Link Search Menu Expand Document

Constructor: wallPaper

Back to constructors index

Represents a wallpaper based on an image.

Attributes:

NameTypeRequiredDescription
idlongYesIdentifier
creatorBoolOptionalWhether we created this wallpaper
defaultBoolOptionalWhether this is the default wallpaper
patternBoolOptionalWhether this is a pattern wallpaper »
darkBoolOptionalWhether this wallpaper should be used in dark mode.
access_hashlongYesAccess hash
slugstringYesUnique wallpaper ID, used when generating wallpaper links or importing wallpaper links.
documentDocumentOptionalThe actual wallpaper
settingsWallPaperSettingsOptionalInfo 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];