Table of contents
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: Google, Yahoo.
Note: Before your application can retrieve contacts from the email providers, the user must grant your application with access. 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). During the social sign-on process, the user is presented with a dialog in which she may authorize your application to retrieve contacts from her profile. You may find more information in the Enable retrieving user contacts guide.
Syntax
gigya.socialize.getContacts(params)
Method Parameters
The following table lists the params object members:
| Required | Name | Type | Description |
| Optional | callback | function | 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. |
| enabledProviders | string | A comma-delimited list of provider names to include in the method execution. This parameter gives the possibility to apply this method only to a subset of providers of your choice. If you do not set this parameter, by default all the providers are enabled (i.e. the method applies to all connected providers). For example, if you would like the method to apply only to Yahoo, define: enabledProviders="yahoo". Valid provider names include: 'google', 'yahoo'. Note: the value of this parameter overrides the value of the identical parameter in the global configuration object. | |
| disabledProviders | string | A comma-delimited list of provider names to exclude in the method execution. This parameter gives the possibility to specify providers to which that you don't want this method to apply. If you do not set this parameter, by default no provider is disabled (i.e. the method applies to all connected providers). For example, if you would like the method to apply to all providers except Google, define: disabledProviders="google". Valid provider names include: 'google', 'yahoo'. Note: the value of this parameter overrides the value of the identical parameter in the global configuration object. | |
| cid | string | A string of maximum 100 characters length. This string is associated with each transaction and will later appear on 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. The "Context ID" combo box lets you filter the report data by site/application context. Note: the value of this parameter overrides the value of the identical parameter in the global configuration object. | |
| context | object | 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
| Field | Type | Description |
| 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 Error Codes table. |
| errorMessage | string | A short textual description of an error associated with the errorCode for logging purposes. |
| operation | string | The name of the API method that generated this response. |
| context | object | The context object passed by the application as parameter to the API method, or null if no context object has been passed. |
| contacts | Collection | A 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);
- 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 socialize.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.
Comments