Skip to main content

Class: Pushname

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

Represents a Pushname.

Implements​

Constructors​

new Pushname()​

new Pushname(properties?): Pushname

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

Constructs a new Pushname.

Parameters​

properties?​

IPushname

Properties to set

Returns​

Pushname

Properties​

id?​

optional id: null | string

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

Pushname id.

Implementation of​

IPushname.id

pushname?​

optional pushname: null | string

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

Pushname pushname.

Implementation of​

IPushname.pushname

Methods​

toJSON()​

toJSON(): object

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

Converts this Pushname to JSON.

Returns​

object

JSON object

create()​

static create(properties?): Pushname

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

Creates a new Pushname instance using the specified properties.

Parameters​

properties?​

IPushname

Properties to set

Returns​

Pushname

Pushname instance

decode()​

static decode(reader, length?): Pushname

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

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

Pushname

Pushname

Throws​

If the payload is not a reader or valid buffer

Throws​

If required fields are missing

decodeDelimited()​

static decodeDelimited(reader): Pushname

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

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

Parameters​

reader​

Reader or buffer to decode from

Uint8Array<ArrayBufferLike> | Reader

Returns​

Pushname

Pushname

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

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

Parameters​

message​

IPushname

Pushname 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:37611

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

Parameters​

message​

IPushname

Pushname message or plain object to encode

writer?​

Writer

Writer to encode to

Returns​

Writer

Writer

fromObject()​

static fromObject(object): Pushname

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

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

Parameters​

object​

Plain object

Returns​

Pushname

Pushname

getTypeUrl()​

static getTypeUrl(typeUrlPrefix?): string

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

Gets the default type url for Pushname

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

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

Parameters​

message​

Pushname

Pushname

options?​

IConversionOptions

Conversion options

Returns​

object

Plain object

verify()​

static verify(message): null | string

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

Verifies a Pushname message.

Parameters​

message​

Plain object to verify

Returns​

null | string

null if valid, otherwise the reason why it is not