Avatar Management Service

Complete Avatar management—create, delete, update, previous avatars, etc. Operations for managing user avatars i.e. images provided by users, Facebook, web URL or through InputStream.

Import Statement
  • create User Api for Android
  • create User Api for Windows
  • create User Api for iOS
  • create User Api for Swift
  • create User Api for Java
  • create User Api for Unity
  • create User Api for JS
  • create User Api for Corona
  • create User Api for Cocos2DX
  • create User Api for .Net
  • create User Api for PHP
  • create User Api for Marmalade
  •  create User Api for Ruby
  •  create User Api for Flash
  1. using com.shephertz.app42.paas.sdk.windows;    
  2. using com.shephertz.app42.paas.sdk.windows.avatar;     
Initialize

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.

  • create User Api for Android
  • create User Api for Windows
  • create User Api for iOS
  • create User Api for Swift
  • create User Api for Java
  • create User Api for Unity
  • create User Api for JS
  • create User Api for Corona
  • create User Api for Cocos2DX
  • create User Api for .Net
  • create User Api for PHP
  • create User Api for Marmalade
  •  create User Api for Ruby
  •  create User Api for Flash
  1. 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 AvatarService, buildAvatarService() method needs to be called.

  • create User Api for Android
  • create User Api for Windows
  • create User Api for iOS
  • create User Api for Swift
  • create User Api for Java
  • create User Api for Unity
  • create User Api for JS
  • create User Api for Corona
  • create User Api for Cocos2DX
  • create User Api for .Net
  • create User Api for PHP
  • create User Api for Marmalade
  •  create User Api for Ruby
  •  create User Api for Flash
  1. AvatarService avatarService = App42API.BuildAvatarService();    
Create Avatar

User can create their own avatar.

Required Parameters

avatarName - Name of avatar to be created. userName - Name of the user who is creating avatar. filePath - The local path for the file. description - Description of the avatar.

  • create User Api for Android
  • create User Api for Windows
  • create User Api for iOS
  • create User Api for Swift
  • create User Api for Java
  • create User Api for Unity
  • create User Api for JS
  • create User Api for Corona
  • create User Api for Cocos2DX
  • create User Api for .Net
  • create User Api for PHP
  • create User Api for Marmalade
  •  create User Api for Ruby
  •  create User Api for Flash
  1. String avatarName = "Shephertz Nick";  
  2. String userName = "Nick";  
  3. String filePath = "Your File Path";  
  4. String description = "My Profile Pic";          
  5. App42API.Initialize("API_KEY","SECRET_KEY");  
  6. AvatarService avatarService = App42API.BuildAvatarService();    
  7. avatarService.CreateAvatar(avatarName, userName,filePath, description,new Callback());  
  8. public class Callback : App42Callback    
  9. {    
  10.     public void OnSuccess(Object response)    
  11.     {    
  12.         Avatar avatar = (Avatar) response;     
  13.         Console.WriteLine("avatarName is :" + avatar.GetName());  
  14.         Console.WriteLine("url is :" + avatar.GetURL());  
  15.         Console.WriteLine("tinyUrl is :" + avatar.GetTinyURL());  
  16.         Console.WriteLine("createdOn is :" + avatar.GetCreatedOn());  
  17.         Console.WriteLine("Description is :"+avatar.GetDescription());  
  18.         Console.WriteLine("Is Current :"+avatar.IsCurrent());  
  19.         Console.WriteLine("UserName is :"+avatar.GetUserName());  
  20.     }    
  21.     public void OnException(App42Exception exception)    
  22.     {    
  23.         Console.WriteLine("Exception Message : " + exception);    
  24.     }    
  25. }    
Create Avatar With Input Stream

User can create their own avatar with input stream.

Required Parameters

avatarName - Name of avatar to be created. userName - Name of the user who is creating avatar. inputStream - InputStream of the file to be creating avatar. description - Description of the avatar. fileExtension - Extention of the image. e.g:- GIF, PNG, JPG.

  • create User Api for Android
  • create User Api for Windows
  • create User Api for iOS
  • create User Api for Swift
  • create User Api for Java
  • create User Api for Unity
  • create User Api for JS
  • create User Api for Corona
  • create User Api for Cocos2DX
  • create User Api for .Net
  • create User Api for PHP
  • create User Api for Marmalade
  •  create User Api for Ruby
  •  create User Api for Flash
Create Avatar From Facebook

User can import their avatar from Facebook based on giving access token.

Required Parameters

avatarName - Name of avatar to be created. userName - Name of the user who is creating an avatar. accessToken - Facebook Access Token that has been received after authorization. description - Description of the avatar.

  • create User Api for Android
  • create User Api for Windows
  • create User Api for iOS
  • create User Api for Swift
  • create User Api for Java
  • create User Api for Unity
  • create User Api for JS
  • create User Api for Corona
  • create User Api for Cocos2DX
  • create User Api for .Net
  • create User Api for PHP
  • create User Api for Marmalade
  •  create User Api for Ruby
  •  create User Api for Flash
  1. String avatarName = "Shephertz Nick";  
  2. String userName = "Nick";  
  3. String accessToken = "<Enter Your Facebook Access Token>";  
  4. String description = "My Profile Pic";        
  5. App42API.Initialize("API_KEY","SECRET_KEY");  
  6. AvatarService avatarService = App42API.BuildAvatarService();    
  7. avatarService.CreateAvatarFromFacebook(avatarName, userName,accessToken, description,new Callback());  
  8. public class Callback : App42Callback    
  9. {    
  10.     public void OnSuccess(Object response)    
  11.     {    
  12.         Avatar avatar = (Avatar) response;     
  13.         Console.WriteLine("avatarName is :" + avatar.GetName());  
  14.         Console.WriteLine("url is :" + avatar.GetURL());  
  15.         Console.WriteLine("tinyUrl is :" + avatar.GetTinyURL());  
  16.         Console.WriteLine("createdOn is :" + avatar.GetCreatedOn());  
  17.         Console.WriteLine("Description is :"+avatar.GetDescription());  
  18.         Console.WriteLine("Is Current :"+avatar.IsCurrent());  
  19.         Console.WriteLine("UserName is :"+avatar.GetUserName());          
  20.     }    
  21.     public void OnException(App42Exception exception)    
  22.     {    
  23.         Console.WriteLine("Exception Message : " + exception);    
  24.     }    
  25. }    
Create Avatar From Web URL

Create an avatar from any web media using a URL.

Required Parameters

avatarName - Name of avatar to be created. userName - Name of the user who is creating an avatar. webURL - Web URL of the photo which you want to create. description - Description of the avatar.

  • create User Api for Android
  • create User Api for Windows
  • create User Api for iOS
  • create User Api for Swift
  • create User Api for Java
  • create User Api for Unity
  • create User Api for JS
  • create User Api for Corona
  • create User Api for Cocos2DX
  • create User Api for .Net
  • create User Api for PHP
  • create User Api for Marmalade
  •  create User Api for Ruby
  •  create User Api for Flash
  1. String avatarName = "Shephertz Nick";  
  2. String userName = "Nick";  
  3. String webURL = "<Enter the WebURL>";  
  4. String description = "My Profile Pic";        
  5. App42API.Initialize("API_KEY","SECRET_KEY");  
  6. AvatarService avatarService = App42API.BuildAvatarService();    
  7. avatarService.CreateAvatarFromWebURL(avatarName, userName,webURL, description,new Callback());  
  8. public class Callback : App42Callback    
  9. {    
  10.     public void OnException(App42Exception exception)    
  11.     {    
  12.         Console.WriteLine("Exception Message : " + exception);    
  13.     }    
  14.     public void OnSuccess(Object response)    
  15.     {    
  16.         Avatar avatar = (Avatar) response;     
  17.         Console.WriteLine("avatarName is :" + avatar.GetName());  
  18.         Console.WriteLine("url is :" + avatar.GetURL());  
  19.         Console.WriteLine("tinyUrl is :" + avatar.GetTinyURL());  
  20.         Console.WriteLine("createdOn is :" + avatar.GetCreatedOn());  
  21.         Console.WriteLine("Description is :"+avatar.GetDescription());  
  22.         Console.WriteLine("Is Current :"+avatar.IsCurrent());  
  23.         Console.WriteLine("UserName is :"+avatar.GetUserName());  
  24.     }    
  25. }    
Get Avatar By Name

Get detail description of the avatar.

Required Parameters

avatarName - Name of the avatar which is to be fetched. userName - Name of the user whose avatar is to be fetched.

  • create User Api for Android
  • create User Api for Windows
  • create User Api for iOS
  • create User Api for Swift
  • create User Api for Java
  • create User Api for Unity
  • create User Api for JS
  • create User Api for Corona
  • create User Api for Cocos2DX
  • create User Api for .Net
  • create User Api for PHP
  • create User Api for Marmalade
  •  create User Api for Ruby
  •  create User Api for Flash
  1. String avatarName = "Shephertz Nick";  
  2. String userName = "Nick";  
  3. App42API.Initialize("API_KEY","SECRET_KEY");  
  4. AvatarService avatarService = App42API.BuildAvatarService();    
  5. avatarService.GetAvatarByName(avatarName, userName,new Callback());  
  6. public class Callback : App42Callback    
  7. {    
  8.     public void OnException(App42Exception exception)    
  9.     {    
  10.         Console.WriteLine("Exception Message : " + exception);    
  11.     }    
  12.     public void OnSuccess(Object response)    
  13.     {    
  14.         Avatar avatar = (Avatar) response;     
  15.         Console.WriteLine("avatarName is :" + avatar.GetName());  
  16.         Console.WriteLine("url is :" + avatar.GetURL());  
  17.         Console.WriteLine("tinyUrl is :" + avatar.GetTinyURL());  
  18.         Console.WriteLine("createdOn is :" + avatar.GetCreatedOn());  
  19.         Console.WriteLine("Description is :"+avatar.GetDescription());  
  20.         Console.WriteLine("Is Current :"+avatar.IsCurrent());  
  21.         Console.WriteLine("UserName is :"+avatar.GetUserName());  
  22.     }    
  23. }    
Get All Avatars

User can view all their avatars.

Required Parameters

userName - Name of the user who wants to get all his avatars.

  • create User Api for Android
  • create User Api for Windows
  • create User Api for iOS
  • create User Api for Swift
  • create User Api for Java
  • create User Api for Unity
  • create User Api for JS
  • create User Api for Corona
  • create User Api for Cocos2DX
  • create User Api for .Net
  • create User Api for PHP
  • create User Api for Marmalade
  •  create User Api for Ruby
  •  create User Api for Flash
  1. String userName = "Nick";  
  2. App42API.Initialize("API_KEY","SECRET_KEY");  
  3. AvatarService avatarService = App42API.BuildAvatarService();    
  4. avatarService.GetAllAvatars(userName,new Callback());  
  5. public class Callback : App42Callback    
  6. {     
  7.     public void OnSuccess(Object response)    
  8.     {   
  9.         IList<Avatar> avatar = (List<Avatar>) response;   
  10.         for (int i = 0; i < avatar.Count; i++)   
  11.         {  
  12.             Console.WriteLine("avatarName is :" + avatar[i].GetName());  
  13.             Console.WriteLine("url is :" + avatar[i].GetURL());  
  14.             Console.WriteLine("tinyUrl is :" + avatar[i].GetTinyURL());  
  15.             Console.WriteLine("createdOn is :" + avatar[i].GetCreatedOn());  
  16.             Console.WriteLine("Description is :"+avatar[i].getDescription());  
  17.             Console.WriteLine("Is Current :"+avatar[i].isCurrent());  
  18.             Console.WriteLine("UserName is :"+avatar[i].getUserName());  
  19.         }  
  20.     }    
  21.     public void OnException(App42Exception exception)    
  22.     {    
  23.         Console.WriteLine("Exception Message : " + exception);    
  24.     }   
  25. }    
Get Current Avatar

User can view the latest avatar uploaded by user.

Required Parameters

userName - Name of the user for which current avatar is to be fetched.

  • create User Api for Android
  • create User Api for Windows
  • create User Api for iOS
  • create User Api for Swift
  • create User Api for Java
  • create User Api for Unity
  • create User Api for JS
  • create User Api for Corona
  • create User Api for Cocos2DX
  • create User Api for .Net
  • create User Api for PHP
  • create User Api for Marmalade
  •  create User Api for Ruby
  •  create User Api for Flash
  1. String userName = "Nick";  
  2. App42API.Initialize("API_KEY","SECRET_KEY");  
  3. AvatarService avatarService = App42API.BuildAvatarService();    
  4. avatarService.GetCurrentAvatar(userName,new Callback());  
  5. public class Callback : App42Callback    
  6. {    
  7.     public void OnException(App42Exception exception)    
  8.     {    
  9.         Console.WriteLine("Exception Message : " + exception);    
  10.     }    
  11.     public void OnSuccess(Object response)    
  12.     {    
  13.         Avatar avatar = (Avatar) response;     
  14.         Console.WriteLine("avatarName is :" + avatar.GetName());  
  15.         Console.WriteLine("url is :" + avatar.GetURL());  
  16.         Console.WriteLine("tinyUrl is :" + avatar.GetTinyURL());  
  17.         Console.WriteLine("createdOn is :" + avatar.GetCreatedOn());  
  18.         Console.WriteLine("Description is :"+avatar.GetDescription());  
  19.         Console.WriteLine("Is Current :"+avatar.IsCurrent());  
  20.         Console.WriteLine("UserName is :"+avatar.GetUserName());  
  21.     }    
  22. }    
Change Current Avatar

Change your current avatar from existing avatars in app.

Required Parameters

userName - Name of the user whose avatar is to be updated. avatarName - Name of the avatar to be updated.

  • create User Api for Android
  • create User Api for Windows
  • create User Api for iOS
  • create User Api for Swift
  • create User Api for Java
  • create User Api for Unity
  • create User Api for JS
  • create User Api for Corona
  • create User Api for Cocos2DX
  • create User Api for .Net
  • create User Api for PHP
  • create User Api for Marmalade
  •  create User Api for Ruby
  •  create User Api for Flash
  1. String avatarName = "Shephertz Nick";  
  2. String userName = "Nick";  
  3. App42API.Initialize("API_KEY","SECRET_KEY");  
  4. AvatarService avatarService = App42API.BuildAvatarService();    
  5. avatarService.ChangeCurrentAvatar(userName,avatarName,new Callback());  
  6. public class Callback : App42Callback    
  7. {    
  8.     public void OnException(App42Exception exception)    
  9.     {    
  10.         Console.WriteLine("Exception Message : " + exception);    
  11.     }    
  12.     public void OnSuccess(Object response)    
  13.     {    
  14.         Avatar avatar = (Avatar) response;     
  15.         Console.WriteLine("avatarName is :" + avatar.GetName());  
  16.         Console.WriteLine("url is :" + avatar.GetURL());  
  17.         Console.WriteLine("tinyUrl is :" + avatar.GetTinyURL());  
  18.         Console.WriteLine("createdOn is :" + avatar.GetCreatedOn());  
  19.         Console.WriteLine("Description is :"+avatar.GetDescription());  
  20.         Console.WriteLine("Is Current :"+avatar.IsCurrent());  
  21.         Console.WriteLine("UserName is :"+avatar.GetUserName());  
  22.     }    
  23. }    
Update Avatar

Update avatar name and description of existing avatars from app.

Required Parameters

avatarName - Name of the avatar for which you want to update. userName - Name of the user who wants to update his avatar. newAvatarName - Name of the new avatar. description - Add new description about the avatar or put null to remain old.

  • create User Api for Android
  • create User Api for Windows
  • create User Api for iOS
  • create User Api for Swift
  • create User Api for Java
  • create User Api for Unity
  • create User Api for JS
  • create User Api for Corona
  • create User Api for Cocos2DX
  • create User Api for .Net
  • create User Api for PHP
  • create User Api for Marmalade
  •  create User Api for Ruby
  •  create User Api for Flash
  1. String avatarName = "Shephertz Nick";  
  2. String userName = "Nick";  
  3. String newAvatarName = "Nick Avatar";  
  4. String description = "Description about the avatar";  
  5. App42API.Initialize("API_KEY","SECRET_KEY");  
  6. AvatarService avatarService = App42API.BuildAvatarService();    
  7. avatarService.UpdateAvatar(avatarName, userName, newAvatarName,  description, new Callback());  
  8. public class Callback : App42Callback    
  9. {    
  10.     public void OnException(App42Exception exception)    
  11.     {    
  12.         Console.WriteLine("Exception Message : " + exception);    
  13.     }    
  14.     public void OnSuccess(Object response)    
  15.     {    
  16.         Avatar avatar = (Avatar) response;     
  17.         Console.WriteLine("avatarName is :" + avatar.GetName());  
  18.         Console.WriteLine("URL is :" + avatar.GetURL());  
  19.         Console.WriteLine("tinyUrl is :" + avatar.GetTinyURL());  
  20.         Console.WriteLine("createdOn is :" + avatar.GetCreatedOn());  
  21.         Console.WriteLine("Description is :"+avatar.GetDescription());  
  22.         Console.WriteLine("Is Current :"+avatar.IsCurrent());  
  23.         Console.WriteLine("UserName is :"+avatar.GetUserName());  
  24.     }    
  25. }    
Delete Avatar By Name

Delete a particular avatar based on name.

Required Parameters

userName - Name of the user who wants to delete his/her avatar. avatarName - Name of the avatar to be deleted.

  • create User Api for Android
  • create User Api for Windows
  • create User Api for iOS
  • create User Api for Swift
  • create User Api for Java
  • create User Api for Unity
  • create User Api for JS
  • create User Api for Corona
  • create User Api for Cocos2DX
  • create User Api for .Net
  • create User Api for PHP
  • create User Api for Marmalade
  •  create User Api for Ruby
  •  create User Api for Flash
  1. String userName = "Nick";  
  2. String avatarName = "Shephertz Nick";  
  3. App42API.Initialize("API_KEY","SECRET_KEY");  
  4. AvatarService avatarService = App42API.BuildAvatarService();    
  5. avatarService.DeleteAvatarByName(userName, avatarName,  new Callback());  
  6. public class Callback : App42Callback    
  7. {    
  8.     public void OnException(App42Exception exception)    
  9.     {    
  10.         Console.WriteLine("Exception Message : " + exception);    
  11.     }    
  12.     public void OnSuccess(Object response)    
  13.     {    
  14.         App42Response app42Response = (App42Response) response;   
  15.         Console.WriteLine("App42Response is : "+app42Response.ToString());  
  16.     }    
  17. }    
Delete All Avatar

Delete all avatars of a particular user.

Required Parameters

userName - Name of the user who wants to delete his/her all avatars.

  • create User Api for Android
  • create User Api for Windows
  • create User Api for iOS
  • create User Api for Swift
  • create User Api for Java
  • create User Api for Unity
  • create User Api for JS
  • create User Api for Corona
  • create User Api for Cocos2DX
  • create User Api for .Net
  • create User Api for PHP
  • create User Api for Marmalade
  •  create User Api for Ruby
  •  create User Api for Flash
  1. String userName = "Nick";  
  2. App42API.Initialize("API_KEY","SECRET_KEY");  
  3. AvatarService avatarService = App42API.BuildAvatarService();    
  4. avatarService.DeleteAllAvatars(userName, new Callback());  
  5. public class Callback : App42Callback    
  6. {    
  7.     public void OnException(App42Exception exception)    
  8.     {    
  9.         Console.WriteLine("Exception Message : " + exception);    
  10.     }    
  11.     public void OnSuccess(Object response)    
  12.     {    
  13.         App42Response app42Response = (App42Response) response;   
  14.         Console.WriteLine("App42Response is : "+app42Response.ToString());  
  15.     }    
  16. }    
Exception Handling

The functions available under Avatar API can throw some exceptions in abnormal conditions. For example, if a developer is creating the avatar name that already exist in the database, the function will throw the App42Exception (as shown below) with the message as “Bad Request” and the appErrorCode as “4701” and the details as “The Request parameters are invalid. Avatar by the name ‘Shephertz Nick’ already exists.”.

  • create User Api for Android
  • create User Api for Windows
  • create User Api for iOS
  • create User Api for Swift
  • create User Api for Java
  • create User Api for Unity
  • create User Api for JS
  • create User Api for Corona
  • create User Api for Cocos2DX
  • create User Api for .Net
  • create User Api for PHP
  • create User Api for Marmalade
  •  create User Api for Ruby
  •  create User Api for Flash
  1. String avatarName = "Shephertz Nick";  
  2. String userName = "Nick";  
  3. String filePath = "Your File Path";  
  4. String description = "My Profile Pic";    
  5. App42API.Initialize("API_KEY","SECRET_KEY");  
  6. AvatarService avatarService = App42API.BuildAvatarService();    
  7. avatarService.CreateAvatar(avatarName, userName,filePath, description,new Callback());  
  8. public class Callback : App42Callback    
  9. {    
  10.     public void OnException(App42Exception exception)    
  11.     {    
  12.         Console.WriteLine("Exception Message : " + exception);    
  13.         int appErrorCode = exception.GetAppErrorCode();  
  14.         int httpErrorCode = exception.GetHttpErrorCode();  
  15.         if(appErrorCode == 4701)  
  16.         {  
  17.             // Handle here for Bad Request (The Request parameters are invalid. Avatar by the name 'Shephertz Nick' already exists.)  
  18.         }  
  19.         else if(appErrorCode == 1401)  
  20.         {  
  21.             // handle here for Client is not authorized  
  22.         }  
  23.         else if(appErrorCode == 1500)  
  24.         {  
  25.             // handle here for Internal Server Error  
  26.         }  
  27.         String jsonText = exception.GetMessage();   
  28.     }    
  29.     public void OnSuccess(Object response)    
  30.     {   
  31.         Avatar avatar = (Avatar) response;  
  32.         String jsonResponse = avatar.ToString();    
  33.     }   
  34. }    
Error Codes

Functions in Avatar 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. 4701 - BAD REQUEST - The Request parameters are invalid. Avatar by the name '@avatarName' already exists. 4702 - NOT FOUND - User by the name '@userName' does not have any avatar. 4703 - NOT FOUND - User by the name '@userName' avatar '@avatarName'does not exist. 4704 - BAD REQUEST - The Facebook Access Credentials are invalid. + &lt;Received Facebook Exception Message>. 4705 - BAD REQUEST - Given URL is invalid.