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

[clans] Adds documentation for user clan information #6836

Draft
wants to merge 1 commit into
base: main
Choose a base branch
from

Conversation

hammerdr
Copy link
Contributor

@hammerdr hammerdr commented May 2, 2024

Users can join Guilds (called clans in documentation) and as part of that
process can adopt the guild's tag as their own. This tag is displayed in
the client next to their name.

This documents the clan tags that might come down on the user object. Clans
are a feature that is not yet released, so this is subject to change.

In addition, the full clan object is not yet documented because it is still
in development. This is just the tag that will be displayed next to the user's
name.

@hammerdr hammerdr marked this pull request as draft May 2, 2024 20:42
@hammerdr hammerdr force-pushed the clans/user-documentation branch from 6521006 to 90296f0 Compare May 2, 2024 20:43
@hammerdr hammerdr force-pushed the clans/user-documentation branch from 90296f0 to ee625de Compare May 2, 2024 20:45
@@ -43,6 +43,7 @@ There are other rules and restrictions not shared here for the sake of spam and
| premium_type? | integer | the [type of Nitro subscription](#DOCS_RESOURCES_USER/user-object-premium-types) on a user's account | identify |
| public_flags? | integer | the public [flags](#DOCS_RESOURCES_USER/user-object-user-flags) on a user's account | identify |
| avatar_decoration? | ?string | the user's [avatar decoration hash](#DOCS_REFERENCE/image-formatting) | identify |
| clan? | ?UserClan | the user's [clan data](#DOCS_RESOURCES_USER/user-object-user-clan) | identify |
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
| clan? | ?UserClan | the user's [clan data](#DOCS_RESOURCES_USER/user-object-user-clan) | identify |
| clan? | ?[user clan](#DOCS_RESOURCES_USER/user-object-user-clan) object | the user's clan data | identify |

Leaving the table formatting aside (which currently this would probably break) the corresponding object should be mentioned in the type column entry and not the description to stay consistent across the docs...

@sebm253 sebm253 mentioned this pull request May 2, 2024
1 task
@cobaltt7
Copy link

cobaltt7 commented May 3, 2024

Will there be an option for server owners to disable showing clan tags in their server? I feel like messages would get quite cluttered otherwise, especially for servers completely unrelated to gaming.

@Lulalaby
Copy link
Contributor

Lulalaby commented May 3, 2024

Agreed, that should be definitely kept in mind.
A message author can currently have

  • their name
  • a role icon
  • a app / verified app tag
  • a linked role badge

Additionally, to have a clan badge next to it would fill the whole author line probably at some point.

@colinloretz colinloretz added the not released This issue or PR is referencing a change that is not yet widely released and/or subject to change. label May 6, 2024
@MinnDevelopment
Copy link
Contributor

MinnDevelopment commented May 13, 2024

Why was this naming convention approved? This is going to cause a ton of confusion for every new developer. Now we have two naming discrepancies that are even conflicting. Server -> Guild and Guild -> Clan. I'm really disappointed in this decision and dread the amount of confusion this will cause.

@sumeetv
Copy link

sumeetv commented May 14, 2024

Hey everyone, I'm one of the engineering leads of the team testing this feature out. We understand the confusion around guilds and server terminology. This is just an experiment at this time. If we decide to roll this out more broadly after the experiment concludes, we intend to come up with a better name that will be consistent across our Developer API and how we refer to it in the product. We know this might cause some confusion while the experiment is live and intend to clean things up soon. Thanks!

@MCausc78
Copy link
Contributor

MCausc78 commented May 19, 2024

curious, but why some fields in user.clan in interaction.resolved.messages[x] and GET /users/{user.id} are null? Happens with some users

{
  "type": 0,
  "tts": false,
  "timestamp": "2024-05-19T17:21:27.550000+00:00",
  "pinned": false,
  "mentions": [],
  "mention_roles": [],
  "mention_everyone": false,
  "id": "1241802919326646283",
  "flags": 0,
  "embeds": [],
  "edited_timestamp": null,
  "content": "haven't seen you in a while",
  "components": [],
  "channel_id": "1241787241014104136",
  "author": {
    "username": "pukima",
    "public_flags": 4194432,
    "id": "751092600890458203",
    "global_name": "Pukima",
    "discriminator": "0",
    "clan": {
      "tag": null,
      "identity_guild_id": null,
      "identity_enabled": false,
      "badge": null
    },
    "avatar_decoration_data": {
      "sku_id": "1144307629225672846",
      "asset": "a_d72066b8cecbadd9fc951913ebcc384f"
    },
    "avatar": "b7e2f5461e61512674abc06c3d0264b7"
  },
  "attachments": []
}

@@ -59,6 +60,12 @@ There are other rules and restrictions not shared here for the sake of spam and
"accent_color": 16711680,
"premium_type": 1,
"public_flags": 64
"clan": {
"identity_guild_id": "1234647491267808778",
"identity_enabled": true,
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

if they've disabled identity shouldn't this whole clan object just not be serialized?

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
not released This issue or PR is referencing a change that is not yet widely released and/or subject to change.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

9 participants