Class WallpaperSettings

Represents a WallpaperSettings.

Hierarchy

WallpaperSettings

Implements

IWallpaperSettings

Index

Constructors

constructor

Properties

Methods

Constructors

constructor

new WallpaperSettings(properties?: IWallpaperSettings): WallpaperSettings

- Defined in WAProto/index.d.ts:6929
Constructs a new WallpaperSettings.

Parameters
- Optional properties: IWallpaperSettings
Returns WallpaperSettings

Properties

filename

filename: string

WallpaperSettings filename.

opacity

opacity: number

WallpaperSettings opacity.

Methods

toJSON

toJSON(): {}

- Defined in WAProto/index.d.ts:7011
Converts this WallpaperSettings to JSON.

Returns {}

JSON object
- [k: string]: any

Static create

create(properties?: IWallpaperSettings): WallpaperSettings

- Defined in WAProto/index.d.ts:6948
Creates a new WallpaperSettings instance using the specified properties.

Parameters
- Optional properties: IWallpaperSettings
Returns WallpaperSettings

WallpaperSettings instance

Static decode

decode(reader: Uint8Array | Reader, length?: number): WallpaperSettings

- Defined in WAProto/index.d.ts:6974
Decodes a WallpaperSettings message from the specified reader or buffer.

throws

{Error} If the payload is not a reader or valid buffer

throws

{$protobuf.util.ProtocolError} If required fields are missing

Parameters
- reader: Uint8Array | Reader
  
  Reader or buffer to decode from
- Optional length: number
Returns WallpaperSettings

WallpaperSettings

Static decodeDelimited

decodeDelimited(reader: Uint8Array | Reader): WallpaperSettings

- Defined in WAProto/index.d.ts:6983
Decodes a WallpaperSettings message from the specified reader or buffer, length delimited.

throws

{Error} If the payload is not a reader or valid buffer

throws

{$protobuf.util.ProtocolError} If required fields are missing

Parameters
- reader: Uint8Array | Reader
  
  Reader or buffer to decode from
Returns WallpaperSettings

WallpaperSettings

Static encode

encode(message: IWallpaperSettings, writer?: Writer): Writer

- Defined in WAProto/index.d.ts:6956
Encodes the specified WallpaperSettings message. Does not implicitly verify messages.

Parameters
- message: IWallpaperSettings
  
  WallpaperSettings message or plain object to encode
- Optional writer: Writer
Returns Writer

Writer

Static encodeDelimited

encodeDelimited(message: IWallpaperSettings, writer?: Writer): Writer

- Defined in WAProto/index.d.ts:6964
Encodes the specified WallpaperSettings message, length delimited. Does not implicitly verify messages.

Parameters
- message: IWallpaperSettings
  
  WallpaperSettings message or plain object to encode
- Optional writer: Writer
Returns Writer

Writer

Static fromObject

fromObject(object: {}): WallpaperSettings

- Defined in WAProto/index.d.ts:6997
Creates a WallpaperSettings message from a plain object. Also converts values to their respective internal types.

Parameters
- object: {}
  
  Plain object
  - [k: string]: any
Returns WallpaperSettings

WallpaperSettings

Static toObject

toObject(message: WallpaperSettings, options?: IConversionOptions): {}

- Defined in WAProto/index.d.ts:7005
Creates a plain object from a WallpaperSettings message. Also converts values to other types if specified.

Parameters
- message: WallpaperSettings
  
  WallpaperSettings
- Optional options: IConversionOptions
Returns {}

Plain object
- [k: string]: any

Static verify

verify(message: {}): string

- Defined in WAProto/index.d.ts:6990
Verifies a WallpaperSettings message.

Parameters
- message: {}
  
  Plain object to verify
  - [k: string]: any
Returns string

null if valid, otherwise the reason why it is not

Generated using TypeDoc