IndexedPageItemView

Artikel
03/29/2023

The IndexedPageItemView element describes how paged conversation or item information is returned for a FindItem operation or FindConversation operation request.

<IndexedPageViewItemView MaxEntriesReturned="" Offset="" BasePoint=""/>

IndexedPageViewType

Attributes and elements

The following sections describe attributes, child elements, and parent elements.

Attributes

Attribute	Description
MaxEntriesReturned	Describes the maximum number of items or conversations to return in the response. This attribute is optional.
Offset	Describes the offset from the BasePoint. If BasePoint is equal to Beginning, the offset is positive. If BasePoint is equal to End, the offset is handled as if it were negative. This identifies which item or conversation will be the first to be delivered in the response. This attribute is required.
BasePoint	Describes whether the page of items or conversations will start from the beginning or the end of the set of items or conversations that are found by using the search criteria. Seeking from the end always searches backward. This attribute is required.

BasePoint Attribute

Value	Description
Beginning	The paged view starts at the beginning of the found conversation or item set.
End	The paged view starts at the end of the found conversation or item set.

Child elements

None.

Parent elements

Element	Description
FindItem	Defines a request to find items in a mailbox. The following is the XPath expression to this element: `/FindItem`
FindConversation	Defines a request to find conversations in a mailbox.

Remarks

Seeking from the end involves moving to the origin identified by the offset. Additionally, the pointer is moved back by the number of requested records. For example, if there are 100 records and the offset is 25 from the end, the search starts from 75. If 10 records are returned, the pointer is moved backward an additional 10 records to 65 and returns records 65 through 75. The next index is 64. The next offset from the end for a page is 100 minus 64 which equals 36. 36 is the value for the next offset from the end to get the next indexed page.

The schema that describes this element is located in the IIS virtual directory that hosts Exchange Web Services.

Example

The following example shows a FindItem operation request. Each item is returned with its ID and subject. A maximum of six items are returned in the response, as specified by the MaxEntriesReturned attribute. The items are listed in ascending order grouped by importance. Items in a group are aggregated by subject.

<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
               xmlns:xsd="http://www.w3.org/2001/XMLSchema"
               xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/"
               xmlns:t="http://schemas.microsoft.com/exchange/services/2006/types">
  <soap:Body>
    <FindItem Traversal="Shallow" xmlns="http://schemas.microsoft.com/exchange/services/2006/messages">
      <ItemShape>
        <t:BaseShape>IdOnly</t:BaseShape>
        <t:AdditionalProperties>
          <t:FieldURI FieldURI="item:Subject"/>
        </t:AdditionalProperties>
      </ItemShape>
      <IndexedPageItemView MaxEntriesReturned="6" BasePoint="Beginning" Offset="0" />
      <GroupBy Order="Ascending">
        <t:FieldURI FieldURI="item:Importance"/>
        <t:AggregateOn Aggregate="Maximum">
          <t:FieldURI FieldURI="item:Subject"/>
        </t:AggregateOn>
      </GroupBy>
      <ParentFolderIds>
        <t:DistinguishedFolderId Id="inbox"/>
      </ParentFolderIds>
    </FindItem>
  </soap:Body>
</soap:Envelope>

Element information

Element	Example
Namespace	http://schemas.microsoft.com/exchange/services/2006/messages
Schema Name	Messages schema
Validation File	Messages.xsd
Can be Empty	False

Dela via