agama/doc/dbus/org.opensuse.Agama1.Registration.doc.xml
2025-04-17 10:24:37 +02:00

80 lines
2.2 KiB
XML

<?xml version="1.0" encoding="UTF-8"?>
<node name="/org/opensuse/Agama/Software1/Product">
<!--
Interface for registering a product.
-->
<interface name="org.opensuse.Agama1.Registration">
<!--
Registers the currently selected product.
-->
<method name="Register">
<!--
Registration code.
-->
<arg name="reg_code" direction="in" type="s"/>
<!--
Email s
-->
<arg name="options" direction="in" type="a{sv}"/>
<!--
Result code and description.
Possible result codes are:
0: success
1: missing product
2: already registered
3: registration not required
4: network error
5: timeout error
6: api error
7: missing credentials
8: incorrect credentials
8: invalid certificate
10: internal error (e.g., parsing json data)
-->
<arg name="result" direction="out" type="(us)"/>
</method>
<!--
Deregisters the currently selected product.
-->
<method name="Deregister">
<!--
Result code and description.
Possible result codes are:
0: success
1: missing product
2: not registered yet
3: network error
4: timeout error
5: api error
6: missing credentials
7: incorrect credentials
8: invalid certificate
9: internal error (e.g., parsing json data)
-->
<arg name="result" direction="out" type="(us)"/>
</method>
<!--
Registration code. Empty if the current product is not registered yet.
-->
<property type="s" name="RegCode" access="read"/>
<!--
Email used for the registration. Empty if the current product is not registered yet.
-->
<property type="s" name="Email" access="read"/>
<!--
URL used to register against. Empty means use default
-->
<property type="s" name="Url" access="readwrite"/>
<!--
Indicates the registration requirement of the currently selected product.
Possible values:
0: registration is not required.
1: registration is optional.
2: registration is mandatory.
-->
<property type="u" name="Requirement" access="read"/>
</interface>
</node>