ImState class

IM 的全局状态管理

Constructors

ImState()
factory

Properties

hashCode → int
The hash code for this object.
no setterinherited
runtimeType → Type
A representation of the runtime type of the object.
no setterinherited

Methods

noSuchMethod(Invocation invocation) → dynamic
Invoked when a nonexistent method or property is accessed.
inherited
toString() → String
A string representation of this object.
inherited

Operators

operator ==(Object other) → bool
The equality operator.
inherited

Static Properties

applicationNavigatorKey ↔ GlobalKey<NavigatorState>?
当需要音视频通话时，宿主应用需要传入的全局 navigatorKey
getter/setter pair
callBeginTimeNotifiers ↔ ValueNotifier<DateTime?>
当前开始音视频通话的时间
getter/setter pair
callCameraIsOnNotifiers ↔ ValueNotifier<bool>
当前本地视频是否开启，拨打视频通话时，默认开启
getter/setter pair
callEventCallListenerConfig ↔ ValueNotifier<EventCallListenerConfig?>
call 实例对应的事件监听参数
getter/setter pair
callInstance ↔ ValueNotifier
call 实例
getter/setter pair
callIsInitiatorNotifier ↔ ValueNotifier<bool?>
当前是否为音视频通话发起者
getter/setter pair
callMemberListNotifier ↔ ValueNotifier<List<CallMemberInfo>>
当前音视频通话成员信息
getter/setter pair
callMicrophoneIsOnNotifiers ↔ ValueNotifier<bool>
当前本地音频是否开启，拨打音视频通话时，默认开启
getter/setter pair
callStateNotifier ↔ ValueNotifier<CallState>
当前音视频通话拨打状态
getter/setter pair
callTypeNotifier ↔ ValueNotifier<CallType?>
音视频通话相关 =========================================================================== 当前拨打音视频类型
getter/setter pair
callVolumeNotifiers → Map<String, ValueNotifier<int>>
通话各参与方声音的变化
final
chatEventChatListenerConfig ↔ ValueNotifier<EventChatListenerConfig?>
chat 实例对应的事件监听参数
getter/setter pair
chatInstance ↔ ValueNotifier
chat 实例相关 =========================================================================== chat 实例
getter/setter pair
chatLoginInfo ↔ ValueNotifier<ImLoginInfoEntity?>
chat 登录账号
getter/setter pair
conversationList ↔ ValueNotifier<List<ConversationItemEntity>>
数据存储 =========================================================================== 会话数据
getter/setter pair
conversationListNative ↔ ConversationListNotifier
会话数据 - 原生平台
getter/setter pair
currentFocusConversation ↔ ValueNotifier<ConversationItemEntity?>
当前打开聚焦的会话
getter/setter pair
currentFocusConversationNative ↔ ValueNotifier<Map<String, dynamic>?>
当前打开聚焦的会话 - 原生平台
getter/setter pair
doFilterConvDataList ↔ Future<List<Map<String, dynamic>>> Function(List<Map<String, dynamic>> convList, PaginationType paginationType)?
对于原生平台，进行刷新会话列表的方法
getter/setter pair
imSdkAppID ↔ ValueNotifier<int?>
im SdkAppID
getter/setter pair
imSdkKey ↔ ValueNotifier<String?>
im Sdk key
getter/setter pair
initCallInstance ↔ ValueNotifier<bool>
call 实例相关 =========================================================================== 是否初始化 call 实例
getter/setter pair
keyboardHeight ↔ ValueNotifier<double>
存储当前的键盘高度
getter/setter pair
messageListConfig ↔ ValueNotifier<Map<String, List<MessageItemEntity>>>
聊天消息存储
getter/setter pair
messageListNativeConfig ↔ ValueNotifier<Map<String, List<Map<String, dynamic>>>>
聊天消息存储 - 原生平台
getter/setter pair
needClearUnreadConversations ↔ ValueNotifier<Set<String>>
需要清除未读消息数的会话列表
getter/setter pair
totalUnreadMessageCount ↔ ValueNotifier<int>
总消息未读数
getter/setter pair

Static Methods

addMessage(MessageItemEntity msgInfo) → void
发送消息后添加聊天消息
addMessageNative(Map<String, dynamic> msgInfo) → void
发送消息后添加聊天消息 - 原生平台
addNeedClearUnreadConversation(List<String> conversationIdList) → void
添加需要清除未读消息数的会话
callVolumeOf(String userId) → ValueNotifier<int>
获取对应用户的声音变化监听
clearImConfig() → void
销毁 im 参数配置
getImSdkKey() → Future<String?>
设置 im Sdk key
getKeyboardHeightWithLeast({double least = 260, double? getKeyboardHeight}) → double
获取当前的键盘高度，当键盘高度小于 least 时，返回 least
getMessageList({String? conversationID}) → List<MessageItemEntity>
获取聊天消息
getMessageListNative({String? conversationID}) → List<Map<String, dynamic>>
获取聊天消息 - 原生平台
removeNeedClearUnreadConversation(String conversationId) → void
移除需要清除未读消息数的会话
setCallEventCallListenerConfig(EventCallListenerConfig? listenerConfig) → void
设置 call 实例对应的事件监听参数
setChatEventChatListenerConfig(EventChatListenerConfig? listenerConfig) → void
设置 chat 实例对应的事件监听参数
setChatLoginInfo(ImLoginInfoEntity? loginInfo) → void
设置 chat 登录账号
setConversationList(List list, {bool doClear = false}) → void
设置会话数据
setConversationListNative(List<Map<String, dynamic>> list, {bool doClear = false, bool isRefresh = false}) → Future<void>
设置会话数据 - 原生平台
setConversationListUpdateNative(List<Map<String, dynamic>> list) → Future<void>
更新部分会话数据 - 原生平台
setCurrentFocusConversation(ConversationItemEntity? conversationData) → void
设置当前打开聚焦的会话
setCurrentFocusConversationNative(Map<String, dynamic>? conversationData, {bool toggle = false}) → void
设置当前打开聚焦的会话 - 原生平台
setDoFilterConvDataListFunIsBlockFlag(bool flag) → void
设置 对会话列表的过滤请求是否屏蔽 - 对 android / ios 原生平台
setImSdkAppID(int? sdkAppID) → void
设置 im SdkAppID
setImSdkKey(String? sdkKey) → void
设置 im Sdk key
setInitCallInstance(bool initCall) → void
设置 是否初始化 call 实例
setMessageList(List<MessageItemEntity> msgList) → void
设置聊天消息
setMessageListNative(List<Map<String, dynamic>> msgList) → void
设置聊天消息 - 原生平台
setTotalUnreadMessageCount(int totalUnreadCount) → void
设置总消息未读数
stopWhenCallEnd(CallState callState) → void
停止音视频通话需要清理的部分
updateCallMemberList(List<String> userIdList, {bool? isEnter}) → void
更新音视频通话成员信息
updateCallVolume(String userId, int volume) → void
更新通话中各参与方声音的变化