Stream API v1 - Revision history

Sinisakrisan at 13:19, 1 February 2013

2013-02-01T13:19:40Z

Sinisakrisan: /* Aggregated activities */

2013-01-19T01:38:33Z

‎Aggregated activities

Sinisakrisan: /* Creating New Activity */

2013-01-19T01:37:24Z

‎Creating New Activity

Sinisakrisan at 18:21, 17 January 2013

2013-01-17T18:21:34Z

Sinisakrisan at 18:08, 17 January 2013

2013-01-17T18:08:18Z

Sinisakrisan at 18:07, 17 January 2013

2013-01-17T18:07:40Z

Sinisakrisan at 18:06, 17 January 2013

2013-01-17T18:06:19Z

Sinisakrisan: Created page with "{{alert|WARNING: API explained bellow works only with JomSocial 2.6 and below. If you need Activity Stream API for version 2.8 and above, [[Stream API..."

2013-01-17T18:05:17Z

Created page with "{{alert|<center><strong>WARNING:</strong> API explained bellow works only with JomSocial 2.6 and below. If you need Activity Stream API for version 2.8 and above, [[Stream API..."

New page

{{alert|<center><strong>WARNING:</strong> API explained bellow works only with JomSocial 2.6 and below. If you need Activity Stream API for version 2.8 and above, [[Stream API v2|click here]] </center>|alert-danger}}

← Older revision		Revision as of 13:19, 1 February 2013
Line 1:		Line 1:
−	{{alert\|<center><strong>WARNING:</strong> API explained bellow works only with JomSocial 2.6 and below. If you need Activity Stream API for version 2.8 ~~and above~~, [[Stream API v2\|~~click~~ here]] </center>\|alert-danger}}	+	{{alert\|<center><strong>WARNING:</strong> API explained bellow works only with JomSocial 2.6 and below. If you need Activity Stream API for version 2.8 you need to implement a slight change which is explained , [[Stream API v2\|here]] </center>\|alert-danger}}

	Activity stream represent a user action within the site. A user can follow his/her own or friends activity within the site. Activity stream will be visible in each user profile.<br />		Activity stream represent a user action within the site. A user can follow his/her own or friends activity within the site. Activity stream will be visible in each user profile.<br />

@@ Line 25: / Line 25: @@
 === Aggregated activities===
 Multiple activities can be aggregated into a single 'story'. For example
- John added Twitter application
+*John added Twitter application
- Jane added Twitter application
+*Jane added Twitter application
- Joe added Twitter application
+*Joe added Twitter application
 will be converted to
- John, Jane and Joe add Twitter application
+*John, Jane and Joe add Twitter application
 For the aggregator to work properly, the activities will need to be
- from the same application (app)
+*from the same application (app)
- with the same title
+*with the same title
- with the same cid (must not be null)
+*with the same cid (must not be null)
- the title contain the '{multiple}' hint.
+*the title contain the '{multiple}' hint.
 In the example above, all 3 entry have the same title, {actor} added Twitter application, same app code, (twitter) and same cid (20)
 <syntaxhighlight lang="php">
@@ Line 50: / Line 50: @@
 </syntaxhighlight>
 <br />
 === Formatting "title"===
 When writing a title, you would normally want to take advantage of JomSocial content replacement system instead of hard coding everything.

@@ Line 11: / Line 11: @@
 '''actor'''
- Actor is the person who carry out the action
+*Actor is the person who carry out the action
 '''target'''
- (Optional) A target is a user who's object is being manipulated by actor
+*(Optional) A target is a user who's object is being manipulated by actor
 '''title'''
- The actual activity title
+*The actual activity title
 '''content'''
- (optional) A longer description of the activity
+*(optional) A longer description of the activity
 '''apps'''
- The application name that the activity run on
+*The application name that the activity run on
 '''cid'''
- (optional) any unique id, unique to the application.
+*(optional) any unique id, unique to the application.
 === Aggregated activities===

@@ Line 11: / Line 11: @@
 '''actor'''
-Actor is the person who carry out the action
+ Actor is the person who carry out the action
 '''target'''
-(Optional) A target is a user who's object is being manipulated by actor
+ (Optional) A target is a user who's object is being manipulated by actor
 '''title'''
-The actual activity title
+ The actual activity title
 '''content'''
-(optional) A longer description of the activity
+ (optional) A longer description of the activity
 '''apps'''
-The application name that the activity run on
+ The application name that the activity run on
 '''cid'''
-(optional) any unique id, unique to the application.
+ (optional) any unique id, unique to the application.

@@ Line 8: / Line 8: @@
 ===Creating New Activity===
- Before you can create or register a new activity, you will need to understand some basic concept.
+Before you can create or register a new activity, you will need to understand some basic concept.
 '''actor'''
-    Actor is the person who carry out the action
+Actor is the person who carry out the action
 '''target'''
-    (Optional) A target is a user who's object is being manipulated by actor
+(Optional) A target is a user who's object is being manipulated by actor
 '''title'''
-    The actual activity title
+The actual activity title
 '''content'''
-    (optional) A longer description of the activity
+(optional) A longer description of the activity
 '''apps'''
-    The application name that the activity run on
+The application name that the activity run on
 '''cid'''
-    (optional) any unique id, unique to the application.
+(optional) any unique id, unique to the application.

@@ Line 1: / Line 1: @@
 {{alert|<center><strong>WARNING:</strong> API explained bellow works only with JomSocial 2.6 and below. If you need Activity Stream API for version 2.8 and above, [[Stream API v2|click here]] </center>|alert-danger}}
-Activity stream represent a user action within the site. A user can follow his/her own or friends activity within the site. Activity stream will be visible in each user profile.
+Activity stream represent a user action within the site. A user can follow his/her own or friends activity within the site. Activity stream will be visible in each user profile.<br />
-A user point system is calculated based on user activity.
+A user point system is calculated based on user activity.<br />
-However with the new UserPoints system introduced, now user point and activity are no longer tied to each other.
+However with the new UserPoints system introduced, now user point and activity are no longer tied to each other.<br />
-Each activity (new wall post, new blog entry, etc) can be assigned a point value through UserPoints API call.
+Each activity (new wall post, new blog entry, etc) can be assigned a point value through UserPoints API call.<br />
 Please refer to UserPoints System for more details on how points can be given to user.

← Older revision		Revision as of 18:06, 17 January 2013
Line 1:		Line 1:
	{{alert\|<center><strong>WARNING:</strong> API explained bellow works only with JomSocial 2.6 and below. If you need Activity Stream API for version 2.8 and above, [[Stream API v2\|click here]] </center>\|alert-danger}}		{{alert\|<center><strong>WARNING:</strong> API explained bellow works only with JomSocial 2.6 and below. If you need Activity Stream API for version 2.8 and above, [[Stream API v2\|click here]] </center>\|alert-danger}}
		+
		+	Activity stream represent a user action within the site. A user can follow his/her own or friends activity within the site. Activity stream will be visible in each user profile.
		+	A user point system is calculated based on user activity.
		+	However with the new UserPoints system introduced, now user point and activity are no longer tied to each other.
		+	Each activity (new wall post, new blog entry, etc) can be assigned a point value through UserPoints API call.
		+	Please refer to UserPoints System for more details on how points can be given to user.