socialize.showShareBarUI JS

Skip to end of metadata
Go to start of metadata

Description

This method displays the Share Bar plugin, which consists of one or more share buttons arranged in a horizontal or vertical bar. The buttons can be direct bookmark buttons, a general share button, or an email button. Certain bookmark buttons including the general share button can display a counter representing the number of shares. For more information regarding counters, refer to the socialize.getProviderShareCounts API method.

Once a user clicks a direct bookmark button, the window of the provider will be opened for direct bookmarking. Once a user clicks the general share button, the Simple Share mode of the Share plugin will pop up, enabling your user to share and bookmark content and site activities to a selected social destinations.

Notes:

  • If you plan on integrating the Share Bar plugin, we highly recommend reading the Share Bar plugin page in the Developer's Guide, which is a step-by-step guide for integrating the Share Bar plugin and also provides a reference and guide for the various customization options.
  • Full control over content shared to Facebook requires implementation of Open Graph meta tags in your website. Meta tags are supported by all major social networks. Meta tags can be tested and configured using the Facebook debugger and Google's webmaster tools. For more information see Sharing Content.   

 

 

Syntax

 

Parameters

The following table lists the available parameters:

RequiredNameTypeDescription

shareButtonsstring or an array of objects

An array of ShareButton objects or a string containing a comma-separated list of providers, representing the buttons to display in the share bar. When passing a comma-separated list, the plugin behaves as if an array of ShareButton objects was passed, where the only value in each object is the provider name.

Valid provider names include:

  • facebook
  • twitter
  • linkedIn
  • microsoft
  • delicious
  • whatsApp 
  • reddit
  • googleplus
  • googlebookmarks
  • vkontakte
  • spiceworks
  • viadeo
  • nkpl
  • xing
  • tuenti
  • pinterest*
  • kindle
  • baidu
  • friendfeed
  • tumblr
  • stumbleupon
  • qq
  • sina
  • mixi* *
  • wanelo
  • share

(Note: messenger has been replaced by microsoft, however, for backward compatibility, either can be used). 

delicious is not supported on IE9.

In addition to the provider names listed above, the comma-separated string containing the provider list may also include these reserved names, that implement the provider's own (native) button:

  • 'facebook-like' - represents the Facebook Like button. 
  • 'facebook-share' - represents the Facebook Share button. Items shared via the 'facebook-share' button do not appear in reports. 
  • 'facebook-send' - represents the Facebook Send button.
  • 'facebook-subscribe' - represents the  Facebook Subscribe button. This button can only be configured as a full ShareButton object, not by a simple string.
  • 'twitter-tweet' - represents the Twitter Tweet button.
  • 'twitter-hashtag' - represents the Twitter Hashtag button. Specifies a hashtag within the text and the button.
  • 'twitter-mention' - represents the Twitter Tweet to button. Allows you to specify a user to mention from within the text and the button.
  • 'google-plusone' - represents the Google +1 button.
  • 'googleplus-share' - represents the Google + Share button.
  • 'googleplus-interactive' - represents the Google + Interactive Post button.
  • 'moshare-sms' - represents the moShare button for mobile sharing via text message. moShare cannot be used over https.
  • 'foursquare' - represents the foursquare button.
  • 'foursquare-save' - represents the Save to foursquare button.
  • 'share' - represents a button in the share bar that triggers the Simple Share dialog.
  • 'email' - represents a button in the share bar that triggers the standard share dialog in email mode.
  • 'comments' - represents a Comments button. The button is displayed with a counter when the ShareButton object of the comments button contains the fields: categoryID and streamID, and the number of comments is larger than 0. When using the Comments plugin on the same page, use the onShareButtonClicked event to direct the user to the Comments box. See example below.
  • 'print' - represents a button in the share bar that triggers the print operation.
  • 'pinterest-pinit' - represents the Pinterest pin-it GD* button.
  • 'tvtag' - represents the TVTag button (formerly the GetGlue button).
  • 'lineit' - represents the LINE button. This button can be used in mobile only.
  • 'hatena-bookmark' - represents the Hatena bookmark button.

*** The Googleplus button is unable to display share counts because Google does not have an API that returns share counts.
**** The Pinterest pin-it button requires you to define a thumbnail URL in the userAction object, otherwise it won't work. 
* The 'hatena-bookmark' button text is in Japanese by default. To change it to English, add param " lang: 'en' " explicitly to Hatena's 'ShareButton Object'.

containerIDstringAn ID of a <div> element on the page in which you want to display the plugin.
userActionUserAction objectThe user action to share. The UserAction object enfolds newsfeed data, including text, media, link, etc., and is used to construct the newsfeed item for all networks except Facebook, Twitter and Google, which use Open Graph (OG) tags instead. For more information on using OG tags, see Sharing Content.
Notes:
  • A shared URL must match the approved URLs (domains) for the specified API key, otherwise the share will not work.

    When sharing URLs via any Gigya Add-ons, the URL being shared must be a publicly accessible URI. If the URI is behind a firewall, an HTTP Auth, or does not respond within 5 seconds of a request to retrieve the URL of the page, even if the URL is within a whitelisted domain, Gigya will respond with errorCode 400120 - Invalid Site Domain, and the share will fail.

     
  • When Twitter is the provider, only the Title and Link Back are posted.
actionAttributesJSON objectIn Gamification your users receive points for actions they perform on your site, in this case clicking a share button grants the user points. Action Attributes may be used to annotate actions with additional information, such as the section of the website that generated the action. If you set here the actionAttributes, each time a user clicks a share button, 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>" }

buttonImagesJSON objectUsing this object you may override the default design of a share button. Specify your alternative button images using the object fields. The following fields are supported:
  • buttonLeftImgUp
  • buttonLeftImgOver
  • buttonCenterBGImgUp
  • buttonCenterBGImgOver
  • buttonRightImgUp
  • buttonRightImgOver
  • countBGImg.

Read more in the Applying a New Button Design guide.

Notes:

  • The images are specified separately from the buttonTemplate in order to be pre-loaded. If pre-loading is not required the images may also be specified directly in the buttonTemplate.
  • Custom design can only be applied to generic and non-native buttons. Styling parameters applied to Social network native buttons take no effect. A list of native buttons can be found in the description of the 'shareButtons' parameter above.
buttonTemplatestring
(HTML)
This parameter enables you to override the default design of the buttons in the Share Bar that do not include a counter, such as the "Print" and "Email" buttons. The parameter defines an HTML template representing the appearance of each button. The HTML template supports the placeholders $iconImg, $text, $onClick. See Using Button Templates for information and examples.
buttonWithCountTemplatestring (HTML)This parameter enables you to override the default design of the buttons in the Share Bar that include a counter, such as the general "Share" button. The parameter defines an HTML template representing the appearance of each button. The HTML template supports the following placeholders: $iconImg, $text, $onClick, $count. See Using Button Templates for information and examples.
cidstring
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: This parameter overrides the value of the identical parameter in Global Conf (the global configuration object). If the parameter is not set for the method, the value from Global Conf is used.

contextobjectA reference to a developer created object that will be passed back unchanged to the event handlers as one of the fields of the eventObj (see extended explanation in the "Plugin Events" section below).
countURLURLAllows to specify a canonical URL and counts are then retrieved from this URL. The countURL ensures that the counts are incremented properly, and tracks counts against the canonical URL. To count Facebook's native buttons you must Enable Native SDK Capabilities (see the shareButtons parameter for native button details). Other native buttons will not be counted.
deviceTypestringDetermines the type of the device on which the Share Bar UI is displayed. The parameter supports the following values:
  • desktop  (default) - render the share bar in regular mode
  • mobile  - render the share bar in mobile view mode 
  • auto  - identify the device (user-agent) and if it is a mobile device, render in the mobile view mode

When the Share Bar is set to deviceType mobile or auto (on mobile), clicking the email share will open the mail client rather than the Gigya share bar UI.

displayCountThresholdintegerThe threshold of the counter to be displayed, i.e. each button in the share bar will display its counter only once it reaches this number. If the counter has not reached this threshold, the counter will not be displayed for the provider. The default value is 0.
This parameter does not apply to the Facebook Like/Send and Twitter buttons.
facebookDialogTypestringApplicable only for sharing through Facebook. This parameter determines which Facebook dialog will appear when clicking the share button. Options are:
  • 'share' (default value)
  • 'feed'

When using the 'share' dialog, it is required to implement open graph tags on your page, since Facebook's 'share' as well as other major social networks, use open graph tags to get the news feed item data for the shared item, rather than using data from the 'user action object'. 

grayedOutScreenOpacityinteger
(0-100)
This parameter allows you to gray-out the screen behind the plugin to emphasize the "modal" environment in Multiple Selection Share mode. Graying-out covers the entire page behind the plugin with a gray transparent layer. Using this parameter you can define the opacity of the gray layer. The value of this parameter should be a number between 0-100, where:
  • 0 - clear (not grayed out). This is the default, if this parameter is not set.
  • 100 - opaque (blacked out).
  • 20 - is our recommended value for gray-out opacity.
iconsOnlyBooleanThis parameter determines whether the share bar buttons are displayed as icons only, without text and borders. The default value of this parameter is 'false'.
initialViewstringDetermines the initial view of the plugin when it loads in Multiple Selection Share mode. There are three options:
  • 'share' (default) - shows the default share view.
  • 'more' - shows the "More" view. This option is only relevant if the showMoreButton parameter (see below) is set to 'true'. To learn more, please read the Adding More Destinations page.
  • 'email' - shows the "Email" view. This option is only relevant if the showEmailButton parameter (see below) is set to 'true'. To learn more, please read the Sharing via Email page.
KeystringUsing this parameter, you can specify all the API keys of the social networks that require an API key, e.g. 'mixiKey'.
layoutstringSets the arrangement of buttons in the bar. May be:
  • 'horizontal' (default)
  • 'vertical'
noButtonBordersBooleanThis parameter determines whether the share bar buttons are displayed without borders. The default value of this parameter is 'false' (the buttons are displayed with borders). This parameter is only applicable if iconsOnly is false.
shareCountCacheTimeoutintegerThis parameter defines how long the share counts data will be stored in local cache. The default value of this parameter is 300,000 milliseconds. The share counts data will not be refreshed within this interval, for better performance.
shareTimeoutintegerSets a timeout to the sharing operation in Multiple Selection Share mode. Set this parameter with the maximum number of seconds to wait for the sharing operation to be completed. If a timeout occurs, the Share plugin will close and an onError event will be fired with errorCode=504001 and errorMessage="Share request timeout".
shortURLsstring
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 based on the Data Center you are using.
    fw.to for US DC.
    shr.gs   for users of the European data center.
    vst.to for Australian DC.
  • '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 available for the following providers:

ProviderNote
FacebookN/A
TwitterN/A
LinkedInShortened URL is posted to the social network but traffic reports show abbreviated URL (e.g., http://developers.gigya.com/display/GD/showShareBarUI+JS is abbreviated to developers.gigya.com).
MicrosoftNot for share. (Note: messenger has been replaced by microsoft, however, for backward compatibility, either can be used).
DeliciousShortened URL is posted to the social network but traffic reports show abbreviated URL (e.g., http://developers.gigya.com/display/GD/showShareBarUI+JS is abbreviated to developers.gigya.com).
WhatsAppOnly on mobile.
RedditN/A
GooglePlusN/A
Google BookmarksN/A
VKontakteN/A
nk.plN/A
XingN/A
TuentiN/A
HatenaN/A
PinterestShortened URL is posted to the social network but traffic reports show abbreviated URL (e.g., http://developers.gigya.com/display/GD/showShareBarUI+JS is abbreviated to developers.gigya.com).
BaiduN/A
FriendFeedN/A
TumblrN/A
SinaN/A
mixiN/A

When Gigya's URL shortening service is active, Gigya tracks all the traffic coming from the distributed URLs. In such case, 'Referred Traffic' reports will be available to you.

 


Note: This parameter overrides the value of the identical parameter in Global Conf (the global configuration object). If the parameter is not set for the method, the value from Global Conf is used.

showCountsstringThis parameter determines if and where to display the share counts in relation to the share button. The options are:
  • 'right' (default)
  • 'top'
  • 'none'

The following providers support counters: 'facebook' , 'delicious', 'stumbleupon', 'linkedin', 'vkontakte', 'facebook-like',  'facebook-share', 'facebook-send', 'twitter-tweet', 'google-plusone', 'moshare-sms', 'share', 'comments', 'pinterest', 'pinterest-pinit', 'hatena-bookmark'. Note: for provider='moshare-sms'  the counters can be either right or none, if top is defined, the moshare button will not display counters. 

Shares posted using the generic +Share button will not be counted as shares made by the other buttons.

In addition, showCounts will only work when the shareButtons parameter (see above) is a string.

showTooltipsBooleanThis parameter's default value is 'false'. If set to 'true', a tooltip will be displayed when the mouse hovers over a social network icon. The tooltip presents the social network's full name. This parameter is relevant only in Multiple Selection Share mode.
tagsstringA comma separated list of tags that are used to identify the share operation.
UserActionUserAction objectIt is possible to specify different content to publish for each social network in Multiple Selection Share mode. For this purpose, the method supports a set of parameters with the same name format: (i.e., facebook, twitter, googleplus, etc.) followed by "UserAction". For example: twitter UserAction - specifies the content to be used specifically when publishing to Twitter.
Each of these optional parameters accepts a UserAction object and if specified override the userAction parameter when posting to that provider. In other words, the userAction parameter (see above) specifies the default content to be used for all social networks and UserAction specifies the content to be used for the specific network.
userMessagePlaceholderstringText that appears as a placeholder for the user message in the shareUI when in multiselect mode. When the user clicks the user message input box in the shareUI, the text disappears.
wrapBooleanIndicates whether to "wrap" the buttons in the Share Bar plugin. The default is 'false', and when set to 'true' the share bar's buttons will be automatically wrapped to the next line if the current line isn't wide enough to display all the buttons.  
Deprecated: 
facebookLikeButtonJSON object Deprecated . Please use the shareButtons parameter instead, along with the 'facebook-like' value.
This parameter adds the Facebook Like button to the share bar.

'Share' button related Parameters:

The following parameters are relevant only if you are in Multiple Selection Share mode and using the Simple Share dialog (enabled by creating a generic "Share" button).  By default the Share button opens a provider selection box, in which the last option is a "More" button which opens a second box showing all available providers. Gigya offers tens of additional destinations for social sharing. To learn more about this feature, please read the More Networks Screen page in the Developer's Guide.

showMoreButtonBooleanGigya offers tens of additional destinations for social sharing. The additional destination are provided through a "More" button on the Share Plugin. Using this parameter you can show/hide the "More" button. The default value is of this parameter is 'true' (button is shown). To learn more about this feature, see Adding More Destinations.
moreEnabledProviders, moreDisabledProvidersstring

Using these pair of parameters you may define which destination sites buttons will be displayed on the "More" screen, and also determine the order. In Simple Share mode, these are the providers that are displayed (not the  enabledProviders ). Each parameter is set with a comma separated string of destination names. These pair of parameters have similar logic to the enabledProviders and disabledProviders pair of parameters (see above). Valid destinations for the "More" screen include:
amazon, aolmail, baidu, bitly, blinklist, boxnet, currenttv, delicious, diigo, douban, dropjack, evernote, facebook, fark, faves, formspring, friendfeed, gmail, googlebookmarks, googleplus, hatena, kaboodle, linkagogo, linkedin, microsoft, mixi, mixx, myaol, netlog, newsvine, nkpl, odnoklassniki, pinterest, plaxo, qq, reddit, renren, segnalo, sina, skimbit, spiceworks, stumbleupon, technorati, tuenti, tumblr, twitter, viadeo, vkontakte, whatsapp, xing, yardbarker (Note: messenger has been replaced by microsoft, however, for backward compatibility, either can be used). 

To learn more about this feature, see Adding More Destinations.

Notes:

  • delicious is not supported on IE9.
  • Whatsapp  can only be used in iOS only, not in Android.
  • These parameters are not relevant if the showMoreButton parameter (see above) is set to 'false'.
  • In addition to the above automatic destinations, Gigya supports 150 more destinations. These destinations should be explicitly requested. Please contact us by filling in a support form on our site. You can also access the support page by clicking "Support" on the upper menu of Gigya's site. Check out the list of additional destinations here
'Email' button related Parameters: 
showEmailButtonBooleanGigya offers an option of sharing the user action via email. Sharing via email is provided through the enabling of a "Email" button on the Share Plugin. To enable the "Email" button, set this parameter to 'true' (The default value is 'false'). To learn more about this feature, see Sharing via Email.
emailBodystring (HTML)This parameter is only relevant if the showEmailButton parameter (see above) is set to 'true'. Using the "Email" screen of the Share plugin, users may send emails to selected email contacts. Gigya defines a default email body structure which is based on the User Action fields, and the message entered by the user in the Share Plugin. You may define an alternative email body, using the emailBody parameter. The email body should be defined in HTML format, and may include the following replacement strings: $sender$, $URL$, $userMsg$, $title$, $description$, and $actionLinkTitle$.
To learn more about this feature, see Sharing via Email.
dontSendEmailBooleanThis parameter is only relevant if the showEmailButton parameter (see above) is set to 'true'. Setting this parameter to 'true' instructs Gigya to not actually send an email when the user chooses to send one. You can use this parameter along with the onSendDone event data to send the actual email from your own servers. The default value is 'false' (Gigya server will send the email).
To learn more about this feature, see Sharing via Email.
emailProvidersstringA comma delimited list of email providers that should be displayed on the email screen for importing contacts. Valid provider names include: 'yahoo', 'googleplus'. When emailProviders=' ' , the Import Contacts header in the Share UI for share via email is hidden.
Auto Share related Parameters:
The following parameters are relevant only if you are in Multiple Selection Share mode. To learn more about this feature, please read the Automatic Sharing guide.
showAlwaysSharestringThis parameter determines whether to show an "Always share" checkbox at the bottom of the Share Plugin. If the user checks this checkbox and presses "Publish", Gigya will turn on an automatic share for this user. Each time this user repeats the same type of action, Gigya will automatically share the action without prompting the user with the Share Plugin. The type of action is determined using the autoShareActionID parameter (see below). The action will be shared on the Social Networks which the user selected when he checked the "Always share" checkbox. If a Network is no longer connected, the share will fail without notifying the user.
The optional values for this parameter are:
  • 'hide' (default) - do not display the "Always share" checkbox.
  • 'checked' - the "Always share" checkbox is displayed and checked by default.
  • 'unchecked' - the "Always share" checkbox is displayed and unchecked by default.
To apply this feature, you must set both showAlwaysShare and the autoShareActionID parameters.
autoShareActionIDstringUse this parameter to specify a unique identifier for the type of action that the user has performed on your site. For example: "Commented", "Rated", "Replied", "Liked", etc.
The user selection (Always Share) will apply only to this ID.
autoShareExpirationstringUsing this parameter, you may assign an expiration date/time for the user selection for the specific autoShareActionID. The default is never expire. The expected format is the Unix time format (i.e. the number of milliseconds since Jan. 1st 1970).
autoShareActionDisplaystringUsing this parameter, you may change the default text shown next to the "Always share" checkbox and the "Never share" link. The autoShareActionDisplay string will be appended to the "Always share" and "Never share" strings, i.e., "Always share XXX" and "Never share XXX", where XXX is the autoShareActionDisplay string. The default value of autoShareActionDisplay is the string "this".
Events Registration Parameters: 
onSendDonefunction refA reference to an event handler function that will be called when the process of sharing to the selected social network has finished. This does not include submitting comments; for comments use onShareButtonClicked .
Note that in some instances share actions fire OnSendDone before they have completed: for bookmark providers and emails onSendDone  will fire immediately, and for other providers it will fire after the share is complete.
onShareButtonClickedfunction refA reference to an event handler function that will be called when one of the plugin's buttons is clicked. To register a click on a provider's (native) button, use onSendDone.
onLoadfunction refA reference to an event handler function that will be called when the plugin has finished drawing itself.
onErrorfunction refA reference to an event handler function that will be called when an error occurs.

Plugin Events

An Event Handler is a JavaScript function with the following signature:

functionName(eventObj)

The single argument, eventObj, contains information about the event and has different fields for different events.

The following tables specify the list of fields available in the eventObj for each event:

onLoad Event Data

FieldTypeDescription
   
eventName string The name of the event.
source string The source plugin that generated this event. The value of this field is the name of the plugin's API method, e.g., 'showLoginUI', 'showCommentsUI', etc.
contextobject The context object passed by the application as parameter to the API method, or null if no context object has been passed.

onError Event Data

FieldTypeDescription
   
eventName string The name of the event.
source string The source plugin that generated this event. The value of this field is the name of the plugin's API method, e.g., 'showLoginUI', 'showCommentsUI', etc.
contextobject The context object passed by the application as parameter to the API method, or null if no context object has been passed.
errorCodeintegerThe 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.
errorMessagestringA short textual description of an error, associated with the errorCode, for logging purposes.
errorDetailsstringThis field will contain the exception info, if available.
 

onSendDone Event Data

FieldTypeDescription
   
eventName string The name of the event.
source string The source plugin that generated this event. The value of this field is the name of the plugin's API method, e.g., 'showLoginUI', 'showCommentsUI', etc.
contextobject The context object passed by the application as parameter to the API method, or null if no context object has been passed.
providersstringThe name of the sharing target (e.g., 'twitter', 'email'). Pinterest does not fire this event.
userMessagestringThe textual message that the user entered in the editable text box of the Share Plugin.
targetURLstringThe URL that was shared.

  

onSendDone Event Data - Email

When a user chooses to share via email, he will use the plugin's email screen and press the 'Send' button. In this situation, Gigya fires an onSendDone event with the providers field set to 'email' and with extra email related fields.

FieldTypeDescription
   
eventName string The name of the event.
source string The source plugin that generated this event. The value of this field is the name of the plugin's API method, e.g., 'showLoginUI', 'showCommentsUI', etc.
contextobject The context object passed by the application as parameter to the API method, or null if no context object has been passed.
providersstring'email'.
userMessagestringThe user custom message.
recipientsarrayAn array of objects that each has a name property and an email property corresponding to the recipients of the email that has been sent.
senderstringThe name or email of the sender.

To learn more about using this event, please read Sharing via Email.

onShareButtonClicked Event Data

FieldTypeDescription
   
eventName string The name of the event.
source string The source plugin that generated this event. The value of this field is the name of the plugin's API method, e.g., 'showLoginUI', 'showCommentsUI', etc.
contextobject The context object passed by the application as parameter to the API method, or null if no context object has been passed.
shareItemShareButton objectThe object representing the share button that has been clicked. Note: Pinterest does not fire this event.

 

Global Event Triggered

By using this Plugin, the following global event may be triggered: onConnectionAdded .

To register an event handler use the socialize.addEventHandlers API method. Refer to the onConnectionAdded event data. Refer to Events to learn more about how to handle events generated by the Gigya service.

Code Sample

var ua = new gigya.socialize.UserAction(); 
ua.setLinkBack("http://www.youtube.com/watch?v=jqxENMKaeCU"); 
ua.setTitle("Adobe Gets Into Widget Distribution And Advertising With Help From Gigya");

var params = { 
    userAction:ua,
    shareButtons: "facebook-like,google-plusone,share,twitter-tweet,email",
    containerID: 'divButtons' // The ID of the <DIV> element on the page in which the plugin is displayed
};

// Show the share bar
gigya.socialize.showShareBarUI(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 gigya.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.

Code Sample (using the comments provider with showCommentsUI)

When using the Share Bar Comments provider in conjunction with the Comments plugin (comments.showCommentsUI), you need to capture the Comments button click event in order to send the user to the Comments box on the page. This can be done as follows:

<script type="text/javascript">
    function chkButton(btn) {
            if (btn.shareItem.provider == 'comments') {
                var comDiv = document.getElementById('commentsDiv');
                comDiv.scrollIntoView(false);
                }
            }

var ua = new gigya.socialize.UserAction();
ua.setLinkBack("http://www.youtube.com/watch?v=jqxENMKaeCU");
ua.setTitle("Adobe Gets Into Widget Distribution And Advertising With Help From Gigya");

var shareBarParams = {
    userAction:ua,
    shareButtons:
    [
            { // General Share Button
                provider:'share',
                tooltip:'General Share Button',
                userMessage:'default user message'
            },
            ......
            { // Comments button
                provider: 'comments',
                categoryID: 'happyComments',
                streamID: '123',
             }
        ],
        containerID: 'divButtons', // location of the Share Bar plugin
        operationMode: 'multiSelect',
        onShareButtonClicked: chkButton
	};

// Show the share bar
gigya.socialize.showShareBarUI(shareBarParams);

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 gigya.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.

Important Note: If you intend to use socialize.showShareUI or socialize.showShareBarUI, it is required to check the Enable retrieving user contacts permission of the General Permissions page of the Gigya Console.

In the ShareBar Plugin demo you will find a complete working example, which uses the socialize.showShareBarUI method. You may view the code, run it and view the outcome.