\EasyWeChat\Work\UserClient

__construct()

__construct(\EasyWeChat\Kernel\ServiceContainer  $app, \EasyWeChat\Kernel\Contracts\AccessTokenInterface|null  $accessToken = null) 

BaseClient constructor.

Parameters

httpGet()

httpGet(string  $url, array  $query = array()) : \Psr\Http\Message\ResponseInterface|\EasyWeChat\Kernel\Support\Collection|array|object|string

GET request.

Parameters

Throws

\EasyWeChat\Kernel\Exceptions\InvalidConfigException

Returns

httpPost()

httpPost(string  $url, array  $data = array()) : \Psr\Http\Message\ResponseInterface|\EasyWeChat\Kernel\Support\Collection|array|object|string

POST request.

Parameters

Throws

\EasyWeChat\Kernel\Exceptions\InvalidConfigException

Returns

httpPostJson()

httpPostJson(string  $url, string|array  $data = array(), array  $query = array()) : \Psr\Http\Message\ResponseInterface|\EasyWeChat\Kernel\Support\Collection|array|object|string

JSON request.

Parameters

Throws

\EasyWeChat\Kernel\Exceptions\InvalidConfigException

Returns

httpUpload()

httpUpload(string  $url, array  $files = array(), array  $form = array(), array  $query = array()) : \Psr\Http\Message\ResponseInterface|\EasyWeChat\Kernel\Support\Collection|array|object|string

Upload file.

Parameters

Throws

\EasyWeChat\Kernel\Exceptions\InvalidConfigException

Returns

getAccessToken()

getAccessToken() : \EasyWeChat\Kernel\Contracts\AccessTokenInterface

Returns

setAccessToken()

setAccessToken(\EasyWeChat\Kernel\Contracts\AccessTokenInterface  $accessToken) : $this

Parameters

Returns

request()

request(string  $url, string  $method = 'GET', array  $options = array()) : \Psr\Http\Message\ResponseInterface|\EasyWeChat\Kernel\Support\Collection|array|object|string

Make a request.

Parameters

Returns

requestRaw()

requestRaw(string  $url, string  $method = 'GET', array  $options = array()) : \EasyWeChat\Kernel\Http\Response

Parameters

Throws

\EasyWeChat\Kernel\Exceptions\InvalidConfigException

Returns

getHttpClient()

getHttpClient() : \GuzzleHttp\ClientInterface

Return GuzzleHttp\ClientInterface instance.

Returns

setDefaultOptions()

setDefaultOptions(array  $defaults = array()) 

Set guzzle default settings.

Parameters

getDefaultOptions()

getDefaultOptions() : array

Return current guzzle default settings.

Returns

setHttpClient()

setHttpClient(\GuzzleHttp\ClientInterface  $httpClient) : $this

Set GuzzleHttp\Client.

Parameters

Returns

pushMiddleware()

pushMiddleware(callable  $middleware, null|string  $name = null) : $this

Add a middleware.

Parameters

Returns

getMiddlewares()

getMiddlewares() : array

Return all middlewares.

Returns

setHandlerStack()

setHandlerStack(\GuzzleHttp\HandlerStack  $handlerStack) : $this

Parameters

Returns

getHandlerStack()

getHandlerStack() : \GuzzleHttp\HandlerStack

Build a handler stack.

Returns

create()

create(array  $data) : \Psr\Http\Message\ResponseInterface|\EasyWeChat\Kernel\Support\Collection|array|object|string

Create a user.

Parameters

Returns

update()

update(string  $id, array  $data) : array|\EasyWeChat\Kernel\Support\Collection|object|\Psr\Http\Message\ResponseInterface|string

Update an exist user.

Parameters

Returns

delete()

delete(string|array  $userId) : \Psr\Http\Message\ResponseInterface|\EasyWeChat\Kernel\Support\Collection|array|object|string

Delete a user.

Parameters

Returns

batchDelete()

batchDelete(array  $userIds) : \Psr\Http\Message\ResponseInterface|\EasyWeChat\Kernel\Support\Collection|array|object|string

Batch delete users.

Parameters

Returns

get()

get(string  $userId) : \Psr\Http\Message\ResponseInterface|\EasyWeChat\Kernel\Support\Collection|array|object|string

Get user.

Parameters

Returns

getDepartmentUsers()

getDepartmentUsers(integer  $departmentId, boolean  $fetchChild = false) : \Psr\Http\Message\ResponseInterface|\EasyWeChat\Kernel\Support\Collection|array|object|string

Get simple user list.

Parameters

Returns

getDetailedDepartmentUsers()

getDetailedDepartmentUsers(integer  $departmentId, boolean  $fetchChild = false) : \Psr\Http\Message\ResponseInterface|\EasyWeChat\Kernel\Support\Collection|array|object|string

Get user list.

Parameters

Returns

userIdToOpenid()

userIdToOpenid(string  $userId, integer|null  $agentId = null) : \Psr\Http\Message\ResponseInterface|\EasyWeChat\Kernel\Support\Collection|array|object|string

Convert userId to openid.

Parameters

Returns

openidToUserId()

openidToUserId(string  $openid) : \Psr\Http\Message\ResponseInterface|\EasyWeChat\Kernel\Support\Collection|array|object|string

Convert openid to userId.

Parameters

Returns

accept()

accept(string  $userId) : \Psr\Http\Message\ResponseInterface|\EasyWeChat\Kernel\Support\Collection|array|object|string

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

fixJsonIssue()

fixJsonIssue(array  $options) : array

Parameters

Returns