Class ChannelRouter

The channel router for the Guilded REST API.

Example

new ChannelRouter(rest);

Hierarchy

Constructors

constructor

Properties

rest

Methods

create delete edit fetch

Constructors

constructor

Properties

Readonly rest

rest: RESTManager

Methods

create

  • Create a channel on Guilded.

    Returns

    The created channel.

    Example

    channels.create({ name: 'Chat', type: 'chat' });

    Parameters

    Returns Promise<APIChannel>

delete

  • Delete a channel from Guilded.

    Example

    channels.delete('abc');

    Parameters

    • channelId: string

      The ID of the channel to delete.

    Returns Promise<void>

edit

  • Edit a channel on Guilded.

    Returns

    The edited channel.

    Example

    channels.edit('abc', { name: 'Chat' });

    Parameters

    • channelId: string

      The ID of the channel to edit.

    • payload: APIChannelEditPayload

      The payload of the channel.

    Returns Promise<APIChannel>

fetch

  • Fetch a channel from Guilded.

    Returns

    The fetched channel.

    Example

    channels.fetch('abc');

    Parameters

    • channelId: string

      The ID of the channel to fetch.

    Returns Promise<APIChannel>

Settings

Member Visibility

Theme