Skip to main content

Class: Footer

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

Represents a Footer.

Implements​

Constructors​

new Footer(properties?): Footer

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

Constructs a new Footer.

Parameters​

properties?​

IFooter

Properties to set

Returns​

Footer

Properties​

text?​

optional text: null | string

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

Footer text.

Implementation of​

IFooter.text

Methods​

toJSON()​

toJSON(): object

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

Converts this Footer to JSON.

Returns​

object

JSON object

create()​

static create(properties?): Footer

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

Creates a new Footer instance using the specified properties.

Parameters​

properties?​

IFooter

Properties to set

Returns​

Footer

Footer instance

decode()​

static decode(reader, length?): Footer

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

Decodes a Footer 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​

Footer

Footer

Throws​

If the payload is not a reader or valid buffer

Throws​

If required fields are missing

decodeDelimited()​

static decodeDelimited(reader): Footer

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

Decodes a Footer message from the specified reader or buffer, length delimited.

Parameters​

reader​

Reader or buffer to decode from

Uint8Array<ArrayBufferLike> | Reader

Returns​

Footer

Footer

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

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

Parameters​

message​

IFooter

Footer 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:25446

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

Parameters​

message​

IFooter

Footer message or plain object to encode

writer?​

Writer

Writer to encode to

Returns​

Writer

Writer

fromObject()​

static fromObject(object): Footer

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

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

Parameters​

object​

Plain object

Returns​

Footer

Footer

getTypeUrl()​

static getTypeUrl(typeUrlPrefix?): string

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

Gets the default type url for Footer

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

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

Parameters​

message​

Footer

Footer

options?​

IConversionOptions

Conversion options

Returns​

object

Plain object

verify()​

static verify(message): null | string

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

Verifies a Footer message.

Parameters​

message​

Plain object to verify

Returns​

null | string

null if valid, otherwise the reason why it is not