IResourceSystem

The object system is a primary layer one interface. It provides methods for managing resources and their metadata.

Methods

void CancelImportNotification(Guid importHandle)

void CancelResourceImport(Guid importHandle)

Cancels a resource import

Guid CloneResourceItem(Guid resourceItemID)

Clones a resource item returning a new resource you can modify separately, but initially referencing the same data as the original

ResourceValue CompleteResourceImport(Guid importHandle, string originalFileName)

Completes a resource import

ResourceValue CompleteResourceImport(Guid importHandle, ResourceQualityLevel quality, string originalFileName, Byte[] resourceData)

Completes a resource import

Guid CreateResourceImportHandle(Guid sessionID, Guid resourceItemID, ResourceQualityLevel resourceQuality)

Create a new resource import

Guid CreateResourceItem(Guid resourceTypeID, string title, Dictionary<string, ProtoValue> metadata, Guid? resourceItemID = NULL)

Creates a resource item

Guid CreateResourceType(string identifier, string mimeType, string allowedExtensions)

Creates a new resource Type

void DeleteResourceItem(Guid resourceItemID)

Deletes a resource

Guid? FindResourceType(string fileExtension)

Get ResourceType based on a file extension

Byte[] GetResourceBytes(Guid resourceItemID, ResourceQualityLevel quality)

Gets the raw data for a given resource item and quality level

IResourceItemInfo GetResourceItemInfo(Guid resourceItemID)

Gets info about a specific resource item

IResourceItemInfo[] GetResourceItems(IIdentityBase identity, Guid? resourceItemID, Guid? fileHash)

Gets a filtered array of resources for a given entity

IResourceItemInfo[] GetResourceItems(Guid[] resourceTypes)

Gets a filtered array of resources for a given type

ProtoValue GetResourceMetadata(Guid resourceItemID, string name)

Gets a single metadata value for a resource

Dictionary<string, ProtoValue> GetResourceMetadataCollection(Guid resourceItemID, bool extended = false)

Gets all the metadata values for a resource at once

Byte[] GetResourceMetadataRaw(Guid resourceItemID)

Gets all the metadata values for a resource at once

IResourceTypeInfo GetResourceTypeInfo(Guid resourceTypeID)

Gets info about a specific resource type

IResourceTypeInfo[] GetResourceTypeInfos()

Gets info about all registered resource types

string GetResourceUploadFilename(Guid resourceItemID, ResourceQualityLevel quality = ResourceQualityLevel.Ultra)

Gets the #FileName(quality) metadata property for the specified resource

bool GrantResourceAccess(Guid resourceItemID, Guid entityID)

Grants access to an entity on a resource item

void RegisterImportNotification(Guid importHandle, Action<bool, Guid> callback)

void RemoveResourceFile(Guid resourceItemID, ResourceQualityLevel quality)

Removes a resource reference by quality level

void RemoveResourceMetadata(Guid resourceItemID, string name)

Removes a single metadata value for a resource

void RemoveResourceMetadata(Guid resourceItemID)

Removes all metadata for a resource

bool RevokeResourceAccess(Guid resourceItemID, Guid entityID)

Revokes access to an entity on a resource item

void SetResourceMetadata(Guid resourceItemID, string name, ProtoValue value)

Sets a single metadata value for a resource

void SetResourceMetadata(Guid resourceItemID, Byte[] metadata)

Sets all the metadata values for a resource at once

void SetResourceMetadata(Guid resourceItemID, Dictionary<string, ProtoValue> metadata)

Sets all the metadata values for a resource at once

void TagResource(Guid resourceItemID, string tagName)

Adds a text tag to a resource to make it more searchable in the resource browser

void UntagResource(Guid resourceItemID, string tagName)

Removes a text tag from a resource

ResourceValue UpdateResource(Guid resourceItemID, Byte[] resourceData, ResourceQualityLevel quality, string originalFileName, bool notify = true)

Updates an existing resource

void UpdateResourceItem(Guid resourceItemID, string title, Dictionary<string, ProtoValue> metadata, List<Guid> tags, List<ResourceQualityLevel> removedResourceQualities)

Updates a resource