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
|
/* -*- 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+
*/
#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 rejected ODRS submission or returned an error.
*
* 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,
} 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);
gboolean gs_odrs_provider_submit_review (GsOdrsProvider *self,
GsApp *app,
AsReview *review,
GCancellable *cancellable,
GError **error);
gboolean gs_odrs_provider_report_review (GsOdrsProvider *self,
GsApp *app,
AsReview *review,
GCancellable *cancellable,
GError **error);
gboolean gs_odrs_provider_upvote_review (GsOdrsProvider *self,
GsApp *app,
AsReview *review,
GCancellable *cancellable,
GError **error);
gboolean gs_odrs_provider_downvote_review (GsOdrsProvider *self,
GsApp *app,
AsReview *review,
GCancellable *cancellable,
GError **error);
gboolean gs_odrs_provider_dismiss_review (GsOdrsProvider *self,
GsApp *app,
AsReview *review,
GCancellable *cancellable,
GError **error);
gboolean gs_odrs_provider_remove_review (GsOdrsProvider *self,
GsApp *app,
AsReview *review,
GCancellable *cancellable,
GError **error);
gboolean gs_odrs_provider_add_unvoted_reviews (GsOdrsProvider *self,
GsAppList *list,
GCancellable *cancellable,
GError **error);
G_END_DECLS
|
