Skip to content

InvocationEvent.md

Latest commit

 

History

History
70 lines (42 loc) · 1.78 KB

InvocationEvent.md

File metadata and controls

70 lines (42 loc) · 1.78 KB
Raw

@heroku/applink v1.1.1

@heroku/applink / InvocationEvent

Interface: InvocationEvent<A>

Defined in: src/index.ts:125

An InvocationEvent is representative of the data associated with the occurrence of an event, and supporting metadata about the source of that occurrence.

Type Parameters

A

A

Properties

data

readonly data: A;

Defined in: src/index.ts:126

The payload of the event

dataContentType?

readonly optional dataContentType: string;

Defined in: src/index.ts:127

The media type of the event payload that is accessible in data

id

readonly id: string;

Defined in: src/index.ts:128

The platform event occurrence id for event invocation.

time?

readonly optional time: string;

Defined in: src/index.ts:129

The timestamp of when the occurrence happened. If the time of the occurrence cannot be determined then this attribute may be set to some other time (such as the current time), however all producers for the same source must be consistent in this respect. In other words, either they all use the actual time of the occurrence or they all use the same algorithm to determine the value used.