SwiftDiscord Reference DiscordEndpoint Enumeration Reference

DiscordEndpoint

public enum DiscordEndpoint : CustomStringConvertible

This enum defines the endpoints used to interact with the Discord API.

baseURL
The base url for the Discord REST API.
Declaration
Swift

case baseURL

channel(id:)
The base channel endpoint.
Declaration
Swift

case channel(id: ChannelID)

messages(channel:)
The base channel messages endpoint.
Declaration
Swift

case messages(channel: ChannelID)

bulkMessageDelete(channel:)
The channel bulk delete endpoint.
Declaration
Swift

case bulkMessageDelete(channel: ChannelID)

channelMessage(channel:message:)
The base channel message endpoint.
Declaration
Swift

case channelMessage(channel: ChannelID, message: MessageID)

channelMessageDelete(channel:message:)
Same as channelMessage, separate for rate limiting purposes
Declaration
Swift

case channelMessageDelete(channel: ChannelID, message: MessageID)

typing(channel:)
The channel typing endpoint.
Declaration
Swift

case typing(channel: ChannelID)

permissions(channel:)
The base channel permissions endpoint.
Declaration
Swift

case permissions(channel: ChannelID)

channelPermission(channel:overwrite:)
The channel permission endpoint.
Declaration
Swift

case channelPermission(channel: ChannelID, overwrite: OverwriteID)

invites(code:)
The base endpoint for invites.
Declaration
Swift

case invites(code: String)

channelInvites(channel:)
The base endpoint for channel invites.
Declaration
Swift

case channelInvites(channel: ChannelID)

pins(channel:)
The base endpoint for pinned channel messages.
Declaration
Swift

case pins(channel: ChannelID)

pinnedMessage(channel:message:)
The channel pinned message endpoint.
Declaration
Swift

case pinnedMessage(channel: ChannelID, message: MessageID)

channelWebhooks(channel:)
The channel webhooks endpoint.
Declaration
Swift

case channelWebhooks(channel: ChannelID)

guilds(id:)
The base guild endpoint.
Declaration
Swift

case guilds(id: GuildID)

guildAuditLog(id:)
Guild audit log
Declaration
Swift

case guildAuditLog(id: GuildID)

guildChannels(guild:)
The base endpoint for guild channels.
Declaration
Swift

case guildChannels(guild: GuildID)

guildMembers(guild:)
The base guild members endpoint.
Declaration
Swift

case guildMembers(guild: GuildID)

guildMember(guild:user:)
The guild member endpoint.
Declaration
Swift

case guildMember(guild: GuildID, user: UserID)

guildMemberRole(guild:user:role:)
The guild member roles enpoint.
Declaration
Swift

case guildMemberRole(guild: GuildID, user: UserID, role: RoleID)

guildBans(guild:)
The base guild bans endpoint.
Declaration
Swift

case guildBans(guild: GuildID)

guildBanUser(guild:user:)
The guild ban user endpoint.
Declaration
Swift

case guildBanUser(guild: GuildID, user: UserID)

guildRoles(guild:)
The base guild roles endpoint.
Declaration
Swift

case guildRoles(guild: GuildID)

guildRole(guild:role:)
The guild role endpoint.
Declaration
Swift

case guildRole(guild: GuildID, role: RoleID)

guildWebhooks(guild:)
The guilds webhooks endpoint.
Declaration
Swift

case guildWebhooks(guild: GuildID)

userChannels
The user channels endpoint.
Declaration
Swift

case userChannels

userGuilds
The user guilds endpoint.
Declaration
Swift

case userGuilds

webhook(id:)
The single webhook endpoint.
Declaration
Swift

case webhook(id: WebhookID)

webhookWithToken(id:token:)
The single webhook with token endpoint.
Declaration
Swift

case webhookWithToken(id: WebhookID, token: String)

webhookSlack(id:token:)
A slack compatible webhook.
Declaration
Swift

case webhookSlack(id: WebhookID, token: String)

webhookGithub(id:token:)
A GitHub compatible webhook.
Declaration
Swift

case webhookGithub(id: WebhookID, token: String)

Endpoint Request enum

EndpointRequest
An HTTP Request for an Endpoint. This includes any associated data.
See more
Declaration
Swift

public enum EndpointRequest

Endpoint string calculation

description
Declaration
Swift

public var description: String

Options
A namespace struct for endpoint options.
See more
Declaration
Swift

public struct Options