Interface ITermsService

Interface representing a terms service

Namespace: DataWeb.Terms

Assembly: DataWeb.Core.dll

Syntax

public interface ITermsService

Methods

GetTermsApprovalAsync(TermsApprovalFilter, CancellationToken)

Get a terms approval that matches the provided filter

Declaration

Task<TermsApproval> GetTermsApprovalAsync(TermsApprovalFilter filter, CancellationToken cancellationToken = default)

Parameters

Type	Name	Description
TermsApprovalFilter	filter	The TermsApprovalFilter to apply when retrieving a terms approval
CancellationToken	cancellationToken

Returns

Type	Description
Task<TermsApproval>	An asynchronous operation that returns a terms approval

GetTermsApprovalsAsync(TermsApprovalFilter, CancellationToken)

Get a collection of terms approvals that match the provided filter

Declaration

Task<IEnumerable<TermsApproval>> GetTermsApprovalsAsync(TermsApprovalFilter filter, CancellationToken cancellationToken = default)

Parameters

Type	Name	Description
TermsApprovalFilter	filter	The TermsApprovalFilter to apply when retrieving terms approvals
CancellationToken	cancellationToken

Returns

Type	Description
Task<IEnumerable<TermsApproval>>	An asynchronous operation that returns a collection of terms approvals

SetTermsApprovalAsync(string, string, string, string, CancellationToken)

Set a terms approval for a reference

Declaration

Task SetTermsApprovalAsync(string referenceId, string referenceType, string termsName, string termsVersion, CancellationToken cancellationToken = default)

Parameters

Type	Name	Description
string	referenceId	The unique identifier of the reference for which to set the terms approval
string	referenceType	The type of the reference for which to set the terms approval
string	termsName	The name of the terms being approved
string	termsVersion	The version of the terms being approved
CancellationToken	cancellationToken

Returns

Type	Description
Task	An asynchronous operation that sets the terms approval