快速开始

/**
 *  @brief 创建 JCClient 实例
 *  @param appKey       用户从 菊风云 平台上申请的 AppKey 字符串
 *  @param callback     回调接口，用于接收 JCClient 相关通知
 *  @param extraParams  额外参数，没有则填nil
 *  @return JCClient 对象
 */
+(JCClient*)create:(NSString*)appKey callback:(id<JCClientCallback>)callback extraParams:(NSDictionary*)extraParams;

- (BOOL)application:(UIApplication *)application didFinishLaunchingWithOptions:(NSDictionary *)launchOptions
{
    // 初始化各模块，因为这些模块实例将被频繁使用，建议声明在单例中
    JCClient *client = [JCClient create:@"your appkey" callback:self extraParams:nil];
    return YES;
}

/**
 *  @brief 设置配置相关参数
 *  JCClientConfigServer, JCClientConfigHttpsProxy 均需要在 login 之前调用
 *  @param key   参数关键字, 参见 JCClientConstants 中定义
 *  @param value 参数值
 *  @return 返回 true 表示设置成功，false 表示设置失败
 */
-(bool)setConfig:(NSString*)key value:(NSString*)value;

/// 服务器
extern NSString* const JCClientConfigServer;
/// 设备标识，用户可以自己传入设备标识
extern NSString* const JCClientConfigDeviceId;
/// https代理, 例如 192.168.1.100:3128
extern NSString* const JCClientConfigHttpsProxy;

JCClient *client = [JCClient create:@"your appkey" callback:self extraParams:nil];
// 设置登录地址（国内环境）
[client setConfig:JCClientConfigServer value:@"http:cn.router.justalkcloud.com:8080"];
// 设置登录地址（国际环境）
[client setConfig:JCClientConfigServer value:@"http:intl.router.justalkcloud.com:8080"];

/**
 *  @brief 获取配置相关参数
 *  @param key 参数关键字, 参见 JCClientConstants 中定义
 *  @return 成功返回字符串类型具体值, 失败返回 NULL
 */
-(NSString*)getConfig:(NSString*)key;

// 获取登录配置
[client getConfig:JCClientConfigServer];

/**
 *  @brief 登录
 *  @param userId   用户名
 *  @param password 密码，免鉴权模式密码可以随意输入，但不能为空
 *  @return 返回 true 表示正常执行调用流程，false 表示调用异常，异常错误通过 JCClientCallback 通知
 *  @warning 目前只支持免鉴权模式，免鉴权模式下当账号不存在时会自动去创建该账号
 *  @warning 用户名为英文、数字和'+' '-' '_' '.'，长度不要超过64字符，'-' '_' '.'不能作为第一个字符
 */
-(bool)login:(NSString*)userId password:(NSString*)password;

// 登录
[client login:@"userId" password:@"your password"];

/**
   *  @brief 登录结果回调
   *  @param result  true 表示登录成功，false 表示登录失败
   *  @param reason  当 result 为 false 时该值有效
   *  @see JCClientReason
   */
  -(void)onLogin:(bool)result reason:(JCClientReason)reason;
  

/// 正常
JCClientReasonNone,
/// sdk 未初始化
JCClientReasonSDKNotInit,
/// 无效的参数
JCClientReasonInvalidParam,
/// 函数调用失败
JCClientReasonCallFunctionError,
/// 当前状态无法再次登录
JCClientReasonStateCannotLogin,
/// 超时
JCClientReasonTimeOut,
/// 网络异常
JCClientReasonNetWork,
/// appkey 错误
JCClientReasonAppKey,
/// 账号密码错误
JCClientReasonAuth,
/// 无该用户
JCClientReasonNoUser,
/// 被强制登出
JCClientReasonServerLogout,
/// 其他错误
JCClientReasonOther,

/**
 *  登出 菊风云 平台，登出后不能进行平台上的各种业务
 *  @return 返回 true 表示正常执行调用流程，false 表示调用异常，异常错误通过 JCClientCallback 通知
 */
-(bool)logout;

/**
 *  @brief 登出回调
 *  @param reason 登出原因
 *  @see JCClientReason
 */
-(void)onLogout:(JCClientReason)reason;

/**
 *  @brief 登录状态变化通知
 *  @param state    当前状态值
 *  @param oldState 之前状态值
 */
-(void)onClientStateChange:(JCClientState)state oldState:(JCClientState)oldState;

// 未初始化
JCClientStateNotInit,
// 未登录
JCClientStateIdle,
// 登录中
JCClientStateLogining,
// 登录成功
JCClientStateLogined,
// 登出中
JCClientStateLogouting,

-(void)onClientStateChange:(JCClientState)state oldState:(JCClientState)oldState
{
    if (state == JCClientStateIdle) { // 未登录
        ...
    } else if (state == JCClientStateLogining) { // 登录中
        ...
    } else if (state == JCClientStateLogined) {  // 登录成功
        ...
    } else if (state == JCClientStateLogouting) {  // 登出中
        ...
    }
}

/**
 *  @brief 设置是否是前台，当应用进入前台标志为true，进入后台标志为false
 *  @param foreground  true 是前台，false 是后台
 */
-(void)setForeground:(bool)foreground;

/**
 *  @brief                  创建 JCCall 实例
 *  @param client           JCClient 实例
 *  @param mediaDevice      JCMediaDevice 实例
 *  @param callback         JCCallCallback 回调接口，用于接收 JCCall 相关回调事件
 *  @return                 返回 JCCall 实例
 */
+(JCCall*)create:(JCClient*)client mediaDevice:(JCMediaDevice*)mediaDevice callback:(id<JCCallCallback>)callback;

/**
 *  @brief     创建 JCMediaChannel 对象
 *  @param     client JCClient 对象
 *  @param     mediaDevice JCMediaDevice 对象
 *  @param     callback JCMediaChannelCallback 回调接口，用于接收 JCMediaChannel 相关通知
 *  @return    返回 JCMediaChannel 对象
 */
+(JCMediaChannel*)create:(JCClient*)client mediaDevice:(JCMediaDevice*)mediaDevice callback:(id<JCMediaChannelCallback>)callback;

// 初始化各模块，因为这些模块实例将被频繁使用，建议声明在单例中
JCMediaDevice *mediaDevice = [JCMediaDevice create:client callback:self];
JCCall *call = [JCCall create:client mediaDevice:mediaDevice callback:self];

/**
 *  @brief                  一对一呼叫
 *  @param userId           用户标识
 *  @param video            是否为视频呼叫
 *  @param extraParam       透传参数，被叫方可获取透传参数
 *  @return                 返回 true 表示正常执行调用流程，false 表示调用异常
 */
-(bool)call:(NSString*)userId video:(bool)video extraParam:(NSString *)extraParam;

// 发起语音呼叫
[call call:@"peer number" video:false extraParam:@"自定义透传字符串"];

/**
 *  @brief 新增通话回调
 *  @param item JCCallItem 对象
 */
-(void)onCallItemAdd:(JCCallItem*)item;

-(void)onCallItemAdd:(JCCallItem*)item {
    // 收到新增通话回调
}

/**
 *  @brief                  接听
 *  @param item             JCCallItem 对象
 *  @param video            针对视频呼入可以选择以视频接听还是音频接听
 *  @return                 返回 true 表示正常执行调用流程，false 表示调用异常
 */
-(bool)answer:(JCCallItem*)item video:(bool)video;

-(void)onCallItemAdd:(JCCallItem*)item {
    // 如果是语音呼入且在振铃中
    if (item && item.direction == JCCallDirectionIn && !item.video) {
         // 应答通话
         [call answer:item video:false];
    }
}

/**
 *  @brief                  挂断
 *  @param item             JCCallItem 对象
 *  @param reason           挂断原因
 *  @param description      挂断描述
 *  @return                 返回 true 表示正常执行调用流程，false 表示调用异常
 *  @see JCCallReason
 */
-(bool)term:(JCCallItem*)item reason:(JCCallReason)reason description:(NSString*)description;

// 挂断通话
JCCallItem *item = call.callItems[0];
[call term:item reason:JCCallReasonNone description:@"test"];

/**
 *  @brief              移除通话
 *  @param item         JCCallItem 对象
 *  @param reason       通话结束原因
 *  @param description  通话结束原因的描述，只有被动挂断的时候，才会收到这个值，其他情况下则返回空字符串
 *  @see JCCallReason
 */
-(void)onCallItemRemove:(JCCallItem*)item reason:(JCCallReason)reason description:(NSString *)description;

-(void)onCallItemRemove:(JCCallItem*)item reason:(JCCallReason)reason description:(NSString *)description { //移除通话回调
    // 界面处理
}

/**
 * @brief上报服务器拉取的未接来电
 * @param item JCCallItem 对象
 */
-(void)onMissedCallItem:(JCCallItem *)item;