Represents a list channel on Guilded.

Example

new ListChannel(client, rawChannel);

Hierarchy

Constructors

  • Parameters

    • client: Client

      The client the list channel belongs to.

    • raw: APIChannel

      The raw data of the list channel.

    • Optional cache: boolean

      Whether to cache the list channel.

    Returns ListChannel

Properties

archivedAt?: Date

The date the channel was archived.

archivedBy?: string

The ID of the user that archived the channel.

categoryId?: number

The ID of the category the channel belongs to.

client: Client
createdAt: Date

The date the channel was created.

createdBy: string

The ID of the user that created the channel.

editedAt?: Date

The date the channel was edited.

groupId: string

The ID of the group the channel belongs to.

id: string
isPublic?: boolean

Whether the channel is public.

The manager of items that belong to the list channel.

name: string

The name of the channel.

parantId?: string

The ID of the parent channel the channel belongs to.

serverId: string

The ID of the server the channel belongs to.

topic?: string

The topic of the channel.

The type of the channel.

The manager of webhooks that belong to the channel.

Accessors

  • get archivedTimestamp(): undefined | number
  • The timestamp the channel was archived.

    Returns undefined | number

  • get archiver(): undefined | ServerMember
  • The server member that archived the channel.

    Returns undefined | ServerMember

  • get createdTimestamp(): number
  • The timestamp the channel was created.

    Returns number

  • get creator(): undefined | ServerMember
  • The server member that created the channel.

    Returns undefined | ServerMember

  • get editedTimestamp(): undefined | number
  • The timestamp the channel was edited.

    Returns undefined | number

  • get group(): undefined | Group
  • The group the channel belongs to.

    Returns undefined | Group

  • get isAnnouncement(): boolean
  • Whether the channel is a announcement channel.

    Returns boolean

  • get isArchived(): boolean
  • Whether the channel is archived.

    Returns boolean

  • get isCached(): boolean
  • Whether the channel is cached.

    Returns boolean

  • get isCalendar(): boolean
  • Whther the channel is a calendar channel.

    Returns boolean

  • get isChat(): boolean
  • Whther the channel is a chat channel.

    Returns boolean

  • get isChatBased(): boolean
  • Whether the channel is chat based.

    Returns boolean

  • get isDoc(): boolean
  • Whther the channel is a doc channel.

    Returns boolean

  • get isForum(): boolean
  • Whther the channel is a forum channel.

    Returns boolean

  • get isList(): boolean
  • Whther the channel is a list channel.

    Returns boolean

  • get isMedia(): boolean
  • Whther the channel is a media channel.

    Returns boolean

  • get isSchedule(): boolean
  • Whther the channel is a schedule channel.

    Returns boolean

  • get isStream(): boolean
  • Whther the channel is a stream channel.

    Returns boolean

  • get isVoice(): boolean
  • Whther the channel is a voice channel.

    Returns boolean

  • get parent(): undefined | Channel
  • The parent channel the channel belongs to.

    Returns undefined | Channel

  • get server(): undefined | Server
  • The server the channel belongs to.

    Returns undefined | Server

Methods

  • Create a item in the list channel.

    Returns

    The created list item.

    Example

    channel.createItem('Hello World!');
    

    Parameters

    • message: string

      The message of the list item.

    • Optional note: string

      The note of the list item.

    Returns Promise<ListItem>

  • Delete the channel.

    Returns

    The deleted channel.

    Example

    channel.delete();
    

    Returns Promise<ListChannel>

  • Fetch the channel.

    Returns

    The fetched channel.

    Example

    channel.fetch();
    

    Parameters

    • Optional options: FetchOptions

      The options to fetch the channel with.

    Returns Promise<ListChannel>

  • Fetch the server member that archived the channel.

    Returns

    The fetched server member.

    Example

    channel.fetchArchiver();
    

    Parameters

    • Optional options: FetchOptions

      The options to fetch the server member with.

    Returns Promise<undefined | ServerMember>

  • Fetch the server member that created the channel.

    Returns

    The fetched server member.

    Example

    channel.fetchCreator();
    

    Parameters

    • Optional options: FetchOptions

      The options to fetch the server member with.

    Returns Promise<ServerMember>

  • Fetch the group the channel belongs to.

    Returns

    The fetched group.

    Example

    channel.fetchGroup();
    

    Parameters

    • Optional options: FetchOptions

      The options to fetch the group with.

    Returns Group

  • Fetch the parent channel the channel belongs to.

    Returns

    The fetched channel.

    Example

    channel.fetchParent();
    

    Parameters

    • Optional options: FetchOptions

      The options to fetch the channel with.

    Returns undefined | Promise<Channel>

  • Fetch the server the channel belongs to.

    Returns

    The fetched server.

    Example

    channel.fetchServer();
    

    Parameters

    • Optional options: FetchOptions

      The options to fetch the server with.

    Returns Promise<Server>

  • Set the name of the channel.

    Returns

    The edited channel.

    Example

    channel.setName('Chat');
    

    Parameters

    • name: string

      The name of the channel.

    Returns Promise<ListChannel>

  • Set whether the channel is public.

    Returns

    The edited channel.

    Example

    channel.setPublic(true);
    

    Parameters

    • isPublic: boolean

      Whether the channel is public.

    Returns Promise<ListChannel>

  • Set the topic of the channel.

    Returns

    The edited channel.

    Example

    channel.setTopic('This is a topic');
    

    Parameters

    • topic: string

      The topic of the channel.

    Returns Promise<ListChannel>