com.smartdevicelink.proxy.rpc

Class AppServiceManifest

java.lang.Object

com.smartdevicelink.proxy.RPCStruct

com.smartdevicelink.proxy.rpc.AppServiceManifest

All Implemented Interfaces:

Cloneable

public class AppServiceManifest
extends RPCStruct

This manifest contains all the information necessary for the service to be published, activated, and allow consumers to interact with it

Field Summary

Fields

Modifier and Type	Field and Description
static String	KEY_ALLOW_APP_CONSUMERS
static String	KEY_HANDLED_RPCS
static String	KEY_MEDIA_SERVICE_MANIFEST
static String	KEY_NAVIGATION_SERVICE_MANIFEST
static String	KEY_RPC_SPEC_VERSION
static String	KEY_SERVICE_ICON
static String	KEY_SERVICE_NAME
static String	KEY_SERVICE_TYPE
static String	KEY_WEATHER_SERVICE_MANIFEST

Fields inherited from class com.smartdevicelink.proxy.RPCStruct

KEY_BULK_DATA, KEY_PROTECTED, store

Constructor Summary

Constructors

Constructor and Description
AppServiceManifest()
AppServiceManifest(AppServiceType serviceType) Constructor that takes in the mandatory parameters.
AppServiceManifest(Hashtable<String,Object> hash)
AppServiceManifest(String serviceType) Constructor that takes in the mandatory parameters.

Method Summary

Modifier and Type	Method and Description
Boolean	getAllowAppConsumers() If true, app service consumers beyond the IVI system will be able to access this service.
List<Integer>	getHandledRpcs() This field contains the FunctionID integer ID values for the RPCs that this service intends to handle correctly.
MediaServiceManifest	getMediaServiceManifest() The MediaServiceManifest
NavigationServiceManifest	getNavigationServiceManifest() The NavigationServiceManifest
SdlMsgVersion	getRpcSpecVersion() This is the max RPC Spec version the app service understands.
Image	getServiceIcon() The icon to be associated with this service Most likely the same as the appIcon.
String	getServiceName() Unique name of this service
String	getServiceType() The type of service that is to be offered by this app
WeatherServiceManifest	getWeatherServiceManifest() The WeatherServiceManifest
AppServiceManifest	setAllowAppConsumers(Boolean allowAppConsumers) If true, app service consumers beyond the IVI system will be able to access this service.
AppServiceManifest	setHandledRpcs(List<Integer> handledRPCs) This field contains the Function IDs for the RPCs that this service intends to handle correctly.
AppServiceManifest	setHandledRpcsUsingFunctionIDs(List<FunctionID> handledRPCs) This field contains the Function IDs for the RPCs that this service intends to handle correctly.
AppServiceManifest	setMediaServiceManifest(MediaServiceManifest mediaServiceManifest) The MediaServiceManifest
AppServiceManifest	setNavigationServiceManifest(NavigationServiceManifest navigationServiceManifest) The NavigationServiceManifest
AppServiceManifest	setRpcSpecVersion(SdlMsgVersion rpcSpecVersion) This is the max RPC Spec version the app service understands.
AppServiceManifest	setServiceIcon(Image serviceIcon) The icon to be associated with this service Most likely the same as the appIcon.
AppServiceManifest	setServiceName(String serviceName) Unique name of this service
AppServiceManifest	setServiceType(String serviceType) The type of service that is to be offered by this app
AppServiceManifest	setWeatherServiceManifest(WeatherServiceManifest weatherServiceManifest) The WeatherServiceManifest

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_SERVICE_NAME

public static final String KEY_SERVICE_NAME

See Also:

Constant Field Values

KEY_SERVICE_TYPE

public static final String KEY_SERVICE_TYPE

See Also:

Constant Field Values

KEY_SERVICE_ICON

public static final String KEY_SERVICE_ICON

See Also:

Constant Field Values

KEY_ALLOW_APP_CONSUMERS

public static final String KEY_ALLOW_APP_CONSUMERS

See Also:

Constant Field Values

KEY_RPC_SPEC_VERSION

public static final String KEY_RPC_SPEC_VERSION

See Also:

Constant Field Values

KEY_HANDLED_RPCS

public static final String KEY_HANDLED_RPCS

See Also:

Constant Field Values

KEY_MEDIA_SERVICE_MANIFEST

public static final String KEY_MEDIA_SERVICE_MANIFEST

See Also:

Constant Field Values

KEY_WEATHER_SERVICE_MANIFEST

public static final String KEY_WEATHER_SERVICE_MANIFEST

See Also:

Constant Field Values

KEY_NAVIGATION_SERVICE_MANIFEST

public static final String KEY_NAVIGATION_SERVICE_MANIFEST

See Also:

Constant Field Values

Constructor Detail

AppServiceManifest

public AppServiceManifest()

AppServiceManifest

public AppServiceManifest(Hashtable<String,Object> hash)

AppServiceManifest

public AppServiceManifest(@NonNull
                          String serviceType)

Constructor that takes in the mandatory parameters.

Parameters:

serviceType - the type of service this is, use AppServiceType

See Also:

AppServiceType

AppServiceManifest

public AppServiceManifest(@NonNull
                          AppServiceType serviceType)

Constructor that takes in the mandatory parameters.

Parameters:

serviceType - the type of service this is

See Also:

AppServiceType

Method Detail

setServiceName

public AppServiceManifest setServiceName(String serviceName)

Unique name of this service

Parameters:

serviceName - - the service name

getServiceName

public String getServiceName()

Unique name of this service

Returns:

ServiceName

setServiceType

public AppServiceManifest setServiceType(@NonNull
                                         String serviceType)

The type of service that is to be offered by this app

Parameters:

serviceType - - the serviceType use AppServiceType

See Also:

AppServiceType

getServiceType

public String getServiceType()

The type of service that is to be offered by this app

Returns:

the AppServiceType

See Also:

AppServiceType

setServiceIcon

public AppServiceManifest setServiceIcon(Image serviceIcon)

The icon to be associated with this service Most likely the same as the appIcon.

Parameters:

serviceIcon - - The Service Icon Image

getServiceIcon

public Image getServiceIcon()

The icon to be associated with this service Most likely the same as the appIcon.

Returns:

serviceIcon Image

setAllowAppConsumers

public AppServiceManifest setAllowAppConsumers(Boolean allowAppConsumers)

If true, app service consumers beyond the IVI system will be able to access this service. If false, only the IVI system will be able consume the service. If not provided, it is assumed to be false.

Parameters:

allowAppConsumers - - boolean

getAllowAppConsumers

public Boolean getAllowAppConsumers()

If true, app service consumers beyond the IVI system will be able to access this service. If false, only the IVI system will be able consume the service. If not provided, it is assumed to be false.

Returns:

allowAppConsumers - boolean

setRpcSpecVersion

public AppServiceManifest setRpcSpecVersion(SdlMsgVersion rpcSpecVersion)

This is the max RPC Spec version the app service understands. This is important during the RPC pass through functionality. If not included, it is assumed the max version of the module is acceptable.

Parameters:

rpcSpecVersion - - The rpcSpecVersion

getRpcSpecVersion

public SdlMsgVersion getRpcSpecVersion()

This is the max RPC Spec version the app service understands. This is important during the RPC pass through functionality. If not included, it is assumed the max version of the module is acceptable.

Returns:

rpcSpecVersion - The rpcSpecVersion

setHandledRpcs

public AppServiceManifest setHandledRpcs(List<Integer> handledRPCs)

This field contains the Function IDs for the RPCs that this service intends to handle correctly. This means the service will provide meaningful responses.

Parameters:

handledRPCs - - The List of Handled RPCs using their ID value from the FunctionID enum

See Also:

FunctionID, setHandledRpcsUsingFunctionIDs(List)

setHandledRpcsUsingFunctionIDs

public AppServiceManifest setHandledRpcsUsingFunctionIDs(List<FunctionID> handledRPCs)

This field contains the Function IDs for the RPCs that this service intends to handle correctly. This means the service will provide meaningful responses.

Parameters:

handledRPCs - - The List of Handled RPCs using the FunctionID enum

See Also:

setHandledRpcs(List)

getHandledRpcs

public List<Integer> getHandledRpcs()

This field contains the FunctionID integer ID values for the RPCs that this service intends to handle correctly. This means the service will provide meaningful responses.

Returns:

handledRPCs - The List of Handled RPC IDs obtained through the FunctionID enum

See Also:

FunctionID

setMediaServiceManifest

public AppServiceManifest setMediaServiceManifest(MediaServiceManifest mediaServiceManifest)

The MediaServiceManifest

Parameters:

mediaServiceManifest - - The mediaServiceManifest

getMediaServiceManifest

public MediaServiceManifest getMediaServiceManifest()

The MediaServiceManifest

Returns:

mediaServiceManifest - The mediaServiceManifest

setWeatherServiceManifest

public AppServiceManifest setWeatherServiceManifest(WeatherServiceManifest weatherServiceManifest)

The WeatherServiceManifest

Parameters:

weatherServiceManifest - - The weatherServiceManifest

getWeatherServiceManifest

public WeatherServiceManifest getWeatherServiceManifest()

The WeatherServiceManifest

Returns:

weatherServiceManifest - The weatherServiceManifest

setNavigationServiceManifest

public AppServiceManifest setNavigationServiceManifest(NavigationServiceManifest navigationServiceManifest)

The NavigationServiceManifest

Parameters:

navigationServiceManifest - - The navigationServiceManifest

getNavigationServiceManifest

public NavigationServiceManifest getNavigationServiceManifest()

The NavigationServiceManifest

Returns:

navigationServiceManifest - The navigationServiceManifest