Was this article helpful?

socialize.getActions (deprecated)

Last modified 10:37, 1 Jul 2014

Description

This method is deprecated!

Returns a collection of user actions that have been added to the current user's action feed.

Supporting Providers

This operation is currently supported by the following providers: Facebook.

 

Syntax

gigya.socialize.getActions (deprecated)(params)

 

Method Parameters

The following table lists the params object members:

Required Name Type Description
Optional count number The maximum number of user actions to return. (default value is - 10)
  siteActionOnly boolean Lets you select if you wish to get only actions from this site or actions that have been reported by other sites as well. (default value is - true)
  filterActionName string If this parameter is set, the method will return only actions with the specified name. If this parameter is not set or if it is set to empty string, there will be no filtering.
  filterActionData1 string If this parameter is set, the method will return only actions with this value in the actionData1 field. If this parameter is not set or if it is set to empty string, there will be no filtering.
  filterActionData2 string If this parameter is set, the method will return only actions with this value in the actionData2 field. If this parameter is not set or if it is set to empty string, there will be no filtering.
  filterTarget string This parameter has two optional values: 'self', 'friends' (default value is - 'friends').
If this parameter is set to 'self', the method will return only the users own actions. Else, the method will return only user's friends' actions.
  callback function A reference to a callback function. Gigya calls the specified function along with the results of the API method when the API method completes.
The callback function should be defined with the following signature: functionName(response).
The "Response object Data Members" table below provides specification of the data that is passed to the callback function.
  enabledProviders string A comma-delimited list of provider names to include in the method execution. This parameter gives the possibility to apply this method only to a subset of providers of your choice. If you do not set this parameter, by default all the providers are enabled (i.e. the method applies to all connected providers).
For example, if you would like the method to apply only to Facebook and Twitter, define: enabledProviders: "facebook, twitter".
Valid provider names include: 'facebook'.
  disabledProviders string A comma-delimited list of provider names to exclude in the method execution. This parameter gives the possibility to specify providers to which that you don't want this method to apply. If you do not set this parameter, by default no provider is disabled (i.e. the method applies to all connected providers).
For example, if you would like the method to apply to all providers except Google+ and Twitter, define: disabledProviders: "googleplus, twitter".
Valid provider names include: 'facebook'.
  cid string A string of maximum 100 characters length. The CID sets categories for transactions that can be used later for filtering reports generated by Gigya in the "Context ID" combo box. The CID allows you to associate the report information with your own internal data. For example, to identify a specific widget or page on your site/application. You should not define more than 100 different context IDs.
  context object A developer-created object that is passed back unchanged to the application as one of the fields in the response object.

 

Response Object Data Members

errorCode integer The result code of the operation. Code '0' indicates success, any other number indicates failure. For a complete list of error codes, see the Error Codes table. errorMessage string A short textual description of an error associated with the errorCode for logging purposes. operation string The name of the API method that generated this response. context object The context object passed by the application as parameter to the API method, or null if no context object has been passed.

Field Type Description
actions Collection A collection of UserAction objects from the current user's actions feed.

 

 

Code Sample

var conf = { 
    APIKey:'2_fA4cZD0cEmxKUjDdNai8hyK4fZ-Jq7w4qm1x-pkS-7E6NDm90gAmrdcugVoaewUS'
};

function printResponse(response) {    
    if ( response.errorCode == 0 ) { 
        alert('After getActions'); 
        var actions = response['actions'].asArray();
        for (var index in actions) {
            alert("Actor #" + index + ": " + actions[index].getActor() + " Action: " + actions[index].getActionName());
        }
    }
}
			
var params={  
  siteActionOnly:false,  
  filterTarget:'friends',  
  callback:printResponse,  
  context:{method:'getActions'}  
};

			
gigya.socialize.getActions(conf,params);

Notes:
  • This sample is not meant to be fully functional code. For brevity's sake, only the code required for demonstrating the API call itself is presented.
  • To run the code on your own domain, add your Gigya API key to the socialize.js URL. A Gigya API key can be obtained on the Site Dashboard page on Gigya's website. Please make sure that the domain from which you are loading the page is the same domain name that you used for generating the API key.
  • In some cases it is necessary to connect/login the user to a provider? prior to calling the API method. You can learn more in the Social Login guide.

Was this article helpful?
Page statistics
1822 view(s) and 6 edit(s)
Social share
Share this page?

Tags

This page has no custom tags set.

Comments

You must to post a comment.

Attachments