• Preparing search index...
  • The search index is not available
agora-react-native-rtm - v2.2.3-dev.1
  • agora-react-native-rtm
  • useRtm

Function useRtm

  • useRtm(client?): RTMClient
  • Parameters

    • Optional client: null | RTMClient

    Returns RTMClient

    • Defined in hooks/useRtm.tsx:29

Settings

Member Visibility

Theme

agora-react-native-rtm - v2.2.3-dev.1
  • default
  • ErrorCode
  • RtmAreaCode
  • RtmChannelType
  • RtmConnectionChangeReason
  • RtmConnectionState
  • RtmEncryptionMode
  • RtmLinkOperation
  • RtmLinkState
  • RtmLinkStateChangeReason
  • RtmLockEventType
  • RtmLogLevel
  • RtmMessagePriority
  • RtmMessageQos
  • RtmMessageType
  • RtmPresenceEventType
  • RtmProtocolType
  • RtmProxyType
  • RtmServiceType
  • RtmStorageEventType
  • RtmStorageType
  • RtmTopicEventType
  • SubscribeTopicErrorCode
  • ChannelInfo
  • GetHistoryMessagesOptions
  • GetOnlineUsersOptions
  • HistoryMessage
  • IRtmClient
  • IRtmLock
  • IRtmPresence
  • IRtmStorage
  • IStreamChannel
  • IntervalInfo
  • JoinChannelOptions
  • JoinTopicOptions
  • LinkStateEvent
  • LockDetail
  • LockEvent
  • MessageEvent
  • Metadata
  • MetadataItem
  • MetadataOptions
  • PresenceEvent
  • PresenceOptions
  • PublishOptions
  • PublisherInfo
  • RTMClient
  • RTMHistory
  • RTMLock
  • RTMPresence
  • RTMStorage
  • RTMStreamChannel
  • RtmConfig
  • RtmEncryptionConfig
  • RtmLogConfig
  • RtmPrivateConfig
  • RtmProxyConfig
  • SnapshotInfo
  • StateItem
  • StorageEvent
  • SubscribeOptions
  • TopicEvent
  • TopicInfo
  • TopicMessageOptions
  • TopicOptions
  • UserList
  • UserState
  • AcquireLockOptions
  • BaseResponse
  • GetLockResponse
  • GetUserMetadataOptions
  • IMetadataOptions
  • IRtmEventHandler
  • LoginOptions
  • RTMClientEventMap
  • RTMProviderProps
  • RemoveChannelMetadataOptions
  • RemoveStateOptions
  • RemoveUserMetadataOptions
  • RenewTokenOptions
  • SetLockOptions
  • SetOrUpdateUserMetadataOptions
  • AcquireLockResponse
  • ChannelMetadataOperationResponse
  • ErrorInfo
  • GetChannelMetadataResponse
  • GetMessagesResponse
  • GetOnlineUsersResponse
  • GetStateResponse
  • GetSubscribedUserListResponse
  • GetUserChannelsResponse
  • GetUserMetadataResponse
  • JoinChannelResponse
  • JoinTopicResponse
  • LeaveChannelResponse
  • LeaveTopicResponse
  • LockOperationResponse
  • LoginResponse
  • LogoutResponse
  • PublishResponse
  • PublishTopicMessageResponse
  • RTMOperationResponse
  • ReleaseLockResponse
  • RemoveChannelMetadataResponse
  • RemoveLockResponse
  • RemoveStateResponse
  • RemoveUserMetadataResponse
  • RenewTokenResponse
  • RevokeLockResponse
  • SetChannelMetadataResponse
  • SetLockResponse
  • SetStateResponse
  • SetUserMetadataResponse
  • StreamChannelOperationResponse
  • SubscribeResponse
  • SubscribeTopicResponse
  • SubscribeUserMetaResponse
  • UnsubscribeResponse
  • UnsubscribeTopicResponse
  • UnsubscribeUserMetaResponse
  • UpdateChannelMetadataResponse
  • UpdateConfigResponse
  • UpdateUserMetadataResponse
  • UserMetadataOperationResponse
  • WhereNowResponse
  • WhoNowResponse
  • AgoraRTMContext
  • RTMProvider
  • callIrisApi
  • createAgoraRtmClient
  • isDebuggable
  • processRTMClientEventMap
  • setDebuggable
  • useLogin
  • useRtm
  • useRtmEvent