public interface IFlowsApiClient : IApiFilteredPageAccessor<IFlow>, IApiPageAccessor<IFlow>, IContentApiClient, INameSearchApiClient<IFlow>, IFilteredPagedListApiClient<IFlow>, IPagedListApiClient<IFlow>, IReadApiClient<IFlowDetails>, IPullApiClient<IFlow, IPublishableFlow>, IPublishApiClient<IPublishableFlow, IFlow>, IConnectionsApiClient, IOwnershipApiClient, ITagsContentApiClient, IPermissionsContentApiClient, IEmbeddedCredentialsContentApiClient

Methods

DownloadFlowAsync(Guid, CancellationToken)

Downloads the prep flow file for the given ID.

Declaration

Task<IAsyncDisposableResult<FileDownload>> DownloadFlowAsync(Guid flowId, CancellationToken cancel)

Parameters

Type	Name	Description
Guid	flowId	The ID to download the flow file for.
CancellationToken	cancel	A cancellation token to obey.

Returns

Type	Description
Task<IAsyncDisposableResult<FileDownload>>	The file download result.

PublishFlowAsync(IPublishFlowOptions, CancellationToken)

Uploads the input prep flow file.

Declaration

Task<IResult<IFlow>> PublishFlowAsync(IPublishFlowOptions options, CancellationToken cancel)

Parameters

Type	Name	Description
IPublishFlowOptions	options	The new prep flows's details.
CancellationToken	cancel	A cancellation token to obey.

Returns

Type	Description
Task<IResult<IFlow>>	The published prep flow.

UpdateFlowAsync(Guid, CancellationToken, Guid?, Guid?)

Updates the flow.

Declaration

Task<IResult<IUpdateFlowResult>> UpdateFlowAsync(Guid flowId, CancellationToken cancel, Guid? newProjectId = null, Guid? newOwnerId = null)

Parameters

Type	Name	Description
Guid	flowId	The ID for the flow to update.
CancellationToken	cancel	The cancellation token to obey.
Guid?	newProjectId	The LUID of a project to move the flow to, or null to not update the project.
Guid?	newOwnerId	The LUID of a user to assign the flow to as owner, or null to not update the owner.

Returns

Type	Description
Task<IResult<IUpdateFlowResult>>	The update result.