MatrixEventRoom

MatrixEventRoom — Abstract base class for room events.

Functions

Types and Values

Description

Functions

MATRIX_EVENT_TYPE_ROOM

#define MATRIX_EVENT_TYPE_ROOM (matrix_event_room_get_type ())

The type for MatrixEventRoom.


matrix_event_room_get_event_id ()

const gchar *
matrix_event_room_get_event_id (MatrixEventRoom *self);

Get and return the current value of the "event-id" property.

A globally unique event ID. Required.

Parameters

self

the MatrixEventRoom instance to query

 

Returns

the value of the "event-id" property


matrix_event_room_set_event_id ()

void
matrix_event_room_set_event_id (MatrixEventRoom *self,
                                const gchar *value);

Set the value of the "event-id" property to value .

A globally unique event ID. Required.

Parameters

self

the MatrixEventRoom instance to modify

 

value

the new value of the "event-id" property

 

matrix_event_room_get_room_id ()

const gchar *
matrix_event_room_get_room_id (MatrixEventRoom *self);

Get and return the current value of the "room-id" property.

The ID of the room associated with this event. Required, but it may be stripped by HS implementations from some APIs if they reside under a key marked with the room ID.

Parameters

self

the MatrixEventRoom instance to query

 

Returns

the value of the "room-id" property


matrix_event_room_set_room_id ()

void
matrix_event_room_set_room_id (MatrixEventRoom *self,
                               const gchar *value);

Set the value of the "room-id" property to value .

The ID of the room associated with this event. Required, but it may be stripped by HS implementations from some APIs if they reside under a key marked with the room ID.

Parameters

self

the MatrixEventRoom instance to modify

 

value

the new value of the "room-id" property

 

matrix_event_room_get_sender ()

const gchar *
matrix_event_room_get_sender (MatrixEventRoom *self);

Get and return the current value of the "sender" property.

The fully qualified Matrix ID of the user who sent the event. Required.

Parameters

self

the MatrixEventRoom instance to query

 

Returns

the value of the "sender" property


matrix_event_room_set_sender ()

void
matrix_event_room_set_sender (MatrixEventRoom *self,
                              const gchar *value);

Set the value of the "sender" property to value .

The fully qualified Matrix ID of the user who sent the event. Required.

Parameters

self

the MatrixEventRoom instance to modify

 

value

the new value of the "sender" property

 

matrix_event_room_get_age ()

glong
matrix_event_room_get_age (MatrixEventRoom *self);

Get and return the current value of the "age" property.

The time, in milliseconds, that has elapsed since the event was sent. This is part of the unsigned event data.

This value will be omitted from the generated event JSON if less than zero.

Parameters

self

the MatrixEventRoom instance to query

 

Returns

the value of the "age" property


matrix_event_room_set_age ()

void
matrix_event_room_set_age (MatrixEventRoom *self,
                           glong value);

Set the value of the "age" property to value .

The time, in milliseconds, that has elapsed since the event was sent. This is part of the unsigned event data.

This value will be omitted from the generated event JSON if less than zero.

Parameters

self

the MatrixEventRoom instance to modify

 

value

the new value of the "age" property

 

matrix_event_room_get_redacted_because ()

const gchar *
matrix_event_room_get_redacted_because
                               (MatrixEventRoom *self);

Get and return the current value of the "redacted-because" property.

The reason this event was redacted, if it was redacted.

Parameters

self

the MatrixEventRoom instance to query

 

Returns

the value of the "redacted-because" property


matrix_event_room_set_redacted_because ()

void
matrix_event_room_set_redacted_because
                               (MatrixEventRoom *self,
                                const gchar *value);

Set the value of the "redacted-because" property to value .

The reason this event was redacted, if it was redacted.

Parameters

self

the MatrixEventRoom instance to modify

 

value

the new value of the "redacted-because" property

 

matrix_event_room_get_transaction_id ()

const gchar *
matrix_event_room_get_transaction_id (MatrixEventRoom *self);

Get and return the current value of the "transaction-id" property.

The client-supplied transaction ID. This should only be set if the client being given the event is the same one which sent it.

Parameters

self

the MatrixEventRoom instance to query

 

Returns

the value of the "transaction-id" property


matrix_event_room_set_transaction_id ()

void
matrix_event_room_set_transaction_id (MatrixEventRoom *self,
                                      const gchar *value);

Set the value of the "transaction-id" property to value .

The client-supplied transaction ID. This should only be set if the client being given the event is the same one which sent it.

Parameters

self

the MatrixEventRoom instance to modify

 

value

the new value of the "transaction-id" property

 

Types and Values

struct MatrixEventRoom

struct MatrixEventRoom {
	MatrixEventBase parent_instance;
	MatrixEventRoomPrivate * priv;
};

Abstract base class for room events.


struct MatrixEventRoomClass

struct MatrixEventRoomClass {
	MatrixEventBaseClass parent_class;
};

The class structure for MATRIX_EVENT_TYPE_ROOM. All the fields in this structure are private and should never be accessed directly.

Members

MatrixEventBaseClass parent_class;

the parent class structure