Text channels

Text channels — service-side interfaces for the Text channel type, and the Chat State and Password interfaces

Synopsis


#include <telepathy-glib/svc-channel-text.h>

                    TpSvcChannelTypeText;
                    TpSvcChannelTypeTextClass;
void                (*tp_svc_channel_type_text_acknowledge_pending_messages_impl)
                                                        (TpSvcChannelTypeText *self,
                                                         const GArray *in_ids,
                                                         DBusGMethodInvocation *context);
void                tp_svc_channel_type_text_implement_acknowledge_pending_messages
                                                        (TpSvcChannelTypeTextClass *klass,
                                                         tp_svc_channel_type_text_acknowledge_pending_messages_impl impl);
void                tp_svc_channel_type_text_return_from_acknowledge_pending_messages
                                                        (DBusGMethodInvocation *context);
void                (*tp_svc_channel_type_text_get_message_types_impl)
                                                        (TpSvcChannelTypeText *self,
                                                         DBusGMethodInvocation *context);
void                tp_svc_channel_type_text_implement_get_message_types
                                                        (TpSvcChannelTypeTextClass *klass,
                                                         tp_svc_channel_type_text_get_message_types_impl impl);
void                tp_svc_channel_type_text_return_from_get_message_types
                                                        (DBusGMethodInvocation *context,
                                                         const GArray *out0);
void                (*tp_svc_channel_type_text_list_pending_messages_impl)
                                                        (TpSvcChannelTypeText *self,
                                                         gboolean in_clear,
                                                         DBusGMethodInvocation *context);
void                tp_svc_channel_type_text_implement_list_pending_messages
                                                        (TpSvcChannelTypeTextClass *klass,
                                                         tp_svc_channel_type_text_list_pending_messages_impl impl);
void                tp_svc_channel_type_text_return_from_list_pending_messages
                                                        (DBusGMethodInvocation *context,
                                                         const GPtrArray *out0);
void                (*tp_svc_channel_type_text_send_impl)
                                                        (TpSvcChannelTypeText *self,
                                                         guint in_type,
                                                         const gchar *in_text,
                                                         DBusGMethodInvocation *context);
void                tp_svc_channel_type_text_implement_send
                                                        (TpSvcChannelTypeTextClass *klass,
                                                         tp_svc_channel_type_text_send_impl impl);
void                tp_svc_channel_type_text_return_from_send
                                                        (DBusGMethodInvocation *context);
void                tp_svc_channel_type_text_emit_lost_message
                                                        (gpointer instance);
void                tp_svc_channel_type_text_emit_received
                                                        (gpointer instance,
                                                         guint arg_id,
                                                         guint arg_timestamp,
                                                         guint arg_sender,
                                                         guint arg_type,
                                                         guint arg_flags,
                                                         const gchar *arg_text);
void                tp_svc_channel_type_text_emit_send_error
                                                        (gpointer instance,
                                                         guint arg_error,
                                                         guint arg_timestamp,
                                                         guint arg_type,
                                                         const gchar *arg_text);
void                tp_svc_channel_type_text_emit_sent  (gpointer instance,
                                                         guint arg_timestamp,
                                                         guint arg_type,
                                                         const gchar *arg_text);


                    TpSvcChannelInterfaceChatState;
                    TpSvcChannelInterfaceChatStateClass;
void                (*tp_svc_channel_interface_chat_state_set_chat_state_impl)
                                                        (TpSvcChannelInterfaceChatState *self,
                                                         guint in_state,
                                                         DBusGMethodInvocation *context);
void                tp_svc_channel_interface_chat_state_implement_set_chat_state
                                                        (TpSvcChannelInterfaceChatStateClass *klass,
                                                         tp_svc_channel_interface_chat_state_set_chat_state_impl impl);
void                tp_svc_channel_interface_chat_state_return_from_set_chat_state
                                                        (DBusGMethodInvocation *context);
void                tp_svc_channel_interface_chat_state_emit_chat_state_changed
                                                        (gpointer instance,
                                                         guint arg_contact,
                                                         guint arg_state);


                    TpSvcChannelInterfacePassword;
                    TpSvcChannelInterfacePasswordClass;
void                (*tp_svc_channel_interface_password_get_password_flags_impl)
                                                        (TpSvcChannelInterfacePassword *self,
                                                         DBusGMethodInvocation *context);
void                tp_svc_channel_interface_password_implement_get_password_flags
                                                        (TpSvcChannelInterfacePasswordClass *klass,
                                                         tp_svc_channel_interface_password_get_password_flags_impl impl);
void                tp_svc_channel_interface_password_return_from_get_password_flags
                                                        (DBusGMethodInvocation *context,
                                                         guint out0);
void                (*tp_svc_channel_interface_password_provide_password_impl)
                                                        (TpSvcChannelInterfacePassword *self,
                                                         const gchar *in_password,
                                                         DBusGMethodInvocation *context);
void                tp_svc_channel_interface_password_implement_provide_password
                                                        (TpSvcChannelInterfacePasswordClass *klass,
                                                         tp_svc_channel_interface_password_provide_password_impl impl);
void                tp_svc_channel_interface_password_return_from_provide_password
                                                        (DBusGMethodInvocation *context,
                                                         gboolean out0);
void                tp_svc_channel_interface_password_emit_password_flags_changed
                                                        (gpointer instance,
                                                         guint arg_added,
                                                         guint arg_removed);

Description

A major use for instant messaging is obviously to send messages. Channels of type Text represent IM conversations or chat rooms.

This section documents the auto-generated GInterfaces used to implement the Text channel type, and some interfaces used in conjunction with it.

Details

TpSvcChannelTypeText

typedef struct _TpSvcChannelTypeText TpSvcChannelTypeText;

Dummy typedef representing any implementation of this interface.


TpSvcChannelTypeTextClass

typedef struct _TpSvcChannelTypeTextClass TpSvcChannelTypeTextClass;

The class of TpSvcChannelTypeText.


tp_svc_channel_type_text_acknowledge_pending_messages_impl ()

void                (*tp_svc_channel_type_text_acknowledge_pending_messages_impl)
                                                        (TpSvcChannelTypeText *self,
                                                         const GArray *in_ids,
                                                         DBusGMethodInvocation *context);

The signature of an implementation of the D-Bus method AcknowledgePendingMessages on interface org.freedesktop.Telepathy.Channel.Type.Text.

self :

The object implementing this interface

in_ids :

const GArray * (FIXME, generate documentation)

context :

Used to return values or throw an error

tp_svc_channel_type_text_implement_acknowledge_pending_messages ()

void                tp_svc_channel_type_text_implement_acknowledge_pending_messages
                                                        (TpSvcChannelTypeTextClass *klass,
                                                         tp_svc_channel_type_text_acknowledge_pending_messages_impl impl);

Register an implementation for the AcknowledgePendingMessages method in the vtable of an implementation of this interface. To be called from the interface init function.

klass :

A class whose instances implement this interface

impl :

A callback used to implement the AcknowledgePendingMessages D-Bus method

tp_svc_channel_type_text_return_from_acknowledge_pending_messages ()

void                tp_svc_channel_type_text_return_from_acknowledge_pending_messages
                                                        (DBusGMethodInvocation *context);

Return successfully by calling dbus_g_method_return(). This inline function exists only to provide type-safety.

context :

The D-Bus method invocation context

tp_svc_channel_type_text_get_message_types_impl ()

void                (*tp_svc_channel_type_text_get_message_types_impl)
                                                        (TpSvcChannelTypeText *self,
                                                         DBusGMethodInvocation *context);

The signature of an implementation of the D-Bus method GetMessageTypes on interface org.freedesktop.Telepathy.Channel.Type.Text.

self :

The object implementing this interface

context :

Used to return values or throw an error

tp_svc_channel_type_text_implement_get_message_types ()

void                tp_svc_channel_type_text_implement_get_message_types
                                                        (TpSvcChannelTypeTextClass *klass,
                                                         tp_svc_channel_type_text_get_message_types_impl impl);

Register an implementation for the GetMessageTypes method in the vtable of an implementation of this interface. To be called from the interface init function.

klass :

A class whose instances implement this interface

impl :

A callback used to implement the GetMessageTypes D-Bus method

tp_svc_channel_type_text_return_from_get_message_types ()

void                tp_svc_channel_type_text_return_from_get_message_types
                                                        (DBusGMethodInvocation *context,
                                                         const GArray *out0);

Return successfully by calling dbus_g_method_return(). This inline function exists only to provide type-safety.

context :

The D-Bus method invocation context

out0 :

const GArray * (FIXME, generate documentation)

tp_svc_channel_type_text_list_pending_messages_impl ()

void                (*tp_svc_channel_type_text_list_pending_messages_impl)
                                                        (TpSvcChannelTypeText *self,
                                                         gboolean in_clear,
                                                         DBusGMethodInvocation *context);

The signature of an implementation of the D-Bus method ListPendingMessages on interface org.freedesktop.Telepathy.Channel.Type.Text.

self :

The object implementing this interface

in_clear :

gboolean (FIXME, generate documentation)

context :

Used to return values or throw an error

tp_svc_channel_type_text_implement_list_pending_messages ()

void                tp_svc_channel_type_text_implement_list_pending_messages
                                                        (TpSvcChannelTypeTextClass *klass,
                                                         tp_svc_channel_type_text_list_pending_messages_impl impl);

Register an implementation for the ListPendingMessages method in the vtable of an implementation of this interface. To be called from the interface init function.

klass :

A class whose instances implement this interface

impl :

A callback used to implement the ListPendingMessages D-Bus method

tp_svc_channel_type_text_return_from_list_pending_messages ()

void                tp_svc_channel_type_text_return_from_list_pending_messages
                                                        (DBusGMethodInvocation *context,
                                                         const GPtrArray *out0);

Return successfully by calling dbus_g_method_return(). This inline function exists only to provide type-safety.

context :

The D-Bus method invocation context

out0 :

const GPtrArray * (FIXME, generate documentation)

tp_svc_channel_type_text_send_impl ()

void                (*tp_svc_channel_type_text_send_impl)
                                                        (TpSvcChannelTypeText *self,
                                                         guint in_type,
                                                         const gchar *in_text,
                                                         DBusGMethodInvocation *context);

The signature of an implementation of the D-Bus method Send on interface org.freedesktop.Telepathy.Channel.Type.Text.

self :

The object implementing this interface

in_type :

guint (FIXME, generate documentation)

in_text :

const gchar * (FIXME, generate documentation)

context :

Used to return values or throw an error

tp_svc_channel_type_text_implement_send ()

void                tp_svc_channel_type_text_implement_send
                                                        (TpSvcChannelTypeTextClass *klass,
                                                         tp_svc_channel_type_text_send_impl impl);

Register an implementation for the Send method in the vtable of an implementation of this interface. To be called from the interface init function.

klass :

A class whose instances implement this interface

impl :

A callback used to implement the Send D-Bus method

tp_svc_channel_type_text_return_from_send ()

void                tp_svc_channel_type_text_return_from_send
                                                        (DBusGMethodInvocation *context);

Return successfully by calling dbus_g_method_return(). This inline function exists only to provide type-safety.

context :

The D-Bus method invocation context

tp_svc_channel_type_text_emit_lost_message ()

void                tp_svc_channel_type_text_emit_lost_message
                                                        (gpointer instance);

Type-safe wrapper around g_signal_emit to emit the LostMessage signal on interface org.freedesktop.Telepathy.Channel.Type.Text.

instance :

The object implementing this interface

tp_svc_channel_type_text_emit_received ()

void                tp_svc_channel_type_text_emit_received
                                                        (gpointer instance,
                                                         guint arg_id,
                                                         guint arg_timestamp,
                                                         guint arg_sender,
                                                         guint arg_type,
                                                         guint arg_flags,
                                                         const gchar *arg_text);

Type-safe wrapper around g_signal_emit to emit the Received signal on interface org.freedesktop.Telepathy.Channel.Type.Text.

instance :

The object implementing this interface

arg_id :

guint (FIXME, generate documentation)

arg_timestamp :

guint (FIXME, generate documentation)

arg_sender :

guint (FIXME, generate documentation)

arg_type :

guint (FIXME, generate documentation)

arg_flags :

guint (FIXME, generate documentation)

arg_text :

const gchar * (FIXME, generate documentation)

tp_svc_channel_type_text_emit_send_error ()

void                tp_svc_channel_type_text_emit_send_error
                                                        (gpointer instance,
                                                         guint arg_error,
                                                         guint arg_timestamp,
                                                         guint arg_type,
                                                         const gchar *arg_text);

Type-safe wrapper around g_signal_emit to emit the SendError signal on interface org.freedesktop.Telepathy.Channel.Type.Text.

instance :

The object implementing this interface

arg_error :

guint (FIXME, generate documentation)

arg_timestamp :

guint (FIXME, generate documentation)

arg_type :

guint (FIXME, generate documentation)

arg_text :

const gchar * (FIXME, generate documentation)

tp_svc_channel_type_text_emit_sent ()

void                tp_svc_channel_type_text_emit_sent  (gpointer instance,
                                                         guint arg_timestamp,
                                                         guint arg_type,
                                                         const gchar *arg_text);

Type-safe wrapper around g_signal_emit to emit the Sent signal on interface org.freedesktop.Telepathy.Channel.Type.Text.

instance :

The object implementing this interface

arg_timestamp :

guint (FIXME, generate documentation)

arg_type :

guint (FIXME, generate documentation)

arg_text :

const gchar * (FIXME, generate documentation)

TpSvcChannelInterfaceChatState

typedef struct _TpSvcChannelInterfaceChatState TpSvcChannelInterfaceChatState;

Dummy typedef representing any implementation of this interface.


TpSvcChannelInterfaceChatStateClass

typedef struct _TpSvcChannelInterfaceChatStateClass TpSvcChannelInterfaceChatStateClass;

The class of TpSvcChannelInterfaceChatState.


tp_svc_channel_interface_chat_state_set_chat_state_impl ()

void                (*tp_svc_channel_interface_chat_state_set_chat_state_impl)
                                                        (TpSvcChannelInterfaceChatState *self,
                                                         guint in_state,
                                                         DBusGMethodInvocation *context);

The signature of an implementation of the D-Bus method SetChatState on interface org.freedesktop.Telepathy.Channel.Interface.ChatState.

self :

The object implementing this interface

in_state :

guint (FIXME, generate documentation)

context :

Used to return values or throw an error

tp_svc_channel_interface_chat_state_implement_set_chat_state ()

void                tp_svc_channel_interface_chat_state_implement_set_chat_state
                                                        (TpSvcChannelInterfaceChatStateClass *klass,
                                                         tp_svc_channel_interface_chat_state_set_chat_state_impl impl);

Register an implementation for the SetChatState method in the vtable of an implementation of this interface. To be called from the interface init function.

klass :

A class whose instances implement this interface

impl :

A callback used to implement the SetChatState D-Bus method

tp_svc_channel_interface_chat_state_return_from_set_chat_state ()

void                tp_svc_channel_interface_chat_state_return_from_set_chat_state
                                                        (DBusGMethodInvocation *context);

Return successfully by calling dbus_g_method_return(). This inline function exists only to provide type-safety.

context :

The D-Bus method invocation context

tp_svc_channel_interface_chat_state_emit_chat_state_changed ()

void                tp_svc_channel_interface_chat_state_emit_chat_state_changed
                                                        (gpointer instance,
                                                         guint arg_contact,
                                                         guint arg_state);

Type-safe wrapper around g_signal_emit to emit the ChatStateChanged signal on interface org.freedesktop.Telepathy.Channel.Interface.ChatState.

instance :

The object implementing this interface

arg_contact :

guint (FIXME, generate documentation)

arg_state :

guint (FIXME, generate documentation)

TpSvcChannelInterfacePassword

typedef struct _TpSvcChannelInterfacePassword TpSvcChannelInterfacePassword;

Dummy typedef representing any implementation of this interface.


TpSvcChannelInterfacePasswordClass

typedef struct _TpSvcChannelInterfacePasswordClass TpSvcChannelInterfacePasswordClass;

The class of TpSvcChannelInterfacePassword.


tp_svc_channel_interface_password_get_password_flags_impl ()

void                (*tp_svc_channel_interface_password_get_password_flags_impl)
                                                        (TpSvcChannelInterfacePassword *self,
                                                         DBusGMethodInvocation *context);

The signature of an implementation of the D-Bus method GetPasswordFlags on interface org.freedesktop.Telepathy.Channel.Interface.Password.

self :

The object implementing this interface

context :

Used to return values or throw an error

tp_svc_channel_interface_password_implement_get_password_flags ()

void                tp_svc_channel_interface_password_implement_get_password_flags
                                                        (TpSvcChannelInterfacePasswordClass *klass,
                                                         tp_svc_channel_interface_password_get_password_flags_impl impl);

Register an implementation for the GetPasswordFlags method in the vtable of an implementation of this interface. To be called from the interface init function.

klass :

A class whose instances implement this interface

impl :

A callback used to implement the GetPasswordFlags D-Bus method

tp_svc_channel_interface_password_return_from_get_password_flags ()

void                tp_svc_channel_interface_password_return_from_get_password_flags
                                                        (DBusGMethodInvocation *context,
                                                         guint out0);

Return successfully by calling dbus_g_method_return(). This inline function exists only to provide type-safety.

context :

The D-Bus method invocation context

out0 :

guint (FIXME, generate documentation)

tp_svc_channel_interface_password_provide_password_impl ()

void                (*tp_svc_channel_interface_password_provide_password_impl)
                                                        (TpSvcChannelInterfacePassword *self,
                                                         const gchar *in_password,
                                                         DBusGMethodInvocation *context);

The signature of an implementation of the D-Bus method ProvidePassword on interface org.freedesktop.Telepathy.Channel.Interface.Password.

self :

The object implementing this interface

in_password :

const gchar * (FIXME, generate documentation)

context :

Used to return values or throw an error

tp_svc_channel_interface_password_implement_provide_password ()

void                tp_svc_channel_interface_password_implement_provide_password
                                                        (TpSvcChannelInterfacePasswordClass *klass,
                                                         tp_svc_channel_interface_password_provide_password_impl impl);

Register an implementation for the ProvidePassword method in the vtable of an implementation of this interface. To be called from the interface init function.

klass :

A class whose instances implement this interface

impl :

A callback used to implement the ProvidePassword D-Bus method

tp_svc_channel_interface_password_return_from_provide_password ()

void                tp_svc_channel_interface_password_return_from_provide_password
                                                        (DBusGMethodInvocation *context,
                                                         gboolean out0);

Return successfully by calling dbus_g_method_return(). This inline function exists only to provide type-safety.

context :

The D-Bus method invocation context

out0 :

gboolean (FIXME, generate documentation)

tp_svc_channel_interface_password_emit_password_flags_changed ()

void                tp_svc_channel_interface_password_emit_password_flags_changed
                                                        (gpointer instance,
                                                         guint arg_added,
                                                         guint arg_removed);

Type-safe wrapper around g_signal_emit to emit the PasswordFlagsChanged signal on interface org.freedesktop.Telepathy.Channel.Interface.Password.

instance :

The object implementing this interface

arg_added :

guint (FIXME, generate documentation)

arg_removed :

guint (FIXME, generate documentation)

See Also

TpTextMixin