class  CreateParam
 
class  LoginParam
 

Public 成员函数

bool login (string username, string password, LoginParam loginParam)
 
bool logout ()
 
bool isSelf (string userId)
 
int sendOnlineMessage (string userId, string content)
 

静态 Public 成员函数

static JCClient create (Application app, string appKey, JCClientCallback callback, CreateParam createParam)
 
static void destroy ()
 

属性

CreateParam createParam [get]
 
LoginParam loginParam [get]
 
string displayName [get, set]
 
string userId [get]
 
string serverAddress [get, set]
 
JCClientState state [get]
 
Application app [get]
 
string appkey [get, set]
 

详细描述

全局基础类

主要负责登录登出管理及账户属性存储

成员函数说明

◆ create()

static JCClient JCSDK.JCClient.JCClient.create ( Application  app,
string  appKey,
JCClientCallback  callback,
CreateParam  createParam 
)
static

创建 JCClient 对象

JCClient 的所有接口函数,如无特殊说明,都建议在主线程调用

注解
  • 请确保在调用其他 API 前先调用该方法创建并初始化 JCClient 对象
  • 调用此方法创建 JCClient 对象后,期间没有调用过 destroy 方法销毁对象,然后又重复调用此方法,会直接返回第一次创建的 JCClient 对象
参数
appKey用户从 Juphoon Cloud 平台上申请的 AppKey 字符串。详见 获取 appKey
callbackJCClientCallback 对象,用于回调相关通知
createParam创建参数,传入 null 则按默认值创建,详见 CreateParam
返回
调用方法返回的结果
  • 调用成功时,返回 JCClient 对象
  • 调用失败时,返回 nil
异常
appKey、callback 任意一个参数传空就会返回 null

◆ destroy()

static void JCSDK.JCClient.JCClient.destroy ( )
static

销毁 JCClient 对象

该方法为同步调用,需要等待 JCClient 实例资源释放后才能执行其他操作,调用此方法后,你将无法再使用 SDK 的其它方法和回调。
此模块为基础模块,所以需要在销毁其他模块的对象后,再调用此方法来销毁 JCClient 对象。此外,我们 不建议JCSDK 的回调中调用此方法销毁 JCClient 对象,否则会出现崩溃。
如需在销毁后再次创建 JCClient 实例,需要等待 destroy 方法执行结束后再创建实例。

◆ isSelf()

bool JCSDK.JCClient.JCClient.isSelf ( string  userId)

根据用户标识判断是否为自己

参数
userId用户标识
返回
是否为自己

◆ login()

bool JCSDK.JCClient.JCClient.login ( string  username,
string  password,
LoginParam  loginParam 
)

登录 Juphoon Cloud 平台

只有登录成功后才能进行平台上的各种业务

参数
userId用户名,长度在 64 字节以内的字符串。以下为支持的字符集范围(共 66 个字符):
  • 26 个小写英文字母 a-z
  • 26 个大写英文字母 A-Z
  • 10 个数字 0-9
  • '+','-','_','.'。另外 '-','_','.' 这三个字符不能处于用户名的第一位
password密码,不能为 nil 或 "",长度不能超过 128 字符。免鉴权模式密码可以随意输入,Token 鉴权模式密码需要输入外部生成的 Token
loginParam登录参数,一般不需要设置,如需设置请询问客服,传 null 则按默认值,详见 LoginParam
返回
调用是否成功
  • true:正常执行调用流程,登录结果通过 onLogin 通知
  • false:调用异常,不会收到 onLogin 通知

◆ logout()

bool JCSDK.JCClient.JCClient.logout ( )

登出 Juphoon Cloud 平台

登出后不能进行平台上的各种业务

返回
调用是否成功
  • true:正常执行调用流程,登出结果通过 onLogout 通知
  • false:调用失败,不会收到 onLogout 通知

◆ sendOnlineMessage()

int JCSDK.JCClient.JCClient.sendOnlineMessage ( string  userId,
string  content 
)

发送在线消息

消息发送结果通过 onOnlineMessageSendResult 通知

注解
  • 当前对方只有在线才能收到此消息
  • 此接口调用频次限制 100次/分钟
参数
userId对方的 userId
content要发送的消息内容
返回
  • >0:成功返回操作id,与回调中的 operationId 一致
  • -1:失败,不会触发消息发送结果回调

属性说明

◆ app

Application JCSDK.JCClient.JCClient.app
get

获取 Application 实例

得到的 Application 对象是调用 create 方法时传入

◆ appkey

string JCSDK.JCClient.JCClient.appkey
getset

获取 appkey

得到的 appkey 是调用 create 方法时传入的

◆ createParam

CreateParam JCSDK.JCClient.JCClient.createParam
get

获取创建参数

得到的创建参数就是用户在调用 create 方法时传入的 createParam 参数

若用户在调用 create 方法时,createParam 传入了 null,则返回默认的 CreateParam 对象

◆ displayName

string JCSDK.JCClient.JCClient.displayName
getset

获取/设置自己的昵称

在发起呼叫、加入频道、发送消息时,都会将自己的昵称发送给其他用户

注解
每次调用 create 初始化 SDK 后都需要重新设置

◆ loginParam

LoginParam JCSDK.JCClient.JCClient.loginParam
get

获取登录参数

得到的登录参数就是用户在调用 login 方法时传入的 loginParam 参数
若用户在调用 login 方法时, loginParam 传入了 null,则将返回默认的 LoginParam 对象
需要注意的是只有用户状态为登录中或已登录时才能获取到值,其他状态将返回 null

◆ serverAddress

string JCSDK.JCClient.JCClient.serverAddress
getset

获取/设置登录服务器地址

默认地址为 http:cn.router.justalkcloud.com:8080(国内环境)。如果是海外用户需要设置为 http:intl.router.justalkcloud.com:8080(国际环境)
该属性需要在调用登录方法 login 之前进行设置。

◆ state

JCClientState JCSDK.JCClient.JCClient.state
get

获取当前登录状态

◆ userId

string JCSDK.JCClient.JCClient.userId
get

获取用户标识

得到的的用户标识就是用户在调用 login 方法时传入的 userId 参数
需要注意的是只有用户状态为登录中或已登录才能获取到值,其他状态将返回 null


该类的文档由以下文件生成:
  • JCSDK/JCSDK/JCClient/JCClient.cs