diff options
| author | Michael Biebl <biebl@debian.org> | 2019-03-26 23:25:23 +0100 |
|---|---|---|
| committer | Michael Biebl <biebl@debian.org> | 2019-03-26 23:25:23 +0100 |
| commit | 9a6dcbf895f9da01768e64b73cec88c16157d91e (patch) | |
| tree | a359958930d731e9f1b59344642e10754419fe84 /docs/api/dbus-org.freedesktop.NetworkManager.Device.WifiP2P.xml | |
| parent | 964ae8cc391520440cf5aa13e2b9cc34850ea6c2 (diff) | |
New upstream version 1.16.0 upstream/1.16.0
Diffstat (limited to 'docs/api/dbus-org.freedesktop.NetworkManager.Device.WifiP2P.xml')
| -rw-r--r-- | docs/api/dbus-org.freedesktop.NetworkManager.Device.WifiP2P.xml | 124 |
1 files changed, 124 insertions, 0 deletions
diff --git a/docs/api/dbus-org.freedesktop.NetworkManager.Device.WifiP2P.xml b/docs/api/dbus-org.freedesktop.NetworkManager.Device.WifiP2P.xml new file mode 100644 index 00000000..d89bbe7b --- /dev/null +++ b/docs/api/dbus-org.freedesktop.NetworkManager.Device.WifiP2P.xml @@ -0,0 +1,124 @@ +<?xml version="1.0" encoding="utf-8"?> +<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.1.2//EN" + "http://www.oasis-open.org/docbook/xml/4.1.2/docbookx.dtd" [ +]> +<refentry id="gdbus-org.freedesktop.NetworkManager.Device.WifiP2P"> + <refmeta> <refentrytitle role="top_of_page" id="gdbus-interface-org-freedesktop-NetworkManager-Device-WifiP2P.top_of_page">org.freedesktop.NetworkManager.Device.WifiP2P</refentrytitle> + <indexterm zone="gdbus-interface-org-freedesktop-NetworkManager-Device-WifiP2P.top_of_page"><primary sortas="DeviceWifiP2P">org.freedesktop.NetworkManager.Device.WifiP2P</primary></indexterm> + </refmeta> <refnamediv> <refname>org.freedesktop.NetworkManager.Device.WifiP2P</refname> <refpurpose>Wi-Fi P2P Device</refpurpose> </refnamediv> <refsynopsisdiv role="synopsis"> + <title role="synopsis.title">Methods</title> + <synopsis> +<link linkend="gdbus-method-org-freedesktop-NetworkManager-Device-WifiP2P.StartFind">StartFind</link> (IN a{sv} options); +<link linkend="gdbus-method-org-freedesktop-NetworkManager-Device-WifiP2P.StopFind">StopFind</link> (); +</synopsis> + </refsynopsisdiv> + <refsect1 role="signal_proto"> + <title role="signal_proto.title">Signals</title> + <synopsis> +<link linkend="gdbus-signal-org-freedesktop-NetworkManager-Device-WifiP2P.PeerAdded">PeerAdded</link> (o peer); +<link linkend="gdbus-signal-org-freedesktop-NetworkManager-Device-WifiP2P.PeerRemoved">PeerRemoved</link> (o peer); +</synopsis> + </refsect1> + <refsect1 role="properties"> + <title role="properties.title">Properties</title> + <synopsis> +<link linkend="gdbus-property-org-freedesktop-NetworkManager-Device-WifiP2P.HwAddress">HwAddress</link> readable s +<link linkend="gdbus-property-org-freedesktop-NetworkManager-Device-WifiP2P.Peers">Peers</link> readable ao +</synopsis> + </refsect1> +<refsect1 role="desc" id="gdbus-interface-org-freedesktop-NetworkManager-Device-WifiP2P"> + <title role="desc.title">Description</title> + <para> Since: 1.16 +</para> +</refsect1> +<refsect1 role="details" id="gdbus-methods-org.freedesktop.NetworkManager.Device.WifiP2P"> + <title role="details.title">Method Details</title> +<refsect2 role="method" id="gdbus-method-org-freedesktop-NetworkManager-Device-WifiP2P.StartFind"> + <title>The StartFind() method</title> + <indexterm zone="gdbus-method-org-freedesktop-NetworkManager-Device-WifiP2P.StartFind"><primary sortas="DeviceWifiP2P.StartFind">org.freedesktop.NetworkManager.Device.WifiP2P.StartFind()</primary></indexterm> +<programlisting> +StartFind (IN a{sv} options); +</programlisting> +<para> in the range of 1-600 seconds is supported. The default is + 30 seconds. +</para><para> Start a find operation for Wi-Fi P2P peers. +</para><para> Since: 1.16 +</para> +<variablelist role="params"> +<varlistentry> + <term><literal>IN a{sv} <parameter>options</parameter></literal>:</term> + <listitem><para>Options of find. Currently 'timeout' option with value of "i"</para></listitem> +</varlistentry> +</variablelist> +</refsect2> +<refsect2 role="method" id="gdbus-method-org-freedesktop-NetworkManager-Device-WifiP2P.StopFind"> + <title>The StopFind() method</title> + <indexterm zone="gdbus-method-org-freedesktop-NetworkManager-Device-WifiP2P.StopFind"><primary sortas="DeviceWifiP2P.StopFind">org.freedesktop.NetworkManager.Device.WifiP2P.StopFind()</primary></indexterm> +<programlisting> +StopFind (); +</programlisting> +<para> Stop an ongoing find operation again. +</para><para> Since: 1.16 +</para> +</refsect2> +</refsect1> +<refsect1 role="details" id="gdbus-signals-org.freedesktop.NetworkManager.Device.WifiP2P"> + <title role="details.title">Signal Details</title> +<refsect2 role="signal" id="gdbus-signal-org-freedesktop-NetworkManager-Device-WifiP2P.PeerAdded"> + <title>The "PeerAdded" signal</title> + <indexterm zone="gdbus-signal-org-freedesktop-NetworkManager-Device-WifiP2P.PeerAdded"><primary sortas="DeviceWifiP2P::PeerAdded">org.freedesktop.NetworkManager.Device.WifiP2P::PeerAdded</primary></indexterm> +<programlisting> +PeerAdded (o peer); +</programlisting> +<para> Emitted when a new Wi-Fi P2P peer is found by the device. +</para><para> Since: 1.16 +</para> +<variablelist role="params"> +<varlistentry> + <term><literal>o <parameter>peer</parameter></literal>:</term> + <listitem><para>The object path of the newly found access point.</para></listitem> +</varlistentry> +</variablelist> +</refsect2> +<refsect2 role="signal" id="gdbus-signal-org-freedesktop-NetworkManager-Device-WifiP2P.PeerRemoved"> + <title>The "PeerRemoved" signal</title> + <indexterm zone="gdbus-signal-org-freedesktop-NetworkManager-Device-WifiP2P.PeerRemoved"><primary sortas="DeviceWifiP2P::PeerRemoved">org.freedesktop.NetworkManager.Device.WifiP2P::PeerRemoved</primary></indexterm> +<programlisting> +PeerRemoved (o peer); +</programlisting> +<para> Emitted when a Wi-Fi P2P peer disappears from view of the device. +</para><para> Since: 1.16 +</para> +<variablelist role="params"> +<varlistentry> + <term><literal>o <parameter>peer</parameter></literal>:</term> + <listitem><para>The object path of the Wi-Fi P2P peer that has disappeared.</para></listitem> +</varlistentry> +</variablelist> +</refsect2> +</refsect1> +<refsect1 role="details" id="gdbus-properties-org.freedesktop.NetworkManager.Device.WifiP2P"> + <title role="details.title">Property Details</title> +<refsect2 role="property" id="gdbus-property-org-freedesktop-NetworkManager-Device-WifiP2P.HwAddress"> + <title>The "HwAddress" property</title> + <indexterm zone="gdbus-property-org-freedesktop-NetworkManager-Device-WifiP2P.HwAddress"><primary sortas="DeviceWifiP2P:HwAddress">org.freedesktop.NetworkManager.Device.WifiP2P:HwAddress</primary></indexterm> +<programlisting> +HwAddress readable s +</programlisting> +<para> The active hardware address of the device. +</para><para> Since: 1.16 +</para> +</refsect2> +<refsect2 role="property" id="gdbus-property-org-freedesktop-NetworkManager-Device-WifiP2P.Peers"> + <title>The "Peers" property</title> + <indexterm zone="gdbus-property-org-freedesktop-NetworkManager-Device-WifiP2P.Peers"><primary sortas="DeviceWifiP2P:Peers">org.freedesktop.NetworkManager.Device.WifiP2P:Peers</primary></indexterm> +<programlisting> +Peers readable ao +</programlisting> +<para> List of object paths of peers visible to this Wi-Fi P2P device. +</para><para> Since: 1.16 +</para> +</refsect2> +</refsect1> +</refentry> + |