登录登出管理更多...

#import <JRTCClient.h>

构造函数
(void)	- setForeground:

(bool)	- login:password:

(bool)	- login:password:loginParam:

(bool)	- relogin:password:

(bool)	- logout

(int)	- sendOnlineMessage:userId:

(JRTCP2PSession *_Nonnull)	- createP2PSession

(bool)	- getUploadUrl:

(int)	- requestFileUploadInfo:requestFileUploadParam:

(int)	- completeFileUpload:completeFileUploadParam:

(int)	- getUploadFileInfo:extraInfo:

类方法
(JRTCClient *_Nullable)	+ create:initParam:

(void)	+ destroy

属性
NSString *_Nullable	userId

NSString *_Nullable	displayName

NSString *_Nullable	appKey

NSString *_Nullable	server

NSString *_Nullable	appName

JRTCClientState	state

详细描述

登录登出管理

函数文档

◆ completeFileUpload:completeFileUploadParam:

- (int) completeFileUpload:	(NSString *_Nonnull)	serialId
completeFileUploadParam:	(JRTCCompleteFileUploadParam *_Nonnull)	completeFileUploadParam

文件上传完成确认

注解: 通过 http 上传文件完成后，需要调用该接口确认完成，否则上传文件将无法在平台查询到

参数

serialId	业务id，必选，如果是通话业务相关文件，需要传通话唯一标识 callId
completeFileUploadParam	文件上传完成确认参数，必选

返回

接口调用结果

操作id: 接口调用成功，对应 result:fileName:extraInfo:fileType:reason: onCompleteFileUploadResponse 回调的 operatorId 参数
-1: 接口调用异常，不会收到回调

参见: JRTCCompleteFileUploadParam

◆ create:initParam:

+ (JRTCClient *_Nullable) create:	(id< JRTCClientCallback > _Nonnull)	callback
initParam:	(JRTCClientInitParam *_Nullable)	initParam

创建 JRTCClient 实例

参数

callback	回调接口，用于接收 JRTCClient 相关通知
initParam	初始化参数，没有则填nil

返回: JRTCClient 对象

◆ createP2PSession

- (JRTCP2PSession *_Nonnull) createP2PSession

创建P2P通道实例

返回: P2P通道实例

◆ destroy

+ (void) destroy

销毁 JRTCClient 对象

注解

调用此方法后，你将无法再使用 JRTCClient 的其他方法和回调
我们不建议在 JRTCSDK 的回调中调用此方法销毁 JRTCClient 对象，否则可能出现崩溃

◆ getUploadFileInfo:extraInfo:

- (int) getUploadFileInfo:	(NSString *_Nonnull)	serialId
extraInfo:	(NSDictionary< NSString , id > _Nullable)	extraInfo

获取上传文件信息列表

注解: 查询返回所有和该业务唯一标识相关的文件信息列表

参数

serialId	业务id，必选，如果是通话业务相关文件，需要传通话唯一标识 callId
extraInfo	随路参数

返回

接口调用结果

操作id: 接口调用成功，对应 onGetUploadFileInfoResponse 回调的 operatorId 参数
-1: 接口调用异常，不会收到回调

◆ getUploadUrl:

- (bool) getUploadUrl: (NSString *_Nullable) fileId

获取文件上传路径

调用此接口，fileId 非必须指定时可传空字符串
调用成功后，文件上传路径等具体信息可通过 onGetUploadUrlResponse 回调获取

参数

fileId 文件 id

注解: 文件 id 用于断点续传，第二次续传文件时需要传递前一次获取到的 fileId 首次新文件上传，建议传空，fileId由服务器自动生成下发

返回

接口调用结果

true: 接口调用成功
false: 接口调用异常

◆ login:password:

- (bool) login:	(NSString *_Nonnull)	userId
password:	(NSString *_Nonnull)	password

登录 Juphoon RTC 平台，只有登录成功后才能进行平台上的各种业务登录结果通过 onLogin 回调通知

参数

userId	用户ID
password	密码，不能为空

返回

接口调用结果

true: 接口调用成功
false: 接口调用异常

警告: 目前只支持免鉴权模式，服务器不校验账号密码，免鉴权模式下当账号不存在时会自动去创建该账号; 用户名为英文数字和'+' '-' '_' '.'，长度不要超过64字符，'-' '_' '.'不能作为第一个字符

◆ login:password:loginParam:

- (bool) login:	(NSString *_Nonnull)	userId
password:	(NSString *_Nonnull)	password
loginParam:	(JRTCClientLoginParam *_Nullable)	loginParam

登录 Juphoon RTC 平台，只有登录成功后才能进行平台上的各种业务登录结果通过 onLogin 回调通知

参数

userId	用户ID
password	密码，不能为空
loginParam	登录参数，一般不需要设置，如需设置请询问客服，传 nil 则按默认值，详见 JRTCClientLoginParam

返回

接口调用结果

true: 接口调用成功
false: 接口调用异常

警告: 目前只支持免鉴权模式，服务器不校验账号密码，免鉴权模式下当账号不存在时会自动去创建该账号; 用户名为英文数字和'+' '-' '_' '.'，长度不要超过64字符，'-' '_' '.'不能作为第一个字符

◆ logout

- (bool) logout

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

登出结果通过 onLogout 回调通知

返回

接口调用结果

true: 接口调用成功
false: 接口调用异常

◆ relogin:password:

- (bool) relogin:	(NSString *_Nonnull)	userId
password:	(NSString *_Nonnull)	password

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

参数

password 密码，不能为空

返回

接口调用结果

true: 接口调用成功
false: 接口调用异常

◆ requestFileUploadInfo:requestFileUploadParam:

- (int) requestFileUploadInfo:	(NSString *_Nonnull)	serialId
requestFileUploadParam:	(JRTCRequestFileUploadParam *_Nonnull)	requestFileUploadParam

获取文件上传或断点续传信息

注解: 目前仅支持视频和图片类型文件上传，服务端会通过文件后缀名判断

参数

serialId	业务id，必选，如果是通话业务相关文件，需要传通话唯一标识 callId
requestFileUploadParam	请求文件上传信息参数，必选

返回

接口调用结果

操作id: 接口调用成功，对应 onRequestFileUploadInfoResponse 回调的 operatorId 参数
-1: 接口调用异常，不会收到回调

◆ sendOnlineMessage:userId:

- (int) sendOnlineMessage:	(NSString *_Nonnull)	message
userId:	(NSString *_Nonnull)	userId

发送在线消息，消息内容不能大于4K

参数

message	消息内容
userId	对端的用户名

返回

接口调用结果

操作ID: 接口调用成功，对应 onOnlineMessageSendResult 回调的 operatorId 参数
-1: 接口调用异常，不会收到回调

◆ setForeground:

- (void) setForeground: (bool) foreground

设置是否是前台

参数

foreground

true: 设置为前台
false: 设置为后台

属性说明

◆ appKey

- (NSString* _Nullable) appKey

readwritenonatomiccopy

用户从 Juphoon RTC 平台上申请的 AppKey 字符串

◆ appName

- (NSString* _Nullable) appName

readwritenonatomiccopy

应用名称

◆ displayName

- (NSString* _Nullable) displayName

readwritenonatomiccopy

昵称，用于通话，消息等，可以更直观的表明身份，默认为用户ID，即 userId

◆ server

- (NSString* _Nullable) server

readwritenonatomiccopy

接入服务器地址

◆ state

- (JRTCClientState) state

readnonatomicassign

当前登录状态

◆ userId

- (NSString* _Nullable) userId

readnonatomiccopy

用户ID

警告: 当 state > JRTCClientStateIdle 该值有效

构造函数

类方法

属性

详细描述

函数文档

◆ completeFileUpload:completeFileUploadParam:

◆ create:initParam:

◆ createP2PSession

◆ destroy

◆ getUploadFileInfo:extraInfo:

◆ getUploadUrl:

◆ login:password:

◆ login:password:loginParam:

◆ logout

◆ relogin:password:

◆ requestFileUploadInfo:requestFileUploadParam:

◆ sendOnlineMessage:userId:

◆ setForeground:

属性说明

◆ appKey

◆ appName

◆ displayName

◆ server

◆ state

◆ userId