LaunchBoxContributors
On this page

PlayActivitySourceDescriptor14.1

Class in Unbroken.LaunchBox.Plugins.Components.Activity

C#
public sealed class PlayActivitySourceDescriptor
Describes a logical source independently of the package implementing it.

Constructors

PlayActivitySourceDescriptor

C#
public PlayActivitySourceDescriptor(string sourceId, PluginText displayName)
Creates a source descriptor.
sourceId
Stable lowercase ID of at most 128 ASCII letters, digits, dots, underscores or hyphens, starting with a letter or digit.
displayName
Plugin-owned translatable name.

Properties

  • DisplayNameGets the translatable name.
  • GameIdNamespaceGets or initializes the external-ID namespace whose values are source-local game IDs.
  • IconResourceIdGets or initializes an optional package image resource ID.
  • MaximumBatchSizeGets or initializes a positive batch limit; the host may request smaller batches.
  • SourceIdGets the implementation-independent source ID.

DisplayName

C#
public PluginText DisplayName { get; }
Gets the translatable name.

GameIdNamespace

C#
public string? GameIdNamespace { get; init; }
Gets or initializes the external-ID namespace whose values are source-local game IDs.

Remarks

For example, storefront.steam or gamesdb. Values in PlayActivityRequest.ItemIds come from this namespace when it is declared. Omission requires optional Components.GameData.IGameMatchCapability matching. Matching never assigns storefront ownership; ambiguous matches are skipped.

IconResourceId

C#
public string? IconResourceId { get; init; }
Gets or initializes an optional package image resource ID.

MaximumBatchSize

C#
public int MaximumBatchSize { get; init; }
Gets or initializes a positive batch limit; the host may request smaller batches.

SourceId

C#
public string SourceId { get; }
Gets the implementation-independent source ID.