logo
@fett/synology-api @0.0.4
文档
English
简体中文
文档
English
简体中文
logo
@fett/synology-api @0.0.4

快速开始

介绍
使用

API

API Overview

Modules

BaseApi
User APIs
FileStation APIs
VideoStation APIs
AudioStation APIs
Docker APIs

贡献

添加 Synology APIs
代码测试
编写文档

支持的 APIs

Modules

BaseApi

  • connect
  • disconnect
  • getApiInfo
  • hasApi

User APIs

  • getUserList
  • getUserInfo

FileStation APIs

  • getInfo
  • getFileList
  • getShareFileList
  • getVirtualFolderList
  • startSearch
  • stopSearch
  • getSearchList
  • cleanSearch
  • createFolder
  • getFavoriteList
  • addFavorite
  • deleteFavorite
  • clearBrokenFavorite
  • getThumbUrl
  • startDirSizeCalc
  • stopDirSizeCalc
  • getDirSizeCalcStatus
  • startMD5Calc
  • stopMD5Calc
  • getMD5CalcStatus
  • checkPermission
  • rename
  • getBackgroundTaskList
  • clearFinishedBackgroundTasks
  • startDeleteFile
  • stopDeleteFile
  • getDeleteFileStatus
  • getDownloadFile
  • getSharingInfo
  • getSharingList
  • createSharingLink
  • deleteSharingLink
  • clearInvalidSharingLink
  • editSharingLink
  • startCopyMove
  • getCopyMoveStatus
  • stopCopyMove

VideoStation APIs

  • getInfo
  • getMoiveInfo
  • getStreamUrl
  • getAcrossLibrary

AudioStation APIs

  • getInfo
  • getAlbumList
  • getArtistList
  • getPlaylist
  • createPlaylist
  • deletePlaylist
  • getSongList

Docker APIs

  • getContainerList