GramIO API Reference / @gramio/contexts/dist / BackgroundTypeWallpaper
Class: BackgroundTypeWallpaper
Defined in: contexts/index.d.ts:1114
The background is a wallpaper in the JPEG format.
Constructors
Constructor
new BackgroundTypeWallpaper(
payload):BackgroundTypeWallpaper
Defined in: contexts/index.d.ts:1116
Parameters
| Parameter | Type |
|---|---|
payload | TelegramBackgroundTypeWallpaper |
Returns
BackgroundTypeWallpaper
Properties
| Property | Type | Defined in |
|---|---|---|
payload | TelegramBackgroundTypeWallpaper | contexts/index.d.ts:1115 |
Accessors
[toStringTag]
Get Signature
get [toStringTag]():
string
Defined in: contexts/index.d.ts:1118
Returns
string
darkThemeDimming
Get Signature
get darkThemeDimming():
number
Defined in: contexts/index.d.ts:1130
Dimming of the background in dark themes, as a percentage; 0-100
Returns
number
document
Get Signature
get document():
DocumentAttachment
Defined in: contexts/index.d.ts:1126
Document with the wallpaper
Returns
isBlurred
Get Signature
get isBlurred():
true
Defined in: contexts/index.d.ts:1134
Optional. True, if the wallpaper is downscaled to fit in a 450x450 square and then box-blurred with radius 12
Returns
true
isMoving
Get Signature
get isMoving():
true
Defined in: contexts/index.d.ts:1138
Optional. True, if the background moves slightly when the device is tilted
Returns
true
type
Get Signature
get type():
"wallpaper"
Defined in: contexts/index.d.ts:1122
Type of the background, always “wallpaper”
Returns
"wallpaper"