Loading...
Searching...
No Matches
AccelByte::Api::Lobby Class Reference

Lobby API for chatting and party management. Unlike other servers which use HTTP, Lobby server uses WebSocket (RFC 6455). More...

#include <AccelByteLobbyApi.h>

Inheritance diagram for AccelByte::Api::Lobby:

Public Types

typedef TDelegate< void(FAccelByteModelsDisconnectNotif const &)> FDisconnectNotif
 delegate for handling lobby connection disconnected.
typedef AccelByteWebSocket::FConnectionCloseDelegate FConnectionClosed
typedef AccelByteWebSocket::FReconnectAttemptMulticastDelegate FReconnectAttempted
typedef AccelByteWebSocket::FMassiveOutageMulticastDelegate FMassiveOutage

Public Member Functions

 Lobby (Credentials &InCredentialsRef, Settings const &InSettingsRef, FHttpRetrySchedulerBase &InHttpRef, FAccelByteMessagingSystem &InMessagingSystemRef, FAccelByteNetworkConditioner &InNetworkConditionerRef, TSharedPtr< AccelByte::FApiClient, ESPMode::ThreadSafe > const &InApiClient=nullptr, float InPingDelay=30.f, float InInitialBackoffDelay=1.f, float InMaxBackoffDelay=30.f, float InTotalTimeout=60.f)
 Lobby (Credentials &InCredentialsRef, Settings const &InSettingsRef, FHttpRetrySchedulerBase &InHttpRef, FAccelByteMessagingSystem &InMessagingSystemRef, FAccelByteNetworkConditioner &InNetworkConditionerRef, FAccelBytePlatformPtr const &InAccelBytePlatform, float InPingDelay=30.f, float InInitialBackoffDelay=1.f, float InMaxBackoffDelay=30.f, float InTotalTimeout=60.f)
 DECLARE_DELEGATE_OneParam (FBaseResponse, FAccelByteModelsLobbyBaseResponse const &)
 delegate for handling info party response.
 DECLARE_DELEGATE_OneParam (FPartyInfoResponse, FAccelByteModelsInfoPartyResponse const &)
 delegate for handling info party response.
 DECLARE_DELEGATE_OneParam (FPartyCreateResponse, FAccelByteModelsCreatePartyResponse const &)
 delegate for handling create party response.
 DECLARE_DELEGATE_OneParam (FPartyLeaveResponse, FAccelByteModelsLeavePartyResponse const &)
 delegate for handling leave party response.
 DECLARE_DELEGATE_OneParam (FPartyLeaveNotif, FAccelByteModelsLeavePartyNotice const &)
 delegate for handling leave party notification. This delegate is DEPRECATED
 DECLARE_DELEGATE_OneParam (FPartyMemberLeaveNotif, FAccelByteModelsLeavePartyNotice const &)
 delegate for handling leave party notification.
 DECLARE_DELEGATE_OneParam (FPartyInviteResponse, FAccelByteModelsPartyInviteResponse const &)
 delegate for handling invite party response.
 DECLARE_DELEGATE_OneParam (FPartyInviteNotif, FAccelByteModelsInvitationNotice const &)
 delegate for handling party invitation notification
 DECLARE_DELEGATE_OneParam (FPartyGetInvitedNotif, FAccelByteModelsPartyGetInvitedNotice const &)
 delegate for handling get party invitation notification
 DECLARE_DELEGATE_OneParam (FPartyJoinResponse, FAccelByteModelsPartyJoinResponse const &)
 delegate for handling join party response
 DECLARE_DELEGATE_OneParam (FPartyJoinNotif, FAccelByteModelsPartyJoinNotice const &)
 delegate for handling join party notification
 DECLARE_DELEGATE_OneParam (FPartyRejectResponse, FAccelByteModelsPartyRejectResponse const &)
 delegate for handling reject party response
 DECLARE_DELEGATE_OneParam (FPartyRejectNotif, FAccelByteModelsPartyRejectNotice const &)
 delegate for handling reject party notification
 DECLARE_DELEGATE_OneParam (FPartyKickResponse, FAccelByteModelsKickPartyMemberResponse const &)
 delegate for handling member kicked from party event
 DECLARE_DELEGATE_OneParam (FPartyKickNotif, FAccelByteModelsGotKickedFromPartyNotice const &)
 delegate for handling member kicked from party event notification
 DECLARE_DELEGATE_OneParam (FPartyDataUpdateNotif, FAccelByteModelsPartyDataNotif const &)
 delegate for handling update data notification
 DECLARE_DELEGATE_OneParam (FPartyMemberConnectNotif, FAccelByteModelsPartyMemberConnectionNotice const &)
 delegate for handling party connect notification
 DECLARE_DELEGATE_OneParam (FPartyMemberDisconnectNotif, FAccelByteModelsPartyMemberConnectionNotice const &)
 delegate for handling party disconnect notification
 DECLARE_DELEGATE_OneParam (FPartyGenerateCodeResponse, FAccelByteModelsPartyGenerateCodeResponse const &)
 delegate for handling generate party code event
 DECLARE_DELEGATE_OneParam (FPartyGetCodeResponse, FAccelByteModelsPartyGetCodeResponse const &)
 delegate for handling get party code event
 DECLARE_DELEGATE_OneParam (FPartyDeleteCodeResponse, FAccelByteModelsPartyDeleteCodeResponse const &)
 delegate for handling delete party code event
 DECLARE_DELEGATE_OneParam (FPartyJoinViaCodeResponse, FAccelByteModelsPartyJoinResponse const &)
 delegate for handling join party via party code event
 DECLARE_DELEGATE_OneParam (FPartyPromoteLeaderResponse, FAccelByteModelsPartyPromoteLeaderResponse const &)
 delegate for handling promote party leader response
 DECLARE_DELEGATE_OneParam (FPartySendNotifResponse, FAccelByteModelsPartySendNotifResponse const &)
 delegate for handling sending a notification to a party member
 DECLARE_DELEGATE_OneParam (FPartyNotif, FAccelByteModelsPartyNotif const &)
 delegate for handling notification from a party member
 DECLARE_DELEGATE_OneParam (FPersonalChatResponse, FAccelByteModelsPersonalMessageResponse const &)
 delegate for handling private message response
 DECLARE_DELEGATE_OneParam (FPersonalChatNotif, FAccelByteModelsPersonalMessageNotice const &)
 delegate for handling private message event notification
 DECLARE_DELEGATE_OneParam (FPartyChatResponse, FAccelByteModelsPartyMessageResponse const &)
 delegate for handling party message event response
 DECLARE_DELEGATE_OneParam (FPartyChatNotif, FAccelByteModelsPartyMessageNotice const &)
 delegate for handling party message event notification
 DECLARE_DELEGATE_OneParam (FJoinDefaultChannelChatResponse, FAccelByteModelsJoinDefaultChannelResponse const &)
 delegate for handling join default channel message event response
 DECLARE_DELEGATE_OneParam (FChannelChatResponse, FAccelByteModelsChannelMessageResponse const &)
 delegate for handling channel message event response
 DECLARE_DELEGATE_OneParam (FChannelChatNotif, FAccelByteModelsChannelMessageNotice const &)
 delegate for handling channel message event notification
 DECLARE_DELEGATE_OneParam (FSetUserPresenceResponse, FAccelByteModelsSetOnlineUsersResponse const &)
 delegate for handling user change presence status
 DECLARE_DELEGATE_OneParam (FFriendStatusNotif, FAccelByteModelsUsersPresenceNotice const &)
 delegate for handling other user change their presence status event
 DECLARE_DELEGATE_OneParam (FGetAllFriendsStatusResponse, FAccelByteModelsGetOnlineUsersResponse const &)
 delegate for handling get all user presence
 DECLARE_DELEGATE_OneParam (FMessageNotif, FAccelByteModelsNotificationMessage const &)
 delegate for handling incoming notification
 DECLARE_MULTICAST_DELEGATE_OneParam (FNotifBroadcaster, FAccelByteModelsNotificationMessage const &)
 DECLARE_DELEGATE_OneParam (FUserBannedNotification, FAccelByteModelsUserBannedNotification const &)
 delegate for handling ban notification
 DECLARE_DELEGATE_OneParam (FUserUnbannedNotification, FAccelByteModelsUserBannedNotification const &)
 delegate for handling unban notification
 DECLARE_DELEGATE_OneParam (FRequestFriendsResponse, FAccelByteModelsRequestFriendsResponse const &)
 delegate for handling request friend response
 DECLARE_DELEGATE_OneParam (FUnfriendResponse, FAccelByteModelsUnfriendResponse const &)
 delegate for handling unfriend response
 DECLARE_DELEGATE_OneParam (FListOutgoingFriendsResponse, FAccelByteModelsListOutgoingFriendsResponse const &)
 delegate for handling list outgoing friends response
 DECLARE_DELEGATE_OneParam (FListOutgoingFriendsWithTimeResponse, FAccelByteModelsListOutgoingFriendsWithTimeResponse const &)
 delegate for handling list outgoing friends response with added requiredAt timestamp
 DECLARE_DELEGATE_OneParam (FCancelFriendsResponse, FAccelByteModelsCancelFriendsResponse const &)
 delegate for handling cancel friend response
 DECLARE_DELEGATE_OneParam (FListIncomingFriendsResponse, FAccelByteModelsListIncomingFriendsResponse const &)
 delegate for handling list incoming friends response
 DECLARE_DELEGATE_OneParam (FListIncomingFriendsWithTimeResponse, FAccelByteModelsListIncomingFriendsWithTimeResponse const &)
 delegate for handling list incoming friends response with added requiredAt timestamp
 DECLARE_DELEGATE_OneParam (FAcceptFriendsResponse, FAccelByteModelsAcceptFriendsResponse const &)
 delegate for handling accept friend response
 DECLARE_DELEGATE_OneParam (FRejectFriendsResponse, FAccelByteModelsRejectFriendsResponse const &)
 delegate for handling reject friend response
 DECLARE_DELEGATE_OneParam (FLoadFriendListResponse, FAccelByteModelsLoadFriendListResponse const &)
 delegate for handling load friend list response
 DECLARE_DELEGATE_OneParam (FGetFriendshipStatusResponse, FAccelByteModelsGetFriendshipStatusResponse const &)
 delegate for handling get friendship status response
 DECLARE_DELEGATE_OneParam (FAcceptFriendsNotif, FAccelByteModelsAcceptFriendsNotif const &)
 delegate for handling notification when your request friend is accepted
 DECLARE_DELEGATE_OneParam (FRequestFriendsNotif, FAccelByteModelsRequestFriendsNotif const &)
 delegate for handling notification when you receive a request friend
 DECLARE_DELEGATE_OneParam (FUnfriendNotif, FAccelByteModelsUnfriendNotif const &)
 delegate for handling unfriend notification
 DECLARE_DELEGATE_OneParam (FCancelFriendsNotif, FAccelByteModelsCancelFriendsNotif const &)
 delegate for handling cancel friend notification
 DECLARE_DELEGATE_OneParam (FRejectFriendsNotif, FAccelByteModelsRejectFriendsNotif const &)
 delegate for handling reject friend notification
 DECLARE_DELEGATE_OneParam (FBlockPlayerResponse, FAccelByteModelsBlockPlayerResponse const &)
 delegate for handling block player response
 DECLARE_DELEGATE_OneParam (FUnblockPlayerResponse, FAccelByteModelsUnblockPlayerResponse const &)
 delegate for handling unblock player response
 DECLARE_DELEGATE_OneParam (FListBlockedUserResponse, FAccelByteModelsListBlockedUserResponse const &)
 delegate for handling list blocked user response
 DECLARE_DELEGATE_OneParam (FListBlockerResponse, FAccelByteModelsListBlockerResponse const &)
 delegate for handling list blocker response
 DECLARE_DELEGATE_OneParam (FBlockPlayerNotif, FAccelByteModelsBlockPlayerNotif const &)
 delegate for handling notification when you block a player
 DECLARE_DELEGATE_OneParam (FUnblockPlayerNotif, FAccelByteModelsUnblockPlayerNotif const &)
 delegate for handling notification when you unblock a player
 DECLARE_DELEGATE_TwoParams (FSignalingP2P, FString const &, FString const &)
 delegate for handling signaling P2P message
 DECLARE_DELEGATE_TwoParams (FErrorNotif, int32, FString const &)
 delegate for handling signaling P2P message
 DECLARE_DELEGATE_OneParam (FSetSessionAttributeResponse, FAccelByteModelsSetSessionAttributesResponse const &)
 delegate for handling response when setting session attribute
 DECLARE_DELEGATE_OneParam (FGetSessionAttributeResponse, FAccelByteModelsGetSessionAttributesResponse const &)
 delegate for handling response when setting session attribute
 DECLARE_DELEGATE_OneParam (FGetAllSessionAttributeResponse, FAccelByteModelsGetAllSessionAttributesResponse const &)
 delegate for handling response when setting session attribute
 DECLARE_DELEGATE_OneParam (FRefreshTokenResponse, FAccelByteModelsRefreshTokenResponse const &)
 delegate for handling response when refreshing lobby token.
 DECLARE_DELEGATE (FConnectSuccess)
 delegate for handling successfully connecting to lobby.
 DECLARE_DELEGATE_OneParam (FV2PartyMembersChangedNotif, FAccelByteModelsV2PartyMembersChangedEvent)
 Delegate for party members changed event.
 DECLARE_DELEGATE_OneParam (FV2PartyInvitedNotif, FAccelByteModelsV2PartyInvitedEvent)
 Delegate for user invited to party event.
 DECLARE_DELEGATE_OneParam (FV2PartyInviteTimeoutNotif, FAccelByteModelsV2PartyInviteTimeoutEvent)
 Delegate for user party invitation timed out event. Notification when a party invitation has been timeout.
 DECLARE_DELEGATE_OneParam (FV2PartyRejectedNotif, FAccelByteModelsV2PartyUserRejectedEvent)
 Delegate for user rejected invitation event.
 DECLARE_DELEGATE_OneParam (FV2PartyJoinedNotif, FAccelByteModelsV2PartyUserJoinedEvent)
 Delegate for user joined party event.
 DECLARE_DELEGATE_OneParam (FV2PartyKickedNotif, FAccelByteModelsV2PartyUserKickedEvent)
 Delegate for user kicked from party event.
 DECLARE_MULTICAST_DELEGATE_OneParam (FV2PartyInviteCanceledNotif, FAccelByteModelsV2PartyInviteCanceledEvent)
 Delegate for party invite canceled event. Will be triggered when any outgoing invitation canceled. Inviter and Invitee will receive it.
 DECLARE_DELEGATE_OneParam (FV2PartyUpdatedNotif, FAccelByteModelsV2PartySession)
 DECLARE_MULTICAST_DELEGATE_OneParam (FV2PartyCreatedNotif, FAccelByteModelsV2PartyCreatedEvent)
 DECLARE_DELEGATE_OneParam (FV2PartyStorageChangedNotif, FAccelByteModelsV2PartyStorageChangedEvent)
 DECLARE_DELEGATE_OneParam (FV2GameSessionInvitedNotif, FAccelByteModelsV2GameSessionUserInvitedEvent)
 Delegate for user invited to game session event.
 DECLARE_DELEGATE_OneParam (FV2GameSessionInviteTimeoutNotif, FAccelByteModelsV2GameSessionUserInviteTimeoutEvent)
 Delegate for user game session invitation timed out event. Notification when a game session invitation has been timeout.
 DECLARE_DELEGATE_OneParam (FV2GameSessionJoinedNotif, FAccelByteModelsV2GameSessionUserJoinedEvent)
 Delegate for user joined game session event.
 DECLARE_DELEGATE_OneParam (FV2GameSessionMembersChangedNotif, FAccelByteModelsV2GameSessionMembersChangedEvent)
 Delegate for game session members changed event.
 DECLARE_DELEGATE_OneParam (FV2GameSessionUpdatedNotif, FAccelByteModelsV2GameSession)
 Delegate for game session updated event.
 DECLARE_DELEGATE_OneParam (FV2GameSessionKickedNotif, FAccelByteModelsV2GameSessionUserKickedEvent)
 Delegate for game session updated event.
 DECLARE_DELEGATE_OneParam (FV2GameSessionRejectedNotif, FAccelByteModelsV2GameSessionUserRejectedEvent)
 Delegate for game session invite rejected event.
 DECLARE_DELEGATE_OneParam (FV2GameSessionEndedNotif, FAccelByteModelsV2GameSessionEndedEvent)
 Delegate for game session ended event. Will be triggered when DS unregistered.
 DECLARE_MULTICAST_DELEGATE_OneParam (FV2GameSessionInviteCanceledNotif, FAccelByteModelsV2GameSessionInviteCanceledEvent)
 Delegate for game session invite canceled event. Will be triggered when any outgoing invitation canceled. Inviter and Invitee will receive it.
 DECLARE_DELEGATE_OneParam (FV2SessionStorageChangedNotif, FAccelByteModelsV2SessionStorageChangedEvent)
 Delegate for session storage changed event.
 DECLARE_DELEGATE_OneParam (FV2SessionJoinedSecretNotif, FAccelByteModelsV2SessionJoinedSecret const &)
 Delegate for session joined secret event.
 DECLARE_DELEGATE_OneParam (FV2DSStatusChangedNotif, FAccelByteModelsV2DSStatusChangedNotif)
 Delegate for game session when DS status is changed.
 DECLARE_DELEGATE_OneParam (FV2MatchmakingMatchFoundNotif, FAccelByteModelsV2MatchFoundNotif)
 Delegate for notif when match is found.
 DECLARE_DELEGATE_OneParam (FV2MatchmakingStartNotif, FAccelByteModelsV2StartMatchmakingNotif)
 Delegate for notification when party leader started matchmaking.
 DECLARE_DELEGATE_OneParam (FV2MatchmakingExpiredNotif, FAccelByteModelsV2MatchmakingExpiredNotif)
 Delegate for notification when matchmaking ticket expired.
 DECLARE_DELEGATE_OneParam (FV2MatchmakingCanceledNotif, FAccelByteModelsV2MatchmakingCanceledNotif)
 Delegate for notification when party leader canceled matchmaking.
 DECLARE_DELEGATE_OneParam (FChangeUserRegionResponse, FAccelByteModelsChangeUserRegionResponse const &)
 delegate for handling set user region response
 DECLARE_DELEGATE_OneParam (FV2NativeSessionSyncNotif, FAccelByteModelsV2NativeSessionSyncNotif)
 Delegate for a native session sync event from session service.
 DECLARE_MULTICAST_DELEGATE_OneParam (FOneTimeCodeLinkedNotif, FAccelByteModelsOneTimeCodeLinked const &)
 DECLARE_MULTICAST_DELEGATE_OneParam (FEntitlementUpdatedNotif, FAccelByteModelsEntitlementUpdatedNotification const &)
 Delegate for notification when entitlements are updated.
 DECLARE_MULTICAST_DELEGATE_OneParam (FWalletBalanceChangedNotif, FAccelByteModelsWalletBalanceChangedNotification const &)
 Delegate for notification when wallet balance are changed.
 DECLARE_MULTICAST_DELEGATE_OneParam (FWalletStatusChangedNotif, FAccelByteModelsWalletStatusChangedNotification const &)
 Delegate for notification when wallet status are changed.
void Connect (FString const &Token="")
 Connect to the Lobby server via websocket. You must connect to the server before you can start sending/receiving. Also make sure you have logged in first as this operation requires access token.
void Disconnect (bool ForceCleanup=false)
 Disconnect from server if and only if the you have connected to server. If not currently connected, then this does nothing.
bool IsConnected () const
 Check whether the websocket is currently connected to the Lobby server.
bool IsReconnecting () const
 Check whether the websocket is currently trying to reconnect to the Lobby server.
void SendPing ()
 Send ping.
FString SendPrivateMessage (FString const &UserId, FString const &Message)
 Send a private message to another user.
FString SendPartyMessage (FString const &Message)
 Send a message to other party members.
FString SendJoinDefaultChannelChatRequest ()
 Request to join the default channel chat.
FString SendChannelMessage (FString const &Message)
 Send a message to joined channel chat.
FString SendInfoPartyRequest ()
 Get information about current party.
FString SendInfoPartyRequest (FPartyInfoResponse const &OnInfoPartyResponse, FErrorHandler const &OnError=nullptr)
FString SendCreatePartyRequest ()
 Create a party.
FString SendLeavePartyRequest ()
 Leave current party.
FString SendInviteToPartyRequest (FString const &UserId)
 Invite a user to party.
FString SendAcceptInvitationRequest (FString const &PartyId, FString const &InvitationToken)
 Accept a party invitation.
FString SendRejectInvitationRequest (FString const &PartyId, FString const &InvitationToken)
 Reject a party invitation.
FString SendKickPartyMemberRequest (FString const &UserId)
 Kick a party member.
FString SendPartyGenerateCodeRequest ()
 Generate Party code.
FString SendPartyGetCodeRequest ()
 Get Party code.
FString SendPartyDeleteCodeRequest ()
 Remove Party invite code.
FString SendPartyJoinViaCodeRequest (FString const &partyCode)
 Join Party via party code.
FString SendPartyPromoteLeaderRequest (FString const &UserId)
 Promote party member to party leader.
FString SendNotificationToPartyMember (FString const &Topic, FString const &Payload)
 Send notification to party member.
FAccelByteTaskWPtr SetPartySizeLimit (FString const &PartyId, int32 Limit, FVoidHandler const &OnSuccess, FErrorHandler const &OnError)
 Set the party's member limit.
void GetAllAsyncNotification ()
 Get all pending notification(s) that is sent to user when user is not connected to lobby. Please call this function after user connected to lobby.
FAccelByteTaskWPtr QueryFriendList (THandler< FAccelByteModelsQueryFriendListResponse > const &OnSuccess, FErrorHandler const &OnError, int32 Offset=0, int32 Limit=20)
 Query the friend list of current user. The result is friend ids in pagination format.
FAccelByteTaskWPtr QueryIncomingFriendRequest (THandler< FAccelByteModelsIncomingFriendRequests > const &OnSuccess, FErrorHandler const &OnError, int32 Offset=0, int32 Limit=20)
 Query the incoming friend requests for current user. The result is friend requests with requested time info in pagination format.
FAccelByteTaskWPtr QueryOutgoingFriendRequest (THandler< FAccelByteModelsOutgoingFriendRequests > const &OnSuccess, FErrorHandler const &OnError, int32 Offset=0, int32 Limit=20)
 Query the outgoing friend requests for current user. The result is friend requests with requested time info in pagination format.
FAccelByteTaskWPtr SendFriendRequest (FString const &UserId, FVoidHandler const &OnSuccess, FErrorHandler const &OnError)
 Send friend request to other user by user id.
FAccelByteTaskWPtr SendFriendRequestByPublicId (FString const &PublicId, FVoidHandler const &OnSuccess, FErrorHandler const &OnError)
 Send friend request to other user by public id.
FAccelByteTaskWPtr CancelFriendRequest (FString const &UserId, FVoidHandler const &OnSuccess, FErrorHandler const &OnError)
 Cancel outgoing friend request.
FAccelByteTaskWPtr AcceptFriendRequest (FString const &UserId, FVoidHandler const &OnSuccess, FErrorHandler const &OnError)
 Accept friend request from other user.
FAccelByteTaskWPtr RejectFriendRequest (FString const &UserId, FVoidHandler const &OnSuccess, FErrorHandler const &OnError)
 Reject friend request from other user.
FAccelByteTaskWPtr GetFriendshipStatus (FString const &UserId, THandler< FAccelByteModelsFriendshipStatusResponse > const &OnSuccess, FErrorHandler const &OnError)
 Get friendship status of current user with other user.
FAccelByteTaskWPtr Unfriend (FString const &UserId, FVoidHandler const &OnSuccess, FErrorHandler const &OnError)
 Unfriend a user from friend list.
FAccelByteTaskWPtr BlockPlayer (FString const &UserId, FVoidHandler const &OnSuccess, FErrorHandler const &OnError)
 Block specified player from being able to do certain action against current user the specified player will be removed from friend list.
FAccelByteTaskWPtr UnblockPlayer (FString const &UserId, FVoidHandler const &OnSuccess, FErrorHandler const &OnError)
 Unblock specified player enabling them to do certain action against current user.
void RequestFriend (FString const &UserId)
 Send request friend request.
void RequestFriendByPublicId (FString const &PublicId)
 Send friend request by public ID.
void Unfriend (FString const &UserId)
 Send unfriend request.
void ListOutgoingFriends ()
 Send list of outgoing friends request.
void ListOutgoingFriendsWithTime ()
 Send list of outgoing friends request with requestedAt timestamp.
void CancelFriendRequest (FString const &UserId)
 Send cancel friend request.
void ListIncomingFriends ()
 Send list of incoming friends request.
void ListIncomingFriendsWithTime ()
 Send list of incoming friends request with requestedAt timestamp.
void AcceptFriend (FString const &UserId)
 Send accept friend request.
void RejectFriend (FString const &UserId)
 Send reject friend request.
void LoadFriendsList ()
 Send load friends list request.
void GetFriendshipStatus (FString const &UserId)
 Send get friendship status request.
void BlockPlayer (FString const &UserId)
 Block specified player from being able to do certain action against current user the specified player will be removed from friend list.
void UnblockPlayer (FString const &UserId)
 Unblock specified player enabling them to do certain action against current user.
FString SendSignalingMessage (FString const &UserId, FString const &Message)
 Send a signaling message to another user.
FString SetSessionAttribute (FString const &Key, FString const &Value)
 Set user attribute to lobby session.
FString GetSessionAttribute (FString const &Key)
 Get user attribute from lobby session.
FString GetAllSessionAttribute ()
 Get all user attribute from lobby session.
FString RefreshToken (FString const &AccessToken)
 Refresh access token used in lobby.
void UnbindEvent ()
 Unbind all delegates set previously.
void UnbindPartyNotifEvents ()
 Unbind all party notif delegates set previously.
void UnbindPartyResponseEvents ()
 Unbind all party response delegates set previously.
void UnbindFriendNotifEvents ()
 Unbind all friend notif delegates set previously.
void UnbindFriendResponseEvents ()
 Unbind all friend response delegates set previously.
void UnbindChatNotifEvents ()
 Unbind all chat notif delegates set previously.
void UnbindChatResponseEvents ()
 Unbind all chat response delegates set previously.
void UnbindBlockNotifEvents ()
 Unbind all Block notif delegates set previously.
void UnbindBlockResponseEvents ()
 Unbind all Block response delegates set previously.
void UnbindSessionAttributeEvents ()
 Unbind all session attribute response delegates set previously.
void UnbindV2PartyEvents ()
 Unbind all V2 party delegates set previously.
void UnbindV2GameSessionEvents ()
 Unbind all V2 party delegates set previously.
void UnbindV2SessionGeneralEvents ()
 Unbind all shared notif for session and v2 party set previously.
void UnbindV2MatchmakingEvents ()
 Unbind all V2 matchmaking delegates set previously.
void UnbindMessageNotificationEvents ()
 Unbind all message notification delegates set previously.
void SetConnectSuccessDelegate (FConnectSuccess const &OnConnectSuccess)
 Set a trigger function when successfully connect to lobby.
void SetConnectFailedDelegate (FErrorHandler const &OnConnectError)
 Set a trigger function when connection to lobby failed.
void SetDisconnectNotifDelegate (FDisconnectNotif const &OnDisconnectNotice)
 Set a trigger function when connection to lobby is disconnected.
void SetConnectionClosedDelegate (FConnectionClosed const &OnConnectionClosed)
 Set a trigger function when connection is closed.
void SetReconnectingDelegate (FConnectionClosed const &OnReconnecting)
 Set a trigger function when connection is closed and reconnecting.
FReconnectAttempted & OnReconnectAttemptedMulticastDelegate ()
 Get a multicast delegate that will be triggered when an attempt to reconnect websocket has been done.
FMassiveOutage & OnMassiveOutageMulticastDelegate ()
 Get a multicast delegate that will be triggered when connection is down & can't be reestablished. Longer than usual.
void SetPartyLeaveNotifDelegate (FPartyLeaveNotif const &OnPartyLeaveNotice)
 Set a trigger function when a party member leave from the party. This function is DEPRECATED.
void SetPartyMemberLeaveNotifDelegate (FPartyMemberLeaveNotif const &OnPartyMemberLeaveNotice)
 Set a trigger function when a party member leave from the party.
void SetPartyMemberConnectNotifDelegate (FPartyMemberConnectNotif const &OnPartyMemberConnectNotif)
 Set a trigger function when a party member reconnecting to the lobby.
void SetPartyMemberDisconnectNotifDelegate (FPartyMemberDisconnectNotif const &OnPartyMemberDisconnectNotif)
 Set a trigger function when a party member disconnect from lobby.
void SetPartyInviteNotifDelegate (FPartyInviteNotif const &OnPartyInviteNotif)
 Set a trigger function when other user is invited to party.
void SetPartyGetInvitedNotifDelegate (FPartyGetInvitedNotif const &OnInvitePartyGetInvitedNotice)
 Set a trigger function when receiving a party invite.
void SetPartyJoinNotifDelegate (FPartyJoinNotif const &OnInvitePartyJoinNotice)
 Set a trigger function when a new member joins the party.
void SetPartyInvitationRejectedNotifDelegate (FPartyRejectNotif const &OnInvitePartyRejectNotice)
 Set a trigger function when a party invitation is rejected.
void SetPartyKickNotifDelegate (FPartyKickNotif const &OnInvitePartyKickedNotice)
 Set a trigger function when kicked from party.
void SetPartyNotifDelegate (FPartyNotif const &OnPartyNotif)
 Set a trigger function when party data is updated.
void SetPrivateMessageNotifDelegate (FPersonalChatNotif const &OnPersonalChatNotif)
 Set a trigger function when party data is updated.
void SetPartyChatNotifDelegate (FPartyChatNotif const &OnPersonalChatNotif)
 Set a trigger function when received a party chat (v1).
void SetUserPresenceNotifDelegate (FFriendStatusNotif const &OnUserPresenceNotif)
 Set a trigger function when friends presence is updated.
void SetMessageNotifDelegate (FMessageNotif const &OnNotificationMessage)
 Set a trigger function when receiving a notification message.
FDelegateHandle AddMessageNotifDelegate (FMessageNotif const &OnNotificationMessage)
 Add a delegate when receiving a notification message.
FDelegateHandle AddMessageNotifBroadcasterDelegate (FNotifBroadcaster const &OnNotificationBroadcasterMessage)
 Set a trigger function when receiving a notification message.
bool RemoveMessageNotifBroadcasterDelegate (FDelegateHandle const &OnNotificationBroadcasterDelegate)
 Remove a trigger function when receiving a notification message.
void SetV2PartyInvitedNotifDelegate (FV2PartyInvitedNotif const &OnPartyInvitedNotif)
 Set a trigger function when receiving invite to a party (v2).
void SetV2PartyInviteTimeoutNotifDelegate (FV2PartyInviteTimeoutNotif const &OnPartyInviteTimeoutNotif)
 Set a trigger function when an party (v2) invitation is already timeout.
void SetV2PartyMembersChangedNotifDelegate (FV2PartyMembersChangedNotif const &OnPartyMembersChanged)
 Set a trigger function when party members changed (v2).
void SetV2PartyJoinedNotifDelegate (FV2PartyJoinedNotif const &OnPartyJoinedNotif)
 Set a trigger function when a new member joined current party (v2).
void SetV2PartyRejectedNotifDelegate (FV2PartyRejectedNotif const &OnPartyRejectedNotif)
 Set a trigger function when a party invitation is rejected (v2).
void SetV2PartyKickedNotifDelegate (FV2PartyKickedNotif const &OnPartyKickedNotif)
 Set a trigger function when getting kicked from a party (v2).
void SetV2GameSessionInvitedNotifDelegate (FV2GameSessionInvitedNotif const &OnGameSessionInvitedNotif)
 Set a trigger function when receiving invite to a game session (v2).
void SetV2GameSessionInviteTimeoutNotifDelegate (FV2GameSessionInviteTimeoutNotif const &OnGameSessionInviteTimeoutNotif)
 Set a trigger function when an game session (v2) invitation is already timeout.
void SetV2GameSessionJoinedNotifDelegate (FV2GameSessionJoinedNotif const &OnGameSessionJoinedNotif)
 Set a trigger function when a new member joined the game session (v2).
void SetV2GameSessionMembersChangedNotifDelegate (FV2GameSessionMembersChangedNotif const &OnGameSessionMembersChangedNotif)
 Set a trigger function when a game session member changes (v2).
void SetV2GameSessionUpdatedNotifDelegate (FV2GameSessionUpdatedNotif const &OnGameSessionUpdatedNotif)
 Set a trigger function when a game session data changes (v2).
void SetV2GameSessionKickedNotifDelegate (FV2GameSessionKickedNotif const &OnGameSessionKickedNotif)
 Set a trigger function when kicked from a game session (v2).
void SetV2GameSessionRejectedNotifDelegate (FV2GameSessionRejectedNotif const &OnGameSessionRejectedNotif)
 Set a trigger function when an invitation is rejected (v2).
void SetV2GameSessionEndedNotifDelegate (FV2GameSessionEndedNotif const &OnGameSessionEndededNotif)
 Set a trigger function when game session ended by the DS (v2).
FDelegateHandle AddV2GameSessionInviteCanceledNotifDelegate (THandler< FAccelByteModelsV2GameSessionInviteCanceledEvent > const &OnGameSessionInviteCanceled)
bool RemoveV2GameSessionInviteCanceledNotifDelegate (FDelegateHandle const &DelegateHandle)
FDelegateHandle AddV2PartyCreatedNotifDelegate (THandler< FAccelByteModelsV2PartyCreatedEvent > const &OnPartyCreated)
bool RemoveV2PartyCreatedNotifDelegate (FDelegateHandle const &DelegateHandle)
FDelegateHandle AddV2PartyInviteCanceledNotifDelegate (THandler< FAccelByteModelsV2PartyInviteCanceledEvent > const &OnPartyInviteCanceled)
bool RemoveV2PartyInviteCanceledNotifDelegate (FDelegateHandle const &DelegateHandle)
void SetV2SessionStorageChangedNotifDelegate (FV2SessionStorageChangedNotif const &OnSessionStorageChangedNotif)
 Set a trigger function when session storage content changes (v2).
void SetV2PartyStorageChangedNotifDelegate (FV2PartyStorageChangedNotif const &OnPartyStorageChangedNotif)
 Set a trigger function when party storage content changes (v2).
void SetV2SessionJoinedSecretNotifDelegate (FV2SessionJoinedSecretNotif const &OnSessionJoinedSecretNotif)
 Set a trigger function when session (with secret server enabled) joined (v2).
void SetV2DSStatusChangedNotifDelegate (FV2DSStatusChangedNotif const &OnDSStatusChangedNotif)
 Set a trigger function when a DS status changes (v2).
void SetV2PartyUpdatedNotifDelegate (FV2PartyUpdatedNotif const &OnPartyUpdatedNotif)
 Set a trigger function when a party data is updated (v2).
void SetV2MatchmakingMatchFoundNotifDelegate (FV2MatchmakingMatchFoundNotif const &OnMatchFoundNotif)
 Set a trigger function when matchmaking ticket is successfully matched (v2).
void SetV2MatchmakingStartNotifDelegate (FV2MatchmakingStartNotif const &OnMatchmakingStartNotif)
 Set a trigger function when leader created a matchmaking ticket (v2).
void SetV2MatchmakingExpiredNotifDelegate (FV2MatchmakingExpiredNotif const &OnMatchmakingExpiredNotif)
 Set a trigger function when matchmaking ticket is expired and matchmaking stopped (v2).
void SetV2MatchmakingCanceledNotifDelegate (FV2MatchmakingCanceledNotif const &OnMatchmakingCanceledNotif)
 Set a trigger function when leader cancelled matchmaking (v2).
void SetV2NativeSessionSyncNotifDelegate (const FV2NativeSessionSyncNotif &OnV2NativeSessionSyncNotif)
 Set a trigger function when leader cancelled matchmaking (v2).
void SetUserBannedNotificationDelegate (FUserBannedNotification const &OnUserBannedNotification)
 Set a trigger function when user is banned.
void SetUserUnbannedNotificationDelegate (FUserUnbannedNotification const &OnUserUnbannedNotification)
 Set a trigger function when user is unbanned.
void SetOnFriendRequestAcceptedNotifDelegate (FAcceptFriendsNotif const &OnAcceptFriendsNotif)
 Set a trigger function when a friend request is accepted.
void SetOnIncomingRequestFriendsNotifDelegate (FRequestFriendsNotif const &OnRequestFriendsNotif)
 Set a trigger function when a friend request is received.
void SetOnUnfriendNotifDelegate (FUnfriendNotif const &OnUnfriendNotif)
 Set a trigger function when unfriended.
void SetOnCancelFriendsNotifDelegate (FCancelFriendsNotif const &OnCancelFriendsNotif)
 Set a trigger function when friend request is cancelled.
void SetOnRejectFriendsNotifDelegate (FRejectFriendsNotif const &OnRejectFriendsNotif)
 Set a trigger function when friend request is rejected.
void SetParsingErrorDelegate (FErrorHandler const &OnParsingError)
 Set a trigger function when a lobby message failed to be parsed.
void SetInfoPartyResponseDelegate (FPartyInfoResponse const &OnInfoPartyResponse, FErrorHandler const &OnError=nullptr)
 set info party response
void SetCreatePartyResponseDelegate (FPartyCreateResponse const &OnCreatePartyResponse, FErrorHandler const &OnError=nullptr)
 create party response delegate
void SetLeavePartyResponseDelegate (FPartyLeaveResponse const &OnLeavePartyResponse, FErrorHandler const &OnError=nullptr)
 set leave party response delegate
void SetInvitePartyResponseDelegate (FPartyInviteResponse const &OnInvitePartyResponse, FErrorHandler const &OnError=nullptr)
 set invite party response delegate
void SetInvitePartyJoinResponseDelegate (FPartyJoinResponse const &OnInvitePartyJoinResponse, FErrorHandler const &OnError=nullptr)
 set invite party join response
void SetInvitePartyRejectResponseDelegate (FPartyRejectResponse const &OnInvitePartyRejectResponse, FErrorHandler const &OnError=nullptr)
 set invite party reject response
void SetInvitePartyKickMemberResponseDelegate (FPartyKickResponse const &OnInvitePartyKickMemberResponse, FErrorHandler const &OnError=nullptr)
 set invite party kick member response
void SetPartyDataUpdateResponseDelegate (FPartyDataUpdateNotif const &OnPartyDataUpdateNotif)
 misnamed, same as SetPartyDataUpdateNotifDelegate
void SetPartyDataUpdateNotifDelegate (FPartyDataUpdateNotif const &OnPartyDataUpdateNotif)
 set party data update notif delegate
void SetPartyGenerateCodeResponseDelegate (FPartyGenerateCodeResponse const &OnPartyGenerateCodeResponse, FErrorHandler const &OnError=nullptr)
 generate party code response
void SetPartyGetCodeResponseDelegate (FPartyGetCodeResponse const &OnPartyGetCodeResponse, FErrorHandler const &OnError=nullptr)
 get party code response
void SetPartyDeleteCodeResponseDelegate (FPartyDeleteCodeResponse const &OnPartyDeleteCodeResponse, FErrorHandler const &OnError=nullptr)
 delete party code response
void SetPartyJoinViaCodeResponseDelegate (FPartyJoinViaCodeResponse const &OnPartyJoinViaCodeResponse, FErrorHandler const &OnError=nullptr)
 join party via party code response
void SetPartyPromoteLeaderResponseDelegate (FPartyPromoteLeaderResponse const &OnPartyPromoteLeaderResponse, FErrorHandler const &OnError=nullptr)
 set promote party leader response
void SetPartySendNotifResponseDelegate (FPartySendNotifResponse const &OnPartySendNotifResponse, FErrorHandler const &OnError=nullptr)
 set party send notification response
void SetPrivateMessageResponseDelegate (FPersonalChatResponse const &OnPrivateMessageResponse, FErrorHandler const &OnError=nullptr)
 set private message delegate
void SetPartyMessageResponseDelegate (FPartyChatResponse const &OnPartyMessageResponse, FErrorHandler const &OnError=nullptr)
 set party message response
void SetJoinChannelChatResponseDelegate (FJoinDefaultChannelChatResponse const &OnJoinDefaultChannelResponse, FErrorHandler const &OnError=nullptr)
 set join channel chat response
void SetChannelMessageResponseDelegate (FChannelChatResponse const &OnChannelMessageResponse, FErrorHandler const &OnError=nullptr)
 set channel message response
void SetChannelMessageNotifDelegate (FChannelChatNotif const &OnChannelMessageNotif)
 set channel message notif
FString SendSetPresenceStatus (EAvailability Availability, FString const &Activity)
 Set presence status on lobby service.
void SetUserPresenceResponseDelegate (FSetUserPresenceResponse const &OnSetUserPresenceResponse, FErrorHandler const &OnError=nullptr)
 set user presence response
void SetGetAllUserPresenceResponseDelegate (FGetAllFriendsStatusResponse const &OnGetAllUserPresenceResponse, FErrorHandler const &OnError=nullptr)
 (obsolete) misnamed, please use SetGetOnlineFriendsPresenceResponseDelegate
void SetGetOnlineFriendsPresenceResponseDelegate (FGetAllFriendsStatusResponse const &OnGetFriendsPresenceResponse, FErrorHandler const &OnError=nullptr)
 Set GetFriendsPresenceResponse delegate.
FString SendGetOnlineUsersRequest ()
 (Obsolete) the function name is misleading, please use SendGetOnlineFriendPresenceRequest().
FString SendGetOnlineFriendPresenceRequest ()
 Get list of online friends in the lobby server.
void SetRequestFriendsResponseDelegate (FRequestFriendsResponse const &OnRequestFriendsResponse, FErrorHandler const &OnError=nullptr)
 Set request for friends response.
void SetRequestFriendsByPublicIdResponseDelegate (FRequestFriendsResponse const &OnRequestFriendsResponse, FErrorHandler const &OnError=nullptr)
 Set request for friends by public ID response.
void SetUnfriendResponseDelegate (FUnfriendResponse const &OnUnfriendResponse, FErrorHandler const &OnError=nullptr)
 Set unfriend response.
void SetListOutgoingFriendsResponseDelegate (FListOutgoingFriendsResponse const &OnListOutgoingFriendsResponse, FErrorHandler const &OnError=nullptr)
 Set list outgoing request of friend response.
void SetListOutgoingFriendsWithTimeResponseDelegate (FListOutgoingFriendsWithTimeResponse const &OnListOutgoingFriendsWithTimeResponse, FErrorHandler const &OnError=nullptr)
 Set list outgoing request of friend response with time.
void SetCancelFriendsResponseDelegate (FCancelFriendsResponse const &OnCancelFriendsResponse, FErrorHandler const &OnError=nullptr)
 Set cancel request of friend response.
void SetListIncomingFriendsResponseDelegate (FListIncomingFriendsResponse const &OnListIncomingFriendsResponse, FErrorHandler const &OnError=nullptr)
 Set incoming request of friend response.
void SetListIncomingFriendsWithTimeResponseDelegate (FListIncomingFriendsWithTimeResponse const &OnListIncomingFriendsWithTimeResponse, FErrorHandler const &OnError=nullptr)
 Set incoming request of friend response with time.
void SetAcceptFriendsResponseDelegate (FAcceptFriendsResponse const &OnAcceptFriendsResponse, FErrorHandler const &OnError=nullptr)
 Set accept friend response.
void SetRejectFriendsResponseDelegate (FRejectFriendsResponse const &OnRejectFriendsResponse, FErrorHandler const &OnError=nullptr)
 Set reject request for friend response.
void SetLoadFriendListResponseDelegate (FLoadFriendListResponse const &OnLoadFriendListResponse, FErrorHandler const &OnError=nullptr)
 Set load friend list response.
void SetGetFriendshipStatusResponseDelegate (FGetFriendshipStatusResponse const &OnGetFriendshipStatusResponse, FErrorHandler const &OnError=nullptr)
 Set get friendship status response.
void SetBlockPlayerResponseDelegate (FBlockPlayerResponse const &OnBlockPlayerResponse, FErrorHandler const &OnError=nullptr)
 set unblock player responses
void SetUnblockPlayerResponseDelegate (FUnblockPlayerResponse const &OnUnblockPlayerResponse, FErrorHandler const &OnError=nullptr)
 set unblock player responses
void SetBlockPlayerNotifDelegate (FBlockPlayerNotif const &OnBlockPlayerNotif)
 set a function triggered when user is blocked
void SetUnblockPlayerNotifDelegate (FUnblockPlayerNotif const &OnUnblockPlayerNotif)
 set a function triggered when user is unblocked
void SetErrorNotifDelegate (FErrorNotif const &OnErrorNotif)
 set a function triggered when there is a general lobby error notification.
void SetSignalingP2PDelegate (FSignalingP2P const &OnSignalingP2P)
 Set SignalingP2P delegate.
void SetSetSessionAttributeDelegate (FSetSessionAttributeResponse const &OnSetSessionAttributeResponse, FErrorHandler const &OnError=nullptr)
 Set SetSessionAttribute delegate.
void SetGetSessionAttributeDelegate (FGetSessionAttributeResponse const &OnGetSessionAttributeResponse, FErrorHandler const &OnError=nullptr)
 Set GetSessionAttribute delegate.
void SetGetAllSessionAttributeDelegate (FGetAllSessionAttributeResponse const &OnGetAllSessionAttributeResponse, FErrorHandler const &OnError=nullptr)
 Set SetSessionAttribute delegate.
void SetRefreshTokenDelegate (const FRefreshTokenResponse &OnRefreshTokenResponse, FErrorHandler const &OnError=nullptr)
 Set SetSessionAttribute delegate.
void SetChangeUserRegionDelegate (FChangeUserRegionResponse const &OnChangeUserRegionResponse, FErrorHandler const &OnError=nullptr)
 Set delegate for set user region response.
FDelegateHandle AddOneTimeCodeLinkedNotifDelegate (THandler< FAccelByteModelsOneTimeCodeLinked > const &OneTimeCodeLinkedNotifDelegate)
bool RemoveOneTimeCodeLinkedNotifDelegate (FDelegateHandle const &OneTimeCodeLinkedNotifDelegateHandle)
FDelegateHandle AddEntitlementUpdatedNotifDelegate (THandler< FAccelByteModelsEntitlementUpdatedNotification > const &EntitlementUpdatedNotifDelegate)
 Add a function triggered when there is an entitlement updated notification.
bool RemoveEntitlementUpdatedNotifDelegate (FDelegateHandle const &EntitlementUpdatedNotifDelegateHandle)
 Remove a delegate from wallet balance changed notification.
FDelegateHandle AddWalletBalanceChangedNotifDelegate (THandler< FAccelByteModelsWalletBalanceChangedNotification > const &WalletBalanceChangedNotifDelegate)
 Add a function triggered when there is a wallet balance changed notification.
bool RemoveWalletBalanceChangedNotifDelegate (FDelegateHandle const &WalletBalanceChangedNotifDelegateHandle)
 Remove a delegate from wallet balance changed notification.
FDelegateHandle AddWalletStatusChangedNotifDelegate (THandler< FAccelByteModelsWalletStatusChangedNotification > const &WalletStatusChangedNotifDelegate)
 Add a function triggered when there is a wallet status changed notification.
bool RemoveWalletStatusChangedNotifDelegate (FDelegateHandle const &WalletStatusChangedNotifDelegateHandle)
 Remove a delegate from wallet status changed notification.
FAccelByteTaskWPtr BulkFriendRequest (FAccelByteModelsBulkFriendsRequest const &UserIds, FVoidHandler const &OnSuccess, FErrorHandler const &OnError)
 Bulk add friend(s), don't need any confirmation from the player.
FAccelByteTaskWPtr SyncThirdPartyFriends (FAccelByteModelsSyncThirdPartyFriendsRequest const &Request, THandler< TArray< FAccelByteModelsSyncThirdPartyFriendsResponse > > const &OnSuccess, FErrorHandler const &OnError)
 Sync platform specific friend list to AccelByte friend list. This will automatically add platform specific friend list to AccelByte friend list if the friends already linked their account to AccelByte service.
FAccelByteTaskWPtr SyncThirdPartyBlockList (FAccelByteModelsSyncThirdPartyBlockListRequest const &Request, THandler< TArray< FAccelByteModelsSyncThirdPartyBlockListResponse > > const &OnSuccess, FErrorHandler const &OnError)
 Sync third party platform block list to the AccelByte block list. Automatically will add players from the platform block list to the AccelByte block list, if the blocked player has linked their account with an AccelByte account.
FAccelByteTaskWPtr GetPartyData (FString const &PartyId, THandler< FAccelByteModelsPartyData > const &OnSuccess, FErrorHandler const &OnError)
 Get party data by party ID.
FAccelByteTaskWPtr BulkGetUserPresence (TArray< FString > const &UserIds, THandler< FAccelByteModelsBulkUserStatusNotif > const &OnSuccess, FErrorHandler const &OnError, bool CountOnly=false)
 Bulk Get User(s) Presence, can get specific user's presence status not limited to friend.
FAccelByteTaskWPtr BulkGetUserPresenceV2 (TArray< FString > const &UserIds, THandler< FAccelByteModelsBulkUserStatusNotif > const &OnSuccess, FErrorHandler const &OnError, bool CountOnly=false)
 Bulk Get User(s) Presence, can get specific user's presence status not limited to friend.
FAccelByteTaskWPtr GetPartyStorage (FString const &PartyId, THandler< FAccelByteModelsPartyDataNotif > const &OnSuccess, FErrorHandler const &OnError)
 Get party storage (attributes) by party ID.
FAccelByteTaskWPtr GetListOfBlockedUsers (FString const &UserId, THandler< FAccelByteModelsListBlockedUserResponse > OnSuccess, FErrorHandler const &OnError)
 List Blocked User's Id.
FAccelByteTaskWPtr GetListOfBlockedUsers (THandler< FAccelByteModelsListBlockedUserResponse > const &OnSuccess, FErrorHandler const &OnError)
 List Blocked User's Id, override of GetListOfBlockedUser, will get current user's List of Blocked User's Id.
FAccelByteTaskWPtr GetListOfBlockers (FString const &UserId, THandler< FAccelByteModelsListBlockerResponse > const &OnSuccess, FErrorHandler const &OnError)
 List Id of Player that blocks an User.
FAccelByteTaskWPtr GetListOfBlockers (THandler< FAccelByteModelsListBlockerResponse > const &OnSuccess, FErrorHandler const &OnError)
 List Blockers User's Id, override of GetListOfBlocker, will get current user's List of Blocker User's Id.
FAccelByteTaskWPtr SendNotificationToUser (FString const &SendToUserId, FAccelByteModelsFreeFormNotificationRequest const &Message, bool bAsync, FVoidHandler const &OnSuccess, FErrorHandler const &OnError)
 (DEPRECATED) Send a freeform notification message to a user
FAccelByteTaskWPtr WritePartyStorage (FString const &PartyId, TFunction< FJsonObjectWrapper(FJsonObjectWrapper)> const &PayloadModifier, THandler< FAccelByteModelsPartyDataNotif > const &OnSuccess, FErrorHandler const &OnError, uint32 RetryAttempt=1)
 Write party storage (attributes) data to the targeted party ID. Beware: Object will not be write immediately, please take care of the original object until it written.
void SetTokenGenerator (TSharedPtr< IAccelByteTokenGenerator > const &TokenGenerator)
 Set token generator to be used when trying to connect to lobby using ownership token.
void ChangeUserRegion (FString const &Region)
 Change current user region for metric.
FAccelByteTaskWPtr GetNotifications (THandler< FAccelByteModelsGetUserNotificationsResponse > const &OnSuccess, FErrorHandler const &OnError, FDateTime const &StartTime=FDateTime{0}, FDateTime const &EndTime=FDateTime{0}, int32 Offset=0, int32 Limit=25)
 Get list of notifications from current user from specified time.
TSharedPtr< FAccelByteKeyLockNotifications ()
 Lock notifications that has SequenceID. Next notification received won't be broadcasted until key is destroyed.
void Startup ()
 Startup module.
bool HasUnbanNotificationsScheduled () const
 Checks whether any future unban notifications are scheduled.
 DECLARE_DELEGATE_OneParam (FMatchmakingResponse, FAccelByteModelsMatchmakingResponse const &)
 delegate for handling matchmaking response
 DECLARE_DELEGATE_OneParam (FReadyConsentResponse, FAccelByteModelsReadyConsentRequest const &)
 delegate for handling ready consent response
 DECLARE_DELEGATE_OneParam (FRejectConsentResponse, FAccelByteModelsRejectConsentRequest const &)
 delegate for handling reject consent response
 DECLARE_DELEGATE_OneParam (FMatchmakingNotif, FAccelByteModelsMatchmakingNotice const &)
 delegate for handling matchmaking notification
 DECLARE_DELEGATE_OneParam (FReadyConsentNotif, FAccelByteModelsReadyConsentNotice const &)
 DECLARE_DELEGATE_OneParam (FRejectConsentNotif, FAccelByteModelsRejectConsentNotice const &)
 delegate for handling reject consent notification
 DECLARE_DELEGATE_OneParam (FRematchmakingNotif, FAccelByteModelsRematchmakingNotice const &)
 delegate for handling rematchmaking notification
 DECLARE_DELEGATE_OneParam (FDsNotif, FAccelByteModelsDsNotice const &)
 delegate for handling DS notification
FString SendStartMatchmaking (FString const &GameMode, FString const &ServerName, FString const &ClientVersion=TEXT(""), TArray< TPair< FString, float > > const &Latencies={}, TMap< FString, FString > const &PartyAttributes={}, TArray< FString > const &TempPartyUserIds={}, TArray< FString > const &ExtraAttributes={})
 start the matchmaking
FString SendStartMatchmaking (FString const &GameMode, TArray< FString > const &TempPartyUserIds, FString const &ServerName=TEXT(""), FString const &ClientVersion=TEXT(""), TArray< TPair< FString, float > > const &Latencies={}, TMap< FString, FString > const &PartyAttributes={}, TArray< FString > const &ExtraAttributes={})
 start the matchmaking
FString SendStartMatchmaking (FString const &GameMode, TMap< FString, FString > const &PartyAttributes, FString const &ServerName=TEXT(""), FString const &ClientVersion=TEXT(""), TArray< TPair< FString, float > > const &Latencies={}, TArray< FString > const &TempPartyUserIds={}, TArray< FString > const &ExtraAttributes={})
 start the matchmaking
FString SendStartMatchmaking (FString const &GameMode, TMap< FString, FString > const &PartyAttributes, TArray< FString > const &TempPartyUserIds, FString const &ServerName=TEXT(""), FString const &ClientVersion=TEXT(""), TArray< TPair< FString, float > > const &Latencies={}, TArray< FString > const &ExtraAttributes={})
 start the matchmaking
void SetOnMatchmakingSuccessInitQosScheduler ()
 On success, we poll Latencies (if Settings allows us to).
FString SendStartMatchmaking (FString const &GameMode, FMatchmakingOptionalParams const &OptionalParams={})
 start the matchmaking
FString SendCancelMatchmaking (FString const &GameMode, bool IsTempParty=false)
 cancel the currently running matchmaking process
FString SendReadyConsentRequest (FString const &MatchId)
 send ready consent request
FString SendRejectConsentRequest (FString const &MatchId)
 send reject consent request
FString RequestDS (FString const &SessionID, FString const &GameMode, FString const &ClientVersion, FString const &Region, FString const &Deployment, FString const &ServerName=TEXT(""))
 Request Dedicated custom server.
void UnbindMatchmakingNotifEvents ()
 Unbind all matchmaking notif delegates set previously.
void UnbindMatchmakingResponseEvents ()
 Unbind all matchmaking response delegates set previously.
void SetStartMatchmakingResponseDelegate (FMatchmakingResponse const &OnMatchmakingStart, FErrorHandler const &OnError=nullptr)
 set start matchmaking response
void SetCancelMatchmakingResponseDelegate (FMatchmakingResponse const &OnMatchmakingCancel, FErrorHandler const &OnError=nullptr)
 set cancel matchmaking notification
void SetReadyConsentResponseDelegate (FReadyConsentResponse const &OnReadyConsentResponse, FErrorHandler const &OnError=nullptr)
 set ready consent response notification
void SetRejectConsentResponseDelegate (FRejectConsentResponse const &OnRejectConsentResponse, FErrorHandler const &OnError=nullptr)
 set reject consent response notification
void SetMatchmakingNotifDelegate (FMatchmakingNotif const &OnMatchmakingNotification)
 set matchmaking notification
void SetReadyConsentNotifDelegate (FReadyConsentNotif const &OnReadyConsentNotification)
 set ready consent notification
void SetRejectConsentNotifDelegate (FRejectConsentNotif const &OnRejectConsentNotification)
 set reject consent notification
void SetRematchmakingNotifDelegate (FRematchmakingNotif const &OnRematchmakingNotification)
 set rematchmaking notification
void SetDsNotifDelegate (FDsNotif const &OnDsNotification)
 set ready consent notification
void SetCreateDSDelegate (FBaseResponse const &OnCreateDSResponse, FErrorHandler const &OnError=nullptr)
 set create DS response delegate
Public Member Functions inherited from AccelByte::FApiBase
 FApiBase (Credentials const &InCredentialsRef, Settings const &InSettingsRef, FHttpRetrySchedulerBase &InHttpRef, TSharedPtr< AccelByte::FApiClient, ESPMode::ThreadSafe > const &InApiClient)
 FApiBase (Credentials const &InCredentialsRef, Settings const &InSettingsRef, FHttpRetrySchedulerBase &InHttpRef, FAccelBytePlatformPtr const &InAccelBytePlatform)
void SetApiClient (TSharedPtr< AccelByte::FApiClient, ESPMode::ThreadSafe > const &InApiClient)
Public Member Functions inherited from AccelByte::IWebsocketConfigurableReconnectStrategy
void SetDefaultReconnectionStrategy (const FReconnectionStrategy &Strategy)
FReconnectionStrategyGetDefaultReconnectionStrategy ()
TMap< int32, FReconnectionStrategy > & GetReconnectionStrategyDictionary ()
void SetSpecificReconnectionStrategy (EWebsocketClosureCodeForSpecificRetry WebsocketDisconnectionCode, const FReconnectionStrategy &Strategy)
void SetSpecificReconnectionStrategy (int32 RawWebsocketConnectionCode, const FReconnectionStrategy &Strategy)

Static Public Member Functions

static FString LobbyMessageToJson (FString const &Message)
static void ClearLobbyErrorMessages ()
static FString GetServerLatenciesJsonStr (TArray< TPair< FString, float > > const &SelectedLatencies)
 Serialize the Qos Latencies obj into a stringified json object.

Additional Inherited Members

Protected Member Functions inherited from AccelByte::FApiBase
template<typename T>
bool ValidateAccelByteId (FString const &Id, EAccelByteIdHypensRule HypenRule, FString const &ErrorMessage, T const &OnError)
Protected Attributes inherited from AccelByte::FApiBase
TSharedRef< Credentials const, ESPMode::ThreadSafe > CredentialsRef
Settings const & SettingsRef
FHttpRetrySchedulerBaseHttpRef
FHttpClient HttpClient
FAccelBytePlatformPtr AccelBytePlatformPtr

Detailed Description

Lobby API for chatting and party management. Unlike other servers which use HTTP, Lobby server uses WebSocket (RFC 6455).

Member Function Documentation

◆ AcceptFriendRequest()

FAccelByteTaskWPtr AccelByte::Api::Lobby::AcceptFriendRequest ( FString const & UserId,
FVoidHandler const & OnSuccess,
FErrorHandler const & OnError )

Accept friend request from other user.

Parameters
UserIdTargeted user ID.
OnSuccessThis will be called when the operation succeeded.
OnErrorThis will be called when the operation failed.
Returns
AccelByteTask object to track and cancel the ongoing API operation.

◆ AddEntitlementUpdatedNotifDelegate()

FDelegateHandle AccelByte::Api::Lobby::AddEntitlementUpdatedNotifDelegate ( THandler< FAccelByteModelsEntitlementUpdatedNotification > const & EntitlementUpdatedNotifDelegate)
inline

Add a function triggered when there is an entitlement updated notification.

Parameters
EntitlementUpdatedNotifDelegateDelegate that will be added.

◆ AddMessageNotifBroadcasterDelegate()

FDelegateHandle AccelByte::Api::Lobby::AddMessageNotifBroadcasterDelegate ( FNotifBroadcaster const & OnNotificationBroadcasterMessage)

Set a trigger function when receiving a notification message.

Parameters
OnNotificationBroadcasterMessagereturn models called FAccelByteModelsNotificationMessage

◆ AddMessageNotifDelegate()

FDelegateHandle AccelByte::Api::Lobby::AddMessageNotifDelegate ( FMessageNotif const & OnNotificationMessage)

Add a delegate when receiving a notification message.

Parameters
OnNotificationMessagereturn models called FAccelByteModelsNotificationMessage

◆ AddWalletBalanceChangedNotifDelegate()

FDelegateHandle AccelByte::Api::Lobby::AddWalletBalanceChangedNotifDelegate ( THandler< FAccelByteModelsWalletBalanceChangedNotification > const & WalletBalanceChangedNotifDelegate)
inline

Add a function triggered when there is a wallet balance changed notification.

Parameters
WalletBalanceChangedNotifDelegateDelegate that will be added.

◆ AddWalletStatusChangedNotifDelegate()

FDelegateHandle AccelByte::Api::Lobby::AddWalletStatusChangedNotifDelegate ( THandler< FAccelByteModelsWalletStatusChangedNotification > const & WalletStatusChangedNotifDelegate)
inline

Add a function triggered when there is a wallet status changed notification.

Parameters
WalletStatusChangedNotifDelegateDelegate that will be added.

◆ BlockPlayer() [1/2]

void AccelByte::Api::Lobby::BlockPlayer ( FString const & UserId)

Block specified player from being able to do certain action against current user the specified player will be removed from friend list.

Action that blocked player can't do : -Add Friend -Direct Chat -Invite to Party -Invite to Group -Matchmaking as one alliance

Additional Limitation : Blocked Player can't access blocker/current user's user ID

Parameters
UserIdthe specified player's user ID. (Target to block)

◆ BlockPlayer() [2/2]

FAccelByteTaskWPtr AccelByte::Api::Lobby::BlockPlayer ( FString const & UserId,
FVoidHandler const & OnSuccess,
FErrorHandler const & OnError )

Block specified player from being able to do certain action against current user the specified player will be removed from friend list.

Action that blocked player can't do : -Add Friend -Direct Chat -Invite to Party -Invite to Group -Matchmaking as one alliance

Additional Limitation : Blocked Player can't access blocker/current user's user ID

Parameters
UserIdTargeted user ID.
OnSuccessThis will be called when the operation succeeded.
OnErrorThis will be called when the operation failed.
Returns
AccelByteTask object to track and cancel the ongoing API operation.

◆ BulkFriendRequest()

FAccelByteTaskWPtr AccelByte::Api::Lobby::BulkFriendRequest ( FAccelByteModelsBulkFriendsRequest const & UserIds,
FVoidHandler const & OnSuccess,
FErrorHandler const & OnError )

Bulk add friend(s), don't need any confirmation from the player.

Parameters
UserIdsthe list of UserId you want to make friend with.
OnSuccessThis will be called when the operation succeeded.
OnErrorThis will be called when the operation failed.
Returns
AccelByteTask object to track and cancel the ongoing API operation.

◆ BulkGetUserPresence()

FAccelByteTaskWPtr AccelByte::Api::Lobby::BulkGetUserPresence ( TArray< FString > const & UserIds,
THandler< FAccelByteModelsBulkUserStatusNotif > const & OnSuccess,
FErrorHandler const & OnError,
bool CountOnly = false )

Bulk Get User(s) Presence, can get specific user's presence status not limited to friend.

Parameters
UserIdsthe list of UserId you want to request.
OnSuccessThis will be called when the operation succeeded. The result is a FAccelByteModelsBulkUserStatusNotif.
OnErrorThis will be called when the operation failed.
CountOnlyWill only return the status count, without the user's data when set to true.
Returns
AccelByteTask object to track and cancel the ongoing API operation.

◆ BulkGetUserPresenceV2()

FAccelByteTaskWPtr AccelByte::Api::Lobby::BulkGetUserPresenceV2 ( TArray< FString > const & UserIds,
THandler< FAccelByteModelsBulkUserStatusNotif > const & OnSuccess,
FErrorHandler const & OnError,
bool CountOnly = false )

Bulk Get User(s) Presence, can get specific user's presence status not limited to friend.

Parameters
UserIdsthe list of UserId you want to request.
OnSuccessThis will be called when the operation succeeded. The result is a FAccelByteModelsBulkUserStatusNotif.
OnErrorThis will be called when the operation failed.
CountOnlyWill only return the status count, without the user's data when set to true.
Returns
AccelByteTask object to track and cancel the ongoing API operation.

◆ CancelFriendRequest() [1/2]

void AccelByte::Api::Lobby::CancelFriendRequest ( FString const & UserId)

Send cancel friend request.

Parameters
UserIdTargeted user ID.

◆ CancelFriendRequest() [2/2]

FAccelByteTaskWPtr AccelByte::Api::Lobby::CancelFriendRequest ( FString const & UserId,
FVoidHandler const & OnSuccess,
FErrorHandler const & OnError )

Cancel outgoing friend request.

Parameters
UserIdTargeted user ID.
OnSuccessThis will be called when the operation succeeded.
OnErrorThis will be called when the operation failed.
Returns
AccelByteTask object to track and cancel the ongoing API operation.

◆ ChangeUserRegion()

void AccelByte::Api::Lobby::ChangeUserRegion ( FString const & Region)

Change current user region for metric.

Parameters
RegionThe region of current user based on lowest ping to QOS servers.

◆ GetFriendshipStatus() [1/2]

void AccelByte::Api::Lobby::GetFriendshipStatus ( FString const & UserId)

Send get friendship status request.

Parameters
UserIdTargeted user ID.

◆ GetFriendshipStatus() [2/2]

FAccelByteTaskWPtr AccelByte::Api::Lobby::GetFriendshipStatus ( FString const & UserId,
THandler< FAccelByteModelsFriendshipStatusResponse > const & OnSuccess,
FErrorHandler const & OnError )

Get friendship status of current user with other user.

Parameters
UserIdTargeted user ID.
OnSuccessThis will be called when the operation succeeded.
OnErrorThis will be called when the operation failed.
Returns
AccelByteTask object to track and cancel the ongoing API operation.

◆ GetListOfBlockedUsers() [1/2]

FAccelByteTaskWPtr AccelByte::Api::Lobby::GetListOfBlockedUsers ( FString const & UserId,
THandler< FAccelByteModelsListBlockedUserResponse > OnSuccess,
FErrorHandler const & OnError )

List Blocked User's Id.

Parameters
UserIdUser Id of the Player.
OnSuccessThis will be called when the operation succeeded. Will return FAccelByteModelsListBlockedUserResponse model.
OnErrorThis will be called when the operation failed.
Returns
AccelByteTask object to track and cancel the ongoing API operation.

◆ GetListOfBlockedUsers() [2/2]

FAccelByteTaskWPtr AccelByte::Api::Lobby::GetListOfBlockedUsers ( THandler< FAccelByteModelsListBlockedUserResponse > const & OnSuccess,
FErrorHandler const & OnError )

List Blocked User's Id, override of GetListOfBlockedUser, will get current user's List of Blocked User's Id.

Parameters
OnSuccessThis will be called when the operation succeeded. Will return FAccelByteModelsListBlockedUserResponse model.
OnErrorThis will be called when the operation failed.
Returns
AccelByteTask object to track and cancel the ongoing API operation.

◆ GetListOfBlockers() [1/2]

FAccelByteTaskWPtr AccelByte::Api::Lobby::GetListOfBlockers ( FString const & UserId,
THandler< FAccelByteModelsListBlockerResponse > const & OnSuccess,
FErrorHandler const & OnError )

List Id of Player that blocks an User.

Parameters
UserIdUser Id of the Player.
OnSuccessThis will be called when the operation succeeded. Will return FAccelByteModelsListBlockerResponse model.
OnErrorThis will be called when the operation failed.
Returns
AccelByteTask object to track and cancel the ongoing API operation.

◆ GetListOfBlockers() [2/2]

FAccelByteTaskWPtr AccelByte::Api::Lobby::GetListOfBlockers ( THandler< FAccelByteModelsListBlockerResponse > const & OnSuccess,
FErrorHandler const & OnError )

List Blockers User's Id, override of GetListOfBlocker, will get current user's List of Blocker User's Id.

Parameters
OnSuccessThis will be called when the operation succeeded. Will return FAccelByteModelsListBlockerResponse model.
OnErrorThis will be called when the operation failed.
Returns
AccelByteTask object to track and cancel the ongoing API operation.

◆ GetNotifications()

FAccelByteTaskWPtr AccelByte::Api::Lobby::GetNotifications ( THandler< FAccelByteModelsGetUserNotificationsResponse > const & OnSuccess,
FErrorHandler const & OnError,
FDateTime const & StartTime = FDateTime{0},
FDateTime const & EndTime = FDateTime{0},
int32 Offset = 0,
int32 Limit = 25 )

Get list of notifications from current user from specified time.

Parameters
OnSuccessThis will be called when the operation succeeded. Will return FAccelByteModelsGetUserNotificationsResponse model.
OnErrorThis will be called when the operation failed.
StartTime[Optional] The beginning sequenceID to query.
EndTime[Optional] The end sequenceID to query.
Offset[Optional] The offset of the result. Default value is 0.
Limit[Optional] The limit of the result. Default value is 20.
Returns
AccelByteTask object to track and cancel the ongoing API operation.

◆ GetPartyData()

FAccelByteTaskWPtr AccelByte::Api::Lobby::GetPartyData ( FString const & PartyId,
THandler< FAccelByteModelsPartyData > const & OnSuccess,
FErrorHandler const & OnError )

Get party data by party ID.

Parameters
PartyIdTargeted party Id.
OnSuccessThis will be called when the operation succeeded. Will return FAccelByteModelsPartyData model.
OnErrorThis will be called when the operation failed.
Returns
AccelByteTask object to track and cancel the ongoing API operation.

◆ GetPartyStorage()

FAccelByteTaskWPtr AccelByte::Api::Lobby::GetPartyStorage ( FString const & PartyId,
THandler< FAccelByteModelsPartyDataNotif > const & OnSuccess,
FErrorHandler const & OnError )

Get party storage (attributes) by party ID.

Parameters
PartyIdTargeted party Id.
OnSuccessThis will be called when the operation succeeded. Will return FAccelByteModelsPartyDataNotif model.
OnErrorThis will be called when the operation failed.
Returns
AccelByteTask object to track and cancel the ongoing API operation.

◆ GetServerLatenciesJsonStr()

FString AccelByte::Api::Lobby::GetServerLatenciesJsonStr ( TArray< TPair< FString, float > > const & SelectedLatencies)
static

Serialize the Qos Latencies obj into a stringified json object.

  • Multiple regions are possible (hence the TArray).
    Parameters
    SelectedLatenciesArray of latencies pair, key is region name and value is latency in ms.
    Returns

◆ GetSessionAttribute()

FString AccelByte::Api::Lobby::GetSessionAttribute ( FString const & Key)

Get user attribute from lobby session.

Parameters
Keythe attribute's key.

◆ IsConnected()

bool AccelByte::Api::Lobby::IsConnected ( ) const

Check whether the websocket is currently connected to the Lobby server.

Returns
true if it's connected, false otherwise.

◆ IsReconnecting()

bool AccelByte::Api::Lobby::IsReconnecting ( ) const

Check whether the websocket is currently trying to reconnect to the Lobby server.

Returns
true if it's connected, false otherwise.

◆ LockNotifications()

TSharedPtr< FAccelByteKey > AccelByte::Api::Lobby::LockNotifications ( )

Lock notifications that has SequenceID. Next notification received won't be broadcasted until key is destroyed.

Returns
Key of the lock, while key exist next notifications won't be broadcasted.

◆ QueryFriendList()

FAccelByteTaskWPtr AccelByte::Api::Lobby::QueryFriendList ( THandler< FAccelByteModelsQueryFriendListResponse > const & OnSuccess,
FErrorHandler const & OnError,
int32 Offset = 0,
int32 Limit = 20 )

Query the friend list of current user. The result is friend ids in pagination format.

Parameters
OnSuccessThis will be called when the operation succeeded.
OnErrorThis will be called when the operation failed.
OffsetThe offset of the result. Default value is 0.
LimitThe limit of the result. Default value is 20.
Returns
AccelByteTask object to track and cancel the ongoing API operation.

◆ QueryIncomingFriendRequest()

FAccelByteTaskWPtr AccelByte::Api::Lobby::QueryIncomingFriendRequest ( THandler< FAccelByteModelsIncomingFriendRequests > const & OnSuccess,
FErrorHandler const & OnError,
int32 Offset = 0,
int32 Limit = 20 )

Query the incoming friend requests for current user. The result is friend requests with requested time info in pagination format.

Parameters
OnSuccessThis will be called when the operation succeeded.
OnErrorThis will be called when the operation failed.
OffsetThe offset of the result. Default value is 0.
LimitThe limit of the result. Default value is 20.
Returns
AccelByteTask object to track and cancel the ongoing API operation.

◆ QueryOutgoingFriendRequest()

FAccelByteTaskWPtr AccelByte::Api::Lobby::QueryOutgoingFriendRequest ( THandler< FAccelByteModelsOutgoingFriendRequests > const & OnSuccess,
FErrorHandler const & OnError,
int32 Offset = 0,
int32 Limit = 20 )

Query the outgoing friend requests for current user. The result is friend requests with requested time info in pagination format.

Parameters
OnSuccessThis will be called when the operation succeeded.
OnErrorThis will be called when the operation failed.
OffsetThe offset of the result. Default value is 0.
LimitThe limit of the result. Default value is 20.
Returns
AccelByteTask object to track and cancel the ongoing API operation.

◆ RefreshToken()

FString AccelByte::Api::Lobby::RefreshToken ( FString const & AccessToken)

Refresh access token used in lobby.

Parameters
AccessTokenNew access token to use.

◆ RejectFriendRequest()

FAccelByteTaskWPtr AccelByte::Api::Lobby::RejectFriendRequest ( FString const & UserId,
FVoidHandler const & OnSuccess,
FErrorHandler const & OnError )

Reject friend request from other user.

Parameters
UserIdTargeted user ID.
OnSuccessThis will be called when the operation succeeded.
OnErrorThis will be called when the operation failed.
Returns
AccelByteTask object to track and cancel the ongoing API operation.

◆ RemoveEntitlementUpdatedNotifDelegate()

bool AccelByte::Api::Lobby::RemoveEntitlementUpdatedNotifDelegate ( FDelegateHandle const & EntitlementUpdatedNotifDelegateHandle)
inline

Remove a delegate from wallet balance changed notification.

Parameters
EntitlementUpdatedNotifDelegateHandleDelegateHandle that will be removed.

◆ RemoveMessageNotifBroadcasterDelegate()

bool AccelByte::Api::Lobby::RemoveMessageNotifBroadcasterDelegate ( FDelegateHandle const & OnNotificationBroadcasterDelegate)

Remove a trigger function when receiving a notification message.

Parameters
OnNotificationBroadcasterDelegateDelegate handle to be removed

◆ RemoveWalletBalanceChangedNotifDelegate()

bool AccelByte::Api::Lobby::RemoveWalletBalanceChangedNotifDelegate ( FDelegateHandle const & WalletBalanceChangedNotifDelegateHandle)
inline

Remove a delegate from wallet balance changed notification.

Parameters
WalletBalanceChangedNotifDelegateHandleDelegateHandle that will be removed.

◆ RemoveWalletStatusChangedNotifDelegate()

bool AccelByte::Api::Lobby::RemoveWalletStatusChangedNotifDelegate ( FDelegateHandle const & WalletStatusChangedNotifDelegateHandle)
inline

Remove a delegate from wallet status changed notification.

Parameters
WalletStatusChangedNotifDelegateHandleDelegateHandle that will be removed.

◆ RequestDS()

FString AccelByte::Api::Lobby::RequestDS ( FString const & SessionID,
FString const & GameMode,
FString const & ClientVersion,
FString const & Region,
FString const & Deployment,
FString const & ServerName = TEXT("") )

Request Dedicated custom server.

Parameters
SessionIDSession ID of the game session.
GameModeThe mode that party member want to play.
ClientVersionThe version of DS, fill it blank to choose the default version.
RegionThe region where the party member want to play.
DeploymentThe deployment mode where the party member requested
ServerNameThe Local DS name, fill it blank if you don't use Local DS.

◆ RequestFriend()

void AccelByte::Api::Lobby::RequestFriend ( FString const & UserId)

Send request friend request.

Parameters
UserIdTargeted user ID.

◆ RequestFriendByPublicId()

void AccelByte::Api::Lobby::RequestFriendByPublicId ( FString const & PublicId)

Send friend request by public ID.

Parameters
PublicIdTargeted user's PublicId.

◆ SendAcceptInvitationRequest()

FString AccelByte::Api::Lobby::SendAcceptInvitationRequest ( FString const & PartyId,
FString const & InvitationToken )

Accept a party invitation.

Parameters
PartyIdParty ID from the invitation notice.
InvitationTokenRandom string from the invitation notice.

◆ SendCancelMatchmaking()

FString AccelByte::Api::Lobby::SendCancelMatchmaking ( FString const & GameMode,
bool IsTempParty = false )

cancel the currently running matchmaking process

Parameters
GameModeThe mode that party member want to cancel.
IsTempPartyIs canceling matchmaking that was started using temporary party.

◆ SendFriendRequest()

FAccelByteTaskWPtr AccelByte::Api::Lobby::SendFriendRequest ( FString const & UserId,
FVoidHandler const & OnSuccess,
FErrorHandler const & OnError )

Send friend request to other user by user id.

Parameters
UserIdTargeted user ID.
OnSuccessThis will be called when the operation succeeded.
OnErrorThis will be called when the operation failed.
Returns
AccelByteTask object to track and cancel the ongoing API operation.

◆ SendFriendRequestByPublicId()

FAccelByteTaskWPtr AccelByte::Api::Lobby::SendFriendRequestByPublicId ( FString const & PublicId,
FVoidHandler const & OnSuccess,
FErrorHandler const & OnError )

Send friend request to other user by public id.

Parameters
PublicIdTargeted public ID.
OnSuccessThis will be called when the operation succeeded.
OnErrorThis will be called when the operation failed.
Returns
AccelByteTask object to track and cancel the ongoing API operation.

◆ SendInviteToPartyRequest()

FString AccelByte::Api::Lobby::SendInviteToPartyRequest ( FString const & UserId)

Invite a user to party.

Parameters
UserIdThe target user ID to be invited.

◆ SendKickPartyMemberRequest()

FString AccelByte::Api::Lobby::SendKickPartyMemberRequest ( FString const & UserId)

Kick a party member.

Parameters
UserIdThe target user ID to be kicked.

◆ SendNotificationToPartyMember()

FString AccelByte::Api::Lobby::SendNotificationToPartyMember ( FString const & Topic,
FString const & Payload )

Send notification to party member.

Parameters
TopicThe topic of the request. Can use this as ID to know how to marshal the payload
PayloadThe Payload of the request. Can be JSON string

◆ SendNotificationToUser()

FAccelByteTaskWPtr AccelByte::Api::Lobby::SendNotificationToUser ( FString const & SendToUserId,
FAccelByteModelsFreeFormNotificationRequest const & Message,
bool bAsync,
FVoidHandler const & OnSuccess,
FErrorHandler const & OnError )

(DEPRECATED) Send a freeform notification message to a user

Parameters
SendToUserIduser id to send this notification message
Messagenotification message
bAsyncshou;d the message be sent even if the receiving user is offline?
OnSuccessThis will be called when the operation succeeded. Will return FAccelByteModelsListBlockerResponse model.
OnErrorThis will be called when the operation failed.
Returns
AccelByteTask object to track and cancel the ongoing API operation.

◆ SendPartyJoinViaCodeRequest()

FString AccelByte::Api::Lobby::SendPartyJoinViaCodeRequest ( FString const & partyCode)

Join Party via party code.

Parameters
partyCodeThe target party Code to be joined.

◆ SendPartyMessage()

FString AccelByte::Api::Lobby::SendPartyMessage ( FString const & Message)

Send a message to other party members.

Parameters
MessageMessage to be sent.

◆ SendPartyPromoteLeaderRequest()

FString AccelByte::Api::Lobby::SendPartyPromoteLeaderRequest ( FString const & UserId)

Promote party member to party leader.

Parameters
UserIdThe target user ID to be promoted.

◆ SendPrivateMessage()

FString AccelByte::Api::Lobby::SendPrivateMessage ( FString const & UserId,
FString const & Message )

Send a private message to another user.

Parameters
UserIdThe recipient's user ID.
MessageMessage to be sent.

◆ SendReadyConsentRequest()

FString AccelByte::Api::Lobby::SendReadyConsentRequest ( FString const & MatchId)

send ready consent request

Parameters
MatchIdThe id of a match user ready to play.

◆ SendRejectConsentRequest()

FString AccelByte::Api::Lobby::SendRejectConsentRequest ( FString const & MatchId)

send reject consent request

Parameters
MatchIdThe id of a match user ready to play.

◆ SendRejectInvitationRequest()

FString AccelByte::Api::Api::Lobby::SendRejectInvitationRequest ( FString const & PartyId,
FString const & InvitationToken )

Reject a party invitation.

Parameters
PartyIdParty ID from the invitation notice.
InvitationTokenRandom string from the invitation notice.

◆ SendSetPresenceStatus()

FString AccelByte::Api::Lobby::SendSetPresenceStatus ( EAvailability Availability,
FString const & Activity )

Set presence status on lobby service.

Parameters
AvailabilityPresence state that you want to use. State is EAvailability type
ActivityUser's custom activity. It will be escaped and unescaped automatically, can handle JSON.

◆ SendSignalingMessage()

FString AccelByte::Api::Lobby::SendSignalingMessage ( FString const & UserId,
FString const & Message )

Send a signaling message to another user.

Parameters
UserIdThe recipient's user ID.
MessageSignaling message to be sent.

◆ SendStartMatchmaking() [1/5]

FString AccelByte::Api::Lobby::SendStartMatchmaking ( FString const & GameMode,
FMatchmakingOptionalParams const & OptionalParams = {} )

start the matchmaking

Parameters
GameModeThe mode that party member want to play.
OptionalParamsOptional parameters to be considered while matchmaking.

◆ SendStartMatchmaking() [2/5]

FString AccelByte::Api::Lobby::SendStartMatchmaking ( FString const & GameMode,
FString const & ServerName,
FString const & ClientVersion = TEXT(""),
TArray< TPair< FString, float > > const & Latencies = {},
TMap< FString, FString > const & PartyAttributes = {},
TArray< FString > const & TempPartyUserIds = {},
TArray< FString > const & ExtraAttributes = {} )

start the matchmaking

Parameters
GameModeThe mode that party member want to play.
ServerNameThe Local DS name, fill it blank if you don't use Local DS.
ClientVersionThe version of DS, fill it blank to choose the default version.
Latencieslist of servers and their latencies to client, DSM will created the server on one of this list. Fill it blank if you use Local DS.
PartyAttributesString map custom attributes to be added on matchmaking and also will be passed to ds too. Example: {"Map":"Dungeon1", "Rank":"B", "Stage":"04"}
TempPartyUserIdsUserIDs to form a temporary party with (include user who started the matchmaking). Temporary party will disband when matchmaking finishes.
ExtraAttributescustom attributes defined in game mode's matching/flexing rule.

◆ SendStartMatchmaking() [3/5]

FString AccelByte::Api::Lobby::SendStartMatchmaking ( FString const & GameMode,
TArray< FString > const & TempPartyUserIds,
FString const & ServerName = TEXT(""),
FString const & ClientVersion = TEXT(""),
TArray< TPair< FString, float > > const & Latencies = {},
TMap< FString, FString > const & PartyAttributes = {},
TArray< FString > const & ExtraAttributes = {} )

start the matchmaking

Parameters
GameModeThe mode that party member want to play.
TempPartyUserIdsUserIDs to form a temporary party with (include user who started the matchmaking). Temporary party will disband when matchmaking finishes.
ServerNameThe Local DS name, fill it blank if you don't use Local DS.
ClientVersionThe version of DS, fill it blank to choose the default version.
Latencieslist of servers and their latencies to client, DSM will created the server on one of this list. Fill it blank if you use Local DS.
PartyAttributesString map custom attributes to be added on matchmaking and also will be passed to ds too. Example: {"Map":"Dungeon1", "Rank":"B", "Stage":"04"}
ExtraAttributescustom attributes defined in game mode's matching/flexing rule.

◆ SendStartMatchmaking() [4/5]

FString AccelByte::Api::Lobby::SendStartMatchmaking ( FString const & GameMode,
TMap< FString, FString > const & PartyAttributes,
FString const & ServerName = TEXT(""),
FString const & ClientVersion = TEXT(""),
TArray< TPair< FString, float > > const & Latencies = {},
TArray< FString > const & TempPartyUserIds = {},
TArray< FString > const & ExtraAttributes = {} )

start the matchmaking

Parameters
GameModeThe mode that party member want to play.
PartyAttributesString map custom attributes to be added on matchmaking and also will be passed to ds too. Example: {"Map":"Dungeon1", "Rank":"B", "Stage":"04"}
ServerNameThe Local DS name, fill it blank if you don't use Local DS.
ClientVersionThe version of DS, fill it blank to choose the default version.
Latencieslist of servers and their latencies to client, DSM will created the server on one of this list. Fill it blank if you use Local DS.
TempPartyUserIdsUserIDs to form a temporary party with (include user who started the matchmaking). Temporary party will disband when matchmaking finishes.
ExtraAttributescustom attributes defined in game mode's matching/flexing rule.

◆ SendStartMatchmaking() [5/5]

FString AccelByte::Api::Lobby::SendStartMatchmaking ( FString const & GameMode,
TMap< FString, FString > const & PartyAttributes,
TArray< FString > const & TempPartyUserIds,
FString const & ServerName = TEXT(""),
FString const & ClientVersion = TEXT(""),
TArray< TPair< FString, float > > const & Latencies = {},
TArray< FString > const & ExtraAttributes = {} )

start the matchmaking

Parameters
GameModeThe mode that party member want to play.
PartyAttributesString map custom attributes to be added on matchmaking and also will be passed to ds too. Example: {"Map":"Dungeon1", "Rank":"B", "Stage":"04"}
TempPartyUserIdsUserIDs to form a temporary party with (include user who started the matchmaking). Temporary party will disband when matchmaking finishes.
ServerNameThe Local DS name, fill it blank if you don't use Local DS.
ClientVersionThe version of DS, fill it blank to choose the default version.
Latencieslist of servers and their latencies to client, DSM will created the server on one of this list. Fill it blank if you use Local DS.
ExtraAttributescustom attributes defined in game mode's matching/flexing rule.

◆ SetAcceptFriendsResponseDelegate()

void AccelByte::Api::Lobby::SetAcceptFriendsResponseDelegate ( FAcceptFriendsResponse const & OnAcceptFriendsResponse,
FErrorHandler const & OnError = nullptr )
inline

Set accept friend response.

Parameters
OnAcceptFriendsResponseDelegate that will be set.
OnErrorDelegate that will be called when operation failed.

◆ SetBlockPlayerNotifDelegate()

void AccelByte::Api::Lobby::SetBlockPlayerNotifDelegate ( FBlockPlayerNotif const & OnBlockPlayerNotif)
inline

set a function triggered when user is blocked

Parameters
OnBlockPlayerNotifDelegate that will be set.

◆ SetBlockPlayerResponseDelegate()

void AccelByte::Api::Lobby::SetBlockPlayerResponseDelegate ( FBlockPlayerResponse const & OnBlockPlayerResponse,
FErrorHandler const & OnError = nullptr )
inline

set unblock player responses

Parameters
OnBlockPlayerResponseDelegate that will be set.
OnErrorDelegate that will be called when operation failed.

◆ SetCancelFriendsResponseDelegate()

void AccelByte::Api::Lobby::SetCancelFriendsResponseDelegate ( FCancelFriendsResponse const & OnCancelFriendsResponse,
FErrorHandler const & OnError = nullptr )
inline

Set cancel request of friend response.

Parameters
OnCancelFriendsResponseDelegate that will be set.
OnErrorDelegate that will be called when operation failed.

◆ SetCancelMatchmakingResponseDelegate()

void AccelByte::Api::Lobby::SetCancelMatchmakingResponseDelegate ( FMatchmakingResponse const & OnMatchmakingCancel,
FErrorHandler const & OnError = nullptr )
inline

set cancel matchmaking notification

Parameters
OnMatchmakingCancelset delegate .
OnErrorDelegate that will be called when operation failed.

◆ SetChangeUserRegionDelegate()

void AccelByte::Api::Lobby::SetChangeUserRegionDelegate ( FChangeUserRegionResponse const & OnChangeUserRegionResponse,
FErrorHandler const & OnError = nullptr )
inline

Set delegate for set user region response.

Parameters
OnChangeUserRegionResponseDelegate that will be called when operation success.
OnErrorDelegate that will be called when operation failed.

◆ SetChannelMessageNotifDelegate()

void AccelByte::Api::Lobby::SetChannelMessageNotifDelegate ( FChannelChatNotif const & OnChannelMessageNotif)
inline

set channel message notif

Parameters
OnChannelMessageNotifset delegate.

◆ SetChannelMessageResponseDelegate()

void AccelByte::Api::Lobby::SetChannelMessageResponseDelegate ( FChannelChatResponse const & OnChannelMessageResponse,
FErrorHandler const & OnError = nullptr )
inline

set channel message response

Parameters
OnChannelMessageResponseset delegate.
OnErrorDelegate that will be called when operation failed.

◆ SetCreateDSDelegate()

void AccelByte::Api::Lobby::SetCreateDSDelegate ( FBaseResponse const & OnCreateDSResponse,
FErrorHandler const & OnError = nullptr )
inline

set create DS response delegate

Parameters
OnCreateDSResponseDelegate to set.
OnErrorDelegate that will be called when operation failed.

◆ SetCreatePartyResponseDelegate()

void AccelByte::Api::Lobby::SetCreatePartyResponseDelegate ( FPartyCreateResponse const & OnCreatePartyResponse,
FErrorHandler const & OnError = nullptr )
inline

create party response delegate

Parameters
OnCreatePartyResponseset delegate .
OnErrorDelegate that will be called when operation failed.

◆ SetDsNotifDelegate()

void AccelByte::Api::Lobby::SetDsNotifDelegate ( FDsNotif const & OnDsNotification)
inline

set ready consent notification

Parameters
OnDsNotificationset delegate.

◆ SetErrorNotifDelegate()

void AccelByte::Api::Lobby::SetErrorNotifDelegate ( FErrorNotif const & OnErrorNotif)
inline

set a function triggered when there is a general lobby error notification.

Parameters
OnErrorNotifDelegate that will be set.

◆ SetGetAllSessionAttributeDelegate()

void AccelByte::Api::Lobby::SetGetAllSessionAttributeDelegate ( FGetAllSessionAttributeResponse const & OnGetAllSessionAttributeResponse,
FErrorHandler const & OnError = nullptr )
inline

Set SetSessionAttribute delegate.

Parameters
OnGetAllSessionAttributeResponseDelegate that will be set.
OnErrorDelegate that will be called when operation failed.

◆ SetGetAllUserPresenceResponseDelegate()

void AccelByte::Api::Lobby::SetGetAllUserPresenceResponseDelegate ( FGetAllFriendsStatusResponse const & OnGetAllUserPresenceResponse,
FErrorHandler const & OnError = nullptr )
inline

(obsolete) misnamed, please use SetGetOnlineFriendsPresenceResponseDelegate

Parameters
OnGetAllUserPresenceResponseset delegate .
OnErrorDelegate that will be called when operation failed.

◆ SetGetFriendshipStatusResponseDelegate()

void AccelByte::Api::Lobby::SetGetFriendshipStatusResponseDelegate ( FGetFriendshipStatusResponse const & OnGetFriendshipStatusResponse,
FErrorHandler const & OnError = nullptr )
inline

Set get friendship status response.

Parameters
OnGetFriendshipStatusResponseDelegate that will be set.
OnErrorDelegate that will be called when operation failed.

◆ SetGetOnlineFriendsPresenceResponseDelegate()

void AccelByte::Api::Lobby::SetGetOnlineFriendsPresenceResponseDelegate ( FGetAllFriendsStatusResponse const & OnGetFriendsPresenceResponse,
FErrorHandler const & OnError = nullptr )
inline

Set GetFriendsPresenceResponse delegate.

Parameters
OnGetFriendsPresenceResponseset delegate .
OnErrorDelegate that will be called when operation failed.

◆ SetGetSessionAttributeDelegate()

void AccelByte::Api::Lobby::SetGetSessionAttributeDelegate ( FGetSessionAttributeResponse const & OnGetSessionAttributeResponse,
FErrorHandler const & OnError = nullptr )
inline

Set GetSessionAttribute delegate.

Parameters
OnGetSessionAttributeResponseDelegate that will be set.
OnErrorDelegate that will be called when operation failed.

◆ SetInfoPartyResponseDelegate()

void AccelByte::Api::Lobby::SetInfoPartyResponseDelegate ( FPartyInfoResponse const & OnInfoPartyResponse,
FErrorHandler const & OnError = nullptr )
inline

set info party response

Parameters
OnInfoPartyResponseset delegate .
OnErrorDelegate that will be called when operation failed.

◆ SetInvitePartyJoinResponseDelegate()

void AccelByte::Api::Lobby::SetInvitePartyJoinResponseDelegate ( FPartyJoinResponse const & OnInvitePartyJoinResponse,
FErrorHandler const & OnError = nullptr )
inline

set invite party join response

Parameters
OnInvitePartyJoinResponseset delegate .
OnErrorDelegate that will be called when operation failed.

◆ SetInvitePartyKickMemberResponseDelegate()

void AccelByte::Api::Lobby::SetInvitePartyKickMemberResponseDelegate ( FPartyKickResponse const & OnInvitePartyKickMemberResponse,
FErrorHandler const & OnError = nullptr )
inline

set invite party kick member response

Parameters
OnInvitePartyKickMemberResponseset delegate .
OnErrorDelegate that will be called when operation failed.

◆ SetInvitePartyRejectResponseDelegate()

void AccelByte::Api::Lobby::SetInvitePartyRejectResponseDelegate ( FPartyRejectResponse const & OnInvitePartyRejectResponse,
FErrorHandler const & OnError = nullptr )
inline

set invite party reject response

Parameters
OnInvitePartyRejectResponseset delegate .
OnErrorDelegate that will be called when operation failed.

◆ SetInvitePartyResponseDelegate()

void AccelByte::Api::Lobby::SetInvitePartyResponseDelegate ( FPartyInviteResponse const & OnInvitePartyResponse,
FErrorHandler const & OnError = nullptr )
inline

set invite party response delegate

Parameters
OnInvitePartyResponseset delegate .
OnErrorDelegate that will be called when operation failed.

◆ SetJoinChannelChatResponseDelegate()

void AccelByte::Api::Lobby::SetJoinChannelChatResponseDelegate ( FJoinDefaultChannelChatResponse const & OnJoinDefaultChannelResponse,
FErrorHandler const & OnError = nullptr )
inline

set join channel chat response

Parameters
OnJoinDefaultChannelResponseset delegate.
OnErrorDelegate that will be called when operation failed.

◆ SetLeavePartyResponseDelegate()

void AccelByte::Api::Lobby::SetLeavePartyResponseDelegate ( FPartyLeaveResponse const & OnLeavePartyResponse,
FErrorHandler const & OnError = nullptr )
inline

set leave party response delegate

Parameters
OnLeavePartyResponseset delegate .
OnErrorDelegate that will be called when operation failed.

◆ SetListIncomingFriendsResponseDelegate()

void AccelByte::Api::Lobby::SetListIncomingFriendsResponseDelegate ( FListIncomingFriendsResponse const & OnListIncomingFriendsResponse,
FErrorHandler const & OnError = nullptr )
inline

Set incoming request of friend response.

Parameters
OnListIncomingFriendsResponseDelegate that will be set.
OnErrorDelegate that will be called when operation failed.

◆ SetListIncomingFriendsWithTimeResponseDelegate()

void AccelByte::Api::Lobby::SetListIncomingFriendsWithTimeResponseDelegate ( FListIncomingFriendsWithTimeResponse const & OnListIncomingFriendsWithTimeResponse,
FErrorHandler const & OnError = nullptr )
inline

Set incoming request of friend response with time.

Parameters
OnListIncomingFriendsWithTimeResponseDelegate that will be set.
OnErrorDelegate that will be called when operation failed.

◆ SetListOutgoingFriendsResponseDelegate()

void AccelByte::Api::Lobby::SetListOutgoingFriendsResponseDelegate ( FListOutgoingFriendsResponse const & OnListOutgoingFriendsResponse,
FErrorHandler const & OnError = nullptr )
inline

Set list outgoing request of friend response.

Parameters
OnListOutgoingFriendsResponseDelegate that will be set.
OnErrorDelegate that will be called when operation failed.

◆ SetListOutgoingFriendsWithTimeResponseDelegate()

void AccelByte::Api::Lobby::SetListOutgoingFriendsWithTimeResponseDelegate ( FListOutgoingFriendsWithTimeResponse const & OnListOutgoingFriendsWithTimeResponse,
FErrorHandler const & OnError = nullptr )
inline

Set list outgoing request of friend response with time.

Parameters
OnListOutgoingFriendsWithTimeResponseDelegate that will be set.
OnErrorDelegate that will be called when operation failed.

◆ SetLoadFriendListResponseDelegate()

void AccelByte::Api::Lobby::SetLoadFriendListResponseDelegate ( FLoadFriendListResponse const & OnLoadFriendListResponse,
FErrorHandler const & OnError = nullptr )
inline

Set load friend list response.

Parameters
OnLoadFriendListResponseDelegate that will be set.
OnErrorDelegate that will be called when operation failed.

◆ SetMatchmakingNotifDelegate()

void AccelByte::Api::Lobby::SetMatchmakingNotifDelegate ( FMatchmakingNotif const & OnMatchmakingNotification)
inline

set matchmaking notification

Parameters
OnMatchmakingNotificationset delegate .

◆ SetMessageNotifDelegate()

void AccelByte::Api::Lobby::SetMessageNotifDelegate ( FMessageNotif const & OnNotificationMessage)

Set a trigger function when receiving a notification message.

Parameters
OnNotificationMessagereturn models called FAccelByteModelsNotificationMessage

◆ SetOnCancelFriendsNotifDelegate()

void AccelByte::Api::Lobby::SetOnCancelFriendsNotifDelegate ( FCancelFriendsNotif const & OnCancelFriendsNotif)
inline

Set a trigger function when friend request is cancelled.

Parameters
OnCancelFriendsNotifreturn models called FAccelByteModelsCancelFriendsNotif

◆ SetOnFriendRequestAcceptedNotifDelegate()

void AccelByte::Api::Lobby::SetOnFriendRequestAcceptedNotifDelegate ( FAcceptFriendsNotif const & OnAcceptFriendsNotif)
inline

Set a trigger function when a friend request is accepted.

Parameters
OnAcceptFriendsNotifreturn models called FAccelByteModelsAcceptFriendsNotif

◆ SetOnIncomingRequestFriendsNotifDelegate()

void AccelByte::Api::Lobby::SetOnIncomingRequestFriendsNotifDelegate ( FRequestFriendsNotif const & OnRequestFriendsNotif)
inline

Set a trigger function when a friend request is received.

Parameters
OnRequestFriendsNotifreturn models called FAccelByteModelsRequestFriendsNotif

◆ SetOnRejectFriendsNotifDelegate()

void AccelByte::Api::Lobby::SetOnRejectFriendsNotifDelegate ( FRejectFriendsNotif const & OnRejectFriendsNotif)
inline

Set a trigger function when friend request is rejected.

Parameters
OnRejectFriendsNotifreturn models called FAccelByteModelsRejectFriendsNotif

◆ SetOnUnfriendNotifDelegate()

void AccelByte::Api::Lobby::SetOnUnfriendNotifDelegate ( FUnfriendNotif const & OnUnfriendNotif)
inline

Set a trigger function when unfriended.

Parameters
OnUnfriendNotifreturn models called FAccelByteModelsUnfriendNotif

◆ SetParsingErrorDelegate()

void AccelByte::Api::Lobby::SetParsingErrorDelegate ( FErrorHandler const & OnParsingError)
inline

Set a trigger function when a lobby message failed to be parsed.

Parameters
OnParsingErrorreturn models with the error code and message

◆ SetPartyChatNotifDelegate()

void AccelByte::Api::Lobby::SetPartyChatNotifDelegate ( FPartyChatNotif const & OnPersonalChatNotif)

Set a trigger function when received a party chat (v1).

Parameters
OnPersonalChatNotifreturn models called FAccelByteModelsPartyMessageNotice

◆ SetPartyDataUpdateNotifDelegate()

void AccelByte::Api::Lobby::SetPartyDataUpdateNotifDelegate ( FPartyDataUpdateNotif const & OnPartyDataUpdateNotif)
inline

set party data update notif delegate

Parameters
OnPartyDataUpdateNotifset delegate

◆ SetPartyDataUpdateResponseDelegate()

void AccelByte::Api::Lobby::SetPartyDataUpdateResponseDelegate ( FPartyDataUpdateNotif const & OnPartyDataUpdateNotif)
inline

misnamed, same as SetPartyDataUpdateNotifDelegate

Parameters
OnPartyDataUpdateNotifset delegate

◆ SetPartyDeleteCodeResponseDelegate()

void AccelByte::Api::Lobby::SetPartyDeleteCodeResponseDelegate ( FPartyDeleteCodeResponse const & OnPartyDeleteCodeResponse,
FErrorHandler const & OnError = nullptr )
inline

delete party code response

Parameters
OnPartyDeleteCodeResponseset delegate .
OnErrorDelegate that will be called when operation failed.

◆ SetPartyGenerateCodeResponseDelegate()

void AccelByte::Api::Lobby::SetPartyGenerateCodeResponseDelegate ( FPartyGenerateCodeResponse const & OnPartyGenerateCodeResponse,
FErrorHandler const & OnError = nullptr )
inline

generate party code response

Parameters
OnPartyGenerateCodeResponseset delegate .
OnErrorDelegate that will be called when operation failed.

◆ SetPartyGetCodeResponseDelegate()

void AccelByte::Api::Lobby::SetPartyGetCodeResponseDelegate ( FPartyGetCodeResponse const & OnPartyGetCodeResponse,
FErrorHandler const & OnError = nullptr )
inline

get party code response

Parameters
OnPartyGetCodeResponseset delegate .
OnErrorDelegate that will be called when operation failed.

◆ SetPartyGetInvitedNotifDelegate()

void AccelByte::Api::Lobby::SetPartyGetInvitedNotifDelegate ( FPartyGetInvitedNotif const & OnInvitePartyGetInvitedNotice)

Set a trigger function when receiving a party invite.

Parameters
OnInvitePartyGetInvitedNoticereturn models called FAccelByteModelsPartyGetInvitedNotice

◆ SetPartyInvitationRejectedNotifDelegate()

void AccelByte::Api::Lobby::SetPartyInvitationRejectedNotifDelegate ( FPartyRejectNotif const & OnInvitePartyRejectNotice)

Set a trigger function when a party invitation is rejected.

Parameters
OnInvitePartyRejectNoticereturn models called FAccelByteModelsPartyRejectNotice

◆ SetPartyInviteNotifDelegate()

void AccelByte::Api::Lobby::SetPartyInviteNotifDelegate ( FPartyInviteNotif const & OnPartyInviteNotif)

Set a trigger function when other user is invited to party.

Parameters
OnPartyInviteNotifreturn models called FAccelByteModelsInvitationNotice

◆ SetPartyJoinNotifDelegate()

void AccelByte::Api::Lobby::SetPartyJoinNotifDelegate ( FPartyJoinNotif const & OnInvitePartyJoinNotice)

Set a trigger function when a new member joins the party.

Parameters
OnInvitePartyJoinNoticereturn models called FAccelByteModelsPartyJoinNotice

◆ SetPartyJoinViaCodeResponseDelegate()

void AccelByte::Api::Lobby::SetPartyJoinViaCodeResponseDelegate ( FPartyJoinViaCodeResponse const & OnPartyJoinViaCodeResponse,
FErrorHandler const & OnError = nullptr )
inline

join party via party code response

Parameters
OnPartyJoinViaCodeResponseset delegate .
OnErrorDelegate that will be called when operation failed.

◆ SetPartyKickNotifDelegate()

void AccelByte::Api::Lobby::SetPartyKickNotifDelegate ( FPartyKickNotif const & OnInvitePartyKickedNotice)

Set a trigger function when kicked from party.

Parameters
OnInvitePartyKickedNoticereturn models called FAccelByteModelsGotKickedFromPartyNotice

◆ SetPartyLeaveNotifDelegate()

void AccelByte::Api::Lobby::SetPartyLeaveNotifDelegate ( FPartyLeaveNotif const & OnPartyLeaveNotice)

Set a trigger function when a party member leave from the party. This function is DEPRECATED.

Parameters
OnPartyLeaveNoticedelegate parameter with returned model called FAccelByteModelsLeavePartyNotice

◆ SetPartyMemberConnectNotifDelegate()

void AccelByte::Api::Lobby::SetPartyMemberConnectNotifDelegate ( FPartyMemberConnectNotif const & OnPartyMemberConnectNotif)

Set a trigger function when a party member reconnecting to the lobby.

Parameters
OnPartyMemberConnectNotifreturn models called FAccelByteModelsPartyMemberConnectionNotice

◆ SetPartyMemberDisconnectNotifDelegate()

void AccelByte::Api::Lobby::SetPartyMemberDisconnectNotifDelegate ( FPartyMemberDisconnectNotif const & OnPartyMemberDisconnectNotif)

Set a trigger function when a party member disconnect from lobby.

Parameters
OnPartyMemberDisconnectNotifreturn models called FAccelByteModelsPartyMemberConnectionNotice

◆ SetPartyMemberLeaveNotifDelegate()

void AccelByte::Api::Lobby::SetPartyMemberLeaveNotifDelegate ( FPartyMemberLeaveNotif const & OnPartyMemberLeaveNotice)

Set a trigger function when a party member leave from the party.

Parameters
OnPartyMemberLeaveNoticedelegate parameter with returned model called FAccelByteModelsLeavePartyNotice

◆ SetPartyMessageResponseDelegate()

void AccelByte::Api::Lobby::SetPartyMessageResponseDelegate ( FPartyChatResponse const & OnPartyMessageResponse,
FErrorHandler const & OnError = nullptr )
inline

set party message response

Parameters
OnPartyMessageResponseset delegate .
OnErrorDelegate that will be called when operation failed.

◆ SetPartyNotifDelegate()

void AccelByte::Api::Lobby::SetPartyNotifDelegate ( FPartyNotif const & OnPartyNotif)

Set a trigger function when party data is updated.

Parameters
OnPartyNotifreturn models called FAccelByteModelsPartyNotif

◆ SetPartyPromoteLeaderResponseDelegate()

void AccelByte::Api::Lobby::SetPartyPromoteLeaderResponseDelegate ( FPartyPromoteLeaderResponse const & OnPartyPromoteLeaderResponse,
FErrorHandler const & OnError = nullptr )
inline

set promote party leader response

Parameters
OnPartyPromoteLeaderResponseset delegate .
OnErrorDelegate that will be called when operation failed.

◆ SetPartySendNotifResponseDelegate()

void AccelByte::Api::Lobby::SetPartySendNotifResponseDelegate ( FPartySendNotifResponse const & OnPartySendNotifResponse,
FErrorHandler const & OnError = nullptr )
inline

set party send notification response

Parameters
OnPartySendNotifResponseset delegate .

◆ SetPartySizeLimit()

FAccelByteTaskWPtr AccelByte::Api::Lobby::SetPartySizeLimit ( FString const & PartyId,
int32 Limit,
FVoidHandler const & OnSuccess,
FErrorHandler const & OnError )

Set the party's member limit.

Parameters
PartyIdThe party id to be set.
LimitThe party member limit, should be above 0 and below the configured limit in admin portal.
OnSuccessThe callback triggered when operation is successful
OnErrorthe callback triggered when operation failed.
Returns
AccelByteTask object to track and cancel the ongoing API operation.

◆ SetPrivateMessageNotifDelegate()

void AccelByte::Api::Lobby::SetPrivateMessageNotifDelegate ( FPersonalChatNotif const & OnPersonalChatNotif)

Set a trigger function when party data is updated.

Parameters
OnPersonalChatNotifreturn models called FAccelByteModelsPartyNotif

◆ SetPrivateMessageResponseDelegate()

void AccelByte::Api::Lobby::SetPrivateMessageResponseDelegate ( FPersonalChatResponse const & OnPrivateMessageResponse,
FErrorHandler const & OnError = nullptr )
inline

set private message delegate

Parameters
OnPrivateMessageResponseset delegate .
OnErrorDelegate that will be called when operation failed.

◆ SetReadyConsentNotifDelegate()

void AccelByte::Api::Lobby::SetReadyConsentNotifDelegate ( FReadyConsentNotif const & OnReadyConsentNotification)
inline

set ready consent notification

Parameters
OnReadyConsentNotificationset delegate .

◆ SetReadyConsentResponseDelegate()

void AccelByte::Api::Lobby::SetReadyConsentResponseDelegate ( FReadyConsentResponse const & OnReadyConsentResponse,
FErrorHandler const & OnError = nullptr )
inline

set ready consent response notification

Parameters
OnReadyConsentResponseset delegate .
OnErrorDelegate that will be called when operation failed.

◆ SetRefreshTokenDelegate()

void AccelByte::Api::Lobby::SetRefreshTokenDelegate ( const FRefreshTokenResponse & OnRefreshTokenResponse,
FErrorHandler const & OnError = nullptr )
inline

Set SetSessionAttribute delegate.

Parameters
OnRefreshTokenResponseDelegate that will be set.
OnErrorDelegate that will be called when operation failed.

◆ SetRejectConsentNotifDelegate()

void AccelByte::Api::Lobby::SetRejectConsentNotifDelegate ( FRejectConsentNotif const & OnRejectConsentNotification)
inline

set reject consent notification

Parameters
OnRejectConsentNotificationset delegate .

◆ SetRejectConsentResponseDelegate()

void AccelByte::Api::Lobby::SetRejectConsentResponseDelegate ( FRejectConsentResponse const & OnRejectConsentResponse,
FErrorHandler const & OnError = nullptr )
inline

set reject consent response notification

Parameters
OnRejectConsentResponseset delegate .
OnErrorDelegate that will be called when operation failed.

◆ SetRejectFriendsResponseDelegate()

void AccelByte::Api::Lobby::SetRejectFriendsResponseDelegate ( FRejectFriendsResponse const & OnRejectFriendsResponse,
FErrorHandler const & OnError = nullptr )
inline

Set reject request for friend response.

Parameters
OnRejectFriendsResponseDelegate that will be set.
OnErrorDelegate that will be called when operation failed.

◆ SetRematchmakingNotifDelegate()

void AccelByte::Api::Lobby::SetRematchmakingNotifDelegate ( FRematchmakingNotif const & OnRematchmakingNotification)
inline

set rematchmaking notification

Parameters
OnRematchmakingNotificationset delegate .

◆ SetRequestFriendsByPublicIdResponseDelegate()

void AccelByte::Api::Lobby::SetRequestFriendsByPublicIdResponseDelegate ( FRequestFriendsResponse const & OnRequestFriendsResponse,
FErrorHandler const & OnError = nullptr )
inline

Set request for friends by public ID response.

Parameters
OnRequestFriendsResponseDelegate that will be set.
OnErrorDelegate that will be called when operation failed.

◆ SetRequestFriendsResponseDelegate()

void AccelByte::Api::Lobby::SetRequestFriendsResponseDelegate ( FRequestFriendsResponse const & OnRequestFriendsResponse,
FErrorHandler const & OnError = nullptr )
inline

Set request for friends response.

Parameters
OnRequestFriendsResponseDelegate that will be set.
OnErrorDelegate that will be called when operation failed.

◆ SetSessionAttribute()

FString AccelByte::Api::Lobby::SetSessionAttribute ( FString const & Key,
FString const & Value )

Set user attribute to lobby session.

Parameters
Keythe attribute's key.
Valuethe attribute's value.

◆ SetSetSessionAttributeDelegate()

void AccelByte::Api::Lobby::SetSetSessionAttributeDelegate ( FSetSessionAttributeResponse const & OnSetSessionAttributeResponse,
FErrorHandler const & OnError = nullptr )
inline

Set SetSessionAttribute delegate.

Parameters
OnSetSessionAttributeResponseDelegate that will be set.
OnErrorDelegate that will be called when operation failed.

◆ SetSignalingP2PDelegate()

void AccelByte::Api::Lobby::SetSignalingP2PDelegate ( FSignalingP2P const & OnSignalingP2P)
inline

Set SignalingP2P delegate.

Parameters
OnSignalingP2PDelegate that will be set.

◆ SetStartMatchmakingResponseDelegate()

void AccelByte::Api::Lobby::SetStartMatchmakingResponseDelegate ( FMatchmakingResponse const & OnMatchmakingStart,
FErrorHandler const & OnError = nullptr )
inline

set start matchmaking response

Parameters
OnMatchmakingStartset delegate .
OnErrorDelegate that will be called when operation failed.

◆ SetTokenGenerator()

void AccelByte::Api::Lobby::SetTokenGenerator ( TSharedPtr< IAccelByteTokenGenerator > const & TokenGenerator)

Set token generator to be used when trying to connect to lobby using ownership token.

Parameters
TokenGeneratorThe token generator.

◆ SetUnblockPlayerNotifDelegate()

void AccelByte::Api::Lobby::SetUnblockPlayerNotifDelegate ( FUnblockPlayerNotif const & OnUnblockPlayerNotif)
inline

set a function triggered when user is unblocked

Parameters
OnUnblockPlayerNotifDelegate that will be set.

◆ SetUnblockPlayerResponseDelegate()

void AccelByte::Api::Lobby::SetUnblockPlayerResponseDelegate ( FUnblockPlayerResponse const & OnUnblockPlayerResponse,
FErrorHandler const & OnError = nullptr )
inline

set unblock player responses

Parameters
OnUnblockPlayerResponseDelegate that will be set.
OnErrorDelegate that will be called when operation failed.

◆ SetUnfriendResponseDelegate()

void AccelByte::Api::Lobby::SetUnfriendResponseDelegate ( FUnfriendResponse const & OnUnfriendResponse,
FErrorHandler const & OnError = nullptr )
inline

Set unfriend response.

Parameters
OnUnfriendResponseDelegate that will be set.
OnErrorDelegate that will be called when operation failed.

◆ SetUserBannedNotificationDelegate()

void AccelByte::Api::Lobby::SetUserBannedNotificationDelegate ( FUserBannedNotification const & OnUserBannedNotification)
inline

Set a trigger function when user is banned.

Parameters
OnUserBannedNotificationreturn models called FAccelByteModelsUserBannedNotification

◆ SetUserPresenceNotifDelegate()

void AccelByte::Api::Lobby::SetUserPresenceNotifDelegate ( FFriendStatusNotif const & OnUserPresenceNotif)

Set a trigger function when friends presence is updated.

Parameters
OnUserPresenceNotifreturn models called FAccelByteModelsUsersPresenceNotice

◆ SetUserPresenceResponseDelegate()

void AccelByte::Api::Lobby::SetUserPresenceResponseDelegate ( FSetUserPresenceResponse const & OnSetUserPresenceResponse,
FErrorHandler const & OnError = nullptr )
inline

set user presence response

Parameters
OnSetUserPresenceResponseset delegate .
OnErrorDelegate that will be called when operation failed.

◆ SetUserUnbannedNotificationDelegate()

void AccelByte::Api::Lobby::SetUserUnbannedNotificationDelegate ( FUserUnbannedNotification const & OnUserUnbannedNotification)
inline

Set a trigger function when user is unbanned.

Parameters
OnUserUnbannedNotificationreturn models called FAccelByteModelsUserBannedNotification

◆ SetV2DSStatusChangedNotifDelegate()

void AccelByte::Api::Lobby::SetV2DSStatusChangedNotifDelegate ( FV2DSStatusChangedNotif const & OnDSStatusChangedNotif)
inline

Set a trigger function when a DS status changes (v2).

Parameters
OnDSStatusChangedNotifreturn models called FAccelByteModelsV2DSStatusChangedNotif

◆ SetV2GameSessionEndedNotifDelegate()

void AccelByte::Api::Lobby::SetV2GameSessionEndedNotifDelegate ( FV2GameSessionEndedNotif const & OnGameSessionEndededNotif)
inline

Set a trigger function when game session ended by the DS (v2).

Parameters
OnGameSessionEndededNotifreturn models called FAccelByteModelsV2GameSessionEndedEvent

◆ SetV2GameSessionInvitedNotifDelegate()

void AccelByte::Api::Lobby::SetV2GameSessionInvitedNotifDelegate ( FV2GameSessionInvitedNotif const & OnGameSessionInvitedNotif)
inline

Set a trigger function when receiving invite to a game session (v2).

Parameters
OnGameSessionInvitedNotifreturn models called FAccelByteModelsV2GameSessionUserInvitedEvent

◆ SetV2GameSessionInviteTimeoutNotifDelegate()

void AccelByte::Api::Lobby::SetV2GameSessionInviteTimeoutNotifDelegate ( FV2GameSessionInviteTimeoutNotif const & OnGameSessionInviteTimeoutNotif)
inline

Set a trigger function when an game session (v2) invitation is already timeout.

Parameters
OnGameSessionInviteTimeoutNotifreturn models called FV2GameSessionInviteTimeoutNotif

◆ SetV2GameSessionJoinedNotifDelegate()

void AccelByte::Api::Lobby::SetV2GameSessionJoinedNotifDelegate ( FV2GameSessionJoinedNotif const & OnGameSessionJoinedNotif)
inline

Set a trigger function when a new member joined the game session (v2).

Parameters
OnGameSessionJoinedNotifreturn models called FAccelByteModelsV2GameSessionUserJoinedEvent

◆ SetV2GameSessionKickedNotifDelegate()

void AccelByte::Api::Lobby::SetV2GameSessionKickedNotifDelegate ( FV2GameSessionKickedNotif const & OnGameSessionKickedNotif)
inline

Set a trigger function when kicked from a game session (v2).

Parameters
OnGameSessionKickedNotifreturn models called FAccelByteModelsV2GameSessionUserKickedEvent

◆ SetV2GameSessionMembersChangedNotifDelegate()

void AccelByte::Api::Lobby::SetV2GameSessionMembersChangedNotifDelegate ( FV2GameSessionMembersChangedNotif const & OnGameSessionMembersChangedNotif)
inline

Set a trigger function when a game session member changes (v2).

Parameters
OnGameSessionMembersChangedNotifreturn models called FAccelByteModelsV2GameSessionMembersChangedEvent

◆ SetV2GameSessionRejectedNotifDelegate()

void AccelByte::Api::Lobby::SetV2GameSessionRejectedNotifDelegate ( FV2GameSessionRejectedNotif const & OnGameSessionRejectedNotif)
inline

Set a trigger function when an invitation is rejected (v2).

Parameters
OnGameSessionRejectedNotifreturn models called FAccelByteModelsV2GameSessionUserRejectedEvent

◆ SetV2GameSessionUpdatedNotifDelegate()

void AccelByte::Api::Lobby::SetV2GameSessionUpdatedNotifDelegate ( FV2GameSessionUpdatedNotif const & OnGameSessionUpdatedNotif)
inline

Set a trigger function when a game session data changes (v2).

Parameters
OnGameSessionUpdatedNotifreturn models called FAccelByteModelsV2GameSession

◆ SetV2MatchmakingCanceledNotifDelegate()

void AccelByte::Api::Lobby::SetV2MatchmakingCanceledNotifDelegate ( FV2MatchmakingCanceledNotif const & OnMatchmakingCanceledNotif)
inline

Set a trigger function when leader cancelled matchmaking (v2).

Parameters
OnMatchmakingCanceledNotifreturn models called FAccelByteModelsV2MatchmakingCanceledNotif

◆ SetV2MatchmakingExpiredNotifDelegate()

void AccelByte::Api::Lobby::SetV2MatchmakingExpiredNotifDelegate ( FV2MatchmakingExpiredNotif const & OnMatchmakingExpiredNotif)
inline

Set a trigger function when matchmaking ticket is expired and matchmaking stopped (v2).

Parameters
OnMatchmakingExpiredNotifreturn models called FAccelByteModelsV2MatchmakingExpiredNotif

◆ SetV2MatchmakingMatchFoundNotifDelegate()

void AccelByte::Api::Lobby::SetV2MatchmakingMatchFoundNotifDelegate ( FV2MatchmakingMatchFoundNotif const & OnMatchFoundNotif)
inline

Set a trigger function when matchmaking ticket is successfully matched (v2).

Parameters
OnMatchFoundNotifreturn models called FAccelByteModelsV2MatchFoundNotif

◆ SetV2MatchmakingStartNotifDelegate()

void AccelByte::Api::Lobby::SetV2MatchmakingStartNotifDelegate ( FV2MatchmakingStartNotif const & OnMatchmakingStartNotif)
inline

Set a trigger function when leader created a matchmaking ticket (v2).

Parameters
OnMatchmakingStartNotifreturn models called FAccelByteModelsV2StartMatchmakingNotif

◆ SetV2NativeSessionSyncNotifDelegate()

void AccelByte::Api::Lobby::SetV2NativeSessionSyncNotifDelegate ( const FV2NativeSessionSyncNotif & OnV2NativeSessionSyncNotif)
inline

Set a trigger function when leader cancelled matchmaking (v2).

Parameters
OnMatchmakingCanceledNotifreturn models called FAccelByteModelsV2MatchmakingCanceledNotif

◆ SetV2PartyInvitedNotifDelegate()

void AccelByte::Api::Lobby::SetV2PartyInvitedNotifDelegate ( FV2PartyInvitedNotif const & OnPartyInvitedNotif)
inline

Set a trigger function when receiving invite to a party (v2).

Parameters
OnPartyInvitedNotifreturn models called FAccelByteModelsV2PartyInvitedEvent

◆ SetV2PartyInviteTimeoutNotifDelegate()

void AccelByte::Api::Lobby::SetV2PartyInviteTimeoutNotifDelegate ( FV2PartyInviteTimeoutNotif const & OnPartyInviteTimeoutNotif)
inline

Set a trigger function when an party (v2) invitation is already timeout.

Parameters
OnPartyInviteTimeoutNotifreturn models called FV2PartyInviteTimeoutNotif

◆ SetV2PartyJoinedNotifDelegate()

void AccelByte::Api::Lobby::SetV2PartyJoinedNotifDelegate ( FV2PartyJoinedNotif const & OnPartyJoinedNotif)
inline

Set a trigger function when a new member joined current party (v2).

Parameters
OnPartyJoinedNotifreturn models called FAccelByteModelsV2PartyUserJoinedEvent

◆ SetV2PartyKickedNotifDelegate()

void AccelByte::Api::Lobby::SetV2PartyKickedNotifDelegate ( FV2PartyKickedNotif const & OnPartyKickedNotif)
inline

Set a trigger function when getting kicked from a party (v2).

Parameters
OnPartyKickedNotifreturn models called FAccelByteModelsV2PartyUserKickedEvent

◆ SetV2PartyMembersChangedNotifDelegate()

void AccelByte::Api::Lobby::SetV2PartyMembersChangedNotifDelegate ( FV2PartyMembersChangedNotif const & OnPartyMembersChanged)
inline

Set a trigger function when party members changed (v2).

Parameters
OnPartyMembersChangedreturn models called FAccelByteModelsV2PartyMembersChangedEvent

◆ SetV2PartyRejectedNotifDelegate()

void AccelByte::Api::Lobby::SetV2PartyRejectedNotifDelegate ( FV2PartyRejectedNotif const & OnPartyRejectedNotif)
inline

Set a trigger function when a party invitation is rejected (v2).

Parameters
OnPartyRejectedNotifreturn models called FAccelByteModelsV2PartyUserRejectedEvent

◆ SetV2PartyStorageChangedNotifDelegate()

void AccelByte::Api::Lobby::SetV2PartyStorageChangedNotifDelegate ( FV2PartyStorageChangedNotif const & OnPartyStorageChangedNotif)
inline

Set a trigger function when party storage content changes (v2).

Parameters
OnPartyStorageChangedNotifreturn models called FAccelByteModelsV2PartyStorageChangedEvent

◆ SetV2PartyUpdatedNotifDelegate()

void AccelByte::Api::Lobby::SetV2PartyUpdatedNotifDelegate ( FV2PartyUpdatedNotif const & OnPartyUpdatedNotif)
inline

Set a trigger function when a party data is updated (v2).

Parameters
OnPartyUpdatedNotifreturn models called FAccelByteModelsV2PartySession

◆ SetV2SessionJoinedSecretNotifDelegate()

void AccelByte::Api::Lobby::SetV2SessionJoinedSecretNotifDelegate ( FV2SessionJoinedSecretNotif const & OnSessionJoinedSecretNotif)
inline

Set a trigger function when session (with secret server enabled) joined (v2).

Parameters
OnSessionJoinedSecretNotifreturn models called FAccelByteModelsV2SessionJoinedSecret

◆ SetV2SessionStorageChangedNotifDelegate()

void AccelByte::Api::Lobby::SetV2SessionStorageChangedNotifDelegate ( FV2SessionStorageChangedNotif const & OnSessionStorageChangedNotif)
inline

Set a trigger function when session storage content changes (v2).

Parameters
OnSessionStorageChangedNotifreturn models called FAccelByteModelsV2SessionStorageChangedEvent

◆ SyncThirdPartyBlockList()

FAccelByteTaskWPtr AccelByte::Api::Lobby::SyncThirdPartyBlockList ( FAccelByteModelsSyncThirdPartyBlockListRequest const & Request,
THandler< TArray< FAccelByteModelsSyncThirdPartyBlockListResponse > > const & OnSuccess,
FErrorHandler const & OnError )

Sync third party platform block list to the AccelByte block list. Automatically will add players from the platform block list to the AccelByte block list, if the blocked player has linked their account with an AccelByte account.

Parameters
RequestRequest model used to configure the block list sync API call
OnSuccessThis will be called when the operation succeeded.
OnErrorThis will be called when the operation failed.
Returns
AccelByteTask object to track and cancel the ongoing API operation.

◆ SyncThirdPartyFriends()

FAccelByteTaskWPtr AccelByte::Api::Lobby::SyncThirdPartyFriends ( FAccelByteModelsSyncThirdPartyFriendsRequest const & Request,
THandler< TArray< FAccelByteModelsSyncThirdPartyFriendsResponse > > const & OnSuccess,
FErrorHandler const & OnError )

Sync platform specific friend list to AccelByte friend list. This will automatically add platform specific friend list to AccelByte friend list if the friends already linked their account to AccelByte service.

Parameters
Requestthe request of S2S friend sync.
OnSuccessThis will be called when the operation succeeded.
OnErrorThis will be called when the operation failed.
Returns
AccelByteTask object to track and cancel the ongoing API operation.

◆ UnblockPlayer() [1/2]

void AccelByte::Api::Lobby::UnblockPlayer ( FString const & UserId)

Unblock specified player enabling them to do certain action against current user.

Action that unblocked player can do : -Add Friend -Direct Chat -Invite to Party -Invite to Group -Matchmaking as one alliance

Additional Limitation : Unblocked Player can now access blocker/current user's user ID

Parameters
UserIdthe specified player's user ID. (Target to block)

◆ UnblockPlayer() [2/2]

FAccelByteTaskWPtr AccelByte::Api::Lobby::UnblockPlayer ( FString const & UserId,
FVoidHandler const & OnSuccess,
FErrorHandler const & OnError )

Unblock specified player enabling them to do certain action against current user.

Action that unblocked player can do : -Add Friend -Direct Chat -Invite to Party -Invite to Group -Matchmaking as one alliance

Additional Limitation : Unblocked Player can now access blocker/current user's user ID

Parameters
UserIdTargeted user ID.
OnSuccessThis will be called when the operation succeeded.
OnErrorThis will be called when the operation failed.
Returns
AccelByteTask object to track and cancel the ongoing API operation.

◆ Unfriend() [1/2]

void AccelByte::Api::Lobby::Unfriend ( FString const & UserId)

Send unfriend request.

Parameters
UserIdTargeted user ID.

◆ Unfriend() [2/2]

FAccelByteTaskWPtr AccelByte::Api::Lobby::Unfriend ( FString const & UserId,
FVoidHandler const & OnSuccess,
FErrorHandler const & OnError )

Unfriend a user from friend list.

Parameters
UserIdTargeted user ID.
OnSuccessThis will be called when the operation succeeded.
OnErrorThis will be called when the operation failed.
Returns
AccelByteTask object to track and cancel the ongoing API operation.

◆ WritePartyStorage()

FAccelByteTaskWPtr AccelByte::Api::Lobby::WritePartyStorage ( FString const & PartyId,
TFunction< FJsonObjectWrapper(FJsonObjectWrapper)> const & PayloadModifier,
THandler< FAccelByteModelsPartyDataNotif > const & OnSuccess,
FErrorHandler const & OnError,
uint32 RetryAttempt = 1 )

Write party storage (attributes) data to the targeted party ID. Beware: Object will not be write immediately, please take care of the original object until it written.

Parameters
PartyIdTargeted party Id.
PayloadModifierFunction to modify the latest party data with your customized modifier.
OnSuccessThis will be called when the operation succeeded. Will return FAccelByteModelsPartyDataNotif model.
OnErrorThis will be called when the operation failed.
RetryAttemptthe number of retry to do when there is an error in writing to party storage (likely due to write conflicts).
Returns
AccelByteTask object to track and cancel the ongoing API operation.