↗️ListItem

ListItem is a 'list channel' component. It has his own properties and methods.

Properties

Property	Description	Type
_data	raw data	Object
_client	client	Client
id	item id	String
guildID	id of the guild	String
channelID	id of the list channel	String
content	content of the item	String
mentions	mentions contained in the item	Object (MentionsType)
_createdAt	timestamp of item's creation	Number
memberID	id of the member who created the item	String
webhookID	id of the webhook who created/updated the item.	String
_updatedAt	timestamp of when the item got updated	Number
updatedBy	id of the member that updated the item, if updated.	String
parentListItemID	The ID of the parent list item if this list item is nested	String
_completedAt	timestamp of the item's completion	Number
completedBy	set to completed by'?'	String
note	note object provided by guilded, with all the note information.	Object
member	Member component of the the owner of the item or the user who updated the item (depends on the action).	Member|void
createdAt	string representation of the _createdAt timestamp.	Date
updatedAt	string representation of the _updatedAt timestamp.	Date
completedAt	string representation of the _completedAt timestamp.	Date

Constructor

new ListItem(rawData, client)

Properties	Description	Type	Required?
rawData	raw data received from ws and converted to JSON	Object	true
client	Client	Client	true

Do not use this constructor unless you know what you're doing. This constructor is used to return you rawdata into component.

Methods

edit(content, note?)

Edit the list item.

Properties	Description	Type	Required?
content	New content of the item.	String	true
note?	Item's additional note	Object	false
note?.content	note's content	String	true

Returns: Promise<ListItem>

delete()

Delete the list item.

Returns: Promise<void>

complete()

Set the item to 'complete'.

Returns: Promise<void>

uncomplete()

Set the item to 'uncomplete'.

Returns: Promise<void>