Class IRtmClientAbstract

The IRtmClient class.

This class provides the main methods that can be invoked by your app.

IRtmClient is the basic interface class of the Agora RTM SDK. Creating an IRtmClient object and then calling the methods of this object enables you to use Agora RTM SDK's functionality.

Hierarchy

  • IRtmClient

Constructors

constructor

Methods

createStreamChannel getHistory getLock getPresence getStorage login logout publish release renewToken setParameters subscribe unsubscribe

Constructors

constructor

Methods

Abstract createStreamChannel

Abstract getHistory

Abstract getLock

Abstract getPresence

Abstract getStorage

Abstract login

  • Login the Agora RTM service. The operation result will be notified by \ref agora::rtm::IRtmEventHandler::onLoginResult callback.

    Parameters

    • token: string

    Returns number

    • 0: Success.
    • < 0: Failure.

Abstract logout

  • Logout the Agora RTM service. Be noticed that this method will break the rtm service including storage/lock/presence.

    Returns number

    • 0: Success.
    • < 0: Failure.

Abstract publish

  • Publish a message in the channel.

    Parameters

    • channelName: string
    • message: any
    • length: number
    • option: PublishOptions

    Returns number

    • 0: Success.
    • < 0: Failure.

Abstract release

Abstract renewToken

  • Renews the token. Once a token is enabled and used, it expires after a certain period of time. You should generate a new token on your server, call this method to renew it.

    Parameters

    • token: string

    Returns number

Abstract setParameters

  • Set parameters of the sdk or engine

    Parameters

    • parameters: string

    Returns number

    • 0: Success.
    • < 0: Failure.

Abstract subscribe

Abstract unsubscribe

  • Unsubscribe a channel.

    Parameters

    • channelName: string

    Returns number

    • 0: Success.
    • < 0: Failure.

Settings

Member Visibility

Theme

On This Page