Constructor Detail

Method Detail

• getApplicationBaseDir

   abstract File getApplicationBaseDir()

  Returns the directory which can be used as a application data directory.

• getLocaleString

   abstract String getLocaleString()

  Returns active locale's value in string format. The default value is en-US

• getDefaultUserAgent

   abstract String getDefaultUserAgent()

  Returns the default platform/device user agent value

• getApplicationCacheDir

   abstract File getApplicationCacheDir()

  Returns the application specific cache directory. The application will be able to read and write to the directory, but there is no guarantee made as to the persistence of the data (it may be deleted by the system when storage is required).

• getAsset

   abstract InputStream getAsset(String fileName)

  Open the requested asset returns an InputStream to read its contents.

  Parameters:

  fileName - asset's name which is to be retrieved

• getPropertyFromManifest

   abstract String getPropertyFromManifest(String resourceKey)

  Returns the property value specific to the key from the manifest file.

  Parameters:

  resourceKey - resource key

• getApplicationName

   abstract String getApplicationName()

  Returns the application name.

• getApplicationPackageName

   abstract String getApplicationPackageName()

  Returns the application package name.

• getApplicationVersion

   abstract String getApplicationVersion()

  Returns the application version.

• getApplicationVersionCode

   abstract String getApplicationVersionCode()

  Returns the application version code as a string.

• getActiveLocale

   abstract Locale getActiveLocale()

  Returns the currently selected / active locale value with respect to the application context.

• getSystemLocale

   abstract Locale getSystemLocale()

  Returns the currently selected / active locale value on the device settings as set by the user.

• getDisplayInformation

   abstract DeviceInforming.DisplayInformation getDisplayInformation()

  Returns information about the display hardware, as returned by the underlying OS.

• getCurrentOrientation

   abstract int getCurrentOrientation()

  Returns the current screen orientation

• getOperatingSystemName

   abstract String getOperatingSystemName()

  Returns the string representation of the operating system name.

• getCanonicalPlatformName

   abstract String getCanonicalPlatformName()

  Returns the string representation of the canonical platform name.

• getOperatingSystemVersion

   abstract String getOperatingSystemVersion()

  Returns the string representation of the operating system version.

• getDeviceBrand

   abstract String getDeviceBrand()

  Returns the device brand.

• getDeviceManufacturer

   abstract String getDeviceManufacturer()

  The device manufacturer's name.

• getDeviceName

   abstract String getDeviceName()

  Returns the device name.

• getDevice

   abstract String getDevice()

  Returns name of the industrial design for the device

• getDeviceType

   abstract DeviceInforming.DeviceType getDeviceType()

  Returns the device type.

  • If PHONE, for a Phone type device
  • If TABLET, for a Tablet type device
  • If WATCH, for a Watch type device
  • If UNKNOWN, when device type cannot be determined

• getDeviceBuildId

   abstract String getDeviceBuildId()

  Returns a string that identifies a particular device OS build. This value may be present on Android devices, with a value like "M4-rc20". The value is platform dependent and platform specific.

• getMobileCarrierName

   abstract String getMobileCarrierName()

  Returns the device's mobile carrier name.

• getNetworkConnectionStatus

   abstract DeviceInforming.ConnectionStatus getNetworkConnectionStatus()

  Indicates whether network connectivity exists and it is possible to establish connections and pass data.

  Always call this before attempting to perform data transactions.

  • If CONNECTED, if we have network connectivity.
  • If DISCONNECTED, if do not have network connectivity.
  • If UNKNOWN, if unable to determine the network connectivity.

• registerOneTimeNetworkConnectionActiveListener

   abstract boolean registerOneTimeNetworkConnectionActiveListener(DeviceInforming.NetworkConnectionActiveListener listener)

  Invokes a callback when the network connection status changes.

  Parameters:

  listener - DeviceInforming.NetworkConnectionActiveListener listener that will get invoked once when the connection status changes.

• getRunMode

   abstract String getRunMode()

  Returns a string that identifies the SDK running mode, e.g. Application, Extension.

• getDeviceUniqueId

   abstract String getDeviceUniqueId()

  Get unique identifier for device.