Table Of ContentKony
Mobile Application Development
Platform (MADP)
API Developer's Guide
Release 7.0 Beta
DocumentRelevanceandAccuracy
ThisdocumentisconsideredrelevanttotheReleasestatedonthistitlepageandthedocumentversion
statedontheRevisionHistorypage.Remembertoalwaysviewanddownloadthelatestdocument
versionrelevanttothesoftwarereleaseyouareusing.
©2016byKony,Inc.Allrightsreserved 1of838
KonyStudioAPI Developer'sGuide
Version3.1
Copyright©2015Kony,Inc.
Allrightsreserved.
January,2016
ThisdocumentcontainsinformationproprietarytoKony,Inc.,isboundbytheKonylicense
agreements,andmaynotbeusedexceptinthecontextofunderstandingtheuseandmethodsof
Kony,Inc.,softwarewithoutprior,express,writtenpermission.Kony,EmpoweringEverywhere,Kony
Modeler,andKonyVisualizeraretrademarksofKony,Inc.MobileFabricisaregisteredtrademarkof
Kony,Inc.Microsoft,theMicrosoftlogo,InternetExplorer,Windows,andWindowsVistaare
registeredtrademarksofMicrosoftCorporation.Apple,theApplelogo,iTunes,iPhone,iPad,OSX,
Objective-C,Safari,ApplePay,AppleWatch,andXcodearetrademarksorregisteredtrademarksof
Apple,Inc.Google,theGooglelogo,Android,andtheAndroidlogoareregisteredtrademarksof
Google,Inc.ChromeisatrademarkofGoogle,Inc.BlackBerry,PlayBook,ResearchinMotion,and
RIMareregisteredtrademarksofBlackBerry.Allotherterms,trademarks,orservicemarks
mentionedinthisdocumenthavebeencapitalizedandaretobeconsideredthepropertyoftheir
respectiveowners.
©2016byKony,Inc.Allrightsreserved 2of838
KonyStudioAPI Developer'sGuide
Version3.1
Revision History
Date DocumentVersion Description ofModifications/Release
13/1/2016 3.1 AddedtheAppGroupAPI.
Addedfunctionsinthekony.imagenamespace.
11/10/2015 3.0 Followinginformationadded:
SelfSufficientModules
l
TouchIDAPIs
l
07/13/2015 2.0 Followinginformationisadded:
MobileFirstAPIs
l
ThreadingAPIs
l
Wearables-KonyWatchKitLibraryUtils
l
05/19/2015 1.0 Followinginformationisadded:
LocalNotifications
l
NotificationSettings
l
Wearables
l
setApplicationCallbacksupdatedfor
l
iOS
©2016byKony,Inc.Allrightsreserved 3of838
KonyStudioAPI Developer'sGuide
Version3.1
Table of Contents
1. Preface 9
1.1 Purpose 9
1.2 IntendedAudience 9
1.3 FormattingConventions 9
1.4 RelatedDocuments 11
1.5 ContactUs 11
2. Overview 12
2.1 PlatformAvailability 14
2.2 AccelerometerAPIs 18
2.3 AlertAPI 20
2.4 AppGroupAPI 20
2.5 ApplicationAPIs 22
2.6 ApplicationSettingsAPI 24
2.7 BackgroundJobs 25
2.8 BadgeAPIs 47
2.9 BeaconFFIAPIs 51
2.10 BookmarkandRefreshAPI 61
2.11 CameraAPI 63
2.12 CharmSettingAPIs 64
2.13 CryptographyAPIs 66
©2016byKony,Inc.Allrightsreserved 4of838
KonyStudioAPI Developer'sGuide
Version3.1
2.14 DataStoreAPI 74
2.15 FunctionalModulesAPI 76
2.16 GeoLocationAPIs 77
2.17 GestureAPI 81
2.18 HybridAPI 83
2.19 InputandOutputAPIs 85
2.20 InternationalizationAPIs 86
2.21 kony.localAuthenticationNamespace 90
2.22 LanguageAPIs 92
2.23 LiveTilesAPI 93
2.24 MathAPIs 94
2.25 MobileFirstAPIs 94
2.26 NetworkAPIs 125
2.27 Notifications 132
2.28 OfflineDataAccessAPIs 146
2.29 OperatingSystemAPIs 151
2.30 PhoneAPIs 153
2.31 SelfSufficientModules 154
2.32 StandardKonyAPIs 159
2.33 StreamingAPI 164
2.34 StringAPIs 165
©2016byKony,Inc.Allrightsreserved 5of838
KonyStudioAPI Developer'sGuide
Version3.1
2.35 TableAPIs 172
2.36 ThemeAPIs 173
2.37 ThreadingAPIs 177
2.38 GuidelinesforusingThreadingAPIs 177
2.39 TimerAPIs 179
2.40 WorkerThreadAPIs 180
2.41 Appendix:GeneralFAQ 216
2.42 Appendix:JavaScriptFAQ 222
2.43 Appendix:SQLite 225
2.44 BackgroundJobs 231
3. References 243
3.1 com.konyNamespace 244
3.2 DeviceInfoObject 298
3.3 FormDataObject 302
3.4 HttpRequestObject 315
3.5 konyNamespace 323
3.6 kony.accelerometerNamespace 334
3.7 kony.applicationNamespace 345
3.8 kony.application.settingsNamespace 436
3.9 kony.cameraNamespace 441
3.10 kony.contactNamespace 445
©2016byKony,Inc.Allrightsreserved 6of838
KonyStudioAPI Developer'sGuide
Version3.1
3.11 kony.cryptoNamespace 452
3.12 kony.dbNamespace 481
3.13 kony.dsNamespace 500
3.14 kony.filterNamespace 506
3.15 kony.hybridNamespace 555
3.16 kony.imageNamespace 558
3.17 kony.io.FileNamespace 563
3.18 kony.io.FileListNamespace 572
3.19 kony.io.FileSystemNamespace 574
3.20 kony.i18nNamespace 586
3.21 kony.langNamespace 605
3.22 kony.localAuthenticationNamespace 608
3.23 kony.localnotificationsNamespace 613
3.24 kony.locationNamespace 618
3.25 kony.mapNamespace 626
3.26 kony.modulesNamespace 635
3.27 kony.netNamespace 638
3.28 kony.notificationsettingsNamespace 662
3.29 kony.osNamespace 669
3.30 kony.phoneNamespace 691
3.31 kony.pushNamespace 710
©2016byKony,Inc.Allrightsreserved 7of838
KonyStudioAPI Developer'sGuide
Version3.1
3.32 kony.storeNamespace 726
3.33 kony.streamNamespace 732
3.34 kony.stringNamespace 739
3.35 kony.themeNamespace 756
3.36 kony.timerNamespace 767
3.37 kony.types.RawBytesNamespace 772
3.38 kony.UINamespace 773
3.39 kony.workerNamespace 781
3.40 mathNamespace 784
3.41 SyncObject 788
3.42 syncNamespace 802
3.43 tableNamespace 809
3.44 WorkerThreadObject 822
©2016byKony,Inc.Allrightsreserved 8of838
1. Preface KonyStudioAPI Developer'sGuide
Version3.1
1. Preface
KonyVisualizerisanintegrateddevelopmentenvironment(IDE)forrapiddevelopmentand
deploymentofmobileapplications.KonyVisualizerisprovidedasaplug-intoEclipse,anopen-source
environment.TheIDEoffersyouaneasytolearnandusevisualdevelopmentenvironmenttodesign
anddevelopthemobileapplications.TheprimaryelementofKonyVisualizerisavisualdeveloper
panelthatisusedtodesigntheapplicationformsinadeviceindependentwire-frameformat.
AlltheKonysupporteddevices,developmentlanguages,andbrowsersarelistedat,Supported
DevicesandBrowsers.
1.1 Purpose
ThisdocumentexplainstheApplicationProgram Interface(API) usedinKonyVisualizerandalso
providesproceduralinformationtousethemtoachievefunctionality.
1.2 Intended Audience
ThisdocumentistargetedatdeveloperswhouseKonyVisualizertodevelopapplications.
1.3 Formatting Conventions
Thefollowingaretheformattingconventionsusedthroughoutthedocument:
Clickhere
©2016byKony,Inc.Allrightsreserved 9of838
1. Preface KonyStudioAPI Developer'sGuide
Version3.1
Conventions Explanation
Monospace Userinputtext,systemprompts,and
l
responses
Filepath
l
Commands
l
Programcode
l
Filenames.
l
Italic Emphasis
l
Namesofbooksanddocuments
l
Newterminology.
l
Bold Windows
l
Menus
l
Buttons
l
Icons
l
Fields
l
Tabs
l
Folders.
l
URL ActivelinktoaURL.
Provideshelpfulhintsoradditionalinformation.
Note:
Highlightsactionsorinformationthatmightcause
Important:
problemstosystemsordata.
©2016byKony,Inc.Allrightsreserved 10of838
Description:Apple, Inc. Google, the Google logo, Android, and the Android logo are . File names. Italic. ○. Emphasis. ○. Names of books and documents. ○ of data into scrambled text (concealing its readability and meaning) and deciphering . tutorials/default.htm#Accelerometer.htm%3FTocPath%3D_____5.
