Interface IModifyExtender

Hierarchy

IModifyExtender

Index

Methods

Methods

extendMessage

extendMessage(messageId: string, updater: IUser): Promise<IMessageExtender>

- Defined in accessors/IModify.ts:85
Modifies a message in a non-destructive way: Properties can be added to it, but existing properties cannot be changed.

Parameters
- messageId: string
  
  the id of the message to be extended
- updater: IUser
  
  the user who is updating/extending the message
Returns Promise<IMessageExtender>

the extender instance for the message

extendRoom

extendRoom(roomId: string, updater: IUser): Promise<IRoomExtender>

- Defined in accessors/IModify.ts:95
Modifies a room in a non-destructive way: Properties can be added to it, but existing properties cannot be changed.

Parameters
- roomId: string
  
  the id of the room to be extended
- updater: IUser
  
  the user who is updating/extending the room
Returns Promise<IRoomExtender>

the extender instance for the room

finish

finish(extender: IRoomExtender | IMessageExtender): Promise<void>

- Defined in accessors/IModify.ts:103
Finishes the extending process, saving the object to the database. Note: If there is an issue or error while updating, this will throw an error.

Parameters
- extender: IRoomExtender | IMessageExtender
  
  the extender instance
Returns Promise<void>

Generated using TypeDoc