Classes

An object represents base class for channel

The GroupChannel class represents a group channel which is a private chat.

The user who wants to join the group channel has to be invited by another user who is already joined the channel. This class is derived from BaseChannel. If the BaseChannelDelegate is added, the user will automatically receive all messages from the group channels where the user belongs after connection. The GroupChannel provides the features of general messaging apps.

• Typing indicator.
• Read status for each message.
• Unread message count in the channel.
• Lastest message in the channel.

The GroupChannel has a special property, isDistinct. The distinct property enabled group channel is always reuesd for same channel members. If a new member gets invited or the member left from the channel, then the distinct property disabled automatically. If you don’t set distinct property on the channel, it always create new channel for the same members.

For more information, see Group Channel.

The OpenChannel class represents a open channel which is a public chat.

Any users who wants to enter the channel can join freely. This class is derived from BaseChannel. If the OpenChannelDelegate is added, the user will automatically receive all messages from the channels where the user belongs after connection. The OpenChannel does not provide the features that GroupChannel does, but it can handle much more users.

For more information, see Group Channel.

An object contains set of options for message change logs.

An object contains set of options for get message methods

An object that represents the parameters for the The method returns channels according to the properties in this object.

An object contains set of options to create a group channel

An object contains a set of options to get total unread message count from a group channel

An object contains a set of options to get unread item count from a group channel

An object contains a set of options to update a group channel

The OpenChannelCreateParams class contain parameters for open channel.

When you want to create a open channel or update a open channel, use this class. Add what you want to create with, add which properties you want to update, and pass this class to OpenChannel. You can use this class with apis that are OpenChannel.createChannel(params:completionHandler:) or OpenChannel,update(params:completionHandler:). For more information, see Open Channel.

An object contains set of options to update open channel

Represents an poll update event

Undocumented

Represents a vote event on a poll

Sendbird error class.

The BaseMessage class represents the base message which is generated by a user or an admin. The UserMessage, the FileMessage and the AdminMessage are derived from this class.

The User class represents a user. The user is identified by the userId, so the userId has to be unique. The userId, nickname and profileURL are valid in every User instance, however the connectionStatus and lastSeenAt is valid in User instance from UserListQuery.

Represents a poll that users can vote

Class to represent emoji cateogry

An object that represents reaction event info.

The object is returned by not only the completion handler of addReaction(message:key:completionHandler:) and deleteReaction(message:key:completionHandler:) in BaseChannel class, but also channel(_:updatedReaction:) delegate of BaseChannelDelegate protocol. The object has to be applied to the message that has the identical message ID with the apply(_:) method in BaseMessage class.

The UnreadItemCount class represents counts of messages. The instance of this class is returned from completion handler in getUnreadItemCountWithKey:completionHandler:].

An object that represents the Reaction info.

The BaseMessage object can have the Reaction object in reactions property.

An base object for collection

An object that specifies the options for the local caching.

An object that accesses the cache for the group channels.

Channel context

General class for representing event details for ChannelContext and FeedChannelContext. Every detail from delegate functions from GroupChannelDelegate and FeedChannelDelegate can be found as a subclass of EventDetail

An object that accesses the cache for the messages.

Represents what happened to the messages.

Undocumented

The AdminMessage class represents a message which is sent by an admin via Platform API. The admin message doesn’t have a sender. This message is sutable for a notice to inform the members in a group channel or the participants in an open channel. If you would like to know about the Platform API for the message, see Send a message.

Represents a mesage object that contains a text message. Derived from BaseMessage.

Represents a mesage object that contains a file. Derived from BaseMessage

Represents the base class which has parameters to create a channel.

The UserMessageCreateParams, the FileMessageCreateParams are derived from this class.

Represents the base class which has parameters to update a message.

The UserMessageUpdateParams, the FileMessageUpdateParams are derived from this class.

An object contains set of options to retrieve a message.

A base class to create a scheduled message.

A base class to update a scheduled message.

An object that contains a set of options to retrieve scheduled messages.

An object contains set of options to retrieve threaded messages.

An object that contains a set of options to get scheduled messages count.

An object contains set of options to create FileMessage.

The FileMessageUpdateParams class is used to update a file message in BaseChannel. This is a child class of BaseMessageUpdateParams.

Undocumented

Undocumented

Represents a thumbnail information

The ThumbnailSize class represents the thumbnail size of thumbnail.

Form data

Input field data information.

Submitted answer information for specific form field.

Message form data Since: 4.21.0

The item data held by the Message form. Since: 4.21.0

Represents the data structure for template messages.

Feedback data model for a message.

An object that represents the information about message review history

An object that represents the information about original message

The MessageMetaArray instance has a string type of key and an array type of value.

The value consists of a string. It usually can be used for ‘vote’ or ‘reaction’ for the message.

Represents OpenGraph Image information

Represents OpenGraph information

Undocumented

Represents a parameter object to create or update poll object

Represents a poll data

Represents a poll details information

An object to retrieve list of Poll

Represents a parameter object for creating a list of Polls.

Represents an option for poll

An object that retrieves a specific poll option.

An object contains a voter result for an option

An object contains set of options to retrieve Poll object

An object contains set of options to update Poll

An object contains information about updated vote count

An object to retrieve list of voter

This object is used when calling voterList query.

Class holding an information about the scheduled messages.

Undocumented

An object that represents the information about threaded messages, whose properties show how many replies the thread has received, who left the replies, and when the last reply was added.

An object that is returned through the event handler when a threaded reply is added or deleted.

This object should be applied to the parent message.

Represents a message object that contains multiple files. Derived from BaseMessage.

An object that contains a set of options to create MultipleFilesMessage.

An object that contains a set of options to create a single file inside the files in a MultipleFilesMessage instance.

An object that contains a set of information of a single file that finished being uploaded inside MultipleFilesMessage.

An object that has parameters to create a scheduled message.

An object that has parameters to update a scheduled message.

An object contains a set of options to create UserMessage.

The UserMessageUpdateParams class is used to update a user message in BaseChannel. This is a child class of BaseMessageUpdateParams.

An object contains application information

Represents the options for the Apple Critical Alert.

The BaseMessageCreateParams object may have the AppleCriticalAlertOptions object as an appleCriticalAlertOptions property. When the message that has this options is received by the iOS device, the message is displayed as a critical alert. See the Generating a Remote Notification for the details.

Class to represent emoji

An object contains list of EmojiCategory and hash

Undocumented

Represents SendbirdChat options.

An object contains set of options to retrieve total unread channel count

An object to initialize SendbirdChat

A object to represent a plugin

Filter types to query with GroupChannelListQuery. You can combine search fields to query. used for setSearchFilter(_:fields:) of GroupChannelListQuery

The bitmask keys of count about unread messages or invitation.

The SendbirdChat is the core class for Sendbird. This class is singletone instance which is initialized by Application ID. This class provides the methods for overall operations. The methods include BaseChannelDelegate registration for receiving events that are related to channels, ConnectionDelegate for managing the connection status, updating the current user’s information, registration for APNS push notification and blocking other users.

The configuration information for UIKit

Category for reporting a channel, message, or user.

A class that represents a feed channel.

Channel context

An object that accesses the cache for the messages.

Represents what happened to the messages.

A class that represents a category for notifications.

A class that represents an extra data for the notifications.

Undocumented

Undocumented

The GroupChannelListQuery class is a query class for getting the list of group channels.

The instance of this class is created by createMyGroupChannelListQuery() in GroupChannel class.

Undocumented

The OpenChannelListQuery class is a query class for getting the list of open channels.

The instance of this class is created by createOpenChannelListQuery() in OpenChannel class.

Undocumented

The PublicGroupChannelListQuery class is a query class for getting the list of public group channels.

The instance of this class is created by createPublicGroupChannelListQuery() in GroupChannel class.

Undocumented

A class representing query to retrieve list of BaseMessages that matches a given query with given filters. MessageSearchQuery can be generated by using MessageSearchQueryBuilder

Message search query builder

This class provides a way to retrieve a list of pinned messages in a group channel. It has properties to get the query options and to check the status of the query.

A class that provides options to fetch pinned messages from a server.

An object which retrieves messages from the given channel.

The instance of this class is created by createPreviousMessageListQuery() in BaseChannel class.

Undocumented

The ScheduledMessageListQuery class is a query class for getting the list of scheduled messages.

Undocumented

The ApplicationUserListQuery class is a query class for getting the list of all users of the current application.

This instance is created by createApplicationUserListQuery() of SendbirdChat.

Undocumented

The BannedUserListQuery class is a query class for getting the list of banned users in a specific channel.

This instance is created by createBannedUserListQuery of BaseChannel.

Undocumented

The BlockedUserListQuery class is a query class for getting the list of blocked users by the current user.

This instance is created by createBlockedUserListQuery() of SendbirdChat.

Undocumented

A object to retrieve friend list

Undocumented

The MemberListQuery class is a query class for getting the list member in group channels.

The instance of this class is created by createMemberListQuery() in GroupChannel class.

Undocumented

The MutedUserListQuery class is a query class for getting the list of muted users in a specific channel.

This instance is created by createMutedUserListQuery of BaseChannel.

Undocumented

The OperatorListQuery class is a query class for getting the list of operators in channel.

The instance of this class is created by createOperatorListQuery() in BaseChannel class.

Undocumented

The ParticipantListQuery class is a query class for getting the list of participants in an open channel.

This instance is created by createParticipantListQuery() of OpenChannel.

Undocumented

The entry point for handling statistics

Undocumented

Undocumented

Undocumented

Undocumented

Undocumented

Undocumented

Represents a member in GroupChannel

Represents a participant in OpenChannel.

Represents a user who has been restricted in a channel

An object contains information about restriction

Represents a user that typically binds with message

An object to update user information

Protoperty wrapper to access a property atomically