FoxoChat.js Packages
    Preparing search index...

    Interface APIUser<Short>

    API User DTO.

    interface APIUser<Short extends boolean = false> {
        avatar: null | APIAvatar;
        banner: Short extends false ? null | APIAvatar : never;
        bio: Short extends false ? string : never;
        channels: Short extends false ? number[] : never;
        contacts: Short extends false ? number[] : never;
        created_at: Short extends false ? number : never;
        display_name: string;
        email?: Short extends false ? string : never;
        flags: Short extends false ? UserFlags : never;
        id: number;
        status: UserStatus;
        status_updated_at: number;
        type: Short extends false ? UserType : never;
        username: string;
    }

    Type Parameters

    • Short extends boolean = false
    Index

    Properties

    avatar banner bio channels contacts created_at display_name email? flags id status status_updated_at type username

    Properties

    avatar: null | APIAvatar

    The avatar of the user.

    banner: Short extends false ? null | APIAvatar : never

    The banner of the user.

    bio: Short extends false ? string : never

    The bio of the user.

    channels: Short extends false ? number[] : never

    The channels of the user.

    contacts: Short extends false ? number[] : never

    The contacts of the user.

    created_at: Short extends false ? number : never

    The time when user created at.

    display_name: string

    The display name of the user.

    email?: Short extends false ? string : never

    The email of the user.

    flags: Short extends false ? UserFlags : never

    The flags of the user.

    id: number

    The id of the user.

    status: UserStatus

    The status of the user.

    status_updated_at: number

    The timestamp when the user's status was last updated.

    type: Short extends false ? UserType : never

    The type of the user.

    username: string

    The username of the user.

    Settings

    Member Visibility

    On This Page

    Properties