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
AuthoringInfo AuthoringInfo { get; }Property Value
| Type | Description |
|---|---|
| AuthoringInfo |
Descriptor
The descriptor for the field.
Declaration
FieldDefinitionDescriptor Descriptor { get; }Property Value
| Type | Description |
|---|---|
| FieldDefinitionDescriptor |
DisplayName
The display name for the field.
Declaration
string DisplayName { get; }Property Value
| Type | Description |
|---|---|
| string |
IsDeleted
Whether the field is deleted.
Declaration
bool IsDeleted { get; }Property Value
| Type | Description |
|---|---|
| bool |
Origin
The originator of the field.
Declaration
FieldDefinitionOrigin Origin { get; }Property Value
| Type | Description |
|---|---|
| FieldDefinitionOrigin |
Type
The type of the field.
Declaration
FieldDefinitionType Type { get; }Property Value
| Type | Description |
|---|---|
| FieldDefinitionType |
Methods
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. |