Class KodiSettingsNamespace

Index

Constructors

Methods

GetCategories GetSections GetSettings GetSettingValue GetSkinSettings GetSkinSettingValue ResetSettingValue SetSettingValue SetSkinSettingValue

Constructors

constructor

new KodiSettingsNamespace(sendMessage: ISendMessage): KodiSettingsNamespace
Parameters
- sendMessage: ISendMessage
Returns KodiSettingsNamespace
- Defined in generated/namespaces/settings.ts:26

Methods

GetCategories

GetCategories(
params: SettingsGetCategoriesParams,
): Promise<SettingsGetCategoriesResponse>
Retrieves all setting categories
Parameters
- params: SettingsGetCategoriesParams
Returns Promise<SettingsGetCategoriesResponse>
SettingsGetCategoriesResponse
- Defined in generated/namespaces/settings.ts:37

GetSections

GetSections(
params: SettingsGetSectionsParams,
): Promise<SettingsGetSectionsResponse>
Retrieves all setting sections
Parameters
- params: SettingsGetSectionsParams
Returns Promise<SettingsGetSectionsResponse>
SettingsGetSectionsResponse
- Defined in generated/namespaces/settings.ts:47

GetSettings

GetSettings(
params: SettingsGetSettingsParams,
): Promise<SettingsGetSettingsResponse>
Retrieves all settings
Parameters
- params: SettingsGetSettingsParams
Returns Promise<SettingsGetSettingsResponse>
SettingsGetSettingsResponse
- Defined in generated/namespaces/settings.ts:66

GetSettingValue

GetSettingValue(
params: SettingsGetSettingValueParams,
): Promise<SettingsGetSettingValueResponse>
Retrieves the value of a setting
Parameters
- params: SettingsGetSettingValueParams
Returns Promise<SettingsGetSettingValueResponse>
SettingsGetSettingValueResponse
- Defined in generated/namespaces/settings.ts:56

GetSkinSettings

GetSkinSettings(): Promise<SettingsGetSkinSettingsResponse>
Retrieves all skin settings of the currently used skin

Returns Promise<SettingsGetSkinSettingsResponse>
SettingsGetSkinSettingsResponse
- Defined in generated/namespaces/settings.ts:83

GetSkinSettingValue

GetSkinSettingValue(
params: SettingsGetSkinSettingValueParams,
): Promise<SettingsGetSkinSettingValueResponse>
Retrieves the value of the specified skin setting
Parameters
- params: SettingsGetSkinSettingValueParams
Returns Promise<SettingsGetSkinSettingValueResponse>
SettingsGetSkinSettingValueResponse
- Defined in generated/namespaces/settings.ts:75

ResetSettingValue

ResetSettingValue(params: SettingsResetSettingValueParams): Promise<string>
Resets the value of a setting
Parameters
- params: SettingsResetSettingValueParams
Returns Promise<string>
string
- Defined in generated/namespaces/settings.ts:92

SetSettingValue

SetSettingValue(params: SettingsSetSettingValueParams): Promise<boolean>
Changes the value of a setting
Parameters
- params: SettingsSetSettingValueParams
Returns Promise<boolean>
boolean
- Defined in generated/namespaces/settings.ts:102

SetSkinSettingValue

SetSkinSettingValue(params: SettingsSetSkinSettingValueParams): Promise<boolean>
Changes the value of the specified skin setting
Parameters
- params: SettingsSetSkinSettingValueParams
Returns Promise<boolean>
boolean
- Defined in generated/namespaces/settings.ts:112