Class AppInfo
Hierarchy
java.lang.Object
com.smartdevicelink.proxy.RPCStruct
- Package
- com.smartdevicelink.proxy.rpc
Overview
Contains detailed information about the registered application.Parameter List
| Param Name | Type | Description | Required | Notes | Version Available |
|---|---|---|---|---|---|
| appDisplayName | String | The name displayed for the mobile application on the mobile device (can differ from the app name set in the initial RAI request). | Y | {"string_min_length": 1, "string_max_length": 100} | |
| appBundleID | String | The AppBundleID of an iOS application or package name of the Android application. This supports App Launch strategies for each platform. | Y | {"string_min_length": 1, "string_max_length": 256} | |
| appVersion | String | Represents the build version number of this particular mobile app. | Y | {"string_min_length": 1, "string_max_length": 256} | |
| appIcon | String | A file reference to the icon utilized by this app (simplifies the process of setting an app icon during app registration). | N | {"string_min_length": 1, "string_max_length": 500} |
Quick Jump
- Fields
- Constructors
- Methods
Fields
KEY_APP_DISPLAY_NAME
public static final java.lang.String KEY_APP_DISPLAY_NAME
- Constant Value
- "appDisplayName"
KEY_APP_BUNDLE_ID
public static final java.lang.String KEY_APP_BUNDLE_ID
- Constant Value
- "appBundleID"
KEY_APP_VERSION
public static final java.lang.String KEY_APP_VERSION
- Constant Value
- "appVersion"
KEY_APP_ICON
public static final java.lang.String KEY_APP_ICON
- Constant Value
- "appIcon"
Inherited Fields
| From Class | Fields |
|---|---|
| com.smartdevicelink.proxy.RPCStruct | KEY_BULK_DATA, KEY_PROTECTED, store |
Constructors
AppInfo()
Constructs a new AppInfo object
public AppInfo()
AppInfo( java.util.Hashtable<java.lang.String, java.lang.Object> hash )
Constructs a new AppInfo object indicated by the Hashtable parameter
public AppInfo(java.util.Hashtable<java.lang.String, java.lang.Object> hash)
Constructor Parameters
- hash
- The Hashtable to use
AppInfo( String appDisplayName, String appBundleID, String appVersion )
Constructs a new AppInfo object
public AppInfo(String appDisplayName,String appBundleID,String appVersion)
Constructor Parameters
- appDisplayName
- - name displayed for the mobile application on the mobile device
- appBundleID
- - package name of the application.
- appVersion
- - build version number of this particular mobile app.
Methods
setAppDisplayName( String appDisplayName )
Sets the name displayed for the mobile application on the mobile device (can differ from the app name set in the initial RAI request).
public com.smartdevicelink.proxy.rpc.AppInfo setAppDisplayName(String appDisplayName)
Method Parameters
- appDisplayName
- - name displayed for the mobile application on the mobile device.
getAppDisplayName()
Gets the name displayed for the mobile application on the mobile device (can differ from the app name set in the initial RAI request).
public java.lang.String getAppDisplayName()
setAppBundleID( String appBundleID )
Sets package name of the Android application. This supports App Launch strategies for each platform.
public com.smartdevicelink.proxy.rpc.AppInfo setAppBundleID(String appBundleID)
Method Parameters
- appBundleID
- - package name of the application
getAppBundleID()
Gets package name of the Android application. This supports App Launch strategies for each platform.
public java.lang.String getAppBundleID()
setAppVersion( String appVersion )
Sets build version number of this particular mobile app.
public com.smartdevicelink.proxy.rpc.AppInfo setAppVersion(String appVersion)
Method Parameters
- appVersion
- - build version number of this particular mobile app.
getAppVersion()
Gets build version number of this particular mobile app.
public java.lang.String getAppVersion()
setAppIcon( String appIcon )
Sets file reference to the icon utilized by this app (simplifies the process of setting an app icon during app registration).
public com.smartdevicelink.proxy.rpc.AppInfo setAppIcon(String appIcon)
Method Parameters
- appIcon
- - file reference to the icon utilized by this app
getAppIcon()
Gets build version number of this particular mobile app.
public java.lang.String getAppIcon()
Inherited Methods
| From Class | Methods |
|---|---|
| com.smartdevicelink.proxy.RPCStruct | getStoreValue, getStore, deserializeJSON, serializeJSON, serializeJSON, format, getBulkData, setBulkData, setPayloadProtected, isPayloadProtected, getMessageTypeName, hasKey, setValue, getValue, getObject, formatObject, getValueForString, getString, getInteger, getDouble, getFloat, getBoolean, getLong, clone, equals, hashCode |
| java.lang.Object | getClass, hashCode, equals, clone, toString, notify, notifyAll, wait, wait, wait, finalize |