diff options
author | Richard van der Hoff <richard@matrix.org> | 2015-10-15 10:38:56 +0100 |
---|---|---|
committer | Richard van der Hoff <richard@matrix.org> | 2015-10-15 10:43:14 +0100 |
commit | 80af6b59c5cc7dbf927abab8a52b185590653918 (patch) | |
tree | b049ce9984ef8d6bcdb0c518dc46eea2a0c93123 /matrix-api.h | |
parent | d183825c3a74eab217b7b7463247c07156acd929 (diff) | |
download | purple-matrix-80af6b59c5cc7dbf927abab8a52b185590653918.tar.gz |
Call initialSync
Our first API call, woohoo.
At the moment we just call initialSync and don't do anything with the
response. But it's satisfying progress.
Diffstat (limited to 'matrix-api.h')
-rw-r--r-- | matrix-api.h | 63 |
1 files changed, 63 insertions, 0 deletions
diff --git a/matrix-api.h b/matrix-api.h new file mode 100644 index 0000000..892b8ed --- /dev/null +++ b/matrix-api.h @@ -0,0 +1,63 @@ +/** + * Interface to the matrix client/server API + * + * 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 + +#include "util.h" + +#include "libmatrix.h" + +/** + * This is the signature used for functions that act as the callback + * to the matrix api methods + * + * @param account The MatrixAccount passed into the api method + * @param user_data The user data that your code passed into the api + * method. + * @param ret_text This will be NULL on error. Otherwise this + * will contain the entire response text + * @param ret_len 0 on error, otherwise this is the length of ret_text. + * @param http_response -1 on error, otherwise this is the HTTP response code. + * @param http_response_msg NULL on error, otherwise this is the message from + * the HTTP response line. + * @param error_message If something went wrong then this will contain + * a descriptive error message, and ret_text will be + * NULL and ret_len will be 0. + */ +typedef void (*MatrixApiCallback)(MatrixAccount *account, + gpointer user_data, + const gchar *ret_text, gsize ret_len, + int http_response_code, + const gchar *http_response_msg, + const gchar *body_start, + const gchar *error_message); + + +/** + * call the /initialsync API + * + * @param account The MatrixAccount for which to make the request + * @param callback Function to be called when the request completes + * @param user_data Opaque data to be passed to the callback + */ +PurpleUtilFetchUrlData *matrix_initialsync(MatrixAccount *account, + MatrixApiCallback callback, + gpointer user_data); + +#endif |