NotificationCollection

open class NotificationCollection: BaseCollection

extension NotificationCollection: FeedChannelDelegate

extension NotificationCollection: ConnectionDelegate

An object that accesses the cache for the messages.

Since

4.6.0


                    
                    
                    delegate

Notification collection delegate.

Declaration

Swift

open weak var delegate: NotificationCollectionDelegate?


                    
                    
                    startingPoint

Undocumented

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 notifications that are already loaded in memory.
Declaration
Swift

open var succeededMessages: [BaseMessage]


                    
                    
                    startCollection(initPolicy:cacheResultHandler:apiResultHandler:)

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

Declaration

Swift

open func startCollection(
    initPolicy: NotificationCollectionInitPolicy,
    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.

BaseChannelDelegate


                    
                    
                    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(_: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)


                    
                    
                    channelDidUpdateOperators(_:)

Declaration

Swift

open func channelDidUpdateOperators(_ channel: BaseChannel)


                    
                    
                    channel(_:userWasBanned:)

Declaration

Swift

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


                    
                    
                    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]?)

FeedChannelDelegate


                    
                    
                    feedChannelDidUpdateReadStatus(_:)

Undocumented

Declaration

Swift

open func feedChannelDidUpdateReadStatus(_ channel: FeedChannel)

ConnectionDelegate

didSucceedReconnection()
Declaration
Swift

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

open func didConnect(userId: String)