ZoomSDKPresenceHelper Class Reference

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

#include <ZoomSDKPresenceHelper.h>

Inherits NSObject.

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

Properties
id< ZoomSDKPresenceHelperDelegate >	delegate
	Delegate to receive presence-related callbacks.

Detailed Description

Interface to manage contact presence and meeting invitations.

Definition at line 197 of file ZoomSDKPresenceHelper.h.

Method Documentation

addStarContact:

- (ZoomSDKError) addStarContact:

(NSString *)

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 ZoomSDKError_success. Otherwise, this function returns an error.

inviteContact:

- (ZoomSDKError) inviteContact:

(NSString *)

contactID

Sends an invitation to a contact to join a meeting.

Parameters

contactID

The contact ID.

Returns

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

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 returns ZoomSDKError_success. Otherwise, this function returns an error.

requestContactDetailInfo:

- (ZoomSDKError) requestContactDetailInfo:

(NSArray< NSString * > *)

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 ZoomSDKError_success. Otherwise, this function returns an error.

requestStarContact

- (ZoomSDKError) requestStarContact

Sends a request to get the starred contact IDs.

Returns

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

subscribeContactPresence:

- (ZoomSDKError) subscribeContactPresence:

(NSArray< NSString * > *)

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 ZoomSDKError_success. Otherwise, this function returns an error.

unStarContact:

- (ZoomSDKError) unStarContact:

(NSString *)

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 ZoomSDKError_success. Otherwise, this function returns an error.

unSubscribeContactPresence:

- (ZoomSDKError) unSubscribeContactPresence:

(NSArray< NSString * > *)

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 ZoomSDKError_success. Otherwise, this function returns an error.

Property Documentation

delegate

- (id<ZoomSDKPresenceHelperDelegate>) delegate

readwritenonatomicassign

Delegate to receive presence-related callbacks.

Definition at line 201 of file ZoomSDKPresenceHelper.h.