Class ForumDAO

Hierarchy

AbstractDAO
- ForumDAO

Index

Constructors

constructor

Accessors

http

Methods

Constructors

constructor

new ForumDAO(impl: ITwitarrHTTP | IHasHTTP): ForumDAO

Inherited from AbstractDAO.constructor
- Defined in dao/AbstractDAO.ts:11
Construct a DAO instance.

Parameters
- impl: ITwitarrHTTP | IHasHTTP
  
  The HTTP implementation to use. It is also legal to pass any object conforming to the IHasHTTP interface (like a Client).
Returns ForumDAO

Accessors

http

get http(): ITwitarrHTTP
set http(impl: ITwitarrHTTP): void

Inherited from AbstractDAO.http
- Defined in dao/AbstractDAO.ts:29
The HTTP implementation to use internally when making DAO requests.

Returns ITwitarrHTTP
Inherited from AbstractDAO.http
- Defined in dao/AbstractDAO.ts:33
The HTTP implementation to use internally when making DAO requests.

Parameters
- impl: ITwitarrHTTP
Returns void

Methods

create

create(subject: string, text: string, photos?: string[], as_mod?: boolean): Promise<ForumThread>

- Defined in dao/ForumDAO.ts:40
Create a new thread

Parameters
- subject: string
- text: string
- Optional photos: string[]
- Optional as_mod: boolean
Returns Promise<ForumThread>

deleteReact

deleteReact(threadId: string, postId: string, reaction: string): Promise<ReactionsSummary>

- Defined in dao/ForumDAO.ts:136
React to a post

Parameters
- threadId: string
- postId: string
- reaction: string
Returns Promise<ReactionsSummary>

get

get(id: string, page?: number, limit?: number): Promise<ForumThread>

- Defined in dao/ForumDAO.ts:60
Get a forum thread

Parameters
- id: string
- Optional page: number
- Optional limit: number
Returns Promise<ForumThread>

getPost

getPost(threadId: string, postId: string): Promise<ForumPost>

- Defined in dao/ForumDAO.ts:155
Get an individual thread post

Parameters
- threadId: string
- postId: string
Returns Promise<ForumPost>

Protected handleErrors

handleErrors(result: TwitarrResult<any>): any

Inherited from AbstractDAO.handleErrors
- Defined in dao/AbstractDAO.ts:37
Parameters
- result: TwitarrResult<any>
Returns any

list

list(page?: number, limit?: number): Promise<ForumResponse>

- Defined in dao/ForumDAO.ts:23
Get a list of forum threads.

Parameters
- Optional page: number
- Optional limit: number
Returns Promise<ForumResponse>

locked

locked(id: string, locked?: boolean): Promise<any>

- Defined in dao/ForumDAO.ts:116
Set locked status for a thread

Parameters
- id: string
- Optional locked: boolean
Returns Promise<any>

post

post(id: string, text: string, photos?: string[], as_mod?: boolean): Promise<ForumPost>

- Defined in dao/ForumDAO.ts:77
Post to a forum thread

Parameters
- id: string
- text: string
- Optional photos: string[]
- Optional as_mod: boolean
Returns Promise<ForumPost>

react

react(threadId: string, postId: string, reaction: string): Promise<ReactionsSummary>

- Defined in dao/ForumDAO.ts:126
React to a post

Parameters
- threadId: string
- postId: string
- reaction: string
Returns Promise<ReactionsSummary>

reactions

reactions(threadId: string, postId: string): Promise<any>

- Defined in dao/ForumDAO.ts:146
Get the list of reactions on a post

Parameters
- threadId: string
- postId: string
Returns Promise<any>

remove

remove(id: string): Promise<boolean>

- Defined in dao/ForumDAO.ts:96
Delete a thread (admin-only)

Parameters
- id: string
Returns Promise<boolean>

removePost

removePost(threadId: string, postId: string): Promise<boolean>

- Defined in dao/ForumDAO.ts:183
Delete an individual thread post

Parameters
- threadId: string
- postId: string
Returns Promise<boolean>

sticky

sticky(id: string, sticky?: boolean): Promise<any>

- Defined in dao/ForumDAO.ts:106
Set sticky status for a thread

Parameters
- id: string
- Optional sticky: boolean
Returns Promise<any>

updatePost

updatePost(threadId: string, postId: string, text?: string, photos?: string[]): Promise<ForumPost>

- Defined in dao/ForumDAO.ts:166
Get an individual thread post

Parameters
- threadId: string
- postId: string
- Optional text: string
- Optional photos: string[]
Returns Promise<ForumPost>

Generated using TypeDoc