Interface ILabel
Namespace: Unity.Cloud.Assets
Assembly: Unity.Cloud.Assets.dll
Syntax
public interface ILabelProperties
AuthoringInfo
The authoring information for the label.
Declaration
AuthoringInfo AuthoringInfo { get; }Property Value
| Type | Description |
|---|---|
| AuthoringInfo |
Description
The description of the label.
Declaration
string Description { get; }Property Value
| Type | Description |
|---|---|
| string |
Descriptor
The descriptor for the label.
Declaration
LabelDescriptor Descriptor { get; }Property Value
| Type | Description |
|---|---|
| LabelDescriptor |
DisplayColor
The color of the label.
Declaration
Color DisplayColor { get; }Property Value
| Type | Description |
|---|---|
| Color |
IsAssignable
Whether the label can be manually assigned to an asset.
Declaration
bool IsAssignable { get; }Property Value
| Type | Description |
|---|---|
| bool |
IsSystemLabel
Whether the label is a system label.
Declaration
bool IsSystemLabel { get; }Property Value
| Type | Description |
|---|---|
| bool |
Name
A unique name for the label. Uniqueness is scoped to the organization.
Declaration
string Name { get; }Property Value
| Type | Description |
|---|---|
| string |
Methods
ArchiveAsync(CancellationToken)
Archives the label.
Declaration
Task ArchiveAsync(CancellationToken cancellationToken)Parameters
| Type | Name | Description |
|---|---|---|
| CancellationToken | cancellationToken | A token that can be used to cancel the request. |
Returns
| Type | Description |
|---|---|
| Task | A task with no result. |
RefreshAsync(CancellationToken)
Fetches the latest changes.
Declaration
Task RefreshAsync(CancellationToken cancellationToken)Parameters
| Type | Name | Description |
|---|---|---|
| CancellationToken | cancellationToken | A token that can be used to cancel the request. |
Returns
| Type | Description |
|---|---|
| Task | A task with no result. |
RenameAsync(string, CancellationToken)
Updates the label name.
Declaration
Task RenameAsync(string labelName, CancellationToken cancellationToken)Parameters
| Type | Name | Description |
|---|---|---|
| string | labelName | A new unique name for the label. |
| CancellationToken | cancellationToken | A token that can be used to cancel the request. |
Returns
| Type | Description |
|---|---|
| Task | A task with no result. |
UnarchiveAsync(CancellationToken)
Unarchives the label.
Declaration
Task UnarchiveAsync(CancellationToken cancellationToken)Parameters
| Type | Name | Description |
|---|---|---|
| CancellationToken | cancellationToken | A token that can be used to cancel the request. |
Returns
| Type | Description |
|---|---|
| Task | A task with no result. |
UpdateAsync(ILabelUpdate, CancellationToken)
Updates the label.
Declaration
Task UpdateAsync(ILabelUpdate labelUpdate, CancellationToken cancellationToken)Parameters
| Type | Name | Description |
|---|---|---|
| ILabelUpdate | labelUpdate | The object containing information to update the label. |
| CancellationToken | cancellationToken | A token that can be used to cancel the request. |
Returns
| Type | Description |
|---|---|
| Task | A task with no result. |