JSDoc: Interface: User

Source:

tc-user.service.js, line 14

Methods

addCartItem(entityType, entityId, options) → {Promise.<Cart>}

Parameters:

Name	Type	Description
`entityType`	string
`entityId`	number
`options`	object	as specified in the Angular documentation

Source:

tc-user.service.js, line 386

Returns:

Type: Promise.<Cart>

addCartItem(entityType, entityId, timeout) → {Promise.<Cart>}

Parameters:

Name	Type	Description
`entityType`	string
`entityId`	number
`timeout`	Promise	if resolved will cancel the request

Source:

tc-user.service.js, line 398

Returns:

Type: Promise.<Cart>

addCartItem(entityType, entityId) → {Promise.<Cart>}

Parameters:

Name	Type	Description
`entityType`	string
`entityId`	number

Source:

tc-user.service.js, line 410

Returns:

Type: Promise.<Cart>

addCartItems(items, options) → {Promise.<Cart>}

Parameters:

Name	Type	Description
`items`	array
`options`	object	as specified in the Angular documentation

Source:

tc-user.service.js, line 329

Returns:

Type: Promise.<Cart>

addCartItems(timeout, items) → {Promise.<Cart>}

Parameters:

Name	Type	Description
`timeout`	Promise	if resolved will cancel the request
`items`	array

Source:

tc-user.service.js, line 363

Returns:

Type: Promise.<Cart>

addCartItems(items) → {Promise.<Cart>}

Parameters:

Name	Type	Description
`items`	array

Source:

tc-user.service.js, line 374

Returns:

Type: Promise.<Cart>

cart(options) → {Promise.<Cart>}

Parameters:

Name	Type	Description
`options`	object	as specified in the Angular documentation

Source:

tc-user.service.js, line 286

Returns:

Type: Promise.<Cart>

cart(timeout) → {Promise.<Cart>}

Parameters:

Name	Type	Description
`timeout`	Promise	if resolved will cancel the request

Source:

tc-user.service.js, line 308

Returns:

Type: Promise.<Cart>

cart() → {Promise.<Cart>}

Source:

tc-user.service.js, line 318

Returns:

Type: Promise.<Cart>

deleteAllCartItems(options) → {Promise.<Cart>}

Parameters:

Name	Type	Description
`options`	object	as specified in the Angular documentation

Source:

tc-user.service.js, line 540

Returns:

Type: Promise.<Cart>

deleteAllCartItems(timeout) → {Promise.<Cart>}

Parameters:

Name	Type	Description
`timeout`	Promise	if resolved will cancel the request

Source:

tc-user.service.js, line 558

Returns:

Type: Promise.<Cart>

deleteAllCartItems() → {Promise.<Cart>}

Source:

tc-user.service.js, line 568

Returns:

Type: Promise.<Cart>

deleteCartItem(id, options) → {Promise.<Cart>}

Parameters:

Name	Type	Description
`id`	string \| number
`options`	object	as specified in the Angular documentation

Source:

tc-user.service.js, line 497

Returns:

Type: Promise.<Cart>

deleteCartItem(id, timeout) → {Promise.<Cart>}

Parameters:

Name	Type	Description
`id`	string \| number
`timeout`	Promise	if resolved will cancel the request

Source:

tc-user.service.js, line 508

Returns:

Type: Promise.<Cart>

deleteCartItem(id) → {Promise.<Cart>}

Parameters:

Name	Type	Description
`id`	string \| number

Source:

tc-user.service.js, line 519

Returns:

Type: Promise.<Cart>

deleteCartItems(items, options) → {Promise.<Cart>}

Parameters:

Name	Type	Description
`items`	array
`options`	object	as specified in the Angular documentation

Source:

tc-user.service.js, line 423

Returns:

Type: Promise.<Cart>

deleteCartItems(timeout, items) → {Promise.<Cart>}

Parameters:

Name	Type	Description
`timeout`	Promise	if resolved will cancel the request
`items`	array

Source:

tc-user.service.js, line 474

Returns:

Type: Promise.<Cart>

deleteCartItems(items) → {Promise.<Cart>}

Parameters:

Name	Type	Description
`items`	array

Source:

tc-user.service.js, line 485

Returns:

Type: Promise.<Cart>

deleteDownload(id, options) → {Promise}

Parameters:

Name	Type	Description
`id`	string \| number
`options`	object	as specified in the Angular documentation

Source:

tc-user.service.js, line 138

Returns:

Type: Promise

deleteDownload(id, timeout) → {Promise}

Parameters:

Name	Type	Description
`id`	string \| number
`timeout`	Promise	if resolved will cancel the request

Source:

tc-user.service.js, line 156

Returns:

Type: Promise

deleteDownload(id) → {Promise}

Parameters:

Name	Type	Description
`id`	string \| number

Source:

tc-user.service.js, line 167

Returns:

Type: Promise

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

Returns the current user's downloads.

Parameters:

Name	Type	Description
`queryOffset`	array	any JPQL from the where clause onwards
`options`	object	as specified in the Angular documentation

Source:

tc-user.service.js, line 25

Returns:

a deferred list of downloads

Type: Promise.<Array.<object>>

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

Returns the current user's downloads.

Parameters:

Name	Type	Description
`timeout`	Promise	if resolved will cancel the request
`queryOffset`	array	any JPQL from the where clause onwards

Source:

tc-user.service.js, line 63

Returns:

a deferred list of downloads

Type: Promise.<Array.<object>>

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

Returns the current user's downloads.

Parameters:

Name	Type	Description
`queryOffset`	array	any JPQL from the where clause onwards

Source:

tc-user.service.js, line 76

Returns:

a deferred list of downloads

Type: Promise.<Array.<object>>

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

Returns the current user's downloads.

Parameters:

Name	Type	Description
`timeout`	Promise	if resolved will cancel the request
`queryOffset`	string	any JPQL from the where clause onwards

Source:

tc-user.service.js, line 88

Returns:

a deferred list of downloads

Type: Promise.<Array.<object>>

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

Returns the current user's downloads.

Parameters:

Name	Type	Description
`queryOffset`	string	any JPQL from the where clause onwards

Source:

tc-user.service.js, line 101

Returns:

a deferred list of downloads

Type: Promise.<Array.<object>>

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

Returns the current user's downloads.

Parameters:

Name	Type	Description
`timeout`	Promise	if resolved will cancel the request

Source:

tc-user.service.js, line 113

Returns:

a deferred list of downloads

Type: Promise.<Array.<object>>

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

Returns the current user's downloads.

Source:

tc-user.service.js, line 125

Returns:

a deferred list of downloads

Type: Promise.<Array.<object>>

getDownloadTypeStatus(downloadType, options) → {Promise.<object>}

Parameters:

Name	Type	Description
`downloadType`	string	download type as defined in topcat.json (e.g. 'globus')
`options`	object	as specified in the Angular documentation

Source:

tc-user.service.js, line 238

Returns:

a deferred object containing disabled flag and string message

Type: Promise.<object>

getDownloadTypeStatus(downloadType, timeout) → {Promise.<object>}

Parameters:

Name	Type	Description
`downloadType`	string	download type as defined in topcat.json (e.g. 'globus')
`timeout`	Promise	if resolved will cancel the request

Source:

tc-user.service.js, line 257

Returns:

a deferred object containing disabled flag and string message

Type: Promise.<object>

getDownloadTypeStatus(downloadType) → {Promise.<object>}

Parameters:

Name	Type	Description
`downloadType`	string	download type as defined in topcat.json (e.g. 'globus')

Source:

tc-user.service.js, line 267

Returns:

a deferred object containing disabled flag and string message

Type: Promise.<object>

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

Parameters:

Name	Type	Description
`id`	string \| number	the ID of the download
`status`	string	can be 'ONLINE', 'ARCHIVE' or 'RESTORING'
`options`	object	as specified in the Angular documentation

Source:

tc-user.service.js, line 188

Returns:

Type: Promise

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

Parameters:

Name	Type	Description
`timeout`	Promise	if resolved will cancel the request
`id`	string \| number	the ID of the download
`status`	string	can be 'ONLINE', 'ARCHIVE' or 'RESTORING'

Source:

tc-user.service.js, line 204

Returns:

Type: Promise

setDownloadStatus(id, status) → {Promise}

Parameters:

Name	Type	Description
`id`	string \| number	the ID of the download
`status`	string	can be 'ONLINE', 'ARCHIVE' or 'RESTORING'

Source:

tc-user.service.js, line 216

Returns:

Type: Promise

submitCart(fileName, transport, email, options) → {Promise.<Cart>}

Parameters:

Name	Type	Description
`fileName`	string	name of file into which the cart will be downloaded
`transport`	string	transport mechanism
`email`	string	optional address to send email when download is available
`options`	object	as specified in the Angular documentation

Source:

tc-user.service.js, line 579

Returns:

Type: Promise.<Cart>

submitCart(fileName, transport, email, timeout) → {Promise.<Cart>}

Parameters:

Name	Type	Description
`fileName`	string	name of file into which the cart will be downloaded
`transport`	string	transport mechanism
`email`	string	optional address to send email when download is available
`timeout`	Promise	if resolved will cancel the request

Source:

tc-user.service.js, line 611

Returns:

Type: Promise.<Cart>

submitCart(fileName, transport, email) → {Promise.<Cart>}

Parameters:

Name	Type	Description
`fileName`	string	name of file into which the cart will be downloaded
`transport`	string	transport mechanism
`email`	string	optional address to send email when download is available

Source:

tc-user.service.js, line 624

Returns:

Type: Promise.<Cart>