Interface: Admin

Admin

Methods

deleteDownload(id, options) → {Promise}

Soft deletes a download.
Parameters:
Name Type Description
id string | number the id of the download
options object as specified in the Angular documentation
Source:
Returns:
Type
Promise

deleteDownload(id, timeout) → {Promise}

Soft deletes a download.
Parameters:
Name Type Description
id string | number the id of the download
timeout Promise if resolved will cancel the request
Source:
Returns:
Type
Promise

deleteDownload(id) → {Promise}

Soft deletes a download.
Parameters:
Name Type Description
id string | number the id of the download
Source:
Returns:
Type
Promise

downloads(queryOffset, options) → {Promise.<Array.<object>>}

Returns all downloads.
Parameters:
Name Type Description
queryOffset array any JPQL from the where clause onwards
options object as specified in the Angular documentation
Source:
Returns:
a deferred list of downloads
Type
Promise.<Array.<object>>

downloads(timeout, queryOffset) → {Promise.<Array.<object>>}

Returns all downloads.
Parameters:
Name Type Description
timeout Promise if resolved will cancel the request
queryOffset array any JPQL from the where clause onwards
Source:
Returns:
a deferred list of downloads
Type
Promise.<Array.<object>>

downloads(queryOffset) → {Promise.<Array.<object>>}

Returns all downloads.
Parameters:
Name Type Description
queryOffset array any JPQL from the where clause onwards
Source:
Returns:
a deferred list of downloads
Type
Promise.<Array.<object>>

downloads(timeout, queryOffset) → {Promise.<Array.<object>>}

Returns all downloads.
Parameters:
Name Type Description
timeout Promise if resolved will cancel the request
queryOffset string any JPQL from the where clause onwards
Source:
Returns:
a deferred list of downloads
Type
Promise.<Array.<object>>

downloads(queryOffset) → {Promise.<Array.<object>>}

Returns all downloads.
Parameters:
Name Type Description
queryOffset string any JPQL from the where clause onwards
Source:
Returns:
a deferred list of downloads
Type
Promise.<Array.<object>>

downloads(timeout) → {Promise.<Array.<object>>}

Returns all downloads.
Parameters:
Name Type Description
timeout Promise if resolved will cancel the request
Source:
Returns:
a deferred list of downloads
Type
Promise.<Array.<object>>

downloads() → {Promise.<Array.<object>>}

Returns all downloads.
Source:
Returns:
a deferred list of downloads
Type
Promise.<Array.<object>>

isValidSession(sessionId, options) → {Promise.<boolean>}

Returns whether or not the user's session has admin priviliges.
Parameters:
Name Type Description
sessionId string the session id to be tested
options object as specified in the Angular documentation
Source:
Returns:
Type
Promise.<boolean>

isValidSession(sessionId, timeout) → {Promise.<boolean>}

Returns whether or not the user's session has admin priviliges.
Parameters:
Name Type Description
sessionId string the session id to be tested
timeout Promise if resolved will cancel the request
Source:
Returns:
Type
Promise.<boolean>

isValidSession(sessionId) → {Promise.<boolean>}

Returns whether or not the user's session has admin priviliges.
Parameters:
Name Type Description
sessionId string the session id to be tested
Source:
Returns:
Type
Promise.<boolean>

restoreDownload(id, options) → {Promise}

Restores a (soft deleted) download.
Parameters:
Name Type Description
id string | number the id of the download
options object as specified in the Angular documentation
Source:
Returns:
Type
Promise

restoreDownload(id, timeout) → {Promise}

Restores a (soft deleted) download.
Parameters:
Name Type Description
id string | number the id of the download
timeout Promise if resolved will cancel the request
Source:
Returns:
Type
Promise

restoreDownload(id) → {Promise}

Restores a (soft deleted) download.
Parameters:
Name Type Description
id string | number the id of the download
Source:
Returns:
Type
Promise

setConfVar(name, value, options) → {Promise}

Stores a value on Topcat.
Parameters:
Name Type Description
name string the name of the value
value object the value to be stored
options object as specified in the Angular documentation
Source:
Returns:
Type
Promise

setConfVar(name, value, timeout) → {Promise}

Stores a value on Topcat.
Parameters:
Name Type Description
name string the name of the value
value object the value to be stored
timeout Promise if resolved will cancel the request
Source:
Returns:
Type
Promise

setConfVar(name, value) → {Promise}

Stores a value on Topcat.
Parameters:
Name Type Description
name string the name of the value
value object the value to be stored
Source:
Returns:
Type
Promise

setDownloadStatus(id, options) → {Promise}

Sets the status of a download.
Parameters:
Name Type Description
id string | number the id of the download
options object as specified in the Angular documentation
Source:
Returns:
Type
Promise

setDownloadStatus(id, status, timeout) → {Promise}

Sets the status of a download.
Parameters:
Name Type Description
id string | number the id of the download
status string can be 'ONLINE', 'ARCHIVE' or 'RESTORING'
timeout Promise if resolved will cancel the request
Source:
Returns:
Type
Promise

setDownloadStatus(id, status) → {Promise}

Sets the status of a download.
Parameters:
Name Type Description
id string | number the id of the download
status string can be 'ONLINE', 'ARCHIVE' or 'RESTORING'
Source:
Returns:
Type
Promise