Struct SettingsApi 

pub struct SettingsApi<'a> { /* private fields */ }

Settings API methods

Implementations

impl<'a> SettingsApi<'a>

pub fn get(&self) -> SettingsFetcher<'_>

Fetch one setting Notes

• If the setting is not defined, it will default to null
• Accessing an undefined setting in the client scope will not create it

pub fn reset(&self) -> SettingReset<'_>

Notes

• If you reset a setting in the client scope, it will be deleted and no longer appear in the list action
• If the setting does not exist, the value will be null

pub fn get_multiple(&self) -> SettingsBuilder<'_>

Fetch multiple settings Notes

• If the setting is not defined, it will default to null
• Accessing an undefined setting in the client scope will not create it

pub async fn get_all(&self) -> Result<AllSettings, Error>

Fetch all the settings

pub async fn set(&self, settings: Settings) -> Result<Vec<SettingValue>, Error>

Set the value of a writable setting

pub async fn set_client<D: Serialize + DeserializeOwned>( &self, name: ClientSettings, value: D, ) -> Result<D, Error>

Set the value of a client setting Note

• If the size limitations of the client scope are exceeded, an error will be returned