Skip to content
New issue

Have a question about this project? # for a free GitHub account to open an issue and contact its maintainers and the community.

#

By clicking “#”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? # to your account

Add admonition documenting lack of DM channel caching #561

Merged
merged 2 commits into from
Apr 24, 2024
Merged

Add admonition documenting lack of DM channel caching #561

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
416b91c
Add admonition documenting lack of DM channel caching
jb3 Apr 24, 2024
d17ff3d
Fix typo
jb3 Apr 24, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
10 changes: 10 additions & 0 deletions lib/nostrum/struct/channel.ex
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -35,6 +35,16 @@ defmodule Nostrum.Struct.Channel do

Once you have a guild ID, you can use the `Nostrum.Cache.GuildCache` to fetch the guild and all channels, then use the `t:Nostrum.Struct.Guild.channels/0` field to find the channel.

> #### Note on DM Channels {: .tip}
>
> The `Nostrum.Cache.ChannelGuildMapping` by design only caches a mapping of channels to their respective guilds, and the stored channel object sits within the `Nostrum.Cache.GuildCache`.
>
> Due to how Direct Message channels work (no `CHANNEL_CREATE` events, not sent in any gateway events, etc.), we make no attempt to store direct message channels within any of the
> built-in Nostrum caching adapters.
>
> If you wish to implement this functionality yourself, you will have to fetch the channel details from the API by looking at the `channel_id` field of received message objects,
> you can then store these details in your own choice of caching system (ETS, Mnesia, etc.).

### Example

```elixir
Expand Down
Loading