Interface ILabel

Namespace: Unity.Cloud.Assets

Assembly: Unity.Cloud.Assets.dll

Syntax

public interface ILabel

Properties

AuthoringInfo

The authoring information for the label.

Declaration

[Obsolete("Use LabelProperties.AuthoringInfo instead.")]
AuthoringInfo AuthoringInfo { get; }

Property Value

Type	Description
AuthoringInfo

CacheConfiguration

The caching configuration for the label.

Declaration

LabelCacheConfiguration CacheConfiguration { get; }

Property Value

Type	Description
LabelCacheConfiguration

Description

The description of the label.

Declaration

[Obsolete("Use LabelProperties.Description instead.")]
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

[Obsolete("Use LabelProperties.DisplayColor instead.")]
Color DisplayColor { get; }

Property Value

Type	Description
Color

IsAssignable

Whether the label can be manually assigned to an asset.

Declaration

[Obsolete("Use LabelProperties.IsAssignable instead.")]
bool IsAssignable { get; }

Property Value

Type	Description
bool

IsSystemLabel

Whether the label is a system label.

Declaration

[Obsolete("Use LabelProperties.IsSystemLabel instead.")]
bool IsSystemLabel { get; }

Property Value

Type	Description
bool

Name

A unique name for the label. Uniqueness is scoped to the organization.

Declaration

[Obsolete("Use Descriptor.LabelName instead.")]
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.

GetPropertiesAsync(CancellationToken)

Returns the properties of the label.

Declaration

Task<LabelProperties> GetPropertiesAsync(CancellationToken cancellationToken)

Parameters

Type	Name	Description
CancellationToken	cancellationToken	A token that can be used to cancel the request.

Returns

Type	Description
Task<LabelProperties>	A task whose result is the LabelProperties of the label.

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.

WithCacheConfigurationAsync(LabelCacheConfiguration, CancellationToken)

Returns a label configured with the specified caching configuration.

Declaration

Task<ILabel> WithCacheConfigurationAsync(LabelCacheConfiguration labelCacheConfiguration, CancellationToken cancellationToken)

Parameters

Type	Name	Description
LabelCacheConfiguration	labelCacheConfiguration	The caching configuration for the label.
CancellationToken	cancellationToken	A token that can be used to cancel the request.

Returns

Type	Description
Task<ILabel>	A task whose result is an ILabel with cached values specified by the caching configurations.