NIMSDK-iOS
载入中...
搜索中...
未找到
NIMQChatDefs.h 文件参考
#import <Foundation/Foundation.h>

浏览源代码.

类型定义

typedef void(^ NIMQChatHandler) (NSError *__nullable error)
 

枚举

enum  NIMQChatLoginStep {
  NIMQChatLoginStepLinking = 1 , NIMQChatLoginStepLinkOK , NIMQChatLoginStepLinkFailed , NIMQChatLoginStepLogining ,
  NIMQChatLoginStepLoginOK , NIMQChatLoginStepLoginFailed , NIMQChatLoginStepSyncing , NIMQChatLoginStepSyncOK ,
  NIMQChatLoginStepLoseConnection , NIMQChatLoginStepNetChanged , NIMQChatLoginStepLogout
}
 
enum  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 , NIMQChatSystemNotificationTypeVisitorChannelVisibilityUpdate = 34 , NIMQChatSystemNotificationTypeMyMemberInfoUpdated = 35 , NIMQChatSystemNotificationTypeCustom = 100
}
 
enum  NIMQChatSystemNotificationToType {
  NIMQChatSystemNotificationToTypeServer = 1 , NIMQChatSystemNotificationToTypeChannel = 2 , NIMQChatSystemNotificationToTypeServerAccids = 3 , NIMQChatSystemNotificationToTypeChannelAccids = 4 ,
  NIMQChatSystemNotificationToTypeAccids = 5
}
 
enum  NIMQChatRoleType { NIMQChatRoleTypeEveryOne = 1 , NIMQChatRoleTypeCustom = 2 }
 
enum  NIMQChatPermissionType {
  NIMQChatPermissionTypeManageServer = 1 , NIMQChatPermissionTypeManageChannel = 2 , NIMQChatPermissionTypeManageRole = 3 , NIMQChatPermissionTypeSendMsg = 4 ,
  NIMQChatPermissionTypeModifySelfInfo = 5 , NIMQChatPermissionTypeInviteToServer = 6 , NIMQChatPermissionTypeKickOthersInServer = 7 , NIMQChatPermissionTypeModifyOthersInfoInServer = 8 ,
  NIMQChatPermissionTypeRevokeMsg = 9 , NIMQChatPermissionTypeDeleteOtherMsg = 10 , NIMQChatPermissionTypeRemindOther = 11 , NIMQChatPermissionTypeRemindAll = 12 ,
  NIMQChatPermissionTypeManageBlackWhiteList = 13 , NIMQChatPermissionTypeManageBanServerMember = 14 , NIMQChatPermissionTypeRTCChannelConnect = 15 , NIMQChatPermissionTypeRTCChannelDisconnectOther = 16 ,
  NIMQChatPermissionTypeRTCChannelOpenMicrophone = 17 , NIMQChatPermissionTypeRTCChannelOpenCamera = 18 , NIMQChatPermissionTypeRTCChannelOpenCloseOtherMicrophone = 19 , NIMQChatPermissionTypeRTCChannelOpenCloseOtherCamera = 20 ,
  NIMQChatPermissionTypeRTCChannelOpenCloseEveryOneMicrophone = 21 , NIMQChatPermissionTypeRTCChannelOpenCloseEveryOneCamera = 22 , NIMQChatPermissionTypeRTCChannelOpenMyShareScreen = 23 , NIMQChatPermissionTypeRTCChannelCloseOtherShareScreen = 24 ,
  NIMQChatPermissionTypeHandleServerApply = 25 , NIMQChatPermissionTypeQueryServerInviteApplyHistory = 26 , NIMQChatPermissionTypeQueryMentionedRole = 27
}
 
enum  NIMQChatPermissionStatus { NIMQChatPermissionStatusDeny = -1 , NIMQChatPermissionStatusExtend = 0 , NIMQChatPermissionStatusAllow = 1 }
 
enum  NIMQChatServerMemberType { NIMQChatServerMemberTypeCommon = 0 , NIMQChatServerMemberTypeOwner = 1 }
 
enum  NIMQChatChannelType { NIMQChatChannelTypeMsg = 0 , NIMQChatChannelTypeRTC = 1 , NIMQChatChannelTypeCustom = 100 }
 
enum  NIMQChatChannelSyncMode { NIMQChatChannelSyncModeNone = -1 , NIMQChatChannelSyncModeNotSync = 0 , NIMQChatChannelSyncModeSync = 1 }
 
enum  NIMQChatChannelViewMode { NIMQChatChannelViewModeNone = -1 , NIMQChatChannelViewModePublic = 0 , NIMQChatChannelViewModePrivate = 1 }
 
enum  NIMQChatServerInviteMode { NIMQChatServerInviteModeNeedApprove = 0 , NIMQChatServerInviteModeAutoEnter = 1 }
 
enum  NIMQChatServerApplyMode { NIMQChatServerApplyModeAutoEnter = 0 , NIMQChatServerApplyModeNeedApprove = 1 }
 
enum  NIMQChatChannelMemberRoleOpeType { NIMQChatChannelMemberRoleOpeTypeAdd = 1 , NIMQChatChannelMemberRoleOpeTypeRemove = 2 }
 
enum  NIMQChatChannelMemberRoleType { NIMQChatChannelMemberRoleTypeWhite = 1 , NIMQChatChannelMemberRoleTypeBlack = 2 }
 
enum  NIMQChatServerMemberBanType { NIMQChatServerMemberBanTypeBan = 1 , NIMQChatServerMemberBanTypeUnBan = 2 }
 
enum  NIMQChatUpdateQuickCommentType { NIMQChatUpdateQuickCommentTypeAdd = 1 , NIMQChatUpdateQuickCommentTypeDelete = 2 }
 
enum  NIMQChatSearchServerType { NIMQChatSearchServerTypeSquare = 1 , NIMQChatSearchServerTypePersonal = 2 }
 
enum  NIMQChatSearchServerSortType { NIMQChatSearchServerSortTypeCustomWeight = 0 , NIMQChatSearchServerSortTypeCreateTime = 1 , NIMQChatSearchServerSortTypeMemberCount = 2 }
 
enum  NIMQChatSearchChannelSortType { NIMQChatSearchChannelSortTypeCustomWeight = 0 , NIMQChatSearchChannelSortTypeCreateTime = 1 }
 
enum  NIMQChatInoutType { NIMQChatInoutTypeIn = 1 , NIMQChatInoutTypeOut = 2 }
 
enum  NIMQChatSearchMessageSortType { NIMQChatSearchMessageSortTypeSendTime = 1 }
 
enum  NIMQChatSubscribeType {
  NIMQChatSubscribeTypeChannelMsg = 1 , NIMQChatSubscribeTypeChannelMsgUnreadCount = 2 , NIMQChatSubscribeTypeChannelMsgUnreadStatus = 3 , NIMQChatSubscribeTypeServerMsg = 4 ,
  NIMQChatSubscribeTypeChannelTypingEvent = 5 , NIMQChatSubscribeTypeVisitorChannelMsg = 6 , NIMQChatSubscribeTypeVisitorServerMsg = 7
}
 
enum  NIMQChatSubscribeOperationType { NIMQChatSubscribeOperationTypeSubscribe = 1 , NIMQChatSubscribeOperationTypeUnsubscribe = 2 }
 
enum  NIMQChatVisitorMode { NIMQChatVisitorModeNone = -1 , NIMQChatVisitorModeVisible = 0 , NIMQChatVisitorModeInvisible = 1 , NIMQChatVisitorModeFollow = 2 }
 

类型定义说明

◆ NIMQChatHandler

typedef void(^ NIMQChatHandler) (NSError *__nullable error)

圈组网络请求回调

参数
error错误信息

枚举类型说明

◆ NIMQChatChannelMemberRoleOpeType

枚举值
NIMQChatChannelMemberRoleOpeTypeAdd 
NIMQChatChannelMemberRoleOpeTypeRemove 

◆ NIMQChatChannelMemberRoleType

枚举值
NIMQChatChannelMemberRoleTypeWhite 
NIMQChatChannelMemberRoleTypeBlack 

◆ NIMQChatChannelSyncMode

枚举值
NIMQChatChannelSyncModeNone 
NIMQChatChannelSyncModeNotSync 
NIMQChatChannelSyncModeSync 

◆ NIMQChatChannelType

枚举值
NIMQChatChannelTypeMsg 
NIMQChatChannelTypeRTC 
NIMQChatChannelTypeCustom 

◆ NIMQChatChannelViewMode

枚举值
NIMQChatChannelViewModeNone 
NIMQChatChannelViewModePublic 
NIMQChatChannelViewModePrivate 

◆ NIMQChatInoutType

枚举值
NIMQChatInoutTypeIn 
NIMQChatInoutTypeOut 

◆ NIMQChatLoginStep

登录步骤枚举

枚举值
NIMQChatLoginStepLinking 

连接服务器

NIMQChatLoginStepLinkOK 

连接服务器成功

NIMQChatLoginStepLinkFailed 

连接服务器失败

NIMQChatLoginStepLogining 

登录

NIMQChatLoginStepLoginOK 

登录成功

NIMQChatLoginStepLoginFailed 

登录失败

NIMQChatLoginStepSyncing 

开始同步

NIMQChatLoginStepSyncOK 

同步完成

NIMQChatLoginStepLoseConnection 

连接断开

NIMQChatLoginStepNetChanged 

网络切换 @discussion 这个并不是登录步骤的一种,但是UI有可能需要通过这个状态进行UI展现

NIMQChatLoginStepLogout 

主动退出登陆

◆ NIMQChatPermissionStatus

枚举值
NIMQChatPermissionStatusDeny 
NIMQChatPermissionStatusExtend 
NIMQChatPermissionStatusAllow 

◆ NIMQChatPermissionType

圈组权限类型

枚举值
NIMQChatPermissionTypeManageServer 

管理服务器。修改服务器

NIMQChatPermissionTypeManageChannel 

管理频道,server和channel都有

NIMQChatPermissionTypeManageRole 

管理角色的权限,server和channel都有

NIMQChatPermissionTypeSendMsg 

发送消息,server和channel都有

NIMQChatPermissionTypeModifySelfInfo 

修改自己在该server的成员信息,仅server有

NIMQChatPermissionTypeInviteToServer 

邀请他人进入server的,仅server有

NIMQChatPermissionTypeKickOthersInServer 

踢除他人的权限,仅server有

NIMQChatPermissionTypeModifyOthersInfoInServer 

修改他人在该server的服务器成员信息,仅server有

NIMQChatPermissionTypeRevokeMsg 

撤回他人消息的权限,server和channel都有

NIMQChatPermissionTypeDeleteOtherMsg 

删除他人消息的权限,server和channel都有

NIMQChatPermissionTypeRemindOther 

@ 他人的权限,server和channel都有

NIMQChatPermissionTypeRemindAll 

@everyone的权限,server和channel都有

NIMQChatPermissionTypeManageBlackWhiteList 

管理黑白名单的权限,server和channel都有

NIMQChatPermissionTypeManageBanServerMember 

封禁他人的权限,仅server有,允许成员永久封禁其他成员访问此服务器

NIMQChatPermissionTypeRTCChannelConnect 

RTC频道:连接的权限

NIMQChatPermissionTypeRTCChannelDisconnectOther 

RTC频道:断开他人连接的权限

NIMQChatPermissionTypeRTCChannelOpenMicrophone 

RTC频道:开启麦克风的权限

NIMQChatPermissionTypeRTCChannelOpenCamera 

RTC频道:开启摄像头的权限

NIMQChatPermissionTypeRTCChannelOpenCloseOtherMicrophone 

RTC频道:开启/关闭他人麦克风的权限

NIMQChatPermissionTypeRTCChannelOpenCloseOtherCamera 

RTC频道:开启/关闭他人摄像头的权限

NIMQChatPermissionTypeRTCChannelOpenCloseEveryOneMicrophone 

RTC频道:开启/关闭全员麦克风的权限

NIMQChatPermissionTypeRTCChannelOpenCloseEveryOneCamera 

RTC频道:开启/关闭全员摄像头的权限

NIMQChatPermissionTypeRTCChannelOpenMyShareScreen 

RTC频道:打开自己共享屏幕的权限

NIMQChatPermissionTypeRTCChannelCloseOtherShareScreen 

RTC频道:关闭他人共享屏幕的权限

NIMQChatPermissionTypeHandleServerApply 

服务器申请处理权限

NIMQChatPermissionTypeQueryServerInviteApplyHistory 

加入服务器申请邀请历史查看权限,有这个权限才可以查询server级别的申请/邀请记录

NIMQChatPermissionTypeQueryMentionedRole 

身份组的权限,server和channel都有

◆ NIMQChatRoleType

枚举值
NIMQChatRoleTypeEveryOne 

everyone

NIMQChatRoleTypeCustom 

定制

◆ NIMQChatSearchChannelSortType

枚举值
NIMQChatSearchChannelSortTypeCustomWeight 
NIMQChatSearchChannelSortTypeCreateTime 

◆ NIMQChatSearchMessageSortType

枚举值
NIMQChatSearchMessageSortTypeSendTime 

◆ NIMQChatSearchServerSortType

枚举值
NIMQChatSearchServerSortTypeCustomWeight 
NIMQChatSearchServerSortTypeCreateTime 
NIMQChatSearchServerSortTypeMemberCount 

◆ NIMQChatSearchServerType

枚举值
NIMQChatSearchServerTypeSquare 
NIMQChatSearchServerTypePersonal 

◆ NIMQChatServerApplyMode

枚举值
NIMQChatServerApplyModeAutoEnter 
NIMQChatServerApplyModeNeedApprove 

◆ NIMQChatServerInviteMode

枚举值
NIMQChatServerInviteModeNeedApprove 
NIMQChatServerInviteModeAutoEnter 

◆ NIMQChatServerMemberBanType

枚举值
NIMQChatServerMemberBanTypeBan 
NIMQChatServerMemberBanTypeUnBan 

◆ NIMQChatServerMemberType

枚举值
NIMQChatServerMemberTypeCommon 
NIMQChatServerMemberTypeOwner 

◆ NIMQChatSubscribeOperationType

枚举值
NIMQChatSubscribeOperationTypeSubscribe 

订阅

NIMQChatSubscribeOperationTypeUnsubscribe 

取消订阅

◆ NIMQChatSubscribeType

枚举值
NIMQChatSubscribeTypeChannelMsg 

订阅某个channel的【消息】/【通知】

NIMQChatSubscribeTypeChannelMsgUnreadCount 

订阅某个channel的【消息未读数】/【通知】

NIMQChatSubscribeTypeChannelMsgUnreadStatus 

订阅某个channel的【消息未读状态】/【通知】

NIMQChatSubscribeTypeServerMsg 

订阅某个server的【消息】/【通知】,如server基本信息修改、人员进出、权限变更、创建channel等

NIMQChatSubscribeTypeChannelTypingEvent 

订阅某个channel的消息正在输入事件

NIMQChatSubscribeTypeVisitorChannelMsg 

【游客】订阅某个channel的【消息】/【通知】

NIMQChatSubscribeTypeVisitorServerMsg 

【游客】订阅某个server的【消息】/【通知】

◆ NIMQChatSystemNotificationToType

枚举值
NIMQChatSystemNotificationToTypeServer 

服务器ID

NIMQChatSystemNotificationToTypeChannel 

服务器ID/频道ID

NIMQChatSystemNotificationToTypeServerAccids 

服务器ID/账号

NIMQChatSystemNotificationToTypeChannelAccids 

服务器ID/频道ID/账号

NIMQChatSystemNotificationToTypeAccids 

账号

◆ NIMQChatSystemNotificationType

系统通知类型

枚举值
NIMQChatSystemNotificationTypeServerMemberInvite 

邀请服务器成员

NIMQChatSystemNotificationTypeServerMemberInviteReject 

拒绝邀请

NIMQChatSystemNotificationTypeServerMemberApply 

申请加入服务器

NIMQChatSystemNotificationTypeServerMemberApplyReject 

拒绝申请

NIMQChatSystemNotificationTypeServerCreate 

创建服务器

NIMQChatSystemNotificationTypeServerRemove 

删除服务器

NIMQChatSystemNotificationTypeServerUpdate 

修改服务器信息

NIMQChatSystemNotificationTypeServerMemberInviteDone 

已邀请服务器成员

NIMQChatSystemNotificationTypeServerMemberInviteAccept 

接受邀请

NIMQChatSystemNotificationTypeServerMemberApplyDone 

已申请加入服务器

NIMQChatSystemNotificationTypeServerMemberApplyAccept 

接受申请

NIMQChatSystemNotificationTypeServerMemberKick 

踢除服务器成员

NIMQChatSystemNotificationTypeServerMemberLeave 

主动离开服务器

NIMQChatSystemNotificationTypeServerMemberUpdate 

修改服务器成员信息

NIMQChatSystemNotificationTypeChannelCreate 

创建频道

NIMQChatSystemNotificationTypeChannelRemove 

删除频道

NIMQChatSystemNotificationTypeChannelUpdate 

修改频道信息

NIMQChatSystemNotificationTypeChannelUpdateWhiteBlackRole 

频道修改黑白名单身份组

NIMQChatSystemNotificationTypeChannelUpdateWhiteBlackMember 

频道修改黑白名单成员

NIMQChatSystemNotificationTypeUpdateQuickComment 

更新了消息的快捷评论

NIMQChatSystemNotificationTypeCreateChannelCategory 

新增频道分组

NIMQChatSystemNotificationTypeDeleteChannelCategory 

删除频道分组

NIMQChatSystemNotificationTypeUpdateChannelCategory 

修改频道分组

NIMQChatSystemNotificationTypeUpdateChannelCategoryBlackWhiteRole 

更新频道分组黑白名单身份组

NIMQChatSystemNotificationTypeUpdateChannelCategoryBlackWhiteMember 

更新频道分组黑白名单成员

NIMQChatSystemNotificationTypeAddServerRoleMembers 

加入服务器身份组成员

NIMQChatSystemNotificationTypeRemoveServerRoleMembers 

移除服务器身份组成员

NIMQChatSystemNotificationTypeServerRoleAuthUpdate 

更新服务器身份组权限

NIMQChatSystemNotificationTypeChannelRoleAuthUpdate 

更新频道身份组权限

NIMQChatSystemNotificationTypeMemberRoleAuthUpdate 

更新频道中个人定制权限

NIMQChatSystemNotificationTypeChannelVisibilityUpdate 
NIMQChatSystemNotificationTypeServerEnterLeave 

用户进入/离开服务器

NIMQChatSystemNotificationTypeServerMemberJoinByInviteCode 

用户通过邀请码加入服务器

NIMQChatSystemNotificationTypeVisitorChannelVisibilityUpdate 

频道对游客可见性变更,sdk收到此通知后需要重新调整频道的游客订阅信息 //attach:JSON格式,字段:event,event=1表示in,event=2表示out

NIMQChatSystemNotificationTypeMyMemberInfoUpdated 

修改IM用户信息 //attach:JSON格式,字段:type,serverIds,userInfo(name、icon) 2023.02.20 IM-5455 【圈组】圈组的用户资料如果没设置,复用IM的用户资料

NIMQChatSystemNotificationTypeCustom 

自定义信息

◆ NIMQChatUpdateQuickCommentType

枚举值
NIMQChatUpdateQuickCommentTypeAdd 
NIMQChatUpdateQuickCommentTypeDelete 

◆ NIMQChatVisitorMode

枚举值
NIMQChatVisitorModeNone 

不传

NIMQChatVisitorModeVisible 

可见

NIMQChatVisitorModeInvisible 

不可见

NIMQChatVisitorModeFollow 

跟随模式(默认),频道公开游客可见,频道私密游客不可见