// // TIMComm+FriendshipExt.h // IMFriendshipExt // // Created by tomzhu on 2017/1/19. // // #ifndef TIMComm_FriendshipExt_h #define TIMComm_FriendshipExt_h #import @class TIMFriendMetaInfo; @class TIMFriendPendencyMeta; @class TIMFriendFutureMeta; #pragma mark - 枚举类型 /** * 好友操作状态 */ typedef NS_ENUM(NSInteger, TIMFriendStatus) { /** * 操作成功 */ TIM_FRIEND_STATUS_SUCC = 0, /** * 加好友时有效：被加好友在自己的黑名单中 */ TIM_ADD_FRIEND_STATUS_IN_SELF_BLACK_LIST = 30515, /** * 加好友时有效：被加好友设置为禁止加好友 */ TIM_ADD_FRIEND_STATUS_FRIEND_SIDE_FORBID_ADD = 30516, /** * 加好友时有效：好友数量已满 */ TIM_ADD_FRIEND_STATUS_SELF_FRIEND_FULL = 30519, /** * 加好友时有效：已经是好友 */ TIM_ADD_FRIEND_STATUS_ALREADY_FRIEND = 30520, /** * 加好友时有效：已被被添加好友设置为黑名单 */ TIM_ADD_FRIEND_STATUS_IN_OTHER_SIDE_BLACK_LIST = 30525, /** * 加好友时有效：对方好友列表已满 */ TIM_ADD_FRIEND_STATUS_OTHER_SIDE_FRIEND_LIST_FULL = 30535, /** * 加好友时有效：等待好友审核同意 */ TIM_ADD_FRIEND_STATUS_PENDING = 30539, /** * 删除好友时有效：删除好友时对方不是好友 */ TIM_DEL_FRIEND_STATUS_NO_FRIEND = 31704, /** * 响应好友申请时有效：对方没有申请过好友 */ TIM_RESPONSE_FRIEND_STATUS_NO_REQ = 30614, /** * 响应好友申请时有效：自己的好友满 */ TIM_RESPONSE_FRIEND_STATUS_SELF_FRIEND_FULL = 30615, /** * 响应好友申请时有效：好友已经存在 */ TIM_RESPONSE_FRIEND_STATUS_FRIEND_EXIST = 30617, /** * 响应好友申请时有效：对方好友满 */ TIM_RESPONSE_FRIEND_STATUS_OTHER_SIDE_FRIEND_FULL = 30630, /** * 添加黑名单有效：已经在黑名单了 */ TIM_ADD_BLACKLIST_FRIEND_STATUS_IN_BLACK_LIST = 31307, /** * 删除黑名单有效：用户不在黑名单里 */ TIM_DEL_BLACKLIST_FRIEND_STATUS_NOT_IN_BLACK_LIST = 31503, /** * 创建好友分组时有效：没有拉到SDKAppId */ TIM_ADD_FRIEND_GROUP_STATUS_GET_SDKAPPID_FAILED = 32207, /** * 创建好友分组时有效：要加入到好友分组中的用户不是好友 */ TIM_ADD_FRIEND_GROUP_STATUS_NOT_FRIEND = 32216, /** * 更新好友分组时有效：没有拉到SDKAppId */ TIM_UPDATE_FRIEND_GROUP_STATUS_GET_SDKAPPID_FAILED = 32511, /** * 更新好友分组时有效：要加入到好友分组中的用户不是好友 */ TIM_UPDATE_FRIEND_GROUP_STATUS_ADD_NOT_FRIEND = 32518, /** * 更新好友分组时有效：要加入到好友分组中的好友已经在分组中 */ TIM_UPDATE_FRIEND_GROUP_STATUS_ADD_ALREADY_IN_GROUP = 32519, /** * 更新好友分组时有效：要从好友分组中删除的好友不在好友分组中 */ TIM_UPDATE_FRIEND_GROUP_STATUS_DEL_NOT_IN_GROUP = 32520, /** * 更新好友分组时有效：该好友加入的好友分组个数超过了限制，每个好友最多只能加入32个好友分组 */ TIM_UPDATE_FRIEND_GROUP_STATUS_MAX_GROUPS_EXCEED = 32521, }; typedef NS_ENUM(NSInteger, TIMDelFriendType) { /** * 删除单向好友 */ TIM_FRIEND_DEL_SINGLE = 1, /** * 删除双向好友 */ TIM_FRIEND_DEL_BOTH = 2, }; typedef NS_ENUM(NSInteger, TIMPendencyGetType) { /** * 别人发给我的 */ TIM_PENDENCY_GET_COME_IN = 1, /** * 我发给别人的 */ TIM_PENDENCY_GET_SEND_OUT = 2, /** * 别人发给我的 和 我发给别人的 */ TIM_PENDENCY_GET_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_BOTH = 0x3, }; typedef NS_ENUM(NSInteger, TIMFriendResponseType) { /** * 同意加好友（建立单向好友） */ TIM_FRIEND_RESPONSE_AGREE = 0, /** * 同意加好友并加对方为好友（建立双向好友） */ TIM_FRIEND_RESPONSE_AGREE_AND_ADD = 1, /** * 拒绝对方好友请求 */ TIM_FRIEND_RESPONSE_REJECT = 2, }; #pragma mark - block回调 /** * 获取好友列表回调 * * @param meta 好友元信息 * @param friends 好友列表 TIMUserProfile* 数组，只包含需要的字段 */ typedef void (^TIMGetFriendListByPageSucc)(TIMFriendMetaInfo * meta, NSArray * friends); /** * 获取未决请求列表成功 * * @param meta 未决请求元信息 * @param pendencies 未决请求列表（TIMFriendPendencyItem*）数组 */ typedef void (^TIMGetFriendPendencyListSucc)(TIMFriendPendencyMeta * meta, NSArray * pendencies); /** * 获取推荐好友和未决列表成功 * * @param meta 下次拉取时填入信息 * @param items 列表（TIMFriendFutureItem*）数组 */ typedef void (^TIMGetFriendFutureListSucc)(TIMFriendFutureMeta * meta, NSArray * items); /** * 群搜索回调 * * @param totalNum 搜索结果的总数 * @param users 请求的用户列表片段 */ typedef void (^TIMUserSearchSucc)(uint64_t totalNum, NSArray * users); /** * 好友分组列表 * * @param arr 好友分组（TIMFriendGroup*)列表 */ typedef void (^TIMFriendGroupSucc)(NSArray * arr); /** * 好友关系检查回调 * * @param results TIMCheckFriendResult列表 */ typedef void (^TIMFriendCheckSucc)(NSArray* results); #pragma mark - 基本类型 /** * 加好友请求 */ @interface TIMAddFriendRequest : TIMCodingModel /** * 用户identifier */ @property(nonatomic,strong) NSString* identifier; /** * 用户备注（备注最大96字节） */ @property(nonatomic,strong) NSString* remark; /** * 请求说明（最大120字节） */ @property(nonatomic,strong) NSString* addWording; /** * 添加来源 */ @property(nonatomic,strong) NSString* addSource; /** * 预分组名 */ @property(nonatomic,strong) NSString* friendGroup; @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) TIMPendencyGetType type; @end /** * 未决请求元信息 */ @interface TIMFriendPendencyMeta : 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; /** * 每页的数量，请求时有效（建议值，server可根据需要返回或多或少，不能作为完成与否的标志） */ @property(nonatomic,assign) uint64_t numPerPage; /** * 未决请求未读数量（仅在server返回时有效） */ @property(nonatomic,assign) uint64_t unReadCnt; @end /** * 推荐好友元信息 */ @interface TIMFriendFutureMeta : TIMCodingModel /** * 翻页类型 */ @property(nonatomic,assign) TIMPageDirectionType directionType; /** * 获取数量 */ @property(nonatomic,assign) uint64_t reqNum; /** * 时间戳：只做分页之用，第一次请求填0，分页时下次请求传入返回的时间戳，直到返回的时间戳为0，表示数据已经拉完，此时更新pendencySeq和recommendSeq（分页过程中不能更新pendencySeq和recommendSeq） */ @property(nonatomic,assign) uint64_t timestamp; /** * 未决序列号 */ @property(nonatomic,assign) uint64_t pendencySeq; /** * 推荐序列号 */ @property(nonatomic,assign) uint64_t recommendSeq; /** * 已决序列号 */ @property(nonatomic,assign) uint64_t decideSeq; /** * 未决未读数量 */ @property(nonatomic,assign) uint64_t pendencyUnReadCnt; /** * 推荐未读数量 */ @property(nonatomic,assign) uint64_t recommendUnReadCnt; /** * 已决未读数量 */ @property(nonatomic,assign) uint64_t decideUnReadCnt; /** * 未决最新时间戳 */ @property(nonatomic,assign) uint64_t currentPendencyTimestamp; /** * 推荐最新时间戳 */ @property(nonatomic,assign) uint64_t currentRecommendTimestamp; /** * 已决最新时间戳 */ @property(nonatomic,assign) uint64_t currentDecideTimestamp; @end /** * 好友元信息 */ @interface TIMFriendMetaInfo : TIMCodingModel /** * 时间戳，需要保存，下次拉取时传入，增量更新使用 */ @property(nonatomic,assign) uint64_t timestamp; /** * 序列号，需要保存，下次拉取时传入，增量更新使用 */ @property(nonatomic,assign) uint64_t infoSeq; /** * 分页信息，无需保存，返回为0时结束，非0时传入再次拉取，第一次拉取时传0 */ @property(nonatomic,assign) uint64_t nextSeq; /** * 覆盖：为TRUE时需要重设timestamp, infoSeq, nextSeq为0，清除客户端存储，重新拉取资料 */ @property(nonatomic,assign) BOOL recover; @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(nonatomic,strong) NSString* identifier; /** * 返回状态 */ @property(nonatomic,assign) TIMFriendStatus status; /** * 检查结果 */ @property(nonatomic,assign) TIMFriendRelationType resultType; @end @interface TIMFriendResult : NSObject /** * 用户Id */ @property(nonatomic,strong) NSString* identifier; /** * 返回状态 */ @property(nonatomic,assign) TIMFriendStatus status; @end @interface TIMFriendResponse : NSObject /** * 响应类型 */ @property(nonatomic,assign) TIMFriendResponseType responseType; /** * 用户identifier */ @property(nonatomic,strong) NSString* identifier; /** * （可选）如果要加对方为好友，表示备注，其他type无效，备注最大96字节 */ @property(nonatomic,strong) NSString* remark; @end /** * 推荐好友 */ @interface TIMFriendFutureItem : TIMCodingModel /** * 推荐好友类型 */ @property(nonatomic,assign) TIMFutureFriendType type; /** * 好友标识 */ @property(nonatomic,strong) NSString* identifier; /** * 好友资料 */ @property(nonatomic,strong) TIMUserProfile* profile; /** * 添加时间 */ @property(nonatomic,assign) uint64_t addTime; /** * 来源（仅未决好友有效） */ @property(nonatomic,strong) NSString* addSource; /** * 加好友附言（仅未决好友有效） */ @property(nonatomic,strong) NSString* addWording; /** * 推荐理由（server端写入，仅推荐好友有效） */ @property(nonatomic,strong) NSDictionary* recommendTags; @end /** * 好友分组信息扩展 */ @interface TIMFriendGroupWithProfiles : TIMFriendGroup /** * 好友资料（TIMUserProfile*）列表 */ @property(nonatomic,strong) NSArray* profiles; @end #endif /* TIMComm_FriendshipExt_h */