aboutsummaryrefslogtreecommitdiff
path: root/src/request.h
blob: 91789ab0bb8ad23b3edc937d0b0ba6780f79e82d (plain) (blame)
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
/*
   This file is part of GNUnet.
   Copyright (C) 2024 GNUnet e.V.

   GNUnet is free software: you can redistribute it and/or modify it
   under the terms of the GNU Affero General Public License as published
   by the Free Software Foundation, either version 3 of the License,
   or (at your option) any later version.

   GNUnet 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
   Affero General Public License for more details.

   You should have received a copy of the GNU Affero General Public License
   along with this program.  If not, see <http://www.gnu.org/licenses/>.

   SPDX-License-Identifier: AGPL3.0-or-later
 */
/*
 * @author Tobias Frisch
 * @file request.h
 */

#ifndef REQUEST_H_
#define REQUEST_H_

#include <gio/gio.h>

#ifndef MESSENGER_APPLICATION_NO_PORTAL
#include <libportal/portal.h>
#else
typedef enum XdpBackgroundFlags {
  XDP_BACKGROUND_FLAG_ACTIVATABLE = 1,
  XDP_BACKGROUND_FLAG_AUTOSTART = 2,
  XDP_BACKGROUND_FLAG_NONE = 0,
} XdpBackgroundFlags;

typedef enum XdpCameraFlags {
  XDP_CAMERA_FLAG_NONE = 0,
} XdpCameraFlags;
#endif

#include "application.h"

typedef void (*MESSENGER_RequestCallback)(
  MESSENGER_Application *application,
  gboolean success,
  gboolean error,
  gpointer user_data
);

typedef struct MESSENGER_Request {
  MESSENGER_Application *application;
  MESSENGER_RequestCallback callback;
  GCancellable *cancellable;
  gpointer user_data;

#ifdef MESSENGER_APPLICATION_NO_PORTAL
  guint timeout;
#endif
} MESSENGER_Request;

/**
 * Creates a new request for the messsenger
 * application for a certain permission.
 *
 * The request object will automatically be
 * added to the list of the messenger application.
 *
 * @param application Messenger application
 * @param cancellable Cancellable object (optional)
 * @param user_data User data (optional)
 * @return New request object
 */
MESSENGER_Request*
request_new(MESSENGER_Application *application,
            MESSENGER_RequestCallback callback,
            GCancellable *cancellable,
            gpointer user_data);

/**
 * Creates a new request for the messsenger
 * application for a background permission.
 *
 * @param application Messenger application
 * @param flags Background flags
 * @param callback Callback
 * @param user_data User data
 * @return New background request object
 */
MESSENGER_Request*
request_new_background(MESSENGER_Application *application,
                       XdpBackgroundFlags flags,
                       MESSENGER_RequestCallback callback,
                       gpointer user_data);

/**
 * Creates a new request for the messsenger
 * application for a camera permission.
 *
 * @param application Messenger application
 * @param flags Camera flags
 * @param callback Callback
 * @param user_data User data
 * @return New camera request object
 */
MESSENGER_Request*
request_new_camera(MESSENGER_Application *application,
                   XdpCameraFlags flags,
                   MESSENGER_RequestCallback callback,
                   gpointer user_data);

/**
 * Cancel a request object if possible.
 *
 * @param request Request object
 */
void
request_cancel(MESSENGER_Request *request);

/**
 * Cleanup a request object and its owned
 * resources.
 *
 * @param request Request object
 */
void
request_cleanup(MESSENGER_Request *request);

/**
 * Drop a request object from the messenger
 * application list of requests.
 *
 * @param request Request object
 */
void
request_drop(MESSENGER_Request *request);

/**
 * Delete a request object and its owned 
 * resources.
 *
 * @param request Request object
 */
void
request_delete(MESSENGER_Request *request);

#endif /* REQUEST_H_ */