Mac SDK API
Instance Methods | Class Methods | Protected Attributes | Properties | List of all members
ZoomSDK Class Reference
Inheritance diagram for ZoomSDK:

Instance Methods

(void) - initSDK:
 This method is used to initialize Zoom SDK. More...
 
(void) - setZoomDomain:
 Set client domain of ZOOM SDK. More...
 
(ZoomSDKAuthService *) - getAuthService
 Get the default authentication service. More...
 
(ZoomSDKMeetingService *) - getMeetingService
 Get the default meeting service.
More...
 
(ZoomSDKSettingService *) - getSettingService
 Get the default meeting service.
More...
 
(ZoomSDKPremeetingService *) - getPremeetingService
 Get the default pre-meeting service. More...
 
(ZoomSDKNetworkService *) - getNetworkService
 Get the default Network service.
More...
 
(NSString *) - getSDKVersionNumber
 Get the serial number of SDK version. More...
 
(NSArray *) - getLanguageArray
 Get the languages supported by the SDK. More...
 
(ZoomSDKError) - setPreferLanguage:
 Set the language of the App. More...
 
(void) - enableDefaultLog:
 Set whether to enable default log of which the capacity is less than 5M. More...
 
(void) - enableDefaultLog:fileSize:
 
(void) - setCustomLocalizationFileName:
 Set custom localizable string file name. More...
 
(void) - setAppLocale:
 Set the locale of the App. More...
 

Class Methods

(ZoomSDK *) + sharedSDK
 The sharedSDK will be instantiated only once over the lifespan of the application. Configure the client with the specified key and secret. More...
 

Protected Attributes

NSString * _zoomDomain
 
ZoomSDKMeetingService_meetingService
 
ZoomSDKAuthService_authService
 
ZoomSDKSettingService_settingService
 
ZoomSDKPremeetingService_premeetingService
 
ZoomSDKNetworkService_networkService
 
NSMutableArray * _languageArray
 
BOOL _needCustomizedUI
 

Properties

NSString * zoomDomain
 
BOOL needCustomizedUI
 

Method Documentation

◆ enableDefaultLog:()

- (void) enableDefaultLog: (4.)  1
(4.3)  NS_DEPRECATED_MAC 

Set whether to enable default log of which the capacity is less than 5M.

Parameters
enableYES mean enabled, NO disabled.
sizeThe size of the log file, the unit is MB. The size of log file is between 1 to 50M.
Note
Call Api firstly before you call [[ZoomSDK sharedSDK]initSDK:NO/YES] in the App.

◆ getAuthService()

- (ZoomSDKAuthService*) getAuthService

Get the default authentication service.

Note
The ZOOM SDK can not be called unless the authentication service is called successfully.
Returns
A preconfigured authentication service.

◆ getLanguageArray()

- (NSArray*) getLanguageArray

Get the languages supported by the SDK.

Returns
The supported languages.

◆ getMeetingService()

- (ZoomSDKMeetingService*) getMeetingService

Get the default meeting service.

Returns
A preconfigured meeting Service

◆ getNetworkService()

- (ZoomSDKNetworkService*) getNetworkService

Get the default Network service.

Returns
An object of Network Service

◆ getPremeetingService()

- (ZoomSDKPremeetingService*) getPremeetingService

Get the default pre-meeting service.

Returns
An object of pre-meeting Service

◆ getSDKVersionNumber()

- (NSString*) getSDKVersionNumber

Get the serial number of SDK version.

Returns
The default serial number of ZOOM SDK version.

◆ getSettingService()

- (ZoomSDKSettingService*) getSettingService

Get the default meeting service.

Returns
An object of setting service.

◆ initSDK:()

- (void) initSDK: (BOOL)  customizedFlag

This method is used to initialize Zoom SDK.

Parameters
customizedFlagYES means Custom UI, No ZOOM original UI.

◆ setAppLocale:()

- (void) setAppLocale: (ZoomSDKLocale)  locale

Set the locale of the App.

Parameters
localeThe locale you want set for the App.
Note
You should call the method before calling [[ZoomSDK sharedSDK]initSDK:NO/YES] in the App.

◆ setCustomLocalizationFileName:()

- (void) setCustomLocalizationFileName: (NSString *)  fileName

Set custom localizable string file name.

Parameters
fileNameSpecify the localizable string file name.

◆ setPreferLanguage:()

- (ZoomSDKError) setPreferLanguage: (NSString *)  preferLanguage

Set the language of the App.

Parameters
preferLanguageUsually if user does not specify the language, it will follow up the systematical language of the device.
Returns
If the function succeeds, it will return ZoomSDKError_Success, otherwise failed.
Note
You should call the method before calling [[ZoomSDK sharedSDK]initSDK:NO/YES] in the App, or no, you should restart the App once you reset the preferred Language.

◆ setZoomDomain:()

- (void) setZoomDomain: (NSString *)  domain

Set client domain of ZOOM SDK.

Note
The format of domain should like "zoom.us" or "www.zoom.us", please do not add the protocol "http" or "https".
Parameters
domainA domain for starting/joining ZOOM meeting.

◆ sharedSDK()

+ (ZoomSDK*) sharedSDK

The sharedSDK will be instantiated only once over the lifespan of the application. Configure the client with the specified key and secret.

Note
Configure the client with the specified key and secret.
Returns
A preconfigured ZOOM SDK client.

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