mirror of
https://github.com/vector-im/element-call.git
synced 2026-08-08 20:09:19 +00:00
review change comment to proper doc
This commit is contained in:
@@ -151,7 +151,7 @@ export const createLocalTransport$ = ({
|
|||||||
logger: logger,
|
logger: logger,
|
||||||
});
|
});
|
||||||
|
|
||||||
// Get the preferred transport from the current deployement.
|
// Get the preferred transport from the current deployment.
|
||||||
const discoveredTransport$ = from(
|
const discoveredTransport$ = from(
|
||||||
transportDiscovery.discoverPreferredTransport(),
|
transportDiscovery.discoverPreferredTransport(),
|
||||||
);
|
);
|
||||||
@@ -266,15 +266,22 @@ function observerOldestMembership$(
|
|||||||
);
|
);
|
||||||
}
|
}
|
||||||
|
|
||||||
// Utility to ensure the user can authenticate with the SFU.
|
/**
|
||||||
//
|
* Utility to ensure the user can authenticate with the SFU.
|
||||||
// We will call `getSFUConfigWithOpenID` once per transport here as it's our
|
* We will call `getSFUConfigWithOpenID` once per transport here as it's our
|
||||||
// only mechanism of validation. This means we will also ask the
|
* only mechanism of validation. This means we will also ask the
|
||||||
// homeserver for a OpenID token a few times. Since OpenID tokens are single
|
* homeserver for a OpenID token a few times. Since OpenID tokens are single
|
||||||
// use we don't want to risk any issues by re-using a token.
|
* use we don't want to risk any issues by re-using a token.
|
||||||
//
|
*
|
||||||
// If the OpenID request were to fail, then it's acceptable for us to fail
|
* @param transport The transport to authenticate with.
|
||||||
// this function early, as we assume the homeserver has got some problems.
|
* @param forceJwtEndpoint Whether to force the JWT endpoint to be used.
|
||||||
|
* @param membership The identity of the local member.
|
||||||
|
* @param roomId The room ID to use for the JWT.
|
||||||
|
* @param client The client to use for the OpenID token.
|
||||||
|
* @param delayId The delayId to use for the JWT.
|
||||||
|
*
|
||||||
|
* @throws FailToGetOpenIdToken, NoMatrix2AuthorizationService
|
||||||
|
*/
|
||||||
async function doOpenIdAndJWTFromUrl(
|
async function doOpenIdAndJWTFromUrl(
|
||||||
transport: LivekitTransportConfig,
|
transport: LivekitTransportConfig,
|
||||||
forceJwtEndpoint: JwtEndpointVersion,
|
forceJwtEndpoint: JwtEndpointVersion,
|
||||||
|
|||||||
Reference in New Issue
Block a user