LaunchBoxContributors
On this page

GameMediaRequest14.1

Class in Unbroken.LaunchBox.Plugins.Components.GameData

C#
public sealed class GameMediaRequest
Requests media for a batch of source-local game IDs.

Remarks

Media types are the public LaunchBox image and video type names or source-documented type names. Null requests every media type the source offers; a selection is never empty.

Constructors

GameMediaRequest

C#
public GameMediaRequest(
    IReadOnlyCollection<string> gameIds,
    IReadOnlyCollection<string>? mediaTypes
)
Creates a request.
gameIds
Source-local game IDs.
mediaTypes
Requested media types, or null for all. An empty collection is rejected.

Properties

  • AttemptNumberGets or initializes the one-based attempt for this enrichment request. Waiting in the host queue does not advance it.
  • GameIdsGets the requested game IDs.
  • MediaTypesGets the requested media types, or null for all. A selection is never empty.
  • RegionGets or initializes the region of the requested games, as a comma-separated list when a game spans regions.
  • RegionPrioritiesGets or initializes the user's region preference order.

AttemptNumber

C#
public int AttemptNumber { get; init; }
Gets or initializes the one-based attempt for this enrichment request. Waiting in the host queue does not advance it.

GameIds

C#
public IReadOnlyCollection<string> GameIds { get; }
Gets the requested game IDs.

MediaTypes

C#
public IReadOnlyCollection<string>? MediaTypes { get; }
Gets the requested media types, or null for all. A selection is never empty.

Region

C#
public string? Region { get; init; }
Gets or initializes the region of the requested games, as a comma-separated list when a game spans regions.

Remarks

A source may use it to limit or order region-specific candidates. LaunchBox still applies its own region selection to the returned candidates.

RegionPriorities

C#
public IReadOnlyCollection<string> RegionPriorities { get; init; }
Gets or initializes the user's region preference order.