JSDoc: Interface: Admin

Source:

tc-admin.service.js, line 14

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:

tc-admin.service.js, line 193

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:

tc-admin.service.js, line 210

Returns:

Type: Promise

deleteDownload(id) → {Promise}

Soft deletes a download.

Parameters:

Name	Type	Description
`id`	string \| number	the id of the download

Source:

tc-admin.service.js, line 223

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:

tc-admin.service.js, line 68

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:

tc-admin.service.js, line 118

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:

tc-admin.service.js, line 131

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:

tc-admin.service.js, line 143

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:

tc-admin.service.js, line 156

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:

tc-admin.service.js, line 168

Returns:

a deferred list of downloads

Type: Promise.<Array.<object>>

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

Returns all downloads.

Source:

tc-admin.service.js, line 180

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:

tc-admin.service.js, line 25

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:

tc-admin.service.js, line 41

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:

tc-admin.service.js, line 54

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:

tc-admin.service.js, line 246

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:

tc-admin.service.js, line 263

Returns:

Type: Promise

restoreDownload(id) → {Promise}

Restores a (soft deleted) download.

Parameters:

Name	Type	Description
`id`	string \| number	the id of the download

Source:

tc-admin.service.js, line 276

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:

tc-admin.service.js, line 406

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:

tc-admin.service.js, line 424

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:

tc-admin.service.js, line 438

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:

tc-admin.service.js, line 299

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:

tc-admin.service.js, line 317

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:

tc-admin.service.js, line 331

Returns:

Type: Promise

setDownloadTypeStatus(downloadType, disabled, message, options) → {Promise}

Parameters:

Name	Type	Description
`downloadType`	string	download type as defined in topcat.json (e.g. 'globus')
`disabled`	boolean	true to disable, false to enable
`message`	string	displayed to user if they try to use this download type
`options`	object	as specified in the Angular documentation

Source:

tc-admin.service.js, line 355

Returns:

Type: Promise

setDownloadTypeStatus(downloadType, disabled, message, timeout) → {Promise}

Parameters:

Name	Type	Description
`downloadType`	string	download type as defined in topcat.json (e.g. 'globus')
`disabled`	boolean	true to disable, false to enable
`message`	string	displayed to user if they try to use this download type
`timeout`	Promise	if resolved will cancel the request

Source:

tc-admin.service.js, line 380

Returns:

Type: Promise

setDownloadTypeStatus(downloadType, disabled, message) → {Promise}

Parameters:

Name	Type	Description
`downloadType`	string	download type as defined in topcat.json (e.g. 'globus')
`disabled`	boolean	true to disable, false to enable
`message`	string	displayed to user if they try to use this download type

Source:

tc-admin.service.js, line 392

Returns:

Type: Promise