/usr/share/pyshared/telepathy/_generated/Connection_Manager.py is in python-telepathy 0.15.19-2.1build1.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 | # -*- coding: utf-8 -*-
# Generated from the Telepathy spec
"""Copyright (C) 2005-2008 Collabora Limited
Copyright (C) 2005-2008 Nokia Corporation
Copyright (C) 2006 INdT
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 2.1 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, write to the Free Software
Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
"""
import dbus.service
class ConnectionManager(dbus.service.Object):
"""\
A D-Bus service which allows connections to be created. The manager
processes are intended to be started by D-Bus service activation.
For service discovery, each Telepathy connection manager must have
a connection manager name (see
Connection_Manager_Name for syntax).
The connection manager must then provide a well-known bus name of
org.freedesktop.Telepathy.ConnectionManager.cmname
where cmname is its connection manager name. If it makes sense
to start the connection manager using D-Bus service activation, it
must register that well-known name for service activation by installing
a .service file.
Clients can list the running connection managers by calling the
ListNames method on the D-Bus daemon's org.freedesktop.DBus interface
and looking for names matching the above pattern; they can list the
activatable connection managers by calling ListActivatableNames, and
they should usually combine the two lists to get a complete list of
running or activatable connection managers.
When the connection manager is running, it must have an object
implementing the ConnectionManager interface at the object path
/org/freedesktop/Telepathy/ConnectionManager/cmname.
Connection managers' capabilities can be determined dynamically by
calling their ListProtocols method, then
for each protocol of interest, calling
GetParameters to discover the required and
optional parameters.
However, since it is inefficient to activate all possible connection
managers on the system just to find out what they can do, there
is a standard mechanism to store static information about CMs in
".manager files".
To look up a connection manager's supported protocols, clients
should search the data directories specified by
the
freedesktop.org XDG Base Directory Specification ($XDG_DATA_HOME,
defaulting to $HOME/.local/share if unset, followed by
colon-separated paths from $XDG_DATA_DIRS, defaulting to
/usr/local/share:/usr/share if unset) for the first file named
telepathy/managers/cmname.manager that can be
read without error. This file has the same syntax as a
freedesktop.org Desktop Entry file.
Clients must still support connection managers for which no
.manager file can be found, which they can do by activating
the connection manager and calling its methods; the
.manager file is merely an optimization. Connection managers
whose list of protocols can change at any time (for instance, via
a plugin architecture) should not install a .manager
file.
The .manager file SHOULD have a group headed
[ConnectionManager], containing a key
Interfaces representing
Interfaces as a sequence of strings
each followed by a semicolon (the "localestrings" type from the Desktop
Entry Specification).
The [ConnectionManager] group SHOULD NOT contain keys
ObjectPath or BusName. If it does, they MUST
be ignored.
The object path and bus name are derivable from the connection
manager's name, which is part of the filename, so these keys are
redundant. They were required in very old versions of Telepathy.
For each protocol name proto that would be returned by
ListProtocols, the .manager file contains a group
headed [Protocol proto]. For each parameter
p that would be returned by GetParameters(proto), the
.manager file contains a key param-p with a value
consisting of a D-Bus signature (a single complete type), optionally
followed by a space and a space-separated list of flags. The supported
flags are:
required, corresponding to
Conn_Mgr_Param_Flag_Required
register, corresponding
to Conn_Mgr_Param_Flag_Register
secret, corresponding
to Conn_Mgr_Param_Flag_Secret
dbus-property, corresponding
to Conn_Mgr_Param_Flag_DBus_Property
The group may also contain a key default-p
whose value is a string form of the default value for the parameter.
If this key exists, it sets the default, and also sets the flag
Conn_Mgr_Param_Flag_Has_Default. The default value is formatted
according to the D-Bus signature as follows:
s (string)
The UTF-8 string, with the standard backslash escape
sequences supported by the Desktop Entry Specification
(the "localestring" type from the Desktop Entry Specification)
o (object path)
The object path as an ASCII string
b (boolean)
"true" (case-insensitively) or "1" means True, "false"
(case-insensitively) or "0" means False; when writing a file,
"true" and "false" SHOULD be used
y, q, u, t (8-, 16-, 32-, 64-bit unsigned integer)
ASCII decimal integer
n, i, x (16-, 32-, 64-bit signed integer)
ASCII decimal integer, optionally prefixed with "-"
d (double-precision floating point)
ASCII decimal number
as (array of string)
A sequence of UTF-8 strings each followed by a semicolon, with
any semicolons they contain escaped with a backslash
(the "localestrings" type from the Desktop Entry Specification)
Currently, no other D-Bus signatures are allowed to have default values,
but clients parsing the .manager file MUST ignore defaults
that they cannot parse, and treat them as if the
default-p key was not present at all.
It is not required that a connection manager be able to support multiple
protocols, or even multiple connections. When a connection is made, a
service name where the connection object can be found is returned. A
manager which can only make one connection may then remove itself from its
well-known bus name, causing a new connection manager to be activated when
somebody attempts to make a new connection.
"""
@dbus.service.method('org.freedesktop.Telepathy.ConnectionManager', in_signature='s', out_signature='a(susv)')
def GetParameters(self, Protocol):
"""
Get a list of the parameters which must or may be provided to the
RequestConnection method when connecting
to the given protocol,
or registering (the boolean "register" parameter is available,
and set to true).
"""
raise NotImplementedError
@dbus.service.method('org.freedesktop.Telepathy.ConnectionManager', in_signature='', out_signature='as')
def ListProtocols(self):
"""
Get a list of protocol identifiers that are implemented by this
connection manager.
"""
raise NotImplementedError
@dbus.service.method('org.freedesktop.Telepathy.ConnectionManager', in_signature='sa{sv}', out_signature='so')
def RequestConnection(self, Protocol, Parameters):
"""
Request a
Connection
object representing a given account on a given
protocol with the given parameters. The method returns the bus name
and the object path where the new Connection object can be found,
which should have the status of Connection_Status_Disconnected, to
allow signal handlers to be attached before connecting is started
with the
Connect
method.
The parameters which must and may be provided in the parameters
dictionary can be discovered with the
GetParameters method. These
parameters, their types, and their default values may be cached
in files so that all available connection managers do not need to be
started to discover which protocols are available.
To request values for these parameters from the user, a client must
have prior knowledge of the meaning of the parameter names, so the
well-known names and types defined by the
Connection_Parameter_Name type should be used where
appropriate.
Connection manager authors SHOULD avoid introducing parameters
whose default values would not be serializable in a
.manager file.
The same serialization format is used in Mission Control
to store accounts.
Every successful RequestConnection call will cause the emission of a
NewConnection signal for the same newly
created connection. The
requester can use the returned object path and service name
independently of the emission of that signal. In that case this signal
emission is most useful for, e.g. other processes that are monitoring
the creation of new connections.
"""
raise NotImplementedError
@dbus.service.signal('org.freedesktop.Telepathy.ConnectionManager', signature='sos')
def NewConnection(self, Bus_Name, Object_Path, Protocol):
"""
Emitted when a new Connection object
is created.
"""
pass
|