Class GlobalListItemManager

A class representing a manager for list items at a global level.

Hierarchy

GlobalManager
- GlobalListItemManager

Index

Constructors

Properties

Methods

complete create delete fetch fetchMany uncomplete update

Constructors

constructor

new GlobalListItemManager(client): GlobalListItemManager
Parameters
- client: Client
Returns GlobalListItemManager
Inherited from GlobalManager.constructor
- Defined in guilded.js/lib/managers/global/GlobalManager.ts:7

Properties

`Readonly` client

client: Client

Methods

complete

complete(channelId, listItemId): Promise<void>
Marks a list item as complete.
Parameters
- channelId: string
  
  The ID of the channel that the list item belongs to.
- listItemId: string
  
  The ID of the list item to mark as complete.
Returns Promise<void>
A Promise that resolves with no value upon successful completion.
- Defined in guilded.js/lib/managers/global/ListManager.ts:90

create

create(channelId, options): Promise<ListItemPayload>
Creates a new list item.
Parameters
- channelId: string
  
  The ID of the channel to create the list item in.
- options: {}
  
  Additional options for the list item.
Returns Promise<ListItemPayload>
A Promise that resolves with the newly created list item.
- Defined in guilded.js/lib/managers/global/ListManager.ts:16

delete

delete(channelId, listItemId): Promise<void>
Deletes a list item.
Parameters
- channelId: string
  
  The ID of the channel that the list item belongs to.
- listItemId: string
  
  The ID of the list item to delete.
Returns Promise<void>
A Promise that resolves with no value upon successful deletion.
- Defined in guilded.js/lib/managers/global/ListManager.ts:76

fetch

fetch(channelId, listItemId): Promise<ListItemPayload>
Fetches a single list item.
Parameters
- channelId: string
  
  The ID of the channel that the list item belongs to.
- listItemId: string
  
  The ID of the list item to fetch.
Returns Promise<ListItemPayload>
A Promise that resolves with the requested list item.
- Defined in guilded.js/lib/managers/global/ListManager.ts:44

fetchMany

fetchMany(channelId): Promise<ListItemSummaryPayload[]>
Fetches multiple list items.
Parameters
- channelId: string
  
  The ID of the channel to fetch the list items from.
Returns Promise<ListItemSummaryPayload[]>
A Promise that resolves with an array of list item summaries.
- Defined in guilded.js/lib/managers/global/ListManager.ts:30

uncomplete

uncomplete(channelId, listItemId): Promise<void>
Marks a completed list item as incomplete.
Parameters
- channelId: string
  
  The ID of the channel that the list item belongs to.
- listItemId: string
  
  The ID of the completed list item to mark as incomplete.
Returns Promise<void>
A Promise that resolves with no value upon successful uncompletion.
- Defined in guilded.js/lib/managers/global/ListManager.ts:104

update

update(channelId, listItemId, options): Promise<ListItemPayload>
Updates a list item.
Parameters
- channelId: string
  
  The ID of the channel that the list item belongs to.
- listItemId: string
  
  The ID of the list item to update.
- options: {}
  
  Additional options for the updated list item.
Returns Promise<ListItemPayload>
A Promise that resolves with the updated list item.
- Defined in guilded.js/lib/managers/global/ListManager.ts:60

Generated using TypeDoc