iOS
Android
Unity
REST Api
BDArenaChatConnectorDelegate

Availability : ver 1.0 and later

Declared in : BDArenaChatConnectorDelegate.h

Sample code : -

Overview

The delegates of the BDArenaConnector object must adopt the BDArenaChatConnectorDelegate protocol in order to be notified about chat module's events. Optional methods of the protocol allow the delegates to manage the creation of the chat rooms, the joining and the leaving of the players in and out the chat rooms, the exchange of public and private messages between players.

Tasks

Error handling

- arenaChat:requestDidFail:

 

Connection to daemon management

- arenaChatConnectionDidClose

- arenaChatConnectionEstabilished

- arenaChatConnectionFailedWithError:

 

Joining and leaving chat rooms

- arenaChat:roomJoined:numberOfPlayers:playersList:

- arenaChat:roomJoined:numberOfPlayers:playersList:
        localPlayerAdministrationRoleStatus:localPlayerRestrictionMask:

- arenaChat:joinRoom:didFailWithError:

- arenaChat:roomLeft:

- arenaChat:roomAlreadyJoined:

- arenaChat:player:joinedRoom:

- arenaChat:player:leftRoom:

 

Handling messages between players

- arenaChat:messageSuccessfullySentInRoom:

- arenaChat:messageSuccessfullySentToPlayerWithAuid:

- arenaChat:messageFailedToSendBecauseLocalPlayerIsRestrictedInRoom:

- arenaChat:messageFailedToSendBecauseLocalPlayerIsIgnoredByPlayerWithAuid:

- arenaChat:newMessageReceived:inRoom:fromPlayer:

- arenaChat:newPrivateMessageReceived:fromPlayer:

 

Retrieving information about chat rooms

- arenaChat:roomsListReceived:

- arenaChat:roomsList:receivedForPlayerWithAuid:

- arenaChat:playersList:receivedForRoom:

- arenaChat:numberOfPlayers:inRoom:

- arenaChat:numberOfPlayersGlobal:

 

Moderation : block/unblock of remote players messages

- arenaChat:startIgnoringMessageDidSucceedForPlayerWithAuid:

- arenaChat:startIgnoringMessageAlreadySetForPlayerWithAuid:

- arenaChat:startIgnoringMessageFromPlayerWithAuid:didFailWithError:

- arenaChat:endIgnoringMessageDidSucceedForPlayerWithAuid:

- arenaChat:endIgnoringMessageAlreadySetForPlayerWithAuid:

- arenaChat:endIgnoringMessageFromPlayerWithAuid:didFailWithError:

- arenaChat:ignoredPlayersListReceived:

 

Administration : restrict/unrestric players in rooms

- arenaChat:restrictionMask:successfullyUpdatedToMask:forPlayerWithAuid:inRoom:

- arenaChat:restrictionMask:alreadySetForPlayerWithAuid:inRoom:

- arenaChat:restrictionMask:forPlayerWithAuid:inRoom:didFailWithError:

- arenaChat:restrictionMask:receivedForPlayerWithAuid:forRoom:

- arenaChat:restrictionsReceivedForRoomsGlobal:

 

History management

- arenaChat:historySuccessfullyReceivedWithData:forRoom:withFilterMask:
- arenaChat:historyFailedToReceiveForRoom:withError:
- arenaChat:historySuccessfullyClearedForRoom:
- arenaChat:historyFailedToClearForRoom:withError:
- arenaChat:historyPrivateSuccessfullyReceivedWithData:forPlayerWithAuid:withFilterMask:
- arenaChat:historyPrivateFailedToReceiveForPlayerWithAuid:withError:
- arenaChat:historyPrivateSuccessfullyClearedForPlayerWithAuid:
- arenaChat:historyPrivateFailedToClearForPlayerWithAuid:withError:

 

Asynchronous notifications 

- arenaChat:status:receivedForPlayerWithAuid:

- arenaChatLocalPlayerDidLoginFromDifferentDevice

- arenaChat:notificationStartIgnoringMessagesReceivedFromPlayer:

- arenaChat:notificationEndIgnoringMessagesReceivedFromPlayer:

- arenaChat:notificationRestrictionMask:successfullyUpdatedToMask:
        forLocalPlayerByAdministrator:inRoom:

- arenaChat:notificationRestrictionMask:successfullyUpdatedToMask:
        forPlayer:byAdministrator:inRoom:

- arenaChat:notificationLocalPlayerDidUpdateInfo:
        administrationRoleStatus:

- arenaChat:notificationRemotePlayerDidUpdateInfo:fromInfo:

 

 

 


 

 

 

arenaChat:requestDidFail:

 

Notifies to the developers about failure events.

 

- (void) arenaChat:(BDArenaChatConnector*)connector requestDidFail:(NSError*)error;

 

Parameters

connector

    The unique instance of BDArenaChatConnector.

error

    An NSError object containing the specific error that occurred.

    For more information about errors, check out the Errors Map section.

 

Discussion

This notification is called whenever a method call fails for unpredictable circumstances

(such as network connection failures or issues related to the device). 

 

Availability

available in SDK ver 1.0 and later

 

Declared in

BDArenaChatConnectorDelegate.h

 

 

 

arenaChatConnectionDidClose

 

Informs that the connection to the chat daemon has been closed.

 

- (void) arenaChatConnectionDidClose;

 

Availability

available in SDK ver 1.0 and later

 

Declared in

BDArenaChatConnectorDelegate.h

 

 

 

arenaChatConnectionEstabilished

 

Informs that the connection to the chat daemon has been successfully estabilished.

 

- (void) arenaChatConnectionEstabilished;

 

Availability

available in SDK ver 1.0 and later

 

Declared in

BDArenaChatConnectorDelegate.h

 

 

 

arenaChatConnectionFailedWithError:

 

Informs that some error occurred while trying to connect to the chat daemon.

 

- (void) arenaChatConnectionFailedWithError:(NSError*)error;

 

Parameters

error

    An NSError object containing the specific error that occurred.

    For more information about errors, check out the Errors Map section.

 

Availability

available in SDK ver 1.0 and later

 

Declared in

BDArenaChatConnectorDelegate.h

 

 

 

arenaChat:roomJoined:numberOfPlayers:playersList:

 

Informs that the local player successfully joined a specific chat room.

 

- (void) arenaChat:(BDArenaChatConnector*)connector

        roomJoined:(NSString*)roomName

        numberOfPlayers:(NSInteger)numberOfPlayers

        playersList:(NSArray*)players;

 

Parameters

connector

    The unique instance of BDArenaChatConnector.

roomName

    An user defined string containing the room name.

numberOfPlayers

    An integer expressing the number of players already present in the joined room.

players

    An array of BDArenaPlayerData objects representing the players present into the room.

 

Availability

available in SDK ver 1.0 and later

 

Declared in

BDArenaChatConnectorDelegate.h

 

 

 

arenaChat:roomJoined:numberOfPlayers:playersList:

    localPlayerAdministrationRoleStatus:localPlayerRestrictionMask:

 

Informs that the local player successfully joined a specific chat room.

 

- (void) arenaChat:(BDArenaChatConnector*)connector

        roomJoined:(NSString*)roomName

        numberOfPlayers:(NSInteger)numberOfPlayers

        playersList:(NSArray*)players

        localPlayerAdministrationRoleStatus:(BDArenaAdministrationRole)administrationRole

        localPlayerRestrictionMask:(BDArenaRestrictionMask)restrictionMask;

 

Parameters

connector

    The unique instance of BDArenaChatConnector.

roomName

    An user defined string containing the room name.

numberOfPlayers

    An integer expressing the number of players already present in the joined room.

players

    An array of BDArenaPlayerData objects representing the players present into the room.

administrationRole

    An BDArenaAdministrationRole value indicating the administration role

    of the local player for the joined room.

restrictionMask

    An BDArenaRestrictionMask value indicating the restrictions

    applied to the local player in the joined room.

 

Availability

available in SDK ver 2.8.0 and later

 

Declared in

BDArenaChatConnectorDelegate.h 

 

 

 

arenaChat:joinRoom:didFailWithError:

 

Informs that the local player did fail to joined a specific chat room.

 

- (void) arenaChat:(BDArenaChatConnector*)connector

        joinRoom:(NSString*)roomName

        didFailWithError:(NSError*)error; 

 

Parameters

connector

    The unique instance of BDArenaChatConnector.

roomName

    An user defined string containing the room name.

error

    An NSError object containing the specific error that occurred.

    For more information about errors, check out the Errors Map section.

 

Availability

available in SDK ver 2.6 and later

 

Declared in

BDArenaChatConnectorDelegate.h

 

 

 

arenaChat:roomLeft:

 

Informs that the local player successfully left a specific chat room.

 

- (void) arenaChat:(BDArenaChatConnector*)connector roomLeft:(NSString*)roomName;

 

Parameters

connector

    The unique instance of BDArenaChatConnector.

roomName

    An user defined string containing the room name.

 

Availability

available in SDK ver 1.0 and later

 

Declared in

BDArenaChatConnectorDelegate.h

 

 

 

arenaChat:roomAlreadyJoined:

 

Informs that the local player tried to join a room in which he is already present.

 

- (void) arenaChat:(BDArenaChatConnector*)connector roomAlreadyJoined:(NSString*)roomName;

 

Parameters

connector

    The unique instance of BDArenaChatConnector.

roomName

    An user defined string containing the room name.

 

Discussion

This event is notified when the local player tries to join a room in which he is already present.

 

Availability

available in SDK ver 1.0 and later

 

Declared in

BDArenaChatConnectorDelegate.h

 

 

 

arenaChat:player:joinedRoom:

 

Asynchronously informs that a remote player joined a specific chat room.

 

- (void) arenaChat:(BDArenaChatConnector*)connector

        player:(BDArenaPlayerData*)playerData

        joinedRoom:(NSString*)roomName;

 

Parameters

connector

    The unique instance of BDArenaChatConnector.

playerData

    A BDArenaPlayerData object filled with the remote player information.

roomName

    An user defined string containing the room name.

 

Discussion

This event is notified to the local player only if the remote player joined a chat room

in which the local player is present.

 

Availability

available in SDK ver 1.0 and later

 

Declared in

BDArenaChatConnectorDelegate.h

 

 

 

arenaChat:player:leftRoom:

 

Asynchronously informs that a remote player left a specific chat room.

 

- (void) arenaChat:(BDArenaChatConnector*)connector

        player:(BDArenaPlayerData*)playerData

        leftRoom:(NSString*)roomName; 

 

Parameters

connector

    The unique instance of BDArenaChatConnector.

playerData

    A BDArenaPlayerData object filled with the remote player information.

roomName

    An user defined string containing the room name.

 

Discussion

This event is notified to the local player only if the remote player left a chat room

in which the local player is present.

 

Availability

available in SDK ver 1.0 and later

 

Declared in

BDArenaChatConnectorDelegate.h

 

 

 

arenaChat:messageSuccessfullySentInRoom:

 

Informs that the local player successfully sent a public message in a specific chat room.

 

- (void) arenaChat:(BDArenaChatConnector*)connector

        messageSuccessfullySentInRoom:(NSString*)roomName;

 

Parameters

connector

    The unique instance of BDArenaChatConnector.

roomName

    An user defined string containing the room name.

 

Discussion

The messages sent in a chat room are public and they are received by every player present

in the chat room recipient of the message.

 

Availability

available in SDK ver 1.0 and later

 

Declared in

BDArenaChatConnectorDelegate.h

 

 

 

arenaChat:messageSuccessfullySentToPlayerWithAuid:

 

Informs that the local player successfully sent a private message to a specific player.

 

- (void) arenaChat:(BDArenaChatConnector*)connector

        messageSuccessfullySentToPlayerWithAuid:(NSInteger)destinationAuid;

 

Parameters

connector

    The unique instance of BDArenaChatConnector.

destinationAuid

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

 

Discussion

The messages sent to a specific player are private and they are received only by

the recipient remote player.

In order to exchange private messages, the players are not required to be in the same chat room.

 

Availability

available in SDK ver 1.0 and later

 

Declared in

BDArenaChatConnectorDelegate.h

 

 

 

arenaChat:messageFailedToSendBecauseLocalPlayerIsRestrictedInRoom:

 

Informs that the message cannot be delivered because the local player

has been restricted by an administrator in the chat room.

 

- (void) arenaChat:(BDArenaChatConnector*)connector

        messageFailedToSendBecauseLocalPlayerIsRestrictedInRoom:(NSString*)roomName;

 

Parameters

connector

    The unique instance of BDArenaChatConnector.

roomName

    An user defined string containing the room name.

 

Discussion

This event is fired only if the local player tries to send a message in a chat room in which

he has been restricted (probably Unvoiced).

 

Availability

available in SDK ver 2.6 and later

 

Declared in

BDArenaChatConnectorDelegate.h

 

 

 

arenaChat:messageFailedToSendBecauseLocalPlayerIsIgnoredByPlayerWithAuid:

 

Informs that the message cannot be delivered because the local player

is currently ignored by the recipient player.

 

- (void) arenaChat:(BDArenaChatConnector*)connector

        messageFailedToSendBecauseLocalPlayerIsIgnoredByPlayerWithAuid:(NSInteger)destinationAuid;

 

Parameters

connector

    The unique instance of BDArenaChatConnector.

destinationAuid

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

 

Discussion

This event is fired only if the local player tries to send a private message to the recipient.

 

Availability

available in SDK ver 2.5 and later

 

Declared in

BDArenaChatConnectorDelegate.h

 

 

 

arenaChat:newMessageReceived:inRoom:fromPlayer:

 

Informs that a new public message, sent by a specific player, has been received in a specific chat room.

 

- (void) arenaChat:(BDArenaChatConnector*)connector

        newMessageReceived:(NSString*)message

        inRoom:(NSString*)roomName

        fromPlayer:(BDArenaPlayerData*)playerData;

 

Parameters

connector

    The unique instance of BDArenaChatConnector.

message

    The string containing the message.

roomName

    An user defined string containing the room name.

playerData

    A BDArenaPlayerData object filled with the remote player information.

 

Discussion

This event is notified to the local player only if the remote player sent the message

in a chat room in which the local player is present.

 

Availability

available in SDK ver 1.0 and later

 

Declared in

BDArenaChatConnectorDelegate.h

 

 

 

arenaChat:newPrivateMessageReceived:fromPlayer:

 

Informs that a new private message, sent by a specific player, has been received by the local player.

 

- (void) arenaChat:(BDArenaChatConnector*)connector

        newPrivateMessageReceived:(NSString*)message

        fromPlayer:(BDArenaPlayerData*)playerData;

 

Parameters

connector

    The unique instance of BDArenaChatConnector.

message

    The string containing the message.

playerData

    A BDArenaPlayerData object filled with the remote player information.

 

Availability

available in SDK ver 1.0 and later

 

Declared in

BDArenaChatConnectorDelegate.h

 

 

 

arenaChat:roomsListReceived:

 

Retrieves the list of the active chat rooms.

 

- (void) arenaChat:(BDArenaChatConnector*)connector roomsListReceived:(NSArray*)roomsArray;

 

Parameters

connector

    The unique instance of BDArenaChatConnector.

roomsArray

    The list of objects containing the rooms info.

 

Availability

available in SDK ver 1.0 and later

 

Declared in

BDArenaChatConnectorDelegate.h

 

 

 

arenaChat:roomsList:receivedForPlayerWithAuid:

 

Retrieves the list of the chat rooms in which a specific player is present.

 

- (void) arenaChat:(BDArenaChatConnector*)connector

        roomsList:(NSArray*)roomsArray

        receivedForPlayerWithAuid:(NSInteger)auid;

 

Parameters

connector

    The unique instance of BDArenaChatConnector.

roomsArray

    The list of objects containing the rooms info.

auid

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

 

Availability

available in SDK ver 1.0 and later

 

Declared in

BDArenaChatConnectorDelegate.h

 

 

 

arenaChat:playersList:receivedForRoom:

 

Retrieves the list of the players present in a specific chat room.

 

- (void) arenaChat:(BDArenaChatConnector*)connector

        playersList:(NSArray*)players

        receivedForRoom:(NSString*)roomName;

 

Parameters

connector

    The unique instance of BDArenaChatConnector.

players

    An array of BDArenaPlayerData objects representing the players present into the room.

roomName

    The name of the room for which the list was requested.

 

Availability

available in SDK ver 1.0 and later

 

Declared in

BDArenaChatConnectorDelegate.h

 

 

 

arenaChat:numberOfPlayers:inRoom:

 

Retrieves the number of players present in a specific chat room.

 

- (void) arenaChat:(BDArenaChatConnector*)connector

        numberOfPlayers:(NSInteger)count

        inRoom:(NSString*)roomName;

 

Parameters

connector

    The unique instance of BDArenaChatConnector.

count

    The number of players present in the requested chat room.

roomName

    An user defined string containing the room name.

 

Availability

available in SDK ver 1.0 and later

 

Declared in

BDArenaChatConnectorDelegate.h

 

 

 

arenaChat:numberOfPlayersGlobal:

 

Retrieves the total number of players connected to the chat daemon.

 

- (void) arenaChat:(BDArenaChatConnector*)connector

        numberOfPlayersGlobal:(NSInteger)count;

 

Parameters

connector

    The unique instance of BDArenaChatConnector.

count

    The total number of players connected to the chat daemon.

 

Availability

available in SDK ver 1.0 and later

 

Declared in

BDArenaChatConnectorDelegate.h

 

 

 

arenaChat:startIgnoringMessageDidSucceedForPlayerWithAuid:

 

Informs that all incoming messages sent by a specific player will be ignored.

 

- (void) arenaChat:(BDArenaChatConnector*)connector

        startIgnoringMessageDidSucceedForPlayerWithAuid:(NSInteger)auid;

 

Parameters

connector

    The unique instance of BDArenaChatConnector.

auid

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

 

Availability

available in SDK ver 2.5 and later

 

Declared in

BDArenaChatConnectorDelegate.h

 

 

 

arenaChat:startIgnoringMessageAlreadySetForPlayerWithAuid:

 

Informs that all incoming messages sent by a specific player are already ignored.

 

- (void) arenaChat:(BDArenaChatConnector*)connector

        startIgnoringMessageAlreadySetForPlayerWithAuid:(NSInteger)auid;

 

Parameters

connector

    The unique instance of BDArenaChatConnector.

auid

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

 

Availability

available in SDK ver 2.5 and later

 

Declared in

BDArenaChatConnectorDelegate.h

 

 

 

arenaChat:startIgnoringMessageFromPlayerWithAuid:didFailWithError:

 

Informs that some error occurred while trying to start to ignore incoming messages

sent by a specific player.

 

- (void) arenaChat:(BDArenaChatConnector*)connector

        startIgnoringMessageFromPlayerWithAuid:(NSInteger)auid 

        didFailWithError:(NSError*)error;

 

Parameters

connector

    The unique instance of BDArenaChatConnector.

auid

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

error

    An NSError object containing the specific error that occurred.

    For more information about errors, check out the Errors Map section.

 

Availability

available in SDK ver 2.5 and later

 

Declared in

BDArenaChatConnectorDelegate.h

 

 

 

arenaChat:endIgnoringMessageDidSucceedForPlayerWithAuid:

 

Informs that all incoming messages sent by a specific player will be accepted.

 

- (void) arenaChat:(BDArenaChatConnector*)connector

        endIgnoringMessageDidSucceedForPlayerWithAuid:(NSInteger)auid;

 

Parameters

connector

    The unique instance of BDArenaChatConnector.

auid

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

 

Availability

available in SDK ver 2.5 and later

 

Declared in

BDArenaChatConnectorDelegate.h

 

 

 

arenaChat:endIgnoringMessageAlreadySetForPlayerWithAuid:

 

Informs that all incoming messages sent by a specific player are already accepted.

 

- (void) arenaChat:(BDArenaChatConnector*)connector

        endIgnoringMessageAlreadySetForPlayerWithAuid:(NSInteger)auid;

 

Parameters

connector

    The unique instance of BDArenaChatConnector.

auid

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

 

Availability

available in SDK ver 2.5 and later

 

Declared in

BDArenaChatConnectorDelegate.h

 

 

 

arenaChat:endIgnoringMessageFromPlayerWithAuid:didFailWithError:

 

Informs that some error occurred while trying to start to accept incoming messages

sent by a specific player.

 

- (void) arenaChat:(BDArenaChatConnector*)connector

        endIgnoringMessageFromPlayerWithAuid:(NSInteger)auid 

        didFailWithError:(NSError*)error;

 

Parameters

connector

    The unique instance of BDArenaChatConnector.

auid

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

error

    An NSError object containing the specific error that occurred.

    For more information about errors, check out the Errors Map section.

 

Availability

available in SDK ver 2.5 and later

 

Declared in

BDArenaChatConnectorDelegate.h

 

 

 

arenaChat:ignoredPlayersListReceived:

 

The list of the players ignored by the local player has been successfully retrieved.

 

- (void) arenaChat:(BDArenaChatConnector*)connector

        ignoredPlayersListReceived:(NSArray*)ignoredPlayersList;

 

Parameters

connector

    The unique instance of BDArenaChatConnector.

ignoredPlayersList

    An array of BDArenaPlayerData objects representing the players ignored by the local player.

 

Availability

available in SDK ver 2.5 and later

 

Declared in

BDArenaChatConnectorDelegate.h

 

 

 

arenaChat:restrictionMask:successfullyUpdatedToMask:forPlayerWithAuid:inRoom:

 

Informs that the restriction mask for a specific player in a specific room

has been updated by the local player.

 

- (void) arenaChat:(BDArenaChatConnector*)connector

        restrictionMask:(BDArenaRestrictionMask)oldRestrictionMask

        successfullyUpdatedToMask:(BDArenaRestrictionMask)newRestrictionMask

        forPlayerWithAuid:(NSInteger)auid

        inRoom:(NSString*)roomName;

 

Parameters

connector

    The unique instance of BDArenaChatConnector.

oldRestrictionMask

    The previoulsy set restriction map for the target player.

newRestrictionMask

    The new restriction map set for the target player.

auid

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

roomName

    The name of the chat room in which the restriction has effect for the target player.

 

Availability

available in SDK ver 2.6 and later

 

Declared in

BDArenaChatConnectorDelegate.h

 

 

 

arenaChat:restrictionMask:alreadySetForPlayerWithAuid:inRoom:

 

Informs that the restriction mask for a specific player in a specific room

is already set to the specified mask value.

 

- (void) arenaChat:(BDArenaChatConnector*)connector

        restrictionMask:(BDArenaRestrictionMask)restrictionMask

        alreadySetForPlayerWithAuid:(NSInteger)auid

        inRoom:(NSString*)roomName;

 

Parameters

connector

    The unique instance of BDArenaChatConnector.

restrictionMask

    The restriction map for the target player.

auid

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

roomName

    The name of the chat room in which the restriction has effect for the target player.

 

Availability

available in SDK ver 2.6 and later

 

Declared in

BDArenaChatConnectorDelegate.h

 

 

 

arenaChat:restrictionMask:forPlayerWithAuid:inRoom:didFailWithError:

 

Informs that an error occurred while trying to set a restriction mask

for a specific player in a specific room.

 

- (void) arenaChat:(BDArenaChatConnector*)connector

        restrictionMask:(BDArenaRestrictionMask)restrictionMask

        forPlayerWithAuid:(NSInteger)auid

        inRoom:(NSString*)roomName

       didFailWithError:(NSError*)error;

 

Parameters

connector

    The unique instance of BDArenaChatConnector.

restrictionMask

    The restriction map for the target player.

auid

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

roomName

    The name of the chat room in which the restriction has effect for the target player.

error

    An NSError object containing the specific error that occurred.

    For more information about errors, check out the Errors Map section.

 

Availability

available in SDK ver 2.6 and later

 

Declared in

BDArenaChatConnectorDelegate.h

 

 

 

arenaChat:restrictionMask:receivedForPlayerWithAuid:forRoom:

 

Returns the restriction mask currently applied to a specific player in a specific room.

 

- (void) arenaChat:(BDArenaChatConnector*)connector

        restrictionMask:(BDArenaRestrictionMask)restrictionMask

        receivedForPlayerWithAuid:(NSInteger)auid

        forRoom:(NSString*)roomName; 

 

Parameters

connector

    The unique instance of BDArenaChatConnector.

restrictionMask

    The restriction map for the target player.

auid

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

roomName

    The name of the chat room in which the restriction has effect for the target player.

 

Availability

available in SDK ver 2.6 and later

 

Declared in

BDArenaChatConnectorDelegate.h

 

 

arenaChat:historySuccessfullyReceivedWithData:

        forRoom:withFilterMask:

 

Returns the history items array for a specific room, after a request performed

with a specific filter mask.

 

- (void) arenaChat:(BDArenaChatConnector*)connector

        historySuccessfullyReceivedWithData:(NSArray*)historyArray

        forRoom:(NSString*)roomName withFilterMask:(BDArenaChatHistoryFilterTypeMask)filterMask; 

 

Parameters

connector

    The unique instance of BDArenaChatConnector.

historyArray

    An array of  BDArenaChatHistoryItemData objects.

filterMask

    The filter mask used in the request call. Refer to Constants and Types for more info.

 

Discussion 

historyArray brings items of type BDArenaChatHistoryItemData.

These objects have the data property, of type id, that assumes different values and data type

depending on the filter used in the request.

The following table reports each case :

 

 

******
MESSAGES

timestamp_utc = timestamp;
type                = BDArenaChatHistoryItemTypeMessage;
playerData       = BDArenaPlayerData obj (info about the player that sent the message)
data                = [NSString*] -> the content of the message


******
ROOM EVENTS

timestamp_utc = timestamp;
type                = BDArenaChatHistoryItemTypeJoinRoom ||              

                              BDArenaChatHistoryItemTypeLeaveRoom;
playerData       = BDArenaPlayerData obj (info about the player that joined/left room)
data                = nil;

 

******
RESTRICTION UPDATES

timestamp_utc = timestamp;
type                = BDArenaChatHistoryItemTypeRestrictionsUpdate
playerData       = BDArenaPlayerData obj (info about the player (un)restricted in room)
data                = [BDArenaChatHistoryRestrictionUpdateInfo*] -> an object containing

                              info about the old restriction mask, the new restriction mask,

                              and the info about the administrator that performed the action;

******
PROFILE UPDATE

timestamp_utc = timestamp;
type                = BDArenaChatHistoryItemTypeProfileUpdate
playerData       = BDArenaPlayerData obj (info about the player)
data                = nil;

 

 

NOTE : Referring to RESTRICTIONS UPDATES case, for private conversations,

if player A starts ignoring messages from player B, the event in history will be reported with

the value of data field of type BDArenaChatHistoryRestrictionUpdateInfo and the corresponding

administratorPlayerData property will bring the info of the blocker player.

 

This way, 

- player A will see himself as administrator that performed the action (so, A is the blocker player)
- player B will see player A as administrator that performed the action (so, B is the blocked player).

 

and the restriction mask will assume the value of

- BDArenaRestrictionMaskBan if the player is ignored.

- BDArenaRestrictionMaskNone if the player is not ignored

 

Availability

available in SDK ver 3.4.0 and later

 

Declared in

BDArenaChatConnectorDelegate.h

 

 

arenaChat:historyFailedToReceiveForRoom:withError:

 

Informs that some error occurred while trying to retrieve chat history for a specific room.

 

- (void) arenaChat:(BDArenaChatConnector*)connector

        historyFailedToReceiveForRoom:(NSString*)roomName

        withError:(NSError*)error;

 

Parameters

connector

    The unique instance of BDArenaChatConnector.

roomName

    The requested room name.

error

    An NSError object containing the specific error that occurred.

    For more information about errors, check out the Errors Map section.

 

Availability

available in SDK ver 3.4.0 and later

 

Declared in

BDArenaChatConnectorDelegate.h

 

 

arenaChat:historySuccessfullyClearedForRoom: 

 

Informs that the history of a specific room has been successfully cleared.

 

- (void) arenaChat:(BDArenaChatConnector*)connector

        historySuccessfullyClearedForRoom:(NSString*)roomName;

 

Parameters

connector

    The unique instance of BDArenaChatConnector.

roomName

    The requested room name.

 

Availability

available in SDK ver 3.4.0 and later

 

Declared in

BDArenaChatConnectorDelegate.h

 

 

arenaChat:historyFailedToClearForRoom:withError:

 

Informs that some error occurred while trying to clear the history of a specific room.

 

- (void) arenaChat:(BDArenaChatConnector*)connector

        historyFailedToClearForRoom:(NSString*)roomName

        withError:(NSError*)error; 

 

Parameters

connector

    The unique instance of BDArenaChatConnector.

roomName

    The requested room name.

error

    An NSError object containing the specific error that occurred.

    For more information about errors, check out the Errors Map section.

 

Availability

available in SDK ver 3.4.0 and later

 

Declared in

BDArenaChatConnectorDelegate.h

 

 

arenaChat:historyPrivateSuccessfullyReceivedWithData:

        forPlayerWithAuid:withFilterMask:

 

Returns the history items array for a specific private conversation,

after a request performed with a specific filter mask.

 

- (void) arenaChat:(BDArenaChatConnector*)connector

        historyPrivateSuccessfullyReceivedWithData:(NSArray*)historyArray

        forPlayerWithAuid:(NSInteger)auid

        withFilterMask:(BDArenaChatHistoryFilterTypeMask)filterMask; 

 

Parameters

connector

    The unique instance of BDArenaChatConnector.

historyArray

    An array of  BDArenaChatHistoryItemData objects.

auid

    The Arena daemon Unique Id (auid) of the player target of the private conversation.

filterMask

    The filter mask used in the request call. Refer to Constants and Types for more info.

 

Availability

available in SDK ver 3.4.0 and later

 

Declared in

BDArenaChatConnectorDelegate.h

 

 

 

arenaChat:historyPrivateFailedToReceiveForPlayerWithAuid:withError:

 

Informs that some error occurred while trying to retrieve chat history

for a private conversation.

 

- (void) arenaChat:(BDArenaChatConnector*)connector

        historyPrivateFailedToReceiveForPlayerWithAuid:(NSInteger)auid

        withError:(NSError*)error;

 

Parameters

connector

    The unique instance of BDArenaChatConnector.

auid

    The Arena daemon Unique Id (auid) of the player target of the private conversation.

error

    An NSError object containing the specific error that occurred.

    For more information about errors, check out the Errors Map section.

 

Availability

available in SDK ver 3.4.0 and later

 

Declared in

BDArenaChatConnectorDelegate.h

 

 

arenaChat:historyPrivateSuccessfullyClearedForPlayerWithAuid:

 

Informs that the history of a specific private conversation has been successfully cleared.

 

- (void) arenaChat:(BDArenaChatConnector*)connector

        historyPrivateSuccessfullyClearedForPlayerWithAuid:(NSInteger)auid;

 

Parameters

connector

    The unique instance of BDArenaChatConnector.

auid

    The Arena daemon Unique Id (auid) of the player target of the private conversation.

 

Availability

available in SDK ver 3.4.0 and later

 

Declared in

BDArenaChatConnectorDelegate.h

 

 

 

arenaChat:historyPrivateFailedToClearForPlayerWithAuid:withError:

 

Informs that some error occurred while trying to clear the history of a specific private conversation.

 

- (void) arenaChat:(BDArenaChatConnector*)connector

        historyPrivateFailedToClearForPlayerWithAuid:(NSInteger)auid

        withError:(NSError*)error; 

 

Parameters

connector

    The unique instance of BDArenaChatConnector.

auid

    The Arena daemon Unique Id (auid) of the player target of the private conversation.

error

    An NSError object containing the specific error that occurred.

    For more information about errors, check out the Errors Map section.

 

Availability

available in SDK ver 3.4.0 and later

 

Declared in

BDArenaChatConnectorDelegate.h

 

 

 

arenaChat:restrictionsReceivedForRoomsGlobal:

 

Returns an object that contains all rooms in which one or more restrictions have been activated.

 

- (void) arenaChat:(BDArenaChatConnector*)connector

        restrictionsReceivedForRoomsGlobal:(NSDictionary*)restrictions;

 

Parameters

connector

    The unique instance of BDArenaChatConnector.

restrictions

    An NSDictionary object that maps rooms and associated restricted players data.

 

Discussion 

The restrictions object is an NSDictionary in which keys represents rooms name

and each associated value is an NSArray of BDArenaPlayerData filled with restricted players data.

 

Availability

available in SDK ver 2.6 and later

 

Declared in

BDArenaChatConnectorDelegate.h

 

 

 

arenaChat:status:receivedForPlayerWithAuid:

 

Returns the status information of a specific player.

 

- (void) arenaChat:(BDArenaChatConnector*)connector

        status:(ARENA_PLAYER_STATUS)status

        receivedForPlayerWithAuid:(NSInteger)auid;

 

Parameters

connector

    The unique instance of BDArenaChatConnector.

status

    An ARENA_PLAYER_STATUS value indicating the status of the requested player.

auid

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

 

Discussion

This event is notified only to the local player.

 

Availability

available in SDK ver 1.0 and later

 

Declared in

BDArenaChatConnectorDelegate.h

 

 

 

arenaChatLocalPlayerDidLoginFromDifferentDevice

 

Informs that the local player did login from a different device.

 

- (void) arenaChatLocalPlayerDidLoginFromDifferentDevice; 

 

Discussion

The multiplayer and chat daemons allow players to have only one session active.

If the local user, while connected to one of the daemons, tries to connect to the same daemons

through different devices, all previously estabilished connections are closed

by the system leaving active only the last incoming connection.
This behaviour is applied by ArenaDaemon in order to avoid duplication of players

and flooding actions to the platform.

 

Availability

available in SDK ver 1.0 and later

 

Declared in

BDArenaChatConnectorDelegate.h

 

 

 

arenaChat:notificationStartIgnoringMessagesReceivedFromPlayer:

 

Informs that a remote player did start to ignore messages sent by the local player.

 

- (void) arenaChat:(BDArenaChatConnector*)connector

        notificationStartIgnoringMessagesReceivedFromPlayer:(BDArenaPlayerData*)playerData;

 

Parameters

connector

    The unique instance of BDArenaChatConnector.

playerData

    A BDArenaPlayerData object filled with the remote player information.

 

Availability

available in SDK ver 2.5 and later

 

Declared in

BDArenaChatConnectorDelegate.h

 

 

 

arenaChat:notificationEndIgnoringMessagesReceivedFromPlayer:

 

Informs that a remote player did start to accept messages sent by the local player.

 

- (void) arenaChat:(BDArenaChatConnector*)connector

        notificationEndIgnoringMessagesReceivedFromPlayer:(BDArenaPlayerData*)playerData;

 

Parameters

connector

    The unique instance of BDArenaChatConnector.

playerData

    A BDArenaPlayerData object filled with the remote player information.

 

Availability

available in SDK ver 2.5 and later

 

Declared in

BDArenaChatConnectorDelegate.h

 

 

 

arenaChat:notificationRestrictionMask:successfullyUpdatedToMask:

        forLocalPlayerByAdministrator:inRoom:

 

Notifies that the restriction mask for the local player in a specific room

has been updated by a remote administrator.

 

- (void) arenaChat:(BDArenaChatConnector*)connector

        notificationRestrictionMask:(BDArenaRestrictionMask)oldRestrictionMask

        successfullyUpdatedToMask:(BDArenaRestrictionMask)newRestrictionMask

        forLocalPlayerByAdministrator:(BDArenaPlayerData*)administratorData

        inRoom:(NSString*)roomName; 

 

Parameters

connector

    The unique instance of BDArenaChatConnector.

oldRestrictionMask

    The previoulsy set restriction map for the local player.

newRestrictionMask

    The new restriction map set for the local player.

administratorData

    A BDArenaPlayerData object filled with the remote administrator information.

roomName

    The name of the chat room in which the restriction has effect for the local player.

 

Availability

available in SDK ver 2.6 and later

 

Declared in

BDArenaChatConnectorDelegate.h

 

 

 

arenaChat:notificationRestrictionMask:successfullyUpdatedToMask:

        forPlayer:byAdministrator:inRoom:

 

Notifies that the restriction mask for a remote player in a specific room

has been updated by a remote administrator.

 

- (void) arenaChat:(BDArenaChatConnector*)connector

        notificationRestrictionMask:(BDArenaRestrictionMask)oldRestrictionMask

        successfullyUpdatedToMask:(BDArenaRestrictionMask)newRestrictionMask

        forPlayer:(BDArenaPlayerData*)playerData

        byAdministrator:(BDArenaPlayerData*)administratorData

        inRoom:(NSString*)roomName;

 

Parameters

connector

    The unique instance of BDArenaChatConnector.

oldRestrictionMask

    The previoulsy set restriction map for the target player.

newRestrictionMask

    The new restriction map set for the target player.

playerData

    A BDArenaPlayerData object filled with the target player information.

administratorData

    A BDArenaPlayerData object filled with the remote administrator information.

roomName

    The name of the chat room in which the restriction has effect for the target player.

 

Availability

available in SDK ver 2.6 and later

 

Declared in

BDArenaChatConnectorDelegate.h

 

 

 

arenaChat:notificationLocalPlayerDidUpdateInfo:

        administrationRoleStatus:

 

Notifies that the local player has updated his profile info.

 

- (void) arenaChat:(BDArenaChatConnector*)connector

        notificationLocalPlayerDidUpdateInfo:(BDArenaPlayerData*)localPlayerData

        administrationRoleStatus:(BDArenaAdministrationRole)administrationRole;

 

Parameters

connector

    The unique instance of BDArenaChatConnector.

localPlayerData

    A BDArenaPlayerData object filled with the local player information.

administrationRole

    A BDArenaAdministrationRole object filled with the remote administrator information.

 

Availability

available in SDK ver 3.4.0 and later

 

Declared in

BDArenaChatConnectorDelegate.h

 

 

 

arenaChat:notificationRemotePlayerDidUpdateInfo:fromInfo:

 

Notifies that a remote player has updated his profile info.

 

- (void) arenaChat:(BDArenaChatConnector*)connector

        notificationRemotePlayerDidUpdateInfo:(BDArenaPlayerData*)newPlayerData

        fromInfo:(BDArenaPlayerData*)oldPlayerData;

 

Parameters

connector

    The unique instance of BDArenaChatConnector.

newPlayerData

    A BDArenaPlayerData object filled with the local player information.

oldPlayerData

    A BDArenaPlayerData object filled with the local player information.

 

Availability

available in SDK ver 3.4.0 and later

 

Declared in

BDArenaChatConnectorDelegate.h