PlayerIO

The fastest way to build online games without breaking a sweat.

Objective-C Client Reference

Multiplayer  class documentationClass PIOErrorCodes

Language: Objective-C

The error codes used by PIOError objects

Methods

 
+ (PIOErrorCode)
AccessDenied
Access is denied
+ (PIOErrorCode)
AchievementsNotLoaded
Cannot access achievements before Refresh() has been called.
+ (PIOErrorCode)
AdTrackCheckCookie
Check cookie required.
+ (PIOErrorCode)
ArgumentOutOfRange
The given argument value is outside the range of allowed values.
+ (PIOErrorCode)
BigDBObjectDoesNotExist
Could not locate the database object.
+ (PIOErrorCode)
BigDBObjectTooLarge
The object exceeds the maximum allowed size for BigDB objects.
+ (PIOErrorCode)
BuyingCoinsNotSupportedByProvider
The specified PayVault provider does not support buying coins
+ (PIOErrorCode)
CircularReference
Cannot create circular references inside database objects
+ (PIOErrorCode)
DialogClosed
The dialog was closed by the user
+ (PIOErrorCode)
DirectPurchaseNotSupportedByProvider
The specified PayVault provider does not support direct purchase
+ (PIOErrorCode)
ExternalError
An error occurred while contacting an external service
+ (PIOErrorCode)
GameDisabled
The game has been disabled, most likely because of missing payment.
+ (PIOErrorCode)
GameRequestsNotLoaded
Cannot access requests before Refresh() has been called.
+ (PIOErrorCode)
GameRequired
A game is required to do this action
+ (PIOErrorCode)
GeneralError
A general error occurred
+ (PIOErrorCode)
HeartbeatFailed
The server could not complete the heartbeat
+ (PIOErrorCode)
IndexOutOfBounds
The index was out of bounds from the range of acceptable values
+ (PIOErrorCode)
InternalError
An unexpected error occurred inside the Player.IO webservice. Please try again.
+ (PIOErrorCode)
InvalidArgument
The given argument did not have the expected value
+ (PIOErrorCode)
InvalidAuth
The auth given is invalid or malformatted
+ (PIOErrorCode)
InvalidBigDBKey
The key given for the BigDB object is not a valid BigDB key. Keys must be between 1 and 50 characters. Only letters, numbers, hyphens, underbars, and spaces are allowed.
+ (PIOErrorCode)
InvalidGameCode
The game code is invalid
+ (PIOErrorCode)
InvalidIdentifier
The given identifier does not match the expected format
+ (PIOErrorCode)
InvalidIndexValue
The value given for the index, does not match the expected type.
+ (PIOErrorCode)
InvalidMessageFormat
The message is malformatted
+ (PIOErrorCode)
InvalidNotificationsEndpoint
The given notifications endpoint is invalid
+ (PIOErrorCode)
InvalidPassword
The password supplied is incorrect
+ (PIOErrorCode)
InvalidPayVaultProviderSetup
The chosen provider is not configured correctly in the admin panel
+ (PIOErrorCode)
InvalidPurchaseArguments
The chosen provider rejected one or more of the purchase arguments
+ (PIOErrorCode)
InvalidRegistrationData
The supplied data is incorrect
+ (PIOErrorCode)
InvalidSegment
The given segment was invalid.
+ (PIOErrorCode)
InvalidType
The given type was invalid
+ (PIOErrorCode)
ItemNotInVault
The item does not exist in the vault.
+ (PIOErrorCode)
KeyAlreadyUsed
The key is in use by another database object
+ (PIOErrorCode)
LoggedOut
This client has been logged out
+ (PIOErrorCode)
MissingRoomId
You can't join the room when the RoomID is null or the empty string
+ (PIOErrorCode)
MissingValue
A value is missing
+ (PIOErrorCode)
NetworkIssue
There is an issue with the network
+ (PIOErrorCode)
NoServersAvailable
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.
+ (PIOErrorCode)
NotASearchColumn
The key you specified is not set as searchable. You can change the searchable keys in the admin panel for the server type
+ (PIOErrorCode)
NotEnoughCoins
The user does not have enough coins in the PayVault to complete the purchase or debit.
+ (PIOErrorCode)
NotificationsNotLoaded
Cannot access notification endpoints before Refresh() has been called.
+ (PIOErrorCode)
NotObjectCreator
The operation was aborted because the user attempting the operation was not the original creator of the object accessed.
+ (PIOErrorCode)
OneScoreNotLoaded
Cannot access OneScore before Refresh() has been called.
+ (PIOErrorCode)
QuickConnectMethodNotEnabled
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
+ (PIOErrorCode)
RoomAlreadyExists
You are unable to create room because there is already a room with the specified id
+ (PIOErrorCode)
RoomDataTooLarge
The room data for the room was over the allowed size limit
+ (PIOErrorCode)
RoomIsFull
The room already has the maxmium amount of users in it.
+ (PIOErrorCode)
StaleVersion
BigDB object could not be saved using optimistic locks as it's out of date.
+ (PIOErrorCode)
UnknownAchievement
Cannot find the achievement with the specified id.
+ (PIOErrorCode)
UnknownConnection
The connection requested is not known by the server
+ (PIOErrorCode)
UnknownGame
The game requested is not known by the server
+ (PIOErrorCode)
UnknownIndex
The specified index does not exist.
+ (PIOErrorCode)
UnknownPartnerPayAction
Unable to locate the custom PartnerPay action with the given key
+ (PIOErrorCode)
UnknownPayVaultProvider
There is no PayVault provider with the specified id
+ (PIOErrorCode)
UnknownRoom
There is no room running with that id
+ (PIOErrorCode)
UnknownRoomType
The game you're connected to does not have a room type with the specified name
+ (PIOErrorCode)
UnknownTable
The specified table does not exist.
+ (PIOErrorCode)
UnknownUser
The user is unknown
+ (PIOErrorCode)
UnsupportedMethod
The method requested is not supported
+ (PIOErrorCode)
VaultNotLoaded
Cannot access coins or items before vault has been loaded. Please refresh the vault first.
+ (PIOErrorCode)
YahooNotAvailable
The Yahoo features are only avaliable when authenticated to PlayerIO using Yahoo authentication. Authentication methods are managed in the connections setting of your game in the admin panel on PlayerIO.
+ (PIOErrorCode)
YahooNotLoaded
Cannot access profile, friends, ignored before Yahoo has been loaded. Please refresh Yahoo first.

AccessDenied

Access is denied

Return Value

PIOErrorCode

AchievementsNotLoaded

Cannot access achievements before Refresh() has been called.

Return Value

PIOErrorCode

AdTrackCheckCookie

Check cookie required.

Return Value

PIOErrorCode

ArgumentOutOfRange

The given argument value is outside the range of allowed values.

Return Value

PIOErrorCode

BigDBObjectDoesNotExist

Could not locate the database object.

Return Value

PIOErrorCode

BigDBObjectTooLarge

The object exceeds the maximum allowed size for BigDB objects.

Return Value

PIOErrorCode

BuyingCoinsNotSupportedByProvider

The specified PayVault provider does not support buying coins

Return Value

PIOErrorCode

CircularReference

Cannot create circular references inside database objects

Return Value

PIOErrorCode

DialogClosed

The dialog was closed by the user

Return Value

PIOErrorCode

DirectPurchaseNotSupportedByProvider

The specified PayVault provider does not support direct purchase

Return Value

PIOErrorCode

ExternalError

An error occurred while contacting an external service

Return Value

PIOErrorCode

GameDisabled

The game has been disabled, most likely because of missing payment.

Return Value

PIOErrorCode

GameRequestsNotLoaded

Cannot access requests before Refresh() has been called.

Return Value

PIOErrorCode

GameRequired

A game is required to do this action

Return Value

PIOErrorCode

GeneralError

A general error occurred

Return Value

PIOErrorCode

HeartbeatFailed

The server could not complete the heartbeat

Return Value

PIOErrorCode

IndexOutOfBounds

The index was out of bounds from the range of acceptable values

Return Value

PIOErrorCode

InternalError

An unexpected error occurred inside the Player.IO webservice. Please try again.

Return Value

PIOErrorCode

InvalidArgument

The given argument did not have the expected value

Return Value

PIOErrorCode

InvalidAuth

The auth given is invalid or malformatted

Return Value

PIOErrorCode

InvalidBigDBKey

The key given for the BigDB object is not a valid BigDB key. Keys must be between 1 and 50 characters. Only letters, numbers, hyphens, underbars, and spaces are allowed.

Return Value

PIOErrorCode

InvalidGameCode

The game code is invalid

Return Value

PIOErrorCode

InvalidIdentifier

The given identifier does not match the expected format

Return Value

PIOErrorCode

InvalidIndexValue

The value given for the index, does not match the expected type.

Return Value

PIOErrorCode

InvalidMessageFormat

The message is malformatted

Return Value

PIOErrorCode

InvalidNotificationsEndpoint

The given notifications endpoint is invalid

Return Value

PIOErrorCode

InvalidPassword

The password supplied is incorrect

Return Value

PIOErrorCode

InvalidPayVaultProviderSetup

The chosen provider is not configured correctly in the admin panel

Return Value

PIOErrorCode

InvalidPurchaseArguments

The chosen provider rejected one or more of the purchase arguments

Return Value

PIOErrorCode

InvalidRegistrationData

The supplied data is incorrect

Return Value

PIOErrorCode

InvalidSegment

The given segment was invalid.

Return Value

PIOErrorCode

InvalidType

The given type was invalid

Return Value

PIOErrorCode

ItemNotInVault

The item does not exist in the vault.

Return Value

PIOErrorCode

KeyAlreadyUsed

The key is in use by another database object

Return Value

PIOErrorCode

LoggedOut

This client has been logged out

Return Value

PIOErrorCode

MissingRoomId

You can't join the room when the RoomID is null or the empty string

Return Value

PIOErrorCode

MissingValue

A value is missing

Return Value

PIOErrorCode

NetworkIssue

There is an issue with the network

Return Value

PIOErrorCode

NoServersAvailable

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.

Return Value

PIOErrorCode

NotASearchColumn

The key you specified is not set as searchable. You can change the searchable keys in the admin panel for the server type

Return Value

PIOErrorCode

NotEnoughCoins

The user does not have enough coins in the PayVault to complete the purchase or debit.

Return Value

PIOErrorCode

NotificationsNotLoaded

Cannot access notification endpoints before Refresh() has been called.

Return Value

PIOErrorCode

NotObjectCreator

The operation was aborted because the user attempting the operation was not the original creator of the object accessed.

Return Value

PIOErrorCode

OneScoreNotLoaded

Cannot access OneScore before Refresh() has been called.

Return Value

PIOErrorCode

QuickConnectMethodNotEnabled

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

Return Value

PIOErrorCode

RoomAlreadyExists

You are unable to create room because there is already a room with the specified id

Return Value

PIOErrorCode

RoomDataTooLarge

The room data for the room was over the allowed size limit

Return Value

PIOErrorCode

RoomIsFull

The room already has the maxmium amount of users in it.

Return Value

PIOErrorCode

StaleVersion

BigDB object could not be saved using optimistic locks as it's out of date.

Return Value

PIOErrorCode

UnknownAchievement

Cannot find the achievement with the specified id.

Return Value

PIOErrorCode

UnknownConnection

The connection requested is not known by the server

Return Value

PIOErrorCode

UnknownGame

The game requested is not known by the server

Return Value

PIOErrorCode

UnknownIndex

The specified index does not exist.

Return Value

PIOErrorCode

UnknownPartnerPayAction

Unable to locate the custom PartnerPay action with the given key

Return Value

PIOErrorCode

UnknownPayVaultProvider

There is no PayVault provider with the specified id

Return Value

PIOErrorCode

UnknownRoom

There is no room running with that id

Return Value

PIOErrorCode

UnknownRoomType

The game you're connected to does not have a room type with the specified name

Return Value

PIOErrorCode

UnknownTable

The specified table does not exist.

Return Value

PIOErrorCode

UnknownUser

The user is unknown

Return Value

PIOErrorCode

UnsupportedMethod

The method requested is not supported

Return Value

PIOErrorCode

VaultNotLoaded

Cannot access coins or items before vault has been loaded. Please refresh the vault first.

Return Value

PIOErrorCode

YahooNotAvailable

The Yahoo features are only avaliable when authenticated to PlayerIO using Yahoo authentication. Authentication methods are managed in the connections setting of your game in the admin panel on PlayerIO.

Return Value

PIOErrorCode

YahooNotLoaded

Cannot access profile, friends, ignored before Yahoo has been loaded. Please refresh Yahoo first.

Return Value

PIOErrorCode