MatrixJsonCompact

MatrixJsonCompact — Abstract parent class for classes that can be saved to JSON.

Functions

#define MATRIX_TYPE_JSON_COMPACT
JsonNode * matrix_json_compact_get_json_node ()
gchar * matrix_json_compact_get_json_data ()
gpointer matrix_json_compact_ref ()
void matrix_json_compact_unref ()
GParamSpec * matrix_param_spec_json_compact ()
void matrix_value_set_json_compact ()
gpointer matrix_value_get_json_compact ()
void matrix_value_take_json_compact ()
#define MATRIX_TYPE_FILTER
MatrixFilter * matrix_filter_new ()
GList * matrix_filter_get_event_fields ()
void matrix_filter_set_event_fields ()
MatrixEventFormat matrix_filter_get_event_format ()
void matrix_filter_set_event_format ()
MatrixFilterRules * matrix_filter_get_presence_filter ()
void matrix_filter_set_presence_filter ()
MatrixRoomFilter * matrix_filter_get_room_filter ()
void matrix_filter_set_room_filter ()
#define MATRIX_TYPE_ROOM_FILTER
MatrixRoomFilter * matrix_room_filter_new ()
gboolean matrix_room_filter_get_include_leave ()
void matrix_room_filter_set_include_leave ()
MatrixFilterRules * matrix_room_filter_get_ephemeral ()
void matrix_room_filter_set_ephemeral ()
MatrixFilterRules * matrix_room_filter_get_state ()
void matrix_room_filter_set_state ()
MatrixFilterRules * matrix_room_filter_get_timeline ()
void matrix_room_filter_set_timeline ()
#define MATRIX_TYPE_FILTER_RULES
MatrixFilterRules * matrix_filter_rules_new ()
guint matrix_filter_rules_get_limit ()
void matrix_filter_rules_set_limit ()
GList * matrix_filter_rules_get_types ()
void matrix_filter_rules_set_types ()
GList * matrix_filter_rules_get_excluded_types ()
void matrix_filter_rules_set_excluded_types ()
GList * matrix_filter_rules_get_senders ()
void matrix_filter_rules_set_senders ()
GList * matrix_filter_rules_get_excluded_senders ()
void matrix_filter_rules_set_excluded_senders ()
GList * matrix_filter_rules_get_rooms ()
void matrix_filter_rules_set_rooms ()
GList * matrix_filter_rules_get_excluded_rooms ()
void matrix_filter_rules_set_excluded_rooms ()
#define MATRIX_TYPE_3PID_CREDENTIAL
Matrix3PidCredential * matrix_3pid_credential_new ()
const gchar * matrix_3pid_credential_get_id_server ()
void matrix_3pid_credential_set_id_server ()
const gchar * matrix_3pid_credential_get_session_id ()
void matrix_3pid_credential_set_session_id ()
const gchar * matrix_3pid_credential_get_client_secret ()
void matrix_3pid_credential_set_client_secret ()
#define MATRIX_TYPE_PUSHER
MatrixPusher * matrix_pusher_new ()
const gchar * matrix_pusher_get_device_display_name ()
void matrix_pusher_set_device_display_name ()
const gchar * matrix_pusher_get_app_display_name ()
void matrix_pusher_set_app_display_name ()
const gchar * matrix_pusher_get_app_id ()
void matrix_pusher_set_app_id ()
gboolean matrix_pusher_get_append ()
void matrix_pusher_set_append ()
const gchar * matrix_pusher_get_kind ()
void matrix_pusher_set_kind ()
const gchar * matrix_pusher_get_lang ()
void matrix_pusher_set_lang ()
const gchar * matrix_pusher_get_profile_tag ()
void matrix_pusher_set_profile_tag ()
const gchar * matrix_pusher_get_pushkey ()
void matrix_pusher_set_pushkey ()
JsonNode * matrix_pusher_get_data ()
void matrix_pusher_set_data ()
#define MATRIX_TYPE_UNSIGNED_EVENT_DATA
MatrixUnsignedEventData * matrix_unsigned_event_data_new_from_json ()
MatrixUnsignedEventData * matrix_unsigned_event_data_new ()
guint matrix_unsigned_event_data_get_age ()
void matrix_unsigned_event_data_set_age ()
const gchar * matrix_unsigned_event_data_get_redact_reason ()
void matrix_unsigned_event_data_set_redact_reason ()
const gchar * matrix_unsigned_event_data_get_transaction_id ()
void matrix_unsigned_event_data_set_transaction_id ()
#define MATRIX_TYPE_EVENT_CONTEXT
MatrixEventContext * matrix_event_context_new ()
gint * matrix_event_context_get_before_limit ()
void matrix_event_context_set_before_limit ()
gint * matrix_event_context_get_after_limit ()
void matrix_event_context_set_after_limit ()
gboolean * matrix_event_context_get_include_profile ()
void matrix_event_context_set_include_profile ()
#define MATRIX_TYPE_SEARCH_GROUPING
MatrixSearchGrouping * matrix_search_grouping_new ()
MatrixSearchGroupBy * matrix_search_grouping_get_key ()
void matrix_search_grouping_set_key ()
#define MATRIX_TYPE_SEARCH_GROUPINGS
MatrixSearchGroupings * matrix_search_groupings_new ()
GList * matrix_search_groupings_get_group_by ()
void matrix_search_groupings_set_group_by ()
#define MATRIX_TYPE_SEARCH_ROOM_EVENTS
MatrixSearchRoomEvents * matrix_search_room_events_new ()
MatrixSearchOrder * matrix_search_room_events_get_order_by ()
void matrix_search_room_events_set_order_by ()
GList * matrix_search_room_events_get_keys ()
void matrix_search_room_events_set_keys ()
MatrixEventContext * matrix_search_room_events_get_event_context ()
void matrix_search_room_events_set_event_context ()
gboolean * matrix_search_room_events_get_include_state ()
void matrix_search_room_events_set_include_state ()
const gchar * matrix_search_room_events_get_filter_id ()
void matrix_search_room_events_set_filter_id ()
MatrixFilter * matrix_search_room_events_get_filter ()
void matrix_search_room_events_set_filter ()
const gchar * matrix_search_room_events_get_search_term ()
void matrix_search_room_events_set_search_term ()
MatrixSearchGroupings * matrix_search_room_events_get_groupings ()
void matrix_search_room_events_set_groupings ()
#define MATRIX_TYPE_SEARCH_CATEGORIES
MatrixSearchCategories * matrix_search_categories_new ()
MatrixSearchRoomEvents * matrix_search_categories_get_room_events ()
void matrix_search_categories_set_room_events ()

Types and Values

Object Hierarchy


Description

Functions

MATRIX_TYPE_JSON_COMPACT

#define MATRIX_TYPE_JSON_COMPACT (matrix_json_compact_get_type ())

The type for MatrixJsonCompact.


matrix_json_compact_get_json_node ()

JsonNode *
matrix_json_compact_get_json_node (MatrixJsonCompact *self,
                                   GError **error);

Parameters

self

the MatrixJsonCompact instance

 

error

location to store the error occuring, or NULL to ignore.

[error-domains MatrixError]

matrix_json_compact_get_json_data ()

gchar *
matrix_json_compact_get_json_data (MatrixJsonCompact *self,
                                   gsize *datalen,
                                   GError **error);

Parameters

self

the MatrixJsonCompact instance

 

datalen

 

 

error

location to store the error occuring, or NULL to ignore.

[error-domains MatrixError]

matrix_json_compact_ref ()

gpointer
matrix_json_compact_ref (gpointer instance);

Increases the reference count of object .

Parameters

instance

a MatrixJsonCompact.

 

Returns

the same object


matrix_json_compact_unref ()

void
matrix_json_compact_unref (gpointer instance);

Decreases the reference count of object . When its reference count drops to 0, the object is finalized (i.e. its memory is freed).

Parameters

instance

a MatrixJsonCompact.

 

matrix_param_spec_json_compact ()

GParamSpec *
matrix_param_spec_json_compact (const gchar *name,
                                const gchar *nick,
                                const gchar *blurb,
                                GType object_type,
                                GParamFlags flags);

Creates a new GParamSpecBoxed instance specifying a MATRIX_TYPE_JSON_COMPACT derived property.

See g_param_spec_internal() for details on property names.

Parameters

name

canonical name of the property specified

 

nick

nick name for the property specified

 

blurb

description of the property specified

 

object_type

MATRIX_TYPE_JSON_COMPACT derived type of this property  

flags

flags for the property specified

 

matrix_value_set_json_compact ()

void
matrix_value_set_json_compact (GValue *value,
                               gpointer v_object);

Set the contents of a MATRIX_TYPE_JSON_COMPACT derived GValue to v_object .

matrix_value_set_json_compact() increases the reference count of v_object (the GValue holds a reference to v_object). If you do not wish to increase the reference count of the object (i.e. you wish to pass your current reference to the GValue because you no longer need it), use matrix_value_take_json_compact() instead.

It is important that your GValue holds a reference to v_object (either its own, or one it has taken) to ensure that the object won't be destroyed while the GValue still exists).

Parameters

value

a valid GValue of MATRIX_TYPE_JSON_COMPACT derived type

 

v_object

object value to be set

 

matrix_value_get_json_compact ()

gpointer
matrix_value_get_json_compact (const GValue *value);

Get the contents of a MATRIX_TYPE_JSON_COMPACT derived GValue.

Parameters

value

a valid GValue of MATRIX_TYPE_JSON_COMPACT derived type

 

Returns

object contents of value


matrix_value_take_json_compact ()

void
matrix_value_take_json_compact (GValue *value,
                                gpointer v_object);

Sets the contents of a MATRIX_TYPE_JSON_COMPACT derived GValue to v_object and takes over the ownership of the callers reference to v_object ; the caller doesn't have to unref it any more (i.e. the reference count of the object is not increased).

If you want the GValue to hold its own reference to v_object , use matrix_value_set_json_compact() instead.

Parameters

value

a valid GValue of MATRIX_TYPE_JSON_COMPACT derived type

 

v_object

object value to be set

 

MATRIX_TYPE_FILTER

#define MATRIX_TYPE_FILTER (matrix_filter_get_type ())

The type for MatrixFilter.


matrix_filter_new ()

MatrixFilter *
matrix_filter_new (void);

matrix_filter_get_event_fields ()

GList *
matrix_filter_get_event_fields (MatrixFilter *self);

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

The event fields to include in the filtered events.

Parameters

self

the MatrixFilter instance to query

 

Returns

the value of the "event-fields" property


matrix_filter_set_event_fields ()

void
matrix_filter_set_event_fields (MatrixFilter *self,
                                GList *value);

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

The event fields to include in the filtered events.

Parameters

self

the MatrixFilter instance to modify

 

value

the new value of the "event-fields" property

 

matrix_filter_get_event_format ()

MatrixEventFormat
matrix_filter_get_event_format (MatrixFilter *self);

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

The desired event format for the filtered events (e.g. for matrix_api_sync())

Parameters

self

the MatrixFilter instance to query

 

Returns

the value of the "event-format" property


matrix_filter_set_event_format ()

void
matrix_filter_set_event_format (MatrixFilter *self,
                                MatrixEventFormat value);

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

The desired event format for the filtered events (e.g. for matrix_api_sync())

Parameters

self

the MatrixFilter instance to modify

 

value

the new value of the "event-format" property

 

matrix_filter_get_presence_filter ()

MatrixFilterRules *
matrix_filter_get_presence_filter (MatrixFilter *self);

Get and return the current value of the "presence-filter" property.

A filtering ruleset for presence events.

Parameters

self

the MatrixFilter instance to query

 

Returns

the value of the "presence-filter" property


matrix_filter_set_presence_filter ()

void
matrix_filter_set_presence_filter (MatrixFilter *self,
                                   MatrixFilterRules *value);

Set the value of the "presence-filter" property to value .

A filtering ruleset for presence events.

Parameters

self

the MatrixFilter instance to modify

 

value

the new value of the "presence-filter" property

 

matrix_filter_get_room_filter ()

MatrixRoomFilter *
matrix_filter_get_room_filter (MatrixFilter *self);

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

A filtering ruleset for room events.

Parameters

self

the MatrixFilter instance to query

 

Returns

the value of the "room-filter" property


matrix_filter_set_room_filter ()

void
matrix_filter_set_room_filter (MatrixFilter *self,
                               MatrixRoomFilter *value);

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

A filtering ruleset for room events.

Parameters

self

the MatrixFilter instance to modify

 

value

the new value of the "room-filter" property

 

MATRIX_TYPE_ROOM_FILTER

#define MATRIX_TYPE_ROOM_FILTER (matrix_room_filter_get_type ())

The type for MatrixRoomFilter.


matrix_room_filter_new ()

MatrixRoomFilter *
matrix_room_filter_new (void);

matrix_room_filter_get_include_leave ()

gboolean
matrix_room_filter_get_include_leave (MatrixRoomFilter *self);

Get and return the current value of the "include-leave" property.

If

true

, events for rooms that the user has left will be included in the filtered event list.

Parameters

self

the MatrixRoomFilter instance to query

 

Returns

the value of the "include-leave" property


matrix_room_filter_set_include_leave ()

void
matrix_room_filter_set_include_leave (MatrixRoomFilter *self,
                                      gboolean value);

Set the value of the "include-leave" property to value .

If

true

, events for rooms that the user has left will be included in the filtered event list.

Parameters

self

the MatrixRoomFilter instance to modify

 

value

the new value of the "include-leave" property

 

matrix_room_filter_get_ephemeral ()

MatrixFilterRules *
matrix_room_filter_get_ephemeral (MatrixRoomFilter *self);

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

Filtering rules for ephemeral events, i.e. events that are not recorded in the room history (typing notifications, receipts, etc.)

Parameters

self

the MatrixRoomFilter instance to query

 

Returns

the value of the "ephemeral" property


matrix_room_filter_set_ephemeral ()

void
matrix_room_filter_set_ephemeral (MatrixRoomFilter *self,
                                  MatrixFilterRules *value);

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

Filtering rules for ephemeral events, i.e. events that are not recorded in the room history (typing notifications, receipts, etc.)

Parameters

self

the MatrixRoomFilter instance to modify

 

value

the new value of the "ephemeral" property

 

matrix_room_filter_get_state ()

MatrixFilterRules *
matrix_room_filter_get_state (MatrixRoomFilter *self);

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

Filtering rules for state events.

Parameters

self

the MatrixRoomFilter instance to query

 

Returns

the value of the "state" property


matrix_room_filter_set_state ()

void
matrix_room_filter_set_state (MatrixRoomFilter *self,
                              MatrixFilterRules *value);

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

Filtering rules for state events.

Parameters

self

the MatrixRoomFilter instance to modify

 

value

the new value of the "state" property

 

matrix_room_filter_get_timeline ()

MatrixFilterRules *
matrix_room_filter_get_timeline (MatrixRoomFilter *self);

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

Filtering rules for timeline events.

Parameters

self

the MatrixRoomFilter instance to query

 

Returns

the value of the "timeline" property


matrix_room_filter_set_timeline ()

void
matrix_room_filter_set_timeline (MatrixRoomFilter *self,
                                 MatrixFilterRules *value);

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

Filtering rules for timeline events.

Parameters

self

the MatrixRoomFilter instance to modify

 

value

the new value of the "timeline" property

 

MATRIX_TYPE_FILTER_RULES

#define MATRIX_TYPE_FILTER_RULES (matrix_filter_rules_get_type ())

The type for MatrixFilterRules.


matrix_filter_rules_new ()

MatrixFilterRules *
matrix_filter_rules_new (void);

matrix_filter_rules_get_limit ()

guint
matrix_filter_rules_get_limit (MatrixFilterRules *self);

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

The limit of the count of returned events.

Parameters

self

the MatrixFilterRules instance to query

 

Returns

the value of the "limit" property


matrix_filter_rules_set_limit ()

void
matrix_filter_rules_set_limit (MatrixFilterRules *self,
                               guint value);

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

The limit of the count of returned events.

Parameters

self

the MatrixFilterRules instance to modify

 

value

the new value of the "limit" property

 

matrix_filter_rules_get_types ()

GList *
matrix_filter_rules_get_types (MatrixFilterRules *self);

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

List of message types to include in the filtered result.

Parameters

self

the MatrixFilterRules instance to query

 

Returns

the value of the "types" property


matrix_filter_rules_set_types ()

void
matrix_filter_rules_set_types (MatrixFilterRules *self,
                               GList *value);

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

List of message types to include in the filtered result.

Parameters

self

the MatrixFilterRules instance to modify

 

value

the new value of the "types" property

 

matrix_filter_rules_get_excluded_types ()

GList *
matrix_filter_rules_get_excluded_types
                               (MatrixFilterRules *self);

Get and return the current value of the "excluded-types" property.

List of message types to exclude from the filtered result. A matching type will be excluded from the result even if it is listed in the types to include.

Parameters

self

the MatrixFilterRules instance to query

 

Returns

the value of the "excluded-types" property


matrix_filter_rules_set_excluded_types ()

void
matrix_filter_rules_set_excluded_types
                               (MatrixFilterRules *self,
                                GList *value);

Set the value of the "excluded-types" property to value .

List of message types to exclude from the filtered result. A matching type will be excluded from the result even if it is listed in the types to include.

Parameters

self

the MatrixFilterRules instance to modify

 

value

the new value of the "excluded-types" property

 

matrix_filter_rules_get_senders ()

GList *
matrix_filter_rules_get_senders (MatrixFilterRules *self);

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

List of senders to include in the filtered results.

Parameters

self

the MatrixFilterRules instance to query

 

Returns

the value of the "senders" property


matrix_filter_rules_set_senders ()

void
matrix_filter_rules_set_senders (MatrixFilterRules *self,
                                 GList *value);

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

List of senders to include in the filtered results.

Parameters

self

the MatrixFilterRules instance to modify

 

value

the new value of the "senders" property

 

matrix_filter_rules_get_excluded_senders ()

GList *
matrix_filter_rules_get_excluded_senders
                               (MatrixFilterRules *self);

Get and return the current value of the "excluded-senders" property.

List of senders to exclude from the filtered result. A matching sender will be excluded from the result even if it is listed in the senders to include.

Parameters

self

the MatrixFilterRules instance to query

 

Returns

the value of the "excluded-senders" property


matrix_filter_rules_set_excluded_senders ()

void
matrix_filter_rules_set_excluded_senders
                               (MatrixFilterRules *self,
                                GList *value);

Set the value of the "excluded-senders" property to value .

List of senders to exclude from the filtered result. A matching sender will be excluded from the result even if it is listed in the senders to include.

Parameters

self

the MatrixFilterRules instance to modify

 

value

the new value of the "excluded-senders" property

 

matrix_filter_rules_get_rooms ()

GList *
matrix_filter_rules_get_rooms (MatrixFilterRules *self);

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

List of rooms to include in the filtered results.

Parameters

self

the MatrixFilterRules instance to query

 

Returns

the value of the "rooms" property


matrix_filter_rules_set_rooms ()

void
matrix_filter_rules_set_rooms (MatrixFilterRules *self,
                               GList *value);

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

List of rooms to include in the filtered results.

Parameters

self

the MatrixFilterRules instance to modify

 

value

the new value of the "rooms" property

 

matrix_filter_rules_get_excluded_rooms ()

GList *
matrix_filter_rules_get_excluded_rooms
                               (MatrixFilterRules *self);

Get and return the current value of the "excluded-rooms" property.

List of rooms to exclude from the filtered result. A matching room will be excluded from the result even if it is listed in the rooms to include.

Parameters

self

the MatrixFilterRules instance to query

 

Returns

the value of the "excluded-rooms" property


matrix_filter_rules_set_excluded_rooms ()

void
matrix_filter_rules_set_excluded_rooms
                               (MatrixFilterRules *self,
                                GList *value);

Set the value of the "excluded-rooms" property to value .

List of rooms to exclude from the filtered result. A matching room will be excluded from the result even if it is listed in the rooms to include.

Parameters

self

the MatrixFilterRules instance to modify

 

value

the new value of the "excluded-rooms" property

 

MATRIX_TYPE_3PID_CREDENTIAL

#define MATRIX_TYPE_3PID_CREDENTIAL (matrix_3pid_credential_get_type ())

The type for Matrix3PidCredential.


matrix_3pid_credential_new ()

Matrix3PidCredential *
matrix_3pid_credential_new (void);

matrix_3pid_credential_get_id_server ()

const gchar *
matrix_3pid_credential_get_id_server (Matrix3PidCredential *self);

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

The Identity Server used for this credential.

Parameters

self

the Matrix3PidCredential instance to query

 

Returns

the value of the "id-server" property


matrix_3pid_credential_set_id_server ()

void
matrix_3pid_credential_set_id_server (Matrix3PidCredential *self,
                                      const gchar *value);

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

The Identity Server used for this credential.

Parameters

self

the Matrix3PidCredential instance to modify

 

value

the new value of the "id-server" property

 

matrix_3pid_credential_get_session_id ()

const gchar *
matrix_3pid_credential_get_session_id (Matrix3PidCredential *self);

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

The session identifier got from the Identity Server.

Parameters

self

the Matrix3PidCredential instance to query

 

Returns

the value of the "session-id" property


matrix_3pid_credential_set_session_id ()

void
matrix_3pid_credential_set_session_id (Matrix3PidCredential *self,
                                       const gchar *value);

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

The session identifier got from the Identity Server.

Parameters

self

the Matrix3PidCredential instance to modify

 

value

the new value of the "session-id" property

 

matrix_3pid_credential_get_client_secret ()

const gchar *
matrix_3pid_credential_get_client_secret
                               (Matrix3PidCredential *self);

Get and return the current value of the "client-secret" property.

The client secret that was used in the session with the Identity Server.

Parameters

self

the Matrix3PidCredential instance to query

 

Returns

the value of the "client-secret" property


matrix_3pid_credential_set_client_secret ()

void
matrix_3pid_credential_set_client_secret
                               (Matrix3PidCredential *self,
                                const gchar *value);

Set the value of the "client-secret" property to value .

The client secret that was used in the session with the Identity Server.

Parameters

self

the Matrix3PidCredential instance to modify

 

value

the new value of the "client-secret" property

 

MATRIX_TYPE_PUSHER

#define MATRIX_TYPE_PUSHER (matrix_pusher_get_type ())

The type for MatrixPusher.


matrix_pusher_new ()

MatrixPusher *
matrix_pusher_new (void);

matrix_pusher_get_device_display_name ()

const gchar *
matrix_pusher_get_device_display_name (MatrixPusher *self);

Get and return the current value of the "device-display-name" property.

A device display name.

Parameters

self

the MatrixPusher instance to query

 

Returns

the value of the "device-display-name" property


matrix_pusher_set_device_display_name ()

void
matrix_pusher_set_device_display_name (MatrixPusher *self,
                                       const gchar *value);

Set the value of the "device-display-name" property to value .

A device display name.

Parameters

self

the MatrixPusher instance to modify

 

value

the new value of the "device-display-name" property

 

matrix_pusher_get_app_display_name ()

const gchar *
matrix_pusher_get_app_display_name (MatrixPusher *self);

Get and return the current value of the "app-display-name" property.

An application display name.

Parameters

self

the MatrixPusher instance to query

 

Returns

the value of the "app-display-name" property


matrix_pusher_set_app_display_name ()

void
matrix_pusher_set_app_display_name (MatrixPusher *self,
                                    const gchar *value);

Set the value of the "app-display-name" property to value .

An application display name.

Parameters

self

the MatrixPusher instance to modify

 

value

the new value of the "app-display-name" property

 

matrix_pusher_get_app_id ()

const gchar *
matrix_pusher_get_app_id (MatrixPusher *self);

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

An application ID.

Parameters

self

the MatrixPusher instance to query

 

Returns

the value of the "app-id" property


matrix_pusher_set_app_id ()

void
matrix_pusher_set_app_id (MatrixPusher *self,
                          const gchar *value);

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

An application ID.

Parameters

self

the MatrixPusher instance to modify

 

value

the new value of the "app-id" property

 

matrix_pusher_get_append ()

gboolean
matrix_pusher_get_append (MatrixPusher *self);

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

If

true

, the homeserver should add another pusher with the given push key and app ID in addition to any others with different user IDs. Otherwise, the homeserver must remove any other pushers with the same App ID and pushkey for different users.

Parameters

self

the MatrixPusher instance to query

 

Returns

the value of the "append" property


matrix_pusher_set_append ()

void
matrix_pusher_set_append (MatrixPusher *self,
                          gboolean value);

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

If

true

, the homeserver should add another pusher with the given push key and app ID in addition to any others with different user IDs. Otherwise, the homeserver must remove any other pushers with the same App ID and pushkey for different users.

Parameters

self

the MatrixPusher instance to modify

 

value

the new value of the "append" property

 

matrix_pusher_get_kind ()

const gchar *
matrix_pusher_get_kind (MatrixPusher *self);

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

The kind of the pusher.

http

makes a pusher that sends HTTP pokes.

null

deletes the pusher.

Parameters

self

the MatrixPusher instance to query

 

Returns

the value of the "kind" property


matrix_pusher_set_kind ()

void
matrix_pusher_set_kind (MatrixPusher *self,
                        const gchar *value);

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

The kind of the pusher.

http

makes a pusher that sends HTTP pokes.

null

deletes the pusher.

Parameters

self

the MatrixPusher instance to modify

 

value

the new value of the "kind" property

 

matrix_pusher_get_lang ()

const gchar *
matrix_pusher_get_lang (MatrixPusher *self);

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

The preferred language for receiving notifications, e.g.

en

or

en-US

.

Parameters

self

the MatrixPusher instance to query

 

Returns

the value of the "lang" property


matrix_pusher_set_lang ()

void
matrix_pusher_set_lang (MatrixPusher *self,
                        const gchar *value);

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

The preferred language for receiving notifications, e.g.

en

or

en-US

.

Parameters

self

the MatrixPusher instance to modify

 

value

the new value of the "lang" property

 

matrix_pusher_get_profile_tag ()

const gchar *
matrix_pusher_get_profile_tag (MatrixPusher *self);

Get and return the current value of the "profile-tag" property.

A string that determines what set of device rules will be matched when evaluating push rules for this pusher. It is an arbitrary string. Multiple devices may use the same profile tag. It is advised that when an app's data is copied or restored to a different device, this value remain the same. Client apps should offer ways to change the profile tag, optionally copying rules from the old profile tag. Maximum length is 32 bytes. If the profile tag is longer than this, it will be truncated

Parameters

self

the MatrixPusher instance to query

 

Returns

the value of the "profile-tag" property


matrix_pusher_set_profile_tag ()

void
matrix_pusher_set_profile_tag (MatrixPusher *self,
                               const gchar *value);

Set the value of the "profile-tag" property to value .

A string that determines what set of device rules will be matched when evaluating push rules for this pusher. It is an arbitrary string. Multiple devices may use the same profile tag. It is advised that when an app's data is copied or restored to a different device, this value remain the same. Client apps should offer ways to change the profile tag, optionally copying rules from the old profile tag. Maximum length is 32 bytes. If the profile tag is longer than this, it will be truncated

Parameters

self

the MatrixPusher instance to modify

 

value

the new value of the "profile-tag" property

 

matrix_pusher_get_pushkey ()

const gchar *
matrix_pusher_get_pushkey (MatrixPusher *self);

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

A unique identifier for this pusher. The value you should use for this is the routing or destination address information for the notification, for example, the APNS token for APNS or the Registration ID for GCM. If your notification client has no such concept, use any unique identifier. Maximum length is 512 bytes. If pushkey is longer than this, it will be truncated

Parameters

self

the MatrixPusher instance to query

 

Returns

the value of the "pushkey" property


matrix_pusher_set_pushkey ()

void
matrix_pusher_set_pushkey (MatrixPusher *self,
                           const gchar *value);

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

A unique identifier for this pusher. The value you should use for this is the routing or destination address information for the notification, for example, the APNS token for APNS or the Registration ID for GCM. If your notification client has no such concept, use any unique identifier. Maximum length is 512 bytes. If pushkey is longer than this, it will be truncated

Parameters

self

the MatrixPusher instance to modify

 

value

the new value of the "pushkey" property

 

matrix_pusher_get_data ()

JsonNode *
matrix_pusher_get_data (MatrixPusher *self);

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

a dictionary of information for the pusher implementation itself. For example, if kind is

http

, this should contain an

url

member, which is the URL to use to send notifications to. This function creates a deep copy of the data, so it can be freed after this call.

Parameters

self

the MatrixPusher instance to query

 

Returns

the value of the "data" property


matrix_pusher_set_data ()

void
matrix_pusher_set_data (MatrixPusher *self,
                        JsonNode *value);

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

a dictionary of information for the pusher implementation itself. For example, if kind is

http

, this should contain an

url

member, which is the URL to use to send notifications to. This function creates a deep copy of the data, so it can be freed after this call.

Parameters

self

the MatrixPusher instance to modify

 

value

the new value of the "data" property

 

MATRIX_TYPE_UNSIGNED_EVENT_DATA

#define MATRIX_TYPE_UNSIGNED_EVENT_DATA (matrix_unsigned_event_data_get_type ())

The type for MatrixUnsignedEventData.


matrix_unsigned_event_data_new_from_json ()

MatrixUnsignedEventData *
matrix_unsigned_event_data_new_from_json
                               (JsonNode *json_data);

Create an UnsignedEventData object based on param json_data.

Parameters

json_data

 

 

matrix_unsigned_event_data_new ()

MatrixUnsignedEventData *
matrix_unsigned_event_data_new (void);

matrix_unsigned_event_data_get_age ()

guint
matrix_unsigned_event_data_get_age (MatrixUnsignedEventData *self);

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

The age of the event, in seconds.

Parameters

self

the MatrixUnsignedEventData instance to query

 

Returns

the value of the "age" property


matrix_unsigned_event_data_set_age ()

void
matrix_unsigned_event_data_set_age (MatrixUnsignedEventData *self,
                                    guint value);

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

The age of the event, in seconds.

Parameters

self

the MatrixUnsignedEventData instance to modify

 

value

the new value of the "age" property

 

matrix_unsigned_event_data_get_redact_reason ()

const gchar *
matrix_unsigned_event_data_get_redact_reason
                               (MatrixUnsignedEventData *self);

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

The reason of redaction, if any.

Parameters

self

the MatrixUnsignedEventData instance to query

 

Returns

the value of the "redact-reason" property


matrix_unsigned_event_data_set_redact_reason ()

void
matrix_unsigned_event_data_set_redact_reason
                               (MatrixUnsignedEventData *self,
                                const gchar *value);

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

The reason of redaction, if any.

Parameters

self

the MatrixUnsignedEventData instance to modify

 

value

the new value of the "redact-reason" property

 

matrix_unsigned_event_data_get_transaction_id ()

const gchar *
matrix_unsigned_event_data_get_transaction_id
                               (MatrixUnsignedEventData *self);

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

The transaction ID of the message.

Parameters

self

the MatrixUnsignedEventData instance to query

 

Returns

the value of the "transaction-id" property


matrix_unsigned_event_data_set_transaction_id ()

void
matrix_unsigned_event_data_set_transaction_id
                               (MatrixUnsignedEventData *self,
                                const gchar *value);

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

The transaction ID of the message.

Parameters

self

the MatrixUnsignedEventData instance to modify

 

value

the new value of the "transaction-id" property

 

MATRIX_TYPE_EVENT_CONTEXT

#define MATRIX_TYPE_EVENT_CONTEXT (matrix_event_context_get_type ())

The type for MatrixEventContext.


matrix_event_context_new ()

MatrixEventContext *
matrix_event_context_new (void);

matrix_event_context_get_before_limit ()

gint *
matrix_event_context_get_before_limit (MatrixEventContext *self);

Get and return the current value of the "before-limit" property.

Parameters

self

the MatrixEventContext instance to query

 

Returns

the value of the "before-limit" property


matrix_event_context_set_before_limit ()

void
matrix_event_context_set_before_limit (MatrixEventContext *self,
                                       gint *value);

Set the value of the "before-limit" property to value .

Parameters

self

the MatrixEventContext instance to modify

 

value

the new value of the "before-limit" property

 

matrix_event_context_get_after_limit ()

gint *
matrix_event_context_get_after_limit (MatrixEventContext *self);

Get and return the current value of the "after-limit" property.

Parameters

self

the MatrixEventContext instance to query

 

Returns

the value of the "after-limit" property


matrix_event_context_set_after_limit ()

void
matrix_event_context_set_after_limit (MatrixEventContext *self,
                                      gint *value);

Set the value of the "after-limit" property to value .

Parameters

self

the MatrixEventContext instance to modify

 

value

the new value of the "after-limit" property

 

matrix_event_context_get_include_profile ()

gboolean *
matrix_event_context_get_include_profile
                               (MatrixEventContext *self);

Get and return the current value of the "include-profile" property.

Parameters

self

the MatrixEventContext instance to query

 

Returns

the value of the "include-profile" property


matrix_event_context_set_include_profile ()

void
matrix_event_context_set_include_profile
                               (MatrixEventContext *self,
                                gboolean *value);

Set the value of the "include-profile" property to value .

Parameters

self

the MatrixEventContext instance to modify

 

value

the new value of the "include-profile" property

 

MATRIX_TYPE_SEARCH_GROUPING

#define MATRIX_TYPE_SEARCH_GROUPING (matrix_search_grouping_get_type ())

The type for MatrixSearchGrouping.


matrix_search_grouping_new ()

MatrixSearchGrouping *
matrix_search_grouping_new (void);

matrix_search_grouping_get_key ()

MatrixSearchGroupBy *
matrix_search_grouping_get_key (MatrixSearchGrouping *self);

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

Parameters

self

the MatrixSearchGrouping instance to query

 

Returns

the value of the "key" property


matrix_search_grouping_set_key ()

void
matrix_search_grouping_set_key (MatrixSearchGrouping *self,
                                MatrixSearchGroupBy *value);

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

Parameters

self

the MatrixSearchGrouping instance to modify

 

value

the new value of the "key" property

 

MATRIX_TYPE_SEARCH_GROUPINGS

#define MATRIX_TYPE_SEARCH_GROUPINGS (matrix_search_groupings_get_type ())

The type for MatrixSearchGroupings.


matrix_search_groupings_new ()

MatrixSearchGroupings *
matrix_search_groupings_new (void);

matrix_search_groupings_get_group_by ()

GList *
matrix_search_groupings_get_group_by (MatrixSearchGroupings *self);

Get and return the current value of the "group-by" property.

Parameters

self

the MatrixSearchGroupings instance to query

 

Returns

the value of the "group-by" property


matrix_search_groupings_set_group_by ()

void
matrix_search_groupings_set_group_by (MatrixSearchGroupings *self,
                                      GList *value);

Set the value of the "group-by" property to value .

Parameters

self

the MatrixSearchGroupings instance to modify

 

value

the new value of the "group-by" property

 

MATRIX_TYPE_SEARCH_ROOM_EVENTS

#define MATRIX_TYPE_SEARCH_ROOM_EVENTS (matrix_search_room_events_get_type ())

The type for MatrixSearchRoomEvents.


matrix_search_room_events_new ()

MatrixSearchRoomEvents *
matrix_search_room_events_new (void);

matrix_search_room_events_get_order_by ()

MatrixSearchOrder *
matrix_search_room_events_get_order_by
                               (MatrixSearchRoomEvents *self);

Get and return the current value of the "order-by" property.

Parameters

self

the MatrixSearchRoomEvents instance to query

 

Returns

the value of the "order-by" property


matrix_search_room_events_set_order_by ()

void
matrix_search_room_events_set_order_by
                               (MatrixSearchRoomEvents *self,
                                MatrixSearchOrder *value);

Set the value of the "order-by" property to value .

Parameters

self

the MatrixSearchRoomEvents instance to modify

 

value

the new value of the "order-by" property

 

matrix_search_room_events_get_keys ()

GList *
matrix_search_room_events_get_keys (MatrixSearchRoomEvents *self);

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

Parameters

self

the MatrixSearchRoomEvents instance to query

 

Returns

the value of the "keys" property


matrix_search_room_events_set_keys ()

void
matrix_search_room_events_set_keys (MatrixSearchRoomEvents *self,
                                    GList *value);

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

Parameters

self

the MatrixSearchRoomEvents instance to modify

 

value

the new value of the "keys" property

 

matrix_search_room_events_get_event_context ()

MatrixEventContext *
matrix_search_room_events_get_event_context
                               (MatrixSearchRoomEvents *self);

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

Parameters

self

the MatrixSearchRoomEvents instance to query

 

Returns

the value of the "event-context" property


matrix_search_room_events_set_event_context ()

void
matrix_search_room_events_set_event_context
                               (MatrixSearchRoomEvents *self,
                                MatrixEventContext *value);

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

Parameters

self

the MatrixSearchRoomEvents instance to modify

 

value

the new value of the "event-context" property

 

matrix_search_room_events_get_include_state ()

gboolean *
matrix_search_room_events_get_include_state
                               (MatrixSearchRoomEvents *self);

Get and return the current value of the "include-state" property.

Parameters

self

the MatrixSearchRoomEvents instance to query

 

Returns

the value of the "include-state" property


matrix_search_room_events_set_include_state ()

void
matrix_search_room_events_set_include_state
                               (MatrixSearchRoomEvents *self,
                                gboolean *value);

Set the value of the "include-state" property to value .

Parameters

self

the MatrixSearchRoomEvents instance to modify

 

value

the new value of the "include-state" property

 

matrix_search_room_events_get_filter_id ()

const gchar *
matrix_search_room_events_get_filter_id
                               (MatrixSearchRoomEvents *self);

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

Parameters

self

the MatrixSearchRoomEvents instance to query

 

Returns

the value of the "filter-id" property


matrix_search_room_events_set_filter_id ()

void
matrix_search_room_events_set_filter_id
                               (MatrixSearchRoomEvents *self,
                                const gchar *value);

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

Parameters

self

the MatrixSearchRoomEvents instance to modify

 

value

the new value of the "filter-id" property

 

matrix_search_room_events_get_filter ()

MatrixFilter *
matrix_search_room_events_get_filter (MatrixSearchRoomEvents *self);

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

Parameters

self

the MatrixSearchRoomEvents instance to query

 

Returns

the value of the "filter" property


matrix_search_room_events_set_filter ()

void
matrix_search_room_events_set_filter (MatrixSearchRoomEvents *self,
                                      MatrixFilter *value);

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

Parameters

self

the MatrixSearchRoomEvents instance to modify

 

value

the new value of the "filter" property

 

matrix_search_room_events_get_search_term ()

const gchar *
matrix_search_room_events_get_search_term
                               (MatrixSearchRoomEvents *self);

Get and return the current value of the "search-term" property.

Parameters

self

the MatrixSearchRoomEvents instance to query

 

Returns

the value of the "search-term" property


matrix_search_room_events_set_search_term ()

void
matrix_search_room_events_set_search_term
                               (MatrixSearchRoomEvents *self,
                                const gchar *value);

Set the value of the "search-term" property to value .

Parameters

self

the MatrixSearchRoomEvents instance to modify

 

value

the new value of the "search-term" property

 

matrix_search_room_events_get_groupings ()

MatrixSearchGroupings *
matrix_search_room_events_get_groupings
                               (MatrixSearchRoomEvents *self);

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

Parameters

self

the MatrixSearchRoomEvents instance to query

 

Returns

the value of the "groupings" property


matrix_search_room_events_set_groupings ()

void
matrix_search_room_events_set_groupings
                               (MatrixSearchRoomEvents *self,
                                MatrixSearchGroupings *value);

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

Parameters

self

the MatrixSearchRoomEvents instance to modify

 

value

the new value of the "groupings" property

 

MATRIX_TYPE_SEARCH_CATEGORIES

#define MATRIX_TYPE_SEARCH_CATEGORIES (matrix_search_categories_get_type ())

The type for MatrixSearchCategories.


matrix_search_categories_new ()

MatrixSearchCategories *
matrix_search_categories_new (void);

matrix_search_categories_get_room_events ()

MatrixSearchRoomEvents *
matrix_search_categories_get_room_events
                               (MatrixSearchCategories *self);

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

Parameters

self

the MatrixSearchCategories instance to query

 

Returns

the value of the "room-events" property


matrix_search_categories_set_room_events ()

void
matrix_search_categories_set_room_events
                               (MatrixSearchCategories *self,
                                MatrixSearchRoomEvents *value);

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

Parameters

self

the MatrixSearchCategories instance to modify

 

value

the new value of the "room-events" property

 

Types and Values

struct MatrixJsonCompact

struct MatrixJsonCompact {
	GTypeInstance parent_instance;
	volatile int ref_count;
	MatrixJsonCompactPrivate * priv;
};

Abstract parent class for classes that can be saved to JSON.


struct MatrixJsonCompactClass

struct MatrixJsonCompactClass {
	GTypeClass parent_class;
	void (*finalize) (MatrixJsonCompact *self);
	JsonNode* (*get_json_node) (MatrixJsonCompact* self, GError** error);
};

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

Members

GTypeClass parent_class;

the parent class structure

 

finalize ()

   

get_json_node ()

virtual method called by matrix_json_compact_get_json_node()

 

struct MatrixFilter

struct MatrixFilter {
	MatrixJsonCompact parent_instance;
	MatrixFilterPrivate * priv;
};

Class to hold a filter.


struct MatrixFilterClass

struct MatrixFilterClass {
	MatrixJsonCompactClass parent_class;
};

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

Members

MatrixJsonCompactClass parent_class;

the parent class structure

 

struct MatrixRoomFilter

struct MatrixRoomFilter {
	MatrixJsonCompact parent_instance;
	MatrixRoomFilterPrivate * priv;
};

Class to hold room filters.


struct MatrixRoomFilterClass

struct MatrixRoomFilterClass {
	MatrixJsonCompactClass parent_class;
};

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

Members

MatrixJsonCompactClass parent_class;

the parent class structure

 

struct MatrixFilterRules

struct MatrixFilterRules {
	MatrixJsonCompact parent_instance;
	MatrixFilterRulesPrivate * priv;
};

Class to hold filtering rules.


struct MatrixFilterRulesClass

struct MatrixFilterRulesClass {
	MatrixJsonCompactClass parent_class;
};

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

Members

MatrixJsonCompactClass parent_class;

the parent class structure

 

struct Matrix3PidCredential

struct Matrix3PidCredential {
	MatrixJsonCompact parent_instance;
	Matrix3PidCredentialPrivate * priv;
};

Class to hold 3rd party credential related data.


struct Matrix3PidCredentialClass

struct Matrix3PidCredentialClass {
	MatrixJsonCompactClass parent_class;
};

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

Members

MatrixJsonCompactClass parent_class;

the parent class structure

 

struct MatrixPusher

struct MatrixPusher {
	MatrixJsonCompact parent_instance;
	MatrixPusherPrivate * priv;
};

Class to hold pusher related data.


struct MatrixPusherClass

struct MatrixPusherClass {
	MatrixJsonCompactClass parent_class;
};

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

Members

MatrixJsonCompactClass parent_class;

the parent class structure

 

struct MatrixUnsignedEventData

struct MatrixUnsignedEventData {
	MatrixJsonCompact parent_instance;
	MatrixUnsignedEventDataPrivate * priv;
};

Class to hold unsigned event data, like event age, redact reason or a transaction ID.


struct MatrixUnsignedEventDataClass

struct MatrixUnsignedEventDataClass {
	MatrixJsonCompactClass parent_class;
};

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

Members

MatrixJsonCompactClass parent_class;

the parent class structure

 

struct MatrixEventContext

struct MatrixEventContext {
	MatrixJsonCompact parent_instance;
	MatrixEventContextPrivate * priv;
};

struct MatrixEventContextClass

struct MatrixEventContextClass {
	MatrixJsonCompactClass parent_class;
};

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

Members

MatrixJsonCompactClass parent_class;

the parent class structure

 

struct MatrixSearchGrouping

struct MatrixSearchGrouping {
	MatrixJsonCompact parent_instance;
	MatrixSearchGroupingPrivate * priv;
};

struct MatrixSearchGroupingClass

struct MatrixSearchGroupingClass {
	MatrixJsonCompactClass parent_class;
};

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

Members

MatrixJsonCompactClass parent_class;

the parent class structure

 

struct MatrixSearchGroupings

struct MatrixSearchGroupings {
	MatrixJsonCompact parent_instance;
	MatrixSearchGroupingsPrivate * priv;
};

struct MatrixSearchGroupingsClass

struct MatrixSearchGroupingsClass {
	MatrixJsonCompactClass parent_class;
};

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

Members

MatrixJsonCompactClass parent_class;

the parent class structure

 

struct MatrixSearchRoomEvents

struct MatrixSearchRoomEvents {
	MatrixJsonCompact parent_instance;
	MatrixSearchRoomEventsPrivate * priv;
};

struct MatrixSearchRoomEventsClass

struct MatrixSearchRoomEventsClass {
	MatrixJsonCompactClass parent_class;
};

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

Members

MatrixJsonCompactClass parent_class;

the parent class structure

 

struct MatrixSearchCategories

struct MatrixSearchCategories {
	MatrixJsonCompact parent_instance;
	MatrixSearchCategoriesPrivate * priv;
};

struct MatrixSearchCategoriesClass

struct MatrixSearchCategoriesClass {
	MatrixJsonCompactClass parent_class;
};

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

Members

MatrixJsonCompactClass parent_class;

the parent class structure