Oceanic

https://docs.oceanic.ws/v1.12.0
Admin
Oceanic is a JavaScript library designed for interacting with the Discord API, enabling developers...
Tokens:5,303,487
Snippets:20,308
Trust Score:5
Update:1 year ago
Show doc for...
Tokens:
Raw
### Typing Start API

Source: https://docs.oceanic.ws/v1.12.0/classes/Compression

Indicates that the current user has started typing in a channel.

```APIDOC
TYPING_START
  Description: Sends a typing indicator.
  Endpoint: POST /channels/{channel.id}/typing
  Parameters:
    channel.id: The ID of the channel.
  Returns: None.
  Example: TYPING_START(channel_id)
```

--------------------------------

### Session Start Limit Types

Source: https://docs.oceanic.ws/v1.12.0/enums/Constants.OAuthScopes

Raw data structure for session start limits.

```APIDOC
RawSessionStartLimit:
  total: int
  remaining: int
  reset_after: int
  adjust_after: int
```

--------------------------------

### Get Event Listeners Example

Source: https://docs.oceanic.ws/v1.12.0/classes/TypedEmitter

Illustrates retrieving listeners for a specific event from both Node.js EventEmitter and DOM EventTarget instances.

```javascript
import { getEventListeners, EventEmitter } from'node:events';

{
  const ee = new EventEmitter();
  const listener = () => console.log('Events are fun');
  ee.on('foo', listener);
  getEventListeners(ee, 'foo'); // [listener]
}
{
  const et = new EventTarget();
  const listener = () => console.log('Events are fun');
  et.addEventListener('foo', listener);
  getEventListeners(et, 'foo'); // [listener]
}
```

--------------------------------

### Guild Onboarding and Welcome Screen

Source: https://docs.oceanic.ws/v1.12.0/classes/SequentialBucket

Options for configuring guild onboarding flows and the welcome screen.

```APIDOC
EditOnboardingOptions:
  - Options for editing the guild's onboarding configuration.
  - Includes prompts, default channels, and descriptions.

EditWelcomeScreenOptions:
  - Options for editing the guild's welcome screen.
  - Allows setting welcome channels and a description.
```

--------------------------------

### STAGE_INSTANCE_UPDATE API Event

Source: https://docs.oceanic.ws/v1.12.0/classes/Member

Triggered when an existing stage instance is updated, for example, if its topic or start time changes. It provides the latest details of the stage instance.

```APIDOC
STAGE_INSTANCE_UPDATE
  Description: Fired when an existing stage instance is updated (e.g., topic change).
  URL: https://docs.oceanic.ws/v1.12.0/functions/STAGE_INSTANCE_UPDATE.html
```

--------------------------------

### Guild Onboarding and Welcome Screen

Source: https://docs.oceanic.ws/v1.12.0/classes/UncachedError

Options for configuring guild onboarding flows and the welcome screen.

```APIDOC
EditOnboardingOptions:
  - Options for editing the guild's onboarding configuration.
  - Includes prompts, default channels, and descriptions.

EditWelcomeScreenOptions:
  - Options for editing the guild's welcome screen.
  - Allows setting welcome channels and a description.
```

--------------------------------

### PartialApplication Instance Methods

Source: https://docs.oceanic.ws/v1.12.0/classes/PartialApplication

Documentation for instance methods of the PartialApplication class, including generating an icon URL, converting to JSON, and string representation.

```APIDOC
PartialApplication Instance Methods:
  iconURL(format?: "jpg" | "jpeg" | "png" | "webp" | "gif", size?: number): null | string
    The url of this application's icon.
    Parameters:
      format: The format the url should be.
      size: The dimensions of the image.
    Returns: null | string
    Defined in lib/structures/PartialApplication.ts:55

  toJSON(): JSONPartialApplication
    Overrides Base.toJSON
    Returns: JSONPartialApplication
    Defined in lib/structures/PartialApplication.ts:59

  toString(): string
    Inherited from Base.toString
    Returns: string
    Defined in lib/structures/Base.ts:64
```

--------------------------------

### STAGE_INSTANCE_UPDATE API Event

Source: https://docs.oceanic.ws/v1.12.0/classes/MediaChannel

Triggered when an existing stage instance is updated, for example, if its topic or start time changes. It provides the latest details of the stage instance.

```APIDOC
STAGE_INSTANCE_UPDATE
  Description: Fired when an existing stage instance is updated (e.g., topic change).
  URL: https://docs.oceanic.ws/v1.12.0/functions/STAGE_INSTANCE_UPDATE.html
```

--------------------------------

### STAGE_INSTANCE_UPDATE API Event

Source: https://docs.oceanic.ws/v1.12.0/classes/ForumChannel

Triggered when an existing stage instance is updated, for example, if its topic or start time changes. It provides the latest details of the stage instance.

```APIDOC
STAGE_INSTANCE_UPDATE
  Description: Fired when an existing stage instance is updated (e.g., topic change).
  URL: https://docs.oceanic.ws/v1.12.0/functions/STAGE_INSTANCE_UPDATE.html
```

--------------------------------

### Guild Onboarding and Welcome Screen

Source: https://docs.oceanic.ws/v1.12.0/classes/Bucket

Options for configuring guild onboarding flows and the welcome screen.

```APIDOC
EditOnboardingOptions:
  - Options for editing the guild's onboarding configuration.
  - Includes prompts, default channels, and descriptions.

EditWelcomeScreenOptions:
  - Options for editing the guild's welcome screen.
  - Allows setting welcome channels and a description.
```

--------------------------------

### APIDOC: TYPING_START Function

Source: https://docs.oceanic.ws/v1.12.0/classes/ClientApplication

Documentation for the TYPING_START function. This function indicates that a user has started typing. Specific details on parameters, return values, and usage are available at the linked documentation.

```APIDOC
TYPING_START
  Description: User starts typing.
  Details: Refer to https://docs.oceanic.ws/v1.12.0/functions/TYPING_START.html
```

--------------------------------

### Typing Start API

Source: https://docs.oceanic.ws/v1.12.0/classes/REST_Channels

Indicates that the current user has started typing in a channel.

```APIDOC
TYPING_START
  Description: Sends a typing indicator.
  Endpoint: POST /channels/{channel.id}/typing
  Parameters:
    channel.id: The ID of the channel.
  Returns: None.
  Example: TYPING_START(channel_id)
```

--------------------------------

### User and Typing Indicators

Source: https://docs.oceanic.ws/v1.12.0/enums/Constants.OAuthScopes

API references for user updates and starting the typing indicator.

```APIDOC
TYPING_START:
  Description: Indicates that a user has started typing in a channel.
  Parameters: None specified in the provided links.
  Returns: None specified in the provided links.

USER_UPDATE:
  Description: Updates a user's profile information.
  Parameters: None specified in the provided links.
  Returns: None specified in the provided links.
```

--------------------------------

### Guild Onboarding and Welcome Screen

Source: https://docs.oceanic.ws/v1.12.0/classes/Base

Options for configuring guild onboarding flows and the welcome screen.

```APIDOC
EditOnboardingOptions:
  - Options for editing the guild's onboarding configuration.
  - Includes prompts, default channels, and descriptions.

EditWelcomeScreenOptions:
  - Options for editing the guild's welcome screen.
  - Allows setting welcome channels and a description.
```

--------------------------------

### Typing Start API

Source: https://docs.oceanic.ws/v1.12.0/enums/Constants.InviteFlags

Indicates that the current user has started typing in a channel.

```APIDOC
TYPING_START
  Description: Sends a typing indicator.
  Endpoint: POST /channels/{channel.id}/typing
  Parameters:
    channel.id: The ID of the channel.
  Returns: None.
  Example: TYPING_START(channel_id)
```

--------------------------------

### Guild Onboarding and Welcome Screen

Source: https://docs.oceanic.ws/v1.12.0/classes/REST_Miscellaneous

Options for configuring guild onboarding flows and the welcome screen.

```APIDOC
EditOnboardingOptions:
  - Options for editing the guild's onboarding configuration.
  - Includes prompts, default channels, and descriptions.

EditWelcomeScreenOptions:
  - Options for editing the guild's welcome screen.
  - Allows setting welcome channels and a description.
```

--------------------------------

### Typing Start API

Source: https://docs.oceanic.ws/v1.12.0/enums/Constants.EntitlementOwnerTypes

Indicates that the current user has started typing in a channel.

```APIDOC
TYPING_START
  Description: Sends a typing indicator.
  Endpoint: POST /channels/{channel.id}/typing
  Parameters:
    channel.id: The ID of the channel.
  Returns: None.
  Example: TYPING_START(channel_id)
```

--------------------------------

### Guild Onboarding and Welcome Screen

Source: https://docs.oceanic.ws/v1.12.0/classes/Permission

Options for configuring guild onboarding flows and the welcome screen.

```APIDOC
EditOnboardingOptions:
  - Options for editing the guild's onboarding configuration.
  - Includes prompts, default channels, and descriptions.

EditWelcomeScreenOptions:
  - Options for editing the guild's welcome screen.
  - Allows setting welcome channels and a description.
```

--------------------------------

### Typing Start API

Source: https://docs.oceanic.ws/v1.12.0/enums/Constants.EmbedMediaFlags

Indicates that the current user has started typing in a channel.

```APIDOC
TYPING_START
  Description: Sends a typing indicator.
  Endpoint: POST /channels/{channel.id}/typing
  Parameters:
    channel.id: The ID of the channel.
  Returns: None.
  Example: TYPING_START(channel_id)
```

--------------------------------

### Typing Start API

Source: https://docs.oceanic.ws/v1.12.0/enums/Constants.IntegrationExpireBehaviors

Indicates that the current user has started typing in a channel.

```APIDOC
TYPING_START
  Description: Sends a typing indicator.
  Endpoint: POST /channels/{channel.id}/typing
  Parameters:
    channel.id: The ID of the channel.
  Returns: None.
  Example: TYPING_START(channel_id)
```

--------------------------------

### Soundboard and Stage Instance Management

Source: https://docs.oceanic.ws/v1.12.0/classes/PartialApplication

Documentation for events related to guild soundboard sounds and stage instance operations.

```APIDOC
SOUNDBOARD_SOUNDS:
  Description: Fired when the soundboard sounds for a guild are fetched.
  URL: https://docs.oceanic.ws/v1.12.0/functions/SOUNDBOARD_SOUNDS.html

STAGE_INSTANCE_CREATE:
  Description: Fired when a stage instance is created.
  URL: https://docs.oceanic.ws/v1.12.0/functions/STAGE_INSTANCE_CREATE.html

STAGE_INSTANCE_DELETE:
  Description: Fired when a stage instance is deleted.
  URL: https://docs.oceanic.ws/v1.12.0/functions/STAGE_INSTANCE_DELETE.html

STAGE_INSTANCE_UPDATE:
  Description: Fired when a stage instance is updated.
  URL: https://docs.oceanic.ws/v1.12.0/functions/STAGE_INSTANCE_UPDATE.html
```

--------------------------------

### Typing Start API

Source: https://docs.oceanic.ws/v1.12.0/enums/Constants.GuildScheduledEventPrivacyLevels

Indicates that the current user has started typing in a channel.

```APIDOC
TYPING_START
  Description: Sends a typing indicator.
  Endpoint: POST /channels/{channel.id}/typing
  Parameters:
    channel.id: The ID of the channel.
  Returns: None.
  Example: TYPING_START(channel_id)
```

--------------------------------

### Guild Onboarding and Welcome Screen

Source: https://docs.oceanic.ws/v1.12.0/classes/NotImplementedError

Options for configuring guild onboarding flows and the welcome screen.

```APIDOC
EditOnboardingOptions:
  - Options for editing the guild's onboarding configuration.
  - Includes prompts, default channels, and descriptions.

EditWelcomeScreenOptions:
  - Options for editing the guild's welcome screen.
  - Allows setting welcome channels and a description.
```

--------------------------------

### Guild Onboarding and Welcome Screen

Source: https://docs.oceanic.ws/v1.12.0/classes/MessageInteractionResponse

Options for configuring guild onboarding flows and the welcome screen.

```APIDOC
EditOnboardingOptions:
  - Options for editing the guild's onboarding configuration.
  - Includes prompts, default channels, and descriptions.

EditWelcomeScreenOptions:
  - Options for editing the guild's welcome screen.
  - Allows setting welcome channels and a description.
```

--------------------------------

### Typing Start API

Source: https://docs.oceanic.ws/v1.12.0/enums/Constants.ApplicationInteractionsVersion

Indicates that the current user has started typing in a channel.

```APIDOC
TYPING_START
  Description: Sends a typing indicator.
  Endpoint: POST /channels/{channel.id}/typing
  Parameters:
    channel.id: The ID of the channel.
  Returns: None.
  Example: TYPING_START(channel_id)
```

--------------------------------

### Typing Start API

Source: https://docs.oceanic.ws/v1.12.0/enums/Constants.ApplicationExplicitContentFilterLevel

Indicates that the current user has started typing in a channel.

```APIDOC
TYPING_START
  Description: Sends a typing indicator.
  Endpoint: POST /channels/{channel.id}/typing
  Parameters:
    channel.id: The ID of the channel.
  Returns: None.
  Example: TYPING_START(channel_id)
```

--------------------------------

### Guild Onboarding and Welcome Screen

Source: https://docs.oceanic.ws/v1.12.0/enums/Constants.ApplicationDiscoverabilityState

Options for configuring guild onboarding flows and the welcome screen.

```APIDOC
EditOnboardingOptions:
  - Options for editing the guild's onboarding configuration.
  - Includes prompts, default channels, and descriptions.

EditWelcomeScreenOptions:
  - Options for editing the guild's welcome screen.
  - Allows setting welcome channels and a description.
```

--------------------------------

### Typing Start API

Source: https://docs.oceanic.ws/v1.12.0/classes/ThreadableChannel

Indicates that the current user has started typing in a channel.

```APIDOC
TYPING_START
  Description: Sends a typing indicator.
  Endpoint: POST /channels/{channel.id}/typing
  Parameters:
    channel.id: The ID of the channel.
  Returns: None.
  Example: TYPING_START(channel_id)
```

--------------------------------

### ClientApplication Constructor

Source: https://docs.oceanic.ws/v1.12.0/classes/ClientApplication

Initializes a new ClientApplication instance. It takes raw application data and a client instance as parameters. This constructor overrides the base constructor.

```APIDOC
ClientApplication:
  constructor(data: RawClientApplication, client: Client)
    Parameters:
      - data: RawClientApplication - The raw data object for the client application.
      - client: Client - The client instance that manages this application.
    Returns: ClientApplication - The newly created ClientApplication instance.
    Overrides: Base.constructor
    Defined in: lib/structures/ClientApplication.ts:43
```

--------------------------------

### Typing Start API

Source: https://docs.oceanic.ws/v1.12.0/classes/PublicThreadChannel

Indicates that the current user has started typing in a channel.

```APIDOC
TYPING_START
  Description: Sends a typing indicator.
  Endpoint: POST /channels/{channel.id}/typing
  Parameters:
    channel.id: The ID of the channel.
  Returns: None.
  Example: TYPING_START(channel_id)
```

--------------------------------

### Guild Onboarding and Welcome Screen

Source: https://docs.oceanic.ws/v1.12.0/classes/RequestHandler

Options for configuring guild onboarding flows and the welcome screen.

```APIDOC
EditOnboardingOptions:
  - Options for editing the guild's onboarding configuration.
  - Includes prompts, default channels, and descriptions.

EditWelcomeScreenOptions:
  - Options for editing the guild's welcome screen.
  - Allows setting welcome channels and a description.
```

--------------------------------

### PartialApplication Static Methods

Source: https://docs.oceanic.ws/v1.12.0/classes/PartialApplication

Documentation for static methods available on the PartialApplication class, including generating IDs and retrieving creation dates from IDs.

```APIDOC
PartialApplication Static Methods:
  generateID(timestamp?: number | Date): string
    Inherited from Base.generateID
    Parameters:
      timestamp: The timestamp to generate the ID from.
    Returns: string
    Defined in lib/structures/Base.ts:21

  getCreatedAt(id: string): Date
    Parameters:
      id: The ID to get the creation date from.
    Returns: Date
    Defined in lib/structures/Base.ts:21
```

--------------------------------

### Typing Start API

Source: https://docs.oceanic.ws/v1.12.0/classes/ModalSubmitInteraction

Indicates that the current user has started typing in a channel.

```APIDOC
TYPING_START
  Description: Sends a typing indicator.
  Endpoint: POST /channels/{channel.id}/typing
  Parameters:
    channel.id: The ID of the channel.
  Returns: None.
  Example: TYPING_START(channel_id)
```

--------------------------------

### Typing Start API

Source: https://docs.oceanic.ws/v1.12.0/classes/CommandInteraction

Indicates that the current user has started typing in a channel.

```APIDOC
TYPING_START
  Description: Sends a typing indicator.
  Endpoint: POST /channels/{channel.id}/typing
  Parameters:
    channel.id: The ID of the channel.
  Returns: None.
  Example: TYPING_START(channel_id)
```

--------------------------------

### Guild Onboarding and Welcome Screen

Source: https://docs.oceanic.ws/v1.12.0/classes/DependencyError

Options for configuring guild onboarding flows and the welcome screen.

```APIDOC
EditOnboardingOptions:
  - Options for editing the guild's onboarding configuration.
  - Includes prompts, default channels, and descriptions.

EditWelcomeScreenOptions:
  - Options for editing the guild's welcome screen.
  - Allows setting welcome channels and a description.
```

--------------------------------

### Typing Start API

Source: https://docs.oceanic.ws/v1.12.0/enums/Constants.MFALevels

Indicates that the current user has started typing in a channel.

```APIDOC
TYPING_START
  Description: Sends a typing indicator.
  Endpoint: POST /channels/{channel.id}/typing
  Parameters:
    channel.id: The ID of the channel.
  Returns: None.
  Example: TYPING_START(channel_id)
```

--------------------------------

### Guild Onboarding and Welcome Screen

Source: https://docs.oceanic.ws/v1.12.0/classes/Clan

Options for configuring guild onboarding flows and the welcome screen.

```APIDOC
EditOnboardingOptions:
  - Options for editing the guild's onboarding configuration.
  - Includes prompts, default channels, and descriptions.

EditWelcomeScreenOptions:
  - Options for editing the guild's welcome screen.
  - Allows setting welcome channels and a description.
```

--------------------------------

### Guild Management Options

Source: https://docs.oceanic.ws/v1.12.0/classes/PartialApplication

Provides a comprehensive list of options for various guild management operations, including member management, channel creation, role management, and more.

```APIDOC
AddMemberOptions:
  Options for adding a member to a guild.
  URL: https://docs.oceanic.ws/v1.12.0/interfaces/Types_Guilds.AddMemberOptions.html

Ban:
  Represents a ban entry for a guild member.
  URL: https://docs.oceanic.ws/v1.12.0/interfaces/Types_Guilds.Ban.html

BeginPruneOptions:
  Options for initiating a prune operation on guild members.
  URL: https://docs.oceanic.ws/v1.12.0/interfaces/Types_Guilds.BeginPruneOptions.html

BulkBanOptions:
  Options for performing a bulk ban operation on multiple members.
  URL: https://docs.oceanic.ws/v1.12.0/interfaces/Types_Guilds.BulkBanOptions.html

BulkBanResponse:
  Response structure for a bulk ban operation.
  URL: https://docs.oceanic.ws/v1.12.0/interfaces/Types_Guilds.BulkBanResponse.html

CreateAnnouncementChannelOptions:
  Options for creating an announcement channel.
  URL: https://docs.oceanic.ws/v1.12.0/interfaces/Types_Guilds.CreateAnnouncementChannelOptions.html

CreateBanOptions:
  Options for creating a ban for a specific member.
  URL: https://docs.oceanic.ws/v1.12.0/interfaces/Types_Guilds.CreateBanOptions.html

CreateCategoryChannelOptions:
  Options for creating a category channel.
  URL: https://docs.oceanic.ws/v1.12.0/interfaces/Types_Guilds.CreateCategoryChannelOptions.html

CreateChannelOptions:
  General options for creating various types of channels.
  URL: https://docs.oceanic.ws/v1.12.0/interfaces/Types_Guilds.CreateChannelOptions.html

CreateGuildEmojiOptions:
  Options for creating a custom emoji for a guild.
  URL: https://docs.oceanic.ws/v1.12.0/interfaces/Types_Guilds.CreateGuildEmojiOptions.html

CreateGuildOptions:
  Options for creating a new guild.
  URL: https://docs.oceanic.ws/v1.12.0/interfaces/Types_Guilds.CreateGuildOptions.html

CreateRoleOptions:
  Options for creating a new role within a guild.
  URL: https://docs.oceanic.ws/v1.12.0/interfaces/Types_Guilds.CreateRoleOptions.html

CreateSoundboardSoundOptions:
  Options for creating a soundboard sound.
  URL: https://docs.oceanic.ws/v1.12.0/interfaces/Types_Guilds.CreateSoundboardSoundOptions.html

CreateStageChannelOptions:
  Options for creating a stage channel.
  URL: https://docs.oceanic.ws/v1.12.0/interfaces/Types_Guilds.CreateStageChannelOptions.html

CreateStageInstanceOptions:
  Options for creating a stage instance.
  URL: https://docs.oceanic.ws/v1.12.0/interfaces/Types_Guilds.CreateStageInstanceOptions.html

CreateStickerOptions:
  Options for creating a guild sticker.
  URL: https://docs.oceanic.ws/v1.12.0/interfaces/Types_Guilds.CreateStickerOptions.html

CreateTextChannelOptions:
  Options for creating a text channel.
  URL: https://docs.oceanic.ws/v1.12.0/interfaces/Types_Guilds.CreateTextChannelOptions.html

CreateVoiceChannelOptions:
  Options for creating a voice channel.
  URL: https://docs.oceanic.ws/v1.12.0/interfaces/Types_Guilds.CreateVoiceChannelOptions.html

EditCurrentMemberOptions:
  Options for editing the current member's profile within a guild.
  URL: https://docs.oceanic.ws/v1.12.0/interfaces/Types_Guilds.EditCurrentMemberOptions.html

EditCurrentUserVoiceStateOptions:
  Options for editing the current user's voice state.
  URL: https://docs.oceanic.ws/v1.12.0/interfaces/Types_Guilds.EditCurrentUserVoiceStateOptions.html

EditGuildEmojiOptions:
  Options for editing an existing guild emoji.
  URL: https://docs.oceanic.ws/v1.12.0/interfaces/Types_Guilds.EditGuildEmojiOptions.html

EditGuildOptions:
  Options for editing guild settings.
  URL: https://docs.oceanic.ws/v1.12.0/interfaces/Types_Guilds.EditGuildOptions.html

EditIncidentActionsOptions:
  Options for editing incident actions.
  URL: https://docs.oceanic.ws/v1.12.0/interfaces/Types_Guilds.EditIncidentActionsOptions.html

EditMFALevelOptions:
  Options for editing the guild's MFA level.
  URL: https://docs.oceanic.ws/v1.12.0/interfaces/Types_Guilds.EditMFALevelOptions.html

EditMemberOptions:
  Options for editing a guild member's properties.
  URL: https://docs.oceanic.ws/v1.12.0/interfaces/Types_Guilds.EditMemberOptions.html

EditOnboardingOptions:
  Options for editing the guild's onboarding settings.
  URL: https://docs.oceanic.ws/v1.12.0/interfaces/Types_Guilds.EditOnboardingOptions.html

EditRoleOptions:
  Options for editing an existing role.
  URL: https://docs.oceanic.ws/v1.12.0/interfaces/Types_Guilds.EditRoleOptions.html

EditRolePositionsEntry:
  An entry for modifying the position of a role.
  URL: https://docs.oceanic.ws/v1.12.0/interfaces/Types_Guilds.EditRolePositionsEntry.html

EditSoundboardSoundOptions:
  Options for editing an existing soundboard sound.
  URL: https://docs.oceanic.ws/v1.12.0/interfaces/Types_Guilds.EditSoundboardSoundOptions.html

EditStageInstanceOptions:
  Options for editing an existing stage instance.
  URL: https://docs.oceanic.ws/v1.12.0/interfaces/Types_Guilds.EditStageInstanceOptions.html

EditStickerOptions:
  Options for editing an existing guild sticker.
  URL: https://docs.oceanic.ws/v1.12.0/interfaces/Types_Guilds.EditStickerOptions.html

EditUserVoiceStateOptions:
  Options for editing a user's voice state.
  URL: https://docs.oceanic.ws/v1.12.0/interfaces/Types_Guilds.EditUserVoiceStateOptions.html

EditWelcomeScreenOptions:
  Options for editing the guild's welcome screen.
  URL: https://docs.oceanic.ws/v1.12.0/interfaces/Types_Guilds.EditWelcomeScreenOptions.html
```

--------------------------------

### Typing Start API

Source: https://docs.oceanic.ws/v1.12.0/enums/Constants.ConnectionVisibilityTypes

Indicates that the current user has started typing in a channel.

```APIDOC
TYPING_START
  Description: Sends a typing indicator.
  Endpoint: POST /channels/{channel.id}/typing
  Parameters:
    channel.id: The ID of the channel.
  Returns: None.
  Example: TYPING_START(channel_id)
```

--------------------------------

### Typing Start API

Source: https://docs.oceanic.ws/v1.12.0/enums/Constants.AutoModerationEventTypes

Indicates that the current user has started typing in a channel.

```APIDOC
TYPING_START
  Description: Sends a typing indicator.
  Endpoint: POST /channels/{channel.id}/typing
  Parameters:
    channel.id: The ID of the channel.
  Returns: None.
  Example: TYPING_START(channel_id)
```

--------------------------------

### Client Options

Source: https://docs.oceanic.ws/v1.12.0/classes/PermissionOverwrite

This entry details the configuration options available for initializing the client within the Oceanic WS library. It specifies the structure for client instance options.

```APIDOC
ClientInstanceOptions:
  # Options for initializing the client instance.
  # Specific properties and their types would be detailed here in full API documentation.
```

--------------------------------

### Typing Start API

Source: https://docs.oceanic.ws/v1.12.0/enums/Constants.ApplicationIntegrationTypes

Indicates that the current user has started typing in a channel.

```APIDOC
TYPING_START
  Description: Sends a typing indicator.
  Endpoint: POST /channels/{channel.id}/typing
  Parameters:
    channel.id: The ID of the channel.
  Returns: None.
  Example: TYPING_START(channel_id)
```

--------------------------------

### Guild Onboarding and Welcome Screen

Source: https://docs.oceanic.ws/v1.12.0/classes/RateLimitedError

Options for configuring guild onboarding flows and the welcome screen.

```APIDOC
EditOnboardingOptions:
  - Options for editing the guild's onboarding configuration.
  - Includes prompts, default channels, and descriptions.

EditWelcomeScreenOptions:
  - Options for editing the guild's welcome screen.
  - Allows setting welcome channels and a description.
```

--------------------------------

### Guild Onboarding and Welcome Screen

Source: https://docs.oceanic.ws/v1.12.0/classes/ModalSubmitInteractionComponentsWrapper

Options for configuring guild onboarding flows and the welcome screen.

```APIDOC
EditOnboardingOptions:
  - Options for editing the guild's onboarding configuration.
  - Includes prompts, default channels, and descriptions.

EditWelcomeScreenOptions:
  - Options for editing the guild's welcome screen.
  - Allows setting welcome channels and a description.
```

--------------------------------

### Typing Start API

Source: https://docs.oceanic.ws/v1.12.0/enums/Constants.AnimationTypes

Indicates that the current user has started typing in a channel.

```APIDOC
TYPING_START
  Description: Sends a typing indicator.
  Endpoint: POST /channels/{channel.id}/typing
  Parameters:
    channel.id: The ID of the channel.
  Returns: None.
  Example: TYPING_START(channel_id)
```

--------------------------------

### Guild Soundboard and Stickers

Source: https://docs.oceanic.ws/v1.12.0/classes/PartialApplication

Documentation for events related to guild soundboard sounds and sticker updates.

```APIDOC
GUILD_SOUNDBOARD_SOUNDS_UPDATE:
  Description: Fired when the list of soundboard sounds in a guild is updated.
  URL: https://docs.oceanic.ws/v1.12.0/functions/GUILD_SOUNDBOARD_SOUNDS_UPDATE.html

GUILD_SOUNDBOARD_SOUND_CREATE:
  Description: Fired when a new soundboard sound is created in a guild.
  URL: https://docs.oceanic.ws/v1.12.0/functions/GUILD_SOUNDBOARD_SOUND_CREATE.html

GUILD_SOUNDBOARD_SOUND_DELETE:
  Description: Fired when a soundboard sound is deleted from a guild.
  URL: https://docs.oceanic.ws/v1.12.0/functions/GUILD_SOUNDBOARD_SOUND_DELETE.html

GUILD_SOUNDBOARD_SOUND_UPDATE:
  Description: Fired when a guild soundboard sound is updated.
  URL: https://docs.oceanic.ws/v1.12.0/functions/GUILD_SOUNDBOARD_SOUND_UPDATE.html

GUILD_STICKERS_UPDATE:
  Description: Fired when the list of stickers in a guild is updated.
  URL: https://docs.oceanic.ws/v1.12.0/functions/GUILD_STICKERS_UPDATE.html
```

--------------------------------

### Typing Start API

Source: https://docs.oceanic.ws/v1.12.0/enums/Constants.ActivityLocationKind

Indicates that the current user has started typing in a channel.

```APIDOC
TYPING_START
  Description: Sends a typing indicator.
  Endpoint: POST /channels/{channel.id}/typing
  Parameters:
    channel.id: The ID of the channel.
  Returns: None.
  Example: TYPING_START(channel_id)
```

--------------------------------

### Guild Onboarding and Welcome Screen

Source: https://docs.oceanic.ws/v1.12.0/enums/Constants.ButtonStyles

Options for configuring guild onboarding flows and the welcome screen.

```APIDOC
EditOnboardingOptions:
  - Options for editing the guild's onboarding configuration.
  - Includes prompts, default channels, and descriptions.

EditWelcomeScreenOptions:
  - Options for editing the guild's welcome screen.
  - Allows setting welcome channels and a description.
```

--------------------------------

### Typing Start API

Source: https://docs.oceanic.ws/v1.12.0/classes/VoiceChannel

Indicates that the current user has started typing in a channel.

```APIDOC
TYPING_START
  Description: Sends a typing indicator.
  Endpoint: POST /channels/{channel.id}/typing
  Parameters:
    channel.id: The ID of the channel.
  Returns: None.
  Example: TYPING_START(channel_id)
```

--------------------------------

### Typing Start API

Source: https://docs.oceanic.ws/v1.12.0/classes/TextableVoiceChannel

Indicates that the current user has started typing in a channel.

```APIDOC
TYPING_START
  Description: Sends a typing indicator.
  Endpoint: POST /channels/{channel.id}/typing
  Parameters:
    channel.id: The ID of the channel.
  Returns: None.
  Example: TYPING_START(channel_id)
```

--------------------------------

### Guild Onboarding and Welcome Screen

Source: https://docs.oceanic.ws/v1.12.0/classes/WrapperError

Options for configuring guild onboarding flows and the welcome screen.

```APIDOC
EditOnboardingOptions:
  - Options for editing the guild's onboarding configuration.
  - Includes prompts, default channels, and descriptions.

EditWelcomeScreenOptions:
  - Options for editing the guild's welcome screen.
  - Allows setting welcome channels and a description.
```

--------------------------------

### Typing Start API

Source: https://docs.oceanic.ws/v1.12.0/classes/TextChannel

Indicates that the current user has started typing in a channel.

```APIDOC
TYPING_START
  Description: Sends a typing indicator.
  Endpoint: POST /channels/{channel.id}/typing
  Parameters:
    channel.id: The ID of the channel.
  Returns: None.
  Example: TYPING_START(channel_id)
```

--------------------------------

### Stage Instance and Sticker API Routes

Source: https://docs.oceanic.ws/v1.12.0/classes/ClientApplication

Endpoints for managing stage instances and stickers.

```APIDOC
Routes.STAGE_INSTANCE: Get a stage instance.
Routes.STICKER: Get a sticker.
Routes.STICKER_PACK_BANNER: Get a sticker pack banner.
```

--------------------------------

### Stage Instance and Sticker API Routes

Source: https://docs.oceanic.ws/v1.12.0/classes/PartialApplication

API endpoints for managing real-time stage instances and static sticker assets. Stage instances are likely for live events or shared experiences, while stickers are for communication.

```APIDOC
Routes.STAGE_INSTANCE:
  Description: Manages a specific stage instance.
  URL: /stage-instances/{stage_instance_id}
  Method: GET | PATCH | DELETE

Routes.STICKER:
  Description: Retrieves information about a specific sticker.
  URL: /stickers/{sticker_id}
  Method: GET

Routes.STICKER_PACK_BANNER:
  Description: Retrieves the banner asset for a sticker pack.
  URL: /sticker-packs/{sticker_pack_id}/banner
  Method: GET
```

--------------------------------

### Typing Start API

Source: https://docs.oceanic.ws/v1.12.0/classes/StageChannel

Indicates that the current user has started typing in a channel.

```APIDOC
TYPING_START
  Description: Sends a typing indicator.
  Endpoint: POST /channels/{channel.id}/typing
  Parameters:
    channel.id: The ID of the channel.
  Returns: None.
  Example: TYPING_START(channel_id)
```

--------------------------------

### SKU and Subscription API Routes

Source: https://docs.oceanic.ws/v1.12.0/classes/PartialApplication

Provides access to SKU (Stock Keeping Unit) information and subscription management endpoints. These routes are essential for managing product licensing and user subscriptions within the platform.

```APIDOC
Routes.SKU_SUBSCRIPTION:
  Description: Retrieves details for a specific SKU subscription.
  URL: /sku/subscription/{id}
  Method: GET

Routes.SKU_SUBSCRIPTIONS:
  Description: Retrieves a list of all SKU subscriptions.
  URL: /sku/subscriptions
  Method: GET
```

--------------------------------

### Typing Start API

Source: https://docs.oceanic.ws/v1.12.0/classes/Shard

Indicates that the current user has started typing in a channel.

```APIDOC
TYPING_START
  Description: Sends a typing indicator.
  Endpoint: POST /channels/{channel.id}/typing
  Parameters:
    channel.id: The ID of the channel.
  Returns: None.
  Example: TYPING_START(channel_id)
```

--------------------------------

### Welcome Screen and Channel Options

Source: https://docs.oceanic.ws/v1.12.0/enums/Constants.AuditLogActionTypes

Details structures for editing welcome screens and managing editable channel properties. Includes EditWelcomeScreenOptions and EditableChannels for customizing server welcome experiences and channel configurations.

```APIDOC
EditWelcomeScreenOptions:
  Represents options for editing a server's welcome screen.

EditableChannels:
  Represents properties that can be edited on channels.
```
Tokens:
Raw