Table of Contents

Class AppGroupsController

Namespace
OpenSettings.AspNetCore.Controllers.v1
Assembly
OpenSettings.AspNetCore.dll
[Route("v1/app-groups")]
public class AppGroupsController : ControllerBase
Inheritance
AppGroupsController
Inherited Members

Constructors

AppGroupsController(IAppGroupsService)

public AppGroupsController(IAppGroupsService appGroupsService)

Parameters

appGroupsService IAppGroupsService

Methods

CreateGroup(CreateAppGroupRequest, CancellationToken)

[HttpPost]
public Task<IActionResult> CreateGroup(CreateAppGroupRequest request, CancellationToken cancellationToken = default)

Parameters

request CreateAppGroupRequest
cancellationToken CancellationToken

Returns

Task<IActionResult>

DeleteGroup(DeleteAppGroupRequest, CancellationToken)

[HttpDelete("{GroupId}")]
public Task<IActionResult> DeleteGroup(DeleteAppGroupRequest request, CancellationToken cancellationToken = default)

Parameters

request DeleteAppGroupRequest
cancellationToken CancellationToken

Returns

Task<IActionResult>

DeleteUnmappedGroups(CancellationToken)

[HttpDelete("unmapped")]
public Task<IActionResult> DeleteUnmappedGroups(CancellationToken cancellationToken = default)

Parameters

cancellationToken CancellationToken

Returns

Task<IActionResult>

DragGroup(DragItemSortOrderRequest, CancellationToken)

[HttpPost("{SourceId}/drag/{TargetId}")]
public Task<IActionResult> DragGroup(DragItemSortOrderRequest request, CancellationToken cancellationToken = default)

Parameters

request DragItemSortOrderRequest
cancellationToken CancellationToken

Returns

Task<IActionResult>

GetGroupById(GetAppGroupRequest, CancellationToken)

[HttpGet("{GroupIdOrSlug}")]
public Task<IActionResult> GetGroupById(GetAppGroupRequest request, CancellationToken cancellationToken = default)

Parameters

request GetAppGroupRequest
cancellationToken CancellationToken

Returns

Task<IActionResult>

GetGroupBySlug(GetAppGroupRequest, CancellationToken)

[HttpGet("slug/{GroupIdOrSlug}")]
public Task<IActionResult> GetGroupBySlug(GetAppGroupRequest request, CancellationToken cancellationToken = default)

Parameters

request GetAppGroupRequest
cancellationToken CancellationToken

Returns

Task<IActionResult>

GetGroups(GetAppGroupsRequest, CancellationToken)

[HttpGet]
public Task<IActionResult> GetGroups(GetAppGroupsRequest request, CancellationToken cancellationToken = default)

Parameters

request GetAppGroupsRequest
cancellationToken CancellationToken

Returns

Task<IActionResult>

GetPaginatedGroups(GetPaginatedRequest, CancellationToken)

[HttpGet("paginated")]
public Task<IActionResult> GetPaginatedGroups(GetPaginatedRequest request, CancellationToken cancellationToken = default)

Parameters

request GetPaginatedRequest
cancellationToken CancellationToken

Returns

Task<IActionResult>

ReorderGroups()

[HttpPost("reorder")]
public Task<IActionResult> ReorderGroups()

Returns

Task<IActionResult>

UpdateGroup(UpdateAppGroupRequest, CancellationToken)

[HttpPut("{GroupId}")]
public Task<IActionResult> UpdateGroup(UpdateAppGroupRequest request, CancellationToken cancellationToken = default)

Parameters

request UpdateAppGroupRequest
cancellationToken CancellationToken

Returns

Task<IActionResult>

UpdateGroupSortOrder(UpdateAppGroupSortOrderRequest, CancellationToken)

[HttpPost("{GroupId}/sort-order")]
public Task<IActionResult> UpdateGroupSortOrder(UpdateAppGroupSortOrderRequest request, CancellationToken cancellationToken = default)

Parameters

request UpdateAppGroupSortOrderRequest
cancellationToken CancellationToken

Returns

Task<IActionResult>