Client Data Models

Enums

MatchmakingStatus

Battle session status

/// namespace: Pgos.Client
public enum MatchmakingStatus

member	value	description
Dummy	0	Dummy
Starting	1	matchmaking is starting
Preparing	2	the multi-player matchmaking's preparation phase. note: when the MatchmakingObserver receives this status, it requires players to join or reject the matchmaking request. mutilplayer matchmaking : when one of the players start a matchmaking request, the other players will receive the 'Preparing' matchmaking status, and then decide to join or reject the matchmaking request. When everyone has joined, matchmaking start Searching.
Searching	3	search players for matchmaking
Accepting	4	wait for players to accepting the result of matchmaking
Placing	5	placing battle session on game DS
Completed	7	The matchmaking request ends with a successful result. Check battle_session_info for detail information about the battle. Note: when the MatchmakingObserver receives this status, you need to connect the DS server via IP and port that could obtain from battle_session_info.
TimedOut	8	matchmaking request timeout
Terminated	9	matchmaking request is terminated
Canceled	10	matchmaking request is canceled. The request may have been canceled by the player or the matchmaking result has been rejected by the player
Error	11	matchmaking request error

MatchmakingMutexType

Mutex type of matchmaking request

/// namespace: Pgos.Client
public enum MatchmakingMutexType

member	value	description
PerMatchmakingConfig	0	There is no limit to the number of battle sessions a player can be in. multiple matchmaking requests from a player in the same matchmaking config are not allowed at the same time.
PerPlayer	1	If a player has any on going battle sessions or matchmaking in progress, they will not be able to start new matchmaking request.

PlayerBattleSessionStatus

Player battle session status

/// namespace: Pgos.Client
public enum PlayerBattleSessionStatus

member	value	description
Dummy	0	Dummy
Pending	1	The player battle session requires DS to call the ReservePlayerBattleSession interface for approval.
Reserved	2	Reserved players can be validated through the AcceptPlayerBattleSession interface.
Active	3	Player battle session status turn to ACTIVE after AcceptPlayerBattleSession is called successfully.
Completed	4	This is the terminal status of player battle session.The status will turn to COMPLETED after RemovePlayerBattleSession is called or player actively leave the battle session.
Disconnected	5	The player has disconnected from DS server.

P2PPlayerBattleSessionStatus

Status of a P2P player battle session

/// namespace: Pgos.Client
public enum P2PPlayerBattleSessionStatus

member	value	description
Dummy	0	Dummy
Reserved	2	Reserved players can be validated through the AcceptPlayerBattleSession interface.
Active	3	Player battle session status turn to ACTIVE after AcceptPlayerBattleSession is called successfully.
Completed	4	This is the terminal status of player battle session.The status will turn to COMPLETED after RemovePlayerBattleSession is called or player actively leave the battle session.
Disconnected	5	The player has disconnected from DS server.

BattleSessionStatus

Battle session status

/// namespace: Pgos.Client
public enum BattleSessionStatus

member	value	description
Dummy	0	Dummy
Placing	1	the battle session is currently waiting to be placed on a game DS.
Active	2	the battle session have been successfully created.
Terminated	3	the battle session have been terminated.
Error	5	the battle session error, check status_msg for more information.
Cancelled	6	the battle session is cancelled.
TimedOut	7	the battle session timeout
Failed	8	the battle session failed, check status_msg for more information.

P2PBattleSessionStatus

P2P Battle session status

/// namespace: Pgos.Client
public enum P2PBattleSessionStatus

member	value	description
Dummy	0	Dummy
Placing	1	the battle session is currently waiting to be placed on a game DS.
Active	2	the battle session have been successfully created.
HostHealthChecking	3	P2P clients should report the host health state within a limited time.
NewHostSelected	4	the new host has been selected and must accept the identity within a limited time. The new host needs to call the ActivateP2PBattleSession interface to reactivate the battle session.
Terminated	101	the battle session have been terminated.
Error	102	the battle session error, check status_msg for more information.
TimedOut	103	the battle session timeout
Failed	104	the battle session failed, check status_msg for more information.

FriendRequestProcessStatus

Friend request process status

/// namespace: Pgos.Client
public enum FriendRequestProcessStatus

member	value	description
Pending	0	friend request pending
Accepted	1	request Accepted
Expired	2	it may be timed out, the current validity period is 7 days

ReadStatus

Message read status

/// namespace: Pgos.Client
public enum ReadStatus

member	value	description
Unread	0	message unread
Read	1	message read

LobbyStatus

Lobby status

/// namespace: Pgos.Client
public enum LobbyStatus

member	value	description
Dummy	0	Dummy
Waiting	1	StartBattle has not been called
Preparing	2	StartBattle was called, but not all lobby members are READY
Playing	3	A battle session that contains all lobby members is ready to be joined

LobbyPrivacy

Lobby privacy type

/// namespace: Pgos.Client
public enum LobbyPrivacy

member	value	description
Dummy	0	Dummy
Visible	1	Lobby can be searched
Invisible	2	Lobby can only be searched using the exact lobby_id

LobbyProtection

Lobby protection type

/// namespace: Pgos.Client
public enum LobbyProtection

member	value	description
Dummy	0	Dummy should be used when searching lobbies for all protection types
PasswordNeeded	1	Password needed when joining lobbies
PasswordUnneeded	2	Password unneeded when joining lobbies
FreeAccess	2	Players can join lobby directly
ApplicationNeeded	3	A join request will be sent to the owner after calling the JoinLobby interface, and the owner's approval is required to successfully join the lobby

LobbyJoiningSource

The source of the player join the lobby

/// namespace: Pgos.Client
public enum LobbyJoiningSource

member	value	description
Dummy	0	Dummy
JoiningByLobbyID	1	Search for the lobby and join.
JoiningFromInvitation	2	Join the lobby through the event of 'OnLobbyInvitation' when the player is invited to join the lobby.
JoiningAsOwner	3	The lobby creator.
JoiningByQuickJoin	4	Joined by QuickJoin interface.

LobbyStatusReason

The reason that the lobby status changes

/// namespace: Pgos.Client
public enum LobbyStatusReason

member	value	description
Dummy	0	Dummy
SomeoneNotReady	1	The lobby owner starts the battle, and lobby status changes from Waiting to Preparing.
PlacingFailed	2	Placing is failed, and lobby status changes from Placing to Waiting.
PreparingTimeout	3	Preparing is timeout because there are members not ready, and lobby status changes from Preparing to Waiting.
BattleCompleted	4	Battle is completed, and lobby status changes from Playing to Waiting.
PreparationInterrupted	5	Because of member changing, preparing status is interrupted and changes to Waiting.

LobbyStartBattleCondition

The action when the lobby owner invokes the StartBattle interface depends on the Ready flag of lobby members.

/// namespace: Pgos.Client
public enum LobbyStartBattleCondition

member	value	description
AllReadyOtherwiseWaiting	0	The lobby will enter the Preparing stage, waiting for unready players to get ready.
AllReadyOtherwiseError	1	The lobby owner will receive an error if not all players are ready.
IgnoringReadyFlag	2	The lobby will enter the Playing stage directly, ignoring the Ready flag.

OnlineStatus

Online status: online or offline

/// namespace: Pgos.Client
public enum OnlineStatus

member	value	description
Offline	0	Player is online
Online	1	Player is offline

StoreOrderStatus

/// namespace: Pgos.Client
public enum StoreOrderStatus

member	value	description
Dummy	0	None.
StoreOrderProcessing	1	Order is being processed.
StoreOrderCompleted	2	Purchase successful.
StoreOrderFailed	3	Purchase failed.

StoreItemStatus

/// namespace: Pgos.Client
public enum StoreItemStatus

member	value	description
Dummy	0	None.
Available	1	The item can be purchased normally.
Owned	2	The unique item can't be purchased because the player already owns.
ExceedLimit	3	The store item can't be purchased because the player have reached the maximum purchase limit.

StoreCategoryType

/// namespace: Pgos.Client
public enum StoreCategoryType

member	value	description
Simple	0	A simple category be used to manage the publish and retire of store items.
Manual	1	The category schedule will be enabled to support multi-period publish schedule management. Could be used to implement advanced features such as limited-time sales and regular product updates.
Rotation	2	The category schedule will be a rotation schedule.

GroupJoinRule

Join rules of the group.

/// namespace: Pgos.Client
public enum GroupJoinRule

member	value	description
Any	0	Players can freely join the group.
MemberInvite	1	Must be invited by group members to join the group.
AdminInvite	2	Must be invited by group administrator to join the group.
Forbid	3	No one is allowed to join.

ChatMsgType

Message type.

/// namespace: Pgos.Client
public enum ChatMsgType

member	value	description
MsgTypeText	0	Type of text message, sent via SendGroupTextMsg.
MsgTypeCustom	1	Type of custom message, sent via SendGroupCustomMsg.
MsgTypeEvent	2	Type of event message, sent by the system.
MsgTypeSystem	3	Type of system message, sent by the system.

GroupEventType

Type of event message.

/// namespace: Pgos.Client
public enum GroupEventType

member	value	description
Dummy	0
GroupNameChanged	1	Group name has been changed.
GroupDescChanged	2	Group description has been changed.
GroupMemberJoined	3	New member joined.
GroupMemberLeft	4	Member left the group.
GroupMemberRemoved	5	Member removed.
GroupAnnouncementChanged	6	Group announcement has been changed.
GroupOwnerChanged	7	Group owner has changed.
GroupAdminGranted	8	Member granted to group administrator.
GroupAdminRevoked	9	Group administrator is revoked.

GroupOfficialFilterType

Group searching filter type for official.

/// namespace: Pgos.Client
public enum GroupOfficialFilterType

member	value	description
Dummy	0	Don't filter official groups when searching.
NotOfficial	1	Only search unofficial groups.
Official	2	Only search official groups.

GroupRoomFilterType

Group searching filter type for left rooms.

/// namespace: Pgos.Client
public enum GroupRoomFilterType

member	value	description
Dummy	0	Don't filter group rooms when searching.
NotFull	1	Only search groups that are not full.
Full	2	Only search full groups.

GroupOrderBy

The basis for sorting group search result.

/// namespace: Pgos.Client
public enum GroupOrderBy

member	value	description
Dummy	0	No sorting of search result.
MemberCount	1	Search result sorted by members count.
CreatedTime	2	Search result sorted by creation time.

GroupOrderType

The order type for group search result.

/// namespace: Pgos.Client
public enum GroupOrderType

member	value	description
Dummy	0	No sorting of search results.
Asc	1	Ascending order for search result.
Desc	2	Descending order for search result.

MailCategory

/// namespace: Pgos.Client
public enum MailCategory

member	value	description
All	0	All categories.
System	1	System category.
Notice	2	Notice category.
Campaign	3	Campaign category.
Award	4	Award category.
Gift	5	Gift category. Usually received gifts from other players.
Custom	6	Custom category. Category for developer customization.

GoalType

/// namespace: Pgos.Client
public enum GoalType

member	value	description
Dummy	0
Simple	1
Hyper	2

GoalRewardWay

/// namespace: Pgos.Client
public enum GoalRewardWay

member	value	description
Dummy	0
Manual	1	Goal reward need to be claimed manually
Mail	2	When the goal is achieved, the rewards will be automatically granted through the preset email template

ScheduleStatus

/// namespace: Pgos.Client
public enum ScheduleStatus

member	value	description
Dummy	0
Published	1
Retired	2

PrivacyItemType

/// namespace: Pgos.Client
public enum PrivacyItemType

member	value	description
Dummy	0
AllowSearchedByOthers	1
AllowFriendRequest	2
AllowNonFriendPersChat	3
AllowGroupInvitation	4
ChatStrategy	5

PrivacyChatStrategy

Text and voice chat privacy settings

/// namespace: Pgos.Client
public enum PrivacyChatStrategy

member	value	description
Allow	0	Everyone, can see and be seen chat messages from anyone (except block list)
OnlyFriends	1	Friends, can only see friends and be seen by friends
Blocked	2	Not allowed at all, won't see anyone's messages, and won't send any messages out

LobbyOrderBy

/// namespace: Pgos.Client
public enum LobbyOrderBy

member	value	description
LOBBY_ORDER_BY_DEFAULT	0	Sort by status: Waiting, Preparing, Playing;then by create time from older to newer
LOBBY_ORDER_BY_CREATE_TIME	1	Sort by lobby create time
LOBBY_ORDER_BY_UPDATE_TIME	2	Sort by lobby last update time
LOBBY_ORDER_BY_JOINED_MEMBER_COUNT	3	Sort by joined member count
LOBBY_ORDER_BY_MISSING_MEMBER_COUNT	4	Sort by empty slot count

LobbyOrderType

The order type for group search result.

/// namespace: Pgos.Client
public enum LobbyOrderType

member	value	description
LOBBY_ORDER_TYPE_ASCENDING	0	Ascending order for search result.
LOBBY_ORDER_TYPE_DESCENDING	1	Descending order for search result.

PartyJoinStrategy

The strategy controls the rules who could join the party

/// namespace: Pgos.Client
public enum PartyJoinStrategy

member	value	description
Public	0	Open to anyone, it's the default strategy
OnlyFriendsOfLeader	1	Only friends of the leader could join the party
OnlyFriendsOfMembers	2	Only friends of any member could join the party
OnlyInvited	3	Only invited players could join the party
NotAllowed	4	No one can join

PartyInviteStrategy

The strategy controls the rules who could invite others to the party

/// namespace: Pgos.Client
public enum PartyInviteStrategy

member	value	description
AllMembersCanInvite	0	All members of the party can invite others, it's the default strategy
OnlyLeaderCanInvite	1	Only the party leader can invite others

PgosEventChannelStatus

Various status definitions of the PGOS event channel. The Event Channel serves as a data pipeline for the PGOS backend to send event notifications (e.g., chat_messages/friend_requests) to the client.

/// namespace: Pgos.Client
public enum PgosEventChannelStatus

member	value	description
Dummy	0	Invalid status.
Creating	1	When the client is connecting or reconnecting to the backend in order to establish the channel, the status is set to 'Creating'.
Available	2	When the channel is successfully established, the status is set to 'Available', indicating that the event notification service is functioning properly.
Unavailable	3	When the client expectedly(logout) or unexpectedly(network exception) disconnects from the backend, the status is set to 'Unavailable', and the event notification service stops working. The SDK will automatically attempt to rebuild the channel until it succeeds, with a gradually slowing frequency. It starts by trying to rebuild every 3 seconds and eventually reduces the frequency to once every 5 minutes.

MidasRoleIDMethod

/// namespace: Pgos.Client
public enum MidasRoleIDMethod

member	value	description
Game	0
PGOS	1

JoinWorldInvitationStatus

Describe the status of the join world invitation.

/// namespace: Pgos.Client
public enum JoinWorldInvitationStatus

member	value	description
Dummy	0	Invalid status.
Pending	1	Means: there are still invited players who have not yet confirmed whether to accept or reject the invitation.
Completed	2	Means: all invited players have made their choices to accept/reject, or the invitation has timed out. And no more 'OnJoinWorldInvitationUpdated' event of this invitation_ticket. Now, the player who accepted the invitation has been added to the battle session. Typically, the player who accepts the invitation will receive the 'OnWorldBattleSessionUpdated' event after the invitation status is marked as 'Completed'. However, if the player is already in the assigned battle session before the invitation, and has obtained the battle session's IP&port (which means he has received the relevant event of the battle session status being Active), then he may not be pushed the 'OnWorldBattleSessionUpdated' event.
Error	3	Means: An error has occurred (e.g. not enough slots left in the world). Please refer to the 'error_msg' in 'JoinWorldInvitationInfo' structure for more details.

JoinWorldInvitationAction

The player's action type in response to a join world invitation.

/// namespace: Pgos.Client
public enum JoinWorldInvitationAction

member	value	description
Undecided	0	The player has not yet decided.
Accepted	1	The player has decided to accept the invitation.
Rejected	2	The player has decided to reject the invitation.

LeaveWorldInvitationStatus

Describe the status of the leave world invitation.

/// namespace: Pgos.Client
public enum LeaveWorldInvitationStatus

member	value	description
Dummy	0	Invalid status.
Pending	1	Means: there are still invited players who have not yet confirmed whether to accept or reject the invitation.
Completed	2	Means: all invited players have made their choices to accept/reject, or the invitation has timed out. And no more 'OnLeaveWorldInvitationUpdated' event of this invitation_ticket. Now, the player who accepted the invitation has been removed from the world.
Error	3	Please refer to the 'error_msg' in 'LeaveWorldInvitationInfo' structure for more details.

LeaveWorldInvitationAction

The player's action type in response to a leave world invitation.

/// namespace: Pgos.Client
public enum LeaveWorldInvitationAction

member	value	description
Undecided	0	The player has not yet decided.
Accepted	1	The player has decided to accept the invitation.
Rejected	2	The player has decided to reject the invitation.

P2PConnectionType

The type of P2P connection.

/// namespace: Pgos.Client
public enum P2PConnectionType

member	value	description
Unspecified	0	Unspecified. Will try to connect via p2p first.
P2P	1	Try to connect via p2p.
Relay	2	Try to connect via relay.

NatType

The type of NAT.

/// namespace: Pgos.Client
public enum NatType

member	value	description
Unknown	0
Open	1	No Nat
FullCone	2	Full Cone
AddressRestrictedCone	3	Address restricted cone
PortRestrictedCone	4	Port restricted cone
Symmetric	5	Symmetric
SymmetricUDPFirewall	6	No NAT with UDP firewall
UDPBlocked	7

Structs

Balance

The currency in the player's wallet.

/// namespace: Pgos.Client
struct Balance

field	type	description
currency_code	string	The code of the currency.
currency_name	string	The name of the currency.
currency_icon	string	The uri of the currency.
currency_type	CurrencyType	Currency type.
amount	Int64	The balance of the currency.
max_deposit	Int64	The maximum balance that a player can hold for this currency. A value of 0 represents no limitation.

MidasGlobalBalance

/// namespace: Pgos.Client
struct MidasGlobalBalance : Balance

parent: Balance

field	type	description
resource_id	string	Resource id of a Midas Token, provided by Midas, view on Midas portal.
gift_balance	string	Balance obtained by gift.
accumulated_topup_amount	string	Accumulated topup amount.
accumulated_gift_amount	string	Accumulated gift amount.
total_consume	string	Total consumed amount.
first_topup	bool	To show if it is the first topup.

FasLoginInfo

FAS: The data of the simulated account

/// namespace: Pgos.Client
struct FasLoginInfo

field	type	description
open_id	string	Open id of the fake account
token	string	Token of the fake account
user_name	string	Username of the fake account
token_valid_time	Int64	The valid time of the current token

FasRefreshTokenInfo

The new token after refreshing it

/// namespace: Pgos.Client
struct FasRefreshTokenInfo

field	type	description
token	string	The new token generated after refreshing

LoginPGOSParams

Request parameters for login PGOS.

/// namespace: Pgos.Client
struct LoginPGOSParams : BaseBackendEventParams

parent: BaseBackendEventParams

field	type	description
account_provider	Int32	Account provider: 0 means FAS, 1 means INTL, 2 means MSDK, 3 means WeGame, 4 means PlayFab, 5 means Steam, 6 means Epic, 7 means XboxLive, 8 means PlayStationNetwork, 9 means Nintendo, 10 means JWT. The default value is -1 (not set), at which point PgosSDK will try to read it from the configuration: account_provider. Using int32 instead of enum type is to make SDK better compatible with the new account provider. More info for account provider: https://pgos.intlgame.com/pgosdoc/manual/service_manual/player_management/player_auth.html#311-login-param
account_open_id	string	Open id of the logged in account service.
account_token	string	Token of the open id.
title_region_id	string	Title region the player wants to login, can be obtained from PGOS portal console.
extra_param	Dictionary<string, string>	[Optional] Extra parameter for the account provider, Its value depends on the account provider used to log in. view the manual for detail: https://pgos.intlgame.com/pgosdoc/manual/service_manual/player_management/player_auth.html#31-log-in-pgos.

LogoutPGOSParams

Request parameters for logout PGOS.

/// namespace: Pgos.Client
struct LogoutPGOSParams : BaseBackendEventParams

parent: BaseBackendEventParams

PlayerBannedEvt

The event will be triggered when the player is banned.

/// namespace: Pgos.Client
struct PlayerBannedEvt

field	type	description
ban_reason	string	Reason for ban.
ban_created_time	Int64	Ban creation time. Unix timestamp in seconds.
ban_duration	Int64	Ban duration in seconds.
ban_expired_time	Int64	Ban expiration time. Unix timestamp in seconds, if the value <= 0, it is considered to be permanently banned.

AuthBanInfo

Auth ban info.

/// namespace: Pgos.Client
struct AuthBanInfo : PlayerBannedEvt

parent: PlayerBannedEvt

field	type	description
is_banned	bool	Whether the player is banned.

AuthenticationInfo

The authentication data when the game needs to identify the player and manage the player session status of the players

/// namespace: Pgos.Client
struct AuthenticationInfo

field	type	description
player_id	string	The id of the player
session_id	string	The id of the current authenticated session
is_first_login	bool	Whether the player is logging in for the first time
is_display_name_modified	bool	Whether the display name of the current player has been modified. The display name is initially an empty string before being modified.
account_platform	string	account platform name, such as: 'Steam', 'Epic', 'PlayStationNetwork'.
ban_info	AuthBanInfo	Whether the player is banned

BatchGetPlayerInfoCltRsp

Response that client batch getting playerInfo.

/// namespace: Pgos.Client
struct BatchGetPlayerInfoCltRsp

field	type	description
data	Dictionary<string, PlayerInfo>	Player infos, key: player_id, value: player_info.
fail_players	Dictionary<string, string>	Players who totally failed, key: player_id, value: failed reason.

MatchmakingPlayerInfo

Player who is in the matchmaking process

/// namespace: Pgos.Client
struct MatchmakingPlayerInfo

field	type	description
player_id	string	The player id
team	string	The team of the players
match_attributes	Dictionary<string, KVDataValue>	Attributes needed by the Matchmaking Ruleset, map key: attribute name, map value: attribute value.

RequestedPlayerInfo

Player in current matchmaking request.

/// namespace: Pgos.Client
struct RequestedPlayerInfo

field	type	description
player_info	PlayerInfo	Base info of a player.
ready	bool	Whether the player has joined matchmaking.
region_latencies	List<RegionLatencyInfo>	The latency(ms) of the player in different regions. If the latency of the player exceeds the max latency of Queue, then the player cannot join the battle.

MatchedPlayerInfo

Player who has already matched

/// namespace: Pgos.Client
struct MatchedPlayerInfo

field	type	description
player_info	PlayerInfo	Base info of a player.
accepted_status	AcceptedStatus	Player response to the proposed battle.
team	string	The team of the players

CancelMatchmakingInfo

Cancel a matchmaking request

/// namespace: Pgos.Client
struct CancelMatchmakingInfo

field	type	description
ticket_id	string	Ticket id for the matchmaking request
canceled	bool	Whether the player has canceled the matchmaking request
reason	string	The reason for the cancel action, not necessary

StartMatchmakingParams

Params to start a matchmaking request.

/// namespace: Pgos.Client
struct StartMatchmakingParams

field	type	description
configuration_name	string	Name of matchmaking configuration
player_info_list	List<MatchmakingPlayerInfo>	Players who start matchmaking together, and they must be set to the same team.
mutex_type	MatchmakingMutexType	Mutex type of matchmaking request. PerMatchmakingConfig as default value.

StartMatchmakingInfo

Start a matchmaking request

/// namespace: Pgos.Client
struct StartMatchmakingInfo

field	type	description
ticket_id	string	Ticket id for the matchmaking request

CurrentMatchmakingsInfo

Current activate matchmaking tickets of the player.

/// namespace: Pgos.Client
struct CurrentMatchmakingsInfo

field	type	description
tickets_map	Dictionary<string, string>	The mapping of matchmaking configuration to matchmaking ticket.

PlayerBattleSessionInfo

A player-battle-session is a session between a player and an active battle-session

/// namespace: Pgos.Client
struct PlayerBattleSessionInfo

field	type	description
player_id	string	The player id
battle_session_id	string	The battle session id to query
player_battle_session_id	string	The id of player session in the battle, !!! NOT BATTLE SESSION ID !!!
ip_address	string	The access ip address of the battle session
port	UInt32	The access port of the battle session
status	PlayerBattleSessionStatus
team_name	string	Team name in a world battle session.

BattleSessionInfo

A battle session corresponds a running game.

/// namespace: Pgos.Client
struct BattleSessionInfo

field	type	description
battle_session_id	string	The battle session id to query
created_time	Int64	The Unix timestamp(in seconds) when the battle session was created.
ip_address	string	The IP address of the DS holding the battle session, and it will be assigned the value when the status is 'Active'.
port	UInt32	The port of the DS holding the battle session, and it will be assigned the value when the status is 'Active'.
status	BattleSessionStatus	Placing the battle session is currently waiting to be placed on game DS Active the battle session has been successfully created, now you can connect to the DS using the IP address and port Terminated the battle session has been terminated Error the battle session error, check status_msg for more information Canceled the battle session is canceled Timeout the battle session timeout Failed the battle session failed, check status_msg for more information
status_msg	string	The message of the battle status
last_updated_time	Int64	The Unix timestamp(in seconds) for the last update in the battle status
terminated_time	Int64	The Unix timestamp(in seconds) when the player disconnected from game server.
placing_timeout	UInt32	Timeout for placing status
cur_player_battle_session_info	PlayerBattleSessionInfo	Player battle session of current player
battle_properties	List<BattleProperty>	K-V pair property of a battle session
battle_session_data	string	Custom string data of a battle session. Preset in matchmaking configuration
source_type	BattleSourceType	What service that the battle session generated from
configuration_name	string	Configuration name of matchmaking, lobby or world service
bucket_path	Dictionary<string, string>	Mapping from bucket filter attribute name to attribute value. [for WORLD battle session only]
ruleset_name	string	Ruleset name hit. Filled when battle session source type is BattleSourceType::Matchmaking
locked	bool	True if the battle session is locked by game server A battle session generated from world service could be locked/unlocked by calling Lock/UnlockWorldBattleSession.
zone	string	Zone where the battle session placed.

P2PPlayerBattleSession

A player-battle-session is a session between a player and a activated battle-session.

/// namespace: Pgos.Client
struct P2PPlayerBattleSession

field	type	description
battle_session_id	string	The battle session id.
player_battle_session_id	string	The id of player session in the battle, !!! NOT BATTLE SESSION ID !!!
player_id	string	The player id
status	P2PPlayerBattleSessionStatus
created_time	Int64	The Unix timestamp(in seconds) when the battle session was created.
terminated_time	Int64	The Unix timestamp(in seconds) when the battle session was terminated.

P2PBattleSessionBase

A battle session corresponds a running game.

/// namespace: Pgos.Client
struct P2PBattleSessionBase

field	type	description
battle_session_id	string	The battle session id to query
host_player_id	string	Host player of the P2P battle session
status	P2PBattleSessionStatus	Battle session status
status_msg	string	The message of the battle status
source_type	BattleSourceType	What service that the battle session generated from
configuration_name	string	Configuration name of matchmaking, lobby or world service
ruleset_name	string	Ruleset name hit. Filled when battle session source type is BattleSourceType::Matchmaking
battle_properties	List<BattleProperty>	K-V pair property of a battle session
battle_session_data	string	Custom string data of a battle session. Preset in matchmaking configuration
max_players	Int32	Maximum number of players in the battle session If the source of the battle session is Matchmaking, the max_players is calculated from the teams section of ruleset script If the source of the game is Lobby, the max_players is calculated from the teams section of lobby config
total_players	Int32	Total number of players in the battle session. Only players with a player battle session status of COMPLETED will be excluded
created_time	Int64	The Unix timestamp(in seconds) when the battle session was created.
terminated_time	Int64	The Unix timestamp(in seconds) when the player disconnected from game server.

P2PBattleSession

A battle session corresponds a running game.

/// namespace: Pgos.Client
struct P2PBattleSession : P2PBattleSessionBase

parent: P2PBattleSessionBase

field	type	description
cur_player_battle_session_info	P2PPlayerBattleSession	Player battle session of current player

MatchmakingProcessInfo

Detailed process of a matchmaking request.

/// namespace: Pgos.Client
struct MatchmakingProcessInfo

field	type	description
matchmaking_status	MatchmakingStatus	Starting Matchmaking request is starting. Preparing Waiting for players confirmation for a multi-player matchmaking request. Note: when the MatchmakingObserver receives this status, it requires players to join or reject the mutilplayer matchmaking request. When one of the players start a mutilplayer matchmaking request, the other players will receive the 'Preparing' matchmaking status, and then decide to join or reject the matchmaking request. When everyone has joined, matchmaking start Searching. Searching Search players who fit the ruleset. Accepting Wait for players to accept the result of matchmaking. Placing Placing battle session on game DS. Pending Deprecated since <v0.12.7>. Use Placing instead. Completed The matchmaking request ends with a successful result. Check battle_session_info for detail information about the battle. Note: when the MatchmakingObserver receives this status, you need to connect the DS server via IP and port that could obtain from battle_session_info. Timeout Matchmaking request timeout. Terminated Matchmaking request is terminated. Canceled Matchmaking request is canceled. The request may have been canceled by the player or the matchmaking result has been rejected by the player. Error Matchmaking request error.
matchmaking_message	string	The message of the matchmaking status.
last_updated_status_time	Int64	The Unix timestamp(in seconds) for the last update in the matchmaking status.
ticket_id	string	Ticket id for the matchmaking request.
configuration_name	string	The target matchmaking configuration name of current matchmaking request.
requested_players	List<RequestedPlayerInfo>	Players in current matchmaking request.
matched_players	List<MatchedPlayerInfo>	Players already matched.
matchmaking_creator_id	string	Originator of the matchmaking request.
match_start_time	Int64	The Unix timestamp(in seconds) when the matchmaking started.
match_end_time	Int64	The Unix timestamp(in seconds) when the matchmaking ended.
estimated_searching_time	UInt32	Not used.
preparing_timeout	UInt32	The maximum time(in seconds) to wait for all request members to accept the request.
searching_timeout	UInt32	The maximum time(in seconds) to wait for searching matched players.
accepting_timeout	UInt32	The maximum time(in seconds) to wait for accepting a matched battle
placing_timeout	UInt32	Timeout(in seconds) for Placing status.
concurrent_player_count	UInt32	Number of players searching in current match config
battle_session_info	BattleSessionInfo	A battle session contains matched players.
battle_session_provider	string	Provider of battle session management: @ PGOS for PGOS battle service @ STANDALONE for self-build battle session management service. @ P2P for battle session hosted by game P2P game client
p2p_host_player_id	string	Host player id for a P2P battle provide by P2P matchmaking. Only be filled when @battle_session_provider is set to P2P. OnStartP2PBattleSession event of P2PBattle module should be handled by the host client to obtain detail information of a P2P battle sesssion.
p2p_battle_session_id	string	P2P Battle sesssion id provide by P2P matchmaking. Only be filled when @battle_session_provider is set to P2P. Battle session activation events will be pushed through OnP2PBattleSessionUpdated events of P2PBattle module.

GetConcurrentMatchmakingPlayerCountParams

/// namespace: Pgos.Client
struct GetConcurrentMatchmakingPlayerCountParams

field	type	description
configuration_name	string	Matchmaking configuration name.

GetConcurrentMatchmakingPlayerCountResult

/// namespace: Pgos.Client
struct GetConcurrentMatchmakingPlayerCountResult

field	type	description
count	UInt32	Players in current matchmaking pool.

PartyCustomData

Custom data for party.

/// namespace: Pgos.Client
struct PartyCustomData

field	type	description
version	int	Custom data version, always incremental over the lifetime of the party.
global_custom_data	string	Global custom data. Only Leader has permission to modify it.
player_custom_data	Dictionary<string, string>	Player custom data. The map key is party member's player ID, the map value is the party member's custom data. Each party member could modify it's player custom data.

PartyInfo

Detailed information of a party

/// namespace: Pgos.Client
struct PartyInfo

field	type	description
party_id	string	The party id
name	string	Name of the party
leader	PlayerInfo	Player who is the leader of the party A leader can: Kick out members: a leader can kick out any member at any time. Dismiss the party. Transfer leadership to another member.
members	List<PlayerInfo>	Players of the party
created_time	Int64	The Unix timestamp(in seconds) when the party was created.
max_player	UInt32	Max number of players in the party, unlimited if it is 0.
custom_data	PartyCustomData	Custom data of the party(including global and player).
join_strategy	PartyJoinStrategy	The strategy controls the rules who could join the party.
invite_strategy	PartyInviteStrategy	The strategy controls the rules who could invite others to the party.

SetPartyStrategyParams

The parameters of join/invite strategy used to SetPartyStrategy

/// namespace: Pgos.Client
struct SetPartyStrategyParams

field	type	description
party_id	string	The party id
join_strategy	PartyJoinStrategy	The strategy controls the rules who could join the party.
invite_strategy	PartyInviteStrategy	The strategy controls the rules who could invite others to the party.

CreatePartyParams

Request struct for create party

/// namespace: Pgos.Client
struct CreatePartyParams

field	type	description
party_name	string	Optional name of the new party
max_player	UInt32	The maximum limit on the count of party members, pass 0 if you don't want to limit
enable_chatting	bool	If true, the party members can use SendPartyChatTextMsg/SendPartyChatCustomMsg/SetOnReceiveChatMsg
join_strategy	PartyJoinStrategy	The strategy controls the rules who could join the party.
invite_strategy	PartyInviteStrategy	The strategy controls the rules who could invite others to the party.

SendPartyChatMsgParams

Request struct for sending party chat message

/// namespace: Pgos.Client
struct SendPartyChatMsgParams

field	type	description
content	string	The message content to be sent
custom_data	string	Additional information added by the game

BattleDataInfo

Raw battle history data

/// namespace: Pgos.Client
struct BattleDataInfo

field	type	description
battle_session_id	string	The battle session id to query
data	Dictionary<string, string>	Battle custom kv data, such as {key1:value1, key2:value2}
tags	List<string>	Battle custom tags, you can filter battles by tags, such as [Entertainment]
fails	Dictionary<string, string>	A list of failed items in K-V pair data operations
battle_created_time	Int64	The Unix timestamp(in seconds) when the battle session was created.

BattleListInfo

A list of battle history data

/// namespace: Pgos.Client
struct BattleListInfo

field	type	description
battle_data_list	List<BattleDataInfo>	A list of raw battle history data
next_offset	UInt32	The next starting position of the list

BattleBriefInfo

A special battle history data that is preset by PGOS.

/// namespace: Pgos.Client
struct BattleBriefInfo

field	type	description
battle_session_id	string	The battle session id to query
brief	string	Custom battle brief, such as current player's KDA
tags	List<string>	Battle custom tags, you can filter battles by tags, such as [Entertainment]
battle_created_time	Int64	The Unix timestamp(in seconds) when the battle session was created.

BattleDetailInfo

A special battle history data that is preset by PGOS.

/// namespace: Pgos.Client
struct BattleDetailInfo

field	type	description
battle_session_id	string	The battle session id to query
detail	string	Custom battle detail, such as the KDA of all players
tags	List<string>	Battle custom tags, you can filter battles by tags, such as [Entertainment]
battle_created_time	Int64	The Unix timestamp(in seconds) when the battle session was created.

BattleBriefListInfo

A list of battle brief info

/// namespace: Pgos.Client
struct BattleBriefListInfo

field	type	description
battle_data_list	List<BattleBriefInfo>	A list of raw battle history data
next_offset	UInt32	The next starting position of the list

MentionedPlayer

The mentioned player. When the value of player_id is '@ALL', it means mentioning all players.

/// namespace: Pgos.Client
struct MentionedPlayer

field	type	description
player_id	string	Unique id of player, When the value of player_id is '@ALL', it means mentioning all players.
player_display_name	string	Player's display name. Populated by the game developer when sending a message.

ChatMsgContent

Instant/Party/Lobby chat message content

/// namespace: Pgos.Client
struct ChatMsgContent

field	type	description
text_content	string	Take the value from here when msg type is MsgTypeText
custom_content	string	Take the value from here when msg type is MsgTypeCustom

ChatMsgInfo

Instant/Party/Lobby chat messages

/// namespace: Pgos.Client
struct ChatMsgInfo

field	type	description
sender	PlayerInfo	The player who send the message
sent_time	Int64	The time the message was sent
msg_type	ChatMsgType	The type of the message
content	ChatMsgContent	The message to be sent
seq	Int64	The sequence number of the message
custom_data	string	Additional information added by the game

SendPersonalMsgParams

Request struct for sending personal message

/// namespace: Pgos.Client
struct SendPersonalMsgParams

field	type	description
peer_player_id	string	Peer player's ID
content	string	Content
custom_data	string	Additional information added by the game

UnreadMsgCountNotifyEvt

Event result of unread message count changed

/// namespace: Pgos.Client
struct UnreadMsgCountNotifyEvt

field	type	description
total_unread_count	Int32	Total unread count of personal chat or group chat

PersonalMsgContent

Personal chat message content

/// namespace: Pgos.Client
struct PersonalMsgContent

field	type	description
text_content	string	Take the value from here when msg type is MsgTypeText
custom_content	string	Take the value from here when msg type is MsgTypeCustom

PersonalMsgInfo

Personal chat message info

/// namespace: Pgos.Client
struct PersonalMsgInfo

field	type	description
sender	PlayerInfo	The player who sent the message
sent_time	Int64	The time the message was sent
msg_type	ChatMsgType	The type of the message
content	PersonalMsgContent	The message to be sent
seq	Int64	The sequence number of the message
custom_data	string	Additional information added by the game

ReceivePersonalMsgEvt

Event result of receive personal chat message

/// namespace: Pgos.Client
struct ReceivePersonalMsgEvt

field	type	description
msg	PersonalMsgInfo	Personal chat message received
unread_count	Int32	Count of unread message from sender

PersonalChatItem

Personal chat info

/// namespace: Pgos.Client
struct PersonalChatItem

field	type	description
peer_player_info	PlayerInfo	The peer player info
unread_count	Int32	Unread message count
msg_latest	PersonalMsgInfo	Recent chat message info

GetMyPersonalChatListResult

My personal chat list

/// namespace: Pgos.Client
struct GetMyPersonalChatListResult

field	type	description
personal_chat_list	List<PersonalChatItem>	Personal chat list

GetPersonalChatMsgListResult

Result of get personal chat message list

/// namespace: Pgos.Client
struct GetPersonalChatMsgListResult

field	type	description
msg_list	List<PersonalMsgInfo>	Chat message info list
already_read_seq	Int64	Messages with seq less than or equal to this have already been read
has_more	bool	Whether has more message
next_seq	Int64	The starting sequence for the next query

GetGmeTicketResult

/// namespace: Pgos.Client
struct GetGmeTicketResult

field	type	description
gme_ticket	string	Result of the gme ticket request, which is base64 encoded
voice_app_id	string	Indicates the gme app id registed on portal
gme_type	string	Service provider: aws, tcloud_chinese_mainland, tcloud_intl, etc.

JoinInstantChatResult

The result of players joining instant chat

/// namespace: Pgos.Client
struct JoinInstantChatResult

field	type	description
chat_channel_id	string	The chat channel

ReceiveInstantChatMsgEvt

Event result of receive instant chat message

/// namespace: Pgos.Client
struct ReceiveInstantChatMsgEvt

field	type	description
chat_channel_id	string	ID of chat channel where the message was received
chat_msg_info	ChatMsgInfo	Instant chat message received

InstantChatMemberJoinedEvt

Event result of member joined instant chat

/// namespace: Pgos.Client
struct InstantChatMemberJoinedEvt

field	type	description
chat_channel_id	string	Instant chat channel the player joined
added_members	List<PlayerInfo>	Players added to the instant chat

InstantChatMemberLeftEvt

Event result of member left instant chat

/// namespace: Pgos.Client
struct InstantChatMemberLeftEvt

field	type	description
chat_channel_id	string	Instant chat channel the player left
left_members	List<PlayerInfo>	Players left from the channel

GetInstantChatMembersResult

All the players in the channel

/// namespace: Pgos.Client
struct GetInstantChatMembersResult

field	type	description
all_members	List<PlayerInfo>	All the players in the channel

SendInstantChatMsgParams

Request struct for sending instant chat message

/// namespace: Pgos.Client
struct SendInstantChatMsgParams

field	type	description
chat_channel_id	string	The chat channel ID
content	string	The message content to be sent
custom_data	string	Additional information added by the game

GetInstantChatMemberIDsResult

All player IDs in a channel

/// namespace: Pgos.Client
struct GetInstantChatMemberIDsResult

field	type	description
all_member_ids	List<string>	All the players in the channel

GetInstantChatMemberCountResult

The num of players in a channel

/// namespace: Pgos.Client
struct GetInstantChatMemberCountResult

field	type	description
all_member_count	Int32	The num of players in a channel

LobbyPlayer

Player in lobby

/// namespace: Pgos.Client
struct LobbyPlayer

field	type	description
player_info	PlayerInfo	Base info of a player.
team_name	string	Current team of the player. Team name is pre-set in lobby configuration
team_slot	UInt32	Slot index of the player. Starting value is 1
source	LobbyJoiningSource	The source of the player join the lobby
ready	bool	Ready flag of the player

LobbyTeam

Team struct of current lobby

/// namespace: Pgos.Client
struct LobbyTeam

field	type	description
name	string	Team name is pre-set in lobby configuration
capacity	UInt32	Capacity of the team
players	Dictionary<string, LobbyPlayer>	A map from team slot(in string format) to LobbyPlayer for all players in the team.
group	string	The group to which the team belongs
start_battle_condition	LobbyStartBattleCondition	The action when the lobby owner invokes the StartBattle interface depends on the Ready flag of lobby members.

LobbyBriefInfo

Brief information of a lobby

/// namespace: Pgos.Client
struct LobbyBriefInfo

field	type	description
lobby_id	string	A unique lobby ID which was displayed on the game client.
lobby_owner	LobbyPlayer	The name of the lobby owner.
name	string	The name of the lobby.
status	LobbyStatus	The current lobby status.
privacy	LobbyPrivacy	Lobby privacy type: Dummy, Invisible, or Invisible
protection	LobbyProtection	Lobby protection type: Dummy, PasswordNeeded, PasswordUnNeeded
player_count	UInt32	The number of players in the lobby
player_limit	UInt32	Sum of capacities of all teams
kv_data	Dictionary<string, string>	Global kv data of the lobby. Only owner has the permission to modify it.
player_kv_data	Dictionary<string, string>	Player custom data of each lobby member. The map key is lobby member's player ID, the map value is the lobby member's custom data. Each lobby member could modify it's player kv data.
game_mode	string	The game mode of the lobby. Each game mode can be configured with a placer on the portal

LobbyDetailInfo

Detailed information of a lobby

/// namespace: Pgos.Client
struct LobbyDetailInfo : LobbyBriefInfo

parent: LobbyBriefInfo

field	type	description
status_reason	LobbyStatusReason	The reason that the lobby status changes.
password	string	Password needed to join the lobby
teams	List<LobbyTeam>	The team struct of current lobby.
lobby_config	string	Lobby configuration name of current lobby
chat_channel_id	string	An unique chat channel ID for the lobby's chat channel; empty if enable_chatting was set to false when the lobby was created.
battle_session_id	string	The battle session that started from the lobby
preparing_timeout	UInt32	The maximum time to wait for all request members to accept the request
placing_timeout	UInt32	The maximum time to wait for placing the battle session
battle_session_provider	string	Provider of battle session management service. PGOS for PGOS battle service, STANDALONE for self-build battle session management service.

CreateLobbyParams

The information needed to create the lobby.

/// namespace: Pgos.Client
struct CreateLobbyParams

field	type	description
lobby_config	string	Lobby configuration name of current lobby
name	string	The name of the lobby.
privacy	LobbyPrivacy	Lobby privacy type: Dummy, Invisible, or Invisible
password	string	Password needed to join the lobby
enable_chatting	bool	If true, the lobby members can use SendLobbyChatTextMsg/SendLobbyChatCustomMsg/SetOnReceiveLobbyChatMsg
kv_data	Dictionary<string, string>	Lobby global data. Each key-value pair is a string. Special note: When using this parameter to filter room instances (such as in the SearchLobby/QuickJoin interfaces), PGOS supports parsing special string values as lists to enable more complex set-based filtering operations. The string value formats that can be parsed as lists include: [a, b, c] / ["a", "b", "c"] (where the double quotes will be automatically stripped).
protection	LobbyProtection	Optional, the lobby protection policy.
game_mode	string	Optional, the game mode of the lobby. After starting the battle, the placer corresponding to the game mode on the portal will be used. If this game mode does not have a placer configured, the default placer configured on the portal will be used.

EditLobbyInfoParams

The lobby information that needs to be updated. These data will overwrite the previous data.

/// namespace: Pgos.Client
struct EditLobbyInfoParams

field	type	description
name	string	The name of the lobby.
privacy	LobbyPrivacy	Lobby privacy type: Dummy, Invisible, or Invisible
password	string	Password needed to join the lobby
kv_data	Dictionary<string, string>	Deprecated since <v0.33.2>, use SetSetLobbyGlobalData instead
protection	LobbyProtection	The lobby protection policy.
game_mode	string	the game mode of the lobby. After starting the battle, the placer corresponding to the game mode on the portal will be used. If this game mode does not have a placer configured, the default placer configured on the portal will be used.

JoinLobbyParams

The information needed when join the lobby

/// namespace: Pgos.Client
struct JoinLobbyParams

field	type	description
lobby_id	string	The lobby id to join
password	string	The lobby password. If the lobby is not encrypted, it doesn't need to be filled.
join_token	string	It is from the event of 'OnLobbyInvitation' if the player is invited to join a lobby, Otherwise it doesn't need to be filled.
payload	string	Join request payload will be passed to the lobby owner in OnLobbyJoinRequest event for a lobby with LobbyProtection::ApplicationNeeded.

JoinLobbyWithGroupsParams

The information needed when join the lobby

/// namespace: Pgos.Client
struct JoinLobbyWithGroupsParams : JoinLobbyParams

parent: JoinLobbyParams

field	type	description
selected_groups	Dictionary<string, UInt32>	Try to join the specified groups in the lobby according to the specified priority value from small to large. key: group, value: priority.(priority cannot be less than 0)

JoinLobbyWithTeamsParams

The information needed when join the lobby

/// namespace: Pgos.Client
struct JoinLobbyWithTeamsParams : JoinLobbyParams

parent: JoinLobbyParams

field	type	description
selected_teams	Dictionary<string, UInt32>	Try to join the specified teams in the lobby according to the specified priority value from small to large. key: team name, value: priority.(priority cannot be less than 0)

SearchLobbyDataFilter

Lobby data search filter

/// namespace: Pgos.Client
struct SearchLobbyDataFilter

field	type	description
equal_values	List<string>	[Only for single string value] List all values that meet the filtering data. This field does not take effect when 'treat_as_list_value' is true.
not_equal_values	List<string>	[Only for single string value] List all values that do not meet the filtering data. This field does not take effect when 'treat_as_list_value' is true.
set_is_subset_values	List<string>	[Only for list value] Target data list value is subset of giving list. This field does not take effect when 'treat_as_list_value' is false.
set_intersection_values	List<string>	[Only for list value] The intersection between the target list and the given list is not empty. This field does not take effect when 'treat_as_list_value' is false.
treat_as_list_value	bool	Whether to treat the target value in lobby_data as a list value, defaulting to false.

SearchLobbyParams

The optional filter information when searching the lobby list.

/// namespace: Pgos.Client
struct SearchLobbyParams

field	type	description
lobby_id	string	Optional, search for the specified lobby by id. It can search for the lobby of 'Invisible'
lobby_config	string	Optional, search for the lobby of the specified config, such as 'lobby 1v1'
status	LobbyStatus	Optional, search for the lobby in the specific state
protection	LobbyProtection	Optional, for example, only search for the lobby without password
offset	UInt32	The starting position of the search
count	UInt32	The search count
order_by	LobbyOrderBy	Search order
order_type	LobbyOrderType	Order direction
lobby_data	Dictionary<string, SearchLobbyDataFilter>	Filter by global kv data of the lobby. The map key is lobby data key, and the map value is lobby data filter.

SearchLobbyResult

The result of the search lobby request

/// namespace: Pgos.Client
struct SearchLobbyResult

field	type	description
lobbies	List<LobbyBriefInfo>	A list of lobbies filtered by our search. If these data are not filled (lobby_id, lobby_config, status, protection), all existing lobbies will be returned.
total_matched_lobbies_count	Int64	The total number of lobbies filtered by the search

QuickJoinLobbyParams

/// namespace: Pgos.Client
struct QuickJoinLobbyParams

field	type	description
lobby_config	string	Required, lobby configuration name.
lobby_data	Dictionary<string, SearchLobbyDataFilter>	Optional, filter by global kv data of the lobby. The map key is lobby data key, and the map value is lobby data filter.
selected_groups	Dictionary<string, UInt32>	Optional, selected_groups will be used when PGOS place the player into lobby instance. Try to join the specified groups in the lobby according to the specified priority value from small to large. key: group, value: priority.(priority cannot be less than 0)
selected_teams	Dictionary<string, UInt32>	Optional, selected_teams will be used when PGOS place the player into lobby instance. Try to join the specified teams in the lobby according to the specified priority value from small to large. key: team name, value: priority.(priority cannot be less than 0)

SendLobbyChatMsgParams

Request struct for sending lobby chat message

/// namespace: Pgos.Client
struct SendLobbyChatMsgParams

field	type	description
content	string	The message content to be sent
custom_data	string	Additional information added by the game

SetFriendRemarkParams

Request struct for set friend remark.

/// namespace: Pgos.Client
struct SetFriendRemarkParams

field	type	description
player_id	string	Player's ID
remark	string	remark to the friend

AddFriendParams

Request struct for add friend.

/// namespace: Pgos.Client
struct AddFriendParams

field	type	description
player_id	string	The player id to add
message	string	Request message

BatchAddFriendParams

Request struct for batch add friend.

/// namespace: Pgos.Client
struct BatchAddFriendParams

field	type	description
player_ids	List<string>	The player ids to add
message	string	Request message

FriendReqInfo

The friend request details.

/// namespace: Pgos.Client
struct FriendReqInfo

field	type	description
player_info	PlayerInfo	Basic player information such as display name and avatar.
message	string	The request message sent from the player who wants to add you as a friend.
created_time	Int64	The Unix timestamp(in seconds) when the request was created.

BatchAddFriendRsp

Response that add batch friends.

/// namespace: Pgos.Client
struct BatchAddFriendRsp

field	type	description
fail_players	Dictionary<string, string>	Players who totally failed, key: player_id, value: failed reason.

FriendReqListInfo

The list of friend requests.

/// namespace: Pgos.Client
struct FriendReqListInfo

field	type	description
friend_request_info_list	List<FriendReqInfo>	The list of friend requests

GetMyFriendsLimitResult

Response to get my friends limit.

/// namespace: Pgos.Client
struct GetMyFriendsLimitResult

field	type	description
friends_limit	UInt32	The maximum limit of friends you can have.

BatchAccountIDToPlayerIDResult

The result of batch account ids to player ids.

/// namespace: Pgos.Client
struct BatchAccountIDToPlayerIDResult

field	type	description
data	Dictionary<string, string>	Result of successful conversion, key: account id, value: player id.
fails	Dictionary<string, string>	Partial failure result, key: account id, value: failed reason.

BlocklistInfo

My blocklist details

/// namespace: Pgos.Client
struct BlocklistInfo

field	type	description
player_info_list	List<PlayerInfo>	Players in my blocklist

SyncAccountPlatformBlocklistResult

All blocklist's player IDs

/// namespace: Pgos.Client
struct SyncAccountPlatformBlocklistResult

field	type	description
all_blocklist	List<string>	All players in blocklist

PlayerPresence

The player's current status information which is set by game, such as in party , in lobby, in battle.

/// namespace: Pgos.Client
struct PlayerPresence

field	type	description
status	OnlineStatus	Online status is provided by PGOS Server. It has two values: online and offline.
presence	string	The player's current status information which is set by game, such as in party , in lobby, in battle.

BatchGetPlayerPresenceRsp

Response of querying multiple players' presence

/// namespace: Pgos.Client
struct BatchGetPlayerPresenceRsp

field	type	description
player_presences	Dictionary<string, PlayerPresence>	Presences of the players, key: player_id, value: the player's presence.
fail_players	Dictionary<string, string>	Players who totally failed, key: player_id, value: failed reason.

PlayerFriendInfo

Details of a player's friend

/// namespace: Pgos.Client
struct PlayerFriendInfo

field	type	description
player_info	PlayerInfo	Basic player information such as display name and avatar.
player_presence	PlayerPresence	The player's current status information which is set by game, such as in party , in lobby, in battle.
remark	string	remark to the player, for example, "Tommy, a humorous man, met in the battle."

PlayerSearchInfo

Details of player search

/// namespace: Pgos.Client
struct PlayerSearchInfo

field	type	description
player_info	PlayerInfo	Basic player information such as display name and avatar.
player_presence	PlayerPresence	The player's current status information which is set by game, such as in party , in lobby, in battle.
remark	string	The remark of the player
is_friend	bool	Whether the searched player is a friend
is_blocked	bool	Whether the searched player is placed in the blocked list

FriendListInfo

Friend list details

/// namespace: Pgos.Client
struct FriendListInfo

field	type	description
friend_info_list	List<PlayerFriendInfo>	Friend list details

PlayerSearchInfoList

A list of player search details

/// namespace: Pgos.Client
struct PlayerSearchInfoList

field	type	description
info_list	List<PlayerSearchInfo>	A list of player search details

PlatformPlayerInfo

Players of external platform such as Steam

/// namespace: Pgos.Client
struct PlatformPlayerInfo

field	type	description
account_open_id	string	Account openIDs of external platform such as Steam.
player_info	PlayerInfo	Basic player information such as display name and avatar.
player_presence	PlayerPresence	The player's current status information which is set by game, such as in party , in lobby, in battle.
remark	string	The remark of the player
is_friend	bool	Whether the searched player is a friend
is_blocked	bool	Whether the searched player is placed in the blocked list

PlatformPlayerInfoMap

A map of players of external platform such as Steam.

/// namespace: Pgos.Client
struct PlatformPlayerInfoMap

field	type	description
transform_item_map	Dictionary<string, PlatformPlayerInfo>	A map of players of external platform such as Steam. Key: player's open_id, Value: PlatformPlayerInfo

AcceptFriendRequestResult

Result of accept friend request.

/// namespace: Pgos.Client
struct AcceptFriendRequestResult

field	type	description
friend_info	PlayerFriendInfo	New friend information obtained after accepting.

SearchPlayerFilter

Filter param for search player.

/// namespace: Pgos.Client
struct SearchPlayerFilter

field	type	description
os	List<ClientOS>	OS filter. Currently supports passing in at most one OS. Empty means no filtering based on OS.

SearchPlayersParams

Request struct for search players

/// namespace: Pgos.Client
struct SearchPlayersParams

field	type	description
search_key	string	Key words to for searching, now only supports searching based on player id and player name. Search results are paged back.
offset	UInt32	Index of the first data in all search results.
count	UInt32	Maximum count of results returned in one page, the maximum value of 'count' is 50

SearchPlayersWithFilterParams

Request struct for search players with filter

/// namespace: Pgos.Client
struct SearchPlayersWithFilterParams

field	type	description
search_key	string	Key words to for searching, now only supports searching based on player id and player name. Search results are paged back.
search_filter	SearchPlayerFilter	Filter by OS etc..
offset	UInt32	Index of the first data in all search results.
count	UInt32	Maximum count of results returned in one page, the maximum value of 'count' is 50

UniqueItemDeduction

Price deduction for unique items in the store item configured on the portal.

/// namespace: Pgos.Client
struct UniqueItemDeduction

field	type	description
item_id	string	The id of the unique item.
deduction_price	UInt32	The deduction price of the unique item configured on the portal.
is_deducted	bool	True means that the player owns the unique item and a deduction occurred when purchasing the store item.

CompensationCurrency

Currency compensation.

/// namespace: Pgos.Client
struct CompensationCurrency

field	type	description
currency_code	string	The code of the currency.
amount	UInt32	The amount of the currency.

UniqueItemCompensation

Compensation for unique items in the store item configured on the portal. This used when pay_platform is MidasGlobal

/// namespace: Pgos.Client
struct UniqueItemCompensation

field	type	description
currencies	List<CompensationCurrency>	Currency compensations.

StoreItemPrice

The price of a store item.

/// namespace: Pgos.Client
struct StoreItemPrice

field	type	description
currency_code	string	The code of the currency.
currency_name	string	The name of the currency.
currency_icon	string	The uri of the currency.
price	UInt32	The actual price used to purchase the store item with the currency. selling_price deducts the deduction_price where is_deducted is true in unique_item_deductions.
selling_price	UInt32	Selling price in the store, defined in the store item of the portal. When creating a store item on the portal, you can directly use the price defined in the in-game item (default_price), at this time selling_price is equal to default_price, or you can use custom selling price.
original_price	UInt32	Deprecated since <v0.25.0>. Use selling_price instead.
default_price	UInt32	The price of in-game item. defined in the in-game item of the portal.
unique_item_deductions	Dictionary<string, UniqueItemDeduction>	Price deduction for unique items in the store item configured on the portal. Key: unique item id.

ItemPrice

The currency code and price used to purchase the item

/// namespace: Pgos.Client
struct ItemPrice

field	type	description
currency_code	string	The code of the currency.
price	UInt32	The actual price used to purchase the store item with the currency.

GetBalancesResult

/// namespace: Pgos.Client
struct GetBalancesResult

field	type	description
balances	List<Balance>	The balances that the player owns.

StoreItemPurchaseLimit

Purchase amount limit of store item.

/// namespace: Pgos.Client
struct StoreItemPurchaseLimit

field	type	description
max_purchase_amount	UInt32	The maximum amount limit that players can purchase for this store item. 0 means no limit.
purchased_amount	UInt32	When max_purchase_amount is greater than 0, record the amount that the player has purchased. Please note that when the category period is switched, its value will be recalculated.

StoreItem

/// namespace: Pgos.Client
struct StoreItem

field	type	description
pay_platform	string	Pay platform name, such as: 'Pgos', 'MidasGlobal', etc. You can use macros starting with 'PAY_PLATFORM' in pgos_common_define.h @ Pgos, make a virtual currency payment to PGOS to purchase this item. @ MidasGlobal, make a cash payment through Midas to purchase this item.
store_item_id	string	The id of the store item.
status	StoreItemStatus	Store item status: Dummy / Available / Owned / ExceedLimit.
prices	List<StoreItemPrice>	The currency to purchase the store item, it may be multiple.
item	InGameItem	The in-game item related to the store item.
tags	Dictionary<string, string>	The tags of store item Fill in the tags of item on the portal.
purchase_limit	StoreItemPurchaseLimit	Purchase amount limit of store item.
compensations	Dictionary<string, UniqueItemCompensation>	The compensation for unique items in the store item configured on the portal when pay_platform is MidasGlobal. Key: unique item id.

StoreCategoryBrief

The brief information of the store category.

/// namespace: Pgos.Client
struct StoreCategoryBrief

field	type	description
category_id	string	The id of the category.
name	string	The name of the category.
description	string	The description of the category.
tags	Dictionary<string, string>	The custom tags of the category.
type	StoreCategoryType	The type of the category.
published_start_time	Int64	The Unix timestamp (in seconds) for the start time of the currently active period. It is always 0 under the simple type.
published_end_time	Int64	The Unix timestamp (in seconds) for the end time of the currently active period. It is always 0 under the simple type.

StoreCategory

The information of the store category.

/// namespace: Pgos.Client
struct StoreCategory : StoreCategoryBrief

parent: StoreCategoryBrief

field	type	description
content_items	List<StoreItem>	Store items in the category.

Store

/// namespace: Pgos.Client
struct Store

field	type	description
store_id	string	The id of the store.
display_name	string	The name of the store.
description	string	The description of the store.
tags	Dictionary<string, string>	The custom tags of the store.
categories	List<StoreCategory>	The category list of the the store, each category has a store item list.
item_dict	ItemDict	In-game item defines that may be referenced in the 'item_content', and you can use 'ItemDict::FindItem' to search.
platform_item_mapping	Dictionary<string, string>	The mapping relationship between PGOS in-game items and 3rd-party platform items configured on the PGOS portal. key: PGOS in-game item id, value: 3rd-party platform item id.

StoreBrief

The brief information of the store.

/// namespace: Pgos.Client
struct StoreBrief

field	type	description
store_id	string	The id of the store.
display_name	string	The name of the store.
description	string	The description of the store.
tags	Dictionary<string, string>	The custom tags of the store.
category_briefs	List<StoreCategoryBrief>	The category brief list of the the store.

GetStoreBriefsParams

/// namespace: Pgos.Client
struct GetStoreBriefsParams

field	type	description
store_ids	List<string>	List of store IDs to be queried.

GetStoreBriefsResult

/// namespace: Pgos.Client
struct GetStoreBriefsResult

field	type	description
store_briefs	Dictionary<string, StoreBrief>	List of store brief information queried.

GetStoreParams

/// namespace: Pgos.Client
struct GetStoreParams

field	type	description
store_id	string	The specified store id.
pay_platform	string	[Optional] Pay platform name, such as: 'Steam', 'Xbox', etc. You can use macros starting with 'PAY_PLATFORM' in pgos_common_define.h After specifying the pay platform, the result will bring the platform_item_mapping of the corresponding platform configured on the portal.

GetStoreWithPlatformParams

/// namespace: Pgos.Client
struct GetStoreWithPlatformParams : GetStoreParams

parent: GetStoreParams

GetStoreCategoriesParams

/// namespace: Pgos.Client
struct GetStoreCategoriesParams

field	type	description
store_id	string	The specified store id.
category_ids	List<string>	List of category IDs to be queried.
pay_platform	string	[Optional] Pay platform name, such as: 'Steam', 'Xbox', etc. You can use macros starting with 'PAY_PLATFORM' in pgos_common_define.h After specifying the pay platform, the result will bring the platform_item_mapping of the corresponding platform configured on the portal.

GetStoreCategoriesResult

/// namespace: Pgos.Client
struct GetStoreCategoriesResult

field	type	description
categories	List<StoreCategory>	The specified categories that have been queried.
fails	Dictionary<string, string>	Categories that failed to query, key: player id, value: failed reason.
item_dict	ItemDict	In-game item defines that may be referenced in the 'item_content', and you can use 'ItemDict::FindItem' to search.
store_id	string	The id of the store.
display_name	string	The name of the store.
description	string	The description of the store.
tags	Dictionary<string, string>	The custom tags of the store.
platform_item_mapping	Dictionary<string, string>	The mapping relationship between PGOS in-game items and 3rd-party platform items configured on the PGOS portal. key: PGOS in-game item id, value: 3rd-party platform item id.

InstanceOperationResult

/// namespace: Pgos.Client
struct InstanceOperationResult

field	type	description
instance_id	string	The instance id of this operation.
left_amount	UInt32	The number of instance remaining after this operation.

ConsumeInstanceParams

Request struct for consume instance.

/// namespace: Pgos.Client
struct ConsumeInstanceParams : BaseBackendEventParams

parent: BaseBackendEventParams

field	type	description
instance_id	string	The item instance id.
idempotency_token	string	[Optional] Used to ensure the idempotence of the function. Idempotence means that regardless of how many times the function is called, the result remains the same. By passing a unique idempotency_token, it ensures that the function does not produce duplicate side effects or results when called repeatedly. Note: To avoid generating the same idempotency_token as other players, it is recommended to concatenate it with the player's own player ID.

ConsumeInstanceResult

/// namespace: Pgos.Client
struct ConsumeInstanceResult : InstanceOperationResult

parent: InstanceOperationResult

field	type	description
custom_err_code	Int32	The error code returned by the virtual server bound to the consumer action.
custom_err_msg	string	The error msg returned by the virtual server bound to the consumer action.
func_result	string	The json string returned by the virtual server bound to the consumer action.
replayed	bool	Whether the request is replayed. When it is True, it indicates that the result of the function is obtained by replaying with the same idempotency_token. This means that the result of the function has been generated in a previous call and is being reused in the current call.

OpenContainerInstanceParams

Request struct for open container instance.

/// namespace: Pgos.Client
struct OpenContainerInstanceParams : BaseBackendEventParams

parent: BaseBackendEventParams

field	type	description
instance_id	string	The container instance id.

OpenContainerResult

/// namespace: Pgos.Client
struct OpenContainerResult : InstanceOperationResult

parent: InstanceOperationResult

field	type	description
item_insts	ItemInstPack	The item instances obtained after opening the container.
currencies	List<Currency>	The currencies obtained after opening the container.
conflict_unique_items	List<ConflictUniqueItem>	Unique items that already in inventory cause failed to be synchronized.

RevokeInstanceParams

Request struct for revoke instance.

/// namespace: Pgos.Client
struct RevokeInstanceParams : BaseBackendEventParams

parent: BaseBackendEventParams

field	type	description
instance_id	string	The item instance id.

SetInstanceTagsParams

/// namespace: Pgos.Client
struct SetInstanceTagsParams

field	type	description
instance_id	string	The item instance id.
update_data	Dictionary<string, string>	Update the data of the specified keys in the tags. If the key does not exist, it indicates inserting new data.
delete_keys	List<string>	Delete the data of specified keys in the tags. The key from update_data cannot be included.

SetInstanceTagsResult

/// namespace: Pgos.Client
struct SetInstanceTagsResult

field	type	description
tags	Dictionary<string, string>	Latest tags of item instance.

CreateStoreOrderParams

Request struct for create order.

/// namespace: Pgos.Client
struct CreateStoreOrderParams : BaseBackendEventParams

parent: BaseBackendEventParams

field	type	description
store_id	string	The store id of this store item.
store_item_id	string	The store item id.
amount	UInt32	The amount of store item will be purchased.
price	ItemPrice	The currency code and actual price to purchase the item, it must be one of the prices of this store item.

CreateStoreOrderResult

/// namespace: Pgos.Client
struct CreateStoreOrderResult

field	type	description
order_id	string	Order ID required for purchase.

CommitStoreOrderParams

Request struct for commit order.

/// namespace: Pgos.Client
struct CommitStoreOrderParams

field	type	description
order_id	string	The previously created order ID.

CommitStoreOrderResult

/// namespace: Pgos.Client
struct CommitStoreOrderResult

field	type	description
spent_currency_code	string	The code of currency that has been spent to purchase the store item.
spent_currency_amount	UInt32	The amount of currency that has been spent to purchase the store item.
item_insts	ItemInstPack	The item instances obtained after purchase.
currencies	List<Currency>	The currencies obtained after purchase.
status	StoreOrderStatus	Order status.
failed_currencies	Dictionary<string, string>	Currencies that failed to grant. Mapping from currency code to failure reason.

QueryStoreOrderParams

/// namespace: Pgos.Client
struct QueryStoreOrderParams

field	type	description
order_id	string	The previously created order ID.

QueryStoreOrderResult

/// namespace: Pgos.Client
struct QueryStoreOrderResult : CommitStoreOrderResult

parent: CommitStoreOrderResult

CheckBeforePlatformPurchaseParams

/// namespace: Pgos.Client
struct CheckBeforePlatformPurchaseParams

field	type	description
item_id	string	The PGOS in-game item id corresponding to the item id of the 3rd-party platform to be purchased.
amount	UInt32	The amount of item will be purchased.
pay_platform	string	Pay platform name, such as: 'Steam', 'EpicGames', etc. You can use macros starting with 'PAY_PLATFORM' in pgos_common_define.h

SyncPlayerPlatformInventoryParams

Request struct for sync player inventory from 3rd-party platform.

/// namespace: Pgos.Client
struct SyncPlayerPlatformInventoryParams : BaseBackendEventParams

parent: BaseBackendEventParams

field	type	description
pay_platform	string	Pay platform name, such as: 'Steam', 'EpicGames', etc. You can use macros starting with 'PAY_PLATFORM' in pgos_common_define.h

SyncPlayerPlatformInventoryResult

/// namespace: Pgos.Client
struct SyncPlayerPlatformInventoryResult

field	type	description
item_insts	ItemInstPack	The item instances obtained after synchronized.
currencies	List<Currency>	The currencies obtained after synchronized.
conflict_unique_items	List<ConflictUniqueItem>	Unique items that already in inventory cause failed to be synchronized.

SyncSteamPlayerInventoryParams

Request struct for sync player inventory from Steam platform.

/// namespace: Pgos.Client
struct SyncSteamPlayerInventoryParams : BaseBackendEventParams

parent: BaseBackendEventParams

SyncSteamPurchaseParams

Request struct for sync item instance from Steam.

/// namespace: Pgos.Client
struct SyncSteamPurchaseParams : BaseBackendEventParams

parent: BaseBackendEventParams

field	type	description
steam_item_inst_id	UInt64	Steam item instance id.

SyncSteamPurchaseResult

/// namespace: Pgos.Client
struct SyncSteamPurchaseResult : SyncPlayerPlatformInventoryResult

parent: SyncPlayerPlatformInventoryResult

SyncXboxPlayerInventoryParams

Request struct for sync player inventory from Xbox platform.

/// namespace: Pgos.Client
struct SyncXboxPlayerInventoryParams : BaseBackendEventParams

parent: BaseBackendEventParams

field	type	description
xbox_xsts_token	string	Xbox XSTS token.

SyncXboxPurchaseParams

Request struct for sync item instance from Xbox.

/// namespace: Pgos.Client
struct SyncXboxPurchaseParams : BaseBackendEventParams

parent: BaseBackendEventParams

field	type	description
xbox_product_id	string	Xbox product id. Also referred to as the Store ID for the product within the Microsoft Store catalog.
xbox_xsts_token	string	Xbox XSTS token.

SyncXboxPurchaseResult

/// namespace: Pgos.Client
struct SyncXboxPurchaseResult : SyncPlayerPlatformInventoryResult

parent: SyncPlayerPlatformInventoryResult

InventoryGrantedEvt

/// namespace: Pgos.Client
struct InventoryGrantedEvt

field	type	description
item_insts	ItemInstPack	The item instances granted.
src_type	string	Source type of granted. For example, "Store", "Midas", "Portal", "Client", "DS", "VS", "System", "Mail" etc.

CurrencyChange

/// namespace: Pgos.Client
struct CurrencyChange

field	type	description
currency_code	string	The code of currency that has been changed.
before_value	Int64	The amount of changed currency before this change.
after_value	Int64	The amount of changed currency after this change.

BalanceUpdatedEvt

/// namespace: Pgos.Client
struct BalanceUpdatedEvt

field	type	description
currencies	List<CurrencyChange>	The details of changed currencies.
reason	string	The reason caused the currencies changes. Usually will be 'Deduct' or 'Grant'

VirtualServerEvt

/// namespace: Pgos.Client
struct VirtualServerEvt

field	type	description
json_str	string	The message is in json format.

AddFriendRequestEvt

/// namespace: Pgos.Client
struct AddFriendRequestEvt

field	type	description
req_info	FriendReqInfo	The request details.

AddFriendResponseEvt

/// namespace: Pgos.Client
struct AddFriendResponseEvt

field	type	description
friend_info	PlayerFriendInfo	The friend details.

FriendRemovedEvt

/// namespace: Pgos.Client
struct FriendRemovedEvt

field	type	description
player_info	PlayerInfo	The player details.

BadgeNumOfFriendReqEvt

/// namespace: Pgos.Client
struct BadgeNumOfFriendReqEvt

field	type	description
badge_num	UInt32	The badge number of outstanding friend requests.

FriendPresenceChangedEvt

/// namespace: Pgos.Client
struct FriendPresenceChangedEvt

field	type	description
player_id	string	The friend whose presence changed.
player_presence	PlayerPresence	Friend's new presence.

LobbyMemberJoinedEvt

/// namespace: Pgos.Client
struct LobbyMemberJoinedEvt

field	type	description
joined_player	LobbyPlayer	The player who newly joined the lobby.
lobby_id	string	Lobby id.

LobbyMemberLeftEvt

/// namespace: Pgos.Client
struct LobbyMemberLeftEvt

field	type	description
left_player	LobbyPlayer	The player who left the lobby.
is_kick_out	bool	Was the player kicked out by lobby owner.
lobby_id	string	Lobby id.

LobbyTeamUpdatedEvt

/// namespace: Pgos.Client
struct LobbyTeamUpdatedEvt

field	type	description
lobby_players	List<LobbyPlayer>	The players who update ready flag or change team slot.
lobby_id	string	Lobby id.

LobbyInvitationEvt

/// namespace: Pgos.Client
struct LobbyInvitationEvt

field	type	description
lobby_detail	LobbyDetailInfo	The updated lobby details.
inviter	LobbyPlayer	The player who sent the invitation.
join_token	string	If the invited player wants to join the lobby, this value of 'join_token' needs to be filled to the 'join_token' of 'JoinLobby'.

LobbyOwnerTransferredEvt

/// namespace: Pgos.Client
struct LobbyOwnerTransferredEvt

field	type	description
new_owner	LobbyPlayer	The new lobby owner.
lobby_id	string	Lobby id.

LobbyInfoUpdatedEvt

/// namespace: Pgos.Client
struct LobbyInfoUpdatedEvt

field	type	description
lobby_detail	LobbyDetailInfo	The updated lobby details.

LobbyDataUpdatedEvt

/// namespace: Pgos.Client
struct LobbyDataUpdatedEvt

field	type	description
lobby_detail	LobbyDetailInfo	The updated lobby details.

LobbyStatusChangedEvt

/// namespace: Pgos.Client
struct LobbyStatusChangedEvt

field	type	description
status	LobbyStatus	The current lobby status.
battle_session_id	string	The battle session that started from the lobby
battle_session_provider	string	Provider of battle session management service. PGOS for PGOS battle service, STANDALONE for self-build battle session management service.
lobby_id	string	Lobby id.

BattleSessionUpdatedEvt

/// namespace: Pgos.Client
struct BattleSessionUpdatedEvt

field	type	description
battle_session	BattleSessionInfo	The updated battle session details.

ReceiveLobbyChatMsgEvt

/// namespace: Pgos.Client
struct ReceiveLobbyChatMsgEvt

field	type	description
chat_msg_info	ChatMsgInfo	Lobby chat messages received.

LobbySwitchTeamSlotRequestEvt

/// namespace: Pgos.Client
struct LobbySwitchTeamSlotRequestEvt

field	type	description
from_player_info	LobbyPlayer	Lobby player who send the switch request.
request_id	string	Team slot switch request id.
lobby_id	string	Lobby id.

LobbySwitchTeamSlotRequestConfirmedEvt

/// namespace: Pgos.Client
struct LobbySwitchTeamSlotRequestConfirmedEvt

field	type	description
from_player_info	LobbyPlayer	Lobby player who confirm the switch request.
request_id	string	Team slot switch request id.
lobby_id	string	Lobby id.

LobbySwitchTeamSlotRequestRejectedEvt

/// namespace: Pgos.Client
struct LobbySwitchTeamSlotRequestRejectedEvt

field	type	description
from_player_info	LobbyPlayer	Lobby player who reject the switch request.
request_id	string	Team slot switch request id.
lobby_id	string	Lobby id.

PartyStrategyChangedEvt

/// namespace: Pgos.Client
struct PartyStrategyChangedEvt

field	type	description
party_id	string	The party id.
join_strategy	PartyJoinStrategy	The strategy controls the rules who could join the party.
invite_strategy	PartyInviteStrategy	The strategy controls the rules who could invite others to the party.

PartyMemberJoinedEvt

/// namespace: Pgos.Client
struct PartyMemberJoinedEvt

field	type	description
party_id	string	The party id.
joined_member	PlayerInfo	The player who newly joined the party.

PartyMemberLeftEvt

/// namespace: Pgos.Client
struct PartyMemberLeftEvt

field	type	description
party_id	string	The party id.
left_player	PlayerInfo	The player who left the party.
kicked	bool	Was the player kicked out by party leader.

PartyDismissedEvt

/// namespace: Pgos.Client
struct PartyDismissedEvt

field	type	description
party_id	string	The party id that was dismissed.

PartyLeaderTransferredEvt

/// namespace: Pgos.Client
struct PartyLeaderTransferredEvt

field	type	description
party_id	string	The party id.
new_leader	PlayerInfo	The player who transferred to new leader.

ReceivePartyInvitationEvt

/// namespace: Pgos.Client
struct ReceivePartyInvitationEvt

field	type	description
party_id	string	The party id.
inviter	PlayerInfo	The player who sent the invitation.

ReceivePartyChatMsgEvt

/// namespace: Pgos.Client
struct ReceivePartyChatMsgEvt

field	type	description
chat_msg_info	ChatMsgInfo	Party chat messages received.

PartyCustomDataChangedEvt

/// namespace: Pgos.Client
struct PartyCustomDataChangedEvt

field	type	description
party_id	string	The party id.
custom_data	PartyCustomData	Party custom data.

PartyInfoUpdatedEvt

/// namespace: Pgos.Client
struct PartyInfoUpdatedEvt

field	type	description
party_info	PartyInfo	The party info.

MatchmakingProcessChangedEvt

/// namespace: Pgos.Client
struct MatchmakingProcessChangedEvt

field	type	description
process	MatchmakingProcessInfo	The updated matchmaking progress information.

PlayerSessionChangedEvt

/// namespace: Pgos.Client
struct PlayerSessionChangedEvt

field	type	description
evt	PlayerSessionEvt	The triggered event id, view event enum for detail.
session_id	string	The id of the current player session
msg	string	Message for the triggered event.

GroupInfo

Group info could be access by players both in or not in the group.

/// namespace: Pgos.Client
struct GroupInfo

field	type	description
group_id	string	The group id.
name	string	The group name.
icon	string	Uri of the group.
description	string	The description of the group.
tags	List<string>	Custom tags of the group.
owner_info	PlayerInfo	The player info of group owner.
member_count	Int32	Current member count of the group.
max_members	Int32	Max member count of the group.
is_official	bool	Is it a official group.
created_time	Int64	The Unix timestamp(in seconds) when the group was created.
join_rule	GroupJoinRule	The rules for players to join the group.
global_custom_data	Dictionary<string, string>	Group global custom data. Can be modified by the group owner or administrators.

GroupDetail

Group detail could be access only by players in the group.

/// namespace: Pgos.Client
struct GroupDetail : GroupInfo

parent: GroupInfo

field	type	description
announcement	string	Announcement of the group.
is_public	bool	Could or couldn't be seen by player not in the group.

GroupMember

/// namespace: Pgos.Client
struct GroupMember

field	type	description
player_info	PlayerInfo	Base info of the player.
nickname	string	Nick name of a group member.
remark	string	Remark of a group member. Remark can only be modified by group owner and group admin.
player_presence	PlayerPresence	Player presence info.
is_owner	bool	True if the member is group owner.
is_admin	bool	True if the member is group admin.
joined_time	Int64	The Unix timestamp(in seconds) when the member joined.
custom_data	string	The custom data for group member. Could be Can be modified by the player or administrator.

MutedGroupMember

/// namespace: Pgos.Client
struct MutedGroupMember

field	type	description
player_id	string	Player's ID.
display_name	string	Player's display name.
group_nickname	string	Nickname in the group.
remark	string	Remark of a group member. Remark can only be modified by group owner and group admin.
operator_id	string	Id of the operator.
operator_display_name	string	Display name of the operator.
mute_created_time	Int64	The Unix timestamp(in seconds) when the mute is created.
mute_expired_time	Int64	The Unix timestamp(in seconds) when the mute is expired, 0 means mute forever.
joined_time	Int64	The Unix timestamp(in seconds) when the member joined.

GroupMemberBrief

/// namespace: Pgos.Client
struct GroupMemberBrief

field	type	description
player_id	string	Player's ID.
display_name	string	Player's display name.
group_nickname	string	Nickname of a group member.

GroupInvitation

/// namespace: Pgos.Client
struct GroupInvitation

field	type	description
inviter_info	PlayerInfo	Base info of the player.
id	string	Invitation id.
msg	string	Invitation message. Set by the inviter.
group_info	GroupInfo	Base info of the group.
created_time	Int64	The Unix timestamp(in seconds) when the invitation was created.
expired_time	Int64	The Unix timestamp(in seconds) when the invitation's expired.

GroupInvitationEvt

/// namespace: Pgos.Client
struct GroupInvitationEvt

field	type	description
invitation	GroupInvitation	The group invitation info.

RemovedFromGroupEvt

/// namespace: Pgos.Client
struct RemovedFromGroupEvt

field	type	description
group_id	string	The group from which the player was removed.

MutedInGroupEvt

/// namespace: Pgos.Client
struct MutedInGroupEvt

field	type	description
group_id	string	The group in which the player is muted.
operator_id	string	Id of the operator.
operator_display_name	string	Display name of the operator.
mute_created_time	Int64	The Unix timestamp(in seconds) when the mute is created.
mute_expired_time	Int64	The Unix timestamp(in seconds) when the mute is expired, 0 means mute forever.

UnmutedInGroupEvt

/// namespace: Pgos.Client
struct UnmutedInGroupEvt

field	type	description
group_id	string	The group in which the player is unmuted.
operator_id	string	Id of the operator.
operator_display_name	string	Display name of the operator.

GroupDismissedEvt

/// namespace: Pgos.Client
struct GroupDismissedEvt

field	type	description
group_id	string	The group id.
dismiss_reason	string	Reason for group dismissed.

BadgeNumOfGroupInvitationEvt

/// namespace: Pgos.Client
struct BadgeNumOfGroupInvitationEvt

field	type	description
badge_num	UInt32	The badge number of group invitation.

GroupDetailChangedEvt

/// namespace: Pgos.Client
struct GroupDetailChangedEvt

field	type	description
group_detail	GroupDetail	Group detail information.

GroupGlobalCustomDataChangedEvt

/// namespace: Pgos.Client
struct GroupGlobalCustomDataChangedEvt

field	type	description
group_id	string	Group id.
global_custom_data	Dictionary<string, string>	Updated group global custom data.

GroupPlayerCustomDataChangedEvt

/// namespace: Pgos.Client
struct GroupPlayerCustomDataChangedEvt

field	type	description
group_id	string	Group id.
player_custom_data	Dictionary<string, string>	Updated custom data for each player.

CreateGroupParams

/// namespace: Pgos.Client
struct CreateGroupParams

field	type	description
name	string	The group name.
icon	string	Uri of the group.
description	string	The description of the group.
tags	List<string>	Custom tags of the group.
join_rule	GroupJoinRule	The rules for players to join the group.
is_public	bool	Could or couldn't be seen by player not in the group.

SetGroupNameParams

/// namespace: Pgos.Client
struct SetGroupNameParams

field	type	description
group_id	string	Group ID.
group_name	string	Group name.

SetGroupDescParams

/// namespace: Pgos.Client
struct SetGroupDescParams

field	type	description
group_id	string
group_description	string

SetGroupAnnouncementParams

/// namespace: Pgos.Client
struct SetGroupAnnouncementParams

field	type	description
group_id	string
group_announcement	string

SetGroupTagsParams

/// namespace: Pgos.Client
struct SetGroupTagsParams

field	type	description
group_id	string
tags	List<string>

SetMyGroupNicknameParams

/// namespace: Pgos.Client
struct SetMyGroupNicknameParams

field	type	description
group_id	string
nickname	string

SetGroupMemberRemarkParams

/// namespace: Pgos.Client
struct SetGroupMemberRemarkParams

field	type	description
group_id	string
player_id	string
remark	string

BatchSetGroupMemberRemarkParams

/// namespace: Pgos.Client
struct BatchSetGroupMemberRemarkParams

field	type	description
group_id	string
player_ids	List<string>
remark	string

InvitePlayersToGroupParams

/// namespace: Pgos.Client
struct InvitePlayersToGroupParams

field	type	description
group_id	string
invite_msg	string
player_ids	List<string>

CreateGroupRsp

/// namespace: Pgos.Client
struct CreateGroupRsp

field	type	description
group_detail	GroupDetail
is_profane	bool	Whether the updated data contains profanity words.

SearchGroupParams

/// namespace: Pgos.Client
struct SearchGroupParams

field	type	description
official_filter	GroupOfficialFilterType	The search count
left_room_filter	GroupRoomFilterType	The search count
tags_filter	List<string>	The search count
order_by	GroupOrderBy	The search count
order_type	GroupOrderType	The search count
offset	UInt32	The starting position of the search
count	UInt32	The search count

SearchGroupRsp

/// namespace: Pgos.Client
struct SearchGroupRsp

field	type	description
group_list	List<GroupInfo>	List of groups.
total_num	UInt32	The total number of groups that meet the filters.
next_offset	UInt32	The next starting position of the list.

GetGroupDiscoveryListParams

/// namespace: Pgos.Client
struct GetGroupDiscoveryListParams

field	type	description
owner_os	List<ClientOS>	Only obtain groups where the group owner's OS is the specified OS. Currently supports passing in at most one OS. Empty means no filtering based on OS.
recommend_count	UInt32	Get the number of recommended groups additionally, cannot exceed 50. Recommended groups can be configured on the portal.
offset	UInt32	The starting position of the list.
count	UInt32	The query count, cannot exceed 50.

GetGroupDiscoveryListResult

/// namespace: Pgos.Client
struct GetGroupDiscoveryListResult

field	type	description
recommend_group_list	List<GroupInfo>	Additional recommended groups.
group_list	List<GroupInfo>	List of groups.
next_offset	UInt32	The next starting position of the list.
total_num	UInt32	The total number of group discoveries.

InvitePlayersToGroupRsp

Response that invite players to a group.

/// namespace: Pgos.Client
struct InvitePlayersToGroupRsp

field	type	description
group_id	string	Players that failed to invite, key: player id, value: failed reason.
invitation_map	Dictionary<string, string>	Players that success to invite, key: player id, value: invitation_id.
fails	Dictionary<string, string>	Players that failed to invite, key: player id, value: failed reason.

BatchGetGroupInfoRsp

/// namespace: Pgos.Client
struct BatchGetGroupInfoRsp

field	type	description
group_info_list	List<GroupInfo>	The group info list.
fails	Dictionary<string, string>	Groups that failed to query, key: group id, value: failed reason.

BatchGetGroupDetailRsp

/// namespace: Pgos.Client
struct BatchGetGroupDetailRsp

field	type	description
group_detail_list	List<GroupDetail>	The group detail data list.
fails	Dictionary<string, string>	Groups that failed to query, key: group id, value: failed reason.

GetGroupMembersRsp

/// namespace: Pgos.Client
struct GetGroupMembersRsp

field	type	description
group_members	Dictionary<string, GroupMember>	Group members, key: player id, value: group member information.
muted_members	Dictionary<string, MutedGroupMember>	Muted group members, key: player id, value: muted member information.

GetGroupMemberRsp

/// namespace: Pgos.Client
struct GetGroupMemberRsp

field	type	description
is_member	bool	Whether the player is a member of a group.
member_info	GroupMember	Group member information.

AcceptGroupInvitationRsp

/// namespace: Pgos.Client
struct AcceptGroupInvitationRsp

field	type	description
group_detail	GroupDetail	The group detail data.
badge_num	UInt32	The badge number of outstanding group invitations.

RejectGroupInvitationRsp

/// namespace: Pgos.Client
struct RejectGroupInvitationRsp

field	type	description
badge_num	UInt32	The badge number of outstanding group invitations.

UpdateGroupRsp

/// namespace: Pgos.Client
struct UpdateGroupRsp

field	type	description
group_detail	GroupDetail	The updated group detail.
is_profane	bool	Whether the updated data contains profanity words.

PrivacySettingInfo

The privacy settings of player, the initial default values of the setting items can be set on the PGOS portal.

/// namespace: Pgos.Client
struct PrivacySettingInfo

field	type	description
allow_searched_by_others	bool	Whether allow being searched by other players, true: allowed, false: not allowed.
allow_friend_request	bool	Whether allow receiving other players' add-friend requests, true: allow, false: not allow.
allow_nonfriend_perschat	bool	Whether allow non-friend players to have a personal chat with you, true: allow, false: not allow.
allow_group_invitation	bool	Whether allow other players to invite you to join a group, true: allow, false: not allow.
chat_strategy	PrivacyChatStrategy	Text and voice chat privacy settings.

TssAccountInfo

Account information for user input check. For the meaning of each field, see the TSS documentation.

/// namespace: Pgos.Client
struct TssAccountInfo

field	type	description
account	string	See the TSS documentation for the meaning of the field.
account_type	Int32	See the TSS documentation for the meaning of the field.
area_id	Int32	See the TSS documentation for the meaning of the field.
plat_id	Int32	See the TSS documentation for the meaning of the field.
world_id	Int32	See the TSS documentation for the meaning of the field.
role_id	string	See the TSS documentation for the meaning of the field.
role_name	string	See the TSS documentation for the meaning of the field.
role_pic_url	string	See the TSS documentation for the meaning of the field.
role_level	Int32	See the TSS documentation for the meaning of the field.
user_sign	string	See the TSS documentation for the meaning of the field.
user_desc	string	See the TSS documentation for the meaning of the field.

TssHandledIn

Contextual information of the API.

/// namespace: Pgos.Client
struct TssHandledIn

field	type	description
scene_name	string	Scene name defined by PGOS.
module	string	Module name where the API is located.
func_name	string	Name of the API.
func_params	string	Request parameters of the API.

TssHandledOut

TSS information that needs to be returned.

/// namespace: Pgos.Client
struct TssHandledOut

field	type	description
scene_id	Int32	See the TSS documentation for the meaning of the field.
account_info	TssAccountInfo	See the TSS documentation for the meaning of the field.
extra	string	See the TSS documentation for the meaning of the field.

SendGroupMsgParams

Request struct for sending group message

/// namespace: Pgos.Client
struct SendGroupMsgParams

field	type	description
group_id	string	Group ID
content	string	Content, content length cannot exceed 1024 characters
custom_data	string	Additional information added by the game, content size cannot exceed 8KB in a narrow-character string, if it is a wide-character string, it should be converted to a utf-8 narrow-character string before calculating its length.
mentioned_players	List<MentionedPlayer>	The mentioned player list. The mentioned players will receive the corresponding events. When the value of player_id is '@ALL', it means mentioning all players.

GroupNameChangedEvt

Event result of group name changed

/// namespace: Pgos.Client
struct GroupNameChangedEvt

field	type	description
operator_info	GroupMemberBrief	The person who modified the group information
group_name	string	New group name

GroupDescChangedEvt

Event result of group description change

/// namespace: Pgos.Client
struct GroupDescChangedEvt

field	type	description
operator_info	GroupMemberBrief	The person who modified the group information
group_desc	string	New group description

GroupMemberJoinedEvt

Event result of new member of the group

/// namespace: Pgos.Client
struct GroupMemberJoinedEvt

field	type	description
member_info	GroupMember	New member
is_invited	bool	Whether the member was invited in
inviter_info	GroupMemberBrief	Who invited the member

GroupMemberLeftEvt

Event result of member left the group

/// namespace: Pgos.Client
struct GroupMemberLeftEvt

field	type	description
member_info	GroupMemberBrief	Member who left

GroupMemberRemovedEvt

Event result of member removed from group

/// namespace: Pgos.Client
struct GroupMemberRemovedEvt

field	type	description
operator_info	GroupMemberBrief	The person who removed the member
removed_member_info	GroupMemberBrief	Removed member

GroupAnnouncementChangedEvt

Event result of group description change

/// namespace: Pgos.Client
struct GroupAnnouncementChangedEvt

field	type	description
operator_info	GroupMemberBrief	The person who modified the group information
announcement	string	New announcement

GroupOwnerChangedEvt

Event result of group owner change

/// namespace: Pgos.Client
struct GroupOwnerChangedEvt

field	type	description
owner_info	GroupMemberBrief	New owner of the group

GroupAdminGrantedEvt

Event result of group admin granted

/// namespace: Pgos.Client
struct GroupAdminGrantedEvt

field	type	description
operator_info	GroupMemberBrief	Operator
member_info	GroupMemberBrief	Who granted as administrator

GroupAdminRevokedEvt

Event result of group admin revoked

/// namespace: Pgos.Client
struct GroupAdminRevokedEvt

field	type	description
operator_info	GroupMemberBrief	Operator
member_info	GroupMemberBrief	whose admin is revoked

GroupMsgEventContent

Group chat event message content

/// namespace: Pgos.Client
struct GroupMsgEventContent

field	type	description
event_type	GroupEventType	Group event type, rRead the specified event content according to the event type
group_name_changed	GroupNameChangedEvt	Event content of group name changed
group_desc_changed	GroupDescChangedEvt	Event content of group description changed
group_member_joined	GroupMemberJoinedEvt	Event content of new member of the group
group_member_left	GroupMemberLeftEvt	Event content of member left the group
group_member_removed	GroupMemberRemovedEvt	Event content of member removed from group
group_announcement_changed	GroupAnnouncementChangedEvt	Event content of group description changed
group_owner_changed	GroupOwnerChangedEvt	Event content of group owner changed
group_admin_granted	GroupAdminGrantedEvt	Event content of group admin granted
group_admin_revoked	GroupAdminRevokedEvt	Event content of group admin revoked

GroupMsgContent

Group chat message content

/// namespace: Pgos.Client
struct GroupMsgContent

field	type	description
text_content	string	Take the value from here when msg type is MsgTypeText
event_content	GroupMsgEventContent	Take the value from here when msg type is MsgTypeEvent
custom_content	string	Take the value from here when msg type is MsgTypeCustom

GroupMsgInfo

Group chat message info

/// namespace: Pgos.Client
struct GroupMsgInfo

field	type	description
sender	GroupMember	The member who sent the message
sent_time	Int64	The time the message was sent
msg_type	ChatMsgType	The type of the message
content	GroupMsgContent	The message to be sent
seq	Int64	The sequence number of the message
custom_data	string	Additional information added by the game
mentioned_players	List<MentionedPlayer>	The mentioned player list. The mentioned players will receive the corresponding events. When the value of player_id is '@ALL', it means mentioning all players.

GroupBrief

Group brief information

/// namespace: Pgos.Client
struct GroupBrief

field	type	description
group_id	string	Unique id of group
name	string	Group name
icon	string	Group icon
global_custom_data	Dictionary<string, string>	Group global custom data. Can be modified by the group owner or administrators.

GroupItem

Group item

/// namespace: Pgos.Client
struct GroupItem

field	type	description
group_brief	GroupBrief	Group brief information
latest_msg	GroupMsgInfo	Recent chat message info
unread_count	Int32	Unread message count

GetMyGroupListResult

My group list

/// namespace: Pgos.Client
struct GetMyGroupListResult

field	type	description
group_list	List<GroupItem>	My group list

GetGroupChatMsgListResult

Result of get group chat message list

/// namespace: Pgos.Client
struct GetGroupChatMsgListResult

field	type	description
msg_list	List<GroupMsgInfo>	Chat message info list
already_read_seq	Int64	Messages with seq less than or equal to this have already been read
has_more	bool	Whether has more message
next_seq	Int64	The starting sequence for the next query

ReceiveGroupMsgEvt

Event result of receive group chat message

/// namespace: Pgos.Client
struct ReceiveGroupMsgEvt

field	type	description
msg	GroupMsgInfo	Group chat message received
group_brief	GroupBrief	Group brief info
unread_count	Int32	Count of unread message from group

SendGroupMsgResult

Result of send a group message

/// namespace: Pgos.Client
struct SendGroupMsgResult

field	type	description
msg	GroupMsgInfo	Group chat message
group_brief	GroupBrief	Group brief info

GroupMentionedInfo

Result of get group mentioned record.

/// namespace: Pgos.Client
struct GroupMentionedInfo

field	type	description
msg	GroupMsgInfo	Group chat message received
group_brief	GroupBrief	Group brief info

GroupNewMentionedEvt

Event result of new mentioned.

/// namespace: Pgos.Client
struct GroupNewMentionedEvt

field	type	description
msg	GroupMsgInfo	Group chat message received
group_brief	GroupBrief	Group brief info

GetMailListParams

Request parameters for get mail list.

/// namespace: Pgos.Client
struct GetMailListParams

field	type	description
category	MailCategory	Query the specified category.
offset	UInt32	The starting position of the list.
count	UInt32	The query count.

UnclaimedItem

In-game Item not claimed.

/// namespace: Pgos.Client
struct UnclaimedItem

field	type	description
item	InGameItem	Economy item.
amount	UInt32	The amount of item.

MailAttachmentInfo

Mail attachment information.

/// namespace: Pgos.Client
struct MailAttachmentInfo

field	type	description
items	List<UnclaimedItem>	Items waiting to be claimed.
currencies	List<Currency>	Currencies waiting to be claimed.
is_gift_from_player	bool	Is it a gift from the player.
giver	PlayerInfo	If 'is_gift_from_player' is true, 'giver' represents the player who gave the gift.
is_claimed	bool	Is it claimed.

MailInfo

Mail information.

/// namespace: Pgos.Client
struct MailInfo

field	type	description
mail_id	string	Mail ID.
title	string	Mail title.
category	MailCategory	Mail category.
content	string	Mail content.
attachment	MailAttachmentInfo	Mail attachment.
custom_data	string	Custom data for mail.
sent_time	Int64	The time the mail was sent.
is_read	bool	Whether the mail is marked as read.

GetMailListResult

Result of get mail list.

/// namespace: Pgos.Client
struct GetMailListResult

field	type	description
mail_list	List<MailInfo>	Mail info list.
has_more	bool	Has more.
next_offset	Int32	The next starting position of the list.
total_num	UInt32	The total number of mails in the specified category. When the query category is 'All', it indicates the total number of mails in all categories.

ClaimMailAttachmentResult

Result of claim mail attachment.

/// namespace: Pgos.Client
struct ClaimMailAttachmentResult

field	type	description
item_insts	ItemInstPack	The item instances obtained after claim attachments.
currencies	List<Currency>	The currencies obtained after claim attachments.
conflict_unique_items	List<UnclaimedItem>	Unique items that already in inventory cause failed to be granted.
fails	Dictionary<string, string>	Mails that failed to claim attachments, key: mail ID, value: failed reason.

GetMailBadgeNumResult

Result of get mail badge number.

/// namespace: Pgos.Client
struct GetMailBadgeNumResult

field	type	description
category_badge_num	Dictionary<MailCategory, UInt32>	Mail unread count by category.
total_badge_num	UInt32	Total unread count.

BadgeNumOfMailEvt

Event result of badge num of mail.

/// namespace: Pgos.Client
struct BadgeNumOfMailEvt

field	type	description
total_badge_num	UInt32	Total unread count.

ReceiveNewMailEvt

Event result of receive new mail.

/// namespace: Pgos.Client
struct ReceiveNewMailEvt

field	type	description
mail	MailInfo	New mail.

RelationshipInfo

Information of the relationship with other players.

/// namespace: Pgos.Client
struct RelationshipInfo

field	type	description
is_blocked	bool	Whether the player is blocked
is_friend	bool	Whether the player is in friend list
friend_remark	string	Friend remark. Only valid if the player is in friend_list
befriend_time	Int64	The time when the player became friend, in seconds. Only valid if the player is in friend_list

GetPlayerProfileResult

Result of get player profile

/// namespace: Pgos.Client
struct GetPlayerProfileResult

field	type	description
player_info	PlayerInfo
player_presence	PlayerPresence
relationship_info	RelationshipInfo
last_play_time	Int64	The time when the current logged in player played games with the player last time, in seconds

PublicChatSystemContent

Public chat system message content.

/// namespace: Pgos.Client
struct PublicChatSystemContent

field	type	description
msg	string	System message content.
duration_sec	UInt32	Indicates how long a system message will expire. The players will receive the system messages that were sent before they join, as long as the message doesn't expire.

PublicChatMsgContent

Public chat message content

/// namespace: Pgos.Client
struct PublicChatMsgContent

field	type	description
text_content	string	Take the value from here when msg type is MsgTypeText.
system_content	PublicChatSystemContent	Take the value from here when msg type is MsgTypeSystem.
custom_content	string	Take the value from here when msg type is MsgTypeCustom.

PublicChatMsgInfo

Public chat message info.

/// namespace: Pgos.Client
struct PublicChatMsgInfo

field	type	description
msg_type	ChatMsgType	The type of the message.
content	PublicChatMsgContent	The message to be sent.
sender	PlayerInfo	The player who sent the message.
sent_time	Int64	The time the message was sent.
seq	Int64	The sequence number of the message
custom_data	string	Custom data for message.
mentioned_players	List<MentionedPlayer>	The mentioned player list. The mentioned players will receive the corresponding events. When the value of player_id is '@ALL', it means mentioning all players.

PublicChatChannelInfo

The channel info of public chat

/// namespace: Pgos.Client
struct PublicChatChannelInfo

field	type	description
channel_name	string	Channel name.

JoinPublicChatResult

Result of join public chat.

/// namespace: Pgos.Client
struct JoinPublicChatResult

field	type	description
channel_info	PublicChatChannelInfo	The channel info of public chat.

SendPublicChatMsgParams

Request parameters for sending public chat message.

/// namespace: Pgos.Client
struct SendPublicChatMsgParams

field	type	description
channel_name	string	The name of the channel on which the message was sent.
content	string	The content of the message to be sent.
custom_data	string	Custom data for message.
mentioned_players	List<MentionedPlayer>	The mentioned player list. The mentioned players will receive the corresponding events. When the value of player_id is '@ALL', it means mentioning all players.

SendPublicChatMsgResult

Result of send public chat message.

/// namespace: Pgos.Client
struct SendPublicChatMsgResult

field	type	description
msg	PublicChatMsgInfo	Public chat message.
channel_info	PublicChatChannelInfo	Public chat channel info.

ReceivePublicChatMsgEvt

Event result of receive public chat message.

/// namespace: Pgos.Client
struct ReceivePublicChatMsgEvt

field	type	description
msg	PublicChatMsgInfo	Public chat message.
channel_info	PublicChatChannelInfo	Public chat channel info.

PublicChatMentionedInfo

Result of get public chat mentioned record.

/// namespace: Pgos.Client
struct PublicChatMentionedInfo

field	type	description
msg	PublicChatMsgInfo	Public chat message.
channel_info	PublicChatChannelInfo	Public chat channel info.

PublicChatNewMentionedEvt

Event result of new mentioned.

/// namespace: Pgos.Client
struct PublicChatNewMentionedEvt

field	type	description
msg	PublicChatMsgInfo	Public chat message.
channel_info	PublicChatChannelInfo	Public chat channel info.

GoalRewardItem

In-game item as goal rewards.

/// namespace: Pgos.Client
struct GoalRewardItem

field	type	description
item	InGameItem	In-game item.
amount	UInt32	Amount of the item.

PlayerGoalPass

Pass for rewards in a hyper goal.

/// namespace: Pgos.Client
struct PlayerGoalPass

field	type	description
pass_id	string	The identifier of the pass.
name	string	Name of the pass.
description	string	Description of the pass.
icon	string	Icon records the resource address of the pass icon shown to players.
is_activated	bool	Whether the pass is activated for the player.

GoalReward

The reward that will available to players when a goal or a tier is reached.

/// namespace: Pgos.Client
struct GoalReward

field	type	description
reward_id	string	The identifier of the reward.
pass_id	string	The access pass's id for the reward.
is_claimed	bool	True if the reward is claimed by the player.
claimed_time	Int64	Unix timestamp that the reward is claimed.
items	List<GoalRewardItem>	The in-game items in this reward
currencies	List<Currency>	The currencies in this reward

PlayerGoalTier

/// namespace: Pgos.Client
struct PlayerGoalTier

field	type	description
tier_id	string	The identifier of the tier.
name	string	Name of the tier.
order	UInt32	Order of the tier.
achieve_value	UInt32	The value of achieve data of a player to achieve the tier.
is_achieved	bool	True if the tier is achieved by the player.
achieved_time	Int64	Unix timestamp that the reward is claimed.
tier_rewards	List<GoalReward>	Rewards of the tier.

GoalBaseInfo

/// namespace: Pgos.Client
struct GoalBaseInfo

field	type	description
player_goal_id	string	Id of the player goal. The player goal id will be different when the goal appears in different available periods.
goal_id	string	The identifier of the goal.
type	GoalType	Type of the goal.
name	string	Name of the goal.
description	string	Description of the goal.
icon	string	Icon records the resource address of the goal icon shown to players.
tags	List<string>	Tag strings of the goal.

SimpleGoal

/// namespace: Pgos.Client
struct SimpleGoal : GoalBaseInfo

parent: GoalBaseInfo

field	type	description
achieve_value	UInt32	The value of achieve data of a player to achieve the simple goal.
current_value	UInt32	The current value of the achieve data.
is_achieved	bool	True if the simple goal is achieved by the player.
achieved_time	Int64	Unix timestamp that the reward is claimed.
reward	GoalReward	The reward players can get if they achieve the goal.

HyperGoal

/// namespace: Pgos.Client
struct HyperGoal : GoalBaseInfo

parent: GoalBaseInfo

field	type	description
passes	List<PlayerGoalPass>	Passes of the hyper goal.
tiers	List<PlayerGoalTier>	Tiers of the hyper goal.
current_tier_id	string	The tier that the player is challenging now. When the Algorithm Type is Absolute, current value is the same as the value of player's achieve data. When the Algorithm Type is Increment, current value is the incremental value obtained by the player achieve data in the current tier.
current_value	UInt32	The current value of the achieve data of the hyper goal.

AvailablePeriod

Available period info.

/// namespace: Pgos.Client
struct AvailablePeriod

field	type	description
period_id	string	Period id.
player_goal_ids	List<string>	Player goal ids within the available period.
simple_goals	Dictionary<string, SimpleGoal>	Mapping of player goal id to simple player goal.
hyper_goals	Dictionary<string, HyperGoal>	Mapping of player goal id to hyper player goal.
start_time	Int64	Start Unix timestamp of the period.
end_time	Int64	End Unix timestamp of the period.
length	Int64	Length of the available period. Counting in second.

GoalsSchedule

Goal schedule info.

/// namespace: Pgos.Client
struct GoalsSchedule

field	type	description
schedule_id	string	The identifier of a goals schedule.
name	string	Name of a goals schedule.
description	string	Description of a goals schedule.
status	ScheduleStatus	Status of a goals schedule.
periods	Dictionary<string, AvailablePeriod>	Available periods of the schedule. For current period, a fully AvailablePeriod structure will be returned. For next period, only the time schedule of of the period will be returned.
current_period_id	string	The nearest available period to the current time, which is already active.
next_period_id	string	The nearest available period to the current time that is not yet active.
reward_way	GoalRewardWay	The reward way of the goals within the goals schedule.

GetGoalTiersResult

/// namespace: Pgos.Client
struct GetGoalTiersResult

field	type	description
tiers	List<PlayerGoalTier>	Tiers info.
next_order	UInt32	Next tier's roder.

ClaimGoalsRewardResult

Result of claim goal rewards.

/// namespace: Pgos.Client
struct ClaimGoalsRewardResult

field	type	description
item_insts	ItemInstPack	The item instances obtained after claim attachments.
currencies	List<Currency>	The currencies obtained after claim attachments.
conflict_unique_items	List<UnclaimedItem>	Unique items that already in inventory that failed to be granted.

SimpleGoalAchievedEvt

The event will be triggered when a simple goal achieved.

/// namespace: Pgos.Client
struct SimpleGoalAchievedEvt

field	type	description
achieved_goal	SimpleGoal	The simple goal that has been achieved.

HyperGoalAchievedEvt

The event will be triggered when some tiers of a hyper goal achieved.

/// namespace: Pgos.Client
struct HyperGoalAchievedEvt

field	type	description
achieved_goal	HyperGoal
achieved_tiers_ids	List<string>	The tier id that has been achieved.

TitleRegionClosedEvt

The event will be triggered when the title region is closed. After the title region is closed, players can no longer access new logins, new matchmaking, or new battle session placements.

/// namespace: Pgos.Client
struct TitleRegionClosedEvt

field	type	description
current_time	Int64	The current Unix timestamp of the backend server. (in seconds)
kicked_offline_time	Int64	The approximate Unix timestamp at which the player will be kicked offline. (in seconds) If the value is 0, the PGOS backend will kick the player offline soon. If the value is -1, the PGOS backend will still allow the current player to remain online, and battle sessions the player is in will not be affected.

EventChannelStatusChangedEvt

The event will be triggered when the event channel status has been changed. The Event Channel serves as a data pipeline for the PGOS backend to send event notifications (e.g., chat_messages/friend_requests) to the client. Its status can be influenced by factors such as API calls (e.g., login/logout) and fluctuations in the network environment. In certain scenarios, the event helps the game/player understand the possible reasons for PGOS/game service degradation.

/// namespace: Pgos.Client
struct EventChannelStatusChangedEvt

field	type	description
current_status	PgosEventChannelStatus	Indicate the current status of the event channel.
last_status	PgosEventChannelStatus	Indicate the status of the event channel in the previous StatusChanged event. If there is no previous event (meaning it is the first event), its value is set to 'Dummy'.

DescribeBattleSessionsResult

/// namespace: Pgos.Client
struct DescribeBattleSessionsResult

field	type	description
battle_sessions	List<BattleSessionInfo>	The battle sesions that a player is participating in.

DSHostingLatencies

The latencies from the client to the DS hosting data centers.

/// namespace: Pgos.Client
struct DSHostingLatencies

field	type	description
latencies	Dictionary<string, Int32>	The latencies from the client to the DS hosting data centers. Key: The data center name and its possible values can be viewed in the 'DataCenterName' definition. Value: The latency to the data center, in milliseconds.

GameCustomMsgEvt

The event will be triggered when the game calls the HTTP API 'PushMsg'.

/// namespace: Pgos.Client
struct GameCustomMsgEvt

field	type	description
msg_type	string	Corresponds to the 'msg_type' parameter of the HTTP API 'PushMsg'.
msg	string	Corresponds to the 'msg' parameter of the HTTP API 'PushMsg'.

CycleInfo

Information of cycle which configured on the portal.

/// namespace: Pgos.Client
struct CycleInfo

field	type	description
cycle_name	string	Cycle name.
cycle_start_time	Int64	Start time of the cycle. Unix time in second.
cycle_end_time	Int64	End time of the cycle. Unix time in second.
lock_time_span	UInt32	Lock time span of this cycle. After setting, the period before the end of each round will be locked, and the leaderboard data will not be updated during the locked period. Unix time in second.

LeaderboardRoundInfo

Information of leaderboard round.

/// namespace: Pgos.Client
struct LeaderboardRoundInfo

field	type	description
round_seq	UInt32	The sequence number of the leaderboard round. Start from 1, the numbers are increasing in sequence, increasing by 1 in each round. 0 means the data of this round info is invalid or has been cleared.
round_start_time	Int64	The round start time. Unix time in second.
round_end_time	Int64	The round end time. Unix time in second.
round_locked	bool	True if this round has been locked or end.

LeaderboardInfo

Information of leaderboard.

/// namespace: Pgos.Client
struct LeaderboardInfo

field	type	description
leaderboard_name	string	The name of the leaderboard.
stat_name	string	The name of the stat bound to the leaderboard.
is_cycled	bool	Is this leaderboard a cycled leaderboard.
cycle_info	CycleInfo	The information of cycle bound to the leaderboard. This is only meaningful if is_cycled is true.
round_info	LeaderboardRoundInfo	Round information for a specified time or current time. This is only meaningful if is_cycled is true.

LBRankingItem

Ranking item of leaderboard.

/// namespace: Pgos.Client
struct LBRankingItem

field	type	description
rank	UInt32	The ranking number, start from 1.
key	string	Stat item key.
value	double	Stat item value.
secondary_value	double	Stat item secondary value.
custom_data	string	Stat item custom data, used to store additional information.

LBRankingListResult

Response for get ranking list.

/// namespace: Pgos.Client
struct LBRankingListResult

field	type	description
items	List<LBRankingItem>	List of ranking items.
leaderboard_info	LeaderboardInfo	Leaderboard information.
total_num	UInt32	The total number of ranking items.
next_offset	UInt32	The next starting position of the list.

LBRankingItemPos

Current ranking list item with neighbor items.

/// namespace: Pgos.Client
struct LBRankingItemPos

field	type	description
item	LBRankingItem	Current ranking item.
preceding_items	List<LBRankingItem>	Preceding items.
subsequent_items	List<LBRankingItem>	Subsequent items.
leaderboard_info	LeaderboardInfo	Leaderboard information.

GetRankingListParams

/// namespace: Pgos.Client
struct GetRankingListParams

field	type	description
leaderboard_name	string	The name of the leaderboard to query.
offset	UInt32	The starting position of the query.
count	UInt32	The query count.
leaderboard_round_seq	UInt32	[Option] Query the ranking list of the specified round in the cycled leaderboard. The default value 0 means querying the ranking of the current round.

GetFriendsRankingListParams

/// namespace: Pgos.Client
struct GetFriendsRankingListParams

field	type	description
leaderboard_name	string	The name of the leaderboard to query.
leaderboard_round_seq	UInt32	[Option] Query the ranking list of the specified round in the cycled leaderboard. The default value 0 means querying the ranking of the current round.

LBFriendsRankingListResult

Response for get friends ranking list.

/// namespace: Pgos.Client
struct LBFriendsRankingListResult

field	type	description
items	List<LBRankingItem>	List of friends ranking items. The stat item key was filled with player id.
friend_infos	Dictionary<string, PlayerFriendInfo>	Friends' details. key: player id Note that this only contains the player information of friends, not my own. The 'items' contains my ranking.
leaderboard_info	LeaderboardInfo	Leaderboard information.

GetRankingItemPosParams

/// namespace: Pgos.Client
struct GetRankingItemPosParams

field	type	description
leaderboard_name	string	The name of the leaderboard to query.
key	string	The stat item key to query.
neighbor_cnt	UInt32	Specify the desired number of preceding and subsequent neighbors, ranging from 0 to 10. For example: if neighbor_cnt is 3, then you will get 3 preceding neighbors and 3 subsequent neighbors.
leaderboard_round_seq	UInt32	[Option] Query the ranking list of the specified round in the cycled leaderboard. The default value 0 means querying the ranking of the current round.

SetGroupGlobalCustomDataParams

/// namespace: Pgos.Client
struct SetGroupGlobalCustomDataParams

field	type	description
group_id	string	The group id.
global_custom_data	Dictionary<string, string>	Custom data to be modified or added.

SetGroupGlobalCustomDataResult

/// namespace: Pgos.Client
struct SetGroupGlobalCustomDataResult

field	type	description
global_custom_data	Dictionary<string, string>	Updated full global custom data.

DelGroupGlobalCustomDataParams

/// namespace: Pgos.Client
struct DelGroupGlobalCustomDataParams

field	type	description
group_id	string	The group id.
keys	List<string>	Custom data keys to delete.

DelGroupGlobalCustomDataResult

/// namespace: Pgos.Client
struct DelGroupGlobalCustomDataResult

field	type	description
global_custom_data	Dictionary<string, string>	Updated full global custom data.
fails	Dictionary<string, string>	Keys failed to delete, and also with the reason.

ClearGroupGlobalCustomDataParams

/// namespace: Pgos.Client
struct ClearGroupGlobalCustomDataParams

field	type	description
group_id	string	The group id.

SetGroupMyPlayerCustomDataParams

/// namespace: Pgos.Client
struct SetGroupMyPlayerCustomDataParams

field	type	description
group_id	string	The group id.
player_custom_data	string	Custom data for current player.

SetGroupMyPlayerCustomDataResult

/// namespace: Pgos.Client
struct SetGroupMyPlayerCustomDataResult

field	type	description
player_custom_data	string	Updated custom data for current player.

BatchSetGroupPlayerCustomDataParams

/// namespace: Pgos.Client
struct BatchSetGroupPlayerCustomDataParams

field	type	description
group_id	string	The group id.
player_custom_data	Dictionary<string, string>	Map from player id to player custom data.

BatchSetGroupPlayerCustomDataResult

/// namespace: Pgos.Client
struct BatchSetGroupPlayerCustomDataResult

field	type	description
player_custom_data	Dictionary<string, string>	Updated custom data for each player.
fails	Dictionary<string, string>	Keys failed to set, and also with the reason.

JoinWorldParams

/// namespace: Pgos.Client
struct JoinWorldParams

field	type	description
world_config	string	World config name that request to join.
filter_attributes	Dictionary<string, KVDataValue>	Attributes needed by world buckets filters, map key: attribute name, map value: attribute value.
team_name	string	The team name that the player will join in the world battle session. If empty, the player will be assigned to a [default] team.

JoinWorldResult

/// namespace: Pgos.Client
struct JoinWorldResult

field	type	description
battle_session	BattleSessionInfo	The battle session that the world assigned for the players.

InviteJoinWorldParams

/// namespace: Pgos.Client
struct InviteJoinWorldParams

field	type	description
world_config	string	World config name that request to join.
filter_attributes	Dictionary<string, KVDataValue>	Attributes needed by world buckets filters, map key: attribute name, map value: attribute value.
invited_player_ids	List<string>	Player IDs who will be invited to join the same world. (Must include at least 1 player) These invited players will receive the 'OnJoinWorldInvitationUpdated' event on their game client. Players who accept (AcceptJoinWorldInvitation API) the invitation will be assigned to the same world battle session as the current player. Players who reject (RejectJoinWorldInvitation API) the invitation will skip the invitation and will not be affected. The inviter (current player) will also receive the 'OnJoinWorldInvitationUpdated' event to know the status of the invitation being accepted or rejected. The inviter will automatically accept the invitation.
team_name	string	The team name that the player will join in the world battle session. If empty, the player will be assigned to a [default] team.

InviteJoinWorldResult

/// namespace: Pgos.Client
struct InviteJoinWorldResult

field	type	description
world_config	string	The world configuration name associated with the invitation ticket.
invitation_ticket	string	The ticket of the join world invitation.

InviteLeaveWorldParams

/// namespace: Pgos.Client
struct InviteLeaveWorldParams

field	type	description
world_config	string	World config name that request to join.
invited_player_ids	List<string>	Player IDs who will be invited to leave the same world. (Must include at least 1 player) These invited players will receive the 'OnLeaveWorldInvitationUpdated' event on their game client. Players who accept (AcceptLeaveWorldInvitation API) the invitation will be removed from the world. Players who reject (RejectLeaveWorldInvitation API) the invitation will skip the invitation and will not be affected. The inviter (current player) will also receive the 'OnLeaveWorldInvitationUpdated' event to know the status of the invitation being accepted or rejected. The inviter will automatically leave the world.

InviteLeaveWorldResult

/// namespace: Pgos.Client
struct InviteLeaveWorldResult

field	type	description
world_config	string	The world configuration name associated with the invitation ticket.
invitation_ticket	string	The ticket of the leave world invitation.

LeaveWorldParams

/// namespace: Pgos.Client
struct LeaveWorldParams

field	type	description
world_config	string	World config name that request to leave.

JoinWorldBattleSessionParams

/// namespace: Pgos.Client
struct JoinWorldBattleSessionParams

field	type	description
world_config	string	World config name that request to join.
battle_session_id	string	The world battle session id to join.
payload	string	The game custom data, which will be passed to the DS (dedicated server). It can be obtained by monitoring the 'OnBattleSessionUpdated' event of the Hosting module: FServerBattleSessionUpdatedEvt.new_player_battle_sessions.payload.
team_name	string	The team name that the player will join in the world battle session. If empty, the player will be assigned to a [default] team.

JoinWorldBattleSessionResult

/// namespace: Pgos.Client
struct JoinWorldBattleSessionResult

field	type	description
battle_session	BattleSessionInfo	Battle session detail info.

InviteJoinWorldBattleSessionParams

/// namespace: Pgos.Client
struct InviteJoinWorldBattleSessionParams

field	type	description
world_config	string	World config name that request to join.
battle_session_id	string	The world battle session id to join.
payload	string	The game custom data, which will be passed to the DS (dedicated server). It can be obtained by monitoring the Hosting module event (OnBattleSessionUpdatedEvt): BattleSessionUpdatedEvt.new_player_battle_sessions.payload.
invited_player_ids	List<string>	Player IDs who will be invited to join the same world battle session. (Must include at least 1 player) These invited players will receive the 'OnJoinWorldInvitationUpdated' event on their game client. Players who accept (AcceptJoinWorldInvitation API) the invitation will be assigned to the same world battle session as the current player. Players who reject (RejectJoinWorldInvitation API) the invitation will skip the invitation and will not be affected. The inviter (current player) will also receive the 'OnJoinWorldInvitationUpdated' event to know the status of the invitation being accepted or rejected. The inviter will automatically accept the invitation.
team_name	string	The team name that the player will join in the world battle session. If empty, the player will be assigned to a [default] team.

InviteJoinWorldBattleSessionResult

/// namespace: Pgos.Client
struct InviteJoinWorldBattleSessionResult

field	type	description
world_config	string	The world configuration name associated with the invitation ticket.
invitation_ticket	string	The ticket of the join world invitation.

AcceptJoinWorldInvitationParams

/// namespace: Pgos.Client
struct AcceptJoinWorldInvitationParams

field	type	description
invitation_ticket	string	The ticket of the join world invitation.

RejectJoinWorldInvitationParams

/// namespace: Pgos.Client
struct RejectJoinWorldInvitationParams

field	type	description
invitation_ticket	string	The ticket of the join world invitation.

AcceptLeaveWorldInvitationParams

/// namespace: Pgos.Client
struct AcceptLeaveWorldInvitationParams

field	type	description
invitation_ticket	string	The ticket of the leave world invitation.

RejectLeaveWorldInvitationParams

/// namespace: Pgos.Client
struct RejectLeaveWorldInvitationParams

field	type	description
invitation_ticket	string	The ticket of the leave world invitation.

QueryMyWorldBattleSessionsParams

/// namespace: Pgos.Client
struct QueryMyWorldBattleSessionsParams

field	type	description
world_configs	List<string>	Worlds to query.

QueryMyWorldBattleSessionsResult

/// namespace: Pgos.Client
struct QueryMyWorldBattleSessionsResult

field	type	description
world_battle_sessions	Dictionary<string, BattleSessionInfo>	A map from world config name to the battle session. Only contains the worlds that the player has joined.

QueryPlayerWorldBattleSessionsParams

/// namespace: Pgos.Client
struct QueryPlayerWorldBattleSessionsParams

field	type	description
player_id	string	Player to query.
world_configs	List<string>	Worlds to query.

QueryPlayerWorldBattleSessionsResult

/// namespace: Pgos.Client
struct QueryPlayerWorldBattleSessionsResult

field	type	description
world_battle_sessions	Dictionary<string, BattleSessionInfo>	A map from world config name to the battle session. Only contains the worlds that the player has joined.

QueryJoinWorldInvitationParams

/// namespace: Pgos.Client
struct QueryJoinWorldInvitationParams

field	type	description
invitation_ticket	string	The invitation ticket to query.

JoinWorldInvitationInfo

The join world invitation detail information.

/// namespace: Pgos.Client
struct JoinWorldInvitationInfo

field	type	description
world_config	string	The world configuration name associated with the invitation ticket.
inviter	PlayerInfo	The player who initiated the invitation.
invitation_ticket	string	The ticket of the join world invitation.
status	JoinWorldInvitationStatus	The status of the Join World invitation. Typically, the player who accepts the invitation will receive the 'OnWorldBattleSessionUpdated' event after the invitation status is marked as 'Completed'. However, if the player is already in the assigned battle session before the invitation, and has obtained the battle session's IP&port (which means he has received the relevant event of the battle session status being Active), then he may not be pushed the 'OnWorldBattleSessionUpdated' event.
error_msg	string	The error message when the status is 'Error'.
my_action_to_invitation	JoinWorldInvitationAction	The current player's action to this join world invitation. Call 'AcceptJoinWorldInvitation' API to accept the invitation and will receive the 'OnJoinWorldInvitationUpdated' event until the status is 'Completed'. Alternatively, call the 'RejectJoinWorldInvitation' API to reject the invitation and stop receiving the 'OnJoinWorldInvitationUpdated' event for this 'invitation_ticket'. Note: Once you have made your choice, you cannot change your decision.
accepted_players	List<PlayerInfo>	Players who have accepted the invitation. (including the inviter)
rejected_players	List<PlayerInfo>	Players who have rejected the invitation.
undecided_players	List<PlayerInfo>	Players who have not yet made a decision.
invitation_created_time	Int64	The Unix timestamp(in seconds) when the invitation was created.
invitation_timeout	UInt32	The maximum time(in seconds) to wait for all invited players to accept/reject. After the time (invitation_created_time+invitation_timeout), the event status will be updated to 'Completed'.
battle_session_id	string	The world battle session joined by the players who accepted the invitation. It will be empty until the 'status' changes to 'JoinWorldInvitationStatus::Completed'.

LeaveWorldInvitationInfo

The leave world invitation detail information.

/// namespace: Pgos.Client
struct LeaveWorldInvitationInfo

field	type	description
world_config	string	The world configuration name associated with the invitation ticket.
inviter	PlayerInfo	The player who initiated the invitation.
invitation_ticket	string	The ticket of the leave world invitation.
status	LeaveWorldInvitationStatus	The status of the leave World invitation.
error_msg	string	The error message when the status is 'Error'.
my_action_to_invitation	LeaveWorldInvitationAction	The current player's action to this leave world invitation. Call 'AcceptLeaveWorldInvitation' API to accept the invitation and will receive the 'OnLeaveWorldInvitationUpdated' event until the status is 'Completed'. Alternatively, call the 'RejectLeaveWorldInvitation' API to reject the invitation and stop receiving the 'OnLeaveWorldInvitationUpdated' event for this 'invitation_ticket'. Note: Once you have made your choice, you cannot change your decision.
accepted_players	List<PlayerInfo>	Players who have accepted the invitation. (including the inviter)
rejected_players	List<PlayerInfo>	Players who have rejected the invitation.
undecided_players	List<PlayerInfo>	Players who have not yet made a decision.
invitation_created_time	Int64	The Unix timestamp(in seconds) when the invitation was created.
invitation_timeout	UInt32	The maximum time(in seconds) to wait for all invited players to accept/reject. After the time (invitation_created_time+invitation_timeout), the event status will be updated to 'Completed'.

QueryJoinWorldInvitationResult

/// namespace: Pgos.Client
struct QueryJoinWorldInvitationResult

field	type	description
info	JoinWorldInvitationInfo	The join world invitation detail information.

GetRecommendedPlayersParams

/// namespace: Pgos.Client
struct GetRecommendedPlayersParams

field	type	description
count	UInt32	Specifies the (maximum) number of players to be returned, its value range is: [1~50]

GetPotentialFriendsParams

/// namespace: Pgos.Client
struct GetPotentialFriendsParams

field	type	description
count	UInt32	Specifies the (maximum) number of players to be returned, its value range is: [1~50]
offset	UInt32	Specifies the offset of the first player to be returned.

WorldBattleSessionUpdatedEvt

/// namespace: Pgos.Client
struct WorldBattleSessionUpdatedEvt

field	type	description
world_config	string	The world configuration name associated with this update.
battle_session	BattleSessionInfo	The updated details of the battle session that the current player joined.

WorldBattlePropertiesUpdatedEvt

/// namespace: Pgos.Client
struct WorldBattlePropertiesUpdatedEvt

field	type	description
source_type	BattleSourceType	The source type of the battle session.
configuration_name	string	World config name.
battle_session_id	string	World battle session id.
battle_properties	List<BattleProperty>

JoinWorldInvitationUpdatedEvt

/// namespace: Pgos.Client
struct JoinWorldInvitationUpdatedEvt

field	type	description
info	JoinWorldInvitationInfo	The join world invitation detail information.

LeaveWorldInvitationUpdatedEvt

/// namespace: Pgos.Client
struct LeaveWorldInvitationUpdatedEvt

field	type	description
info	LeaveWorldInvitationInfo	The leave world invitation detail information.

LobbyJoinRequestEvt

/// namespace: Pgos.Client
struct LobbyJoinRequestEvt

field	type	description
lobby_id	string	Lobby id.
player_id	string	Player id who request to join the lobby.
payload	string	Payload data from the request player.
token	string	The token required to process this join request, which should be used in ApproveJoinRequest/RejectJoinRequest interface.

LobbyJoinRequestApprovedEvt

/// namespace: Pgos.Client
struct LobbyJoinRequestApprovedEvt

field	type	description
lobby_detail	LobbyDetailInfo	The lobby details information.

LobbyJoinRequestRejectedEvt

/// namespace: Pgos.Client
struct LobbyJoinRequestRejectedEvt

field	type	description
lobby_id	string	Lobby id.

LobbyGlobalCustomDataUpdatedEvt

/// namespace: Pgos.Client
struct LobbyGlobalCustomDataUpdatedEvt

field	type	description
kv_data	Dictionary<string, string>	Global kv data of the lobby. Only owner has the permission to modify it.
lobby_id	string	Lobby id.

LobbyPlayerCustomDataUpdatedEvt

/// namespace: Pgos.Client
struct LobbyPlayerCustomDataUpdatedEvt

field	type	description
player_kv_data	Dictionary<string, string>	Player custom data of each lobby member. The map key is lobby member's player ID, the map value is the lobby member's custom data. Each lobby member could modify it's player kv data.
lobby_id	string	Lobby id.

ApproveJoinLobbyRequestParams

/// namespace: Pgos.Client
struct ApproveJoinLobbyRequestParams

field	type	description
lobby_id	string	Lobby id.
player_id	string	Player id who request to join the lobby.
token	string	The token required to process this join request, which could be obtained from LobbyJoinRequestEvt.

RejectJoinLobbyRequestParams

/// namespace: Pgos.Client
struct RejectJoinLobbyRequestParams

field	type	description
lobby_id	string	Lobby id.
player_id	string	Player id who request to join the lobby.
token	string	The token required to process this join request, which could be obtained from LobbyJoinRequestEvt.

IncrMyKVDataIdempotentParams

/// namespace: Pgos.Client
struct IncrMyKVDataIdempotentParams

field	type	description
increments	Dictionary<string, KVDataValue>	Increments to update, key: kvdata key, value: increment of the value.
idempotency_token	string	[Optional] Used to ensure the idempotence of the function. An idempotent operation produces the same outcome regardless of how many times it's executed, without causing any side effects or altering the system's state. The scope of the idempotent token is for each player.

IncrMyKVDataIdempotentResult

/// namespace: Pgos.Client
struct IncrMyKVDataIdempotentResult

field	type	description
kvdata	Dictionary<string, KVDataValue>	KVData items, key: item key, value: item value.
replayed	bool	Whether the request is replayed. When it is True, it indicates that the result of the function is obtained by replaying with the same idempotency_token. This means that the result of the function has been generated in a previous call and is being reused in the current call.

GetMidasGlobalAddonInfoResult

/// namespace: Pgos.Client
struct GetMidasGlobalAddonInfoResult

field	type	description
is_role_id_mapped	bool	The management method for the Midas Role ID in the Midas Global addon. If the value is true, the role_id field will be populated by PGOS with the Role ID assigned to the current logged-in player based on the Midas Global addon configuration. If the value is false, the role_id field will not be populated. Please use the SetMidasGlobalMetaData interface to actively set the Midas Role ID.
role_id	string
partition_id	string
provider_app_id	string

SetMidasGlobalMetaDataParams

/// namespace: Pgos.Client
struct SetMidasGlobalMetaDataParams : MidasGlobalMetaData

parent: MidasGlobalMetaData

SetMidasGlobalMetaDataResult

/// namespace: Pgos.Client
struct SetMidasGlobalMetaDataResult

field	type	description
is_role_id_mapped	bool	Echo back the role ID management mode configured in the Midas Global addon.
role_id	string	Echo back the final adopted role ID. It will be the same as the calling parameter if is_role_id_mapped is false. If is_role_id_mapped is true, PGOS will populate it based on the current player's login information.

MidasGlobalTransaction

/// namespace: Pgos.Client
struct MidasGlobalTransaction

field	type	description
payment_method	string	Pay method, enumeration values can be filled in: GOOGLE_PLAY, APPLE_STORE, STEAM, EPIC, MICROSOFT_STORE, SWITCH, PLAY_STATION
region_code	string	Region code in uppercase, refer to ISO 3166.
currency_code	string	Currency code, refer to ISO 4217.

MidasGlobalProductInfo

/// namespace: Pgos.Client
struct MidasGlobalProductInfo

field	type	description
midas_unified_product_id	string	Midas unified product id.
store_item_id	string	PGOS store item that mapped to the Midas product and the Store where it will be listed for sale are need.
store_id	string	PGOS store item that mapped to the Midas product and the Store where it will be listed for sale are need.

CreateMidasGlobalOrderParams

/// namespace: Pgos.Client
struct CreateMidasGlobalOrderParams

field	type	description
product_info	MidasGlobalProductInfo	Purchase item information.
transaction	MidasGlobalTransaction	Transaction information.
payload	string	Transparent field, with a maximum limit of 256 characters.
language	string	Related to multilingualism, refer to ISO 639-1.

CreateMidasGlobalOrderResult

/// namespace: Pgos.Client
struct CreateMidasGlobalOrderResult

field	type	description
order_id	string	Order ID.
pay_info	string	Payment informatio, required by the Pay interface provided by the Midas Client SDK.

GetMidasGlobalBalanceDetailParams

/// namespace: Pgos.Client
struct GetMidasGlobalBalanceDetailParams

field	type	description
currency_codes	List<string>	Currency code of a PGOS virtual currency. Note: This interface is only used to query virtual currency with CurrencyType as MidasGlobalToken.

GetMidasGlobalBalanceDetailResult

/// namespace: Pgos.Client
struct GetMidasGlobalBalanceDetailResult

field	type	description
balances	List<MidasGlobalBalance>

ActivateP2PBattleSessionParams

/// namespace: Pgos.Client
struct ActivateP2PBattleSessionParams

field	type	description
battle_session_id	string

AcceptP2PPlayerBattleSessionParams

/// namespace: Pgos.Client
struct AcceptP2PPlayerBattleSessionParams

field	type	description
battle_session_id	string	The id of a P2P battle session
player_battle_session_id	string	The id of player session in the battle, only a Reserved player session id could be accepted. !!! NOT BATTLE SESSION ID !!!
player_id	string	Player id.

DisconnectP2PPlayerBattleSessionParams

/// namespace: Pgos.Client
struct DisconnectP2PPlayerBattleSessionParams

field	type	description
battle_session_id	string	The id of a P2P battle session
player_battle_session_id	string	The id of player session in the battle, !!! NOT BATTLE SESSION ID !!!
player_id	string	Keep it empty if do not need PGOS to validate it.

RemoveP2PPlayerBattleSessionParams

/// namespace: Pgos.Client
struct RemoveP2PPlayerBattleSessionParams

field	type	description
battle_session_id	string	The id of a P2P battle session
player_battle_session_id	string	The id of player session in the battle, !!! NOT BATTLE SESSION ID !!!
player_id	string	Keep it empty if do not need PGOS to validate it.

DescribeP2PPlayerBattleSessionsParams

Request info to describe player battle sessions

/// namespace: Pgos.Client
struct DescribeP2PPlayerBattleSessionsParams

field	type	description
battle_session_id	string	The P2P battle session id.
player_battle_session_id	string	The id of player session in the battle, !!! NOT BATTLE SESSION ID !!! Leave this parameter blank to iterate through all players in the battle session.
offset	UInt32	The next token
count	UInt32	The limit of the player battle sessions request.

DescribeP2PPlayerBattleSessionsResult

Information about the players in the battle session.

/// namespace: Pgos.Client
struct DescribeP2PPlayerBattleSessionsResult

field	type	description
next_offset	UInt32	The next offset.
has_more	bool	If has more players.
total_num	UInt32	None-completed players count in the battle session.
player_battle_sessions	List<P2PPlayerBattleSession>	A list of player battle sessions. Empty if there's no more sessions.

DescribeP2PBattleSessionsResult

/// namespace: Pgos.Client
struct DescribeP2PBattleSessionsResult

field	type	description
battle_sessions	List<P2PBattleSession>	The battle sesions that a player is participating in.

TerminateP2PPlayerBattleSessionParams

/// namespace: Pgos.Client
struct TerminateP2PPlayerBattleSessionParams

field	type	description
battle_session_id	string	The battle session id
player_battle_session_id	string	The player battle session id, !!! NOT BATTLE SESSION ID !!!

ReportHostHealthParams

/// namespace: Pgos.Client
struct ReportHostHealthParams

field	type	description
battle_session_id	string	The battle session id
player_battle_session_id	string	The player battle session id of reporter
host_player_id	string	Host player id
is_host_healthy	bool	Is the current client considering the host healthy or not

StartP2PBattleSessionEvt

/// namespace: Pgos.Client
struct StartP2PBattleSessionEvt

field	type	description
battle_session	P2PBattleSession	The battle session.
battle_source_data	BattleSourceData	Creation source data of a battle session, contains information about the source type of the battle and player information filled in by the battle creator.

P2PBattleSessionTerminateEvt

/// namespace: Pgos.Client
struct P2PBattleSessionTerminateEvt

field	type	description
battle_session_id	string	The battle session id
termination_time	Int64	PGOS will forcefully terminate the session after waiting this time.

P2PPlayerBattleSessionsTerminatedEvt

This event is called periodically to notify game DS of those player battle sessions that have been terminated from client side.

/// namespace: Pgos.Client
struct P2PPlayerBattleSessionsTerminatedEvt

field	type	description
battle_session_id	string	The battle session id.
player_battle_session_id	string	The player battle session id that have been terminated.

P2PBattleSessionUpdatedEvt

/// namespace: Pgos.Client
struct P2PBattleSessionUpdatedEvt

field	type	description
battle_session	P2PBattleSession	The updated battle session details.

P2PConnectParams

/// namespace: Pgos.Client
struct P2PConnectParams

field	type	description
peer_player_id	string	The player id.
connection_type	P2PConnectionType	The connection type to used. If not specified, PGOS will try to connect via p2p and then via relay.
token	string	The token to be used for authentication by the game client.
response_timeout	UInt32	The number of milliseconds that the local player waits for a response from the remote player

P2PConnectResult

/// namespace: Pgos.Client
struct P2PConnectResult

field	type	description
peer_player_id	string	The player id.
connection_type	P2PConnectionType	The connection type to used.
connection_id	string	A unique id that represents a A->B connection.

P2PConnectRequestEvt

Event result of receiving a p2p connection request.

/// namespace: Pgos.Client
struct P2PConnectRequestEvt

field	type	description
peer_player_id	string	The player id of the player who sent the request.
connection_id	string	The connection id of the connection.
token	string	The token to be used for authentication by the game client.

P2PMessageEvt

Event result of receiving a p2p message.

/// namespace: Pgos.Client
struct P2PMessageEvt

field	type	description
peer_player_id	string	The player id of the player who sent the message.
connection_id	string	The connection id of the connection.
message	byte[]	The message.

P2PConnectionClosedEvt

Event result when the p2p connection has been closed.

/// namespace: Pgos.Client
struct P2PConnectionClosedEvt

field	type	description
peer_player_id	string	The player id of the player you connect to.
connection_id	string	The connection id of the connection.
reason	PgosResult	The reason of the connection close. Should be ok if the connection is closed by yourself.

DetectNatTypeResult

/// namespace: Pgos.Client
struct DetectNatTypeResult

field	type	description
nat_type	NatType	The detected nat type.

P2PConnectionInfo

The information of P2P connection.

/// namespace: Pgos.Client
struct P2PConnectionInfo

field	type	description
peer_player_id	string	The player id of the player you connect to.
peer_nat_type	NatType	The nat type of the peer player.
connection_id	string	The connection id of the connection.
connection_type	P2PConnectionType	The connection type to used.
is_connected	bool	Whether the connection is connected.
is_initiator	bool	Whether the connection is initiated by you.
rtt	int	The RTT of the connection. -1 if not connected.
srtt	int	The smoothed RTT of the connection. -1 if not connected.
loss_rate	float	The packet loss rate of the connection. -1 if not connected.

SendP2PMessageParams

/// namespace: Pgos.Client
struct SendP2PMessageParams

field	type	description
connection_id	string	The connection id of the connection.
message	byte[]	The message to be sent.

TerminateP2PBattleSessionParams

/// namespace: Pgos.Client
struct TerminateP2PBattleSessionParams

field	type	description
battle_session_id	string	P2P battle session id.

IntoLoginQueueEvt

Event result when the player is placed into the login queue.

/// namespace: Pgos.Client
struct IntoLoginQueueEvt

field	type	description
queue_position	UInt32	The queue position of the player.
estimated_wait_time	UInt32	The estimated wait time of the player in seconds.

LoginQueueUpdatedEvt

Event result when the login queue status is updated.

/// namespace: Pgos.Client
struct LoginQueueUpdatedEvt : IntoLoginQueueEvt

parent: IntoLoginQueueEvt

GetInventoryWithFilterParams

Get inventory with filter params.

/// namespace: Pgos.Client
struct GetInventoryWithFilterParams

field	type	description
item_types	List<InGameItemType>	Item types to get
item_tags	List<TagDataFilter>	Item tags to get
item_instance_tags	List<TagDataFilter>	Item instance tags to get
unique	BooleanFilter	Filter by unique item
stackable	BooleanFilter	Filter by stackable item
consumable	BooleanFilter	Filter by consumable item

GetMutualFriendsCountParams

Get mutual friends count params.

/// namespace: Pgos.Client
struct GetMutualFriendsCountParams

field	type	description
player_ids	List<string>	The player ids to get mutual friends count with

GetMutualFriendsCountResult

Get mutual friends count result.

/// namespace: Pgos.Client
struct GetMutualFriendsCountResult

field	type	description
mutual_friends_count	Dictionary<string, UInt32>	The mutual friends count of each target player.

PotentialFriendInfo

Basic player information of a potential friend

/// namespace: Pgos.Client
struct PotentialFriendInfo : PlayerSearchInfo

parent: PlayerSearchInfo

field	type	description
mutual_friend_count	UInt32	The number of mutual friends between this player and the target player.

GetPotentialFriendsResult

The result of [GetPotentialFriends]

/// namespace: Pgos.Client
struct GetPotentialFriendsResult

field	type	description
info_list	List<PotentialFriendInfo>	A list of potential friends information
has_more	bool	Whether there is more friends or not
next_offset	UInt32	The starting offset for the next query

LatencyTestRoundCompletedEvt

Event details when a latency test round is completed.]

/// namespace: Pgos.Client
struct LatencyTestRoundCompletedEvt

field	type	description
round_idx	UInt32	The index of the test round, specifying which round this is (starting from 0).
data	DSHostingLatencies	The latencies from the client to the DS hosting data centers.