Options
All
  • Public
  • Public/Protected
  • All
Menu

Class MH

媒资托管客户端。该类和命名空间使用名字 MediaHosting 导出：

export { MH as MediaHosting };

Hierarchy

  • MH

Index

Classes

Interfaces

Type aliases

Constructors

Properties

Accessors

Methods

Type aliases

Static AllowModifiedSpaceExtension

AllowModifiedSpaceExtension: Pick<SpaceExtension, AllowModifiedExtensionFields>

允许随后修改的租户空间扩展选项

Static CreateSpaceCallback

CreateSpaceCallback: RequestCallback<CreateSpaceResult>

完成创建租户空间的回调函数

Static GetAccessTokenCallback

GetAccessTokenCallback: GeneralCallback<AccessToken>

完成获取访问令牌函数的回调函数

Static GetMultiSpaceAccessTokenCallback

GetMultiSpaceAccessTokenCallback: GeneralCallback<MultiSpaceAccessToken>

完成获取可用于多个指定租户空间的访问令牌函数的回调函数

Static GetUrlCallback

GetUrlCallback: GeneralCallback<string[]>

完成获取 URL 的回调函数

Static ListDirectoryCallback

ListDirectoryCallback: GeneralCallback<ListDirectoryResult>

完成列出目录的回调函数

Static ListDirectoryResult

ListDirectoryResult: Omit<ListDirectoryWithPaginationResult, "nextMarker">

成功列出的目录内容信息

Static ListDirectoryWithPaginationCallback

ListDirectoryWithPaginationCallback: RequestCallback<ListDirectoryWithPaginationResult>

完成分页列出指定目录的回调函数

Static RequestCallback

RequestCallback<T>: GeneralCallback<RequestResult<T>>

完成请求的回调函数

Type parameters

  • T = ""

Static UploadCallback

UploadCallback: RequestCallback<UploadResult>

完成上传、重命名移动的回调函数

Constructors

constructor

  • 实例化媒资托管客户端

    Parameters

    Returns MH

Properties

Readonly libraryId

libraryId: string

获取当前指定的媒体库 ID

Static getMultiSpaceAccessToken

getMultiSpaceAccessToken: GetMultiSpaceAccessTokenFunc

Accessors

spaceId

  • get spaceId(): string
  • set spaceId(value: string): void

  • 获取当前指定的租户空间 ID

    Returns string

  • 设置租户空间 ID

    Parameters

    • value: string

    Returns void

userId

  • get userId(): string
  • set userId(value: string): void

  • 获取当前指定的用户 ID

    Returns string

  • 设置用户 ID

    Parameters

    • value: string

    Returns void

Methods

createDirectory

  • 创建目录

    Parameters

    • path: string

      目录路径

    • Optional callback: RequestCallback

      创建完成回调函数，返回是否成功。

    Returns void

createSpace

  • 创建租户空间。在创建成功后，当前实例的租户空间 ID 将自动指向新创建的租户空间。

    Parameters

    • Optional callback: CreateSpaceCallback

      创建完成回调函数，返回是否成功及成功创建的租户空间的相关信息。

    Returns void

  • 创建具有指定扩展选项的租户空间。在创建成功后，当前实例的租户空间 ID 将自动指向新创建的租户空间。

    Parameters

    • Optional extension: SpaceExtension

      租户空间扩展选项

    • Optional callback: CreateSpaceCallback

      创建完成回调函数，返回是否成功及成功创建的租户空间的相关信息。

    Returns void

deleteDirectory

  • 删除指定目录

    Parameters

    • path: string

      目录路径

    • Optional callback: RequestCallback

      删除完成回调函数，返回是否成功。

    Returns void

deleteFile

  • 删除指定文件

    Parameters

    • path: string

      文件路径

    • Optional callback: RequestCallback

      删除完成回调函数，返回是否成功。

    Returns void

deleteSpace

  • 删除租户空间。在删除成功后，当前实例的租户空间 ID 将自动置空，需要重新创建新的租户空间或手动指向其他的租户空间。

    Parameters

    • Optional callback: RequestCallback

      删除完成回调函数，返回是否成功。

    Returns void

ensureToken

  • 确保访问令牌存在且在有效期内，否则将自动续期或刷新访问令牌。

    Parameters

    • Optional callback: GetAccessTokenCallback

      回调函数，返回是否成功及成功后在有效期内的访问令牌。

    Returns void

  • 确保访问令牌存在且在有效期内，否则将自动续期或刷新访问令牌。

    Parameters

    • Optional forceRenew: undefined | false | true

      是否强制续期，指定为 true 时，如果访问令牌距离上次使用已经超过 5 分钟，将自动续期；如果访问令牌剩余有效期不足 5 分钟，则忽略该参数强制自动续期。

    • Optional callback: GetAccessTokenCallback

      回调函数，返回是否成功及成功后符合要求有效期的访问令牌。

    Returns void

getCoverUrl

  • getCoverUrl(albumName: string, callback?: GetUrlCallback): void
  • getCoverUrl(albumName: string, size: number, callback?: GetUrlCallback): void
  • getCoverUrl(albumNameList: string[], callback?: GetUrlCallback): void
  • getCoverUrl(albumNameList: string[], size: number, callback?: GetUrlCallback): void

  • 获取媒体库指定相簿的封面图片 URL

    Parameters

    • albumName: string

      相簿名，对于非多相簿模式可指定空字符串获取整个空间的封面图。

    • Optional callback: GetUrlCallback

      回调函数，返回是否成功及成功获取的相簿封面图片 URL。

    Returns void

  • 获取媒体库指定相簿的指定大小的封面图片 URL

    Parameters

    • albumName: string

      相簿名，对于非多相簿模式可指定空字符串获取整个空间的封面图。

    • size: number

      封面图片大小(px)，将缩放裁剪为正方形图片。

    • Optional callback: GetUrlCallback

      回调函数，返回是否成功及成功获取的相簿封面图片 URL。

    Returns void

  • 批量获取媒体库指定相簿的封面图片 URL

    Parameters

    • albumNameList: string[]

      相簿名列表，对于非多相簿模式可指定空字符串获取整个空间的封面图。

    • Optional callback: GetUrlCallback

      回调函数，返回是否成功及成功获取的相簿封面图片 URL。

    Returns void

  • 批量获取媒体库指定相簿的指定大小的封面图片 URL

    Parameters

    • albumNameList: string[]

      相簿名列表，对于非多相簿模式可指定空字符串获取整个空间的封面图。

    • size: number

      封面图片大小(px)，将缩放裁剪为正方形图片。

    • Optional callback: GetUrlCallback

      回调函数，返回是否成功及成功获取的相簿封面图片 URL。

    Returns void

getFileUrl

  • 获取指定文件 URL

    Parameters

    • path: string

      文件路径

    • Optional callback: GetUrlCallback

      回调函数，返回是否成功及成功获取的文件 URL。

    Returns void

  • 批量获取指定文件 URL

    Parameters

    • pathList: string[]

      文件路径列表

    • Optional callback: GetUrlCallback

      回调函数，返回是否成功及成功获取的文件 URL。

    Returns void

getPreviewUrl

  • getPreviewUrl(path: string, callback?: GetUrlCallback): void
  • getPreviewUrl(path: string, size: number, callback?: GetUrlCallback): void
  • getPreviewUrl(pathList: string[], callback?: GetUrlCallback): void
  • getPreviewUrl(pathList: string[], size: number, callback?: GetUrlCallback): void

  • 获取指定照片 URL 或视频的封面 URL

    Parameters

    • path: string

      文件路径

    • Optional callback: GetUrlCallback

      回调函数，返回是否成功及成功获取的文件 URL。

    Returns void

  • 获取指定媒体文件的指定大小的缩略图 URL

    Parameters

    • path: string

      文件路径

    • size: number

      缩略图大小(px)，将缩放裁剪为正方形图片。

    • Optional callback: GetUrlCallback

      回调函数，返回是否成功及成功获取的文件 URL。

    Returns void

  • 批量获取指定照片 URL 或视频的封面 URL

    Parameters

    • pathList: string[]

      文件路径列表

    • Optional callback: GetUrlCallback

      回调函数，返回是否成功及成功获取的文件 URL。

    Returns void

  • 批量获取指定媒体文件的指定大小的缩略图 URL

    Parameters

    • pathList: string[]

      文件路径列表

    • size: number

      缩略图大小(px)，将缩放裁剪为正方形图片。

    • Optional callback: GetUrlCallback

      回调函数，返回是否成功及成功获取的文件 URL。

    Returns void

listDirectory

  • 列出根目录中的内容，该方法将自动从第 1 页开始列出根目录直到所有页均列出。

    Parameters

    • Optional callback: ListDirectoryCallback

      回调函数，返回是否成功及成功列出的目录内容信息。

    Returns void

  • 列出指定目录中的内容，该方法将自动从第 1 页开始列出指定目录直到所有页均列出。

    Parameters

    • path: string

      目录路径

    • Optional callback: ListDirectoryCallback

      回调函数，返回是否成功及成功列出的目录内容信息。

    Returns void

listDirectoryWithPagination

moveDirectory

  • moveDirectory(fromPath: string, toPath: string, callback?: RequestCallback): void

  • 重命名或移动指定目录

    Parameters

    • fromPath: string

      源目录完整路径

    • toPath: string

      目标目录完整路径

    • Optional callback: RequestCallback

      重命名或移动完成回调函数，返回是否成功。

    Returns void

moveFile

  • moveFile(fromPath: string, toPath: string, callback?: UploadCallback): void
  • moveFile(fromPath: string, toPath: string, force: boolean, callback?: UploadCallback): void

  • 重命名或移动指定文件

    Parameters

    • fromPath: string

      源文件完整路径

    • toPath: string

      目标文件完整路径，如果指定路径存在同名文件或目录则自动改名。

    • Optional callback: UploadCallback

      重命名或移动完成回调函数，返回是否成功及成功重命名或移动的目标文件信息。

    Returns void

  • 重命名或移动指定文件并可指定遇到同名文件或目录时的处理方法

    Parameters

    • fromPath: string

      源文件完整路径

    • toPath: string

      目标文件完整路径

    • force: boolean

      是否强制覆盖同名文件或目录，当选择强制覆盖时，同名文件将会被删除，同名目录将会连同目录内容一并被删除。

    • Optional callback: UploadCallback

      重命名或移动完成回调函数，返回是否成功及成功重命名或移动的目标文件信息。

    Returns void

refreshToken

  • 刷新访问令牌

    Parameters

    • Optional callback: GetAccessTokenCallback

      访问令牌刷新完成回调，返回是否成功及成功后最新的访问令牌信息。

    Returns void

updateSpaceExtension

  • 修改租户空间的部分扩展选项

    Parameters

    • extension: AllowModifiedSpaceExtension

      需要修改的扩展选项，只有部分选项支持修改且仅在该参数中出现的选项会被修改。

    • Optional callback: RequestCallback

      修改完成回调函数，返回是否成功。

    Returns void

uploadFile

  • uploadFile(remotePath: string, localPath: string, callback?: UploadCallback): void
  • uploadFile(remotePath: string, localPath: string, force: boolean, callback?: UploadCallback): void

  • 上传文件

    Parameters

    • remotePath: string

      文件的远程目标路径，如果指定路径存在同名文件或目录则自动改名。

    • localPath: string

      在微信内获取的文件本地路径

    • Optional callback: UploadCallback

      上传完成回调函数，返回是否成功及成功上传的文件的信息。

    Returns void

  • 上传文件并可指定遇到同名文件或目录时的处理方法

    Parameters

    • remotePath: string

      文件的远程目标路径

    • localPath: string

      在微信内获取的文件本地路径

    • force: boolean

      是否强制覆盖同名文件或目录，当选择强制覆盖时，同名文件将会被删除，同名目录将会连同目录内容一并被删除。

    • Optional callback: UploadCallback

      上传完成回调函数，返回是否成功及成功上传的文件的信息。

    Returns void

Static encodePath

  • encodePath(path: string): string

  • 编码路径

    Parameters

    • path: string

      原始路径

    Returns string

    编码后可直接拼接在 URL 中的路径

Static ensureMultiSpaceToken

  • 确保可用于多个指定租户空间的访问令牌存在且在有效期内，否则将自动更新访问令牌。

    Parameters

    • libraryId: string

      媒体库 ID

    • spaceIdList: string[]

      租户空间 ID 列表

    • Optional callback: GetMultiSpaceAccessTokenCallback

      回调函数，返回是否成功及成功后符合要求有效期的可用于多个指定租户空间的访问令牌。

    Returns void

  • 确保可用于多个指定租户空间的访问令牌存在且在有效期内，否则将自动更新访问令牌。

    Parameters

    • libraryId: string

      媒体库 ID

    • spaceIdList: string[]

      租户空间 ID 列表

    • userId: string

      用户 ID

    • Optional callback: GetMultiSpaceAccessTokenCallback

      回调函数，返回是否成功及成功后符合要求有效期的可用于多个指定租户空间的访问令牌。

    Returns void

Static getSpaceCoverUrl

  • getSpaceCoverUrl(libraryId: string, spaceIdList: string[], size?: undefined | number, callback?: GetUrlCallback): void

  • 批量获取媒体库指定租户空间的封面图片 URL

    Parameters

    • libraryId: string

      媒体库 ID。

    • spaceIdList: string[]

      租户空间 ID 列表。

    • Optional size: undefined | number

      封面图片大小(px)，将缩放裁剪为正方形图片，如不指定则为原始大小。

    • Optional callback: GetUrlCallback

      回调函数，返回是否成功及成功获取的相簿封面图片 URL。

    Returns void

    与指定的租户空间 ID 列表顺序对应的租户空间封面图片 URL 列表。

Static stringifyQueryString

  • stringifyQueryString(query: Query): string

  • 字符串化查询字符串

    Parameters

    • query: Query

      查询字符串键值对

    Returns string

    查询字符串

Generated using TypeDoc