com.symbol.emdk

Class EMDKManager

java.lang.Object

com.symbol.emdk.EMDKManager

public class EMDKManager
extends java.lang.Object

The EMDKManager class is the key class in Android EMDK. This class provides access to different classes for the supported features. Clients should call EMDKManager.getEMDKManager(Context, EMDKManager.EMDKListener), to get the EMDKManager object. Each application implements EMDKListener interface. The EMDKManager object will be returned on successful opening through the EMDKListener callback.

 
 	Example Usage:
 	EMDKResults results = EMDKManager.getEMDKManager(getApplicationContext(), emdkListener);
 

When using EMDKManager consider the followings:

1. Developers must implement EMDKListener and wait for onOpened() before making any API call. If making any API calls inside onResume(), check the status of the EMDKManager object first. In some cases, onResume() can be called before the onOpened() callback, and the EMDKManager object can become null.
2. The EMDKManager.release() without an argument specifying the specific feature type (ex: FEATURE_TYPE.BARCODE) releases all the resources bound to underlying features. This API must be called before exiting the application only. Zebra recommends the using onDestroy() callback for this purpose.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	EMDKManager.EMDKListener This is the interface for the callback to notify the opening and closing status of the EMDK.
static class	EMDKManager.FEATURE_TYPE This lists all the features exposed by the EMDK.
class	EMDKManager.StatusData StatusData class provides access to EMDK Manager feature ready to use status.
static interface	EMDKManager.StatusListener This is the interface for the callback to notify the status of the feature object request.

Method Summary

Modifier and Type	Method and Description
static EMDKResults	getEMDKManager(Context context, EMDKManager.EMDKListener emdkListener) This is static method and it is the key function to get the EMDKManager object.
EMDKBase	getInstance(EMDKManager.FEATURE_TYPE featureType) This method returns an object instance which has derived from EMDKBase.
void	getInstanceAsync(EMDKManager.FEATURE_TYPE featureType, EMDKManager.StatusListener statusListener) This method is an asynchronous call and requests object instance for the specified feature type and object is returned through the status listener callback when the feature is initialized and ready to use.
EMDKError	getLastError() This method provides detailed error information related to failures in EMDK.
void	release() This method releases all the resources constructed by EMDKManager.
void	release(EMDKManager.FEATURE_TYPE featureType) This method releases resources of a given manager type.

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

getEMDKManager

public static EMDKResults getEMDKManager(Context context,
                                         EMDKManager.EMDKListener emdkListener)

This is static method and it is the key function to get the EMDKManager object. Clients must implement EMDKManager.EMDKListener to get notified of the EMDK manager status and to get the EMDKManager object.

Parameters:

context - The application context should be provided by the user.

emdkListener - The EMDK Listener for listener callbacks.

Returns:

EMDKResults object.

getInstance

public EMDKBase getInstance(EMDKManager.FEATURE_TYPE featureType)

This method returns an object instance which has derived from EMDKBase. Based on the type given, the object needs to be type-casted before used. Calling this method before EMDKManager opened will return null.

 
 ProfileManager mProfileManager = (ProfileManager) emdkManager.getInstance(EMDKManager.FEATURE_TYPE.PROFILE);
 VersionManager mVersionManager = (VersionManager) emdkManager.getInstance(EMDKManager.FEATURE_TYPE.VERSION);
 

Parameters:

featureType - The EMDKManager.FEATURE_TYPE the object to be created.

Returns:

Object derived from EMDKBase to be type-casted to the appropriate type. Currently ProfileManager and VersionManager are returned based on the EMDKManager.FEATURE_TYPE given in.
ProfileManager mProfileManager = (ProfileManager) emdkManager.getInstance(EMDKManager.FEATURE_TYPE.PROFILE);<br> VersionManager mVersionManager = (VersionManager) emdkManager.getInstance(EMDKManager.FEATURE_TYPE.VERSION);<br>

getInstanceAsync

public void getInstanceAsync(EMDKManager.FEATURE_TYPE featureType,
                             EMDKManager.StatusListener statusListener)
                      throws EMDKException

This method is an asynchronous call and requests object instance for the specified feature type and object is returned through the status listener callback when the feature is initialized and ready to use. Ex:The Profile Manager related components will take few seconds to initialize for it to be used after device booted. If the application tries to use the getInstance(com.symbol.emdk.EMDKManager.FEATURE_TYPE) to get the profile manager object and sets the profile during the device boot will result in error because the underlying Profile manager is not ready.

 
 try {
 
                emdkManager.getInstanceAsync(EMDKManager.FEATURE_TYPE.PROFILE, statusListener);
 
 } catch(EMDKException ex) {
                Log.e(TAG, "" + ex.getMessage());
 }
 

Parameters:

featureType - The EMDKManager.FEATURE_TYPE the object to be created.

statusListener - The callback will returned on EMDKManager.StatusListener when the feature is ready to use.

Throws:

EMDKException - The exception will be thrown when the error occurs during this request.

release

public void release()

This method releases all the resources constructed by EMDKManager. EMDKManager can't be used after this call. The clients must call this method before exiting the application.

 
 	Example Usage:
 	emdkManager.release();
 

release

public void release(EMDKManager.FEATURE_TYPE featureType)

This method releases resources of a given manager type. Instance variable is not required as multiple instances are not allowed by design.

 
 	Example Usage:
 	emdkManager.release(EMDKManager.FEATURE_TYPE.PROFILE);
 

Parameters:

featureType - Type of EMDKManager.FEATURE_TYPE to be released. Only the given feature related manager will be cleared if it has been constructed.

getLastError

public EMDKError getLastError()

This method provides detailed error information related to failures in EMDK. Note: Currently this is applicable to licensed features only.

 
 	Example Usage:
 	EMDKError emdkError = emdkManager.getLastError();
 

Returns:

EMDKError object.