Warning! caching is not yet implemented and may change behaviour in the future
In this article it is detailed how to fetch information about a user. You do also use the REST API to edit information, send messages, etc.
Imagine that you want to fetch information about a Discord user. Since Disgord supports every REST endpoint found in the default Discord API, you do not have to worry about handling the response format, compression, rate limits, etc. yourself. In stead you are given two solutions to solve query the Discord API; using the REST functions in: A: the barebone REST functions found in disgord pkg (not recommended, unless you want to bypass the Session interface) B: the Session interface (recommended)
The REST functions are located in the disgord package and are blocking operations. It's important to note that these functions do not update the state (or the cache). They do however implement rate limiting (which you should not bypass). A reason to use these is when you want to force a request, as the functionality in the Session interface should always checks the cache first to avoid asking for information that you already have locally. See Query Discord using the REST functions.
The Session interface is the recommended way to query objects from the Discord API. It supports caching, and some other implementations might even handle concurrency by returning a channel (in the future, right now it's not complete and have a low priority). By returning a channel you can decide the query to be either blocking or handle the response later (see Query Discord using the session interface).
Note: It is assumed you understand how to create a session. You do not need to use Session.Connect and Session.Disconnect for most REST queries.
// The user id of this repository's owner
userID := disgord.NewSnowflake(228846961774559232)
// send a GET request to Discord to retrieve user information.
// the response is not stored in cache.
user, err := disgord.GetUser(session.Req(), userID)
if err != nil {
...
}
// Even though you just sent this request, you force a new request without caring that you already have this information.
user2, err := disgord.GetUser(session.Req(), userID)
if err != nil {
...
}Note: It is assumed you understand how to create a session. You do not need to use Session.Connect and Session.Disconnect for most REST queries.
Note#2: This is currently not a part of the Session interface, but will be added in a later version of Disgord.
Channel methods - these are however commented out as of now.
// The user id of this repository's owner
userID := disgord.NewSnowflake(228846961774559232)
user := <- session.UserChan(userID) // sends a request to discord
user2 := <- session.UserChan(userID) // discovers that the information is already in the cache, and does not query Discord
userChan := session.UserChan(userID) // you can ofc just get the channel and listen for it later on
// do some stuff here
user3 := <-userChan