Method LobbyThirdPartyJoinHandle
LobbyThirdPartyJoinHandle(String, String, String, String)
Gets a third-party join handle for a lobby.
Declaration
public System.Threading.Tasks.Task<Den.Dev.Grunt.Models.HaloApiResultContainer<Den.Dev.Grunt.Models.HaloInfinite.LobbyJoinHandle,Den.Dev.Grunt.Models.RawResponseContainer>> LobbyThirdPartyJoinHandle (string lobbyId, string player, string handleAudience, string handlePlatform);Parameters
| Type | Name | Description |
|---|---|---|
| System.String | lobbyId | Unique lobby ID. |
| System.String | player | Player ID in the format of "xuid(XUID_VALUE)". |
| System.String | handleAudience | Audience for the join handle. Example value is "Friends". |
| System.String | handlePlatform | Platform for the join handle. Example value is "Discord". |
Returns
| Type | Description |
|---|---|
| System.Threading.Tasks.Task<HaloApiResultContainer<LobbyJoinHandle,RawResponseContainer>> | An instance of LobbyJoinHandle if the request is successful. Otherwise, returns null. |
Remarks
It seems that this request requires a more "broad access" Spartan token that is generated by the game, and is not open to third-party apps. Additional investigation is required.
Examples
Here is an example response from the API, as snapshotted on 7/10/2022:
{
"JoinHandle": "thirdpartyhandle(l-GUID_a-Friends_s-GUIDa_i-2533274837773602)"
}