com.smartdevicelink.proxy.rpc

Class AppInfo

java.lang.Object

com.smartdevicelink.proxy.RPCStruct

com.smartdevicelink.proxy.rpc.AppInfo

All Implemented Interfaces:

Cloneable

public class AppInfo
extends RPCStruct

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}

Since:

SmartDeviceLink 4.2.0

Field Summary

Fields

Modifier and Type	Field and Description
static String	KEY_APP_BUNDLE_ID
static String	KEY_APP_DISPLAY_NAME
static String	KEY_APP_ICON
static String	KEY_APP_VERSION

Fields inherited from class com.smartdevicelink.proxy.RPCStruct

KEY_BULK_DATA, KEY_PROTECTED, store

Constructor Summary

Constructors

Constructor and Description
AppInfo() Constructs a new AppInfo object
AppInfo(Hashtable<String,Object> hash) Constructs a new AppInfo object indicated by the Hashtable parameter
AppInfo(String appDisplayName, String appBundleID, String appVersion) Constructs a new AppInfo object

Method Summary

Modifier and Type	Method and Description
String	getAppBundleID() Gets package name of the Android application.
String	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).
String	getAppIcon() Gets build version number of this particular mobile app.
String	getAppVersion() Gets build version number of this particular mobile app.
AppInfo	setAppBundleID(String appBundleID) Sets package name of the Android application.
AppInfo	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).
AppInfo	setAppIcon(String appIcon) Sets file reference to the icon utilized by this app (simplifies the process of setting an app icon during app registration).
AppInfo	setAppVersion(String appVersion) Sets build version number of this particular mobile app.

Methods inherited from class com.smartdevicelink.proxy.RPCStruct

clone, deserializeJSON, equals, format, formatObject, getBoolean, getBulkData, getDouble, getFloat, getInteger, getLong, getMessageTypeName, getObject, getStore, getStoreValue, getString, getValue, getValueForString, hashCode, hasKey, isPayloadProtected, serializeJSON, serializeJSON, setBulkData, setPayloadProtected, setValue

Methods inherited from class java.lang.Object

finalize, getClass, notify, notifyAll, toString, wait, wait, wait

Field Detail

KEY_APP_DISPLAY_NAME

public static final String KEY_APP_DISPLAY_NAME

See Also:

Constant Field Values

KEY_APP_BUNDLE_ID

public static final String KEY_APP_BUNDLE_ID

See Also:

Constant Field Values

KEY_APP_VERSION

public static final String KEY_APP_VERSION

See Also:

Constant Field Values

KEY_APP_ICON

public static final String KEY_APP_ICON

See Also:

Constant Field Values

Constructor Detail

AppInfo

public AppInfo()

Constructs a new AppInfo object

AppInfo

public AppInfo(Hashtable<String,Object> hash)

Constructs a new AppInfo object indicated by the Hashtable parameter

Parameters:

hash - The Hashtable to use

AppInfo

public AppInfo(@NonNull
               String appDisplayName,
               String appBundleID,
               String appVersion)

Constructs a new AppInfo object

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.

Method Detail

setAppDisplayName

public AppInfo setAppDisplayName(@NonNull
                                 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).

Parameters:

appDisplayName - - name displayed for the mobile application on the mobile device.

getAppDisplayName

public String 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).

Returns:

appDisplayName - name displayed for the mobile application on the mobile device.

setAppBundleID

public AppInfo setAppBundleID(@NonNull
                              String appBundleID)

Sets package name of the Android application. This supports App Launch strategies for each platform.

Parameters:

appBundleID - - package name of the application

getAppBundleID

public String getAppBundleID()

Gets package name of the Android application. This supports App Launch strategies for each platform.

Returns:

appBundleID - package name of the application.

setAppVersion

public AppInfo setAppVersion(@NonNull
                             String appVersion)

Sets build version number of this particular mobile app.

Parameters:

appVersion - - build version number of this particular mobile app.

getAppVersion

public String getAppVersion()

Gets build version number of this particular mobile app.

Returns:

appVersion - build version number of this particular mobile app.

setAppIcon

public AppInfo setAppIcon(String appIcon)

Sets file reference to the icon utilized by this app (simplifies the process of setting an app icon during app registration).

Parameters:

appIcon - - file reference to the icon utilized by this app

getAppIcon

public String getAppIcon()

Gets build version number of this particular mobile app.

Returns:

appIcon - build version number of this particular mobile app.