iOS
Android
Unity
REST Api
Data objects

The SDK defines a set of objects in which all data are wrapped in order to provide the developer a fast and easy way for using data in his own application.

Note that in a non-ARC project, the developer needs to retain these objects if returned by a protocol method because, internally to the SDK, they are always autoreleased.

BDArenaAchievementData

BDArenaAchievementData is a subclass of NSObject.

following properties are available :

 

achievementId

percentComplete

points

achievementTitle

achievementDescription

achievementImageUrl

 

 

achievementId

 

The unique identifier of the achievement.

 

@property (nonatomicreadonlyassignNSInteger achievementId;

 

Availability

available in SDK ver 1.0 and later.

 

Declared in

BDArenaAchievementData.h

 

 

 

percentComplete

 

The completion percentage of the achievement. This value is in the range from 0 to 100.

 

@property (nonatomicreadonlyassignCGFloat percentComplete;

 

Availability

available in SDK ver 1.0 and later.

 

Declared in

BDArenaAchievementData.h

 

 

 

points

 

The points associated with the achievement. When a player earns the achievement, the points

associated with it are added to the player's global ranking value.

 

@property (nonatomicreadonlyassignNSInteger points;

 

Availability

available in SDK ver 1.0 and later.

 

Declared in

BDArenaAchievementData.h

 

 

 

achievementTitle

 

The achievement's title.

 

@property (nonatomicreadonlyretainNSString* achievementTitle;

 

Availability

available in SDK ver 1.0 and later.

 

Declared in

BDArenaAchievementData.h

 

 

 

achievementDescription

 

The achievement's description.

 

@property (nonatomicreadonlyretainNSString* achievementDescription;

 

Availability

available in SDK ver 1.0 and later.

 

Declared in

BDArenaAchievementData.h

 

 

 

achievementImageUrl

 

The url of the image associated with the achievement.

 

@property (nonatomicreadonlyretainNSString* achievementImageUrl;

 

Availability

available in SDK ver 1.0 and later.

 

Declared in

BDArenaAchievementData.h

BDArenaLeaderboardData

BDArenaLeaderboardData is a subclass of NSObject.

following properties are available :

 

leaderboardId

leaderboardTitle

 

 

leaderboardId

 

The unique identifier of the leaderboard.

 

@property (nonatomicreadonlyassignNSInteger leaderboardId;

 

Availability

available in SDK ver 1.0 and later.

 

Declared in

BDArenaLeaderboardData.h

 

 

 

leaderboardTitle

 

The title of the leaderboard.

 

@property (nonatomicreadonlyretainNSString* leaderboardTitle;

 

Availability

available in SDK ver 1.0 and later.

 

Declared in

BDArenaLeaderboardData.h

BDArenaMatchData

BDArenaMatchData is a subclass of NSObject.

following properties are available :

 

matchId

tableId

tableReferenceName

param

maxPlayers

players

 

 

 

matchId

 

The unique identifier of the match.

 

@property (nonatomicreadonlyassignNSInteger matchId;

 

Availability

available in SDK ver 1.0 and later.

 

Declared in

BDArenaMatchData.h

 

 

 

tableId

 

The unique identifier of the table associated with the match.

 

@property (nonatomicreadonlyretainNSString* tableId;

 

Availability

available in SDK ver 1.0 and later.

 

Declared in

BDArenaMatchData.h

 

 

 

tableReferenceName

 

A custom string associated with the table by the administrator of the appication through the web panel interface.

This string has the main purpose to identify uniquely a specific table within the application.

 

@property (nonatomicreadonlyretainNSString* tableReferenceName; 

 

Availability

available in SDK ver 1.0 and later.

 

Declared in

BDArenaMatchData.h

 

 

 

param

 

A custom string associated with the table by the administrator of the appication through the web panel interface.

This string has the main purpose to provide developer a simple mechanism to bind user defined information to each table available.

 

@property (nonatomicreadonlyretainNSString* param;

 

Availability

available in SDK ver 1.0 and later.

 

Declared in

BDArenaMatchData.h

 

 

 

maxPlayers

 

the number of seats available at the table.

 

@property (nonatomicreadonlyassignNSInteger maxPlayers;

 

Availability

available in SDK ver 1.0 and later.

 

Declared in

BDArenaMatchData.h

 

 

 

players

 

An array of BDArenaPlayerData objects that brings the list of the players participating the match.

 

@property (nonatomicreadonlyretainNSMutableArray* players;

 

Availability

available in SDK ver 1.0 and later.

 

Declared in

BDArenaMatchData.h

BDArenaPlayerData

BDArenaPlayerData is a subclass of NSObject.

following properties are available :

 

auid

accessToken

nickname

email

gender

dateOfBirth

age

avatarImageOriginalUrl

avatarImageThumbUrl

registered

deviceModel

deviceSystemName

deviceSystemVersion

chatAdministrationRoleStatus

chatRoomRestrictionMask

 

 

auid

 

The Arena daemon Unique Id (auid) of the requested player.

 

@property (nonatomicassignNSInteger auid;

 

Availability

available in SDK ver 1.0 and later.

 

Declared in

BDArenaPlayerData.h

 

 

 

accessToken

 

The unique access token associated with the player.

 

@property (nonatomicretainNSString* accessToken;

 

Availability

available in SDK ver 1.0 and later.

 

Declared in

BDArenaPlayerData.h

 

 

 

nickname

 

The nickname of the player.

 

@property (nonatomicretainNSString* nickname;

 

Availability

available in SDK ver 1.0 and later.

 

Declared in

BDArenaPlayerData.h

 

 

 

email

 

The email associated with the player's account. This parameter is never returned

by any of the methods of the BDArenaConnector SDK. This parameter is only used

by the SDK for players registration purposes.

 

@property (nonatomicretainNSString* email;

 

Availability

available in SDK ver 1.0 and later.

 

Declared in

BDArenaPlayerData.h

 

 

 

gender

 

The gender of the player.

 

@property (nonatomicretainNSString* gender;

 

Availability

available in SDK ver 1.0 and later.

 

Declared in

BDArenaPlayerData.h

 

 

 

dateOfBirth

 

The year of birth of the player.

 

@property (nonatomicassignNSInteger dateOfBirth;

 

Availability

available in SDK ver 1.0 and later.

 

Declared in

BDArenaPlayerData.h

 

 

 

age

 

The age of the player.

 

@property (nonatomicassignNSInteger age;

 

Availability

available in SDK ver 1.0 and later.

 

Declared in

BDArenaPlayerData.h

 

 

 

avatarImageOriginalUrl

 

The URL of the avatar image of the player in its original dimensions.

 

@property (nonatomicretainNSString* avatarImageOriginalUrl;

 

Availability

available in SDK ver 1.0 and later.

 

Declared in

BDArenaPlayerData.h

 

 

 

avatarImageThumbUrl

 

The URL of the avatar image of the player in thumbnail version.

 

@property (nonatomic, retain) NSString* avatarImageThumbUrl;

 

Availability

available in SDK ver 1.0 and later.

 

Declared in

BDArenaPlayerData.h

 

 

 

registered

 

A boolean value that indicates if the player is registered or Guest.

 

@property (nonatomicassignBOOL registered;

 

Availability

available in SDK ver 1.0 and later.

 

Declared in

BDArenaPlayerData.h

 

 

 

deviceModel

 

The model of the device through which the player is connected.

 

@property (nonatomicretainNSString* deviceModel;

 

Availability

available in SDK ver 1.0 and later.

 

Declared in

BDArenaPlayerData.h

 

 

 

deviceSystemName

 

The system name of the device through which the player is connected.

 

@property (nonatomicretainNSString* deviceSystemName;

 

Availability

available in SDK ver 1.0 and later.

 

Declared in

BDArenaPlayerData.h

 

 

 

deviceSystemVersion

 

The system version of the device through which the player is connected.

 

@property (nonatomicretainNSString* deviceSystemVersion;

 

Availability

available in SDK ver 1.0 and later.

 

Declared in

BDArenaPlayerData.h

 

 

 

chatAdministrationRoleStatus

 

Specifies if the player has the administrator role for the chat rooms.

 

@property (nonatomic, assign) BDArenaAdministrationRole chatAdministrationRoleStatus;

 

Availability

available in SDK ver 2.6 and later.

 

Declared in

BDArenaPlayerData.h

 

 

 

chatRoomRestrictionMask

 

Specifies the player's restriction mask for a specific chat room.

 

@property (nonatomic, assign) BDArenaRestrictionMask chatRoomRestrictionMask;

 

Availability

available in SDK ver 2.6 and later.

 

Declared in

BDArenaPlayerData.h

BDArenaRoomData

BDArenaRoomData is a subclass of NSObject.

following properties are available :

 

name

numberOfPlayers

param

 

 

 

name

 

The name of the chat room.

 

@property (nonatomic, retain, readonly) NSString* name;

 

Availability

available in SDK ver 1.0 and later.

 

Declared in

BDArenaRoomData.h

 

 

 

numberOfPlayers

 

The number of players present in the chat room.

This value is determined at the time when the developer calls BDArenaChatConnector

to retrieve information about a specific chat room.

 

@property (nonatomic, assign, readonly) NSInteger numberOfPlayers;

 

Availability

available in SDK ver 1.0 and later.

 

Declared in

BDArenaRoomData.h

 

 

 

param

 

A custom string associated with the chat room by the developer at runtime.

This string has the main purpose to provide developer a simple mechanism to bind

user defined information to each active chat room.

 

@property (nonatomic, retain, readonly) NSString* param;

 

Availability

available in SDK ver 1.0 and later.

 

Declared in

BDArenaRoomData.h

BDArenaScoreData

BDArenaScoreData is a subclass of NSObject.

following properties are available :

 

leaderboardId

score

playerData

 

 

 

leaderboardId

 

The unique identifier of the leaderboard.

 

@property (nonatomic, readonly, assign) NSInteger leaderboardId;

 

Availability

available in SDK ver 1.0 and later.

 

Declared in

BDArenaScoreData.h

 

 

 

score

 

The score achieved by the player.

 

@property (nonatomic, readonly, assign) NSInteger score;

 

Availability

available in SDK ver 1.0 and later.

 

Declared in

BDArenaScoreData.h

 

 

 

playerData

 

A BDArenaPlayerData object filled with the player information.

 

@property (nonatomic, readonly, assign) BDArenaPlayerData* playerData;

 

Availability

available in SDK ver 1.0 and later.

 

Declared in

BDArenaScoreData.h

BDArenaTableData

BDArenaTableData is a subclass of NSObject.

following properties are available :

 

tableId

symbolicName

referenceName

maxPlayers

registeredPlayers

alreadyRegistered

param

 

 

 

tableId

 

The unique identifier of the table.

 

@property (nonatomic, readonly, retain) NSString* tableId;

 

Availability

available in SDK ver 1.0 and later.

 

Declared in

BDArenaTableData.h

 

 

 

symbolicName

 

The name of the table. This is an user defined string.

 

@property (nonatomicreadonlyretainNSString* symbolicName;

 

Availability

available in SDK ver 1.0 and later.

 

Declared in

BDArenaTableData.h

 

 

 

referenceName

 

The reference name of the table. This is a string created by the developer through the web

panel interface.

 

@property (nonatomicreadonlyretainNSString* referenceName;

 

Availability

available in SDK ver 1.0 and later.

 

Declared in

BDArenaTableData.h

 

 

 

maxPlayers

 

The number of available seats to the table.

 

@property (nonatomicreadonlyassignNSInteger maxPlayers;

 

Availability

available in SDK ver 1.0 and later.

 

Declared in

BDArenaTableData.h

 

 

 

registeredPlayers

 

The number of players already registered to the table and that are waiting for the match to start.

 

@property (nonatomicreadonlyassignNSInteger registeredPlayers;

 

Availability

available in SDK ver 1.0 and later.

 

Declared in

BDArenaTableData.h

 

 

 

alreadyRegistered

 

A boolean value that indicates if the local player did already register to the table.

 

@property (nonatomicreadonlyassignBOOL alreadyRegistered;

 

Availability

available in SDK ver 1.0 and later.

 

Declared in

BDArenaTableData.h

 

 

 

param

 

A developer defined string that brings information associated with the table.

This string can be set through the web panel interface.

 

@property (nonatomicreadonlyretainNSString* param;

 

Availability

available in SDK ver 1.0 and later.

 

Declared in

BDArenaTableData.h

BDArenaAdClipConfigData

BDArenaAdClipConfigData is a subclass of NSObject.

following properties are available :

 

countdownText

labelPosition

textAlignment

clickThruAlertTitle

clickThruAlertMessage

clickThruAlertCancelButtonTitle

clickThruAlertOpenButtonTitle

 

 

countdownText

 

The text shown within the countdown label.

 

@property (nonatomic, retain) NSString* countdownText;

 

Discussion

Within this string, the developer can use the following placeholders :

    [TIME] : the number of seconds remaining to the end of the clip.

    [PERCENT] : the playback completion percent value.

 

Availability

available in SDK ver 1.7 and later.

 

Discussion

Please note, all macros are case sensitive!

 

Declared in

BDArenaAdClipConfigData.h

 

 

 

labelPosition

 

The position of the countdown label within the ad clip container view.

 

@property (nonatomic, assign) BDArenaAdvAdClipCountdownLabelPosition labelPosition;

 

Availability

available in SDK ver 1.7 and later.

 

Declared in

BDArenaAdClipConfigData.h

 

 

 

textAlignment

 

The alignment of the text into the countdown label.

 

@property (nonatomic, assign) NSTextAlignment textAlignment;

 

Availability

available in SDK ver 1.7 and later.

 

Declared in

BDArenaAdClipConfigData.h

 

 

 

clickThruAlertTitle

 

The title of the alert view that pops up if the player taps the screen

during the ad clip playback.

 

@property (nonatomic, retain) NSString* clickThruAlertTitle;

 

Availability

available in SDK ver 1.7 and later.

 

Declared in

BDArenaAdClipConfigData.h

 

 

 

clickThruAlertMessage

 

The message displayed by alert view that pops up if the player taps the screen

during the ad clip playback.

 

@property (nonatomicretainNSString* clickThruAlertMessage;

 

Availability

available in SDK ver 1.7 and later.

 

Declared in

BDArenaAdClipConfigData.h

 

 

 

clickThruAlertCancelButtonTitle

 

The text for the CANCEL button of the alert view that pops up if the player taps the screen

during the ad clip playback.

 

@property (nonatomic, retain) NSString* clickThruAlertCancelButtonTitle;

 

Availability

available in SDK ver 1.7 and later.

 

Declared in

BDArenaAdClipConfigData.h

 

 

 

clickThruAlertOpenButtonTitle

 

The text for the OPEN button of the alert view that pops up if the player taps the screen

during the ad clip playback.

 

@property (nonatomic, retain) NSString* clickThruAlertOpenButtonTitle;

 

Availability

available in SDK ver 1.7 and later.

 

Declared in

BDArenaAdClipConfigData.h

BDArenaPushData

BDArenaPushData is a subclass of NSObject.

following properties are available :

 

identifier

body

sound

contentAvailable

badge

actionLocKey

locKey

locArgs

launchImage

customParams

 

 

 

identifier

 

An Unique, SDK generated, identification string associated with a notification.

 

@property (nonatomic, readonly, retainNSString* identifier;

 

Availability

available in SDK ver 3.2 and later.

 

Declared in

BDArenaPushData.h

 

 

 

body

 

The basic text message encapsulated into a notification.

 

@property (nonatomicretainNSString* body;

 

Availability

available in SDK ver 3.2 and later.

 

Declared in

BDArenaPushData.h

 

 

 

sound

 

[iOS Only] An optional audio filename to play when the notification reaches the device.

 

@property (nonatomicretainNSString* sound;

 

Availability

available in SDK ver 3.2 and later.

 

Declared in

BDArenaPushData.h

 

 

 

contentAvailable

 

[iOS Only] The 'contentAvailable' native field of an iOS's push notification envelope.

 

@property (nonatomicassignBOOL contentAvailable;

 

Availability

available in SDK ver 3.2 and later.

 

Declared in

BDArenaPushData.h

 

 

 

badge

 

[iOS Only] The value to show on top of the application icon.

 

@property (nonatomicassignNSInteger* badge;

 

Availability

available in SDK ver 3.2 and later.

 

Declared in

BDArenaPushData.h

 

 

 

actionLocKey

 

[iOS Only] The localized key for of the caption of the push notification action button.

 

@property (nonatomicretainNSString* actionLocKey;

 

Availability

available in SDK ver 3.2 and later.

 

Declared in

BDArenaPushData.h

 

 

 

locKey

 

[iOS Only] The localized key for of the text message of the push notification.

 

@property (nonatomicretainNSString* lockey;

 

Availability

available in SDK ver 3.2 and later.

 

Declared in

BDArenaPushData.h

 

 

 

locArgs

 

[iOS Only] An NSMutableArray of keys to be used as localized values within

a localized or parametrized text message for a push notification.

 

@property (nonatomicretainNSMutableArray* locArgs;

 

Availability

available in SDK ver 3.2 and later.

 

Declared in

BDArenaPushData.h

 

 

 

launchImage

 

[iOS Only] An optional image filename to be displayed if the app is launched from

the push notification

 

@property (nonatomic, retain) NSString* avatarImageThumbUrl;

 

Availability

available in SDK ver 3.2 and later.

 

Declared in

BDArenaPushData.h

 

 

 

customParams

 

An optional dictionary of numbers, strings and/or arrays with user defined fields and values.

 

@property (nonatomic, retain) NSDictionary* customParams;

 

Availability

available in SDK ver 3.2 and later.

 

Declared in

BDArenaPushData.h

BDArenaChatHistoryItemData

BDArenaChatHistoryItemData is a subclass of NSObject.

following properties are available :

 

timestamp_utc

type

data

playerData

 

 

 

timestamp_utc

 

The timestamp when the event occurred, in UTC.

 

@property (nonatomic, readonly, assignNSUInteger timestamp_utc;

 

Availability

available in SDK ver 3.4.0 and later.

 

Declared in

BDArenaChatHistoryItemData.h

 

 

 

type

 

The type of the event.

 

@property (nonatomicreadonly, assignBDArenaChatHistoryItemType type;

 

Availability

available in SDK ver 3.4.0 and later.

 

Declared in

BDArenaChatHistoryItemData.h

 

 

 

data

 

Generic object that brings the data associated wth the event.

 

@property (nonatomic, readonly, retainid data;

 

Availability

available in SDK ver 3.4.0 and later.

 

Declared in

BDArenaChatHistoryItemData.h

 

 

 

playerData

 

An BDArenaPlayerData object that brings the information of the player that performed the event.

 

@property (nonatomicreadonly, retain) BDArenaPlayerData playerData;

 

Availability

available in SDK ver 3.4.0 and later.

 

Declared in

BDArenaChatHistoryItemData.h

BDArenaChatHistoryRestrictionUpdateInfo

BDArenaChatHistoryRestrictionUpdateInfo is a subclass of NSObject.

following properties are available :

 

administratorPlayerData

oldRestrictionsMask

newRestrictionsMask

 

 

 

administratorPlayerData

 

An BDArenaPlayerData object that brings the information of the administrator player

that performed the event.

 

@property (nonatomic, readonly, retainBDArenaPlayerData administratorPlayerData;

 

Availability

available in SDK ver 3.4.0 and later.

 

Declared in

BDArenaChatHistoryRestrictionUpdateInfo.h

 

 

 

oldRestrictionsMask

 

The BDArenaRestrictionMask value before the restrictions update.

 

@property (nonatomicreadonly, assignBDArenaRestrictionMask oldRestrictionsMask;

 

Availability

available in SDK ver 3.4.0 and later.

 

Declared in

BDArenaChatHistoryRestrictionUpdateInfo.h

 

 

 

newRestrictionsMask

 

The BDArenaRestrictionMask value after the restrictions update.

 

@property (nonatomic, readonly, assign) BDArenaRestrictionMask newRestrictionsMask;

 

Availability

available in SDK ver 3.4.0 and later.

 

Declared in

BDArenaChatHistoryRestrictionUpdateInfo.h