Flexberry Documentation
Syncer Class
Item Index
Methods
- _lazyInjections
- _scheduledDestroy
- init
- syncDown
- _onLookup
- _syncDownRecord
- addObserver
- beginPropertyChanges
- cacheFor
- decrementProperty
- destroy
- endPropertyChanges
- get
- getProperties
- getSyncUpProjectionName
- getWithDefault
- hasObserverFor
- incrementProperty
- notifyPropertyChange
- propertyDidChange
- propertyWillChange
- removeObserver
- reopen
- reopenClass
- resolveNotFoundRecord
- resolveServerError
- set
- setProperties
- syncUp
- toggleProperty
- toString
- willDestroy
Methods
_lazyInjections
()
Object
private
Returns a hash of property names and container names that injected
properties will lookup on the container lazily.
Returns:
Object:
Hash of all lazy injected property keys to container names
_scheduledDestroy
()
private
Invoked by the run loop to actually destroy the object. This is
scheduled for execution by the
destroy method.
init
()
private
Initialize offline store.
syncDown
(
Promise
public
-
descriptor -
[reload] -
[projectionName] -
[params]
Save specified records into local store (IndexedDB).
Parameters:
-
descriptorString | DS.Model | ArraytypeName, record, records.
-
[reload]Boolean optionalIf set to true then syncer perform remote reload for data, otherwise data will get from the store.
-
[projectionName]String optionalName of projection for remote reload of data. If not set then all properties of record, except navigation properties, will be read.
-
[params]Object optionalAdditional parameters for syncing down.
-
[queryObject]Query.QueryObject optionalQueryObject instance to make query if descriptor is a typeName.
-
[unloadSyncedRecords]Boolean optionalIf set to true then synced records will be unloaded from online store.
-
Returns:
Remove all records in local store.
_onLookup
()
private
Provides lookup-time type validation for injected properties.
_syncDownRecord
(
private
-
store -
record -
[reload] -
[projectionName] -
[params]
Saves data to local store.
Parameters:
-
storeDS.Store or SubclassStore of application.
-
recordDS.ModelRecord to save in local store.
-
[reload]Boolean optionalIf set to true then syncer perform remote reload for data, otherwise data will get from the store.
-
[projectionName]String optionalName of projection for remote reload of data. If not set then all properties of record, except navigation properties, will be read.
-
[params]Object optionalAdditional parameters for syncing down.
-
[queryObject]Query.QueryObject optionalQueryObject instance to make query if descriptor is a typeName.
-
[unloadSyncedRecords]Boolean optionalIf set to true then synced records will be unloaded from online store.
-
addObserver
(
public
-
key -
target -
method
Adds an observer on a property.
This is the core method used to register an observer for a property.
Once you call this method, any time the key's value is set, your observer
will be notified. Note that the observers are triggered any time the
value is set, regardless of whether it has actually changed. Your
observer should be prepared to handle that.
You can also pass an optional context parameter to this method. The
context will be passed to your observer method whenever it is triggered.
Note that if you add the same target/method pair on a key multiple times
with different context parameters, your observer will only be called once
with the last context you passed.
### Observer Methods
Observer methods you pass should generally have the following signature if
you do not pass a
context parameter:
`javascript
fooDidChange: function(sender, key, value, rev) { };
`
The sender is the object that changed. The key is the property that
changes. The value property is currently reserved and unused. The rev
is the last property revision of the object when it changed, which you can
use to detect if the key value has really changed or not.
If you pass a context parameter, the context will be passed before the
revision like so:
`javascript
fooDidChange: function(sender, key, value, context, rev) { };
`
Usually you will not need the value, context or revision parameters at
the end. In this case, it is common to write observer methods that take
only a sender and key value as parameters or, if you aren't interested in
any of these values, to write an observer that has no parameters at all.
beginPropertyChanges
()
Ember.Observable
private
Begins a grouping of property changes.
You can use this method to group property changes so that notifications
will not be sent until the changes are finished. If you plan to make a
large number of changes to an object at one time, you should call this
method at the beginning of the changes to begin deferring change
notifications. When you are done making changes, call
endPropertyChanges() to deliver the deferred change notifications and end
deferring.
Returns:
cacheFor
(
Object
public
-
keyName
Returns the cached value of a computed property, if it exists.
This allows you to inspect the value of a computed property
without accidentally invoking it if it is intended to be
generated lazily.
Parameters:
-
keyNameString
Returns:
Object:
The cached value of the computed property, if any
decrementProperty
(
Number
public
-
keyName -
decrement
Set the value of a property to the current value minus some amount.
`javascript
player.decrementProperty('lives');
orc.decrementProperty('health', 5);
`
Parameters:
Returns:
Number:
The new property value
destroy
()
Ember.Object
public
Destroys an object by setting the
isDestroyed flag and removing its
metadata, which effectively destroys observers and bindings.
If you try to set a property on a destroyed object, an exception will be
raised.
Note that destruction is scheduled for the end of the run loop and does not
happen immediately. It will set an isDestroying flag immediately.
Returns:
Ember.Object:
receiver
endPropertyChanges
()
Ember.Observable
private
Ends a grouping of property changes.
You can use this method to group property changes so that notifications
will not be sent until the changes are finished. If you plan to make a
large number of changes to an object at one time, you should call
beginPropertyChanges() at the beginning of the changes to defer change
notifications. When you are done making changes, call this method to
deliver the deferred change notifications and end deferring.
Returns:
get
(
Object
public
-
keyName
Retrieves the value of a property from the object.
This method is usually similar to using
object[keyName] or object.keyName,
however it supports both computed properties and the unknownProperty
handler.
Because get unifies the syntax for accessing all these kinds
of properties, it can make many refactorings easier, such as replacing a
simple property with a computed property, or vice versa.
### Computed Properties
Computed properties are methods defined with the property modifier
declared at the end, such as:
`javascript
fullName: function() {
return this.get('firstName') + ' ' + this.get('lastName');
}.property('firstName', 'lastName')
`
When you call get on a computed property, the function will be
called and the return value will be returned instead of the function
itself.
### Unknown Properties
Likewise, if you try to call get on a property whose value is
undefined, the unknownProperty() method will be called on the object.
If this method returns any value other than undefined, it will be returned
instead. This allows you to implement "virtual" properties that are
not defined upfront.
Parameters:
-
keyNameStringThe property to retrieve
Returns:
Object:
The property value or undefined.
getProperties
(
Object
public
-
list
To get the values of multiple properties at once, call
getProperties
with a list of strings or an array:
`javascript
record.getProperties('firstName', 'lastName', 'zipCode');
// { firstName: 'John', lastName: 'Doe', zipCode: '10011' }
`
is equivalent to:
`javascript
record.getProperties(['firstName', 'lastName', 'zipCode']);
// { firstName: 'John', lastName: 'Doe', zipCode: '10011' }
`
Parameters:
-
listString... | Arrayof keys to get
Returns:
getSyncUpProjectionName
(
-
modelName
Return name of projection to sync up by model name.
Parameters:
-
modelNameStringName of model to get sync up projection name.
Returns:
Name of projection to sync up.
getWithDefault
(
Object
public
-
keyName -
defaultValue
Retrieves the value of a property, or a default value in the case that the
property returns
undefined.
`javascript
person.getWithDefault('lastName', 'Doe');
`
Parameters:
Returns:
Object:
The property value or the defaultValue.
hasObserverFor
(
Boolean
private
-
key
Returns
true if the object currently has observers registered for a
particular key. You can use this method to potentially defer performing
an expensive action until someone begins observing a particular property
on the object.
Parameters:
-
keyStringKey to check
Returns:
incrementProperty
(
Number
public
-
keyName -
increment
Set the value of a property to the current value plus some amount.
`javascript
person.incrementProperty('age');
team.incrementProperty('score', 2);
`
Parameters:
Returns:
Number:
The new property value
notifyPropertyChange
(
Ember.Observable
public
-
keyName
Convenience method to call
propertyWillChange and propertyDidChange in
succession.
Parameters:
-
keyNameStringThe property key to be notified about.
Returns:
propertyDidChange
(
Ember.Observable
private
-
keyName
Notify the observer system that a property has just changed.
Sometimes you need to change a value directly or indirectly without
actually calling
get() or set() on it. In this case, you can use this
method and propertyWillChange() instead. Calling these two methods
together will notify all observers that the property has potentially
changed value.
Note that you must always call propertyWillChange and propertyDidChange
as a pair. If you do not, it may get the property change groups out of
order and cause notifications to be delivered more often than you would
like.
Parameters:
-
keyNameStringThe property key that has just changed.
Returns:
propertyWillChange
(
Ember.Observable
private
-
keyName
Notify the observer system that a property is about to change.
Sometimes you need to change a value directly or indirectly without
actually calling
get() or set() on it. In this case, you can use this
method and propertyDidChange() instead. Calling these two methods
together will notify all observers that the property has potentially
changed value.
Note that you must always call propertyWillChange and propertyDidChange
as a pair. If you do not, it may get the property change groups out of
order and cause notifications to be delivered more often than you would
like.
Parameters:
-
keyNameStringThe property key that is about to change.
Returns:
removeObserver
(
public
-
key -
target -
method
Remove an observer you have previously registered on this object. Pass
the same key, target, and method you passed to
addObserver() and your
target will no longer receive notifications.
reopen
()
public
Augments a constructor's prototype with additional
properties and functions:
`javascript
MyObject = Ember.Object.extend({
name: 'an object'
});
o = MyObject.create();
o.get('name'); // 'an object'
MyObject.reopen({
say: function(msg){
console.log(msg);
}
})
o2 = MyObject.create();
o2.say("hello"); // logs "hello"
o.say("goodbye"); // logs "goodbye"
`
To add functions and properties to the constructor itself,
see reopenClass
reopenClass
()
public
Augments a constructor's own properties and functions:
`javascript
MyObject = Ember.Object.extend({
name: 'an object'
});
MyObject.reopenClass({
canBuild: false
});
MyObject.canBuild; // false
o = MyObject.create();
`
In other words, this creates static properties and functions for the class.
These are only available on the class and not on any instance of that class.
`javascript
App.Person = Ember.Object.extend({
name : "",
sayHello : function() {
alert("Hello. My name is " + this.get('name'));
}
});
App.Person.reopenClass({
species : "Homo sapiens",
createPerson: function(newPersonsName){
return App.Person.create({
name:newPersonsName
});
}
});
var tom = App.Person.create({
name : "Tom Dale"
});
var yehuda = App.Person.createPerson("Yehuda Katz");
tom.sayHello(); // "Hello. My name is Tom Dale"
yehuda.sayHello(); // "Hello. My name is Yehuda Katz"
alert(App.Person.species); // "Homo sapiens"
`
Note that species and createPerson are *not* valid on the tom and yehuda
variables. They are only valid on App.Person.
To add functions and properties to instances of
a constructor by extending the constructor's prototype
see reopen
resolveNotFoundRecord
(
Promise
-
job
This method is called when a sync process not found record on server for delete or update.
Default behavior: Marked job as 'Не выполнено', not delete and not execute further when called syncUp method.
Parameters:
-
jobsubclass of DS.ModelInstance of
auditEntitymodel when restore which error occurred.
Returns:
Promise:
Promise that resolves updated job.
Example:
// app/services/syncer.js
import Syncer from 'ember-flexberry-data/services/syncer';
export default Syncer.extend({
...
resolveNotFoundRecord(job) {
if (job.get('operationType') === 'UPDATE') {
// It will be executed when next called syncUp method.
job.set('executionResult', 'Ошибка');
} else if (job.get('operationType') === 'DELETE') {
// It will be immediately delete and not never executed.
job.set('executionResult', 'Выполнено');
}
return job.save();
},
...
});
resolveServerError
(
Promise
-
job -
error
This method is called when a sync process if at attempt create, update or delete record, server error return.
Default behavior: Marked job as 'Ошибка', execute further when called syncUp method.
Parameters:
-
jobsubclass of DS.ModelInstance of
auditEntitymodel when restore which error occurred. -
errorObject
Returns:
Promise:
Promise that resolves updated job.
Example:
// app/services/syncer.js
import Syncer from 'ember-flexberry-data/services/syncer';
export default Syncer.extend({
...
resolveServerError(job, error) {
let _this = this;
return new RSVP.Promise((resolve, reject) => {
// Here error.status as example, as if user not authorized on server.
if (error.status === 401) {
// As if auth function authorize user.
auth().then(() => {
_this.syncUp(A([job])).then(() => {
job.set('executionResult', 'Выполнено');
resolve(job.save());
}, reject);
}, reject);
} else {
job.set('executionResult', 'Ошибка');
resolve(job.save());
}
});
},
...
});
set
(
Object
public
-
keyName -
value
Sets the provided key or path to the value.
This method is generally very similar to calling
object[key] = value or
object.key = value, except that it provides support for computed
properties, the setUnknownProperty() method and property observers.
### Computed Properties
If you try to set a value on a key that has a computed property handler
defined (see the get() method for an example), then set() will call
that method, passing both the value and key instead of simply changing
the value itself. This is useful for those times when you need to
implement a property that is composed of one or more member
properties.
### Unknown Properties
If you try to set a value on a key that is undefined in the target
object, then the setUnknownProperty() handler will be called instead. This
gives you an opportunity to implement complex "virtual" properties that
are not predefined on the object. If setUnknownProperty() returns
undefined, then set() will simply set the value on the object.
### Property Observers
In addition to changing the property, set() will also register a property
change with the object. Unless you have placed this call inside of a
beginPropertyChanges() and endPropertyChanges(), any "local" observers
(i.e. observer methods declared on the same object), will be called
immediately. Any "remote" observers (i.e. observer methods declared on
another object) will be placed in a queue and called at a later time in a
coalesced manner.
Returns:
Object:
The passed value
setProperties
(
Object
public
-
hash
Sets a list of properties at once. These properties are set inside
a single
beginPropertyChanges and endPropertyChanges batch, so
observers will be buffered.
`javascript
record.setProperties({ firstName: 'Charles', lastName: 'Jolley' });
`
Parameters:
-
hashObjectthe hash of keys and values to set
Returns:
Object:
The passed in hash
syncUp
(
Promise
-
[jobs] -
[options]
Start sync up process.
Parameters:
-
[jobs]Ember.Array optionalArray instances of
auditEntitymodel for sync up. -
[options]Object optionalObject with options for sync up.
Returns:
toggleProperty
(
Boolean
public
-
keyName
Set the value of a boolean property to the opposite of its
current value.
`javascript
starship.toggleProperty('warpDriveEngaged');
`
Parameters:
-
keyNameStringThe name of the property to toggle
Returns:
Boolean:
The new property value
toString
()
String
public
Returns a string representation which attempts to provide more information
than Javascript's "
"
toString typically does, in a generic way for all Ember
objects.
`javascript
App.Person = Em.Object.extend()
person = App.Person.create()
person.toString() //=> "`
If the object's class is not defined on an Ember namespace, it will
indicate it is a subclass of the registered superclass:
`javascript
Student = App.Person.extend()
student = Student.create()
student.toString() //=> "<(subclass of App.Person):ember1025>"
`
If the method toStringExtension is defined, its return value will be
included in the output.
`javascript
App.Teacher = App.Person.extend({
toStringExtension: function() {
return this.get('fullName');
}
});
teacher = App.Teacher.create()
teacher.toString(); //=> "`
Returns:
String:
string representation
willDestroy
()
public
Override to implement teardown.
Properties
concatenatedProperties
Array
public
Defines the properties that will be concatenated from the superclass
(instead of overridden).
By default, when you extend an Ember class a property defined in
the subclass overrides a property with the same name that is defined
in the superclass. However, there are some cases where it is preferable
to build up a property's value by combining the superclass' property
value with the subclass' value. An example of this in use within Ember
is the
classNames property of Ember.View.
Here is some sample code showing the difference between a concatenated
property and a normal one:
`javascript
App.BarView = Ember.View.extend({
someNonConcatenatedProperty: ['bar'],
classNames: ['bar']
});
App.FooBarView = App.BarView.extend({
someNonConcatenatedProperty: ['foo'],
classNames: ['foo']
});
var fooBarView = App.FooBarView.create();
fooBarView.get('someNonConcatenatedProperty'); // ['foo']
fooBarView.get('classNames'); // ['ember-view', 'bar', 'foo']
`
This behavior extends to object creation as well. Continuing the
above example:
`javascript
var view = App.FooBarView.create({
someNonConcatenatedProperty: ['baz'],
classNames: ['baz']
})
view.get('someNonConcatenatedProperty'); // ['baz']
view.get('classNames'); // ['ember-view', 'bar', 'foo', 'baz']
`
Adding a single property that is not an array will just add it in the array:
`javascript
var view = App.FooBarView.create({
classNames: 'baz'
})
view.get('classNames'); // ['ember-view', 'bar', 'foo', 'baz']
`
Using the concatenatedProperties property, we can tell Ember to mix the
content of the properties.
In Ember.View the classNameBindings and attributeBindings properties
are also concatenated, in addition to classNames.
This feature is available for you to use throughout the Ember object model,
although typical app developers are likely to use it infrequently. Since
it changes expectations about behavior of properties, you should properly
document its usage in each individual concatenated property (to not
mislead your users to think they can override the property in a subclass).
Default: null
isDestroyed
Unknown
public
Destroyed object property flag.
if this property is
true the observers and bindings were already
removed by the effect of calling the destroy() method.
Default: false
isDestroying
Unknown
public
Destruction scheduled flag. The
destroy() method has been called.
The object stays intact until the end of the run loop at which point
the isDestroyed flag is set.
Default: false
mergedProperties
Array
public
Defines the properties that will be merged from the superclass
(instead of overridden).
By default, when you extend an Ember class a property defined in
the subclass overrides a property with the same name that is defined
in the superclass. However, there are some cases where it is preferable
to build up a property's value by merging the superclass property value
with the subclass property's value. An example of this in use within Ember
is the
queryParams property of routes.
Here is some sample code showing the difference between a merged
property and a normal one:
`javascript
App.BarRoute = Ember.Route.extend({
someNonMergedProperty: {
nonMerged: 'superclass value of nonMerged'
},
queryParams: {
page: {replace: false},
limit: {replace: true}
}
});
App.FooBarRoute = App.BarRoute.extend({
someNonMergedProperty: {
completelyNonMerged: 'subclass value of nonMerged'
},
queryParams: {
limit: {replace: false}
}
});
var fooBarRoute = App.FooBarRoute.create();
fooBarRoute.get('someNonMergedProperty');
// => { completelyNonMerged: 'subclass value of nonMerged' }
//
// Note the entire object, including the nonMerged property of
// the superclass object, has been replaced
fooBarRoute.get('queryParams');
// => {
// page: {replace: false},
// limit: {replace: false}
// }
//
// Note the page remains from the superclass, and the
// limit property's value of false has been merged from
// the subclass.
`
This behavior is not available during object create calls. It is only
available at extend time.
This feature is available for you to use throughout the Ember object model,
although typical app developers are likely to use it infrequently. Since
it changes expectations about behavior of properties, you should properly
document its usage in each individual merged property (to not
mislead your users to think they can override the property in a subclass).
Default: null
numberOfRecordsForPerformingBulkOperations
Number
Number of "main" records (include related records for relationships) that should be accumulated before bulk operation will be performed.
Default: 10
offlineStore
DS.Store
Store that use for making requests in offline mode. By default it is set to global instane of LocalStore class.
queueContinueOnError
Boolean
Allows to enable or disable continuation of syncing down if error occurs.
Default: true