Skip to content

Commit

Permalink
docs: update passport docs
Browse files Browse the repository at this point in the history
  • Loading branch information
nattb8 committed Oct 10, 2024
1 parent bd6fdeb commit f5271a1
Showing 1 changed file with 4 additions and 1 deletion.
5 changes: 4 additions & 1 deletion src/Packages/Passport/Runtime/Scripts/Public/Passport.cs
Original file line number Diff line number Diff line change
Expand Up @@ -95,7 +95,7 @@ private Passport()
/// <param name="clientId">The client ID</param>
/// <param name="environment">The environment to connect to</param>
/// <param name="redirectUri">(Android, iOS, and macOS only) The URL where the browser will redirect after successful authentication.</param>
/// <param name="logoutRedirectUri">(Android, iOS, and macOS only) The URL where the browser will redirect after logout is complete.</param>
/// <param name="logoutRedirectUri">The URL where the browser will redirect after logout is complete.</param>
/// <param name="engineStartupTimeoutMs">(Windows only) Timeout duration in milliseconds to wait for the default Windows browser engine to start.</param>
/// <param name="webBrowserClient">(Windows only) Custom Windows browser to use instead of the default browser in the SDK.</param>
public static UniTask<Passport> Init(
Expand Down Expand Up @@ -225,6 +225,9 @@ public void SetCallTimeout(int ms)
/// <param name="useCachedSession">If true, the saved access token or refresh token will be used to log the user in. If this fails, it will not fallback to device code auth.</param>
/// <param name="timeoutMs">(Optional) The maximum time, in milliseconds, the function is allowed to take before a TimeoutException is thrown. If not set, the function will wait indefinitely.</param>
/// </summary>
/// <returns>
/// Returns true if login is successful, otherwise false.
/// </returns>
public async UniTask<bool> Login(bool useCachedSession = false, Nullable<long> timeoutMs = null)
{
return await GetPassportImpl().Login(useCachedSession, timeoutMs);
Expand Down

0 comments on commit f5271a1

Please sign in to comment.