Changes

Jump to navigation Jump to search
1,177 bytes added ,  02:59, 4 September 2014
no edit summary
Line 26: Line 26:  
* ''role''<br>An integer which is a bit-wise ORed value of the following constants:
 
* ''role''<br>An integer which is a bit-wise ORed value of the following constants:
 
** ''0x1'', author is registered in the Sugar Network (and ''guid'' key is set);
 
** ''0x1'', author is registered in the Sugar Network (and ''guid'' key is set);
** ''0x10000'', 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.
+
** ''0x10000'', 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;
 +
* ''avatar''<br>An url to author's avatar.
    
<div id="resource-status"></div>
 
<div id="resource-status"></div>
Line 51: Line 52:  
'''Context.type'''
 
'''Context.type'''
   −
Context types:
+
* ''activity'', Sugar application;
* ''activity'', Sugar activity;
   
* ''book'', books in various forms;
 
* ''book'', books in various forms;
* ''group'', offline discussion groups;
+
* ''group'', a social group of related activities;
* ''package'', GNU/Linux package metadata.
+
* ''talks'', sub-type to mix-in offline discussion forum;
 +
* ''project'', sub-type to mix-in issue tracker and polling functionality.
 +
 
 +
Context type specifies how context, and all related resources, can be used. For example, ''activity'' type assumes activity bundles uploaded to the ''Context.releases'' property, or, [[#post-type|Post.type]] depends on Context type it was created for.
    
<div id="context-releases"></div>
 
<div id="context-releases"></div>
Line 62: Line 65:     
Contexts with ''activity'' or ''book'' types might have releases, i.e., activity or book versions that users can download. The ''releases'' property is aggregated where each item describes one particular version. There is no need in working with the ''releases'' property directly, there are high-level API commands to [[Sugar_Network/API#Upload_releases|upload]] and [[Sugar_Network/API#Retrieving_releases|download]] releases.
 
Contexts with ''activity'' or ''book'' types might have releases, i.e., activity or book versions that users can download. The ''releases'' property is aggregated where each item describes one particular version. There is no need in working with the ''releases'' property directly, there are high-level API commands to [[Sugar_Network/API#Upload_releases|upload]] and [[Sugar_Network/API#Retrieving_releases|download]] releases.
 +
 +
<div id="post-type"></div>
 +
 +
'''Post.type'''
 +
 +
Choose Post types according to Context [[#context-type|types]] the Post belongs to.
 +
 +
* ''topic'', general purpose discussion; ''talks'' Contexts;
 +
* ''artefact'', object generated by Context application; ''activity'' Contexts;
 +
* ''issue'', problem with the Context; ''project'' Contexts;
 +
* ''poll'', a poll within the Context; ''project'' Contexts;
 +
* ''post'', a comment for a parent Post object; Context type independent.
    
<div id="post-topic"></div>
 
<div id="post-topic"></div>
Line 67: Line 82:  
'''Post.topic'''
 
'''Post.topic'''
   −
Post objects might belong to a topic post. The system design assumes only a two-level Posts hierarchy.
+
Only ''post'' type Post objects belong to a parent Post which guid should be specified in the ''topic'' property. The system design assumes only a two-level Posts hierarchy.
 +
 
 +
<div id="post-topic"></div>
 +
 
 +
'''Post.resolution'''
   −
<div id="post-type"></div>
+
Post types ''issue'' and ''poll'' topics might have a resolution to expose the current status. The only way to change topic resolution is creating a dependent post with resolution property set.
   −
'''Post.type'''
+
Resolutions for ''issue'' Post objects:
 +
* ''unconfirmed'', newly created issue;
 +
* ''new'', confirmed issue;
 +
* ''needinfo'', posted information about the issue is insufficient, more details needed;
 +
* ''resolved'', the issue is resolved, closed;
 +
* ''unrelated'', the issue does not related to the Context, closed;
 +
* ''obsolete'', the issue is already solved in recent Context releases, closed;
 +
* ''duplicate'', the issue is a duplicate, closed.
   −
* ''topic'', general purpose top-level Post;
+
Resolutions for ''poll'' Post objects:
* ''post'', general purpose dependent Post;
+
* ''open'', the poll is open for votes;
* ''review'', review the Context (topic);
+
* ''closed'', the poll is closed for votes.
* ''object'', object generated by Context application (topic);
  −
* ''question'', Q&A request (topic);
  −
* ''problem'', problem with the Context (topic);
  −
* ''idea'', an idea for the Context (topic);
  −
* ''solution'', solution for question, problem, or, idea (post);
  −
* ''announce'', general announcement (topic);
  −
* ''notification'', auto-generated Post for updates within the Context (topic).
 

Navigation menu