diff --git a/404.html b/404.html index 32e489817..d216daa34 100644 --- a/404.html +++ b/404.html @@ -13,7 +13,7 @@ - +
diff --git a/assets/js/634079bb.3e44a621.js b/assets/js/634079bb.3e44a621.js new file mode 100644 index 000000000..69eccd488 --- /dev/null +++ b/assets/js/634079bb.3e44a621.js @@ -0,0 +1 @@ +"use strict";(self.webpackChunk_rnx_kit_docsite=self.webpackChunk_rnx_kit_docsite||[]).push([[2794],{4364:(e,t,d)=>{d.r(t),d.d(t,{assets:()=>c,contentTitle:()=>n,default:()=>h,frontMatter:()=>r,metadata:()=>o,toc:()=>l});var i=d(4848),s=d(8453);const r={},n="tools-android",o={id:"tools/tools-android",title:"tools-android",description:"@rnx-kit/tools-android is a collection of functions for deploying apps on",source:"@site/docs/tools/tools-android.md",sourceDirName:"tools",slug:"/tools/tools-android",permalink:"/rnx-kit/docs/tools/tools-android",draft:!1,unlisted:!1,editUrl:"https://github.com/microsoft/rnx-kit/tree/main/docsite/docs/tools/tools-android.md",tags:[],version:"current",frontMatter:{},sidebar:"toolsSidebar",previous:{title:"third-party-notices",permalink:"/rnx-kit/docs/tools/third-party-notices"},next:{title:"tools-apple",permalink:"/rnx-kit/docs/tools/tools-apple"}},c={},l=[];function a(e){const t={code:"code",h1:"h1",header:"header",p:"p",pre:"pre",table:"table",tbody:"tbody",td:"td",th:"th",thead:"thead",tr:"tr",...(0,s.R)(),...e.components};return(0,i.jsxs)(i.Fragment,{children:[(0,i.jsx)(t.header,{children:(0,i.jsx)(t.h1,{id:"tools-android",children:"tools-android"})}),"\n",(0,i.jsxs)(t.p,{children:[(0,i.jsx)(t.code,{children:"@rnx-kit/tools-android"})," is a collection of functions for deploying apps on\nAndroid."]}),"\n",(0,i.jsx)(t.p,{children:"Usage:"}),"\n",(0,i.jsx)(t.pre,{children:(0,i.jsx)(t.code,{className:"language-typescript",children:'import * as tools from "@rnx-kit/tools-android";\n'})}),"\n",(0,i.jsxs)(t.table,{children:[(0,i.jsx)(t.thead,{children:(0,i.jsxs)(t.tr,{children:[(0,i.jsx)(t.th,{children:"Category"}),(0,i.jsx)(t.th,{children:"Function"}),(0,i.jsx)(t.th,{children:"Description"})]})}),(0,i.jsxs)(t.tbody,{children:[(0,i.jsxs)(t.tr,{children:[(0,i.jsx)(t.td,{children:"apk"}),(0,i.jsx)(t.td,{children:(0,i.jsx)(t.code,{children:"getPackageName(apk)"})}),(0,i.jsx)(t.td,{children:"Returns the package name and the first launchable activity of the specified APK."})]}),(0,i.jsxs)(t.tr,{children:[(0,i.jsx)(t.td,{children:"apk"}),(0,i.jsx)(t.td,{children:(0,i.jsx)(t.code,{children:"install(device, apk, packageName)"})}),(0,i.jsx)(t.td,{children:"Installs the specified APK on specified emulator or physical device."})]}),(0,i.jsxs)(t.tr,{children:[(0,i.jsx)(t.td,{children:"apk"}),(0,i.jsx)(t.td,{children:(0,i.jsx)(t.code,{children:"start(options, packageName, activityName)"})}),(0,i.jsx)(t.td,{children:"Starts the specified activity on specified emulator or physical device."})]}),(0,i.jsxs)(t.tr,{children:[(0,i.jsx)(t.td,{children:"device"}),(0,i.jsx)(t.td,{children:(0,i.jsx)(t.code,{children:"getDevices()"})}),(0,i.jsx)(t.td,{children:"Returns a list of attached physical Android devices."})]}),(0,i.jsxs)(t.tr,{children:[(0,i.jsx)(t.td,{children:"device"}),(0,i.jsx)(t.td,{children:(0,i.jsx)(t.code,{children:"getEmulators()"})}),(0,i.jsx)(t.td,{children:"Returns a list of available Android virtual devices."})]}),(0,i.jsxs)(t.tr,{children:[(0,i.jsx)(t.td,{children:"device"}),(0,i.jsx)(t.td,{children:(0,i.jsx)(t.code,{children:"launchEmulator(emulatorName)"})}),(0,i.jsx)(t.td,{children:"Launches the emulator with the specified name."})]}),(0,i.jsxs)(t.tr,{children:[(0,i.jsx)(t.td,{children:"device"}),(0,i.jsx)(t.td,{children:(0,i.jsx)(t.code,{children:"selectDevice(emulatorName, logger)"})}),(0,i.jsx)(t.td,{children:"Returns the emulator or physical device with the specified name."})]}),(0,i.jsxs)(t.tr,{children:[(0,i.jsx)(t.td,{children:"gradle"}),(0,i.jsx)(t.td,{children:(0,i.jsx)(t.code,{children:"assemble(projectDir, buildParams)"})}),(0,i.jsx)(t.td,{children:"Invokes Gradle build."})]}),(0,i.jsxs)(t.tr,{children:[(0,i.jsx)(t.td,{children:"gradle"}),(0,i.jsx)(t.td,{children:(0,i.jsx)(t.code,{children:"findOutputFile(projectDir, buildConfiguration)"})}),(0,i.jsx)(t.td,{children:"Tries to find Gradle build output file."})]}),(0,i.jsxs)(t.tr,{children:[(0,i.jsx)(t.td,{children:"sdk"}),(0,i.jsx)(t.td,{children:(0,i.jsx)(t.code,{children:"getBuildToolsPath()"})}),(0,i.jsx)(t.td,{children:"Returns the path to Android SDK Build-Tools."})]})]})]})]})}function h(e={}){const{wrapper:t}={...(0,s.R)(),...e.components};return t?(0,i.jsx)(t,{...e,children:(0,i.jsx)(a,{...e})}):a(e)}},8453:(e,t,d)=>{d.d(t,{R:()=>n,x:()=>o});var i=d(6540);const s={},r=i.createContext(s);function n(e){const t=i.useContext(r);return i.useMemo((function(){return"function"==typeof e?e(t):{...t,...e}}),[t,e])}function o(e){let t;return t=e.disableParentContext?"function"==typeof e.components?e.components(s):e.components||s:n(e.components),i.createElement(r.Provider,{value:t},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/634079bb.b175e166.js b/assets/js/634079bb.b175e166.js deleted file mode 100644 index 2a7887598..000000000 --- a/assets/js/634079bb.b175e166.js +++ /dev/null @@ -1 +0,0 @@ -"use strict";(self.webpackChunk_rnx_kit_docsite=self.webpackChunk_rnx_kit_docsite||[]).push([[2794],{4364:(e,t,s)=>{s.r(t),s.d(t,{assets:()=>c,contentTitle:()=>o,default:()=>h,frontMatter:()=>i,metadata:()=>r,toc:()=>l});var d=s(4848),n=s(8453);const i={},o="tools-android",r={id:"tools/tools-android",title:"tools-android",description:"@rnx-kit/tools-android is a collection of functions for deploying apps on",source:"@site/docs/tools/tools-android.md",sourceDirName:"tools",slug:"/tools/tools-android",permalink:"/rnx-kit/docs/tools/tools-android",draft:!1,unlisted:!1,editUrl:"https://github.com/microsoft/rnx-kit/tree/main/docsite/docs/tools/tools-android.md",tags:[],version:"current",frontMatter:{},sidebar:"toolsSidebar",previous:{title:"third-party-notices",permalink:"/rnx-kit/docs/tools/third-party-notices"},next:{title:"tools-apple",permalink:"/rnx-kit/docs/tools/tools-apple"}},c={},l=[];function a(e){const t={code:"code",h1:"h1",header:"header",p:"p",pre:"pre",table:"table",tbody:"tbody",td:"td",th:"th",thead:"thead",tr:"tr",...(0,n.R)(),...e.components};return(0,d.jsxs)(d.Fragment,{children:[(0,d.jsx)(t.header,{children:(0,d.jsx)(t.h1,{id:"tools-android",children:"tools-android"})}),"\n",(0,d.jsxs)(t.p,{children:[(0,d.jsx)(t.code,{children:"@rnx-kit/tools-android"})," is a collection of functions for deploying apps on\nAndroid."]}),"\n",(0,d.jsx)(t.p,{children:"Usage:"}),"\n",(0,d.jsx)(t.pre,{children:(0,d.jsx)(t.code,{className:"language-typescript",children:'import * as tools from "@rnx-kit/tools-android";\n'})}),"\n",(0,d.jsxs)(t.table,{children:[(0,d.jsx)(t.thead,{children:(0,d.jsxs)(t.tr,{children:[(0,d.jsx)(t.th,{children:"Category"}),(0,d.jsx)(t.th,{children:"Function"}),(0,d.jsx)(t.th,{children:"Description"})]})}),(0,d.jsxs)(t.tbody,{children:[(0,d.jsxs)(t.tr,{children:[(0,d.jsx)(t.td,{children:"-"}),(0,d.jsx)(t.td,{children:(0,d.jsx)(t.code,{children:"getBuildToolsPath()"})}),(0,d.jsx)(t.td,{children:"Returns the path to Android SDK Build-Tools."})]}),(0,d.jsxs)(t.tr,{children:[(0,d.jsx)(t.td,{children:"-"}),(0,d.jsx)(t.td,{children:(0,d.jsx)(t.code,{children:"getDevices()"})}),(0,d.jsx)(t.td,{children:"Returns a list of attached physical Android devices."})]}),(0,d.jsxs)(t.tr,{children:[(0,d.jsx)(t.td,{children:"-"}),(0,d.jsx)(t.td,{children:(0,d.jsx)(t.code,{children:"getEmulators()"})}),(0,d.jsx)(t.td,{children:"Returns a list of available Android virtual devices."})]}),(0,d.jsxs)(t.tr,{children:[(0,d.jsx)(t.td,{children:"-"}),(0,d.jsx)(t.td,{children:(0,d.jsx)(t.code,{children:"getPackageName(apk)"})}),(0,d.jsx)(t.td,{children:"Returns the package name and the first launchable activity of the specified APK."})]}),(0,d.jsxs)(t.tr,{children:[(0,d.jsx)(t.td,{children:"-"}),(0,d.jsx)(t.td,{children:(0,d.jsx)(t.code,{children:"install(device, apk, packageName)"})}),(0,d.jsx)(t.td,{children:"Installs the specified APK on specified emulator or physical device."})]}),(0,d.jsxs)(t.tr,{children:[(0,d.jsx)(t.td,{children:"-"}),(0,d.jsx)(t.td,{children:(0,d.jsx)(t.code,{children:"launchEmulator(emulatorName)"})}),(0,d.jsx)(t.td,{children:"Launches the emulator with the specified name."})]}),(0,d.jsxs)(t.tr,{children:[(0,d.jsx)(t.td,{children:"-"}),(0,d.jsx)(t.td,{children:(0,d.jsx)(t.code,{children:"selectDevice(emulatorName, logger)"})}),(0,d.jsx)(t.td,{children:"Returns the emulator or physical device with the specified name."})]}),(0,d.jsxs)(t.tr,{children:[(0,d.jsx)(t.td,{children:"-"}),(0,d.jsx)(t.td,{children:(0,d.jsx)(t.code,{children:"start(options, packageName, activityName)"})}),(0,d.jsx)(t.td,{children:"Starts the specified activity on specified emulator or physical device."})]})]})]})]})}function h(e={}){const{wrapper:t}={...(0,n.R)(),...e.components};return t?(0,d.jsx)(t,{...e,children:(0,d.jsx)(a,{...e})}):a(e)}},8453:(e,t,s)=>{s.d(t,{R:()=>o,x:()=>r});var d=s(6540);const n={},i=d.createContext(n);function o(e){const t=d.useContext(i);return d.useMemo((function(){return"function"==typeof e?e(t):{...t,...e}}),[t,e])}function r(e){let t;return t=e.disableParentContext?"function"==typeof e.components?e.components(n):e.components||n:o(e.components),d.createElement(i.Provider,{value:t},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/runtime~main.253e6381.js b/assets/js/runtime~main.7d5d8c82.js similarity index 99% rename from assets/js/runtime~main.253e6381.js rename to assets/js/runtime~main.7d5d8c82.js index 67694f2e3..5fc52a6a1 100644 --- a/assets/js/runtime~main.253e6381.js +++ b/assets/js/runtime~main.7d5d8c82.js @@ -1 +1 @@ -(()=>{"use strict";var e,a,c,d,f,t={},r={};function b(e){var a=r[e];if(void 0!==a)return a.exports;var c=r[e]={id:e,loaded:!1,exports:{}};return t[e].call(c.exports,c,c.exports,b),c.loaded=!0,c.exports}b.m=t,b.c=r,e=[],b.O=(a,c,d,f)=>{if(!c){var t=1/0;for(i=0;iUsage:
import * as tools from "@rnx-kit/tools-android";
Category | Function | Description |
---|---|---|
- | getBuildToolsPath() | Returns the path to Android SDK Build-Tools. |
- | getDevices() | Returns a list of attached physical Android devices. |
- | getEmulators() | Returns a list of available Android virtual devices. |
- | getPackageName(apk) | Returns the package name and the first launchable activity of the specified APK. |
- | install(device, apk, packageName) | Installs the specified APK on specified emulator or physical device. |
- | launchEmulator(emulatorName) | Launches the emulator with the specified name. |
- | selectDevice(emulatorName, logger) | Returns the emulator or physical device with the specified name. |
- | start(options, packageName, activityName) | Starts the specified activity on specified emulator or physical device. |
Category | Function | Description |
---|---|---|
apk | getPackageName(apk) | Returns the package name and the first launchable activity of the specified APK. |
apk | install(device, apk, packageName) | Installs the specified APK on specified emulator or physical device. |
apk | start(options, packageName, activityName) | Starts the specified activity on specified emulator or physical device. |
device | getDevices() | Returns a list of attached physical Android devices. |
device | getEmulators() | Returns a list of available Android virtual devices. |
device | launchEmulator(emulatorName) | Launches the emulator with the specified name. |
device | selectDevice(emulatorName, logger) | Returns the emulator or physical device with the specified name. |
gradle | assemble(projectDir, buildParams) | Invokes Gradle build. |
gradle | findOutputFile(projectDir, buildConfiguration) | Tries to find Gradle build output file. |
sdk | getBuildToolsPath() | Returns the path to Android SDK Build-Tools. |