Class EpAsyncApiChannelDocument

Hierarchy

EpAsyncApiChannelDocument

Constructors

constructor

new EpAsyncApiChannelDocument(epAsyncApiDocument: EpAsyncApiDocument, asyncApiChannelKey: string, asyncApiChannel: Channel): EpAsyncApiChannelDocument
Parameters
- epAsyncApiDocument: EpAsyncApiDocument
- asyncApiChannelKey: string
- asyncApiChannel: Channel
Returns EpAsyncApiChannelDocument
- Defined in src/documents/EpAsyncApiChannelDocument.ts:27

Properties

`Private` asyncApiChannel

asyncApiChannel: Channel

`Private` asyncApiChannelKey

asyncApiChannelKey: string

`Private` epAsyncApiDocument

epAsyncApiDocument: EpAsyncApiDocument

`Private` `Optional` epEventName

epEventName?: string

`Private` `Optional` epEventVersionName

epEventVersionName?: string

Methods

`Private` _validate_EpEventVersionName

_validate_EpEventVersionName(epEventVersionName: string): string
Parameters
- epEventVersionName: string
Returns string
- Defined in src/documents/EpAsyncApiChannelDocument.ts:82

`Private` createEpEventName

createEpEventName(): void
Returns void
- Defined in src/documents/EpAsyncApiChannelDocument.ts:37

`Private` createEpEventVersionName

createEpEventVersionName(): void
Returns void
- Defined in src/documents/EpAsyncApiChannelDocument.ts:45

getApplicationDomainName

getApplicationDomainName(): string
Returns string
- Defined in src/documents/EpAsyncApiChannelDocument.ts:197

getAsyncApiChannel

getAsyncApiChannel(): Channel
Returns Channel
- Defined in src/documents/EpAsyncApiChannelDocument.ts:166

getAsyncApiChannelKey

getAsyncApiChannelKey(): string
Returns string
- Defined in src/documents/EpAsyncApiChannelDocument.ts:168

getEpAsyncApiChannelParameterDocumentMap

getEpAsyncApiChannelParameterDocumentMap(): undefined | T_EpAsyncApiChannelParameterDocumentMap
Returns undefined | T_EpAsyncApiChannelParameterDocumentMap
- Defined in src/documents/EpAsyncApiChannelDocument.ts:201

getEpAsyncApiChannelPublishOperation

getEpAsyncApiChannelPublishOperation(): undefined | EpAsynApiChannelPublishOperation
Returns undefined | EpAsynApiChannelPublishOperation
- Defined in src/documents/EpAsyncApiChannelDocument.ts:213

getEpAsyncApiChannelSubscribeOperation

getEpAsyncApiChannelSubscribeOperation(): undefined | EpAsyncApiChannelSubscribeOperation
Returns undefined | EpAsyncApiChannelSubscribeOperation
- Defined in src/documents/EpAsyncApiChannelDocument.ts:220

getEpEventName

getEpEventName(): string
Return the event name for EP from:
1. channel extension: x-ep-event-name
2. channel topic
Returns string
- Defined in src/documents/EpAsyncApiChannelDocument.ts:175

getEpEventVersionName

getEpEventVersionName(): string
Returns string
- Defined in src/documents/EpAsyncApiChannelDocument.ts:186

`Private` get_X_EpEventName

get_X_EpEventName(): undefined | string
Returns undefined | string
- Defined in src/documents/EpAsyncApiChannelDocument.ts:33

validate

validate(): void
Returns void
- Defined in src/documents/EpAsyncApiChannelDocument.ts:118

validate_BestPractices

validate_BestPractices(): void
Returns void
- Defined in src/documents/EpAsyncApiChannelDocument.ts:142

`Private` validate_EpEventVersionName

validate_EpEventVersionName(): void
Returns void
- Defined in src/documents/EpAsyncApiChannelDocument.ts:99

`Private` validate_EpName

validate_EpName(): void
Returns void
- Defined in src/documents/EpAsyncApiChannelDocument.ts:58