Interface IStructureService

Interface for accessing the structure of the application, including areas, elements, sections, and views.

Namespace: DataWeb.Structure

Assembly: DataWeb.Core.dll

Syntax

public interface IStructureService

Methods

GetAllAreasAsync(CancellationToken)

Get all areas in the application.

Declaration

Task<IEnumerable<Area>> GetAllAreasAsync(CancellationToken cancellationToken = default)

Parameters

Type	Name	Description
CancellationToken	cancellationToken

Returns

Type	Description
Task<IEnumerable<Area>>	A collection of all areas in the application.

GetAreaAsync(string, CancellationToken)

Get an area with the given name.

Declaration

Task<Area> GetAreaAsync(string name, CancellationToken cancellationToken = default)

Parameters

Type	Name	Description
string	name	The name of the area.
CancellationToken	cancellationToken

Returns

Type	Description
Task<Area>	The area object.

GetElementAsync(string, CancellationToken)

Get an element with the given name.

Declaration

Task<Element> GetElementAsync(string name, CancellationToken cancellationToken = default)

Parameters

Type	Name	Description
string	name	The name of the element.
CancellationToken	cancellationToken

Returns

Type	Description
Task<Element>	The element object.

GetElementsAsync(CancellationToken)

Get all elements in the application.

Declaration

Task<IEnumerable<Element>> GetElementsAsync(CancellationToken cancellationToken = default)

Parameters

Type	Name	Description
CancellationToken	cancellationToken

Returns

Type	Description
Task<IEnumerable<Element>>	A collection of all elements in the application.

GetExplorerModuleAsync(Section, NavigationContext, CancellationToken)

Get the explorer module for the given section and navigation context.

Declaration

Task<Module> GetExplorerModuleAsync(Section section, NavigationContext navigationContext, CancellationToken cancellationToken = default)

Parameters

Type	Name	Description
Section	section	The Section object.
NavigationContext	navigationContext	The NavigationContext object.
CancellationToken	cancellationToken

Returns

Type	Description
Task<Module>	The explorer module.

GetSectionAsync(string, CancellationToken)

Get a section with the given name.

Declaration

Task<Section> GetSectionAsync(string name, CancellationToken cancellationToken = default)

Parameters

Type	Name	Description
string	name	The name of the section.
CancellationToken	cancellationToken

Returns

Type	Description
Task<Section>	The section object.

GetSectionsAsync(CancellationToken)

Get all sections in the application.

Declaration

Task<IEnumerable<Section>> GetSectionsAsync(CancellationToken cancellationToken = default)

Parameters

Type	Name	Description
CancellationToken	cancellationToken

Returns

Type	Description
Task<IEnumerable<Section>>	A collection of all sections in the application.

GetUserAreasAsync(IUser, CancellationToken)

Get all areas that the specified user has access to.

Declaration

Task<IEnumerable<Area>> GetUserAreasAsync(IUser user, CancellationToken cancellationToken = default)

Parameters

Type	Name	Description
IUser	user	The IUser object representing the current user.
CancellationToken	cancellationToken

Returns

Type	Description
Task<IEnumerable<Area>>	A collection of areas that the user can access.

GetViewAsync(string, CancellationToken)

Get a view with the given name.

Declaration

Task<View> GetViewAsync(string name, CancellationToken cancellationToken = default)

Parameters

Type	Name	Description
string	name	The name of the view.
CancellationToken	cancellationToken

Returns

Type	Description
Task<View>	The view object.

GetViewsAsync(CancellationToken)

Get all views in the application.

Declaration

Task<IEnumerable<View>> GetViewsAsync(CancellationToken cancellationToken = default)

Parameters

Type	Name	Description
CancellationToken	cancellationToken

Returns

Type	Description
Task<IEnumerable<View>>	A collection of all views in the application.