Party

API References for Party Service

Explore the list of API functions available in TypeScript for party service, including detailed descriptions and usage examples.

To use service functions, first ensure that the service is activated before. You can see services by opening "Service Hub" From the game's dashboard header.

Find Parties​

Retrieves a list of parties based on the specified parameters.

DynamicPixels.Services.Party.GetParties(input: T): Promise<Party[]>

Create New Party​

Creates a new party based on the specified parameters.

DynamicPixels.Services.Party.CreateParty(input: T): Promise<Party>

Get Subscribed parties​

Retrieves a list of parties the user has subscribed to.

DynamicPixels.Services.Party.GetLeaderboards(): Promise<Leaderboard[]>

Join To Party​

Joins the user to a specified party.

DynamicPixels.Services.Party.JoinToParty(input: T);

Leave Party​

Removes a user from a specified party.

DynamicPixels.Services.Party.LeaveParty(input: T);

Get Party By ID​

Retrieves a party by its unique identifier.

DynamicPixels.Services.Party.GetPartyById(input: T);

Edit Party​

Edits the details of a specified party.

DynamicPixels.Services.Party.EditParty(input: T);

Get Party Members​

Retrieves a list of members in a specified party.

DynamicPixels.Services.Party.GetPartyMembers(input: T);

Get Party Membership Requests​

Retrieves a list of members waiting for approval to join a specified party.

DynamicPixels.Services.Party.GetPartyWaitingMembers(input: T);

Accept Join Request​

Accepts a member's request to join a specified party.

DynamicPixels.Services.Party.AcceptJoining(input: T);

Reject Join Request​

Rejects a member's request to join a specified party.

DynamicPixels.Services.Party.RejectJoining(input: T);