Gigya Job Openings

accounts.hideScreenSet JS

Skip to end of metadata
Go to start of metadata

Description

This method hides the specified screen-set. If the containerID parameter is specified, Gigya clears the container in which the screen-set is displayed otherwise Gigya closes the dialog

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.

 

Syntax

 

 

Parameters

The following table lists the available parameters:

RequiredNameTypeDescription
screenSetstringA reference to the screen-set to be removed. The value of this parameter is the ID of a screen-set. Read more under gigya-screen-set. The screen-set is either defined on the same page from which this method is called, or it is stored on Gigya servers.
containerID stringAn ID of a <div> element on the page in which the screens are displayed. The containerID parameter is Required if it was specified with the accounts.showScreenSet method call (i.e., if your screen-set is actually displayed embedded within a <div> on the page). Gigya will clear this <div> element when specified.

 

Code Sample

<div id="userScreensDiv"><!-- the screens are displayed here --></div> 
...
<script>
// hide the screen-set
var params={
    containerID:"userScreensDiv"
}
gigya.accounts.hideScreenSet(params);
</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.