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
Documentation
AppServiceRecord

AppServiceRecord Class Reference

Constructors

Instance Methods

Constructors

new AppServiceRecord(parameters)

Initalizes an instance of AppServiceRecord.

Instance Methods

appServiceRecord.getServiceActive() ⇒ Boolean

Get the ServiceActive

Kind: Instance method of AppServiceRecord
Returns: Boolean - the KEY_SERVICE_ACTIVE value

appServiceRecord.getServiceID() ⇒ String

Get the ServiceID

Kind: Instance method of AppServiceRecord
Returns: String - the KEY_SERVICE_ID value

appServiceRecord.getServiceManifest() ⇒ AppServiceManifest

Get the ServiceManifest

Kind: Instance method of AppServiceRecord
Returns: AppServiceManifest - the KEY_SERVICE_MANIFEST value

appServiceRecord.getServicePublished() ⇒ Boolean

Get the ServicePublished

Kind: Instance method of AppServiceRecord
Returns: Boolean - the KEY_SERVICE_PUBLISHED value

appServiceRecord.setServiceActive(active) ⇒ AppServiceRecord

Set the ServiceActive

Kind: Instance method of AppServiceRecord
Returns: AppServiceRecord - The class instance for method chaining.

ParamTypeDescription
active Boolean 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. - The desired ServiceActive.

appServiceRecord.setServiceID(id) ⇒ AppServiceRecord

Set the ServiceID

Kind: Instance method of AppServiceRecord
Returns: AppServiceRecord - The class instance for method chaining.

ParamTypeDescription
id String A unique ID tied to this specific service record. The ID is supplied by the module that services publish themselves. - The desired ServiceID. {'string_min_length': 1}

appServiceRecord.setServiceManifest(manifest) ⇒ AppServiceRecord

Set the ServiceManifest

Kind: Instance method of AppServiceRecord
Returns: AppServiceRecord - The class instance for method chaining.

ParamTypeDescription
manifest AppServiceManifest Manifest for the service that this record is for. - The desired ServiceManifest.

appServiceRecord.setServicePublished(published) ⇒ AppServiceRecord

Set the ServicePublished

Kind: Instance method of AppServiceRecord
Returns: AppServiceRecord - The class instance for method chaining.

ParamTypeDescription
published Boolean If true, the service is published and available. If false, the service has likely just been unpublished, and should be considered unavailable. - The desired ServicePublished.
View on GitHub.com
Previous Section Next Section