Message

Message — A message representation

Functions

Properties

gchar * author Read / Write / Construct
TalkatuContentType content-type Read / Write / Construct Only
gchar * contents Read / Write / Construct
gboolean edited Read / Write / Construct
guint64 id Read / Write / Construct
gpointer timestamp Read / Write / Construct Only

Types and Values

Object Hierarchy

    GInterface
    ╰── TalkatuMessage

Description

Talkatu needs a way to represent a message in a client agnostic way, this is the API that does that.

Functions

talkatu_message_get_id ()

guint64
talkatu_message_get_id (TalkatuMessage *message);

Gets the identifier of the message .

Parameters

message

The TalkatuMessage instance.

 

Returns

The identifier of message .


talkatu_message_set_id ()

void
talkatu_message_set_id (TalkatuMessage *message,
                        guint64 id);

Sets the identifier of message .

Parameters

message

The TalkatuMessage instance.

 

id

The new identifier of message .

 

talkatu_message_get_timestamp ()

GDateTime *
talkatu_message_get_timestamp (TalkatuMessage *message);

Gets the timestamp for when this message was created.

Parameters

message

The TalkatuMessage instance.

 

Returns

The timestamp of message .

[transfer full][nullable]


talkatu_message_set_timestamp ()

void
talkatu_message_set_timestamp (TalkatuMessage *message,
                               GDateTime *timestamp);

Sets the creation timestamp for message to timestamp .

Parameters

message

The TalkatuMessage instance.

 

timestamp

The new timestamp for message .

[nullable]

talkatu_message_get_content_type ()

TalkatuContentType
talkatu_message_get_content_type (TalkatuMessage *message);

Gets the content-type of message .

Parameters

message

The TalkatuMessage instance.

 

Returns

The content type of message .


talkatu_message_get_author ()

gchar *
talkatu_message_get_author (TalkatuMessage *message);

Gets the author of message .

Parameters

message

The TalkatuMessage instance.

 

Returns

The author of message .

[transfer full]


talkatu_message_set_author ()

void
talkatu_message_set_author (TalkatuMessage *message,
                            const gchar *author);

Sets the author of message to author .

Parameters

message

The TalkatuMessage instance.

 

author

The new author of message .

 

talkatu_message_get_contents ()

gchar *
talkatu_message_get_contents (TalkatuMessage *message);

Gets the contents of message .

Parameters

message

The TalkatuMessage instance.

 

Returns

The contents of message .

[transfer full]


talkatu_message_set_contents ()

void
talkatu_message_set_contents (TalkatuMessage *message,
                              const gchar *contents);

Sets the contents of message to contents .

Parameters

message

The TalkatuMessage instance.

 

contents

The new contents of message .

 

talkatu_message_get_edited ()

gboolean
talkatu_message_get_edited (TalkatuMessage *message);

Gets whether message has been edited by its author.

Parameters

message

The TalkatuMessage instance.

 

Returns

TRUE if message was edited by its author, or FALSE if not.


talkatu_message_set_edited ()

void
talkatu_message_set_edited (TalkatuMessage *message,
                            gboolean edited);

Sets whether message has been edited or not.

Parameters

message

The TalkatuMessage instance.

 

edited

Whether the message has been edited or not.

 

Types and Values

enum TalkatuContentType

An enum representing a given markup type.

Members

TALKATU_CONTENT_TYPE_PLAIN

Plain text content.

 

TALKATU_CONTENT_TYPE_PANGO

Pango Markup content.

 

TALKATU_CONTENT_TYPE_HTML

HTML content.

 

TALKATU_CONTENT_TYPE_MARKDOWN

Markdown content.

 

TALKATU_TYPE_MESSAGE

#define TALKATU_TYPE_MESSAGE (talkatu_message_get_type())

The standard _get_type macro for TalkatuMessage.


struct TalkatuMessageInterface

struct TalkatuMessageInterface {
};

TalkatuMessage is an interface to be implemented to standardize the way messages are handled. All of its properties should be overridden with a sensible value returned for them.


TalkatuMessage

typedef struct _TalkatuMessage TalkatuMessage;

TalkatuMessage is an opaque data structure and can only be accessed using the following functions.

Property Details

The “author” property

  “author”                   gchar *

The author of the message.

Flags: Read / Write / Construct

Default value: NULL


The “content-type” property

  “content-type”             TalkatuContentType

The content-type of the message.

Flags: Read / Write / Construct Only

Default value: TALKATU_CONTENT_TYPE_PLAIN


The “contents” property

  “contents”                 gchar *

The contents of the message.

Flags: Read / Write / Construct

Default value: NULL


The “edited” property

  “edited”                   gboolean

Whether this message has been edited by its author.

Flags: Read / Write / Construct

Default value: FALSE


The “id” property

  “id”                       guint64

The identifier of the message.

Flags: Read / Write / Construct

Default value: 0


The “timestamp” property

  “timestamp”                gpointer

The timestamp of the message.

Flags: Read / Write / Construct Only