Skip to content

SK-3068: Fix README API examples in both SDK READMEs #197

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
saileshwar-skyflow merged 1 commit into from
Aug 25, 2026
Merged

SK-3068: Fix README API examples in both SDK READMEs #197

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
69 changes: 35 additions & 34 deletions flowvault/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -144,7 +144,7 @@ val container = skyflowClient.container(Skyflow.ContainerType.COLLECT)
val cardNumberInput = Skyflow.CollectElementInput(
tableName = "cards",
column = "card_number",
type = Skyflow.ElementType.CARD_NUMBER
type = SkyflowElementType.CARD_NUMBER
)
val cardNumberElement = container.create(context = this, input = cardNumberInput)
parent.addView(cardNumberElement) // it's a View — mount it like any other
Expand Down Expand Up @@ -319,7 +319,7 @@ To create a collect element, we must first construct `Skyflow.CollectElementInpu
Skyflow.CollectElementInput(
tableName: String, // required, the table this data belongs to
column: String, // required, the column into which this data should be inserted
type: Skyflow.ElementType //Skyflow.ElementType enum
type: SkyflowElementType //SkyflowElementType enum
inputStyles: Skyflow.Styles, //optional styles that should be applied to the form element
labelStyles: Skyflow.Styles, //optional styles that will be applied to the label of the collect element
errorTextStyles: Skyflow.Styles, //optional styles that will be applied to the errorText of the collect element
Expand Down Expand Up @@ -505,7 +505,7 @@ the `context` param takes android `Context` object as described below:
val collectElementInput = Skyflow.CollectElementInput(
tableName = "string", //the table this data belongs to
column = "string", //the column into which this data should be inserted
type = Skyflow.ElementType.CARD_NUMBER, //Skyflow.ElementType enum
type = SkyflowElementType.CARD_NUMBER, //SkyflowElementType enum
inputStyles = Skyflow.Styles(), /*optional styles that should be applied to the form element*/
labelStyles = Skyflow.Styles(), //optional styles that will be applied to the label of the collect element
errorTextStyles = Skyflow.Styles(), //optional styles that will be applied to the errorText of the collect element
Expand Down Expand Up @@ -599,7 +599,7 @@ To create a collect Element, construct a `Skyflow.CollectElementInput` object as
val collectElementInput = Skyflow.CollectElementInput(
tableName: String, // required, the table this data belongs to
column: String, // required, the column into which this data should be inserted
type: Skyflow.ElementType, // Skyflow.ElementType enum
type: SkyflowElementType, // SkyflowElementType enum
inputStyles: Skyflow.Styles, // optional styles that should be applied to the form element
labelStyles: Skyflow.Styles, // optional styles that will be applied to the label of the collect element
errorTextStyles: Skyflow.Styles, // optional styles that will be applied to the errorText of the collect element
Expand Down Expand Up @@ -708,15 +708,15 @@ val lengthRule = LengthMatchRule(minLength = 8, maxLength = 16, error = "Must be
myRuleset.add(rule = strongPasswordRule)
myRuleset.add(rule = lengthRule)

val passwordInput = CollectElementInput(inputStyles = styles, label = "Password", placeholder = "****", type = ElementType.INPUT_FIELD, validations = myRuleset)
val passwordInput = CollectElementInput(inputStyles = styles, label = "Password", placeholder = "****", type = SkyflowElementType.INPUT_FIELD, validations = myRuleset)

val Password = container.create(passwordInput)
val Password = container.create(context = this, input = passwordInput)

// For confirm Password element - shows error when the PINs don't match
val elementMatchRule = ElementMatchRule(element = Password, error = "PINs don't match")
val elementMatchRule = ElementValueMatchRule(element = Password, error = "PINs don't match")

val confirmPasswordinput = CollectElementInput(inputStyles = styles, label = "Confirm Password", placeholder = "****", type = ElementType.INPUT_FIELD, validations = ValidationSet(rules = mutableListOf(strongPasswordRule, lengthRule, elementMatchRule)))
val confirmPassword = container.create(input = confirmPasswordinput)
val confirmPasswordinput = CollectElementInput(inputStyles = styles, label = "Confirm Password", placeholder = "****", type = SkyflowElementType.INPUT_FIELD, validations = ValidationSet(rules = mutableListOf(strongPasswordRule, lengthRule, elementMatchRule)))
val confirmPassword = container.create(context = this, input = confirmPasswordinput)

//mount elements to the screen
addView(Password)
Expand Down Expand Up @@ -748,7 +748,7 @@ The handler ```(state: JSONObject) -> Unit``` is a callback function you provide

```kt
val state = {
"elementType": Skyflow.ElementType,
"elementType": SkyflowElementType,
"isEmpty": Boolean,
"isRequired": Boolean,
"isFocused": Boolean,
Expand All @@ -774,12 +774,12 @@ val container = skyflowClient.container(type = Skyflow.ContainerType.COLLECT)
val cardNumberInput = Skyflow.CollectElementInput(
tableName = "cards",
column = "cardNumber",
type = Skyflow.ElementType.CARD_NUMBER,
type = SkyflowElementType.CARD_NUMBER,
)
val cardHolderNameInput = Skyflow.CollectElementInput(
tableName = "cards",
column = "cardHolderName",
type = Skyflow.ElementType.CARDHOLDER_NAME,
type = SkyflowElementType.CARDHOLDER_NAME,
)

val cardNumber = container.create(context = this, input = cardNumberInput)
Expand All @@ -798,15 +798,15 @@ cardHolderName.on(eventName = Skyflow.EventName.CHANGE) { state ->
##### Sample Element state object when `Env` is `DEV`
```kt
{
"elementType": Skyflow.ElementType.CARD_NUMBER,
"elementType": SkyflowElementType.CARD_NUMBER,
"isEmpty": false,
"isRequired": false,
"isFocused": true,
"isValid": true,
"value": "4111111111111111"
}
{
"elementType": Skyflow.ElementType.CARDHOLDER_NAME,
"elementType": SkyflowElementType.CARDHOLDER_NAME,
"isEmpty": false,
"isRequired": false,
"isFocused": true,
Expand All @@ -817,14 +817,14 @@ cardHolderName.on(eventName = Skyflow.EventName.CHANGE) { state ->
##### Sample Element state object when `Env` is `PROD`
```kt
{
"elementType": Skyflow.ElementType.CARD_NUMBER,
"elementType": SkyflowElementType.CARD_NUMBER,
"isEmpty": false,
"isFocused": true,
"isValid": true,
"value": "41111111XXXXXXXX"
}
{
"elementType": Skyflow.ElementType.CARDHOLDER_NAME,
"elementType": SkyflowElementType.CARDHOLDER_NAME,
"isEmpty": false,
"isFocused": true,
"isValid": true,
Expand Down Expand Up @@ -854,10 +854,10 @@ val container = skyflowClient.container(type = Skyflow.ContainerType.COLLECT)
val cardNumberInput = Skyflow.CollectElementInput(
tableName = "cards",
column = "cardNumber",
type = Skyflow.ElementType.CARD_NUMBER,
type = SkyflowElementType.CARD_NUMBER,
)

val cardNumber = container.create(input = cardNumberInput)
val cardNumber = container.create(context = this, input = cardNumberInput)

//Set custom error
cardNumber.setError("custom error")
Expand Down Expand Up @@ -892,9 +892,9 @@ val container = skyflowClient.container(type = Skyflow.ContainerType.COLLECT)
val cardNumberInput = Skyflow.CollectElementInput(
tableName = "cards",
column = "cardNumber",
type = Skyflow.ElementType.CARD_NUMBER,
type = SkyflowElementType.CARD_NUMBER,
)
val cardNumber = container.create(input = cardNumberInput)
val cardNumber = container.create(context = this, input = cardNumberInput)
//Set a value programatically
cardNumber.setValue("4111111111111111")
//Clear the value
Expand Down Expand Up @@ -954,7 +954,7 @@ val composableElementInput = Skyflow.CollectElementInput(
placeholder: String, // optional placeholder for the form element
altText: String, // (DEPRECATED) optional that acts as an initial value for the collect element
validations: ValidationSet, // optional set of validations for the input element
type: Skyflow.ElementType, // Skyflow.ElementType enum
type: SkyflowElementType, // SkyflowElementType enum
)
```
The `tableName` and `column` fields indicate which table and column in the vault the Element corresponds to.
Expand Down Expand Up @@ -1036,7 +1036,7 @@ val styles = Skyflow.Styles(

Other parameters in the `Skyflow.Style` object are ignored for `label` and `errorText` text views.

Finally, the `type` parameter takes a Skyflow.ElementType. Each type applies the appropriate regex and validations to the form element.
Finally, the `type` parameter takes a SkyflowElementType. Each type applies the appropriate regex and validations to the form element.

The Android SDK supports the following composable elements:

Expand Down Expand Up @@ -1126,7 +1126,7 @@ val composableElementInput = Skyflow.CollectElementInput(
placeholder: String, // optional placeholder for the form element
altText: String, // (DEPRECATED) optional that acts as an initial value for the collect element
validations: ValidationSet, // optional set of validations for the input element
type: Skyflow.ElementType, // Skyflow.ElementType enum
type: SkyflowElementType, // SkyflowElementType enum
)

val collectElementOptions = Skyflow.CollectElementOptions(
Expand Down Expand Up @@ -1214,7 +1214,7 @@ Composable Elements use the following schema:
val composableElementInput = Skyflow.CollectElementInput(
tableName: String, // required, the table this data belongs to
column: String, // required, the column into which this data should be updated
type: Skyflow.ElementType, // Skyflow.ElementType enum
type: SkyflowElementType, // SkyflowElementType enum
inputStyles: Skyflow.Styles, // optional styles that should be applied to the form element
labelStyles: Skyflow.Styles, // optional styles that will be applied to the label of the collect element
errorTextStyles: Skyflow.Styles, // optional styles that will be applied to the errorText of the collect element
Expand Down Expand Up @@ -1325,7 +1325,7 @@ The handler `(state: JSONObject) -> Unit` is a callback function you provide, th

```kotlin
val state = {
"elementType": Skyflow.ElementType,
"elementType": SkyflowElementType,
"isEmpty": Bool ,
"isRequired": Bool,
"isFocused": Bool,
Expand Down Expand Up @@ -1363,13 +1363,13 @@ val container = skyflowClient.container(type: Skyflow.ContainerType.COMPOSABLE,
val cardNumberInput = Skyflow.CollectElementInput(
tableName = "cards",
column = "cardNumber",
type = Skyflow.ElementType.CARD_NUMBER,
type = SkyflowElementType.CARD_NUMBER,
)

val cardHolderNameInput = Skyflow.CollectElementInput(
tableName = "cards",
column = "cardHolderName",
type = Skyflow.ElementType.CARDHOLDER_NAME,
type = SkyflowElementType.CARDHOLDER_NAME,
)

val cardNumber = container.create(context = this, input = cardNumberInput)
Expand Down Expand Up @@ -1397,15 +1397,15 @@ cardHolderName.on(eventName: Skyflow.EventName.CHANGE) { state ->
#### Sample Element state object when `env` is `DEV`
```kotlin
{
"elementType": Skyflow.ElementType.CARD_NUMBER,
"elementType": SkyflowElementType.CARD_NUMBER,
"isEmpty": false,
"isRequired": false,
"isFocused": true,
"isValid": true,
"value": "4111111111111111"
}
{
"elementType": Skyflow.ElementType.CARDHOLDER_NAME,
"elementType": SkyflowElementType.CARDHOLDER_NAME,
"isEmpty": false,
"isRequired": false,
"isFocused": true,
Expand All @@ -1416,15 +1416,15 @@ cardHolderName.on(eventName: Skyflow.EventName.CHANGE) { state ->
#### Sample Element state object when `env` is `PROD`
```kotlin
{
"elementType": Skyflow.ElementType.CARD_NUMBER,
"elementType": SkyflowElementType.CARD_NUMBER,
"isEmpty": false,
"isRequired": false,
"isFocused": true,
"isValid": true,
"value": "41111111XXXXXXXX"
}
{
"elementType": Skyflow.ElementType.CARDHOLDER_NAME,
"elementType": SkyflowElementType.CARDHOLDER_NAME,
"isEmpty": false,
"isRequired": false,
"isFocused": true,
Expand Down Expand Up @@ -1482,13 +1482,13 @@ val container = skyflowClient.container(type: Skyflow.ContainerType.COMPOSABLE,
val cardNumberInput = Skyflow.CollectElementInput(
tableName = "cards",
column = "cardNumber",
type = Skyflow.ElementType.CARD_NUMBER,
type = SkyflowElementType.CARD_NUMBER,
)

val cardHolderNameInput = Skyflow.CollectElementInput(
tableName = "cards",
column = "cardHolderName",
type = Skyflow.ElementType.CARDHOLDER_NAME,
type = SkyflowElementType.CARDHOLDER_NAME,
)

val cardNumber = container.create(context = this, input = cardNumberInput)
Expand Down Expand Up @@ -1549,7 +1549,7 @@ val container = skyflowClient.container(type: Skyflow.ContainerType.COMPOSABLE,
val cardNumberInput = Skyflow.CollectElementInput(
tableName = "cards",
column = "cardNumber",
type = Skyflow.ElementType.CARD_NUMBER,
type = SkyflowElementType.CARD_NUMBER,
)

val cardNumber = container.create(context = this, input = cardNumberInput)
Expand Down Expand Up @@ -1669,6 +1669,7 @@ Once you've defined a `Skyflow.RevealElementInput` object and `Skyflow.RevealEle

```kotlin
val element = container.create(
context = this,
input = revealElementInput,
options = Skyflow.RevealElementOptions(
format = "XXXX-XXXXXX-XXXXX",
Expand Down
Loading
Loading