Party

API References for Party Service

Explore the list of API functions available in Unity 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.

var parties = await ServiceHub.Services.Party.GetParties(new GetPartiesParams
{
    Query = "",
    Skip = 0,
    Limit = 0
});

Create New Party​

Creates a new party based on the specified parameters.

var party = await ServiceHub.Services.Party.CreateParty(new CreatePartyParams
{
    Data = new PartyInput
        {
            Name = "",
            Desc = "",
            MaxMemberCount = 0,
            IsPrivate = false,
            Teams = new string[] { },
            Channels = new string[] { },
            Variables = new Dictionary<string, string>()
        }
});

Get Subscribed parties​

Retrieves a list of parties the user has subscribed to.

var parties = await ServiceHub.Services.Party.GetSubscribedParties(new GetSubscribedPartiesParams
{
    Query = "",
    Skip = 0,
    Limit = 0
});

Join To Party​

Joins the user to a specified party.

var partyMemberInfo = await ServiceHub.Services.Party.JoinToParty(new JoinToPartyParams
{
    PartyId = 0,
    Team = "",
    Channels = new string[] { }
});

Leave Party​

Removes a user from a specified party.

await ServiceHub.Services.Party.LeaveParty(new LeavePartyParams
{
    PartyId = 0
});

Get Party By ID​

Retrieves a party by its unique identifier.

    var party = await ServiceHub.Services.Party.GetPartyById(new GetPartyByIdParams
    {
        PartyId = 0
    });

Edit Party​

Edits the details of a specified party.

var party = await ServiceHub.Services.Party.EditParty(new EditPartyParams
{
    PartyId = 0,
    Party = new PartyInput
{
    Name = "",
    Desc = "",
    MaxMemberCount = 0,
    IsPrivate = false,
    Teams = new string[] { },
    Channels = new string[] { },
    Variables = new Dictionary<string, string>()
}
});

Get Party Members​

Retrieves a list of members in a specified party.

var members = await ServiceHub.Services.Party.GetPartyMembers(new GetPartyMembersParams
{
    PartyId = 0,
    Skip = 0,
    Limit = 0
});

Get Party Membership Requests​

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

var waitingMembers = await ServiceHub.Services.Party.GetPartyWaitingMembers(
new GetPartyWaitingMembersParams
{
    PartyId = 0,
    Skip = 0,
    Limit = 0
});

Accept Join Request​

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

var member = await ServiceHub.Services.Party.AcceptJoining(new AcceptJoiningParams
{
    PartyId = 0,
    MembershipId = 0
});

Reject Join Request​

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

var member = await ServiceHub.Services.Party.RejectJoining(new RejectJoiningParams
{
    PartyId = 0,
    MembershipId = 0
});