Discord Elixir v1.1.4 DiscordEx.RestClient.Resources.Invite

Convience helper for invites

Summary

Functions

Accept invite

Delete invite object

Get invite object

Functions

accept(conn, invite_id)

Specs

accept(pid, String.t) :: map

Accept invite

Accept an invite. This is not available to bot accounts, and requires the guilds.join OAuth2 scope to accept on behalf of normal users.

Parameters

  • conn: User connection for REST holding auth info
  • invite_id: Invite id

Examples

Invite.accept(conn, "99999999993832")
delete(conn, invite_id)

Specs

delete(pid, String.t) :: map

Delete invite object

Requires the MANAGE_CHANNELS permission. Returns an invite object on success.

Parameters

  • conn: User connection for REST holding auth info
  • invite_id: Invite id

Examples

Invite.delete(conn, "99999999993832")
get(conn, invite_id)

Specs

get(pid, String.t) :: map

Get invite object

Parameters

  • conn: User connection for REST holding auth info
  • invite_id: Invite id

Examples

Invite.get(conn, "99999999993832")