Skip to main content

Class: UserReceipt

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

Represents a UserReceipt.

Implements​

Constructors​

new UserReceipt()​

new UserReceipt(properties?): UserReceipt

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

Constructs a new UserReceipt.

Parameters​

properties?​

IUserReceipt

Properties to set

Returns​

UserReceipt

Properties​

deliveredDeviceJid​

deliveredDeviceJid: string[]

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

UserReceipt deliveredDeviceJid.

Implementation of​

IUserReceipt.deliveredDeviceJid

pendingDeviceJid​

pendingDeviceJid: string[]

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

UserReceipt pendingDeviceJid.

Implementation of​

IUserReceipt.pendingDeviceJid

playedTimestamp?​

optional playedTimestamp: null | number | Long

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

UserReceipt playedTimestamp.

Implementation of​

IUserReceipt.playedTimestamp

readTimestamp?​

optional readTimestamp: null | number | Long

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

UserReceipt readTimestamp.

Implementation of​

IUserReceipt.readTimestamp

receiptTimestamp?​

optional receiptTimestamp: null | number | Long

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

UserReceipt receiptTimestamp.

Implementation of​

IUserReceipt.receiptTimestamp

userJid​

userJid: string

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

UserReceipt userJid.

Implementation of​

IUserReceipt.userJid

Methods​

toJSON()​

toJSON(): object

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

Converts this UserReceipt to JSON.

Returns​

object

JSON object

create()​

static create(properties?): UserReceipt

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

Creates a new UserReceipt instance using the specified properties.

Parameters​

properties?​

IUserReceipt

Properties to set

Returns​

UserReceipt

UserReceipt instance

decode()​

static decode(reader, length?): UserReceipt

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

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

UserReceipt

UserReceipt

Throws​

If the payload is not a reader or valid buffer

Throws​

If required fields are missing

decodeDelimited()​

static decodeDelimited(reader): UserReceipt

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

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

Parameters​

reader​

Reader or buffer to decode from

Uint8Array<ArrayBufferLike> | Reader

Returns​

UserReceipt

UserReceipt

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

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

Parameters​

message​

IUserReceipt

UserReceipt 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:48800

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

Parameters​

message​

IUserReceipt

UserReceipt message or plain object to encode

writer?​

Writer

Writer to encode to

Returns​

Writer

Writer

fromObject()​

static fromObject(object): UserReceipt

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

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

Parameters​

object​

Plain object

Returns​

UserReceipt

UserReceipt

getTypeUrl()​

static getTypeUrl(typeUrlPrefix?): string

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

Gets the default type url for UserReceipt

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

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

Parameters​

message​

UserReceipt

UserReceipt

options?​

IConversionOptions

Conversion options

Returns​

object

Plain object

verify()​

static verify(message): null | string

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

Verifies a UserReceipt message.

Parameters​

message​

Plain object to verify

Returns​

null | string

null if valid, otherwise the reason why it is not