TplEntry

TplEntry — Abstract representation of a log entry

Synopsis

                    TplEntry;
                    TplEntryClass;
                    TplEntryPriv;
enum                TplEntryDirection;
gint64              tpl_entry_get_timestamp             (TplEntry *self);
const gchar *       tpl_entry_get_account_path          (TplEntry *self);
TpAccount *         tpl_entry_get_account               (TplEntry *self);
TplEntity *         tpl_entry_get_sender                (TplEntry *self);
TplEntity *         tpl_entry_get_receiver              (TplEntry *self);

Object Hierarchy

  GObject
   +----TplEntry
         +----TplEntryText

Properties

  "account"                  TpAccount*            : Read / Write / Construct Only
  "account-path"             gchar*                : Read
  "channel-path"             gchar*                : Read / Write / Construct Only
  "chat-id"                  gchar*                : Read / Write / Construct Only
  "direction"                guint                 : Read / Write / Construct Only
  "log-id"                   gchar*                : Read / Write / Construct Only
  "receiver"                 TplEntity*            : Read / Write / Construct Only
  "sender"                   TplEntity*            : Read / Write / Construct Only
  "timestamp"                guint                 : Read / Write

Description

The TPLogger log entry represent a generic log entry, which will be specialied by subclasses of TplEntry.

Details

TplEntry

typedef struct _TplEntry TplEntry;

An object representing a generic log entry.


TplEntryClass

typedef struct _TplEntryClass TplEntryClass;


TplEntryPriv

typedef struct _TplEntryPriv TplEntryPriv;


enum TplEntryDirection

typedef enum
{
  TPL_ENTRY_DIRECTION_NONE = 0,

  TPL_ENTRY_DIRECTION_IN,
  TPL_ENTRY_DIRECTION_OUT
} TplEntryDirection;


tpl_entry_get_timestamp ()

gint64              tpl_entry_get_timestamp             (TplEntry *self);

self :

a TplEntry

Returns :

the same timestamp as the "timestamp" property

tpl_entry_get_account_path ()

const gchar *       tpl_entry_get_account_path          (TplEntry *self);

self :

Returns :


tpl_entry_get_account ()

TpAccount *         tpl_entry_get_account               (TplEntry *self);

self :

a TplEntry

Returns :

the same account as the "account" property

tpl_entry_get_sender ()

TplEntity *         tpl_entry_get_sender                (TplEntry *self);

self :

a TplEntry

Returns :

the same TplEntity as the "sender" property

tpl_entry_get_receiver ()

TplEntity *         tpl_entry_get_receiver              (TplEntry *self);

self :

a TplEntry

Returns :

the same TplEntity as the "receiver" property

Property Details

The "account" property

  "account"                  TpAccount*            : Read / Write / Construct Only

The TpAccount to which the log entry is related.


The "account-path" property

  "account-path"             gchar*                : Read

The account path of the TpAccount to which the log entry is related.

Default value: NULL


The "channel-path" property

  "channel-path"             gchar*                : Read / Write / Construct Only

The channel path of the TpChannel to which the log entry is related.

Default value: NULL


The "chat-id" property

  "chat-id"                  gchar*                : Read / Write / Construct Only

The chat identifier to which the log entry is related.

Default value: NULL


The "direction" property

  "direction"                guint                 : Read / Write / Construct Only

The direction of the log entry (in/out).

Default value: 0


The "log-id" property

  "log-id"                   gchar*                : Read / Write / Construct Only

Log identification token, it's unique among existing Entry, if two messages have the same token, they are the same entry (maybe logged by two different TplLogStore).

Default value: NULL


The "receiver" property

  "receiver"                 TplEntity*            : Read / Write / Construct Only

TplEntity instance destination for the log entry.


The "sender" property

  "sender"                   TplEntity*            : Read / Write / Construct Only

TplEntity instance who originated the log entry.


The "timestamp" property

  "timestamp"                guint                 : Read / Write

The timestamp (gint64) for the log entry.

Default value: 0

See Also

TplEntryText and other subclasses when they'll exist