shmily

sdk upgrade

Too many changes to show.

To preserve performance only 12 of 12+ files are displayed.

Pod::Spec.new do |s|
s.name = "HHVDoctorSDK"
s.version = "2.5.6.0312.1627"
s.version = "2.5.6.0312.1644"
s.summary = "和缓视频医生 SDK"
s.description = <<-DESC
... ...
//
// ImSDK.h
// ImSDK
//
// Created by bodeng on 24/3/15.
// Copyright (c) 2015 tencent. All rights reserved.
//
#ifndef ImSDK_ImSDK_h
#define ImSDK_ImSDK_h
#import "TIMComm.h"
#import "TIMManager.h"
#import "TIMMessage.h"
#import "TIMConversation.h"
#import "TIMGroupManager.h"
#import "TIMCallback.h"
#import "TIMFriendshipManager.h"
#import "TIMErrorCode.h"
#import "TIMConversation+MsgExt.h"
#import "TIMManager+MsgExt.h"
#endif
//
// TIMCallback.h
// ImSDK
//
// Created by bodeng on 30/3/15.
// Copyright (c) 2015 tencent. All rights reserved.
//
#ifndef ImSDK_TIMCallback_h
#define ImSDK_TIMCallback_h
#import "TIMComm.h"
@class TIMMessage;
@class TIMGroupTipsElem;
@class TIMGroupInfo;
@class TIMSNSChangeInfo;
@class TIMFriendPendencyInfo;
/**
* 连接通知回调
*/
@protocol TIMConnListener <NSObject>
@optional
/**
* 网络连接成功
*/
- (void)onConnSucc;
/**
* 网络连接失败
*
* @param code 错误码
* @param err 错误描述
*/
- (void)onConnFailed:(int)code err:(NSString*)err;
/**
* 网络连接断开(断线只是通知用户,不需要重新登录,重连以后会自动上线)
*
* @param code 错误码
* @param err 错误描述
*/
- (void)onDisconnect:(int)code err:(NSString*)err;
/**
* 连接中
*/
- (void)onConnecting;
@end
/**
* 用户在线状态通知
*/
@protocol TIMUserStatusListener <NSObject>
@optional
/**
* 踢下线通知
*/
- (void)onForceOffline;
/**
* 断线重连失败
*/
- (void)onReConnFailed:(int)code err:(NSString*)err;
/**
* 用户登录的userSig过期(用户需要重新获取userSig后登录)
*/
- (void)onUserSigExpired;
@end
/**
* 页面刷新接口(如有需要未读计数刷新,会话列表刷新等)
*/
@protocol TIMRefreshListener <NSObject>
@optional
/**
* 刷新会话
*/
- (void)onRefresh;
/**
* 刷新部分会话
*
* @param conversations 会话(TIMConversation*)列表
*/
- (void)onRefreshConversations:(NSArray<TIMConversation *>*)conversations;
@end
/**
* 消息回调
*/
@protocol TIMMessageListener <NSObject>
@optional
/**
* 新消息回调通知
*
* @param msgs 新消息列表,TIMMessage 类型数组
*/
- (void)onNewMessage:(NSArray*)msgs;
@end
@protocol TIMMessageReceiptListener <NSObject>
@optional
/**
* 收到了已读回执
*
* @param receipts 已读回执(TIMMessageReceipt*)列表
*/
- (void) onRecvMessageReceipts:(NSArray*)receipts;
@end
/**
* 消息修改回调
*/
@protocol TIMMessageUpdateListener <NSObject>
@optional
/**
* 消息修改通知
*
* @param msgs 修改的消息列表,TIMMessage 类型数组
*/
- (void)onMessageUpdate:(NSArray*) msgs;
@end
@protocol TIMMessageRevokeListener <NSObject>
@optional
/**
* 消息撤回通知
*
* @param locator 被撤回消息的标识
*/
- (void)onRevokeMessage:(TIMMessageLocator*)locator;
@end
/**
* 上传进度回调
*/
@protocol TIMUploadProgressListener <NSObject>
@optional
/**
* 上传进度回调
*
* @param msg 正在上传的消息
* @param elemidx 正在上传的elem的索引
* @param taskid 任务id
* @param progress 上传进度
*/
- (void)onUploadProgressCallback:(TIMMessage*)msg elemidx:(uint32_t)elemidx taskid:(uint32_t)taskid progress:(uint32_t)progress;
@end
/**
* 群事件通知回调
*/
@protocol TIMGroupEventListener <NSObject>
@optional
/**
* 群tips回调
*
* @param elem 群tips消息
*/
- (void)onGroupTipsEvent:(TIMGroupTipsElem*)elem;
@end
/**
* 好友代理事件回调
*/
@protocol TIMFriendshipListener <NSObject>
@optional
/**
* 添加好友通知
*
* @param users 好友列表(NSString*)
*/
- (void)onAddFriends:(NSArray*)users;
/**
* 删除好友通知
*
* @param identifiers 用户id列表(NSString*)
*/
- (void)onDelFriends:(NSArray*)identifiers;
/**
* 好友资料更新通知
*
* @param profiles 资料列表(TIMSNSChangeInfo *)
*/
- (void)onFriendProfileUpdate:(NSArray<TIMSNSChangeInfo *> *)profiles;
/**
* 好友申请通知
*
* @param reqs 好友申请者id列表(TIMFriendPendencyInfo *)
*/
- (void)onAddFriendReqs:(NSArray<TIMFriendPendencyInfo *> *)reqs;
@end
#endif
//
// TIMComm.h
// ImSDK
//
// Created by bodeng on 29/1/15.
// Copyright (c) 2015 tencent. All rights reserved.
//
#ifndef ImSDK_TIMComm_h
#define ImSDK_TIMComm_h
#import <Foundation/Foundation.h>
#define ERR_IMSDK_KICKED_BY_OTHERS 6208
@protocol TIMConnListener;
@protocol TIMUserStatusListener;
@protocol TIMRefreshListener;
@protocol TIMMessageReceiptListener;
@protocol TIMMessageUpdateListener;
@protocol TIMMessageRevokeListener;
@protocol TIMUploadProgressListener;
@protocol TIMGroupEventListener;
@protocol TIMFriendshipListener;
//@protocol TIMGroupListener;
@class TIMMessage;
@class TIMImageElem;
@class TIMConversation;
@class TIMAPNSConfig;
@class TIMUserProfile;
@class TIMFriend;
@class TIMGroupInfoOption;
@class TIMGroupMemberInfoOption;
@class TIMFriendProfileOption;
@class TIMFriendResult;
@class TIMCheckFriendResult;
@class TIMGroupPendencyMeta;
@class TIMCreateGroupMemberInfo;
@class TIMSendToUsersDetailInfo;
@class TIMGroupInfo;
@class TIMGroupInfoResult;
@class TIMGroupMemberInfo;
@class TIMGroupPendencyItem;
#pragma mark - 枚举类型
/**
* 网络连接状态
*/
typedef NS_ENUM(NSInteger, TIMNetworkStatus) {
/**
* 已连接
*/
TIM_NETWORK_STATUS_CONNECTED = 1,
/**
* 链接断开
*/
TIM_NETWORK_STATUS_DISCONNECTED = 2,
};
/**
* 日志级别
*/
typedef NS_ENUM(NSInteger, TIMLogLevel) {
/**
* 不输出任何 sdk log
*/
TIM_LOG_NONE = 0,
/**
* 输出 DEBUG,INFO,WARNING,ERROR 级别的 log
*/
TIM_LOG_DEBUG = 3,
/**
* 输出 INFO,WARNING,ERROR 级别的 log
*/
TIM_LOG_INFO = 4,
/**
* 输出 WARNING,ERROR 级别的 log
*/
TIM_LOG_WARN = 5,
/**
* 输出 ERROR 级别的 log
*/
TIM_LOG_ERROR = 6,
};
/**
* 会话类型:
* C2C 双人聊天
* GROUP 群聊
*/
typedef NS_ENUM(NSInteger, TIMConversationType) {
/**
* C2C 类型
*/
TIM_C2C = 1,
/**
* 群聊 类型
*/
TIM_GROUP = 2,
/**
* 系统消息
*/
TIM_SYSTEM = 3,
};
/**
* 消息状态
*/
typedef NS_ENUM(NSInteger, TIMMessageStatus){
/**
* 消息发送中
*/
TIM_MSG_STATUS_SENDING = 1,
/**
* 消息发送成功
*/
TIM_MSG_STATUS_SEND_SUCC = 2,
/**
* 消息发送失败
*/
TIM_MSG_STATUS_SEND_FAIL = 3,
/**
* 消息被删除
*/
TIM_MSG_STATUS_HAS_DELETED = 4,
/**
* 导入到本地的消息
*/
TIM_MSG_STATUS_LOCAL_STORED = 5,
/**
* 被撤销的消息
*/
TIM_MSG_STATUS_LOCAL_REVOKED = 6,
};
/**
* 消息优先级标识
*/
typedef NS_ENUM(NSInteger, TIMMessagePriority) {
/**
* 高优先级,一般为红包或者礼物消息
*/
TIM_MSG_PRIORITY_HIGH = 1,
/**
* 普通优先级,普通消息
*/
TIM_MSG_PRIORITY_NORMAL = 2,
/**
* 低优先级,一般为点赞消息
*/
TIM_MSG_PRIORITY_LOW = 3,
/**
* 最低优先级,一般为后台下发的成员进退群通知
*/
TIM_MSG_PRIORITY_LOWEST = 4,
};
/**
* 图片压缩选项
*/
typedef NS_ENUM(NSInteger, TIM_IMAGE_COMPRESS_TYPE){
/**
* 原图(不压缩)
*/
TIM_IMAGE_COMPRESS_ORIGIN = 0x00,
/**
* 高压缩率:图片较小,默认值
*/
TIM_IMAGE_COMPRESS_HIGH = 0x01,
/**
* 低压缩:高清图发送(图片较大)
*/
TIM_IMAGE_COMPRESS_LOW = 0x02,
};
/**
* 图片类型
*/
typedef NS_ENUM(NSInteger, TIM_IMAGE_TYPE){
/**
* 原图
*/
TIM_IMAGE_TYPE_ORIGIN = 0x01,
/**
* 缩略图
*/
TIM_IMAGE_TYPE_THUMB = 0x02,
/**
* 大图
*/
TIM_IMAGE_TYPE_LARGE = 0x04,
};
/**
* 图片格式
*/
typedef NS_ENUM(NSInteger, TIM_IMAGE_FORMAT){
/**
* JPG 格式
*/
TIM_IMAGE_FORMAT_JPG = 0x1,
/**
* GIF 格式
*/
TIM_IMAGE_FORMAT_GIF = 0x2,
/**
* PNG 格式
*/
TIM_IMAGE_FORMAT_PNG = 0x3,
/**
* BMP 格式
*/
TIM_IMAGE_FORMAT_BMP = 0x4,
/**
* 未知格式
*/
TIM_IMAGE_FORMAT_UNKNOWN = 0xff,
};
/**
* 登录状态
*/
typedef NS_ENUM(NSInteger, TIMLoginStatus) {
/**
* 已登录
*/
TIM_STATUS_LOGINED = 1,
/**
* 登录中
*/
TIM_STATUS_LOGINING = 2,
/**
* 无登录
*/
TIM_STATUS_LOGOUT = 3,
};
/**
* 推送规则
*/
typedef NS_ENUM(NSInteger, TIMOfflinePushFlag) {
/**
* 按照默认规则进行推送
*/
TIM_OFFLINE_PUSH_DEFAULT = 0,
/**
* 不进行推送
*/
TIM_OFFLINE_PUSH_NO_PUSH = 1,
};
/**
* 安卓离线推送模式
*/
typedef NS_ENUM(NSInteger, TIMAndroidOfflinePushNotifyMode) {
/**
* 通知栏消息
*/
TIM_ANDROID_OFFLINE_PUSH_NOTIFY_MODE_NOTIFICATION = 0x00,
/**
* 不弹窗,由应用自行处理
*/
TIM_ANDROID_OFFLINE_PUSH_NOTIFY_MODE_CUSTOM = 0x01,
};
/**
* 群组成员是否可见
*/
typedef NS_ENUM(NSInteger, TIMGroupMemberVisibleType) {
/**
* 未知
*/
TIM_GROUP_MEMBER_VISIBLE_UNKNOWN = 0x00,
/**
* 群组成员不可见
*/
TIM_GROUP_MEMBER_VISIBLE_NO = 0x01,
/**
* 群组成员可见
*/
TIM_GROUP_MEMBER_VISIBLE_YES = 0x02,
};
/**
* 群组是否能被搜到
*/
typedef NS_ENUM(NSInteger, TIMGroupSearchableType) {
/**
* 未知
*/
TIM_GROUP_SEARCHABLE_UNKNOWN = 0x00,
/**
* 群组不能被搜到
*/
TIM_GROUP_SEARCHABLE_NO = 0x01,
/**
* 群组能被搜到
*/
TIM_GROUP_SEARCHABLE_YES = 0x02,
};
/**
* 加群选项
*/
typedef NS_ENUM(NSInteger, TIMGroupAddOpt) {
/**
* 禁止加群
*/
TIM_GROUP_ADD_FORBID = 0,
/**
* 需要管理员审批
*/
TIM_GROUP_ADD_AUTH = 1,
/**
* 任何人可以加入
*/
TIM_GROUP_ADD_ANY = 2,
};
/**
* 群组提示类型
*/
typedef NS_ENUM(NSInteger, TIMGroupTipsType){
/**
* 成员加入
*/
TIM_GROUP_TIPS_JOIN = 1,
/**
* 成员离开
*/
TIM_GROUP_TIPS_QUIT = 2,
/**
* 成员被踢
*/
TIM_GROUP_TIPS_KICK = 3,
/**
* 成员设置管理员
*/
TIM_GROUP_TIPS_SET_ADMIN = 4,
/**
* 成员取消管理员
*/
TIM_GROUP_TIPS_CANCEL_ADMIN = 5,
};
/**
* 群消息接受选项
*/
typedef NS_ENUM(NSInteger, TIMGroupReceiveMessageOpt) {
/**
* 接收消息
*/
TIM_GROUP_RECEIVE_MESSAGE = 0,
/**
* 不接收消息,服务器不进行转发
*/
TIM_GROUP_NOT_RECEIVE_MESSAGE = 1,
/**
* 接受消息,不进行 iOS APNs 推送
*/
TIM_GROUP_RECEIVE_NOT_NOTIFY_MESSAGE = 2,
};
/**
* 群 Tips 类型
*/
typedef NS_ENUM(NSInteger, TIM_GROUP_TIPS_TYPE){
/**
* 邀请加入群 (opUser & groupName & userList)
*/
TIM_GROUP_TIPS_TYPE_INVITE = 0x01,
/**
* 退出群 (opUser & groupName & userList)
*/
TIM_GROUP_TIPS_TYPE_QUIT_GRP = 0x02,
/**
* 踢出群 (opUser & groupName & userList)
*/
TIM_GROUP_TIPS_TYPE_KICKED = 0x03,
/**
* 设置管理员 (opUser & groupName & userList)
*/
TIM_GROUP_TIPS_TYPE_SET_ADMIN = 0x04,
/**
* 取消管理员 (opUser & groupName & userList)
*/
TIM_GROUP_TIPS_TYPE_CANCEL_ADMIN = 0x05,
/**
* 群资料变更 (opUser & groupName & introduction & notification & faceUrl & owner)
*/
TIM_GROUP_TIPS_TYPE_INFO_CHANGE = 0x06,
/**
* 群成员资料变更 (opUser & groupName & memberInfoList)
*/
TIM_GROUP_TIPS_TYPE_MEMBER_INFO_CHANGE = 0x07,
};
/**
* 群变更信息 Tips 类型
*/
typedef NS_ENUM(NSInteger, TIM_GROUP_INFO_CHANGE_TYPE){
/**
* 群名修改
*/
TIM_GROUP_INFO_CHANGE_GROUP_NAME = 0x01,
/**
* 群简介修改
*/
TIM_GROUP_INFO_CHANGE_GROUP_INTRODUCTION = 0x02,
/**
* 群公告修改
*/
TIM_GROUP_INFO_CHANGE_GROUP_NOTIFICATION = 0x03,
/**
* 群头像修改
*/
TIM_GROUP_INFO_CHANGE_GROUP_FACE = 0x04,
/**
* 群主变更
*/
TIM_GROUP_INFO_CHANGE_GROUP_OWNER = 0x05,
/**
* 群自定义字段变更
*/
TIM_GROUP_INFO_CHANGE_GROUP_CUSTOM = 0x06,
};
/**
* 群系统消息类型
*/
typedef NS_ENUM(NSInteger, TIM_GROUP_SYSTEM_TYPE){
/**
* 申请加群请求(只有管理员会收到)
*/
TIM_GROUP_SYSTEM_ADD_GROUP_REQUEST_TYPE = 0x01,
/**
* 申请加群被同意(只有申请人能够收到)
*/
TIM_GROUP_SYSTEM_ADD_GROUP_ACCEPT_TYPE = 0x02,
/**
* 申请加群被拒绝(只有申请人能够收到)
*/
TIM_GROUP_SYSTEM_ADD_GROUP_REFUSE_TYPE = 0x03,
/**
* 被管理员踢出群(只有被踢的人能够收到)
*/
TIM_GROUP_SYSTEM_KICK_OFF_FROM_GROUP_TYPE = 0x04,
/**
* 群被解散(全员能够收到)
*/
TIM_GROUP_SYSTEM_DELETE_GROUP_TYPE = 0x05,
/**
* 创建群消息(创建者能够收到)
*/
TIM_GROUP_SYSTEM_CREATE_GROUP_TYPE = 0x06,
/**
* 邀请入群通知(被邀请者能够收到)
*/
TIM_GROUP_SYSTEM_INVITED_TO_GROUP_TYPE = 0x07,
/**
* 主动退群(主动退群者能够收到)
*/
TIM_GROUP_SYSTEM_QUIT_GROUP_TYPE = 0x08,
/**
* 设置管理员(被设置者接收)
*/
TIM_GROUP_SYSTEM_GRANT_ADMIN_TYPE = 0x09,
/**
* 取消管理员(被取消者接收)
*/
TIM_GROUP_SYSTEM_CANCEL_ADMIN_TYPE = 0x0a,
/**
* 群已被回收(全员接收)
*/
TIM_GROUP_SYSTEM_REVOKE_GROUP_TYPE = 0x0b,
/**
* 邀请入群请求(被邀请者接收)
*/
TIM_GROUP_SYSTEM_INVITE_TO_GROUP_REQUEST_TYPE = 0x0c,
/**
* 邀请加群被同意(只有发出邀请者会接收到)
*/
TIM_GROUP_SYSTEM_INVITE_TO_GROUP_ACCEPT_TYPE = 0x0d,
/**
* 邀请加群被拒绝(只有发出邀请者会接收到)
*/
TIM_GROUP_SYSTEM_INVITE_TO_GROUP_REFUSE_TYPE = 0x0e,
/**
* 用户自定义通知(默认全员接收)
*/
TIM_GROUP_SYSTEM_CUSTOM_INFO = 0xff,
};
/**
* 群成员角色
*/
typedef NS_ENUM(NSInteger, TIMGroupMemberRole) {
/**
* 未定义(没有获取该字段)
*/
TIM_GROUP_MEMBER_UNDEFINED = 0,
/**
* 群成员
*/
TIM_GROUP_MEMBER_ROLE_MEMBER = 200,
/**
* 群管理员
*/
TIM_GROUP_MEMBER_ROLE_ADMIN = 300,
/**
* 群主
*/
TIM_GROUP_MEMBER_ROLE_SUPER = 400,
};
/**
* 群基本获取资料标志
*/
typedef NS_ENUM(NSInteger, TIMGetGroupBaseInfoFlag) {
/**
* 不获取群组资料
*/
TIM_GET_GROUP_BASE_INFO_FLAG_NONE = 0x00,
/**
* 获取群组名
*/
TIM_GET_GROUP_BASE_INFO_FLAG_NAME = 0x01,
/**
* 获取创建时间
*/
TIM_GET_GROUP_BASE_INFO_FLAG_CREATE_TIME = 0x01 << 1,
/**
* 获取群主id
*/
TIM_GET_GROUP_BASE_INFO_FLAG_OWNER_UIN = 0x01 << 2,
/**
* (不可用)
*/
TIM_GET_GROUP_BASE_INFO_FLAG_SEQ = 0x01 << 3,
/**
* 获取最近一次修改群信息时间
*/
TIM_GET_GROUP_BASE_INFO_FLAG_TIME = 0x01 << 4,
/**
* (不可用)
*/
TIM_GET_GROUP_BASE_INFO_FLAG_NEXT_MSG_SEQ = 0x01 << 5,
/**
* 获取最近一次发消息时间
*/
TIM_GET_GROUP_BASE_INFO_FLAG_LAST_MSG_TIME = 0x01 << 6,
/**
* (不可用)
*/
TIM_GET_GROUP_BASE_INFO_FLAG_APP_ID = 0x01 << 7,
/**
* 获取群成员数量
*/
TIM_GET_GROUP_BASE_INFO_FLAG_MEMBER_NUM = 0x01 << 8,
/**
* 获取最大群成员数量
*/
TIM_GET_GROUP_BASE_INFO_FLAG_MAX_MEMBER_NUM = 0x01 << 9,
/**
* 获取群公告
*/
TIM_GET_GROUP_BASE_INFO_FLAG_NOTIFICATION = 0x01 << 10,
/**
* 获取群简介
*/
TIM_GET_GROUP_BASE_INFO_FLAG_INTRODUCTION = 0x01 << 11,
/**
* 获取群头像
*/
TIM_GET_GROUP_BASE_INFO_FLAG_FACE_URL = 0x01 << 12,
/**
* 获取入群类型
*/
TIM_GET_GROUP_BASE_INFO_FLAG_ADD_OPTION = 0x01 << 13,
/**
* 获取群组类型
*/
TIM_GET_GROUP_BASE_INFO_FLAG_GROUP_TYPE = 0x01 << 14,
/**
* 获取最后一条群消息
*/
TIM_GET_GROUP_BASE_INFO_FLAG_LAST_MSG = 0x01 << 15,
/**
* 获取在线人数
*/
TIM_GET_GROUP_BASE_INFO_FLAG_ONLINE_NUM = 0x01 << 16,
/**
* 获取群成员是否可见标志
*/
TIM_GET_GROUP_BASE_INFO_VISIBLE = 0x01 << 17,
/**
* 获取群是否能被搜到标志
*/
TIM_GET_GROUP_BASE_INFO_SEARCHABLE = 0x01 << 18,
/**
* 获取群全员禁言时间
*/
TIM_GET_GROUP_BASE_INFO_ALL_SHUTUP = 0x01 << 19
};
/**
* 群成员角色过滤方式
*/
typedef NS_ENUM(NSInteger, TIMGroupMemberFilter) {
/**
* 全部成员
*/
TIM_GROUP_MEMBER_FILTER_ALL = 0x00,
/**
* 群主
*/
TIM_GROUP_MEMBER_FILTER_SUPER = 0x01,
/**
* 管理员
*/
TIM_GROUP_MEMBER_FILTER_ADMIN = 0x02,
/**
* 普通成员
*/
TIM_GROUP_MEMBER_FILTER_COMMON = 0x04,
};
/**
* 群成员获取资料标志
*/
typedef NS_ENUM(NSInteger, TIMGetGroupMemInfoFlag) {
/**
* 入群时间
*/
TIM_GET_GROUP_MEM_INFO_FLAG_JOIN_TIME = 0x01,
/**
* 消息标志
*/
TIM_GET_GROUP_MEM_INFO_FLAG_MSG_FLAG = 0x01 << 1,
/**
* 角色
*/
TIM_GET_GROUP_MEM_INFO_FLAG_ROLE_INFO = 0x01 << 3,
/**
* 禁言时间
*/
TIM_GET_GROUP_MEM_INFO_FLAG_SHUTUP_TIME = 0x01 << 4,
/**
* 群名片
*/
TIM_GET_GROUP_MEM_INFO_FLAG_NAME_CARD = 0x01 << 5,
};
/**
* 群组操作结果
*/
typedef NS_ENUM(NSInteger, TIMGroupMemberStatus) {
/**
* 操作失败
*/
TIM_GROUP_MEMBER_STATUS_FAIL = 0,
/**
* 操作成功
*/
TIM_GROUP_MEMBER_STATUS_SUCC = 1,
/**
* 无效操作,加群时已经是群成员,移除群组时不在群内
*/
TIM_GROUP_MEMBER_STATUS_INVALID = 2,
/**
* 等待处理,邀请入群时等待对方处理
*/
TIM_GROUP_MEMBER_STATUS_PENDING = 3,
};
/**
* 群组未决请求类型
*/
typedef NS_ENUM(NSInteger, TIMGroupPendencyGetType) {
/**
* 申请入群
*/
TIM_GROUP_PENDENCY_GET_TYPE_JOIN = 0x0,
/**
* 邀请入群
*/
TIM_GROUP_PENDENCY_GET_TYPE_INVITE = 0x1,
};
/**
* 群组已决标志
*/
typedef NS_ENUM(NSInteger, TIMGroupPendencyHandleStatus) {
/**
* 未处理
*/
TIM_GROUP_PENDENCY_HANDLE_STATUS_UNHANDLED = 0,
/**
* 被他人处理
*/
TIM_GROUP_PENDENCY_HANDLE_STATUS_OTHER_HANDLED = 1,
/**
* 被用户处理
*/
TIM_GROUP_PENDENCY_HANDLE_STATUS_OPERATOR_HANDLED = 2,
};
/**
* 群组已决结果
*/
typedef NS_ENUM(NSInteger, TIMGroupPendencyHandleResult) {
/**
* 拒绝申请
*/
TIM_GROUP_PENDENCY_HANDLE_RESULT_REFUSE = 0,
/**
* 同意申请
*/
TIM_GROUP_PENDENCY_HANDLE_RESULT_AGREE = 1,
};
/**
* 好友验证方式
*/
typedef NS_ENUM(NSInteger, TIMFriendAllowType) {
/**
* 同意任何用户加好友
*/
TIM_FRIEND_ALLOW_ANY = 0,
/**
* 需要验证
*/
TIM_FRIEND_NEED_CONFIRM = 1,
/**
* 拒绝任何人加好友
*/
TIM_FRIEND_DENY_ANY = 2,
};
/**
* 性别
*/
typedef NS_ENUM(NSInteger, TIMGender) {
/**
* 未知性别
*/
TIM_GENDER_UNKNOWN = 0,
/**
* 男性
*/
TIM_GENDER_MALE = 1,
/**
* 女性
*/
TIM_GENDER_FEMALE = 2,
};
/**
* 操作类型
*/
typedef NS_ENUM(NSInteger, TIM_SNS_SYSTEM_TYPE){
/**
* 增加好友消息
*/
TIM_SNS_SYSTEM_ADD_FRIEND = 0x01,
/**
* 删除好友消息
*/
TIM_SNS_SYSTEM_DEL_FRIEND = 0x02,
/**
* 增加好友申请
*/
TIM_SNS_SYSTEM_ADD_FRIEND_REQ = 0x03,
/**
* 删除未决申请
*/
TIM_SNS_SYSTEM_DEL_FRIEND_REQ = 0x04,
/**
* 黑名单添加
*/
TIM_SNS_SYSTEM_ADD_BLACKLIST = 0x05,
/**
* 黑名单删除
*/
TIM_SNS_SYSTEM_DEL_BLACKLIST = 0x06,
/**
* 未决已读上报
*/
TIM_SNS_SYSTEM_PENDENCY_REPORT = 0x07,
/**
* 关系链资料变更
*/
TIM_SNS_SYSTEM_SNS_PROFILE_CHANGE = 0x08,
};
/**
* 资料变更
*/
typedef NS_ENUM(NSInteger, TIM_PROFILE_SYSTEM_TYPE){
/**
好友资料变更
*/
TIM_PROFILE_SYSTEM_FRIEND_PROFILE_CHANGE = 0x01,
};
#pragma mark - block 回调
/**
* 获取消息回调
*
* @param msgs 消息列表
*/
typedef void (^TIMGetMsgSucc)(NSArray * msgs);
/**
* 一般操作成功回调
*/
typedef void (^TIMSucc)(void);
/**
* 操作失败回调
*
* @param code 错误码
* @param msg 错误描述,配合错误码使用,如果问题建议打印信息定位
*/
typedef void (^TIMFail)(int code, NSString * msg);
/**
* 进度毁掉
*
* @param curSize 已下载大小
* @param totalSize 总大小
*/
typedef void (^TIMProgress)(NSInteger curSize, NSInteger totalSize);
/**
* 登录成功回调
*/
typedef void (^TIMLoginSucc)(void);
/**
* 获取资源
*
* @param data 资源二进制
*/
typedef void (^TIMGetResourceSucc)(NSData * data);
/**
* 日志回调
*
* @param lvl 输出的日志级别
* @param msg 日志内容
*/
typedef void (^TIMLogFunc)(TIMLogLevel lvl, NSString * msg);
/**
* 上传图片成功回调
*
* @param elem 上传图片成功后 elem
*/
typedef void (^TIMUploadImageSucc)(TIMImageElem * elem);
/**
* APNs 推送配置更新成功回调
*
* @param config 配置
*/
typedef void (^TIMAPNSConfigSucc)(TIMAPNSConfig* config);
/**
* 群创建成功
*
* @param groupId 群组 Id
*/
typedef void (^TIMCreateGroupSucc)(NSString * groupId);
/**
* 好友列表
*
* @param friends 好友列表
*/
typedef void (^TIMFriendArraySucc)(NSArray<TIMFriend *> *friends);
/**
* 获取资料回调
*
* @param profile 资料
*/
typedef void (^TIMGetProfileSucc)(TIMUserProfile * profile);
/**
* 获取资料回调
*
* @param profiles 资料
*/
typedef void (^TIMUserProfileArraySucc)(NSArray<TIMUserProfile *> *profiles);
/**
* 好友操作回调
*
* @param result 资料
*/
typedef void (^TIMFriendResultSucc)(TIMFriendResult *result);
/**
* 好友操作回调
*
* @param results 资料
*/
typedef void (^TIMFriendResultArraySucc)(NSArray<TIMFriendResult *> *results);
/**
* 检查好友操作回调
*
* @param results 检查结果
*/
typedef void (^TIMCheckFriendResultArraySucc)(NSArray<TIMCheckFriendResult *> *results);
/**
* 群成员列表回调
*
* @param members 群成员列表
*/
typedef void (^TIMGroupMemberSucc)(NSArray * members);
/**
* 群列表结果回调
*
* @param groupList 群列表结果
*/
typedef void (^TIMGroupListSucc)(NSArray* groupList);
/**
* 本人群组内成员信息回调
*
* @param selfInfo 本人成员信息
*/
typedef void (^TIMGroupSelfSucc)(TIMGroupMemberInfo * selfInfo);
/**
* 群接受消息选项回调
*
* @param opt 群接受消息选项
*/
typedef void (^TIMGroupReciveMessageOptSucc)(TIMGroupReceiveMessageOpt opt);
/**
* 群成员列表回调(分页使用)
*
* @param members 群成员(TIMGroupMemberInfo*)列表
*/
typedef void (^TIMGroupMemberSuccV2)(uint64_t nextSeq, NSArray * members);
/**
* 群搜索回调
*
* @param totalNum 搜索结果的总数
* @param groups 请求的群列表片段
*/
typedef void (^TIMGroupSearchSucc)(uint64_t totalNum, NSArray * groups);
/**
* 获取群组未决请求列表成功
*
* @param meta 未决请求元信息
* @param pendencies 未决请求列表(TIMGroupPendencyItem)数组
*/
typedef void (^TIMGetGroupPendencyListSucc)(TIMGroupPendencyMeta * meta, NSArray<TIMGroupPendencyItem *> * pendencies);
/**
* 发送消息给多个用户失败
*
* @param code 错误码
* @param err 错误信息
* @param detailInfo 错误详情
*/
typedef void (^TIMSendToUsersFail)(int code, NSString *err, TIMSendToUsersDetailInfo *detailInfo);
#pragma mark - 基本类型
/// 实现 NSCoding 协议
@interface TIMCodingModel : NSObject <NSCoding>
///读取实例变量,并把这些数据写到 coder 中去,序列化数据
- (void)encodeWithCoder:(NSCoder *)encoder;
///从 coder 中读取数据,保存到相应的变量中,即反序列化数据
- (id)initWithCoder:(NSCoder *)decoder;
@end
/// 初始化 SDK 配置信息
@interface TIMSdkConfig : NSObject
///用户标识接入 SDK 的应用 ID,必填
@property(nonatomic,assign) int sdkAppId;
///用户的账号类型,新版本不需要再填写
//@property(nonatomic,strong) NSString * accountType;
///禁止在控制台打印 log
@property(nonatomic,assign) BOOL disableLogPrint;
///本地写 log 文件的等级,默认 DEBUG 等级
@property(nonatomic,assign) TIMLogLevel logLevel;
///log 文件路径,不设置时为默认路径,可以通过 TIMManager -> getLogPath 获取 log 路径
@property(nonatomic,strong) NSString * logPath;
///回调给 logFunc 函数的 log 等级,默认 DEBUG 等级
@property(nonatomic,assign) TIMLogLevel logFuncLevel;
///log 监听函数
@property(nonatomic,copy) TIMLogFunc logFunc;
///消息数据库路径,不设置时为默认路径
@property(nonatomic,strong) NSString * dbPath;
///网络监听器,监听网络连接成功失败的状态
@property(nonatomic,weak) id<TIMConnListener> connListener;
@end
/// 设置用户配置信息
@interface TIMUserConfig : NSObject
///禁用本地存储(AVChatRoom,BChatRoom 消息数量很大,出于程序性能的考虑,默认不存本地)
@property(nonatomic,assign) BOOL disableStorage;
///默认情况下,出于性能考虑,当用户在终端 A 收到未读消息后,Server 默认会删除未读消息,但如果用户切换到终端 B 后,IM SDK 无法再同步到未读消息,未读计数也不会增加,如果需要在终端 B 下也有未读,请设置 disableAutoReport 为 YES,这个时候 Server 不会再主动删除未读消息。注意一旦这这样设置,开发者需要主动调用 TIMConversation.h -> setReadMessage ,否则未读消息会一直存在 Server,IM SDK 每次登录或则断网重连都会再次同步到未读消息,详情请参考官方文档 [自动已读上报](https://cloud.tencent.com/document/product/269/9151)。
@property(nonatomic,assign) BOOL disableAutoReport;
///已读回执是自己发出去的消息,对方设置为已读后,自己能收到已读的回调,只针对单聊(C2C)会话生效,默认是关闭的,如果需要开启,请设置 enableReadReceipt 为 YES,收到消息的用户需要显式调用 TIMConversation.h -> setReadMessage,发消息的用户才能通过 TIMMessageReceiptListener 监听到消息的已读回执。
@property(nonatomic,assign) BOOL enableReadReceipt;
///设置默认拉取的群组资料,如果想要拉取自定义字段,要通过 [IM 控制台](https://console.cloud.tencent.com/avc) -> 功能配置 -> 群维度自定义字段配置对应的 "自定义字段" 和用户操作权限,控制台配置之后 5 分钟后才会生效。
@property(nonatomic,strong) TIMGroupInfoOption * groupInfoOpt;
///设置默认拉取的群成员资料,如果想要拉取自定义字段,要通过 [IM 控制台](https://console.cloud.tencent.com/avc) -> 功能配置 -> 群成员维度自定义字段配置对应的 "自定义字段" 和用户操作权限,控制台配置之后 5 分钟后才会生效。
@property(nonatomic,strong) TIMGroupMemberInfoOption * groupMemberInfoOpt;
///关系链参数
@property(nonatomic,strong) TIMFriendProfileOption * friendProfileOpt;
///用户登录状态监听器,用于监听用户被踢,断网重连失败,userSig 过期的通知
@property(nonatomic,weak) id<TIMUserStatusListener> userStatusListener;
///会话刷新监听器,用于监听会话的刷新
@property(nonatomic,weak) id<TIMRefreshListener> refreshListener;
///消息已读回执监听器,用于监听消息已读回执,enableReadReceipt 字段需要设置为 YES
@property(nonatomic,weak) id<TIMMessageReceiptListener> messageReceiptListener;
///消息修改监听器,用于监听消息状态的变化
@property(nonatomic,weak) id<TIMMessageUpdateListener> messageUpdateListener;
///消息撤回监听器,用于监听会话中的消息撤回通知
@property(nonatomic,weak) id<TIMMessageRevokeListener> messageRevokeListener;
///文件上传进度监听器,发送语音,图片,视频,文件消息的时候需要先上传对应文件到服务器,这里可以监听上传进度
@property(nonatomic,weak) id<TIMUploadProgressListener> uploadProgressListener;
///群组事件通知监听器
@property(nonatomic,weak) id<TIMGroupEventListener> groupEventListener;
///关系链数据本地缓存监听器
@property(nonatomic,weak) id<TIMFriendshipListener> friendshipListener;
@end
/// 登录参数
@interface TIMLoginParam : NSObject
///用户名
@property(nonatomic,strong) NSString* identifier;
///鉴权 Token
@property(nonatomic,strong) NSString* userSig;
///App 用户使用 OAuth 授权体系分配的 Appid
@property(nonatomic,strong) NSString* appidAt3rd;
@end
/// APNs 配置
@interface TIMAPNSConfig : NSObject
///是否开启推送:0-不进行设置 1-开启推送 2-关闭推送
@property(nonatomic,assign) uint32_t openPush;
///C2C 消息声音,不设置传入 nil
@property(nonatomic,strong) NSString * c2cSound;
///Group 消息声音,不设置传入 nil
@property(nonatomic,strong) NSString * groupSound;
///Video 音视频邀请声音,不设置传入 nil (暂不支持)
@property(nonatomic,strong) NSString * videoSound;
@end
/// SetToken 参数
@interface TIMTokenParam : NSObject
///token 是苹果后台对客户端的唯一标识,需要主动调用系统 API 向苹果请求获取
@property(nonatomic,strong) NSData* token;
///业务 ID,传递证书时分配
@property(nonatomic,assign) uint32_t busiId;
@end
/// 切后台参数
@interface TIMBackgroundParam : NSObject
///C2C 未读计数
@property(nonatomic,assign) int c2cUnread;
///群未读计数
@property(nonatomic,assign) int groupUnread;
@end
/// 消息定位
@interface TIMMessageLocator : NSObject
///所属会话的 id
@property(nonatomic,strong) NSString * sessId;
///所属会话的类型
@property(nonatomic,assign) TIMConversationType sessType;
///消息序列号
@property(nonatomic,assign) uint64_t seq;
///消息随机码
@property(nonatomic,assign) uint64_t rand;
///消息时间戳
@property(nonatomic,assign) time_t time;
///是否本人消息
@property(nonatomic,assign) BOOL isSelf;
///是否来自撤销通知
@property(nonatomic,assign) BOOL isFromRevokeNotify;
@end
/// 已读回执
@interface TIMMessageReceipt : NSObject
///已读回执对应的会话(目前只支持 C2C 会话)
@property(nonatomic,strong) TIMConversation * conversation;
///收到已读回执时,这个时间戳之前的消息都已读
@property(nonatomic,assign) time_t timestamp;
@end
/// Android 离线推送配置
@interface TIMAndroidOfflinePushConfig : NSObject
///离线推送时展示标签
@property(nonatomic,strong) NSString * title;
///Android 离线 Push 时声音字段信息
@property(nonatomic,strong) NSString * sound;
///为了保证在 Android 8.0 系统以上的 OPPO 手机上能收到离线推送消息,需要 app 在该手机上创建 channelID,并且设置该参数。
@property(nonatomic,strong) NSString * OPPOChannelID;
///离线推送时通知形式
@property(nonatomic,assign) TIMAndroidOfflinePushNotifyMode notifyMode;
@end
/// iOS 离线推送配置
@interface TIMIOSOfflinePushConfig : NSObject
///离线 Push 时声音字段信息
@property(nonatomic,strong) NSString * sound;
///忽略 badge 计数,如果设置为 YES,在 iOS 接收端,这条消息不会使 APP 的应用图标未读计数增加
@property(nonatomic,assign) BOOL ignoreBadge;
@end
/// 填入 sound 字段表示接收时不会播放声音
extern NSString * const kIOSOfflinePushNoSound;
/// 自定义消息 push
@interface TIMOfflinePushInfo : NSObject
///自定义消息描述信息,做离线Push时文本展示
@property(nonatomic,strong) NSString * desc;
///离线 Push 时扩展字段信息
@property(nonatomic,strong) NSString * ext;
///推送规则标志
@property(nonatomic,assign) TIMOfflinePushFlag pushFlag;
///iOS离线推送配置
@property(nonatomic,strong) TIMIOSOfflinePushConfig * iosConfig;
///Android离线推送配置
@property(nonatomic,strong) TIMAndroidOfflinePushConfig * androidConfig;
@end
/// 群组内的本人信息
@interface TIMGroupSelfInfo : NSObject
///加入群组时间
@property(nonatomic,assign) uint32_t joinTime;
///群组中的角色
@property(nonatomic,assign) TIMGroupMemberRole role;
///群组消息接收选项
@property(nonatomic,assign) TIMGroupReceiveMessageOpt recvOpt;
///群组中的未读消息数
@property(nonatomic,assign) uint32_t unReadMessageNum;
@end
/// 群资料信息
@interface TIMGroupInfo : TIMCodingModel
///群组 Id
@property(nonatomic,strong) NSString* group;
///群名
@property(nonatomic,strong) NSString* groupName;
///群创建人/管理员
@property(nonatomic,strong) NSString * owner;
///群类型:Private,Public,ChatRoom
@property(nonatomic,strong) NSString* groupType;
///群创建时间
@property(nonatomic,assign) uint32_t createTime;
///最近一次群资料修改时间
@property(nonatomic,assign) uint32_t lastInfoTime;
///最近一次发消息时间
@property(nonatomic,assign) uint32_t lastMsgTime;
///最大成员数
@property(nonatomic,assign) uint32_t maxMemberNum;
///群成员数量
@property(nonatomic,assign) uint32_t memberNum;
///入群类型
@property(nonatomic,assign) TIMGroupAddOpt addOpt;
///群公告
@property(nonatomic,strong) NSString* notification;
///群简介
@property(nonatomic,strong) NSString* introduction;
///群头像
@property(nonatomic,strong) NSString* faceURL;
///最后一条消息
@property(nonatomic,strong) TIMMessage* lastMsg;
///在线成员数量
@property(nonatomic,assign) uint32_t onlineMemberNum;
///群组是否被搜索类型
@property(nonatomic,assign) TIMGroupSearchableType isSearchable;
///群组成员可见类型
@property(nonatomic,assign) TIMGroupMemberVisibleType isMemberVisible;
///是否全员禁言
@property(nonatomic,assign) BOOL allShutup;
///群组中的本人信息
@property(nonatomic,strong) TIMGroupSelfInfo* selfInfo;
///自定义字段集合,key 是 NSString* 类型,value 是 NSData* 类型
@property(nonatomic,strong) NSDictionary<NSString *,NSData *>* customInfo;
@end
/// 获取群组信息结果
@interface TIMGroupInfoResult : TIMGroupInfo
/// 结果 0:成功;非0:失败
@property(nonatomic,assign) int resultCode;
/// 结果信息
@property(nonatomic,strong) NSString *resultInfo;
@end
/// 事件上报信息
@interface TIMEventReportItem : NSObject
///事件 id
@property(nonatomic,assign) uint32_t event;
///错误码
@property(nonatomic,assign) uint32_t code;
///错误描述
@property(nonatomic,strong) NSString * desc;
///事件延迟(单位 ms)
@property(nonatomic,assign) uint32_t delay;
@end
/// 获取某个群组资料
@interface TIMGroupInfoOption : NSObject
///需要获取的群组信息标志(TIMGetGroupBaseInfoFlag),默认为0xffffff
@property(nonatomic,assign) uint64_t groupFlags;
///需要获取群组资料的自定义信息(NSString*)列表 (接口已废弃,控制台配置群组自定义字段后,SDK 会根据权限自动拉取)
@property(nonatomic,strong) NSArray * groupCustom DEPRECATED_ATTRIBUTE;
@end
/// 需要某个群成员资料
@interface TIMGroupMemberInfoOption : NSObject
///需要获取的群成员标志(TIMGetGroupMemInfoFlag),默认为0xffffff
@property(nonatomic,assign) uint64_t memberFlags ;
///需要获取群成员资料的自定义信息(NSString*)列表 (接口已废弃,控制台配置群成员自定义字段后,SDK 会根据权限自动拉取)
@property(nonatomic,strong) NSArray * memberCustom DEPRECATED_ATTRIBUTE;
@end
/// 群成员资料
@interface TIMGroupMemberInfo : TIMCodingModel
///成员
@property(nonatomic,strong) NSString* member;
///群名片
@property(nonatomic,strong) NSString* nameCard;
///加入群组时间
@property(nonatomic,assign) time_t joinTime;
///成员类型
@property(nonatomic,assign) TIMGroupMemberRole role;
///禁言结束时间(时间戳)
@property(nonatomic,assign) uint32_t silentUntil;
///自定义字段集合,key 是 NSString*类型,value 是 NSData*类型
@property(nonatomic,strong) NSDictionary* customInfo;
///如果是自己,可以获取自己的群接收选项
@property(nonatomic,assign) TIMGroupReceiveMessageOpt receiveMessageOpt;
@end
///资料与关系链
@interface TIMFriendProfileOption : NSObject
///关系链最大缓存时间(默认缓存一天;获取资料和关系链超过缓存时间,将自动向服务器发起请求)
@property NSInteger expiredSeconds;
@end
///用户资料
@interface TIMUserProfile : TIMCodingModel
/**
* 用户 identifier
*/
@property(nonatomic,strong) NSString* identifier;
/**
* 用户昵称
*/
@property(nonatomic,strong) NSString* nickname;
/**
* 好友验证方式
*/
@property(nonatomic,assign) TIMFriendAllowType allowType;
/**
* 用户头像
*/
@property(nonatomic,strong) NSString* faceURL;
/**
* 用户签名
*/
@property(nonatomic,strong) NSData* selfSignature;
/**
* 用户性别
*/
@property(nonatomic,assign) TIMGender gender;
/**
* 用户生日
*/
@property(nonatomic,assign) uint32_t birthday;
/**
* 用户区域
*/
@property(nonatomic,strong) NSData* location;
/**
* 用户语言
*/
@property(nonatomic,assign) uint32_t language;
/**
* 等级
*/
@property(nonatomic,assign) uint32_t level;
/**
* 角色
*/
@property(nonatomic,assign) uint32_t role;
/**
* 自定义字段集合,key是NSString类型,value是NSData类型或者NSNumber类型
* key值按照后台配置的字符串传入,不包括 TIMProfileTypeKey_Custom_Prefix 前缀
*/
@property(nonatomic,strong) NSDictionary* customInfo;
@end
typedef void(^ProfileCallBack) (TIMUserProfile * profile);
/**
* 好友
*/
@interface TIMFriend : TIMCodingModel
/**
* 好友identifier
*/
@property(nonatomic,strong) NSString *identifier;
/**
* 好友备注(最大96字节,获取自己资料时,该字段为空)
*/
@property(nonatomic,strong) NSString *remark;
/**
* 分组名称 NSString* 列表
*/
@property(nonatomic,strong) NSArray *groups;
/**
* 申请时的添加理由
*/
@property(nonatomic,strong) NSString *addWording;
/**
* 申请时的添加来源
*/
@property(nonatomic,strong) NSString *addSource;
/**
* 添加时间
*/
@property(nonatomic,assign) uint64_t addTime;
/**
* 自定义字段集合,key是NSString类型,value是NSData类型或者NSNumber类型
* key值按照后台配置的字符串传入,不包括 TIMFriendTypeKey_Custom_Prefix 前缀
*/
@property(nonatomic,strong) NSDictionary* customInfo;
/**
* 好友资料
*/
@property(nonatomic,strong) TIMUserProfile *profile;
@end
/**
* 创建群参数
*/
@interface TIMCreateGroupInfo : TIMCodingModel
/**
* 群组Id,nil则使用系统默认Id
*/
@property(nonatomic,strong) NSString* group;
/**
* 群名
*/
@property(nonatomic,strong) NSString* groupName;
/**
* 群类型:Private,Public,ChatRoom,AVChatRoom,BChatRoom
*/
@property(nonatomic,strong) NSString* groupType;
/**
* 是否设置入群选项,Private类型群组请设置为false
*/
@property(nonatomic,assign) BOOL setAddOpt;
/**
* 入群选项
*/
@property(nonatomic,assign) TIMGroupAddOpt addOpt;
/**
* 最大成员数,填0则系统使用默认值
*/
@property(nonatomic,assign) uint32_t maxMemberNum;
/**
* 群公告
*/
@property(nonatomic,strong) NSString* notification;
/**
* 群简介
*/
@property(nonatomic,strong) NSString* introduction;
/**
* 群头像
*/
@property(nonatomic,strong) NSString* faceURL;
/**
* 自定义字段集合,key是NSString*类型,value是NSData*类型
*/
@property(nonatomic,strong) NSDictionary* customInfo;
/**
* 创建成员(TIMCreateGroupMemberInfo*)列表
*/
@property(nonatomic,strong) NSArray <TIMCreateGroupMemberInfo *>* membersInfo;
@end
/**
* 未决请求选项
*/
@interface TIMGroupPendencyOption : TIMCodingModel
/**
* 拉取的起始时间 0:拉取最新的
*/
@property(nonatomic,assign) uint64_t timestamp;
/**
* 每页的数量,最大值为 10,设置超过 10,也最多只能拉回 10 条未决
*/
@property(nonatomic,assign) uint32_t numPerPage;
@end
/**
* 未决请求元信息
*/
@interface TIMGroupPendencyMeta : TIMCodingModel
/**
* 下一次拉取的起始时间戳
*/
@property(nonatomic,assign) uint64_t nextStartTime;
/**
* 已读时间戳大小
*/
@property(nonatomic,assign) uint64_t readTimeSeq;
/**
* 未决未读数
*/
@property(nonatomic,assign) uint32_t unReadCnt;
@end
/**
* 创建群组时的成员信息
*/
@interface TIMCreateGroupMemberInfo : TIMCodingModel
/**
* 被操作成员
*/
@property(nonatomic,strong) NSString* member;
/**
* 成员类型
*/
@property(nonatomic,assign) TIMGroupMemberRole role;
/**
* 自定义字段集合,key是NSString*类型,value是NSData*类型
*/
@property(nonatomic,strong) NSDictionary* customInfo;
@end
/**
* 成员操作返回值
*/
@interface TIMGroupMemberResult : NSObject
/**
* 被操作成员
*/
@property(nonatomic,strong) NSString* member;
/**
* 返回状态
*/
@property(nonatomic,assign) TIMGroupMemberStatus status;
@end
/**
* 未决申请
*/
@interface TIMGroupPendencyItem : TIMCodingModel
/**
* 相关群组id
*/
@property(nonatomic,strong) NSString* groupId;
/**
* 请求者id,请求加群:请求者,邀请加群:邀请人
*/
@property(nonatomic,strong) NSString* fromUser;
/**
* 判决者id,请求加群:0,邀请加群:被邀请人
*/
@property(nonatomic,strong) NSString* toUser;
/**
* 未决添加时间
*/
@property(nonatomic,assign) uint64_t addTime;
/**
* 未决请求类型
*/
@property(nonatomic,assign) TIMGroupPendencyGetType getType;
/**
* 已决标志
*/
@property(nonatomic,assign) TIMGroupPendencyHandleStatus handleStatus;
/**
* 已决结果
*/
@property(nonatomic,assign) TIMGroupPendencyHandleResult handleResult;
/**
* 申请或邀请附加信息
*/
@property(nonatomic,strong) NSString* requestMsg;
/**
* 审批信息:同意或拒绝信息
*/
@property(nonatomic,strong) NSString* handledMsg;
/**
* 同意申请
*
* @param msg 同意理由,选填
* @param succ 成功回调
* @param fail 失败回调,返回错误码和错误描述
*/
-(void) accept:(NSString*)msg succ:(TIMSucc)succ fail:(TIMFail)fail;
/**
* 拒绝申请
*
* @param msg 拒绝理由,选填
* @param succ 成功回调
* @param fail 失败回调,返回错误码和错误描述
*/
-(void) refuse:(NSString*)msg succ:(TIMSucc)succ fail:(TIMFail)fail;
/**
* 用户自己的id
*/
@property(nonatomic,strong) NSString* selfIdentifier;
@end
/**
* 关系链变更详细信息
*/
@interface TIMSNSChangeInfo : NSObject
/**
* 用户 identifier
*/
@property(nonatomic,strong) NSString * identifier;
/**
* 用户昵称
*/
@property(nonatomic,strong) NSString * nickname;
/**
* 申请添加时有效,添加理由
*/
@property(nonatomic,strong) NSString * wording;
/**
* 申请时填写,添加来源
*/
@property(nonatomic,strong) NSString * source;
/**
* 备注 type=TIM_SNS_SYSTEM_SNS_PROFILE_CHANGE 有效
*/
@property(nonatomic,strong) NSString * remark;
@end
/**
* 发送消息给多用户的失败回调信息
*/
@interface TIMSendToUsersDetailInfo : NSObject
/**
* 发送消息成功的目标用户数
*/
@property(nonatomic,assign) uint32_t succCnt;
/**
* 发送消息失败的目标用户数
*/
@property(nonatomic,assign) uint32_t failCnt;
/**
* 失败信息(TIMSendToUsersErrInfo*)列表
*/
@property(nonatomic,strong) NSArray *errInofs;
@end
/**
* 发送消息给多用户的失败信息
*/
@interface TIMSendToUsersErrInfo : NSObject
/**
* 发送消息失败的目标用户id
*/
@property(nonatomic,strong) NSString *identifier;
/**
* 错误码
*/
@property(nonatomic,assign) int code;
/**
* 错误描述
*/
@property(nonatomic,strong) NSString *err;
@end
#endif
/////////////////////////////////////////////////////////////////////
//
// 腾讯云通信服务 IMSDK
//
// 模块名称:TIMConversation + MsgExt
//
// 模块功能:此处主要存放待废弃的 API 函数,建议您使用 TIMConversation.h 内部声明的接口函数
//
/////////////////////////////////////////////////////////////////////
#ifndef TIMConversation_h
#define TIMConversation_h
#import "TIMConversation.h"
@interface TIMConversation (MsgExt)
/**
* 向前获取会话漫游消息
*
* 调用方式和 getMessage 一样,区别是 getMessage 获取的是时间更老的消息,主要用于下拉 Tableview 刷新消息数据,getMessageForward 获取的是时间更新的消息,主要用于上拉 Tableview 刷新消息数据。
*
* @param count 获取数量
* @param last 上次最后一条消息,如果 last 为 nil,从最新的消息开始读取
* @param succ 成功时回调
* @param fail 失败时回调
*
* @return 0:本次操作成功;1:本次操作失败
*/
- (int)getMessageForward:(int)count last:(TIMMessage*)last succ:(TIMGetMsgSucc)succ fail:(TIMFail)fail;
/**
* 获取指定会话消息
*
* @param locators 消息定位符(TIMMessageLocator)数组
* @param succ 成功时回调
* @param fail 失败时回调
*
* @return 0:本次操作成功;1:本次操作失败
*/
- (int)findMessages:(NSArray*)locators succ:(TIMGetMsgSucc)succ fail:(TIMFail)fail;
/**
* 获取自己的 id
*
* @return 用户 id
*/
- (NSString*)getSelfIdentifier;
@end
#endif /* TIMConversation_h */
/////////////////////////////////////////////////////////////////////
//
// 腾讯云通信服务 IMSDK
//
// 模块名称:TIMConversation 会话模块
//
// 模块功能:一个会话对应一个聊天窗口,比如跟一个好友的 C2C 聊天叫做一个会话,一个聊天群也叫做一个会话。
//
// TIMConversation 提供的接口函数都是围绕消息的相关操作,包括:消息发送、获取历史消息、设置消息已读、撤回和删除等等。
//
/////////////////////////////////////////////////////////////////////
#ifndef ImSDK_TIMConversation_h
#define ImSDK_TIMConversation_h
#import "TIMComm.h"
#import "TIMCallback.h"
#import "TIMMessage.h"
@class TIMMessage;
@interface TIMConversation : NSObject
#pragma mark 一,发消息
/////////////////////////////////////////////////////////////////////////////////
//
// (一)发消息
//
/////////////////////////////////////////////////////////////////////////////////
/// @name 发消息相关接口
/// @{
/**
* 1.1 发送消息
*
* TIMMessage 由多个 TIMElem 组成,一个 TIMElem 可以是一串文本,也可以是一张图片。
* 虽然说每一条消息都可以包含多个 TIMElem,但这个并不常用,通常您只需要在一个 TIMMessage 塞入一个 TIMElem 即可。
*
* 详情请参考官网文档 [消息收发](https://cloud.tencent.com/document/product/269/9150)
*
* @param msg 消息体
* @param succ 发送成功时回调
* @param fail 发送失败时回调
*
* @return 0:操作成功;1:操作失败
*/
- (int)sendMessage:(TIMMessage*)msg succ:(TIMSucc)succ fail:(TIMFail)fail;
/**
* 1.2 发送在线消息(无痕消息)
*
* “在线消息”,也可以称为是“无痕消息”。跟普通消息的区别在于:在线消息不会被云服务存储,也不会存储于本地数据库中。
* 如果接收者在线,可以收到消息,但如果接收者离线,重新上线后也不能通过 getMessage() 接口从历史消息里查到它们。
*
* 该类型消息比较适合用作发送广播通知等不重要的提示消息。
*
* 1. 在线消息不会被计入未读计数
* 2. 暂不支持在 AVChatRoom 和 BChatRoom 中发送。
*
* @param msg 消息体
* @param succ 成功回调
* @param fail 失败回调
*
* @return 0:操作成功;1:操作失败
*/
- (int)sendOnlineMessage:(TIMMessage*)msg succ:(TIMSucc)succ fail:(TIMFail)fail;
///@}
#pragma mark 二,获取消息
/////////////////////////////////////////////////////////////////////////////////
//
// (二)获取消息
//
/////////////////////////////////////////////////////////////////////////////////
/// @name 获取消息相关接口
/// @{
/**
* 2.1 从云端拉取历史消息
*
* 如果用户的网络正常且登录成功,可以通过该接口拉取历史消息,该接口会返回云端存储的历史消息(最多存储7天)。
*
* 1. 单聊和群聊消息会在云端免费存储7天,如果希望存储更长时间,可前往
* ([IM 控制台](https://console.cloud.tencent.com/avc) -> 功能配置 -> 消息 ->消息漫游时长)进行购买,
* 具体资费请参考 [价格说明](https://cloud.tencent.com/document/product/269/11673)。
*
* 2. 对于图片、语音等资源类消息,获取到的消息体只会包含描述信息,需要通过额外的接口下载数据,
* 详情请参考 [消息收发](https://cloud.tencent.com/document/product/269/9150)中的 "消息解析" 部分文档。
*
* @param count 获取数量
* @param last 上次最后一条消息,如果 last 为 nil,从最新的消息开始读取
* @param succ 成功时回调
* @param fail 失败时回调
*
* @return 0:本次操作成功;1:本次操作失败
*/
- (int)getMessage:(int)count last:(TIMMessage*)last succ:(TIMGetMsgSucc)succ fail:(TIMFail)fail;
/**
* 2.2 从本地数据库中获取历史消息
*
* 如果客户网络异常或登录失败,可以通过该接口获取本地存储的历史消息,调用方法和 getMessage() 一致
* AVChatRoom,BChatRoom 消息数量很大,出于程序性能的考虑,默认不存本地,不能通过这个接口拉取到对应群消息
*
* @param count 获取数量
* @param last 上次最后一条消息
* @param succ 成功时回调
* @param fail 失败时回调
*
* @return 0:本次操作成功;1:本次操作失败
*/
- (int)getLocalMessage:(int)count last:(TIMMessage*)last succ:(TIMGetMsgSucc)succ fail:(TIMFail)fail;
/**
* 2.3 获取当前会话的最后一条消息
*
* 可用于“装饰”会话列表,目前大多数 App 的会话列表中都会显示该会话的最后一条消息
*
* @return 最后一条消息
*/
- (TIMMessage*)getLastMsg;
///@}
#pragma mark 三,设置消息已读
/////////////////////////////////////////////////////////////////////////////////
//
// (三)设置消息已读
//
/////////////////////////////////////////////////////////////////////////////////
/// @name 设置消息已读
/// @{
/**
* 3.1 标记消息为已读状态
*
* 该接口会标记当前消息以及之前的所有消息为已读状态,标记消息为已读状态会有两个作用:
* 1. 已经被标记为已读的消息不会重复提醒,下次登录或者换一台终端设备登录 IM 时,都不会再次收到该消息的未读提醒。
* 2. 如果发送者通过 TIMUserConfig -> enableReadReceipt 开启了 “被阅回执”,接收者在标记已读状态时,发送者会收到“被阅提醒”。
*
* @note 该接口尚不支持标记单独一条消息,只能标记一批。即标记当前一条消息,之前的消息也会全被标记为已读状态。
*
* @param fromMsg 会话内最近一条已读的消息,nil 表示上报最新消息
* @param succ 成功时回调
* @param fail 失败时回调
*
* @return 0 表示成功
*/
- (int)setReadMessage:(TIMMessage*)fromMsg succ:(TIMSucc)succ fail:(TIMFail)fail;
/**
* 3.2 获取会话的未读消息计数
*
* 1. 同一个终端登录,在未卸载 APP 的情况下,您可以通过当前接口获取的未读消息的个数。
* 2. 如果希望换一台终端也能取到同样的未读计数提醒,或者卸载 APP 再重装,未读计数提醒还能保留卸载前的状态,
* 就需要设置 TIMUserConfig 的 disableAutoReport 为 YES,这样可以开启多终端同步未读提醒。
*
* 详情参考 [未读消息计数](https://cloud.tencent.com/document/product/269/9151)
*
* @return 返回未读计数
*/
- (int)getUnReadMessageNum;
///@}
#pragma mark 四,撤回/删除消息
/////////////////////////////////////////////////////////////////////////////////
//
// (四)撤回/删除消息
//
/////////////////////////////////////////////////////////////////////////////////
/// @name 撤回/删除消息相关接口
/// @{
/**
* 4.1 撤回一条已发送的消息(消息发送后 )
*
* 1. 消息撤回的有效时间为2分钟,即消息发出2分钟后不能再撤回。
* 2. 仅支持 C2C 会话和 GROUP 会话中发送的消息,无法撤销 OnlineMessage,也无法撤销 AVChatRoom 和 BChatRoom 中的消息。
* 3. 您需要在 TIMUserConfig -> TIMMessageRevokeListener 监听 onRevokeMessage() 消息撤回回调,
* 如果消息撤回成功,消息的接收方会收到一次 onRevokeMessage:(TIMMessageLocator*) 回调,TIMMessageLocator 相当于一条消息的定位标志。
* 您可以在已收到的历史消息里进行遍历,通过 TIMMessage 中的 respondsToLocator() 接口进行比对,以便定位到该条消息。
*
* @param msg 被撤回的消息
* @param succ 成功时回调
* @param fail 失败时回调
*
* @return 0:本次操作成功;1:本次操作失败
*/
- (int)revokeMessage:(TIMMessage*)msg succ:(TIMSucc)succ fail:(TIMFail)fail;
/**
* 4.2 删除当前会话的本地历史消息
*
* @param succ 成功时回调
* @param fail 失败时回调
*
* @return 0 本次操作成功
*/
- (int)deleteLocalMessage:(TIMSucc)succ fail:(TIMFail)fail;
///@}
#pragma mark 五,获取会话信息
/////////////////////////////////////////////////////////////////////////////////
//
// (五)获取会话信息
//
/////////////////////////////////////////////////////////////////////////////////
/// @name 获取会话信息相关接口
/// @{
/**
* 5.1 获取会话类型
*
* @return 会话类型
*/
- (TIMConversationType)getType;
/**
* 5.2 获取会话 ID
*
* C2C:对方账号;Group:群组Id。
*
* 对同一个单聊或则群聊会话,getReceiver 获取的会话 ID 都是固定的,C2C 获取的是对方账号,Group 获取的是群组 Id。
*
* @return 会话人
*/
- (NSString*)getReceiver;
/**
* 5.3 获取群名称
*
* 获取群名称,只有群会话有效。
*
* @return 群名称
*/
- (NSString*)getGroupName;
///@}
#pragma mark 六,草稿箱
/////////////////////////////////////////////////////////////////////////////////
//
// (六)草稿箱
//
/////////////////////////////////////////////////////////////////////////////////
/// @name 草稿箱
/// @{
/**
* 6.1 添加未编辑完的草稿消息
*
* 在发送消息时,常常会遇到尚未编辑完毕就要切换到其它聊天窗口的情况,这些未编辑完的消息就可以通过 setDraft() 接口存储到草稿箱中。
* 草稿信息会存本地数据库,重新登录后依然可以获取。
*
*
* @param draft 草稿内容,详情请参考 TIMMessage.h 里面的 TIMMessageDraft 定义
*
* @return 0:成功;1:失败
*/
- (int)setDraft:(TIMMessageDraft*)draft;
/**
* 6.2 获取未编辑完的草稿消息
*
* @return 草稿内容,没有草稿返回 nil
*/
- (TIMMessageDraft*)getDraft;
///@}
#pragma mark 七,导入消息到会话
/////////////////////////////////////////////////////////////////////////////////
//
// (七)导入消息到会话
//
/////////////////////////////////////////////////////////////////////////////////
/// @name 导入消息到会话相关接口
/// @{
/**
* 7.1 向本地消息列表中添加一条消息,但并不将其发送出去。
*
* 该接口主要用于满足向聊天会话中插入一些提示性消息的需求,比如“您已经退出该群”,这类消息有展示
* 在聊天消息区的需求,但并没有发送给其他人的必要。
* 所以 saveMessage() 相当于一个被禁用了网络发送能力的 sendMessage() 接口。
*
* @param msg 消息体
* @param sender 发送方
* @param isRead 是否已读,如果发送方是自己,默认已读
*
* @return 0:成功;1:失败
*/
- (int)saveMessage:(TIMMessage*)msg sender:(NSString*)sender isReaded:(BOOL)isRead;
/**
* 7.2 将消息导入本地数据库
*
* @param msgs 消息(TIMMessage*)列表
*
* @return 0:成功;1:失败
*/
- (int)importMessages:(NSArray*)msgs;
///@}
@end
#endif
//
// TIMErrorCode.h
// ImSDK
//
// Created by jameskhdeng on 2018/11/23.
// Copyright © 2018 tencent. All rights reserved.
//
#ifndef TIMErrorCode_h
#define TIMErrorCode_h
enum ERROR_CODE {
/////////////////////////////////////////////////////////////////////////////////
//
// (一)IM SDK 的错误码
//
/////////////////////////////////////////////////////////////////////////////////
// 通用错误码
ERR_SUCC = 0, ///< 无错误。
ERR_IN_PROGESS = 6015, ///< 执行中,请做好接口调用控制,例如,第一次初始化操作在回调前,后续的初始化操作会返回该错误码。
ERR_INVALID_PARAMETERS = 6017, ///< 参数无效,请检查参数是否符合要求,具体可查看错误信息进一步定义哪个字段。
ERR_IO_OPERATION_FAILED = 6022, ///< 操作本地 IO 错误,检查是否有读写权限,磁盘是否已满。
ERR_INVALID_JSON = 6027, ///< 错误的 JSON 格式,请检查参数是否符合接口的要求,具体可查看错误信息进一步定义哪个字段。
ERR_OUT_OF_MEMORY = 6028, ///< 内存不足,可能存在内存泄漏,iOS 平台使用 Instrument 工具,Android 平台使用 Profiler 工具,分析出什么地方的内存占用高。
ERR_PARSE_RESPONSE_FAILED = 6001, ///< PB 解析失败,内部错误,可 [提交工单](https://console.cloud.tencent.com/workorder/category?level1_id=29&level2_id=40&source=0&data_title=%E4%BA%91%E9%80%9A%E4%BF%A1%20%20IM&step=1) 提供使用接口、错误码、错误信息给客服解决。
ERR_SERIALIZE_REQ_FAILED = 6002, ///< PB 序列化失败,内部错误,可 [提交工单](https://console.cloud.tencent.com/workorder/category?level1_id=29&level2_id=40&source=0&data_title=%E4%BA%91%E9%80%9A%E4%BF%A1%20%20IM&step=1) 提供使用接口、错误码、错误信息给客服解决。
ERR_SDK_NOT_INITIALIZED = 6013, ///< IM SDK 未初始化,初始化成功回调之后重试。
ERR_LOADMSG_FAILED = 6005, ///< 加载本地数据库操作失败,可能存储文件有损坏,可 [提交工单](https://console.cloud.tencent.com/workorder/category?level1_id=29&level2_id=40&source=0&data_title=%E4%BA%91%E9%80%9A%E4%BF%A1%20%20IM&step=1) 联系客服定位具体问题。
ERR_DATABASE_OPERATE_FAILED = 6019, ///< 本地数据库操作失败,可能是部分目录无权限或者数据库文件已损坏。
ERR_SDK_COMM_CROSS_THREAD = 7001, ///< 跨线程错误,不能在跨越不同线程中执行,内部错误,可 [提交工单](https://console.cloud.tencent.com/workorder/category?level1_id=29&level2_id=40&source=0&data_title=%E4%BA%91%E9%80%9A%E4%BF%A1%20%20IM&step=1) 提供使用接口、错误码、错误信息给客服解决。
ERR_SDK_COMM_TINYID_EMPTY = 7002, ///< TinyId 为空,内部错误,可 [提交工单](https://console.cloud.tencent.com/workorder/category?level1_id=29&level2_id=40&source=0&data_title=%E4%BA%91%E9%80%9A%E4%BF%A1%20%20IM&step=1) 提供使用接口、错误码、错误信息给客服解决。
ERR_SDK_COMM_INVALID_IDENTIFIER = 7003, ///< Identifier 非法,必须不为空,要求可打印 ASCII 字符(0x20-0x7e),长度不超过32字节。
ERR_SDK_COMM_FILE_NOT_FOUND = 7004, ///< 文件不存在,请检查文件路径是否正确。
ERR_SDK_COMM_FILE_TOO_LARGE = 7005, ///< 文件大小超出了限制,如果上传文件,最大限制是28MB。
ERR_SDK_COMM_FILE_SIZE_EMPTY = 7006, ///< 空文件,要求文件大小不是0字节,如果上传图片、语音、视频或文件,请检查文件是否正确生成。
ERR_SDK_COMM_FILE_OPEN_FAILED = 7007, ///< 文件打开失败,请检查文件是否存在,或者已被独占打开,引起 SDK 打开失败。
// 帐号错误码
ERR_SDK_NOT_LOGGED_IN = 6014, ///< IM SDK 未登录,请先登录,成功回调之后重试,或者已被踢下线,可使用 TIMManager getLoginUser 检查当前是否在线。
ERR_NO_PREVIOUS_LOGIN = 6026, ///< 自动登录时,并没有登录过该用户,这时候请调用 login 接口重新登录。
ERR_USER_SIG_EXPIRED = 6206, ///< UserSig 过期,请重新获取有效的 UserSig 后再重新登录。
ERR_LOGIN_KICKED_OFF_BY_OTHER = 6208, ///< 其他终端登录同一个帐号,引起已登录的帐号被踢,需重新登录。
ERR_SDK_ACCOUNT_LOGIN_IN_PROCESS = 7501, ///< 登录正在执行中,例如,第一次 login 或 autoLogin 操作在回调前,后续的 login 或 autoLogin 操作会返回该错误码。
ERR_SDK_ACCOUNT_LOGOUT_IN_PROCESS = 7502, ///< 登出正在执行中,例如,第一次 logout 操作在回调前,后续的 logout 操作会返回该错误码。
ERR_SDK_ACCOUNT_TLS_INIT_FAILED = 7503, ///< TLS SDK 初始化失败,内部错误,可 [提交工单](https://console.cloud.tencent.com/workorder/category?level1_id=29&level2_id=40&source=0&data_title=%E4%BA%91%E9%80%9A%E4%BF%A1%20%20IM&step=1) 提供使用接口、错误码、错误信息给客服解决。
ERR_SDK_ACCOUNT_TLS_NOT_INITIALIZED = 7504, ///< TLS SDK 未初始化,内部错误,可 [提交工单](https://console.cloud.tencent.com/workorder/category?level1_id=29&level2_id=40&source=0&data_title=%E4%BA%91%E9%80%9A%E4%BF%A1%20%20IM&step=1) 提供使用接口、错误码、错误信息给客服解决。
ERR_SDK_ACCOUNT_TLS_TRANSPKG_ERROR = 7505, ///< TLS SDK TRANS 包格式错误,内部错误,可 [提交工单](https://console.cloud.tencent.com/workorder/category?level1_id=29&level2_id=40&source=0&data_title=%E4%BA%91%E9%80%9A%E4%BF%A1%20%20IM&step=1) 提供使用接口、错误码、错误信息给客服解决。
ERR_SDK_ACCOUNT_TLS_DECRYPT_FAILED = 7506, ///< TLS SDK 解密失败,内部错误,可 [提交工单](https://console.cloud.tencent.com/workorder/category?level1_id=29&level2_id=40&source=0&data_title=%E4%BA%91%E9%80%9A%E4%BF%A1%20%20IM&step=1) 提供使用接口、错误码、错误信息给客服解决。
ERR_SDK_ACCOUNT_TLS_REQUEST_FAILED = 7507, ///< TLS SDK 请求失败,内部错误,可 [提交工单](https://console.cloud.tencent.com/workorder/category?level1_id=29&level2_id=40&source=0&data_title=%E4%BA%91%E9%80%9A%E4%BF%A1%20%20IM&step=1) 提供使用接口、错误码、错误信息给客服解决。
ERR_SDK_ACCOUNT_TLS_REQUEST_TIMEOUT = 7508, ///< TLS SDK 请求超时,内部错误,可 [提交工单](https://console.cloud.tencent.com/workorder/category?level1_id=29&level2_id=40&source=0&data_title=%E4%BA%91%E9%80%9A%E4%BF%A1%20%20IM&step=1) 提供使用接口、错误码、错误信息给客服解决。
// 消息错误码
ERR_INVALID_CONVERSATION = 6004, ///< 会话无效,getConversation 时检查是否已经登录,如未登录获取会话,会有此错误码返回。
ERR_FILE_TRANS_AUTH_FAILED = 6006, ///< 文件传输鉴权失败,可 [提交工单](https://console.cloud.tencent.com/workorder/category?level1_id=29&level2_id=40&source=0&data_title=%E4%BA%91%E9%80%9A%E4%BF%A1%20%20IM&step=1) 提供使用接口、错误码、错误信息给客服解决。
ERR_FILE_TRANS_NO_SERVER = 6007, ///< 文件传输获取 Server 列表失败,可 [提交工单](https://console.cloud.tencent.com/workorder/category?level1_id=29&level2_id=40&source=0&data_title=%E4%BA%91%E9%80%9A%E4%BF%A1%20%20IM&step=1) 提供使用接口、错误码、错误信息给客服解决。
ERR_FILE_TRANS_UPLOAD_FAILED = 6008, ///< 文件传输上传失败,请检查网络是否连接,如果上传的是图片,确认图片能够正常打开。
ERR_FILE_TRANS_DOWNLOAD_FAILED = 6009, ///< 文件传输下载失败,请检查网络,或者文件、语音是否已经过期,目前资源文件存储7天。
ERR_HTTP_REQ_FAILED = 6010, ///< HTTP 请求失败,请检查 URL 地址是否合法,可在网页浏览器尝试访问该 URL 地址。
ERR_INVALID_MSG_ELEM = 6016, ///< IM SDK 无效消息 elem,具体可查看错误信息进一步定义哪个字段。
ERR_INVALID_SDK_OBJECT = 6021, ///< 无效的对象,例如用户自己生成 TIMImage 对象,或内部赋值错误导致对象无效。
ERR_SDK_MSG_BODY_SIZE_LIMIT = 8001, ///< 消息长度超出限制,消息长度不要超过8k,消息长度是各个 elem 长度的总和,elem 长度是所有 elem 字段的长度总和。
ERR_SDK_MSG_KEY_REQ_DIFFER_RSP = 8002, ///< 消息 KEY 错误,内部错误,网络请求包的 KEY 和 回复包的不一致。
// 群组错误码
ERR_SDK_GROUP_INVALID_ID = 8501, ///< 群组 ID 非法,自定义群组 ID 必须为可打印 ASCII 字符(0x20-0x7e),最长48个字节,且前缀不能为 @TGS#(避免与服务端默认分配的群组 ID 混淆)。
ERR_SDK_GROUP_INVALID_NAME = 8502, ///< 群名称非法,群名称最长30字节,字符编码必须是 UTF-8 ,如果包含中文,可能用多个字节表示一个中文字符,请注意检查字符串的字节长度。
ERR_SDK_GROUP_INVALID_INTRODUCTION = 8503, ///< 群简介非法,群简介最长240字节,字符编码必须是 UTF-8 ,如果包含中文,可能用多个字节表示一个中文字符,请注意检查字符串的字节长度。
ERR_SDK_GROUP_INVALID_NOTIFICATION = 8504, ///< 群公告非法,群公告最长300字节,字符编码必须是 UTF-8 ,如果包含中文,可能用多个字节表示一个中文字符,请注意检查字符串的字节长度。
ERR_SDK_GROUP_INVALID_FACE_URL = 8505, ///< 群头像 URL 非法,群头像 URL 最长100字节,可在网页浏览器尝试访问该 URL 地址。
ERR_SDK_GROUP_INVALID_NAME_CARD = 8506, ///< 群名片非法,群名片最长50字节,字符编码必须是 UTF-8 ,如果包含中文,可能用多个字节表示一个中文字符,请注意检查字符串的字节长度。
ERR_SDK_GROUP_MEMBER_COUNT_LIMIT = 8507, ///< 超过群组成员数的限制,在创建群和邀请成员时,指定的成员数超出限制,最大群成员数量:私有群是200人,公开群是2000人,聊天室是10000人,音视频聊天室和在线成员广播大群无限制。
ERR_SDK_GROUP_JOIN_PRIVATE_GROUP_DENY = 8508, ///< 不允许申请加入 Private 群组,任意群成员可邀请入群,且无需被邀请人同意。
ERR_SDK_GROUP_INVITE_SUPER_DENY = 8509, ///< 不允许邀请角色为群主的成员,请检查角色字段是否填写正确。
ERR_SDK_GROUP_INVITE_NO_MEMBER = 8510, ///< 不允许邀请0个成员,请检查成员字段是否填写正确。
// 关系链错误码
ERR_SDK_FRIENDSHIP_INVALID_PROFILE_KEY = 9001, ///< 资料字段非法,资料支持标配字段及自定义字段,其中自定义字段的关键字,必须是英文字母,且长度不得超过8字节,自定义字段的值最长不能超过500字节。
ERR_SDK_FRIENDSHIP_INVALID_ADD_REMARK = 9002, ///< 备注字段非法,最大96字节,字符编码必须是 UTF-8 ,如果包含中文,可能用多个字节表示一个中文字符,请注意检查字符串的字节长度。
ERR_SDK_FRIENDSHIP_INVALID_ADD_WORDING = 9003, ///< 请求添加好友的请求说明字段非法,最大120字节,字符编码必须是 UTF-8 ,如果包含中文,可能用多个字节表示一个中文字符,请注意检查字符串的字节长度。
ERR_SDK_FRIENDSHIP_INVALID_ADD_SOURCE = 9004, ///< 请求添加好友的添加来源字段非法,来源需要添加“AddSource_Type_”前缀。
ERR_SDK_FRIENDSHIP_FRIEND_GROUP_EMPTY = 9005, ///< 好友分组字段非法,必须不为空,每个分组的名称最长30字节,字符编码必须是 UTF-8 ,如果包含中文,可能用多个字节表示一个中文字符,请注意检查字符串的字节长度。
// 网络错误码
ERR_SDK_NET_ENCODE_FAILED = 9501, ///< SSO 加密失败,内部错误,可 [提交工单](https://console.cloud.tencent.com/workorder/category?level1_id=29&level2_id=40&source=0&data_title=%E4%BA%91%E9%80%9A%E4%BF%A1%20%20IM&step=1) 提供使用接口、错误码、错误信息给客服解决。
ERR_SDK_NET_DECODE_FAILED = 9502, ///< SSO 解密失败,内部错误,可 [提交工单](https://console.cloud.tencent.com/workorder/category?level1_id=29&level2_id=40&source=0&data_title=%E4%BA%91%E9%80%9A%E4%BF%A1%20%20IM&step=1) 提供使用接口、错误码、错误信息给客服解决。
ERR_SDK_NET_AUTH_INVALID = 9503, ///< SSO 未完成鉴权,可能登录未完成,请在登录完成后再操作。
ERR_SDK_NET_COMPRESS_FAILED = 9504, ///< 数据包压缩失败,内部错误,可 [提交工单](https://console.cloud.tencent.com/workorder/category?level1_id=29&level2_id=40&source=0&data_title=%E4%BA%91%E9%80%9A%E4%BF%A1%20%20IM&step=1) 提供使用接口、错误码、错误信息给客服解决。
ERR_SDK_NET_UNCOMPRESS_FAILED = 9505, ///< 数据包解压失败,内部错误,可 [提交工单](https://console.cloud.tencent.com/workorder/category?level1_id=29&level2_id=40&source=0&data_title=%E4%BA%91%E9%80%9A%E4%BF%A1%20%20IM&step=1) 提供使用接口、错误码、错误信息给客服解决。
ERR_SDK_NET_FREQ_LIMIT = 9506, ///< 调用频率限制,最大每秒发起 5 次请求。
ERR_SDK_NET_REQ_COUNT_LIMIT = 9507, ///< 请求队列満,超过同时请求的数量限制,最大同时发起1000个请求。
ERR_SDK_NET_DISCONNECT = 9508, ///< 网络已断开,未建立连接,或者建立 socket 连接时,检测到无网络。
ERR_SDK_NET_ALLREADY_CONN = 9509, ///< 网络连接已建立,重复创建连接,内部错误。
ERR_SDK_NET_CONN_TIMEOUT = 9510, ///< 建立网络连接超时,请等网络恢复后重试。
ERR_SDK_NET_CONN_REFUSE = 9511, ///< 网络连接已被拒绝,请求过于频繁,服务端拒绝服务。
ERR_SDK_NET_NET_UNREACH = 9512, ///< 没有到达网络的可用路由,请等网络恢复后重试。
ERR_SDK_NET_SOCKET_NO_BUFF = 9513, ///< 系统中没有足够的缓冲区空间资源可用来完成调用,系统过于繁忙,内部错误。
ERR_SDK_NET_RESET_BY_PEER = 9514, ///< 对端重置了连接,可能服务端过载,SDK 内部会自动重连,请等网络连接成功 onConnSucc ( iOS ) 或 onConnected ( Android ) 回调后重试。
ERR_SDK_NET_SOCKET_INVALID = 9515, ///< socket 套接字无效,内部错误,可 [提交工单](https://console.cloud.tencent.com/workorder/category?level1_id=29&level2_id=40&source=0&data_title=%E4%BA%91%E9%80%9A%E4%BF%A1%20%20IM&step=1) 提供使用接口、错误码、错误信息给客服解决。
ERR_SDK_NET_HOST_GETADDRINFO_FAILED = 9516, ///< IP 地址解析失败,内部错误,可能是本地 imsdk_config 配置文件被损坏,读取到到 IP 地址非法。
ERR_SDK_NET_CONNECT_RESET = 9517, ///< 网络连接到中间节点或服务端重置,引起连接失效,内部错误,SDK 内部会自动重连,请等网络连接成功 onConnSucc ( iOS ) 或 onConnected ( Android ) 回调后重试。
ERR_SDK_NET_WAIT_INQUEUE_TIMEOUT = 9518, ///< 请求包等待进入待发送队列超时,发送时网络连接建立比较慢 或 频繁断网重连时,会出现该错误,请检查网络连接是否正常。
ERR_SDK_NET_WAIT_SEND_TIMEOUT = 9519, ///< 请求包已进入待发送队列,等待进入系统的网络 buffer 超时,数据包较多 或 发送线程处理不过来,内部错误。
ERR_SDK_NET_WAIT_ACK_TIMEOUT = 9520, ///< 请求包已进入系统的网络 buffer ,等待服务端回包超时,可能请求包没离开终端设备、中间路由丢弃、服务端意外丢包或回包被系统网络层丢弃,内部错误。
/////////////////////////////////////////////////////////////////////////////////
//
// (二)服务端的错误码
//
/////////////////////////////////////////////////////////////////////////////////
// SSO 接入层的错误码
ERR_SVR_SSO_CONNECT_LIMIT = -302 , ///< SSO 的连接数量超出限制,服务端拒绝服务。
ERR_SVR_SSO_VCODE = -10000, ///< 下发验证码标志错误。
ERR_SVR_SSO_D2_EXPIRED = -10001, ///< D2 过期。
ERR_SVR_SSO_A2_UP_INVALID = -10003, ///< A2 校验失败等场景使用。
ERR_SVR_SSO_A2_DOWN_INVALID = -10004, ///< 处理下行包时发现 A2 验证没通过或者被安全打击。
ERR_SVR_SSO_EMPTY_KEY = -10005, ///< 不允许空 D2Key 加密。
ERR_SVR_SSO_UIN_INVALID = -10006, ///< D2 中的 uin 和 SSO 包头的 uin 不匹配。
ERR_SVR_SSO_VCODE_TIMEOUT = -10007, ///< 验证码下发超时。
ERR_SVR_SSO_NO_IMEI_AND_A2 = -10008, ///< 需要带上 IMEI 和 A2 。
ERR_SVR_SSO_COOKIE_INVALID = -10009, ///< Cookie 非法。
ERR_SVR_SSO_DOWN_TIP = -10101, ///< 下发提示语,D2 过期。
ERR_SVR_SSO_DISCONNECT = -10102, ///< 断链锁屏。
ERR_SVR_SSO_IDENTIFIER_INVALID = -10103, ///< 失效身份。
ERR_SVR_SSO_CLIENT_CLOSE = -10104, ///< 终端自动退出。
ERR_SVR_SSO_MSFSDK_QUIT = -10105, ///< MSFSDK 自动退出。
ERR_SVR_SSO_D2KEY_WRONG = -10106, ///< SSO D2key 解密失败次数太多,通知终端需要重置,重新刷新 D2 。
ERR_SVR_SSO_UNSURPPORT = -10107, ///< 不支持聚合,给终端返回统一的错误码。终端在该 TCP 长连接上停止聚合。
ERR_SVR_SSO_PREPAID_ARREARS = -10108, ///< 预付费欠费。
ERR_SVR_SSO_PACKET_WRONG = -10109, ///< 请求包格式错误。
ERR_SVR_SSO_APPID_BLACK_LIST = -10110, ///< SDKAppID 黑名单。
ERR_SVR_SSO_CMD_BLACK_LIST = -10111, ///< SDKAppID 设置 service cmd 黑名单。
ERR_SVR_SSO_APPID_WITHOUT_USING = -10112, ///< SDKAppID 停用。
ERR_SVR_SSO_FREQ_LIMIT = -10113, ///< 频率限制(用户),频率限制是设置针对某一个协议的每秒请求数的限制。
ERR_SVR_SSO_OVERLOAD = -10114, ///< 过载丢包(系统),连接的服务端处理过多请求,处理不过来,拒绝服务。
// 资源文件错误码
ERR_SVR_RES_NOT_FOUND = 114000, ///< 要发送的资源文件不存在。
ERR_SVR_RES_ACCESS_DENY = 114001, ///< 要发送的资源文件不允许访问。
ERR_SVR_RES_SIZE_LIMIT = 114002, ///< 文件大小超过限制。
ERR_SVR_RES_SEND_CANCEL = 114003, ///< 用户取消发送,如发送过程中登出等原因。
ERR_SVR_RES_READ_FAILED = 114004, ///< 读取文件内容失败。
ERR_SVR_RES_TRANSFER_TIMEOUT = 114005, ///< 资源文件(如图片、文件、语音、视频)传输超时,一般是网络问题导致。
ERR_SVR_RES_INVALID_PARAMETERS = 114011, ///< 参数非法。
ERR_SVR_RES_INVALID_FILE_MD5 = 115066, ///< 文件 MD5 校验失败。
ERR_SVR_RES_INVALID_PART_MD5 = 115068, ///< 分片 MD5 校验失败。
// 后台公共错误码
ERR_SVR_COMM_INVALID_HTTP_URL = 60002, ///< HTTP 解析错误 ,请检查 HTTP 请求 URL 格式。
ERR_SVR_COMM_REQ_JSON_PARSE_FAILED = 60003, ///< HTTP 请求 JSON 解析错误,请检查 JSON 格式。
ERR_SVR_COMM_INVALID_ACCOUNT = 60004, ///< 请求 URI 或 JSON 包体中 Identifier 或 UserSig 错误。
ERR_SVR_COMM_INVALID_ACCOUNT_EX = 60005, ///< 请求 URI 或 JSON 包体中 Identifier 或 UserSig 错误。
ERR_SVR_COMM_INVALID_SDKAPPID = 60006, ///< SDKAppID 失效,请核对 SDKAppID 有效性。
ERR_SVR_COMM_REST_FREQ_LIMIT = 60007, ///< REST 接口调用频率超过限制,请降低请求频率。
ERR_SVR_COMM_REQUEST_TIMEOUT = 60008, ///< 服务请求超时或 HTTP 请求格式错误,请检查并重试。
ERR_SVR_COMM_INVALID_RES = 60009, ///< 请求资源错误,请检查请求 URL。
ERR_SVR_COMM_ID_NOT_ADMIN = 60010, ///< REST API 请求的 Identifier 字段请填写 App 管理员帐号。
ERR_SVR_COMM_SDKAPPID_FREQ_LIMIT = 60011, ///< SDKAppID 请求频率超限,请降低请求频率。
ERR_SVR_COMM_SDKAPPID_MISS = 60012, ///< REST 接口需要带 SDKAppID,请检查请求 URL 中的 SDKAppID。
ERR_SVR_COMM_RSP_JSON_PARSE_FAILED = 60013, ///< HTTP 响应包 JSON 解析错误。
ERR_SVR_COMM_EXCHANGE_ACCOUNT_TIMEUT = 60014, ///< 置换帐号超时。
ERR_SVR_COMM_INVALID_ID_FORMAT = 60015, ///< 请求包体 Identifier 类型错误,请确认 Identifier 为字符串格式。
ERR_SVR_COMM_SDKAPPID_FORBIDDEN = 60016, ///< SDKAppID 被禁用,请 [提交工单](https://console.cloud.tencent.com/workorder/category?level1_id=29&level2_id=40&source=0&data_title=%E4%BA%91%E9%80%9A%E4%BF%A1%20%20IM&step=1) 联系客服确认。
ERR_SVR_COMM_REQ_FORBIDDEN = 60017, ///< 请求被禁用,请 [提交工单](https://console.cloud.tencent.com/workorder/category?level1_id=29&level2_id=40&source=0&data_title=%E4%BA%91%E9%80%9A%E4%BF%A1%20%20IM&step=1) 联系客服确认。
ERR_SVR_COMM_REQ_FREQ_LIMIT = 60018, ///< 请求过于频繁,请稍后重试。
ERR_SVR_COMM_REQ_FREQ_LIMIT_EX = 60019, ///< 请求过于频繁,请稍后重试。
ERR_SVR_COMM_INVALID_SERVICE = 60020, ///< 未购买套餐包或购买的套餐包正在配置中暂未生效,请五分钟后再次尝试。
ERR_SVR_COMM_SENSITIVE_TEXT = 80001, ///< 文本安全打击,文本中可能包含敏感词汇。
ERR_SVR_COMM_BODY_SIZE_LIMIT = 80002, ///< 发消息包体过长,目前支持最大8k消息包体长度,请减少包体大小重试。
// 帐号错误码
ERR_SVR_ACCOUNT_USERSIG_EXPIRED = 70001, ///< UserSig 已过期,请重新生成 UserSig,建议 UserSig 有效期不小于24小时。
ERR_SVR_ACCOUNT_USERSIG_EMPTY = 70002, ///< UserSig 长度为0,请检查传入的 UserSig 是否正确。
ERR_SVR_ACCOUNT_USERSIG_CHECK_FAILED = 70003, ///< UserSig 校验失败,请确认下 UserSig 内容是否被截断,如缓冲区长度不够导致的内容截断。
ERR_SVR_ACCOUNT_USERSIG_CHECK_FAILED_EX = 70005, ///< UserSig 校验失败,可用工具自行验证生成的 UserSig 是否正确。
ERR_SVR_ACCOUNT_USERSIG_MISMATCH_PUBLICKEY = 70009, ///< 用公钥验证 UserSig 失败,请确认生成的 UserSig 使用的私钥和 SDKAppID 是否对应。
ERR_SVR_ACCOUNT_USERSIG_MISMATCH_ID = 70013, ///< 请求的 Identifier 与生成 UserSig 的 Identifier 不匹配。
ERR_SVR_ACCOUNT_USERSIG_MISMATCH_SDKAPPID = 70014, ///< 请求的 SDKAppID 与生成 UserSig 的 SDKAppID 不匹配。
ERR_SVR_ACCOUNT_USERSIG_PUBLICKEY_NOT_FOUND = 70016, ///< 验证 UserSig 时公钥不存在。请先登录控制台下载私钥,下载私钥的具体方法可参考 [下载签名用的私钥](https://cloud.tencent.com/document/product/269/32688#.E4.B8.8B.E8.BD.BD.E7.AD.BE.E5.90.8D.E7.94.A8.E7.9A.84.E7.A7.81.E9.92.A5) 。
ERR_SVR_ACCOUNT_SDKAPPID_NOT_FOUND = 70020, ///< SDKAppID 未找到,请在云通信 IM 控制台确认应用信息。
ERR_SVR_ACCOUNT_INVALID_USERSIG = 70052, ///< UserSig 已经失效,请重新生成,再次尝试。
ERR_SVR_ACCOUNT_NOT_FOUND = 70107, ///< 请求的用户帐号不存在。
ERR_SVR_ACCOUNT_SEC_RSTR = 70114, ///< 安全原因被限制。
ERR_SVR_ACCOUNT_INTERNAL_TIMEOUT = 70169, ///< 服务端内部超时,请重试。
ERR_SVR_ACCOUNT_INVALID_COUNT = 70206, ///< 请求中批量数量不合法。
ERR_SVR_ACCOUNT_INVALID_PARAMETERS = 70402, ///< 参数非法,请检查必填字段是否填充,或者字段的填充是否满足协议要求。
ERR_SVR_ACCOUNT_ADMIN_REQUIRED = 70403, ///< 请求需要 App 管理员权限。
ERR_SVR_ACCOUNT_FREQ_LIMIT = 70050, ///< 因失败且重试次数过多导致被限制,请检查 UserSig 是否正确,一分钟之后再试。
ERR_SVR_ACCOUNT_BLACKLIST = 70051, ///< 帐号被拉入黑名单。
ERR_SVR_ACCOUNT_COUNT_LIMIT = 70398, ///< 创建帐号数量超过免费体验版数量限制,请升级为专业版。
ERR_SVR_ACCOUNT_INTERNAL_ERROR = 70500, ///< 服务端内部错误,请重试。
// 资料错误码
ERR_SVR_PROFILE_INVALID_PARAMETERS = 40001, ///< 请求参数错误,请根据错误描述检查请求是否正确。
ERR_SVR_PROFILE_ACCOUNT_MISS = 40002, ///< 请求参数错误,没有指定需要拉取资料的用户帐号。
ERR_SVR_PROFILE_ACCOUNT_NOT_FOUND = 40003, ///< 请求的用户帐号不存在。
ERR_SVR_PROFILE_ADMIN_REQUIRED = 40004, ///< 请求需要 App 管理员权限。
ERR_SVR_PROFILE_SENSITIVE_TEXT = 40005, ///< 资料字段中包含敏感词。
ERR_SVR_PROFILE_INTERNAL_ERROR = 40006, ///< 服务端内部错误,请稍后重试。
ERR_SVR_PROFILE_READ_PERMISSION_REQUIRED = 40007, ///< 没有资料字段的读权限,详情可参见 [资料字段](https://cloud.tencent.com/document/product/269/1500#.E8.B5.84.E6.96.99.E5.AD.97.E6.AE.B5) 。
ERR_SVR_PROFILE_WRITE_PERMISSION_REQUIRED = 40008, ///< 没有资料字段的写权限,详情可参见 [资料字段](https://cloud.tencent.com/document/product/269/1500#.E8.B5.84.E6.96.99.E5.AD.97.E6.AE.B5) 。
ERR_SVR_PROFILE_TAG_NOT_FOUND = 40009, ///< 资料字段的 Tag 不存在。
ERR_SVR_PROFILE_SIZE_LIMIT = 40601, ///< 资料字段的 Value 长度超过500字节。
ERR_SVR_PROFILE_VALUE_ERROR = 40605, ///< 标配资料字段的 Value 错误,详情可参见 [标配资料字段](https://cloud.tencent.com/doc/product/269/1500#.E6.A0.87.E9.85.8D.E8.B5.84.E6.96.99.E5.AD.97.E6.AE.B5) 。
ERR_SVR_PROFILE_INVALID_VALUE_FORMAT = 40610, ///< 资料字段的 Value 类型不匹配,详情可参见 [标配资料字段](https://cloud.tencent.com/doc/product/269/1500#.E6.A0.87.E9.85.8D.E8.B5.84.E6.96.99.E5.AD.97.E6.AE.B5) 。
// 关系链错误码
ERR_SVR_FRIENDSHIP_INVALID_PARAMETERS = 30001, ///< 请求参数错误,请根据错误描述检查请求是否正确。
ERR_SVR_FRIENDSHIP_INVALID_SDKAPPID = 30002, ///< SDKAppID 不匹配。
ERR_SVR_FRIENDSHIP_ACCOUNT_NOT_FOUND = 30003, ///< 请求的用户帐号不存在。
ERR_SVR_FRIENDSHIP_ADMIN_REQUIRED = 30004, ///< 请求需要 App 管理员权限。
ERR_SVR_FRIENDSHIP_SENSITIVE_TEXT = 30005, ///< 关系链字段中包含敏感词。
ERR_SVR_FRIENDSHIP_INTERNAL_ERROR = 30006, ///< 服务端内部错误,请重试。
ERR_SVR_FRIENDSHIP_NET_TIMEOUT = 30007, ///< 网络超时,请稍后重试。
ERR_SVR_FRIENDSHIP_WRITE_CONFLICT = 30008, ///< 并发写导致写冲突,建议使用批量方式。
ERR_SVR_FRIENDSHIP_ADD_FRIEND_DENY = 30009, ///< 后台禁止该用户发起加好友请求。
ERR_SVR_FRIENDSHIP_COUNT_LIMIT = 30010, ///< 自己的好友数已达系统上限。
ERR_SVR_FRIENDSHIP_GROUP_COUNT_LIMIT = 30011, ///< 分组已达系统上限。
ERR_SVR_FRIENDSHIP_PENDENCY_LIMIT = 30012, ///< 未决数已达系统上限。
ERR_SVR_FRIENDSHIP_BLACKLIST_LIMIT = 30013, ///< 黑名单数已达系统上限。
ERR_SVR_FRIENDSHIP_PEER_FRIEND_LIMIT = 30014, ///< 对方的好友数已达系统上限。
ERR_SVR_FRIENDSHIP_IN_SELF_BLACKLIST = 30515, ///< 请求添加好友时,对方在自己的黑名单中,不允许加好友。
ERR_SVR_FRIENDSHIP_ALLOW_TYPE_DENY_ANY = 30516, ///< 请求添加好友时,对方的加好友验证方式是不允许任何人添加自己为好友。
ERR_SVR_FRIENDSHIP_IN_PEER_BLACKLIST = 30525, ///< 请求添加好友时,自己在对方的黑名单中,不允许加好友。
ERR_SVR_FRIENDSHIP_ALLOW_TYPE_NEED_CONFIRM = 30539, ///< A 请求加 B 为好友,B 的加好友验证方式被设置为“AllowType_Type_NeedConfirm”,这时 A 与 B 之间只能形成未决关系,该返回码用于标识加未决成功,以便与加好友成功的返回码区分开,调用方可以捕捉该错误给用户一个合理的提示。
ERR_SVR_FRIENDSHIP_ADD_FRIEND_SEC_RSTR = 30540, ///< 添加好友请求被安全策略打击,请勿频繁发起添加好友请求。
ERR_SVR_FRIENDSHIP_PENDENCY_NOT_FOUND = 30614, ///< 请求的未决不存在。
ERR_SVR_FRIENDSHIP_DEL_NONFRIEND = 31704, ///< 与请求删除的帐号之间不存在好友关系。
ERR_SVR_FRIENDSHIP_DEL_FRIEND_SEC_RSTR = 31707, ///< 删除好友请求被安全策略打击,请勿频繁发起删除好友请求。
ERR_SVR_FRIENDSHIP_ACCOUNT_NOT_FOUND_EX = 31804, ///< 请求的用户帐号不存在。
// 最近联系人错误码
ERR_SVR_CONV_ACCOUNT_NOT_FOUND = 50001, ///< 请求的用户帐号不存在。
ERR_SVR_CONV_INVALID_PARAMETERS = 50002, ///< 请求参数错误,请根据错误描述检查请求是否正确。
ERR_SVR_CONV_ADMIN_REQUIRED = 50003, ///< 请求需要 App 管理员权限。
ERR_SVR_CONV_INTERNAL_ERROR = 50004, ///< 服务端内部错误,请重试。
ERR_SVR_CONV_NET_TIMEOUT = 50005, ///< 网络超时,请稍后重试。
// 消息错误码
ERR_SVR_MSG_PKG_PARSE_FAILED = 20001, ///< 请求包非法,请检查发送方和接收方帐号是否存在。
ERR_SVR_MSG_INTERNAL_AUTH_FAILED = 20002, ///< 内部鉴权失败。
ERR_SVR_MSG_INVALID_ID = 20003, ///< Identifier 无效或者 Identifier 未导入云通信 IM。
ERR_SVR_MSG_NET_ERROR = 20004, ///< 网络异常,请重试。
ERR_SVR_MSG_INTERNAL_ERROR1 = 20005, ///< 服务端内部错误,请重试。
ERR_SVR_MSG_PUSH_DENY = 20006, ///< 触发发送单聊消息之前回调,App 后台返回禁止下发该消息。
ERR_SVR_MSG_IN_PEER_BLACKLIST = 20007, ///< 发送单聊消息,被对方拉黑,禁止发送。
ERR_SVR_MSG_BOTH_NOT_FRIEND = 20009, ///< 消息发送双方互相不是好友,禁止发送(配置单聊消息校验好友关系才会出现)。
ERR_SVR_MSG_NOT_PEER_FRIEND = 20010, ///< 发送单聊消息,自己不是对方的好友(单向关系),禁止发送。
ERR_SVR_MSG_NOT_SELF_FRIEND = 20011, ///< 发送单聊消息,对方不是自己的好友(单向关系),禁止发送。
ERR_SVR_MSG_SHUTUP_DENY = 20012, ///< 因禁言,禁止发送消息。
ERR_SVR_MSG_REVOKE_TIME_LIMIT = 20016, ///< 消息撤回超过了时间限制(默认2分钟)。
ERR_SVR_MSG_DEL_RAMBLE_INTERNAL_ERROR = 20018, ///< 删除漫游内部错误。
ERR_SVR_MSG_JSON_PARSE_FAILED = 90001, ///< JSON 格式解析失败,请检查请求包是否符合 JSON 规范。
ERR_SVR_MSG_INVALID_JSON_BODY_FORMAT = 90002, ///< JSON 格式请求包中 MsgBody 不符合消息格式描述,或者 MsgBody 不是 Array 类型,请参考 [TIMMsgElement 对象](https://cloud.tencent.com/document/product/269/2720#.E6.B6.88.E6.81.AF.E5.85.83.E7.B4.A0timmsgelement) 的定义。
ERR_SVR_MSG_INVALID_TO_ACCOUNT = 90003, ///< JSON 格式请求包体中缺少 To_Account 字段或者 To_Account 字段不是 Integer 类型
ERR_SVR_MSG_INVALID_RAND = 90005, ///< JSON 格式请求包体中缺少 MsgRandom 字段或者 MsgRandom 字段不是 Integer 类型
ERR_SVR_MSG_INVALID_TIMESTAMP = 90006, ///< JSON 格式请求包体中缺少 MsgTimeStamp 字段或者 MsgTimeStamp 字段不是 Integer 类型
ERR_SVR_MSG_BODY_NOT_ARRAY = 90007, ///< JSON 格式请求包体中 MsgBody 类型不是 Array 类型,请将其修改为 Array 类型
ERR_SVR_MSG_ADMIN_REQUIRED = 90009, ///< 请求需要 App 管理员权限。
ERR_SVR_MSG_INVALID_JSON_FORMAT = 90010, ///< JSON 格式请求包不符合消息格式描述,请参考 [TIMMsgElement 对象](https://cloud.tencent.com/document/product/269/2720#.E6.B6.88.E6.81.AF.E5.85.83.E7.B4.A0timmsgelement) 的定义。
ERR_SVR_MSG_TO_ACCOUNT_COUNT_LIMIT = 90011, ///< 批量发消息目标帐号超过500,请减少 To_Account 中目标帐号数量。
ERR_SVR_MSG_TO_ACCOUNT_NOT_FOUND = 90012, ///< To_Account 没有注册或不存在,请确认 To_Account 是否导入云通信 IM 或者是否拼写错误。
ERR_SVR_MSG_TIME_LIMIT = 90026, ///< 消息离线存储时间错误(最多不能超过7天)。
ERR_SVR_MSG_INVALID_SYNCOTHERMACHINE = 90031, ///< JSON 格式请求包体中 SyncOtherMachine 字段不是 Integer 类型
ERR_SVR_MSG_INVALID_MSGLIFETIME = 90044, ///< JSON 格式请求包体中 MsgLifeTime 字段不是 Integer 类型
ERR_SVR_MSG_ACCOUNT_NOT_FOUND = 90048, ///< 请求的用户帐号不存在。
ERR_SVR_MSG_INTERNAL_ERROR2 = 90994, ///< 服务内部错误,请重试。
ERR_SVR_MSG_INTERNAL_ERROR3 = 90995, ///< 服务内部错误,请重试。
ERR_SVR_MSG_INTERNAL_ERROR4 = 91000, ///< 服务内部错误,请重试。
ERR_SVR_MSG_INTERNAL_ERROR5 = 90992, ///< 服务内部错误,请重试;如果所有请求都返回该错误码,且 App 配置了第三方回调,请检查 App 服务端是否正常向云通信 IM 后台服务端返回回调结果。
ERR_SVR_MSG_BODY_SIZE_LIMIT = 93000, ///< JSON 数据包超长,消息包体请不要超过8k。
ERR_SVR_MSG_LONGPOLLING_COUNT_LIMIT = 91101, ///< Web 端长轮询被踢(Web 端同时在线实例个数超出限制)。
// 120001 - 130000, ///< 单聊第三方回调返回的自定义错误码。
// 群组错误码
ERR_SVR_GROUP_INTERNAL_ERROR = 10002, ///< 服务端内部错误,请重试。
ERR_SVR_GROUP_API_NAME_ERROR = 10003, ///< 请求中的接口名称错误,请核对接口名称并重试。
ERR_SVR_GROUP_INVALID_PARAMETERS = 10004, ///< 参数非法,请根据错误描述检查请求是否正确。
ERR_SVR_GROUP_ACOUNT_COUNT_LIMIT = 10005, ///< 请求包体中携带的帐号数量过多。
ERR_SVR_GROUP_FREQ_LIMIT = 10006, ///< 操作频率限制,请尝试降低调用的频率。
ERR_SVR_GROUP_PERMISSION_DENY = 10007, ///< 操作权限不足,比如 Public 群组中普通成员尝试执行踢人操作,但只有 App 管理员才有权限。
ERR_SVR_GROUP_INVALID_REQ = 10008, ///< 请求非法,可能是请求中携带的签名信息验证不正确,请再次尝试或 [提交工单](https://console.cloud.tencent.com/workorder/category?level1_id=29&level2_id=40&source=0&data_title=%E4%BA%91%E9%80%9A%E4%BF%A1%20%20IM&step=1) 联系技术客服。
ERR_SVR_GROUP_SUPER_NOT_ALLOW_QUIT = 10009, ///< 该群不允许群主主动退出。
ERR_SVR_GROUP_NOT_FOUND = 10010, ///< 群组不存在,或者曾经存在过,但是目前已经被解散。
ERR_SVR_GROUP_JSON_PARSE_FAILED = 10011, ///< 解析 JSON 包体失败,请检查包体的格式是否符合 JSON 格式。
ERR_SVR_GROUP_INVALID_ID = 10012, ///< 发起操作的 Identifier 非法,请检查发起操作的用户 Identifier 是否填写正确。
ERR_SVR_GROUP_ALLREADY_MEMBER = 10013, ///< 被邀请加入的用户已经是群成员。
ERR_SVR_GROUP_FULL_MEMBER_COUNT = 10014, ///< 群已满员,无法将请求中的用户加入群组,如果是批量加人,可以尝试减少加入用户的数量。
ERR_SVR_GROUP_INVALID_GROUPID = 10015, ///< 群组 ID 非法,请检查群组 ID 是否填写正确。
ERR_SVR_GROUP_REJECT_FROM_THIRDPARTY = 10016, ///< App 后台通过第三方回调拒绝本次操作。
ERR_SVR_GROUP_SHUTUP_DENY = 10017, ///< 因被禁言而不能发送消息,请检查发送者是否被设置禁言。
ERR_SVR_GROUP_RSP_SIZE_LIMIT = 10018, ///< 应答包长度超过最大包长(1MB),请求的内容过多,请尝试减少单次请求的数据量。
ERR_SVR_GROUP_ACCOUNT_NOT_FOUND = 10019, ///< 请求的用户帐号不存在。
ERR_SVR_GROUP_GROUPID_IN_USED = 10021, ///< 群组 ID 已被使用,请选择其他的群组 ID。
ERR_SVR_GROUP_SEND_MSG_FREQ_LIMIT = 10023, ///< 发消息的频率超限,请延长两次发消息时间的间隔。
ERR_SVR_GROUP_REQ_ALLREADY_BEEN_PROCESSED = 10024, ///< 此邀请或者申请请求已经被处理。
ERR_SVR_GROUP_GROUPID_IN_USED_FOR_SUPER = 10025, ///< 群组 ID 已被使用,并且操作者为群主,可以直接使用。
ERR_SVR_GROUP_SDKAPPID_DENY = 10026, ///< 该 SDKAppID 请求的命令字已被禁用,请 [提交工单](https://console.cloud.tencent.com/workorder/category?level1_id=29&level2_id=40&source=0&data_title=%E4%BA%91%E9%80%9A%E4%BF%A1%20%20IM&step=1) 联系客服。
ERR_SVR_GROUP_REVOKE_MSG_NOT_FOUND = 10030, ///< 请求撤回的消息不存在。
ERR_SVR_GROUP_REVOKE_MSG_TIME_LIMIT = 10031, ///< 消息撤回超过了时间限制(默认2分钟)。
ERR_SVR_GROUP_REVOKE_MSG_DENY = 10032, ///< 请求撤回的消息不支持撤回操作。
ERR_SVR_GROUP_NOT_ALLOW_REVOKE_MSG = 10033, ///< 群组类型不支持消息撤回操作。
ERR_SVR_GROUP_REMOVE_MSG_DENY = 10034, ///< 该消息类型不支持删除操作。
ERR_SVR_GROUP_NOT_ALLOW_REMOVE_MSG = 10035, ///< 音视频聊天室和在线成员广播大群不支持删除消息。
ERR_SVR_GROUP_AVCHATROOM_COUNT_LIMIT = 10036, ///< 音视频聊天室创建数量超过了限制,请参考 [价格说明](https://cloud.tencent.com/document/product/269/11673) 购买预付费套餐“IM音视频聊天室”。
ERR_SVR_GROUP_COUNT_LIMIT = 10037, ///< 单个用户可创建和加入的群组数量超过了限制,请参考 [价格说明](https://cloud.tencent.com/document/product/269/11673) 购买或升级预付费套餐“单人可创建与加入群组数”。
ERR_SVR_GROUP_MEMBER_COUNT_LIMIT = 10038, ///< 群成员数量超过限制,请参考 [价格说明](https://cloud.tencent.com/document/product/269/11673) 购买或升级预付费套餐“扩展群人数上限”。
/////////////////////////////////////////////////////////////////////////////////
//
// (三)IM SDK V3 版本的错误码
//
/////////////////////////////////////////////////////////////////////////////////
ERR_NO_SUCC_RESULT = 6003, ///< 批量操作无成功结果。
ERR_TO_USER_INVALID = 6011, ///< 无效接收方。
ERR_REQUEST_TIMEOUT = 6012, ///< 请求超时。
ERR_INIT_CORE_FAIL = 6018, ///< INIT CORE 模块失败。
ERR_EXPIRED_SESSION_NODE = 6020, ///< SessionNode 为 null 。
ERR_LOGGED_OUT_BEFORE_LOGIN_FINISHED = 6023, ///< 在登录完成前进行了登出(在登录时返回)。
ERR_TLSSDK_NOT_INITIALIZED = 6024, ///< TLS SDK 未初始化。
ERR_TLSSDK_USER_NOT_FOUND = 6025, ///< TLS SDK 没有找到相应的用户信息。
ERR_BIND_FAIL_UNKNOWN = 6100, ///< QALSDK 未知原因BIND失败。
ERR_BIND_FAIL_NO_SSOTICKET = 6101, ///< 缺少 SSO 票据。
ERR_BIND_FAIL_REPEATD_BIND = 6102, ///< 重复 BIND。
ERR_BIND_FAIL_TINYID_NULL = 6103, ///< TinyId 为空。
ERR_BIND_FAIL_GUID_NULL = 6104, ///< GUID 为空。
ERR_BIND_FAIL_UNPACK_REGPACK_FAILED = 6105, ///< 解注册包失败。
ERR_BIND_FAIL_REG_TIMEOUT = 6106, ///< 注册超时。
ERR_BIND_FAIL_ISBINDING = 6107, ///< 正在 BIND 操作中。
ERR_PACKET_FAIL_UNKNOWN = 6120, ///< 发包未知错误。
ERR_PACKET_FAIL_REQ_NO_NET = 6121, ///< 发送请求包时没有网络。
ERR_PACKET_FAIL_RESP_NO_NET = 6122, ///< 发送回复包时没有网络。
ERR_PACKET_FAIL_REQ_NO_AUTH = 6123, ///< 发送请求包时没有权限。
ERR_PACKET_FAIL_SSO_ERR = 6124, ///< SSO 错误。
ERR_PACKET_FAIL_REQ_TIMEOUT = 6125, ///< 请求超时。
ERR_PACKET_FAIL_RESP_TIMEOUT = 6126, ///< 回复超时。
ERR_PACKET_FAIL_REQ_ON_RESEND = 6127, ///< 重发失败。
ERR_PACKET_FAIL_RESP_NO_RESEND = 6128, ///< 重发时没有真正发送。
ERR_PACKET_FAIL_FLOW_SAVE_FILTERED = 6129, ///< 保存被过滤。
ERR_PACKET_FAIL_REQ_OVER_LOAD = 6130, ///< 发送过载。
ERR_PACKET_FAIL_LOGIC_ERR = 6131, ///< 数据逻辑错误。
ERR_FRIENDSHIP_PROXY_NOT_SYNCED = 6150, ///< proxy_manager 没有完成服务端数据同步。
ERR_FRIENDSHIP_PROXY_SYNCING = 6151, ///< proxy_manager 正在进行服务端数据同步。
ERR_FRIENDSHIP_PROXY_SYNCED_FAIL = 6152, ///< proxy_manager 同步失败。
ERR_FRIENDSHIP_PROXY_LOCAL_CHECK_ERR = 6153, ///< proxy_manager 请求参数,在本地检查不合法。
ERR_GROUP_INVALID_FIELD = 6160, ///< Group assistant 请求字段中包含非预设字段。
ERR_GROUP_STORAGE_DISABLED = 6161, ///< Group assistant 群资料本地存储没有开启。
ERR_LOADGRPINFO_FAILED = 6162, ///< 加载群资料失败。
ERR_REQ_NO_NET_ON_REQ = 6200, ///< 请求的时候没有网络。
ERR_REQ_NO_NET_ON_RSP = 6201, ///< 响应的时候没有网络。
ERR_SERIVCE_NOT_READY = 6205, ///< QALSDK 服务未就绪。
ERR_LOGIN_AUTH_FAILED = 6207, ///< 账号认证失败( TinyId 转换失败)。
ERR_NEVER_CONNECT_AFTER_LAUNCH = 6209, ///< 在应用启动后没有尝试联网。
ERR_REQ_FAILED = 6210, ///< QALSDK 执行失败。
ERR_REQ_INVALID_REQ = 6211, ///< 请求非法,toMsgService 非法。
ERR_REQ_OVERLOADED = 6212, ///< 请求队列满。
ERR_REQ_KICK_OFF = 6213, ///< 已经被其他终端踢了。
ERR_REQ_SERVICE_SUSPEND = 6214, ///< 服务被暂停。
ERR_REQ_INVALID_SIGN = 6215, ///< SSO 签名错误。
ERR_REQ_INVALID_COOKIE = 6216, ///< SSO cookie 无效。
ERR_LOGIN_TLS_RSP_PARSE_FAILED = 6217, ///< 登录时 TLS SDK 回包校验,包体长度错误。
ERR_LOGIN_OPENMSG_TIMEOUT = 6218, ///< 登录时 OPENSTATSVC 向 OPENMSG 上报状态超时。
ERR_LOGIN_OPENMSG_RSP_PARSE_FAILED = 6219, ///< 登录时 OPENSTATSVC 向 OPENMSG 上报状态时解析回包失败。
ERR_LOGIN_TLS_DECRYPT_FAILED = 6220, ///< 登录时 TLS SDK 解密失败。
ERR_WIFI_NEED_AUTH = 6221, ///< WIFI 需要认证。
ERR_USER_CANCELED = 6222, ///< 用户已取消。
ERR_REVOKE_TIME_LIMIT_EXCEED = 6223, ///< 消息撤回超过了时间限制(默认2分钟)。
ERR_LACK_UGC_EXT = 6224, ///< 缺少 UGC 扩展包。
ERR_AUTOLOGIN_NEED_USERSIG = 6226, ///< 自动登录,本地票据过期,需要 UserSig 手动登录。
ERR_QAL_NO_SHORT_CONN_AVAILABLE = 6300, ///< 没有可用的短连接 SSO 。
ERR_REQ_CONTENT_ATTACK = 80101, ///< 消息内容安全打击。
ERR_LOGIN_SIG_EXPIRE = 70101, ///< 登录返回,票据过期。
ERR_SDK_HAD_INITIALIZED = 90101, ///< IM SDK 已经初始化无需重复初始化。
ERR_OPENBDH_BASE = 115000, ///< OpenBDH 错误码基。
ERR_REQUEST_NO_NET_ONREQ = 6250, ///< 请求时没有网络,请等网络恢复后重试。
ERR_REQUEST_NO_NET_ONRSP = 6251, ///< 响应时没有网络,请等网络恢复后重试。
ERR_REQUEST_FAILED = 6252, ///< QALSDK 执行失败。
ERR_REQUEST_INVALID_REQ = 6253, ///< 请求非法,toMsgService 非法。
ERR_REQUEST_OVERLOADED = 6254, ///< 请求队列満。
ERR_REQUEST_KICK_OFF = 6255, ///< 已经被其他终端踢了。
ERR_REQUEST_SERVICE_SUSPEND = 6256, ///< 服务被暂停。
ERR_REQUEST_INVALID_SIGN = 6257, ///< SSO 签名错误。
ERR_REQUEST_INVALID_COOKIE = 6258, ///< SSO cookie 无效。
};
#endif /* TIMErrorCode_h */
//
// TIMFriendshipDefine.h
// imsdk
//
// Created by annidyfeng on 2019/3/7.
// Copyright © 2019年 Tencent. All rights reserved.
//
#ifndef TIMFriendshipDefine_h
#define TIMFriendshipDefine_h
#import "ImSDK.h"
@class TIMFriendPendencyResponse;
@class TIMFriendPendencyItem;
@class TIMFriendFutureMeta;
@class TIMFriendGroup;
#pragma mark - 枚举类型
/**
* 好友操作状态
*
* 详细错误码参见 https://cloud.tencent.com/document/product/269/1671#.E5.85.B3.E7.B3.BB.E9.93.BE.E9.94.99.E8.AF.AF.E7.A0.81
*/
typedef NS_ENUM(NSInteger, TIMFriendStatus) {
/**
* 操作成功
*/
TIM_FRIEND_STATUS_SUCC = 0,
/**
* 请求参数错误,请根据错误描述检查请求是否正确
*/
TIM_FRIEND_PARAM_INVALID = 30001,
/**
* 请求参数错误,SdkAppid 不匹配。
*/
TIM_FRIEND_SDK_APPID_INVALID = 30002,
/**
* 请求的用户帐号不存在
*/
TIM_FRIEND_ID_INVALID = 30003,
/**
* 请求需要 App 管理员权限
*/
TIM_FRIEND_NEED_ADMIN_PERMISSON = 30004,
/**
* 关系链字段中包含敏感词
*/
TIM_FRIEND_DIRTY_WORD = 30005,
/**
* 服务器内部错误,请重试
*/
TIM_FRIEND_SERVER_ERROR = 30006,
/**
* 网络超时,请稍后重试
*/
TIM_FRIEND_TIMEOUT = 30007,
/**
* 并发写导致写冲突,建议使用批量方式
*/
TIM_FRIEND_WRITE_ERROR = 30008,
/**
* 后台禁止该用户发起加好友请求
*/
TIM_ADD_FRIEND_FORBIDEN = 30009,
/**
* 自己的好友数已达系统上限
*/
TIM_ADD_FRIEND_STATUS_SELF_FRIEND_FULL = 30010,
/**
* 分组已达系统上限
*/
TIM_UPDATE_FRIEND_GROUP_STATUS_MAX_GROUPS_EXCEED = 30011,
/**
* 未决数已达系统上限。
*/
TIM_PENDENCY_STATUS_FULL = 30012,
/**
* 黑名单数已达系统上限
*/
TIM_ADD_BLACKLIST_STATUS_FULL = 30013,
/**
* 对方的好友数已达系统上限
*/
TIM_ADD_FRIEND_STATUS_THEIR_FRIEND_FULL = 30014,
/**
* 被加好友在自己的黑名单中
*/
TIM_ADD_FRIEND_STATUS_IN_SELF_BLACK_LIST = 30515,
/**
* 被加好友设置为禁止加好友
*/
TIM_ADD_FRIEND_STATUS_FRIEND_SIDE_FORBID_ADD = 30516,
/**
* 已被被添加好友设置为黑名单
*/
TIM_ADD_FRIEND_STATUS_IN_OTHER_SIDE_BLACK_LIST = 30525,
/**
* 等待好友审核同意
*/
TIM_ADD_FRIEND_STATUS_PENDING = 30539,
/**
* 添加好友请求被安全策略打击,请勿频繁发起添加好友请求
*/
TIM_ADD_FRIEND_STATUS_SENSITIVE = 30540,
/**
* 对方没有申请过好友
*/
TIM_RESPONSE_FRIEND_STATUS_NO_REQ = 30614,
/**
* 删除好友请求被安全策略打击,请勿频繁发起删除好友请求
*/
TIM_DELETE_FRIEND_STATUS_SENSITIVE = 31707,
};
typedef NS_ENUM(NSInteger, TIMDelFriendType) {
/**
* 删除单向好友
*/
TIM_FRIEND_DEL_SINGLE = 1,
/**
* 删除双向好友
*/
TIM_FRIEND_DEL_BOTH = 2,
};
typedef NS_ENUM(NSInteger, TIMPendencyType) {
/**
* 别人发给我的
*/
TIM_PENDENCY_COME_IN = 1,
/**
* 我发给别人的
*/
TIM_PENDENCY_SEND_OUT = 2,
/**
* 别人发给我的 和 我发给别人的。仅拉取时有效
*/
TIM_PENDENCY_BOTH = 3,
};
/**
* 推荐好友类型
*/
typedef NS_ENUM(NSInteger, TIMFutureFriendType) {
/**
* 收到的未决请求
*/
TIM_FUTURE_FRIEND_PENDENCY_IN_TYPE = 0x1,
/**
* 发出去的未决请求
*/
TIM_FUTURE_FRIEND_PENDENCY_OUT_TYPE = 0x2,
/**
* 推荐好友
*/
TIM_FUTURE_FRIEND_RECOMMEND_TYPE = 0x4,
/**
* 已决好友
*/
TIM_FUTURE_FRIEND_DECIDE_TYPE = 0x8,
};
/**
* 翻页选项
*/
typedef NS_ENUM(NSInteger, TIMPageDirectionType) {
/**
* 向上翻页
*/
TIM_PAGE_DIRECTION_UP_TYPE = 1,
/**
* 向下翻页
*/
TIM_PAGE_DIRECTION_DOWN_TYPE = 2,
};
/**
* 好友检查类型
*/
typedef NS_ENUM(NSInteger,TIMFriendCheckType) {
/**
* 单向好友
*/
TIM_FRIEND_CHECK_TYPE_UNIDIRECTION = 0x1,
/**
* 互为好友
*/
TIM_FRIEND_CHECK_TYPE_BIDIRECTION = 0x2,
};
/**
* 好友关系类型
*/
typedef NS_ENUM(NSInteger,TIMFriendRelationType) {
/**
* 不是好友
*/
TIM_FRIEND_RELATION_TYPE_NONE = 0x0,
/**
* 对方在我的好友列表中
*/
TIM_FRIEND_RELATION_TYPE_MY_UNI = 0x1,
/**
* 我在对方的好友列表中
*/
TIM_FRIEND_RELATION_TYPE_OTHER_UNI = 0x2,
/**
* 互为好友
*/
TIM_FRIEND_RELATION_TYPE_BOTHWAY = 0x3,
};
typedef NS_ENUM(NSInteger, TIMFriendResponseType) {
/**
* 同意加好友(建立单向好友)
*/
TIM_FRIEND_RESPONSE_AGREE = 0,
/**
* 同意加好友并加对方为好友(建立双向好友)
*/
TIM_FRIEND_RESPONSE_AGREE_AND_ADD = 1,
/**
* 拒绝对方好友请求
*/
TIM_FRIEND_RESPONSE_REJECT = 2,
};
/**
* 好友检查类型
*/
typedef NS_ENUM(NSInteger,TIMFriendAddType) {
/**
* 单向好友
*/
TIM_FRIEND_ADD_TYPE_SINGLE = 1,
/**
* 互为好友
*/
TIM_FRIEND_ADD_TYPE_BOTH = 2,
};
#pragma mark - block回调
/**
* 获取未决请求列表成功
*
* @param pendencyResponse 未决请求元信息
*/
typedef void (^TIMGetFriendPendencyListSucc)(TIMFriendPendencyResponse *pendencyResponse);
/**
* 群搜索回调
*
* @param totalNum 搜索结果的总数
* @param users 请求的用户列表片段
*/
typedef void (^TIMUserSearchSucc)(uint64_t totalNum, NSArray * users);
/**
* 好友分组列表
*
* @param groups 好友分组(TIMFriendGroup*)列表
*/
typedef void (^TIMFriendGroupArraySucc)(NSArray<TIMFriendGroup *> * groups);
/**
* 好友关系检查回调
*
* @param results TIMCheckFriendResult列表
*/
typedef void (^TIMFriendCheckSucc)(NSArray* results);
#pragma mark - 基本类型
/**
* 加好友请求
*/
@interface TIMFriendRequest : TIMCodingModel
/**
* 用户identifier(必填)
*/
@property (nonatomic,strong) NSString* identifier;
/**
* 备注(备注最大96字节)
*/
@property (nonatomic,strong) NSString* remark;
/**
* 请求说明(最大120字节)
*/
@property (nonatomic,strong) NSString* addWording;
/**
* 添加来源
* 来源需要添加“AddSource_Type_”前缀
*/
@property (nonatomic,strong) NSString* addSource;
/**
* 分组
*/
@property (nonatomic,strong) NSString* group;
/**
* 加好友方式 (可选)
*/
@property (nonatomic,assign) TIMFriendAddType addType;
@end
/**
* 未决请求
*/
@interface TIMFriendPendencyItem : TIMCodingModel
/**
* 用户标识
*/
@property(nonatomic,strong) NSString* identifier;
/**
* 增加时间
*/
@property(nonatomic,assign) uint64_t addTime;
/**
* 来源
*/
@property(nonatomic,strong) NSString* addSource;
/**
* 加好友附言
*/
@property(nonatomic,strong) NSString* addWording;
/**
* 加好友昵称
*/
@property(nonatomic,strong) NSString* nickname;
/**
* 未决请求类型
*/
@property(nonatomic,assign) TIMPendencyType type;
@end
/**
* 未决推送
*/
@interface TIMFriendPendencyInfo : TIMCodingModel
/**
* 用户标识
*/
@property(nonatomic,strong) NSString* identifier;
/**
* 来源
*/
@property(nonatomic,strong) NSString* addSource;
/**
* 加好友附言
*/
@property(nonatomic,strong) NSString* addWording;
/**
* 加好友昵称
*/
@property(nonatomic,strong) NSString* nickname;
@end
/**
* 未决请求信息
*/
@interface TIMFriendPendencyRequest : TIMCodingModel
/**
* 序列号,未决列表序列号
* 建议客户端保存seq和未决列表,请求时填入server返回的seq
* 如果seq是server最新的,则不返回数据
*/
@property(nonatomic,assign) uint64_t seq;
/**
* 翻页时间戳,只用来翻页,server返回0时表示没有更多数据,第一次请求填0
* 特别注意的是,如果server返回的seq跟填入的seq不同,翻页过程中,需要使用客户端原始seq请求,直到数据请求完毕,才能更新本地seq
*/
@property(nonatomic,assign) uint64_t timestamp;
/**
* 每页的数量,即本次请求最多返回多个数据,最大不超过 100,设置太大一次请求回包的时间会过长。默认值100
* 注意:后台最多只保存100条未决
*/
@property(nonatomic,assign) uint64_t numPerPage;
/**
* 未决请求拉取类型
*/
@property(nonatomic,assign) TIMPendencyType type;
@end
/**
* 未决返回信息
*/
@interface TIMFriendPendencyResponse : TIMCodingModel
/**
* 本次请求的未决列表序列号
*/
@property(nonatomic,assign) uint64_t seq;
/**
* 本次请求的翻页时间戳
*/
@property(nonatomic,assign) uint64_t timestamp;
/**
* 未决请求未读数量
*/
@property(nonatomic,assign) uint64_t unreadCnt;
/**
* 未决数据
*/
@property NSArray<TIMFriendPendencyItem *> * pendencies;
@end
/**
* 好友分组信息
*/
@interface TIMFriendGroup : TIMCodingModel
/**
* 好友分组名称
*/
@property(nonatomic,strong) NSString* name;
/**
* 分组成员数量
*/
@property(nonatomic,assign) uint64_t userCnt;
/**
* 分组成员identifier列表
*/
@property(nonatomic,strong) NSArray* friends;
@end
/**
* 好友关系检查
*/
@interface TIMFriendCheckInfo : NSObject
/**
* 检查用户的id列表(NSString*)
*/
@property(nonatomic,strong) NSArray* users;
/**
* 检查类型
*/
@property(nonatomic,assign) TIMFriendCheckType checkType;
@end
@interface TIMCheckFriendResult : NSObject
/**
* 用户id
*/
@property NSString* identifier;
/**
* 返回码
*/
@property NSInteger result_code;
/**
* 返回信息
*/
@property NSString *result_info;
/**
* 检查结果
*/
@property(nonatomic,assign) TIMFriendRelationType resultType;
@end
@interface TIMFriendResult : NSObject
/**
* 用户Id
*/
@property NSString* identifier;
/**
* 返回码
*/
@property NSInteger result_code;
/**
* 返回信息
*/
@property NSString *result_info;
@end
/**
* 响应好友请求
*/
@interface TIMFriendResponse : NSObject
/**
* 响应类型
*/
@property(nonatomic,assign) TIMFriendResponseType responseType;
/**
* 用户identifier
*/
@property(nonatomic,strong) NSString* identifier;
/**
* 备注好友(可选,如果要加对方为好友)。备注最大96字节
*/
@property(nonatomic,strong) NSString* remark;
@end
/**
* 好友分组信息扩展
*/
@interface TIMFriendGroupWithProfiles : TIMFriendGroup
/**
* 好友资料(TIMUserProfile*)列表
*/
@property(nonatomic,strong) NSArray* profiles;
@end
// 用户资料KEY
/**
* 昵称
* 值类型: NSString
*/
extern NSString *const TIMProfileTypeKey_Nick;
/**
* 头像
* 值类型: NSString
*/
extern NSString *const TIMProfileTypeKey_FaceUrl;
/**
* 好友申请
* 值类型: NSNumber [TIM_FRIEND_ALLOW_ANY,TIM_FRIEND_NEED_CONFIRM,TIM_FRIEND_DENY_ANY]
*/
extern NSString *const TIMProfileTypeKey_AllowType;
/**
* 性别
* 值类型: NSNumber [TIM_GENDER_UNKNOWN,TIM_GENDER_MALE,TIM_GENDER_FEMALE]
*/
extern NSString *const TIMProfileTypeKey_Gender;
/**
* 生日
* 值类型: NSNumber
*/
extern NSString *const TIMProfileTypeKey_Birthday;
/**
* 位置
* 值类型: NSString
*/
extern NSString *const TIMProfileTypeKey_Location;
/**
* 语言
* 值类型: NSNumber
*/
extern NSString *const TIMProfileTypeKey_Language;
/**
* 等级
* 值类型: NSNumber
*/
extern NSString *const TIMProfileTypeKey_Level;
/**
* 角色
* 值类型: NSNumber
*/
extern NSString *const TIMProfileTypeKey_Role;
/**
* 签名
* 值类型: NSString
*/
extern NSString *const TIMProfileTypeKey_SelfSignature;
/**
* 自定义字段前缀
* 值类型: [NSString,NSData|NSNumber]
* @note 当设置自定义字的值NSString对象时,后台会将其转为UTF8保存在数据库中。由于部分用户迁移资料时可能不是UTF8类型,所以在获取资料时,统一返回NSData类型。
*/
extern NSString *const TIMProfileTypeKey_Custom_Prefix;
// 好友资料KEY
/**
* 备注
* 值类型: NSString
*/
extern NSString *const TIMFriendTypeKey_Remark;
/**
* 分组
* 值类型: [NSArray]
*/
extern NSString *const TIMFriendTypeKey_Group;
/**
* 自定义字段前缀
* 值类型: [NSString,NSData|NSNumber]
*/
extern NSString *const TIMFriendTypeKey_Custom_Prefix;
#endif /* TIMFriendshipDefine_h */
//
// TIMFriendshipManager.h
// imsdk
//
// Created by annidyfeng on 2019/3/7.
// Copyright © 2019年 Tencent. All rights reserved.
//
#ifndef TIMFriendshipManager_h
#define TIMFriendshipManager_h
#import "TIMComm.h"
#import "TIMFriendshipDefine.h"
@interface TIMFriendshipManager : NSObject
/**
* 获取好友管理器实例
*
* @return 管理器实例
*/
+ (TIMFriendshipManager*)sharedInstance;
/**
* 设置自己的资料
*
* @param values 需要更新的属性,可一次更新多个字段. 参见 TIMFriendshipDefine.h 的 TIMProfileTypeKey_XXX
* @param succ 成功回调
* @param fail 失败回调
*
* @return 0 发送请求成功
*/
- (int)modifySelfProfile:(NSDictionary<NSString *, id> *)values succ:(TIMSucc)succ fail:(TIMFail)fail;
/**
* 获取自己的资料
*
* @param succ 成功回调,返回 TIMUserProfile
* @param fail 失败回调
*
* @return 0 发送请求成功
*/
- (int)getSelfProfile:(TIMGetProfileSucc)succ fail:(TIMFail)fail;
/**
* 在缓存中查询自己的资料
*
* @return 返回缓存的资料,未找到返回nil
*/
- (TIMUserProfile *)querySelfProfile;
/**
* 获取指定用户资料
*
* @param identifiers 用户id,非好友的用户也可以
* @prarm forceUpdate 强制从后台拉取
* @param succ 成功回调
* @param fail 失败回调
*
* @return 0 发送请求成功
*/
- (int)getUsersProfile:(NSArray<NSString *> *)identifiers forceUpdate:(BOOL)forceUpdate succ:(TIMUserProfileArraySucc)succ fail:(TIMFail)fail;
/**
* 在缓存中查询用户的资料
*
* @praram identifier 用户id,非好友的用户也可以
*
* @return 返回缓存的资料,未找到返回nil
*/
- (TIMUserProfile *)queryUserProfile:(NSString *)identifier;
/**
* 获取好友列表
*
* @param succ 成功回调,返回好友(TIMFriend)列表
* @param fail 失败回调
*
* @return 0 发送请求成功
*/
-(int)getFriendList:(TIMFriendArraySucc)succ fail:(TIMFail)fail;
/**
* 在缓存中查询用户的关系链数据
*
* @praram identifier 用户id
*
* @return 返回缓存的关系链数据,未找到返回nil
* @note 缓存数据来自于上一次调用getFriendList,请确保已调用了获取好友列表方法
*/
- (TIMFriend *)queryFriend:(NSString *)identifier;
/**
* 获取缓存中的关系链列表
*
* @return 返回缓存的关系链数据
* @note 缓存数据来自于上一次调用getFriendList,请确保已调用了获取好友列表方法
*/
- (NSArray<TIMFriend *> *)queryFriendList;
/**
* 检查指定用户的好友关系
*
* @param checkInfo 好友检查信息
* @param succ 成功回调,返回检查结果
* @param fail 失败回调
*
* @return 0:发送成功;-1:checkInfo->users 参数异常;-2:checkInfo->checkType 参数异常
*/
- (int)checkFriends:(TIMFriendCheckInfo *)checkInfo succ:(TIMCheckFriendResultArraySucc)succ fail:(TIMFail)fail;
/**
* 添加好友
*
* @param request 添加好友请求
* @param succ 成功回调(TIMFriendResult)
* @param fail 失败回调
*
* @return 0 发送请求成功
*/
- (int)addFriend:(TIMFriendRequest *)request succ:(TIMFriendResultSucc)succ fail:(TIMFail)fail;
/**
* 响应对方好友邀请
*
* @param response 响应请求
* @param succ 成功回调
* @param fail 失败回调
*
* @return 0 发送请求成功
*/
- (int)doResponse:(TIMFriendResponse *)response succ:(TIMFriendResultSucc)succ fail:(TIMFail)fail;
/**
* 删除好友
*
* @param identifiers 好友id
* @param delType 删除类型(单向好友、双向好友)
* @param succ 成功回调([TIMFriendResult])
* @param fail 失败回调
*
* @return 0 发送请求成功
*/
- (int)deleteFriends:(NSArray *)identifiers delType:(TIMDelFriendType)delType succ:(TIMFriendResultArraySucc)succ fail:(TIMFail)fail;
/**
* 修改好友
*
* @param identifier 好友id
* @param values 需要更新的属性,可一次更新多个字段. 参见 TIMFriendshipDefine.h 的 TIMFriendTypeKey_XXX
* @param succ 成功回调
* @param fail 失败回调
*
* @return 0 发送请求成功
*/
- (int)modifyFriend:(NSString *)identifier values:(NSDictionary<NSString *, id> *)values succ:(TIMSucc)succ fail:(TIMFail)fail;
/**
* 获取未决列表
*
* @param pendencyRequest 请求信息,详细参考TIMFriendPendencyRequest
* @param succ 成功回调
* @param fail 失败回调
*
* @return 0 发送请求成功
*/
- (int)getPendencyList:(TIMFriendPendencyRequest *)pendencyRequest succ:(TIMGetFriendPendencyListSucc)succ fail:(TIMFail)fail;
/**
* 未决删除
*
* @param type 未决好友类型
* @param identifiers 要删除的未决列表
* @param succ 成功回调
* @param fail 失败回调
*
* @return 0 发送请求成功
*/
- (int)deletePendency:(TIMPendencyType)type users:(NSArray *)identifiers succ:(TIMSucc)succ fail:(TIMFail)fail;
/**
* 未决已读上报
*
* @param timestamp 已读时间戳,此时间戳以前的消息都将置为已读
* @param succ 成功回调
* @param fail 失败回调
*
* @return 0 发送请求成功
*/
- (int)pendencyReport:(uint64_t)timestamp succ:(TIMSucc)succ fail:(TIMFail)fail;
/**
* 获取黑名单列表
*
* @param succ 成功回调,返回NSString*列表
* @param fail 失败回调
*
* @return 0 发送请求成功
*/
- (int)getBlackList:(TIMFriendArraySucc)succ fail:(TIMFail)fail;
/**
* 添加用户到黑名单
*
* @param identifiers 用户列表
* @param succ 成功回调
* @param fail 失败回调
*
* @return 0 发送请求成功
*/
- (int)addBlackList:(NSArray *)identifiers succ:(TIMFriendResultArraySucc)succ fail:(TIMFail)fail;
/**
* 把用户从黑名单中删除
*
* @param identifiers 用户列表
* @param succ 成功回调
* @param fail 失败回调
*
* @return 0 发送请求成功
*/
- (int)deleteBlackList:(NSArray *)identifiers succ:(TIMFriendResultArraySucc)succ fail:(TIMFail)fail;
/**
* 新建好友分组
*
* @param groupNames 分组名称列表,必须是当前不存在的分组
* @param identifiers 要添加到分组中的好友
* @param succ 成功回调
* @param fail 失败回调
*
* @return 0 发送请求成功
*/
- (int)createFriendGroup:(NSArray *)groupNames users:(NSArray *)identifiers succ:(TIMFriendResultArraySucc)succ fail:(TIMFail)fail;
/**
* 获取指定的好友分组信息
*
* @param groupNames 要获取信息的好友分组名称列表,传入nil获得所有分组信息
* @param succ 成功回调,返回 TIMFriendGroup* 列表
* @param fail 失败回调
*
* @return 0 发送请求成功
*/
- (int)getFriendGroups:(NSArray *)groupNames succ:(TIMFriendGroupArraySucc)succ fail:(TIMFail)fail;
/**
* 删除好友分组
*
* @param groupNames 要删除的好友分组名称列表
* @param succ 成功回调
* @param fail 失败回调
*
* @return 0 发送请求成功
*/
- (int)deleteFriendGroup:(NSArray *)groupNames succ:(TIMSucc)succ fail:(TIMFail)fail;
/**
* 修改好友分组的名称
*
* @param oldName 原来的分组名称
* @param newName 新的分组名称
* @param succ 成功回调
* @param fail 失败回调
*
* @return 0 发送请求成功
*/
- (int)renameFriendGroup:(NSString*)oldName newName:(NSString*)newName succ:(TIMSucc)succ fail:(TIMFail)fail;
/**
* 添加好友到一个好友分组
*
* @param groupName 好友分组名称
* @param identifiers 要添加到分组中的好友
* @param succ 成功回调
* @param fail 失败回调
*
* @return 0 发送请求成功
*/
- (int)addFriendsToFriendGroup:(NSString *)groupName users:(NSArray *)identifiers succ:(TIMFriendResultArraySucc)succ fail:(TIMFail)fail;
/**
* 从好友分组中删除好友
*
* @param groupName 好友分组名称
* @param identifiers 要移出分组的好友
* @param succ 成功回调
* @param fail 失败回调
*
* @return 0 发送请求成功
*/
- (int)deleteFriendsFromFriendGroup:(NSString *)groupName users:(NSArray *)identifiers succ:(TIMFriendResultArraySucc)succ fail:(TIMFail)fail;
@end
#endif /* TIMFriendshipManager_h */
//
// TIMGroupManager.h
// ImSDK
//
// Created by bodeng on 17/3/15.
// Copyright (c) 2015 tencent. All rights reserved.
//
#ifndef ImSDK_TIMGroupManager_h
#define ImSDK_TIMGroupManager_h
#import "TIMComm.h"
@interface TIMGroupManager : NSObject
#pragma mark 一,获取群组实例
/////////////////////////////////////////////////////////////////////////////////
//
// (一)获取群组实例
//
/////////////////////////////////////////////////////////////////////////////////
/// @name 获取群组实例
/// @{
/**
* 1.1 获取群管理器实例
*
* @return 管理器实例
*/
+ (TIMGroupManager*)sharedInstance;
///@}
#pragma mark 二,创建/删除/加入/退出群组
/////////////////////////////////////////////////////////////////////////////////
//
// (二)创建/删除/加入/退出群组
//
/////////////////////////////////////////////////////////////////////////////////
/// @name 创建/删除/加入/退出群组
/// @{
/**
* 1.1 创建私有群
*
* 快速创建私有群,创建者默认加入群组,无需显式指定,群组类型形态请参考官网文档 [群组形态介绍](https://cloud.tencent.com/document/product/269/1502#.E7.BE.A4.E7.BB.84.E5.BD.A2.E6.80.81.E4.BB.8B.E7.BB.8D)
*
* @param members 群成员,NSString* 数组
* @param groupName 群名
* @param succ 成功回调 groupId
* @param fail 失败回调
*
* @return 0:成功;1:失败
*/
- (int)createPrivateGroup:(NSArray<NSString *>*)members groupName:(NSString*)groupName succ:(TIMCreateGroupSucc)succ fail:(TIMFail)fail;
/**
* 1.2 创建公开群
*
* 快速创建公开群,创建者默认加入群组,无需显式指定,群组类型形态请参考官网文档 [群组形态介绍](https://cloud.tencent.com/document/product/269/1502#.E7.BE.A4.E7.BB.84.E5.BD.A2.E6.80.81.E4.BB.8B.E7.BB.8D)
*
* @param members 群成员,NSString* 数组
* @param groupName 群名
* @param succ 成功回调 groupId
* @param fail 失败回调
*
* @return 0:成功;1:失败
*/
- (int)createPublicGroup:(NSArray<NSString *>*)members groupName:(NSString*)groupName succ:(TIMCreateGroupSucc)succ fail:(TIMFail)fail;
/**
* 1.3 创建聊天室
*
* 快速创建聊天室,创建者默认加入群组,无需显式指定,群组类型形态请参考官网文档 [群组形态介绍](https://cloud.tencent.com/document/product/269/1502#.E7.BE.A4.E7.BB.84.E5.BD.A2.E6.80.81.E4.BB.8B.E7.BB.8D)
*
* @param members 群成员,NSString* 数组
* @param groupName 群名
* @param succ 成功回调 groupId
* @param fail 失败回调
*
* @return 0:成功;1:失败
*/
- (int)createChatRoomGroup:(NSArray<NSString *>*)members groupName:(NSString*)groupName succ:(TIMCreateGroupSucc)succ fail:(TIMFail)fail;
/**
* 1.4 创建音视频聊天室
*
* 快速创建音视频聊天室,创建者默认加入群组,无需显式指定,群组类型形态请参考官网文档 [群组形态介绍](https://cloud.tencent.com/document/product/269/1502#.E7.BE.A4.E7.BB.84.E5.BD.A2.E6.80.81.E4.BB.8B.E7.BB.8D)
*
* @param groupName 群名
* @param succ 成功回调 groupId
* @param fail 失败回调
*
* @return 0:成功;1:失败
*/
- (int)createAVChatRoomGroup:(NSString*)groupName succ:(TIMCreateGroupSucc)succ fail:(TIMFail)fail;
/**
* 1.5 创建指定类型和 ID 的群组
*
* 1. 默认创建群组时,IM 通讯云服务器会生成一个唯一的 ID,该 ID 将以 @TGS# 开头,且保证在 App 中唯一,以便后续操作。
* 2. 如果用户需要自定义群组 ID,在创建时可指定 ID,自定义群组 ID 必须为可打印 ASCII 字符(0x20-0x7e),最长 48 个字节,且前缀不能为 @TGS#(避免与默认分配的群组 ID 混淆)
*
* @param type 群类型,Private,Public,ChatRoom,AVChatRoom
* @param groupId 自定义群组 ID,为空时系统自动分配
* @param groupName 群组名称
* @param succ 成功回调
* @param fail 失败回调
*
* @return 0:成功;1:失败
*/
- (int)createGroup:(NSString*)type groupId:(NSString*)groupId groupName:(NSString*)groupName succ:(TIMCreateGroupSucc)succ fail:(TIMFail)fail;
/**
* 1.6 创建自定义群组
*
* 在创建群组时,除了设置默认的成员以及群名外,还可以设置如群公告、群简介等字段。
*
* @param groupInfo 群组信息,详情请参考 TIMComm+Group.h 里面的 TIMCreateGroupInfo 定义
* @param succ 成功回调 groupId
* @param fail 失败回调
*
* @return 0:成功;1:失败
*/
- (int)createGroup:(TIMCreateGroupInfo*)groupInfo succ:(TIMCreateGroupSucc)succ fail:(TIMFail)fail;
/**
* 1.7 解散群组
*
* 1. 私有群:任何人都无法解散群组
* 2. 公开群、聊天室、直播大群:群主可以解散群组。
*
* @param groupId 群组Id
* @param succ 成功回调
* @param fail 失败回调
*
* @return 0:成功;1:失败
*/
- (int)deleteGroup:(NSString*)groupId succ:(TIMSucc)succ fail:(TIMFail)fail;
/**
* 1.8 申请加群
*
* 1. 私有群:不能由用户主动申请入群。
* 2. 公开群、聊天室:可以主动申请进入。
* 3. 直播大群:可以任意加入群组。
* 4. 如果群组设置为需要审核,申请入群后管理员和群主会收到申请入群系统消息 TIMGroupSystemElem,判断 TIMGroupSystemElem 的 Type 类型如果是 TIM_GROUP_SYSTEM_ADD_GROUP_REQUEST_TYPE ,这时候调用 getPendencyFromServer 获取群未决列表,调用 TIMGroupPendencyItem 对象调用 accept 接口同意入群,申请人会收到同意入群的消息 TIMGroupSystemElem(Type:TIM_GROUP_SYSTEM_ADD_GROUP_ACCEPT_TYPE),调用 refuse 接口拒绝入群,申请人会收到拒绝入群的消息 TIMGroupSystemElem(Type:TIM_GROUP_SYSTEM_ADD_GROUP_REFUSE_TYPE)。
* 5. 如果群主设置为任何人可加入,则直接入群成功。
*
* @param groupId 申请加入的群组Id
* @param msg 申请消息
* @param succ 成功回调(申请成功等待审批)
* @param fail 失败回调
*
* @return 0:成功;1:失败
*/
- (int)joinGroup:(NSString*)groupId msg:(NSString*)msg succ:(TIMSucc)succ fail:(TIMFail)fail;
/**
* 1.9 主动退出群组
*
* 1. 私有群:全员可退出群组。
* 2. 公开群、聊天室、直播大群:群主不能退出。
* 3. 当用户主动退出群组时,该用户会收到退群消息 TIMGroupSystemElem(Type:TIM_GROUP_SYSTEM_QUIT_GROUP_TYPE),只有退群的用户自己可以收到。当用户调用 QuitGroup 时成功回调返回,表示已退出成功,此消息主要为了多终端同步,其他终端可以作为更新群列表的时机,本终端可以选择忽略。
*
* @param groupId 群组Id
* @param succ 成功回调
* @param fail 失败回调
*
* @return 0:成功;1:失败
*/
- (int)quitGroup:(NSString*)groupId succ:(TIMSucc)succ fail:(TIMFail)fail;
///@}
#pragma mark 三,邀请/删除群成员
/////////////////////////////////////////////////////////////////////////////////
//
// (三)邀请/删除群成员
//
/////////////////////////////////////////////////////////////////////////////////
/// @name 邀请/删除群成员
/// @{
/**
* 3.1 邀请好友入群
*
* 1. 只有私有群可以邀请用户入群
* 2. 公开群,聊天室不能邀请用户入群,但在创建群时可以直接拉人入群
* 3. 音视频聊天室不能拉用户入群,也不能在创建群时拉人入群,只能用户主动进群
*
* @param groupId 群组Id
* @param members 要加入的成员列表(NSString* 类型数组)
* @param succ 成功回调 (TIMGroupMemberResult 列表)
* @param fail 失败回调
*
* @return 0:成功;1:失败
*/
- (int)inviteGroupMember:(NSString*)groupId members:(NSArray<NSString *>*)members succ:(TIMGroupMemberSucc)succ fail:(TIMFail)fail;
/**
* 3.2 删除群成员
*
* 1. 私有群:只有创建者可删除群组成员。
* 2. 公开群、聊天室:只有管理员和群主可以踢人。
* 3. 对于直播大群:不能踢人。
*
* @param groupId 群组Id
* @param reason 删除原因
* @param members 要删除的成员列表
* @param succ 成功回调 (TIMGroupMemberResult 列表)
* @param fail 失败回调
*
* @return 0:成功;1:失败
*/
- (int)deleteGroupMemberWithReason:(NSString*)groupId reason:(NSString*)reason members:(NSArray<NSString *>*)members succ:(TIMGroupMemberSucc)succ fail:(TIMFail)fail;
///@}
#pragma mark 四,获取群信息
/////////////////////////////////////////////////////////////////////////////////
//
// (四)获取群信息
//
/////////////////////////////////////////////////////////////////////////////////
/// @name 获取群信息
/// @{
/**
* 4.1 获取群列表
*
* 获取自己所加入的群列表。
*
* @param succ 成功回调,NSArray 列表为 TIMGroupInfo,结构体只包含 group|groupName|groupType|faceUrl|allShutup|selfInfo 信息
* @param fail 失败回调
*
* @return 0:成功;1:失败
*/
- (int)getGroupList:(TIMGroupListSucc)succ fail:(TIMFail)fail;
/**
* 4.2 获取服务器存储的群组信息
*
* 1. 无论是公开群还是私有群,群成员均可以拉到群组信息。
* 2. 如果是公开群,非群组成员可以拉到 group|groupName|owner|groupType|createTime|maxMemberNum|memberNum|introduction|faceURL|addOpt|onlineMemberNum|customInfo 这些字段信息。如果是私有群,非群组成员拉取不到群组信息。
*
* @param succ 成功回调,NSArray 列表为 TIMGroupInfoResult,不包含 selfInfo 信息
* @param fail 失败回调
*
* @return 0:成功;1:失败
*/
- (int)getGroupInfo:(NSArray*)groups succ:(TIMGroupListSucc)succ fail:(TIMFail)fail;
/**
* 4.3 获取本地存储的群组信息
*
* 1. 无论是公开群还是私有群,群成员均可以拉到群组信息。
* 2. 如果是公开群,非群组成员可以拉到 group|groupName|owner|groupType|createTime|maxMemberNum|memberNum|introduction|faceURL|addOpt|onlineMemberNum|customInfo 这些字段信息。如果是私有群,非群组成员拉取不到群组信息。
*
* @param groupId 群组Id
*
* @return 群组信息
*/
- (TIMGroupInfo *)queryGroupInfo:(NSString *)groupId;
/**
* 4.4 获取群成员列表
*
* @param groupId 群组Id
* @param succ 成功回调 (TIMGroupMemberInfo 列表)
* @param fail 失败回调
*
* @return 0:成功;1:失败
*/
- (int)getGroupMembers:(NSString*)groupId succ:(TIMGroupMemberSucc)succ fail:(TIMFail)fail;
/**
* 4.5 获取本人在群组内的成员信息
*
* @param groupId 群组Id
* @param succ 成功回调,返回信息
* @param fail 失败回调
*
* @return 0:成功;1:失败
*/
- (int)getGroupSelfInfo:(NSString*)groupId succ:(TIMGroupSelfSucc)succ fail:(TIMFail)fail;
/**
* 4.6 获取群组指定成员的信息
*
* 获取群组指定成员的信息,需要设置群成员 members,其他限制参考 getGroupMembers
*
* @param groupId 群组Id
* @param members 成员Id(NSString*)列表
* @param succ 成功回调 (TIMGroupMemberInfo 列表)
* @param fail 失败回调
*
* @return 0:成功;1:失败
*/
- (int)getGroupMembersInfo:(NSString*)groupId members:(NSArray<NSString *>*)members succ:(TIMGroupMemberSucc)succ fail:(TIMFail)fail;
/**
* 4.7 获取指定类型的成员列表(支持按字段拉取,分页)
*
* @param groupId 群组Id
* @param filter 群成员角色过滤方式
* @param flags 拉取资料标志
* @param custom 要获取的自定义key(NSString*)列表
* @param nextSeq 分页拉取标志,第一次拉取填0,回调成功如果 nextSeq 不为零,需要分页,传入再次拉取,直至为0
* @param succ 成功回调
* @param fail 失败回调
* @return 0:成功;1:失败
*/
- (int)getGroupMembers:(NSString*)groupId ByFilter:(TIMGroupMemberFilter)filter flags:(TIMGetGroupMemInfoFlag)flags custom:(NSArray<NSString *>*)custom nextSeq:(uint64_t)nextSeq succ:(TIMGroupMemberSuccV2)succ fail:(TIMFail)fail;
/**
* 4.8 获取接受消息选项
*
* @param groupId 群组Id
* @param succ 成功回调, TIMGroupReceiveMessageOpt 0:接收消息;1:不接收消息,服务器不进行转发;2:接受消息,不进行 iOS APNs 推送
* @param fail 失败回调
*
* @return 0:成功;1:失败
*/
- (int)getReciveMessageOpt:(NSString*)groupId succ:(TIMGroupReciveMessageOptSucc)succ fail:(TIMFail)fail;
///@}
#pragma mark 五,修改群信息
/////////////////////////////////////////////////////////////////////////////////
//
// (五)修改群信息
//
/////////////////////////////////////////////////////////////////////////////////
/// @name 修改群信息
/// @{
/**
* 5.1 修改群名
*
* 1. 公开群、聊天室和直播大群:只有群主或者管理员可以修改群名。
* 2. 私有群:任何人可修改群名。
*
* @param groupId 群组Id
* @param groupName 新群名
* @param succ 成功回调
* @param fail 失败回调
*
* @return 0:成功;1:失败
*/
- (int)modifyGroupName:(NSString*)groupId groupName:(NSString*)groupName succ:(TIMSucc)succ fail:(TIMFail)fail;
/**
* 5.2 修改群简介
*
* 1. 公开群、聊天室、直播大群:只有群主或者管理员可以修改群简介。
* 2. 私有群:任何人可修改群简介。
*
* @param groupId 群组Id
* @param introduction 群简介(最长120字节)
* @param succ 成功回调
* @param fail 失败回调
*
* @return 0:成功;1:失败
*/
- (int)modifyGroupIntroduction:(NSString*)groupId introduction:(NSString*)introduction succ:(TIMSucc)succ fail:(TIMFail)fail;
/**
* 5.3 修改群公告
*
* 1. 公开群、聊天室、直播大群:只有群主或者管理员可以修改群公告。
* 2. 私有群:任何人可修改群公告。
*
* @param groupId 群组Id
* @param notification 群公告(最长150字节)
* @param succ 成功回调
* @param fail 失败回调
*
* @return 0:成功;1:失败
*/
- (int)modifyGroupNotification:(NSString*)groupId notification:(NSString*)notification succ:(TIMSucc)succ fail:(TIMFail)fail;
/**
* 5.4 修改群头像
*
* 1. 公开群、聊天室、直播大群:只有群主或者管理员可以修改群头像。
* 2. 私有群:任何人可修改群头像。
*
* @param groupId 群组Id
* @param url 群头像地址(最长100字节)
* @param succ 成功回调
* @param fail 失败回调
*
* @return 0:成功;1:失败
*/
- (int)modifyGroupFaceUrl:(NSString*)groupId url:(NSString*)url succ:(TIMSucc)succ fail:(TIMFail)fail;
/**
* 5.5 修改加群选项
*
* 1. 公开群、聊天室、直播大群:只有群主或者管理员可以修改加群选项。
* 2. 私有群:只能通过邀请加入群组,不能主动申请加入某个群组。
*
* @param groupId 群组Id
* @param opt 加群选项,详见 TIMGroupAddOpt
* @param succ 成功回调
* @param fail 失败回调
*
* @return 0:成功;1:失败
*/
- (int)modifyGroupAddOpt:(NSString*)groupId opt:(TIMGroupAddOpt)opt succ:(TIMSucc)succ fail:(TIMFail)fail;
/**
* 5.6 修改群组是否可被搜索属性
*
* @param groupId 群组Id
* @param searchable 是否能被搜索
* @param succ 成功回调
* @param fail 失败回调
*
* @return 0:成功;1:失败
*/
- (int)modifyGroupSearchable:(NSString*)groupId searchable:(BOOL)searchable succ:(TIMSucc)succ fail:(TIMFail)fail;
/**
* 5.8 修改群组全员禁言属性
*
* 1. 群主、管理员:有权限进行全员禁言的操作。
* 2. 所有群组类型:都支持全员禁言的操作。
*
* @param groupId 群组Id
* @param shutup 是否禁言
* @param succ 成功回调
* @param fail 失败回调
*
* @return 0:成功;1:失败
*/
- (int)modifyGroupAllShutup:(NSString*)groupId shutup:(BOOL)shutup succ:(TIMSucc)succ fail:(TIMFail)fail;
/**
* 5.9 修改群自定义字段集合
*
* 通过 [IM 控制台](https://console.cloud.tencent.com/avc) -> 功能配置 -> 群维度自定义字段 配置相关的 key 和权限。
*
*
* @param groupId 群组Id
* @param customInfo 自定义字段集合,key 是 NSString* 类型,value 是 NSData* 类型,value 长度不超过 512 字节
* @param succ 成功回调
* @param fail 失败回调
*
* @return 0:成功;1:失败
*/
- (int)modifyGroupCustomInfo:(NSString*)groupId customInfo:(NSDictionary<NSString *,NSData *>*)customInfo succ:(TIMSucc)succ fail:(TIMFail)fail;
/**
* 5.10 转让群给新群主
*
* 1. 只有群主才有权限进行群转让操作。
* 2. 直播大群不能进行群转让操作。
*
* @param groupId 群组Id
* @param identifier 新的群主Id
* @param succ 成功回调
* @param fail 失败回调
*
* @return 0:成功;1:失败
*/
- (int)modifyGroupOwner:(NSString*)groupId user:(NSString*)identifier succ:(TIMSucc)succ fail:(TIMFail)fail;
///@}
#pragma mark 六,修改群成员信息
/////////////////////////////////////////////////////////////////////////////////
//
// (六)修改群成员信息
//
/////////////////////////////////////////////////////////////////////////////////
/// @name 修改群成员信息
/// @{
/**
* 6.1 修改群成员名片
*
* 只有本人、管理员或群主能够调用
*
* @param groupId 群组Id
* @param identifier 被操作用户identifier
* @param nameCard 群名片
* @param succ 成功回调
* @param fail 失败回调
*
* @return 0:成功;1:失败
*/
- (int)modifyGroupMemberInfoSetNameCard:(NSString*)groupId user:(NSString*)identifier nameCard:(NSString*)nameCard succ:(TIMSucc)succ fail:(TIMFail)fail;
/**
* 6.2 修改群成员角色
*
* 1. 群主、管理员:可以进行对群成员的身份进行修改。
* 2. 直播大群:不支持修改用户群内身份。
*
* @param groupId 群组Id
* @param identifier 被修改角色的用户identifier
* @param role 角色(注意:不能修改为群主),详见 TIMGroupMemberRole
* @param succ 成功回调
* @param fail 失败回调
*
* @return 0:成功;1:失败
*/
- (int)modifyGroupMemberInfoSetRole:(NSString*)groupId user:(NSString*)identifier role:(TIMGroupMemberRole)role succ:(TIMSucc)succ fail:(TIMFail)fail;
/**
* 6.3 修改群组成员是否可见属性
*
* @param groupId 群组Id
* @param visible 是否可见
* @param succ 成功回调
* @param fail 失败回调
*
* @return 0:成功;1:失败
*/
- (int)modifyGroupMemberVisible:(NSString*)groupId visible:(BOOL)visible succ:(TIMSucc)succ fail:(TIMFail)fail;
/**
* 6.4 禁言用户
*
* 只有管理员或群主能够调用
*
* @param groupId 群组Id
* @param identifier 被禁言的用户identifier
* @param stime 禁言时间
* @param succ 成功回调
* @param fail 失败回调
*
* @return 0:成功;1:失败
*/
- (int)modifyGroupMemberInfoSetSilence:(NSString*)groupId user:(NSString*)identifier stime:(uint32_t)stime succ:(TIMSucc)succ fail:(TIMFail)fail;
/**
* 5.7 修改个人接受消息选项
*
* 默认情况下,公开群和私有群是接收并离线推送群消息,聊天室和直播大群是接收但不离线推送群消息。
*
* @param groupId 群组Id
* @param opt 接受消息选项,详见 TIMGroupReceiveMessageOpt
* @param succ 成功回调
* @param fail 失败回调
*
* @return 0:成功;1:失败
*/
- (int)modifyReceiveMessageOpt:(NSString*)groupId opt:(TIMGroupReceiveMessageOpt)opt succ:(TIMSucc)succ fail:(TIMFail)fail;
/**
* 6.5 修改群成员自定义字段集合
*
* 通过 [IM 控制台](https://console.cloud.tencent.com/avc) -> 功能配置 -> 群成员维度自定义字段 配置相关的 key 和权限。
*
* @param groupId 群组 Id
* @param identifier 被操作用户 identifier
* @param customInfo 自定义字段集合,key 是 NSString* 类型,value 是 NSData* 类型,value 长度不超过 64 字节
* @param succ 成功回调
* @param fail 失败回调
*
* @return 0:成功;1:失败
*/
- (int)modifyGroupMemberInfoSetCustomInfo:(NSString*)groupId user:(NSString*)identifier customInfo:(NSDictionary<NSString*,NSData*> *)customInfo succ:(TIMSucc)succ fail:(TIMFail)fail;
///@}
#pragma mark 七,群未决逻辑
/////////////////////////////////////////////////////////////////////////////////
//
// (七)群未处理请求逻辑
//
/////////////////////////////////////////////////////////////////////////////////
/// @name 群未处理请求逻辑
/// @{
/**
* 7.1 获取群组未处理请求列表
*
* 1. 群未处理请求泛指所有需要审批的群相关的操作(例如:加群待审批,拉人入群待审批等等)。即便审核通过或者拒绝后,该条信息也可通过此接口拉回,拉回的信息中有已处理标志
* 2. 审批人:有权限拉取相关信息,如果 UserA 申请加入群 GroupA,则群管理员可获取此未处理相关信息,UserA 因为没有审批权限,不需要拉取未处理信息。如果 AdminA 拉 UserA 进去 GroupA,则 UserA 可以拉取此未处理相关信息,因为该未处理信息待 UserA 审批。
*
* @param option 拉取群未处理请求参数配置,详情请参考 TIMComm.h -> TIMGroupPendencyOption
* @param succ 成功回调,返回未决列表
* @param fail 失败回调
*
* @return 0:成功;1:失败
*/
- (int)getPendencyFromServer:(TIMGroupPendencyOption*)option succ:(TIMGetGroupPendencyListSucc)succ fail:(TIMFail)fail;
/**
* 7.2 群未处理列表已读上报
*
* 对于未处理信息,SDK 可对其和之前的所有未处理请求上报已读。上报已读后,仍然可以拉取到这些未决信息,但可通过对已读时戳的判断判定未决信息是否已读。
*
* @param timestamp 上报已读时间戳
* @param succ 成功回调
* @param fail 失败回调
*
* @return 0:成功;1:失败
*/
- (int)pendencyReport:(uint64_t)timestamp succ:(TIMSucc)succ fail:(TIMFail)fail;
///@}
@end
#endif
/////////////////////////////////////////////////////////////////////
//
// 腾讯云通信服务 IMSDK
//
// 模块名称:TIMManager + MsgExt
//
// 模块功能:此处主要存放待废弃的 API 函数,建议您使用 TIMManager.h 内部声明的接口函数
//
/////////////////////////////////////////////////////////////////////
#ifndef TIMManager_MsgExt_h
#define TIMManager_MsgExt_h
#import "TIMManager.h"
/**
* IMSDK 扩展类,此处主要存放待废弃的 API 函数,建议您使用 TIMManager.h 内部声明的接口函数
*/
@interface TIMManager (MsgExt)
/**
* 获取群管理器
*
* 此函数待废弃,请直接使用 TIMGroupManager 的 sharedInstance 函数
*
* @return 群管理器,详情请参考 TIMGroupManager.h 中的 TIMGroupManager 定义
*/
- (TIMGroupManager*)groupManager;
/**
* 获取好友管理器
*
* 此函数待废弃,请直接使用 TIMFriendshipManager 的 sharedInstance 函数
*
* @return 好友管理器,详情请参考 TIMFriendshipManager.h 中的 TIMFriendshipManager 定义
*/
- (TIMFriendshipManager*)friendshipManager;
/**
* 获取会话数量
*
* @return 会话数量
*/
- (int)conversationCount;
/**
* 发送消息给多个用户
*
* @param msg 发送的消息
* @param users 目标用户的id列表
* @param succ 成功回调
* @param fail 失败回调
*
* @return 0 发送成功
*/
- (int)sendMessage:(TIMMessage*)msg toUsers:(NSArray*)users succ:(TIMSucc)succ fail:(TIMSendToUsersFail)fail;
/**
* 自定义版本号
*
* @param version 版本号
* @note setCustomVersion() 要在 initSdk() 之前调用。
*/
- (void)setCustomVersion:(NSString *)version;
/**
* 删除未读消息的时候减少会话的未读数
*
* 不建议客户使用,删除消息和减少未读数是本地操作,没有和服务器做同步,在程序卸载或则多端同步中会出现未读数不一致的问题。
*
* @note reduceUnreadNumberWhenRemoveMessage 要在 initSdk() 之前调用。
*/
- (void)reduceUnreadNumberWhenRemoveMessage;
@end
#endif /* TIMManager_MsgExt_h */
/////////////////////////////////////////////////////////////////////
//
// 腾讯云通信服务 IMSDK
//
// 模块名称:TIMManager
//
// 模块功能:IMSDK 主核心模块,负责 IMSDK 的初始化、登录、创建会话、管理推送等功能。
//
// (1) 初始化:初始化是使用 TIMSDK 的前提,任何其它 API 的调用都应该在 initSdk 接口之后被调用。
//
// (2) 登录:需要设置 SDKAppID,userID 和 userSig 才能使用腾讯云服务。
//
// (3) 会话:一个会话对应一个聊天窗口,比如跟一个好友的 C2C 聊天,或者一个聊天群,都是一个会话。
//
// (4) 推送:管理和设置 APNS 的相关功能,包括 token 和开关等。
//
/////////////////////////////////////////////////////////////////////
#ifndef ImSDK_TIMManager_h
#define ImSDK_TIMManager_h
#import "TIMComm.h"
#import "TIMCallback.h"
@class TIMGroupManager;
@class TIMFriendshipManager;
/**
* IMSDK 主核心类,负责 IMSDK 的初始化、登录、创建会话、管理推送等功能。
*/
@interface TIMManager : NSObject
#pragma mark 一,初始化相关接口函数
/////////////////////////////////////////////////////////////////////////////////
//
// (一)初始化相关接口函数
//
/////////////////////////////////////////////////////////////////////////////////
/// @name 初始化相关接口
/// @{
/**
* 1.1 获取管理器实例 TIMManager
*
* @return 管理器实例
*/
+ (TIMManager*)sharedInstance;
/**
* 1.2 初始化 SDK,设置全局配置信息
*
* 初始化 SDK 需要设置 TIMSdkConfig 信息,TIMSdkConfig 主要包含 sdkAppId 设置、Log 相关逻辑设置、数据库存储路径设置、网络监听设置等,
* 其中 sdkAppId 的获取请参考官网文档 [跑通Demo(iOS与Mac)](https://cloud.tencent.com/document/product/269/32674)。
*
* @param globalConfig 配置信息,全局有效,详情请参考 TIMComm.h 中的 TIMSdkConfig 定义。
* @return 0:成功;1:失败,config 为 nil
*/
- (int)initSdk:(TIMSdkConfig*)globalConfig;
/**
* 1.3 反初始化
*/
- (void)unInit;
/**
* 1.4 获取全局配置信息
*
* @return 全局配置,详情请参考 TIMComm.h 中的 TIMSdkConfig 定义
*/
- (TIMSdkConfig*)getGlobalConfig;
/**
* 1.5 设置用户配置信息
*
* 主要用来开启/关闭自动已读上报和已读回执,设置默认拉取的群组资料,群成员资料字段,监听用户登录状态、会话刷新、消息已读回执、文件上传进度、群组事件通知。
*
* 1. disableAutoReport 是否开启多终端同步未读提醒,这个选项主要影响多终端登录时的未读消息提醒逻辑。
* YES:只有当一个终端调用 setReadMessage() 将消息标记为已读,另一个终端再登录时才不会收到未读提醒;
* NO:消息一旦被一个终端接收,另一个终端都不会再次提醒。同理,卸载 APP 再安装也无法再次收到这些未读消息。
* 2. enableReadReceipt 是否开启被阅回执,接收端设置,发送端才会生效。
* YES:接收者查看消息(setReadMessage)后,消息的发送者会收到 TIMMessageReceiptListener 的回调提醒;
* NO: 不开启被阅回执,默认不开启。
* 3. groupInfoOpt 设置拉取群资料中的自定义字段。
* 4. groupMemberInfoOpt 设置拉群成员资料中的自定义字段。
*
* @note setUserConfig() 要在 initSdk() 之后 和 login() 之前调用。
*
* @param config 配置信息,对当前 TIMManager 有效,详情请参考 TIMComm.h 中的 TIMUserConfig 定义
* @return 0:成功;1:失败,config 为 nil
*/
- (int)setUserConfig:(TIMUserConfig*)config;
/**
* 1.6 获取用户配置信息
*
* @return 当前 manager 绑定用户的配置,详情请参考 TIMComm.h 中的 TIMUserConfig 定义
*/
- (TIMUserConfig*)getUserConfig;
/**
* 1.7 新消息接收监听
*
* 添加消息监听后,会在 TIMMessageListener 的 onNewMessage 收到回调消息,消息内容通过参数 TIMMessage 传递。
* 消息的解析可参阅 [消息解析](https://cloud.tencent.com/document/product/269/9150#.E6.B6.88.E6.81.AF.E8.A7.A3.E6.9E.90) 。
*
* @param listener 回调,详情请参考 TIMCallback.h 中的 TIMMessageListener 定义
* @return 0:成功;1:失败,listener 为 nil
*/
- (int)addMessageListener:(id<TIMMessageListener>)listener;
/**
* 1.8 移除消息监听
*
* @param listener 回调,详情请参考 TIMCallback.h 中的 TIMMessageListener 定义
* @return 0:成功;1:失败,listener 为 nil
*/
- (int)removeMessageListener:(id<TIMMessageListener>)listener;
/// @}
#pragma mark 二,登录相关接口
/////////////////////////////////////////////////////////////////////////////////
//
// (二)登录相关接口
//
/////////////////////////////////////////////////////////////////////////////////
/// @name 登录相关接口
/// @{
/**
* 2.1 登录
*
* 1. 登录需要设置用户名 userID 和用户签名 userSig,userSig 生成请参 [UserSig 后台 API](https://cloud.tencent.com/document/product/269/32688)。
* 2. 如果 userSig 过期,登录会返回 ERR_USER_SIG_EXPIRED:6206 错误码,收到错误码后请生成新的 userSig 重新登录。
* 3. 用户在线情况下被踢,会在 TIMUserConfig 里面配置的 TIMUserStatusListener 监听器获取 onForceOffline 回调,收到回调后可以选择重新登录。
* 4. 用户离线状态下被踢,会在用户重新登录时收到 (ERR_IMSDK_KICKED_BY_OTHERS:6208) 错误码,此时需要再次调用 login() 强制上线。
* 5. 如果当前是登录中,则本次登录无效,本次回调不会有任何返回,登录结果会通过第一次登录的回调返回,可以通过 getLoginStatus() 获取登录状态。
*
* 更多详情请参考 [用户状态变更](https://cloud.tencent.com/document/product/269/9148#5.-.E7.94.A8.E6.88.B7.E7.8A.B6.E6.80.81.E5.8F.98.E6.9B.B4)。
*
* @param param 登录参数,详情请参考 TIMComm.h 中的 TIMLoginParam 定义
* @param succ 成功回调,详情请参考 TIMComm.h 中的 TIMLoginSucc 定义
* @param fail 失败回调,详情请参考 TIMComm.h 中的 TIMFail 定义
*
* @return 0:成功;1:失败,请检查 param 参数是否正常
*/
- (int)login: (TIMLoginParam*)param succ:(TIMLoginSucc)succ fail:(TIMFail)fail;
/**
* 2.2 自动登录
*
* 自动登录类似“记住密码”的功能,如果上一次已经成功登录,那么一段时间内都只需要传入用户名就可以完成登录。
* 相比于普通的 login(TIMLoginParam) 接口,该接口可以减少 IM SDK 向您的服务器索要 UserSig 的频率,
* 既可以加快登录速度,又能减少你的 UserSig 服务器压力,也在一定程度上降低了 UserSig 泄漏的风险。
*
* 1. 首次登录之后,SDK 会把登录信息存在在本地,下次登录即可调用自动登录
* 2. 如果用户之前没有登录过,或则 APP 被卸载过,自动登录会报 ERR_NO_PREVIOUS_LOGIN:6026 错误,这个时候请调用 login 接口重新登录。
*
* @param userID 自动登录用户名
* @param succ 成功回调,详情请参考 TIMComm.h 中的 TIMLoginSucc 定义
* @param fail 失败回调,详情请参考 TIMComm.h 中的 TIMFail 定义
*
* @return 0:成功;1:失败,请检查 param 参数是否正常
*/
- (int)autoLogin:(NSString*)userID succ:(TIMLoginSucc)succ fail:(TIMFail)fail;
/**
* 2.3 登出
*
* 退出登录,如果切换账号,需要 logout 回调成功或者失败后才能再次 login,否则 login 可能会失败。
*
* @param succ 成功回调,登出成功
* @param fail 失败回调,返回错误码和错误信息
*
* @return 0:发送登出包成功,等待回调;1:失败
*/
- (int)logout:(TIMLoginSucc)succ fail:(TIMFail)fail;
/**
* 2.4 获取当前登录的用户
*
* @return 如果登录返回用户的 userID,如果未登录返回 nil
*/
- (NSString*)getLoginUser;
/**
* 2.5 获取当前登录状态
*
* @return 登录状态,详情请参考 TIMComm.h 中的 TIMLoginStatus 定义
*/
- (TIMLoginStatus)getLoginStatus;
/// @}
#pragma mark 三,会话管理器
/////////////////////////////////////////////////////////////////////////////////
//
// (三)会话管理器
//
/////////////////////////////////////////////////////////////////////////////////
/// @name 会话管理器
/// @{
/**
* 3.1 获取会话列表
*
* 一个会话对应一个聊天窗口,比如跟一个好友的 1v1 聊天,或者一个聊天群,都是一个会话。
*
* @return 会话列表
*/
- (NSArray<TIMConversation *>*)getConversationList;
/**
* 3.2 获取单个会话
*
* TIMConversation 负责会话相关操作,包含发送消息、获取会话消息缓存、获取未读计数等。
*
* @param type 详情请参考 TIMComm.h 里面的 TIMConversationType 定义
* @param conversationId 会话 ID
单聊类型(C2C) :为对方 userID;
群组类型(GROUP) :为群组 groupId;
系统类型(SYSTEM):为 @""
*
* @return 会话对象,详情请参考 TIMConversation.h 里面的 TIMConversation 定义
*/
- (TIMConversation*)getConversation:(TIMConversationType)type receiver:(NSString*)conversationId;
/**
* 3.3 删除单个会话
*
* @param type 会话类型,详情请参考 TIMComm.h 里面的 TIMConversationType 定义
* @param conversationId 会话 Id
* 单聊类型(C2C) :为对方 userID;
* 群组类型(GROUP) :为群组 groupId;
* 系统类型(SYSTEM):为 @""
*
* @return YES:删除成功;NO:删除失败
*/
- (BOOL)deleteConversation:(TIMConversationType)type receiver:(NSString*)conversationId;
/**
* 3.4 删除单个会话和对应的会话消息
*
* 本接口与 deleteConversation() 的差异在于,deleteConversation() 只是删除单个会话,而本接口会额外把本地缓存的消息记录也一并删除掉。
*
* @note 本接口只能删除本地缓存的历史消息,无法删除云端保存的历史消息。
* @param type 会话类型,详情请参考 TIMComm.h 里面的 TIMConversationType 定义
* @param conversationId 会话 Id
* 单聊类型(C2C) :为对方 userID;
* 群组类型(GROUP) :为群组 groupId;
* 系统类型(SYSTEM):为 @""
*
* @return YES:删除成功;NO:删除失败
*/
- (BOOL)deleteConversationAndMessages:(TIMConversationType)type receiver:(NSString*)conversationId;
/// @}
#pragma mark 四,设置 APNs 推送
/////////////////////////////////////////////////////////////////////////////////
//
// (四)设置 APNs 推送
//
/////////////////////////////////////////////////////////////////////////////////
/// @name 设置 APNs 推送
/// @{
/**
* 4.1. 设置客户端 Token 和证书 busiId
*
* token 是苹果后台对客户端的唯一标识,需要主动调用系统 API 向苹果请求获取,请求成功后,
* 可以在 didRegisterForRemoteNotificationsWithDeviceToken 回调收到对应的 token 信息。
* 具体实现见下面代码示例:
*
* <pre>
*
* //获取 token 代码示例
* if ([[[UIDevice currentDevice] systemVersion] floatValue] >= 8.0) {
* [[UIApplication sharedApplication] registerUserNotificationSettings:
* [UIUserNotificationSettings settingsForTypes:
* (UIUserNotificationTypeSound | UIUserNotificationTypeAlert | UIUserNotificationTypeBadge) categories:nil]];
* [[UIApplication sharedApplication] registerForRemoteNotifications];
* }
* else{
* [[UIApplication sharedApplication] registerForRemoteNotificationTypes:
* (UIUserNotificationTypeBadge | UIUserNotificationTypeSound | UIUserNotificationTypeAlert)];
* }
*
* //收到 token 代码示例
* -(void)application:(UIApplication *)app didRegisterForRemoteNotificationsWithDeviceToken:(NSData *)deviceToken {
* //回调的 deviceToken 就是需要的 token 信息
* }
*
* </pre>
*
* busiId 是推送证书 ID,是向 IM 控制台上传 iOS 证书(p.12)生成的,
* 具体步骤请参考 [离线推送](https://cloud.tencent.com/document/product/269/9154)。
*
* @param token 详情请参考 TIMComm.h 中的 TIMTokenParam 定义
* @param succ 成功回调,详情请参考 TIMComm.h 中的 TIMSucc 定义
* @param fail 失败回调,详情请参考 TIMComm.h 中的 TIMFail 定义
*
* @return 0:成功;1:失败,token 参数异常
*/
- (int)setToken:(TIMTokenParam*)token succ:(TIMSucc)succ fail:(TIMFail)fail;
/**
* 4.2. 设置 APNS
*
* 设置 APNS,可设置单聊、群组推送声音,也可以设置是否开启推送。
*
* @param config APNS 配置,详情请参考 TIMComm.h 中的 TIMAPNSConfig 定义
* @param succ 成功回调,详情请参考 TIMComm.h 中的 TIMSucc 定义
* @param fail 失败回调,详情请参考 TIMComm.h 中的 TIMFail 定义
*
* @return 0:成功;1:失败,config 参数异常
*/
- (int)setAPNS:(TIMAPNSConfig*)config succ:(TIMSucc)succ fail:(TIMFail)fail;
/**
* 4.3. 获取 APNS 配置
*
* @param succ 成功回调,返回配置信息,详情请参考 TIMComm.h 中的 TIMAPNSConfigSucc 定义
* @param fail 失败回调,详情请参考 TIMComm.h 中的 TIMFail 定义
*
* @return 0:成功;1:失败
*/
- (int)getAPNSConfig:(TIMAPNSConfigSucc)succ fail:(TIMFail)fail;
/**
* 4.4. APP 进后台
*
* APP 进后台的时候需要主动调用 doBackground ,这个时候后台知道 APP 的状态,之后的消息会下发推送通知。
*
* <pre>
*
* - (void)applicationDidEnterBackground:(UIApplication *)application {
* TIMBackgroundParam *param = [[TIMBackgroundParam alloc] init];
* [param setC2cUnread:unReadCount];
* [[TIMManager sharedInstance] doBackground:param succ:^() {
* // to do
* } fail:^(int code, NSString * err) {
* // to do
* }];
* }
*
* </pre>
*
* @param param 上报参数,详情请参考 TIMComm.h 中的 TIMBackgroundParam 定义
* @param succ 成功时回调,详情请参考 TIMComm.h 中的 TIMSucc 定义
* @param fail 失败时回调,详情请参考 TIMComm.h 中的 TIMFail 定义
*
* @return 0:成功;1:失败
*/
- (int)doBackground:(TIMBackgroundParam*)param succ:(TIMSucc)succ fail:(TIMFail)fail;
/**
* 4.5. APP 进前台
*
* APP 进前台的时候需要主动调用 doForeground,这个时候后台知道 APP 的状态,之后的消息不会下发推送通知。
*
* <pre>
*
* - (void)applicationDidBecomeActive:(UIApplication *)application {
* [[TIMManager sharedInstance] doForeground:^() {
* //to do
* } fail:^(int code, NSString * err) {
* //to do
* }];
* }
*
* </pre>
*
* @param succ 成功时回调,详情请参考 TIMComm.h 中的 TIMSucc 定义
* @param fail 失败时回调,详情请参考 TIMComm.h 中的 TIMFail 定义
*
* @return 0:成功;1:失败
*/
- (int)doForeground:(TIMSucc)succ fail:(TIMFail)fail;
/// @}
#pragma mark 五,未登录查看本地会话和消息
/////////////////////////////////////////////////////////////////////////////////
//
// (五)未登录查看本地会话和消息
//
/////////////////////////////////////////////////////////////////////////////////
/// @name 未登录查看本地会话和消息
/// @{
/**
* 5.1 在未登录的情况下加载本地存储
*
* 该接口相当于 login() 函数的无网络版本,适用于在用户没有网络(未登录)的情况下查看用户的本地会话和消息。
*
* @note 如过已经 login() 成功,请不要调用此函数,否则会导致各种异常问题。
*
* @param userID 用户名
* @param succ 成功回调,收到回调时,可以获取会话列表和消息
* @param fail 失败回调
* @return 0:加载成功;1:请求失败
*/
- (int)initStorage:(NSString*)userID succ:(TIMLoginSucc)succ fail:(TIMFail)fail;
///@}
#pragma mark 六,调试相关接口
/////////////////////////////////////////////////////////////////////////////////
//
// (六)调试相关接口
//
/////////////////////////////////////////////////////////////////////////////////
/// @name 调试相关接口
/// @{
/**
* 6.1 获取版本号
*
* @return 返回版本号,字符串表示,例如 v1.1.1
*/
- (NSString*)GetVersion;
/**
* 6.2 打印日志
*
* 通过 ImSDK 提供的日志功能打印日志
*
* @param level 日志级别,详情请参考 TIMComm.h 中的 TIMLogLevel 定义
* @param tag 模块 tag
* @param msg 要输出的日志内容
*/
- (void)log:(TIMLogLevel)level tag:(NSString*)tag msg:(NSString*)msg;
/**
* 6.3 获取日志文件路径
*/
- (NSString*)getLogPath;
/**
* 6.4 获取日志打印开启状态
*
* 您可以在 initSdk -> TIMSdkConfig -> disableLogPrint 设置日志是否打印
*
* @return YES:允许 log 打印;NO:不允许 log 打印
*/
- (BOOL)getIsLogPrintEnabled;
/**
* 6.5 获取日志级别
*
* @return 返回日志级别,详情请参考 TIMComm.h 中的 TIMLogLevel 定义
*/
-(TIMLogLevel) getLogLevel;
///@}
@end
#endif