socialize.getPhotos

Last modified 12:25, 13 Apr 2015

Description

Returns all visible photos uploaded by the current user according to the specified filters. The data is delivered as a Collection of Photo objects.

You can use this method to find all photos that are:

  • In one of the albums, specified in albumIDs parameter.
  • Tagged with one or more people, specified in tags parameter.
  • Combination of these two criteria (if both parameters are provided, the method returns photos that meet both conditions).

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

 

Supporting Providers

The following providers currently support this operation: FacebookInstagramVkontakte, mixi.

Note: Before your application can get photos and albums from Facebook, the user must grant your application an extended permission. Make sure you have checked the "Enable retrieving photos" check box in the Site Setup > Permissions page in the Gigya website. During the social login process, the user will be presented with a dialog in which they can authorize your application to retrieve photos from their Facebook profile. Read more in the Facebook Permissions guide.

 

Syntax

gigya.socialize.getPhotos(params)

 

Method Parameters

The following table lists the params object members:

Required Name Type Description
Required* albumIDs string A comma-separated list of albums from which to retrieve the photos. The method returns all photos that belong to all the specified albums. You can retrieve the user's album IDs using the socialize.getAlbums method.
  tags string A comma-separated list of friends' UIDs. The method returns all the photos that are tagged with the specified friends. You can use the string 'self' for retrieving photos that are tagged with the current user. For example:
tags: "self, _gid_9LRc48vNolfN34fybPpsv6Gdr, _gid_aaaaaalfN34fybPpsv6Gdr";

The above example returns all the photos in which either the current user or one of the two friends is tagged.

Tagged photos are currently only supported by Facebook. If the tags parameter is provided, this method returns photos only from Facebook. If the tags parameter is provided and Facebook is not connected or not an enabled network, the method returns a "Not supported" error (Error code: 400096).

 
* Notes:
  • You must provide either albumIDs or tags. If neither parameter is provided, the method will return a "Missing required parameter" error (Error code: 400002).
  • Supplying both the albumIDs and tags parameters will return photos matching both criteria (i.e., photos belonging to a given album and tagged with the given tag(s)).
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 Facebook and Twitter, define: enabledProviders: "facebook, twitter".
Valid provider names include: 'facebook', 'instagram', 'vkontakte', 'mixi'.
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.
  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', 'instagram', 'vkontakte', 'mixi'.
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.
  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: 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.
  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.
photos Collection A collection of Photo objects. Note that thumbnailWidth and thumbnailHeight are not returned for the Photo objects if the method was called using the tags parameter .

 

Code Sample

function printResponse(response) {  
    if (response.errorCode == 0) {             
        var myPhotos = response['photos'].asArray();          
        if (null!=myPhotos && myPhotos.length>0) {        
            var msg = 'My Photos: \n';        
	    for (var index in myPhotos) {
                msg += myPhotos[index].title + ': ' + myPhotos[index].photoURL + ' ;  ' + myPhotos[index].created + '\n';
            }
            alert(msg);
        }
        else {
            alert('No Photos were returned');
        }
    }
    else {
        alert('Error :' + response.errorMessage);
    }
}

var albumID = "5437";  // You can retrieve album IDs using the socialize.getAlbums methods.

var params = {
    albumIDs:albumID,
    callback:printResponse
};

gigya.socialize.getPhotos(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 socialize.getPhotos method. You may view the code, run it and view the outcome.

Page statistics
684 view(s) and 3 edit(s)
Social share
Share this page?

Tags

This page has no custom tags.
This page has no classifications.

Comments

You must to post a comment.

Attachments