Record

Creating records

Records are created and retrieved using client.record.getRecord( 'name' );

const recordName = 'user/' + client.getUid() // "user/iqaphzxy-2o1pnsvcnbo"
const record = client.record.getRecord(recordName)

Methods

whenReady(callback)

Immediately executes the callback if the record is ready. Otherwise, it registers it as a callback for the ready event.

record.whenReady(record => {
  // data has now been loaded
})

set(path, value)

Used to set the data of the entire record or of a path within it to a given value.

// Set the entire record's data
record.set({
  personalData: {
    firstname: 'Homer',
    lastname: 'Simpson',
    status: 'married'
  },
  children: ['Bart', 'Maggie', 'Lisa']
});

// Update only firstname
record.set('personalData.firstname', 'Marge')

get(path)

Will return the entire record's data or - if called with a path the value for that path. Will return undefined if the path can't be found.

record.get() // Returns entire object
record.get('children[1]') // 'Maggie'
record.get('personalData.firstname') // 'Homer'

subscribe(path, callback, triggerNow)

Registers a callback that will be invoked whenever the record's value changes. Subscribes to any change to the record when called without a path argument or to the changes of a path within the record.

Optional: Passing true will execute the callback immediately with the record's current value.

Listening to any changes on the record:

// Subscribe to any change of the record
function userDataChanged(data) {
  // do stuff...
}
user.subscribe(userDataChanged)

Listening to changes on a specific path within the record:

// Only subscribe to the status of the user
function statusChanged( status ) {
  if (status !== 'married') {
    // I want my childhood back!
  }
}
user.subscribe('status', statusChanged, true)

unsubscribe(path, callback)

Removes a subscription previously made using record.subscribe(). Passing a path to unsubscribe removes the callback only for that specific path.

Unsubscribe all callbacks registered with the path status

user.unsubscribe('status')

Unsubscribe a specific callback registered for the path status

user.unsubscribe('status', statusChanged)

Unsubscribe a specific callback registered for the record

user.unsubscribe(userDataChanged)

Unsubscribe all callbacks not associated with a path

user.unsubscribe()

discard()

Removes all change listeners and notifies the platform that the client is no longer interested in updates for this record.

user.discard()
<div class="docbox infobox"><h3>Info</h3><ul><li>Especially for mobile apps it's crucial to minimize the amount of data that's sent to the app. Make sure to discard all unneeded records so the platform won't sent updates anymore.
Please note: the deepstream client keeps track of how many times a record was requested. Every time a component within your app calls `.getRecord()`, that count goes up. Every time `.discard()` is called the count goes down. Only when it reaches 0 will the client assume that no aspect of your app needs the record anymore and notify the platform.
</li></ul></div>


### delete()
This permanently deletes the record for all users.

```javascript
user.delete()

Properties

Events

ready

Emitted once the record has received its current data from the platform.

delete

Emitted when the record was deleted, whether by this client or by another.

discard

Emitted once the record was discarded.

error

Emitted if the record encounters an error. The error message is passed to the event callback.