osu-api-v2-js
    Preparing search index...

    Interface WithDetails

    API.sendChatPrivateMessage / API.createChatPrivateChannel

    interface WithDetails {
        channel_id: number;
        current_user_attributes: {
            can_list_users: boolean;
            can_message: boolean;
            can_message_error: null | string;
            last_read_id: null | number;
        };
        description: null
        | string;
        icon: null | string;
        last_message_id: number;
        message_length_limit: number;
        moderated: boolean;
        name: string;
        type:
            | "PUBLIC"
            | "PRIVATE"
            | "MULTIPLAYER"
            | "SPECTATOR"
            | "TEMPORARY"
            | "PM"
            | "GROUP"
            | "ANNOUNCE";
        users: number[];
        uuid: null
        | string;
    }

    Hierarchy (View Summary)

    Index

    Properties

    channel_id current_user_attributes description icon last_message_id message_length_limit moderated name type users uuid

    Properties

    channel_id: number
    current_user_attributes: {
        can_list_users: boolean;
        can_message: boolean;
        can_message_error: null | string;
        last_read_id: null | number;
    }

    Type declaration

    • can_list_users: boolean
    • can_message: boolean
    • can_message_error: null | string

      The reason why messages can't be sent in this channel

      Is null if messages can be sent

    • last_read_id: null | number

      Is null if no message has been read (I think)

    description: null | string
    icon: null | string
    last_message_id: number
    message_length_limit: number
    moderated: boolean
    name: string
    type:
        | "PUBLIC"
        | "PRIVATE"
        | "MULTIPLAYER"
        | "SPECTATOR"
        | "TEMPORARY"
        | "PM"
        | "GROUP"
        | "ANNOUNCE"
    users: number[]

    The ids of the users that are in the channel

    Is empty for public channels

    uuid: null | string

    Settings

    Member Visibility

    On This Page

    Properties