Was this article helpful?

socialize.sendNotification

Last modified 11:38, 15 Sep 2014

Description

Sends a notification to a list of friends. Note: To send a notification to a Twitter friend, the friend must be following you and you must also be following the friend.

Note: This method is also supported in our REST API. If you wish to execute this method from your server, please refer to REST API > socialize.sendNotification.

Supporting Providers

The following providers currently support this operation: Twitter, LinkedIn, and Yahoo.

 

Syntax

gigya.socialize.sendNotification(params)

 

Method Parameters

The following table lists the params object members:

Required Name Type Description
Required recipients string
 or
Collection
The list of recipients that will receive this notification. There are two options of defining this list:
1. string: a comma separated list of UIDs representing recipients.
2. Collection: A collection of User objects representing recipients (as returned by the Friends Selector Plugin).
  body string The content of the notification.
The notification body should not include HTML tags. Links should be provided as simple urls, not <a> tags. For Example:
body: 'Check out this lovely site: http://www.myLovelySite.com'

Each social network uses a different format for links. Gigya identifies your links and converts them to the proper format corresponding to the social network.
  subject string The subject of the notification.
Optional actionAttributes JSON object In Gamification your users receive points for actions they perform on your site, in this case sending a notification grants the user points. Action Attributes may be used to annotate actions with additional information, such as the section of the web site that generated the action. If you set here the actionAttributes, each time a user sends a notification, the action also receives an attribute, for example "tv-show":"glee", which can mean that the action was performed on the "Glee" page of the site. 
actionAttributes contain a JSON object comprised of a series of attribute keys (categories) with associated values. You can also use a generic "tags" key. No more than three values can be given, they can be with a single key or each have their own key. For more information see Variants and Action Attributes. Action attributes are later used to filter GM Plugins by a certain attribute.
Example:  {"<attribute key1>": ["<attribute value1>", "<attribute value2>"],  "<attribute key2>": "<attribute value3>" }
  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.
  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.
Note: the value of this parameter overrides the value of the identical parameter in the global configuration object.
  context object A developer-created object that is passed back unchanged to the application as one of the fields in the response object.
  shortURLs string

Using this parameter you may determine whether to use Gigya's URL shortening service for URLs passed in the status parameter. The optional values for this parameter are:

  • 'always' (default): always try to shorten URLs. Where providers permit, URLs are shortened to the fw.to domain. Customers using the European data center are shortened to the shr.gs domain.
  • 'whenRequired': URLs longer than 139 characters are shortened in accordance with provider preferences.
  • 'never' - never shorten URLs. Where providers permit, URLs are left untouched.

URL shortening requirements vary between providers and depend on the particular type of action and its content. URL shortening is only available for the providers LinkedIn, QQ, Twitter, mixi, and Hatena.
When Gigya's URL shortening service is active, Gigya tracks all the traffic coming from the distributed URLs. In such case, 'Referred Traffic' reportswill be available to you.


Note: the value of this parameter overrides the value of the identical parameter in the global configuration object.

 

Response Object Data Members

Field Type Description
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.

 

Code Sample

function printResponse(response) {  
    if ( response.errorCode == 0 ) { 					
        alert('Notification has been sent');
    }
    else {
        alert('Error :' + response.errorMessage);
    }
}

var params = {
    recipients: '_gid_+2tC3ZkFL&3er4hBQYa3PQ==' , 
    body: 'This is my message content', 
    subject: 'This is my subject',
    callback:printResponse
};

gigya.socialize.sendNotification(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.

 

In the Send notifications page you will find a complete working example which uses socialize.sendNotification method. You may view the code, run it and view the outcome.

Was this article helpful?
Pages that link here
Page statistics
179 view(s) and 1 edit(s)
Social share
Share this page?

Tags

This page has no custom tags.
This page has no classifications.

Comments

You must to post a comment.

Attachments