Interface IUserSettingStore

Provides an interface for a user settings store.

Namespace: DataWeb.Identity

Assembly: DataWeb.Core.dll

Syntax

public interface IUserSettingStore

Properties

Name

Gets the name of the store.

Declaration

string Name { get; }

Property Value

Type	Description
string

Methods

ExistsAsync(string, string, string, CancellationToken)

Determines whether a specific user setting exists for a given user, setting name, and navigation path.

Declaration

Task<bool> ExistsAsync(string userIdMaster, string name, string navigationPath = null, CancellationToken cancellationToken = default)

Parameters

Type	Name	Description
string	userIdMaster	The user Id.
string	name	The name of the setting.
string	navigationPath	The navigation path.
CancellationToken	cancellationToken

Returns

Type	Description
Task<bool>	true if the setting exists; otherwise, false.

GetSettingAsync(string, string, string, CancellationToken)

Retrieves a specific user setting for a given user, setting name, and navigation path.

Declaration

Task<string> GetSettingAsync(string userIdMaster, string name, string navigationPath = null, CancellationToken cancellationToken = default)

Parameters

Type	Name	Description
string	userIdMaster	The user Id.
string	name	The name of the setting.
string	navigationPath	The navigation path.
CancellationToken	cancellationToken

Returns

Type	Description
Task<string>	The value of the setting, or null if the setting does not exist.

GetSettingsAsync(string, string, CancellationToken)

Retrieves the user settings for a given user and navigation path.

Declaration

Task<IEnumerable<UserSetting>> GetSettingsAsync(string userIdMaster, string navigationPath = null, CancellationToken cancellationToken = default)

Parameters

Type	Name	Description
string	userIdMaster	The user Id.
string	navigationPath	The navigation path.
CancellationToken	cancellationToken

Returns

Type	Description
Task<IEnumerable<UserSetting>>	The user settings.

RemoveAllAsync(string, CancellationToken)

Removes all user settings for a given user.

Declaration

Task RemoveAllAsync(string userIdMaster, CancellationToken cancellationToken = default)

Parameters

Type	Name	Description
string	userIdMaster	The user Id.
CancellationToken	cancellationToken

Returns

Type	Description
Task	A task representing the operation.

RemoveAsync(string, string, string, CancellationToken)

Removes a specific user setting for a given user, setting name, and navigation path.

Declaration

Task RemoveAsync(string userIdMaster, string name, string navigationPath = null, CancellationToken cancellationToken = default)

Parameters

Type	Name	Description
string	userIdMaster	The user Id.
string	name	The name of the setting.
string	navigationPath	The navigation path.
CancellationToken	cancellationToken

Returns

Type	Description
Task	A task representing the operation.

SetAsync(string, string, string, string, CancellationToken)

Sets the value of a specific user setting for a given user, setting name, and navigation path.

Declaration

Task SetAsync(string userIdMaster, string name, string value, string navigationPath = null, CancellationToken cancellationToken = default)

Parameters

Type	Name	Description
string	userIdMaster	The user Id.
string	name	The name of the setting.
string	value	The value of the setting.
string	navigationPath	The navigation path.
CancellationToken	cancellationToken

Returns

Type	Description
Task	A task representing the operation.