Mercurial > libervia-backend

comparison src/bridge/bridge_template.ini @ 265:b5f1f3dc9ac6

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
bridge: automatic bridge generator, first draft
author Goffi <goffi@goffi.org>
date Mon, 24 Jan 2011 01:22:00 +0100
parents
children c4b84a2d2ad1
comparison
equal deleted inserted replaced
264:27bc5d7732a3 265:b5f1f3dc9ac6
1 ;signals
2
3 [connected]
4 type=signal
5 category=communication
6 sig_in=s
7 doc=Connection is done
8
9 [disconnected]
10 type=signal
11 category=communication
12 sig_in=s
13 doc=Connection is finished or lost
14
15 [connection_error]
16 type=signal
17 category=communication
18 sig_in=ss
19 doc=Something went wront with the connection
20
21 [newContact]
22 type=signal
23 category=communication
24 sig_in=sa{ss}ass
25 doc=New contact received in roster
26
27 [newMessage]
28 type=signal
29 category=communication
30 sig_in=sssss
31 doc=A message has been received
32
33 [newAlert]
34 type=signal
35 category=communication
36 sig_in=ssss
37 doc=A message has been received
38
39 [presenceUpdate]
40 type=signal
41 category=communication
42 sig_in=ssia{ss}s
43 doc=Somebody changed his presence informations.
44
45 [subscribe]
46 type=signal
47 category=communication
48 sig_in=sss
49 doc=Somebody wants to be added in roster list
50
51 [paramUpdate]
52 type=signal
53 category=communication
54 sig_in=ssss
55 doc=A parameter has been changed
56
57 [contactDeleted]
58 type=signal
59 category=communication
60 sig_in=ss
61 doc=A contact has been supressed from roster list
62
63 [askConfirmation]
64 type=signal
65 category=request
66 sig_in=ssa{ss}
67 doc=A confirmation is needed for an action
68
69 [actionResult]
70 type=signal
71 category=request
72 sig_in=ssa{ss}
73 doc=Requested result of an action
74
75 [actionResultExt]
76 type=signal
77 category=request
78 sig_in=ssa{sa{ss}}
79 doc=Requested result of an action (Extended)
80
81 [updatedValue]
82 type=signal
83 category=request
84 sig_in=sa{ss}
85 doc=A value has been updated
86
87 ;methods
88
89 [getVersion]
90 type=method
91 category=request
92 sig_in=
93 sig_out=s
94 doc=Get "Salut à Toi" version
95
96 [getProfileName]
97 type=method
98 category=request
99 sig_in=s
100 sig_out=s
101 doc=Get real profile name from profile key
102
103 [getProfilesList]
104 type=method
105 category=request
106 sig_in=
107 sig_out=as
108 doc=Get all profiles
109
110 [createProfile]
111 type=method
112 category=request
113 sig_in=s
114 sig_out=i
115 doc=Create a new profile
116
117 [deleteProfile]
118 type=method
119 category=request
120 sig_in=s
121 sig_out=i
122 doc=Delete a profile
123
124 [registerNewAccount]
125 type=method
126 category=communication
127 sig_in=sssi
128 sig_out=s
129 doc=Register a new account on a given server
130
131 [connect]
132 type=method
133 category=communication
134 sig_in=s
135 sig_out=
136 param_0_default="@DEFAULT@"
137 doc=Connect a profile
138
139 [disconnect]
140 type=method
141 category=communication
142 sig_in=s
143 sig_out=
144 param_0_default="@DEFAULT@"
145 doc=Disconnect a profile
146
147 [isConnected]
148 type=method
149 category=communication
150 sig_in=
151 sig_out=b
152 param_0_default="@DEFAULT@"
153 doc=Tell if a profile is connected
154
155 [getContacts]
156 type=method
157 category=communication
158 sig_in=s
159 sig_out=a(sa{ss}as)
160 param_0_default="@DEFAULT@"
161 doc=Return informations about all contacts
162
163 [getPresenceStatus]
164 type=method
165 category=communication
166 sig_in=s
167 sig_out=a{sa{s(sia{ss})}}
168 param_0_default="@DEFAULT@"
169 doc=Return presence informations of all contacts
170
171 [getWaitingSub]
172 type=method
173 category=communication
174 sig_in=s
175 sig_out=a{ss}
176 param_0_default="@DEFAULT@"
177 doc=Get subscription requests in queue
178
179 [sendMessage]
180 type=method
181 category=communication
182 sig_in=sssss
183 sig_out=
184 param_4_default="@DEFAULT@"
185 doc=Send a message
186
187 [setPresence]
188 type=method
189 category=communication
190 sig_in=ssia{ss}s
191 sig_out=
192 param_4_default="@DEFAULT@"
193 doc=Set presence information for the profile
194
195 [subscription]
196 type=method
197 category=communication
198 sig_in=sss
199 sig_out=
200 param_2_default="@DEFAULT@"
201 doc=Send subscription request/answer to a contact
202
203 [setParam]
204 type=method
205 category=communication
206 sig_in=ssss
207 sig_out=
208 param_3_default="@DEFAULT@"
209 doc=Change a parameter
210
211 [getParamA]
212 type=method
213 category=communication
214 sig_in=sss
215 sig_out=s
216 param_2_default="@DEFAULT@"
217 doc=Helper method to get a parameter's attribute
218
219 [getParamsUI]
220 type=method
221 category=communication
222 sig_in=s
223 sig_out=s
224 param_0_default="@DEFAULT@"
225 doc=Return a SàT XMLUI for parameters
226
227 [getParams]
228 type=method
229 category=communication
230 sig_in=s
231 sig_out=s
232 param_0_default="@DEFAULT@"
233 doc=Return XML of parameters
234
235 [getParamsForCategory]
236 type=method
237 category=communication
238 sig_in=ss
239 sig_out=s
240 param_1_default="@DEFAULT@"
241 doc=Return a xml of all params in a category
242
243 [getParamsCategories]
244 type=method
245 category=communication
246 sig_in=
247 sig_out=as
248 doc=Get all categories currently existing in parameters
249
250 [getHistory]
251 type=method
252 category=communication
253 sig_in=ssi
254 sig_out=a{i(ss)}
255 doc=Get history of a communication between two entities
256
257 [addContact]
258 type=method
259 category=communication
260 sig_in=ss
261 sig_out=
262 param_1_default="@DEFAULT@"
263 doc=Add a contact to profile's roster list
264
265 [delContact]
266 type=method
267 category=communication
268 sig_in=ss
269 sig_out=
270 param_1_default="@DEFAULT@"
271 doc=Remove a contact from profile's roster list
272
273 [launchAction]
274 type=method
275 category=request
276 sig_in=sa{ss}s
277 sig_out=s
278 param_2_default="@DEFAULT@"
279 doc=Launch a specific action
280
281 [confirmationAnswer]
282 type=method
283 category=request
284 sig_in=sba{ss}
285 sig_out=
286 doc=Give answer to a confirmation request
287
288 [getProgress]
289 type=method
290 category=request
291 sig_in=s
292 sig_out=a{ss}
293 doc=Get progress information for an action
294
295 [getMenus]
296 type=method
297 category=request
298 sig_in=
299 sig_out=a(sss)
300 doc=Get all additional menus
301
302 [getMenuHelp]
303 type=method
304 category=request
305 sig_in=sss
306 sig_out=s
307 param_2="NORMAL"
308 doc=Get help informationd for a menu
309
310 [callMenu]
311 type=method
312 category=request
313 sig_in=ssss
314 sig_out=s
315 doc=Execute action associated with a menu
316