Using The Web SDK

Skip to end of metadata
Go to start of metadata

 

This chapter provides the basic knowledge needed to start developing using Gigya's JavaScript Web SDK. We highly recommend reading this document before starting to code.

What's in this Guide?

  • Basic Concepts - The guide starts out with some fundamental concepts that are required for developing applications with Gigya's JavaScript Web SDK.
  • Basic Tutorial - Continue with a basic example of a web page that uses the Gigya service - a basic Facebook app, and a guide for using Gigya Web SDK methods.
  • Events - Learn how to handle Events generated by Gigya socialize.
  • Advanced Customizations - Advanced customization options that you may apply on your client application.
  • Supported Browsers - Information about Gigya's browser support.

 

Note: In addition to the JavaScript Web SDK, Gigya has several mobile SDKs for platforms such as iPhone, Android, and Cordova.

  

Basic Concepts

An Asynchronous Programming Model

Gigya uses an asynchronous programming model in which operations are triggered and then run in the background until they are completed. Upon successful or unsuccessful completion, the operation invokes a callback function, which is provided by the developer, and returns a response object that includes the results of the operation. The callback function should handle the response in an appropriate manner, as determined by the application. 

The SDK Namespaces

The entire range of Gigya functionality is provided as methods of one of the following namespaces: gigya.socialize, gigya.accounts, gigya.comments, gigya.gm, gigya.ds, and gigya.gcs, thus all methods are referenced with the gigya. prefix. 

Making Calls

All the methods in the Gigya Web SDK have a common signature:

gigya.<namespace>.<method_name>(params);
// e.g., gigya.socialize.showShareBarUI(params)

The "params" object is actually an object that may contain multiple members. We choose to use this object instead of passing parameters in the "classical" way - this provides flexibility in adding new parameters without "breaking" older code.