igpapi — Instagram private API Simulator for Node.js (API reference) 4.14.0
    Preparing search index...

    Interface DirectInboxActions

    The actions of DirectInboxScreen: the methods you call on its handle while the screen is open.

    interface DirectInboxActions {
        openNewMessage: (
            ...args: [],
        ) => Effect<
            AssembledHandle<
                "DirectRecipientPicker",
                "screen",
                {
                    recipients: readonly {
                        full_name: string;
                        pk: string;
                        username: string;
                    }[];
                    searchSessionId: string;
                    threads: readonly {
                        is_group: boolean;
                        muted?: boolean;
                        preview: readonly {
                            client_context?: string;
                            command_count?: number;
                            edit_count?: number;
                            item_id: string;
                            item_type: string;
                            media?: | {
                                height: number;
                                media_type: 1;
                                pk: string;
                                url: string;
                                width: number;
                            }
                            | {
                                height: number;
                                media_type: 2;
                                pk: string;
                                url: string;
                                width: number;
                            }
                            | { media_type: 8; pk: string; slides: readonly (...)[] };
                            message_ephemeral_lifetime_ms?: string;
                            text?: string;
                            timestamp: string;
                            user_id: string;
                        }[];
                        thread_id: string;
                        thread_title: string;
                        thread_v2_id?: string;
                        users: readonly {
                            fbid_v2?: string;
                            full_name: string;
                            pk: string;
                            username: string;
                        }[];
                    }[];
                },
                DirectRecipientPickerActions,
                DirectRecipientPickerItems,
                ScreenHandle,
                "required",
                true,
                never,
                AndroidScreens,
            >,
            | IgCheckpointError
            | IgAccountSuspendedError
            | IgAccountDisabledError
            | IgLoginRequiredError
            | IgUserLoggedOutError
            | ScreenEnterConcurrentError
            | ScreenDataError
            | ScreenEdgeInputError,
            never,
        >;
    }
    Index

    Properties

    Properties

    openNewMessage: (
        ...args: [],
    ) => Effect<
        AssembledHandle<
            "DirectRecipientPicker",
            "screen",
            {
                recipients: readonly {
                    full_name: string;
                    pk: string;
                    username: string;
                }[];
                searchSessionId: string;
                threads: readonly {
                    is_group: boolean;
                    muted?: boolean;
                    preview: readonly {
                        client_context?: string;
                        command_count?: number;
                        edit_count?: number;
                        item_id: string;
                        item_type: string;
                        media?: | {
                            height: number;
                            media_type: 1;
                            pk: string;
                            url: string;
                            width: number;
                        }
                        | {
                            height: number;
                            media_type: 2;
                            pk: string;
                            url: string;
                            width: number;
                        }
                        | { media_type: 8; pk: string; slides: readonly (...)[] };
                        message_ephemeral_lifetime_ms?: string;
                        text?: string;
                        timestamp: string;
                        user_id: string;
                    }[];
                    thread_id: string;
                    thread_title: string;
                    thread_v2_id?: string;
                    users: readonly {
                        fbid_v2?: string;
                        full_name: string;
                        pk: string;
                        username: string;
                    }[];
                }[];
            },
            DirectRecipientPickerActions,
            DirectRecipientPickerItems,
            ScreenHandle,
            "required",
            true,
            never,
            AndroidScreens,
        >,
        | IgCheckpointError
        | IgAccountSuspendedError
        | IgAccountDisabledError
        | IgLoginRequiredError
        | IgUserLoggedOutError
        | ScreenEnterConcurrentError
        | ScreenDataError
        | ScreenEdgeInputError,
        never,
    >

    Taps New message and opens the recipient picker. Answers the picker's handle.