SendBird (Sendbird Chat SDK for Android reference)

java.lang.Object
- com.sendbird.android.SendBird

public final class SendBird
extends java.lang.Object

SendBird Main Class.

Nested Class Summary

Nested Classes
Modifier and Type	Class and Description
`static interface`	`SendBird.AddFriendsHandler` AddFriendsHandler handler.
`static class`	`SendBird.ChannelHandler` Channel handler.
`static interface`	`SendBird.ConnectHandler` Connect handler.
`static interface`	`SendBird.ConnectionHandler` Connection handler.
`static class`	`SendBird.ConnectionState` SDK connection state.
`static interface`	`SendBird.DeleteFriendDiscoveriesHandler` DeleteFriendDiscoveriesHandler handler.
`static interface`	`SendBird.DeleteFriendDiscoveryHandler` DeleteFriendDiscoveryHandler handler.
`static interface`	`SendBird.DeleteFriendHandler` DeleteFriendHandler handler.
`static interface`	`SendBird.DeleteFriendsHandler` DeleteFriendsHandler handler.
`static interface`	`SendBird.DisconnectHandler` Disconnect handler.
`static interface`	`SendBird.GetAllEmojiHandler` getAllEmoji handler.
`static interface`	`SendBird.GetChannelInvitationPreferenceHandler` GetAutoAcceptInvitation handler.
`static interface`	`SendBird.GetDoNotDisturbHandler` GetDoNotDisturb handler.
`static interface`	`SendBird.GetEmojiCategoryHandler` getEmojiCategory handler.
`static interface`	`SendBird.GetEmojiHandler` getEmoji handler.
`static interface`	`SendBird.GetFriendChangeLogsByTokenHandler` GetFriendChangeLogsByTokenHandler handler.
`static interface`	`SendBird.GetMyGroupChannelChangeLogsHandler` GetMyGroupChannelChangeLogsHandler handler.
`static interface`	`SendBird.GetPushSoundHandler` GetPushSound handler.
`static interface`	`SendBird.GetPushTemplateHandler` GetPushTemplate handler.
`static interface`	`SendBird.GetPushTokensHandler` GetPushTokens handler.
`static interface`	`SendBird.GetPushTriggerOptionHandler` GetPushTriggerOptionHandler handler.
`static interface`	`SendBird.GetSnoozePeriodHandler` GetSnoozePeriodHandler handler.
`static class`	`SendBird.HMS` Push token related class specifically for Huawei Message Service, HMS.
`static interface`	`SendBird.MarkAsReadHandler` GroupChannelMarkAsRead handler.
`static class`	`SendBird.Options` Represents operation options.
`static class`	`SendBird.PushTokenRegistrationStatus` Status of push token registration.
`static class`	`SendBird.PushTokenType` PushTokenType.
`static class`	`SendBird.PushTriggerOption` PushTriggerOption of the current `User`.
`static interface`	`SendBird.RegisterPushTokenHandler` Deprecated. As of 3.0.2, replaced by `SendBird.RegisterPushTokenWithStatusHandler`.
`static interface`	`SendBird.RegisterPushTokenWithStatusHandler` RegisterPushTokenWithStatus handler.
`static interface`	`SendBird.SetChannelInvitationPreferenceHandler` SetAutoAcceptInvitation handler.
`static interface`	`SendBird.SetDoNotDisturbHandler` SetDoNotDisturb handler.
`static interface`	`SendBird.SetPushSoundHandler` SetPushSound handler.
`static interface`	`SendBird.SetPushTemplateHandler` SetPushTemplate handler.
`static interface`	`SendBird.SetPushTriggerOptionHandler` SetPushTriggerOptionHandler handler.
`static interface`	`SendBird.SetSnoozePeriodHandler` SetSnoozePeriodHandler handler.
`static interface`	`SendBird.UnregisterPushTokenHandler` UnregisterPushToken handler.
`static interface`	`SendBird.UploadFriendDiscoveriesHandler` UploadFriendDiscoveriesHandler handler.
`static interface`	`SendBird.UserBlockHandler` UserBlock handler.
`static class`	`SendBird.UserEventHandler` User event handler.
`static interface`	`SendBird.UserInfoUpdateHandler` UserInfoUpdate handler.
`static interface`	`SendBird.UserUnblockHandler` UserUnblock handler.

Field Summary

Fields
Modifier and Type	Field and Description
`static int`	`LOGGER_INFO`
`static int`	`LOGGER_NONE`
`static java.lang.String`	`PUSH_TEMPLATE_ALTERNATIVE` Value for `setPushTemplate(String, SetPushTemplateHandler)`, `setPushTemplate(String, SetPushTemplateHandler)`.
`static java.lang.String`	`PUSH_TEMPLATE_DEFAULT` Value for `setPushTemplate(String, SetPushTemplateHandler)`, `setPushTemplate(String, SetPushTemplateHandler)`.

Method Summary

All Methods Static Methods Concrete Methods Deprecated Methods
Modifier and Type	Method and Description
`static void`	`addChannelHandler(java.lang.String identifier, SendBird.ChannelHandler handler)` Adds a channel handler.
`static void`	`addConnectionHandler(java.lang.String identifier, SendBird.ConnectionHandler handler)` Adds a connection handler.
`static void`	`addExtension(java.lang.String key, java.lang.String version)` To send additional User-Agent information please set the version information.
`static void`	`addFriends(java.util.List<java.lang.String> userIds, SendBird.AddFriendsHandler handler)` Add friends.
`static void`	`addUserEventHandler(java.lang.String identifier, SendBird.UserEventHandler handler)` Adds a user event handler.
`static void`	`allowFriendDiscovery(boolean allow, AllowFriendDiscoveryHandler handler)` Sets friend discoverability of current user.
`static void`	`blockUser(User userToBlock, SendBird.UserBlockHandler handler)` Blocks the specified `User`.
`static void`	`blockUserWithUserId(java.lang.String userIdToBlock, SendBird.UserBlockHandler handler)` Blocks the specified `User` ID.
`static void`	`clearCachedData(android.content.Context context, CompletionHandler handler)` Clears the db data used in local caching.
`static void`	`clearCachedMessages(java.lang.String channelUrl, CompletionHandler handler)` Clear cached messages of specific channel.
`static void`	`connect(java.lang.String userId, SendBird.ConnectHandler handler)` Connects to SendBird with given `User` ID.
`static void`	`connect(java.lang.String userId, java.lang.String accessToken, SendBird.ConnectHandler handler)` Connects to SendBird with given `User` ID and access token.
`static void`	`connect(java.lang.String userId, java.lang.String accessToken, java.lang.String apiHost, java.lang.String wsHost, SendBird.ConnectHandler handler)` Connects to SendBird with given `User` ID and access token.
`static ApplicationUserListQuery`	`createApplicationUserListQuery()` Creates a query instance to get the whole `User` list.
`static BlockedUserListQuery`	`createBlockedUserListQuery()` Creates a query instance to get only the blocked `User` (by me) list.
`static FriendListQuery`	`createFriendListQuery()` Creates a query instance to get friends.
`static UserListQuery`	`createUserListQuery()` Deprecated. As of 3.0.81, replaced by `createApplicationUserListQuery()`.
`static UserListQuery`	`createUserListQuery(java.util.List<java.lang.String> userIds)` Deprecated. As of 3.0.81, replaced by `createApplicationUserListQuery()` with `ApplicationUserListQuery.setUserIdsFilter(List)`.
`static void`	`deleteFriend(java.lang.String userId, SendBird.DeleteFriendHandler handler)` Delete friend.
`static void`	`deleteFriendDiscoveries(java.util.List<java.lang.String> discoveryKeys, SendBird.DeleteFriendDiscoveriesHandler handler)` Delete friend discoveries.
`static void`	`deleteFriendDiscovery(java.lang.String discoveryKey, SendBird.DeleteFriendDiscoveryHandler handler)` Delete friend discovery.
`static void`	`deleteFriends(java.util.List<java.lang.String> userIds, SendBird.DeleteFriendsHandler handler)` Delete friends.
`static void`	`disconnect(SendBird.DisconnectHandler handler)` Disconnects from SendBird.
`static void`	`disconnectWebSocket(SendBird.DisconnectHandler handler)` Disconnects the websocket connection only.
`static void`	`getAllEmoji(SendBird.GetAllEmojiHandler handler)` Requests the all emoji.
`static void`	`getAllowFriendDiscovery(GetAllowFriendDiscoveryHandler handler)` Gets friend discoverability of current user.
`static AppInfo`	`getAppInfo()` Returns obtain information on the set application settings.
`static java.lang.String`	`getApplicationId()` Returns current application ID.
`static boolean`	`getAutoBackgroundDetection()` Gets SendBird auto background detection status.
`static java.lang.Long`	`getCachedDataSize(android.content.Context context)` Gets the size of cached data.
`static void`	`getChannelInvitationPreference(SendBird.GetChannelInvitationPreferenceHandler handler)` Gets the current `User`'s preference for `GroupChannel` join.
`static SendBird.ConnectionState`	`getConnectionState()` Gets SDK connection state.
`static User`	`getCurrentUser()` Gets the current `User`.
`static void`	`getDoNotDisturb(SendBird.GetDoNotDisturbHandler handler)` Gets Do-not-disturb option for the current `User`.
`static java.lang.String`	`getEkey()` Gets the key to authenticate the url retrieved from `FileMessage.getPlainUrl()`, `User.getPlainProfileImageUrl()` and `FileMessage.Thumbnail.getPlainUrl()`.
`static void`	`getEmoji(java.lang.String key, SendBird.GetEmojiHandler handler)` Requests the emoji.
`static void`	`getEmojiCategory(long emojiCategoryId, SendBird.GetEmojiCategoryHandler handler)` Requests the emoji category.
`static void`	`getFriendChangeLogsByToken(java.lang.String token, SendBird.GetFriendChangeLogsByTokenHandler handler)` Get friend changelogs by token.
`static void`	`getGroupChannelCount(GroupChannelListQuery.MemberStateFilter memberStateFilter, GroupChannel.GroupChannelChannelCountHandler handler)` Gets the number of my `GroupChannel`s.
`static long`	`getLastConnectedAt()` Gets the last connected timestamp.
`static void`	`getMyGroupChannelChangeLogsByTimestamp(long ts, java.util.List<java.lang.String> customTypes, boolean includeEmpty, SendBird.GetMyGroupChannelChangeLogsHandler handler)` Deprecated. As of 3.0.131, replaced by `getMyGroupChannelChangeLogsByTimestampWithParams(long, GroupChannelChangeLogsParams, GetMyGroupChannelChangeLogsHandler)`.
`static void`	`getMyGroupChannelChangeLogsByTimestamp(long ts, java.util.List<java.lang.String> customTypes, SendBird.GetMyGroupChannelChangeLogsHandler handler)` Deprecated. As of 3.0.131, replaced by `getMyGroupChannelChangeLogsByTimestampWithParams(long, GroupChannelChangeLogsParams, GetMyGroupChannelChangeLogsHandler)`.
`static void`	`getMyGroupChannelChangeLogsByTimestampWithParams(long ts, GroupChannelChangeLogsParams params, SendBird.GetMyGroupChannelChangeLogsHandler handler)` Requests the channel changelogs after given timestamp.
`static void`	`getMyGroupChannelChangeLogsByToken(java.lang.String token, java.util.List<java.lang.String> customTypes, boolean includeEmpty, SendBird.GetMyGroupChannelChangeLogsHandler handler)` Deprecated. As of 3.0.131, replaced by `getMyGroupChannelChangeLogsByTokenWithParams(String, GroupChannelChangeLogsParams, GetMyGroupChannelChangeLogsHandler)`.
`static void`	`getMyGroupChannelChangeLogsByToken(java.lang.String token, java.util.List<java.lang.String> customTypes, SendBird.GetMyGroupChannelChangeLogsHandler handler)` Deprecated. As of 3.0.131, replaced by `getMyGroupChannelChangeLogsByTokenWithParams(String, GroupChannelChangeLogsParams, GetMyGroupChannelChangeLogsHandler)`.
`static void`	`getMyGroupChannelChangeLogsByTokenWithParams(java.lang.String token, GroupChannelChangeLogsParams params, SendBird.GetMyGroupChannelChangeLogsHandler handler)` Requests the channel changelogs from given token.
`static void`	`getMyPushTokensByToken(java.lang.String token, SendBird.PushTokenType type, SendBird.GetPushTokensHandler handler)` Requests push tokens of current user from given token.
`static boolean`	`getNetworkAwarenessReconnection()` Gets SendBird network awareness reconnection status.
`static java.lang.String`	`getOSVersion()` Returns current OS version.
`static java.lang.String`	`getPendingPushToken()` Gets the pending push token.
`static void`	`getPushSound(SendBird.GetPushSoundHandler handler)` Gets push notification sound path for the current `User`.
`static void`	`getPushTemplate(SendBird.GetPushTemplateHandler handler)` Gets push template option for the current `User`.
`static void`	`getPushTriggerOption(SendBird.GetPushTriggerOptionHandler handler)` Gets the current `User`'s push trigger option.
`static java.lang.String`	`getSDKVersion()` Returns current SDK version.
`static void`	`getSnoozePeriod(SendBird.GetSnoozePeriodHandler handler)` Gets snooze period for the current `User`.
`static int`	`getSubscribedCustomTypeTotalUnreadMessageCount()` Gets the total number of unread message of `GroupChannel`s with subscribed custom types.
`static int`	`getSubscribedCustomTypeUnreadMessageCount(java.lang.String customType)` Gets the number of unread message of `GroupChannel` with subscribed custom type.
`static int`	`getSubscribedTotalUnreadMessageCount()` Gets the subscribed total number of unread message of all `GroupChannel`s the current user has joined.
`static void`	`getTotalUnreadChannelCount(GroupChannel.GroupChannelTotalUnreadChannelCountHandler handler)` Gets the total number of unread `GroupChannel`s the current user has joined.
`static void`	`getTotalUnreadChannelCount(GroupChannelTotalUnreadChannelCountParams params, GroupChannel.GroupChannelTotalUnreadChannelCountHandler handler)` Gets the total number of unread `GroupChannel`s the current user has joined.
`static void`	`getTotalUnreadMessageCount(GroupChannel.GroupChannelTotalUnreadMessageCountHandler handler)` Gets the total number of unread message of all `GroupChannel`s the current user has joined.
`static void`	`getTotalUnreadMessageCount(GroupChannelTotalUnreadMessageCountParams params, GroupChannel.GroupChannelTotalUnreadMessageCountHandler handler)` Gets the total number of unread message of `GroupChannel`s with `GroupChannelTotalUnreadMessageCountParams` filter.
`static void`	`getTotalUnreadMessageCount(java.util.List<java.lang.String> channelCustomTypes, GroupChannel.GroupChannelTotalUnreadMessageCountHandler handler)` Gets the total number of unread message of `GroupChannel`s with channel custom types filter.
`static void`	`getUnreadItemCount(java.util.Collection<GroupChannel.UnreadItemKey> keys, GroupChannel.GroupChannelGetUnreadItemCountHandler handler)` Gets the unread item count of `GroupChannel`s from keys.
`static boolean`	`init(java.lang.String appId, android.content.Context context)` Deprecated. As of 3.1.0, replaced by `init(String, Context, boolean, InitResultHandler)`.
`static void`	`init(java.lang.String appId, android.content.Context context, boolean useCaching, InitResultHandler handler)` Initializes SendBird with given app ID.
`static boolean`	`initFromForeground(java.lang.String appId, android.content.Context context)` Deprecated. As of 3.1.0, replaced by `initFromForeground(String, Context, boolean, InitResultHandler)`.
`static void`	`initFromForeground(java.lang.String appId, android.content.Context context, boolean useCaching, InitResultHandler handler)` Initializes SendBird with given app ID.
`static boolean`	`isUsingLocalCaching()` Returns whether the app uses local caching.
`static void`	`markAsDelivered(java.util.Map<java.lang.String,java.lang.String> data)` Sends mark as delivered to this channel when you received push message from us.
`static void`	`markAsDelivered(java.lang.String channelUrl)` Deprecated. As of 3.0.150, replaced by `markAsDelivered(Map)`.
`static void`	`markAsReadAll(SendBird.MarkAsReadHandler handler)` Sends mark as read to all joined `GroupChannel`s.
`static void`	`markAsReadWithChannelUrls(java.util.List<java.lang.String> channelUrls, SendBird.MarkAsReadHandler handler)` Sends mark as read to joined `GroupChannel`s.
`static void`	`notifyActivityPausedForOldAndroids()` Deprecated. As of 3.0.136, if you set `setAutoBackgroundDetection(boolean)` to `true`, you do not need to call this function manually.
`static void`	`notifyActivityResumedForOldAndroids()` Deprecated. As of 3.0.136, if you set `setAutoBackgroundDetection(boolean)` to `true`, you do not need to call this function manually.
`static boolean`	`reconnect()` Tries reconnection with previously and successfully connected user information.
`static void`	`registerPushTokenForCurrentUser(java.lang.String gcmRegToken, boolean unique, SendBird.RegisterPushTokenWithStatusHandler handler)` Registers push token for the current `User` to receive push notification.
`static void`	`registerPushTokenForCurrentUser(java.lang.String gcmRegToken, SendBird.RegisterPushTokenHandler handler)` Deprecated. As of 3.0.2, replaced by `registerPushTokenForCurrentUser(String, RegisterPushTokenWithStatusHandler)`.
`static void`	`registerPushTokenForCurrentUser(java.lang.String gcmRegToken, SendBird.RegisterPushTokenWithStatusHandler handler)` Registers push token for the current `User` to receive push notification.
`static void`	`removeAllChannelHandlers()` Removes all channel handlers added by `addChannelHandler(String, ChannelHandler)`.
`static void`	`removeAllConnectionHandlers()` Removes all connection handlers added by `addConnectionHandler(String, ConnectionHandler)`.
`static void`	`removeAllUserEventHandlers()` Removes all user event handlers added by `addUserEventHandler(String, UserEventHandler)`.
`static SendBird.ChannelHandler`	`removeChannelHandler(java.lang.String identifier)` Removes a channel handler.
`static SendBird.ConnectionHandler`	`removeConnectionHandler(java.lang.String identifier)` Removes a connection handler.
`static SendBird.UserEventHandler`	`removeUserEventHandler(java.lang.String identifier)` Removes a user event handler.
`static void`	`runOnUIThread(java.lang.Runnable runnable)`
`static void`	`setAppVersion(java.lang.String version)` Sets the app version.
`static void`	`setAutoBackgroundDetection(boolean enable)` Sets SendBird to detect if the `Application` is in background automatically.
`static void`	`setChannelInvitationPreference(boolean autoAccept, SendBird.SetChannelInvitationPreferenceHandler handler)` Sets the current `User`'s preference for `GroupChannel` join.
`static void`	`setDoNotDisturb(boolean doNotDisturbOn, int startHour, int startMin, int endHour, int endMin, java.lang.String timezone, SendBird.SetDoNotDisturbHandler handler)` Sets Do-not-disturb option for the current `User`.
`static void`	`setLoggerLevel(int level)` Sets logger level.
`static void`	`setLoggerLevel(LogLevel logLevel)` As of 3.0.153, Sets the logger level for server request/response related logs.
`static void`	`setNetworkAwarenessReconnection(boolean enable)` Sets SendBird to reconnect automatically by network awareness.
`static void`	`setPushSound(java.lang.String sound, SendBird.SetPushSoundHandler handler)` Sets the push notification sound file path for the current `User`.
`static void`	`setPushTemplate(java.lang.String templateName, SendBird.SetPushTemplateHandler handler)` Sets push template option for the current `User`.
`static void`	`setPushTriggerOption(SendBird.PushTriggerOption pushTriggerOption, SendBird.SetPushTriggerOptionHandler handler)` Sets the current `User`'s push trigger option.
`static void`	`setSessionHandler(SessionHandler sessionHandler)` Set a `SessionHandler` which is required for SDK refresh the session when the current session expires.
`static void`	`setSnoozePeriod(boolean snoozeOn, long startTs, long endTs, SendBird.SetSnoozePeriodHandler handler)` Sets snooze period for the current `User`.
`static void`	`unblockUser(User blockedUser, SendBird.UserUnblockHandler handler)` Unblocks the specified `User`.
`static void`	`unblockUserWithUserId(java.lang.String blockedUserId, SendBird.UserUnblockHandler handler)` Unblocks the specified `User` ID.
`static void`	`unregisterPushTokenAllForCurrentUser(SendBird.UnregisterPushTokenHandler handler)` Unregisters all push token bound to the current `User`.
`static void`	`unregisterPushTokenForCurrentUser(java.lang.String gcmRegToken, SendBird.UnregisterPushTokenHandler handler)` Unregisters push token for the current `User`.
`static void`	`updateCurrentUserInfo(java.util.List<java.lang.String> preferredLanguages, SendBird.UserInfoUpdateHandler handler)` Updates current `User`'s information.
`static void`	`updateCurrentUserInfo(java.lang.String nickname, java.lang.String profileUrl, SendBird.UserInfoUpdateHandler handler)` Updates current `User`'s information.
`static void`	`updateCurrentUserInfoWithProfileImage(java.lang.String nickname, java.io.File profileImage, SendBird.UserInfoUpdateHandler handler)` Updates current `User`'s information.
`static void`	`uploadFriendDiscoveries(java.util.Map<java.lang.String,java.lang.String> discoveryMap, SendBird.UploadFriendDiscoveriesHandler handler)` Upload friend discoveries.

Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - LOGGER_NONE
```
public static final int LOGGER_NONE
```
    See Also:
    
    Constant Field Values
  - LOGGER_INFO
```
public static final int LOGGER_INFO
```
    See Also:
    
    Constant Field Values
  - PUSH_TEMPLATE_DEFAULT
```
public static final java.lang.String PUSH_TEMPLATE_DEFAULT
```
    Value for setPushTemplate(String, SetPushTemplateHandler), setPushTemplate(String, SetPushTemplateHandler).
    
    Since:
    
    3.0.12
    
    See Also:
    
    Constant Field Values
  - PUSH_TEMPLATE_ALTERNATIVE
```
public static final java.lang.String PUSH_TEMPLATE_ALTERNATIVE
```
    Value for setPushTemplate(String, SetPushTemplateHandler), setPushTemplate(String, SetPushTemplateHandler).
    
    Since:
    
    3.0.12
    
    See Also:
    
    Constant Field Values
- Method Detail
  - addExtension
```
public static void addExtension(java.lang.String key,
                                java.lang.String version)
```
    To send additional User-Agent information please set the version information. This will be set pre-defined keys only.
    
    Parameters:
    
    key - KEY of value you want to send.
    
    version - a value you want to send.
    
    Since:
    
    3.0.127
  - runOnUIThread
```
public static void runOnUIThread(java.lang.Runnable runnable)
```
  - getOSVersion
```
public static java.lang.String getOSVersion()
```
    Returns current OS version.
    
    Returns:
    
    OS version.
  - getSDKVersion
```
public static java.lang.String getSDKVersion()
```
    Returns current SDK version.
    
    Returns:
    
    SDK version.
  - getApplicationId
```
public static java.lang.String getApplicationId()
```
    Returns current application ID.
    
    Returns:
    
    Application ID.
  - setLoggerLevel
```
public static void setLoggerLevel(int level)
```
    Sets logger level.
    
    Parameters:
    
    level - Level of logger. LOGGER_NONE or LOGGER_INFO can be assigned.
  - setLoggerLevel
```
public static void setLoggerLevel(LogLevel logLevel)
```
    As of 3.0.153, Sets the logger level for server request/response related logs. The scope of the log is subject to change.
    
    Parameters:
    
    logLevel - desired log level. When set to LogLevel.VERBOSE, all logs will be printed. When set to LogLevel.ERROR, only error logs will be printed.
    
    Since:
    
    3.0.153
    
    See Also:
    
    LogLevel
  - setAppVersion
```
public static void setAppVersion(java.lang.String version)
```
    Sets the app version. It's recommended to set the app version right after init(String, Context, boolean, InitResultHandler).
    
    Parameters:
    
    version - The version of the app.
    
    Since:
    
    3.1.5
  - init
```
public static void init(java.lang.String appId,
                        android.content.Context context,
                        boolean useCaching,
                        InitResultHandler handler)
```
    Initializes SendBird with given app ID.
    
    Parameters:
    
    appId - Application ID which you can get by creating the application at SendBird Dashboard.
    Refer to SendBird Docs for further details.
    
    context - Context of Application.
    
    useCaching - Determine whether to use database in the SDK.
    
    handler - Handler to receive SendBird.init function call processing results. Application ID can be changed by calling this with different application IDs. Notice that only on CLOSED connection status application ID can be modified.
    
    Since:
    
    3.1.0
  - clearCachedData
```
public static void clearCachedData(android.content.Context context,
                                   CompletionHandler handler)
```
    Clears the db data used in local caching. If local caching is enabled, this should be called before init(String, Context, boolean, InitResultHandler) or initFromForeground(String, Context, boolean, InitResultHandler).
    
    Parameters:
    
    context - Context.
    
    Since:
    
    3.1.0
    
    See Also:
    
    init(String, Context, boolean, InitResultHandler)., initFromForeground(String, Context, boolean, InitResultHandler).
  - clearCachedMessages
```
public static void clearCachedMessages(java.lang.String channelUrl,
                                       CompletionHandler handler)
```
    Clear cached messages of specific channel.
    
    Parameters:
    
    channelUrl - target channel's url
    
    Since:
    
    3.1.0
    
    See Also:
    
    clearCachedData(Context, CompletionHandler)
  - getCachedDataSize
```
public static java.lang.Long getCachedDataSize(android.content.Context context)
```
    Gets the size of cached data. If local caching is not used, return 0 If you want to clear all cached data, call clearCachedData(Context, CompletionHandler) If you want to clear specific channel's cache, call clearCachedMessages(String, CompletionHandler)
    
    Parameters:
    
    context - Context.
    
    Returns:
    
    the size of cache data in bytes. returns 0 if local caching is not used
    
    Since:
    
    3.1.0
    
    See Also:
    
    clearCachedData(Context, CompletionHandler), clearCachedMessages(String, CompletionHandler)
  - init
```
@Deprecated
public static boolean init(java.lang.String appId,
                                       android.content.Context context)
```
    Deprecated. As of 3.1.0, replaced by init(String, Context, boolean, InitResultHandler).
    
    Initializes SendBird with given app ID.
    
    Parameters:
    
    appId - Application ID which you can get by creating the application at SendBird Dashboard.
    Refer to SendBird Docs for further details.
    
    context - Context of Application.
    
    Returns:
    
    Returns true if the initialization succeeded. Otherwise, false. Application ID can be changed by calling this with different application IDs. Notice that only on CLOSED connection status application ID can be modified and it will return false if you try to change application ID while in OPEN connection status.
  - initFromForeground
```
@Deprecated
public static boolean initFromForeground(java.lang.String appId,
                                                     android.content.Context context)
```
    Deprecated. As of 3.1.0, replaced by initFromForeground(String, Context, boolean, InitResultHandler).
    
    Initializes SendBird with given app ID. It will set the application state to FOREGROUND.
    
    Parameters:
    
    appId - Application ID which you can get by creating the application at SendBird Dashboard.
    Refer to SendBird Docs for further details.
    
    context - Context of Application.
    
    Returns:
    
    Returns true if the initialization succeeded. Otherwise, false. Application ID can be changed by calling this with different application IDs. Notice that only on CLOSED connection status application ID can be modified and it will return false if you try to change application ID while in OPEN connection status.
    
    Since:
    
    3.0.149
  - initFromForeground
```
public static void initFromForeground(java.lang.String appId,
                                      android.content.Context context,
                                      boolean useCaching,
                                      InitResultHandler handler)
```
    Initializes SendBird with given app ID. It will set the application state to FOREGROUND.
    
    Parameters:
    
    appId - Application ID which you can get by creating the application at SendBird Dashboard.
    Refer to SendBird Docs for further details.
    
    context - Context of Application.
    
    useCaching - Determine whether to use local caching in the SDK.
    
    handler - Handler to receive SendBird.init function call processing results. Application ID can be changed by calling this with different application IDs. Notice that only on CLOSED connection status application ID can be modified.
    
    Since:
    
    3.1.0
  - isUsingLocalCaching
```
public static boolean isUsingLocalCaching()
```
    Returns whether the app uses local caching.
    
    Returns:
    
    whether the app uses local caching, or not.
    
    Since:
    
    3.1.0
  - notifyActivityResumedForOldAndroids
```
@Deprecated
public static void notifyActivityResumedForOldAndroids()
```
    Deprecated. As of 3.0.136, if you set setAutoBackgroundDetection(boolean) to true, you do not need to call this function manually.
    
    Notifies SendBird of the current Activity being started.
    This MUST be called on every Activity#onResume() in the application, so that it can receive push notifications (GCM).
    If the application runs only above Android 4.0, this method can be ignored.
    
    Since:
    
    3.0.2
  - notifyActivityPausedForOldAndroids
```
@Deprecated
public static void notifyActivityPausedForOldAndroids()
```
    Deprecated. As of 3.0.136, if you set setAutoBackgroundDetection(boolean) to true, you do not need to call this function manually.
    
    Notifies SendBird of the current Activity being paused.
    This MUST be called on every Activity#onPause() in the application, so that it can receive push notifications (GCM).
    If the application runs only above Android 4.0, this method can be ignored.
    
    Since:
    
    3.0.2
  - setAutoBackgroundDetection
```
public static void setAutoBackgroundDetection(boolean enable)
```
    Sets SendBird to detect if the Application is in background automatically.
    SendBird by default tracks the Application state by being notified Activity#onResume() and Activity#onPause() event in the Application.
    This enables connection is automatically made or closed when Application goes foreground or background respectively. This auto-detection renders Application can receive push notifications (FCM) without calling disconnect(DisconnectHandler) explicitly.
    
    You can be notified when your Application goes foreground and connection is reestablished with SendBird.ConnectionHandler.onReconnectSucceeded() callback (refer to SendBird.ConnectionHandler and addConnectionHandler(String, ConnectionHandler)).
    
    If you want the Application not to act like in background so connection to still open, for instance when you start external gallery Activity to send photos from you Application, set this as false with such as Activity.startActivityForResult(Intent, int) call and then set true again at Activity#onResume().
    
    Parameters:
    
    enable - If true, automatic Application state tracking is on. It is true by default.
    
    Since:
    
    3.0.2
  - getAutoBackgroundDetection
```
public static boolean getAutoBackgroundDetection()
```
    Gets SendBird auto background detection status. For details, refer to setAutoBackgroundDetection(boolean).
    
    Returns:
    
    true if auto background detection is on.
    
    Since:
    
    3.0.2
  - setNetworkAwarenessReconnection
```
public static void setNetworkAwarenessReconnection(boolean enable)
```
    Sets SendBird to reconnect automatically by network awareness.
    
    Parameters:
    
    enable - If true, the reconnection by network awareness is on. It is true by default.
    
    Since:
    
    3.0.37
  - getNetworkAwarenessReconnection
```
public static boolean getNetworkAwarenessReconnection()
```
    Gets SendBird network awareness reconnection status. For details, refer to setNetworkAwarenessReconnection(boolean).
    
    Returns:
    
    true if network awareness reconnection is on.
    
    Since:
    
    3.0.37
  - getConnectionState
```
public static SendBird.ConnectionState getConnectionState()
```
    Gets SDK connection state.
    
    Returns:
    
    SDK connection state.
  - connect
```
public static void connect(java.lang.String userId,
                           SendBird.ConnectHandler handler)
```
    Connects to SendBird with given User ID. If you have created Users with access token, refer to connect(String, String, ConnectHandler).
    Even though User is not created by Platform API, this method creates one and calls callback to return it.
    
    Parameters:
    
    userId - User ID to connect with. Refer to User.getUserId().
    
    handler - Callback handler.
  - connect
```
public static void connect(java.lang.String userId,
                           java.lang.String accessToken,
                           SendBird.ConnectHandler handler)
```
    Connects to SendBird with given User ID and access token. If you have created Users without access token, refer to connect(String, ConnectHandler) or just pass access token with null.
    
    Parameters:
    
    userId - User ID to connect with. Refer to User.getUserId().
    
    accessToken - Access token. It should not be saved on the client side. Set null if not used.
    
    handler - Callback handler.
  - connect
```
public static void connect(java.lang.String userId,
                           java.lang.String accessToken,
                           java.lang.String apiHost,
                           java.lang.String wsHost,
                           SendBird.ConnectHandler handler)
```
    Connects to SendBird with given User ID and access token. If you have created Users without access token, refer to connect(String, ConnectHandler) or just pass access token with null.
    
    Parameters:
    
    userId - User ID to connect with. Refer to User.getUserId().
    
    accessToken - Access token. It should not be saved on the client side.
    
    apiHost - Custom API Host. Internal use only.
    
    wsHost - Custom WS Host. Internal use only.
    
    handler - Callback handler.
  - reconnect
```
public static boolean reconnect()
```
    Tries reconnection with previously and successfully connected user information. This can be called in SendBird.ConnectionHandler.onReconnectFailed() or where you check the device network status to let the SDK try reconnection. SendBird.ConnectionHandler.onReconnectStarted() will be called after you call this (note that it will not be called if there is previously started connection process which has not finished), and SendBird.ConnectionHandler.onReconnectFailed() or SendBird.ConnectionHandler.onReconnectSucceeded() will be called according to the connection status afterwards.
    Usually, the SDK automatically retries connection process when the network connection is lost with some backoff period. When you call this method, you can start connection process immediately.
    
    Returns:
    
    true if there is previously and successfully connected user information, false otherwise. When false is returned, please try with connect(String, ConnectHandler) or connect(String, String, ConnectHandler).
    
    Since:
    
    3.0.16
  - setSessionHandler
```
public static void setSessionHandler(SessionHandler sessionHandler)
```
    Set a SessionHandler which is required for SDK refresh the session when the current session expires. Must be set before the connection is made by connect(String, ConnectHandler), connect(String, String, ConnectHandler) or connect(String, String, String, String, ConnectHandler).
    
    Parameters:
    
    sessionHandler - SessionHandler to handle session related events.
    
    Since:
    
    3.0.150
  - addChannelHandler
```
public static void addChannelHandler(java.lang.String identifier,
                                     SendBird.ChannelHandler handler)
```
    Adds a channel handler. All added handlers will be notified when events occur.
    
    Parameters:
    
    identifier - ID of handler to be added.
    
    handler - Handler to be added.
  - removeChannelHandler
```
public static SendBird.ChannelHandler removeChannelHandler(java.lang.String identifier)
```
    Removes a channel handler. The deleted handler no longer be notified.
    
    Parameters:
    
    identifier - ID of handler to be removed.
    
    Returns:
    
    The removed handler.
  - removeAllChannelHandlers
```
public static void removeAllChannelHandlers()
```
    Removes all channel handlers added by addChannelHandler(String, ChannelHandler).
    
    Since:
    
    3.0.16
  - addUserEventHandler
```
public static void addUserEventHandler(java.lang.String identifier,
                                       SendBird.UserEventHandler handler)
```
    Adds a user event handler. All added handlers will be notified when events occur.
    
    Parameters:
    
    identifier - ID of handler to be added.
    
    handler - Handler to be added.
    
    Since:
    
    3.0.47
  - removeUserEventHandler
```
public static SendBird.UserEventHandler removeUserEventHandler(java.lang.String identifier)
```
    Removes a user event handler. The deleted handler no longer be notified.
    
    Parameters:
    
    identifier - ID of handler to be removed.
    
    Returns:
    
    The removed handler.
    
    Since:
    
    3.0.47
  - removeAllUserEventHandlers
```
public static void removeAllUserEventHandlers()
```
    Removes all user event handlers added by addUserEventHandler(String, UserEventHandler).
    
    Since:
    
    3.0.47
  - addConnectionHandler
```
public static void addConnectionHandler(java.lang.String identifier,
                                        SendBird.ConnectionHandler handler)
```
    Adds a connection handler. All added handlers will be notified when events occurs.
    
    Parameters:
    
    identifier - ID of handler to be added.
    
    handler - Handler to be added.
  - removeConnectionHandler
```
public static SendBird.ConnectionHandler removeConnectionHandler(java.lang.String identifier)
```
    Removes a connection handler. The deleted handler no longer be notified.
    
    Parameters:
    
    identifier - ID of handler to be removed.
    
    Returns:
    
    The removed handler.
  - removeAllConnectionHandlers
```
public static void removeAllConnectionHandlers()
```
    Removes all connection handlers added by addConnectionHandler(String, ConnectionHandler).
    
    Since:
    
    3.0.16
  - disconnect
```
public static void disconnect(SendBird.DisconnectHandler handler)
```
    Disconnects from SendBird.
    
    Parameters:
    
    handler - Callback handler.
  - disconnectWebSocket
```
public static void disconnectWebSocket(SendBird.DisconnectHandler handler)
```
    Disconnects the websocket connection only. This does not clear the [currentUser] and any cached data. If you want to logout, call [disconnect].
    
    Parameters:
    
    handler - Callback handler.
    
    Since:
    
    3.1.26
    
    See Also:
    
    [disconnect]
  - getAppInfo
```
public static AppInfo getAppInfo()
```
    Returns obtain information on the set application settings.
    
    Returns:
    
    Returns current information that the application is set
    
    Since:
    
    3.0.130
  - getCurrentUser
```
public static User getCurrentUser()
```
    Gets the current User.
    
    Returns:
    
    Returns the current User. If SendBird is not connected, null is returned.
  - getLastConnectedAt
```
public static long getLastConnectedAt()
```
    Gets the last connected timestamp.
    
    Returns:
    
    Returns the last connected timestamp.
    
    Since:
    
    3.0.77
  - createUserListQuery
```
@Deprecated
public static UserListQuery createUserListQuery()
```
    Deprecated. As of 3.0.81, replaced by createApplicationUserListQuery().
    
    Creates a query instance to get the whole User list.
    
    Returns:
    
    Query to use.
  - createUserListQuery
```
@Deprecated
public static UserListQuery createUserListQuery(java.util.List<java.lang.String> userIds)
```
    Deprecated. As of 3.0.81, replaced by createApplicationUserListQuery() with ApplicationUserListQuery.setUserIdsFilter(List).
    
    Creates a query instance to get the filtered User list by User IDs.
    
    Parameters:
    
    userIds - User IDs to query.
    
    Returns:
    
    Query to use.
    
    Since:
    
    3.0.2
  - createApplicationUserListQuery
```
public static ApplicationUserListQuery createApplicationUserListQuery()
```
    Creates a query instance to get the whole User list.
    
    Returns:
    
    Query to use.
    
    Since:
    
    3.0.81
  - createBlockedUserListQuery
```
public static BlockedUserListQuery createBlockedUserListQuery()
```
    Creates a query instance to get only the blocked User (by me) list.
    
    Returns:
    
    Query to use.
  - updateCurrentUserInfoWithProfileImage
```
public static void updateCurrentUserInfoWithProfileImage(java.lang.String nickname,
                                                         java.io.File profileImage,
                                                         SendBird.UserInfoUpdateHandler handler)
```
    Updates current User's information.
    
    Parameters:
    
    nickname - Nickname to be used.
    
    profileImage - Image file to be used.
    
    handler - Callback handler.
  - updateCurrentUserInfo
```
public static void updateCurrentUserInfo(java.lang.String nickname,
                                         java.lang.String profileUrl,
                                         SendBird.UserInfoUpdateHandler handler)
```
    Updates current User's information.
    
    Parameters:
    
    nickname - Nickname to be used.
    
    profileUrl - Image URL to be used.
    
    handler - Callback handler.
  - updateCurrentUserInfo
```
public static void updateCurrentUserInfo(java.util.List<java.lang.String> preferredLanguages,
                                         SendBird.UserInfoUpdateHandler handler)
```
    Updates current User's information.
    
    Parameters:
    
    preferredLanguages - Preferred languages for push translation. Shouldn't be null.
    
    handler - Callback handler.
    
    Since:
    
    3.0.109
  - getPendingPushToken
```
public static java.lang.String getPendingPushToken()
```
    Gets the pending push token.
    
    Returns:
    
    Returns the pending push token. Returns null if there is no registration pending token.
    
    Since:
    
    3.0.2
  - registerPushTokenForCurrentUser
```
@Deprecated
public static void registerPushTokenForCurrentUser(java.lang.String gcmRegToken,
                                                               SendBird.RegisterPushTokenHandler handler)
```
    Deprecated. As of 3.0.2, replaced by registerPushTokenForCurrentUser(String, RegisterPushTokenWithStatusHandler).
    
    Registers push token for the current User to receive push notification. To enable push notification and get a token, refer to SendBird Docs.
    
    Parameters:
    
    gcmRegToken - GCM push token.
    
    handler - Callback handler.
  - registerPushTokenForCurrentUser
```
public static void registerPushTokenForCurrentUser(java.lang.String gcmRegToken,
                                                   SendBird.RegisterPushTokenWithStatusHandler handler)
```
    Registers push token for the current User to receive push notification. To enable push notification and get a token, refer to SendBird Docs.
    Push token registration succeeds only when the connection (connect(String, ConnectHandler), connect(String, String, ConnectHandler)) is made. Otherwise, callback will return with SendBird.PushTokenRegistrationStatus.PENDING status. Then, you can register push token again by calling SendBird.registerPushTokenForCurrentUser(SendBird.getPendingPushToken(), RegisterPushTokenWithStatusHandler) after the connection is done. This just adds token to the server. If you want to register this token and delete all the previous ones, refer to registerPushTokenForCurrentUser(String, boolean, RegisterPushTokenWithStatusHandler).
    
    Parameters:
    
    gcmRegToken - GCM push token.
    
    handler - Callback handler.
    
    Since:
    
    3.0.2
  - registerPushTokenForCurrentUser
```
public static void registerPushTokenForCurrentUser(java.lang.String gcmRegToken,
                                                   boolean unique,
                                                   SendBird.RegisterPushTokenWithStatusHandler handler)
```
    Registers push token for the current User to receive push notification. To enable push notification and get a token, refer to SendBird Docs.
    Push token registration succeeds only when the connection (connect(String, ConnectHandler), connect(String, String, ConnectHandler)) is made. Otherwise, callback will return with SendBird.PushTokenRegistrationStatus.PENDING status. Then, you can register push token again by calling SendBird.registerPushTokenForCurrentUser(SendBird.getPendingPushToken(), unique, RegisterPushTokenWithStatusHandler) after the connection is done.
    
    Parameters:
    
    gcmRegToken - GCM push token.
    
    unique - If true, all the previously registered token for the current User will be deleted and this token will be the unique one.
    
    handler - Callback handler.
    
    Since:
    
    3.0.11
  - unregisterPushTokenForCurrentUser
```
public static void unregisterPushTokenForCurrentUser(java.lang.String gcmRegToken,
                                                     SendBird.UnregisterPushTokenHandler handler)
```
    Unregisters push token for the current User.
    
    Parameters:
    
    gcmRegToken - GCM push token.
    
    handler - Callback handler.
  - unregisterPushTokenAllForCurrentUser
```
public static void unregisterPushTokenAllForCurrentUser(SendBird.UnregisterPushTokenHandler handler)
```
    Unregisters all push token bound to the current User.
    
    Parameters:
    
    handler - Callback handler.
  - getMyPushTokensByToken
```
public static void getMyPushTokensByToken(java.lang.String token,
                                          SendBird.PushTokenType type,
                                          SendBird.GetPushTokensHandler handler)
```
    Requests push tokens of current user from given token. The result is passed to handler.
    
    Parameters:
    
    token - Token to get next push tokens. If token is null, the result will be passed from the beginning.
    
    type - PushTokenType. Refer to SendBird.PushTokenType.
    
    handler - Callback handler.
    
    Since:
    
    3.0.92
  - setDoNotDisturb
```
public static void setDoNotDisturb(boolean doNotDisturbOn,
                                   int startHour,
                                   int startMin,
                                   int endHour,
                                   int endMin,
                                   java.lang.String timezone,
                                   SendBird.SetDoNotDisturbHandler handler)
```
    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(boolean, long, long, SetSnoozePeriodHandler).
    
    Parameters:
    
    doNotDisturbOn - Enables option or not.
    
    startHour - Start hour (0~23).
    
    startMin - Start minute (0~59).
    
    endHour - End hour (0~23).
    
    endMin - End minute (0~59).
    
    timezone - Timezone. TimeZone.getID() can be used to get the current timezone.
    
    handler - Callback handler.
    
    Since:
    
    3.0.2
  - getDoNotDisturb
```
public static void getDoNotDisturb(SendBird.GetDoNotDisturbHandler handler)
```
    Gets Do-not-disturb option for the current User.
    
    Parameters:
    
    handler - Callback handler.
    
    Since:
    
    3.0.2
  - setSnoozePeriod
```
public static void setSnoozePeriod(boolean snoozeOn,
                                   long startTs,
                                   long endTs,
                                   SendBird.SetSnoozePeriodHandler handler)
```
    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(boolean, int, int, int, int, String, SetDoNotDisturbHandler).
    
    Parameters:
    
    snoozeOn - Enables option or not.
    
    startTs - Start timestamp of snooze period
    
    endTs - End timestamp of snooze period
    
    handler - Callback handler.
    
    Since:
    
    3.0.86
  - getSnoozePeriod
```
public static void getSnoozePeriod(SendBird.GetSnoozePeriodHandler handler)
```
    Gets snooze period for the current User.
    
    Parameters:
    
    handler - Callback handler.
    
    Since:
    
    3.0.86
  - setPushSound
```
public static void setPushSound(java.lang.String sound,
                                SendBird.SetPushSoundHandler handler)
```
    Sets the push notification sound file path for the current User. This setting will be delivered on push notification payload.
    
    Parameters:
    
    sound - Sound file path.
    
    handler - Callback handler.
    
    Since:
    
    3.0.29
  - getPushSound
```
public static void getPushSound(SendBird.GetPushSoundHandler handler)
```
    Gets push notification sound path for the current User.
    
    Parameters:
    
    handler - Callback handler.
    
    Since:
    
    3.0.29
  - setPushTemplate
```
public static void setPushTemplate(java.lang.String templateName,
                                   SendBird.SetPushTemplateHandler handler)
```
    Sets push template option for the current User. The only valid arguments for template name are PUSH_TEMPLATE_DEFAULT and PUSH_TEMPLATE_ALTERNATIVE. If PUSH_TEMPLATE_DEFAULT is set, the push notification will contain the original message in the message field of the push notification. If PUSH_TEMPLATE_ALTERNATIVE is set, message of push notification will be replaced by the content you've set on SendBird Dashboard.
    
    Parameters:
    
    templateName - Name of template to be applied to current User.
    
    handler - Callback handler.
    
    Since:
    
    3.0.12
  - getPushTemplate
```
public static void getPushTemplate(SendBird.GetPushTemplateHandler handler)
```
    Gets push template option for the current User. For details of push template option, refer to setPushTemplate(String, SetPushTemplateHandler). This can be used, for instance, when you need to check the push notification content preview is on or off at the moment.
    
    Parameters:
    
    handler - Callback handler.
    
    Since:
    
    3.0.12
  - setPushTriggerOption
```
public static void setPushTriggerOption(SendBird.PushTriggerOption pushTriggerOption,
                                        SendBird.SetPushTriggerOptionHandler handler)
```
    Sets the current User's push trigger option. If certain channel's push trigger option is set to GroupChannel.PushTriggerOption.DEFAULT, it works according to the state of SendBird.PushTriggerOption. If not, push messages will be triggered according to the state of GroupChannel.PushTriggerOption. Refer to GroupChannel.PushTriggerOption.
    
    Parameters:
    
    pushTriggerOption - PushTriggerOption. Refer to SendBird.PushTriggerOption.
    
    handler - Callback handler.
    
    Since:
    
    3.0.86
  - getPushTriggerOption
```
public static void getPushTriggerOption(SendBird.GetPushTriggerOptionHandler handler)
```
    Gets the current User's push trigger option. Refer to SendBird.PushTriggerOption. For details of push trigger option, refer to setPushTriggerOption(PushTriggerOption, SetPushTriggerOptionHandler).
    
    Parameters:
    
    handler - Callback handler.
    
    Since:
    
    3.0.86
  - setChannelInvitationPreference
```
public static void setChannelInvitationPreference(boolean autoAccept,
                                                  SendBird.SetChannelInvitationPreferenceHandler handler)
```
    Sets the current User's preference for GroupChannel join. If this is set as true, the User will automatically join the GroupChannel. If set as false, the User can join the GroupChannel by calling GroupChannel.acceptInvitation(GroupChannel.GroupChannelAcceptInvitationHandler) or decline the invitation by calling GroupChannel.declineInvitation(GroupChannel.GroupChannelDeclineInvitationHandler).
    
    Parameters:
    
    autoAccept - GroupChannel invitation auto-acceptance preference.
    
    handler - Callback handler.
    
    Since:
    
    3.0.30
  - getChannelInvitationPreference
```
public static void getChannelInvitationPreference(SendBird.GetChannelInvitationPreferenceHandler handler)
```
    Gets the current User's preference for GroupChannel join. If this is set as true, the User will automatically join the GroupChannel. If set as false, the User can join the GroupChannel by calling GroupChannel.acceptInvitation(GroupChannel.GroupChannelAcceptInvitationHandler) or decline the invitation by calling GroupChannel.declineInvitation(GroupChannel.GroupChannelDeclineInvitationHandler).
    
    Parameters:
    
    handler - Callback handler.
    
    Since:
    
    3.0.30
  - blockUser
```
public static void blockUser(User userToBlock,
                             SendBird.UserBlockHandler handler)
```
    Blocks the specified User. Blocked User cannot send messages to the blocker.
    
    Parameters:
    
    userToBlock - User to block.
    
    handler - Callback handler.
  - blockUserWithUserId
```
public static void blockUserWithUserId(java.lang.String userIdToBlock,
                                       SendBird.UserBlockHandler handler)
```
    Blocks the specified User ID. Blocked User cannot send messages to the blocker.
    
    Parameters:
    
    userIdToBlock - User ID to block.
    
    handler - Callback handler.
  - unblockUser
```
public static void unblockUser(User blockedUser,
                               SendBird.UserUnblockHandler handler)
```
    Unblocks the specified User. Unblocked User can send messages to the ex-blocker.
    
    Parameters:
    
    blockedUser - User to unblock.
    
    handler - Callback handler.
  - unblockUserWithUserId
```
public static void unblockUserWithUserId(java.lang.String blockedUserId,
                                         SendBird.UserUnblockHandler handler)
```
    Unblocks the specified User ID. Unblocked User cannot send messages to the ex-blocker.
    
    Parameters:
    
    blockedUserId - User ID to unblock.
    
    handler - Callback handler.
  - addFriends
```
public static void addFriends(java.util.List<java.lang.String> userIds,
                              SendBird.AddFriendsHandler handler)
```
    Add friends.
    
    Parameters:
    
    userIds - User IDs to add friends.
    
    handler - Callback handler.
    
    Since:
    
    3.0.47
  - deleteFriends
```
public static void deleteFriends(java.util.List<java.lang.String> userIds,
                                 SendBird.DeleteFriendsHandler handler)
```
    Delete friends.
    
    Parameters:
    
    userIds - User IDs to delete friends.
    
    handler - Callback handler.
    
    Since:
    
    3.0.47
  - deleteFriend
```
public static void deleteFriend(java.lang.String userId,
                                SendBird.DeleteFriendHandler handler)
```
    Delete friend.
    
    Parameters:
    
    userId - User ID to delete friend.
    
    handler - Callback handler.
    
    Since:
    
    3.0.47
  - uploadFriendDiscoveries
```
public static void uploadFriendDiscoveries(java.util.Map<java.lang.String,java.lang.String> discoveryMap,
                                           SendBird.UploadFriendDiscoveriesHandler handler)
```
    Upload friend discoveries. addUserEventHandler(String, com.sendbird.android.SendBird.UserEventHandler) removeUserEventHandler(String) removeAllUserEventHandlers() SendBird.UserEventHandler.onFriendsDiscovered(List)
    
    Parameters:
    
    discoveryMap - The discovery key, friend name map to upload friend discoveries.
    
    handler - Callback handler.
    
    Since:
    
    3.0.47
  - deleteFriendDiscoveries
```
public static void deleteFriendDiscoveries(java.util.List<java.lang.String> discoveryKeys,
                                           SendBird.DeleteFriendDiscoveriesHandler handler)
```
    Delete friend discoveries.
    
    Parameters:
    
    discoveryKeys - The discovery keys to delete friend discoveries.
    
    handler - Callback handler.
    
    Since:
    
    3.0.47
  - deleteFriendDiscovery
```
public static void deleteFriendDiscovery(java.lang.String discoveryKey,
                                         SendBird.DeleteFriendDiscoveryHandler handler)
```
    Delete friend discovery.
    
    Parameters:
    
    discoveryKey - The discovery key to delete friend discovery.
    
    handler - Callback handler.
    
    Since:
    
    3.0.47
  - getFriendChangeLogsByToken
```
public static void getFriendChangeLogsByToken(java.lang.String token,
                                              SendBird.GetFriendChangeLogsByTokenHandler handler)
```
    Get friend changelogs by token.
    
    Parameters:
    
    token - Token to get next friend changelogs. If the token is null, the result will be passed from the beginning.
    
    handler - Callback handler.
    
    Since:
    
    3.0.47
  - createFriendListQuery
```
public static FriendListQuery createFriendListQuery()
```
    Creates a query instance to get friends.
    
    Returns:
    
    Query to use.
    
    Since:
    
    3.0.47
  - getMyGroupChannelChangeLogsByToken
```
@Deprecated
public static void getMyGroupChannelChangeLogsByToken(java.lang.String token,
                                                                  java.util.List<java.lang.String> customTypes,
                                                                  SendBird.GetMyGroupChannelChangeLogsHandler handler)
```
    Deprecated. As of 3.0.131, replaced by getMyGroupChannelChangeLogsByTokenWithParams(String, GroupChannelChangeLogsParams, GetMyGroupChannelChangeLogsHandler).
    
    Requests the channel changelogs from given token. The result is passed to handler.
    
    Parameters:
    
    token - Token to get next channel changelogs. If the token is null, the result will be passed from the beginning.
    
    customTypes - GroupChannel custom types filter.
    
    handler - Callback handler.
    
    Since:
    
    3.0.84
  - getMyGroupChannelChangeLogsByTimestamp
```
@Deprecated
public static void getMyGroupChannelChangeLogsByTimestamp(long ts,
                                                                      java.util.List<java.lang.String> customTypes,
                                                                      SendBird.GetMyGroupChannelChangeLogsHandler handler)
```
    Deprecated. As of 3.0.131, replaced by getMyGroupChannelChangeLogsByTimestampWithParams(long, GroupChannelChangeLogsParams, GetMyGroupChannelChangeLogsHandler).
    
    Requests the channel changelogs after given timestamp. The result is passed to handler.
    
    Parameters:
    
    ts - Timestamp to load changelogs. Changelogs after this timestamp will be returned.
    
    customTypes - GroupChannel custom types filter. If this is null, the changelogs of all channels will be returned.
    
    handler - Callback handler.
    
    Since:
    
    3.0.84
  - getMyGroupChannelChangeLogsByToken
```
@Deprecated
public static void getMyGroupChannelChangeLogsByToken(java.lang.String token,
                                                                  java.util.List<java.lang.String> customTypes,
                                                                  boolean includeEmpty,
                                                                  SendBird.GetMyGroupChannelChangeLogsHandler handler)
```
    Deprecated. As of 3.0.131, replaced by getMyGroupChannelChangeLogsByTokenWithParams(String, GroupChannelChangeLogsParams, GetMyGroupChannelChangeLogsHandler).
    
    Requests the channel changelogs from given token. The result is passed to handler.
    
    Parameters:
    
    token - Token to get next channel changelogs. If the token is null, the result will be passed from the beginning.
    
    customTypes - GroupChannel custom types filter.
    
    includeEmpty - Flag to include empty channels.
    
    handler - Callback handler.
    
    Since:
    
    3.0.90
  - getMyGroupChannelChangeLogsByTimestamp
```
@Deprecated
public static void getMyGroupChannelChangeLogsByTimestamp(long ts,
                                                                      java.util.List<java.lang.String> customTypes,
                                                                      boolean includeEmpty,
                                                                      SendBird.GetMyGroupChannelChangeLogsHandler handler)
```
    Deprecated. As of 3.0.131, replaced by getMyGroupChannelChangeLogsByTimestampWithParams(long, GroupChannelChangeLogsParams, GetMyGroupChannelChangeLogsHandler).
    
    Requests the channel changelogs after given timestamp. The result is passed to handler.
    
    Parameters:
    
    ts - Timestamp to load changelogs. Changelogs after this timestamp will be returned.
    
    customTypes - GroupChannel custom types filter. If this is null, the changelogs of all channels will be returned.
    
    includeEmpty - Flag to include empty channels.
    
    handler - Callback handler.
    
    Since:
    
    3.0.90
  - getMyGroupChannelChangeLogsByTokenWithParams
```
public static void getMyGroupChannelChangeLogsByTokenWithParams(java.lang.String token,
                                                                GroupChannelChangeLogsParams params,
                                                                SendBird.GetMyGroupChannelChangeLogsHandler handler)
```
    Requests the channel changelogs from given token. The result is passed to handler.
    
    Parameters:
    
    token - Token to get next channel changelogs. If the token is null, the result will be passed from the beginning.
    
    params - Params for getting group channel list. See GroupChannelChangeLogsParams
    
    handler - Callback handler.
    
    Since:
    
    3.0.131
  - getMyGroupChannelChangeLogsByTimestampWithParams
```
public static void getMyGroupChannelChangeLogsByTimestampWithParams(long ts,
                                                                    GroupChannelChangeLogsParams params,
                                                                    SendBird.GetMyGroupChannelChangeLogsHandler handler)
```
    Requests the channel changelogs after given timestamp. The result is passed to handler.
    
    Parameters:
    
    ts - Timestamp to load changelogs. Changelogs after this timestamp will be returned.
    
    params - Params for getting group channel list. See GroupChannelChangeLogsParams
    
    handler - Callback handler.
    
    Since:
    
    3.0.131
  - markAsDelivered
```
@Deprecated
public static void markAsDelivered(java.lang.String channelUrl)
```
    Deprecated. As of 3.0.150, replaced by markAsDelivered(Map).
    
    Sends mark as delivered to this channel when you received push message from us.
    
    Parameters:
    
    channelUrl - target channel's url
    
    Since:
    
    3.0.112
  - markAsDelivered
```
public static void markAsDelivered(java.util.Map<java.lang.String,java.lang.String> data)
```
    Sends mark as delivered to this channel when you received push message from us.
    
    Parameters:
    
    data - The payload data from the push. com.google.firebase.messaging.RemoteMessage#getData() for FCM, com.huawei.hms.push.RemoteMessage#getDataOfMap() for HMS.
    
    Since:
    
    3.0.150
  - markAsReadAll
```
public static void markAsReadAll(SendBird.MarkAsReadHandler handler)
```
    Sends mark as read to all joined GroupChannels. This method has rate limit. You can send one request per second. It returns SendBirdException if you exceed the rate limit.
    
    Parameters:
    
    handler - Callback handler.
    
    Since:
    
    3.0.48
  - markAsReadWithChannelUrls
```
public static void markAsReadWithChannelUrls(java.util.List<java.lang.String> channelUrls,
                                             SendBird.MarkAsReadHandler handler)
```
    Sends mark as read to joined GroupChannels. This method has rate limit. You can send one request per second. It returns SendBirdException if you exceed the rate limit.
    
    Parameters:
    
    channelUrls - Channel Urls.
    
    handler - Callback handler.
    
    Since:
    
    3.0.48
  - getAllEmoji
```
public static void getAllEmoji(SendBird.GetAllEmojiHandler handler)
```
    Requests the all emoji. The result is passed to handler.
    
    Parameters:
    
    handler - Callback handler.
    
    Since:
    
    3.0.130
  - getEmojiCategory
```
public static void getEmojiCategory(long emojiCategoryId,
                                    SendBird.GetEmojiCategoryHandler handler)
```
    Requests the emoji category. The result is passed to handler.
    
    Parameters:
    
    emojiCategoryId - Emoji category id.
    
    handler - Callback handler.
    
    Since:
    
    3.0.130
  - getEmoji
```
public static void getEmoji(java.lang.String key,
                            SendBird.GetEmojiHandler handler)
```
    Requests the emoji. The result is passed to handler.
    
    Parameters:
    
    key - Emoji key.
    
    handler - Callback handler.
    
    Since:
    
    3.0.130
  - getTotalUnreadMessageCount
```
public static void getTotalUnreadMessageCount(GroupChannel.GroupChannelTotalUnreadMessageCountHandler handler)
```
    Gets the total number of unread message of all GroupChannels the current user has joined.
    
    Parameters:
    
    handler - Callback handler.
    
    Since:
    
    3.0.75
  - getTotalUnreadMessageCount
```
public static void getTotalUnreadMessageCount(java.util.List<java.lang.String> channelCustomTypes,
                                              GroupChannel.GroupChannelTotalUnreadMessageCountHandler handler)
```
    Gets the total number of unread message of GroupChannels with channel custom types filter.
    
    Parameters:
    
    channelCustomTypes - GroupChannel custom type list.
    
    handler - Callback handler.
    
    Since:
    
    3.0.75
  - getTotalUnreadMessageCount
```
public static void getTotalUnreadMessageCount(GroupChannelTotalUnreadMessageCountParams params,
                                              GroupChannel.GroupChannelTotalUnreadMessageCountHandler handler)
```
    Gets the total number of unread message of GroupChannels with GroupChannelTotalUnreadMessageCountParams filter.
    
    Parameters:
    
    params - GroupChannelTotalUnreadMessageCountParams
    
    handler - Callback handler.
    
    Since:
    
    3.0.75
  - getSubscribedTotalUnreadMessageCount
```
public static int getSubscribedTotalUnreadMessageCount()
```
    Gets the subscribed total number of unread message of all GroupChannels the current user has joined.
    
    Returns:
    
    The subscribed total unread message count.
    
    Since:
    
    3.0.80
  - getSubscribedCustomTypeTotalUnreadMessageCount
```
public static int getSubscribedCustomTypeTotalUnreadMessageCount()
```
    Gets the total number of unread message of GroupChannels with subscribed custom types.
    
    Returns:
    
    The subscribed custom type total unread message count.
    
    Since:
    
    3.0.80
  - getSubscribedCustomTypeUnreadMessageCount
```
public static int getSubscribedCustomTypeUnreadMessageCount(java.lang.String customType)
```
    Gets the number of unread message of GroupChannel with subscribed custom type.
    
    Parameters:
    
    customType - The subscribed custom type.
    
    Returns:
    
    The subscribed custom type unread message count.
    
    Since:
    
    3.0.80
  - getUnreadItemCount
```
public static void getUnreadItemCount(java.util.Collection<GroupChannel.UnreadItemKey> keys,
                                      GroupChannel.GroupChannelGetUnreadItemCountHandler handler)
```
    Gets the unread item count of GroupChannels from keys.
    
    Parameters:
    
    keys - Unread item keys. Refer to GroupChannel.UnreadItemKey.
    
    handler - Callback handler.
    
    Since:
    
    3.0.75
  - getTotalUnreadChannelCount
```
public static void getTotalUnreadChannelCount(GroupChannel.GroupChannelTotalUnreadChannelCountHandler handler)
```
    Gets the total number of unread GroupChannels the current user has joined.
    
    Parameters:
    
    handler - Callback handler.
    
    Since:
    
    3.0.75
  - getTotalUnreadChannelCount
```
public static void getTotalUnreadChannelCount(GroupChannelTotalUnreadChannelCountParams params,
                                              GroupChannel.GroupChannelTotalUnreadChannelCountHandler handler)
```
    Gets the total number of unread GroupChannels the current user has joined.
    
    Parameters:
    
    params - GroupChannelTotalUnreadChannelCountParams.
    
    handler - Callback handler.
    
    Since:
    
    3.1.8
  - getGroupChannelCount
```
public static void getGroupChannelCount(GroupChannelListQuery.MemberStateFilter memberStateFilter,
                                        GroupChannel.GroupChannelChannelCountHandler handler)
```
    Gets the number of my GroupChannels.
    
    Parameters:
    
    memberStateFilter - GroupChannelListQuery.MemberStateFilter.
    
    handler - Callback handler.
    
    Since:
    
    3.0.75
  - getEkey
```
public static java.lang.String getEkey()
```
    Gets the key to authenticate the url retrieved from FileMessage.getPlainUrl(), User.getPlainProfileImageUrl() and FileMessage.Thumbnail.getPlainUrl(). This key has to be put into the HTTP header to access the url provided by above methods.
    
    Returns:
    
    The key to authenticate plain resource urls that contain encrypted contents.
  - allowFriendDiscovery
```
public static void allowFriendDiscovery(boolean allow,
                                        AllowFriendDiscoveryHandler handler)
```
    Sets friend discoverability of current user.
    
    Parameters:
    
    allow - true to allow, false to disallow.
    
    handler - a completion handler to get notified of complete event. Can be null.
    
    Since:
    
    3.0.150
  - getAllowFriendDiscovery
```
public static void getAllowFriendDiscovery(GetAllowFriendDiscoveryHandler handler)
```
    Gets friend discoverability of current user.
    
    Parameters:
    
    handler - A handler to get notified of the result.
    
    Since:
    
    3.0.150

Class SendBird

Nested Class Summary

Field Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

LOGGER_NONE

LOGGER_INFO

PUSH_TEMPLATE_DEFAULT

PUSH_TEMPLATE_ALTERNATIVE

Method Detail

addExtension

runOnUIThread

getOSVersion

getSDKVersion

getApplicationId

setLoggerLevel

setLoggerLevel

setAppVersion

init

clearCachedData

clearCachedMessages

getCachedDataSize

init

initFromForeground

initFromForeground

isUsingLocalCaching

notifyActivityResumedForOldAndroids

notifyActivityPausedForOldAndroids

setAutoBackgroundDetection

getAutoBackgroundDetection

setNetworkAwarenessReconnection

getNetworkAwarenessReconnection

getConnectionState

connect

connect

connect

reconnect

setSessionHandler

addChannelHandler

removeChannelHandler

removeAllChannelHandlers

addUserEventHandler

removeUserEventHandler

removeAllUserEventHandlers

addConnectionHandler

removeConnectionHandler

removeAllConnectionHandlers

disconnect

disconnectWebSocket

getAppInfo

getCurrentUser

getLastConnectedAt

createUserListQuery

createUserListQuery

createApplicationUserListQuery

createBlockedUserListQuery

updateCurrentUserInfoWithProfileImage

updateCurrentUserInfo

updateCurrentUserInfo

getPendingPushToken

registerPushTokenForCurrentUser

registerPushTokenForCurrentUser

registerPushTokenForCurrentUser

unregisterPushTokenForCurrentUser

unregisterPushTokenAllForCurrentUser

getMyPushTokensByToken

setDoNotDisturb

getDoNotDisturb

setSnoozePeriod

getSnoozePeriod

setPushSound

getPushSound

setPushTemplate

getPushTemplate

setPushTriggerOption

getPushTriggerOption

setChannelInvitationPreference

getChannelInvitationPreference

blockUser