api

package

Go to main page

Versions in this module

v2

v2.1.0

Jun 8, 2021

v2.0.6

Apr 6, 2021

Changes in this version

type Client

+ func (c *Client) CrosspostMessage(channelID discord.ChannelID, messageID discord.MessageID) (*discord.Message, error)

v2.0.5

Feb 24, 2021

v2.0.4

Feb 14, 2021

Changes in this version

type Client

+ func (c *Client) SendEmbedReply(channelID discord.ChannelID, e discord.Embed, referenceID discord.MessageID) (*discord.Message, error)

+ func (c *Client) SendMessageReply(channelID discord.ChannelID, content string, embed *discord.Embed, ...) (*discord.Message, error)

+ func (c *Client) SendTextReply(channelID discord.ChannelID, content string, referenceID discord.MessageID) (*discord.Message, error)

v2.0.3

Feb 8, 2021

v2.0.2

Jan 30, 2021

Changes in this version

+ var EndpointApplications = Endpoint + "applications/"

+ var EndpointInteractions = Endpoint + "interactions/"

type Client

+ func (c *Client) Command(appID discord.AppID, commandID discord.CommandID) ([]discord.Command, error)

+ func (c *Client) Commands(appID discord.AppID) ([]discord.Command, error)

+ func (c *Client) CreateCommand(appID discord.AppID, data CreateCommandData) (*discord.Command, error)

+ func (c *Client) CreateGuildCommand(appID discord.AppID, guildID discord.GuildID, data CreateCommandData) (*discord.Command, error)

+ func (c *Client) DeleteCommand(appID discord.AppID, commandID discord.CommandID) error

+ func (c *Client) DeleteGuildCommand(appID discord.AppID, guildID discord.GuildID, commandID discord.CommandID) error

+ func (c *Client) EditCommand(appID discord.AppID, commandID discord.CommandID, data CreateCommandData) (*discord.Command, error)

+ func (c *Client) EditGuildCommand(appID discord.AppID, guildID discord.GuildID, commandID discord.CommandID, ...) (*discord.Command, error)

+ func (c *Client) GuildCommand(appID discord.AppID, guildID discord.GuildID, commandID discord.CommandID) ([]discord.Command, error)

+ func (c *Client) GuildCommands(appID discord.AppID, guildID discord.GuildID) ([]discord.Command, error)

+ func (c *Client) RespondInteraction(id discord.Snowflake, token string, data InteractionResponse) error

+ type CreateCommandData struct

+ Description string

+ Name string

+ Options []discord.CommandOption

+ type InteractionResponse struct

+ Data *InteractionResponseData

+ Type InteractionResponseType

+ type InteractionResponseData struct

+ AllowedMentions AllowedMentions

+ Content string

+ Embeds []discord.Embed

+ TTS bool

+ type InteractionResponseType uint

+ const AcknowledgeInteraction

+ const AcknowledgeInteractionWithSource

+ const MessageInteraction

+ const MessageInteractionWithSource

+ const PongInteraction

v2.0.1

Jan 25, 2021

v2.0.0

Jan 15, 2021

Changes in this version

+ const AttachmentSpoilerPrefix

+ const MaxGuildFetchLimit

+ const MaxMemberFetchLimit

+ const MaxMessageReactionFetchLimit

+ var BaseEndpoint = "https://discord.com"

+ var Endpoint = BaseEndpoint + Path + "/"

+ var EndpointAuth = Endpoint + "auth/"

+ var EndpointChannels = Endpoint + "channels/"

+ var EndpointGateway = Endpoint + "gateway"

+ var EndpointGatewayBot = EndpointGateway + "/bot"

+ var EndpointGuilds = Endpoint + "guilds/"

+ var EndpointInvites = Endpoint + "invites/"

+ var EndpointLogin = EndpointAuth + "login"

+ var EndpointMe = EndpointUsers + "@me"

+ var EndpointTOTP = EndpointAuth + "mfa/totp"

+ var EndpointUsers = Endpoint + "users/"

+ var EndpointWebhooks = Endpoint + "webhooks/"

+ var ErrEmptyMessage = errors.New("message is empty")

+ var ErrInvalidImageCT = errors.New("unknown image content-type")

+ var ErrInvalidImageData = errors.New("invalid image data")

+ var Path = "/api/v" + Version

+ var UserAgent = "DiscordBot (https://github.com/diamondburned/arikawa/v2)"

+ var Version = "8"

+ type Ack struct

+ Token string

+ type AddMemberData struct

+ Deaf option.Bool

+ Mute option.Bool

+ Nick option.String

+ Roles *[]discord.RoleID

+ Token string

+ type AllowedMentionType string

+ const AllowEveryoneMention

+ const AllowRoleMention

+ const AllowUserMention

+ type AllowedMentions struct

+ Parse []AllowedMentionType

+ RepliedUser option.Bool

+ Roles []discord.RoleID

+ Users []discord.UserID

+ func (am AllowedMentions) Verify() error

+ type AuditLogData struct

+ ActionType discord.AuditLogEvent

+ Before discord.AuditLogEntryID

+ Limit uint

+ UserID discord.UserID

+ type BanData struct

+ DeleteDays option.Uint

+ Reason option.String

+ type Client struct

+ func NewClient(token string) *Client

+ func NewCustomClient(token string, httpClient *httputil.Client) *Client

+ func (c *Client) Ack(channelID discord.ChannelID, messageID discord.MessageID, ack *Ack) error

+ func (c *Client) AddMember(guildID discord.GuildID, userID discord.UserID, data AddMemberData) (*discord.Member, error)

+ func (c *Client) AddRecipient(channelID discord.ChannelID, userID discord.UserID, ...) error

+ func (c *Client) AddRole(guildID discord.GuildID, userID discord.UserID, roleID discord.RoleID) error

+ func (c *Client) AttachIntegration(guildID discord.GuildID, integrationID discord.IntegrationID, ...) error

+ func (c *Client) AuditLog(guildID discord.GuildID, data AuditLogData) (*discord.AuditLog, error)

+ func (c *Client) Ban(guildID discord.GuildID, userID discord.UserID, data BanData) error

+ func (c *Client) Bans(guildID discord.GuildID) ([]discord.Ban, error)

+ func (c *Client) ChangeOwnNickname(guildID discord.GuildID, nick string) error

+ func (c *Client) Channel(channelID discord.ChannelID) (*discord.Channel, error)

+ func (c *Client) ChannelInvites(channelID discord.ChannelID) ([]discord.Invite, error)

+ func (c *Client) ChannelWebhooks(channelID discord.ChannelID) ([]discord.Webhook, error)

+ func (c *Client) Channels(guildID discord.GuildID) ([]discord.Channel, error)

+ func (c *Client) CreateChannel(guildID discord.GuildID, data CreateChannelData) (*discord.Channel, error)

+ func (c *Client) CreateEmoji(guildID discord.GuildID, data CreateEmojiData) (*discord.Emoji, error)

+ func (c *Client) CreateGuild(data CreateGuildData) (*discord.Guild, error)

+ func (c *Client) CreateInvite(channelID discord.ChannelID, data CreateInviteData) (*discord.Invite, error)

+ func (c *Client) CreatePrivateChannel(recipientID discord.UserID) (*discord.Channel, error)

+ func (c *Client) CreateRole(guildID discord.GuildID, data CreateRoleData) (*discord.Role, error)

+ func (c *Client) CreateWebhook(channelID discord.ChannelID, data CreateWebhookData) (*discord.Webhook, error)

+ func (c *Client) DeleteAllReactions(channelID discord.ChannelID, messageID discord.MessageID) error

+ func (c *Client) DeleteChannel(channelID discord.ChannelID) error

+ func (c *Client) DeleteChannelPermission(channelID discord.ChannelID, overwriteID discord.Snowflake) error

+ func (c *Client) DeleteEmoji(guildID discord.GuildID, emojiID discord.EmojiID) error

+ func (c *Client) DeleteGuild(id discord.GuildID) error

+ func (c *Client) DeleteInvite(code string) (*discord.Invite, error)

+ func (c *Client) DeleteMessage(channelID discord.ChannelID, messageID discord.MessageID) error

+ func (c *Client) DeleteMessages(channelID discord.ChannelID, messageIDs []discord.MessageID) error

+ func (c *Client) DeleteReactions(channelID discord.ChannelID, messageID discord.MessageID, ...) error

+ func (c *Client) DeleteRelationship(userID discord.UserID) error

+ func (c *Client) DeleteRole(guildID discord.GuildID, roleID discord.RoleID) error

+ func (c *Client) DeleteUserReaction(channelID discord.ChannelID, messageID discord.MessageID, ...) error

+ func (c *Client) DeleteWebhook(webhookID discord.WebhookID) error

+ func (c *Client) EditChannelPermission(channelID discord.ChannelID, overwriteID discord.Snowflake, ...) error

+ func (c *Client) EditEmbed(channelID discord.ChannelID, messageID discord.MessageID, embed discord.Embed) (*discord.Message, error)

+ func (c *Client) EditMessage(channelID discord.ChannelID, messageID discord.MessageID, content string, ...) (*discord.Message, error)

+ func (c *Client) EditMessageComplex(channelID discord.ChannelID, messageID discord.MessageID, data EditMessageData) (*discord.Message, error)

+ func (c *Client) EditText(channelID discord.ChannelID, messageID discord.MessageID, content string) (*discord.Message, error)

+ func (c *Client) Emoji(guildID discord.GuildID, emojiID discord.EmojiID) (*discord.Emoji, error)

+ func (c *Client) Emojis(guildID discord.GuildID) ([]discord.Emoji, error)

+ func (c *Client) GetBan(guildID discord.GuildID, userID discord.UserID) (*discord.Ban, error)

+ func (c *Client) Guild(id discord.GuildID) (*discord.Guild, error)

+ func (c *Client) GuildInvites(guildID discord.GuildID) ([]discord.Invite, error)

+ func (c *Client) GuildPreview(id discord.GuildID) (*discord.GuildPreview, error)

+ func (c *Client) GuildVanityInvite(guildID discord.GuildID) (*discord.Invite, error)

+ func (c *Client) GuildWebhooks(guildID discord.GuildID) ([]discord.Webhook, error)

+ func (c *Client) GuildWidget(guildID discord.GuildID) (*discord.GuildWidget, error)

+ func (c *Client) GuildWidgetImage(guildID discord.GuildID, img GuildWidgetImageStyle) (io.ReadCloser, error)

+ func (c *Client) GuildWidgetImageURL(guildID discord.GuildID, img GuildWidgetImageStyle) string

+ func (c *Client) GuildWidgetSettings(guildID discord.GuildID) (*discord.GuildWidgetSettings, error)

+ func (c *Client) GuildWithCount(id discord.GuildID) (*discord.Guild, error)

+ func (c *Client) Guilds(limit uint) ([]discord.Guild, error)

+ func (c *Client) GuildsAfter(after discord.GuildID, limit uint) ([]discord.Guild, error)

+ func (c *Client) GuildsBefore(before discord.GuildID, limit uint) ([]discord.Guild, error)

+ func (c *Client) Integrations(guildID discord.GuildID) ([]discord.Integration, error)

+ func (c *Client) Invite(code string) (*discord.Invite, error)

+ func (c *Client) InviteWithCounts(code string) (*discord.Invite, error)

+ func (c *Client) JoinInvite(code string) (*JoinedInvite, error)

+ func (c *Client) Kick(guildID discord.GuildID, userID discord.UserID) error

+ func (c *Client) KickWithReason(guildID discord.GuildID, userID discord.UserID, reason string) error

+ func (c *Client) LeaveGuild(id discord.GuildID) error

+ func (c *Client) Login(email, password string) (*LoginResponse, error)

+ func (c *Client) Me() (*discord.User, error)

+ func (c *Client) Member(guildID discord.GuildID, userID discord.UserID) (*discord.Member, error)

+ func (c *Client) Members(guildID discord.GuildID, limit uint) ([]discord.Member, error)

+ func (c *Client) MembersAfter(guildID discord.GuildID, after discord.UserID, limit uint) ([]discord.Member, error)

+ func (c *Client) Message(channelID discord.ChannelID, messageID discord.MessageID) (*discord.Message, error)

+ func (c *Client) Messages(channelID discord.ChannelID, limit uint) ([]discord.Message, error)

+ func (c *Client) MessagesAfter(channelID discord.ChannelID, after discord.MessageID, limit uint) ([]discord.Message, error)

+ func (c *Client) MessagesAround(channelID discord.ChannelID, around discord.MessageID, limit uint) ([]discord.Message, error)

+ func (c *Client) MessagesBefore(channelID discord.ChannelID, before discord.MessageID, limit uint) ([]discord.Message, error)

+ func (c *Client) ModifyChannel(channelID discord.ChannelID, data ModifyChannelData) error

+ func (c *Client) ModifyEmoji(guildID discord.GuildID, emojiID discord.EmojiID, data ModifyEmojiData) error

+ func (c *Client) ModifyGuild(id discord.GuildID, data ModifyGuildData) (*discord.Guild, error)

+ func (c *Client) ModifyGuildWidget(guildID discord.GuildID, data ModifyGuildWidgetData) (*discord.GuildWidgetSettings, error)

+ func (c *Client) ModifyIntegration(guildID discord.GuildID, integrationID discord.IntegrationID, ...) error

+ func (c *Client) ModifyMe(data ModifySelfData) (*discord.User, error)

+ func (c *Client) ModifyMember(guildID discord.GuildID, userID discord.UserID, data ModifyMemberData) error

+ func (c *Client) ModifyRole(guildID discord.GuildID, roleID discord.RoleID, data ModifyRoleData) (*discord.Role, error)

+ func (c *Client) ModifyWebhook(webhookID discord.WebhookID, data ModifyWebhookData) (*discord.Webhook, error)

+ func (c *Client) MoveChannel(guildID discord.GuildID, data []MoveChannelData) error

+ func (c *Client) MoveRole(guildID discord.GuildID, data []MoveRoleData) ([]discord.Role, error)

+ func (c *Client) Note(userID discord.UserID) (string, error)

+ func (c *Client) PinMessage(channelID discord.ChannelID, messageID discord.MessageID) error

+ func (c *Client) PinnedMessages(channelID discord.ChannelID) ([]discord.Message, error)

+ func (c *Client) PrivateChannels() ([]discord.Channel, error)

+ func (c *Client) Prune(guildID discord.GuildID, data PruneData) (uint, error)

+ func (c *Client) PruneCount(guildID discord.GuildID, data PruneCountData) (uint, error)

+ func (c *Client) React(channelID discord.ChannelID, messageID discord.MessageID, ...) error

+ func (c *Client) Reactions(channelID discord.ChannelID, messageID discord.MessageID, ...) ([]discord.User, error)

+ func (c *Client) ReactionsAfter(channelID discord.ChannelID, messageID discord.MessageID, after discord.UserID, ...) ([]discord.User, error)

+ func (c *Client) ReactionsBefore(channelID discord.ChannelID, messageID discord.MessageID, ...) ([]discord.User, error)

+ func (c *Client) RemoveRecipient(channelID discord.ChannelID, userID discord.UserID) error

+ func (c *Client) RemoveRole(guildID discord.GuildID, userID discord.UserID, roleID discord.RoleID) error

+ func (c *Client) Roles(guildID discord.GuildID) ([]discord.Role, error)

+ func (c *Client) SendEmbed(channelID discord.ChannelID, e discord.Embed) (*discord.Message, error)

+ func (c *Client) SendMessage(channelID discord.ChannelID, content string, embed *discord.Embed) (*discord.Message, error)

+ func (c *Client) SendMessageComplex(channelID discord.ChannelID, data SendMessageData) (*discord.Message, error)

+ func (c *Client) SendText(channelID discord.ChannelID, content string) (*discord.Message, error)

+ func (c *Client) SetNote(userID discord.UserID, note string) error

+ func (c *Client) SetRelationship(userID discord.UserID, t discord.RelationshipType) error

+ func (c *Client) SyncIntegration(guildID discord.GuildID, integrationID discord.IntegrationID) error

+ func (c *Client) TOTP(code, ticket string) (*LoginResponse, error)

+ func (c *Client) Typing(channelID discord.ChannelID) error

+ func (c *Client) Unban(guildID discord.GuildID, userID discord.UserID) error

+ func (c *Client) UnpinMessage(channelID discord.ChannelID, messageID discord.MessageID) error

+ func (c *Client) Unreact(channelID discord.ChannelID, messageID discord.MessageID, ...) error

+ func (c *Client) User(userID discord.UserID) (*discord.User, error)

+ func (c *Client) UserConnections() ([]discord.Connection, error)

+ func (c *Client) VoiceRegionsGuild(guildID discord.GuildID) ([]discord.VoiceRegion, error)

+ func (c *Client) Webhook(webhookID discord.WebhookID) (*discord.Webhook, error)

+ func (c *Client) WithContext(ctx context.Context) *Client

+ type CreateChannelData struct

+ CategoryID discord.ChannelID

+ NSFW bool

+ Name string

+ Permissions []discord.Overwrite

+ Position option.Int

+ Topic string

+ Type discord.ChannelType

+ UserRateLimit discord.Seconds

+ VoiceBitrate uint

+ VoiceUserLimit uint

+ type CreateEmojiData struct

+ Image Image

+ Name string

+ Roles *[]discord.RoleID

+ type CreateGuildData struct

+ AFKChannelID discord.ChannelID

+ AFKTimeout option.Seconds

+ Channels []discord.Channel

+ ExplicitFilter *discord.ExplicitFilter

+ Icon *Image

+ Name string

+ Notification *discord.Notification

+ Roles []discord.Role

+ SystemChannelID discord.ChannelID

+ Verification *discord.Verification

+ VoiceRegion string

+ type CreateInviteData struct

+ MaxAge option.Uint

+ MaxUses uint

+ Temporary bool

+ Unique bool

+ type CreateRoleData struct

+ Color discord.Color

+ Hoist bool

+ Mentionable bool

+ Name string

+ Permissions discord.Permissions

+ type CreateWebhookData struct

+ Avatar *Image

+ Name string

+ type EditChannelPermissionData struct

+ Allow discord.Permissions

+ Deny discord.Permissions

+ Type discord.OverwriteType

+ type EditMessageData struct

+ AllowedMentions *AllowedMentions

+ Content option.NullableString

+ Embed *discord.Embed

+ Flags *discord.MessageFlags

+ type ErrImageTooLarge struct

+ Max int

+ Size int

+ func (err ErrImageTooLarge) Error() string

+ type GuildWidgetImageStyle string

+ const GuildBanner1

+ const GuildBanner2

+ const GuildBanner3

+ const GuildBanner4

+ const GuildShield

+ type Image struct

+ Content []byte

+ ContentType string

+ func DecodeImage(data []byte) (*Image, error)

+ func (i *Image) UnmarshalJSON(v []byte) error

+ func (i Image) Encode() ([]byte, error)

+ func (i Image) MarshalJSON() ([]byte, error)

+ func (i Image) Validate(maxSize int) error

+ type JoinedInvite struct

+ Channel discord.Channel

+ Code string

+ Guild discord.Guild

+ NewMember bool

+ type LoginResponse struct

+ MFA bool

+ SMS bool

+ Ticket string

+ Token string

+ type ModifyChannelData struct

+ CategoryID discord.ChannelID

+ NSFW option.NullableBool

+ Name string

+ Permissions *[]discord.Overwrite

+ Position option.NullableInt

+ Topic option.NullableString

+ Type *discord.ChannelType

+ UserRateLimit option.NullableUint

+ VoiceBitrate option.NullableUint

+ VoiceUserLimit option.NullableUint

+ type ModifyEmojiData struct

+ Name string

+ Roles *[]discord.RoleID

+ type ModifyGuildData struct

+ AFKChannelID discord.ChannelID

+ AFKTimeout option.Seconds

+ Banner *Image

+ ExplicitFilter *discord.ExplicitFilter

+ Icon *Image

+ Name string

+ Notification *discord.Notification

+ OwnerID discord.UserID

+ PreferredLocale option.NullableString

+ PublicUpdatesChannelID discord.ChannelID

+ Region option.NullableString

+ RulesChannelID discord.ChannelID

+ Splash *Image

+ SystemChannelID discord.ChannelID

+ Verification *discord.Verification

+ type ModifyGuildWidgetData struct

+ ChannelID discord.ChannelID

+ Enabled option.Bool

+ type ModifyIntegrationData struct

+ EnableEmoticons option.NullableBool

+ ExpireBehavior *discord.ExpireBehavior

+ ExpireGracePeriod option.NullableInt

+ type ModifyMemberData struct

+ Deaf option.Bool

+ Mute option.Bool

+ Nick option.String

+ Roles *[]discord.RoleID

+ VoiceChannel discord.ChannelID

+ type ModifyRoleData struct

+ Color option.NullableColor

+ Hoist option.NullableBool

+ Mentionable option.NullableBool

+ Name option.NullableString

+ Permissions *discord.Permissions

+ type ModifySelfData struct

+ Avatar *Image

+ Username option.String

+ type ModifyWebhookData struct

+ Avatar *Image

+ ChannelID discord.ChannelID

+ Name option.String

+ type MoveChannelData struct

+ ID discord.ChannelID

+ Position option.Int

+ type MoveRoleData struct

+ ID discord.RoleID

+ Position option.NullableInt

+ type PruneCountData struct

+ Days uint

+ IncludedRoles []discord.RoleID

+ type PruneData struct

+ Days uint

+ IncludedRoles []discord.RoleID

+ ReturnCount bool

+ type SendMessageData struct

+ AllowedMentions *AllowedMentions

+ Content string

+ Embed *discord.Embed

+ Files []sendpart.File

+ Nonce string

+ Reference *discord.MessageReference

+ TTS bool

+ func (data SendMessageData) NeedsMultipart() bool

+ func (data SendMessageData) WriteMultipart(body *multipart.Writer) error

+ type Session struct

+ Limiter *rate.Limiter

+ Token string

+ UserAgent string

+ func (s *Session) InjectRequest(r httpdriver.Request) error

+ func (s *Session) OnResponse(r httpdriver.Request, resp httpdriver.Response) error

Other modules containing this package

github.com/diamondburned/arikawa

github.com/diamondburned/arikawa/v3

?	: This menu
/	: Search site
f or F	: Jump to
y or Y	: Canonical URL