Browse Source

Add more examples

pull/988/head
Hsu Still 7 years ago
parent
commit
197875b7bd
10 changed files with 150 additions and 40 deletions
  1. +0
    -20
      docs/_overwrites/Commands/CommandContext.Overwrite.md
  2. +0
    -0
      docs/_overwrites/Commands/ICommandContext.Inclusion.md
  3. +27
    -0
      docs/_overwrites/Commands/ICommandContext.Overwrite.md
  4. +0
    -20
      docs/_overwrites/Common/Discord.EmbedObjectBuilder.Overwrites.md
  5. +0
    -0
      docs/_overwrites/Common/EmbedBuilder.Overwrites.md
  6. +0
    -0
      docs/_overwrites/Common/EmbedObjectBuilder.Inclusion.md
  7. +20
    -0
      docs/_overwrites/Common/EmbedObjectBuilder.Overwrites.md
  8. +26
    -0
      docs/_overwrites/Common/IEmote.Inclusion.md
  9. +77
    -0
      docs/_overwrites/Common/IEmote.Overwrites.md
  10. BIN
      docs/_overwrites/Common/images/react-example.png

+ 0
- 20
docs/_overwrites/Commands/CommandContext.Overwrite.md View File

@@ -1,20 +0,0 @@
---
uid: Discord.Commands.CommandContext
example: [*content]
---

[!include[Example Section](CommandContext.Inclusion.md)]

---
uid: Discord.Commands.SocketCommandContext
example: [*content]
---

[!include[Example Section](CommandContext.Inclusion.md)]

---
uid: Discord.Commands.ShardCommandContext
example: [*content]
---

[!include[Example Section](CommandContext.Inclusion.md)]

docs/_overwrites/Commands/CommandContext.Inclusion.md → docs/_overwrites/Commands/ICommandContext.Inclusion.md View File


+ 27
- 0
docs/_overwrites/Commands/ICommandContext.Overwrite.md View File

@@ -0,0 +1,27 @@
---
uid: Discord.Commands.ICommandContext
example: [*content]
---

[!include[Example Section](ICommandContext.Inclusion.md)]

---
uid: Discord.Commands.CommandContext
example: [*content]
---

[!include[Example Section](ICommandContext.Inclusion.md)]

---
uid: Discord.Commands.SocketCommandContext
example: [*content]
---

[!include[Example Section](ICommandContext.Inclusion.md)]

---
uid: Discord.Commands.ShardCommandContext
example: [*content]
---

[!include[Example Section](ICommandContext.Inclusion.md)]

+ 0
- 20
docs/_overwrites/Common/Discord.EmbedObjectBuilder.Overwrites.md View File

@@ -1,20 +0,0 @@
---
uid: Discord.EmbedAuthorBuilder
example: [*content]
---

[!include[Embed Object Builder Sample](Discord.EmbedObjectBuilder.Inclusion.md)]

---
uid: Discord.EmbedFooterBuilder
example: [*content]
---

[!include[Embed Object Builder Sample](Discord.EmbedObjectBuilder.Inclusion.md)]

---
uid: Discord.EmbedFieldBuilder
example: [*content]
---

[!include[Embed Object Builder Sample](Discord.EmbedObjectBuilder.Inclusion.md)]

docs/_overwrites/Common/Discord.EmbedBuilder.Overwrites.md → docs/_overwrites/Common/EmbedBuilder.Overwrites.md View File


docs/_overwrites/Common/Discord.EmbedObjectBuilder.Inclusion.md → docs/_overwrites/Common/EmbedObjectBuilder.Inclusion.md View File


+ 20
- 0
docs/_overwrites/Common/EmbedObjectBuilder.Overwrites.md View File

@@ -0,0 +1,20 @@
---
uid: Discord.EmbedAuthorBuilder
example: [*content]
---

[!include[Embed Object Builder Sample](EmbedObjectBuilder.Inclusion.md)]

---
uid: Discord.EmbedFooterBuilder
example: [*content]
---

[!include[Embed Object Builder Sample](EmbedObjectBuilder.Inclusion.md)]

---
uid: Discord.EmbedFieldBuilder
example: [*content]
---

[!include[Embed Object Builder Sample](EmbedObjectBuilder.Inclusion.md)]

+ 26
- 0
docs/_overwrites/Common/IEmote.Inclusion.md View File

@@ -0,0 +1,26 @@
The sample below sends a message and adds an @Discord.Emoji and a custom
@Discord.Emote to the message.

```cs
public async Task SendAndReactAsync(ISocketMessageChannel channel)
{
var message = await channel.SendMessageAsync("I am a message.");

// Creates a Unicode-based emoji based on the Unicode string.
// This is effctively the same as new Emoji("💕").
var heartEmoji = new Emoji("\U0001f495");
// Reacts to the message with the Emoji.
await message.AddReactionAsync(heartEmoji);

// Parses a custom emote based on the provided Discord emote format.
// Please note that this does not guarantee the existence of
// the emote.
var emote = Emote.Parse("<:thonkang:282745590985523200>");
// Reacts to the message with the Emote.
await message.AddReactionAsync(emote);
}
```

#### Result

![React Example](images/react-example.png)

+ 77
- 0
docs/_overwrites/Common/IEmote.Overwrites.md View File

@@ -0,0 +1,77 @@
---
uid: Discord.IEmote
seealso:
- linkId: Discord.Emote
- linkId: Discord.Emoji
- linkId: Discord.GuildEmote
- linkId: Discord.IUserMessage
remarks: *content
---

This interface is often used with reactions. It can represent an
unicode-based @Discord.Emoji, or a custom @Discord.Emote.

---
uid: Discord.Emote
seealso:
- linkId: Discord.IEmote
- linkId: Discord.GuildEmote
- linkId: Discord.Emoji
- linkId: Discord.IUserMessage
remarks: *content
---

> [!NOTE]
> A valid @Discord.Emote format is `<:emoteName:emoteId>`. This can be
> obtained by escaping with a `\` in front of the emote using the
> Discord chat client.

This class represents a custom emoji. This type of emoji can be
created via the @Discord.Emote.Parse* or @Discord.Emote.TryParse*
method.

---
uid: Discord.Emoji
seealso:
- linkId: Discord.Emote
- linkId: Discord.GuildEmote
- linkId: Discord.Emoji
- linkId: Discord.IUserMessage
remarks: *content
---

> [!NOTE]
> A valid @Discord.Emoji format is Unicode-based. This means only
> something like `🙃` or `\U0001f643` would work, instead of
> `:upside_down:`.

This class represents a standard Unicode-based emoji. This type of emoji
can be created by passing the unicode into its constructor.

---
uid: Discord.IEmote
example: [*content]
---

[!include[Example Section](IEmote.Inclusion.md)]

---
uid: Discord.Emoji
example: [*content]
---

[!include[Example Section](IEmote.Inclusion.md)]

---
uid: Discord.Emote
example: [*content]
---

[!include[Example Section](IEmote.Inclusion.md)]

---
uid: Discord.GuildEmote
example: [*content]
---

[!include[Example Section](IEmote.Inclusion.md)]

BIN
docs/_overwrites/Common/images/react-example.png View File

Before After
Width: 307  |  Height: 95  |  Size: 8.8 KiB

Loading…
Cancel
Save