Class MessageService

Message table service.

Hierarchy

MessageService

Index

Constructors

constructor

Methods

Constructors

constructor

new MessageService(dbService: DBService, resourceService: ResourceService, userService: UserService, blockService: BlockService): MessageService

- Defined in src/services/message/message.service.ts:24
Parameters
- dbService: DBService
- resourceService: ResourceService
- userService: UserService
- blockService: BlockService
Returns MessageService

Methods

deleteMessage

deleteMessage(messageID: string): Promise<void>

- Defined in src/services/message/message.service.ts:248
Delete a message.

Parameters
- messageID: string
  
  The message's ID.
Returns Promise<void>

deleteOldMessages

deleteOldMessages(fromUserID: string, toUserID: string): Promise<void>

- Defined in src/services/message/message.service.ts:255
Delete old messages.

Parameters
- fromUserID: string
- toUserID: string
Returns Promise<void>

getMessage

getMessage(messageID: string): Promise<NBMessage>

- Defined in src/services/message/message.service.ts:105
Get a message.

Parameters
- messageID: string
  
  The message's ID.
Returns Promise<NBMessage>

The message record.

getMessageThreads

getMessageThreads(userID: string): Promise<NBMessage[]>

- Defined in src/services/message/message.service.ts:124
Get a user's message threads.

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

getMessages

getMessages(userID1: string, userID2: string): Promise<NBMessage[]>

- Defined in src/services/message/message.service.ts:160
Get message history for two users.

Parameters
- userID1: string
  
  One user's ID.
- userID2: string
  
  Another user's ID.
Returns Promise<NBMessage[]>

Messages exchanged between two users.

markRead

markRead(messageID: string): Promise<NBMessage>

- Defined in src/services/message/message.service.ts:185
Mark a message as read.

Parameters
- messageID: string
  
  The message's ID.
Returns Promise<NBMessage>

The updated message record.

markUnread

markUnread(messageID: string): Promise<NBMessage>

- Defined in src/services/message/message.service.ts:217
Mark a message as unread.

Parameters
- messageID: string
  
  The message's ID.
Returns Promise<NBMessage>

The updated message record.

messageExists

messageExists(messageID: string): Promise<boolean>

- Defined in src/services/message/message.service.ts:91
Determine whether or not a message exists.

Parameters
- messageID: string
  
  The message's ID.
Returns Promise<boolean>

Whether or not the message exists.

sendMessage

sendMessage(fromUserID: string, toUserID: string, content: string): Promise<NBMessage>

- Defined in src/services/message/message.service.ts:43
Send a message.

Parameters
- fromUserID: string
  
  The ID of the user sending the message.
- toUserID: string
  
  The ID of the user receiving the message.
- content: string
  
  The message content.
Returns Promise<NBMessage>

The new message record.

Generated using TypeDoc