Nostrum.Api.get_invite
You're seeing just the function
get_invite
, go back to Nostrum.Api module for more information.
Specs
get_invite(Nostrum.Struct.Invite.code(), options()) :: error() | {:ok, Nostrum.Struct.Invite.simple_invite()}
Gets an invite by its invite_code
.
If successful, returns {:ok, invite}
. Otherwise, returns a
Nostrum.Api.error/0
.
Options
:with_counts
(boolean) - whether to include member count fields
Examples
Nostrum.Api.get_invite("zsjUsC")
Nostrum.Api.get_invite("zsjUsC", with_counts: true)