Table of Contents

Interface IInboxApi

Namespace
MegaForm.Sdk
Assembly
MegaForm.Sdk.dll

Human-task inbox facade for same-host dashboard integrations.

public interface IInboxApi

Methods

ApproveAsync(InboxTaskActionRequest, MegaFormScope?, CancellationToken)

Approve an open task and resume the workflow.

Task<InboxTaskResultDto> ApproveAsync(InboxTaskActionRequest request, MegaFormScope? scope = null, CancellationToken cancellationToken = default)

Parameters

request InboxTaskActionRequest
scope MegaFormScope
cancellationToken CancellationToken

Returns

Task<InboxTaskResultDto>

AttachFileAsync(InboxFileAttachmentRequest, MegaFormScope?, CancellationToken)

Attach a file to the task's linked submission, then return the stored file metadata.

Task<InboxFileAttachmentResultDto> AttachFileAsync(InboxFileAttachmentRequest request, MegaFormScope? scope = null, CancellationToken cancellationToken = default)

Parameters

request InboxFileAttachmentRequest
scope MegaFormScope
cancellationToken CancellationToken

Returns

Task<InboxFileAttachmentResultDto>

ClaimAsync(InboxTaskActionRequest, MegaFormScope?, CancellationToken)

Claim an open task for the current actor.

Task<InboxTaskResultDto> ClaimAsync(InboxTaskActionRequest request, MegaFormScope? scope = null, CancellationToken cancellationToken = default)

Parameters

request InboxTaskActionRequest
scope MegaFormScope
cancellationToken CancellationToken

Returns

Task<InboxTaskResultDto>

CommentAsync(InboxTaskActionRequest, MegaFormScope?, CancellationToken)

Add a comment to an open task without changing its state.

Task<InboxTaskResultDto> CommentAsync(InboxTaskActionRequest request, MegaFormScope? scope = null, CancellationToken cancellationToken = default)

Parameters

request InboxTaskActionRequest
scope MegaFormScope
cancellationToken CancellationToken

Returns

Task<InboxTaskResultDto>

ForwardAsync(InboxTaskActionRequest, MegaFormScope?, CancellationToken)

Forward an open task to another user or role target.

Task<InboxTaskResultDto> ForwardAsync(InboxTaskActionRequest request, MegaFormScope? scope = null, CancellationToken cancellationToken = default)

Parameters

request InboxTaskActionRequest
scope MegaFormScope
cancellationToken CancellationToken

Returns

Task<InboxTaskResultDto>

GetMyInboxAsync(InboxQuery?, MegaFormScope?, CancellationToken)

Return the current actor's workboard: incoming, in-progress, completed, and KPI counts.

Task<InboxBoardDto> GetMyInboxAsync(InboxQuery? query = null, MegaFormScope? scope = null, CancellationToken cancellationToken = default)

Parameters

query InboxQuery
scope MegaFormScope
cancellationToken CancellationToken

Returns

Task<InboxBoardDto>

GetTaskAsync(string, MegaFormScope?, CancellationToken)

Load one visible task with action history and linked submission summary.

Task<InboxTaskResultDto> GetTaskAsync(string taskId, MegaFormScope? scope = null, CancellationToken cancellationToken = default)

Parameters

taskId string
scope MegaFormScope
cancellationToken CancellationToken

Returns

Task<InboxTaskResultDto>

RejectAsync(InboxTaskActionRequest, MegaFormScope?, CancellationToken)

Reject an open task and resume the workflow.

Task<InboxTaskResultDto> RejectAsync(InboxTaskActionRequest request, MegaFormScope? scope = null, CancellationToken cancellationToken = default)

Parameters

request InboxTaskActionRequest
scope MegaFormScope
cancellationToken CancellationToken

Returns

Task<InboxTaskResultDto>

SendSubmissionAsync(SendSubmissionToInboxRequest, MegaFormScope?, CancellationToken)

Create a one-step review task for a submission without requiring a preconfigured workflow.

Task<InboxSendSubmissionResultDto> SendSubmissionAsync(SendSubmissionToInboxRequest request, MegaFormScope? scope = null, CancellationToken cancellationToken = default)

Parameters

request SendSubmissionToInboxRequest
scope MegaFormScope
cancellationToken CancellationToken

Returns

Task<InboxSendSubmissionResultDto>