MobileRTCPresenceHelper Class Reference

A class to manage contact presence and meeting invitations. More...

#include <MobileRTCPresenceHelper.h>

Inherits NSObject.

Instance Methods
(MobileRTCSDKError)	- requestStarContact
	Sends a request to get the starred contact IDs.
(MobileRTCSDKError)	- starContact:
	Sends a request to add the contact into a starred contact list.
(MobileRTCSDKError)	- unStarContact:
	Sends a request to remove a contact from the starred contact list.
(MobileRTCSDKError)	- inviteContact:
	Sends an invitation to a contact to join a meeting.
(MobileRTCSDKError)	- inviteContactList:
	Batch invites a list of specified contacts to the current meeting.
(MobileRTCSDKError)	- requestContactDetailInfo:
	Sends a request for contact detail information according to the contact ID list.
(MobileRTCSDKError)	- subscribeContactPresence:
	Sends a request to subscribe contact presence status according to the contact ID list.
(MobileRTCSDKError)	- unSubscribeContactPresence:
	Sends 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

A class to manage contact presence and meeting invitations.

Definition at line 198 of file MobileRTCPresenceHelper.h.

Method Documentation

inviteContact:

- (MobileRTCSDKError) inviteContact:

(NSString *_Nonnull)

contactID

Sends an invitation to a contact to join a meeting.

Parameters

contactID

The contact ID.

Returns

If the function succeeds, it returns MobileRTCSDKError_Success. Otherwise, this function returns an error.

inviteContactList:

- (MobileRTCSDKError) inviteContactList:

(NSArray< NSString * > *_Nonnull)

contactIDList

Batch invites a list of specified contacts to the current meeting.

Parameters

contactIDList

A list which contains contact IDs of the specified users.

Returns

If the function succeeds, it returns MobileRTCSDKError_Success. Otherwise, this function returns an error.

requestContactDetailInfo:

- (MobileRTCSDKError) requestContactDetailInfo:

(NSArray< NSString * > *_Nonnull)

contactIDList

Sends a request for contact detail information according to the contact ID list.

Parameters

contactIDList

The contact ID list.

Returns

If the function succeeds, it returns MobileRTCSDKError_Success. Otherwise, this function returns an error.

requestStarContact

- (MobileRTCSDKError) requestStarContact

Sends a request to get the starred contact IDs.

Returns

If the function succeeds, it returns MobileRTCSDKError_Success. Otherwise, this function returns an error.

starContact:

- (MobileRTCSDKError) starContact:

(NSString *_Nonnull)

contactID

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

Parameters

contactID

The contact ID.

Returns

If the function succeeds, it returns MobileRTCSDKError_Success. Otherwise, this function returns an error.

subscribeContactPresence:

- (MobileRTCSDKError) subscribeContactPresence:

(NSArray< NSString * > *_Nonnull)

contactIDList

Sends a request to subscribe contact presence status according to the contact ID list.

Parameters

contactIDList

The contact ID list.

Returns

If the function succeeds, it returns MobileRTCSDKError_Success. Otherwise, this function returns an error.

unStarContact:

- (MobileRTCSDKError) unStarContact:

(NSString *_Nonnull)

contactID

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

Parameters

contactID

The contact ID.

Returns

If the function succeeds, it returns MobileRTCSDKError_Success. Otherwise, this function returns an error.

unSubscribeContactPresence:

- (MobileRTCSDKError) unSubscribeContactPresence:

(NSArray< NSString * > *_Nonnull)

contactIDList

Sends a request to unsubscribe contact presence status according to the contact ID list.

Parameters

contactIDList

The contact ID list.

Returns

If the function succeeds, it returns MobileRTCSDKError_Success. Otherwise, this function returns an error.

Property Documentation

delegate

- (id<MobileRTCPresenceHelperDelegate>) delegate

readwritenonatomicassign

The delegate for presence helper's event handler.

Definition at line 203 of file MobileRTCPresenceHelper.h.