IPlayerProfileCapability14.1
Interface in Unbroken.LaunchBox.Plugins.Capabilities.Profiles
public interface IPlayerProfileCapability : IPluginComponentMetadataSupplies player profiles from a storefront, achievement service, or other managed component.
Remarks
Implement on the existing component; no separate activation or achievement capability is required. Use the shared connection capability to signal account changes. Profile reads must not initiate sign-in or change the configured account.Inheritance and interfaces
Properties
ProfileSourceIdGets the stable logical profile source ID, independent of the plugin package. Use the same ID as the associated storefront or achievement source where applicable.
ProfileSourceId
string ProfileSourceId { get; }Gets the stable logical profile source ID, independent of the plugin package. Use the same ID as the associated storefront or achievement source where applicable.
Methods
GetCurrentAccountIdAsyncGets the currently selected service account ID, independent of connection handles.GetProfileAsyncRetrieves a profile using the configured connection.
GetCurrentAccountIdAsync
Task<string?> GetCurrentAccountIdAsync(CancellationToken cancellationToken)Gets the currently selected service account ID, independent of connection handles.
cancellationToken- Cancels account resolution.
Returns
The selected player ID, or null when no player is selected. Throw when the account cannot be determined; failure must not be reported as logout.GetProfileAsync
Task<PlayerProfile?> GetProfileAsync(
string accountId,
CancellationToken cancellationToken
)Retrieves a profile using the configured connection.
accountId- The requested service account ID.
cancellationToken- Cancels retrieval.