Aspose::Email::Clients::Imap::ImapPageInfo Class Reference

Contains information about retrieved page when paging methods are used. More...

Inherits Aspose::Email::Clients::PageInfo.

Public Member Functions

System::SharedPtr< System::Collections::Generic::ListExt< int64_t > > get_SearchedSeqNums () const
 Gets collection of ImapMessageInfo objects More...
 
System::SharedPtr< ImapMessageInfoCollectionget_Items () const
 Gets collection of ImapMessageInfo objects More...
 
void set_Items (System::SharedPtr< ImapMessageInfoCollection > value)
 Gets collection of ImapMessageInfo objects More...
 
System::SharedPtr< PageInfoget_NextPage () override
 Information of the next page or null if current page is last More...
 
 ImapPageInfo (int32_t totalCount, int32_t itemsPerPage, int32_t offset, bool lastPage, System::SharedPtr< System::Collections::Generic::ListExt< int64_t >> searchedSeqNums)
 Initializes a new instance of the ImapPageInfo class More...
 
 ImapPageInfo (int32_t totalCount, int32_t itemsPerPage, int32_t offset, bool lastPage, System::SharedPtr< ImapMessageInfoCollection > items)
 Initializes a new instance of the ImapPageInfo class More...
 
- Public Member Functions inherited from Aspose::Email::Clients::PageInfo
int32_t get_PageOffset () const
 Gets offset of a page More...
 
void set_PageOffset (int32_t value)
 Gets offset of a page More...
 
int32_t get_AbsoluteOffset () const
 Gets additinal offset added to start index of a page More...
 
void set_AbsoluteOffset (int32_t value)
 Gets additinal offset added to start index of a page More...
 
bool get_LastPage () const
 Indicates whether current page is last page in view. More...
 
void set_LastPage (bool value)
 Indicates whether current page is last page in view. More...
 
int32_t get_TotalCount () const
 Gets total count of items in view More...
 
void set_TotalCount (int32_t value)
 Gets total count of items in view More...
 
int32_t get_ItemsPerPage () const
 A number of items in page More...
 
void set_ItemsPerPage (int32_t value)
 A number of items in page More...
 
 PageInfo (int32_t itemsPerPage)
 Initializes a new instance of the PageInfo class More...
 
 PageInfo (int32_t itemsPerPage, int32_t offset)
 Initializes a new instance of the PageInfo class More...
 
 PageInfo (int32_t totalCount, int32_t itemsPerPage, int32_t offset, bool lastPage)
 Initializes a new instance of the PageInfo class More...
 
 PageInfo (int32_t totalCount, int32_t itemsPerPage, int32_t offset, int32_t absoluteOffset, bool lastPage)
 Initializes a new instance of the PageInfo class More...
 

Friends

class Aspose::Email::Clients::Imap::Commands::ListMessagesByPageGrCommand
 

Additional Inherited Members

- Protected Attributes inherited from Aspose::Email::Clients::PageInfo
System::SharedPtr< PageInfonext
 

Detailed Description

Contains information about retrieved page when paging methods are used.

Constructor & Destructor Documentation

◆ ImapPageInfo() [1/2]

Aspose::Email::Clients::Imap::ImapPageInfo::ImapPageInfo ( int32_t  totalCount,
int32_t  itemsPerPage,
int32_t  offset,
bool  lastPage,
System::SharedPtr< System::Collections::Generic::ListExt< int64_t >>  searchedSeqNums 
)

Initializes a new instance of the ImapPageInfo class

Parameters
totalCountTotal count of items in view
itemsPerPageA number of items in page
offsetoffset in view of a page
lastPageIndicates whether current page is last page in view
searchedSeqNumsA searched items collection

◆ ImapPageInfo() [2/2]

Aspose::Email::Clients::Imap::ImapPageInfo::ImapPageInfo ( int32_t  totalCount,
int32_t  itemsPerPage,
int32_t  offset,
bool  lastPage,
System::SharedPtr< ImapMessageInfoCollection items 
)

Initializes a new instance of the ImapPageInfo class

Parameters
totalCountTotal count of items in view
offsetoffset in view of a page
lastPageIndicates whether current page is last page in view
itemsPerPageA number of items in page
itemsA collection of ImapMessageInfo objects

Member Function Documentation

◆ get_Items()

System::SharedPtr<ImapMessageInfoCollection> Aspose::Email::Clients::Imap::ImapPageInfo::get_Items ( ) const

Gets collection of ImapMessageInfo objects

◆ get_NextPage()

System::SharedPtr<PageInfo> Aspose::Email::Clients::Imap::ImapPageInfo::get_NextPage ( )
overridevirtual

Information of the next page or null if current page is last

Reimplemented from Aspose::Email::Clients::PageInfo.

◆ get_SearchedSeqNums()

System::SharedPtr<System::Collections::Generic::ListExt<int64_t> > Aspose::Email::Clients::Imap::ImapPageInfo::get_SearchedSeqNums ( ) const

Gets collection of ImapMessageInfo objects

◆ set_Items()

void Aspose::Email::Clients::Imap::ImapPageInfo::set_Items ( System::SharedPtr< ImapMessageInfoCollection value)

Gets collection of ImapMessageInfo objects

Friends And Related Function Documentation

◆ Aspose::Email::Clients::Imap::Commands::ListMessagesByPageGrCommand

friend class Aspose::Email::Clients::Imap::Commands::ListMessagesByPageGrCommand
friend