sendbird_chat_sdk library

Sendbird Chat

Classes

AccessTokenRequester
Interface that is passed on to SessionHandler.onAccessTokenRequired. After the application fetches the new accessToken, it should pass on the accessToken to SDK through onSuccess. If any error occurred during this process, it must call onFail to let SDK know the status.
AdminMessage
Object representing an admin message.
AppInfo
Represents information obtained from the application settings. The values for this will be set after a connection has been made.
AppleCriticalAlertOptions
A class that can be used to send apple's critical alert.
ApplicationUserListQuery
A class representing query to retrieve lists related to User.
BannedUserListQuery
A class representing query to retrieve lists related to banned User.
BaseChannel
Objects representing a channel.
BaseChannelContext
The context of a base channel. @since 4.0.3
BaseChannelHandler
The BaseChannel handler. This handler provides callbacks for events related OpenChannel or GroupChannel. All callbacks are called only when the currently logged-in User is a participant or member of OpenChannel or GroupChannel respectively. To add or remove this handler, refer to SendbirdChat.addChannelHandler and SendbirdChat.removeChannelHandler.
BaseMessage
Base class for messages.
BaseMessageCollection
The base message collection that handles message lists. @since 4.0.3
BaseMessageCollectionHandler
The base message collection handler. @since 4.0.3
BaseMessageContext
The context of a base message. @since 4.0.3
BaseMessageCreateParams
Represents a base message params.
BaseMessageFetchParams
Represents a base for message fetch params.
BaseMessageUpdateParams
Represents a base message params.
BaseQuery
Abstract class for query
BlockedUserListQuery
A class representing query to retrieve lists related to blocked User.
ConnectionHandler
The connection handler. This handler provides callbacks for automatically managed reconnection events. SendbirdChat tries reconnection when the connection is lost. This handler can be used to track the reconnection state. To add or remove this handler, refer to SendbirdChat.addConnectionHandler and SendbirdChat.removeConnectionHandler.
DoNotDisturb
The DoNotDisturb class.
Emoji
Objects representing a emoji.
EmojiCategory
Objects representing a category of emoji.
EmojiContainer
Objects representing emoji information.
FeedChannel
Represents a feed channel. @since 4.0.3
FeedChannelChangeLogs
The FeedChannelChangeLogs class.
FeedChannelChangeLogsParams
Represents a feed channel change logs params. @since 4.0.3
FeedChannelContext
The context of a feed channel, used in NotificationCollectionHandler. @since 4.0.3
FeedChannelHandler
The FeedChannel handler. @since 4.1.0
FeedChannelListQuery
A class representing query to retrieve FeedChannel list for the current User. @since 4.0.3
FileInfo
The file info.
FileMessage
Object representing a file.
FileMessageCreateParams
Represents a file message params.
FileMessageUpdateParams
Represents a file message params.
GlobalNotificationChannelSetting
Class to obtain the global notification channel setting. @since 4.0.3
GroupChannel
Represents a group channel.
GroupChannelChangeLogs
The GroupChannelChangeLogs class.
GroupChannelChangeLogsParams
Represents a group channel change logs params.
GroupChannelCollection
Collection that handles channel lists.
GroupChannelCollectionHandler
An interface used in GroupChannelCollection.
GroupChannelContext
The context of a group channel, used in GroupChannelCollectionHandler.
GroupChannelCreateParams
Represents a group channel create params.
GroupChannelHandler
The GroupChannel handler.
GroupChannelListQuery
A class representing query to retrieve GroupChannel list for the current User. Currently, 1 kind of GroupChannel list can be queried. The list of GroupChannels the current User is a member of.
GroupChannelTotalUnreadChannelCountParams
Represents a group channel total unread channel count params.
GroupChannelTotalUnreadMessageCountParams
Represents a group channel total unread message count params.
GroupChannelUnreadItemCount
The GroupChannelUnreadItemCount class for SendbirdChat.getUnreadItemCount.
GroupChannelUpdateParams
Represents a group channel update params.
Member
Represents a GroupChannel member.
MemberListQuery
A query object to retrieve list of members from my group channel.
MessageChangeLogParams
An object consists a set of parameters to retrieve message's change log
MessageChangeLogs
The MessageChangeLogs class.
MessageCollection
Message collection that handles message lists.
MessageCollectionHandler
A handler used in MessageCollection.
MessageContext
The context of a message, used in MessageCollectionHandler.
MessageListParams
Represents a message list params.
MessageMetaArray
Represents meta array of BaseMessage.
MessageRetrievalParams
An object consists a set of parameters to retrieve information from a message.
MessageSearchQuery
A class representing query to retrieve list of BaseMessages that matches a given query with given filters. @since 4.0.13
MutedUserListQuery
A class representing query to retrieve lists related to muted User.
MuteInfo
The MuteInfo class.
NotificationCategory
NotificationCategory @since 4.0.6
NotificationCollection
Notification collection that handles message lists. @since 4.0.3
NotificationCollectionHandler
A handler used in NotificationCollection.
NotificationContext
The context of a notification, used in NotificationCollectionHandler. @since 4.0.3
NotificationData
The NotificationData class for BaseMessage.notificationData. @since 4.0.7
NotificationInfo
Represents information about Notifications. @since 4.0.3
NotificationMessage
Class representing a notification message. @since 4.1.0
NotificationTemplate
Class to obtain the Notification template. @since 4.0.3
NotificationTemplateList
The notification template list received from the SendbirdChat.getNotificationTemplateListByToken. @since 4.0.3
NotificationTemplateListParams
Params for retrieving Notification template list. @since 4.0.3
OGDisplayable
OGImage
Represents a Open Graph Image of OGMetaData. For Specifications, see https://ogp.me/.
OGMedia
OGMetaData
Represents a OGMetaData of a url. For Specifications, see https://ogp.me/. Currently we only support images.
OpenChannel
Represents an open channel.
OpenChannelCreateParams
Represents a open channel params.
OpenChannelHandler
The OpenChannel handler.
OpenChannelListQuery
A class representing query to retrieve OpenChannel list. Currently, 1 kind of OpenChannel list can be queried.
OpenChannelUpdateParams
Represents a open channel update params.
OperatorListQuery
A class representing query to retrieve operator lists related to User.
ParticipantListQuery
A class representing query to retrieve lists related to participant.
Poll
Class representing a poll. A poll instance can be created using Poll.create with PollCreateParams and updated using GroupChannelPoll.updatePoll with PollUpdateParams class. A poll can be attached to a message using UserMessageCreateParams.pollId.
PollChangeLogs
The PollChangeLogs class.
PollCreateParams
Parameters for creating poll and updating poll operations. For poll creation, title and optionTexts are required and all other members are optional. For poll update, all members are optional.
PollData
Class representing data for poll. A poll may or may not have a data, which is an additional field used after user's vote. Currently this class only supports text data.
PollListQuery
A class representing query to retrieve the list of polls.
PollListQueryParams
Params for creating a PollListQuery object.
PollOption
Class representing a poll option. A poll options can be created by Poll.create and GroupChannelPoll.addPollOption. text is the only field set by the client. Other fields can be set by the server and voting.
PollOptionRetrievalParams
Parameters for retrieving poll option. A poll option should be specified by the pollId of the poll that the option belongs to and pollOptionId of the option, and the channelUrl of the channel that the poll specified by pollId belongs to.
PollRetrievalParams
Parameters for retrieving poll operations. For poll retrieval, pollId, channelType and channelUrl are required and all other members are optional.
PollUpdateEvent
Class representing an event that a Poll has been updated. This event will be passed to GroupChannelHandler.onPollUpdated. Once this event is received, the user must find cached messages that contain this poll and apply changes using Poll.applyPollUpdateEvent.
PollUpdateParams
Parameters for updating poll operations. All members are optional.
PollVoteEvent
Class representing an event that one or more vote has been casted on a poll option. The affected poll may be in multiple channels. This event will be passed to GroupChannelHandler.onPollVoted. Once this event is received, the user must find cached messages that contain this poll and apply changes using Poll.applyPollVoteEvent.
PollVoterListQuery
A class representing query to retrieve the list of voters for each poll options.
PollVoterListQueryParams
Params for creating a PollVoterListQuery object.
PreviousMessageListQuery
A query object to retrieve previous messages
PublicGroupChannelListQuery
A class representing query to retrieve GroupChannel list for the current User. Currently, 1 kind of public GroupChannel list can be queried.
Reaction
Objects representing a reaction.
ReactionEvent
Objects representing a reaction event.
RestrictedUser
Represents a restricted User.
RestrictionInfo
Represents an detailed information of a RestrictedUser or Member's restriction.
RootChannelHandler
RootMessage
Class representing a root message.
ScheduledFileMessageCreateParams
Represents a scheduled file message params.
ScheduledFileMessageUpdateParams
ScheduledFileMessageUpdateParams
ScheduledInfo
Class holding an information about the scheduled messages.
ScheduledMessageListQuery
Represents a query for retrieving a list of scheduled messages.
ScheduledMessageListQueryParams
Params for creating a ScheduledMessageListQuery object.
ScheduledMessageRetrievalParams
Represents a params for retrieving a single scheduled message.
ScheduledUserMessageCreateParams
Represents a scheduled user message params.
ScheduledUserMessageUpdateParams
Represents a scheduled user message update params.
SendbirdChat
An object represents a main class to use Sendbird Chat
SendbirdChatOptions
The SendbirdChatOptions class for SendbirdChat.init.
SendbirdError
Represents a set of error code from server and sdk
Sender
Represents a sender.
SessionHandler
A handler required on refreshing the session key on expiration. This should be added by SendbirdChat.setSessionHandler before the connection by SendbirdChat.connect.
SnoozePeriod
The SnoozePeriod class
ThreadedMessageListParams
Represents a message list params.
ThreadedMessages
The ThreadedMessages class.
ThreadInfo
Represents a thread info of a message.
ThreadInfoUpdateEvent
Objects representing a thread info event.
Thumbnail
An object represents thumbnail
TotalScheduledMessageCountParams
Represents a params for retrieving total scheduled message.
UnreadMessageCount
The UnreadMessageCount class for SendbirdChat.getTotalUnreadMessageCount. @since 4.0.3
User
Represents a user.
UserEventHandler
User event handler. To add or remove this handler, refer to SendbirdChat.addUserEventHandler and SendbirdChat.removeUserEventHandler.
UserMessage
Object representing a user message.
UserMessageCreateParams
Represents a user message params.
UserMessageUpdateParams
Represents a user message update params.

Enums

ChannelType
ChannelType
CollectionEventSource
Indicates the source of an event. isFromEvent is true only when it comes from the socket.
CountPreference
CountPreference
GroupChannelHiddenState
GroupChannelHiddenState
GroupChannelListQueryOrder
GroupChannelListQueryOrder chronological query returns the result as by event time descending order. latestLastMessage query returns the result as by event time descending order. channelNameAlphabetical query returns the result as by channel name alphabetical order.
GroupChannelListQuerySearchField
GroupChannelListQuerySearchField
GroupChannelListQueryType
GroupChannelListQueryType
GroupChannelPushTriggerOption
GroupChannelPushTriggerOption
HiddenChannelFilter
HiddenChannelFilter
LogLevel
LogLevel
MemberListOrder
MemberListOrder
MembershipFilter
MembershipFilter
MemberState
MemberState
MentionType
MentionType
MessageSearchQueryOrder
The order in which the query result will be based on. score query returns the result as by their matching score. timestamp query returns the result as by BaseMessage's timestamp. @since 4.0.13
MessageType
MessageTypeFilter
MessageTypeFilter
MetaArrayUpdateMode
MutedMemberFilter
MutedMemberFilter
MuteState
MuteState
MyConnectionState
MyConnectionState
MyMemberStateFilter
MyMemberStateFilter
NotificationMessageStatus
NotificationMessageStatus @since 4.1.0
OperatorFilter
OperatorFilter
PollStatus
PollStatus
PublicChannelFilter
PublicChannelFilter
PushNotificationDeliveryOption
PushNotificationDeliveryOption
PushTokenRegistrationStatus
PushTokenRegistrationStatus
PushTokenType
PushTokenType
PushTriggerOption
PushTriggerOption
ReactionEventAction
ReactionEventAction
ReplyType
ReplyType
ReportCategory
ReportCategory
RestrictionType
RestrictionType
Role
Role
ScheduledMessageListQueryOrder
ScheduledMessageListQueryOrder
ScheduledStatus
ScheduledStatus
SendingStatus
MessageSendingStatus
SuperChannelFilter
SuperChannelFilter
UnreadChannelFilter
UnreadChannelFilter
UnreadItemKey
UnreadItemKey
UpdateMetaCounterMode
UserConnectionStatus
UserConnectionStatus

Extensions

BaseChannelMessage
BaseChannelMessage
BaseChannelMessageMetaArray
BaseChannelMessageMetaArray
BaseChannelMetaCounters
BaseChannelMetaCounters
BaseChannelMetaData
BaseChannelMetaData
BaseChannelModeration
BaseChannelModeration
BaseChannelOperator
BaseChannelOperator
BaseChannelReactions
BaseChannelReactions
BaseMessageExtensions
GroupChannelConfiguration
GroupChannelConfiguration
GroupChannelExtensions
GroupChannelOperation
GroupChannelOperation
GroupChannelPinnedMessage
GroupChannelPinnedMessage
GroupChannelPoll
GroupChannelPoll
GroupChannelRead
GroupChannelRead
GroupChannelScheduledMessage
GroupChannelScheduledMessage
GroupChannelTyping
GroupChannelTyping
OpenChannelOperation
OpenChannelOperation

Typedefs

BaseMessageHandler = void Function(BaseMessage message, SendbirdException? e)
BaseMessageHandler
FileMessageHandler = void Function(FileMessage message, SendbirdException? e)
FileMessageHandler
ProgressHandler = void Function(int sentBytes, int totalBytes)
ProgressHandler
UserMessageHandler = void Function(UserMessage message, SendbirdException? e)
UserMessageHandler

Exceptions / Errors

AccessTokenRevokedException
AccessTokenRevokedException
AckTimeoutException
AckTimeoutException
BadRequestException
BadRequestException
ConnectionCanceledException
ConnectionCanceledException
ConnectionRequiredException
ConnectionRequiredException
FileSizeLimitExceededException
FileSizeLimitExceededException
InternalServerException
InternalServerException
InvalidAccessTokenException
InvalidAccessTokenException
InvalidCollectionDisposedException
InvalidCollectionDisposedException
InvalidInitializationException
InvalidInitializationException
InvalidMessageTypeException
InvalidMessageTypeException
InvalidParameterException
InvalidParameterException
LoginTimeoutException
LoginTimeoutException
MalformedDataException
MalformedException
MarkAsReadRateLimitExceededException
MarkAsReadRateLimitExceededException
NotSupportedException
NotSupportedException
OperationCanceledException
OperationCanceledException
QueryInProgressException
QueryInProgressException
RequestFailedException
RequestFailedException
SendbirdException
SendbirdException
SessionKeyRefreshFailedException
SessionKeyRefreshFailedException
UnauthorizedException
UnauthorizedException
WebSocketFailedException
WebSocketFailedException