API Quick Reference

AnkuLua
Administrator

Posts: 3,535

API Quick Reference Sept 28, 2016 9:39:48 GMT mikronex, Devn00b, and 4 more like this

Quote

Post by AnkuLua on Sept 28, 2016 9:39:48 GMT

Objects
Location
Pattern
Region
Match

Basic Methods (Sikuli Compatible)
click()
find()
findAll()
wait()
exists()
waitVanish()
dragDrop()
     setDragDropTiming(), setDragDropStepCount(), setDragDropStepInterval()
type()
getLastMatch()
highlight()
     setHighlightStyle()
     setHighlightTextStyle()
highlightOff()
highlightUpdate()

Other Methods (Not in Sikuli)
waitClick()
existsClick()
findAllNoFindException()
regionFindAllNoFindException()
doubleClick()
keyevent()
swipe()
touchDown(), touchMove(), touchUp()
manualTouch()
setManualTouchParameter()
save()
saveColor()
scriptPath()
getLanguage()
getCountry()
getVersion()
getAndroidVersion()
getDeviceID(), getIMEI(), getSIMSerial(), getIMSI(), getWiFiMAC(), getMacAddr()
getUserID()
setClipboard()
typeOf()

Settings Methods
Settings:setCompareDimension()
setImmersiveMode()
autoGameArea()
getGameArea()
setGameArea()
getAppUsableScreenSize()
getRealScreenSize()
Settings:setScriptDimension()
setImagePath()
Settings:set()
Settings:get()
usePreviousSnap()
snapshot()
snapshotColor()
setAlternativeClick()
ImageCache
ImageCache:setCheckEnable()
ImageCache:setUpdateEnable()
ImageCache:setImageSizeLimit()
    ImageCache:setCacheNumber()
Settings:snapSet()

User Interface methods
toast()
dialogInit()
addTextView()
addEditText()
addEditPassword()
addEditNumber()
addCheckBox()
newRow()
addRadioGroup()
addRadioButton()
addRelativeRadioGroup()
addRelativeRadioGroupNewRow()
addSpinner()
addSpinnerIndex()
addSpinnerIndex()
addSeparator()
dialogShow()
dialogShowFullScreen()
removePreference()
preferencePutString(), preferencePutNumber(), preferencePutBoolean()
preferenceGetString(), preferenceGetNumber(), preferenceGetBoolean()
setButtonPosition()

Advanced Methods
zoom()
continueClick()
continueClick()
setContinueClickTiming()
continueMultiTouch()
longClick()
stopLongClick()
numberOCR()
numberOCRNoFindException()
charOCR()
charOCRNoFindException()
getColor()
getTouchEvent()
     setTouchEventStyle()
playMusic()
stopMusic()
vibrate()
setVolumeDetect()
isVolumeUp(), isVolumeDown()
Timer()
     set()
     check()
setScanInterval(), setScanRate(), getScanInterval(), getScanRate()
setBrightness(), getBrightness()
getNetworkTime()
scriptExit()
setStopMessage()
chargerConnected()
batteryLevel()
isEmulator()
startApp()
killApp()
unzip()
isRecoveredFromKilled()
setRecoveredFromKilled()
halfCompareDimension()

setHttpTimeout()
httpGet()
httpPost()
httpDownload()
openUrl()
sendEmail()
setExceptionEmail()
setRewardAccount()

Last Edit: Jul 2, 2023 14:05:09 GMT by AnkuLua

--
Discord: discord.gg/CyFfZWKqMW
Messenger: www.facebook.com/app.ankulua/
Email: ankulua@gmail.com

Franky Contributors Posts: 127	API Quick Reference Sept 28, 2016 14:09:44 GMT Quote Select Post Deselect Post Link to Post Member Give Gift Back to Top Post by Franky on Sept 28, 2016 14:09:44 GMT handy. Shouldn't these functions be here too?: chargerConnected() isEmulator() getRealScreenSize() getAppUsableScreenSize()
	Have you tried my BDM Utils?

AnkuLua Administrator Posts: 3,535	API Quick Reference Sept 28, 2016 14:29:27 GMT Quote Select Post Deselect Post Link to Post Member Give Gift Back to Top Post by AnkuLua on Sept 28, 2016 14:29:27 GMT Sept 28, 2016 14:09:44 GMT Franky said: handy. Shouldn't these functions be here too?: chargerConnected() isEmulator() getRealScreenSize() getAppUsableScreenSize() Thanks for reminding. Added.
	-- Discord: discord.gg/CyFfZWKqMW Messenger: www.facebook.com/app.ankulua/ Email: ankulua@gmail.com

mikronex New Member Posts: 8	API Quick Reference Sept 29, 2016 7:41:03 GMT Quote Select Post Deselect Post Link to Post Member Give Gift Back to Top Post by mikronex on Sept 29, 2016 7:41:03 GMT Thanks! Well organized.

Devn00b New Member Posts: 12	API Quick Reference Nov 15, 2016 2:42:30 GMT via Tapatalk Quote Select Post Deselect Post Link to Post Member Give Gift Back to Top Post by Devn00b on Nov 15, 2016 2:42:30 GMT getTime() local clock. I want automate punch in/ punch out for my job.. via mini android pc. T=getTime() -- localtime If T=0800 then Ble ble ble.. End

AnkuLua
Administrator

Posts: 3,535

API Quick Reference Nov 15, 2016 4:21:13 GMT Devn00b likes this

Quote

Post by AnkuLua on Nov 15, 2016 4:21:13 GMT

Nov 15, 2016 2:42:30 GMT Devn00b said:

getTime() local clock.
I want automate punch in/ punch out for my job.. via mini android pc.
T=getTime() -- localtime
If T=0800 then
Ble ble ble..
End

Try this

oclock = 0 + os.date("%H")

if (oclock == 8) then

  -- do what you want
end

--
Discord: discord.gg/CyFfZWKqMW
Messenger: www.facebook.com/app.ankulua/
Email: ankulua@gmail.com

vampiredbr9 Contributors Posts: 91	API Quick Reference Jan 29, 2017 20:09:01 GMT via mobile Devn00b likes this Quote Select Post Deselect Post Link to Post Member Give Gift Back to Top Post by vampiredbr9 on Jan 29, 2017 20:09:01 GMT Can't see doFile()
	Check out my clash royale bot here: ankulua.boards.net/thread/245/clash-royale-featuring-auto-battle

AnkuLua Administrator Posts: 3,535	API Quick Reference Jan 30, 2017 0:04:04 GMT Quote Select Post Deselect Post Link to Post Member Give Gift Back to Top Post by AnkuLua on Jan 30, 2017 0:04:04 GMT dofile() is lua embedded. Only AnkuLua's special functions are listed.
	-- Discord: discord.gg/CyFfZWKqMW Messenger: www.facebook.com/app.ankulua/ Email: ankulua@gmail.com

vampiredbr9 Contributors Posts: 91	API Quick Reference Jan 30, 2017 23:27:56 GMT via mobile Quote Select Post Deselect Post Link to Post Member Give Gift Back to Top Post by vampiredbr9 on Jan 30, 2017 23:27:56 GMT Jan 30, 2017 0:04:04 GMT AnkuLua said: dofile() is lua embedded. Only AnkuLua's special functions are listed. Oh- ok. Thanks for quick response
	Check out my clash royale bot here: ankulua.boards.net/thread/245/clash-royale-featuring-auto-battle

chezzy New Member Posts: 20	API Quick Reference Apr 22, 2017 13:28:41 GMT Quote Select Post Deselect Post Link to Post Member Give Gift Back to Top Post by chezzy on Apr 22, 2017 13:28:41 GMT It would be great to have opposite of startApp() to exit apps.

mikronex New Member Posts: 8	API Quick Reference Apr 22, 2017 13:32:48 GMT via mobile Quote Select Post Deselect Post Link to Post Member Give Gift Back to Top Post by mikronex on Apr 22, 2017 13:32:48 GMT Apr 22, 2017 13:28:41 GMT chezzy said: It would be great to have opposite of startApp() to exit apps. Try this: keyevent(187) swipe(Location(x1, y1), Location(x2, y1))
	Last Edit: Apr 22, 2017 13:36:26 GMT by mikronex

chezzy
New Member

Posts: 20

API Quick Reference Apr 23, 2017 22:19:57 GMT

Quote

Post by chezzy on Apr 23, 2017 22:19:57 GMT

Apr 22, 2017 13:32:48 GMT mikronex said:

Apr 22, 2017 13:28:41 GMT chezzy said:

It would be great to have opposite of startApp() to exit apps.

Try this:

keyevent(187)
swipe(Location(x1, y1), Location(x2, y1))

Yeah problem is I need to to exit app that is running in the background (qpython console), but its nothing crucial, it would just be nice to have such simple way to kill apps as to start them. but I know things that seems easy from user point of view might be very hard from developers point of view.
BTW: are your from Czech republic? Im asking because of your avatar

Last Edit: Apr 23, 2017 22:22:47 GMT by chezzy

noncombat
Contributors

Posts: 34

API Quick Reference May 6, 2018 19:41:36 GMT zouna likes this

Quote

Post by noncombat on May 6, 2018 19:41:36 GMT

Hey maybe this could be in the API

clickRandomRegion()
clickRandomLocation()
waitMs()
waitMsRandom(min ms, max ms)
highlightLastClick() -> Debug purpose mostly the cirle of Show Touch in Android is very small a bigger circle would be nice.

AnkuLua
Administrator

Posts: 3,535

API Quick Reference May 7, 2018 1:01:16 GMT

Quote

Post by AnkuLua on May 7, 2018 1:01:16 GMT

May 6, 2018 19:41:36 GMT noncombat said:

Hey maybe this could be in the API

clickRandomRegion()
clickRandomLocation()
waitMs()
waitMsRandom(min ms, max ms)
highlightLastClick() -> Debug purpose mostly the cirle of Show Touch in Android is very small a bigger circle would be nice.

You could add it in your library.

--
Discord: discord.gg/CyFfZWKqMW
Messenger: www.facebook.com/app.ankulua/
Email: ankulua@gmail.com

noncombat Contributors Posts: 34	API Quick Reference May 10, 2018 15:33:29 GMT via mobile Mercobots, Exilereven, and 1 more like this Quote Select Post Deselect Post Link to Post Member Give Gift Back to Top Post by noncombat on May 10, 2018 15:33:29 GMT Hi AnkuLua, is it possible to have an function getActiveUsers() which will return an integer depending on how many users are running the script?

News

Post by AnkuLua on Sept 28, 2016 9:39:48 GMT

Post by Franky on Sept 28, 2016 14:09:44 GMT

Post by AnkuLua on Sept 28, 2016 14:29:27 GMT

Post by mikronex on Sept 29, 2016 7:41:03 GMT

Post by Devn00b on Nov 15, 2016 2:42:30 GMT

Post by AnkuLua on Nov 15, 2016 4:21:13 GMT

Post by vampiredbr9 on Jan 29, 2017 20:09:01 GMT

Post by AnkuLua on Jan 30, 2017 0:04:04 GMT

Post by vampiredbr9 on Jan 30, 2017 23:27:56 GMT

Post by chezzy on Apr 22, 2017 13:28:41 GMT

Post by mikronex on Apr 22, 2017 13:32:48 GMT

Post by chezzy on Apr 23, 2017 22:19:57 GMT

Post by noncombat on May 6, 2018 19:41:36 GMT

Post by AnkuLua on May 7, 2018 1:01:16 GMT

Post by noncombat on May 10, 2018 15:33:29 GMT