|
|||||||||
| PREV NEXT | FRAMES NO FRAMES | ||||||||
| Packages that use APIException | |
|---|---|
| org.gbanga.api | Specifies the complete interface to the Gbanga Puppetmaster API service. |
| Uses of APIException in org.gbanga.api |
|---|
| Methods in org.gbanga.api that throw APIException | |
|---|---|
Trade |
API.abort(java.lang.String sessionKey,
long tradeId)
Decline an incoming trade offer. |
Trade |
API.accept(java.lang.String sessionKey,
long tradeId)
Accept an incoming trade offer. |
Player |
API.acceptFriendship(java.lang.String sessionKey,
java.lang.String player)
Accepts the friendship offer of another player. |
Trade |
API.addToOffer(java.lang.String sessionKey,
long tradeId,
long offeredGoodId,
long requestedGoodId)
Add goods to the indicated offer. |
Player |
API.adjustInterests(java.lang.String sessionKey,
boolean play,
boolean collecting,
boolean trading,
boolean events,
boolean networking,
boolean travel,
boolean dating)
Update your keywords of interest. |
Gbangoo |
API.beamGbangoo(java.lang.String sessionKey,
long gbangooId,
java.lang.String cellName)
Teleport a Gbangoo to a given cell. |
Infrastructure |
API.beamInfrastructure(java.lang.String sessionKey,
long infrastructureId,
java.lang.String cellName)
Teleport an infrastructure to a given cell. |
Resource |
API.beamResource(java.lang.String sessionKey,
long resourceId,
java.lang.String cellName)
Teleport a resource to a given cell. |
Player |
API.breakWith(java.lang.String sessionKey,
java.lang.String player,
java.lang.String lastMessage)
Break with a prior friend and, optionally, let him know why. |
void |
API.broadcast(java.lang.String sessionKey,
java.lang.String message)
Sends a Message to all player friends. |
Infrastructure |
API.build(java.lang.String sessionKey,
long gbangooId,
long type,
java.lang.String screenname)
A Gbangoo starts with a construction of a building of given type at its current location. |
Challenge |
API.challenge(java.lang.String sessionKey,
long challengerId,
long opponentId)
Start a match between the initiating challenger and the challenged opponent. |
Player |
API.changeSettings(java.lang.String sessionKey,
boolean friendCanSeeMyPosition,
boolean everybodyCanSeeMyPosition,
boolean notifyBySMS,
boolean notifyByEmail)
Update your privacy sensitive settings. |
Tile |
API.clear(java.lang.String sessionKey,
long tileId)
Remove the indicated tile from the Gbanga world. |
void |
API.collectResource(java.lang.String sessionKey,
long id)
Collects a resource. |
long |
API.createAvatar(java.lang.String sessionKey,
java.io.InputStream image)
Creates a new avatar from the given InputStream. |
long |
API.createDescription(java.lang.String sessionKey,
java.lang.String text)
Creates a new description from the given text. |
Gbangoo |
API.createGbangoo(java.lang.String sessionKey,
long type,
java.lang.String name,
long avatar,
long description)
Creates a Gbangoo. |
long |
API.createGbangooType(java.lang.String sessionKey,
java.io.InputStream avatar,
java.lang.String description,
java.lang.String comment)
Creates a new Gbangoo type. |
Gube |
API.createGube(java.lang.String sessionKey,
long tileId,
int lifetime,
int color)
Pulls a Gube at the given location. |
Infrastructure |
API.createInfrastructure(java.lang.String sessionKey,
long type,
java.lang.String name,
long avatar,
long description)
Creates an Infrastructure. |
long |
API.createInfrastructureType(java.lang.String sessionKey,
java.io.InputStream avatar,
java.lang.String description,
java.lang.String comment)
Creates a new Infrastructure type. |
Resource |
API.createResource(java.lang.String sessionKey,
long type,
short amount)
Creates a particular amount of a resource of given type. |
long |
API.createResourceType(java.lang.String sessionKey,
java.lang.String screenname,
java.io.InputStream avatar,
java.lang.String description)
Creates a new Resource type. |
Tag |
API.createTag(java.lang.String sessionKey,
long content,
long avatar)
|
Cell |
API.decorate(java.lang.String sessionKey,
long cellId,
int[] flag)
Set the flag for a given cell. |
Feature |
API.discover(java.lang.String sessionKey,
java.lang.String cellName,
float latitude,
float longitude,
java.lang.String cellFlagString)
Creates a new cell based on the the geographical location of a given player. |
void |
API.dispose(java.lang.String sessionKey,
long goodId)
Disposes of the given Good. |
FeatureCollection |
API.findOnMap(java.lang.String queryPhrase)
Locates the given phrase in Gbanga (Cell name, city name, ZIP code, etc.) |
Player |
API.forceFriendship(java.lang.String sessionKey,
java.lang.String offerer,
java.lang.String receiver)
Forces a friendship offer to be sent from one player to another one. |
void |
API.free(java.lang.String sessionKey,
long entityId)
Releases the given entity to be freely available to other Players. |
Message[] |
API.getAllMessages(java.lang.String sessionKey)
Returns a list with Messages that have not been read by the recieving Player yet. |
Cell |
API.getCell(java.lang.String cellName)
Retrieves the cell with the given name. |
java.lang.String[] |
API.getCellNames(float topLatitude,
float leftLongitude,
float bottomLatitude,
float rightLongitude)
Retrieves the names of all cells within the specified area. |
Message[] |
API.getConversationWithGbangoo(java.lang.String sessionKey,
long gbangoo)
Returns the last messages between you and a Gbangoo (max. 5 messages) |
Message[] |
API.getConversationWithPlayer(java.lang.String sessionKey,
java.lang.String player)
Returns the last messages between two players (max. |
int |
API.getCountEntitiesWithMemory(java.lang.String sessionKey,
java.lang.String key,
java.lang.String value)
Counts the entities containing a specific entry in the memory db. |
java.lang.String |
API.getDownloadLink(java.lang.String sessionKey)
Requests a message with the download location for the client software. |
EntitiesFromMemory |
API.getEntitiesWithMemory(java.lang.String sessionKey,
java.lang.String memkey,
java.lang.String value)
Gets the entities containing a specific entry in the memory db. |
Event[] |
API.getEventsAt(java.lang.String cellname)
Assorts a list with local Events at a given Cell. |
Event[] |
API.getEventsAt(java.lang.String cellname,
int n)
Assorts a list with a given number of local Events at a given Cell. |
Story[] |
API.getFeaturedStories(int n)
Returns a list of featured stories interesting to be displayed on the frontpage. |
Player[] |
API.getFriends(java.lang.String sessionKey)
Returns a list with friend Players of a given authenticated Player. |
Player[] |
API.getFriendsInDetail(java.lang.String sessionKey)
Returns a list with friend Players containing the location if allowed
of a given authenticated Player. |
Gbangoo |
API.getGbangoo(java.lang.String gbangooName,
java.lang.String ownerName)
Retrieve a Gbangoo owned by the indicated player. |
Gbangoo |
API.getGbangooById(long gbangooId)
Retrieve a Gbangoo given its ID. |
Gbangoo |
API.getGbangooById(java.lang.String sessionKey,
long gbangooId,
java.lang.String lang)
Retrieve a Gbangoo given its ID containing the description in the player's language. |
Event[] |
API.getGlobalEvents(int n)
Returns a number of events that take place right now. |
Player[] |
API.getHighscore(int first,
int n,
byte type)
Assorts a list with entries for the given type of highscore with the given number of entries with a given rank. |
Infrastructure |
API.getInfrastructure(long infrastructureId)
Retrieve an Infrastructure given its ID. |
Infrastructure |
API.getInfrastructure(java.lang.String sessionKey,
long infrastructureId,
java.lang.String lang)
Retrieve an Infrastructure given its ID containing the description in the player's language. |
int |
API.getLoginType(java.lang.String playerName)
Request a membership for the given person with the given details. |
FeatureCollection |
API.getMapTile(float topLatitude,
float leftLongitude,
float bottomLatitude,
float rightLongitude)
Returns a list of placemarks that are within the specified area. |
java.lang.String |
API.getMemory(java.lang.String sessionKey,
java.lang.String entityId,
java.lang.String key)
Return the value of a given key in a given Entity's memory. |
Tag[] |
API.getMostPopular(int n)
Returns a gien number of the most popular Tags. |
Player[] |
API.getNewcomers(int n)
Assorts a list with Players that have recently signed up. |
int |
API.getNumCells(float topLatitude,
float leftLongitude,
float bottomLatitude,
float rightLongitude)
Gets the number of cells within the specified area. |
Player |
API.getPlayer(java.lang.String playerName)
Retrieve a player indicated the player name. |
Player |
API.getPlayer(java.lang.String sessionKey,
java.lang.String playerName)
Retrieve a player indicated the player name and extra details if the caller is a friend. |
FeatureCollection |
API.getPlayersIn(float topLatitude,
float leftLongitude,
float bottomLatitude,
float rightLongitude)
Returns a list of players that are present within the specified area. |
FeatureCollection |
API.getPlayersIn(java.lang.String sessionKey,
float topLatitude,
float leftLongitude,
float bottomLatitude,
float rightLongitude)
Returns a list of players that are present within the specified area. |
Pocket |
API.getPocket(java.lang.String sessionKey)
Returns the personal pocket. |
Pocket |
API.getPocketOf(java.lang.String sessionKey,
java.lang.String playerName)
Returns the pocket of the given player. |
Cell |
API.getRandomCell(float topLatitude,
float leftLongitude,
float bottomLatitude,
float rightLongitude)
Retrieves a random cell within the specified area. |
java.lang.String[] |
API.getRanking(java.lang.String memkey,
int from,
int count)
Gets the ranking of players according to the natural ordering of values in the players' memory for a given key and rank range. |
Resource |
API.getResource(long id)
Retrieve a resource given the id. |
Resource |
API.getResource(java.lang.String sessionKey,
long id,
java.lang.String lang)
Retrieve a resource given the id containing the description in the player's language.. |
Message[] |
API.getShouts(java.lang.String sessionKey)
Gets the most recent shouts. |
Message[] |
API.getStatusFeed(java.lang.String sessionKey)
Gets the status feed messages. |
Tag |
API.getTag(long id)
Retrieve a tag given the id. |
Message[] |
API.getUnreadMessages(java.lang.String sessionKey)
Returns a list with Messages that have not been read by the recieving Player yet. |
WebHookSubscription[] |
API.getWebHookSubscriptions(java.lang.String sessionKey)
Gets all subscriptions to any Web Hook for the given user. |
Event[] |
API.getYourEvents(java.lang.String sessionKey)
Returns a number of events that are relevant to an authenticated player personally. |
Event[] |
API.getYourEvents(java.lang.String sessionKey,
int n)
Returns a number of events that are relevant to an authenticated player personally. |
Good |
API.give(java.lang.String sessionKey,
java.lang.String receivingPlayer,
long goodId)
Transfers the given Good from one Pocket to another Players Pocket. |
void |
API.interact(java.lang.String sessionKey,
long id)
Interact with an infrastructure. |
boolean |
API.invite(java.lang.String sessionKey,
java.lang.String name,
java.lang.String contactInfo)
Send an invitation to the given contact. |
boolean |
API.isEmailAvailable(java.lang.String email)
Checks if the given email address is available. |
boolean |
API.isPhoneAvailable(java.lang.String phone)
Checks if the given (cell) phone number address is available. |
boolean |
API.isTradable(long entityId)
Checks if a given entity is tradable. |
Gube |
API.jump(java.lang.String sessionKey,
long gbangooId)
A Gbangoo should jump to the current location of the player and produce the prepared Gube. |
Feature |
API.locate(java.lang.String sessionKey,
float latitude,
float longitude)
Retrieve the geographical location of a given cell. |
WebSession |
API.login(java.lang.String playerName,
java.lang.String password)
Authenticates and generates a session key. |
void |
API.logout(java.lang.String sessionKey)
Close a currently open session by indicating the sessionKey. |
Message |
API.mail(java.lang.String sessionKey,
java.lang.String receivingPlayer,
java.lang.String message)
Send a Message to a remote Player. |
void |
API.makeProductItemAvailableTo(java.lang.String sessionKey,
long productItemId,
java.lang.String player,
boolean available)
Collect a resource. |
Gbangoo |
API.mine(java.lang.String sessionKey,
long gbangooId)
A Gbangoo starts mining at its current location. |
Event |
API.move(java.lang.String sessionKey,
long entityId,
long direction)
Move a placeable Entity towards a given direction |
void |
API.notify(java.lang.String sessionKey,
java.lang.String player,
java.lang.String title,
java.lang.String description,
long avatar,
boolean shareable)
Sends a notification message to a player. |
Player |
API.offerFriendship(java.lang.String sessionKey,
java.lang.String player,
java.lang.String introduction)
Offer friendship to another player. |
Pocket |
API.pick(java.lang.String sessionKey,
long tagId)
Pick up a copy of a tag |
Tile |
API.piece(java.lang.String sessionKey,
long tagId,
long tileId)
Create a tag at a given position. |
Challenge |
API.playCard(java.lang.String sessionKey,
long challengeId,
long tagId)
Play a given card in a given match. |
void |
API.playSound(java.lang.String sessionKey,
java.lang.String name,
long melodyId)
Plays a sound on the device of the given Player if logged in and if settings allow. |
Trade |
API.postOffer(java.lang.String sessionKey,
long tradeId)
Sends the created offer to the trading partner. |
Trade |
API.prepareOffer(java.lang.String sessionKey,
java.lang.String partnerName)
Prepare a trade (initial offer or re-offer) with a given player. |
Cell |
API.rateCell(java.lang.String sessionKey,
long cellId,
byte rating,
java.lang.String comment)
Rate a given cell. |
Tag |
API.rateTag(java.lang.String sessionKey,
long tagId,
byte rating,
java.lang.String comment)
Vote for the rating of a Cell. |
void |
API.register(java.lang.String playerName,
java.lang.String password,
java.lang.String cellPhone,
java.lang.String email,
java.lang.String model,
java.lang.String language,
java.lang.String method)
Request a membership for the given person with the given details. |
void |
API.registerFB(java.lang.String playerName,
java.lang.String fbuid,
java.lang.String fbsession,
java.lang.String model,
java.lang.String language,
java.lang.String method)
Request a membership for the given person with the given details. |
void |
API.registerFQ(java.lang.String playerName,
java.lang.String fquid,
java.lang.String fbsession,
java.lang.String model,
java.lang.String language,
java.lang.String method)
Request a membership for the given person with the given details. |
void |
API.registerLess(java.lang.String playerName,
java.lang.String iphoneid,
java.lang.String model,
java.lang.String language,
java.lang.String method)
Register a player with the iphone id as the identifier. |
void |
API.registerTwitter(java.lang.String playerName,
java.lang.String tuid,
java.lang.String fbsession,
java.lang.String model,
java.lang.String language,
java.lang.String method)
Request a membership for the given person with the given details. |
void |
API.remindPassword(java.lang.String phoneOrEmail)
Request a password reminder message to an email address or a cell phone. |
void |
API.removeMemory(java.lang.String sessionKey,
java.lang.String entityId,
java.lang.String key)
Remove a key-value pair from a Entity's memory. |
Cell |
API.renameCell(java.lang.String sessionKey,
long cellId,
java.lang.String name)
Gives a new name to a given cell. |
int |
API.reportBug(java.lang.String author,
java.lang.String content,
int severity)
Post a bug report indicating the author, a problem description and the severity. |
Report |
API.reportPlayer(java.lang.String sessionKey,
java.lang.String player,
java.lang.String explanation)
Report an incident about a player that didn't comply with the regulations (rudeness in chat messages, privacy tricks, fraud, creating dangerous quests, etc.). |
DownloadRequest |
API.requestDownloadSMS(java.lang.String playerName,
java.lang.String password)
Request a message with the download location for the client software. |
DownloadRequest |
API.requestDownloadSMSByHeader(java.lang.String playerName,
java.lang.String password,
java.lang.String header)
Same as API.requestDownloadSMS(String, String) but also uses the given
http header to guess the user's device. |
DownloadRequest |
API.requestDownloadSMSBySessionKey(java.lang.String sessionKey)
Request a message with the download location for the client software. |
void |
API.requestPurchasedItem(java.lang.String sessionKey,
java.lang.String appleProductId,
java.lang.String transactionId,
java.lang.String receipt)
Counts the entities containing a specific entry in the memory db. |
WebSession |
API.resume(java.lang.String playerName,
java.lang.String sessionKey)
Password-less resume into existing session. |
void |
API.reward(java.lang.String sessionKey,
java.lang.String player,
int points)
Reward the given Player with points. |
boolean |
API.setCode(java.lang.String key,
long id,
java.lang.String code)
Applies a "download code" for the given entity. |
void |
API.setMemory(java.lang.String sessionKey,
java.lang.String entityId,
java.lang.String key,
java.lang.String value)
Add a key-value pair to a Entity's memory. |
void |
API.setMemoryForAll(java.lang.String sessionKey,
java.lang.String key,
java.lang.String value)
Set a key-value pair to all the Entity's memory having the key. |
void |
API.setTradable(java.lang.String sessionKey,
long entityId,
boolean yes)
Sets if a given entity is tradable. |
Message |
API.shout(java.lang.String sessionKey,
java.lang.String receivingCell,
java.lang.String message)
Shout a text Message to a Cell. |
void |
API.showTicker(java.lang.String sessionKey,
java.lang.String name,
java.lang.String ticker)
Shows a ticker message on the device of the given Player if logged in and if settings allow. |
Event |
API.speak(java.lang.String sessionKey,
long gbangooId,
java.lang.String message)
Lets the given Gbangoo send the message to everyone in its current cell. |
Event |
API.speakTo(java.lang.String sessionKey,
long gbangooId,
java.lang.String player,
java.lang.String message)
Lets the given Gbangoo send a message to the specified player. |
Gbangoo |
API.stop(java.lang.String sessionKey,
long gbangooId)
Halts the given Gbangoo. |
java.lang.String |
API.subscribeToWebHook(java.lang.String sessionKey,
int event,
java.lang.String filter,
java.lang.String url)
Registers a Web Hook listener at the given URL for the given user. |
int |
API.takeOverCell(java.lang.String sessionKey,
java.lang.String playerName,
java.lang.String cellName,
java.lang.String newOwner)
Transfer the ownership of a cell to a new family |
Trade |
API.trade(java.lang.String sessionKey,
java.lang.String partnerName,
java.lang.String offeredGoodIdString,
java.lang.String requestedGoodIdString)
Add goods to the indicated offer. |
int |
API.transferInfrastructuresAndCells(java.lang.String sessionKey,
java.lang.String playerName,
java.lang.String newFamily)
Transfer the infrstructures owned by a player from a family to another one |
java.lang.String |
API.unsubscribeFromWebHook(java.lang.String sessionKey,
java.lang.String url)
Unregisters a Web Hook listener at the given URL for the given user. |
void |
API.updateAvatar(java.lang.String sessionKey,
long entityId,
java.io.InputStream is)
Updates the image of a given entity. |
void |
API.updateAvatarByRef(java.lang.String sessionKey,
long entityId,
long avatarId)
Sets the image of a given entity by referencing an existing image. |
void |
API.updateDescription(java.lang.String sessionKey,
long entityId,
java.lang.String description)
Sets the description field of the given entity. |
void |
API.updateEmail(java.lang.String sessionKey,
java.lang.String playerName,
java.lang.String email)
Update the email of a Player. |
void |
API.updateGbangooType(java.lang.String sessionKey,
long type,
java.io.InputStream avatar,
java.lang.String description,
java.lang.String comment)
Updates an existing Gbangoo type. |
void |
API.updateInfrastructureType(java.lang.String sessionKey,
long type,
java.io.InputStream avatar,
java.lang.String description,
java.lang.String comment)
Updates an existing Infrastructure type. |
Player |
API.updateProfile(java.lang.String sessionKey,
java.lang.String cellphone,
java.lang.String email)
Update the details of a Player. |
void |
API.updateProfileImage(java.lang.String sessionKey,
java.io.InputStream image)
Update the profile image of the authenticated Player. |
void |
API.updateResourceType(java.lang.String sessionKey,
long type,
java.lang.String screenname,
java.io.InputStream avatar,
java.lang.String description)
Updates an existing Resource type. |
Player |
API.updateStatus(java.lang.String sessionKey,
java.lang.String status)
Updates the status message of a Player in a manner similar to a Twitter message, Facebook's status or a tagline in any instant messenger (eg, MSN and Skype). |
|
|||||||||
| PREV NEXT | FRAMES NO FRAMES | ||||||||