Fetch One

/api/v2/room/fetch/one

Post

rooms

jwt

Purpose

To allow a user to fetch a chat room that he/she is a member of or to have some details it if it is otherwise public.

Body Content [input]

{
    uid: string,
    roomID: string
}

Returns if valid [output]

{
    roomID: string,
    name: string,
    description: string,
    privacy: string,
    icon: string,
    members: {
        uid: string,
        is_admin: bool,
        status: string
    }[],
    messages: [],
    threads: [],
    error: 0
}

What the API does

• Finds all records from the rooms collection.
• Filters out all records not having a uid in the members field corresponding to the one passed if they have a value of private for their privacy field.
• Finds the room being referenced using the value of the roomID field passed [404].
• Removes the has_muted field for each record in their members field.
• Replaces the value of the message field in messages and threads by an empty string if the value in the is_deleted field is set to true.
• Sets empty values for members if uid does not correspond to a record in the members field with a status of accepted.
• Sets empty values for the messages and threads fields.