Interface IHoldsBaggage<TKey>
Manages baggage for the selected keys.
Namespace: Microsoft.XboxStudios.ClientManager
Assembly: ClientManager.Abstractions.dll
Syntax
public interface IHoldsBaggage<TKey>Type Parameters
| Name | Description |
|---|---|
| TKey | The key to use to identify a specific client. |
Methods
View SourceGetAllBaggage<TBaggage>()
Gets the baggage of a specified type from all active clients.
Declaration
IEnumerable<KeyValuePair<TKey, TBaggage>> GetAllBaggage<TBaggage>()Returns
| Type | Description |
|---|---|
| IEnumerable<KeyValuePair<TKey, TBaggage>> | An enumeration of keys and associated baggage. |
Type Parameters
| Name | Description |
|---|---|
| TBaggage | The type of the baggage. |
Exceptions
| Type | Condition |
|---|---|
| BaggageNullException | Thrown if the registered baggage factory returned null. |
| MissingBaggageFactoryException | Thrown if the baggage factory of the requested baggage is not registered. |
GetBaggage<TBaggage>(TKey)
Gets the baggage associated with a key.
Declaration
TBaggage GetBaggage<TBaggage>(TKey key)Parameters
| Type | Name | Description |
|---|---|---|
| TKey | key | The |
Returns
| Type | Description |
|---|---|
| TBaggage | The baggage or null if no connection exists. |
Type Parameters
| Name | Description |
|---|---|
| TBaggage | The type of the baggage. |
Exceptions
| Type | Condition |
|---|---|
| BaggageNullException | Thrown if the registered baggage factory returned null. |
| MissingBaggageFactoryException | Thrown if the baggage factory of the requested baggage is not registered. |