MatrixEventRoomRedaction

MatrixEventRoomRedaction — Class to hold a m.room.redaction event

Functions

Types and Values

Description

Events can be redacted by either room or server admins. Redacting an event means that all keys not required by the protocol are stripped off, allowing admins to remove offensive or illegal content that may have been attached to any event. This cannot be undone, allowing server owners to physically delete the offending data. There is also a concept of a moderator hiding a message event, which can be undone, but cannot be applied to state events. The event that has been redacted is specified in the redacts event level key.

Functions

MATRIX_EVENT_TYPE_ROOM_REDACTION

#define MATRIX_EVENT_TYPE_ROOM_REDACTION (matrix_event_room_redaction_get_type ())

The type for MatrixEventRoomRedaction.


matrix_event_room_redaction_new ()

MatrixEventRoomRedaction *
matrix_event_room_redaction_new (void);

matrix_event_room_redaction_get_reason ()

const gchar *
matrix_event_room_redaction_get_reason
                               (MatrixEventRoomRedaction *self);

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

The reason for the redaction, if any.

Parameters

self

the MatrixEventRoomRedaction instance to query

 

Returns

the value of the "reason" property


matrix_event_room_redaction_set_reason ()

void
matrix_event_room_redaction_set_reason
                               (MatrixEventRoomRedaction *self,
                                const gchar *value);

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

The reason for the redaction, if any.

Parameters

self

the MatrixEventRoomRedaction instance to modify

 

value

the new value of the "reason" property

 

matrix_event_room_redaction_get_redacted_event_id ()

const gchar *
matrix_event_room_redaction_get_redacted_event_id
                               (MatrixEventRoomRedaction *self);

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

The event ID that was redacted.

Parameters

self

the MatrixEventRoomRedaction instance to query

 

Returns

the value of the "redacted-event-id" property


matrix_event_room_redaction_set_redacted_event_id ()

void
matrix_event_room_redaction_set_redacted_event_id
                               (MatrixEventRoomRedaction *self,
                                const gchar *value);

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

The event ID that was redacted.

Parameters

self

the MatrixEventRoomRedaction instance to modify

 

value

the new value of the "redacted-event-id" property

 

Types and Values

struct MatrixEventRoomRedaction

struct MatrixEventRoomRedaction {
	MatrixEventRoom parent_instance;
	MatrixEventRoomRedactionPrivate * priv;
};

Class to hold a m.room.redaction event

Events can be redacted by either room or server admins. Redacting an event means that all keys not required by the protocol are stripped off, allowing admins to remove offensive or illegal content that may have been attached to any event. This cannot be undone, allowing server owners to physically delete the offending data. There is also a concept of a moderator hiding a message event, which can be undone, but cannot be applied to state events. The event that has been redacted is specified in the redacts event level key.


struct MatrixEventRoomRedactionClass

struct MatrixEventRoomRedactionClass {
	MatrixEventRoomClass parent_class;
};

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

Members

MatrixEventRoomClass parent_class;

the parent class structure