API to Start Library UI

Use the API for respective platforms to launch the Volt MX Iris Library from the Native app. This feature is available from V8 SP3 onwards. The Start Library API is available for Android, iOS, and Windows platforms.

Note: Calling this API from the Native app will internally call the appService callback of the Volt MX Iris Application.

Android

You must use this API to launch the library UI. This API must be called after the library is successfully initialized.

Note: You must call the Initialize Library API before using the Start Library API; otherwise, this method throws an exception.

Note: Avoid passing null to mandatory parameters as that results in an exception.

Package

com.voltmx.library

Class

VoltMXLibrary

Syntax

public static void start(String libraryId,  
       android.app.Activity activity,  
       Hashtable<String,Object> libraryArgs,  
       Hashtable<String,Object> libraryConfig,  
       VoltMXLibrary.OnLibraryResultListener resultListener)throws Exception

Input Parameters

Example

try {
    VoltMXLibrary.start( < libraryId > , < activity > , < libraryArgs > , null, < resultListener > );
} catch (Exception ex) {}

OnLibraryResultListener Interface

Package

com.voltmx.library

Class

VoltMXLibrary

Syntax

public static interface OnLibraryResultListener

Methods

onLibraryResult

abstract void onLibraryResult(String libraryId, Hashtable<String,Object> resultData)

Parameters

Parameter	Description
libraryId	Specifies the library for which the acknowledgment (result) is sent.
resultData	Specifies the result data in the form of key-value pairs.> Note: The library should publish the keys of resultData to let the Native app handle the resultData.

iOS

You must use this API to launch the library UI. This API must be called after the library is successfully initialized.

Note: You must call the Initialize Library API before using the Start Library API; otherwise, this method throws an exception.

Note: Avoid passing null to mandatory parameters as that results in an exception.

Import

<CoreComponent/VoltMXLibrary.h>

Class

VoltMXLibrary

Method

+ start : viewController: libraryArgs : libraryConfig: delegate:

Declaration

\+ (void) start:(NSString *)libraryId  
         viewController:(UIViewController*) viewController  
         libraryArgs:(NSDictionary*) libraryArgs  
         libraryConfig:(NSDictionary*) libraryConfig  
         delegate:(id<VoltMXLibraryResultDelegate>) resultDelegate

Input Parameters

[VoltMXLibrary start:<libraryId> viewController:<viewController> libraryArgs:<libraryArgs>  
libraryConfig:<libraryConfig> delegate:<resultDelegate>];

Protocol : VoltMXLibraryResultDelegate

Import

<CoreComponent/VoltMXLibrary.h>

Class

VoltMXLibrary

Method

(void)onLibraryResult: resultData:

Declaration

(void) onLibraryResult: (NSString * ) libraryId resultData: (NSDictionary * ) resultData

Parameters

Windows

You must use this API to launch the library UI. This API must be called after the library is successfully initialized.

Note: You must call the Initialize Library API before using the Start Library API; otherwise, this method throws an exception.

Note: Avoid passing null to mandatory parameters as that results in an exception.

Package

Framework

Class

VoltMXLibrary

Syntax

public static void Start(string libraryId,
       Dictionary<string, Object> libraryArgs,
       Dictionary<string, Object> libraryConfig,
       ILibraryResultListener resultListener)

Parameters

Note: The resultListener methods are called from the main/ UI thread.

ILibraryResultListener Interface

Package

Framework

Syntax

public interface ILibraryResultListener

Methods

OnLibraryResult

void  OnLibraryResult(String libraryId, Dictionary <string, Object> resultData)

Parameters