Class MessageController

Message controller.

Hierarchy

MessageController

Index

Constructors

constructor

Methods

Constructors

constructor

new MessageController(messageService: MessageService): MessageController

- Defined in src/controllers/message/message.controller.ts:30
Parameters
- messageService: MessageService
Returns MessageController

Methods

deleteMessage

deleteMessage(messageID: string, user: NBUser): Promise<void>

- Defined in src/controllers/message/message.controller.ts:131
Delete a message.

Parameters
- messageID: string
  
  The message ID.
- user: NBUser
  
  The user.
Returns Promise<void>

getMessage

getMessage(messageID: string, user: NBUser): Promise<NBMessage>

- Defined in src/controllers/message/message.controller.ts:59
Get a message.

Parameters
- messageID: string
  
  The message ID.
- user: NBUser
  
  The user.
Returns Promise<NBMessage>

The message.

getMessageHistory

getMessageHistory(userID: string, user: NBUser): Promise<NBMessage[]>

- Defined in src/controllers/message/message.controller.ts:95
Get message history with another user.

Parameters
- userID: string
  
  The user's ID.
- user: NBUser
  
  The user.
Returns Promise<NBMessage[]>

The message history with the other user.

getMessageThreads

getMessageThreads(user: NBUser): Promise<NBMessage[]>

- Defined in src/controllers/message/message.controller.ts:80
Get the user's message threads.

Parameters
- user: NBUser
  
  The user.
Returns Promise<NBMessage[]>

The user's message threads.

markRead

markRead(messageID: string, user: NBUser): Promise<void>

- Defined in src/controllers/message/message.controller.ts:110
Mark a message as read.

Parameters
- messageID: string
  
  The message ID.
- user: NBUser
  
  The user.
Returns Promise<void>

sendMessage

sendMessage(userID: string, content: string, user: NBUser): Promise<NBMessage>

- Defined in src/controllers/message/message.controller.ts:42
Send a message to another user.

Parameters
- userID: string
  
  The ID of the user to send the message to.
- content: string
  
  The message content.
- user: NBUser
  
  The user.
Returns Promise<NBMessage>

The new message.

Generated using TypeDoc