WallPaper

class pyrogram.raw.types.WallPaper

Represents a wallpaper based on an image.

Constructor of WallPaper.

Details:

  • Layer: 223

  • ID: A437C3ED

Parameters:

  • id (int 64-bit) – Identifier

  • access_hash (int 64-bit) – Access hash

  • slug (str) – Unique wallpaper ID, used when generating wallpaper links or importing wallpaper links.

  • document (Document) – The actual wallpaper

  • creator (bool, optional) – Whether we created this wallpaper

  • default (bool, optional) – Whether this is the default wallpaper

  • pattern (bool, optional) – Whether this is a pattern wallpaper »

  • dark (bool, optional) – Whether this wallpaper should be used in dark mode.

  • settings (WallPaperSettings, optional) – Info on how to generate the wallpaper, according to these instructions ».

Functions:

This object can be returned by 3 functions.

account.GetWallPaper

Get info about a certain wallpaper

account.UploadWallPaper

Create and upload a new wallpaper

account.GetMultiWallPapers

Get info about multiple wallpapers

TL Schema

wallPaper#a437c3ed
id:long
flags:#
creator:flags.0?true
default:flags.1?true
pattern:flags.3?true
dark:flags.4?true
access_hash:long
slug:string
document:Document
settings:flags.2?WallPaperSettings

= WallPaper

Parameter Tree

WallPaper
├── id → long
├── creator → true (optional)
├── default → true (optional)
├── pattern → true (optional)
├── dark → true (optional)
├── access_hash → long
├── slug → string
├── document → Document
│ ├── DocumentEmpty
│ │ └── id → long
│ └── Document
│ ├── id → long
│ ├── access_hash → long
│ ├── file_reference → bytes
│ ├── date → int
│ ├── mime_type → string
│ ├── size → long
│ ├── thumbs → Vector < PhotoSize > (optional)
│ │ ├── PhotoSizeEmpty
│ │ │ └── type → string
│ │ ├── PhotoSize
│ │ │ ├── type → string
│ │ │ ├── w → int
│ │ │ ├── h → int
│ │ │ └── size → int
│ │ ├── PhotoCachedSize
│ │ │ ├── type → string
│ │ │ ├── w → int
│ │ │ ├── h → int
│ │ │ └── bytes → bytes
│ │ ├── PhotoStrippedSize
│ │ │ ├── type → string
│ │ │ └── bytes → bytes
│ │ ├── PhotoSizeProgressive
│ │ │ ├── type → string
│ │ │ ├── w → int
│ │ │ ├── h → int
│ │ │ └── sizes → Vector < int >
│ │ └── PhotoPathSize
│ │ ├── type → string
│ │ └── bytes → bytes
│ ├── video_thumbs → Vector < VideoSize > (optional)
│ │ ├── VideoSize
│ │ │ ├── type → string
│ │ │ ├── w → int
│ │ │ ├── h → int
│ │ │ ├── size → int
│ │ │ └── video_start_ts → double (optional)
│ │ ├── VideoSizeEmojiMarkup
│ │ │ ├── emoji_id → long
│ │ │ └── background_colors → Vector < int >
│ │ └── VideoSizeStickerMarkup
│ │ ├── stickerset → InputStickerSet
│ │ │ ├── InputStickerSetEmpty
│ │ │ ├── InputStickerSetID
│ │ │ ├── InputStickerSetShortName
│ │ │ ├── InputStickerSetAnimatedEmoji
│ │ │ ├── InputStickerSetDice
│ │ │ ├── InputStickerSetAnimatedEmojiAnimations
│ │ │ ├── InputStickerSetPremiumGifts
│ │ │ ├── InputStickerSetEmojiGenericAnimations
│ │ │ ├── InputStickerSetEmojiDefaultStatuses
│ │ │ ├── InputStickerSetEmojiDefaultTopicIcons
│ │ │ ├── InputStickerSetEmojiChannelDefaultStatuses
│ │ │ └── InputStickerSetTonGifts
│ │ ├── sticker_id → long
│ │ └── background_colors → Vector < int >
│ ├── dc_id → int
│ └── attributes → Vector < DocumentAttribute >
│ ├── DocumentAttributeImageSize
│ │ ├── w → int
│ │ └── h → int
│ ├── DocumentAttributeAnimated
│ ├── DocumentAttributeSticker
│ │ ├── mask → true (optional)
│ │ ├── alt → string
│ │ ├── stickerset → InputStickerSet
│ │ │ ├── InputStickerSetEmpty
│ │ │ ├── InputStickerSetID
│ │ │ ├── InputStickerSetShortName
│ │ │ ├── InputStickerSetAnimatedEmoji
│ │ │ ├── InputStickerSetDice
│ │ │ ├── InputStickerSetAnimatedEmojiAnimations
│ │ │ ├── InputStickerSetPremiumGifts
│ │ │ ├── InputStickerSetEmojiGenericAnimations
│ │ │ ├── InputStickerSetEmojiDefaultStatuses
│ │ │ ├── InputStickerSetEmojiDefaultTopicIcons
│ │ │ ├── InputStickerSetEmojiChannelDefaultStatuses
│ │ │ └── InputStickerSetTonGifts
│ │ └── mask_coords → MaskCoords (optional)
│ │ └── MaskCoords
│ ├── DocumentAttributeVideo
│ │ ├── round_message → true (optional)
│ │ ├── supports_streaming → true (optional)
│ │ ├── nosound → true (optional)
│ │ ├── duration → double
│ │ ├── w → int
│ │ ├── h → int
│ │ ├── preload_prefix_size → int (optional)
│ │ ├── video_start_ts → double (optional)
│ │ └── video_codec → string (optional)
│ ├── DocumentAttributeAudio
│ │ ├── voice → true (optional)
│ │ ├── duration → int
│ │ ├── title → string (optional)
│ │ ├── performer → string (optional)
│ │ └── waveform → bytes (optional)
│ ├── DocumentAttributeFilename
│ │ └── file_name → string
│ ├── DocumentAttributeHasStickers
│ └── DocumentAttributeCustomEmoji
│ ├── free → true (optional)
│ ├── text_color → true (optional)
│ ├── alt → string
│ └── stickerset → InputStickerSet
│ ├── InputStickerSetEmpty
│ ├── InputStickerSetID
│ ├── InputStickerSetShortName
│ ├── InputStickerSetAnimatedEmoji
│ ├── InputStickerSetDice
│ ├── InputStickerSetAnimatedEmojiAnimations
│ ├── InputStickerSetPremiumGifts
│ ├── InputStickerSetEmojiGenericAnimations
│ ├── InputStickerSetEmojiDefaultStatuses
│ ├── InputStickerSetEmojiDefaultTopicIcons
│ ├── InputStickerSetEmojiChannelDefaultStatuses
│ └── InputStickerSetTonGifts
└── settings → WallPaperSettings (optional)
└── WallPaperSettings
├── blur → true (optional)
├── motion → true (optional)
├── background_color → int (optional)
├── second_background_color → int (optional)
├── third_background_color → int (optional)
├── fourth_background_color → int (optional)
├── intensity → int (optional)
├── rotation → int (optional)
└── emoticon → string (optional)

Example

WallPaper(
    id=0,
    access_hash=0,
    slug="text",
    document=DocumentEmpty(id=0),
)