Sugar Network/Resources: Difference between revisions

Line 31:

** ''2'', author is the original author of the corresponding resource; if it is not set, user is only a maintainer, e.g., an uploader of a book which has its original authors.

'''Resource.~~layer~~'''

'''Resource.status'''

This is a system level property ~~to to track objects' condition~~. It is a list of ~~states~~ set ~~by the system during~~ the object ~~life cycle. Users cannot directly write to this property~~. Currently supported ~~states~~ are:

This is a system level property which can be set only by node editors. It is a list of "badges" editors set depending on the object quality. Currently supported statuses are:

* ''featured'', the object is popped up by node editors;

* ''featured'', the object is popped up by node editors.

* ''~~deleted~~''~~, set after removing~~ objects ~~by users; right after user deletes,~~ the ~~object still remains in the system but becomes inaccessible to user requests;~~

* ''favorite'', applied to [[Sugar_Network/API#Client_proxy|local]] ~~Context objects only~~, set if a user has ''"stared"'' the ~~context~~;

* ''checkin'', applied to ~~[[Sugar_Network/API#Client_proxy|local]]~~ Context objects only, set if a user has ''"pinned"'' the context to keep its most recent version permanently in the local system;

* ''stale'', applied to ~~[[Sugar_Network/API#Client_proxy|local]]~~ Context objects only, set if previously checked-in Context might have more fresh releases on the ~~server~~; it is not possible to filter Contexts by this ~~state~~;

'''Resource.pins'''

* ''inprogress'', applied to ~~[[Sugar_Network/API#Client_proxy|local]]~~ Context objects only, set if the Context is in the process of downloading content from the ~~server~~; it is being temporally set before launching the Context of checking it in; it is not possible to filter Contexts by this ~~state~~.

This property makes sense only for objects provided from the [[Sugar_Network/API#Client_proxy|local proxy]]. The property is intended to store local user's preferences or statuses remote object has in local environment. Currently supported values are:

* ''favorite'', set if a user has ''"stared"'' the object;

* ''checkin'', applied to Context objects only, set if a user has ''"pinned"'' the context to keep its most recent version permanently in the local system;

* ''stale'', applied to Context objects only, set if previously checked-in Context might have more fresh releases on the node; it is not possible to filter Contexts by this value;

* ''inprogress'', applied to Context objects only, set if the Context is in the process of downloading content from the node; it is being temporally set before launching the Context or checking it in; it is not possible to filter Contexts by this value.

@@ Line 31: / Line 31: @@
 ** ''2'', author is the original author of the corresponding resource; if it is not set, user is only a maintainer, e.g., an uploader of a book which has its original authors.
-<div id="resource-layer"></div>
+<div id="resource-status"></div>
-'''Resource.layer'''
+'''Resource.status'''
-This is a system level property to to track objects' condition. It is a list of states set by the system during the object life cycle. Users cannot directly write to this property. Currently supported states are:
+This is a system level property which can be set only by node editors. It is a list of "badges" editors set depending on the object quality. Currently supported statuses are:
-* ''featured'', the object is popped up by node editors;
+* ''featured'', the object is popped up by node editors.
-* ''deleted'', set after removing objects by users; right after user deletes, the object still remains in the system but becomes inaccessible to user requests;
-* ''favorite'', applied to [[Sugar_Network/API#Client_proxy|local]] Context objects only, set if a user has ''"stared"'' the context;
+<div id="resource-pins"></div>
-* ''checkin'', applied to [[Sugar_Network/API#Client_proxy|local]] Context objects only, set if a user has ''"pinned"'' the context to keep its most recent version permanently in the local system;
-* ''stale'', applied to [[Sugar_Network/API#Client_proxy|local]] Context objects only, set if previously checked-in Context might have more fresh releases on the server; it is not possible to filter Contexts by this state;
+'''Resource.pins'''
-* ''inprogress'', applied to [[Sugar_Network/API#Client_proxy|local]] Context objects only, set if the Context is in the process of downloading content from the server; it is being temporally set before launching the Context of checking it in; it is not possible to filter Contexts by this state.
+This property makes sense only for objects provided from the [[Sugar_Network/API#Client_proxy|local proxy]]. The property is intended to store local user's preferences or statuses remote object has in local environment. Currently supported values are:
+* ''favorite'', set if a user has ''"stared"'' the object;
+* ''checkin'', applied to Context objects only, set if a user has ''"pinned"'' the context to keep its most recent version permanently in the local system;
+* ''stale'', applied to Context objects only, set if previously checked-in Context might have more fresh releases on the node; it is not possible to filter Contexts by this value;
+* ''inprogress'', applied to Context objects only, set if the Context is in the process of downloading content from the node; it is being temporally set before launching the Context or checking it in; it is not possible to filter Contexts by this value.
 <div id="context-type"></div>