Update reauthenticate and promoteAnonymousUser for state parameter do…

…cumentation
authgear · Sep 5, 2024 · 357c0f5 · 357c0f5
1 parent 9d76cfc
commit 357c0f5
Showing 1 changed file with 6 additions and 4 deletions.
diff --git a/Sources/Authgear.swift b/Sources/Authgear.swift
@@ -853,9 +853,10 @@ public class Authgear {
         }
     }
 
+    /// - Parameters:
+    ///   - xState: Use this parameter to provide parameters from the client application to Custom UI. The string in xState can be accessed by the Custom UI. Ignore this parameter if default AuthUI is used
     public func reauthenticate(
         redirectURI: String,
-        state: String? = nil,
         xState: String? = nil,
         uiLocales: [String]? = nil,
         colorScheme: ColorScheme? = nil,
@@ -899,7 +900,7 @@ public class Authgear {
         let options = ReauthenticateOptions(
             redirectURI: redirectURI,
             isSSOEnabled: self.isSSOEnabled,
-            state: state,
+            state: nil,
             xState: xState,
             uiLocales: uiLocales,
             colorScheme: colorScheme,
@@ -981,9 +982,10 @@ public class Authgear {
         }
     }
 
+    /// - Parameters:
+    ///   - xState: Use this parameter to provide parameters from the client application to Custom UI. The string in xState can be accessed by the Custom UI. Ignore this parameter if default AuthUI is used
     public func promoteAnonymousUser(
         redirectURI: String,
-        state: String? = nil,
         xState: String? = nil,
         uiLocales: [String]? = nil,
         colorScheme: ColorScheme? = nil,
@@ -1023,7 +1025,7 @@ public class Authgear {
                         redirectURI: redirectURI,
                         isSSOEnabled: self.isSSOEnabled,
                         preAuthenticatedURLEnabled: self.preAuthenticatedURLEnabled,
-                        state: state,
+                        state: nil,
                         xState: xState,
                         prompt: [.login],
                         loginHint: loginHint,