Share via


ContentInfo interface

Extends

Properties

entityKind

Inherited Properties

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

Inherited Methods

validateInstance(string)

Property Details

entityKind

entityKind: "command" | "component" | "property" | "relationship" | "telemetry"

Property Value

"command" | "component" | "property" | "relationship" | "telemetry"

Inherited Property Details

childOf

childOf: undefined | string

Property Value

undefined | string

Inherited From NamedEntityInfo.childOf

comment

comment?: string

Property Value

string

Inherited From NamedEntityInfo.comment

definedIn

definedIn: undefined | string

Property Value

undefined | string

Inherited From NamedEntityInfo.definedIn

description

description?: LanguageStringType

Property Value

Inherited From NamedEntityInfo.description

displayName

displayName?: LanguageStringType

Property Value

Inherited From NamedEntityInfo.displayName

dtdlVersion

dtdlVersion: number

Property Value

number

Inherited From NamedEntityInfo.dtdlVersion

id

id: string

Property Value

string

Inherited From NamedEntityInfo.id

languageVersion

languageVersion?: number

Property Value

number

Inherited From NamedEntityInfo.languageVersion

name

name?: string

Property Value

string

Inherited From NamedEntityInfo.name

supplementalProperties

supplementalProperties: {[x: string]: any}

Property Value

{[x: string]: any}

Inherited From NamedEntityInfo.supplementalProperties

supplementalTypeIds

supplementalTypeIds: string[]

Property Value

string[]

Inherited From NamedEntityInfo.supplementalTypeIds

supplementalTypes

supplementalTypes: SupplementalTypeInfo[]

Property Value

Inherited From NamedEntityInfo.supplementalTypes

undefinedProperties

undefinedProperties: {[name: string]: any}

Property Value

{[name: string]: any}

Inherited From NamedEntityInfo.undefinedProperties

undefinedTypes

undefinedTypes: string[]

Property Value

string[]

Inherited From NamedEntityInfo.undefinedTypes

Inherited Method Details

validateInstance(string)

function validateInstance(instanceText: string): boolean

Parameters

instanceText

string

Returns

boolean

Inherited From NamedEntityInfo.validateInstance