Skip to content

Latest commit

 

History

History
321 lines (205 loc) · 8.04 KB

realtimedatabaseadapter.md

File metadata and controls

321 lines (205 loc) · 8.04 KB

EmberFire > RealtimeDatabaseAdapter

Class: RealtimeDatabaseAdapter

Persist your Ember Data models in the Firebase Realtime Database

// app/adapters/application.js
import RealtimeDatabaseAdapter from 'emberfire/adapters/realtime-database';

export default RealtimeDatabaseAdapter.extend({
  // configuration goes here
});

Hierarchy

object & Adapter<this>

↳ RealtimeDatabaseAdapter

Index

Properties

Methods

Properties

<Optional> databaseURL

● databaseURL: undefined | string

Defined in adapters/realtime-database.ts:83

Override the default database used by the RealtimeDatabaseAdapter

// app/adapters/application.js
import RealtimeDatabaseAdapter from 'emberfire/adapters/realtime-database';

export default RealtimeDatabaseAdapter.extend({
  databaseURL: 'https://DIFFERENT_DATABASE.firebaseio.com'
});

firebaseApp

● firebaseApp: ComputedProperty<FirebaseAppService, FirebaseAppService>

Defined in adapters/realtime-database.ts:50

Override the default FirebaseApp Service used by the RealtimeDatabaseAdapter: service('firebase-app')

// app/adapters/application.js
import RealtimeDatabaseAdapter from 'emberfire/adapters/realtime-database';
import { inject as service } from '@ember/service';

export default RealtimeDatabaseAdapter.extend({
  firebaseApp: service('firebase-different-app')
});

namespace

● namespace: string | undefined

Defined in adapters/realtime-database.ts:67

Namespace all of the paths

// app/adapters/application.js
import RealtimeDatabaseAdapter from 'emberfire/adapters/realtime-database';

export default RealtimeDatabaseAdapter.extend({
  namespace: 'environments/production'
});

Methods

createRecord

▸ createRecord<K>(_: Store, type: ModelRegistry[K], snapshot: Snapshot<K>): Promise<DataSnapshot>

Defined in adapters/realtime-database.ts:144

Type parameters:

K : keyof ModelRegistry

Parameters:

Name Type
_ Store
type ModelRegistry[K]
snapshot Snapshot<K>

Returns: Promise<DataSnapshot>

deleteRecord

▸ deleteRecord<K>(_: Store, type: ModelRegistry[K], snapshot: Snapshot<K>): Promise<any>

Defined in adapters/realtime-database.ts:155

Type parameters:

K : keyof ModelRegistry

Parameters:

Name Type
_ Store
type ModelRegistry[K]
snapshot Snapshot<K>

Returns: Promise<any>

findAll

▸ findAll<K>(store: Store, type: ModelRegistry[K]): Promise<DataSnapshot>

Defined in adapters/realtime-database.ts:89

Type parameters:

K : keyof ModelRegistry

Parameters:

Name Type
store Store
type ModelRegistry[K]

Returns: Promise<DataSnapshot>

findBelongsTo

▸ findBelongsTo<K>(store: Store, snapshot: Snapshot<K>, url: any, relationship: any): Promise<any>

Defined in adapters/realtime-database.ts:107

Type parameters:

K : keyof ModelRegistry

Parameters:

Name Type
store Store
snapshot Snapshot<K>
url any
relationship any

Returns: Promise<any>

findHasMany

▸ findHasMany<K>(store: Store, snapshot: Snapshot<K>, url: string, relationship: object): Promise<any>

Defined in adapters/realtime-database.ts:93

Type parameters:

K : keyof ModelRegistry

Parameters:

Name Type
store Store
snapshot Snapshot<K>
url string
relationship object

Returns: Promise<any>

findRecord

▸ findRecord<K>(_store: Store, type: ModelRegistry[K], id: string): Promise<DataSnapshot>

Defined in adapters/realtime-database.ts:85

Type parameters:

K : keyof ModelRegistry

Parameters:

Name Type
_store Store
type ModelRegistry[K]
id string

Returns: Promise<DataSnapshot>

query

▸ query<K>(_store: Store, type: ModelRegistry[K], options?: QueryOptions): Promise<DataSnapshot>

Defined in adapters/realtime-database.ts:116

Type parameters:

K : keyof ModelRegistry

Parameters:

Name Type
_store Store
type ModelRegistry[K]
Optional options QueryOptions

Returns: Promise<DataSnapshot>

queryRecord

▸ queryRecord<K>(_store: Store, type: ModelRegistry[K], options?: QueryOptions): Promise<DataSnapshot>

Defined in adapters/realtime-database.ts:120

Type parameters:

K : keyof ModelRegistry

Parameters:

Name Type
_store Store
type ModelRegistry[K]
Optional options QueryOptions

Returns: Promise<DataSnapshot>

shouldBackgroundReloadRecord

▸ shouldBackgroundReloadRecord(): boolean

Defined in adapters/realtime-database.ts:133

Returns: boolean

updateRecord

▸ updateRecord<K>(_: Store, type: ModelRegistry[K], snapshot: Snapshot<K>): Promise<any>

Defined in adapters/realtime-database.ts:137

Type parameters:

K : keyof ModelRegistry

Parameters:

Name Type
_ Store
type ModelRegistry[K]
snapshot Snapshot<K>

Returns: Promise<any>