Extensions for 'extended' examples

Interfaces

com.example.Telepathy.Connection.Interface.Hats

This interface is a silly example and is likely to cause havoc to your API/ABI if bindings are generated. Don't include it in libraries that care about compatibility.

Implementations of this interface must also implement:

This interface is an example of how Telepathy can be extended. For the purposes of this example, we pretend we're an organisation example.com that's adding a proprietary extension to Telepathy, so the extension is not in the main Telepathy namespace.

Methods:

GetHats ( au: Contact ) → a(usua{sv})

Request a list of the hats worn by the given contacts.

Parameters

Contact − au (Contact_Handle[])
The handles of the contacts whose hats are requested

Returns

Hats − a(usua{sv}) (Contact_Hat[])
A list of contacts and their hats.

Possible errors

org.freedesktop.Telepathy.Error.Disconnected
(Undocumented.)
org.freedesktop.Telepathy.Error.NetworkError
(Undocumented.)
org.freedesktop.Telepathy.Error.InvalidHandle
(Undocumented.)
org.freedesktop.Telepathy.Error.PermissionDenied
(Undocumented.)
org.freedesktop.Telepathy.Error.NotAvailable
(Undocumented.)

SetHat ( s: Color, u: Style, a{sv}: Properties ) → nothing

Indicate that the hat currently being worn by the local user has changed.

Parameters

Color − s
The color of the contact's hat.
Style − u (Hat_Style)
The style of the contact's hat.
Properties − a{sv} (String_Variant_Map)
There's always an a{sv}...

Signals:

HatsChanged ( u: Contact, s: Color, u: Style, a{sv}: Properties )

Emitted when the contact's hat has changed.

Parameters

Contact − u (Contact_Handle)
The handle representing the contact's ID on the server
Color − s
The color of the contact's hat.
Style − u (Hat_Style)
The style of the contact's hat.
Properties − a{sv} (String_Variant_Map)
There's always an a{sv}. Perhaps there's some special religious reason.

Interface has no Telepathy properties.

Interface has no D-Bus core properties.

Enumerated types:

Hat_Style

Hat_Style_None = 0
There is no hat. color MUST be the empty string and properties MUST be an empty mapping.
Hat_Style_Other = 1
An unspecified type of hat.
Hat_Style_Fedora = 2
A fedora, which MAY be red.
Hat_Style_Knitted = 3
A knitted hat, with or without a bobble.
Hat_Style_Bowler = 4
A bowler hat, as worn by stereotypical English businessmen.

Structure types

Contact_Hat − ( u: Contact, s: Color, u: Style, a{sv}: Properties )

A data structure representing a contact and their hat.

In bindings that need a separate name, arrays of Contact_Hat should be called Contact_Hat_List.

Members

Contact − u (Contact_Handle)
The contact wearing the hat.
Color − s
The color of the hat
Style − u (Hat_Style)
The style of the hat
Properties − a{sv} (String_Variant_Map)
Optional key-value pairs describing extended properties of the hat.

Generic types

Types defined elsewhere

Contact_Handle − u
Defined by: Telepathy specification
String_Variant_Map − a{sv}
Defined by: Telepathy specification

Index

Index of interfaces

Index of types