PHP Класс Zendesk\API\Resources\Core\Users

Наследование: 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

Показать файл Открыть проект

Защищенные свойства (Protected)

Свойство	Тип	Описание
$identities	UserIdentities

Открытые методы

Метод	Описание
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

Защищенные методы

Метод	Описание
setUpRoutes ( )

Описание методов

autocomplete() публичный Метод

Requests autocomplete for users

public autocomplete ( array $params ) : stdClass
$params	array
Результат	stdClass	\| null

changePassword() публичный Метод

Change a user's password

public changePassword ( array $params ) : null
$params	array
Результат	null

createOrUpdate() публичный Метод

Create or updates a user

public createOrUpdate ( array $params, string $routeKey = __FUNCTION__ ) : null \| stdClass
$params	array
$routeKey	string
Результат	null \| stdClass

findAll() публичный Метод

List all users

public findAll ( array $params = [] ) : stdClass
$params	array
Результат	stdClass	\| null

findMany() публичный Метод

Find users by ids or external_ids

public findMany ( array $params = [] ) : stdClass
$params	array
Результат	stdClass	\| null

getUploadName() публичный Метод

{$@inheritdoc}

public getUploadName ( ) : String
Результат	String

getUploadRequestMethod() публичный Метод

{$@inheritdoc}

public getUploadRequestMethod ( ) : String
Результат	String

getValidSubResources() публичный статический Метод

public static getValidSubResources ( )

me() публичный Метод

Show the current user

public me ( array $params = [] ) : stdClass
$params	array
Результат	stdClass	\| null

merge() публичный Метод

Merge the specified user (???)

public merge ( array $params = [] ) : stdClass
$params	array
Результат	stdClass	\| null

search() публичный Метод

Search for users

public search ( array $params ) : stdClass
$params	array	Accepts `external_id` & `query`
Результат	stdClass	\| null

setPassword() публичный Метод

Sets a user's initial password

public setPassword ( array $params ) : null
$params	array
Результат	null

setUpRoutes() защищенный Метод

protected setUpRoutes ( )

suspend() публичный Метод

Update multiple users

public suspend ( array $params = [] ) : stdClass
$params	array
Результат	stdClass	\| null

traitFindAll() публичный Метод

public traitFindAll ( )

traitFindMany() публичный Метод

public traitFindMany ( )

updateProfileImageFromFile() публичный Метод

Update a user's profile image

public updateProfileImageFromFile ( array $params ) : stdClass
$params	array
Результат	stdClass	\| null

updateProfileImageFromUrl() публичный Метод