nim_core library Null safety
Classes
- AddFriendNotify
- AntiSpamConfig
- AttachmentProgress
- 附件发送/接收进度通知
- AudioService
- AuthService
- AvSignallingService
- 信令服务类 目前仅支持iOS和Android平台
- CallParam
- ChannelBaseInfo
- ChannelCommonEvent
- ChannelFullInfo
- ChatroomMessageBuilder
- ChatroomService
- CustomNotification
- CustomNotificationConfig
- Event
- EventSubscribeRequest
- EventSubscribeResult
- EventSubscribeServicePlatform
- InviteParam
- MemberInfo
- MessageBuilder
- MessageKeywordSearchConfig
- MessageSearchOption
- MessageService
- NIMAndroidSDKOptions
- NIMAntiSpamOption
- 云信反垃圾配置
- NIMAttachmentProgress
- 附件上传/下载进度
- NIMAudioAttachment
- 音频消息附件
- NIMAuthStatusEvent
- 登录/登出状态变更事件
- NIMBroadcastMessage
- 广播消息
- NIMChatroomEnterRequest
- 加入聊天室请求
- NIMChatroomEnterResult
- 加入聊天室响应
- NIMChatroomErrors
- NIMChatroomEvent
- 聊天室事件
- NIMChatroomIndependentModeConfig
- 独立模式聊天室配置信息
- NIMChatroomIndependentModeConfigDesktop
- Windows & macOS独立模式聊天室配置信息
- NIMChatroomInfo
- NIMChatroomKickOutEvent
- 当用户被踢出聊天室或者聊天室关闭时,会触发被踢事件
- NIMChatroomMember
- 聊天室成员信息
- NIMChatroomMemberInAttachment
- 聊天室成员加入通知消息附件
- NIMChatroomMemberOptions
- NIMChatroomMessage
- NIMChatroomMessageExtension
- 聊天室消息扩展
- NIMChatroomNotificationAttachment
- 聊天室通知消息附件
- NIMChatroomNotificationTypes
- 聊天室通知类型
- NIMChatroomQueueChangeAttachment
- NIMChatroomQueueEntry
- 聊天室队列元素
- NIMChatroomStatusEvent
- 聊天室状态变更事件
- NIMChatroomTempMuteAttachment
- 聊天室新增临时禁言通知消息附件
- NIMChatroomUpdateMyMemberInfoRequest
- 修改自身成员信息请求
- NIMChatroomUpdateRequest
- 聊天室信息修改请求
- NIMCollectInfo
- 收藏信息
- NIMCollectInfoQueryResult
- 收藏信息查询结果
- NimCore
- NIMCreateTeamOptions
- NIMCreateTeamResult
- NIMCustomMessageAttachment
- 自定义消息附件
- NIMCustomMessageConfig
- 消息的配置选项,主要用于设定消息的声明周期,是否需要推送,是否需要计入未读数等。
- NIMDataSyncStatusEvent
- 数据同步状态变更事件,可监听数据同步开始、结束
- NIMDismissAttachment
- NIMFileAttachment
- 文件消息附件
- NIMFriend
- 消息
- NIMHandleQuickCommentOption
- NIMImageAttachment
- 图片消息附件
- NIMIOSSDKOptions
- NIMKickOutByOtherClientEvent
- NIMLeaveTeamAttachment
- NIMLocalAntiSpamResult
- 本地反垃圾检测结果 反垃圾词库由开发者在云信后台管理配置,SDK 内负责下载并管理这个词库。垃圾词汇命中后支持三种替换规则:
- NIMLocationAttachment
- 图片消息附件
- NIMLoginInfo
- 用户登录认证信息
- NIMMACOSSDKOptions
- NIMMemberChangeAttachment
- NIMMemberPushOption
- 指定成员推送相关可选项
- NIMMessage
- 消息
- NIMMessageAttachment
- NIMMessageKey
- NIMMessagePin
- 消息PIN
- NIMMessagePinAddedEvent
- 消息PIN 添加事件
- NIMMessagePinEvent
- 会话消息查询结果 消息PIN事件类
- NIMMessagePinRemovedEvent
- 消息PIN 移除事件
- NIMMessagePinUpdatedEvent
- 消息PIN 更新事件
- NIMMessageReceipt
- 消息已读回执
- NIMMessageThreadOption
- NIMMessageTypeConverter
- NIMMixPushConfig
- 消息推送配置
- NIMMuteMemberAttachment
- NIMMySessionKey
- 服务端会话Key,包含 sessionId 与 sessionType
- NIMNosScenes
- NIMNOSTransferProgress
- 文件上传进度
- NIMNOSTransferStatus
- NIMOnlineClient
- 当前在线端信息
- NIMPassThroughNotifyData
- NIMPassThroughProxyData
- NIMPushNoDisturbConfig
- 免打扰配置
- NIMQuickCommentOption
- NIMQuickCommentOptionWrapper
-
NIMResult<
T> - NIMRevokeMessage
- 消息撤回内容
- NIMSDKOptions
- 初始化基础配置
- NIMSession
- 最近会话
- NIMSessionInfo
- 清空消息未读数请求
- NIMSessionTypeConverter
- NIMStatusBarNotificationConfig
- SDK提供状态栏提醒的配置
- NIMStickTopSessionInfo
- NIMSuperTeam
- NIMSuperTeamMember
- NIMSuperTeamNotificationTypes
- 聊天室通知类型
- NIMTeam
- NIMTeamMember
- NIMTeamMessageAckInfo
- 群已读回执信息 此类有两种状态,一种是存储已读未读用户账号列表的状态, 一种是存储已读未读人数的状态 第一种状态下,ackCount和unAckCount为0 第二种状态下ackAccountList和unAckAccountList都为null
- NIMTeamMessageReceipt
- 群消息已读回执
- NIMTeamNotificationAttachment
- 群组通知消息附件
- NIMTeamNotificationTypes
- 聊天室通知类型
- NIMTeamUpdatedFields
- 群更新字段
- NIMTeamUpdateFieldRequest
- NIMThreadTalkHistory
- 请求Thread聊天里的消息列表得到的信息
- NIMUpdateTeamAttachment
- 群组更新消息附件
- NIMUser
- 消息
- NIMVideoAttachment
- 音频消息附件
- NIMWINDOWSSDKOptions
- NOSService
- PairIntWithString
- PassThroughMethod
- PassThroughService
- QChatAcceptServerApplyParam
- QChatAcceptServerInviteParam
- QChatAddChannelRoleParam
- QChatAddChannelRoleResult
- QChatAddMembersToServerRoleParam
- QChatAddMembersToServerRoleResult
- QChatAddServerRoleMembersAttachment
- QChatAntiSpamConfig
- QChatAntiSpamConfigParam
- QChatApplyJoinServerMemberAcceptAttachment
- QChatApplyJoinServerMemberAttachment
- QChatApplyJoinServerMemberDoneAttachment
- 已申请加入服务器通知附件
- QChatApplyServerJoinParam
- QChatApplyServerJoinResult
- QChatChannel
- QChatChannelCategory
- 频道分组信息
- QChatChannelIdInfo
- QChatChannelMember
- QChatChannelRole
- QChatChannelService
- 圈组频道服务 仅支持Android 和 iOS
- QChatClient
- QChatCreateChannelCategoryAttachment
- 创建频道分组通知附件
- QChatCreateChannelNotificationAttachment
- QChatCreateChannelParam
- QChatCreateChannelResult
- QChatCreateServerAttachment
- QChatCreateServerParam
- QChatCreateServerResult
- QChatCreateServerRoleParam
- QChatCreateServerRoleResult
- QChatDeleteChannelCategoryAttachment
- 删除频道分组通知附件
- QChatDeleteChannelParam
- QChatDeleteMessageParam
- QChatDeleteMessageResult
- QChatDeleteServerParam
- QChatDeleteServerRoleMembersAttachment
- QChatDeleteServerRoleParam
- QChatDownloadAttachmentParam
- "下载附件"接口入参
- QChatGenerateInviteCodeParam
- QChatGenerateInviteCodeResult
- QChatGetByPageResult
- QChatGetByPageWithCursorResult
- QChatGetChannelMembersByPageParam
- QChatGetChannelMembersByPageResult
- QChatGetChannelRolesParam
- QChatGetChannelRolesResult
- QChatGetChannelsByPageParam
- QChatGetChannelsByPageResult
- QChatGetChannelsParam
- "查询channel信息"接口入参
- QChatGetChannelsResult
- QChatGetChannelUnreadInfosParam
- "查询未读信息"接口入参
- QChatGetChannelUnreadInfosResult
- QChatGetExistingAccidsInServerRoleParam
- QChatGetExistingAccidsInServerRoleResult
- QChatGetExistingAccidsOfMemberRolesParam
- QChatGetExistingAccidsOfMemberRolesResult
- QChatGetExistingChannelRolesByServerRoleIdsParam
- QChatGetExistingChannelRolesByServerRoleIdsResult
- QChatGetExistingServerRolesByAccidsParam
- QChatGetExistingServerRolesByAccidsResult
- QChatGetMembersFromServerRoleParam
- QChatGetMembersFromServerRoleResult
- QChatGetMessageHistoryByIdsParam
- "根据消息id查询历史消息"接口入参
- QChatGetMessageHistoryParam
- "查询历史消息"接口入参
- QChatGetMessageHistoryResult
- QChatGetServerMembersByPageParam
- QChatGetServerMembersByPageResult
- QChatGetServerMembersParam
- QChatGetServerMembersResult
- QChatGetServerRolesByAccidParam
- QChatGetServerRolesByAccidResult
- QChatGetServerRolesParam
- QChatGetServerRolesResult
- QChatGetServersByPageParam
- QChatGetServersByPageResult
- QChatGetServersParam
- QChatGetServersResult
- QChatInviteApplyServerMemberInfo
- QChatInviteServerMemberAcceptAttachment
- 接受服务器成员邀请通知附件
- QChatInviteServerMemberAttachment
- QChatInviteServerMembersDoneAttachment
- 已邀请服务器成员通知附件
- QChatInviteServerMembersParam
- QChatInviteServerMembersResult
- QChatJoinByInviteCodeParam
- QChatJoinServerByInviteCodeAttachment
- QChatJoinServerOperationParam
- QChatKickedOutEvent
- QChatKickOtherClientsParam
- QChatKickOtherClientsResult
- QChatKickServerMembersDoneAttachment
- QChatKickServerMembersParam
- QChatLeaveServerAttachment
- QChatLeaveServerParam
- QChatLoginParam
- QChatLoginResult
- QChatMarkMessageReadParam
- "标记已读"接口入参
- QChatMarkSystemNotificationsReadParam
- QChatMessage
- QChatMessageAntiSpamOption
- QChatMessageAntiSpamResult
- 消息反垃圾结果
- QChatMessageDeleteEvent
- 消息删除事件
- QChatMessageRefer
- 消息引用结构
- QChatMessageRevokeEvent
- 消息撤回事件
- QChatMessageService
- 圈组消息服务 仅支持Android 和 iOS
- QChatMessageUpdateEvent
- 消息更新事件
- QChatMsgUpdateContent
- 消息更新内容
- QChatMsgUpdateInfo
- 消息更新信息
- QChatMultiSpotLoginEvent
- QChatObserver
- 圈组回调 目前仅支持iOS和Android平台
- QChatQuickComment
- 消息快捷评论
- QChatQuickCommentAttachment
- 快捷评论通知附件
- QChatRejectApplyServerMemberAttachment
- QChatRejectInviteServerMemberAttachment
- QChatRejectServerApplyParam
- QChatRejectServerInviteParam
- QChatRemoveChannelRoleParam
- QChatRemoveMembersFromServerRoleParam
- QChatRemoveMembersFromServerRoleResult
- QChatResendMessageParam
- "重发消息"接口入参
- QChatResendSystemNotificationParam
- QChatRevokeMessageParam
- "撤回消息"接口入参
- QChatRevokeMessageResult
- QChatRoleResourceValueInfo
- QChatRoleService
- 圈组身份组服务 目前仅支持iOS和Android平台
- QChatSearchChannelByPageParam
- 检索频道的接口入参
- QChatSearchChannelByPageResult
- QChatSearchChannelMembersParam
- QChatSearchChannelMembersResult
- QChatSearchServerByPageParam
- QChatSearchServerByPageResult
- QChatSendMessageParam
- QChatSendMessageResult
- QChatSendSystemNotificationParam
- QChatSendSystemNotificationResult
- QChatServer
- QChatServerEnterLeaveAttachment
- 当前用户进入/离开服务器通知附件
- QChatServerJoinParam
- QChatServerMember
- QChatServerRole
- QChatServerRoleMember
- QChatServerService
- 圈组服务器服务 目前仅支持iOS和Android平台
- QChatService
- 圈组服务 目前仅支持iOS和Android平台
- QChatStatusChangeEvent
- 状态变化事件
- QChatSubscribeChannelParam
- "订阅频道"接口入参
- QChatSubscribeChannelResult
- QChatSubscribeServerParam
- QChatSubscribeServerResult
- QChatSystemNotification
- QChatSystemNotificationAttachment
- QChatSystemNotificationAttachmentCommon
- QChatSystemNotificationTypeConverter
- QChatSystemNotificationUpdateEvent
- 系统通知更新事件
- QChatUnreadInfo
- QChatUnreadInfoChangedEvent
- 未读信息变更事件
- QChatUpdateChannelBlackWhiteMemberAttachment
- QChatUpdateChannelBlackWhiteRoleAttachment
- QChatUpdateChannelCategoryAttachment
- QChatUpdateChannelCategoryBlackWhiteMemberAttachment
- 频道分组修改黑白名单成员通知附件
- QChatUpdateChannelCategoryBlackWhiteRoleAttachment
- 频道分组修改黑白名单身份组通知附件
- QChatUpdateChannelNotificationAttachment
- QChatUpdateChannelParam
- QChatUpdateChannelResult
- QChatUpdateChannelRoleAuthsAttachment
- QChatUpdateChannelRoleParam
- QChatUpdateChannelRoleResult
- QChatUpdateChannelVisibilityAttachment
- QChatUpdateMemberRoleAuthsAttachment
- QChatUpdateMessageParam
- QChatUpdateMessageResult
- QChatUpdateMyMemberInfoParam
- QChatUpdateMyMemberInfoResult
- QChatUpdateParam
- 消息/系统通知相关接口更新操作通用参数,设置该操作相关的附加字段,设置该操作引发的推送内容
- QChatUpdateServerAttachment
- QChatUpdateServerMemberAttachment
- QChatUpdateServerParam
- QChatUpdateServerResult
- QChatUpdateServerRoleAuthsAttachment
- QChatUpdateServerRoleParam
- QChatUpdateServerRolePrioritiesParam
- QChatUpdateServerRolePrioritiesResult
- QChatUpdateServerRoleResult
- QChatUpdateSystemNotificationParam
- "更新系统通知"接口入参
- QChatUpdateSystemNotificationResult
- ReadPair
- RecentSession
- RecentSessionList
- RecordInfo
- SettingsService
- SignallingEvent
- SignallingPushConfig
- 信令推送配置项
- SuperTeamService
- SuperTeamServicePlatform
- SyncChannelEvent
- SystemMessage
- SystemMessageServicePlatform
- SystemMessageStatusConverter
- SystemMessageTypeConverter
- TeamService
- UserService
Mixins
-
EnumConverter<
E, T>
Extensions
Constants
-
NIMTeamFieldEnumEnumMap
→ const Map<
NIMTeamFieldEnum, String> -
{NIMTeamFieldEnum.undefined : 'undefined', NIMTeamFieldEnum.announcement : 'announcement', NIMTeamFieldEnum.beInviteMode : 'beInviteMode', NIMTeamFieldEnum.extension : 'ext…
-
NIMTeamMessageNotifyTypeEnumEnumMap
→ const Map<
NIMTeamMessageNotifyTypeEnum, String> -
{NIMTeamMessageNotifyTypeEnum.all : 'all', NIMTeamMessageNotifyTypeEnum.manager : 'manager', NIMTeamMessageNotifyTypeEnum.mute : 'mute'}
Functions
-
antiSpamConfigFromJson(
Map? map) → QChatAntiSpamConfig? -
castMapToTypeOfStringInt(
Map? map) → Map< String, int> ? -
castMapToTypeOfStringString(
Map? map) → Map< String, String> ? -
castPlatformMapToDartMap(
Map? map) → Map< String, dynamic> ? -
enumDecode<
K, V> (Map< K, V> enumValues, Object? source, {K? unknownValue}) → K? -
enumifyDirCacheFileTypeName(
String type) → NIMDirCacheFileType -
getEventFromInt(
int val) → FriendEvent? -
loginInfoFromMap(
Map? map) → NIMLoginInfo? -
loginInfoToMap(
NIMLoginInfo? loginInfo) → Map? -
memberFromJson(
Map? map) → QChatServerMember? -
messageFromMap(
Map? map) → NIMMessage? -
messageToMap(
NIMMessage? nimMessage) → Map? -
nosSceneConfigFromMap(
Map? map) → Map< String, int> ? -
qChatChannelFromJson(
Map? map) → QChatChannel? -
qChatMessageFromJson(
Map? map) → QChatMessage? -
qChatMsgUpdateInfoFromJson(
Map? map) → QChatMsgUpdateInfo? -
qChatSystemNotificationFromJson(
Map? map) → QChatSystemNotification? -
qChatUnreadInfListFromJson(
List? infoList) → List< QChatUnreadInfo> ? -
replyListFromMap(
Map? replyListMap) → List< NIMMessage> ? -
replyListToMap(
List< NIMMessage> ? replyList) → List<Map?> ? -
serverFromJsonNullable(
Map? map) → QChatServer? -
sessionDeleteTypeToString(
NIMSessionDeleteType type) → String -
stringifyDirCacheFileTypeName(
NIMDirCacheFileType type) → String -
teamFromMap(
Map? map) → NIMTeam? -
teamToMap(
NIMTeam? nimTeam) → Map?
Enums
- AudioOutputFormat
- ChannelStatus
- ChannelType
- FriendEvent
- InviteAckStatus
- NIMAuthStatus
- 登录/登出状态事件
- NIMAuthType
- 认证类型
- NIMChatroomKickOutReason
- 从聊天室断开原因
- NIMChatroomMemberQueryType
- 成员查询类型
- NIMChatroomMemberType
- 聊天室成员类型
- NIMChatroomQueueChangeType
- NIMChatroomQueueModificationLevel
- 聊天室队列修改权限
- NIMChatroomStatus
- 聊天室状态
- NIMClientType
- 客户端类型
- NIMDirCacheFileType
- sdk 本地文件缓存类型
- NIMMessageAttachmentStatus
- 消息附件接收/发送状态
- NIMMessageDirection
- 消息方向
- NIMMessageStatus
- NIMMessageType
- 消息内容类型
- NIMNosTransferStatus
- 传输状态
- NIMNOSTransferType
- 传输类型
- NIMNotificationExtraType
- 通知传递的extra类型
- NIMNotificationFoldStyle
- 通知折叠方式
- NIMSessionDeleteType
- NIMSessionType
- 会话类型
- NIMTeamAllMuteModeEnum
- NIMTeamBeInviteModeEnum
- NIMTeamExtensionUpdateModeEnum
- NIMTeamFieldEnum
- TeamFieldEnum属性 说明 数据类型 announcement 群公告 beInviteMode 群被邀请模式:被邀请人的同意方式 extension 群扩展字段(客户端自定义信息) icon 群头像 introduce 群简介 inviteMode 群邀请模式:谁可以邀请他人入群 maxMemberCount 指定创建群组的最大群成员数量 ,MaxMemberCount不能超过应用级配置的最大人数 name 群名 teamExtensionUpdateMode 群资料扩展字段修改模式:谁可以修改群自定义属性(扩展字段) teamUpdateMode 群资料修改模式:谁可以修改群资料 verifyType 申请加入群组的验证模式
- NIMTeamInviteModeEnum
- NIMTeamMessageNotifyTypeEnum
- NIMTeamTypeEnum
- TeamTypeEnum属性 说明 advanced 高级群,有完善的权限管理功能 normal 讨论组,仅具有基本的权限管理功能,所有人都能加入, superTeam 超大群 仅群主可以踢人
- NIMTeamUpdateModeEnum
- NIMUnreadCountQueryType
- NIMUserGenderEnum
- 认证类型
- NIMVerifyType
- 添加好友确认类型
- NIMVerifyTypeEnum
- QChatApplyJoinMode
- QChatChannelBlackWhiteOperateType
- QChatChannelBlackWhiteType
- QChatChannelMode
- QChatChannelSearchSortEnum
- QChatChannelSyncMode
- QChatChannelType
- QChatInOutType
- QChatInviteMode
- QChatKickOutReason
- QChatMemberType
- QChatMultiSpotNotifyType
- QChatNotifyReason
- 下发通知原因
- QChatQuickCommentOperateType
- QChatRoleOption
- 身份组权限选项
- QChatRoleResource
- QChatRoleType
- QChatSearchServerTypeEnum
- QChatServerSearchSortEnum
- 服务器搜索排序条件
- QChatSubscribeOperateType
- QChatSubscribeType
- QChatSystemMessageToType
- QChatSystemNotificationType
- QueryDirection
- RecordState
- RevokeMessageType
- 撤回消息类型
- SearchOrder
- SignallingEventType
- SystemMessageStatus
- SystemMessageType
- TeamMemberType
Typedefs
- ChatroomMessageAction = Future Function(NIMChatroomMessage message)
- MessageAction = Future Function(NIMMessage message)
- NIMNosScene = String
- NIMNosScenes SDK 内置场景
-
NIMResultDataConvert<
T> = T? Function(Map< String, dynamic> map)