Contact Center SDK for iOS API reference
Loading...
Searching...
No Matches
Instance Methods | List of all members
<ZoomCCServiceDelegate> Protocol Reference

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

#include <ZoomCCInterface.h>

Inheritance diagram for <ZoomCCServiceDelegate>:
<ZoomCCChatServiceDelegate>

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: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
serviceThe current service.
engagementIdThe engagement identifier.

◆ onService:engagementStart:

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

Callback: Invoked when the service creates an engagement.

Parameters
serviceThe current service.
engagementIdThe engagement identifier.

◆ 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
serviceThe current service.
errorService error code. See the definition of ZoomCCSDKError in file ZoomCCConstants.h.
detailThe 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
serviceThe current service.
errorService error code. See the definition of ZoomCCSDKError in file ZoomCCConstants.h.
detailThe error details.
descriptionThe 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
serviceThe current service.
eventThe event that occurred.

◆ onService:loginStatusChanged:

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

Callback: Invoked when the login status changes.

Parameters
serviceThe current service.
statusThe service status. ZoomCCSDKStatus_Login means the logging succeeded.

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