Difference between revisions of "Stream API v1"

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.
+
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.
 
Please refer to UserPoints System for more details on how points can be given to user.
 +
 +
===Creating New Activity===
 +
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
 +
'''target'''
 +
    (Optional) A target is a user who's object is being manipulated by actor
 +
'''title'''
 +
    The actual activity title
 +
'''content'''
 +
    (optional) A longer description of the activity
 +
'''apps'''
 +
    The application name that the activity run on
 +
'''cid'''
 +
    (optional) any unique id, unique to the application.

Revision as of 18:07, 17 January 2013

WARNING: API explained bellow works only with JomSocial 2.6 and below. If you need Activity Stream API for version 2.8 and above, click here

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.

Creating New Activity

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

target

   (Optional) A target is a user who's object is being manipulated by actor

title

   The actual activity title

content

   (optional) A longer description of the activity

apps

   The application name that the activity run on

cid

   (optional) any unique id, unique to the application.