\AliyunMNSClient

Please refer to https://docs.aliyun.com/?spm=#/pub/mns/api_reference/api_spec&queue_operation for more details

Summary

Methods
Properties
Constants
__construct()
getQueueRef()
createQueue()
createQueueAsync()
listQueue()
listQueueAsync()
deleteQueue()
deleteQueueAsync()
getTopicRef()
createTopic()
deleteTopic()
listTopic()
getAccountAttributes()
getAccountAttributesAsync()
setAccountAttributes()
setAccountAttributesAsync()
No public properties found
No constants found
No protected methods found
No protected properties found
N/A
No private methods found
$client
N/A

Properties

$client

$client : 

Type

Methods

__construct()

__construct(  $endPoint,   $accessId,   $accessKey,   $securityToken = NULL, \AliyunMNS\Config  $config = NULL) 

Please refer to http://www.aliyun.com/product/mns for more details

Parameters

$endPoint
$accessId
$accessKey
$securityToken
\AliyunMNS\Config $config

getQueueRef()

getQueueRef(  $queueName,   $base64 = TRUE) : \AliyunMNS\Queue

Returns a queue reference for operating on the queue this function does not create the queue automatically.

Parameters

$queueName
$base64

Returns

\AliyunMNS\Queue

$queue: the Queue instance

createQueue()

createQueue(\AliyunMNS\Requests\CreateQueueRequest  $request) : \AliyunMNS\Responses\CreateQueueResponse

Create Queue and Returns the Queue reference

Parameters

\AliyunMNS\Requests\CreateQueueRequest $request

Throws

\AliyunMNS\QueueAlreadyExistException

if queue already exists

\AliyunMNS\InvalidArgumentException

if any argument value is invalid

\AliyunMNS\MnsException

if any other exception happends

Returns

\AliyunMNS\Responses\CreateQueueResponse

$response: the CreateQueueResponse

createQueueAsync()

createQueueAsync(\AliyunMNS\Requests\CreateQueueRequest  $request, \AliyunMNS\AsyncCallback  $callback = NULL) : \AliyunMNS\MnsPromise

Create Queue and Returns the Queue reference The request will not be sent until calling MnsPromise->wait();

Parameters

\AliyunMNS\Requests\CreateQueueRequest $request
\AliyunMNS\AsyncCallback $callback

Throws

\AliyunMNS\MnsException

if any exception happends

Returns

\AliyunMNS\MnsPromise —

$promise: the MnsPromise instance

listQueue()

listQueue(\AliyunMNS\Requests\ListQueueRequest  $request) : \AliyunMNS\ListQueueResponse:

Query the queues created by current account

Parameters

\AliyunMNS\Requests\ListQueueRequest $request

Returns

\AliyunMNS\ListQueueResponse: —

the response containing queueNames

deleteQueue()

deleteQueue(  $queueName) : \AliyunMNS\Responses\DeleteQueueResponse

Delete the specified queue the request will succeed even when the queue does not exist

Parameters

$queueName

Returns

\AliyunMNS\Responses\DeleteQueueResponse

deleteQueueAsync()

deleteQueueAsync(  $queueName, \AliyunMNS\AsyncCallback  $callback = NULL) 

Parameters

$queueName
\AliyunMNS\AsyncCallback $callback

getTopicRef()

getTopicRef(  $topicName) : \AliyunMNS\Topic

Returns a topic reference for operating on the topic this function does not create the topic automatically.

Parameters

$topicName

Returns

\AliyunMNS\Topic

$topic: the Topic instance

createTopic()

createTopic(\AliyunMNS\Requests\CreateTopicRequest  $request) : \AliyunMNS\Responses\CreateTopicResponse

Create Topic and Returns the Topic reference

Parameters

\AliyunMNS\Requests\CreateTopicRequest $request

Throws

\AliyunMNS\TopicAlreadyExistException

if topic already exists

\AliyunMNS\InvalidArgumentException

if any argument value is invalid

\AliyunMNS\MnsException

if any other exception happends

Returns

\AliyunMNS\Responses\CreateTopicResponse

$response: the CreateTopicResponse

deleteTopic()

deleteTopic(  $topicName) : \AliyunMNS\Responses\DeleteTopicResponse

Delete the specified topic the request will succeed even when the topic does not exist

Parameters

$topicName

Returns

\AliyunMNS\Responses\DeleteTopicResponse

listTopic()

listTopic(\AliyunMNS\Requests\ListTopicRequest  $request) : \AliyunMNS\ListTopicResponse:

Query the topics created by current account

Parameters

\AliyunMNS\Requests\ListTopicRequest $request

Returns

\AliyunMNS\ListTopicResponse: —

the response containing topicNames

getAccountAttributes()

getAccountAttributes() : \AliyunMNS\GetAccountAttributesResponse:

Query the AccountAttributes

Throws

\AliyunMNS\MnsException

if any exception happends

Returns

\AliyunMNS\GetAccountAttributesResponse: —

the response containing topicNames

getAccountAttributesAsync()

getAccountAttributesAsync(\AliyunMNS\AsyncCallback  $callback = NULL) 

Parameters

\AliyunMNS\AsyncCallback $callback

setAccountAttributes()

setAccountAttributes(\AliyunMNS\Model\AccountAttributes  $attributes) : \AliyunMNS\SetAccountAttributesResponse:

Set the AccountAttributes

Parameters

\AliyunMNS\Model\AccountAttributes $attributes

Throws

\AliyunMNS\MnsException

if any exception happends

Returns

\AliyunMNS\SetAccountAttributesResponse: —

the response