NIMSDK-AOS 10.2.4-beta
|
SDK 核心接口类,用于初始化 SDK,获取各个服务能力接口,获取当前状态等功能。 更多...
静态 Public 成员函数 | |
static void | init (Context context, LoginInfo info, SDKOptions options) |
[初始化 SDK 方式一] 在 Application#onCreate() 中调用该方法在应用启动时初始化 SDK。 更多... | |
static void | config (Context context, LoginInfo info, SDKOptions options) |
[初始化 SDK 方式二] 在 Application#onCreate() 中配置 SDK(仅仅是配置,不影响性能),具体可配置的参数同 NIMClient#init(Context, LoginInfo, SDKOptions) 。 更多... | |
static void | initSDK () |
[初始化 SDK 方式二] 在 UI 进程主线程上按需初始化 SDK(不放在 Application#onCreate() 中初始化)。与 NIMClient#config(Context, LoginInfo, SDKOptions) 方法搭配使用。 更多... | |
static void | initDelay (Context context, LoginInfo info, SDKOptions options) |
[初始化 SDK 方式三] 在 UI 进程主线程上按需初始化 SDK(不一定放在 Application#onCreate() 中初始化)。 更多... | |
static void | initV2 (Context context, SDKOptions options) |
static< T > T | getService (Class< T > clazz) |
获取云信各服务接口。 更多... | |
static< T > RequestResult< T > | syncRequest (InvocationFuture< T > future, long time) |
在非 UI 线程中调用云信 SDK 异步 API,强制将异步调用转换为同步调用。 更多... | |
static< T > RequestResult< T > | syncRequest (InvocationFuture< T > future) |
在非 UI 线程调用云信 SDK 异步 API,强制将异步调用转换为同步调用。该接口已废弃,请使用 NIMClient#syncRequest(InvocationFuture, long) 接口。 更多... | |
static String | getCurrentAccount () |
获取当前用户的 IM 账号(accid)。 更多... | |
static String | getAppKey () |
获取当前应用的 AppKey。 更多... | |
static StatusCode | getStatus () |
获取当前用户的状态。 更多... | |
static ModeCode | getMode () |
获取 SDK 当前的登录模式。 更多... | |
static void | toggleNotification (boolean on) |
通知栏消息提醒开关。 更多... | |
static void | toggleRevokeMessageNotification (boolean on) |
撤回消息需要通知栏提醒的开关。 更多... | |
static void | updateStatusBarNotificationConfig (StatusBarNotificationConfig config) |
更新通知栏消息提醒配置,包括是否需要振动提醒、是否需要响铃提醒等。 更多... | |
static void | updateStrings (NimStrings strings) |
更新系统文案。 更多... | |
static String | getSdkStorageDirPath () |
获取 SDK 数据缓存目录路径。 更多... | |
static String | getSDKVersion () |
运行时获取当前 SDK 版本号。 更多... | |
static void | updateTokenSceneConfig (NosTokenSceneConfig config) |
更新 SDK NOS Token 场景配置。对于 SDK NOS Token,云信 SDK 有默认值 ,若用户不单独配置,则直接采用默认值。 更多... | |
static void | updateCaptureDeviceInfoOption (CaptureDeviceInfoConfig captureDeviceInfoConfig) |
更新获取设备信息的相关配置。包括配置是否获取产品型号、是否获取制造商信息、是否获取品牌信息,null 表示都可以获取,没有限制。 更多... | |
静态 Public 属性 | |
static final String | TAG = "NIMClient" |
SDK 核心接口类,用于初始化 SDK,获取各个服务能力接口,获取当前状态等功能。
在文件 NIMClient.java 第 22 行定义.
|
static |
[初始化 SDK 方式二] 在 Application#onCreate()
中配置 SDK(仅仅是配置,不影响性能),具体可配置的参数同 NIMClient#init(Context, LoginInfo, SDKOptions)
。
NIMClient#config(Context, LoginInfo, SDKOptions)
方法必须与 NIMClient#initSDK()
方法搭配使用,在应用代码的任意位置初始化 SDK。 参数名称 | 描述 |
---|---|
context | 调用上下文 |
info | 手动登录成功的用户信息。如 account(即 accid)和 token
|
options | SDK 的其他初始化配置。如 App Key、第三方离线推送配置、是否开启会话已读多端同步等
|
在文件 NIMClient.java 第 98 行定义.
|
static |
|
static |
|
static |
获取 SDK 当前的登录模式。
ModeCode
包括以下三种模式:在文件 NIMClient.java 第 307 行定义.
|
static |
获取 SDK 数据缓存目录路径。
在文件 NIMClient.java 第 368 行定义.
|
static |
|
static |
获取云信各服务接口。
参数名称 | 描述 |
---|---|
clazz | 服务接口类型实例 |
<T> | 服务接口类型 |
在文件 NIMClient.java 第 193 行定义.
|
static |
|
static |
[初始化 SDK 方式一] 在 Application#onCreate()
中调用该方法在应用启动时初始化 SDK。
Application#onCreate()
中添加进程判断,SDK 的初始化方法必须在主进程中调用。不要把业务逻辑写入 core 进程,理论上,core 进程的 Application#onCreate()
(或者 Application 的其他方法)只能做与 NIM SDK 相关的工作。IM 进程启动时也不要初始化第三方库。 参数名称 | 描述 |
---|---|
context | 调用上下文 |
info | 手动登录成功的用户信息。如 account(即 accid)和 token
|
options | SDK 的其他初始化配置。如 App Key、第三方离线推送配置、是否开启会话已读多端同步等
|
com.netease.nimlib.sdk.lifecycle.SdkLifecycleObserver#observeMainProcessInitCompleteResult(Observer, boolean)
:初始化进程回调 在文件 NIMClient.java 第 57 行定义.
|
static |
[初始化 SDK 方式三] 在 UI 进程主线程上按需初始化 SDK(不一定放在 Application#onCreate()
中初始化)。
参数名称 | 描述 |
---|---|
context | 调用上下文 |
info | 手动登录成功的用户信息。如 account(即 accid)和 token
|
options | SDK 的其他初始化配置。如 App Key、第三方离线推送配置、是否开启会话已读多端同步等
|
在文件 NIMClient.java 第 153 行定义.
|
static |
[初始化 SDK 方式二] 在 UI 进程主线程上按需初始化 SDK(不放在 Application#onCreate()
中初始化)。与 NIMClient#config(Context, LoginInfo, SDKOptions)
方法搭配使用。
NIMClient#config(Context, LoginInfo, SDKOptions)
方法搭配使用,即先在 Application::onCreate 中调用 config 方法,然后在应用代码的任意位置调用 NIMClient#initSDK()
方法初始化 SDK。 在文件 NIMClient.java 第 120 行定义.
|
static |
在文件 NIMClient.java 第 163 行定义.
|
static |
在非 UI 线程调用云信 SDK 异步 API,强制将异步调用转换为同步调用。该接口已废弃,请使用 NIMClient#syncRequest(InvocationFuture, long)
接口。
参数名称 | 描述 |
---|---|
future | 异步 API 调用返回的回调 |
<T> | 结果的数据类型 |
在文件 NIMClient.java 第 256 行定义.
|
static |
在非 UI 线程中调用云信 SDK 异步 API,强制将异步调用转换为同步调用。
ResponseCode#RES_API_SYNC_RUN_ON_LOOPER_THREAD_EXCEPTION
。 参数名称 | 描述 |
---|---|
future | 异步 API 调用返回的回调 |
<T> | 结果的数据类型 |
time | 最大同步等待时间,单位毫秒,一般设置为 30000,超时后该方法直接返回错误,错误码参见 ResponseCode#RES_API_SYNC_TIMEOUT |
在文件 NIMClient.java 第 231 行定义.
|
static |
通知栏消息提醒开关。
StatusBarNotificationConfig
配置不为空时才有效。在文件 NIMClient.java 第 319 行定义.
|
static |
撤回消息需要通知栏提醒的开关。
NIMClient#toggleNotification(boolean)
)开启时才有效。 在文件 NIMClient.java 第 332 行定义.
|
static |
更新获取设备信息的相关配置。包括配置是否获取产品型号、是否获取制造商信息、是否获取品牌信息,null 表示都可以获取,没有限制。
在文件 NIMClient.java 第 409 行定义.
|
static |
更新通知栏消息提醒配置,包括是否需要振动提醒、是否需要响铃提醒等。
在文件 NIMClient.java 第 344 行定义.
|
static |
更新系统文案。
在文件 NIMClient.java 第 357 行定义.
|
static |
更新 SDK NOS Token 场景配置。对于 SDK NOS Token,云信 SDK 有默认值 ,若用户不单独配置,则直接采用默认值。
com.netease.nimlib.NimNosSceneKeyConstant
。 NosTokenSceneConfig#appendCustomScene(String, int)
:增加自定义场景NosTokenSceneConfig#updateDefaultProfileSceneExpireTime(int)
:更新默认场景(NIM_DEFAULT_PROFILE)的过期时间NosTokenSceneConfig#updateDefaultIMSceneExpireTime(int)
:更新默认场景(NIM_DEFAULT_IM)的过期时间在文件 NIMClient.java 第 398 行定义.
|
static |
在文件 NIMClient.java 第 24 行定义.