MadelineProtoDocs/old_docs/API_docs_v95/constructors/wallPaper.md

47 lines
1.4 KiB
Markdown
Raw Normal View History

2019-03-29 21:12:30 +01:00
---
title: wallPaper
2019-12-27 17:48:04 +01:00
description: Wallpaper settings.
2019-03-29 21:12:30 +01:00
image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png
---
# Constructor: wallPaper
[Back to constructors index](index.md)
2019-12-27 17:48:04 +01:00
Wallpaper settings.
2019-03-29 21:12:30 +01:00
### Attributes:
| Name | Type | Required | Description |
|----------|---------------|----------|-------------|
2019-12-27 17:48:04 +01:00
|id|[long](../types/long.md) | Yes|Identifier|
|creator|[Bool](../types/Bool.md) | Optional|Creator of the wallpaper|
|default|[Bool](../types/Bool.md) | Optional|Whether this is the default wallpaper|
2019-03-29 21:12:30 +01:00
|pattern|[Bool](../types/Bool.md) | Optional|Pattern|
2019-12-27 17:48:04 +01:00
|dark|[Bool](../types/Bool.md) | Optional|Dark mode|
|access\_hash|[long](../types/long.md) | Yes|Access hash|
|slug|[string](../types/string.md) | Yes|Unique wallpaper ID|
|document|[Document](../types/Document.md) | Optional|The actual wallpaper|
2019-03-29 21:12:30 +01:00
|settings|[WallPaperSettings](../types/WallPaperSettings.md) | Optional|Wallpaper settings|
### Type: [WallPaper](../types/WallPaper.md)
### Example:
```php
$wallPaper = ['_' => 'wallPaper', 'id' => long, 'creator' => Bool, 'default' => Bool, 'pattern' => Bool, 'dark' => Bool, 'access_hash' => long, 'slug' => 'string', 'document' => Document, 'settings' => WallPaperSettings];
```
Or, if you're into Lua:
```lua
wallPaper={_='wallPaper', id=long, creator=Bool, default=Bool, pattern=Bool, dark=Bool, access_hash=long, slug='string', document=Document, settings=WallPaperSettings}
```