SDK Object Initialization
Before beginning any operation, you must first create an instance of the RUISDKOBJC object. This is done using the initRegisterDefaultGraphicalReachOutHandler:registerHandler method.
initRegisterDefaultGraphicalReachOutHandler
(RUISDKOBJC) initRegisterDefaultGraphicalReachOutHandler: (BOOL)registerHandler
Constructor
initRegisterDefaultGraphicalReachOutHandler creates an instance of the SDK. Constructor must be paired with call to destructor when the client application is done using the RUI SDK. The constructor does not configure the RUI SDK (createConfig:productID:appName:serverURL:protocol:aesKeyHex:multiSessionEnabled:reachOutOnAutoSync:) nor start the RUI SDK (startSDK).
A typical client will create only a single instance of the RUI SDK. Creating more than one RUI SDK instance is allowed and is used to support clients that are plug-ins or other scenarios whereby multiple independent clients may co-exist in the same executable. Multiple RUI SDK instances perform independently of one another with the potential exception of shared or unshared configuration file (createConfig:productID:appName:serverURL:protocol:aesKeyHex:multiSessionEnabled:reachOutOnAutoSync:).
The constructor is a synchronous function, returning when all functionality is completed.
Parameters
The initRegisterDefaultGraphicalReachOutHandler function has the following parameters.
|
Parameter |
Description |
|
registerHandler (BOOL) |
On platforms that contain a RUI SDK default graphical ReachOut handler, automatically register that handler via setReachOutHandler:(). This is currently only Windows and macOS. |
Return Type
The instantiated object, or null if there is a problem constructing the SDK instance.