Options
All
  • Public
  • Public/Protected
  • All
Menu

Class PaymentBackground

Represents a PaymentBackground.

Hierarchy

  • PaymentBackground

Implements

Index

Constructors

Properties

Methods

Constructors

constructor

Properties

fileLength

fileLength: number | Long

PaymentBackground fileLength.

height

height: number

PaymentBackground height.

id

id: string

PaymentBackground id.

Optional mediaData

mediaData: IMediaData

PaymentBackground mediaData.

mimetype

mimetype: string

PaymentBackground mimetype.

placeholderArgb

placeholderArgb: number

PaymentBackground placeholderArgb.

subtextArgb

subtextArgb: number

PaymentBackground subtextArgb.

textArgb

textArgb: number

PaymentBackground textArgb.

type

type: PaymentBackgroundType

PaymentBackground type.

width

width: number

PaymentBackground width.

Methods

toJSON

  • toJSON(): {}

Static create

Static decode

  • Decodes a PaymentBackground message from the specified reader or buffer.

    throws

    {Error} If the payload is not a reader or valid buffer

    throws

    {$protobuf.util.ProtocolError} If required fields are missing

    Parameters

    • reader: Uint8Array | Reader

      Reader or buffer to decode from

    • Optional length: number

    Returns PaymentBackground

    PaymentBackground

Static decodeDelimited

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

    throws

    {Error} If the payload is not a reader or valid buffer

    throws

    {$protobuf.util.ProtocolError} If required fields are missing

    Parameters

    • reader: Uint8Array | Reader

      Reader or buffer to decode from

    Returns PaymentBackground

    PaymentBackground

Static encode

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

    Parameters

    • message: IPaymentBackground

      PaymentBackground message or plain object to encode

    • Optional writer: Writer

    Returns Writer

    Writer

Static encodeDelimited

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

    Parameters

    • message: IPaymentBackground

      PaymentBackground message or plain object to encode

    • Optional writer: Writer

    Returns Writer

    Writer

Static fromObject

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

    Parameters

    • object: {}

      Plain object

      • [k: string]: any

    Returns PaymentBackground

    PaymentBackground

Static toObject

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

    Parameters

    Returns {}

    Plain object

    • [k: string]: any

Static verify

  • verify(message: {}): string

  • Verifies a PaymentBackground message.

    Parameters

    • message: {}

      Plain object to verify

      • [k: string]: any

    Returns string

    null if valid, otherwise the reason why it is not

Generated using TypeDoc