com.netease.nimlib.sdk

Class NIMClient

java.lang.Object

com.netease.nimlib.sdk.NIMClient

public class NIMClient
extends java.lang.Object

SDK core class used to initialize the SDK, obtain various service functionality interfaces, and current status.

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	TAG

Constructor Summary

Constructors

Constructor and Description
NIMClient()

Method Summary

Modifier and Type	Method and Description
static void	config(Context context, LoginInfo info, SDKOptions options) [Method 2] Configures the SDK in Application#onCreate().
static ModeCode	getMode() Gets the current login mode of the SDK
static java.lang.String	getSdkStorageDirPath() Gets the data directory path in the SDK.
static java.lang.String	getSDKVersion() Gets the version number of the SDK.
static <T> T	getService(java.lang.Class<T> clazz) Gets interfaces for each service.
static StatusCode	getStatus() Gets the state of the current user.
static void	init(Context context, LoginInfo info, SDKOptions options) [Method 1] Initializes SDK using Application#onCreate()
static void	initSDK() [Method 2] initializes the SDK when required on the main thread of the UI process instead of being initialized by calling Application#onCreate()).
static <T> RequestResult<T>	syncRequest(InvocationFuture<T> future)
static <T> RequestResult<T>	syncRequest(InvocationFuture<T> future, long time) Converts an asynchronous call into a synchronous call when making asynchronous API calls on a non-UI thread.
static void	toggleNotification(boolean on) Turns on or off alerts on the notifications bar.
static void	toggleRevokeMessageNotification(boolean on) Turns on or off alerts when message are recalled.
static void	updateCaptureDeviceInfoOption(CaptureDeviceInfoConfig captureDeviceInfoConfig) Updates the configuration for getting the device information A value of null indicates the device information can be obtained.
static void	updateStatusBarNotificationConfig(StatusBarNotificationConfig config) Updates the configuration of the notification alert on the status bar
static void	updateStrings(NimStrings strings) Updates the strings when the system language changes.
static void	updateTokenSceneConfig(NosTokenSceneConfig config) Updates NosTokenSceneConfig

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

TAG

public static final java.lang.String TAG

See Also:

Constant Field Values

Constructor Detail

NIMClient

public NIMClient()

Method Detail

init

public static void init(Context context,
                        LoginInfo info,
                        SDKOptions options)

[Method 1] Initializes SDK using Application#onCreate()

Parameters:

context - specifies the context parameter.

info - User info. If the user information is provided, automatic login will be implemented and the user info will be fetched at the same time. If no user account is logged in, pass in null.

options - specifies the SDK configuration.

config

public static void config(Context context,
                          LoginInfo info,
                          SDKOptions options)

[Method 2] Configures the SDK in Application#onCreate().

Parameters:

context - specifies the context parameter.

info - User info. If the user information is provided, automatic login will be implemented and the user info will be fetched at the same time. If no user account is logged in, pass in null.

options - specifies the SDK configuration.

initSDK

public static void initSDK()

[Method 2] initializes the SDK when required on the main thread of the UI process instead of being initialized by calling Application#onCreate()). Synchronous and asynchronous calls are supported using SDKOptions.asyncInitSDK Weak IM mode is supported by calling SDKOptions.reducedIM, and loading the push process service is delayed. Note: Call config(Context, LoginInfo, SDKOptions) in Application#onCreate() first.

getService

public static <T> T getService(java.lang.Class<T> clazz)

Gets interfaces for each service.

Type Parameters:

T - service interface type

Parameters:

clazz - service interface class instance

Returns:

service interface

syncRequest

public static <T> RequestResult<T> syncRequest(InvocationFuture<T> future,
                                               long time)

Converts an asynchronous call into a synchronous call when making asynchronous API calls on a non-UI thread. This method will block the caller thread until the asynchronous API call responds with a result. This method is not recommended, and is only provided for scenarios where synchronous calls of CommsEase APIs without the synchronous version in non-UI threads of CommsEase APIs without Looper. For example, starting a thread or thread pool to handle data in the SDK. If the SDK provides a synchronous API, do not use this method to make an asynchronous call. In addition, when a non-UI thread with Looper make an asynchronous API call, the callback will be executed on the calling thread. In SDKs earlier than 4.4.0, the callback is executed in the UI thread. Note: This method is not allowed on the UI thread or on a non-UI thread with Looper. This does not conform to the Android specification. Otherwise, the interface will return an error code ResponseCode.RES_API_SYNC_RUN_ON_LOOPER_THREAD_EXCEPTION

Type Parameters:

T - The data type of the result

Parameters:

future - The callback returned by the asynchronous API call

time - The maximum waiting time for synchronization in milliseconds. In most cases, set the value to 30000. after the timeout, the method returns the error code ResponseCode.RES_API_SYNC_TIMEOUT

Returns:

The result of an asynchronous call on a non-UI thread

syncRequest

public static <T> RequestResult<T> syncRequest(InvocationFuture<T> future)

getStatus

public static StatusCode getStatus()

Gets the state of the current user.

Returns:

The current state

getMode

public static ModeCode getMode()

Gets the current login mode of the SDK

Returns:

IM login mode, chat room login mode

toggleNotification

public static void toggleNotification(boolean on)

Turns on or off alerts on the notifications bar. The method takes effect only if StatusBarNotificationConfig is specified.

Parameters:

on - Option to turn on or off

toggleRevokeMessageNotification

public static void toggleRevokeMessageNotification(boolean on)

Turns on or off alerts when message are recalled. The method takes effect only if StatusBarNotificationConfig is specified and the switch for alerts on the notification bar is turned on. By default, the switch is turned on. However, if the switch is turned off, no alerts will appear on the notification bar and the notification bar alert switch toggleNotification(boolean on) becomes invalid.

Parameters:

on - Option to turn on or off

updateStatusBarNotificationConfig

public static void updateStatusBarNotificationConfig(StatusBarNotificationConfig config)

Updates the configuration of the notification alert on the status bar

Parameters:

config - The configuration

updateStrings

public static void updateStrings(NimStrings strings)

Updates the strings when the system language changes. The configuration does not take effect immediately, and all strings are applied the next time they are used.

Parameters:

strings - Definition of strings used in SDK.

getSdkStorageDirPath

public static java.lang.String getSdkStorageDirPath()

Gets the data directory path in the SDK. The method must be called after the SDK is initialized.

Returns:

The directory location of the data, including subdirectories, such as log, file, image, audio, video, and thumb, etc.

getSDKVersion

public static java.lang.String getSDKVersion()

Gets the version number of the SDK.

Returns:

The version number, such as "1.0.0"

updateTokenSceneConfig

public static void updateTokenSceneConfig(NosTokenSceneConfig config)

Updates NosTokenSceneConfig

Parameters:

config - NosTokenSceneConfig

updateCaptureDeviceInfoOption

public static void updateCaptureDeviceInfoOption(CaptureDeviceInfoConfig captureDeviceInfoConfig)

Updates the configuration for getting the device information A value of null indicates the device information can be obtained. If the device information is not obtained, use of features may be affected. Contact technical support for more information.

Parameters:

captureDeviceInfoConfig - The configuration for getting the device information