Skip to main content

Class: PaymentBackground

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

Represents a PaymentBackground.

Implements​

Constructors​

new PaymentBackground()​

new PaymentBackground(properties?): PaymentBackground

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

Constructs a new PaymentBackground.

Parameters​

properties?​

IPaymentBackground

Properties to set

Returns​

PaymentBackground

Properties​

fileLength?​

optional fileLength: null | number | Long

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

PaymentBackground fileLength.

Implementation of​

IPaymentBackground.fileLength

height?​

optional height: null | number

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

PaymentBackground height.

Implementation of​

IPaymentBackground.height

id?​

optional id: null | string

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

PaymentBackground id.

Implementation of​

IPaymentBackground.id

mediaData?​

optional mediaData: null | IMediaData

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

PaymentBackground mediaData.

Implementation of​

IPaymentBackground.mediaData

mimetype?​

optional mimetype: null | string

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

PaymentBackground mimetype.

Implementation of​

IPaymentBackground.mimetype

placeholderArgb?​

optional placeholderArgb: null | number

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

PaymentBackground placeholderArgb.

Implementation of​

IPaymentBackground.placeholderArgb

subtextArgb?​

optional subtextArgb: null | number

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

PaymentBackground subtextArgb.

Implementation of​

IPaymentBackground.subtextArgb

textArgb?​

optional textArgb: null | number

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

PaymentBackground textArgb.

Implementation of​

IPaymentBackground.textArgb

type?​

optional type: null | Type

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

PaymentBackground type.

Implementation of​

IPaymentBackground.type

width?​

optional width: null | number

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

PaymentBackground width.

Implementation of​

IPaymentBackground.width

Methods​

toJSON()​

toJSON(): object

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

Converts this PaymentBackground to JSON.

Returns​

object

JSON object

create()​

static create(properties?): PaymentBackground

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

Creates a new PaymentBackground instance using the specified properties.

Parameters​

properties?​

IPaymentBackground

Properties to set

Returns​

PaymentBackground

PaymentBackground instance

decode()​

static decode(reader, length?): PaymentBackground

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

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

PaymentBackground

PaymentBackground

Throws​

If the payload is not a reader or valid buffer

Throws​

If required fields are missing

decodeDelimited()​

static decodeDelimited(reader): PaymentBackground

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

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

Parameters​

reader​

Reader or buffer to decode from

Uint8Array<ArrayBufferLike> | Reader

Returns​

PaymentBackground

PaymentBackground

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

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

Parameters​

message​

IPaymentBackground

PaymentBackground 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:35673

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

Parameters​

message​

IPaymentBackground

PaymentBackground message or plain object to encode

writer?​

Writer

Writer to encode to

Returns​

Writer

Writer

fromObject()​

static fromObject(object): PaymentBackground

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

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

Parameters​

object​

Plain object

Returns​

PaymentBackground

PaymentBackground

getTypeUrl()​

static getTypeUrl(typeUrlPrefix?): string

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

Gets the default type url for PaymentBackground

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

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

Parameters​

message​

PaymentBackground

PaymentBackground

options?​

IConversionOptions

Conversion options

Returns​

object

Plain object

verify()​

static verify(message): null | string

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

Verifies a PaymentBackground message.

Parameters​

message​

Plain object to verify

Returns​

null | string

null if valid, otherwise the reason why it is not