\EasyWeChat\OfficialAccount\BroadcastingClient

__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

send()

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

Send a message.

Parameters

Throws

\EasyWeChat\Kernel\Exceptions\RuntimeException

Returns

preview()

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

Preview a message.

Parameters

Returns

delete()

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

Delete a broadcast.

Parameters

Returns

status()

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

Get a broadcast status.

Parameters

Returns

sendText()

sendText(string  $message, mixed  $reception = null) : \Psr\Http\Message\ResponseInterface|\EasyWeChat\Kernel\Support\Collection|array|object|string

Send a text message.

Parameters

Throws

\EasyWeChat\Kernel\Exceptions\RuntimeException

Returns

sendNews()

sendNews(string  $mediaId, mixed  $reception = null) : array|\EasyWeChat\Kernel\Support\Collection|object|\Psr\Http\Message\ResponseInterface|string

Send a news message.

Parameters

Throws

\EasyWeChat\Kernel\Exceptions\RuntimeException

Returns

sendVoice()

sendVoice(string  $mediaId, mixed  $reception = null) : array|\EasyWeChat\Kernel\Support\Collection|object|\Psr\Http\Message\ResponseInterface|string

Send a voice message.

Parameters

Throws

\EasyWeChat\Kernel\Exceptions\RuntimeException

Returns

sendImage()

sendImage(mixed  $mediaId, mixed  $reception = null) : \Psr\Http\Message\ResponseInterface|\EasyWeChat\Kernel\Support\Collection|array|object|string

Send a image message.

Parameters

Throws

\EasyWeChat\Kernel\Exceptions\RuntimeException

Returns

sendVideo()

sendVideo(string  $mediaId, mixed  $reception = null) : array|\EasyWeChat\Kernel\Support\Collection|object|\Psr\Http\Message\ResponseInterface|string

Send a video message.

Parameters

Throws

\EasyWeChat\Kernel\Exceptions\RuntimeException

Returns

sendCard()

sendCard(string  $cardId, mixed  $reception = null) : \Psr\Http\Message\ResponseInterface|\EasyWeChat\Kernel\Support\Collection|array|object|string

Send a card message.

Parameters

Throws

\EasyWeChat\Kernel\Exceptions\RuntimeException

Returns

previewText()

previewText(mixed  $message, string  $reception, string  $method = self::PREVIEW_BY_OPENID) : \Psr\Http\Message\ResponseInterface|\EasyWeChat\Kernel\Support\Collection|array|object|string

Preview a text message.

Parameters

Throws

\EasyWeChat\Kernel\Exceptions\RuntimeException

Returns

previewNews()

previewNews(mixed  $mediaId, string  $reception, string  $method = self::PREVIEW_BY_OPENID) : \Psr\Http\Message\ResponseInterface|\EasyWeChat\Kernel\Support\Collection|array|object|string

Preview a news message.

Parameters

Throws

\EasyWeChat\Kernel\Exceptions\RuntimeException

Returns

previewVoice()

previewVoice(mixed  $mediaId, string  $reception, string  $method = self::PREVIEW_BY_OPENID) : \Psr\Http\Message\ResponseInterface|\EasyWeChat\Kernel\Support\Collection|array|object|string

Preview a voice message.

Parameters

Throws

\EasyWeChat\Kernel\Exceptions\RuntimeException

Returns

previewImage()

previewImage(mixed  $mediaId, string  $reception, string  $method = self::PREVIEW_BY_OPENID) : \Psr\Http\Message\ResponseInterface|\EasyWeChat\Kernel\Support\Collection|array|object|string

Preview a image message.

Parameters

Throws

\EasyWeChat\Kernel\Exceptions\RuntimeException

Returns

previewVideo()

previewVideo(mixed  $mediaId, string  $reception, string  $method = self::PREVIEW_BY_OPENID) : \Psr\Http\Message\ResponseInterface|\EasyWeChat\Kernel\Support\Collection|array|object|string

Preview a video message.

Parameters

Throws

\EasyWeChat\Kernel\Exceptions\RuntimeException

Returns

previewCard()

previewCard(mixed  $cardId, string  $reception, string  $method = self::PREVIEW_BY_OPENID) : \Psr\Http\Message\ResponseInterface|\EasyWeChat\Kernel\Support\Collection|array|object|string

Preview a card message.

Parameters

Throws

\EasyWeChat\Kernel\Exceptions\RuntimeException

Returns

previewMessage()

previewMessage(\EasyWeChat\Kernel\Contracts\MessageInterface  $message, mixed  $reception, string  $method = self::PREVIEW_BY_OPENID) : mixed

Parameters

Throws

\EasyWeChat\Kernel\Exceptions\RuntimeException

Returns

sendMessage()

sendMessage(\EasyWeChat\Kernel\Contracts\MessageInterface  $message, mixed  $reception = null) : mixed

Parameters

Throws

\EasyWeChat\Kernel\Exceptions\RuntimeException

Returns

__call()

__call(string  $method, array  $args) : mixed

Parameters

Returns

previewTextByName()

previewTextByName(mixed  $text, mixed  $name) : \Psr\Http\Message\ResponseInterface|\EasyWeChat\Kernel\Support\Collection|array|object|string

;

Parameters

Returns

previewNewsByName()

previewNewsByName(mixed  $mediaId, mixed  $name) : \Psr\Http\Message\ResponseInterface|\EasyWeChat\Kernel\Support\Collection|array|object|string

;

Parameters

Returns

previewVoiceByName()

previewVoiceByName(mixed  $mediaId, mixed  $name) : \Psr\Http\Message\ResponseInterface|\EasyWeChat\Kernel\Support\Collection|array|object|string

;

Parameters

Returns

previewImageByName()

previewImageByName(mixed  $mediaId, mixed  $name) : \Psr\Http\Message\ResponseInterface|\EasyWeChat\Kernel\Support\Collection|array|object|string

;

Parameters

Returns

previewVideoByName()

previewVideoByName(mixed  $message, mixed  $name) : \Psr\Http\Message\ResponseInterface|\EasyWeChat\Kernel\Support\Collection|array|object|string

;

Parameters

Returns

previewCardByName()

previewCardByName(mixed  $cardId, mixed  $name) : \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