Update xState description in doc

authgear · Sep 5, 2024 · 3ca7031 · 3ca7031
1 parent fa608c4
commit 3ca7031
Show file tree

Hide file tree

Showing 3 changed files with 3 additions and 3 deletions.
diff --git a/sdk/src/main/java/com/oursky/authgear/AuthenticateOptions.kt b/sdk/src/main/java/com/oursky/authgear/AuthenticateOptions.kt
@@ -15,7 +15,7 @@ data class AuthenticateOptions @JvmOverloads constructor(
      */
     var state: String? = null,
     /**
-     * Custom state.
+     * 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
      */
     var xState: String? = null,
     /**

diff --git a/sdk/src/main/java/com/oursky/authgear/PromoteOptions.kt b/sdk/src/main/java/com/oursky/authgear/PromoteOptions.kt
@@ -10,7 +10,7 @@ data class PromoteOptions @JvmOverloads constructor(
      */
     var state: String? = null,
     /**
-     * Custom state.
+     * 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
      */
     var xState: String? = null,
     /**

diff --git a/sdk/src/main/java/com/oursky/authgear/ReauthenticateOptions.kt b/sdk/src/main/java/com/oursky/authgear/ReauthenticateOptions.kt
@@ -15,7 +15,7 @@ data class ReauthenticateOptions @JvmOverloads constructor(
      */
     var state: String? = null,
     /**
-     * Custom state.
+     * 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
      */
     var xState: String? = null,
     /**