jester.help_map.couchdb.description_short=[[Access to CouchDB.]]
jester.help_map.couchdb.description_long=[[This module provides actions that allow access to CouchDB.
The module uses Luchia (https://github.com/thehunmonkgroup/luchia) to interface with CouchDB, so it must be installed and configured correctly.
For all actions below that support the 'server' parameter:
The 'server' parameter is a table of connection parameters to the CouchDB server, see http://thehunmonkgroup.github.com/luchia/modules/luchia.core.server.html#new_params for details.
If things aren't working, be sure to check the log file, as configured in luchia/conf.lua.
server=[[(Optional) Table of server connection parameters.]],
database=[[Database to connect to.]],
document_id=[[The document ID.]],
query_parameters=[[(Optional) A table of query parameters to pass to the server, eg. '{revs = "true"}']],
storage_area=[[(Optional) The storage area to store the document in after loading. Defaults to 'couchdb_retrieve_document'. This will contain 'document', 'id' and 'rev' keys on success, 'document' is a table representing the document.]],
server=[[(Optional) Table of server connection parameters.]],
database=[[Database to connect to.]],
document=[[A table of data representing the docuement to create, eg. '{hello = "world", foo = "bar"}']],
document_id=[[(Optional) The document ID, one will be generated by the server if not provided.]],
storage_area=[[(Optional) The storage area to store the server response in. Defaults to 'couchdb_create_document'. This will contain 'id' and 'rev' keys of the created document on success.]],
server=[[(Optional) Table of server connection parameters.]],
database=[[Database to connect to.]],
document=[[A table of data representing the docuement to update, eg. '{hello = "world", foo = "bar"}']],
document_id=[[The document ID.]],
document_rev=[[The current document revision.]],
storage_area=[[(Optional) The storage area to store the server response in. Defaults to 'couchdb_update_document'. This will contain 'id' and 'rev' keys of the updated document on success.]],
server=[[(Optional) Table of server connection parameters.]],
database=[[Database to connect to.]],
document_id=[[The document ID.]],
document_rev=[[The current document revision.]],
storage_area=[[(Optional) The storage area to store the server response in. Defaults to 'couchdb_delete_document'. This will contain 'id' and 'rev' keys of the deleted document on success.]],
file_path=[[File path to write the retrieved attachment to, eg. 'tmp/attachment.txt'.]],
storage_area=[[(Optional) The storage area to store the server response in. Defaults to 'couchdb_retrieve_attachment'. This will contain 'attachment_name' and 'file_path' keys of the retrieved attachment on success.]],
server=[[(Optional) Table of server connection parameters.]],
database=[[Database to connect to.]],
file_path=[[File path to the attachment, eg. 'tmp/attachment.txt'.]],
content_type=[[MIME type of the attachment, eg. 'text/plain'.]],
attachment_name=[[(Optional) File name for the attachment, eg. 'attachment.txt'.]],
document_id=[[(Optional) The document ID. If not provided, a new empty document will be created.]],
document_rev=[[The current document revision, required if attaching to an existing document.]],
storage_area=[[(Optional) The storage area to store the server response in. Defaults to 'couchdb_add_attachment'. This will contain 'id' and 'rev' keys of the updated document on success.]],
storage_area=[[(Optional) The storage area to store the server response in. Defaults to 'couchdb_delete_attachment'. This will contain 'id' and 'rev' keys of the updated document on success.]],
jester.help_map.event.actions.fire_event.description_short=[[Fires a custom event.]]
jester.help_map.event.actions.fire_event.description_long=[[Fires a custom event. The event name will be 'CUSTOM', and the event type will be 'jester::[event_type]'.
jester.help_map.event.actions.fire_event.description_long=[[Fires a custom event. Event-Name will be 'CUSTOM', and Event-Subclass will be '[subclass]::[event_type]'.
All headers will be prefixed with 'Jester-', and the body will automatically have two newline characters appended to it.]]
The body will automatically have two newline characters appended to it.]]
jester.help_map.event.actions.fire_event.params={
event_type=[[The event type.]],
subclass=[[(Optional) The first portion of the Event-Subclass header (before the double colons). Default is 'jester'.]],
event_type=[[The second portion of the Event-Subclass header (after the double colons).]],
headers=[[(Optional) A table of event headers, key = header name, value = header description. Note that some headers will need to use the full table key syntax, eg. 'headers = {["Custom-Value"] = "foo"}'.]],
header_prefix=[[(Optional) Prefix all header keys with this string. Defaults to 'Jester-'.]],
2. A relative file path from the FreeSWITCH 'sounds' directory
3. A phrase prefixed with 'phrase:', eg, 'phrase:invalid_sound'.
To play several files together in a group, pass a table of names instead, eg. 'file = { "foo", "bar", "phrase:goodbye" }'.]],
To play several files together in a group, pass a table of names instead, eg. 'file = { "/tmp/foo.wav", "bar.wav", "phrase:goodbye" }'. Internally, Jester uses an ampersand (&) as the default delimiter for playback of mulitple files; to override this, set the 'playback_delimiter' variable in either the global or profile configuration file.]],
repetitions=[[(Optional) How many times to repeat the file(s). Default is 1.]],
wait=[[(Optional) How long to wait between repetitions, in milliseconds. Default is no wait.]],
jester.help_map.speech_to_text.description_short=[[Speech to text translation. WARNING: experimental.]]
jester.help_map.speech_to_text.description_long=[[This module provides speech to text translation. WARNING: totally experimental, no guarantees it will work!
The module requires the Lua JSON package, more details at http://luaforge.net/projects/json]]
The module requires the Lua lua-cjson package, more details at http://luarocks.org/repositories/rocks]]
