mpsd

type ActivityHandle struct {

	// CreateTime is the time at which the activity handle was created.
	CreateTime time.Time `json:"createTime"`

	// CustomProperties contains title-defined metadata associated with the
	// multiplayer session.
	//
	// The format and semantics of this field are specific to the title.
	CustomProperties json.RawMessage `json:"customProperties"`

	// GameTypes is currently unknown and unclear how it is used in retail games.
	GameTypes json.RawMessage `json:"gameTypes"`

	// ID uniquely identifies the activity handle.
	ID uuid.UUID `json:"id"`

	// InviteProtocol specifies the protocol used to invite users to the
	// multiplayer session.
	InviteProtocol string `json:"inviteProtocol"`

	// RelatedInfo contains additional state and metadata associated with
	// the referenced multiplayer session.
	RelatedInfo *ActivityHandleRelatedInfo `json:"relatedInfo"`

	// TitleID is the title ID associated with the multiplayer session.
	//
	// This value may differ from the title of the authenticated client,
	// as a single service configuration may be shared across multiple titles.
	TitleID string `json:"titleId"`

	// OwnerXUID is the XUID of the user who created the multiplayer session.
	OwnerXUID string `json:"ownerXuid"`
	// contains filtered or unexported fields
}

type ActivityHandleRelatedInfo struct {
	// Closed indicates whether the multiplayer session is closed to new joins.
	Closed bool `json:"closed"`

	// InviteProtocol specifies the protocol used when inviting the current
	// authenticated user.
	InviteProtocol string `json:"inviteProtocol"`

	// JoinRestriction specifies the restriction applied when joining
	// the multiplayer session.
	JoinRestriction string `json:"joinRestriction"`

	// MaxMembersCount is the maximum number of members allowed in the
	// multiplayer session.
	MaxMembersCount uint32 `json:"maxMembersCount"`

	// PostedTime is the time at which the multiplayer session was created.
	PostedTime time.Time `json:"postedTime"`

	// Visibility specifies the visibility of the multiplayer session.
	Visibility string `json:"visibility"`
}

type Client struct {
	// contains filtered or unexported fields
}

type GameType struct {
	// TitleID is the title ID associated with the game type.
	TitleID string `json:"titleId"`

	// PackageFamilyName is the package family name associated with the game type.
	PackageFamilyName string `json:"pfn"`

	// BoundPackageFamilyNames lists other package family names associated with the game type.
	BoundPackageFamilyNames []string `json:"boundPfns"`
}

type Handler interface {
	// HandleSessionChange is called when a change is made to a remote session
	// in the directory. This includes events such as a member joining the
	// session or a custom property being updated. For the full list of changes
	// that trigger this handler, refer to the ChangeType* constants defined in
	// this package.
	HandleSessionChange(session *Session)
}

type InviteAttributes struct {
	// TitleID is the title ID associated with the invite handle.
	// For invitation requests, it must be the title authenticated
	// by the XSTS token.
	TitleID string `json:"titleId"`

	// ContextStringID is the optional ID used to activate the
	// invite handle. It is unknown how it is used or how it is
	// generated during invitation.
	ContextStringID string `json:"contextString,omitempty"`

	// Context is the optional context associated with the invite
	// handle, encapsulated in a string. The format and semantics
	// are specific to the title.
	Context string `json:"context,omitempty"`
}

type InviteHandle struct {

	// ID is the unique ID associated with the invite handle.
	ID uuid.UUID `json:"id"`

	// GameTypes is a map whose keys are platform name such as "uwp-desktop" or
	// "android", and whose values are structs that describes a single title
	// associated with the invite handle.
	GameTypes map[string]GameType `json:"gameTypes"`

	// SenderXUID is the XUID of the user that has sent the invite.
	SenderXUID string `json:"senderXuid"`

	// Expiration indicates the time that this invite handle will expire.
	Expiration time.Time `json:"expiration"`

	// InviteProtocol is the protocol used for invitation.
	// It is unknown how it is used. It is always "game".
	// Supported values might also include "party".
	InviteProtocol string `json:"inviteProtocol"`
	// contains filtered or unexported fields
}

type JoinConfig struct {
	// CustomMemberConstants holds immutable constants associated with the caller
	// as a member of the session. These are set when joining and cannot be
	// changed for the lifetime of the membership.
	//
	// The format and semantics of this field are defined by the title.
	CustomMemberConstants json.RawMessage

	// CustomMemberProperties holds mutable properties associated with the caller
	// as a member of the session. Unlike [JoinConfig.CustomMemberConstants],
	// these can be updated at any time during the session via
	// [Session.SetMemberCustomProperties].
	//
	// The format and semantics of this field are defined by the title.
	CustomMemberProperties json.RawMessage
}

type MemberConstants struct {
	// System contains system-defined constants for the member.
	System *MemberConstantsSystem `json:"system,omitempty"`

	// Custom contains title-defined constants for the member.
	//
	// The format and semantics of this field are specific to the title.
	Custom json.RawMessage `json:"custom,omitempty"`
}

type MemberConstantsSystem struct {
	// XUID is the user ID of the member.
	XUID string `json:"xuid,omitempty"`

	// Initialize indicates whether QoS initialization should be performed for
	// the member when joining the session.
	Initialize bool `json:"initialize,omitempty"`
}

type MemberDescription struct {
	// Constants contains immutable, system-defined values
	// associated with the member.
	//
	// Fields in this struct cannot be modified after the member has joined or
	// published the multiplayer session.
	Constants *MemberConstants `json:"constants,omitempty"`

	// Properties contains mutable properties associated with the member.
	//
	// These properties may be updated at any time, but only by the member
	// to whom they belong.
	Properties *MemberProperties `json:"properties,omitempty"`
}

type MemberProperties struct {
	// System contains system-defined properties for the member.
	System *MemberPropertiesSystem `json:"system,omitempty"`

	// Custom contains title-defined properties for the member.
	//
	// The format and semantics of this field are specific to the title.
	Custom json.RawMessage `json:"custom,omitempty"`
}

type MemberPropertiesSystem struct {
	// Active indicates whether the member is active in the multiplayer session.
	//
	// This value is typically true for most members. Joining or publishing a
	// multiplayer session requires this field to be set to true.
	Active bool `json:"active,omitempty"`

	// Ready indicates whether the member is ready for gameplay or matchmaking.
	//
	// This field is used by titles that support a ready-state concept prior
	// to matchmaking or session start.
	Ready bool `json:"ready,omitempty"`

	// Connection identifies the RTA subscription associated with this member.
	//
	// The value must match the ID specified in the corresponding
	// [rta.Subscription]. Once the member has joined or published the session,
	// notifications for the session will be delivered over this connection,
	// subject to the scope specified in [MemberPropertiesSystem.Subscription].
	Connection uuid.UUID `json:"connection"`

	// Subscription specifies which portions of the multiplayer session generate
	// notifications over the associated RTA subscription.
	Subscription *MemberPropertiesSystemSubscription `json:"subscription,omitempty"`

	// SecureDeviceAddress is a legacy identifier used by UWP and Xbox One titles.
	//
	// The value is base64-encoded and contains device and connection information
	// for session hosting. This field is not used by most modern games.
	SecureDeviceAddress []byte `json:"secureDeviceAddress,omitempty"`
}

type MemberPropertiesSystemSubscription struct {
	// ID uniquely identifies the relationship between the RTA subscription
	// and the multiplayer session.
	//
	// The value must be an uppercase UUID (GUID) and is used exclusively
	// for this field. It must not be confused with ID, which
	// uses a standard (lowercase) UUID format.
	ID string `json:"id"`

	// ChangeTypes specifies the types of session changes that generate
	// notifications for the member over the associated RTA subscription.
	ChangeTypes []string `json:"changeTypes,omitempty"`
}

type NopHandler struct{}

type PublishConfig struct {
	// CustomProperties holds mutable properties to be associated with the multiplayer session
	// when publishing.
	//
	// The format and semantics of this field are defined by the title. It is
	// commonly used to expose session metadata such as display names or
	// server details.
	CustomProperties json.RawMessage
	// CustomConstants holds immutable constants to be associated with the multiplayer session
	// when publishing. Once published, it cannot be changed during for the lifetime of the session.
	//
	// The format and semantics of this field are defined by the title.
	CustomConstants json.RawMessage

	// CustomMemberProperties holds mutable properties associated with the host.
	// Unlike [JoinConfig.CustomMemberConstants], these can be updated at any time
	// during the session via [Session.SetMemberCustomProperties].
	//
	// The format and semantics of this field are defined by the title.
	CustomMemberProperties json.RawMessage
	// CustomMemberConstants holds immutable constants associated with the host.
	// These are set when publishing and cannot be changed for the lifetime of the ownership.
	//
	// The format and semantics of this field are defined by the title.
	CustomMemberConstants json.RawMessage

	// JoinRestriction and ReadRestriction specify who may join or read an open session.
	// If JoinRestriction or ReadRestriction are empty, it will default to [SessionRestrictionFollowed].
	JoinRestriction, ReadRestriction string
}

type Session struct {
	// contains filtered or unexported fields
}

type SessionConstants struct {
	// System contains system-defined constants for the session.
	//
	// Fields defined by a session template cannot be overridden.
	System *SessionConstantsSystem `json:"system,omitempty"`

	// Custom contains title-defined constants for the session.
	Custom json.RawMessage `json:"custom,omitempty"`
}

type SessionConstantsSystem struct {
	// MaxMembersCount is the maximum number of members allowed in the session.
	MaxMembersCount uint32 `json:"maxMembersCount,omitempty"`

	// Capabilities defines the capabilities supported by the session.
	//
	// The format and semantics of this field are currently undefined.
	Capabilities json.RawMessage `json:"capabilities,omitempty"`

	// Visibility specifies the visibility level of the session.
	Visibility string `json:"visibility,omitempty"`

	// Initiators contains the XUIDs of users who initiated the session.
	Initiators []string `json:"initiators,omitempty"`

	// ReservedRemovalTimeout is the maximum duration, in milliseconds, that a
	// reserved member may take to join the session before the reservation
	// is removed.
	ReservedRemovalTimeout uint64 `json:"reservedRemovalTimeout,omitempty"`

	// InactiveRemovalTimeout is the maximum duration, in milliseconds, that an
	// inactive member may remain inactive before being removed from the session.
	InactiveRemovalTimeout uint64 `json:"inactiveRemovalTimeout,omitempty"`

	// ReadyRemovalTimeout is the maximum duration, in milliseconds, that a
	// ready member may take to become active before transitioning to inactive.
	ReadyRemovalTimeout uint64 `json:"readyRemovalTimeout,omitempty"`

	// SessionEmptyTimeout is the maximum duration, in milliseconds, that a
	// session may remain empty before being deleted.
	SessionEmptyTimeout uint64 `json:"sessionEmptyTimeout,omitempty"`

	// Metrics is currently unknown, seems to be used for QoS measurement.
	Metrics json.RawMessage `json:"metrics,omitempty"`

	// MemberInitialization indicates that members are expected to perform
	// initialization after session creation.
	//
	// Initialization stages and timeouts are tracked automatically, including
	// initial Quality of Service (QoS) measurements when metrics are specified.
	MemberInitialization json.RawMessage `json:"memberInitialization,omitempty"`

	// PeerToPeerRequirements defines QoS requirements for peer-to-peer
	// connections between session members.
	PeerToPeerRequirements json.RawMessage `json:"peerToPeerRequirements,omitempty"`

	// PeerToHostRequirements defines QoS requirements for connections between
	// host candidates and session members.
	PeerToHostRequirements json.RawMessage `json:"peerToHostRequirements,omitempty"`

	// MeasurementServerAddresses contains the server endpoints to be evaluated
	// for QoS measurements.
	MeasurementServerAddresses json.RawMessage `json:"measurementServerAddresses,omitempty"`

	// CloudComputePackage contains Cloud Compute package constants for the session.
	CloudComputePackage json.RawMessage `json:"cloudComputePackage,omitempty"`
}

type SessionDescription struct {
	// Constants contains immutable values associated with the multiplayer session.
	//
	// Fields in this struct cannot be modified after the session is published.
	Constants *SessionConstants `json:"constants,omitempty"`

	// RoleTypes contains role definitions associated with the session.
	//
	// The format and semantics of this field are currently undefined.
	RoleTypes json.RawMessage `json:"roleTypes,omitempty"`

	// Properties contains mutable properties associated with the multiplayer session.
	//
	// These properties may be updated at any time by the owner of the session.
	Properties *SessionProperties `json:"properties,omitempty"`

	// Members is a map whose keys are member identifiers (labels) and whose values
	// are the corresponding member descriptions.
	//
	// In addition to concrete numerical IDs for member, the reserved alias "me" may
	// be used as a key to refer to the member associated with the currently authenticated user.
	//
	// A member may modify only their own MemberDescription. Use of "me" is
	// equivalent to specifying the caller's own member ID.
	Members map[string]*MemberDescription `json:"members,omitempty"`
}

type SessionProperties struct {
	// System contains system-defined properties for the session.
	System *SessionPropertiesSystem `json:"system,omitempty"`

	// Custom contains title-defined properties for the session.
	//
	// The format and semantics of this field are defined by the title. It is
	// commonly used to expose session metadata such as display names or
	// server details.
	Custom json.RawMessage `json:"custom,omitempty"`
}

type SessionPropertiesSystem struct {
	// Keywords is an optional list of keywords associated with the session.
	Keywords []string `json:"keywords,omitempty"`

	// Turn contains the member IDs that currently have the turn in a
	// turn-based session. The usage of this field is currently unknown.
	Turn []uint32 `json:"turn,omitempty"`

	// JoinRestriction specifies who may join an open session.
	//
	// This field has no effect on reservations and does not apply to
	// private or visible sessions.
	JoinRestriction string `json:"joinRestriction,omitempty"`

	// ReadRestriction specifies who may read an open session before joining.
	//
	// This field has no effect on reservations and does not apply to
	// private or visible sessions.
	ReadRestriction string `json:"readRestriction,omitempty"`

	// Closed indicates whether the session is joinable.
	//
	// When true, the session cannot be joined regardless of visibility,
	// join restrictions, or available capacity. This field does not
	// affect reservations. The default value is false.
	Closed bool `json:"closed"`

	// Locked indicates whether session membership is locked.
	//
	// When true, members who leave may rejoin the session, but no new
	// members may take their place. The default value is false.
	Locked bool `json:"locked,omitempty"`

	// Matchmaking is currently unknown, seems to be used for QoS measurement.
	Matchmaking json.RawMessage `json:"matchmaking,omitempty"`

	// MatchmakingResubmit indicates whether matchmaking should be resubmitted.
	//
	// When true, a previously found match is considered invalid and must be
	// resubmitted. When false, the match is considered successful and the
	// matchmaking service may release the session.
	MatchmakingResubmit bool `json:"matchmakingResubmit,omitempty"`

	// InitializationSucceeded indicates whether session initialization
	// completed successfully.
	InitializationSucceeded bool `json:"initializationSucceeded,omitempty"`

	// Host identifies the device token of the session host.
	Host string `json:"host,omitempty"`

	// ServerConnectionStringCandidates contains an ordered list of
	// case-insensitive connection strings that may be used to connect
	// to a game server.
	//
	// Titles typically use the first entry, but may apply custom selection
	// logic (for example, based on load).
	ServerConnectionStringCandidates json.RawMessage `json:"serverConnectionStringCandidates,omitempty"`
}

type SessionReference struct {
	// ServiceConfigID is the Xbox Live service configuration ID (SCID)
	// associated with the title.
	//
	// A single service configuration may be shared by multiple titles
	// and platforms for the same game.
	ServiceConfigID uuid.UUID `json:"scid,omitempty"`

	// TemplateName is the name of the session template used to create
	// the session.
	//
	// This value may be used to retrieve the template definition via
	// API.TemplateByName.
	TemplateName string `json:"templateName,omitempty"`

	// Name is the unique identifier of the session.
	//
	// The value is an uppercase UUID (GUID) that uniquely identifies
	// the session within the service configuration.
	Name string `json:"name,omitempty"`
}