Sendbird Chat/com.sendbird.android.params

Package-level declarations

Types

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.

BannedUserListQueryParams

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

Params for creating a BannedUserListQuery object.

BaseMessageCreateParams

sealed class BaseMessageCreateParams

Represents a base message params.

BaseMessageListParams

open class BaseMessageListParams

Represents a base for message list params.

BaseMessageUpdateParams

sealed class BaseMessageUpdateParams

Represents a base message params.

BlockedUserListQueryParams

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

Params for creating a BlockedUserListQuery object.

FeedChannelChangeLogsParams

data class FeedChannelChangeLogsParams(var includeEmpty: Boolean = true)

Represents a group channel change logs params.

FeedChannelListQueryParams

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

Params for creating a FeedChannelListQuery object.

FileMessageCreateParams

class FileMessageCreateParams : BaseMessageCreateParams

Represents a file message params.

FileMessageUpdateParams

class FileMessageUpdateParams : BaseMessageUpdateParams

Represents a file message params.

FriendListQueryParams

data class FriendListQueryParams @JvmOverloads constructor(var limit: Int = QUERY_DEFAULT_LIMIT)

Params for creating a FriendListQuery object.

GroupChannelChangeLogsParams

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.

GroupChannelCollectionCreateParams

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

A params to create the GroupChannelCollection object.

GroupChannelCreateParams

class GroupChannelCreateParams

Represents a group channel create params.

GroupChannelListQueryParams

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.

GroupChannelTotalUnreadChannelCountParams

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

Represents a group channel total unread channel count params.

GroupChannelTotalUnreadMessageCountParams

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

Represents a group channel total unread message count params.

GroupChannelUpdateParams

class GroupChannelUpdateParams

Represents a group channel update params.

InitParams

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.

MemberListQueryParams

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.

MessageChangeLogsParams

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

Represents a message list params.

MessageCollectionCreateParams

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.

MessageListParams

class MessageListParams : BaseMessageListParams

Represents a message list params.

MessageRetrievalParams

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.

MessageSearchQueryParams

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.

MessageTemplateListParams

data class MessageTemplateListParams @JvmOverloads constructor(val reverse: Boolean = false, val limit: Int = 20, val keys: List<String>? = null)

Parameters for retrieving message template list.

MultipleFilesMessageCreateParams

class MultipleFilesMessageCreateParams(val uploadableFileInfoList: List<UploadableFileInfo>) : BaseMessageCreateParams

The set of parameters to create com.sendbird.android.message.MultipleFilesMessage.

MutedUserListQueryParams

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

Params for creating a MutedUserListQuery object.

NotificationTemplateListParams

class NotificationTemplateListParams

Params for retrieving Notification template list.

OpenChannelCreateParams

class OpenChannelCreateParams

Represents a open channel params.

OpenChannelListQueryParams

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.

OpenChannelUpdateParams

class OpenChannelUpdateParams

Represents a open channel params.

OperatorListQueryParams

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

Params for creating a OperatorListQuery object.

ParticipantListQueryParams

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

Params for creating a ParticipantListQuery object.

PinnedMessageListQueryParams

class PinnedMessageListQueryParams(var channelType: ChannelType, var channelUrl: String)

Represents query parameters for getting pinned messages.

PollCreateParams

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.

PollListQueryParams

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

Params for creating a PollListQuery object.

PollOptionRetrievalParams

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.

PollRetrievalParams

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.

PollUpdateParams

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.

PollVoterListQueryParams

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.

PreviousMessageListQueryParams

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.

PublicGroupChannelListQueryParams

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.

ScheduledBaseMessageCreateParams

sealed class ScheduledBaseMessageCreateParams

Represents a base scheduled message create params.

ScheduledBaseMessageUpdateParams

sealed class ScheduledBaseMessageUpdateParams

Represents a base scheduled message update params.

ScheduledFileMessageCreateParams

class ScheduledFileMessageCreateParams(val scheduledAt: Long) : ScheduledBaseMessageCreateParams

Represents a scheduled file message params.

ScheduledFileMessageUpdateParams

class ScheduledFileMessageUpdateParams : ScheduledBaseMessageUpdateParams

Represents a scheduled file message update params.

ScheduledMessageListQueryParams

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.

ScheduledMessageRetrievalParams

data class ScheduledMessageRetrievalParams(val channelUrl: String, val scheduledMessageId: Long)

Represents a params for retrieving a single scheduled message.

ScheduledUserMessageCreateParams

class ScheduledUserMessageCreateParams(val scheduledAt: Long) : ScheduledBaseMessageCreateParams

Represents a scheduled user message params.

ScheduledUserMessageUpdateParams

class ScheduledUserMessageUpdateParams : ScheduledBaseMessageUpdateParams

Represents a scheduled user message update params.

ThreadMessageListParams

class ThreadMessageListParams : BaseMessageListParams

Represents a message list params.

TotalScheduledMessageCountParams

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.

UserMessageCreateParams

class UserMessageCreateParams @JvmOverloads constructor(var message: String = "") : BaseMessageCreateParams

Represents a user message params.

UserMessageUpdateParams

class UserMessageUpdateParams @JvmOverloads constructor(var message: String? = null) : BaseMessageUpdateParams

Represents a user message update params.

UserUpdateParams

class UserUpdateParams

Params for update current users.