SAGE2: SAGE2_App

Asks server to launch app with values. On the server this will add additional associations like which app launched which. Part of the launch process will include calling back to this app and stating the id of the newly launched app.

• data <String>
  • name of app to launch. Has to correctly match.

Support for the RPC call to the server

• query <Object>

  parameter for RPC function on server

• funcName <String>

  return function name for broadcast or emit

• broadcast <Boolean>

  wether or not doing a return broadcast or emit

RPC to every application client (client-side)

• funcName <String>

  name of the function to be called in each client

• data <Object>

  parameters to the function call

Entry point for a RPC callback into the app. Needed to keep state consistant

• func <Function>

  actual method to call

• data <Object>

  parameters sent from server

Close the application itself

Method to create a layered div ontop the application

• backgroundColor <String>

  color in DOM-syntax for the div

Given a function, will attempt to determine the string name.

• callback <Function>
  • The function to get name as a string.

Performs full fill of app context menu and sends update to server. This provides one place(mostly) to change code for context menu.

Method to hide the layer

Calculate if the application is hidden in this display

Method returning the visibility of the layer

Used to check if display believes this app is shared with a remote site. This is done by checking if the sync icon is visible.

Calculate if the application is visible in this display

Asks server to launch app with values. On the server this will add additional associations like which app launched which. Part of the launch process will include calling back to this app and stating the id of the newly launched app.

• appName <String>
  • name of app to launch. Has to correctly match.
• paramObj <Object>
  • optional. What to pass the launched app. Appears within init() as serverDataInitValues.
• x <Integer | Undefined | Null>
  • optional. X coordinate to start the app at.
• y <Integer | Undefined | Null>

  -optional. Y coordinate to start the app at.

• funcToPassParams <String | Undefined | Null>
  • optional. app which called this function. Could be a function and will convert to string.

Loads a saved data file (from the saveFile function)

• filename <String>

  The filename to load

• callback <Function>

  function to call when loading is done

Prints message to local browser console and send to server. Accept a string as parameter or multiple parameters

• msg <Object>

  list of arguments to be printed

Method called after the draw function

• date <Date>

  current time from the server

Method called before the draw function, calculates timing and frame rate

• date <Date>

  current time from the server

Internal method for an actual draw loop (predraw, draw, postdraw). draw is called as needed

• date <Date>

  current time from the server

Register a callback to be called when receiving a updated file list from server

• mth <Method>

  method on object to be called back

Application request for fileBuffer

• fileName <String>

  name of the file to which data will be saved.

Application request for a new title

• newTitle <String>

  Text that will be set as the new title for this instance of the app.

SAGE2CopyState method called on init or load to copy state of app instance

• state <Object>

  contains state of app instance

SAGE2Init method called right after the constructor

• type <String>

  type of DOM element to be created (div, canvas, ...)

• data <Object>

  contains initialization values (id, width, height, state, ...)

Uses WebSocket to send a request to the server to save a file from the app into the media folders as an asset (image, pdf, ...)

• filename <String>

  The name for the file being saved

• ext <String>

  The file's extension

• data <String>

  The file's data

Uses WebSocket to send a request to the server to save a file from the app into the media folders. The file will be placed in a subdirectory of the media folders called savedFiles/appname/(subdir)?/ . The file name must not contains any directory characters ('/', '', etc.).

• subdir <String>

  Subdirectory within the app's folder to save file

• filename <String>

  The name for the file being saved

• ext <String>

  The file's extension

• data <String>

  The file's data

Sends data to any apps that this one launched. This doesn't go through server.

• func <String>
  • name of function to activate. Has to correctly match
• data <Object>
  • data to send. doens't have to be an object.

This is used to send data to a specific SAGE2 client. Usually UI clients.

• clientDest <String>
  • Which client to send the data.
• func <String>
  • What function to call on the client.
• paramObj <Object>
  • Object to give the function as parameter. This will have clientDest, func, and appId added.

Sends data to app that launched this one if possible. This doesn't go through server.

• func <String>
  • name of function to activate. Has to correctly match.
• data <Object>
  • data to send. doens't have to be an object.

Request fullscreen

Application request for a new size

• newWidth <Number>

  desired width

• newHeight <Number>

  desired height

Helper function to tell server about a destination. In addition to creating the variable on the server, will also subscribe to the variable. Name will be of format: app_id:destination:givenName

• nameSuffix <String>
  • name suffix
• value <Object>
  • the initial value. Probably is blank.
• description <Object>
  • description object
• callback <String>
  • what function will handle values given to the source

Helper function to tell server about a source. This will add additional markers to the variable. Name will be of format: app_id:source:givenName

• nameSuffix <String>
  • name suffix
• value <Object>
  • the value to store for this variable
• description <Object>
  • description object

Asks server for all variable names and their descriptions. Goes to callback as array. Contents of the array will be objects with two properties: nameOfValue and description.

• callback <String>
  • app which called this function. Could be a function and will convert to string.
• unsubscribe <Boolean>
  • optional. If true, will stop receiving updates for that variable.

Given the name of the variable, will ask server for the variable. The given callback will be activated with that variable's value. Current setup will not activate callback if there is no variable.

• nameOfValue <String>
  • which value to get
• callback <String>
  • function on app to give value. Could be a function ref and will convert to string.

Will remove all source and destination variables submitted to server. Expectation is this is not called by user (but the option is there) instead as part of cleanup on quit().

Given the name of the variable, remove variable from server. Expectation is this is not called by user (but the option is there) instead as part of cleanup on quit(). Sends an array of strings, which this function is just the specified value.

• namesOfValuesToRemove <String | Array>
  • Can give a single name as string, or an array of string to remove.

Helper function, given the variable name suffix, set value of variable on server. Checks in place to ensure value exists.

• nameSuffix <String>
  • name of value on server to set
• value <Object>
  • the value to store for this variable
• description <Object>
  • description object
• shouldRemoveValueFromServerWhenAppCloses <Boolean>
  • Optional. If true, app quit will remove value from server.

Given the name of the variable, set value of variable on server. Will create if doesn't exist.

• nameOfValue <String>
  • name of value on server to set
• value <Object>
  • the value to store for this variable
• description <Object>
  • description object
• shouldRemoveValueFromServerWhenAppCloses <Boolean>
  • Optional. If true, app quit will remove value from server.

Asks server for notifications of any new variables that are added to server. The callback will get one object with properties: nameOfValue and description.

• callback <String>
  • app which called this function. Could be a function and will convert to string.
• unsubscribe <Boolean>
  • optional. If true, will stop receiving notificaitons.

Given the name of a variable, will ask server to send its value each time it is assigned. Values will be sent to callback.

• nameOfValue <String>
  • app which called this function
• callback <String>
  • app which called this function. Could be a function and will convert to string.
• unsubscribe <Boolean>
  • optional. If true, will stop receiving updates for that variable.

Method to flip the visibility of the layer

Method to display the layer

Method called by SAGE2, and calls the application 'quit' method

Used to set status of event sharing. Activated through context menu.

Unregister a callback to be called when receiving a updated file list from server

• mth <Method>

  method on object to be called back

Change the title of the application window

• title <String>

  new title string