PHP Class Zendesk\API\Resources\Core\Users

Inheritance: extends Zendesk\API\Resources\ResourceAbstract, use trait Zendesk\API\Traits\Utility\InstantiatorTrait, use trait Zendesk\API\Traits\Resource\Defaults, use trait Zendesk\API\Traits\Resource\MultipartUpload, use trait Zendesk\API\Traits\Resource\CreateMany, use trait Zendesk\API\Traits\Resource\FindMany, use trait Zendesk\API\Traits\Resource\UpdateMany, use trait Zendesk\API\Traits\Resource\CreateOrUpdateMany
显示文件 Open project: zendesk/zendesk_api_client_php

Protected Properties

Property Type Description
$identities UserIdentities

Public Methods

Method Description
autocomplete ( array $params ) : stdClass Requests autocomplete for users
changePassword ( array $params ) : null Change a user's password
createOrUpdate ( array $params, string $routeKey = __FUNCTION__ ) : null | stdClass Create or updates a user
findAll ( array $params = [] ) : stdClass List all users
findMany ( array $params = [] ) : stdClass Find users by ids or external_ids
getUploadName ( ) : String {$@inheritdoc}
getUploadRequestMethod ( ) : String {$@inheritdoc}
getValidSubResources ( )
me ( array $params = [] ) : stdClass Show the current user
merge ( array $params = [] ) : stdClass Merge the specified user (???)
related ( array $params = [] ) : stdClass Get related information about the user
search ( array $params ) : stdClass Search for users
setPassword ( array $params ) : null Sets a user's initial password
suspend ( array $params = [] ) : stdClass Update multiple users
traitFindAll ( )
traitFindMany ( )
updateProfileImageFromFile ( array $params ) : stdClass Update a user's profile image
updateProfileImageFromUrl ( array $params ) : stdClass Update a user's profile image

Protected Methods

Method Description
setUpRoutes ( )

Method Details

autocomplete() public method

Requests autocomplete for users
public autocomplete ( array $params ) : stdClass
$params array
return stdClass | null

changePassword() public method

Change a user's password
public changePassword ( array $params ) : null
$params array
return null

createOrUpdate() public method

Create or updates a user
public createOrUpdate ( array $params, string $routeKey = __FUNCTION__ ) : null | stdClass
$params array
$routeKey string
return null | stdClass

findAll() public method

List all users
public findAll ( array $params = [] ) : stdClass
$params array
return stdClass | null

findMany() public method

Find users by ids or external_ids
public findMany ( array $params = [] ) : stdClass
$params array
return stdClass | null

getUploadName() public method

{$@inheritdoc}
public getUploadName ( ) : String
return String

getUploadRequestMethod() public method

{$@inheritdoc}
public getUploadRequestMethod ( ) : String
return String

getValidSubResources() public static method

public static getValidSubResources ( )

me() public method

Show the current user
public me ( array $params = [] ) : stdClass
$params array
return stdClass | null

merge() public method

Merge the specified user (???)
public merge ( array $params = [] ) : stdClass
$params array
return stdClass | null

setPassword() public method

Sets a user's initial password
public setPassword ( array $params ) : null
$params array
return null

setUpRoutes() protected method

protected setUpRoutes ( )

suspend() public method

Update multiple users
public suspend ( array $params = [] ) : stdClass
$params array
return stdClass | null

traitFindAll() public method

public traitFindAll ( )

traitFindMany() public method

public traitFindMany ( )

updateProfileImageFromFile() public method

Update a user's profile image
public updateProfileImageFromFile ( array $params ) : stdClass
$params array
return stdClass | null

updateProfileImageFromUrl() public method

Update a user's profile image
public updateProfileImageFromUrl ( array $params ) : stdClass
$params array
return stdClass | null

Property Details

$identities protected_oe property

protected UserIdentities,Zendesk\API\Resources\Core $identities
return UserIdentities