\EasyWeChat\StaffStaff

__construct()

__construct(\EasyWeChat\Core\AccessToken  $accessToken) 

Constructor.

Parameters

getHttp()

getHttp() : \EasyWeChat\Core\Http

Return the http instance.

Returns

setHttp()

setHttp(\EasyWeChat\Core\Http  $http) : $this

Set the http instance.

Parameters

Returns

getAccessToken()

getAccessToken() : \EasyWeChat\Core\AccessToken

Return the current accessToken.

Returns

setAccessToken()

setAccessToken(\EasyWeChat\Core\AccessToken  $accessToken) : $this

Set the request token.

Parameters

Returns

maxRetries()

maxRetries(integer  $retries) 

Parameters

parseJSON()

parseJSON(string  $method, array  $args) : \EasyWeChat\Support\Collection

Parse JSON from response and check error.

Parameters

Throws

\EasyWeChat\Core\Exceptions\HttpException

Returns

| null

lists()

lists() : \EasyWeChat\Support\Collection

List all staffs.

Returns

onlines()

onlines() : \EasyWeChat\Support\Collection

List all online staffs.

Returns

create()

create(string  $account, string  $nickname) : \EasyWeChat\Support\Collection

Create a staff.

Parameters

Returns

update()

update(string  $account, string  $nickname) : \EasyWeChat\Support\Collection

Update a staff.

Parameters

Returns

delete()

delete(string  $account) : \EasyWeChat\Support\Collection

Delete a staff.

Parameters

Returns

invite()

invite(string  $account, string  $wechatId) : \EasyWeChat\Support\Collection

Invite a staff.

Parameters

Returns

avatar()

avatar(string  $account, string  $path) : \EasyWeChat\Support\Collection

Set staff avatar.

Parameters

Returns

message()

message(\EasyWeChat\Message\AbstractMessage|string  $message) : \EasyWeChat\Staff\MessageBuilder

Get message builder.

Parameters

Throws

\EasyWeChat\Core\Exceptions\InvalidArgumentException

Returns

send()

send(string|array  $message) : \EasyWeChat\Support\Collection

Send a message.

Parameters

Returns

records()

records(integer  $startTime, integer  $endTime, integer  $page = 1, integer  $pageSize = 10) : \EasyWeChat\Support\Collection

Get staff session history.

Parameters

Returns

messages()

messages(integer  $startTime, integer  $endTime, integer  $msgId = 1, integer  $number = 10000) : \EasyWeChat\Support\Collection

获取聊天记录.

Parameters

Returns

registerHttpMiddlewares()

registerHttpMiddlewares() 

Register Guzzle middlewares.

accessTokenMiddleware()

accessTokenMiddleware() : \Closure

Attache access token to request query.

Returns

logMiddleware()

logMiddleware() : \Closure

Log the request.

Returns

retryMiddleware()

retryMiddleware() : \Closure

Return retry middleware.

Returns

checkAndThrow()

checkAndThrow(array  $contents) 

Check the array data errors, and Throw exception when the contents contains error.

Parameters

Throws

\EasyWeChat\Core\Exceptions\HttpException