Chat SDK for Unity and Windows v1.3.2
Public 成员函数 | 静态 Public 成员函数 | Public 属性 | 属性 | 所有成员列表
AgoraChat.Options类 参考
类 AgoraChat.Options 继承关系图:

Public 成员函数

 Options (string appKey)
 

静态 Public 成员函数

static Options InitOptionsWithAppKey (string appKey)
 
static Options InitOptionsWithAppId (string appId)
 

Public 属性

string DNSURL = ""
 
string IMServer = ""
 
string RestServer = ""
 
int IMPort = 0
 
bool EnableDNSConfig = true
 
bool DebugMode = false
 
bool AutoLogin = false
 
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 = true
 
bool ServerTransfer = true
 
bool IsAutoDownload = true
 
bool EnableEmptyConversation = false
 
bool UseReplacedMessageContents = false
 
bool IncludeSendMessageInMessageListener = false
 
int CustomOSType = -1
 
string CustomDeviceName = ""
 
string LoginCustomExt = ""
 
AreaCode AreaCode = AreaCode.GLOB
 
string MyUUID = ""
 
bool RegardImportMsgAsRead = false
 
string SDKDataPath = ""
 

属性

string AppKey = "" [get, set]
 
string AppId = "" [get, set]
 

详细描述

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

构造及析构函数说明

◆ Options()

AgoraChat.Options.Options ( string  appKey)

Options 构造方法。

参数
appKeyApp Key。

成员函数说明

◆ InitOptionsWithAppKey()

static Options AgoraChat.Options.InitOptionsWithAppKey ( string  appKey)
static

使用Appkey构造Options。

参数
appKeyApp Key。
return返回Options对象。

◆ InitOptionsWithAppId()

static Options AgoraChat.Options.InitOptionsWithAppId ( string  appId)
static

使用AppId构造Options。

参数
appIdApp Id。
return返回Options对象。

类成员变量说明

◆ DNSURL

string AgoraChat.Options.DNSURL = ""

DNS 服务器的地址。

◆ IMServer

string AgoraChat.Options.IMServer = ""

IM 消息服务器地址。

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

如有需求，请联系商务。

◆ RestServer

string AgoraChat.Options.RestServer = ""

REST 服务器地址。

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

如有需求，请联系商务。

◆ IMPort

int AgoraChat.Options.IMPort = 0

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

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

如有需求，请联系商务。

◆ EnableDNSConfig

bool AgoraChat.Options.EnableDNSConfig = true

设置是否开启 DNS。

  • （默认） true：开启。
  • false：关闭。私有部署时需要关闭。

◆ DebugMode

bool AgoraChat.Options.DebugMode = false

是否输出调试信息。

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

◆ AutoLogin

bool AgoraChat.Options.AutoLogin = false

是否开启自动登录。

  • true：开启；
  • （默认）false：关闭。

◆ AcceptInvitationAlways

bool AgoraChat.Options.AcceptInvitationAlways = false

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

  • true：是。
  • （默认） false：否。

◆ AutoAcceptGroupInvitation

bool AgoraChat.Options.AutoAcceptGroupInvitation = false

是否自动接受群组邀请。

  • （默认） true：是。
  • false：否。

◆ RequireAck

bool AgoraChat.Options.RequireAck = true

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

  • （默认） true：是；
  • false：否。

◆ RequireDeliveryAck

bool AgoraChat.Options.RequireDeliveryAck = false

是否需要接收方发送送达回执。 -（默认）true：是；

  • false：否。

◆ DeleteMessagesAsExitGroup

bool AgoraChat.Options.DeleteMessagesAsExitGroup = true

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

  • （默认） true: 是；
  • false: 否

◆ DeleteMessagesAsExitRoom

bool AgoraChat.Options.DeleteMessagesAsExitRoom = true

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

  • （默认） true: 是；
  • false：否

◆ IsRoomOwnerLeaveAllowed

bool AgoraChat.Options.IsRoomOwnerLeaveAllowed = true

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

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

◆ SortMessageByServerTime

bool AgoraChat.Options.SortMessageByServerTime = true

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

  • （默认） true：是；
  • false：否。按消息创建时间的倒序排序。

◆ UsingHttpsOnly

bool AgoraChat.Options.UsingHttpsOnly = true

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

  • （默认） true：是；
  • false：否。支持 HTTPS 和 HTTP。

◆ ServerTransfer

bool AgoraChat.Options.ServerTransfer = true

是否自动将消息附件上传到聊天服务器。 -（默认）true：是；

  • false：否。。

◆ IsAutoDownload

bool AgoraChat.Options.IsAutoDownload = true

是否自动下载缩略图。

  • （默认） true：是；
  • false：否。

◆ EnableEmptyConversation

bool AgoraChat.Options.EnableEmptyConversation = false

从数据库加载会话时，是否允许加载空会话。

  • true：是；
  • （默认）false：否。

◆ UseReplacedMessageContents

bool AgoraChat.Options.UseReplacedMessageContents = false

是否在文本审核时，返回给发送者被替换内容的文本消息。

  • true：将内容替换后的消息返回给发送方。
  • （默认）false：将原消息返回给发送方。

◆ IncludeSendMessageInMessageListener

bool AgoraChat.Options.IncludeSendMessageInMessageListener = false

设置发送成功的消息是否在 IChatManagerDelegate#OnMessagesReceived 中回调给用户。

  • true：是；
  • （默认）false：否。

◆ CustomOSType

int AgoraChat.Options.CustomOSType = -1

自定义系统类型。

◆ CustomDeviceName

string AgoraChat.Options.CustomDeviceName = ""

自定义设备名称。

◆ LoginCustomExt

string AgoraChat.Options.LoginCustomExt = ""

自定义扩展消息，用于多设备登录时，通知被踢设备。

◆ AreaCode

AreaCode AgoraChat.Options.AreaCode = AreaCode.GLOB

设置区域代号，使用边缘节点时遵循区域限制。

（默认）GLOB: 不限制区域。

◆ MyUUID

string AgoraChat.Options.MyUUID = ""

当前设备的 UUID。

◆ RegardImportMsgAsRead

bool AgoraChat.Options.RegardImportMsgAsRead = false

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

  • true：是；
  • （默认）false：否。

◆ SDKDataPath

string AgoraChat.Options.SDKDataPath = ""

设置 SDK 底层数据存储路径。仅用于 MacOS 和 Windows 平台端。

如果未设置，则由 SDK 设置为缺省路径。

注意： 对于 Unity SDK，在 1.1.2 版本之前，SDKDataPath 为当前路径，即 "."，从 1.1.2 开始变更为持久化目录 Application.persistentDataPath， 若从 1.1.2 之前的 SDK 版本进行升级，而且需要保留本地历史消息，可使用以下两种方式：

  • 方式一：将 SDKDataPath 设置为当前路径，即 "."；
  • 方式二：将原来当前路径下的 sdkdata 文件夹拷贝到 Application.persistentDataPath 中。 对于 Windows SDK，SDKDataPath 仍使用缺省的当前路径，即 "."。

举例如下: MacOS: /Users/UserName/Library/Application Support/DefaultCompany/xxx Windows: C:/Users/UserName/AppData/LocalLow/DefaultCompany/xxx

若数据存储路径以文件夹结尾，无需添加 “/”。

注意: 在 MacOS 下，如果使用相对路径设置 SDKDatapath，必须使用"."开头，例如: "./sdkdatapath"。

属性说明

◆ AppKey

string AgoraChat.Options.AppKey = ""
getset

创建 App 时在 console 后台上注册的 App 唯一识别符，即 App Key。不能和AppId同时使用。

◆ AppId

string AgoraChat.Options.AppId = ""
getset

创建 App 时在 console 后台上注册的 App 唯一识别符，即 App Id。不能和AppKey同时使用。

制作者 doxygen 1.9.4