Class: Bookmark

Bookmark(opts)

The Bookmark class wraps node operations

Cannot directly be instantiated

Constructor

new Bookmark(opts)

Creates a Node

Parameters:
Name Type Description
opts object

The configuration options.

Methods

add(uuid, name) → {Promise.<*>}

Add bookmark

Parameters:
Name Type Description
uuid

The uuid of the node

name

The name of the bookmark

Returns:
  • Return void
Type
Promise.<*>

add(uuid, name) → {Promise.<*>}

Add bookmark

Parameters:
Name Type Description
uuid

The uuid of the node

name

The name of the bookmark

Returns:
  • Return void
Type
Promise.<*>

deleteBookmark(bookmarkId) → {Promise.<*>}

Delete bookmark

Parameters:
Name Type Description
bookmarkId

The bookmark id

Returns:
Type
Promise.<*>

deleteBookmark(bookmarkId) → {Promise.<*>}

Delete bookmark

Parameters:
Name Type Description
bookmarkId

The bookmark id

Returns:
Type
Promise.<*>

getAll() → {Promise.<any>|Promise.<(*|never)>}

Get all bookmars

Returns:

Return a list of boormarks

Type
Promise.<any> | Promise.<(*|never)>

getAll() → {Promise.<any>|Promise.<(*|never)>}

Get all bookmars

Returns:

Return a list of boormarks

Type
Promise.<any> | Promise.<(*|never)>

renameBookmark(bookmarkId, name) → {Promise.<*>}

Rename a bookmark

Parameters:
Name Type Description
bookmarkId

The bookmark id

name

The name of the bookmark

Returns:
  • Return void
Type
Promise.<*>

renameBookmark(bookmarkId, name) → {Promise.<*>}

Rename a bookmark

Parameters:
Name Type Description
bookmarkId

The bookmark id

name

The name of the bookmark

Returns:
  • Return void
Type
Promise.<*>

setRestUrl(restUrl)

Set the rest url

Parameters:
Name Type Description
restUrl

The rest url

setRestUrl(restUrl)

Set the rest url

Parameters:
Name Type Description
restUrl

The rest url

setToken(token)

Set the token in Node variables

Parameters:
Name Type Description
token

The authorization token value

setToken(token)

Set the token in Node variables

Parameters:
Name Type Description
token

The authorization token value

Bookmark(opts)

The Bookmark class wraps node operations

Cannot directly be instantiated

Constructor

new Bookmark(opts)

Creates a Node

Parameters:
Name Type Description
opts object

The configuration options.

Methods

add(uuid, name) → {Promise.<*>}

Add bookmark

Parameters:
Name Type Description
uuid

The uuid of the node

name

The name of the bookmark

Returns:
  • Return void
Type
Promise.<*>

add(uuid, name) → {Promise.<*>}

Add bookmark

Parameters:
Name Type Description
uuid

The uuid of the node

name

The name of the bookmark

Returns:
  • Return void
Type
Promise.<*>

deleteBookmark(bookmarkId) → {Promise.<*>}

Delete bookmark

Parameters:
Name Type Description
bookmarkId

The bookmark id

Returns:
Type
Promise.<*>

deleteBookmark(bookmarkId) → {Promise.<*>}

Delete bookmark

Parameters:
Name Type Description
bookmarkId

The bookmark id

Returns:
Type
Promise.<*>

getAll() → {Promise.<any>|Promise.<(*|never)>}

Get all bookmars

Returns:

Return a list of boormarks

Type
Promise.<any> | Promise.<(*|never)>

getAll() → {Promise.<any>|Promise.<(*|never)>}

Get all bookmars

Returns:

Return a list of boormarks

Type
Promise.<any> | Promise.<(*|never)>

renameBookmark(bookmarkId, name) → {Promise.<*>}

Rename a bookmark

Parameters:
Name Type Description
bookmarkId

The bookmark id

name

The name of the bookmark

Returns:
  • Return void
Type
Promise.<*>

renameBookmark(bookmarkId, name) → {Promise.<*>}

Rename a bookmark

Parameters:
Name Type Description
bookmarkId

The bookmark id

name

The name of the bookmark

Returns:
  • Return void
Type
Promise.<*>

setRestUrl(restUrl)

Set the rest url

Parameters:
Name Type Description
restUrl

The rest url

setRestUrl(restUrl)

Set the rest url

Parameters:
Name Type Description
restUrl

The rest url

setToken(token)

Set the token in Node variables

Parameters:
Name Type Description
token

The authorization token value

setToken(token)

Set the token in Node variables

Parameters:
Name Type Description
token

The authorization token value