CNLiveChatStatusDefine.h 13.3 KB

Edit Raw Blame History

//
//  CNLiveChatStatusDefine.h
//  CNLiveChatManager
//
//  Created by cnliveJunBo on 17/3/1.
//  Copyright © 2017年 cnlive. All rights reserved.
//

#import <Foundation/Foundation.h>

#pragma mark - 错误码相关

#pragma mark CNLiveChatConnectErrorCode - 建立连接返回的错误码
/*!
 建立连接返回的错误码

 @discussion
 开发者仅需要关注以下几种连接错误码，其余错误码SDK均会进行自动重连，开发者无须处理。
 CNLive_CONN_ID_REJECT, CNLive_CONN_TOKEN_INCORRECT, CNLive_CONN_NOT_AUTHRORIZED,
 CNLive_CONN_PACKAGE_NAME_INVALID, CNLive_CONN_APP_BLOCKED_OR_DELETED,
 CNLive_CONN_USER_BLOCKED, CNLive_DISCONN_KICK, CNLive_CLIENT_NOT_INIT, CNLive_INVALID_PARAMETER, CNLive_INVALID_ARGUMENT
 */
typedef NS_ENUM(NSInteger, CNLiveChatConnectErrorCode) {

    /*!
     连接已被释放

     @discussion 建立连接的临时错误码，SDK会做好自动重连，开发者无须处理。
     */
    CNLive_NET_CHANNEL_INVALID = 30001,

    /*!
     连接不可用

     @discussion 建立连接的临时错误码，SDK会做好自动重连，开发者无须处理。
     */
    CNLive_NET_UNAVAILABLE = 30002,

    /*!
     导航HTTP发送失败

     @discussion 建立连接的临时错误码，SDK会做好自动重连，开发者无须处理。
     */
    CNLive_NAVI_REQUEST_FAIL = 30004,

    /*!
     导航HTTP请求失败

     @discussion 建立连接的临时错误码，SDK会做好自动重连，开发者无须处理。
     */
    CNLive_NAVI_RESPONSE_ERROR = 30007,

    /*!
     导航HTTP返回数据格式错误

     @discussion 建立连接的临时错误码，SDK会做好自动重连，开发者无须处理。
     */
    CNLive_NODE_NOT_FOUND = 30008,

    /*!
     创建Socket连接失败

     @discussion 建立连接的临时错误码，SDK会做好自动重连，开发者无须处理。
     */
    CNLive_SOCKET_NOT_CONNECTED = 30010,

    /*!
     Socket断开

     @discussion 建立连接的临时错误码，SDK会做好自动重连，开发者无须处理。
     */
    CNLive_SOCKET_DISCONNECTED = 30011,

    /*!
     PING失败

     @discussion 建立连接的临时错误码，SDK会做好自动重连，开发者无须处理。
     */
    CNLive_PING_SEND_FAIL = 30012,

    /*!
     PING超时

     @discussion 建立连接的临时错误码，SDK会做好自动重连，开发者无须处理。
     */
    CNLive_PONG_RECV_FAIL = 30013,

    /*!
     信令发送失败

     @discussion 建立连接的临时错误码，SDK会做好自动重连，开发者无须处理。
     */
    CNLive_MSG_SEND_FAIL = 30014,

    /*!
     连接过于频繁

     @discussion 建立连接的临时错误码，SDK会做好自动重连，开发者无须处理。
     */
    CNLive_CONN_OVERFREQUENCY = 30015,

    /*!
     连接ACK超时

     @discussion 建立连接的临时错误码，SDK会做好自动重连，开发者无须处理。
     */
    CNLive_CONN_ACK_TIMEOUT = 31000,

    /*!
     信令版本错误

     @discussion 建立连接的临时错误码，SDK会做好自动重连，开发者无须处理。
     */
    CNLive_CONN_PROTO_VERSION_ERROR = 31001,

    /*!
     AppKey错误

     @discussion 请检查您使用的AppKey是否正确。(*自行处理)
     */
    CNLive_CONN_ID_REJECT = 31002,

    /*!
     服务器当前不可用（预留）

     @discussion 建立连接的临时错误码，SDK会做好自动重连，开发者无须处理。
     */
    CNLive_CONN_SERVER_UNAVAILABLE = 31003,

    /*!
     Token无效

     @discussion Token无效一般有以下两种原因。(*自行处理)
     一是token错误，请您检查客户端初始化使用的AppKey和您服务器获取token使用的AppKey是否一致；
     二是token过期，是因为您在开发者后台设置了token过期时间，您需要请求您的服务器重新获取token并再次用新的token建立连接。
     */
    CNLive_CONN_TOKEN_INCORRECT = 31004,

    /*!
     AppKey与Token不匹配

     @discussion
     请检查您使用的AppKey与Token是否正确，是否匹配。一般有以下两种原因。(*自行处理)
     一是token错误，请您检查客户端初始化使用的AppKey和您服务器获取token使用的AppKey是否一致；
     二是token过期，是因为您在开发者后台设置了token过期时间，您需要请求您的服务器重新获取token并再次用新的token建立连接。
     */
    CNLive_CONN_NOT_AUTHRORIZED = 31005,

    /*!
     连接重定向

     @discussion 建立连接的临时错误码，SDK会做好自动重连，开发者无须处理。
     */
    CNLive_CONN_REDIRECTED = 31006,

    /*!
     BundleID不正确

     @discussion 请检查您App的BundleID是否正确。(*自行处理)
     */
    CNLive_CONN_PACKAGE_NAME_INVALID = 31007,

    /*!
     AppKey被封禁或已删除

     @discussion 请检查您使用的AppKey是否正确。(*自行处理)
     */
    CNLive_CONN_APP_BLOCKED_OR_DELETED = 31008,

    /*!
     用户被封禁

     @discussion 请检查您使用的Token是否正确，以及对应的UserId是否被封禁。(*自行处理)
     */
    CNLive_CONN_USER_BLOCKED = 31009,

    /*!
     Token请求失败

     @discussion 请检查连接服务器方法的参数是否正确,特别是用户信息中的用户ID。也可能是无网络。(*自行处理)
     */
    CNLive_CONN_TOKEN_NULL = 31012,

    /*!
     当前用户在其他设备上登陆，此设备被踢下线。(*自行处理)
     */
    CNLive_DISCONN_KICK = 31010,

    /*!
     SDK没有初始化

     @discussion 在使用SDK任何功能之前，必须先Init。(*自行处理)
     */
    CNLive_CONN_CLIENT_NOT_INIT = 33001,

    /*!
     开发者接口调用时传入的参数错误

     @discussion 请检查接口调用时传入的参数类型和值。(*自行处理)
     */
    CNLive_CONN_INVALID_PARAMETER = 33003,

    /*!
     Connection已经存在

     @discussion
     调用过connect之后，建议在token错误或者被踢下线或者用户logout的情况下才需要再次调用connect。SDK会自动重连，不需要应用多次调用connect来保证连接性。(*自行处理)
     */
    CNLive_CONNECTION_EXIST = 34001,

    /*!
     Connection正在连接

     @discussion
     Connection正在连接,此时不能再次做connect操作,稍后再做操作(*自行处理)
     */
    CNLive_CONNECTION_CONNING = 34002,

    /*!
     开发者接口调用时传入的参数错误

     @discussion 请检查接口调用时传入的参数类型和值。(*自行处理)
     */
    CNLive_INVALID_ARGUMENT = -1000
};

#pragma mark CNLiveChatErrorCode - 具体业务错误码
/*!
 具体业务错误码
 */
typedef NS_ENUM(NSInteger, CNLiveChatErrorCode) {
    /*!
     未知错误（预留）
     */
    CNLive_ERRORCODE_UNKNOWN = -1,

    /*!
     token错误
     */
    CNLive_ERRORCODE_BY_TOKENERROR = 302,

    /*!
     鉴权失败  此AppId无权加入此targetId的聊天室
     */
    CNLive_ERRORCODE_BY_AUTHENTICATIONERROR = 303,

    /*!
    不合法的 targetId
     */
    CNLive_ERRORCODE_BY_TARGETIDERROR = 304,

    /*!
     不合法的 会话类型 type
     */
    CNLive_ERRORCODE_BY_CONVERSATIONTYPEERROR = 305,

    /*!
     已被对方加入黑名单
     */
    CNLive_REJECTED_BY_BLACKLIST = 405,

    /*!
     超时
     */
    CNLive_ERRORCODE_TIMEOUT = 5004,

    /*!
     发送消息频率过高，1秒钟最多只允许发送5条消息
     */
    CNLive_SEND_MSG_FREQUENCY_OVERRUN = 20604,

    /*!
     不在该聊天室中
     */
    CNLive_NOT_IN_CHATROOM = 23406,

    /*!
     在该聊天室中已被禁言
     */
    CNLive_FORBIDDEN_IN_CHATROOM = 23408,

    /*!
     已被踢出聊天室
     */
    CNLive_KICKED_FROM_CHATROOM = 23409,

    /*!
     聊天室不存在
     */
    CNLive_CHATROOM_NOT_EXIST = 23410,

    /*!
     聊天室成员超限
     */
    CNLive_CHATROOM_IS_FULL = 23411,

    /*!
     聊天室接口参数无效
     */
    CNLive_PARAMETER_INVALID_CHATROOM = 23412,

    /*!
     聊天室云存储业务未开通
     */
    CNLive_ROAMING_SERVICE_UNAVAILABLE_CHATROOM = 23414,

    /*!
     当前连接不可用（连接已经被释放）
     */
    CNLive_CHANNEL_INVALID = 30001,

    /*!
     当前连接不可用
     */
    CNLive_NETWORK_UNAVAILABLE = 30002,

    /*!
     消息响应超时
     */
    CNLive_MSG_RESPONSE_TIMEOUT = 30003,

    /*!
     SDK没有初始化

     @discussion 在使用SDK任何功能之前，必须先Init。
     */
    CNLive_CLIENT_NOT_INIT = 33001,

    /*!
     数据库错误

     @discussion 请检查您使用的Token和userId是否正确。
     */
    CNLive_DATABASE_ERROR = 33002,

    /*!
     开发者接口调用时传入的参数错误

     @discussion 请检查接口调用时传入的参数类型和值。
     */
    CNLive_INVALID_PARAMETER = 33003,

    /*!
     历史消息云存储业务未开通
     */
    CNLive_MSG_ROAMING_SERVICE_UNAVAILABLE = 33007,

    /*!
     消息大小超限，消息体（序列化成json格式之后的内容）最大128k bytes。
     */
    CNLive_MSG_SIZE_OUT_OF_LIMIT = 30016
};

#pragma mark - 会话相关

#pragma mark CNLiveConversationType - 会话类型
/*!
 会话类型
 */
typedef NS_ENUM(NSUInteger, CNLiveConversationType) {
    /*!
     私聊
     */
    CNLive_ConversationType_PRIVATE = 1,

    /*!
     聊天室
     */
    CNLive_ConversationType_CHATROOM = 4,
};

#pragma mark - 线上状态

#pragma mark CNLiveConnectionStatus - 网络连接状态码
/*!
 网络连接状态码

 @discussion 开发者仅需要关注以下几种连接状态，其余状态SDK均会进行自动重连。
 CNLive_ConnectionStatus_Connected, CNLive_ConnectionStatus_Connecting,
 CNLive_ConnectionStatus_Unconnected,
 CNLive_ConnectionStatus_SignUp, CNLive_ConnectionStatus_KICKED_OFFLINE_BY_OTHER_CLIENT,
 CNLive_ConnectionStatus_TOKEN_INCORRECT
 */
typedef NS_ENUM(NSInteger, CNLiveConnectionStatus) {
    /*!
     未知状态

     @discussion 建立连接中出现异常的临时状态，SDK会做好自动重连，开发者无须处理。
     */
    CNLive_ConnectionStatus_UNKNOWN = -1,

    /*!
     连接成功
     */
    CNLive_ConnectionStatus_Connected = 0,

    /*!
     当前设备网络不可用

     @discussion 建立连接的临时状态，SDK会做好自动重连，开发者无须处理。
     */
    CNLive_ConnectionStatus_NETWORK_UNAVAILABLE = 1,

    /*!
     当前设备切换到飞行模式

     @discussion 建立连接的临时状态，SDK会做好自动重连，开发者无须处理。
     */
    CNLive_ConnectionStatus_AIRPLANE_MODE = 2,

    /*!
     当前设备切换到 2G（GPRS、EDGE）低速网络

     @discussion 建立连接的临时状态，SDK会做好自动重连，开发者无须处理。
     */
    CNLive_ConnectionStatus_Cellular_2G = 3,

    /*!
     当前设备切换到 3G 或 4G 高速网络

     @discussion 建立连接的临时状态，SDK会做好自动重连，开发者无须处理。
     */
    CNLive_ConnectionStatus_Cellular_3G_4G = 4,

    /*!
     当前设备切换到 WIFI 网络

     @discussion 建立连接的临时状态，SDK会做好自动重连，开发者无须处理。
     */
    CNLive_ConnectionStatus_WIFI = 5,

    /*!
     当前用户在其他设备上登录，此设备被踢下线
     */
    CNLive_ConnectionStatus_KICKED_OFFLINE_BY_OTHER_CLIENT = 6,

    /*!
     当前用户在 Web 端登录

     @discussion 建立连接的临时状态，SDK会做好自动重连，开发者无须处理。
     */
    CNLive_ConnectionStatus_LOGIN_ON_WEB = 7,

    /*!
     服务器异常

     @discussion 建立连接的临时状态，SDK会做好自动重连，开发者无须处理。
     */
    CNLive_ConnectionStatus_SERVER_INVALID = 8,

    /*!
     连接验证异常

     @discussion 建立连接的临时状态，SDK会做好自动重连，开发者无须处理。
     */
    CNLive_ConnectionStatus_VALIDATE_INVALID = 9,

    /*!
     连接中
     */
    CNLive_ConnectionStatus_Connecting = 10,

    /*!
     连接失败或未连接
     */
    CNLive_ConnectionStatus_Unconnected = 11,

    /*!
     已注销
     */
    CNLive_ConnectionStatus_SignUp = 12,

    /*!
     Token无效

     @discussion
     Token无效一般有两种原因。一是token错误，请您检查客户端初始化使用的AppKey和您服务器获取token使用的AppKey是否一致；二是token过期，是因为您在开发者后台设置了token过期时间，您需要请求您的服务器重新获取token并再次用新的token建立连接。
     */
    CNLive_ConnectionStatus_TOKEN_INCORRECT = 31004,

    /*!
     与服务器的连接已断开

     @discussion 建立连接的临时状态，SDK会做好自动重连，开发者无须处理。
     */
    CNLive_ConnectionStatus_DISCONN_EXCEPTION = 31011,

    /*!
     与服务器的连接已断开

     @discussion 无法自动重连,需手动重新连接服务器connectServerSuccess:error:。
     */
    CNLive_ConnectionStatus_DISCONN_MANUALCONN = 32011
};