Mercurial > pidgin3 / file comparison

comparison: libpurple/purpleauthorizationrequest.h

libpurple/purpleauthorizationrequest.h

changeset 42387
d9350cda1556
parent 42344
c51d37734155
child 42594
eddde70cedd8
equal deleted inserted replaced
42386:63de4915950b 42387:d9350cda1556
25 25
26 #include <glib.h> 26 #include <glib.h>
27 #include <glib-object.h> 27 #include <glib-object.h>
28 28
29 #include "purpleaccount.h" 29 #include "purpleaccount.h"
30 #include "purpleversion.h"
30 31
31 G_BEGIN_DECLS 32 G_BEGIN_DECLS
32 33
33 /** 34 /**
34 * PurpleAuthorizationRequest: 35 * PurpleAuthorizationRequest:
40 * Since: 3.0.0 41 * Since: 3.0.0
41 */ 42 */
42 43
43 #define PURPLE_TYPE_AUTHORIZATION_REQUEST (purple_authorization_request_get_type()) 44 #define PURPLE_TYPE_AUTHORIZATION_REQUEST (purple_authorization_request_get_type())
44 45
46 PURPLE_AVAILABLE_IN_3_0
45 G_DECLARE_FINAL_TYPE(PurpleAuthorizationRequest, purple_authorization_request, 47 G_DECLARE_FINAL_TYPE(PurpleAuthorizationRequest, purple_authorization_request,
46 PURPLE, AUTHORIZATION_REQUEST, GObject) 48 PURPLE, AUTHORIZATION_REQUEST, GObject)
47 49
48 /** 50 /**
49 * purple_authorization_request_new: 51 * purple_authorization_request_new:
56 * 58 *
57 * Returns: The new instance. 59 * Returns: The new instance.
58 * 60 *
59 * Since: 3.0.0 61 * Since: 3.0.0
60 */ 62 */
63 PURPLE_AVAILABLE_IN_3_0
61 PurpleAuthorizationRequest *purple_authorization_request_new(PurpleAccount *account, const gchar *username); 64 PurpleAuthorizationRequest *purple_authorization_request_new(PurpleAccount *account, const gchar *username);
62 65
63 /** 66 /**
64 * purple_authorization_request_get_account: 67 * purple_authorization_request_get_account:
65 * @request: The instance. 68 * @request: The instance.
68 * 71 *
69 * Returns: (transfer none): The account. 72 * Returns: (transfer none): The account.
70 * 73 *
71 * Since: 3.0.0 74 * Since: 3.0.0
72 */ 75 */
76 PURPLE_AVAILABLE_IN_3_0
73 PurpleAccount *purple_authorization_request_get_account(PurpleAuthorizationRequest *request); 77 PurpleAccount *purple_authorization_request_get_account(PurpleAuthorizationRequest *request);
74 78
75 /** 79 /**
76 * purple_authorization_request_get_username: 80 * purple_authorization_request_get_username:
77 * @request: The instance. 81 * @request: The instance.
80 * 84 *
81 * Returns: The username of the remote user. 85 * Returns: The username of the remote user.
82 * 86 *
83 * Since: 3.0.0 87 * Since: 3.0.0
84 */ 88 */
89 PURPLE_AVAILABLE_IN_3_0
85 const gchar *purple_authorization_request_get_username(PurpleAuthorizationRequest *request); 90 const gchar *purple_authorization_request_get_username(PurpleAuthorizationRequest *request);
86 91
87 /** 92 /**
88 * purple_authorization_request_set_alias: 93 * purple_authorization_request_set_alias:
89 * @request: The instance. 94 * @request: The instance.
92 * Sets the alias of the remote user to @alias. User interfaces can use this 97 * Sets the alias of the remote user to @alias. User interfaces can use this
93 * when presenting the authorization request to the end user. 98 * when presenting the authorization request to the end user.
94 * 99 *
95 * Since: 3.0.0 100 * Since: 3.0.0
96 */ 101 */
102 PURPLE_AVAILABLE_IN_3_0
97 void purple_authorization_request_set_alias(PurpleAuthorizationRequest *request, const gchar *alias); 103 void purple_authorization_request_set_alias(PurpleAuthorizationRequest *request, const gchar *alias);
98 104
99 /** 105 /**
100 * purple_authorization_request_get_alias: 106 * purple_authorization_request_get_alias:
101 * @request: The instance. 107 * @request: The instance.
104 * 110 *
105 * Returns: (nullable): The alias if one was set. 111 * Returns: (nullable): The alias if one was set.
106 * 112 *
107 * Since: 3.0.0 113 * Since: 3.0.0
108 */ 114 */
115 PURPLE_AVAILABLE_IN_3_0
109 const gchar *purple_authorization_request_get_alias(PurpleAuthorizationRequest *request); 116 const gchar *purple_authorization_request_get_alias(PurpleAuthorizationRequest *request);
110 117
111 /** 118 /**
112 * purple_authorization_request_set_message: 119 * purple_authorization_request_set_message:
113 * @request: The instance. 120 * @request: The instance.
116 * Sets an optional message from remote user, that the user interface can 123 * Sets an optional message from remote user, that the user interface can
117 * display to the end user. 124 * display to the end user.
118 * 125 *
119 * Since: 3.0.0 126 * Since: 3.0.0
120 */ 127 */
128 PURPLE_AVAILABLE_IN_3_0
121 void purple_authorization_request_set_message(PurpleAuthorizationRequest *request, const gchar *message); 129 void purple_authorization_request_set_message(PurpleAuthorizationRequest *request, const gchar *message);
122 130
123 /** 131 /**
124 * purple_authorization_request_get_message: 132 * purple_authorization_request_get_message:
125 * @request: The instance. 133 * @request: The instance.
128 * 136 *
129 * Returns: (nullable): The optional message. 137 * Returns: (nullable): The optional message.
130 * 138 *
131 * Since: 3.0.0 139 * Since: 3.0.0
132 */ 140 */
141 PURPLE_AVAILABLE_IN_3_0
133 const gchar *purple_authorization_request_get_message(PurpleAuthorizationRequest *request); 142 const gchar *purple_authorization_request_get_message(PurpleAuthorizationRequest *request);
134 143
135 /** 144 /**
136 * purple_authorization_request_set_add: 145 * purple_authorization_request_set_add:
137 * @request: The instance. 146 * @request: The instance.
140 * Sets whether or not the user interface should ask the end user to add the 149 * Sets whether or not the user interface should ask the end user to add the
141 * remote user if the remote user was accepted. 150 * remote user if the remote user was accepted.
142 * 151 *
143 * Since: 3.0.0 152 * Since: 3.0.0
144 */ 153 */
154 PURPLE_AVAILABLE_IN_3_0
145 void purple_authorization_request_set_add(PurpleAuthorizationRequest *request, gboolean add); 155 void purple_authorization_request_set_add(PurpleAuthorizationRequest *request, gboolean add);
146 156
147 /** 157 /**
148 * purple_authorization_request_get_add: 158 * purple_authorization_request_get_add:
149 * @request: The instance. 159 * @request: The instance.
154 * Returns: %TRUE if the user interface should request the end user to add the 164 * Returns: %TRUE if the user interface should request the end user to add the
155 * remote user back. 165 * remote user back.
156 * 166 *
157 * Since: 3.0.0 167 * Since: 3.0.0
158 */ 168 */
169 PURPLE_AVAILABLE_IN_3_0
159 gboolean purple_authorization_request_get_add(PurpleAuthorizationRequest *request); 170 gboolean purple_authorization_request_get_add(PurpleAuthorizationRequest *request);
160 171
161 /** 172 /**
162 * purple_authorization_request_accept: 173 * purple_authorization_request_accept:
163 * @request: The instance. 174 * @request: The instance.
168 * If this is called multiple times, or called after 179 * If this is called multiple times, or called after
169 * [method@AuthorizationRequest.deny] then this does nothing. 180 * [method@AuthorizationRequest.deny] then this does nothing.
170 * 181 *
171 * Since: 3.0.0 182 * Since: 3.0.0
172 */ 183 */
184 PURPLE_AVAILABLE_IN_3_0
173 void purple_authorization_request_accept(PurpleAuthorizationRequest *request); 185 void purple_authorization_request_accept(PurpleAuthorizationRequest *request);
174 186
175 /** 187 /**
176 * purple_authorization_request_deny: 188 * purple_authorization_request_deny:
177 * @request: The instance. 189 * @request: The instance.
183 * If this is called multiple times, or called after 195 * If this is called multiple times, or called after
184 * [method@AuthorizationRequest.accept] then this does nothing. 196 * [method@AuthorizationRequest.accept] then this does nothing.
185 * 197 *
186 * Since: 3.0.0 198 * Since: 3.0.0
187 */ 199 */
200 PURPLE_AVAILABLE_IN_3_0
188 void purple_authorization_request_deny(PurpleAuthorizationRequest *request, const gchar *message); 201 void purple_authorization_request_deny(PurpleAuthorizationRequest *request, const gchar *message);
189 202
190 G_END_DECLS 203 G_END_DECLS
191 204
192 #endif /* PURPLE_AUTHORIZATION_REQUEST_H */ 205 #endif /* PURPLE_AUTHORIZATION_REQUEST_H */

Mercurial Repository: pidgin3

mercurial