azure-storage-queue\src\Queue\Models\QueueMessage.php

Show: PublicProtectedPrivateinherited
Table of Contents
LICENSE: The MIT License (the "License") you may not use this file except in compliance with the License.

You may obtain a copy of the License at https://github.com/azure/azure-storage-php/LICENSE

Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.

PHP version 5

Author
Azure Storage PHP SDK  
Category
Microsoft  
Copyright
2016 Microsoft Corporation  
License
https://github.com/azure/azure-storage-php/LICENSE  
Link
https://github.com/azure/azure-storage-php  
Package
MicrosoftAzure\Storage\Queue\Models  

\MicrosoftAzure\Storage\Queue\Models\QueueMessage

Package: MicrosoftAzure\Storage\Queue\Models
Holds data for single queue message.
Author
Azure Storage PHP SDK  
Category
Microsoft  
Copyright
2016 Microsoft Corporation  
License
https://github.com/azure/azure-storage-php/LICENSE  
Link
https://github.com/azure/azure-storage-php  

Methods

methodpublicgetDequeueCount() : integer

Gets dequeueCount field.

Returns
TypeDescription
integer
methodpublicgetExpirationDate() : \DateTime

Gets expirationDate field.

Returns
TypeDescription
\DateTime
methodpublicgetInsertionDate() : \DateTime

Gets insertionDate field.

Returns
TypeDescription
\DateTime
methodpublicgetMessageId() : string

Gets messageId field.

Returns
TypeDescription
string
methodpublicgetMessageText() : string

Gets message text field.

Returns
TypeDescription
string
methodpublicgetPopReceipt() : string

Gets popReceipt field.

Returns
TypeDescription
string
methodpublicgetTimeNextVisible() : \DateTime

Gets timeNextVisible field.

Returns
TypeDescription
\DateTime
methodpublicsetExpirationDate(\DateTime $expirationDate) : void

Sets expirationDate field.

Parameters
NameTypeDescription
$expirationDate\DateTime

the expiration date of the message.

methodpublicsetMessageId(string $messageId) : void

Sets messageId field.

Parameters
NameTypeDescription
$messageIdstring

message contents.

methodpublicsetMessageText(string $messageText) : void

Sets message text field.

Parameters
NameTypeDescription
$messageTextstring

message contents.

methodpublicsetPopReceipt(string $popReceipt) : void

Sets popReceipt field.

Parameters
NameTypeDescription
$popReceiptstring

used when deleting the message.

methodpublicsetTimeNextVisible(\DateTime $timeNextVisible) : void

Sets timeNextVisible field.

Parameters
NameTypeDescription
$timeNextVisible\DateTime

next visibile time for the message.

Documentation was generated by phpDocumentor 2.9.1.