-
Notifications
You must be signed in to change notification settings - Fork 3
Home
Jonas Gossens edited this page May 7, 2018
·
15 revisions
The chayns® JavaScript API allows you to expand your Tapp with many useful features, like
- Working with the chayns.ready promise.
To read initial user data or execute functions after the tapp is loaded, you need to call the 'chayns.ready' promise. - Reading additional user data.
The chayns.env object allows you to read further user data from the chayns framework.
In addition chayns provides a lot of functions and helpers. See the following table of contents to get an overview of this features.
To get started, you can follow this wiki or alternatively take a look at the chayns® css wiki.
- Home
- Getting Started
- Pagemaker Iframes
- Environment Variables
-
Basic Functions
- chayns.login(parameters)
- chayns.getUser(config)
- chayns.getUacGroups(siteId, updateCache)
- chayns.allowRefreshScroll()
- chayns.disallowRefreshScroll()
- chayns.showTitleImage()
- chayns.hideTitleImage()
- chayns.setOnActivateCallback(callback)
- chayns.setNetworkChangeCallback(callback, ongoing)
- chayns.setNfcCallback(callback, ongoing)
- chayns.removeNfcCallback()
- chayns.startNfcDetection(callback, interval, vibrate)
- chayns.stopNfcDetection()
- chayns.scanQRCode()
- chayns.createQRCode(text)
- chayns.showFinetradingQRCode()
- chayns.selectTapp(tapp, parameter)
- chayns.openUrl(config)
- chayns.closeUrl()
- chayns.openUrlInBrowser(url)
- chayns.getGeoLocation()
- chayns.getLocationBeacons(forceReload)
- chayns.getBeaconHistory(subNumber)
- chayns.share(config)
- chayns.getBaseColor(color, colorMode)
- chayns.getSchemeColor(saturation, color)
- chayns.getWindowMetrics()
- chayns.getAvailableSharingServices()
- chayns.intercom.sendMessageToUser(userId, config)
- chayns.intercom.sendMessageToGroup(groupId, config)
- chayns.intercom.sendMessageToPage(config)
- chayns.navigateBack()
- chayns.updateNavigation(tappId, config)
- chayns.enableDisplayTimeout()
- chayns.disableDisplayTimeout()
- chayns.setSpeechToText(title, callback)
- chayns.createTappShortcut(name, imageUrl)
- chayns.setSubTapp(config)
- chayns.removeSubTapp(config)
- chayns.vibrate(ms)
- chayns.setHeight(config)
- chayns.scrollToY(position)
- chayns.addToWallet(passbook)
- chayns.passKit.getInstalled()
- chayns.passKit.isInstalled(identifier)
- chayns.addScrollListener(callback, throttle)
- chayns.setScreenOrientation(orientation)
- chayns.findSite(name, skip, take)
- UI Functions
- Media Functions
- Utility Functions
<!-- To get started.. -->
<!-- Load the chayns API styles and JavaScript from our server -->
<!-- css styles -->
<script src="https://api.chayns-static.space/css/v4/compatibility/compatibility.min.js" version="4.2"></script>
<!-- js api -->
<script src="https://api.chayns-static.space/js/v4.0/chayns.min.js"></script>