MessageCollection

open class MessageCollection: BaseCollection

extension MessageCollection: GroupChannelDelegate

extension MessageCollection: ConnectionDelegate

An object that accesses the cache for the messages.

Since

3.1.0


                    
                    
                    delegate

Undocumented

Declaration

Swift

open weak var delegate: MessageCollectionDelegate?

startingPoint
Message collection delegate.
Declaration
Swift

open internal(set) var startingPoint: Int64
hasNext
If true, there may be the messages on the next page.
Declaration
Swift

open internal(set) var hasNext: Bool
hasPrevious
If true, there may be the messages on the previous page.
Declaration
Swift

open internal(set) var hasPrevious: Bool
succeededMessages
Returns the succeeded messages that are already loaded in memory.
Declaration
Swift

open var succeededMessages: [BaseMessage]
pendingMessages
Returns the pending messages that are already loaded in memory.
Declaration
Swift

open var pendingMessages: [BaseMessage]
failedMessages
Returns the failed messages that are already loaded in memory.
Declaration
Swift

open var failedMessages: [BaseMessage]


                    
                    
                    startCollection(initPolicy:cacheResultHandler:apiResultHandler:)

Starts the message collection with the policy. The result of the

Declaration

Swift

open func startCollection(
    initPolicy: MessageCollectionInitPolicy,
    cacheResultHandler: MessageListHandler?,
    apiResultHandler: MessageListHandler?
)

Parameters

`initPolicy`	The policy for the message collection.
`cacheResultHandler`	The callback to call when the messages are loaded from the cache. The `messages` is the messages that are loaded from the cache. The `error` will be returned when the loading message failed.
`apiResultHandler`	The callback to call when the messages are loaded from the server. The `messages` is the messages that are loaded from the server. The `error` will be returned when the loading message failed.

dispose()
Invalidates the object.
Declaration
Swift

open func dispose()


                    
                    
                    loadNext(completionHandler:)

Loads messages of the next page.

Declaration

Swift

open func loadNext(completionHandler: @escaping MessageListHandler)

Parameters


                                completionHandler

The callback to call when the load is complete. The error will be returned when the loading message failed.


                    
                    
                    loadPrevious(completionHandler:)

Loads messages of the previous page.

Declaration

Swift

open func loadPrevious(completionHandler: @escaping MessageListHandler)

Parameters


                                completionHandler

The callback to call when the load is complete. The error will be returned when the loading message failed.


                    
                    
                    removeFailed(messages:completionHandler:)

Removes failed messages from DB.

Declaration

Swift

open func removeFailed(messages: [BaseMessage], completionHandler: MessageRequestIdsHandler?)

Parameters


                                completionHandler

The callback to call when the method is complete. The error will be returned when the removing failed messages failed.


                    
                    
                    removeAllFailed(completionHandler:)

Removes all failed messages.

Declaration

Swift

open func removeAllFailed(completionHandler: SBErrorHandler?)

Parameters


                                completionHandler

The callback to call when the method is complete. The error will be returned when the removing failed messages failed.

ChannelEventDelegate


                    
                    
                    channel(_:didReceive:)

Declaration

Swift

open func channel(_ channel: BaseChannel, didReceive message: BaseMessage)


                    
                    
                    channel(_:didUpdate:)

Declaration

Swift

open func channel(_ channel: BaseChannel, didUpdate message: BaseMessage)


                    
                    
                    channel(_:messageWasDeleted:)

Declaration

Swift

open func channel(_ channel: BaseChannel, messageWasDeleted messageId: Int64)


                    
                    
                    channel(_:updatedReaction:)

Declaration

Swift

open func channel(_ channel: BaseChannel, updatedReaction reactionEvent: ReactionEvent)


                    
                    
                    channel(_:didUpdateThreadInfo:)

Declaration

Swift

open func channel(
    _ channel: BaseChannel,
    didUpdateThreadInfo threadInfoUpdateEvent: ThreadInfoUpdateEvent
)


                    
                    
                    channelWasChanged(_:)

Declaration

Swift

open func channelWasChanged(_ channel: BaseChannel)


                    
                    
                    channel(_:didReceiveInvitation:inviter:)

Declaration

Swift

open func channel(
    _ channel: GroupChannel,
    didReceiveInvitation invitees: [User]?,
    inviter: User?
)


                    
                    
                    channelDidUpdateDeliveryStatus(_:)

Declaration

Swift

open func channelDidUpdateDeliveryStatus(_ channel: GroupChannel)


                    
                    
                    channelDidUpdateReadStatus(_:)

Declaration

Swift

open func channelDidUpdateReadStatus(_ channel: GroupChannel)


                    
                    
                    channelDidChangeMemberCount(_:)

Declaration

Swift

open func channelDidChangeMemberCount(_ channels: [GroupChannel])


                    
                    
                    channel(_:userWasMuted:)

Declaration

Swift

open func channel(_ channel: BaseChannel, userWasMuted user: RestrictedUser)


                    
                    
                    channel(_:userWasUnmuted:)

Declaration

Swift

open func channel(_ channel: BaseChannel, userWasUnmuted user: User)


                    
                    
                    channelWasFrozen(_:)

Declaration

Swift

open func channelWasFrozen(_ channel: BaseChannel)


                    
                    
                    channelWasUnfrozen(_:)

Declaration

Swift

open func channelWasUnfrozen(_ channel: BaseChannel)


                    
                    
                    channelWasHidden(_:)

Declaration

Swift

open func channelWasHidden(_ channel: GroupChannel)


                    
                    
                    channelDidUpdateOperators(_:)

Declaration

Swift

open func channelDidUpdateOperators(_ channel: BaseChannel)


                    
                    
                    channelDidUpdateTypingStatus(_:)

Declaration

Swift

open func channelDidUpdateTypingStatus(_ channel: GroupChannel)


                    
                    
                    channel(_:userDidLeave:)

Declaration

Swift

open func channel(_ channel: GroupChannel, userDidLeave user: User)


                    
                    
                    channel(_:userWasBanned:)

Declaration

Swift

open func channel(_ channel: BaseChannel, userWasBanned user: RestrictedUser)


                    
                    
                    channel(_:didDeclineInvitation:inviter:)

Declaration

Swift

open func channel(_ channel: GroupChannel, didDeclineInvitation invitee: User, inviter: User?)


                    
                    
                    channel(_:userDidJoin:)

Declaration

Swift

open func channel(_ channel: GroupChannel, userDidJoin user: User)


                    
                    
                    channelWasDeleted(_:channelType:)

Declaration

Swift

open func channelWasDeleted(_ channelURL: String, channelType: ChannelType)


                    
                    
                    channel(_:didReceiveMention:)

Declaration

Swift

open func channel(_ channel: BaseChannel, didReceiveMention message: BaseMessage)


                    
                    
                    channel(_:createdMetaData:)

Declaration

Swift

open func channel(_ channel: BaseChannel, createdMetaData: [String: String]?)


                    
                    
                    channel(_:updatedMetaData:)

Declaration

Swift

open func channel(_ channel: BaseChannel, updatedMetaData: [String: String]?)


                    
                    
                    channel(_:deletedMetaDataKeys:)

Declaration

Swift

open func channel(_ channel: BaseChannel, deletedMetaDataKeys: [String]?)


                    
                    
                    channel(_:createdMetaCounters:)

Declaration

Swift

open func channel(_ channel: BaseChannel, createdMetaCounters: [String: Int]?)


                    
                    
                    channel(_:updatedMetaCounters:)

Declaration

Swift

open func channel(_ channel: BaseChannel, updatedMetaCounters: [String: Int]?)


                    
                    
                    channel(_:deletedMetaCountersKeys:)

Declaration

Swift

open func channel(_ channel: BaseChannel, deletedMetaCountersKeys: [String]?)


                    
                    
                    channel(_:didUpdatePoll:)

Declaration

Swift

open func channel(_ channel: GroupChannel, didUpdatePoll event: PollUpdateEvent)


                    
                    
                    channel(_:didVotePoll:)

Declaration

Swift

open func channel(_ channel: GroupChannel, didVotePoll event: PollVoteEvent)


                    
                    
                    channelDidUpdatePinnedMessages(_:)

Declaration

Swift

open func channelDidUpdatePinnedMessages(_ channel: GroupChannel)


                    
                    
                    channel(_:didUpdateFeedbackMessage:)

Declaration

Swift

open func channel(_ channel: GroupChannel, didUpdateFeedbackMessage: BaseMessage)

ConnectionDelegate

didStartReconnection()
Declaration
Swift

public func didStartReconnection()
didSucceedReconnection()
Declaration
Swift

open func didSucceedReconnection()
didConnect(userId:)
Declaration
Swift

open func didConnect(userId: String)