1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
|
/**
* matrix-api.h: Interface to the matrix client/server API.
*
* The intention is that this module provides an interface to the matrix API
* without anything purple-specific.
*
* Each API method takes a 'MatrixConnectionData *'; this is used to determine the
* URL of the homeserver, and the access_token which is used for authorisation.
*
* The methods are asyncronous, and take a callback to be called when the method
* completes.
*
*
*
* This program is free software; you can redistribute it and/or modify
* it under the terms of the GNU General Public License as published by
* the Free Software Foundation; either version 2 of the License, or
* (at your option) any later version.
*
* This program is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU General Public License for more details.
*
* You should have received a copy of the GNU General Public License
* along with this program; if not, write to the Free Software
* Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02111-1301 USA
*/
#ifndef MATRIX_API_H
#define MATRIX_API_H
/* libpurple */
#include "util.h"
#include "matrix-connection.h"
struct _JsonNode;
struct _JsonObject;
typedef struct _MatrixApiRequestData MatrixApiRequestData;
/**
* This is the signature used for functions that act as the callback
* to the matrix api methods
*
* @param conn The MatrixConnectionData passed into the api method
* @param user_data The user data that your code passed into the api
* method.
* @param json_root NULL if there was no body, or it could not be
* parsed as JSON; otherwise the root of the JSON
* tree in the response
*/
typedef void (*MatrixApiCallback)(MatrixConnectionData *conn,
gpointer user_data,
struct _JsonNode *json_root);
/**
* Signature for functions which are called when there is an error calling the
* API (such as a connection failure)
*
* @param conn The MatrixConnectionData passed into the api method
* @param user_data The user data that your code passed into the api
* method.
* @param error_message a descriptive error message
*
*/
typedef void (*MatrixApiErrorCallback)(MatrixConnectionData *conn,
gpointer user_data, const gchar *error_message);
/**
* Default error callback. We just put the connection into the "error" state.
*/
void matrix_api_error(MatrixConnectionData *conn, gpointer user_data,
const gchar *error_message);
/**
* Signature for functions which are called when the API returns a non-200
* response.
*
* @param conn The MatrixConnectionData passed into the api method
* @param user_data The user data that your code passed into the api
* method.
* @param http_response HTTP response code.
* @param json_root NULL if there was no body, or it could not be
* parsed as JSON; otherwise the root of the JSON
* tree in the response
*/
typedef void (*MatrixApiBadResponseCallback)(MatrixConnectionData *conn,
gpointer user_data, int http_response_code,
struct _JsonNode *json_root);
/**
* Default bad-response callback. We just put the connection into the "error"
* state.
*/
void matrix_api_bad_response(MatrixConnectionData *ma, gpointer user_data,
int http_response_code, struct _JsonNode *json_root);
/**
* Cancel a call to an API. This will also call the error_callback
* with an error message of "cancelled".
*
* @param request The result from an earlier matrix_api_* call
*/
void matrix_api_cancel(MatrixApiRequestData *request);
/**
* call the /login API
*
* @param conn The connection with which to make the request
* @param username user id to pass in request
* @param password password to pass in request
* @param callback Function to be called when the request completes
* @param user_data Opaque data to be passed to the callback
*/
MatrixApiRequestData *matrix_api_password_login(MatrixConnectionData *conn,
const gchar *username,
const gchar *password,
MatrixApiCallback callback,
gpointer user_data);
/**
* call the /sync API
*
* @param conn The connection with which to make the request
* @param since If non-null, the batch token to start sync from
* @param timeout Number of milliseconds after which the API will time out if
* no events
* @param callback Function to be called when the request completes
* @param error_callback Function to be called if there is an error making
* the request. If NULL, matrix_api_error will be
* used.
* @param bad_response_callback Function to be called if the API gives a non-200
* response. If NULL, matrix_api_bad_response will be
* used.
* @param user_data Opaque data to be passed to the callback
*/
MatrixApiRequestData *matrix_api_sync(MatrixConnectionData *conn,
const gchar *since, int timeout,
MatrixApiCallback callback,
gpointer user_data);
/**
* Send an event to a room
*
* @param conn The connection with which to make the request
* @param room_id The room to send the event to
* @param event_type The type of event (eg "m.room.message")
* @param txn_id Unique transaction id
* @param content The content of the event
* @param callback Function to be called when the request completes
* @param error_callback Function to be called if there is an error making
* the request. If NULL, matrix_api_error will be
* used.
* @param bad_response_callback Function to be called if the API gives a non-200
* response. If NULL, matrix_api_bad_response will be
* used.
* @param user_data Opaque data to be passed to the callbacks
*/
MatrixApiRequestData *matrix_api_send(MatrixConnectionData *conn,
const gchar *room_id, const gchar *event_type, const gchar *txn_id,
struct _JsonObject *content,
MatrixApiCallback callback,
MatrixApiErrorCallback error_callback,
MatrixApiBadResponseCallback bad_response_callback,
gpointer user_data);
/**
* Get the current state of a room
*
* @param conn The connection with which to make the request
* @param room_id The room to get state for
* @param callback Function to be called when the request completes
* @param user_data Opaque data to be passed to the callbacks
*/
MatrixApiRequestData *matrix_api_get_room_state(MatrixConnectionData *conn,
const gchar *room_id,
MatrixApiCallback callback,
gpointer user_data);
#endif
|
