Unity and Windows API reference
Public 成员函数 | Public 属性 | 所有成员列表
ChatSDK.Options类 参考

Public 成员函数

 Options (string appKey)
 

Public 属性

string AppKey = ""
 
string DNSURL = ""
 
string IMServer = ""
 
string RestServer = ""
 
int IMPort = 0
 
bool EnableDNSConfig = true
 
bool DebugMode = false
 
bool AutoLogin = true
 
bool AcceptInvitationAlways = false
 
bool AutoAcceptGroupInvitation = false
 
bool RequireAck = true
 
bool RequireDeliveryAck = false
 
bool DeleteMessagesAsExitGroup = true
 
bool DeleteMessagesAsExitRoom = true
 
bool IsRoomOwnerLeaveAllowed = true
 
bool SortMessageByServerTime = true
 
bool UsingHttpsOnly = false
 
bool ServerTransfer = true
 
bool IsAutoDownload = true
 

详细描述

聊天设置类,用于定义 SDK 的各种参数和选项,例如,是否自动接受加好友邀请以及是否自动下载缩略图。

构造及析构函数说明

◆ Options()

ChatSDK.Options.Options ( string  appKey)

Options 构造方法。

参数
appKeyApp Key。

类成员变量说明

◆ AppKey

string ChatSDK.Options.AppKey = ""

创建 App 时在 console 后台上注册的 App 唯一识别符,即 App Key。

◆ DNSURL

string ChatSDK.Options.DNSURL = ""

DNS 服务器的地址。

◆ IMServer

string ChatSDK.Options.IMServer = ""

IM 消息服务器地址。

该地址在进行私有部署时实现数据隔离和数据安全时使用。

如有需求,请联系商务。

◆ RestServer

string ChatSDK.Options.RestServer = ""

REST 服务器地址。

该地址在进行私有部署时实现数据隔离和数据安全时使用。

如有需求,请联系商务。

◆ IMPort

int ChatSDK.Options.IMPort = 0

IM 消息服务器的自定义端口号。

该端口在进行私有部署时实现数据隔离和数据安全时使用。

如有需求,请联系商务。

◆ EnableDNSConfig

bool ChatSDK.Options.EnableDNSConfig = true

设置是否开启 DNS。

  • (默认) true:开启。
  • false:关闭。私有部署时需要关闭。

◆ DebugMode

bool ChatSDK.Options.DebugMode = false

是否输出调试信息。

  • true: SDK 会在日志里输出调试信息。
  • (默认) false: SDK 不输出调试信息。

◆ AutoLogin

bool ChatSDK.Options.AutoLogin = true

是否开启自动登录。 -(默认) true:开启;

  • false:关闭。

◆ AcceptInvitationAlways

bool ChatSDK.Options.AcceptInvitationAlways = false

是否自动接受加好友邀请。

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

◆ AutoAcceptGroupInvitation

bool ChatSDK.Options.AutoAcceptGroupInvitation = false

是否自动接受群组邀请。

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

◆ RequireAck

bool ChatSDK.Options.RequireAck = true

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

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

◆ RequireDeliveryAck

bool ChatSDK.Options.RequireDeliveryAck = false

是否需要接收方发送送达回执。 -(默认)true:是;

  • false:否。

◆ DeleteMessagesAsExitGroup

bool ChatSDK.Options.DeleteMessagesAsExitGroup = true

是否在退出(主动或被动)群组时删除该群组中在内存和本地数据库中的历史消息。

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

◆ DeleteMessagesAsExitRoom

bool ChatSDK.Options.DeleteMessagesAsExitRoom = true

是否在退出(主动或被动)聊天室时删除该聊天室在内存和本地数据库中的历史消息。

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

◆ IsRoomOwnerLeaveAllowed

bool ChatSDK.Options.IsRoomOwnerLeaveAllowed = true

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

  • (默认) true: 允许。离开聊天室后,聊天室所有者除了接收不到该聊天室的消息,其他权限不变。
  • false: 不允许。

◆ SortMessageByServerTime

bool ChatSDK.Options.SortMessageByServerTime = true

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

  • (默认) true:是;
  • false:否。按消息创建时间的倒序排序。

◆ UsingHttpsOnly

bool ChatSDK.Options.UsingHttpsOnly = false

是否只通过 HTTPS 进行 REST 操作。

  • (默认) true:是;
  • false:否。支持 HTTPS 和 HTTP。

◆ ServerTransfer

bool ChatSDK.Options.ServerTransfer = true

是否自动将消息附件上传到聊天服务器。 -(默认)true:是;

  • false:否。。

◆ IsAutoDownload

bool ChatSDK.Options.IsAutoDownload = true

是否自动下载缩略图。

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