PartyService
Parties: friends who join games together, with party chat.
On this page
Parties: 2-8 friends who move between games together. The leader's SessionService.Join takes the whole party: it finds a session with room for everyone (the fullest that fits, a friend's session the leader joins, or a new one), holds seats for the others, and tells each member over realtime {"type":"party_follow","partyId","experienceId","sessionId","title"}; their client joins that session. Party chat is the realtime channel party:<pty_...>. Realtime events: {"type":"party","party":{...Party JSON}} to every member on any change; {"type":"party_invite","invite":{...PartyInvite JSON}} to the invitee; {"type":"party_left","partyId"} to someone no longer in it (left, kicked, disbanded). Every method is a POST with a JSON body; see the overview for the protocol, authentication and errors.
Summary#
| Method | Auth | Description |
|---|---|---|
| GetMyParty | Account | The caller's party (an empty Party when they're in none) and their pending invites. |
| CreateParty | Account | Starts a party led by the caller (who must not be in one). |
| InviteToParty | Account | Invites a friend (any member may invite; up to 8 in the party). |
| AcceptPartyInvite | Account | |
| DeclinePartyInvite | Account | |
| LeaveParty | Account | Leaves the caller's party. A leader who leaves hands it to the longest-standing member; the last one out ends it. |
| KickFromParty | None | The leader removes a member. |
| PromotePartyLeader | None | The leader hands leadership to another member. |
Methods#
GetMyParty#
The caller's party (an empty Party when they're in none) and their pending invites.
POST /neo.platform.v1.PartyService/GetMyParty
Content-Type: application/jsonAuth: A signed-in account. Guests are refused.
Request: GetMyPartyRequest. Response: MyParty.
CreateParty#
Starts a party led by the caller (who must not be in one).
POST /neo.platform.v1.PartyService/CreateParty
Content-Type: application/jsonAuth: A signed-in account. Guests are refused.
Request: CreatePartyRequest. Response: Party.
InviteToParty#
Invites a friend (any member may invite; up to 8 in the party).
POST /neo.platform.v1.PartyService/InviteToParty
Content-Type: application/jsonAuth: A signed-in account. Guests are refused.
Request: InviteToPartyRequest. Response: Party.
AcceptPartyInvite#
POST /neo.platform.v1.PartyService/AcceptPartyInvite
Content-Type: application/jsonAuth: A signed-in account. Guests are refused.
Request: PartyRef. Response: Party.
DeclinePartyInvite#
POST /neo.platform.v1.PartyService/DeclinePartyInvite
Content-Type: application/jsonAuth: A signed-in account. Guests are refused.
Request: PartyRef. Response: MyParty.
LeaveParty#
Leaves the caller's party. A leader who leaves hands it to the longest-standing member; the last one out ends it.
POST /neo.platform.v1.PartyService/LeaveParty
Content-Type: application/jsonAuth: A signed-in account. Guests are refused.
Request: LeavePartyRequest. Response: MyParty.
KickFromParty#
The leader removes a member.
POST /neo.platform.v1.PartyService/KickFromParty
Content-Type: application/jsonAuth: None.
Request: PartyMemberRef. Response: Party.
PromotePartyLeader#
The leader hands leadership to another member.
POST /neo.platform.v1.PartyService/PromotePartyLeader
Content-Type: application/jsonAuth: None.
Request: PartyMemberRef. Response: Party.
Types#
CreatePartyRequest#
No fields: send {}.
GetMyPartyRequest#
No fields: send {}.
InviteToPartyRequest#
| Field | Type | Description |
|---|---|---|
userId | string |
LeavePartyRequest#
No fields: send {}.
MyParty#
| Field | Type | Description |
|---|---|---|
party | Party | |
invites | array of PartyInvite |
Party#
| Field | Type | Description |
|---|---|---|
id | string | pty_...; empty when the caller is in no party. |
leader | UserSummary | |
members | array of PartyMember | |
maxMembers | number | |
experienceId | string | The game and session the leader last took the party to. |
experienceTitle | string | |
sessionId | string | |
chatChannel | string | The party's chat channel on the realtime gateway (party:pty_...). |
invited | array of UserSummary | Invites sent and still pending. |
createdAt | string |
PartyInvite#
| Field | Type | Description |
|---|---|---|
partyId | string | |
from | UserSummary | |
leader | UserSummary | |
size | number | |
expiresAt | string |
PartyMember#
| Field | Type | Description |
|---|---|---|
user | UserSummary | |
leader | boolean | |
presence | string | online, in_game, offline (as the member's friends see it) |
experienceId | string | |
joinedAt | string |
PartyMemberRef#
| Field | Type | Description |
|---|---|---|
userId | string |
PartyRef#
| Field | Type | Description |
|---|---|---|
partyId | string |