![]() |
![]() |
![]() |
telepathy-glib API Reference Manual | ![]() |
---|---|---|---|---|
Top | Description | Object Hierarchy | Signals |
Text channelsText channels — service-side interfaces for the Text channel type, and the Chat State, Password and SMS interfaces |
#include <telepathy-glib/telepathy-glib-dbus.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_emit_message_received (gpointer instance
,const GPtrArray *arg_Message
); void tp_svc_channel_type_text_emit_message_sent (gpointer instance
,const GPtrArray *arg_Content
,guint arg_Flags
,const gchar *arg_Message_Token
); void tp_svc_channel_type_text_emit_pending_messages_removed (gpointer instance
,const GArray *arg_Message_IDs
); 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_implement_send_message (TpSvcChannelTypeTextClass *klass
,tp_svc_channel_type_text_send_message_impl impl
); void tp_svc_channel_type_text_return_from_acknowledge_pending_messages (DBusGMethodInvocation *context
); void tp_svc_channel_type_text_return_from_send_message (DBusGMethodInvocation *context
,const gchar *out_Token
); void (*tp_svc_channel_type_text_send_message_impl) (TpSvcChannelTypeText *self
,const GPtrArray *in_Message
,guint in_Flags
,DBusGMethodInvocation *context
); 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 out_Password_Flags
); 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 out_Correct
); void tp_svc_channel_interface_password_emit_password_flags_changed (gpointer instance
,guint arg_Added
,guint arg_Removed
); TpSvcChannelInterfaceSMS; TpSvcChannelInterfaceSMSClass; void tp_svc_channel_interface_sms_emit_sms_channel_changed (gpointer instance
,gboolean arg_SMSChannel
); void (*tp_svc_channel_interface_sms_get_sms_length_impl) (TpSvcChannelInterfaceSMS *self
,const GPtrArray *in_Message
,DBusGMethodInvocation *context
); void tp_svc_channel_interface_sms_implement_get_sms_length (TpSvcChannelInterfaceSMSClass *klass
,tp_svc_channel_interface_sms_get_sms_length_impl impl
); void tp_svc_channel_interface_sms_return_from_get_sms_length (DBusGMethodInvocation *context
,guint out_Chunks_Required
,gint out_Remaining_Characters
,gint out_Estimated_Cost
);
GInterface +----TpSvcChannelTypeText
GInterface +----TpSvcChannelInterfaceChatState
GInterface +----TpSvcChannelInterfacePassword
GInterface +----TpSvcChannelInterfaceSMS
"message-received" :Has Details
"message-sent" :Has Details
"pending-messages-removed" :Has Details
"chat-state-changed" :Has Details
"password-flags-changed" :Has Details
"s-ms-channel-changed" :Has Details
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.
typedef struct _TpSvcChannelTypeText TpSvcChannelTypeText;
Dummy typedef representing any implementation of this interface.
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 }
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 im.telepathy1.Channel.Type.Text.
|
The object implementing this interface |
|
const GArray * (FIXME, generate documentation) |
|
Used to return values or throw an error |
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.telepathy1.Channel.Type.Text.
|
The object implementing this interface |
|
const GPtrArray * (FIXME, generate documentation) |
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.telepathy1.Channel.Type.Text.
|
The object implementing this interface |
|
const GPtrArray * (FIXME, generate documentation) |
|
guint (FIXME, generate documentation) |
|
const gchar * (FIXME, generate documentation) |
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.telepathy1.Channel.Type.Text.
|
The object implementing this interface |
|
const GArray * (FIXME, generate documentation) |
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.
|
A class whose instances implement this interface |
|
A callback used to implement the AcknowledgePendingMessages D-Bus method |
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.
|
A class whose instances implement this interface |
|
A callback used to implement the SendMessage D-Bus method |
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.
|
The D-Bus method invocation context |
void tp_svc_channel_type_text_return_from_send_message (DBusGMethodInvocation *context
,const gchar *out_Token
);
Return successfully by calling dbus_g_method_return()
.
This inline function exists only to provide type-safety.
|
The D-Bus method invocation context |
|
const gchar * (FIXME, generate documentation) |
void (*tp_svc_channel_type_text_send_message_impl) (TpSvcChannelTypeText *self
,const GPtrArray *in_Message
,guint in_Flags
,DBusGMethodInvocation *context
);
The signature of an implementation of the D-Bus method SendMessage on interface im.telepathy1.Channel.Type.Text.
|
The object implementing this interface |
|
const GPtrArray * (FIXME, generate documentation) |
|
guint (FIXME, generate documentation) |
|
Used to return values or throw an error |
typedef struct _TpSvcChannelInterfaceChatState TpSvcChannelInterfaceChatState;
Dummy typedef representing any implementation of this interface.
typedef struct _TpSvcChannelInterfaceChatStateClass TpSvcChannelInterfaceChatStateClass;
The class of TpSvcChannelInterfaceChatState.
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_state (gpointer klass, gpointer unused G_GNUC_UNUSED) { #define IMPLEMENT(x) tp_svc_channel_interface_chat_state_implement_##x (\ klass, my_object_##x) IMPLEMENT (set_chat_state); #undef IMPLEMENT }
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 im.telepathy1.Channel.Interface.ChatState1.
|
The object implementing this interface |
|
guint (FIXME, generate documentation) |
|
Used to return values or throw an error |
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.
|
A class whose instances implement this interface |
|
A callback used to implement the SetChatState D-Bus method |
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.
|
The D-Bus method invocation context |
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 im.telepathy1.Channel.Interface.ChatState1.
|
The object implementing this interface |
|
guint (FIXME, generate documentation) |
|
guint (FIXME, generate documentation) |
typedef struct _TpSvcChannelInterfacePassword TpSvcChannelInterfacePassword;
Dummy typedef representing any implementation of this interface.
typedef struct _TpSvcChannelInterfacePasswordClass TpSvcChannelInterfacePasswordClass;
The class of TpSvcChannelInterfacePassword.
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_password (gpointer klass, gpointer unused G_GNUC_UNUSED) { #define IMPLEMENT(x) tp_svc_channel_interface_password_implement_##x (\ klass, my_object_##x) IMPLEMENT (get_password_flags); IMPLEMENT (provide_password); #undef IMPLEMENT }
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 im.telepathy1.Channel.Interface.Password1.
|
The object implementing this interface |
|
Used to return values or throw an error |
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.
|
A class whose instances implement this interface |
|
A callback used to implement the GetPasswordFlags D-Bus method |
void tp_svc_channel_interface_password_return_from_get_password_flags (DBusGMethodInvocation *context
,guint out_Password_Flags
);
Return successfully by calling dbus_g_method_return()
.
This inline function exists only to provide type-safety.
|
The D-Bus method invocation context |
|
guint (FIXME, generate documentation) |
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 im.telepathy1.Channel.Interface.Password1.
|
The object implementing this interface |
|
const gchar * (FIXME, generate documentation) |
|
Used to return values or throw an error |
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.
|
A class whose instances implement this interface |
|
A callback used to implement the ProvidePassword D-Bus method |
void tp_svc_channel_interface_password_return_from_provide_password (DBusGMethodInvocation *context
,gboolean out_Correct
);
Return successfully by calling dbus_g_method_return()
.
This inline function exists only to provide type-safety.
|
The D-Bus method invocation context |
|
gboolean (FIXME, generate documentation) |
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 im.telepathy1.Channel.Interface.Password1.
|
The object implementing this interface |
|
guint (FIXME, generate documentation) |
|
guint (FIXME, generate documentation) |
typedef struct _TpSvcChannelInterfaceSMS TpSvcChannelInterfaceSMS;
Dummy typedef representing any implementation of this interface.
typedef struct _TpSvcChannelInterfaceSMSClass TpSvcChannelInterfaceSMSClass;
The class of TpSvcChannelInterfaceSMS.
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_sms (gpointer klass, gpointer unused G_GNUC_UNUSED) { #define IMPLEMENT(x) tp_svc_channel_interface_sms_implement_##x (\ klass, my_object_##x) IMPLEMENT (get_sms_length); #undef IMPLEMENT }
void tp_svc_channel_interface_sms_emit_sms_channel_changed (gpointer instance
,gboolean arg_SMSChannel
);
Type-safe wrapper around g_signal_emit to emit the SMSChannelChanged signal on interface im.telepathy1.Channel.Interface.SMS1.
|
The object implementing this interface |
|
gboolean (FIXME, generate documentation) |
void (*tp_svc_channel_interface_sms_get_sms_length_impl) (TpSvcChannelInterfaceSMS *self
,const GPtrArray *in_Message
,DBusGMethodInvocation *context
);
The signature of an implementation of the D-Bus method GetSMSLength on interface im.telepathy1.Channel.Interface.SMS1.
|
The object implementing this interface |
|
const GPtrArray * (FIXME, generate documentation) |
|
Used to return values or throw an error |
void tp_svc_channel_interface_sms_implement_get_sms_length (TpSvcChannelInterfaceSMSClass *klass
,tp_svc_channel_interface_sms_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.
|
A class whose instances implement this interface |
|
A callback used to implement the GetSMSLength D-Bus method |
void tp_svc_channel_interface_sms_return_from_get_sms_length (DBusGMethodInvocation *context
,guint out_Chunks_Required
,gint out_Remaining_Characters
,gint out_Estimated_Cost
);
Return successfully by calling dbus_g_method_return()
.
This inline function exists only to provide type-safety.
|
The D-Bus method invocation context |
|
guint (FIXME, generate documentation) |
|
gint (FIXME, generate documentation) |
|
gint (FIXME, generate documentation) |
"message-received"
signalvoid user_function (TpSvcChannelTypeText *self,
gpointer user_data) : Has Details
The MessageReceived D-Bus signal is emitted whenever this GObject signal is.
|
an object |
|
const GPtrArray * (FIXME, generate documentation) |
|
user data set when the signal handler was connected. |
"message-sent"
signalvoid user_function (TpSvcChannelTypeText *self,
guint arg_Flags,
gchar *arg_Message_Token,
gpointer user_data) : Has Details
The MessageSent D-Bus signal is emitted whenever this GObject signal is.
|
an object |
|
const GPtrArray * (FIXME, generate documentation) |
|
guint (FIXME, generate documentation) |
|
const gchar * (FIXME, generate documentation) |
|
user data set when the signal handler was connected. |
"pending-messages-removed"
signalvoid user_function (TpSvcChannelTypeText *self,
GArray_guint_ *arg_Message_IDs,
gpointer user_data) : Has Details
The PendingMessagesRemoved D-Bus signal is emitted whenever this GObject signal is.
|
an object |
|
const GArray * (FIXME, generate documentation) |
|
user data set when the signal handler was connected. |
"chat-state-changed"
signalvoid user_function (TpSvcChannelInterfaceChatState *self,
guint arg_Contact,
guint arg_State,
gpointer user_data) : Has Details
The ChatStateChanged D-Bus signal is emitted whenever this GObject signal is.
|
an object |
|
guint (FIXME, generate documentation) |
|
guint (FIXME, generate documentation) |
|
user data set when the signal handler was connected. |
"password-flags-changed"
signalvoid user_function (TpSvcChannelInterfacePassword *self,
guint arg_Added,
guint arg_Removed,
gpointer user_data) : Has Details
The PasswordFlagsChanged D-Bus signal is emitted whenever this GObject signal is.
|
an object |
|
guint (FIXME, generate documentation) |
|
guint (FIXME, generate documentation) |
|
user data set when the signal handler was connected. |
"s-ms-channel-changed"
signalvoid user_function (TpSvcChannelInterfaceSMS *self,
gboolean arg_SMSChannel,
gpointer user_data) : Has Details
The SMSChannelChanged D-Bus signal is emitted whenever this GObject signal is.
|
an object |
|
gboolean (FIXME, generate documentation) |
|
user data set when the signal handler was connected. |