此类主要用来管理用户登录 更多...

Public 成员函数

bool Login (string username, string password)
 登陆 Juphoon Cloud 平台,只有登陆成功后才能进行平台上的各种业务 登陆结果通过 JCCallCallback 通知 更多...
 
bool ReLogin (string username, string password)
 重登录,该接口在如果有其他同类型终端登录着则会登录失败,一般用于记住了账号后重启自动登录逻辑 更多...
 
bool Login (bool autoLogin, string accountType, string account, string password)
 登陆 Juphoon Cloud 平台,只有登陆成功后才能进行平台上的各种业务 服务器分为鉴权模式和非鉴权模式 更多...
 
bool Logout ()
 登出 Juphoon Cloud 平台,登出后不能进行平台上的各种业务 更多...
 
bool SetConfig< T > (string key, T value)
 设置登录相关属性 更多...
 
GetConfig< T > (string key)
 获取设置属性的值 更多...
 
bool IsSelf (string userId)
 是否为自己 更多...
 
void OnNetChange (int newNetType, int oldNetType)
 
void AddCallback (JCClientCallback callback)
 添加回调 更多...
 
void RemoveCallback (JCClientCallback callback)
 删除回调 更多...
 

静态 Public 成员函数

static JCClient Create (Application app, string appKey, JCClientCallback callback, Dictionary< string, string > extraParams)
 创建 JCClient 实例 更多...
 
static void Destroy ()
 销毁 JCClient 实例 更多...
 

Public 属性

Action< string, string, int > MtcNotify
 调用Mtc接口时,对于的通知。第一个参数通知name,第二个参数通知携带的信息,第三个cookie。 更多...
 

属性

string DisplayName [get, set]
 昵称,用于通话,消息等,可以更直观的标明身份 更多...
 
string UserId [get]
 用户标识,当 state > JCClientStateIdle 该值有效 更多...
 
JCClientState State [get]
 当前状态 更多...
 
Application App [get]
 Application实例 更多...
 

详细描述

此类主要用来管理用户登录

成员函数说明

◆ AddCallback()

void JMSDK.JCClient.JCClient.AddCallback ( JCClientCallback  callback)
inline

添加回调

参数
callback

◆ Create()

static JCClient JMSDK.JCClient.JCClient.Create ( Application  app,
string  appKey,
JCClientCallback  callback,
Dictionary< string, string >  extraParams 
)
inlinestatic

创建 JCClient 实例

参数
appKey用户从 Juphoon Cloud 平台申请的 AppKey 字符串
callback回调接口,用于接收 JCClient 相关通知
extraParams额外参数,没有则填 null,key值参见 JCClientConstants 中 JCClientCreateExtra* 相关定义
app创建实例依赖的程序APP
返回
创建成功则返回创建的实例,否则返回null

◆ Destroy()

static void JMSDK.JCClient.JCClient.Destroy ( )
inlinestatic

销毁 JCClient 实例

◆ GetConfig< T >()

T JMSDK.JCClient.JCClient.GetConfig< T > ( string  key)
inline

获取设置属性的值

参数
key需要获取的属性key值
返回
需要获取的属性值

◆ IsSelf()

bool JMSDK.JCClient.JCClient.IsSelf ( string  userId)
inline

是否为自己

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

◆ Login() [1/2]

bool JMSDK.JCClient.JCClient.Login ( bool  autoLogin,
string  accountType,
string  account,
string  password 
)
inline

登陆 Juphoon Cloud 平台,只有登陆成功后才能进行平台上的各种业务 服务器分为鉴权模式和非鉴权模式

  • 鉴权模式: 服务器会检查用户名和密码
  • 免鉴权模式: 只要用户保证用户标识唯一即可, 服务器不校验 登陆结果通过 JCCallCallback 通知
参数
autoLogin是否自动登录
accountType账号类型,具体参考 JCAccountConstants.h 的定义(如 JCAccountTypePhone)
account用户名为英文数字和'+' '-' '_' '.',长度不要超过64字符,'-' '_' '.'不能作为第一个字符
password密码,免鉴权模式密码可以随意输入,但不能为空
返回
返回 true 表示正常执行调用流程,false 表示调用异常,异常错误通过 JCClientCallback 通知

◆ Login() [2/2]

bool JMSDK.JCClient.JCClient.Login ( string  username,
string  password 
)
inline

登陆 Juphoon Cloud 平台,只有登陆成功后才能进行平台上的各种业务 登陆结果通过 JCCallCallback 通知

参数
username用户标识
password密码,不能为空
返回
true 表示正常执行调用流程,false 表示调用异常

注意:用户名为英文数字和'+' '-' '_' '.',长度不要超过64字符, '-' '_' '.'不能作为首字符

当用户不存在时会自动创建该用户

◆ Logout()

bool JMSDK.JCClient.JCClient.Logout ( )
inline

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

返回
返回 true 表示正常执行调用流程,false 表示调用异常,异常错误通过 JCClientCallback 通知

◆ ReLogin()

bool JMSDK.JCClient.JCClient.ReLogin ( string  username,
string  password 
)
inline

重登录,该接口在如果有其他同类型终端登录着则会登录失败,一般用于记住了账号后重启自动登录逻辑

参数
username用户名
password密码,免鉴权模式密码可以随意输入,但不能为空
返回
返回 true 表示正常执行调用流程,false 表示调用异常,异常错误通过 JCClientCallback 通知

◆ RemoveCallback()

void JMSDK.JCClient.JCClient.RemoveCallback ( JCClientCallback  callback)
inline

删除回调

参数
callback

◆ SetConfig< T >()

bool JMSDK.JCClient.JCClient.SetConfig< T > ( string  key,
value 
)
inline

设置登录相关属性

参数
key设置的属性key值
value设置的属性对应值
返回
返回 ture 表示设置成功,false设置失败

类成员变量说明

◆ MtcNotify

Action<string, string, int> JMSDK.JCClient.JCClient.MtcNotify

调用Mtc接口时,对于的通知。第一个参数通知name,第二个参数通知携带的信息,第三个cookie。

属性说明

◆ App

Application JMSDK.JCClient.JCClient.App
get

Application实例

◆ DisplayName

string JMSDK.JCClient.JCClient.DisplayName
getset

昵称,用于通话,消息等,可以更直观的标明身份

◆ State

JCClientState JMSDK.JCClient.JCClient.State
get

当前状态

◆ UserId

string JMSDK.JCClient.JCClient.UserId
get

用户标识,当 state > JCClientStateIdle 该值有效


该类的文档由以下文件生成:
  • C:/code/Windows/SDK/Windows/JMSDK/JMSDK/JCCommon/JCClient/JCClient.cs