Skip to main content

Class: WallpaperSettings

Defined in: WAProto/index.d.ts:49101

Represents a WallpaperSettings.

Implements​

Constructors​

new WallpaperSettings()​

new WallpaperSettings(properties?): WallpaperSettings

Defined in: WAProto/index.d.ts:49107

Constructs a new WallpaperSettings.

Parameters​

properties?​

IWallpaperSettings

Properties to set

Returns​

WallpaperSettings

Properties​

filename?​

optional filename: null | string

Defined in: WAProto/index.d.ts:49110

WallpaperSettings filename.

Implementation of​

IWallpaperSettings.filename

opacity?​

optional opacity: null | number

Defined in: WAProto/index.d.ts:49113

WallpaperSettings opacity.

Implementation of​

IWallpaperSettings.opacity

Methods​

toJSON()​

toJSON(): object

Defined in: WAProto/index.d.ts:49183

Converts this WallpaperSettings to JSON.

Returns​

object

JSON object

create()​

static create(properties?): WallpaperSettings

Defined in: WAProto/index.d.ts:49120

Creates a new WallpaperSettings instance using the specified properties.

Parameters​

properties?​

IWallpaperSettings

Properties to set

Returns​

WallpaperSettings

WallpaperSettings instance

decode()​

static decode(reader, length?): WallpaperSettings

Defined in: WAProto/index.d.ts:49146

Decodes a WallpaperSettings message from the specified reader or buffer.

Parameters​

reader​

Reader or buffer to decode from

Uint8Array<ArrayBufferLike> | Reader

length?​

number

Message length if known beforehand

Returns​

WallpaperSettings

WallpaperSettings

Throws​

If the payload is not a reader or valid buffer

Throws​

If required fields are missing

decodeDelimited()​

static decodeDelimited(reader): WallpaperSettings

Defined in: WAProto/index.d.ts:49155

Decodes a WallpaperSettings message from the specified reader or buffer, length delimited.

Parameters​

reader​

Reader or buffer to decode from

Uint8Array<ArrayBufferLike> | Reader

Returns​

WallpaperSettings

WallpaperSettings

Throws​

If the payload is not a reader or valid buffer

Throws​

If required fields are missing

encode()​

static encode(message, writer?): Writer

Defined in: WAProto/index.d.ts:49128

Encodes the specified WallpaperSettings message. Does not implicitly verify messages.

Parameters​

message​

IWallpaperSettings

WallpaperSettings message or plain object to encode

writer?​

Writer

Writer to encode to

Returns​

Writer

Writer

encodeDelimited()​

static encodeDelimited(message, writer?): Writer

Defined in: WAProto/index.d.ts:49136

Encodes the specified WallpaperSettings message, length delimited. Does not implicitly verify messages.

Parameters​

message​

IWallpaperSettings

WallpaperSettings message or plain object to encode

writer?​

Writer

Writer to encode to

Returns​

Writer

Writer

fromObject()​

static fromObject(object): WallpaperSettings

Defined in: WAProto/index.d.ts:49169

Creates a WallpaperSettings message from a plain object. Also converts values to their respective internal types.

Parameters​

object​

Plain object

Returns​

WallpaperSettings

WallpaperSettings

getTypeUrl()​

static getTypeUrl(typeUrlPrefix?): string

Defined in: WAProto/index.d.ts:49190

Gets the default type url for WallpaperSettings

Parameters​

typeUrlPrefix?​

string

your custom typeUrlPrefix(default "type.googleapis.com")

Returns​

string

The default type url

toObject()​

static toObject(message, options?): object

Defined in: WAProto/index.d.ts:49177

Creates a plain object from a WallpaperSettings message. Also converts values to other types if specified.

Parameters​

message​

WallpaperSettings

WallpaperSettings

options?​

IConversionOptions

Conversion options

Returns​

object

Plain object

verify()​

static verify(message): null | string

Defined in: WAProto/index.d.ts:49162

Verifies a WallpaperSettings message.

Parameters​

message​

Plain object to verify

Returns​

null | string

null if valid, otherwise the reason why it is not