Class ListChannel

Represents a list channel in Guilded.

Hierarchy

Channel
- ListChannel

Index

Constructors

Constructors

constructor

new ListChannel(client, data): ListChannel
Parameters
- client: Client
- data: Omit<ServerChannelPayload, "visibility"> & {
  deleted?: boolean;
  visibility?: null | "" | "private" | "public";
  }
Returns ListChannel
Inherited from Channel.constructor
- Defined in guilded.js/lib/structures/channels/Channel.ts:78

Properties

_archivedAt

_archivedAt: null | number

The timestamp when the channel was archived.

_createdAt

_createdAt: number

The timestamp when the channel was created.

_updatedAt

_updatedAt: null | number

The timestamp when the channel was last updated.

archivedBy

archivedBy: null | string

The user ID of the user who archived the channel.

categoryId

categoryId: null | number

The ID of the category that the channel belongs to.

`Readonly` client

client: Client

createdBy

createdBy: string

The user ID of the user who created the channel.

groupId

groupId: string

The ID of the group that the channel belongs to.

id

id: string

Identifier of this structrure

`Readonly` items

items: Collection<string, ListItemPayload | ListItemSummaryPayload> = ...

The list items in this channel.

name

name: string

The name of the channel.

parentId

parentId: null | string

The ID of the parent channel.

raw

raw: {
id: string;
}

Bare data of this structure

Type declaration

id: string

serverId

serverId: string

The ID of the server that the channel belongs to.

topic

topic: null | string

The topic of the channel.

type

type: ChannelType

The type of the channel.

visibility

visibility: null | string

The visibility state of the channel.

Accessors

archivedAt

get archivedAt(): null | Date
The timestamp when the channel was archived as a Date object, or null if the channel is not archived.

Returns null | Date
Inherited from Channel.archivedAt
- Defined in guilded.js/lib/structures/channels/Channel.ts:105

createdAt

get createdAt(): Date
The timestamp when the channel was created as a Date object.

Returns Date
Inherited from Channel.createdAt
- Defined in guilded.js/lib/structures/channels/Channel.ts:98

updatedAt

get updatedAt(): null | Date
The timestamp when the channel was last updated as a Date object, or null if the channel has not been updated.

Returns null | Date
Inherited from Channel.updatedAt
- Defined in guilded.js/lib/structures/channels/Channel.ts:112

Methods

_clone

_clone(): ListChannel
Taken from https://github.com/discordjs/discord.js/blob/8e8d9b490a71de6cabe6f16375d7549a7c5c3737/src/structures/Base.js#L20 Licensed under the Apache License 2.0 https://github.com/discordjs/discord.js/blob/8e8d9b490a71de6cabe6f16375d7549a7c5c3737/LICENSE

Returns ListChannel
Inherited from Channel._clone
- Defined in guilded.js/lib/structures/Base.ts:28

_update

_update(data): ListChannel
Parameters
- data: Partial<Omit<ServerChannelPayload, "visibility"> & {
  deleted?: boolean;
  visibility?: null | "" | "private" | "public";
  }>
Returns ListChannel
Inherited from Channel._update
- Defined in guilded.js/lib/structures/channels/Channel.ts:116

completeItem

completeItem(itemId): Promise<void>
Completes a list item.
Parameters
- itemId: string
  
  The ID of the list item to complete.
Returns Promise<void>
A Promise that resolves when the list item is completed.
- Defined in guilded.js/lib/structures/channels/ListChannel.ts:66

createItem

createItem(message, note?): Promise<ListItemPayload>
Creates a list item in this channel.
Parameters
- message: string
  
  The message of the new list item.
- Optional note: string
  
  Optional note for the new list item.
Returns Promise<ListItemPayload>
A Promise that resolves with the newly created list item payload.
- Defined in guilded.js/lib/structures/channels/ListChannel.ts:23

delete

delete(): Promise<null | Channel>
Delete the channel.

Returns Promise<null | Channel>
Inherited from Channel.delete
- Defined in guilded.js/lib/structures/channels/Channel.ts:189

fetchMessage

fetchMessage(messageId): Promise<Message>
Fetch details for a specific message in the channel.
Parameters
- messageId: string
  
  The ID of the message to fetch.
Returns Promise<Message>
Inherited from Channel.fetchMessage
- Defined in guilded.js/lib/structures/channels/Channel.ts:173

fetchMessages

fetchMessages(options?): Promise<Collection<string, Message>>
Fetch from the latest 100 messages in the channel.
Parameters
- Optional options: unknown
  
  Additional options for the message fetch.
Returns Promise<Collection<string, Message>>
Inherited from Channel.fetchMessages
- Defined in guilded.js/lib/structures/channels/Channel.ts:164

getItem

getItem(itemId): Promise<ListItemPayload>
Fetches a list item by its ID.
Parameters
- itemId: string
  
  The ID of the list item to fetch.
Returns Promise<ListItemPayload>
A Promise that resolves with the list item payload.
- Defined in guilded.js/lib/structures/channels/ListChannel.ts:40

getItems

getItems(): Promise<ListItemSummaryPayload[]>
Fetches all list items in this channel.

Returns Promise<ListItemSummaryPayload[]>
A Promise that resolves with an array of list item summary payloads.
- Defined in guilded.js/lib/structures/channels/ListChannel.ts:51

send

send(content): Promise<Message>
Send a message in the channel.

Example
```
let replyObj = {
 content: 'This is text, supports **markdown**.',
 embeds: [{
   title: 'This is an embed title!',
   description: 'A description may go here'
 }]
};
channel.send(replyObj)
```
Parameters
- content: MessageContent
  
  The content of the message.
Returns Promise<Message>
Inherited from Channel.send
- Defined in guilded.js/lib/structures/channels/Channel.ts:207

uncompleteItem

uncompleteItem(itemId): Promise<void>
Uncompletes a list item.
Parameters
- itemId: string
  
  The ID of the list item to uncomplete.
Returns Promise<void>
A Promise that resolves when the list item is uncompleted.
- Defined in guilded.js/lib/structures/channels/ListChannel.ts:76

update

update(options): Promise<Channel>
Update the channel with new data.
Parameters
- options: {}
  
  The new data for the channel.
Returns Promise<Channel>
Inherited from Channel.update
- Defined in guilded.js/lib/structures/channels/Channel.ts:182

Class ListChannel

Hierarchy

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

client: Client

data: Omit<ServerChannelPayload, "visibility"> & { deleted?: boolean; visibility?: null | "" | "private" | "public"; }

Returns ListChannel

Properties

_archivedAt

_createdAt

_updatedAt

archivedBy

categoryId

Readonly client

createdBy

groupId

id

Readonly items

name

parentId

raw

Type declaration

id: string

serverId

topic

type

visibility

Accessors

archivedAt

Returns null | Date

createdAt

Returns Date

updatedAt

Returns null | Date

Methods

_clone

Returns ListChannel

_update

Parameters

data: Partial<Omit<ServerChannelPayload, "visibility"> & { deleted?: boolean; visibility?: null | "" | "private" | "public"; }>

Returns ListChannel

completeItem

Parameters

itemId: string

Returns Promise<void>

createItem

Parameters

message: string

Optional note: string

Returns Promise<ListItemPayload>

delete

Returns Promise<null | Channel>

fetchMessage

Parameters

messageId: string

Returns Promise<Message>

fetchMessages

Parameters

Optional options: unknown

Returns Promise<Collection<string, Message>>

getItem

Parameters

itemId: string

Returns Promise<ListItemPayload>

getItems

Returns Promise<ListItemSummaryPayload[]>

send

Example

Parameters

content: MessageContent

Returns Promise<Message>

uncompleteItem

Parameters

itemId: string

data: Omit<ServerChannelPayload, "visibility"> & {
deleted?: boolean;
visibility?: null | "" | "private" | "public";
}

`Readonly` client

`Readonly` items

data: Partial<Omit<ServerChannelPayload, "visibility"> & {
deleted?: boolean;
visibility?: null | "" | "private" | "public";
}>

`Optional` note: string

`Optional` options: unknown