Date: Fri Mar 4 16:17:42 2016 +0100 Initial commit for the current development version diff --git a/.gitignore b/.gitignore new file mode 100644 index 0000000..bd3f1fa --- /dev/null +++ b/.gitignore @@ -0,0 +1 @@ +/_site/ diff --git a/Matrix-0.0-MatrixAPI.html b/Matrix-0.0-MatrixAPI.html new file mode 100644 index 0000000..0997972 --- /dev/null +++ b/Matrix-0.0-MatrixAPI.html @@ -0,0 +1,6376 @@ + + + + +Matrix-0.0 Reference Manual: MatrixAPI + + + + + + + + + + + + + + + + +

+ + +

MatrixAPI

MatrixAPI — Base interface for all Client/Server API functionality.

Functions

+void +	+matrix_api_abort_pending () +
+void +	+matrix_api_media_download () +
+void +	+matrix_api_media_thumbnail () +
+void +	+matrix_api_media_upload () +
+void +	+matrix_api_get_presence_list () +
+void +	+matrix_api_update_presence_list () +
+void +	+matrix_api_get_user_presence () +
+void +	+matrix_api_set_user_presence () +
+void +	+matrix_api_update_pusher () +
+void +	+matrix_api_get_pushers () +
+void +	+matrix_api_delete_pusher () +
+void +	+matrix_api_get_pusher () +
+void +	+matrix_api_add_pusher () +
+void +	+matrix_api_toggle_pusher () +
+void +	+matrix_api_create_room () +
+void +	+matrix_api_delete_room_alias () +
+void +	+matrix_api_get_room_id () +
+void +	+matrix_api_create_room_alias () +
+void +	+matrix_api_list_public_rooms () +
+void +	+matrix_api_ban_user () +
+void +	+matrix_api_forget_room () +
+void +	+matrix_api_invite_user_3rdparty () +
+void +	+matrix_api_invite_user () +
+void +	+matrix_api_join_room () +
+void +	+matrix_api_leave_room () +
+void +	+matrix_api_event_stream () +
+void +	+matrix_api_get_event () +
+void +	+matrix_api_initial_sync () +
+void +	+matrix_api_get_event_context () +
+void +	+matrix_api_initial_sync_room () +
+void +	+matrix_api_list_room_members () +
+void +	+matrix_api_list_room_messages () +
+void +	+matrix_api_send_event_receipt () +
+void +	+matrix_api_redact_event () +
+void +	+matrix_api_send_message_event () +
+void +	+matrix_api_get_room_state () +
+void +	+matrix_api_send_room_event () +
+void +	+matrix_api_notify_room_typing () +
+void +	+matrix_api_sync () +
+void +	+matrix_api_create_filter () +
+void +	+matrix_api_download_filter () +
+void +	+matrix_api_search () +
+void +	+matrix_api_whois () +
+void +	+matrix_api_versions () +
+void +	+matrix_api_login () +
+void +	+matrix_api_token_refresh () +
+void +	+matrix_api_get_3pids () +
+void +	+matrix_api_add_3pid () +
+void +	+matrix_api_change_password () +
+void +	+matrix_api_get_profile () +
+void +	+matrix_api_get_avatar_url () +
+void +	+matrix_api_set_avatar_url () +
+void +	+matrix_api_get_display_name () +
+void +	+matrix_api_set_display_name () +
+void +	+matrix_api_register_account () +
+void +	+matrix_api_set_account_data () +
+void +	+matrix_api_get_room_tags () +
+void +	+matrix_api_delete_room_tag () +
+void +	+matrix_api_add_room_tag () +
+void +	+matrix_api_get_turn_server () +
+void +	+(*MatrixAPICallback) () +
const gchar * +	+matrix_api_get_token () +
+void +	+matrix_api_set_token () +
const gchar * +	+matrix_api_get_refresh_token () +
+void +	+matrix_api_set_refresh_token () +
const gchar * +	+matrix_api_get_user_id () +
const gchar * +	+matrix_api_get_homeserver () +

Types and Values

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

	MatrixAPI
struct	MatrixAPIIface

Object Hierarchy

Description

Functions

matrix_api_abort_pending ()

void
+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

+++++ + + + + + +

self

the MatrixAPI instance

matrix_api_media_download ()

void
+matrix_api_media_download (MatrixAPI *self,
+                           MatrixAPICallback callback,
+                           void *callback_target,
+                           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
+

+, implementations MUST throw Matrix.Error.INCOMPLETE.

Parameters

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

self	the MatrixAPI instance
callback	+ . + a function to call when the request is finished + . +	[in][allow-none]
callback_target	user data to pass to `callback` +.	[allow-none][closure]
callback_target_destroy_notify	function to call when `callback_target` +is no longer needed.	[allow-none]
server_name	+ . + the server name from the `mxc:` URI + . +	[in]
media_id	+ . + the media ID from the `mxc:` URI + . +	[in]
error	location to store the error occuring, or `NULL` to ignore.	[error-domains MatrixError]

matrix_api_media_thumbnail ()

void
+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);

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
+

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

Parameters

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

self	the MatrixAPI instance
callback	+ . + a function to call when the request is finished + . +	[in][allow-none]
callback_target	user data to pass to `callback` +.	[allow-none][closure]
callback_target_destroy_notify	function to call when `callback_target` +is no longer needed.	[allow-none]
server_name	+ . + the server name from the `mxc:` URI + . +	[in]
media_id	+ . + the media ID from the `mxc:` URI + . +	[in]
width
height
method
error	location to store the error occuring, or `NULL` to ignore.	[error-domains MatrixError]

matrix_api_media_upload ()

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

Upload some content to the content repository.

If param content is +

+null
+

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

Parameters

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

self	the MatrixAPI instance
callback_target	user data to pass to `callback` +.	[allow-none][closure]
callback_target_destroy_notify	function to call when `callback_target` +is no longer needed.	[allow-none]
content_type	+ . + the type of the content to be uploaded + . +	[in][allow-none]
content	+ . + the content to be uploaded + . +	[in][transfer full]
callback
error	location to store the error occuring, or `NULL` to ignore.	[error-domains MatrixError]

matrix_api_get_presence_list ()

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

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

If param user_id is +

+null
+

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

Parameters

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

self	the MatrixAPI instance
callback_target	user data to pass to `callback` +.	[allow-none][closure]
callback_target_destroy_notify	function to call when `callback_target` +is no longer needed.	[allow-none]
user_id	+ . + the user whose presence list should be retrieved + . +	[in]
callback
error	location to store the error occuring, or `NULL` to ignore.	[error-domains MatrixError]

matrix_api_update_presence_list ()

void
+matrix_api_update_presence_list (MatrixAPI *self,
+                                 MatrixAPICallback callback,
+                                 void *callback_target,
+                                 const gchar *user_id,
+                                 GList *drop_ids,
+                                 GList *invite_ids,
+                                 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
+

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

Parameters

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

self	the MatrixAPI instance
callback_target	user data to pass to `callback` +.	[allow-none][closure]
callback_target_destroy_notify	function to call when `callback_target` +is no longer needed.	[allow-none]
user_id	+ . + the user whose presence list is being modified + . +	[in]
drop_ids	+ . + a list of user IDs to remove from the list + . +	[in]
invite_ids	+ . + a list of user IDs to add to the list + . +	[in]
callback
error	location to store the error occuring, or `NULL` to ignore.	[error-domains MatrixError]

matrix_api_get_user_presence ()

void
+matrix_api_get_user_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
+

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

Parameters

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

self	the MatrixAPI instance
callback_target	user data to pass to `callback` +.	[allow-none][closure]
callback_target_destroy_notify	function to call when `callback_target` +is no longer needed.	[allow-none]
user_id	+ . + the user whose presence list is being modified + . +	[in]
callback
error	location to store the error occuring, or `NULL` to ignore.	[error-domains MatrixError]

matrix_api_set_user_presence ()

void
+matrix_api_set_user_presence (MatrixAPI *self,
+                              MatrixAPICallback callback,
+                              void *callback_target,
+                              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
+

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

Parameters

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

self	the MatrixAPI instance
callback_target	user data to pass to `callback` +.	[allow-none][closure]
callback_target_destroy_notify	function to call when `callback_target` +is no longer needed.	[allow-none]
user_id	+ . + the user whose presence list is being modified + . +	[in]
presence	+ . + the new presence state + . +	[in]
status_message	+ . + a status message attached to this state + . +	[in][allow-none]
callback
error	location to store the error occuring, or `NULL` to ignore.	[error-domains MatrixError]

matrix_api_update_pusher ()

void
+matrix_api_update_pusher (MatrixAPI *self,
+                          MatrixAPICallback callback,
+                          void *callback_target,
+                          MatrixPusher *pusher,
+                          GError **error);

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

If param pusher is +

+null
+

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

Parameters

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

self	the MatrixAPI instance
callback_target	user data to pass to `callback` +.	[allow-none][closure]
callback_target_destroy_notify	function to call when `callback_target` +is no longer needed.	[allow-none]
callback
pusher
error	location to store the error occuring, or `NULL` to ignore.	[error-domains MatrixError]

matrix_api_get_pushers ()

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

Retrieve all push rulesets.

Parameters

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

self	the MatrixAPI instance
callback_target	user data to pass to `callback` +.	[allow-none][closure]
callback_target_destroy_notify	function to call when `callback_target` +is no longer needed.	[allow-none]
callback
error	location to store the error occuring, or `NULL` to ignore.	[error-domains MatrixError]

matrix_api_delete_pusher ()

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

Delete a push rule.

If param scope or param rule_id is +

+null
+

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

Parameters

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

self	the MatrixAPI instance
callback	+ . + a function to call when the request is finished + . +	[in][allow-none]
callback_target	user data to pass to `callback` +.	[allow-none][closure]
callback_target_destroy_notify	function to call when `callback_target` +is no longer needed.	[allow-none]
scope	+ . + either + + + +global + + + + +to specify global rules, or + + + +device/<profile tag> + + + + +for rules for a given + + + +profile tag + + + + + + . +	[in]
kind	+ . + the kind of rule + . +	[in]
rule_id	+ . + an identifier for the rule + . +	[in]
error	location to store the error occuring, or `NULL` to ignore.	[error-domains MatrixError]

matrix_api_get_pusher ()

void
+matrix_api_get_pusher (MatrixAPI *self,
+                       MatrixAPICallback callback,
+                       void *callback_target,
+                       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
+

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

Parameters

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

self	the MatrixAPI instance
callback	+ . + a function to call when the request is finished + . +	[in][allow-none]
callback_target	user data to pass to `callback` +.	[allow-none][closure]
callback_target_destroy_notify	function to call when `callback_target` +is no longer needed.	[allow-none]
scope	+ . + either + + + +global + + + + +to specify global rules, or + + + +device/<profile tag> + + + + +for rules for a given + + + +profile tag + + + + +. + . +	[in]
kind	+ . + the kind of rule + . +	[in]
rule_id	+ . + an identifier for the rule + . +	[in]
error	location to store the error occuring, or `NULL` to ignore.	[error-domains MatrixError]

matrix_api_add_pusher ()

void
+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);

Add or change a push rule.

If either param scope, param rule_id or param actions are +

+null
+

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

Parameters

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

self	the MatrixAPI instance
callback	+ . + a function to call when the request is finished + . +	[in][allow-none]
callback_target	user data to pass to `callback` +.	[allow-none][closure]
callback_target_destroy_notify	function to call when `callback_target` +is no longer needed.	[allow-none]
scope	+ . + either + + + +global + + + + +to specify global rules, or + + + +device/<profile tag> + + + + +for rules for a given + + + +profile tag + + + + + + . +	[in]
kind	+ . + the kind of rule + . +	[in]
rule_id	+ . + an identifier for the rule + . +	[in]
before	+ . + make the new rule the next-most important than this rule ID + . +	[in][allow-none]
after	+ . + make the new rule the next-less important than this rule ID + . +	[in][allow-none]
actions	+ . + the actions to perform when the conditions for this rule are met + . +	[in]
conditions	+ . + 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]
error	location to store the error occuring, or `NULL` to ignore.	[error-domains MatrixError]

matrix_api_toggle_pusher ()

void
+matrix_api_toggle_pusher (MatrixAPI *self,
+                          MatrixAPICallback callback,
+                          void *callback_target,
+                          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.

Parameters

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

self	the MatrixAPI instance
callback	+ . + a function to call when the request is finished + . +	[in][allow-none]
callback_target	user data to pass to `callback` +.	[allow-none][closure]
callback_target_destroy_notify	function to call when `callback_target` +is no longer needed.	[allow-none]
scope	+ . + either + + + +global + + + + +to specify global rules, or + + + +device/<profile tag> + + + + +for rules for a given + + + +profile tag + + + + + + . +	[in]
kind	+ . + the kind of rule + . +	[in]
rule_id	+ . + an identifier for the rule + . +	[in]
enabled	+ . + if + + + +true + + + + +, the rule will be enabled, otherwise it gets disabled + . +	[in]
error	location to store the error occuring, or `NULL` to ignore.	[error-domains MatrixError]

matrix_api_create_room ()

void
+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,
+                        JsonNode *creation_content,
+                        GList *initial_state,
+                        GList *invitees,
+                        GList *invite_3pids,
+                        GError **error);

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

Parameters

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

self	the MatrixAPI instance
callback	+ . + the function to call when the request is finished + . +	[in][allow-none]
callback_target	user data to pass to `callback` +.	[allow-none][closure]
callback_target_destroy_notify	function to call when `callback_target` +is no longer needed.	[allow-none]
preset	+ . + a room preset to use + . +	[in]
room_name	+ . + the desired display name for the room + . +	[in][allow-none]
room_alias	+ . + an alias of the room + . +	[in][allow-none]
topic	+ . + the topic of the room + . +	[in][allow-none]
visibility	+ . + the initial visibility of the room + . +	[in]
creation_content	+ . + extra keys to be added to the content of m.room.create + . +	[in][allow-none]
initial_state	+ . + a list of state events to set in the new room + . +	[in][allow-none]
invitees	+ . + list of user IDs to invite to the new room + . +	[in][allow-none]
invite_3pids	+ . + a list of 3rd party credentials to invite to the new room + . +	[in][allow-none]
error	location to store the error occuring, or `NULL` to ignore.	[error-domains MatrixError]

matrix_api_delete_room_alias ()

void
+matrix_api_delete_room_alias (MatrixAPI *self,
+                              MatrixAPICallback callback,
+                              void *callback_target,
+                              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.

Parameters

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

self	the MatrixAPI instance
callback	+ . + the function to call when the request is finished + . +	[in][allow-none]
callback_target	user data to pass to `callback` +.	[allow-none][closure]
callback_target_destroy_notify	function to call when `callback_target` +is no longer needed.	[allow-none]
room_alias	+ . + the alias name to remove + . +	[in]
error	location to store the error occuring, or `NULL` to ignore.	[error-domains MatrixError]

matrix_api_get_room_id ()

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

Get the room ID corresponding to this room alias.

If param room_alias is +

+null
+

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

Parameters

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

self	the MatrixAPI instance
callback	+ . + the function to call when the request is finished + . +	[in][allow-none]
callback_target	user data to pass to `callback` +.	[allow-none][closure]
callback_target_destroy_notify	function to call when `callback_target` +is no longer needed.	[allow-none]
room_alias	+ . + the room alias + . +	[in]
error	location to store the error occuring, or `NULL` to ignore.	[error-domains MatrixError]

matrix_api_create_room_alias ()

void
+matrix_api_create_room_alias (MatrixAPI *self,
+                              MatrixAPICallback callback,
+                              void *callback_target,
+                              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
+

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

Parameters

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

self	the MatrixAPI instance
callback	+ . + the function to call when the request is finished + . +	[in][allow-none]
callback_target	user data to pass to `callback` +.	[allow-none][closure]
callback_target_destroy_notify	function to call when `callback_target` +is no longer needed.	[allow-none]
room_id	+ . + the room ID to add this alias to + . +	[in]
room_alias	+ . + the room alias to set + . +	[in]
error	location to store the error occuring, or `NULL` to ignore.	[error-domains MatrixError]

matrix_api_list_public_rooms ()

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

List the public rooms on the server.

Parameters

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

self	the MatrixAPI instance
callback	+ . + the function to call when the request is finished + . +	[in][allow-none]
callback_target	user data to pass to `callback` +.	[allow-none][closure]
callback_target_destroy_notify	function to call when `callback_target` +is no longer needed.	[allow-none]
error	location to store the error occuring, or `NULL` to ignore.	[error-domains MatrixError]

matrix_api_ban_user ()

void
+matrix_api_ban_user (MatrixAPI *self,
+                     MatrixAPICallback callback,
+                     void *callback_target,
+                     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
+

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

Parameters

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

self	the MatrixAPI instance
callback	+ . + the function to call when the request is finished + . +	[in][allow-none]
callback_target	user data to pass to `callback` +.	[allow-none][closure]
callback_target_destroy_notify	function to call when `callback_target` +is no longer needed.	[allow-none]
room_id	+ . + the room ID where the user should be banned + . +	[in]
user_id	+ . + the user ID to ban + . +	[in]
reason	+ . + the reason of the ban + . +	[in][allow-none]
error	location to store the error occuring, or `NULL` to ignore.	[error-domains MatrixError]

matrix_api_forget_room ()

void
+matrix_api_forget_room (MatrixAPI *self,
+                        MatrixAPICallback callback,
+                        void *callback_target,
+                        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
+

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

Parameters

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

self	the MatrixAPI instance
callback	+ . + the function to call when the request is finished + . +	[in][allow-none]
callback_target	user data to pass to `callback` +.	[allow-none][closure]
callback_target_destroy_notify	function to call when `callback_target` +is no longer needed.	[allow-none]
room_id	+ . + the room ID to forget + . +	[in]
error	location to store the error occuring, or `NULL` to ignore.	[error-domains MatrixError]

matrix_api_invite_user_3rdparty ()

void
+matrix_api_invite_user_3rdparty (MatrixAPI *self,
+                                 MatrixAPICallback callback,
+                                 void *callback_target,
+                                 const gchar *room_id,
+                                 Matrix3PidCredential *credential,
+                                 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
+

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

Parameters

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

self	the MatrixAPI instance
callback	+ . + the function to call when the request is finished + . +	[in][allow-none]
callback_target	user data to pass to `callback` +.	[allow-none][closure]
callback_target_destroy_notify	function to call when `callback_target` +is no longer needed.	[allow-none]
room_id	+ . + the room ID to which to invite the user + . +	[in]
credential	+ . + a Matrix3PidCredential that identifies a user to invite + . +	[in]
error	location to store the error occuring, or `NULL` to ignore.	[error-domains MatrixError]

matrix_api_invite_user ()

void
+matrix_api_invite_user (MatrixAPI *self,
+                        MatrixAPICallback callback,
+                        void *callback_target,
+                        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.

Parameters

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

self	the MatrixAPI instance
callback	+ . + the function to call when the request is finished + . +	[in][allow-none]
callback_target	user data to pass to `callback` +.	[allow-none][closure]
callback_target_destroy_notify	function to call when `callback_target` +is no longer needed.	[allow-none]
room_id	+ . + the room ID to invite the user to + . +	[in]
user_id	+ . + the user ID to invite + . +	[in]
error	location to store the error occuring, or `NULL` to ignore.	[error-domains MatrixError]

matrix_api_join_room ()

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

Join a room.

If param room_id is +

+null
+

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

Parameters

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

self	the MatrixAPI instance
callback	+ . + the function to call when the request is finished + . +	[in][allow-none]
callback_target	user data to pass to `callback` +.	[allow-none][closure]
callback_target_destroy_notify	function to call when `callback_target` +is no longer needed.	[allow-none]
room_id	+ . + the room ID to join to + . +	[in]
error	location to store the error occuring, or `NULL` to ignore.	[error-domains MatrixError]

matrix_api_leave_room ()

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

Leave a room.

If param room_id is +

+null
+

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

Parameters

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

self	the MatrixAPI instance
callback	+ . + the function to call when the request is finished + . +	[in][allow-none]
callback_target	user data to pass to `callback` +.	[allow-none][closure]
callback_target_destroy_notify	function to call when `callback_target` +is no longer needed.	[allow-none]
room_id	+ . + the room ID to kick the user from + . +	[in]
error	location to store the error occuring, or `NULL` to ignore.	[error-domains MatrixError]

matrix_api_event_stream ()

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

Get the event stream, optionally beginning from from_token +.

Parameters

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

self	the MatrixAPI instance
callback	+ . + the function to call when the request is finished + . +	[in][allow-none]
callback_target	user data to pass to `callback` +.	[allow-none][closure]
callback_target_destroy_notify	function to call when `callback_target` +is no longer needed.	[allow-none]
from_token	+ . + events will be listed from this token + . +	[in][allow-none]
timeout	+ . + timeout of the request + . +	[in]
error	location to store the error occuring, or `NULL` to ignore.	[error-domains MatrixError]

matrix_api_get_event ()

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

Get a single event by event ID.

If param event_id is +

+null
+

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

Parameters

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

self	the MatrixAPI instance
callback	+ . + the function to call when the request is finished + . +	[in][allow-none]
callback_target	user data to pass to `callback` +.	[allow-none][closure]
callback_target_destroy_notify	function to call when `callback_target` +is no longer needed.	[allow-none]
event_id	+ . + the event ID to get + . +	[in]
error	location to store the error occuring, or `NULL` to ignore.	[error-domains MatrixError]

matrix_api_initial_sync ()

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

Perform an initial sync of events

Parameters

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

self	the MatrixAPI instance
callback	+ . + the function to call when the request is finished + . +	[in][allow-none]
callback_target	user data to pass to `callback` +.	[allow-none][closure]
callback_target_destroy_notify	function to call when `callback_target` +is no longer needed.	[allow-none]
limit	+ . + the maximum number of events to get + . +	[in]
archived	+ . + whether to include rooms that the user has left + . +	[in]
error	location to store the error occuring, or `NULL` to ignore.	[error-domains MatrixError]

matrix_api_get_event_context ()

void
+matrix_api_get_event_context (MatrixAPI *self,
+                              MatrixAPICallback callback,
+                              void *callback_target,
+                              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
+

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

Parameters

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

self	the MatrixAPI instance
callback	+ . + the function to call when the request is finished + . +	[in][allow-none]
callback_target	user data to pass to `callback` +.	[allow-none][closure]
callback_target_destroy_notify	function to call when `callback_target` +is no longer needed.	[allow-none]
room_id	+ . + the room to get events from + . +	[in]
event_id	+ . + the event to get context around + . +	[in]
limit	+ . + the maximum number of events to get. If 0, a default value is used (10, according to the specification) + . +	[in]
error	location to store the error occuring, or `NULL` to ignore.	[error-domains MatrixError]

matrix_api_initial_sync_room ()

void
+matrix_api_initial_sync_room (MatrixAPI *self,
+                              MatrixAPICallback callback,
+                              void *callback_target,
+                              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
+

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

Parameters

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

self	the MatrixAPI instance
callback	+ . + the function to call when the request is finished + . +	[in][allow-none]
callback_target	user data to pass to `callback` +.	[allow-none][closure]
callback_target_destroy_notify	function to call when `callback_target` +is no longer needed.	[allow-none]
room_id	+ . + the room to get the data for + . +	[in]
error	location to store the error occuring, or `NULL` to ignore.	[error-domains MatrixError]

matrix_api_list_room_members ()

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

Get the list of members for a room.

If param room_id is +

+null
+

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

Parameters

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

self	the MatrixAPI instance
callback	+ . + the function to call when the request is finished + . +	[in][allow-none]
callback_target	user data to pass to `callback` +.	[allow-none][closure]
callback_target_destroy_notify	function to call when `callback_target` +is no longer needed.	[allow-none]
room_id	+ . + the room to get the member events for + . +	[in]
error	location to store the error occuring, or `NULL` to ignore.	[error-domains MatrixError]

matrix_api_list_room_messages ()

void
+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);

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

If param room_id or param from_token is +

+null
+

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

Parameters

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

self	the MatrixAPI instance
callback	+ . + the function to call when the request is finished + . +	[in][allow-none]
callback_target	user data to pass to `callback` +.	[allow-none][closure]
callback_target_destroy_notify	function to call when `callback_target` +is no longer needed.	[allow-none]
room_id	+ . + the room to get the events for + . +	[in]
from_token	+ . + the token to start returning events from. This token can be obtained by calling `matrix_api_initial_sync()` or `matrix_api_initial_sync_room()` + . +	[in]
direction	+ . + the direction of the returned events + . +	[in]
limit	+ . + the maximum number of events to return. If 0, a default value will be used (10, according to the specification + . +	[in]
error	location to store the error occuring, or `NULL` to ignore.	[error-domains MatrixError]

matrix_api_send_event_receipt ()

void
+matrix_api_send_event_receipt (MatrixAPI *self,
+                               MatrixAPICallback callback,
+                               void *callback_target,
+                               const gchar *room_id,
+                               MatrixReceiptType receipt_type,
+                               const gchar *event_id,
+                               JsonNode *receipt,
+                               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
+

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

Parameters

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

self	the MatrixAPI instance
callback	+ . + the function to call when the request is finished + . +	[in][allow-none]
callback_target	user data to pass to `callback` +.	[allow-none][closure]
callback_target_destroy_notify	function to call when `callback_target` +is no longer needed.	[allow-none]
room_id	+ . + the room in which to send the event + . +	[in]
receipt_type	+ . + type of the receipt + . +	[in]
event_id	+ . + the event ID to acknowledge up to + . +	[in]
receipt	+ . + extra receipt information to attach. Note that the server will automatically attach the + + + +ts + + + + +field + . +	[in]
error	location to store the error occuring, or `NULL` to ignore.	[error-domains MatrixError]

matrix_api_redact_event ()

void
+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);

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
+

+ power level of the room may redact events there.

If param room_id, param event_id or param txn_id is +

+null
+

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

Parameters

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

self	the MatrixAPI instance
callback	+ . + the function to call when the request is finished + . +	[in][allow-none]
callback_target	user data to pass to `callback` +.	[allow-none][closure]
callback_target_destroy_notify	function to call when `callback_target` +is no longer needed.	[allow-none]
room_id	+ . + the room from which to redact the event + . +	[in]
event_id	+ . + the event ID to acknowledge up to + . +	[in]
txn_id	+ . + the transaction ID for this event. Clients should generate a unique ID; it will be used by the server to ensure idempotency of requests + . +	[in]
reason	+ . + the reason for the event being redacted + . +	[in][allow-none]
error	location to store the error occuring, or `NULL` to ignore.	[error-domains MatrixError]

matrix_api_send_message_event ()

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

Send a message event to the room.

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

+null
+

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

Parameters

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

self	the MatrixAPI instance
callback	+ . + the function to call when the request is finished + . +	[in][allow-none]
callback_target	user data to pass to `callback` +.	[allow-none][closure]
callback_target_destroy_notify	function to call when `callback_target` +is no longer needed.	[allow-none]
room_id	+ . + the room to send the event to + . +	[in]
event_type	+ . + the type of event to send + . +	[in]
txn_id	+ . + the transaction ID for this event. Clients should generate a unique ID; it will be used by the server to ensure idempotency of requests + . +	[in]
content	+ . + the content of the event as a JsonNode + . +	[in][transfer full]
error	location to store the error occuring, or `NULL` to ignore.	[error-domains MatrixError]

matrix_api_get_room_state ()

void
+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);

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
+

+, or if param state_key is set with param event_type being +

+null
+

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

Parameters

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

self	the MatrixAPI instance
callback	+ . + the function to call when the request is finished + . +	[in][allow-none]
callback_target	user data to pass to `callback` +.	[allow-none][closure]
callback_target_destroy_notify	function to call when `callback_target` +is no longer needed.	[allow-none]
room_id	+ . + the room ID to get a state for + . +	[in]
event_type	+ . + the type of state to look up + . +	[in][allow-none]
state_key	+ . + the key of the state to look up. If `param` +event_type is + + + +null + + + + +, this parameter is ignored + . +	[in][allow-none]
error	location to store the error occuring, or `NULL` to ignore.	[error-domains MatrixError]

matrix_api_send_room_event ()

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

Send a state event to the room. These events will be overwritten if param + room_id, param + event_type and param + state_key all match.

This request cannot use transaction IDs.

The required fields in the body of the request (param content) vary depending on the type of the event.

If param room_id or param content is +

+null
+

+, or if param + state_key is set with param + event_type being

+null
+

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

Parameters

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

self	the MatrixAPI instance
callback	+ . + the function to call when the request is finished + . +	[in][allow-none]
callback_target	user data to pass to `callback` +.	[allow-none][closure]
callback_target_destroy_notify	function to call when `callback_target` +is no longer needed.	[allow-none]
room_id	+ . + the room ID to get a state for + . +	[in]
event_type	+ . + the type of state to look up + . +	[in]
state_key	+ . + the key of the state to look up. If `param` +event_type is + + + +null + + + + +, this parameter is ignored + . +	[in][allow-none]
content	+ . + the content of the state event + . +	[in][transfer full]
error	location to store the error occuring, or `NULL` to ignore.	[error-domains MatrixError]

matrix_api_notify_room_typing ()

void
+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);

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

+false
+

+, it tells the server that the user stopped typing.

If param user_id or param room_id is +

+null
+

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

Parameters

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

self	the MatrixAPI instance
callback	+ . + the function to call when the request is finished + . +	[in][allow-none]
callback_target	user data to pass to `callback` +.	[allow-none][closure]
callback_target_destroy_notify	function to call when `callback_target` +is no longer needed.	[allow-none]
user_id	+ . + the user who has started to type + . +	[in]
room_id	+ . + the room in which the user is typing + . +	[in]
timeout	+ . + the length of time in milliseconds to mark this user as typing + . +	[in]
typing	+ . + whether the user is typing or not. If + + + +false + + + + +, `param` +timeout can be omitted (ie. set to 0) + . +	[in]
error	location to store the error occuring, or `NULL` to ignore.	[error-domains MatrixError]

matrix_api_sync ()

void
+matrix_api_sync (MatrixAPI *self,
+                 MatrixAPICallback callback,
+                 void *callback_target,
+                 const gchar *filter_id,
+                 MatrixFilter *filter,
+                 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
+

+ to receive all events.

Parameters

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

self	the MatrixAPI instance
callback	+ . + the function to call when the request is finished + . +	[in][allow-none]
callback_target	user data to pass to `callback` +.	[allow-none][closure]
callback_target_destroy_notify	function to call when `callback_target` +is no longer needed.	[allow-none]
filter_id	+ . + a filter ID created by the filter API (e.g. `matrix_api_create_filter()`) + . +	[in][allow-none]
filter	+ . + a definition on what events to fetch + . +	[in][allow-none]
since	+ . + a point in time to continue a sync from + . +	[in][allow-none]
full_state	+ . + if + + + +true + + + + +, all state events will be returned, even if `param` +since is not empty. If + + + +false + + + + +, and `param` +since is not empty, only states which have changed since the point indicated by `param` +since will be returned + . +	[in]
set_presence	+ . + controls whether the client is automatically marked as online by polling this API. + . +	[in]
timeout	+ . + the maximum time to poll in milliseconds + . +	[in]
error	location to store the error occuring, or `NULL` to ignore.	[error-domains MatrixError]

matrix_api_create_filter ()

void
+matrix_api_create_filter (MatrixAPI *self,
+                          MatrixAPICallback callback,
+                          void *callback_target,
+                          const gchar *user_id,
+                          MatrixFilter *filter,
+                          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
+

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

Parameters

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

self	the MatrixAPI instance
callback	+ . + the function to call when the request is finished + . +	[in][allow-none]
callback_target	user data to pass to `callback` +.	[allow-none][closure]
callback_target_destroy_notify	function to call when `callback_target` +is no longer needed.	[allow-none]
user_id	+ . + the ID of the user uploading the filter. An access token must be present (either specifying one with `matrix_api_set_token()` or requested from the server via `matrix_api_register_account()` or `matrix_api_login()`). + . +	[in]
filter	+ . + the filter to upload + . +	[in]
error	location to store the error occuring, or `NULL` to ignore.	[error-domains MatrixError]

matrix_api_download_filter ()

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

Download a filter.

If param user_id or param filter_id is +

+null
+

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

Parameters

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

self	the MatrixAPI instance
callback	+ . + the function to call when the request is finished + . +	[in][allow-none]
callback_target	user data to pass to `callback` +.	[allow-none][closure]
callback_target_destroy_notify	function to call when `callback_target` +is no longer needed.	[allow-none]
user_id	+ . + the user ID to download a filter from + . +	[in]
filter_id	+ . + the filter ID to download + . +	[in]
error	location to store the error occuring, or `NULL` to ignore.	[error-domains MatrixError]

matrix_api_search ()

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

Perform a server side search.

Parameters

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

self	the MatrixAPI instance
callback_target	user data to pass to `callback` +.	[allow-none][closure]
callback_target_destroy_notify	function to call when `callback_target` +is no longer needed.	[allow-none]
next_batch	+ . + the point to return events from. If given, this should be a next_batch result from a previous call to this method + . +	[in][allow-none]
search_categories	+ . + describes which categories to search, and their criteria + . +	[in]
callback
error	location to store the error occuring, or `NULL` to ignore.	[error-domains MatrixError]

matrix_api_whois ()

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

Get information about a particular user.

If param user_id is +

+null
+

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

Parameters

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

self	the MatrixAPI instance
callback	+ . + the function to call when the request is finished + . +	[in][allow-none]
callback_target	user data to pass to `callback` +.	[allow-none][closure]
callback_target_destroy_notify	function to call when `callback_target` +is no longer needed.	[allow-none]
user_id	+ . + the user ID to look up + . +	[in]
error	location to store the error occuring, or `NULL` to ignore.	[error-domains MatrixError]

matrix_api_versions ()

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

Get the versions of the specification supported by the server.

Parameters

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

self	the MatrixAPI instance
callback	+ . + the function to call when the request is finished + . +	[in][allow-none]
callback_target	user data to pass to `callback` +.	[allow-none][closure]
callback_target_destroy_notify	function to call when `callback_target` +is no longer needed.	[allow-none]
error	location to store the error occuring, or `NULL` to ignore.	[error-domains MatrixError]

matrix_api_login ()

void
+matrix_api_login (MatrixAPI *self,
+                  MatrixAPICallback callback,
+                  void *callback_target,
+                  const gchar *login_type,
+                  JsonNode *content,
+                  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
+

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

Parameters

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

self	the MatrixAPI instance
callback	+ . + the function to call when the request is finished + . +	[in][allow-none]
callback_target	user data to pass to `callback` +.	[allow-none][closure]
callback_target_destroy_notify	function to call when `callback_target` +is no longer needed.	[allow-none]
login_type	+ . + the login type to use + . +	[in]
content	+ . + parameters to pass for the login request + . +	[in][allow-none]
error	location to store the error occuring, or `NULL` to ignore.	[error-domains MatrixError]

matrix_api_token_refresh ()

void
+matrix_api_token_refresh (MatrixAPI *self,
+                          MatrixAPICallback callback,
+                          void *callback_target,
+                          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
+

+, 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

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

self	the MatrixAPI instance
callback	+ . + the function to call when the request is finished + . +	[in][allow-none]
callback_target	user data to pass to `callback` +.	[allow-none][closure]
callback_target_destroy_notify	function to call when `callback_target` +is no longer needed.	[allow-none]
refresh_token	+ . + the refresh token that was issued by the server + . +	[in][allow-none]
error	location to store the error occuring, or `NULL` to ignore.	[error-domains MatrixError]

matrix_api_get_3pids ()

void
+matrix_api_get_3pids (MatrixAPI *self,
+                      MatrixAPICallback callback,
+                      void *callback_target,
+                      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

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

self	the MatrixAPI instance
callback	+ . + the function to call when the request is finished + . +	[in][allow-none]
callback_target	user data to pass to `callback` +.	[allow-none][closure]
callback_target_destroy_notify	function to call when `callback_target` +is no longer needed.	[allow-none]
error	location to store the error occuring, or `NULL` to ignore.	[error-domains MatrixError]

matrix_api_add_3pid ()

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

Add contact information to the user's account.

If param threepid_creds is +

+null
+

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

Parameters

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

self	the MatrixAPI instance
callback	+ . + the function to call when the request is finished + . +	[in][allow-none]
callback_target	user data to pass to `callback` +.	[allow-none][closure]
callback_target_destroy_notify	function to call when `callback_target` +is no longer needed.	[allow-none]
bind_creds	+ . + whether the homeserver should also bind this third party identifier to the account's Matrix ID with the passed Identity Server. + . +	[in]
threepid_creds	+ . + the credentials to associate with the account + . +	[in]
error	location to store the error occuring, or `NULL` to ignore.	[error-domains MatrixError]

matrix_api_change_password ()

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

Change the active user's password.

If param new_password is +

+null
+

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

Parameters

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

self	the MatrixAPI instance
callback	+ . + the function to call when the request is finished + . +	[in][allow-none]
callback_target	user data to pass to `callback` +.	[allow-none][closure]
callback_target_destroy_notify	function to call when `callback_target` +is no longer needed.	[allow-none]
new_password	+ . + the new password for the account + . +	[in]
error	location to store the error occuring, or `NULL` to ignore.	[error-domains MatrixError]

matrix_api_get_profile ()

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

Get a user's profile.

If param user_id is +

+null
+

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

Parameters

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

self	the MatrixAPI instance
callback	+ . + the function to call when the request is finished + . +	[in][allow-none]
callback_target	user data to pass to `callback` +.	[allow-none][closure]
callback_target_destroy_notify	function to call when `callback_target` +is no longer needed.	[allow-none]
user_id	+ . + the user whose profile to get + . +	[in]
error	location to store the error occuring, or `NULL` to ignore.	[error-domains MatrixError]

matrix_api_get_avatar_url ()

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

Get the URL of the specified user's avatar.

If param user_id is +

+null
+

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

Parameters

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

self	the MatrixAPI instance
callback	+ . + the function to call when the request is finished + . +	[in][allow-none]
callback_target	user data to pass to `callback` +.	[allow-none][closure]
callback_target_destroy_notify	function to call when `callback_target` +is no longer needed.	[allow-none]
user_id	+ . + the user whose avatar URL to get + . +	[in]
error	location to store the error occuring, or `NULL` to ignore.	[error-domains MatrixError]

matrix_api_set_avatar_url ()

void
+matrix_api_set_avatar_url (MatrixAPI *self,
+                           MatrixAPICallback callback,
+                           void *callback_target,
+                           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
+

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

Parameters

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

self	the MatrixAPI instance
callback	+ . + the function to call when the request is finished + . +	[in][allow-none]
callback_target	user data to pass to `callback` +.	[allow-none][closure]
callback_target_destroy_notify	function to call when `callback_target` +is no longer needed.	[allow-none]
user_id	+ . + the user whose avatar URL to set + . +	[in]
avatar_url	+ . + the avatar URL info + . +	[in]
error	location to store the error occuring, or `NULL` to ignore.	[error-domains MatrixError]

matrix_api_get_display_name ()

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

Get the user's display name.

If param user_id is +

+null
+

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

Parameters

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

self	the MatrixAPI instance
callback	+ . + the function to call when the request is finished + . +	[in][allow-none]
callback_target	user data to pass to `callback` +.	[allow-none][closure]
callback_target_destroy_notify	function to call when `callback_target` +is no longer needed.	[allow-none]
user_id	+ . + the user whose display name to get + . +	[in]
error	location to store the error occuring, or `NULL` to ignore.	[error-domains MatrixError]

matrix_api_set_display_name ()

void
+matrix_api_set_display_name (MatrixAPI *self,
+                             MatrixAPICallback callback,
+                             void *callback_target,
+                             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
+

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

Parameters

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

self	the MatrixAPI instance
callback	+ . + the function to call when the request is finished + . +	[in][allow-none]
callback_target	user data to pass to `callback` +.	[allow-none][closure]
callback_target_destroy_notify	function to call when `callback_target` +is no longer needed.	[allow-none]
user_id	+ . + the user whose display name to set + . +	[in]
display_name	+ . + the display name info + . +	[in]
error	location to store the error occuring, or `NULL` to ignore.	[error-domains MatrixError]

matrix_api_register_account ()

void
+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);

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
+

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

Parameters

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

self	the MatrixAPI instance
callback	+ . + the function to call when the request is finished + . +	[in][allow-none]
callback_target	user data to pass to `callback` +.	[allow-none][closure]
callback_target_destroy_notify	function to call when `callback_target` +is no longer needed.	[allow-none]
account_kind	+ . + the type of account to register + . +	[in]
bind_email	+ . + if + + + +true + + + + +, the server binds the e-mail used for authentication to the Matrix ID with the ID server + . +	[in]
username	+ . + the local part of the desired Matrix ID. If omitted, the server will generate a local part + . +	[in][allow-none]
password	+ . + the desired password for the account + . +	[in]
error	location to store the error occuring, or `NULL` to ignore.	[error-domains MatrixError]

matrix_api_set_account_data ()

void
+matrix_api_set_account_data (MatrixAPI *self,
+                             MatrixAPICallback callback,
+                             void *callback_target,
+                             const gchar *user_id,
+                             const gchar *room_id,
+                             const gchar *event_type,
+                             JsonNode *content,
+                             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
+

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

Parameters

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

self	the MatrixAPI instance
callback	+ . + the function to call when the request is finished + . +	[in][allow-none]
callback_target	user data to pass to `callback` +.	[allow-none][closure]
callback_target_destroy_notify	function to call when `callback_target` +is no longer needed.	[allow-none]
user_id	+ . + the user to set account data for. An access token must be present and be authorized to make requests for this user ID + . +	[in]
room_id	+ . + the room to set account data for. If + + + +null + + + + +, the account data will be set globally + . +	[in][allow-none]
event_type	+ . + the event type of the account data to set. Custom types should be namespaced to avoid clashes + . +	[in]
content	+ . + the content of the account data + . +	[in][transfer full]
error	location to store the error occuring, or `NULL` to ignore.	[error-domains MatrixError]

matrix_api_get_room_tags ()

void
+matrix_api_get_room_tags (MatrixAPI *self,
+                          MatrixAPICallback callback,
+                          void *callback_target,
+                          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
+

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

Parameters

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

self	the MatrixAPI instance
callback	+ . + the function to call when the request is finished + . +	[in][allow-none]
callback_target	user data to pass to `callback` +.	[allow-none][closure]
callback_target_destroy_notify	function to call when `callback_target` +is no longer needed.	[allow-none]
user_id	+ . + the ID of the user to get the tags for. An access token must be set, and it must be authorised to make requests for this user ID + . +	[in]
room_id	+ . + the room to get tags for + . +	[in]
error	location to store the error occuring, or `NULL` to ignore.	[error-domains MatrixError]

matrix_api_delete_room_tag ()

void
+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);

Remove a tag from the room.

If param user_id, param room_id or param tag is +

+null
+

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

Parameters

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

self	the MatrixAPI instance
callback	+ . + the function to call when the request is finished + . +	[in][allow-none]
callback_target	user data to pass to `callback` +.	[allow-none][closure]
callback_target_destroy_notify	function to call when `callback_target` +is no longer needed.	[allow-none]
user_id	+ . + the id of the user to remove a tag for + . +	[in]
room_id	+ . + the id of the room to remove the tag from + . +	[in]
tag	+ . + the tag to remove + . +	[in]
error	location to store the error occuring, or `NULL` to ignore.	[error-domains MatrixError]

matrix_api_add_room_tag ()

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

Add a tag to the room.

If param user_id, param room_id or param tag is +

+null
+

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

Parameters

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

self	the MatrixAPI instance
callback	+ . + the function to call when the request is finished + . +	[in][allow-none]
callback_target	user data to pass to `callback` +.	[allow-none][closure]
callback_target_destroy_notify	function to call when `callback_target` +is no longer needed.	[allow-none]
user_id	+ . + the ID of the user to add the tag for + . +	[in]
room_id	+ . + the ID of the room to add the tag for + . +	[in]
tag	+ . + the tag to add + . +	[in]
content	+ . + extra data for the tag, e.g. ordering + . +	[in][allow-none][transfer full]
error	location to store the error occuring, or `NULL` to ignore.	[error-domains MatrixError]

matrix_api_get_turn_server ()

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

Get credentials for the client to use when initiating calls.

Parameters

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

self	the MatrixAPI instance
callback	+ . + the function to call when the request is finished + . +	[in][allow-none]
callback_target	user data to pass to `callback` +.	[allow-none][closure]
callback_target_destroy_notify	function to call when `callback_target` +is no longer needed.	[allow-none]
error	location to store the error occuring, or `NULL` to ignore.	[error-domains MatrixError]

MatrixAPICallback ()

void
+(*MatrixAPICallback) (MatrixAPI *api,
+                      const gchar *content_type,
+                      JsonNode *json_content,
+                      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
+

+ and raw_content + holds the content body.

Parameters

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

api	+ . + a Matrix.API instance + . +	[in]
content_type	+ . + the content type of the response + . +	[in]
json_content	+ . + the JSON content of the response + . +	[in][allow-none]
raw_content	+ . + the raw (ie. binary) content of the response + . +	[in][allow-none]
err	+ . + a GLib.Error that holds any errors that occured during the API call, or + + + +null + + + + + + . +	[in][allow-none]
user_data	data to pass to the delegate function.	[closure]

matrix_api_get_token ()

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

+++++ + + + + + +

self

the MatrixAPI instance to query

Returns

the value of the "token" property

matrix_api_set_token ()

void
+matrix_api_set_token (MatrixAPI *self,
+                      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

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

self	the MatrixAPI instance to modify
value	the new value of the "token" property

matrix_api_get_refresh_token ()

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

+++++ + + + + + +

self

the MatrixAPI instance to query

Returns

the value of the "refresh-token" property

matrix_api_set_refresh_token ()

void
+matrix_api_set_refresh_token (MatrixAPI *self,
+                              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

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

self	the MatrixAPI instance to modify
value	the new value of the "refresh-token" property

matrix_api_get_user_id ()

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

+++++ + + + + + +

self

the MatrixAPI instance to query

Returns

the value of the "user-id" property

matrix_api_get_homeserver ()

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

+++++ + + + + + +

self

the MatrixAPI instance to query

Returns

the value of the "homeserver" property

Types and Values

MatrixAPI

typedef struct _MatrixAPI MatrixAPI;

Base interface for all Client/Server API functionality.

struct MatrixAPIIface

struct MatrixAPIIface {
+	GTypeInterface parent_iface;
+	void (*abort_pending) (MatrixAPI* self);
+	void (*media_download) (MatrixAPI* self, MatrixAPICallback callback, void* callback_target, const gchar* server_name, const gchar* media_id, GError** error);
+	void (*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);
+	void (*media_upload) (MatrixAPI* self, MatrixAPICallback callback, void* callback_target, const gchar* content_type, GByteArray* content, GError** error);
+	void (*get_presence_list) (MatrixAPI* self, MatrixAPICallback callback, void* callback_target, const gchar* user_id, GError** error);
+	void (*update_presence_list) (MatrixAPI* self, MatrixAPICallback callback, void* callback_target, const gchar* user_id, GList* drop_ids, GList* invite_ids, GError** error);
+	void (*get_user_presence) (MatrixAPI* self, MatrixAPICallback callback, void* callback_target, const gchar* user_id, GError** error);
+	void (*set_user_presence) (MatrixAPI* self, MatrixAPICallback callback, void* callback_target, const gchar* user_id, MatrixPresence presence, const gchar* status_message, GError** error);
+	void (*update_pusher) (MatrixAPI* self, MatrixAPICallback callback, void* callback_target, MatrixPusher* pusher, GError** error);
+	void (*get_pushers) (MatrixAPI* self, MatrixAPICallback callback, void* callback_target, GError** error);
+	void (*delete_pusher) (MatrixAPI* self, MatrixAPICallback callback, void* callback_target, const gchar* scope, MatrixPusherKind kind, const gchar* rule_id, GError** error);
+	void (*get_pusher) (MatrixAPI* self, MatrixAPICallback callback, void* callback_target, const gchar* scope, MatrixPusherKind kind, const gchar* rule_id, GError** error);
+	void (*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);
+	void (*toggle_pusher) (MatrixAPI* self, MatrixAPICallback callback, void* callback_target, const gchar* scope, MatrixPusherKind kind, const gchar* rule_id, gboolean enabled, GError** error);
+	void (*create_room) (MatrixAPI* self, MatrixAPICallback callback, void* callback_target, 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);
+	void (*delete_room_alias) (MatrixAPI* self, MatrixAPICallback callback, void* callback_target, const gchar* room_alias, GError** error);
+	void (*get_room_id) (MatrixAPI* self, MatrixAPICallback callback, void* callback_target, const gchar* room_alias, GError** error);
+	void (*create_room_alias) (MatrixAPI* self, MatrixAPICallback callback, void* callback_target, const gchar* room_id, const gchar* room_alias, GError** error);
+	void (*list_public_rooms) (MatrixAPI* self, MatrixAPICallback callback, void* callback_target, GError** error);
+	void (*ban_user) (MatrixAPI* self, MatrixAPICallback callback, void* callback_target, const gchar* room_id, const gchar* user_id, const gchar* reason, GError** error);
+	void (*forget_room) (MatrixAPI* self, MatrixAPICallback callback, void* callback_target, const gchar* room_id, GError** error);
+	void (*invite_user_3rdparty) (MatrixAPI* self, MatrixAPICallback callback, void* callback_target, const gchar* room_id, Matrix3PidCredential* credential, GError** error);
+	void (*invite_user) (MatrixAPI* self, MatrixAPICallback callback, void* callback_target, const gchar* room_id, const gchar* user_id, GError** error);
+	void (*join_room) (MatrixAPI* self, MatrixAPICallback callback, void* callback_target, const gchar* room_id, GError** error);
+	void (*leave_room) (MatrixAPI* self, MatrixAPICallback callback, void* callback_target, const gchar* room_id, GError** error);
+	void (*event_stream) (MatrixAPI* self, MatrixAPICallback callback, void* callback_target, const gchar* from_token, gulong timeout, GError** error);
+	void (*get_event) (MatrixAPI* self, MatrixAPICallback callback, void* callback_target, const gchar* event_id, GError** error);
+	void (*initial_sync) (MatrixAPI* self, MatrixAPICallback callback, void* callback_target, guint limit, gboolean archived, GError** error);
+	void (*get_event_context) (MatrixAPI* self, MatrixAPICallback callback, void* callback_target, const gchar* room_id, const gchar* event_id, guint limit, GError** error);
+	void (*initial_sync_room) (MatrixAPI* self, MatrixAPICallback callback, void* callback_target, const gchar* room_id, GError** error);
+	void (*list_room_members) (MatrixAPI* self, MatrixAPICallback callback, void* callback_target, const gchar* room_id, GError** error);
+	void (*list_room_messages) (MatrixAPI* self, MatrixAPICallback callback, void* callback_target, const gchar* room_id, const gchar* from_token, MatrixEventDirection direction, guint limit, GError** error);
+	void (*send_event_receipt) (MatrixAPI* self, MatrixAPICallback callback, void* callback_target, const gchar* room_id, MatrixReceiptType receipt_type, const gchar* event_id, JsonNode* receipt, GError** error);
+	void (*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);
+	void (*send_message_event) (MatrixAPI* self, MatrixAPICallback callback, void* callback_target, const gchar* room_id, const gchar* event_type, const gchar* txn_id, JsonNode* content, GError** error);
+	void (*get_room_state) (MatrixAPI* self, MatrixAPICallback callback, void* callback_target, const gchar* room_id, const gchar* event_type, const gchar* state_key, GError** error);
+	void (*send_room_event) (MatrixAPI* self, MatrixAPICallback callback, void* callback_target, const gchar* room_id, const gchar* event_type, const gchar* state_key, JsonNode* content, GError** error);
+	void (*notify_room_typing) (MatrixAPI* self, MatrixAPICallback callback, void* callback_target, const gchar* user_id, const gchar* room_id, guint timeout, gboolean typing, GError** error);
+	void (*sync) (MatrixAPI* self, MatrixAPICallback callback, void* callback_target, const gchar* filter_id, MatrixFilter* filter, const gchar* since, gboolean full_state, gboolean set_presence, gulong timeout, GError** error);
+	void (*create_filter) (MatrixAPI* self, MatrixAPICallback callback, void* callback_target, const gchar* user_id, MatrixFilter* filter, GError** error);
+	void (*download_filter) (MatrixAPI* self, MatrixAPICallback callback, void* callback_target, const gchar* user_id, const gchar* filter_id, GError** error);
+	void (*search) (MatrixAPI* self, MatrixAPICallback callback, void* callback_target, const gchar* next_batch, MatrixSearchCategories* search_categories, GError** error);
+	void (*whois) (MatrixAPI* self, MatrixAPICallback callback, void* callback_target, const gchar* user_id, GError** error);
+	void (*versions) (MatrixAPI* self, MatrixAPICallback callback, void* callback_target, GError** error);
+	void (*login) (MatrixAPI* self, MatrixAPICallback callback, void* callback_target, const gchar* login_type, JsonNode* content, GError** error);
+	void (*token_refresh) (MatrixAPI* self, MatrixAPICallback callback, void* callback_target, const gchar* refresh_token, GError** error);
+	void (*get_3pids) (MatrixAPI* self, MatrixAPICallback callback, void* callback_target, GError** error);
+	void (*add_3pid) (MatrixAPI* self, MatrixAPICallback callback, void* callback_target, gboolean bind_creds, Matrix3PidCredential* threepid_creds, GError** error);
+	void (*change_password) (MatrixAPI* self, MatrixAPICallback callback, void* callback_target, const gchar* new_password, GError** error);
+	void (*get_profile) (MatrixAPI* self, MatrixAPICallback callback, void* callback_target, const gchar* user_id, GError** error);
+	void (*get_avatar_url) (MatrixAPI* self, MatrixAPICallback callback, void* callback_target, const gchar* user_id, GError** error);
+	void (*set_avatar_url) (MatrixAPI* self, MatrixAPICallback callback, void* callback_target, const gchar* user_id, const gchar* avatar_url, GError** error);
+	void (*get_display_name) (MatrixAPI* self, MatrixAPICallback callback, void* callback_target, const gchar* user_id, GError** error);
+	void (*set_display_name) (MatrixAPI* self, MatrixAPICallback callback, void* callback_target, const gchar* user_id, const gchar* display_name, GError** error);
+	void (*register_account) (MatrixAPI* self, MatrixAPICallback callback, void* callback_target, MatrixAccountKind account_kind, gboolean bind_email, const gchar* username, const gchar* password, GError** error);
+	void (*set_account_data) (MatrixAPI* self, MatrixAPICallback callback, void* callback_target, const gchar* user_id, const gchar* room_id, const gchar* event_type, JsonNode* content, GError** error);
+	void (*get_room_tags) (MatrixAPI* self, MatrixAPICallback callback, void* callback_target, const gchar* user_id, const gchar* room_id, GError** error);
+	void (*delete_room_tag) (MatrixAPI* self, MatrixAPICallback callback, void* callback_target, const gchar* user_id, const gchar* room_id, const gchar* tag, GError** error);
+	void (*add_room_tag) (MatrixAPI* self, MatrixAPICallback callback, void* callback_target, const gchar* user_id, const gchar* room_id, const gchar* tag, JsonNode* content, GError** error);
+	void (*get_turn_server) (MatrixAPI* self, MatrixAPICallback callback, void* callback_target, GError** error);
+	const gchar* (*get_token) (MatrixAPI* self);
+	void (*set_token) (MatrixAPI* self, const gchar* value);
+	const gchar* (*get_refresh_token) (MatrixAPI* self);
+	void (*set_refresh_token) (MatrixAPI* self, const gchar* value);
+	const gchar* (*get_user_id) (MatrixAPI* self);
+	const gchar* (*get_homeserver) (MatrixAPI* self);
+};
+

Interface for creating MatrixAPI implementations.

Members

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

GTypeInterface `parent_iface`;	the parent interface structure
`abort_pending` ()	virtual method called by `matrix_api_abort_pending()`
`media_download` ()	virtual method called by `matrix_api_media_download()`
`media_thumbnail` ()	virtual method called by `matrix_api_media_thumbnail()`
`media_upload` ()	virtual method called by `matrix_api_media_upload()`
`get_presence_list` ()	virtual method called by `matrix_api_get_presence_list()`
`update_presence_list` ()	virtual method called by `matrix_api_update_presence_list()`
`get_user_presence` ()	virtual method called by `matrix_api_get_user_presence()`
`set_user_presence` ()	virtual method called by `matrix_api_set_user_presence()`
`update_pusher` ()	virtual method called by `matrix_api_update_pusher()`
`get_pushers` ()	virtual method called by `matrix_api_get_pushers()`
`delete_pusher` ()	virtual method called by `matrix_api_delete_pusher()`
`get_pusher` ()	virtual method called by `matrix_api_get_pusher()`
`add_pusher` ()	virtual method called by `matrix_api_add_pusher()`
`toggle_pusher` ()	virtual method called by `matrix_api_toggle_pusher()`
`create_room` ()	virtual method called by `matrix_api_create_room()`
`delete_room_alias` ()	virtual method called by `matrix_api_delete_room_alias()`
`get_room_id` ()	virtual method called by `matrix_api_get_room_id()`
`create_room_alias` ()	virtual method called by `matrix_api_create_room_alias()`
`list_public_rooms` ()	virtual method called by `matrix_api_list_public_rooms()`
`ban_user` ()	virtual method called by `matrix_api_ban_user()`
`forget_room` ()	virtual method called by `matrix_api_forget_room()`
`invite_user_3rdparty` ()	virtual method called by `matrix_api_invite_user_3rdparty()`
`invite_user` ()	virtual method called by `matrix_api_invite_user()`
`join_room` ()	virtual method called by `matrix_api_join_room()`
`leave_room` ()	virtual method called by `matrix_api_leave_room()`
`event_stream` ()	virtual method called by `matrix_api_event_stream()`
`get_event` ()	virtual method called by `matrix_api_get_event()`
`initial_sync` ()	virtual method called by `matrix_api_initial_sync()`
`get_event_context` ()	virtual method called by `matrix_api_get_event_context()`
`initial_sync_room` ()	virtual method called by `matrix_api_initial_sync_room()`
`list_room_members` ()	virtual method called by `matrix_api_list_room_members()`
`list_room_messages` ()	virtual method called by `matrix_api_list_room_messages()`
`send_event_receipt` ()	virtual method called by `matrix_api_send_event_receipt()`
`redact_event` ()	virtual method called by `matrix_api_redact_event()`
`send_message_event` ()	virtual method called by `matrix_api_send_message_event()`
`get_room_state` ()	virtual method called by `matrix_api_get_room_state()`
`send_room_event` ()	virtual method called by `matrix_api_send_room_event()`
`notify_room_typing` ()	virtual method called by `matrix_api_notify_room_typing()`
`sync` ()	virtual method called by `matrix_api_sync()`
`create_filter` ()	virtual method called by `matrix_api_create_filter()`
`download_filter` ()	virtual method called by `matrix_api_download_filter()`
`search` ()	virtual method called by `matrix_api_search()`
`whois` ()	virtual method called by `matrix_api_whois()`
`versions` ()	virtual method called by `matrix_api_versions()`
`login` ()	virtual method called by `matrix_api_login()`
`token_refresh` ()	virtual method called by `matrix_api_token_refresh()`
`get_3pids` ()	virtual method called by `matrix_api_get_3pids()`
`add_3pid` ()	virtual method called by `matrix_api_add_3pid()`
`change_password` ()	virtual method called by `matrix_api_change_password()`
`get_profile` ()	virtual method called by `matrix_api_get_profile()`
`get_avatar_url` ()	virtual method called by `matrix_api_get_avatar_url()`
`set_avatar_url` ()	virtual method called by `matrix_api_set_avatar_url()`
`get_display_name` ()	virtual method called by `matrix_api_get_display_name()`
`set_display_name` ()	virtual method called by `matrix_api_set_display_name()`
`register_account` ()	virtual method called by `matrix_api_register_account()`
`set_account_data` ()	virtual method called by `matrix_api_set_account_data()`
`get_room_tags` ()	virtual method called by `matrix_api_get_room_tags()`
`delete_room_tag` ()	virtual method called by `matrix_api_delete_room_tag()`
`add_room_tag` ()	virtual method called by `matrix_api_add_room_tag()`
`get_turn_server` ()	virtual method called by `matrix_api_get_turn_server()`
`get_token` ()	getter method for the abstract property "token"
`set_token` ()	setter method for the abstract property "token"
`get_refresh_token` ()	getter method for the abstract property "refresh-token"
`set_refresh_token` ()	setter method for the abstract property "refresh-token"
`get_user_id` ()	getter method for the abstract property "user-id"
`get_homeserver` ()	getter method for the abstract property "homeserver"

+ + + \ No newline at end of file diff --git a/Matrix-0.0-MatrixClient.html b/Matrix-0.0-MatrixClient.html new file mode 100644 index 0000000..874fdd4 --- /dev/null +++ b/Matrix-0.0-MatrixClient.html @@ -0,0 +1,665 @@ + + + + +Matrix-0.0 Reference Manual: MatrixClient + + + + + + + + + + + + + + + + +

+ + +

MatrixClient

MatrixClient — Base interface for client communication with a Matrix.org homeserver

Functions

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

+void +	+matrix_client_login_with_password () +
+void +	+matrix_client_register_with_password () +
+void +	+matrix_client_logout () +
+void +	+matrix_client_begin_polling () +
+void +	+matrix_client_stop_polling () +
+void +	+matrix_client_emit_login_finished () +
+void +	+matrix_client_incoming_event () +
+void +	+matrix_client_connect_event () +
+void +	+(*MatrixClientEventCallback) () +

Types and Values

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

	MatrixClient
struct	MatrixClientIface

Object Hierarchy

Description

Functions

matrix_client_login_with_password ()

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

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

Parameters

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

self	the MatrixClient instance
username	+ . + the username to login with + . +	[in]
password	+ . + the password to use + . +	[in]
error	location to store the error occuring, or `NULL` to ignore.	[error-domains MatrixError]

matrix_client_register_with_password ()

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

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

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

self	the MatrixClient instance
username	+ . + the username to register. If omitted, the server will generate one + . +	[in][allow-none]
password	+ . + the password to use with the registration + . +	[in]
error	location to store the error occuring, or `NULL` to ignore.	[error-domains MatrixError]

matrix_client_logout ()

void
+matrix_client_logout (MatrixClient *self,
+                      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

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

self	the MatrixClient instance
error	location to store the error occuring, or `NULL` to ignore.	[error-domains MatrixError]

matrix_client_begin_polling ()

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

Begin polling the event stream.

Parameters

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

self	the MatrixClient instance
error	location to store the error occuring, or `NULL` to ignore.	[error-domains MatrixError]

matrix_client_stop_polling ()

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

Stop polling the event stream. If param + cancel_ongoing is

+true
+

+, ongoing requests will be cancelled, too.

Parameters

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

self

the MatrixClient instance

cancel_ongoing

+true
+

+, ongoing requests will be cancelled, too

[in]

error

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

[error-domains MatrixError]

matrix_client_emit_login_finished ()

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

Convenience function to emits the login-finished signal.

Parameters

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

self

the MatrixClient instance

success

set to

+true
+

+if login was successful

[in]

matrix_client_incoming_event ()

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

Emits the “event” signal.

Parameters

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

self	the MatrixClient instance
room_id	+ . + the room this event is associated with + . +	[in][allow-none]
raw_event	+ . + the raw event + . +	[in]
matrix_event	+ . + the event as a Matrix.Event + . +	[in]

matrix_client_connect_event ()

void
+matrix_client_connect_event (MatrixClient *self,
+                             GType event_gtype,
+                             MatrixClientEventCallback event_callback,
+                             void *event_callback_target,
+                             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.

Parameters

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

callback	the allback function to connect
self	the MatrixClient instance
event_gtype	+ . + the GType of a MatrixEvent derivative + . +	[in]
event_callback_target	user data to pass to `event_callback` +.	[allow-none][closure]
event_callback_target_destroy_notify	function to call when `event_callback_target` +is no longer needed.	[allow-none]
event_callback

MatrixClientEventCallback ()

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

Callback function delegate for the event signal.

Parameters

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

room_id	+ . + the room the event associated with + . +	[in][allow-none]
raw_event	+ . + the event as a raw JSON object + . +	[in]
matrix_event	+ . + the event as a Matrix.Event object + . +	[in]
client
user_data	data to pass to the delegate function.	[closure]

Types and Values

MatrixClient

typedef struct _MatrixClient MatrixClient;

Base interface for client communication with a Matrix.org homeserver

struct MatrixClientIface

struct MatrixClientIface {
+	GTypeInterface parent_iface;
+	void (*login_with_password) (MatrixClient* self, const gchar* username, const gchar* password, GError** error);
+	void (*register_with_password) (MatrixClient* self, const gchar* username, const gchar* password, GError** error);
+	void (*logout) (MatrixClient* self, GError** error);
+	void (*begin_polling) (MatrixClient* self, GError** error);
+	void (*stop_polling) (MatrixClient* self, gboolean cancel_ongoing, GError** error);
+	void (*login_finished) (MatrixClient* self, gboolean success);
+	void (*event) (MatrixClient* self, const gchar* room_id, JsonNode* raw_event, MatrixEvent* matrix_event);
+};
+

Interface for creating MatrixClient implementations.

Members

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

GTypeInterface `parent_iface`;	the parent interface structure
`login_with_password` ()	virtual method called by `matrix_client_login_with_password()`
`register_with_password` ()	virtual method called by `matrix_client_register_with_password()`
`logout` ()	virtual method called by `matrix_client_logout()`
`begin_polling` ()	virtual method called by `matrix_client_begin_polling()`
`stop_polling` ()	virtual method called by `matrix_client_stop_polling()`
`login_finished` ()
`event` ()

+ + + \ No newline at end of file diff --git a/Matrix-0.0-MatrixEvent.html b/Matrix-0.0-MatrixEvent.html new file mode 100644 index 0000000..11d9c7a --- /dev/null +++ b/Matrix-0.0-MatrixEvent.html @@ -0,0 +1,916 @@ + + + + +Matrix-0.0 Reference Manual: MatrixEvent + + + + + + + + + + + + + + + + +

+ + +

MatrixEvent

MatrixEvent — Base class for Matrix events.

Functions

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

#define	MATRIX_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

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

struct	MatrixEvent
struct	MatrixEventClass

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()`

+ + + \ No newline at end of file diff --git a/Matrix-0.0-MatrixHTTPAPI.html b/Matrix-0.0-MatrixHTTPAPI.html new file mode 100644 index 0000000..9d56af0 --- /dev/null +++ b/Matrix-0.0-MatrixHTTPAPI.html @@ -0,0 +1,313 @@ + + + + +Matrix-0.0 Reference Manual: MatrixHTTPAPI + + + + + + + + + + + + + + + + +

+ + +

MatrixHTTPAPI

MatrixHTTPAPI — This is a class for low level communication with a Matrix.org server via HTTP.

Functions

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

#define	MATRIX_TYPE_HTTP_API
+MatrixHTTPAPI * +	+matrix_http_api_new () +
const gchar * +	+matrix_http_api_get_base_url () +
+void +	+matrix_http_api_set_base_url () +
+gboolean +	+matrix_http_api_get_validate_certificate () +
+void +	+matrix_http_api_set_validate_certificate () +

Types and Values

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

struct	MatrixHTTPAPI
struct	MatrixHTTPAPIClass

Object Hierarchy

Description

Functions

MATRIX_TYPE_HTTP_API

#define MATRIX_TYPE_HTTP_API (matrix_http_api_get_type ())
+

The type for MatrixHTTPAPI.

matrix_http_api_new ()

MatrixHTTPAPI *
+matrix_http_api_new (const gchar *base_url,
+                     const gchar *token);

Parameters

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

base_url
token

matrix_http_api_get_base_url ()

const gchar *
+matrix_http_api_get_base_url (MatrixHTTPAPI *self);

Get and return the current value of the "base-url" property.

Parameters

+++++ + + + + + +

self

the MatrixHTTPAPI instance to query

Returns

the value of the "base-url" property

matrix_http_api_set_base_url ()

void
+matrix_http_api_set_base_url (MatrixHTTPAPI *self,
+                              const gchar *value);

Set the value of the "base-url" property to value +.

Parameters

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

self	the MatrixHTTPAPI instance to modify
value	the new value of the "base-url" property

matrix_http_api_get_validate_certificate ()

gboolean
+matrix_http_api_get_validate_certificate
+                               (MatrixHTTPAPI *self);

Get and return the current value of the "validate-certificate" property.

Parameters

+++++ + + + + + +

self

the MatrixHTTPAPI instance to query

Returns

the value of the "validate-certificate" property

matrix_http_api_set_validate_certificate ()

void
+matrix_http_api_set_validate_certificate
+                               (MatrixHTTPAPI *self,
+                                gboolean value);

Set the value of the "validate-certificate" property to value +.

Parameters

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

self	the MatrixHTTPAPI instance to modify
value	the new value of the "validate-certificate" property

Types and Values

struct MatrixHTTPAPI

struct MatrixHTTPAPI {
+	GObject parent_instance;
+	MatrixHTTPAPIPrivate * priv;
+};
+

This is a class for low level communication with a Matrix.org server via HTTP.

struct MatrixHTTPAPIClass

struct MatrixHTTPAPIClass {
+	GObjectClass parent_class;
+};
+

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

Members

+++++ + + + + + +

GObjectClass parent_class;

the parent class structure

+ + + \ No newline at end of file diff --git a/Matrix-0.0-MatrixHTTPClient.html b/Matrix-0.0-MatrixHTTPClient.html new file mode 100644 index 0000000..4698365 --- /dev/null +++ b/Matrix-0.0-MatrixHTTPClient.html @@ -0,0 +1,156 @@ + + + + +Matrix-0.0 Reference Manual: MatrixHTTPClient + + + + + + + + + + + + + + + + +

+ + +

MatrixHTTPClient

MatrixHTTPClient — An event-driven client class to communicate with HTTP based Matrix.org servers.

Functions

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

#define	MATRIX_TYPE_HTTP_CLIENT
+MatrixHTTPClient * +	+matrix_http_client_new () +

Types and Values

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

struct	MatrixHTTPClient
struct	MatrixHTTPClientClass

Object Hierarchy

Description

Functions

MATRIX_TYPE_HTTP_CLIENT

#define MATRIX_TYPE_HTTP_CLIENT (matrix_http_client_get_type ())
+

The type for MatrixHTTPClient.

matrix_http_client_new ()

MatrixHTTPClient *
+matrix_http_client_new (const gchar *base_url);

Parameters

+++++ + + + + + +

base_url

Types and Values

struct MatrixHTTPClient

struct MatrixHTTPClient {
+	MatrixHTTPAPI parent_instance;
+	MatrixHTTPClientPrivate * priv;
+};
+

An event-driven client class to communicate with HTTP based Matrix.org servers.

struct MatrixHTTPClientClass

struct MatrixHTTPClientClass {
+	MatrixHTTPAPIClass parent_class;
+};
+

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

Members

+++++ + + + + + +

MatrixHTTPAPIClass parent_class;

the parent class structure

+ + + \ No newline at end of file diff --git a/Matrix-0.0-MatrixJsonCompact.html b/Matrix-0.0-MatrixJsonCompact.html new file mode 100644 index 0000000..3bba291 --- /dev/null +++ b/Matrix-0.0-MatrixJsonCompact.html @@ -0,0 +1,4642 @@ + + + + +Matrix-0.0 Reference Manual: MatrixJsonCompact + + + + + + + + + + + + + + + + +

+ + +

MatrixJsonCompact

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

Functions

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

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

Types and Values

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

struct	MatrixJsonCompact
struct	MatrixJsonCompactClass
struct	MatrixFilter
struct	MatrixFilterClass
struct	MatrixRoomFilter
struct	MatrixRoomFilterClass
struct	MatrixFilterRules
struct	MatrixFilterRulesClass
struct	Matrix3PidCredential
struct	Matrix3PidCredentialClass
struct	MatrixPusher
struct	MatrixPusherClass
struct	MatrixUnsignedEventData
struct	MatrixUnsignedEventDataClass
struct	MatrixEventContext
struct	MatrixEventContextClass
struct	MatrixSearchGrouping
struct	MatrixSearchGroupingClass
struct	MatrixSearchGroupings
struct	MatrixSearchGroupingsClass
struct	MatrixSearchRoomEvents
struct	MatrixSearchRoomEventsClass
struct	MatrixSearchCategories
struct	MatrixSearchCategoriesClass

Object Hierarchy

Description

Functions

MATRIX_TYPE_JSON_COMPACT

#define MATRIX_TYPE_JSON_COMPACT (matrix_json_compact_get_type ())
+

The type for MatrixJsonCompact.

matrix_json_compact_get_json_node ()

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

Parameters

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

self	the MatrixJsonCompact instance
error	location to store the error occuring, or `NULL` to ignore.	[error-domains MatrixError]

matrix_json_compact_get_json_data ()

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

Parameters

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

self	the MatrixJsonCompact instance
datalen
error	location to store the error occuring, or `NULL` to ignore.	[error-domains MatrixError]

matrix_json_compact_ref ()

gpointer
+matrix_json_compact_ref (gpointer instance);

Increases the reference count of object +.

Parameters

+++++ + + + + + +

instance

a MatrixJsonCompact.

Returns

the same object +

matrix_json_compact_unref ()

void
+matrix_json_compact_unref (gpointer instance);

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

Parameters

+++++ + + + + + +

instance

a MatrixJsonCompact.

matrix_param_spec_json_compact ()

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

Creates a new GParamSpecBoxed instance specifying a MATRIX_TYPE_JSON_COMPACT derived property.

See g_param_spec_internal() for details on property names.

Parameters

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

name	canonical name of the property specified
nick	nick name for the property specified
blurb	description of the property specified
object_type	+`MATRIX_TYPE_JSON_COMPACT` derived type of this property
flags	flags for the property specified

matrix_value_set_json_compact ()

void
+matrix_value_set_json_compact (GValue *value,
+                               gpointer v_object);

Set the contents of a MATRIX_TYPE_JSON_COMPACT derived GValue to v_object +.

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

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

Parameters

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

value	a valid GValue of `MATRIX_TYPE_JSON_COMPACT` derived type
v_object	object value to be set

matrix_value_get_json_compact ()

gpointer
+matrix_value_get_json_compact (const GValue *value);

Get the contents of a MATRIX_TYPE_JSON_COMPACT derived GValue.

Parameters

+++++ + + + + + +

value

a valid GValue of MATRIX_TYPE_JSON_COMPACT derived type

Returns

object contents of value +

matrix_value_take_json_compact ()

void
+matrix_value_take_json_compact (GValue *value,
+                                gpointer v_object);

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

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

Parameters

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

value	a valid GValue of `MATRIX_TYPE_JSON_COMPACT` derived type
v_object	object value to be set

MATRIX_TYPE_FILTER

#define MATRIX_TYPE_FILTER (matrix_filter_get_type ())
+

The type for MatrixFilter.

matrix_filter_new ()

MatrixFilter *
+matrix_filter_new (void);

matrix_filter_get_event_fields ()

GList *
+matrix_filter_get_event_fields (MatrixFilter *self);

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

The event fields to include in the filtered events.

Parameters

+++++ + + + + + +

self

the MatrixFilter instance to query

Returns

the value of the "event-fields" property

matrix_filter_set_event_fields ()

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

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

The event fields to include in the filtered events.

Parameters

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

self	the MatrixFilter instance to modify
value	the new value of the "event-fields" property

matrix_filter_get_event_format ()

MatrixEventFormat
+matrix_filter_get_event_format (MatrixFilter *self);

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

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

Parameters

+++++ + + + + + +

self

the MatrixFilter instance to query

Returns

the value of the "event-format" property

matrix_filter_set_event_format ()

void
+matrix_filter_set_event_format (MatrixFilter *self,
+                                MatrixEventFormat value);

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

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

Parameters

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

self	the MatrixFilter instance to modify
value	the new value of the "event-format" property

matrix_filter_get_presence_filter ()

MatrixFilterRules *
+matrix_filter_get_presence_filter (MatrixFilter *self);

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

A filtering ruleset for presence events.

Parameters

+++++ + + + + + +

self

the MatrixFilter instance to query

Returns

the value of the "presence-filter" property

matrix_filter_set_presence_filter ()

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

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

A filtering ruleset for presence events.

Parameters

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

self	the MatrixFilter instance to modify
value	the new value of the "presence-filter" property

matrix_filter_get_room_filter ()

MatrixRoomFilter *
+matrix_filter_get_room_filter (MatrixFilter *self);

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

A filtering ruleset for room events.

Parameters

+++++ + + + + + +

self

the MatrixFilter instance to query

Returns

the value of the "room-filter" property

matrix_filter_set_room_filter ()

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

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

A filtering ruleset for room events.

Parameters

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

self	the MatrixFilter instance to modify
value	the new value of the "room-filter" property

MATRIX_TYPE_ROOM_FILTER

#define MATRIX_TYPE_ROOM_FILTER (matrix_room_filter_get_type ())
+

The type for MatrixRoomFilter.

matrix_room_filter_new ()

MatrixRoomFilter *
+matrix_room_filter_new (void);

matrix_room_filter_get_include_leave ()

gboolean
+matrix_room_filter_get_include_leave (MatrixRoomFilter *self);

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

+true
+

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

Parameters

+++++ + + + + + +

self

the MatrixRoomFilter instance to query

Returns

the value of the "include-leave" property

matrix_room_filter_set_include_leave ()

void
+matrix_room_filter_set_include_leave (MatrixRoomFilter *self,
+                                      gboolean value);

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

+true
+

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

Parameters

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

self	the MatrixRoomFilter instance to modify
value	the new value of the "include-leave" property

matrix_room_filter_get_ephemeral ()

MatrixFilterRules *
+matrix_room_filter_get_ephemeral (MatrixRoomFilter *self);

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

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

Parameters

+++++ + + + + + +

self

the MatrixRoomFilter instance to query

Returns

the value of the "ephemeral" property

matrix_room_filter_set_ephemeral ()

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

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

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

Parameters

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

self	the MatrixRoomFilter instance to modify
value	the new value of the "ephemeral" property

matrix_room_filter_get_state ()

MatrixFilterRules *
+matrix_room_filter_get_state (MatrixRoomFilter *self);

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

Filtering rules for state events.

Parameters

+++++ + + + + + +

self

the MatrixRoomFilter instance to query

Returns

the value of the "state" property

matrix_room_filter_set_state ()

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

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

Filtering rules for state events.

Parameters

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

self	the MatrixRoomFilter instance to modify
value	the new value of the "state" property

matrix_room_filter_get_timeline ()

MatrixFilterRules *
+matrix_room_filter_get_timeline (MatrixRoomFilter *self);

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

Filtering rules for timeline events.

Parameters

+++++ + + + + + +

self

the MatrixRoomFilter instance to query

Returns

the value of the "timeline" property

matrix_room_filter_set_timeline ()

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

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

Filtering rules for timeline events.

Parameters

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

self	the MatrixRoomFilter instance to modify
value	the new value of the "timeline" property

MATRIX_TYPE_FILTER_RULES

#define MATRIX_TYPE_FILTER_RULES (matrix_filter_rules_get_type ())
+

The type for MatrixFilterRules.

matrix_filter_rules_new ()

MatrixFilterRules *
+matrix_filter_rules_new (void);

matrix_filter_rules_get_limit ()

guint
+matrix_filter_rules_get_limit (MatrixFilterRules *self);

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

The limit of the count of returned events.

Parameters

+++++ + + + + + +

self

the MatrixFilterRules instance to query

Returns

the value of the "limit" property

matrix_filter_rules_set_limit ()

void
+matrix_filter_rules_set_limit (MatrixFilterRules *self,
+                               guint value);

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

The limit of the count of returned events.

Parameters

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

self	the MatrixFilterRules instance to modify
value	the new value of the "limit" property

matrix_filter_rules_get_types ()

GList *
+matrix_filter_rules_get_types (MatrixFilterRules *self);

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

List of message types to include in the filtered result.

Parameters

+++++ + + + + + +

self

the MatrixFilterRules instance to query

Returns

the value of the "types" property

matrix_filter_rules_set_types ()

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

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

List of message types to include in the filtered result.

Parameters

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

self	the MatrixFilterRules instance to modify
value	the new value of the "types" property

matrix_filter_rules_get_excluded_types ()

GList *
+matrix_filter_rules_get_excluded_types
+                               (MatrixFilterRules *self);

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

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

Parameters

+++++ + + + + + +

self

the MatrixFilterRules instance to query

Returns

the value of the "excluded-types" property

matrix_filter_rules_set_excluded_types ()

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

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

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

Parameters

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

self	the MatrixFilterRules instance to modify
value	the new value of the "excluded-types" property

matrix_filter_rules_get_senders ()

GList *
+matrix_filter_rules_get_senders (MatrixFilterRules *self);

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

List of senders to include in the filtered results.

Parameters

+++++ + + + + + +

self

the MatrixFilterRules instance to query

Returns

the value of the "senders" property

matrix_filter_rules_set_senders ()

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

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

List of senders to include in the filtered results.

Parameters

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

self	the MatrixFilterRules instance to modify
value	the new value of the "senders" property

matrix_filter_rules_get_excluded_senders ()

GList *
+matrix_filter_rules_get_excluded_senders
+                               (MatrixFilterRules *self);

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

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

Parameters

+++++ + + + + + +

self

the MatrixFilterRules instance to query

Returns

the value of the "excluded-senders" property

matrix_filter_rules_set_excluded_senders ()

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

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

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

Parameters

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

self	the MatrixFilterRules instance to modify
value	the new value of the "excluded-senders" property

matrix_filter_rules_get_rooms ()

GList *
+matrix_filter_rules_get_rooms (MatrixFilterRules *self);

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

List of rooms to include in the filtered results.

Parameters

+++++ + + + + + +

self

the MatrixFilterRules instance to query

Returns

the value of the "rooms" property

matrix_filter_rules_set_rooms ()

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

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

List of rooms to include in the filtered results.

Parameters

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

self	the MatrixFilterRules instance to modify
value	the new value of the "rooms" property

matrix_filter_rules_get_excluded_rooms ()

GList *
+matrix_filter_rules_get_excluded_rooms
+                               (MatrixFilterRules *self);

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

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

Parameters

+++++ + + + + + +

self

the MatrixFilterRules instance to query

Returns

the value of the "excluded-rooms" property

matrix_filter_rules_set_excluded_rooms ()

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

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

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

Parameters

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

self	the MatrixFilterRules instance to modify
value	the new value of the "excluded-rooms" property

MATRIX_TYPE_3PID_CREDENTIAL

#define MATRIX_TYPE_3PID_CREDENTIAL (matrix_3pid_credential_get_type ())
+

The type for Matrix3PidCredential.

matrix_3pid_credential_new ()

Matrix3PidCredential *
+matrix_3pid_credential_new (void);

matrix_3pid_credential_get_id_server ()

const gchar *
+matrix_3pid_credential_get_id_server (Matrix3PidCredential *self);

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

The Identity Server used for this credential.

Parameters

+++++ + + + + + +

self

the Matrix3PidCredential instance to query

Returns

the value of the "id-server" property

matrix_3pid_credential_set_id_server ()

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

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

The Identity Server used for this credential.

Parameters

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

self	the Matrix3PidCredential instance to modify
value	the new value of the "id-server" property

matrix_3pid_credential_get_session_id ()

const gchar *
+matrix_3pid_credential_get_session_id (Matrix3PidCredential *self);

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

The session identifier got from the Identity Server.

Parameters

+++++ + + + + + +

self

the Matrix3PidCredential instance to query

Returns

the value of the "session-id" property

matrix_3pid_credential_set_session_id ()

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

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

The session identifier got from the Identity Server.

Parameters

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

self	the Matrix3PidCredential instance to modify
value	the new value of the "session-id" property

matrix_3pid_credential_get_client_secret ()

const gchar *
+matrix_3pid_credential_get_client_secret
+                               (Matrix3PidCredential *self);

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

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

Parameters

+++++ + + + + + +

self

the Matrix3PidCredential instance to query

Returns

the value of the "client-secret" property

matrix_3pid_credential_set_client_secret ()

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

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

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

Parameters

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

self	the Matrix3PidCredential instance to modify
value	the new value of the "client-secret" property

MATRIX_TYPE_PUSHER

#define MATRIX_TYPE_PUSHER (matrix_pusher_get_type ())
+

The type for MatrixPusher.

matrix_pusher_new ()

MatrixPusher *
+matrix_pusher_new (void);

matrix_pusher_get_device_display_name ()

const gchar *
+matrix_pusher_get_device_display_name (MatrixPusher *self);

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

A device display name.

Parameters

+++++ + + + + + +

self

the MatrixPusher instance to query

Returns

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

matrix_pusher_set_device_display_name ()

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

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

A device display name.

Parameters

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

self	the MatrixPusher instance to modify
value	the new value of the "device-display-name" property

matrix_pusher_get_app_display_name ()

const gchar *
+matrix_pusher_get_app_display_name (MatrixPusher *self);

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

An application display name.

Parameters

+++++ + + + + + +

self

the MatrixPusher instance to query

Returns

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

matrix_pusher_set_app_display_name ()

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

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

An application display name.

Parameters

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

self	the MatrixPusher instance to modify
value	the new value of the "app-display-name" property

matrix_pusher_get_app_id ()

const gchar *
+matrix_pusher_get_app_id (MatrixPusher *self);

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

An application ID.

Parameters

+++++ + + + + + +

self

the MatrixPusher instance to query

Returns

the value of the "app-id" property

matrix_pusher_set_app_id ()

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

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

An application ID.

Parameters

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

self	the MatrixPusher instance to modify
value	the new value of the "app-id" property

matrix_pusher_get_append ()

gboolean
+matrix_pusher_get_append (MatrixPusher *self);

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

+true
+

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

Parameters

+++++ + + + + + +

self

the MatrixPusher instance to query

Returns

the value of the "append" property

matrix_pusher_set_append ()

void
+matrix_pusher_set_append (MatrixPusher *self,
+                          gboolean value);

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

+true
+

Parameters

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

self	the MatrixPusher instance to modify
value	the new value of the "append" property

matrix_pusher_get_kind ()

const gchar *
+matrix_pusher_get_kind (MatrixPusher *self);

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

The kind of the pusher.

+http
+

+ makes a pusher that sends HTTP pokes.

+null
+

+ deletes the pusher.

Parameters

+++++ + + + + + +

self

the MatrixPusher instance to query

Returns

the value of the "kind" property

matrix_pusher_set_kind ()

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

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

The kind of the pusher.

+http
+

+ makes a pusher that sends HTTP pokes.

+null
+

+ deletes the pusher.

Parameters

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

self	the MatrixPusher instance to modify
value	the new value of the "kind" property

matrix_pusher_get_lang ()

const gchar *
+matrix_pusher_get_lang (MatrixPusher *self);

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

The preferred language for receiving notifications, e.g.

+en
+

+ or

+en-US
+

Parameters

+++++ + + + + + +

self

the MatrixPusher instance to query

Returns

the value of the "lang" property

matrix_pusher_set_lang ()

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

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

The preferred language for receiving notifications, e.g.

+en
+

+ or

+en-US
+

Parameters

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

self	the MatrixPusher instance to modify
value	the new value of the "lang" property

matrix_pusher_get_profile_tag ()

const gchar *
+matrix_pusher_get_profile_tag (MatrixPusher *self);

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

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

Parameters

+++++ + + + + + +

self

the MatrixPusher instance to query

Returns

the value of the "profile-tag" property

matrix_pusher_set_profile_tag ()

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

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

Parameters

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

self	the MatrixPusher instance to modify
value	the new value of the "profile-tag" property

matrix_pusher_get_pushkey ()

const gchar *
+matrix_pusher_get_pushkey (MatrixPusher *self);

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

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

Parameters

+++++ + + + + + +

self

the MatrixPusher instance to query

Returns

the value of the "pushkey" property

matrix_pusher_set_pushkey ()

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

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

Parameters

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

self	the MatrixPusher instance to modify
value	the new value of the "pushkey" property

matrix_pusher_get_data ()

JsonNode *
+matrix_pusher_get_data (MatrixPusher *self);

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

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

+http
+

+, this should contain an

+url
+

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

Parameters

+++++ + + + + + +

self

the MatrixPusher instance to query

Returns

the value of the "data" property

matrix_pusher_set_data ()

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

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

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

+http
+

+, this should contain an

+url
+

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

Parameters

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

self	the MatrixPusher instance to modify
value	the new value of the "data" property

MATRIX_TYPE_UNSIGNED_EVENT_DATA

#define MATRIX_TYPE_UNSIGNED_EVENT_DATA (matrix_unsigned_event_data_get_type ())
+

The type for MatrixUnsignedEventData.

matrix_unsigned_event_data_new_from_json ()

MatrixUnsignedEventData *
+matrix_unsigned_event_data_new_from_json
+                               (JsonNode *json_data);

Create an UnsignedEventData object based on param + json_data.

Parameters

+++++ + + + + + +

json_data

matrix_unsigned_event_data_new ()

MatrixUnsignedEventData *
+matrix_unsigned_event_data_new (void);

matrix_unsigned_event_data_get_age ()

guint
+matrix_unsigned_event_data_get_age (MatrixUnsignedEventData *self);

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

The age of the event, in seconds.

Parameters

+++++ + + + + + +

self

the MatrixUnsignedEventData instance to query

Returns

the value of the "age" property

matrix_unsigned_event_data_set_age ()

void
+matrix_unsigned_event_data_set_age (MatrixUnsignedEventData *self,
+                                    guint value);

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

The age of the event, in seconds.

Parameters

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

self	the MatrixUnsignedEventData instance to modify
value	the new value of the "age" property

matrix_unsigned_event_data_get_redact_reason ()

const gchar *
+matrix_unsigned_event_data_get_redact_reason
+                               (MatrixUnsignedEventData *self);

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

The reason of redaction, if any.

Parameters

+++++ + + + + + +

self

the MatrixUnsignedEventData instance to query

Returns

the value of the "redact-reason" property

matrix_unsigned_event_data_set_redact_reason ()

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

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

The reason of redaction, if any.

Parameters

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

self	the MatrixUnsignedEventData instance to modify
value	the new value of the "redact-reason" property

matrix_unsigned_event_data_get_transaction_id ()

const gchar *
+matrix_unsigned_event_data_get_transaction_id
+                               (MatrixUnsignedEventData *self);

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

The transaction ID of the message.

Parameters

+++++ + + + + + +

self

the MatrixUnsignedEventData instance to query

Returns

the value of the "transaction-id" property

matrix_unsigned_event_data_set_transaction_id ()

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

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

The transaction ID of the message.

Parameters

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

self	the MatrixUnsignedEventData instance to modify
value	the new value of the "transaction-id" property

MATRIX_TYPE_EVENT_CONTEXT

#define MATRIX_TYPE_EVENT_CONTEXT (matrix_event_context_get_type ())
+

The type for MatrixEventContext.

matrix_event_context_new ()

MatrixEventContext *
+matrix_event_context_new (void);

matrix_event_context_get_before_limit ()

gint *
+matrix_event_context_get_before_limit (MatrixEventContext *self);

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

Parameters

+++++ + + + + + +

self

the MatrixEventContext instance to query

Returns

the value of the "before-limit" property

matrix_event_context_set_before_limit ()

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

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

Parameters

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

self	the MatrixEventContext instance to modify
value	the new value of the "before-limit" property

matrix_event_context_get_after_limit ()

gint *
+matrix_event_context_get_after_limit (MatrixEventContext *self);

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

Parameters

+++++ + + + + + +

self

the MatrixEventContext instance to query

Returns

the value of the "after-limit" property

matrix_event_context_set_after_limit ()

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

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

Parameters

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

self	the MatrixEventContext instance to modify
value	the new value of the "after-limit" property

matrix_event_context_get_include_profile ()

gboolean *
+matrix_event_context_get_include_profile
+                               (MatrixEventContext *self);

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

Parameters

+++++ + + + + + +

self

the MatrixEventContext instance to query

Returns

the value of the "include-profile" property

matrix_event_context_set_include_profile ()

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

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

Parameters

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

self	the MatrixEventContext instance to modify
value	the new value of the "include-profile" property

MATRIX_TYPE_SEARCH_GROUPING

#define MATRIX_TYPE_SEARCH_GROUPING (matrix_search_grouping_get_type ())
+

The type for MatrixSearchGrouping.

matrix_search_grouping_new ()

MatrixSearchGrouping *
+matrix_search_grouping_new (void);

matrix_search_grouping_get_key ()

MatrixSearchGroupBy *
+matrix_search_grouping_get_key (MatrixSearchGrouping *self);

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

Parameters

+++++ + + + + + +

self

the MatrixSearchGrouping instance to query

Returns

the value of the "key" property

matrix_search_grouping_set_key ()

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

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

Parameters

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

self	the MatrixSearchGrouping instance to modify
value	the new value of the "key" property

MATRIX_TYPE_SEARCH_GROUPINGS

#define MATRIX_TYPE_SEARCH_GROUPINGS (matrix_search_groupings_get_type ())
+

The type for MatrixSearchGroupings.

matrix_search_groupings_new ()

MatrixSearchGroupings *
+matrix_search_groupings_new (void);

matrix_search_groupings_get_group_by ()

GList *
+matrix_search_groupings_get_group_by (MatrixSearchGroupings *self);

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

Parameters

+++++ + + + + + +

self

the MatrixSearchGroupings instance to query

Returns

the value of the "group-by" property

matrix_search_groupings_set_group_by ()

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

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

Parameters

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

self	the MatrixSearchGroupings instance to modify
value	the new value of the "group-by" property

MATRIX_TYPE_SEARCH_ROOM_EVENTS

#define MATRIX_TYPE_SEARCH_ROOM_EVENTS (matrix_search_room_events_get_type ())
+

The type for MatrixSearchRoomEvents.

matrix_search_room_events_new ()

MatrixSearchRoomEvents *
+matrix_search_room_events_new (void);

matrix_search_room_events_get_order_by ()

MatrixSearchOrder *
+matrix_search_room_events_get_order_by
+                               (MatrixSearchRoomEvents *self);

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

Parameters

+++++ + + + + + +

self

the MatrixSearchRoomEvents instance to query

Returns

the value of the "order-by" property

matrix_search_room_events_set_order_by ()

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

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

Parameters

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

self	the MatrixSearchRoomEvents instance to modify
value	the new value of the "order-by" property

matrix_search_room_events_get_keys ()

GList *
+matrix_search_room_events_get_keys (MatrixSearchRoomEvents *self);

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

Parameters

+++++ + + + + + +

self

the MatrixSearchRoomEvents instance to query

Returns

the value of the "keys" property

matrix_search_room_events_set_keys ()

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

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

Parameters

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

self	the MatrixSearchRoomEvents instance to modify
value	the new value of the "keys" property

matrix_search_room_events_get_event_context ()

MatrixEventContext *
+matrix_search_room_events_get_event_context
+                               (MatrixSearchRoomEvents *self);

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

Parameters

+++++ + + + + + +

self

the MatrixSearchRoomEvents instance to query

Returns

the value of the "event-context" property

matrix_search_room_events_set_event_context ()

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

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

Parameters

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

self	the MatrixSearchRoomEvents instance to modify
value	the new value of the "event-context" property

matrix_search_room_events_get_include_state ()

gboolean *
+matrix_search_room_events_get_include_state
+                               (MatrixSearchRoomEvents *self);

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

Parameters

+++++ + + + + + +

self

the MatrixSearchRoomEvents instance to query

Returns

the value of the "include-state" property

matrix_search_room_events_set_include_state ()

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

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

Parameters

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

self	the MatrixSearchRoomEvents instance to modify
value	the new value of the "include-state" property

matrix_search_room_events_get_filter_id ()

const gchar *
+matrix_search_room_events_get_filter_id
+                               (MatrixSearchRoomEvents *self);

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

Parameters

+++++ + + + + + +

self

the MatrixSearchRoomEvents instance to query

Returns

the value of the "filter-id" property

matrix_search_room_events_set_filter_id ()

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

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

Parameters

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

self	the MatrixSearchRoomEvents instance to modify
value	the new value of the "filter-id" property

matrix_search_room_events_get_filter ()

MatrixFilter *
+matrix_search_room_events_get_filter (MatrixSearchRoomEvents *self);

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

Parameters

+++++ + + + + + +

self

the MatrixSearchRoomEvents instance to query

Returns

the value of the "filter" property

matrix_search_room_events_set_filter ()

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

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

Parameters

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

self	the MatrixSearchRoomEvents instance to modify
value	the new value of the "filter" property

matrix_search_room_events_get_search_term ()

const gchar *
+matrix_search_room_events_get_search_term
+                               (MatrixSearchRoomEvents *self);

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

Parameters

+++++ + + + + + +

self

the MatrixSearchRoomEvents instance to query

Returns

the value of the "search-term" property

matrix_search_room_events_set_search_term ()

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

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

Parameters

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

self	the MatrixSearchRoomEvents instance to modify
value	the new value of the "search-term" property

matrix_search_room_events_get_groupings ()

MatrixSearchGroupings *
+matrix_search_room_events_get_groupings
+                               (MatrixSearchRoomEvents *self);

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

Parameters

+++++ + + + + + +

self

the MatrixSearchRoomEvents instance to query

Returns

the value of the "groupings" property

matrix_search_room_events_set_groupings ()

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

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

Parameters

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

self	the MatrixSearchRoomEvents instance to modify
value	the new value of the "groupings" property

MATRIX_TYPE_SEARCH_CATEGORIES

#define MATRIX_TYPE_SEARCH_CATEGORIES (matrix_search_categories_get_type ())
+

The type for MatrixSearchCategories.

matrix_search_categories_new ()

MatrixSearchCategories *
+matrix_search_categories_new (void);

matrix_search_categories_get_room_events ()

MatrixSearchRoomEvents *
+matrix_search_categories_get_room_events
+                               (MatrixSearchCategories *self);

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

Parameters

+++++ + + + + + +

self

the MatrixSearchCategories instance to query

Returns

the value of the "room-events" property

matrix_search_categories_set_room_events ()

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

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

Parameters

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

self	the MatrixSearchCategories instance to modify
value	the new value of the "room-events" property

Types and Values

struct MatrixJsonCompact

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

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

struct MatrixJsonCompactClass

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

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

Members

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

GTypeClass `parent_class`;	the parent class structure
`finalize` ()
`get_json_node` ()	virtual method called by `matrix_json_compact_get_json_node()`

struct MatrixFilter

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

Class to hold a filter.

struct MatrixFilterClass

struct MatrixFilterClass {
+	MatrixJsonCompactClass parent_class;
+};
+

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

Members

+++++ + + + + + +

MatrixJsonCompactClass parent_class;

the parent class structure

struct MatrixRoomFilter

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

Class to hold room filters.

struct MatrixRoomFilterClass

struct MatrixRoomFilterClass {
+	MatrixJsonCompactClass parent_class;
+};
+

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

Members

+++++ + + + + + +

MatrixJsonCompactClass parent_class;

the parent class structure

struct MatrixFilterRules

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

Class to hold filtering rules.

struct MatrixFilterRulesClass

struct MatrixFilterRulesClass {
+	MatrixJsonCompactClass parent_class;
+};
+

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

Members

+++++ + + + + + +

MatrixJsonCompactClass parent_class;

the parent class structure

struct Matrix3PidCredential

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

Class to hold 3rd party credential related data.

struct Matrix3PidCredentialClass

struct Matrix3PidCredentialClass {
+	MatrixJsonCompactClass parent_class;
+};
+

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

Members

+++++ + + + + + +

MatrixJsonCompactClass parent_class;

the parent class structure

struct MatrixPusher

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

Class to hold pusher related data.

struct MatrixPusherClass

struct MatrixPusherClass {
+	MatrixJsonCompactClass parent_class;
+};
+

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

Members

+++++ + + + + + +

MatrixJsonCompactClass parent_class;

the parent class structure

struct MatrixUnsignedEventData

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

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

struct MatrixUnsignedEventDataClass

struct MatrixUnsignedEventDataClass {
+	MatrixJsonCompactClass parent_class;
+};
+

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

Members

+++++ + + + + + +

MatrixJsonCompactClass parent_class;

the parent class structure

struct MatrixEventContext

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

struct MatrixEventContextClass

struct MatrixEventContextClass {
+	MatrixJsonCompactClass parent_class;
+};
+

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

Members

+++++ + + + + + +

MatrixJsonCompactClass parent_class;

the parent class structure

struct MatrixSearchGrouping

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

struct MatrixSearchGroupingClass

struct MatrixSearchGroupingClass {
+	MatrixJsonCompactClass parent_class;
+};
+

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

Members

+++++ + + + + + +

MatrixJsonCompactClass parent_class;

the parent class structure

struct MatrixSearchGroupings

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

struct MatrixSearchGroupingsClass

struct MatrixSearchGroupingsClass {
+	MatrixJsonCompactClass parent_class;
+};
+

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

Members

+++++ + + + + + +

MatrixJsonCompactClass parent_class;

the parent class structure

struct MatrixSearchRoomEvents

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

struct MatrixSearchRoomEventsClass

struct MatrixSearchRoomEventsClass {
+	MatrixJsonCompactClass parent_class;
+};
+

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

Members

+++++ + + + + + +

MatrixJsonCompactClass parent_class;

the parent class structure

struct MatrixSearchCategories

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

struct MatrixSearchCategoriesClass

struct MatrixSearchCategoriesClass {
+	MatrixJsonCompactClass parent_class;
+};
+

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

Members

+++++ + + + + + +

MatrixJsonCompactClass parent_class;

the parent class structure

+ + + \ No newline at end of file diff --git a/Matrix-0.0-MatrixPresenceEvent.html b/Matrix-0.0-MatrixPresenceEvent.html new file mode 100644 index 0000000..cb35ca5 --- /dev/null +++ b/Matrix-0.0-MatrixPresenceEvent.html @@ -0,0 +1,441 @@ + + + + +Matrix-0.0 Reference Manual: MatrixPresenceEvent + + + + + + + + + + + + + + + + +

+ + +

MatrixPresenceEvent

MatrixPresenceEvent — Class for representing presence events

Functions

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

#define	MATRIX_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

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

struct	MatrixPresenceEvent
struct	MatrixPresenceEventClass

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

+ + + \ No newline at end of file diff --git a/Matrix-0.0-MatrixRoomEvent.html b/Matrix-0.0-MatrixRoomEvent.html new file mode 100644 index 0000000..093ab91 --- /dev/null +++ b/Matrix-0.0-MatrixRoomEvent.html @@ -0,0 +1,125 @@ + + + + +Matrix-0.0 Reference Manual: MatrixRoomEvent + + + + + + + + + + + + + + + + +

+ + +

MatrixRoomEvent

MatrixRoomEvent — Abstract base class for room events.

Functions

++++ + + + + +

#define

MATRIX_TYPE_ROOM_EVENT

Types and Values

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

struct	MatrixRoomEvent
struct	MatrixRoomEventClass

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

+ + + \ No newline at end of file diff --git a/Matrix-0.0-MatrixRoomMemberEvent.html b/Matrix-0.0-MatrixRoomMemberEvent.html new file mode 100644 index 0000000..71d399c --- /dev/null +++ b/Matrix-0.0-MatrixRoomMemberEvent.html @@ -0,0 +1,444 @@ + + + + +Matrix-0.0 Reference Manual: MatrixRoomMemberEvent + + + + + + + + + + + + + + + + +

+ + +

MatrixRoomMemberEvent

MatrixRoomMemberEvent — Class for representing a room membership events

Functions

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

#define	MATRIX_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

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

struct	MatrixRoomMemberEvent
struct	MatrixRoomMemberEventClass

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

+ + + \ No newline at end of file diff --git a/Matrix-0.0-MatrixRoomMessageEvent.html b/Matrix-0.0-MatrixRoomMessageEvent.html new file mode 100644 index 0000000..a5aca61 --- /dev/null +++ b/Matrix-0.0-MatrixRoomMessageEvent.html @@ -0,0 +1,288 @@ + + + + +Matrix-0.0 Reference Manual: MatrixRoomMessageEvent + + + + + + + + + + + + + + + + +

+ + +

MatrixRoomMessageEvent

Functions

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

#define	MATRIX_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

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

struct	MatrixRoomMessageEvent
struct	MatrixRoomMessageEventClass

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

+ + + \ No newline at end of file diff --git a/Matrix-0.0-MatrixStateEvent.html b/Matrix-0.0-MatrixStateEvent.html new file mode 100644 index 0000000..fb581ab --- /dev/null +++ b/Matrix-0.0-MatrixStateEvent.html @@ -0,0 +1,287 @@ + + + + +Matrix-0.0 Reference Manual: MatrixStateEvent + + + + + + + + + + + + + + + + +

+ + +

MatrixStateEvent

Functions

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

#define	MATRIX_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

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

struct	MatrixStateEvent
struct	MatrixStateEventClass

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

+ + + \ No newline at end of file diff --git a/Matrix-0.0-c-api.html b/Matrix-0.0-c-api.html new file mode 100644 index 0000000..c1f17d0 --- /dev/null +++ b/Matrix-0.0-c-api.html @@ -0,0 +1,54 @@ + + + + +Matrix-0.0 Reference Manual: c-api + + + + + + + + + + + + + + + + +

+ + +

c-api

Object Hierarchy

Description

Functions

Types and Values

+ + + \ No newline at end of file diff --git a/Matrix-0.0-matrix-enums.html b/Matrix-0.0-matrix-enums.html new file mode 100644 index 0000000..b77d5b7 --- /dev/null +++ b/Matrix-0.0-matrix-enums.html @@ -0,0 +1,800 @@ + + + + +Matrix-0.0 Reference Manual: matrix-enums + + + + + + + + + + + + + + + + +

+ + +

matrix-enums

Functions

++++ + + + + +

+GQuark +

+matrix_error_quark () +

Types and Values

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

enum	MatrixAccountKind
enum	MatrixEventDirection
enum	MatrixEventFormat
enum	MatrixPresence
enum	MatrixPusherConditionKind
enum	MatrixPusherKind
enum	MatrixReceiptType
enum	MatrixResizeMethod
enum	MatrixRoomMembership
enum	MatrixRoomPreset
enum	MatrixRoomVisibility
enum	MatrixSearchOrder
enum	MatrixSearchKey
enum	MatrixSearchGroupBy
enum	MatrixError

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

+ + + \ No newline at end of file diff --git a/annotation-glossary.html b/annotation-glossary.html new file mode 100644 index 0000000..fa4140b --- /dev/null +++ b/annotation-glossary.html @@ -0,0 +1,54 @@ + + + + +Matrix-0.0 Reference Manual: Annotation Glossary + + + + + + + + + + + + + + + +

+Annotation Glossary

A

allow-none

NULL is ok, both for passing and for returning.

C

closure

This parameter is a 'user_data', for callbacks; many bindings can pass NULL here.

E

error-domains

Typed errors. Similar to throws in Java.

I

Parameter for input. Default is transfer none.

T

transfer full

Free data after the code is done.

transfer none

Don't free data after the code is done.

+ + + \ No newline at end of file diff --git a/api-index-full.html b/api-index-full.html new file mode 100644 index 0000000..ba98898 --- /dev/null +++ b/api-index-full.html @@ -0,0 +1,1303 @@ + + + + +Matrix-0.0 Reference Manual: API Index + + + + + + + + + + + + + + + + +

+API Index

M

+Matrix3PidCredential, struct in MatrixJsonCompact +

+Matrix3PidCredentialClass, struct in MatrixJsonCompact +

+MatrixAccountKind, enum in matrix-enums +

+MatrixAPI, struct in MatrixAPI +

+MatrixAPICallback, user_function in MatrixAPI +

+MatrixAPIIface, struct in MatrixAPI +

+MatrixClient, struct in MatrixClient +

+MatrixClientEventCallback, user_function in MatrixClient +

+MatrixClientIface, struct in MatrixClient +

+MatrixError, enum in matrix-enums +

+MatrixEvent, struct in MatrixEvent +

+MatrixEventClass, struct in MatrixEvent +

+MatrixEventContext, struct in MatrixJsonCompact +

+MatrixEventContextClass, struct in MatrixJsonCompact +

+MatrixEventDirection, enum in matrix-enums +

+MatrixEventFormat, enum in matrix-enums +

+MatrixFilter, struct in MatrixJsonCompact +

+MatrixFilterClass, struct in MatrixJsonCompact +

+MatrixFilterRules, struct in MatrixJsonCompact +

+MatrixFilterRulesClass, struct in MatrixJsonCompact +

+MatrixHTTPAPI, struct in MatrixHTTPAPI +

+MatrixHTTPAPIClass, struct in MatrixHTTPAPI +

+MatrixHTTPClient, struct in MatrixHTTPClient +

+MatrixHTTPClientClass, struct in MatrixHTTPClient +

+MatrixJsonCompact, struct in MatrixJsonCompact +

+MatrixJsonCompactClass, struct in MatrixJsonCompact +

+MatrixPresence, enum in matrix-enums +

+MatrixPresenceEvent, struct in MatrixPresenceEvent +

+MatrixPresenceEventClass, struct in MatrixPresenceEvent +

+MatrixPusher, struct in MatrixJsonCompact +

+MatrixPusherClass, struct in MatrixJsonCompact +

+MatrixPusherConditionKind, enum in matrix-enums +

+MatrixPusherKind, enum in matrix-enums +

+MatrixReceiptType, enum in matrix-enums +

+MatrixResizeMethod, enum in matrix-enums +

+MatrixRoomEvent, struct in MatrixRoomEvent +

+MatrixRoomEventClass, struct in MatrixRoomEvent +

+MatrixRoomFilter, struct in MatrixJsonCompact +

+MatrixRoomFilterClass, struct in MatrixJsonCompact +

+MatrixRoomMemberEvent, struct in MatrixRoomMemberEvent +

+MatrixRoomMemberEventClass, struct in MatrixRoomMemberEvent +

+MatrixRoomMembership, enum in matrix-enums +

+MatrixRoomMessageEvent, struct in MatrixRoomMessageEvent +

+MatrixRoomMessageEventClass, struct in MatrixRoomMessageEvent +

+MatrixRoomPreset, enum in matrix-enums +

+MatrixRoomVisibility, enum in matrix-enums +

+MatrixSearchCategories, struct in MatrixJsonCompact +

+MatrixSearchCategoriesClass, struct in MatrixJsonCompact +

+MatrixSearchGroupBy, enum in matrix-enums +

+MatrixSearchGrouping, struct in MatrixJsonCompact +

+MatrixSearchGroupingClass, struct in MatrixJsonCompact +

+MatrixSearchGroupings, struct in MatrixJsonCompact +

+MatrixSearchGroupingsClass, struct in MatrixJsonCompact +

+MatrixSearchKey, enum in matrix-enums +

+MatrixSearchOrder, enum in matrix-enums +

+MatrixSearchRoomEvents, struct in MatrixJsonCompact +

+MatrixSearchRoomEventsClass, struct in MatrixJsonCompact +

+MatrixStateEvent, struct in MatrixStateEvent +

+MatrixStateEventClass, struct in MatrixStateEvent +

+MatrixUnsignedEventData, struct in MatrixJsonCompact +

+MatrixUnsignedEventDataClass, struct in MatrixJsonCompact +

+matrix_3pid_credential_get_client_secret, function in MatrixJsonCompact +

+matrix_3pid_credential_get_id_server, function in MatrixJsonCompact +

+matrix_3pid_credential_get_session_id, function in MatrixJsonCompact +

+matrix_3pid_credential_new, function in MatrixJsonCompact +

+matrix_3pid_credential_set_client_secret, function in MatrixJsonCompact +

+matrix_3pid_credential_set_id_server, function in MatrixJsonCompact +

+matrix_3pid_credential_set_session_id, function in MatrixJsonCompact +

+matrix_api_abort_pending, function in MatrixAPI +

+matrix_api_add_3pid, function in MatrixAPI +

+matrix_api_add_pusher, function in MatrixAPI +

+matrix_api_add_room_tag, function in MatrixAPI +

+matrix_api_ban_user, function in MatrixAPI +

+matrix_api_change_password, function in MatrixAPI +

+matrix_api_create_filter, function in MatrixAPI +

+matrix_api_create_room, function in MatrixAPI +

+matrix_api_create_room_alias, function in MatrixAPI +

+matrix_api_delete_pusher, function in MatrixAPI +

+matrix_api_delete_room_alias, function in MatrixAPI +

+matrix_api_delete_room_tag, function in MatrixAPI +

+matrix_api_download_filter, function in MatrixAPI +

+matrix_api_event_stream, function in MatrixAPI +

+matrix_api_forget_room, function in MatrixAPI +

+matrix_api_get_3pids, function in MatrixAPI +

+matrix_api_get_avatar_url, function in MatrixAPI +

+matrix_api_get_display_name, function in MatrixAPI +

+matrix_api_get_event, function in MatrixAPI +

+matrix_api_get_event_context, function in MatrixAPI +

+matrix_api_get_homeserver, function in MatrixAPI +

+matrix_api_get_presence_list, function in MatrixAPI +

+matrix_api_get_profile, function in MatrixAPI +

+matrix_api_get_pusher, function in MatrixAPI +

+matrix_api_get_pushers, function in MatrixAPI +

+matrix_api_get_refresh_token, function in MatrixAPI +

+matrix_api_get_room_id, function in MatrixAPI +

+matrix_api_get_room_state, function in MatrixAPI +

+matrix_api_get_room_tags, function in MatrixAPI +

+matrix_api_get_token, function in MatrixAPI +

+matrix_api_get_turn_server, function in MatrixAPI +

+matrix_api_get_user_id, function in MatrixAPI +

+matrix_api_get_user_presence, function in MatrixAPI +

+matrix_api_initial_sync, function in MatrixAPI +

+matrix_api_initial_sync_room, function in MatrixAPI +

+matrix_api_invite_user, function in MatrixAPI +

+matrix_api_invite_user_3rdparty, function in MatrixAPI +

+matrix_api_join_room, function in MatrixAPI +

+matrix_api_leave_room, function in MatrixAPI +

+matrix_api_list_public_rooms, function in MatrixAPI +

+matrix_api_list_room_members, function in MatrixAPI +

+matrix_api_list_room_messages, function in MatrixAPI +

+matrix_api_login, function in MatrixAPI +

+matrix_api_media_download, function in MatrixAPI +

+matrix_api_media_thumbnail, function in MatrixAPI +

+matrix_api_media_upload, function in MatrixAPI +

+matrix_api_notify_room_typing, function in MatrixAPI +

+matrix_api_redact_event, function in MatrixAPI +

+matrix_api_register_account, function in MatrixAPI +

+matrix_api_search, function in MatrixAPI +

+matrix_api_send_event_receipt, function in MatrixAPI +

+matrix_api_send_message_event, function in MatrixAPI +

+matrix_api_send_room_event, function in MatrixAPI +

+matrix_api_set_account_data, function in MatrixAPI +

+matrix_api_set_avatar_url, function in MatrixAPI +

+matrix_api_set_display_name, function in MatrixAPI +

+matrix_api_set_refresh_token, function in MatrixAPI +

+matrix_api_set_token, function in MatrixAPI +

+matrix_api_set_user_presence, function in MatrixAPI +

+matrix_api_sync, function in MatrixAPI +

+matrix_api_toggle_pusher, function in MatrixAPI +

+matrix_api_token_refresh, function in MatrixAPI +

+matrix_api_update_presence_list, function in MatrixAPI +

+matrix_api_update_pusher, function in MatrixAPI +

+matrix_api_versions, function in MatrixAPI +

+matrix_api_whois, function in MatrixAPI +

+matrix_client_begin_polling, function in MatrixClient +

+matrix_client_connect_event, function in MatrixClient +

+matrix_client_emit_login_finished, function in MatrixClient +

+matrix_client_incoming_event, function in MatrixClient +

+matrix_client_login_with_password, function in MatrixClient +

+matrix_client_logout, function in MatrixClient +

+matrix_client_register_with_password, function in MatrixClient +

+matrix_client_stop_polling, function in MatrixClient +

+matrix_error_quark, function in matrix-enums +

+matrix_event_context_get_after_limit, function in MatrixJsonCompact +

+matrix_event_context_get_before_limit, function in MatrixJsonCompact +

+matrix_event_context_get_include_profile, function in MatrixJsonCompact +

+matrix_event_context_new, function in MatrixJsonCompact +

+matrix_event_context_set_after_limit, function in MatrixJsonCompact +

+matrix_event_context_set_before_limit, function in MatrixJsonCompact +

+matrix_event_context_set_include_profile, function in MatrixJsonCompact +

+matrix_event_delete_custom_field, function in MatrixEvent +

+matrix_event_from_json, function in MatrixEvent +

+matrix_event_get_custom_field, function in MatrixEvent +

+matrix_event_get_event_type, function in MatrixEvent +

+matrix_event_get_handler, function in MatrixEvent +

+matrix_event_get_json, function in MatrixEvent +

+matrix_event_get_origin_server_ts, function in MatrixEvent +

+matrix_event_get_room_id, function in MatrixEvent +

+matrix_event_get_sender, function in MatrixEvent +

+matrix_event_get_unsigned_data, function in MatrixEvent +

+matrix_event_new, function in MatrixEvent +

+matrix_event_new_from_json, function in MatrixEvent +

+matrix_event_register_type, function in MatrixEvent +

+matrix_event_set_custom_field, function in MatrixEvent +

+matrix_event_set_origin_server_ts, function in MatrixEvent +

+matrix_event_set_room_id, function in MatrixEvent +

+matrix_event_set_sender, function in MatrixEvent +

+matrix_event_set_unsigned_data, function in MatrixEvent +

+matrix_event_to_json, function in MatrixEvent +

+matrix_event_unregister_type, function in MatrixEvent +

+matrix_filter_get_event_fields, function in MatrixJsonCompact +

+matrix_filter_get_event_format, function in MatrixJsonCompact +

+matrix_filter_get_presence_filter, function in MatrixJsonCompact +

+matrix_filter_get_room_filter, function in MatrixJsonCompact +

+matrix_filter_new, function in MatrixJsonCompact +

+matrix_filter_rules_get_excluded_rooms, function in MatrixJsonCompact +

+matrix_filter_rules_get_excluded_senders, function in MatrixJsonCompact +

+matrix_filter_rules_get_excluded_types, function in MatrixJsonCompact +

+matrix_filter_rules_get_limit, function in MatrixJsonCompact +

+matrix_filter_rules_get_rooms, function in MatrixJsonCompact +

+matrix_filter_rules_get_senders, function in MatrixJsonCompact +

+matrix_filter_rules_get_types, function in MatrixJsonCompact +

+matrix_filter_rules_new, function in MatrixJsonCompact +

+matrix_filter_rules_set_excluded_rooms, function in MatrixJsonCompact +

+matrix_filter_rules_set_excluded_senders, function in MatrixJsonCompact +

+matrix_filter_rules_set_excluded_types, function in MatrixJsonCompact +

+matrix_filter_rules_set_limit, function in MatrixJsonCompact +

+matrix_filter_rules_set_rooms, function in MatrixJsonCompact +

+matrix_filter_rules_set_senders, function in MatrixJsonCompact +

+matrix_filter_rules_set_types, function in MatrixJsonCompact +

+matrix_filter_set_event_fields, function in MatrixJsonCompact +

+matrix_filter_set_event_format, function in MatrixJsonCompact +

+matrix_filter_set_presence_filter, function in MatrixJsonCompact +

+matrix_filter_set_room_filter, function in MatrixJsonCompact +

+matrix_http_api_get_base_url, function in MatrixHTTPAPI +

+matrix_http_api_get_validate_certificate, function in MatrixHTTPAPI +

+matrix_http_api_new, function in MatrixHTTPAPI +

+matrix_http_api_set_base_url, function in MatrixHTTPAPI +

+matrix_http_api_set_validate_certificate, function in MatrixHTTPAPI +

+matrix_http_client_new, function in MatrixHTTPClient +

+matrix_json_compact_get_json_data, function in MatrixJsonCompact +

+matrix_json_compact_get_json_node, function in MatrixJsonCompact +

+matrix_json_compact_ref, function in MatrixJsonCompact +

+matrix_json_compact_unref, function in MatrixJsonCompact +

+matrix_param_spec_json_compact, function in MatrixJsonCompact +

+matrix_presence_event_get_avatar_url, function in MatrixPresenceEvent +

+matrix_presence_event_get_display_name, function in MatrixPresenceEvent +

+matrix_presence_event_get_last_active_ago, function in MatrixPresenceEvent +

+matrix_presence_event_get_presence, function in MatrixPresenceEvent +

+matrix_presence_event_new, function in MatrixPresenceEvent +

+matrix_presence_event_set_avatar_url, function in MatrixPresenceEvent +

+matrix_presence_event_set_display_name, function in MatrixPresenceEvent +

+matrix_presence_event_set_last_active_ago, function in MatrixPresenceEvent +

+matrix_presence_event_set_presence, function in MatrixPresenceEvent +

+matrix_pusher_get_append, function in MatrixJsonCompact +

+matrix_pusher_get_app_display_name, function in MatrixJsonCompact +

+matrix_pusher_get_app_id, function in MatrixJsonCompact +

+matrix_pusher_get_data, function in MatrixJsonCompact +

+matrix_pusher_get_device_display_name, function in MatrixJsonCompact +

+matrix_pusher_get_kind, function in MatrixJsonCompact +

+matrix_pusher_get_lang, function in MatrixJsonCompact +

+matrix_pusher_get_profile_tag, function in MatrixJsonCompact +

+matrix_pusher_get_pushkey, function in MatrixJsonCompact +

+matrix_pusher_new, function in MatrixJsonCompact +

+matrix_pusher_set_append, function in MatrixJsonCompact +

+matrix_pusher_set_app_display_name, function in MatrixJsonCompact +

+matrix_pusher_set_app_id, function in MatrixJsonCompact +

+matrix_pusher_set_data, function in MatrixJsonCompact +

+matrix_pusher_set_device_display_name, function in MatrixJsonCompact +

+matrix_pusher_set_kind, function in MatrixJsonCompact +

+matrix_pusher_set_lang, function in MatrixJsonCompact +

+matrix_pusher_set_profile_tag, function in MatrixJsonCompact +

+matrix_pusher_set_pushkey, function in MatrixJsonCompact +

+matrix_room_filter_get_ephemeral, function in MatrixJsonCompact +

+matrix_room_filter_get_include_leave, function in MatrixJsonCompact +

+matrix_room_filter_get_state, function in MatrixJsonCompact +

+matrix_room_filter_get_timeline, function in MatrixJsonCompact +

+matrix_room_filter_new, function in MatrixJsonCompact +

+matrix_room_filter_set_ephemeral, function in MatrixJsonCompact +

+matrix_room_filter_set_include_leave, function in MatrixJsonCompact +

+matrix_room_filter_set_state, function in MatrixJsonCompact +

+matrix_room_filter_set_timeline, function in MatrixJsonCompact +

+matrix_room_member_event_get_avatar_url, function in MatrixRoomMemberEvent +

+matrix_room_member_event_get_display_name, function in MatrixRoomMemberEvent +

+matrix_room_member_event_get_membership, function in MatrixRoomMemberEvent +

+matrix_room_member_event_get_state_key, function in MatrixRoomMemberEvent +

+matrix_room_member_event_new, function in MatrixRoomMemberEvent +

+matrix_room_member_event_set_avatar_url, function in MatrixRoomMemberEvent +

+matrix_room_member_event_set_display_name, function in MatrixRoomMemberEvent +

+matrix_room_member_event_set_membership, function in MatrixRoomMemberEvent +

+matrix_room_member_event_set_state_key, function in MatrixRoomMemberEvent +

+matrix_room_message_event_get_body, function in MatrixRoomMessageEvent +

+matrix_room_message_event_get_msg_type, function in MatrixRoomMessageEvent +

+matrix_room_message_event_new, function in MatrixRoomMessageEvent +

+matrix_room_message_event_set_body, function in MatrixRoomMessageEvent +

+matrix_room_message_event_set_msg_type, function in MatrixRoomMessageEvent +

+matrix_search_categories_get_room_events, function in MatrixJsonCompact +

+matrix_search_categories_new, function in MatrixJsonCompact +

+matrix_search_categories_set_room_events, function in MatrixJsonCompact +

+matrix_search_groupings_get_group_by, function in MatrixJsonCompact +

+matrix_search_groupings_new, function in MatrixJsonCompact +

+matrix_search_groupings_set_group_by, function in MatrixJsonCompact +

+matrix_search_grouping_get_key, function in MatrixJsonCompact +

+matrix_search_grouping_new, function in MatrixJsonCompact +

+matrix_search_grouping_set_key, function in MatrixJsonCompact +

+matrix_search_room_events_get_event_context, function in MatrixJsonCompact +

+matrix_search_room_events_get_filter, function in MatrixJsonCompact +

+matrix_search_room_events_get_filter_id, function in MatrixJsonCompact +

+matrix_search_room_events_get_groupings, function in MatrixJsonCompact +

+matrix_search_room_events_get_include_state, function in MatrixJsonCompact +

+matrix_search_room_events_get_keys, function in MatrixJsonCompact +

+matrix_search_room_events_get_order_by, function in MatrixJsonCompact +

+matrix_search_room_events_get_search_term, function in MatrixJsonCompact +

+matrix_search_room_events_new, function in MatrixJsonCompact +

+matrix_search_room_events_set_event_context, function in MatrixJsonCompact +

+matrix_search_room_events_set_filter, function in MatrixJsonCompact +

+matrix_search_room_events_set_filter_id, function in MatrixJsonCompact +

+matrix_search_room_events_set_groupings, function in MatrixJsonCompact +

+matrix_search_room_events_set_include_state, function in MatrixJsonCompact +

+matrix_search_room_events_set_keys, function in MatrixJsonCompact +

+matrix_search_room_events_set_order_by, function in MatrixJsonCompact +

+matrix_search_room_events_set_search_term, function in MatrixJsonCompact +

+matrix_state_event_get_content, function in MatrixStateEvent +

+matrix_state_event_get_state_key, function in MatrixStateEvent +

+matrix_state_event_new, function in MatrixStateEvent +

+matrix_state_event_set_content, function in MatrixStateEvent +

+matrix_state_event_set_state_key, function in MatrixStateEvent +

+MATRIX_TYPE_3PID_CREDENTIAL, macro in MatrixJsonCompact +

+MATRIX_TYPE_EVENT, macro in MatrixEvent +

+MATRIX_TYPE_EVENT_CONTEXT, macro in MatrixJsonCompact +

+MATRIX_TYPE_FILTER, macro in MatrixJsonCompact +

+MATRIX_TYPE_FILTER_RULES, macro in MatrixJsonCompact +

+MATRIX_TYPE_HTTP_API, macro in MatrixHTTPAPI +

+MATRIX_TYPE_HTTP_CLIENT, macro in MatrixHTTPClient +

+MATRIX_TYPE_JSON_COMPACT, macro in MatrixJsonCompact +

+MATRIX_TYPE_PRESENCE_EVENT, macro in MatrixPresenceEvent +

+MATRIX_TYPE_PUSHER, macro in MatrixJsonCompact +

+MATRIX_TYPE_ROOM_EVENT, macro in MatrixRoomEvent +

+MATRIX_TYPE_ROOM_FILTER, macro in MatrixJsonCompact +

+MATRIX_TYPE_ROOM_MEMBER_EVENT, macro in MatrixRoomMemberEvent +

+MATRIX_TYPE_ROOM_MESSAGE_EVENT, macro in MatrixRoomMessageEvent +

+MATRIX_TYPE_SEARCH_CATEGORIES, macro in MatrixJsonCompact +

+MATRIX_TYPE_SEARCH_GROUPING, macro in MatrixJsonCompact +

+MATRIX_TYPE_SEARCH_GROUPINGS, macro in MatrixJsonCompact +

+MATRIX_TYPE_SEARCH_ROOM_EVENTS, macro in MatrixJsonCompact +

+MATRIX_TYPE_STATE_EVENT, macro in MatrixStateEvent +

+MATRIX_TYPE_UNSIGNED_EVENT_DATA, macro in MatrixJsonCompact +

+matrix_unsigned_event_data_get_age, function in MatrixJsonCompact +

+matrix_unsigned_event_data_get_redact_reason, function in MatrixJsonCompact +

+matrix_unsigned_event_data_get_transaction_id, function in MatrixJsonCompact +

+matrix_unsigned_event_data_new, function in MatrixJsonCompact +

+matrix_unsigned_event_data_new_from_json, function in MatrixJsonCompact +

+matrix_unsigned_event_data_set_age, function in MatrixJsonCompact +

+matrix_unsigned_event_data_set_redact_reason, function in MatrixJsonCompact +

+matrix_unsigned_event_data_set_transaction_id, function in MatrixJsonCompact +

+matrix_value_get_json_compact, function in MatrixJsonCompact +

+matrix_value_set_json_compact, function in MatrixJsonCompact +

+matrix_value_take_json_compact, function in MatrixJsonCompact +

+ + + \ No newline at end of file diff --git a/ch01.html b/ch01.html new file mode 100644 index 0000000..badd199 --- /dev/null +++ b/ch01.html @@ -0,0 +1,71 @@ + + + + +Matrix-0.0 Reference Manual: Matrix-0.0 API Reference + + + + + + + + + + + + + + + + +

+Matrix-0.0 API Reference

+MatrixRoomEvent — Abstract base class for room events. +
+MatrixPresenceEvent — Class for representing presence events +
+matrix-enums +
+MatrixEvent — Base class for Matrix events. +
+MatrixRoomMemberEvent — Class for representing a room membership events +
+MatrixClient — Base interface for client communication with a Matrix.org homeserver +
+MatrixJsonCompact — Abstract parent class for classes that can be saved to JSON. +
+MatrixHTTPClient — An event-driven client class to communicate with HTTP based Matrix.org servers. +
+MatrixStateEvent +
+MatrixRoomMessageEvent +
+c-api +
+MatrixHTTPAPI — This is a class for low level communication with a Matrix.org server via HTTP. +
+MatrixAPI — Base interface for all Client/Server API functionality. +

+ + + \ No newline at end of file diff --git a/deprecated-api-index.html b/deprecated-api-index.html new file mode 100644 index 0000000..a973d53 --- /dev/null +++ b/deprecated-api-index.html @@ -0,0 +1,31 @@ + + + + +Matrix-0.0 Reference Manual: Index of deprecated API + + + + + + + + + + + + + + + + +

+Index of deprecated API

+ +

+ + + \ No newline at end of file diff --git a/home.png b/home.png new file mode 100644 index 0000000..28c2e27 Binary files /dev/null and b/home.png differ diff --git a/index.html b/index.html new file mode 100644 index 0000000..568cd8e --- /dev/null +++ b/index.html @@ -0,0 +1,77 @@ + + + + +Matrix-0.0 Reference Manual: Matrix-0.0 Reference Manual + + + + + + + +

+ for Matrix-0.0 0.0.1.20160304. + The latest version of this documentation can be found on-line at + http://gergely.polonkai.eu/matrix-glib-sdk/. +

Matrix-0.0 API Reference

+MatrixRoomEvent — Abstract base class for room events. +
+MatrixPresenceEvent — Class for representing presence events +
+matrix-enums +
+MatrixEvent — Base class for Matrix events. +
+MatrixRoomMemberEvent — Class for representing a room membership events +
+MatrixClient — Base interface for client communication with a Matrix.org homeserver +
+MatrixJsonCompact — Abstract parent class for classes that can be saved to JSON. +
+MatrixHTTPClient — An event-driven client class to communicate with HTTP based Matrix.org servers. +
+MatrixStateEvent +
+MatrixRoomMessageEvent +
+c-api +
+MatrixHTTPAPI — This is a class for low level communication with a Matrix.org server via HTTP. +
+MatrixAPI — Base interface for all Client/Server API functionality. +

API Index

Index of deprecated API

Annotation Glossary

+ + + diff --git a/left-insensitive.png b/left-insensitive.png new file mode 100644 index 0000000..9b8005b Binary files /dev/null and b/left-insensitive.png differ diff --git a/left.png b/left.png new file mode 100644 index 0000000..c518641 Binary files /dev/null and b/left.png differ diff --git a/right-insensitive.png b/right-insensitive.png new file mode 100644 index 0000000..f999f00 Binary files /dev/null and b/right-insensitive.png differ diff --git a/right.png b/right.png new file mode 100644 index 0000000..78f5875 Binary files /dev/null and b/right.png differ diff --git a/style.css b/style.css new file mode 100644 index 0000000..705a5c9 --- /dev/null +++ b/style.css @@ -0,0 +1,461 @@ +body +{ + font-family: cantarell, sans-serif; +} +.synopsis, .classsynopsis +{ + /* tango:aluminium 1/2 */ + background: #eeeeec; + background: rgba(238, 238, 236, 0.5); + border: solid 1px rgb(238, 238, 236); + padding: 0.5em; +} +.programlisting +{ + /* tango:sky blue 0/1 */ + /* fallback for no rgba support */ + background: #e6f3ff; + border: solid 1px #729fcf; + background: rgba(114, 159, 207, 0.1); + border: solid 1px rgba(114, 159, 207, 0.2); + padding: 0.5em; +} +.variablelist +{ + padding: 4px; + margin-left: 3em; +} +.variablelist td:first-child +{ + vertical-align: top; +} + +@media screen { + sup a.footnote + { + position: relative; + top: 0em ! important; + } + /* this is needed so that the local anchors are displayed below the naviagtion */ + div.footnote a[name], div.refnamediv a[name], div.refsect1 a[name], div.refsect2 a[name], div.index a[name], div.glossary a[name], div.sect1 a[name] + { + display: inline-block; + position: relative; + top:-5em; + } + /* this seems to be a bug in the xsl style sheets when generating indexes */ + div.index div.index + { + top: 0em; + } + /* make space for the fixed navigation bar and add space at the bottom so that + * link targets appear somewhat close to top + */ + body + { + padding-top: 5em; + padding-bottom: 500px; + max-width: 60em; + } + p + { + max-width: 60em; + } + /* style and size the navigation bar */ + table.navigation#top + { + position: fixed; + background: #e2e2e2; + border-bottom: solid 1px #babdb6; + margin-top: 0; + margin-bottom: 0; + top: 0; + left: 0; + height: 3em; + z-index: 10; + } + .navigation a, .navigation a:visited + { + /* tango:sky blue 3 */ + color: #204a87; + } + .navigation a:hover + { + /* tango:sky blue 2 */ + color: #3465a4; + } + td.shortcuts + { + /* tango:sky blue 2 */ + color: #3465a4; + font-size: 80%; + white-space: nowrap; + } + td.shortcuts .dim + { + color: #babdb6; + } +} +@media screen and (min-width: 60em) { + /* screen larger than 60em */ + body { margin: auto; } +} +@media screen and (max-width: 60em) { + /* screen less than 60em */ + #nav_hierarchy { display: none; } + #nav_interfaces { display: none; } + #nav_prerequisites { display: none; } + #nav_derived_interfaces { display: none; } + #nav_implementations { display: none; } + #nav_child_properties { display: none; } + #nav_style_properties { display: none; } + #nav_index { display: none; } + #nav_glossary { display: none; } + .gallery_image { display: none; } + .property_flags { display: none; } + .signal_flags { display: none; } + .parameter_annotations { display: none; } + .enum_member_annotations { display: none; } + .struct_member_annotations { display: none; } + .union_member_annotations { display: none; } + /* now that a column is hidden, optimize space */ + col.parameters_name { width: auto; } + col.parameters_description { width: auto; } + col.struct_members_name { width: auto; } + col.struct_members_description { width: auto; } + col.enum_members_name { width: auto; } + col.enum_members_description { width: auto; } + col.union_members_name { width: auto; } + col.union_members_description { width: auto; } +} +@media print { + table.navigation { + visibility: collapse; + display: none; + } + div.titlepage table.navigation { + visibility: visible; + display: table; + background: #e2e2e2; + border: solid 1px #babdb6; + margin-top: 0; + margin-bottom: 0; + top: 0; + left: 0; + height: 3em; + } +} + +.navigation .title +{ + font-size: 120%; +} + +div.gallery-float +{ + float: left; + padding: 10px; +} +div.gallery-float img +{ + border-style: none; +} +div.gallery-spacer +{ + clear: both; +} + +a, a:visited +{ + text-decoration: none; + /* tango:sky blue 2 */ + color: #3465a4; +} +a:hover +{ + text-decoration: underline; + /* tango:sky blue 1 */ + color: #729fcf; +} + +div.informaltable table +{ + border-collapse: separate; + border-spacing: 20px 3px; + border: none; +} + +div.informaltable table td, div.informaltable table th +{ + vertical-align: top; +} + +.function_type, +.variable_type, +.property_type, +.signal_type, +.parameter_name, +.struct_member_name, +.union_member_name, +.define_keyword, +.datatype_keyword, +.typedef_keyword +{ + text-align: right; +} + +/* dim non-primary columns */ +.c_punctuation, +.function_type, +.variable_type, +.property_type, +.signal_type, +.define_keyword, +.datatype_keyword, +.typedef_keyword, +.property_flags, +.signal_flags, +.parameter_annotations, +.enum_member_annotations, +.struct_member_annotations, +.union_member_annotations +{ + color: #888a85; +} + +.function_type a, +.function_type a:visited, +.function_type a:hover, +.property_type a, +.property_type a:visited, +.property_type a:hover, +.signal_type a, +.signal_type a:visited, +.signal_type a:hover, +.signal_flags a, +.signal_flags a:visited, +.signal_flags a:hover +{ + color: #729fcf; +} + +div.table table +{ + border-collapse: collapse; + border-spacing: 0px; + /* tango:aluminium 3 */ + border: solid 1px #babdb6; +} + +div.table table td, div.table table th +{ + /* tango:aluminium 3 */ + border: solid 1px #babdb6; + padding: 3px; + vertical-align: top; +} + +div.table table th +{ + /* tango:aluminium 2 */ + background-color: #d3d7cf; +} + +h4 +{ + color: #555753; +} + +hr +{ + /* tango:aluminium 1 */ + color: #d3d7cf; + background: #d3d7cf; + border: none 0px; + height: 1px; + clear: both; + margin: 2.0em 0em 2.0em 0em; +} + +dl.toc dt +{ + padding-bottom: 0.25em; +} + +dl.toc > dd > dl > dt +{ + padding-top: 0.25em; + padding-bottom: 0.25em; +} + +dl.toc > dt +{ + padding-top: 1em; + padding-bottom: 0.5em; + font-weight: bold; +} + +.parameter +{ + font-style: normal; +} + +.footer +{ + padding-top: 3.5em; + /* tango:aluminium 3 */ + color: #babdb6; + text-align: center; + font-size: 80%; +} + +.informalfigure, +.figure +{ + margin: 1em; +} + +.informalexample, +.example +{ + margin-top: 1em; + margin-bottom: 1em; +} + +.warning +{ + /* tango:orange 0/1 */ + background: #ffeed9; + background: rgba(252, 175, 62, 0.1); + border-color: #ffb04f; + border-color: rgba(252, 175, 62, 0.2); +} +.note +{ + /* tango:chameleon 0/0.5 */ + background: #d8ffb2; + background: rgba(138, 226, 52, 0.1); + border-color: #abf562; + border-color: rgba(138, 226, 52, 0.2); +} +div.blockquote +{ + border-color: #eeeeec; +} +.note, .warning, div.blockquote +{ + padding: 0.5em; + border-width: 1px; + border-style: solid; + margin: 2em; +} +.note p, .warning p +{ + margin: 0; +} + +div.warning h3.title, +div.note h3.title +{ + display: none; +} + +p + div.section +{ + margin-top: 1em; +} + +div.refnamediv, +div.refsynopsisdiv, +div.refsect1, +div.refsect2, +div.toc, +div.section +{ + margin-bottom: 1em; +} + +/* blob links */ +h2 .extralinks, h3 .extralinks +{ + float: right; + /* tango:aluminium 3 */ + color: #babdb6; + font-size: 80%; + font-weight: normal; +} + +.lineart +{ + color: #d3d7cf; + font-weight: normal; +} + +.annotation +{ + /* tango:aluminium 5 */ + color: #555753; + font-weight: normal; +} + +.structfield +{ + font-style: normal; + font-weight: normal; +} + +/* code listings */ + +.listing_code .programlisting .cbracket { color: #a40000; } /* tango: scarlet red 3 */ +.listing_code .programlisting .comment { color: #a1a39d; } /* tango: aluminium 4 */ +.listing_code .programlisting .function { color: #000000; font-weight: bold; } +.listing_code .programlisting .function a { color: #11326b; font-weight: bold; } /* tango: sky blue 4 */ +.listing_code .programlisting .keyword { color: #4e9a06; } /* tango: chameleon 3 */ +.listing_code .programlisting .linenum { color: #babdb6; } /* tango: aluminium 3 */ +.listing_code .programlisting .normal { color: #000000; } +.listing_code .programlisting .number { color: #75507b; } /* tango: plum 2 */ +.listing_code .programlisting .preproc { color: #204a87; } /* tango: sky blue 3 */ +.listing_code .programlisting .string { color: #c17d11; } /* tango: chocolate 2 */ +.listing_code .programlisting .type { color: #000000; } +.listing_code .programlisting .type a { color: #11326b; } /* tango: sky blue 4 */ +.listing_code .programlisting .symbol { color: #ce5c00; } /* tango: orange 3 */ + +.listing_frame { + /* tango:sky blue 1 */ + border: solid 1px #729fcf; + border: solid 1px rgba(114, 159, 207, 0.2); + padding: 0px; +} + +.listing_lines, .listing_code { + margin-top: 0px; + margin-bottom: 0px; + padding: 0.5em; +} +.listing_lines { + /* this just adds visual clutter and + takes precious room from small screens */ + display: none; +} +.listing_lines { + /* tango:sky blue 0.5 */ + background: #a6c5e3; + background: rgba(114, 159, 207, 0.2); + /* tango:aluminium 6 */ + color: #2e3436; +} +.listing_code { + /* tango:sky blue 0 */ + background: #e6f3ff; + background: rgba(114, 159, 207, 0.1); +} +.listing_code .programlisting { + /* override from previous */ + border: none 0px; + padding: 0px; + background: none; +} +.listing_lines pre, .listing_code pre { + margin: 0px; +} + diff --git a/up-insensitive.png b/up-insensitive.png new file mode 100644 index 0000000..bda3ce2 Binary files /dev/null and b/up-insensitive.png differ diff --git a/up.png b/up.png new file mode 100644 index 0000000..af46b2a Binary files /dev/null and b/up.png differ