Was this article helpful?

socialize.getAlbums

Last modified 13:51, 5 Aug 2013

Description

Returns metadata about all of the photo albums uploaded by the current user. The data is delivered as a Collection of Album objects. This method supports filtering of the privacy level and type of the albums to retrieve. The method will return the user's albums from all the connected providers that support the album feature.

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.getAlbums.

Supporting Providers

The following providers currently support this operation: Facebook, Myspace, Orkut, InstagramVkontakte, mixi.

Note: Before your application can get photos and albums from Facebook, the user must grant your application an extended permission. Please make sure you have checked the "Enable retrieving photos" check box in the Site Setup > Permissions page on Gigya's website. During the social sign-on process, the user will be presented with a dialog in which the user can authorize your application to retrieve photos from her Facebook profile.
You can read more in the Facebook Setting - Permissions guide.

 

Syntax

gigya.socialize.getAlbums(params)

 

Method Parameters

The following table lists the params object members:

Required Name Type Description
Optional type string With this parameter you may filter the type of the albums to retrieve. The optional values for this parameter are: 'normal', 'profile', 'mobile', 'wall' and 'all'. The default value is 'all'.
Note: For MySpace album types are not defined. This method will return MySpace albums only if the type parameter is 'normal' or not provided.
  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 Facebook and Twitter, define: enabledProviders: "facebook, twitter".
Valid provider names include: 'facebook', 'myspace', 'orkut', 'instagram', 'vkontakte', 'mixi'.
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+ and Twitter, define: disabledProviders: "googleplus, twitter".
Valid provider names include: 'facebook', 'myspace', 'orkut', 'instagram', 'vkontakte', 'mixi'.
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. 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: 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.
albums Collection A collection of Album objects corresponding to the list of albums of the current user on all the social networks to which the user is connected.

 

Code Sample

function printResponse(response) {  
    if (  response.errorCode == 0 ) {             
        var myAlbums = response['albums'].asArray();          
        if ( null!=myAlbums && myAlbums.length>0) {        
            var msg = 'My Albums: \n';        
            for (var index in myAlbums) {
                var currAlbum = myAlbums[index];
                msg += "In " + currAlbum['name'] + ' there are '+currAlbum['count']+' photos.\n' ;                 
            }            
            alert(msg);
        }
        else {
            alert('No albums were returned');
        }
    }
    else {
        alert('Error :' + response.errorMessage);
    }
}

var params = {
    callback:printResponse
};

gigya.socialize.getAlbums(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 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 Albums and Photos page you will find a complete working example that uses the socialize.getAlbums method. You may view the code, run it and view the outcome.

Was this article helpful?
Pages that link here
Page statistics
2079 view(s) and 4 edit(s)
Social share
Share this page?

Tags

This page has no custom tags set.

Comments

You must to post a comment.

Attachments