Config
功能介绍
信息
初始化 SDK 的配置信息。
- iOS
- Android
- Flutter
- uni-app
- Browser/Electron/MiniProgram
- React-Native
- Unity
InitConfig
字段名称 | 字段类型 | 是否必填 | 描述 |
---|---|---|---|
platformID | int | 是 | 平台号: iOS 1, Android 2, Windows 3, OSX 4, WEB 5, 小程序 6,linux 7 |
apiAddr | String | 是 | IM api 地址,一般为http://xxx:10002 或https://xxx/api |
wsAddr | String | 是 | IM ws 地址,一般为ws://xxx:10001 或wss://xxx/msg_gateway |
dataDir | String | 是 | IM 客户端 DB 存放目录 |
logLevel | int | 否 | SDK 日志打印级别 |
isLogStandardOutput | BOOL | 否 | 是否将日志打印到控制台 |
logFilePath | NSString | 否 | 本地保存日志文件路径 |
OIMInitConfig
字段名称 | 字段类型 | 是否必填 | 描述 |
---|---|---|---|
platformID | OIMPlatform | 是 | 平台号: iOS 1, Android 2, Windows 3, OSX 4, WEB 5, 小程序 6,linux 7 |
apiAddr | NSString | 是 | IM api 地址,一般为http://xxx:10002 或https://xxx/api |
wsAddr | NSString | 是 | IM ws 地址,一般为ws://xxx:10001 或wss://xxx/msg_gateway |
dataDir | NSString | 否 | IM 客户端 DB 存放目录 |
logLevel | NSInteger | 否 | SDK 日志打印级别 |
isLogStandardOutput | BOOL | 否 | 是否将日志打印到控制台 |
logFilePath | NSString | 否 | 本地保存日志文件路径 |
InitConfig
字段名称 | 字段类型 | 是否必填 | 描述 |
---|---|---|---|
apiAddr | string | 是 | IM api 地址,一般为http://xxx:10002 或https://xxx/api |
wsAddr | string | 是 | IM ws 地址,一般为ws://xxx:10001 或wss://xxx/msg_gateway |
dataDir | string | 是 | IM 客户端 DB 存放目录 |
platformID | number | 否 | 平台号: iOS 1, Android 2, Windows 3, OSX 4, WEB 5, 小程序 6,linux 7 |
logLevel | number | 否 | SDK 日志打印级别 |
isLogStandardOutput | boolean | 否 | 是否将日志打印到控制台 |
logFilePath | string | 否 | 本地保存日志文件路径 |
InitConfig
字段名称 | 字段类型 | 是否必填 | 描述 |
---|---|---|---|
platformID | Platform | 是 | 平台号: iOS 1, Android 2, Windows 3, OSX 4, WEB 5, 小程序 6,linux 7 |
apiAddr | string | 是 | IM api 地址,一般为http://xxx:10002 或https://xxx/api |
wsAddr | string | 是 | IM ws 地址,一般为ws://xxx:10001 或wss://xxx/msg_gateway |
dataDir | string | 是 | IM 客户端 DB 存放目录 |
logLevel | LogLevel | 否 | SDK 日志打印级别 |
isLogStandardOutput | boolean | 否 | 是否将日志打印到控制台 |
logFilePath | string | 否 | 本地保存日志文件路径 |
InitConfig
字段名称 | 字段类型 | 是否必填 | 描述 |
---|---|---|---|
platformID | Platform | 是 | 平台号: iOS 1, Android 2, Windows 3, OSX 4, WEB 5, 小程序 6,linux 7 |
apiAddr | string | 是 | IM api 地址,一般为http://xxx:10002 或https://xxx/api |
wsAddr | string | 是 | IM ws 地址,一般为ws://xxx:10001 或wss://xxx/msg_gateway |
dataDir | string | 是 | db 文件存储目录,绝对路径 |
logFilePath | string | 否 | 日志文件存储目录,绝对路径,不传则不存 |
logLevel | LogLevel | 否 | SDK 日志打印级别 |
isLogStandardOutput | boolean | 否 | 是否输入日志到控制台 |
InitAndLoginConfig
字段名称 | 字段类型 | 是否必填 | 描述 | |
---|---|---|---|---|
platformID | Platform | 是 | 平台号: iOS 1, Android 2, Windows 3, OSX 4, WEB 5, 小程序 6,linux 7 | |
apiAddr | string | 是 | IM api 地址,一般为http://xxx:10002 或https://xxx/api | |
wsAddr | string | 是 | IM ws 地址,一般为ws://xxx:10001 或wss://xxx/msg_gateway | |
userID | string | 是 | IM 用户 userID | |
token | string | 是 | OpenIM 用户令牌,业务后台验证用户账号密码后,通过 user_token 来获取 | |
logLevel | LogLevel | 否 | SDK 日志打印级别 | |
isLogStandardOutput | boolean | 否 | 是否输入日志到控制台 | |
tryParse | boolean | 否 | 是否自动 parse 返回值,默认为 true |
InitConfig
字段名称 | 字段类型 | 是否必填 | 描述 |
---|---|---|---|
platformID | Platform | 是 | 平台号: iOS 1, Android 2, Windows 3, OSX 4, WEB 5, 小程序 6,linux 7 |
apiAddr | string | 是 | IM api 地址,一般为http://xxx:10002 或https://xxx/api |
wsAddr | string | 是 | IM ws 地址,一般为ws://xxx:10001 或wss://xxx/msg_gateway |
dataDir | string | 是 | IM 客户端 DB 存放目录 |
logLevel | LogLevel | 否 | SDK 日志打印级别 |
isLogStandardOutput | boolean | 否 | 是否将日志打印到控制台 |
IMConfig
字段名称 | 字段类型 | 是否必填 | 描述 |
---|---|---|---|
ApiAddr | string | 是 | IM api 地址,一般为http://xxx:10002 或https://xxx/api |
WsAddr | string | 是 | IM ws 地址,一般为ws://xxx:10001 或wss://xxx/msg_gateway |
DataDir | string | 是 | IM 客户端 DB 存放目录 |
PlatformID | int | 否 | 平台号: iOS 1, Android 2, Windows 3, OSX 4, WEB 5, 小程序 6,linux 7 |
LogLevel | uint | 否 | SDK 日志打印级别 |
IsLogStandardOutput | bool | 否 | 是否将日志打印到控制台 |
LogFilePath | string | 否 | 本地保存日志文件路径 |
IsExternalExtensions | bool | 否 |