Mercurial > libervia-backend
diff src/bridge/bridge_template.ini @ 265:b5f1f3dc9ac6
bridge: automatic bridge generator, first draft
author | Goffi <goffi@goffi.org> |
---|---|
date | Mon, 24 Jan 2011 01:22:00 +0100 |
parents | |
children | c4b84a2d2ad1 |
line wrap: on
line diff
--- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/src/bridge/bridge_template.ini Mon Jan 24 01:22:00 2011 +0100 @@ -0,0 +1,316 @@ +;signals + +[connected] +type=signal +category=communication +sig_in=s +doc=Connection is done + +[disconnected] +type=signal +category=communication +sig_in=s +doc=Connection is finished or lost + +[connection_error] +type=signal +category=communication +sig_in=ss +doc=Something went wront with the connection + +[newContact] +type=signal +category=communication +sig_in=sa{ss}ass +doc=New contact received in roster + +[newMessage] +type=signal +category=communication +sig_in=sssss +doc=A message has been received + +[newAlert] +type=signal +category=communication +sig_in=ssss +doc=A message has been received + +[presenceUpdate] +type=signal +category=communication +sig_in=ssia{ss}s +doc=Somebody changed his presence informations. + +[subscribe] +type=signal +category=communication +sig_in=sss +doc=Somebody wants to be added in roster list + +[paramUpdate] +type=signal +category=communication +sig_in=ssss +doc=A parameter has been changed + +[contactDeleted] +type=signal +category=communication +sig_in=ss +doc=A contact has been supressed from roster list + +[askConfirmation] +type=signal +category=request +sig_in=ssa{ss} +doc=A confirmation is needed for an action + +[actionResult] +type=signal +category=request +sig_in=ssa{ss} +doc=Requested result of an action + +[actionResultExt] +type=signal +category=request +sig_in=ssa{sa{ss}} +doc=Requested result of an action (Extended) + +[updatedValue] +type=signal +category=request +sig_in=sa{ss} +doc=A value has been updated + +;methods + +[getVersion] +type=method +category=request +sig_in= +sig_out=s +doc=Get "Salut à Toi" version + +[getProfileName] +type=method +category=request +sig_in=s +sig_out=s +doc=Get real profile name from profile key + +[getProfilesList] +type=method +category=request +sig_in= +sig_out=as +doc=Get all profiles + +[createProfile] +type=method +category=request +sig_in=s +sig_out=i +doc=Create a new profile + +[deleteProfile] +type=method +category=request +sig_in=s +sig_out=i +doc=Delete a profile + +[registerNewAccount] +type=method +category=communication +sig_in=sssi +sig_out=s +doc=Register a new account on a given server + +[connect] +type=method +category=communication +sig_in=s +sig_out= +param_0_default="@DEFAULT@" +doc=Connect a profile + +[disconnect] +type=method +category=communication +sig_in=s +sig_out= +param_0_default="@DEFAULT@" +doc=Disconnect a profile + +[isConnected] +type=method +category=communication +sig_in= +sig_out=b +param_0_default="@DEFAULT@" +doc=Tell if a profile is connected + +[getContacts] +type=method +category=communication +sig_in=s +sig_out=a(sa{ss}as) +param_0_default="@DEFAULT@" +doc=Return informations about all contacts + +[getPresenceStatus] +type=method +category=communication +sig_in=s +sig_out=a{sa{s(sia{ss})}} +param_0_default="@DEFAULT@" +doc=Return presence informations of all contacts + +[getWaitingSub] +type=method +category=communication +sig_in=s +sig_out=a{ss} +param_0_default="@DEFAULT@" +doc=Get subscription requests in queue + +[sendMessage] +type=method +category=communication +sig_in=sssss +sig_out= +param_4_default="@DEFAULT@" +doc=Send a message + +[setPresence] +type=method +category=communication +sig_in=ssia{ss}s +sig_out= +param_4_default="@DEFAULT@" +doc=Set presence information for the profile + +[subscription] +type=method +category=communication +sig_in=sss +sig_out= +param_2_default="@DEFAULT@" +doc=Send subscription request/answer to a contact + +[setParam] +type=method +category=communication +sig_in=ssss +sig_out= +param_3_default="@DEFAULT@" +doc=Change a parameter + +[getParamA] +type=method +category=communication +sig_in=sss +sig_out=s +param_2_default="@DEFAULT@" +doc=Helper method to get a parameter's attribute + +[getParamsUI] +type=method +category=communication +sig_in=s +sig_out=s +param_0_default="@DEFAULT@" +doc=Return a SàT XMLUI for parameters + +[getParams] +type=method +category=communication +sig_in=s +sig_out=s +param_0_default="@DEFAULT@" +doc=Return XML of parameters + +[getParamsForCategory] +type=method +category=communication +sig_in=ss +sig_out=s +param_1_default="@DEFAULT@" +doc=Return a xml of all params in a category + +[getParamsCategories] +type=method +category=communication +sig_in= +sig_out=as +doc=Get all categories currently existing in parameters + +[getHistory] +type=method +category=communication +sig_in=ssi +sig_out=a{i(ss)} +doc=Get history of a communication between two entities + +[addContact] +type=method +category=communication +sig_in=ss +sig_out= +param_1_default="@DEFAULT@" +doc=Add a contact to profile's roster list + +[delContact] +type=method +category=communication +sig_in=ss +sig_out= +param_1_default="@DEFAULT@" +doc=Remove a contact from profile's roster list + +[launchAction] +type=method +category=request +sig_in=sa{ss}s +sig_out=s +param_2_default="@DEFAULT@" +doc=Launch a specific action + +[confirmationAnswer] +type=method +category=request +sig_in=sba{ss} +sig_out= +doc=Give answer to a confirmation request + +[getProgress] +type=method +category=request +sig_in=s +sig_out=a{ss} +doc=Get progress information for an action + +[getMenus] +type=method +category=request +sig_in= +sig_out=a(sss) +doc=Get all additional menus + +[getMenuHelp] +type=method +category=request +sig_in=sss +sig_out=s +param_2="NORMAL" +doc=Get help informationd for a menu + +[callMenu] +type=method +category=request +sig_in=ssss +sig_out=s +doc=Execute action associated with a menu +