Documentation
¶
Index ¶
- Constants
- func ExtendType(mime, filename string) (symbol template.HTML, primaryType, secondaryType, extension string)
- func SortFolderEntries(entries []*FolderEntry)
- type API
- func (api *API) Auth(pr *beepboop.PageRequest, folderName, accessType, password string) error
- func (api *API) ChangeFolderPassword(sess *beepboop.Session, folderName, accessType, password string) error
- func (api *API) ConnectDB(redisUrl string) (*beepboop.DB, error)
- func (api *API) CreateSubfolder(sess *beepboop.Session, folderName, subfolder string) (string, error)
- func (api *API) DeleteFile(sess *beepboop.Session, filePath string) error
- func (api *API) DeleteSubfolder(sess *beepboop.Session, folderName, subfolder string) error
- func (api *API) DownloadFileToFolder(sess *beepboop.Session, o *DownloadFileToFolderOptions) error
- func (api *API) EditFile(sess *beepboop.Session, o *EditFileOptions) error
- func (api *API) GetArchiveWalker(sess *beepboop.Session, filePath string) (ArchiveWalker, error)
- func (api *API) GetFileThumbnail(sess *beepboop.Session, filePath string) (*Thumbnail, error)
- func (api *API) GetFolderEntries(sess *beepboop.Session, folderOrFilename string) ([]*FolderEntry, *FolderFlags, error)
- func (api *API) GetFolderFlags(sess *beepboop.Session, folderName string) (*FolderFlags, error)
- func (api *API) GetInternalFilename(sess *beepboop.Session, filePath string) (string, error)
- func (api *API) GetSubfolders(sess *beepboop.Session, folderName string) ([]string, error)
- func (api *API) OpenFile(sess *beepboop.Session, filePath string) (FileReader, error)
- func (api *API) UploadFile(sess *beepboop.Session, o *UploadFileOptions) error
- type ArchiveFile
- type ArchiveWalker
- type DownloadFileToFolderOptions
- type EditFileOptions
- type ErrBadHTTPResponseStatus
- type ErrFolderBusy
- type ErrInvalidMoveLocation
- type ErrInvalidName
- type ErrNoFiles
- type ErrNoReadAccess
- type ErrNoWriteAccess
- type ErrNotDeletable
- type ErrNotFound
- type ErrRateLimitExceeded
- type ErrSizeLimitExceeded
- type ErrSubfoldersDisabled
- type ErrUnsupportedFileFormat
- type ErrWrongPassword
- type FileReader
- type FolderEntry
- type FolderFlags
- type LimitedReadCloser
- type LimitedReader
- type Thumbnail
- type ThumbnailBounds
- type UploadFileOptions
Constants ¶
const MaxThumbnailWidth = internal.MaxThumbnailWidth
MaxThumbnailWidth ...
Variables ¶
This section is empty.
Functions ¶
func ExtendType ¶
func ExtendType(mime, filename string) (symbol template.HTML, primaryType, secondaryType, extension string)
ExtendType ...
func SortFolderEntries ¶
func SortFolderEntries(entries []*FolderEntry)
SortFolderEntries sorts the entries by the upload date (most recent first)
Types ¶
type API ¶
type API struct {
CacheDuration time.Duration
CookieExpiration time.Duration
ThumbnailRetryAfter time.Duration
AuthsPerMin int
// contains filtered or unexported fields
}
API ...
func (*API) Auth ¶
func (api *API) Auth(pr *beepboop.PageRequest, folderName, accessType, password string) error
Auth ...
func (*API) ChangeFolderPassword ¶
func (api *API) ChangeFolderPassword(sess *beepboop.Session, folderName, accessType, password string) error
ChangeFolderPassword ...
func (*API) CreateSubfolder ¶
func (api *API) CreateSubfolder(sess *beepboop.Session, folderName, subfolder string) (string, error)
CreateSubfolder ...
func (*API) DeleteFile ¶
DeleteFile ...
func (*API) DeleteSubfolder ¶
DeleteSubfolder ...
func (*API) DownloadFileToFolder ¶
func (api *API) DownloadFileToFolder(sess *beepboop.Session, o *DownloadFileToFolderOptions) error
DownloadFileToFolder ...
func (*API) EditFile ¶
func (api *API) EditFile(sess *beepboop.Session, o *EditFileOptions) error
EditFile ...
func (*API) GetArchiveWalker ¶
GetArchiveWalker ...
func (*API) GetFileThumbnail ¶
GetFileThumbnail ...
func (*API) GetFolderEntries ¶
func (api *API) GetFolderEntries(sess *beepboop.Session, folderOrFilename string) ([]*FolderEntry, *FolderFlags, error)
GetFolderEntries ...
func (*API) GetFolderFlags ¶
GetFolderFlags ...
func (*API) GetInternalFilename ¶
GetInternalFilename ...
func (*API) GetSubfolders ¶
GetSubfolders ...
func (*API) UploadFile ¶
func (api *API) UploadFile(sess *beepboop.Session, o *UploadFileOptions) error
UploadFile ...
type ArchiveFile ¶
ArchiveFile ...
type ArchiveWalker ¶
type ArchiveWalker interface {
Walk(func(ArchiveFile) error) error
}
ArchiveWalker ...
type DownloadFileToFolderOptions ¶
type DownloadFileToFolderOptions struct {
Folder string
URL string
Filename string
Tags []string
Overwrite bool
Public bool
}
DownloadFileToFolderOptions ...
type EditFileOptions ¶
type EditFileOptions struct {
Folder string
OriginalFilename string
NewFilename string
Tags []string
Public bool
MoveTo string
}
EditFileOptions ...
type ErrBadHTTPResponseStatus ¶
type ErrBadHTTPResponseStatus struct {
StatusCode int
}
ErrBadHTTPResponseStatus ...
func (ErrBadHTTPResponseStatus) Error ¶
func (err ErrBadHTTPResponseStatus) Error() string
type ErrFolderBusy ¶
type ErrFolderBusy struct{}
ErrFolderBusy ...
func (ErrFolderBusy) Error ¶
func (err ErrFolderBusy) Error() string
type ErrInvalidMoveLocation ¶
type ErrInvalidMoveLocation struct {
Location string
}
ErrInvalidMoveLocation ...
func (ErrInvalidMoveLocation) Error ¶
func (err ErrInvalidMoveLocation) Error() string
type ErrInvalidName ¶
type ErrInvalidName struct {
Name string
}
ErrInvalidName ...
func (ErrInvalidName) Error ¶
func (err ErrInvalidName) Error() string
type ErrNoFiles ¶
type ErrNoFiles struct{}
ErrNoFiles ...
func (ErrNoFiles) Error ¶
func (err ErrNoFiles) Error() string
type ErrNoReadAccess ¶
type ErrNoReadAccess struct {
Folder string
}
ErrNoReadAccess ...
func (ErrNoReadAccess) Error ¶
func (err ErrNoReadAccess) Error() string
type ErrNoWriteAccess ¶
type ErrNoWriteAccess struct {
Folder string
}
ErrNoWriteAccess ...
func (ErrNoWriteAccess) Error ¶
func (err ErrNoWriteAccess) Error() string
type ErrNotDeletable ¶
type ErrNotDeletable struct {
Name string
}
ErrNotDeletable ...
func (ErrNotDeletable) Error ¶
func (err ErrNotDeletable) Error() string
type ErrNotFound ¶
type ErrNotFound struct{}
ErrNotFound ...
func (ErrNotFound) Error ¶
func (err ErrNotFound) Error() string
type ErrRateLimitExceeded ¶
type ErrRateLimitExceeded struct {
ReqPerMin int
}
ErrRateLimitExceeded ...
func (ErrRateLimitExceeded) Error ¶
func (err ErrRateLimitExceeded) Error() string
type ErrSizeLimitExceeded ¶
type ErrSizeLimitExceeded struct{}
ErrSizeLimitExceeded ...
func (ErrSizeLimitExceeded) Error ¶
func (err ErrSizeLimitExceeded) Error() string
type ErrSubfoldersDisabled ¶
type ErrSubfoldersDisabled struct {
Folder string
}
ErrSubfoldersDisabled ...
func (ErrSubfoldersDisabled) Error ¶
func (err ErrSubfoldersDisabled) Error() string
type ErrUnsupportedFileFormat ¶
type ErrUnsupportedFileFormat struct {
MIME string
}
ErrUnsupportedFileFormat ...
func (ErrUnsupportedFileFormat) Error ¶
func (err ErrUnsupportedFileFormat) Error() string
type ErrWrongPassword ¶
type ErrWrongPassword struct{}
ErrWrongPassword ...
func (ErrWrongPassword) Error ¶
func (err ErrWrongPassword) Error() string
type FileReader ¶
FileReader ...
type FolderEntry ¶
type FolderEntry struct {
Folder bool `json:"folder,omitempty"`
Prefix template.HTML `json:"prefix,omitempty"`
Name string `json:"name"`
RelPath string `json:"rel_path"`
MIME string `json:"mime,omitempty"`
PrimaryType string `json:"primary_type,omitempty"`
SecondaryType string `json:"secondary_type,omitempty"`
Extension string `json:"extension"`
Tags []string `json:"tags,omitempty"`
Size int64 `json:"size,omitempty"`
Uploaded int64 `json:"uploaded,omitempty"`
Public bool `json:"public,omitempty"`
EditMode bool `json:"edit_mode,omitempty"`
HasThumbnail bool `json:"has_thumbnail,omitempty"`
ThumbBounds *ThumbnailBounds `json:"thumb_bounds,omitempty"`
Archive bool `json:"archive,omitempty"`
}
FolderEntry ...
type FolderFlags ¶
type FolderFlags struct {
EditMode bool
Editable bool
Deletable bool
Configurable bool
Subfolders bool
MaxUploadSizeMB int64
}
FolderFlags ...
type LimitedReadCloser ¶
type LimitedReadCloser struct {
R io.ReadCloser
N int64
}
LimitedReadCloser ...
func (*LimitedReadCloser) Close ¶
func (l *LimitedReadCloser) Close() error
Close implements io.Closer
type LimitedReader ¶
LimitedReader is like io.LimitedReader, but returns a non-EOF error if limit is exceeded
type Thumbnail ¶
type Thumbnail struct {
Data []byte
MIME string
Bounds ThumbnailBounds
}
Thumbnail ...
type ThumbnailBounds ¶
ThumbnailBounds ...
type UploadFileOptions ¶
type UploadFileOptions struct {
Folder string
Files []*multipart.FileHeader
Filename string
Tags []string
Overwrite bool
Public bool
}
UploadFileOptions ...