Class PaymentBackground

Represents a PaymentBackground.

Hierarchy

  • PaymentBackground

Implements

Constructors

Properties

fileLength: number | Long

PaymentBackground fileLength.

height: number

PaymentBackground height.

id: string

PaymentBackground id.

PaymentBackground mediaData.

mimetype: string

PaymentBackground mimetype.

placeholderArgb: number

PaymentBackground placeholderArgb.

subtextArgb: number

PaymentBackground subtextArgb.

textArgb: number

PaymentBackground textArgb.

PaymentBackground type.

width: number

PaymentBackground width.

Methods

  • Converts this PaymentBackground to JSON.

    Returns {
        [k: string]: any;
    }

    JSON object

    • [k: string]: any
  • Decodes a PaymentBackground message from the specified reader or buffer.

    Parameters

    • reader: Uint8Array | Reader

      Reader or buffer to decode from

    • Optional 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

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

    Parameters

    • reader: Uint8Array | Reader

      Reader or buffer to decode from

    Returns PaymentBackground

    PaymentBackground

    Throws

    If the payload is not a reader or valid buffer

    Throws

    If required fields are missing

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

    Parameters

    • message: IPaymentBackground

      PaymentBackground message or plain object to encode

    • Optional writer: Writer

      Writer to encode to

    Returns Writer

    Writer

  • 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

      Writer to encode to

    Returns Writer

    Writer

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

    Parameters

    • object: {
          [k: string]: any;
      }

      Plain object

      • [k: string]: any

    Returns PaymentBackground

    PaymentBackground

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

    Parameters

    • message: PaymentBackground

      PaymentBackground

    • Optional options: IConversionOptions

      Conversion options

    Returns {
        [k: string]: any;
    }

    Plain object

    • [k: string]: any
  • Verifies a PaymentBackground message.

    Parameters

    • message: {
          [k: string]: any;
      }

      Plain object to verify

      • [k: string]: any

    Returns null | string

    null if valid, otherwise the reason why it is not

Generated using TypeDoc