Skip to content

Commit 013de52

Browse files
advaith1advaith1
committed
Document more attachment flags and fields
1 parent e7913ea commit 013de52

File tree

1 file changed

+63
-40
lines changed

1 file changed

+63
-40
lines changed

‎docs/resources/Message.md‎

Lines changed: 63 additions & 40 deletions
Original file line numberDiff line numberDiff line change
@@ -449,21 +449,22 @@ The reaction count details object contains a breakdown of normal and super react
449449

450450
###### Embed Structure
451451

452-
| Field | Type | Description |
453-
|--------------|--------------------------------------------------------------------------------------------|------------------------------------------------------------------------------------------------------|
454-
| title? | string | title of embed |
455-
| type? | string | [type of embed](#DOCS_RESOURCES_MESSAGE/embed-object-embed-types) (always "rich" for webhook embeds) |
456-
| description? | string | description of embed |
457-
| url? | string | url of embed |
458-
| timestamp? | ISO8601 timestamp | timestamp of embed content |
459-
| color? | integer | color code of the embed |
460-
| footer? | [embed footer](#DOCS_RESOURCES_MESSAGE/embed-object-embed-footer-structure) object | footer information |
461-
| image? | [embed image](#DOCS_RESOURCES_MESSAGE/embed-object-embed-image-structure) object | image information |
462-
| thumbnail? | [embed thumbnail](#DOCS_RESOURCES_MESSAGE/embed-object-embed-thumbnail-structure) object | thumbnail information |
463-
| video? | [embed video](#DOCS_RESOURCES_MESSAGE/embed-object-embed-video-structure) object | video information |
464-
| provider? | [embed provider](#DOCS_RESOURCES_MESSAGE/embed-object-embed-provider-structure) object | provider information |
465-
| author? | [embed author](#DOCS_RESOURCES_MESSAGE/embed-object-embed-author-structure) object | author information |
466-
| fields? | array of [embed field](#DOCS_RESOURCES_MESSAGE/embed-object-embed-field-structure) objects | fields information, max of 25 |
452+
| Field | Type | Description |
453+
|--------------|--------------------------------------------------------------------------------------------|-----------------------------------------------------------------------------------------------------------------------------------|
454+
| title? | string | title of embed |
455+
| type? | string | [type of embed](#DOCS_RESOURCES_MESSAGE/embed-object-embed-types) (always "rich" for webhook embeds) |
456+
| description? | string | description of embed |
457+
| url? | string | url of embed |
458+
| timestamp? | ISO8601 timestamp | timestamp of embed content |
459+
| color? | integer | color code of the embed |
460+
| footer? | [embed footer](#DOCS_RESOURCES_MESSAGE/embed-object-embed-footer-structure) object | footer information |
461+
| image? | [embed image](#DOCS_RESOURCES_MESSAGE/embed-object-embed-image-structure) object | image information |
462+
| thumbnail? | [embed thumbnail](#DOCS_RESOURCES_MESSAGE/embed-object-embed-thumbnail-structure) object | thumbnail information |
463+
| video? | [embed video](#DOCS_RESOURCES_MESSAGE/embed-object-embed-video-structure) object | video information |
464+
| provider? | [embed provider](#DOCS_RESOURCES_MESSAGE/embed-object-embed-provider-structure) object | provider information |
465+
| author? | [embed author](#DOCS_RESOURCES_MESSAGE/embed-object-embed-author-structure) object | author information |
466+
| fields? | array of [embed field](#DOCS_RESOURCES_MESSAGE/embed-object-embed-field-structure) objects | fields information, max of 25 |
467+
| flags? | integer | [embed flags](#DOCS_RESOURCES_MESSAGE/embed-object-embed-flags) combined as a [bitfield](https://en.wikipedia.org/wiki/Bit_field) |
467468

468469
###### Embed Types
469470

@@ -477,6 +478,13 @@ The reaction count details object contains a breakdown of normal and super react
477478
| link | link embed |
478479
| poll_result | [poll result embed](#DOCS_RESOURCES_MESSAGE/embed-fields-by-embed-type-poll-result-embed-fields) |
479480

481+
###### Embed Flags
482+
483+
| Flag | Value | Description |
484+
|----------------------------|----------|-------------------------------------------------------------------------------------------------------------|
485+
| CONTAINS_EXPLICIT_MEDIA | `1 << 4` | this embed was flagged as [sensitive content](https://support.discord.com/hc/en-us/articles/18210995019671) |
486+
| IS_CONTENT_INVENTORY_ENTRY | `1 << 5` | this embed is a reply to an activity card and is no longer displayed |
487+
480488
###### Embed Thumbnail Structure
481489

482490
| Field | Type | Description |
@@ -497,12 +505,19 @@ The reaction count details object contains a breakdown of normal and super react
497505

498506
###### Embed Image Structure
499507

500-
| Field | Type | Description |
501-
|------------|---------|-------------------------------------------------------------|
502-
| url | string | source url of image (only supports http(s) and attachments) |
503-
| proxy_url? | string | a proxied url of the image |
504-
| height? | integer | height of image |
505-
| width? | integer | width of image |
508+
| Field | Type | Description |
509+
|------------|---------|-----------------------------------------------------------------------------------------------------------------------------------------------|
510+
| url | string | source url of image (only supports http(s) and attachments) |
511+
| proxy_url? | string | a proxied url of the image |
512+
| height? | integer | height of image |
513+
| width? | integer | width of image |
514+
| flags? | integer | [embed media flags](#DOCS_RESOURCES_MESSAGE/embed-object-embed-media-flags) combined as a [bitfield](https://en.wikipedia.org/wiki/Bit_field) |
515+
516+
###### Embed Media Flags
517+
518+
| Flag | Value | Description |
519+
|-------------|----------|------------------------|
520+
| IS_ANIMATED | `1 << 5` | this image is animated |
506521

507522
###### Embed Provider Structure
508523

@@ -580,30 +595,38 @@ Certain embed types are used to power special UIs. These embeds use [fields](#DO
580595
> info
581596
> For the `attachments` array in Message Create/Edit requests, only the `id` is required.
582597
583-
| Field | Type | Description |
584-
|----------------|-----------|--------------------------------------------------------------------------------------------------------------------------------------------------|
585-
| id | snowflake | attachment id |
586-
| filename | string | name of file attached |
587-
| title? | string | the title of the file |
588-
| description? | string | description for the file (max 1024 characters) |
589-
| content_type? | string | the attachment's [media type](https://en.wikipedia.org/wiki/Media_type) |
590-
| size | integer | size of file in bytes |
591-
| url | string | source url of file |
592-
| proxy_url | string | a proxied url of file |
593-
| height? | ?integer | height of file (if image) |
594-
| width? | ?integer | width of file (if image) |
595-
| ephemeral? \* | boolean | whether this attachment is ephemeral |
596-
| duration_secs? | float | the duration of the audio file (currently for voice messages) |
597-
| waveform? | string | base64 encoded bytearray representing a sampled waveform (currently for voice messages) |
598-
| flags? | integer | [attachment flags](#DOCS_RESOURCES_MESSAGE/attachment-object-attachment-flags) combined as a [bitfield](https://en.wikipedia.org/wiki/Bit_field) |
598+
| Field | Type | Description |
599+
|--------------------|----------------------------------------------------------------|--------------------------------------------------------------------------------------------------------------------------------------------------|
600+
| id | snowflake | attachment id |
601+
| filename | string | name of file attached |
602+
| title? | string | the title of the file |
603+
| description? | string | description for the file (max 1024 characters) |
604+
| content_type? | string | the attachment's [media type](https://en.wikipedia.org/wiki/Media_type) |
605+
| size | integer | size of file in bytes |
606+
| url | string | source url of file |
607+
| proxy_url | string | a proxied url of file |
608+
| height? | ?integer | height of file (if image) |
609+
| width? | ?integer | width of file (if image) |
610+
| ephemeral? \* | boolean | whether this attachment is ephemeral |
611+
| duration_secs? | float | the duration of the audio file (currently for voice messages) |
612+
| waveform? | string | base64 encoded bytearray representing a sampled waveform (currently for voice messages) |
613+
| flags? | integer | [attachment flags](#DOCS_RESOURCES_MESSAGE/attachment-object-attachment-flags) combined as a [bitfield](https://en.wikipedia.org/wiki/Bit_field) |
614+
| clip_participants? | array of [user](#DOCS_RESOURCES_USER/user-object) objects | for Clips, array of users who were in the stream |
615+
| clip_created_at? | ISO8601 timestamp | for Clips, when the clip was created |
616+
| application? | ?[application](#DOCS_RESOURCES_APPLICATION/application-object) | for Clips, the application in the stream, if recognized |
599617

600618
\* Ephemeral attachments will automatically be removed after a set period of time. Ephemeral attachments on messages are guaranteed to be available as long as the message itself exists.
601619

602620
###### Attachment Flags
603621

604-
| Flag | Value | Description |
605-
|----------|----------|-------------------------------------------------------------------|
606-
| IS_REMIX | `1 << 2` | this attachment has been edited using the remix feature on mobile |
622+
| Flag | Value | Description |
623+
|-------------------------|----------|------------------------------------------------------------------------------------------------------------------|
624+
| IS_CLIP | `1 << 0` | this attachment is a [Clip from a stream](https://support.discord.com/hc/en-us/articles/16861982215703) |
625+
| IS_THUMBNAIL | `1 << 1` | this attachment is the thumbnail of a thread in amedia channel, displayed in the grid but not on the message |
626+
| IS_REMIX | `1 << 2` | this attachment has been edited using the remix feature on mobile |
627+
| IS_SPOILER | `1 << 3` | this attachment was marked as a spoiler and is blurred until clicked |
628+
| CONTAINS_EXPLICIT_MEDIA | `1 << 4` | this attachment was flagged as [sensitive content](https://support.discord.com/hc/en-us/articles/18210995019671) |
629+
| IS_ANIMATED | `1 << 5` | this attachment is an animated image |
607630

608631
### Channel Mention Object
609632

0 commit comments

Comments
 (0)