Skip to main content

Class: PinInChat

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

Represents a PinInChat.

Implements​

Constructors​

new PinInChat()​

new PinInChat(properties?): PinInChat

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

Constructs a new PinInChat.

Parameters​

properties?​

IPinInChat

Properties to set

Returns​

PinInChat

Properties​

key?​

optional key: null | IMessageKey

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

PinInChat key.

Implementation of​

IPinInChat.key

messageAddOnContextInfo?​

optional messageAddOnContextInfo: null | IMessageAddOnContextInfo

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

PinInChat messageAddOnContextInfo.

Implementation of​

IPinInChat.messageAddOnContextInfo

senderTimestampMs?​

optional senderTimestampMs: null | number | Long

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

PinInChat senderTimestampMs.

Implementation of​

IPinInChat.senderTimestampMs

serverTimestampMs?​

optional serverTimestampMs: null | number | Long

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

PinInChat serverTimestampMs.

Implementation of​

IPinInChat.serverTimestampMs

type?​

optional type: null | Type

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

PinInChat type.

Implementation of​

IPinInChat.type

Methods​

toJSON()​

toJSON(): object

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

Converts this PinInChat to JSON.

Returns​

object

JSON object

create()​

static create(properties?): PinInChat

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

Creates a new PinInChat instance using the specified properties.

Parameters​

properties?​

IPinInChat

Properties to set

Returns​

PinInChat

PinInChat instance

decode()​

static decode(reader, length?): PinInChat

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

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

PinInChat

PinInChat

Throws​

If the payload is not a reader or valid buffer

Throws​

If required fields are missing

decodeDelimited()​

static decodeDelimited(reader): PinInChat

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

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

Parameters​

reader​

Reader or buffer to decode from

Uint8Array<ArrayBufferLike> | Reader

Returns​

PinInChat

PinInChat

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

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

Parameters​

message​

IPinInChat

PinInChat 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:36366

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

Parameters​

message​

IPinInChat

PinInChat message or plain object to encode

writer?​

Writer

Writer to encode to

Returns​

Writer

Writer

fromObject()​

static fromObject(object): PinInChat

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

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

Parameters​

object​

Plain object

Returns​

PinInChat

PinInChat

getTypeUrl()​

static getTypeUrl(typeUrlPrefix?): string

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

Gets the default type url for PinInChat

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

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

Parameters​

message​

PinInChat

PinInChat

options?​

IConversionOptions

Conversion options

Returns​

object

Plain object

verify()​

static verify(message): null | string

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

Verifies a PinInChat message.

Parameters​

message​

Plain object to verify

Returns​

null | string

null if valid, otherwise the reason why it is not