Class MessageCollectionResult

Inheritance Relationships

Base Type

Class Documentation

class MessageCollectionResult : public csp::systems::ResultBase

Data class used to contain information when retrieving a collection of messages.

Public Functions

csp::common::Array<MessageInfo> &GetMessages()

Gets the list of messages, as message info objects, from this result.

@retrun Array of message info objects.

const csp::common::Array<MessageInfo> &GetMessages() const

Gets the list of messages, as message info objects, from this result.

@retrun Array of message info objects.

uint64_t GetTotalCount() const

Retrieves the total number of messages in the conversation.

If the async operation was using pagination this count number represents the sum of how many messages exist in all pages. If the async operation is not using pagination this count number will be equal to the ConversationMessages array size.

Returns

uint64_t : count number as described above.

void SetTotalCount(uint64_t Value)

Sets the value returned by GetTotalCount()

inline MessageCollectionResult(csp::systems::EResultCode ResCode, uint16_t HttpResCode)