Interface ISettingsClient
このページの翻訳はAIによって自動的に行われました。可能な限り正確な翻訳を心掛けていますが、原文と異なる表現や解釈が含まれる場合があります。正確で公式な情報については、必ず英語の原文をご参照ください。
Client for fetching setting and category entities.
Namespace: Stylelabs.M.Sdk.Clients
Assembly: Stylelabs.M.Sdk.dll
Syntax
Methods
GetCategoryIdAsync(String)
Gets the id of a category by name.
Declaration
Parameters
| Type | Name | Description |
|---|---|---|
| System.String | name |
Returns
| Type | Description |
|---|---|
| Task<System.Nullable<System.Int64>> |
Id of the category entity. |
GetSettingAsync(String, String, IEntityLoadConfiguration)
Gets the setting with the specified name from the specified category.
If the category or setting could not be found, null is returned.
Declaration
Parameters
| Type | Name | Description |
|---|---|---|
| System.String | category |
The category to get the setting from. |
| System.String | name |
The name of the setting to get. |
| IEntityLoadConfiguration | loadConfiguration |
Load configuration. |
Returns
| Type | Description |
|---|---|
| Task<IEntity> |
The setting with the specified name from the specified category or null if that setting doesn't exist. |
GetSettingsForCategoryAsync(String, IEntityLoadConfiguration)
Gets the settings for the specified category.
Declaration
Parameters
| Type | Name | Description |
|---|---|---|
| System.String | category |
The category to get the setting for. |
| IEntityLoadConfiguration | loadConfiguration |
Load configuration. |
Returns
| Type | Description |
|---|---|
| Task<IList<IEntity>> |
A list of all setting entities for the specified category. |
Exceptions
| Type | Condition |
|---|---|
| NotFoundException |
Unable to find the category with the specified name. |