The main class for interacting with the api.

Template

The custom events for the client.

Hierarchy

Constructors

  • Throws

    Must provide options in client constructor in the form of an object.

    Throws

    No token provided.

    Parameters

    Returns Client

Properties

A manager for guild bans, used to manage and interact with bans.

calendars: GlobalCalendarManager = ...

A manager for calendars, used to manage and interact with calendars.

categories: GlobalCategoryManager = ...

A manager for categories, used to manage and interact with categories.

channels: GlobalChannelManager = ...

A manager for channels, used to manage and interact with channels.

docs: GlobalDocManager = ...

A manager for docs, used to manage and interact with docs.

gatewayHandler: ClientGatewayHandler = ...

The gateway events will be processed by this manager.

groups: GlobalGroupManager = ...

A manager for groups, used to manage and interact with groups.

A manager for list items, used to manage and interact with list items.

members: GlobalMemberManager = ...

A manager for members, used to manage and interact with members.

messages: GlobalMessageManager = ...

A manager for messages, used to manage and interact with messages.

options: ClientOptions

The options for the client.

reactions: GlobalReactionManager = ...

A manager for reactions, used to manage and interact with reactions.

readyTimestamp: null | number = null

The time in milliseconds since the Client connected.

rest: RestManager = ...

The manager for the bot to make requests to the REST api.

roles: GlobalRoleManager = ...

A manager for roles, used to manage and interact with roles.

servers: GlobalServerManager = ...

A manager for servers, used to manage and interact with servers.

subscriptions: GlobalSubscriptionManager = ...

A manager for server subscriptions, used to manage and interact with server subscriptions.

A manager for forum topics, used to manage and interact with forum topics.

user: null | ClientUser = null

The user belonging to this bot.

users: GlobalUserManager = ...

A manager for users, used to manage and interact with users.

webhooks: GlobalWebhookManager = ...

A manager for webhooks, used to manage and interact with webhooks.

The websocket connection.

Accessors

Methods

  • Connects the bot to the api.

    Example

    let client = new Guilded.Client({ token: process.env.GUILDED_TOKEN });
    client.on('ready', () => console.log('Logged in!'));
    client.login();

    Parameters

    • Optional opts: {
          fresh?: boolean;
      }

      The options for connecting to the api.

      • Optional fresh?: boolean

        Whether this should create a new WebSocketManager instance.

    Returns void

  • Set current logged in client's status

    Parameters

    • options: {
          content?: string;
          emoteId: number;
          expiresAt?: string | number | Date;
      }

      The options for setting the status.

      • Optional content?: string

        The content of the status.

      • emoteId: number

        The id of the emote to use for the status.

      • Optional expiresAt?: string | number | Date

        The time the status should expire.

    Returns Promise<void>

Generated using TypeDoc