Class AppServiceManifest

Hierarchy

java.lang.Object
com.smartdevicelink.proxy.RPCStruct

Package: com.smartdevicelink.proxy.rpc

Overview

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

Quick Jump

Fields

KEY_SERVICE_NAME
KEY_SERVICE_TYPE
KEY_SERVICE_ICON
KEY_ALLOW_APP_CONSUMERS
KEY_RPC_SPEC_VERSION
KEY_HANDLED_RPCS
KEY_MEDIA_SERVICE_MANIFEST
KEY_WEATHER_SERVICE_MANIFEST
KEY_NAVIGATION_SERVICE_MANIFEST

Constructors

AppServiceManifest()
AppServiceManifest( java.util.Hashtable<java.lang.String, java.lang.Object> hash )
AppServiceManifest( String serviceType )
AppServiceManifest( AppServiceType serviceType )

Methods

setServiceName(String serviceName)
getServiceName()
setServiceType(String serviceType)
getServiceType()
setServiceIcon(Image serviceIcon)
getServiceIcon()
setAllowAppConsumers(Boolean allowAppConsumers)
getAllowAppConsumers()
setRpcSpecVersion(SdlMsgVersion rpcSpecVersion)
getRpcSpecVersion()
setHandledRpcs(java.util.List<java.lang.Integer> handledRPCs)
setHandledRpcsUsingFunctionIDs(java.util.List<com.smartdevicelink.protocol.enums.FunctionID> handledRPCs)
getHandledRpcs()
setMediaServiceManifest(MediaServiceManifest mediaServiceManifest)
getMediaServiceManifest()
setWeatherServiceManifest(WeatherServiceManifest weatherServiceManifest)
getWeatherServiceManifest()
setNavigationServiceManifest(NavigationServiceManifest navigationServiceManifest)
getNavigationServiceManifest()

Fields

KEY_SERVICE_NAME

public static final java.lang.String KEY_SERVICE_NAME

Constant Value: "serviceName"

KEY_SERVICE_TYPE

public static final java.lang.String KEY_SERVICE_TYPE

Constant Value: "serviceType"

KEY_SERVICE_ICON

public static final java.lang.String KEY_SERVICE_ICON

Constant Value: "serviceIcon"

KEY_ALLOW_APP_CONSUMERS

public static final java.lang.String KEY_ALLOW_APP_CONSUMERS

Constant Value: "allowAppConsumers"

KEY_RPC_SPEC_VERSION

public static final java.lang.String KEY_RPC_SPEC_VERSION

Constant Value: "rpcSpecVersion"

KEY_HANDLED_RPCS

public static final java.lang.String KEY_HANDLED_RPCS

Constant Value: "handledRPCs"

KEY_MEDIA_SERVICE_MANIFEST

public static final java.lang.String KEY_MEDIA_SERVICE_MANIFEST

Constant Value: "mediaServiceManifest"

KEY_WEATHER_SERVICE_MANIFEST

public static final java.lang.String KEY_WEATHER_SERVICE_MANIFEST

Constant Value: "weatherServiceManifest"

KEY_NAVIGATION_SERVICE_MANIFEST

public static final java.lang.String KEY_NAVIGATION_SERVICE_MANIFEST

Constant Value: "navigationServiceManifest"

Inherited Fields

From Class	Fields
com.smartdevicelink.proxy.RPCStruct	KEY_BULK_DATA, KEY_PROTECTED, store

Constructors

AppServiceManifest()

public AppServiceManifest()

AppServiceManifest( java.util.Hashtable<java.lang.String, java.lang.Object> hash )

public AppServiceManifest(java.util.Hashtable<java.lang.String, java.lang.Object> hash)

Constructor Parameters

hash

AppServiceManifest( String serviceType )

Constructor that takes in the mandatory parameters.

public AppServiceManifest(String serviceType)

Constructor Parameters

serviceType: the type of service this is, use {@link com.smartdevicelink.proxy.rpc.enums.AppServiceType}

AppServiceManifest( AppServiceType serviceType )

Constructor that takes in the mandatory parameters.

public AppServiceManifest(AppServiceType serviceType)

Constructor Parameters

serviceType: the type of service this is

Methods

setServiceName( String serviceName )

Unique name of this service

public com.smartdevicelink.proxy.rpc.AppServiceManifest setServiceName(String serviceName)

Method Parameters

serviceName: - the service name

getServiceName()

Unique name of this service

public java.lang.String getServiceName()

setServiceType( String serviceType )

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

public com.smartdevicelink.proxy.rpc.AppServiceManifest setServiceType(String serviceType)

Method Parameters

serviceType: - the serviceType use {@link AppServiceType}

getServiceType()

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

public java.lang.String getServiceType()

setServiceIcon( Image serviceIcon )

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

public com.smartdevicelink.proxy.rpc.AppServiceManifest setServiceIcon(Image serviceIcon)

Method Parameters

serviceIcon: - The Service Icon Image

getServiceIcon()

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

public com.smartdevicelink.proxy.rpc.Image getServiceIcon()

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.

public com.smartdevicelink.proxy.rpc.AppServiceManifest setAllowAppConsumers(Boolean allowAppConsumers)

Method Parameters

allowAppConsumers: - 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.

public java.lang.Boolean getAllowAppConsumers()

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.

public com.smartdevicelink.proxy.rpc.AppServiceManifest setRpcSpecVersion(SdlMsgVersion rpcSpecVersion)

Method Parameters

rpcSpecVersion: - The rpcSpecVersion

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.

public com.smartdevicelink.proxy.rpc.SdlMsgVersion getRpcSpecVersion()

setHandledRpcs( java.util.List<java.lang.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.

public com.smartdevicelink.proxy.rpc.AppServiceManifest setHandledRpcs(java.util.List<java.lang.Integer> handledRPCs)

Method Parameters

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

setHandledRpcsUsingFunctionIDs( java.util.List<com.smartdevicelink.protocol.enums.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.

public com.smartdevicelink.proxy.rpc.AppServiceManifest setHandledRpcsUsingFunctionIDs(java.util.List<com.smartdevicelink.protocol.enums.FunctionID> handledRPCs)

Method Parameters

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

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.

public java.util.List getHandledRpcs()

setMediaServiceManifest( MediaServiceManifest mediaServiceManifest )

The MediaServiceManifest

public com.smartdevicelink.proxy.rpc.AppServiceManifest setMediaServiceManifest(MediaServiceManifest mediaServiceManifest)

Method Parameters

mediaServiceManifest: - The mediaServiceManifest

getMediaServiceManifest()

The MediaServiceManifest

public com.smartdevicelink.proxy.rpc.MediaServiceManifest getMediaServiceManifest()

setWeatherServiceManifest( WeatherServiceManifest weatherServiceManifest )

The WeatherServiceManifest

public com.smartdevicelink.proxy.rpc.AppServiceManifest setWeatherServiceManifest(WeatherServiceManifest weatherServiceManifest)

Method Parameters

weatherServiceManifest: - The weatherServiceManifest

getWeatherServiceManifest()

The WeatherServiceManifest

public com.smartdevicelink.proxy.rpc.WeatherServiceManifest getWeatherServiceManifest()

setNavigationServiceManifest( NavigationServiceManifest navigationServiceManifest )

The NavigationServiceManifest

public com.smartdevicelink.proxy.rpc.AppServiceManifest setNavigationServiceManifest(NavigationServiceManifest navigationServiceManifest)

Method Parameters

navigationServiceManifest: - The navigationServiceManifest

getNavigationServiceManifest()

The NavigationServiceManifest

public com.smartdevicelink.proxy.rpc.NavigationServiceManifest getNavigationServiceManifest()

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

View on GitHub.com

Previous Section Next Section