matrix-types

matrix-types

Functions

Types and Values

Description

Functions

matrix_error_quark ()

GQuark
matrix_error_quark (void);

matrix_file_info_set_from_json ()

void
matrix_file_info_set_from_json (MatrixFileInfo *self,
                                JsonNode *json_data);

Parameters

self

the MatrixFileInfo instance

 

json_data

 

 

matrix_file_info_get_json_node ()

JsonNode *
matrix_file_info_get_json_node (MatrixFileInfo *self,
                                GError **error);

Parameters

self

the MatrixFileInfo instance

 

error

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

[error-domains MatrixError]

matrix_file_info_dup ()

MatrixFileInfo *
matrix_file_info_dup (const MatrixFileInfo *self);

Creates a copy of self.

See also: matrix_file_info_copy(), matrix_file_info_destroy(), matrix_file_info_free()

Parameters

self

the instance to duplicate

 

Returns

a copy of self , free with matrix_file_info_free()


matrix_file_info_free ()

void
matrix_file_info_free (MatrixFileInfo *self);

Frees the heap-allocated struct.

See also: matrix_file_info_dup(), matrix_file_info_copy(), matrix_file_info_destroy()

Parameters

self

the struct to free

 

matrix_file_info_copy ()

void
matrix_file_info_copy (const MatrixFileInfo *self,
                       MatrixFileInfo *dest);

Creates a copy of self.

See also: matrix_file_info_dup(), matrix_file_info_destroy(), matrix_file_info_free()

Parameters

self

the struct to copy

 

dest

a unused struct. Use matrix_file_info_destroy() to free the content.

 

matrix_file_info_destroy ()

void
matrix_file_info_destroy (MatrixFileInfo *self);

Frees the content of the struct pointed by self .

See also: matrix_file_info_dup(), matrix_file_info_copy(), matrix_file_info_free()

Parameters

self

the struct to destroy

 

matrix_image_info_set_from_json ()

void
matrix_image_info_set_from_json (MatrixImageInfo *self,
                                 JsonNode *json_data);

Parameters

self

the MatrixImageInfo instance

 

json_data

 

 

matrix_image_info_get_json_node ()

JsonNode *
matrix_image_info_get_json_node (MatrixImageInfo *self,
                                 GError **error);

Parameters

self

the MatrixImageInfo instance

 

error

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

[error-domains MatrixError]

matrix_image_info_dup ()

MatrixImageInfo *
matrix_image_info_dup (const MatrixImageInfo *self);

Creates a copy of self.

See also: matrix_image_info_copy(), matrix_image_info_destroy(), matrix_image_info_free()

Parameters

self

the instance to duplicate

 

Returns

a copy of self , free with matrix_image_info_free()


matrix_image_info_free ()

void
matrix_image_info_free (MatrixImageInfo *self);

Frees the heap-allocated struct.

See also: matrix_image_info_dup(), matrix_image_info_copy(), matrix_image_info_destroy()

Parameters

self

the struct to free

 

matrix_image_info_copy ()

void
matrix_image_info_copy (const MatrixImageInfo *self,
                        MatrixImageInfo *dest);

Creates a copy of self.

See also: matrix_image_info_dup(), matrix_image_info_destroy(), matrix_image_info_free()

Parameters

self

the struct to copy

 

dest

a unused struct. Use matrix_image_info_destroy() to free the content.

 

matrix_image_info_destroy ()

void
matrix_image_info_destroy (MatrixImageInfo *self);

Frees the content of the struct pointed by self .

See also: matrix_image_info_dup(), matrix_image_info_copy(), matrix_image_info_free()

Parameters

self

the struct to destroy

 

matrix_audio_info_set_from_json ()

void
matrix_audio_info_set_from_json (MatrixAudioInfo *self,
                                 JsonNode *json_data);

Parameters

self

the MatrixAudioInfo instance

 

json_data

 

 

matrix_audio_info_get_json_node ()

JsonNode *
matrix_audio_info_get_json_node (MatrixAudioInfo *self,
                                 GError **error);

Parameters

self

the MatrixAudioInfo instance

 

error

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

[error-domains MatrixError]

matrix_audio_info_dup ()

MatrixAudioInfo *
matrix_audio_info_dup (const MatrixAudioInfo *self);

Creates a copy of self.

See also: matrix_audio_info_copy(), matrix_audio_info_destroy(), matrix_audio_info_free()

Parameters

self

the instance to duplicate

 

Returns

a copy of self , free with matrix_audio_info_free()


matrix_audio_info_free ()

void
matrix_audio_info_free (MatrixAudioInfo *self);

Frees the heap-allocated struct.

See also: matrix_audio_info_dup(), matrix_audio_info_copy(), matrix_audio_info_destroy()

Parameters

self

the struct to free

 

matrix_audio_info_copy ()

void
matrix_audio_info_copy (const MatrixAudioInfo *self,
                        MatrixAudioInfo *dest);

Creates a copy of self.

See also: matrix_audio_info_dup(), matrix_audio_info_destroy(), matrix_audio_info_free()

Parameters

self

the struct to copy

 

dest

a unused struct. Use matrix_audio_info_destroy() to free the content.

 

matrix_audio_info_destroy ()

void
matrix_audio_info_destroy (MatrixAudioInfo *self);

Frees the content of the struct pointed by self .

See also: matrix_audio_info_dup(), matrix_audio_info_copy(), matrix_audio_info_free()

Parameters

self

the struct to destroy

 

matrix_video_info_set_from_json ()

void
matrix_video_info_set_from_json (MatrixVideoInfo *self,
                                 JsonNode *json_data);

Parameters

self

the MatrixVideoInfo instance

 

json_data

 

 

matrix_video_info_get_json_node ()

JsonNode *
matrix_video_info_get_json_node (MatrixVideoInfo *self,
                                 GError **error);

Parameters

self

the MatrixVideoInfo instance

 

error

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

[error-domains MatrixError]

matrix_video_info_dup ()

MatrixVideoInfo *
matrix_video_info_dup (const MatrixVideoInfo *self);

Creates a copy of self.

See also: matrix_video_info_copy(), matrix_video_info_destroy(), matrix_video_info_free()

Parameters

self

the instance to duplicate

 

Returns

a copy of self , free with matrix_video_info_free()


matrix_video_info_free ()

void
matrix_video_info_free (MatrixVideoInfo *self);

Frees the heap-allocated struct.

See also: matrix_video_info_dup(), matrix_video_info_copy(), matrix_video_info_destroy()

Parameters

self

the struct to free

 

matrix_video_info_copy ()

void
matrix_video_info_copy (const MatrixVideoInfo *self,
                        MatrixVideoInfo *dest);

Creates a copy of self.

See also: matrix_video_info_dup(), matrix_video_info_destroy(), matrix_video_info_free()

Parameters

self

the struct to copy

 

dest

a unused struct. Use matrix_video_info_destroy() to free the content.

 

matrix_video_info_destroy ()

void
matrix_video_info_destroy (MatrixVideoInfo *self);

Frees the content of the struct pointed by self .

See also: matrix_video_info_dup(), matrix_video_info_copy(), matrix_video_info_free()

Parameters

self

the struct to destroy

 

Types and Values

enum MatrixAccountKind

User account types.

Members

MATRIX_ACCOUNT_KIND_DEFAULT

   

MATRIX_ACCOUNT_KIND_USER

   

MATRIX_ACCOUNT_KIND_GUEST

   

enum MatrixEventDirection

Direction of events when requesting an event context.

Members

MATRIX_EVENT_DIRECTION_FORWARD

   

MATRIX_EVENT_DIRECTION_BACKWARD

   

enum MatrixEventFormat

Event format received when synchronizing.

Members

MATRIX_EVENT_FORMAT_DEFAULT

   

MATRIX_EVENT_FORMAT_CLIENT

   

MATRIX_EVENT_FORMAT_FEDERATION

   

enum MatrixPresence

Presence values for matrix_api_set_user_presence() and other presence related queries.

Members

MATRIX_PRESENCE_UNKNOWN

   

MATRIX_PRESENCE_ONLINE

   

MATRIX_PRESENCE_OFFLINE

   

MATRIX_PRESENCE_UNAVAILABLE

   

MATRIX_PRESENCE_FREE_FOR_CHAT

   

enum MatrixPusherConditionKind

Condition types for pushers.

Members

MATRIX_PUSHER_CONDITION_KIND_EVENT_MATCH

   

MATRIX_PUSHER_CONDITION_KIND_PROFILE_TAG

   

MATRIX_PUSHER_CONDITION_KIND_CONTAINS_DISPLAY_NAME

   

MATRIX_PUSHER_CONDITION_KIND_ROOM_MEMBER_COUNT

   

enum MatrixPusherKind

Pusher types.

Members

MATRIX_PUSHER_KIND_OVERRIDE

   

MATRIX_PUSHER_KIND_SENDER

   

MATRIX_PUSHER_KIND_ROOM

   

MATRIX_PUSHER_KIND_CONTENT

   

MATRIX_PUSHER_KIND_UNDERRIDE

   

enum MatrixReceiptType

Receipt types of acknowledgment.

Members

MATRIX_RECEIPT_TYPE_READ

   

enum MatrixResizeMethod

Resizing methods for matrix_api_media_thumbnail().

Members

MATRIX_RESIZE_METHOD_DEFAULT

   

MATRIX_RESIZE_METHOD_CROP

   

MATRIX_RESIZE_METHOD_SCALE

   

enum MatrixRoomMembership

Room membership types.

Members

MATRIX_ROOM_MEMBERSHIP_UNKNOWN

   

MATRIX_ROOM_MEMBERSHIP_INVITE

   

MATRIX_ROOM_MEMBERSHIP_JOIN

   

MATRIX_ROOM_MEMBERSHIP_LEAVE

   

MATRIX_ROOM_MEMBERSHIP_BAN

   

MATRIX_ROOM_MEMBERSHIP_KNOCK

   

enum MatrixRoomPreset

Preset values for matrix_api_create_room() calls.

Members

MATRIX_ROOM_PRESET_NONE

   

MATRIX_ROOM_PRESET_PRIVATE

   

MATRIX_ROOM_PRESET_TRUSTED_PRIVATE

   

MATRIX_ROOM_PRESET_PUBLIC

   

enum MatrixRoomVisibility

Visibility values for room creation. Not to be confused with join rules.

Members

MATRIX_ROOM_VISIBILITY_DEFAULT

   

MATRIX_ROOM_VISIBILITY_PUBLIC

   

MATRIX_ROOM_VISIBILITY_PRIVATE

   

enum MatrixJoinRules

Room join rules.

Members

MATRIX_JOIN_RULES_UNKNOWN

   

MATRIX_JOIN_RULES_PUBLIC

   

MATRIX_JOIN_RULES_INVITE

   

MATRIX_JOIN_RULES_PRIVATE

   

MATRIX_JOIN_RULES_KNOCK

   

enum MatrixSearchOrder

Members

MATRIX_SEARCH_ORDER_RECENT

   

MATRIX_SEARCH_ORDER_RANK

   

enum MatrixSearchKey

Members

MATRIX_SEARCH_KEY_CONTENT_BODY

   

MATRIX_SEARCH_KEY_CONTENT_NAME

   

MATRIX_SEARCH_KEY_CONTENT_TOPIC

   

enum MatrixSearchGroupBy

Members

MATRIX_SEARCH_GROUP_BY_UNKNOWN

   

MATRIX_SEARCH_GROUP_BY_ROOM_ID

   

MATRIX_SEARCH_GROUP_BY_SENDER

   

enum MatrixHistoryVisibility

Members

MATRIX_HISTORY_VISIBILITY_UNKNOWN

   

MATRIX_HISTORY_VISIBILITY_INVITED

   

MATRIX_HISTORY_VISIBILITY_JOINED

   

MATRIX_HISTORY_VISIBILITY_SHARED

   

MATRIX_HISTORY_VISIBILITY_WORLD_READABLE

   

enum MatrixGuestAccess

Members

MATRIX_GUEST_ACCESS_UNKNOWN

   

MATRIX_GUEST_ACCESS_CAN_JOIN

   

MATRIX_GUEST_ACCESS_FORBIDDEN

   

enum MatrixCallOfferType

Members

MATRIX_CALL_OFFER_TYPE_UNKNOWN

   

MATRIX_CALL_OFFER_TYPE_OFFER

   

enum MatrixCallAnswerType

Members

MATRIX_CALL_ANSWER_TYPE_UNKNOWN

   

MATRIX_CALL_ANSWER_TYPE_ANSWER

   

enum MatrixError

Members

MATRIX_ERROR_NONE

   

MATRIX_ERROR_COMMUNICATION_ERROR

   

MATRIX_ERROR_INCOMPLETE

   

MATRIX_ERROR_BAD_REQUEST

   

MATRIX_ERROR_BAD_RESPONSE

   

MATRIX_ERROR_INVALID_ROOM_ID

   

MATRIX_ERROR_UNKNOWN_VALUE

   

MATRIX_ERROR_INVALID_TYPE

   

MATRIX_ERROR_UNSUPPORTED

   

MATRIX_ERROR_INVALID_FORMAT

   

MATRIX_ERROR_UNAVAILABLE

   

MATRIX_ERROR_NOT_FOUND

   

MATRIX_ERROR_ALREADY_EXISTS

   

MATRIX_ERROR_M_MISSING_TOKEN

   

MATRIX_ERROR_M_FORBIDDEN

   

MATRIX_ERROR_M_UNKNOWN

   

MATRIX_ERROR_M_UNKNOWN_TOKEN

   

MATRIX_ERROR_M_NOT_JSON

   

MATRIX_ERROR_M_UNRECOGNIZED

   

MATRIX_ERROR_M_UNAUTHORIZED

   

MATRIX_ERROR_M_BAD_JSON

   

MATRIX_ERROR_M_USER_IN_USE

   

MATRIX_ERROR_M_ROOM_IN_USE

   

MATRIX_ERROR_M_BAD_PAGINATION

   

MATRIX_ERROR_M_BAD_STATE

   

MATRIX_ERROR_M_NOT_FOUND

   

MATRIX_ERROR_M_GUEST_ACCESS_FORBIDDEN

   

MATRIX_ERROR_M_LIMIT_EXCEEDED

   

MATRIX_ERROR_M_CAPTCHA_NEEDED

   

MATRIX_ERROR_M_CAPTCHA_INVALID

   

MATRIX_ERROR_M_MISSING_PARAM

   

MATRIX_ERROR_M_TOO_LARGE

   

MATRIX_ERROR_M_EXCLUSIVE

   

MATRIX_ERROR_M_THREEPID_AUTH_FAILED

   

MATRIX_ERROR_M_THREEPID_IN_USE

   

MATRIX_ERROR_M_INVALID_USERNAME

   

MATRIX_ERROR_UNSPECIFIED

   

MATRIX_ERROR_UNKNOWN_ERROR

   

struct MatrixFileInfo

struct MatrixFileInfo {
	gint* size;
	gchar* mimetype;
};

Information about the file referred to in a URL.


struct MatrixImageInfo

struct MatrixImageInfo {
	gint* size;
	gint* height;
	gint* width;
	gchar* mimetype;
};

struct MatrixAudioInfo

struct MatrixAudioInfo {
	gint* size;
	gchar* mimetype;
	gint* duration;
};

struct MatrixVideoInfo

struct MatrixVideoInfo {
	gint* size;
	gchar* mimetype;
	gint* duration;
	gint* width;
	gint* height;
	gchar* thumbnail_url;
	MatrixImageInfo* thumbnail_info;
};