comparison libervia/backend/bridge/bridge_constructor/bridge_template.ini @ 4148:a8a0fa678ce2

bridge: add `message_update` signal
author Goffi <goffi@goffi.org>
date Wed, 22 Nov 2023 14:26:13 +0100
parents 02f0adc745c6
children 730f542e4ad0
comparison
equal deleted inserted replaced
4147:11f95dfe5b17 4148:a8a0fa678ce2
37 [message_new] 37 [message_new]
38 type=signal 38 type=signal
39 category=core 39 category=core
40 sig_in=sdssa{ss}a{ss}sss 40 sig_in=sdssa{ss}a{ss}sss
41 doc=A message has been received 41 doc=A message has been received
42 doc_param_0=uid: unique ID of the message (id specific to SàT, this it *NOT* an XMPP id) 42 doc_param_0=uid: unique ID of the message (id specific to Libervia, this it *NOT* an XMPP id)
43 doc_param_1=timestamp: when the message was sent (or declared sent for delayed messages) 43 doc_param_1=timestamp: when the message was sent (or declared sent for delayed messages)
44 doc_param_2=from_jid: JID where the message is comming from 44 doc_param_2=from_jid: JID where the message is comming from
45 doc_param_3=to_jid: JID where the message must be sent 45 doc_param_3=to_jid: JID where the message must be sent
46 doc_param_4=message: message itself, can be in several languages (key is language code or '' for default) 46 doc_param_4=message: message itself, can be in several languages (key is language code or '' for default)
47 doc_param_5=subject: subject of the message, can be in several languages (key is language code or '' for default) 47 doc_param_5=subject: subject of the message, can be in several languages (key is language code or '' for default)
51 - thread_parent: id of the parent of the current thread 51 - thread_parent: id of the parent of the current thread
52 - received_timestamp: date of receiption for delayed messages 52 - received_timestamp: date of receiption for delayed messages
53 - delay_sender: entity which has originally sent or which has delayed the message 53 - delay_sender: entity which has originally sent or which has delayed the message
54 - info_type: subtype for info messages 54 - info_type: subtype for info messages
55 doc_param_8=%(doc_profile)s 55 doc_param_8=%(doc_profile)s
56
57 [message_update]
58 type=signal
59 category=core
60 sig_in=ssss
61 doc=An existing message has been updated
62 doc_param_0=uid: unique ID of the message (id specific to Libervia, this is *NOT* an XMPP id)
63 doc_param_1=message_type: Type of the update (can be "EDIT", "REACTION", or any of C.MESS_UPDATE_*)
64 doc_param_2=message_data: JSON serialized dictionary containing the updated message data. Keys and values will depend on the specific message and use case.
65 doc_param_3=%(doc_profile)s
56 66
57 [message_encryption_started] 67 [message_encryption_started]
58 type=signal 68 type=signal
59 category=core 69 category=core
60 sig_in=sss 70 sig_in=sss
340 param_0_default="@DEFAULT@" 350 param_0_default="@DEFAULT@"
341 param_1_default='' 351 param_1_default=''
342 param_2_default={} 352 param_2_default={}
343 doc=Connect a profile 353 doc=Connect a profile
344 doc_param_0=%(doc_profile_key)s 354 doc_param_0=%(doc_profile_key)s
345 doc_param_1=password: the SàT profile password 355 doc_param_1=password: the Libervia profile password
346 doc_param_2=options: connection options 356 doc_param_2=options: connection options
347 doc_return=a deferred boolean or failure: 357 doc_return=a deferred boolean or failure:
348 - boolean if the profile authentication succeed: 358 - boolean if the profile authentication succeed:
349 - True if the XMPP connection was already established 359 - True if the XMPP connection was already established
350 - False if the XMPP connection has been initiated (it may still fail) 360 - False if the XMPP connection has been initiated (it may still fail)
357 sig_in=ss 367 sig_in=ss
358 sig_out=b 368 sig_out=b
359 param_0_default='' 369 param_0_default=''
360 param_1_default="@DEFAULT@" 370 param_1_default="@DEFAULT@"
361 doc=Start a profile session without connecting it (if it's not already the case) 371 doc=Start a profile session without connecting it (if it's not already the case)
362 doc_param_0=password: the SàT profile password 372 doc_param_0=password: the Libervia profile password
363 doc_param_1=%(doc_profile_key)s 373 doc_param_1=%(doc_profile_key)s
364 doc_return=D(bool): 374 doc_return=D(bool):
365 - True if the profile session was already started 375 - True if the profile session was already started
366 - False else 376 - False else
367 377
688 sig_out=s 698 sig_out=s
689 param_0_default=-1 699 param_0_default=-1
690 param_1_default='' 700 param_1_default=''
691 param_2_default='' 701 param_2_default=''
692 param_3_default="@DEFAULT@" 702 param_3_default="@DEFAULT@"
693 doc=Return a SàT XMLUI for parameters, eventually restrict the result to the parameters concerning a given frontend 703 doc=Return a Libervia XMLUI for parameters, eventually restrict the result to the parameters concerning a given frontend
694 doc_param_0=%(doc_security_limit)s 704 doc_param_0=%(doc_security_limit)s
695 doc_param_1=app: name of the frontend requesting the parameters, or '' to get all parameters 705 doc_param_1=app: name of the frontend requesting the parameters, or '' to get all parameters
696 doc_param_2=extra: extra options/filters 706 doc_param_2=extra: extra options/filters
697 doc_param_3=%(doc_profile_key)s 707 doc_param_3=%(doc_profile_key)s
698 708