InSquareProfile

java.lang.Object
- com.nsqre.insquare.User.InSquareProfile

```
public class InSquareProfile
extends java.lang.Object
```
InSquareProfile is the class that handles most of the user data. It's a singleton class which stores user's data locally, so the app can react faster to inputs and has less data to request from the backend

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static interface InSquareProfile.InSquareProfileListener

Nested Classes
Modifier and Type	Class and Description
`static interface`	`InSquareProfile.InSquareProfileListener`

Field Summary

Fields
Modifier and Type	Field and Description
`static java.lang.String`	`email`
`private static java.lang.String`	`EMAIL_KEY`
`private static java.lang.String`	`FACEBOOK_EMAIL_KEY`
`private static java.lang.String`	`FACEBOOK_ID_KEY`
`private static java.lang.String`	`FACEBOOK_NAME_KEY`
`private static java.lang.String`	`FACEBOOK_TOKEN_KEY`
`static java.lang.String`	`facebookEmail`
`static java.lang.String`	`facebookId`
`static java.lang.String`	`facebookName`
`static java.lang.String`	`facebookToken`
`private static java.lang.String`	`FAVOURITE_SQUARES_KEY`
`private static java.util.ArrayList<Square>`	`favouriteSquaresList` The list of the squares favoured by the user
`private static java.lang.String`	`GOOGLE_EMAIL_KEY`
`private static java.lang.String`	`GOOGLE_ID_KEY`
`private static java.lang.String`	`GOOGLE_NAME_KEY`
`private static java.lang.String`	`GOOGLE_TOKEN_KEY`
`static java.lang.String`	`googleEmail`
`static java.lang.String`	`googleId`
`static java.lang.String`	`googleName`
`static java.lang.String`	`googleToken`
`private static java.util.ArrayList<InSquareProfile.InSquareProfileListener>`	`listeners`
`private static java.lang.String`	`OUTGOING_MESSAGES`
`private static java.util.HashMap<java.lang.String,java.util.ArrayList<Message>>`	`outgoingMessages` The map of the messages I'm currently trying to send
`private static java.lang.String`	`OWNED_SQUARES_KEY`
`private static java.util.ArrayList<Square>`	`ownedSquaresList` The list of the squares owned by the user
`private static java.lang.String`	`PICTURE_URL_KEY`
`static java.lang.String`	`pictureUrl`
`private static InSquareProfile`	`profile`
`private static java.lang.String`	`RECENT_SQUARES_KEY`
`private static java.util.ArrayList<Square>`	`recentSquaresList` The list of the squares recently used by the user
`private static java.lang.String`	`SHOW_TUTORIAL`
`static boolean`	`showTutorial`
`private static java.lang.String`	`TAG`
`private static java.lang.String`	`USER_ID_KEY`
`static java.lang.String`	`userId`
`static java.lang.String`	`username`
`private static java.lang.String`	`USERNAME_KEY`

Constructor Summary

Constructors
Modifier Constructor and Description

private InSquareProfile()

Constructors
Modifier	Constructor and Description
`private`	`InSquareProfile()`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`static void`	`addFav(Square square)` Adds the square passed as parameter to the list of the favourite squares
`static void`	`addListener(InSquareProfile.InSquareProfileListener listener)`
`static void`	`addOutgoing(java.lang.String mSquareId, Message message, Context c)` Adds a message to the list of outgoing messages
`static void`	`addOwned(Square square)` Adds the square passed as parameter to the list of the owned squares
`static void`	`addRecent(Square square)` Adds the square passed as parameter to the list of the recent squares
`static void`	`clearFacebookCredentials(Context c)` Removes Facebook's saved credentials
`static void`	`clearGoogleCredentials(Context c)` Removes Google's saved credentials
`static void`	`clearProfileCredentials(Context c)` Clears all the credentials saved on the disk
`static void`	`downloadAllSquares()` Starts the download of owned, favourites and recent squares
`static void`	`downloadFavoriteSquares()` Makes a GET request to the server to download the favourite squares
`static void`	`downloadOwnedSquares()` Makes a GET request to the server to download the owned squares
`static void`	`downloadRecentSquares()` Makes a GET request to the server to download the recent squares
`static java.util.ArrayList<Square>`	`getFavouriteSquaresList()`
`static InSquareProfile`	`getInstance(Context c)` Loads the data from the disk and creates user's InSquareProfile
`static java.util.HashMap<java.lang.String,java.util.ArrayList<Message>>`	`getOutgoingMessages()`
`static java.util.ArrayList<Square>`	`getOwnedSquaresList()`
`static java.lang.String`	`getPictureUrl()`
`static java.util.ArrayList<Square>`	`getRecentSquaresList()`
`static java.lang.String`	`getUserId()`
`static java.lang.String`	`getUsername()` Return an available username.
`static boolean`	`hasLoginData()` Checks if there are userID, username and email available
`static boolean`	`isFacebookConnected()` Checks if the Facebook Access Token is available
`static boolean`	`isFav(java.lang.String squareId)` Checks if there is a square with the id equals to the one passed as parameter inside the favourite squares list
`static boolean`	`isGoogleConnected()` Checks if the Google Access Token is available
`static boolean`	`isOwned(java.lang.String squareId)` Checks if there is a square with the id equals to the one passed as parameter inside the owned squares list
`static boolean`	`isRecent(java.lang.String squareId)` Checks if there is a square with the id equals to the one passed as parameter inside the recent squares list
`static Bitmap`	`loadProfileImageFromStorage(Context context)` Loads an image from the local storage
`static void`	`removeFav(java.lang.String square)` Removes the square passed as parameter from the list of the favourite squares
`static void`	`removeListener(InSquareProfile.InSquareProfileListener listener)`
`static void`	`removeOutgoing(java.lang.String mSquareId, Message m, Context c)` Removes a message from the list of outgoing messages
`static void`	`removeOwned(java.lang.String square)` Removes the square passed as parameter from the list of the owned squares
`static void`	`removeRecent(java.lang.String square)` Removes the square passed as parameter from the list of the recent squares
`static void`	`save(Context c)` Saves locally user's data
`static java.lang.String`	`saveToInternalStorage(Context currentContext, Bitmap bitmap)` Saves an image in the local storage
`static void`	`setFavouriteSquaresList(java.util.ArrayList<Square> favouriteSquaresList)` Sets the favourite squares list, notifying the listeners
`static void`	`setOwnedSquaresList(java.util.ArrayList<Square> ownedSquaresList)` Sets the owned squares list, notifying the listeners
`static void`	`setRecentSquaresList(java.util.ArrayList<Square> recentSquaresList)` Sets the recent squares list, notifying the listeners
`static void`	`setShowTutorial(boolean showTutorial, Context context)`
`static boolean`	`showTutorial()`
`java.lang.String`	`toString()`

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

- Field Detail
  - TAG
```
private static final java.lang.String TAG
```
    See Also:
    
    Constant Field Values
  - USER_ID_KEY
```
private static final java.lang.String USER_ID_KEY
```
    See Also:
    
    Constant Field Values
  - USERNAME_KEY
```
private static final java.lang.String USERNAME_KEY
```
    See Also:
    
    Constant Field Values
  - EMAIL_KEY
```
private static final java.lang.String EMAIL_KEY
```
    See Also:
    
    Constant Field Values
  - PICTURE_URL_KEY
```
private static final java.lang.String PICTURE_URL_KEY
```
    See Also:
    
    Constant Field Values
  - OWNED_SQUARES_KEY
```
private static final java.lang.String OWNED_SQUARES_KEY
```
    See Also:
    
    Constant Field Values
  - FAVOURITE_SQUARES_KEY
```
private static final java.lang.String FAVOURITE_SQUARES_KEY
```
    See Also:
    
    Constant Field Values
  - RECENT_SQUARES_KEY
```
private static final java.lang.String RECENT_SQUARES_KEY
```
    See Also:
    
    Constant Field Values
  - OUTGOING_MESSAGES
```
private static final java.lang.String OUTGOING_MESSAGES
```
    See Also:
    
    Constant Field Values
  - FACEBOOK_ID_KEY
```
private static final java.lang.String FACEBOOK_ID_KEY
```
    See Also:
    
    Constant Field Values
  - FACEBOOK_TOKEN_KEY
```
private static final java.lang.String FACEBOOK_TOKEN_KEY
```
    See Also:
    
    Constant Field Values
  - FACEBOOK_EMAIL_KEY
```
private static final java.lang.String FACEBOOK_EMAIL_KEY
```
    See Also:
    
    Constant Field Values
  - FACEBOOK_NAME_KEY
```
private static final java.lang.String FACEBOOK_NAME_KEY
```
    See Also:
    
    Constant Field Values
  - GOOGLE_ID_KEY
```
private static final java.lang.String GOOGLE_ID_KEY
```
    See Also:
    
    Constant Field Values
  - GOOGLE_TOKEN_KEY
```
private static final java.lang.String GOOGLE_TOKEN_KEY
```
    See Also:
    
    Constant Field Values
  - GOOGLE_EMAIL_KEY
```
private static final java.lang.String GOOGLE_EMAIL_KEY
```
    See Also:
    
    Constant Field Values
  - GOOGLE_NAME_KEY
```
private static final java.lang.String GOOGLE_NAME_KEY
```
    See Also:
    
    Constant Field Values
  - SHOW_TUTORIAL
```
private static final java.lang.String SHOW_TUTORIAL
```
    See Also:
    
    Constant Field Values
  - listeners
```
private static java.util.ArrayList<InSquareProfile.InSquareProfileListener> listeners
```
  - ownedSquaresList
```
private static java.util.ArrayList<Square> ownedSquaresList
```
    The list of the squares owned by the user
  - favouriteSquaresList
```
private static java.util.ArrayList<Square> favouriteSquaresList
```
    The list of the squares favoured by the user
  - recentSquaresList
```
private static java.util.ArrayList<Square> recentSquaresList
```
    The list of the squares recently used by the user
  - outgoingMessages
```
private static java.util.HashMap<java.lang.String,java.util.ArrayList<Message>> outgoingMessages
```
    The map of the messages I'm currently trying to send
  - userId
```
public static java.lang.String userId
```
  - username
```
public static java.lang.String username
```
  - email
```
public static java.lang.String email
```
  - pictureUrl
```
public static java.lang.String pictureUrl
```
  - facebookId
```
public static java.lang.String facebookId
```
  - facebookToken
```
public static java.lang.String facebookToken
```
  - facebookEmail
```
public static java.lang.String facebookEmail
```
  - facebookName
```
public static java.lang.String facebookName
```
  - googleId
```
public static java.lang.String googleId
```
  - googleToken
```
public static java.lang.String googleToken
```
  - googleEmail
```
public static java.lang.String googleEmail
```
  - googleName
```
public static java.lang.String googleName
```
  - showTutorial
```
public static boolean showTutorial
```
  - profile
```
private static InSquareProfile profile
```
- Constructor Detail
  - InSquareProfile
```
private InSquareProfile()
```
- Method Detail
  - getInstance
```
public static InSquareProfile getInstance(Context c)
```
    Loads the data from the disk and creates user's InSquareProfile
    
    Parameters:
    
    c - The context of the application
    
    Returns:
    
    Returns the instance of the user's InSquareProfile
  - save
```
public static void save(Context c)
```
    Saves locally user's data
    
    Parameters:
    
    c - The context of the application
  - getUsername
```
public static java.lang.String getUsername()
```
    Return an available username. It chooses from the internal one, Google's or Facebook's
    
    Returns:
    
    the username
  - getUserId
```
public static java.lang.String getUserId()
```
  - getPictureUrl
```
public static java.lang.String getPictureUrl()
```
  - hasLoginData
```
public static boolean hasLoginData()
```
    Checks if there are userID, username and email available
    
    Returns:
    
    true if they're available
  - isFacebookConnected
```
public static boolean isFacebookConnected()
```
    Checks if the Facebook Access Token is available
    
    Returns:
    
    true if it is available
  - clearFacebookCredentials
```
public static void clearFacebookCredentials(Context c)
```
    Removes Facebook's saved credentials
  - isGoogleConnected
```
public static boolean isGoogleConnected()
```
    Checks if the Google Access Token is available
    
    Returns:
    
    true if it is available
  - clearGoogleCredentials
```
public static void clearGoogleCredentials(Context c)
```
    Removes Google's saved credentials
  - clearProfileCredentials
```
public static void clearProfileCredentials(Context c)
```
    Clears all the credentials saved on the disk
    
    See Also:
    
    clearFacebookCredentials(Context), clearGoogleCredentials(Context)
  - toString
```
public java.lang.String toString()
```
    Overrides:
    
    toString in class java.lang.Object
  - addListener
```
public static void addListener(InSquareProfile.InSquareProfileListener listener)
```
  - removeListener
```
public static void removeListener(InSquareProfile.InSquareProfileListener listener)
```
  - addOutgoing
```
public static void addOutgoing(java.lang.String mSquareId,
                               Message message,
                               Context c)
```
    Adds a message to the list of outgoing messages
    
    Parameters:
    
    mSquareId - the square of the message
    
    message - the Message itself
  - removeOutgoing
```
public static void removeOutgoing(java.lang.String mSquareId,
                                  Message m,
                                  Context c)
```
    Removes a message from the list of outgoing messages
    
    Parameters:
    
    mSquareId - the square of the message
    
    m - the Message itself
  - addOwned
```
public static void addOwned(Square square)
```
    Adds the square passed as parameter to the list of the owned squares
    
    Parameters:
    
    square - The square you want to add
  - removeOwned
```
public static void removeOwned(java.lang.String square)
```
    Removes the square passed as parameter from the list of the owned squares
    
    Parameters:
    
    square - The square you want to remove
  - isOwned
```
public static boolean isOwned(java.lang.String squareId)
```
    Checks if there is a square with the id equals to the one passed as parameter inside the owned squares list
    
    Parameters:
    
    squareId - The id of the square
    
    Returns:
    
    True if the square is present
  - addFav
```
public static void addFav(Square square)
```
    Adds the square passed as parameter to the list of the favourite squares
    
    Parameters:
    
    square - The square you want to add
  - removeFav
```
public static void removeFav(java.lang.String square)
```
    Removes the square passed as parameter from the list of the favourite squares
    
    Parameters:
    
    square - The square you want to remove
  - isFav
```
public static boolean isFav(java.lang.String squareId)
```
    Checks if there is a square with the id equals to the one passed as parameter inside the favourite squares list
    
    Parameters:
    
    squareId - The id of the square
    
    Returns:
    
    True if the square is present
  - addRecent
```
public static void addRecent(Square square)
```
    Adds the square passed as parameter to the list of the recent squares
    
    Parameters:
    
    square - The square you want to add
  - removeRecent
```
public static void removeRecent(java.lang.String square)
```
    Removes the square passed as parameter from the list of the recent squares
    
    Parameters:
    
    square - The square you want to remove
  - isRecent
```
public static boolean isRecent(java.lang.String squareId)
```
    Checks if there is a square with the id equals to the one passed as parameter inside the recent squares list
    
    Parameters:
    
    squareId - The id of the square
    
    Returns:
    
    True if the square is present
  - getOwnedSquaresList
```
public static java.util.ArrayList<Square> getOwnedSquaresList()
```
  - getFavouriteSquaresList
```
public static java.util.ArrayList<Square> getFavouriteSquaresList()
```
  - getRecentSquaresList
```
public static java.util.ArrayList<Square> getRecentSquaresList()
```
  - getOutgoingMessages
```
public static java.util.HashMap<java.lang.String,java.util.ArrayList<Message>> getOutgoingMessages()
```
  - setOwnedSquaresList
```
public static void setOwnedSquaresList(java.util.ArrayList<Square> ownedSquaresList)
```
    Sets the owned squares list, notifying the listeners
    
    Parameters:
    
    ownedSquaresList - the list to set
  - setFavouriteSquaresList
```
public static void setFavouriteSquaresList(java.util.ArrayList<Square> favouriteSquaresList)
```
    Sets the favourite squares list, notifying the listeners
    
    Parameters:
    
    favouriteSquaresList - the list to set
  - setRecentSquaresList
```
public static void setRecentSquaresList(java.util.ArrayList<Square> recentSquaresList)
```
    Sets the recent squares list, notifying the listeners
    
    Parameters:
    
    recentSquaresList - the list to set
  - saveToInternalStorage
```
public static java.lang.String saveToInternalStorage(Context currentContext,
                                                     Bitmap bitmap)
```
    Saves an image in the local storage
    
    Parameters:
    
    bitmap - the image to save
    
    Returns:
    
    the path of the saved image
  - loadProfileImageFromStorage
```
public static Bitmap loadProfileImageFromStorage(Context context)
```
    Loads an image from the local storage
    
    Returns:
    
    the Bitmap object of the image
  - downloadAllSquares
```
public static void downloadAllSquares()
```
    Starts the download of owned, favourites and recent squares
    
    See Also:
    
    downloadOwnedSquares(), downloadFavoriteSquares(), downloadRecentSquares()
  - downloadRecentSquares
```
public static void downloadRecentSquares()
```
    Makes a GET request to the server to download the recent squares
  - downloadFavoriteSquares
```
public static void downloadFavoriteSquares()
```
    Makes a GET request to the server to download the favourite squares
  - downloadOwnedSquares
```
public static void downloadOwnedSquares()
```
    Makes a GET request to the server to download the owned squares
  - showTutorial
```
public static boolean showTutorial()
```
  - setShowTutorial
```
public static void setShowTutorial(boolean showTutorial,
                                   Context context)
```

Class InSquareProfile

Nested Class Summary

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

TAG

USER_ID_KEY

USERNAME_KEY

EMAIL_KEY

PICTURE_URL_KEY

OWNED_SQUARES_KEY

FAVOURITE_SQUARES_KEY

RECENT_SQUARES_KEY

OUTGOING_MESSAGES

FACEBOOK_ID_KEY

FACEBOOK_TOKEN_KEY

FACEBOOK_EMAIL_KEY

FACEBOOK_NAME_KEY

GOOGLE_ID_KEY

GOOGLE_TOKEN_KEY

GOOGLE_EMAIL_KEY

GOOGLE_NAME_KEY

SHOW_TUTORIAL

listeners

ownedSquaresList

favouriteSquaresList

recentSquaresList

outgoingMessages

userId

username

email

pictureUrl

facebookId

facebookToken

facebookEmail

facebookName

googleId

googleToken

googleEmail

googleName

showTutorial

profile

Constructor Detail

InSquareProfile

Method Detail

getInstance

save

getUsername

getUserId

getPictureUrl

hasLoginData

isFacebookConnected

clearFacebookCredentials

isGoogleConnected

clearGoogleCredentials

clearProfileCredentials

toString

addListener

removeListener

addOutgoing

removeOutgoing

addOwned

removeOwned

isOwned

addFav

removeFav

isFav

addRecent

removeRecent

isRecent

getOwnedSquaresList

getFavouriteSquaresList

getRecentSquaresList

getOutgoingMessages

setOwnedSquaresList

setFavouriteSquaresList

setRecentSquaresList

saveToInternalStorage