NIMQChatDefs.h

浏览该文件的文档.

//
//  NIMQChatDefs.h
//  NIMSDK
//
//  Created by Netease.
//  Copyright © 2022 Netease. All rights reserved.
//
 
#ifndef NIMQChatDefs_h
#define NIMQChatDefs_h
 
#import <Foundation/Foundation.h>
 
/**
 *  登录步骤枚举
 */
typedef NS_ENUM(NSInteger, NIMQChatLoginStep)
{
    /**
     *  连接服务器
     */
    NIMQChatLoginStepLinking = 1,
    /**
     *  连接服务器成功
     */
    NIMQChatLoginStepLinkOK,
    /**
     *  连接服务器失败
     */
    NIMQChatLoginStepLinkFailed,
    /**
     *  登录
     */
    NIMQChatLoginStepLogining,
    /**
     *  登录成功
     */
    NIMQChatLoginStepLoginOK,
    /**
     *  登录失败
     */
    NIMQChatLoginStepLoginFailed,
    /**
     *  开始同步
     */
    NIMQChatLoginStepSyncing,
    /**
     *  同步完成
     */
    NIMQChatLoginStepSyncOK,
    /**
     *  连接断开
     */
    NIMQChatLoginStepLoseConnection,
    /**
     *  网络切换
     *  @discussion 这个并不是登录步骤的一种,但是UI有可能需要通过这个状态进行UI展现
     */
    NIMQChatLoginStepNetChanged,
    /**
     *  主动退出登陆
     */
    NIMQChatLoginStepLogout,
};
/**
 * 系统通知类型
 */
typedef NS_ENUM(NSInteger, NIMQChatSystemNotificationType) {
    /**
    * 邀请服务器成员
    */
    NIMQChatSystemNotificationTypeServerMemberInvite = 1,
 
    /**
     * 拒绝邀请
     */
    NIMQChatSystemNotificationTypeServerMemberInviteReject = 2,
 
    /**
     * 申请加入服务器
     */
    NIMQChatSystemNotificationTypeServerMemberApply = 3,
 
    /**
     * 拒绝申请
     */
    NIMQChatSystemNotificationTypeServerMemberApplyReject = 4,
 
    /**
     * 创建服务器
     */
    NIMQChatSystemNotificationTypeServerCreate = 5,
 
    /**
     * 删除服务器
     */
    NIMQChatSystemNotificationTypeServerRemove = 6,
 
    /**
     * 修改服务器信息
     */
    NIMQChatSystemNotificationTypeServerUpdate = 7,
 
    /**
     * 已邀请服务器成员
     */
    NIMQChatSystemNotificationTypeServerMemberInviteDone = 8,
 
    /**
     * 接受邀请
     */
    NIMQChatSystemNotificationTypeServerMemberInviteAccept = 9,
 
    /**
     * 已申请加入服务器
     */
    NIMQChatSystemNotificationTypeServerMemberApplyDone = 10,
 
    /**
     * 接受申请
     */
    NIMQChatSystemNotificationTypeServerMemberApplyAccept = 11,
 
    /**
     * 踢除服务器成员
     */
    NIMQChatSystemNotificationTypeServerMemberKick = 12,
 
    /**
     * 主动离开服务器
     */
    NIMQChatSystemNotificationTypeServerMemberLeave = 13,
 
    /**
     * 修改服务器成员信息
     */
    NIMQChatSystemNotificationTypeServerMemberUpdate = 14,
 
    /**
     * 创建频道
     */
    NIMQChatSystemNotificationTypeChannelCreate = 15,
 
    /**
     * 删除频道
     */
    NIMQChatSystemNotificationTypeChannelRemove = 16,
 
    /**
     * 修改频道信息
     */
    NIMQChatSystemNotificationTypeChannelUpdate = 17,
 
    /**
     * 频道修改黑白名单身份组
     */
    NIMQChatSystemNotificationTypeChannelUpdateWhiteBlackRole = 18,
 
    /**
     * 频道修改黑白名单成员
     */
    NIMQChatSystemNotificationTypeChannelUpdateWhiteBlackMember = 19,
    
    /**
     * 更新了消息的快捷评论
     */
    NIMQChatSystemNotificationTypeUpdateQuickComment = 20,
    /**
     * 新增频道分组
     */
    NIMQChatSystemNotificationTypeCreateChannelCategory = 21,
    /**
     * 删除频道分组
     */
    NIMQChatSystemNotificationTypeDeleteChannelCategory = 22,
    /**
     * 修改频道分组
     */
    NIMQChatSystemNotificationTypeUpdateChannelCategory = 23,
    /**
     * 更新频道分组黑白名单身份组
     */
    NIMQChatSystemNotificationTypeUpdateChannelCategoryBlackWhiteRole = 24,
    /**
     * 更新频道分组黑白名单成员
     */
    NIMQChatSystemNotificationTypeUpdateChannelCategoryBlackWhiteMember = 25,
    /**
     * 加入服务器身份组成员
     */
    NIMQChatSystemNotificationTypeAddServerRoleMembers = 26,
    /**
     * 移除服务器身份组成员
     */
    NIMQChatSystemNotificationTypeRemoveServerRoleMembers = 27,
    /**
     * 更新服务器身份组权限
     */
    NIMQChatSystemNotificationTypeServerRoleAuthUpdate = 28,
    /**
     * 更新频道身份组权限
     */
    NIMQChatSystemNotificationTypeChannelRoleAuthUpdate = 29,
    /**
     * 更新频道中个人定制权限
     */
    NIMQChatSystemNotificationTypeMemberRoleAuthUpdate = 30,
    /*
     * 频道对当前用户可见性变更
     */
    NIMQChatSystemNotificationTypeChannelVisibilityUpdate = 31,
    /**
     * 用户进入/离开服务器
     */
    NIMQChatSystemNotificationTypeServerEnterLeave = 32,
    /**
     * 用户通过邀请码加入服务器
     */
    NIMQChatSystemNotificationTypeServerMemberJoinByInviteCode = 33,
    /**
     * 频道对游客可见性变更，sdk收到此通知后需要重新调整频道的游客订阅信息  //attach：JSON格式，字段：event，event=1表示in，event=2表示out
     */
    NIMQChatSystemNotificationTypeVisitorChannelVisibilityUpdate = 34,
    /**
     * 修改IM用户信息 //attach：JSON格式，字段：type，serverIds，userInfo（name、icon）
     * 2023.02.20 IM-5455  【圈组】圈组的用户资料如果没设置，复用IM的用户资料
     */
    NIMQChatSystemNotificationTypeMyMemberInfoUpdated = 35,
    /**
     * 禁言、解禁相关操作
     */
    NIMQChatSystemNotificationTypeMute = 36,
    /**
     * 自定义信息
     */
    NIMQChatSystemNotificationTypeCustom = 100,
 
};
 
typedef NS_ENUM(NSInteger, NIMQChatSystemNotificationToType) {
    /**
     * 服务器ID
     */
    NIMQChatSystemNotificationToTypeServer = 1,
    /**
     * 服务器ID/频道ID
     */
    NIMQChatSystemNotificationToTypeChannel = 2,
    /**
     * 服务器ID/账号
     */
    NIMQChatSystemNotificationToTypeServerAccids = 3,
    /**
     * 服务器ID/频道ID/账号
     */
    NIMQChatSystemNotificationToTypeChannelAccids = 4,
    /**
     * 账号
     */
    NIMQChatSystemNotificationToTypeAccids = 5,
};
 
//身份组类型 1表示everyone,2表示定制身份组
typedef NS_ENUM(NSInteger, NIMQChatRoleType) {
    /**
     * everyone
     */
    NIMQChatRoleTypeEveryOne = 1,
    /**
     * 定制
     */
    NIMQChatRoleTypeCustom = 2,
};
 
/**
 *  圈组网络请求回调
 *
 *  @param error 错误信息
 */
typedef void(^NIMQChatHandler)(NSError *__nullable error);
 
/**
 *  圈组权限类型
 */
typedef NS_ENUM(NSInteger, NIMQChatPermissionType) {
    
    /**
     * 管理服务器。修改服务器
     */
    NIMQChatPermissionTypeManageServer             =       1,
   /**
    * 管理频道，server和channel都有
    */
    NIMQChatPermissionTypeManageChannel            =       2,
   /**
    * 管理角色的权限，server和channel都有
    */
    NIMQChatPermissionTypeManageRole               =       3,
   /**
    * 发送消息，server和channel都有
    */
    NIMQChatPermissionTypeSendMsg                  =       4,
    /**
     * 修改自己在该server的成员信息，仅server有
     */
    NIMQChatPermissionTypeModifySelfInfo           =       5,
   /**
    * 邀请他人进入server的，仅server有
    */
    NIMQChatPermissionTypeInviteToServer           =       6,
   /**
    * 踢除他人的权限，仅server有
    */
    NIMQChatPermissionTypeKickOthersInServer       =       7,
   /**
    * 修改他人在该server的服务器成员信息，仅server有
    */
    NIMQChatPermissionTypeModifyOthersInfoInServer =       8,
   /**
    * 撤回他人消息的权限，server和channel都有
    */
    NIMQChatPermissionTypeRevokeMsg                =       9,
   /**
    * 删除他人消息的权限，server和channel都有
    */
    NIMQChatPermissionTypeDeleteOtherMsg           =       10,
   /**
    * @ 他人的权限，server和channel都有
    */
    NIMQChatPermissionTypeRemindOther              =       11,
   /**
    * @everyone的权限，server和channel都有
    */
    NIMQChatPermissionTypeRemindAll                =       12,
   /**
    * 管理黑白名单的权限，server和channel都有
    */
    NIMQChatPermissionTypeManageBlackWhiteList     =       13,
   /**
    * 封禁他人的权限，仅server有，允许成员永久封禁其他成员访问此服务器
    */
    NIMQChatPermissionTypeManageBanServerMember     =       14,
    /**
     * RTC频道：连接的权限
     */
    NIMQChatPermissionTypeRTCChannelConnect  = 15,
    /**
     * RTC频道：断开他人连接的权限
     */
    NIMQChatPermissionTypeRTCChannelDisconnectOther  = 16,
    /**
     * RTC频道：开启麦克风的权限
     */
    NIMQChatPermissionTypeRTCChannelOpenMicrophone  = 17,
    /**
     * RTC频道：开启摄像头的权限
     */
    NIMQChatPermissionTypeRTCChannelOpenCamera  = 18,
    /**
     * RTC频道：开启/关闭他人麦克风的权限
     */
    NIMQChatPermissionTypeRTCChannelOpenCloseOtherMicrophone  = 19,
    /**
     * RTC频道：开启/关闭他人摄像头的权限
     */
    NIMQChatPermissionTypeRTCChannelOpenCloseOtherCamera  = 20,
    /**
     * RTC频道：开启/关闭全员麦克风的权限
     */
    NIMQChatPermissionTypeRTCChannelOpenCloseEveryOneMicrophone  = 21,
    /**
     * RTC频道：开启/关闭全员摄像头的权限
     */
    NIMQChatPermissionTypeRTCChannelOpenCloseEveryOneCamera  = 22,
    /**
     * RTC频道：打开自己共享屏幕的权限
     */
    NIMQChatPermissionTypeRTCChannelOpenMyShareScreen  = 23,
    /**
     * RTC频道：关闭他人共享屏幕的权限
     */
    NIMQChatPermissionTypeRTCChannelCloseOtherShareScreen  = 24,
    /**
     * 服务器申请处理权限
     */
    NIMQChatPermissionTypeHandleServerApply  = 25,
    /**
     * 加入服务器申请邀请历史查看权限，有这个权限才可以查询server级别的申请/邀请记录
     */
    NIMQChatPermissionTypeQueryServerInviteApplyHistory  = 26,
    /**
     * 身份组的权限，server和channel都有
     */
    NIMQChatPermissionTypeQueryMentionedRole  = 27,
    /**
     * 禁言操作的权限，server和channel都有
     */
    NIMQChatPermissionTypeMute  = 28
};
 
// 权限操作
typedef NS_ENUM(NSInteger, NIMQChatPermissionStatus) {
    NIMQChatPermissionStatusDeny   = -1,
    NIMQChatPermissionStatusExtend = 0,
    NIMQChatPermissionStatusAllow  = 1,
};
// 成员
typedef NS_ENUM(NSInteger, NIMQChatServerMemberType) {
    NIMQChatServerMemberTypeCommon   =  0,
    NIMQChatServerMemberTypeOwner    =  1,
};
// 频道类型
typedef NS_ENUM(NSInteger, NIMQChatChannelType) {
    NIMQChatChannelTypeMsg   =  0,  // 消息频道
    NIMQChatChannelTypeRTC   =  1,  // 音视频频道
    NIMQChatChannelTypeCustom    =  100,  //自定义频道
};
 
// 频道配置与频道分组同步模式
typedef NS_ENUM(NSInteger, NIMQChatChannelSyncMode) {
    NIMQChatChannelSyncModeNone   =  -1,
    NIMQChatChannelSyncModeNotSync    =  0,
    NIMQChatChannelSyncModeSync   =  1,
};
// 频道查看模式
typedef NS_ENUM(NSInteger, NIMQChatChannelViewMode) {
    NIMQChatChannelViewModeNone       = -1,
    NIMQChatChannelViewModePublic     =  0,
    NIMQChatChannelViewModePrivate    =  1,
};
 
 
// 服务器邀请模式
typedef NS_ENUM(NSInteger, NIMQChatServerInviteMode) {
    NIMQChatServerInviteModeNeedApprove   =  0, // 需要同意
    NIMQChatServerInviteModeAutoEnter     =  1,  // 不需要同意
};
 
// 服务器申请模式
typedef NS_ENUM(NSInteger, NIMQChatServerApplyMode) {
    NIMQChatServerApplyModeAutoEnter      =  0, // 不需要同意
    NIMQChatServerApplyModeNeedApprove    =  1,  // 需要同意
};
//频道成员身份组的操作类型
typedef NS_ENUM(NSInteger, NIMQChatChannelMemberRoleOpeType) {
    NIMQChatChannelMemberRoleOpeTypeAdd       =  1, //添加
    NIMQChatChannelMemberRoleOpeTypeRemove    =  2,  //移除
};
//频道成员身份组类型
typedef NS_ENUM(NSInteger, NIMQChatChannelMemberRoleType) {
    NIMQChatChannelMemberRoleTypeWhite       =  1, // 白名单
    NIMQChatChannelMemberRoleTypeBlack    =  2,  // 黑名单
};
 
//成员封禁类型
typedef NS_ENUM(NSInteger, NIMQChatServerMemberBanType) {
    NIMQChatServerMemberBanTypeBan       =  1, // 封禁
    NIMQChatServerMemberBanTypeUnBan    =  2, // 解封
};
 
//快捷评论操作类型
typedef NS_ENUM(NSInteger, NIMQChatUpdateQuickCommentType) {
    NIMQChatUpdateQuickCommentTypeAdd       =  1, // 添加
    NIMQChatUpdateQuickCommentTypeDelete    =  2, // 删除
};
 
typedef NS_ENUM(NSInteger, NIMQChatSearchServerType) {
    NIMQChatSearchServerTypeSquare      = 1, // 广场搜索
    NIMQChatSearchServerTypePersonal    = 2, // 个人服务器搜索
};
 
typedef NS_ENUM(NSInteger, NIMQChatSearchServerSortType) {
    NIMQChatSearchServerSortTypeCustomWeight      = 0, // 自定义权重排序
    NIMQChatSearchServerSortTypeCreateTime         = 1,  // 创建时间排序， 默认
    NIMQChatSearchServerSortTypeMemberCount      = 2, // 服务器人数排序
};
 
typedef NS_ENUM(NSInteger, NIMQChatSearchChannelSortType) {
    NIMQChatSearchChannelSortTypeCustomWeight      = 0, // 自定义权重排序
    NIMQChatSearchChannelSortTypeCreateTime         = 1, // 创建时间排序， 默认
};
 
typedef NS_ENUM(NSInteger, NIMQChatInoutType) {
    NIMQChatInoutTypeIn     = 1, // 加入
    NIMQChatInoutTypeOut    = 2, // 退出
};
 
//圈组消息排序方式
typedef NS_ENUM(NSInteger, NIMQChatSearchMessageSortType) {
    NIMQChatSearchMessageSortTypeSendTime  = 1, //发送时间排序
};
 
//圈组订阅类型
typedef NS_ENUM(NSInteger, NIMQChatSubscribeType) {
 
    /**
     * 订阅某个channel的【消息】/【通知】
     */
    NIMQChatSubscribeTypeChannelMsg = 1,
    /**
     * 订阅某个channel的【消息未读数】/【通知】
     */
    NIMQChatSubscribeTypeChannelMsgUnreadCount = 2,
    /**
     * 订阅某个channel的【消息未读状态】/【通知】
     */
    NIMQChatSubscribeTypeChannelMsgUnreadStatus = 3,
    /**
     * 订阅某个server的【消息】/【通知】，如server基本信息修改、人员进出、权限变更、创建channel等
     */
    NIMQChatSubscribeTypeServerMsg = 4,
    /**
     * 订阅某个channel的消息正在输入事件
     */
    NIMQChatSubscribeTypeChannelTypingEvent = 5,
    /**
     * 【游客】订阅某个channel的【消息】/【通知】
     */
    NIMQChatSubscribeTypeVisitorChannelMsg = 6,
    /**
     * 【游客】订阅某个server的【消息】/【通知】
     */
    NIMQChatSubscribeTypeVisitorServerMsg = 7,
};
 
//圈组订阅操作类型
typedef NS_ENUM(NSInteger, NIMQChatSubscribeOperationType) {
    /**
     * 订阅
     */
    NIMQChatSubscribeOperationTypeSubscribe = 1,
    /**
     * 取消订阅
     */
    NIMQChatSubscribeOperationTypeUnsubscribe = 2,
};
 
 
 
//圈组游客可见模式
typedef NS_ENUM(NSInteger, NIMQChatVisitorMode) {
    /**
     * 不传
     */
    NIMQChatVisitorModeNone = -1,
    /**
     * 可见
     */
    NIMQChatVisitorModeVisible = 0,
    /**
     * 不可见
     */
    NIMQChatVisitorModeInvisible = 1,
    /**
     * 跟随模式(默认)，频道公开游客可见，频道私密游客不可见
     */
    NIMQChatVisitorModeFollow = 2,
};
 
//禁言的操作类型
typedef NS_ENUM(NSInteger, NIMQChatMuteOperateType) {
    /**
     * 禁言
     */
    NIMQChatMuteOperateTypeMute = 1,
    /**
     * 解禁
     */
    NIMQChatMuteOperateTypeUnMute = 2,
    /**
     * 自动解禁
     */
    NIMQChatMuteOperateTypeAutoUnMute = 3,
};
 
 
//禁言级别
typedef NS_ENUM(NSInteger, NIMQChatMuteLevel) {
    /**
     * 服务器级别
     */
    NIMQChatMuteLevelServer = 1,
    /**
     * 频道级别
     */
    NIMQChatMuteLevelChannel = 2,
};
 
//禁言后的通知范围类型
typedef NS_ENUM(NSInteger, NIMQChatMuteNotifyScope) {
    /**
     * 仅通知被操作人
     */
    NIMQChatMuteNotifyScopeServerTargetOnly = 1,
    /**
     * 通知所有人
     */
    NIMQChatMuteNotifyScopeChannelAll = 2,
};
 
#endif /* NIMQChatDefs_h */