€cdocutils.nodes document q)q}q(U nametypesq}q(X7. get a specific messageqNX6.1 descriptionqNX4.2 parametersqNX3.3.1 posting a single messageq NX4.1 descriptionq NX8. delete messageq NX8.3 code sampleq NX1. introductionq NX6.2 parametersqNX7.4 code sampleqNX7.1 descriptionqNX4.3 code sampleqNX3.3 code samplesqNX!6. delete a set of messages by idqNX4. get messagesqNX5.3 code sampleqNX5.1 descriptionqNX2. setupqNX5.2 parametersqNX3.3.2 post a batch of messagesqNX7.3 object propertiesqNX6.3 code sampleqNX3. post messageqNX8.2 parametersqNX3.1 descriptionqNX5. get a set of messages by idqNX8.1 descriptionq NX7.2 parametersq!NX3.2 parametersq"NuUsubstitution_defsq#}q$Uparse_messagesq%]q&Ucurrent_sourceq'NU decorationq(NUautofootnote_startq)KUnameidsq*}q+(hUget-a-specific-messageq,hUid6q-hUid2q.h Uposting-a-single-messageq/h Uid1q0h Udelete-messageq1h Uid14q2h U introductionq3hUid7q4hUid11q5hUid9q6hU code-sampleq7hU code-samplesq8hUdelete-a-set-of-messages-by-idq9hU get-messagesq:hUid5q;hUid3qhUpost-a-batch-of-messagesq?hUobject-propertiesq@hUid8qAhU post-messageqBhUid13qChU descriptionqDhUget-a-set-of-messages-by-idqEh Uid12qFh!Uid10qGh"U parametersqHuUchildrenqI]qJ(cdocutils.nodes section qK)qL}qM(U rawsourceqNUUparentqOhUsourceqPXJ/Users/jamie/projects/php/php-opencloud/doc/services/queues/Message.md.rstqQUtagnameqRUsectionqSU attributesqT}qU(UdupnamesqV]UclassesqW]UbackrefsqX]UidsqY]qZh3aUnamesq[]q\h auUlineq]KUdocumentq^hhI]q_(cdocutils.nodes title q`)qa}qb(hNX1. IntroductionqchOhLhPhQhRUtitleqdhT}qe(hV]hW]hX]hY]h[]uh]Kh^hhI]qfcdocutils.nodes Text qgX1. Introductionqh…qi}qj(hNhchOhaubaubcdocutils.nodes paragraph qk)ql}qm(hNXèA **Message** is a task, a notification, or any meaningful data that a producer or publisher sends to the queue. A message exists until it is deleted by a recipient or automatically by the system based on a TTL (time-to-live) value.hOhLhPhQhRU paragraphqnhT}qo(hV]hW]hX]hY]h[]uh]Kh^hhI]qp(hgXA qq…qr}qs(hNXA hOhlubcdocutils.nodes strong qt)qu}qv(hNX **Message**hT}qw(hV]hW]hX]hY]h[]uhOhlhI]qxhgXMessageqy…qz}q{(hNUhOhuubahRUstrongq|ubhgXÛ is a task, a notification, or any meaningful data that a producer or publisher sends to the queue. A message exists until it is deleted by a recipient or automatically by the system based on a TTL (time-to-live) value.q}…q~}q(hNXÛ is a task, a notification, or any meaningful data that a producer or publisher sends to the queue. A message exists until it is deleted by a recipient or automatically by the system based on a TTL (time-to-live) value.hOhlubeubeubhK)q€}q(hNUhOhhPhQhRhShT}q‚(hV]hW]hX]hY]qƒh=ah[]q„hauh]K h^hhI]q…(h`)q†}q‡(hNX2. SetupqˆhOh€hPhQhRhdhT}q‰(hV]hW]hX]hY]h[]uh]K h^hhI]qŠhgX2. Setupq‹…qŒ}q(hNhˆhOh†ubaubhk)qŽ}q(hNX9A message is initialized from its parent object, a Queue:qhOh€hPhQhRhnhT}q‘(hV]hW]hX]hY]h[]uh]K h^hhI]q’hgX9A message is initialized from its parent object, a Queue:q“…q”}q•(hNhhOhŽubaubcdocutils.nodes literal_block q–)q—}q˜(hNXˆ// Setup an empty object $message = $queue->getMessage(); // or retrieve an existing one $message = $queue->getMessage('');hOh€hPhQhRU literal_blockq™hT}qš(U xml:spaceq›UpreserveqœhY]hX]hV]hW]q(UcodeqžXphpqŸeh[]uh]Kh^hhI]q cdocutils.nodes inline q¡)q¢}q£(hNXˆ// Setup an empty object $message = $queue->getMessage(); // or retrieve an existing one $message = $queue->getMessage('');hT}q¤(hV]hW]q¥Uotherq¦ahX]hY]h[]uhOh—hI]q§hgXˆ// Setup an empty object $message = $queue->getMessage(); // or retrieve an existing one $message = $queue->getMessage('');q¨…q©}qª(hNUhOh¢ubahRUinlineq«ubaubeubhK)q¬}q­(hNUhOhhPhQhRhShT}q®(hV]hW]hX]hY]q¯hBah[]q°hauh]Kh^hhI]q±(h`)q²}q³(hNX3. Post messageq´hOh¬hPhQhRhdhT}qµ(hV]hW]hX]hY]h[]uh]Kh^hhI]q¶hgX3. Post messageq·…q¸}q¹(hNh´hOh²ubaubhK)qº}q»(hNUhOh¬hPhQhRhShT}q¼(hV]hW]hX]hY]q½hDah[]q¾hauh]Kh^hhI]q¿(h`)qÀ}qÁ(hNX3.1 DescriptionqÂhOhºhPhQhRhdhT}qÃ(hV]hW]hX]hY]h[]uh]Kh^hhI]qÄhgX3.1 DescriptionqÅ…qÆ}qÇ(hNhÂhOhÀubaubhk)qÈ}qÉ(hNXmThis operation posts the specified message or messages. You can submit up to 10 messages in a single request.qÊhOhºhPhQhRhnhT}qË(hV]hW]hX]hY]h[]uh]Kh^hhI]qÌhgXmThis operation posts the specified message or messages. You can submit up to 10 messages in a single request.qÍ…qÎ}qÏ(hNhÊhOhÈubaubhk)qÐ}qÑ(hNX‡When posting new messages, you specify only the ``body`` and ``ttl`` for the message. The API will insert metadata, such as ID and age.hOhºhPhQhRhnhT}qÒ(hV]hW]hX]hY]h[]uh]Kh^hhI]qÓ(hgX0When posting new messages, you specify only the qÔ…qÕ}qÖ(hNX0When posting new messages, you specify only the hOhÐubcdocutils.nodes literal q×)qØ}qÙ(hNX``body``hT}qÚ(hV]hW]hX]hY]h[]uhOhÐhI]qÛhgXbodyqÜ…qÝ}qÞ(hNUhOhØubahRUliteralqßubhgX and qà…qá}qâ(hNX and hOhÐubh×)qã}qä(hNX``ttl``hT}qå(hV]hW]hX]hY]h[]uhOhÐhI]qæhgXttlqç…qè}qé(hNUhOhãubahRhßubhgXC for the message. The API will insert metadata, such as ID and age.qê…që}qì(hNXC for the message. The API will insert metadata, such as ID and age.hOhÐubeubeubhK)qí}qî(hNUhOh¬hPhQhRhShT}qï(hV]hW]hX]hY]qðhHah[]qñh"auh]K#h^hhI]qò(h`)qó}qô(hNX3.2 ParametersqõhOhíhPhQhRhdhT}qö(hV]hW]hX]hY]h[]uh]K#h^hhI]q÷hgX3.2 Parametersqø…qù}qú(hNhõhOhóubaubhk)qû}qü(hNX’How you pass through the array structure depends on whether you are executing multiple (3.3.2) or single (3.3.3) posts, but the keys are the same.qýhOhíhPhQhRhnhT}qþ(hV]hW]hX]hY]h[]uh]K%h^hhI]qÿhgX’How you pass through the array structure depends on whether you are executing multiple (3.3.2) or single (3.3.3) posts, but the keys are the same.r…r}r(hNhýhOhûubaubhk)r}r(hNX­The ``body`` attribute specifies an arbitrary document that constitutes the body of the message being sent. The size of this body is limited to 256 KB, excluding whitespace.hOhíhPhQhRhnhT}r(hV]hW]hX]hY]h[]uh]K)h^hhI]r(hgXThe r…r}r (hNXThe hOjubh×)r }r (hNX``body``hT}r (hV]hW]hX]hY]h[]uhOjhI]r hgXbodyr…r}r(hNUhOj ubahRhßubhgX¡ attribute specifies an arbitrary document that constitutes the body of the message being sent. The size of this body is limited to 256 KB, excluding whitespace.r…r}r(hNX¡ attribute specifies an arbitrary document that constitutes the body of the message being sent. The size of this body is limited to 256 KB, excluding whitespace.hOjubeubhk)r}r(hNXfThe ``ttl`` attribute specifies how long the server waits before marking the message as expired and removing it from the queue. The value of ttl must be between 60 and 1209600 seconds (14 days). Note that the server might not actually delete the message until its age has reached up to (ttl + 60) seconds, to allow for flexibility in storage implementations.hOhíhPhQhRhnhT}r(hV]hW]hX]hY]h[]uh]K-h^hhI]r(hgXThe r…r}r(hNXThe hOjubh×)r}r(hNX``ttl``hT}r(hV]hW]hX]hY]h[]uhOjhI]rhgXttlr…r }r!(hNUhOjubahRhßubhgX[ attribute specifies how long the server waits before marking the message as expired and removing it from the queue. The value of ttl must be between 60 and 1209600 seconds (14 days). Note that the server might not actually delete the message until its age has reached up to (ttl + 60) seconds, to allow for flexibility in storage implementations.r"…r#}r$(hNX[ attribute specifies how long the server waits before marking the message as expired and removing it from the queue. The value of ttl must be between 60 and 1209600 seconds (14 days). Note that the server might not actually delete the message until its age has reached up to (ttl + 60) seconds, to allow for flexibility in storage implementations.hOjubeubeubhK)r%}r&(hNUhOh¬hPhQhRhShT}r'(hV]hW]hX]hY]r(h8ah[]r)hauh]K4h^hhI]r*(h`)r+}r,(hNX3.3 Code samplesr-hOj%hPhQhRhdhT}r.(hV]hW]hX]hY]h[]uh]K4h^hhI]r/hgX3.3 Code samplesr0…r1}r2(hNj-hOj+ubaubhK)r3}r4(hNUhOj%hPhQhRhShT}r5(hV]hW]hX]hY]r6h/ah[]r7h auh]K7h^hhI]r8(h`)r9}r:(hNX3.3.1 Posting a single messager;hOj3hPhQhRhdhT}r<(hV]hW]hX]hY]h[]uh]K7h^hhI]r=hgX3.3.1 Posting a single messager>…r?}r@(hNj;hOj9ubaubh–)rA}rB(hNXØuse OpenCloud\Common\Constants\Datetime; $queue->createMessage(array( 'body' => (object) array( 'event' => 'BackupStarted', 'deadline' => '26.12.2013 ), 'ttl' => 2 * Datetime::DAY ));hOj3hPhQhRh™hT}rC(h›hœhY]hX]hV]hW]h[]uh]K;h^hhI]rDhgXØuse OpenCloud\Common\Constants\Datetime; $queue->createMessage(array( 'body' => (object) array( 'event' => 'BackupStarted', 'deadline' => '26.12.2013 ), 'ttl' => 2 * Datetime::DAY ));rE…rF}rG(hNUhOjAubaubeubhK)rH}rI(hNUhOj%hPhQhRhShT}rJ(hV]hW]hX]hY]rKh?ah[]rLhauh]KFh^hhI]rM(h`)rN}rO(hNX3.3.2 Post a batch of messagesrPhOjHhPhQhRhdhT}rQ(hV]hW]hX]hY]h[]uh]KFh^hhI]rRhgX3.3.2 Post a batch of messagesrS…rT}rU(hNjPhOjNubaubhk)rV}rW(hNXlPlease note that the list of messages will be truncated at 10. For more, please execute another method call.rXhOjHhPhQhRhnhT}rY(hV]hW]hX]hY]h[]uh]KHh^hhI]rZhgXlPlease note that the list of messages will be truncated at 10. For more, please execute another method call.r[…r\}r](hNjXhOjVubaubh–)r^}r_(hNXjuse OpenCloud\Common\Constants\Datetime; $messages = array( array( 'body' => (object) array( 'play' => 'football' ), 'ttl' => 2 * Datetime::DAY ), array( 'body' => (object) array( 'play' => 'tennis' ), 'ttl' => 50 * Datetime::HOUR ) ); $queue->createMessages($messages);hOjHhPhQhRh™hT}r`(h›hœhY]hX]hV]hW]ra(hžXphprbeh[]uh]K_h^hhI]rch¡)rd}re(hNXjuse OpenCloud\Common\Constants\Datetime; $messages = array( array( 'body' => (object) array( 'play' => 'football' ), 'ttl' => 2 * Datetime::DAY ), array( 'body' => (object) array( 'play' => 'tennis' ), 'ttl' => 50 * Datetime::HOUR ) ); $queue->createMessages($messages);hT}rf(hV]hW]rgUotherrhahX]hY]h[]uhOj^hI]rihgXjuse OpenCloud\Common\Constants\Datetime; $messages = array( array( 'body' => (object) array( 'play' => 'football' ), 'ttl' => 2 * Datetime::DAY ), array( 'body' => (object) array( 'play' => 'tennis' ), 'ttl' => 50 * Datetime::HOUR ) ); $queue->createMessages($messages);rj…rk}rl(hNUhOjdubahRh«ubaubeubeubeubhK)rm}rn(hNUhOhhPhQhRhShT}ro(hV]hW]hX]hY]rph:ah[]rqhauh]Kah^hhI]rr(h`)rs}rt(hNX4. Get messagesruhOjmhPhQhRhdhT}rv(hV]hW]hX]hY]h[]uh]Kah^hhI]rwhgX4. Get messagesrx…ry}rz(hNjuhOjsubaubhK)r{}r|(hNUhOjmhPhQhRhShT}r}(hV]hW]hX]hY]r~h0ah[]rh auh]Kdh^hhI]r€(h`)r}r‚(hNX4.1 DescriptionrƒhOj{hPhQhRhdhT}r„(hV]hW]hX]hY]h[]uh]Kdh^hhI]r…hgX4.1 Descriptionr†…r‡}rˆ(hNjƒhOjubaubhk)r‰}rŠ(hNXCThis operation gets the message or messages in the specified queue.r‹hOj{hPhQhRhnhT}rŒ(hV]hW]hX]hY]h[]uh]Kfh^hhI]rhgXCThis operation gets the message or messages in the specified queue.rŽ…r}r(hNj‹hOj‰ubaubhk)r‘}r’(hNX@Message IDs and markers are opaque strings. Clients should make no assumptions about their format or length. Furthermore, clients should assume that there is no relationship between markers and message IDs (that is, one cannot be derived from the other). This allows for a wide variety of storage driver implementations.r“hOj{hPhQhRhnhT}r”(hV]hW]hX]hY]h[]uh]Khh^hhI]r•hgX@Message IDs and markers are opaque strings. Clients should make no assumptions about their format or length. Furthermore, clients should assume that there is no relationship between markers and message IDs (that is, one cannot be derived from the other). This allows for a wide variety of storage driver implementations.r–…r—}r˜(hNj“hOj‘ubaubhk)r™}rš(hNX1Results are ordered by age, oldest message first.r›hOj{hPhQhRhnhT}rœ(hV]hW]hX]hY]h[]uh]Knh^hhI]rhgX1Results are ordered by age, oldest message first.rž…rŸ}r (hNj›hOj™ubaubeubhK)r¡}r¢(hNUhOjmhPhQhRhShT}r£(hV]hW]hX]hY]r¤h.ah[]r¥hauh]Kqh^hhI]r¦(h`)r§}r¨(hNX4.2 Parametersr©hOj¡hPhQhRhdhT}rª(hV]hW]hX]hY]h[]uh]Kqh^hhI]r«hgX4.2 Parametersr¬…r­}r®(hNj©hOj§ubaubhk)r¯}r°(hNXA hash of options.r±hOj¡hPhQhRhnhT}r²(hV]hW]hX]hY]h[]uh]Ksh^hhI]r³hgXA hash of options.r´…rµ}r¶(hNj±hOj¯ubaubcdocutils.nodes table r·)r¸}r¹(hNUhOj¡hPhQhRUtablerºhT}r»(hV]hW]hX]hY]h[]uh]Nh^hhI]r¼cdocutils.nodes tgroup r½)r¾}r¿(hNUhT}rÀ(hY]hX]hV]hW]h[]UcolsKuhOj¸hI]rÁ(cdocutils.nodes colspec rÂ)rÃ}rÄ(hNUhT}rÅ(hY]hX]hV]hW]h[]UcolwidthKuhOj¾hI]hRUcolspecrÆubjÂ)rÇ}rÈ(hNUhT}rÉ(hY]hX]hV]hW]h[]UcolwidthK uhOj¾hI]hRjÆubjÂ)rÊ}rË(hNUhT}rÌ(hY]hX]hV]hW]h[]UcolwidthK uhOj¾hI]hRjÆubjÂ)rÍ}rÎ(hNUhT}rÏ(hY]hX]hV]hW]h[]UcolwidthMÌuhOj¾hI]hRjÆubcdocutils.nodes thead rÐ)rÑ}rÒ(hNUhT}rÓ(hV]hW]hX]hY]h[]uhOj¾hI]rÔcdocutils.nodes row rÕ)rÖ}r×(hNUhT}rØ(hV]hW]hX]hY]h[]uhOjÑhI]rÙ(cdocutils.nodes entry rÚ)rÛ}rÜ(hNUhT}rÝ(hV]hW]hX]hY]h[]uhOjÖhI]rÞhk)rß}rà(hNXNameráhOjÛhPhQhRhnhT}râ(hV]hW]hX]hY]h[]uh]KvhI]rãhgXNamerä…rå}ræ(hNjáhOjßubaubahRUentryrçubjÚ)rè}ré(hNUhT}rê(hV]hW]hX]hY]h[]uhOjÖhI]rëhk)rì}rí(hNXStylerîhOjèhPhQhRhnhT}rï(hV]hW]hX]hY]h[]uh]KvhI]rðhgXStylerñ…rò}ró(hNjîhOjìubaubahRjçubjÚ)rô}rõ(hNUhT}rö(hV]hW]hX]hY]h[]uhOjÖhI]r÷hk)rø}rù(hNXTyperúhOjôhPhQhRhnhT}rû(hV]hW]hX]hY]h[]uh]KvhI]rühgXTyperý…rþ}rÿ(hNjúhOjøubaubahRjçubjÚ)r}r(hNUhT}r(hV]hW]hX]hY]h[]uhOjÖhI]rhk)r}r(hNX DescriptionrhOjhPhQhRhnhT}r(hV]hW]hX]hY]h[]uh]KvhI]rhgX Descriptionr …r }r (hNjhOjubaubahRjçubehRUrowr ubahRUtheadr ubcdocutils.nodes tbody r)r}r(hNUhT}r(hV]hW]hX]hY]h[]uhOj¾hI]r(jÕ)r}r(hNUhT}r(hV]hW]hX]hY]h[]uhOjhI]r(jÚ)r}r(hNUhT}r(hV]hW]hX]hY]h[]uhOjhI]rhk)r}r(hNXmarkerrhOjhPhQhRhnhT}r(hV]hW]hX]hY]h[]uh]KxhI]rhgXmarkerr …r!}r"(hNjhOjubaubahRjçubjÚ)r#}r$(hNUhT}r%(hV]hW]hX]hY]h[]uhOjhI]r&hk)r'}r((hNXQueryr)hOj#hPhQhRhnhT}r*(hV]hW]hX]hY]h[]uh]KxhI]r+hgXQueryr,…r-}r.(hNj)hOj'ubaubahRjçubjÚ)r/}r0(hNUhT}r1(hV]hW]hX]hY]h[]uhOjhI]r2hk)r3}r4(hNXStringr5hOj/hPhQhRhnhT}r6(hV]hW]hX]hY]h[]uh]KxhI]r7hgXStringr8…r9}r:(hNj5hOj3ubaubahRjçubjÚ)r;}r<(hNUhT}r=(hV]hW]hX]hY]h[]uhOjhI]r>hk)r?}r@(hNX+Specifies an opaque string that the client can use to request the next batch of messages. The marker parameter communicates to the server which messages the client has already received. If you do not specify a value, the API returns all messages at the head of the queue (up to the limit). Optional.rAhOj;hPhQhRhnhT}rB(hV]hW]hX]hY]h[]uh]KxhI]rChgX+Specifies an opaque string that the client can use to request the next batch of messages. The marker parameter communicates to the server which messages the client has already received. If you do not specify a value, the API returns all messages at the head of the queue (up to the limit). Optional.rD…rE}rF(hNjAhOj?ubaubahRjçubehRj ubjÕ)rG}rH(hNUhT}rI(hV]hW]hX]hY]h[]uhOjhI]rJ(jÚ)rK}rL(hNUhT}rM(hV]hW]hX]hY]h[]uhOjGhI]rNhk)rO}rP(hNXlimitrQhOjKhPhQhRhnhT}rR(hV]hW]hX]hY]h[]uh]KzhI]rShgXlimitrT…rU}rV(hNjQhOjOubaubahRjçubjÚ)rW}rX(hNUhT}rY(hV]hW]hX]hY]h[]uhOjGhI]rZhk)r[}r\(hNXQueryr]hOjWhPhQhRhnhT}r^(hV]hW]hX]hY]h[]uh]KzhI]r_hgXQueryr`…ra}rb(hNj]hOj[ubaubahRjçubjÚ)rc}rd(hNUhT}re(hV]hW]hX]hY]h[]uhOjGhI]rfhk)rg}rh(hNXIntegerrihOjchPhQhRhnhT}rj(hV]hW]hX]hY]h[]uh]KzhI]rkhgXIntegerrl…rm}rn(hNjihOjgubaubahRjçubjÚ)ro}rp(hNUhT}rq(hV]hW]hX]hY]h[]uhOjGhI]rrhk)rs}rt(hNXzWhen more messages are available than can be returned in a single request, the client can pick up the next batch of messages by simply using the URI template parameters returned from the previous call in the "next" field. Specifies up to 10 messages (the default value) to return. If you do not specify a value for the limit parameter, the default value of 10 is used. Optional.ruhOjohPhQhRhnhT}rv(hV]hW]hX]hY]h[]uh]KzhI]rwhgXzWhen more messages are available than can be returned in a single request, the client can pick up the next batch of messages by simply using the URI template parameters returned from the previous call in the "next" field. Specifies up to 10 messages (the default value) to return. If you do not specify a value for the limit parameter, the default value of 10 is used. Optional.rx…ry}rz(hNjuhOjsubaubahRjçubehRj ubjÕ)r{}r|(hNUhT}r}(hV]hW]hX]hY]h[]uhOjhI]r~(jÚ)r}r€(hNUhT}r(hV]hW]hX]hY]h[]uhOj{hI]r‚hk)rƒ}r„(hNXechor…hOjhPhQhRhnhT}r†(hV]hW]hX]hY]h[]uh]K|hI]r‡hgXechorˆ…r‰}rŠ(hNj…hOjƒubaubahRjçubjÚ)r‹}rŒ(hNUhT}r(hV]hW]hX]hY]h[]uhOj{hI]rŽhk)r}r(hNXQueryr‘hOj‹hPhQhRhnhT}r’(hV]hW]hX]hY]h[]uh]K|hI]r“hgXQueryr”…r•}r–(hNj‘hOjubaubahRjçubjÚ)r—}r˜(hNUhT}r™(hV]hW]hX]hY]h[]uhOj{hI]ršhk)r›}rœ(hNXBooleanrhOj—hPhQhRhnhT}rž(hV]hW]hX]hY]h[]uh]K|hI]rŸhgXBooleanr …r¡}r¢(hNjhOj›ubaubahRjçubjÚ)r£}r¤(hNUhT}r¥(hV]hW]hX]hY]h[]uhOj{hI]r¦hk)r§}r¨(hNXÈDetermines whether the API returns a client's own messages. The echo parameter is a Boolean value (true or false) that determines whether the API returns a client's own messages, as determined by the uuid portion of the User-Agent header. If you do not specify a value, echo uses the default value of false. If you are experimenting with the API, you might want to set echo=true in order to see the messages that you posted. The echo parameter is optional.r©hOj£hPhQhRhnhT}rª(hV]hW]hX]hY]h[]uh]K|hI]r«hgXÈDetermines whether the API returns a client's own messages. The echo parameter is a Boolean value (true or false) that determines whether the API returns a client's own messages, as determined by the uuid portion of the User-Agent header. If you do not specify a value, echo uses the default value of false. If you are experimenting with the API, you might want to set echo=true in order to see the messages that you posted. The echo parameter is optional.r¬…r­}r®(hNj©hOj§ubaubahRjçubehRj ubjÕ)r¯}r°(hNUhT}r±(hV]hW]hX]hY]h[]uhOjhI]r²(jÚ)r³}r´(hNUhT}rµ(hV]hW]hX]hY]h[]uhOj¯hI]r¶hk)r·}r¸(hNXinclude\_claimedhOj³hPhQhRhnhT}r¹(hV]hW]hX]hY]h[]uh]K~hI]rºhgXinclude_claimedr»…r¼}r½(hNXinclude\_claimedhOj·ubaubahRjçubjÚ)r¾}r¿(hNUhT}rÀ(hV]hW]hX]hY]h[]uhOj¯hI]rÁhk)rÂ}rÃ(hNXQueryrÄhOj¾hPhQhRhnhT}rÅ(hV]hW]hX]hY]h[]uh]K~hI]rÆhgXQueryrÇ…rÈ}rÉ(hNjÄhOjÂubaubahRjçubjÚ)rÊ}rË(hNUhT}rÌ(hV]hW]hX]hY]h[]uhOj¯hI]rÍhk)rÎ}rÏ(hNX ​BooleanrÐhOjÊhPhQhRhnhT}rÑ(hV]hW]hX]hY]h[]uh]K~hI]rÒhgX ​BooleanrÓ…rÔ}rÕ(hNjÐhOjÎubaubahRjçubjÚ)rÖ}r×(hNUhT}rØ(hV]hW]hX]hY]h[]uhOj¯hI]rÙhk)rÚ}rÛ(hNX`Determines whether the API returns claimed messages and unclaimed messages. The include\_claimed parameter is a Boolean value (true or false) that determines whether the API returns claimed messages and unclaimed messages. If you do not specify a value, include\_claimed uses the default value of false (only unclaimed messages are returned). Optional.rÜhOjÖhPhQhRhnhT}rÝ(hV]hW]hX]hY]h[]uh]K~hI]rÞhgX^Determines whether the API returns claimed messages and unclaimed messages. The include_claimed parameter is a Boolean value (true or false) that determines whether the API returns claimed messages and unclaimed messages. If you do not specify a value, include_claimed uses the default value of false (only unclaimed messages are returned). Optional.rß…rà}rá(hNX`Determines whether the API returns claimed messages and unclaimed messages. The include\_claimed parameter is a Boolean value (true or false) that determines whether the API returns claimed messages and unclaimed messages. If you do not specify a value, include\_claimed uses the default value of false (only unclaimed messages are returned). Optional.hOjÚubaubahRjçubehRj ubehRUtbodyrâubehRUtgrouprãubaubeubhK)rä}rå(hNUhOjmhPhQhRhShT}ræ(hV]hW]hX]hY]rçh7ah[]rèhauh]K‚h^hhI]ré(h`)rê}rë(hNX4.3 Code samplerìhOjähPhQhRhdhT}rí(hV]hW]hX]hY]h[]uh]K‚h^hhI]rîhgX4.3 Code samplerï…rð}rñ(hNjìhOjêubaubh–)rò}ró(hNXÐ$messages = $queue->listMessages(array( 'marker' => '51db6f78c508f17ddc924357', 'limit' => 20, 'echo' => true )); while ($message = $messages->next()) { echo $message->getId() . PHP_EOL; }hOjähPhQhRh™hT}rô(h›hœhY]hX]hV]hW]rõ(hžXphpröeh[]uh]Kh^hhI]r÷h¡)rø}rù(hNXÐ$messages = $queue->listMessages(array( 'marker' => '51db6f78c508f17ddc924357', 'limit' => 20, 'echo' => true )); while ($message = $messages->next()) { echo $message->getId() . PHP_EOL; }hT}rú(hV]hW]rûUotherrüahX]hY]h[]uhOjòhI]rýhgXÐ$messages = $queue->listMessages(array( 'marker' => '51db6f78c508f17ddc924357', 'limit' => 20, 'echo' => true )); while ($message = $messages->next()) { echo $message->getId() . PHP_EOL; }rþ…rÿ}r(hNUhOjøubahRh«ubaubeubeubhK)r}r(hNUhOhhPhQhRhShT}r(hV]hW]hX]hY]rhEah[]rhauh]K‘h^hhI]r(h`)r}r(hNX5. Get a set of messages by IDr hOjhPhQhRhdhT}r (hV]hW]hX]hY]h[]uh]K‘h^hhI]r hgX5. Get a set of messages by IDr …r }r(hNj hOjubaubhK)r}r(hNUhOjhPhQhRhShT}r(hV]hW]hX]hY]rhah[]r)hauh]Kœh^hhI]r*(h`)r+}r,(hNX5.2 Parametersr-hOj%hPhQhRhdhT}r.(hV]hW]hX]hY]h[]uh]Kœh^hhI]r/hgX5.2 Parametersr0…r1}r2(hNj-hOj+ubaubhk)r3}r4(hNXA hash of options.r5hOj%hPhQhRhnhT}r6(hV]hW]hX]hY]h[]uh]Kžh^hhI]r7hgXA hash of options.r8…r9}r:(hNj5hOj3ubaubhk)r;}r<(hNXp\|Name\|Style\|Type\|Description\| \|----\|-----\|----\|-----------\| \|ids\|Query\|String\|Specifies the IDs of the messages to get. Format multiple message ID values by separating them with commas (comma-separated). Optional.\| \|claim\_id\|Query\|​String\|Specifies the claim ID with which the message is associated. Optional.\| \|----\|-----\|----\|-----------\|hOj%hPhQhRhnhT}r=(hV]hW]hX]hY]h[]uh]K h^hhI]r>hgXV|Name|Style|Type|Description| |----|-----|----|-----------| |ids|Query|String|Specifies the IDs of the messages to get. Format multiple message ID values by separating them with commas (comma-separated). Optional.| |claim_id|Query|​String|Specifies the claim ID with which the message is associated. Optional.| |----|-----|----|-----------|r?…r@}rA(hNXp\|Name\|Style\|Type\|Description\| \|----\|-----\|----\|-----------\| \|ids\|Query\|String\|Specifies the IDs of the messages to get. Format multiple message ID values by separating them with commas (comma-separated). Optional.\| \|claim\_id\|Query\|​String\|Specifies the claim ID with which the message is associated. Optional.\| \|----\|-----\|----\|-----------\|hOj;ubaubeubhK)rB}rC(hNUhOjhPhQhRhShT}rD(hV]hW]hX]hY]rEh;ah[]rFhauh]K¨h^hhI]rG(h`)rH}rI(hNX5.3 Code samplerJhOjBhPhQhRhdhT}rK(hV]hW]hX]hY]h[]uh]K¨h^hhI]rLhgX5.3 Code samplerM…rN}rO(hNjJhOjHubaubh–)rP}rQ(hNXÎ$ids = array('51db6f78c508f17ddc924357', 'f5b8c8a7c62b0150b68a50d6'); $messages = $queue->listMessages(array('ids' => $ids)); while ($message = $messages->next()) { echo $message->getId() . PHP_EOL; }hOjBhPhQhRh™hT}rR(h›hœhY]hX]hV]hW]rS(hžXphprTeh[]uh]K³h^hhI]rUh¡)rV}rW(hNXÎ$ids = array('51db6f78c508f17ddc924357', 'f5b8c8a7c62b0150b68a50d6'); $messages = $queue->listMessages(array('ids' => $ids)); while ($message = $messages->next()) { echo $message->getId() . PHP_EOL; }hT}rX(hV]hW]rYUotherrZahX]hY]h[]uhOjPhI]r[hgXÎ$ids = array('51db6f78c508f17ddc924357', 'f5b8c8a7c62b0150b68a50d6'); $messages = $queue->listMessages(array('ids' => $ids)); while ($message = $messages->next()) { echo $message->getId() . PHP_EOL; }r\…r]}r^(hNUhOjVubahRh«ubaubeubeubhK)r_}r`(hNUhOhhPhQhRhShT}ra(hV]hW]hX]hY]rbh9ah[]rchauh]Kµh^hhI]rd(h`)re}rf(hNX!6. Delete a set of messages by IDrghOj_hPhQhRhdhT}rh(hV]hW]hX]hY]h[]uh]Kµh^hhI]rihgX!6. Delete a set of messages by IDrj…rk}rl(hNjghOjeubaubhK)rm}rn(hNUhOj_hPhQhRhShT}ro(hV]hW]hX]hY]rph-ah[]rqhauh]K¸h^hhI]rr(h`)rs}rt(hNX6.1 DescriptionruhOjmhPhQhRhdhT}rv(hV]hW]hX]hY]h[]uh]K¸h^hhI]rwhgX6.1 Descriptionrx…ry}rz(hNjuhOjsubaubhk)r{}r|(hNX³This operation immediately deletes the specified messages. If any of the message IDs are malformed or non-existent, they are ignored. The remaining valid messages IDs are deleted.r}hOjmhPhQhRhnhT}r~(hV]hW]hX]hY]h[]uh]Kºh^hhI]rhgX³This operation immediately deletes the specified messages. If any of the message IDs are malformed or non-existent, they are ignored. The remaining valid messages IDs are deleted.r€…r}r‚(hNj}hOj{ubaubeubhK)rƒ}r„(hNUhOj_hPhQhRhShT}r…(hV]hW]hX]hY]r†h4ah[]r‡hauh]K¿h^hhI]rˆ(h`)r‰}rŠ(hNX6.2 Parametersr‹hOjƒhPhQhRhdhT}rŒ(hV]hW]hX]hY]h[]uh]K¿h^hhI]rhgX6.2 ParametersrŽ…r}r(hNj‹hOj‰ubaubhk)r‘}r’(hNXAn array of IDs.r“hOjƒhPhQhRhnhT}r”(hV]hW]hX]hY]h[]uh]KÁh^hhI]r•hgXAn array of IDs.r–…r—}r˜(hNj“hOj‘ubaubeubhK)r™}rš(hNUhOj_hPhQhRhShT}r›(hV]hW]hX]hY]rœhAah[]rhauh]KÄh^hhI]rž(h`)rŸ}r (hNX6.3 Code sampler¡hOj™hPhQhRhdhT}r¢(hV]hW]hX]hY]h[]uh]KÄh^hhI]r£hgX6.3 Code sampler¤…r¥}r¦(hNj¡hOjŸubaubh–)r§}r¨(hNXp$ids = array('51db6f78c508f17ddc924357', 'f5b8c8a7c62b0150b68a50d6'); $response = $queue->deleteMessages($ids);hOj™hPhQhRh™hT}r©(h›hœhY]hX]hV]hW]rª(hžXphpr«eh[]uh]KËh^hhI]r¬h¡)r­}r®(hNXp$ids = array('51db6f78c508f17ddc924357', 'f5b8c8a7c62b0150b68a50d6'); $response = $queue->deleteMessages($ids);hT}r¯(hV]hW]r°Uotherr±ahX]hY]h[]uhOj§hI]r²hgXp$ids = array('51db6f78c508f17ddc924357', 'f5b8c8a7c62b0150b68a50d6'); $response = $queue->deleteMessages($ids);r³…r´}rµ(hNUhOj­ubahRh«ubaubeubeubhK)r¶}r·(hNUhOhhPhQhRhShT}r¸(hV]hW]hX]hY]r¹h,ah[]rºhauh]KÍh^hhI]r»(h`)r¼}r½(hNX7. Get a specific messager¾hOj¶hPhQhRhdhT}r¿(hV]hW]hX]hY]h[]uh]KÍh^hhI]rÀhgX7. Get a specific messagerÁ…rÂ}rÃ(hNj¾hOj¼ubaubhK)rÄ}rÅ(hNUhOj¶hPhQhRhShT}rÆ(hV]hW]hX]hY]rÇh6ah[]rÈhauh]KÐh^hhI]rÉ(h`)rÊ}rË(hNX7.1 DescriptionrÌhOjÄhPhQhRhdhT}rÍ(hV]hW]hX]hY]h[]uh]KÐh^hhI]rÎhgX7.1 DescriptionrÏ…rÐ}rÑ(hNjÌhOjÊubaubhk)rÒ}rÓ(hNXCThis operation gets the specified message from the specified queue.rÔhOjÄhPhQhRhnhT}rÕ(hV]hW]hX]hY]h[]uh]KÒh^hhI]rÖhgXCThis operation gets the specified message from the specified queue.r×…rØ}rÙ(hNjÔhOjÒubaubeubhK)rÚ}rÛ(hNUhOj¶hPhQhRhShT}rÜ(hV]hW]hX]hY]rÝhGah[]rÞh!auh]KÕh^hhI]rß(h`)rà}rá(hNX7.2 ParametersrâhOjÚhPhQhRhdhT}rã(hV]hW]hX]hY]h[]uh]KÕh^hhI]rähgX7.2 Parametersrå…ræ}rç(hNjâhOjàubaubhk)rè}ré(hNX Message ID.rêhOjÚhPhQhRhnhT}rë(hV]hW]hX]hY]h[]uh]K×h^hhI]rìhgX Message ID.rí…rî}rï(hNjêhOjèubaubeubhK)rð}rñ(hNUhOj¶hPhQhRhShT}rò(hV]hW]hX]hY]róh@ah[]rôhauh]KÚh^hhI]rõ(h`)rö}r÷(hNX7.3 Object propertiesrøhOjðhPhQhRhdhT}rù(hV]hW]hX]hY]h[]uh]KÚh^hhI]rúhgX7.3 Object propertiesrû…rü}rý(hNjøhOjöubaubhk)rþ}rÿ(hNXx``href`` is an opaque relative URI that the client can use to uniquely identify a message resource and interact with it.hOjðhPhQhRhnhT}r(hV]hW]hX]hY]h[]uh]KÜh^hhI]r(h×)r}r(hNX``href``hT}r(hV]hW]hX]hY]h[]uhOjþhI]rhgXhrefr…r}r(hNUhOjubahRhßubhgXp is an opaque relative URI that the client can use to uniquely identify a message resource and interact with it.r …r }r (hNXp is an opaque relative URI that the client can use to uniquely identify a message resource and interact with it.hOjþubeubhk)r }r (hNXq``ttl`` is the TTL that was set on the message when it was posted. The message expires after (ttl - age) seconds.hOjðhPhQhRhnhT}r(hV]hW]hX]hY]h[]uh]Kßh^hhI]r(h×)r}r(hNX``ttl``hT}r(hV]hW]hX]hY]h[]uhOj hI]rhgXttlr…r}r(hNUhOjubahRhßubhgXj is the TTL that was set on the message when it was posted. The message expires after (ttl - age) seconds.r…r}r(hNXj is the TTL that was set on the message when it was posted. The message expires after (ttl - age) seconds.hOj ubeubhk)r}r(hNX@``age`` is the number of seconds relative to the server's clock.rhOjðhPhQhRhnhT}r(hV]hW]hX]hY]h[]uh]Kâh^hhI]r(h×)r}r (hNX``age``hT}r!(hV]hW]hX]hY]h[]uhOjhI]r"hgXager#…r$}r%(hNUhOjubahRhßubhgX9 is the number of seconds relative to the server's clock.r&…r'}r((hNX9 is the number of seconds relative to the server's clock.hOjubeubhk)r)}r*(hNXd``body`` is the arbitrary document that was submitted with the original request to post the message.hOjðhPhQhRhnhT}r+(hV]hW]hX]hY]h[]uh]Käh^hhI]r,(h×)r-}r.(hNX``body``hT}r/(hV]hW]hX]hY]h[]uhOj)hI]r0hgXbodyr1…r2}r3(hNUhOj-ubahRhßubhgX\ is the arbitrary document that was submitted with the original request to post the message.r4…r5}r6(hNX\ is the arbitrary document that was submitted with the original request to post the message.hOj)ubeubeubhK)r7}r8(hNUhOj¶hPhQhRhShT}r9(hV]hW]hX]hY]r:h5ah[]r;hauh]Kèh^hhI]r<(h`)r=}r>(hNX7.4 Code sampler?hOj7hPhQhRhdhT}r@(hV]hW]hX]hY]h[]uh]Kèh^hhI]rAhgX7.4 Code samplerB…rC}rD(hNj?hOj=ubaubh–)rE}rF(hNX:$message = $queue->getMessage('51db6f78c508f17ddc924357');hOj7hPhQhRh™hT}rG(h›hœhY]hX]hV]hW]rH(hžXphprIeh[]uh]Kíh^hhI]rJh¡)rK}rL(hNX:$message = $queue->getMessage('51db6f78c508f17ddc924357');hT}rM(hV]hW]rNUotherrOahX]hY]h[]uhOjEhI]rPhgX:$message = $queue->getMessage('51db6f78c508f17ddc924357');rQ…rR}rS(hNUhOjKubahRh«ubaubeubeubhK)rT}rU(hNUhOhhPhQhRhShT}rV(hV]hW]hX]hY]rWh1ah[]rXh auh]Kïh^hhI]rY(h`)rZ}r[(hNX8. Delete messager\hOjThPhQhRhdhT}r](hV]hW]hX]hY]h[]uh]Kïh^hhI]r^hgX8. Delete messager_…r`}ra(hNj\hOjZubaubhK)rb}rc(hNUhOjThPhQhRhShT}rd(hV]hW]hX]hY]rehFah[]rfh auh]Kòh^hhI]rg(h`)rh}ri(hNX8.1 DescriptionrjhOjbhPhQhRhdhT}rk(hV]hW]hX]hY]h[]uh]Kòh^hhI]rlhgX8.1 Descriptionrm…rn}ro(hNjjhOjhubaubhk)rp}rq(hNX9This operation immediately deletes the specified message.rrhOjbhPhQhRhnhT}rs(hV]hW]hX]hY]h[]uh]Kôh^hhI]rthgX9This operation immediately deletes the specified message.ru…rv}rw(hNjrhOjpubaubeubhK)rx}ry(hNUhOjThPhQhRhShT}rz(hV]hW]hX]hY]r{hCah[]r|hauh]K÷h^hhI]r}(h`)r~}r(hNX8.2 Parametersr€hOjxhPhQhRhdhT}r(hV]hW]hX]hY]h[]uh]K÷h^hhI]r‚hgX8.2 Parametersrƒ…r„}r…(hNj€hOj~ubaubhk)r†}r‡(hNXNone.rˆhOjxhPhQhRhnhT}r‰(hV]hW]hX]hY]h[]uh]Kùh^hhI]rŠhgXNone.r‹…rŒ}r(hNjˆhOj†ubaubeubhK)rŽ}r(hNUhOjThPhQhRhShT}r(hV]hW]hX]hY]r‘h2ah[]r’h auh]Küh^hhI]r“(h`)r”}r•(hNX8.3 Code sampler–hOjŽhPhQhRhdhT}r—(hV]hW]hX]hY]h[]uh]Küh^hhI]r˜hgX8.3 Code sampler™…rš}r›(hNj–hOj”ubaubh–)rœ}r(hNX$message->delete();hOjŽhPhQhRh™hT}rž(h›hœhY]hX]hV]hW]rŸ(hžXphpr eh[]uh]Mh^hhI]r¡h¡)r¢}r£(hNX$message->delete();hT}r¤(hV]hW]r¥Uotherr¦ahX]hY]h[]uhOjœhI]r§hgX$message->delete();r¨…r©}rª(hNUhOj¢ubahRh«ubaubeubeubehNUU transformerr«NU footnote_refsr¬}r­Urefnamesr®}r¯Usymbol_footnotesr°]r±Uautofootnote_refsr²]r³Usymbol_footnote_refsr´]rµU citationsr¶]r·h^hU current_liner¸NUtransform_messagesr¹]rºUreporterr»NUid_startr¼KU autofootnotesr½]r¾U citation_refsr¿}rÀUindirect_targetsrÁ]rÂUsettingsrÃ(cdocutils.frontend Values rÄorÅ}rÆ(Ufootnote_backlinksrÇKUrecord_dependenciesrÈNU rfc_base_urlrÉUhttp://tools.ietf.org/html/rÊU tracebackrˈUpep_referencesrÌNUstrip_commentsrÍNU toc_backlinksrÎjçU language_coderÏUenrÐU datestamprÑNU report_levelrÒKU _destinationrÓNU halt_levelrÔKU strip_classesrÕNhdNUerror_encoding_error_handlerrÖUbackslashreplacer×UdebugrØNUembed_stylesheetrÙ‰Uoutput_encoding_error_handlerrÚUstrictrÛU sectnum_xformrÜKUdump_transformsrÝNU docinfo_xformrÞKUwarning_streamrßNUpep_file_url_templateràUpep-%04dráUexit_status_levelrâKUconfigrãNUstrict_visitorräNUcloak_email_addressesråˆUtrim_footnote_reference_spaceræ‰UenvrçNUdump_pseudo_xmlrèNUexpose_internalsréNUsectsubtitle_xformrê‰U source_linkrëNUrfc_referencesrìNUoutput_encodingríUutf-8rîU source_urlrïNUinput_encodingrðU utf-8-sigrñU_disable_configròNU id_prefixróUU tab_widthrôKUerror_encodingrõUUTF-8röU_sourcer÷hQUgettext_compactrøˆU generatorrùNUdump_internalsrúNU smart_quotesrû‰U pep_base_urlrüUhttp://www.python.org/dev/peps/rýUsyntax_highlightrþUlongrÿUinput_encoding_error_handlerrjÛUauto_id_prefixrUidrUdoctitle_xformr‰Ustrip_elements_with_classesrNU _config_filesr]Ufile_insertion_enabledrˆU raw_enabledrKU dump_settingsrNubUsymbol_footnote_startr KUidsr }r (h7jäh@jðh1jTh9j_h?jHhGjÚhHhíh6jÄh3hLh4jƒh>j%h;jBh.j¡h