MobileRTCPresenceHelper Class Reference

Interface to manage contact presence and meeting invitations. More...

#include <MobileRTCPresenceHelper.h>

Inherits NSObject.

Instance Methods
(MobileRTCSDKError)	- requestStarContact
	Send a request to get the starred contact IDs.
(MobileRTCSDKError)	- starContact:
	Send a request to add the contact into a starred contact list.
(MobileRTCSDKError)	- unStarContact:
	Send a request to remove a contact from the starred contact list.
(MobileRTCSDKError)	- inviteContact:
	Send an invitation to a contact to join a meeting.
(MobileRTCSDKError)	- inviteContactList:
	Batch invite a list of specified contact to the current meeting.
(MobileRTCSDKError)	- requestContactDetailInfo:
	Send a request for contact detail information according to the contact id list.
(MobileRTCSDKError)	- subscribeContactPresence:
	Send a request to subscribe contact presence status according to the contact id list.
(MobileRTCSDKError)	- unSubscribeContactPresence:
	Send a request to unsubscribe contact presence status according to the contact id list.

Properties
id< MobileRTCPresenceHelperDelegate >	delegate
	The delegate for presence helper's event handler.

Detailed Description

Interface to manage contact presence and meeting invitations.

Definition at line 182 of file MobileRTCPresenceHelper.h.

Method Documentation

inviteContact:

- (MobileRTCSDKError) inviteContact:

(NSString *_Nonnull)

contactID

Send an invitation to a contact to join a meeting.

Parameters

contactID

The contact ID.

Returns

If the function succeeds, the return value is MobileRTCSDKError_Success. Otherwise failed. To get extended error information, see [MobileRTCSDKError].

inviteContactList:

- (MobileRTCSDKError) inviteContactList:

(NSArray< NSString * > *_Nonnull)

contactIDList

Batch invite a list of specified contact to the current meeting.

Parameters

contactIDList

A list which contains contactsID of the specified user.

Returns

If the function succeeds, it will return MobileRTCSDKError_Success, otherwise not.

requestContactDetailInfo:

- (MobileRTCSDKError) requestContactDetailInfo:

(NSArray< NSString * > *_Nonnull)

contactIDList

Send a request for contact detail information according to the contact id list.

Parameters

contactIDList

The contact id list.

Returns

If the function succeeds, the return value is MobileRTCSDKError_Success. Otherwise failed. To get extended error information, see [MobileRTCSDKError].

requestStarContact

- (MobileRTCSDKError) requestStarContact

Send a request to get the starred contact IDs.

Returns

If the function succeeds, the return value is MobileRTCSDKError_Success. Otherwise failed. To get extended error information, see [MobileRTCSDKError].

starContact:

- (MobileRTCSDKError) starContact:

(NSString *_Nonnull)

contactID

Send a request to add the contact into a starred contact list.

Parameters

contactID

The contact ID.

Returns

If the function succeeds, the return value is MobileRTCSDKError_Success. Otherwise failed. To get extended error information, see [MobileRTCSDKError].

subscribeContactPresence:

- (MobileRTCSDKError) subscribeContactPresence:

(NSArray< NSString * > *_Nonnull)

contactIDList

Send a request to subscribe contact presence status according to the contact id list.

Parameters

contactIDList

The contact id list.

Returns

If the function succeeds, the return value is MobileRTCSDKError_Success. Otherwise failed. To get extended error information, see [MobileRTCSDKError].

unStarContact:

- (MobileRTCSDKError) unStarContact:

(NSString *_Nonnull)

contactID

Send a request to remove a contact from the starred contact list.

Parameters

contactID

The contact ID.

Returns

If the function succeeds, the return value is MobileRTCSDKError_Success. Otherwise failed. To get extended error information, see [MobileRTCSDKError].

unSubscribeContactPresence:

- (MobileRTCSDKError) unSubscribeContactPresence:

(NSArray< NSString * > *_Nonnull)

contactIDList

Send a request to unsubscribe contact presence status according to the contact id list.

Parameters

contactIDList

The contact id list.

Returns

If the function succeeds, the return value is MobileRTCSDKError_Success. Otherwise failed. To get extended error information, see [MobileRTCSDKError].

Property Documentation

delegate

- (id<MobileRTCPresenceHelperDelegate>) delegate

readwritenonatomicassign

The delegate for presence helper's event handler.

Definition at line 187 of file MobileRTCPresenceHelper.h.