IRelaySessionAwareDriverFactory Interface
An interface that allows a concrete instance of a driver factory to call the getRelayServiceSessionInfo function if it session aware.
This API is provided for existing users, but is not recommended for new users.
To use, import via @fluidframework/odsp-driver-definitions/legacy.
For more information about our API support guarantees, see here.
Signature
export interface IRelaySessionAwareDriverFactory extends IProvideSessionAwareDriverFactory
Extends: IProvideSessionAwareDriverFactory
Methods
| Method | Alerts | Return Type | Description |
|---|---|---|---|
| getRelayServiceSessionInfo(resolvedUrl) | Alpha |
Promise<ISocketStorageDiscovery | undefined> |
Method Details
getRelayServiceSessionInfo
This API is provided as an alpha preview and may change without notice.
To use, import via @fluidframework/odsp-driver-definitions/alpha.
For more information about our API support guarantees, see here.
Signature
getRelayServiceSessionInfo(resolvedUrl: IResolvedUrl): Promise<ISocketStorageDiscovery | undefined>;
Parameters
| Parameter | Type | Description |
|---|---|---|
| resolvedUrl | IResolvedUrl |
Returns
Return type: Promise<ISocketStorageDiscovery | undefined>