1
0
Fork 0
mirror of https://gitlab.gnome.org/GNOME/calls.git synced 2025-01-12 14:55:33 +00:00
Purism-Calls/src/dbus/org.gnome.Calls.Call.xml
Evangelos Ribeiro Tzaras cde517096b dbus: Add hint property
This is a dictionary to allow for future extensibility. Currently we're only
hinting if the UI should be shown for a given call.
2022-02-03 12:37:05 +01:00

165 lines
4.6 KiB
XML

<!DOCTYPE node PUBLIC
"-//freedesktop//DTD D-BUS Object Introspection 1.0//EN"
"http://www.freedesktop.org/standards/dbus/1.0/introspect.dtd">
<!--
Copyright (C) 2021 Purism SPC
This library is free software; you can redistribute it and/or
modify it under the terms of the GNU Lesser General Public
License as published by the Free Software Foundation; either
version 3 of the License, or (at your option) any later version.
This library is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
Lesser General Public License for more details.
You should have received a copy of the GNU Lesser General
Public License along with this library; if not, see <http://www.gnu.org/licenses/>.
-->
<node>
<!--
org.gnome.Calls.Call:
This objects lets applications accept, reject calls
and query call properties like the call state, the id of the remote
peer and more.
-->
<interface name="org.gnome.Calls.Call">
<!--
Accept:
Accept the incoming call.
-->
<method name="Accept"/>
<!--
Hangup:
Hang up the call
-->
<method name="Hangup"/>
<!--
SendDtmf:
@tone: A one character string. One of: 0-9,A-D,* or #.
Send DTMF tone.
-->
<method name="SendDtmf">
<arg name="tone" type="s" direction="in">
<doc:doc>
<doc:summary>A one character string. One of: 0-9,A-D,* or #.</doc:summary>
</doc:doc>
</arg>
</method>
<!--
Silence:
Silence the ringing of incoming call
-->
<method name="Silence"/>
<doc:doc>
<doc:summary>Silence the ringing</doc:summary>
</doc:doc>
<property name="Inbound" type="b" access="read"/>
<!--
State:
State of the call.
Valid states: 0 = Unknown, 1 = Active, 2 = Held,
3 = Dialing, 4 = Alerting (deprecated),
5 = Incoming, 6 = Waiting (deprecated), 7 = Disconnected
Unrecognized values should be considered equal to Unknown.
-->
<property name="State" type="u" access="read"/>
<!--
Id:
The ID identifying the call, e.g. a phone number
-->
<property name="Id" type="s" access="read">
<doc:doc>
<doc:description>
<doc:para>The Id identifying the call, e.g. a phone number</doc:para>
</doc:description>
</doc:doc>
</property>
<!--
DisplayName:
The DisplayName of the calling party, e.g. from the address book
-->
<property name="DisplayName" type="s" access="read">
<doc:doc>
<doc:description>
<doc:para>The DisplayName of the calling party, e.g. from the address book</doc:para>
</doc:description>
</doc:doc>
</property>
<!--
ImagePath:
The path to an (avatar) image to display for this call.
-->
<property name="ImagePath" type="s" access="read">
<doc:doc>
<doc:description>
<doc:para>The path to an image to display for this call.</doc:para>
</doc:description>
</doc:doc>
</property>
<!--
Protocol:
The protocol used for this call, e.g. "tel" or "sip".
-->
<property name="Protocol" type="s" access="read">
<doc:doc>
<doc:description>
<doc:para>The protocol used for this call</doc:para>
</doc:description>
</doc:doc>
</property>
<!--
Encrypted:
Whether this call is encrypted.
-->
<property name="Encrypted" type="b" access="read">
<doc:doc>
<doc:description>
<doc:para>Whether the call is encrypted. This does not indicate anything about the
type of encryption being used.</doc:para>
</doc:description>
</doc:doc>
</property>
<!--
CanDtmf:
Whether this call is capable of sending DTMF.
-->
<property name="CanDtmf" type="b" access="read">
<doc:doc>
<doc:description>
<doc:para>Whether the call can do DTMF</doc:para>
</doc:description>
</doc:doc>
</property>
<!--
Hints:
Additional property dictionary with hints.
"ui-active" hints whether the UI should be shown or not.
-->
<property name="Hints" type="a{sv}" access="read">
<doc:doc>
<doc:description>
<doc:para>Additional hints about this call</doc:para>
</doc:description>
</doc:doc>
</property>
</interface>
</node>