org.gbanga.api
Class Player

java.lang.Object
  extended by org.gbanga.api.Entity
      extended by org.gbanga.api.Player

public class Player
extends Entity

A player is a real person that participates in Gbanga.

Details about JSON serialization

For the JSON object serialization, the field names are used. Eg.

 {
   name: "some name",
   status: "",
   gbangoos: [
               { id: 7223 },
               { id: 1821 }
             ]
 }
 

Fields annotated with PrimaryKey are used, if not the whole object is sent. HideIfNull indicates that the field is not sent at all, if the value is not set.

Author:
Matthias

Field Summary
 java.lang.String cellPhone
          Its cell phone number including the country code.
 int cellsDiscovered
          Number of Cells discovered
 int countriesVisited
          Number of real countries visited
 Cell currentCell
          The current location (if visible to friends or all).
 java.lang.String device
          The device the Player currently uses.
 java.lang.String email
          The email address
 java.lang.String facebook
          The Facebook User ID linked to this Player
 int friendsCount
          Number of Player friends
 Gbangoo[] gbangoos
          A list with the Gbangoos in its Pocket
 int image
          The image id of its avatar
 boolean isFriend
          Information to know if the player requesting the info is a friend.
 double latitude
          The latitude of the current location (if visible to friends or all).
 double longitude
          The longitude of the current location (if visible to friends or all).
 java.lang.String name
          The screen name
 int pocketSize
          Number of items in its Pocket
 int points
          The score point balance.
 Puzzle[] puzzles
          A list with the collected Puzzles
 Message[] shouts
          A list with cell shout Message
 int sqmVisited
          Number of real square meters visited
 java.lang.String status
          The status message
 int tagCount
          Number of Tags collected
 Visit[] trail
          A list with its Visits
 java.lang.String twitter
          The Twitter account linked to this Player
 java.lang.String twitterPassword
          The password to the linked Twitter account
 
Constructor Summary
Player()
           
 
Method Summary
 
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

cellPhone

@HideIfNull
public java.lang.String cellPhone
Its cell phone number including the country code.


cellsDiscovered

public int cellsDiscovered
Number of Cells discovered


countriesVisited

public int countriesVisited
Number of real countries visited


currentCell

@HideIfNull
public Cell currentCell
The current location (if visible to friends or all).


device

@HideIfNull
public java.lang.String device
The device the Player currently uses.


email

@HideIfNull
public java.lang.String email
The email address


facebook

@HideIfNull
public java.lang.String facebook
The Facebook User ID linked to this Player


friendsCount

public int friendsCount
Number of Player friends


gbangoos

@HideIfNull
public Gbangoo[] gbangoos
A list with the Gbangoos in its Pocket


image

public int image
The image id of its avatar


isFriend

public boolean isFriend
Information to know if the player requesting the info is a friend.


latitude

@HideIfNull
public double latitude
The latitude of the current location (if visible to friends or all).


longitude

@HideIfNull
public double longitude
The longitude of the current location (if visible to friends or all).


name

@PrimaryKey
public java.lang.String name
The screen name


pocketSize

public int pocketSize
Number of items in its Pocket


points

public int points
The score point balance.


puzzles

@HideIfNull
public Puzzle[] puzzles
A list with the collected Puzzles


shouts

@HideIfNull
public Message[] shouts
A list with cell shout Message


sqmVisited

public int sqmVisited
Number of real square meters visited


status

@HideIfNull
public java.lang.String status
The status message


tagCount

public int tagCount
Number of Tags collected


trail

@HideIfNull
public Visit[] trail
A list with its Visits


twitter

@HideIfNull
public java.lang.String twitter
The Twitter account linked to this Player


twitterPassword

@HideIfNull
public java.lang.String twitterPassword
The password to the linked Twitter account

Constructor Detail

Player

public Player()