Classes Reference


                    
                    
                    BaseChannel

An object represents base class for channel

Declaration

Swift

@objc(SBDBaseChannel)
open class BaseChannel : NSObject, Codable, Identifiable, Cacheable, Injectable

extension BaseChannel: Serializable

extension BaseChannel: Mappable


                    
                    
                    GroupChannel

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.

Declaration

Swift

@objc(SBDGroupChannel)
open class GroupChannel : BaseChannel, SortableElement


                    
                    
                    OpenChannel

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.

Declaration

Swift

@objc(SBDOpenChannel)
open class OpenChannel : BaseChannel


                    
                    
                    MessageListParams

An object contains set of options for get message methods

Since

3.0.181

Declaration

Swift

@objc(SBDMessageListParams)
public class MessageListParams : NSObject, NSCopying


                    
                    
                    MessageChangeLogsParams

An object contains set of options for message change logs.

Since

3.0.181

Declaration

Swift

@objc(SBDMessageChangeLogsParams)
public class MessageChangeLogsParams : NSObject, NSCopying


                    
                    
                    GroupChannelChangeLogsParams

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

Since

3.0.182

Declaration

Swift

@objc(SBDGroupChannelChangeLogsParams)
public class GroupChannelChangeLogsParams : NSObject


                    
                    
                    GroupChannelCreateParams

An object contains set of options to create a group channel

Declaration

Swift

@objc(SBDGroupChannelCreateParams)
public class GroupChannelCreateParams : NSObject, Codable

extension GroupChannelCreateParams: NSCopying


                    
                    
                    GroupChannelTotalUnreadMessageCountParams

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

Declaration

Swift

@objc(SBDGroupChannelTotalUnreadMessageCountParams)
public class GroupChannelTotalUnreadMessageCountParams : NSObject


                    
                    
                    GroupChannelUpdateParams

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

Declaration

Swift

@objc(SBDGroupChannelUpdateParams)
public class GroupChannelUpdateParams : NSObject, Encodable


                    
                    
                    OpenChannelCreateParams

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.

Since

3.0.206

Declaration

Swift

@objc(SBDOpenChannelCreateParams)
public class OpenChannelCreateParams : NSObject, NSCopying


                    
                    
                    OpenChannelUpdateParams

An object contains set of options to update open channel

Since

4.0.0

Declaration

Swift

@objc(SBDOpenChannelUpdateParams)
public class OpenChannelUpdateParams : NSObject, NSCopying


                    
                    
                    PollUpdateEvent

Represents an poll update event

Since

4.1.0

Declaration

Swift

@objc(SBDPollUpdateEvent)
public class PollUpdateEvent : NSObject, SBCommand


                    
                    
                    UpdatedPoll

Undocumented

Declaration

Swift

public class UpdatedPoll : NSObject, Codable


                    
                    
                    PollVoteEvent

Represents a vote event on a poll

Since

4.1.0

Declaration

Swift

@objc(SBDPollVoteEvent)
public class PollVoteEvent : NSObject, Decodable, SBCommand


                    
                    
                    SBError

Sendbird error class.

Declaration

Swift

public class SBError : NSError


                    
                    
                    Atomic

Protoperty wrapper to access a property atomically

Declaration

Swift

@propertyWrapper
public class Atomic<T>


                    
                    
                    BaseMessage

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.

Declaration

Swift

@objc(SBDBaseMessage)
open class BaseMessage : NSObject, Codable, NSCopying, Injectable, SBCommand, SortableElement, Identifiable

extension BaseMessage: Mappable

extension BaseMessage: Serializable


                    
                    
                    User

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.

Declaration

Swift

@objc(SBDUser)
open class User : NSObject, Codable, Identifiable, Injectable

extension User: Mappable

extension User: NSCopying

extension User: Serializable


                    
                    
                    Poll

Represents a poll that users can vote

Since

4.1.0

Declaration

Swift

@objc(SBDPoll)
public class Poll : NSObject, Codable

extension Poll: Mappable

extension Poll: Serializable


                    
                    
                    EmojiCategory

Class to represent emoji cateogry

Since

3.0.180

Declaration

Swift

@objc(SBDEmojiCategory)
public class EmojiCategory : NSObject, Codable

extension EmojiCategory: Mappable

extension EmojiCategory: Serializable


                    
                    
                    ReactionEvent

An object 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.

Since

3.0.169

Declaration

Swift

@objc(SBDReactionEvent)
public class ReactionEvent : NSObject, Codable

extension ReactionEvent: Mappable


                    
                    
                    UnreadItemCount

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

Declaration

Swift

@objc(SBDUnreadItemCount)
public class UnreadItemCount : NSObject, Codable

extension UnreadItemCount: Mappable


                    
                    
                    Reaction

A object represents the reaction info.

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

Since

3.0.169

Declaration

Swift

@objc(SBDReaction)
public class Reaction : NSObject, Codable

extension Reaction: Mappable


                    
                    
                    BaseCollection

An base object for collection

Declaration

Swift

@objc(SBDBaseCollection)
open class BaseCollection : NSObject


                    
                    
                    LocalCacheConfig

An object that specifies the options for the local caching.

Since

4.6.0

Declaration

Swift

@objc(SBDLocalCacheConfig)
public class LocalCacheConfig : NSObject


                    
                    
                    GroupChannelCollection

An object that accesses the cache for the group channels.

Since

3.1.0

Declaration

Swift

@objc(SBDGroupChannelCollection)
open class GroupChannelCollection : BaseCollection

extension GroupChannelCollection: GroupChannelDelegate

extension GroupChannelCollection: ConnectionDelegate


                    
                    
                    ChannelContext

Channel context

Since

3.1.0

Declaration

Swift

@objc(SBDChannelContext)
public class ChannelContext : NSObject


                    
                    
                    MessageCollection

An object that accesses the cache for the messages.

Since

3.1.0

Declaration

Swift

@objc(SBDMessageCollection)
open class MessageCollection : BaseCollection

extension MessageCollection: GroupChannelDelegate

extension MessageCollection: ConnectionDelegate


                    
                    
                    MessageContext

Represents what happened to the messages.

Since

3.1.0

Declaration

Swift

@objc(SBDMessageContext)
public class MessageContext : NSObject


                    
                    
                    CachedBaseChannelInfo

Undocumented

Declaration

Swift

@objc(SBDCachedBaseChannelInfo)
public class CachedBaseChannelInfo : NSObject, Comparable


                    
                    
                    AdminMessage

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.

Declaration

Swift

@objc(SBDAdminMessage)
open class AdminMessage : BaseMessage


                    
                    
                    UserMessage

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

Declaration

Swift

@objc(SBDUserMessage)
open class UserMessage : BaseMessage


                    
                    
                    FileMessage

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

Note

This class doesn’t include a binary data for the file. It is just a URL.

Declaration

Swift

@objc(SBDFileMessage)
open class FileMessage : BaseMessage


                    
                    
                    BaseMessageCreateParams

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

The UserMessageCreateParams, the FileMessageCreateParams are derived from this class.

Declaration

Swift

@objc(SBDBaseMessageCreateParams)
public class BaseMessageCreateParams : NSObject, Codable, NSCopying


                    
                    
                    BaseMessageUpdateParams

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

The UserMessageUpdateParams, the FileMessageUpdateParams are derived from this class.

Declaration

Swift

@objc(SBDBaseMessageUpdateParams)
public class BaseMessageUpdateParams : NSObject, Encodable, NSCopying


                    
                    
                    MessageRetrievalParams

An object contains set of options to retrieve a message.

Since

3.0.181

Declaration

Swift

@objc(SBDMessageRetrievalParams)
public class MessageRetrievalParams : NSObject, NSCopying


                    
                    
                    NotificationTemplateListParams

Since

4.6.0

Declaration

Swift

@objc(SBDNotificationTemplateListParams)
public final class NotificationTemplateListParams : NSObject

extension NotificationTemplateListParams: NSCopying


                    
                    
                    ScheduledBaseMessageCreateParams

A base class to create a scheduled message.

Since

4.0.0

Declaration

Swift

@objc(SBDScheduledBaseMessageCreateParams)
public class ScheduledBaseMessageCreateParams : NSObject, Codable


                    
                    
                    ScheduledBaseMessageUpdateParams

A base class to update a scheduled message.

Since

4.0.0

Declaration

Swift

@objc(SBDScheduledBaseMessageUpdateParams)
public class ScheduledBaseMessageUpdateParams : NSObject


                    
                    
                    ScheduledMessageRetrievalParams

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

Since

4.0.0

Declaration

Swift

@objc(SBDScheduledMessageRetrievalParams)
public class ScheduledMessageRetrievalParams : NSObject


                    
                    
                    ThreadedMessageListParams

An object contains set of options to retrieve threaded messages.

Since

3.0.181

Declaration

Swift

@objc(SBDThreadedMessageListParams)
public class ThreadedMessageListParams : NSObject, NSCopying


                    
                    
                    TotalScheduledMessageCountParams

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

Since

4.0.0

Declaration

Swift

@objc(SBDTotalScheduledMessageCountParams)
public class TotalScheduledMessageCountParams : NSObject


                    
                    
                    FileMessageCreateParams

An object contains set of options to create FileMessage.

Since

3.0.90

Declaration

Swift

@objc(SBDFileMessageCreateParams)
public class FileMessageCreateParams : BaseMessageCreateParams


                    
                    
                    FileMessageUpdateParams

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

Declaration

Swift

@objc(SBDFileMessageUpdateParams)
public class FileMessageUpdateParams : BaseMessageUpdateParams


                    
                    
                    ScheduledFileMessageCreateParams

Undocumented

Declaration

Swift

@objc(SBDScheduledFileMessageCreateParams)
public class ScheduledFileMessageCreateParams : ScheduledBaseMessageCreateParams


                    
                    
                    ScheduledFileMessageUpdateParams

Undocumented

Declaration

Swift

@objc(SBDScheduledFileMessageUpdateParams)
public class ScheduledFileMessageUpdateParams : ScheduledBaseMessageUpdateParams


                    
                    
                    Thumbnail

Represents a thumbnail information

Declaration

Swift

@objc(SBDThumbnail)
public class Thumbnail : NSObject, Codable, Injectable

extension Thumbnail: Serializable


                    
                    
                    ThumbnailSize

The ThumbnailSize class represents the thumbnail size of thumbnail.

Declaration

Swift

@objc(SBDThumbnailSize)
public class ThumbnailSize : NSObject, Codable


                    
                    
                    MessageMetaArray

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.

Declaration

Swift

@objc(SBDMessageMetaArray)
public class MessageMetaArray : NSObject, Codable, NSCopying

extension MessageMetaArray: Serializable


                    
                    
                    OGImage

Represents OpenGraph Image information

Since

3.0.193

Declaration

Swift

@objc(SBDOGImage)
public class OGImage : NSObject, Codable


                    
                    
                    OGMetaData

Represents OpenGraph information

Since

3.0.193

Declaration

Swift

@objc(SBDOGMetaData)
public class OGMetaData : NSObject, Codable


                    
                    
                    PinnedMessage

Undocumented

Declaration

Swift

@objc(SBDPinnedMessage)
public class PinnedMessage : NSObject, Codable, NSCopying, Injectable


                    
                    
                    PollCreateParams

Represents a parameter object to create or update poll object

Since

4.1.0

Declaration

Swift

@objc(SBDPollCreateParams)
public class PollCreateParams : NSObject

extension PollCreateParams: Encodable


                    
                    
                    PollData

Represents a poll data

Since

4.1.0

Declaration

Swift

@objc(SBDPollData)
public class PollData : NSObject, Codable


                    
                    
                    PollDetails

Represents a poll details information

Since

4.1.0

Declaration

Swift

@objc(SBDPollDetails)
public class PollDetails : NSObject, Codable


                    
                    
                    PollListQuery

An object to retrieve list of Poll

Since

4.1.0

Declaration

Swift

@objc(SBDPollListQuery)
public class PollListQuery : NSObject, Queryable


                    
                    
                    PollListQueryParams

Represents a parameter object for creating a list of Polls.

Since

4.1.0

Declaration

Swift

@objc(SBDPollListQueryParams)
public class PollListQueryParams : NSObject


                    
                    
                    PollOption

Represents an option for poll

Since

4.1.0

Declaration

Swift

@objc(SBDPollOption)
public class PollOption : NSObject, Codable, Injectable


                    
                    
                    PollOptionRetrievalParams

An object that retrieves a specific poll option.

Since

4.1.0

Declaration

Swift

@objc(SBDPollOptionRetrievalParams)
public class PollOptionRetrievalParams : NSObject

extension PollOptionRetrievalParams: Encodable


                    
                    
                    PollOptionVoterResult

An object contains a voter result for an option

Since

4.1.0

Declaration

Swift

@objc(SBDPollOptionVoterResult)
public class PollOptionVoterResult : NSObject, Codable


                    
                    
                    PollRetrievalParams

An object contains set of options to retrieve Poll object

Since

4.1.0

Declaration

Swift

@objc(SBDPollRetrievalParams)
public class PollRetrievalParams : NSObject

extension PollRetrievalParams: Encodable


                    
                    
                    PollUpdateParams

An object contains set of options to update Poll

Since

4.1.0

Declaration

Swift

@objc(SBDPollUpdateParams)
public class PollUpdateParams : NSObject

extension PollUpdateParams: Encodable


                    
                    
                    UpdatedVoteCount

An object contains information about updated vote count

Since

4.1.0

Declaration

Swift

@objc(SBDUpdatedVoteCount)
public class UpdatedVoteCount : NSObject, Decodable


                    
                    
                    PollVoterListQuery

An object to retrieve list of voter

Since

4.1.0

Declaration

Swift

@objc(SBDPollVoterListQuery)
public class PollVoterListQuery : NSObject


                    
                    
                    PollVoterListQueryParams

This object is used when calling voterList query.

Since

4.1.0

Declaration

Swift

@objc(SBDPollVoterListQueryParams)
public class PollVoterListQueryParams : NSObject

extension PollVoterListQueryParams: Encodable


                    
                    
                    ScheduledInfo

Class holding an information about the scheduled messages.

Since

4.0.0

Declaration

Swift

@objc(SBDScheduledInfo)
public class ScheduledInfo : NSObject, Codable


                    
                    
                    ScheduledStatusOptions

Undocumented

Declaration

Swift

@objc(SBDScheduledStatusOptions)
public final class ScheduledStatusOptions : NSObject, OptionSet


                    
                    
                    ThreadInfo

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.

Since

3.0.181

Declaration

Swift

@objc(SBDThreadInfo)
public class ThreadInfo : NSObject, Codable


                    
                    
                    ThreadInfoUpdateEvent

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.

Since

3.0.181

Declaration

Swift

@objc(SBDThreadInfoUpdateEvent)
public class ThreadInfoUpdateEvent : NSObject, Codable, SBCommand


                    
                    
                    MultipleFilesMessage

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

Since

4.9.1

Declaration

Swift

@objc(SBDMultipleFilesMessage)
public class MultipleFilesMessage : BaseMessage


                    
                    
                    MultipleFilesMessageCreateParams

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

Since

4.9.1

Declaration

Swift

@objc(SBDMultipleFilesMessageCreateParams)
public class MultipleFilesMessageCreateParams : BaseMessageCreateParams


                    
                    
                    UploadableFileInfo

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

Since

4.9.1

Declaration

Swift

@objc(SBDUploadableFileInfo)
public class UploadableFileInfo : NSObject, Codable


                    
                    
                    UploadedFileInfo

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

Since

4.9.1

Declaration

Swift

@objc(SBDUploadedFileInfo)
public class UploadedFileInfo : NSObject, Codable, NSCopying, Injectable


                    
                    
                    ScheduledUserMessageCreateParams

An object that has parameters to create a scheduled message.

Since

4.0.0

Declaration

Swift

@objc(SBDScheduledUserMessageCreateParams)
public class ScheduledUserMessageCreateParams : ScheduledBaseMessageCreateParams


                    
                    
                    ScheduledUserMessageUpdateParams

An object that has parameters to update a scheduled message.

Since

4.0.0

Declaration

Swift

@objc(SBDScheduledUserMessageUpdateParams)
public class ScheduledUserMessageUpdateParams : ScheduledBaseMessageUpdateParams


                    
                    
                    UserMessageCreateParams

An object contains a set of options to create UserMessage.

Since

3.0.90

Declaration

Swift

@objc(SBDUserMessageCreateParams)
public class UserMessageCreateParams : BaseMessageCreateParams


                    
                    
                    UserMessageUpdateParams

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

Since

4.0.0

Declaration

Swift

@objc(SBDUserMessageUpdateParams)
public class UserMessageUpdateParams : BaseMessageUpdateParams


                    
                    
                    AppInfo

An object contains application information

Declaration

Swift

@objc(SBDAppInfo)
public class AppInfo : NSObject, Codable


                    
                    
                    AppleCriticalAlertOptions

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.

Since

3.0.221

Declaration

Swift

@objc(SBDAppleCriticalAlertOptions)
public class AppleCriticalAlertOptions : NSObject, Codable


                    
                    
                    DeliveryStatus

An object represets delivery status of a channel

Declaration

Swift

@objc(SBDDeliveryStatus)
public class DeliveryStatus : NSObject, Codable, SBCommand


                    
                    
                    Emoji

Class to represent emoji

Since

3.0.180

Declaration

Swift

@objc(SBDEmoji)
public class Emoji : NSObject, Codable

extension Emoji: Serializable


                    
                    
                    EmojiContainer

An object contains list of EmojiCategory and hash

Declaration

Swift

@objc(SBDEmojiContainer)
public class EmojiContainer : NSObject, Codable

extension EmojiContainer: Serializable


                    
                    
                    SendbirdChatOptions

Represents SendbirdChat options.

Declaration

Swift

public class SendbirdChatOptions : NSObject


                    
                    
                    GroupChannelTotalUnreadChannelCountParams

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

Declaration

Swift

@objc(SBDGroupChannelTotalUnreadChannelCountParams)
public class GroupChannelTotalUnreadChannelCountParams : NSObject, Encodable


                    
                    
                    InitParams

An object to initialize SendbirdChat

Since

4.0.0

Declaration

Swift

@objc(SBDInitParams)
public class InitParams : NSObject


                    
                    
                    Plugin

A object to represent a plugin

Since

3.0.207

Declaration

Swift

@objc(SBDPlugin)
public class Plugin : NSObject, Codable


                    
                    
                    ReadStatus

An object represents read status of a user

Declaration

Swift

@objc(SBDReadStatus)
public class ReadStatus : NSObject, Codable, SBCommand, Injectable


                    
                    
                    GroupChannelListQuerySearchField

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

Since

3.0.144

Declaration

Swift

@objc(SBDGroupChannelListQuerySearchField)
public class GroupChannelListQuerySearchField : NSObject, OptionSet, Codable


                    
                    
                    UnreadItemKey

The bitmask keys of count about unread messages or invitation.

Declaration

Swift

@objc(SBDUnreadItemKey)
public class UnreadItemKey : NSObject, OptionSet, Codable


                    
                    
                    SendbirdChat

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.

Declaration

Swift

public class SendbirdChat : NSObject


                    
                    
                    UIKitConfigInfo

Undocumented

Declaration

Swift

final public class UIKitConfigInfo : Codable


                    
                    
                    UIKitConfiguration

Since

4.8.4

Declaration

Swift

@objc(SBDUIKitConfiguration)
final public class UIKitConfiguration : NSObject, Codable


                    
                    
                    UnreadMessageCount

Since

4.6.0

Declaration

Swift

@objc(SBDUnreadMessageCount)
open class UnreadMessageCount : NSObject


                    
                    
                    FeedChannel

Since

4.6.0

Declaration

Swift

@objc(SBDFeedChannel)
open class FeedChannel : BaseChannel, SortableElement


                    
                    
                    FeedChannelContext

Channel context

Since

3.1.0

Declaration

Swift

@objc(SBDFeedChannelContext)
public class FeedChannelContext : NSObject


                    
                    
                    NotificationCollection

An object that accesses the cache for the messages.

Since

4.6.0

Declaration

Swift

@objc(SBDNotificationCollection)
open class NotificationCollection : BaseCollection

extension NotificationCollection: FeedChannelDelegate

extension NotificationCollection: ConnectionDelegate


                    
                    
                    NotificationContext

Represents what happened to the messages.

Since

4.6.0

Declaration

Swift

@objc(SBDNotificationContext)
public class NotificationContext : NSObject


                    
                    
                    GlobalNotificationChannelSetting

Since

4.6.0

Declaration

Swift

@objc(SBDGlobalNotificationChannelSetting)
open class GlobalNotificationChannelSetting : NSObject


                    
                    
                    NotificationInfo

Since

4.6.0

Declaration

Swift

@objc(SBDNotificationInfo)
open class NotificationInfo : NSObject, Codable


                    
                    
                    NotificationTemplate

Since

4.6.0

Declaration

Swift

@objc(SBDNotificationTemplate)
open class NotificationTemplate : NSObject


                    
                    
                    NotificationTemplateList

Since

4.6.0

Declaration

Swift

@objc(SBDNotificationTemplateList)
open class NotificationTemplateList : NSObject


                    
                    
                    FeedChannelChangeLogsParams

Since

4.6.0

Declaration

Swift

@objc(SBDFeedChannelChangeLogsParams)
public class FeedChannelChangeLogsParams : NSObject


                    
                    
                    FeedChannelListQuery

Undocumented

Declaration

Swift

@objc(SBDFeedChannelListQuery)
public class FeedChannelListQuery : NSObject, NSCopying, Queryable


                    
                    
                    FeedChannelListQueryParams

Undocumented

Declaration

Swift

@objc(SBDFeedChannelListQueryParams)
public final class FeedChannelListQueryParams : NSObject, Codable

extension FeedChannelListQueryParams: NSCopying


                    
                    
                    GroupChannelListQuery

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.

Declaration

Swift

@objc(SBDGroupChannelListQuery)
public class GroupChannelListQuery : NSObject, Codable, Queryable

extension GroupChannelListQuery: Serializable


                    
                    
                    GroupChannelListQueryParams

Undocumented

Declaration

Swift

@objc(SBDGroupChannelListQueryParams)
public final class GroupChannelListQueryParams : NSObject, Codable

extension GroupChannelListQueryParams: NSCopying


                    
                    
                    OpenChannelListQuery

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.

Declaration

Swift

@objc(SBDOpenChannelListQuery)
public class OpenChannelListQuery : NSObject, NSCopying, Queryable


                    
                    
                    OpenChannelListQueryParams

Undocumented

Declaration

Swift

@objc(SBDOpenChannelListQueryParams)
public final class OpenChannelListQueryParams : NSObject

extension OpenChannelListQueryParams: NSCopying


                    
                    
                    PublicGroupChannelListQuery

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.

Declaration

Swift

@objc(SBDPublicGroupChannelListQuery)
public class PublicGroupChannelListQuery : NSObject, Queryable


                    
                    
                    PublicGroupChannelListQueryParams

Undocumented

Declaration

Swift

@objc(SBDPublicGroupChannelListQueryParams)
public final class PublicGroupChannelListQueryParams : NSObject

extension PublicGroupChannelListQueryParams: NSCopying


                    
                    
                    MessageSearchQuery

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

Since

3.0.162

Declaration

Swift

@objc(SBDMessageSearchQuery)
public class MessageSearchQuery : NSObject, Codable, Queryable

extension MessageSearchQuery: Serializable


                    
                    
                    MessageSearchQueryParams

Message search query builder

Declaration

Swift

@objc(SBDMessageSearchQueryParams)
public class MessageSearchQueryParams : NSObject, Codable

extension MessageSearchQueryParams: NSCopying


                    
                    
                    PinnedMessageListQuery

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.

Since

4.8.0

Declaration

Swift

@objc(SBDPinnedMessageListQuery)
public class PinnedMessageListQuery : NSObject, Queryable


                    
                    
                    PinnedMessageListQueryParams

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

Since

4.8.0

Declaration

Swift

@objc(SBDPinnedMessageListQueryParams)
public final class PinnedMessageListQueryParams : NSObject, NSCopying


                    
                    
                    PreviousMessageListQuery

An object which retrieves messages from the given channel.

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

Declaration

Swift

@objc(SBDPreviousMessageListQuery)
public class PreviousMessageListQuery : NSObject, Queryable


                    
                    
                    PreviousMessageListQueryParams

Undocumented

Declaration

Swift

@objc(SBDPreviousMessageListQueryParams)
public final class PreviousMessageListQueryParams : NSObject

extension PreviousMessageListQueryParams: NSCopying


                    
                    
                    ScheduledMessageListQuery

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

Since

4.0.0

Declaration

Swift

@objc(SBDScheduledMessageListQuery)
public class ScheduledMessageListQuery : NSObject

extension ScheduledMessageListQuery: NSCopying


                    
                    
                    ScheduledMessageListQueryParams

Undocumented

Declaration

Swift

@objc(SBDScheduledMessageListQueryParams)
public final class ScheduledMessageListQueryParams : NSObject

extension ScheduledMessageListQueryParams: NSCopying


                    
                    
                    ApplicationUserListQuery

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.

Since

3.0.120

Declaration

Swift

@objc(SBDApplicationUserListQuery)
public class ApplicationUserListQuery : NSObject, Queryable, UserListQuery


                    
                    
                    ApplicationUserListQueryParams

Undocumented

Declaration

Swift

@objc(SBDApplicationUserListQueryParams)
public final class ApplicationUserListQueryParams : NSObject

extension ApplicationUserListQueryParams: NSCopying


                    
                    
                    BannedUserListQuery

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.

Since

3.0.120

Declaration

Swift

@objc(SBDBannedUserListQuery)
public class BannedUserListQuery : NSObject, Queryable, RestrictedUserListQuery


                    
                    
                    BannedUserListQueryParams

Undocumented

Declaration

Swift

@objc(SBDBannedUserListQueryParams)
public final class BannedUserListQueryParams : NSObject

extension BannedUserListQueryParams: NSCopying


                    
                    
                    BlockedUserListQuery

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.

Since

3.0.120

Declaration

Swift

@objc(SBDBlockedUserListQuery)
public class BlockedUserListQuery : NSObject, Queryable, UserListQuery


                    
                    
                    BlockedUserListQueryParams

Undocumented

Declaration

Swift

@objc(SBDBlockedUserListQueryParams)
public final class BlockedUserListQueryParams : NSObject

extension BlockedUserListQueryParams: NSCopying


                    
                    
                    FriendListQuery

A object to retrieve friend list

Declaration

Swift

@objc(SBDFriendListQuery)
public class FriendListQuery : NSObject, Queryable, UserListQuery


                    
                    
                    FriendListQueryParams

Undocumented

Declaration

Swift

@objc(SBDFriendListQueryParams)
public class FriendListQueryParams : NSObject

extension FriendListQueryParams: NSCopying


                    
                    
                    MemberListQuery

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.

Declaration

Swift

@objc(SBDMemberListQuery)
public class MemberListQuery : NSObject, Queryable


                    
                    
                    MemberListQueryParams

Undocumented

Declaration

Swift

@objc(SBDMemberListQueryParams)
public final class MemberListQueryParams : NSObject

extension MemberListQueryParams: NSCopying


                    
                    
                    MutedUserListQuery

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.

Since

3.0.120

Declaration

Swift

@objc(SBDMutedUserListQuery)
public class MutedUserListQuery : NSObject, Queryable, RestrictedUserListQuery


                    
                    
                    MutedUserListQueryParams

Undocumented

Declaration

Swift

@objc(SBDMutedUserListQueryParams)
public final class MutedUserListQueryParams : NSObject

extension MutedUserListQueryParams: NSCopying


                    
                    
                    OperatorListQuery

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.

Declaration

Swift

@objc(SBDOperatorListQuery)
public class OperatorListQuery : NSObject, Queryable, UserListQuery


                    
                    
                    OperatorListQueryParams

Undocumented

Declaration

Swift

@objc(SBDOperatorListQueryParams)
public final class OperatorListQueryParams : NSObject

extension OperatorListQueryParams: NSCopying


                    
                    
                    ParticipantListQuery

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.

Since

3.0.120

Declaration

Swift

@objc(SBDParticipantListQuery)
public class ParticipantListQuery : NSObject, Queryable, UserListQuery


                    
                    
                    ParticipantListQueryParams

Undocumented

Declaration

Swift

@objc(SBDParticipantListQueryParams)
public final class ParticipantListQueryParams : NSObject

extension ParticipantListQueryParams: NSCopying


                    
                    
                    __SendbirdStatistics

The entry point for handling statistics

Warning

This class is only for SendBird modules. Do not use this class in external services.

Declaration

Swift

public class __SendbirdStatistics


                    
                    
                    MessageRequestState

Undocumented

Declaration

Swift

@objc(SBDMessageRequestState)
public class MessageRequestState : NSObject


                    
                    
                    Member

Represents a member in GroupChannel

Declaration

Swift

@objc(SBDMember)
public class Member : User


                    
                    
                    Participant

Represents a participant in OpenChannel.

Since

4.3.0

Declaration

Swift

@objc(SBDParticipant)
public class Participant : User


                    
                    
                    RestrictedUser

Represents a user who has been restricted in a channel

Declaration

Swift

@objc(SBDRestrictedUser)
public class RestrictedUser : User


                    
                    
                    RestrictionInfo

An object contains information about restriction

Declaration

Swift

@objc(SBDRestrictionInfo)
public class RestrictionInfo : NSObject, Codable


                    
                    
                    Sender

Represents a user that typically binds with message

Declaration

Swift

@objc(SBDSender)
public class Sender : User


                    
                    
                    UserUpdateParams

An object to update user information

Since

4.0.0

Declaration

Swift

@objc(SBDUserUpdateParams)
public class UserUpdateParams : NSObject, Encodable