Photo Gallery Service

This module enables you to create your own photo gallery on the cloud where you can create, retrieve, remove and manage your photo albums. This service is very useful for developers who want to integrate Photo Gallery functionality in their Mobile/Device and Web Apps. Gallery API gives a complete Photo Gallery service and reduces the footprint on the device so that you can focus on other Gallery aspects such as how to render the Photo Gallery thereby reducing development time. Functions available in Gallery API are listed below:

Import Statement

view plain print ?

using com.shephertz.app42.paas.sdk.csharp;
using com.shephertz.app42.paas.sdk.csharp.gallery;

Initialize

Download Android SDK, if you have not downloaded yet.

In order to use the various functions available in a specific API, the developer has to initialize with App42API by passing the apiKey and the secretKey which will become available after the app creation from AppHQ dashboard.

Required Parameters

apiKey - The Application key given when the application was created.secretKey - The secret key corresponding to the application key given when the application was created.

view plain print ?

App42API.Initialize(“API_KEY”,“SECRET_KEY”);

Build Service

After initialization, the developer will have to call the buildXXXService method on App42API to get the instance of the particular API that they wish to build. For example, to build an instance of Album Service, buildAlbumService() method needs to be called.

view plain print ?

AlbumService albumService = App42API.BuildAlbumService();

PhotoService photoService = App42API.BuildPhotoService();

Create Albums

Create Album on the cloud.

Required Parameters

userName - The user to whom the album belongs.albumName - Name of the album to be created on the cloud.description - Description of the album to be created.

view plain print ?

String userName = “Nick”;
String albumName = “My Album”;
String description = “Album Description”;
App42Log.SetDebug(true); //Prints output in your editor console
App42API.Initialize(“API_KEY”,“SECRET_KEY”);
AlbumService albumService = App42API.BuildAlbumService();
albumService.CreateAlbum(userName, albumName, description, new UnityCallBack());
public class UnityCallBack : App42CallBack
{
public void OnSuccess(object response)
{
Album album = (Album) response;
App42Log.Console(“userName is :” + album.GetUserName());
App42Log.Console(“albumName is :” + album.GetName());
App42Log.Console(“Description is :” + album.GetDescription());
App42Log.Console(“jsonResponse is :” + album.ToString());
}
public void OnException(Exception e)
{
App42Log.Console(“Exception : “ + e);
}
}

Get Albums

Fetch all the albums based on the username.

Required Parameters

userName - Name of the user whose albums have to be fetched.

view plain print ?

String userName = “Nick”;
App42Log.SetDebug(true); //Prints output in your editor console
App42API.Initialize(“API_KEY”,“SECRET_KEY”);
AlbumService albumService = App42API.BuildAlbumService();
albumService.GetAlbums(userName, new UnityCallBack());
public class UnityCallBack : App42CallBack
{
public void OnSuccess(object response)
{
IList<Album> album = (IList<Album>) response;
for(int i = 0; i < album.Count; i++)
{
App42Log.Console(“userName is :” + album[i].GetUserName());
App42Log.Console(“albumName is :” + album[i].GetName());
App42Log.Console(“Description is :” + album[i].GetDescription());
App42Log.Console(“jsonResponse is :” + album[i].ToString());
}
}
public void OnException(Exception e)
{
App42Log.Console(“Exception : “ + e);
}
}

Get Albums Count

Fetch the count of all the Albums based on the username.

userName - The user for which the count of albums have to be fetched.

view plain print ?

String userName = “Nick”;
App42Log.SetDebug(true); //Prints output in your editor console
App42API.Initialize(“API_KEY”,“SECRET_KEY”);
AlbumService albumService = App42API.BuildAlbumService();
albumService.GetAlbumsCount(userName, new UnityCallBack());
public class UnityCallBack : App42CallBack
{
public void OnSuccess(object response)
{
App42Response app42Response = (App42Response) response;
App42Log.Console(“app42Response is :” + app42Response.ToString());
}
public void OnException(Exception e)
{
App42Log.Console(“Exception : “ + e);
}
}

Get Albums Paging

Fetch all the albums based on the username by paging.

Required Parameters

userName - Name of the user whose albums have to be fetched.max - Maximum number of records to be fetched.offset - From where the records are to be fetched.

view plain print ?

String userName = “Nick”;
int max = 1;
int offset = 0 ;
App42Log.SetDebug(true); //Prints output in your editor console
App42API.Initialize(“API_KEY”,“SECRET_KEY”);
AlbumService albumService = App42API.BuildAlbumService();
albumService.GetAlbums(userName,max,offset, new UnityCallBack());
public class UnityCallBack : App42CallBack
{
public void OnSuccess(object response)
{
IList<Album> album = (IList<Album>) response;
for(int i = 0; i < album.Count; i++)
{
App42Log.Console(“userName is :” + album[i].GetUserName());
App42Log.Console(“albumName is :” + album[i].GetName());
App42Log.Console(“Description is :” + album[i].GetDescription());
App42Log.Console(“jsonResponse is :” + album[i].ToString());
}
}
public void OnException(Exception e)
{
App42Log.Console(“Exception : “ + e);
}
}

Get Album By Name

Fetch album details based on the username.

Required Parameters

userName - Name of the user whose albums have to be fetched.albumName - Name of the album that has to be fetched.

view plain print ?

String userName = “Nick”;
String albumName = “My Album”;
App42Log.SetDebug(true); //Prints output in your editor console
App42API.Initialize(“API_KEY”,“SECRET_KEY”);
AlbumService albumService = App42API.BuildAlbumService();
albumService.GetAlbumByName(userName,albumName, new UnityCallBack());
public class UnityCallBack : App42CallBack
{
public void OnSuccess(object response)
{
Album album = (Album) response;
App42Log.Console(“userName is :” + album.GetUserName());
App42Log.Console(“albumName is :” + album.GetName());
App42Log.Console(“Description is :” + album.GetDescription());
App42Log.Console(“jsonResponse is :” + album.ToString());
}
public void OnException(Exception e)
{
App42Log.Console(“Exception : “ + e);
}
}

Add Photo

Add photo for a particular user and album. The photo is uploaded on the cloud.

Required Parameters

userName - Name of the user whose photo has to be added.albumName - Name of the album in which photo has to be added.photoName - Name of the photo that has to be added.description - Description of the photo that has to be added.filePath - The local path for the file.

view plain print ?

String userName = “Nick”;
String albumName = “My Album”;
String photoName = “My Photo”;
String description = “Photo Details”;
String filePath = “Your Local file path”;
App42Log.SetDebug(true); //Prints output in your editor console
App42API.Initialize(“API_KEY”,“SECRET_KEY”);
PhotoService photoService = App42API.BuildPhotoService();
photoService.AddPhoto(userName, albumName, photoName, description, filePath, new UnityCallBack());
public class UnityCallBack : App42CallBack
{
public void OnSuccess(object response)
{
Album album = (Album) response;
App42Log.Console(“userName is :” + album.GetUserName());
App42Log.Console(“albumName is :” + album.GetName());
App42Log.Console(“Description is :” + album.GetDescription());
App42Log.Console(“jsonResponse is :” + album.ToString());
IList<Album.Photo> photoList = album.GetPhotoList();;
for(int i = 0; i < photoList.Count; i++)
{
App42Log.Console(“PhotoName is :” + photoList[i].GetName());
App42Log.Console(“Url is :” + photoList[i].GetUrl());
App42Log.Console(“TinyUrl is :” + photoList[i].GetTinyUrl());
App42Log.Console(“ThumbNailUrl is :” + photoList[i].GetThumbNailUrl());
App42Log.Console(“ThumbNailTinyUrl is :” + photoList[i].GetThumbNailTinyUrl());
App42Log.Console(“jsonResponse is :” + photoList[i].ToString());
}
}
public void OnException(Exception e)
{
App42Log.Console(“Exception : “ + e);
}
}

Add Tag To Photo

Add tags to the photos for the user in the album.

Required Parameters

userName - Name of the user whose photo has to be tagged.albumName - Name of the album whose photo is to be tagged.photoName - Name of the photo to be tagged.tagList - List of tags in Photo.

view plain print ?

String userName = “Nick”;
String albumName = “My Album”;
String photoName = “My Photo”;
IList<String> tagList = new List<String>();
tagList.Add(“John”);
App42Log.SetDebug(true); //Prints output in your editor console
App42API.Initialize(“API_KEY”,“SECRET_KEY”);
PhotoService photoService = App42API.BuildPhotoService();
photoService.AddTagToPhoto(userName,albumName,photoName,taglist, new UnityCallBack());
public class UnityCallBack : App42CallBack
{
public void OnSuccess(object response)
{
Album album = (Album) response;
App42Log.Console(“userName is :” + album.GetUserName());
App42Log.Console(“albumName is :” + album.GetName());
App42Log.Console(“Description is :” + album.GetDescription());
App42Log.Console(“jsonResponse is :” + album.ToString());
IList<Album.Photo> photoList = album.GetPhotoList();;
for(int i = 0; i < photoList.Count; i++)
{
App42Log.Console(“PhotoName is :” + photoList[i].GetName());
App42Log.Console(“Url is :” + photoList[i].GetUrl());
App42Log.Console(“TinyUrl is :” + photoList[i].GetTinyUrl());
App42Log.Console(“ThumbNailUrl is :” + photoList[i].GetThumbNailUrl());
App42Log.Console(“ThumbNailTinyUrl is :” + photoList[i].GetThumbNailTinyUrl());
App42Log.Console(“jsonResponse is :” + photoList[i].ToString());
}
}
public void OnException(Exception e)
{
App42Log.Console(“Exception : “ + e);
}
}

Get Photos

Fetch all the photos based on the username.

Required Parameters

userName - Name of the user whose photos have to be fetched.

view plain print ?

String userName = “Nick”;
App42Log.SetDebug(true); //Prints output in your editor console
App42API.Initialize(“API_KEY”,“SECRET_KEY”);
PhotoService photoService = App42API.BuildPhotoService();
photoService.GetPhotos(userName, new UnityCallBack());
public class UnityCallBack : App42CallBack
{
public void OnSuccess(object response)
{
Album album = (Album) response;
App42Log.Console(“userName is :” + album.GetUserName());
App42Log.Console(“albumName is :” + album.GetName());
App42Log.Console(“Description is :” + album.GetDescription());
App42Log.Console(“jsonResponse is :” + album.ToString());
IList<Album.Photo> photoList = album.GetPhotoList();;
for(int i = 0; i < photoList.Count; i++)
{
App42Log.Console(“PhotoName is :” + photoList[i].GetName());
App42Log.Console(“Url is :” + photoList[i].GetUrl());
App42Log.Console(“TinyUrl is :” + photoList[i].GetTinyUrl());
App42Log.Console(“ThumbNailUrl is :” + photoList[i].GetThumbNailUrl());
App42Log.Console(“ThumbNailTinyUrl is :” + photoList[i].GetThumbNailTinyUrl());
App42Log.Console(“jsonResponse is :” + photoList[i].ToString());
}
}
public void OnException(Exception e)
{
App42Log.Console(“Exception : “ + e);
}
}

Get Tagged Photos

Fetche all the photos based on the username and tag.

Required Parameters

userName - Name of the user for which the albums have to be fetched.tag - Tag on which basis photos have to be fetched.

view plain print ?

String userName = “Nick”;
String tag = “John”;
App42Log.SetDebug(true); //Prints output in your editor console
App42API.Initialize(“API_KEY”,“SECRET_KEY”);
PhotoService photoService = App42API.BuildPhotoService();
photoService.GetTaggedPhotos(userName, tag, new UnityCallBack());
public class UnityCallBack : App42CallBack
{
public void OnSuccess(object response)
{
IList<Album> album = (IList<Album>) response;
for(int i=0; i < album.Count; i++)
{
App42Log.Console(“userName is :” + album[i].GetUserName());
App42Log.Console(“albumName is :” + album[i].GetName());
App42Log.Console(“Description is :” + album[i].GetDescription());
App42Log.Console(“jsonResponse is :” + album[i].ToString());
}
}
public void OnException(Exception e)
{
App42Log.Console(“Exception : “ + e);
}
}

Get Photos By Album Name

Fetche all photos based on the username and album name.

Required Parameters

userName - Name of the user whose photos have to be fetched.albumName - Name of the album from which photos have to be fetched.

view plain print ?

String userName = “Nick”;
String albumName = “My Album”;
App42Log.SetDebug(true); //Prints output in your editor console
App42API.Initialize(“API_KEY”,“SECRET_KEY”);
PhotoService photoService = App42API.BuildPhotoService();
photoService.GetPhotosByAlbumName(userName,albumName, new UnityCallBack());
public class UnityCallBack : App42CallBack
{
public void OnSuccess(object response)
{
Album album = (Album) response;
App42Log.Console(“userName is :” + album.GetUserName());
App42Log.Console(“albumName is :” + album.GetName());
App42Log.Console(“Description is :” + album.GetDescription());
App42Log.Console(“jsonResponse is :” + album.ToString());
IList<Album.Photo> photoList = album.GetPhotoList();
for(int i=0; i < photoList.Count; i++)
{
App42Log.Console(“Photo List jsonResponse is : “ + photoList[i].ToString());
App42Log.Console(“Name is : “ + photoList[i].GetName());
App42Log.Console(“ThumbNailUrl is : “ + photoList[i].GetThumbNailUrl());
App42Log.Console(“ThumbNailTinyUrl is : “ + photoList[i].GetThumbNailTinyUrl());
App42Log.Console(“Url is : “ + photoList[i].GetUrl());
App42Log.Console(“TinyUrl is : “ + photoList[i].GetTinyUrl());
}
}
public void OnException(Exception e)
{
App42Log.Console(“Exception : “ + e);
}
}

Get Photos By Album Name (Paging)

Fetches all photos based on the username and album name by paging.

Required Parameters

userName - Name of the user whose photos have to be fetched.albumName - Name of the album from which photos have to be fetched.max - Maximum number of records to be fetched.offset - From where the records are to be fetched.

view plain print ?

String userName = “Nick”;
String albumName = “My Album”;
int max = 1;
int offset = 0;
App42Log.SetDebug(true); //Prints output in your editor console
App42API.Initialize(“API_KEY”,“SECRET_KEY”);
PhotoService photoService = App42API.BuildPhotoService();
photoService.GetPhotosByAlbumName(userName,albumName,max,offset, new UnityCallBack());
public class UnityCallBack : App42CallBack
{
public void OnSuccess(object response)
{
Album album = (Album) response;
App42Log.Console(“userName is :” + album.GetUserName());
App42Log.Console(“albumName is :” + album.GetName());
App42Log.Console(“Description is :” + album.GetDescription());
App42Log.Console(“jsonResponse is :” + album.ToString());
IList<Album.Photo> photoList = album.GetPhotoList();
for(int i=0; i < photoList.Count; i++)
{
App42Log.Console(“Photo List jsonResponse is : “ + photoList[i].ToString());
App42Log.Console(“Name is : “ + photoList[i].GetName());
App42Log.Console(“ThumbNailUrl is : “ + photoList[i].GetThumbNailUrl());
App42Log.Console(“ThumbNailTinyUrl is : “ + photoList[i].GetThumbNailTinyUrl());
App42Log.Console(“Url is : “ + photoList[i].GetUrl());
App42Log.Console(“TinyUrl is : “ + photoList[i].GetTinyUrl());
}
}
public void OnException(Exception e)
{
App42Log.Console(“Exception : “ + e);
}
}

Get Photos Count By Album Name

Fetche the count of all Photos based on the username and album name.

Required Parameters

userName - Name of the user whose count of photos have to be fetched.albumName - Name of the album from which count of photos have to be fetched.

view plain print ?

String userName = “Nick”;
String albumName = “My Album”;
App42Log.SetDebug(true); //Prints output in your editor console
App42API.Initialize(“API_KEY”,“SECRET_KEY”);
PhotoService photoService = App42API.BuildPhotoService();
photoService.GetPhotosCountByAlbumName(userName,albumName, new UnityCallBack());
public class UnityCallBack : App42CallBack
{
public void OnSuccess(object response)
{
App42Response app42Response = (App42Response) response;
App42Log.Console(“app42Response is :” + app42Response.ToString());
}
public void OnException(Exception e)
{
App42Log.Console(“Exception : “ + e);
}
}

Get Photos By Album Name And Photo Name

Fetch the photo details based on the username, album name and photo name.

Required Parameters

userName - Name of the user whose photo has to be added.albumName - Name of the album in which photo has to be added.photoName - Name of the photo that has to be added.

view plain print ?

String userName = “Nick”;
String albumName = “My Album”;
String photoName = “My Photo”;
App42Log.SetDebug(true); //Prints output in your editor console
App42API.Initialize(“API_KEY”,“SECRET_KEY”);
PhotoService photoService = App42API.BuildPhotoService();
photoService.GetPhotosByAlbumAndPhotoName(userName, albumName, photoName, new UnityCallBack());
public class UnityCallBack : App42CallBack
{
public void OnSuccess(object response)
{
Album album = (Album) response;
App42Log.Console(“userName is :” + album.GetUserName());
App42Log.Console(“albumName is :” + album.GetName());
App42Log.Console(“Description is :” + album.GetDescription());
App42Log.Console(“jsonResponse is :” + album.ToString());
IList<Album.Photo> photoList = album.GetPhotoList();
for(int i=0; i < photoList.Count; i++)
{
App42Log.Console(“Photo List jsonResponse is : “ + photoList[i].ToString());
App42Log.Console(“Name is : “ + photoList[i].GetName());
App42Log.Console(“ThumbNailUrl is : “ + photoList[i].GetThumbNailUrl());
App42Log.Console(“ThumbNailTinyUrl is : “ + photoList[i].GetThumbNailTinyUrl());
App42Log.Console(“Url is : “ + photoList[i].GetUrl());
App42Log.Console(“TinyUrl is : “ + photoList[i].GetTinyUrl());
}
}
public void OnException(Exception e)
{
App42Log.Console(“Exception : “ + e);
}
}

Remove Album

Remove the album based on the username and album name. Note : All photos in this album will also be removed.

Required Parameters

userName - User whose album has to be removed.albumName - Name of the album that has to be removed.

view plain print ?

String userName = “Nick”;
String albumName = “My Album”;
App42Log.SetDebug(true); //Prints output in your editor console
App42API.Initialize(“API_KEY”,“SECRET_KEY”);
PhotoService photoService = App42API.BuildPhotoService();
photoService.RemoveAlbum(userName,albumName, new UnityCallBack());
public class UnityCallBack : App42CallBack
{
public void OnSuccess(object response)
{
App42Response app42Response = (App42Response) response;
App42Log.Console(“app42Response is :” + app42Response.ToString());
}
public void OnException(Exception e)
{
App42Log.Console(“Exception : “ + e);
}
}

Remove Photo

Remove the particular photo from the specified album for a particular user. Note : The photo is removed from the cloud and won’t be accessible in future.

Required Parameters

userName - Name of the user whose photo has to be removed.albumName - Name of the album in which photo has to be removed.photoName - Name of the photo that has to be removed.

view plain print ?

String userName = “Nick”;
String albumName = “My Album”;
String photoName = “My Photo”;
App42Log.SetDebug(true); //Prints output in your editor console
App42API.Initialize(“API_KEY”,“SECRET_KEY”);
PhotoService photoService = App42API.BuildPhotoService();
photoService.RemovePhoto(userName,albumName,photoName, new UnityCallBack());
public class UnityCallBack : App42CallBack
{
public void OnSuccess(object response)
{
App42Response app42Response = (App42Response) response;
App42Log.Console(“app42Response is :” + app42Response.ToString());
}
public void OnException(Exception e)
{
App42Log.Console(“Exception : “ + e);
}
}

Update Photo

Update existing photo for a particular user and album. Note Only Photo and description will be changed(Photo Name will remain the same).

Required Parameters

userName - Name of the user whose photo has to be updated.albumName - Name of the album in which photo has to be updated.photoName - Name of the photo that has to be update.description - Description of the photo that has to be updated.filePath - Path from where photo has to be picked for addition.

view plain print ?

String userName = “Nick”;
String albumName = “My Album”;
String photoName = “My Photo”;
String description = “Photo Details”;
String filePath = “Your Local file path”;
App42Log.SetDebug(true); //Prints output in your editor console
App42API.Initialize(“API_KEY”,“SECRET_KEY”);
PhotoService photoService = App42API.BuildPhotoService();
photoService.UpdatePhoto(userName, albumName, photoName, description, filePath, new UnityCallBack());
public class UnityCallBack : App42CallBack
{
public void OnSuccess(object response)
{
Album album = (Album) response;
App42Log.Console(“userName is :” + album.GetUserName());
App42Log.Console(“albumName is :” + album.GetName());
App42Log.Console(“Description is :” + album.GetDescription());
App42Log.Console(“jsonResponse is :” + album.ToString());
IList<Album.Photo> photoList = album.GetPhotoList();;
for(int i = 0; i < photoList.Count; i++)
{
App42Log.Console(“PhotoName is :” + photoList[i].GetName());
App42Log.Console(“Url is :” + photoList[i].GetUrl());
App42Log.Console(“TinyUrl is :” + photoList[i].GetTinyUrl());
App42Log.Console(“ThumbNailUrl is :” + photoList[i].GetThumbNailUrl());
App42Log.Console(“ThumbNailTinyUrl is :” + photoList[i].GetThumbNailTinyUrl());
App42Log.Console(“jsonResponse is :” + photoList[i].ToString());
}
}
public void OnException(Exception e)
{
App42Log.Console(“Exception : “ + e);
}
}

Exception Handling

The functions available under Gallery API can throw some exceptions in abnormal conditions. For example, if a developer is creating an album for the user which is not in database, the function will throw the App42Exception (as shown below) with message as “Not Found” and the appErrorCode as “2500” and the details as “The request parameters are invalid. Album with the name ‘My Album’ for the user ‘Nick’ already exists”.

view plain print ?

String userName = “Nick”;
String albumName = “My Album”;
String albumDescription = “Album Description”;
App42Log.SetDebug(true); //Prints output in your editor console
App42API.Initialize(“API_KEY”,“SECRET_KEY”);
PhotoService photoService = App42API.BuildPhotoService();
photoService.CreateAlbum(userName,albumName,albumDescription, new UnityCallBack());
public class UnityCallBack : App42CallBack
{
public void OnException(Exception e)
{
App42Exception exception = (App42Exception)e;
int appErrorCode = exception.GetAppErrorCode();
int httpErrorCode = exception.GetHttpErrorCode();
if(appErrorCode == 2500)
{
// Handle here for Bad Request (The request parameters are invalid. Album with the name ‘@My Album’ for the user ‘@userName’ already exists.)
}
else if(appErrorCode == 1401){
// handle here for Client is not authorized
}
else if(appErrorCode == 1500){
// handle here for Internal Server Error
}
String jsonText = exception.GetMessage();
}
public void OnSuccess(object response)
{
App42Log.Console(“response is :” + response.ToString());
}
}

Error Codes

Functions in Gallery API might throw exceptions with following HTTP and Application Error Codes (along with their descriptions):

1400 - BAD REQUEST - The requested parameters are invalid.1401 - UNAUTHORIZED - Client is not authorized.1500 - INTERNAL SERVER ERROR - Internal Server Error. Please try again.2500 - BAD REQUEST - The request parameters are invalid. Album with the name '@albumName' for the user '@userName' already exists.2501 - NOT FOUND - Album by the name '@albumName' for the user '@userName' does not exist.2502 - NOT FOUND - Albums for the user '@userName' do not exist.2503 - NOT FOUND - Albums and Photos for the user '@userName' does not exist.2504 - NOT FOUND - Photo with the name '@photoName' from the Album '@albumName' for the user '@userName' does not exist.2505 - BAD REQUEST - The request parameters are invalid. Photo by the name '@photoName' for album '@albumName' for the user '@userName' already exists.2506 - NOT FOUND - The number of albums for the user '@userName' are less than the specified offset : + "offset".2507 - NOT FOUND - Album by the name '@albumName' for the user '@userName' have less photos than the specified offset : + "offset".2508 - NOT FOUND - Albums and Photos for the tag '@tag' does not exist.