The Ember Simple Auth API

BaseStore

import BaseStore from 'ember-simple-auth/session-stores/base';

The base class for all session stores. This serves as a starting point for implementing custom session stores and must not be used directly.

Session Stores persist the session's state so that it survives a page reload and is synchronized across multiple tabs or windows of the same application.

Methods

source public

clear( ) → Ember.RSVP.Promise

Clears the store.

BaseStores's implementation always returns a rejecting promise. This method must be overridden in subclasses.

Returns

→ Ember.RSVP.Promise

A promise that resolves when the store has been cleared successfully and rejects otherwise.

source public

persist(data) → Ember.RSVP.Promise

Persists the data. This replaces all currently stored data.

BaseStores's implementation always returns a rejecting promise. This method must be overridden in subclasses.

Arguments

data: Object

The data to persist

Returns

→ Ember.RSVP.Promise

A promise that resolves when the data has successfully been persisted and rejects otherwise.

source public

restore( ) → Ember.RSVP.Promise

Returns all data currently stored as a plain object.

BaseStores's implementation always returns a rejecting promise. This method must be overridden in subclasses.

Returns

→ Ember.RSVP.Promise

A promise that resolves with the data currently persisted in the store when the data has been restored successfully and rejects otherwise.

Events

source

sessionDataUpdated

Triggered when the session store's data changes due to an external event, e.g., from another tab or window of the same application. The session handles that event, passes the updated data to its authenticator's restore method and handles the result of that invocation accordingly.

Arguments

data: Object

The updated session data

Extends

Ember.Object

Uses

    Ember.Evented

Methods

Events