api

package

v1.74.0 Latest Latest Go to latest Published: May 1, 2026 License: MIT Imports: 1 Imported by: 0

Details

Valid go.mod file
Redistributable license
Tagged version
Stable version
Learn more about best practices

Repository

github.com/rclone/rclone

Links

Documentation ¶

Overview ¶

Package api provides types used by the Huawei Drive API.

Constants ¶

View Source

const (
	// MIME types
	FolderMimeType = "application/vnd.huawei-apps.folder"

	// Special folder names
	ApplicationDataFolder = "applicationData"

	// Upload types
	UploadTypeMultipart = "multipart"
	UploadTypeContent   = "content"
	UploadTypeResume    = "resume"

	// Form types
	FormContent = "content"
	FormJSON    = "json"

	// Categories
	CategoryDriveFile     = "drive#file"
	CategoryDriveFileList = "drive#fileList"
	CategoryDriveAbout    = "drive#about"
	CategoryDriveUser     = "drive#user"

	// Global API domain (always available)
	GlobalDriveAPI  = "https://driveapis.cloud.huawei.com.cn"
	GlobalUploadAPI = "https://driveapis.cloud.huawei.com.cn"
)

Constants

Variables ¶

View Source

var DomainToRootURL = map[string]string{
	"china":                          "https://drive-drcn.cloud.dbankcloud.cn",
	"europe":                         "https://drive-dre.cloud.dbankcloud.cn",
	"aala":                           "https://drive-dra.cloud.dbankcloud.cn",
	"russia":                         "https://drive-drru.cloud.dbankcloud.cn",
	"drive-drcn.cloud.dbankcloud.cn": "https://drive-drcn.cloud.dbankcloud.cn",
	"drive-dre.cloud.dbankcloud.cn":  "https://drive-dre.cloud.dbankcloud.cn",
	"drive-dra.cloud.dbankcloud.cn":  "https://drive-dra.cloud.dbankcloud.cn",
	"drive-drru.cloud.dbankcloud.cn": "https://drive-drru.cloud.dbankcloud.cn",
}

DomainToRootURL maps the domain field from About:get to the regional API root URL. The API returns the full domain name (e.g., "driveapis.cloud.huawei.com.cn"). If the domain matches the global API, no switch is needed. See: https://developer.huawei.com/consumer/cn/doc/HMSCore-References/server-public-info-0000001050159641

View Source

var GlobalDomains = map[string]bool{
	"driveapis.cloud.huawei.com.cn": true,
	"drive.cloud.hicloud.com":       true,
}

GlobalDomains lists domain values that indicate the global API endpoint (no switch needed)

Functions ¶

func BoolPtr ¶

func BoolPtr(b bool) *bool

BoolPtr returns a pointer to a bool value (helper for UpdateFileRequest)

Types ¶

type About ¶

type About struct {
	StorageQuota struct {
		UsedSpace    string `json:"usedSpace"`
		UserCapacity string `json:"userCapacity"`
	} `json:"storageQuota"`
	MaxThumbnailSize  int64  `json:"maxThumbnailSize"`
	NeedUpdate        bool   `json:"needUpdate"`
	MaxFileUploadSize string `json:"maxFileUploadSize"`
	Domain            string `json:"domain"`
	Category          string `json:"category"`
	User              User   `json:"user"`
	FolderLevel       int    `json:"folderLevel"`
}

About represents response to About.get endpoint

type ChangeItem ¶

type ChangeItem struct {
	Category   string `json:"category"`   // "drive#change"
	Type       string `json:"type"`       // resource type, e.g. "File"
	ChangeType string `json:"changeType"` // change type, e.g. "File"
	Time       string `json:"time"`
	Deleted    bool   `json:"deleted"`
	FileID     string `json:"fileId"`
	File       *File  `json:"file,omitempty"`
}

ChangeItem represents a single change entry

type ChangeList ¶

type ChangeList struct {
	Category       string       `json:"category"` // "drive#changeList"
	NextCursor     string       `json:"nextCursor,omitempty"`
	NewStartCursor string       `json:"newStartCursor,omitempty"`
	Changes        []ChangeItem `json:"changes"`
}

ChangeList represents response to Changes.list endpoint

type ContentExtras ¶

type ContentExtras struct {
	Thumbnail *Thumbnail `json:"thumbnail,omitempty"`
}

ContentExtras represents additional content information

type CopyFileRequest ¶

type CopyFileRequest struct {
	FileName     string                 `json:"fileName,omitempty"`
	MimeType     string                 `json:"mimeType,omitempty"`
	ParentFolder []string               `json:"parentFolder,omitempty"`
	Properties   map[string]interface{} `json:"properties,omitempty"`
	AppSettings  map[string]interface{} `json:"appSettings,omitempty"`
}

CopyFileRequest represents request to copy a file

type CreateFolderRequest ¶

type CreateFolderRequest struct {
	FileName     string                 `json:"fileName"`
	Description  string                 `json:"description,omitempty"`
	MimeType     string                 `json:"mimeType"`
	ParentFolder []string               `json:"parentFolder,omitempty"`
	Favorite     bool                   `json:"favorite,omitempty"`
	Properties   map[string]interface{} `json:"properties,omitempty"`
	AppSettings  map[string]interface{} `json:"appSettings,omitempty"`
	AutoRename   int                    `json:"autoRename,omitempty"`
}

CreateFolderRequest represents request to create a folder

type ErrorResponse ¶

type ErrorResponse struct {
	Error struct {
		Code    int    `json:"code"`
		Message string `json:"message"`
	} `json:"error"`
}

ErrorResponse represents an error response from the API

type File ¶

type File struct {
	ID                        string                 `json:"id"`
	FileName                  string                 `json:"fileName"`
	OriginalFilename          string                 `json:"originalFilename,omitempty"`
	Description               string                 `json:"description,omitempty"`
	MimeType                  string                 `json:"mimeType"`
	Category                  string                 `json:"category"`
	Size                      int64                  `json:"size,omitempty"`
	SHA256                    string                 `json:"sha256,omitempty"`
	CreatedTime               time.Time              `json:"createdTime"`
	EditedTime                time.Time              `json:"editedTime"`
	EditedByMeTime            time.Time              `json:"editedByMeTime,omitempty"`
	ParentFolder              []string               `json:"parentFolder,omitempty"`
	Owners                    []User                 `json:"owners"`
	LastEditor                User                   `json:"lastEditor"`
	Permissions               []Permission           `json:"permissions"`
	PermissionIDs             []string               `json:"permissionIds"`
	Capabilities              FileCapabilities       `json:"capabilities"`
	OwnedByMe                 bool                   `json:"ownedByMe"`
	EditedByMe                bool                   `json:"editedByMe"`
	ViewedByMe                bool                   `json:"viewedByMe"`
	HasShared                 bool                   `json:"hasShared"`
	Recycled                  bool                   `json:"recycled"`
	DirectlyRecycled          bool                   `json:"directlyRecycled"`
	Favorite                  bool                   `json:"favorite"`
	ExistThumbnail            bool                   `json:"existThumbnail"`
	ThumbnailVersion          int64                  `json:"thumbnailVersion"`
	IconDownloadLink          string                 `json:"iconDownloadLink,omitempty"`
	ContentDownloadLink       string                 `json:"contentDownloadLink,omitempty"`
	ContentVersion            string                 `json:"contentVersion,omitempty"`
	LastHistoryVersionID      string                 `json:"lastHistoryVersionId,omitempty"`
	OccupiedSpace             int64                  `json:"occupiedSpace,omitempty"`
	Version                   int64                  `json:"version"`
	WritersHasSharePermission bool                   `json:"writersHasSharePermission"`
	WriterHasCopyPermission   bool                   `json:"writerHasCopyPermission"`
	Containers                []string               `json:"containers"`
	Properties                map[string]interface{} `json:"properties,omitempty"`
	AppSettings               map[string]interface{} `json:"appSettings,omitempty"`
	ContentExtras             *ContentExtras         `json:"contentExtras,omitempty"`
}

File represents a file or folder in Huawei Drive

func (*File) IsDir ¶

func (f *File) IsDir() bool

IsDir returns true if the file is a directory

type FileCapabilities ¶

type FileCapabilities struct {
	DownloadPermission            bool `json:"downloadPermission"`
	RenameFilePermission          bool `json:"renameFilePermission"`
	CommentPermission             bool `json:"commentPermission"`
	DeletePermission              bool `json:"deletePermission"`
	ReadHistoryVersionPermission  bool `json:"readHistoryVersionPermission"`
	RecyclePermission             bool `json:"recyclePermission"`
	AddChildNodePermission        bool `json:"addChildNodePermission"`
	UnrecyclePermission           bool `json:"unrecyclePermission"`
	WriterHasChangeCopyPermission bool `json:"writerHasChangeCopyPermission"`
	CopyPermission                bool `json:"copyPermission"`
	EditContentPermission         bool `json:"editContentPermission"`
	RemoveChildNodePermission     bool `json:"removeChildNodePermission"`
	EditPermission                bool `json:"editPermission"`
	ListChildNodePermission       bool `json:"listChildNodePermission"`
	ShareFilePermission           bool `json:"shareFilePermission"`
}

FileCapabilities represents capabilities for a file

type FileList ¶

type FileList struct {
	Files         []File `json:"files"`
	NextPageToken string `json:"nextPageToken,omitempty"`
	Category      string `json:"category"`
}

FileList represents response to Files.list endpoint

type Permission ¶

type Permission struct {
	ID                 string `json:"id"`
	Type               string `json:"type"`
	Role               string `json:"role"`
	DisplayName        string `json:"displayName,omitempty"`
	Deleted            bool   `json:"deleted"`
	AllowFileDiscovery bool   `json:"allowFileDiscovery,omitempty"`
	Category           string `json:"category"`
}

Permission represents file permission

type ResumeUploadInitResponse ¶

type ResumeUploadInitResponse struct {
	SliceSize int64 `json:"sliceSize"`
}

ResumeUploadInitResponse represents response to resume upload init

type StartCursor ¶

type StartCursor struct {
	Category    string `json:"category"` // "drive#startCursor"
	StartCursor string `json:"startCursor"`
}

StartCursor represents response to Changes.getStartCursor endpoint

type Thumbnail ¶

type Thumbnail struct {
	Content  string `json:"content"` // base64 encoded
	MimeType string `json:"mimeType"`
}

Thumbnail represents thumbnail information

type UpdateFileRequest ¶

type UpdateFileRequest struct {
	FileName                  string                 `json:"fileName,omitempty"`
	Description               string                 `json:"description,omitempty"`
	MimeType                  string                 `json:"mimeType,omitempty"`
	Favorite                  *bool                  `json:"favorite,omitempty"`
	Recycled                  *bool                  `json:"recycled,omitempty"`
	OriginalFilename          string                 `json:"originalFilename,omitempty"`
	WriterHasCopyPermission   *bool                  `json:"writerHasCopyPermission,omitempty"`
	WritersHasSharePermission *bool                  `json:"writersHasSharePermission,omitempty"`
	Properties                map[string]interface{} `json:"properties,omitempty"`
	AppSettings               map[string]interface{} `json:"appSettings,omitempty"`
	AddParentFolder           []string               `json:"addParentFolder,omitempty"`
	RemoveParentFolder        []string               `json:"removeParentFolder,omitempty"`
	CreatedTime               *time.Time             `json:"createdTime,omitempty"`
	EditedTime                *time.Time             `json:"editedTime,omitempty"`
}

UpdateFileRequest represents request to update a file

type User ¶

type User struct {
	PermissionID string `json:"permissionId"`
	DisplayName  string `json:"displayName"`
	Me           bool   `json:"me"`
	Category     string `json:"category"`
}

User represents a user

Source Files ¶

View all Source files

types.go

?	: This menu
/	: Search site
f or F	: Jump to
y or Y	: Canonical URL

Documentation ¶

Overview ¶

Index ¶

Constants ¶

Variables ¶

Functions ¶

func BoolPtr ¶

Types ¶

type About ¶

type ChangeItem ¶

type ChangeList ¶

type ContentExtras ¶

type CopyFileRequest ¶

type CreateFolderRequest ¶

type ErrorResponse ¶

type File ¶

func (*File) IsDir ¶

type FileCapabilities ¶

type FileList ¶

type Permission ¶

type ResumeUploadInitResponse ¶

type StartCursor ¶

type Thumbnail ¶

type UpdateFileRequest ¶

type User ¶

Source Files ¶