tp_dbus_specialized_value_slice_new ()

GValue*             tp_dbus_specialized_value_slice_new (GType type);

TP_ARRAY_TYPE_OBJECT_PATH_LIST

#define TP_ARRAY_TYPE_OBJECT_PATH_LIST (tp_type_dbus_array_of_o ())

Expands to a call to a function that returns the GType of a GPtrArray of DBUS_TYPE_G_OBJECT_PATH.

Since 0.7.34

TP_HASH_TYPE_STRING_STRING_MAP

#define             TP_HASH_TYPE_STRING_STRING_MAP

A mapping from strings to strings representing extra key-value pairs.

This macro expands to a call to a function that returns the GType of a GHashTable appropriate for representing a D-Bus dictionary of signature a{ss}.

Keys (D-Bus type s, named Key): (Undocumented)

Values (D-Bus type s, named Value): (Undocumented)

TP_ARRAY_TYPE_STRING_STRING_MAP_LIST

#define             TP_ARRAY_TYPE_STRING_STRING_MAP_LIST

Expands to a call to a function that returns the GType of a GPtrArray of TP_HASH_TYPE_STRING_STRING_MAP.

TP_HASH_TYPE_STRING_VARIANT_MAP

#define             TP_HASH_TYPE_STRING_VARIANT_MAP

A mapping from strings to variants representing extra key-value pairs.

This macro expands to a call to a function that returns the GType of a GHashTable appropriate for representing a D-Bus dictionary of signature a{sv}.

Keys (D-Bus type s, named Key): (Undocumented)

Values (D-Bus type v, named Value): (Undocumented)

TP_ARRAY_TYPE_STRING_VARIANT_MAP_LIST

#define             TP_ARRAY_TYPE_STRING_VARIANT_MAP_LIST

Expands to a call to a function that returns the GType of a GPtrArray of TP_HASH_TYPE_STRING_VARIANT_MAP.

TP_HASH_TYPE_QUALIFIED_PROPERTY_VALUE_MAP

#define             TP_HASH_TYPE_QUALIFIED_PROPERTY_VALUE_MAP

A mapping from strings representing D-Bus properties (by their namespaced names) to their values.

This macro expands to a call to a function that returns the GType of a GHashTable appropriate for representing a D-Bus dictionary of signature a{sv}.

Keys (D-Bus type s, type DBus_Qualified_Member, named Key): A D-Bus interface name, followed by a dot and a D-Bus property name.

Values (D-Bus type v, named Value): The value of the property.

TP_ARRAY_TYPE_QUALIFIED_PROPERTY_VALUE_MAP_LIST

#define             TP_ARRAY_TYPE_QUALIFIED_PROPERTY_VALUE_MAP_LIST

Expands to a call to a function that returns the GType of a GPtrArray of TP_HASH_TYPE_QUALIFIED_PROPERTY_VALUE_MAP.

TP_STRUCT_TYPE_SOCKET_ADDRESS_IP

#define             TP_STRUCT_TYPE_SOCKET_ADDRESS_IP

An IP address and port.

This macro expands to a call to a function that returns the GType of a GValueArray appropriate for representing a D-Bus struct with signature (sq).

Member 0 (D-Bus type s, named Address): Either a dotted-quad IPv4 address literal as for <tp:type>Socket_Address_IPv4</tp:type>, or an RFC2373 IPv6 address as for <tp:type>Socket_Address_IPv6</tp:type>.

Member 1 (D-Bus type q, named Port): The TCP or UDP port number.

TP_ARRAY_TYPE_SOCKET_ADDRESS_IP_LIST

#define             TP_ARRAY_TYPE_SOCKET_ADDRESS_IP_LIST

Expands to a call to a function that returns the GType of a GPtrArray of TP_STRUCT_TYPE_SOCKET_ADDRESS_IP.

TP_STRUCT_TYPE_SOCKET_ADDRESS_IPV4

#define             TP_STRUCT_TYPE_SOCKET_ADDRESS_IPV4

An IPv4 address and port.

This macro expands to a call to a function that returns the GType of a GValueArray appropriate for representing a D-Bus struct with signature (sq).

Member 0 (D-Bus type s, named Address): A dotted-quad IPv4 address literal: four ASCII decimal numbers, each between 0 and 255 inclusive, e.g. &quot;192.168.0.1&quot;.

Member 1 (D-Bus type q, named Port): The TCP or UDP port number.

TP_STRUCT_TYPE_SOCKET_ADDRESS_IPV6

#define             TP_STRUCT_TYPE_SOCKET_ADDRESS_IPV6

An IPv6 address and port.

This macro expands to a call to a function that returns the GType of a GValueArray appropriate for representing a D-Bus struct with signature (sq).

Member 0 (D-Bus type s, named Address): An IPv6 address literal as specified by RFC2373 section 2.2, e.g. &quot;2001:DB8::8:800:200C:4171&quot;.

Member 1 (D-Bus type q, named Port): The TCP or UDP port number.

TP_STRUCT_TYPE_SOCKET_NETMASK_IPV4

#define             TP_STRUCT_TYPE_SOCKET_NETMASK_IPV4

An IPv4 network or subnet.

This macro expands to a call to a function that returns the GType of a GValueArray appropriate for representing a D-Bus struct with signature (sy).

Member 0 (D-Bus type s, named Address): A dotted-quad IPv4 address literal: four ASCII decimal numbers, each between 0 and 255 inclusive, e.g. &quot;192.168.0.1&quot;.

Member 1 (D-Bus type y, named Prefix_Length): The number of leading bits of the address that must match, for this netmask to be considered to match an address.

TP_STRUCT_TYPE_SOCKET_NETMASK_IPV6

#define             TP_STRUCT_TYPE_SOCKET_NETMASK_IPV6

An IPv6 network or subnet.

This macro expands to a call to a function that returns the GType of a GValueArray appropriate for representing a D-Bus struct with signature (sy).

Member 0 (D-Bus type s, named Address): An IPv6 address literal as specified by RFC2373 section 2.2, e.g. &quot;2001:DB8::8:800:200C:4171&quot;.

Member 1 (D-Bus type y, named Prefix_Length): The number of leading bits of the address that must match, for this netmask to be considered to match an address.

TP_STRUCT_TYPE_PARAM_SPEC

#define             TP_STRUCT_TYPE_PARAM_SPEC

A struct representing an allowed parameter, as returned by GetParameters on the ConnectionManager interface.

This macro expands to a call to a function that returns the GType of a GValueArray appropriate for representing a D-Bus struct with signature (susv).

Member 0 (D-Bus type s, named Name): A string parameter name

Member 1 (D-Bus type u, type Conn_Mgr_Param_Flags, named Flags): A bitwise OR of the parameter flags

Member 2 (D-Bus type s, type DBus_Signature, named Signature): A string containing the D-Bus type signature for this parameter

Member 3 (D-Bus type v, named Default_Value): The default value (if the Has_Default flag is not present, there is no default and this takes some dummy value, which SHOULD be of the appropriate D-Bus type)

TP_ARRAY_TYPE_PARAM_SPEC_LIST

#define             TP_ARRAY_TYPE_PARAM_SPEC_LIST

Expands to a call to a function that returns the GType of a GPtrArray of TP_STRUCT_TYPE_PARAM_SPEC.

TP_STRUCT_TYPE_CHANNEL_INFO

#define             TP_STRUCT_TYPE_CHANNEL_INFO

A struct representing a channel, as returned by ListChannels on the Connection interface.

This macro expands to a call to a function that returns the GType of a GValueArray appropriate for representing a D-Bus struct with signature (osuu).

Member 0 (D-Bus type o, named Channel): The object path of the channel, which is on the same bus name as the connection

Member 1 (D-Bus type s, type DBus_Interface, named Channel_Type): The channel's type

Member 2 (D-Bus type u, type Handle_Type, named Handle_Type): The type of the handle that the channel communicates with, or Handle_Type_None if there is no associated handle

Member 3 (D-Bus type u, type Handle, named Handle): The handle that the channel communicates with, or 0 if there is no associated handle

TP_ARRAY_TYPE_CHANNEL_INFO_LIST

#define             TP_ARRAY_TYPE_CHANNEL_INFO_LIST

Expands to a call to a function that returns the GType of a GPtrArray of TP_STRUCT_TYPE_CHANNEL_INFO.

TP_HASH_TYPE_ALIAS_MAP

#define             TP_HASH_TYPE_ALIAS_MAP

A dictionary whose keys are contact handles and whose values are aliases.

This macro expands to a call to a function that returns the GType of a GHashTable appropriate for representing a D-Bus dictionary of signature a{us}.

Keys (D-Bus type u, type Contact_Handle, named Handle): (Undocumented)

Values (D-Bus type s, named Alias): (Undocumented)

TP_STRUCT_TYPE_ALIAS_PAIR

#define             TP_STRUCT_TYPE_ALIAS_PAIR

A pair (contact handle, alias) as seen in the <tp:member-ref> AliasesChanged </tp:member-ref> signal.

This macro expands to a call to a function that returns the GType of a GValueArray appropriate for representing a D-Bus struct with signature (us).

Member 0 (D-Bus type u, type Contact_Handle, named Handle): (Undocumented)

Member 1 (D-Bus type s, named Alias): (Undocumented)

TP_ARRAY_TYPE_ALIAS_PAIR_LIST

#define             TP_ARRAY_TYPE_ALIAS_PAIR_LIST

Expands to a call to a function that returns the GType of a GPtrArray of TP_STRUCT_TYPE_ALIAS_PAIR.

TP_HASH_TYPE_AVATAR_TOKEN_MAP

#define             TP_HASH_TYPE_AVATAR_TOKEN_MAP

A dictionary whose keys are contact handles and whose values are avatar tokens.

This macro expands to a call to a function that returns the GType of a GHashTable appropriate for representing a D-Bus dictionary of signature a{us}.

Keys (D-Bus type u, type Contact_Handle, named Handle): (Undocumented)

Values (D-Bus type s, type Avatar_Token, named Token): (Undocumented)

TP_HASH_TYPE_CONTACT_CAPABILITIES_MAP

#define             TP_HASH_TYPE_CONTACT_CAPABILITIES_MAP

A mapping from contact handle to their capabilities.

This macro expands to a call to a function that returns the GType of a GHashTable appropriate for representing a D-Bus dictionary of signature a{ua(a{sv}as)}.

Keys (D-Bus type u, type Contact_Handle, named Key): A contact handle.

Values (D-Bus type a(a{sv}as), type Requestable_Channel_Class[], named Value): The contact capabilities.

TP_ARRAY_TYPE_CONTACT_CAPABILITIES_MAP_LIST

#define             TP_ARRAY_TYPE_CONTACT_CAPABILITIES_MAP_LIST

Expands to a call to a function that returns the GType of a GPtrArray of TP_HASH_TYPE_CONTACT_CAPABILITIES_MAP.

TP_STRUCT_TYPE_HANDLER_CAPABILITIES

#define             TP_STRUCT_TYPE_HANDLER_CAPABILITIES

A structure representing the capabilities of a single client.

This macro expands to a call to a function that returns the GType of a GValueArray appropriate for representing a D-Bus struct with signature (saa{sv}as).

Member 0 (D-Bus type s, type DBus_Well_Known_Name, named Well_Known_Name): For implementations of the <tp:dbus-ref namespace="org.freedesktop.Telepathy">Client</tp:dbus-ref> interface, the well-known bus name name of the client; for any other process, any other reversed domain name that uniquely identifies it.

Member 1 (D-Bus type aa{sv}, type String_Variant_Map[], named Channel_Classes): <tp:docstring xmlns="http://www.w3.org/1999/xhtml"> An array of channel classes that can be handled by this client. This will usually be a copy of the client's <tp:dbus-ref namespace="org.freedesktop.Telepathy.Client.Handler">HandlerChannelFilter</tp:dbus-ref> property.

Member 2 (D-Bus type as, type Handler_Capability_Token[], named Capabilities): <tp:docstring xmlns="http://www.w3.org/1999/xhtml"> An array of client capabilities supported by this client, to be used by the connection manager to determine what capabilities to advertise. This will usually be a copy of the client's <tp:dbus-ref namespace="org.freedesktop.Telepathy.Client.Handler">Capabilities</tp:dbus-ref> property.

TP_ARRAY_TYPE_HANDLER_CAPABILITIES_LIST

#define             TP_ARRAY_TYPE_HANDLER_CAPABILITIES_LIST

Expands to a call to a function that returns the GType of a GPtrArray of TP_STRUCT_TYPE_HANDLER_CAPABILITIES.

TP_STRUCT_TYPE_CAPABILITY_CHANGE

#define             TP_STRUCT_TYPE_CAPABILITY_CHANGE

A struct (contact handle, channel type, old generic flags, new generic flags, old type-specific flags, new type-specific flags) representing a change to one of a contact's capabilities, as seen in the <tp:member-ref> CapabilitiesChanged </tp:member-ref> signal on the Capabilities interface.

This macro expands to a call to a function that returns the GType of a GValueArray appropriate for representing a D-Bus struct with signature (usuuuu).

Member 0 (D-Bus type u, type Contact_Handle, named Handle): (Undocumented)

Member 1 (D-Bus type s, type DBus_Interface, named Channel_Type): (Undocumented)

Member 2 (D-Bus type u, type Connection_Capability_Flags, named Old_Generic_Flags): (Undocumented)

Member 3 (D-Bus type u, type Connection_Capability_Flags, named New_Generic_Flags): (Undocumented)

Member 4 (D-Bus type u, named Old_Type_Specific_Flags): (Undocumented)

Member 5 (D-Bus type u, named New_Type_Specific_Flags): (Undocumented)

TP_ARRAY_TYPE_CAPABILITY_CHANGE_LIST

#define             TP_ARRAY_TYPE_CAPABILITY_CHANGE_LIST

Expands to a call to a function that returns the GType of a GPtrArray of TP_STRUCT_TYPE_CAPABILITY_CHANGE.

TP_STRUCT_TYPE_CAPABILITY_PAIR

#define             TP_STRUCT_TYPE_CAPABILITY_PAIR

A pair (channel type, type-specific flags) as passed to <tp:member-ref> AdvertiseCapabilities </tp:member-ref> on the Capabilities interface.

This macro expands to a call to a function that returns the GType of a GValueArray appropriate for representing a D-Bus struct with signature (su).

Member 0 (D-Bus type s, type DBus_Interface, named Channel_Type): (Undocumented)

Member 1 (D-Bus type u, named Type_Specific_Flags): (Undocumented)

TP_ARRAY_TYPE_CAPABILITY_PAIR_LIST

#define             TP_ARRAY_TYPE_CAPABILITY_PAIR_LIST

Expands to a call to a function that returns the GType of a GPtrArray of TP_STRUCT_TYPE_CAPABILITY_PAIR.

TP_STRUCT_TYPE_CONTACT_CAPABILITY

#define             TP_STRUCT_TYPE_CONTACT_CAPABILITY

A struct (contact handle, channel type, generic flags, type-specific flags) representing a capability posessed by a contact, as returned by <tp:member-ref> GetCapabilities </tp:member-ref> on the Capabilities interface.

This macro expands to a call to a function that returns the GType of a GValueArray appropriate for representing a D-Bus struct with signature (usuu).

Member 0 (D-Bus type u, type Contact_Handle, named Handle): (Undocumented)

Member 1 (D-Bus type s, type DBus_Interface, named Channel_Type): (Undocumented)

Member 2 (D-Bus type u, type Connection_Capability_Flags, named Generic_Flags): (Undocumented)

Member 3 (D-Bus type u, named Type_Specific_Flags): (Undocumented)

TP_ARRAY_TYPE_CONTACT_CAPABILITY_LIST

#define             TP_ARRAY_TYPE_CONTACT_CAPABILITY_LIST

Expands to a call to a function that returns the GType of a GPtrArray of TP_STRUCT_TYPE_CONTACT_CAPABILITY.

TP_HASH_TYPE_CONTACT_ATTRIBUTES_MAP

#define             TP_HASH_TYPE_CONTACT_ATTRIBUTES_MAP

Mapping returned by <tp:member-ref>GetContactAttributes</tp:member-ref>, representing a collection of Contacts and their requested attributes.

This macro expands to a call to a function that returns the GType of a GHashTable appropriate for representing a D-Bus dictionary of signature a{ua{sv}}.

Keys (D-Bus type u, type Contact_Handle, named Contact): A contact

Values (D-Bus type a{sv}, type Single_Contact_Attributes_Map, named Attributes): Attributes of that contact

TP_HASH_TYPE_SINGLE_CONTACT_ATTRIBUTES_MAP

#define             TP_HASH_TYPE_SINGLE_CONTACT_ATTRIBUTES_MAP

Some of the attributes of a single contact.

This macro expands to a call to a function that returns the GType of a GHashTable appropriate for representing a D-Bus dictionary of signature a{sv}.

Keys (D-Bus type s, type Contact_Attribute, named Attribute): The name of the attribute

Values (D-Bus type v, named Value): The value of the attribute

TP_HASH_TYPE_CHANNEL_CLASS

#define             TP_HASH_TYPE_CHANNEL_CLASS

<tp:docstring xmlns="http://www.w3.org/1999/xhtml"> <p>Mapping representing a class of channels that can be requested from a connection manager, can be handled by a user interface, are supported by a contact, etc.</p> <p>Classes of channel are identified by the fixed values of a subset of their properties.</p> <p>Channel classes SHOULD always include the keys <tp:dbus-ref>org.freedesktop.Telepathy.Channel.ChannelType</tp:dbus-ref> and <tp:dbus-ref>org.freedesktop.Telepathy.Channel.TargetHandleType</tp:dbus-ref>. </p>

This macro expands to a call to a function that returns the GType of a GHashTable appropriate for representing a D-Bus dictionary of signature a{sv}.

Keys (D-Bus type s, type DBus_Qualified_Member, named Key): A D-Bus interface name, followed by a dot and a D-Bus property name.

Values (D-Bus type v, named Value): The value of the property.

TP_ARRAY_TYPE_CHANNEL_CLASS_LIST

#define             TP_ARRAY_TYPE_CHANNEL_CLASS_LIST

Expands to a call to a function that returns the GType of a GPtrArray of TP_HASH_TYPE_CHANNEL_CLASS.

TP_STRUCT_TYPE_CHANNEL_DETAILS

#define             TP_STRUCT_TYPE_CHANNEL_DETAILS

Enough details of a channel that clients can work out how to dispatch or handle it.

This macro expands to a call to a function that returns the GType of a GValueArray appropriate for representing a D-Bus struct with signature (oa{sv}).

Member 0 (D-Bus type o, named Channel): The object path of the channel.

Member 1 (D-Bus type a{sv}, type Qualified_Property_Value_Map, named Properties): <tp:docstring xmlns="http://www.w3.org/1999/xhtml"> <p>Properties of the channel.</p> <p>Connection managers MUST NOT include properties in this mapping if their values can change. Clients MUST ignore properties that appear in this mapping if their values can change.</p> <tp:rationale> <p>If properties that could change were included, the following race condition would be likely to exist in some cases:</p> <ul> <li>NewChannels or Get(&quot;Channels&quot;) includes a property P with value V1</li> <li>Client creates a proxy object for the channel</li> <li>The value of P changes to V2</li> <li>Client connects to PChanged signal</li> <li>Client should call Get(&quot;P&quot;) or GetAll here, to avoid the race, but client's author has forgotten to do so</li> <li>Proxy object thinks P == V1, but actually P == V2</li> </ul> <p>We've taken the opportunity to make the API encourage the client author to get it right. Where possible, we intend that properties whose value will be used in channel dispatching or other &quot;early&quot; processing will be defined so that they are immutable (can never change).</p> </tp:rationale> <p>Each dictionary MUST contain the keys <tp:dbus-ref>org.freedesktop.Telepathy.Channel.ChannelType</tp:dbus-ref>, <tp:dbus-ref>org.freedesktop.Telepathy.Channel.TargetHandleType</tp:dbus-ref>, <tp:dbus-ref>org.freedesktop.Telepathy.Channel.TargetHandle</tp:dbus-ref>, <tp:dbus-ref>org.freedesktop.Telepathy.Channel.TargetID</tp:dbus-ref> and <tp:dbus-ref>org.freedesktop.Telepathy.Channel.Requested</tp:dbus-ref>. </p> <tp:rationale> <p>We expect these to be crucial to the channel-dispatching process.</p> </tp:rationale>

TP_ARRAY_TYPE_CHANNEL_DETAILS_LIST

#define             TP_ARRAY_TYPE_CHANNEL_DETAILS_LIST

Expands to a call to a function that returns the GType of a GPtrArray of TP_STRUCT_TYPE_CHANNEL_DETAILS.

TP_STRUCT_TYPE_REQUESTABLE_CHANNEL_CLASS

#define             TP_STRUCT_TYPE_REQUESTABLE_CHANNEL_CLASS

<tp:docstring xmlns="http://www.w3.org/1999/xhtml"> <p> Structure representing a class of channels that can be requested, identified by a set of properties that identify that class of channel. </p>

<tp:rationale> <p> This will often just be the channel type and the handle type, but can include other properties of the channel - for instance, encrypted channels might require properties that unencrypted channels do not, like an encryption key. </p> </tp:rationale>

<p> In some cases, these classes of channel may overlap, in the sense that one class fixes all the properties that another class does, plus some more properties. </p>

<tp:rationale> <p> For older clients to still be able to understand how to request channels in the presence of a hypothetical &quot;encryption&quot; interface, we'd need to represent it like this: </p>

<ul> <li> class 1: ChannelType = Text, TargetHandleType = CONTACT </li> <li> class 2: Channel.ChannelType = Text, Channel.TargetHandleType = CONTACT, Encryption.Encrypted = TRUE </li> </ul> </tp:rationale>

This macro expands to a call to a function that returns the GType of a GValueArray appropriate for representing a D-Bus struct with signature (a{sv}as).

Member 0 (D-Bus type a{sv}, type Channel_Class, named Fixed_Properties): <tp:docstring xmlns="http://www.w3.org/1999/xhtml"> <p>The property values that identify this requestable channel class. These properties MUST be included in requests for a channel of this class, and MUST take these values.</p> <p>Clients that do not understand the semantics of all the Fixed_Properties MUST NOT request channels of this class, since they would be unable to avoid making an incorrect request.</p> <p>This implies that connection managers wishing to make channels available to old or minimal clients SHOULD have a channel class with the minimum number of Fixed_Properties, and MAY additionally have channel classes with extra Fixed_Properties.</p>

Member 1 (D-Bus type as, type DBus_Qualified_Member[], named Allowed_Properties): <tp:docstring xmlns="http://www.w3.org/1999/xhtml"> <p>Properties that MAY be set when requesting a channel of this channel type and handle type.</p> <p>This array MUST NOT include properties that are in the Fixed_Properties mapping.</p> <p>Properties in this array may either be required or optional, according to their documented semantics.</p> <tp:rationale> <p>For instance, if TargetHandleType takes a value that is not Handle_Type_None, one or the other of TargetHandle and TargetID is required. Clients are expected to understand the documented relationship between the properties, so we do not have separate arrays of required and optional properties.</p> </tp:rationale> <p>If this array contains the <tp:dbus-ref namespace="org.freedesktop.Telepathy.Channel.FUTURE">Bundle</tp:dbus-ref> property, then this class of channel can be combined with other channels with that property in a request, or added to an existing bundle. If not, this signifies that the connection manager is unable to mark channels of this class as part of a bundle - this means that to the remote contact they are likely to be indistinguishable from channels requested separately.</p>

TP_ARRAY_TYPE_REQUESTABLE_CHANNEL_CLASS_LIST

#define             TP_ARRAY_TYPE_REQUESTABLE_CHANNEL_CLASS_LIST

Expands to a call to a function that returns the GType of a GPtrArray of TP_STRUCT_TYPE_REQUESTABLE_CHANNEL_CLASS.

TP_HASH_TYPE_SIMPLE_CONTACT_PRESENCES

#define             TP_HASH_TYPE_SIMPLE_CONTACT_PRESENCES

Mapping returned by <tp:member-ref>GetPresences</tp:member-ref> and signalled by <tp:member-ref>PresencesChanged</tp:member-ref>, indicating the presence of a number of contacts.

This macro expands to a call to a function that returns the GType of a GHashTable appropriate for representing a D-Bus dictionary of signature a{u(uss)}.

Keys (D-Bus type u, type Contact_Handle, named Contact): A contact

Values (D-Bus type (uss), type Simple_Presence, named Presence): The contact's presence

TP_HASH_TYPE_SIMPLE_STATUS_SPEC_MAP

#define             TP_HASH_TYPE_SIMPLE_STATUS_SPEC_MAP

A mapping describing possible statuses.

This macro expands to a call to a function that returns the GType of a GHashTable appropriate for representing a D-Bus dictionary of signature a{s(ubb)}.

Keys (D-Bus type s, named Identifier): The string identifier of this status.

Values (D-Bus type (ubb), type Simple_Status_Spec, named Spec): Details of this status.

TP_STRUCT_TYPE_SIMPLE_PRESENCE

#define             TP_STRUCT_TYPE_SIMPLE_PRESENCE

A struct representing the presence of a contact.

This macro expands to a call to a function that returns the GType of a GValueArray appropriate for representing a D-Bus struct with signature (uss).

Member 0 (D-Bus type u, type Connection_Presence_Type, named Type): The presence type, e.g. Connection_Presence_Type_Away.

Member 1 (D-Bus type s, named Status): The string identifier of the status, e.g. &quot;brb&quot;, as defined in the <tp:member-ref>Statuses</tp:member-ref> property.

Member 2 (D-Bus type s, named Status_Message): <tp:docstring xmlns="http://www.w3.org/1999/xhtml"> <p>The user-defined status message, e.g. &quot;Back soon!&quot;.</p> <p>Clients SHOULD set the status message for the local user to the empty string, unless the user has actually provided a specific message (i.e. one that conveys more information than the Status).</p> <p>User interfaces SHOULD regard an empty status message as unset, and MAY replace it with a localized string corresponding to the Status or Type.</p> <tp:rationale> Use case: Daf sets his status in Empathy by choosing the Welsh translation of &quot;Available&quot; from a menu. It is more informative for his English-speaking colleagues to see the English translation of &quot;Available&quot; (as localized by their own clients) than to see &quot;Ar Gael&quot; (which they don't understand anyway). </tp:rationale>

TP_STRUCT_TYPE_SIMPLE_STATUS_SPEC

#define             TP_STRUCT_TYPE_SIMPLE_STATUS_SPEC

A struct containing information about a status.

This macro expands to a call to a function that returns the GType of a GValueArray appropriate for representing a D-Bus struct with signature (ubb).

Member 0 (D-Bus type u, type Connection_Presence_Type, named Type): The type of a presence. This SHOULD NOT be used as a way to set statuses that the client does not recognise (as explained in <tp:member-ref>SetPresence</tp:member-ref>), but MAY be used to check that the client's assumptions about a particular status name match the connection manager's.

Member 1 (D-Bus type b, named May_Set_On_Self): If true, the user can set this status on themselves using <tp:member-ref>SetPresence</tp:member-ref>.

Member 2 (D-Bus type b, named Can_Have_Message): If true, a non-empty message can be set for this status. Otherwise, the empty string is the only acceptable message. <tp:rationale> On IRC you can be Away with a status message, but if you are available you cannot set a status message. </tp:rationale>

TP_STRUCT_TYPE_RICH_PRESENCE_ACCESS_CONTROL

#define             TP_STRUCT_TYPE_RICH_PRESENCE_ACCESS_CONTROL

An access control mode for extended presence items like geolocation. This type isn't actually used by the SimplePresence interface, but it's included here so it can be referenced by rich presence interfaces such as <tp:dbus-ref namespace="org.freedesktop.Telepathy.Connection.Interface"> Location </tp:dbus-ref> .

This macro expands to a call to a function that returns the GType of a GValueArray appropriate for representing a D-Bus struct with signature (uv).

Member 0 (D-Bus type u, type Rich_Presence_Access_Control_Type, named Type): The type of access control to apply.

Member 1 (D-Bus type v, named Detail): Any additional information required by the Type. The required type and semantics are defined for each <tp:type>Rich_Presence_Access_Control_Type</tp:type>.

TP_HASH_TYPE_CONTACT_PRESENCES

#define             TP_HASH_TYPE_CONTACT_PRESENCES

Mapping returned by <tp:member-ref>GetPresence</tp:member-ref> and signalled by <tp:member-ref>PresenceUpdate</tp:member-ref>, where the keys are contacts and the values represent their presences.

This macro expands to a call to a function that returns the GType of a GHashTable appropriate for representing a D-Bus dictionary of signature a{u(ua{sa{sv}})}.

Keys (D-Bus type u, type Contact_Handle, named Contact): (Undocumented)

Values (D-Bus type (ua{sa{sv}}), type Last_Activity_And_Statuses, named Presence): (Undocumented)

TP_HASH_TYPE_MULTIPLE_STATUS_MAP

#define             TP_HASH_TYPE_MULTIPLE_STATUS_MAP

Mapping used in <tp:type>Last_Activity_And_Statuses</tp:type> and passed to <tp:member-ref>SetStatus</tp:member-ref>, representing a collection of statuses. Use of this mapping with more than one member is deprecated.

This macro expands to a call to a function that returns the GType of a GHashTable appropriate for representing a D-Bus dictionary of signature a{sa{sv}}.

Keys (D-Bus type s, named Status): (Undocumented)

Values (D-Bus type a{sv}, type String_Variant_Map, named Parameters): (Undocumented)

TP_HASH_TYPE_STATUS_SPEC_MAP

#define             TP_HASH_TYPE_STATUS_SPEC_MAP

(Undocumented)

This macro expands to a call to a function that returns the GType of a GHashTable appropriate for representing a D-Bus dictionary of signature a{s(ubba{ss})}.

Keys (D-Bus type s, named Identifier): (Undocumented)

Values (D-Bus type (ubba{ss}), type Status_Spec, named Spec): (Undocumented)

TP_STRUCT_TYPE_LAST_ACTIVITY_AND_STATUSES

#define             TP_STRUCT_TYPE_LAST_ACTIVITY_AND_STATUSES

Structure representing a contact's presence, containing a last-activity time (deprecated) and a Multiple_Status_Map.

This macro expands to a call to a function that returns the GType of a GValueArray appropriate for representing a D-Bus struct with signature (ua{sa{sv}}).

Member 0 (D-Bus type u, type Unix_Timestamp, named Last_Activity): (Undocumented)

Member 1 (D-Bus type a{sa{sv}}, type Multiple_Status_Map, named Statuses): (Undocumented)

TP_STRUCT_TYPE_STATUS_SPEC

#define             TP_STRUCT_TYPE_STATUS_SPEC

(Undocumented)

This macro expands to a call to a function that returns the GType of a GValueArray appropriate for representing a D-Bus struct with signature (ubba{ss}).

Member 0 (D-Bus type u, type Connection_Presence_Type, named Type): (Undocumented)

Member 1 (D-Bus type b, named May_Set_On_Self): (Undocumented)

Member 2 (D-Bus type b, named Exclusive): (Undocumented)

Member 3 (D-Bus type a{ss}, type String_String_Map, named Parameter_Types): (Undocumented)

TP_HASH_TYPE_LOCATION

#define             TP_HASH_TYPE_LOCATION

A user's location, represented as an extensible mapping.

This macro expands to a call to a function that returns the GType of a GHashTable appropriate for representing a D-Bus dictionary of signature a{sv}.

Keys (D-Bus type s, named Key): <tp:docstring xmlns="http://www.w3.org/1999/xhtml"> <p>Civic addresses are represented by the following well-known keys (all of which have string values), which should be kept in sync with those used in XEP-0080 and in the Geoclue project:</p> <ul> <li>countrycode - s: an ISO-3166-1 alpha-2 (two-letter) country code, e.g. &quot;us&quot;, &quot;gb&quot;, &quot;fr&quot;</li> <li>country - s: a country name in unspecified locale, e.g. &quot;USA&quot;</li> <li>region - s: an administrative region of the nation, such as a state or province</li> <li>locality - s: a locality within the administrative region, such as a town or city</li> <li>area - s: a named area such as a campus or neighborhood</li> <li>postalcode - s: a code used for postal delivery</li> <li>street - s: a thoroughfare within the locality, or a crossing of two thoroughfares</li> </ul> <p>The following address keys are defined in XEP-0080 but not by Geoclue, and are also allowed:</p> <ul> <li>building - s: a specific building on a street or in an area</li> <li>floor - s: a particular floor in a building</li> <li>room - s: a particular room in a building</li> <li>text - s: any more specific information, e.g. &quot;Northwest corner of the lobby&quot;</li> <li>description - s: A natural-language name for or description of the location, e.g. &quot;Bill's house&quot;</li> <li>uri - s: a URI representing the location or pointing to more information about it</li> </ul> <p>Since the previous strings have data intended to be read by users, the language used should be stated using:</p> <ul> <li>language - s: a specific language or locale of location information in a format compatible to RFC 4646. Note that UTF-8 is the only allowed encoding, e.g. &quot;en&quot; or &quot;fr-CA&quot;.</li> </ul> <p>Positions are represented by the following well-known keys:</p> <ul> <li>lat - d: latitude in decimal degrees north, -90 to +90, relative to the WGS-84 datum <tp:rationale> This is from XEP-0080; the XEP allows use of a different datum, but recommends this one. We enforce sanity by requiring a consistent datum: a minimal compliant implementation of this specification in terms of XEP-0080 would simply ignore the &lt;lat&gt; and &lt;lon&gt; elements if &lt;datum&gt; exists and has a value other than WGS-84, while an advanced implementation might correct for the different datum. </tp:rationale> </li> <li>lon - d: Longitude in decimal degrees east, -180 to +180, relative to the WGS-84 datum <tp:rationale> Same rationale as 'lat' </tp:rationale> </li> <li>alt - d: altitude in metres above sea level (negative if below sea level) <tp:rationale> This is from XEP-0080 </tp:rationale> </li> <!-- Potentially to be reinstated later: http://bugs.freedesktop.org/show_bug.cgi?id=19585 <li>accuracy-level - i (<tp:type>Location_Accuracy_Level</tp:type>): an indication of accuracy, which SHOULD be omitted if it would be Location_Accuracy_Level_None or Location_Accuracy_Level_Detailed <tp:rationale> This is a struct field in GeoClue; the name is new in this specification, and was chosen in an attempt to avoid clashing with any future XEP-0080 terminology. </tp:rationale> </li> --> <li>accuracy - d: horizontal position error in metres if known <tp:rationale> This is from XEP-0080 </tp:rationale> </li> </ul> <p>Velocities are represented by the following well-known keys:</p> <ul> <li>speed - d: speed in metres per second <tp:rationale> This is from XEP-0080 </tp:rationale> </li> <li>bearing - d: direction of movement in decimal degrees, where North is 0 and East is 90 <tp:rationale> This is from XEP-0080, and is equivalent to the struct field called &quot;direction&quot; in GeoClue </tp:rationale> </li> </ul> <p>Other well-known keys:</p> <ul> <li>timestamp - x (<tp:type>Unix_Timestamp64</tp:type>): the time that the contact was at this location, in seconds since 1970-01-01T00:00:00Z (i.e. the beginning of 1970 in UTC) <tp:rationale> XEP-0080 uses an ISO 8601 string for this, but a number of seconds since the epoch is probably easier to work with. </tp:rationale> </li> </ul>

Values (D-Bus type v, named Value): The value corresponding to the well-known key.

TP_HASH_TYPE_CONTACT_LOCATIONS

#define             TP_HASH_TYPE_CONTACT_LOCATIONS

A map from contacts to their locations.

This macro expands to a call to a function that returns the GType of a GHashTable appropriate for representing a D-Bus dictionary of signature a{ua{sv}}.

Keys (D-Bus type u, type Contact_Handle, named Contact): A contact

Values (D-Bus type a{sv}, type Location, named Location): The contact's location, which MAY be empty to indicate that the contact's location is unknown

TP_STRUCT_TYPE_LOCAL_PENDING_INFO

#define             TP_STRUCT_TYPE_LOCAL_PENDING_INFO

A structure representing a contact whose attempt to join a group is to be confirmed by the local user using <tp:member-ref> AddMembers </tp:member-ref> .

This macro expands to a call to a function that returns the GType of a GValueArray appropriate for representing a D-Bus struct with signature (uuus).

Member 0 (D-Bus type u, type Contact_Handle, named To_Be_Added): The contact to be added to the group

Member 1 (D-Bus type u, type Contact_Handle, named Actor): The contact requesting or causing the change

Member 2 (D-Bus type u, type Channel_Group_Change_Reason, named Reason): The reason for the change

Member 3 (D-Bus type s, named Message): A human-readable message from the Actor, or an empty string if there is no message

TP_ARRAY_TYPE_LOCAL_PENDING_INFO_LIST

#define             TP_ARRAY_TYPE_LOCAL_PENDING_INFO_LIST

Expands to a call to a function that returns the GType of a GPtrArray of TP_STRUCT_TYPE_LOCAL_PENDING_INFO.

TP_HASH_TYPE_HANDLE_OWNER_MAP

#define             TP_HASH_TYPE_HANDLE_OWNER_MAP

A map from channel-specific handles to their owners.

This macro expands to a call to a function that returns the GType of a GHashTable appropriate for representing a D-Bus dictionary of signature a{uu}.

Keys (D-Bus type u, type Contact_Handle, named Channel_Specific_Handle): A nonzero channel-specific handle

Values (D-Bus type u, type Contact_Handle, named Global_Handle): The global handle that owns the corresponding channel-specific handle, or 0 if this could not be determined

TP_HASH_TYPE_HANDLE_IDENTIFIER_MAP

#define             TP_HASH_TYPE_HANDLE_IDENTIFIER_MAP

A map from handles to the corresponding normalized string identifier.

This macro expands to a call to a function that returns the GType of a GHashTable appropriate for representing a D-Bus dictionary of signature a{us}.

Keys (D-Bus type u, type Contact_Handle, named Handle): A nonzero handle

Values (D-Bus type s, named Identifier): The same string that would be returned by <tp:dbus-ref namespace="org.freedesktop.Telepathy.Connection">InspectHandles</tp:dbus-ref> for this handle.

TP_STRUCT_TYPE_PENDING_TEXT_MESSAGE

#define             TP_STRUCT_TYPE_PENDING_TEXT_MESSAGE

A struct (message ID, timestamp in seconds since 1970-01-01 00:00 UTC, sender's handle, message type, flags, text) representing a pending text message, as returned by <tp:member-ref> ListPendingMessages </tp:member-ref> . The arguments of the <tp:member-ref> Received </tp:member-ref> signal also match this struct's signature.

This macro expands to a call to a function that returns the GType of a GValueArray appropriate for representing a D-Bus struct with signature (uuuuus).

Member 0 (D-Bus type u, type Message_ID, named Identifier): (Undocumented)

Member 1 (D-Bus type u, type Unix_Timestamp, named Unix_Timestamp): (Undocumented)

Member 2 (D-Bus type u, type Contact_Handle, named Sender): (Undocumented)

Member 3 (D-Bus type u, type Channel_Text_Message_Type, named Message_Type): (Undocumented)

Member 4 (D-Bus type u, type Channel_Text_Message_Flags, named Flags): (Undocumented)

Member 5 (D-Bus type s, named Text): (Undocumented)

TP_ARRAY_TYPE_PENDING_TEXT_MESSAGE_LIST

#define             TP_ARRAY_TYPE_PENDING_TEXT_MESSAGE_LIST

Expands to a call to a function that returns the GType of a GPtrArray of TP_STRUCT_TYPE_PENDING_TEXT_MESSAGE.

TP_HASH_TYPE_MESSAGE_PART

#define             TP_HASH_TYPE_MESSAGE_PART

<tp:docstring xmlns="http://www.w3.org/1999/xhtml"> <p>Part of a message's content. In practice, this mapping never appears in isolation - messages are represented by a list of <tp:type>Message_Part</tp:type> mappings.</p> <p>An example of how a message might look, in a Python-like syntax:</p> <pre> [ { 'message-token': '9de9546a-3400-4419-a505-3ea270cb834c', 'message-sender': 42, 'message-sent': 1210067943, 'message-received': 1210067947, 'message-type': 0, # = Channel_Text_Message_Type_Normal 'pending-message-id': 437, }, { 'alternative': 'main', 'content-type': 'text/html', 'content': 'Here is a photo of my cat:&lt;br /&gt;' + '&lt;img src=&quot;cid:catphoto&quot; alt=&quot;lol!&quot; /&gt;' + '&lt;br /&gt;Isn't it cute?', }, { 'alternative': 'main', 'content-type': 'text/plain', 'content': 'Here is a photo of my cat:\n[IMG: lol!]\nIsn't it cute?', }, { 'identifier': 'catphoto', 'content-type': 'image/jpeg', 'size': 101000, 'needs-retrieval': True, }, ] </pre> <div> <p>The first part of the message contains &quot;headers&quot; which refer to the entire message.</p> <p>It is an error for a connection manager to put keys referring to the message as a whole in the second or subsequent Message_Part, but clients MUST recover from this error by ignoring these keys in the second and subsequent parts.</p> <tp:rationale> <p>Instead of representing messages as aa{sv} where the first dictionary is special (a dictionary of headers), we could have used a signature like (a{sv}aa{sv}) to separate out the headers and the body parts.</p> <p>However, this would make access to the messages more awkward. In Python, the syntax for access to a header field would remain <code>message[0]['message-type']</code>, but access to a body field in the second body part would change from message[2]['content'] to message[1][1]['content']. In GLib, the message would change from being a GPtrArray(GHashTable) to being a GValueArray(GHashTable, GPtrArray(GHashTable)) which is rather inconvenient to dereference.</p> </tp:rationale> <p>Well-known keys for the message as a whole, and the corresponding value types, include:</p> <dl> <dt>message-token (s)</dt> <dd>An opaque, globally-unique identifier for the entire message. This MAY be treated as if it were a MIME Message-ID, e.g. for the mid: and cid: URI schemes. If omitted, there is no suitable token.</dd> <dt>message-sent (x - <tp:type>Unix_Timestamp64</tp:type>)</dt> <dd>The time the message was sent (if unavailable, the time it arrived at a central server MAY be used). Omitted if no reasonable approximation is available; SHOULD always be present on outgoing messages.</dd> <dt>message-received (x - <tp:type>Unix_Timestamp64</tp:type>)</dt> <dd>The time the message was received locally. SHOULD always be present.</dd> <dt>message-sender (u - <tp:type>Contact_Handle</tp:type>)</dt> <dd>The contact who sent the message. If 0 or omitted, the contact who sent the message could not be determined.</dd> <dt>message-type (u - <tp:type>Channel_Text_Message_Type</tp:type>) </dt> <dd>The type of message; if omitted, Channel_Text_Message_Type_Normal MUST be assumed. MAY be omitted for normal chat messages.</dd> <dt>pending-message-id (u - <tp:type>Message_ID</tp:type>)</dt> <dd>The incoming message ID. This MUST NOT be present on outgoing messages. Clients SHOULD NOT store this key - it is only valid for as long as the message remains unacknowledged.</dd> <dt>interface (s - <tp:type>DBus_Interface</tp:type>)</dt> <dd>This message is specific to the given interface, which is neither Text nor Messages. It SHOULD be ignored if that interface is not supported. (Note that an 'interface' key can also appear on the second and subsequent parts, where it indicates that that part (only) should be ignored if unsupported.)</dd> <dt>scrollback (b)</dt> <dd>If present and true, the incoming message was part of a replay of message history (this matches the Scrollback flag in <tp:type>Channel_Text_Message_Flags</tp:type>). This flag does not make sense on outgoing messages and SHOULD NOT appear there.</dd> <dt>rescued (b)</dt> <dd>If present and true, the incoming message has been seen in a previous channel during the lifetime of the Connection, but had not been acknowledged when that channel closed, causing an identical channel (in which the message now appears) to open. This matches the Rescued flag in <tp:type>Channel_Text_Message_Flags</tp:type>; it does not make sense on outgoing messages, and SHOULD NOT appear there.</dd> </dl> </div> <div> <p>The second and subsequent parts contain the message's content, including plain text, formatted text and/or attached files.</p> <p>It is an error for a connection manager to put keys referring to the message body in the first Message_Part; clients MUST recover from this error by ignoring these keys in first part.</p> <p>In any group of parts with the same non-empty value for the &quot;alternative&quot; key (which represent alternative versions of the same content), more faithful versions of the intended message MUST come before less faithful versions (note that this order is the opposite of MIME &quot;multipart/alternative&quot; parts). Clients SHOULD display the first alternative that they understand.</p> <tp:rationale> <p>Specifying the preference order means that if the underlying protocol doesn't support alternatives, the CM can safely delete everything apart from the first supported alternative when sending messages.</p> <p>The order is the reverse of MIME because MIME's rationale for placing the &quot;plainest&quot; part first (legibility in pre-MIME UAs) does not apply to us, and placing the most preferred part first simplifies display (a client can iterate the message in order, display the first alternative that it understands, and skip displaying all subsequent parts with the same &quot;alternative&quot; key).</p> </tp:rationale> <p>Clients SHOULD present all parts that are not redundant alternatives in the order they appear in this array, possibly excluding parts that are referenced by another displayed part. It is implementation-specific how the parts are presented to the user.</p> <tp:rationale> <p>This allows CMs to assume that all parts are actually shown to the user, even if they are not explicitly referenced - we do not yet recommend formatted text, and there is no way for plain text to reference an attachment since it has no concept of markup or references. This also forces clients to do something sensible with messages that consist entirely of &quot;attachments&quot;, with no &quot;body&quot; at all.</p> <p>For instance, when displaying the above example, a client that understands the HTML part should display the JPEG image once, between the two lines &quot;Here is a photo of my cat:&quot; and &quot;Isn't it cute?&quot;; it may additionally present the image in some way for a second time, after &quot;Isn't it cute?&quot;, or may choose not to.</p> <p>A client that does not understand HTML, displaying the same message, should display the plain-text part, followed by the JPEG image.</p> </tp:rationale> <p>Well-known keys for the second and subsequent parts, and the corresponding value types, include:</p> <dl> <dt>identifier (s)</dt> <dd>An opaque identifier for this part. Parts of a message MAY reference other parts by treating this identifier as if it were a MIME Content-ID and using the cid: URI scheme.</dd> <dt>alternative (s)</dt> <dd> <p>If present, this part of the message is an alternative for all other parts with the same value for &quot;alternative&quot;. Clients SHOULD only display one of them (this is expected to be used for XHTML messages in a future version of this specification).</p> <p>If omitted, this part is not an alternative for any other part.</p> <p>Parts of a message MAY reference the group of alternatives as a whole (i.e. a reference to whichever of them is chosen) by treating this identifier as if it were the MIME Content-ID of a multipart/alternative part, and using the cid: URI scheme.</p> </dd> <dt>content-type (s)</dt> <dd> <p>The MIME type of this part. See the documentation for ReceivedMessage for notes on the special status of &quot;text/plain&quot; parts.</p> <p>Connection managers MUST NOT signal parts without a 'content-type' key; if a protocol provides no way to determine the MIME type, the connection manager is responsible for guessing it, but MAY fall back to &quot;text/plain&quot; for text and &quot;application/octet-stream&quot; for non-text.</p> <p>Clients MUST ignore parts without a 'content-type' key, which are reserved for future expansion.</p> </dd> <dt>lang (s)</dt> <dd>The natural language of this part, identified by a RFC 3066 language tag. <tp:rationale> XMPP allows alternative-selection by language as well as by content-type. </tp:rationale> </dd> <dt>size (u)</dt> <dd>The size in bytes (if needs-retrieval is true, this MAY be an estimated or approximate size). SHOULD be omitted if 'content' is provided. <tp:rationale> There's no point in providing the size if you're already providing all the content. </tp:rationale> </dd> <dt>needs-retrieval (b)</dt> <dd>If false or omitted, the connection manager already holds this part in memory. If present and true, this part will be retrieved on demand (like MIME's message/external-body), so clients should expect retrieval to take time; if this specification is later extended to provide a streaming version of GetPendingMessageContent, clients should use it for parts with this flag.</dd> <dt>truncated (b)</dt> <dd>The content available via the 'content' key or GetPendingMessageContent has been truncated by the server or connection manager (equivalent to Channel_Text_Message_Flag_Truncated in the Text interface). </dd> <dt>content (s or ay)</dt> <dd>The part's content, if it is available and sufficiently small to include here (implies that 'needs-retrieval' is false or omitted). Otherwise, omitted. If the part is human-readable text or HTML, the value for this key MUST be a UTF-8 string (D-Bus signature 's'). If the part is not text, the value MUST be a byte-array (D-Bus signature 'ay'). If the part is a text-based format that is not the main body of the message (e.g. an iCalendar or an attached XML document), the value SHOULD be a UTF-8 string, transcoding from another charset to UTF-8 if necessary, but MAY be a byte-array (of unspecified character set) if transcoding fails or the source charset is not known.</dd> <!-- FIXME: "sufficiently small to include" is not currently defined; we should add some API so clients can tell the CM how large a message it should emit in the signal.--> <dt>interface (s - <tp:type>DBus_Interface</tp:type>)</dt> <dd>This part is specific to the given interface, which is neither Text nor Messages. It SHOULD be ignored if that interface is not supported. (Note that an 'interface' key can also appear on the first part, where it indicates that the entire message should be ignored if unsupported.)</dd> </dl> </div> <div> <p>Delivery reports are also represented as messages, of type Channel_Text_Message_Type_Delivery_Report, with the Non_Text_Content flag in the Text interface.</p> <p>Whenever a message of type Channel_Text_Message_Type_Delivery_Report is signalled for a delivery error report, Channel.Type.Text.SendError SHOULD also be emitted; whenever Channel.Type.Text.SendError is emitted by a channel which supports this interface, a message of type Channel_Text_Message_Type_Delivery_Report MUST also be emitted.</p> <p>The corresponding message in the Messages interface MUST contain &quot;headers&quot; for the delivery report, as specified below, in its first Message_Part.</p> <dl> <dt>message-sender (u - Contact_Handle as defined above)</dt> <dd>MUST be the intended recipient of the original message, if available (zero or omitted if the intended recipient is unavailable or is not a contact, e.g. a chatroom), even if the delivery report actually came from an intermediate server.</dd> <dt>message-type (u - Channel_Text_Message_Type as defined above)</dt> <dd>MUST be Channel_Text_Message_Type_Delivery_Report.</dd> <dt>delivery-status (u - Delivery_Status)</dt> <dd>The status of the message. All delivery reports MUST contain this key in the first Message_Part.</dd> <dt>delivery-token (s - Sent_Message_Token)</dt> <dd> <p>An identifier for the message to which this delivery report refers. MUST NOT be an empty string. Omitted if not available.</p> <p>Clients may match this against the token produced by the SendMessage method and MessageSent signal. A status report with no token could match any sent message, and a sent message with an empty token could match any status report. If multiple sent messages match, clients SHOULD use some reasonable heuristic.</p> <tp:rationale> In an ideal world, we could unambiguously match reports against messages; however, deployed protocols are not ideal, and not all reports and messages can be matched. </tp:rationale> </dd> <dt>delivery-error (u - Channel_Text_Send_Error)</dt> <dd> The reason for the failure. MUST be omitted if this was a successful delivery; SHOULD be omitted if it would be Channel_Text_Send_Error_Unknown. </dd> <dt>delivery-dbus-error (s - DBus_Error_Name)</dt> <dd> The reason for the failure, specified as a (possibly implementation-specific) D-Bus error. MUST be omitted if this was a successful delivery. If set, the 'delivery-error' key SHOULD be set to the closest available value. </dd> <dt>delivery-error-message (s)</dt> <dd> Debugging information on why the message could not be delivered. MUST be omitted if this was a successful delivery; MAY always be omitted. </dd> <dt>delivery-echo (aa{sv} - Message_Part[])</dt> <dd> <p>The message content, as defined by the Messages interface. Omitted if no content is available. Content MAY have been truncated, message parts MAY have been removed, and message parts MAY have had their content removed (i.e. the message part metadata is present, but the 'content' key is not).</p> <tp:rationale> Some protocols, like XMPP, echo the failing message back to the sender. This is sometimes the only way to match it against the sent message, so we include it here. </tp:rationale> <p>Unlike in the Messages interface, content not visible in the value for this key cannot be retrieved by another means, so the connection manager SHOULD be more aggressive about including (possibly truncated) message content in the 'content' key.</p> <tp:rationale> The Messages interface needs to allow all content to be retrieved, but in this interface, the content we provide is merely a hint; so some is better than none, and it doesn't seem worth providing an API as complex as Messages' GetPendingMessageContent for the echoed message. </tp:rationale> </dd> </dl> <p>The second and subsequent Message_Part dictionaries, if present, are a human-readable report from the IM service.</p> <p>Clients MUST NOT attempt to send delivery reports using the SendMessage method in the Messages API, and connection managers MUST NOT allow this to be done. If support for sending delivery reports is later added, it will be part of this interface.</p> <p>Some example delivery reports in a Python-like syntax (in which arrays are indicated by [a, b] and dictionaries by {k1: v1, k2: v2}) follow.</p> <dl> <dt>A minimal delivery report indicating permanent failure of the sent message whose token was <code>b9a991bd-8845-4d7f-a704-215186f43bb4</code> for an unknown reason</dt> <dd><pre> [{ # header 'message-sender': 123, 'message-type': Channel_Text_Message_Type_Delivery_Report, 'delivery-status': Delivery_Status_Permanently_Failed, 'delivery-token': 'b9a991bd-8845-4d7f-a704-215186f43bb4', } # no body ] </pre></dd> <dt>A delivery report where the failed message is echoed back to the sender rather than being referenced by ID, and the failure reason is that this protocol cannot send messages to offline contacts such as the contact with handle 123</dt> <dd><pre> [{ # header 'message-sender': 123, 'message-type': Channel_Text_Message_Type_Delivery_Report, 'delivery-status': Delivery_Status_Temporarily_Failed, 'delivery-error': Channel_Text_Send_Error_Offline, 'delivery-echo': [{ # header of original message 'message-sender': 1, 'message-sent': 1210067943, }, { # body of original message 'content-type': 'text/plain', 'content': 'Hello, world!', }] ], # no body ] </pre></dd> <dt>A maximally complex delivery report: the server reports a bilingual human-readable failure message because the user sent a message &quot;Hello, world!&quot; with token <code>b9a991bd-8845-4d7f-a704-215186f43bb4</code> to a contact with handle 123, but that handle represents a contact who does not actually exist</dt> <dd><pre> [{ # header 'message-sender': 123, 'message-type': Channel_Text_Message_Type_Delivery_Report, 'delivery-status': Delivery_Status_Permanently_Failed, 'delivery-error': Channel_Text_Send_Error_Invalid_Contact, 'delivery-token': 'b9a991bd-8845-4d7f-a704-215186f43bb4', 'delivery-echo': [{ # header of original message 'message-sender': 1, 'message-sent': 1210067943, }, { # body of original message 'content-type': 'text/plain', 'content': 'Hello, world!', }] ], }, { # message from server (alternative in English) 'alternative': '404', 'content-type': 'text/plain', 'lang': 'en', 'content': 'I have no contact with that name', }, { # message from server (alternative in German) 'alternative': '404'. 'content-type': 'text/plain', 'lang': 'de', 'content', 'Ich habe keinen Kontakt mit diesem Namen', } ] </pre></dd> <dt>A minimal delivery report indicating successful delivery of the sent message whose token was <code>b9a991bd-8845-4d7f-a704-215186f43bb4</code></dt> <dd><pre> [{ # header 'message-sender': 123, 'message-type': Channel_Text_Message_Type_Delivery_Report, 'delivery-status': Delivery_Status_Delivered, 'delivery-token': 'b9a991bd-8845-4d7f-a704-215186f43bb4', } # no body ] </pre></dd> </dl> </div>

This macro expands to a call to a function that returns the GType of a GHashTable appropriate for representing a D-Bus dictionary of signature a{sv}.

Keys (D-Bus type s, named Key): A key, which SHOULD be one of the well-known keys specified, if possible.

Values (D-Bus type v, named Value): The value corresponding to the given key, which must be of one of the types indicated.

TP_ARRAY_TYPE_MESSAGE_PART_LIST

#define             TP_ARRAY_TYPE_MESSAGE_PART_LIST

Expands to a call to a function that returns the GType of a GPtrArray of TP_HASH_TYPE_MESSAGE_PART.

TP_HASH_TYPE_MESSAGE_PART_CONTENT_MAP

#define             TP_HASH_TYPE_MESSAGE_PART_CONTENT_MAP

A mapping from message part indexes to their content, as returned by <tp:member-ref>GetPendingMessageContent</tp:member-ref>.

This macro expands to a call to a function that returns the GType of a GHashTable appropriate for representing a D-Bus dictionary of signature a{uv}.

Keys (D-Bus type u, type Message_Part_Index, named Part): Indexes into the array of <tp:type>Message_Part</tp:type>s that represents a message. The &quot;headers&quot; part (which is not a valid argument to GetPendingMessageContent) is considered to be part 0, so the valid part numbers start at 1 (for the second message part).

Values (D-Bus type v, named Content): The message part's content. The variant MUST contain either type 's' or 'ay' (UTF-8 text string, or byte array), following the same rules as for the value of the 'content' key in the <tp:type>Message_Part</tp:type> mappings.

TP_HASH_TYPE_SUPPORTED_SOCKET_MAP

#define             TP_HASH_TYPE_SUPPORTED_SOCKET_MAP

The supported socket address and access-control types for tubes. See GetAvailableStreamTubeTypes.

This macro expands to a call to a function that returns the GType of a GHashTable appropriate for representing a D-Bus dictionary of signature a{uau}.

Keys (D-Bus type u, type Socket_Address_Type, named Address_Type): (Undocumented)

Values (D-Bus type au, type Socket_Access_Control[], named Access_Control): (Undocumented)

TP_STRUCT_TYPE_TUBE_INFO

#define             TP_STRUCT_TYPE_TUBE_INFO

A struct (tube ID, initiator handle, tube type, service name, parameters, state) representing a tube, as returned by ListTubes on the Tubes channel type.

This macro expands to a call to a function that returns the GType of a GValueArray appropriate for representing a D-Bus struct with signature (uuusa{sv}u).

Member 0 (D-Bus type u, type Tube_ID, named Identifier): (Undocumented)

Member 1 (D-Bus type u, type Contact_Handle, named Initiator): (Undocumented)

Member 2 (D-Bus type u, type Tube_Type, named Type): (Undocumented)

Member 3 (D-Bus type s, named Service): (Undocumented)

Member 4 (D-Bus type a{sv}, type String_Variant_Map, named Parameters): (Undocumented)

Member 5 (D-Bus type u, type Tube_State, named State): (Undocumented)

TP_ARRAY_TYPE_TUBE_INFO_LIST

#define             TP_ARRAY_TYPE_TUBE_INFO_LIST

Expands to a call to a function that returns the GType of a GPtrArray of TP_STRUCT_TYPE_TUBE_INFO.

TP_STRUCT_TYPE_DBUS_TUBE_MEMBER

#define             TP_STRUCT_TYPE_DBUS_TUBE_MEMBER

Represents a participant in a multi-user D-Bus tube, as returned by <tp:member-ref> GetDBusNames </tp:member-ref> and seen in the <tp:member-ref> DBusNamesChanged </tp:member-ref> signal.

This macro expands to a call to a function that returns the GType of a GValueArray appropriate for representing a D-Bus struct with signature (us).

Member 0 (D-Bus type u, type Contact_Handle, named Handle): The handle of a participant in this D-Bus tube.

Member 1 (D-Bus type s, type DBus_Unique_Name, named Unique_Name): That participant's unique name.

TP_ARRAY_TYPE_DBUS_TUBE_MEMBER_LIST

#define             TP_ARRAY_TYPE_DBUS_TUBE_MEMBER_LIST

Expands to a call to a function that returns the GType of a GPtrArray of TP_STRUCT_TYPE_DBUS_TUBE_MEMBER.

TP_HASH_TYPE_DBUS_TUBE_PARTICIPANTS

#define             TP_HASH_TYPE_DBUS_TUBE_PARTICIPANTS

Represents the participants in a multi-user D-Bus tube, as used by the <tp:member-ref>DBusNames</tp:member-ref> property and the <tp:member-ref>DBusNamesChanged</tp:member-ref> signal.

This macro expands to a call to a function that returns the GType of a GHashTable appropriate for representing a D-Bus dictionary of signature a{us}.

Keys (D-Bus type u, type Contact_Handle, named Handle): The handle of a participant in this D-Bus tube.

Values (D-Bus type s, type DBus_Unique_Name, named Unique_Name): That participant's unique name.

TP_STRUCT_TYPE_PROPERTY_SPEC

#define             TP_STRUCT_TYPE_PROPERTY_SPEC

A struct (property ID, property name, D-Bus signature, flags) representing a property, as returned by ListProperties on the Properties interface.

This macro expands to a call to a function that returns the GType of a GValueArray appropriate for representing a D-Bus struct with signature (ussu).

Member 0 (D-Bus type u, named Property_ID): (Undocumented)

Member 1 (D-Bus type s, named Name): (Undocumented)

Member 2 (D-Bus type s, type DBus_Signature, named Signature): (Undocumented)

Member 3 (D-Bus type u, type Property_Flags, named Flags): (Undocumented)

TP_ARRAY_TYPE_PROPERTY_SPEC_LIST

#define             TP_ARRAY_TYPE_PROPERTY_SPEC_LIST

Expands to a call to a function that returns the GType of a GPtrArray of TP_STRUCT_TYPE_PROPERTY_SPEC.

TP_STRUCT_TYPE_PROPERTY_FLAGS_CHANGE

#define             TP_STRUCT_TYPE_PROPERTY_FLAGS_CHANGE

A struct (property ID, flags) representing a change to a property's flags, as seen in the PropertyFlagsChanged signal on the Properties interface.

This macro expands to a call to a function that returns the GType of a GValueArray appropriate for representing a D-Bus struct with signature (uu).

Member 0 (D-Bus type u, named Property_ID): (Undocumented)

Member 1 (D-Bus type u, named New_Flags): (Undocumented)

TP_ARRAY_TYPE_PROPERTY_FLAGS_CHANGE_LIST

#define             TP_ARRAY_TYPE_PROPERTY_FLAGS_CHANGE_LIST

Expands to a call to a function that returns the GType of a GPtrArray of TP_STRUCT_TYPE_PROPERTY_FLAGS_CHANGE.

TP_STRUCT_TYPE_PROPERTY_VALUE

#define             TP_STRUCT_TYPE_PROPERTY_VALUE

A struct (property ID, value) representing a property's value, as seen in the PropertiesChanged signal on the Properties interface, returned by the GetProperties method and passed to the SetProperties method.

This macro expands to a call to a function that returns the GType of a GValueArray appropriate for representing a D-Bus struct with signature (uv).

Member 0 (D-Bus type u, type Property_ID, named Identifier): (Undocumented)

Member 1 (D-Bus type v, named Value): (Undocumented)

TP_ARRAY_TYPE_PROPERTY_VALUE_LIST

#define             TP_ARRAY_TYPE_PROPERTY_VALUE_LIST

Expands to a call to a function that returns the GType of a GPtrArray of TP_STRUCT_TYPE_PROPERTY_VALUE.

TP_ARRAY_TYPE_MEDIA_SESSION_HANDLER_INFO_LIST

#define             TP_ARRAY_TYPE_MEDIA_SESSION_HANDLER_INFO_LIST

Expands to a call to a function that returns the GType of a GPtrArray of TP_STRUCT_TYPE_MEDIA_SESSION_HANDLER_INFO.

TP_STRUCT_TYPE_MEDIA_SESSION_HANDLER_INFO

#define             TP_STRUCT_TYPE_MEDIA_SESSION_HANDLER_INFO

A struct representing a active session handler.

This macro expands to a call to a function that returns the GType of a GValueArray appropriate for representing a D-Bus struct with signature (os).

Member 0 (D-Bus type o, named Session_Handler): The object path of the session handler, which is on the same bus name as the channel.

Member 1 (D-Bus type s, type Media_Session_Type, named Media_Session_Type): The media session's type

TP_ARRAY_TYPE_MEDIA_STREAM_HANDLER_CANDIDATE_LIST

#define             TP_ARRAY_TYPE_MEDIA_STREAM_HANDLER_CANDIDATE_LIST

Expands to a call to a function that returns the GType of a GPtrArray of TP_STRUCT_TYPE_MEDIA_STREAM_HANDLER_CANDIDATE.

TP_ARRAY_TYPE_MEDIA_STREAM_HANDLER_CODEC_LIST

#define             TP_ARRAY_TYPE_MEDIA_STREAM_HANDLER_CODEC_LIST

Expands to a call to a function that returns the GType of a GPtrArray of TP_STRUCT_TYPE_MEDIA_STREAM_HANDLER_CODEC.

TP_ARRAY_TYPE_MEDIA_STREAM_HANDLER_TRANSPORT_LIST

#define             TP_ARRAY_TYPE_MEDIA_STREAM_HANDLER_TRANSPORT_LIST

Expands to a call to a function that returns the GType of a GPtrArray of TP_STRUCT_TYPE_MEDIA_STREAM_HANDLER_TRANSPORT.

TP_STRUCT_TYPE_MEDIA_STREAM_HANDLER_CANDIDATE

#define             TP_STRUCT_TYPE_MEDIA_STREAM_HANDLER_CANDIDATE

(Undocumented)

This macro expands to a call to a function that returns the GType of a GValueArray appropriate for representing a D-Bus struct with signature (sa(usuussduss)).

Member 0 (D-Bus type s, named Name): (Undocumented)

Member 1 (D-Bus type a(usuussduss), type Media_Stream_Handler_Transport[], named Transports): (Undocumented)

TP_STRUCT_TYPE_MEDIA_STREAM_HANDLER_CODEC

#define             TP_STRUCT_TYPE_MEDIA_STREAM_HANDLER_CODEC

Information about a codec supported by a client or a peer's client.

This macro expands to a call to a function that returns the GType of a GValueArray appropriate for representing a D-Bus struct with signature (usuuua{ss}).

Member 0 (D-Bus type u, named Codec_ID): The codec's payload identifier, as per RFC 3551 (static or dynamic)

Member 1 (D-Bus type s, named Name): The codec's name

Member 2 (D-Bus type u, type Media_Stream_Type, named Media_Type): Type of stream this codec supports

Member 3 (D-Bus type u, named Clock_Rate): Sampling frequency in Hertz

Member 4 (D-Bus type u, named Number_Of_Channels): Number of supported channels

Member 5 (D-Bus type a{ss}, type String_String_Map, named Parameters): Codec-specific optional parameters

TP_STRUCT_TYPE_MEDIA_STREAM_HANDLER_TRANSPORT

#define             TP_STRUCT_TYPE_MEDIA_STREAM_HANDLER_TRANSPORT

(Undocumented)

This macro expands to a call to a function that returns the GType of a GValueArray appropriate for representing a D-Bus struct with signature (usuussduss).

Member 0 (D-Bus type u, named Component_Number): (Undocumented)

Member 1 (D-Bus type s, named IP_Address): (Undocumented)

Member 2 (D-Bus type u, named Port): (Undocumented)

Member 3 (D-Bus type u, type Media_Stream_Base_Proto, named Protocol): (Undocumented)

Member 4 (D-Bus type s, named Subtype): (Undocumented)

Member 5 (D-Bus type s, named Profile): (Undocumented)

Member 6 (D-Bus type d, named Preference_Value): (Undocumented)

Member 7 (D-Bus type u, type Media_Stream_Transport_Type, named Transport_Type): (Undocumented)

Member 8 (D-Bus type s, named Username): (Undocumented)

Member 9 (D-Bus type s, named Password): (Undocumented)

TP_STRUCT_TYPE_MEDIA_STREAM_INFO

#define             TP_STRUCT_TYPE_MEDIA_STREAM_INFO

(Undocumented)

This macro expands to a call to a function that returns the GType of a GValueArray appropriate for representing a D-Bus struct with signature (uuuuuu).

Member 0 (D-Bus type u, type Stream_ID, named Identifier): (Undocumented)

Member 1 (D-Bus type u, type Contact_Handle, named Contact): (Undocumented)

Member 2 (D-Bus type u, type Media_Stream_Type, named Type): (Undocumented)

Member 3 (D-Bus type u, type Media_Stream_State, named State): (Undocumented)

Member 4 (D-Bus type u, type Media_Stream_Direction, named Direction): (Undocumented)

Member 5 (D-Bus type u, type Media_Stream_Pending_Send, named Pending_Send_Flags): (Undocumented)

TP_ARRAY_TYPE_MEDIA_STREAM_INFO_LIST

#define             TP_ARRAY_TYPE_MEDIA_STREAM_INFO_LIST

Expands to a call to a function that returns the GType of a GPtrArray of TP_STRUCT_TYPE_MEDIA_STREAM_INFO.

TP_HASH_TYPE_CHANNEL_CALL_STATE_MAP

#define             TP_HASH_TYPE_CHANNEL_CALL_STATE_MAP

A map from contacts to call states.

This macro expands to a call to a function that returns the GType of a GHashTable appropriate for representing a D-Bus dictionary of signature a{uu}.

Keys (D-Bus type u, type Contact_Handle, named Contact): A contact involved in this call.

Values (D-Bus type u, type Channel_Call_State_Flags, named State): State flags for the given contact.

TP_ARRAY_TYPE_ROOM_INFO_LIST

#define             TP_ARRAY_TYPE_ROOM_INFO_LIST

Expands to a call to a function that returns the GType of a GPtrArray of TP_STRUCT_TYPE_ROOM_INFO.

TP_STRUCT_TYPE_ROOM_INFO

#define             TP_STRUCT_TYPE_ROOM_INFO

(Undocumented)

This macro expands to a call to a function that returns the GType of a GValueArray appropriate for representing a D-Bus struct with signature (usa{sv}).

Member 0 (D-Bus type u, type Room_Handle, named Handle): (Undocumented)

Member 1 (D-Bus type s, type DBus_Interface, named Channel_Type): (Undocumented)

Member 2 (D-Bus type a{sv}, type String_Variant_Map, named Info): (Undocumented)

TP_STRUCT_TYPE_AVATAR

#define             TP_STRUCT_TYPE_AVATAR

<tp:docstring xmlns="http://www.w3.org/1999/xhtml"> <p> A struct containing avatar data marked with its MIME type. </p>

This macro expands to a call to a function that returns the GType of a GValueArray appropriate for representing a D-Bus struct with signature (ays).

Member 0 (D-Bus type ay, named Avatar_Data): (Undocumented)

Member 1 (D-Bus type s, named MIME_Type): (Undocumented)

TP_STRUCT_TYPE_DISPATCH_OPERATION_DETAILS

#define             TP_STRUCT_TYPE_DISPATCH_OPERATION_DETAILS

Details of a channel dispatch operation.

This macro expands to a call to a function that returns the GType of a GValueArray appropriate for representing a D-Bus struct with signature (oa{sv}).

Member 0 (D-Bus type o, named Channel_Dispatch_Operation): The object path of the <tp:dbus-ref namespace="org.freedesktop.Telepathy">ChannelDispatchOperation</tp:dbus-ref>.

Member 1 (D-Bus type a{sv}, type Qualified_Property_Value_Map, named Properties): <tp:docstring xmlns="http://www.w3.org/1999/xhtml"> <p>Properties of the channel dispatch operation.</p> <p>Connection managers MUST NOT include properties in this mapping if their values can change. Clients MUST ignore properties that appear in this mapping if their values can change.</p> <tp:rationale> <p>The rationale is the same as for <tp:type-ref>Channel_Details</tp:type-ref>.</p> </tp:rationale> <p>Each dictionary MUST contain at least the following keys:</p> <ul> <li><tp:dbus-ref>org.freedesktop.Telepathy.ChannelDispatchOperation.Interfaces</tp:dbus-ref></li> <li><tp:dbus-ref>org.freedesktop.Telepathy.ChannelDispatchOperation.Connection</tp:dbus-ref></li> <li><tp:dbus-ref>org.freedesktop.Telepathy.ChannelDispatchOperation.Account</tp:dbus-ref></li> <li><tp:dbus-ref>org.freedesktop.Telepathy.ChannelDispatchOperation.PossibleHandlers</tp:dbus-ref></li> </ul>

TP_ARRAY_TYPE_DISPATCH_OPERATION_DETAILS_LIST

#define             TP_ARRAY_TYPE_DISPATCH_OPERATION_DETAILS_LIST

Expands to a call to a function that returns the GType of a GPtrArray of TP_STRUCT_TYPE_DISPATCH_OPERATION_DETAILS.

TP_STRUCT_TYPE_DEBUG_MESSAGE

#define             TP_STRUCT_TYPE_DEBUG_MESSAGE

A struct representing a debug message, as returned by <tp:member-ref> GetMessages </tp:member-ref> .

This macro expands to a call to a function that returns the GType of a GValueArray appropriate for representing a D-Bus struct with signature (dsus).

Member 0 (D-Bus type d, named Timestamp): Timestamp of the debug message. This is a double to allow more accuracy in the time the message was logged.

Member 1 (D-Bus type s, named Domain): <tp:docstring xmlns="http://www.w3.org/1999/xhtml"> <p>Domain of the debug message. This is used to identify the source of debug messages. For example, debug messages from a connection manager could have this Domain struct member be the name of the connection manager, and logs from any helper library could have the name of the helper library.</p> <p>The domain could also contain a category as to where the log message originated separated by a forward-slash. For example, if a debug message was output in a connection manager called &quot;dummy&quot;, in the file-transfer code, this Domain struct member might be <tt>dummy/file-transfer</tt>.</p>

Member 2 (D-Bus type u, type Debug_Level, named Level): Level of the debug message. This states the severity of the debug message.

Member 3 (D-Bus type s, named Message): The text of the debug message.

TP_ARRAY_TYPE_DEBUG_MESSAGE_LIST

#define             TP_ARRAY_TYPE_DEBUG_MESSAGE_LIST

Expands to a call to a function that returns the GType of a GPtrArray of TP_STRUCT_TYPE_DEBUG_MESSAGE.