| Package | playerio |
| Class | public class PlayerIOError |
| Inheritance | PlayerIOError Error |
| Subclasses | PlayerIORegistrationError |
| Property | Defined By | ||
|---|---|---|---|
| type : PlayerIOError [read-only]
The type of error the PlayerIOError object represent
| PlayerIOError | ||
| Method | Defined By | ||
|---|---|---|---|
PlayerIOError(message:String, id:int)
Create a new PlayerIOError object. | PlayerIOError | ||
| Constant | Defined By | ||
|---|---|---|---|
| AccessDenied : PlayerIOError [static]
PlayerIOError type if access is denied
| PlayerIOError | ||
| ArgumentOutOfRange : PlayerIOError [static]
PlayerIOError type if the given argument value is outside the range of allowed values. | PlayerIOError | ||
| BigDBObjectDoesNotExist : PlayerIOError [static]
PlayerIOError type if could not locate the database object. | PlayerIOError | ||
| BigDBObjectTooLarge : PlayerIOError [static]
PlayerIOError type if the object exceeds the maximum allowed size for BigDB objects. | PlayerIOError | ||
| BuyingCoinsNotSupportedByProvider : PlayerIOError [static]
PlayerIOError type if the specified PayVault provider does not support buying coins
| PlayerIOError | ||
| CircularReference : PlayerIOError [static]
PlayerIOError type if cannot create circular references inside database objects
| PlayerIOError | ||
| DirectPurchaseNotSupportedByProvider : PlayerIOError [static]
PlayerIOError type if the specified PayVault provider does not support direct purchase
| PlayerIOError | ||
| ExternalError : PlayerIOError [static]
PlayerIOError type if an error occurred while contacting an external service
| PlayerIOError | ||
| GameDisabled : PlayerIOError [static]
PlayerIOError type if the game has been disabled, most likely because of missing payment. | PlayerIOError | ||
| GameRequired : PlayerIOError [static]
PlayerIOError type if a game is required to do this action
| PlayerIOError | ||
| GeneralError : PlayerIOError [static]
PlayerIOError type if a general error occured
| PlayerIOError | ||
| HeartbeatFailed : PlayerIOError [static]
PlayerIOError type if the server could not complete the heartbeat
| PlayerIOError | ||
| InternalError : PlayerIOError [static]
PlayerIOError type if an unexpected error occured inside the Player.IO webservice. | PlayerIOError | ||
| InvalidAuth : PlayerIOError [static]
PlayerIOError type if the auth given is invalid or malformatted
| PlayerIOError | ||
| InvalidBigDBKey : PlayerIOError [static]
PlayerIOError type if the key given for the BigDB object is not a valid BigDB key. | PlayerIOError | ||
| InvalidGameCode : PlayerIOError [static]
PlayerIOError type if the game code is invalid
| PlayerIOError | ||
| InvalidIndexValue : PlayerIOError [static]
PlayerIOError type if the value given for the index, does not match the expeceded type. | PlayerIOError | ||
| InvalidMessageFormat : PlayerIOError [static]
PlayerIOError type if the message is malformatted
| PlayerIOError | ||
| InvalidPassword : PlayerIOError [static]
PlayerIOError type if the password supplied is incorrect
| PlayerIOError | ||
| InvalidPayVaultProviderSetup : PlayerIOError [static]
PlayerIOError type if the chosen provider is not configured correctly in the admin panel
| PlayerIOError | ||
| InvalidPurchaseArguments : PlayerIOError [static]
PlayerIOError type if the chosen provider rejected one or more of the purchase arguments
| PlayerIOError | ||
| InvalidRegistrationData : PlayerIOError [static]
PlayerIOError type if the supplied data is incorrect
| PlayerIOError | ||
| ItemNotInVault : PlayerIOError [static]
PlayerIOError type if the item does not exist in the vault. | PlayerIOError | ||
| KeyAlreadyUsed : PlayerIOError [static]
PlayerIOError type if the key is in use by another database object
| PlayerIOError | ||
| MissingRoomId : PlayerIOError [static]
PlayerIOError type if you can't join the room when the RoomID is null or the empty string
| PlayerIOError | ||
| MissingValue : PlayerIOError [static]
PlayerIOError type if a value is missing
| PlayerIOError | ||
| NoServersAvailable : PlayerIOError [static]
PlayerIOError type if there is no server in any of the selected server clusters for the game that are eligible to start a new room in (they're all at full capacity or there are no servers in any of the clusters). | PlayerIOError | ||
| NotASearchColumn : PlayerIOError [static]
PlayerIOError type if the key you specified is not set as searchable. | PlayerIOError | ||
| NotEnoughCoins : PlayerIOError [static]
PlayerIOError type if the user does not have enough coins in the PayVault to complete the purchase or debit. | PlayerIOError | ||
| NotObjectCreator : PlayerIOError [static]
PlayerIOError type if the operation was aborted because the user attempting the operation was not the original creator of the object accessed. | PlayerIOError | ||
| QuickConnectMethodNotEnabled : PlayerIOError [static]
PlayerIOError type if the QuickConnect method (simple, facebook, kongregate...) is not enabled for the game. | PlayerIOError | ||
| RoomAlreadyExists : PlayerIOError [static]
PlayerIOError type if you are unable to create room because there is already a room with the specified id
| PlayerIOError | ||
| RoomDataTooLarge : PlayerIOError [static]
PlayerIOError type if the room data for the room was over the allowed size limit
| PlayerIOError | ||
| RoomIsFull : PlayerIOError [static]
PlayerIOError type if the room already has the maxmium amount of users in it. | PlayerIOError | ||
| StaleVersion : PlayerIOError [static]
PlayerIOError type if bigDB object could not be saved using optimistic locks as it's out of date. | PlayerIOError | ||
| UnknownConnection : PlayerIOError [static]
PlayerIOError type if the connection requested is not known by the server
| PlayerIOError | ||
| UnknownGame : PlayerIOError [static]
PlayerIOError type if the game requested is not known by the server
| PlayerIOError | ||
| UnknownIndex : PlayerIOError [static]
PlayerIOError type if the specified index does not exist. | PlayerIOError | ||
| UnknownPartnerPayAction : PlayerIOError [static]
PlayerIOError type if unable to locate the custom PartnerPay action with the given key
| PlayerIOError | ||
| UnknownPayVaultProvider : PlayerIOError [static]
PlayerIOError type if there is no PayVault provider with the specified id
| PlayerIOError | ||
| UnknownRoom : PlayerIOError [static]
PlayerIOError type if there is no room running with that id
| PlayerIOError | ||
| UnknownRoomType : PlayerIOError [static]
PlayerIOError type if the game you're connected to does not have a room type with the specified name
| PlayerIOError | ||
| UnknownTable : PlayerIOError [static]
PlayerIOError type if the specified table does not exist. | PlayerIOError | ||
| UnknownUser : PlayerIOError [static]
PlayerIOError type if the user is unknown
| PlayerIOError | ||
| UnsupportedMethod : PlayerIOError [static]
PlayerIOError type if the method requested is not supported
| PlayerIOError | ||
| VaultNotLoaded : PlayerIOError [static]
PlayerIOError type if cannot access coins or items before vault has been loaded. | PlayerIOError | ||
| type | property |
type:PlayerIOError [read-only] The type of error the PlayerIOError object represent
public function get type():PlayerIOError| PlayerIOError | () | Constructor |
public function PlayerIOError(message:String, id:int)Create a new PlayerIOError object. Errors initialized outside the api will have the type GeneralError
Parametersmessage:String | |
id:int |
| AccessDenied | Constant |
public static const AccessDenied:PlayerIOErrorPlayerIOError type if access is denied
| ArgumentOutOfRange | Constant |
public static const ArgumentOutOfRange:PlayerIOErrorPlayerIOError type if the given argument value is outside the range of allowed values.
| BigDBObjectDoesNotExist | Constant |
public static const BigDBObjectDoesNotExist:PlayerIOErrorPlayerIOError type if could not locate the database object.
| BigDBObjectTooLarge | Constant |
public static const BigDBObjectTooLarge:PlayerIOErrorPlayerIOError type if the object exceeds the maximum allowed size for BigDB objects.
| BuyingCoinsNotSupportedByProvider | Constant |
public static const BuyingCoinsNotSupportedByProvider:PlayerIOErrorPlayerIOError type if the specified PayVault provider does not support buying coins
| CircularReference | Constant |
public static const CircularReference:PlayerIOErrorPlayerIOError type if cannot create circular references inside database objects
| DirectPurchaseNotSupportedByProvider | Constant |
public static const DirectPurchaseNotSupportedByProvider:PlayerIOErrorPlayerIOError type if the specified PayVault provider does not support direct purchase
| ExternalError | Constant |
public static const ExternalError:PlayerIOErrorPlayerIOError type if an error occurred while contacting an external service
| GameDisabled | Constant |
public static const GameDisabled:PlayerIOErrorPlayerIOError type if the game has been disabled, most likely because of missing payment.
| GameRequired | Constant |
public static const GameRequired:PlayerIOErrorPlayerIOError type if a game is required to do this action
| GeneralError | Constant |
public static const GeneralError:PlayerIOErrorPlayerIOError type if a general error occured
| HeartbeatFailed | Constant |
public static const HeartbeatFailed:PlayerIOErrorPlayerIOError type if the server could not complete the heartbeat
| InternalError | Constant |
public static const InternalError:PlayerIOErrorPlayerIOError type if an unexpected error occured inside the Player.IO webservice. Please try again.
| InvalidAuth | Constant |
public static const InvalidAuth:PlayerIOErrorPlayerIOError type if the auth given is invalid or malformatted
| InvalidBigDBKey | Constant |
public static const InvalidBigDBKey:PlayerIOErrorPlayerIOError type if the key given for the BigDB object is not a valid BigDB key. BigDB keys must be between 1 and 50 word characters (no spaces).
| InvalidGameCode | Constant |
public static const InvalidGameCode:PlayerIOErrorPlayerIOError type if the game code is invalid
| InvalidIndexValue | Constant |
public static const InvalidIndexValue:PlayerIOErrorPlayerIOError type if the value given for the index, does not match the expeceded type.
| InvalidMessageFormat | Constant |
public static const InvalidMessageFormat:PlayerIOErrorPlayerIOError type if the message is malformatted
| InvalidPassword | Constant |
public static const InvalidPassword:PlayerIOErrorPlayerIOError type if the password supplied is incorrect
| InvalidPayVaultProviderSetup | Constant |
public static const InvalidPayVaultProviderSetup:PlayerIOErrorPlayerIOError type if the chosen provider is not configured correctly in the admin panel
| InvalidPurchaseArguments | Constant |
public static const InvalidPurchaseArguments:PlayerIOErrorPlayerIOError type if the chosen provider rejected one or more of the purchase arguments
| InvalidRegistrationData | Constant |
public static const InvalidRegistrationData:PlayerIOErrorPlayerIOError type if the supplied data is incorrect
| ItemNotInVault | Constant |
public static const ItemNotInVault:PlayerIOErrorPlayerIOError type if the item does not exist in the vault.
| KeyAlreadyUsed | Constant |
public static const KeyAlreadyUsed:PlayerIOErrorPlayerIOError type if the key is in use by another database object
| MissingRoomId | Constant |
public static const MissingRoomId:PlayerIOErrorPlayerIOError type if you can't join the room when the RoomID is null or the empty string
| MissingValue | Constant |
public static const MissingValue:PlayerIOErrorPlayerIOError type if a value is missing
| NoServersAvailable | Constant |
public static const NoServersAvailable:PlayerIOErrorPlayerIOError type if there is no server in any of the selected server clusters for the game that are eligible to start a new room in (they're all at full capacity or there are no servers in any of the clusters). Either change the selected clusters for your game in the admin panel, try again later or start some more servers for one of your clusters.
| NotASearchColumn | Constant |
public static const NotASearchColumn:PlayerIOErrorPlayerIOError type if the key you specified is not set as searchable. You can change the searchable keys in the admin panel for the server type
| NotEnoughCoins | Constant |
public static const NotEnoughCoins:PlayerIOErrorPlayerIOError type if the user does not have enough coins in the PayVault to complete the purchase or debit.
| NotObjectCreator | Constant |
public static const NotObjectCreator:PlayerIOErrorPlayerIOError type if the operation was aborted because the user attempting the operation was not the original creator of the object accessed.
| QuickConnectMethodNotEnabled | Constant |
public static const QuickConnectMethodNotEnabled:PlayerIOErrorPlayerIOError type if the QuickConnect method (simple, facebook, kongregate...) is not enabled for the game. You can enable the various methods in the admin panel for the game
| RoomAlreadyExists | Constant |
public static const RoomAlreadyExists:PlayerIOErrorPlayerIOError type if you are unable to create room because there is already a room with the specified id
| RoomDataTooLarge | Constant |
public static const RoomDataTooLarge:PlayerIOErrorPlayerIOError type if the room data for the room was over the allowed size limit
| RoomIsFull | Constant |
public static const RoomIsFull:PlayerIOErrorPlayerIOError type if the room already has the maxmium amount of users in it.
| StaleVersion | Constant |
public static const StaleVersion:PlayerIOErrorPlayerIOError type if bigDB object could not be saved using optimistic locks as it's out of date.
| UnknownConnection | Constant |
public static const UnknownConnection:PlayerIOErrorPlayerIOError type if the connection requested is not known by the server
| UnknownGame | Constant |
public static const UnknownGame:PlayerIOErrorPlayerIOError type if the game requested is not known by the server
| UnknownIndex | Constant |
public static const UnknownIndex:PlayerIOErrorPlayerIOError type if the specified index does not exist.
| UnknownPartnerPayAction | Constant |
public static const UnknownPartnerPayAction:PlayerIOErrorPlayerIOError type if unable to locate the custom PartnerPay action with the given key
| UnknownPayVaultProvider | Constant |
public static const UnknownPayVaultProvider:PlayerIOErrorPlayerIOError type if there is no PayVault provider with the specified id
| UnknownRoom | Constant |
public static const UnknownRoom:PlayerIOErrorPlayerIOError type if there is no room running with that id
| UnknownRoomType | Constant |
public static const UnknownRoomType:PlayerIOErrorPlayerIOError type if the game you're connected to does not have a room type with the specified name
| UnknownTable | Constant |
public static const UnknownTable:PlayerIOErrorPlayerIOError type if the specified table does not exist.
| UnknownUser | Constant |
public static const UnknownUser:PlayerIOErrorPlayerIOError type if the user is unknown
| UnsupportedMethod | Constant |
public static const UnsupportedMethod:PlayerIOErrorPlayerIOError type if the method requested is not supported
| VaultNotLoaded | Constant |
public static const VaultNotLoaded:PlayerIOErrorPlayerIOError type if cannot access coins or items before vault has been loaded. Please refresh the vault first.