sendbird_sdk library Null safety
Sendbird SDK for flutter
Classes
- AdminMessage
- Represents an admin message that can be sent from dashboard
- AppInfo
- Represents current Sendbird application information.
- ApplicationUserListQuery
- A query object to retrieve list of user on current application.
- AuthenticateEventHandler
- Represents a class to get notify authentication events
- BaseChannel
- Represents base channel
- BaseMessage
- Represents base class for messages.
- ChannelEventHandler
- Represents a class to notify various channel event.
- ConnectionEventHandler
- Represents a class to notify various connection event.
- Emoji
- An object represents emoji information
- EmojiCategory
- An object represents emoji category information
- EmojiContainer
- An object represents emoji container information
- ErrorCode
- Represents a set of error code from server and sdk
- FileInfo
- Represents information about image that will be used to upload
- FileMessage
- Represents media type message, typically serve image or video type message.
- FileMessageParams
- An object consists a set of parameters for file message.
- GroupChannel
- Represents group channel
- GroupChannelChangeLogsParams
- An object consists a set of parameters for group channel change logs
- GroupChannelListQuery
- A query object to retrieve list of my group channel.
- GroupChannelMemberListQuery
- A query object to retrieve list of members from my group channel.
- GroupChannelParams
- An object consists a set of parameters to create/update group channel.
- GroupChannelTotalUnreadMessageCountParams
- An object consists a set of parameters for group channel total unread message count.
- Member
- Represents a member of a channel.
- MessageChangeLogParams
- An object consists a set of parameters to retrieve message's change log
- MessageListParams
- An object consists a set of parameters to retrieve list of messages.
- MessageMetaArray
- An object represents message meta array.
- MessageRetrievalParams
- An object consists a set of parameters to retrieve information from a message.
- MessageSearchQuery
- A query object to search messages
- NetworkEventHandler
- Represents a class to get notify network events
- OpenChannel
- Represents open channel
- OpenChannelListQuery
- A query object to retrieve list of open channel.
- OpenChannelParams
- An object consists a set of parameters to create/update open channel.
- OperatorListQuery
- A query object to retrieve operators.
- Options
- A structure for options to SendbirdSdk.
- PreviousMessageListQuery
- A query object to retrieve previous messages
- PublicGroupChannelListQuery
- A query object to retrieve list of public group channel.
- Reaction
- Represents a reaction.
- ReactionEvent
- Represents an reaction event that happens on BaseMessage.
- ScheduledUserMessageParams
- An object consists a set of parameters to create scheduled user message.
- SendbirdSdk
- An object represents a main class to use Sendbird Chat
- Sender
- An object represents a sender of a message.
- SessionEventHandler
- Represents a class to notify user session event.
- ThreadedMessageListParams
- An object consists a set of parameters to retrieve list of a threaded message
- ThreadInfo
- Represents thread information on BaseMessage
- ThreadInfoUpdateEvent
- Represents thread update information.
- Thumbnail
- An object represents thumbnail
- User
- An object represents user
- UserEventHandler
- Represents a class to notify user event.
- UserListQuery
- #################### SECURITY TIPS #################### Before launching, you should review "Allow retrieving user list from SDK" under ⚙️ Sendbird Dashboard ->Settings -> Security. It's turned on at first to simplify running samples and implementing your first code. Most apps will want to disable "Allow retrieving user list from SDK" as that could possibly expose user information #################### SECURITY TIPS #################### A query object to retrieve user list
- UserMessage
- Represents a basic text message
- UserMessageParams
- An object consists a set of parameters to create/update user message.
Extensions
- BaseChannelConfiguration
- Set of functionality related to configure channel
- ChannelTypeExtension
- GroupChannelConfiguration
- Set of functionality related to configure group channel
- GroupChannelOperations
- Set of functionality related to operating a group channel
- GroupChannelRead
- Set of functionality related to read feature for group channel
- GroupChannelTyping
- Set of functionality related to typing feature for group channel
- IncludeOptionList
- Messages
- Set of functionality related to message
- Meta
- Set of functionality related to meta
- Moderations
- Set of functionality related to channel moderation
- OpenChannelOperations
- Set of functionality related to operating a open channel
- Reactions
- Set of functionality related to reaction feature
Constants
-
countPreferenceEnumMap
→ const Map<
CountPreference, String> -
<CountPreference, String>{CountPreference.all : 'all', CountPreference.messageOnly : 'unread_message_count_only', CountPreference.mentionOnly : 'unread_mention_count_only'… -
groupChannelListOrderEnumMap
→ const Map<
GroupChannelListOrder, String> -
<GroupChannelListOrder, String>{GroupChannelListOrder.chronological : 'chronological', GroupChannelListOrder.latestLastMessage : 'latest_last_message', GroupChannelListOrder.chan… -
groupChannelListQuerySearchFieldEnumMap
→ const Map<
GroupChannelListQuerySearchField, String> -
<GroupChannelListQuerySearchField, String>{GroupChannelListQuerySearchField.memberNickname : 'member_nick_name', GroupChannelListQuerySearchField.channelName : 'channel_name'} -
groupChannelPublicFilterEnumMap
→ const Map<
PublicChannelFilter, String> -
<PublicChannelFilter, String>{PublicChannelFilter.all : 'all', PublicChannelFilter.public : 'public', PublicChannelFilter.private : 'private'} -
groupChannelPushTriggerOptionEnumMap
→ const Map<
GroupChannelPushTriggerOption, String> -
<GroupChannelPushTriggerOption, String>{GroupChannelPushTriggerOption.global : 'default', GroupChannelPushTriggerOption.all : 'all', GroupChannelPushTriggerOption.off : 'off&… -
memberListOrderEnumMap
→ const Map<
MemberListOrder, String> -
<MemberListOrder, String>{MemberListOrder.nicknameAlphabetical : 'member_nickname_alphabetical', MemberListOrder.operatorThenMemberNicknameAlphabetical : 'operator_then_member_alphab… -
messageSearchQueryOrderEnumMap
→ const Map<
MessageSearchQueryOrder, String> -
<MessageSearchQueryOrder, String>{MessageSearchQueryOrder.score : 'score', MessageSearchQueryOrder.timestamp : 'ts'} -
messageTypeEnumMap
→ const Map<
MessageType, String> -
<MessageType, String>{MessageType.admin : 'ADMN', MessageType.file : 'FILE', MessageType.user : 'MESG'} -
messageTypeFilterEnumMap
→ const Map<
MessageTypeFilter, String> -
<MessageTypeFilter, String>{MessageTypeFilter.admin : 'ADMN', MessageTypeFilter.file : 'FILE', MessageTypeFilter.user : 'MESG'} -
mutedMemberFilterEnumMap
→ const Map<
MutedMemberFilter, String> -
<MutedMemberFilter, String>{MutedMemberFilter.all : 'all', MutedMemberFilter.muted : 'muted', MutedMemberFilter.unmuted : 'unmuted'} -
operatorFilterEnumMap
→ const Map<
OperatorFilter, String> -
<OperatorFilter, String>{OperatorFilter.all : 'all', OperatorFilter.operator : 'operator', OperatorFilter.nonOperator : 'nonoperator'} -
publicGroupChannelListOrderEnumMap
→ const Map<
PublicGroupChannelListOrder, String> -
<PublicGroupChannelListOrder, String>{PublicGroupChannelListOrder.chronological : 'chronological', PublicGroupChannelListOrder.channelNameAlphabetical : 'channel_name_alphabetical… -
pushTriggerOptionEnumMap
→ const Map<
PushTriggerOption, String> -
<PushTriggerOption, String>{PushTriggerOption.all : 'all', PushTriggerOption.off : 'off', PushTriggerOption.mentionOnly : 'mention_only'} -
scheduledMessageListOrderEnumMap
→ const Map<
ScheduledMessageListOrder, String> -
<ScheduledMessageListOrder, String>{ScheduledMessageListOrder.createdAt : 'created_at', ScheduledMessageListOrder.scheduledAt : 'scheduled_at'} -
unreadItemKeyEnumMap
→ const Map<
UnreadItemKey, String> -
<UnreadItemKey, String>{UnreadItemKey.nonSuperGroupChannelUnreadMessageCount : 'non_super_group_channel_unread_message_count', UnreadItemKey.superGroupChannelUnreadMessageCount : 'su…
Functions
-
channelEventValueOf(
int value) → ChannelEventCategory -
enumDecode<
T> (Map< T, dynamic> enumValues, dynamic source, {required T unknownValue}) → T -
getFileExtension(
String fileName) → String -
groupChannelSuperFilterEnum(
SuperChannelFilter filter) → String -
memberStateFilterEnumForGroupCount(
MemberStateFilter filter) → String -
memberStateFilterEnumForQuery(
MemberStateFilter filter) → String -
pushTokenToString(
PushTokenType type) → String? -
stringFromSearchFields(
List< GroupChannelListQuerySearchField> fields) → List<String> -
userEventValueOf(
int value) → UserEventCategory
Enums
- ChannelEventCategory
- Represents channel event that comes from socket
- ChannelHiddenStateFilter
- Represents a filter for channel's visibility state
- ChannelQueryIncludeOption
- Represents option to filter channel
- ChannelType
- Represents the type of channel
- ConnectionEventType
- Represents sdk's connection event
- ConnectionState
- Represents sdk's connection status
- CountPreference
- Represents user's message count filter
- GroupChannelHiddenState
- Represents channel's visibility state
- GroupChannelListOrder
- Represents result order of group channel query
- GroupChannelListQuerySearchField
- Represents group channel search field
- GroupChannelListQueryType
- Defines query operational type
- GroupChannelPushTriggerOption
- Represents push trigger option for a group channel
- LogLevel
- Defines levels of logging level
- MemberListOrder
- MemberState
- Represents member state for user in a channel
- MemberStateFilter
- Represents a filter for member state
- MentionType
- Represents message's mention type
- MessageQueryIncludeOption
- MessageSearchQueryOrder
- Represents result order for message search
- MessageSendingStatus
- Represents message's sending status
- MessageType
- Represents message type
- MessageTypeFilter
- Represents a filter for message type
- MetaArrayUpdateMode
- Represents meta array update mode
- MetaCounterMode
- Represents meta counter operation mode
- MutedMemberFilter
- MuteState
- Represents user's mute state in a channel
- OperatorFilter
- PollStatus
- Represents poll status
- PublicChannelFilter
- Represents a filter for group channel visibilty
- PublicGroupChannelListOrder
- Represents result order of public group channel query
- PublicGroupChannelMembershipFilter
- Represents a filter for public group channel member state
- PushNotificationDeliveryOption
- Represents push notification delivery option
- PushTokenRegistrationStatus
- Represents push registration status
- PushTokenType
- Represents push token type
- PushTriggerOption
- Represents global push trigger option
- ReactionEventAction
- Represents reaction's operation event
- ReplyType
- Represents message's reply type
- ReportCategory
- Defines reporting category
- RestrictionType
- Role
- Represents role for user in a channel
- ScheduledMessageListOrder
- Represnts Ordering of Scheduled Message List
- ScheduledStatus
- Represents Scheduled Status
- ScheduledUserMessageStatus
- Represents scheduled user message status
- SuperChannelFilter
- Represents a filter for super group channel
- UnreadChannelFilter
- Represents a filter for unread channel
- UnreadItemKey
- Represents unread item key filter
- UserConnectionStatus
- UserEventCategory
- Represents user event that comes from socket
- UserListQueryType
- Represents a filter for user list query
Exceptions / Errors
- AckTimeoutError
- BadRequestError
- ConnectionCancelError
- ConnectionClosedError
- ConnectionFailedError
- ConnectionRequiredError
- FileSizeLimitExceededError
- InternalServerError
- InvalidAccessTokenError
- InvalidInitializationError
- InvalidParameterError
- LoginTimeoutError
- MalformedError
- MarkAsReadRateLimitExceededError
- MisConfigurationError
- NotFoundError
- OperationCancelError
- QueryInProgressError
- SBError
- SessionKeyRefreshFailedError
- SessionKeyRefreshSucceededError
- UnknownError
- UnrecognizedMessageTypeError
- UnrecognizedTypeError
- WebSocketConnectionClosedError
- WebSocketConnectionFailed
- WebSocketError
- WebSocketTimeoutError