![]() |
![]() |
![]() |
telepathy-glib Reference Manual | ![]() |
---|---|---|---|---|
GType factory functionsGType factory functions — Macros using caching factory functions to get dbus-glib specialized GTypes |
#include <telepathy-glib/gtypes.h> GValue* tp_dbus_specialized_value_slice_new (GType type); #define TP_HASH_TYPE_STRING_STRING_MAP #define TP_HASH_TYPE_STRING_VARIANT_MAP #define TP_HASH_TYPE_QUALIFIED_PROPERTY_VALUE_MAP #define TP_STRUCT_TYPE_PARAM_SPEC #define TP_ARRAY_TYPE_PARAM_SPEC_LIST #define TP_STRUCT_TYPE_CHANNEL_INFO #define TP_ARRAY_TYPE_CHANNEL_INFO_LIST #define TP_HASH_TYPE_ALIAS_MAP #define TP_STRUCT_TYPE_ALIAS_PAIR #define TP_ARRAY_TYPE_ALIAS_PAIR_LIST #define TP_HASH_TYPE_AVATAR_TOKEN_MAP #define TP_STRUCT_TYPE_CAPABILITY_CHANGE #define TP_ARRAY_TYPE_CAPABILITY_CHANGE_LIST #define TP_STRUCT_TYPE_CAPABILITY_PAIR #define TP_ARRAY_TYPE_CAPABILITY_PAIR_LIST #define TP_STRUCT_TYPE_CONTACT_CAPABILITY #define TP_ARRAY_TYPE_CONTACT_CAPABILITY_LIST #define TP_HASH_TYPE_CONTACT_ATTRIBUTES_MAP #define TP_HASH_TYPE_SINGLE_CONTACT_ATTRIBUTES_MAP #define TP_ARRAY_TYPE_CHANNEL_DETAILS_LIST #define TP_ARRAY_TYPE_REQUESTABLE_CHANNEL_CLASS_LIST #define TP_HASH_TYPE_CHANNEL_CLASS #define TP_STRUCT_TYPE_CHANNEL_DETAILS #define TP_STRUCT_TYPE_REQUESTABLE_CHANNEL_CLASS #define TP_HASH_TYPE_SIMPLE_CONTACT_PRESENCES #define TP_HASH_TYPE_SIMPLE_STATUS_SPEC_MAP #define TP_STRUCT_TYPE_SIMPLE_PRESENCE #define TP_STRUCT_TYPE_SIMPLE_STATUS_SPEC #define TP_HASH_TYPE_CONTACT_PRESENCES #define TP_HASH_TYPE_MULTIPLE_STATUS_MAP #define TP_HASH_TYPE_STATUS_SPEC_MAP #define TP_STRUCT_TYPE_LAST_ACTIVITY_AND_STATUSES #define TP_STRUCT_TYPE_STATUS_SPEC #define TP_STRUCT_TYPE_LOCAL_PENDING_INFO #define TP_ARRAY_TYPE_LOCAL_PENDING_INFO_LIST #define TP_HASH_TYPE_HANDLE_OWNER_MAP #define TP_STRUCT_TYPE_PENDING_TEXT_MESSAGE #define TP_ARRAY_TYPE_PENDING_TEXT_MESSAGE_LIST #define TP_STRUCT_TYPE_SOCKET_ADDRESS_IPV4 #define TP_STRUCT_TYPE_SOCKET_ADDRESS_IPV6 #define TP_STRUCT_TYPE_SOCKET_NETMASK_IPV4 #define TP_STRUCT_TYPE_SOCKET_NETMASK_IPV6 #define TP_HASH_TYPE_SUPPORTED_SOCKET_MAP #define TP_STRUCT_TYPE_TUBE_INFO #define TP_ARRAY_TYPE_TUBE_INFO_LIST #define TP_STRUCT_TYPE_DBUS_TUBE_MEMBER #define TP_ARRAY_TYPE_DBUS_TUBE_MEMBER_LIST #define TP_STRUCT_TYPE_PROPERTY_SPEC #define TP_ARRAY_TYPE_PROPERTY_SPEC_LIST #define TP_STRUCT_TYPE_PROPERTY_FLAGS_CHANGE #define TP_ARRAY_TYPE_PROPERTY_FLAGS_CHANGE_LIST #define TP_STRUCT_TYPE_PROPERTY_VALUE #define TP_ARRAY_TYPE_PROPERTY_VALUE_LIST #define TP_ARRAY_TYPE_MEDIA_SESSION_HANDLER_INFO_LIST #define TP_STRUCT_TYPE_MEDIA_SESSION_HANDLER_INFO #define TP_ARRAY_TYPE_MEDIA_STREAM_HANDLER_CANDIDATE_LIST #define TP_ARRAY_TYPE_MEDIA_STREAM_HANDLER_CODEC_LIST #define TP_ARRAY_TYPE_MEDIA_STREAM_HANDLER_TRANSPORT_LIST #define TP_STRUCT_TYPE_MEDIA_STREAM_HANDLER_CANDIDATE #define TP_STRUCT_TYPE_MEDIA_STREAM_HANDLER_CODEC #define TP_STRUCT_TYPE_MEDIA_STREAM_HANDLER_TRANSPORT #define TP_STRUCT_TYPE_MEDIA_STREAM_INFO #define TP_ARRAY_TYPE_MEDIA_STREAM_INFO_LIST #define TP_HASH_TYPE_CHANNEL_CALL_STATE_MAP #define TP_ARRAY_TYPE_ROOM_INFO_LIST #define TP_STRUCT_TYPE_ROOM_INFO
dbus-glib's built-in factory functions for specialized GTypes need to do a fair amount of parsing on their arguments, so these macros are provided to avoid that. Each macro expands to a call to a function which caches the GType, so it only ever has to call into dbus-glib once.
tp_dbus_specialized_value_slice_new()
is also provided.
GValue* tp_dbus_specialized_value_slice_new (GType type);
|
A D-Bus specialized type (i.e. probably a specialized GValueArray representing a D-Bus struct) |
Returns : |
a slice-allocated GValue containing an empty value of the given type. |
#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)
#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)
#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.
#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)
#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.
#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
#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.
#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)
#define TP_STRUCT_TYPE_ALIAS_PAIR
A pair (contact handle, alias) as seen in the AliasesChanged 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)
#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.
#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
,
named Token
):
(Undocumented)
#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 CapabilitiesChanged 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)
#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.
#define TP_STRUCT_TYPE_CAPABILITY_PAIR
A pair (channel type, type-specific flags) as passed to AdvertiseCapabilities 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)
#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.
#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 GetCapabilities 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)
#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.
#define TP_HASH_TYPE_CONTACT_ATTRIBUTES_MAP
Mapping returned by GetContactAttributes, 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
#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
#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.
#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.
#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.
#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("Channels") 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("P") 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 "early" 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> and <tp:dbus-ref>org.freedesktop.Telepathy.Channel.TargetID</tp:dbus-ref>. </p> <!-- FIXME: maybe also Requested, InitiatorHandle, InitiatorID once they leave the FUTURE pseudo-interface --> <tp:rationale> <p>We expect these to be crucial to the channel-dispatching process.</p> </tp:rationale>
#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 "encryption" 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>
#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
#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.
#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. "brb", 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. "Back soon!".</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 "Available" from a menu. It is more informative for his English-speaking colleagues to see the English translation of "Available" (as localized by their own clients) than to see "Ar Gael" (which they don't understand anyway). </tp:rationale>
#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>
#define TP_HASH_TYPE_CONTACT_PRESENCES
Mapping returned by GetPresence and signalled by PresenceUpdate, 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)
#define TP_HASH_TYPE_MULTIPLE_STATUS_MAP
Mapping used in Last_Activity_And_Statuses and passed to SetStatus, 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)
#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)
#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)
#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)
#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 AddMembers.
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
#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.
#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
#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 ListPendingMessages on the Text channel type. The arguments of the Received 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)
#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.
#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. "192.168.0.1".
Member 1 (D-Bus type q
,
named Port
):
The TCP or UDP port number.
#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. "2001:DB8::8:800:200C:4171".
Member 1 (D-Bus type q
,
named Port
):
The TCP or UDP port number.
#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. "192.168.0.1".
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.
#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. "2001:DB8::8:800:200C:4171".
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.
#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)
#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)
#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.
#define TP_STRUCT_TYPE_DBUS_TUBE_MEMBER
A struct (handle, unique name) representing a participant in a D-Bus tube, as returned by GetDBusNames on the Tubes channel type, and as seen in the DBusNamesChanged 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
,
type DBus_Unique_Name
,
named Unique_Name
):
(Undocumented)
#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.
#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)
#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.
#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)
#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.
#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)
#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.
#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.
#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
#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.
#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.
#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.
#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)
#define TP_STRUCT_TYPE_MEDIA_STREAM_HANDLER_CODEC
(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 (usuuua{ss})
.
Member 0 (D-Bus type u
,
named Codec_ID
):
(Undocumented)
Member 1 (D-Bus type s
,
named Name
):
(Undocumented)
Member 2 (D-Bus type u
,
type Media_Stream_Type
,
named Media_Type
):
(Undocumented)
Member 3 (D-Bus type u
,
named Clock_Rate
):
(Undocumented)
Member 4 (D-Bus type u
,
named Number_Of_Channels
):
(Undocumented)
Member 5 (D-Bus type a{ss}
,
type String_String_Map
,
named Parameters
):
(Undocumented)
#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)
#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)
#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.
#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.
#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.
#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)