Skip to main content

Class: EventAdditionalMetadata

Defined in: WAProto/index.d.ts:14347

Represents an EventAdditionalMetadata.

Implements​

Constructors​

new EventAdditionalMetadata()​

new EventAdditionalMetadata(properties?): EventAdditionalMetadata

Defined in: WAProto/index.d.ts:14353

Constructs a new EventAdditionalMetadata.

Parameters​

properties?​

IEventAdditionalMetadata

Properties to set

Returns​

EventAdditionalMetadata

Properties​

isStale?​

optional isStale: null | boolean

Defined in: WAProto/index.d.ts:14356

EventAdditionalMetadata isStale.

Implementation of​

IEventAdditionalMetadata.isStale

Methods​

toJSON()​

toJSON(): object

Defined in: WAProto/index.d.ts:14426

Converts this EventAdditionalMetadata to JSON.

Returns​

object

JSON object

create()​

static create(properties?): EventAdditionalMetadata

Defined in: WAProto/index.d.ts:14363

Creates a new EventAdditionalMetadata instance using the specified properties.

Parameters​

properties?​

IEventAdditionalMetadata

Properties to set

Returns​

EventAdditionalMetadata

EventAdditionalMetadata instance

decode()​

static decode(reader, length?): EventAdditionalMetadata

Defined in: WAProto/index.d.ts:14389

Decodes an EventAdditionalMetadata message from the specified reader or buffer.

Parameters​

reader​

Reader or buffer to decode from

Uint8Array<ArrayBufferLike> | Reader

length?​

number

Message length if known beforehand

Returns​

EventAdditionalMetadata

EventAdditionalMetadata

Throws​

If the payload is not a reader or valid buffer

Throws​

If required fields are missing

decodeDelimited()​

static decodeDelimited(reader): EventAdditionalMetadata

Defined in: WAProto/index.d.ts:14398

Decodes an EventAdditionalMetadata message from the specified reader or buffer, length delimited.

Parameters​

reader​

Reader or buffer to decode from

Uint8Array<ArrayBufferLike> | Reader

Returns​

EventAdditionalMetadata

EventAdditionalMetadata

Throws​

If the payload is not a reader or valid buffer

Throws​

If required fields are missing

encode()​

static encode(message, writer?): Writer

Defined in: WAProto/index.d.ts:14371

Encodes the specified EventAdditionalMetadata message. Does not implicitly verify messages.

Parameters​

message​

IEventAdditionalMetadata

EventAdditionalMetadata message or plain object to encode

writer?​

Writer

Writer to encode to

Returns​

Writer

Writer

encodeDelimited()​

static encodeDelimited(message, writer?): Writer

Defined in: WAProto/index.d.ts:14379

Encodes the specified EventAdditionalMetadata message, length delimited. Does not implicitly verify messages.

Parameters​

message​

IEventAdditionalMetadata

EventAdditionalMetadata message or plain object to encode

writer?​

Writer

Writer to encode to

Returns​

Writer

Writer

fromObject()​

static fromObject(object): EventAdditionalMetadata

Defined in: WAProto/index.d.ts:14412

Creates an EventAdditionalMetadata message from a plain object. Also converts values to their respective internal types.

Parameters​

object​

Plain object

Returns​

EventAdditionalMetadata

EventAdditionalMetadata

getTypeUrl()​

static getTypeUrl(typeUrlPrefix?): string

Defined in: WAProto/index.d.ts:14433

Gets the default type url for EventAdditionalMetadata

Parameters​

typeUrlPrefix?​

string

your custom typeUrlPrefix(default "type.googleapis.com")

Returns​

string

The default type url

toObject()​

static toObject(message, options?): object

Defined in: WAProto/index.d.ts:14420

Creates a plain object from an EventAdditionalMetadata message. Also converts values to other types if specified.

Parameters​

message​

EventAdditionalMetadata

EventAdditionalMetadata

options?​

IConversionOptions

Conversion options

Returns​

object

Plain object

verify()​

static verify(message): null | string

Defined in: WAProto/index.d.ts:14405

Verifies an EventAdditionalMetadata message.

Parameters​

message​

Plain object to verify

Returns​

null | string

null if valid, otherwise the reason why it is not