From 3dfe286f52bd6ed6918625d187fc27f94ccabc8b Mon Sep 17 00:00:00 2001 From: Gergely Polonkai Date: Thu, 17 Mar 2016 16:47:46 +0000 Subject: [PATCH] Update GTK Doc with current develop --- Matrix-0.0-MatrixAPI.html | 2206 +++++++++++------ Matrix-0.0-MatrixClient.html | 349 ++- Matrix-0.0-MatrixEvent.html | 916 ------- Matrix-0.0-MatrixEventBase.html | 482 ++++ Matrix-0.0-MatrixEventCall.html | 269 ++ Matrix-0.0-MatrixEventCallAnswer.html | 287 +++ Matrix-0.0-MatrixEventCallCandidates.html | 369 +++ Matrix-0.0-MatrixEventCallHangup.html | 134 + Matrix-0.0-MatrixEventCallInvite.html | 360 +++ Matrix-0.0-MatrixEventPresence.html | 586 +++++ Matrix-0.0-MatrixEventReceipt.html | 208 ++ Matrix-0.0-MatrixEventRoom.html | 569 +++++ Matrix-0.0-MatrixEventRoomAliases.html | 217 ++ Matrix-0.0-MatrixEventRoomAvatar.html | 438 ++++ Matrix-0.0-MatrixEventRoomCanonicalAlias.html | 212 ++ Matrix-0.0-MatrixEventRoomCreate.html | 285 +++ Matrix-0.0-MatrixEventRoomGuestAccess.html | 211 ++ ...-0.0-MatrixEventRoomHistoryVisibility.html | 214 ++ Matrix-0.0-MatrixEventRoomJoinRules.html | 211 ++ Matrix-0.0-MatrixEventRoomMember.html | 839 +++++++ Matrix-0.0-MatrixEventRoomMessage.html | 247 ++ ...ix-0.0-MatrixEventRoomMessageFeedback.html | 291 +++ Matrix-0.0-MatrixEventRoomName.html | 208 ++ Matrix-0.0-MatrixEventRoomPowerLevels.html | 675 +++++ Matrix-0.0-MatrixEventRoomRedaction.html | 288 +++ ...x-0.0-MatrixEventRoomThirdPartyInvite.html | 675 +++++ Matrix-0.0-MatrixEventRoomTopic.html | 210 ++ Matrix-0.0-MatrixEventState.html | 299 +++ Matrix-0.0-MatrixEventTag.html | 133 + Matrix-0.0-MatrixEventTyping.html | 287 +++ Matrix-0.0-MatrixHTTPAPI.html | 63 +- Matrix-0.0-MatrixHTTPClient.html | 33 +- Matrix-0.0-MatrixJsonCompact.html | 1205 ++++----- Matrix-0.0-MatrixMessageAudio.html | 285 +++ Matrix-0.0-MatrixMessageBase.html | 590 +++++ Matrix-0.0-MatrixMessageEmote.html | 136 + Matrix-0.0-MatrixMessageFile.html | 510 ++++ Matrix-0.0-MatrixMessageImage.html | 438 ++++ Matrix-0.0-MatrixMessageLocation.html | 361 +++ Matrix-0.0-MatrixMessageNotice.html | 136 + Matrix-0.0-MatrixMessageText.html | 136 + Matrix-0.0-MatrixMessageVideo.html | 283 +++ Matrix-0.0-MatrixPresenceEvent.html | 441 ---- Matrix-0.0-MatrixProfile.html | 318 +++ Matrix-0.0-MatrixRoomEvent.html | 125 - Matrix-0.0-MatrixRoomMemberEvent.html | 444 ---- Matrix-0.0-MatrixRoomMessageEvent.html | 288 --- Matrix-0.0-MatrixStateEvent.html | 287 --- Matrix-0.0-c-api.html | 54 - Matrix-0.0-matrix-enums.html | 800 ------ Matrix-0.0-matrix-types.html | 1910 ++++++++++++++ Matrix-0.0.devhelp2 | 773 ++++++ annotation-glossary.html | 13 +- api-index-full.html | 1771 +++++++++++-- ch01.html | 161 +- deprecated-api-index.html | 9 +- home.png | Bin 169 -> 256 bytes index.html | 159 +- index.sgml | 984 ++++++++ left-insensitive.png | Bin 329 -> 395 bytes left.png | Bin 187 -> 262 bytes right-insensitive.png | Bin 233 -> 373 bytes right.png | Bin 186 -> 261 bytes style.css | 302 +-- up-insensitive.png | Bin 293 -> 374 bytes up.png | Bin 187 -> 260 bytes 66 files changed, 20281 insertions(+), 5409 deletions(-) delete mode 100644 Matrix-0.0-MatrixEvent.html create mode 100644 Matrix-0.0-MatrixEventBase.html create mode 100644 Matrix-0.0-MatrixEventCall.html create mode 100644 Matrix-0.0-MatrixEventCallAnswer.html create mode 100644 Matrix-0.0-MatrixEventCallCandidates.html create mode 100644 Matrix-0.0-MatrixEventCallHangup.html create mode 100644 Matrix-0.0-MatrixEventCallInvite.html create mode 100644 Matrix-0.0-MatrixEventPresence.html create mode 100644 Matrix-0.0-MatrixEventReceipt.html create mode 100644 Matrix-0.0-MatrixEventRoom.html create mode 100644 Matrix-0.0-MatrixEventRoomAliases.html create mode 100644 Matrix-0.0-MatrixEventRoomAvatar.html create mode 100644 Matrix-0.0-MatrixEventRoomCanonicalAlias.html create mode 100644 Matrix-0.0-MatrixEventRoomCreate.html create mode 100644 Matrix-0.0-MatrixEventRoomGuestAccess.html create mode 100644 Matrix-0.0-MatrixEventRoomHistoryVisibility.html create mode 100644 Matrix-0.0-MatrixEventRoomJoinRules.html create mode 100644 Matrix-0.0-MatrixEventRoomMember.html create mode 100644 Matrix-0.0-MatrixEventRoomMessage.html create mode 100644 Matrix-0.0-MatrixEventRoomMessageFeedback.html create mode 100644 Matrix-0.0-MatrixEventRoomName.html create mode 100644 Matrix-0.0-MatrixEventRoomPowerLevels.html create mode 100644 Matrix-0.0-MatrixEventRoomRedaction.html create mode 100644 Matrix-0.0-MatrixEventRoomThirdPartyInvite.html create mode 100644 Matrix-0.0-MatrixEventRoomTopic.html create mode 100644 Matrix-0.0-MatrixEventState.html create mode 100644 Matrix-0.0-MatrixEventTag.html create mode 100644 Matrix-0.0-MatrixEventTyping.html create mode 100644 Matrix-0.0-MatrixMessageAudio.html create mode 100644 Matrix-0.0-MatrixMessageBase.html create mode 100644 Matrix-0.0-MatrixMessageEmote.html create mode 100644 Matrix-0.0-MatrixMessageFile.html create mode 100644 Matrix-0.0-MatrixMessageImage.html create mode 100644 Matrix-0.0-MatrixMessageLocation.html create mode 100644 Matrix-0.0-MatrixMessageNotice.html create mode 100644 Matrix-0.0-MatrixMessageText.html create mode 100644 Matrix-0.0-MatrixMessageVideo.html delete mode 100644 Matrix-0.0-MatrixPresenceEvent.html create mode 100644 Matrix-0.0-MatrixProfile.html delete mode 100644 Matrix-0.0-MatrixRoomEvent.html delete mode 100644 Matrix-0.0-MatrixRoomMemberEvent.html delete mode 100644 Matrix-0.0-MatrixRoomMessageEvent.html delete mode 100644 Matrix-0.0-MatrixStateEvent.html delete mode 100644 Matrix-0.0-c-api.html delete mode 100644 Matrix-0.0-matrix-enums.html create mode 100644 Matrix-0.0-matrix-types.html create mode 100644 Matrix-0.0.devhelp2 create mode 100644 index.sgml diff --git a/Matrix-0.0-MatrixAPI.html b/Matrix-0.0-MatrixAPI.html index 0997972..3bf70ef 100644 --- a/Matrix-0.0-MatrixAPI.html +++ b/Matrix-0.0-MatrixAPI.html @@ -2,26 +2,25 @@ -Matrix-0.0 Reference Manual: MatrixAPI +MatrixAPI: Matrix-0.0 Reference Manual - - - + + + - + - - + +
@@ -93,7 +92,7 @@ void -matrix_api_get_user_presence () +matrix_api_get_presence () @@ -529,7 +528,7 @@ -const gchar * +const gchar * matrix_api_get_token () @@ -544,7 +543,7 @@ -const gchar * +const gchar * matrix_api_get_refresh_token () @@ -559,14 +558,14 @@ -const gchar * +const gchar * matrix_api_get_user_id () -const gchar * +const gchar * matrix_api_get_homeserver () @@ -595,11 +594,6 @@
-

Object Hierarchy

-
-
-
-

Description

@@ -610,7 +604,7 @@ matrix_api_abort_pending (MatrixAPI *self);

Abort all pending requests toward a Matrix homeserver. Be aware that this may leave requests in an inconsistent state.

-

Parameters

+

Parameters

@@ -632,19 +626,27 @@ matrix_api_abort_pending (MatrixAPI *self, MatrixAPICallback callback, void *callback_target, - const gchar *server_name, - const gchar *media_id, - GError **error); + const gchar *server_name, + const gchar *media_id, + GError **error);

Download content from the content repository.

Implementors: If server_name or media_id is

-
-null
-
+
+
+ + + + + + + 
1
null
+
+

, implementations MUST throw Matrix.Error.INCOMPLETE.

-

Parameters

+

Parameters

@@ -664,19 +666,19 @@ null

a function to call when the request is finished

.

- + - + - + @@ -698,7 +700,7 @@ is no longer needed.

- + @@ -712,22 +714,30 @@ is no longer needed.

matrix_api_media_thumbnail (MatrixAPI *self, MatrixAPICallback callback, void *callback_target, - const gchar *server_name, - const gchar *media_id, - guint width, - guint height, - MatrixResizeMethod method, - GError **error); + const gchar *server_name, + const gchar *media_id, + guint width, + guint height, + MatrixResizeMethod method, + GError **error);

Download a thumbnail of the content from the content repository. The actual thumbnail may not match the size specified.

If param server_name or param media_id is

-
-null
-
+
+
[in][allow-none][in][allow-none]

callback_target

user data to pass to callback .

[allow-none][closure][allow-none][closure]

callback_target_destroy_notify

function to call when callback_target is no longer needed.

[allow-none][allow-none]

server_name

error

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

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

[error-domains MatrixError]
+ + + + + + + 
1
null
+
+

, this function returns immediately, and throws Matrix.Error.INCOMPLETE.

-

Parameters

+

Parameters

@@ -747,19 +757,19 @@ null

a function to call when the request is finished

.

- + - + - + @@ -796,7 +806,7 @@ is no longer needed.

- + @@ -810,19 +820,27 @@ is no longer needed.

matrix_api_media_upload (MatrixAPI *self, MatrixAPICallback callback, void *callback_target, - const gchar *content_type, - GByteArray *content, - GError **error); + const gchar *content_type, + GByteArray *content, + GError **error);

Upload some content to the content repository.

If param content is

-
-null
-
+
+
[in][allow-none][in][allow-none]

callback_target

user data to pass to callback .

[allow-none][closure][allow-none][closure]

callback_target_destroy_notify

function to call when callback_target is no longer needed.

[allow-none][allow-none]

server_name

error

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

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

[error-domains MatrixError]
+ + + + + + + 
1
null
+
+

, this function returns immediately, and throws Matrix.Error.INCOMPLETE.

-

Parameters

+

Parameters

@@ -839,13 +857,13 @@ null - + - + @@ -854,7 +872,7 @@ is no longer needed.

the type of the content to be uploaded

.

- + @@ -872,7 +890,7 @@ is no longer needed.

- + @@ -886,18 +904,26 @@ is no longer needed.

matrix_api_get_presence_list (MatrixAPI *self, MatrixAPICallback callback, void *callback_target, - const gchar *user_id, - GError **error); + const gchar *user_id, + GError **error);

Retrieve a list of presence events for every user on this list.

If param user_id is

-
-null
-
+
+

callback_target

user data to pass to callback .

[allow-none][closure][allow-none][closure]

callback_target_destroy_notify

function to call when callback_target is no longer needed.

[allow-none][allow-none]

content_type

 [in][allow-none][in][allow-none]

content

error

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

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

[error-domains MatrixError]
+ + + + + + + 
1
null
+
+

, this function returns immediately, and throws Matrix.Error.INCOMPLETE.

-

Parameters

+

Parameters

@@ -914,13 +940,13 @@ null - + - + @@ -938,7 +964,7 @@ is no longer needed.

- + @@ -952,20 +978,30 @@ is no longer needed.

matrix_api_update_presence_list (MatrixAPI *self, MatrixAPICallback callback, void *callback_target, - const gchar *user_id, - GList *drop_ids, - GList *invite_ids, - GError **error); + const gchar *user_id, + gchar **drop_ids, + int drop_ids_length1, + gchar **invite_ids, + int invite_ids_length1, + GError **error);

Add or remove users from the specified user's presence list.

If param user_id, or both param drop_ids and param invite_ids are

-
-null
-
+
+

callback_target

user data to pass to callback .

[allow-none][closure][allow-none][closure]

callback_target_destroy_notify

function to call when callback_target is no longer needed.

[allow-none][allow-none]

user_id

error

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

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

[error-domains MatrixError]
+ + + + + + + 
1
null
+
+

, this function returns immediately, and throws Matrix.Error.INCOMPLETE.

-

Parameters

+

Parameters

@@ -982,13 +1018,13 @@ null - + - + @@ -1006,7 +1042,13 @@ is no longer needed.

a list of user IDs to remove from the list

.

- + + + + + + @@ -1015,7 +1057,13 @@ is no longer needed.

a list of user IDs to add to the list

.

- + + + + + + @@ -1024,7 +1072,7 @@ is no longer needed.

- + @@ -1033,23 +1081,31 @@ is no longer needed.

-

matrix_api_get_user_presence ()

+

matrix_api_get_presence ()

void
-matrix_api_get_user_presence (MatrixAPI *self,
-                              MatrixAPICallback callback,
-                              void *callback_target,
-                              const gchar *user_id,
-                              GError **error);
+matrix_api_get_presence (MatrixAPI *self, + MatrixAPICallback callback, + void *callback_target, + const gchar *user_id, + GError **error);

Get the given user's presence state.

If param user_id is

-
-null
-
+
+

callback_target

user data to pass to callback .

[allow-none][closure][allow-none][closure]

callback_target_destroy_notify

function to call when callback_target is no longer needed.

[allow-none][allow-none]

user_id

 [in][in][array length=drop_ids_length1]

drop_ids_length1

length of the drop_ids +array

 

invite_ids

 [in][in][array length=invite_ids_length1]

invite_ids_length1

length of the invite_ids +array

 

callback

error

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

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

[error-domains MatrixError]
+ + + + + + + 
1
null
+
+

, this function returns immediately, and throws Matrix.Error.INCOMPLETE.

-

Parameters

+

Parameters

@@ -1066,13 +1122,13 @@ null - + - + @@ -1090,7 +1146,7 @@ is no longer needed.

- + @@ -1104,20 +1160,28 @@ is no longer needed.

matrix_api_set_user_presence (MatrixAPI *self, MatrixAPICallback callback, void *callback_target, - const gchar *user_id, - MatrixPresence presence, - const gchar *status_message, - GError **error); + const gchar *user_id, + MatrixPresence presence, + const gchar *status_message, + GError **error);

Set the given user's presence. You cannot set the presence of another user.

If param user_id is

-
-null
-
+
+

callback_target

user data to pass to callback .

[allow-none][closure][allow-none][closure]

callback_target_destroy_notify

function to call when callback_target is no longer needed.

[allow-none][allow-none]

user_id

error

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

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

[error-domains MatrixError]
+ + + + + + + 
1
null
+
+

, this function returns immediately, and throws Matrix.Error.INCOMPLETE.

-

Parameters

+

Parameters

@@ -1134,13 +1198,13 @@ null - + - + @@ -1167,7 +1231,7 @@ is no longer needed.

a status message attached to this state

.

- + @@ -1176,7 +1240,7 @@ is no longer needed.

- + @@ -1191,17 +1255,25 @@ matrix_api_update_pusher (MatrixAPICallback callback, void *callback_target, MatrixPusher *pusher, - GError **error); + GError **error);

Create, update or delete a pusher for the active user on this homeserver.

If param pusher is

-
-null
-
+
+

callback_target

user data to pass to callback .

[allow-none][closure][allow-none][closure]

callback_target_destroy_notify

function to call when callback_target is no longer needed.

[allow-none][allow-none]

user_id

 [in][allow-none][in][allow-none]

callback

error

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

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

[error-domains MatrixError]
+ + + + + + + 
1
null
+
+

, this function returns immediately, and throws Matrix.Error.INCOMPLETE.

-

Parameters

+

Parameters

@@ -1218,13 +1290,13 @@ null - + - + @@ -1238,7 +1310,7 @@ is no longer needed.

- + @@ -1252,10 +1324,10 @@ is no longer needed.

matrix_api_get_pushers (MatrixAPI *self, MatrixAPICallback callback, void *callback_target, - GError **error); + GError **error);

Retrieve all push rulesets.

-

Parameters

+

Parameters

callback_target

user data to pass to callback .

[allow-none][closure][allow-none][closure]

callback_target_destroy_notify

function to call when callback_target is no longer needed.

[allow-none][allow-none]

callback

error

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

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

[error-domains MatrixError]
@@ -1272,13 +1344,13 @@ matrix_api_get_pushers (

callback_target

 - + - + @@ -1287,7 +1359,7 @@ is no longer needed.

- + @@ -1301,20 +1373,28 @@ is no longer needed.

matrix_api_delete_pusher (MatrixAPI *self, MatrixAPICallback callback, void *callback_target, - const gchar *scope, - MatrixPusherKind kind, - const gchar *rule_id, - GError **error); + const gchar *scope, + MatrixPusherKind kind, + const gchar *rule_id, + GError **error);

Delete a push rule.

If param scope or param rule_id is

-
-null
-
+
+

user data to pass to callback .

[allow-none][closure][allow-none][closure]

callback_target_destroy_notify

function to call when callback_target is no longer needed.

[allow-none][allow-none]

callback

error

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

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

[error-domains MatrixError]
+ + + + + + + 
1
null
+
+

, this function returns immediately, and throws Matrix.Error.INCOMPLETE.

-

Parameters

+

Parameters

@@ -1334,19 +1414,19 @@ null

a function to call when the request is finished

.

- + - + - + @@ -1355,27 +1435,51 @@ is no longer needed.

either

-
-global
-
+
+
[in][allow-none][in][allow-none]

callback_target

user data to pass to callback .

[allow-none][closure][allow-none][closure]

callback_target_destroy_notify

function to call when callback_target is no longer needed.

[allow-none][allow-none]

scope
+ + + + + + + 
1
global
+
+

to specify global rules, or

-
-device/<profile tag>
-
+
+ + + + + + + + 
1
device/<profile tag>
+
+

for rules for a given

-
-profile tag
-
+
+ + + + + + + + 
1
profile tag
+
+

@@ -1404,7 +1508,7 @@ profile tag

error

-

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

+

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

[error-domains MatrixError] @@ -1418,20 +1522,28 @@ profile tag matrix_api_get_pusher (MatrixAPI *self, MatrixAPICallback callback, void *callback_target, - const gchar *scope, - MatrixPusherKind kind, - const gchar *rule_id, - GError **error); + const gchar *scope, + MatrixPusherKind kind, + const gchar *rule_id, + GError **error);

Retrieve a specific push rule.

If param scope or param rule_id is

-
-null
-
+
+ + + + + + + + 
1
null
+
+

, this function returns immediately, and throws Matrix.Error.INCOMPLETE.

-

Parameters

+

Parameters

@@ -1451,19 +1563,19 @@ null

a function to call when the request is finished

.

- + - + - + @@ -1472,27 +1584,51 @@ is no longer needed.

either

-
-global
-
+
+
[in][allow-none][in][allow-none]

callback_target

user data to pass to callback .

[allow-none][closure][allow-none][closure]

callback_target_destroy_notify

function to call when callback_target is no longer needed.

[allow-none][allow-none]

scope
+ + + + + + + 
1
global
+
+

to specify global rules, or

-
-device/<profile tag>
-
+
+ + + + + + + + 
1
device/<profile tag>
+
+

for rules for a given

-
-profile tag
-
+
+ + + + + + + + 
1
profile tag
+
+

@@ -1521,7 +1657,7 @@ profile tag

error

-

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

+

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

[error-domains MatrixError] @@ -1535,24 +1671,34 @@ profile tag matrix_api_add_pusher (MatrixAPI *self, MatrixAPICallback callback, void *callback_target, - const gchar *scope, - MatrixPusherKind kind, - const gchar *rule_id, - const gchar *before, - const gchar *after, - GList *actions, - GList *conditions, - GError **error); + const gchar *scope, + MatrixPusherKind kind, + const gchar *rule_id, + const gchar *before, + const gchar *after, + gchar **actions, + int actions_length1, + MatrixPusherConditionKind *conditions, + int conditions_length1, + GError **error);

Add or change a push rule.

If either param scope, param rule_id or param actions are

-
-null
-
+
+ + + + + + + + 
1
null
+
+

, this function returns immediately, and throws Matrix.Error.INCOMPLETE.

-

Parameters

+

Parameters

@@ -1572,19 +1718,19 @@ null

a function to call when the request is finished

.

- + - + - + @@ -1593,27 +1739,51 @@ is no longer needed.

either

-
-global
-
+
+
[in][allow-none][in][allow-none]

callback_target

user data to pass to callback .

[allow-none][closure][allow-none][closure]

callback_target_destroy_notify

function to call when callback_target is no longer needed.

[allow-none][allow-none]

scope
+ + + + + + + 
1
global
+
+

to specify global rules, or

-
-device/<profile tag>
-
+
+ + + + + + + + 
1
device/<profile tag>
+
+

for rules for a given

-
-profile tag
-
+
+ + + + + + + + 
1
profile tag
+
+

@@ -1647,7 +1817,7 @@ profile tag

make the new rule the next-most important than this rule ID

.

-[in][allow-none] +[in][allow-none]

after

@@ -1656,7 +1826,7 @@ profile tag

make the new rule the next-less important than this rule ID

.

-[in][allow-none] +[in][allow-none]

actions

@@ -1665,7 +1835,13 @@ profile tag

the actions to perform when the conditions for this rule are met

.

-[in] +[in][array length=actions_length1] + + +

actions_length1

+

length of the actions +array

+ 

conditions

@@ -1674,11 +1850,17 @@ profile tag

the conditions that must hold true for an event for a rule to be applied. A rule with no conditions always matches

.

-[in][allow-none] +[in][array length=conditions_length1] + + +

conditions_length1

+

length of the conditions +array

+ 

error

-

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

+

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

[error-domains MatrixError] @@ -1692,15 +1874,15 @@ profile tag matrix_api_toggle_pusher (MatrixAPI *self, MatrixAPICallback callback, void *callback_target, - const gchar *scope, - MatrixPusherKind kind, - const gchar *rule_id, - gboolean enabled, - GError **error); + const gchar *scope, + MatrixPusherKind kind, + const gchar *rule_id, + gboolean enabled, + GError **error);

Enable or disable the specified push rule.

-

If scope or rule_id is NULL, this function returns immediately, and fills error with MATRIX_ERROR_INCOMPLETE.

+

If scope or rule_id is NULL, this function returns immediately, and fills error with MATRIX_ERROR_INCOMPLETE.

-

Parameters

+

Parameters

@@ -1720,19 +1902,19 @@ matrix_api_toggle_pusher ([in][allow-none] + - + - + @@ -1741,27 +1923,51 @@ is no longer needed.

either

-
-global
-
+
+
[in][allow-none]

callback_target

user data to pass to callback .

[allow-none][closure][allow-none][closure]

callback_target_destroy_notify

function to call when callback_target is no longer needed.

[allow-none][allow-none]

scope

+ + + + + + + 
1
global
+
+

to specify global rules, or

-
-device/<profile tag>
-
+
+ + + + + + + + 
1
device/<profile tag>
+
+

for rules for a given

-
-profile tag
-
+
+ + + + + + + + 
1
profile tag
+
+

@@ -1795,9 +2001,17 @@ profile tag

if

-
-true
-
+
+ + + + + + + + 
1
true
+
+

@@ -1808,7 +2022,7 @@ true

error

-

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

+

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

[error-domains MatrixError] @@ -1822,20 +2036,23 @@ true matrix_api_create_room (MatrixAPI *self, MatrixAPICallback callback, void *callback_target, - MatrixRoomPreset preset, - const gchar *room_name, - const gchar *room_alias, - const gchar *topic, - MatrixRoomVisibility visibility, + MatrixRoomPreset preset, + const gchar *room_name, + const gchar *room_alias, + const gchar *topic, + MatrixRoomVisibility visibility, JsonNode *creation_content, - GList *initial_state, - GList *invitees, - GList *invite_3pids, - GError **error); + MatrixEventState **initial_state, + int initial_state_length1, + gchar **invitees, + int invitees_length1, + Matrix3PidCredential **invite_3pids, + int invite_3pids_length1, + GError **error);

Create a new room with the given name and invite the users in param invitees.

-

Parameters

+

Parameters

@@ -1855,19 +2072,19 @@ matrix_api_create_room ([in][allow-none] + - + - + @@ -1885,7 +2102,7 @@ is no longer needed.

the desired display name for the room

.

- + @@ -1894,7 +2111,7 @@ is no longer needed.

an alias of the room

.

- + @@ -1903,7 +2120,7 @@ is no longer needed.

the topic of the room

.

- + @@ -1921,7 +2138,7 @@ is no longer needed.

extra keys to be added to the content of m.room.create

.

- + @@ -1930,7 +2147,13 @@ is no longer needed.

a list of state events to set in the new room

.

- + + + + + + @@ -1939,7 +2162,13 @@ is no longer needed.

list of user IDs to invite to the new room

.

- + + + + + + @@ -1948,11 +2177,17 @@ is no longer needed.

a list of 3rd party credentials to invite to the new room

.

- + + + + + + - + @@ -1966,14 +2201,14 @@ is no longer needed.

matrix_api_delete_room_alias (MatrixAPI *self, MatrixAPICallback callback, void *callback_target, - const gchar *room_alias, - GError **error); + const gchar *room_alias, + GError **error);

Remove the mapping of room_alias to its room ID

Servers may choose to implement additional access control checks here, for instance that room aliases can only be deleted by their creator or a server administrator.

-

If room_alias is NULL, this function returns immediately, and fills error with MATRIX_ERROR_INCOMPLETE.

+

If room_alias is NULL, this function returns immediately, and fills error with MATRIX_ERROR_INCOMPLETE.

-

Parameters

+

Parameters

[in][allow-none]

callback_target

user data to pass to callback .

[allow-none][closure][allow-none][closure]

callback_target_destroy_notify

function to call when callback_target is no longer needed.

[allow-none][allow-none]

preset

[in][allow-none][in][allow-none]

room_alias

[in][allow-none][in][allow-none]

topic

[in][allow-none][in][allow-none]

visibility

[in][allow-none][in][allow-none]

initial_state

[in][allow-none][in][array length=initial_state_length1]

initial_state_length1

length of the initial_state +array

 

invitees

[in][allow-none][in][array length=invitees_length1]

invitees_length1

length of the invitees +array

 

invite_3pids

[in][allow-none][in][array length=invite_3pids_length1]

invite_3pids_length1

length of the invite_3pids +array

 

error

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

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

[error-domains MatrixError]
@@ -1993,19 +2228,19 @@ matrix_api_delete_room_alias ([in][allow-none] + - + - + @@ -2018,7 +2253,7 @@ is no longer needed.

- + @@ -2032,18 +2267,26 @@ is no longer needed.

matrix_api_get_room_id (MatrixAPI *self, MatrixAPICallback callback, void *callback_target, - const gchar *room_alias, - GError **error); + const gchar *room_alias, + GError **error);

Get the room ID corresponding to this room alias.

If param room_alias is

-
-null
-
+
+
[in][allow-none]

callback_target

user data to pass to callback .

[allow-none][closure][allow-none][closure]

callback_target_destroy_notify

function to call when callback_target is no longer needed.

[allow-none][allow-none]

room_alias

error

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

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

[error-domains MatrixError]
+ + + + + + + 
1
null
+
+

, this function returns immediately, throws Matrix.Error.INCOMPLETE.

-

Parameters

+

Parameters

@@ -2063,19 +2306,19 @@ null

the function to call when the request is finished

.

- + - + - + @@ -2088,7 +2331,7 @@ is no longer needed.

- + @@ -2102,19 +2345,27 @@ is no longer needed.

matrix_api_create_room_alias (MatrixAPI *self, MatrixAPICallback callback, void *callback_target, - const gchar *room_id, - const gchar *room_alias, - GError **error); + const gchar *room_id, + const gchar *room_alias, + GError **error);

Create a new mapping from room alias to room ID.

If param room_alias or param room_id is

-
-null
-
+
+
[in][allow-none][in][allow-none]

callback_target

user data to pass to callback .

[allow-none][closure][allow-none][closure]

callback_target_destroy_notify

function to call when callback_target is no longer needed.

[allow-none][allow-none]

room_alias

error

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

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

[error-domains MatrixError]
+ + + + + + + 
1
null
+
+

, this function returns immediately, and throws Matrix.Error.INCOMPLETE.

-

Parameters

+

Parameters

@@ -2134,19 +2385,19 @@ null

the function to call when the request is finished

.

- + - + - + @@ -2168,7 +2419,7 @@ is no longer needed.

- + @@ -2182,10 +2433,10 @@ is no longer needed.

matrix_api_list_public_rooms (MatrixAPI *self, MatrixAPICallback callback, void *callback_target, - GError **error); + GError **error);

List the public rooms on the server.

-

Parameters

+

Parameters

[in][allow-none][in][allow-none]

callback_target

user data to pass to callback .

[allow-none][closure][allow-none][closure]

callback_target_destroy_notify

function to call when callback_target is no longer needed.

[allow-none][allow-none]

room_id

error

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

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

[error-domains MatrixError]
@@ -2205,23 +2456,23 @@ matrix_api_list_public_rooms ([in][allow-none] + - + - + - + @@ -2235,20 +2486,28 @@ is no longer needed.

matrix_api_ban_user (MatrixAPI *self, MatrixAPICallback callback, void *callback_target, - const gchar *room_id, - const gchar *user_id, - const gchar *reason, - GError **error); + const gchar *room_id, + const gchar *user_id, + const gchar *reason, + GError **error);

Ban the specified user from the specified room. An optional reason can be specified.

If param room_id or param user_id is

-
-null
-
+
+
[in][allow-none]

callback_target

user data to pass to callback .

[allow-none][closure][allow-none][closure]

callback_target_destroy_notify

function to call when callback_target is no longer needed.

[allow-none][allow-none]

error

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

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

[error-domains MatrixError]
+ + + + + + + 
1
null
+
+

, this function returns immediately, and throws Matrix.Error.INCOMPLETE.

-

Parameters

+

Parameters

@@ -2268,19 +2527,19 @@ null

the function to call when the request is finished

.

- + - + - + @@ -2307,11 +2566,11 @@ is no longer needed.

the reason of the ban

.

- + - + @@ -2325,22 +2584,30 @@ is no longer needed.

matrix_api_forget_room (MatrixAPI *self, MatrixAPICallback callback, void *callback_target, - const gchar *room_id, - GError **error); + const gchar *room_id, + GError **error);

Stop the requesting user remembering about a particular room.

In general, history is a first class citizen in Matrix. After this API is called, however, a user will no longer be able to retrieve history for this room. If all users on a homeserver forget a room, the room is eligible for deletion from that homeserver.

If the user is currently joined to the room, they will implicitly leave the room as part of this API call.

If param room_id is

-
-null
-
+
+
[in][allow-none][in][allow-none]

callback_target

user data to pass to callback .

[allow-none][closure][allow-none][closure]

callback_target_destroy_notify

function to call when callback_target is no longer needed.

[allow-none][allow-none]

room_id

 [in][allow-none][in][allow-none]

error

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

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

[error-domains MatrixError]
+ + + + + + + 
1
null
+
+

, this function returns immediately, and throws Matrix.Error.INCOMPLETE.

-

Parameters

+

Parameters

@@ -2360,19 +2627,19 @@ null

the function to call when the request is finished

.

- + - + - + @@ -2385,7 +2652,7 @@ is no longer needed.

- + @@ -2399,22 +2666,30 @@ is no longer needed.

matrix_api_invite_user_3rdparty (MatrixAPI *self, MatrixAPICallback callback, void *callback_target, - const gchar *room_id, + const gchar *room_id, Matrix3PidCredential *credential, - GError **error); + GError **error);

Invite a user to the room by a 3rd party identifier. They do not start participating in the room until they actually join the room.

If the identity server does not know a Matrix user identifier for the passed third party identifier, the homeserver will issue an invitation which can be accepted upon providing proof of ownership of the third party identifier.

If param credential is

-
-null
-
+
+
[in][allow-none][in][allow-none]

callback_target

user data to pass to callback .

[allow-none][closure][allow-none][closure]

callback_target_destroy_notify

function to call when callback_target is no longer needed.

[allow-none][allow-none]

room_id

error

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

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

[error-domains MatrixError]
+ + + + + + + 
1
null
+
+

, this function immediately returns, and throws Matrix.Error.INCOMPLETE.

-

Parameters

+

Parameters

@@ -2434,19 +2709,19 @@ null

the function to call when the request is finished

.

- + - + - + @@ -2468,7 +2743,7 @@ is no longer needed.

- + @@ -2482,13 +2757,13 @@ is no longer needed.

matrix_api_invite_user (MatrixAPI *self, MatrixAPICallback callback, void *callback_target, - const gchar *room_id, - const gchar *user_id, - GError **error); + const gchar *room_id, + const gchar *user_id, + GError **error);

Invite a user to a room.

-

If room_id or user_id is NULL, this function returns immediately, and fills error with MATRIX_ERROR_INCOMPLETE.

+

If room_id or user_id is NULL, this function returns immediately, and fills error with MATRIX_ERROR_INCOMPLETE.

-

Parameters

+

Parameters

[in][allow-none][in][allow-none]

callback_target

user data to pass to callback .

[allow-none][closure][allow-none][closure]

callback_target_destroy_notify

function to call when callback_target is no longer needed.

[allow-none][allow-none]

room_id

error

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

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

[error-domains MatrixError]
@@ -2508,19 +2783,19 @@ matrix_api_invite_user ([in][allow-none] + - + - + @@ -2542,7 +2817,7 @@ is no longer needed.

- + @@ -2556,18 +2831,26 @@ is no longer needed.

matrix_api_join_room (MatrixAPI *self, MatrixAPICallback callback, void *callback_target, - const gchar *room_id, - GError **error); + const gchar *room_id, + GError **error);

Join a room.

If param room_id is

-
-null
-
+
+
[in][allow-none]

callback_target

user data to pass to callback .

[allow-none][closure][allow-none][closure]

callback_target_destroy_notify

function to call when callback_target is no longer needed.

[allow-none][allow-none]

room_id

error

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

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

[error-domains MatrixError]
+ + + + + + + 
1
null
+
+

, this function returns immediately, and throws Matrix.Error.INCOMPLETE.

-

Parameters

+

Parameters

@@ -2587,19 +2870,19 @@ null

the function to call when the request is finished

.

- + - + - + @@ -2612,7 +2895,7 @@ is no longer needed.

- + @@ -2626,18 +2909,26 @@ is no longer needed.

matrix_api_leave_room (MatrixAPI *self, MatrixAPICallback callback, void *callback_target, - const gchar *room_id, - GError **error); + const gchar *room_id, + GError **error);

Leave a room.

If param room_id is

-
-null
-
+
+
[in][allow-none][in][allow-none]

callback_target

user data to pass to callback .

[allow-none][closure][allow-none][closure]

callback_target_destroy_notify

function to call when callback_target is no longer needed.

[allow-none][allow-none]

room_id

error

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

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

[error-domains MatrixError]
+ + + + + + + 
1
null
+
+

, this function returns immediately, and throws Matrix.Error.INCOMPLETE.

-

Parameters

+

Parameters

@@ -2657,19 +2948,19 @@ null

the function to call when the request is finished

.

- + - + - + @@ -2682,7 +2973,7 @@ is no longer needed.

- + @@ -2696,13 +2987,13 @@ is no longer needed.

matrix_api_event_stream (MatrixAPI *self, MatrixAPICallback callback, void *callback_target, - const gchar *from_token, - gulong timeout, - GError **error); + const gchar *from_token, + gulong timeout, + GError **error);

Get the event stream, optionally beginning from from_token .

-

Parameters

+

Parameters

[in][allow-none][in][allow-none]

callback_target

user data to pass to callback .

[allow-none][closure][allow-none][closure]

callback_target_destroy_notify

function to call when callback_target is no longer needed.

[allow-none][allow-none]

room_id

error

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

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

[error-domains MatrixError]
@@ -2722,19 +3013,19 @@ matrix_api_event_stream ([in][allow-none] + - + - + @@ -2743,7 +3034,7 @@ is no longer needed.

events will be listed from this token

.

- + @@ -2756,7 +3047,7 @@ is no longer needed.

- + @@ -2770,18 +3061,26 @@ is no longer needed.

matrix_api_get_event (MatrixAPI *self, MatrixAPICallback callback, void *callback_target, - const gchar *event_id, - GError **error); + const gchar *event_id, + GError **error);

Get a single event by event ID.

If param event_id is

-
-null
-
+
+
[in][allow-none]

callback_target

user data to pass to callback .

[allow-none][closure][allow-none][closure]

callback_target_destroy_notify

function to call when callback_target is no longer needed.

[allow-none][allow-none]

from_token

[in][allow-none][in][allow-none]

timeout

error

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

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

[error-domains MatrixError]
+ + + + + + + 
1
null
+
+

, this function returns immediately, and throws Matrix.Error.INCOMPLETE.

-

Parameters

+

Parameters

@@ -2801,19 +3100,19 @@ null

the function to call when the request is finished

.

- + - + - + @@ -2826,7 +3125,7 @@ is no longer needed.

- + @@ -2840,12 +3139,12 @@ is no longer needed.

matrix_api_initial_sync (MatrixAPI *self, MatrixAPICallback callback, void *callback_target, - guint limit, - gboolean archived, - GError **error); + guint limit, + gboolean archived, + GError **error);

Perform an initial sync of events

-

Parameters

+

Parameters

[in][allow-none][in][allow-none]

callback_target

user data to pass to callback .

[allow-none][closure][allow-none][closure]

callback_target_destroy_notify

function to call when callback_target is no longer needed.

[allow-none][allow-none]

event_id

error

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

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

[error-domains MatrixError]
@@ -2865,19 +3164,19 @@ matrix_api_initial_sync ([in][allow-none] + - + - + @@ -2899,7 +3198,7 @@ is no longer needed.

- + @@ -2913,20 +3212,28 @@ is no longer needed.

matrix_api_get_event_context (MatrixAPI *self, MatrixAPICallback callback, void *callback_target, - const gchar *room_id, - const gchar *event_id, - guint limit, - GError **error); + const gchar *room_id, + const gchar *event_id, + guint limit, + GError **error);

Gets a number of events that happened just before and after the specified event.

If param room_id or param event_id is

-
-null
-
+
+
[in][allow-none]

callback_target

user data to pass to callback .

[allow-none][closure][allow-none][closure]

callback_target_destroy_notify

function to call when callback_target is no longer needed.

[allow-none][allow-none]

limit

error

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

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

[error-domains MatrixError]
+ + + + + + + 
1
null
+
+

, this function returns immediately, and throws Matrix.Error.INCOMPLETE.

-

Parameters

+

Parameters

@@ -2946,19 +3253,19 @@ null

the function to call when the request is finished

.

- + - + - + @@ -2989,7 +3296,7 @@ is no longer needed.

- + @@ -3003,18 +3310,26 @@ is no longer needed.

matrix_api_initial_sync_room (MatrixAPI *self, MatrixAPICallback callback, void *callback_target, - const gchar *room_id, - GError **error); + const gchar *room_id, + GError **error);

Get a copy of the current state and the most recent messages in a room.

If param room_id is

-
-null
-
+
+
[in][allow-none][in][allow-none]

callback_target

user data to pass to callback .

[allow-none][closure][allow-none][closure]

callback_target_destroy_notify

function to call when callback_target is no longer needed.

[allow-none][allow-none]

room_id

error

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

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

[error-domains MatrixError]
+ + + + + + + 
1
null
+
+

, this function returns immediately, and throws Matrix.Error.INCOMPLETE.

-

Parameters

+

Parameters

@@ -3034,19 +3349,19 @@ null

the function to call when the request is finished

.

- + - + - + @@ -3059,7 +3374,7 @@ is no longer needed.

- + @@ -3073,18 +3388,26 @@ is no longer needed.

matrix_api_list_room_members (MatrixAPI *self, MatrixAPICallback callback, void *callback_target, - const gchar *room_id, - GError **error); + const gchar *room_id, + GError **error);

Get the list of members for a room.

If param room_id is

-
-null
-
+
+
[in][allow-none][in][allow-none]

callback_target

user data to pass to callback .

[allow-none][closure][allow-none][closure]

callback_target_destroy_notify

function to call when callback_target is no longer needed.

[allow-none][allow-none]

room_id

error

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

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

[error-domains MatrixError]
+ + + + + + + 
1
null
+
+

, this function returns immediately, and throws Matrix.Error.INCOMPLETE.

-

Parameters

+

Parameters

@@ -3104,19 +3427,19 @@ null

the function to call when the request is finished

.

- + - + - + @@ -3129,7 +3452,7 @@ is no longer needed.

- + @@ -3143,21 +3466,29 @@ is no longer needed.

matrix_api_list_room_messages (MatrixAPI *self, MatrixAPICallback callback, void *callback_target, - const gchar *room_id, - const gchar *from_token, - MatrixEventDirection direction, - guint limit, - GError **error); + const gchar *room_id, + const gchar *from_token, + MatrixEventDirection direction, + guint limit, + GError **error);

Get a list of message and state events for a room.

If param room_id or param from_token is

-
-null
-
+
+
[in][allow-none][in][allow-none]

callback_target

user data to pass to callback .

[allow-none][closure][allow-none][closure]

callback_target_destroy_notify

function to call when callback_target is no longer needed.

[allow-none][allow-none]

room_id

error

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

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

[error-domains MatrixError]
+ + + + + + + 
1
null
+
+

, this function returns immediately, and throws Matrix.Error.INCOMPLETE.

-

Parameters

+

Parameters

@@ -3177,19 +3508,19 @@ null

the function to call when the request is finished

.

- + - + - + @@ -3229,7 +3560,7 @@ is no longer needed.

- + @@ -3243,21 +3574,29 @@ is no longer needed.

matrix_api_send_event_receipt (MatrixAPI *self, MatrixAPICallback callback, void *callback_target, - const gchar *room_id, - MatrixReceiptType receipt_type, - const gchar *event_id, + const gchar *room_id, + MatrixReceiptType receipt_type, + const gchar *event_id, JsonNode *receipt, - GError **error); + GError **error);

Update the marker for the given receipt type to the event ID specified.

If param room_id, param event_id or param receipt is

-
-null
-
+
+
[in][allow-none][in][allow-none]

callback_target

user data to pass to callback .

[allow-none][closure][allow-none][closure]

callback_target_destroy_notify

function to call when callback_target is no longer needed.

[allow-none][allow-none]

room_id

error

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

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

[error-domains MatrixError]
+ + + + + + + 
1
null
+
+

, this function returns immediately, and throws Matrix.Error.INCOMPLETE.

-

Parameters

+

Parameters

@@ -3277,19 +3616,19 @@ null

the function to call when the request is finished

.

- + - + - + @@ -3325,9 +3664,17 @@ is no longer needed.

extra receipt information to attach. Note that the server will automatically attach the

-
-ts
-
+
+
[in][allow-none][in][allow-none]

callback_target

user data to pass to callback .

[allow-none][closure][allow-none][closure]

callback_target_destroy_notify

function to call when callback_target is no longer needed.

[allow-none][allow-none]

room_id
+ + + + + + + 
1
ts
+
+

@@ -3338,7 +3685,7 @@ field

error

-

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

+

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

[error-domains MatrixError] @@ -3352,28 +3699,44 @@ field

matrix_api_redact_event (MatrixAPI *self, MatrixAPICallback callback, void *callback_target, - const gchar *room_id, - const gchar *event_id, - const gchar *txn_id, - const gchar *reason, - GError **error); + const gchar *room_id, + const gchar *event_id, + const gchar *txn_id, + const gchar *reason, + GError **error);

Strip all information out of an event which isn't critical to the integrity of the server-side representation of the room. This cannot be undone.

Users may redact their own events, and any user with a power level greater than or equal to

-
-redact
-
+
+ + + + + + + + 
1
redact
+
+

power level of the room may redact events there.

If param room_id, param event_id or param txn_id is

-
-null
-
+
+ + + + + + + + 
1
null
+
+

, this function returns immediately, and throws Matrix.Error.INCOMPLETE.

-

Parameters

+

Parameters

@@ -3393,19 +3756,19 @@ null

the function to call when the request is finished

.

- + - + - + @@ -3441,11 +3804,11 @@ is no longer needed.

the reason for the event being redacted

.

- + - + @@ -3459,21 +3822,29 @@ is no longer needed.

matrix_api_send_message_event (MatrixAPI *self, MatrixAPICallback callback, void *callback_target, - const gchar *room_id, - const gchar *event_type, - const gchar *txn_id, + const gchar *room_id, + const gchar *event_type, + const gchar *txn_id, JsonNode *content, - GError **error); + GError **error);

Send a message event to the room.

If param room_id, param event_type, param txn_id or content is

-
-null
-
+
+
[in][allow-none][in][allow-none]

callback_target

user data to pass to callback .

[allow-none][closure][allow-none][closure]

callback_target_destroy_notify

function to call when callback_target is no longer needed.

[allow-none][allow-none]

room_id

 [in][allow-none][in][allow-none]

error

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

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

[error-domains MatrixError]
+ + + + + + + 
1
null
+
+

, this function returns immediately, and throws Matrix.Error.INCOMPLETE.

-

Parameters

+

Parameters

@@ -3493,19 +3864,19 @@ null

the function to call when the request is finished

.

- + - + - + @@ -3545,7 +3916,7 @@ is no longer needed.

- + @@ -3559,28 +3930,44 @@ is no longer needed.

matrix_api_get_room_state (MatrixAPI *self, MatrixAPICallback callback, void *callback_target, - const gchar *room_id, - const gchar *event_type, - const gchar *state_key, - GError **error); + const gchar *room_id, + const gchar *event_type, + const gchar *state_key, + GError **error);

Look up the contents of a state event in a room. If both param event_type and param state_key are empty, get a list of state events for that room.

If param room_id is

-
-null
-
+
+
[in][allow-none][in][allow-none]

callback_target

user data to pass to callback .

[allow-none][closure][allow-none][closure]

callback_target_destroy_notify

function to call when callback_target is no longer needed.

[allow-none][allow-none]

room_id

error

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

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

[error-domains MatrixError]
+ + + + + + + 
1
null
+
+

, or if param state_key is set with param event_type being

-
-null
-
+
+ + + + + + + + 
1
null
+
+

, this function returns immediately, and throws Matrix.Error.INCOMPLETE.

-

Parameters

+

Parameters

@@ -3600,19 +3987,19 @@ null

the function to call when the request is finished

.

- + - + - + @@ -3630,7 +4017,7 @@ is no longer needed.

the type of state to look up

.

- + @@ -3640,20 +4027,28 @@ is no longer needed.

event_type is

-
-null
-
+
+
[in][allow-none][in][allow-none]

callback_target

user data to pass to callback .

[allow-none][closure][allow-none][closure]

callback_target_destroy_notify

function to call when callback_target is no longer needed.

[allow-none][allow-none]

room_id

 [in][allow-none][in][allow-none]

state_key
+ + + + + + + 
1
null
+
+

, this parameter is ignored

.

-[in][allow-none] +[in][allow-none]

error

-

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

+

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

[error-domains MatrixError] @@ -3667,11 +4062,11 @@ null matrix_api_send_room_event (MatrixAPI *self, MatrixAPICallback callback, void *callback_target, - const gchar *room_id, - const gchar *event_type, - const gchar *state_key, + const gchar *room_id, + const gchar *event_type, + const gchar *state_key, JsonNode *content, - GError **error); + GError **error);

Send a state event to the room. These events will be overwritten if param room_id, param event_type and param @@ -3680,9 +4075,17 @@ matrix_api_send_room_event (param content) vary depending on the type of the event.

If param room_id or param content is

-
-null
-
+
+ + + + + + + + 
1
null
+
+

@@ -3691,15 +4094,23 @@ null event_type being

-
-null
-
+
+ + + + + + + + 
1
null
+
+

, this function returns immediately, and throw Matrix.Error.INCOMPLETE.

-

Parameters

+

Parameters

@@ -3719,19 +4130,19 @@ null

the function to call when the request is finished

.

- + - + - + @@ -3759,16 +4170,24 @@ is no longer needed.

event_type is

-
-null
-
+
+
[in][allow-none][in][allow-none]

callback_target

user data to pass to callback .

[allow-none][closure][allow-none][closure]

callback_target_destroy_notify

function to call when callback_target is no longer needed.

[allow-none][allow-none]

room_id
+ + + + + + + 
1
null
+
+

, this parameter is ignored

.

-[in][allow-none] +[in][allow-none]

content

@@ -3781,7 +4200,7 @@ null

error

-

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

+

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

[error-domains MatrixError] @@ -3795,28 +4214,44 @@ null matrix_api_notify_room_typing (MatrixAPI *self, MatrixAPICallback callback, void *callback_target, - const gchar *user_id, - const gchar *room_id, - guint timeout, - gboolean typing, - GError **error); + const gchar *user_id, + const gchar *room_id, + guint timeout, + gboolean typing, + GError **error);

Tell the server the user is typing for the next param timeout milliseconds. If param typing is

-
-false
-
+
+ + + + + + + + 
1
false
+
+

, it tells the server that the user stopped typing.

If param user_id or param room_id is

-
-null
-
+
+ + + + + + + + 
1
null
+
+

, this function returns immediately, and throws Matrix.Error.INCOMPLETE.

-

Parameters

+

Parameters

@@ -3836,19 +4271,19 @@ null

the function to call when the request is finished

.

- + - + - + @@ -3884,9 +4319,17 @@ is no longer needed.

whether the user is typing or not. If

-
-false
-
+
+
[in][allow-none][in][allow-none]

callback_target

user data to pass to callback .

[allow-none][closure][allow-none][closure]

callback_target_destroy_notify

function to call when callback_target is no longer needed.

[allow-none][allow-none]

user_id
+ + + + + + + 
1
false
+
+

@@ -3898,7 +4341,7 @@ timeout can be omitted (ie. set to 0)

error

-

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

+

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

[error-domains MatrixError] @@ -3912,23 +4355,31 @@ timeout can be omitted (ie. set to 0)

matrix_api_sync (MatrixAPI *self, MatrixAPICallback callback, void *callback_target, - const gchar *filter_id, + const gchar *filter_id, MatrixFilter *filter, - const gchar *since, - gboolean full_state, - gboolean set_presence, - gulong timeout, - GError **error); + const gchar *since, + gboolean full_state, + gboolean set_presence, + gulong timeout, + GError **error);

Synchronize the client's state with the latest state on the server. Clients should use this API when they first log in to get an initial snapshot of the state on the server and then continue to call this API to get incremental details to the state and to receive new messages.

Only one of param filter and param filter_id should be specified, or both of them should be set to

-
-null
-
+
+ + + + + + + + 
1
null
+
+

to receive all events.

-

Parameters

+

Parameters

@@ -3948,19 +4399,19 @@ null

the function to call when the request is finished

.

- + - + - + @@ -3969,7 +4420,7 @@ is no longer needed.

a filter ID created by the filter API (e.g. matrix_api_create_filter())

.

- + @@ -3978,7 +4429,7 @@ is no longer needed.

a definition on what events to fetch

.

- + @@ -3987,7 +4438,7 @@ is no longer needed.

a point in time to continue a sync from

.

- + @@ -3996,9 +4447,17 @@ is no longer needed.

if

-
-true
-
+
+
[in][allow-none][in][allow-none]

callback_target

user data to pass to callback .

[allow-none][closure][allow-none][closure]

callback_target_destroy_notify

function to call when callback_target is no longer needed.

[allow-none][allow-none]

filter_id

 [in][allow-none][in][allow-none]

filter

 [in][allow-none][in][allow-none]

since

 [in][allow-none][in][allow-none]

full_state
+ + + + + + + 
1
true
+
+

@@ -4006,9 +4465,17 @@ true since is not empty. If

-
-false
-
+
+ + + + + + + + 
1
false
+
+

@@ -4039,7 +4506,7 @@ since will be returned

error

-

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

+

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

[error-domains MatrixError] @@ -4053,19 +4520,27 @@ since will be returned

matrix_api_create_filter (MatrixAPI *self, MatrixAPICallback callback, void *callback_target, - const gchar *user_id, + const gchar *user_id, MatrixFilter *filter, - GError **error); + GError **error);

Upload a new filter definition to the homeserver. It will return a filter ID that may be used in future requests.

If param user_id or param filter is

-
-null
-
+
+ + + + + + + + 
1
null
+
+

, this function returns immediately, and throws Matrix.Error.INCOMPLETE.

-

Parameters

+

Parameters

@@ -4085,19 +4560,19 @@ null

the function to call when the request is finished

.

- + - + - + @@ -4119,7 +4594,7 @@ is no longer needed.

- + @@ -4133,19 +4608,27 @@ is no longer needed.

matrix_api_download_filter (MatrixAPI *self, MatrixAPICallback callback, void *callback_target, - const gchar *user_id, - const gchar *filter_id, - GError **error); + const gchar *user_id, + const gchar *filter_id, + GError **error);

Download a filter.

If param user_id or param filter_id is

-
-null
-
+
+
[in][allow-none][in][allow-none]

callback_target

user data to pass to callback .

[allow-none][closure][allow-none][closure]

callback_target_destroy_notify

function to call when callback_target is no longer needed.

[allow-none][allow-none]

user_id

error

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

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

[error-domains MatrixError]
+ + + + + + + 
1
null
+
+

, this function returns immediately, and throws Matrix.Error.INCOMPLETE.

-

Parameters

+

Parameters

@@ -4165,19 +4648,19 @@ null

the function to call when the request is finished

.

- + - + - + @@ -4199,7 +4682,7 @@ is no longer needed.

- + @@ -4213,12 +4696,12 @@ is no longer needed.

matrix_api_search (MatrixAPI *self, MatrixAPICallback callback, void *callback_target, - const gchar *next_batch, + const gchar *next_batch, MatrixSearchCategories *search_categories, - GError **error); + GError **error);

Perform a server side search.

-

Parameters

+

Parameters

[in][allow-none][in][allow-none]

callback_target

user data to pass to callback .

[allow-none][closure][allow-none][closure]

callback_target_destroy_notify

function to call when callback_target is no longer needed.

[allow-none][allow-none]

user_id

error

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

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

[error-domains MatrixError]
@@ -4235,13 +4718,13 @@ matrix_api_search (

callback_target

 - + - + @@ -4250,7 +4733,7 @@ is no longer needed.

the point to return events from. If given, this should be a next_batch result from a previous call to this method

.

- + @@ -4268,7 +4751,7 @@ is no longer needed.

- + @@ -4282,18 +4765,26 @@ is no longer needed.

matrix_api_whois (MatrixAPI *self, MatrixAPICallback callback, void *callback_target, - const gchar *user_id, - GError **error); + const gchar *user_id, + GError **error);

Get information about a particular user.

If param user_id is

-
-null
-
+
+

user data to pass to callback .

[allow-none][closure][allow-none][closure]

callback_target_destroy_notify

function to call when callback_target is no longer needed.

[allow-none][allow-none]

next_batch

[in][allow-none][in][allow-none]

search_categories

error

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

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

[error-domains MatrixError]
+ + + + + + + 
1
null
+
+

, this function returns immediately, and throws Matrix.Error.INCOMPLETE.

-

Parameters

+

Parameters

@@ -4313,19 +4804,19 @@ null

the function to call when the request is finished

.

- + - + - + @@ -4338,7 +4829,7 @@ is no longer needed.

- + @@ -4352,10 +4843,10 @@ is no longer needed.

matrix_api_versions (MatrixAPI *self, MatrixAPICallback callback, void *callback_target, - GError **error); + GError **error);

Get the versions of the specification supported by the server.

-

Parameters

+

Parameters

[in][allow-none][in][allow-none]

callback_target

user data to pass to callback .

[allow-none][closure][allow-none][closure]

callback_target_destroy_notify

function to call when callback_target is no longer needed.

[allow-none][allow-none]

user_id

error

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

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

[error-domains MatrixError]
@@ -4375,23 +4866,23 @@ matrix_api_versions ([in][allow-none] + - + - + - + @@ -4405,20 +4896,28 @@ is no longer needed.

matrix_api_login (MatrixAPI *self, MatrixAPICallback callback, void *callback_target, - const gchar *login_type, + const gchar *login_type, JsonNode *content, - GError **error); + GError **error);

Attempt to login with type param type. Implementations of this method must set the token property on a successful login.

If param login_type or param content is

-
-null
-
+
+
[in][allow-none]

callback_target

user data to pass to callback .

[allow-none][closure][allow-none][closure]

callback_target_destroy_notify

function to call when callback_target is no longer needed.

[allow-none][allow-none]

error

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

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

[error-domains MatrixError]
+ + + + + + + 
1
null
+
+

, this function returns immediately, and throws Matrix.Error.INCOMPLETE.

-

Parameters

+

Parameters

@@ -4438,19 +4937,19 @@ null

the function to call when the request is finished

.

- + - + - + @@ -4468,11 +4967,11 @@ is no longer needed.

parameters to pass for the login request

.

- + - + @@ -4486,17 +4985,25 @@ is no longer needed.

matrix_api_token_refresh (MatrixAPI *self, MatrixAPICallback callback, void *callback_target, - const gchar *refresh_token, - GError **error); + const gchar *refresh_token, + GError **error);

Exchanges a refresh token for a new access token. This is intended to be used if the access token has expired. If param refresh_token is

-
-null
-
+
+
[in][allow-none][in][allow-none]

callback_target

user data to pass to callback .

[allow-none][closure][allow-none][closure]

callback_target_destroy_notify

function to call when callback_target is no longer needed.

[allow-none][allow-none]

login_type

 [in][allow-none][in][allow-none]

error

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

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

[error-domains MatrixError]
+ + + + + + + 
1
null
+
+

, implementations MUST send the stored refresh token. If it is not pesent (e.g. because login hasn’t happened yet), this function MUST throw an error.

-

Parameters

+

Parameters

@@ -4516,19 +5023,19 @@ null

the function to call when the request is finished

.

- + - + - + @@ -4537,11 +5044,11 @@ is no longer needed.

the refresh token that was issued by the server

.

- + - + @@ -4555,12 +5062,12 @@ is no longer needed.

matrix_api_get_3pids (MatrixAPI *self, MatrixAPICallback callback, void *callback_target, - GError **error); + GError **error);

Get a list of the third party identifiers that a homeserver has associated with the user's account.

This is not the same as the list of third party identifiers bound to the user's Matrix ID in Identity Servers.

Identifiers in this list may be used by the homeserver as, for example, identifiers to accept to reset the user's account password.

-

Parameters

+

Parameters

[in][allow-none][in][allow-none]

callback_target

user data to pass to callback .

[allow-none][closure][allow-none][closure]

callback_target_destroy_notify

function to call when callback_target is no longer needed.

[allow-none][allow-none]

refresh_token

 [in][allow-none][in][allow-none]

error

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

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

[error-domains MatrixError]
@@ -4580,23 +5087,23 @@ matrix_api_get_3pids ([in][allow-none] + - + - + - + @@ -4610,19 +5117,27 @@ is no longer needed.

matrix_api_add_3pid (MatrixAPI *self, MatrixAPICallback callback, void *callback_target, - gboolean bind_creds, + gboolean bind_creds, Matrix3PidCredential *threepid_creds, - GError **error); + GError **error);

Add contact information to the user's account.

If param threepid_creds is

-
-null
-
+
+
[in][allow-none]

callback_target

user data to pass to callback .

[allow-none][closure][allow-none][closure]

callback_target_destroy_notify

function to call when callback_target is no longer needed.

[allow-none][allow-none]

error

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

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

[error-domains MatrixError]
+ + + + + + + 
1
null
+
+

, this function returns immediately, and throws Matrix.Error.INCOMPLETE.

-

Parameters

+

Parameters

@@ -4642,19 +5157,19 @@ null

the function to call when the request is finished

.

- + - + - + @@ -4676,7 +5191,7 @@ is no longer needed.

- + @@ -4690,18 +5205,26 @@ is no longer needed.

matrix_api_change_password (MatrixAPI *self, MatrixAPICallback callback, void *callback_target, - const gchar *new_password, - GError **error); + const gchar *new_password, + GError **error);

Change the active user's password.

If param new_password is

-
-null
-
+
+
[in][allow-none][in][allow-none]

callback_target

user data to pass to callback .

[allow-none][closure][allow-none][closure]

callback_target_destroy_notify

function to call when callback_target is no longer needed.

[allow-none][allow-none]

bind_creds

error

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

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

[error-domains MatrixError]
+ + + + + + + 
1
null
+
+

, this function returns immediately, and throws Matrix.Error.INCOMPLETE.

-

Parameters

+

Parameters

@@ -4721,19 +5244,19 @@ null

the function to call when the request is finished

.

- + - + - + @@ -4746,7 +5269,7 @@ is no longer needed.

- + @@ -4760,18 +5283,26 @@ is no longer needed.

matrix_api_get_profile (MatrixAPI *self, MatrixAPICallback callback, void *callback_target, - const gchar *user_id, - GError **error); + const gchar *user_id, + GError **error);

Get a user's profile.

If param user_id is

-
-null
-
+
+
[in][allow-none][in][allow-none]

callback_target

user data to pass to callback .

[allow-none][closure][allow-none][closure]

callback_target_destroy_notify

function to call when callback_target is no longer needed.

[allow-none][allow-none]

new_password

error

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

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

[error-domains MatrixError]
+ + + + + + + 
1
null
+
+

, this function returns immediately, and throws Matrix.Error.INCOMPLETE.

-

Parameters

+

Parameters

@@ -4791,19 +5322,19 @@ null

the function to call when the request is finished

.

- + - + - + @@ -4816,7 +5347,7 @@ is no longer needed.

- + @@ -4830,18 +5361,26 @@ is no longer needed.

matrix_api_get_avatar_url (MatrixAPI *self, MatrixAPICallback callback, void *callback_target, - const gchar *user_id, - GError **error); + const gchar *user_id, + GError **error);

Get the URL of the specified user's avatar.

If param user_id is

-
-null
-
+
+
[in][allow-none][in][allow-none]

callback_target

user data to pass to callback .

[allow-none][closure][allow-none][closure]

callback_target_destroy_notify

function to call when callback_target is no longer needed.

[allow-none][allow-none]

user_id

error

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

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

[error-domains MatrixError]
+ + + + + + + 
1
null
+
+

, this function returns immediately, and throws Matrix.Error.INCOMPLETE.

-

Parameters

+

Parameters

@@ -4861,19 +5400,19 @@ null

the function to call when the request is finished

.

- + - + - + @@ -4886,7 +5425,7 @@ is no longer needed.

- + @@ -4900,19 +5439,27 @@ is no longer needed.

matrix_api_set_avatar_url (MatrixAPI *self, MatrixAPICallback callback, void *callback_target, - const gchar *user_id, - const gchar *avatar_url, - GError **error); + const gchar *user_id, + const gchar *avatar_url, + GError **error);

Set the user's avatar URL.

If param user_id or param avatar_url is

-
-null
-
+
+
[in][allow-none][in][allow-none]

callback_target

user data to pass to callback .

[allow-none][closure][allow-none][closure]

callback_target_destroy_notify

function to call when callback_target is no longer needed.

[allow-none][allow-none]

user_id

error

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

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

[error-domains MatrixError]
+ + + + + + + 
1
null
+
+

, this function returns immediately, and throws Matrix.Error.INCOMPLETE.

-

Parameters

+

Parameters

@@ -4932,19 +5479,19 @@ null

the function to call when the request is finished

.

- + - + - + @@ -4966,7 +5513,7 @@ is no longer needed.

- + @@ -4980,18 +5527,26 @@ is no longer needed.

matrix_api_get_display_name (MatrixAPI *self, MatrixAPICallback callback, void *callback_target, - const gchar *user_id, - GError **error); + const gchar *user_id, + GError **error);

Get the user's display name.

If param user_id is

-
-null
-
+
+
[in][allow-none][in][allow-none]

callback_target

user data to pass to callback .

[allow-none][closure][allow-none][closure]

callback_target_destroy_notify

function to call when callback_target is no longer needed.

[allow-none][allow-none]

user_id

error

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

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

[error-domains MatrixError]
+ + + + + + + 
1
null
+
+

, this function returns immediately, and throws Matrix.Error.INCOMPLETE.

-

Parameters

+

Parameters

@@ -5011,19 +5566,19 @@ null

the function to call when the request is finished

.

- + - + - + @@ -5036,7 +5591,7 @@ is no longer needed.

- + @@ -5050,19 +5605,27 @@ is no longer needed.

matrix_api_set_display_name (MatrixAPI *self, MatrixAPICallback callback, void *callback_target, - const gchar *user_id, - const gchar *display_name, - GError **error); + const gchar *user_id, + const gchar *display_name, + GError **error);

Set the user's display name.

If param user_id or param display_name is

-
-null
-
+
+
[in][allow-none][in][allow-none]

callback_target

user data to pass to callback .

[allow-none][closure][allow-none][closure]

callback_target_destroy_notify

function to call when callback_target is no longer needed.

[allow-none][allow-none]

user_id

error

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

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

[error-domains MatrixError]
+ + + + + + + 
1
null
+
+

, this function returns immediately, and throws Matrix.Error.INCOMPLETE.

-

Parameters

+

Parameters

@@ -5082,19 +5645,19 @@ null

the function to call when the request is finished

.

- + - + - + @@ -5116,7 +5679,7 @@ is no longer needed.

- + @@ -5130,26 +5693,34 @@ is no longer needed.

matrix_api_register_account (MatrixAPI *self, MatrixAPICallback callback, void *callback_target, - MatrixAccountKind account_kind, - gboolean bind_email, - const gchar *username, - const gchar *password, - GError **error); + MatrixAccountKind account_kind, + gboolean bind_email, + const gchar *username, + const gchar *password, + GError **error);

Attempt to register an account with the homeserver using param username and param password.

Implementations of this method must set the token property on a successful login.

If param password is

-
-null
-
+
+
[in][allow-none][in][allow-none]

callback_target

user data to pass to callback .

[allow-none][closure][allow-none][closure]

callback_target_destroy_notify

function to call when callback_target is no longer needed.

[allow-none][allow-none]

user_id

error

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

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

[error-domains MatrixError]
+ + + + + + + 
1
null
+
+

, this function returns immediately, and throws Matrix.Error.INCOMPLETE.

-

Parameters

+

Parameters

@@ -5169,19 +5740,19 @@ null

the function to call when the request is finished

.

- + - + - + @@ -5199,9 +5770,17 @@ is no longer needed.

if

-
-true
-
+
+
[in][allow-none][in][allow-none]

callback_target

user data to pass to callback .

[allow-none][closure][allow-none][closure]

callback_target_destroy_notify

function to call when callback_target is no longer needed.

[allow-none][allow-none]

account_kind
+ + + + + + + 
1
true
+
+

@@ -5217,7 +5796,7 @@ true

the local part of the desired Matrix ID. If omitted, the server will generate a local part

.

-[in][allow-none] +[in][allow-none]

password

@@ -5230,7 +5809,7 @@ true

error

-

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

+

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

[error-domains MatrixError] @@ -5244,21 +5823,29 @@ true matrix_api_set_account_data (MatrixAPI *self, MatrixAPICallback callback, void *callback_target, - const gchar *user_id, - const gchar *room_id, - const gchar *event_type, + const gchar *user_id, + const gchar *room_id, + const gchar *event_type, JsonNode *content, - GError **error); + GError **error);

Set some account data for the client. This config is only visible to the user who set the account data. The config will be synced to clients in the top-level account data.

If param user_id, param event_type or param content is

-
-null
-
+
+ + + + + + + + 
1
null
+
+

, this function returns immediately, and throws Matrix.Error.INCOMPLETE.

-

Parameters

+

Parameters

@@ -5278,19 +5865,19 @@ null

the function to call when the request is finished

.

- + - + - + @@ -5308,16 +5895,24 @@ is no longer needed.

the room to set account data for. If

-
-null
-
+
+
[in][allow-none][in][allow-none]

callback_target

user data to pass to callback .

[allow-none][closure][allow-none][closure]

callback_target_destroy_notify

function to call when callback_target is no longer needed.

[allow-none][allow-none]

user_id
+ + + + + + + 
1
null
+
+

, the account data will be set globally

.

-[in][allow-none] +[in][allow-none]

event_type

@@ -5339,7 +5934,7 @@ null

error

-

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

+

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

[error-domains MatrixError] @@ -5353,19 +5948,27 @@ null matrix_api_get_room_tags (MatrixAPI *self, MatrixAPICallback callback, void *callback_target, - const gchar *user_id, - const gchar *room_id, - GError **error); + const gchar *user_id, + const gchar *room_id, + GError **error);

List the tags set by a user on a room.

If param user_id or param room_id is

-
-null
-
+
+ + + + + + + + 
1
null
+
+

, this function returns immediately, and throws Matrix.Error.INCOMPLETE.

-

Parameters

+

Parameters

@@ -5385,19 +5988,19 @@ null

the function to call when the request is finished

.

- + - + - + @@ -5419,7 +6022,7 @@ is no longer needed.

- + @@ -5433,20 +6036,28 @@ is no longer needed.

matrix_api_delete_room_tag (MatrixAPI *self, MatrixAPICallback callback, void *callback_target, - const gchar *user_id, - const gchar *room_id, - const gchar *tag, - GError **error); + const gchar *user_id, + const gchar *room_id, + const gchar *tag, + GError **error);

Remove a tag from the room.

If param user_id, param room_id or param tag is

-
-null
-
+
+
[in][allow-none][in][allow-none]

callback_target

user data to pass to callback .

[allow-none][closure][allow-none][closure]

callback_target_destroy_notify

function to call when callback_target is no longer needed.

[allow-none][allow-none]

user_id

error

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

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

[error-domains MatrixError]
+ + + + + + + 
1
null
+
+

, this function returns immediately, and throws Matrix.Error.INCOMPLETE.

-

Parameters

+

Parameters

@@ -5466,19 +6077,19 @@ null

the function to call when the request is finished

.

- + - + - + @@ -5509,7 +6120,7 @@ is no longer needed.

- + @@ -5523,21 +6134,29 @@ is no longer needed.

matrix_api_add_room_tag (MatrixAPI *self, MatrixAPICallback callback, void *callback_target, - const gchar *user_id, - const gchar *room_id, - const gchar *tag, + const gchar *user_id, + const gchar *room_id, + const gchar *tag, JsonNode *content, - GError **error); + GError **error);

Add a tag to the room.

If param user_id, param room_id or param tag is

-
-null
-
+
+
[in][allow-none][in][allow-none]

callback_target

user data to pass to callback .

[allow-none][closure][allow-none][closure]

callback_target_destroy_notify

function to call when callback_target is no longer needed.

[allow-none][allow-none]

user_id

error

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

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

[error-domains MatrixError]
+ + + + + + + 
1
null
+
+

, this function returns immediately, and throws Matrix.Error.INCOMPLETE.

-

Parameters

+

Parameters

@@ -5557,19 +6176,19 @@ null

the function to call when the request is finished

.

- + - + - + @@ -5605,11 +6224,11 @@ is no longer needed.

extra data for the tag, e.g. ordering

.

- + - + @@ -5623,10 +6242,10 @@ is no longer needed.

matrix_api_get_turn_server (MatrixAPI *self, MatrixAPICallback callback, void *callback_target, - GError **error); + GError **error);

Get credentials for the client to use when initiating calls.

-

Parameters

+

Parameters

[in][allow-none][in][allow-none]

callback_target

user data to pass to callback .

[allow-none][closure][allow-none][closure]

callback_target_destroy_notify

function to call when callback_target is no longer needed.

[allow-none][allow-none]

user_id

 [in][allow-none][transfer full][in][allow-none][transfer full]

error

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

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

[error-domains MatrixError]
@@ -5646,23 +6265,23 @@ matrix_api_get_turn_server ([in][allow-none] + - + - + - + @@ -5674,23 +6293,31 @@ is no longer needed.

MatrixAPICallback ()

void
 (*MatrixAPICallback) (MatrixAPI *api,
-                      const gchar *content_type,
+                      const gchar *content_type,
                       JsonNode *json_content,
-                      GByteArray *raw_content,
-                      GError *err,
+                      GByteArray *raw_content,
+                      GError *err,
                       void *user_data);

A callback function to use with Client API calls. If the response is JSON, param json_content is set and param raw_content is not. If the response is not JSON, but still has a body (e.g. with media downloads), param json_content is

-
-null
-
+
+
[in][allow-none]

callback_target

user data to pass to callback .

[allow-none][closure][allow-none][closure]

callback_target_destroy_notify

function to call when callback_target is no longer needed.

[allow-none][allow-none]

error

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

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

[error-domains MatrixError]
+ + + + + + + 
1
null
+
+

and raw_content holds the content body.

-

Parameters

+

Parameters

@@ -5723,7 +6350,7 @@ null

the JSON content of the response

.

- + @@ -5732,7 +6359,7 @@ null

the raw (ie. binary) content of the response

.

- + @@ -5741,16 +6368,24 @@ null

a GLib.Error that holds any errors that occured during the API call, or

-
-null
-
+
+
[in][allow-none][in][allow-none]

raw_content

 [in][allow-none][in][allow-none]

err
+ + + + + + + 
1
null
+
+

.

-[in][allow-none] +[in][allow-none]

user_data

@@ -5764,12 +6399,12 @@ null

matrix_api_get_token ()

-
const gchar *
+
const gchar *
 matrix_api_get_token (MatrixAPI *self);

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

 
The token to use for authorization. The Matrix.API.login() and Matrix.API.register_account() calls MUST set this automatically.

 

-
Parameters

+
Parameters

 
@@ -5784,9 +6419,8 @@ matrix_api_get_token (
-
Returns

+
Returns

 
 the value of the "token" property

-

 
 
 

@@ -5794,12 +6428,12 @@ matrix_api_get_token (
matrix_api_set_token ()

 
void
 matrix_api_set_token (MatrixAPI *self,
-                      const gchar *value);

+                      const gchar *value);
 
Set the value of the "token" property to value
 .

 
The token to use for authorization. The Matrix.API.login() and Matrix.API.register_account() calls MUST set this automatically.

 

-
Parameters

+
Parameters

 

 
 

@@ -5824,12 +6458,12 @@ matrix_api_set_token (
 
matrix_api_get_refresh_token ()

-
const gchar *
+
const gchar *
 matrix_api_get_refresh_token (MatrixAPI *self);

 
Get and return the current value of the "refresh-token" property.

 
The token to use for refreshing the authorization token. It is issued by the server after a successful registration, login or token refresh.

 

-
Parameters

+
Parameters

 

 
 

@@ -5844,9 +6478,8 @@ matrix_api_get_refresh_token (
-
Returns

+
Returns

 
 the value of the "refresh-token" property

-

 
 
 

@@ -5854,12 +6487,12 @@ matrix_api_get_refresh_token (
matrix_api_set_refresh_token ()

 
void
 matrix_api_set_refresh_token (MatrixAPI *self,
-                              const gchar *value);

+                              const gchar *value);
 
Set the value of the "refresh-token" property to value
 .

 
The token to use for refreshing the authorization token. It is issued by the server after a successful registration, login or token refresh.

 

-
Parameters

+
Parameters

 

 
 

@@ -5884,12 +6517,12 @@ matrix_api_set_refresh_token (
 
matrix_api_get_user_id ()

-
const gchar *
+
const gchar *
 matrix_api_get_user_id (MatrixAPI *self);

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

 
The Matrix user ID that is currently authenticated with the server. It is set automatically by the registration and login process.

 

-
Parameters

+
Parameters

 

 
 

@@ -5904,20 +6537,19 @@ matrix_api_get_user_id (
-
Returns

+
Returns

 
 the value of the "user-id" property

-

 
 
 

 

 
matrix_api_get_homeserver ()

-
const gchar *
+
const gchar *
 matrix_api_get_homeserver (MatrixAPI *self);

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

 
The name of the Matrix home server as it calls itself. It is set automatically by the registration and login process.

 

-
Parameters

+
Parameters

 

 
 

@@ -5932,9 +6564,8 @@ matrix_api_get_homeserver (
-
Returns

+
Returns

 
 the value of the "homeserver" property

-

 
 
 
@@ -5955,16 +6586,16 @@ matrix_api_get_homeserver (MatrixAPI implementations.

 

-
Members

+
Members

 

 
 

@@ -6029,7 +6660,7 @@ matrix_api_get_homeserver (
GTypeInterface parent_iface;

+
@@ -6064,8 +6695,8 @@ matrix_api_get_homeserver ( 
 
 
-
-
+
+
@@ -6370,7 +7001,6 @@ matrix_api_get_homeserver (
-

-          Generated by GTK-Doc V1.20
+
Generated by GTK-Doc V1.24
 
 
\ No newline at end of file
diff --git a/Matrix-0.0-MatrixClient.html b/Matrix-0.0-MatrixClient.html
index 874fdd4..7a56b58 100644
--- a/Matrix-0.0-MatrixClient.html
+++ b/Matrix-0.0-MatrixClient.html
@@ -2,26 +2,25 @@
 
 
 
-Matrix-0.0 Reference Manual: MatrixClient
+MatrixClient: Matrix-0.0 Reference Manual
 
 
 
-
-
-
+
+
+
 
 
 
-

 
 

GTypeInterface parent_iface;

 
the parent interface structure

  
 
get_user_presence ()
virtual method called by matrix_api_get_user_presence()
get_presence ()
virtual method called by matrix_api_get_presence()

  
 

 

+
-
-
+
+
 

 

@@ -106,6 +105,30 @@
 
 
 
+MatrixProfile *
+
+
+matrix_client_get_user_profile ()
+
+
+
+
+MatrixPresence
+
+
+matrix_client_get_user_presence ()
+
+
+
+
+MatrixRoom *
+
+
+matrix_client_get_room_by_id ()
+
+
+
+
 void
 
 
@@ -135,11 +158,6 @@
 

 

 

-
Object Hierarchy

-
-

-

-

 
Description

 

 

@@ -148,12 +166,12 @@
 
matrix_client_login_with_password ()

 
void
 matrix_client_login_with_password (MatrixClient *self,
-                                   const gchar *username,
-                                   const gchar *password,
-                                   GError **error);

+                                   const gchar *username,
+                                   const gchar *password,
+                                   GError **error);

Authenticate with the Matrix.org server with a username and password.

-

Parameters

+

Parameters

@@ -186,7 +204,7 @@ matrix_client_login_with_password ( - + @@ -198,16 +216,16 @@ matrix_client_login_with_password (

matrix_client_register_with_password ()

void
 matrix_client_register_with_password (MatrixClient *self,
-                                      const gchar *username,
-                                      const gchar *password,
-                                      GError **error);
+ const gchar *username, + const gchar *password, + GError **error);

Register username with the homeserver as a normal user.

Upon success, the user is registered and authenticated.

Implementations must emit the login-finished signal when a response arrives.

This method registers a normal user account. If you want to register a different kind of user, use matrix_api_register_account().

-

Parameters

+

Parameters

error

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

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

[error-domains MatrixError]
@@ -227,7 +245,7 @@ matrix_client_register_with_password ([in][allow-none] + @@ -240,7 +258,7 @@ matrix_client_register_with_password (

error

- + @@ -252,10 +270,10 @@ matrix_client_register_with_password (

matrix_client_logout ()

void
 matrix_client_logout (MatrixClient *self,
-                      GError **error);
+ GError **error);

Logout from the homeserver. As Matrix.org doesn’t have such a concept, this cancels all ongoing requests and clears the authentication data (e.g. tokens).

-

Parameters

+

Parameters

[in][allow-none]

password

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

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

[error-domains MatrixError]
@@ -270,7 +288,7 @@ matrix_client_logout (

error

- + @@ -282,10 +300,10 @@ matrix_client_logout (

matrix_client_begin_polling ()

void
 matrix_client_begin_polling (MatrixClient *self,
-                             GError **error);
+ GError **error);

Begin polling the event stream.

-

Parameters

+

Parameters

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

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

[error-domains MatrixError]
@@ -300,7 +318,7 @@ matrix_client_begin_polling (

error

- + @@ -312,17 +330,25 @@ matrix_client_begin_polling (

matrix_client_stop_polling ()

void
 matrix_client_stop_polling (MatrixClient *self,
-                            gboolean cancel_ongoing,
-                            GError **error);
+ gboolean cancel_ongoing, + GError **error);

Stop polling the event stream. If param cancel_ongoing is

-
-true
-
+
+

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

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

[error-domains MatrixError]
+ + + + + + + 
1
true
+
+

, ongoing requests will be cancelled, too.

-

Parameters

+

Parameters

@@ -342,9 +368,17 @@ true

if

-
-true
-
+
+
+ + + + + + + 
1
true
+
+

@@ -355,7 +389,7 @@ true

error

-

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

+

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

[error-domains MatrixError] @@ -367,10 +401,10 @@ true

matrix_client_emit_login_finished ()

void
 matrix_client_emit_login_finished (MatrixClient *self,
-                                   gboolean success);
+ gboolean success);

Convenience function to emits the login-finished signal.

-

Parameters

+

Parameters

@@ -390,9 +424,17 @@ matrix_client_emit_login_finished (set to

-
-true
-
+
+
+ + + + + + + 
1
true
+
+

@@ -410,12 +452,12 @@ if login was successful

matrix_client_incoming_event ()

void
 matrix_client_incoming_event (MatrixClient *self,
-                              const gchar *room_id,
+                              const gchar *room_id,
                               JsonNode *raw_event,
-                              MatrixEvent *matrix_event);
+ MatrixEventBase *matrix_event);

Emits the “event” signal.

-

Parameters

+

Parameters

@@ -435,7 +477,7 @@ matrix_client_incoming_event ([in][allow-none] + @@ -453,7 +495,7 @@ matrix_client_incoming_event ([in] +
[in][allow-none]

raw_event

[in][allow-none]
@@ -464,15 +506,15 @@ matrix_client_incoming_event (

matrix_client_connect_event ()

void
 matrix_client_connect_event (MatrixClient *self,
-                             GType event_gtype,
+                             GType event_gtype,
                              MatrixClientEventCallback event_callback,
                              void *event_callback_target,
-                             GDestroyNotify event_callback_target_destroy_notify);
+ GDestroyNotify event_callback_target_destroy_notify);

Connect a handler for events. If param event_gtype is Matrix.Event, all events will be sent to the callback function, otherwise only events that match the specified event type.

-

If event_gtype is not derived from MatrixEvent, param callback won’t get connected.

+

If event_gtype is not derived from Matrix.Event, param callback won’t get connected.

-

Parameters

+

Parameters

@@ -481,11 +523,6 @@ matrix_client_connect_event (

callback

- - - - @@ -494,7 +531,16 @@ matrix_client_connect_event (

event_gtype

 + + + + + @@ -503,18 +549,13 @@ matrix_client_connect_event (

event_callback_target

 - + - - - - - - +

the allback function to connect

 

self

the MatrixClient instance

  

 .

-

the GType of a MatrixEvent derivative

+

the GType of a Matrix.Event derivative

+

.

+		[in]

event_callback

 +

 .

+

the allback function to connect

.

[in]

user data to pass to event_callback .

[allow-none][closure][allow-none][closure]

event_callback_target_destroy_notify

function to call when event_callback_target is no longer needed.

[allow-none]

event_callback

 

 [allow-none]
@@ -522,16 +563,149 @@ is no longer needed.

+

matrix_client_get_user_profile ()

+
MatrixProfile *
+matrix_client_get_user_profile (MatrixClient *self,
+                                const gchar *user_id,
+                                const gchar *room_id,
+                                GError **error);
+

Get the profile of a user specified by param + user_id. If param + room_id is not null, return the room-specific profile. If the user's profile is not cached yet, Matrix.Error.UNAVAILABLE is thrown.

+
+

Parameters

+
+++++ + + + + + + + + + + + + + + + + + + + + + + +

self

the MatrixClient instance

 

user_id

 

 

room_id

 

 

error

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

[error-domains MatrixError]
+
+
+
+
+

matrix_client_get_user_presence ()

+
MatrixPresence
+matrix_client_get_user_presence (MatrixClient *self,
+                                 const gchar *user_id,
+                                 const gchar *room_id,
+                                 GError **error);
+

Get the presence state of a user specified by param + user_id. If param + room_id is null, return the room specific presence state. If the user's presence state is not cached yet, Matrix.Error.UNAVAILABLE is thrown.

+
+

Parameters

+
+++++ + + + + + + + + + + + + + + + + + + + + + + +

self

the MatrixClient instance

 

user_id

 

 

room_id

 

 

error

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

[error-domains MatrixError]
+
+
+
+
+

matrix_client_get_room_by_id ()

+
MatrixRoom *
+matrix_client_get_room_by_id (MatrixClient *self,
+                              const gchar *room_id,
+                              GError **error);
+

Get a room object by the room ID specified in param + room_id. If room data is not cached yet, Matrix.Error.UNAVAILABLE is thrown.

+
+

Parameters

+
+++++ + + + + + + + + + + + + + + + + + +

self

the MatrixClient instance

 

room_id

 +

 .

+

the ID of a room

+

.

+		[in]

error

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

[error-domains MatrixError]
+
+
+

Returns

+

a Matrix.Room object

+
+
+
+

MatrixClientEventCallback ()

void
 (*MatrixClientEventCallback) (MatrixClient *client,
-                              const gchar *room_id,
+                              const gchar *room_id,
                               JsonNode *raw_event,
-                              MatrixEvent *matrix_event,
+                              MatrixEventBase *matrix_event,
                               void *user_data);

Callback function delegate for the event signal.

-

Parameters

+

Parameters

@@ -546,7 +720,7 @@ is no longer needed.

the room the event associated with

.

- + @@ -564,7 +738,7 @@ is no longer needed.

the event as a Matrix.Event object

.

- + @@ -598,13 +772,16 @@ is no longer needed.

void (*logout) (MatrixClient* self, GError** error); void (*begin_polling) (MatrixClient* self, GError** error); void (*stop_polling) (MatrixClient* self, gboolean cancel_ongoing, GError** error); + MatrixProfile* (*get_user_profile) (MatrixClient* self, const gchar* user_id, const gchar* room_id, GError** error); + MatrixPresence (*get_user_presence) (MatrixClient* self, const gchar* user_id, const gchar* room_id, GError** error); + MatrixRoom* (*get_room_by_id) (MatrixClient* self, const gchar* room_id, GError** error); void (*login_finished) (MatrixClient* self, gboolean success); - void (*event) (MatrixClient* self, const gchar* room_id, JsonNode* raw_event, MatrixEvent* matrix_event); + void (*event) (MatrixClient* self, const gchar* room_id, JsonNode* raw_event, MatrixEventBase* matrix_event); };

Interface for creating MatrixClient implementations.

-

Members

+

Members

[in][allow-none][in][allow-none]

raw_event

 [in][in][allow-none]

client
@@ -613,7 +790,7 @@ is no longer needed.

- + @@ -643,6 +820,21 @@ is no longer needed.

+ + + + + + + + + + + + + + + @@ -659,7 +851,6 @@ is no longer needed.

-
- Generated by GTK-Doc V1.20
+
Generated by GTK-Doc V1.24 \ No newline at end of file diff --git a/Matrix-0.0-MatrixEvent.html b/Matrix-0.0-MatrixEvent.html deleted file mode 100644 index 11d9c7a..0000000 --- a/Matrix-0.0-MatrixEvent.html +++ /dev/null @@ -1,916 +0,0 @@ - - - - -Matrix-0.0 Reference Manual: MatrixEvent - - - - - - - - - -

GTypeInterface parent_iface;

GTypeInterface parent_iface;

the parent interface structure

  
 

get_user_profile ()

virtual method called by matrix_client_get_user_profile()

 

get_user_presence ()

virtual method called by matrix_client_get_user_presence()

 

get_room_by_id ()

virtual method called by matrix_client_get_room_by_id()

 

login_finished ()

    
- - - - - - -
-
-
- - -
-

MatrixEvent

-

MatrixEvent — Base class for Matrix events.

-
-
-

Functions

-
---- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
#defineMATRIX_TYPE_EVENT
-void - -matrix_event_from_json () -
-void - -matrix_event_to_json () -
-void - -matrix_event_set_custom_field () -
-JsonNode * - -matrix_event_get_custom_field () -
-void - -matrix_event_delete_custom_field () -
-MatrixEvent * - -matrix_event_new () -
const gchar * - -matrix_event_get_sender () -
-void - -matrix_event_set_sender () -
const gchar * - -matrix_event_get_room_id () -
-void - -matrix_event_set_room_id () -
const gchar * - -matrix_event_get_event_type () -
-gulong * - -matrix_event_get_origin_server_ts () -
-void - -matrix_event_set_origin_server_ts () -
-MatrixUnsignedEventData * - -matrix_event_get_unsigned_data () -
-void - -matrix_event_set_unsigned_data () -
-JsonNode * - -matrix_event_get_json () -
-MatrixEvent * - -matrix_event_new_from_json () -
-GType - -matrix_event_get_handler () -
-void - -matrix_event_register_type () -
-void - -matrix_event_unregister_type () -
-
-
-

Types and Values

-
---- - - - - - - - - - - -
structMatrixEvent
structMatrixEventClass
-
-
-

Object Hierarchy

-
-
-
-
-

Description

-
-
-

Functions

-
-

MATRIX_TYPE_EVENT

-
#define MATRIX_TYPE_EVENT (matrix_event_get_type ())
-
-

The type for MatrixEvent.

-
-
-
-

matrix_event_from_json ()

-
void
-matrix_event_from_json (MatrixEvent *self,
-                        JsonNode *json_data,
-                        GError **error);
-

Subclasses should implement this function to initialize themselves from JSON data.

-
-

Parameters

-
----- - - - - - - - - - - - - - - - - - -

self

the MatrixEvent instance

 

json_data

 

 

error

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

[error-domains MatrixError]
-
-
-
-
-

matrix_event_to_json ()

-
void
-matrix_event_to_json (MatrixEvent *self,
-                      JsonNode *json_data,
-                      GError **error);
-

Subclasses should implement this to export their data to JSON.

-
-

Parameters

-
----- - - - - - - - - - - - - - - - - - -

self

the MatrixEvent instance

 

json_data

 

 

error

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

[error-domains MatrixError]
-
-
-
-
-

matrix_event_set_custom_field ()

-
void
-matrix_event_set_custom_field (MatrixEvent *self,
-                               const gchar *field_name,
-                               JsonNode *value);
-

Set a value for a custom field.

-
-

Parameters

-
----- - - - - - - - - - - - - - - - - - -

self

the MatrixEvent instance

 

field_name

 

 

value

 

 
-
-
-
-
-

matrix_event_get_custom_field ()

-
JsonNode *
-matrix_event_get_custom_field (MatrixEvent *self,
-                               const gchar *field_name);
-

Get the value of a custom field.

-
-

Parameters

-
----- - - - - - - - - - - - - -

self

the MatrixEvent instance

 

field_name

 

 
-
-
-
-
-

matrix_event_delete_custom_field ()

-
void
-matrix_event_delete_custom_field (MatrixEvent *self,
-                                  const gchar *field_name);
-

Delete a custom field.

-
-

Parameters

-
----- - - - - - - - - - - - - -

self

the MatrixEvent instance

 

field_name

 

 
-
-
-
-
-

matrix_event_new ()

-
MatrixEvent *
-matrix_event_new (void);
-
-
-
-

matrix_event_get_sender ()

-
const gchar *
-matrix_event_get_sender (MatrixEvent *self);
-

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

-

The Matrix ID of the events sender.

-
-

Parameters

-
----- - - - - - -

self

the MatrixEvent instance to query

 
-
-
-

Returns

-

the value of the "sender" property

-

-
-
-
-
-

matrix_event_set_sender ()

-
void
-matrix_event_set_sender (MatrixEvent *self,
-                         const gchar *value);
-

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

-

The Matrix ID of the events sender.

-
-

Parameters

-
----- - - - - - - - - - - - - -

self

the MatrixEvent instance to modify

 

value

the new value of the "sender" property

 
-
-
-
-
-

matrix_event_get_room_id ()

-
const gchar *
-matrix_event_get_room_id (MatrixEvent *self);
-

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

-

The ID of the room this event is associated with.

-
-

Parameters

-
----- - - - - - -

self

the MatrixEvent instance to query

 
-
-
-

Returns

-

the value of the "room-id" property

-

-
-
-
-
-

matrix_event_set_room_id ()

-
void
-matrix_event_set_room_id (MatrixEvent *self,
-                          const gchar *value);
-

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

-

The ID of the room this event is associated with.

-
-

Parameters

-
----- - - - - - - - - - - - - -

self

the MatrixEvent instance to modify

 

value

the new value of the "room-id" property

 
-
-
-
-
-

matrix_event_get_event_type ()

-
const gchar *
-matrix_event_get_event_type (MatrixEvent *self);
-

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

-

The type of the event.

-
-

Parameters

-
----- - - - - - -

self

the MatrixEvent instance to query

 
-
-
-

Returns

-

the value of the "event-type" property

-

-
-
-
-
-

matrix_event_get_origin_server_ts ()

-
gulong *
-matrix_event_get_origin_server_ts (MatrixEvent *self);
-

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

-

The timestamp of the event on the originating server.

-
-

Parameters

-
----- - - - - - -

self

the MatrixEvent instance to query

 
-
-
-

Returns

-

the value of the "origin-server-ts" property

-

-
-
-
-
-

matrix_event_set_origin_server_ts ()

-
void
-matrix_event_set_origin_server_ts (MatrixEvent *self,
-                                   gulong *value);
-

Set the value of the "origin-server-ts" property to value -.

-

The timestamp of the event on the originating server.

-
-

Parameters

-
----- - - - - - - - - - - - - -

self

the MatrixEvent instance to modify

 

value

the new value of the "origin-server-ts" property

 
-
-
-
-
-

matrix_event_get_unsigned_data ()

-
MatrixUnsignedEventData *
-matrix_event_get_unsigned_data (MatrixEvent *self);
-

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

-

The unsigned part of the event.

-
-

Parameters

-
----- - - - - - -

self

the MatrixEvent instance to query

 
-
-
-

Returns

-

the value of the "unsigned-data" property

-

-
-
-
-
-

matrix_event_set_unsigned_data ()

-
void
-matrix_event_set_unsigned_data (MatrixEvent *self,
-                                MatrixUnsignedEventData *value);
-

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

-

The unsigned part of the event.

-
-

Parameters

-
----- - - - - - - - - - - - - -

self

the MatrixEvent instance to modify

 

value

the new value of the "unsigned-data" property

 
-
-
-
-
-

matrix_event_get_json ()

-
JsonNode *
-matrix_event_get_json (MatrixEvent *self);
-

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

-

The event as a JSON node.

-
-

Parameters

-
----- - - - - - -

self

the MatrixEvent instance to query

 
-
-
-

Returns

-

the value of the "json" property

-

-
-
-
-
-

matrix_event_new_from_json ()

-
MatrixEvent *
-matrix_event_new_from_json (gchar *event_type,
-                            const gchar *room_id,
-                            JsonNode *json_data,
-                            GError **error);
-
-

Parameters

-
----- - - - - - - - - - - - - - - - - - - - - - - -

event_type

 

 

room_id

 

 

json_data

 

 

error

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

[error-domains MatrixError]
-
-
-
-
-

matrix_event_get_handler ()

-
GType
-matrix_event_get_handler (const gchar *event_type);
-

Get the GType of the class that is registered to handle events with type param - event_type.

-
-

Parameters

-
----- - - - - - -

event_type

 -

 .

-

the event type to look up

-

.

-		[in]
-
-
-

Returns

-

a GType or MatrixEvent if no handler is registered

-

-
-
-
-
-

matrix_event_register_type ()

-
void
-matrix_event_register_type (const gchar *event_type,
-                            GType event_gtype,
-                            GError **error);
-

Registers param - event_type to be handled by the type param - event_gtype.

-
-

Parameters

-
----- - - - - - - - - - - - - - - - - - -

event_type

 -

 .

-

the type of the event

-

.

-		[in]

event_gtype

 -

 .

-

the GType of the event’s handler

-

.

-		[in]

error

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

[error-domains MatrixError]
-
-
-
-
-

matrix_event_unregister_type ()

-
void
-matrix_event_unregister_type (const gchar *event_type);
-

Unregister param - event_type.

-
-

Parameters

-
----- - - - - - -

event_type

 -

 .

-

the event type to remove

-

.

-		[in]
-
-
-
-
-

Types and Values

-
-

struct MatrixEvent

-
struct MatrixEvent {
-	GObject parent_instance;
-	MatrixEventPrivate * priv;
-	gchar* _sender;
-	gchar* _room_id;
-};
-
-

Base class for Matrix events.

-
-
-
-

struct MatrixEventClass

-
struct MatrixEventClass {
-	GObjectClass parent_class;
-	void (*from_json) (MatrixEvent* self, JsonNode* json_data, GError** error);
-	void (*to_json) (MatrixEvent* self, JsonNode* json_data, GError** error);
-};
-
-

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

-
-

Members

-
----- - - - - - - - - - - - - - - - - - -

GObjectClass parent_class;

the parent class structure

 

from_json ()

virtual method called by matrix_event_from_json()

 

to_json ()

virtual method called by matrix_event_to_json()

 
-
-
-
-
-
-
- Generated by GTK-Doc V1.20
- - \ No newline at end of file diff --git a/Matrix-0.0-MatrixEventBase.html b/Matrix-0.0-MatrixEventBase.html new file mode 100644 index 0000000..49a5f1e --- /dev/null +++ b/Matrix-0.0-MatrixEventBase.html @@ -0,0 +1,482 @@ + + + + +MatrixEventBase: Matrix-0.0 Reference Manual + + + + + + + + + + + + + + + + +
+
+
+ + +
+

MatrixEventBase

+

MatrixEventBase — Base class for Matrix events.

+
+
+

Functions

+
++++ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+GType * + +matrix_event_get_handler () +
+void + +matrix_event_register_type () +
+void + +matrix_event_unregister_type () +
#defineMATRIX_EVENT_TYPE_BASE
+void + +matrix_event_base_from_json () +
+void + +matrix_event_base_to_json () +
const gchar * + +matrix_event_base_get_event_type () +
+JsonNode * + +matrix_event_base_get_json () +
+MatrixEventBase * + +matrix_event_base_new_from_json () +
+
+
+

Types and Values

+
++++ + + + + + + + + + + +
structMatrixEventBase
structMatrixEventBaseClass
+
+
+

Description

+
+
+

Functions

+
+

matrix_event_get_handler ()

+
GType *
+matrix_event_get_handler (const gchar *event_type);
+

Get the GType of the class that is registered to handle events with type param + event_type.

+
+

Parameters

+
+++++ + + + + + + + + + + + + +

self

the (null) instance

 

event_type

 +

 .

+

the event type to look up

+

.

+		[in]
+
+
+

Returns

+

a GType or Matrix.Event if no handler is registered

+
+
+
+
+

matrix_event_register_type ()

+
void
+matrix_event_register_type (const gchar *event_type,
+                            GType event_gtype,
+                            GError **error);
+

Registers param + event_type to be handled by the type param + event_gtype.

+
+

Parameters

+
+++++ + + + + + + + + + + + + + + + + + + + + + + +

self

the (null) instance

 

event_type

 +

 .

+

the type of the event

+

.

+		[in]

event_gtype

 +

 .

+

the GType of the event’s handler

+

.

+		[in]

error

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

[error-domains MatrixError]
+
+
+
+
+

matrix_event_unregister_type ()

+
void
+matrix_event_unregister_type (const gchar *event_type);
+

Unregister param + event_type.

+
+

Parameters

+
+++++ + + + + + + + + + + + + +

self

the (null) instance

 

event_type

 +

 .

+

the event type to remove

+

.

+		[in]
+
+
+
+
+

MATRIX_EVENT_TYPE_BASE

+
#define MATRIX_EVENT_TYPE_BASE (matrix_event_base_get_type ())
+
+

The type for MatrixEventBase.

+
+
+
+

matrix_event_base_from_json ()

+
void
+matrix_event_base_from_json (MatrixEventBase *self,
+                             JsonNode *json_data,
+                             GError **error);
+

Subclasses should implement this function to initialize themselves from JSON data.

+
+

Parameters

+
+++++ + + + + + + + + + + + + + + + + + +

self

the MatrixEventBase instance

 

json_data

 

 

error

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

[error-domains MatrixError]
+
+
+
+
+

matrix_event_base_to_json ()

+
void
+matrix_event_base_to_json (MatrixEventBase *self,
+                           JsonNode *json_data,
+                           GError **error);
+

Subclasses should implement this to export their data to JSON.

+
+

Parameters

+
+++++ + + + + + + + + + + + + + + + + + +

self

the MatrixEventBase instance

 

json_data

 

 

error

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

[error-domains MatrixError]
+
+
+
+
+

matrix_event_base_get_event_type ()

+
const gchar *
+matrix_event_base_get_event_type (MatrixEventBase *self);
+

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

+

The type of the event. It should be namespaced similar to the Java package naming conventions, e.g. com.example.subdomain.event.type. It cannot be changed after object initialization.

+
+

Parameters

+
+++++ + + + + + +

self

the MatrixEventBase instance to query

 
+
+
+

Returns

+

the value of the "event-type" property

+
+
+
+
+

matrix_event_base_get_json ()

+
JsonNode *
+matrix_event_base_get_json (MatrixEventBase *self);
+

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

+

The event as a JSON node.

+
+

Parameters

+
+++++ + + + + + +

self

the MatrixEventBase instance to query

 
+
+
+

Returns

+

the value of the "json" property

+
+
+
+
+

matrix_event_base_new_from_json ()

+
MatrixEventBase *
+matrix_event_base_new_from_json (gchar *event_type,
+                                 JsonNode *json_data,
+                                 GError **error);
+
+

Parameters

+
+++++ + + + + + + + + + + + + + + + + + +

event_type

 

 

json_data

 

 

error

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

[error-domains MatrixError]
+
+
+
+
+

Types and Values

+
+

struct MatrixEventBase

+
struct MatrixEventBase {
+	GObject parent_instance;
+	MatrixEventBasePrivate * priv;
+	gchar* _event_type;
+};
+
+

Base class for Matrix events.

+
+
+
+

struct MatrixEventBaseClass

+
struct MatrixEventBaseClass {
+	GObjectClass parent_class;
+	void (*from_json) (MatrixEventBase* self, JsonNode* json_data, GError** error);
+	void (*to_json) (MatrixEventBase* self, JsonNode* json_data, GError** error);
+};
+
+

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

+
+

Members

+
+++++ + + + + + + + + + + + + + + + + + +

GObjectClass parent_class;

the parent class structure

 

from_json ()

virtual method called by matrix_event_base_from_json()

 

to_json ()

virtual method called by matrix_event_base_to_json()

 
+
+
+
+
+
+
Generated by GTK-Doc V1.24
+ + \ No newline at end of file diff --git a/Matrix-0.0-MatrixEventCall.html b/Matrix-0.0-MatrixEventCall.html new file mode 100644 index 0000000..f3f99d7 --- /dev/null +++ b/Matrix-0.0-MatrixEventCall.html @@ -0,0 +1,269 @@ + + + + +MatrixEventCall: Matrix-0.0 Reference Manual + + + + + + + + + + + + + + + + +
+
+
+ + +
+

MatrixEventCall

+

MatrixEventCall — Base class for m.call.* events.

+
+
+

Functions

+
++++ + + + + + + + + + + + + + + + + + + + + + + +
#defineMATRIX_EVENT_TYPE_CALL
const gchar * + +matrix_event_call_get_call_id () +
+void + +matrix_event_call_set_call_id () +
+gint + +matrix_event_call_get_version () +
+void + +matrix_event_call_set_version () +
+
+
+

Types and Values

+
++++ + + + + + + + + + + +
structMatrixEventCall
structMatrixEventCallClass
+
+
+

Description

+
+
+

Functions

+
+

MATRIX_EVENT_TYPE_CALL

+
#define MATRIX_EVENT_TYPE_CALL (matrix_event_call_get_type ())
+
+

The type for MatrixEventCall.

+
+
+
+

matrix_event_call_get_call_id ()

+
const gchar *
+matrix_event_call_get_call_id (MatrixEventCall *self);
+

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

+

The ID of the call this event relates to.

+
+

Parameters

+
+++++ + + + + + +

self

the MatrixEventCall instance to query

 
+
+
+

Returns

+

the value of the "call-id" property

+
+
+
+
+

matrix_event_call_set_call_id ()

+
void
+matrix_event_call_set_call_id (MatrixEventCall *self,
+                               const gchar *value);
+

Set the value of the "call-id" property to value +.

+

The ID of the call this event relates to.

+
+

Parameters

+
+++++ + + + + + + + + + + + + +

self

the MatrixEventCall instance to modify

 

value

the new value of the "call-id" property

 
+
+
+
+
+

matrix_event_call_get_version ()

+
gint
+matrix_event_call_get_version (MatrixEventCall *self);
+

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

+

The version of the VoIP specification this message adheres to.

+
+

Parameters

+
+++++ + + + + + +

self

the MatrixEventCall instance to query

 
+
+
+

Returns

+

the value of the "version" property

+
+
+
+
+

matrix_event_call_set_version ()

+
void
+matrix_event_call_set_version (MatrixEventCall *self,
+                               gint value);
+

Set the value of the "version" property to value +.

+

The version of the VoIP specification this message adheres to.

+
+

Parameters

+
+++++ + + + + + + + + + + + + +

self

the MatrixEventCall instance to modify

 

value

the new value of the "version" property

 
+
+
+
+
+

Types and Values

+
+

struct MatrixEventCall

+
struct MatrixEventCall {
+	MatrixEventRoom parent_instance;
+	MatrixEventCallPrivate * priv;
+};
+
+

Base class for m.call.* events.

+
+
+
+

struct MatrixEventCallClass

+
struct MatrixEventCallClass {
+	MatrixEventRoomClass parent_class;
+};
+
+

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

+
+

Members

+
+++++ + + + + + +

MatrixEventRoomClass parent_class;

the parent class structure

 
+
+
+
+
+
+
Generated by GTK-Doc V1.24
+ + \ No newline at end of file diff --git a/Matrix-0.0-MatrixEventCallAnswer.html b/Matrix-0.0-MatrixEventCallAnswer.html new file mode 100644 index 0000000..50f5487 --- /dev/null +++ b/Matrix-0.0-MatrixEventCallAnswer.html @@ -0,0 +1,287 @@ + + + + +MatrixEventCallAnswer: Matrix-0.0 Reference Manual + + + + + + + + + + + + + + + + +
+
+
+ + +
+

MatrixEventCallAnswer

+

MatrixEventCallAnswer — This event is sent by the callee when they wish to answer the call.

+
+
+

Functions

+
++++ + + + + + + + + + + + + + + + + + + + + + + + + + + +
#defineMATRIX_EVENT_TYPE_CALL_ANSWER
+MatrixEventCallAnswer * + +matrix_event_call_answer_new () +
+MatrixCallAnswerType + +matrix_event_call_answer_get_answer_type () +
+void + +matrix_event_call_answer_set_answer_type () +
const gchar * + +matrix_event_call_answer_get_answer_sdp () +
+void + +matrix_event_call_answer_set_answer_sdp () +
+
+
+

Types and Values

+
++++ + + + + + + + + + + +
structMatrixEventCallAnswer
structMatrixEventCallAnswerClass
+
+
+

Description

+
+
+

Functions

+
+

MATRIX_EVENT_TYPE_CALL_ANSWER

+
#define MATRIX_EVENT_TYPE_CALL_ANSWER (matrix_event_call_answer_get_type ())
+
+

The type for MatrixEventCallAnswer.

+
+
+
+

matrix_event_call_answer_new ()

+
MatrixEventCallAnswer *
+matrix_event_call_answer_new (void);
+
+
+
+

matrix_event_call_answer_get_answer_type ()

+
MatrixCallAnswerType
+matrix_event_call_answer_get_answer_type
+                               (MatrixEventCallAnswer *self);
+

Get and return the current value of the "answer-type" property.

+

The type of session description.

+
+

Parameters

+
+++++ + + + + + +

self

the MatrixEventCallAnswer instance to query

 
+
+
+

Returns

+

the value of the "answer-type" property

+
+
+
+
+

matrix_event_call_answer_set_answer_type ()

+
void
+matrix_event_call_answer_set_answer_type
+                               (MatrixEventCallAnswer *self,
+                                MatrixCallAnswerType value);
+

Set the value of the "answer-type" property to value +.

+

The type of session description.

+
+

Parameters

+
+++++ + + + + + + + + + + + + +

self

the MatrixEventCallAnswer instance to modify

 

value

the new value of the "answer-type" property

 
+
+
+
+
+

matrix_event_call_answer_get_answer_sdp ()

+
const gchar *
+matrix_event_call_answer_get_answer_sdp
+                               (MatrixEventCallAnswer *self);
+

Get and return the current value of the "answer-sdp" property.

+

The SDP text of the session description.

+
+

Parameters

+
+++++ + + + + + +

self

the MatrixEventCallAnswer instance to query

 
+
+
+

Returns

+

the value of the "answer-sdp" property

+
+
+
+
+

matrix_event_call_answer_set_answer_sdp ()

+
void
+matrix_event_call_answer_set_answer_sdp
+                               (MatrixEventCallAnswer *self,
+                                const gchar *value);
+

Set the value of the "answer-sdp" property to value +.

+

The SDP text of the session description.

+
+

Parameters

+
+++++ + + + + + + + + + + + + +

self

the MatrixEventCallAnswer instance to modify

 

value

the new value of the "answer-sdp" property

 
+
+
+
+
+

Types and Values

+
+

struct MatrixEventCallAnswer

+
struct MatrixEventCallAnswer {
+	MatrixEventCall parent_instance;
+	MatrixEventCallAnswerPrivate * priv;
+};
+
+

This event is sent by the callee when they wish to answer the call.

+
+
+
+

struct MatrixEventCallAnswerClass

+
struct MatrixEventCallAnswerClass {
+	MatrixEventCallClass parent_class;
+};
+
+

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

+
+

Members

+
+++++ + + + + + +

MatrixEventCallClass parent_class;

the parent class structure

 
+
+
+
+
+
+
Generated by GTK-Doc V1.24
+ + \ No newline at end of file diff --git a/Matrix-0.0-MatrixEventCallCandidates.html b/Matrix-0.0-MatrixEventCallCandidates.html new file mode 100644 index 0000000..5c10e03 --- /dev/null +++ b/Matrix-0.0-MatrixEventCallCandidates.html @@ -0,0 +1,369 @@ + + + + +MatrixEventCallCandidates: Matrix-0.0 Reference Manual + + + + + + + + + + + + + + + + +
+
+
+ + +
+

MatrixEventCallCandidates

+

MatrixEventCallCandidates — This event is sent by callers after sending an invite and by the callee after answering. Its purpose is to give the other party additional ICE candidates to try using to communicate.

+
+
+

Functions

+
++++ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
#defineMATRIX_EVENT_TYPE_CALL_CANDIDATES
+MatrixEventCallCandidates * + +matrix_event_call_candidates_new () +
+MatrixEventCallCandidatesCandidate * + +matrix_event_call_candidates_get_candidates () +
+void + +matrix_event_call_candidates_set_candidates () +
+MatrixEventCallCandidatesCandidate * + +matrix_event_call_candidates_candidate_dup () +
+void + +matrix_event_call_candidates_candidate_free () +
+void + +matrix_event_call_candidates_candidate_copy () +
+void + +matrix_event_call_candidates_candidate_destroy () +
+
+
+

Types and Values

+
++++ + + + + + + + + + + + + + + +
structMatrixEventCallCandidatesCandidate
structMatrixEventCallCandidates
structMatrixEventCallCandidatesClass
+
+
+

Description

+
+
+

Functions

+
+

MATRIX_EVENT_TYPE_CALL_CANDIDATES

+
#define MATRIX_EVENT_TYPE_CALL_CANDIDATES (matrix_event_call_candidates_get_type ())
+
+

The type for MatrixEventCallCandidates.

+
+
+
+

matrix_event_call_candidates_new ()

+
MatrixEventCallCandidates *
+matrix_event_call_candidates_new (void);
+
+
+
+

matrix_event_call_candidates_get_candidates ()

+
MatrixEventCallCandidatesCandidate *
+matrix_event_call_candidates_get_candidates
+                               (MatrixEventCallCandidates *self,
+                                int *result_length1);
+

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

+

The list of candidates.

+
+

Parameters

+
+++++ + + + + + +

self

the MatrixEventCallCandidates instance to query

 
+
+
+

Returns

+

the value of the "candidates" property

+
+
+
+
+

matrix_event_call_candidates_set_candidates ()

+
void
+matrix_event_call_candidates_set_candidates
+                               (MatrixEventCallCandidates *self,
+                                MatrixEventCallCandidatesCandidate *value,
+                                int value_length1);
+

Set the value of the "candidates" property to value +.

+

The list of candidates.

+
+

Parameters

+
+++++ + + + + + + + + + + + + +

self

the MatrixEventCallCandidates instance to modify

 

value

the new value of the "candidates" property

 
+
+
+
+
+

matrix_event_call_candidates_candidate_dup ()

+
MatrixEventCallCandidatesCandidate *
+matrix_event_call_candidates_candidate_dup
+                               (const MatrixEventCallCandidatesCandidate *self);
+

Creates a copy of self.

+

See also: matrix_event_call_candidates_candidate_copy(), matrix_event_call_candidates_candidate_destroy(), matrix_event_call_candidates_candidate_free()

+
+

Parameters

+
+++++ + + + + + +

self

the instance to duplicate

 
+
+
+

Returns

+

a copy of self +, free with matrix_event_call_candidates_candidate_free()

+
+
+
+
+

matrix_event_call_candidates_candidate_free ()

+
void
+matrix_event_call_candidates_candidate_free
+                               (MatrixEventCallCandidatesCandidate *self);
+

Frees the heap-allocated struct.

+

See also: matrix_event_call_candidates_candidate_dup(), matrix_event_call_candidates_candidate_copy(), matrix_event_call_candidates_candidate_destroy()

+
+

Parameters

+
+++++ + + + + + +

self

the struct to free

 
+
+
+
+
+

matrix_event_call_candidates_candidate_copy ()

+
void
+matrix_event_call_candidates_candidate_copy
+                               (const MatrixEventCallCandidatesCandidate *self,
+                                MatrixEventCallCandidatesCandidate *dest);
+

Creates a copy of self.

+

See also: matrix_event_call_candidates_candidate_dup(), matrix_event_call_candidates_candidate_destroy(), matrix_event_call_candidates_candidate_free()

+
+

Parameters

+
+++++ + + + + + + + + + + + + +

self

the struct to copy

 

dest

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

 
+
+
+
+
+

matrix_event_call_candidates_candidate_destroy ()

+
void
+matrix_event_call_candidates_candidate_destroy
+                               (MatrixEventCallCandidatesCandidate *self);
+

Frees the content of the struct pointed by self +.

+

See also: matrix_event_call_candidates_candidate_dup(), matrix_event_call_candidates_candidate_copy(), matrix_event_call_candidates_candidate_free()

+
+

Parameters

+
+++++ + + + + + +

self

the struct to destroy

 
+
+
+
+
+

Types and Values

+
+

struct MatrixEventCallCandidatesCandidate

+
struct MatrixEventCallCandidatesCandidate {
+	gchar* sdp_mid;
+	gint* sdp_line_index;
+	gchar* candidate;
+};
+
+
+
+
+

struct MatrixEventCallCandidates

+
struct MatrixEventCallCandidates {
+	MatrixEventCall parent_instance;
+	MatrixEventCallCandidatesPrivate * priv;
+};
+
+

This event is sent by callers after sending an invite and by the callee after answering. Its purpose is to give the other party additional ICE candidates to try using to communicate.

+
+
+
+

struct MatrixEventCallCandidatesClass

+
struct MatrixEventCallCandidatesClass {
+	MatrixEventCallClass parent_class;
+};
+
+

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

+
+

Members

+
+++++ + + + + + +

MatrixEventCallClass parent_class;

the parent class structure

 
+
+
+
+
+
+
Generated by GTK-Doc V1.24
+ + \ No newline at end of file diff --git a/Matrix-0.0-MatrixEventCallHangup.html b/Matrix-0.0-MatrixEventCallHangup.html new file mode 100644 index 0000000..fb2ea95 --- /dev/null +++ b/Matrix-0.0-MatrixEventCallHangup.html @@ -0,0 +1,134 @@ + + + + +MatrixEventCallHangup: Matrix-0.0 Reference Manual + + + + + + + + + + + + + + + + +
+
+
+ + +
+

MatrixEventCallHangup

+

MatrixEventCallHangup — Sent by either party to signal their termination of the call. This can be sent either once the call has has been established or before to abort the call.

+
+
+

Functions

+
++++ + + + + + + + + + + +
#defineMATRIX_EVENT_TYPE_CALL_HANGUP
+MatrixEventCallHangup * + +matrix_event_call_hangup_new () +
+
+
+

Types and Values

+
++++ + + + + + + + + + + +
structMatrixEventCallHangup
structMatrixEventCallHangupClass
+
+
+

Description

+
+
+

Functions

+
+

MATRIX_EVENT_TYPE_CALL_HANGUP

+
#define MATRIX_EVENT_TYPE_CALL_HANGUP (matrix_event_call_hangup_get_type ())
+
+

The type for MatrixEventCallHangup.

+
+
+
+

matrix_event_call_hangup_new ()

+
MatrixEventCallHangup *
+matrix_event_call_hangup_new (void);
+
+
+
+

Types and Values

+
+

struct MatrixEventCallHangup

+
struct MatrixEventCallHangup {
+	MatrixEventCall parent_instance;
+	MatrixEventCallHangupPrivate * priv;
+};
+
+

Sent by either party to signal their termination of the call. This can be sent either once the call has has been established or before to abort the call.

+
+
+
+

struct MatrixEventCallHangupClass

+
struct MatrixEventCallHangupClass {
+	MatrixEventCallClass parent_class;
+};
+
+

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

+
+

Members

+
+++++ + + + + + +

MatrixEventCallClass parent_class;

the parent class structure

 
+
+
+
+
+
+
Generated by GTK-Doc V1.24
+ + \ No newline at end of file diff --git a/Matrix-0.0-MatrixEventCallInvite.html b/Matrix-0.0-MatrixEventCallInvite.html new file mode 100644 index 0000000..0b52f40 --- /dev/null +++ b/Matrix-0.0-MatrixEventCallInvite.html @@ -0,0 +1,360 @@ + + + + +MatrixEventCallInvite: Matrix-0.0 Reference Manual + + + + + + + + + + + + + + + + +
+
+
+ + +
+

MatrixEventCallInvite

+

MatrixEventCallInvite — This event is sent by the caller when they wish to establish a call.

+
+
+

Functions

+
++++ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
#defineMATRIX_EVENT_TYPE_CALL_INVITE
+MatrixEventCallInvite * + +matrix_event_call_invite_new () +
+MatrixCallOfferType + +matrix_event_call_invite_get_offer_type () +
+void + +matrix_event_call_invite_set_offer_type () +
const gchar * + +matrix_event_call_invite_get_sdp () +
+void + +matrix_event_call_invite_set_sdp () +
+gint + +matrix_event_call_invite_get_lifetime () +
+void + +matrix_event_call_invite_set_lifetime () +
+
+
+

Types and Values

+
++++ + + + + + + + + + + +
structMatrixEventCallInvite
structMatrixEventCallInviteClass
+
+
+

Description

+
+
+

Functions

+
+

MATRIX_EVENT_TYPE_CALL_INVITE

+
#define MATRIX_EVENT_TYPE_CALL_INVITE (matrix_event_call_invite_get_type ())
+
+

The type for MatrixEventCallInvite.

+
+
+
+

matrix_event_call_invite_new ()

+
MatrixEventCallInvite *
+matrix_event_call_invite_new (void);
+
+
+
+

matrix_event_call_invite_get_offer_type ()

+
MatrixCallOfferType
+matrix_event_call_invite_get_offer_type
+                               (MatrixEventCallInvite *self);
+

Get and return the current value of the "offer-type" property.

+

The type of session description.

+
+

Parameters

+
+++++ + + + + + +

self

the MatrixEventCallInvite instance to query

 
+
+
+

Returns

+

the value of the "offer-type" property

+
+
+
+
+

matrix_event_call_invite_set_offer_type ()

+
void
+matrix_event_call_invite_set_offer_type
+                               (MatrixEventCallInvite *self,
+                                MatrixCallOfferType value);
+

Set the value of the "offer-type" property to value +.

+

The type of session description.

+
+

Parameters

+
+++++ + + + + + + + + + + + + +

self

the MatrixEventCallInvite instance to modify

 

value

the new value of the "offer-type" property

 
+
+
+
+
+

matrix_event_call_invite_get_sdp ()

+
const gchar *
+matrix_event_call_invite_get_sdp (MatrixEventCallInvite *self);
+

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

+

The SDP text of the session description.

+
+

Parameters

+
+++++ + + + + + +

self

the MatrixEventCallInvite instance to query

 
+
+
+

Returns

+

the value of the "sdp" property

+
+
+
+
+

matrix_event_call_invite_set_sdp ()

+
void
+matrix_event_call_invite_set_sdp (MatrixEventCallInvite *self,
+                                  const gchar *value);
+

Set the value of the "sdp" property to value +.

+

The SDP text of the session description.

+
+

Parameters

+
+++++ + + + + + + + + + + + + +

self

the MatrixEventCallInvite instance to modify

 

value

the new value of the "sdp" property

 
+
+
+
+
+

matrix_event_call_invite_get_lifetime ()

+
gint
+matrix_event_call_invite_get_lifetime (MatrixEventCallInvite *self);
+

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

+

The time in milliseconds that the invite is valid for. Once the invite age exceeds this value, clients should discard it. They should also no longer show the call as awaiting an answer in the UI.

+
+

Parameters

+
+++++ + + + + + +

self

the MatrixEventCallInvite instance to query

 
+
+
+

Returns

+

the value of the "lifetime" property

+
+
+
+
+

matrix_event_call_invite_set_lifetime ()

+
void
+matrix_event_call_invite_set_lifetime (MatrixEventCallInvite *self,
+                                       gint value);
+

Set the value of the "lifetime" property to value +.

+

The time in milliseconds that the invite is valid for. Once the invite age exceeds this value, clients should discard it. They should also no longer show the call as awaiting an answer in the UI.

+
+

Parameters

+
+++++ + + + + + + + + + + + + +

self

the MatrixEventCallInvite instance to modify

 

value

the new value of the "lifetime" property

 
+
+
+
+
+

Types and Values

+
+

struct MatrixEventCallInvite

+
struct MatrixEventCallInvite {
+	MatrixEventCall parent_instance;
+	MatrixEventCallInvitePrivate * priv;
+};
+
+

This event is sent by the caller when they wish to establish a call.

+
+
+
+

struct MatrixEventCallInviteClass

+
struct MatrixEventCallInviteClass {
+	MatrixEventCallClass parent_class;
+};
+
+

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

+
+

Members

+
+++++ + + + + + +

MatrixEventCallClass parent_class;

the parent class structure

 
+
+
+
+
+
+
Generated by GTK-Doc V1.24
+ + \ No newline at end of file diff --git a/Matrix-0.0-MatrixEventPresence.html b/Matrix-0.0-MatrixEventPresence.html new file mode 100644 index 0000000..f2eba59 --- /dev/null +++ b/Matrix-0.0-MatrixEventPresence.html @@ -0,0 +1,586 @@ + + + + +MatrixEventPresence: Matrix-0.0 Reference Manual + + + + + + + + + + + + + + + + +
+
+
+ + +
+

MatrixEventPresence

+

MatrixEventPresence — Class for representing presence events

+
+
+

Functions

+
++++ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
#defineMATRIX_EVENT_TYPE_PRESENCE
+MatrixEventPresence * + +matrix_event_presence_new () +
const gchar * + +matrix_event_presence_get_avatar_url () +
+void + +matrix_event_presence_set_avatar_url () +
const gchar * + +matrix_event_presence_get_display_name () +
+void + +matrix_event_presence_set_display_name () +
+glong + +matrix_event_presence_get_last_active_ago () +
+void + +matrix_event_presence_set_last_active_ago () +
const gchar * + +matrix_event_presence_get_user_id () +
+void + +matrix_event_presence_set_user_id () +
const gchar * + +matrix_event_presence_get_event_id () +
+void + +matrix_event_presence_set_event_id () +
+MatrixPresence + +matrix_event_presence_get_presence () +
+void + +matrix_event_presence_set_presence () +
+
+
+

Types and Values

+
++++ + + + + + + + + + + +
structMatrixEventPresence
structMatrixEventPresenceClass
+
+
+

Description

+

Informs the client of a user's presence state change.

+
+
+

Functions

+
+

MATRIX_EVENT_TYPE_PRESENCE

+
#define MATRIX_EVENT_TYPE_PRESENCE (matrix_event_presence_get_type ())
+
+

The type for MatrixEventPresence.

+
+
+
+

matrix_event_presence_new ()

+
MatrixEventPresence *
+matrix_event_presence_new (void);
+
+
+
+

matrix_event_presence_get_avatar_url ()

+
const gchar *
+matrix_event_presence_get_avatar_url (MatrixEventPresence *self);
+

Get and return the current value of the "avatar-url" property.

+

The current avatar URL for this user, if any.

+
+

Parameters

+
+++++ + + + + + +

self

the MatrixEventPresence instance to query

 
+
+
+

Returns

+

the value of the "avatar-url" property

+
+
+
+
+

matrix_event_presence_set_avatar_url ()

+
void
+matrix_event_presence_set_avatar_url (MatrixEventPresence *self,
+                                      const gchar *value);
+

Set the value of the "avatar-url" property to value +.

+

The current avatar URL for this user, if any.

+
+

Parameters

+
+++++ + + + + + + + + + + + + +

self

the MatrixEventPresence instance to modify

 

value

the new value of the "avatar-url" property

 
+
+
+
+
+

matrix_event_presence_get_display_name ()

+
const gchar *
+matrix_event_presence_get_display_name
+                               (MatrixEventPresence *self);
+

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

+

The current display name for this user, if any.

+
+

Parameters

+
+++++ + + + + + +

self

the MatrixEventPresence instance to query

 
+
+
+

Returns

+

the value of the "display-name" property

+
+
+
+
+

matrix_event_presence_set_display_name ()

+
void
+matrix_event_presence_set_display_name
+                               (MatrixEventPresence *self,
+                                const gchar *value);
+

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

+

The current display name for this user, if any.

+
+

Parameters

+
+++++ + + + + + + + + + + + + +

self

the MatrixEventPresence instance to modify

 

value

the new value of the "display-name" property

 
+
+
+
+
+

matrix_event_presence_get_last_active_ago ()

+
glong
+matrix_event_presence_get_last_active_ago
+                               (MatrixEventPresence *self);
+

Get and return the current value of the "last-active-ago" property.

+

The last time since this used performed some action, in milliseconds.

+

This won’t get into the generated event JSON if negative.

+
+

Parameters

+
+++++ + + + + + +

self

the MatrixEventPresence instance to query

 
+
+
+

Returns

+

the value of the "last-active-ago" property

+
+
+
+
+

matrix_event_presence_set_last_active_ago ()

+
void
+matrix_event_presence_set_last_active_ago
+                               (MatrixEventPresence *self,
+                                glong value);
+

Set the value of the "last-active-ago" property to value +.

+

The last time since this used performed some action, in milliseconds.

+

This won’t get into the generated event JSON if negative.

+
+

Parameters

+
+++++ + + + + + + + + + + + + +

self

the MatrixEventPresence instance to modify

 

value

the new value of the "last-active-ago" property

 
+
+
+
+
+

matrix_event_presence_get_user_id ()

+
const gchar *
+matrix_event_presence_get_user_id (MatrixEventPresence *self);
+

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

+

The user's ID.

+
+

Parameters

+
+++++ + + + + + +

self

the MatrixEventPresence instance to query

 
+
+
+

Returns

+

the value of the "user-id" property

+
+
+
+
+

matrix_event_presence_set_user_id ()

+
void
+matrix_event_presence_set_user_id (MatrixEventPresence *self,
+                                   const gchar *value);
+

Set the value of the "user-id" property to value +.

+

The user's ID.

+
+

Parameters

+
+++++ + + + + + + + + + + + + +

self

the MatrixEventPresence instance to modify

 

value

the new value of the "user-id" property

 
+
+
+
+
+

matrix_event_presence_get_event_id ()

+
const gchar *
+matrix_event_presence_get_event_id (MatrixEventPresence *self);
+

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

+
+

Parameters

+
+++++ + + + + + +

self

the MatrixEventPresence instance to query

 
+
+
+

Returns

+

the value of the "event-id" property

+
+
+
+
+

matrix_event_presence_set_event_id ()

+
void
+matrix_event_presence_set_event_id (MatrixEventPresence *self,
+                                    const gchar *value);
+

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

+
+

Parameters

+
+++++ + + + + + + + + + + + + +

self

the MatrixEventPresence instance to modify

 

value

the new value of the "event-id" property

 
+
+
+
+
+

matrix_event_presence_get_presence ()

+
MatrixPresence
+matrix_event_presence_get_presence (MatrixEventPresence *self);
+

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

+

The presence state for this user.

+
+

Parameters

+
+++++ + + + + + +

self

the MatrixEventPresence instance to query

 
+
+
+

Returns

+

the value of the "presence" property

+
+
+
+
+

matrix_event_presence_set_presence ()

+
void
+matrix_event_presence_set_presence (MatrixEventPresence *self,
+                                    MatrixPresence value);
+

Set the value of the "presence" property to value +.

+

The presence state for this user.

+
+

Parameters

+
+++++ + + + + + + + + + + + + +

self

the MatrixEventPresence instance to modify

 

value

the new value of the "presence" property

 
+
+
+
+
+

Types and Values

+
+

struct MatrixEventPresence

+
struct MatrixEventPresence {
+	MatrixEventBase parent_instance;
+	MatrixEventPresencePrivate * priv;
+};
+
+

Class for representing presence events

+

Informs the client of a user's presence state change.

+
+
+
+

struct MatrixEventPresenceClass

+
struct MatrixEventPresenceClass {
+	MatrixEventBaseClass parent_class;
+};
+
+

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

+
+

Members

+
+++++ + + + + + +

MatrixEventBaseClass parent_class;

the parent class structure

 
+
+
+
+
+
+
Generated by GTK-Doc V1.24
+ + \ No newline at end of file diff --git a/Matrix-0.0-MatrixEventReceipt.html b/Matrix-0.0-MatrixEventReceipt.html new file mode 100644 index 0000000..962b6ba --- /dev/null +++ b/Matrix-0.0-MatrixEventReceipt.html @@ -0,0 +1,208 @@ + + + + +MatrixEventReceipt: Matrix-0.0 Reference Manual + + + + + + + + + + + + + + + + +
+
+
+ + +
+

MatrixEventReceipt

+

MatrixEventReceipt — Class to hold m.receipt events.

+
+
+

Functions

+
++++ + + + + + + + + + + + + + + + + + + +
#defineMATRIX_EVENT_TYPE_RECEIPT
+MatrixEventReceipt * + +matrix_event_receipt_new () +
const gchar * + +matrix_event_receipt_get_room_id () +
+void + +matrix_event_receipt_set_room_id () +
+
+
+

Types and Values

+
++++ + + + + + + + + + + +
structMatrixEventReceipt
structMatrixEventReceiptClass
+
+
+

Description

+

Informs the client of new receipts.

+
+
+

Functions

+
+

MATRIX_EVENT_TYPE_RECEIPT

+
#define MATRIX_EVENT_TYPE_RECEIPT (matrix_event_receipt_get_type ())
+
+

The type for MatrixEventReceipt.

+
+
+
+

matrix_event_receipt_new ()

+
MatrixEventReceipt *
+matrix_event_receipt_new (void);
+
+
+
+

matrix_event_receipt_get_room_id ()

+
const gchar *
+matrix_event_receipt_get_room_id (MatrixEventReceipt *self);
+

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

+
+

Parameters

+
+++++ + + + + + +

self

the MatrixEventReceipt instance to query

 
+
+
+

Returns

+

the value of the "room-id" property

+
+
+
+
+

matrix_event_receipt_set_room_id ()

+
void
+matrix_event_receipt_set_room_id (MatrixEventReceipt *self,
+                                  const gchar *value);
+

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

+
+

Parameters

+
+++++ + + + + + + + + + + + + +

self

the MatrixEventReceipt instance to modify

 

value

the new value of the "room-id" property

 
+
+
+
+
+

Types and Values

+
+

struct MatrixEventReceipt

+
struct MatrixEventReceipt {
+	MatrixEventBase parent_instance;
+	MatrixEventReceiptPrivate * priv;
+};
+
+

Class to hold m.receipt events.

+

Informs the client of new receipts.

+
+
+
+

struct MatrixEventReceiptClass

+
struct MatrixEventReceiptClass {
+	MatrixEventBaseClass parent_class;
+};
+
+

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

+
+

Members

+
+++++ + + + + + +

MatrixEventBaseClass parent_class;

the parent class structure

 
+
+
+
+
+
+
Generated by GTK-Doc V1.24
+ + \ No newline at end of file diff --git a/Matrix-0.0-MatrixEventRoom.html b/Matrix-0.0-MatrixEventRoom.html new file mode 100644 index 0000000..5e12271 --- /dev/null +++ b/Matrix-0.0-MatrixEventRoom.html @@ -0,0 +1,569 @@ + + + + +MatrixEventRoom: Matrix-0.0 Reference Manual + + + + + + + + + + + + + + + + +
+
+
+ + +
+

MatrixEventRoom

+

MatrixEventRoom — Abstract base class for room events.

+
+
+

Functions

+
++++ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
#defineMATRIX_EVENT_TYPE_ROOM
const gchar * + +matrix_event_room_get_event_id () +
+void + +matrix_event_room_set_event_id () +
const gchar * + +matrix_event_room_get_room_id () +
+void + +matrix_event_room_set_room_id () +
const gchar * + +matrix_event_room_get_sender () +
+void + +matrix_event_room_set_sender () +
+glong + +matrix_event_room_get_age () +
+void + +matrix_event_room_set_age () +
const gchar * + +matrix_event_room_get_redacted_because () +
+void + +matrix_event_room_set_redacted_because () +
const gchar * + +matrix_event_room_get_transaction_id () +
+void + +matrix_event_room_set_transaction_id () +
+
+
+

Types and Values

+
++++ + + + + + + + + + + +
structMatrixEventRoom
structMatrixEventRoomClass
+
+
+

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

 
+
+
+
+
+
+
Generated by GTK-Doc V1.24
+ + \ No newline at end of file diff --git a/Matrix-0.0-MatrixEventRoomAliases.html b/Matrix-0.0-MatrixEventRoomAliases.html new file mode 100644 index 0000000..4d585b7 --- /dev/null +++ b/Matrix-0.0-MatrixEventRoomAliases.html @@ -0,0 +1,217 @@ + + + + +MatrixEventRoomAliases: Matrix-0.0 Reference Manual + + + + + + + + + + + + + + + + +
+
+
+ + +
+

MatrixEventRoomAliases

+

MatrixEventRoomAliases — Class to hold a m.room.aliases event.

+
+
+

Functions

+
++++ + + + + + + + + + + + + + + + + + + +
#defineMATRIX_EVENT_TYPE_ROOM_ALIASES
+MatrixEventRoomAliases * + +matrix_event_room_aliases_new () +
+gchar ** + +matrix_event_room_aliases_get_aliases () +
+void + +matrix_event_room_aliases_set_aliases () +
+
+
+

Types and Values

+
++++ + + + + + + + + + + +
structMatrixEventRoomAliases
structMatrixEventRoomAliasesClass
+
+
+

Description

+

This event is sent by a homeserver directly to inform of changes to the list of aliases it knows about for that room.

+

The state_key for this event is set to the homeserver which owns the room alias.

+

The entire set of known aliases for the room is the union of all the m.room.aliases events, one for each homeserver. Clients should check the validity of any room alias given in this list before presenting it to the user as trusted fact. The lists given by this event should be considered simply as advice on which aliases might exist, for which the client can perform the lookup to confirm whether it receives the correct room ID.

+
+
+

Functions

+
+

MATRIX_EVENT_TYPE_ROOM_ALIASES

+
#define MATRIX_EVENT_TYPE_ROOM_ALIASES (matrix_event_room_aliases_get_type ())
+
+

The type for MatrixEventRoomAliases.

+
+
+
+

matrix_event_room_aliases_new ()

+
MatrixEventRoomAliases *
+matrix_event_room_aliases_new (void);
+
+
+
+

matrix_event_room_aliases_get_aliases ()

+
gchar **
+matrix_event_room_aliases_get_aliases (MatrixEventRoomAliases *self,
+                                       int *result_length1);
+

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

+

A list of room aliases.

+
+

Parameters

+
+++++ + + + + + +

self

the MatrixEventRoomAliases instance to query

 
+
+
+

Returns

+

the value of the "aliases" property

+
+
+
+
+

matrix_event_room_aliases_set_aliases ()

+
void
+matrix_event_room_aliases_set_aliases (MatrixEventRoomAliases *self,
+                                       gchar **value,
+                                       int value_length1);
+

Set the value of the "aliases" property to value +.

+

A list of room aliases.

+
+

Parameters

+
+++++ + + + + + + + + + + + + +

self

the MatrixEventRoomAliases instance to modify

 

value

the new value of the "aliases" property

 
+
+
+
+
+

Types and Values

+
+

struct MatrixEventRoomAliases

+
struct MatrixEventRoomAliases {
+	MatrixEventState parent_instance;
+	MatrixEventRoomAliasesPrivate * priv;
+};
+
+

Class to hold a m.room.aliases event.

+

This event is sent by a homeserver directly to inform of changes to the list of aliases it knows about for that room.

+

The state_key for this event is set to the homeserver which owns the room alias.

+

The entire set of known aliases for the room is the union of all the m.room.aliases events, one for each homeserver. Clients should check the validity of any room alias given in this list before presenting it to the user as trusted fact. The lists given by this event should be considered simply as advice on which aliases might exist, for which the client can perform the lookup to confirm whether it receives the correct room ID.

+
+
+
+

struct MatrixEventRoomAliasesClass

+
struct MatrixEventRoomAliasesClass {
+	MatrixEventStateClass parent_class;
+};
+
+

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

+
+

Members

+
+++++ + + + + + +

MatrixEventStateClass parent_class;

the parent class structure

 
+
+
+
+
+
+
Generated by GTK-Doc V1.24
+ + \ No newline at end of file diff --git a/Matrix-0.0-MatrixEventRoomAvatar.html b/Matrix-0.0-MatrixEventRoomAvatar.html new file mode 100644 index 0000000..006a8e6 --- /dev/null +++ b/Matrix-0.0-MatrixEventRoomAvatar.html @@ -0,0 +1,438 @@ + + + + +MatrixEventRoomAvatar: Matrix-0.0 Reference Manual + + + + + + + + + + + + + + + + +
+
+
+ + +
+

MatrixEventRoomAvatar

+

MatrixEventRoomAvatar — Class to hold a m.room.avatar event

+
+
+

Functions

+
++++ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
#defineMATRIX_EVENT_TYPE_ROOM_AVATAR
+MatrixEventRoomAvatar * + +matrix_event_room_avatar_new () +
const gchar * + +matrix_event_room_avatar_get_url () +
+void + +matrix_event_room_avatar_set_url () +
const gchar * + +matrix_event_room_avatar_get_thumbnail_url () +
+void + +matrix_event_room_avatar_set_thumbnail_url () +
+MatrixImageInfo * + +matrix_event_room_avatar_get_info () +
+void + +matrix_event_room_avatar_set_info () +
+MatrixImageInfo * + +matrix_event_room_avatar_get_thumbnail_info () +
+void + +matrix_event_room_avatar_set_thumbnail_info () +
+
+
+

Types and Values

+
++++ + + + + + + + + + + +
structMatrixEventRoomAvatar
structMatrixEventRoomAvatarClass
+
+
+

Description

+

A picture that is associated with the room. This can be displayed alongside the room information.

+
+
+

Functions

+
+

MATRIX_EVENT_TYPE_ROOM_AVATAR

+
#define MATRIX_EVENT_TYPE_ROOM_AVATAR (matrix_event_room_avatar_get_type ())
+
+

The type for MatrixEventRoomAvatar.

+
+
+
+

matrix_event_room_avatar_new ()

+
MatrixEventRoomAvatar *
+matrix_event_room_avatar_new (void);
+
+
+
+

matrix_event_room_avatar_get_url ()

+
const gchar *
+matrix_event_room_avatar_get_url (MatrixEventRoomAvatar *self);
+

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

+

The URL to the image.

+
+

Parameters

+
+++++ + + + + + +

self

the MatrixEventRoomAvatar instance to query

 
+
+
+

Returns

+

the value of the "url" property

+
+
+
+
+

matrix_event_room_avatar_set_url ()

+
void
+matrix_event_room_avatar_set_url (MatrixEventRoomAvatar *self,
+                                  const gchar *value);
+

Set the value of the "url" property to value +.

+

The URL to the image.

+
+

Parameters

+
+++++ + + + + + + + + + + + + +

self

the MatrixEventRoomAvatar instance to modify

 

value

the new value of the "url" property

 
+
+
+
+
+

matrix_event_room_avatar_get_thumbnail_url ()

+
const gchar *
+matrix_event_room_avatar_get_thumbnail_url
+                               (MatrixEventRoomAvatar *self);
+

Get and return the current value of the "thumbnail-url" property.

+

The URL to the thumbnail of the image.

+
+

Parameters

+
+++++ + + + + + +

self

the MatrixEventRoomAvatar instance to query

 
+
+
+

Returns

+

the value of the "thumbnail-url" property

+
+
+
+
+

matrix_event_room_avatar_set_thumbnail_url ()

+
void
+matrix_event_room_avatar_set_thumbnail_url
+                               (MatrixEventRoomAvatar *self,
+                                const gchar *value);
+

Set the value of the "thumbnail-url" property to value +.

+

The URL to the thumbnail of the image.

+
+

Parameters

+
+++++ + + + + + + + + + + + + +

self

the MatrixEventRoomAvatar instance to modify

 

value

the new value of the "thumbnail-url" property

 
+
+
+
+
+

matrix_event_room_avatar_get_info ()

+
MatrixImageInfo *
+matrix_event_room_avatar_get_info (MatrixEventRoomAvatar *self);
+

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

+

Metadata about the image referred to in url.

+
+

Parameters

+
+++++ + + + + + +

self

the MatrixEventRoomAvatar instance to query

 
+
+
+

Returns

+

the value of the "info" property

+
+
+
+
+

matrix_event_room_avatar_set_info ()

+
void
+matrix_event_room_avatar_set_info (MatrixEventRoomAvatar *self,
+                                   MatrixImageInfo *value);
+

Set the value of the "info" property to value +.

+

Metadata about the image referred to in url.

+
+

Parameters

+
+++++ + + + + + + + + + + + + +

self

the MatrixEventRoomAvatar instance to modify

 

value

the new value of the "info" property

 
+
+
+
+
+

matrix_event_room_avatar_get_thumbnail_info ()

+
MatrixImageInfo *
+matrix_event_room_avatar_get_thumbnail_info
+                               (MatrixEventRoomAvatar *self);
+

Get and return the current value of the "thumbnail-info" property.

+

Metadata about the image referred to in thumbnail_url.

+
+

Parameters

+
+++++ + + + + + +

self

the MatrixEventRoomAvatar instance to query

 
+
+
+

Returns

+

the value of the "thumbnail-info" property

+
+
+
+
+

matrix_event_room_avatar_set_thumbnail_info ()

+
void
+matrix_event_room_avatar_set_thumbnail_info
+                               (MatrixEventRoomAvatar *self,
+                                MatrixImageInfo *value);
+

Set the value of the "thumbnail-info" property to value +.

+

Metadata about the image referred to in thumbnail_url.

+
+

Parameters

+
+++++ + + + + + + + + + + + + +

self

the MatrixEventRoomAvatar instance to modify

 

value

the new value of the "thumbnail-info" property

 
+
+
+
+
+

Types and Values

+
+

struct MatrixEventRoomAvatar

+
struct MatrixEventRoomAvatar {
+	MatrixEventState parent_instance;
+	MatrixEventRoomAvatarPrivate * priv;
+};
+
+

Class to hold a m.room.avatar event

+

A picture that is associated with the room. This can be displayed alongside the room information.

+
+
+
+

struct MatrixEventRoomAvatarClass

+
struct MatrixEventRoomAvatarClass {
+	MatrixEventStateClass parent_class;
+};
+
+

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

+
+

Members

+
+++++ + + + + + +

MatrixEventStateClass parent_class;

the parent class structure

 
+
+
+
+
+
+
Generated by GTK-Doc V1.24
+ + \ No newline at end of file diff --git a/Matrix-0.0-MatrixEventRoomCanonicalAlias.html b/Matrix-0.0-MatrixEventRoomCanonicalAlias.html new file mode 100644 index 0000000..b6a514b --- /dev/null +++ b/Matrix-0.0-MatrixEventRoomCanonicalAlias.html @@ -0,0 +1,212 @@ + + + + +MatrixEventRoomCanonicalAlias: Matrix-0.0 Reference Manual + + + + + + + + + + + + + + + + +
+
+
+ + +
+

MatrixEventRoomCanonicalAlias

+

MatrixEventRoomCanonicalAlias — Class to hold a m.room.canonical_alias event

+
+
+

Functions

+
++++ + + + + + + + + + + + + + + + + + + +
#defineMATRIX_EVENT_TYPE_ROOM_CANONICAL_ALIAS
+MatrixEventRoomCanonicalAlias * + +matrix_event_room_canonical_alias_new () +
const gchar * + +matrix_event_room_canonical_alias_get_canonical_alias () +
+void + +matrix_event_room_canonical_alias_set_canonical_alias () +
+
+
+

Types and Values

+
++++ + + + + + + + + + + +
structMatrixEventRoomCanonicalAlias
structMatrixEventRoomCanonicalAliasClass
+
+
+

Description

+

This event is used to inform the room about which alias should be considered the canonical one. This could be for display purposes or as suggestion to users which alias to use to advertise the room.

+
+
+

Functions

+
+

MATRIX_EVENT_TYPE_ROOM_CANONICAL_ALIAS

+
#define MATRIX_EVENT_TYPE_ROOM_CANONICAL_ALIAS (matrix_event_room_canonical_alias_get_type ())
+
+

The type for MatrixEventRoomCanonicalAlias.

+
+
+
+

matrix_event_room_canonical_alias_new ()

+
MatrixEventRoomCanonicalAlias *
+matrix_event_room_canonical_alias_new (void);
+
+
+
+

matrix_event_room_canonical_alias_get_canonical_alias ()

+
const gchar *
+matrix_event_room_canonical_alias_get_canonical_alias
+                               (MatrixEventRoomCanonicalAlias *self);
+

Get and return the current value of the "canonical-alias" property.

+

The canonical alias.

+
+

Parameters

+
+++++ + + + + + +

self

the MatrixEventRoomCanonicalAlias instance to query

 
+
+
+

Returns

+

the value of the "canonical-alias" property

+
+
+
+
+

matrix_event_room_canonical_alias_set_canonical_alias ()

+
void
+matrix_event_room_canonical_alias_set_canonical_alias
+                               (MatrixEventRoomCanonicalAlias *self,
+                                const gchar *value);
+

Set the value of the "canonical-alias" property to value +.

+

The canonical alias.

+
+

Parameters

+
+++++ + + + + + + + + + + + + +

self

the MatrixEventRoomCanonicalAlias instance to modify

 

value

the new value of the "canonical-alias" property

 
+
+
+
+
+

Types and Values

+
+

struct MatrixEventRoomCanonicalAlias

+
struct MatrixEventRoomCanonicalAlias {
+	MatrixEventState parent_instance;
+	MatrixEventRoomCanonicalAliasPrivate * priv;
+};
+
+

Class to hold a m.room.canonical_alias event

+

This event is used to inform the room about which alias should be considered the canonical one. This could be for display purposes or as suggestion to users which alias to use to advertise the room.

+
+
+
+

struct MatrixEventRoomCanonicalAliasClass

+
struct MatrixEventRoomCanonicalAliasClass {
+	MatrixEventStateClass parent_class;
+};
+
+

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

+
+

Members

+
+++++ + + + + + +

MatrixEventStateClass parent_class;

the parent class structure

 
+
+
+
+
+
+
Generated by GTK-Doc V1.24
+ + \ No newline at end of file diff --git a/Matrix-0.0-MatrixEventRoomCreate.html b/Matrix-0.0-MatrixEventRoomCreate.html new file mode 100644 index 0000000..d6a262e --- /dev/null +++ b/Matrix-0.0-MatrixEventRoomCreate.html @@ -0,0 +1,285 @@ + + + + +MatrixEventRoomCreate: Matrix-0.0 Reference Manual + + + + + + + + + + + + + + + + +
+
+
+ + +
+

MatrixEventRoomCreate

+

MatrixEventRoomCreate — Class to hold a m.room.create event

+
+
+

Functions

+
++++ + + + + + + + + + + + + + + + + + + + + + + + + + + +
#defineMATRIX_EVENT_TYPE_ROOM_CREATE
+MatrixEventRoomCreate * + +matrix_event_room_create_new () +
const gchar * + +matrix_event_room_create_get_creator () +
+void + +matrix_event_room_create_set_creator () +
+gboolean + +matrix_event_room_create_get_federate () +
+void + +matrix_event_room_create_set_federate () +
+
+
+

Types and Values

+
++++ + + + + + + + + + + +
structMatrixEventRoomCreate
structMatrixEventRoomCreateClass
+
+
+

Description

+

This is the first event in a room and cannot be changed. It acts as the root of all other events.

+
+
+

Functions

+
+

MATRIX_EVENT_TYPE_ROOM_CREATE

+
#define MATRIX_EVENT_TYPE_ROOM_CREATE (matrix_event_room_create_get_type ())
+
+

The type for MatrixEventRoomCreate.

+
+
+
+

matrix_event_room_create_new ()

+
MatrixEventRoomCreate *
+matrix_event_room_create_new (void);
+
+
+
+

matrix_event_room_create_get_creator ()

+
const gchar *
+matrix_event_room_create_get_creator (MatrixEventRoomCreate *self);
+

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

+

The user_id of the room creator. This is set by the homeserver.

+
+

Parameters

+
+++++ + + + + + +

self

the MatrixEventRoomCreate instance to query

 
+
+
+

Returns

+

the value of the "creator" property

+
+
+
+
+

matrix_event_room_create_set_creator ()

+
void
+matrix_event_room_create_set_creator (MatrixEventRoomCreate *self,
+                                      const gchar *value);
+

Set the value of the "creator" property to value +.

+

The user_id of the room creator. This is set by the homeserver.

+
+

Parameters

+
+++++ + + + + + + + + + + + + +

self

the MatrixEventRoomCreate instance to modify

 

value

the new value of the "creator" property

 
+
+
+
+
+

matrix_event_room_create_get_federate ()

+
gboolean
+matrix_event_room_create_get_federate (MatrixEventRoomCreate *self);
+

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

+

Whether users on other servers can join this room. Defaults to true if key does not exist.

+
+

Parameters

+
+++++ + + + + + +

self

the MatrixEventRoomCreate instance to query

 
+
+
+

Returns

+

the value of the "federate" property

+
+
+
+
+

matrix_event_room_create_set_federate ()

+
void
+matrix_event_room_create_set_federate (MatrixEventRoomCreate *self,
+                                       gboolean value);
+

Set the value of the "federate" property to value +.

+

Whether users on other servers can join this room. Defaults to true if key does not exist.

+
+

Parameters

+
+++++ + + + + + + + + + + + + +

self

the MatrixEventRoomCreate instance to modify

 

value

the new value of the "federate" property

 
+
+
+
+
+

Types and Values

+
+

struct MatrixEventRoomCreate

+
struct MatrixEventRoomCreate {
+	MatrixEventState parent_instance;
+	MatrixEventRoomCreatePrivate * priv;
+};
+
+

Class to hold a m.room.create event

+

This is the first event in a room and cannot be changed. It acts as the root of all other events.

+
+
+
+

struct MatrixEventRoomCreateClass

+
struct MatrixEventRoomCreateClass {
+	MatrixEventStateClass parent_class;
+};
+
+

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

+
+

Members

+
+++++ + + + + + +

MatrixEventStateClass parent_class;

the parent class structure

 
+
+
+
+
+
+
Generated by GTK-Doc V1.24
+ + \ No newline at end of file diff --git a/Matrix-0.0-MatrixEventRoomGuestAccess.html b/Matrix-0.0-MatrixEventRoomGuestAccess.html new file mode 100644 index 0000000..e1bb757 --- /dev/null +++ b/Matrix-0.0-MatrixEventRoomGuestAccess.html @@ -0,0 +1,211 @@ + + + + +MatrixEventRoomGuestAccess: Matrix-0.0 Reference Manual + + + + + + + + + + + + + + + + +
+
+
+ + +
+

MatrixEventRoomGuestAccess

+

MatrixEventRoomGuestAccess — Class to hold a m.room.guest_access event

+
+
+

Functions

+
++++ + + + + + + + + + + + + + + + + + + +
#defineMATRIX_EVENT_TYPE_ROOM_GUEST_ACCESS
+MatrixEventRoomGuestAccess * + +matrix_event_room_guest_access_new () +
+MatrixGuestAccess + +matrix_event_room_guest_access_get_guest_access () +
+void + +matrix_event_room_guest_access_set_guest_access () +
+
+
+

Types and Values

+
++++ + + + + + + + + + + +
structMatrixEventRoomGuestAccess
structMatrixEventRoomGuestAccessClass
+
+
+

Description

+
+
+

Functions

+
+

MATRIX_EVENT_TYPE_ROOM_GUEST_ACCESS

+
#define MATRIX_EVENT_TYPE_ROOM_GUEST_ACCESS (matrix_event_room_guest_access_get_type ())
+
+

The type for MatrixEventRoomGuestAccess.

+
+
+
+

matrix_event_room_guest_access_new ()

+
MatrixEventRoomGuestAccess *
+matrix_event_room_guest_access_new (void);
+
+
+
+

matrix_event_room_guest_access_get_guest_access ()

+
MatrixGuestAccess
+matrix_event_room_guest_access_get_guest_access
+                               (MatrixEventRoomGuestAccess *self);
+

Get and return the current value of the "guest-access" property.

+

Whether guests can join the room.

+
+

Parameters

+
+++++ + + + + + +

self

the MatrixEventRoomGuestAccess instance to query

 
+
+
+

Returns

+

the value of the "guest-access" property

+
+
+
+
+

matrix_event_room_guest_access_set_guest_access ()

+
void
+matrix_event_room_guest_access_set_guest_access
+                               (MatrixEventRoomGuestAccess *self,
+                                MatrixGuestAccess value);
+

Set the value of the "guest-access" property to value +.

+

Whether guests can join the room.

+
+

Parameters

+
+++++ + + + + + + + + + + + + +

self

the MatrixEventRoomGuestAccess instance to modify

 

value

the new value of the "guest-access" property

 
+
+
+
+
+

Types and Values

+
+

struct MatrixEventRoomGuestAccess

+
struct MatrixEventRoomGuestAccess {
+	MatrixEventState parent_instance;
+	MatrixEventRoomGuestAccessPrivate * priv;
+};
+
+

Class to hold a m.room.guest_access event

+
+
+
+

struct MatrixEventRoomGuestAccessClass

+
struct MatrixEventRoomGuestAccessClass {
+	MatrixEventStateClass parent_class;
+};
+
+

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

+
+

Members

+
+++++ + + + + + +

MatrixEventStateClass parent_class;

the parent class structure

 
+
+
+
+
+
+
Generated by GTK-Doc V1.24
+ + \ No newline at end of file diff --git a/Matrix-0.0-MatrixEventRoomHistoryVisibility.html b/Matrix-0.0-MatrixEventRoomHistoryVisibility.html new file mode 100644 index 0000000..fbd7b8e --- /dev/null +++ b/Matrix-0.0-MatrixEventRoomHistoryVisibility.html @@ -0,0 +1,214 @@ + + + + +MatrixEventRoomHistoryVisibility: Matrix-0.0 Reference Manual + + + + + + + + + + + + + + + + +
+
+
+ + +
+

MatrixEventRoomHistoryVisibility

+

MatrixEventRoomHistoryVisibility — Class to hold a m.room.history_visibility event.

+
+
+

Functions

+
++++ + + + + + + + + + + + + + + + + + + +
#defineMATRIX_EVENT_TYPE_ROOM_HISTORY_VISIBILITY
+MatrixEventRoomHistoryVisibility * + +matrix_event_room_history_visibility_new () +
+MatrixHistoryVisibility + +matrix_event_room_history_visibility_get_visibility () +
+void + +matrix_event_room_history_visibility_set_visibility () +
+
+
+

Types and Values

+
++++ + + + + + + + + + + +
structMatrixEventRoomHistoryVisibility
structMatrixEventRoomHistoryVisibilityClass
+
+
+

Description

+

This event controls whether a user can see the events that happened in a room from before they joined.

+
+
+

Functions

+
+

MATRIX_EVENT_TYPE_ROOM_HISTORY_VISIBILITY

+
#define MATRIX_EVENT_TYPE_ROOM_HISTORY_VISIBILITY (matrix_event_room_history_visibility_get_type ())
+
+

The type for MatrixEventRoomHistoryVisibility.

+
+
+
+

matrix_event_room_history_visibility_new ()

+
MatrixEventRoomHistoryVisibility *
+matrix_event_room_history_visibility_new
+                               (void);
+
+
+
+

matrix_event_room_history_visibility_get_visibility ()

+
MatrixHistoryVisibility
+matrix_event_room_history_visibility_get_visibility
+                               (MatrixEventRoomHistoryVisibility *self);
+

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

+

Who can see the room history.

+
+

Parameters

+
+++++ + + + + + +

self

the MatrixEventRoomHistoryVisibility instance to query

 
+
+
+

Returns

+

the value of the "visibility" property

+
+
+
+
+

matrix_event_room_history_visibility_set_visibility ()

+
void
+matrix_event_room_history_visibility_set_visibility
+                               (MatrixEventRoomHistoryVisibility *self,
+                                MatrixHistoryVisibility value);
+

Set the value of the "visibility" property to value +.

+

Who can see the room history.

+
+

Parameters

+
+++++ + + + + + + + + + + + + +

self

the MatrixEventRoomHistoryVisibility instance to modify

 

value

the new value of the "visibility" property

 
+
+
+
+
+

Types and Values

+
+

struct MatrixEventRoomHistoryVisibility

+
struct MatrixEventRoomHistoryVisibility {
+	MatrixEventState parent_instance;
+	MatrixEventRoomHistoryVisibilityPrivate * priv;
+};
+
+

Class to hold a m.room.history_visibility event.

+

This event controls whether a user can see the events that happened in a room from before they joined.

+
+
+
+

struct MatrixEventRoomHistoryVisibilityClass

+
struct MatrixEventRoomHistoryVisibilityClass {
+	MatrixEventStateClass parent_class;
+};
+
+

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

+
+

Members

+
+++++ + + + + + +

MatrixEventStateClass parent_class;

the parent class structure

 
+
+
+
+
+
+
Generated by GTK-Doc V1.24
+ + \ No newline at end of file diff --git a/Matrix-0.0-MatrixEventRoomJoinRules.html b/Matrix-0.0-MatrixEventRoomJoinRules.html new file mode 100644 index 0000000..bde1f90 --- /dev/null +++ b/Matrix-0.0-MatrixEventRoomJoinRules.html @@ -0,0 +1,211 @@ + + + + +MatrixEventRoomJoinRules: Matrix-0.0 Reference Manual + + + + + + + + + + + + + + + + +
+
+
+ + +
+

MatrixEventRoomJoinRules

+

MatrixEventRoomJoinRules — Class to hold a m.room.join_rules event.

+
+
+

Functions

+
++++ + + + + + + + + + + + + + + + + + + +
#defineMATRIX_EVENT_TYPE_ROOM_JOIN_RULES
+MatrixEventRoomJoinRules * + +matrix_event_room_join_rules_new () +
+MatrixJoinRules + +matrix_event_room_join_rules_get_join_rules () +
+void + +matrix_event_room_join_rules_set_join_rules () +
+
+
+

Types and Values

+
++++ + + + + + + + + + + +
structMatrixEventRoomJoinRules
structMatrixEventRoomJoinRulesClass
+
+
+

Description

+

A room may be public meaning anyone can join the room without any prior action. Alternatively, it can be invite meaning that a user who wishes to join the room must first receive an invite to the room from someone already inside of the room. Currently, knock and private are reserved keywords which are not implemented.

+
+
+

Functions

+
+

MATRIX_EVENT_TYPE_ROOM_JOIN_RULES

+
#define MATRIX_EVENT_TYPE_ROOM_JOIN_RULES (matrix_event_room_join_rules_get_type ())
+
+

The type for MatrixEventRoomJoinRules.

+
+
+
+

matrix_event_room_join_rules_new ()

+
MatrixEventRoomJoinRules *
+matrix_event_room_join_rules_new (void);
+
+
+
+

matrix_event_room_join_rules_get_join_rules ()

+
MatrixJoinRules
+matrix_event_room_join_rules_get_join_rules
+                               (MatrixEventRoomJoinRules *self);
+

Get and return the current value of the "join-rules" property.

+
+

Parameters

+
+++++ + + + + + +

self

the MatrixEventRoomJoinRules instance to query

 
+
+
+

Returns

+

the value of the "join-rules" property

+
+
+
+
+

matrix_event_room_join_rules_set_join_rules ()

+
void
+matrix_event_room_join_rules_set_join_rules
+                               (MatrixEventRoomJoinRules *self,
+                                MatrixJoinRules value);
+

Set the value of the "join-rules" property to value +.

+
+

Parameters

+
+++++ + + + + + + + + + + + + +

self

the MatrixEventRoomJoinRules instance to modify

 

value

the new value of the "join-rules" property

 
+
+
+
+
+

Types and Values

+
+

struct MatrixEventRoomJoinRules

+
struct MatrixEventRoomJoinRules {
+	MatrixEventState parent_instance;
+	MatrixEventRoomJoinRulesPrivate * priv;
+};
+
+

Class to hold a m.room.join_rules event.

+

A room may be public meaning anyone can join the room without any prior action. Alternatively, it can be invite meaning that a user who wishes to join the room must first receive an invite to the room from someone already inside of the room. Currently, knock and private are reserved keywords which are not implemented.

+
+
+
+

struct MatrixEventRoomJoinRulesClass

+
struct MatrixEventRoomJoinRulesClass {
+	MatrixEventStateClass parent_class;
+};
+
+

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

+
+

Members

+
+++++ + + + + + +

MatrixEventStateClass parent_class;

the parent class structure

 
+
+
+
+
+
+
Generated by GTK-Doc V1.24
+ + \ No newline at end of file diff --git a/Matrix-0.0-MatrixEventRoomMember.html b/Matrix-0.0-MatrixEventRoomMember.html new file mode 100644 index 0000000..8bb8dee --- /dev/null +++ b/Matrix-0.0-MatrixEventRoomMember.html @@ -0,0 +1,839 @@ + + + + +MatrixEventRoomMember: Matrix-0.0 Reference Manual + + + + + + + + + + + + + + + + +
+
+
+ + +
+

MatrixEventRoomMember

+

MatrixEventRoomMember — Class for representing a room membership events

+
+
+

Functions

+
++++ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
#defineMATRIX_EVENT_TYPE_ROOM_MEMBER
+MatrixEventRoomMember * + +matrix_event_room_member_new () +
+MatrixRoomMembership + +matrix_event_room_member_get_membership () +
+void + +matrix_event_room_member_set_membership () +
const gchar * + +matrix_event_room_member_get_avatar_url () +
+void + +matrix_event_room_member_set_avatar_url () +
const gchar * + +matrix_event_room_member_get_display_name () +
+void + +matrix_event_room_member_set_display_name () +
const gchar * + +matrix_event_room_member_get_tpi_display_name () +
+void + +matrix_event_room_member_set_tpi_display_name () +
const gchar * + +matrix_event_room_member_get_tpi_signed_mxid () +
+void + +matrix_event_room_member_set_tpi_signed_mxid () +
const gchar * + +matrix_event_room_member_get_tpi_signed_token () +
+void + +matrix_event_room_member_set_tpi_signed_token () +
+JsonNode * + +matrix_event_room_member_get_tpi_signature () +
+void + +matrix_event_room_member_set_tpi_signature () +
+MatrixEventState ** + +matrix_event_room_member_get_invite_room_state () +
+void + +matrix_event_room_member_set_invite_room_state () +
const gchar * + +matrix_event_room_member_get_user_id () +
+void + +matrix_event_room_member_set_user_id () +
+
+
+

Types and Values

+
++++ + + + + + + + + + + +
structMatrixEventRoomMember
structMatrixEventRoomMemberClass
+
+
+

Description

+

Adjusts the membership state for a user in a room. It is preferable to use the membership APIs (`/rooms/<room id>/invite` etc) when performing membership actions rather than adjusting the state directly as there are a restricted set of valid transformations. For example, user A cannot force user B to join a room, and trying to force this state change directly will fail.

+

The following membership states are specified:

+

- invite - The user has been invited to join a room, but has not yet joined it. They may not participate in the room until they join.

+

- join - The user has joined the room (possibly after accepting an invite), and may participate in it.

+

- leave - The user was once joined to the room, but has since left (possibly by choice, or possibly by being kicked).

+

- ban - The user has been banned from the room, and is no longer allowed to join it until they are un-banned from the room (by having their membership state set to a value other than ban).

+

- knock - This is a reserved word, which currently has no meaning.

+

The third_party_invite property will be set if this invite is an invite event and is the successor of an m.room.third_party_invite event, and absent otherwise.

+

This event may also include an invite_room_state key outside the content key. If present, this contains an array of stripped state events. These events provide information on a few select state events such as the room name.

+
+
+

Functions

+
+

MATRIX_EVENT_TYPE_ROOM_MEMBER

+
#define MATRIX_EVENT_TYPE_ROOM_MEMBER (matrix_event_room_member_get_type ())
+
+

The type for MatrixEventRoomMember.

+
+
+
+

matrix_event_room_member_new ()

+
MatrixEventRoomMember *
+matrix_event_room_member_new (void);
+
+
+
+

matrix_event_room_member_get_membership ()

+
MatrixRoomMembership
+matrix_event_room_member_get_membership
+                               (MatrixEventRoomMember *self);
+

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

+

The membership state of the user.

+
+

Parameters

+
+++++ + + + + + +

self

the MatrixEventRoomMember instance to query

 
+
+
+

Returns

+

the value of the "membership" property

+
+
+
+
+

matrix_event_room_member_set_membership ()

+
void
+matrix_event_room_member_set_membership
+                               (MatrixEventRoomMember *self,
+                                MatrixRoomMembership value);
+

Set the value of the "membership" property to value +.

+

The membership state of the user.

+
+

Parameters

+
+++++ + + + + + + + + + + + + +

self

the MatrixEventRoomMember instance to modify

 

value

the new value of the "membership" property

 
+
+
+
+
+

matrix_event_room_member_get_avatar_url ()

+
const gchar *
+matrix_event_room_member_get_avatar_url
+                               (MatrixEventRoomMember *self);
+

Get and return the current value of the "avatar-url" property.

+

The avatar URL for this user, if any. This is added by the homeserver.

+
+

Parameters

+
+++++ + + + + + +

self

the MatrixEventRoomMember instance to query

 
+
+
+

Returns

+

the value of the "avatar-url" property

+
+
+
+
+

matrix_event_room_member_set_avatar_url ()

+
void
+matrix_event_room_member_set_avatar_url
+                               (MatrixEventRoomMember *self,
+                                const gchar *value);
+

Set the value of the "avatar-url" property to value +.

+

The avatar URL for this user, if any. This is added by the homeserver.

+
+

Parameters

+
+++++ + + + + + + + + + + + + +

self

the MatrixEventRoomMember instance to modify

 

value

the new value of the "avatar-url" property

 
+
+
+
+
+

matrix_event_room_member_get_display_name ()

+
const gchar *
+matrix_event_room_member_get_display_name
+                               (MatrixEventRoomMember *self);
+

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

+

The display name for this user, if any. This is added by the homeserver.

+
+

Parameters

+
+++++ + + + + + +

self

the MatrixEventRoomMember instance to query

 
+
+
+

Returns

+

the value of the "display-name" property

+
+
+
+
+

matrix_event_room_member_set_display_name ()

+
void
+matrix_event_room_member_set_display_name
+                               (MatrixEventRoomMember *self,
+                                const gchar *value);
+

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

+

The display name for this user, if any. This is added by the homeserver.

+
+

Parameters

+
+++++ + + + + + + + + + + + + +

self

the MatrixEventRoomMember instance to modify

 

value

the new value of the "display-name" property

 
+
+
+
+
+

matrix_event_room_member_get_tpi_display_name ()

+
const gchar *
+matrix_event_room_member_get_tpi_display_name
+                               (MatrixEventRoomMember *self);
+

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

+

A name which can be displayed to represent the user instead of their third party identifier

+
+

Parameters

+
+++++ + + + + + +

self

the MatrixEventRoomMember instance to query

 
+
+
+

Returns

+

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

+
+
+
+
+

matrix_event_room_member_set_tpi_display_name ()

+
void
+matrix_event_room_member_set_tpi_display_name
+                               (MatrixEventRoomMember *self,
+                                const gchar *value);
+

Set the value of the "tpi-display-name" property to value +.

+

A name which can be displayed to represent the user instead of their third party identifier

+
+

Parameters

+
+++++ + + + + + + + + + + + + +

self

the MatrixEventRoomMember instance to modify

 

value

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

 
+
+
+
+
+

matrix_event_room_member_get_tpi_signed_mxid ()

+
const gchar *
+matrix_event_room_member_get_tpi_signed_mxid
+                               (MatrixEventRoomMember *self);
+

Get and return the current value of the "tpi-signed-mxid" property.

+

The invited matrix user ID. Must be equal to the user_id property of the event.

+
+

Parameters

+
+++++ + + + + + +

self

the MatrixEventRoomMember instance to query

 
+
+
+

Returns

+

the value of the "tpi-signed-mxid" property

+
+
+
+
+

matrix_event_room_member_set_tpi_signed_mxid ()

+
void
+matrix_event_room_member_set_tpi_signed_mxid
+                               (MatrixEventRoomMember *self,
+                                const gchar *value);
+

Set the value of the "tpi-signed-mxid" property to value +.

+

The invited matrix user ID. Must be equal to the user_id property of the event.

+
+

Parameters

+
+++++ + + + + + + + + + + + + +

self

the MatrixEventRoomMember instance to modify

 

value

the new value of the "tpi-signed-mxid" property

 
+
+
+
+
+

matrix_event_room_member_get_tpi_signed_token ()

+
const gchar *
+matrix_event_room_member_get_tpi_signed_token
+                               (MatrixEventRoomMember *self);
+

Get and return the current value of the "tpi-signed-token" property.

+

The token property of the containing third_party_invite object.

+
+

Parameters

+
+++++ + + + + + +

self

the MatrixEventRoomMember instance to query

 
+
+
+

Returns

+

the value of the "tpi-signed-token" property

+
+
+
+
+

matrix_event_room_member_set_tpi_signed_token ()

+
void
+matrix_event_room_member_set_tpi_signed_token
+                               (MatrixEventRoomMember *self,
+                                const gchar *value);
+

Set the value of the "tpi-signed-token" property to value +.

+

The token property of the containing third_party_invite object.

+
+

Parameters

+
+++++ + + + + + + + + + + + + +

self

the MatrixEventRoomMember instance to modify

 

value

the new value of the "tpi-signed-token" property

 
+
+
+
+
+

matrix_event_room_member_get_tpi_signature ()

+
JsonNode *
+matrix_event_room_member_get_tpi_signature
+                               (MatrixEventRoomMember *self);
+

Get and return the current value of the "tpi-signature" property.

+

A single signature from the verifying server, in the format specified by the Signing Events section of the server-server API.

+
+

Parameters

+
+++++ + + + + + +

self

the MatrixEventRoomMember instance to query

 
+
+
+

Returns

+

the value of the "tpi-signature" property

+
+
+
+
+

matrix_event_room_member_set_tpi_signature ()

+
void
+matrix_event_room_member_set_tpi_signature
+                               (MatrixEventRoomMember *self,
+                                JsonNode *value);
+

Set the value of the "tpi-signature" property to value +.

+

A single signature from the verifying server, in the format specified by the Signing Events section of the server-server API.

+
+

Parameters

+
+++++ + + + + + + + + + + + + +

self

the MatrixEventRoomMember instance to modify

 

value

the new value of the "tpi-signature" property

 
+
+
+
+
+

matrix_event_room_member_get_invite_room_state ()

+
MatrixEventState **
+matrix_event_room_member_get_invite_room_state
+                               (MatrixEventRoomMember *self,
+                                int *result_length1);
+

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

+

A subset of the state of the room at the time of the invite, if membership is invite.

+
+

Parameters

+
+++++ + + + + + +

self

the MatrixEventRoomMember instance to query

 
+
+
+

Returns

+

the value of the "invite-room-state" property

+
+
+
+
+

matrix_event_room_member_set_invite_room_state ()

+
void
+matrix_event_room_member_set_invite_room_state
+                               (MatrixEventRoomMember *self,
+                                MatrixEventState **value,
+                                int value_length1);
+

Set the value of the "invite-room-state" property to value +.

+

A subset of the state of the room at the time of the invite, if membership is invite.

+
+

Parameters

+
+++++ + + + + + + + + + + + + +

self

the MatrixEventRoomMember instance to modify

 

value

the new value of the "invite-room-state" property

 
+
+
+
+
+

matrix_event_room_member_get_user_id ()

+
const gchar *
+matrix_event_room_member_get_user_id (MatrixEventRoomMember *self);
+

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

+

The user ID whom this event relates to.

+
+

Parameters

+
+++++ + + + + + +

self

the MatrixEventRoomMember instance to query

 
+
+
+

Returns

+

the value of the "user-id" property

+
+
+
+
+

matrix_event_room_member_set_user_id ()

+
void
+matrix_event_room_member_set_user_id (MatrixEventRoomMember *self,
+                                      const gchar *value);
+

Set the value of the "user-id" property to value +.

+

The user ID whom this event relates to.

+
+

Parameters

+
+++++ + + + + + + + + + + + + +

self

the MatrixEventRoomMember instance to modify

 

value

the new value of the "user-id" property

 
+
+
+
+
+

Types and Values

+
+

struct MatrixEventRoomMember

+
struct MatrixEventRoomMember {
+	MatrixEventState parent_instance;
+	MatrixEventRoomMemberPrivate * priv;
+};
+
+

Class for representing a room membership events

+

Adjusts the membership state for a user in a room. It is preferable to use the membership APIs (`/rooms/<room id>/invite` etc) when performing membership actions rather than adjusting the state directly as there are a restricted set of valid transformations. For example, user A cannot force user B to join a room, and trying to force this state change directly will fail.

+

The following membership states are specified:

+

- invite - The user has been invited to join a room, but has not yet joined it. They may not participate in the room until they join.

+

- join - The user has joined the room (possibly after accepting an invite), and may participate in it.

+

- leave - The user was once joined to the room, but has since left (possibly by choice, or possibly by being kicked).

+

- ban - The user has been banned from the room, and is no longer allowed to join it until they are un-banned from the room (by having their membership state set to a value other than ban).

+

- knock - This is a reserved word, which currently has no meaning.

+

The third_party_invite property will be set if this invite is an invite event and is the successor of an m.room.third_party_invite event, and absent otherwise.

+

This event may also include an invite_room_state key outside the content key. If present, this contains an array of stripped state events. These events provide information on a few select state events such as the room name.

+
+
+
+

struct MatrixEventRoomMemberClass

+
struct MatrixEventRoomMemberClass {
+	MatrixEventStateClass parent_class;
+};
+
+

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

+
+

Members

+
+++++ + + + + + +

MatrixEventStateClass parent_class;

the parent class structure

 
+
+
+
+
+
+
Generated by GTK-Doc V1.24
+ + \ No newline at end of file diff --git a/Matrix-0.0-MatrixEventRoomMessage.html b/Matrix-0.0-MatrixEventRoomMessage.html new file mode 100644 index 0000000..7c8772f --- /dev/null +++ b/Matrix-0.0-MatrixEventRoomMessage.html @@ -0,0 +1,247 @@ + + + + +MatrixEventRoomMessage: Matrix-0.0 Reference Manual + + + + + + + + + + + + + + + + +
+
+
+ + +
+

MatrixEventRoomMessage

+

MatrixEventRoomMessage — Class to hold an m.room.message event

+
+
+

Functions

+
++++ + + + + + + + + + + + + + + + + + + + + + + +
#defineMATRIX_EVENT_TYPE_ROOM_MESSAGE
+MatrixEventRoomMessage * + +matrix_event_room_message_new () +
+MatrixMessageBase * + +matrix_event_room_message_get_message () +
+void + +matrix_event_room_message_set_message () +
+JsonNode * + +matrix_event_room_message_get_fallback_content () +
+
+
+

Types and Values

+
++++ + + + + + + + + + + +
structMatrixEventRoomMessage
structMatrixEventRoomMessageClass
+
+
+

Description

+

This event is used when sending messages in a room. Messages are not limited to be text. The `msgtype` key outlines the type of message, e.g. text, audio, image, video, etc. The `body` key is text and MUST be used with every kind of `msgtype` as a fallback mechanism for when a client cannot render a message. This allows clients to display *something* even if it is just plain text.

+
+
+

Functions

+
+

MATRIX_EVENT_TYPE_ROOM_MESSAGE

+
#define MATRIX_EVENT_TYPE_ROOM_MESSAGE (matrix_event_room_message_get_type ())
+
+

The type for MatrixEventRoomMessage.

+
+
+
+

matrix_event_room_message_new ()

+
MatrixEventRoomMessage *
+matrix_event_room_message_new (void);
+
+
+
+

matrix_event_room_message_get_message ()

+
MatrixMessageBase *
+matrix_event_room_message_get_message (MatrixEventRoomMessage *self);
+

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

+

The message as a Matrix.Message object.

+
+

Parameters

+
+++++ + + + + + +

self

the MatrixEventRoomMessage instance to query

 
+
+
+

Returns

+

the value of the "message" property

+
+
+
+
+

matrix_event_room_message_set_message ()

+
void
+matrix_event_room_message_set_message (MatrixEventRoomMessage *self,
+                                       MatrixMessageBase *value);
+

Set the value of the "message" property to value +.

+

The message as a Matrix.Message object.

+
+

Parameters

+
+++++ + + + + + + + + + + + + +

self

the MatrixEventRoomMessage instance to modify

 

value

the new value of the "message" property

 
+
+
+
+
+

matrix_event_room_message_get_fallback_content ()

+
JsonNode *
+matrix_event_room_message_get_fallback_content
+                               (MatrixEventRoomMessage *self);
+

Get and return the current value of the "fallback-content" property.

+

The message as a JSON object. This gets set by Matrix.Message.Base.new_from_json if no handler is installed for the given message type.

+
+

Parameters

+
+++++ + + + + + +

self

the MatrixEventRoomMessage instance to query

 
+
+
+

Returns

+

the value of the "fallback-content" property

+
+
+
+
+

Types and Values

+
+

struct MatrixEventRoomMessage

+
struct MatrixEventRoomMessage {
+	MatrixEventRoom parent_instance;
+	MatrixEventRoomMessagePrivate * priv;
+};
+
+

Class to hold an m.room.message event

+

This event is used when sending messages in a room. Messages are not limited to be text. The `msgtype` key outlines the type of message, e.g. text, audio, image, video, etc. The `body` key is text and MUST be used with every kind of `msgtype` as a fallback mechanism for when a client cannot render a message. This allows clients to display *something* even if it is just plain text.

+
+
+
+

struct MatrixEventRoomMessageClass

+
struct MatrixEventRoomMessageClass {
+	MatrixEventRoomClass parent_class;
+};
+
+

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

+
+

Members

+
+++++ + + + + + +

MatrixEventRoomClass parent_class;

the parent class structure

 
+
+
+
+
+
+
Generated by GTK-Doc V1.24
+ + \ No newline at end of file diff --git a/Matrix-0.0-MatrixEventRoomMessageFeedback.html b/Matrix-0.0-MatrixEventRoomMessageFeedback.html new file mode 100644 index 0000000..49d79b5 --- /dev/null +++ b/Matrix-0.0-MatrixEventRoomMessageFeedback.html @@ -0,0 +1,291 @@ + + + + +MatrixEventRoomMessageFeedback: Matrix-0.0 Reference Manual + + + + + + + + + + + + + + + + +
+
+
+ + +
+

MatrixEventRoomMessageFeedback

+

MatrixEventRoomMessageFeedback — Class to hold a m.room.message.feedback event.

+
+
+

Functions

+
++++ + + + + + + + + + + + + + + + + + + + + + + + + + + +
#defineMATRIX_EVENT_TYPE_ROOM_MESSAGE_FEEDBACK
+MatrixEventRoomMessageFeedback * + +matrix_event_room_message_feedback_new () +
const gchar * + +matrix_event_room_message_feedback_get_feedback_type () +
+void + +matrix_event_room_message_feedback_set_feedback_type () +
const gchar * + +matrix_event_room_message_feedback_get_target_event_id () +
+void + +matrix_event_room_message_feedback_set_target_event_id () +
+
+
+

Types and Values

+
++++ + + + + + + + + + + +
structMatrixEventRoomMessageFeedback
structMatrixEventRoomMessageFeedbackClass
+
+
+

Description

+

Usage of this event is discouraged in favour of the receipts module. Most clients will not recognise this event.

+

Feedback events are events sent to acknowledge a message in some way. There are two supported acknowledgements: `delivered` (sent when the event has been received) and `read` (sent when the event has been observed by the end-user). The `target_event_id` should reference the `m.room.message` event being acknowledged.

+
+
+

Functions

+
+

MATRIX_EVENT_TYPE_ROOM_MESSAGE_FEEDBACK

+
#define MATRIX_EVENT_TYPE_ROOM_MESSAGE_FEEDBACK (matrix_event_room_message_feedback_get_type ())
+
+

The type for MatrixEventRoomMessageFeedback.

+
+
+
+

matrix_event_room_message_feedback_new ()

+
MatrixEventRoomMessageFeedback *
+matrix_event_room_message_feedback_new
+                               (void);
+
+
+
+

matrix_event_room_message_feedback_get_feedback_type ()

+
const gchar *
+matrix_event_room_message_feedback_get_feedback_type
+                               (MatrixEventRoomMessageFeedback *self);
+

Get and return the current value of the "feedback-type" property.

+

The type of the feedback. As the use of this event type is discouraged, Matrix GLib SDK doesn’t implement this as an actual enum.

+
+

Parameters

+
+++++ + + + + + +

self

the MatrixEventRoomMessageFeedback instance to query

 
+
+
+

Returns

+

the value of the "feedback-type" property

+
+
+
+
+

matrix_event_room_message_feedback_set_feedback_type ()

+
void
+matrix_event_room_message_feedback_set_feedback_type
+                               (MatrixEventRoomMessageFeedback *self,
+                                const gchar *value);
+

Set the value of the "feedback-type" property to value +.

+

The type of the feedback. As the use of this event type is discouraged, Matrix GLib SDK doesn’t implement this as an actual enum.

+
+

Parameters

+
+++++ + + + + + + + + + + + + +

self

the MatrixEventRoomMessageFeedback instance to modify

 

value

the new value of the "feedback-type" property

 
+
+
+
+
+

matrix_event_room_message_feedback_get_target_event_id ()

+
const gchar *
+matrix_event_room_message_feedback_get_target_event_id
+                               (MatrixEventRoomMessageFeedback *self);
+

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

+

The event that this feedback is related to.

+
+

Parameters

+
+++++ + + + + + +

self

the MatrixEventRoomMessageFeedback instance to query

 
+
+
+

Returns

+

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

+
+
+
+
+

matrix_event_room_message_feedback_set_target_event_id ()

+
void
+matrix_event_room_message_feedback_set_target_event_id
+                               (MatrixEventRoomMessageFeedback *self,
+                                const gchar *value);
+

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

+

The event that this feedback is related to.

+
+

Parameters

+
+++++ + + + + + + + + + + + + +

self

the MatrixEventRoomMessageFeedback instance to modify

 

value

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

 
+
+
+
+
+

Types and Values

+
+

struct MatrixEventRoomMessageFeedback

+
struct MatrixEventRoomMessageFeedback {
+	MatrixEventRoom parent_instance;
+	MatrixEventRoomMessageFeedbackPrivate * priv;
+};
+
+

Class to hold a m.room.message.feedback event.

+

Usage of this event is discouraged in favour of the receipts module. Most clients will not recognise this event.

+

Feedback events are events sent to acknowledge a message in some way. There are two supported acknowledgements: `delivered` (sent when the event has been received) and `read` (sent when the event has been observed by the end-user). The `target_event_id` should reference the `m.room.message` event being acknowledged.

+
+
+
+

struct MatrixEventRoomMessageFeedbackClass

+
struct MatrixEventRoomMessageFeedbackClass {
+	MatrixEventRoomClass parent_class;
+};
+
+

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

+
+

Members

+
+++++ + + + + + +

MatrixEventRoomClass parent_class;

the parent class structure

 
+
+
+
+
+
+
Generated by GTK-Doc V1.24
+ + \ No newline at end of file diff --git a/Matrix-0.0-MatrixEventRoomName.html b/Matrix-0.0-MatrixEventRoomName.html new file mode 100644 index 0000000..74e6975 --- /dev/null +++ b/Matrix-0.0-MatrixEventRoomName.html @@ -0,0 +1,208 @@ + + + + +MatrixEventRoomName: Matrix-0.0 Reference Manual + + + + + + + + + + + + + + + + +
+
+
+ + +
+

MatrixEventRoomName

+

MatrixEventRoomName — Class to hold a m.room.name event.

+
+
+

Functions

+
++++ + + + + + + + + + + + + + + + + + + +
#defineMATRIX_EVENT_TYPE_ROOM_NAME
+MatrixEventRoomName * + +matrix_event_room_name_new () +
const gchar * + +matrix_event_room_name_get_name () +
+void + +matrix_event_room_name_set_name () +
+
+
+

Types and Values

+
++++ + + + + + + + + + + +
structMatrixEventRoomName
structMatrixEventRoomNameClass
+
+
+

Description

+

A room has an opaque room ID which is not human-friendly to read. A room alias is human-friendly, but not all rooms have room aliases. The room name is a human-friendly string designed to be displayed to the end-user. The room name is not unique, as multiple rooms can have the same room name set. The room name can also be set when creating a room using createRoom with the name key.

+
+
+

Functions

+
+

MATRIX_EVENT_TYPE_ROOM_NAME

+
#define MATRIX_EVENT_TYPE_ROOM_NAME (matrix_event_room_name_get_type ())
+
+

The type for MatrixEventRoomName.

+
+
+
+

matrix_event_room_name_new ()

+
MatrixEventRoomName *
+matrix_event_room_name_new (void);
+
+
+
+

matrix_event_room_name_get_name ()

+
const gchar *
+matrix_event_room_name_get_name (MatrixEventRoomName *self);
+

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

+
+

Parameters

+
+++++ + + + + + +

self

the MatrixEventRoomName instance to query

 
+
+
+

Returns

+

the value of the "name" property

+
+
+
+
+

matrix_event_room_name_set_name ()

+
void
+matrix_event_room_name_set_name (MatrixEventRoomName *self,
+                                 const gchar *value);
+

Set the value of the "name" property to value +.

+
+

Parameters

+
+++++ + + + + + + + + + + + + +

self

the MatrixEventRoomName instance to modify

 

value

the new value of the "name" property

 
+
+
+
+
+

Types and Values

+
+

struct MatrixEventRoomName

+
struct MatrixEventRoomName {
+	MatrixEventState parent_instance;
+	MatrixEventRoomNamePrivate * priv;
+};
+
+

Class to hold a m.room.name event.

+

A room has an opaque room ID which is not human-friendly to read. A room alias is human-friendly, but not all rooms have room aliases. The room name is a human-friendly string designed to be displayed to the end-user. The room name is not unique, as multiple rooms can have the same room name set. The room name can also be set when creating a room using createRoom with the name key.

+
+
+
+

struct MatrixEventRoomNameClass

+
struct MatrixEventRoomNameClass {
+	MatrixEventStateClass parent_class;
+};
+
+

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

+
+

Members

+
+++++ + + + + + +

MatrixEventStateClass parent_class;

the parent class structure

 
+
+
+
+
+
+
Generated by GTK-Doc V1.24
+ + \ No newline at end of file diff --git a/Matrix-0.0-MatrixEventRoomPowerLevels.html b/Matrix-0.0-MatrixEventRoomPowerLevels.html new file mode 100644 index 0000000..8b28d21 --- /dev/null +++ b/Matrix-0.0-MatrixEventRoomPowerLevels.html @@ -0,0 +1,675 @@ + + + + +MatrixEventRoomPowerLevels: Matrix-0.0 Reference Manual + + + + + + + + + + + + + + + + +
+
+
+ + +
+

MatrixEventRoomPowerLevels

+

MatrixEventRoomPowerLevels — Class to handle m.room.power_levels event

+
+
+

Functions

+
++++ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
#defineMATRIX_EVENT_TYPE_ROOM_POWER_LEVELS
+MatrixEventRoomPowerLevels * + +matrix_event_room_power_levels_new () +
+gint + +matrix_event_room_power_levels_get_users_default () +
+void + +matrix_event_room_power_levels_set_users_default () +
+gint + +matrix_event_room_power_levels_get_events_default () +
+void + +matrix_event_room_power_levels_set_events_default () +
+gint + +matrix_event_room_power_levels_get_state_default () +
+void + +matrix_event_room_power_levels_set_state_default () +
+gint + +matrix_event_room_power_levels_get_ban () +
+void + +matrix_event_room_power_levels_set_ban () +
+gint + +matrix_event_room_power_levels_get_kick () +
+void + +matrix_event_room_power_levels_set_kick () +
+gint + +matrix_event_room_power_levels_get_redact () +
+void + +matrix_event_room_power_levels_set_redact () +
+gint + +matrix_event_room_power_levels_get_invite () +
+void + +matrix_event_room_power_levels_set_invite () +
+
+
+

Types and Values

+
++++ + + + + + + + + + + +
structMatrixEventRoomPowerLevels
structMatrixEventRoomPowerLevelsClass
+
+
+

Description

+

This event specifies the minimum level a user must have in order to perform a certain action. It also specifies the levels of each user in the room. If a user_id is in the users list, then that user_id has the associated power level. Otherwise they have the default level users_default. If users_default is not supplied, it is assumed to be 0. The level required to send a certain event is governed by events, state_default and events_default. If an event type is specified in events, then the user must have at least the level specified in order to send that event. If the event type is not supplied, it defaults to events_default for Message Events and state_default for State Events.

+
+
+

Functions

+
+

MATRIX_EVENT_TYPE_ROOM_POWER_LEVELS

+
#define MATRIX_EVENT_TYPE_ROOM_POWER_LEVELS (matrix_event_room_power_levels_get_type ())
+
+

The type for MatrixEventRoomPowerLevels.

+
+
+
+

matrix_event_room_power_levels_new ()

+
MatrixEventRoomPowerLevels *
+matrix_event_room_power_levels_new (void);
+
+
+
+

matrix_event_room_power_levels_get_users_default ()

+
gint
+matrix_event_room_power_levels_get_users_default
+                               (MatrixEventRoomPowerLevels *self);
+

Get and return the current value of the "users-default" property.

+

The default power level for every user in the room, unless their user_id is mentioned in the users key.

+
+

Parameters

+
+++++ + + + + + +

self

the MatrixEventRoomPowerLevels instance to query

 
+
+
+

Returns

+

the value of the "users-default" property

+
+
+
+
+

matrix_event_room_power_levels_set_users_default ()

+
void
+matrix_event_room_power_levels_set_users_default
+                               (MatrixEventRoomPowerLevels *self,
+                                gint value);
+

Set the value of the "users-default" property to value +.

+

The default power level for every user in the room, unless their user_id is mentioned in the users key.

+
+

Parameters

+
+++++ + + + + + + + + + + + + +

self

the MatrixEventRoomPowerLevels instance to modify

 

value

the new value of the "users-default" property

 
+
+
+
+
+

matrix_event_room_power_levels_get_events_default ()

+
gint
+matrix_event_room_power_levels_get_events_default
+                               (MatrixEventRoomPowerLevels *self);
+

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

+

The default level required to send message events. Can be overridden by the events key.

+
+

Parameters

+
+++++ + + + + + +

self

the MatrixEventRoomPowerLevels instance to query

 
+
+
+

Returns

+

the value of the "events-default" property

+
+
+
+
+

matrix_event_room_power_levels_set_events_default ()

+
void
+matrix_event_room_power_levels_set_events_default
+                               (MatrixEventRoomPowerLevels *self,
+                                gint value);
+

Set the value of the "events-default" property to value +.

+

The default level required to send message events. Can be overridden by the events key.

+
+

Parameters

+
+++++ + + + + + + + + + + + + +

self

the MatrixEventRoomPowerLevels instance to modify

 

value

the new value of the "events-default" property

 
+
+
+
+
+

matrix_event_room_power_levels_get_state_default ()

+
gint
+matrix_event_room_power_levels_get_state_default
+                               (MatrixEventRoomPowerLevels *self);
+

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

+

The default level required to send state events. Can be overridden by the events key.

+
+

Parameters

+
+++++ + + + + + +

self

the MatrixEventRoomPowerLevels instance to query

 
+
+
+

Returns

+

the value of the "state-default" property

+
+
+
+
+

matrix_event_room_power_levels_set_state_default ()

+
void
+matrix_event_room_power_levels_set_state_default
+                               (MatrixEventRoomPowerLevels *self,
+                                gint value);
+

Set the value of the "state-default" property to value +.

+

The default level required to send state events. Can be overridden by the events key.

+
+

Parameters

+
+++++ + + + + + + + + + + + + +

self

the MatrixEventRoomPowerLevels instance to modify

 

value

the new value of the "state-default" property

 
+
+
+
+
+

matrix_event_room_power_levels_get_ban ()

+
gint
+matrix_event_room_power_levels_get_ban
+                               (MatrixEventRoomPowerLevels *self);
+

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

+

The level required to ban a user.

+
+

Parameters

+
+++++ + + + + + +

self

the MatrixEventRoomPowerLevels instance to query

 
+
+
+

Returns

+

the value of the "ban" property

+
+
+
+
+

matrix_event_room_power_levels_set_ban ()

+
void
+matrix_event_room_power_levels_set_ban
+                               (MatrixEventRoomPowerLevels *self,
+                                gint value);
+

Set the value of the "ban" property to value +.

+

The level required to ban a user.

+
+

Parameters

+
+++++ + + + + + + + + + + + + +

self

the MatrixEventRoomPowerLevels instance to modify

 

value

the new value of the "ban" property

 
+
+
+
+
+

matrix_event_room_power_levels_get_kick ()

+
gint
+matrix_event_room_power_levels_get_kick
+                               (MatrixEventRoomPowerLevels *self);
+

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

+

The level required to kick a user.

+
+

Parameters

+
+++++ + + + + + +

self

the MatrixEventRoomPowerLevels instance to query

 
+
+
+

Returns

+

the value of the "kick" property

+
+
+
+
+

matrix_event_room_power_levels_set_kick ()

+
void
+matrix_event_room_power_levels_set_kick
+                               (MatrixEventRoomPowerLevels *self,
+                                gint value);
+

Set the value of the "kick" property to value +.

+

The level required to kick a user.

+
+

Parameters

+
+++++ + + + + + + + + + + + + +

self

the MatrixEventRoomPowerLevels instance to modify

 

value

the new value of the "kick" property

 
+
+
+
+
+

matrix_event_room_power_levels_get_redact ()

+
gint
+matrix_event_room_power_levels_get_redact
+                               (MatrixEventRoomPowerLevels *self);
+

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

+

The level required to redact an event.

+
+

Parameters

+
+++++ + + + + + +

self

the MatrixEventRoomPowerLevels instance to query

 
+
+
+

Returns

+

the value of the "redact" property

+
+
+
+
+

matrix_event_room_power_levels_set_redact ()

+
void
+matrix_event_room_power_levels_set_redact
+                               (MatrixEventRoomPowerLevels *self,
+                                gint value);
+

Set the value of the "redact" property to value +.

+

The level required to redact an event.

+
+

Parameters

+
+++++ + + + + + + + + + + + + +

self

the MatrixEventRoomPowerLevels instance to modify

 

value

the new value of the "redact" property

 
+
+
+
+
+

matrix_event_room_power_levels_get_invite ()

+
gint
+matrix_event_room_power_levels_get_invite
+                               (MatrixEventRoomPowerLevels *self);
+

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

+

The level required to invite someone.

+
+

Parameters

+
+++++ + + + + + +

self

the MatrixEventRoomPowerLevels instance to query

 
+
+
+

Returns

+

the value of the "invite" property

+
+
+
+
+

matrix_event_room_power_levels_set_invite ()

+
void
+matrix_event_room_power_levels_set_invite
+                               (MatrixEventRoomPowerLevels *self,
+                                gint value);
+

Set the value of the "invite" property to value +.

+

The level required to invite someone.

+
+

Parameters

+
+++++ + + + + + + + + + + + + +

self

the MatrixEventRoomPowerLevels instance to modify

 

value

the new value of the "invite" property

 
+
+
+
+
+

Types and Values

+
+

struct MatrixEventRoomPowerLevels

+
struct MatrixEventRoomPowerLevels {
+	MatrixEventState parent_instance;
+	MatrixEventRoomPowerLevelsPrivate * priv;
+};
+
+

Class to handle m.room.power_levels event

+

This event specifies the minimum level a user must have in order to perform a certain action. It also specifies the levels of each user in the room. If a user_id is in the users list, then that user_id has the associated power level. Otherwise they have the default level users_default. If users_default is not supplied, it is assumed to be 0. The level required to send a certain event is governed by events, state_default and events_default. If an event type is specified in events, then the user must have at least the level specified in order to send that event. If the event type is not supplied, it defaults to events_default for Message Events and state_default for State Events.

+
+
+
+

struct MatrixEventRoomPowerLevelsClass

+
struct MatrixEventRoomPowerLevelsClass {
+	MatrixEventStateClass parent_class;
+};
+
+

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

+
+

Members

+
+++++ + + + + + +

MatrixEventStateClass parent_class;

the parent class structure

 
+
+
+
+
+
+
Generated by GTK-Doc V1.24
+ + \ No newline at end of file diff --git a/Matrix-0.0-MatrixEventRoomRedaction.html b/Matrix-0.0-MatrixEventRoomRedaction.html new file mode 100644 index 0000000..02fd59b --- /dev/null +++ b/Matrix-0.0-MatrixEventRoomRedaction.html @@ -0,0 +1,288 @@ + + + + +MatrixEventRoomRedaction: Matrix-0.0 Reference Manual + + + + + + + + + + + + + + + + +
+
+
+ + +
+

MatrixEventRoomRedaction

+

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

+
+
+

Functions

+
++++ + + + + + + + + + + + + + + + + + + + + + + + + + + +
#defineMATRIX_EVENT_TYPE_ROOM_REDACTION
+MatrixEventRoomRedaction * + +matrix_event_room_redaction_new () +
const gchar * + +matrix_event_room_redaction_get_reason () +
+void + +matrix_event_room_redaction_set_reason () +
const gchar * + +matrix_event_room_redaction_get_redacted_event_id () +
+void + +matrix_event_room_redaction_set_redacted_event_id () +
+
+
+

Types and Values

+
++++ + + + + + + + + + + +
structMatrixEventRoomRedaction
structMatrixEventRoomRedactionClass
+
+
+

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

 
+
+
+
+
+
+
Generated by GTK-Doc V1.24
+ + \ No newline at end of file diff --git a/Matrix-0.0-MatrixEventRoomThirdPartyInvite.html b/Matrix-0.0-MatrixEventRoomThirdPartyInvite.html new file mode 100644 index 0000000..01d96c8 --- /dev/null +++ b/Matrix-0.0-MatrixEventRoomThirdPartyInvite.html @@ -0,0 +1,675 @@ + + + + +MatrixEventRoomThirdPartyInvite: Matrix-0.0 Reference Manual + + + + + + + + + + + + + + + + +
+
+
+ + +
+

MatrixEventRoomThirdPartyInvite

+

MatrixEventRoomThirdPartyInvite — Class to hold a m.room.third_party_invite event

+
+
+

Functions

+
++++ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
#defineMATRIX_EVENT_TYPE_ROOM_THIRD_PARTY_INVITE
+MatrixEventRoomThirdPartyInvite * + +matrix_event_room_third_party_invite_new () +
const gchar * + +matrix_event_room_third_party_invite_get_display_name () +
+void + +matrix_event_room_third_party_invite_set_display_name () +
const gchar * + +matrix_event_room_third_party_invite_get_key_validity_url () +
+void + +matrix_event_room_third_party_invite_set_key_validity_url () +
const gchar * + +matrix_event_room_third_party_invite_get_public_key () +
+void + +matrix_event_room_third_party_invite_set_public_key () +
+MatrixEventRoomThirdPartyInvitePublicKey * + +matrix_event_room_third_party_invite_get_public_keys () +
+void + +matrix_event_room_third_party_invite_set_public_keys () +
const gchar * + +matrix_event_room_third_party_invite_get_token () +
+void + +matrix_event_room_third_party_invite_set_token () +
+MatrixEventRoomThirdPartyInvitePublicKey * + +matrix_event_room_third_party_invite_public_key_dup () +
+void + +matrix_event_room_third_party_invite_public_key_free () +
+void + +matrix_event_room_third_party_invite_public_key_copy () +
+void + +matrix_event_room_third_party_invite_public_key_destroy () +
+
+
+

Types and Values

+
++++ + + + + + + + + + + + + + + +
structMatrixEventRoomThirdPartyInvitePublicKey
structMatrixEventRoomThirdPartyInvite
structMatrixEventRoomThirdPartyInviteClass
+
+
+

Description

+

Acts as an m.room.member invite event, where there isn't a target user_id to invite. This event contains a token and a public key whose private key must be used to sign the token. Any user who can present that signature may use this invitation to join the target room.

+
+
+

Functions

+
+

MATRIX_EVENT_TYPE_ROOM_THIRD_PARTY_INVITE

+
#define MATRIX_EVENT_TYPE_ROOM_THIRD_PARTY_INVITE (matrix_event_room_third_party_invite_get_type ())
+
+

The type for MatrixEventRoomThirdPartyInvite.

+
+
+
+

matrix_event_room_third_party_invite_new ()

+
MatrixEventRoomThirdPartyInvite *
+matrix_event_room_third_party_invite_new
+                               (void);
+
+
+
+

matrix_event_room_third_party_invite_get_display_name ()

+
const gchar *
+matrix_event_room_third_party_invite_get_display_name
+                               (MatrixEventRoomThirdPartyInvite *self);
+

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

+

A user-readable string which represents the user who has been invited. This should not contain the user's third party ID, as otherwise when the invite is accepted it would leak the association between the matrix ID and the third party ID.

+
+

Parameters

+
+++++ + + + + + +

self

the MatrixEventRoomThirdPartyInvite instance to query

 
+
+
+

Returns

+

the value of the "display-name" property

+
+
+
+
+

matrix_event_room_third_party_invite_set_display_name ()

+
void
+matrix_event_room_third_party_invite_set_display_name
+                               (MatrixEventRoomThirdPartyInvite *self,
+                                const gchar *value);
+

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

+

A user-readable string which represents the user who has been invited. This should not contain the user's third party ID, as otherwise when the invite is accepted it would leak the association between the matrix ID and the third party ID.

+
+

Parameters

+
+++++ + + + + + + + + + + + + +

self

the MatrixEventRoomThirdPartyInvite instance to modify

 

value

the new value of the "display-name" property

 
+
+
+
+
+

matrix_event_room_third_party_invite_get_key_validity_url ()

+
const gchar *
+matrix_event_room_third_party_invite_get_key_validity_url
+                               (MatrixEventRoomThirdPartyInvite *self);
+

Get and return the current value of the "key-validity-url" property.

+

A URL which can be fetched, with querystring public_key=public_key, to validate whether the key has been revoked. The URL must return a JSON object containing a boolean property named valid.

+
+

Parameters

+
+++++ + + + + + +

self

the MatrixEventRoomThirdPartyInvite instance to query

 
+
+
+

Returns

+

the value of the "key-validity-url" property

+
+
+
+
+

matrix_event_room_third_party_invite_set_key_validity_url ()

+
void
+matrix_event_room_third_party_invite_set_key_validity_url
+                               (MatrixEventRoomThirdPartyInvite *self,
+                                const gchar *value);
+

Set the value of the "key-validity-url" property to value +.

+

A URL which can be fetched, with querystring public_key=public_key, to validate whether the key has been revoked. The URL must return a JSON object containing a boolean property named valid.

+
+

Parameters

+
+++++ + + + + + + + + + + + + +

self

the MatrixEventRoomThirdPartyInvite instance to modify

 

value

the new value of the "key-validity-url" property

 
+
+
+
+
+

matrix_event_room_third_party_invite_get_public_key ()

+
const gchar *
+matrix_event_room_third_party_invite_get_public_key
+                               (MatrixEventRoomThirdPartyInvite *self);
+

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

+

A base64-encoded ed25519 key with which token must be signed (though a signature from any entry in public_keys is also sufficient). This exists for backwards compatibility.

+
+

Parameters

+
+++++ + + + + + +

self

the MatrixEventRoomThirdPartyInvite instance to query

 
+
+
+

Returns

+

the value of the "public-key" property

+
+
+
+
+

matrix_event_room_third_party_invite_set_public_key ()

+
void
+matrix_event_room_third_party_invite_set_public_key
+                               (MatrixEventRoomThirdPartyInvite *self,
+                                const gchar *value);
+

Set the value of the "public-key" property to value +.

+

A base64-encoded ed25519 key with which token must be signed (though a signature from any entry in public_keys is also sufficient). This exists for backwards compatibility.

+
+

Parameters

+
+++++ + + + + + + + + + + + + +

self

the MatrixEventRoomThirdPartyInvite instance to modify

 

value

the new value of the "public-key" property

 
+
+
+
+
+

matrix_event_room_third_party_invite_get_public_keys ()

+
MatrixEventRoomThirdPartyInvitePublicKey *
+matrix_event_room_third_party_invite_get_public_keys
+                               (MatrixEventRoomThirdPartyInvite *self,
+                                int *result_length1);
+

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

+

Keys with which the token may be signed.

+
+

Parameters

+
+++++ + + + + + +

self

the MatrixEventRoomThirdPartyInvite instance to query

 
+
+
+

Returns

+

the value of the "public-keys" property

+
+
+
+
+

matrix_event_room_third_party_invite_set_public_keys ()

+
void
+matrix_event_room_third_party_invite_set_public_keys
+                               (MatrixEventRoomThirdPartyInvite *self,
+                                MatrixEventRoomThirdPartyInvitePublicKey *value,
+                                int value_length1);
+

Set the value of the "public-keys" property to value +.

+

Keys with which the token may be signed.

+
+

Parameters

+
+++++ + + + + + + + + + + + + +

self

the MatrixEventRoomThirdPartyInvite instance to modify

 

value

the new value of the "public-keys" property

 
+
+
+
+
+

matrix_event_room_third_party_invite_get_token ()

+
const gchar *
+matrix_event_room_third_party_invite_get_token
+                               (MatrixEventRoomThirdPartyInvite *self);
+

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

+

The token, of which a signature must be produced in order to join the room.

+
+

Parameters

+
+++++ + + + + + +

self

the MatrixEventRoomThirdPartyInvite instance to query

 
+
+
+

Returns

+

the value of the "token" property

+
+
+
+
+

matrix_event_room_third_party_invite_set_token ()

+
void
+matrix_event_room_third_party_invite_set_token
+                               (MatrixEventRoomThirdPartyInvite *self,
+                                const gchar *value);
+

Set the value of the "token" property to value +.

+

The token, of which a signature must be produced in order to join the room.

+
+

Parameters

+
+++++ + + + + + + + + + + + + +

self

the MatrixEventRoomThirdPartyInvite instance to modify

 

value

the new value of the "token" property

 
+
+
+
+
+

matrix_event_room_third_party_invite_public_key_dup ()

+
MatrixEventRoomThirdPartyInvitePublicKey *
+matrix_event_room_third_party_invite_public_key_dup
+                               (const MatrixEventRoomThirdPartyInvitePublicKey *self);
+

Creates a copy of self.

+

See also: matrix_event_room_third_party_invite_public_key_copy(), matrix_event_room_third_party_invite_public_key_destroy(), matrix_event_room_third_party_invite_public_key_free()

+
+

Parameters

+
+++++ + + + + + +

self

the instance to duplicate

 
+
+
+

Returns

+

a copy of self +, free with matrix_event_room_third_party_invite_public_key_free()

+
+
+
+
+

matrix_event_room_third_party_invite_public_key_free ()

+
void
+matrix_event_room_third_party_invite_public_key_free
+                               (MatrixEventRoomThirdPartyInvitePublicKey *self);
+

Frees the heap-allocated struct.

+

See also: matrix_event_room_third_party_invite_public_key_dup(), matrix_event_room_third_party_invite_public_key_copy(), matrix_event_room_third_party_invite_public_key_destroy()

+
+

Parameters

+
+++++ + + + + + +

self

the struct to free

 
+
+
+
+
+

matrix_event_room_third_party_invite_public_key_copy ()

+
void
+matrix_event_room_third_party_invite_public_key_copy
+                               (const MatrixEventRoomThirdPartyInvitePublicKey *self,
+                                MatrixEventRoomThirdPartyInvitePublicKey *dest);
+

Creates a copy of self.

+

See also: matrix_event_room_third_party_invite_public_key_dup(), matrix_event_room_third_party_invite_public_key_destroy(), matrix_event_room_third_party_invite_public_key_free()

+
+

Parameters

+
+++++ + + + + + + + + + + + + +

self

the struct to copy

 

dest

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

 
+
+
+
+
+

matrix_event_room_third_party_invite_public_key_destroy ()

+
void
+matrix_event_room_third_party_invite_public_key_destroy
+                               (MatrixEventRoomThirdPartyInvitePublicKey *self);
+

Frees the content of the struct pointed by self +.

+

See also: matrix_event_room_third_party_invite_public_key_dup(), matrix_event_room_third_party_invite_public_key_copy(), matrix_event_room_third_party_invite_public_key_free()

+
+

Parameters

+
+++++ + + + + + +

self

the struct to destroy

 
+
+
+
+
+

Types and Values

+
+

struct MatrixEventRoomThirdPartyInvitePublicKey

+
struct MatrixEventRoomThirdPartyInvitePublicKey {
+	gchar* key;
+	gchar* validity_url;
+};
+
+
+
+
+

struct MatrixEventRoomThirdPartyInvite

+
struct MatrixEventRoomThirdPartyInvite {
+	MatrixEventState parent_instance;
+	MatrixEventRoomThirdPartyInvitePrivate * priv;
+};
+
+

Class to hold a m.room.third_party_invite event

+

Acts as an m.room.member invite event, where there isn't a target user_id to invite. This event contains a token and a public key whose private key must be used to sign the token. Any user who can present that signature may use this invitation to join the target room.

+
+
+
+

struct MatrixEventRoomThirdPartyInviteClass

+
struct MatrixEventRoomThirdPartyInviteClass {
+	MatrixEventStateClass parent_class;
+};
+
+

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

+
+

Members

+
+++++ + + + + + +

MatrixEventStateClass parent_class;

the parent class structure

 
+
+
+
+
+
+
Generated by GTK-Doc V1.24
+ + \ No newline at end of file diff --git a/Matrix-0.0-MatrixEventRoomTopic.html b/Matrix-0.0-MatrixEventRoomTopic.html new file mode 100644 index 0000000..b28e5fb --- /dev/null +++ b/Matrix-0.0-MatrixEventRoomTopic.html @@ -0,0 +1,210 @@ + + + + +MatrixEventRoomTopic: Matrix-0.0 Reference Manual + + + + + + + + + + + + + + + + +
+
+
+ + +
+

MatrixEventRoomTopic

+

MatrixEventRoomTopic — Event type to hold the m.room.topic event.

+
+
+

Functions

+
++++ + + + + + + + + + + + + + + + + + + +
#defineMATRIX_EVENT_TYPE_ROOM_TOPIC
+MatrixEventRoomTopic * + +matrix_event_room_topic_new () +
const gchar * + +matrix_event_room_topic_get_topic () +
+void + +matrix_event_room_topic_set_topic () +
+
+
+

Types and Values

+
++++ + + + + + + + + + + +
structMatrixEventRoomTopic
structMatrixEventRoomTopicClass
+
+
+

Description

+

A topic is a short message detailing what is currently being discussed in the room. It can also be used as a way to display extra information about the room, which may not be suitable for the room name.

+
+
+

Functions

+
+

MATRIX_EVENT_TYPE_ROOM_TOPIC

+
#define MATRIX_EVENT_TYPE_ROOM_TOPIC (matrix_event_room_topic_get_type ())
+
+

The type for MatrixEventRoomTopic.

+
+
+
+

matrix_event_room_topic_new ()

+
MatrixEventRoomTopic *
+matrix_event_room_topic_new (void);
+
+
+
+

matrix_event_room_topic_get_topic ()

+
const gchar *
+matrix_event_room_topic_get_topic (MatrixEventRoomTopic *self);
+

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

+

The topic text.

+
+

Parameters

+
+++++ + + + + + +

self

the MatrixEventRoomTopic instance to query

 
+
+
+

Returns

+

the value of the "topic" property

+
+
+
+
+

matrix_event_room_topic_set_topic ()

+
void
+matrix_event_room_topic_set_topic (MatrixEventRoomTopic *self,
+                                   const gchar *value);
+

Set the value of the "topic" property to value +.

+

The topic text.

+
+

Parameters

+
+++++ + + + + + + + + + + + + +

self

the MatrixEventRoomTopic instance to modify

 

value

the new value of the "topic" property

 
+
+
+
+
+

Types and Values

+
+

struct MatrixEventRoomTopic

+
struct MatrixEventRoomTopic {
+	MatrixEventState parent_instance;
+	MatrixEventRoomTopicPrivate * priv;
+};
+
+

Event type to hold the m.room.topic event.

+

A topic is a short message detailing what is currently being discussed in the room. It can also be used as a way to display extra information about the room, which may not be suitable for the room name.

+
+
+
+

struct MatrixEventRoomTopicClass

+
struct MatrixEventRoomTopicClass {
+	MatrixEventStateClass parent_class;
+};
+
+

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

+
+

Members

+
+++++ + + + + + +

MatrixEventStateClass parent_class;

the parent class structure

 
+
+
+
+
+
+
Generated by GTK-Doc V1.24
+ + \ No newline at end of file diff --git a/Matrix-0.0-MatrixEventState.html b/Matrix-0.0-MatrixEventState.html new file mode 100644 index 0000000..1edb961 --- /dev/null +++ b/Matrix-0.0-MatrixEventState.html @@ -0,0 +1,299 @@ + + + + +MatrixEventState: Matrix-0.0 Reference Manual + + + + + + + + + + + + + + + + +
+
+
+ + +
+

MatrixEventState

+

MatrixEventState

+
+
+

Functions

+
++++ + + + + + + + + + + + + + + + + + + + + + + + + + + +
#defineMATRIX_EVENT_TYPE_STATE
+JsonNode * + +matrix_event_state_get_stripped_node () +
const gchar * + +matrix_event_state_get_state_key () +
+void + +matrix_event_state_set_state_key () +
+JsonNode * + +matrix_event_state_get_prev_content () +
+void + +matrix_event_state_set_prev_content () +
+
+
+

Types and Values

+
++++ + + + + + + + + + + +
structMatrixEventState
structMatrixEventStateClass
+
+
+

Description

+
+
+

Functions

+
+

MATRIX_EVENT_TYPE_STATE

+
#define MATRIX_EVENT_TYPE_STATE (matrix_event_state_get_type ())
+
+

The type for MatrixEventState.

+
+
+
+

matrix_event_state_get_stripped_node ()

+
JsonNode *
+matrix_event_state_get_stripped_node (MatrixEventState *self);
+

Get a stripped state event.

+
+

Parameters

+
+++++ + + + + + +

self

the MatrixEventState instance

 
+
+
+

Returns

+

`null` if the event is not allowed to be stripped, or the full JSON node otherwise

+
+
+
+
+

matrix_event_state_get_state_key ()

+
const gchar *
+matrix_event_state_get_state_key (MatrixEventState *self);
+

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

+
+

Parameters

+
+++++ + + + + + +

self

the MatrixEventState instance to query

 
+
+
+

Returns

+

the value of the "state-key" property

+
+
+
+
+

matrix_event_state_set_state_key ()

+
void
+matrix_event_state_set_state_key (MatrixEventState *self,
+                                  const gchar *value);
+

Set the value of the "state-key" property to value +.

+
+

Parameters

+
+++++ + + + + + + + + + + + + +

self

the MatrixEventState instance to modify

 

value

the new value of the "state-key" property

 
+
+
+
+
+

matrix_event_state_get_prev_content ()

+
JsonNode *
+matrix_event_state_get_prev_content (MatrixEventState *self);
+

Get and return the current value of the "prev-content" property.

+
+

Parameters

+
+++++ + + + + + +

self

the MatrixEventState instance to query

 
+
+
+

Returns

+

the value of the "prev-content" property

+
+
+
+
+

matrix_event_state_set_prev_content ()

+
void
+matrix_event_state_set_prev_content (MatrixEventState *self,
+                                     JsonNode *value);
+

Set the value of the "prev-content" property to value +.

+
+

Parameters

+
+++++ + + + + + + + + + + + + +

self

the MatrixEventState instance to modify

 

value

the new value of the "prev-content" property

 
+
+
+
+
+

Types and Values

+
+

struct MatrixEventState

+
struct MatrixEventState {
+	MatrixEventRoom parent_instance;
+	MatrixEventStatePrivate * priv;
+	gchar* _state_key;
+};
+
+
+
+
+

struct MatrixEventStateClass

+
struct MatrixEventStateClass {
+	MatrixEventRoomClass parent_class;
+};
+
+

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

+
+

Members

+
+++++ + + + + + +

MatrixEventRoomClass parent_class;

the parent class structure

 
+
+
+
+
+
+
Generated by GTK-Doc V1.24
+ + \ No newline at end of file diff --git a/Matrix-0.0-MatrixEventTag.html b/Matrix-0.0-MatrixEventTag.html new file mode 100644 index 0000000..923f62e --- /dev/null +++ b/Matrix-0.0-MatrixEventTag.html @@ -0,0 +1,133 @@ + + + + +MatrixEventTag: Matrix-0.0 Reference Manual + + + + + + + + + + + + + + + + +
+
+
+ + +
+

MatrixEventTag

+

MatrixEventTag

+
+
+

Functions

+
++++ + + + + + + + + + + +
#defineMATRIX_EVENT_TYPE_TAG
+MatrixEventTag * + +matrix_event_tag_new () +
+
+
+

Types and Values

+
++++ + + + + + + + + + + +
structMatrixEventTag
structMatrixEventTagClass
+
+
+

Description

+
+
+

Functions

+
+

MATRIX_EVENT_TYPE_TAG

+
#define MATRIX_EVENT_TYPE_TAG (matrix_event_tag_get_type ())
+
+

The type for MatrixEventTag.

+
+
+
+

matrix_event_tag_new ()

+
MatrixEventTag *
+matrix_event_tag_new (void);
+
+
+
+

Types and Values

+
+

struct MatrixEventTag

+
struct MatrixEventTag {
+	MatrixEventBase parent_instance;
+	MatrixEventTagPrivate * priv;
+};
+
+
+
+
+

struct MatrixEventTagClass

+
struct MatrixEventTagClass {
+	MatrixEventBaseClass parent_class;
+};
+
+

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

+
+

Members

+
+++++ + + + + + +

MatrixEventBaseClass parent_class;

the parent class structure

 
+
+
+
+
+
+
Generated by GTK-Doc V1.24
+ + \ No newline at end of file diff --git a/Matrix-0.0-MatrixEventTyping.html b/Matrix-0.0-MatrixEventTyping.html new file mode 100644 index 0000000..2bff14d --- /dev/null +++ b/Matrix-0.0-MatrixEventTyping.html @@ -0,0 +1,287 @@ + + + + +MatrixEventTyping: Matrix-0.0 Reference Manual + + + + + + + + + + + + + + + + +
+
+
+ + +
+

MatrixEventTyping

+

MatrixEventTyping — Class to hold an m.typing event.

+
+
+

Functions

+
++++ + + + + + + + + + + + + + + + + + + + + + + + + + + +
#defineMATRIX_EVENT_TYPE_TYPING
+MatrixEventTyping * + +matrix_event_typing_new () +
const gchar * + +matrix_event_typing_get_room_id () +
+void + +matrix_event_typing_set_room_id () +
+gchar ** + +matrix_event_typing_get_user_ids () +
+void + +matrix_event_typing_set_user_ids () +
+
+
+

Types and Values

+
++++ + + + + + + + + + + +
structMatrixEventTyping
structMatrixEventTypingClass
+
+
+

Description

+

Informs the client of the list of users currently typing.

+
+
+

Functions

+
+

MATRIX_EVENT_TYPE_TYPING

+
#define MATRIX_EVENT_TYPE_TYPING (matrix_event_typing_get_type ())
+
+

The type for MatrixEventTyping.

+
+
+
+

matrix_event_typing_new ()

+
MatrixEventTyping *
+matrix_event_typing_new (void);
+
+
+
+

matrix_event_typing_get_room_id ()

+
const gchar *
+matrix_event_typing_get_room_id (MatrixEventTyping *self);
+

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

+

The ID of the room this event belongs to.

+
+

Parameters

+
+++++ + + + + + +

self

the MatrixEventTyping instance to query

 
+
+
+

Returns

+

the value of the "room-id" property

+
+
+
+
+

matrix_event_typing_set_room_id ()

+
void
+matrix_event_typing_set_room_id (MatrixEventTyping *self,
+                                 const gchar *value);
+

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

+

The ID of the room this event belongs to.

+
+

Parameters

+
+++++ + + + + + + + + + + + + +

self

the MatrixEventTyping instance to modify

 

value

the new value of the "room-id" property

 
+
+
+
+
+

matrix_event_typing_get_user_ids ()

+
gchar **
+matrix_event_typing_get_user_ids (MatrixEventTyping *self,
+                                  int *result_length1);
+

Get and return the current value of the "user-ids" property.

+

The list of user IDs typing in this room, if any.

+
+

Parameters

+
+++++ + + + + + +

self

the MatrixEventTyping instance to query

 
+
+
+

Returns

+

the value of the "user-ids" property

+
+
+
+
+

matrix_event_typing_set_user_ids ()

+
void
+matrix_event_typing_set_user_ids (MatrixEventTyping *self,
+                                  gchar **value,
+                                  int value_length1);
+

Set the value of the "user-ids" property to value +.

+

The list of user IDs typing in this room, if any.

+
+

Parameters

+
+++++ + + + + + + + + + + + + +

self

the MatrixEventTyping instance to modify

 

value

the new value of the "user-ids" property

 
+
+
+
+
+

Types and Values

+
+

struct MatrixEventTyping

+
struct MatrixEventTyping {
+	MatrixEventBase parent_instance;
+	MatrixEventTypingPrivate * priv;
+};
+
+

Class to hold an m.typing event.

+

Informs the client of the list of users currently typing.

+
+
+
+

struct MatrixEventTypingClass

+
struct MatrixEventTypingClass {
+	MatrixEventBaseClass parent_class;
+};
+
+

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

+
+

Members

+
+++++ + + + + + +

MatrixEventBaseClass parent_class;

the parent class structure

 
+
+
+
+
+
+
Generated by GTK-Doc V1.24
+ + \ No newline at end of file diff --git a/Matrix-0.0-MatrixHTTPAPI.html b/Matrix-0.0-MatrixHTTPAPI.html index 9d56af0..aec3115 100644 --- a/Matrix-0.0-MatrixHTTPAPI.html +++ b/Matrix-0.0-MatrixHTTPAPI.html @@ -2,26 +2,25 @@ -Matrix-0.0 Reference Manual: MatrixHTTPAPI +MatrixHTTPAPI: Matrix-0.0 Reference Manual - - - + + + - + - - + +
@@ -53,7 +52,7 @@ -const gchar * +const gchar * matrix_http_api_get_base_url () @@ -69,7 +68,7 @@ -gboolean +gboolean matrix_http_api_get_validate_certificate () @@ -106,11 +105,6 @@
-

Object Hierarchy

-
-
-
-

Description

@@ -125,10 +119,10 @@

matrix_http_api_new ()

MatrixHTTPAPI *
-matrix_http_api_new (const gchar *base_url,
-                     const gchar *token);
+matrix_http_api_new (const gchar *base_url, + const gchar *token);
-

Parameters

+

Parameters

@@ -153,11 +147,11 @@ matrix_http_api_new (const

matrix_http_api_get_base_url ()

-
const gchar *
+
const gchar *
 matrix_http_api_get_base_url (MatrixHTTPAPI *self);

 
Get and return the current value of the "base-url" property.

 

-
Parameters

+
Parameters
@@ -172,9 +166,8 @@ matrix_http_api_get_base_url ( -

Returns

+

Returns

the value of the "base-url" property

-

@@ -182,11 +175,11 @@ matrix_http_api_get_base_url (

matrix_http_api_set_base_url ()

void
 matrix_http_api_set_base_url (MatrixHTTPAPI *self,
-                              const gchar *value);
+ const gchar *value);

Set the value of the "base-url" property to value .

-

Parameters

+

Parameters

@@ -211,12 +204,12 @@ matrix_http_api_set_base_url (

matrix_http_api_get_validate_certificate ()

-
gboolean
+
gboolean
 matrix_http_api_get_validate_certificate
                                (MatrixHTTPAPI *self);

 
Get and return the current value of the "validate-certificate" property.

 

-
Parameters

+
Parameters
@@ -231,9 +224,8 @@ matrix_http_api_get_validate_certificate
-

Returns

+

Returns

the value of the "validate-certificate" property

-

@@ -242,11 +234,11 @@ matrix_http_api_get_validate_certificate 
void
 matrix_http_api_set_validate_certificate
                                (MatrixHTTPAPI *self,
-                                gboolean value);
+ gboolean value);

Set the value of the "validate-certificate" property to value .

-

Parameters

+

Parameters

@@ -289,7 +281,7 @@ matrix_http_api_set_validate_certificate

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

-

Members

+

Members

@@ -297,7 +289,7 @@ matrix_http_api_set_validate_certificate - + @@ -307,7 +299,6 @@ matrix_http_api_set_validate_certificate
-
- Generated by GTK-Doc V1.20
+
Generated by GTK-Doc V1.24 \ No newline at end of file diff --git a/Matrix-0.0-MatrixHTTPClient.html b/Matrix-0.0-MatrixHTTPClient.html index 4698365..b97624a 100644 --- a/Matrix-0.0-MatrixHTTPClient.html +++ b/Matrix-0.0-MatrixHTTPClient.html @@ -2,26 +2,25 @@ -Matrix-0.0 Reference Manual: MatrixHTTPClient +MatrixHTTPClient: Matrix-0.0 Reference Manual - - - + + + -

GObjectClass parent_class;

GObjectClass parent_class;

the parent class structure

  
+ - - + +
@@ -75,11 +74,6 @@
-

Object Hierarchy

-
-
-
-

Description

@@ -94,9 +88,9 @@

matrix_http_client_new ()

MatrixHTTPClient *
-matrix_http_client_new (const gchar *base_url);
+matrix_http_client_new (const gchar *base_url);
-

Parameters

+

Parameters

@@ -132,7 +126,7 @@ matrix_http_client_new (const MATRIX_TYPE_HTTP_CLIENT. All the fields in this structure are private and should never be accessed directly.

-

Members

+

Members

@@ -150,7 +144,6 @@ matrix_http_client_new (const -
- Generated by GTK-Doc V1.20 +
Generated by GTK-Doc V1.24 \ No newline at end of file diff --git a/Matrix-0.0-MatrixJsonCompact.html b/Matrix-0.0-MatrixJsonCompact.html index 3bba291..5b9e017 100644 --- a/Matrix-0.0-MatrixJsonCompact.html +++ b/Matrix-0.0-MatrixJsonCompact.html @@ -2,26 +2,25 @@ -Matrix-0.0 Reference Manual: MatrixJsonCompact +MatrixJsonCompact: Matrix-0.0 Reference Manual - - - + + + -
+ - - + +
@@ -54,7 +53,7 @@ -gchar * +gchar * matrix_json_compact_get_json_data () @@ -62,7 +61,7 @@ -gpointer +gpointer matrix_json_compact_ref () @@ -78,7 +77,7 @@ -GParamSpec * +GParamSpec * matrix_param_spec_json_compact () @@ -94,7 +93,7 @@ -gpointer +gpointer matrix_value_get_json_compact () @@ -122,7 +121,7 @@ -GList * +gchar ** matrix_filter_get_event_fields () @@ -138,7 +137,7 @@ -MatrixEventFormat +MatrixEventFormat matrix_filter_get_event_format () @@ -198,7 +197,7 @@ -gboolean +gboolean matrix_room_filter_get_include_leave () @@ -274,7 +273,7 @@ -guint +guint matrix_filter_rules_get_limit () @@ -290,7 +289,7 @@ -GList * +gchar ** matrix_filter_rules_get_types () @@ -306,7 +305,7 @@ -GList * +gchar ** matrix_filter_rules_get_excluded_types () @@ -322,7 +321,7 @@ -GList * +gchar ** matrix_filter_rules_get_senders () @@ -338,7 +337,7 @@ -GList * +gchar ** matrix_filter_rules_get_excluded_senders () @@ -354,7 +353,7 @@ -GList * +gchar ** matrix_filter_rules_get_rooms () @@ -370,7 +369,7 @@ -GList * +gchar ** matrix_filter_rules_get_excluded_rooms () @@ -397,7 +396,7 @@ -const gchar * +const gchar * matrix_3pid_credential_get_id_server () @@ -412,7 +411,7 @@ -const gchar * +const gchar * matrix_3pid_credential_get_session_id () @@ -427,7 +426,7 @@ -const gchar * +const gchar * matrix_3pid_credential_get_client_secret () @@ -454,7 +453,7 @@ -const gchar * +const gchar * matrix_pusher_get_device_display_name () @@ -469,7 +468,7 @@ -const gchar * +const gchar * matrix_pusher_get_app_display_name () @@ -484,7 +483,7 @@ -const gchar * +const gchar * matrix_pusher_get_app_id () @@ -500,7 +499,7 @@ -gboolean +gboolean matrix_pusher_get_append () @@ -515,7 +514,7 @@ -const gchar * +const gchar * matrix_pusher_get_kind () @@ -530,7 +529,7 @@ -const gchar * +const gchar * matrix_pusher_get_lang () @@ -545,7 +544,7 @@ -const gchar * +const gchar * matrix_pusher_get_profile_tag () @@ -560,7 +559,7 @@ -const gchar * +const gchar * matrix_pusher_get_pushkey () @@ -592,72 +591,6 @@ #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 @@ -670,7 +603,7 @@ -gint * +gint matrix_event_context_get_before_limit () @@ -686,7 +619,7 @@ -gint * +gint matrix_event_context_get_after_limit () @@ -702,7 +635,7 @@ -gboolean * +gboolean matrix_event_context_get_include_profile () @@ -730,7 +663,7 @@ -MatrixSearchGroupBy * +MatrixSearchGroupBy matrix_search_grouping_get_key () @@ -758,7 +691,7 @@ -GList * +MatrixSearchGrouping ** matrix_search_groupings_get_group_by () @@ -786,7 +719,7 @@ -MatrixSearchOrder * +MatrixSearchOrder matrix_search_room_events_get_order_by () @@ -802,7 +735,7 @@ -GList * +MatrixSearchKey * matrix_search_room_events_get_keys () @@ -834,7 +767,7 @@ -gboolean * +gboolean matrix_search_room_events_get_include_state () @@ -849,7 +782,7 @@ -const gchar * +const gchar * matrix_search_room_events_get_filter_id () @@ -880,7 +813,7 @@ -const gchar * +const gchar * matrix_search_room_events_get_search_term () @@ -999,14 +932,6 @@ struct -MatrixUnsignedEventData - - -struct -MatrixUnsignedEventDataClass - - -struct MatrixEventContext @@ -1049,11 +974,6 @@
-

Object Hierarchy

-
-
-
-

Description

@@ -1069,9 +989,9 @@

matrix_json_compact_get_json_node ()

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

Parameters

+

Parameters

@@ -1086,7 +1006,7 @@ matrix_json_compact_get_json_node ( - + @@ -1096,12 +1016,12 @@ matrix_json_compact_get_json_node (

matrix_json_compact_get_json_data ()

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

+                                   GError **error);
-

Parameters

+

Parameters

error

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

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

[error-domains MatrixError]
@@ -1121,7 +1041,7 @@ matrix_json_compact_get_json_data ( - + @@ -1131,12 +1051,12 @@ matrix_json_compact_get_json_data (

matrix_json_compact_ref ()

-
gpointer
-matrix_json_compact_ref (gpointer instance);
+
gpointer
+matrix_json_compact_ref (gpointer instance);

Increases the reference count of object .

-

Parameters

+

Parameters

error

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

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

[error-domains MatrixError]
@@ -1151,21 +1071,20 @@ matrix_json_compact_ref ( -

Returns

+

Returns

the same object

-

matrix_json_compact_unref ()

void
-matrix_json_compact_unref (gpointer instance);
+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

+

Parameters

@@ -1183,16 +1102,16 @@ matrix_json_compact_unref (

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.

+
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

+

Parameters

@@ -1234,15 +1153,15 @@ matrix_param_spec_json_compact (const

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 (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).

+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

+

Parameters

@@ -1252,7 +1171,7 @@ matrix_value_set_json_compact (

value

- + @@ -1267,11 +1186,11 @@ matrix_value_set_json_compact (

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.

+
gpointer
+matrix_value_get_json_compact (const GValue *value);
+

Get the contents of a MATRIX_TYPE_JSON_COMPACT derived GValue.

-

Parameters

+

Parameters

a valid GValue of MATRIX_TYPE_JSON_COMPACT derived type

a valid GValue of MATRIX_TYPE_JSON_COMPACT derived type

  
@@ -1280,31 +1199,30 @@ matrix_value_get_json_compact (const

value

- +

a valid GValue of MATRIX_TYPE_JSON_COMPACT derived type

a valid GValue of MATRIX_TYPE_JSON_COMPACT derived type

  
-

Returns

+

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 +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

+

Parameters

@@ -1314,7 +1232,7 @@ matrix_value_take_json_compact (

value

- + @@ -1342,12 +1260,13 @@ matrix_filter_new (void

matrix_filter_get_event_fields ()

-
GList *
-matrix_filter_get_event_fields (MatrixFilter *self);
+
gchar **
+matrix_filter_get_event_fields (MatrixFilter *self,
+                                int *result_length1);

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

The event fields to include in the filtered events.

-

Parameters

+

Parameters

a valid GValue of MATRIX_TYPE_JSON_COMPACT derived type

a valid GValue of MATRIX_TYPE_JSON_COMPACT derived type

  
@@ -1362,9 +1281,8 @@ matrix_filter_get_event_fields (
-

Returns

+

Returns

the value of the "event-fields" property

-

@@ -1372,12 +1290,13 @@ matrix_filter_get_event_fields (

matrix_filter_set_event_fields ()

void
 matrix_filter_set_event_fields (MatrixFilter *self,
-                                GList *value);
+ gchar **value, + int value_length1);

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

The event fields to include in the filtered events.

-

Parameters

+

Parameters

@@ -1402,12 +1321,12 @@ matrix_filter_set_event_fields (

matrix_filter_get_event_format ()

-
MatrixEventFormat
+
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

+
Parameters
@@ -1422,9 +1341,8 @@ matrix_filter_get_event_format (
-

Returns

+

Returns

the value of the "event-format" property

-

@@ -1432,12 +1350,12 @@ matrix_filter_get_event_format (

matrix_filter_set_event_format ()

void
 matrix_filter_set_event_format (MatrixFilter *self,
-                                MatrixEventFormat value);
+ 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

+

Parameters

@@ -1467,7 +1385,7 @@ matrix_filter_get_presence_filter (Get and return the current value of the "presence-filter" property.

A filtering ruleset for presence events.

-

Parameters

+

Parameters

@@ -1482,9 +1400,8 @@ matrix_filter_get_presence_filter (
-

Returns

+

Returns

the value of the "presence-filter" property

-

@@ -1497,7 +1414,7 @@ matrix_filter_set_presence_filter (

A filtering ruleset for presence events.

-

Parameters

+

Parameters

@@ -1527,7 +1444,7 @@ matrix_filter_get_room_filter (Get and return the current value of the "room-filter" property.

A filtering ruleset for room events.

-

Parameters

+

Parameters

@@ -1542,9 +1459,8 @@ matrix_filter_get_room_filter (
-

Returns

+

Returns

the value of the "room-filter" property

-

@@ -1557,7 +1473,7 @@ matrix_filter_set_room_filter (

A filtering ruleset for room events.

-

Parameters

+

Parameters

@@ -1595,17 +1511,25 @@ matrix_room_filter_new (void

matrix_room_filter_get_include_leave ()

-
gboolean
+
gboolean
 matrix_room_filter_get_include_leave (MatrixRoomFilter *self);

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

 
If 

-
-true
-

+

+
+ + + + + + + 
1
true
+
+

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

-

Parameters

+

Parameters

@@ -1620,9 +1544,8 @@ true
-

Returns

+

Returns

the value of the "include-leave" property

-

@@ -1630,17 +1553,25 @@ true

matrix_room_filter_set_include_leave ()

void
 matrix_room_filter_set_include_leave (MatrixRoomFilter *self,
-                                      gboolean value);
+ gboolean value);

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

If

-
-true
-
+
+ + + + + + + + 
1
true
+
+

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

-

Parameters

+

Parameters

@@ -1670,7 +1601,7 @@ matrix_room_filter_get_ephemeral (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

+

Parameters

@@ -1685,9 +1616,8 @@ matrix_room_filter_get_ephemeral (
-

Returns

+

Returns

the value of the "ephemeral" property

-

@@ -1700,7 +1630,7 @@ matrix_room_filter_set_ephemeral (

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

-

Parameters

+

Parameters

@@ -1730,7 +1660,7 @@ matrix_room_filter_get_state ("state" property.

Filtering rules for state events.

-

Parameters

+

Parameters

@@ -1745,9 +1675,8 @@ matrix_room_filter_get_state ( -

Returns

+

Returns

the value of the "state" property

-

@@ -1760,7 +1689,7 @@ matrix_room_filter_set_state ( -

Parameters

+

Parameters

@@ -1790,7 +1719,7 @@ matrix_room_filter_get_timeline (Get and return the current value of the "timeline" property.

Filtering rules for timeline events.

-

Parameters

+

Parameters

@@ -1805,9 +1734,8 @@ matrix_room_filter_get_timeline (
-

Returns

+

Returns

the value of the "timeline" property

-

@@ -1820,7 +1748,7 @@ matrix_room_filter_set_timeline (

Filtering rules for timeline events.

-

Parameters

+

Parameters

@@ -1858,12 +1786,12 @@ matrix_filter_rules_new (void

matrix_filter_rules_get_limit ()

-
guint
+
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

+
Parameters
@@ -1878,9 +1806,8 @@ matrix_filter_rules_get_limit (
-

Returns

+

Returns

the value of the "limit" property

-

@@ -1888,12 +1815,12 @@ matrix_filter_rules_get_limit (

matrix_filter_rules_set_limit ()

void
 matrix_filter_rules_set_limit (MatrixFilterRules *self,
-                               guint value);
+ guint value);

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

The limit of the count of returned events.

-

Parameters

+

Parameters

@@ -1918,12 +1845,13 @@ matrix_filter_rules_set_limit (

matrix_filter_rules_get_types ()

-
GList *
-matrix_filter_rules_get_types (MatrixFilterRules *self);
+
gchar **
+matrix_filter_rules_get_types (MatrixFilterRules *self,
+                               int *result_length1);

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

List of message types to include in the filtered result.

-

Parameters

+

Parameters

@@ -1938,9 +1866,8 @@ matrix_filter_rules_get_types (
-

Returns

+

Returns

the value of the "types" property

-

@@ -1948,12 +1875,13 @@ matrix_filter_rules_get_types (

matrix_filter_rules_set_types ()

void
 matrix_filter_rules_set_types (MatrixFilterRules *self,
-                               GList *value);
+ gchar **value, + int value_length1);

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

List of message types to include in the filtered result.

-

Parameters

+

Parameters

@@ -1978,13 +1906,14 @@ matrix_filter_rules_set_types (

matrix_filter_rules_get_excluded_types ()

-
GList *
+
gchar **
 matrix_filter_rules_get_excluded_types
-                               (MatrixFilterRules *self);

+                               (MatrixFilterRules *self,
+                                int *result_length1);

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

+

Parameters

@@ -1999,9 +1928,8 @@ matrix_filter_rules_get_excluded_types
-

Returns

+

Returns

the value of the "excluded-types" property

-

@@ -2010,12 +1938,13 @@ matrix_filter_rules_get_excluded_types 
void
 matrix_filter_rules_set_excluded_types
                                (MatrixFilterRules *self,
-                                GList *value);
+ gchar **value, + int value_length1);

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

+

Parameters

@@ -2040,12 +1969,13 @@ matrix_filter_rules_set_excluded_types

matrix_filter_rules_get_senders ()

-
GList *
-matrix_filter_rules_get_senders (MatrixFilterRules *self);
+
gchar **
+matrix_filter_rules_get_senders (MatrixFilterRules *self,
+                                 int *result_length1);

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

List of senders to include in the filtered results.

-

Parameters

+

Parameters

@@ -2060,9 +1990,8 @@ matrix_filter_rules_get_senders (
-

Returns

+

Returns

the value of the "senders" property

-

@@ -2070,12 +1999,13 @@ matrix_filter_rules_get_senders (

matrix_filter_rules_set_senders ()

void
 matrix_filter_rules_set_senders (MatrixFilterRules *self,
-                                 GList *value);
+ gchar **value, + int value_length1);

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

List of senders to include in the filtered results.

-

Parameters

+

Parameters

@@ -2100,13 +2030,14 @@ matrix_filter_rules_set_senders (

matrix_filter_rules_get_excluded_senders ()

-
GList *
+
gchar **
 matrix_filter_rules_get_excluded_senders
-                               (MatrixFilterRules *self);

+                               (MatrixFilterRules *self,
+                                int *result_length1);

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

+

Parameters

@@ -2121,9 +2052,8 @@ matrix_filter_rules_get_excluded_senders
-

Returns

+

Returns

the value of the "excluded-senders" property

-

@@ -2132,12 +2062,13 @@ matrix_filter_rules_get_excluded_senders 
void
 matrix_filter_rules_set_excluded_senders
                                (MatrixFilterRules *self,
-                                GList *value);
+ gchar **value, + int value_length1);

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

+

Parameters

@@ -2162,12 +2093,13 @@ matrix_filter_rules_set_excluded_senders

matrix_filter_rules_get_rooms ()

-
GList *
-matrix_filter_rules_get_rooms (MatrixFilterRules *self);
+
gchar **
+matrix_filter_rules_get_rooms (MatrixFilterRules *self,
+                               int *result_length1);

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

List of rooms to include in the filtered results.

-

Parameters

+

Parameters

@@ -2182,9 +2114,8 @@ matrix_filter_rules_get_rooms (
-

Returns

+

Returns

the value of the "rooms" property

-

@@ -2192,12 +2123,13 @@ matrix_filter_rules_get_rooms (

matrix_filter_rules_set_rooms ()

void
 matrix_filter_rules_set_rooms (MatrixFilterRules *self,
-                               GList *value);
+ gchar **value, + int value_length1);

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

List of rooms to include in the filtered results.

-

Parameters

+

Parameters

@@ -2222,13 +2154,14 @@ matrix_filter_rules_set_rooms (

matrix_filter_rules_get_excluded_rooms ()

-
GList *
+
gchar **
 matrix_filter_rules_get_excluded_rooms
-                               (MatrixFilterRules *self);

+                               (MatrixFilterRules *self,
+                                int *result_length1);

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

+

Parameters

@@ -2243,9 +2176,8 @@ matrix_filter_rules_get_excluded_rooms
-

Returns

+

Returns

the value of the "excluded-rooms" property

-

@@ -2254,12 +2186,13 @@ matrix_filter_rules_get_excluded_rooms 
void
 matrix_filter_rules_set_excluded_rooms
                                (MatrixFilterRules *self,
-                                GList *value);
+ gchar **value, + int value_length1);

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

+

Parameters

@@ -2297,12 +2230,12 @@ matrix_3pid_credential_new (void<

matrix_3pid_credential_get_id_server ()

-
const gchar *
+
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

+
Parameters
@@ -2317,9 +2250,8 @@ matrix_3pid_credential_get_id_server ( -

Returns

+

Returns

the value of the "id-server" property

-

@@ -2327,12 +2259,12 @@ matrix_3pid_credential_get_id_server (

matrix_3pid_credential_set_id_server ()

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

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

The Identity Server used for this credential.

-

Parameters

+

Parameters

@@ -2357,12 +2289,12 @@ matrix_3pid_credential_set_id_server (

matrix_3pid_credential_get_session_id ()

-
const gchar *
+
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

+
Parameters
@@ -2377,9 +2309,8 @@ matrix_3pid_credential_get_session_id ( -

Returns

+

Returns

the value of the "session-id" property

-

@@ -2387,12 +2318,12 @@ matrix_3pid_credential_get_session_id (

matrix_3pid_credential_set_session_id ()

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

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

The session identifier got from the Identity Server.

-

Parameters

+

Parameters

@@ -2417,13 +2348,13 @@ matrix_3pid_credential_set_session_id (

matrix_3pid_credential_get_client_secret ()

-
const gchar *
+
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

+
Parameters
@@ -2438,9 +2369,8 @@ matrix_3pid_credential_get_client_secret
-

Returns

+

Returns

the value of the "client-secret" property

-

@@ -2449,12 +2379,12 @@ matrix_3pid_credential_get_client_secret 
void
 matrix_3pid_credential_set_client_secret
                                (Matrix3PidCredential *self,
-                                const gchar *value);
+ 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

+

Parameters

@@ -2492,12 +2422,12 @@ matrix_pusher_new (void

matrix_pusher_get_device_display_name ()

-
const gchar *
+
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

+
Parameters
@@ -2512,9 +2442,8 @@ matrix_pusher_get_device_display_name ( -

Returns

+

Returns

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

-

@@ -2522,12 +2451,12 @@ matrix_pusher_get_device_display_name (

matrix_pusher_set_device_display_name ()

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

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

A device display name.

-

Parameters

+

Parameters

@@ -2552,12 +2481,12 @@ matrix_pusher_set_device_display_name (

matrix_pusher_get_app_display_name ()

-
const gchar *
+
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

+
Parameters
@@ -2572,9 +2501,8 @@ matrix_pusher_get_app_display_name (
-

Returns

+

Returns

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

-

@@ -2582,12 +2510,12 @@ matrix_pusher_get_app_display_name (

matrix_pusher_set_app_display_name ()

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

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

An application display name.

-

Parameters

+

Parameters

@@ -2612,12 +2540,12 @@ matrix_pusher_set_app_display_name (

matrix_pusher_get_app_id ()

-
const gchar *
+
const gchar *
 matrix_pusher_get_app_id (MatrixPusher *self);

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

 
An application ID.

 

-
Parameters

+
Parameters
@@ -2632,9 +2560,8 @@ matrix_pusher_get_app_id ( -

Returns

+

Returns

the value of the "app-id" property

-

@@ -2642,12 +2569,12 @@ matrix_pusher_get_app_id (

matrix_pusher_set_app_id ()

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

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

An application ID.

-

Parameters

+

Parameters

@@ -2672,17 +2599,25 @@ matrix_pusher_set_app_id (

matrix_pusher_get_append ()

-
gboolean
+
gboolean
 matrix_pusher_get_append (MatrixPusher *self);

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

 
If 

-
-true
-

+

+
+ + + + + + + 
1
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

+

Parameters

@@ -2697,9 +2632,8 @@ true
-

Returns

+

Returns

the value of the "append" property

-

@@ -2707,17 +2641,25 @@ true

matrix_pusher_set_append ()

void
 matrix_pusher_set_append (MatrixPusher *self,
-                          gboolean value);
+ gboolean value);

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

If

-
-true
-
+
+ + + + + + + + 
1
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

+

Parameters

@@ -2742,22 +2684,38 @@ true

matrix_pusher_get_kind ()

-
const gchar *
+
const gchar *
 matrix_pusher_get_kind (MatrixPusher *self);

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

 
The kind of the pusher. 

-
-http
-

+

+
+ + + + + + + 
1
http
+
+

makes a pusher that sends HTTP pokes.

-
-null
-
+
+ + + + + + + + 
1
null
+
+

deletes the pusher.

-

Parameters

+

Parameters

@@ -2772,9 +2730,8 @@ null
-

Returns

+

Returns

the value of the "kind" property

-

@@ -2782,22 +2739,38 @@ null

matrix_pusher_set_kind ()

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

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

The kind of the pusher.

-
-http
-
+
+ + + + + + + + 
1
http
+
+

makes a pusher that sends HTTP pokes.

-
-null
-
+
+ + + + + + + + 
1
null
+
+

deletes the pusher.

-

Parameters

+

Parameters

@@ -2822,22 +2795,38 @@ null

matrix_pusher_get_lang ()

-
const gchar *
+
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
-

+

+
+ + + + + + + 
1
en
+
+

or

-
-en-US
-
+
+ + + + + + + + 
1
en-US
+
+

.

-

Parameters

+

Parameters

@@ -2852,9 +2841,8 @@ en-US
-

Returns

+

Returns

the value of the "lang" property

-

@@ -2862,22 +2850,38 @@ en-US

matrix_pusher_set_lang ()

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

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

The preferred language for receiving notifications, e.g.

-
-en
-
+
+ + + + + + + + 
1
en
+
+

or

-
-en-US
-
+
+ + + + + + + + 
1
en-US
+
+

.

-

Parameters

+

Parameters

@@ -2902,12 +2906,12 @@ en-US

matrix_pusher_get_profile_tag ()

-
const gchar *
+
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

+
Parameters
@@ -2922,9 +2926,8 @@ matrix_pusher_get_profile_tag (
-

Returns

+

Returns

the value of the "profile-tag" property

-

@@ -2932,12 +2935,12 @@ matrix_pusher_get_profile_tag (

matrix_pusher_set_profile_tag ()

void
 matrix_pusher_set_profile_tag (MatrixPusher *self,
-                               const gchar *value);
+ 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

+

Parameters

@@ -2962,12 +2965,12 @@ matrix_pusher_set_profile_tag (

matrix_pusher_get_pushkey ()

-
const gchar *
+
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

+
Parameters
@@ -2982,9 +2985,8 @@ matrix_pusher_get_pushkey ( -

Returns

+

Returns

the value of the "pushkey" property

-

@@ -2992,12 +2994,12 @@ matrix_pusher_get_pushkey (

matrix_pusher_set_pushkey ()

void
 matrix_pusher_set_pushkey (MatrixPusher *self,
-                           const gchar *value);
+ 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

+

Parameters

@@ -3026,18 +3028,34 @@ matrix_pusher_set_pushkey (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
-
+
+
+ + + + + + + 
1
http
+
+

, this should contain an

-
-url
-
+
+ + + + + + + + 
1
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

+

Parameters

@@ -3052,9 +3070,8 @@ url
-

Returns

+

Returns

the value of the "data" property

-

@@ -3066,18 +3083,34 @@ matrix_pusher_set_data ("data" property to value .

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

-
-http
-
+
+ + + + + + + + 
1
http
+
+

, this should contain an

-
-url
-
+
+ + + + + + + + 
1
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

+

Parameters

@@ -3101,227 +3134,6 @@ url
-

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 ())
@@ -3336,11 +3148,11 @@ matrix_event_context_new (void

matrix_event_context_get_before_limit ()

-
gint *
+
gint
 matrix_event_context_get_before_limit (MatrixEventContext *self);

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

 

-
Parameters

+
Parameters

 
@@ -3355,9 +3167,8 @@ matrix_event_context_get_before_limit (
-
Returns

+
Returns

 
 the value of the "before-limit" property

-

 
 
 

@@ -3365,11 +3176,11 @@ matrix_event_context_get_before_limit (
matrix_event_context_set_before_limit ()

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

+                                       gint value);
 
Set the value of the "before-limit" property to value
 .

 

-
Parameters

+
Parameters

 

 
 

@@ -3394,11 +3205,11 @@ matrix_event_context_set_before_limit (
 
matrix_event_context_get_after_limit ()

-
gint *
+
gint
 matrix_event_context_get_after_limit (MatrixEventContext *self);

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

 

-
Parameters

+
Parameters

 

 
 

@@ -3413,9 +3224,8 @@ matrix_event_context_get_after_limit (
-
Returns

+
Returns

 
 the value of the "after-limit" property

-

 
 
 

@@ -3423,11 +3233,11 @@ matrix_event_context_get_after_limit (
matrix_event_context_set_after_limit ()

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

+                                      gint value);
 
Set the value of the "after-limit" property to value
 .

 

-
Parameters

+
Parameters

 

 
 

@@ -3452,12 +3262,12 @@ matrix_event_context_set_after_limit (
 
matrix_event_context_get_include_profile ()

-
gboolean *
+
gboolean
 matrix_event_context_get_include_profile
                                (MatrixEventContext *self);

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

 

-
Parameters

+
Parameters

 

 
 

@@ -3472,9 +3282,8 @@ matrix_event_context_get_include_profile
 

 
 


 

 

-
Returns

+
Returns

 
 the value of the "include-profile" property

-
@@ -3483,11 +3292,11 @@ matrix_event_context_get_include_profile 
void
 matrix_event_context_set_include_profile
                                (MatrixEventContext *self,
-                                gboolean *value);
+ gboolean value);

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

-

Parameters

+

Parameters

@@ -3525,11 +3334,11 @@ matrix_search_grouping_new (void<

matrix_search_grouping_get_key ()

-
MatrixSearchGroupBy *
+
MatrixSearchGroupBy
 matrix_search_grouping_get_key (MatrixSearchGrouping *self);

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

 

-
Parameters

+
Parameters
@@ -3544,9 +3353,8 @@ matrix_search_grouping_get_key (
-

Returns

+

Returns

the value of the "key" property

-

@@ -3554,11 +3362,11 @@ matrix_search_grouping_get_key (

matrix_search_grouping_set_key ()

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

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

-

Parameters

+

Parameters

@@ -3596,11 +3404,12 @@ matrix_search_groupings_new (void

matrix_search_groupings_get_group_by ()

-
GList *
-matrix_search_groupings_get_group_by (MatrixSearchGroupings *self);
+
MatrixSearchGrouping **
+matrix_search_groupings_get_group_by (MatrixSearchGroupings *self,
+                                      int *result_length1);

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

-

Parameters

+

Parameters

@@ -3615,9 +3424,8 @@ matrix_search_groupings_get_group_by ( -

Returns

+

Returns

the value of the "group-by" property

-

@@ -3625,11 +3433,12 @@ matrix_search_groupings_get_group_by (

matrix_search_groupings_set_group_by ()

void
 matrix_search_groupings_set_group_by (MatrixSearchGroupings *self,
-                                      GList *value);
+ MatrixSearchGrouping **value, + int value_length1);

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

-

Parameters

+

Parameters

@@ -3667,12 +3476,12 @@ matrix_search_room_events_new (vo

matrix_search_room_events_get_order_by ()

-
MatrixSearchOrder *
+
MatrixSearchOrder
 matrix_search_room_events_get_order_by
                                (MatrixSearchRoomEvents *self);

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

 

-
Parameters

+
Parameters
@@ -3687,9 +3496,8 @@ matrix_search_room_events_get_order_by
-

Returns

+

Returns

the value of the "order-by" property

-

@@ -3698,11 +3506,11 @@ matrix_search_room_events_get_order_by 
void
 matrix_search_room_events_set_order_by
                                (MatrixSearchRoomEvents *self,
-                                MatrixSearchOrder *value);
+ MatrixSearchOrder value);

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

-

Parameters

+

Parameters

@@ -3727,11 +3535,12 @@ matrix_search_room_events_set_order_by

matrix_search_room_events_get_keys ()

-
GList *
-matrix_search_room_events_get_keys (MatrixSearchRoomEvents *self);
+
MatrixSearchKey *
+matrix_search_room_events_get_keys (MatrixSearchRoomEvents *self,
+                                    int *result_length1);

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

-

Parameters

+

Parameters

@@ -3746,9 +3555,8 @@ matrix_search_room_events_get_keys (
-

Returns

+

Returns

the value of the "keys" property

-

@@ -3756,11 +3564,12 @@ matrix_search_room_events_get_keys (

matrix_search_room_events_set_keys ()

void
 matrix_search_room_events_set_keys (MatrixSearchRoomEvents *self,
-                                    GList *value);
+ MatrixSearchKey *value, + int value_length1);

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

-

Parameters

+

Parameters

@@ -3790,7 +3599,7 @@ matrix_search_room_events_get_event_context (MatrixSearchRoomEvents *self);

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

-

Parameters

+

Parameters

@@ -3805,9 +3614,8 @@ matrix_search_room_events_get_event_context
-

Returns

+

Returns

the value of the "event-context" property

-

@@ -3820,7 +3628,7 @@ matrix_search_room_events_set_event_context

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

-

Parameters

+

Parameters

@@ -3845,12 +3653,12 @@ matrix_search_room_events_set_event_context

matrix_search_room_events_get_include_state ()

-
gboolean *
+
gboolean
 matrix_search_room_events_get_include_state
                                (MatrixSearchRoomEvents *self);

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

 

-
Parameters

+
Parameters
@@ -3865,9 +3673,8 @@ matrix_search_room_events_get_include_state
-

Returns

+

Returns

the value of the "include-state" property

-

@@ -3876,11 +3683,11 @@ matrix_search_room_events_get_include_state 
void
 matrix_search_room_events_set_include_state
                                (MatrixSearchRoomEvents *self,
-                                gboolean *value);
+ gboolean value);

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

-

Parameters

+

Parameters

@@ -3905,12 +3712,12 @@ matrix_search_room_events_set_include_state

matrix_search_room_events_get_filter_id ()

-
const gchar *
+
const gchar *
 matrix_search_room_events_get_filter_id
                                (MatrixSearchRoomEvents *self);

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

 

-
Parameters

+
Parameters
@@ -3925,9 +3732,8 @@ matrix_search_room_events_get_filter_id
-

Returns

+

Returns

the value of the "filter-id" property

-

@@ -3936,11 +3742,11 @@ matrix_search_room_events_get_filter_id 
void
 matrix_search_room_events_set_filter_id
                                (MatrixSearchRoomEvents *self,
-                                const gchar *value);
+ const gchar *value);

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

-

Parameters

+

Parameters

@@ -3969,7 +3775,7 @@ matrix_search_room_events_set_filter_id matrix_search_room_events_get_filter (MatrixSearchRoomEvents *self);

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

-

Parameters

+

Parameters

@@ -3984,9 +3790,8 @@ matrix_search_room_events_get_filter ( -

Returns

+

Returns

the value of the "filter" property

-

@@ -3998,7 +3803,7 @@ matrix_search_room_events_set_filter ("filter" property to value .

-

Parameters

+

Parameters

@@ -4023,12 +3828,12 @@ matrix_search_room_events_set_filter (

matrix_search_room_events_get_search_term ()

-
const gchar *
+
const gchar *
 matrix_search_room_events_get_search_term
                                (MatrixSearchRoomEvents *self);

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

 

-
Parameters

+
Parameters
@@ -4043,9 +3848,8 @@ matrix_search_room_events_get_search_term
-

Returns

+

Returns

the value of the "search-term" property

-

@@ -4054,11 +3858,11 @@ matrix_search_room_events_get_search_term 
void
 matrix_search_room_events_set_search_term
                                (MatrixSearchRoomEvents *self,
-                                const gchar *value);
+ const gchar *value);

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

-

Parameters

+

Parameters

@@ -4088,7 +3892,7 @@ matrix_search_room_events_get_groupings (MatrixSearchRoomEvents *self);

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

-

Parameters

+

Parameters

@@ -4103,9 +3907,8 @@ matrix_search_room_events_get_groupings
-

Returns

+

Returns

the value of the "groupings" property

-

@@ -4118,7 +3921,7 @@ matrix_search_room_events_set_groupings

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

-

Parameters

+

Parameters

@@ -4161,7 +3964,7 @@ matrix_search_categories_get_room_events (MatrixSearchCategories *self);

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

-

Parameters

+

Parameters

@@ -4176,9 +3979,8 @@ matrix_search_categories_get_room_events
-

Returns

+

Returns

the value of the "room-events" property

-

@@ -4191,7 +3993,7 @@ matrix_search_categories_set_room_events

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

-

Parameters

+

Parameters

@@ -4237,7 +4039,7 @@ matrix_search_categories_set_room_events

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

-

Members

+

Members

@@ -4246,7 +4048,7 @@ matrix_search_categories_set_room_events - + @@ -4283,7 +4085,7 @@ matrix_search_categories_set_room_events

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

-

Members

+

Members

GTypeClass parent_class;

GTypeClass parent_class;

the parent class structure

  
@@ -4317,7 +4119,7 @@ matrix_search_categories_set_room_events

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

-

Members

+

Members

@@ -4351,7 +4153,7 @@ matrix_search_categories_set_room_events

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

-

Members

+

Members

@@ -4385,7 +4187,7 @@ matrix_search_categories_set_room_events

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

-

Members

+

Members

@@ -4419,7 +4221,7 @@ matrix_search_categories_set_room_events

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

-

Members

+

Members

@@ -4436,40 +4238,6 @@ matrix_search_categories_set_room_events
-

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;
@@ -4486,7 +4254,7 @@ matrix_search_categories_set_room_events

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

-

Members

+

Members

@@ -4519,7 +4287,7 @@ matrix_search_categories_set_room_events

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

-

Members

+

Members

@@ -4552,7 +4320,7 @@ matrix_search_categories_set_room_events

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

-

Members

+

Members

@@ -4585,7 +4353,7 @@ matrix_search_categories_set_room_events

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

-

Members

+

Members

@@ -4618,7 +4386,7 @@ matrix_search_categories_set_room_events

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

-

Members

+

Members

@@ -4636,7 +4404,6 @@ matrix_search_categories_set_room_events
-
- Generated by GTK-Doc V1.20
+
Generated by GTK-Doc V1.24 \ No newline at end of file diff --git a/Matrix-0.0-MatrixMessageAudio.html b/Matrix-0.0-MatrixMessageAudio.html new file mode 100644 index 0000000..cb525bb --- /dev/null +++ b/Matrix-0.0-MatrixMessageAudio.html @@ -0,0 +1,285 @@ + + + + +MatrixMessageAudio: Matrix-0.0 Reference Manual + + + + + + + + + +
+ + + + + + +
+
+
+ + +
+

MatrixMessageAudio

+

MatrixMessageAudio — Class to hold a m.audio message

+
+
+

Functions

+
++++ + + + + + + + + + + + + + + + + + + + + + + + + + + +
#defineMATRIX_MESSAGE_TYPE_AUDIO
+MatrixMessageAudio * + +matrix_message_audio_new () +
const gchar * + +matrix_message_audio_get_url () +
+void + +matrix_message_audio_set_url () +
+MatrixAudioInfo * + +matrix_message_audio_get_info () +
+void + +matrix_message_audio_set_info () +
+
+
+

Types and Values

+
++++ + + + + + + + + + + +
structMatrixMessageAudio
structMatrixMessageAudioClass
+
+
+

Description

+

This message represents a single audio clip.

+
+
+

Functions

+
+

MATRIX_MESSAGE_TYPE_AUDIO

+
#define MATRIX_MESSAGE_TYPE_AUDIO (matrix_message_audio_get_type ())
+
+

The type for MatrixMessageAudio.

+
+
+
+

matrix_message_audio_new ()

+
MatrixMessageAudio *
+matrix_message_audio_new (void);
+
+
+
+

matrix_message_audio_get_url ()

+
const gchar *
+matrix_message_audio_get_url (MatrixMessageAudio *self);
+

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

+

The URL to the audio clip.

+
+

Parameters

+
+++++ + + + + + +

self

the MatrixMessageAudio instance to query

 
+
+
+

Returns

+

the value of the "url" property

+
+
+
+
+

matrix_message_audio_set_url ()

+
void
+matrix_message_audio_set_url (MatrixMessageAudio *self,
+                              const gchar *value);
+

Set the value of the "url" property to value +.

+

The URL to the audio clip.

+
+

Parameters

+
+++++ + + + + + + + + + + + + +

self

the MatrixMessageAudio instance to modify

 

value

the new value of the "url" property

 
+
+
+
+
+

matrix_message_audio_get_info ()

+
MatrixAudioInfo *
+matrix_message_audio_get_info (MatrixMessageAudio *self);
+

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

+

Metadata for the audio clip referred to in url.

+
+

Parameters

+
+++++ + + + + + +

self

the MatrixMessageAudio instance to query

 
+
+
+

Returns

+

the value of the "info" property

+
+
+
+
+

matrix_message_audio_set_info ()

+
void
+matrix_message_audio_set_info (MatrixMessageAudio *self,
+                               MatrixAudioInfo *value);
+

Set the value of the "info" property to value +.

+

Metadata for the audio clip referred to in url.

+
+

Parameters

+
+++++ + + + + + + + + + + + + +

self

the MatrixMessageAudio instance to modify

 

value

the new value of the "info" property

 
+
+
+
+
+

Types and Values

+
+

struct MatrixMessageAudio

+
struct MatrixMessageAudio {
+	MatrixMessageBase parent_instance;
+	MatrixMessageAudioPrivate * priv;
+};
+
+

Class to hold a m.audio message

+

This message represents a single audio clip.

+
+
+
+

struct MatrixMessageAudioClass

+
struct MatrixMessageAudioClass {
+	MatrixMessageBaseClass parent_class;
+};
+
+

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

+
+

Members

+
+++++ + + + + + +

MatrixMessageBaseClass parent_class;

the parent class structure

 
+
+
+
+
+
+
Generated by GTK-Doc V1.24
+ + \ No newline at end of file diff --git a/Matrix-0.0-MatrixMessageBase.html b/Matrix-0.0-MatrixMessageBase.html new file mode 100644 index 0000000..bcedec0 --- /dev/null +++ b/Matrix-0.0-MatrixMessageBase.html @@ -0,0 +1,590 @@ + + + + +MatrixMessageBase: Matrix-0.0 Reference Manual + + + + + + + + + + + + + + + + +
+
+
+ + +
+

MatrixMessageBase

+

MatrixMessageBase — Base class for message handlers.

+
+
+

Functions

+
++++ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+GType * + +matrix_message_get_handler () +
+void + +matrix_message_register_type () +
+void + +matrix_message_unregister_type () +
#defineMATRIX_MESSAGE_TYPE_BASE
+void + +matrix_message_base_from_json () +
+void + +matrix_message_base_to_json () +
const gchar * + +matrix_message_base_get_message_type () +
+void + +matrix_message_base_set_message_type () +
const gchar * + +matrix_message_base_get_body () +
+void + +matrix_message_base_set_body () +
+JsonNode * + +matrix_message_base_get_json () +
+MatrixMessageBase * + +matrix_message_base_new_from_json () +
+
+
+

Types and Values

+
++++ + + + + + + + + + + +
structMatrixMessageBase
structMatrixMessageBaseClass
+
+
+

Description

+

Message handler base class.

+
+
+

Functions

+
+

matrix_message_get_handler ()

+
GType *
+matrix_message_get_handler (const gchar *message_type);
+

Get the GType of the class that is registered to handle messages with type param + message_type.

+
+

Parameters

+
+++++ + + + + + + + + + + + + +

self

the (null) instance

 

message_type

 +

 .

+

the message type to look up

+

.

+		[in]
+
+
+

Returns

+

a GType or `null` if no handler is registered

+
+
+
+
+

matrix_message_register_type ()

+
void
+matrix_message_register_type (const gchar *message_type,
+                              GType message_gtype,
+                              GError **error);
+

Register param + message_type to be handled by the type param + message_gtype.

+
+

Parameters

+
+++++ + + + + + + + + + + + + + + + + + + + + + + +

self

the (null) instance

 

message_type

 +

 .

+

the type of the message

+

.

+		[in]

message_gtype

 +

 .

+

the GType of the event's handler

+

.

+		[in]

error

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

[error-domains MatrixError]
+
+
+
+
+

matrix_message_unregister_type ()

+
void
+matrix_message_unregister_type (const gchar *message_type);
+

Unregister param + message_type.

+
+

Parameters

+
+++++ + + + + + + + + + + + + +

self

the (null) instance

 

message_type

 +

 .

+

the message type to remove

+

.

+		[in]
+
+
+
+
+

MATRIX_MESSAGE_TYPE_BASE

+
#define MATRIX_MESSAGE_TYPE_BASE (matrix_message_base_get_type ())
+
+

The type for MatrixMessageBase.

+
+
+
+

matrix_message_base_from_json ()

+
void
+matrix_message_base_from_json (MatrixMessageBase *self,
+                               JsonNode *json_data,
+                               GError **error);
+

Subclasses should override this method to initialize themselves from JSON data while chaining up to allow parent classes to do the same.

+
+

Parameters

+
+++++ + + + + + + + + + + + + + + + + + +

self

the MatrixMessageBase instance

 

json_data

 

 

error

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

[error-domains MatrixError]
+
+
+
+
+

matrix_message_base_to_json ()

+
void
+matrix_message_base_to_json (MatrixMessageBase *self,
+                             JsonNode *json_data,
+                             GError **error);
+

Subclasses should override this method to export their data to JSON, while chaining up to allow parent classes to do the same.

+
+

Parameters

+
+++++ + + + + + + + + + + + + + + + + + +

self

the MatrixMessageBase instance

 

json_data

 

 

error

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

[error-domains MatrixError]
+
+
+
+
+

matrix_message_base_get_message_type ()

+
const gchar *
+matrix_message_base_get_message_type (MatrixMessageBase *self);
+

Get and return the current value of the "message-type" property.

+

The message type.

+
+

Parameters

+
+++++ + + + + + +

self

the MatrixMessageBase instance to query

 
+
+
+

Returns

+

the value of the "message-type" property

+
+
+
+
+

matrix_message_base_set_message_type ()

+
void
+matrix_message_base_set_message_type (MatrixMessageBase *self,
+                                      const gchar *value);
+

Set the value of the "message-type" property to value +.

+

The message type.

+
+

Parameters

+
+++++ + + + + + + + + + + + + +

self

the MatrixMessageBase instance to modify

 

value

the new value of the "message-type" property

 
+
+
+
+
+

matrix_message_base_get_body ()

+
const gchar *
+matrix_message_base_get_body (MatrixMessageBase *self);
+

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

+

The body of the message.

+
+

Parameters

+
+++++ + + + + + +

self

the MatrixMessageBase instance to query

 
+
+
+

Returns

+

the value of the "body" property

+
+
+
+
+

matrix_message_base_set_body ()

+
void
+matrix_message_base_set_body (MatrixMessageBase *self,
+                              const gchar *value);
+

Set the value of the "body" property to value +.

+

The body of the message.

+
+

Parameters

+
+++++ + + + + + + + + + + + + +

self

the MatrixMessageBase instance to modify

 

value

the new value of the "body" property

 
+
+
+
+
+

matrix_message_base_get_json ()

+
JsonNode *
+matrix_message_base_get_json (MatrixMessageBase *self);
+

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

+
+

Parameters

+
+++++ + + + + + +

self

the MatrixMessageBase instance to query

 
+
+
+

Returns

+

the value of the "json" property

+
+
+
+
+

matrix_message_base_new_from_json ()

+
MatrixMessageBase *
+matrix_message_base_new_from_json (JsonNode *json_data,
+                                   GError **error);
+
+

Parameters

+
+++++ + + + + + + + + + + + + +

json_data

 

 

error

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

[error-domains MatrixError]
+
+
+
+
+

Types and Values

+
+

struct MatrixMessageBase

+
struct MatrixMessageBase {
+	GObject parent_instance;
+	MatrixMessageBasePrivate * priv;
+};
+
+

Base class for message handlers.

+

Message handler base class.

+
+
+
+

struct MatrixMessageBaseClass

+
struct MatrixMessageBaseClass {
+	GObjectClass parent_class;
+	void (*from_json) (MatrixMessageBase* self, JsonNode* json_data, GError** error);
+	void (*to_json) (MatrixMessageBase* self, JsonNode* json_data, GError** error);
+};
+
+

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

+
+

Members

+
+++++ + + + + + + + + + + + + + + + + + +

GObjectClass parent_class;

the parent class structure

 

from_json ()

virtual method called by matrix_message_base_from_json()

 

to_json ()

virtual method called by matrix_message_base_to_json()

 
+
+
+
+
+
+
Generated by GTK-Doc V1.24
+ + \ No newline at end of file diff --git a/Matrix-0.0-MatrixMessageEmote.html b/Matrix-0.0-MatrixMessageEmote.html new file mode 100644 index 0000000..a16980f --- /dev/null +++ b/Matrix-0.0-MatrixMessageEmote.html @@ -0,0 +1,136 @@ + + + + +MatrixMessageEmote: Matrix-0.0 Reference Manual + + + + + + + + + + + + + + + + +
+
+
+ + +
+

MatrixMessageEmote

+

MatrixMessageEmote — The emote message type

+
+
+

Functions

+
++++ + + + + + + + + + + +
#defineMATRIX_MESSAGE_TYPE_EMOTE
+MatrixMessageEmote * + +matrix_message_emote_new () +
+
+
+

Types and Values

+
++++ + + + + + + + + + + +
structMatrixMessageEmote
structMatrixMessageEmoteClass
+
+
+

Description

+

This message is similar to `m.text` except that the sender is 'performing' the action contained in the `body` key, similar to `/me` in IRC. This message should be prefixed by the name of the sender. This message could also be represented in a different colour to distinguish it from regular `m.text` messages.

+
+
+

Functions

+
+

MATRIX_MESSAGE_TYPE_EMOTE

+
#define MATRIX_MESSAGE_TYPE_EMOTE (matrix_message_emote_get_type ())
+
+

The type for MatrixMessageEmote.

+
+
+
+

matrix_message_emote_new ()

+
MatrixMessageEmote *
+matrix_message_emote_new (void);
+
+
+
+

Types and Values

+
+

struct MatrixMessageEmote

+
struct MatrixMessageEmote {
+	MatrixMessageBase parent_instance;
+	MatrixMessageEmotePrivate * priv;
+};
+
+

The emote message type

+

This message is similar to `m.text` except that the sender is 'performing' the action contained in the `body` key, similar to `/me` in IRC. This message should be prefixed by the name of the sender. This message could also be represented in a different colour to distinguish it from regular `m.text` messages.

+
+
+
+

struct MatrixMessageEmoteClass

+
struct MatrixMessageEmoteClass {
+	MatrixMessageBaseClass parent_class;
+};
+
+

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

+
+

Members

+
+++++ + + + + + +

MatrixMessageBaseClass parent_class;

the parent class structure

 
+
+
+
+
+
+
Generated by GTK-Doc V1.24
+ + \ No newline at end of file diff --git a/Matrix-0.0-MatrixMessageFile.html b/Matrix-0.0-MatrixMessageFile.html new file mode 100644 index 0000000..cc8c708 --- /dev/null +++ b/Matrix-0.0-MatrixMessageFile.html @@ -0,0 +1,510 @@ + + + + +MatrixMessageFile: Matrix-0.0 Reference Manual + + + + + + + + + + + + + + + + +
+
+
+ + +
+

MatrixMessageFile

+

MatrixMessageFile — Class to hold a m.file message

+
+
+

Functions

+
++++ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
#defineMATRIX_MESSAGE_TYPE_FILE
+MatrixMessageFile * + +matrix_message_file_new () +
const gchar * + +matrix_message_file_get_filename () +
+void + +matrix_message_file_set_filename () +
const gchar * + +matrix_message_file_get_url () +
+void + +matrix_message_file_set_url () +
+MatrixFileInfo * + +matrix_message_file_get_info () +
+void + +matrix_message_file_set_info () +
const gchar * + +matrix_message_file_get_thumbnail_url () +
+void + +matrix_message_file_set_thumbnail_url () +
+MatrixImageInfo * + +matrix_message_file_get_thumbnail_info () +
+void + +matrix_message_file_set_thumbnail_info () +
+
+
+

Types and Values

+
++++ + + + + + + + + + + +
structMatrixMessageFile
structMatrixMessageFileClass
+
+
+

Description

+

This message represents a generic file.

+
+
+

Functions

+
+

MATRIX_MESSAGE_TYPE_FILE

+
#define MATRIX_MESSAGE_TYPE_FILE (matrix_message_file_get_type ())
+
+

The type for MatrixMessageFile.

+
+
+
+

matrix_message_file_new ()

+
MatrixMessageFile *
+matrix_message_file_new (void);
+
+
+
+

matrix_message_file_get_filename ()

+
const gchar *
+matrix_message_file_get_filename (MatrixMessageFile *self);
+

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

+

The original filename of the uploaded file.

+
+

Parameters

+
+++++ + + + + + +

self

the MatrixMessageFile instance to query

 
+
+
+

Returns

+

the value of the "filename" property

+
+
+
+
+

matrix_message_file_set_filename ()

+
void
+matrix_message_file_set_filename (MatrixMessageFile *self,
+                                  const gchar *value);
+

Set the value of the "filename" property to value +.

+

The original filename of the uploaded file.

+
+

Parameters

+
+++++ + + + + + + + + + + + + +

self

the MatrixMessageFile instance to modify

 

value

the new value of the "filename" property

 
+
+
+
+
+

matrix_message_file_get_url ()

+
const gchar *
+matrix_message_file_get_url (MatrixMessageFile *self);
+

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

+

The URL of the file.

+
+

Parameters

+
+++++ + + + + + +

self

the MatrixMessageFile instance to query

 
+
+
+

Returns

+

the value of the "url" property

+
+
+
+
+

matrix_message_file_set_url ()

+
void
+matrix_message_file_set_url (MatrixMessageFile *self,
+                             const gchar *value);
+

Set the value of the "url" property to value +.

+

The URL of the file.

+
+

Parameters

+
+++++ + + + + + + + + + + + + +

self

the MatrixMessageFile instance to modify

 

value

the new value of the "url" property

 
+
+
+
+
+

matrix_message_file_get_info ()

+
MatrixFileInfo *
+matrix_message_file_get_info (MatrixMessageFile *self);
+

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

+

Information about the file referred to in url.

+
+

Parameters

+
+++++ + + + + + +

self

the MatrixMessageFile instance to query

 
+
+
+

Returns

+

the value of the "info" property

+
+
+
+
+

matrix_message_file_set_info ()

+
void
+matrix_message_file_set_info (MatrixMessageFile *self,
+                              MatrixFileInfo *value);
+

Set the value of the "info" property to value +.

+

Information about the file referred to in url.

+
+

Parameters

+
+++++ + + + + + + + + + + + + +

self

the MatrixMessageFile instance to modify

 

value

the new value of the "info" property

 
+
+
+
+
+

matrix_message_file_get_thumbnail_url ()

+
const gchar *
+matrix_message_file_get_thumbnail_url (MatrixMessageFile *self);
+

Get and return the current value of the "thumbnail-url" property.

+

The URL of the thumbnail of the file.

+
+

Parameters

+
+++++ + + + + + +

self

the MatrixMessageFile instance to query

 
+
+
+

Returns

+

the value of the "thumbnail-url" property

+
+
+
+
+

matrix_message_file_set_thumbnail_url ()

+
void
+matrix_message_file_set_thumbnail_url (MatrixMessageFile *self,
+                                       const gchar *value);
+

Set the value of the "thumbnail-url" property to value +.

+

The URL of the thumbnail of the file.

+
+

Parameters

+
+++++ + + + + + + + + + + + + +

self

the MatrixMessageFile instance to modify

 

value

the new value of the "thumbnail-url" property

 
+
+
+
+
+

matrix_message_file_get_thumbnail_info ()

+
MatrixImageInfo *
+matrix_message_file_get_thumbnail_info
+                               (MatrixMessageFile *self);
+

Get and return the current value of the "thumbnail-info" property.

+

Metadata about the image referred to in thumbnail_url.

+
+

Parameters

+
+++++ + + + + + +

self

the MatrixMessageFile instance to query

 
+
+
+

Returns

+

the value of the "thumbnail-info" property

+
+
+
+
+

matrix_message_file_set_thumbnail_info ()

+
void
+matrix_message_file_set_thumbnail_info
+                               (MatrixMessageFile *self,
+                                MatrixImageInfo *value);
+

Set the value of the "thumbnail-info" property to value +.

+

Metadata about the image referred to in thumbnail_url.

+
+

Parameters

+
+++++ + + + + + + + + + + + + +

self

the MatrixMessageFile instance to modify

 

value

the new value of the "thumbnail-info" property

 
+
+
+
+
+

Types and Values

+
+

struct MatrixMessageFile

+
struct MatrixMessageFile {
+	MatrixMessageBase parent_instance;
+	MatrixMessageFilePrivate * priv;
+};
+
+

Class to hold a m.file message

+

This message represents a generic file.

+
+
+
+

struct MatrixMessageFileClass

+
struct MatrixMessageFileClass {
+	MatrixMessageBaseClass parent_class;
+};
+
+

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

+
+

Members

+
+++++ + + + + + +

MatrixMessageBaseClass parent_class;

the parent class structure

 
+
+
+
+
+
+
Generated by GTK-Doc V1.24
+ + \ No newline at end of file diff --git a/Matrix-0.0-MatrixMessageImage.html b/Matrix-0.0-MatrixMessageImage.html new file mode 100644 index 0000000..4b54fe3 --- /dev/null +++ b/Matrix-0.0-MatrixMessageImage.html @@ -0,0 +1,438 @@ + + + + +MatrixMessageImage: Matrix-0.0 Reference Manual + + + + + + + + + + + + + + + + +
+
+
+ + +
+

MatrixMessageImage

+

MatrixMessageImage — Class to hold a m.image message

+
+
+

Functions

+
++++ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
#defineMATRIX_MESSAGE_TYPE_IMAGE
+MatrixMessageImage * + +matrix_message_image_new () +
const gchar * + +matrix_message_image_get_url () +
+void + +matrix_message_image_set_url () +
const gchar * + +matrix_message_image_get_thumbnail_url () +
+void + +matrix_message_image_set_thumbnail_url () +
+MatrixImageInfo * + +matrix_message_image_get_info () +
+void + +matrix_message_image_set_info () +
+MatrixImageInfo * + +matrix_message_image_get_thumbnail_info () +
+void + +matrix_message_image_set_thumbnail_info () +
+
+
+

Types and Values

+
++++ + + + + + + + + + + +
structMatrixMessageImage
structMatrixMessageImageClass
+
+
+

Description

+

This message represents a single image and an optional thumbnail.

+
+
+

Functions

+
+

MATRIX_MESSAGE_TYPE_IMAGE

+
#define MATRIX_MESSAGE_TYPE_IMAGE (matrix_message_image_get_type ())
+
+

The type for MatrixMessageImage.

+
+
+
+

matrix_message_image_new ()

+
MatrixMessageImage *
+matrix_message_image_new (void);
+
+
+
+

matrix_message_image_get_url ()

+
const gchar *
+matrix_message_image_get_url (MatrixMessageImage *self);
+

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

+

The URL to the image.

+
+

Parameters

+
+++++ + + + + + +

self

the MatrixMessageImage instance to query

 
+
+
+

Returns

+

the value of the "url" property

+
+
+
+
+

matrix_message_image_set_url ()

+
void
+matrix_message_image_set_url (MatrixMessageImage *self,
+                              const gchar *value);
+

Set the value of the "url" property to value +.

+

The URL to the image.

+
+

Parameters

+
+++++ + + + + + + + + + + + + +

self

the MatrixMessageImage instance to modify

 

value

the new value of the "url" property

 
+
+
+
+
+

matrix_message_image_get_thumbnail_url ()

+
const gchar *
+matrix_message_image_get_thumbnail_url
+                               (MatrixMessageImage *self);
+

Get and return the current value of the "thumbnail-url" property.

+

The URL to the thumbnail of the image.

+
+

Parameters

+
+++++ + + + + + +

self

the MatrixMessageImage instance to query

 
+
+
+

Returns

+

the value of the "thumbnail-url" property

+
+
+
+
+

matrix_message_image_set_thumbnail_url ()

+
void
+matrix_message_image_set_thumbnail_url
+                               (MatrixMessageImage *self,
+                                const gchar *value);
+

Set the value of the "thumbnail-url" property to value +.

+

The URL to the thumbnail of the image.

+
+

Parameters

+
+++++ + + + + + + + + + + + + +

self

the MatrixMessageImage instance to modify

 

value

the new value of the "thumbnail-url" property

 
+
+
+
+
+

matrix_message_image_get_info ()

+
MatrixImageInfo *
+matrix_message_image_get_info (MatrixMessageImage *self);
+

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

+

Metadata about the image referred to in url.

+
+

Parameters

+
+++++ + + + + + +

self

the MatrixMessageImage instance to query

 
+
+
+

Returns

+

the value of the "info" property

+
+
+
+
+

matrix_message_image_set_info ()

+
void
+matrix_message_image_set_info (MatrixMessageImage *self,
+                               MatrixImageInfo *value);
+

Set the value of the "info" property to value +.

+

Metadata about the image referred to in url.

+
+

Parameters

+
+++++ + + + + + + + + + + + + +

self

the MatrixMessageImage instance to modify

 

value

the new value of the "info" property

 
+
+
+
+
+

matrix_message_image_get_thumbnail_info ()

+
MatrixImageInfo *
+matrix_message_image_get_thumbnail_info
+                               (MatrixMessageImage *self);
+

Get and return the current value of the "thumbnail-info" property.

+

Metadata about the image referred to in thumbnail_url.

+
+

Parameters

+
+++++ + + + + + +

self

the MatrixMessageImage instance to query

 
+
+
+

Returns

+

the value of the "thumbnail-info" property

+
+
+
+
+

matrix_message_image_set_thumbnail_info ()

+
void
+matrix_message_image_set_thumbnail_info
+                               (MatrixMessageImage *self,
+                                MatrixImageInfo *value);
+

Set the value of the "thumbnail-info" property to value +.

+

Metadata about the image referred to in thumbnail_url.

+
+

Parameters

+
+++++ + + + + + + + + + + + + +

self

the MatrixMessageImage instance to modify

 

value

the new value of the "thumbnail-info" property

 
+
+
+
+
+

Types and Values

+
+

struct MatrixMessageImage

+
struct MatrixMessageImage {
+	MatrixMessageBase parent_instance;
+	MatrixMessageImagePrivate * priv;
+};
+
+

Class to hold a m.image message

+

This message represents a single image and an optional thumbnail.

+
+
+
+

struct MatrixMessageImageClass

+
struct MatrixMessageImageClass {
+	MatrixMessageBaseClass parent_class;
+};
+
+

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

+
+

Members

+
+++++ + + + + + +

MatrixMessageBaseClass parent_class;

the parent class structure

 
+
+
+
+
+
+
Generated by GTK-Doc V1.24
+ + \ No newline at end of file diff --git a/Matrix-0.0-MatrixMessageLocation.html b/Matrix-0.0-MatrixMessageLocation.html new file mode 100644 index 0000000..ef871a8 --- /dev/null +++ b/Matrix-0.0-MatrixMessageLocation.html @@ -0,0 +1,361 @@ + + + + +MatrixMessageLocation: Matrix-0.0 Reference Manual + + + + + + + + + + + + + + + + +
+
+
+ + +
+

MatrixMessageLocation

+

MatrixMessageLocation — This message represents a real-world location.

+
+
+

Functions

+
++++ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
#defineMATRIX_MESSAGE_TYPE_LOCATION
+MatrixMessageLocation * + +matrix_message_location_new () +
const gchar * + +matrix_message_location_get_geo_uri () +
+void + +matrix_message_location_set_geo_uri () +
const gchar * + +matrix_message_location_get_thumbnail_url () +
+void + +matrix_message_location_set_thumbnail_url () +
+MatrixImageInfo * + +matrix_message_location_get_thumbnail_info () +
+void + +matrix_message_location_set_thumbnail_info () +
+
+
+

Types and Values

+
++++ + + + + + + + + + + +
structMatrixMessageLocation
structMatrixMessageLocationClass
+
+
+

Description

+
+
+

Functions

+
+

MATRIX_MESSAGE_TYPE_LOCATION

+
#define MATRIX_MESSAGE_TYPE_LOCATION (matrix_message_location_get_type ())
+
+

The type for MatrixMessageLocation.

+
+
+
+

matrix_message_location_new ()

+
MatrixMessageLocation *
+matrix_message_location_new (void);
+
+
+
+

matrix_message_location_get_geo_uri ()

+
const gchar *
+matrix_message_location_get_geo_uri (MatrixMessageLocation *self);
+

Get and return the current value of the "geo-uri" property.

+

A geo URI representing this location.

+
+

Parameters

+
+++++ + + + + + +

self

the MatrixMessageLocation instance to query

 
+
+
+

Returns

+

the value of the "geo-uri" property

+
+
+
+
+

matrix_message_location_set_geo_uri ()

+
void
+matrix_message_location_set_geo_uri (MatrixMessageLocation *self,
+                                     const gchar *value);
+

Set the value of the "geo-uri" property to value +.

+

A geo URI representing this location.

+
+

Parameters

+
+++++ + + + + + + + + + + + + +

self

the MatrixMessageLocation instance to modify

 

value

the new value of the "geo-uri" property

 
+
+
+
+
+

matrix_message_location_get_thumbnail_url ()

+
const gchar *
+matrix_message_location_get_thumbnail_url
+                               (MatrixMessageLocation *self);
+

Get and return the current value of the "thumbnail-url" property.

+

The URL to a thumbnail of the location being represented.

+
+

Parameters

+
+++++ + + + + + +

self

the MatrixMessageLocation instance to query

 
+
+
+

Returns

+

the value of the "thumbnail-url" property

+
+
+
+
+

matrix_message_location_set_thumbnail_url ()

+
void
+matrix_message_location_set_thumbnail_url
+                               (MatrixMessageLocation *self,
+                                const gchar *value);
+

Set the value of the "thumbnail-url" property to value +.

+

The URL to a thumbnail of the location being represented.

+
+

Parameters

+
+++++ + + + + + + + + + + + + +

self

the MatrixMessageLocation instance to modify

 

value

the new value of the "thumbnail-url" property

 
+
+
+
+
+

matrix_message_location_get_thumbnail_info ()

+
MatrixImageInfo *
+matrix_message_location_get_thumbnail_info
+                               (MatrixMessageLocation *self);
+

Get and return the current value of the "thumbnail-info" property.

+

Metadata about the location referred to in thumbnail_url.

+
+

Parameters

+
+++++ + + + + + +

self

the MatrixMessageLocation instance to query

 
+
+
+

Returns

+

the value of the "thumbnail-info" property

+
+
+
+
+

matrix_message_location_set_thumbnail_info ()

+
void
+matrix_message_location_set_thumbnail_info
+                               (MatrixMessageLocation *self,
+                                MatrixImageInfo *value);
+

Set the value of the "thumbnail-info" property to value +.

+

Metadata about the location referred to in thumbnail_url.

+
+

Parameters

+
+++++ + + + + + + + + + + + + +

self

the MatrixMessageLocation instance to modify

 

value

the new value of the "thumbnail-info" property

 
+
+
+
+
+

Types and Values

+
+

struct MatrixMessageLocation

+
struct MatrixMessageLocation {
+	MatrixMessageBase parent_instance;
+	MatrixMessageLocationPrivate * priv;
+};
+
+

This message represents a real-world location.

+
+
+
+

struct MatrixMessageLocationClass

+
struct MatrixMessageLocationClass {
+	MatrixMessageBaseClass parent_class;
+};
+
+

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

+
+

Members

+
+++++ + + + + + +

MatrixMessageBaseClass parent_class;

the parent class structure

 
+
+
+
+
+
+
Generated by GTK-Doc V1.24
+ + \ No newline at end of file diff --git a/Matrix-0.0-MatrixMessageNotice.html b/Matrix-0.0-MatrixMessageNotice.html new file mode 100644 index 0000000..9d8c0ac --- /dev/null +++ b/Matrix-0.0-MatrixMessageNotice.html @@ -0,0 +1,136 @@ + + + + +MatrixMessageNotice: Matrix-0.0 Reference Manual + + + + + + + + + + + + + + + + +
+
+
+ + +
+

MatrixMessageNotice

+

MatrixMessageNotice — Message type to hold a m.notice message

+
+
+

Functions

+
++++ + + + + + + + + + + +
#defineMATRIX_MESSAGE_TYPE_NOTICE
+MatrixMessageNotice * + +matrix_message_notice_new () +
+
+
+

Types and Values

+
++++ + + + + + + + + + + +
structMatrixMessageNotice
structMatrixMessageNoticeClass
+
+
+

Description

+

A m.notice message should be considered similar to a plain m.text message except that clients should visually distinguish it in some way. It is intended to be used by automated clients, such as bots, bridges, and other entities, rather than humans. Additionally, such automated agents which watch a room for messages and respond to them ought to ignore m.notice messages. This helps to prevent infinite-loop situations where two automated clients continuously exchange messages, as each responds to the other.

+
+
+

Functions

+
+

MATRIX_MESSAGE_TYPE_NOTICE

+
#define MATRIX_MESSAGE_TYPE_NOTICE (matrix_message_notice_get_type ())
+
+

The type for MatrixMessageNotice.

+
+
+
+

matrix_message_notice_new ()

+
MatrixMessageNotice *
+matrix_message_notice_new (void);
+
+
+
+

Types and Values

+
+

struct MatrixMessageNotice

+
struct MatrixMessageNotice {
+	MatrixMessageBase parent_instance;
+	MatrixMessageNoticePrivate * priv;
+};
+
+

Message type to hold a m.notice message

+

A m.notice message should be considered similar to a plain m.text message except that clients should visually distinguish it in some way. It is intended to be used by automated clients, such as bots, bridges, and other entities, rather than humans. Additionally, such automated agents which watch a room for messages and respond to them ought to ignore m.notice messages. This helps to prevent infinite-loop situations where two automated clients continuously exchange messages, as each responds to the other.

+
+
+
+

struct MatrixMessageNoticeClass

+
struct MatrixMessageNoticeClass {
+	MatrixMessageBaseClass parent_class;
+};
+
+

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

+
+

Members

+
+++++ + + + + + +

MatrixMessageBaseClass parent_class;

the parent class structure

 
+
+
+
+
+
+
Generated by GTK-Doc V1.24
+ + \ No newline at end of file diff --git a/Matrix-0.0-MatrixMessageText.html b/Matrix-0.0-MatrixMessageText.html new file mode 100644 index 0000000..2c54b71 --- /dev/null +++ b/Matrix-0.0-MatrixMessageText.html @@ -0,0 +1,136 @@ + + + + +MatrixMessageText: Matrix-0.0 Reference Manual + + + + + + + + + + + + + + + + +
+
+
+ + +
+

MatrixMessageText

+

MatrixMessageText — Message handler for plain text messages

+
+
+

Functions

+
++++ + + + + + + + + + + +
#defineMATRIX_MESSAGE_TYPE_TEXT
+MatrixMessageText * + +matrix_message_text_new () +
+
+
+

Types and Values

+
++++ + + + + + + + + + + +
structMatrixMessageText
structMatrixMessageTextClass
+
+
+

Description

+

Handle plain text messages.

+
+
+

Functions

+
+

MATRIX_MESSAGE_TYPE_TEXT

+
#define MATRIX_MESSAGE_TYPE_TEXT (matrix_message_text_get_type ())
+
+

The type for MatrixMessageText.

+
+
+
+

matrix_message_text_new ()

+
MatrixMessageText *
+matrix_message_text_new (void);
+
+
+
+

Types and Values

+
+

struct MatrixMessageText

+
struct MatrixMessageText {
+	MatrixMessageBase parent_instance;
+	MatrixMessageTextPrivate * priv;
+};
+
+

Message handler for plain text messages

+

Handle plain text messages.

+
+
+
+

struct MatrixMessageTextClass

+
struct MatrixMessageTextClass {
+	MatrixMessageBaseClass parent_class;
+};
+
+

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

+
+

Members

+
+++++ + + + + + +

MatrixMessageBaseClass parent_class;

the parent class structure

 
+
+
+
+
+
+
Generated by GTK-Doc V1.24
+ + \ No newline at end of file diff --git a/Matrix-0.0-MatrixMessageVideo.html b/Matrix-0.0-MatrixMessageVideo.html new file mode 100644 index 0000000..338c43d --- /dev/null +++ b/Matrix-0.0-MatrixMessageVideo.html @@ -0,0 +1,283 @@ + + + + +MatrixMessageVideo: Matrix-0.0 Reference Manual + + + + + + + + + + + + + + + + +
+
+
+ + +
+

MatrixMessageVideo

+

MatrixMessageVideo — This message represents a single video clip.

+
+
+

Functions

+
++++ + + + + + + + + + + + + + + + + + + + + + + + + + + +
#defineMATRIX_MESSAGE_TYPE_VIDEO
+MatrixMessageVideo * + +matrix_message_video_new () +
const gchar * + +matrix_message_video_get_url () +
+void + +matrix_message_video_set_url () +
+MatrixVideoInfo * + +matrix_message_video_get_info () +
+void + +matrix_message_video_set_info () +
+
+
+

Types and Values

+
++++ + + + + + + + + + + +
structMatrixMessageVideo
structMatrixMessageVideoClass
+
+
+

Description

+
+
+

Functions

+
+

MATRIX_MESSAGE_TYPE_VIDEO

+
#define MATRIX_MESSAGE_TYPE_VIDEO (matrix_message_video_get_type ())
+
+

The type for MatrixMessageVideo.

+
+
+
+

matrix_message_video_new ()

+
MatrixMessageVideo *
+matrix_message_video_new (void);
+
+
+
+

matrix_message_video_get_url ()

+
const gchar *
+matrix_message_video_get_url (MatrixMessageVideo *self);
+

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

+

The URL to the video clip.

+
+

Parameters

+
+++++ + + + + + +

self

the MatrixMessageVideo instance to query

 
+
+
+

Returns

+

the value of the "url" property

+
+
+
+
+

matrix_message_video_set_url ()

+
void
+matrix_message_video_set_url (MatrixMessageVideo *self,
+                              const gchar *value);
+

Set the value of the "url" property to value +.

+

The URL to the video clip.

+
+

Parameters

+
+++++ + + + + + + + + + + + + +

self

the MatrixMessageVideo instance to modify

 

value

the new value of the "url" property

 
+
+
+
+
+

matrix_message_video_get_info ()

+
MatrixVideoInfo *
+matrix_message_video_get_info (MatrixMessageVideo *self);
+

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

+

Metadata about the video clip referred to in url.

+
+

Parameters

+
+++++ + + + + + +

self

the MatrixMessageVideo instance to query

 
+
+
+

Returns

+

the value of the "info" property

+
+
+
+
+

matrix_message_video_set_info ()

+
void
+matrix_message_video_set_info (MatrixMessageVideo *self,
+                               MatrixVideoInfo *value);
+

Set the value of the "info" property to value +.

+

Metadata about the video clip referred to in url.

+
+

Parameters

+
+++++ + + + + + + + + + + + + +

self

the MatrixMessageVideo instance to modify

 

value

the new value of the "info" property

 
+
+
+
+
+

Types and Values

+
+

struct MatrixMessageVideo

+
struct MatrixMessageVideo {
+	MatrixMessageBase parent_instance;
+	MatrixMessageVideoPrivate * priv;
+};
+
+

This message represents a single video clip.

+
+
+
+

struct MatrixMessageVideoClass

+
struct MatrixMessageVideoClass {
+	MatrixMessageBaseClass parent_class;
+};
+
+

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

+
+

Members

+
+++++ + + + + + +

MatrixMessageBaseClass parent_class;

the parent class structure

 
+
+
+
+
+
+
Generated by GTK-Doc V1.24
+ + \ No newline at end of file diff --git a/Matrix-0.0-MatrixPresenceEvent.html b/Matrix-0.0-MatrixPresenceEvent.html deleted file mode 100644 index cb35ca5..0000000 --- a/Matrix-0.0-MatrixPresenceEvent.html +++ /dev/null @@ -1,441 +0,0 @@ - - - - -Matrix-0.0 Reference Manual: MatrixPresenceEvent - - - - - - - - - - - - - - - - -
-
-
- - -
-

MatrixPresenceEvent

-

MatrixPresenceEvent — Class for representing presence events

-
-
-

Functions

-
---- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
#defineMATRIX_TYPE_PRESENCE_EVENT
-MatrixPresenceEvent * - -matrix_presence_event_new () -
const gchar * - -matrix_presence_event_get_avatar_url () -
-void - -matrix_presence_event_set_avatar_url () -
const gchar * - -matrix_presence_event_get_display_name () -
-void - -matrix_presence_event_set_display_name () -
-gulong * - -matrix_presence_event_get_last_active_ago () -
-void - -matrix_presence_event_set_last_active_ago () -
-MatrixPresence - -matrix_presence_event_get_presence () -
-void - -matrix_presence_event_set_presence () -
-
-
-

Types and Values

-
---- - - - - - - - - - - -
structMatrixPresenceEvent
structMatrixPresenceEventClass
-
-
-

Object Hierarchy

-
-
-
-
-

Description

-

The presence event class.

-
-
-

Functions

-
-

MATRIX_TYPE_PRESENCE_EVENT

-
#define MATRIX_TYPE_PRESENCE_EVENT (matrix_presence_event_get_type ())
-
-

The type for MatrixPresenceEvent.

-
-
-
-

matrix_presence_event_new ()

-
MatrixPresenceEvent *
-matrix_presence_event_new (void);
-
-
-
-

matrix_presence_event_get_avatar_url ()

-
const gchar *
-matrix_presence_event_get_avatar_url (MatrixPresenceEvent *self);
-

Get and return the current value of the "avatar-url" property.

-
-

Parameters

-
----- - - - - - -

self

the MatrixPresenceEvent instance to query

 
-
-
-

Returns

-

the value of the "avatar-url" property

-

-
-
-
-
-

matrix_presence_event_set_avatar_url ()

-
void
-matrix_presence_event_set_avatar_url (MatrixPresenceEvent *self,
-                                      const gchar *value);
-

Set the value of the "avatar-url" property to value -.

-
-

Parameters

-
----- - - - - - - - - - - - - -

self

the MatrixPresenceEvent instance to modify

 

value

the new value of the "avatar-url" property

 
-
-
-
-
-

matrix_presence_event_get_display_name ()

-
const gchar *
-matrix_presence_event_get_display_name
-                               (MatrixPresenceEvent *self);
-

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

-
-

Parameters

-
----- - - - - - -

self

the MatrixPresenceEvent instance to query

 
-
-
-

Returns

-

the value of the "display-name" property

-

-
-
-
-
-

matrix_presence_event_set_display_name ()

-
void
-matrix_presence_event_set_display_name
-                               (MatrixPresenceEvent *self,
-                                const gchar *value);
-

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

-
-

Parameters

-
----- - - - - - - - - - - - - -

self

the MatrixPresenceEvent instance to modify

 

value

the new value of the "display-name" property

 
-
-
-
-
-

matrix_presence_event_get_last_active_ago ()

-
gulong *
-matrix_presence_event_get_last_active_ago
-                               (MatrixPresenceEvent *self);
-

Get and return the current value of the "last-active-ago" property.

-
-

Parameters

-
----- - - - - - -

self

the MatrixPresenceEvent instance to query

 
-
-
-

Returns

-

the value of the "last-active-ago" property

-

-
-
-
-
-

matrix_presence_event_set_last_active_ago ()

-
void
-matrix_presence_event_set_last_active_ago
-                               (MatrixPresenceEvent *self,
-                                gulong *value);
-

Set the value of the "last-active-ago" property to value -.

-
-

Parameters

-
----- - - - - - - - - - - - - -

self

the MatrixPresenceEvent instance to modify

 

value

the new value of the "last-active-ago" property

 
-
-
-
-
-

matrix_presence_event_get_presence ()

-
MatrixPresence
-matrix_presence_event_get_presence (MatrixPresenceEvent *self);
-

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

-
-

Parameters

-
----- - - - - - -

self

the MatrixPresenceEvent instance to query

 
-
-
-

Returns

-

the value of the "presence" property

-

-
-
-
-
-

matrix_presence_event_set_presence ()

-
void
-matrix_presence_event_set_presence (MatrixPresenceEvent *self,
-                                    MatrixPresence value);
-

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

-
-

Parameters

-
----- - - - - - - - - - - - - -

self

the MatrixPresenceEvent instance to modify

 

value

the new value of the "presence" property

 
-
-
-
-
-

Types and Values

-
-

struct MatrixPresenceEvent

-
struct MatrixPresenceEvent {
-	MatrixEvent parent_instance;
-	MatrixPresenceEventPrivate * priv;
-};
-
-

Class for representing presence events

-

The presence event class.

-
-
-
-

struct MatrixPresenceEventClass

-
struct MatrixPresenceEventClass {
-	MatrixEventClass parent_class;
-};
-
-

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

-
-

Members

-
----- - - - - - -

MatrixEventClass parent_class;

the parent class structure

 
-
-
-
-
-
-
- Generated by GTK-Doc V1.20
- - \ No newline at end of file diff --git a/Matrix-0.0-MatrixProfile.html b/Matrix-0.0-MatrixProfile.html new file mode 100644 index 0000000..5d6cfd8 --- /dev/null +++ b/Matrix-0.0-MatrixProfile.html @@ -0,0 +1,318 @@ + + + + +MatrixProfile: Matrix-0.0 Reference Manual + + + + + + + + + + + + + + + + +
+
+
+ + +
+

MatrixProfile

+

MatrixProfile — Object to hold a user's profile

+
+
+

Functions

+
++++ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
#defineMATRIX_TYPE_PROFILE
+MatrixProfile * + +matrix_profile_new () +
+GTimeSpan + +matrix_profile_get_age () +
const gchar * + +matrix_profile_get_display_name () +
+void + +matrix_profile_set_display_name () +
const gchar * + +matrix_profile_get_avatar_url () +
+void + +matrix_profile_set_avatar_url () +
+
+
+

Types and Values

+
++++ + + + + + + + + + + +
structMatrixProfile
structMatrixProfileClass
+
+
+

Description

+

This object is used for both global and room specific profiles.

+
+
+

Functions

+
+

MATRIX_TYPE_PROFILE

+
#define MATRIX_TYPE_PROFILE (matrix_profile_get_type ())
+
+

The type for MatrixProfile.

+
+
+
+

matrix_profile_new ()

+
MatrixProfile *
+matrix_profile_new (void);
+
+
+
+

matrix_profile_get_age ()

+
GTimeSpan
+matrix_profile_get_age (MatrixProfile *self);
+

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

+
+

Parameters

+
+++++ + + + + + +

self

the MatrixProfile instance to query

 
+
+
+

Returns

+

the value of the "age" property

+
+
+
+
+

matrix_profile_get_display_name ()

+
const gchar *
+matrix_profile_get_display_name (MatrixProfile *self);
+

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

+

The human readable name of the user.

+
+

Parameters

+
+++++ + + + + + +

self

the MatrixProfile instance to query

 
+
+
+

Returns

+

the value of the "display-name" property

+
+
+
+
+

matrix_profile_set_display_name ()

+
void
+matrix_profile_set_display_name (MatrixProfile *self,
+                                 const gchar *value);
+

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

+

The human readable name of the user.

+
+

Parameters

+
+++++ + + + + + + + + + + + + +

self

the MatrixProfile instance to modify

 

value

the new value of the "display-name" property

 
+
+
+
+
+

matrix_profile_get_avatar_url ()

+
const gchar *
+matrix_profile_get_avatar_url (MatrixProfile *self);
+

Get and return the current value of the "avatar-url" property.

+

The URL of the user's avatar.

+
+

Parameters

+
+++++ + + + + + +

self

the MatrixProfile instance to query

 
+
+
+

Returns

+

the value of the "avatar-url" property

+
+
+
+
+

matrix_profile_set_avatar_url ()

+
void
+matrix_profile_set_avatar_url (MatrixProfile *self,
+                               const gchar *value);
+

Set the value of the "avatar-url" property to value +.

+

The URL of the user's avatar.

+
+

Parameters

+
+++++ + + + + + + + + + + + + +

self

the MatrixProfile instance to modify

 

value

the new value of the "avatar-url" property

 
+
+
+
+
+

Types and Values

+
+

struct MatrixProfile

+
struct MatrixProfile {
+	GObject parent_instance;
+	MatrixProfilePrivate * priv;
+};
+
+

Object to hold a user's profile

+

This object is used for both global and room specific profiles.

+
+
+
+

struct MatrixProfileClass

+
struct MatrixProfileClass {
+	GObjectClass parent_class;
+};
+
+

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

+
+

Members

+
+++++ + + + + + +

GObjectClass parent_class;

the parent class structure

 
+
+
+
+
+
+
Generated by GTK-Doc V1.24
+ + \ No newline at end of file diff --git a/Matrix-0.0-MatrixRoomEvent.html b/Matrix-0.0-MatrixRoomEvent.html deleted file mode 100644 index 093ab91..0000000 --- a/Matrix-0.0-MatrixRoomEvent.html +++ /dev/null @@ -1,125 +0,0 @@ - - - - -Matrix-0.0 Reference Manual: MatrixRoomEvent - - - - - - - - - - - - - - - - -
-
-
- - -
-

MatrixRoomEvent

-

MatrixRoomEvent — Abstract base class for room events.

-
-
-

Functions

-
---- - - - - -
#defineMATRIX_TYPE_ROOM_EVENT
-
-
-

Types and Values

-
---- - - - - - - - - - - -
structMatrixRoomEvent
structMatrixRoomEventClass
-
-
-

Object Hierarchy

-
-
-
-
-

Description

-
-
-

Functions

-
-

MATRIX_TYPE_ROOM_EVENT

-
#define MATRIX_TYPE_ROOM_EVENT (matrix_room_event_get_type ())
-
-

The type for MatrixRoomEvent.

-
-
-
-

Types and Values

-
-

struct MatrixRoomEvent

-
struct MatrixRoomEvent {
-	MatrixEvent parent_instance;
-	MatrixRoomEventPrivate * priv;
-};
-
-

Abstract base class for room events.

-
-
-
-

struct MatrixRoomEventClass

-
struct MatrixRoomEventClass {
-	MatrixEventClass parent_class;
-};
-
-

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

-
-

Members

-
----- - - - - - -

MatrixEventClass parent_class;

the parent class structure

 
-
-
-
-
-
-
- Generated by GTK-Doc V1.20
- - \ No newline at end of file diff --git a/Matrix-0.0-MatrixRoomMemberEvent.html b/Matrix-0.0-MatrixRoomMemberEvent.html deleted file mode 100644 index 71d399c..0000000 --- a/Matrix-0.0-MatrixRoomMemberEvent.html +++ /dev/null @@ -1,444 +0,0 @@ - - - - -Matrix-0.0 Reference Manual: MatrixRoomMemberEvent - - - - - - - - - - - - - - - - -
-
-
- - -
-

MatrixRoomMemberEvent

-

MatrixRoomMemberEvent — Class for representing a room membership events

-
-
-

Functions

-
---- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
#defineMATRIX_TYPE_ROOM_MEMBER_EVENT
-MatrixRoomMemberEvent * - -matrix_room_member_event_new () -
const gchar * - -matrix_room_member_event_get_state_key () -
-void - -matrix_room_member_event_set_state_key () -
-MatrixRoomMembership - -matrix_room_member_event_get_membership () -
-void - -matrix_room_member_event_set_membership () -
const gchar * - -matrix_room_member_event_get_avatar_url () -
-void - -matrix_room_member_event_set_avatar_url () -
const gchar * - -matrix_room_member_event_get_display_name () -
-void - -matrix_room_member_event_set_display_name () -
-
-
-

Types and Values

-
---- - - - - - - - - - - -
structMatrixRoomMemberEvent
structMatrixRoomMemberEventClass
-
-
-

Object Hierarchy

-
-
-
-
-

Description

-

The room membership event class.

-
-
-

Functions

-
-

MATRIX_TYPE_ROOM_MEMBER_EVENT

-
#define MATRIX_TYPE_ROOM_MEMBER_EVENT (matrix_room_member_event_get_type ())
-
-

The type for MatrixRoomMemberEvent.

-
-
-
-

matrix_room_member_event_new ()

-
MatrixRoomMemberEvent *
-matrix_room_member_event_new (void);
-
-
-
-

matrix_room_member_event_get_state_key ()

-
const gchar *
-matrix_room_member_event_get_state_key
-                               (MatrixRoomMemberEvent *self);
-

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

-
-

Parameters

-
----- - - - - - -

self

the MatrixRoomMemberEvent instance to query

 
-
-
-

Returns

-

the value of the "state-key" property

-

-
-
-
-
-

matrix_room_member_event_set_state_key ()

-
void
-matrix_room_member_event_set_state_key
-                               (MatrixRoomMemberEvent *self,
-                                const gchar *value);
-

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

-
-

Parameters

-
----- - - - - - - - - - - - - -

self

the MatrixRoomMemberEvent instance to modify

 

value

the new value of the "state-key" property

 
-
-
-
-
-

matrix_room_member_event_get_membership ()

-
MatrixRoomMembership
-matrix_room_member_event_get_membership
-                               (MatrixRoomMemberEvent *self);
-

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

-
-

Parameters

-
----- - - - - - -

self

the MatrixRoomMemberEvent instance to query

 
-
-
-

Returns

-

the value of the "membership" property

-

-
-
-
-
-

matrix_room_member_event_set_membership ()

-
void
-matrix_room_member_event_set_membership
-                               (MatrixRoomMemberEvent *self,
-                                MatrixRoomMembership value);
-

Set the value of the "membership" property to value -.

-
-

Parameters

-
----- - - - - - - - - - - - - -

self

the MatrixRoomMemberEvent instance to modify

 

value

the new value of the "membership" property

 
-
-
-
-
-

matrix_room_member_event_get_avatar_url ()

-
const gchar *
-matrix_room_member_event_get_avatar_url
-                               (MatrixRoomMemberEvent *self);
-

Get and return the current value of the "avatar-url" property.

-
-

Parameters

-
----- - - - - - -

self

the MatrixRoomMemberEvent instance to query

 
-
-
-

Returns

-

the value of the "avatar-url" property

-

-
-
-
-
-

matrix_room_member_event_set_avatar_url ()

-
void
-matrix_room_member_event_set_avatar_url
-                               (MatrixRoomMemberEvent *self,
-                                const gchar *value);
-

Set the value of the "avatar-url" property to value -.

-
-

Parameters

-
----- - - - - - - - - - - - - -

self

the MatrixRoomMemberEvent instance to modify

 

value

the new value of the "avatar-url" property

 
-
-
-
-
-

matrix_room_member_event_get_display_name ()

-
const gchar *
-matrix_room_member_event_get_display_name
-                               (MatrixRoomMemberEvent *self);
-

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

-
-

Parameters

-
----- - - - - - -

self

the MatrixRoomMemberEvent instance to query

 
-
-
-

Returns

-

the value of the "display-name" property

-

-
-
-
-
-

matrix_room_member_event_set_display_name ()

-
void
-matrix_room_member_event_set_display_name
-                               (MatrixRoomMemberEvent *self,
-                                const gchar *value);
-

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

-
-

Parameters

-
----- - - - - - - - - - - - - -

self

the MatrixRoomMemberEvent instance to modify

 

value

the new value of the "display-name" property

 
-
-
-
-
-

Types and Values

-
-

struct MatrixRoomMemberEvent

-
struct MatrixRoomMemberEvent {
-	MatrixRoomEvent parent_instance;
-	MatrixRoomMemberEventPrivate * priv;
-};
-
-

Class for representing a room membership events

-

The room membership event class.

-
-
-
-

struct MatrixRoomMemberEventClass

-
struct MatrixRoomMemberEventClass {
-	MatrixRoomEventClass parent_class;
-};
-
-

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

-
-

Members

-
----- - - - - - -

MatrixRoomEventClass parent_class;

the parent class structure

 
-
-
-
-
-
-
- Generated by GTK-Doc V1.20
- - \ No newline at end of file diff --git a/Matrix-0.0-MatrixRoomMessageEvent.html b/Matrix-0.0-MatrixRoomMessageEvent.html deleted file mode 100644 index a5aca61..0000000 --- a/Matrix-0.0-MatrixRoomMessageEvent.html +++ /dev/null @@ -1,288 +0,0 @@ - - - - -Matrix-0.0 Reference Manual: MatrixRoomMessageEvent - - - - - - - - - - - - - - - - -
-
-
- - -
-

MatrixRoomMessageEvent

-

MatrixRoomMessageEvent

-
-
-

Functions

-
---- - - - - - - - - - - - - - - - - - - - - - - - - - - -
#defineMATRIX_TYPE_ROOM_MESSAGE_EVENT
-MatrixRoomMessageEvent * - -matrix_room_message_event_new () -
const gchar * - -matrix_room_message_event_get_msg_type () -
-void - -matrix_room_message_event_set_msg_type () -
const gchar * - -matrix_room_message_event_get_body () -
-void - -matrix_room_message_event_set_body () -
-
-
-

Types and Values

-
---- - - - - - - - - - - -
structMatrixRoomMessageEvent
structMatrixRoomMessageEventClass
-
-
-

Object Hierarchy

-
-
-
-
-

Description

-
-
-

Functions

-
-

MATRIX_TYPE_ROOM_MESSAGE_EVENT

-
#define MATRIX_TYPE_ROOM_MESSAGE_EVENT (matrix_room_message_event_get_type ())
-
-

The type for MatrixRoomMessageEvent.

-
-
-
-

matrix_room_message_event_new ()

-
MatrixRoomMessageEvent *
-matrix_room_message_event_new (void);
-
-
-
-

matrix_room_message_event_get_msg_type ()

-
const gchar *
-matrix_room_message_event_get_msg_type
-                               (MatrixRoomMessageEvent *self);
-

Get and return the current value of the "msg-type" property.

-
-

Parameters

-
----- - - - - - -

self

the MatrixRoomMessageEvent instance to query

 
-
-
-

Returns

-

the value of the "msg-type" property

-

-
-
-
-
-

matrix_room_message_event_set_msg_type ()

-
void
-matrix_room_message_event_set_msg_type
-                               (MatrixRoomMessageEvent *self,
-                                const gchar *value);
-

Set the value of the "msg-type" property to value -.

-
-

Parameters

-
----- - - - - - - - - - - - - -

self

the MatrixRoomMessageEvent instance to modify

 

value

the new value of the "msg-type" property

 
-
-
-
-
-

matrix_room_message_event_get_body ()

-
const gchar *
-matrix_room_message_event_get_body (MatrixRoomMessageEvent *self);
-

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

-
-

Parameters

-
----- - - - - - -

self

the MatrixRoomMessageEvent instance to query

 
-
-
-

Returns

-

the value of the "body" property

-

-
-
-
-
-

matrix_room_message_event_set_body ()

-
void
-matrix_room_message_event_set_body (MatrixRoomMessageEvent *self,
-                                    const gchar *value);
-

Set the value of the "body" property to value -.

-
-

Parameters

-
----- - - - - - - - - - - - - -

self

the MatrixRoomMessageEvent instance to modify

 

value

the new value of the "body" property

 
-
-
-
-
-

Types and Values

-
-

struct MatrixRoomMessageEvent

-
struct MatrixRoomMessageEvent {
-	MatrixRoomEvent parent_instance;
-	MatrixRoomMessageEventPrivate * priv;
-};
-
-
-
-
-

struct MatrixRoomMessageEventClass

-
struct MatrixRoomMessageEventClass {
-	MatrixRoomEventClass parent_class;
-};
-
-

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

-
-

Members

-
----- - - - - - -

MatrixRoomEventClass parent_class;

the parent class structure

 
-
-
-
-
-
-
- Generated by GTK-Doc V1.20
- - \ No newline at end of file diff --git a/Matrix-0.0-MatrixStateEvent.html b/Matrix-0.0-MatrixStateEvent.html deleted file mode 100644 index fb581ab..0000000 --- a/Matrix-0.0-MatrixStateEvent.html +++ /dev/null @@ -1,287 +0,0 @@ - - - - -Matrix-0.0 Reference Manual: MatrixStateEvent - - - - - - - - - - - - - - - - -
-
-
- - -
-

MatrixStateEvent

-

MatrixStateEvent

-
-
-

Functions

-
---- - - - - - - - - - - - - - - - - - - - - - - - - - - -
#defineMATRIX_TYPE_STATE_EVENT
-MatrixStateEvent * - -matrix_state_event_new () -
const gchar * - -matrix_state_event_get_state_key () -
-void - -matrix_state_event_set_state_key () -
-JsonNode * - -matrix_state_event_get_content () -
-void - -matrix_state_event_set_content () -
-
-
-

Types and Values

-
---- - - - - - - - - - - -
structMatrixStateEvent
structMatrixStateEventClass
-
-
-

Object Hierarchy

-
-
-
-
-

Description

-
-
-

Functions

-
-

MATRIX_TYPE_STATE_EVENT

-
#define MATRIX_TYPE_STATE_EVENT (matrix_state_event_get_type ())
-
-

The type for MatrixStateEvent.

-
-
-
-

matrix_state_event_new ()

-
MatrixStateEvent *
-matrix_state_event_new (void);
-
-
-
-

matrix_state_event_get_state_key ()

-
const gchar *
-matrix_state_event_get_state_key (MatrixStateEvent *self);
-

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

-
-

Parameters

-
----- - - - - - -

self

the MatrixStateEvent instance to query

 
-
-
-

Returns

-

the value of the "state-key" property

-

-
-
-
-
-

matrix_state_event_set_state_key ()

-
void
-matrix_state_event_set_state_key (MatrixStateEvent *self,
-                                  const gchar *value);
-

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

-
-

Parameters

-
----- - - - - - - - - - - - - -

self

the MatrixStateEvent instance to modify

 

value

the new value of the "state-key" property

 
-
-
-
-
-

matrix_state_event_get_content ()

-
JsonNode *
-matrix_state_event_get_content (MatrixStateEvent *self);
-

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

-
-

Parameters

-
----- - - - - - -

self

the MatrixStateEvent instance to query

 
-
-
-

Returns

-

the value of the "content" property

-

-
-
-
-
-

matrix_state_event_set_content ()

-
void
-matrix_state_event_set_content (MatrixStateEvent *self,
-                                JsonNode *value);
-

Set the value of the "content" property to value -.

-
-

Parameters

-
----- - - - - - - - - - - - - -

self

the MatrixStateEvent instance to modify

 

value

the new value of the "content" property

 
-
-
-
-
-

Types and Values

-
-

struct MatrixStateEvent

-
struct MatrixStateEvent {
-	MatrixEvent parent_instance;
-	MatrixStateEventPrivate * priv;
-};
-
-
-
-
-

struct MatrixStateEventClass

-
struct MatrixStateEventClass {
-	MatrixEventClass parent_class;
-};
-
-

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

-
-

Members

-
----- - - - - - -

MatrixEventClass parent_class;

the parent class structure

 
-
-
-
-
-
-
- Generated by GTK-Doc V1.20
- - \ No newline at end of file diff --git a/Matrix-0.0-c-api.html b/Matrix-0.0-c-api.html deleted file mode 100644 index c1f17d0..0000000 --- a/Matrix-0.0-c-api.html +++ /dev/null @@ -1,54 +0,0 @@ - - - - -Matrix-0.0 Reference Manual: c-api - - - - - - - - - - - - - - - - -
-
-
- - -
-

c-api

-

c-api

-
-
-

Object Hierarchy

-
-
-
-
-

Description

-
-
-

Functions

-
-
-

Types and Values

-
-
-
-
- Generated by GTK-Doc V1.20
- - \ No newline at end of file diff --git a/Matrix-0.0-matrix-enums.html b/Matrix-0.0-matrix-enums.html deleted file mode 100644 index b77d5b7..0000000 --- a/Matrix-0.0-matrix-enums.html +++ /dev/null @@ -1,800 +0,0 @@ - - - - -Matrix-0.0 Reference Manual: matrix-enums - - - - - - - - - - - - - - - - -
-
-
- - -
-

matrix-enums

-

matrix-enums

-
-
-

Functions

-
---- - - - - -
-GQuark - -matrix_error_quark () -
-
-
-

Types and Values

-
---- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
enumMatrixAccountKind
enumMatrixEventDirection
enumMatrixEventFormat
enumMatrixPresence
enumMatrixPusherConditionKind
enumMatrixPusherKind
enumMatrixReceiptType
enumMatrixResizeMethod
enumMatrixRoomMembership
enumMatrixRoomPreset
enumMatrixRoomVisibility
enumMatrixSearchOrder
enumMatrixSearchKey
enumMatrixSearchGroupBy
enumMatrixError
-
-
-

Object Hierarchy

-
-
-
-
-

Description

-
-
-

Functions

-
-

matrix_error_quark ()

-
GQuark
-matrix_error_quark (void);
-
-
-
-

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 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_ROOM_ID

  

MATRIX_SEARCH_GROUP_BY_SENDER

  
-
-
-
-
-

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_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

  
-
-
-
-
-
-
- Generated by GTK-Doc V1.20
- - \ No newline at end of file diff --git a/Matrix-0.0-matrix-types.html b/Matrix-0.0-matrix-types.html new file mode 100644 index 0000000..d480845 --- /dev/null +++ b/Matrix-0.0-matrix-types.html @@ -0,0 +1,1910 @@ + + + + +matrix-types: Matrix-0.0 Reference Manual + + + + + + + + + + + + + + + + +
+
+
+ + +
+

matrix-types

+

matrix-types

+
+
+

Functions

+
++++ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+GQuark + +matrix_error_quark () +
+void + +matrix_file_info_set_from_json () +
+JsonNode * + +matrix_file_info_get_json_node () +
+MatrixFileInfo * + +matrix_file_info_dup () +
+void + +matrix_file_info_free () +
+void + +matrix_file_info_copy () +
+void + +matrix_file_info_destroy () +
+void + +matrix_image_info_set_from_json () +
+JsonNode * + +matrix_image_info_get_json_node () +
+MatrixImageInfo * + +matrix_image_info_dup () +
+void + +matrix_image_info_free () +
+void + +matrix_image_info_copy () +
+void + +matrix_image_info_destroy () +
+void + +matrix_audio_info_set_from_json () +
+JsonNode * + +matrix_audio_info_get_json_node () +
+MatrixAudioInfo * + +matrix_audio_info_dup () +
+void + +matrix_audio_info_free () +
+void + +matrix_audio_info_copy () +
+void + +matrix_audio_info_destroy () +
+void + +matrix_video_info_set_from_json () +
+JsonNode * + +matrix_video_info_get_json_node () +
+MatrixVideoInfo * + +matrix_video_info_dup () +
+void + +matrix_video_info_free () +
+void + +matrix_video_info_copy () +
+void + +matrix_video_info_destroy () +
+
+
+

Types and Values

+
++++ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
enumMatrixAccountKind
enumMatrixEventDirection
enumMatrixEventFormat
enumMatrixPresence
enumMatrixPusherConditionKind
enumMatrixPusherKind
enumMatrixReceiptType
enumMatrixResizeMethod
enumMatrixRoomMembership
enumMatrixRoomPreset
enumMatrixRoomVisibility
enumMatrixJoinRules
enumMatrixSearchOrder
enumMatrixSearchKey
enumMatrixSearchGroupBy
enumMatrixHistoryVisibility
enumMatrixGuestAccess
enumMatrixCallOfferType
enumMatrixCallAnswerType
enumMatrixError
structMatrixFileInfo
structMatrixImageInfo
structMatrixAudioInfo
structMatrixVideoInfo
+
+
+

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;
+};
+
+
+
+
+
+
Generated by GTK-Doc V1.24
+ + \ No newline at end of file diff --git a/Matrix-0.0.devhelp2 b/Matrix-0.0.devhelp2 new file mode 100644 index 0000000..48d494b --- /dev/null +++ b/Matrix-0.0.devhelp2 @@ -0,0 +1,773 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + diff --git a/annotation-glossary.html b/annotation-glossary.html index fa4140b..c6599ec 100644 --- a/annotation-glossary.html +++ b/annotation-glossary.html @@ -2,16 +2,16 @@ -Matrix-0.0 Reference Manual: Annotation Glossary +Annotation Glossary: Matrix-0.0 Reference Manual - + - +