| Top | |
|
|
|
GInterface
├── TpSvcChannelInterfaceRoom1
├── TpSvcChannelInterfaceRoomConfig1
╰── TpSvcChannelInterfaceSubject1
This collection of interfaces is used to expose various aspects of the configuration of chat rooms.
TpSvcChannelInterfaceRoom consists of a pair of requestable,
immutable properties: "RoomName" and
"Server"; and a pair of immutable properties:
"Creator", "CreatorHandle", and
"CreationTimestamp". It has no methods or signals. It
should be implemented on channels representing a chat room (whether it be a text chat, a multi-user call, or some other media type).
TpSvcChannelInterfaceSubject may be implemented by channels which have a
subject (or topic, depending on your protocol's terminology of choice). This
will usually be in addition to TpSvcChannelInterfaceRoom, though in theory
a 1-1 channel could have a subject. In addition to its single method, it
defines a set of read-only properties, namely "Subject",
"Actor", "ActorHandle", "Timestamp",
and "CanSet". Changes should be signalled using
tp_dbus_properties_mixin_emit_properties_changed().
TpSvcChannelInterfaceRoomConfig provides a vast array of properties for other aspects of a chat room's configuration (such as the maximum number of participants, and whether the room is password-protected). Channels with this interface will typically implement the other two, too.
void tp_svc_channel_interface_room_config1_implement_update_configuration (TpSvcChannelInterfaceRoomConfig1Class *klass,tp_svc_channel_interface_room_config1_update_configuration_impl impl);
Register an implementation for the UpdateConfiguration method in the vtable of an implementation of this interface. To be called from the interface init function.
void
tp_svc_channel_interface_room_config1_return_from_update_configuration
(GDBusMethodInvocation *invocation);
Return successfully by calling g_dbus_method_invocation_return_value().
void (*tp_svc_channel_interface_room_config1_update_configuration_impl) (TpSvcChannelInterfaceRoomConfig1 *self,GHashTable *in_Properties,GDBusMethodInvocation *invocation);
The signature of an implementation of the D-Bus method UpdateConfiguration on interface im.telepathy.v1.Channel.Interface.RoomConfig1.
void tp_svc_channel_interface_subject1_implement_set_subject (TpSvcChannelInterfaceSubject1Class *klass,tp_svc_channel_interface_subject1_set_subject_impl impl);
Register an implementation for the SetSubject method in the vtable of an implementation of this interface. To be called from the interface init function.
void
tp_svc_channel_interface_subject1_return_from_set_subject
(GDBusMethodInvocation *invocation);
Return successfully by calling g_dbus_method_invocation_return_value().
void (*tp_svc_channel_interface_subject1_set_subject_impl) (TpSvcChannelInterfaceSubject1 *self,const gchar *in_Subject,GDBusMethodInvocation *invocation);
The signature of an implementation of the D-Bus method SetSubject on interface im.telepathy.v1.Channel.Interface.Subject1.
typedef struct _TpSvcChannelInterfaceRoom1 TpSvcChannelInterfaceRoom1;
Dummy typedef representing any implementation of this interface.
typedef struct _TpSvcChannelInterfaceRoom1Class TpSvcChannelInterfaceRoom1Class;
The class of TpSvcChannelInterfaceRoom1.
This interface has no D-Bus methods, so an
implementation can typically pass NULL to
G_IMPLEMENT_INTERFACE() as the interface
initialization function.
typedef struct _TpSvcChannelInterfaceRoomConfig1 TpSvcChannelInterfaceRoomConfig1;
Dummy typedef representing any implementation of this interface.
typedef struct _TpSvcChannelInterfaceRoomConfig1Class TpSvcChannelInterfaceRoomConfig1Class;
The class of TpSvcChannelInterfaceRoomConfig1.
In a full implementation of this interface (i.e. all
methods implemented), the interface initialization
function used in G_IMPLEMENT_INTERFACE() would
typically look like this:
static void
implement_channel_interface_room_config1 (gpointer klass,
gpointer unused G_GNUC_UNUSED)
{
#define IMPLEMENT(x) tp_svc_channel_interface_room_config1_implement_##x (\
klass, my_object_##x)
IMPLEMENT (update_configuration);
#undef IMPLEMENT
}
typedef struct _TpSvcChannelInterfaceSubject1 TpSvcChannelInterfaceSubject1;
Dummy typedef representing any implementation of this interface.
typedef struct _TpSvcChannelInterfaceSubject1Class TpSvcChannelInterfaceSubject1Class;
The class of TpSvcChannelInterfaceSubject1.
In a full implementation of this interface (i.e. all
methods implemented), the interface initialization
function used in G_IMPLEMENT_INTERFACE() would
typically look like this:
static void
implement_channel_interface_subject1 (gpointer klass,
gpointer unused G_GNUC_UNUSED)
{
#define IMPLEMENT(x) tp_svc_channel_interface_subject1_implement_##x (\
klass, my_object_##x)
IMPLEMENT (set_subject);
#undef IMPLEMENT
}