Class FormController

Inheritance
object
FormController
Implements
IApplicationService
IRemoteService
Namespace: Volo.Forms.Forms
Assembly: Volo.Forms.HttpApi.dll
Syntax
[Area("form")]
[Route("api/forms")]
public class FormController : AbpControllerBase, IFormAppService, IApplicationService, IRemoteService

Constructors

FormController(IFormAppService)

Declaration
public FormController(IFormAppService formAppService)
Parameters
Type Name Description
IFormAppService formAppService

Properties

FormAppService

Declaration
protected IFormAppService FormAppService { get; }
Property Value
Type Description
IFormAppService

Methods

CreateAsync(CreateFormDto)

Declaration
[HttpPost]
public virtual Task<FormDto> CreateAsync(CreateFormDto input)
Parameters
Type Name Description
CreateFormDto input
Returns
Type Description
Task<FormDto>

CreateQuestionAsync(Guid, CreateQuestionDto)

Declaration
[HttpPost]
[Route("{id}/questions")]
public virtual Task<QuestionDto> CreateQuestionAsync(Guid id, CreateQuestionDto input)
Parameters
Type Name Description
Guid id
CreateQuestionDto input
Returns
Type Description
Task<QuestionDto>

DeleteAllResponsesOfFormAsync(Guid)

Declaration
[HttpDelete]
[Route("{id}/responses")]
public Task DeleteAllResponsesOfFormAsync(Guid id)
Parameters
Type Name Description
Guid id
Returns
Type Description
Task

DeleteAsync(Guid)

Declaration
[HttpDelete]
[Route("{id}")]
public virtual Task DeleteAsync(Guid id)
Parameters
Type Name Description
Guid id
Returns
Type Description
Task

GetAsync(Guid)

Declaration
[HttpGet]
[Route("{id}")]
public virtual Task<FormWithDetailsDto> GetAsync(Guid id)
Parameters
Type Name Description
Guid id
Returns
Type Description
Task<FormWithDetailsDto>

GetCsvResponsesAsync(Guid, GetResponseListInputDto)

Declaration
[HttpGet]
[Route("{id}/download-responses-csv")]
public Task<IRemoteStreamContent> GetCsvResponsesAsync(Guid id, GetResponseListInputDto input)
Parameters
Type Name Description
Guid id
GetResponseListInputDto input
Returns
Type Description
Task<IRemoteStreamContent>

GetListAsync(GetFormListInputDto)

Declaration
[HttpGet]
public virtual Task<PagedResultDto<FormDto>> GetListAsync(GetFormListInputDto input)
Parameters
Type Name Description
GetFormListInputDto input
Returns
Type Description
Task<PagedResultDto<FormDto>>

GetQuestionsAsync(Guid, GetQuestionListDto)

Declaration
[HttpGet]
[Route("{id}/questions")]
public virtual Task<List<QuestionDto>> GetQuestionsAsync(Guid id, GetQuestionListDto input)
Parameters
Type Name Description
Guid id
GetQuestionListDto input
Returns
Type Description
Task<List<QuestionDto>>

GetResponsesAsync(Guid, GetResponseListInputDto)

Declaration
[HttpGet]
[Route("{id}/responses")]
public Task<PagedResultDto<FormResponseDetailedDto>> GetResponsesAsync(Guid id, GetResponseListInputDto input)
Parameters
Type Name Description
Guid id
GetResponseListInputDto input
Returns
Type Description
Task<PagedResultDto<FormResponseDetailedDto>>

GetResponsesCountAsync(Guid)

Declaration
[HttpGet]
[Route("{id}/responses-count")]
public Task<long> GetResponsesCountAsync(Guid id)
Parameters
Type Name Description
Guid id
Returns
Type Description
Task<long>

GetSettingsAsync(Guid)

Declaration
[HttpGet]
[Route("{id}/settings")]
public virtual Task<FormSettingsDto> GetSettingsAsync(Guid id)
Parameters
Type Name Description
Guid id
Returns
Type Description
Task<FormSettingsDto>

SendInviteEmailAsync(FormInviteEmailInputDto)

Declaration
[HttpPost]
[Route("/invite")]
public Task SendInviteEmailAsync(FormInviteEmailInputDto input)
Parameters
Type Name Description
FormInviteEmailInputDto input
Returns
Type Description
Task

SetSettingsAsync(Guid, UpdateFormSettingInputDto)

Declaration
[HttpPut]
[Route("{id}/settings")]
public virtual Task SetSettingsAsync(Guid id, UpdateFormSettingInputDto input)
Parameters
Type Name Description
Guid id
UpdateFormSettingInputDto input
Returns
Type Description
Task

UpdateAsync(Guid, UpdateFormDto)

Declaration
[HttpPut]
[Route("{id}")]
public virtual Task<FormDto> UpdateAsync(Guid id, UpdateFormDto input)
Parameters
Type Name Description
Guid id
UpdateFormDto input
Returns
Type Description
Task<FormDto>

Implements

Volo.Abp.Application.Services.IApplicationService
Volo.Abp.IRemoteService