CommandInfo interface

Package:
@azure/dtdl-parser
Extends
ContentInfo

Properties

commandType
entityKind
request
response

Inherited Properties

childOf
comment
definedIn
description
displayName
dtdlVersion
id
languageVersion
name
supplementalProperties
supplementalTypeIds
supplementalTypes
undefinedProperties
undefinedTypes

Inherited Methods

validateInstance(string)

Property Details

commandType 

commandType?: CommandTypeInfo

Property Value

CommandTypeInfo

entityKind 

entityKind: "command"

Property Value

"command"

request 

request?: CommandPayloadInfo

Property Value

CommandPayloadInfo

response 

response?: CommandPayloadInfo

Property Value

CommandPayloadInfo

Inherited Property Details

childOf 

childOf: undefined | string

Property Value

undefined | string

Inherited From ContentInfo.childOf

comment 

comment?: string

Property Value

string

Inherited From ContentInfo.comment

definedIn 

definedIn: undefined | string

Property Value

undefined | string

Inherited From ContentInfo.definedIn

description 

description?: LanguageStringType

Property Value

LanguageStringType

Inherited From ContentInfo.description

displayName 

displayName?: LanguageStringType

Property Value

LanguageStringType

Inherited From ContentInfo.displayName

dtdlVersion 

dtdlVersion: number

Property Value

number

Inherited From ContentInfo.dtdlVersion

id 

id: string

Property Value

string

Inherited From ContentInfo.id

languageVersion 

languageVersion?: number

Property Value

number

Inherited From ContentInfo.languageVersion

name 

name?: string

Property Value

string

Inherited From ContentInfo.name

supplementalProperties 

supplementalProperties: {[x: string]: any}

Property Value

{[x: string]: any}

Inherited From ContentInfo.supplementalProperties

supplementalTypeIds 

supplementalTypeIds: string[]

Property Value

string[]

Inherited From ContentInfo.supplementalTypeIds

supplementalTypes 

supplementalTypes: SupplementalTypeInfo[]

Property Value

SupplementalTypeInfo[]

Inherited From ContentInfo.supplementalTypes

undefinedProperties 

undefinedProperties: {[name: string]: any}

Property Value

{[name: string]: any}

Inherited From ContentInfo.undefinedProperties

undefinedTypes 

undefinedTypes: string[]

Property Value

string[]

Inherited From ContentInfo.undefinedTypes

Inherited Method Details

validateInstance(string) 

function validateInstance(instanceText: string): boolean

Parameters

instanceText

string

Returns

boolean

Inherited From ContentInfo.validateInstance