Interface IFormApi

Namespace

MegaForm.Sdk

Assembly

MegaForm.Sdk.dll

Create, read, list and delete forms.

public interface IFormApi

Methods

CreateFormAsync(CreateFormRequest, MegaFormScope?, CancellationToken)

Create a new form. Returns the created form (with its new id).

Task<FormDto> CreateFormAsync(CreateFormRequest request, MegaFormScope? scope = null, CancellationToken cancellationToken = default)

Parameters

request CreateFormRequest

scope MegaFormScope

cancellationToken CancellationToken

Returns

Task<FormDto>

DeleteFormAsync(int, MegaFormScope?, CancellationToken)

Permanently delete a form.

Task DeleteFormAsync(int formId, MegaFormScope? scope = null, CancellationToken cancellationToken = default)

Parameters

formId int

scope MegaFormScope

cancellationToken CancellationToken

Returns

Task

GetFormAsync(int, MegaFormScope?, CancellationToken)

Get a single form by id, or null if not found / not in this portal.

Task<FormDto?> GetFormAsync(int formId, MegaFormScope? scope = null, CancellationToken cancellationToken = default)

Parameters

formId int

scope MegaFormScope

cancellationToken CancellationToken

Returns

Task<FormDto>

ListFormsAsync(FormQuery?, MegaFormScope?, CancellationToken)

List forms in the current portal with optional filter + paging.

Task<PagedResult<FormDto>> ListFormsAsync(FormQuery? query = null, MegaFormScope? scope = null, CancellationToken cancellationToken = default)

Parameters

query FormQuery

scope MegaFormScope

cancellationToken CancellationToken

Returns

Task<PagedResult<FormDto>>

UpdateFormAsync(int, UpdateFormRequest, MegaFormScope?, CancellationToken)

Apply a partial update to a form (only non-null members of request change). Returns the updated form. Throws InvalidOperationException when the form does not exist or belongs to another portal.

Task<FormDto> UpdateFormAsync(int formId, UpdateFormRequest request, MegaFormScope? scope = null, CancellationToken cancellationToken = default)

Parameters

formId int

request UpdateFormRequest

scope MegaFormScope

cancellationToken CancellationToken

Returns

Task<FormDto>