Offline 类

离线下载

Offline

Source code in src/cpan123/Offline.py

class Offline:
    def __init__(self, auth: Auth, userinfo: UserInfoModel | None = None) -> None:
        """初始化

        Args:
            auth (Auth): 已授权的 Auth 实例

        """
        self.auth = auth
        self.userinfo = userinfo

    @validate_call
    def download(
        self,
        url: str,
        fileName: Optional[str] = None,
        dirID: Optional[int] = None,
        callBackUrl: Optional[str] = None,
    ) -> dict:
        """
        创建离线下载任务


        Args:
            url: 下载链接
            fileName: 自定义文件名称 (需携带图片格式,支持格式:png, gif, jpeg, tiff, webp,jpg,tif,svg,bmp)
            dirID: 选择下载到指定目录ID.  示例:10023, 注:不支持下载到根目录,默认会下载到名为"来自:离线下载"的目录中
            callBackUrl: 回调地址,当文件下载成功或者失败,均会通过回调地址通知.
        """
        data = {
            "url": url,
            "fileName": fileName,
            "dirID": dirID,
            "callBackUrl": callBackUrl,
        }
        return self.auth.request_json("POST", API.OfflinePath.DOWNLOAD, json=data)

    @validate_call
    def process(self, taskID: int) -> dict:
        """
        获取离线下载进度

        Args:
            taskID: 离线下载任务ID
        """
        params = {
            "taskID": taskID,
        }
        return self.auth.request_json("GET", API.OfflinePath.DOWNLOAD_PROCESS, params=params)

__init__

__init__(
    auth: Auth, userinfo: UserInfoModel | None = None
) -> None

初始化

Parameters:

Name	Type	Description	Default
auth	Auth	已授权的 Auth 实例	required

Source code in src/cpan123/Offline.py

def __init__(self, auth: Auth, userinfo: UserInfoModel | None = None) -> None:
    """初始化

    Args:
        auth (Auth): 已授权的 Auth 实例

    """
    self.auth = auth
    self.userinfo = userinfo

download

download(
    url: str,
    fileName: Optional[str] = None,
    dirID: Optional[int] = None,
    callBackUrl: Optional[str] = None,
) -> dict

创建离线下载任务

Parameters:

Name	Type	Description	Default
url	str	下载链接	required
fileName	Optional[str]	自定义文件名称 (需携带图片格式,支持格式:png, gif, jpeg, tiff, webp,jpg,tif,svg,bmp)	None
dirID	Optional[int]	选择下载到指定目录ID. 示例:10023, 注:不支持下载到根目录,默认会下载到名为"来自:离线下载"的目录中	None
callBackUrl	Optional[str]	回调地址,当文件下载成功或者失败,均会通过回调地址通知.	None

Source code in src/cpan123/Offline.py

@validate_call
def download(
    self,
    url: str,
    fileName: Optional[str] = None,
    dirID: Optional[int] = None,
    callBackUrl: Optional[str] = None,
) -> dict:
    """
    创建离线下载任务


    Args:
        url: 下载链接
        fileName: 自定义文件名称 (需携带图片格式,支持格式:png, gif, jpeg, tiff, webp,jpg,tif,svg,bmp)
        dirID: 选择下载到指定目录ID.  示例:10023, 注:不支持下载到根目录,默认会下载到名为"来自:离线下载"的目录中
        callBackUrl: 回调地址,当文件下载成功或者失败,均会通过回调地址通知.
    """
    data = {
        "url": url,
        "fileName": fileName,
        "dirID": dirID,
        "callBackUrl": callBackUrl,
    }
    return self.auth.request_json("POST", API.OfflinePath.DOWNLOAD, json=data)

process

process(taskID: int) -> dict

获取离线下载进度

Parameters:

Name	Type	Description	Default
taskID	int	离线下载任务ID	required

Source code in src/cpan123/Offline.py

@validate_call
def process(self, taskID: int) -> dict:
    """
    获取离线下载进度

    Args:
        taskID: 离线下载任务ID
    """
    params = {
        "taskID": taskID,
    }
    return self.auth.request_json("GET", API.OfflinePath.DOWNLOAD_PROCESS, params=params)