Interface ITranslationRuleStore

The interface for a translation rule store implementation, which provides CRUD operations for entries.

Namespace: DataWeb.Localization

Assembly: DataWeb.Core.dll

Syntax

public interface ITranslationRuleStore

Properties

Name

Gets the name of the translation rule store.

Declaration

string Name { get; }

Property Value

Type	Description
string

Methods

GetTranslationRuleAsync(TranslationRuleFilter, CancellationToken)

Gets a rule that matches the specified filter.

Declaration

Task<TranslationRule> GetTranslationRuleAsync(TranslationRuleFilter filter, CancellationToken cancellationToken = default)

Parameters

Type	Name	Description
TranslationRuleFilter	filter	The TranslationRuleFilter to apply.
CancellationToken	cancellationToken

Returns

Type	Description
Task<TranslationRule>	The rule that matches the specified filter.

GetTranslationRuleCountAsync(TranslationRuleFilter, CancellationToken)

Gets the count of rules that match the specified filter.

Declaration

Task<long> GetTranslationRuleCountAsync(TranslationRuleFilter filter, CancellationToken cancellationToken = default)

Parameters

Type	Name	Description
TranslationRuleFilter	filter	The TranslationRuleFilter to apply.
CancellationToken	cancellationToken

Returns

Type	Description
Task<long>	The count of rules that match the specified filter.

GetTranslationRulesAsync(TranslationRuleFilter, CancellationToken)

Gets the translation rules.

Declaration

Task<IEnumerable<TranslationRule>> GetTranslationRulesAsync(TranslationRuleFilter filter, CancellationToken cancellationToken = default)

Parameters

Type	Name	Description
TranslationRuleFilter	filter	The TranslationRuleFilter to apply to the rules.
CancellationToken	cancellationToken

Returns

Type	Description
Task<IEnumerable<TranslationRule>>	An enumerable collection of translation rules.

RemoveAsync(string, CancellationToken)

Removes the rule with the specified Id.

Declaration

Task RemoveAsync(string id, CancellationToken cancellationToken = default)

Parameters

Type	Name	Description
string	id	The Id of the rule to remove.
CancellationToken	cancellationToken

Returns

Type	Description
Task	A task representing the asynchronous operation.

SetAsync(TranslationRule, CancellationToken)

Sets the specified rule.

Declaration

Task SetAsync(TranslationRule translationRule, CancellationToken cancellationToken = default)

Parameters

Type	Name	Description
TranslationRule	translationRule	The TranslationRule to set.
CancellationToken	cancellationToken

Returns

Type	Description
Task	A task representing the asynchronous operation.