nim_core library Null safety
Classes
- AudioService
- AuthService
- ChatroomMessageBuilder
- ChatroomService
- CustomNotification
- CustomNotificationConfig
- Event
- EventSubscribeRequest
- EventSubscribeResult
- EventSubscribeServicePlatform
- MessageBuilder
- MessageKeywordSearchConfig
- MessageSearchOption
- MessageService
- NIMAndroidSDKOptions
- NIMAntiSpamOption
- Anti-spam configuration
- NIMAttachmentProgress
- Upload or download transfer progress
- NIMAudioAttachment
- Audio attachment
- NIMAuthStatusEvent
- Events of login or logout status changes
- NIMBroadcastMessage
- Broadcast messages
- NIMChatroomEnterRequest
- Request for joining a chat room
- NIMChatroomEnterResult
- Response to the request for joining a chat room
- NIMChatroomErrors
- NIMChatroomEvent
- Chat room events
- NIMChatroomIndependentModeConfig
- Chat room standalone mode configuration
- NIMChatroomIndependentModeConfigDesktop
- Windows and macOS standalone configuration
- NIMChatroomInfo
- NIMChatroomKickOutEvent
- The event is triggered when a user is removed from a chat room or a chat room is closed.
- NIMChatroomMember
- Chat room members info
- NIMChatroomMemberInAttachment
- Attachment for a message sent when members join a chat room
- NIMChatroomMemberOptions
- NIMChatroomMessage
- NIMChatroomMessageExtension
- Chat room message extension
- NIMChatroomNotificationAttachment
- Notification attachment
- NIMChatroomNotificationTypes
- Notification types in a chat room
- NIMChatroomQueueChangeAttachment
- NIMChatroomQueueEntry
- Elements in a queue of a chat room
- NIMChatroomStatusEvent
- Chat room status change events
- NIMChatroomTempMuteAttachment
- Attachment for messages sent when a chat room is temporarily muted.
- NIMChatroomUpdateMyMemberInfoRequest
- Request for editing the profile of the current user
- NIMChatroomUpdateRequest
- Request to update the profile of a chat room
- NIMCollectInfo
- Messages in Bookmark
- NIMCollectInfoQueryResult
- Result for querying bookmarks
- NimCore
- NIMCreateTeamOptions
- NIMCreateTeamResult
- NIMCustomMessageAttachment
- Custom message attachment
- NIMCustomMessageConfig
- Message configuration for the life cycle of messages and whether to push or count as unread.
- NIMDataSyncStatusEvent
- Data sync status change event. The event is triggered when data sync starts or ends.
- NIMDismissAttachment
- NIMFileAttachment
- File message attachment
- NIMFriend
- Message
- NIMHandleQuickCommentOption
- NIMImageAttachment
- Image message attachment
- NIMIOSSDKOptions
- NIMKickOutByOtherClientEvent
- NIMLeaveTeamAttachment
- NIMLocalAntiSpamResult
- Result for local anti-spam review The anti-spam lexicon is managed and configured by the developer in the CommsEase console, and the SDK can download and manage this lexicon. Three rules are applied for anti-spam hits
- NIMLocationAttachment
- Image message attachment
- NIMLoginInfo
- Authentication credentials used for login
- NIMMACOSSDKOptions
- NIMMemberChangeAttachment
- NIMMemberPushOption
- Push notification configuration for specified members
- NIMMessage
- Message
- NIMMessageAttachment
- NIMMessageKey
- NIMMessagePin
- Message PIN
- NIMMessagePinAddedEvent
- Add event for PIN messages
- NIMMessagePinEvent
- Result for querying session messages PIN message event
- NIMMessagePinRemovedEvent
- Remove event for PIN messages
- NIMMessagePinUpdatedEvent
- Update event for PIN messages
- NIMMessageReceipt
- Message read receipt
- NIMMessageThreadOption
- NIMMessageTypeConverter
- NIMMixPushConfig
- Message push settings
- NIMMuteMemberAttachment
- NIMMySessionKey
- Session key on the server, including sessionId and sessionType.
- NIMNosScenes
- NIMNOSTransferProgress
- Upload transfer progress
- NIMNOSTransferStatus
- NIMOnlineClient
- Information about the online client.
- NIMPassThroughNotifyData
- NIMPassThroughProxyData
- NIMPushNoDisturbConfig
- Do Not Disturb setting
- NIMQuickCommentOption
- NIMQuickCommentOptionWrapper
-
NIMResult<
T> - NIMRevokeMessage
- Recalled message
- NIMSDKOptions
- Basic configuration for SDK initialization
- NIMSession
- Recent sessions
- NIMSessionInfo
- Session information
- NIMSessionTypeConverter
- NIMStatusBarNotificationConfig
- the SDK configuration for status bar reminder
- NIMStickTopSessionInfo
- NIMSuperTeam
- NIMSuperTeamMember
- NIMSuperTeamNotificationTypes
- Notification types in a chat room
- NIMTeam
- NIMTeamMember
- NIMTeamMessageAckInfo
- Read receipt in groups. The class has two states: 1. The list of accounts that have read or unread messages. 2: The number of accounts that have read or unread messages. In the first state, ackCount and unAckCount are set to 0. In the second state, the values of ackAccountList and unAckAccountList are set to null.
- NIMTeamMessageReceipt
- Group message read receipt
- NIMTeamNotificationAttachment
- Attachment of group notification messages
- NIMTeamNotificationTypes
- Notification types in a chat room
- NIMTeamUpdatedFields
- Fields to be updated
- NIMTeamUpdateFieldRequest
- NIMThreadTalkHistory
- History messages in a thread
- NIMUpdateTeamAttachment
- Attachment of updated messages in a group
- NIMUser
- Message
- NIMVideoAttachment
- Audio attachment
- NIMWINDOWSSDKOptions
- NOSService
- PassThroughMethod
- PassThroughService
- RecentSession
- RecentSessionList
- RecordInfo
- SettingsService
- SuperTeamService
- SuperTeamServicePlatform
- 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
-
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 -
loginInfoFromMap(
Map? map) → NIMLoginInfo? -
loginInfoToMap(
NIMLoginInfo? loginInfo) → Map? -
messageFromMap(
Map? map) → NIMMessage? -
messageToMap(
NIMMessage? nimMessage) → Map? -
nosSceneConfigFromMap(
Map? map) → Map< String, int> ? -
replyListFromMap(
Map? replyListMap) → List< NIMMessage> ? -
replyListToMap(
List< NIMMessage> ? replyList) → List<Map?> ? -
sessionDeleteTypeToString(
NIMSessionDeleteType type) → String -
stringifyDirCacheFileTypeName(
NIMDirCacheFileType type) → String -
teamFromMap(
Map? map) → NIMTeam? -
teamToMap(
NIMTeam? nimTeam) → Map?
Enums
- AudioOutputFormat
- NIMAuthStatus
- login or logout status events
- NIMAuthType
- Authentication type
- NIMChatroomKickOutReason
- Reasons for getting disconnected.
- NIMChatroomMemberQueryType
- Member types
- NIMChatroomMemberType
- Member types in a chat room
- NIMChatroomQueueChangeType
- NIMChatroomQueueModificationLevel
- Chat room queue modification permissions
- NIMChatroomStatus
- Chat room status
- NIMClientType
- Client type
- NIMDirCacheFileType
- Local cache types
- NIMMessageAttachmentStatus
- Message attachment status
- NIMMessageDirection
- Message direction
- NIMMessageStatus
- NIMMessageType
- Message types
- NIMNosTransferStatus
- Transfer states
- NIMNOSTransferType
- Transfer types
- NIMNotificationExtraType
- Extra notification type
- NIMNotificationFoldStyle
- Notification display style
- NIMSessionDeleteType
- NIMSessionType
- Session types
- NIMTeamAllMuteModeEnum
- NIMTeamBeInviteModeEnum
- NIMTeamExtensionUpdateModeEnum
- NIMTeamFieldEnum
- TeamFieldEnum attribute description data type announcement Group announcement beInviteMode Invitation response mode: how to respond to the invitation extension extension field (user-defined) icon Group avatar introduce Group introduction inviteMode Invitation mode: invite permissions maxMemberCount Specify the maximum number of group members. The number of group members cannot exceeds the value of MaxMemberCount. name Group name teamExtensionUpdateMode edit mode of extension fields of a group profile: permissions to edit custom attributes (extension fields) teamUpdateMode edit mode of a group profile: permissions to edit a group profile. verifyType verification mode for joining a group
- NIMTeamInviteModeEnum
- NIMTeamMessageNotifyTypeEnum
- NIMTeamTypeEnum
- TeamTypeEnum attribute description advanced Advanced group with full permissions management normal discussion group with basic permissions management. All users can join a discussion group. superTeam super group Only the group owner can remove members
- NIMTeamUpdateModeEnum
- NIMUnreadCountQueryType
- NIMUserGenderEnum
- User gender constant
- NIMVerifyType
- Verification types for adding friends
- NIMVerifyTypeEnum
- QueryDirection
- RecordState
- RevokeMessageType
- Message recall types
- SearchOrder
- SystemMessageStatus
- SystemMessageType
- TeamMemberType
Typedefs
- ChatroomMessageAction = Future Function(NIMChatroomMessage message)
- MessageAction = Future Function(NIMMessage message)
- NIMNosScene = String
- NIMNosScenes SDK built-in scenarios
-
NIMResultDataConvert<
T> = T? Function(Map< String, dynamic> map)