Interface IAliasService

Namespace

Oqtane.Services

Assembly

Oqtane.Client.dll

Service to retrieve and store Alias information.

public interface IAliasService

Methods

AddAliasAsync(Alias)

Save another Alias in the DB. It must already contain all the information incl. Tenant it belongs to.

Task<Alias> AddAliasAsync(Alias alias)

Parameters

alias Alias

An Alias to add.

Returns

Task<Alias>

DeleteAliasAsync(int)

Remove an Alias from the DB.

Task DeleteAliasAsync(int aliasId)

Parameters

aliasId int

The Alias ID, not to be confused with a Site ID.

Returns

Task

GetAliasAsync(int)

Get a single alias

Task<Alias> GetAliasAsync(int aliasId)

Parameters

aliasId int

The Alias ID, not to be confused with a Site ID

Returns

Task<Alias>

GetAliasesAsync()

Get all aliases in the system

Task<List<Alias>> GetAliasesAsync()

Returns

Task<List<Alias>>

UpdateAliasAsync(Alias)

Update an Alias in the DB. Make sure the object is correctly filled, as it must update an existing record.

Task<Alias> UpdateAliasAsync(Alias alias)

Parameters

alias Alias

The Alias to update.

Returns

Task<Alias>