|
Agora Java API Reference for Android
|
#include <IAgoraRtmService.h>
Public Member Functions | |
| virtual int | initialize (const char *appId, IRtmServiceEventHandler *eventHandler)=0 |
| virtual void | unregisterObserver (IRtmServiceEventHandler *eventHandler)=0 |
| virtual int | release (bool sync=false)=0 |
| virtual int | login (const char *token, const char *userId, aosl_ref_t ares=AOSL_REF_INVALID)=0 |
| virtual int | logout (aosl_ref_t ares=AOSL_REF_INVALID)=0 |
| virtual int | sendMessageToPeer (const char *peerId, const IMessage *message, aosl_ref_t ares=AOSL_REF_INVALID)=0 |
| virtual IChannel * | createChannel (const char *channelId, IChannelEventHandler *eventHandler)=0 |
The IRtmService class.
|
pure virtual |
Creates and gets an IRtmService instance.
| appId | The pointer to the app ID. |
| eventHandler | The pointer to the IRtmServiceEventHandler object. |
| eventSpace | The connection specific ID, used during report to argus. |
|
pure virtual |
Releases the IRtmServiceEventHandler object.
| eventHandler | The pointer to the IRtmServiceEventHandler object. |
|
pure virtual |
Releases the IRtmService instance.
| sync | Determines whether to report the result of this method call synchronously.
|
|
pure virtual |
Logs in the RTM service.
| token | The token used to log in the RTM service. |
| userId | ID of the user logging in the RTM service. |
|
pure virtual |
Logs out of the RTM service.
|
pure virtual |
Sends a peer message to a specified remote user.
| peerId | The pointer to the ID of the remote user. |
| message | The pointer to message: IMessage. |
|
pure virtual |
Creates an RTM channel.
| channelId | The unique channel name for an RTM session. Supported character scopes are:
|
| eventHandler | The pointer to IChannelEventHandler. |
1.8.18