-
Notifications
You must be signed in to change notification settings - Fork 29
/
Copy pathconcord_guild.template
363 lines (324 loc) · 12.6 KB
/
concord_guild.template
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
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
include(./concord.m4)
CONCORD_HEADER(`concord_guild')
.SH NAME
concord_user - functions related to interacting with discord guilds
.SH SYNOPSIS
.B #include <concord/guild.h>
.br
.B #include <concord/discord.h>
.BI "CCORDcode discord_create_guild(struct discord *" "client" ","
.br
.BI " struct discord_create_guild *" "params" ","
.br
.BI " struct discord_ret_guild *" "ret" ");"
.BI "CCORDcode discord_get_guild(struct discord *" "client" ","
.br
.BI " u64snowflake" "guild_id" ","
.br
.BI " struct discord_ret_guild *" "ret" ");"
.BI "CCORDcode discord_get_guild_preview(struct discord *" "client" ","
.br
.BI " u64snowflake" "guild_id" ","
.br
.BI " struct discord_ret_guild_review *" \
"ret" ");"
.BI "CCORDcode discord_modify_guild(struct discord *" "client" ","
.br
.BI " u64snowflake" " guild_id" ","
.br
.BI " struct discord_modify_guild *" "params" ","
.br
.BI " struct discord_ret_guild *" "ret" ");"
.BI "CCORDcode discord_delete_guild(struct discord *" "client" ","
.br
.BI " struct discord_modify_guild *" "params" ","
.br
.BI " struct discord_ret_guild *" "ret" ");"
.BI "CCORDcode discord_get_guild_channel(struct discord *" "client" ","
.br
.BI " u64snowflake" " guild_id" ","
.br
.BI " struct discord_ret_channel *" "ret" \
");"
.BI "CCORDcode discord_create_guild_channel(struct discord *" "client" ","
.br
.BI " u64snowflake" " guild_id" ","
.br
.BI " struct discord_modify_guild_chann\
el_positions *" "params" ","
.br
.BI " struct discord_ret *" "ret" ");"
.BI "CCORDcode discord_get_guild_member(struct discord *" "client" ","
.br
.BI " u64snowflake" " guild_id" ","
.br
.BI " u64snowflake" " user_id" ","
.br
.BI " struct discord_ret_guild_member *" \
"ret" ");"
.BI "CCORDcode discord_list_guild_members(struct discord *" "client" ","
.br
.BI " u64snowflake" " guild_id" ","
.br
.BI " struct discord_list_guild_members *"\
params ","
.br
.BI " struct discord_ret_guild_members *" \
"ret" ");"
.BI "CCORDcode discord_search_guild_members(struct discord *" "client" ","
.br
.BI " u64snowflake" " guild_id" ","
.br
.BI " struct discord_search_guild_membe\
rs *" params ","
.br
.BI " struct discord_ret_guild_members *" \
"ret" ");"
.BI "CCORDcode discord_add_guild_member(struct discord *" "client" ","
.br
.BI " u64snowflake" " guild_id" ","
.br
.BI " u64snowflake" " user_id" ","
.br
.BI " struct discord_add_guild_member *" \
params ","
.br
.BI " struct discord_ret_guild_member *" \
"ret" ");"
.BI "CCORDcode discord_modify_guild_member(struct discord *" "client" ","
.br
.BI " u64snowflake" " guild_id" ","
.br
.BI " u64snowflake" " user_id" ","
.br
.BI " struct discord_modify_guild_member \
*" params ","
.br
.BI " struct discord_ret_guild_member *" \
"ret" ");"
.BI "CCORDcode discord_modify_current_member(struct discord *" "client" ","
.br
.BI " u64snowflake" " guild_id" ","
.br
.BI " struct discord_modify_current_me\
mber *" params ","
.br
.BI " struct discord_ret_guild_member \
*" "ret" ");"
.BI "CCORDcode discord_modify_current_user_nick(struct discord *" "client" ","
.br
.BI " u64snowflake" " guild_id" ","
.br
.BI " struct discord_modify_current\
_user_nick *" params ","
.br
.BI " struct discord_ret_guild_memb\
er *" "ret" ");"
.BI "CCORDcode discord_add_guild_member_role(struct discord *" "client" ","
.br
.BI " u64snowflake" " guild_id" ","
.br
.BI " u64snowflake" " user_id" ","
.br
.BI " u64snowflake" " role_id" ","
.br
.BI " struct discord_ret *" "ret" ");"
.br
.BI "CCORDcode discord_remove_guild_member_role(struct discord *" "client" ","
.br
.BI " u64snowflake" " guild_id" ","
.br
.BI " u64snowflake" " user_id" ","
.br
.BI " u64snowflake" " role_id" ","
.br
.BI " struct discord_ret *" "ret" \
");"
.br
.BI "CCORDcode discord_remove_guild_member(struct discord *" "client" ","
.br
.BI " u64snowflake" " guild_id" ","
.br
.BI " u64snowflake" " user_id" ","
.br
.BI " struct discord_ret *" "ret" ");"
.br
.BI "CCORDcode discord_get_guild_bans(struct discord *" "client" ","
.br
.BI " u64snowflake" " guild_id" ","
.br
.BI " struct discord_ret_bans *" "ret" ");"
.br
.BI "CCORDcode discord_get_guild_ban(struct discord *" "client" ","
.br
.BI " u64snowflake" " guild_id" ","
.br
.BI " u64snowflake" " user_id" ","
.br
.BI " struct discord_ret_ban *" "ret" ");"
.br
.BI "CCORDcode discord_create_guild_ban(struct discord *" "client" ","
.br
.BI " u64snowflake" " guild_id" ","
.br
.BI " u64snowflake" " user_id" ","
.br
.BI " struct discord_create_guild_ban *" \
"params" ");"
.br
.BI " struct discord_ret *" "ret" ");"
.br
.BI "CCORDcode discord_remove_guild_ban(struct discord *" "client" ","
.br
.BI " u64snowflake" " guild_id" ","
.br
.BI " u64snowflake" " user_id" ","
.br
.BI " struct discord_ret *" "ret" ");"
.br
.BI "CCORDcode discord_get_guild_roles(struct discord *" "client" ","
.br
.BI " u64snowflake" " guild_id" ","
.br
.BI " struct discord_ret_roles *" "ret" ");"
.br
.BI "CCORDcode discord_create_guild_role(struct discord *" "client" ","
.br
.BI " u64snowflake" " guild_id" ","
.br
.BI " struct discord_create_guild_role *" \
"params" ");"
.br
.BI " struct discord_ret_role *" "ret" ");"
.br
.BI "CCORDcode discord_begin_guild_prune(struct discord *" "client" ","
.br
.BI " u64snowflake" " guild_id" ","
.br
.BI " struct discord_begin_guild_prune *" \
"params" ");"
.br
.BI " struct discord_ret_role *" "ret" ");"
.br
.BI "CCORDcode discord_get_guild_invites(struct discord *" "client" ","
.br
.BI " u64snowflake" " guild_id" ","
.br
.BI " struct discord_ret_invites *" "ret" \
");"
.br
.BI "CCORDcode discord_delete_guild_integrations(struct discord *" "client" ","
.br
.BI " u64snowflake" " guild_id" ","
.br
.BI " u64snowflake" " integration_\
id" ","
.br
.BI " struct discord_ret *" "ret" \
");"
.br
.BI "CCORDcode discord_get_guild_vanity_url(struct discord *" "client" ","
.br
.BI " u64snowflake" " guild_id" ","
.br
.BI " struct discord_ret_invite *" "ret\
" ");"
.br
.BI "CCORDcode discord_get_guild_welcome_screen(struct discord *" "client" ","
.br
.BI " u64snowflake" " guild_id" ","
.br
.BI " struct discord_ret_welcome_sc\
reen *" "ret" ");"
.br
.BI "CCORDcode discord_modify_guild_role_positions(struct discord *" "client"\
","
.br
.BI " u64snowflake" " guild_id" ","
.br
.BI " struct discord_modify_guil\
d_role_positions *" "params" ","
.br
.BI " struct discord_ret_roles *\
" "ret" ");"
.br
.BI "CCORDcode discord_modify_guild_role(struct discord *" "client"\
","
.br
.BI " u64snowflake" " guild_id" ","
.br
.BI " u64snowflake" " role_id" ","
.br
.BI " struct discord_modify_guild_role *\
" "params" ","
.br
.BI " struct discord_ret_role *" "ret" ");"
.br
.BI "CCORDcode discord_delete_guild_role(struct discord *" "client"\
","
.br
.BI " u64snowflake" " guild_id" ","
.br
.BI " u64snowflake" " role_id" ","
.br
.BI " struct discord_ret *" "ret" ");"
.br
.SH DESCRIPTION
This manual documents the guild API provided by Concord. The functions shown in
this manual are used for manipulating the users, roles, channels, and more that
are inside of a Discord guild. While each function does not have its own
manual, each function is shown in the below table along with a description of
what it does.
.TS
tab(;);
lb l
_ _
lb l
.
Function;Description
CCORDcode discord_create_guild;Creates a Discord guild
CCORDcode discord_get_guild;Retrieves information about a Discord guild
CCORDcode discord_get_guild_preview;Retrieves the preview for a Discord guild
CCORDcode discord_modify_guild;Modify the settings of a Discord guild
CCORDcode discord_delete_guild;Delete a Discord guild
CCORDcode discord_get_guild_channels;Retrieve all the channels in a Discord \
guild
CCORDcode discord_create_guild_channel;Create a channel in a Discord guild
CCORDcode discord_modify_guild_channel_positions;Change the position of a \
channel in a Discord guild
CCORDcode discord_get_guild_member;Get a member of a Discord guild
CCORDcode discord_list_guild_members;Retrieve all members of a Discord guild
CCORDcode discord_search_guild_members;Search for members in a Discord guild
CCORDcode discord_add_guild_member;Add a member to a Discord guild
CCORDcode discord_modify_guild_member;Modify the information of a member of a \
Discord guild
CCORDcode discord_modify_current_member;Modify the current member of a \
Discord guild
CCORDcode discord_modify_current_user_nick;Modify the nickname of the current \
member of a Discord guild
CCORDcode discord_add_guild_member_role;Add a role to a member of a Discord \
guild
CCORDcode discord_remove_guild_member_role;Remove a role assigned to a member \
of a Discord guild
CCORDcode discord_remove_guild_member;Remove a member from a Discord guild
CCORDcode discord_get_guild_bans;Retrieve all bans in a Discord guild
CCORDcode discord_get_guild_ban;Retrieve individual ban in a Discord guild
CCORDcode discord_create_guild_ban;Ban a member of a Discord guild
CCORDcode discord_remove_guild_ban;Unban a user of a Discord guild
CCORDcode discord_get_guild_roles;Retrieve all the roles in a Discord guild
CCORDcode discord_create_guild_role;Create a role in a Discord guild
CCORDcode discord_begin_guild_prune;Remove inactive members of a Discord guild
CCORDcode discord_get_guild_invites;Retrieve all active invites of a Discord \
guild
CCORDcode discord_delete_guild_integrations;Delete an integration in a \
Discord guild
CCORDcode discord_get_guild_vanity_url;Get the vanity URL of a Discord guild
CCORDcode discord_get_guild_welcome_screen;Get the welcome screen of a \
Discord guild
CCORDcode discord_modify_guild_role_positions;Modfiy the positions of a role \
in a Discord guild
CCORDcode discord_modify_guild_role;Modify a role in a Discord guild
CCORDcode discord_delete_guild_role;Delete a role in a Discord guild
.TE
.SH SEE ALSO
.BR concord (3)