Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

Name

Description

Options (Parameters passed to service in FireSpark)

Return Values

SessionBegin

Stores login information into session, authenticates and loads account template

  • cntr : string : Container selector for account panel : optional default '#account-panel'
  • sel : string : Selector for login form : optional default '#login-container'

None

SessionEnd

Deletes session and loads account template

  • cntr : string : Container selector for account panel : optional default '#account-panel'
  • sel : string : Selector for login form : optional default '#login-container'
  • data : object : Indicate whether to show invalid message : optional default { invalid : false }

None

ResourceLoad

Loads resource using GET and applies template into selected element

  • type : string : Resource Type : values (refer ResourceRESTURL service rsrctype values)
  • tabui : string : Saved reference index for Tabpanel : optional default 'tabuipanel'
  • title : string : Tab Title : optional default 'DSpace RESTUI'
  • id : number : Resource ID : optional default false
  • ld : string : HTML Loading content : optional default RESTClient.jquery.constant.loadmsg
  • anm : string : Animation Type : optional default 'fadein' : values ('fadein', 'fadeout', 'slidein', 'slideout')
  • dur : number : Animation Duration : optional default 100
  • dly : number : Animation Delay : optional default 0

None

ResourceEdit

Edits resource fields using PUT

  • type : string : Resource Type : values (refer ResourceRESTURL service rsrctype values)
  • id : number : Resource ID : optional default false
  • field : string : Resource Field
  • sel : string : Selector for element where response is to be loaded
  • cf : boolean : Confirm edit : optional default false
  • cfmsg : string : Confirmation Message : optional default 'Are you sure you want to continue ?'
  • ld : string : HTML Loading content : optional default RESTClient.jquery.constant.loadmsg
  • anm : string : Animation Type : optional default 'fadein' : values ('fadein', 'fadeout', 'slidein', 'slideout')
  • dur : number : Animation Duration : optional default 100
  • dly : number : Animation Delay : optional default 0

None

ResourceDelete

Deletes resource fields using DELETE

  • type : string : Resource Type : values (refer ResourceRESTURL service rsrctype values)
  • id : number : Resource ID : optional default false
  • field : string : Resource Field : optional default false
  • sel : string : Selector for element where response is to be loaded
  • cf : boolean : Confirm edit : optional default false
  • cfmsg : string : Confirmation Message : optional default 'Are you sure you want to continue ?'
  • ld : string : HTML Loading content : optional default RESTClient.jquery.constant.loadmsg
  • anm : string : Animation Type : optional default 'fadein' : values ('fadein', 'fadeout', 'slidein', 'slideout')
  • dur : number : Animation Duration : optional default 100
  • dly : number : Animation Delay : optional default 0

None

Helpers

Name

Description

Arguments

Return Value

getDate

Returns timestamp as properly formatted date string

time : number : Timestamp

date : string : Formatted Date

readFileSize

Returns size in bytes as properly formatted string

size : number : Size in bytes

size : string : Formatted Size

...