A common interface for chat or video services.
More...
#include <ZoomCCInterface.h>
|
(void) | - initializeWithItem: |
| Initializes the service. @Discussion After we get the service by method "[[ZoomCCInterface sharedInstance] chatService]" or method" [[ZoomCCInterface sharedInstance] videoService]", we should call method "initializeWithItem:" once to initialize the service. The method "initializeWithItem:" creates an internal instance to communicate with server. For the video calls, this method also initializes the ZoomVideoSDK. For chats, after this method been called, the service is prepared to start to communicate with server. We then call the method "login" to start the request to server at a flexible time when needed.
|
|
(void) | - uninitialize |
| Used to uninitialize service @discussion After the method is called, the service's instance is released. Call this method when you do not need to use ZoomCCChatService or ZoomCCVideoService service.
|
|
(BOOL) | - login |
| When calling method "initializeWithItem:", call this method to request to login to server.
|
|
(BOOL) | - logout |
| When done using the service, call this method to disconnect from the server.
|
|
(void) | - fetchUI: |
| Gets the UIViewcontroller instance of the service, which is then used to customize the display.
|
|
|
ZoomCCItem * | item |
| Retrieves information about the service.
|
|
ZoomCCSDKStatus | status |
| Retrieves the current service status.
|
|
BOOL | inEngagement |
| Retrieves the service's current engagement status.
|
|
NSString * | engagementId |
| Retrieves the service's engagement ID.
|
|
A common interface for chat or video services.
◆ fetchUI:
- (void) fetchUI: |
|
(ZoomCCFetchUIBlock) | complete |
|
Gets the UIViewcontroller instance of the service, which is then used to customize the display.
- Note
- This view controller only supports push operations.
- Parameters
-
complete | A callback block that is called after the current service creates the view controller. |
◆ initializeWithItem:
Initializes the service. @Discussion After we get the service by method "[[ZoomCCInterface sharedInstance] chatService]" or method" [[ZoomCCInterface sharedInstance] videoService]", we should call method "initializeWithItem:" once to initialize the service. The method "initializeWithItem:" creates an internal instance to communicate with server. For the video calls, this method also initializes the ZoomVideoSDK. For chats, after this method been called, the service is prepared to start to communicate with server. We then call the method "login" to start the request to server at a flexible time when needed.
- Parameters
-
item | the item that initializes the service. Both properties of sdkType and entryId must be set properly. |
◆ login
When calling method "initializeWithItem:", call this method to request to login to server.
- Note
- For the ZoomCCChatService service, call this method before we call the "fetchUI:" method. For the ZoomCCVideoService service, directly call method "fetchUI:" because method "login" will be called internally.
- Returns
- Yes if successful; NO if unsuccessful.
◆ logout
When done using the service, call this method to disconnect from the server.
- Note
- For ZoomCCChatService service, call this method to disconnect from the sever. For the ZoomCCVideoService service, this method is called internally when video views disappear.
- Returns
- Yes if successful; NO if unsuccessful.
The documentation for this protocol was generated from the following file: