Skip to content

appium doc fix #2288

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
merged 1 commit into from
Nov 19, 2025
Merged

appium doc fix #2288

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
168 changes: 160 additions & 8 deletions docs/smartui-appium-sdk.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,8 +1,8 @@
---
id: smartui-appium-sdk
title: Integrate SmartUI SDK with Appium Tests
title: Integrate SmartUI with Appium Tests
sidebar_label: Appium
description: In this documentation, learn how integrate your Appium automated tests with LambdaTest's SmartUI.
description: Learn how to integrate your Appium automated tests with LambdaTest's SmartUI. Java uses both SDK and hooks integration, while JavaScript, Python, Ruby, and C# use Hooks integration.
keywords:
- Visual Regression
- Visual Regression Testing Guide
Expand Down Expand Up @@ -48,41 +48,46 @@ import {YOUR_LAMBDATEST_USERNAME, YOUR_LAMBDATEST_ACCESS_KEY} from "@site/src/co
></script>
Appium is an open-source tool for automating mobile application testing. It allows developers and testers to write tests for native, hybrid, and mobile web applications across multiple platforms, such as iOS and Android, using a single codebase.

The LambdaTest SmartUI SDK supports multiple programming languages for running Appium automation tests on mobile browsers. <br /> Below is the list of supported languages:
LambdaTest SmartUI supports Appium automation tests for mobile applications through two integration methods:

- **SDK Integration**: Available for Java
- **Hooks Integration**: Available for JavaScript, Python, Ruby, and C#

Below is the list of supported languages and their integration methods:

<div className='lt_row lt_framework_list_row'>
<div className='lt_col lt_framework_wrapper'>
<img loading="lazy" src={require('../assets/images/getting-started/java-icon.webp').default} alt="Java" width="200" height="200" className='language-icon no-zoom'/>
<ul className='lt_framework_list'>
<li><a href="/support/docs/smartui-appium-java-sdk/" target="_blank" style={{color: '#0a69da', textDecoration: 'underline'}} >Java</a></li>
<li><a href="/support/docs/smartui-appium-java-sdk/" target="_blank" style={{color: '#0a69da', textDecoration: 'underline'}} >Java SDK</a></li>
</ul>
</div>

<div className='lt_col lt_framework_wrapper'>
<img loading="lazy" src={require('../assets/images/getting-started/color-js.webp').default} alt="Javascript" width="181" height="200" className='language-icon no-zoom'/>
<ul className='lt_framework_list'>
<li><a href="/support/docs/smartui-appium-hooks/" target="_blank" style={{color: '#0a69da', textDecoration: 'underline'}}>JavaScript</a></li>
<li><a href="/support/docs/smartui-appium-hooks/" target="_blank" style={{color: '#0a69da', textDecoration: 'underline'}}>JavaScript Hooks</a></li>
</ul>
</div>

<div className='lt_col lt_framework_wrapper'>
<img loading="lazy" src={require('../assets/images/getting-started/python-icon.webp').default} alt="Python" width="200" height="200" className='language-icon no-zoom'/>
<ul className='lt_framework_list'>
<li><a href="/support/docs/smartui-appium-hooks/" target="_blank" style={{color: '#0a69da', textDecoration: 'underline'}}>Python</a></li>
<li><a href="/support/docs/smartui-appium-hooks/" target="_blank" style={{color: '#0a69da', textDecoration: 'underline'}}>Python Hooks</a></li>
</ul>
</div>

<div className='lt_col lt_framework_wrapper'>
<img loading="lazy" src={require('../assets/images/getting-started/ruby-icon.webp').default} alt="Ruby" width="200" height="200" className='language-icon no-zoom'/>
<ul className='lt_framework_list'>
<li><a href="/support/docs/smartui-appium-hooks/" target="_blank" style={{color: '#0a69da', textDecoration: 'underline'}}>Ruby</a></li>
<li><a href="/support/docs/smartui-appium-hooks/" target="_blank" style={{color: '#0a69da', textDecoration: 'underline'}}>Ruby Hooks</a></li>
</ul>
</div>

<div className='lt_col lt_framework_wrapper'>
<img loading="lazy" src={require('../assets/images/getting-started/c-sharp-icon.webp').default} alt="C#" width="200" height="200" className='language-icon no-zoom'/>
<ul className='lt_framework_list'>
<li><a href="/support/docs/smartui-appium-hooks/" target="_blank" style={{color: '#0a69da', textDecoration: 'underline'}}>C#</a></li>
<li><a href="/support/docs/smartui-appium-hooks/" target="_blank" style={{color: '#0a69da', textDecoration: 'underline'}}>C# Hooks</a></li>
</ul>
</div>
</div>
Expand All @@ -91,6 +96,153 @@ The LambdaTest SmartUI SDK supports multiple programming languages for running A
<p>We support all languages and frameworks that are compatible with Appium, so in case your favorite isn't in the table.<br/>Don't worry, you can still run the test. <span className='doc__lt' onClick={() => window.openLTChatWidget()}>Contact Us</span> for any help.</p>
</div>

## Integration Methods

### SDK Integration (Java)

The SmartUI App SDK provides a native Java library for integrating visual regression testing into your Appium Java test suite. This method offers:

- Native Java API for screenshot capture
- Type-safe integration with your existing test framework
- Comprehensive error handling and logging

**Documentation**: [Appium Java SDK](/support/docs/smartui-appium-java-sdk) - Complete guide with best practices and troubleshooting

### Hooks Integration (JavaScript, Python, Ruby, C#)

For languages other than Java, SmartUI uses Hooks integration, which leverages Appium's execute command to capture screenshots. This method:

- Works with any Appium-compatible language
- Uses simple execute commands for screenshot capture
- Supports both viewport and full-page screenshots

**Documentation**: [Appium Hooks](/support/docs/smartui-appium-hooks) - Complete guide for JavaScript, Python, Ruby, and C# implementations

#### Quick Start with Hooks

**Prerequisites:**
- Appium driver instance initialized
- SmartUI project created with Project Token
- LambdaTest credentials configured

**Taking Viewport Screenshots:**

Add the following code snippet in your test where you want to capture a screenshot:

<Tabs className='docs__val' groupId='hooks-language'>
<TabItem value='javascript' label='JavaScript' default>

```javascript
driver.execute("smartui.takeScreenshot=<Name of your screenshot>");
```

</TabItem>
<TabItem value='python' label='Python'>

```python
driver.execute("smartui.takeScreenshot=<Your Screenshot Name>")
```

</TabItem>
<TabItem value='ruby' label='Ruby'>

```ruby
driver.execute("smartui.takeScreenshot=<Your Screenshot Name>")
```

</TabItem>
<TabItem value='csharp' label='C#'>

```csharp
driver.Execute("smartui.takeScreenshot=<Your Screenshot Name>");
```

</TabItem>
</Tabs>

**Taking Full Page Screenshots (Native Apps):**

For apps with scrolling functionality, you can capture full-page screenshots:

<Tabs className='docs__val' groupId='hooks-fullpage'>
<TabItem value='javascript-full' label='JavaScript' default>

```javascript
let config = {
screenshotName: '<Name of your screenshot>',
fullPage: true,
pageCount: 15 // Minimum 1, Maximum 20
};
await driver.execute("smartui.takeScreenshot", config);
```

</TabItem>
<TabItem value='python-full' label='Python'>

```python
config = {
'screenshotName': '<Your Screenshot Name>',
'fullPage': True,
'pageCount': 15 # Minimum 1, Maximum 20
}
driver.execute("smartui.takeScreenshot", config)
```

</TabItem>
<TabItem value='ruby-full' label='Ruby'>

```ruby
config = {
'screenshotName' => '<Your Screenshot Name>',
'fullPage' => true,
'pageCount' => 15 # Minimum 1, Maximum 20
}
driver.execute("smartui.takeScreenshot", config)
```

</TabItem>
<TabItem value='csharp-full' label='C#'>

```csharp
var config = new Dictionary<string, object> {
{"screenshotName", "<Your Screenshot Name>"},
{"fullPage", true},
{"pageCount", 15} // Minimum 1, Maximum 20
};
driver.Execute("smartui.takeScreenshot", config);
```

</TabItem>
</Tabs>

**Configuration:**

Set your Project Token as an environment variable before running tests:

<Tabs className='docs__val' groupId='hooks-config'>
<TabItem value='macos-linux' label='MacOS/Linux' default>

```bash
export PROJECT_TOKEN="your_project_token"
```

</TabItem>
<TabItem value='windows' label='Windows - CMD'>

```bash
set PROJECT_TOKEN=your_project_token
```

</TabItem>
<TabItem value='powershell' label='PowerShell'>

```powershell
$env:PROJECT_TOKEN="your_project_token"
```

</TabItem>
</Tabs>

## Next Steps

After selecting your preferred language, refer to the specific documentation for detailed integration steps:
Expand Down
Loading