Global

Members

_

(event)Emitter renamed to avoid confusion with prvy's events

Source:

accesses :ConnectionProfile

Manipulate accesses for this connection

Type:
  • ConnectionProfile
Source:

bookmarks :ConnectionProfile

Manipulate bookmarks for this connection

Type:
  • ConnectionProfile
Source:

events :ConnectionEvents

Manipulate events for this connection

Type:
Source:

eventTypes

Event types directory data.

Source:

FormData

Node-only utils

Source:

monitors

Manipulate this connection monitors

Source:

profile :ConnectionProfile

Manipulate app profile for this connection

Type:
  • ConnectionProfile
Source:

Stream :function

TODO write documentation with use cases.. !!

Type:
  • function
Source:

streams :ConnectionStreams

Manipulate streams for this connection

Type:
Source:

utility

Browser-only utils

Source:

Methods

getPreferredLanguage(supportedLanguages, desiredLanguage)

Method to get the preferred language, either from desiredLanguage or from the browser settings

Parameters:
Name Type Description
supportedLanguages Array

an array of supported languages encoded on 2characters
desiredLanguage String

(optional) get this language if supported
Source:

isValidExtrasFile(data)

Performs a basic check to avoid corrupt data (more smoke test than actual validation).

Parameters:
Name Type Description
data Object
Source:

isValidTypesFile(data)

Performs a basic check to avoid corrupt data (more smoke test than actual validation).

Parameters:
Name Type Description
data Object
Source:

loadExternalFiles(filename, type)

Method to load external files like javascript and stylesheet. this version of method only support to file types - js|javascript and css|stylesheet.

Parameters:
Name Type Description
filename String
type String

'js' or 'css'
Source:

parseResponseHeaders()

XmlHttpRequest's getAllResponseHeaders() method returns a string of response headers according to the format described here: http://www.w3.org/TR/XMLHttpRequest/#the-getallresponseheaders-method This method parses that string into a user-friendly key/value pair object.

Source:

supportCSS3()

//TODO check if it's robust Method to check the browser supports CSS3.

Source:
Returns:

boolean

Type Definitions

AccessInfo

Source:
See:

ConnectionStreamsOptions

Properties:
Name Type Attributes Description
parentId string

if parentId is null you will get all the "root" streams.
state string <optional>

'all' || null - if null you get only "active" streams
Source:

FilterLike

An pryv Filter or an object corresponding at what we can get with Filter.getData().

Type:
Properties:
Name Type Attributes Description
streams Array.<String> <optional>
tags Array.<String> <optional>
fromTime number <optional>
  • serverTime
toTime number <optional>
  • serverTime
modifiedSince number <optional>
  • serverTime
limit number <optional>
  • response to 'n' events
skip number <optional>
  • skip the first 'n' events of he response
Source:

NewEventLike

An newly created Event (no id, not synched with API) or an object with sufficient properties to be considered as an Event.

Type:
Properties:
Name Type Attributes Description
streamId String
type String
time number <optional>
Source: