Interface IFieldDefinition
Namespace: Unity.Cloud.Assets
Assembly: Unity.Cloud.Assets.dll
Syntax
public interface IFieldDefinitionProperties
AuthoringInfo
The creation and update information of the field.
Declaration
[Obsolete("Use FieldDefinitionProperties.AuthoringInfo instead.")]
AuthoringInfo AuthoringInfo { get; }Property Value
| Type | Description |
|---|---|
| AuthoringInfo |
CacheConfiguration
The caching configuration for the field definition.
Declaration
FieldDefinitionCacheConfiguration CacheConfiguration { get; }Property Value
| Type | Description |
|---|---|
| FieldDefinitionCacheConfiguration |
Descriptor
The descriptor for the field.
Declaration
FieldDefinitionDescriptor Descriptor { get; }Property Value
| Type | Description |
|---|---|
| FieldDefinitionDescriptor |
DisplayName
The display name for the field.
Declaration
[Obsolete("Use FieldDefinitionProperties.DisplayName instead.")]
string DisplayName { get; }Property Value
| Type | Description |
|---|---|
| string |
IsDeleted
Whether the field is deleted.
Declaration
[Obsolete("Use FieldDefinitionProperties.IsDeleted instead.")]
bool IsDeleted { get; }Property Value
| Type | Description |
|---|---|
| bool |
Origin
The originator of the field.
Declaration
[Obsolete("Use FieldDefinitionProperties.Origin instead.")]
FieldDefinitionOrigin Origin { get; }Property Value
| Type | Description |
|---|---|
| FieldDefinitionOrigin |
Type
The type of the field.
Declaration
[Obsolete("Use FieldDefinitionProperties.Type instead.")]
FieldDefinitionType Type { get; }Property Value
| Type | Description |
|---|---|
| FieldDefinitionType |
Methods
GetPropertiesAsync(CancellationToken)
Returns the properties of the field definition.
Declaration
Task<FieldDefinitionProperties> GetPropertiesAsync(CancellationToken cancellationToken)Parameters
| Type | Name | Description |
|---|---|---|
| CancellationToken | cancellationToken | A token that can be used to cancel the request. |
Returns
| Type | Description |
|---|---|
| Task<FieldDefinitionProperties> | A task whose result is the FieldDefinitionProperties of the field definition. |
RefreshAsync(CancellationToken)
Refreshes the field to retrieve the latest values.
Declaration
Task RefreshAsync(CancellationToken cancellationToken)Parameters
| Type | Name | Description |
|---|---|---|
| CancellationToken | cancellationToken |
Returns
| Type | Description |
|---|---|
| Task |
UpdateAsync(IFieldDefinitionUpdate, CancellationToken)
Syncronizes local changes to the field definition to the data source.
Declaration
Task UpdateAsync(IFieldDefinitionUpdate definitionUpdate, CancellationToken cancellationToken)Parameters
| Type | Name | Description |
|---|---|---|
| IFieldDefinitionUpdate | definitionUpdate | The object containing the information to update. |
| 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<IFieldDefinition> 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<IFieldDefinition> | A task whose result is an IFieldDefinition with cached values specified by the caching configurations. |