blob: 078c1a5ee7e41e4b073973dcbc31be076608238b [file] [log] [blame]
Create (or Delete) a preference: PREFERENCE (-del)
A preference is a internal variable that can be used upon loading or while
running the plugin. It should be correctly formed and listed in a preferences.json
file. Also, a preference value only can be modified during runtime if the code that
applies the new value is within your functionality implementation. For more
technical information, please refer to:
https://git.jami.net/savoirfairelinux/ring-project/wikis/technical/7.-Jami-plugins .
Prior continuing, and to easy the process of constructing your preferences, take your
time to think about the list of preferences you will be needing.
But do not worry! If you forget something you will have the oportunity to change it
later.
Example of preferences:
-> LIST:
{
"category" : "Streams",
"type": "List",
"key": "videostreams",
"title": "Streams to transform",
"summary": "Select video to transform",
"defaultValue": "0",
"entries": ["sent", "received"],
"entryValues": ["0", "1"],
"scope": "plugin"
}
-> PATH:
{
"category" : "Backgrounds",
"type": "Path",
"mimeType": "image/png",
"key": "background",
"title": "Background image",
"summary": "Select the image background to use",
"defaultValue": "data/backgrounds/background2.png",
"scope": "plugin, foo"
}
For more detailed information for each of the preferences types, please specify the preference type:
-> preference -h list
-> preference -h path