Skip to content

Commit

Permalink
feat: update constants and messages
Browse files Browse the repository at this point in the history
  • Loading branch information
@FedeIlLeone
FedeIlLeone committed Dec 9, 2023
1 parent 4fb84f0 commit 1243e66
Show file tree
Hide file tree
Showing 2 changed files with 13 additions and 10 deletions.
6 changes: 4 additions & 2 deletions docs/plugins/modules/common/stores/messages.mdx
View file
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ import RequiredNotice from "@site/src/components/RequiredNotice.mdx";

<RequiredNotice />

{/* [!]: `ChannelMessages`, `FetchMessagesOptions`, `LocalFetchComplete`, `MessageJumpOptions`, `UserServer` and all functions starting with an underscore aren't documented */}
{/* [!]: `ChannelMessages`, `FetchMessagesOptions`, `LocalFetchComplete`, `MessageJumpOptions`, `Poll`, `UserServer` and all functions starting with an underscore aren't documented */}

### Functions

Expand All @@ -28,7 +28,7 @@ import RequiredNotice from "@site/src/components/RequiredNotice.mdx";
| `fetchNewLocalMessages` | <Required /> `channelId`: string <br /> <Required /> `limit`: number | Promise\<void> | Fetches local messages (new version) |
| `focusMessage` | <Required /> `options`: [`FocusMessageOptions`](#FocusMessageOptions) | void | Fetches with a focused message |
| `getMessage` | <Required /> `channelId`: string <br /> <Required /> `messageId`: string | <APIReferences.Message /> | Gets the message by its id |
| `getMessages` | <Required /> `channelId`: string | `MessagesData` | Gets all messages in a channel, with a system to manage data |
| `getMessages` | <Required /> `channelId`: string | `ChannelMessages` | Gets all messages in a channel, with a system to manage data |
| `getSendMessageOptionsForReply` | <Required /> `options`: [`SendMessageForReplyOptions`](#SendMessageForReplyOptions) | [`SendMessageOptionsForReply`](#SendMessageOptionsForReply) \| \{} | Gets options for a reply |
| `jumpToMessage` | <Required /> `options`: `MessageJumpOptions` | Promise\<boolean> | Jumps to a message |
| `jumpToPresent` | <Required /> `channelId`: string <br /> <Required /> `limit`: number | void | Jumps to the most recent message |
Expand All @@ -41,6 +41,7 @@ import RequiredNotice from "@site/src/components/RequiredNotice.mdx";
| `sendGreetMessage` | <Required /> `channelId`: string <br /> <Required /> `stickerId`: string <br /> `options`: [`MessageGreetOptions`](#MessageGreetOptions) | Promise\<[`HTTPResponse`](../utilities/api#HTTPResponse)&nbsp;\|&nbsp;void> | Sends a greet message |
| `sendInvite` | <Required /> `channelId`: string <br /> <Required /> `inviteCode`: string <br /> `analyticsTriggeredFrom`: string <br /> `suggestedInvite`: [`InviteSuggestion`](#InviteSuggestion) | Promise\<[`HTTPResponse`](../utilities/api#HTTPResponse)&nbsp;\|&nbsp;void> | Sends an invite |
| `sendMessage` | <Required /> `channelId`: string <br /> <Required /> `message`: [`OutgoingMessage`](#OutgoingMessage) <br /> `promise`: boolean <br /> `options`: [`OutgoingMessageOptions`](#OutgoingMessageOptions) | Promise\<[`HTTPResponse`](../utilities/api#HTTPResponse)&nbsp;\|&nbsp;void> | Sends a message |
| `sendPollMessage` | <Required /> `channelId`: string <br /> <Required /> `poll`: `Poll` <br /> `options`: [`SendMessageOptionsForReply`](#SendMessageOptionsForReply) \| \{} | Promise\<[`HTTPResponse`](../utilities/api#HTTPResponse)&nbsp;\|&nbsp;void> | Sends a poll |
| `sendStickers` | <Required /> `channelId`: string <br /> <Required /> `stickersIds`: string[] <br /> `content`: string <br /> `options`: [`SendMessageOptionsForReply`](#SendMessageOptionsForReply) \| \{} <br /> `tts`: boolean | Promise\<[`HTTPResponse`](../utilities/api#HTTPResponse)&nbsp;\|&nbsp;void> | Sends a sticker |
| `startEditMessage` | <Required /> `channelId`: string <br /> <Required /> `messageId`: string <br /> <Required /> `content`: string | void | Starts editing a message |
| `suppressEmbeds` | <Required /> `channelId`: string <br /> <Required /> `messageId`: string | Promise\<void> | Deletes an embed from a message |
Expand Down Expand Up @@ -79,6 +80,7 @@ import RequiredNotice from "@site/src/components/RequiredNotice.mdx";
| `flags` | number | | Message flags |
| `messageReference` | [`MessageReference`](#MessageReference) | | Contains information for a reply |
| `nonce` | string | | Id of the message |
| `poll` | `Poll` | | The poll sent with the message |
| `tts` | boolean | `false` | Whether the message is a TTS message |
| `type` | number | `0` | Type of message |

Expand Down
17 changes: 9 additions & 8 deletions docs/plugins/modules/common/utilities/constants.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -45,11 +45,12 @@ ColorGenerator.colors.BACKGROUND_PRIMARY.resolve({ theme: Themes.DARK, saturatio

Props:

| Name | Type | Description |
| ------------------ | -------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------ |
| `colors` | Record\<string,&nbsp;`Color`> | Contains all CSS variables with the corresponding function to generate a color based on a given saturation |
| `radii` | Record\<string,&nbsp;number> | Contains border-radius values |
| `shadows` | Record\<string,&nbsp;`ShadowColor`> | Contains all CSS variables for shadows with the corresponding function to get specific information |
| `spacing` | Record\<string,&nbsp;string> | Contains spacing values |
| `themes` | Record\<string,&nbsp;string> | Client themes |
| `unsafe_rawColors` | Record\<string,&nbsp;`UnsafeRawColor`> | Contains all CSS variables for specific colors with the corresponding function to generate a color based on a given saturation |
| Name | Type | Description |
| ------------------ | -------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------ |
| `colors` | Record\<string,&nbsp;`Color`> | Contains all CSS variables with the corresponding function to generate a color based on a given saturation |
| `modules` | Record\<string,&nbsp;Record\<string,&nbsp;number>> | Contains modules used in the CSS, such as size variables |
| `radii` | Record\<string,&nbsp;number> | Contains border-radius values |
| `shadows` | Record\<string,&nbsp;`ShadowColor`> | Contains all CSS variables for shadows with the corresponding function to get specific information |
| `spacing` | Record\<string,&nbsp;string> | Contains spacing values |
| `themes` | Record\<string,&nbsp;string> | Client themes |
| `unsafe_rawColors` | Record\<string,&nbsp;`UnsafeRawColor`> | Contains all CSS variables for specific colors with the corresponding function to generate a color based on a given saturation |

0 comments on commit 1243e66

Please sign in to comment.