Gigya Job Openings

socialize.getContacts JS

Skip to end of metadata
Go to start of metadata

Description

Returns the list of email contacts of the current user from all the providers that support retrieving contacts. Contact information includes first name, last name and email.

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 > socialize.getContacts.

Supporting Providers

The following providers currently support this operation: Yahoo.

 

Note:

  • Before your application can retrieve email contacts from providers, the user must grant your application access. During the social sign-on process, the user is presented with a dialog in which they authorize your application to retrieve contacts from their profile. For more information see the Enable retrieving user contacts guide. 
  • Please make sure you have checked the "Enable retrieving user contacts" check box in the Site settings page on Gigya's website (click the 'Advanced' button to open the collapsible configuration section).

Syntax

 

Parameters

The following table lists the available parameters:

RequiredNameTypeDescription
callbackfunction
A 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).
The "Response Object Data Members" table below provides specification of the data that is passed to the callback function.
enabledProvidersstring'yahoo'.

Note: This parameter overrides the value of the identical parameter in Global Conf (the global configuration object). If the parameter is not set for the method, the value from Global Conf is used.

disabledProvidersstring'yahoo'.

Note: This parameter overrides the value of the identical parameter in Global Conf (the global configuration object). If the parameter is not set for the method, the value from Global Conf is used.

cidstring
A string of maximum 100 characters length. The CID sets categories for transactions that can be used later for filtering reports generated by Gigya in the "Context ID" combo box. The CID allows you to associate the report information with your own internal data. For example, to identify a specific widget or page on your site/application. You should not define more than 100 different context IDs.

Note: This parameter overrides the value of the identical parameter in Global Conf (the global configuration object). If the parameter is not set for the method, the value from Global Conf is used.

contextobject
A developer-created object that is passed back unchanged to the application as one of the fields in the response object.

 

Response Object Data Members

FieldTypeDescription
errorCode integer The result code of the operation. Code '0' indicates success, any other number indicates failure. For a complete list of error codes, see the Response Codes and Errors table.
errorMessage string A short textual description of an error associated with the errorCode for logging purposes.
callId string Unique identifier of the transaction, for debugging purposes.
context object The context object passed by the application as a parameter to the API method, or null if no context object has been passed.
contactsCollectionA collection of Contact objects, corresponding to the list of contacts of the current user from all the email providers to which the user is connected.

Code Sample

function printResponse(response) {  
    if ( response.errorCode == 0 ) {             
        var myContacts = response['contacts'].asArray();          
        if ( null!=myContacts && myContacts.length>0) {        
            var msg = 'My contacts are:\n\n';        
            for (var index in myContacts) {
                var currContact = myContacts[index];
                msg += currContact['firstName']+' - ' + currContact ['email']+ '\n' ;                 
            }            
            alert(msg);
        }
        else {
            alert('No contacts were returned');
        }
    }
    else {
        alert('Error :' + response.errorMessage);
    }
}

var params = {
    callback:printResponse
};

gigya.socialize.getContacts(params); 

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.

 

In the Get Email Contacts page you will find a complete working example that uses socialize.getContacts method. You may view the code, run it and view the outcome.