GuildRESTAPI¶

Inherits: DiscordRESTAPI < Reference < Object

Description¶

Guild REST API implementation.

Methods¶

return type	signature
Guild	create_guild ( Dictionary params ) coroutine
Guild	get_guild ( int guild_id, bool with_counts=false ) coroutine
Object	get_guild_preview ( int _guild_id )
Guild	edit_guild ( int guild_id, Dictionary params, String reason="" ) coroutine
bool	delete_guild ( int guild_id ) coroutine
Array	get_guild_channels ( int guild_id ) coroutine
Channel	create_guild_channel ( int guild_id, Dictionary params, String reason ) coroutine
bool	edit_guild_channel_positions ( int guild_id, Array params ) coroutine
Guild.Member	get_guild_member ( int guild_id, Variant user_id ) coroutine
Array	list_guild_members ( int guild_id, int limit=1, int after=0 ) coroutine
Array	search_guild_members ( int guild_id, String query, int limit=1 ) coroutine
Array	add_guild_member ( int guild_id, int user_id, Dictionary params ) coroutine
Array	edit_guild_member ( int guild_id, int user_id, Dictionary params, String reason="" ) coroutine
Array	edit_current_member ( int guild_id, Dictionary params, String reason="" ) coroutine
bool	add_guild_member_role ( int guild_id, int user_id, int role_id, String reason="" ) coroutine
bool	remove_guild_member_role ( int guild_id, int user_id, int role_id, String reason="" ) coroutine
bool	remove_guild_member ( int guild_id, int user_id, String reason="" ) coroutine
Array	get_guild_bans ( int guild_id ) coroutine
GuildBan	get_guild_ban ( int guild_id, int user_id ) coroutine
bool	create_guild_ban ( int guild_id, int user_id, Dictionary params, String reason="" ) coroutine
bool	remove_guild_ban ( int guild_id, int user_id, String reason="" ) coroutine
Array	get_guild_roles ( int guild_id ) coroutine
Guild.Role	create_guild_role ( int guild_id, Dictionary params, String reason="" ) coroutine
Array	edit_guild_role_positions ( int guild_id, Array params, String reason="" ) coroutine
Guild.Role	edit_guild_role ( int guild_id, int role_id, Dictionary params, String reason="" ) coroutine
bool	delete_guild_role ( int guild_id, int role_id, String reason="" ) coroutine
int	get_guild_prune_count ( int guild_id, int days=7, PoolStringArray include_roles=[ ] ) coroutine
int	begin_guild_prune ( int guild_id, Dictionary params, String reason="" ) coroutine
Array	get_guild_voice_regions ( int guild_id ) coroutine
Array	get_guild_invites ( int guild_id ) coroutine
Array	get_guild_integrations ( int _guild_id )
bool	delete_guild_integration ( int _guild_id, int _integration_id )
Object	get_guild_widget_settings ( int _guild_id )
Object	edit_guild_widget_settings ( int _guild_id, Dictionary _params )
Object	get_guild_widget ( int _guild_id )
Guild.Invite	get_guild_vanity_url ( int guild_id ) coroutine
Texture	get_guild_widget_image ( int guild_id, String style="shield" ) coroutine
WelcomeScreen	get_guild_welcome_screen ( int _guild_id )
WelcomeScreen	edit_guild_welcome_screen ( int _guild_id, Dictionary _params )
void	edit_current_user_voice_state ( int _guild_id, Dictionary _params )
void	edit_user_voice_state ( int _guild_id, int _user_id, Dictionary _params )

Method Descriptions¶

• GuildRESTAPI GuildRESTAPI ( String _token, DiscordRESTRequester _requester, BaseDiscordEntityManager _entity_manager )

  Constructs a new GuildRESTAPI object.

  ---

• Guild create_guild ( Dictionary params ) coroutine

  Creates a new guild.
  https://discord.com/developers/docs/resources/guild#create-guild

  ---

• Guild get_guild ( int guild_id, bool with_counts=false ) coroutine

  Returns the guild object for the given guild_id.
  https://discord.com/developers/docs/resources/guild#get-guild

  ---

• Object get_guild_preview ( int _guild_id )

  There is currently no description for this method.

  ---

• Guild edit_guild ( int guild_id, Dictionary params, String reason="" ) coroutine

  Modifies a guild's settings. Returns the updated guild object.
  https://discord.com/developers/docs/resources/guild#modify-guild

  ---

• bool delete_guild ( int guild_id ) coroutine

  Delete a guild permanently. User must be owner. Returns true on success.
  https://discord.com/developers/docs/resources/guild#delete-guild

  ---

• Array get_guild_channels ( int guild_id ) coroutine

  Returns a list of guild channel. Does not include threads.
  https://discord.com/developers/docs/resources/guild#get-guild-channels

  ---

• Channel create_guild_channel ( int guild_id, Dictionary params, String reason ) coroutine

  Creates a new channel for the guild.
  https://discord.com/developers/docs/resources/guild#create-guild-channel

  ---

• bool edit_guild_channel_positions ( int guild_id, Array params ) coroutine

  Modify the positions of a set of channel for the guild. Returns true on success.
  https://discord.com/developers/docs/resources/guild#modify-guild-channel-positions

  ---

• Guild.Member get_guild_member ( int guild_id, Variant user_id ) coroutine

  Returns a Guild.Member object for the specified user_id.
  https://discord.com/developers/docs/resources/guild#get-guild-member

  ---

• Array list_guild_members ( int guild_id, int limit=1, int after=0 ) coroutine

  Returns a list of Guild.Member objects that are members of the guild.
  https://discord.com/developers/docs/resources/guild#list-guild-members

  ---

• Array search_guild_members ( int guild_id, String query, int limit=1 ) coroutine

  Returns a list of Guild.Member objects whose username or nickname starts with a provided query string.
  https://discord.com/developers/docs/resources/guild#search-guild-members

  ---

• Array add_guild_member ( int guild_id, int user_id, Dictionary params ) coroutine

  Adds a user to the guild, provided you have a valid oauth2 access token for the user with the guilds.join scope.
  https://discord.com/developers/docs/resources/guild#add-guild-member

  ---

• Array edit_guild_member ( int guild_id, int user_id, Dictionary params, String reason="" ) coroutine

  Modify attributes of a guild member.
  https://discord.com/developers/docs/resources/guild#modify-guild-member

  ---

• Array edit_current_member ( int guild_id, Dictionary params, String reason="" ) coroutine

  Modifies the current member in a guild.
  https://discord.com/developers/docs/resources/guild#modify-current-member

  ---

• bool add_guild_member_role ( int guild_id, int user_id, int role_id, String reason="" ) coroutine

  Adds a role to a guild member. Returns true on success.
  https://discord.com/developers/docs/resources/guild#add-guild-member-role

  ---

• bool remove_guild_member_role ( int guild_id, int user_id, int role_id, String reason="" ) coroutine

  Removes a role from a guild member. Returns true on success.
  https://discord.com/developers/docs/resources/guild#remove-guild-member-role

  ---

• bool remove_guild_member ( int guild_id, int user_id, String reason="" ) coroutine

  Removes a member from a guild. Returns true on success.
  https://discord.com/developers/docs/resources/guild#remove-guild-member

  ---

• Array get_guild_bans ( int guild_id ) coroutine

  Returns a list of GuildBan objects for the users banned from a guild.
  https://discord.com/developers/docs/resources/guild#get-guild-bans

  ---

• GuildBan get_guild_ban ( int guild_id, int user_id ) coroutine

  Returns a GuildBan object for the given user_id.
  https://discord.com/developers/docs/resources/guild#get-guild-ban

  ---

• bool create_guild_ban ( int guild_id, int user_id, Dictionary params, String reason="" ) coroutine

  Creates a guild ban, and optionally delete previous messages sent by the banned user. Returns true on success.
  https://discord.com/developers/docs/resources/guild#create-guild-ban

  ---

• bool remove_guild_ban ( int guild_id, int user_id, String reason="" ) coroutine

  Removes the ban for a user. Returns true on success.
  https://discord.com/developers/docs/resources/guild#remove-guild-ban

  ---

• Array get_guild_roles ( int guild_id ) coroutine

  Returns a list of Guild.Role objects for the guild.
  https://discord.com/developers/docs/resources/guild#get-guild-roles

  ---

• Guild.Role create_guild_role ( int guild_id, Dictionary params, String reason="" ) coroutine

  Create a new role for the guild.
  https://discord.com/developers/docs/resources/guild#create-guild-role

  ---

• Array edit_guild_role_positions ( int guild_id, Array params, String reason="" ) coroutine

  Modifies the positions of the guild roles. Returns a list of all of the guild's role objects on success.
  https://discord.com/developers/docs/resources/guild#modify-guild-role-positions

  ---

• Guild.Role edit_guild_role ( int guild_id, int role_id, Dictionary params, String reason="" ) coroutine

  Modifies the properties of a role. Returns the updated role on success. https://discord.com/developers/docs/resources/guild#modify-guild-role

  ---

• bool delete_guild_role ( int guild_id, int role_id, String reason="" ) coroutine

  Deletes a guild role. Returns true on success. https://discord.com/developers/docs/resources/guild#delete-guild-role

  ---

• int get_guild_prune_count ( int guild_id, int days=7, PoolStringArray include_roles=[ ] ) coroutine

  Returns the guild prune count indicating the number of members that would be removed in a prune operation.
  https://discord.com/developers/docs/resources/guild#get-guild-prune-count

  ---

• int begin_guild_prune ( int guild_id, Dictionary params, String reason="" ) coroutine

  Begin a prune operation. https://discord.com/developers/docs/resources/guild#begin-guild-prune

  ---

• Array get_guild_voice_regions ( int guild_id ) coroutine

  Returns a list of DiscordVoiceRegion objects for the guild. https://discord.com/developers/docs/resources/guild#get-guild-voice-regions

  ---

• Array get_guild_invites ( int guild_id ) coroutine

  Returns a list of Guild.Invite objects for the guild.
  https://discord.com/developers/docs/resources/guild#get-guild-invites

  ---

• Array get_guild_integrations ( int _guild_id )

  There is currently no description for this method.

  ---

• bool delete_guild_integration ( int _guild_id, int _integration_id )

  There is currently no description for this method.

  ---

• Object get_guild_widget_settings ( int _guild_id )

  There is currently no description for this method.

  ---

• Object edit_guild_widget_settings ( int _guild_id, Dictionary _params )

  There is currently no description for this method.

  ---

• Object get_guild_widget ( int _guild_id )

  There is currently no description for this method.

  ---

• Guild.Invite get_guild_vanity_url ( int guild_id ) coroutine

  Returns a partial Guild.Invite object for guilds with that feature enabled.
  https://discord.com/developers/docs/resources/guild#get-guild-vanity-url

  ---

• Texture get_guild_widget_image ( int guild_id, String style="shield" ) coroutine

  Returns a PNG image widget for the guild. https://discord.com/developers/docs/resources/guild#get-guild-widget-image

  ---

• WelcomeScreen get_guild_welcome_screen ( int _guild_id )

  There is currently no description for this method.

  ---

• WelcomeScreen edit_guild_welcome_screen ( int _guild_id, Dictionary _params )

  There is currently no description for this method.

  ---

• void edit_current_user_voice_state ( int _guild_id, Dictionary _params )

  There is currently no description for this method.

  ---

• void edit_user_voice_state ( int _guild_id, int _user_id, Dictionary _params )

  There is currently no description for this method.

  ---