mirror of
https://github.com/NodeBB/NodeBB.git
synced 2025-12-24 01:10:31 +01:00
4c4f3ac983
* feat: add direct message link /message/:mid add /:index? to chat routes add copy link to chat messages add messageCount to each room object add infinitescroll in both directions to chat * fix more tests * test: more text fixes * test: fix tests * remove async * dont crash if element not in dom clamp scrollToIndex values to 0, msgCount
214 lines
6.4 KiB
YAML
214 lines
6.4 KiB
YAML
RoomObject:
|
|
type: object
|
|
properties:
|
|
roomId:
|
|
type: number
|
|
description: unique identifier for the chat room
|
|
roomName:
|
|
type: string
|
|
description: the name of the room, if set this is displayed instead of the usernames
|
|
groupChat:
|
|
type: boolean
|
|
description: whether the chat room is a group chat or not (if more than 2 users it is a group chat)
|
|
public:
|
|
type: boolean
|
|
description: whether the chat room is public or private
|
|
userCount:
|
|
type: number
|
|
description: number of users in this chat room
|
|
messageCount:
|
|
type: number
|
|
description: number of messages sent in this chat room
|
|
groups:
|
|
type: array
|
|
description: list of groups that can access the room
|
|
timestamp:
|
|
type: number
|
|
description: Timestamp of when room was created
|
|
notificationSetting:
|
|
type: number
|
|
MessageObject:
|
|
type: object
|
|
properties:
|
|
content:
|
|
type: string
|
|
description: A chat message's content, parsed like a post (so probably outputs html)
|
|
timestamp:
|
|
type: number
|
|
fromuid:
|
|
type: number
|
|
roomId:
|
|
type: number
|
|
deleted:
|
|
type: number
|
|
system:
|
|
type: number
|
|
edited:
|
|
type: number
|
|
timestampISO:
|
|
type: string
|
|
editedISO:
|
|
type: string
|
|
mid:
|
|
type: number
|
|
messageId:
|
|
type: number
|
|
isOwner:
|
|
type: boolean
|
|
fromUser:
|
|
type: object
|
|
properties:
|
|
uid:
|
|
type: number
|
|
description: A user identifier
|
|
username:
|
|
type: string
|
|
description: A friendly name for a given user account
|
|
example: Dragon Fruit
|
|
userslug:
|
|
type: string
|
|
description: An URL-safe variant of the username (i.e. lower-cased, spaces removed, etc.)
|
|
example: dragon-fruit
|
|
picture:
|
|
type: string
|
|
nullable: true
|
|
description: A URL pointing to a picture to be used as the user's avatar
|
|
example: 'https://images.unsplash.com/photo-1560070094-e1f2ddec4337?ixlib=rb-1.2.1&ixid=eyJhcHBfaWQiOjEyMDd9&auto=format&fit=crop&w=256&h=256&q=80'
|
|
status:
|
|
type: string
|
|
enum:
|
|
- online
|
|
- offline
|
|
- dnd
|
|
- away
|
|
banned:
|
|
type: boolean
|
|
description: Whether a user is banned or not
|
|
example: false
|
|
displayname:
|
|
type: string
|
|
description: This is either username or fullname depending on forum and user settings
|
|
example: Dragon Fruit
|
|
icon:text:
|
|
type: string
|
|
description: A single-letter representation of a username. This is used in the
|
|
auto-generated icon given to users
|
|
without an avatar
|
|
icon:bgColor:
|
|
type: string
|
|
description: A six-character hexadecimal colour code assigned to the user. This
|
|
value is used in conjunction with
|
|
`icon:text` for the user's
|
|
auto-generated icon
|
|
example: "#f44336"
|
|
banned_until_readable:
|
|
type: string
|
|
description: An ISO 8601 formatted date string representing the moment a ban will be lifted, or the words "Not Banned"
|
|
example: Not Banned
|
|
deleted:
|
|
type: boolean
|
|
self:
|
|
type: number
|
|
newSet:
|
|
type: boolean
|
|
RoomUserList:
|
|
type: object
|
|
properties:
|
|
users:
|
|
type: array
|
|
items:
|
|
type: object
|
|
properties:
|
|
uid:
|
|
type: number
|
|
description: A user identifier
|
|
username:
|
|
type: string
|
|
description: A friendly name for a given user account
|
|
picture:
|
|
nullable: true
|
|
type: string
|
|
status:
|
|
type: string
|
|
displayname:
|
|
type: string
|
|
description: This is either username or fullname depending on forum and user settings
|
|
icon:text:
|
|
type: string
|
|
description: A single-letter representation of a username. This is used in the
|
|
auto-generated icon given to users
|
|
without an avatar
|
|
icon:bgColor:
|
|
type: string
|
|
description: A six-character hexadecimal colour code assigned to the user. This
|
|
value is used in conjunction with
|
|
`icon:text` for the user's
|
|
auto-generated icon
|
|
example: "#f44336"
|
|
isOwner:
|
|
type: boolean
|
|
canKick:
|
|
type: boolean
|
|
canToggleOwner:
|
|
type: boolean
|
|
index:
|
|
type: number
|
|
online:
|
|
type: boolean
|
|
RoomObjectFull:
|
|
# Messaging.loadRoom
|
|
allOf:
|
|
- $ref: '#/RoomObject'
|
|
- $ref: '#/MessageObject'
|
|
- type: object
|
|
properties:
|
|
isOwner:
|
|
type: boolean
|
|
users:
|
|
type: array
|
|
items:
|
|
type: object
|
|
properties:
|
|
uid:
|
|
type: number
|
|
description: A user identifier
|
|
username:
|
|
type: string
|
|
description: A friendly name for a given user account
|
|
picture:
|
|
nullable: true
|
|
type: string
|
|
status:
|
|
type: string
|
|
displayname:
|
|
type: string
|
|
description: This is either username or fullname depending on forum and user settings
|
|
icon:text:
|
|
type: string
|
|
description: A single-letter representation of a username. This is used in the
|
|
auto-generated icon given to users
|
|
without an avatar
|
|
icon:bgColor:
|
|
type: string
|
|
description: A six-character hexadecimal colour code assigned to the user. This
|
|
value is used in conjunction with
|
|
`icon:text` for the user's
|
|
auto-generated icon
|
|
example: "#f44336"
|
|
isOwner:
|
|
type: boolean
|
|
canReply:
|
|
type: boolean
|
|
groupChat:
|
|
type: boolean
|
|
usernames:
|
|
type: string
|
|
description: User-friendly depiction of the users within the chat room
|
|
maximumUsersInChatRoom:
|
|
type: number
|
|
maximumChatMessageLength:
|
|
type: number
|
|
showUserInput:
|
|
type: boolean
|
|
isAdminOrGlobalMod:
|
|
type: boolean |