data

Documentation

Index

• type Capabilities
• type CapabilitiesAppProvider
• type CapabilitiesArchiver
• type CapabilitiesChecksums
• type CapabilitiesCore
• type CapabilitiesData
• type CapabilitiesDav
• type CapabilitiesFiles
• type CapabilitiesFilesSharing
• type CapabilitiesFilesSharingFederation
• type CapabilitiesFilesSharingPublic
• type CapabilitiesFilesSharingPublicExpireDate
• type CapabilitiesFilesSharingPublicPassword
• type CapabilitiesFilesSharingPublicPasswordEnforcedFor
• type CapabilitiesFilesSharingUser
• type CapabilitiesFilesSharingUserEnumeration
• type CapabilitiesFilesTusSupport
• type CapabilitiesGroupBased
• type CapabilitiesNotifications
• type CapabilitiesUserSettings
• type ConfigData
• type Spaces
• type Status
• type Version

Types

type Capabilities

type Capabilities struct {
	Core         *CapabilitiesCore         `json:"core" xml:"core"`
	Checksums    *CapabilitiesChecksums    `json:"checksums" xml:"checksums"`
	Files        *CapabilitiesFiles        `json:"files" xml:"files" mapstructure:"files"`
	Dav          *CapabilitiesDav          `json:"dav" xml:"dav"`
	FilesSharing *CapabilitiesFilesSharing `json:"files_sharing" xml:"files_sharing" mapstructure:"files_sharing"`
	Spaces       *Spaces                   `json:"spaces,omitempty" xml:"spaces,omitempty" mapstructure:"spaces"`

	Notifications *CapabilitiesNotifications `json:"notifications,omitempty" xml:"notifications,omitempty"`

	GroupBased *CapabilitiesGroupBased `json:"group_based" xml:"group_based" mapstructure:"group_based"`
}

Capabilities groups several capability aspects

type CapabilitiesAppProvider

type CapabilitiesAppProvider struct {
	Enabled bool   `json:"enabled" xml:"enabled" mapstructure:"enabled"`
	Version string `json:"version" xml:"version" mapstructure:"version"`
	AppsURL string `json:"apps_url" xml:"apps_url" mapstructure:"apps_url"`
	OpenURL string `json:"open_url" xml:"open_url" mapstructure:"open_url"`
	NewURL  string `json:"new_url" xml:"new_url" mapstructure:"new_url"`
}

CapabilitiesAppProvider holds available app provider information

type CapabilitiesArchiver

type CapabilitiesArchiver struct {
	Enabled     bool     `json:"enabled" xml:"enabled" mapstructure:"enabled"`
	Version     string   `json:"version" xml:"version" mapstructure:"version"`
	Formats     []string `json:"formats" xml:"formats" mapstructure:"formats"`
	ArchiverURL string   `json:"archiver_url" xml:"archiver_url" mapstructure:"archiver_url"`
	MaxNumFiles string   `json:"max_num_files" xml:"max_num_files" mapstructure:"max_num_files"`
	MaxSize     string   `json:"max_size" xml:"max_size" mapstructure:"max_size"`
}

CapabilitiesArchiver holds available archivers information

type CapabilitiesChecksums

type CapabilitiesChecksums struct {
	SupportedTypes      []string `json:"supportedTypes" xml:"supportedTypes>element" mapstructure:"supported_types"`
	PreferredUploadType string   `json:"preferredUploadType" xml:"preferredUploadType" mapstructure:"preferred_upload_type"`
}

CapabilitiesChecksums holds available hashes

type CapabilitiesCore

type CapabilitiesCore struct {
	PollInterval      int     `json:"pollinterval" xml:"pollinterval" mapstructure:"poll_interval"`
	WebdavRoot        string  `json:"webdav-root,omitempty" xml:"webdav-root,omitempty" mapstructure:"webdav_root"`
	Status            *Status `json:"status" xml:"status"`
	SupportURLSigning ocsBool `json:"support-url-signing" xml:"support-url-signing" mapstructure:"support_url_signing"`
}

CapabilitiesCore holds webdav config

type CapabilitiesData

type CapabilitiesData struct {
	Capabilities *Capabilities `json:"capabilities" xml:"capabilities"`
	Version      *Version      `json:"version" xml:"version"`
}

CapabilitiesData TODO document

type CapabilitiesDav

type CapabilitiesDav struct {
	Chunking                       string   `json:"chunking" xml:"chunking"`
	Trashbin                       string   `json:"trashbin" xml:"trashbin"`
	Reports                        []string `json:"reports" xml:"reports>element" mapstructure:"reports"`
	ChunkingParallelUploadDisabled bool     `json:"chunkingParallelUploadDisabled" xml:"chunkingParallelUploadDisabled"`
}

CapabilitiesDav holds dav endpoint config

type CapabilitiesFiles

type CapabilitiesFiles struct {
	PrivateLinks      ocsBool                      `json:"privateLinks" xml:"privateLinks" mapstructure:"private_links"`
	BigFileChunking   ocsBool                      `json:"bigfilechunking" xml:"bigfilechunking"`
	Undelete          ocsBool                      `json:"undelete" xml:"undelete"`
	Versioning        ocsBool                      `json:"versioning" xml:"versioning"`
	Favorites         ocsBool                      `json:"favorites" xml:"favorites"`
	PermanentDeletion ocsBool                      `json:"permanent_deletion" xml:"permanent_deletion"`
	BlacklistedFiles  []string                     `json:"blacklisted_files" xml:"blacklisted_files>element" mapstructure:"blacklisted_files"`
	TusSupport        *CapabilitiesFilesTusSupport `json:"tus_support" xml:"tus_support" mapstructure:"tus_support"`
	Archivers         []*CapabilitiesArchiver      `json:"archivers" xml:"archivers" mapstructure:"archivers"`
	AppProviders      []*CapabilitiesAppProvider   `json:"app_providers" xml:"app_providers" mapstructure:"app_providers"`
}

CapabilitiesFiles TODO this is storage specific, not global. What effect do these options have on the clients?

type CapabilitiesFilesSharing

type CapabilitiesFilesSharing struct {
	APIEnabled                    ocsBool                                  `json:"api_enabled" xml:"api_enabled" mapstructure:"api_enabled"`
	Resharing                     ocsBool                                  `json:"resharing" xml:"resharing"`
	GroupSharing                  ocsBool                                  `json:"group_sharing" xml:"group_sharing" mapstructure:"group_sharing"`
	AutoAcceptShare               ocsBool                                  `json:"auto_accept_share" xml:"auto_accept_share" mapstructure:"auto_accept_share"`
	ShareWithGroupMembersOnly     ocsBool                                  `json:"share_with_group_members_only" xml:"share_with_group_members_only" mapstructure:"share_with_group_members_only"`
	ShareWithMembershipGroupsOnly ocsBool                                  `` /* 129-byte string literal not displayed */
	CanRename                     ocsBool                                  `json:"can_rename" xml:"can_rename" mapstructure:"can_rename"`
	AllowCustom                   ocsBool                                  `json:"allow_custom" xml:"allow_custom" mapstructure:"allow_custom"`
	SearchMinLength               int                                      `json:"search_min_length" xml:"search_min_length" mapstructure:"search_min_length"`
	DefaultPermissions            int                                      `json:"default_permissions" xml:"default_permissions" mapstructure:"default_permissions"`
	UserEnumeration               *CapabilitiesFilesSharingUserEnumeration `json:"user_enumeration" xml:"user_enumeration" mapstructure:"user_enumeration"`
	Federation                    *CapabilitiesFilesSharingFederation      `json:"federation" xml:"federation"`
	Public                        *CapabilitiesFilesSharingPublic          `json:"public" xml:"public"`
	User                          *CapabilitiesFilesSharingUser            `json:"user" xml:"user"`
}

CapabilitiesFilesSharing TODO document

type CapabilitiesFilesSharingFederation

type CapabilitiesFilesSharingFederation struct {
	Outgoing ocsBool `json:"outgoing" xml:"outgoing"`
	Incoming ocsBool `json:"incoming" xml:"incoming"`
}

CapabilitiesFilesSharingFederation holds outgoing and incoming flags

type CapabilitiesFilesSharingPublic

type CapabilitiesFilesSharingPublic struct {
	Enabled            ocsBool                                   `json:"enabled" xml:"enabled"`
	SendMail           ocsBool                                   `json:"send_mail" xml:"send_mail" mapstructure:"send_mail"`
	SocialShare        ocsBool                                   `json:"social_share" xml:"social_share" mapstructure:"social_share"`
	Upload             ocsBool                                   `json:"upload" xml:"upload"`
	Multiple           ocsBool                                   `json:"multiple" xml:"multiple"`
	SupportsUploadOnly ocsBool                                   `json:"supports_upload_only" xml:"supports_upload_only" mapstructure:"supports_upload_only"`
	CanEdit            ocsBool                                   `json:"can_edit" xml:"can_edit" mapstructure:"can_edit"`
	Password           *CapabilitiesFilesSharingPublicPassword   `json:"password" xml:"password"`
	ExpireDate         *CapabilitiesFilesSharingPublicExpireDate `json:"expire_date" xml:"expire_date" mapstructure:"expire_date"`
}

CapabilitiesFilesSharingPublic TODO document

type CapabilitiesFilesSharingPublicExpireDate

type CapabilitiesFilesSharingPublicExpireDate struct {
	Enabled ocsBool `json:"enabled" xml:"enabled"`
}

CapabilitiesFilesSharingPublicExpireDate TODO document

type CapabilitiesFilesSharingPublicPassword

type CapabilitiesFilesSharingPublicPassword struct {
	EnforcedFor *CapabilitiesFilesSharingPublicPasswordEnforcedFor `json:"enforced_for" xml:"enforced_for" mapstructure:"enforced_for"`
	Enforced    ocsBool                                            `json:"enforced" xml:"enforced"`
}

CapabilitiesFilesSharingPublicPassword TODO document

type CapabilitiesFilesSharingPublicPasswordEnforcedFor

type CapabilitiesFilesSharingPublicPasswordEnforcedFor struct {
	ReadOnly   ocsBool `json:"read_only" xml:"read_only,omitempty" mapstructure:"read_only"`
	ReadWrite  ocsBool `json:"read_write" xml:"read_write,omitempty" mapstructure:"read_write"`
	UploadOnly ocsBool `json:"upload_only" xml:"upload_only,omitempty" mapstructure:"upload_only"`
}

CapabilitiesFilesSharingPublicPasswordEnforcedFor TODO document

type CapabilitiesFilesSharingUser

type CapabilitiesFilesSharingUser struct {
	SendMail       ocsBool                     `json:"send_mail" xml:"send_mail" mapstructure:"send_mail"`
	ProfilePicture ocsBool                     `json:"profile_picture" xml:"profile_picture" mapstructure:"profile_picture"`
	Settings       []*CapabilitiesUserSettings `json:"settings" xml:"settings" mapstructure:"settings"`
}

CapabilitiesFilesSharingUser TODO document

type CapabilitiesFilesSharingUserEnumeration

type CapabilitiesFilesSharingUserEnumeration struct {
	Enabled          ocsBool `json:"enabled" xml:"enabled"`
	GroupMembersOnly ocsBool `json:"group_members_only" xml:"group_members_only" mapstructure:"group_members_only"`
}

CapabilitiesFilesSharingUserEnumeration TODO document

type CapabilitiesFilesTusSupport

type CapabilitiesFilesTusSupport struct {
	Version            string `json:"version" xml:"version"`
	Resumable          string `json:"resumable" xml:"resumable"`
	Extension          string `json:"extension" xml:"extension"`
	MaxChunkSize       int    `json:"max_chunk_size" xml:"max_chunk_size" mapstructure:"max_chunk_size"`
	HTTPMethodOverride string `json:"http_method_override" xml:"http_method_override" mapstructure:"http_method_override"`
}

CapabilitiesFilesTusSupport TODO this must be a summary of storages

type CapabilitiesGroupBased

type CapabilitiesGroupBased struct {
	Capabilities []string `json:"capabilities" xml:"capabilities" mapstructure:"capabilities"`
}

CapabilitiesGroupBased holds capabilities based on the groups a user belongs to

type CapabilitiesNotifications

type CapabilitiesNotifications struct {
	Endpoints []string `json:"ocs-endpoints,omitempty" xml:"ocs-endpoints>element,omitempty" mapstructure:"endpoints"`
}

CapabilitiesNotifications holds a list of notification endpoints

type CapabilitiesUserSettings

type CapabilitiesUserSettings struct {
	Enabled bool   `json:"enabled" xml:"enabled" mapstructure:"enabled"`
	Version string `json:"version" xml:"version" mapstructure:"version"`
}

CapabilitiesUserSettings holds available user settings service information

type ConfigData

type ConfigData struct {
	Version string `json:"version" xml:"version"`
	Website string `json:"website" xml:"website"`
	Host    string `json:"host" xml:"host"`
	Contact string `json:"contact" xml:"contact"`
	SSL     string `json:"ssl" xml:"ssl"`
}

ConfigData holds basic config

type Spaces

type Spaces struct {
	Version string `json:"version" xml:"version" mapstructure:"version"`
	Enabled bool   `json:"enabled" xml:"enabled" mapstructure:"enabled"`
}

Spaces lets a service configure its advertised options related to Storage Spaces.

type Status

type Status struct {
	Installed      ocsBool `json:"installed" xml:"installed"`
	Maintenance    ocsBool `json:"maintenance" xml:"maintenance"`
	NeedsDBUpgrade ocsBool `json:"needsDbUpgrade" xml:"needsDbUpgrade"`
	Version        string  `json:"version" xml:"version"`
	VersionString  string  `json:"versionstring" xml:"versionstring"`
	Edition        string  `json:"edition" xml:"edition"`
	ProductName    string  `json:"productname" xml:"productname"`
	Product        string  `json:"product" xml:"product"`
	Hostname       string  `json:"hostname,omitempty" xml:"hostname,omitempty"`
}

Status holds basic status information

type Version

type Version struct {
	Major   int    `json:"major" xml:"major"`
	Minor   int    `json:"minor" xml:"minor"`
	Micro   int    `json:"micro" xml:"micro"` // = patch level
	String  string `json:"string" xml:"string"`
	Edition string `json:"edition" xml:"edition"`
	Product string `json:"product" xml:"product"`
}

Version holds version information