组件和钩子

  • React Native

更新时间

组件

RTMProvider

该组件向子组件提供 Context,让 children 内的各个组件都能读取你传入的 client 属性。

Props

属性类型默认值描述
clientRTMClient是通过 React Native SDK 的 createAgoraRtmClient 创建的 RTMClient 对象。
childrenReactNativeNode无需要展示的 ReactNative 节点。
表格内容超出当前宽度,可横向滚动查看更多列。

基本用法

JSX
function App({ children }) {
    const [client] = useState(() => createAgoraRtmClient(
        new RtmConfig({
            userId: uid,
            appId: appId,
        })
    ));
    return <RTMProvider client={client}>{children}</RTMProvider>;
}

钩子

useLogin

用于登录 RTM 服务。当组件准备好时登录 RTM 服务,当组件卸载时自动登出 RTM 服务。

参数

参数名类型是否必填描述
clientRTMClient是通过 React Native SDK 的 createAgoraRtmClient 创建的 RTMClient 对象。
loginOptionsLoginOptions是登录选项。详见 login。
表格内容超出当前宽度,可横向滚动查看更多列。

基本用法

JSX
useLogin(client, { token: "your_token" });

useRtm

用于获取 RTMClient 对象。

参数

参数名类型是否必填描述
clientRTMClient | null否通过 React Native SDK 的 createAgoraRtmClient 创建的 RTMClient 对象。
表格内容超出当前宽度,可横向滚动查看更多列。

返回值

返回一个 RTMClient 对象。

基本用法

JSX
const rtmClient = useRtm();

useRtmEvent

用于监听 RTMClient 对象的指定事件。

  • 当组件挂载时,该 Hook 会注册对应的事件监听器。
  • 当组件卸载时,该 Hook 会销毁对应的事件监听器。

参数

参数名类型是否必填描述
clientRTMClient是通过 React Native SDK 的 createAgoraRtmClient 创建的 RTMClient 对象。
eventstring是事件名称。支持的事件详见添加监听。
listenerFunction是回调函数。当传入的事件触发时,该函数会被调用。
表格内容超出当前宽度,可横向滚动查看更多列。

基本用法

JSX
useRtmEvent(client, 'message', (message: MessageEvent) => {
    // your code
});