Interface ISelectionFieldDefinition

Inherited Members
Namespace: Unity.Cloud.Assets
Assembly: Unity.Cloud.Assets.dll
Syntax
public interface ISelectionFieldDefinition : IFieldDefinition

Properties

AcceptedValues

The accepted values of the field. This is only required for field definitions of type Selection.

Declaration
[Obsolete("Use SelectionFieldDefinitionProperties.AcceptedValues instead.")]
IEnumerable<string> AcceptedValues { get; }
Property Value
Type Description
IEnumerable<string>

Multiselection

Whether the field can have multiple values. This is only requred for field definitions of type Selection.

Declaration
[Obsolete("Use SelectionFieldDefinitionProperties.Multiselection instead.")]
bool Multiselection { get; }
Property Value
Type Description
bool

Methods

AddSelectionValuesAsync(IEnumerable<string>, CancellationToken)

Appends the parameter list to the accepted values of the field.

Declaration
Task AddSelectionValuesAsync(IEnumerable<string> acceptedValues, CancellationToken cancellationToken)
Parameters
Type Name Description
IEnumerable<string> acceptedValues

An enumeration of accepted values.
CancellationToken cancellationToken

The cancellation token.
Returns
Type Description
Task

A task with no result.

GetPropertiesAsync(CancellationToken)

Returns the properties of the field definition.

Declaration
Task<SelectionFieldDefinitionProperties> GetPropertiesAsync(CancellationToken cancellationToken)
Parameters
Type Name Description
CancellationToken cancellationToken

A token that can be used to cancel the request.
Returns
Type Description
Task<SelectionFieldDefinitionProperties>

A task whose result is the FieldDefinitionProperties of the field definition.

RemoveSelectionValuesAsync(IEnumerable<string>, CancellationToken)

Removes the parameter list from the accepted values of the field.

Declaration
Task RemoveSelectionValuesAsync(IEnumerable<string> acceptedValues, CancellationToken cancellationToken)
Parameters
Type Name Description
IEnumerable<string> acceptedValues

An enumeration of accepted values.
CancellationToken cancellationToken

The cancellation token.
Returns
Type Description
Task

A task with no result.

SetSelectionValuesAsync(IEnumerable<string>, CancellationToken)

Sets the parameter list as the accepted values of the field.

Declaration
Task SetSelectionValuesAsync(IEnumerable<string> acceptedValues, CancellationToken cancellationToken)
Parameters
Type Name Description
IEnumerable<string> acceptedValues

An enumeration of accepted values.
CancellationToken cancellationToken

The cancellation token.
Returns
Type Description
Task

A task with no result.

WithCacheConfigurationAsync(FieldDefinitionCacheConfiguration, CancellationToken)

Returns a field definition configured with the specified caching configuration.

Declaration
Task<ISelectionFieldDefinition> WithCacheConfigurationAsync(FieldDefinitionCacheConfiguration fieldDefinitionCacheConfiguration, CancellationToken cancellationToken)
Parameters
Type Name Description
FieldDefinitionCacheConfiguration fieldDefinitionCacheConfiguration

The caching configuration for the field definition.
CancellationToken cancellationToken

A token that can be used to cancel the request.
Returns
Type Description
Task<ISelectionFieldDefinition>

A task whose result is an ISelectionFieldDefinition with cached values specified by the caching configurations.

Extension Methods