Skip to content

Commit 3bbb2c1

Browse files
authored
Merge pull request #300 from immutable/docs/logout-redirect-uri
[DX-3324] docs: update passport docs
2 parents bd6fdeb + f5271a1 commit 3bbb2c1

File tree

1 file changed

+4
-1
lines changed
  • src/Packages/Passport/Runtime/Scripts/Public

1 file changed

+4
-1
lines changed

src/Packages/Passport/Runtime/Scripts/Public/Passport.cs

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -95,7 +95,7 @@ private Passport()
9595
/// <param name="clientId">The client ID</param>
9696
/// <param name="environment">The environment to connect to</param>
9797
/// <param name="redirectUri">(Android, iOS, and macOS only) The URL where the browser will redirect after successful authentication.</param>
98-
/// <param name="logoutRedirectUri">(Android, iOS, and macOS only) The URL where the browser will redirect after logout is complete.</param>
98+
/// <param name="logoutRedirectUri">The URL where the browser will redirect after logout is complete.</param>
9999
/// <param name="engineStartupTimeoutMs">(Windows only) Timeout duration in milliseconds to wait for the default Windows browser engine to start.</param>
100100
/// <param name="webBrowserClient">(Windows only) Custom Windows browser to use instead of the default browser in the SDK.</param>
101101
public static UniTask<Passport> Init(
@@ -225,6 +225,9 @@ public void SetCallTimeout(int ms)
225225
/// <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>
226226
/// <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>
227227
/// </summary>
228+
/// <returns>
229+
/// Returns true if login is successful, otherwise false.
230+
/// </returns>
228231
public async UniTask<bool> Login(bool useCachedSession = false, Nullable<long> timeoutMs = null)
229232
{
230233
return await GetPassportImpl().Login(useCachedSession, timeoutMs);

0 commit comments

Comments
 (0)