|
Agora RTC Objective-C API Reference
Refactor
|
Public Member Functions | |
| virtual int | setEventHandler (IChannelEventHandler *eventHandler, aosl_ref_t ares=AOSL_REF_INVALID)=0 |
| virtual int | join (aosl_ref_t ares=AOSL_REF_INVALID)=0 |
| virtual int | leave (aosl_ref_t ares=AOSL_REF_INVALID)=0 |
| virtual int | sendMessage (const IMessage *message, aosl_ref_t ares=AOSL_REF_INVALID)=0 |
| virtual int | updateAttributes (IChannelAttributes *attributes, int64_t &requestId, aosl_ref_t ares=AOSL_REF_INVALID)=0 |
| virtual int | deleteAttributes (IChannelAttributes *attributes, int64_t &requestId, aosl_ref_t ares=AOSL_REF_INVALID)=0 |
| virtual const char * | getId () const =0 |
| virtual int | release ()=0 |
The IChannel class.
|
pure virtual |
Sets an event handler for IChannel.
| eventHandler | The pointer to the event handler of IChannel: IChannelEventHandler. |
|
pure virtual |
Joins the current channel.
A successful method call triggers either onJoinSuccess() or onJoinFailure() on the local client, to report the state of joining the channel.
|
pure virtual |
Leaves the current channel.
After the local user successfully leaves the channel, the SDK triggers the onLeave() on the local client.
|
pure virtual |
Sends a channel message.
After you successfully send a channel message, all members in the channel receive the message in the onMessageReceived() callback.
| message | The pointer to the channel message that you want to send: IMessage. |
|
pure virtual |
Updates the channel attributes.
A successful method call triggers the onUpdateAttributesResponse() callback on the local client.
| attributes | The pointer to the channel attributes that you want to update: IChannelAttributes. |
| requestId | ID of the current update request. |
|
pure virtual |
Removes the channel attributes.
A successful method call triggers the onDeleteAttributesResponse() callback on the local client.
| attributes | The pointer to the channel attributes that you want to remove: IChannelAttributes. |
| requestId | ID of the current delete request. |
|
pure virtual |
Gets the current request ID.