Memento JavaScript Library: Difference between revisions

To keep JavaScript fields both easy and safe for users, they may use only a portion of the library, and the nature of its use is simplified. Any limitations or differences related to JavaScript fields will be identified.

== Libraries and Entries ==

==== entry() ====

: This Entry object is a clone of the actual Entry object. If the entry is saved, this object will become the actual one, but if cancel() is called, this entry clone, along with any changes the script may have performed, will be discarded.

:; Result: [[#Object Entry|'''''Entry''''' object]] — the current entry

:; Result: [[#Object DefaultEntry|'''''DefaultEntry''''' object]]

==== lib() ====

:; Result: [[#Object Library|'''''Library''''' object]] — the library identified by the argument ''name'', if found. Otherwise ''null''.

<br/>

=== Object ''Library'' ===

===== entries() =====

: Get all the entries of the library

===== find(query) =====

:; Result: Array object containing matching entries. Entries are sorted by the time of their creation, from newest to oldest.

: '''Argument'''

:; Result: [[#Object Entry|'''''Entry''''' object]], if found. Otherwise, ''null''.

: '''Argument'''

===== show() =====

: Display the library

<br/>

This object holds an entry of the current library, allowing the setting of field values

===== field(name) =====

::{{FieldTypeReturnValues}}

===== link(name, entry) =====

::; name: Name of the Link to Entry field to which to add the link

::; entry: Entry in the field's related library to which to link

===== unlink(name, entry) =====

::; entry: Entry in the field's related library identifying the link to be removed

<br/>

Template with default values for a new entry. This feature is available specifically and only for the Event '''Creating an entry''' & Phase '''Opening an Entry Edit card'''.

===== set(name, value) =====

: Set the value of the field

=== Library & Entry objects examples ===

<br/>

-----

With scripts, you can read or write files located in the device's internal memory or on the SD card. All file operations are performed by the ''File'' object, which is obtained via a global function called ''file()''.

==== file(name) ====

Open a file for read or write operations. If the file with the specified name does not exist yet, it will be created.

: '''Argument'''

:; Result

This object is returned by the global function ''file()'' and provides access to the requested file. After reading or writing, the file should be closed using the method ''close()''.

:; readAll(): Reads all lines of the file, and then closes the file

::; Returns: Array containing the lines of the file

:; readLine(): Reads the next line from the file stream

:; readLines(): Reads the remaining lines from the file stream

::; Returns: Array containing the remaining lines of the file

:; write(text): Write string(s). Take a variable number of arguments, converts each argument to a string, and writes that string to the file stream.

:; writeLine(text): Write strings and a newline to the file stream

:; exists: true &mdash; if and only if the file exists; false otherwise

:; length: The length, in bytes, of the file, or 0L if the file does not exist.  

<br/>

<br/>

-----

Interface for processing HTTP requests

===== get(url) =====

<br/>

=== Object ''HttpResult'' ===

Result of the execution of the HTTP request

<br/>

<br/>

-----

<br/>

==== cancel() ====

: Stop the system operation that caused the event. Many triggers can be a result of an entry manipulation (create, update, delete, etc). The ''cancel()'' function can be used during the phases that precede the system operation. For example, this function can be used during data validation before the entry is saved.

==== guid() ====

==== intent(action) ====

: Create an information exchange object &mdash; Intent. This function can send a request for action to another application.

:; Result: [[#Object Intent|'''''Intent''''' object]] &mdash; Information exchange object

: After the object is received, the data will be added to it, and then sent via ''send()''.

: Android has many built-in actions. A list of these actions can be found [https://developer.android.com/reference/android/content/Intent.html '''here'''].

<br/>

This object contains information about the system.

<br/>

Information exchange object. This object is created by using the global function ''intent()''.

===== data(uri) =====

: Define URI to reference the data

===== extra(key, value) =====

: Define additional data as key-value pairs, as necessary for execution of the required action. Similar to how URI data can be required for certain actions, other actions may require extra data in this format.

===== extraLong(key, value) =====

: Define additional data as key-value pairs, where data type needs to be Long

===== send() =====

<br/>

<br/>

-----

If the Contact field contains multiple contacts, use ''hasNext'' and ''next'' to retrieve them.

:; sendSMS(message): If the device is a phone, sends the provided '''''message''''' (text string) as an SMS message to the primary phone number of this contact

:; fullName: The full name of this contact

=== Object ''JSGeolocation'' ===

If the Location field contains multiple locations, use ''hasNext'' and ''next'' to retrieve them.

:; lat: Latitude, as a Real

:; lng: Longitude, as a Real

:; next: Returns the next JSGeolocation object, if there is one.  

<br/>

<br/>

-----

== See also ==

; [[Triggers]]: Memento Triggers

; [[Trigger Examples]]: Examples of Memento Triggers

-----

<br/>