Skip to content

Commit e26aa5a

Browse files
android sdk doc updates
1 parent d647832 commit e26aa5a

1 file changed

Lines changed: 11 additions & 11 deletions

File tree

modules/ROOT/pages/mobile-embed-android.adoc

Lines changed: 11 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -30,15 +30,15 @@ Instructs Gradle to add the dependency for compile and runtime usage in your And
3030
* `com.github.thoughtspot` +
3131
GitHub reference ID
3232
* `android-embed-sdk` +
33-
The GitHub repository containing the Android Embed SDK package.
33+
The GitHub repository of the Android Embed SDK package.
3434
* `Tag` +
3535
Indicates the version of the SDK to use. Replace this with a specific release tag from the GitHub repository. For example,0.0.1-beta.
3636

3737
The SDK may require network access to communicate with your ThoughtSpot instance. Ensure your app’s `AndroidManifest.xml` includes the following:
3838

3939
== XML Layout
4040

41-
In the `activity_main.xml` of your project, add the following to define a custom Android view component:
41+
In the `activity_main.xml` of your project, add the following elements to create a custom Android view component for Liveboard embedding:
4242

4343
[source,xml]
4444
----
@@ -58,11 +58,11 @@ Declares a custom view to render the Liveboard in the app.
5858
* `android:id="@+id/liveboard_embed_view"` +
5959
Assigns a unique ID to this view so you can reference it in your Kotlin/Java code.
6060
* `android:layout_width="match_parent"` and `android:layout_height="wrap_content"` +
61-
Sets the width and height of the layout for embedded view.
61+
These elements set the width and height of the layout for the embed view.
6262
* The `app:layout_constraint...` attributes +
6363
Positions the view relative to the other UI elements.
6464

65-
You'll need to add a reference to this view in your code and then load a specific Liveboard into it.
65+
In the next step, we'll add a reference to this view and then load a specific Liveboard into it.
6666

6767
////
6868
@@ -134,7 +134,7 @@ Replace it with the SDK version. For example, 1.0.0.
134134
val embedView = findViewById<LiveboardEmbed>(R.id.liveboard_embed_view)
135135
----
136136

137-
. Specify ThoughtSpot application URL, authentication attributes and token fetching method.
137+
. Specify the ThoughtSpot application URL, authentication attributes, and token fetching method.
138138
+
139139
[source,kotlin]
140140
----
@@ -162,14 +162,14 @@ embedView.initialize(
162162
)
163163
----
164164

165-
== Add the Liveboard and configure the embed view
165+
== Add the Liveboard and customize the embed view
166166

167167
Add the Liveboard GUID.
168168

169169
[source,Kotlin]
170170
----
171171
val viewConfig = LiveboardViewConfig(
172-
liveboardId = "your-livebaord-id" // Replace with your Liveboard ID
172+
liveboardId = "your-Liveboard-id" // Replace with your Liveboard ID
173173
)
174174
----
175175

@@ -178,7 +178,7 @@ You can also add optional parameters as shown in this example:
178178
[source,Kotlin]
179179
----
180180
val viewConfig = LiveboardViewConfig(
181-
liveboardId = "your-livebaord-id", // Replace with your Liveboard ID
181+
liveboardId = "your-Liveboard-id", // Replace with your Liveboard ID
182182
enable2ColumnLayout = true, // sets column layout and breakpoint width
183183
activeTabId = "your-tab-guid", // Set a specific tab as a home tab
184184
)
@@ -201,7 +201,7 @@ To disable or hide a menu action, use the `disabledActions`, `visibleActions`, o
201201
[source,Kotlin]
202202
----
203203
val viewConfig = LiveboardViewConfig(
204-
liveboardId = "your-livebaord-id" // Replace with your Liveboard ID
204+
liveboardId = "your-Liveboard-id" // Replace with your Liveboard ID
205205
// Show only these actions
206206
visibleActions = listOf(
207207
Action.AddFilter, //Add filter menu action
@@ -229,7 +229,7 @@ Define CSS variables to apply custom styles.
229229
[source,Kotlin]
230230
----
231231
val viewConfig = LiveboardViewConfig(
232-
liveboardId = "your-livebaord-id",
232+
liveboardId = "Your-Liveboard-id",
233233
enable2ColumnLayout = true,
234234
customizations = CustomisationsInterface(
235235
style = CustomStyles(
@@ -280,7 +280,7 @@ import kotlinx.coroutines.runBlocking
280280
val embedView = findViewById<LiveboardEmbed>(R.id.liveboard_embed_view)
281281
282282
val viewConfig = LiveboardViewConfig(
283-
liveboardId = "your-liveboard-id", // Replace with your Liveboard ID
283+
liveboardId = "Your-Liveboard-id", // Replace with your Liveboard ID
284284
enable2ColumnLayout = true,
285285
visibleActions = listOf(
286286
Action.AddFilter, // Add filter menu action

0 commit comments

Comments
 (0)