Interface IDeviceSettings

Interface that provides the methods that may be used to interact with the settings on a device.

interface IDeviceSettings {
    delete(key: string): Promise<void>;
    getKeys(): Promise<string[]>;
    getProperties(): Promise<IDeviceSettingProperty[]>;
    getValue(key: string): Promise<DeviceSettingValue>;
    save(): Promise<void>;
    setValue(key: string, value: DeviceSettingValue): Promise<void>;
}

Index

Methods

delete getKeys getProperties getValue save setValue

Methods

delete

delete(key: string): Promise<void>
Deletes a device setting.
Parameters
- key: string
  The key of the device setting to delete.
Returns Promise<void>
- A promise that resolves when the device setting is deleted.

getKeys

getKeys(): Promise<string[]>
Retrieves the list of device settings keys.

Returns Promise<string[]>
- A promise that resolves to an array of device setting keys.

getProperties

getProperties(): Promise<IDeviceSettingProperty[]>
Retrieves the list of device settings properties.

Returns Promise<IDeviceSettingProperty[]>
- A promise that resolves to an array of device setting properties.

getValue

getValue(key: string): Promise<DeviceSettingValue>
Retrieves the value of a device setting.
Parameters
- key: string
  The key of the device setting.
Returns Promise<DeviceSettingValue>
- A promise that resolves to the value of the device setting.

save

save(): Promise<void>
Saves the current device settings to persistent storage.

Returns Promise<void>
- A promise that resolves when the settings are saved.

setValue

setValue(key: string, value: DeviceSettingValue): Promise<void>
Sets the value of a device setting.
Parameters
- key: string
  The key of the device setting.
- value: DeviceSettingValue
  The value to apply to the device setting.
Returns Promise<void>
- A promise that resolves when the value is set.