Sugar Network/Resources

From Sugar Labs
< Sugar Network
Revision as of 05:16, 31 December 2013 by Alsroot (talk | contribs)
Jump to: navigation, search

The following diagram shows the full list of objects implemented by the Sugar Network API.

Sugar Network objects

A list of authors working on the corresponding resource. List items are dictionaries with the following keys:

  • guid
    Author's guid in the Sugar Network; might be omitted if a particular author is not registered in the Sugar Network;
  • name
    Full author's name;
  • role
    An integer which is a bit-wise ORed value of the following constants:
    • 1, author is registered in the Sugar Network (and guid key is set);
    • 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.


This is an attempt to generalize the idea of user/resource levels with the idea that objects should not be removed from the Network immediately (only hidden, and permanently removed by Network administrators). So, every resource is associated with a layer, i.e., it might be visible for observers only if they requested this layer and have permissions to see it.
For now, only the following list of layers is implemented, but the layer concept might be reused for teachers related workflows later:
  • public, object is visible for everyone;
  • deleted Network objects' layer will be changed to deleted after removing objects by users.


Context types:
  • activity, Sugar activity;
  • book, books in various forms;
  • group, offline discussion groups;
  • package, GNU/Linux package metadata.


Short license names. The licenses should conform with the Activity Library licensing policy.


Stability level of the Implementation. Values conform to Sugar Network recipe specification.


A list of dependencies the Implementation requires to be installed in the system. The property is being auto populated from a spec file from the uploaded Implementation bundle. This field exists only to simplify users driven queries, the real dependency checking bases on spec files.


  • create, object was created;
  • update, object's properties were modified;
  • delete, object was deleted (hidden);
  • vote, object was voted/unvoted.


  • question
  • idea
  • problem


  • instance, Sugar activity instance object.