about summary refs log tree commit diff stats
path: root/apidocs
diff options
context:
space:
mode:
authorJames Booth <boothj5@gmail.com>2016-08-07 00:22:21 +0100
committerJames Booth <boothj5@gmail.com>2016-08-07 00:22:21 +0100
commit4f7af4e429612167c8c4242a2096e001a43a2318 (patch)
treeed3801395085ae8145994bffcb0e53b62fc0a325 /apidocs
parentefeb2fcfcd9a86bf80558c86fc92dadc3fbf52b8 (diff)
downloadprofani-tty-4f7af4e429612167c8c4242a2096e001a43a2318.tar.gz
Update plugin API docs
Diffstat (limited to 'apidocs')
-rw-r--r--apidocs/c/profapi.h16
-rw-r--r--apidocs/python/src/prof.py16
2 files changed, 16 insertions, 16 deletions
diff --git a/apidocs/c/profapi.h b/apidocs/c/profapi.h
index c6b293e7..6e625f2c 100644
--- a/apidocs/c/profapi.h
+++ b/apidocs/c/profapi.h
@@ -217,7 +217,7 @@ Settings must be specified in ~/.local/share/profanity/plugin_settings
 @param def default value if setting not found
 @return the setting, or default value
 */
-int prof_settings_get_boolean(char *group, char *key, int def);
+int prof_settings_boolean_get(char *group, char *key, int def);
 
 /**
 Set a boolean setting
@@ -226,7 +226,7 @@ Settings must be specified in ~/.local/share/profanity/plugin_settings
 @param key the item name within the group
 @param value value to set
 */
-void prof_settings_set_boolean(char *group, char *key, int value);
+void prof_settings_boolean_set(char *group, char *key, int value);
 
 /**
 Get a string setting
@@ -236,7 +236,7 @@ Settings must be specified in ~/.local/share/profanity/plugin_settings
 @param def default value if setting not found
 @return the setting, or default value
 */
-char* prof_settings_get_string(char *group, char *key, char *def);
+char* prof_settings_string_get(char *group, char *key, char *def);
 
 /**
 Set a string setting
@@ -245,7 +245,7 @@ Settings must be specified in ~/.local/share/profanity/plugin_settings
 @param key the item name within the group
 @param value value to set
 */
-void prof_settings_set_string(char *group, char *key, char *value);
+void prof_settings_string_set(char *group, char *key, char *value);
 
 /**
 Get a string list setting
@@ -255,7 +255,7 @@ The string list setting items are separated by semicolons.
 @param key the item name within the group
 @return the list setting
 */
-char** prof_settings_get_string_list(char *group, char *key);
+char** prof_settings_string_list_get(char *group, char *key);
 
 /**
 Add an item to a string list setting
@@ -284,7 +284,7 @@ Settings must be specified in ~/.local/share/profanity/plugin_settings
 @param key the item name within the group
 @return 1 if the list was cleared, 0 if the list does not exist
 */
-int prof_settings_string_list_remove_all(char *group, char *key);
+int prof_settings_string_list_clear(char *group, char *key);
 
 /**
 Get an integer setting
@@ -294,7 +294,7 @@ Settings must be specified in ~/.local/share/profanity/plugin_settings
 @param def default value if setting not found
 @return the setting, or default value
 */
-int prof_settings_get_int(char *group, char *key, int def);
+int prof_settings_int_get(char *group, char *key, int def);
 
 /**
 Set an integer setting
@@ -303,7 +303,7 @@ Settings must be specified in ~/.local/share/profanity/plugin_settings
 @param key the item name within the group
 @param value value to set
 */
-void prof_settings_set_int(char *group, char *key, int value);
+void prof_settings_int_set(char *group, char *key, int value);
 
 /**
 Trigger incoming message handling, this plugin will make profanity act as if the message has been received
diff --git a/apidocs/python/src/prof.py b/apidocs/python/src/prof.py
index d25a5943..e91e8852 100644
--- a/apidocs/python/src/prof.py
+++ b/apidocs/python/src/prof.py
@@ -388,7 +388,7 @@ def send_stanza(stanza):
     pass
 
 
-def settings_get_boolean(group, key, default):
+def settings_boolean_get(group, key, default):
     """Get a boolean setting\n
     Settings must be specified in ``~/.local/share/profanity/plugin_settings``
 
@@ -406,7 +406,7 @@ def settings_get_boolean(group, key, default):
     pass
 
 
-def settings_set_boolean(group, key, value):
+def settings_boolean_set(group, key, value):
     """Set a boolean setting\n
     Settings must be specified in ``~/.local/share/profanity/plugin_settings``
 
@@ -424,7 +424,7 @@ def settings_set_boolean(group, key, value):
     pass
 
 
-def settings_get_string(group, key, default):
+def settings_string_get(group, key, default):
     """Get a string setting\n
     Settings must be specified in ``~/.local/share/profanity/plugin_settings``
 
@@ -442,7 +442,7 @@ def settings_get_string(group, key, default):
     pass
 
 
-def settings_set_string(group, key, value):
+def settings_string_set(group, key, value):
     """Set a string setting\n
     Settings must be specified in ``~/.local/share/profanity/plugin_settings``
 
@@ -460,7 +460,7 @@ def settings_set_string(group, key, value):
     pass
 
 
-def settings_get_string_list(group, key):
+def settings_string_list_get(group, key):
     """Get a string list setting\n
     Settings must be specified in ``~/.local/share/profanity/plugin_settings``\n
     The string list setting items are separated by semicolons.
@@ -515,7 +515,7 @@ def settings_string_list_remove(group, key, value):
     """
 
 
-def settings_string_list_remove_all(group, key):
+def settings_string_list_clear(group, key):
     """Remove all items from a string list setting\n
     Settings must be specified in ``~/.local/share/profanity/plugin_settings``\n
 
@@ -532,7 +532,7 @@ def settings_string_list_remove_all(group, key):
     """
 
 
-def settings_get_int(group, key, default):
+def settings_int_get(group, key, default):
     """Get an integer setting\n
     Settings must be specified in ``~/.local/share/profanity/plugin_settings``
 
@@ -550,7 +550,7 @@ def settings_get_int(group, key, default):
     pass
 
 
-def settings_set_int(group, key, value):
+def settings_int_set(group, key, value):
     """Set an integer setting\n
     Settings must be specified in ``~/.local/share/profanity/plugin_settings``
 
ynx-snapshots/commit/src/chrtrans/README.format?id=d3f9d5478df478427c2aa5db4507ddd0a38f0eb6'>d3f9d547 ^
e4409c40 ^
c82d2a40 ^
d3f9d547 ^
e4409c40 ^

327b7c16 ^

e4409c40 ^



b63d287c ^

e4409c40 ^



b63d287c ^
e47cfd56 ^
e4409c40 ^


d3f9d547 ^
e4409c40 ^







08fc6e5c ^
e9b52cbf ^



08fc6e5c ^
e9b52cbf ^

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138