Merge pull request #2251 from Ishavyas9/main

Updated documentation

Author: Ishavyas9

docs/apis-for-app-testing.md

@@ -17,6 +17,8 @@ import CodeBlock from '@theme/CodeBlock';
 import {YOUR_LAMBDATEST_USERNAME, YOUR_LAMBDATEST_ACCESS_KEY} from "@site/src/component/keys";
 import Tabs from '@theme/Tabs';
 import TabItem from '@theme/TabItem';
+import RealDeviceTag from '../src/component/realDevice';
+import VirtualDeviceTag from '../src/component/virtualDevice';
 
 <script type="application/ld+json"
       dangerouslySetInnerHTML={{ __html: JSON.stringify({
@@ -41,15 +43,11 @@ import TabItem from '@theme/TabItem';
       })
     }}
 ></script>
-
-## Overview
-***
-
+<RealDeviceTag value="Real Device" /> <VirtualDeviceTag value="Virtual Device" />
 In this documentation, we look at some APIs that will help you optimize your mobile app testing workflow. If you are performing live or automated app testing, you can use these APIs in your scripts to perform various actions.
 
 ## Fetching The Devices Available for Testing
-***
-
+<RealDeviceTag value="Real Device" />
 To fetch the Devices that are available for running Tests.
 
 <div className="lambdatest__codeblock">
@@ -237,8 +235,8 @@ Shown below is the response to the above cURL request.
 </div>
 
 ## Generate publicly shareable build and test links
-***
-
+<RealDeviceTag value="Real Device" />
+<VirtualDeviceTag value="Virtual Device" />
 To generate public **shareable build link**, run the below cURL command. 
 
 <div className="lambdatest__codeblock">

docs/appium-firebase-app-upload.md

@@ -17,7 +17,6 @@ url: https://www.lambdatest.com/support/docs/appium-firebase-app-upload/
 site_name: Uploading app via Firebase
 slug: appium-firebase-app-upload/
 ---
-
 <script type="application/ld+json"
       dangerouslySetInnerHTML={{ __html: JSON.stringify({
        "@context": "https://schema.org",
@@ -47,9 +46,10 @@ import {YOUR_LAMBDATEST_USERNAME, YOUR_LAMBDATEST_ACCESS_KEY} from "@site/src/co
 
 import Tabs from '@theme/Tabs';
 import TabItem from '@theme/TabItem';
+import RealDeviceTag from '../src/component/realDevice';
 
 ---
-
+<RealDeviceTag value="Real Device" /> 
 ## Tutorial to test an app uploaded on Firebase
 
 **Firebase** is a platform developed by **Google** for creating mobile and web applications. **LambdaTest cloud platform** provides you various methods to upload your files on a real device like from playstore and appstore. Uploading an app through Firebase is one such method.

docs/appium-flutter-integration.md

@@ -32,7 +32,7 @@ After preparing your Flutter app with this integration (refer to the setup docum
 
 ---
 
-## Native Flutter Integration Driver vs Appium Flutter Integration Driver <RealDeviceTag value="Real Device" /> <VirtualDeviceTag value="Virtual Device" />
+## Native Flutter Integration Driver vs Appium Flutter Integration Driver 
 
 | Feature / Use Case                                   | Native Flutter Driver | Appium Flutter Integration Driver |
 |----------------------------------------------------|----------------------|----------------------------------|

docs/appium-install-uninstall-hook.md

@@ -44,12 +44,19 @@ import {YOUR_LAMBDATEST_USERNAME, YOUR_LAMBDATEST_ACCESS_KEY} from "@site/src/co
 
 import Tabs from '@theme/Tabs';
 import TabItem from '@theme/TabItem';
+import RealDeviceTag from '../src/component/realDevice';
+import VirtualDeviceTag from '../src/component/virtualDevice';
+
+
+<RealDeviceTag value="Real Device" /> 
+<VirtualDeviceTag value="Virtual Device" />
 
 ## Introduction
 
 LambdaTest now allows you to install and uninstall apps in the middle of your automated tests. This means you don’t need to restart the session every time you want to switch apps, upgrade them, or clean up the device.
 
-## Installing and Uninstalling Apps
+## Installing and Uninstalling Apps  
+<RealDeviceTag value="Real Device" /> <VirtualDeviceTag value="Virtual Device" />
 
 LambdaTest enables you to install and uninstall applications during automation test execution by using commands that can be run through WebDriver's script execution functionality.
 

docs/appium-lambdaHooks.md

@@ -46,8 +46,13 @@ import {YOUR_LAMBDATEST_USERNAME, YOUR_LAMBDATEST_ACCESS_KEY} from "@site/src/co
 
 import Tabs from '@theme/Tabs';
 import TabItem from '@theme/TabItem';
+import RealDeviceTag from '../src/component/realDevice';
+import VirtualDeviceTag from '../src/component/virtualDevice';
 
 
+<RealDeviceTag value="Real Device" /> 
+<VirtualDeviceTag value="Virtual Device" />
+
 
 This document will help you provide lambdahooks which can be used to improve your test scripts to easily debug your test cases for **App Automation on Real Devices** on **LambdaTest Cloud**.
 

docs/appium-uploading-retrieving-files.md

@@ -24,6 +24,9 @@ import {YOUR_LAMBDATEST_USERNAME, YOUR_LAMBDATEST_ACCESS_KEY} from "@site/src/co
 
 import Tabs from '@theme/Tabs';
 import TabItem from '@theme/TabItem';
+import RealDeviceTag from '../src/component/realDevice';
+
+<RealDeviceTag value="Real Device" /> 
 
 <script type="application/ld+json"
       dangerouslySetInnerHTML={{ __html: JSON.stringify({

docs/application-setup-via-api.md

@@ -19,6 +19,11 @@ import Tabs from '@theme/Tabs';
 import TabItem from '@theme/TabItem';
 import {YOUR_LAMBDATEST_USERNAME, YOUR_LAMBDATEST_ACCESS_KEY} from "@site/src/component/keys";
 import CodeBlock from '@theme/CodeBlock';
+import RealDeviceTag from '../src/component/realDevice';
+import VirtualDeviceTag from '../src/component/virtualDevice';
+
+<RealDeviceTag value="Real Device" /> 
+<VirtualDeviceTag value="Virtual Device" />
 
 <script type="application/ld+json"
       dangerouslySetInnerHTML={{ __html: JSON.stringify({
@@ -64,28 +69,55 @@ The maximum size for application should not exceed 1GB.
 
 ### Using App File
 
+<Tabs className="docs__val">
+
+<TabItem value="real" label="Real Device" default>
 <div className="lambdatest__codeblock">
 <CodeBlock className="language-bash">
-{`curl -u "${ YOUR_LAMBDATEST_USERNAME()}:${ YOUR_LAMBDATEST_ACCESS_KEY()}" -X POST "https://manual-api.lambdatest.com/app/upload/realDevice" -F "appFile=@"/Users/macuser/Downloads/Appname.apk"" -F "name="appname""
-`}
+{`curl -u "${ YOUR_LAMBDATEST_USERNAME()}:${ YOUR_LAMBDATEST_ACCESS_KEY()}" -X POST "https://manual-api.lambdatest.com/app/upload/realDevice" -F "appFile=@"/Users/macuser/Downloads/Appname.apk"" -F "name="appname""`}
+</CodeBlock>
+</div>
+</TabItem>
+
+<TabItem value="virtual" label="Virtual Device">
+<div className="lambdatest__codeblock">
+<CodeBlock className="language-bash">
+{`curl -u "${ YOUR_LAMBDATEST_USERNAME()}:${ YOUR_LAMBDATEST_ACCESS_KEY()}" -X POST "https://manual-api.lambdatest.com/app/upload/virtualDevice" -F "appFile=@"/Users/macuser/Downloads/Appname.apk"" -F "name="appname""`}
 </CodeBlock>
 </div>
+</TabItem>
+
+</Tabs>
 
 ### Using App URL
 
+<Tabs className="docs__val">
+
+<TabItem value="real" label="Real Device" default>
 <div className="lambdatest__codeblock">
 <CodeBlock className="language-bash">
 {`curl -u "${ YOUR_LAMBDATEST_USERNAME()}:${ YOUR_LAMBDATEST_ACCESS_KEY()}" -X POST "https://manual-api.lambdatest.com/app/upload/realDevice" -F "url=https://prod-mobile-artefacts.lambdatest.com/assets/docs/proverbial_android.apk" -F "name=Proverbial_App" -F "custom_id=sampleName" -F "storage=url" -F "visibility=individual"`}
 </CodeBlock>
 </div>
+</TabItem>
+
+<TabItem value="virtual" label="Virtual Device">
+<div className="lambdatest__codeblock">
+<CodeBlock className="language-bash">
+{`curl -u "${ YOUR_LAMBDATEST_USERNAME()}:${ YOUR_LAMBDATEST_ACCESS_KEY()}" -X POST "https://manual-api.lambdatest.com/app/upload/virtualDevice" -F "url=https://prod-mobile-artefacts.lambdatest.com/assets/docs/proverbial_android.apk" -F "name=Proverbial_App" -F "custom_id=sampleName" -F "storage=url" -F "visibility=individual"`}
+</CodeBlock>
+</div>
+</TabItem>
+
+</Tabs>
 
 - Response of above cURL will be a **JSON** object containing the `App URL` of the format - ``lt://APP123456789123456789``
 
 :::warning note
 The upload time of your application can range from a few seconds to a minute, depending on the size of your application. Therefore, do not interrupt the cURL command request until you receive the response.
 :::
 
-## Fetch your Applications
+## Fetch your Applications for Real Devices
 
 <Tabs className="docs__val">
 
@@ -129,10 +161,48 @@ Shown below is the response to the above cURL request.
 }
 ```
 
+## Fetch your Applications for Virtual Devices
+
+<Tabs className="docs__val">
+
+<TabItem value="android" label="Android" default>
+  <div className="lambdatest__codeblock">
+    <CodeBlock className="language-bash">
+  {`curl --location --request GET "https://${ YOUR_LAMBDATEST_USERNAME()}:${ YOUR_LAMBDATEST_ACCESS_KEY()}@manual-api.lambdatest.com/app/data?type=emulator&level=user"`}
+  </CodeBlock>
+</div>
+
+</TabItem>
+
+<TabItem value="ios" label="iOS" default>
+  <div className="lambdatest__codeblock">
+    <CodeBlock className="language-powershell">
+  {`curl --location --request GET "https://${ YOUR_LAMBDATEST_USERNAME()}:${ YOUR_LAMBDATEST_ACCESS_KEY()}@manual-api.lambdatest.com/app/data?type=simulator&level=user"`}
+  </CodeBlock>
+</div>
+
+</TabItem>
+</Tabs>
+
+
 ## Deleting your Application
 
-To delete your uploaded apps, run the below cURL command. 
+<Tabs className="docs__val">
+
+<TabItem value="real" label="Real Device" default>
+<div className="lambdatest__codeblock">
+<CodeBlock className="language-bash">
+{`curl --location --request DELETE "https://${ YOUR_LAMBDATEST_USERNAME()}:${ YOUR_LAMBDATEST_ACCESS_KEY()}@manual-api.lambdatest.com/app/delete" \
+--header 'Content-Type: application/json' \
+--data-raw '{
+    "appIds" : "APPID1,APPID2"
+}'
+`}
+</CodeBlock>
+</div>
+</TabItem>
 
+<TabItem value="virtual" label="Virtual Device">
 <div className="lambdatest__codeblock">
 <CodeBlock className="language-bash">
 {`curl --location --request DELETE "https://${ YOUR_LAMBDATEST_USERNAME()}:${ YOUR_LAMBDATEST_ACCESS_KEY()}@manual-api.lambdatest.com/app/delete" \
@@ -143,6 +213,9 @@ To delete your uploaded apps, run the below cURL command.
 `}
 </CodeBlock>
 </div>
+</TabItem>
+
+</Tabs>
 
 Shown below is the response to the above cURL request.
 
@@ -154,13 +227,30 @@ Shown below is the response to the above cURL request.
 
 ## Processing check for your Application
 
-To unlock features such as network logs, image injection, and screenshotunblock feature for your application, app needs to undergo a processing phase. This processing takes a few minutes after the application is uploaded. You can verify if the processing is complete before running your automation script using the following API.
+<Tabs className="docs__val">
 
+<TabItem value="real" label="Real Device" default>
 <div className="lambdatest__codeblock">
 <CodeBlock className="language-bash">
 {`curl --location --request POST 'https://mobile-api.lambdatest.com/mobile-automation/api/v1/fetchpatchedapkurl' \
 --header 'Authorization: Basic c2hhbnRhbnV3OkFPOEh3NHJtV2hxUlJZSVl3OEk1elMzajhCS0c2ZHl3SVBZeXNNSDJPakdtbFVheXZC' \
---header 'Content-Type: application/json' \y
+--header 'Content-Type: application/json' \
+--data-raw '{
+    "appId": "APP10160161171698993659206876",
+    "networkLogsEnabled": true,
+    "imageInjectionEnabled": true,
+    "screenshotUnblockEnabled": true
+}'`}
+</CodeBlock>
+</div>
+</TabItem>
+
+<TabItem value="virtual" label="Virtual Device">
+<div className="lambdatest__codeblock">
+<CodeBlock className="language-bash">
+{`curl --location --request POST 'https://mobile-api.lambdatest.com/mobile-automation/api/v1/fetchpatchedapkurl/virtualDevice' \
+--header 'Authorization: Basic c2hhbnRhbnV3OkFPOEh3NHJtV2hxUlJZSVl3OEk1elMzajhCS0c2ZHl3SVBZeXNNSDJPakdtbFVheXZC' \
+--header 'Content-Type: application/json' \
 --data-raw '{
     "appId": "APP10160161171698993659206876",
     "networkLogsEnabled": true,
@@ -169,6 +259,9 @@ To unlock features such as network logs, image injection, and screenshotunblock
 }'`}
 </CodeBlock>
 </div>
+</TabItem>
+
+</Tabs>
 
 The payload allows you to check the processing status for specific features. If the **patched_url** is empty, the processing is still in progress. To check if the processing for image injection or screenshot unblock is complete, pass either **imageInjectionEnabled** or **screenshotUnblockEnabled** as `true` based on the feature you are testing.
 

docs/application-setup-via-gui.md

@@ -20,6 +20,11 @@ import TabItem from '@theme/TabItem';
 import {YOUR_LAMBDATEST_USERNAME, YOUR_LAMBDATEST_ACCESS_KEY} from "@site/src/component/keys";
 import CodeBlock from '@theme/CodeBlock';
 import NewTag from '../src/component/newTag';
+import RealDeviceTag from '../src/component/realDevice';
+import VirtualDeviceTag from '../src/component/virtualDevice';
+
+<RealDeviceTag value="Real Device" /> 
+<VirtualDeviceTag value="Virtual Device" />
 
 <script type="application/ld+json"
       dangerouslySetInnerHTML={{ __html: JSON.stringify({
@@ -57,13 +62,26 @@ Wait for the file to upload and process. A success message will indicate when yo
 
 <img loading="lazy" src={require('../assets/images/appium-app/application/real-device-upload.gif').default} alt="Image" className="doc_img"/>
 
+
 > Learn how to [Upload Apps on LambdaTest’s Real Device Cloud](/support/docs/upload-apps-on-real-device-cloud/) in detail.
 
+:::info
+- You can access the [**Virtual Device Dashboard**](https://app.lambdatest.com/console/realtime/app).
+- For **Virtual Devices**, the steps remain identical to those for Real Devices.  
+- The only difference is that for **iOS applications**, you must upload a **.zip** file instead of an `.ipa` file, as simulators accept `.zip` format.  
+:::
+
 ## Automation Dashboard
 - **Access the App Automation Dashboard :** Log in to your LambdaTest account and navigate to the [App Automation Dashboard](https://appautomation.lambdatest.com/build).
 - **Upload the Application :** Click the Browse File button in the App tab under the Real Device or Virtual Device section. Select your application file from your local system:
   - **Android :** Upload a `.aab` or `.apk` file.
   - **iOS :** Upload an `.ipa` file.
 - **Copy the App URL :** After uploading, an `app_url` will be generated (format: `"lt://<app_url>"`). Copy this app_url and use it in your test scripts to identify your application.
 
-<img loading="lazy" src={require('../assets/images/appium-app/application/automation-upload.gif').default} alt="Image" className="doc_img"/>
+<img loading="lazy" src={require('../assets/images/appium-app/application/automation-upload.gif').default} alt="Image" className="doc_img"/>
+
+
+:::info
+- The **App Automation Dashboard** supports both **Real** and **Virtual Devices**.  
+- To perform testing on Virtual Devices, simply select the **Virtual Device** option during upload — the rest of the flow remains identical.
+:::

docs/desired-capabilities-in-appium.md

@@ -27,6 +27,9 @@ import {YOUR_LAMBDATEST_USERNAME, YOUR_LAMBDATEST_ACCESS_KEY} from "@site/src/co
 import RealDeviceTag from '../src/component/realDevice';
 import VirtualDeviceTag from '../src/component/virtualDevice';
 
+<RealDeviceTag value="Real Device" /> 
+<VirtualDeviceTag value="Virtual Device" />
+
 <script type="application/ld+json"
       dangerouslySetInnerHTML={{ __html: JSON.stringify({
        "@context": "https://schema.org",

docs/getting-started-with-flutter-dart-android-automation.md

@@ -44,7 +44,7 @@ import TabItem from '@theme/TabItem';
       })
     }}
 ></script>
-<RealDeviceTag value="Real Device" /> <VirtualDeviceTag value="Virtual Device" />
+<RealDeviceTag value="Real Device" /> 
 Flutter, an open-source UI toolkit created by Google, is a popular choice among developers to build natively compiled applications for mobile, web, and desktop from a single codebase. With Dart as its programming language, Flutter enables fast development of beautiful apps with a highly productive, extensible and open-source set of features.
 
 In this guide, we will explore how to run your first Flutter Dart test on an Android device using the LambdaTest Real Device Cloud. By combining the capabilities of Flutter Dart and LambdaTest, you can ensure the proper functioning of your app across different devices and make your app more reliable and robust.