Text channels

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

Functions

void (*tp_svc_channel_type_text_acknowledge_pending_messages_impl) ()
void tp_svc_channel_type_text_emit_message_received ()
void tp_svc_channel_type_text_emit_message_sent ()
void tp_svc_channel_type_text_emit_pending_messages_removed ()
void tp_svc_channel_type_text_implement_acknowledge_pending_messages ()
void tp_svc_channel_type_text_implement_send_message ()
void tp_svc_channel_type_text_return_from_acknowledge_pending_messages ()
void tp_svc_channel_type_text_return_from_send_message ()
void (*tp_svc_channel_type_text_send_message_impl) ()
void (*tp_svc_channel_interface_chat_state1_set_chat_state_impl) ()
void tp_svc_channel_interface_chat_state1_implement_set_chat_state ()
void tp_svc_channel_interface_chat_state1_return_from_set_chat_state ()
void tp_svc_channel_interface_chat_state1_emit_chat_state_changed ()
void (*tp_svc_channel_interface_password1_get_password_flags_impl) ()
void tp_svc_channel_interface_password1_implement_get_password_flags ()
void tp_svc_channel_interface_password1_return_from_get_password_flags ()
void (*tp_svc_channel_interface_password1_provide_password_impl) ()
void tp_svc_channel_interface_password1_implement_provide_password ()
void tp_svc_channel_interface_password1_return_from_provide_password ()
void tp_svc_channel_interface_password1_emit_password_flags_changed ()
void tp_svc_channel_interface_sms1_emit_sms_channel_changed ()
void (*tp_svc_channel_interface_sms1_get_sms_length_impl) ()
void tp_svc_channel_interface_sms1_implement_get_sms_length ()
void tp_svc_channel_interface_sms1_return_from_get_sms_length ()

Signals

void message-received Has Details
void message-sent Has Details
void pending-messages-removed Has Details
void chat-state-changed Has Details
void password-flags-changed Has Details
void s-ms-channel-changed Has Details

Types and Values

  TpSvcChannelTypeText
  TpSvcChannelTypeTextClass
  TpSvcChannelInterfaceChatState1
  TpSvcChannelInterfaceChatState1Class
  TpSvcChannelInterfacePassword1
  TpSvcChannelInterfacePassword1Class
  TpSvcChannelInterfaceSMS1
  TpSvcChannelInterfaceSMS1Class

Object Hierarchy

    GInterface
    ├── TpSvcChannelInterfaceChatState1
    ├── TpSvcChannelInterfacePassword1
    ├── TpSvcChannelInterfaceSMS1
    ╰── TpSvcChannelTypeText

Includes

#include <telepathy-glib/telepathy-glib-dbus.h>

Description

A major use for instant messaging is obviously to send messages. Channels of type Text represent conversations or chat rooms using short real-time messages, including SMS.

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

Functions

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,
                                GDBusMethodInvocation *invocation);

The signature of an implementation of the D-Bus method AcknowledgePendingMessages on interface im.telepathy.v1.Channel.Type.Text.

Parameters

self

The object implementing this interface

  

in_IDs

const GArray * (FIXME, generate documentation)

  

invocation

Used to return values or throw an error

  

tp_svc_channel_type_text_emit_message_received ()

void
tp_svc_channel_type_text_emit_message_received
                               (gpointer instance,
                                const GPtrArray *arg_Message);

Type-safe wrapper around g_signal_emit to emit the MessageReceived signal on interface im.telepathy.v1.Channel.Type.Text.

Parameters

instance

The object implementing this interface

  

arg_Message

const GPtrArray * (FIXME, generate documentation)

  

tp_svc_channel_type_text_emit_message_sent ()

void
tp_svc_channel_type_text_emit_message_sent
                               (gpointer instance,
                                const GPtrArray *arg_Content,
                                guint arg_Flags,
                                const gchar *arg_Message_Token);

Type-safe wrapper around g_signal_emit to emit the MessageSent signal on interface im.telepathy.v1.Channel.Type.Text.

Parameters

instance

The object implementing this interface

  

arg_Content

const GPtrArray * (FIXME, generate documentation)

  

arg_Flags

guint (FIXME, generate documentation)

  

arg_Message_Token

const gchar * (FIXME, generate documentation)

  

tp_svc_channel_type_text_emit_pending_messages_removed ()

void
tp_svc_channel_type_text_emit_pending_messages_removed
                               (gpointer instance,
                                const GArray *arg_Message_IDs);

Type-safe wrapper around g_signal_emit to emit the PendingMessagesRemoved signal on interface im.telepathy.v1.Channel.Type.Text.

Parameters

instance

The object implementing this interface

  

arg_Message_IDs

const GArray * (FIXME, generate documentation)

  

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.

Parameters

klass

A class whose instances implement this interface

  

impl

A callback used to implement the AcknowledgePendingMessages D-Bus method

  

tp_svc_channel_type_text_implement_send_message ()

void
tp_svc_channel_type_text_implement_send_message
                               (TpSvcChannelTypeTextClass *klass,
                                tp_svc_channel_type_text_send_message_impl impl);

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

Parameters

klass

A class whose instances implement this interface

  

impl

A callback used to implement the SendMessage D-Bus method

  

tp_svc_channel_type_text_return_from_acknowledge_pending_messages ()

void
tp_svc_channel_type_text_return_from_acknowledge_pending_messages
                               (GDBusMethodInvocation *invocation);

Return successfully by calling g_dbus_method_invocation_return_value().

Parameters

invocation

The D-Bus method invocation context

  

tp_svc_channel_type_text_return_from_send_message ()

void
tp_svc_channel_type_text_return_from_send_message
                               (GDBusMethodInvocation *invocation,
                                const gchar *out_Token);

Return successfully by calling g_dbus_method_invocation_return_value().

Parameters

invocation

The D-Bus method invocation context

  

out_Token

const gchar * (FIXME, generate documentation)

  

tp_svc_channel_type_text_send_message_impl ()

void
(*tp_svc_channel_type_text_send_message_impl)
                               (TpSvcChannelTypeText *self,
                                const GPtrArray *in_Message,
                                guint in_Flags,
                                GDBusMethodInvocation *invocation);

The signature of an implementation of the D-Bus method SendMessage on interface im.telepathy.v1.Channel.Type.Text.

Parameters

self

The object implementing this interface

  

in_Message

const GPtrArray * (FIXME, generate documentation)

  

in_Flags

guint (FIXME, generate documentation)

  

invocation

Used to return values or throw an error

  

tp_svc_channel_interface_chat_state1_set_chat_state_impl ()

void
(*tp_svc_channel_interface_chat_state1_set_chat_state_impl)
                               (TpSvcChannelInterfaceChatState1 *self,
                                guint in_State,
                                GDBusMethodInvocation *invocation);

The signature of an implementation of the D-Bus method SetChatState on interface im.telepathy.v1.Channel.Interface.ChatState1.

Parameters

self

The object implementing this interface

  

in_State

guint (FIXME, generate documentation)

  

invocation

Used to return values or throw an error

  

tp_svc_channel_interface_chat_state1_implement_set_chat_state ()

void
tp_svc_channel_interface_chat_state1_implement_set_chat_state
                               (TpSvcChannelInterfaceChatState1Class *klass,
                                tp_svc_channel_interface_chat_state1_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.

Parameters

klass

A class whose instances implement this interface

  

impl

A callback used to implement the SetChatState D-Bus method

  

tp_svc_channel_interface_chat_state1_return_from_set_chat_state ()

void
tp_svc_channel_interface_chat_state1_return_from_set_chat_state
                               (GDBusMethodInvocation *invocation);

Return successfully by calling g_dbus_method_invocation_return_value().

Parameters

invocation

The D-Bus method invocation context

  

tp_svc_channel_interface_chat_state1_emit_chat_state_changed ()

void
tp_svc_channel_interface_chat_state1_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 im.telepathy.v1.Channel.Interface.ChatState1.

Parameters

instance

The object implementing this interface

  

arg_Contact

guint (FIXME, generate documentation)

  

arg_State

guint (FIXME, generate documentation)

  

tp_svc_channel_interface_password1_get_password_flags_impl ()

void
(*tp_svc_channel_interface_password1_get_password_flags_impl)
                               (TpSvcChannelInterfacePassword1 *self,
                                GDBusMethodInvocation *invocation);

The signature of an implementation of the D-Bus method GetPasswordFlags on interface im.telepathy.v1.Channel.Interface.Password1.

Parameters

self

The object implementing this interface

  

invocation

Used to return values or throw an error

  

tp_svc_channel_interface_password1_implement_get_password_flags ()

void
tp_svc_channel_interface_password1_implement_get_password_flags
                               (TpSvcChannelInterfacePassword1Class *klass,
                                tp_svc_channel_interface_password1_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.

Parameters

klass

A class whose instances implement this interface

  

impl

A callback used to implement the GetPasswordFlags D-Bus method

  

tp_svc_channel_interface_password1_return_from_get_password_flags ()

void
tp_svc_channel_interface_password1_return_from_get_password_flags
                               (GDBusMethodInvocation *invocation,
                                guint out_Password_Flags);

Return successfully by calling g_dbus_method_invocation_return_value().

Parameters

invocation

The D-Bus method invocation context

  

out_Password_Flags

guint (FIXME, generate documentation)

  

tp_svc_channel_interface_password1_provide_password_impl ()

void
(*tp_svc_channel_interface_password1_provide_password_impl)
                               (TpSvcChannelInterfacePassword1 *self,
                                const gchar *in_Password,
                                GDBusMethodInvocation *invocation);

The signature of an implementation of the D-Bus method ProvidePassword on interface im.telepathy.v1.Channel.Interface.Password1.

Parameters

self

The object implementing this interface

  

in_Password

const gchar * (FIXME, generate documentation)

  

invocation

Used to return values or throw an error

  

tp_svc_channel_interface_password1_implement_provide_password ()

void
tp_svc_channel_interface_password1_implement_provide_password
                               (TpSvcChannelInterfacePassword1Class *klass,
                                tp_svc_channel_interface_password1_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.

Parameters

klass

A class whose instances implement this interface

  

impl

A callback used to implement the ProvidePassword D-Bus method

  

tp_svc_channel_interface_password1_return_from_provide_password ()

void
tp_svc_channel_interface_password1_return_from_provide_password
                               (GDBusMethodInvocation *invocation,
                                gboolean out_Correct);

Return successfully by calling g_dbus_method_invocation_return_value().

Parameters

invocation

The D-Bus method invocation context

  

out_Correct

gboolean (FIXME, generate documentation)

  

tp_svc_channel_interface_password1_emit_password_flags_changed ()

void
tp_svc_channel_interface_password1_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 im.telepathy.v1.Channel.Interface.Password1.

Parameters

instance

The object implementing this interface

  

arg_Added

guint (FIXME, generate documentation)

  

arg_Removed

guint (FIXME, generate documentation)

  

tp_svc_channel_interface_sms1_emit_sms_channel_changed ()

void
tp_svc_channel_interface_sms1_emit_sms_channel_changed
                               (gpointer instance,
                                gboolean arg_SMSChannel);

Type-safe wrapper around g_signal_emit to emit the SMSChannelChanged signal on interface im.telepathy.v1.Channel.Interface.SMS1.

Parameters

instance

The object implementing this interface

  

arg_SMSChannel

gboolean (FIXME, generate documentation)

  

tp_svc_channel_interface_sms1_get_sms_length_impl ()

void
(*tp_svc_channel_interface_sms1_get_sms_length_impl)
                               (TpSvcChannelInterfaceSMS1 *self,
                                const GPtrArray *in_Message,
                                GDBusMethodInvocation *invocation);

The signature of an implementation of the D-Bus method GetSMSLength on interface im.telepathy.v1.Channel.Interface.SMS1.

Parameters

self

The object implementing this interface

  

in_Message

const GPtrArray * (FIXME, generate documentation)

  

invocation

Used to return values or throw an error

  

tp_svc_channel_interface_sms1_implement_get_sms_length ()

void
tp_svc_channel_interface_sms1_implement_get_sms_length
                               (TpSvcChannelInterfaceSMS1Class *klass,
                                tp_svc_channel_interface_sms1_get_sms_length_impl impl);

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

Parameters

klass

A class whose instances implement this interface

  

impl

A callback used to implement the GetSMSLength D-Bus method

  

tp_svc_channel_interface_sms1_return_from_get_sms_length ()

void
tp_svc_channel_interface_sms1_return_from_get_sms_length
                               (GDBusMethodInvocation *invocation,
                                guint out_Chunks_Required,
                                gint out_Remaining_Characters,
                                gint out_Estimated_Cost);

Return successfully by calling g_dbus_method_invocation_return_value().

Parameters

invocation

The D-Bus method invocation context

  

out_Chunks_Required

guint (FIXME, generate documentation)

  

out_Remaining_Characters

gint (FIXME, generate documentation)

  

out_Estimated_Cost

gint (FIXME, generate documentation)

  

Types and Values

TpSvcChannelTypeText

typedef struct _TpSvcChannelTypeText TpSvcChannelTypeText;

Dummy typedef representing any implementation of this interface.

TpSvcChannelTypeTextClass

typedef struct _TpSvcChannelTypeTextClass TpSvcChannelTypeTextClass;

The class of TpSvcChannelTypeText.

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_type_text (gpointer klass,
    gpointer unused G_GNUC_UNUSED)
{
#define IMPLEMENT(x) tp_svc_channel_type_text_implement_##x (\
  klass, my_object_##x)
  IMPLEMENT (acknowledge_pending_messages);
  IMPLEMENT (send_message);
#undef IMPLEMENT
}

TpSvcChannelInterfaceChatState1

typedef struct _TpSvcChannelInterfaceChatState1 TpSvcChannelInterfaceChatState1;

Dummy typedef representing any implementation of this interface.

TpSvcChannelInterfaceChatState1Class

typedef struct _TpSvcChannelInterfaceChatState1Class TpSvcChannelInterfaceChatState1Class;

The class of TpSvcChannelInterfaceChatState1.

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_chat_state1 (gpointer klass,
    gpointer unused G_GNUC_UNUSED)
{
#define IMPLEMENT(x) tp_svc_channel_interface_chat_state1_implement_##x (\
  klass, my_object_##x)
  IMPLEMENT (set_chat_state);
#undef IMPLEMENT
}

TpSvcChannelInterfacePassword1

typedef struct _TpSvcChannelInterfacePassword1 TpSvcChannelInterfacePassword1;

Dummy typedef representing any implementation of this interface.

TpSvcChannelInterfacePassword1Class

typedef struct _TpSvcChannelInterfacePassword1Class TpSvcChannelInterfacePassword1Class;

The class of TpSvcChannelInterfacePassword1.

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_password1 (gpointer klass,
    gpointer unused G_GNUC_UNUSED)
{
#define IMPLEMENT(x) tp_svc_channel_interface_password1_implement_##x (\
  klass, my_object_##x)
  IMPLEMENT (get_password_flags);
  IMPLEMENT (provide_password);
#undef IMPLEMENT
}

TpSvcChannelInterfaceSMS1

typedef struct _TpSvcChannelInterfaceSMS1 TpSvcChannelInterfaceSMS1;

Dummy typedef representing any implementation of this interface.

TpSvcChannelInterfaceSMS1Class

typedef struct _TpSvcChannelInterfaceSMS1Class TpSvcChannelInterfaceSMS1Class;

The class of TpSvcChannelInterfaceSMS1.

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_sms1 (gpointer klass,
    gpointer unused G_GNUC_UNUSED)
{
#define IMPLEMENT(x) tp_svc_channel_interface_sms1_implement_##x (\
  klass, my_object_##x)
  IMPLEMENT (get_sms_length);
#undef IMPLEMENT
}

Signal Details

The “message-received” signal

void
user_function (TpSvcChannelTypeText *self,
               gpointer              user_data)

The MessageReceived D-Bus signal is emitted whenever this GObject signal is.

Parameters

self

an object

  

arg_Message

const GPtrArray * (FIXME, generate documentation)

  

user_data

user data set when the signal handler was connected.

  

Flags: Has Details

The “message-sent” signal

void
user_function (TpSvcChannelTypeText *self,
               guint                 arg_Flags,
               gchar                *arg_Message_Token,
               gpointer              user_data)

The MessageSent D-Bus signal is emitted whenever this GObject signal is.

Parameters

self

an object

  

arg_Content

const GPtrArray * (FIXME, generate documentation)

  

arg_Flags

guint (FIXME, generate documentation)

  

arg_Message_Token

const gchar * (FIXME, generate documentation)

  

user_data

user data set when the signal handler was connected.

  

Flags: Has Details

The “pending-messages-removed” signal

void
user_function (TpSvcChannelTypeText *self,
               GArray_guint_        *arg_Message_IDs,
               gpointer              user_data)

The PendingMessagesRemoved D-Bus signal is emitted whenever this GObject signal is.

Parameters

self

an object

  

arg_Message_IDs

const GArray * (FIXME, generate documentation)

  

user_data

user data set when the signal handler was connected.

  

Flags: Has Details

The “chat-state-changed” signal

void
user_function (TpSvcChannelInterfaceChatState1 *self,
               guint                            arg_Contact,
               guint                            arg_State,
               gpointer                         user_data)

The ChatStateChanged D-Bus signal is emitted whenever this GObject signal is.

Parameters

self

an object

  

arg_Contact

guint (FIXME, generate documentation)

  

arg_State

guint (FIXME, generate documentation)

  

user_data

user data set when the signal handler was connected.

  

Flags: Has Details

The “password-flags-changed” signal

void
user_function (TpSvcChannelInterfacePassword1 *self,
               guint                           arg_Added,
               guint                           arg_Removed,
               gpointer                        user_data)

The PasswordFlagsChanged D-Bus signal is emitted whenever this GObject signal is.

Parameters

self

an object

  

arg_Added

guint (FIXME, generate documentation)

  

arg_Removed

guint (FIXME, generate documentation)

  

user_data

user data set when the signal handler was connected.

  

Flags: Has Details

The “s-ms-channel-changed” signal

void
user_function (TpSvcChannelInterfaceSMS1 *self,
               gboolean                   arg_SMSChannel,
               gpointer                   user_data)

The SMSChannelChanged D-Bus signal is emitted whenever this GObject signal is.

Parameters

self

an object

  

arg_SMSChannel

gboolean (FIXME, generate documentation)

  

user_data

user data set when the signal handler was connected.

  

Flags: Has Details

See Also

TpTextMixin

Generated by GTK-Doc V1.20