TpaTextChannel

TpaTextChannel

Synopsis




#define             TPA_TEXT_CHANNEL_GET_PRIVATE        (obj)
                    TpaTextChannelPrivate;
                    TpaTextChannel;
void                tpa_text_channel_send               (TpaTextChannel *self,
                                                         const gchar *contents,
                                                         TpaTextMessageType type);
#define             tpa_text_channel_send_normal        (self, contents)
#define             tpa_text_channel_send_action        (self, contents)
#define             tpa_text_channel_send_notice        (self, contents)
#define             tpa_text_channel_send_auto_reply    (self, contents)
void                tpa_text_channel_send_message       (TpaTextChannel *self,
                                                         TpaTextMessage *message);
GPtrArray*          tpa_text_channel_get_messages       (TpaTextChannel *self,
                                                         guint messages,
                                                         TpaTextMessageType type);
#define             tpa_text_channel_get_normal_messages(self, messages)
#define             tpa_text_channel_get_action_messages(self, messages)
#define             tpa_text_channel_get_notice_messages(self, messages)
#define             tpa_text_channel_get_auto_reply_messages(self, messages)
#define             tpa_text_channel_get_error_messages (self, messages)
#define             tpa_text_channel_get_all_messages   (self, messages)
void                tpa_text_channel_set_log_size       (TpaTextChannel *self,
                                                         guint log_size);
guint               tpa_text_channel_get_log_size       (TpaTextChannel *self);
void                tpa_text_channel_acknowledge_message
                                                        (TpaTextChannel *self,
                                                         TpaTextMessage *message);
GPtrArray*          tpa_text_channel_get_pending        (TpaTextChannel *self,
                                                         gboolean acknowledge);
gboolean            tpa_text_channel_set_local_chat_state
                                                        (TpaTextChannel *self,
                                                         TpaChatState state);
TpaChatState        tpa_text_channel_get_local_chat_state
                                                        (TpaTextChannel *self);

Object Hierarchy


  GObject
   +----TpaObject
         +----TpaChannel
               +----TpaTextChannel

Signals


  "message-error"                                  : Run Last / Has Details
  "message-received"                               : Run Last / Has Details
  "message-sent"                                   : Run Last / Has Details

Description

Details

TPA_TEXT_CHANNEL_GET_PRIVATE()

#define             TPA_TEXT_CHANNEL_GET_PRIVATE(obj)

obj :

TpaTextChannelPrivate

typedef struct _TpaTextChannelPrivate TpaTextChannelPrivate;


TpaTextChannel

typedef struct _TpaTextChannel TpaTextChannel;


tpa_text_channel_send ()

void                tpa_text_channel_send               (TpaTextChannel *self,
                                                         const gchar *contents,
                                                         TpaTextMessageType type);

Send raw text string.

self : TpaTextChannel instance
contents : Text string to be sent.
type : contents message type.

tpa_text_channel_send_normal()

#define             tpa_text_channel_send_normal(self, contents)

self :
contents :

tpa_text_channel_send_action()

#define             tpa_text_channel_send_action(self, contents)

self :
contents :

tpa_text_channel_send_notice()

#define             tpa_text_channel_send_notice(self, contents)

self :
contents :

tpa_text_channel_send_auto_reply()

#define             tpa_text_channel_send_auto_reply(self, contents)

self :
contents :

tpa_text_channel_send_message ()

void                tpa_text_channel_send_message       (TpaTextChannel *self,
                                                         TpaTextMessage *message);

Send message.

self : TpaTextChannel instance
message : TpaTextMessage instance.

tpa_text_channel_get_messages ()

GPtrArray*          tpa_text_channel_get_messages       (TpaTextChannel *self,
                                                         guint messages,
                                                         TpaTextMessageType type);

Return a number messages logged with the given type.

self : TpaTextChannel instance
messages : number of messages required.
type : TpaTextMessageType required.
Returns : GPtrArray containing TpaTextMessage messages.

tpa_text_channel_get_normal_messages()

#define             tpa_text_channel_get_normal_messages(self, messages)

self :
messages :

tpa_text_channel_get_action_messages()

#define             tpa_text_channel_get_action_messages(self, messages)

self :
messages :

tpa_text_channel_get_notice_messages()

#define             tpa_text_channel_get_notice_messages(self, messages)

self :
messages :

tpa_text_channel_get_auto_reply_messages()

#define             tpa_text_channel_get_auto_reply_messages(self, messages)

self :
messages :

tpa_text_channel_get_error_messages()

#define             tpa_text_channel_get_error_messages(self, messages)

self :
messages :

tpa_text_channel_get_all_messages()

#define             tpa_text_channel_get_all_messages(self, messages)

self :
messages :

tpa_text_channel_set_log_size ()

void                tpa_text_channel_set_log_size       (TpaTextChannel *self,
                                                         guint log_size);

Get number of logged messages available.

self : TpaTextChannel instance.
log_size :

tpa_text_channel_get_log_size ()

guint               tpa_text_channel_get_log_size       (TpaTextChannel *self);

self :
Returns :

tpa_text_channel_acknowledge_message ()

void                tpa_text_channel_acknowledge_message
                                                        (TpaTextChannel *self,
                                                         TpaTextMessage *message);

self : TpaTextChannel instance.
message : TpaTextChannel instance.

tpa_text_channel_get_pending ()

GPtrArray*          tpa_text_channel_get_pending        (TpaTextChannel *self,
                                                         gboolean acknowledge);

self : TpaTextChannel instance.
acknowledge : Acknowledge messages.
Returns :

tpa_text_channel_set_local_chat_state ()

gboolean            tpa_text_channel_set_local_chat_state
                                                        (TpaTextChannel *self,
                                                         TpaChatState state);

Update chat state.

self : TpaTextChannel instance.
state : TpaChatState value.
Returns : TRUE if the state was updated.

tpa_text_channel_get_local_chat_state ()

TpaChatState        tpa_text_channel_get_local_chat_state
                                                        (TpaTextChannel *self);

self : TpaTextChannel instance.
Returns : The current chat state.

Signal Details

The "message-error" signal

void                user_function                      (TpaTextChannel *tpatextchannel,
                                                        gpointer        user_data)           : Run Last / Has Details

tpatextchannel : the object which received the signal.
user_data : user data set when the signal handler was connected.

The "message-received" signal

void                user_function                      (TpaTextChannel *tpatextchannel,
                                                        TpaTextMessage *arg1,
                                                        gpointer        user_data)           : Run Last / Has Details

tpatextchannel : the object which received the signal.
arg1 :
user_data : user data set when the signal handler was connected.

The "message-sent" signal

void                user_function                      (TpaTextChannel *tpatextchannel,
                                                        TpaTextMessage *arg1,
                                                        gpointer        user_data)           : Run Last / Has Details

tpatextchannel : the object which received the signal.
arg1 :
user_data : user data set when the signal handler was connected.