Page History

Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

RequiredNameTypeDescription
Include Page
Template_gs api common UI parameters
Template_gs api common UI parameters
No
versionintegerGigya offers a new improved version of the Add Connections plugin. To use the new plugin set this parameter to "2". All new implementations are required to use the new version, although existing implementations without this parameter will continue to function.
No
actionAttributesJSON objectIn Gamification your users receive points for actions they perform on your site, in this case adding a connection 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 adds a connection, 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. 
Include Page
Template_gs api actionAttributes description
Template_gs api actionAttributes description
No
authFlowstringUsing this parameter you may specify that the adding connection flow will use page redirects instead of using a popup. This gives a solution for environments where popups are unavailable (e.g. mobile web view controls). This parameter accepts two values:
  • "popup" (default)
  • "redirect" - the adding connection flow uses page redirects. When the adding connection process completes successfully, the user is redirected to the URL specified by the redirectURL parameter (see below). If the redirectURL parameter is not specified, the user will be redirected to the original page from which the adding connection process started.
    Notes: This option will only work if CNAME is configured.
    When using this mode, the onConnectionAdded event is not fired .
No
cidstring
Include Page
Template_gs api cid description
Template_gs api cid description

Include Page
Template_gs override params short note
Template_gs override params short note
No
customButtonsarray of JSON objects
Include Page
customButtons Object Description Template
customButtons Object Description Template
Deprec
customButtoncustomButton object

This parameter is deprecated. Use customButtons, above.

You may define any OpenID provider as an authentication destination - read more about Adding a Custom OpenID Provider 

You may also define a SAML login provider - read more about Adding a SAML Login Provider.

No
disabledProvidersstringA comma-delimited list of providers that should not be displayed in the plugin. The valid provider names are:
Include Page
Login Providers Full List Template 2016
Login Providers Full List Template 2016

For example, if you would like this plugin to show all providers but LinkedIn and Twitter, define: disabledProviders:"linkedin,twitter".
Include Page
Template_gs override params short note
Template_gs override params short note
No
enabledProvidersstringA comma-delimited list of providers to be displayed in the plugin. The valid provider names are:
Include Page
Login Providers Full List Template 2016
Login Providers Full List Template 2016

For example, if you would like this plugin to show only the icons of Facebook and Twitter, define: enabledProviders:"facebook,twitter".
Include Page
Template_gs override params short note
Template_gs override params short note
No
extraFieldsstring
Include Page
Template_gs api extraFields
Template_gs api extraFields
No
forceAuthenticationBoolean
Include Page
Template_gs api forceAuthentication parameter description
Template_gs api forceAuthentication parameter description
No
headerTextstringSets the plugin's header text.
No
redirectURLstring

This parameter is relevant only if the authFlow parameter is set to "redirect" (see above). Set this parameter with a URL to which to redirect the user when they log-in with the adding connection process. Users who have already logged-in with another connection will not be redirected.

The following additional parameters are appended to the URL string:
UID, UIDSig, timestamp, loginProvider, loginProviderUID loginProviderUID, nickname, photoURL, thumbnailURL, firstName, lastName, gender, birthDay, birthMonth, birthYear, email, country, state, city, zip, profileURL, provider.

These parameters are equivalent to the User object fields. Please find the parameters' description in the User object reference page.

If the redirectURL parameter is provided the callback function is not called and the onConnectionAdded event is not fired.

Panel
borderColor#81C0FC
bgColor#F4F7FC
borderWidth1
borderStylesolid

Note: We strongly advise providing a secure HTTPS URL.

No
requiredCapabilitiesstring
Include Page
Template_gs api requiredCapabilities parameter description
Template_gs api requiredCapabilities parameter description

You can set the requiredCapabilities parameter to login in order to add more providers such as Google and AOL. 
No
sessionExpirationintegerThis parameter defines the time in seconds that Gigya should keep the social network session valid for the user. To end the session when the browser closes, please assign the value '0'. If this parameter is not specified, the session will be valid forever.
No
showEditLinkBooleanShow or hide the "Edit" link. Clicking the "Edit" link opens a popup dialog that enables the user to edit his connection status to each of the social networks. Note: The "Edit" link only appears when connected to a social network. 
No
showTermsLinkBooleanShow or hide the "Terms" link. Clicking the "Terms" link opens Gigya's Legal Notices page.
No
showTooltipsBooleanThis parameter's default value is 'true'. When set to 'true', a tooltip will be displayed when you mouse-hover over a social network icon. The tooltip presents the social network's full name.
No
showWhatsThisBooleanWhen this parameter is set to "true", rolling over the "Social by Gigya" link at the bottom of the plugin causes a hint to pop up with a description of the Add Connection plugin. By default the value of this parameter is "false". In order for the "What's this" tooltip to appear, the width of the plugin must be at least 150px and the height must be at least 100px. Use the whatsThisText parameter if you want to change the default hint text.
No
UIConfigstring (XML)

An XML string describing changes to the default design of the plugin.
For example:

Code Block
UIConfig:"<config><body>
<texts color=\"#00006D\"></texts>
<background background-color=\"#CACACA\" frame-color=\"#2424FF\"></background>
</body></config>";

For more information 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.

No
whatsThisTextstringThis parameter is relevant only if the showWhatsThis parameter is set to "true". Use this parameter to define the text that appears in the pop-up (see screenshot above). The default text is "Add more connections to your account.".
 Events Registration Parameters 
No
onLoadfunction refA reference to an event handler function that will be called when the plugin has finished drawing itself.
No
onErrorfunction refA reference to an event handler function that will be called when an error occurs.
No
onClosefunction refA reference to an event handler function that will be called in one of the following scenarios:
  • If the plugin is displayed as a popup the event will be fired when the plugin is closing.
  • If the plugin is embedded in page the event will be fired when the user clicks a button that indicates the dialog should be closed. In this case the dialog will not hide itself automatically.
No
onConnectionAddedfunction refA reference to a function that is called when the user is successfully connected to a provider.
No
onButtonClickedfunction refA reference to an event handler function that will be called when one of the plugin's buttons is clicked.
Deprec
useHTMLBooleanDeprecated. The Add Connections plugin is available in both Flash and HTML versions. By default, the HTML version is used. You may override the default behavior. Setting this parameter with the value 'false', will force Gigya to use the Flash version.

...

FieldTypeDescription
eventNamestringThe name of the event: 'connectionAdded'.
sourcestringThe source plugin that generated this event. The value of this field is the name of the plugin's API method, in this case 'showAddConnectionUI'.
Note: This field will not be available if the source of this event is not a plugin (e.g., if the source is a socialize.addConnection API call)
contextobjectThe context object passed as a parameter to the plugin/method that triggered this event, or null if no object was passed.
userUser objectUser object with updated information for the current user.
providerstringThe name of the social network to which the user connected.

...

By using this plugin, the following global event may be triggered: onConnectionAddedand - indirectly, if the 'Edit' link is displayed and the user opens the Edit Connections plugin, onConnectionRemoved might also be triggered.

...

Include Page
Table Fixer JS Script - Template
Table Fixer JS Script - Template