classeur-api-client

Class: ClasseurClient

classeur-api-client~ ClasseurClient

Object-oriented interface to the Classeur REST API.

new ClasseurClient(userId, apiKey, host)

Constructs a new API client.

Parameters:
Name Type Argument Default Description
userId string

Classeur user ID string.
apiKey string

API Key string. Keep this secret.
host string <optional>
 app.classeur.io

Fully qualified hostname to connect to. Connections will be made with HTTPS, regardless of whether the hostname is prefixed with http:// or https://.
Source:

Methods

getFile(id, callback)

Retrieve a single file.

Parameters:
Name Type Description
id String

Classeur file ID to retrieve.
callback module:classeur-api-client.ScrubbedCallback

Called with (error, result).

  • result will be a File object, or null on error.
Source:

getFileMetadata(id, callback)

Retrieve metadata for a file.

Parameters:
Name Type Description
id String

The Classeur file ID for which to retrieve metadata.
callback module:classeur-api-client.ScrubbedCallback

Called with (error, result).
Source:

getFiles([ids], callback)

Retrieve one or more files.

Parameters:
Name Type Description
[ids] Array.<String>

Array of Classeur file IDs to retrieve.
callback module:classeur-api-client.ScrubbedCallback

Called with (error, result).

  • result will be an Array of File objects, or null on error.
Source:

getFiles(…ids, callback)

Retrieve one or more files.
Like ClasseurClient#getFiles, but with spread: accepts a variable number of file IDs in the arguments, instead of an Array.

Parameters:
Name Type Argument Description
…ids String <repeatable>

Classeur file IDs to retrieve.
callback module:classeur-api-client.ScrubbedCallback

Called with (error, result).

  • result will be an Array of File objects, or null on error.
Source:

getFilesMetadata([ids], callback)

Retrieve metadata for one or more files.

Parameters:
Name Type Description
[ids] Array.<String>

Array of Classeur file IDs for which to retrieve metadata.
callback module:classeur-api-client.ScrubbedCallback

Called with (error, result).

  • result will be an Array of FileMetadata objects, or null on error.
Source:

getFilesMetadata(…ids, callback)

Like ClasseurClient#getUsersMetadata, but with spread: accepts a variable number of folder IDs in the arguments, instead of an Array.

Parameters:
Name Type Argument Description
…ids String <repeatable>

Classeur file IDs for which to retrieve metadata.
callback module:classeur-api-client.ScrubbedCallback

Called with (error, result).

  • result will be an Array of FileMetadata objects, or null on error.
Source:

getFolder(id, callback)

Retrieve a single folder.

Parameters:
Name Type Description
id String

Classeur folder ID to retrieve.
callback module:classeur-api-client.ScrubbedCallback

Called with (error, result).

  • result will be a Folder object, or null on error.
Source:

getFolderMetadata(id, callback)

Retrieve metadata for a folder.

Parameters:
Name Type Description
id String

The Classeur folder ID for which to retrieve metadata.
callback module:classeur-api-client.ScrubbedCallback

Called with (error, result).
Source:

getFolders([ids], callback)

Retrieve one or more folders.

Parameters:
Name Type Description
[ids] Array.<String>

Array of Classeur folder IDs to retrieve.
callback module:classeur-api-client.ScrubbedCallback

Called with (error, result).

  • result will be an Array of Folder objects, or null on error.
Source:

getFolders(…ids, callback)

Like ClasseurClient#getFolders, but with spread: accepts a variable number of folder IDs in the arguments, instead of an Array.

Parameters:
Name Type Argument Description
…ids String <repeatable>

Classeur folder IDs to retrieve.
callback module:classeur-api-client.ScrubbedCallback

Called with (error, result).

  • result will be an Array of Folder objects, or null on error.
Source:

getFoldersMetadata([ids], callback)

Retrieve metadata for one or more folders.

Parameters:
Name Type Description
[ids] Array.<String>

Array of Classeur folder IDs for which to retrieve metadata.
callback module:classeur-api-client.ScrubbedCallback

Called with (error, result).

  • result will be an Array of FolderMetadata objects, or null on error.
Source:

getFoldersMetadata(…ids, callback)

Like ClasseurClient#getUsersMetadata, but with spread: accepts a variable number of folder IDs in the arguments, instead of an Array.

Parameters:
Name Type Argument Description
…ids String <repeatable>

Classeur folder IDs for which to retrieve metadata.
callback module:classeur-api-client.ScrubbedCallback

Called with (error, result).

  • result will be an Array of FolderMetadata objects, or null on error.
Source:

getUserMetadata(id, callback)

Retrieve metadata for a user.

Parameters:
Name Type Description
id String

The Classeur user ID for which to retrieve metadata.
callback module:classeur-api-client.ScrubbedCallback

Called with (error, result).
Source:

getUsers(callback)

Retrieve all users on the Classeur account to which the ClasseurClient is connected.

Parameters:
Name Type Description
callback module:classeur-api-client.ScrubbedCallback

Called with (error, result).

  • result will be an Array of User objects, or null on error.
Source:

getUsersMetadata([ids], callback)

Retrieve metadata for one or more users.

Parameters:
Name Type Description
[ids] Array.<String>

Array of Classeur user IDs for which to retrieve metadata.
callback module:classeur-api-client.ScrubbedCallback

Called with (error, result).

  • result will be an Array of UserMetadata objects, or null on error.
Source:

getUsersMetadata(…ids, callback)

Like ClasseurClient#getUsersMetadata, but with spread: accepts a variable number of folder IDs in the arguments, instead of an Array.

Parameters:
Name Type Argument Description
…ids String <repeatable>

Classeur user IDs for which to retrieve metadata.
callback module:classeur-api-client.ScrubbedCallback <optional>

callback - Called with (error, result).

  • result will be an Array of UserMetadata objects, or null on error.
Source: