提供 SDK 聊天相关的设置。

用户可以用于配置 SDK 的各种参数、选项,比如,设置 App Key,是否自动接受加好友邀请。

Constructors

Methods

allowChatroomOwnerLeave canChatroomOwnerLeave getAppIDForPush getAppId getAppKey getAreaCode getCustomDeviceName getCustomOSPlatform getDeviceUuid getDnsURL getDownloadPath getEnableDnsConfig getImPort getImServer getLogLevel getLoginCustomExt getRestServer getSDKPlatform getSyncDataWebSocketPort getSyncDataWebSocketServer getUIKitVersion getWebSocketPort getWebSocketServer isAcceptInvitationAlways isAutoAcceptGroupInvitations isAutoDownloadThumbnail isAutoLogin isAutoTransferMessageAttachments isDeleteMessagesOnLeaveChatroom isDeleteMessagesOnLeaveGroup isEnableAutoSyncContacts isEnableTLSConnection isEnableUserInfo isIncludeSendMessageInMessageListener isRequireDeliveryAck isRequireReadAck isSortMessageByServerTime isUseReplacedMessageContents isUsingHttpsOnly regardImportedMsgAsRead setAcceptInvitationAlways setAppIDForPush setAppId setAppKey setAreaCode setAutoAcceptGroupInvitations setAutoDownloadThumbnail setAutoLogin setAutoTransferMessageAttachments setConfig setCustomDeviceName setCustomOSPlatform setDeleteMessagesOnLeaveChatroom setDeleteMessagesOnLeaveGroup setDnsURL setEnableAutoSyncContacts setEnableDnsConfig setEnableTLSConnection setEnableUserInfo setIMServer setImPort setIncludeSendMessageInMessageListener setLogLevel setLoginCustomExt setRegardImportedMsgAsRead setRequireDeliveryAck setRequireReadAck setRestServer setSDKPlatform setSortMessageByServerTime setSyncDataWebSocketPort setSyncDataWebSocketServer setUIKitVersion setUseReplacedMessageContents setUsingHttpsOnly setWebSocketPort setWebSocketServer updatePath

Constructors

  • 构造函数

    Parameters

    • param: string

      应用的 AppKey (可以在 console 后台上获取)。

    Returns ChatOptions

  • 构造函数

    Parameters

    • param: AppParam

      构造函数传入的参数。

      • 当应用的唯一标识是 AppKey 时,需要传入 AppKey 参数(可以在 console 后台上获取);
      • 当应用的唯一标识是 AppId 时,需要传入 AppId 参数(可以在 console 后台上获取)。

    Returns ChatOptions

Methods

  • 设置是否允许聊天室所有者离开并删除会话记录。

    Parameters

    • isChatroomOwnerLeaveAllowed: boolean

      是否允许聊天室所有者离开并删除会话记录。

      • (默认) true:允许。聊天室所有者离开时不再接收该聊天室的任何消息并删除会话记录。
      • false:不允许。

    Returns void

  • 获取是否允许聊天室所有者离开。

    Returns boolean

    • 返回是否允许聊天室所有者离开。
    • (默认)true:允许。聊天室所有者离开时,不再接收该聊天室的任何消息,并删除会话记录;
    • false:不允许。
  • 获取用于推送的 app ID。

    Returns string

    • 返回 app ID。
  • 获取 APP ID。

    Returns string

    返回当前应用设置的 APP ID。

  • 获取 app key。

    Returns string

    返回当前应用设置的 app key。

  • 获取区域代号。

    区域代码参数用于限制边缘节点的访问范围。

    Returns AreaCode

    • 返回区域代号。
  • 获取当前设备的自定义名称。

    Returns string

    • 返回当前设备的自定义名称。
  • 获取登录设备的自定义平台代号。

    Returns number

    • 返回登录设备的自定义平台代号。
  • 返回设备 ID。

    Returns string

    • 返回设备 ID。
  • 获取 DNS 地址。

    Returns string

    • 返回设置的 DNS 地址。
  • 获取附件下载后所在文件夹的路径。

    Returns string

    • 下载的附件所在文件夹的路径。
  • 获取是否启用 DNS。

    Returns boolean

    是否启用 DNS。

  • 获取设置的 Chat 消息服务器端口号,一般为私有部署服务,在开发者想实现数据隔离、特别注重数据安全时使用,如有需求请联系商务。

    Returns number

    • 返回 Chat 端口号。
  • 获取设置的 Chat 消息服务器地址,一般为私有部署服务,在开发者想实现数据隔离、特别注重数据安全时使用,如有需求请联系商务。

    Returns string

    • 返回 Chat 消息服务器地址。
  • 获取当前日志输出等级。

    默认为 DEBUG_LEVEL = 0。

    Returns ChatLogLevel

    • 返回日志输出等级。
  • 获取自定义设备扩展信息。

    Returns string

    • 返回自定义设备扩展信息。
  • 获取设置的 REST 服务器地址,一般为私有部署服务,在开发者想实现数据隔离、特别注重数据安全时使用,如有需求请联系商务。

    Returns string

    • 返回 REST 服务器地址。
  • 获取当前 SDK 平台枚举。

    Returns SDKPlatform

    • 返回当前 SDK 平台枚举
  • 获取设置的同步数据 WebSocket 服务器端口号。

    Returns number

    同步数据 WebSocket 服务器端口号。

  • 获取设置的同步数据 WebSocket 服务器地址。

    Returns string

    同步数据 WebSocket 服务器地址。

  • 获取 UIKit 版本号。

    Returns string

    • 返回 UIKit 版本号。
  • 获取设置的 WebSocket 服务器端口号。

    Returns number

    WebSocket 服务器端口号。

  • 获取设置的 WebSocket 服务器地址。

    Returns string

    WebSocket 服务器地址。

  • 获取是否自动同意好友申请。

    Returns boolean

    • 返回是否自动同意好友申请。
    • true:是;
    • false:否。
  • 获取是否自动同意群组邀请。

    Returns boolean

    • 返回是否自动同意群组邀请。
    • true:是;
    • false:否。
  • 获取是否自动下载缩略图。

    Returns boolean

    • 是否自动下载缩略图。
    • true:自动;
    • false:不自动。
  • 获取是否开启了自动登录。

    Returns boolean

    • (默认)true:已设置为自动登录;
    • false:未设置为自动登录。
  • 获取是否使用 Chat 服务器进行上传下载。

    Returns boolean

    • 是否自动使用 Chat 服务器进行上传下载。
    • true:是;
    • false:不自动使用 Chat 服务器上传下载,自定义上传下载路径。
  • 获取退出(主动和被动退出)聊天室时是否删除聊天消息。

    Returns boolean

    • 返回退出(主动和被动退出)聊天室时是否删除聊天消息。
    • (默认)true:删除。
    • false:保留。
  • 获取退出(主动和被动退出)群组时是否删除聊天消息。

    Returns boolean

    • 返回退出(主动和被动退出)群组时是否删除聊天消息。
    • (默认)true: 删除。
    • false: 不删除。
  • 获取登录时是否同步好友列表。

    Returns boolean

    是否同步好友列表。

    • true:同步好友列表;
    • false(默认):不同步好友列表。
  • 获取是否开启 TLS 连接。

    Returns boolean

    • 返回是否开启 TLS 连接。
    • true:开启 TLS 连接;
    • false:未开启 TLS 连接。
  • 获取是否开启用户信息系统。

    Returns boolean

    是否开启用户信息系统。

    • true:已开启;
    • false:未开启。
  • 获取送达回执设置。

    Returns boolean

    • 是否需要送达回执。
    • true:需要;
    • false: 不需要。
  • 获取是否需要消息接收方发送已读回执的设置。

    Returns boolean

    • 是否要求消息的接收方发送已读回执。
    • true:需要;
    • `false:不需要。
  • 获取是否按照服务器收到时间进行排序。

    Returns boolean

    • 返回是否按照服务器收到的时间排序。
    • (默认)true:是;
    • false:否。
  • 获取当发送的文本消息的内容被文本审核(Moderation)服务替换时,是否需要返回给发送方。

    Returns boolean

    • 是否将内容替换后的消息返回给发送方。
    • true:是。将内容替换后的消息返回给发送方。
    • (默认)false:否。将原消息返回给发送方。
  • 获取是否只使用 HTTPS 进行 REST 操作。

    Returns boolean

    • 是否只使用 HTTPS 进行 REST 操作。
    • (默认)true 只使用 HTTPS;
    • false 可以使用 HTTPS 和 HTTP。
  • 获取是否将导入的消息视为已读。

    Returns boolean

    是否将导入的消息视为已读。

  • 设置是否自动同意好友申请。

    Parameters

    • isAutoAccept: boolean

      是否自动同意好友申请:

      • (默认)true:是;
      • false:否。

    Returns void

  • 设置用于推送的 app ID。

    Parameters

    • appId: string

      { string } 用于推送的 app ID (certName)。

    Returns void

  • 设置 APP ID。

    Parameters

    • appId: string

      创建 app 时在 console 后台上注册的 app 识别符。

    Returns void

  • 设置 app key。

    Parameters

    • appKey: string

      创建 app 时在 console 后台上注册的 app 识别符。

    Returns void

  • 设置区域代号。

    Parameters

    • code: AreaCode

      区域代号。该参数用于限制边缘节点的访问范围,默认值为 AreaCode#AREA_CODE_GLOB,表示不限制区域。应用运行时不能对该参数进行修改。

    Returns void

  • 设置是否自动同意群组邀请。

    Parameters

    • isAutoAcceptGroups: boolean

      是否自动同意群组邀请。

      • (默认)true:是;
      • false:否。

    Returns void

  • 是否自动下载缩略图。

    Parameters

    • autoDownload: boolean

      是否自动下载缩略图。

      • (默认)true:自动;
      • false:不自动。

    Returns void

  • 开启/关闭自动登录。

    Parameters

    • autoLogin: boolean

      (默认)true:自动登录;

      • false:不自动登录。

    Returns void

  • 设置是否使用 Chat 服务器自动上传和下载附件。

    Parameters

    • isTransferAttachments: boolean

      是否自动上传和下载附件。

      • (默认)true:是;
      • false:不自动使用 Chat 服务器上传下载,自定义上传下载路径。

    Returns void

  • Parameters

    • config: ChatConfigPrivate

    Returns void

  • 设置当前设备自定义名称。

    设置当前设备自定义名称旨在多设备登录时区分设备。

    Parameters

    • customDeviceName: string

      自定义设备名称。该参数不支持空字符串。

    Returns void

  • 设置登录设备的自定义平台代号。

    Parameters

    • platform: number

      自定义平台代号,取值范围为 1-100。

    Returns void

  • 设置退出(主动和被动退出)聊天室时是否删除聊天消息。

    Parameters

    • isDeleteMessageOnLeaveChatroom: boolean

      退出(主动和被动退出)聊天室时是否删除聊天消息。

      • (默认)true:删除。
      • false:保留。

    Returns void

  • 设置退出(主动和被动退出)群组时是否删除聊天消息。

    Parameters

    • isDeleteMessagesOnLeaveGroup: boolean

      退出(主动和被动退出)群组时是否删除聊天消息。

      • (默认)true: 删除。
      • false: 不删除。

    Returns void

  • 设置 DNS 地址。

    Parameters

    • url: string

      DNS 地址。

    Returns void

  • 设置登录时是否同步好友列表。

    默认值为 false。需在 ChatClient.init 前设置。

    Parameters

    • enableAutoSyncContacts: boolean

      是否同步好友列表。

      • true:同步好友列表;
      • false(默认):不同步好友列表。

    Returns void

  • 设置是否启用 DNS。默认为 true。

    仅在 ChatClient.init 前设置生效,运行时不可修改。

    • true:启用 DNS(默认),SDK 通过 DNS 解析服务器地址;
    • false:使用私有部署服务器配置,此时需自行设置 chatServer、restServer、webSocketServer 等地址。

    Parameters

    • enableDnsConfig: boolean

      是否启用 DNS。

    Returns void

  • 设置是否开启 TLS 连接。

    该设置只在私有部署时使用。需要在调用 ChatClient#init 之前进行设置。

    Parameters

    • enableTLSConnection: boolean

      是否开启 TLS 连接。

      • true:开启;
      • (默认)false:不开启。

    Returns void

  • 设置是否开启用户信息系统,默认为关闭。

    关闭会影响:

    • 发送消息时不会携带 SenderInfo;
    • ChatMessage.getSenderInfo 返回 undefined
    • 通过 UserInfoManager.fetchUserInfoById 拉取的数据不会更新本地缓存;
    • 通过 UserInfoManager.getUserInfoById 获取不到本地用户信息;
    • 登录成功后不会主动从服务器同步当前用户信息。

    开启后,SDK 会在支持的场景中处理 SenderInfo 和用户信息本地缓存,例如:

    • 消息可通过 ChatMessage.getSenderInfo 获取消息发送者信息。

    需在调用 ChatClient.init 前设置。

    Parameters

    • enableUserInfo: boolean

      是否开启用户信息系统。

      • true:开启;
      • (默认)false:关闭。

    Returns void

  • 设置 Chat 消息服务器地址,一般为私有部署服务,在开发者想实现数据隔离、特别注重数据安全时使用,如有需求请联系商务。

    Parameters

    • imServer: string

      { string } - Chat 消息服务器地址。

    Returns void

  • 设置 Chat 消息服务器端口号,一般为私有部署服务,在开发者想实现数据隔离、特别注重数据安全时使用,如有需求请联系商务。

    Parameters

    • imPort: number

      { number } - 端口号。

    Returns void

  • 设置日志输出等级。

    {
    DEBUG_LEVEL = 0,
    WARNING_LEVEL = 1,
    ERROR_LEVEL = 2
    }

    Parameters

    Returns void

  • 设置当前设备自定义扩展信息。

    未初始化 SDK 或使用自动登录时,需在调用 ChatClient#init 方法之前设置当前设备扩展信息。

    若应用已完成初始化且使用手动登录,若要修改自定义信息,在下次调用 ChatClient#loginChatClient#loginWithToken 之前设置自定义信息。

    Parameters

    • ext: string

      自定义设备扩展信息。长度限制为 1024 个字符。若用户因登录了当前设备而将另一台设备踢下线,向被踢下线设备发通知时会携带当前设备的自定义扩展信息。

    Returns void

  • 设置是否将导入的消息视为已读。

    默认值为 false。

    Parameters

    • regardImportedMsgAsRead: boolean

      是否将导入的消息视为已读。

    Returns void

  • 设置是否需要接收方发送送达回执。

    Parameters

    • isRequireDeliveryAck: boolean

      是否需要送达回执。

      • (默认)true:需要。
      • false:不需要。

    Returns void

  • 设置是否需要接收方发送已读回执。

    Parameters

    • isRequireReadAck: boolean

      是否需要接收方发送已读回执。

      • (默认)true:需要;
      • false:不需要。

    Returns void

  • 设置 REST 服务器地址,一般在开发者想实现数据隔离、特别注重数据安全时使用,如有需求请联系商务获取指定的服务器地址。

    Parameters

    • restServer: string

      { string } - REST 服务器地址。

    Returns void

  • 设置当前 SDK 平台。

    默认为原生平台。

    Parameters

    Returns void

  • 设置是否按照服务器收到的时间对消息进行排序。

    Parameters

    • sortByServerTime: boolean

      是否按照服务器收到的时间对消息进行排序。

      • (默认)true:是;
      • false:否。

    Returns void

  • 设置同步数据的 WebSocket 服务器端口号。

    用于设置数据同步第二通道的服务器端口,一般为私有部署服务使用。

    仅在 setEnableDnsConfig 设为 false 时生效。需在 ChatClient.init 前设置。

    Parameters

    • syncDataWebSocketPort: number

      同步数据的 WebSocket 服务器端口号。

    Returns void

  • 设置同步数据的 WebSocket 服务器地址。

    用于设置数据同步第二通道的服务器地址,一般为私有部署服务使用。

    仅在 setEnableDnsConfig 设为 false 时生效。需在 ChatClient.init 前设置。

    Parameters

    • syncDataWebSocketServer: string

      同步数据的 WebSocket 服务器地址。

    Returns void

  • 设置 UIKit 版本号。

    Parameters

    • version: string

      UIKit 版本号。

    Returns void

  • 设置当发送的文本消息的内容被文本审核(Moderation)服务替换时,是否需要返回给发送方。

    • true:将内容替换后的消息返回给发送方。

    • (默认)false:将原消息返回给发送方。

    该方法只能在调用 ChatClient#init 前才能调用。

    Parameters

    • useReplacedMessageContents: boolean

    Returns void

  • 设置只使用 HTTPS 进行 REST 操作。

    Parameters

    • httpsOnly: boolean

      是否只使用 HTTPS 进行 REST 操作。

      • (默认)true:只使用 HTTPS;
      • false:可以使用 HTTPS 和 HTTP。

    Returns void

  • 设置 WebSocket 服务器端口号。

    一般为私有部署服务,在开发者想实现数据隔离、特别注重数据安全时使用,如有需求请联系商务。

    Parameters

    • webSocketPort: number

      WebSocket 服务器端口号。

    Returns void

  • 设置 WebSocket 服务器地址。

    一般为私有部署服务,在开发者想实现数据隔离、特别注重数据安全时使用,如有需求请联系商务。

    Parameters

    • webSocketServer: string

      WebSocket 服务器地址。

    Returns void

  • 更新应用内下载等路径。

    Parameters

    • appKey: string

      app的标识符。

    • appId: string

      app的标识符。

    Returns void