Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface Consumer

Defines the data contract of a consumer.

Hierarchy

  • Consumer

Index

Properties

Properties

Optional actions

actions: Array<ConsumerAction>

Gets this consumer's actions.

Optional consumerId

consumerId: number

ID of the consumer.

Optional consumerName

consumerName: string

Name of the consumer.

Optional description

description: string

Gets or sets this consumer's localized description.

Optional externalConfiguration

externalConfiguration: ExternalConfigurationDescriptor

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

Optional id

id: string

Gets or sets this consumer's identifier.

Optional imageUrl

imageUrl: string

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

Optional informationUrl

informationUrl: string

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

Optional inputDescriptors

inputDescriptors: Array<InputDescriptor>

Gets or sets this consumer's input descriptors.

Optional links

links: ReferenceLinks

Reference Links

Optional name

name: string

Gets or sets this consumer's localized name.

Optional url

url: string

The url for this resource

Generated using TypeDoc