Class Channels

Hierarchy

Channels

Constructors

constructor

new Channels(manager: RESTManager): Channels
Parameters
- manager: RESTManager
Returns Channels
- Defined in lib/routes/Channels.ts:52

Methods

completeListItem

completeListItem(channelID: string, itemID: string): Promise<void>
Parameters
- channelID: string
- itemID: string
Returns Promise<void>
- Defined in lib/routes/Channels.ts:412

createCalendarEvent

createCalendarEvent(channelID: string, options: POSTCalendarEventBody): Promise<CalendarEvent>
Parameters
- channelID: string
- options: POSTCalendarEventBody
Returns Promise<CalendarEvent>
- Defined in lib/routes/Channels.ts:346

createDoc

createDoc(channelID: string, options: {
content: string;
title: string;
}): Promise<Doc>
Parameters
- channelID: string
- options: {
  content: string;
  title: string;
  }
  - content: string
  - title: string
Returns Promise<Doc>
- Defined in lib/routes/Channels.ts:321

createListItem

createListItem(channelID: string, content: string, note?: {
content: string;
}): Promise<ListItem>
Parameters
- channelID: string
- content: string
- Optional note: {
  content: string;
  }
  - content: string
    
    The note of the list item
Returns Promise<ListItem>
- Defined in lib/routes/Channels.ts:389

createMessage

createMessage(channelID: string, options: APIMessageOptions, params?: object): Promise<Message>
Parameters
- channelID: string
- options: APIMessageOptions
- Optional params: object
Returns Promise<Message>
- Defined in lib/routes/Channels.ts:190

createMessageReaction

createMessageReaction(channelID: string, messageID: string, reaction: number): Promise<void>
Parameters
- channelID: string
- messageID: string
- reaction: number
Returns Promise<void>
- Defined in lib/routes/Channels.ts:215

createTopic

createTopic(channelID: string, options: {
content: string;
title: string;
}): Promise<ForumThread>
Parameters
- channelID: string
- options: {
  content: string;
  title: string;
  }
  - content: string
  - title: string
Returns Promise<ForumThread>
- Defined in lib/routes/Channels.ts:229

createTopicComment

createTopicComment(channelID: string, topicID: number, options: {
content: string;
}): Promise<ForumThreadComment>
Parameters
- channelID: string
- topicID: number
- options: {
  content: string;
  }
  - content: string
Returns Promise<ForumThreadComment>
- Defined in lib/routes/Channels.ts:296

createTopicReaction

createTopicReaction(channelID: string, topicID: number, emoteID: number): Promise<void>
Parameters
- channelID: string
- topicID: number
- emoteID: number
Returns Promise<void>
- Defined in lib/routes/Channels.ts:282

deleteCalendarEvent

deleteCalendarEvent(channelID: string, eventID: number): Promise<void>
Parameters
- channelID: string
- eventID: number
Returns Promise<void>
- Defined in lib/routes/Channels.ts:366

deleteCalendarRsvp

deleteCalendarRsvp(channelID: string, eventID: number, memberID: string): Promise<void>
Parameters
- channelID: string
- eventID: number
- memberID: string
Returns Promise<void>
- Defined in lib/routes/Channels.ts:382

deleteDoc

deleteDoc(channelID: string, docID: number): Promise<void>
Parameters
- channelID: string
- docID: number
Returns Promise<void>
- Defined in lib/routes/Channels.ts:339

deleteListItem

deleteListItem(channelID: string, itemID: string): Promise<void>
Parameters
- channelID: string
- itemID: string
Returns Promise<void>
- Defined in lib/routes/Channels.ts:405

deleteMessage

deleteMessage(channelID: string, messageID: string): Promise<void>
Parameters
- channelID: string
- messageID: string
Returns Promise<void>
- Defined in lib/routes/Channels.ts:208

deleteMessageReaction

deleteMessageReaction(channelID: string, messageID: string, reaction: number): Promise<void>
Parameters
- channelID: string
- messageID: string
- reaction: number
Returns Promise<void>
- Defined in lib/routes/Channels.ts:222

deleteTopic

deleteTopic(channelID: string, topicID: number): Promise<void>
Parameters
- channelID: string
- topicID: number
Returns Promise<void>
- Defined in lib/routes/Channels.ts:247

deleteTopicComment

deleteTopicComment(channelID: string, topicID: number, commentID: number): Promise<void>
Parameters
- channelID: string
- topicID: number
- commentID: number
Returns Promise<void>
- Defined in lib/routes/Channels.ts:314

deleteTopicReaction

deleteTopicReaction(channelID: string, topicID: number, emoteID: number): Promise<void>
Parameters
- channelID: string
- topicID: number
- emoteID: number
Returns Promise<void>
- Defined in lib/routes/Channels.ts:289

editCalendarEvent

editCalendarEvent(channelID: string, eventID: number, options: PATCHCalendarEventBody): Promise<CalendarEvent>
Parameters
- channelID: string
- eventID: number
- options: PATCHCalendarEventBody
Returns Promise<CalendarEvent>
- Defined in lib/routes/Channels.ts:356

editCalendarRsvp

editCalendarRsvp(channelID: string, eventID: number, memberID: string, options: PUTCalendarEventRSVPBody): Promise<CalendarEventRSVP>
Parameters
- channelID: string
- eventID: number
- memberID: string
- options: PUTCalendarEventRSVPBody
Returns Promise<CalendarEventRSVP>
- Defined in lib/routes/Channels.ts:373

editDoc

editDoc(channelID: string, docID: number, options: {
content: string;
title: string;
}): Promise<Doc>
Parameters
- channelID: string
- docID: number
- options: {
  content: string;
  title: string;
  }
  - content: string
  - title: string
Returns Promise<Doc>
- Defined in lib/routes/Channels.ts:330

editListItem

editListItem(channelID: string, itemID: string, content: string, note?: {
content: string;
}): Promise<ListItem>
Parameters
- channelID: string
- itemID: string
- content: string
- Optional note: {
  content: string;
  }
  - content: string
    
    The note of the list item
Returns Promise<ListItem>
- Defined in lib/routes/Channels.ts:397

editMessage

editMessage(channelID: string, messageID: string, newMessage: APIMessageOptions, params?: object): Promise<Message>
Parameters
- channelID: string
- messageID: string
- newMessage: APIMessageOptions
- Optional params: object
Returns Promise<Message>
- Defined in lib/routes/Channels.ts:199

editTopic

editTopic(channelID: string, topicID: number, options: {
content?: string;
title?: string;
}): Promise<ForumThread>
Parameters
- channelID: string
- topicID: number
- options: {
  content?: string;
  title?: string;
  }
  - Optional content?: string
  - Optional title?: string
Returns Promise<ForumThread>
- Defined in lib/routes/Channels.ts:238

editTopicComment

editTopicComment(channelID: string, topicID: number, commentID: number, options?: {
content?: string;
}): Promise<ForumThreadComment>
Parameters
- channelID: string
- topicID: number
- commentID: number
- Optional options: {
  content?: string;
  }
  - Optional content?: string
Returns Promise<ForumThreadComment>
- Defined in lib/routes/Channels.ts:305

getCalendarEvent

getCalendarEvent(channelID: string, eventID: number): Promise<CalendarEvent>
Parameters
- channelID: string
- eventID: number
Returns Promise<CalendarEvent>
- Defined in lib/routes/Channels.ts:139

getCalendarEvents

getCalendarEvents(channelID: string, filter?: {
    after?: string;
    before?: string;
    limit?: number;
}): Promise<CalendarEvent[]>
Parameters
- channelID: string
- Optional filter: {
      after?: string;
      before?: string;
      limit?: number;
  }
  - Optional after?: string
  - Optional before?: string
  - Optional limit?: number
Returns Promise<CalendarEvent[]>
- Defined in lib/routes/Channels.ts:146

getCalendarRsvp

getCalendarRsvp(channelID: string, eventID: number, memberID: string): Promise<CalendarEventRSVP>
Parameters
- channelID: string
- eventID: number
- memberID: string
Returns Promise<CalendarEventRSVP>
- Defined in lib/routes/Channels.ts:160

getCalendarRsvps

getCalendarRsvps(channelID: string, eventID: number): Promise<CalendarEventRSVP[]>
Parameters
- channelID: string
- eventID: number
Returns Promise<CalendarEventRSVP[]>
- Defined in lib/routes/Channels.ts:167

getChannel

getChannel(channelID: string): Promise<Channel>
Parameters
- channelID: string
Returns Promise<Channel>
- Defined in lib/routes/Channels.ts:56

getDoc

getDoc(channelID: string, docID: number): Promise<Doc>
Parameters
- channelID: string
- docID: number
Returns Promise<Doc>
- Defined in lib/routes/Channels.ts:85

getDocs

getDocs(channelID: string, filter?: {
before?: string;
limit?: number;
}): Promise<Doc[]>
Parameters
- channelID: string
- Optional filter: {
  before?: string;
  limit?: number;
  }
  - Optional before?: string
  - Optional limit?: number
Returns Promise<Doc[]>
- Defined in lib/routes/Channels.ts:92

getForumTopic

getForumTopic(channelID: string, topicID: number): Promise<ForumThread>
Parameters
- channelID: string
- topicID: number
Returns Promise<ForumThread>
- Defined in lib/routes/Channels.ts:105

getForumTopics

getForumTopics(channelID: string, filter?: {
before?: string;
limit?: number;
}): Promise<ForumThread[]>
Parameters
- channelID: string
- Optional filter: {
  before?: string;
  limit?: number;
  }
  - Optional before?: string
  - Optional limit?: number
Returns Promise<ForumThread[]>
- Defined in lib/routes/Channels.ts:112

getListItem

getListItem(channelID: string, itemID: string): Promise<ListItem>
Parameters
- channelID: string
- itemID: string
Returns Promise<ListItem>
- Defined in lib/routes/Channels.ts:174

getListItems

getListItems(channelID: string): Promise<ListItem[]>
Parameters
- channelID: string
Returns Promise<ListItem[]>
- Defined in lib/routes/Channels.ts:181

getMessage

getMessage(channelID: string, messageID: string, params?: object): Promise<Message>
Parameters
- channelID: string
- messageID: string
- Optional params: object
Returns Promise<Message>
- Defined in lib/routes/Channels.ts:63

getMessages

getMessages(channelID: string, filter?: {
    after?: string;
    before?: string;
    includePrivate?: boolean;
    limit?: number;
}): Promise<Message[]>
Parameters
- channelID: string
- Optional filter: {
      after?: string;
      before?: string;
      includePrivate?: boolean;
      limit?: number;
  }
  - Optional after?: string
  - Optional before?: string
  - Optional includePrivate?: boolean
  - Optional limit?: number
Returns Promise<Message[]>
- Defined in lib/routes/Channels.ts:70

getTopicComment

getTopicComment(channelID: string, topicID: number, commentID: number): Promise<ForumThreadComment>
Parameters
- channelID: string
- topicID: number
- commentID: number
Returns Promise<ForumThreadComment>
- Defined in lib/routes/Channels.ts:125

getTopicComments

getTopicComments(channelID: string, topicID: number): Promise<ForumThreadComment[]>
Parameters
- channelID: string
- topicID: number
Returns Promise<ForumThreadComment[]>
- Defined in lib/routes/Channels.ts:132

lockTopic

lockTopic(channelID: string, topicID: number): Promise<void>
Parameters
- channelID: string
- topicID: number
Returns Promise<void>
- Defined in lib/routes/Channels.ts:268

pinTopic

pinTopic(channelID: string, topicID: number): Promise<void>
Parameters
- channelID: string
- topicID: number
Returns Promise<void>
- Defined in lib/routes/Channels.ts:254

uncompleteListItem

uncompleteListItem(channelID: string, itemID: string): Promise<void>
Parameters
- channelID: string
- itemID: string
Returns Promise<void>
- Defined in lib/routes/Channels.ts:419

unlockTopic

unlockTopic(channelID: string, topicID: number): Promise<void>
Parameters
- channelID: string
- topicID: number
Returns Promise<void>
- Defined in lib/routes/Channels.ts:275

unpinTopic

unpinTopic(channelID: string, topicID: number): Promise<void>
Parameters
- channelID: string
- topicID: number
Returns Promise<void>
- Defined in lib/routes/Channels.ts:261

Class Channels

Hierarchy

Index

Constructors

Methods

Constructors

constructor

Parameters

manager: RESTManager

Returns Channels

Methods

completeListItem

Parameters

channelID: string

itemID: string

Returns Promise<void>

createCalendarEvent

Parameters

channelID: string

options: POSTCalendarEventBody

Returns Promise<CalendarEvent>

createDoc

Parameters

channelID: string

options: { content: string; title: string; }

content: string

title: string

Returns Promise<Doc>

createListItem

Parameters

channelID: string

content: string

Optional note: { content: string; }

content: string

Returns Promise<ListItem>

createMessage

Parameters

channelID: string

options: APIMessageOptions

Optional params: object

Returns Promise<Message>

createMessageReaction

Parameters

channelID: string

messageID: string

reaction: number

Returns Promise<void>

createTopic

Parameters

channelID: string

options: { content: string; title: string; }

content: string

title: string

Returns Promise<ForumThread>

createTopicComment

Parameters

channelID: string

topicID: number

options: { content: string; }

content: string

Returns Promise<ForumThreadComment>

createTopicReaction

Parameters

channelID: string

topicID: number

emoteID: number

Returns Promise<void>

deleteCalendarEvent

Parameters

channelID: string

eventID: number

Returns Promise<void>

deleteCalendarRsvp

Parameters

channelID: string

eventID: number

memberID: string

Returns Promise<void>

deleteDoc

Parameters

options: {
content: string;
title: string;
}

`Optional` note: {
content: string;
}

`Optional` params: object

options: {
content: string;
title: string;
}

options: {
content: string;
}

options: {
content: string;
title: string;
}

`Optional` note: {
content: string;
}