<ZoomCCServiceDelegate> Protocol Reference

An interface to listen to common callback methods, including chat and video. More...

#include <ZoomCCInterface.h>

Inheritance diagram for <ZoomCCServiceDelegate>:

Instance Methods
(void)	- onService:error:detail:
	Callback: Invoked when errors occur.
(void)	- onService:error:detail:description:
	Callback: Invoked when errors occur.
(void)	- onService:engagementStart:
	Callback: Invoked when the service creates an engagement.
(void)	- onService:engagementEnd:
	Callback: Invoked when the engagement ends.
(void)	- onService:eventChange:
	Callback: Invoked when a change has occurred, such as a change made by user action.
(void)	- onService:engagementVariablesRequired:
	Callback: Invoked after login when the engagement's application variables are known.
(void)	- onService:loginStatusChanged:
	Callback: Invoked when the login status changes.

Detailed Description

An interface to listen to common callback methods, including chat and video.

Method Documentation

onService:engagementEnd:

- (void) onService: (id< ZoomCCService >) service engagementEnd: (NSString *) engagementId

optionalrequired

Callback: Invoked when the engagement ends.

Parameters

service	The current service.
engagementId	The engagement identifier.

onService:engagementStart:

- (void) onService: (id< ZoomCCService >) service engagementStart: (NSString *) engagementId

optionalrequired

Callback: Invoked when the service creates an engagement.

Parameters

service	The current service.
engagementId	The engagement identifier.

onService:engagementVariablesRequired:

- (void) onService: (id< ZoomCCService >) service engagementVariablesRequired: (NSArray< NSDictionary< NSString *, NSString * > * > *) variables

optionalrequired

Callback: Invoked after login when the engagement's application variables are known.

Parameters

service	The current service.
variables	An array of dictionaries describing variables that the current engagement may require. Each dictionary can contain variableGroupName, variableName, and attributeName.

onService:error:detail:

- (void) onService: (id< ZoomCCService >) service error: (NSUInteger) error detail: ((deprecated("This method is deprecated. Use onService:error:detail:description: to replace this"))) __attribute__

optional

Callback: Invoked when errors occur.

Parameters

service	The current service.
error	Service error code. See the definition of ZoomCCSDKError in file ZoomCCConstants.h.
detail	The error details.

onService:error:detail:description:

- (void) onService: (id< ZoomCCService >) service error: (NSUInteger) error detail: (NSInteger) detail description: (NSString *_Nullable) description

optionalrequired

Callback: Invoked when errors occur.

Parameters

service	The current service.
error	Service error code. See the definition of ZoomCCSDKError in file ZoomCCConstants.h.
detail	The error details.
description	The error desctiption.

onService:eventChange:

- (void) onService: (id< ZoomCCService >) service eventChange: (ZoomCCSDKEvent) event

optionalrequired

Callback: Invoked when a change has occurred, such as a change made by user action.

Parameters

service	The current service.
event	The event that occurred.

onService:loginStatusChanged:

- (void) onService: (id< ZoomCCService >) service loginStatusChanged: (ZoomCCSDKStatus) status

optionalrequired

Callback: Invoked when the login status changes.

Parameters

service	The current service.
status	The service status. ZoomCCSDKStatus_Login means the logging succeeded.

---

The documentation for this protocol was generated from the following file:

• ZoomCCInterface.h