\EasyWeChat\OfficialAccount\TemplateMessageClient

__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

setIndustry()

setIndustry(integer  $industryOne, integer  $industryTwo) : \Psr\Http\Message\ResponseInterface|\EasyWeChat\Kernel\Support\Collection|array|object|string

Set industry.

Parameters

Returns

getIndustry()

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

Get industry.

Returns

addTemplate()

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

Add a template and get template ID.

Parameters

Returns

getPrivateTemplates()

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

Get private templates.

Returns

deletePrivateTemplate()

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

Delete private template.

Parameters

Returns

send()

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

Send a template message.

Parameters

Throws

\EasyWeChat\Kernel\Exceptions\InvalidArgumentException

Returns

sendSubscription()

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

Send template-message for subscription.

Parameters

Throws

\EasyWeChat\Kernel\Exceptions\InvalidArgumentException

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

formatMessage()

formatMessage(array  $data = array()) : array

Parameters

Throws

\EasyWeChat\Kernel\Exceptions\InvalidArgumentException

Returns

formatData()

formatData(array  $data) : array

Parameters

Returns

restoreMessage()

restoreMessage() 

Restore message.