Package-level declarations

Types

Link copied to clipboard
data class ApplicationUserListQueryParams @JvmOverloads constructor(var userIdsFilter: List<String>? = null, var nicknameStartsWithFilter: String? = null, var metaDataFilter: Pair<String, List<String>>? = null, var limit: Int = QUERY_DEFAULT_LIMIT)

Params for creating a ApplicationUserListQuery object.

Link copied to clipboard
data class BannedUserListQueryParams @JvmOverloads constructor(var channelType: ChannelType, var channelUrl: String, var limit: Int = QUERY_DEFAULT_LIMIT)

Params for creating a BannedUserListQuery object.

Link copied to clipboard

Represents a base message params.

Link copied to clipboard

Represents a base for message list params.

Link copied to clipboard

Represents a base message params.

Link copied to clipboard
data class BlockedUserListQueryParams @JvmOverloads constructor(var userIdsFilter: List<String>? = null, var limit: Int = QUERY_DEFAULT_LIMIT)

Params for creating a BlockedUserListQuery object.

Link copied to clipboard
data class FeedChannelChangeLogsParams(var includeEmpty: Boolean = true)

Represents a group channel change logs params.

Link copied to clipboard
class FeedChannelListQueryParams @JvmOverloads constructor(var includeEmpty: Boolean = false, var limit: Int = QUERY_DEFAULT_LIMIT)

Params for creating a FeedChannelListQuery object.

Link copied to clipboard

Represents a file message params.

Link copied to clipboard

Represents a file message params.

Link copied to clipboard
data class FriendListQueryParams @JvmOverloads constructor(var limit: Int = QUERY_DEFAULT_LIMIT)

Params for creating a FriendListQuery object.

Link copied to clipboard
data class GroupChannelChangeLogsParams(var customTypes: List<String>? = null, var includeEmpty: Boolean = true, var includeFrozen: Boolean = true, var includeChatNotification: Boolean = false)

Represents a group channel change logs params.

Link copied to clipboard
data class GroupChannelCollectionCreateParams @JvmOverloads constructor(val query: GroupChannelListQuery = GroupChannel.createMyGroupChannelListQuery(GroupChannelListQueryParams()), var groupChannelCollectionHandler: GroupChannelCollectionHandler? = null)

A params to create the GroupChannelCollection object.

Link copied to clipboard

Represents a group channel create params.

Link copied to clipboard
class GroupChannelListQueryParams @JvmOverloads constructor(var order: GroupChannelListQueryOrder = GroupChannelListQueryOrder.LATEST_LAST_MESSAGE, var includeEmpty: Boolean = false, var includeFrozen: Boolean = true, var includeMetadata: Boolean = true, var superChannelFilter: SuperChannelFilter = SuperChannelFilter.ALL, var publicChannelFilter: PublicChannelFilter = PublicChannelFilter.ALL, var unreadChannelFilter: UnreadChannelFilter = UnreadChannelFilter.ALL, var hiddenChannelFilter: HiddenChannelFilter = HiddenChannelFilter.UNHIDDEN, var myMemberStateFilter: MyMemberStateFilter = MyMemberStateFilter.ALL, var metaDataOrderKeyFilter: String? = null, var customTypeStartsWithFilter: String? = null, var channelUrlsFilter: List<String>? = null, var channelNameContainsFilter: String? = null, var customTypesFilter: List<String>? = null, var limit: Int = QUERY_DEFAULT_LIMIT)

Params for creating a GroupChannelListQuery object.

data class GroupChannelTotalUnreadChannelCountParams @JvmOverloads constructor(var superChannelFilter: SuperChannelFilter = SuperChannelFilter.ALL, var channelCustomTypes: List<String>? = null)

Represents a group channel total unread channel count params.

data class GroupChannelTotalUnreadMessageCountParams @JvmOverloads constructor(var superChannelFilter: SuperChannelFilter = SuperChannelFilter.ALL, var channelCustomTypes: List<String>? = null)

Represents a group channel total unread message count params.

Link copied to clipboard

Represents a group channel update params.

Link copied to clipboard
data class InitParams @JvmOverloads constructor(val appId: String, val context: Context, val useCaching: Boolean, var logLevel: LogLevel = LogLevel.WARN, var isForeground: Boolean = false, var appVersion: String? = null, var localCacheConfig: LocalCacheConfig = LocalCacheConfig())

Represents a params used in SendbirdChat.init.

Link copied to clipboard
data class MemberListQueryParams @JvmOverloads constructor(var order: MemberListQuery.Order = Order.MEMBER_NICKNAME_ALPHABETICAL, var operatorFilter: OperatorFilter = OperatorFilter.ALL, var mutedMemberFilter: MutedMemberFilter = MutedMemberFilter.ALL, var memberStateFilter: MemberStateFilter = MemberStateFilter.ALL, var nicknameStartsWithFilter: String? = null, var limit: Int = QUERY_DEFAULT_LIMIT)

Params for creating a MemberListQuery object.

Link copied to clipboard
data class MessageChangeLogsParams @JvmOverloads constructor(var messagePayloadFilter: MessagePayloadFilter = MessagePayloadFilter(), var replyType: ReplyType = ReplyType.NONE)

Represents a message list params.

Link copied to clipboard
data class MessageCollectionCreateParams @JvmOverloads constructor(val channel: GroupChannel, var messageListParams: MessageListParams, var startingPoint: Long = Long.MAX_VALUE, var messageCollectionHandler: MessageCollectionHandler? = null)

A params to create the MessageCollection.

Link copied to clipboard

Represents a message list params.

Link copied to clipboard
data class MessageRetrievalParams @JvmOverloads constructor(val channelUrl: String, val channelType: ChannelType, val messageId: Long, var messagePayloadFilter: MessagePayloadFilter = MessagePayloadFilter())

Represents a params for retrieving a single message.

Link copied to clipboard
data class MessageSearchQueryParams @JvmOverloads constructor(val keyword: String, var reverse: Boolean = false, var exactMatch: Boolean = false, var limit: Int = QUERY_DEFAULT_LIMIT, var messageTimestampFrom: Long = 0, var messageTimestampTo: Long = Long.MAX_VALUE, var channelUrl: String? = "", var channelCustomType: String? = null, var order: MessageSearchQuery.Order = MessageSearchQuery.Order.SCORE, var advancedQuery: Boolean = false, var targetFields: List<String>? = null)

Params for creating a MessageSearchQuery object.

Link copied to clipboard
data class MutedUserListQueryParams @JvmOverloads constructor(var channelType: ChannelType, var channelUrl: String, var limit: Int = QUERY_DEFAULT_LIMIT)

Params for creating a MutedUserListQuery object.

Link copied to clipboard

Params for retrieving Notification template list.

Link copied to clipboard

Represents a open channel params.

Link copied to clipboard
data class OpenChannelListQueryParams @JvmOverloads constructor(var nameKeyword: String? = null, var urlKeyword: String? = null, var customTypeFilter: String? = null, var includeFrozen: Boolean = true, var includeMetadata: Boolean = true, var limit: Int = QUERY_DEFAULT_LIMIT)

Params for creating a OpenChannelListQuery object.

Link copied to clipboard

Represents a open channel params.

Link copied to clipboard
data class OperatorListQueryParams @JvmOverloads constructor(var channelType: ChannelType, var channelUrl: String, var limit: Int = QUERY_DEFAULT_LIMIT)

Params for creating a OperatorListQuery object.

Link copied to clipboard
data class ParticipantListQueryParams @JvmOverloads constructor(var channelUrl: String, var limit: Int = QUERY_DEFAULT_LIMIT)

Params for creating a ParticipantListQuery object.

Link copied to clipboard
class PinnedMessageListQueryParams(var channelType: ChannelType, var channelUrl: String)

Represents query parameters for getting pinned messages.

Link copied to clipboard
data class PollCreateParams @JvmOverloads constructor(var title: String, var optionTexts: List<String>, var data: PollData? = null, var allowUserSuggestion: Boolean? = null, var allowMultipleVotes: Boolean? = null, var closeAt: Long = Poll.POLL_DEFAULT_TS)

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.

Link copied to clipboard
data class PollListQueryParams @JvmOverloads constructor(var channelType: ChannelType, var channelUrl: String, var limit: Int = 10)

Params for creating a PollListQuery object.

Link copied to clipboard
data class PollOptionRetrievalParams(val pollId: Long, val pollOptionId: Long, val channelType: ChannelType, val channelUrl: String)

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.

Link copied to clipboard
data class PollRetrievalParams(var pollId: Long, val channelType: ChannelType, var channelUrl: String)

Parameters for retrieving poll operations. For poll retrieval, pollId, channelType and channelUrl are required and all other members are optional.

Link copied to clipboard
data class PollUpdateParams @JvmOverloads constructor(var title: String? = null, var data: PollData? = null, var allowUserSuggestion: Boolean? = null, var allowMultipleVotes: Boolean? = null, var closeAt: Long = Poll.POLL_DEFAULT_TS)

Parameters for updating poll operations. All members are optional.

Link copied to clipboard
data class PollVoterListQueryParams @JvmOverloads constructor(var pollId: Long, var pollOptionId: Long, var channelType: ChannelType, var channelUrl: String, var limit: Int = QUERY_DEFAULT_LIMIT)

Params for creating a PollVoterListQuery object.

Link copied to clipboard
data class PreviousMessageListQueryParams @JvmOverloads constructor(var customTypesFilter: Collection<String>? = null, var messageTimestamp: Long = Long.MAX_VALUE, var reverse: Boolean = false, var messageTypeFilter: MessageTypeFilter = MessageTypeFilter.ALL, var senderUserIdsFilter: List<String>? = null, var replyType: ReplyType = ReplyType.NONE, var messagePayloadFilter: MessagePayloadFilter = MessagePayloadFilter(), var showSubchannelMessagesOnly: Boolean = false, var limit: Int = QUERY_DEFAULT_LIMIT)

Params for creating a PreviousMessageListQuery object.

Link copied to clipboard
class PublicGroupChannelListQueryParams @JvmOverloads constructor(var order: GroupChannelListQueryOrder = GroupChannelListQueryOrder.CHRONOLOGICAL, var includeEmpty: Boolean = true, var includeFrozen: Boolean = true, var includeMetadata: Boolean = true, var superChannelFilter: SuperChannelFilter = SuperChannelFilter.ALL, var membershipFilter: MembershipFilter = MembershipFilter.JOINED, var metaDataOrderKeyFilter: String? = null, var customTypeStartsWithFilter: String? = null, var channelUrlsFilter: List<String>? = null, var channelNameContainsFilter: String? = null, var customTypesFilter: List<String>? = null, var limit: Int = QUERY_DEFAULT_LIMIT)

Params for creating a PublicGroupChannelListQuery object.

Link copied to clipboard

Represents a base scheduled message create params.

Link copied to clipboard

Represents a base scheduled message update params.

Link copied to clipboard

Represents a scheduled file message params.

Link copied to clipboard

Represents a scheduled file message update params.

Link copied to clipboard
data class ScheduledMessageListQueryParams @JvmOverloads constructor(var order: ScheduledMessageListQuery.Order = Order.CREATED_AT, var messageTypeFilter: MessageTypeFilter = MessageTypeFilter.ALL, var reverse: Boolean = false, var channelUrl: String? = null, var scheduledStatus: List<ScheduledStatus>? = null, var limit: Int = QUERY_DEFAULT_LIMIT)

Params for creating a ScheduledMessageListQuery object.

Link copied to clipboard
data class ScheduledMessageRetrievalParams(val channelUrl: String, val scheduledMessageId: Long)

Represents a params for retrieving a single scheduled message.

Link copied to clipboard

Represents a scheduled user message params.

Link copied to clipboard

Represents a scheduled user message update params.

Link copied to clipboard
data class ThreadedParentMessageListQueryParams @JvmOverloads constructor(var limit: Int = QUERY_DEFAULT_LIMIT)

Params for creating a ThreadedParentMessageListQueryParams object.

Link copied to clipboard

Represents a message list params.

Link copied to clipboard
data class TotalScheduledMessageCountParams @JvmOverloads constructor(var channelUrl: String? = null, var scheduledStatus: List<ScheduledStatus>? = null, var messageTypeFilter: MessageTypeFilter = MessageTypeFilter.ALL)

Represents a params for retrieving total scheduled message.

Link copied to clipboard
class UserMessageCreateParams @JvmOverloads constructor(var message: String = "") : BaseMessageCreateParams

Represents a user message params.

Link copied to clipboard
class UserMessageUpdateParams @JvmOverloads constructor(var message: String? = null) : BaseMessageUpdateParams

Represents a user message update params.

Link copied to clipboard

Params for update current users.