客户端 API > C++
概览JCClientJCClientCallbackJCMediaDeviceJCMediaDeviceCallbackJCCallJCCallCallbackJCMediaChannelJCMediaChannelCallback错误码

#include <JCClient.h>

Public 成员函数

virtual void setDisplayName (const char *displayName)=0
 
virtual const char * getDisplayName ()=0
 
virtual const char * getUserId ()=0
 
virtual JCClientState getState ()=0
 
virtual const char * getAppkey ()=0
 
virtual JCClientCreateParam * getCreateParam ()=0
 
virtual JCClientLoginParam * getLoginParam ()=0
 
virtual bool login (const char *userId, const char *password, JCClientLoginParam *loginParam)=0
 
virtual void setServerAddress (const char *serverAddress)=0
 
virtual const char * getServerAddress ()=0
 
virtual bool logout ()=0
 
virtual int sendOnlineMessage (const char *userId, const char *content)=0
 
virtual void driveEvent (void *event)=0
 

详细描述

用于初始化sdk以及登录 Juphoon Cloud 平台

成员函数说明

◆ driveEvent()

virtual void JCClient::driveEvent ( void *  event)
pure virtual

驱动底层事件上报，一般在UI线程驱动

参数
event事件指针，从 JCClientCallback::onDriveEvent 回调中获得

◆ getAppkey()

virtual const char * JCClient::getAppkey ( )
pure virtual

获取Appkey

返回的Appkey是由 createJCClient 方法传入的

返回
Appkey

◆ getCreateParam()

virtual JCClientCreateParam * JCClient::getCreateParam ( )
pure virtual

获取创建参数

返回的创建参数就是用户在调用 createJCClient 方法时传入的 JCClientCreateParam 参数，若用户在调用 createJCClient 方法时， JCClientCreateParam 传入了 NULL，则返回默认的 JCClientCreateParam 对象

返回
JCClientCreateParam 创建参数对象

◆ getDisplayName()

virtual const char * JCClient::getDisplayName ( )
pure virtual

获取自己的昵称

返回
自己的昵称

◆ getLoginParam()

virtual JCClientLoginParam * JCClient::getLoginParam ( )
pure virtual

获取登录参数

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

返回
JCClientLoginParam 登录参数对象

◆ getServerAddress()

virtual const char * JCClient::getServerAddress ( )
pure virtual

获取登录服务器地址

返回的登录地址就是用户在调用 setServerAddress 方法时传入的 serverAddress 参数，若用户未调用 setServerAddress 方法，将返回默认国内地址 http:cn.router.justalkcloud.com:8080。

返回
登录服务器地址

◆ getState()

virtual JCClientState JCClient::getState ( )
pure virtual

获取当前登录状态

返回
当前登录状态：

◆ getUserId()

virtual const char * JCClient::getUserId ( )
pure virtual

获得用户标识

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

返回
用户标识

◆ login()

virtual bool JCClient::login ( const char *  userId,
const char *  password,
JCClientLoginParam *  loginParam 
)
pure virtual

登录 Juphoon Cloud 平台

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

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

◆ logout()

virtual bool JCClient::logout ( )
pure virtual

登出 Juphoon Cloud 平台

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

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

◆ sendOnlineMessage()

virtual int JCClient::sendOnlineMessage ( const char *  userId,
const char *  content 
)
pure virtual

发送在线消息

消息发送结果通过 onOnlineMessageSendResult 通知

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

◆ setDisplayName()

virtual void JCClient::setDisplayName ( const char *  displayName)
pure virtual

设置自己的昵称

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

注解
  • 每次调用 create 方法初始化 SDK 后都需要重新设置
  • 不支持 IOT 设备
参数
displayName要设置的昵称

◆ setServerAddress()

virtual void JCClient::setServerAddress ( const char *  serverAddress)
pure virtual

设置登录服务器地址

参数
serverAddress登录服务器地址，默认地址为 http:cn.router.justalkcloud.com:8080（国内环境）。如果是海外用户需要设置为 http:intl.router.justalkcloud.com:8080（国际环境）
该类的文档由以下文件生成:
最后更新时间: 2024/8/7 17:15:00