Hierarchy

  • Channels

Constructors

Methods

  • Mark a list item as completed.

    Parameters

    • channelID: string

      ID of a "Lists" channel.

    • itemID: string

      ID of a list item.

    Returns Promise<void>

  • Create a new item in a list channel.

    Parameters

    • channelID: string

      ID of a "Lists" channel.

    • content: string

      String content of the new item.

    • Optional note: {
          content: string;
      }

      Add a note to the new item.

      • content: string

        The note of the list item

    Returns Promise<ListItem>

  • Add a reaction to a specified object.

    Parameters

    • channelID: string

      ID of a channel that supports reaction.

    • channelType: ChannelReactionTypes

      Type of the selected channel. (e.g: "ChannelMessage")

    • objectID: string | number

      ID of the object you'd like to add the reaction to. (e.g: a message id)

    • reaction: number

      ID of the reaction.

    Returns Promise<void>

  • Delete an event from a "Calendar" channel.

    Parameters

    • channelID: string

      ID of a "Calendar" channel.

    • eventID: number

      ID of a calendar event.

    Returns Promise<void>

  • Delete a RSVP from a calendar event.

    Parameters

    • channelID: string

      ID of a "Calendar" channel.

    • eventID: number

      ID of a calendar event.

    • memberID: string

      ID of a member.

    Returns Promise<void>

  • Delete a doc from a "Docs" channel.

    Parameters

    • channelID: string

      ID of a "Docs" channel.

    • docID: number

      ID of a doc.

    Returns Promise<void>

  • Delete a forum thread comment.

    Parameters

    • channelID: string

      ID of a "Forums" channel.

    • threadID: number

      ID of a forum thread.

    • commentID: number

      ID of a forum thread comment.

    Returns Promise<void>

  • Delete a forum thread from a specific forum channel

    Parameters

    • channelID: string

      ID of a "Forums" channel.

    • threadID: number

      ID of a forum thread.

    Returns Promise<void>

  • Delete an item from a list channel.

    Parameters

    • channelID: string

      ID of a "Lists" channel.

    • itemID: string

      ID of a list item.

    Returns Promise<void>

  • Delete a specific message.

    Parameters

    • channelID: string

      ID of the channel containing the message.

    • messageID: string

      ID of the message you'd like to delete.

    Returns Promise<void>

  • Remove a reaction from a specified message.

    Parameters

    • channelID: string

      ID of a channel that supports reaction.

    • channelType: ChannelReactionTypes

      Type of the selected channel. (e.g: "ChannelMessage")

    • objectID: string | number

      ID of the object you'd like to add the reaction to. (e.g: a message id)

    • reaction: number

      ID of the reaction.

    Returns Promise<void>

  • Edit an item from a list channel.

    Parameters

    • channelID: string

      ID of a "Lists" channel.

    • itemID: string

      ID of a list item.

    • content: string

      New item's content.

    • Optional note: {
          content: string;
      }

      Add a note to the item.

      • content: string

        The note of the list item

    Returns Promise<ListItem>

  • Edit a specific message coming from a specified channel.

    Parameters

    • channelID: string

      The ID of the channel.

    • messageID: string

      The ID of the message you'd like to edit.

    • newMessage: EditMessageOptions

      object containing new message's options.

    • Optional params: object

      Optional parameters.

    Returns Promise<Message>

  • This method is used to get a specific calendar event.

    Note: this method requires a "Calendar" channel.

    Parameters

    • channelID: string

      ID of a Calendar channel.

    • eventID: number

      ID of a Calendar event.

    Returns Promise<CalendarEvent>

  • This method is used to get a specific CalendarEventRSVP.

    Note: this method requires a Calendar channel.

    Parameters

    • channelID: string

      ID of a Calendar channel

    • eventID: number

      ID of a Calendar Event

    • memberID: string

      ID of a Guild Member

    Returns Promise<CalendarEventRSVP>

  • This method is used to get a list of CalendarEventRSVP.

    Parameters

    • channelID: string

      ID of a "Calendar" channel.

    • eventID: number

      ID of a calendar event.

    Returns Promise<CalendarEventRSVP[]>

  • This method is used to get a guild channel.

    Parameters

    • channelID: string

      The ID of the channel to get.

    Returns Promise<Channel>

  • This method is used to get a channel doc.

    Note: This method requires a "Docs" channel.

    Parameters

    • channelID: string

      ID of the Docs channel.

    • docID: number

      ID of the channel doc.

    Returns Promise<Doc>

  • This method is used to get a list of "Channel" Doc.

    Parameters

    • channelID: string

      ID of a "Docs" channel.

    • Optional filter: {
          before?: string;
          limit?: number;
      }

      Object to filter the output.

      • Optional before?: string
      • Optional limit?: number

    Returns Promise<Doc[]>

  • This method is used to get a specific forum thread comment.

    Parameters

    • channelID: string

      ID of a "Forums" channel.

    • threadID: number

      ID of a Forum thread.

    • commentID: number

      ID of a Forum thread comment.

    Returns Promise<ForumThreadComment>

  • This method is used to get a list of ForumThreadComment.

    Parameters

    • channelID: string

      ID of a "Forums" channel.

    • threadID: number

      ID of a Forum Thread.

    Returns Promise<ForumThreadComment[]>

  • This method is used to get a specific forum thread.

    Note: This method requires a "Forum" channel.

    Parameters

    • channelID: string

      ID of a speific Forum channel.

    • threadID: number

      ID of the specific Forum Thread.

    Returns Promise<ForumThread>

  • This method is used to get a specific list item.

    Parameters

    • channelID: string

      ID of a "List" channel.

    • itemID: string

      ID of a list item.

    Returns Promise<ListItem>

  • This method is used to get a list of ListItem.

    Parameters

    • channelID: string

      ID of a "List" channel.

    Returns Promise<ListItem[]>

  • This method is used to get a channel message.

    Parameters

    • channelID: string

      The ID of the channel containing the message.

    • messageID: string

      The ID of the message to get.

    • Optional params: object

      Optional parameters.

    Returns Promise<Message>

  • Lock a forum thread.

    Parameters

    • channelID: string

      ID of a "Forums" channel.

    • threadID: number

      ID of a forum thread.

    Returns Promise<void>

  • Pin a forum thread.

    Parameters

    • channelID: string

      ID of a "Forums" channel.

    • threadID: number

      ID of a forum thread.

    Returns Promise<void>

  • Mark a list item as uncompleted.

    Parameters

    • channelID: string

      ID of a "Lists" channel.

    • itemID: string

      ID of a list item.

    Returns Promise<void>

  • Unlock a forum thread.

    Parameters

    • channelID: string

      ID of a "Forums" channel.

    • threadID: number

      ID of a forum thread.

    Returns Promise<void>

  • Unpin a forum thread.

    Parameters

    • channelID: string

      ID of a "Forums" channel.

    • threadID: number

      ID of a forum thread.

    Returns Promise<void>