agama/doc/dbus/org.opensuse.Agama1.Registration.doc.xml
Martin Vidner c8c7f81be5 doc/dbus: fix the "markup" to render all what is documented
gdbus-codegen is picky about what it lets through.
You have to check that what you write actually gets rendered
in the resulting HTML

BTW there are remnants documenting an abandoned Agama.Network design:
TODO: remove it
https://github.com/search?q=repo%3Aagama-project%2Fagama+%2Forg.*Agama.*Network%2F&type=code
2025-04-13 19:08:20 +02:00

86 lines
2.4 KiB
XML

<?xml version="1.0" encoding="UTF-8"?>
<node name="/org/opensuse/Agama/Software1/Product">
<!--
org.opensuse.Agama1.Registration:
@short_description: Interface for registering a product.
-->
<interface name="org.opensuse.Agama1.Registration">
<!--
Register:
@reg_code: Registration code.
@result: Result code and description.
Registers the currently selected product.
@options are:
<programlisting>
Email s
</programlisting>
Possible @result codes are:
<programlisting>
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)
</programlisting>
-->
<method name="Register">
<arg name="reg_code" direction="in" type="s"/>
<arg name="options" direction="in" type="a{sv}"/>
<arg name="result" direction="out" type="(us)"/>
</method>
<!--
Deregister:
@result: Result code and description.
Deregisters the currently selected product.
Possible result codes are:
<programlisting>
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)
</programlisting>
-->
<method name="Deregister">
<arg name="result" direction="out" type="(us)"/>
</method>
<!--
RegCode:
Registration code. Empty if the current product is not registered yet.
-->
<property type="s" name="RegCode" access="read"/>
<!--
Email:
Email used for the registration. Empty if the current product is not registered yet.
-->
<property type="s" name="Email" access="read"/>
<!--
Requirement:
Indicates the registration requirement of the currently selected product.
Possible values:
<programlisting>
0: registration is not required.
1: registration is optional.
2: registration is mandatory.
</programlisting>
-->
<property type="u" name="Requirement" access="read"/>
</interface>
</node>