Expand Minimize Picture-in-picture Power Device Status Voice Recognition Skip Back Skip Forward Minus Plus Play Search
Documentation
CloudAppProperties

CloudAppProperties Class Reference

Constructors

Instance Methods

Constructors

new CloudAppProperties(parameters)

Initalizes an instance of CloudAppProperties.

Instance Methods

cloudAppProperties.getAppID() ⇒ String

Get the AppID

Kind: Instance method of CloudAppProperties
Returns: String - the KEY_APP_ID value

cloudAppProperties.getAuthToken() ⇒ String

Get the AuthToken

Kind: Instance method of CloudAppProperties
Returns: String - the KEY_AUTH_TOKEN value

cloudAppProperties.getCloudTransportType() ⇒ String

Get the CloudTransportType

Kind: Instance method of CloudAppProperties
Returns: String - the KEY_CLOUD_TRANSPORT_TYPE value

cloudAppProperties.getEnabled() ⇒ Boolean

Get the Enabled

Kind: Instance method of CloudAppProperties
Returns: Boolean - the KEY_ENABLED value

cloudAppProperties.getEndpoint() ⇒ String

Get the Endpoint

Kind: Instance method of CloudAppProperties
Returns: String - the KEY_ENDPOINT value

cloudAppProperties.getHybridAppPreference() ⇒ HybridAppPreference

Get the HybridAppPreference

Kind: Instance method of CloudAppProperties
Returns: HybridAppPreference - the KEY_HYBRID_APP_PREFERENCE value

cloudAppProperties.getNicknames() ⇒ Array.<String>

Get the Nicknames

Kind: Instance method of CloudAppProperties
Returns: Array.<String> - the KEY_NICKNAMES value

cloudAppProperties.setAppID(id) ⇒ CloudAppProperties

Set the AppID

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

ParamTypeDescription
id String The desired AppID.

cloudAppProperties.setAuthToken(token) ⇒ CloudAppProperties

Set the AuthToken

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

ParamTypeDescription
token String Used to authenticate websocket connection on app activation - The desired AuthToken.

cloudAppProperties.setCloudTransportType(type) ⇒ CloudAppProperties

Set the CloudTransportType

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

ParamTypeDescription
type String Specifies the connection type Core should use - The desired CloudTransportType.

cloudAppProperties.setEnabled(enabled) ⇒ CloudAppProperties

Set the Enabled

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

ParamTypeDescription
enabled Boolean If true, cloud app will be included in HMI RPC UpdateAppList - The desired Enabled.

cloudAppProperties.setEndpoint(endpoint) ⇒ CloudAppProperties

Set the Endpoint

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

ParamTypeDescription
endpoint String Specifies the endpoint which Core will attempt to connect to when this app is selected - The desired Endpoint.

cloudAppProperties.setHybridAppPreference(preference) ⇒ CloudAppProperties

Set the HybridAppPreference

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

ParamTypeDescription
preference HybridAppPreference Specifies the user preference to use the cloud app version or mobile - The desired HybridAppPreference. app version when both are available

cloudAppProperties.setNicknames(nicknames) ⇒ CloudAppProperties

Set the Nicknames

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

ParamTypeDescription
nicknames Array.<String> An array of app names a cloud app is allowed to register with. If included in a - The desired Nicknames. SetCloudAppProperties request, this value will overwrite the existing "nicknames" field in the app policies section of the policy table.
View on GitHub.com
Previous Section Next Section