screeps-api
    Preparing search index...

    Interface UserMessagesListResponse

    GET /api/user/messages/list response

    ScreepsHttpClient.userMessagesList

    interface UserMessagesListResponse {
        messages: {
            _id: string;
            date: string;
            text: string;
            type: "in" | "out";
            unread: boolean;
        }[];
        ok: 1;
    }

    Hierarchy (View Summary)

    Index

    Properties

    messages ok

    Properties

    messages: {
        _id: string;
        date: string;
        text: string;
        type: "in" | "out";
        unread: boolean;
    }[]

    Type Declaration

    • _id: string

      ID of the message

    • date: string

      ISO 8601 timestamp

    • text: string

      Message body

    • type: "in" | "out"

      incoming or outgoing

    • unread: boolean
    ok: 1

    An API success response always contains { ok: 1 }

    Settings

    Member Visibility

    On This Page

    Properties