BlockClientTemplate (aliyundrive-client-spring-boot-starter 0.0.6-alpha API)

java.lang.Object
- xyz.xuminghai.template.BlockClientTemplate

所有已实现的接口:

Executor
```
public class BlockClientTemplate
extends Object
```
2021/10/26 15:04 星期二
阻塞式客户端，适用于直接获取响应结果，对结果进行操作

作者:

xuMingHai

字段概要

字段
限定符和类型字段和说明

static String DEFAULT_TOP_DIRECTORY
阿里云盘默认的顶级目录

字段
限定符和类型	字段和说明
`static String`	`DEFAULT_TOP_DIRECTORY` 阿里云盘默认的顶级目录

构造器概要

构造器
构造器和说明

BlockClientTemplate(Cache cache, ReactiveFileDao reactiveFileDao, ReactiveRecycleDao reactiveRecycleDao)

构造器
构造器和说明
`BlockClientTemplate(Cache cache, ReactiveFileDao reactiveFileDao, ReactiveRecycleDao reactiveRecycleDao)`

方法概要

所有方法实例方法具体方法
限定符和类型	方法和说明
`CreateFolderResponse`	`createFolder(CreateFolderRequest createFolderRequest)` 创建文件夹
`CreateFolderResponse`	`createFolder(String name)` 创建文件夹，使用默认的同名策略，自动重命名，使用默认的顶级目录详细的请求参数请参考：`CreateFolderRequest`
`CreateFolderResponse`	`createFolder(String name, CheckNameEnum checkNameEnum)` 创建文件夹，在默认的顶级目录详细的请求参数请参考：`CreateFolderRequest`
`CreateFolderResponse`	`createFolder(String parentFileId, String name)` 创建文件夹，使用默认的同名策略，自动重命名详细的请求参数请参考：`CreateFolderRequest`
`CreateFolderResponse`	`createFolder(String parentFileId, String name, CheckNameEnum checkNameEnum)` 创建文件夹详细的请求参数请参考：`CreateFolderRequest`
`long`	`downloadFile(String fileId, Path path, OpenOption... openOptions)` 快速下载文件
`BaseItem`	`get(String fileId)` 获取单个文件或文件夹的信息
`Cache`	`getCache()` 获取缓存实例
`DownloadUrlResponse`	`getDownloadUrl(String fileId)` 获取这个文件的下载参数
`VideoPreviewPlayInfoResponse`	`getVideoPreviewPlayInfo(String fileId)` 获取视频播放的预览信息
`VideoPreviewPlayInfoResponse`	`getVideoPreviewPlayInfo(VideoPreviewPlayInfoRequest videoPreviewPlayInfoRequest)` 获取视频播放的预览信息
`ListResponse`	`list()` 获取顶级目录的文件列表顶级目录：`AbstractTemplate.DEFAULT_TOP_DIRECTORY`
`ListResponse`	`list(ListRequest listRequest)` 自定义请求参数的文件列表获取
`ListResponse`	`list(String folderId)` 根据文件夹ID查询这个文件夹下的文件信息详细请求配置请参考：`ListRequest`
`ListResponse`	`list(String folderId, OrderByEnum orderByEnum)` 根据文件夹ID，查询这个文件夹下的文件信息详细请求配置请参考：`ListRequest`
`ListResponse`	`list(String folderId, OrderByEnum orderByEnum, OrderDirectionEnum orderDirectionEnum)` 根据文件夹ID，查询这个文件夹下的文件信息详细请求配置请参考：`ListRequest`
`ListResponse`	`list(String folderId, OrderDirectionEnum orderDirectionEnum)` 根据文件夹ID，查询这个文件夹下的文件信息详细请求配置请参考：`ListRequest`
`SearchResponse`	`search(SearchRequest searchRequest)` 使用自定义的请求参数搜索文件
`SearchResponse`	`search(String fileName)` 根据文件名搜索所有类型的文件详细的请求配置请参考：`SearchRequest`
`SearchResponse`	`search(String fileName, CategoryEnum categoryEnum)` 根据文件名搜索指定类型的文件详细的请求配置请参考：`SearchRequest`
`SearchResponse`	`search(String fileName, CategoryEnum categoryEnum, OrderByEnum orderByEnum, OrderDirectionEnum orderDirectionEnum)` 根据文件名搜索文件详细的请求配置请参考：`SearchRequest`
`SearchResponse`	`search(String fileName, OrderByEnum orderByEnum, OrderDirectionEnum orderDirectionEnum)` 根据文件名搜索文件详细的请求配置请参考：`SearchRequest`
`Boolean`	`trash(String fileId)` 将文件或文件夹移入回收站
`BaseItem`	`update(String fileId, String newFileName)` 修改文件名或文件夹名
`BaseItem`	`update(UpdateRequest updateRequest)` 修改文件名或文件夹名
`CreateFileResponse`	`uploadFile(Path path)` 上传文件，使用默认的顶级目录、同名策略（支持快传和分片上传）
`CreateFileResponse`	`uploadFile(Path path, CheckNameEnum checkNameEnum)` 上传文件，使用默认的顶级目录（支持快传和分片上传）
`CreateFileResponse`	`uploadFile(String parentFileId, Path path)` 上传文件，使用默认的同名策略（支持快传和分片上传）
`CreateFileResponse`	`uploadFile(String parentFileId, Path path, CheckNameEnum checkNameEnum)` 上传文件（支持快传和分片上传）
`UploadFolderResponse`	`uploadFolder(Path path)` 上传文件夹
`UploadFolderResponse`	`uploadFolder(Path path, CheckNameEnum checkNameEnum)` 上传文件夹
`UploadFolderResponse`	`uploadFolder(String parentFileId, Path path)` 上传文件夹
`UploadFolderResponse`	`uploadFolder(String parentFileId, Path path, CheckNameEnum checkNameEnum)` 上传文件夹

从类继承的方法 java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- 字段详细资料
  - DEFAULT_TOP_DIRECTORY
```
public static final String DEFAULT_TOP_DIRECTORY
```
    阿里云盘默认的顶级目录
    
    另请参阅:
    
    常量字段值
- 构造器详细资料
  - BlockClientTemplate
```
public BlockClientTemplate(Cache cache,
                           ReactiveFileDao reactiveFileDao,
                           ReactiveRecycleDao reactiveRecycleDao)
```
- 方法详细资料
  - list
```
public ListResponse list()
```
    获取顶级目录的文件列表
    顶级目录：AbstractTemplate.DEFAULT_TOP_DIRECTORY
    
    返回:
    
    顶级目录下的文件列表
  - list
```
public ListResponse list(String folderId)
```
    根据文件夹ID查询这个文件夹下的文件信息
    详细请求配置请参考：ListRequest
    
    参数:
    
    folderId - 文件夹ID
    
    返回:
    
    文件列表响应
  - list
```
public ListResponse list(String folderId,
                         OrderByEnum orderByEnum)
```
    根据文件夹ID，查询这个文件夹下的文件信息
    详细请求配置请参考：ListRequest
    
    参数:
    
    folderId - 文件夹ID
    
    orderByEnum - 根据什么排序，如名称、创建时间。。。
    
    返回:
    
    文件列表响应
  - list
```
public ListResponse list(String folderId,
                         OrderDirectionEnum orderDirectionEnum)
```
    根据文件夹ID，查询这个文件夹下的文件信息
    详细请求配置请参考：ListRequest
    
    参数:
    
    folderId - 文件夹ID
    
    orderDirectionEnum - 排序方向，升序排列或降序
    
    返回:
    
    文件列表响应
  - list
```
public ListResponse list(String folderId,
                         OrderByEnum orderByEnum,
                         OrderDirectionEnum orderDirectionEnum)
```
    根据文件夹ID，查询这个文件夹下的文件信息
    详细请求配置请参考：ListRequest
    
    参数:
    
    folderId - 文件夹ID
    
    orderByEnum - 根据什么排序，如名称、创建时间。。。
    
    orderDirectionEnum - 排序方向，升序排列或降序
    
    返回:
    
    文件列表响应
  - list
```
public ListResponse list(ListRequest listRequest)
```
    自定义请求参数的文件列表获取
    
    参数:
    
    listRequest - 文件请求参数
    
    返回:
    
    文件列表响应
  - search
```
public SearchResponse search(String fileName)
```
    根据文件名搜索所有类型的文件
    详细的请求配置请参考：SearchRequest
    
    参数:
    
    fileName - 文件名
    
    返回:
    
    搜索响应结果。
  - search
```
public SearchResponse search(String fileName,
                             CategoryEnum categoryEnum)
```
    根据文件名搜索指定类型的文件
    详细的请求配置请参考：SearchRequest
    
    参数:
    
    fileName - 文件名
    
    categoryEnum - 搜索的文件类型，如，图片、视频。。。
    
    返回:
    
    搜索响应结果。
  - search
```
public SearchResponse search(String fileName,
                             OrderByEnum orderByEnum,
                             OrderDirectionEnum orderDirectionEnum)
```
    根据文件名搜索文件
    详细的请求配置请参考：SearchRequest
    
    参数:
    
    fileName - 文件名
    
    orderByEnum - 根据什么排序，如名称、创建时间。。。
    
    orderDirectionEnum - 排序方向，升序排列或降序
    
    返回:
    
    搜索响应结果。
  - search
```
public SearchResponse search(String fileName,
                             CategoryEnum categoryEnum,
                             OrderByEnum orderByEnum,
                             OrderDirectionEnum orderDirectionEnum)
```
    根据文件名搜索文件
    详细的请求配置请参考：SearchRequest
    
    参数:
    
    fileName - 文件名
    
    categoryEnum - 搜索的文件类型，如，图片、视频。。。
    
    orderByEnum - 根据什么排序，如名称、创建时间。。。
    
    orderDirectionEnum - 排序方向，如降序、升序
    
    返回:
    
    搜索响应结果
  - search
```
public SearchResponse search(SearchRequest searchRequest)
```
    使用自定义的请求参数搜索文件
    
    参数:
    
    searchRequest - 自定义搜索请求参数
    
    返回:
    
    搜索响应结果
  - get
```
public BaseItem get(String fileId)
```
    获取单个文件或文件夹的信息
    
    参数:
    
    fileId - 文件ID
    
    返回:
    
    文件信息（可以根据类型转为对应的子类）
  - getDownloadUrl
```
public DownloadUrlResponse getDownloadUrl(String fileId)
```
    获取这个文件的下载参数
    
    参数:
    
    fileId - 文件ID
    
    返回:
    
    这个文件的下载参数
  - downloadFile
```
public long downloadFile(String fileId,
                         Path path,
                         OpenOption... openOptions)
```
    快速下载文件
    
    参数:
    
    fileId - 文件ID
    
    path - 下载到的目标地址(不需要指定文件名)
    
    openOptions - 参数选项
    
    返回:
    
    文件字节数
  - createFolder
```
public CreateFolderResponse createFolder(String name)
```
    创建文件夹，使用默认的同名策略，自动重命名，使用默认的顶级目录
    详细的请求参数请参考：CreateFolderRequest
    
    参数:
    
    name - 文件夹名
    
    返回:
    
    响应信息
  - createFolder
```
public CreateFolderResponse createFolder(String parentFileId,
                                         String name)
```
    创建文件夹，使用默认的同名策略，自动重命名
    详细的请求参数请参考：CreateFolderRequest
    
    参数:
    
    parentFileId - 父目录ID
    
    name - 文件夹名
    
    返回:
    
    响应信息
  - createFolder
```
public CreateFolderResponse createFolder(String name,
                                         CheckNameEnum checkNameEnum)
```
    创建文件夹，在默认的顶级目录
    详细的请求参数请参考：CreateFolderRequest
    
    参数:
    
    name - 文件夹名
    
    checkNameEnum - 同名策略
    
    返回:
    
    响应信息
  - createFolder
```
public CreateFolderResponse createFolder(String parentFileId,
                                         String name,
                                         CheckNameEnum checkNameEnum)
```
    创建文件夹
    详细的请求参数请参考：CreateFolderRequest
    
    参数:
    
    parentFileId - 父目录ID
    
    name - 文件夹名
    
    checkNameEnum - 同名策略
    
    返回:
    
    响应信息
  - createFolder
```
public CreateFolderResponse createFolder(CreateFolderRequest createFolderRequest)
```
    创建文件夹
    
    参数:
    
    createFolderRequest - 创建文件夹请求
    
    返回:
    
    响应信息
  - uploadFile
```
public CreateFileResponse uploadFile(Path path)
```
    上传文件，使用默认的顶级目录、同名策略（支持快传和分片上传）
    
    参数:
    
    path - 文件路径
    
    返回:
    
    响应信息
  - uploadFile
```
public CreateFileResponse uploadFile(String parentFileId,
                                     Path path)
```
    上传文件，使用默认的同名策略（支持快传和分片上传）
    
    参数:
    
    parentFileId - 父目录ID
    
    path - 文件路径
    
    返回:
    
    响应信息
  - uploadFile
```
public CreateFileResponse uploadFile(Path path,
                                     CheckNameEnum checkNameEnum)
```
    上传文件，使用默认的顶级目录（支持快传和分片上传）
    
    参数:
    
    path - 文件路径
    
    checkNameEnum - 同名策略
    
    返回:
    
    响应信息
  - uploadFile
```
public CreateFileResponse uploadFile(String parentFileId,
                                     Path path,
                                     CheckNameEnum checkNameEnum)
```
    上传文件（支持快传和分片上传）
    
    参数:
    
    path - 文件路径
    
    parentFileId - 父目录ID
    
    checkNameEnum - 同名策略
    
    返回:
    
    响应信息
  - uploadFolder
```
public UploadFolderResponse uploadFolder(Path path)
```
    上传文件夹
    
    参数:
    
    path - 文件夹路径
    
    返回:
    
    上传文件夹的响应
  - uploadFolder
```
public UploadFolderResponse uploadFolder(String parentFileId,
                                         Path path)
```
    上传文件夹
    
    参数:
    
    path - 文件夹路径
    
    parentFileId - 父文件ID
    
    返回:
    
    上传文件夹的响应
  - uploadFolder
```
public UploadFolderResponse uploadFolder(Path path,
                                         CheckNameEnum checkNameEnum)
```
    上传文件夹
    
    参数:
    
    path - 文件夹路径
    
    checkNameEnum - 同名策略
    
    返回:
    
    上传文件夹的响应
  - uploadFolder
```
public UploadFolderResponse uploadFolder(String parentFileId,
                                         Path path,
                                         CheckNameEnum checkNameEnum)
```
    上传文件夹
    
    参数:
    
    parentFileId - 父文件ID
    
    path - 文件夹路径
    
    checkNameEnum - 同名策略
    
    返回:
    
    上传文件夹的响应
  - update
```
public BaseItem update(String fileId,
                       String newFileName)
```
    修改文件名或文件夹名
    
    参数:
    
    fileId - 文件ID
    
    newFileName - 新的文件名
    
    返回:
    
    响应信息
  - update
```
public BaseItem update(UpdateRequest updateRequest)
```
    修改文件名或文件夹名
    
    参数:
    
    updateRequest - 修改文件名请求参数
    
    返回:
    
    响应信息
  - trash
```
public Boolean trash(String fileId)
```
    将文件或文件夹移入回收站
    
    参数:
    
    fileId - 文件ID
    
    返回:
    
    响应信息
  - getVideoPreviewPlayInfo
```
public VideoPreviewPlayInfoResponse getVideoPreviewPlayInfo(VideoPreviewPlayInfoRequest videoPreviewPlayInfoRequest)
```
    获取视频播放的预览信息
    
    参数:
    
    videoPreviewPlayInfoRequest - 请求体
    
    返回:
    
    返回的响应
  - getVideoPreviewPlayInfo
```
public VideoPreviewPlayInfoResponse getVideoPreviewPlayInfo(String fileId)
```
    获取视频播放的预览信息
    
    参数:
    
    fileId - 文件ID
    
    返回:
    
    响应信息
  - getCache
```
public Cache getCache()
```
    获取缓存实例
    
    返回:
    
    缓存实例，如果没有开启缓存会返回空对象缓存

类 BlockClientTemplate

字段概要

构造器概要

方法概要

从类继承的方法 java.lang.Object

字段详细资料

DEFAULT_TOP_DIRECTORY

构造器详细资料

BlockClientTemplate

方法详细资料

list

list

list

list

list

list

search

search

search

search

search

get

getDownloadUrl

downloadFile

createFolder

createFolder

createFolder

createFolder

createFolder

uploadFile

uploadFile

uploadFile

uploadFile

uploadFolder

uploadFolder

uploadFolder

uploadFolder

update

update

trash

getVideoPreviewPlayInfo

getVideoPreviewPlayInfo

getCache