khanh.pndc/nextcloud-docs
1
0
Fork 0
mirror of https://github.com/nextcloud/documentation.git synced 2026-01-02 17:59:36 +07:00
Code Issues Packages Projects Releases Wiki Activity

updated angular js models to include hints on disabling cache updates while doing CRUD

Browse Source
This commit is contained in:
Bernhard Posselt
2013-03-19 12:46:40 +01:00
parent 48aa8dde94
commit a46fc7b893
1 changed files with 14 additions and 4 deletions
Download Patch File Download Diff File Expand all files Collapse all files

18
developer_manual/app/appframework/angular.rst
View File

@@ -199,20 +199,30 @@ Used as a model parent class and provides CRUD and caching logic for the JSON da
Adds a new item. If the item id is already present, it will be updated
.. js:function:: update(data)
.. js:function:: update(data[, clearCache=true])
:param object data: The object that should be updated
:param boolean clearCache: clears the existing queries cache. Set this to false if the update does not affect the queries on the model to improve performance
Updates an existing object by copying the attributes to the old one
Updates an existing object by copying the provided attributes to the old one. That means that if you want to update only one field simply pass an object with the correct id and the fields that should be overwritten.
.. js:function:: add(data)
Example:
.. code-block:: js
// udpate name and email
itemModel.update({id: 3, name: 'newName', email: 'newEmail'})
.. js:function:: add(data[, clearCache=true])
:param object data: The object that should be added
:param boolean clearCache: clears the existing queries cache. Set this to false if the update does not affect the queries on the model to improve performance
.. js:function:: getById(id)
.. js:function:: getById(id[, clearCache=true])
:param int id: The id of the object
:param boolean clearCache: clears the existing queries cache. Set this to false if the update does not affect the queries on the model to improve performance
:returns object: a data object by its id