Version 2.8#

key#

key.setInfo()#

nil key:setTitle/Info/Icon( [setMe:string/default=nil] )

setIcon only works on phones that have a colored screen.

Icon-Values can be:

• a '@drawable/..'-reference to an icon that's part of the firmware. See debug.getDrawables().
• a http-url to an icon.
• a base64 encoded image.

key.setIcon()#

nil key:setTitle/Info/Icon( [setMe:string/default=nil] )

setIcon only works on phones that have a colored screen.

Icon-Values can be:

• a '@drawable/..'-reference to an icon that's part of the firmware. See debug.getDrawables().
• a http-url to an icon.
• a base64 encoded image.

key.setLed()#

nil key:setLed( color:string [blink:boolean/default=false] )
nil key:setLed{ color:string [blink:boolean/default=false] }

Allowed color-values are "red", "green", "yellow" and "off".

key.setTitle()#

nil key:setTitle/Info/Icon( [setMe:string/default=nil] )

setIcon only works on phones that have a colored screen.

Icon-Values can be:

• a '@drawable/..'-reference to an icon that's part of the firmware. See debug.getDrawables().
• a http-url to an icon.
• a base64 encoded image.

sip#

sip.setupSubscriptionType()#

boolean sip.setupSubscriptionType{ name:string accepted:string/array<string> }

dialog and message-summary do not have to be setup, since the phone initiates them automatically.accepted is a list of acceptable mime type for the notifies e.g. 'application/dialog-info+xml'.

sip.invite()#

nil sip.invite( uri:string [, pickup:boolean/default=false] [, line:int] [, hidden:boolean/default=false] )
? sip.invite{ uri:string [pickup:boolean/default=false] [line:int] [hidden=boolean/default:false] [headers=table/default:nil] [returnHttpResult:boolean/default=false] [callLogNr:int]}

Attemps a pickup if pickup-parameter is true.

line is the number of the identity to use. When not set the default identity (see idle-screen) is used.

pass a headers-map if you want to add additional headers to the outgoing sip-invite.

With hidden=true -> call will not be shown on the phones display. It won't have audio either.

callLogNr defines which party to log for this call, i.e. whom to callback when selecting this call in the redial-history.

Provide a number > 0 to name the party counting from the one we called originally, e.g.:

1 -> originally called number 2 -> the first party the call got diverted to. Provide a number < 0 to name the party counting from backwards from the last connected party, e.g.:

-1 -> last/final party the call was connected or diverted to Provide nothing and setting Telephony.CallLogWithReachedTarget (provisioning only, default: false aka initial) is used.

If you set returnHttpResult to true, the function will return the result of the operation.

Result consists of error code, body and additional headers, taylor made to return within an http.listen()-callback. See http.listen()-callback with exclusive=true for more details.

returns nil unless returnHttpResult==true

sip.subscribe()#

SipSubscription sip.subscribe{uri:string  [onNotify:function] [onTerminated:function] [line:int] [type:string/default=dialog]}

uri is the target of the subscription, i.e. where to subscribe to.

It may not have to be a full uri, username of subscription-uri is enough.

type can be custom, but than it needs to be enabled with sip.setupSubscriptionType beforehand'.

line is the number of the identity to use for subscription (1-based index).

It defaults to the currently selected identity (see idle screen of phone).

On incoming Notify-messages the onNotify-callback is called with 3 parameters:

• same SipSubscription-object as is returned here by sip.subscribe()
• data:string is the raw content of the notify message
• headers:table is a table of string headers paired with either a single or a list of header values Any return value of that callback is ignored.

When the subscription gets terminated, onTerminated() is called with 1 parameter:

• same SipSubscription-object as is returned here by sip.subscribe() Any return value of that callback is ignored.

Return value is a SipSubscription-object which can be used to unsubscribe.

sip.unsubscribe()#

nil sip.unsubscribe( handle:SipSubscription )
nil sip.unsubscribe{ handle:SipSubscription }

sip.sendMessage()#

nil sip.sendMessage{ line:int, message:string, target:string [returnHttpResult:boolean/default=false] }

line is the number of the identity to use (1-based index).

If you set returnHttpResult to true, the function will return the result of the operation.

Result consists of error code, body and additional headers, taylor made to return within an http.listen()-callback. See http.listen()-callback with exclusive=true for more details.

returns nil unless returnHttpResult==true

sip.call-object#

call:getRemote()#

uri:string, name:string call:getRemote()

Returns the sip-uri (string) as the first value and if there is a known name it is returned as the second result (string) else NIL

call:resume()#

nil call:resume( [call2:call-object/callId-string] )
? call:resume{ [call2:call-object/callId-string] [returnHttpResult:boolean/default=false] }

Accepts a 2nd call as parameter to resume an entire conference at once.

If you set returnHttpResult to true, the function will return the result of the operation.

Result consists of error code, body and additional headers, taylor made to return within an http.listen()-callback. See http.listen()-callback with exclusive=true for more details.

returns nil unless returnHttpResult==true

call:accept()#

nil call:accept()
? call:accept{ [returnHttpResult:boolean/default=false] }

If you set returnHttpResult to true, the function will return the result of the operation.

Result consists of error code, body and additional headers, taylor made to return within an http.listen()-callback. See http.listen()-callback with exclusive=true for more details.

returns nil unless returnHttpResult==true

call:terminate()#

nil call:terminate( [call2:call-object/callId-string] )
? call:terminate{ [call2:call-object/callId-string] [returnHttpResult:boolean/default=false] }

Accepts a 2nd call as parameter to terminate an entire conference at once.

If you set returnHttpResult to true, the function will return the result of the operation.

Result consists of error code, body and additional headers, taylor made to return within an http.listen()-callback. See http.listen()-callback with exclusive=true for more details.

returns nil unless returnHttpResult==true

call:getDisconnectCause()#

code:int, reason:string call:getDisconnectCause()

Returns the sip-code (int) as the first value and the reason (string) as the second.

call:getId()#

string call:getId()

call:getState()#

string call:getState()

Returns one of the following Strings:

• calling (outgoing call that was not yet active (i.e. connected))
• ringing (incoming call that was not yet active (i.e. connected))
• active (connected call)
• holding (call was put on hold, i.e. this phone is holding the other party)
• disconnected (call has ended)
• unknown (fallback)

call:isIncoming()#

boolean call:isIncoming()

call:getIdentityIndex()#

int call:getIdentityIndex()

call:hold()#

nil call:hold( [call2:call-object/callId-string] )
? call:hold{ [call2:call-object/callId-string] [returnHttpResult:boolean/default=false] }

Accepts a 2nd call as parameter to hold an entire conference at once.

The call2-parameter may either be a call-obj or just a callId.

If you set returnHttpResult to true, the function will return the result of the operation.

Result consists of error code, body and additional headers, taylor made to return within an http.listen()-callback. See http.listen()-callback with exclusive=true for more details.

returns nil unless returnHttpResult==true

call:transfer()#

? call:transfer( number:string )
? call:transfer{ number:string [returnHttpResult:boolean/default=false] }

Transfers a call to a specified number.

If you set returnHttpResult to true, the function will return the result of the operation.

Result consists of error code, body and additional headers, taylor made to return within an http.listen()-callback. See http.listen()-callback with exclusive=true for more details.

returns nil unless returnHttpResult==true

call:isOutgoing()#

boolean call:isOutgoing()

call:join()#

nil call:join( [call2:call-object/callId-string] )
? call:join{ [call2:call-object/callId-string] [returnHttpResult:boolean/default=false] }

When 2nd call-parameter is missing, phone will do it's best to select the obvious one.

If you set returnHttpResult to true, the function will return the result of the operation.

Result consists of error code, body and additional headers, taylor made to return within an http.listen()-callback. See http.listen()-callback with exclusive=true for more details.

returns nil unless returnHttpResult==true

call:putDetail()#

nil call:putDetail( label:string, value:string )
? call:putDetail{ label:string value:string [returnHttpResult:boolean/default=false] }

Add/Replace a call-detail. These details will make it onto the phones screen whenever the call is displayed in full.

You can delete a detail by passing an empty value.

If you set returnHttpResult to true, the function will return the result of the operation.

Result consists of error code, body and additional headers, taylor made to return within an http.listen()-callback. See http.listen()-callback with exclusive=true for more details.

returns nil unless returnHttpResult==true

call:conference()#

nil call:conference( [call2:call-object/callId-string] )
? call:conference{ [call2:call-object/callId-string] [returnHttpResult:boolean/default=false] }

Conferences may be dissolved by only holding or terminating one of the conference members

When 2nd call-parameter is missing, phone will do it's best to select the obvious one.

If you set returnHttpResult to true, the function will return the result of the operation.

Result consists of error code, body and additional headers, taylor made to return within an http.listen()-callback. See http.listen()-callback with exclusive=true for more details.

returns nil unless returnHttpResult==true

call:dtmf()#

? call:dtmf( dtmf:string )
? call:dtmf{ dtmf:string [returnHttpResult:boolean/default=false] }

If you set returnHttpResult to true, the function will return the result of the operation.

Result consists of error code, body and additional headers, taylor made to return within an http.listen()-callback. See http.listen()-callback with exclusive=true for more details.

returns nil unless returnHttpResult==true

sip.identityListener-object#

identityListener:stop()#

nil identityListener:stop()

sip.sipSubscription-object#

sipSubscription:getLine()#

string SipSubscription:getLine()

sipSubscription:getUri()#

string SipSubscription:getUri()

sipSubscription:resub()#

nil SipSubscription:resub{[body:string], [contentType:string/default=text/plain]}

sipSubscription:unsubscribe()#

nil SipSubscription:unsubscribe()

sipSubscription:resubscribe()#

nil SipSubscription:resubscribe()

sipSubscription:getType()#

string SipSubscription:getType()

sip.calls#

sip.calls.resume()#

nil sip.calls.resume( [call:call-object/callId-string], [call2:call-object/callId-string] )
? sip.calls.resume{ [call:call-object/callId-string] [call2:call-object/callId-string] [returnHttpResult:boolean/default=false] }

If you omit the callId's, the first found held call or conference will be resumed.

If you set returnHttpResult to true, the function will return the result of the operation.

Result consists of error code, body and additional headers, taylor made to return within an http.listen()-callback. See http.listen()-callback with exclusive=true for more details.

returns nil unless returnHttpResult==true

sip.calls.terminate()#

nil sip.calls.terminate( [call:call-object/callId-string], [call2:call-object/callId-string]])
? sip.calls.terminate{ [call:call-object/callId-string] [call2:call-object/callId-string] [returnHttpResult:boolean/default=false] }

If you omit the callId's, the active call or conference will be terminated. If none is active, phone searches first for outgoing

ringing calls, next for incoming ringing calls and last for any calls. Only if it finds one single call or conference in any of theses

states, will it actually terminate without having a specific ID

If you set returnHttpResult to true, the function will return the result of the operation.

Result consists of error code, body and additional headers, taylor made to return within an http.listen()-callback. See http.listen()-callback with exclusive=true for more details.

returns nil unless returnHttpResult==true

sip.calls.accept()#

nil sip.calls.accept( [call:call-object/callId-string] )
? sip.calls.accept{ [call:call-object/callId-string] [returnHttpResult:boolean/default=false] }

If you omit the callId, the first ringing call found will be accepted.

If you set returnHttpResult to true, the function will return the result of the operation.

Result consists of error code, body and additional headers, taylor made to return within an http.listen()-callback. See http.listen()-callback with exclusive=true for more details.

returns nil unless returnHttpResult==true

sip.calls.listen()#

handle:data sip.calls.listen( callback:function )
handle:data sip.calls.listen{ callback:function [line:int] [user:string] }

Set optional line to >=1 to only receive call-updates that involve the given identity.

Set a user to only receive call-updates where remote party has same username.

Returns handle which can be passed to stop_listen.

The callback is called with multiple parameters, first one names the change:

• 'add', call-obj - there is a new call
• 'remove', call-obj - call was deleted
• 'remote_update', call-obj - either number or name of call have changed, see call:getRemote()
• 'state_changed', call-obj - state of call changed (e.g.: put on hold), see call:getState()
• 'transferred', call-obj - call got transferred -> new party on the other end
• 'conferenced', call-obj, call-obj - both calls are now in a conference
• 'unconferenced', call-obj, call-obj - both calls are no longern in a conference
• 'transfer_initiated', call-obj, call-obj - starting attended transfer, both remote parties of both calls are being connected.
• 'transfer_failed', call-obj, call-obj - attended transfer failed
• 'transfer_done', call-obj, call-obj - attended transfer was successful
• 'transfer_done', call-obj, target:string - blind transfer was successful Call objects can be used to query or modify the call.

The return value of the callback is ignored.

sip.calls.get_all()#

array<calls> sip.calls.get_all()

sip.calls.hold()#

nil sip.calls.hold( [call:call-object/callId-string], [call2:call-object/callId-string] )
? sip.calls.hold{ [call:call-object/callId-string] [call2:call-object/callId-string] [returnHttpResult:boolean/default=false] }

If you omit the callId's, the active call or conference will be held.

If you set returnHttpResult to true, the function will return the result of the operation.

Result consists of error code, body and additional headers, taylor made to return within an http.listen()-callback. See http.listen()-callback with exclusive=true for more details.

returns nil unless returnHttpResult==true

sip.calls.transfer()#

nil sip.calls.transfer( [call:call-object/callId-string], number:string )
? sip.calls.transfer{ number:string [call:call-object/callId-string] [returnHttpResult:boolean/default=false] }

You may set the callId to nil in which case the the phone will make a guess which call is ment.

If you set returnHttpResult to true, the function will return the result of the operation.

Result consists of error code, body and additional headers, taylor made to return within an http.listen()-callback. See http.listen()-callback with exclusive=true for more details.

returns nil unless returnHttpResult==true

sip.calls.join()#

nil sip.calls.join( [call:call-object/callId-string], [call2:call-object/callId-string] )
? sip.calls.join{ [call:call-object/callId-string] [call2:call-object/callId-string] [returnHttpResult:boolean/default=false] }

If you omit one or both call's, the phone will make a guess which calls are ment.

If you set returnHttpResult to true, the function will return the result of the operation.

Result consists of error code, body and additional headers, taylor made to return within an http.listen()-callback. See http.listen()-callback with exclusive=true for more details.

returns nil unless returnHttpResult==true

sip.calls.putDetail()#

nil sip.calls.putDetail( [call:call-object/callId-string], label:string, value:string )
? sip.calls.putDetail{ label:string value:string [call:call-object/callId-string] [returnHttpResult:boolean/default=false] }

Add/Replace a call-detail. These details will make it onto the phones screen whenever the call is displayed in full.

You can delete a detail by passing an empty value.

You may set the callId to nil in which case the the phone will make a guess which call is ment.

If you set returnHttpResult to true, the function will return the result of the operation.

Result consists of error code, body and additional headers, taylor made to return within an http.listen()-callback. See http.listen()-callback with exclusive=true for more details.

returns nil unless returnHttpResult==true

sip.calls.conference()#

nil sip.calls.conference( [call:call-object/callId-string], [call2:call-object/callId-string] )
? sip.calls.conference{ [call:call-object/callId-string] [call2:call-object/callId-string] [returnHttpResult:boolean/default=false] }

Conferences may be dissolved by only holding or terminating one of the conference members

If you omit one or both callId's, the phone will make a guess which calls are ment.

If you set returnHttpResult to true, the function will return the result of the operation.

Result consists of error code, body and additional headers, taylor made to return within an http.listen()-callback. See http.listen()-callback with exclusive=true for more details.

returns nil unless returnHttpResult==true

sip.calls.make()#

nil sip.calls.make( uri:string [, pickup:boolean/default=false] [, line:int] [, hidden:boolean/default=false] )
? sip.calls.make{ uri:string [pickup:boolean/default=false] [line:int] [hidden:boolean/default=false] [returnHttpResult:boolean/default=false] }

Attemps a pickup if pickup-parameter is true.

Line is the number of the identity to use. When not set the default identity (see idle-screen) is used.

With hidden=true -> call will not be shown on the phones display. It won't have audio either.

If you set returnHttpResult to true, the function will return the result of the operation.

Result consists of error code, body and additional headers, taylor made to return within an http.listen()-callback. See http.listen()-callback with exclusive=true for more details.

returns nil unless returnHttpResult==true

sip.calls.dtmf()#

nil sip.calls.dtmf( [call:call-object/callId-string], dtmf:string )
? sip.calls.dtmf{ dtmf:string [call:call-object/callId-string] [returnHttpResult:boolean/default=false] }

You may set the callId to nil in which case the active call is used, if there is one.

If you set returnHttpResult to true, the function will return the result of the operation.

Result consists of error code, body and additional headers, taylor made to return within an http.listen()-callback. See http.listen()-callback with exclusive=true for more details.

returns nil unless returnHttpResult==true

sip.calls.stop_listen()#

nil sip.calls.stop_listen( handle:data )
nil sip.calls.stop_listen{ handle:data }

sip.identities#

sip.identities.is_active()#

boolean sip.identities.is_active( line:int )
boolean sip.identities.is_active{ line:int }

line is the number of the identity to check (1-based index).

sip.identities.stop_listen()#

nil sip.identities.stop_listen( handle:identityListener )
nil sip.identities.stop_listen{ handle:identityListener }

sip.identities.listen()#

identityListener sip.identities.listen( callback:function, [line:int] )
identityListener sip.identities.listen{ callback:function [line:int] }

Returns handle which can be passed to stop_listen.

line is the number of the identity which is to be monitored (1-based index).If none is provided, all registry-changes of all identities are reported to the callback.

The callback is called with two parameters:

1: a string that's either unregistered or registered.

2: an int, i.e. the line that changed.

The return an identityListener-object which can be used to stop this monitor.

sip.identities.getDomain()#

string sip.identities.getDomain( line:int )
string sip.identities.getDomain{ line:int }

The host is needed to construct valid sip-uri's e.g. for subscriptions or when making calls.

line is the number of the identity to check (1-based index).

debug#

debug.getDocu()#

string debug.getDocu( thing:lua-object )
string debug.getDocu{ thing:lua-object }

May return nil when no documentation exists.

debug.log()#

nil debug.log( message:string [, debug_level:string/default=i] )
? debug.log{ message:string [debug_level:string/default=i] [returnHttpResult:boolean/default=false] }

debug_level = e/w/i/d/v -> i.e. a one-char String (only first char is looked at) that marks the severity of the log: error, warning, info, debug or verbose.

If you set returnHttpResult to true, the function will return the result of the operation.

Result consists of error code, body and additional headers, taylor made to return within an http.listen()-callback. See http.listen()-callback with exclusive=true for more details.

returns nil unless returnHttpResult==true

debug.getLoadableLibs()#

table<string> debug.getLoadableLibs()

These include baked-in modules like the penlight library as well as the LuaLibraries which are part of the settings.

debug.getDrawables()#

table<string> debug.getDrawables()

system#

system.updatePickupScreen()#

nil system.updatePickupScreen{ uri:string line:int calls:table hideInMixedList:boolean}

line is the number of the identity to use.

uri is the number that is being monitored by the script.

the calls-table is a map where each entry-key is is a dialog-id and each value is expected to contain a dictionary with these entries:.

pickup-name: the name/number to show when presenting this call that says which party will be picked. other-name: the other party involved in the call, the one for which this phone will answer instead on pickup. state: one of terminated / ringing / calling / connected / holding. But since it's pickable calls, they should normally all be ringing. stateTime: ms since epoch when call entered it's current state, use time.currentTimeMillis(). replaces: the replaces-header the phone must use to pickup that call. enable hideInMixedList to keep the calls from being listed in the pickup-screen that shows all available pickups from all participating keys.

system.toast()#

nil system.toast( text:string )
? system.toast{ text:string [returnHttpResult:boolean/default=false] }

On colored devices you may alternatively provide a '@drawable/..' (See debug.getDrawables).

If you set returnHttpResult to true, the function will return the result of the operation.

Result consists of error code, body and additional headers, taylor made to return within an http.listen()-callback. See http.listen()-callback with exclusive=true for more details.

returns nil unless returnHttpResult==true

system.hasPickableCalls()#

nil system.hasPickableCalls()

system.showPickupScreen()#

nil system.showPickupScreen{ uri:string line:int calls:table onExit:function }

line is the number of the identity to use.

uri is the number that is being monitored by the script.

the calls-table is a map where each entry-key is is a dialog-id and each value is expected to contain a dictionary with these entries:.

pickup-name: the name/number to show when presenting this call that says which party will be picked. other-name: the other party involved in the call, the one for which this phone will answer instead on pickup. state: one of terminated / ringing / calling / connected / holding. But since it's pickable calls, they should normally all be ringing. stateTime: ms since epoch when call entered it's current state, use time.currentTimeMillis(). replaces: the replaces-header the phone must use to pickup that call. onExit gets called when UI exits the pickup-screen (either cause call is selected or user cancels). No parameters are passed.

system.intent()#

nil system.intent( action:string )
? system.intent{ action:string [component:string] [data:string(uri-format)] [extras:table] [asBroadcast:boolean/default=false] [returnHttpResult:boolean/default=false]}

set asBroadcast to send it as a broadcast, else code calls startActivity(intent)

for an complete decription of the parameters see: https://developer.android.com/guide/components/intents-filtersIf you set returnHttpResult to true, the function will return the result of the operation.

Result consists of error code, body and additional headers, taylor made to return within an http.listen()-callback. See http.listen()-callback with exclusive=true for more details.

returns nil unless returnHttpResult==true

system.monitorHavePickups()#

HavePickupsMonitor:obj system.monitorHavePickups{onHavePickupsChanged:callback}

system.notifications#

system.notifications.getAll()#

array<notifications> notifications.getAll()

system.notifications.monitor()#

monitor:obj notifications.monitor{onCreated:callback onDeleted:callback [pkg:string] [id:int] [tag:string]}

system.notifications.getUniqueId()#

int notifications.getUniqueId()

system.notifications.get()#

notification:obj notifications.get{[pkg:string] [id:int] [tag:string] [key:string]}

When key is provided, id, tag and pkg are ignored.

When nothing is provided, the first found active notification is returned.

system.notifications.add()#

nil notifications.add{tag:string title:string message:string [id:int] [icon:string]  [led:on|blink|off(default)] [persistent:boolean/default=false] [volatile:boolean/default=false] [alert:boolean/default=false] [alertOkText:string] [alertCancelText:string] [alertsound:boolean/default=true][autoClickDelay:number/default=0] [onClicked:callback] [onDeleted:callback]}

onClicked and onDeleted are callbacks with two parameters cb(tag:string id:int) that get called when user deletes a notification or clicks on it.

A persistent notification cannot be deleted by the user.

A volatile notification disappears when clicked (cannot be combined with persistent).

A alerting notification will auto-open on screen and play a notification sound. The sound can also be disabled with 'alertsound=false'.

You can add ok and cancel-buttons by providing alertOkText and/or alertCancelText. Provide a empty string (not NIL) to use the standard ok/cancel-translations.

When user clicks ok then the onClicked-callback will be called. In the same manner a cancel-click will delete the message and call the onDeleted-callback.

A cancel-option will not be shown for persistent notifications.

A non persistent notification can be automatically clicked after a certain delay. For example 'autoClickDelay=10' triggers an OnClickEvent after 10 seconds. If the message text contains a %AutoClickCountdown% placeholder, then the placeholder is replaced with the current countdown value.Icon-Values can be:

• a '@drawable/..'-reference to an icon that's part of the firmware. See debug.getDrawables().
• a http-url to an icon.
• a base64 encoded image. The led parameter defines the desired behaviour of the LED of the message-key. If you set it to 'on' it will cause the Message-LED to turn on, unless there is another message that overrides this with blinking.

Use tag and id parameter to make your notification unique to the system and to identify it in onClicked- and onDeleted-callbacks.

system.notifications.monitor-object#

monitor:remove()#

nil monitor:remove()

system.notifications.notification-object#

notification:delete()#

nil notification:delete()

If a notification has some intent tied to it's deletion, it will be called.

notification:remove()#

nil notification:remove()

notification:getTitleAndMsg()#

string, string notification:getTitleAndMsg()

notification:getPkg()#

string notification:getPkg()

notification:isPersistent()#

bool notification:isPersistent()

notification:getKey()#

string notification:getKey()

notification:getId()#

int notification:getId()

notification:getTag()#

string notification:getTag()

system.notifications.constants#

luaPkg: "de.auerswald.functions"
vpnIdTrying: 1623130911
vpnPkg: "de.blinkt.openvpn"
vpnIdSuccess: 1346787898

system.network#

system.network.monitor()#

monitor:obj network.monitor{onAvailable:callback onLost:callback transports:string/array<string> [capabilities:array<int>]}

The transports-parameter defines the network-types you are interested in. It is expected as an indexed table with the values being one of these strings: wifi, eth, bluetooth and vpn

The capabilities-parameter is an int defined by android, you can find a list of supported capabilities in network.capabilities.

Returned monitor-obj can be used to end this monitor via its :remove()-function.

Returns nil on error.

system.network.monitor-object#

monitor:remove()#

nil monitor:remove()

system.network.capabilities#

VALIDATED: 16
WIFI_P2P: 6
UNTRUSTED: 14
VPN: 15
INTERNET: 12
CAPTIVE_PORTAL: 17
FOREGROUND: 18
RESTRICTED: 13

http#

http.post()#

nil http.post(url:string [, callback:function [, content:string [, headers:table]]])
nil http.post{url:string [callback:function] [content:string] [headers:table] [follow_redirects:boolean/default=true] [verifyHostname:boolean/default=true] [acceptUnsignedCerts:boolean/default=false]}

See http.request() for details.

http.delete()#

nil http.delete(url:string [, callback:function [, content:string [, headers:table]]])
nil http.delete{url:string [callback:function] [content:string] [headers:table] [follow_redirects:boolean/default=true] [verifyHostname:boolean/default=true] [acceptUnsignedCerts:boolean/default=false]}

See http.request() for details.

http.put()#

nil http.put(url:string [, callback:function [, content:string [, headers:table]]])
nil http.put{url:string [callback:function] [content:string] [headers:table] [follow_redirects:boolean/default=true] [verifyHostname:boolean/default=true] [acceptUnsignedCerts:boolean/default=false]}

See http.request() for details.

http.request()#

nil http.request(url:string [, callback:function [, method:string/default=GET [, content:string]], headers:table])
nil http.request{url:string [callback:function] [method:string/default=GET] [content:string] [headers:table] [follow_redirects:boolean/default=true] [verifyHostname:boolean/default=true] [acceptUnsignedCerts:boolean/default=false]}

The url-parameter must start with http:// or https://.

You can pass credentials for authorization challenges via: http://username:password@...

The callback receives 3 parameters: callback(responseCode:int [, content:string, headers:table]).

• when the request was unsuccessful, the callback gets called with just the http error code. The method-parameter should be either GET, POST, DELETE or PUT.

The content-parameter is appended as the body of the http-request.

With follow_redirects=false you can get to the headers an body of a 3xx-response.

You can optionally supply request headers as a table mapping string keys to string values.

http.get()#

nil http.get(url:string [, callback:function [, headers:table]])
nil http.get{url:string [callback:function] [content:string] [headers:table] [follow_redirects:boolean/default=true] [verifyHostname:boolean/default=true] [acceptUnsignedCerts:boolean/default=false]}

See http.request() for details.

http.listen()#

handle:data http.listen(path:string, callback:function [, exclusive:boolean/default=false])

The request has to be authenticated (via Login or token).

Returns handle which can be passed to stop_listen.

If the parameter <exclusive> is true and there already exists a handler for the supplied <path>,

the function returns nil and the handler is not installed.

The request goes to the supplied callback function, which is called with these parameters:

• the requested path as a string, aka same as the original path-parameter
• the request body as a string
• the request headers as a table with string keys and values
• another table, with additional infos like 'request_method', 'query_string' and 'query_map'

If <exclusive> is true, then the callback can return the HTTP response code, the response body and a map of additional headers to include in the response.

If the code is nil, 200 is sent. If the body is nil, an empty body is sent.

If <exclusive> is false, any return value from the callback is ignored.

http.stop_listen()#

nil http.stop_listen(handle:data)

dialog#

dialog.show()#

nil dialog.show( text:string )

xml#

xml.eval()#

XmlObj xml.eval(xml:str)

xml.append()#

XmlObj xml.append(XmlObj, tableOrTag:table)
XmlObj xml.append(XmlObj, tableOrTag:string)

The children are stored at index 1 and up in the XmlObj.Returns the new child.

xml.appendtext()#

XmlObj xml.appendtext(XmlObj, text:string)

The children are stored at index 1 and up in the XmlObj.Returns the provided XmlObj.

xml.tostring()#

string xml.tostring(XmlObj)

xml.find()#

XmlObj xml.find(XmlObj [, tag[, key[, value]]])

Tag can be nil or "" to find an element with any tag.

If key is not nil or "", the element must have an attribute with this key.

If value is not nil, the attribute must have this value.

xml.new()#

XmlObj xml.new(tableOrTag:table)
XmlObj xml.new(tableOrTag:string)

If tableOrTag is a table, use and convert it to a xml object (i.e. keep the data as is and add a metatable for object-like access).

If tableOrTag is a string, use as the tag of the XmlObj.

XmlObj's have their tag stored at index [0].

At index [1] and above all children are stored. These are either XmlObj's themselfes or a string representing plain-text content.

xml.tag()#

string xml.tag(XmlObj)
nil xml.tag(XmlObj, tag:string)

If tag is a string, changes the tag of the XmlObj.

json#

json.object()#

JsonObj json.object([base:table])

If base is set, copy all its string-key-value pairs to JsonObj[key.tostring()] = value.tostring().

Values of type table get skipped.

json.eval()#

JsonObj json.eval(json:string)

json.insert()#

nil json.insert(array:JsonAry [, index:int], value:data)

Without an index adds the provided value at the end of the JsonAry.

The value should be either a JsonObj, a JsonAry or a string.

json.array()#

JsonAry json.array([base:array])

If base is set, copy all its indexed values to JsonAry[idx] = value.tostring().

Values of type table get skipped.

json.tostring()#

string json.tostring(stringMe:JsonObj)
string json.tostring(stringMe:JsonAry)

bluetooth#

bluetooth.registerStateListener()#

nil bluetooth.registerStateListener(callback)

values: State

-2 - Error -1 - Not Available 0 - Off

1 - Turning On

2 - On

3 - Turning Off

4 - BLE Turning On

5 - BLE On

6 - BLE Turning Off

bluetooth.registerRangeCheck()#

nil bluetooth.registerRangeCheck(addr:string, callback:function)
nil bluetooth.registerRangeCheck{addr:string, callback:function}

You'll need a paired bluetooth 4 device to receive rssi-updates.

Provide the bluetooth-mac-address as addr-parameter.

The callback receives two parameters: callback(status:string, rssi:int).

• the callback gets called in a fixed interval once the device connects for the first time.
• status will either be "OK" or "NOT FOUND".
• rssi is an int or NIL if not in range.

bluetooth.enable()#

nil bluetooth.enable(onOff:boolean)

bluetooth.unregisterRangeCheck()#

nil bluetooth.unregisterRangeCheck(addr:string, callback:function)
nil bluetooth.unregisterRangeCheck{addr:string, callback:function}

bluetooth.unregisterStateListener()#

nil bluetooth.unregisterStateListener(callback)

bluetooth.getDevices()#

{} bluetooth.getDevices()

time#

time.sleep()#

nil time.sleep(sleepInSeconds:number)

time.unregister()#

nil time.unregister(callback)

time.register()#

nil time.register(callback)

time.currentTimeMillis()#

int time.currentTimeMillis()

time.callbackIn()#

nil time.callbackIn(callback, delayInSeconds)

time.callbackIn(callMe, 0.1) will call callMe in 100 milliseconds.

smallest resolution is 1 ms

async#

async.async()#

async.async()

complete(...) -> set the return values of await() ... await([timeout]) -> wait for and return the values given to complete() timeout is specified in seconds the function will never wait longer than 5 minutes even if no timeout is given

example:

local function http_get_sync(url) local async = async.async() http.get(url, function(code, response, headers) async.complete(response) end) local res, response = async.await() return response end

Returns async object

phoneInfo#

phoneInfo.getBrand()#

string phoneInfo.getBrand()

phoneInfo.getMacAddress()#

string phoneInfo.getMacAddress()

phoneInfo.getIPs()#

array<string> phoneInfo.getIPs()

phoneInfo.getModel()#

string phoneInfo.getModel()

phoneInfo.getFwVersion()#

string phoneInfo.getFwVersion()

config#

config.unregister()#

nil config.unregister( path:string, callback:function )
nil config.unregister{ path:string callback:function }

path is the xPath to a setting or group of settings.

config.set()#

nil config.set( path:string, value:string )
nil config.set{ path:string value:string}

path is the xPath to the desired setting.

value holds the new desired value.

config.get()#

string config.get( path:string )
string config.get{ path:string }

path is the xPath to the desired setting.

config.register()#

nil config.register( path:string, callback:function )
nil config.register{ path:string callback:function }

path is the xPath to a setting or group of settings.

callback will be called with one parameter:

• path:string -> the xPath of the changed setting(s) return-value of callback is ignored.

database#

database.subscribe()#

dbMonitor:obj database.subscribe{dbUri:string onChanged:callback [query:string] [orderBy:string] [columns:array<string>]}

of your query and whenever something changes. You can turn this into a one-time-query by simply

stopping the subscription the first time your callback is called.

Please restrict your query as much as possible (using specific query and naming only the columns

of interest) to keep the load low and the performance up of your phone.

dbUri names the database you are interested in. It is expected to be a content uri,

e.g.: content://call_log/calls

orderBy defines how to order the rows, it is formatted as an SQL ORDER BY clause (excluding the ORDER BY itself). Passing null will use the default sort order, which may be unordered.

The onChanged-callback will be called with one parameter, the result of the query. It is an array

where each entry is a map of column-name to value.

The query parameter restricts your search to certain entries that fulfill the query. It is formatted

as an SQL WHERE clause (excluding the WHERE itself) and passed as is to android. It might simply

ask for entries where a column-value has a certain value, e.g.: 'new=1'

Use the columns-array to restrict your answers to the values you are interested in.

database.dbMonitor-object#

dbMonitor:remove()#

nil dbMonitor:remove()

sipTools#

sipTools.mkReplaces()#

string, string sipTools.mkReplaces{callId:string [from:string] [to:string]}

sipTools.parseUri()#

sipUri:obj sipTools.parseUri{sipUri:string [fromUserInput:boolean/default=false] [idIdx:int]}

user-input, i.e. those that aren't a uri yet may get expanded, e.g. the host/registrar is added if

the idIdx is provided.

Please set fromUserInput to true when sipUri-strings stems from a setting-value or some other place

where a user had written it. The parser employs different strategies to turn the input into a valid

sipUri. E.g. a simple sequence of digits may be 'enhanced' with '@registrar' when it stems from human

input but if it came from the network it would be wrong to fantasize a host to the tail of the input.

idIdx indicates which identity the uri belongs to, e.g. 1 for the first identity.

calllog#

calllog.monitorMissed()#

missedMonitor:obj calllog.monitorMissed{onNewMissed:callback [line:int] [user:string]}

calllog.missedMonitor-object#

missedMonitor:remove()#

nil missedMonitor:remove()