PayloadFragment | webapi-parser

Hierarchy

Fragment
- PayloadFragment

Implements

EncodesModel

Index

Constructors

constructor

Properties

Methods

Constructors

constructor

new PayloadFragment(scalar: ScalarNode, mediaType: string): PayloadFragment
new PayloadFragment(object: ObjectNode, mediaType: string): PayloadFragment
new PayloadFragment(array: ArrayNode, mediaType: string): PayloadFragment

- Defined in amf-client-js.d.ts:745
Parameters
- scalar: ScalarNode
- mediaType: string
Returns PayloadFragment
- Defined in amf-client-js.d.ts:747
Parameters
- object: ObjectNode
- mediaType: string
Returns PayloadFragment
- Defined in amf-client-js.d.ts:748
Parameters
- array: ArrayNode
- mediaType: string
Returns PayloadFragment

Properties

dataNode

dataNode: DataNode

encodes

encodes: DomainElement

id

id: string

location

location: string

mediaType

mediaType: string

raw

raw: string | undefined

usage

usage: StrField

Methods

findById

findById(id: string): DomainElement | undefined

Inherited from BaseUnit.findById
- Defined in amf-client-js.d.ts:496
Parameters
- id: string
Returns DomainElement | undefined

findByType

findByType(typeId: string): DomainElement[]

Inherited from BaseUnit.findByType
- Defined in amf-client-js.d.ts:498
Parameters
- typeId: string
Returns DomainElement[]

references

references(): BaseUnit[]

Inherited from BaseUnit.references
- Defined in amf-client-js.d.ts:480
Returns BaseUnit[]

withEncodes

withEncodes(enocdes: DomainElement): this

Inherited from BaseUnitWithEncodesModel.withEncodes
- Defined in amf-client-js.d.ts:516
Parameters
- enocdes: DomainElement
Returns this

withLocation

withLocation(location: string): this

Inherited from BaseUnit.withLocation
- Defined in amf-client-js.d.ts:492
Parameters
- location: string
Returns this

withRaw

withRaw(raw: string): this

Inherited from BaseUnit.withRaw
- Defined in amf-client-js.d.ts:490
Parameters
- raw: string
Returns this

withReferences

withReferences(references: BaseUnit[]): this

Inherited from BaseUnit.withReferences
- Defined in amf-client-js.d.ts:488
Parameters
- references: BaseUnit[]
Returns this

withUsage

withUsage(usage: string): this

Inherited from BaseUnit.withUsage
- Defined in amf-client-js.d.ts:494
Parameters
- usage: string
Returns this

Generated using TypeDoc