alfresco-ng2-components/docs/content-services/upload-version-button.component.md
Andy Stark ad5dcfe7c3 [ADF-3909] Updated references to JS-API in docs (#4176)
* [ADF-3909] Updated references to JSAPI classes in docs

* [ADF-3909] Removed obsolete Document library model doc page

* [ADF-3909] Updated JSAPI import lines in code samples
2019-01-17 12:55:05 +00:00

3.4 KiB

Title, Added, Status, Last reviewed
Title Added Status Last reviewed
Upload Version Button Component (Workaround) v2.3.0 Experimental 2018-03-23

Upload Version Button Component (Workaround)

Activates a file version upload.

Until further backend API improvements are implemented, this component is meant to be used to enrich the features and decrease the restrictions currently applied to node version uploading.

Basic usage

<adf-upload-version-button
    staticTitle="Upload new version"
    [node]="node"
    [rootFolderId]="node.parentId"
    [versioning]="true"
    (success)="onUploadSuccess($event)"
    (error)="onUploadError($event)">
</adf-upload-version-button>

Class members

Properties

Name Type Default value Description
acceptedFilesType string "*" Filter for accepted file types.
comment string When you overwrite existing content, you can use the comment field to add a version comment that appears in the version history
disabled boolean false Toggles component disabled state (if there is no node permission checking).
majorVersion boolean false majorVersion boolean field to true to indicate a major version should be created.
maxFilesSize number Sets a limit on the maximum size (in bytes) of a file to be uploaded. Has no effect if undefined.
multipleFiles boolean false Allows/disallows multiple files
node Node (Required) The node to be versioned.
nodeType string "cm:content" Custom node type for uploaded file
rootFolderId string "-root-" The ID of the root. Use the nodeId for Content Services or the taskId/processId for Process Services.
staticTitle string Defines the text of the upload button.
tooltip string null Custom tooltip text.
uploadFolders boolean false Allows/disallows upload folders (only for Chrome).
versioning boolean false Toggles versioning.

Events

Name Type Description
beginUpload EventEmitter<UploadFilesEvent> Emitted when the upload begins.
error EventEmitter<Object> Emitted when an error occurs.
permissionEvent EventEmitter<PermissionModel> Emitted when create permission is missing.
success EventEmitter<Object> Emitted when the file is uploaded successfully.

Details

This component extends the Upload Button component. The properties and events are the same except for the node property that specifies the node to be versioned (this is a required input parameter). However, some properties don't make sense when applied to the Upload Version Button component, so they are simply ignored.

See also