Source code for pyrogram.methods.messages.check_history_import

#  Pyrogram - Telegram MTProto API Client Library for Python
#  Copyright (C) 2017-present Dan <https://github.com/delivrance>
#
#  This file is part of Pyrogram.
#
#  Pyrogram is free software: you can redistribute it and/or modify
#  it under the terms of the GNU Lesser General Public License as published
#  by the Free Software Foundation, either version 3 of the License, or
#  (at your option) any later version.
#
#  Pyrogram is distributed in the hope that it will be useful,
#  but WITHOUT ANY WARRANTY; without even the implied warranty of
#  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
#  GNU Lesser General Public License for more details.
#
#  You should have received a copy of the GNU Lesser General Public License
#  along with Pyrogram.  If not, see <http://www.gnu.org/licenses/>.

from __future__ import annotations

import pyrogram
from pyrogram import raw


class CheckHistoryImport:
    async def check_history_import(
        self: pyrogram.Client,
        import_head: str,
    ) -> raw.base.messages.HistoryImportParsed:
        """Check if a chat history export file can be imported.

        .. include:: /_includes/usable-by/users.rst

        Parameters:
            import_head (``str``):
                The first part of the chat history export text (for format detection).

        Returns:
            :obj:`~pyrogram.raw.base.messages.HistoryImportParsed`: Info about the importable history.

        Example:
            .. code-block:: python

                result = await app.check_history_import("WhatsApp Chat with John\\n01/01/2023...")
        """
        return await self.invoke(raw.functions.messages.CheckHistoryImport(import_head=import_head))