137 lines
4.6 KiB
C
137 lines
4.6 KiB
C
/* -*- Mode: C; tab-width: 8; indent-tabs-mode: t; c-basic-offset: 8 -*-
|
|
* vi:set noexpandtab tabstop=8 shiftwidth=8:
|
|
*
|
|
* Copyright (C) 2021 Endless OS Foundation LLC
|
|
*
|
|
* Author: Philip Withnall <pwithnall@endlessos.org>
|
|
*
|
|
* SPDX-License-Identifier: GPL-2.0-or-later
|
|
*/
|
|
|
|
#pragma once
|
|
|
|
#include <glib.h>
|
|
#include <glib-object.h>
|
|
#include <libsoup/soup.h>
|
|
|
|
#include "gs-app-list.h"
|
|
#include "gs-download-utils.h"
|
|
|
|
G_BEGIN_DECLS
|
|
|
|
/**
|
|
* GsOdrsProviderError:
|
|
* @GS_ODRS_PROVIDER_ERROR_DOWNLOADING: Error while downloading ODRS data.
|
|
* @GS_ODRS_PROVIDER_ERROR_PARSING_DATA: Problem parsing downloaded ODRS data.
|
|
* @GS_ODRS_PROVIDER_ERROR_NO_NETWORK: Offline or network unavailable.
|
|
* @GS_ODRS_PROVIDER_ERROR_SERVER_ERROR: Server returned an error.
|
|
* @GS_ODRS_PROVIDER_ERROR_CLIENT_ERROR: Client made an invalid submission,
|
|
* such as upvoting a review twice. (Since: 48)
|
|
*
|
|
* Error codes for #GsOdrsProvider.
|
|
*
|
|
* Since: 42
|
|
*/
|
|
typedef enum {
|
|
GS_ODRS_PROVIDER_ERROR_DOWNLOADING,
|
|
GS_ODRS_PROVIDER_ERROR_PARSING_DATA,
|
|
GS_ODRS_PROVIDER_ERROR_NO_NETWORK,
|
|
GS_ODRS_PROVIDER_ERROR_SERVER_ERROR,
|
|
GS_ODRS_PROVIDER_ERROR_CLIENT_ERROR,
|
|
} GsOdrsProviderError;
|
|
|
|
#define GS_ODRS_PROVIDER_ERROR gs_odrs_provider_error_quark ()
|
|
GQuark gs_odrs_provider_error_quark (void);
|
|
|
|
/**
|
|
* GsOdrsProviderRefineFlags:
|
|
* @GS_ODRS_PROVIDER_REFINE_FLAGS_GET_RATINGS: Get the numerical ratings for the app.
|
|
* @GS_ODRS_PROVIDER_REFINE_FLAGS_GET_REVIEWS: Get the written reviews for the app.
|
|
*
|
|
* The flags for refining apps to get their reviews or ratings.
|
|
*
|
|
* Since: 42
|
|
*/
|
|
typedef enum {
|
|
GS_ODRS_PROVIDER_REFINE_FLAGS_GET_RATINGS = (1 << 0),
|
|
GS_ODRS_PROVIDER_REFINE_FLAGS_GET_REVIEWS = (1 << 1),
|
|
} GsOdrsProviderRefineFlags;
|
|
|
|
#define GS_TYPE_ODRS_PROVIDER (gs_odrs_provider_get_type ())
|
|
|
|
G_DECLARE_FINAL_TYPE (GsOdrsProvider, gs_odrs_provider, GS, ODRS_PROVIDER, GObject)
|
|
|
|
GsOdrsProvider *gs_odrs_provider_new (const gchar *review_server,
|
|
const gchar *user_hash,
|
|
const gchar *distro,
|
|
guint64 max_cache_age_secs,
|
|
guint n_results_max,
|
|
SoupSession *session);
|
|
|
|
void gs_odrs_provider_refresh_ratings_async (GsOdrsProvider *self,
|
|
guint64 cache_age_secs,
|
|
GsDownloadProgressCallback progress_callback,
|
|
gpointer progress_user_data,
|
|
GCancellable *cancellable,
|
|
GAsyncReadyCallback callback,
|
|
gpointer user_data);
|
|
gboolean gs_odrs_provider_refresh_ratings_finish(GsOdrsProvider *self,
|
|
GAsyncResult *result,
|
|
GError **error);
|
|
|
|
void gs_odrs_provider_refine_async (GsOdrsProvider *self,
|
|
GsAppList *list,
|
|
GsOdrsProviderRefineFlags flags,
|
|
GCancellable *cancellable,
|
|
GAsyncReadyCallback callback,
|
|
gpointer user_data);
|
|
gboolean gs_odrs_provider_refine_finish (GsOdrsProvider *self,
|
|
GAsyncResult *result,
|
|
GError **error);
|
|
|
|
void gs_odrs_provider_submit_review_async (GsOdrsProvider *self,
|
|
GsApp *app,
|
|
AsReview *review,
|
|
GCancellable *cancellable,
|
|
GAsyncReadyCallback callback,
|
|
gpointer user_data);
|
|
gboolean gs_odrs_provider_submit_review_finish (GsOdrsProvider *self,
|
|
GAsyncResult *result,
|
|
GError **error);
|
|
void gs_odrs_provider_upvote_review_async (GsOdrsProvider *self,
|
|
GsApp *app,
|
|
AsReview *review,
|
|
GCancellable *cancellable,
|
|
GAsyncReadyCallback callback,
|
|
gpointer user_data);
|
|
gboolean gs_odrs_provider_upvote_review_finish (GsOdrsProvider *self,
|
|
GAsyncResult *result,
|
|
GError **error);
|
|
void gs_odrs_provider_downvote_review_async (GsOdrsProvider *self,
|
|
GsApp *app,
|
|
AsReview *review,
|
|
GCancellable *cancellable,
|
|
GAsyncReadyCallback callback,
|
|
gpointer user_data);
|
|
gboolean gs_odrs_provider_downvote_review_finish(GsOdrsProvider *self,
|
|
GAsyncResult *result,
|
|
GError **error);
|
|
void gs_odrs_provider_report_review_async (GsOdrsProvider *self,
|
|
GsApp *app,
|
|
AsReview *review,
|
|
GCancellable *cancellable,
|
|
GAsyncReadyCallback callback,
|
|
gpointer user_data);
|
|
gboolean gs_odrs_provider_report_review_finish (GsOdrsProvider *self,
|
|
GAsyncResult *result,
|
|
GError **error);
|
|
void gs_odrs_provider_remove_review_async (GsOdrsProvider *self,
|
|
GsApp *app,
|
|
AsReview *review,
|
|
GCancellable *cancellable,
|
|
GAsyncReadyCallback callback,
|
|
gpointer user_data);
|
|
gboolean gs_odrs_provider_remove_review_finish (GsOdrsProvider *self,
|
|
GAsyncResult *result,
|
|
GError **error);
|
|
G_END_DECLS
|