MadelineProtoDocs/docs/API_docs/constructors/wallPaper.md
2024-05-01 14:53:46 +02:00

1.8 KiB

title description nav_exclude image
wallPaper Represents a wallpaper based on an image. true https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png

Constructor: wallPaper

Back to constructors index

Represents a wallpaper based on an image.

Attributes:

Name Type Required Description
id long Yes Identifier
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.
access_hash long Yes Access hash
slug string Yes Unique wallpaper ID, used when generating wallpaper links or importing wallpaper links.
document Document Optional The actual wallpaper
settings WallPaperSettings Optional Info on how to generate the wallpaper, according to these instructions ».

Type: WallPaper

Example:

$wallPaper = ['_' => 'wallPaper', 'id' => long, 'creator' => Bool, 'default' => Bool, 'pattern' => Bool, 'dark' => Bool, 'access_hash' => long, 'slug' => 'string', 'document' => Document, 'settings' => WallPaperSettings];