disgord

README

About

Go module for interacting with the Discord API. Supports events, REST calls and voice (sending only).

Discord object comes with helper functions such as Message.Reply(session, "hello"), or Session.SaveToDiscord(newRole) for simplicity/readability.

DisGord has complete implementation for Discord's documented REST API. It lacks battle testing testing, so any bug report/feedback is greatly appreciated!

To get started see the examples in docs

Some projects using DisGord can be found here.

Talk to us on Discord! We exist in both the Gopher server and the Discord API server:

• Discord Gophers
• Discord API

Warning

The develop branch is under continuous breaking changes, as the interface and exported funcs/consts are still undergoing planning. Because DisGord is under development and pushing for a satisfying interface, the SemVer logic is not according to spec. Until v1.0.0, every minor release is considered possibly breaking and patch releases might contain additional features. As soon as the issue #103 is finished, there should only be tweaking left before v1.0.0 is release.

There might be bugs in the cache, or the cache processing might not exist yet for some REST methods. Bypass the cache for REST methods by supplying the flag argument disgord.DisableCache. eg. client.GetCurrentUser(disgord.DisableCache).

Unexpected behavior

• Calling client.SaveToDiscord, or through Session, does not work for Role position.

Starter guide (Linux)

Note! this is a Go module project, and Go module support should activated to properly use DisGord. It might work using only the GOPATH. But officially this is not supported: Read more about modules here: https://github.com/golang/go/wiki/Modules

To create a new bot you can use the disgord.sh script to automate the boring copy/paste process. Paste the following into your terminal:

bash <(curl -s -L https://git.io/disgord-script)

Remember to activate module support. Your IDE might require you to activate it in the settings menu.

Starter guide as a gif: https://terminalizer.com/view/469961d0695

Architecture & Behavior

Discord provide communication in different forms. DisGord tackles the main ones, events (ws), voice (udp + ws), and REST calls.

You can think of DisGord as layered, in which case it will look something like:

Events

For Events, DisGord uses the reactor pattern. Every incoming event from Discord is processed and checked if any handler is registered for it, otherwise it's discarded to save time and resource use. Once a desired event is received, DisGord starts up a Go routine and runs all the related handlers in sequence; avoiding locking the need to use mutexes the handlers.

In addition to traditional handlers, DisGord allows you to use Go channels. Note that if you use more than one channel per event, one of the channels will randomly receive the event data; this is how go channels work. It will act as a randomized load balancer.

But before either channels or handlers are triggered, the cache is updated.

REST

The "REST manager", or the httd.Client, handles rate limiting for outgoing requests, and updated the internal logic on responses. All the REST methods are defined on the disgord.Client and checks for issues before the request is sent out.

If the request is a standard GET request, the cache is always checked first to reduce delay, network traffic and load on the Discord servers. And on responses, regardless of the http method, the data is copied into the cache.

Some of the REST methods (updating existing data structures) will use the builder+command pattern. While the remaining will take a simple config struct.

Note: Methods that update a single field, like SetCurrentUserNick, does not use the builder pattern.

// bypasses local cache
client.GetCurrentUser(disgord.DisableCache)
client.GetGuildMembers(guildID, disgord.DisableCache)

// always checks the local cache first
client.GetCurrentUser()
client.GetGuildMembers(guildID)

Voice

Whenever you want the bot to join a voice channel, a websocket and UDP connection is established. So if your bot is currently in 5 voice channels, then you have 5 websocket connections and 5 udp connections open to handle the voice traffic.

Cache

The cache tries to represent the Discord state as accurate as it can. Because of this, the cache is immutable by default. Meaning the does not allow you to reference any cached objects directly, and every incoming and outgoing data of the cache is deep copied.

Package structure

None of the sub-packages should be used outside the library. If there exists a requirement for that, please create an issue or pull request.

github.com/andersfylling/disgord
└──.circleci    :CircleCI configuration
└──.githooks    :Hooks that can help speed up development for DisGord contributors
└──.github      :GitHub templates, issues, PR, etc.
└──cache        :Different cache replacement algorithms
└──cmd          :Private content for live testing
└──constant     :Constants such as version, GitHub URL, etc.
└──docs         :Examples, templates, (documentation)
└──endpoint     :All the REST endpoints of Discord
└──event        :All the Discord event identifiers
└──generate     :go:generate logic
└──httd         :Deals with rate limits and http calls
└──logger       :Logger interface and Zap wrapper
└──ratelimit    :All the ratelimit keys for the REST endpoints
└──std          :Standard implementations/functionality that bot developers can use with DisGord logic
└──testdata     :Holds all test data for unit tests (typically JSON files)
└──websocket    :Discord Websocket logic (reconnect, resume, etc.)

The root pkg (disgord) holds all the data structures and the main client. Essentially all the features that should be used by the developer for creating bots. If you need access to the Snowflake type used by DisGord, then you should use github.com/andersfylling/snowflake.

Dependencies

github.com/andersfylling/disgord
└──github.com/andersfylling/snowflake  :The snowflake ID designed for Discord
└──github.com/json-iterator/go         :For faster JSON decoding/encoding
└──github.com/gorilla/websocket        :Default websocket client
└──github.com/sergi/go-diff            :Unit testing for checking JSON encoding/decoding of structs
└──github.com/uber-go/zap              :Logging (optional)

Logging

DisGord requires you to inject a logger instance if you want DisGord to log internal messages (recommended). Logrus is supported out of the box, while other projects might require you to wrap them to comply with disgord.Logger.

You can also use the default logger, which is a wrapped Zap instance: disgord.DefaultLogger(false) (see logging.go).

To use the log instance later on, call the method Session.Logger().

client := disgord.New(&disgord.Config{
	Logger: disgord.DefaultLogger(false),
})
client.Logger().Error("oh no")

Build tags

For advanced users only.

If you do not wish to use json-iterator, you can pass -tags=json-std to switch to "encoding/json". However, json-iterator is the recommended default for this library.

DisGord has the option to use mutexes (sync.RWMutex) on Discord objects. By default, methods of Discord objects are not locked as this is not needed in our event driven architecture unless you create a parallel computing environment. If you want the internal methods to deal with read-write locks on their own, you can pass -tags=disgord_parallelism, which will activate built-in locking. Making all methods thread safe.

If you want to remove the extra memory used by mutexes, or you just want to completely avoid potential deadlocks by disabling mutexes you can pass -tags=disgord_removeDiscordMutex which will replace the RWMutex with an empty struct, causing mutexes (in Discord objects only) to be removed at compile time. This cannot be the default behaviour, as it creates confusion whether or not a mutex exists and leads to more error prone code. The developer has to be aware themselves whether or not their code can be run without the need of mutexes. This option is not affected by the disgord_parallelism tag.

Contributing

Please see the CONTRIBUTING.md file (Note that it can be useful to read this regardless if you have the time)

Q&A

NOTE: To see more examples go visit the docs/examples folder. See the GoDoc for a in-depth introduction on the various topics (or disgord.go package comment). Below is an example of the traditional ping-pong bot and then some.

1. Is there an alternative Go package?

Yes, it's called Discordgo (https://github.com/bwmarrin/discordgo). Its purpose is to provide low 
level bindings for Discord, while DisGord wants to provide a more configurable system with more 
features (channels, cache replacement strategies, build constraints, tailored unmarshal methods, etc.). 
Currently I do not have a comparison chart of DisGord and DiscordGo. But I do want to create one in the 
future, for now the biggest difference is that DisGord does not support self bots (as they aren't 
in the official documentation).

2. How do I find my bot token and/or add my bot to a server?

Tutorial here: https://github.com/andersfylling/disgord/wiki/Get-bot-token-and-add-it-to-a-server

3. Why make another Discord lib in GoLang?

I'm trying to take over the world and then become a intergalactic war lord. Have to start somewhere.

4. Does this project re-use any code from DiscordGo?

Yes. See guild.go. The permission consts are pretty much a copy from DiscordGo.

Documentation

Overview

Package disgord provides Go bindings for the documented Discord API. And allows for a stateful client using the Session interface, with the option of a configurable caching system or bypass the built-in caching logic all together.

Getting started

Create a DisGord session to get access to the REST API and socket functionality. In the following example, we listen for new messages and write a "hello" message when our handler function gets fired.

Session interface: https://godoc.org/github.com/andersfylling/disgord/#Session

discord, err := disgord.NewClient(&disgord.Config{
  BotToken: "my-secret-bot-token",
})
if err != nil {
  panic(err)
}

// listen for incoming messages and reply with a "hello"
discord.On(event.MessageCreate, func(session disgord.Session, evt *disgord.MessageCreate) {
    evt.Message.RespondString("hello")
})

// connect to the socket API to receive events
err = discord.Connect()
if err != nil {
    panic(err)
}
discord.DisconnectOnInterrupt()

If you want some logic to fire when the bot is ready (all shards has received their ready event), please use the Ready method.

// ...
discord.Ready(func() {
	fmt.Println("READY NOW!")
})
// ...

Listen for events using channels

Disgord also provides the option to listen for events using a channel, instead of registering a handler. However, before using the event channel, you must notify disgord that you care about the event (this is done automatically in the event handler registration).

session.AcceptEvent(event.MessageCreate) // alternative: disgord.EventMessageCreate
session.AcceptEvent(event.MessageUpdate)
for {
    var message *disgord.Message
    var status string
    select {
    case evt, alive := <- session.EventChannels().MessageCreate()
        if !alive {
            return
        }
        message = evt.Message
        status = "created"
    case evt, alive := <- session.EventChannels().MessageUpdate()
        if !alive {
            return
        }
        message = evt.Message
        status = "updated"
    }

    fmt.Printf("A message from %s was %s\n", message.Author.Mention(), status)
    // output example: "A message from @Anders was created"
}

Optimizing your cache logic

> Note: if you create a CacheConfig you don't have to set every field. All the CacheAlgorithms are default to LFU when left blank.

A part of Disgord is the control you have; while this can be a good detail for advanced users, we recommend beginners to utilise the default configurations (by simply not editing the configuration). Here we pass the cache config when creating the session to access to the different cache replacement algorithms, lifetime settings, and the option to disable different cache systems.

 discord, err := disgord.NewClient(&disgord.Config{
   BotToken: "my-secret-bot-token",
   Cache: &disgord.CacheConfig{
             Mutable: false, // everything going in and out of the cache is deep copied
				// setting Mutable to true, might break your program as this is experimental.

             DisableUserCaching: false, // activates caching for users
             UserCacheLifetime: time.Duration(4) * time.Hour, // removed from cache after 9 hours, unless updated
             UserCacheAlgorithm: disgord.CacheAlgLFU,

             DisableVoiceStateCaching: true, // don't cache voice states
             // VoiceStateCacheLifetime  time.Duration
             // VoiceStateCacheAlgorithm string

             DisableChannelCaching: false,
             ChannelCacheLifetime: 0, // lives forever
             ChannelCacheAlgorithm: disgord.CacheAlgLFU, // lfu (Least Frequently Used)

				GuildCacheAlgorithm: disgord.CacheAlgLFU, // no limit set, so the strategy to replace entries is not used
          },
 })

If you just want to change a specific field, you can do so. By either calling the disgord.DefaultCacheConfig which gives you a Cache configuration designed by DisGord. Or you can set specific fields in a new CacheConfig since the different Cache Strategies are automatically set to LFU if missing.

&disgord.Config{}

Will automatically become

 &disgord.Config{
 	UserCacheAlgorithm: disgord.CacheAlgLFU,
		VoiceStateCacheAlgorithm disgord.CacheAlgLFU,
		ChannelCacheAlgorithm: disgord.CacheAlgLFU,
		GuildCacheAlgorithm: disgord.CacheAlgLFU,
 }

And writing

 &disgord.Config{
 	UserCacheAlgorithm: disgord.CacheAlgLRU,
		VoiceStateCacheAlgorithm disgord.CacheAlgLRU,
 }

Becomes

 &disgord.Config{
 	UserCacheAlgorithm: disgord.CacheAlgLRU, // unchanged
		VoiceStateCacheAlgorithm disgord.CacheAlgLRU,  // unchanged
		ChannelCacheAlgorithm: disgord.CacheAlgLFU,
		GuildCacheAlgorithm: disgord.CacheAlgLFU,
 }

> Note: Disabling caching for some types while activating it for others (eg. disabling channels, but activating guild caching), can cause items extracted from the cache to not reflect the true discord state.

Example, activated guild but disabled channel caching: The guild is stored to the cache, but it's channels are discarded. Guild channels are dismantled from the guild object and otherwise stored in the channel cache to improve performance and reduce memory use. So when you extract the cached guild object, all of the channel will only hold their channel ID, and nothing more.

Immutable and concurrent accessible cache

The option CacheConfig.Immutable can greatly improve performance or break your system. If you utilize channels or you need concurrent access, the safest bet is to set immutable to `true`. While this is slower (as you create deep copies and don't share the same memory space with variables outside the cache), it increases reliability that the cache always reflects the last known Discord state. If you are uncertain, just set it to `true`. The default setting is `true` if `disgord.Cache.CacheConfig` is `nil`.

Bypass the built-in REST cache

Whenever you call a REST method from the Session interface; the cache is always checked first. Upon a cache hit, no REST request is executed and you get the data from the cache in return. However, if this is problematic for you or there exist a bug which gives you bad/outdated data, you can bypass it by using the REST functions directly. Remember that this will not update the cache for you, and this needs to be done manually if you depend on the cache.

// get a user using the Session implementation (checks cache, and updates the cache on cache miss)
user, err := session.GetUser(userID)

// bypass the cache checking. Same function name, but is found in the disgord package, not the session interface.
user, err := disgord.GetUser(userID)

Manually updating the cache

If required, you can access the cache and update it by hand. Note that this should not be required when you use the Session interface.

user, err := disgord.GetUser(userID)
if err != nil {
    return err
}

// update the cache
cache := discord.Cache()
err = cache.Update(disgord.UserCache, user)
if err != nil {
    return err
}

Build tags

`disgord_diagnosews` will store all the incoming and outgoing json data as files in the directory "diagnose-report/packets". The file format is as follows: unix_clientType_direction_shardID_operationCode_sequenceNumber[_eventName].json

`json-std` switches out jsoniter with the json package from the std libs.

`disgord_removeDiscordMutex` replaces mutexes in discord structures with a empty mutex; removes locking behaviour and any mutex code when compiled.

`disgord_parallelism` activates built-in locking in discord structure methods. Eg. Guild.AddChannel(*Channel) does not do locking by default. But if you find yourself using these discord data structures in parallel environment, you can activate the internal locking to reduce race conditions. Note that activating `disgord_parallelism` and `disgord_removeDiscordMutex` at the same time, will cause you to have no locking as `disgord_removeDiscordMutex` affects the same mutexes.

Saving and Deleting Discord data

> Note: when using SaveToDiscord(...) make sure the object reflects the Discord state. Calling Save on default values might overwrite or reset the object at Discord, causing literally.. Hell.

You might have seen the two methods in the session interface: SaveToDiscord(...) and DeleteFromDiscord(...). This are as straight forward as they sound. Passing a discord data structure into one of them executes their obvious behavior; to either save it to Discord, or delete it.

// create a new role and give it certain permissions
role := disgord.Role{}
role.Name = "Giraffes"
role.GuildID = guild.ID // required, for an obvious reason
role.Permissions = disgord.ManageChannelsPermission | disgord.ViewAuditLogsPermission
err := session.SaveToDiscord(&role)

You know what.. Let's just remove the role

err := session.DeleteFromDiscord(&role)

Index

• Constants
• func DefaultLogger(debug bool) *logger.LoggerZap
• func DefaultLoggerWithInstance(log *zap.Logger) *logger.LoggerZap
• func GetShardForGuildID(guildID Snowflake, shardCount uint) (shardID uint)
• func LibraryInfo() string
• func New(conf *Config) (c *client)
• func NewClient(conf *Config) (c *client, err error)
• func NewRESTClient(conf *Config) (*httd.Client, error)
• func SortRoles(rs []*Role)
• func ValidateHandlerInputs(inputs ...interface{}) (err error)
• func ValidateUsername(name string) (err error)
• type Activity
  • func NewActivity() (activity *Activity)
  • func (a *Activity) CopyOverTo(other interface{}) (err error)
  • func (a *Activity) DeepCopy() (copy interface{})
  • func (a *Activity) Reset()
• type ActivityAssets
  • func (a *ActivityAssets) CopyOverTo(other interface{}) (err error)
  • func (a *ActivityAssets) DeepCopy() (copy interface{})
• type ActivityParty
  • func (ap *ActivityParty) CopyOverTo(other interface{}) (err error)
  • func (ap *ActivityParty) DeepCopy() (copy interface{})
  • func (ap *ActivityParty) Limit() int
  • func (ap *ActivityParty) NumberOfPeople() int
• type ActivitySecrets
  • func (a *ActivitySecrets) CopyOverTo(other interface{}) (err error)
  • func (a *ActivitySecrets) DeepCopy() (copy interface{})
• type ActivityTimestamp
  • func (a *ActivityTimestamp) CopyOverTo(other interface{}) (err error)
  • func (a *ActivityTimestamp) DeepCopy() (copy interface{})
• type AddGuildMemberParams
• type Attachment
  • func (a *Attachment) DeepCopy() (copy interface{})
• type AuditLog
  • func (l *AuditLog) Bans() (bans []*PartialBan)
  • func (l *AuditLog) CopyOverTo(other interface{}) (err error)
  • func (l *AuditLog) DeepCopy() (copy interface{})
• type AuditLogChange
• type AuditLogChanges
  • func (l *AuditLogChanges) CopyOverTo(other interface{}) (err error)
  • func (l *AuditLogChanges) DeepCopy() (copy interface{})
• type AuditLogEntry
  • func (l *AuditLogEntry) CopyOverTo(other interface{}) (err error)
  • func (l *AuditLogEntry) DeepCopy() (copy interface{})
• type AuditLogEvt
• type AuditLogOption
  • func (l *AuditLogOption) CopyOverTo(other interface{}) (err error)
  • func (l *AuditLogOption) DeepCopy() (copy interface{})
• type AvatarParamHolder
• type Ban
  • func (b *Ban) CopyOverTo(other interface{}) (err error)
  • func (b *Ban) DeepCopy() (copy interface{})
• type BanMemberParams
  • func (b *BanMemberParams) FindErrors() error
  • func (b *BanMemberParams) URLQueryString() string
• type BodyUserCreateDM
• type Cache
  • func (c *Cache) AddGuildChannel(guildID snowflake.ID, channelID snowflake.ID)
  • func (c *Cache) AddGuildMember(guildID snowflake.ID, member *Member)
  • func (c *Cache) AddGuildRole(guildID Snowflake, role *Role)
  • func (c *Cache) DeleteChannel(id Snowflake)
  • func (c *Cache) DeleteChannelPermissionOverwrite(channelID Snowflake, overwriteID Snowflake) error
  • func (c *Cache) DeleteGuild(id Snowflake)
  • func (c *Cache) DeleteGuildChannel(guildID, channelID Snowflake)
  • func (c *Cache) DeleteGuildEmoji(guildID, emojiID Snowflake)
  • func (c *Cache) DeleteGuildRole(guildID, roleID Snowflake)
  • func (c *Cache) DirectUpdate(registry cacheRegistry, id snowflake.ID, changes []byte) error
  • func (c *Cache) Get(key cacheRegistry, id Snowflake, args ...interface{}) (v interface{}, err error)
  • func (c *Cache) GetChannel(id Snowflake) (channel *Channel, err error)
  • func (c *Cache) GetGuild(id Snowflake) (guild *Guild, err error)
  • func (c *Cache) GetGuildEmojis(id Snowflake) (emojis []*Emoji, err error)
  • func (c *Cache) GetGuildMember(guildID, userID Snowflake) (member *Member, err error)
  • func (c *Cache) GetGuildMembersAfter(guildID, after Snowflake, limit int) (members []*Member, err error)
  • func (c *Cache) GetGuildRoles(id Snowflake) (roles []*Role, err error)
  • func (c *Cache) GetUser(id Snowflake) (user *User, err error)
  • func (c *Cache) GetVoiceState(guildID Snowflake, params *guildVoiceStateCacheParams) (state *VoiceState, err error)
  • func (c *Cache) PeekGuild(id snowflake.ID) (guild *Guild, err error)
  • func (c *Cache) PeekUser(id snowflake.ID) (*User, error)
  • func (c *Cache) RemoveGuildMember(guildID snowflake.ID, memberID snowflake.ID)
  • func (c *Cache) SetChannel(new *Channel)
  • func (c *Cache) SetGuild(guild *Guild)
  • func (c *Cache) SetGuildEmojis(guildID Snowflake, emojis []*Emoji)
  • func (c *Cache) SetGuildMember(guildID Snowflake, member *Member)
  • func (c *Cache) SetGuildMembers(guildID Snowflake, members []*Member)
  • func (c *Cache) SetGuildRoles(guildID Snowflake, roles []*Role)
  • func (c *Cache) SetUser(new *User)
  • func (c *Cache) SetVoiceState(state *VoiceState)
  • func (c *Cache) Update(key cacheRegistry, v interface{}) (err error)
  • func (c *Cache) UpdateChannelLastMessageID(channelID Snowflake, messageID Snowflake)
  • func (c *Cache) UpdateChannelPin(id Snowflake, timestamp Time)
  • func (c *Cache) UpdateGuildRole(guildID snowflake.ID, role *Role, data json.RawMessage) bool
  • func (c *Cache) UpdateMemberAndUser(guildID, userID snowflake.ID, data json.RawMessage)
  • func (c *Cache) UpdateOrAddGuildMembers(guildID Snowflake, members []*Member)
  • func (c *Cache) Updates(key cacheRegistry, vs []interface{}) (err error)
• type CacheConfig
  • func DefaultCacheConfig() *CacheConfig
• type Cacher
• type Channel
  • func NewChannel() *Channel
  • func (c *Channel) Compare(other *Channel) bool
  • func (c *Channel) CopyOverTo(other interface{}) (err error)
  • func (c *Channel) DeepCopy() (copy interface{})
  • func (c *Channel) Mention() string
  • func (c *Channel) Reset()
  • func (c *Channel) SendMsg(client MessageSender, message *Message) (msg *Message, err error)
  • func (c *Channel) SendMsgString(client MessageSender, content string) (msg *Message, err error)
  • func (c *Channel) String() string
• type ChannelCreate
  • func (obj *ChannelCreate) UnmarshalJSON(data []byte) error
• type ChannelCreateHandler
• type ChannelDelete
  • func (obj *ChannelDelete) UnmarshalJSON(data []byte) error
• type ChannelDeleteHandler
• type ChannelFetcher
• type ChannelPinsUpdate
• type ChannelPinsUpdateHandler
• type ChannelUpdate
  • func (obj *ChannelUpdate) UnmarshalJSON(data []byte) error
• type ChannelUpdateHandler
• type Config
• type Copier
• type CreateChannelInvitesParams
• type CreateGroupDMParams
• type CreateGuildChannelParams
• type CreateGuildEmojiParams
• type CreateGuildIntegrationParams
• type CreateGuildParams
• type CreateGuildRoleParams
• type CreateMessageFileParams
• type CreateMessageParams
  • func NewMessageByString(content string) *CreateMessageParams
• type CreateWebhookParams
  • func (c *CreateWebhookParams) FindErrors() error
• type Ctrl
  • func (c *Ctrl) IsDead() bool
  • func (c *Ctrl) OnInsert(Session) error
  • func (c *Ctrl) OnRemove(Session) error
  • func (c *Ctrl) Update()
• type DeepCopier
• type DefaultMessageNotificationLvl
  • func (dmnl *DefaultMessageNotificationLvl) AllMessages() bool
  • func (dmnl *DefaultMessageNotificationLvl) OnlyMentions() bool
• type DeleteMessagesParams
  • func (p *DeleteMessagesParams) AddMessage(msg *Message) (err error)
  • func (p *DeleteMessagesParams) Valid() (err error)
• type Discriminator
  • func NewDiscriminator(d string) (discriminator Discriminator, err error)
  • func (d Discriminator) MarshalJSON() (data []byte, err error)
  • func (d Discriminator) NotSet() bool
  • func (d Discriminator) String() (str string)
  • func (d *Discriminator) UnmarshalJSON(data []byte) (err error)
• type Embed
  • func (c *Embed) CopyOverTo(other interface{}) (err error)
  • func (c *Embed) DeepCopy() (copy interface{})
• type EmbedAuthor
  • func (c *EmbedAuthor) CopyOverTo(other interface{}) (err error)
  • func (c *EmbedAuthor) DeepCopy() (copy interface{})
• type EmbedField
  • func (c *EmbedField) CopyOverTo(other interface{}) (err error)
  • func (c *EmbedField) DeepCopy() (copy interface{})
• type EmbedFooter
  • func (c *EmbedFooter) CopyOverTo(other interface{}) (err error)
  • func (c *EmbedFooter) DeepCopy() (copy interface{})
• type EmbedImage
  • func (c *EmbedImage) CopyOverTo(other interface{}) (err error)
  • func (c *EmbedImage) DeepCopy() (copy interface{})
• type EmbedProvider
  • func (c *EmbedProvider) CopyOverTo(other interface{}) (err error)
  • func (c *EmbedProvider) DeepCopy() (copy interface{})
• type EmbedThumbnail
  • func (c *EmbedThumbnail) CopyOverTo(other interface{}) (err error)
  • func (c *EmbedThumbnail) DeepCopy() (copy interface{})
• type EmbedVideo
  • func (c *EmbedVideo) CopyOverTo(other interface{}) (err error)
  • func (c *EmbedVideo) DeepCopy() (copy interface{})
• type Emitter
• type Emoji
  • func (e *Emoji) CopyOverTo(other interface{}) (err error)
  • func (e *Emoji) DeepCopy() (copy interface{})
  • func (e *Emoji) LinkToGuild(guildID snowflake.ID)
  • func (e *Emoji) Mention() string
  • func (e *Emoji) Reset()
  • func (e *Emoji) String() string
• type ErrRest
• type ErrorCacheItemNotFound
  • func (e *ErrorCacheItemNotFound) Error() string
• type ErrorEmptyValue
  • func (e *ErrorEmptyValue) Error() string
• type ErrorMissingSnowflake
  • func (e *ErrorMissingSnowflake) Error() string
• type ErrorUnsupportedType
  • func (e *ErrorUnsupportedType) Error() string
• type ErrorUsingDeactivatedCache
  • func (e *ErrorUsingDeactivatedCache) Error() string
• type EventChannels
• type ExecuteWebhookParams
  • func NewExecuteWebhookParams(id Snowflake, token string) (ret *ExecuteWebhookParams, err error)
• type ExplicitContentFilterLvl
  • func (ecfl *ExplicitContentFilterLvl) AllMembers() bool
  • func (ecfl *ExplicitContentFilterLvl) Disabled() bool
  • func (ecfl *ExplicitContentFilterLvl) MembersWithoutRoles() bool
• type Flag
  • func (f Flag) IgnoreEmptyParams() bool
  • func (f Flag) Ignorecache() bool
  • func (i Flag) String() string
• type Gateway
  • func GetGateway(client httd.Getter) (gateway *Gateway, err error)
• type GatewayBot
  • func GetGatewayBot(client httd.Getter) (gateway *GatewayBot, err error)
• type GetCurrentUserGuildsParams
  • func (g *GetCurrentUserGuildsParams) URLQueryString() string
• type GetInviteParams
  • func (g *GetInviteParams) URLQueryString() string
• type GetMembersParams
• type GetMessagesParams
  • func (g *GetMessagesParams) URLQueryString() string
• type GetReactionURLParams
  • func (g *GetReactionURLParams) URLQueryString() string
• type GroupDMParticipant
  • func (g *GroupDMParticipant) FindErrors() error
• type Guild
  • func NewGuild() *Guild
  • func NewGuildFromJSON(data []byte) (guild *Guild)
  • func NewGuildFromUnavailable(gu *GuildUnavailable) *Guild
  • func NewPartialGuild(ID Snowflake) (guild *Guild)
  • func (g *Guild) AddChannel(c *Channel) error
  • func (g *Guild) AddMember(member *Member) error
  • func (g *Guild) AddMembers(members []*Member)
  • func (g *Guild) AddRole(role *Role) error
  • func (g *Guild) Channel(id Snowflake) (*Channel, error)
  • func (g *Guild) CopyOverTo(other interface{}) (err error)
  • func (g *Guild) DeepCopy() (copy interface{})
  • func (g *Guild) DeleteChannel(c *Channel) error
  • func (g *Guild) DeleteChannelByID(ID Snowflake) error
  • func (g *Guild) DeleteRoleByID(ID Snowflake)
  • func (g *Guild) Emoji(id Snowflake) (emoji *Emoji, err error)
  • func (g *Guild) GetMemberWithHighestSnowflake() *Member
  • func (g *Guild) LoadAllMembers(s Session) (err error)
  • func (g *Guild) MarshalJSON() ([]byte, error)
  • func (g *Guild) Member(id Snowflake) (*Member, error)
  • func (g *Guild) MembersByName(name string) (members []*Member)
  • func (g *Guild) Reset()
  • func (g *Guild) Role(id Snowflake) (role *Role, err error)
  • func (g *Guild) RoleByName(name string) ([]*Role, error)
  • func (g *Guild) String() string
• type GuildBanAdd
• type GuildBanAddHandler
• type GuildBanRemove
• type GuildBanRemoveHandler
• type GuildCreate
  • func (obj *GuildCreate) UnmarshalJSON(data []byte) error
• type GuildCreateHandler
• type GuildDelete
  • func (obj *GuildDelete) UnmarshalJSON(data []byte) error
  • func (obj *GuildDelete) UserWasRemoved() bool
• type GuildDeleteHandler
• type GuildEmbed
  • func (e *GuildEmbed) CopyOverTo(other interface{}) (err error)
  • func (e *GuildEmbed) DeepCopy() (copy interface{})
• type GuildEmojisUpdate
• type GuildEmojisUpdateHandler
• type GuildIntegrationsUpdate
• type GuildIntegrationsUpdateHandler
• type GuildMemberAdd
  • func (obj *GuildMemberAdd) UnmarshalJSON(data []byte) error
• type GuildMemberAddHandler
• type GuildMemberRemove
• type GuildMemberRemoveHandler
• type GuildMemberUpdate
• type GuildMemberUpdateHandler
• type GuildMembersChunk
• type GuildMembersChunkHandler
• type GuildRoleCreate
• type GuildRoleCreateHandler
• type GuildRoleDelete
• type GuildRoleDeleteHandler
• type GuildRoleUpdate
• type GuildRoleUpdateHandler
• type GuildUnavailable
  • func NewGuildUnavailable(ID Snowflake) *GuildUnavailable
• type GuildUpdate
  • func (obj *GuildUpdate) UnmarshalJSON(data []byte) error
• type GuildUpdateHandler
• type Handler
• type HandlerCtrl
• type Integration
  • func (i *Integration) CopyOverTo(other interface{}) (err error)
  • func (i *Integration) DeepCopy() (copy interface{})
• type IntegrationAccount
  • func (i *IntegrationAccount) CopyOverTo(other interface{}) (err error)
  • func (i *IntegrationAccount) DeepCopy() (copy interface{})
• type Invite
  • func (i *Invite) CopyOverTo(other interface{}) (err error)
  • func (i *Invite) DeepCopy() (copy interface{})
• type InviteMetadata
  • func (i *InviteMetadata) CopyOverTo(other interface{}) (err error)
  • func (i *InviteMetadata) DeepCopy() (copy interface{})
• type Link
• type Lockable
• type Logger
• type MFALvl
  • func (mfal *MFALvl) Elevated() bool
  • func (mfal *MFALvl) None() bool
• type Member
  • func (m *Member) CopyOverTo(other interface{}) (err error)
  • func (m *Member) DeepCopy() (copy interface{})
  • func (m *Member) GetUser(session Session) (usr *User, err error)
  • func (m *Member) Mention() string
  • func (m *Member) Reset()
  • func (m *Member) String() string
• type Message
  • func NewMessage() *Message
  • func (m *Message) CopyOverTo(other interface{}) (err error)
  • func (m *Message) DeepCopy() (copy interface{})
  • func (m *Message) Reply(client msgSender, data ...interface{}) (*Message, error)
  • func (m *Message) Reset()
  • func (m *Message) Respond(client MessageSender, message *Message) (msg *Message, err error)
  • func (m *Message) RespondString(client MessageSender, content string) (msg *Message, err error)
  • func (m *Message) Send(client MessageSender, flags ...Flag) (msg *Message, err error)
  • func (m *Message) String() string
• type MessageActivity
• type MessageApplication
• type MessageCreate
  • func (m *MessageCreate) Reset()
  • func (obj *MessageCreate) UnmarshalJSON(data []byte) error
• type MessageCreateHandler
• type MessageDelete
• type MessageDeleteBulk
• type MessageDeleteBulkHandler
• type MessageDeleteHandler
• type MessageReactionAdd
• type MessageReactionAddHandler
• type MessageReactionRemove
• type MessageReactionRemoveAll
• type MessageReactionRemoveAllHandler
• type MessageReactionRemoveHandler
• type MessageSender
• type MessageUpdate
  • func (obj *MessageUpdate) UnmarshalJSON(data []byte) error
• type MessageUpdateHandler
• type MessageUpdater
• type Middleware
• type PartialBan
  • func (p *PartialBan) String() string
• type PartialChannel
• type PartialEmoji
• type PartialGuild
• type PartialInvite
• type PermissionOverwrite
• type Pool
• type PremiumType
  • func (p PremiumType) String() (t string)
• type Presence
• type PresenceUpdate
• type PresenceUpdateHandler
• type PresencesReplace
• type PresencesReplaceHandler
• type RESTAuditLogs
• type RESTBuilder
  • func (b *RESTBuilder) CancelOnRatelimit() *RESTBuilder
  • func (b *RESTBuilder) IgnoreCache() *RESTBuilder
• type RESTChannel
• type RESTEmoji
• type RESTGuild
• type RESTInvite
• type RESTMessage
• type RESTMethods
• type RESTReaction
• type RESTUser
• type RESTVoice
• type RESTWebhook
• type Reaction
  • func (r *Reaction) CopyOverTo(other interface{}) (err error)
  • func (r *Reaction) DeepCopy() (copy interface{})
  • func (r *Reaction) Reset()
• type Ready
• type ReadyHandler
• type RequestGuildMembersCommand
• type Reseter
• type Resumed
• type ResumedHandler
• type Role
  • func NewRole() *Role
  • func (r *Role) CopyOverTo(other interface{}) (err error)
  • func (r *Role) DeepCopy() (copy interface{})
  • func (r *Role) Mention() string
  • func (r *Role) Reset()
  • func (r *Role) SetGuildID(id Snowflake)
• type Session
• type SimpleHandler
• type SimplestHandler
• type Snowflake
  • func GetSnowflake(v interface{}) (Snowflake, error)
  • func NewSnowflake(id uint64) Snowflake
  • func ParseSnowflakeString(v string) Snowflake
• type SocketCommand
• type SocketHandler
• type Time
  • func (t Time) MarshalJSON() ([]byte, error)
  • func (t Time) String() string
  • func (t *Time) UnmarshalJSON(data []byte) error
• type TypingStart
• type TypingStartHandler
• type URLQueryStringer
• type UpdateChannelPermissionsParams
• type UpdateGuildChannelPositionsParams
• type UpdateGuildIntegrationParams
• type UpdateGuildRolePositionsParams
  • func NewUpdateGuildRolePositionsParams(rs []*Role) (p []UpdateGuildRolePositionsParams)
• type UpdateStatusCommand
• type UpdateVoiceStateCommand
• type User
  • func NewUser() *User
  • func (u *User) CopyOverTo(other interface{}) (err error)
  • func (u *User) DeepCopy() (copy interface{})
  • func (u *User) Mention() string
  • func (u *User) Reset()
  • func (u *User) SendMsg(session Session, message *Message) (channel *Channel, msg *Message, err error)
  • func (u *User) SendMsgString(session Session, content string) (channel *Channel, msg *Message, err error)
  • func (u *User) String() string
  • func (u *User) UnmarshalJSON(data []byte) (err error)
  • func (u *User) Valid() bool
• type UserConnection
  • func (c *UserConnection) CopyOverTo(other interface{}) (err error)
  • func (c *UserConnection) DeepCopy() (copy interface{})
• type UserPresence
  • func NewUserPresence() *UserPresence
  • func (p *UserPresence) CopyOverTo(other interface{}) (err error)
  • func (p *UserPresence) DeepCopy() (copy interface{})
  • func (p *UserPresence) String() string
• type UserUpdate
• type UserUpdateHandler
• type VerificationLvl
  • func (vl *VerificationLvl) High() bool
  • func (vl *VerificationLvl) Low() bool
  • func (vl *VerificationLvl) Medium() bool
  • func (vl *VerificationLvl) None() bool
  • func (vl *VerificationLvl) VeryHigh() bool
• type VoiceConnection
• type VoiceHandler
• type VoiceRegion
  • func (v *VoiceRegion) CopyOverTo(other interface{}) (err error)
  • func (v *VoiceRegion) DeepCopy() (copy interface{})
  • func (v *VoiceRegion) Reset()
• type VoiceServerUpdate
• type VoiceServerUpdateHandler
• type VoiceState
  • func (v *VoiceState) CopyOverTo(other interface{}) (err error)
  • func (v *VoiceState) DeepCopy() (copy interface{})
  • func (v *VoiceState) Reset()
• type VoiceStateUpdate
• type VoiceStateUpdateHandler
• type WSShard
  • func (s *WSShard) Connect() error
  • func (s *WSShard) Disconnect() error
  • func (s *WSShard) Emit(cmd SocketCommand, data interface{}) (err error)
  • func (s *WSShard) Prepare(conf *Config, discordPktPool *sync.Pool, evtChan chan *websocket.Event, ...) (err error)
• type WSShardManager
  • func NewShardManager(conf *Config) *WSShardManager
  • func (s *WSShardManager) Connect() (err error)
  • func (s *WSShardManager) Disconnect() (err error)
  • func (s *WSShardManager) Emit(cmd SocketCommand, data interface{}) (err error)
  • func (s *WSShardManager) GetAvgHeartbeatLatency() (latency time.Duration, err error)
  • func (s *WSShardManager) GetConnectionDetails(c httd.Getter) (url string, shardCount uint, err error)
  • func (s *WSShardManager) GetShard(guildID snowflake.ID) (*WSShard, error)
  • func (s *WSShardManager) Prepare(conf *Config) error
• type WSShardManagerConfig
• type Webhook
  • func (w *Webhook) CopyOverTo(other interface{}) (err error)
  • func (w *Webhook) DeepCopy() (copy interface{})
• type WebhooksUpdate
• type WebhooksUpdateHandler

Constants

const (
	NoCacheSpecified cacheRegistry = iota
	UserCache
	ChannelCache
	GuildCache
	GuildEmojiCache
	VoiceStateCache

	GuildMembersCache
	GuildRolesCache // warning: deletes previous roles
	GuildRoleCache  // updates or adds a new role
)

cacheLink keys to redirect to the related cacheLink system

const (
	CacheAlgLRU  = "lru"
	CacheAlgLFU  = "lfu"
	CacheAlgTLRU = "tlru"
)

the different cacheLink replacement algorithms

const (
	ChannelTypeGuildText uint = iota
	ChannelTypeDM
	ChannelTypeGuildVoice
	ChannelTypeGroupDM
	ChannelTypeGuildCategory
	ChannelTypeGuildNews
	ChannelTypeGuildStore
)

Channel types https://discordapp.com/developers/docs/resources/channel#channel-object-channel-types

const (
	PermissionReadMessages = 1 << (iota + 10)
	PermissionSendMessages
	PermissionSendTTSMessages
	PermissionManageMessages
	PermissionEmbedLinks
	PermissionAttachFiles
	PermissionReadMessageHistory
	PermissionMentionEveryone
	PermissionUseExternalEmojis
)

Constants for the different bit offsets of text channel permissions

const (
	PermissionVoiceConnect = 1 << (iota + 20)
	PermissionVoiceSpeak
	PermissionVoiceMuteMembers
	PermissionVoiceDeafenMembers
	PermissionVoiceMoveMembers
	PermissionVoiceUseVAD
	PermissionVoicePrioritySpeaker = 1 << (iota + 2)
)

Constants for the different bit offsets of voice permissions

const (
	PermissionChangeNickname = 1 << (iota + 26)
	PermissionManageNicknames
	PermissionManageRoles
	PermissionManageWebhooks
	PermissionManageEmojis
)

Constants for general management.

const (
	PermissionCreateInstantInvite = 1 << iota
	PermissionKickMembers
	PermissionBanMembers
	PermissionAdministrator
	PermissionManageChannels
	PermissionManageServer
	PermissionAddReactions
	PermissionViewAuditLogs

	PermissionTextAll = PermissionReadMessages |
		PermissionSendMessages |
		PermissionSendTTSMessages |
		PermissionManageMessages |
		PermissionEmbedLinks |
		PermissionAttachFiles |
		PermissionReadMessageHistory |
		PermissionMentionEveryone
	PermissionAllVoice = PermissionVoiceConnect |
		PermissionVoiceSpeak |
		PermissionVoiceMuteMembers |
		PermissionVoiceDeafenMembers |
		PermissionVoiceMoveMembers |
		PermissionVoiceUseVAD
	PermissionChannelAll = PermissionTextAll |
		PermissionAllVoice |
		PermissionCreateInstantInvite |
		PermissionManageRoles |
		PermissionManageChannels |
		PermissionAddReactions |
		PermissionViewAuditLogs
	PermissionAll = PermissionChannelAll |
		PermissionKickMembers |
		PermissionBanMembers |
		PermissionManageServer |
		PermissionAdministrator
)

Constants for the different bit offsets of general permissions

const (
	MessageActivityTypeJoin
	MessageActivityTypeSpectate
	MessageActivityTypeListen
	MessageActivityTypeJoinRequest
)

different message acticity types

const (
	MessageTypeDefault = iota
	MessageTypeRecipientAdd
	MessageTypeRecipientRemove
	MessageTypeCall
	MessageTypeChannelNameChange
	MessageTypeChannelIconChange
	MessageTypeChannelPinnedMessage
	MessageTypeGuildMemberJoin
)

The different message types usually generated by Discord. eg. "a new user joined"

const (
	// StatusIdle presence status for idle
	StatusIdle = "idle"
	// StatusDnd presence status for dnd
	StatusDnd = "dnd"
	// StatusOnline presence status for online
	StatusOnline = "online"
	// StatusOffline presence status for offline
	StatusOffline = "offline"
)

const (
	ActivityFlagInstance    = 1 << 0
	ActivityFlagJoin        = 1 << 1
	ActivityFlagSpectate    = 1 << 2
	ActivityFlagJoinRequest = 1 << 3
	ActivityFlagSync        = 1 << 4
	ActivityFlagPlay        = 1 << 5
)

flags for the Activity object to signify the type of action taken place

const (
	AttachmentSpoilerPrefix = "SPOILER_"
)

const DefaultShardRateLimit float64 = 5.5 // seconds

const EvtChannelCreate = event.ChannelCreate

EventChannelCreate Sent when a new channel is created, relevant to the current user. The inner payload is a DM channel or guild channel object.

const EvtChannelDelete = event.ChannelDelete

EventChannelDelete Sent when a channel relevant to the current user is deleted. The inner payload is a DM or Guild channel object.

const EvtChannelPinsUpdate = event.ChannelPinsUpdate

EventChannelPinsUpdate Sent when a message is pinned or unpinned in a text channel. This is not sent when a pinned message is deleted.

Fields:
- ChannelID int64 or Snowflake
- LastPinTimestamp time.Now().UTC().Format(time.RFC3339)

TODO fix.

const EvtChannelUpdate = event.ChannelUpdate

EventChannelUpdate Sent when a channel is updated. The inner payload is a guild channel object.

const EvtGuildBanAdd = event.GuildBanAdd

EventGuildBanAdd Sent when a user is banned from a guild. The inner payload is a user object, with an extra guild_id key.

const EvtGuildBanRemove = event.GuildBanRemove

EventGuildBanRemove Sent when a user is unbanned from a guild. The inner payload is a user object, with an extra guild_id key.

const EvtGuildCreate = event.GuildCreate

EventGuildCreate This event can be sent in three different scenarios:

1. When a user is initially connecting, to lazily load and backfill information for all unavailable guilds sent in the Ready event.
2. When a Guild becomes available again to the client.
3. When the current user joins a new Guild.

const EvtGuildDelete = event.GuildDelete

EventGuildDelete Sent when a guild becomes unavailable during a guild outage, or when the user leaves or is removed from a guild. The inner payload is an unavailable guild object. If the unavailable field is not set, the user was removed from the guild.

const EvtGuildEmojisUpdate = event.GuildEmojisUpdate

EventGuildEmojisUpdate Sent when a guild's emojis have been updated.

Fields:
- GuildID Snowflake
- Emojis []*Emoji

const EvtGuildIntegrationsUpdate = event.GuildIntegrationsUpdate

EventGuildIntegrationsUpdate Sent when a guild integration is updated.

Fields:
- GuildID Snowflake

const EvtGuildMemberAdd = event.GuildMemberAdd

EventGuildMemberAdd Sent when a new user joins a guild. The inner payload is a guild member object with these extra fields:

• GuildID Snowflake

  Fields:

• Member *Member

const EvtGuildMemberRemove = event.GuildMemberRemove

EventGuildMemberRemove Sent when a user is removed from a guild (leave/kick/ban).

Fields:
- GuildID   Snowflake
- User      *User

const EvtGuildMemberUpdate = event.GuildMemberUpdate

EventGuildMemberUpdate Sent when a guild member is updated.

Fields:
- GuildID   Snowflake
- Roles     []Snowflake
- User      *User
- Nick      string

const EvtGuildMembersChunk = event.GuildMembersChunk

EventGuildMembersChunk Sent in response to Gateway Request Guild Members.

Fields:
- GuildID Snowflake
- Members []*Member

const EvtGuildRoleCreate = event.GuildRoleCreate

EventGuildRoleCreate Sent when a guild role is created.

Fields:
- GuildID   Snowflake
- Role      *Role

const EvtGuildRoleDelete = event.GuildRoleDelete

EventGuildRoleDelete Sent when a guild role is created.

Fields:
- GuildID Snowflake
- RoleID  Snowflake

const EvtGuildRoleUpdate = event.GuildRoleUpdate

EventGuildRoleUpdate Sent when a guild role is created.

Fields:
- GuildID Snowflake
- Role    *Role

const EvtGuildUpdate = event.GuildUpdate

EventGuildUpdate Sent when a guild is updated. The inner payload is a guild object.

const EvtMessageCreate = event.MessageCreate

EventMessageCreate Sent when a message is created. The inner payload is a message object.

const EvtMessageDelete = event.MessageDelete

EventMessageDelete Sent when a message is deleted.

Fields:
- ID        Snowflake
- ChannelID Snowflake

const EvtMessageDeleteBulk = event.MessageDeleteBulk

EventMessageDeleteBulk Sent when multiple messages are deleted at once.

Fields:
- IDs       []Snowflake
- ChannelID Snowflake

const EvtMessageReactionAdd = event.MessageReactionAdd

EventMessageReactionAdd Sent when a user adds a reaction to a message.

Fields:
- UserID     Snowflake
- ChannelID  Snowflake
- MessageID  Snowflake
- Emoji      *Emoji

const EvtMessageReactionRemove = event.MessageReactionRemove

EventMessageReactionRemove Sent when a user removes a reaction from a message.

Fields:
- UserID     Snowflake
- ChannelID  Snowflake
- MessageID  Snowflake
- Emoji      *Emoji

const EvtMessageReactionRemoveAll = event.MessageReactionRemoveAll

EventMessageReactionRemoveAll Sent when a user explicitly removes all reactions from a message.

Fields:
- ChannelID Snowflake
- MessageID Snowflake

const EvtMessageUpdate = event.MessageUpdate

EventMessageUpdate Sent when a message is updated. The inner payload is a message object.

NOTE! Has _at_least_ the GuildID and ChannelID fields.

const EvtPresenceUpdate = event.PresenceUpdate

EventPresenceUpdate A user's presence is their current state on a guild. This event is sent when a user's presence is updated for a guild.

Fields:
- User    *User
- Roles   []Snowflake
- Game    *Activity
- GuildID Snowflake
- Status  string

const EvtPresencesReplace = event.PresencesReplace

EventPresencesReplace Holds and array of presence update objects

const EvtReady = event.Ready

EventReady The ready event is dispatched when a client has completed the initial handshake with the gateway (for new sessions). // The ready event can be the largest and most complex event the gateway will send, as it contains all the state // required for a client to begin interacting with the rest of the platform. // Fields: // - V int // - User *User // - PrivateChannels []*Channel // - Guilds []*GuildUnavailable // - SessionID string // - Trace []string

const EvtResumed = event.Resumed

EventResumed The resumed event is dispatched when a client has sent a resume payload to the gateway (for resuming existing sessions).

Fields:
- Trace []string

const EvtTypingStart = event.TypingStart

EventTypingStart Sent when a user starts typing in a channel.

Fields:
- ChannelID     Snowflake
- UserID        Snowflake
- TimestampUnix int

const EvtUserUpdate = event.UserUpdate

EventUserUpdate Sent when properties about the user change. Inner payload is a user object.

const EvtVoiceServerUpdate = event.VoiceServerUpdate

EventVoiceServerUpdate Sent when a guild's voice server is updated. This is sent when initially connecting to voice, and when the current voice instance fails over to a new server.

Fields:
- Token     string
- ChannelID Snowflake
- Endpoint  string

const EvtVoiceStateUpdate = event.VoiceStateUpdate

EventVoiceStateUpdate Sent when someone joins/leaves/moves voice channels. Inner payload is a voice state object.

const EvtWebhooksUpdate = event.WebhooksUpdate

EventWebhooksUpdate Sent when a guild channel's webhook is created, updated, or deleted.

Fields:
- GuildID   Snowflake
- ChannelID Snowflake

Functions

func DefaultLogger

func DefaultLogger(debug bool) *logger.LoggerZap

func DefaultLoggerWithInstance

func DefaultLoggerWithInstance(log *zap.Logger) *logger.LoggerZap

func GetShardForGuildID

func GetShardForGuildID(guildID Snowflake, shardCount uint) (shardID uint)

GetShardForGuildID converts a GuildID into a ShardID for correct retrieval of guild information

func LibraryInfo

func LibraryInfo() string

LibraryInfo returns name + version

func New

func New(conf *Config) (c *client)

New create a client. But panics on configuration/setup errors.

func NewClient

func NewClient(conf *Config) (c *client, err error)

NewClient creates a new DisGord client and returns an error on configuration issues

func NewRESTClient

func NewRESTClient(conf *Config) (*httd.Client, error)

NewRESTClient creates a client for sending and handling Discord protocols such as rate limiting

func SortRoles

func SortRoles(rs []*Role)

SortRoles sorts a slice of roles such that the first element is the top one in the Discord Guild Settings UI.

func ValidateHandlerInputs

func ValidateHandlerInputs(inputs ...interface{}) (err error)

func ValidateUsername

func ValidateUsername(name string) (err error)

ValidateUsername uses Discords rule-set to verify user-names and nicknames https://discordapp.com/developers/docs/resources/user#usernames-and-nicknames

Note that not all the rules are listed in the docs:

There are other rules and restrictions not shared here for the sake of spam and abuse mitigation, but the
majority of users won't encounter them. It's important to properly handle all error messages returned by
Discord when editing or updating names.

Types

type Activity

type Activity struct {
	Lockable `json:"-"`

	Name          string             `json:"name"`                     // the activity's name
	Type          int                `json:"type"`                     // activity type
	URL           *string            `json:"url,omitempty"`            //stream url, is validated when type is 1
	Timestamps    *ActivityTimestamp `json:"timestamps,omitempty"`     // timestamps object	unix timestamps for start and/or end of the game
	ApplicationID Snowflake          `json:"application_id,omitempty"` //?	snowflake	application id for the game
	Details       *string            `json:"details,omitempty"`        //?	?string	what the player is currently doing
	State         *string            `json:"state,omitempty"`          //state?	?string	the user's current party status
	Party         *ActivityParty     `json:"party,omitempty"`          //party?	party object	information for the current party of the player
	Assets        *ActivityAssets    `json:"assets,omitempty"`         // assets?	assets object	images for the presence and their hover texts
	Secrets       *ActivitySecrets   `json:"secrets,omitempty"`        // secrets?	secrets object	secrets for Rich Presence joining and spectating
	Instance      bool               `json:"instance,omitempty"`       // instance?	boolean	whether or not the activity is an instanced game session
	Flags         int                `json:"flags,omitempty"`          // flags?	int	activity flags ORd together, describes what the payload includes
}

Activity https://discordapp.com/developers/docs/topics/gateway#activity-object-activity-structure

func NewActivity

func NewActivity() (activity *Activity)

NewActivity ...

func (*Activity) CopyOverTo

func (a *Activity) CopyOverTo(other interface{}) (err error)

CopyOverTo see interface at struct.go#Copier

func (*Activity) DeepCopy

func (a *Activity) DeepCopy() (copy interface{})

DeepCopy see interface at struct.go#DeepCopier

func (*Activity) Reset

func (a *Activity) Reset()

type ActivityAssets

type ActivityAssets struct {
	Lockable `json:"-"`

	LargeImage string `json:"large_image,omitempty"` // the id for a large asset of the activity, usually a snowflake
	LargeText  string `json:"large_text,omitempty"`  //text displayed when hovering over the large image of the activity
	SmallImage string `json:"small_image,omitempty"` // the id for a small asset of the activity, usually a snowflake
	SmallText  string `json:"small_text,omitempty"`  //	text displayed when hovering over the small image of the activity
}

ActivityAssets ...

func (*ActivityAssets) CopyOverTo

func (a *ActivityAssets) CopyOverTo(other interface{}) (err error)

CopyOverTo see interface at struct.go#Copier

func (*ActivityAssets) DeepCopy

func (a *ActivityAssets) DeepCopy() (copy interface{})

DeepCopy see interface at struct.go#DeepCopier

type ActivityParty

type ActivityParty struct {
	Lockable `json:"-"`

	ID   string `json:"id,omitempty"`   // the id of the party
	Size []int  `json:"size,omitempty"` // used to show the party's current and maximum size
}

ActivityParty ...

func (*ActivityParty) CopyOverTo

func (ap *ActivityParty) CopyOverTo(other interface{}) (err error)

CopyOverTo see interface at struct.go#Copier

func (*ActivityParty) DeepCopy

func (ap *ActivityParty) DeepCopy() (copy interface{})

DeepCopy see interface at struct.go#DeepCopier

func (*ActivityParty) Limit

func (ap *ActivityParty) Limit() int

Limit shows the maximum number of guests/people allowed

func (*ActivityParty) NumberOfPeople

func (ap *ActivityParty) NumberOfPeople() int

NumberOfPeople shows the current number of people attending the Party

type ActivitySecrets

type ActivitySecrets struct {
	Lockable `json:"-"`

	Join     string `json:"join,omitempty"`     // the secret for joining a party
	Spectate string `json:"spectate,omitempty"` // the secret for spectating a game
	Match    string `json:"match,omitempty"`    // the secret for a specific instanced match
}

ActivitySecrets ...

func (*ActivitySecrets) CopyOverTo

func (a *ActivitySecrets) CopyOverTo(other interface{}) (err error)

CopyOverTo see interface at struct.go#Copier

func (*ActivitySecrets) DeepCopy

func (a *ActivitySecrets) DeepCopy() (copy interface{})

DeepCopy see interface at struct.go#DeepCopier

type ActivityTimestamp

type ActivityTimestamp struct {
	Lockable `json:"-"`

	Start int `json:"start,omitempty"` // unix time (in milliseconds) of when the activity started
	End   int `json:"end,omitempty"`   // unix time (in milliseconds) of when the activity ends
}

ActivityTimestamp ...

func (*ActivityTimestamp) CopyOverTo

func (a *ActivityTimestamp) CopyOverTo(other interface{}) (err error)

CopyOverTo see interface at struct.go#Copier

func (*ActivityTimestamp) DeepCopy

func (a *ActivityTimestamp) DeepCopy() (copy interface{})

DeepCopy see interface at struct.go#DeepCopier

type AddGuildMemberParams

type AddGuildMemberParams struct {
	AccessToken string      `json:"access_token"` // required
	Nick        string      `json:"nick,omitempty"`
	Roles       []Snowflake `json:"roles,omitempty"`
	Mute        bool        `json:"mute,omitempty"`
	Deaf        bool        `json:"deaf,omitempty"`
}

AddGuildMemberParams ... https://discordapp.com/developers/docs/resources/guild#add-guild-member-json-params

type Attachment

type Attachment struct {
	ID       Snowflake `json:"id"`
	Filename string    `json:"filename"`
	Size     uint      `json:"size"`
	URL      string    `json:"url"`
	ProxyURL string    `json:"proxy_url"`
	Height   uint      `json:"height"`
	Width    uint      `json:"width"`

	SpoilerTag bool `json:"-"`
}

Attachment https://discordapp.com/developers/docs/resources/channel#attachment-object

func (*Attachment) DeepCopy

func (a *Attachment) DeepCopy() (copy interface{})

DeepCopy see interface at struct.go#DeepCopier

type AuditLog

type AuditLog struct {
	Lockable `json:"-"`

	Webhooks        []*Webhook       `json:"webhooks"`
	Users           []*User          `json:"users"`
	AuditLogEntries []*AuditLogEntry `json:"audit_log_entries"`
}

AuditLog ...

func (*AuditLog) Bans

func (l *AuditLog) Bans() (bans []*PartialBan)

func (*AuditLog) CopyOverTo

func (l *AuditLog) CopyOverTo(other interface{}) (err error)

CopyOverTo see interface at struct.go#Copier

func (*AuditLog) DeepCopy

func (l *AuditLog) DeepCopy() (copy interface{})

DeepCopy see interface at struct.go#DeepCopier

type AuditLogChange

type AuditLogChange string

const (
	// key name,								          identifier                       changed, type,   description
	AuditLogChangeName                        AuditLogChange = "name"                          // guild	string	name changed
	AuditLogChangeIconHash                    AuditLogChange = "icon_hash"                     // guild	string	icon changed
	AuditLogChangeSplashHash                  AuditLogChange = "splash_hash"                   // guild	string	invite splash page artwork changed
	AuditLogChangeOwnerID                     AuditLogChange = "owner_id"                      // guild	snowflake	owner changed
	AuditLogChangeRegion                      AuditLogChange = "region"                        // guild	string	region changed
	AuditLogChangeAFKChannelID                AuditLogChange = "afk_channel_id"                // guild	snowflake	afk channel changed
	AuditLogChangeAFKTimeout                  AuditLogChange = "afk_timeout"                   // guild	integer	afk timeout duration changed
	AuditLogChangeMFALevel                    AuditLogChange = "mfa_level"                     // guild	integer	two-factor auth requirement changed
	AuditLogChangeVerificationLevel           AuditLogChange = "verification_level"            // guild	integer	required verification level changed
	AuditLogChangeExplicitContentFilter       AuditLogChange = "explicit_content_filter"       // guild	integer	change in whose messages are scanned and deleted for explicit content in the server
	AuditLogChangeDefaultMessageNotifications AuditLogChange = "default_message_notifications" // guild	integer	default message notification level changed
	AuditLogChangeVanityURLCode               AuditLogChange = "vanity_url_code"               // guild	string	guild invite vanity url changed
	AuditLogChangeAdd                         AuditLogChange = "$add"                          // add	guild	array of role objects	new role added
	AuditLogChangeRemove                      AuditLogChange = "$remove"                       // remove	guild	array of role objects	role removed
	AuditLogChangePruneDeleteDays             AuditLogChange = "prune_delete_days"             // guild	integer	change in number of days after which inactive and role-unassigned members are kicked
	AuditLogChangeWidgetEnabled               AuditLogChange = "widget_enabled"                // guild	bool	server widget enabled/disable
	AuditLogChangeWidgetChannelID             AuditLogChange = "widget_channel_id"             // guild	snowflake	channel id of the server widget changed
	AuditLogChangePosition                    AuditLogChange = "position"                      // channel	integer	text or voice channel position changed
	AuditLogChangeTopic                       AuditLogChange = "topic"                         // channel	string	text channel topic changed
	AuditLogChangeBitrate                     AuditLogChange = "bitrate"                       // channel	integer	voice channel bitrate changed
	AuditLogChangePermissionOverwrites        AuditLogChange = "permission_overwrites"         // channel	array of channel overwrite objects	permissions on a channel changed
	AuditLogChangeNSFW                        AuditLogChange = "nsfw"                          // channel	bool	channel nsfw restriction changed
	AuditLogChangeApplicationID               AuditLogChange = "application_id"                // channel	snowflake	application id of the added or removed webhook or bot
	AuditLogChangePermissions                 AuditLogChange = "permissions"                   // role	integer	permissions for a role changed
	AuditLogChangeColor                       AuditLogChange = "color"                         // role	integer	role color changed
	AuditLogChangeHoist                       AuditLogChange = "hoist"                         // role	bool	role is now displayed/no longer displayed separate from online users
	AuditLogChangeMentionable                 AuditLogChange = "mentionable"                   // role	bool	role is now mentionable/unmentionable
	AuditLogChangeAllow                       AuditLogChange = "allow"                         // role	integer	a permission on a text or voice channel was allowed for a role
	AuditLogChangeDeny                        AuditLogChange = "deny"                          // role	integer	a permission on a text or voice channel was denied for a role
	AuditLogChangeCode                        AuditLogChange = "code"                          // invite	string	invite code changed
	AuditLogChangeChannelID                   AuditLogChange = "channel_id"                    // invite	snowflake	channel for invite code changed
	AuditLogChangeInviterID                   AuditLogChange = "inviter_id"                    // invite	snowflake	person who created invite code changed
	AuditLogChangeMaxUses                     AuditLogChange = "max_uses"                      // invite	integer	change to max number of times invite code can be used
	AuditLogChangeUses                        AuditLogChange = "uses"                          // invite	integer	number of times invite code used changed
	AuditLogChangeMaxAge                      AuditLogChange = "max_age"                       // invite	integer	how long invite code lasts changed
	AuditLogChangeTemporary                   AuditLogChange = "temporary"                     // invite	bool	invite code is temporary/never expires
	AuditLogChangeDeaf                        AuditLogChange = "deaf"                          // user	bool	user server deafened/undeafened
	AuditLogChangeMute                        AuditLogChange = "mute"                          // user	bool	user server muted/unmuteds
	AuditLogChangeNick                        AuditLogChange = "nick"                          // user	string	user nickname changed
	AuditLogChangeAvatarHash                  AuditLogChange = "avatar_hash"                   // user	string	user avatar changed
	AuditLogChangeID                          AuditLogChange = "id"                            // any	snowflake	the id of the changed entity - sometimes used in conjunction with other keys
	AuditLogChangeType                        AuditLogChange = "type"                          // any	integer (channel type) or string	type of entity created
)

all the different keys for an audit log change

type AuditLogChanges

type AuditLogChanges struct {
	Lockable `json:"-"`

	NewValue interface{} `json:"new_value,omitempty"`
	OldValue interface{} `json:"old_value,omitempty"`
	Key      string      `json:"key"`
}

AuditLogChanges ...

func (*AuditLogChanges) CopyOverTo

func (l *AuditLogChanges) CopyOverTo(other interface{}) (err error)

CopyOverTo see interface at struct.go#Copier

func (*AuditLogChanges) DeepCopy

func (l *AuditLogChanges) DeepCopy() (copy interface{})

DeepCopy see interface at struct.go#DeepCopier

type AuditLogEntry

type AuditLogEntry struct {
	Lockable `json:"-"`

	TargetID Snowflake          `json:"target_id"`
	Changes  []*AuditLogChanges `json:"changes,omitempty"`
	UserID   Snowflake          `json:"user_id"`
	ID       Snowflake          `json:"id"`
	Event    AuditLogEvt        `json:"action_type"`
	Options  *AuditLogOption    `json:"options,omitempty"`
	Reason   string             `json:"reason,omitempty"`
}

AuditLogEntry ...

func (*AuditLogEntry) CopyOverTo

func (l *AuditLogEntry) CopyOverTo(other interface{}) (err error)

CopyOverTo see interface at struct.go#Copier

func (*AuditLogEntry) DeepCopy

func (l *AuditLogEntry) DeepCopy() (copy interface{})

DeepCopy see interface at struct.go#DeepCopier

type AuditLogEvt

type AuditLogEvt uint

const (
	AuditLogEvtChannelCreate AuditLogEvt = 10 + iota
	AuditLogEvtChannelUpdate
	AuditLogEvtChannelDelete
	AuditLogEvtOverwriteCreate
	AuditLogEvtOverwriteUpdate
	AuditLogEvtOverwriteDelete
)

const (
	AuditLogEvtMemberKick AuditLogEvt = 20 + iota
	AuditLogEvtMemberPrune
	AuditLogEvtMemberBanAdd
	AuditLogEvtMemberBanRemove
	AuditLogEvtMemberUpdate
	AuditLogEvtMemberRoleUpdate
)

const (
	AuditLogEvtRoleCreate AuditLogEvt = 30 + iota
	AuditLogEvtRoleUpdate
	AuditLogEvtRoleDelete
)

const (
	AuditLogEvtInviteCreate AuditLogEvt = 40
	AuditLogEvtInviteUpdate
	AuditLogEvtInviteDelete
)

const (
	AuditLogEvtWebhookCreate AuditLogEvt = 50 + iota
	AuditLogEvtWebhookUpdate
	AuditLogEvtWebhookDelete
)

const (
	AuditLogEvtEmojiCreate AuditLogEvt = 60 + iota
	AuditLogEvtEmojiUpdate
	AuditLogEvtEmojiDelete
)

const (
	AuditLogEvtGuildUpdate AuditLogEvt = 1
)

Audit-log event types

const (
	AuditLogEvtMessageDelete AuditLogEvt = 72
)

type AuditLogOption

type AuditLogOption struct {
	Lockable `json:"-"`

	DeleteMemberDays string    `json:"delete_member_days"`
	MembersRemoved   string    `json:"members_removed"`
	ChannelID        Snowflake `json:"channel_id"`
	Count            string    `json:"count"`
	ID               Snowflake `json:"id"`
	Type             string    `json:"type"` // type of overwritten entity ("member" or "role")
	RoleName         string    `json:"role_name"`
}

AuditLogOption ...

func (*AuditLogOption) CopyOverTo

func (l *AuditLogOption) CopyOverTo(other interface{}) (err error)

CopyOverTo see interface at struct.go#Copier

func (*AuditLogOption) DeepCopy

func (l *AuditLogOption) DeepCopy() (copy interface{})

DeepCopy see interface at struct.go#DeepCopier

type AvatarParamHolder

type AvatarParamHolder interface {
	json.Marshaler
	Empty() bool
	SetAvatar(avatar string)
	UseDefaultAvatar()
}

AvatarParamHolder is used when handling avatar related REST structs. since a Avatar can be reset by using nil, it causes some extra issues as omit empty cannot be used to get around this, the struct requires an internal state and must also handle custom marshalling

type Ban

type Ban struct {
	Lockable `json:"-"`

	Reason string `json:"reason"`
	User   *User  `json:"user"`
}

Ban https://discordapp.com/developers/docs/resources/guild#ban-object

func (*Ban) CopyOverTo

func (b *Ban) CopyOverTo(other interface{}) (err error)

CopyOverTo see interface at struct.go#Copier

func (*Ban) DeepCopy

func (b *Ban) DeepCopy() (copy interface{})

DeepCopy see interface at struct.go#DeepCopier

type BanMemberParams

type BanMemberParams struct {
	DeleteMessageDays int    `urlparam:"delete_message_days,omitempty"` // number of days to delete messages for (0-7)
	Reason            string `urlparam:"reason,omitempty"`              // reason for being banned
}

BanMemberParams ... https://discordapp.com/developers/docs/resources/guild#create-guild-ban-query-string-params

func (*BanMemberParams) FindErrors

func (b *BanMemberParams) FindErrors() error

func (*BanMemberParams) URLQueryString

func (b *BanMemberParams) URLQueryString() string

type BodyUserCreateDM

type BodyUserCreateDM struct {
	RecipientID Snowflake `json:"recipient_id"`
}

BodyUserCreateDM JSON param for func CreateDM

type Cache

type Cache struct {
	// contains filtered or unexported fields
}

Cache is the actual cacheLink. It holds the different systems which can be tweaked using the CacheConfig.

func (*Cache) AddGuildChannel

func (c *Cache) AddGuildChannel(guildID snowflake.ID, channelID snowflake.ID)

func (*Cache) AddGuildMember

func (c *Cache) AddGuildMember(guildID snowflake.ID, member *Member)

func (*Cache) AddGuildRole

func (c *Cache) AddGuildRole(guildID Snowflake, role *Role)

func (*Cache) DeleteChannel

func (c *Cache) DeleteChannel(id Snowflake)

DeleteChannel ...

func (*Cache) DeleteChannelPermissionOverwrite

func (c *Cache) DeleteChannelPermissionOverwrite(channelID Snowflake, overwriteID Snowflake) error

func (*Cache) DeleteGuild

func (c *Cache) DeleteGuild(id Snowflake)

DeleteGuild ...

func (*Cache) DeleteGuildChannel

func (c *Cache) DeleteGuildChannel(guildID, channelID Snowflake)

DeleteGuildChannel removes a channel from a cached guild object without removing the guild

func (*Cache) DeleteGuildEmoji

func (c *Cache) DeleteGuildEmoji(guildID, emojiID Snowflake)

func (*Cache) DeleteGuildRole

func (c *Cache) DeleteGuildRole(guildID, roleID Snowflake)

DeleteGuildRole removes a role from a cached guild object without removing the guild

func (*Cache) DirectUpdate

func (c *Cache) DirectUpdate(registry cacheRegistry, id snowflake.ID, changes []byte) error

DirectUpdate is used for socket events to only update provided fields. Will peek into the cacheLink for a matching entry if found it updates it, otherwise a not found error is returned. May return a unmarshal error.

// user update
id := extractAttribute([]byte(`"id":"`), 0, jsonData)
err := cacheLink.DirectUpdate(UserCache, id, jsonData)
if err != nil {
	// most likely the user does not exist or it could not be updated
	// add the new user. See Cache.Update
}

TODO-optimize: for bulk changes

func (*Cache) Get

func (c *Cache) Get(key cacheRegistry, id Snowflake, args ...interface{}) (v interface{}, err error)

Get retrieve a item in the cacheLink, or get an error when not found or if the cacheLink system is disabled in your CacheConfig configuration.

func (*Cache) GetChannel

func (c *Cache) GetChannel(id Snowflake) (channel *Channel, err error)

GetChannel ...

func (*Cache) GetGuild

func (c *Cache) GetGuild(id Snowflake) (guild *Guild, err error)

GetGuild ...

func (*Cache) GetGuildEmojis

func (c *Cache) GetGuildEmojis(id Snowflake) (emojis []*Emoji, err error)

GetGuildRoles ...

func (*Cache) GetGuildMember

func (c *Cache) GetGuildMember(guildID, userID Snowflake) (member *Member, err error)

GetGuildMember ...

func (*Cache) GetGuildMembersAfter

func (c *Cache) GetGuildMembersAfter(guildID, after Snowflake, limit int) (members []*Member, err error)

GetGuildMembersAfter ...

func (*Cache) GetGuildRoles

func (c *Cache) GetGuildRoles(id Snowflake) (roles []*Role, err error)

GetGuildRoles ...

func (*Cache) GetUser

func (c *Cache) GetUser(id Snowflake) (user *User, err error)

GetUser ...

func (*Cache) GetVoiceState

func (c *Cache) GetVoiceState(guildID Snowflake, params *guildVoiceStateCacheParams) (state *VoiceState, err error)

GetVoiceState ...

func (*Cache) PeekGuild

func (c *Cache) PeekGuild(id snowflake.ID) (guild *Guild, err error)

func (*Cache) PeekUser

func (c *Cache) PeekUser(id snowflake.ID) (*User, error)

func (*Cache) RemoveGuildMember

func (c *Cache) RemoveGuildMember(guildID snowflake.ID, memberID snowflake.ID)

func (*Cache) SetChannel

func (c *Cache) SetChannel(new *Channel)

SetChannel adds a new channel to cacheLink or updates an existing one

func (*Cache) SetGuild

func (c *Cache) SetGuild(guild *Guild)

SetGuild adds a new guild to cacheLink or updates an existing one

func (*Cache) SetGuildEmojis

func (c *Cache) SetGuildEmojis(guildID Snowflake, emojis []*Emoji)

SetGuildEmojis adds a new guild to cacheLink if no guild exist for the emojis or updates an existing guild with the new emojis

func (*Cache) SetGuildMember

func (c *Cache) SetGuildMember(guildID Snowflake, member *Member)

SetGuildMember calls SetGuildMembers

func (*Cache) SetGuildMembers

func (c *Cache) SetGuildMembers(guildID Snowflake, members []*Member)

SetGuildMembers adds the members to a guild or updates an existing guild

func (*Cache) SetGuildRoles

func (c *Cache) SetGuildRoles(guildID Snowflake, roles []*Role)

SetGuildRoles creates a new guild if none is found and updates the roles for a given guild

func (*Cache) SetUser

func (c *Cache) SetUser(new *User)

SetUser updates an existing user or adds a new one to the cacheLink

func (*Cache) SetVoiceState

func (c *Cache) SetVoiceState(state *VoiceState)

SetVoiceState adds a new voice state to cacheLink or updates an existing one

func (*Cache) Update

func (c *Cache) Update(key cacheRegistry, v interface{}) (err error)

Update updates a item in the cacheLink given the key identifier and the new content. It also checks if the given structs implements the required interfaces (See below).

func (*Cache) UpdateChannelLastMessageID

func (c *Cache) UpdateChannelLastMessageID(channelID Snowflake, messageID Snowflake)

UpdateChannelLastMessageID ...

func (*Cache) UpdateChannelPin

func (c *Cache) UpdateChannelPin(id Snowflake, timestamp Time)

UpdateChannelPin ...

func (*Cache) UpdateGuildRole

func (c *Cache) UpdateGuildRole(guildID snowflake.ID, role *Role, data json.RawMessage) bool

func (*Cache) UpdateMemberAndUser

func (c *Cache) UpdateMemberAndUser(guildID, userID snowflake.ID, data json.RawMessage)

func (*Cache) UpdateOrAddGuildMembers

func (c *Cache) UpdateOrAddGuildMembers(guildID Snowflake, members []*Member)

UpdateOrAddGuildMembers updates and add new members to the guild. It discards the user object so these must be handled before hand. complexity: O(M * N)

func (*Cache) Updates

func (c *Cache) Updates(key cacheRegistry, vs []interface{}) (err error)

Updates does the same as Update. But allows for a slice of entries instead.

type CacheConfig

type CacheConfig struct {
	Mutable bool // Must be immutable to support concurrent access and long-running tasks(!)

	DisableUserCaching  bool
	UserCacheMaxEntries uint
	UserCacheLifetime   time.Duration
	UserCacheAlgorithm  string

	DisableVoiceStateCaching  bool
	VoiceStateCacheMaxEntries uint
	VoiceStateCacheLifetime   time.Duration
	VoiceStateCacheAlgorithm  string

	DisableChannelCaching  bool
	ChannelCacheMaxEntries uint
	ChannelCacheLifetime   time.Duration
	ChannelCacheAlgorithm  string

	DisableGuildCaching  bool
	GuildCacheMaxEntries uint
	GuildCacheLifetime   time.Duration
	GuildCacheAlgorithm  string
}

CacheConfig allows for tweaking the cacheLink system on a personal need

func DefaultCacheConfig

func DefaultCacheConfig() *CacheConfig

type Cacher

type Cacher interface {
	Update(key cacheRegistry, v interface{}) (err error)
	Get(key cacheRegistry, id Snowflake, args ...interface{}) (v interface{}, err error)
	DeleteChannel(channelID snowflake.ID)
	DeleteGuildChannel(guildID snowflake.ID, channelID snowflake.ID)
	AddGuildChannel(guildID snowflake.ID, channelID snowflake.ID)
	AddGuildMember(guildID snowflake.ID, member *Member)
	RemoveGuildMember(guildID snowflake.ID, memberID snowflake.ID)
	UpdateChannelPin(channelID snowflake.ID, lastPinTimestamp Time)
	UpdateMemberAndUser(guildID, userID snowflake.ID, data json.RawMessage)
	DeleteGuild(guildID snowflake.ID)
	DeleteGuildRole(guildID snowflake.ID, roleID snowflake.ID)
	UpdateChannelLastMessageID(channelID snowflake.ID, messageID snowflake.ID)
	SetGuildEmojis(guildID Snowflake, emojis []*Emoji)
	Updates(key cacheRegistry, vs []interface{}) error
	AddGuildRole(guildID Snowflake, role *Role)
	UpdateGuildRole(guildID Snowflake, role *Role, messages json.RawMessage) bool
}

Cacher gives basic cacheLink interaction options, and won't require changes when adding more cacheLink systems

type Channel

type Channel struct {
	Lockable             `json:"-"`
	ID                   Snowflake             `json:"id"`
	Type                 uint                  `json:"type"`
	GuildID              Snowflake             `json:"guild_id,omitempty"`              // ?|
	Position             uint                  `json:"position,omitempty"`              // ?|
	PermissionOverwrites []PermissionOverwrite `json:"permission_overwrites,omitempty"` // ?|
	Name                 string                `json:"name,omitempty"`                  // ?|
	Topic                string                `json:"topic,omitempty"`                 // ?|?
	NSFW                 bool                  `json:"nsfw,omitempty"`                  // ?|
	LastMessageID        Snowflake             `json:"last_message_id,omitempty"`       // ?|?
	Bitrate              uint                  `json:"bitrate,omitempty"`               // ?|
	UserLimit            uint                  `json:"user_limit,omitempty"`            // ?|
	RateLimitPerUser     uint                  `json:"rate_limit_per_user,omitempty"`   // ?|
	Recipients           []*User               `json:"recipient,omitempty"`             // ?| , empty if not DM/GroupDM
	Icon                 *string               `json:"icon,omitempty"`                  // ?|?
	OwnerID              Snowflake             `json:"owner_id,omitempty"`              // ?|
	ApplicationID        Snowflake             `json:"application_id,omitempty"`        // ?|
	ParentID             Snowflake             `json:"parent_id,omitempty"`             // ?|?
	LastPinTimestamp     Time                  `json:"last_pin_timestamp,omitempty"`    // ?|
	// contains filtered or unexported fields
}

Channel ...

func NewChannel

func NewChannel() *Channel

NewChannel ...

func (*Channel) Compare

func (c *Channel) Compare(other *Channel) bool

Compare checks if channel A is the same as channel B

func (*Channel) CopyOverTo

func (c *Channel) CopyOverTo(other interface{}) (err error)

CopyOverTo see interface at struct.go#Copier

func (*Channel) DeepCopy

func (c *Channel) DeepCopy() (copy interface{})

DeepCopy see interface at struct.go#DeepCopier

func (*Channel) Mention

func (c *Channel) Mention() string

Mention creates a channel mention string. Mention format is according the Discord protocol.

func (*Channel) Reset

func (c *Channel) Reset()

func (*Channel) SendMsg

func (c *Channel) SendMsg(client MessageSender, message *Message) (msg *Message, err error)

SendMsg sends a message to a channel

func (*Channel) SendMsgString

func (c *Channel) SendMsgString(client MessageSender, content string) (msg *Message, err error)

SendMsgString same as SendMsg, however this only takes the message content (string) as a argument for the message

func (*Channel) String

func (c *Channel) String() string

type ChannelCreate

type ChannelCreate struct {
	Channel *Channel        `json:"channel"`
	Ctx     context.Context `json:"-"`
	ShardID uint            `json:"-"`
}

ChannelCreate new channel created

func (*ChannelCreate) UnmarshalJSON

func (obj *ChannelCreate) UnmarshalJSON(data []byte) error

UnmarshalJSON ...

type ChannelCreateHandler

type ChannelCreateHandler = func(session Session, h *ChannelCreate)

ChannelCreateHandler is triggered in ChannelCreate events

type ChannelDelete

type ChannelDelete struct {
	Channel *Channel        `json:"channel"`
	Ctx     context.Context `json:"-"`
	ShardID uint            `json:"-"`
}

ChannelDelete channel was deleted

func (*ChannelDelete) UnmarshalJSON

func (obj *ChannelDelete) UnmarshalJSON(data []byte) error

UnmarshalJSON ...

type ChannelDeleteHandler

type ChannelDeleteHandler = func(session Session, h *ChannelDelete)

ChannelDeleteHandler is triggered in ChannelDelete events

type ChannelFetcher

type ChannelFetcher interface {
	GetChannel(id Snowflake) (ret *Channel, err error)
}

ChannelFetcher holds the single method for fetching a channel from the Discord REST API

type ChannelPinsUpdate

type ChannelPinsUpdate struct {
	// ChannelID snowflake	the id of the channel
	ChannelID Snowflake `json:"channel_id"`

	// LastPinTimestamp	ISO8601 timestamp	the time at which the most recent pinned message was pinned
	LastPinTimestamp Time            `json:"last_pin_timestamp,omitempty"` // ?|
	Ctx              context.Context `json:"-"`
	ShardID          uint            `json:"-"`
}

ChannelPinsUpdate message was pinned or unpinned

type ChannelPinsUpdateHandler

type ChannelPinsUpdateHandler = func(session Session, h *ChannelPinsUpdate)

ChannelPinsUpdateHandler is triggered in ChannelPinsUpdate events

type ChannelUpdate

type ChannelUpdate struct {
	Channel *Channel        `json:"channel"`
	Ctx     context.Context `json:"-"`
	ShardID uint            `json:"-"`
}

ChannelUpdate channel was updated

func (*ChannelUpdate) UnmarshalJSON

func (obj *ChannelUpdate) UnmarshalJSON(data []byte) error

UnmarshalJSON ...

type ChannelUpdateHandler

type ChannelUpdateHandler = func(session Session, h *ChannelUpdate)

ChannelUpdateHandler is triggered in ChannelUpdate events

type Config

type Config struct {
	BotToken   string
	HTTPClient *http.Client
	Proxy      proxy.Dialer

	CancelRequestWhenRateLimited bool

	DisableCache         bool
	CacheConfig          *CacheConfig
	WSShardManagerConfig *WSShardManagerConfig
	Presence             *UpdateStatusCommand

	// your project name, name of bot, or application
	ProjectName string

	// ActivateEventChannels signifies that the developer will use channels to handle incoming events. May it be
	// in addition to handlers or not. This forces the use of a scheduler to empty the buffered channels when they
	// reach their capacity. Since it requires extra resources, others who have no interest in utilizing channels
	// should not experience any performance penalty (even though it might be unnoticeable).
	ActivateEventChannels bool

	// Logger is a dependency that must be injected to support logging.
	// disgord.DefaultLogger() can be used
	Logger Logger
	// contains filtered or unexported fields
}

Config Configuration for the DisGord client

type Copier

type Copier interface {
	CopyOverTo(other interface{}) error
}

Copier holds the CopyOverTo method which copies all it's content from one struct to another. Note that this requires a deep copy. useful when overwriting already existing content in the cacheLink to reduce GC.

type CreateChannelInvitesParams

type CreateChannelInvitesParams struct {
	MaxAge    int  `json:"max_age,omitempty"`   // duration of invite in seconds before expiry, or 0 for never. default 86400 (24 hours)
	MaxUses   int  `json:"max_uses,omitempty"`  // max number of uses or 0 for unlimited. default 0
	Temporary bool `json:"temporary,omitempty"` // whether this invite only grants temporary membership. default false
	Unique    bool `json:"unique,omitempty"`    // if true, don't try to reuse a similar invite (useful for creating many unique one time use invites). default false
}

CreateChannelInvitesParams https://discordapp.com/developers/docs/resources/channel#create-channel-invite-json-params

type CreateGroupDMParams

type CreateGroupDMParams struct {
	// AccessTokens access tokens of users that have granted your app the gdm.join scope
	AccessTokens []string `json:"access_tokens"`

	// map[userID] = nickname
	Nicks map[Snowflake]string `json:"nicks"`
}

CreateGroupDMParams required JSON params for func CreateGroupDM https://discordapp.com/developers/docs/resources/user#create-group-dm

type CreateGuildChannelParams

type CreateGuildChannelParams struct {
	Name                 string                `json:"name"` // required
	Type                 uint                  `json:"type,omitempty"`
	Topic                string                `json:"topic,omitempty"`
	Bitrate              uint                  `json:"bitrate,omitempty"`
	UserLimit            uint                  `json:"user_limit,omitempty"`
	RateLimitPerUser     uint                  `json:"rate_limit_per_user,omitempty"`
	PermissionOverwrites []PermissionOverwrite `json:"permission_overwrites,omitempty"`
	ParentID             Snowflake             `json:"parent_id,omitempty"`
	NSFW                 bool                  `json:"nsfw,omitempty"`
	Position             uint                  `json:"position"` // can not omitempty in case position is 0
}

CreateGuildChannelParams https://discordapp.com/developers/docs/resources/guild#create-guild-channel-json-params

type CreateGuildEmojiParams

type CreateGuildEmojiParams struct {
	Name  string      `json:"name"`  // required
	Image string      `json:"image"` // required
	Roles []Snowflake `json:"roles"` // optional
}

CreateGuildEmojiParams JSON params for func CreateGuildEmoji

type CreateGuildIntegrationParams

type CreateGuildIntegrationParams struct {
	Type string    `json:"type"`
	ID   Snowflake `json:"id"`
}

CreateGuildIntegrationParams ... https://discordapp.com/developers/docs/resources/guild#create-guild-integration-json-params

type CreateGuildParams

type CreateGuildParams struct {
	Name                    string                        `json:"name"` // required
	Region                  string                        `json:"region"`
	Icon                    string                        `json:"icon"`
	VerificationLvl         int                           `json:"verification_level"`
	DefaultMsgNotifications DefaultMessageNotificationLvl `json:"default_message_notifications"`
	ExplicitContentFilter   ExplicitContentFilterLvl      `json:"explicit_content_filter"`
	Roles                   []*Role                       `json:"roles"`
	Channels                []*PartialChannel             `json:"channels"`
}

CreateGuildParams ... https://discordapp.com/developers/docs/resources/guild#create-guild-json-params example partial channel object:

{
   "name": "naming-things-is-hard",
   "type": 0
}

type CreateGuildRoleParams

type CreateGuildRoleParams struct {
	Name        string `json:"name,omitempty"`
	Permissions uint64 `json:"permissions,omitempty"`
	Color       uint   `json:"color,omitempty"`
	Hoist       bool   `json:"hoist,omitempty"`
	Mentionable bool   `json:"mentionable,omitempty"`
}

CreateGuildRoleParams ... https://discordapp.com/developers/docs/resources/guild#create-guild-role-json-params

type CreateMessageFileParams

type CreateMessageFileParams struct {
	Reader   io.Reader `json:"-"` // always omit as we don't want this as part of the JSON payload
	FileName string    `json:"-"`

	// SpoilerTag lets discord know that this image should be blurred out.
	// Current Discord behaviour is that whenever a message with one or more images is marked as
	// spoiler tag, all the images in that message are blurred out. (independent of msg.Content)
	SpoilerTag bool `json:"-"`
}

CreateMessageFileParams contains the information needed to upload a file to Discord, it is part of the CreateMessageParams struct.

type CreateMessageParams

type CreateMessageParams struct {
	Content string    `json:"content"`
	Nonce   Snowflake `json:"nonce,omitempty"`
	Tts     bool      `json:"tts,omitempty"`
	Embed   *Embed    `json:"embed,omitempty"` // embedded rich content

	Files []CreateMessageFileParams `json:"-"` // Always omit as this is included in multipart, not JSON payload

	SpoilerTagContent        bool `json:"-"`
	SpoilerTagAllAttachments bool `json:"-"`
}

CreateMessageParams JSON params for CreateChannelMessage

func NewMessageByString

func NewMessageByString(content string) *CreateMessageParams

NewMessageByString creates a message object from a string/content

type CreateWebhookParams

type CreateWebhookParams struct {
	Name   string  `json:"name"`   // name of the webhook (2-32 characters)
	Avatar *string `json:"avatar"` // avatar data uri scheme, image for the default webhook avatar
}

CreateWebhookParams json params for the create webhook rest request avatar string https://discordapp.com/developers/docs/resources/user#avatar-data

func (*CreateWebhookParams) FindErrors

func (c *CreateWebhookParams) FindErrors() error

type Ctrl

type Ctrl struct {
	Runs     int
	Until    time.Time
	Duration time.Duration
}

Ctrl is a handler controller that supports lifetime and max number of execution for one or several handlers.

// register only the first 6 votes
client.On("MESSAGE_CREATE", filter.NonVotes, registerVoteHandler, &disgord.Ctrl{Runs: 6})

// Allow voting for only 10 minutes
client.On("MESSAGE_CREATE", filter.NonVotes, registerVoteHandler, &disgord.Ctrl{Duration: 10*time.Second})

// Allow voting until the month is over
client.On("MESSAGE_CREATE", filter.NonVotes, registerVoteHandler, &disgord.Ctrl{Until: time.Now().AddDate(0, 1, 0)})

func (*Ctrl) IsDead

func (c *Ctrl) IsDead() bool

func (*Ctrl) OnInsert

func (c *Ctrl) OnInsert(Session) error

func (*Ctrl) OnRemove

func (c *Ctrl) OnRemove(Session) error

func (*Ctrl) Update

func (c *Ctrl) Update()

type DeepCopier

type DeepCopier interface {
	DeepCopy() interface{}
}

DeepCopier holds the DeepCopy method which creates and returns a deep copy of any struct.

type DefaultMessageNotificationLvl

type DefaultMessageNotificationLvl uint

DefaultMessageNotificationLvl ... https://discordapp.com/developers/docs/resources/guild#guild-object-default-message-notification-level

const (
	DefaultMessageNotificationLvlAllMessages DefaultMessageNotificationLvl = iota
	DefaultMessageNotificationLvlOnlyMentions
)

different notification levels on new messages

func (*DefaultMessageNotificationLvl) AllMessages

func (dmnl *DefaultMessageNotificationLvl) AllMessages() bool

AllMessages ...

func (*DefaultMessageNotificationLvl) OnlyMentions

func (dmnl *DefaultMessageNotificationLvl) OnlyMentions() bool

OnlyMentions ...

type DeleteMessagesParams

type DeleteMessagesParams struct {
	Messages []Snowflake `json:"messages"`
	// contains filtered or unexported fields
}

DeleteMessagesParams https://discordapp.com/developers/docs/resources/channel#bulk-delete-messages-json-params

func (*DeleteMessagesParams) AddMessage

func (p *DeleteMessagesParams) AddMessage(msg *Message) (err error)

AddMessage Adds a message to be deleted

func (*DeleteMessagesParams) Valid

func (p *DeleteMessagesParams) Valid() (err error)

Valid validates the DeleteMessagesParams data

type Discriminator

type Discriminator uint16

Discriminator value

func NewDiscriminator

func NewDiscriminator(d string) (discriminator Discriminator, err error)

NewDiscriminator Discord user discriminator hashtag

func (Discriminator) MarshalJSON

func (d Discriminator) MarshalJSON() (data []byte, err error)

MarshalJSON see interface json.Marshaler

func (Discriminator) NotSet

func (d Discriminator) NotSet() bool

NotSet checks if the discriminator is not set

func (Discriminator) String

func (d Discriminator) String() (str string)

func (*Discriminator) UnmarshalJSON

func (d *Discriminator) UnmarshalJSON(data []byte) (err error)

UnmarshalJSON see interface json.Unmarshaler

type Embed

type Embed struct {
	Lockable `json:"-"`

	Title       string          `json:"title,omitempty"`       // title of embed
	Type        string          `json:"type,omitempty"`        // type of embed (always "rich" for webhook embeds)
	Description string          `json:"description,omitempty"` // description of embed
	URL         string          `json:"url,omitempty"`         // url of embed
	Timestamp   Time            `json:"timestamp,omitempty"`   // timestamp	timestamp of embed content
	Color       int             `json:"color"`                 // color code of the embed
	Footer      *EmbedFooter    `json:"footer,omitempty"`      // embed footer object	footer information
	Image       *EmbedImage     `json:"image,omitempty"`       // embed image object	image information
	Thumbnail   *EmbedThumbnail `json:"thumbnail,omitempty"`   // embed thumbnail object	thumbnail information
	Video       *EmbedVideo     `json:"video,omitempty"`       // embed video object	video information
	Provider    *EmbedProvider  `json:"provider,omitempty"`    // embed provider object	provider information
	Author      *EmbedAuthor    `json:"author,omitempty"`      // embed author object	author information
	Fields      []*EmbedField   `json:"fields,omitempty"`      //	array of embed field objects	fields information
}

Embed https://discordapp.com/developers/docs/resources/channel#embed-object

func (*Embed) CopyOverTo

func (c *Embed) CopyOverTo(other interface{}) (err error)

CopyOverTo see interface at struct.go#Copier

func (*Embed) DeepCopy

func (c *Embed) DeepCopy() (copy interface{})

DeepCopy see interface at struct.go#DeepCopier

type EmbedAuthor

type EmbedAuthor struct {
	Lockable `json:"-"`

	Name         string `json:"name,omitempty"`           // ?| , name of author
	URL          string `json:"url,omitempty"`            // ?| , url of author
	IconURL      string `json:"icon_url,omitempty"`       // ?| , url of author icon (only supports http(s) and attachments)
	ProxyIconURL string `json:"proxy_icon_url,omitempty"` // ?| , a proxied url of author icon
}

EmbedAuthor https://discordapp.com/developers/docs/resources/channel#embed-object-embed-author-structure

func (*EmbedAuthor) CopyOverTo

func (c *EmbedAuthor) CopyOverTo(other interface{}) (err error)

CopyOverTo see interface at struct.go#Copier

func (*EmbedAuthor) DeepCopy

func (c *EmbedAuthor) DeepCopy() (copy interface{})

DeepCopy see interface at struct.go#DeepCopier

type EmbedField

type EmbedField struct {
	Lockable `json:"-"`

	Name   string `json:"name"`           //  | , name of the field
	Value  string `json:"value"`          //  | , value of the field
	Inline bool   `json:"bool,omitempty"` // ?| , whether or not this field should display inline
}

EmbedField https://discordapp.com/developers/docs/resources/channel#embed-object-embed-field-structure

func (*EmbedField) CopyOverTo

func (c *EmbedField) CopyOverTo(other interface{}) (err error)

CopyOverTo see interface at struct.go#Copier

func (*EmbedField) DeepCopy

func (c *EmbedField) DeepCopy() (copy interface{})

DeepCopy see interface at struct.go#DeepCopier

type EmbedFooter

type EmbedFooter struct {
	Lockable `json:"-"`

	Text         string `json:"text"`                     //  | , url of author
	IconURL      string `json:"icon_url,omitempty"`       // ?| , url of footer icon (only supports http(s) and attachments)
	ProxyIconURL string `json:"proxy_icon_url,omitempty"` // ?| , a proxied url of footer icon
}

EmbedFooter https://discordapp.com/developers/docs/resources/channel#embed-object-embed-footer-structure

func (*EmbedFooter) CopyOverTo

func (c *EmbedFooter) CopyOverTo(other interface{}) (err error)

CopyOverTo see interface at struct.go#Copier

func (*EmbedFooter) DeepCopy

func (c *EmbedFooter) DeepCopy() (copy interface{})

DeepCopy see interface at struct.go#DeepCopier

type EmbedImage

type EmbedImage struct {
	Lockable `json:"-"`

	URL      string `json:"url,omitempty"`       // ?| , source url of image (only supports http(s) and attachments)
	ProxyURL string `json:"proxy_url,omitempty"` // ?| , a proxied url of the image
	Height   int    `json:"height,omitempty"`    // ?| , height of image
	Width    int    `json:"width,omitempty"`     // ?| , width of image
}

EmbedImage https://discordapp.com/developers/docs/resources/channel#embed-object-embed-image-structure

func (*EmbedImage) CopyOverTo

func (c *EmbedImage) CopyOverTo(other interface{}) (err error)

CopyOverTo see interface at struct.go#Copier

func (*EmbedImage) DeepCopy

func (c *EmbedImage) DeepCopy() (copy interface{})

DeepCopy see interface at struct.go#DeepCopier

type EmbedProvider

type EmbedProvider struct {
	Lockable `json:"-"`

	Name string `json:"name,omitempty"` // ?| , name of provider
	URL  string `json:"url,omitempty"`  // ?| , url of provider
}

EmbedProvider https://discordapp.com/developers/docs/resources/channel#embed-object-embed-provider-structure

func (*EmbedProvider) CopyOverTo

func (c *EmbedProvider) CopyOverTo(other interface{}) (err error)

CopyOverTo see interface at struct.go#Copier

func (*EmbedProvider) DeepCopy

func (c *EmbedProvider) DeepCopy() (copy interface{})

DeepCopy see interface at struct.go#DeepCopier

type EmbedThumbnail

type EmbedThumbnail struct {
	Lockable `json:"-"`

	URL      string `json:"url,omitempty"`       // ?| , source url of image (only supports http(s) and attachments)
	ProxyURL string `json:"proxy_url,omitempty"` // ?| , a proxied url of the image
	Height   int    `json:"height,omitempty"`    // ?| , height of image
	Width    int    `json:"width,omitempty"`     // ?| , width of image
}

EmbedThumbnail https://discordapp.com/developers/docs/resources/channel#embed-object-embed-thumbnail-structure

func (*EmbedThumbnail) CopyOverTo

func (c *EmbedThumbnail) CopyOverTo(other interface{}) (err error)

CopyOverTo see interface at struct.go#Copier

func (*EmbedThumbnail) DeepCopy

func (c *EmbedThumbnail) DeepCopy() (copy interface{})

DeepCopy see interface at struct.go#DeepCopier

type EmbedVideo

type EmbedVideo struct {
	Lockable `json:"-"`

	URL    string `json:"url,omitempty"`    // ?| , source url of video
	Height int    `json:"height,omitempty"` // ?| , height of video
	Width  int    `json:"width,omitempty"`  // ?| , width of video
}

EmbedVideo https://discordapp.com/developers/docs/resources/channel#embed-object-embed-video-structure

func (*EmbedVideo) CopyOverTo

func (c *EmbedVideo) CopyOverTo(other interface{}) (err error)

CopyOverTo see interface at struct.go#Copier

func (*EmbedVideo) DeepCopy

func (c *EmbedVideo) DeepCopy() (copy interface{})

DeepCopy see interface at struct.go#DeepCopier

type Emitter

type Emitter interface {
	Emit(command SocketCommand, dataPointer interface{}) error
}

Emitter for emitting data from A to B. Used in websocket connection

type Emoji

type Emoji struct {
	ID            Snowflake   `json:"id"`
	Name          string      `json:"name"`
	Roles         []Snowflake `json:"roles,omitempty"`
	User          *User       `json:"user,omitempty"` // the user who created the emoji
	RequireColons bool        `json:"require_colons,omitempty"`
	Managed       bool        `json:"managed,omitempty"`
	Animated      bool        `json:"animated,omitempty"`
	// contains filtered or unexported fields
}

Emoji ...

func (*Emoji) CopyOverTo

func (e *Emoji) CopyOverTo(other interface{}) (err error)

CopyOverTo see interface at struct.go#Copier

func (*Emoji) DeepCopy

func (e *Emoji) DeepCopy() (copy interface{})

DeepCopy see interface at struct.go#DeepCopier

func (*Emoji) LinkToGuild

func (e *Emoji) LinkToGuild(guildID snowflake.ID)

func (*Emoji) Mention

func (e *Emoji) Mention() string

Mention mentions an emoji. Adds the animation prefix, if animated

func (*Emoji) Reset

func (e *Emoji) Reset()

func (*Emoji) String

func (e *Emoji) String() string

type ErrRest

type ErrRest = httd.ErrREST

type ErrorCacheItemNotFound

type ErrorCacheItemNotFound struct {
	// contains filtered or unexported fields
}

ErrorCacheItemNotFound requested item was not found in cacheLink

func (*ErrorCacheItemNotFound) Error

func (e *ErrorCacheItemNotFound) Error() string

Error ...

type ErrorEmptyValue

type ErrorEmptyValue struct {
	// contains filtered or unexported fields
}

ErrorEmptyValue when a required value was set as empty

func (*ErrorEmptyValue) Error

func (e *ErrorEmptyValue) Error() string

type ErrorMissingSnowflake

type ErrorMissingSnowflake struct {
	// contains filtered or unexported fields
}

ErrorMissingSnowflake used by methods about to communicate with the Discord API. If a snowflake value is required this is used to identify that you must set the value before being able to interact with the Discord API

func (*ErrorMissingSnowflake) Error

func (e *ErrorMissingSnowflake) Error() string

type ErrorUnsupportedType

type ErrorUnsupportedType struct {
	// contains filtered or unexported fields
}

ErrorUnsupportedType used when the given param type is not supported

func (*ErrorUnsupportedType) Error

func (e *ErrorUnsupportedType) Error() string

type ErrorUsingDeactivatedCache

type ErrorUsingDeactivatedCache struct {
	// contains filtered or unexported fields
}

ErrorUsingDeactivatedCache the cacheLink system you are trying to access has been disabled in the CacheConfig

func (*ErrorUsingDeactivatedCache) Error

func (e *ErrorUsingDeactivatedCache) Error() string

type EventChannels

type EventChannels interface {
	Ready() <-chan *Ready
	Resumed() <-chan *Resumed
	ChannelCreate() <-chan *ChannelCreate
	ChannelUpdate() <-chan *ChannelUpdate
	ChannelDelete() <-chan *ChannelDelete
	ChannelPinsUpdate() <-chan *ChannelPinsUpdate
	GuildCreate() <-chan *GuildCreate
	GuildUpdate() <-chan *GuildUpdate
	GuildDelete() <-chan *GuildDelete
	GuildBanAdd() <-chan *GuildBanAdd
	GuildBanRemove() <-chan *GuildBanRemove
	GuildEmojisUpdate() <-chan *GuildEmojisUpdate
	GuildIntegrationsUpdate() <-chan *GuildIntegrationsUpdate
	GuildMemberAdd() <-chan *GuildMemberAdd
	GuildMemberRemove() <-chan *GuildMemberRemove
	GuildMemberUpdate() <-chan *GuildMemberUpdate
	GuildMembersChunk() <-chan *GuildMembersChunk
	GuildRoleUpdate() <-chan *GuildRoleUpdate
	GuildRoleCreate() <-chan *GuildRoleCreate
	GuildRoleDelete() <-chan *GuildRoleDelete
	MessageCreate() <-chan *MessageCreate
	MessageUpdate() <-chan *MessageUpdate
	MessageDelete() <-chan *MessageDelete
	MessageDeleteBulk() <-chan *MessageDeleteBulk
	MessageReactionAdd() <-chan *MessageReactionAdd
	MessageReactionRemove() <-chan *MessageReactionRemove
	MessageReactionRemoveAll() <-chan *MessageReactionRemoveAll
	PresenceUpdate() <-chan *PresenceUpdate
	PresencesReplace() <-chan *PresencesReplace
	TypingStart() <-chan *TypingStart
	UserUpdate() <-chan *UserUpdate
	VoiceStateUpdate() <-chan *VoiceStateUpdate
	VoiceServerUpdate() <-chan *VoiceServerUpdate
	WebhooksUpdate() <-chan *WebhooksUpdate
}

EventChannels all methods for retrieving event channels

type ExecuteWebhookParams

type ExecuteWebhookParams struct {
	WebhookID Snowflake `json:"-"`
	Token     string    `json:"-"`

	Content   string      `json:"content"`
	Username  string      `json:"username"`
	AvatarURL string      `json:"avatar_url"`
	TTS       bool        `json:"tts"`
	File      interface{} `json:"file"`
	Embeds    []*Embed    `json:"embeds"`
}

ExecuteWebhookParams JSON params for func ExecuteWebhook

func NewExecuteWebhookParams

func NewExecuteWebhookParams(id Snowflake, token string) (ret *ExecuteWebhookParams, err error)

NewExecuteWebhookParams creates params for func ExecuteWebhook

type ExplicitContentFilterLvl

type ExplicitContentFilterLvl uint

ExplicitContentFilterLvl ... https://discordapp.com/developers/docs/resources/guild#guild-object-explicit-content-filter-level

const (
	ExplicitContentFilterLvlDisabled ExplicitContentFilterLvl = iota
	ExplicitContentFilterLvlMembersWithoutRoles
	ExplicitContentFilterLvlAllMembers
)

Explicit content filter levels

func (*ExplicitContentFilterLvl) AllMembers

func (ecfl *ExplicitContentFilterLvl) AllMembers() bool

AllMembers if the filter applies for all members regardles of them having a role or not

func (*ExplicitContentFilterLvl) Disabled

func (ecfl *ExplicitContentFilterLvl) Disabled() bool

Disabled if the content filter is disabled

func (*ExplicitContentFilterLvl) MembersWithoutRoles

func (ecfl *ExplicitContentFilterLvl) MembersWithoutRoles() bool

MembersWithoutRoles if the filter only applies for members without a role

type Flag

type Flag uint32

const (
	DisableCache Flag = 1 << iota
	IgnoreEmptyParams
)

func (Flag) IgnoreEmptyParams

func (f Flag) IgnoreEmptyParams() bool

func (Flag) Ignorecache

func (f Flag) Ignorecache() bool

func (Flag) String

func (i Flag) String() string

type Gateway

type Gateway struct {
	URL string `json:"url"`
}

Gateway is for parsing the Gateway endpoint response

func GetGateway

func GetGateway(client httd.Getter) (gateway *Gateway, err error)

GetGateway [REST] Returns an object with a single valid WSS URL, which the client can use for Connecting. Clients should cacheLink this value and only call this endpoint to retrieve a new URL if they are unable to properly establish a connection using the cached version of the URL.

Method                  GET
Endpoint                /gateway
Rate limiter            /gateway
Discord documentation   https://discordapp.com/developers/docs/topics/gateway#get-gateway
Reviewed                2018-10-12
Comment                 This endpoint does not require authentication.

type GatewayBot

type GatewayBot struct {
	Gateway
	Shards            uint `json:"shards"`
	SessionStartLimit struct {
		Total      uint `json:"total"`
		Remaining  uint `json:"remaining"`
		ResetAfter uint `json:"reset_after"`
	} `json:"session_start_limit"`
}

GatewayBot is for parsing the Gateway Bot endpoint response

func GetGatewayBot

func GetGatewayBot(client httd.Getter) (gateway *GatewayBot, err error)

GetGatewayBot [REST] Returns an object based on the information in Get Gateway, plus additional metadata that can help during the operation of large or sharded bots. Unlike the Get Gateway, this route should not be cached for extended periods of time as the value is not guaranteed to be the same per-call, and changes as the bot joins/leaves guilds.

Method                  GET
Endpoint                /gateway/bot
Rate limiter            /gateway/bot
Discord documentation   https://discordapp.com/developers/docs/topics/gateway#get-gateway-bot
Reviewed                2018-10-12
Comment                 This endpoint requires authentication using a valid bot token.

type GetCurrentUserGuildsParams

type GetCurrentUserGuildsParams struct {
	Before Snowflake `urlparam:"before,omitempty"`
	After  Snowflake `urlparam:"after,omitempty"`
	Limit  int       `urlparam:"limit,omitempty"`
}

GetCurrentUserGuildsParams JSON params for func GetCurrentUserGuilds

func (*GetCurrentUserGuildsParams) URLQueryString

func (g *GetCurrentUserGuildsParams) URLQueryString() string

type GetInviteParams

type GetInviteParams struct {
	WithMemberCount bool `urlparam:"with_count,omitempty"`
}

func (*GetInviteParams) URLQueryString

func (g *GetInviteParams) URLQueryString() string

type GetMembersParams

type GetMembersParams struct {
	After Snowflake `urlparam:"after,omitempty"`
	Limit uint32    `urlparam:"limit,omitempty"` // 0 will fetch everyone
}

GetMembersParams if Limit is 0, every member is fetched. This does not follow the Discord API where a 0 is converted into a 1. 0 = every member. The rest is exactly the same, you should be able to do everything the Discord docs says with the addition that you can bypass a limit of 1,000.

If you specify a limit of +1,000 DisGord will run N requests until that amount is met, or until you run out of members to fetch.

type GetMessagesParams

type GetMessagesParams struct {
	Around Snowflake `urlparam:"around,omitempty"`
	Before Snowflake `urlparam:"before,omitempty"`
	After  Snowflake `urlparam:"after,omitempty"`
	Limit  int       `urlparam:"limit,omitempty"`
}

GetChannelMessagesParams https://discordapp.com/developers/docs/resources/channel#get-channel-messages-query-string-params TODO: ensure limits

func (*GetMessagesParams) URLQueryString

func (g *GetMessagesParams) URLQueryString() string

type GetReactionURLParams

type GetReactionURLParams struct {
	Before Snowflake `urlparam:"before,omitempty"` // get users before this user Snowflake
	After  Snowflake `urlparam:"after,omitempty"`  // get users after this user Snowflake
	Limit  int       `urlparam:"limit,omitempty"`  // max number of users to return (1-100)
}

GetReactionURLParams https://discordapp.com/developers/docs/resources/channel#get-reactions-query-string-params

func (*GetReactionURLParams) URLQueryString

func (g *GetReactionURLParams) URLQueryString() string

type GroupDMParticipant

type GroupDMParticipant struct {
	AccessToken string    `json:"access_token"`   // access token of a user that has granted your app the gdm.join scope
	Nickname    string    `json:"nick,omitempty"` // nickname of the user being added
	UserID      Snowflake `json:"-"`
}

GroupDMParticipant Information needed to add a recipient to a group chat

func (*GroupDMParticipant) FindErrors

func (g *GroupDMParticipant) FindErrors() error

type Guild

type Guild struct {
	Lockable `json:"-"`

	ID                          Snowflake                     `json:"id"`
	ApplicationID               Snowflake                     `json:"application_id"` //   |?
	Name                        string                        `json:"name"`
	Icon                        *string                       `json:"icon"`            //  |?, icon hash
	Splash                      *string                       `json:"splash"`          //  |?, image hash
	Owner                       bool                          `json:"owner,omitempty"` // ?|
	OwnerID                     Snowflake                     `json:"owner_id"`
	Permissions                 uint64                        `json:"permissions,omitempty"` // ?|, permission flags for connected user `/users/@me/guilds`
	Region                      string                        `json:"region"`
	AfkChannelID                Snowflake                     `json:"afk_channel_id"` // |?
	AfkTimeout                  uint                          `json:"afk_timeout"`
	EmbedEnabled                bool                          `json:"embed_enabled,omit_empty"`
	EmbedChannelID              Snowflake                     `json:"embed_channel_id,omit_empty"`
	VerificationLevel           VerificationLvl               `json:"verification_level"`
	DefaultMessageNotifications DefaultMessageNotificationLvl `json:"default_message_notifications"`
	ExplicitContentFilter       ExplicitContentFilterLvl      `json:"explicit_content_filter"`
	Roles                       []*Role                       `json:"roles"`
	Emojis                      []*Emoji                      `json:"emojis"`
	Features                    []string                      `json:"features"`
	MFALevel                    MFALvl                        `json:"mfa_level"`
	WidgetEnabled               bool                          `json:"widget_enabled,omit_empty"`    //   |
	WidgetChannelID             Snowflake                     `json:"widget_channel_id,omit_empty"` //   |?
	SystemChannelID             Snowflake                     `json:"system_channel_id,omitempty"`  //   |?

	// JoinedAt must be a pointer, as we can't hide non-nil structs
	JoinedAt    *Time           `json:"joined_at,omitempty"`    // ?*|
	Large       bool            `json:"large,omitempty"`        // ?*|
	Unavailable bool            `json:"unavailable"`            // ?*| omitempty?
	MemberCount uint            `json:"member_count,omitempty"` // ?*|
	VoiceStates []*VoiceState   `json:"voice_states,omitempty"` // ?*|
	Members     []*Member       `json:"members,omitempty"`      // ?*|
	Channels    []*Channel      `json:"channels,omitempty"`     // ?*|
	Presences   []*UserPresence `json:"presences,omitempty"`    // ?*|

}

Guild Guilds in Discord represent an isolated collection of users and channels,

and are often referred to as "servers" in the UI.

https://discordapp.com/developers/docs/resources/guild#guild-object Fields with `*` are only sent within the GUILD_CREATE event reviewed: 2018-08-25

func NewGuild

func NewGuild() *Guild

NewGuild ...

func NewGuildFromJSON

func NewGuildFromJSON(data []byte) (guild *Guild)

NewGuildFromJSON ...

func NewGuildFromUnavailable

func NewGuildFromUnavailable(gu *GuildUnavailable) *Guild

NewGuildFromUnavailable converts a unavailable guild object into a normal Guild object

func NewPartialGuild

func NewPartialGuild(ID Snowflake) (guild *Guild)

NewPartialGuild ...

func (*Guild) AddChannel

func (g *Guild) AddChannel(c *Channel) error

AddChannel adds a channel to the Guild object. Note that this method does not interact with Discord.

func (*Guild) AddMember

func (g *Guild) AddMember(member *Member) error

AddMember adds a member to the Guild object. Note that this method does not interact with Discord.

func (*Guild) AddMembers

func (g *Guild) AddMembers(members []*Member)

AddMembers adds multiple members to the Guild object. Note that this method does not interact with Discord.

func (*Guild) AddRole

func (g *Guild) AddRole(role *Role) error

AddRole adds a role to the Guild object. Note that this does not interact with Discord.

func (*Guild) Channel

func (g *Guild) Channel(id Snowflake) (*Channel, error)

Channel get a guild channel given it's ID

func (*Guild) CopyOverTo

func (g *Guild) CopyOverTo(other interface{}) (err error)

CopyOverTo see interface at struct.go#Copier

func (*Guild) DeepCopy

func (g *Guild) DeepCopy() (copy interface{})

DeepCopy see interface at struct.go#DeepCopier

func (*Guild) DeleteChannel

func (g *Guild) DeleteChannel(c *Channel) error

DeleteChannel removes a channel from the Guild object. Note that this method does not interact with Discord.

func (*Guild) DeleteChannelByID

func (g *Guild) DeleteChannelByID(ID Snowflake) error

DeleteChannelByID removes a channel from the Guild object. Note that this method does not interact with Discord.

func (*Guild) DeleteRoleByID

func (g *Guild) DeleteRoleByID(ID Snowflake)

DeleteRoleByID remove a role from the guild struct

func (*Guild) Emoji

func (g *Guild) Emoji(id Snowflake) (emoji *Emoji, err error)

Emoji get a guild emoji by it's ID

func (*Guild) GetMemberWithHighestSnowflake

func (g *Guild) GetMemberWithHighestSnowflake() *Member

GetMemberWithHighestSnowflake finds the member with the highest snowflake value.

func (*Guild) LoadAllMembers

func (g *Guild) LoadAllMembers(s Session) (err error)

LoadAllMembers fetches all the members for this guild from the Discord REST API

func (*Guild) MarshalJSON

func (g *Guild) MarshalJSON() ([]byte, error)

MarshalJSON see interface json.Marshaler TODO: fix copying of mutex lock

func (*Guild) Member

func (g *Guild) Member(id Snowflake) (*Member, error)

Member return a member by his/her userid

func (*Guild) MembersByName

func (g *Guild) MembersByName(name string) (members []*Member)

MembersByName retrieve a slice of members with same username or nickname

func (*Guild) Reset

func (g *Guild) Reset()

func (*Guild) Role

func (g *Guild) Role(id Snowflake) (role *Role, err error)

Role retrieve a role based on role id

func (*Guild) RoleByName

func (g *Guild) RoleByName(name string) ([]*Role, error)

RoleByName retrieves a slice of roles with same name

func (*Guild) String

func (g *Guild) String() string

type GuildBanAdd

type GuildBanAdd struct {
	GuildID Snowflake       `json:"guild_id"`
	User    *User           `json:"user"`
	Ctx     context.Context `json:"-"`
	ShardID uint            `json:"-"`
}

GuildBanAdd user was banned from a guild

type GuildBanAddHandler

type GuildBanAddHandler = func(session Session, h *GuildBanAdd)

GuildBanAddHandler is triggered in GuildBanAdd events

type GuildBanRemove

type GuildBanRemove struct {
	GuildID Snowflake       `json:"guild_id"`
	User    *User           `json:"user"`
	Ctx     context.Context `json:"-"`
	ShardID uint            `json:"-"`
}

GuildBanRemove user was unbanned from a guild

type GuildBanRemoveHandler

type GuildBanRemoveHandler = func(session Session, h *GuildBanRemove)

GuildBanRemoveHandler is triggered in GuildBanRemove events

type GuildCreate

type GuildCreate struct {
	Guild   *Guild          `json:"guild"`
	Ctx     context.Context `json:"-"`
	ShardID uint            `json:"-"`
}

GuildCreate This event can be sent in three different scenarios:

1. When a user is initially connecting, to lazily load and backfill information for all unavailable guilds sent in the Ready event.
2. When a Guild becomes available again to the client.
3. When the current user joins a new Guild.

func (*GuildCreate) UnmarshalJSON

func (obj *GuildCreate) UnmarshalJSON(data []byte) error

UnmarshalJSON ...

type GuildCreateHandler

type GuildCreateHandler = func(session Session, h *GuildCreate)

GuildCreateHandler is triggered in GuildCreate events

type GuildDelete

type GuildDelete struct {
	UnavailableGuild *GuildUnavailable `json:"guild_unavailable"`
	Ctx              context.Context   `json:"-"`
	ShardID          uint              `json:"-"`
}

GuildDelete guild became unavailable, or user left/was removed from a guild

func (*GuildDelete) UnmarshalJSON

func (obj *GuildDelete) UnmarshalJSON(data []byte) error

UnmarshalJSON ...

func (*GuildDelete) UserWasRemoved

func (obj *GuildDelete) UserWasRemoved() bool

UserWasRemoved ... TODO

type GuildDeleteHandler

type GuildDeleteHandler = func(session Session, h *GuildDelete)

GuildDeleteHandler is triggered in GuildDelete events

type GuildEmbed

type GuildEmbed struct {
	Lockable `json:"-"`

	Enabled   bool      `json:"enabled"`
	ChannelID Snowflake `json:"channel_id"`
}

GuildEmbed https://discordapp.com/developers/docs/resources/guild#guild-embed-object

func (*GuildEmbed) CopyOverTo

func (e *GuildEmbed) CopyOverTo(other interface{}) (err error)

CopyOverTo see interface at struct.go#Copier

func (*GuildEmbed) DeepCopy

func (e *GuildEmbed) DeepCopy() (copy interface{})

DeepCopy see interface at struct.go#DeepCopier

type GuildEmojisUpdate

type GuildEmojisUpdate struct {
	GuildID Snowflake       `json:"guild_id"`
	Emojis  []*Emoji        `json:"emojis"`
	Ctx     context.Context `json:"-"`
	ShardID uint            `json:"-"`
}

GuildEmojisUpdate guild emojis were updated

type GuildEmojisUpdateHandler

type GuildEmojisUpdateHandler = func(session Session, h *GuildEmojisUpdate)

GuildEmojisUpdateHandler is triggered in GuildEmojisUpdate events

type GuildIntegrationsUpdate

type GuildIntegrationsUpdate struct {
	GuildID Snowflake       `json:"guild_id"`
	Ctx     context.Context `json:"-"`
	ShardID uint            `json:"-"`
}

GuildIntegrationsUpdate guild integration was updated

type GuildIntegrationsUpdateHandler

type GuildIntegrationsUpdateHandler = func(session Session, h *GuildIntegrationsUpdate)

GuildIntegrationsUpdateHandler is triggered in GuildIntegrationsUpdate events

type GuildMemberAdd

type GuildMemberAdd struct {
	Member  *Member         `json:"member"`
	Ctx     context.Context `json:"-"`
	ShardID uint            `json:"-"`
}

GuildMemberAdd new user joined a guild

func (*GuildMemberAdd) UnmarshalJSON

func (obj *GuildMemberAdd) UnmarshalJSON(data []byte) error

UnmarshalJSON ...

type GuildMemberAddHandler

type GuildMemberAddHandler = func(session Session, h *GuildMemberAdd)

GuildMemberAddHandler is triggered in GuildMemberAdd events

type GuildMemberRemove

type GuildMemberRemove struct {
	GuildID Snowflake       `json:"guild_id"`
	User    *User           `json:"user"`
	Ctx     context.Context `json:"-"`
	ShardID uint            `json:"-"`
}

GuildMemberRemove user was removed from a guild

type GuildMemberRemoveHandler

type GuildMemberRemoveHandler = func(session Session, h *GuildMemberRemove)

GuildMemberRemoveHandler is triggered in GuildMemberRemove events

type GuildMemberUpdate

type GuildMemberUpdate struct {
	GuildID Snowflake       `json:"guild_id"`
	Roles   []Snowflake     `json:"roles"`
	User    *User           `json:"user"`
	Nick    string          `json:"nick"`
	Ctx     context.Context `json:"-"`
	ShardID uint            `json:"-"`
}

GuildMemberUpdate guild member was updated

type GuildMemberUpdateHandler

type GuildMemberUpdateHandler = func(session Session, h *GuildMemberUpdate)

GuildMemberUpdateHandler is triggered in GuildMemberUpdate events

type GuildMembersChunk

type GuildMembersChunk struct {
	GuildID Snowflake       `json:"guild_id"`
	Members []*Member       `json:"members"`
	Ctx     context.Context `json:"-"`
	ShardID uint            `json:"-"`
}

GuildMembersChunk response to Request Guild Members

type GuildMembersChunkHandler

type GuildMembersChunkHandler = func(session Session, h *GuildMembersChunk)

GuildMembersChunkHandler is triggered in GuildMembersChunk events

type GuildRoleCreate

type GuildRoleCreate struct {
	GuildID Snowflake       `json:"guild_id"`
	Role    *Role           `json:"role"`
	Ctx     context.Context `json:"-"`
	ShardID uint            `json:"-"`
}

GuildRoleCreate guild role was created

type GuildRoleCreateHandler

type GuildRoleCreateHandler = func(session Session, h *GuildRoleCreate)

GuildRoleCreateHandler is triggered in GuildRoleCreate events

type GuildRoleDelete

type GuildRoleDelete struct {
	GuildID Snowflake       `json:"guild_id"`
	RoleID  Snowflake       `json:"role_id"`
	Ctx     context.Context `json:"-"`
	ShardID uint            `json:"-"`
}

GuildRoleDelete a guild role was deleted

type GuildRoleDeleteHandler

type GuildRoleDeleteHandler = func(session Session, h *GuildRoleDelete)

GuildRoleDeleteHandler is triggered in GuildRoleDelete events

type GuildRoleUpdate

type GuildRoleUpdate struct {
	GuildID Snowflake       `json:"guild_id"`
	Role    *Role           `json:"role"`
	Ctx     context.Context `json:"-"`
	ShardID uint            `json:"-"`
}

GuildRoleUpdate guild role was updated

type GuildRoleUpdateHandler

type GuildRoleUpdateHandler = func(session Session, h *GuildRoleUpdate)

GuildRoleUpdateHandler is triggered in GuildRoleUpdate events

type GuildUnavailable

type GuildUnavailable struct {
	ID          Snowflake `json:"id"`
	Unavailable bool      `json:"unavailable"` // ?*|
	Lockable    `json:"-"`
}

GuildUnavailable is a partial Guild object.

func NewGuildUnavailable

func NewGuildUnavailable(ID Snowflake) *GuildUnavailable

NewGuildUnavailable ...

type GuildUpdate

type GuildUpdate struct {
	Guild   *Guild          `json:"guild"`
	Ctx     context.Context `json:"-"`
	ShardID uint            `json:"-"`
}

GuildUpdate guild was updated

func (*GuildUpdate) UnmarshalJSON

func (obj *GuildUpdate) UnmarshalJSON(data []byte) error

UnmarshalJSON ...

type GuildUpdateHandler

type GuildUpdateHandler = func(session Session, h *GuildUpdate)

GuildUpdateHandler is triggered in GuildUpdate events

type Handler

type Handler = interface{}

Handler needs to match one of the *Handler signatures

type HandlerCtrl

type HandlerCtrl interface {
	OnInsert(Session) error
	OnRemove(Session) error

	// IsDead does not need to be locked as the demultiplexer access it synchronously.
	IsDead() bool

	// Update For every time Update is called, it's internal trackers must be updated.
	// you should assume that .Update() means the handler was used.
	Update()
}

HandlerCtrl used when inserting a handler to dictate whether or not the handler(s) should still be kept in the handlers list..

type Integration

type Integration struct {
	Lockable `json:"-"`

	ID                Snowflake           `json:"id"`
	Name              string              `json:"name"`
	Type              string              `json:"type"`
	Enabled           bool                `json:"enabled"`
	Syncing           bool                `json:"syncing"`
	RoleID            Snowflake           `json:"role_id"`
	ExpireBehavior    int                 `json:"expire_behavior"`
	ExpireGracePeriod int                 `json:"expire_grace_period"`
	User              *User               `json:"user"`
	Account           *IntegrationAccount `json:"account"`
}

Integration https://discordapp.com/developers/docs/resources/guild#integration-object

func (*Integration) CopyOverTo

func (i *Integration) CopyOverTo(other interface{}) (err error)

CopyOverTo see interface at struct.go#Copier

func (*Integration) DeepCopy

func (i *Integration) DeepCopy() (copy interface{})

DeepCopy see interface at struct.go#DeepCopier

type IntegrationAccount

type IntegrationAccount struct {
	Lockable `json:"-"`

	ID   string `json:"id"`   // id of the account
	Name string `json:"name"` // name of the account
}

IntegrationAccount https://discordapp.com/developers/docs/resources/guild#integration-account-object

func (*IntegrationAccount) CopyOverTo

func (i *IntegrationAccount) CopyOverTo(other interface{}) (err error)

CopyOverTo see interface at struct.go#Copier

func (*IntegrationAccount) DeepCopy

func (i *IntegrationAccount) DeepCopy() (copy interface{})

DeepCopy see interface at struct.go#DeepCopier

type Invite

type Invite struct {
	Lockable `json:"-"`

	// Code the invite code (unique Snowflake)
	Code string `json:"code"`

	// Guild the guild this invite is for
	Guild *PartialGuild `json:"guild"`

	// Channel the channel this invite is for
	Channel *PartialChannel `json:"channel"`

	// ApproximatePresenceCount approximate count of online members
	ApproximatePresenceCount int `json:"approximate_presence_count,omitempty"`

	// ApproximatePresenceCount approximate count of total members
	ApproximateMemberCount int `json:"approximate_member_count,omitempty"`
}

Invite Represents a code that when used, adds a user to a guild. https://discordapp.com/developers/docs/resources/invite#invite-object Reviewed: 2018-06-10

func (*Invite) CopyOverTo

func (i *Invite) CopyOverTo(other interface{}) (err error)

CopyOverTo see interface at struct.go#Copier

func (*Invite) DeepCopy

func (i *Invite) DeepCopy() (copy interface{})

DeepCopy see interface at struct.go#DeepCopier

type InviteMetadata

type InviteMetadata struct {
	Lockable `json:"-"`

	// Inviter user who created the invite
	Inviter *User `json:"inviter"`

	// Uses number of times this invite has been used
	Uses int `json:"uses"`

	// MaxUses max number of times this invite can be used
	MaxUses int `json:"max_uses"`

	// MaxAge duration (in seconds) after which the invite expires
	MaxAge int `json:"max_age"`

	// Temporary whether this invite only grants temporary membership
	Temporary bool `json:"temporary"`

	// CreatedAt when this invite was created
	CreatedAt Time `json:"created_at"`

	// Revoked whether this invite is revoked
	Revoked bool `json:"revoked"`
}

InviteMetadata Object https://discordapp.com/developers/docs/resources/invite#invite-metadata-object Reviewed: 2018-06-10

func (*InviteMetadata) CopyOverTo

func (i *InviteMetadata) CopyOverTo(other interface{}) (err error)

CopyOverTo see interface at struct.go#Copier

func (*InviteMetadata) DeepCopy

func (i *InviteMetadata) DeepCopy() (copy interface{})

DeepCopy see interface at struct.go#DeepCopier

type Link

type Link interface {
	Connect() error
	Disconnect() error
}

Link is used to establish basic commands to create and destroy a link. See client.Disconnect() and client.Connect() for linking to the Discord servers

type Lockable

type Lockable struct {
	sync.RWMutex
}

type Logger

type Logger = logger.Logger

Logger super basic logging interface

type MFALvl

type MFALvl uint

MFALvl ... https://discordapp.com/developers/docs/resources/guild#guild-object-mfa-level

const (
	MFALvlNone MFALvl = iota
	MFALvlElevated
)

Different MFA levels

func (*MFALvl) Elevated

func (mfal *MFALvl) Elevated() bool

Elevated ...

func (*MFALvl) None

func (mfal *MFALvl) None() bool

None ...

type Member

type Member struct {
	Lockable `json:"-"`

	GuildID  Snowflake   `json:"guild_id,omitempty"`
	User     *User       `json:"user"`
	Nick     string      `json:"nick,omitempty"` // ?|
	Roles    []Snowflake `json:"roles"`
	JoinedAt Time        `json:"joined_at,omitempty"`

	// voice
	Deaf bool `json:"deaf"`
	Mute bool `json:"mute"`
	// contains filtered or unexported fields
}

Member https://discordapp.com/developers/docs/resources/guild#guild-member-object

func (*Member) CopyOverTo

func (m *Member) CopyOverTo(other interface{}) (err error)

CopyOverTo see interface at struct.go#Copier

func (*Member) DeepCopy

func (m *Member) DeepCopy() (copy interface{})

DeepCopy see interface at struct.go#DeepCopier

func (*Member) GetUser

func (m *Member) GetUser(session Session) (usr *User, err error)

GetUser tries to ensure that you get a user object and not a nil. The user can be nil if the guild was fetched from the cache.

func (*Member) Mention

func (m *Member) Mention() string

Mention creates a string which is parsed into a member mention on Discord GUI's

func (*Member) Reset

func (m *Member) Reset()

func (*Member) String

func (m *Member) String() string

type Message

type Message struct {
	Lockable        `json:"-"`
	ID              Snowflake          `json:"id"`
	ChannelID       Snowflake          `json:"channel_id"`
	Author          *User              `json:"author"`
	Content         string             `json:"content"`
	Timestamp       Time               `json:"timestamp"`
	EditedTimestamp Time               `json:"edited_timestamp"` // ?
	Tts             bool               `json:"tts"`
	MentionEveryone bool               `json:"mention_everyone"`
	Mentions        []*User            `json:"mentions"`
	MentionRoles    []Snowflake        `json:"mention_roles"`
	Attachments     []*Attachment      `json:"attachments"`
	Embeds          []*Embed           `json:"embeds"`
	Reactions       []*Reaction        `json:"reactions"`       // ?
	Nonce           Snowflake          `json:"nonce,omitempty"` // ?, used for validating a message was sent
	Pinned          bool               `json:"pinned"`
	WebhookID       Snowflake          `json:"webhook_id"` // ?
	Type            uint               `json:"type"`
	Activity        MessageActivity    `json:"activity"`
	Application     MessageApplication `json:"application"`

	// GuildID is not set when using a REST request. Only socket events.
	GuildID Snowflake `json:"guild_id"`

	// SpoilerTagContent is only true if the entire message text is tagged as a spoiler (aka completely wrapped in ||)
	SpoilerTagContent        bool `json:"-"`
	SpoilerTagAllAttachments bool `json:"-"`
	HasSpoilerImage          bool `json:"-"`
}

Message https://discordapp.com/developers/docs/resources/channel#message-object-message-structure

func NewMessage

func NewMessage() *Message

NewMessage ...

func (*Message) CopyOverTo

func (m *Message) CopyOverTo(other interface{}) (err error)

CopyOverTo see interface at struct.go#Copier

func (*Message) DeepCopy

func (m *Message) DeepCopy() (copy interface{})

DeepCopy see interface at struct.go#DeepCopier

func (*Message) Reply

func (m *Message) Reply(client msgSender, data ...interface{}) (*Message, error)

Reply input any type as an reply. int, string, an object, etc.

func (*Message) Reset

func (m *Message) Reset()

func (*Message) Respond

func (m *Message) Respond(client MessageSender, message *Message) (msg *Message, err error)

Respond responds to a message using a Message object. Deprecated: use Reply

func (*Message) RespondString

func (m *Message) RespondString(client MessageSender, content string) (msg *Message, err error)

RespondString sends a reply to a message in the form of a string Deprecated: use Reply

func (*Message) Send

func (m *Message) Send(client MessageSender, flags ...Flag) (msg *Message, err error)

Send sends this message to discord.

func (*Message) String

func (m *Message) String() string

type MessageActivity

type MessageActivity struct {
	Type    int    `json:"type"`
	PartyID string `json:"party_id"`
}

MessageActivity https://discordapp.com/developers/docs/resources/channel#message-object-message-activity-structure

type MessageApplication

type MessageApplication struct {
	ID          Snowflake `json:"id"`
	CoverImage  string    `json:"cover_image"`
	Description string    `json:"description"`
	Icon        string    `json:"icon"`
	Name        string    `json:"name"`
}

MessageApplication https://discordapp.com/developers/docs/resources/channel#message-object-message-application-structure

type MessageCreate

type MessageCreate struct {
	Message *Message
	Ctx     context.Context `json:"-"`
	ShardID uint            `json:"-"`
}

MessageCreate message was created

func (*MessageCreate) Reset

func (m *MessageCreate) Reset()

func (*MessageCreate) UnmarshalJSON

func (obj *MessageCreate) UnmarshalJSON(data []byte) error

UnmarshalJSON ...

type MessageCreateHandler

type MessageCreateHandler = func(session Session, h *MessageCreate)

MessageCreateHandler is triggered in MessageCreate events

type MessageDelete

type MessageDelete struct {
	MessageID Snowflake       `json:"id"`
	ChannelID Snowflake       `json:"channel_id"`
	GuildID   Snowflake       `json:"guild_id,omitempty"`
	Ctx       context.Context `json:"-"`
	ShardID   uint            `json:"-"`
}

MessageDelete message was deleted

type MessageDeleteBulk

type MessageDeleteBulk struct {
	MessageIDs []Snowflake     `json:"ids"`
	ChannelID  Snowflake       `json:"channel_id"`
	Ctx        context.Context `json:"-"`
	ShardID    uint            `json:"-"`
}

MessageDeleteBulk multiple messages were deleted at once

type MessageDeleteBulkHandler

type MessageDeleteBulkHandler = func(session Session, h *MessageDeleteBulk)

MessageDeleteBulkHandler is triggered in MessageDeleteBulk events

type MessageDeleteHandler

type MessageDeleteHandler = func(session Session, h *MessageDelete)

MessageDeleteHandler is triggered in MessageDelete events

type MessageReactionAdd

type MessageReactionAdd struct {
	UserID    Snowflake `json:"user_id"`
	ChannelID Snowflake `json:"channel_id"`
	MessageID Snowflake `json:"message_id"`
	// PartialEmoji id and name. id might be nil
	PartialEmoji *Emoji          `json:"emoji"`
	Ctx          context.Context `json:"-"`
	ShardID      uint            `json:"-"`
}

MessageReactionAdd user reacted to a message Note! do not cache emoji, unless it's updated with guildID TODO: find guildID when given userID, ChannelID and MessageID

type MessageReactionAddHandler

type MessageReactionAddHandler = func(session Session, h *MessageReactionAdd)

MessageReactionAddHandler is triggered in MessageReactionAdd events

type MessageReactionRemove

type MessageReactionRemove struct {
	UserID    Snowflake `json:"user_id"`
	ChannelID Snowflake `json:"channel_id"`
	MessageID Snowflake `json:"message_id"`
	// PartialEmoji id and name. id might be nil
	PartialEmoji *Emoji          `json:"emoji"`
	Ctx          context.Context `json:"-"`
	ShardID      uint            `json:"-"`
}

MessageReactionRemove user removed a reaction from a message Note! do not cache emoji, unless it's updated with guildID TODO: find guildID when given userID, ChannelID and MessageID

type MessageReactionRemoveAll

type MessageReactionRemoveAll struct {
	ChannelID Snowflake       `json:"channel_id"`
	MessageID Snowflake       `json:"id"`
	Ctx       context.Context `json:"-"`
	ShardID   uint            `json:"-"`
}

MessageReactionRemoveAll all reactions were explicitly removed from a message

type MessageReactionRemoveAllHandler

type MessageReactionRemoveAllHandler = func(session Session, h *MessageReactionRemoveAll)

MessageReactionRemoveAllHandler is triggered in MessageReactionRemoveAll events

type MessageReactionRemoveHandler

type MessageReactionRemoveHandler = func(session Session, h *MessageReactionRemove)

MessageReactionRemoveHandler is triggered in MessageReactionRemove events

type MessageSender

type MessageSender interface {
	CreateMessage(channelID Snowflake, params *CreateMessageParams, flags ...Flag) (ret *Message, err error)
}

MessageSender is an interface which only holds the method needed for creating a channel message

type MessageUpdate

type MessageUpdate struct {
	Message *Message
	Ctx     context.Context `json:"-"`
	ShardID uint            `json:"-"`
}

MessageUpdate message was edited

func (*MessageUpdate) UnmarshalJSON

func (obj *MessageUpdate) UnmarshalJSON(data []byte) error

UnmarshalJSON ...

type MessageUpdateHandler

type MessageUpdateHandler = func(session Session, h *MessageUpdate)

MessageUpdateHandler is triggered in MessageUpdate events

type MessageUpdater

type MessageUpdater interface {
	UpdateMessage(chanID, msgID Snowflake, flags ...Flag) *updateMessageBuilder
}

MessageUpdater is a interface which only holds the message update method

type Middleware

type Middleware = func(interface{}) interface{}

Middleware allows you to manipulate data during the "stream"

type PartialBan

type PartialBan struct {
	Reason                 string
	BannedUserID           Snowflake
	ModeratorResponsibleID Snowflake
}

PartialBan is used by audit logs

func (*PartialBan) String

func (p *PartialBan) String() string

type PartialChannel

type PartialChannel struct {
	Lockable `json:"-"`
	ID       Snowflake `json:"id"`
	Name     string    `json:"name"`
	Type     uint      `json:"type"`
}

PartialChannel ... example of partial channel // "channel": { // "id": "165176875973476352", // "name": "illuminati", // "type": 0 // }

type PartialEmoji

type PartialEmoji = Emoji

PartialEmoji see Emoji

type PartialGuild

type PartialGuild = Guild // TODO: find the actual data struct for partial guild

PartialGuild see Guild

type PartialInvite

type PartialInvite = Invite

PartialInvite ...

{
   "code": "abc"
}

type PermissionOverwrite

type PermissionOverwrite struct {
	ID    Snowflake `json:"id"`    // role or user id
	Type  string    `json:"type"`  // either `role` or `member`
	Allow int       `json:"allow"` // permission bit set
	Deny  int       `json:"deny"`  // permission bit set
}

PermissionOverwrite https://discordapp.com/developers/docs/resources/channel#overwrite-object

type Pool

type Pool interface {
	Put(x Reseter)
	Get() (x Reseter)
}

type PremiumType

type PremiumType int

const (
	// PremiumTypeNitroClassic includes app perks like animated emojis and avatars, but not games
	PremiumTypeNitroClassic PremiumType = 1

	// PremiumTypeNitro includes app perks as well as the games subscription service
	PremiumTypeNitro PremiumType = 2
)

func (PremiumType) String

func (p PremiumType) String() (t string)

type Presence

type Presence = UpdateStatusCommand

type PresenceUpdate

type PresenceUpdate struct {
	User    *User       `json:"user"`
	RoleIDs []Snowflake `json:"roles"`
	Game    *Activity   `json:"game"`
	GuildID Snowflake   `json:"guild_id"`

	// Status either "idle", "dnd", "online", or "offline"
	// TODO: constants somewhere..
	Status  string          `json:"status"`
	Ctx     context.Context `json:"-"`
	ShardID uint            `json:"-"`
}

PresenceUpdate user's presence was updated in a guild

type PresenceUpdateHandler

type PresenceUpdateHandler = func(session Session, h *PresenceUpdate)

PresenceUpdateHandler is triggered in PresenceUpdate events

type PresencesReplace

type PresencesReplace struct {
	Presnces []*PresenceUpdate `json:"presences_replace"` // TODO: verify json tag
	Ctx      context.Context   `json:"-"`
	ShardID  uint              `json:"-"`
}

PresencesReplace holds the event content

type PresencesReplaceHandler

type PresencesReplaceHandler = func(session Session, h *PresencesReplace)

PresencesReplaceHandler is triggered in PresencesReplace events

type RESTAuditLogs

type RESTAuditLogs interface {
	GetGuildAuditLogs(guildID Snowflake, flags ...Flag) *guildAuditLogsBuilder
}

AuditLogsRESTer REST interface for all audit-logs endpoints

type RESTBuilder

type RESTBuilder struct {
	// contains filtered or unexported fields
}

func (*RESTBuilder) CancelOnRatelimit

func (b *RESTBuilder) CancelOnRatelimit() *RESTBuilder

func (*RESTBuilder) IgnoreCache

func (b *RESTBuilder) IgnoreCache() *RESTBuilder

type RESTChannel

type RESTChannel interface {
	RESTMessage
	RESTReaction
	TriggerTypingIndicator(channelID Snowflake, flags ...Flag) (err error)
	GetPinnedMessages(channelID Snowflake, flags ...Flag) (ret []*Message, err error)
	PinMessage(msg *Message, flags ...Flag) (err error)
	PinMessageID(channelID, msgID Snowflake, flags ...Flag) (err error)
	UnpinMessage(msg *Message, flags ...Flag) (err error)
	UnpinMessageID(channelID, msgID Snowflake, flags ...Flag) (err error)
	GetChannel(id Snowflake, flags ...Flag) (ret *Channel, err error)
	UpdateChannel(id Snowflake, flags ...Flag) (builder *updateChannelBuilder)
	DeleteChannel(id Snowflake, flags ...Flag) (channel *Channel, err error)
	UpdateChannelPermissions(chanID, overwriteID Snowflake, params *UpdateChannelPermissionsParams, flags ...Flag) (err error)
	GetChannelInvites(id Snowflake, flags ...Flag) (ret []*Invite, err error)
	CreateChannelInvites(id Snowflake, params *CreateChannelInvitesParams, flags ...Flag) (ret *Invite, err error)
	DeleteChannelPermission(channelID, overwriteID Snowflake, flags ...Flag) (err error)
	AddDMParticipant(channelID Snowflake, participant *GroupDMParticipant, flags ...Flag) (err error)
	KickParticipant(channelID, userID Snowflake, flags ...Flag) (err error)
}

RESTChannel REST interface for all Channel endpoints

type RESTEmoji

type RESTEmoji interface {
	GetGuildEmoji(guildID, emojiID Snowflake, flags ...Flag) (*Emoji, error)
	GetGuildEmojis(id Snowflake, flags ...Flag) ([]*Emoji, error)
	CreateGuildEmoji(guildID Snowflake, params *CreateGuildEmojiParams, flags ...Flag) (*Emoji, error)
	UpdateGuildEmoji(guildID, emojiID Snowflake, flags ...Flag) *updateGuildEmojiBuilder
	DeleteGuildEmoji(guildID, emojiID Snowflake, flags ...Flag) error
}

RESTEmoji REST interface for all emoji endpoints

type RESTGuild

type RESTGuild interface {
	CreateGuild(guildName string, params *CreateGuildParams, flags ...Flag) (ret *Guild, err error)
	GetGuild(id Snowflake, flags ...Flag) (ret *Guild, err error)
	UpdateGuild(id Snowflake, flags ...Flag) *updateGuildBuilder
	DeleteGuild(id Snowflake, flags ...Flag) (err error)
	GetGuildChannels(id Snowflake, flags ...Flag) (ret []*Channel, err error)
	CreateGuildChannel(id Snowflake, name string, params *CreateGuildChannelParams, flags ...Flag) (ret *Channel, err error)
	UpdateGuildChannelPositions(id Snowflake, params []UpdateGuildChannelPositionsParams, flags ...Flag) error
	GetGuildMember(guildID, userID Snowflake, flags ...Flag) (ret *Member, err error)
	GetMembers(guildID Snowflake, params *GetMembersParams, flags ...Flag) ([]*Member, error)
	AddGuildMember(guildID, userID Snowflake, accessToken string, params *AddGuildMemberParams, flags ...Flag) (ret *Member, err error)
	UpdateGuildMember(guildID, userID Snowflake, flags ...Flag) *updateGuildMemberBuilder
	SetCurrentUserNick(id Snowflake, nick string, flags ...Flag) (newNick string, err error)
	AddGuildMemberRole(guildID, userID, roleID Snowflake, flags ...Flag) (err error)
	RemoveGuildMemberRole(guildID, userID, roleID Snowflake, flags ...Flag) (err error)
	KickMember(guildID, userID Snowflake, flags ...Flag) (err error)
	GetGuildBans(id Snowflake, flags ...Flag) (ret []*Ban, err error)
	GetGuildBan(guildID, userID Snowflake, flags ...Flag) (ret *Ban, err error)
	BanMember(guildID, userID Snowflake, params *BanMemberParams, flags ...Flag) (err error)
	UnbanMember(guildID, userID Snowflake, flags ...Flag) (err error)
	GetGuildRoles(guildID Snowflake, flags ...Flag) (ret []*Role, err error)
	CreateGuildRole(id Snowflake, params *CreateGuildRoleParams, flags ...Flag) (ret *Role, err error)
	UpdateGuildRolePositions(guildID Snowflake, params []UpdateGuildRolePositionsParams, flags ...Flag) (ret []*Role, err error)
	UpdateGuildRole(guildID, roleID Snowflake, flags ...Flag) (builder *updateGuildRoleBuilder)
	DeleteGuildRole(guildID, roleID Snowflake, flags ...Flag) (err error)
	EstimatePruneMembersCount(id Snowflake, days int, flags ...Flag) (estimate int, err error)
	PruneMembers(id Snowflake, days int, flags ...Flag) error
	GetGuildVoiceRegions(id Snowflake, flags ...Flag) (ret []*VoiceRegion, err error)
	GetGuildInvites(id Snowflake, flags ...Flag) (ret []*Invite, err error)
	GetGuildIntegrations(id Snowflake, flags ...Flag) (ret []*Integration, err error)
	CreateGuildIntegration(guildID Snowflake, params *CreateGuildIntegrationParams, flags ...Flag) (err error)
	UpdateGuildIntegration(guildID, integrationID Snowflake, params *UpdateGuildIntegrationParams, flags ...Flag) (err error)
	DeleteGuildIntegration(guildID, integrationID Snowflake, flags ...Flag) (err error)
	SyncGuildIntegration(guildID, integrationID Snowflake, flags ...Flag) (err error)
	GetGuildEmbed(guildID Snowflake, flags ...Flag) (ret *GuildEmbed, err error)
	UpdateGuildEmbed(guildID Snowflake, flags ...Flag) *updateGuildEmbedBuilder
	GetGuildVanityURL(guildID Snowflake, flags ...Flag) (ret *PartialInvite, err error)
}

RESTGuild REST interface for all guild endpoints

type RESTInvite

type RESTInvite interface {
	GetInvite(inviteCode string, params URLQueryStringer, flags ...Flag) (*Invite, error)
	DeleteInvite(inviteCode string, flags ...Flag) (deleted *Invite, err error)
}

RESTInvite REST interface for all invite endpoints

type RESTMessage

type RESTMessage interface {
	GetMessages(channelID Snowflake, params URLQueryStringer, flags ...Flag) ([]*Message, error)
	GetMessage(channelID, messageID Snowflake, flags ...Flag) (ret *Message, err error)
	CreateMessage(channelID Snowflake, params *CreateMessageParams, flags ...Flag) (ret *Message, err error)
	UpdateMessage(chanID, msgID Snowflake, flags ...Flag) *updateMessageBuilder
	DeleteMessage(channelID, msgID Snowflake, flags ...Flag) (err error)
	DeleteMessages(chanID Snowflake, params *DeleteMessagesParams, flags ...Flag) (err error)
}

type RESTMethods

type RESTMethods interface {
	RESTAuditLogs
	RESTChannel
	RESTEmoji
	RESTGuild
	RESTInvite
	RESTUser
	RESTVoice
	RESTWebhook
}

RESTer holds all the sub REST interfaces

type RESTReaction

type RESTReaction interface {
	CreateReaction(channelID, messageID Snowflake, emoji interface{}, flags ...Flag) (err error)
	DeleteOwnReaction(channelID, messageID Snowflake, emoji interface{}, flags ...Flag) (err error)
	DeleteUserReaction(channelID, messageID, userID Snowflake, emoji interface{}, flags ...Flag) (err error)
	GetReaction(channelID, messageID Snowflake, emoji interface{}, params URLQueryStringer, flags ...Flag) (ret []*User, err error)
	DeleteAllReactions(channelID, messageID Snowflake, flags ...Flag) (err error)
}

type RESTUser

type RESTUser interface {
	GetCurrentUser(flags ...Flag) (*User, error)
	GetUser(id Snowflake, flags ...Flag) (*User, error)
	UpdateCurrentUser(flags ...Flag) (builder *updateCurrentUserBuilder)
	GetCurrentUserGuilds(params *GetCurrentUserGuildsParams, flags ...Flag) (ret []*PartialGuild, err error)
	LeaveGuild(id Snowflake, flags ...Flag) (err error)
	GetUserDMs(flags ...Flag) (ret []*Channel, err error)
	CreateDM(recipientID Snowflake, flags ...Flag) (ret *Channel, err error)
	CreateGroupDM(params *CreateGroupDMParams, flags ...Flag) (ret *Channel, err error)
	GetUserConnections(flags ...Flag) (ret []*UserConnection, err error)
}

RESTUser REST interface for all user endpoints

type RESTVoice

type RESTVoice interface {
	GetVoiceRegions(flags ...Flag) ([]*VoiceRegion, error)
}

RESTVoice REST interface for all voice endpoints

type RESTWebhook

type RESTWebhook interface {
	CreateWebhook(channelID Snowflake, params *CreateWebhookParams, flags ...Flag) (ret *Webhook, err error)
	GetChannelWebhooks(channelID Snowflake, flags ...Flag) (ret []*Webhook, err error)
	GetGuildWebhooks(guildID Snowflake, flags ...Flag) (ret []*Webhook, err error)
	GetWebhook(id Snowflake, flags ...Flag) (ret *Webhook, err error)
	GetWebhookWithToken(id Snowflake, token string, flags ...Flag) (ret *Webhook, err error)
	UpdateWebhook(id Snowflake, flags ...Flag) (builder *updateWebhookBuilder)
	UpdateWebhookWithToken(id Snowflake, token string, flags ...Flag) (builder *updateWebhookBuilder)
	DeleteWebhook(webhookID Snowflake, flags ...Flag) (err error)
	DeleteWebhookWithToken(id Snowflake, token string, flags ...Flag) (err error)
	ExecuteWebhook(params *ExecuteWebhookParams, wait bool, URLSuffix string, flags ...Flag) (err error)
	ExecuteSlackWebhook(params *ExecuteWebhookParams, wait bool, flags ...Flag) (err error)
	ExecuteGitHubWebhook(params *ExecuteWebhookParams, wait bool, flags ...Flag) (err error)
}

RESTWebhook REST interface for all Webhook endpoints

type Reaction

type Reaction struct {
	Lockable `json:"-"`

	Count uint          `json:"count"`
	Me    bool          `json:"me"`
	Emoji *PartialEmoji `json:"Emoji"`
}

Reaction ... https://discordapp.com/developers/docs/resources/channel#reaction-object

func (*Reaction) CopyOverTo

func (r *Reaction) CopyOverTo(other interface{}) (err error)

CopyOverTo see interface at struct.go#Copier

func (*Reaction) DeepCopy

func (r *Reaction) DeepCopy() (copy interface{})

DeepCopy see interface at struct.go#DeepCopier

func (*Reaction) Reset

func (r *Reaction) Reset()

type Ready

type Ready struct {
	APIVersion int                 `json:"v"`
	User       *User               `json:"user"`
	Guilds     []*GuildUnavailable `json:"guilds"`

	// not really needed, as it is handled on the socket layer.
	SessionID string   `json:"session_id"`
	Trace     []string `json:"_trace"`

	sync.RWMutex `json:"-"`
	Ctx          context.Context `json:"-"`
	ShardID      uint            `json:"-"`
}

Ready contains the initial state information

type ReadyHandler

type ReadyHandler = func(session Session, h *Ready)

ReadyHandler is triggered in Ready events

type RequestGuildMembersCommand

type RequestGuildMembersCommand struct {
	// GuildID	id of the guild(s) to get offline members for
	GuildID Snowflake `json:"guild_id"`

	// Query string that username starts with, or an empty string to return all members
	Query string `json:"query"`

	// Limit maximum number of members to send or 0 to request all members matched
	Limit uint `json:"limit"`
}

RequestGuildMembersCommand payload for socket command REQUEST_GUILD_MEMBERS. See CommandRequestGuildMembers

type Reseter

type Reseter interface {
	Reset()
}

Reseter Reset() zero initialises or empties a struct instance

type Resumed

type Resumed struct {
	Trace   []string        `json:"_trace"`
	Ctx     context.Context `json:"-"`
	ShardID uint            `json:"-"`
}

Resumed response to Resume

type ResumedHandler

type ResumedHandler = func(session Session, h *Resumed)

ResumedHandler is triggered in Resumed events

type Role

type Role struct {
	Lockable `json:"-"`

	ID          Snowflake `json:"id"`
	Name        string    `json:"name"`
	Color       uint      `json:"color"`
	Hoist       bool      `json:"hoist"`
	Position    uint      `json:"position"`
	Permissions uint64    `json:"permissions"`
	Managed     bool      `json:"managed"`
	Mentionable bool      `json:"mentionable"`
	// contains filtered or unexported fields
}

Role https://discordapp.com/developers/docs/topics/permissions#role-object

func NewRole

func NewRole() *Role

NewRole ...

func (*Role) CopyOverTo

func (r *Role) CopyOverTo(other interface{}) (err error)

CopyOverTo see interface at struct.go#Copier

func (*Role) DeepCopy

func (r *Role) DeepCopy() (copy interface{})

DeepCopy see interface at struct.go#DeepCopier

func (*Role) Mention

func (r *Role) Mention() string

Mention gives a formatted version of the role such that it can be parsed by Discord clients

func (*Role) Reset

func (r *Role) Reset()

func (*Role) SetGuildID

func (r *Role) SetGuildID(id Snowflake)

SetGuildID link role to a guild before running session.SaveToDiscord(*Role)

type Session

type Session interface {
	// give information about the bot/connected user
	Myself() (*User, error)

	// Request For interacting with Discord. Sending messages, creating channels, guilds, etc.
	// To read object state such as guilds, State() should be used in stead. However some data
	// might not exist in the state. If so it should be requested. Note that this only holds http
	// CRUD operation and not the actual rest endpoints for discord (See Rest()).
	// Deprecated
	Req() httd.Requester

	// Cache reflects the latest changes received from Discord gateway.
	// Should be used instead of requesting objects.
	// Deprecated
	Cache() Cacher

	Logger() logger.Logger

	// RateLimiter the rate limiter for the discord REST API
	// Deprecated: will be unexported in next breaking release
	RateLimiter() httd.RateLimiter

	// Discord Gateway, web socket
	SocketHandler
	HeartbeatLatency() (duration time.Duration, err error)

	// Generic CRUD operations for Discord interaction
	DeleteFromDiscord(obj discordDeleter, flags ...Flag) error
	SaveToDiscord(obj discordSaver, flags ...Flag) error

	AddPermission(permission int) (updatedPermissions int)
	GetPermissions() (permissions int)
	CreateBotURL() (u string, err error)

	Pool() *pools

	// state/caching module
	// checks the cacheLink first, otherwise do a http request
	RESTMethods

	// Custom REST functions
	SendMsg(channelID Snowflake, data ...interface{}) (msg *Message, err error)

	// Status update functions
	UpdateStatus(s *UpdateStatusCommand) (err error)
	UpdateStatusString(s string) (err error)

	GetGuilds(params *GetCurrentUserGuildsParams, flags ...Flag) ([]*Guild, error)
	GetConnectedGuilds() []snowflake.ID

	// Voice handler, responsible for opening up new voice channel connections
	VoiceHandler
}

Session Is the runtime interface for DisGord. It allows you to interact with a live session (using sockets or not). Note that this interface is used after you've configured DisGord, and therefore won't allow you to configure it further.

type SimpleHandler

type SimpleHandler = func(Session)

type SimplestHandler

type SimplestHandler = func()

these "simple" handler can be used, if you don't care about the actual event data

type Snowflake

type Snowflake = snowflake.Snowflake

Snowflake twitter snowflake identification for Discord

func GetSnowflake

func GetSnowflake(v interface{}) (Snowflake, error)

GetSnowflake see snowflake.GetSnowflake

func NewSnowflake

func NewSnowflake(id uint64) Snowflake

NewSnowflake see snowflake.NewSnowflake

func ParseSnowflakeString

func ParseSnowflakeString(v string) Snowflake

ParseSnowflakeString see snowflake.ParseSnowflakeString

type SocketCommand

type SocketCommand = string

SocketCommand represents the type used to emit commands to Discord over the socket connection

const CommandRequestGuildMembers SocketCommand = cmd.RequestGuildMembers

CommandRequestGuildMembers Used to request offline members for a guild or a list of guilds. When initially connecting, the gateway will only send offline members if a guild has less than the large_threshold members (value in the Gateway Identify). If a client wishes to receive additional members, they need to explicitly request them via this operation. The server will send Guild Members Chunk events in response with up to 1000 members per chunk until all members that match the request have been sent.

const CommandUpdateStatus SocketCommand = cmd.UpdateStatus

CommandUpdateStatus Sent by the client to indicate a presence or status update.

const CommandUpdateVoiceState SocketCommand = cmd.UpdateVoiceState

CommandUpdateVoiceState Sent when a client wants to join, move, or disconnect from a voice channel.

type SocketHandler

type SocketHandler interface {
	// Link
	Disconnect() error

	// event handlers
	// inputs are in the following order: middlewares, handlers, controller
	On(event string, inputs ...interface{})
	Emitter

	// event channels
	EventChan(event string) (channel interface{}, err error)
	EventChannels() EventChannels

	// event register (which events to accept)
	// events which are not registered are discarded at socket level
	// to increase performance
	AcceptEvent(events ...string)
}

SocketHandler all socket related

type Time

type Time struct {
	time.Time
}

Time handles Discord timestamps

func (Time) MarshalJSON

func (t Time) MarshalJSON() ([]byte, error)

MarshalJSON see json.Marshaler error: https://stackoverflow.com/questions/28464711/go-strange-json-hyphen-unmarshall-error

func (Time) String

func (t Time) String() string

String converts the timestamp into a discord formatted timestamp. time.RFC3331 does not suffice

func (*Time) UnmarshalJSON

func (t *Time) UnmarshalJSON(data []byte) error

UnmarshalJSON see json.Unmarshaler

type TypingStart

type TypingStart struct {
	ChannelID     Snowflake       `json:"channel_id"`
	UserID        Snowflake       `json:"user_id"`
	TimestampUnix int             `json:"timestamp"`
	Ctx           context.Context `json:"-"`
	ShardID       uint            `json:"-"`
}

TypingStart user started typing in a channel

type TypingStartHandler

type TypingStartHandler = func(session Session, h *TypingStart)

TypingStartHandler is triggered in TypingStart events

type URLQueryStringer

type URLQueryStringer interface {
	URLQueryString() string
}

URLQueryStringer converts a struct of values to a valid URL query string

type UpdateChannelPermissionsParams

type UpdateChannelPermissionsParams struct {
	Allow int    `json:"allow"` // the bitwise value of all allowed permissions
	Deny  int    `json:"deny"`  // the bitwise value of all disallowed permissions
	Type  string `json:"type"`  // "member" for a user or "role" for a role
}

UpdateChannelPermissionsParams https://discordapp.com/developers/docs/resources/channel#edit-channel-permissions-json-params

type UpdateGuildChannelPositionsParams

type UpdateGuildChannelPositionsParams struct {
	ID       Snowflake `json:"id"`
	Position int       `json:"position"`
}

UpdateGuildChannelPositionsParams ... https://discordapp.com/developers/docs/resources/guild#modify-guild-channel-positions-json-params

type UpdateGuildIntegrationParams

type UpdateGuildIntegrationParams struct {
	ExpireBehavior    int  `json:"expire_behavior"`
	ExpireGracePeriod int  `json:"expire_grace_period"`
	EnableEmoticons   bool `json:"enable_emoticons"`
}

UpdateGuildIntegrationParams ... https://discordapp.com/developers/docs/resources/guild#modify-guild-integration-json-params TODO: currently unsure which are required/optional params

type UpdateGuildRolePositionsParams

type UpdateGuildRolePositionsParams struct {
	ID       Snowflake `json:"id"`
	Position uint      `json:"position"`
}

UpdateGuildRolePositionsParams ... https://discordapp.com/developers/docs/resources/guild#modify-guild-role-positions-json-params

func NewUpdateGuildRolePositionsParams

func NewUpdateGuildRolePositionsParams(rs []*Role) (p []UpdateGuildRolePositionsParams)

type UpdateStatusCommand

type UpdateStatusCommand struct {

	// Since unix time (in milliseconds) of when the client went idle, or null if the client is not idle
	Since *uint `json:"since"`

	// Game null, or the user's new activity
	Game *Activity `json:"game"`

	// Status the user's new status
	Status string `json:"status"`

	// AFK whether or not the client is afk
	AFK bool `json:"afk"`
	// contains filtered or unexported fields
}

UpdateStatusCommand payload for socket command UPDATE_STATUS. see CommandUpdateStatus

type UpdateVoiceStateCommand

type UpdateVoiceStateCommand struct {
	// GuildID id of the guild
	GuildID Snowflake `json:"guild_id"`

	// ChannelID id of the voice channel client wants to join
	// (null if disconnecting)
	ChannelID *Snowflake `json:"channel_id"`

	// SelfMute is the client mute
	SelfMute bool `json:"self_mute"`

	// SelfDeaf is the client deafened
	SelfDeaf bool `json:"self_deaf"`
}

UpdateVoiceStateCommand payload for socket command UPDATE_VOICE_STATE. see CommandUpdateVoiceState

type User

type User struct {
	Lockable `json:"-"`

	ID            Snowflake     `json:"id,omitempty"`
	Username      string        `json:"username,omitempty"`
	Discriminator Discriminator `json:"discriminator,omitempty"`
	Email         string        `json:"email,omitempty"`
	Avatar        *string       `json:"avatar"` // data:image/jpeg;base64,BASE64_ENCODED_JPEG_IMAGE_DATA //TODO: pointer?
	Token         string        `json:"token,omitempty"`
	Verified      bool          `json:"verified,omitempty"`
	MFAEnabled    bool          `json:"mfa_enabled,omitempty"`
	Bot           bool          `json:"bot,omitempty"`
	PremiumType   PremiumType   `json:"premium_type,omitempty"`
	// contains filtered or unexported fields
}

User the Discord user object which is reused in most other data structures.

func NewUser

func NewUser() *User

NewUser creates a new, empty user object

func (*User) CopyOverTo

func (u *User) CopyOverTo(other interface{}) (err error)

CopyOverTo see interface at struct.go#Copier

func (*User) DeepCopy

func (u *User) DeepCopy() (copy interface{})

DeepCopy see interface at struct.go#DeepCopier CopyOverTo see interface at struct.go#Copier

func (*User) Mention

func (u *User) Mention() string

Mention returns the a string that Discord clients can format into a valid Discord mention

func (*User) Reset

func (u *User) Reset()

func (*User) SendMsg

func (u *User) SendMsg(session Session, message *Message) (channel *Channel, msg *Message, err error)

SendMsg send a message to a user where you utilize a Message object instead of a string

func (*User) SendMsgString

func (u *User) SendMsgString(session Session, content string) (channel *Channel, msg *Message, err error)

SendMsgString send a message to given user where the message is in the form of a string.

func (*User) String

func (u *User) String() string

func (*User) UnmarshalJSON

func (u *User) UnmarshalJSON(data []byte) (err error)

UnmarshalJSON see interface json.Unmarshaler

func (*User) Valid

func (u *User) Valid() bool

Valid ensure the user object has enough required information to be used in Discord interactions

type UserConnection

type UserConnection struct {
	Lockable `json:"-"`

	ID           string                `json:"id"`           // id of the connection account
	Name         string                `json:"name"`         // the username of the connection account
	Type         string                `json:"type"`         // the service of the connection (twitch, youtube)
	Revoked      bool                  `json:"revoked"`      // whether the connection is revoked
	Integrations []*IntegrationAccount `json:"integrations"` // an array of partial server integrations
}

UserConnection ...

func (*UserConnection) CopyOverTo

func (c *UserConnection) CopyOverTo(other interface{}) (err error)

CopyOverTo see interface at struct.go#Copier

func (*UserConnection) DeepCopy

func (c *UserConnection) DeepCopy() (copy interface{})

DeepCopy see interface at struct.go#DeepCopier

type UserPresence

type UserPresence struct {
	Lockable `json:"-"`

	User    *User       `json:"user"`
	Roles   []Snowflake `json:"roles"`
	Game    *Activity   `json:"activity"`
	GuildID Snowflake   `json:"guild_id"`
	Nick    string      `json:"nick"`
	Status  string      `json:"status"`
}

UserPresence presence info for a guild member or friend/user in a DM

func NewUserPresence

func NewUserPresence() *UserPresence

NewUserPresence creates a new user presence instance

func (*UserPresence) CopyOverTo

func (p *UserPresence) CopyOverTo(other interface{}) (err error)

CopyOverTo see interface at struct.go#Copier

func (*UserPresence) DeepCopy

func (p *UserPresence) DeepCopy() (copy interface{})

DeepCopy see interface at struct.go#DeepCopier

func (*UserPresence) String

func (p *UserPresence) String() string

type UserUpdate

type UserUpdate struct {
	User    *User           `json:"user"`
	Ctx     context.Context `json:"-"`
	ShardID uint            `json:"-"`
}

UserUpdate properties about a user changed

type UserUpdateHandler

type UserUpdateHandler = func(session Session, h *UserUpdate)

UserUpdateHandler is triggered in UserUpdate events

type VerificationLvl

type VerificationLvl uint

VerificationLvl ... https://discordapp.com/developers/docs/resources/guild#guild-object-verification-level

const (
	VerificationLvlNone VerificationLvl = iota
	VerificationLvlLow
	VerificationLvlMedium
	VerificationLvlHigh
	VerificationLvlVeryHigh
)

the different verification levels

func (*VerificationLvl) High

func (vl *VerificationLvl) High() bool

High (╯°□°）╯︵ ┻━┻ - must be a member of the server for longer than 10 minutes

func (*VerificationLvl) Low

func (vl *VerificationLvl) Low() bool

Low must have verified email on account

func (*VerificationLvl) Medium

func (vl *VerificationLvl) Medium() bool

Medium must be registered on Discord for longer than 5 minutes

func (*VerificationLvl) None

func (vl *VerificationLvl) None() bool

None unrestricted

func (*VerificationLvl) VeryHigh

func (vl *VerificationLvl) VeryHigh() bool

VeryHigh ┻━┻ミヽ(ಠ益ಠ)ﾉ彡┻━┻ - must have a verified phone number

type VoiceConnection

type VoiceConnection interface {
	// StartSpeaking should be sent before sending voice data.
	StartSpeaking() error
	// StopSpeaking should be sent after sending voice data. If there's a break in the sent data, you should not simply
	// stop sending data. Instead you have to send five frames of silence ([]byte{0xF8, 0xFF, 0xFE}) before stopping
	// to avoid unintended Opus interpolation with subsequent transmissions.
	StopSpeaking() error

	// SendOpusFrame sends a single frame of opus data to the UDP server. Frames are sent every 20ms with 960 samples (48kHz).
	SendOpusFrame(data []byte)
	// SendDCA reads from a Reader expecting a DCA encoded stream/file and sends them as frames.
	SendDCA(r io.Reader) error

	// Close closes the websocket and UDP connection. This VoiceConnection interface will no longer be usable and will
	// panic if any other functions are called beyond this point. It is the callers responsibility to ensure there are
	// no concurrent calls to any other methods of this interface after calling Close.
	Close() error
}

VoiceConnection is the interface used to interact with active voice connections.

type VoiceHandler

type VoiceHandler interface {
	VoiceConnect(guildID, channelID Snowflake) (ret VoiceConnection, err error)
}

VoiceHandler holds all the voice connection related methods

type VoiceRegion

type VoiceRegion struct {
	Lockable `json:"-"`

	// Snowflake unique Snowflake for the region
	ID string `json:"id"`

	// Name name of the region
	Name string `json:"name"`

	// SampleHostname an example hostname for the region
	SampleHostname string `json:"sample_hostname"`

	// SamplePort an example port for the region
	SamplePort uint `json:"sample_port"`

	// VIP true if this is a vip-only server
	VIP bool `json:"vip"`

	// Optimal true for a single server that is closest to the current user's client
	Optimal bool `json:"optimal"`

	// Deprecated 	whether this is a deprecated voice region (avoid switching to these)
	Deprecated bool `json:"deprecated"`

	// Custom whether this is a custom voice region (used for events/etc)
	Custom bool `json:"custom"`
}

VoiceRegion voice region structure https://discordapp.com/developers/docs/resources/voice#voice-region

func (*VoiceRegion) CopyOverTo

func (v *VoiceRegion) CopyOverTo(other interface{}) (err error)

CopyOverTo see interface at struct.go#Copier

func (*VoiceRegion) DeepCopy

func (v *VoiceRegion) DeepCopy() (copy interface{})

DeepCopy see interface at struct.go#DeepCopier

func (*VoiceRegion) Reset

func (v *VoiceRegion) Reset()

type VoiceServerUpdate

type VoiceServerUpdate struct {
	Token    string          `json:"token"`
	GuildID  Snowflake       `json:"guild_id"`
	Endpoint string          `json:"endpoint"`
	Ctx      context.Context `json:"-"`
	ShardID  uint            `json:"-"`
}

VoiceServerUpdate guild's voice server was updated. Sent when a guild's voice server is updated. This is sent when initially connecting to voice, and when the current voice instance fails over to a new server.

type VoiceServerUpdateHandler

type VoiceServerUpdateHandler = func(session Session, h *VoiceServerUpdate)

VoiceServerUpdateHandler is triggered in VoiceServerUpdate events

type VoiceState

type VoiceState struct {
	Lockable `json:"-"`

	// GuildID the guild id this voice state is for
	GuildID Snowflake `json:"guild_id,omitempty"` // ? |

	// ChannelID the channel id this user is connected to
	ChannelID Snowflake `json:"channel_id"` // | ?

	// UserID the user id this voice state is for
	UserID Snowflake `json:"user_id"` // |

	// the guild member this voice state is for
	Member *Member `json:"member,omitempty"`

	// SessionID the session id for this voice state
	SessionID string `json:"session_id"` // |

	// Deaf whether this user is deafened by the server
	Deaf bool `json:"deaf"` // |

	// Mute whether this user is muted by the server
	Mute bool `json:"mute"` // |

	// SelfDeaf whether this user is locally deafened
	SelfDeaf bool `json:"self_deaf"` // |

	// SelfMute whether this user is locally muted
	SelfMute bool `json:"self_mute"` // |

	// Suppress whether this user is muted by the current user
	Suppress bool `json:"suppress"` // |
}

VoiceState Voice State structure https://discordapp.com/developers/docs/resources/voice#voice-state-object reviewed 2018-09-29

func (*VoiceState) CopyOverTo

func (v *VoiceState) CopyOverTo(other interface{}) (err error)

CopyOverTo see interface at struct.go#Copier

func (*VoiceState) DeepCopy

func (v *VoiceState) DeepCopy() (copy interface{})

DeepCopy see interface at struct.go#DeepCopier

func (*VoiceState) Reset

func (v *VoiceState) Reset()

type VoiceStateUpdate

type VoiceStateUpdate struct {
	*VoiceState
	Ctx     context.Context `json:"-"`
	ShardID uint            `json:"-"`
}

VoiceStateUpdate someone joined, left, or moved a voice channel

type VoiceStateUpdateHandler

type VoiceStateUpdateHandler = func(session Session, h *VoiceStateUpdate)

VoiceStateUpdateHandler is triggered in VoiceStateUpdate events

type WSShard

type WSShard struct {
	sync.RWMutex
	// contains filtered or unexported fields
}

func (*WSShard) Connect

func (s *WSShard) Connect() error

func (*WSShard) Disconnect

func (s *WSShard) Disconnect() error

func (*WSShard) Emit

func (s *WSShard) Emit(cmd SocketCommand, data interface{}) (err error)

func (*WSShard) Prepare

func (s *WSShard) Prepare(conf *Config, discordPktPool *sync.Pool, evtChan chan *websocket.Event, conRequestChan websocket.A, trackEvents *websocket.UniqueStringSlice, id uint) (err error)

type WSShardManager

type WSShardManager struct {
	sync.RWMutex

	TrackEvent *websocket.UniqueStringSlice

	// Presence represents the desired bot status at any given time
	Presence *UpdateStatusCommand
	// contains filtered or unexported fields
}

func NewShardManager

func NewShardManager(conf *Config) *WSShardManager

func (*WSShardManager) Connect

func (s *WSShardManager) Connect() (err error)

func (*WSShardManager) Disconnect

func (s *WSShardManager) Disconnect() (err error)

func (*WSShardManager) Emit

func (s *WSShardManager) Emit(cmd SocketCommand, data interface{}) (err error)

func (*WSShardManager) GetAvgHeartbeatLatency

func (s *WSShardManager) GetAvgHeartbeatLatency() (latency time.Duration, err error)

GetAvgHeartbeatLatency can be 0 if no heartbeat has been measured yet

func (*WSShardManager) GetConnectionDetails

func (s *WSShardManager) GetConnectionDetails(c httd.Getter) (url string, shardCount uint, err error)

func (*WSShardManager) GetShard

func (s *WSShardManager) GetShard(guildID snowflake.ID) (*WSShard, error)

func (*WSShardManager) Prepare

func (s *WSShardManager) Prepare(conf *Config) error

type WSShardManagerConfig

type WSShardManagerConfig struct {
	// FirstID and ShardLimit creates the shard id range for this client.
	// this can be useful if you have multiple clients and don't want to
	// duplicate the sharded connections. But have unique ones on each machine.
	//
	// ShardLimit overrides the recommended shards sent by Discord if specified.
	// If you do not understand sharding, and your bot is not considered "large" according
	// to the documentation, then just don't touch these and let DisGord configure them.
	FirstID    uint
	ShardLimit uint

	// Large bots only. If Discord did not give you a custom rate limit, do not touch this.
	ShardRateLimit float64

	// URL is fetched from the gateway before initialising a connection
	URL string
}

type Webhook

type Webhook struct {
	Lockable `json:"-"`

	ID        Snowflake `json:"id"`                 //  |
	GuildID   Snowflake `json:"guild_id,omitempty"` //  |?
	ChannelID Snowflake `json:"channel_id"`         //  |
	User      *User     `json:"user,omitempty"`     // ?|
	Name      string    `json:"name"`               //  |?
	Avatar    string    `json:"avatar"`             //  |?
	Token     string    `json:"token"`              //  |
}

Webhook Used to represent a webhook https://discordapp.com/developers/docs/resources/webhook#webhook-object

func (*Webhook) CopyOverTo

func (w *Webhook) CopyOverTo(other interface{}) (err error)

CopyOverTo see interface at struct.go#Copier

func (*Webhook) DeepCopy

func (w *Webhook) DeepCopy() (copy interface{})

DeepCopy see interface at struct.go#DeepCopier

type WebhooksUpdate

type WebhooksUpdate struct {
	GuildID   Snowflake       `json:"guild_id"`
	ChannelID Snowflake       `json:"channel_id"`
	Ctx       context.Context `json:"-"`
	ShardID   uint            `json:"-"`
}

WebhooksUpdate guild channel webhook was created, update, or deleted

type WebhooksUpdateHandler

type WebhooksUpdateHandler = func(session Session, h *WebhooksUpdate)

WebhooksUpdateHandler is triggered in WebhooksUpdate events