Agora Java API Reference for Android
Public Member Functions | Static Public Member Functions | Protected Member Functions | List of all members
io.agora.rtm2.RtmClient Class Referenceabstract

Public Member Functions

abstract int initialize (RtmConfig config)
 
abstract StreamChannel createStreamChannel (@NonNull String channelName)
 

Static Public Member Functions

static synchronized RtmClient create () throws RuntimeException
 
static synchronized void release ()
 

Protected Member Functions

abstract int releaseClient ()
 

Detailed Description

The RtmClient class.

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

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

Member Function Documentation

◆ create()

static synchronized RtmClient io.agora.rtm2.RtmClient.create ( ) throws RuntimeException
static

create rtm client instance.

Returns
  • The RtmClient instance, if the method call succeeds.
  • null, if the method call fails.

◆ release()

static synchronized void io.agora.rtm2.RtmClient.release ( )
static

Release the rtm client instance.

◆ initialize()

abstract int io.agora.rtm2.RtmClient.initialize ( RtmConfig  config)
abstract

Initializes the rtm client instance.

Parameters
[in]configThe configurations for RTM Client.
Returns
  • 0: Success.
  • < 0: Failure.

◆ createStreamChannel()

abstract StreamChannel io.agora.rtm2.RtmClient.createStreamChannel ( @NonNull String  channelName)
abstract

Create a stream channel instance.

Parameters
[in]channelNameThe Name of the channel.