AltibbiChat class

Constructors

AltibbiChat.new()

Properties

currentUser → User?

The current connected User. null if connect is not called.

no setter

hashCode → int

The hash code for this object.

no setter, inherited

runtimeType → Type

A representation of the runtime type of the object.

no setter, inherited

Methods

addChannelHandler(String identifier, BaseChannelHandler handler) → void

Adds a channel event handler with the specified identifier and handler.

addConnectionHandler(String identifier, ConnectionHandler handler) → void

Adds a connection event handler with the specified identifier and handler.

addExtension(String key, String version) → void

Adds an extension to the Sendbird Chat SDK.

addUserEventHandler(String identifier, UserEventHandler handler) → void

Adds a user event handler with the specified identifier and handler.

blockUser(String userId) → Future<User>

Blocks the specified User ID. Blocked User cannot send messages to the blocker.

disconnect() → Future<void>

Disconnects the current user from Sendbird Chat.

getAllEmoji() → Future<EmojiContainer>

Retrieves all the available emoji.

getAppInfo() → AppInfo?

Retrieves the information about the Sendbird application.

getApplicationId() → String?

Retrieves the Sendbird application ID.

getChannelHandler(String identifier) → BaseChannelHandler?

Retrieves the channel event handler with the specified identifier.

getChannelInvitationPreference() → Future<bool>

Retrieves the preference for automatically accepting channel invitations.

getConnectionHandler(String identifier) → ConnectionHandler?

Retrieves the connection event handler with the specified identifier.

getConnectionState() → MyConnectionState

Retrieves the connection state of the current user.

getDoNotDisturb() → Future<DoNotDisturb>

Gets Do-not-disturb option for the current User.

getEmoji(String key) → Future<Emoji>

Retrieves the emoji with the specified key.

getEmojiCategory(int categoryId) → Future<EmojiCategory>

Retrieves the emoji category with the specified ID.

getGroupChannel(Consultation consultation) → Future<GroupChannel>

getGroupChannel

getGroupChannelCount(MyMemberStateFilter filter) → Future<int>

Retrieves the count of group channels that the current user is a member of.

getLastConnectedAt() → int?

Retrieves the timestamp of the last successful connection to Sendbird Chat.

getMyGroupChannelChangeLogs(GroupChannelChangeLogsParams params, {String? token, int? timestamp}) → Future<GroupChannelChangeLogs>

Retrieves the change logs of the user's group channels.

getOptions() → SendbirdChatOptions

Retrieve the currently set options for the Sendbird Chat SDK

getPendingPushToken() → String?

Retrieves the pending push token.

getPushSound() → Future<String>

Gets push notification sound path for the current User.

getPushTemplate() → Future<String>

Gets push template option for the current User. For details of push template option, refer to setPushTemplate. This can be used, for instance, when you need to check the push notification content preview is on or off at the moment.

getPushTriggerOption() → Future<PushTriggerOption>

Retrieves the push trigger option.

getSdkVersion() → String

Retrieves the version of the sendbird Chat Sdk.

getSessionHandler() → SessionHandler?

Gets the currently set session handler.

getSnoozePeriod() → Future<SnoozePeriod>

Gets snooze period for the current User.

getSubscribedCustomTypeTotalUnreadMessageCount() → int

Retrieves the total count of unread messages for the subscribed channels with custom types.

getSubscribedCustomTypeUnreadMessageCount(String customType) → int?

Retrieves the count of unread messages for the subscribed channels with the specified custom type.

getSubscribedTotalUnreadMessageCount() → int

Retrieves the total count of unread messages for the subscribed channels.

getTotalScheduledMessageCount({TotalScheduledMessageCountParams? params}) → Future<int>

Retrieves the total count of scheduled messages.

getTotalUnreadChannelCount([GroupChannelTotalUnreadChannelCountParams? params]) → Future<int>

Retrieves the total count of unread channels for the current user.

getTotalUnreadMessageCount([GroupChannelTotalUnreadMessageCountParams? params]) → Future<int>

Retrieves the total count of unread messages for the current user.

getUnreadItemCount(List<UnreadItemKey> keys) → Future<GroupChannelUnreadItemCount>

Retrieves the count of unread items for the specified keys.

getUserEventHandler(String identifier) → UserEventHandler?

Retrieves the user event handler with the specified identifier.

init({required Consultation consultation, SendbirdChatOptions? options}) → Future<User>

Initializes the SendBird Chat Sdk with the specified appID and option.

isInitialized() → bool

Checks if the Sendbird Chat SDK is initialized.

markAsDelivered({required Map<String, dynamic> data}) → Future<void>

Marks the messages as delivered with the specified data.

markAsRead({required List<String> channelUrls}) → Future<void>

Marks the messages in the specified channels as read.

markAsReadAll() → Future<void>

Marks all messages as read in the current user's group channels.

noSuchMethod(Invocation invocation) → dynamic

Invoked when a nonexistent method or property is accessed.

inherited

reconnect() → Future<bool>

Reconnects the current user to Sendbird Chat.

registerPushToken({required PushTokenType type, required String token, bool alwaysPush = false, bool unique = false}) → Future<PushTokenRegistrationStatus>

Registers a push token for push notifications.

removeAllChannelHandlers() → void

Removes all the channel event handlers.

removeAllConnectionHandlers() → void

Removes all the connection event handlers.

removeAllUserEventHandlers() → void

Removes all the user event handlers.

removeChannelHandler(String identifier) → void

Removes the channel event handler with the specified identifier.

removeConnectionHandler(String identifier) → void

Removes the connection event handler with the specified identifier.

removeSessionHandler() → void

Removes the currently set session handler.

removeUserEventHandler(String identifier) → void

Removes the user event handler with the specified identifier.

setAppVersion(String version) → void

Sets the version of the application

setChannelInvitationPreference(bool autoAccept) → Future<void>

Sets the preference for automatically accepting channel invitations.

setDoNotDisturb({required bool enable, int startHour = 0, int startMin = 0, int endHour = 23, int endMin = 59, String timezone = 'UTC'}) → Future<void>

Sets Do-not-disturb option for the current User. If this option is enabled, the current User does not receive push notification during the specified time repeatedly. If you want to snooze specific period, use setSnoozePeriod.

setLogLevel(LogLevel level) → void

Sets the log level for the Sendbird Chat SDK.

setOptions(SendbirdChatOptions options) → void

set the option for the Sendbird Chat SDK

setPushSound(String sound) → Future<void>

Sets the push sound.

setPushTemplate(String name) → Future<void>

Sets push template option for the current User. The only valid arguments for template name are SendbirdChat.pushTemplateDefault and SendbirdChat.pushTemplateAlternative. If SendbirdChat.pushTemplateDefault is set, the push notification will contain the original message in the message field of the push notification. If SendbirdChat.pushTemplateAlternative is set, message of push notification will be replaced by the content you've set on Sendbird Dashboard.

setPushTriggerOption(PushTriggerOption option) → Future<void>

Sets the push trigger option.

setSessionHandler(SessionHandler handler) → void

Sets a handler to receive session events.

setSnoozePeriod({required bool enable, DateTime? startDate, DateTime? endDate}) → Future<void>

Sets snooze period for the current User. If this option is enabled, the current User does not receive push notification during the given period. It's not a repetitive operation. If you want to snooze repeatedly, use setDoNotDisturb.

toString() → String

A string representation of this object.

inherited

unblockUser(String userId) → Future<void>

Unblocks the specified User ID. Unblocked User cannot send messages to the ex-blocker.

unregisterPushToken({required PushTokenType type, required String token}) → Future<void>

Unregisters a push token.

unregisterPushTokenAll() → Future<void>

Unregisters all push tokens.

updateCurrentUserInfo({String? nickname, FileInfo? profileFileInfo, List<String>? preferredLanguages, ProgressHandler? progressHandler}) → Future<void>

Updates current User's information.

Operators

operator ==(Object other) → bool

The equality operator.

inherited