Class MatchRequests.RetrievedMatchDetail
Retrieved match data when using MatchRequests.GetMatchDetailRequest
Namespace: Unity.PSN.PS5.Matches
Syntax
public class RetrievedMatchDetailProperties
ActivityId
The match Activity Id
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
Whether the match is a team match
Declaration
public MatchGroupType GroupType { get; }Property Value
| Type | Description |
|---|---|
| MatchGroupType |
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 |
MatchId
The 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; }Property Value
| Type | Description |
|---|---|
| List<MatchPlayer> |
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 |
SetFlags
The flags represent which parts of the data have been returned
Declaration
public MatchRequests.RetrievedMatchDetail.ParamTypes SetFlags { get; }Property Value
| Type | Description |
|---|---|
| MatchRequests.RetrievedMatchDetail.ParamTypes |
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
Declaration
public List<MatchTeam> Teams { get; }Property Value
| Type | Description |
|---|---|
| List<MatchTeam> |
ZoneId
ID of the zone where the match takes place
Declaration
public string ZoneId { get; }Property Value
| Type | Description |
|---|---|
| String |
Methods
IsParamFlagSet(MatchRequests.RetrievedMatchDetail.ParamTypes, MatchRequests.RetrievedMatchDetail.ParamTypes)
Test is a flag is set
Declaration
public static bool IsParamFlagSet(MatchRequests.RetrievedMatchDetail.ParamTypes flags, MatchRequests.RetrievedMatchDetail.ParamTypes flagToCheck)Parameters
| Type | Name | Description |
|---|---|---|
| MatchRequests.RetrievedMatchDetail.ParamTypes | flags | The match flags to check |
| MatchRequests.RetrievedMatchDetail.ParamTypes | flagToCheck | The match flag to test |
Returns
| Type | Description |
|---|---|
| Boolean | Returns true if the flag to check is set |