Index

$#! · 0-9 · A · B · C · D · E · F · G · H · I · J · K · L · M · N · O · P · Q · R · S · T · U · V · W · X · Y · Z

A
	access, RemoteStorage
	addEventListener, eventhandling
	authing, RemoteStorage
B
	base, RemoteStorage.BaseClient
C
	caching, RemoteStorage
	cachinglayer
	cachingLayer, cachinglayer
	change RemoteStorage.BaseClient RemoteStorage.WireClient
	changesQueued, RemoteStorage.IndexedDB
	changesRunning, RemoteStorage.IndexedDB
	checkPath, RemoteStorage.Caching
	claim, RemoteStorage.Access
	connect RemoteStorage RemoteStorage.Widget.View
	connected RemoteStorage RemoteStorage.WireClient
	connecting, RemoteStorage
D
	declareType, RemoteStorage.BaseClient baseclient.js baseclient/types.js
	defineModule, RemoteStorage
	disable, RemoteStorage.Caching
	disableLog, RemoteStorage
	disconnect RemoteStorage RemoteStorage.Widget.View
	disconnected, RemoteStorage
	display RemoteStorage.Widget RemoteStorage.Widget.View
	displayWidget RemoteStorage RemoteStorage.Widget
E
	enable, RemoteStorage.Caching
	enableLog, RemoteStorage
	error, RemoteStorage
	eventhandling
	eventHandling, eventhandling
	Events RemoteStorage RemoteStorage.BaseClient RemoteStorage.Widget.View RemoteStorage.WireClient
F
	features-loaded, RemoteStorage
	fetchDelta, RemoteStorage.Dropbox
	fixArrayBuffers, cachinglayer
	Functions cachinglayer eventhandling RemoteStorage RemoteStorage.AccessRemoteStorage.BaseClient baseclient.js baseclient/types.js RemoteStorage.Caching RemoteStorage.Dropbox RemoteStorage.Sync RemoteStorage.Widget RemoteStorage.Widget.View
G
	getAll, RemoteStorage.BaseClient
	getBackgroundSyncInterval, RemoteStorage.Sync
	getCurrentSyncInterval, RemoteStorage.Sync
	getFile, RemoteStorage.BaseClient
	getItemURL, RemoteStorage.BaseClient
	getListing, RemoteStorage.BaseClient
	getObject, RemoteStorage.BaseClient
	getSyncInterval, RemoteStorage.Sync
H
	hideBubble, RemoteStorage.Widget.View
	href, RemoteStorage.WireClient
L
	local, RemoteStorage
	log RemoteStorage RemoteStorage.RemoteStorage
N
	not-connected, RemoteStorage
O
	on, eventhandling.eventhandling
	onActivate, RemoteStorage.Caching
	onChange, RemoteStorage
P
	Properties RemoteStorage RemoteStorage.Access RemoteStorage.BaseClient RemoteStorage.IndexedDB RemoteStorage.WireClient
R
	ready, RemoteStorage
	remote, RemoteStorage
	RemoteStorage
	RemoteStorage.Access
	RemoteStorage.BaseClient baseclient.js baseclient/types.js
	RemoteStorage.BaseClient.Types
	RemoteStorage.Caching
	RemoteStorage.Discover
	RemoteStorage.Dropbox
	RemoteStorage.GoogleDrive
	RemoteStorage.I18n
	RemoteStorage.IndexedDB
	RemoteStorage.InMemoryStorage
	RemoteStorage.LocalStorage
	RemoteStorage.Sync
	RemoteStorage.Widget
	RemoteStorage.Widget.View
	RemoteStorage.WireClient
	remove, RemoteStorage.BaseClient
	removeEventListener, eventhandling
	reset RemoteStorage.Caching RemoteStorage.Widget.View
	RS#scope, RemoteStorage.BaseClient

Tracking claimed access scopes.

addEventListener: function( eventName,
handler )

Install an event handler for the given event name

Fired before redirecting to the authing server

Base path this BaseClient operates on.

Caching settings.

This module defines functions that are mixed into remoteStorage.local when it is instantiated (currently one of indexeddb.js, localstorage.js, or inmemorystorage.js).

RemoteStorage.cachingLayer = function( object )

Mixes common caching layer functionality into an object.

Emitted when a node changes

never fired for some reason

Given a node for which uncommitted changes exist, this cache stores either the entire uncommitted node, or false for a deletion.

checkPath: function( path )

Retrieve caching setting for a given path, or its next parent with a caching strategy set.

claim: function( scope,
mode )

Claim access on a given scope with given mode.

connect: function( userAddress )

Connect to a remoteStorage server.

Emitted when the connect button is clicked

Fired when a remote storage has been connected

fired when the wireclient connect method realizes that it is in posession of a token and a href

Fired before webfinger lookup

Declare a remoteStorage object type using a JSON schema.

RemoteStorage.defineModule = function( moduleName,
builder )

Method for defining a new remoteStorage data module

disable: function( path )

Disable caching for a given path.

disableLog: function()

Disable remoteStorage logging

disconnect: function()

“Disconnect” from remotestorage server to terminate current session.

Emitted when the disconnect button is clicked

Fired after disconnect

display: function( options )

Displays the widget via the view.display method

display: function( options )

Draw the widget inside of the dom element with the id options.domID

Displays the widget at the top right of the page.

RemoteStorage.prototype.displayWidget = function( options )

Same as display

enable: function( path )

Enable caching for a given path.

enableLog: function()

Enable remoteStorage logging

Fired when an error occurs

RemoteStorage.eventHandling = function( object )

Mixes event handling functionality into an object.

Fired when all features are loaded

fetchDelta: function()

this method fetches the deltas from the dropbox api, used to sync the storage here we retrive changes and put them into the _revCache, those values will then be used to determin if something has changed.

function fixArrayBuffers( srcObj,
dstObj )

Takes an object and its copy as produced by the _deepClone function below, and finds and fixes any ArrayBuffers that were cast to `{}` instead of being cloned to new ArrayBuffers with the same content.

getAll: function( path,
maxAge )

Get all objects directly below a given path.

RemoteStorage.prototype.getBackgroundSyncInterval = function()

Get the value of the sync interval when application is in the background

RemoteStorage.prototype.getCurrentSyncInterval = function()

Get the value of the current sync interval

getFile: function( path,
maxAge )

Get the file at the given path.

getItemURL: function( path )

Retrieve full URL of item

getListing: function( path,
maxAge )

Get a list of child nodes below a given path.

getObject: function( path,
maxAge )

Get a JSON object from given path.

RemoteStorage.prototype.getSyncInterval = function()

Get the value of the sync interval when application is in the foreground

hideBubble: function()

Hide the bubble

Holds the server’s base URL, as obtained in the Webfinger discovery

Access to the local caching backend used.

log: function()

The same as RemoteStorage.log.

RemoteStorage.log = function()

Log using console.log, when remoteStorage logging is enabled.

Fired when ready, but no storage connected (“anonymous mode”)

Alias for addEventListener

onActivate: function( cb )

Set a callback for when caching is activated for a path.

onChange: function( path,
handler )

Add a “change” event handler to the given path.

Fired when ready

Access to the remote backend used.

TODO needs proper introduction and links to relevant classes etc

Keeps track of claimed access and scopes.

Provides a high-level interface to access data below a given root path.

Holds/manages caching configuration.

This class deals with the Webfinger lookup, discovering a connecting user’s storage details.

WORK IN PROGRESS, NOT RECOMMENDED FOR PRODUCTION USE

TODO add documentation

IndexedDB Interface

In-memory caching adapter.

localStorage caching adapter.

The widget controller that communicates with the view and listens to its remoteStorage instance.

Controls the visible widget

WireClient Interface

remove: function( path )

Remove node at given path from storage.

removeEventListener: function( eventName,
handler )

Remove a previously installed event handler

reset: function()

Reset the state of caching by deleting all caching information.

Emitted after crash triggers disconnect

Returns a new RS.BaseClient scoped to the given path.