Class Channels

Hierarchy

Channels

Constructors

constructor

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

Methods

completeListItem

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

createCalendarEvent

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

createDoc

createDoc(channelID: string, options: CreateDocOptions): Promise<Doc>
Parameters
- channelID: string
- options: CreateDocOptions
Returns Promise<Doc>
- Defined in lib/routes/Channels.ts:319

createForumComment

createForumComment(channelID: string, threadID: number, options: CreateForumCommentOptions): Promise<ForumThreadComment>
Parameters
- channelID: string
- threadID: number
- options: CreateForumCommentOptions
Returns Promise<ForumThreadComment>
- Defined in lib/routes/Channels.ts:294

createForumThread

createForumThread(channelID: string, options: CreateForumThreadOptions): Promise<ForumThread>
Parameters
- channelID: string
- options: CreateForumThreadOptions
Returns Promise<ForumThread>
- Defined in lib/routes/Channels.ts:241

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:387

createMessage

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

createReaction

createReaction(channelID: string, channelType: ChannelReactionTypes, messageID: string | number, reaction: number): Promise<void>
Parameters
- channelID: string
- channelType: ChannelReactionTypes
- messageID: string | number
- reaction: number
Returns Promise<void>
- Defined in lib/routes/Channels.ts:217

deleteCalendarEvent

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

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:380

deleteDoc

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

deleteForumComment

deleteForumComment(channelID: string, threadID: number, commentID: number): Promise<void>
Parameters
- channelID: string
- threadID: number
- commentID: number
Returns Promise<void>
- Defined in lib/routes/Channels.ts:312

deleteForumThread

deleteForumThread(channelID: string, threadID: number): Promise<void>
Parameters
- channelID: string
- threadID: number
Returns Promise<void>
- Defined in lib/routes/Channels.ts:259

deleteListItem

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

deleteMessage

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

deleteReaction

deleteReaction(channelID: string, channelType: ChannelReactionTypes, messageID: string | number, reaction: number): Promise<void>
Parameters
- channelID: string
- channelType: ChannelReactionTypes
- messageID: string | number
- reaction: number
Returns Promise<void>
- Defined in lib/routes/Channels.ts:229

editCalendarEvent

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

editCalendarRsvp

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

editDoc

editDoc(channelID: string, docID: number, options: EditDocOptions): Promise<Doc>
Parameters
- channelID: string
- docID: number
- options: EditDocOptions
Returns Promise<Doc>
- Defined in lib/routes/Channels.ts:328

editForumComment

editForumComment(channelID: string, threadID: number, commentID: number, options?: EditForumCommentOptions): Promise<ForumThreadComment>
Parameters
- channelID: string
- threadID: number
- commentID: number
- Optional options: EditForumCommentOptions
Returns Promise<ForumThreadComment>
- Defined in lib/routes/Channels.ts:303

editForumThread

editForumThread(channelID: string, threadID: number, options: EditForumThreadOptions): Promise<ForumThread>
Parameters
- channelID: string
- threadID: number
- options: EditForumThreadOptions
Returns Promise<ForumThread>
- Defined in lib/routes/Channels.ts:250

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:395

editMessage

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

getCalendarEvent

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

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:148

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:162

getCalendarRsvps

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

getChannel

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

getDoc

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

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:94

getForumComment

getForumComment(channelID: string, threadID: number, commentID: number): Promise<ForumThreadComment>
Parameters
- channelID: string
- threadID: number
- commentID: number
Returns Promise<ForumThreadComment>
- Defined in lib/routes/Channels.ts:127

getForumComments

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

getForumThread

getForumThread(channelID: string, threadID: number): Promise<ForumThread>
Parameters
- channelID: string
- threadID: number
Returns Promise<ForumThread>
- Defined in lib/routes/Channels.ts:107

getForumThreads

getForumThreads(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:114

getListItem

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

getListItems

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

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:65

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:72

lockForumThread

lockForumThread(channelID: string, threadID: number): Promise<void>
Parameters
- channelID: string
- threadID: number
Returns Promise<void>
- Defined in lib/routes/Channels.ts:280

pinForumThread

pinForumThread(channelID: string, threadID: number): Promise<void>
Parameters
- channelID: string
- threadID: number
Returns Promise<void>
- Defined in lib/routes/Channels.ts:266

uncompleteListItem

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

unlockForumThread

unlockForumThread(channelID: string, threadID: number): Promise<void>
Parameters
- channelID: string
- threadID: number
Returns Promise<void>
- Defined in lib/routes/Channels.ts:287

unpinForumThread

unpinForumThread(channelID: string, threadID: number): Promise<void>
Parameters
- channelID: string
- threadID: number
Returns Promise<void>
- Defined in lib/routes/Channels.ts:273

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: CreateCalendarEventOptions

Returns Promise<CalendarEvent>

createDoc

Parameters

channelID: string

options: CreateDocOptions

Returns Promise<Doc>

createForumComment

Parameters

channelID: string

threadID: number

options: CreateForumCommentOptions

Returns Promise<ForumThreadComment>

createForumThread

Parameters

channelID: string

options: CreateForumThreadOptions

Returns Promise<ForumThread>

createListItem

Parameters

channelID: string

content: string

Optional note: { content: string; }

content: string

Returns Promise<ListItem>

createMessage

Parameters

channelID: string

options: CreateMessageOptions

Optional params: object

Returns Promise<Message>

createReaction

Parameters

channelID: string

channelType: ChannelReactionTypes

messageID: string | number

reaction: 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

channelID: string

docID: number

Returns Promise<void>

deleteForumComment

Parameters

channelID: string

threadID: number

commentID: number

Returns Promise<void>

deleteForumThread

`Optional` note: {
content: string;
}

`Optional` params: object

`Optional` options: EditForumCommentOptions

`Optional` note: {
content: string;
}

`Optional` params: object