readCursorRequest

Reads from the container at the current cursor position. For more information please see Section 1.9, Getting Items.

Request

<readCursorRequest>
   <container type="types:uid"/>
   <cursor type="int"/>
   <forward type="boolean"/>
   <position type="types:CursorSeek"/>
   <count" type="int"/>
</readCursorRequest>

Response

<readCursorResponse>
   <items type="types:ItemList"/>
   <status type="types:Status"/>
</readCursorResponse>

Elements

container: Specifies the ID of the container.
cursor: Specifies the value returned from createCursorRequest.
forward: Specifies whether to read forward or backward.
position: Specifies the anchor position of the cursor: current, start, or end.
count: Specifies the number of items to read. The cursor is then repositioned by the number in the count element.
code: Returns the error number related to the event. 0 indicates that the request was successful.
status: Returns the success or failure of the method.

Example

<readCursorRequest> 
   <container>7.domain1.po1.100.0.1.0.1@16</container> 
   <cursor>1184907119</cursor> 
   <forward>false</forward> 
   <position>current</position> 
   <count>5</count> 
</readCursorRequest>

<readCursorResponse>
   <items> 
      <item>
         <id>450AD3EB.domain1.po1.100.16E3837.1.101E.1@1:7.
               domain1.po1.100.0.1.0.1@16</id> 
         <modified>2012-09-19T19:26:34Z</modified> 
         <container>7.domain1.po1.100.0.1.0.1@16</container> 
         <source>received</source> 
         <subject>20</subject> 
      </item> 
      <item> 
         <id>450AD3E5.domain1.po1.100.16E3837.1.101C.1@1:7.
               domain1.po1.100.0.1.0.1@16</id> 
         <modified>2012-09-19T19:26:33Z</modified> 
         <container>7.domain1.po1.100.0.1.0.1@16</container> 
         <source>received</source> 
         <subject>19</subject> 
      </item> 
      <item>
         <id>450AD3E0.domain1.po1.100.16E3837.1.101A.1@1:7.
               domain1.po1.100.0.1.0.1@16</id> 
         <modified>2012-09-19T19:26:33Z</modified> 
         <container>7.domain1.po1.100.0.1.0.1@16</container> 
         <source>received</source> 
         <subject>18</subject> 
      </item> 
      <item>
         <id>450AD3DA.domain1.po1.100.16E3837.1.1018.1@1:7.
               domain1.po1.100.0.1.0.1@16</id> 
         <modified>2012-09-19T19:26:32Z</modified> 
         <container>7.domain1.po1.100.0.1.0.1@16</container> 
         <source>received</source> 
         <subject>17</subject> 
      </item> 
      <item>
         <id>450AD3D4.domain1.po1.100.16E3837.1.1016.1@1:7.
               domain1.po1.100.0.1.0.1@16</id> 
         <modified>2012-09-19T19:26:32Z</modified> 
         <container>7.domain1.po1.100.0.1.0.1@16</container> 
         <source>received</source> 
         <subject>16</subject> 
      </item> 
   </items>
</readCursorResponse>