#include <SBDBaseChannel.h>

Public Member Functions
virtual void	MessageReceived (SBDBaseChannel channel, SBDBaseMessage message)

virtual void	MessageUpdated (SBDBaseChannel channel, SBDBaseMessage message)

virtual void	ReadReceiptUpdated (SBDGroupChannel *channel)

virtual void	InvitationReceived (SBDGroupChannel *channel, const std::vector< SBDUser > &invitees, SBDUser &inviter)

virtual void	InvitationDeclined (SBDGroupChannel *channel, SBDUser &invitee, SBDUser &inviter)

virtual void	UserJoined (SBDGroupChannel *channel, SBDUser &user)

virtual void	UserLeft (SBDGroupChannel *channel, SBDUser &user)

virtual void	UserEntered (SBDOpenChannel *channel, SBDUser &user)

virtual void	UserExited (SBDOpenChannel *channel, SBDUser &user)

virtual void	UserMuted (SBDOpenChannel *channel, SBDUser &user)

virtual void	UserUnmuted (SBDOpenChannel *channel, SBDUser &user)

virtual void	UserBanned (SBDOpenChannel *channel, SBDUser &user)

virtual void	UserUnbanned (SBDOpenChannel *channel, SBDUser &user)

virtual void	ChannelFrozen (SBDOpenChannel *channel)

virtual void	ChannelUnfrozen (SBDOpenChannel *channel)

virtual void	ChannelChanged (SBDBaseChannel *channel)

virtual void	ChannelDeleted (const std::wstring &channel_url, SBDChannelType channel_type)

virtual void	MessageDeleted (SBDBaseChannel *channel, uint64_t message_id)

virtual void	ChannelMetaDataCreated (SBDBaseChannel *channel, const std::map< std::wstring, std::wstring > &created_meta_data)

virtual void	ChannelMetaDataUpdated (SBDBaseChannel *channel, const std::map< std::wstring, std::wstring > &updated_meta_data)

virtual void	ChannelMetaDataDeleted (SBDBaseChannel *channel, const std::vector< std::wstring > &deleted_meta_data)

virtual void	ChannelMetaCountersCreated (SBDBaseChannel *channel, const std::map< std::wstring, int64_t > &created_meta_counters)

virtual void	ChannelMetaCountersUpdated (SBDBaseChannel *channel, const std::map< std::wstring, int64_t > &updated_meta_counters)

virtual void	ChannelMetaCountersDeleted (SBDBaseChannel *channel, const std::vector< std::wstring > &deleted_meta_counters)

virtual void	MentionReceived (SBDBaseChannel channel, SBDBaseMessage message)

virtual void	ChannelWasHidden (SBDGroupChannel *channel)

virtual void	OperatorUpdated (SBDBaseChannel *channel)

Detailed Description

An object that adopts the SBDChannelHandler class is responsible for receiving the events in the channel. Some of virtual methods are common for the SBDBaseChannel. However, there are virtual methods for the SBDOpenChannel and SBDGroupChannel exclusive. The SBDChannelHandler can be added by [void AddChannelHandler(std::wstring identifier, SBDChannelHandler* handler)]() in SBDMain. Every SBDChannelHandler method which is added is going to receive events.

Warning: If the object that adopts the SBDChannelHandler class is invalid, the delegate has to be removed by the identifier via [void RemoveChannelHandler(string identifier)]() in SBDMain. If you miss this, it will cause the crash.

Member Function Documentation

◆ ChannelChanged()

virtual void SBDChannelHandler::ChannelChanged ( SBDBaseChannel * channel )

inlinevirtual

A callback when an open channel was changed.

Parameters

channel The open channel.

◆ ChannelDeleted()

virtual void SBDChannelHandler::ChannelDeleted	(	const std::wstring &	channel_url,
		SBDChannelType	channel_type
	)

inlinevirtual

A callback when an open channel was deleted.

Parameters

channel_url The open channel.

◆ ChannelFrozen()

virtual void SBDChannelHandler::ChannelFrozen ( SBDOpenChannel * channel )

inlinevirtual

A callback when an open channel was frozen.

Parameters

channel The open channel.

◆ ChannelMetaCountersCreated()

virtual void SBDChannelHandler::ChannelMetaCountersCreated	(	SBDBaseChannel *	channel,
		const std::map< std::wstring, int64_t > &	created_meta_counters
	)

inlinevirtual

A callback when meta counters were created in the channel.

Parameters

channel	The channel that the meta counters were created.
created_meta_counters	The created meta counters.

◆ ChannelMetaCountersDeleted()

virtual void SBDChannelHandler::ChannelMetaCountersDeleted	(	SBDBaseChannel *	channel,
		const std::vector< std::wstring > &	deleted_meta_counters
	)

inlinevirtual

A callback when meta counters were deleted in the channel.

Parameters

channel	The channel that the meta counters were deleted.
deleted_meta_counters	The keys of the deleted meta counters.

◆ ChannelMetaCountersUpdated()

virtual void SBDChannelHandler::ChannelMetaCountersUpdated	(	SBDBaseChannel *	channel,
		const std::map< std::wstring, int64_t > &	updated_meta_counters
	)

inlinevirtual

A callback when meta counters were updated in the channel.

Parameters

channel	The channel that the meta counters were updated.
updated_meta_counters	The updated meta counters.

◆ ChannelMetaDataCreated()

virtual void SBDChannelHandler::ChannelMetaDataCreated	(	SBDBaseChannel *	channel,
		const std::map< std::wstring, std::wstring > &	created_meta_data
	)

inlinevirtual

A callback when meta data was created in the channel.

Parameters

channel	The channel that the meta data was created.
created_meta_data	The created meta data.

◆ ChannelMetaDataDeleted()

virtual void SBDChannelHandler::ChannelMetaDataDeleted	(	SBDBaseChannel *	channel,
		const std::vector< std::wstring > &	deleted_meta_data
	)

inlinevirtual

A callback when meta data was deleted in the channel.

Parameters

channel	The channel that the meta data was deleted.
deleted_meta_data	The keys of the deleted meta data.

◆ ChannelMetaDataUpdated()

virtual void SBDChannelHandler::ChannelMetaDataUpdated	(	SBDBaseChannel *	channel,
		const std::map< std::wstring, std::wstring > &	updated_meta_data
	)

inlinevirtual

A callback when meta data was updated in the channel.

Parameters

channel	The channel that the meta data was updated.
updated_meta_data	The updated meta data.

◆ ChannelUnfrozen()

virtual void SBDChannelHandler::ChannelUnfrozen ( SBDOpenChannel * channel )

inlinevirtual

A callback when an open channel was unfrozen.

Parameters

channel The open channel.

◆ ChannelWasHidden()

virtual void SBDChannelHandler::ChannelWasHidden ( SBDGroupChannel * channel )

inlinevirtual

A callback when the channel was hidden on the other device or by Platform API.

Parameters

channel The channel where the channel was hidden.

◆ InvitationDeclined()

virtual void SBDChannelHandler::InvitationDeclined	(	SBDGroupChannel *	channel,
		SBDUser &	invitee,
		SBDUser &	inviter
	)

inlinevirtual

A callback when user declined the invitation.

Parameters

channel	The group channel where the invitation is occured.
invitee	Invitee.
inviter	Inviter.

◆ InvitationReceived()

virtual void SBDChannelHandler::InvitationReceived	(	SBDGroupChannel *	channel,
		const std::vector< SBDUser > &	invitees,
		SBDUser &	inviter
	)

inlinevirtual

A callback when users are invited by inviter.

Parameters

channel	The group channel where the invitation is occured.
invitees	Invitees.
inviter	Inviter.

◆ MentionReceived()

virtual void SBDChannelHandler::MentionReceived	(	SBDBaseChannel *	channel,
		SBDBaseMessage *	message
	)

inlinevirtual

A callback when a mentioned user is received.

Parameters

channel	The channel where the mentioned user is received.
message	The received message.

◆ MessageDeleted()

virtual void SBDChannelHandler::MessageDeleted	(	SBDBaseChannel *	channel,
		uint64_t	message_id
	)

inlinevirtual

A callback when a message was removed in the channel.

Parameters

channel	The base channel.
message_id	The message ID which was removed.

◆ MessageReceived()

virtual void SBDChannelHandler::MessageReceived	(	SBDBaseChannel *	channel,
		SBDBaseMessage *	message
	)

inlinevirtual

A callback when a message is received.

Parameters

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

◆ MessageUpdated()

virtual void SBDChannelHandler::MessageUpdated	(	SBDBaseChannel *	channel,
		SBDBaseMessage *	message
	)

inlinevirtual

A callback when a message is updated.

Parameters

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

◆ OperatorUpdated()

virtual void SBDChannelHandler::OperatorUpdated ( SBDBaseChannel * channel )

inlinevirtual

A callback for when operators change in channel.

Parameters

channel The BaseChannel the change has occurred.

Since: 3.0.37

◆ ReadReceiptUpdated()

virtual void SBDChannelHandler::ReadReceiptUpdated ( SBDGroupChannel * channel )

inlinevirtual

A callback when read receipts updated.

Parameters

channel The group channel where the read receipt updated.

◆ UserBanned()

virtual void SBDChannelHandler::UserBanned	(	SBDOpenChannel *	channel,
		SBDUser &	user
	)

inlinevirtual

A callback when a user was banned in the open channel.

Parameters

channel	The open channel.
user	The user who was banned.

◆ UserEntered()

virtual void SBDChannelHandler::UserEntered	(	SBDOpenChannel *	channel,
		SBDUser &	user
	)

inlinevirtual

A callback when a user enter an open channel.

Parameters

channel	The open channel.
user	The user

◆ UserExited()

virtual void SBDChannelHandler::UserExited	(	SBDOpenChannel *	channel,
		SBDUser &	user
	)

inlinevirtual

A callback when a user exit an open channel.

Parameters

channel	The open channel.
user	The user.

◆ UserJoined()

virtual void SBDChannelHandler::UserJoined	(	SBDGroupChannel *	channel,
		SBDUser &	user
	)

inlinevirtual

A callback when new member joined to the group channel.

Parameters

channel	The group channel.
user	The new user joined to the channel.

◆ UserLeft()

virtual void SBDChannelHandler::UserLeft	(	SBDGroupChannel *	channel,
		SBDUser &	user
	)

inlinevirtual

A callback when current member left from the group channel.

Parameters

channel	The group channel.
user	The member left from the channel.

◆ UserMuted()

virtual void SBDChannelHandler::UserMuted	(	SBDOpenChannel *	channel,
		SBDUser &	user
	)

inlinevirtual

A callback when a user was muted in the open channel.

Parameters

channel	The open channel.
user	The user who was muted.

◆ UserUnbanned()

virtual void SBDChannelHandler::UserUnbanned	(	SBDOpenChannel *	channel,
		SBDUser &	user
	)

inlinevirtual

A callback when a user was unbanned in the open channel.

Parameters

channel	The open channel.
user	The user who was unbanned.

◆ UserUnmuted()

virtual void SBDChannelHandler::UserUnmuted	(	SBDOpenChannel *	channel,
		SBDUser &	user
	)

inlinevirtual

A callback when a user was unmuted in the open channel.

Parameters

channel	The open channel.
user	The user who was unmuted.

Public Member Functions

Detailed Description

Member Function Documentation

◆ ChannelChanged()

◆ ChannelDeleted()

◆ ChannelFrozen()

◆ ChannelMetaCountersCreated()

◆ ChannelMetaCountersDeleted()

◆ ChannelMetaCountersUpdated()

◆ ChannelMetaDataCreated()

◆ ChannelMetaDataDeleted()

◆ ChannelMetaDataUpdated()

◆ ChannelUnfrozen()

◆ ChannelWasHidden()

◆ InvitationDeclined()

◆ InvitationReceived()

◆ MentionReceived()

◆ MessageDeleted()

◆ MessageReceived()

◆ MessageUpdated()

◆ OperatorUpdated()

◆ ReadReceiptUpdated()

◆ UserBanned()

◆ UserEntered()

◆ UserExited()

◆ UserJoined()

◆ UserLeft()

◆ UserMuted()

◆ UserUnbanned()

◆ UserUnmuted()