Class AssetCollection

This object contains the information pertaining to an asset collection stored on the cloud.

Inheritance

Object

AssetCollection

Inherited Members

Object.ToString()

Object.Equals(Object)

Object.Equals(Object, Object)

Object.ReferenceEquals(Object, Object)

Object.GetHashCode()

Object.GetType()

Object.MemberwiseClone()

Namespace: Unity.Cloud.Assets

Syntax

public class AssetCollection : IAssetCollection

Constructors

AssetCollection(String, String, String, Dictionary<String, IDeserializable>)

Creates and initializes a AssetCollection.

Declaration

public AssetCollection(string name, string description, string parentPath = null, Dictionary<string, IDeserializable> metadata = null)

Parameters

Type	Name	Description
String	name	The name of the collection.
String	description	The description of the collection.
String	parentPath	(Optional) The path to the parent collection.
Dictionary<String, IDeserializable>	metadata	(Optional) The metadata of the collection.

Exceptions

Type	Condition
ArgumentNullException	This exception is thrown if the name or description are null or empty.

Properties

CatalogId

The id of an associated catalog.

Declaration

public string CatalogId { get; }

Property Value

Type	Description
String

Implements

IAssetCollection.CatalogId

Description

Describes the collection.

Declaration

public string Description { get; }

Property Value

Type	Description
String

Implements

IAssetCollection.Description

Metadata

Additional serialized information about the collection.

Declaration

public Dictionary<string, IDeserializable> Metadata { get; set; }

Property Value

Type	Description
Dictionary<String, IDeserializable>

Implements

IAssetCollection.Metadata

Name

The name of the collection.

Declaration

public string Name { get; }

Property Value

Type	Description
String

Implements

IAssetCollection.Name

ParentPath

The path to the parent collection; can be empty.

Declaration

public CollectionPath ParentPath { get; }

Property Value

Type	Description
CollectionPath

Implements

IAssetCollection.ParentPath

Project

The project in which the collection resides.

Declaration

public IProject Project { get; set; }

Property Value

Type	Description
IProject

Implements

IAssetCollection.Project

Methods

GetFullCollectionPath()

Declaration

public string GetFullCollectionPath()

Returns

Type	Description
String

Implements

IAssetCollection.GetFullCollectionPath()

SetDescription(String)

Sets the Description of the collection.

Declaration

public void SetDescription(string description)

Parameters

Type	Name	Description
String	description	The description of the collection.

Implements

IAssetCollection.SetDescription(String)

Exceptions

Type	Condition
ArgumentNullException	This exception is thrown if the description is null or empty.

SetName(String)

Sets the Name of the collection.

Declaration

public void SetName(string name)

Parameters

Type	Name	Description
String	name	The name of the collection.

Implements

IAssetCollection.SetName(String)

Exceptions

Type	Condition
ArgumentNullException	This exception is thrown if the name is null or empty.