Write, Bureaucrats, Administrators
4,332
edits
Memento JavaScript Library: Difference between revisions
m
no edit summary
mNo edit summary |
mNo edit summary |
||
| Line 1: | Line 1: | ||
{{Stamp| | {{Stamp|2021-02-26|4.9.3|1.9.6}} | ||
Memento includes the capability for users to use JavaScript to accomplish complex tasks beyond the capabilities of the normal Memento user interface. Examples include JavaScript fields, Triggers, Actions, and Data Sources. The Memento JavaScript Library may be used to access Memento facilities. | Memento includes the capability for users to use JavaScript to accomplish complex tasks beyond the capabilities of the normal Memento user interface. Examples include JavaScript fields, Triggers, Actions, and Data Sources. The Memento JavaScript Library may be used to access Memento facilities (by all except JavaScript fields). | ||
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. | 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. | ||
| Line 7: | Line 7: | ||
== Libraries and Entries == | == Libraries and Entries == | ||
=== ''Library'' | === ''Library'' global functions === | ||
==== entry() ==== | ==== entry() ==== | ||
: Get the Entry object of the Event. For example, if the script is triggered by an Update Entry event, this | : Get the Entry object of the Event. For example, if the script is triggered by an Update Entry event, this method will return the entry being updated. | ||
: 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. | : 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. | ||
: This function is available to all Events and Phases, with the exception of '''Creating an entry''' > '''Opening an Entry Edit card'''; for this action, use the function ''entryDefault()''. | : This global function is available to all Events and Phases, with the exception of '''Creating an entry''' > '''Opening an Entry Edit card'''; for this action, use the global function ''entryDefault()''. | ||
:; Result: [[#Object Entry|'''''Entry''''' object]] — the current entry | :; Result: [[#Object Entry|'''''Entry''''' object]] — the current entry | ||
| Line 41: | Line 41: | ||
=== Object ''Library'' === | === Object ''Library'' === | ||
This object provides access to library entries. You can work with the current library — the ''lib()'' — or any other library in the database — ''libByName()''. This function provides the ability to update existing entries and create new ones. | This object provides access to library entries. You can work with the current library — the ''lib()'' — or any other library in the database — ''libByName()''. This global function provides the ability to update existing entries and create new ones. | ||
==== ''Library'' | ==== ''Library'' methods ==== | ||
===== create(values) ===== | ===== create(values) ===== | ||
| Line 82: | Line 82: | ||
: Display the library | : Display the library | ||
==== ''Library'' | ==== ''Library'' properties ==== | ||
:; name: The name of the library | :; name: The name of the library | ||
:; title: The name of the library | :; title: The name of the library | ||
| Line 91: | Line 91: | ||
This object holds an entry of the current library, allowing the setting of field values | This object holds an entry of the current library, allowing the setting of field values | ||
==== ''Entry'' | ==== ''Entry'' methods ==== | ||
===== field(name) ===== | ===== field(name) ===== | ||
| Line 119: | Line 119: | ||
: Set the value of the named field. Calling this method results in immediate writing of the value to the library. | : Set the value of the named field. Calling this method results in immediate writing of the value to the library. | ||
:'''Note:''' In the case where the field to be set is a Link To Entry field, the second argument should be the entry name of the entry to link to. If there are, in that library, multiple fields set as | :'''Note:''' In the case where the field to be set is a Link To Entry field, the second argument should be the entry name of the entry to link to. If there are, in that library, multiple fields set as the entry name, the entry name for the set() method is formed by separating the value of those fields by a comma (,) — not a comma and a space, but only a comma. | ||
: '''Arguments''' | : '''Arguments''' | ||
| Line 137: | Line 137: | ||
::; entry: Entry in the field's related library identifying the link to be removed | ::; entry: Entry in the field's related library identifying the link to be removed | ||
==== ''Entry'' | ==== ''Entry'' properties ==== | ||
:; author: the id of the user who created the entry | :; author: the id of the user who created the entry | ||
:; creationTime: date & time the entry was created | :; creationTime: date & time the entry was created | ||
| Line 152: | Line 152: | ||
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'''. | 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'''. | ||
==== ''DefaultEntry'' | ==== ''DefaultEntry'' methods ==== | ||
===== set(name, value) ===== | ===== set(name, value) ===== | ||
| Line 163: | Line 163: | ||
=== Library & Entry objects examples === | === Library & Entry objects examples === | ||
See '''[[Trigger Examples#Libraries | See '''[[Trigger Examples#Libraries examples]]'''. | ||
<br/> | <br/> | ||
----- | ----- | ||
| Line 173: | Line 173: | ||
To work with the files, the library should have read/write file access. | To work with the files, the library should have read/write file access. | ||
=== ''File'' | === ''File'' global functions === | ||
==== file(name) ==== | ==== file(name) ==== | ||
| Line 188: | Line 188: | ||
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()''. | 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()''. | ||
==== ''File'' | ==== ''File'' methods ==== | ||
:; close(): Close the file. It can subsequently be reopened. | :; close(): Close the file. It can subsequently be reopened. | ||
| Line 211: | Line 211: | ||
:; writeLine(text): Write strings and a newline to the file stream | :; writeLine(text): Write strings and a newline to the file stream | ||
==== ''File'' | ==== ''File'' properties ==== | ||
:; exists: true — if and only if the file exists; false otherwise | :; exists: true — 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. | :; length: The length, in bytes, of the file, or 0L if the file does not exist. | ||
<br/> | <br/> | ||
=== Files | === Files examples === | ||
See '''[[Trigger Examples#Files | See '''[[Trigger Examples#Files examples]]'''. | ||
<br/> | <br/> | ||
----- | ----- | ||
| Line 234: | Line 234: | ||
Interface for processing HTTP requests | Interface for processing HTTP requests | ||
==== ''Http'' | ==== ''Http'' methods ==== | ||
===== get(url) ===== | ===== get(url) ===== | ||
| Line 279: | Line 279: | ||
<br/> | <br/> | ||
==== '' Method'' ==== | ==== ''Method'' ==== | ||
===== header(tag) ===== | ===== header(tag) ===== | ||
| Line 285: | Line 285: | ||
::; tag: ??? | ::; tag: ??? | ||
=== Http | === Http examples === | ||
See '''[[Trigger Examples#Http | See '''[[Trigger Examples#Http examples]]'''. | ||
<br/> | <br/> | ||
----- | ----- | ||
<br/> | <br/> | ||
== Performing | == Performing email functions == | ||
=== ''Email'' | === ''Email'' global functions === | ||
==== email() ==== | ==== email() ==== | ||
| Line 301: | Line 301: | ||
This object provides methods related to email. | This object provides methods related to email. | ||
==== ''Email'' | ==== ''Email'' global functions ==== | ||
:; send(): Send an email message based on a provided Smtp configuration object and other arguments. | :; send(): Send an email message based on a provided Smtp configuration object and other arguments. | ||
:: '''Arguments''' | :: '''Arguments''' | ||
| Line 311: | Line 311: | ||
=== Object ''EmailConfig'' === | === Object ''EmailConfig'' === | ||
==== ''EmailConfig'' | ==== ''EmailConfig'' properties ==== | ||
:; host: The SMTP server from which to base email requests | :; host: The SMTP server from which to base email requests | ||
| Line 323: | Line 323: | ||
:; from: The email address for the email "From:" line | :; from: The email address for the email "From:" line | ||
=== Email | === Email example === | ||
Send an email message in the background | Send an email message in the background | ||
<source lang="JavaScript"> | <source lang="JavaScript"> | ||
| Line 337: | Line 337: | ||
== Interaction with the System == | == Interaction with the System == | ||
=== ''System'' | === ''System'' global functions === | ||
==== cancel() ==== | ==== cancel() ==== | ||
| Line 377: | Line 377: | ||
:; exit(): End script execution | :; exit(): End script execution | ||
==== ''System'' | ==== ''System'' properties ==== | ||
:; os: Name of the operating system executing the script | :; os: Name of the operating system executing the script | ||
<br/> | <br/> | ||
| Line 384: | Line 384: | ||
Information exchange object. This object is created by using the global function ''intent()''. | Information exchange object. This object is created by using the global function ''intent()''. | ||
==== ''Intent'' | ==== ''Intent'' methods ==== | ||
===== data(uri) ===== | ===== data(uri) ===== | ||
| Line 412: | Line 412: | ||
<br/> | <br/> | ||
=== System | === System examples === | ||
See '''[[Trigger Examples#System | See '''[[Trigger Examples#System examples]]'''. | ||
<br/> | <br/> | ||
----- | ----- | ||
| Line 426: | Line 426: | ||
If the Contact field contains multiple contacts, use ''hasNext'' and ''next'' to retrieve them. | If the Contact field contains multiple contacts, use ''hasNext'' and ''next'' to retrieve them. | ||
==== JSContact | ==== JSContact methods ==== | ||
:; call(): If the device is a phone, calls the primary phone number of this contact | :; call(): If the device is a phone, calls the primary phone number of this contact | ||
| Line 436: | Line 436: | ||
:; show(): Opens the Contacts app for this contact | :; show(): Opens the Contacts app for this contact | ||
==== JSContact | ==== JSContact properties ==== | ||
:; email: The primary email address of this contact | :; email: The primary email address of this contact | ||
| Line 458: | Line 458: | ||
If the Location field contains multiple locations, use ''hasNext'' and ''next'' to retrieve them. | If the Location field contains multiple locations, use ''hasNext'' and ''next'' to retrieve them. | ||
==== JSGeolocation | ==== JSGeolocation properties ==== | ||
:; address: Address for this Location | :; address: Address for this Location | ||
| Line 472: | Line 472: | ||
<br/> | <br/> | ||
=== Built-in Objects | === Built-in Objects examples === | ||
See '''[[Trigger Examples#Built-in Objects | See '''[[Trigger Examples#Built-in Objects examples]]'''. | ||
<br/> | <br/> | ||
----- | ----- | ||