OpenPrefs

Add items to a list or detail_list preference. Items already on the list are reported, not added twice.

add_list_items

Change items of a list or detail_list preference, found by label: rename one with new_label, or set some of a detail_list item's fields, such as its rating or note. Fields left out keep their values; null clears one.

update_list_items

Check which of some labels a list or detail_list preference holds, such as whether the user has seen a movie.

list_contains

Create a preference so it can be stored and read from now on, without a restart. Use it when the user wants to record something no existing key covers. The key belongs to this user alone and its space is created if needed. Scalar types need a first value; lists start empty. Give it aliases, the other words the user might use for it, such as "films I've seen" for watched movies, since search finds a preference by its name, aliases and description. Define the key again to update it: the type is fixed, and a name, config or aliases omitted keep the current ones. A new config may add choice options or detail_list columns, rename columns or change a number's unit, as long as the current value still fits it.

define_preference

Delete one of the user's preferences, with its items if it is a list. Only call this when the user asks.

delete_preference

Read the items of a list or detail_list preference in order, one page at a time.

list_items

Read the user's preferences by exact key, up to 20 at a time. Find keys with search_preferences first. List preferences report their item_count; read their items with list_items.

get_preferences

Remove items from a list or detail_list preference by label.

remove_list_items

Search the user's preferences and list items by words, tolerating typos, such as "films I've seen" or "The Godfather". This is how to find a preference's key before reading or changing it.

search_preferences

Store up to 20 of the user's toggle, text, number, choice or time_rule preferences at once. Only call this when the user has stated the preference clearly. Values are validated against each key's type. Only existing keys can be set; create a new one with define_preference.

set_preferences