Skip to content

Commit 5f7ee31

Browse files
authored
Merge pull request #1348 from shreybansal-lambdatest/stage
updated document with changes
2 parents 7e94287 + 53e6433 commit 5f7ee31

File tree

1 file changed

+41
-15
lines changed

1 file changed

+41
-15
lines changed

docs/appium-ios-app-settings.md

Lines changed: 41 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -101,38 +101,64 @@ params = {"Permission Settings":{"Location":"While using the app", "Precise Loca
101101
```
102102

103103
:::
104-
105104
### Custom App Settings
106105

107106
These are the settings added by the app developer using the [iOS Settings Bundle](https://developer.apple.com/library/archive/documentation/Cocoa/Conceptual/UserDefaults/Preferences/Preferences.html#//apple_ref/doc/uid/10000059i-CH6-SW11).
108107

109-
**Supported custom settings**
108+
Currently, App Automate supports the following **custom settings** -
109+
110+
*1. Toggles-*
111+
112+
Toggles represent simple On/Off switches. To automate toggles, use the setting name as the key and set its value to "On" or "Off".
113+
114+
Example => Biometric : On
115+
116+
117+
*2. Multivalued Settings-*
118+
119+
Multivalued settings allow users to choose from multiple options, such as dropdowns or segmented controls. The setting name is the key, and the selected option is the value.
120+
121+
Example => Currency : Rs
122+
123+
*3. Nested Settings-*
124+
125+
Nested settings refer to child panes or submenus within the main settings. To interact with them, use the main setting name and specify the desired nested option.
126+
127+
Example => Other Settings : [Country:USA , Voice Command : On]
128+
129+
*4. Sliders-*
130+
131+
Sliders accept decimal values between 0 and 1. If multiple sliders are present, specify the index to target a specific one.
132+
133+
Example => Slider-1 : 0.5
134+
135+
*5. Textfields-*
110136

111-
Currently, App Automate supports the following custom settings:
137+
Textfields accept plain text input. If multiple textfields exist, use an indexed key to target the correct field.
112138

113-
- Toggles
139+
Example => TextField-1 : This is LambdaTest
114140

115-
- Multivalued Settings
141+
*6. Secure Textfields-*
116142

117-
- Nested Settings
143+
Secure textfields are similar to regular textfields but are used for sensitive data like passwords. They obscure the text as it’s entered.
118144

119-
- Sliders
145+
Example => SecureTextField-1: 000000
120146

121-
- Textfields
147+
Note: If any key is not present, we should get an error saying one of the keys is missing in the passed preferences.
122148

123-
Apart from Textfields and Sliders, for every other settings, we have to pass the Name of that particular setting as the **key-value pair**. For example:
149+
**Important Considerations:**
124150

125-
- "Reset App" : "On".
151+
*1. Default Values-*
126152

127-
For **textfields and sliders**, we pass the index of that particular textfield or slider starting from 1 when we traverse from top to bottom. For example:
153+
If a Textfield or Secure Textfield has a default value, it will be cleared before applying the new preference. To retain the default value, pass it explicitly in the preference.
128154

129-
1. "Slider-1":"0.1",
155+
*2. Clearing Values-*
130156

131-
2. "TextField-2":"ABCD"
157+
Pass an empty string ("") to clear an existing value.
132158

133-
The values in Slider are entered on a scale from 0-1 which means the values are not integers but decimals.
159+
*3. Untouched Fields-*
134160

135-
If any key is not present, we should get an error saying one of the keys is missing in the passed preferences.
161+
To leave a Textfield/Secure Textfield untouched, simply omit it from the preferences.
136162

137163
### Remember
138164

0 commit comments

Comments
 (0)