Class Match
Match instance
Namespace: Unity.PSN.PS5.Matches
Syntax
public class MatchProperties
ActivityId
Activity relating to a match
Declaration
public string ActivityId { get; }Property Value
| Type | Description |
|---|---|
| String |
CompetitionType
Whether a match is a competitive match
Declaration
public MatchCompetitionType CompetitionType { get; }Property Value
| Type | Description |
|---|---|
| MatchCompetitionType |
EndTimeStamp
Declaration
public DateTime EndTimeStamp { get; }Property Value
| Type | Description |
|---|---|
| DateTime |
ExpirationTime
Grace period until a match is canceled
Declaration
public int ExpirationTime { get; }Property Value
| Type | Description |
|---|---|
| Int32 |
Remarks
Starting when the status of the match becomes either Waiting or OnHold, if neither the Status nor ExpirationTime are updated by the period specified for ExpirationTime, the match is automatically canceled. Currently, matches are not automatically canceled. It is anticipated that the value of expirationTime will be used in the future.
GroupType
The match is a team match or other
Declaration
public MatchGroupType GroupType { get; }Property Value
| Type | Description |
|---|---|
| MatchGroupType |
IsActive
Has the player session been created and is currently valid
Declaration
public bool IsActive { get; }Property Value
| Type | Description |
|---|---|
| Boolean |
LastPausedTimeStamp
Date and time the match was last temporarily paused (the date and time status last became OnHold)
Declaration
public DateTime LastPausedTimeStamp { get; }Property Value
| Type | Description |
|---|---|
| DateTime |
MatchesList
Return a copy of the list of active matches
Declaration
public static List<Match> MatchesList { get; }Property Value
| Type | Description |
|---|---|
| List<Match> |
MatchId
PSN Match id
Declaration
public string MatchId { get; }Property Value
| Type | Description |
|---|---|
| String |
Players
List of players participating in the match
Declaration
public List<MatchPlayer> Players { get; set; }Property Value
| Type | Description |
|---|---|
| List<MatchPlayer> |
Remarks
Each PlayerId in the request must be unique. If a player's PlayerType is PSNPlayer, an AccountId is required (its existence will be checked for). In all other cases, specifying an accountId results in an error. More than one PlayerId can be linked to a single AccountId.
Results
Match results
Declaration
public MatchResults Results { get; }Property Value
| Type | Description |
|---|---|
| MatchResults |
ResultsType
Whether there are scores in the match results
Declaration
public MatchResultsType ResultsType { get; }Property Value
| Type | Description |
|---|---|
| MatchResultsType |
ServiceLabel
NP service label
Declaration
public int ServiceLabel { get; set; }Property Value
| Type | Description |
|---|---|
| Int32 |
StartTimeStamp
Date and time the match was started (the date and time status first became Playing)
Declaration
public DateTime StartTimeStamp { get; }Property Value
| Type | Description |
|---|---|
| DateTime |
Stats
Additional stats of a match
Declaration
public MatchStats Stats { get; }Property Value
| Type | Description |
|---|---|
| MatchStats |
Remarks
Only PlayerStats is specified if the match's CompetitionType is Cooperative. Only PlayerStats is specified if the match's CompetitionType is Competitive and GroupType is NonTeamMatch. Only TeamStats is specified if the match's CompetitionType is Competitive and GroupType is TeamMatch.
Status
Match status
Declaration
public MatchStatus Status { get; }Property Value
| Type | Description |
|---|---|
| MatchStatus |
Teams
List of teams participating in the match If the match's GroupType is NonTeamMatch, this value won't be specified.
Declaration
public List<MatchTeam> Teams { get; set; }Property Value
| Type | Description |
|---|---|
| List<MatchTeam> |
Remarks
Each TeamId within the match must be unique.
ZoneId
ID of the zone where the match takes place
Declaration
public string ZoneId { get; }Property Value
| Type | Description |
|---|---|
| String |
Methods
FindMatchFromAccountId(UInt64)
Find match from an account id.
Declaration
public static Match FindMatchFromAccountId(ulong accountId)Parameters
| Type | Name | Description |
|---|---|---|
| UInt64 | accountId |
Returns
| Type | Description |
|---|---|
| Match |
FindPlayer(String)
Find a player using the player id
Declaration
public MatchPlayer FindPlayer(string playerId)Parameters
| Type | Name | Description |
|---|---|---|
| String | playerId | The player id to find |
Returns
| Type | Description |
|---|---|
| MatchPlayer | The found player or null |
FindPlayer(UInt64)
Find a player using their account id
Declaration
public MatchPlayer FindPlayer(ulong accountId)Parameters
| Type | Name | Description |
|---|---|---|
| UInt64 | accountId | The account id to find |
Returns
| Type | Description |
|---|---|
| MatchPlayer | The found player or null |
FindPlayerSessionFromSessionId(String)
Find a session instance from a session id
Declaration
public static Match FindPlayerSessionFromSessionId(string matchId)Parameters
| Type | Name | Description |
|---|---|---|
| String | matchId | The match id to find |
Returns
| Type | Description |
|---|---|
| Match |
FindTeam(String)
Find a team using the team id
Declaration
public MatchTeam FindTeam(string teamId)Parameters
| Type | Name | Description |
|---|---|---|
| String | teamId | The team id to find |
Returns
| Type | Description |
|---|---|
| MatchTeam | The found team or null |
UpdateDetails(MatchRequests.RetrievedMatchDetail)
Update the match details using the result retrieved about the match
Declaration
public void UpdateDetails(MatchRequests.RetrievedMatchDetail details)Parameters
| Type | Name | Description |
|---|---|---|
| MatchRequests.RetrievedMatchDetail | details | The details returned by calling MatchRequests.GetMatchDetailRequest |