All three methods are batchable via
apiBatch:
liveTables.find (args { item }, result { rows }), liveTables.items
(args { list }, result { items }), and liveTables.update (args
{ id, description, custom_keys }, result { success }).getLiveTableRowsByName
Finds all rows whose item name matches a given string, across lists. If you are searching for users, the name should be the user id as a string.Parameters
string
required
The item name to search for.
Returns
object[]
Matching rows. Empty if none match or the request failed.
Example
getLiveTableItemsById
Returns all items belonging to a specific list.Parameters
string
required
The id of the list to read.
Returns
object[]
The list’s items. Same shape as the rows returned by
getLiveTableRowsByName. Empty if the list is empty
or the request failed.Example
updateLiveTableItem
Updates the description and/or custom keys of a single Live Table item.Only the fields you provide are changed. Pass
nil for description or
custom_keys to leave that field untouched.Parameters
string
required
The id of the item to update.
string
New description. Only applied when a string is provided.
table
New custom key/value data. Only applied when a table is provided.
Returns
boolean
true if the item was updated. false if the item was not found or the
request failed.