philia
    Preparing search index...

    Class default

    Index

    Constructors

    constructor

    Properties

    api cache event_handle handle logger path? philia protocol queue timeout ws

    Accessors

    open

    Methods

    close listener message request sendQueue

    Constructors

    Properties

    api: {
        clean_cache: (data?: void) => Promise<void>;
        delete_friend: (data: { user_id: number }) => Promise<void>;
        delete_msg: (data: { message_id: number }) => Promise<void>;
        download_file: (
            data: {
                base64?: string;
                file?: string;
                headers?: string | string[];
                thread_count?: number;
            },
        ) => Promise<{ file: string }>;
        get_forward_msg: (
            data: { message_id: number },
        ) => Promise<{ message: Message[] }>;
        get_friend_list: (
            data?: void,
        ) => Promise<
            {
                age: number;
                avatar?: string;
                level: number;
                login_days: number;
                nickname: string;
                qid: string;
                remark?: string;
                sex: "unknown"
                | "male"
                | "female";
                user_id: number;
            }[],
        >;
        get_friend_msg_history: (
            data: { count?: number; message_seq?: number; user_id: number },
        ) => Promise<{ messages: Message[] }>;
        get_group_info: (
            data: { group_id: number; no_cache?: boolean },
        ) => Promise<
            {
                avatar?: string;
                group_create_time: number;
                group_id: number;
                group_level: number;
                group_memo: string;
                group_name: string;
                max_member_count: number;
                member_count: number;
            },
        >;
        get_group_list: (
            data?: void,
        ) => Promise<
            {
                avatar?: string;
                group_create_time: number;
                group_id: number;
                group_level: number;
                group_memo: string;
                group_name: string;
                max_member_count: number;
                member_count: number;
            }[],
        >;
        get_group_member_info: (
            data: { group_id: number; no_cache?: boolean; user_id: number },
        ) => Promise<
            {
                age: number;
                avatar?: string;
                card: string;
                card_changeable: boolean;
                group_id: number;
                join_time: number;
                last_sent_time: number;
                level: number;
                nickname: string;
                role: "owner"
                | "admin"
                | "member";
                sex: "unknown" | "male" | "female";
                shut_up_timestamp: number;
                title: string;
                title_expire_time: number;
                unfriendly: boolean;
                user_id: number;
            },
        >;
        get_group_member_list: (
            data: { group_id: number },
        ) => Promise<
            {
                age: number;
                avatar?: string;
                card: string;
                card_changeable: boolean;
                group_id: number;
                join_time: number;
                last_sent_time: number;
                level: number;
                nickname: string;
                role: "owner"
                | "admin"
                | "member";
                sex: "unknown" | "male" | "female";
                shut_up_timestamp: number;
                title: string;
                title_expire_time: number;
                unfriendly: boolean;
                user_id: number;
            }[],
        >;
        get_group_msg_history: (
            data: { count?: number; group_id: number; message_seq?: number },
        ) => Promise<{ messages: Message[] }>;
        get_login_info: (
            data?: void,
        ) => Promise<{ avatar?: string; nickname: string; user_id: number }>;
        get_msg: (data: { message_id: number }) => Promise<Message>;
        get_stranger_info: (
            data: { no_cache?: boolean; user_id: number },
        ) => Promise<
            {
                age: number;
                avatar?: string;
                level: number;
                login_days: number;
                nickname: string;
                qid: string;
                remark?: string;
                sex: "unknown"
                | "male"
                | "female";
                user_id: number;
            },
        >;
        get_version_info: (
            data?: void,
        ) => Promise<
            {
                app_full_name: string;
                app_name: string;
                app_version: string;
                protocol_version: string;
            },
        >;
        send_group_forward_msg: (
            data: { group_id: number; messages: ForwardNode[] },
        ) => Promise<{ forward_id: number; message_id: number }>;
        send_msg: (
            data: {
                group_id?: number;
                message: MessageSegment[];
                user_id?: number;
            },
        ) => Promise<{ message_id: number }>;
        send_private_forward_msg: (
            data: { messages: ForwardNode[]; user_id: number },
        ) => Promise<{ forward_id: number; message_id: number }>;
        set_friend_add_request: (
            data: { approve?: boolean; flag: string; remark?: string },
        ) => Promise<void>;
        set_friend_remark: (
            data: { remark: string; user_id: number },
        ) => Promise<void>;
        set_group_add_request: (
            data: { approve?: boolean; flag: string; reason?: string },
        ) => Promise<void>;
        set_group_admin: (
            data: { enable: boolean; group_id: number; user_id: number },
        ) => Promise<void>;
        set_group_ban: (
            data: { duration: number; group_id: number; user_id: number },
        ) => Promise<void>;
        set_group_card: (
            data: { card: string; group_id: number; user_id: number },
        ) => Promise<void>;
        set_group_kick: (
            data: {
                group_id: number;
                reject_add_request?: boolean;
                user_id: number;
            },
        ) => Promise<void>;
        set_group_leave: (
            data: { group_id: number; is_dismiss?: boolean },
        ) => Promise<void>;
        set_group_name: (
            data: { group_id: number; group_name: string },
        ) => Promise<void>;
        set_group_portrait: (
            data: { file: string; group_id: number },
        ) => Promise<void>;
        set_group_remark: (
            data: { group_id: number; remark: string },
        ) => Promise<void>;
        set_group_special_title: (
            data: { group_id: number; special_title: string; user_id: number },
        ) => Promise<void>;
        set_group_whole_ban: (
            data: { enable?: boolean; group_id: number },
        ) => Promise<void>;
        set_qq_avatar: (data: { file: string }) => Promise<void>;
        set_qq_profile: (
            data: { nickname: string; personal_note?: string },
        ) => Promise<void>;
        upload_group_file: (
            data: { file: string; folder?: string; group_id: number; name: string },
        ) => Promise<void>;
        upload_private_file: (
            data: { file: string; name: string; user_id: number },
        ) => Promise<void>;
    } = ...
    cache: Map<
        string,
        PromiseWithResolvers<
            | void
            | Message
            | {
                app_full_name: string;
                app_name: string;
                app_version: string;
                protocol_version: string;
            }
            | { avatar?: string; nickname: string; user_id: number }
            | {
                age: number;
                avatar?: string;
                level: number;
                login_days: number;
                nickname: string;
                qid: string;
                remark?: string;
                sex: "unknown" | "male" | "female";
                user_id: number;
            }
            | {
                avatar?: string;
                group_create_time: number;
                group_id: number;
                group_level: number;
                group_memo: string;
                group_name: string;
                max_member_count: number;
                member_count: number;
            }
            | {
                age: number;
                avatar?: string;
                card: string;
                card_changeable: boolean;
                group_id: number;
                join_time: number;
                last_sent_time: number;
                level: number;
                nickname: string;
                role: "owner"
                | "admin"
                | "member";
                sex: "unknown" | "male" | "female";
                shut_up_timestamp: number;
                title: string;
                title_expire_time: number;
                unfriendly: boolean;
                user_id: number;
            }
            | { message_id: number }
            | { forward_id: number; message_id: number }
            | { forward_id: number; message_id: number }
            | { message: Message[] }
            | {
                age: number;
                avatar?: string;
                level: number;
                login_days: number;
                nickname: string;
                qid: string;
                remark?: string;
                sex: "unknown" | "male" | "female";
                user_id: number;
            }[]
            | {
                avatar?: string;
                group_create_time: number;
                group_id: number;
                group_level: number;
                group_memo: string;
                group_name: string;
                max_member_count: number;
                member_count: number;
            }[]
            | {
                age: number;
                avatar?: string;
                card: string;
                card_changeable: boolean;
                group_id: number;
                join_time: number;
                last_sent_time: number;
                level: number;
                nickname: string;
                role: "owner"
                | "admin"
                | "member";
                sex: "unknown" | "male" | "female";
                shut_up_timestamp: number;
                title: string;
                title_expire_time: number;
                unfriendly: boolean;
                user_id: number;
            }[]
            | { file: string }
            | { messages: Message[] }
            | { messages: Message[] },
        > & { request: Request; timeout: Timeout },
    > = ...
    event_handle: default
    handle: PhiliaToOBv11 = ...
    logger: Logger
    path?: string
    philia: Project
    protocol: default = ...
    queue: string[] = []
    timeout: number = 6e4
    ws: WebSocket

    Accessors

    Methods

    • Type Parameters

      • T extends keyof IAPI

      Parameters

      • action: T
      • params: {} = {}

      Returns Promise<
          | void
          | Message
          | {
              app_full_name: string;
              app_name: string;
              app_version: string;
              protocol_version: string;
          }
          | { avatar?: string; nickname: string; user_id: number }
          | {
              age: number;
              avatar?: string;
              level: number;
              login_days: number;
              nickname: string;
              qid: string;
              remark?: string;
              sex: "unknown" | "male" | "female";
              user_id: number;
          }
          | {
              avatar?: string;
              group_create_time: number;
              group_id: number;
              group_level: number;
              group_memo: string;
              group_name: string;
              max_member_count: number;
              member_count: number;
          }
          | {
              age: number;
              avatar?: string;
              card: string;
              card_changeable: boolean;
              group_id: number;
              join_time: number;
              last_sent_time: number;
              level: number;
              nickname: string;
              role: "owner"
              | "admin"
              | "member";
              sex: "unknown" | "male" | "female";
              shut_up_timestamp: number;
              title: string;
              title_expire_time: number;
              unfriendly: boolean;
              user_id: number;
          }
          | { message_id: number }
          | { forward_id: number; message_id: number }
          | { forward_id: number; message_id: number }
          | { message: Message[] }
          | {
              age: number;
              avatar?: string;
              level: number;
              login_days: number;
              nickname: string;
              qid: string;
              remark?: string;
              sex: "unknown" | "male" | "female";
              user_id: number;
          }[]
          | {
              avatar?: string;
              group_create_time: number;
              group_id: number;
              group_level: number;
              group_memo: string;
              group_name: string;
              max_member_count: number;
              member_count: number;
          }[]
          | {
              age: number;
              avatar?: string;
              card: string;
              card_changeable: boolean;
              group_id: number;
              join_time: number;
              last_sent_time: number;
              level: number;
              nickname: string;
              role: "owner"
              | "admin"
              | "member";
              sex: "unknown" | "male" | "female";
              shut_up_timestamp: number;
              title: string;
              title_expire_time: number;
              unfriendly: boolean;
              user_id: number;
          }[]
          | { file: string }
          | { messages: Message[] }
          | { messages: Message[] },
      >

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    Accessors
    Methods