BaseChannelDelegate

public protocol BaseChannelDelegate: AnyObject

An object that adopts the BaseChannelDelegate protocol is responsible for receiving the events in the channel. Delegate methods in BaseChannelDelegate are common for the BaseChannel. Exclusive delegate methods for OpenChannel and GroupChannel can be found in OpenChannelDelegate and GroupChannelDelegate. You must use OpenChannelDelegate and GroupChannelDelegate instead of using BaseChannelDelegate by using add(_:identifier:) in SendbirdChat.

Warning

If the object that adopts the BaseChannelDelegate protocol is invalid, the delegate has to be removed by the identifier via removeChannelDelegate(forIdentifier:) in SendbirdChat.

This protocol deals with the below events.

Receives a message in the BaseChannel.
Receives an event when a message is updated in the BaseChannel.
Receives an event when the property of the BaseChannel was changed.
Receives an event when the BaseChannel was deleted.
Receives an event when a message in the BaseChannel was deleted.
Receives an event when meta data in the BaseChannel was changed.
Receives an event when meta counters in the BaseChannel were changed.
Receives an event when a group channel was hidden.
Receives an event when a user was muted or unmuted in the BaseChannel.
Receives an event when a user was banned or unbanned in the BaseChannel.
Receives an event when operators are updated.
Receives an event when a reaction of message in a channel was updated.


                    
                    
                    channel(_:didReceive:)

A callback when a message is received.

Declaration

Swift

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

Parameters

`channel`	The channel where the message is received.
`message`	The received message.


                    
                    
                    channel(_:didUpdate:)

A callback when a message is updated.

Declaration

Swift

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

Parameters

`channel`	The channel where the message is updated.
`message`	The updated message.


                    
                    
                    channel(_:didReceiveMention:)

A delegate is called when someone mentioned the user.

Declaration

Swift

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

Parameters

`channel`	The channel mention was occured in.
`message`	The message mention was occured about.


                    
                    
                    channel(_:userWasMuted:)

A callback when a user was muted in the channel.

Declaration

Swift

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

Parameters

`channel`	The channel.
`user`	The user who was muted.


                    
                    
                    channel(_:userWasUnmuted:)

A callback when a user was unmuted in the channel.

Declaration

Swift

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

Parameters

`channel`	The channel.
`user`	The user who was unmuted.


                    
                    
                    channel(_:userWasBanned:)

A callback when a user was banned in the channel.

Declaration

Swift

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

Parameters

`channel`	The channel.
`user`	The user who was banned.


                    
                    
                    channel(_:userWasUnbanned:)

A callback when a user was unbanned in the channel.

Declaration

Swift

optional func channel(_ channel: BaseChannel, userWasUnbanned user: User)

Parameters

`channel`	The channel.
`user`	The user who was unbanned.


                    
                    
                    channelWasFrozen(_:)

A callback when a channel was frozen.

Declaration

Swift

optional func channelWasFrozen(_ channel: BaseChannel)

Parameters


                                channel

The channel.


                    
                    
                    channelWasUnfrozen(_:)

A callback when an channel was unfrozen.

Declaration

Swift

optional func channelWasUnfrozen(_ channel: BaseChannel)

Parameters


                                channel

The channel


                    
                    
                    channelWasChanged(_:)

A callback for when channel property is changed.

Declaration

Swift

optional func channelWasChanged(_ channel: BaseChannel)

Parameters


                                channel

The channel the property is changed of.


                    
                    
                    channelWasDeleted(_:channelType:)

A callback for when a channel was deleted.

Declaration

Swift

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

Parameters

`channelURL`	The channel url.
`channelType`	The type of channel that is deleted.


                    
                    
                    channel(_:messageWasDeleted:)

A callback when a message was removed in the channel.

Declaration

Swift

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

Parameters

`channel`	The base channel.
`messageId`	The message ID which was removed.


                    
                    
                    channel(_:createdMetaData:)

A callback when meta data was created in the channel.

Declaration

Swift

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

Parameters

`channel`	The channel that the meta data was created.
`createdMetaData`	The created meta data.


                    
                    
                    channel(_:updatedMetaData:)

A callback when meta data was updated in the channel.

Declaration

Swift

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

Parameters

`channel`	The channel that the meta data was updated.
`updatedMetaData`	The updated meta data.


                    
                    
                    channel(_:deletedMetaDataKeys:)

A callback when meta data was deleted in the channel.

Declaration

Swift

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

Parameters

`channel`	The channel that the meta data was deleted.
`deletedMetaDataKeys`	The keys of the deleted meta data.


                    
                    
                    channel(_:createdMetaCounters:)

A callback when meta counters were created in the channel.

Declaration

Swift

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

Parameters

`channel`	The channel that the meta counters were created.
`createdMetaCounters`	The created meta counters.


                    
                    
                    channel(_:updatedMetaCounters:)

A callback when meta counters were updated in the channel.

Declaration

Swift

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

Parameters

`channel`	The channel that the meta counters were updated.
`updatedMetaCounters`	The updated meta counters.


                    
                    
                    channel(_:deletedMetaCountersKeys:)

A callback when meta counters were deleted in the channel.

Declaration

Swift

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

Parameters

`channel`	The channel that the meta counters were deleted.
`deletedMetaCountersKeys`	The keys of the deleted meta counters.


                    
                    
                    channel(_:updatedReaction:)

A callback when a reaction was updated.

Declaration

Swift

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

Parameters

`channel`	The channel that the reaction was updated.
`reactionEvent`	The updated reaction event.


                    
                    
                    channelDidUpdateOperators(_:)

A callback when operators were updated in the channel.

Since

3.0.174

Declaration

Swift

optional func channelDidUpdateOperators(_ channel: BaseChannel)

Parameters


                                channel

The channel that the operators was updated.


                    
                    
                    channel(_:didUpdateThreadInfo:)

Invoked when the thread information is updated.

Since

3.0.181

Declaration

Swift

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

Parameters

`channel`	The channel that has the message thread.
`threadInfoUpdateEvent`	`ThreadInfoUpdateEvent` object that has the latest information about the thread.