Class default

UnitFacade serves payload-specific API methods.

Hierarchy

default

Implements

Facade

Index

Constructors

Properties

NAME VERSION _info _transport NAME VERSION

Methods

list lookUp setStatus track untrack

Constructors

constructor

new default(transport: Transport, info: ConnectionInfo): default
Parameters
- transport: Transport
- info: ConnectionInfo
Returns default
- Defined in api/facades/payloads-hook-context/PayloadsHookContextV1.ts:95

Properties

NAME

NAME: string = "PayloadsHookContext"

VERSION

VERSION: number = 1

_info

_info: ConnectionInfo

_transport

_transport: Transport

`Static` NAME

NAME: string = "PayloadsHookContext"

`Static` VERSION

VERSION: number = 1

Methods

list

list(params: Entities): Promise<PayloadResults>
List builds the list of payload being tracked for the given unit and IDs. If no IDs are provided then all tracked payloads for the unit are returned.
Parameters
- params: Entities
Returns Promise<PayloadResults>
- Defined in api/facades/payloads-hook-context/PayloadsHookContextV1.ts:107

lookUp

lookUp(params: LookUpPayloadArgs): Promise<PayloadResults>
LookUp identifies the payload with the provided name and raw ID.
Parameters
- params: LookUpPayloadArgs
Returns Promise<PayloadResults>
- Defined in api/facades/payloads-hook-context/PayloadsHookContextV1.ts:123

setStatus

setStatus(params: SetPayloadStatusArgs): Promise<PayloadResults>
SetStatus sets the raw status of a payload.
Parameters
- params: SetPayloadStatusArgs
Returns Promise<PayloadResults>
- Defined in api/facades/payloads-hook-context/PayloadsHookContextV1.ts:139

track

track(params: TrackPayloadArgs): Promise<PayloadResults>
Track stores a payload to be tracked in state.
Parameters
- params: TrackPayloadArgs
Returns Promise<PayloadResults>
- Defined in api/facades/payloads-hook-context/PayloadsHookContextV1.ts:155

untrack

untrack(params: Entities): Promise<PayloadResults>
Untrack marks the identified payload as no longer being tracked.
Parameters
- params: Entities
Returns Promise<PayloadResults>
- Defined in api/facades/payloads-hook-context/PayloadsHookContextV1.ts:171

Generated using TypeDoc