Interface ISubmissionsClient
Namespace: IndicoV2-Submissions
Assembly: IndicoV2-Abstractions-dll
ISubmissionClient defines all operations on -
public interface ISubmissionsClient
Methods
Method creates -
[Obsolete("Please provide file name for each stream-", true)]
Task<IEnumerable<int>> CreateAsync(int workflowId, IEnumerable<Stream> streams, CancellationToken cancellationToken = default)
Parameters
workflowId int
Workflow Id-
streams IEnumerable[Stream](https://learn-microsoft-com/dotnet/api/system-io-stream)\
to create submissions from-
cancellationToken CancellationToken
for handling cancellation of asynchronous operations-
Returns
Task[IEnumerable](https://learn-microsoft-com/dotnet/api/system-collections-generic-ienumerable\-1)<[int](https://learn-microsoft-com/dotnet/api/system-int32)\>
of submissions ids-
CreateAsync(int, IEnumerable<(string Name, Stream Content)>, CancellationToken, SubmissionResultsFileVersion?)
Method creates -
Task<IEnumerable<int>> CreateAsync(int workflowId, IEnumerable<(string Name, Stream Content)> files, CancellationToken cancellationToken = default, SubmissionResultsFileVersion? resultsFileVersion = null)
Parameters
workflowId int
Workflow Id-
files IEnumerable<(string Name, Stream Content)>
cancellationToken CancellationToken
for handling cancellation of asynchronous operations-
resultsFileVersion SubmissionResultsFileVersion?
Optional- Specifies version to use for the results file-
Returns
Task[IEnumerable](https://learn-microsoft-com/dotnet/api/system-collections-generic-ienumerable\-1)<[int](https://learn-microsoft-com/dotnet/api/system-int32)\>
of submissions ids-
Method creates -
Task<IEnumerable<int>> CreateAsync(int workflowId, IEnumerable<Uri> uris, CancellationToken cancellationToken = default, SubmissionResultsFileVersion? resultsFileVersion = null)
Parameters
workflowId int
Workflow Id-
uris IEnumerable[Uri](https://learn-microsoft-com/dotnet/api/system-uri)\
to create submissions from-
cancellationToken CancellationToken
for handling cancellation of asynchronous operations-
resultsFileVersion SubmissionResultsFileVersion?
Returns
Task[IEnumerable](https://learn-microsoft-com/dotnet/api/system-collections-generic-ienumerable\-1)<[int](https://learn-microsoft-com/dotnet/api/system-int32)\>
of submissions ids-
Method creates -
Task<IEnumerable<int>> CreateAsync(int workflowId, IEnumerable<string> paths, CancellationToken cancellationToken = default, SubmissionResultsFileVersion? resultsFileVersion = null)
Parameters
workflowId int
Workflow Id-
paths IEnumerable[string](https://learn-microsoft-com/dotnet/api/system-string)\
Filepaths collection to create submissions from-
cancellationToken CancellationToken
for handling cancellation of asynchronous operations-
resultsFileVersion SubmissionResultsFileVersion?
Returns
Task[IEnumerable](https://learn-microsoft-com/dotnet/api/system-collections-generic-ienumerable\-1)<[int](https://learn-microsoft-com/dotnet/api/system-int32)\>
of submissions ids-
Uses the legacy C# client for older frameworks-
Task<IEnumerable<int>> CreateAsyncLegacy(int workflowId, IEnumerable<string> paths, CancellationToken cancellationToken = default)
Parameters
workflowId int
paths IEnumerable[string](https://learn-microsoft-com/dotnet/api/system-string)\
cancellationToken CancellationToken
Returns
Task[IEnumerable](https://learn-microsoft-com/dotnet/api/system-collections-generic-ienumerable\-1)<[int](https://learn-microsoft-com/dotnet/api/system-int32)\>
Generates 's result
Task<string> GenerateSubmissionResultAsync(int submissionId, CancellationToken cancellationToken = default)
Parameters
submissionId int
's Id
cancellationToken CancellationToken
for handling cancellation of asynchronous operations-
Returns
Task[string](https://learn-microsoft-com/dotnet/api/system-string)\
Created Job's Id
Method gets certain -
Task<ISubmission> GetAsync(int submissionId, CancellationToken cancellationToken = default)
Parameters
submissionId int
Submission id-
cancellationToken CancellationToken
for handling cancellation of asynchronous operations-
Returns
with provided id-
Method lists -
Task<IEnumerable<ISubmission>> ListAsync(IEnumerable<int> submissionIds, IEnumerable<int> workflowIds, IFilter filters, int limit = 1000, CancellationToken cancellationToken = default)
Parameters
submissionIds IEnumerable[int](https://learn-microsoft-com/dotnet/api/system-int32)\
Submissions ids-
workflowIds IEnumerable[int](https://learn-microsoft-com/dotnet/api/system-int32)\
Workflows ids-
filters IFilter
Submission filter- Use or composite filters with and
limit int
Limit of returned submissions- Default value is 1000-
cancellationToken CancellationToken
for handling cancellation of asynchronous operations-
Returns
Task[ienumerable](https://learn-microsoft-com/dotnet/api/system-collections-generic-ienumerable\-1)<[isubmission](indicov2-submissions-models-isubmission)\>
of Method returns a containing an enumerable of
Set after to the EndCursor of PageInfo for subsequent queries-
Task<IHasCursor<IEnumerable<ISubmission>>> ListAsync(IEnumerable<int> submissionIds, IEnumerable<int> workflowIds, IFilter filters, int? after, int limit = 1000, CancellationToken cancellationToken = default)
Parameters
submissionIds IEnumerable[int](https://learn-microsoft-com/dotnet/api/system-int32)\
workflowIds IEnumerable[int](https://learn-microsoft-com/dotnet/api/system-int32)\
filters IFilter
after int?
limit int
cancellationToken CancellationToken
Returns
Task[ihascursor](indicov2-commonmodels-pagination-ihascursor-1-md)<[ienumerable](https://learn-microsoft-com/dotnet/api/system-collections-generic-ienumerable\-1)<[isubmission](indicov2-submissions-models-isubmission)\>>
Marks a submission as retrieved- Defaults retrieved to true-
Task<ISubmission> MarkSubmissionAsRetrieved(int submissionId, bool retrieved = true, CancellationToken cancellationToken = default)
Parameters
submissionId int
retrieved bool
cancellationToken CancellationToken
Returns
Id of the submission updated-
Updated 6 months ago