API Docs for: 0.8.2
Show:

ItemDriver Class

Defined in: scripts/ItemDriver.js:1

An item utility interacts with the item storage and is responsible for creating and deleting items. This is an implementation of item utility using Dropbox as the item storage.

For ItemMirror core developers only. Enable protected to see.

Constructor

ItemDriver

(
  • options
)
protected

Defined in scripts/ItemDriver.js:1

Parameters:

  • options Object

    Data to construct a new ItemU with

    • utilityURI String

      URI of the utility

    • dropboxClient Object

      Authenticated dropbox client

Methods

checkExisted

(
  • path
  • name
  • callback(result)
)
protected

Defined in scripts/ItemDriver.js:270

Check if the item is existed

Parameters:

  • path String

    the path to the location that the item is located

  • name String

    the name of the item

  • callback(result) Function

    Function to be called when self function is finished with it's operation. Result is the bollean value for whether existed.

copyItem

(
  • fromPath
  • toPath
  • callback
)
protected

Defined in scripts/ItemDriver.js:177

Copies an item in the fashion of moveItem

Parameters:

  • fromPath String

    the path to the file you want copied

  • toPath String

    the GroupingItem path you want the fromPath file copied to

  • callback Function

    Function to be called when self function is finished with it's operation.

createGroupingItem

(
  • path
  • callback
)
protected

Defined in scripts/ItemDriver.js:99

Creates a grouping item at the location

Parameters:

  • path String

    the path to the location that the grouping item will be created

  • callback Function

    Function to be called when self function is finished with it's operation.

createNonGroupingItem

(
  • path
  • file
  • callback
)
protected

Defined in scripts/ItemDriver.js:118

Creates or uploads a non-grouping item at the location

Parameters:

  • path String

    the path to the location that the non-grouping item will be created

  • file String

    the contents to be written to the non-grouping item

  • callback Function

    Function to be called when self function is finished with it's operation.

deleteGroupingItem

(
  • path
  • callback
)
protected

Defined in scripts/ItemDriver.js:138

Deletes a grouping item at the location

Parameters:

  • path String

    the path to the location that the grouping item is located

  • callback Function

    Function to be called when self function is finished with it's operation.

deleteNonGroupingItem

(
  • path
  • name
  • callback
)
protected

Defined in scripts/ItemDriver.js:157

Deletes a non-grouping item at the location

Parameters:

  • path String

    the path to the location that the non-grouping item is located

  • name String

    the name of the non-grouping item

  • callback Function

    Function to be called when self function is finished with it's operation.

getURL

(
  • path
  • callback
)
protected

Defined in scripts/ItemDriver.js:217

Get publicly readable download url for a non-grouping item from Dropbox website.

Parameters:

  • path String

    the path to the location that the non-grouping item is located

  • callback Function

    Function to be called when self function is finished with it's operation.

listItems

(
  • path
  • callback(output)
)
protected

Defined in scripts/ItemDriver.js:236

Lists the items under the grouping item

Parameters:

  • path String

    the path to the grouping item

  • callback(output) Function

    Function to be called when self function is finished with it's operation. Output is an array of AssociationEditors.

moveItem

(
  • fromPath
  • toPath
  • callback
)
protected

Defined in scripts/ItemDriver.js:197

Moves an item

Parameters:

  • fromPath String

    the path to the file you want moved

  • toPath String

    the GroupingItem path you want the fromPath file moved

  • callback Function

    Function to be called when self function is finished with it's operation.