全局上下文

更新时间: 2023/07/21 06:56:54

IM UIKit 提供 useStateContext hooks 函数,帮助您在 Provider 的子组件访问 IM UIKit 的上下文。

返回值说明

useStateContext hooks 函数的返回值说明如下:

返回值 类型 说明
nim Object NIM SDK 实例的封装,开发者一般无需关心
store Object 内部 store,具体说明见下文的store 说明
initOptions Object 初始化时传入的初始化参数

store 说明

store提供 IM UIKit 内部数据驱动的能力,由 Mobx 提供数据和 UI 双向绑定的能力。如果需要使用store中的数据自行渲染,请使用 mobx-react 提供的 observer 包裹您的 React 组件。具体使用说明请参见Mobx

  • store 返回值列表
返回值 类型 说明
uiStore Object Mobx 可观察对象,负责 UI 会用到的属性的子 store
connectStore Object Mobx 可观察对象,负责连接的子 store
msgStore Object Mobx 可观察对象,负责管理会话消息的子 store
sysMsgStore Object Mobx 可观察对象,负责管理系统消息的子 store
sessionStore Object Mobx 可观察对象,负责管理会话列表的子 store
friendStore Object Mobx 可观察对象,负责管理好友信息的子 store
userStore Object Mobx 可观察对象,负责管理用户信息(包含陌生人)的子 store
relationStore Object Mobx 可观察对象,负责管理黑名单和静音列表的子 store
teamStore Object Mobx 可观察对象,负责管理群组的子 store
teamMemberStore Object Mobx 可观察对象,负责管理群组成员的子 store

示例代码

import React from 'react'
import { observer } from 'mobx-react'
import { useStateContext } from '@xkit-yx/im-kit-ui'

const Page1 = () => {
  const { store } = useStateContext()

  console.log(store)


  return (
    <observer>
      <div>当前的连接状态是:{store.connectStore.connectState}</div>
    </observer>
  )
}
此文档是否对你有帮助?
有帮助
去反馈
  • 返回值说明
  • store 说明
  • 示例代码