Class NodeAPI
Extends
Chainback.
Defined in: node.js.
Constructor Attributes | Constructor Name and Description |
---|---|
NodeAPI(id, success, error, settings)
Represents a Node
|
Method Attributes | Method Name and Description |
---|---|
<static> |
NodeAPI.constructs(success, error)
Retrieves a list of constructs and constructs categories that are
assigned to this node and passes it as the only argument into the
the `success()' callback.
|
<static> |
NodeAPI.folders(success, error)
Retrieves the top-level folders of this node's root folder.
|
Class Detail
NodeAPI(id, success, error, settings)
Represents a Node
- Parameters:
- {number|string} id
- of the file to be loaded
- {function(ContentObjectAPI))=} success
- Optional success callback that will receive this object as its only argument.
- {function(GCNError):boolean=} error
- Optional custom error handler.
- {object} settings
- currently there are no additional settings to be used
Method Detail
NodeAPI.constructs(success, error)
Retrieves a list of constructs and constructs categories that are
assigned to this node and passes it as the only argument into the
the `success()' callback.
- Parameters:
- {function(Array. success
- Callback to receive an array of constructs.
- {function(GCNError):boolean=} error
- Custom error handler.
- Throws:
- INVALID_ARGUMENTS
- Returns:
- undefined
NodeAPI.folders(success, error)
Retrieves the top-level folders of this node's root folder.
- Parameters:
- {function(FolderAPI)=} success
- {function(GCNError):boolean=} error
- Custom error handler.