Gigya Job Openings

accounts.getScreenSets JS

Skip to end of metadata
Go to start of metadata

Description

This method retrieves one or more screen-sets hosted by Gigya.

Note: If you plan on integrating Gigya's Accounts API, we highly recommend reading the Registration-as-a-Service Guide. Registration-as-a-Service (RaaS) is a premium platform that requires separate activation. If RaaS is not part of your site package, please contact Gigya by filling in a support form through the Console. You can access the support page by clicking Support on the upper menu after logging into the Gigya Console.


 

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 > accounts.getScreenSets

 

Syntax

 

 

Parameters

The following table lists the available parameters:

RequiredNameTypeDescription
screenSetIDsarray or stringEither a comma separated list or an array of identifiers of the screen-sets to be retrieved. When not specified returns all the screen-sets associated with the site (apiKey). To return screen-sets outside of the local site, e.g., when in an SSO Group, you must specify the screenSetIDs of the screen-set to return.
includestring
A comma separated list of top level fields to include in the response. The default is all: "screenSetID, html, css, javascript, translations".
langstringIf translations exist for the screen-set(s), you can specify which language to return. If not provided, lang defaults to NULL and the default localization is used. See Advanced Customizations and Localization for supported values.
callbackfunctionA 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).

 

Code Sample

<script type="text/javascript">
    function showScreenSetInfo(response) {
        alert(JSON.stringify(response));
    }

    function getScreenSetInfo() {
        var screenSetParams = {
            include: 'screenSetID',
            callback: showScreenSetInfo
        };
        gigya.accounts.getScreenSets(screenSetParams);
    }
</script>

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