ZoomSDKPresenceHelper Class Reference

#include <ZoomSDKPresenceHelper.h>

Inherits NSObject.

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

Properties
id< ZoomSDKPresenceHelperDelegate >	delegate

Detailed Description

Definition at line 170 of file ZoomSDKPresenceHelper.h.

Method Documentation

addStarContact:

- (ZoomSDKError) addStarContact:

(NSString *)

contactID

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

Parameters

contactID

The contact ID.

Returns

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

inviteContact:

- (ZoomSDKError) inviteContact:

(NSString *)

contactID

Send an invitation to a contact to join a meeting.

Parameters

contactID

The contact ID.

Returns

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

inviteContactList:

- (ZoomSDKError) inviteContactList:

(NSArray< NSString * > *)

contactIDList

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

Parameters

contactsIDList

A list which contains contactsID of the specified user.

Returns

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

requestContactDetailInfo:

- (ZoomSDKError) requestContactDetailInfo:

(NSArray< NSString * > *)

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, it will return ZoomSDKError_success, otherwise not.

requestStarContact

- (ZoomSDKError) requestStarContact

Send a request to get the starred contact IDs.

Returns

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

subscribeContactPresence:

- (ZoomSDKError) subscribeContactPresence:

(NSArray< NSString * > *)

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, it will return ZoomSDKError_success, otherwise not.

unStarContact:

- (ZoomSDKError) unStarContact:

(NSString *)

contactID

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

Parameters

contactID

The contact ID.

Returns

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

unSubscribeContactPresence:

- (ZoomSDKError) unSubscribeContactPresence:

(NSArray< NSString * > *)

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, it will return ZoomSDKError_success, otherwise not.

Property Documentation

delegate

- (id<ZoomSDKPresenceHelperDelegate>) delegate

readwritenonatomicassign

Definition at line 172 of file ZoomSDKPresenceHelper.h.