Skip to main content

Class: EphemeralSetting

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

Represents an EphemeralSetting.

Implements​

Constructors​

new EphemeralSetting()​

new EphemeralSetting(properties?): EphemeralSetting

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

Constructs a new EphemeralSetting.

Parameters​

properties?​

IEphemeralSetting

Properties to set

Returns​

EphemeralSetting

Properties​

duration?​

optional duration: null | number

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

EphemeralSetting duration.

Implementation of​

IEphemeralSetting.duration

timestamp?​

optional timestamp: null | number | Long

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

EphemeralSetting timestamp.

Implementation of​

IEphemeralSetting.timestamp

Methods​

toJSON()​

toJSON(): object

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

Converts this EphemeralSetting to JSON.

Returns​

object

JSON object

create()​

static create(properties?): EphemeralSetting

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

Creates a new EphemeralSetting instance using the specified properties.

Parameters​

properties?​

IEphemeralSetting

Properties to set

Returns​

EphemeralSetting

EphemeralSetting instance

decode()​

static decode(reader, length?): EphemeralSetting

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

Decodes an EphemeralSetting 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​

EphemeralSetting

EphemeralSetting

Throws​

If the payload is not a reader or valid buffer

Throws​

If required fields are missing

decodeDelimited()​

static decodeDelimited(reader): EphemeralSetting

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

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

Parameters​

reader​

Reader or buffer to decode from

Uint8Array<ArrayBufferLike> | Reader

Returns​

EphemeralSetting

EphemeralSetting

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:12851

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

Parameters​

message​

IEphemeralSetting

EphemeralSetting 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:12859

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

Parameters​

message​

IEphemeralSetting

EphemeralSetting message or plain object to encode

writer?​

Writer

Writer to encode to

Returns​

Writer

Writer

fromObject()​

static fromObject(object): EphemeralSetting

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

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

Parameters​

object​

Plain object

Returns​

EphemeralSetting

EphemeralSetting

getTypeUrl()​

static getTypeUrl(typeUrlPrefix?): string

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

Gets the default type url for EphemeralSetting

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:12900

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

Parameters​

message​

EphemeralSetting

EphemeralSetting

options?​

IConversionOptions

Conversion options

Returns​

object

Plain object

verify()​

static verify(message): null | string

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

Verifies an EphemeralSetting message.

Parameters​

message​

Plain object to verify

Returns​

null | string

null if valid, otherwise the reason why it is not