CraftAR Unity Pro SDK  1.0
Classes | Public Member Functions | Protected Attributes | Properties | List of all members
CraftAROnDeviceCollection Class Reference

The CraftAROnDeviceCollection class encapsulates an OnDevice Collection Item from the CraftAR service. More...

Inheritance diagram for CraftAROnDeviceCollection:
ICraftAROnDeviceCollectionCallbacks

Classes

interface  CraftAROnDeviceCollectionCallbacks
 The CraftAROnDeviceCollectionCallbacks interface defines the callbacks for receiving global events from the CraftAR plugin related to OnDeviceCollection synchronization. More...
 

Public Member Functions

 CraftAROnDeviceCollection (CraftAROnDeviceCollectionImplementation cImpl)
 
void setCraftAROnDeviceCollectionCallbacksHandler (CraftAROnDeviceCollectionCallbacks callbacksHandler)
 Sets the CraftAROnDeviceCollection events handler. More...
 
string GetUUID ()
 Requests the collection's UUID More...
 
string GetName ()
 Requests the collection's Name More...
 
List< string > GetTokens ()
 Requests the collection's Tokens More...
 
void Sync (string token)
 Perform collection synchronization with a token as a reference of collection to sync More...
 
void Sync ()
 Perform collection synchronization More...
 
List< string > ListItems ()
 Get CrafARItems uuids from collection More...
 
CraftARItem GetItem (string uuid)
 Get CrafARItem from collection and uuid More...
 
void SyncFinished ()
 
void SyncProgress (float progress)
 
void SyncFailed (CraftARError error)
 

Protected Attributes

CraftAROnDeviceCollectionImplementation collectionImplementation
 

Properties

CraftAROnDeviceCollectionImplementation CollectionImplementation [get]
 

Detailed Description

The CraftAROnDeviceCollection class encapsulates an OnDevice Collection Item from the CraftAR service.

Member Function Documentation

◆ GetItem()

CraftARItem CraftAROnDeviceCollection.GetItem ( string  uuid)
inline

Get CrafARItem from collection and uuid

Parameters
uuidItem UUID
Returns
Item

◆ GetName()

string CraftAROnDeviceCollection.GetName ( )
inline

Requests the collection's Name

Returns
The collection's Name

◆ GetTokens()

List<string> CraftAROnDeviceCollection.GetTokens ( )
inline

Requests the collection's Tokens

Returns
List of collection tokens

◆ GetUUID()

string CraftAROnDeviceCollection.GetUUID ( )
inline

Requests the collection's UUID

Returns
The collection's UUID

◆ ListItems()

List<string> CraftAROnDeviceCollection.ListItems ( )
inline

Get CrafARItems uuids from collection

Returns
List of CraftARItems uuids

◆ setCraftAROnDeviceCollectionCallbacksHandler()

void CraftAROnDeviceCollection.setCraftAROnDeviceCollectionCallbacksHandler ( CraftAROnDeviceCollectionCallbacks  callbacksHandler)
inline

Sets the CraftAROnDeviceCollection events handler.

Parameters
collectionEventsHandlerCollection events handler.

◆ Sync() [1/2]

void CraftAROnDeviceCollection.Sync ( string  token)
inline

Perform collection synchronization with a token as a reference of collection to sync

Parameters
tokenCollection Token

◆ Sync() [2/2]

void CraftAROnDeviceCollection.Sync ( )
inline

Perform collection synchronization


The documentation for this class was generated from the following file: