Interface IModuleDefinitionService

Namespace

Oqtane.Services

Assembly

Oqtane.Client.dll

Service to manage a ModuleDefinition

public interface IModuleDefinitionService

Methods

CreateModuleDefinitionAsync(ModuleDefinition)

Creates a new module definition

Task<ModuleDefinition> CreateModuleDefinitionAsync(ModuleDefinition moduleDefinition)

Parameters

moduleDefinition ModuleDefinition

Returns

Task<ModuleDefinition>

DeleteModuleDefinitionAsync(int, int)

Deletes a module definition

Task DeleteModuleDefinitionAsync(int moduleDefinitionId, int siteId)

Parameters

moduleDefinitionId int

siteId int

Returns

Task

GetModuleDefinitionAsync(int, int)

Returns a specific module definition

Task<ModuleDefinition> GetModuleDefinitionAsync(int moduleDefinitionId, int siteId)

Parameters

moduleDefinitionId int

siteId int

Returns

Task<ModuleDefinition>

GetModuleDefinitionTemplatesAsync()

Returns a list of module definition templates

Task<List<Template>> GetModuleDefinitionTemplatesAsync()

Returns

Task<List<Template>>

GetModuleDefinitionsAsync(int)

Returns a list of module definitions for the given site

Task<List<ModuleDefinition>> GetModuleDefinitionsAsync(int siteId)

Parameters

siteId int

Returns

Task<List<ModuleDefinition>>

UpdateModuleDefinitionAsync(ModuleDefinition)

Updates a existing module definition

Task UpdateModuleDefinitionAsync(ModuleDefinition moduleDefinition)

Parameters

moduleDefinition ModuleDefinition

Returns

Task