notification

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

type Action struct {
	// Actor is the user associated with this action.
	// It is not necessarily the caller. For game invites, this represents the
	// user who have sent the invite.
	Actor Actor
	// ActionID is the ID assigned to this action.
	ActionID string `json:"ActionId"`
	// Timestamp is the time at which this action was created.
	Timestamp time.Time `json:"ActionTime"`
	// Category is the subscription category of this action's parent notification.
	Category string `json:"SubscriptionCategory"`
	// Type is the subscription type of this action's parent notification.
	Type string `json:"SubscriptionType"`
	// ID is the subscription ID of this action's parent notification.
	ID string `json:"SubscriptionId"`
}

type Actor struct {
	// ClassicGamerTag is the user's display name.
	ClassicGamerTag string `json:"ClassicGamertag"`
	// ModernGamerTag is the base portion of a modern gamertag, excluding
	// the numeric suffix.
	ModernGamerTag string `json:"ModernGamertag"`
	// ModernGamerTagSuffix is the numeric suffix of a modern gamertag,
	// without the hash character.
	ModernGamerTagSuffix string `json:"ModernGamertagSuffix"`
	// UniqueModernGamerTag is the fully qualified modern gamertag in the
	// format "[Actor.ModernGamerTag]#[Actor.ModernGamerTagSuffix]".
	UniqueModernGamerTag string `json:"UniqueModernGamertag"`

	// Name is the name of the actor.
	Name string
	// ID is the unique ID assigned to this actor.
	// When [Actor.Type] is [ActorTypeUser], this is the XUID of the user.
	ID string `json:"Id"`
	// Type indicates the type of the Actor.
	// It is one of the constants below.
	Type int
}

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

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

type GameInvite struct {

	// Options contains options for launching/activating a title with the
	// invitation.
	Options GameInviteOptions `json:"NotificationOptions"`
	// contains filtered or unexported fields
}

type GameInviteAction struct {
	Action

	// LaunchInfo contains information for launching/activating the title with the invite.
	LaunchInfo GameInviteLaunchInfo
}

type GameInviteLaunchInfo struct {
	// HandleID is the ID corresponding to a handle within the
	// Multiplayer Session Directory (MPSD). Callers can use this ID as the second
	// parameter for [github.com/df-mc/go-xsapi/v2/mpsd.Client.Join] to join the multiplayer
	// session from the invitation.
	HandleID uuid.UUID `json:"mpsdHandleId"`
	// ExpirationTime indicates the time at which the handle identified
	// by [GameInviteLaunchInfo.HandleID] will expire.
	ExpirationTime time.Time `json:"expirationTime"`
	// 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]mpsd.GameType `json:"gameTypes"`
}

type GameInviteOptions struct {
	// Location describes the title ta which the invite could be accepted.
	// To accept invitations for a specific title only, filter [Location.ID]
	// by the title ID.
	Location Location
	// Platforms lists the platforms supported by the game.
	Platforms []string
}

type InboxFilter struct {
	// MaxItems specifies the maximum amount of notifications that can
	// be included in the result. When zero, it will be set to 200.
	MaxItems int
	// MaxActions specifies the maximum amount of actions that can be
	// embedded to each notification included in the result. When zero,
	// it wil be set to 5.
	MaxActions int

	// SubscriptionCategories specifies the list of subscription categories
	// that will be populated in the result. If empty, the categories
	// supported in this package are used instead.
	SubscriptionCategories []string
	// SubscriptionTypes specifies the list of subscription types that will
	// be populated in the result. If empty, all subscription types supported
	// in this package are used instead.
	SubscriptionTypes []string
}

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

type Location struct {
	// PackageFamilyName is the package family name of the title.
	// It is only populated when [Location.Type] is [LocationTypeTitle].
	PackageFamilyName string `json:"Pfn"`
	// DisplayImage is the URL used as the thumbnail for the title.
	// It is only populated when [Location.Type] is [LocationTypeTitle].
	DisplayImage string

	// Name is the name of the location.
	Name string
	// ID is the unique ID assigned to this Location.
	// When [Location.Type] is [LocationTypeTitle], this represents the title ID.
	ID string `json:"Id"`
	// Type indicates the type of the location.
	// It is one of the constants below.
	Type int
}

type Notification interface {
	// SubscriptionCategory returns the subscription category of the notification/action.
	// It is one of the constants below.
	SubscriptionCategory() string
	// SubscriptionType returns the subscription type of the notification/action.
	// It is one of the constants below.
	SubscriptionType() string
	// SubscriptionID returns the subscription ID of the notification/action.
	SubscriptionID() string
}

type Unknown struct {
	// Category is the subscription category of the notification.
	Category string `json:"SubscriptionCategory"`
	// Type is the subscription type of the notification.
	Type string `json:"SubscriptionType"`
	// ID is the subscription ID of the notification.
	ID string `json:"SubscriptionId"`

	// Raw is the raw JSON data that were passed to [Unmarshal].
	Raw json.RawMessage `json:"-"`
}