Skip to content
New issue

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

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

Already on GitHub? Sign in to your account

Undocumented attributes #1239

Closed
mbenoukaiss opened this issue Dec 5, 2019 · 2 comments
Closed

Undocumented attributes #1239

mbenoukaiss opened this issue Dec 5, 2019 · 2 comments
Labels

Comments

@mbenoukaiss
Copy link

mbenoukaiss commented Dec 5, 2019

Missing fields
presenceupdate: nick (string) [optional, nullable]
guild: lazy (bool)
guild: system_channel_flags (integer apparently a flag, but what are the corresponding flags??) #1238
guild: discovery_splash (???) [nullable] #1238
guild: rules_channel_id (snowflake) [nullable] #1238
emoji: available (bool)
activity: id (hex string)
activity: emoji is marked as emoji but it seems to be a partial emoji, the id is not always there)
activity: session_id (string) [optional]
activity: sync_id (string) [optional]
activity: created_at (timestamp)
ready dispatch: user_settings (??? an object, i don't know the content, i always see it empty)
ready dispatch: relationships (array, of relationships i suppose, i always see it empty)
ready dispatch: presences (array, of presences i suppose)
presence update: premium_since (ISO8601 timestamp) [optional, nullable]
typing start dispatch: member (guild member)
integration: not enough information about the type, what are all the options?

modify current user: references an "avatar data" type that is not documented
get user dms: says it's no longer supported for bots but does not tell what to use now
guild modify: the region is marked as string but the description says it is a guild voice region id (which by the way, links to https://discordapp.com/developers/docs/resources/voice#voice-region instead of https://discordapp.com/developers/docs/resources/voice#voice-region-object

If get I more information about some types/fields, I can make the PR.

@z64
Copy link
Contributor

z64 commented Dec 9, 2019

  • ready.user_settings
  • ready.relationships
  • ready.presences

These should only ever be filled on user account sessions, and as such won't be documented.


  • guild.lazy

I believe this was a temporarily used field during some backend restructuring (#684 , etc.), added to GUILD_CREATE so that the user clients (desktop app, etc.) would follow the correct behavior while it was in an experimental phase. Just a guess though.

In any case, this field was rejected from documentation here: #1074 (comment)


  • "avatar data"

The only reference that search returns for "avatar data" that I can see is Create Webhook, which should be changed to image data, linking to https://discordapp.com/developers/docs/reference#image-data


  • get user dms: says it's no longer supported for bots but does not tell what to use now

There is no replacement. See #184


  • guild modify: the region is marked as string but the description says it is a guild voice region id

This is correct. Voice region IDs are strings (e.g., "us-east"). The cross link does need to be fixed, as you mentioned.


Other documented fields mentioned in this issue:

@night night added the question label Dec 9, 2019
@night
Copy link
Member

night commented Dec 9, 2019

references for webhook image data and voice regions fixed in master. rest of these are either already documented or intentionally undocumented.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

No branches or pull requests

3 participants