Эта страница является переводом страницы JS Handbook. Перевод выполнен на 100%.

---

Handbook of JavaScript API

The handbook presents the list of objects, methods and events of iRidium API.
It is aimed at developers who are acquainted with JavaScript
« Guide Examples »

Updated: 30.11.2021
Source language: JavaScript
Language version: 1.5
Specification: ECMAScript Edition 3
The JS version that we use is not the latest
one and it does not support new constructions,
but its functions are enough for panel projects
in 99% of all cases. To satisfy the remaining
one per cent converters of the https://babeljs.io
type can be used and of course experience
and developer's skills help.
Report an error

General API

Methods and events of iRidium API can be fully applied in i3 pro. All methods concerning the graphic interface and properties of control panels are not available for use in iRidium Server

Pages and Items

Methods

• IR.CreateItem()
• IR.DeleteItem()
• IR.GetPage()
• IR.GetPopup()
• IR.ShowPage()
• IR.ShowPopup()
• IR.HidePopup()
• IR.HideGroup()
• IR.TogglePopup()
• IR.HideAllPopups()
• IR.CreateEffect()
• IR.ShowKeyboard()
• IR.PasteFromClipboard()
• IR.GetClipboard()
• IR.ShowPasteHelper()
• IR.SelectNextEditBox()
• IR.GetItem()
  • .GetItem()
  • .CreateItem()
  • .Clone()
  • .GetPopup()
  • .StartActions()
  • .GetState()
  • .CreateState()
  • .ShowPopup()
  • .HidePopup()
  • .TogglePopup()
  • .Show()
  • .Hide()

Events

• IR.EVENT_ITEM_PRESS
• IR.EVENT_ITEM_RELEASE
• IR.EVENT_ITEM_HOLD
• IR.EVENT_ITEM_END_HOLD
• IR.EVENT_ITEM_LOST_FOCUS
• IR.EVENT_ITEM_CHANGE
• IR.EVENT_MOUSE_DOWN
• IR.EVENT_MOUSE_UP
• IR.EVENT_MOUSE_MOVE
• IR.EVENT_TOUCH_DOWN
• IR.EVENT_TOUCH_UP
• IR.EVENT_TOUCH_MOVE
• IR.EVENT_ITEM_SHOW
• IR.EVENT_ITEM_HIDE

Properties

• IR
  • IR.ProjectName
  • IR.PagesCount
  • IR.PopupsCount
  • IR.CurrentPage
• Page
• Popup
• Item
• State

Drivers

Methods

• IR.CreateDevice()
• IR.GetDevice()
  • .Connect()
  • .Disconnect()
  • .Send()
  • .SendEx()
  • .Set()
  • .SetFeedback()
  • .GetFeedback()
  • .SetParameters()
  • .GetCookies()
  • .SetCookie()
  • .GetLogin()
  • .GetPassword()
  • .AddChannel()
  • .AddTag()
  • .AddRelation()
  • .GetCommandsCount()
  • .GetCommandAtName()
  • .GetCommandAtPos()
  • .GetFeedbacksCount()
  • .GetFeedbackAtName()
  • .GetFeedbackAtPos()
  • .AddEndOfString()
  • .AddEndOfData()
  • .GetChannelURI
  • Conversion of Data
• IR.GetDevices()
• IR.IsModuleLicensed()

Events

• IR.EVENT_ONLINE
• IR.EVENT_OFFLINE
• IR.EVENT_TAG_CHANGE
• IR.EVENT_RECEIVE_DATA
• IR.EVENT_RECEIVE_TEXT
• IR.EVENT_ERROR
• IR.EVENT_CHANNEL_SET
• IR.EVENT_TAG_UPDATE_START
• IR.EVENT_TAG_UPDATE_END

Other

• UPnP

Properties

• Driver Properties

System

Methods

• IR.ShowSystemMenu()
• IR.SetEnableSystemMenu()
• IR.GetEnableSystemMenu()
• IR.SetProjectSystemMenu()
• IR.GetEnableProjectMenu()
• IR.ShowSettingsMenu()
• IR.SetFullScreen()
• IR.IsFullScreen()
• IR.HWID()
• IR.Exit()
• IR.ShowKeyboard()
• IR.Execute()
• IR.GetSystemInfo()
• IR.GetCurrentWlanInfo()
• IR.GetCurrentLocalIPInfo()
• IR.SetStatusAutoUpdateProjects()
• IR.Log()
• IR.SetInterval()
• IR.SetTimeout()
• IR.ClearInterval()
• IR.AddListener()
• IR.RemoveListener()
• IR.SetGlobalListener()
• IR.SubscribeTagChange()
• IR.UnsubscribeTagChange()
• IR.CopyToClipboard()
• IR.PasteFromClipboard()
• IR.GetClipboard()
• IR.ShowPasteHelper()
• IR.GetDesignsCount()
• IR.DesignSwitch()
• IR.AndroidSendIR()
• IR.CalculateCRC()
• IR.CalculateHash()
• IR.UrlDecode()
• IR.HtmlDecode()
• IR.Base64Encode()
• IR.Base64Decode()
• IR.IsModuleLicensed()
• IR.ValidatePassword()
• IR.TouchIDStart()
• IR.OpenPhotoGallery()
• IR.OpenPhotoCamera()
• IR.UploadFile()
• IR.EnableProximity()
• IR.OnTop()
• Popen()
• iDate (object)
• JSON
  • JSON.Stringify()
  • JSON.Parse()
• XML
  • new XML
  • .toXMLString()
• IR.SetPanelBacklight()

Events

• IR.EVENT_START
• IR.EVENT_WORK
• IR.EVENT_EXIT
• IR.EVENT_GLOBAL_
  _TAG_CHANGE
• IR.EVENT_ORIENTATION
• IR.EVENT_KEYBOARD_SHOW
• IR.EVENT_RECEIVE_SCHEME
• IR.EVENT_RECEIVE_
  _PHOTO_FROM_GALLERY
• IR.EVENT_RECEIVE_
  _PHOTO_FROM_CAMERA
• IR.ANDROID_BACK_PRESS
• IR.EVENT_LICENCE_ACCEPT

Lists

Methods

• IR.ITEM_LISTBOX (List) (deprecated methods)
• IR.ITEM_LISTBOX (List)
  (new methods)
• IR.ITEM_GOOD_LIST
• Static List
• IR.ITEM_PICKER
• IR.EVENT_PICKER_SCROLL

Gestures

Methods

• IR.AddRecognizer()
• IR.RemoveRecognizer()

Events

• IR.EVENT_GESTURE_BEGIN

Sounds

Methods

• IR.PlaySound()
• IR.StopSound()
• IR.StopSlot()
• IR.StopAllSounds()
• IR.SetAudioSession()

Project variables, tokens

Methods

• IR.SetVariable()
• IR.GetVariable()
• IR.SaveConfig()

Videos, cameras, images

Methods

• IR.CreateImage()
• IR.GetImage()
• IR.DeleteImage()
• IR.Camera()

Animation of objects

Methods

• IR.AddAnimation()
• IR.RemoveAnimation()
• IR.StartAllAnimations()
• IR.StopAllAnimations()
• .Start()
• .Stop()
• .AddItem()
• .RemoveItem()
• .AddParameter()
• .GetParameter()
• .GetParametersCount()
• .RemoveParameter()

Push notifications

Methods

• IR.SendPush()

Events

• IR.EVENT_RECEIVE_
  _PUSH_NOTIFY

Trends

Methods of Linear Trend object

• .SetDynamic()
• .GetCurve()
• .SetCurveTag()

Properties of Linear Trend object

• .StartTime
• .EndTime

Properties of Curve object

• .XInterval
• .XLabelTemplate

Browser

Methods

• .OpenBrowser()
• .CloseBrowser()

Events

• IR.EVENT_BROWSER_
  _PAGE_STARTED
• IR.EVENT_BROWSER_
  _PAGE_FINISHED
• IR.EVENT_BROWSER_
  _PAGE_ERROR
• IR.EVENT_BROWSER_
  _CLOSED

Math operations with large numbers

Methods

• IR.CreateBigIntContext()

RSA and AES encryption

Methods

• IR.CreateEncryption()
  • .Encode()
  • .Decode()
  • .GetPublickKey()

Server API

Methods applied in iRidium Server scripts only:

Server API

Methods

• IR.GetServer()

Events

• IR.EVENT_ACCEPT
• IR.EVENT_AUTHORIZE
• IR.EVENT_RELEASE
• IR.EVENT_SCHEDULE_
  _EVENT_CHANGE

DataBases

Methods

• System database
  • IR.GetDatabase()
• User database
  • new SQL()
• RecordSet object
• Methods of the SQL object
  • .Open()
  • .Execute()
  • .Request()
  • .Close()
• Methods of the RecordSet object
  • .GetRows()
  • .GetColumns()
  • .GetColumnName()
  • .GetColumnIndex()
  • .GetColumnType()
  • .GetRowValue()
  • .Free()

Properties

• RecordSet

Working with databases via ODBC

Methods

• new ODBC()
• .Query()

Working with Microsoft Exchange

Methods

• IR.CreateDevice()
• .GetCalendar()
• .GetContact()
• .CreateAppointment()
• .DeleteItem()
• .SendMail

Routines

• Methods
• Parameters of Server Routines
• Events of Server Routines
• Conditions of Server Routines
• Actions of Server Routines