Consumer interface

Defines the data contract of a consumer.

Properties

actions

Gets this consumer's actions.

authenticationType

Gets or sets this consumer's authentication type.

description

Gets or sets this consumer's localized description.

externalConfiguration

Non-null only if subscriptions for this consumer are configured externally.

id

Gets or sets this consumer's identifier.

imageUrl

Gets or sets this consumer's image URL, if any.

informationUrl

Gets or sets this consumer's information URL, if any.

inputDescriptors

Gets or sets this consumer's input descriptors.

name

Gets or sets this consumer's localized name.

url

The url for this resource

Property Details

actions

Gets this consumer's actions.

actions: ConsumerAction[]

Property Value

authenticationType

Gets or sets this consumer's authentication type.

authenticationType: AuthenticationType

Property Value

description

Gets or sets this consumer's localized description.

description: string

Property Value

string

externalConfiguration

Non-null only if subscriptions for this consumer are configured externally.

externalConfiguration: ExternalConfigurationDescriptor

Property Value

id

Gets or sets this consumer's identifier.

id: string

Property Value

string

imageUrl

Gets or sets this consumer's image URL, if any.

imageUrl: string

Property Value

string

informationUrl

Gets or sets this consumer's information URL, if any.

informationUrl: string

Property Value

string

inputDescriptors

Gets or sets this consumer's input descriptors.

inputDescriptors: InputDescriptor[]

Property Value

name

Gets or sets this consumer's localized name.

name: string

Property Value

string

url

The url for this resource

url: string

Property Value

string