SCLOrkConfab:
Filter:
SCLOrkTools/Classes (extension) | Quarks > SCLOrkTools

SCLOrkConfab
ExtensionExtension

Primary Interface to the SCLOrkTools C++-based Asset sharing server.

Description

(put long description here)

Class Methods

.startConfab

Starts the confab service.

Arguments:

pathToConfabBinary

An override path to the confab binary. If not provided, SCLOrkConfab will look in the default path inside the Quark directory.

pathToConfabDatabase

An override path to the confab database directory. If not provided, SCLOrkConfab will look in the default '/data/confab/db' path inside the Quark directory.

Returns:

true on success, false on failure.

.findAsset

Looks up the Asset record associated with the provided id.

Arguments:

id

A symbol with the Asset id to find.

callback

A function to call back with the asset and status, when determined. Called with two arguments, the first is the asset id provided in the original call, and the second is either a SCLOrkAsset object or nil if no asset was found associated with that id. Note that the returned SCLOrkAsset object can have a different key than the one originally requested, usually in the case of deprecation of the original Asset.

Examples