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()
Get all areas in the application.
Declaration
Task<IEnumerable<Area>> GetAllAreasAsync()
Returns
Type | Description |
---|---|
Task<IEnumerable<Area>> | A collection of all areas in the application. |
GetAreaAsync(string)
Get an area with the given name.
Declaration
Task<Area> GetAreaAsync(string name)
Parameters
Type | Name | Description |
---|---|---|
string | name | The name of the area. |
Returns
Type | Description |
---|---|
Task<Area> | The area object. |
GetElementAsync(string)
Get an element with the given name.
Declaration
Task<Element> GetElementAsync(string name)
Parameters
Type | Name | Description |
---|---|---|
string | name | The name of the element. |
Returns
Type | Description |
---|---|
Task<Element> | The element object. |
GetElementsAsync()
Get all elements in the application.
Declaration
Task<IEnumerable<Element>> GetElementsAsync()
Returns
Type | Description |
---|---|
Task<IEnumerable<Element>> | A collection of all elements in the application. |
GetExplorerModuleAsync(Section, NavigationContext)
Get the explorer module for the given section and navigation context.
Declaration
Task<ModuleBase> GetExplorerModuleAsync(Section section, NavigationContext navigationContext)
Parameters
Type | Name | Description |
---|---|---|
Section | section | The Section object. |
NavigationContext | navigationContext | The NavigationContext object. |
Returns
Type | Description |
---|---|
Task<ModuleBase> | The explorer module. |
GetSectionAsync(string)
Get a section with the given name.
Declaration
Task<Section> GetSectionAsync(string name)
Parameters
Type | Name | Description |
---|---|---|
string | name | The name of the section. |
Returns
Type | Description |
---|---|
Task<Section> | The section object. |
GetSectionsAsync()
Get all sections in the application.
Declaration
Task<IEnumerable<Section>> GetSectionsAsync()
Returns
Type | Description |
---|---|
Task<IEnumerable<Section>> | A collection of all sections in the application. |
GetUserAreasAsync(IUser)
Get all areas that the specified user has access to.
Declaration
Task<IEnumerable<Area>> GetUserAreasAsync(IUser user)
Parameters
Type | Name | Description |
---|---|---|
IUser | user | The IUser object representing the current user. |
Returns
Type | Description |
---|---|
Task<IEnumerable<Area>> | A collection of areas that the user can access. |
GetViewAsync(string)
Get a view with the given name.
Declaration
Task<View> GetViewAsync(string name)
Parameters
Type | Name | Description |
---|---|---|
string | name | The name of the view. |
Returns
Type | Description |
---|---|
Task<View> | The view object. |
GetViewsAsync()
Get all views in the application.
Declaration
Task<IEnumerable<View>> GetViewsAsync()
Returns
Type | Description |
---|---|
Task<IEnumerable<View>> | A collection of all views in the application. |