Class LicensesRestService

Namespace

OpenSettings.Services.Rest

Assembly

OpenSettings.dll

public class LicensesRestService : ILicensesRestService, ILicensesService

Inheritance

object

LicensesRestService

Implements

ILicensesRestService

ILicensesService

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Constructors

LicensesRestService(HttpClient)

public LicensesRestService(HttpClient httpClient)

Parameters

httpClient HttpClient

Methods

DeleteLicenseAsync(DeleteLicenseInput, CancellationToken)

Deletes a license based on the provided input parameters.

public Task<IResponse> DeleteLicenseAsync(DeleteLicenseInput input, CancellationToken cancellationToken)

Parameters

input DeleteLicenseInput

The input parameters required to delete the license.

cancellationToken CancellationToken

A cancellation token to cancel the operation.

Returns

Task<IResponse>

A task that represents the asynchronous operation. The task result contains an Ogu.Response.Abstractions.IResponse indicating the success or failure of the operation.

GetCurrentLicenseAsync(CancellationToken)

Retrieves the current active license. This method never returns a failure.

public Task<IResponse<License>> GetCurrentLicenseAsync(CancellationToken cancellationToken)

Parameters

cancellationToken CancellationToken

A cancellation token to cancel the operation.

Returns

Task<IResponse<License>>

A task that represents the asynchronous operation. The task result contains an Ogu.Response.Abstractions.IResponse with the license data. See data type: License.

GetPaginatedLicensesAsync(GetPaginatedLicensesInput, CancellationToken)

Retrieves a paginated list of licenses based on the provided input.

public Task<IResponse> GetPaginatedLicensesAsync(GetPaginatedLicensesInput input, CancellationToken cancellationToken)

Parameters

input GetPaginatedLicensesInput

The input parameters for pagination and filtering.

cancellationToken CancellationToken

A cancellation token to cancel the operation.

Returns

Task<IResponse>

A task that represents the asynchronous operation. The task result contains an Ogu.Response.Abstractions.IResponse with the paginated list of licenses. See data type: GetPaginatedLicensesResponse.

SaveLicenseAsync(string, CancellationToken)

Saves the provided license key.

public Task<IResponse> SaveLicenseAsync(string licenseKey, CancellationToken cancellationToken)

Parameters

licenseKey string

The license key to be saved.

cancellationToken CancellationToken

A cancellation token to cancel the operation.

Returns

Task<IResponse>

A task that represents the asynchronous operation. The task result contains an Ogu.Response.Abstractions.IResponse with the license data. See data type: License.