Skip to content
Back to top
View this page

# BackgroundTypeWallpaper

Added in version 21.2.

class telegram.BackgroundTypeWallpaper(document, dark_theme_dimming, is_blurred=None, is_moving=None, *, api_kwargs=None)

  Bases: `telegram.BackgroundType`

  The background is a wallpaper in the JPEG format.

  Objects of this class are comparable in terms of equality. Two objects of this class are considered equal, if their `document` and `dark_theme_dimming` are equal.

  Available In

  `telegram.ChatBackground.type`

  Added in version 21.2.

  Parameters:

    - document (`telegram.Document`) – Document with the wallpaper

    - dark_theme_dimming (`int`) – Dimming of the background in dark themes, as a percentage; 0-`100`.

    - is_blurred (`bool`, optional) – `True`, if the wallpaper is downscaled to fit in a 450x450 square and then box-blurred with radius 12

    - is_moving (`bool`, optional) – `True`, if the background moves slightly when the device is tilted

  type

    Type of the background. Always `WALLPAPER`.

    Type:

      `str`

  document

    Document with the wallpaper

    Type:

      `telegram.Document`

  dark_theme_dimming

    Dimming of the background in dark themes, as a percentage; 0-`100`.

    Type:

      `int`

  is_blurred

    Optional. `True`, if the wallpaper is downscaled to fit in a 450x450 square and then box-blurred with radius 12

    Type:

      `bool`

  is_moving

    Optional. `True`, if the background moves slightly when the device is tilted

    Type:

      `bool`