SbMessageCollection

Collection that handles message lists, also supporting local caching. More...

Inheritance diagram for SbMessageCollection:

Public Member Functions
void	Initialize (SbMessageCollectionInitHandler inMessageCollectionInitHandler)
	Initializes this collection from startingPoint. More...
void	Dispose ()
	Disposes current MessageCollection and stops all events from being received. More...
void	LoadNext (SbMessageListHandler inCompletionHandler)
	Loads next (latest direction) message lists. More...
void	LoadPrevious (SbMessageListHandler inCompletionHandler)
	Loads previous (oldest direction) message lists. More...
void	RemoveAllFailedMessages (SbErrorHandler inCompletionHandler)
	Remove all failed messages of this BaseMessageCollection More...
void	RemoveFailedMessages (List< SbBaseMessage > inFailedMessages, SbRemoveFailedMessagesHandler inCompletionHandler)
	Remove specific failed messages of this BaseMessageCollection More...

Properties
SbGroupChannel	GroupChannel [get]
	The SbGroupChannel tracked by this SbMessageCollection. More...
IReadOnlyList< SbBaseMessage >	SucceededMessages [get]
	The list of succeeded message list in this collection. More...
IReadOnlyList< SbBaseMessage >	FailedMessages [get]
	The failed message lists. More...
IReadOnlyList< SbBaseMessage >	PendingMessages [get]
	The pending message lists. More...
long	StartingPoint [get]
	The starting point of the collection. More...
bool	HasNext [get]
	Whether there's more data to load in next (latest) direction. More...
bool	HasPrevious [get]
	Whether there's more data to load in previous (oldest) direction. More...
SbMessageCollectionHandler	MessageCollectionHandler [get, set]

Detailed Description

Collection that handles message lists, also supporting local caching.

Since

4.0.0

Member Function Documentation

Dispose()

void Dispose

(

)

Disposes current MessageCollection and stops all events from being received.

Since

4.0.0

Initialize()

void Initialize

(

SbMessageCollectionInitHandler

inMessageCollectionInitHandler

)

Initializes this collection from startingPoint.

Parameters

inMessageCollectionInitHandler

Since

4.0.0

LoadNext()

void LoadNext

(

SbMessageListHandler

inCompletionHandler

)

Loads next (latest direction) message lists.

Parameters

inCompletionHandler

Since

4.0.0

LoadPrevious()

void LoadPrevious

(

SbMessageListHandler

inCompletionHandler

)

Loads previous (oldest direction) message lists.

Parameters

inCompletionHandler

Since

4.0.0

RemoveAllFailedMessages()

void RemoveAllFailedMessages

(

SbErrorHandler

inCompletionHandler

)

Remove all failed messages of this BaseMessageCollection

Parameters

inCompletionHandler

Since

4.0.0

RemoveFailedMessages()

void RemoveFailedMessages	(	List< SbBaseMessage >	inFailedMessages,
		SbRemoveFailedMessagesHandler	inCompletionHandler
	)

Remove specific failed messages of this BaseMessageCollection

Parameters

inFailedMessages
inCompletionHandler

Since

4.0.0

Property Documentation

FailedMessages

IReadOnlyList<SbBaseMessage> FailedMessages

get

The failed message lists.

Since

4.0.0

GroupChannel

SbGroupChannel GroupChannel

get

The SbGroupChannel tracked by this SbMessageCollection.

Since

4.0.0

HasNext

bool HasNext

get

Whether there's more data to load in next (latest) direction.

Since

4.0.0

HasPrevious

bool HasPrevious

get

Whether there's more data to load in previous (oldest) direction.

Since

4.0.0

MessageCollectionHandler

SbMessageCollectionHandler MessageCollectionHandler

getset

Since

4.0.0

PendingMessages

IReadOnlyList<SbBaseMessage> PendingMessages

get

The pending message lists.

Since

4.0.0

StartingPoint

long StartingPoint

get

The starting point of the collection.

Since

4.0.0

SucceededMessages

IReadOnlyList<SbBaseMessage> SucceededMessages

get

The list of succeeded message list in this collection.

Since

4.0.0