$queueName
$queueName :
__construct(\AliyunMNS\Http\HttpClient $client, $queueName, $base64 = TRUE)
| \AliyunMNS\Http\HttpClient | $client | |
| $queueName | ||
| $base64 |
setAttribute(\AliyunMNS\Model\QueueAttributes $attributes) : \AliyunMNS\SetQueueAttributeResponse:
Set the QueueAttributes, detail API sepcs: https://docs.aliyun.com/?spm=#/pub/mns/api_reference/api_spec&queue_operation
| \AliyunMNS\Model\QueueAttributes | $attributes |
if queue does not exist
if any argument value is invalid
if any other exception happends
the response
setAttributeAsync(\AliyunMNS\Model\QueueAttributes $attributes, \AliyunMNS\AsyncCallback $callback = NULL)
| \AliyunMNS\Model\QueueAttributes | $attributes | |
| \AliyunMNS\AsyncCallback | $callback |
getAttribute() : \AliyunMNS\GetQueueAttributeResponse:
Get the QueueAttributes, detail API sepcs: https://docs.aliyun.com/?spm=#/pub/mns/api_reference/api_spec&queue_operation
if queue does not exist
if any other exception happends
containing the attributes
getAttributeAsync(\AliyunMNS\AsyncCallback $callback = NULL)
| \AliyunMNS\AsyncCallback | $callback |
sendMessage(\AliyunMNS\Requests\SendMessageRequest $request) : \AliyunMNS\SendMessageResponse:
SendMessage, the messageBody will be automatically encoded in base64 If you do not need the message body to be encoded in Base64, please specify the $base64 = FALSE in Queue
detail API sepcs: https://docs.aliyun.com/?spm=#/pub/mns/api_reference/api_spec&message_operation
| \AliyunMNS\Requests\SendMessageRequest | $request |
if queue does not exist
if any argument value is invalid
if any error in xml
if any other exception happends
containing the messageId and bodyMD5
sendMessageAsync(\AliyunMNS\Requests\SendMessageRequest $request, \AliyunMNS\AsyncCallback $callback = NULL)
| \AliyunMNS\Requests\SendMessageRequest | $request | |
| \AliyunMNS\AsyncCallback | $callback |
peekMessage() : \AliyunMNS\PeekMessageResponse:
PeekMessage, the messageBody will be automatically decoded as base64 if the $base64 in Queue is TRUE
detail API sepcs: https://docs.aliyun.com/?spm=#/pub/mns/api_reference/api_spec&message_operation
if queue does not exist
if no message exists in the queue
if any other exception happends
containing the messageBody and properties
peekMessageAsync(\AliyunMNS\AsyncCallback $callback = NULL)
| \AliyunMNS\AsyncCallback | $callback |
receiveMessage( $waitSeconds = NULL) : \AliyunMNS\ReceiveMessageResponse:
ReceiveMessage, the messageBody will be automatically decoded as base64 if $base64 = TRUE in Queue detail API sepcs: https://docs.aliyun.com/?spm=#/pub/mns/api_reference/api_spec&message_operation
| $waitSeconds |
if queue does not exist
if no message exists in the queue
if any other exception happends
containing the messageBody and properties the response is same as PeekMessageResponse, except that the receiptHandle is also returned in receiveMessage
receiveMessageAsync(\AliyunMNS\AsyncCallback $callback = NULL)
| \AliyunMNS\AsyncCallback | $callback |
deleteMessage( $receiptHandle) : \AliyunMNS\Responses\ReceiveMessageResponse
DeleteMessage detail API sepcs: https://docs.aliyun.com/?spm=#/pub/mns/api_reference/api_spec&message_operation
| $receiptHandle |
if queue does not exist
if the argument is invalid
if the $receiptHandle is invalid
if any other exception happends
deleteMessageAsync( $receiptHandle, \AliyunMNS\AsyncCallback $callback = NULL)
| $receiptHandle | ||
| \AliyunMNS\AsyncCallback | $callback |
changeMessageVisibility( $receiptHandle, $visibilityTimeout) : \AliyunMNS\Responses\ChangeMessageVisibilityResponse
ChangeMessageVisibility, set the nextVisibleTime for the message detail API sepcs: https://docs.aliyun.com/?spm=#/pub/mns/api_reference/api_spec&message_operation
| $receiptHandle | ||
| $visibilityTimeout |
if queue does not exist
if the message does not exist
if the argument is invalid
if the $receiptHandle is invalid
if any other exception happends
batchSendMessage(\AliyunMNS\Requests\BatchSendMessageRequest $request) : \AliyunMNS\Responses\BatchSendMessageResponse
BatchSendMessage, message body will be automatically encoded in base64 If you do not need the message body to be encoded in Base64, please specify the $base64 = FALSE in Queue
detail API sepcs: https://docs.aliyun.com/?spm=#/pub/mns/api_reference/api_spec&message_operation
| \AliyunMNS\Requests\BatchSendMessageRequest | $request |
if queue does not exist
if any error in the xml
if the argument is invalid
if some messages are not sent
if any other exception happends
batchSendMessageAsync(\AliyunMNS\Requests\BatchSendMessageRequest $request, \AliyunMNS\AsyncCallback $callback = NULL)
| \AliyunMNS\Requests\BatchSendMessageRequest | $request | |
| \AliyunMNS\AsyncCallback | $callback |
batchReceiveMessage(\AliyunMNS\Requests\BatchReceiveMessageRequest $request) : \AliyunMNS\BatchReceiveMessageResponse:
BatchReceiveMessage, message body will be automatically decoded as base64 if $base64 = TRUE in Queue
detail API sepcs: https://docs.aliyun.com/?spm=#/pub/mns/api_reference/api_spec&message_operation
| \AliyunMNS\Requests\BatchReceiveMessageRequest | $request |
if queue does not exist
if no message exists
if any other exception happends
the received messages
batchReceiveMessageAsync(\AliyunMNS\Requests\BatchReceiveMessageRequest $request, \AliyunMNS\AsyncCallback $callback = NULL)
| \AliyunMNS\Requests\BatchReceiveMessageRequest | $request | |
| \AliyunMNS\AsyncCallback | $callback |
batchPeekMessage( $numOfMessages) : \AliyunMNS\BatchPeekMessageResponse:
BatchPeekMessage, message body will be automatically decoded as base64 is $base64 = TRUE in Queue
detail API sepcs: https://docs.aliyun.com/?spm=#/pub/mns/api_reference/api_spec&message_operation
| $numOfMessages |
if queue does not exist
if no message exists
if any other exception happends
the received messages
batchPeekMessageAsync( $numOfMessages, \AliyunMNS\AsyncCallback $callback = NULL)
| $numOfMessages | ||
| \AliyunMNS\AsyncCallback | $callback |
batchDeleteMessage( $receiptHandles) : \AliyunMNS\Responses\BatchDeleteMessageResponse
BatchDeleteMessage detail API sepcs: https://docs.aliyun.com/?spm=#/pub/mns/api_reference/api_spec&message_operation
| $receiptHandles |
if queue does not exist
if the receiptHandle is invalid
if the argument is invalid
if any message not deleted
if any other exception happends
batchDeleteMessageAsync( $receiptHandles, \AliyunMNS\AsyncCallback $callback = NULL)
| $receiptHandles | ||
| \AliyunMNS\AsyncCallback | $callback |