Settings

When the Social Sign-in Widget is initialized, it reads some or all of its settings from the settings object. These settings always include the tokenUrl, which is the address of the web page responsible for retrieving user information. (See Authentication.)

If you created your widget with embedded settings (Pro or Enterprise service levels only), the complete widget configuration is placed in the generated code. You can modify these settings on a page-by-page basis, making it possible to customize the widget where needed. See Figure 1.

Figure 1: Embedded Settings

Settings can also be specified when the widget is designed and created (see Configure the Widget), or they can be modified after the widget is live (see documentation for the Widget, Signin, and Modal objects).

Usage
janrain.settings
Available to:      

Available to:  

extParams ¶

This is a provider specific feature, so you must be careful when implementing it. Use only those parameters that you know a provider supports. If you send a parameter to the wrong provider, you may get unintended results. The syntax looks like this:

janrain.settings.extParams = {
	disqus: '{"foo":"bar", "foo2":"baz"}',
	facebook: '{"facebook":"boo"}'
}

Example ¶

The following example sets essential values, and overrides select formatting settings.

janrain.settings = {};
janrain.settings.tokenUrl = 'https://example.com/landing';
janrain.settings.type = 'embed';
janrain.settings.appId = '12345678912345678912';
janrain.settings.appUrl = 'https://example.rpxnow.com';
janrain.settings.providers = [
    'facebook',
    'google',
    'blogger',
    'aol',
    'yahoo',
    'openid'];
janrain.settings.actionText = 'Choose a provider!';
janrain.settings.showAttribution = false;
janrain.settings.fontColor = '#a020f0';
janrain.settings.fontFamily = 'impact, playbill, fantasy';

Custom Window Size ¶

Available to:

These settings allow you to customize the window size for custom OpenID Providers. You can use these settings to specify the window size that opens, or if you don’t, the window will use the default size. Specify the size in pixels.

Usage: janrain.settings

Facebook AutoLogin ¶

Available to: 
Facebook offers automatic login capabilities with other websites. In order for this to work, the user must have previously logged into the website using Facebook, and approved the app and current set of permissions being requested. Then the user will be automatically logged in when visiting a website that has the auto login configured.

Janrain supports this feature, but currently, it is only available to sites using a Janrain custom CNAME with their Engage application. If your application URL uses rpxnow.com as part of its address, this will not work.

Usage: janrain.settings

Custom Scopes ¶

Available to: 
The Custom Scope setting allows websites sharing the same Social Sign-in solution to request different information from the user.

For detailed instructions for this feature, please refer to the Custom Scoping Guide.

The value for the scopes setting is a list added in array. Example:

janrain.settings.scopes = {"googleplus": ["https://www.googleapis.com/auth/plus.circles.read"]};

Usage: janrain.settings