aboutsummaryrefslogtreecommitdiff
path: root/definitions/structs/embed.yml
blob: ed832b87d2468fa79e769ae73455e8c98e2192f2 (plain) (blame)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
---
name: Embed
description: An embed in a message, such as for a URL or an attachment.
fields:
  - name: author
    description: Author information about the embed.
    optional: true
    type: EmbedAuthor
  - name: colour
    description: The color code of the embed.
    from: color
    optional: true
    type: u64
  - name: description
    description: The description of the embed. This is the long string of text.
    optional: true
    type: string
  - name: fields
    array: true
    description: The array of fields of the embed.
    optional: true
    type: EmbedField
  - name: image
    description: The image information of the embed.
    optional: true
    type: EmbedImage
  - name: kind
    description: >
      The type of the embed. For webhook embeds, this is always `rich`.
    from: type
    type: string
  - name: provider
    description: The provider information for the embed.
    optional: true
    type: EmbedProvider
  - name: timestamp
    description: Timestamp of embed content.
    optional: true
    type: string
  - name: url
    description: The URL of the embed.
    optional: true
    type: string
  - name: thumbnail
    description: The thumbnail provided for the embed.
    optional: true
    type: EmbedThumbnail
  - name: title
    description: The title of the embed.
    optional: true
    type: string
  - name: video
    description: The embed's video information.
    optional: true
    type: EmbedVideo