Interface IStatusFlow
An interface containing information about a status flow for an asset.
Namespace: Unity.Cloud.Assets
Assembly: Unity.Cloud.Assets.dll
Syntax
public interface IStatusFlowProperties
Descriptor
The descriptor of the status flow.
Declaration
StatusFlowDescriptor Descriptor { get; }Property Value
| Type | Description |
|---|---|
| StatusFlowDescriptor |
IsDefault
Whether the status flow is a default flow.
Declaration
bool IsDefault { get; }Property Value
| Type | Description |
|---|---|
| bool |
Name
The name of the status flow.
Declaration
string Name { get; }Property Value
| Type | Description |
|---|---|
| string |
StartStatusId
The id of the starting status.
Declaration
string StartStatusId { get; }Property Value
| Type | Description |
|---|---|
| string |
Methods
ListStatusesAsync(Range, CancellationToken)
Returns the statuses in the flow.
Declaration
IAsyncEnumerable<IStatus> ListStatusesAsync(Range range, CancellationToken cancellationToken)Parameters
| Type | Name | Description |
|---|---|---|
| Range | range | The range of results to return. |
| CancellationToken | cancellationToken | A token that can be used to cancel the request. |
Returns
| Type | Description |
|---|---|
| IAsyncEnumerable<IStatus> | An async enumeration of IStatus. |
ListTransitionsAsync(Range, CancellationToken)
Returns the transitions between statuses.
Declaration
IAsyncEnumerable<IStatusTransition> ListTransitionsAsync(Range range, CancellationToken cancellationToken)Parameters
| Type | Name | Description |
|---|---|---|
| Range | range | The range of results to return. |
| CancellationToken | cancellationToken | A token that can be used to cancel the request. |
Returns
| Type | Description |
|---|---|
| IAsyncEnumerable<IStatusTransition> | An async enumeration of IStatusTransition. |