Expand Minimize Picture-in-picture Power Device Status Voice Recognition Skip Back Skip Forward Minus Plus Play Search
Internet Explorer alert
This browser is not recommended for use with smartdevicelink.com, and may not function properly. Upgrade to a different browser to guarantee support of all features.
close alert
To Top Created with Sketch. To Top
To Bottom Created with Sketch. To Bottom
JavaEE Documentation
AppServiceRecord

Class AppServiceRecord

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 consumers able to interact with it

Fields

KEY_SERVICE_ID

public static final java.lang.String KEY_SERVICE_ID
Constant Value
"serviceID"

KEY_SERVICE_MANIFEST

public static final java.lang.String KEY_SERVICE_MANIFEST
Constant Value
"serviceManifest"

KEY_SERVICE_PUBLISHED

public static final java.lang.String KEY_SERVICE_PUBLISHED
Constant Value
"servicePublished"

KEY_SERVICE_ACTIVE

public static final java.lang.String KEY_SERVICE_ACTIVE
Constant Value
"serviceActive"

Inherited Fields

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

Constructors

AppServiceRecord()

public AppServiceRecord()

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

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

Constructor Parameters

hash

AppServiceRecord( String serviceID, AppServiceManifest serviceManifest, Boolean servicePublished, Boolean serviceActive )

public AppServiceRecord(String serviceID,AppServiceManifest serviceManifest,Boolean servicePublished,Boolean serviceActive)

Constructor Parameters

serviceID
serviceManifest
servicePublished
serviceActive

Methods

setServiceID( String serviceID )

ID of this service

public com.smartdevicelink.proxy.rpc.AppServiceRecord setServiceID(String serviceID)

Method Parameters

serviceID
- the service ID

getServiceID()

ID of this service

public java.lang.String getServiceID()

setServiceManifest( AppServiceManifest serviceManifest )

the App Service Manifest

public com.smartdevicelink.proxy.rpc.AppServiceRecord setServiceManifest(AppServiceManifest serviceManifest)

Method Parameters

serviceManifest
- the App Service Manifest

getServiceManifest()

the App Service Manifest

public com.smartdevicelink.proxy.rpc.AppServiceManifest getServiceManifest()

setServicePublished( Boolean servicePublished )

If true, the service is published and available. If false, the service has likely just been unpublished, and should be considered unavailable.

public com.smartdevicelink.proxy.rpc.AppServiceRecord setServicePublished(Boolean servicePublished)

Method Parameters

servicePublished
- boolean

getServicePublished()

If true, the service is published and available. If false, the service has likely just been unpublished, and should be considered unavailable.

public java.lang.Boolean getServicePublished()

setServiceActive( Boolean serviceActive )

If true, the service is the active primary service of the supplied service type. It will receive all potential RPCs that are passed through to that service type. If false, it is not the primary service of the supplied type. See servicePublished for its availability.

public com.smartdevicelink.proxy.rpc.AppServiceRecord setServiceActive(Boolean serviceActive)

Method Parameters

serviceActive
- boolean

getServiceActive()

If true, the service is the active primary service of the supplied service type. It will receive all potential RPCs that are passed through to that service type. If false, it is not the primary service of the supplied type. See servicePublished for its availability.

public java.lang.Boolean getServiceActive()

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