Provide an API to connect to Lobby and access its services. More...

Inheritance diagram for AccelByte.Api.Lobby:

Public Member Functions
void	OverrideWebsocket (IWebSocket inWebSocket, int inPingDelay=4000, int inBackoffDelay=1000, int inMaxDelay=30000, int inTotalTimeout=60000)
	Override current websocket instance, and set new retry parameters.
void	Connect ()
	Connect to lobby with current logged in user credentials. The token generator need to be set for connection with entitlement verification.
void	SetRetryParameters (int inTotalTimeout=60000, int inBackoffDelay=1000, int inMaxDelay=30000)
	Change the delay parameters to maintain connection in the lobby before lobby connected.
void	SetConnectionTokenGenerator (ITokenGenerator tokenGenerator)
	TokenGenerator is used for generate access token when connecting to lobby. If token generator is not specified, no token will be used when connecting to lobby. For entitlement token verification, use EntitlementTokenGenerator class on the parameter.
void	Disconnect ()
	Disconnect from Lobby.
void	ChangeUserRegion (string region, ResultCallback callback)
	Change user region.
void	GetNotifications (ResultCallback< GetUserNotificationsResponse > callback, DateTime startTime=default, DateTime endTime=default, int offset=0, int limit=25)
	Get list of notifications from user from specified time.
void	GetPartyInfo (ResultCallback< PartyInfo > callback)
	Get party information (leader, members, invitation token).
void	CreateParty (ResultCallback< PartyInfo > callback)
	Create a party and become a party leader for the party. The newer function has different struct return callback and it has partyCode.
void	CreateParty (ResultCallback< PartyCreateResponse > callback)
	Create a party and become a party leader for the party. PartyCode is also provided to the party creator through the callback?.
void	LeaveParty (ResultCallback callback)
	Leave a party a current logged in user is in.
void	InviteToParty (string userId, ResultCallback callback)
	Invite other user by userId. Only party leader (creator) can invite other user.
void	InviteToPartyDetailedCallback (string userId, ResultCallback< PartyInviteResponse > callback)
	Invite other user by userId with detailed model in response callback?. Only party leader (creator) can invite other user.
void	JoinParty (string partyID, string invitationToken, ResultCallback< PartyInfo > callback)
	Join a party by invitation from party leader.
void	KickPartyMember (string userId, ResultCallback callback)
	Kick a member out of our party. Only a party leader can kick a party member.
void	KickPartyMemberDetailedCallback (string userId, ResultCallback< KickResponse > callback)
	Kick a member out of our party with detailed model in response callback?. Only a party leader can kick a party member.
void	RejectPartyInvitation (string partyId, string invitationToken, ResultCallback< PartyRejectResponse > callback)
	Reject a party invitation.
void	GeneratePartyCode (ResultCallback< PartyGenerateCodeResponse > callback)
	Generate party code for invitation.
void	GetPartyCode (ResultCallback< PartyGetCodeResponse > callback)
	Get party code.
void	DeletePartyCode (ResultCallback callback)
	Remove party invite code.
void	JoinPartyViaCode (string invitationPartyCode, ResultCallback< PartyInfo > callback)
	Join to a party via party code.
void	PromotePartyLeader (string userId, ResultCallback< PartyPromoteLeaderResponse > callback)
	Promote member to be a party leader.
void	SetPartySizeLimit (string partyId, int limit, ResultCallback callback)
	Set party member size limit.
void	SendNotificationToPartyMember (string topic, string payload, ResultCallback< PartySendNotifResponse > callback)
	Send notification to party member.
void	SendPartyChat (string chatMessage, ResultCallback callback)
	Send chat to other party members.
void	SendPersonalChat (string userId, string chatMessage, ResultCallback callback)
	Send personal chat to friend.
void	JoinDefaultChatChannel (ResultCallback< ChatChannelSlug > callback)
	Send Join default global chat channel request.
void	SendChannelChat (string chatMessage, ResultCallback callback)
	Send a Chat Message to a Global Chat Channel.
void	SetUserStatus (UserStatus status, string activity, ResultCallback callback)
	Set current user status and activity.
void	ListFriendsStatus (ResultCallback< FriendsStatus > callback)
	Get a list of friends status (availability, activity, last seen at).
void	PullAsyncNotifications (ResultCallback callback)
	Ask lobby to send all pending notification to user. Listen to OnNotification.
void	RequestFriend (string userId, ResultCallback callback)
	Send request friend request.
void	RequestFriendByPublicId (string publicId, ResultCallback callback)
	Send request friend request using other profile's public id.
void	BulkRequestFriend (string[] userIds, ResultCallback callback)
	Add other users as friends automatically, other users don't need to accept it. This is used for syncing other platform friends to AccelByte friend.
void	Unfriend (string userId, ResultCallback callback)
	Send unfriend request.
void	ListOutgoingFriends (ResultCallback< Friends > callback)
	Send list of outgoing friends request.
void	ListOutgoingFriendsWithTime (ResultCallback< FriendsWithTimestamp > callback)
	Send list of outgoing friends request with added timestamp.
void	CancelFriendRequest (string userId, ResultCallback callback)
	Send cancel friend request.
void	ListIncomingFriends (ResultCallback< Friends > callback)
	Send list of incoming friends request.
void	ListIncomingFriendsWithTime (ResultCallback< FriendsWithTimestamp > callback)
	Send list of incoming friends request with added timestamp.
void	AcceptFriend (string userId, ResultCallback callback)
	Send accept friend request.
void	RejectFriend (string userId, ResultCallback callback)
	Send reject friend request.
void	LoadFriendsList (ResultCallback< Friends > callback)
	Send load friends list request.
void	GetFriendshipStatus (string userId, ResultCallback< FriendshipStatus > callback)
	Send get friendship status request.
void	BulkGetUserPresence (string[] userIds, ResultCallback< BulkUserStatusNotif > callback, bool countOnly=false)
	Send request get user presence in bulk.
void	SyncThirdPartyFriends (SyncThirdPartyFriendsRequest request, ResultCallback< SyncThirdPartyFriendsResponse[]> callback)
	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.
void	StartMatchmaking (string gameMode, ResultCallback< MatchmakingCode > callback)
	Send matchmaking start request.
void	StartMatchmaking (string gameMode, string serverName, ResultCallback< MatchmakingCode > callback)
	Send matchmaking start request.
void	StartMatchmaking (string gameMode, string serverName, string clientVersion, ResultCallback< MatchmakingCode > callback)
	Send matchmaking start request.
void	StartMatchmaking (string gameMode, string clientVersion, Dictionary< string, int > latencies, ResultCallback< MatchmakingCode > callback)
	Send matchmaking start request.
void	StartMatchmaking (string gameMode, string clientVersion, Dictionary< string, int > latencies, Dictionary< string, object > partyAttributes, ResultCallback< MatchmakingCode > callback)
	Send matchmaking start request.
void	StartMatchmaking (string gameMode, string clientVersion, Dictionary< string, int > latencies, Dictionary< string, object > partyAttributes, string[] tempPartyUserIds, ResultCallback< MatchmakingCode > callback)
	Send matchmaking start request.
void	StartMatchmaking (string gameMode, string clientVersion, Dictionary< string, int > latencies, Dictionary< string, object > partyAttributes, string[] tempPartyUserIds, string[] extraAttributes, ResultCallback< MatchmakingCode > callback)
	Send matchmaking start request.
void	StartMatchmaking (string gameMode, string serverName, string clientVersion, Dictionary< string, object > partyAttributes, ResultCallback< MatchmakingCode > callback)
	Send matchmaking start request.
void	StartMatchmaking (string gameMode, string serverName, string clientVersion, Dictionary< string, object > partyAttributes, string[] tempPartyUserIds, ResultCallback< MatchmakingCode > callback)
	Send matchmaking start request.
void	StartMatchmaking (string gameMode, string serverName, string clientVersion, Dictionary< string, object > partyAttributes, string[] tempPartyUserIds, string[] extraAttributes, ResultCallback< MatchmakingCode > callback)
	Send matchmaking start request.
void	StartMatchmaking (string gameMode, string serverName, string clientVersion, Dictionary< string, int > latencies, Dictionary< string, object > partyAttributes, string[] tempPartyUserIds, string[] extraAttributes, ResultCallback< MatchmakingCode > callback)
	Send matchmaking start request.
void	StartMatchmaking (string gameMode, MatchmakingOptionalParam param, ResultCallback< MatchmakingCode > callback)
	Send matchmaking start request.
void	ConfirmReadyForMatch (string matchId, ResultCallback callback)
	Send a message to matchmaking service to indicate the user is ready for match.
void	RejectMatch (string matchId, ResultCallback callback)
	Reject match that was found.
void	CancelMatchmaking (string gameMode, ResultCallback< MatchmakingCode > callback)
	Send matchmaking cancel request.
void	CancelMatchmaking (string gameMode, bool isTempParty, ResultCallback< MatchmakingCode > callback)
	Send matchmaking cancel request.
void	RequestDS (CustomDsCreateRequest request)
	Request Dedicated Custom Server.
void	GetPartyStorage (string partyId, ResultCallback< PartyDataUpdateNotif > callback)
	Get party storage by party ID.
void	WritePartyStorage (string partyId, ResultCallback< PartyDataUpdateNotif > callback, Func< Dictionary< string, object >, Dictionary< string, object > > payloadModifier, int retryAttempt=1)
	Write party storage data to the targeted party ID. Beware: Object will not be write immediately, please take care of the original object until it written.
void	BlockPlayer (string userId, ResultCallback< BlockPlayerResponse > callback)
	Block the specified player from doing some action against current user. The specified player will be removed from current user's friend list too.
void	UnblockPlayer (string userId, ResultCallback< UnblockPlayerResponse > callback)
	Unblock the specified player and allow it to some action against current user again.
void	GetListOfBlockedUser (ResultCallback< BlockedList > callback)
	get current logged in user's blocked list.
void	GetListOfBlocker (ResultCallback< BlockerList > callback)
	Get users that currently blocking the user logged in.
void	SetProfanityFilterLevel (ProfanityFilterLevel level, ResultCallback callback)
	Set chat profanity filter level.
void	SetSessionAttribute (string key, string value, ResultCallback callback)
	Set user's lobby session attributes.
void	GetSessionAttribute (string key, ResultCallback< GetSessionAttributeResponse > callback)
	Get user's lobby session attributes.
void	GetSessionAttributeAll (ResultCallback< GetSessionAttributeAllResponse > callback)
	Get all of the user's lobby session attributes.
void	SendSignalingMessage (string userId, string message)
	Send a signaling message to another user.

Properties
bool	IsConnected `[get]`
	Lobby connection status.
Properties inherited from AccelByte.Core.WrapperBase
Utils.AccelByteIdValidator	IdValidator `[get]`

Events
Action	Connected
	Raised when lobby is connected.
ResultCallback< DisconnectNotif >	Disconnecting
	Raised when lobby got message from server that it will disconnect.
Action< WsCloseCode >	Disconnected
	Raised when lobby is disconnected.
Action	Reconnecting
	Raised when lobby is attempting to reconnect.
ResultCallback< PartyInvitation >	InvitedToParty
	Raised when a user is invited to party.
ResultCallback< JoinNotification >	JoinedParty
	Raised when some user joined our party.
ResultCallback< KickNotification >	KickedFromParty
	Raised when the user is kicked from party.
ResultCallback< LeaveNotification >	LeaveFromParty
	Raised when the user leave from party.
ResultCallback< PartyRejectNotif >	RejectedPartyInvitation
	Raised when a user reject party invitation.
ResultCallback< SessionV2PartySessionUpdatedNotification >	SessionV2PartyUpdated
	SessionV2 - Raised when a party session is updated.
ResultCallback< SessionV2PartyInvitationNotification >	SessionV2InvitedUserToParty
	SessionV2 - Raised when a user is being invited to a party.
ResultCallback< SessionV2PartyJoinedNotification >	SessionV2UserJoinedParty
	SessionV2 - Raised when a user joined a party.
ResultCallback< SessionV2PartyMembersChangedNotification >	SessionV2PartyMemberChanged
	SessionV2 - Raised when a party's members changed.
ResultCallback< SessionV2PartyInvitationRejectedNotification >	SessionV2UserRejectedPartyInvitation
	SessionV2 - Raised when a user rejected party invitation.
ResultCallback< SessionV2PartyInvitationCancelledNotification >	SessionV2PartyInvitationCancelled
	SessionV2 - Raised when a leader is canceling an invitation.
ResultCallback< SessionV2PartyUserKickedNotification >	SessionV2UserKickedFromParty
	SessionV2 - Raised when a user is kicked from party.
ResultCallback< SessionV2GameInvitationNotification >	SessionV2InvitedUserToGameSession
	SessionV2 - Raised when a user is being invited to a game session.
ResultCallback< SessionV2GameJoinedNotification >	SessionV2UserJoinedGameSession
	SessionV2 - Raised when a user joined a game session.
ResultCallback< SessionV2GameMembersChangedNotification >	SessionV2GameSessionMemberChanged
	SessionV2 - Raised when a game session's members changed.
ResultCallback< SessionV2GameUserKickedNotification >	SessionV2UserKickedFromGameSession
	SessionV2 - Raised when a user is kicked from game session.
ResultCallback< SessionV2GameInvitationRejectedNotification >	SessionV2UserRejectedGameSessionInvitation
	SessionV2 - Raised when a user rejected game session invitation.
ResultCallback< SessionV2GameSessionUpdatedNotification >	SessionV2GameSessionUpdated
	SessionV2 - Raised when a game session is updated.
ResultCallback< SessionV2GameSessionEndedNotification >	SessionV2GameSessionEnded
	SessionV2 - Raised when a game session is ended by the DS.
ResultCallback< SessionV2DsStatusUpdatedNotification >	SessionV2DsStatusChanged
	SessionV2 - Raised when status of DS changed.
ResultCallback< SessionStorageChangedNotification >	SessionV2StorageChanged
	SessionV2 - Raised when session storage changed.
ResultCallback< SessionV2JoinedSecret >	SessionV2JoinedSecret
	SessionV2 - Raised when received Joined change.
ResultCallback< MatchmakingV2MatchFoundNotification >	MatchmakingV2MatchFound
	MatchmakingV2 - Raised when match is found.
ResultCallback< MatchmakingV2MatchmakingStartedNotification >	MatchmakingV2MatchmakingStarted
	MatchmakingV2 - Raised when matchmaking started.
ResultCallback< MatchmakingV2MatchmakingCanceledNotification >	MatchmakingV2MatchmakingCanceled
	MatchmakingV2 - Raised when matchmaking is canceled.
ResultCallback< MatchmakingV2TicketExpiredNotification >	MatchmakingV2TicketExpired
	MatchmakingV2 - Raised when matchmaking ticket expired.
ResultCallback< ChatMessage >	PersonalChatReceived
	Raised when personal chat message received.
ResultCallback< ChatMessage >	PartyChatReceived
	Raised when party chat message received.
ResultCallback< PartyCreatedNotification >	PartyCreatedNotification
	Triggered when party successfully created.
ResultCallback< Notification >	OnNotification
	Raised when a notification (usually from the system or admin) is received.
ResultCallback< FriendsStatusNotif >	FriendsStatusChanged
	Raised when friends status changed.
ResultCallback< Friend >	FriendRequestAccepted
	Raised when friend request accepted.
ResultCallback< RequestFriend >	OnIncomingFriendRequest
	Raised when there is an incoming friend request.
ResultCallback< Friend >	OnUnfriend
	Raised when friend remove user from friendlist.
ResultCallback< Acquaintance >	FriendRequestCanceled
	Raised when friend request canceled.
ResultCallback< Acquaintance >	FriendRequestRejected
	Raised when friend request rejected.
ResultCallback< DsNotif >	DSUpdated
	Raised when DS process is updated.
ResultCallback< PartyDataUpdateNotif >	PartyDataUpdateNotif
	Raised when there's an update in the party's storage.
ResultCallback< PartyNotif >	PartyNotif
	Raised when other party member send party notification.
ResultCallback< ChannelChatMessage >	ChannelChatReceived
	Raised when channel chat message received.
ResultCallback< PlayerBlockedNotif >	PlayerBlockedNotif
	Raised when player is blocked.
ResultCallback< PlayerUnblockedNotif >	PlayerUnblockedNotif
	Raised when player is unblocked.
ResultCallback< UserBannedNotification >	UserBannedNotification
	Raised when player is banned.
ResultCallback< UserBannedNotification >	UserUnbannedNotification
	Raised when player is unbanned.
ResultCallback< SignalingP2P >	SignalingP2PNotification
	Raised when there is an incoming signaling notification.
ResultCallback	ErrorNotification
	Raised when a general error notification is sent from lobby.
Action	TokenRefreshed
	Raised when lobby access token succesfully updated.
EventHandler	OnRetryAttemptFailed `[add, remove]`
	Event triggered each time a websocket reconnection attempt failed.

Detailed Description

Provide an API to connect to Lobby and access its services.

Member Function Documentation

◆ AcceptFriend()

void AccelByte.Api.Lobby.AcceptFriend	(	string	userId,
		ResultCallback	callback )

inline

Send accept friend request.

Parameters

userId	Targeted user ID.
callback	Result of the function.

◆ BlockPlayer()

void AccelByte.Api.Lobby.BlockPlayer	(	string	userId,
		ResultCallback< BlockPlayerResponse >	callback )

inline

Block the specified player from doing some action against current user. The specified player will be removed from current user's friend list too.

Actions that prevented to do each other:

add friend
direct chat
invite to party
invite to group
matchmaking result as one alliance

Additional limitation:

blocked player cannot access blocker/current user's UserProfile.

Parameters

userId	Blocked user's user ID
callback	Returns a result via callback when completed

◆ BulkGetUserPresence()

void AccelByte.Api.Lobby.BulkGetUserPresence	(	string[]	userIds,
		ResultCallback< BulkUserStatusNotif >	callback,
		bool	countOnly = false )

inline

Send request get user presence in bulk.

Parameters

userIds	requested userIds
callback	Returns a Result that contains BulkUserStatusNotif via callback when completed.

◆ BulkRequestFriend()

void AccelByte.Api.Lobby.BulkRequestFriend	(	string[]	userIds,
		ResultCallback	callback )

inline

Add other users as friends automatically, other users don't need to accept it. This is used for syncing other platform friends to AccelByte friend.

Parameters

userIds	Targeted user IDs.
callback	Returns a Result via callback when completed.

◆ CancelFriendRequest()

void AccelByte.Api.Lobby.CancelFriendRequest	(	string	userId,
		ResultCallback	callback )

inline

Send cancel friend request.

Parameters

userId	Targeted user ID.
callback	Returns a Result via callback when completed.

◆ CancelMatchmaking() [1/2]

void AccelByte.Api.Lobby.CancelMatchmaking	(	string	gameMode,
		bool	isTempParty,
		ResultCallback< MatchmakingCode >	callback )

inline

Send matchmaking cancel request.

Parameters

gameMode	Target matchmaking game mode
isTempParty	Is using temp party when starting matchmaking
callback	Result of the function with a cancel matchmaking status code.

◆ CancelMatchmaking() [2/2]

void AccelByte.Api.Lobby.CancelMatchmaking	(	string	gameMode,
		ResultCallback< MatchmakingCode >	callback )

inline

Send matchmaking cancel request.

Parameters

gameMode	Target matchmaking game mode
callback	Result of the function with a cancel matchmaking status code.

◆ ChangeUserRegion()

void AccelByte.Api.Lobby.ChangeUserRegion	(	string	region,
		ResultCallback	callback )

inline

Change user region.

Parameters

region	New region
callback	Returns a result via callback when completed

◆ ConfirmReadyForMatch()

void AccelByte.Api.Lobby.ConfirmReadyForMatch	(	string	matchId,
		ResultCallback	callback )

inline

Send a message to matchmaking service to indicate the user is ready for match.

Parameters

matchId
callback

◆ CreateParty() [1/2]

void AccelByte.Api.Lobby.CreateParty ( ResultCallback< PartyCreateResponse > callback )

inline

Create a party and become a party leader for the party. PartyCode is also provided to the party creator through the callback?.

Parameters

callback Returns a Result that contain PartyCreateResponse via callback when completed.

◆ CreateParty() [2/2]

void AccelByte.Api.Lobby.CreateParty ( ResultCallback< PartyInfo > callback )

inline

Create a party and become a party leader for the party. The newer function has different struct return callback and it has partyCode.

Parameters

callback Returns a Result that contain PartyInfo via callback when completed.

◆ DeletePartyCode()

void AccelByte.Api.Lobby.DeletePartyCode ( ResultCallback callback )

inline

Remove party invite code.

Parameters

callback

◆ GeneratePartyCode()

void AccelByte.Api.Lobby.GeneratePartyCode ( ResultCallback< PartyGenerateCodeResponse > callback )

inline

Generate party code for invitation.

Parameters

callback Return the party code that has been generated if success

◆ GetFriendshipStatus()

void AccelByte.Api.Lobby.GetFriendshipStatus	(	string	userId,
		ResultCallback< FriendshipStatus >	callback )

inline

Send get friendship status request.

Parameters

userId	Targeted user ID.
callback	Returns a Result that contains FriendshipStatus via callback when completed.

◆ GetListOfBlockedUser()

void AccelByte.Api.Lobby.GetListOfBlockedUser ( ResultCallback< BlockedList > callback )

inline

get current logged in user's blocked list.

Parameters

callback Returns a result via callback when complete

◆ GetListOfBlocker()

void AccelByte.Api.Lobby.GetListOfBlocker ( ResultCallback< BlockerList > callback )

inline

Get users that currently blocking the user logged in.

Parameters

callback Returns a result via callback when complete

◆ GetNotifications()

void AccelByte.Api.Lobby.GetNotifications	(	ResultCallback< GetUserNotificationsResponse >	callback,
		DateTime	startTime = default,
		DateTime	endTime = default,
		int	offset = 0,
		int	limit = 25 )

inline

Get list of notifications from user from specified time.

Parameters

callback	Returns a result via callback when completed
startTime	Start time to filter notifications from
endTime	End time to filter notifications to
offset	Offset of result array value. Default value is 0.
limit	Offset of result array value. Default value is 25.

◆ GetPartyCode()

void AccelByte.Api.Lobby.GetPartyCode ( ResultCallback< PartyGetCodeResponse > callback )

inline

Get party code.

Parameters

callback Return the party code that has been generated previously if success

◆ GetPartyInfo()

void AccelByte.Api.Lobby.GetPartyInfo ( ResultCallback< PartyInfo > callback )

inline

Get party information (leader, members, invitation token).

Parameters

callback Returns a Result that contains PartyInfo via callback when completed.

◆ GetPartyStorage()

void AccelByte.Api.Lobby.GetPartyStorage	(	string	partyId,
		ResultCallback< PartyDataUpdateNotif >	callback )

inline

Get party storage by party ID.

Parameters

partyId	Targeted party ID.
callback	Returns a Result via callback when completed.

◆ GetSessionAttribute()

void AccelByte.Api.Lobby.GetSessionAttribute	(	string	key,
		ResultCallback< GetSessionAttributeResponse >	callback )

inline

Get user's lobby session attributes.

Parameters

key	Attribute key
callback	Returns a result via callback when complete

◆ GetSessionAttributeAll()

void AccelByte.Api.Lobby.GetSessionAttributeAll ( ResultCallback< GetSessionAttributeAllResponse > callback )

inline

Get all of the user's lobby session attributes.

Parameters

callback Returns a result via callback when complete

◆ InviteToParty()

void AccelByte.Api.Lobby.InviteToParty	(	string	userId,
		ResultCallback	callback )

inline

Invite other user by userId. Only party leader (creator) can invite other user.

Parameters

userId	User Id of a person to be invited to
callback	Returns a Result via callback when completed

◆ InviteToPartyDetailedCallback()

void AccelByte.Api.Lobby.InviteToPartyDetailedCallback	(	string	userId,
		ResultCallback< PartyInviteResponse >	callback )

inline

Invite other user by userId with detailed model in response callback?. Only party leader (creator) can invite other user.

Parameters

userId	User Id of a person to be invited to
callback	Returns a Result that contain PartyInviteResponse via callback when completed

◆ JoinDefaultChatChannel()

void AccelByte.Api.Lobby.JoinDefaultChatChannel ( ResultCallback< ChatChannelSlug > callback )

inline

Send Join default global chat channel request.

Parameters

callback Returns a Result that contains ChatChannelSlug via callback when completed.

◆ JoinParty()

void AccelByte.Api.Lobby.JoinParty	(	string	partyID,
		string	invitationToken,
		ResultCallback< PartyInfo >	callback )

inline

Join a party by invitation from party leader.

Parameters

partyID	Party ID of the party to join to
invitationToken	Invitation token to join the party
callback	Returns a Result that contains PartyInfo via callback when completed

◆ JoinPartyViaCode()

void AccelByte.Api.Lobby.JoinPartyViaCode	(	string	invitationPartyCode,
		ResultCallback< PartyInfo >	callback )

inline

Join to a party via party code.

Parameters

callback

◆ KickPartyMember()

void AccelByte.Api.Lobby.KickPartyMember	(	string	userId,
		ResultCallback	callback )

inline

Kick a member out of our party. Only a party leader can kick a party member.

Parameters

userId	User Id of the user to be kicked out of party
callback	Returns a Result via callback when completed.

◆ KickPartyMemberDetailedCallback()

void AccelByte.Api.Lobby.KickPartyMemberDetailedCallback	(	string	userId,
		ResultCallback< KickResponse >	callback )

inline

Kick a member out of our party with detailed model in response callback?. Only a party leader can kick a party member.

Parameters

userId	User Id of the user to be kicked out of party
callback	Returns a Result that contains PartyKickResponse via callback when completed.

◆ LeaveParty()

void AccelByte.Api.Lobby.LeaveParty ( ResultCallback callback )

inline

Leave a party a current logged in user is in.

Parameters

callback Returns a Result via callback when completed

◆ ListFriendsStatus()

void AccelByte.Api.Lobby.ListFriendsStatus ( ResultCallback< FriendsStatus > callback )

inline

Get a list of friends status (availability, activity, last seen at).

Parameters

callback Returns a Result that contains Friends Status via callback when completed.

◆ ListIncomingFriends()

void AccelByte.Api.Lobby.ListIncomingFriends ( ResultCallback< Friends > callback )

inline

Send list of incoming friends request.

Parameters

callback Returns a Result that contains Friends via callback when completed.

◆ ListIncomingFriendsWithTime()

void AccelByte.Api.Lobby.ListIncomingFriendsWithTime ( ResultCallback< FriendsWithTimestamp > callback )

inline

Send list of incoming friends request with added timestamp.

Parameters

callback Returns a Result that contains FriendsWithTimestamp via callback when completed.

◆ ListOutgoingFriends()

void AccelByte.Api.Lobby.ListOutgoingFriends ( ResultCallback< Friends > callback )

inline

Send list of outgoing friends request.

Parameters

callback Returns a Result that contains Friends via callback when completed.

◆ ListOutgoingFriendsWithTime()

void AccelByte.Api.Lobby.ListOutgoingFriendsWithTime ( ResultCallback< FriendsWithTimestamp > callback )

inline

Send list of outgoing friends request with added timestamp.

Parameters

callback Returns a Result that contains FriendsWithTimestamp via callback when completed.

◆ LoadFriendsList()

void AccelByte.Api.Lobby.LoadFriendsList ( ResultCallback< Friends > callback )

inline

Send load friends list request.

Parameters

callback Returns a Result that contains Friends via callback when completed.

◆ OverrideWebsocket()

void AccelByte.Api.Lobby.OverrideWebsocket	(	IWebSocket	inWebSocket,
		int	inPingDelay = 4000,
		int	inBackoffDelay = 1000,
		int	inMaxDelay = 30000,
		int	inTotalTimeout = 60000 )

inline

Override current websocket instance, and set new retry parameters.

Parameters

inWebSocket	IWebsocket instance to use
inPingDelay	delay for each connection ping
inBackoffDelay	first backoff delay duration for a retry connection attempt
inMaxDelay	max delay for each retry connection attempt
inTotalTimeout

◆ PromotePartyLeader()

void AccelByte.Api.Lobby.PromotePartyLeader	(	string	userId,
		ResultCallback< PartyPromoteLeaderResponse >	callback )

inline

Promote member to be a party leader.

Parameters

userId	User ID that will be promoted as a party leader.
callback	Returns a Result via callback when completed.

◆ PullAsyncNotifications()

void AccelByte.Api.Lobby.PullAsyncNotifications ( ResultCallback callback )

inline

Ask lobby to send all pending notification to user. Listen to OnNotification.

Parameters

callback Returns a Result via callback when completed.

◆ RejectFriend()

void AccelByte.Api.Lobby.RejectFriend	(	string	userId,
		ResultCallback	callback )

inline

Send reject friend request.

Parameters

userId	Targeted user ID.
callback	Result of the function.

◆ RejectMatch()

void AccelByte.Api.Lobby.RejectMatch	(	string	matchId,
		ResultCallback	callback )

inline

Reject match that was found.

Parameters

matchId
callback

◆ RejectPartyInvitation()

void AccelByte.Api.Lobby.RejectPartyInvitation	(	string	partyId,
		string	invitationToken,
		ResultCallback< PartyRejectResponse >	callback )

inline

Reject a party invitation.

Parameters

partyId	Party ID of an incoming party invitation that will be declined.
invitationToken	Invitation token of an incoming party invitation that will be declined.
callback	Returns a Result via callback when completed.

◆ RequestDS()

void AccelByte.Api.Lobby.RequestDS ( CustomDsCreateRequest request )

inline

Request Dedicated Custom Server.

Parameters

request	Specification
callback

◆ RequestFriend()

void AccelByte.Api.Lobby.RequestFriend	(	string	userId,
		ResultCallback	callback )

inline

Send request friend request.

Parameters

userId	Targeted user ID.
callback	Returns a Result via callback when completed.

◆ RequestFriendByPublicId()

void AccelByte.Api.Lobby.RequestFriendByPublicId	(	string	publicId,
		ResultCallback	callback )

inline

Send request friend request using other profile's public id.

Parameters

publicId	Targeted user ID.
callback	Returns a Result via callback when completed.

◆ SendChannelChat()

void AccelByte.Api.Lobby.SendChannelChat	(	string	chatMessage,
		ResultCallback	callback )

inline

Send a Chat Message to a Global Chat Channel.

Parameters

chatMessage	Message to send to the channel
callback	Returns a Result via callback when completed

◆ SendNotificationToPartyMember()

void AccelByte.Api.Lobby.SendNotificationToPartyMember	(	string	topic,
		string	payload,
		ResultCallback< PartySendNotifResponse >	callback )

inline

Send notification to party member.

Parameters

topic	Topic The topic of the request. Can use this as ID to know how to marshal the payload
payload	Payload The Payload of the request. Can be JSON string
callback	Returns a Result that contains PartySendNotifResponse via callback when completed.

◆ SendPartyChat()

void AccelByte.Api.Lobby.SendPartyChat	(	string	chatMessage,
		ResultCallback	callback )

inline

Send chat to other party members.

Parameters

chatMessage	Message to send to party
callback	Returns a Result via callback when completed

◆ SendPersonalChat()

void AccelByte.Api.Lobby.SendPersonalChat	(	string	userId,
		string	chatMessage,
		ResultCallback	callback )

inline

Send personal chat to friend.

Parameters

userId	Friend user id
chatMessage	Message to send to friend
callback	Returns a Result via callback when completed

◆ SendSignalingMessage()

void AccelByte.Api.Lobby.SendSignalingMessage	(	string	userId,
		string	message )

inline

Send a signaling message to another user.

Parameters

userId	The recipient's user ID.
message	Signaling message to be sent.

◆ SetConnectionTokenGenerator()

void AccelByte.Api.Lobby.SetConnectionTokenGenerator ( ITokenGenerator tokenGenerator )

inline

TokenGenerator is used for generate access token when connecting to lobby. If token generator is not specified, no token will be used when connecting to lobby. For entitlement token verification, use EntitlementTokenGenerator class on the parameter.

Parameters

tokenGenerator Token generator for connecting lobby.

◆ SetPartySizeLimit()

void AccelByte.Api.Lobby.SetPartySizeLimit	(	string	partyId,
		int	limit,
		ResultCallback	callback )

inline

Set party member size limit.

Parameters

partyId	designated party id
limit	member limit
callback	returns a Result via callback when completed

◆ SetProfanityFilterLevel()

void AccelByte.Api.Lobby.SetProfanityFilterLevel	(	ProfanityFilterLevel	level,
		ResultCallback	callback )

inline

Set chat profanity filter level.

Parameters

level	level of profanity filter to apply
callback	Returns a result via callback when complete

◆ SetRetryParameters()

void AccelByte.Api.Lobby.SetRetryParameters	(	int	inTotalTimeout = 60000,
		int	inBackoffDelay = 1000,
		int	inMaxDelay = 30000 )

inline

Change the delay parameters to maintain connection in the lobby before lobby connected.

Parameters

inTotalTimeout	Time limit until stop to re-attempt
inBackoffDelay	Initial delay time
inMaxDelay	Maximum delay time

◆ SetSessionAttribute()

void AccelByte.Api.Lobby.SetSessionAttribute	(	string	key,
		string	value,
		ResultCallback	callback )

inline

Set user's lobby session attributes.

Parameters

key	Attribute key
value	Attribute value
callback	Returns a result via callback when complete

◆ SetUserStatus()

void AccelByte.Api.Lobby.SetUserStatus	(	UserStatus	status,
		string	activity,
		ResultCallback	callback )

inline

Set current user status and activity.

Parameters

status	User status (Online, Available, Busy, Invisible)
activity	Describe an activity of the user, could be anything.
callback	Returns a Result via callback when completed.

◆ StartMatchmaking() [1/12]

void AccelByte.Api.Lobby.StartMatchmaking	(	string	gameMode,
		MatchmakingOptionalParam	param,
		ResultCallback< MatchmakingCode >	callback )

inline

Send matchmaking start request.

Parameters

gameMode
callback
param

◆ StartMatchmaking() [2/12]

void AccelByte.Api.Lobby.StartMatchmaking	(	string	gameMode,
		ResultCallback< MatchmakingCode >	callback )

inline

Send matchmaking start request.

Parameters

gameMode	Target matchmaking game mode
callback	Result of the function with a start matchmaking status code.

◆ StartMatchmaking() [3/12]

void AccelByte.Api.Lobby.StartMatchmaking	(	string	gameMode,
		string	clientVersion,
		Dictionary< string, int >	latencies,
		Dictionary< string, object >	partyAttributes,
		ResultCallback< MatchmakingCode >	callback )

inline

Send matchmaking start request.

Parameters

gameMode	Target matchmaking game mode
clientVersion	Game client version to ensure match with the same version
latencies	Server latencies based on regions
partyAttributes	Matchmaker will match party with the same party attributes
callback	Result of the function with a start matchmaking status code.

◆ StartMatchmaking() [4/12]

void AccelByte.Api.Lobby.StartMatchmaking	(	string	gameMode,
		string	clientVersion,
		Dictionary< string, int >	latencies,
		Dictionary< string, object >	partyAttributes,
		string[]	tempPartyUserIds,
		ResultCallback< MatchmakingCode >	callback )

inline

Send matchmaking start request.

Parameters

gameMode	Target matchmaking game mode
clientVersion	Game client version to ensure match with the same version
latencies	Server latencies based on regions
partyAttributes	Matchmaker will match party with the same party attributes
tempPartyUserIds	UserIDs to form a temporary party with (include user who started the matchmaking). Temporary party will disband when matchmaking finishes.
callback	Result of the function with a start matchmaking status code.

◆ StartMatchmaking() [5/12]

void AccelByte.Api.Lobby.StartMatchmaking	(	string	gameMode,
		string	clientVersion,
		Dictionary< string, int >	latencies,
		Dictionary< string, object >	partyAttributes,
		string[]	tempPartyUserIds,
		string[]	extraAttributes,
		ResultCallback< MatchmakingCode >	callback )

inline

Send matchmaking start request.

Parameters

gameMode	Target matchmaking game mode
clientVersion	Game client version to ensure match with the same version
latencies	Server latencies based on regions
partyAttributes	Matchmaker will match party with the same party attributes
tempPartyUserIds	UserIDs to form a temporary party with (include user who started the matchmaking). Temporary party will disband when matchmaking finishes.
extraAttributes	Custom attributes defined in game mode's matching/flexing rule
callback	Result of the function with a start matchmaking status code.

◆ StartMatchmaking() [6/12]

void AccelByte.Api.Lobby.StartMatchmaking	(	string	gameMode,
		string	clientVersion,
		Dictionary< string, int >	latencies,
		ResultCallback< MatchmakingCode >	callback )

inline

Send matchmaking start request.

Parameters

gameMode	Target matchmaking game mode
clientVersion	Game client version to ensure match with the same version
latencies	Server latencies based on regions
callback	Result of the function with a start matchmaking status code.

◆ StartMatchmaking() [7/12]

void AccelByte.Api.Lobby.StartMatchmaking	(	string	gameMode,
		string	serverName,
		ResultCallback< MatchmakingCode >	callback )

inline

Send matchmaking start request.

Parameters

gameMode	Target matchmaking game mode
serverName	Server name to do match in Local DS
callback	Result of the function with a start matchmaking status code.

◆ StartMatchmaking() [8/12]

void AccelByte.Api.Lobby.StartMatchmaking	(	string	gameMode,
		string	serverName,
		string	clientVersion,
		Dictionary< string, int >	latencies,
		Dictionary< string, object >	partyAttributes,
		string[]	tempPartyUserIds,
		string[]	extraAttributes,
		ResultCallback< MatchmakingCode >	callback )

inline

Send matchmaking start request.

Parameters

gameMode	Target matchmaking game mode
serverName	Server name to do match in Local DS
clientVersion	Game client version to ensure match with the same version
latencies

Preferred latencies

Parameters

partyAttributes	Matchmaker will match party with the same party attributes
tempPartyUserIds	UserIDs to form a temporary party with (include user who started the matchmaking). Temporary party will disband when matchmaking finishes.
extraAttributes	Custom attributes defined in game mode's matching/flexing rule
callback	Result of the function with a start matchmaking status code.

◆ StartMatchmaking() [9/12]

void AccelByte.Api.Lobby.StartMatchmaking	(	string	gameMode,
		string	serverName,
		string	clientVersion,
		Dictionary< string, object >	partyAttributes,
		ResultCallback< MatchmakingCode >	callback )

inline

Send matchmaking start request.

Parameters

gameMode	Target matchmaking game mode
serverName	Server name to do match in Local DS
clientVersion	Game client version to ensure match with the same version
partyAttributes	Party attributes the matchmaker will do string equality check to matchmake with other party's party attribute
callback	Result of the function with a start matchmaking status code.

◆ StartMatchmaking() [10/12]

void AccelByte.Api.Lobby.StartMatchmaking	(	string	gameMode,
		string	serverName,
		string	clientVersion,
		Dictionary< string, object >	partyAttributes,
		string[]	tempPartyUserIds,
		ResultCallback< MatchmakingCode >	callback )

inline

Send matchmaking start request.

Parameters

gameMode	Target matchmaking game mode
serverName	Server name to do match in Local DS
clientVersion	Game client version to ensure match with the same version
partyAttributes	Matchmaker will match party with the same party attributes
tempPartyUserIds	UserIDs to form a temporary party with (include user who started the matchmaking). Temporary party will disband when matchmaking finishes.
callback	Result of the function with a start matchmaking status code.

◆ StartMatchmaking() [11/12]

void AccelByte.Api.Lobby.StartMatchmaking	(	string	gameMode,
		string	serverName,
		string	clientVersion,
		Dictionary< string, object >	partyAttributes,
		string[]	tempPartyUserIds,
		string[]	extraAttributes,
		ResultCallback< MatchmakingCode >	callback )

inline

Send matchmaking start request.

Parameters

gameMode	Target matchmaking game mode
serverName	Server name to do match in Local DS
clientVersion	Game client version to ensure match with the same version
partyAttributes	Matchmaker will match party with the same party attributes
tempPartyUserIds	UserIDs to form a temporary party with (include user who started the matchmaking). Temporary party will disband when matchmaking finishes.
extraAttributes	Custom attributes defined in game mode's matching/flexing rule
callback	Result of the function with a start matchmaking status code.

◆ StartMatchmaking() [12/12]

void AccelByte.Api.Lobby.StartMatchmaking	(	string	gameMode,
		string	serverName,
		string	clientVersion,
		ResultCallback< MatchmakingCode >	callback )

inline

Send matchmaking start request.

Parameters

gameMode	Target matchmaking game mode
serverName	Server name to do match in Local DS
clientVersion	Game client version to ensure match with the same version
callback	Result of the function with a start matchmaking status code.

◆ SyncThirdPartyFriends()

void AccelByte.Api.Lobby.SyncThirdPartyFriends	(	SyncThirdPartyFriendsRequest	request,
		ResultCallback< SyncThirdPartyFriendsResponse[]>	callback )

inline

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

request	The request containing details of platform information.
callback	Returns a Result that contain response details.

◆ UnblockPlayer()

void AccelByte.Api.Lobby.UnblockPlayer	(	string	userId,
		ResultCallback< UnblockPlayerResponse >	callback )

inline

Unblock the specified player and allow it to some action against current user again.

Allow each other to:

add friend
direct chat
invite to party
invite to group
matchmaking result as one alliance

Additional limitation:

unblocked player can access blocker/current user's UserProfile.

Parameters

userId	Unblocked user's user ID
callback	Returns a result via callback when completed

◆ Unfriend()

void AccelByte.Api.Lobby.Unfriend	(	string	userId,
		ResultCallback	callback )

inline

Send unfriend request.

Parameters

userId	Targeted user ID.
callback	Returns a Result via callback when completed.

◆ WritePartyStorage()

void AccelByte.Api.Lobby.WritePartyStorage	(	string	partyId,
		ResultCallback< PartyDataUpdateNotif >	callback,
		Func< Dictionary< string, object >, Dictionary< string, object > >	payloadModifier,
		int	retryAttempt = 1 )

inline

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

Parameters

partyId	Targeted party ID.
callback	Returns a Result via callback when completed.
payloadModifier	Function to modify the latest party data with your customized modifier.
retryAttempt	the number of retry to do when there is an error in writing to party storage (likely due to write conflicts).

Public Member Functions

Properties

Events

Detailed Description

Member Function Documentation

◆ AcceptFriend()

◆ BlockPlayer()

◆ BulkGetUserPresence()

◆ BulkRequestFriend()

◆ CancelFriendRequest()

◆ CancelMatchmaking() [1/2]

◆ CancelMatchmaking() [2/2]

◆ ChangeUserRegion()

◆ ConfirmReadyForMatch()

◆ CreateParty() [1/2]

◆ CreateParty() [2/2]

◆ DeletePartyCode()

◆ GeneratePartyCode()

◆ GetFriendshipStatus()

◆ GetListOfBlockedUser()

◆ GetListOfBlocker()

◆ GetNotifications()

◆ GetPartyCode()

◆ GetPartyInfo()

◆ GetPartyStorage()

◆ GetSessionAttribute()

◆ GetSessionAttributeAll()

◆ InviteToParty()

◆ InviteToPartyDetailedCallback()

◆ JoinDefaultChatChannel()

◆ JoinParty()

◆ JoinPartyViaCode()

◆ KickPartyMember()

◆ KickPartyMemberDetailedCallback()

◆ LeaveParty()

◆ ListFriendsStatus()

◆ ListIncomingFriends()

◆ ListIncomingFriendsWithTime()

◆ ListOutgoingFriends()

◆ ListOutgoingFriendsWithTime()

◆ LoadFriendsList()

◆ OverrideWebsocket()

◆ PromotePartyLeader()

◆ PullAsyncNotifications()

◆ RejectFriend()

◆ RejectMatch()

◆ RejectPartyInvitation()

◆ RequestDS()

◆ RequestFriend()

◆ RequestFriendByPublicId()

◆ SendChannelChat()

◆ SendNotificationToPartyMember()

◆ SendPartyChat()

◆ SendPersonalChat()

◆ SendSignalingMessage()

◆ SetConnectionTokenGenerator()

◆ SetPartySizeLimit()

◆ SetProfanityFilterLevel()

◆ SetRetryParameters()

◆ SetSessionAttribute()

◆ SetUserStatus()

◆ StartMatchmaking() [1/12]

◆ StartMatchmaking() [2/12]

◆ StartMatchmaking() [3/12]

◆ StartMatchmaking() [4/12]

◆ StartMatchmaking() [5/12]

◆ StartMatchmaking() [6/12]

◆ StartMatchmaking() [7/12]

◆ StartMatchmaking() [8/12]

◆ StartMatchmaking() [9/12]

◆ StartMatchmaking() [10/12]

◆ StartMatchmaking() [11/12]

◆ StartMatchmaking() [12/12]

◆ SyncThirdPartyFriends()

◆ UnblockPlayer()

◆ Unfriend()

◆ WritePartyStorage()