5,705
edits
Changes
Jump to navigation
Jump to search
Line 21:
Line 21: − + − − * ''guid''<br>Author's guid in the Sugar Network; might be omitted if a particular author is not registered in the Sugar Network; − − + − + + Line 54:
Line 52: − Context types:+ − − + − + + + + Line 64:
Line 64: − + Line 70:
Line 70: − + − + − + − + − + − + − + − + − + + + + + + + + + + + + + + + + + + + + + + + +
Sugar Network/Resources (view source)
Revision as of 02:59, 4 September 2014
, 02:59, 4 September 2014no edit summary
'''Resource.author'''
'''Resource.author'''
A list of authors working on the corresponding resource. List items are dictionaries with the following keys:
A dictionary of authors working on the corresponding resource. Keys are Sugar Network ''User'' guids, or, if particular author is not registered in the Sugar Network, full user names. Values are dictionaries with the following keys:
* ''name''<br>Full author's name;
* ''name''<br>Full author's name;
* ''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:
** ''1'', 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);
** ''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.
** ''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>
'''Context.type'''
'''Context.type'''
* ''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>
'''Context.releases'''
'''Context.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#Download_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>
<div id="post-type"></div>
'''Post.type'''
'''Post.type'''
* ''review'', Review the Context;
Choose Post types according to Context [[#context-type|types]] the Post belongs to.
* ''object'', Object generated by Context application;
* ''question'', Q&A request;
* ''topic'', general purpose discussion; ''talks'' Contexts;
* ''answer'', Q&A response;
* ''artefact'', object generated by Context application; ''activity'' Contexts;
* ''issue'', Propblem with the Context;
* ''issue'', problem with the Context; ''project'' Contexts;
* ''announce'', General announcement;
* ''poll'', a poll within the Context; ''project'' Contexts;
* ''notification'', Auto-generated Post for updates within the Context;
* ''post'', a comment for a parent Post object; Context type independent.
* ''feedback'', Review parent Post;
* ''post'', General purpose dependent Post.
<div id="post-topic"></div>
'''Post.topic'''
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'''
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.
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.
Resolutions for ''poll'' Post objects:
* ''open'', the poll is open for votes;
* ''closed'', the poll is closed for votes.