Skip to main content

Class: PremiumMessageInfo

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

Represents a PremiumMessageInfo.

Implements​

Constructors​

new PremiumMessageInfo()​

new PremiumMessageInfo(properties?): PremiumMessageInfo

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

Constructs a new PremiumMessageInfo.

Parameters​

properties?​

IPremiumMessageInfo

Properties to set

Returns​

PremiumMessageInfo

Properties​

serverCampaignId?​

optional serverCampaignId: null | string

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

PremiumMessageInfo serverCampaignId.

Implementation of​

IPremiumMessageInfo.serverCampaignId

Methods​

toJSON()​

toJSON(): object

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

Converts this PremiumMessageInfo to JSON.

Returns​

object

JSON object

create()​

static create(properties?): PremiumMessageInfo

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

Creates a new PremiumMessageInfo instance using the specified properties.

Parameters​

properties?​

IPremiumMessageInfo

Properties to set

Returns​

PremiumMessageInfo

PremiumMessageInfo instance

decode()​

static decode(reader, length?): PremiumMessageInfo

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

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

PremiumMessageInfo

PremiumMessageInfo

Throws​

If the payload is not a reader or valid buffer

Throws​

If required fields are missing

decodeDelimited()​

static decodeDelimited(reader): PremiumMessageInfo

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

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

Parameters​

reader​

Reader or buffer to decode from

Uint8Array<ArrayBufferLike> | Reader

Returns​

PremiumMessageInfo

PremiumMessageInfo

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

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

Parameters​

message​

IPremiumMessageInfo

PremiumMessageInfo 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:37145

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

Parameters​

message​

IPremiumMessageInfo

PremiumMessageInfo message or plain object to encode

writer?​

Writer

Writer to encode to

Returns​

Writer

Writer

fromObject()​

static fromObject(object): PremiumMessageInfo

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

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

Parameters​

object​

Plain object

Returns​

PremiumMessageInfo

PremiumMessageInfo

getTypeUrl()​

static getTypeUrl(typeUrlPrefix?): string

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

Gets the default type url for PremiumMessageInfo

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

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

Parameters​

message​

PremiumMessageInfo

PremiumMessageInfo

options?​

IConversionOptions

Conversion options

Returns​

object

Plain object

verify()​

static verify(message): null | string

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

Verifies a PremiumMessageInfo message.

Parameters​

message​

Plain object to verify

Returns​

null | string

null if valid, otherwise the reason why it is not