通知
RTM 1.x 将于近期下架，各版本退休日期和替代方案详见 退休政策 。
Documentation
Real-time Messaging
Console 官网 Community Technical support
English
search-icon

Agora RTM Web API Reference

Index AgoraRTM RtmClient RtmMessage RtmChannel LocalInvitation RemoteInvitation RtmEvents RtmErrorCode RtmStatusCode

AgoraRTM is the exported module of the Agora RTM SDK.

If you import the Agora RTM Web SDK using the <script> tag, the SDK creates a global variable called AgoraRTM, which includes all the module members.

example

Direct include <script src="agora-rtm-sdk-0.9.1.js"></script> in your HTML.

Note:

The version `0.9.1` in the file name `agora-rtm-sdk-0.9.1.js` is for reference only, please use the latest version of the SDK.

Index

Variables

Functions

Variables

Const BUILD

BUILD: string

Compilation information of the Agora RTM SDK.

example

AgoraRTM.BUILD

Const ConnectionChangeReason

ConnectionChangeReason: ConnectionChangeReason

Const ConnectionState

ConnectionState: ConnectionState

Const LOG_FILTER_ERROR

LOG_FILTER_ERROR: LogFilterType

Output ERROR level log information.

Const LOG_FILTER_INFO

LOG_FILTER_INFO: LogFilterType

Output ERROR, WARNING, and INFO level log information.

Const LOG_FILTER_OFF

LOG_FILTER_OFF: LogFilterType

Do not output any log information.

Const LOG_FILTER_WARNING

LOG_FILTER_WARNING: LogFilterType

Output WARNING and INFO level log information.

Const LocalInvitationFailureReason

LocalInvitationFailureReason: LocalInvitationFailureReason

Const LocalInvitationState

LocalInvitationState: LocalInvitationState

Const RemoteInvitationFailureReason

RemoteInvitationFailureReason: RemoteInvitationFailureReason

Const RemoteInvitationState

RemoteInvitationState: RemoteInvitationState

Const VERSION

VERSION: string

Version of the Agora RTM SDK.

example

AgoraRTM.VERSION

Functions

createInstance

  • Creates and returns an RtmClient instance.

    The Agora RTM SDK supports creating multiple RtmClient instances.

    All methods in the RtmClient class are executed asynchronously.

    example

    Create an RtmClient instance

    import AgoraRTM from 'agora-rtm-sdk';
const client = AgoraRTM.createInstance('demoAppId', { enableLogUpload: false }); // Pass your App ID here.

    Parameters

    • appId: string

      App ID of your project that must be a string containing 32 ASCII characters.

    • Optional params: RtmParameters

      The configurable parameters of an RtmClient instance.

    Returns RtmClient

    An RtmClient instance.