Module - Core SDK

Sample Code:

await MyAppli.close();

Sample Code:

const isTerminated = await MyAppli.kill();

Sample Code:

const nb = MyAppli.count();

Sample Code:

if (MyAppli.exist()) { ... }

Sample Code:

MyAppli.MyPage.highlightItems();

Sample Code:

const instance = await $.MyAppli.getInstanceByIndex(0);

Sample Code:

await $.MyAppli.selectInstance($instance1);

Sample Code:

await MyAppli.start();

Sample Code:

await $.myAppli.waitNewInstance();

Sample Code:

// wait for end of 'myAppli' await myAppli.waitEnd();

Sample Code:

await MyAppli.setNavigator(irpa_core.enums.navigator.Chrome); // use Chrome for this application

Sample Code:

// connect HLLAPI channel on session 'A' await MyHllApiAppli.connect('A', function (res) { ... }); // connect HLLAPI channel, with a custom emulator await MyHllApiAppli.connect('A', function (res) { ... }, 'EHLAPI32.DLL', 'HLLAPI');

Sample Code:

await MyHllApiAppli.disconnect();

Sample Code:

// call the function res = await MyWebAppli.MyPage.oLogo.execScript(['changeObject', {src: ..., alt : ...}], 10000);

Sample Code:

const src = await MyWebAppli.MyPage.oLogo.scriptItem ('src'); // set an attribute await $.MyWebAppli.MyPage.oLogo.scriptItem ("src='http://....png'"); // multiple parameters update (using a list of individual parameters) await $.MyWebAppli.MyPage.oLogo.scriptItem ('src="http://....png"', 'alt="..."'); // multiple parameters update (using an object) await $.MyWebAppli.MyPage.oLogo.scriptItem ({src: 'http://....png', alt :'...', 'background-color': '#e8e8e8'}); // multiple parameters reading (using an object with 'null' attributes) const obj = {src: null, alt: null}; res = await $.MyWebAppli.MyPage.oLogo.scriptItem(obj); // returned 'obj' contains : {src: 'http://....png', alt :'...', }

Sample Code:

// insert a button with id 'idBtn', label 'Go', after item MyWebAppli.screens.MyScreen.btSearch res = await MyWebAppli.screens.MyScreen.elements.btSearch.insertButton('idBtn2', 'Go', '', {class: 'btn', style: 'width:260;height:24'}, irpa_core.enums.html.position.afterEnd);

Sample Code:

// insert a link with id 'btNewLink' after MyWebAppli.screens.MyScreen.elements.myElt, to navigate to Contextor site await MyWebAppli.screens.MyScreen.elements.myElt.insertLink('btNewLink', 'http://www.sap.com', 'Go to Contextor Site');

Sample Code:

// insert a link with id 'btNewLink_2' after MyWebAppli.screens.MyScreen.elements.myElt await MyWebAppli.screens.MyScreen.elements.myElt.insertLink('btNewLink_2', 'http://www.google.com', 'another new link', {class:'defaultLink'}, irpa_core.enums.html.position.afterEnd);

Sample Code:

const code = '<input class="nothing" id="myHtmlButton" type="button" value="My Html Button">'; res = await MyWebAppli.screens.MyScreen.insertHtml(code, myAppli.screens.myScreen.elements.myElt);

Sample Code:

let texts = await $.appli.page.item.getAll(); // texts contains : //[['', '0001362', '1', 'ford'], // ['', '0000132', '15', 'smith'], // ['', '0000937', '4', 'smith', 'ford'], // ['', '0001386', 'smith', 'jack'], // ['', '0000828', '15', 'smith', 'jack'], // ['', '0000265', '3', 'smith', 'jack'], // ['', '0000700', 'smith', 'ford']]

Sample Code:

// get the count of a '1' dimension array let nb = await $.myAppli.screens.myScreen.elements.btEdit.count(); // get the count of the first row of a '2' dimension array let nb = await $.myAppli.screens.myScreen.elements.oMap.i(0).count();

Sample Code:

const texts = await $.appli.page.item.getCol(2); // texts contains: // ['0001362', '0000132', '0000937', '0001386', '0000828', '0000265', '0000700']

Sample Code:

const map = await myAppli.screens.myScreen.elements.oCells.getRow(2);

Sample Code:

if (await $.myAppli.screens.myScreen.exist()) { ... }

Sample Code:

await myAppli.screens.myScreen.activate();

Sample Code:

await myAppli.screens.myScreen.deleteDynamicObjects();

Sample Code:

await $.myAppli.screens.myScreen.close();

Sample Code:

// get page content const obj = await myAppli.screens.myScreen.getRect(); // obj = {x:68, y:157, cx:120, cy:32}

Sample Code:

await myAppli.screens.myScreen.highlightItems();

Sample Code:

await $.myAppli.screens.myScreen.maximize();

Sample Code:

await $.myAppli.screens.myScreen.minimize();

Sample Code:

await $.MyUIAAppli.screens.MyScreen.refresh();

Sample Code:

// send a 'Alt F7' shortcut await $.myAppli.screens.myScreen.keyStroke(irpa_core.enums.key.Alt + irpa_core.enums.key.F7);

Sample Code:

await MyUIAAppli.MyScreen.lockRefresh();

Sample Code:

await MyUIAAppli.MyScreen.unlockRefresh();

Sample Code:

await MyUIAAppli.screens.MyScreen.startRefreshOnPolling();

Sample Code:

await MyUIAAppli.screens.MyScreen.stopRefreshOnPolling();

Sample Code:

await $.myAppli.screens.myScreen.restore();

Sample Code:

await $.myAppli.screens.myScreen.screenshot(irpa_core.path.log + '\\MyAppli.png');

Sample Code:

await $.myAppli.screens.myScreen.screenshotEx(irpa_core.path.log + '\\MyAppli.png', irpa_core.enums.imgType.imgTypeTIFF, {tiffCompression: "compressionLZW"}, undefined, {width: 100, x: 25, y: 50, height: 50})

Sample Code:

await MyWebAppli.screens.MyScreen.scrollWheel(-200);

Sample Code:

await $.myAppli.screens.myScreen.setPosition(50, 50, 600, 400);

Sample Code:

await myAppli.screens.myScreen.setTitle('New title');

Sample Code:

// WIN application: hide page await $.MyWinAppli.screens.MyScreen.setVisible(false);

Sample Code:

// WEB application: hide Address bar await $.MyWebAppli.screens.MyScreen.setVisible(false, irpa_core.enums.windowBarType.AddressBar);

Sample Code:

// wait for page 'MyAppli.screens.MyScreen' await $.myAppli.screens.myScreen.wait();

Sample Code:

// wait for page 'MyAppli.screens.MyScreen' await myAppli.screens.myScreen.waitClose();

Sample Code:

await $.MyAppli.screens.MyScreen.getScreenApplicationInstanceCount();

Sample Code:

await $.MyAppli.screens.MyScreen.getScreenApplicationInstanceByIndex();

Sample Code:

// click the menu 'Network' await MyWinAppli.screens.MyScreen.clickMenuItem('45'); // 45 is the menu numeric identifier

Sample Code:

if (await MyWinAppli.screens.MyScreen.isVisible()) { ... }

Sample Code:

// delete an object inserted in a Windows application await MyWinAppli.screens.MyScreen.deleteObject('6004'); // remove object with id 'btMyButton', await MyWebAppli.screens.MyScreen.deleteObject('btMyButton');

Sample Code:

// provide a single block of code to be executed: await MyWebAppli.screens.MyScreen.execScript('ReconnectToHub();'); // provide a list with function name, then parameters to be used: await MyWebAppli.screens.MyScreen.execScript(['SendAnswerToHub', req.info.destination.id, req.ev], 20000);

Sample Code:

// get page content const obj = await MyWebAppli.screens.MyScreen.getFocusRect(); // obj = {x:68, y:157, cx:350, cy:32}

Sample Code:

const title = await MyWebAppli.screens.MyScreen.historyBack();

Sample Code:

const title = await MyWebAppli.screens.MyScreen.historyForward();

Sample Code:

const title = await MyWebAppli.screens.MyScreen.historyGo(-2);

Sample Code:

// get page url const url = myAppli.screens.myScreen.getURL(); // url = 'http://www.sap.com'

Sample Code:

// navigate to a given URL, opened in a new tab. await $.MyWebAppli.screens.MyScreen.navigate('http://www....', irpa_core.enums.targetFrame.Blank);

Sample Code:

await MyWebAppli.screens.MyScreen.scrollTo(0, 0); // scrolls to the top of the page

Sample Code:

await MyWebAppli.screens.MyScreen.scrollBy(100, 0); // Scroll the document by 100px horizontally

Sample Code:

// start a page in normal mode await $.myAppli.screens.myScreen.start();

Sample Code:

// start a page in maximized mode await $.myAppli.screens.myScreen.start(null, null, null, irpa_core.enums.launchFlag.ShowMaximized);

Sample Code:

// start a page while precizing URL await $.myAppli.screens.myScreen.start('http://www.dokuwiki.org/');

Sample Code:

const name = MyUIAAppli.screens.MyScreen.listenWinEvents();

Sample Code:

MyUIAAppli.MyScreen.openConnection();

Sample Code:

MyUIAAppli.MyScreen.openConnectionByString();

Sample Code:

MyUIAAppli.MyScreen.closeConnection();

Sample Code:

const xml = await MyHllApiAppli.screens.MyScreen.getScreen();

Sample Code:

await MyHllApiAppli.screens.MyScreen.getLine(0);

Sample Code:

let texts = await $.appli.page.tvList.getList();

Sample Code:

// get the current selection in the tree view let val = await $.myAppli.screens.myScreen.elements.tvList.selected());

Sample Code:

// check the 'NAS' check box await $.myAppli.screens.myScreen.elements.oNAS.check(true); // check the 'Network' element in a tree view await $.myAppli.screens.myScreen.elements.tvTree.check(true, 'Network');

Sample Code:

await $.myAppli.screens.myScreen.elements.MyItem.set(data.edName);

Sample Code:

// click on button await $.myAppli.screens.myScreen.elements.btSearch.click (); // click on button with mouse simulation await $.myAppli.screens.myScreen.elements.btSearch.click(true);

Sample Code:

await $.myAppli.screens.myScreen.elements.btSearch.clickSync();

Sample Code:

await $.myAppli.screens.myScreen.elements.btOK.clickMouse();

Sample Code:

// double click on button await $.myAppli.screens.myScreen.elements.btOK.clickDouble(x,y); // double click on button, with specific position await $.myAppli.screens.myScreen.elements.btSearch.clickDouble(30, 20);

Sample Code:

// double click on button await $.myAppli.screens.myScreen.elements.btSearch.clickRight(); // double click on button, with specific position await $.myAppli.screens.myScreen.elements.btSearch.clickRight(true, 30, 20);

Sample Code:

if (await myAppli.screens.myScreen.elements.btSearch.exist()) { ... }

Sample Code:

const name = await myAppli.screens.myScreen.elements.tvList.getProperty('Name');

Sample Code:

// get page content let r = await myAppli.screens.myScreen.elements.edSearch.getRect(); // r = {x:68, y:157, cx:120, cy:32}

Sample Code:

await myAppli.screens.myScreen.elements.MyItem.highlight();

Sample Code:

if (await myAppli.screens.myScreen.elements.btSearch.isEnabled()) { ... }

Sample Code:

if (await myAppli.screens.myScreen.elements.btSearch.isVisible()) { ... }

Sample Code:

// set address, then send 'Enter key' await $.myAppli.screens.myScreen.elements.edSearch.set(searchAddress); await $.myAppli.screens.myScreen.elements.edSearch.keyStroke(irpa_core.enums.key.Enter);

Sample Code:

await $.MyUIAAppli.MyPage.tvList.refresh();

Sample Code:

// select the 'Network' element in a tree view await $.myAppli.screens.myScreen.elements.tvList.select('Network');

Sample Code:

await $.myAppli.screens.myScreen.elements.MyItem.setFocus();

Sample Code:

// wait for page 'myAppli.screens.myScreen.elements.MyItem' await myAppli.screens.myScreen.elements.MyItem.wait();

Sample Code:

let strXml = await $.myAppli.screens.myScreen.elements.edName.xml();