class-harmonie - harmon.ie

harmon.ie SDK class library documentation

Harmonie.SDK.UploadOperationHandler Class Reference

This class changes the harmon.ie upload behavior.

Inheritance diagram for Harmonie.SDK.UploadOperationHandler:

Public Member Functions

virtual void init (ISidebar sidebar, bool isMulti)

Initialize the plugin with the sidebar context.


virtual bool onBeforeUpload (IWrappedList items)

This method is called before starting to upload *all* the items to SharePoint. This is the recommended entry point for changing the upload behavior. In order to rename the document, you must implement this method.
virtual

UploadAction onBeforeUpload (IUploadItemData single)

This method is called for each uploaded item, before it is uploaded to SharePoint. Implement this method for specific item manipulating, for example, displaying a specific UI for each item.


virtual void onAfterUpload (IWrappedList items, bool uploadCancelled)

This method is called after uploading *all* the items to SharePoint. It is recommended to implement this method for cleanup.


virtual void onAfterUpload (IUploadItemData single, UploadAction res)

This method is called for each uploaded item, after it is uploaded to SharePoint. Implement this method if you want to change the metadata of successfully-uploaded items.

Properties

ISidebar Sidebar [get, set]

Returns the sidebar object.
bool IsMultiUpload [get, set]

Are we uploading one or multiple items.

Detailed Description

This class changes the harmon.ie upload behavior.

Member Function Documentation

virtual void Harmonie.SDK.UploadOperationHandler.init

(ISidebar sidebar,bool isMulti )[virtual]

Initialize the plugin with the sidebar context.

Parameters:

sidebarThe sidebar object

isMultiAre we uploading one or multiple items

Implements Harmonie.SDK.IUploadOperationHandler.

virtual void Harmonie.SDK.UploadOperationHandler.onAfterUpload(IUploadItemDatasingle,UploadActionres )[virtual]

This method is called for each uploaded item, after it is uploaded to SharePoint. Implement this method if you want to change the metadata of successfully-uploaded items.

Parameters:

itemsIUploadItemData item that was actually uploaded to SharePoint

uploadCancelledIndicates whether the upload process was cancelled before this method was called

Implements Harmonie.SDK.IUploadOperationHandler.

virtual void Harmonie.SDK.UploadOperationHandler.onAfterUpload(IWrappedList items,bool uploadCancelled )[virtual]

This method is called after uploading *all* the items to SharePoint. It is recommended to implement this method for cleanup.

Parameters:

items List of IUploadItemData items that were actually uploaded to SharePoint

uploadCancelledIndicates whether the upload process was cancelled before this method was called

Implements Harmonie.SDK.IUploadOperationHandler.

virtual UploadAction Harmonie.SDK.UploadOperationHandler.onBeforeUpload(IUploadItemDatasingle)[virtual]

This method is called for each uploaded item, before it is uploaded to SharePoint. Implement this method for specific item manipulating, for example, displaying a specific UI for each item.

Parameters:

singleIUploadItemData item that is to be uploaded to SharePoint

Returns:

false if upload process must be cancelled, true - otherwise

Implements Harmonie.SDK.IUploadOperationHandler.

virtual bool Harmonie.SDK.UploadOperationHandler.onBeforeUpload(IWrappedList items)[virtual]

This method is called before starting to upload *all* the items to SharePoint. This is the recommended entry point for changing the upload behavior. In order to rename the document, you must implement this method.

Parameters:

itemsList of IUploadItemData items that are to be uploaded to SharePoint

Returns:

false if upload process must be cancelled, true - otherwise

Implements Harmonie.SDK.IUploadOperationHandler.

Property Documentation

bool Harmonie.SDK.UploadOperationHandler.IsMultiUpload [get, set]

Are we uploading one or multiple items.

ISidebar Harmonie.SDK.UploadOperationHandler.Sidebar [get, set]

Returns the sidebar object.

The documentation for this class was generated from the following file:

  • UploadOperationHandler.cs

All Classes Namespaces Functions Variables Properties

© Copyright 2022 harmon.ie. All trademarks, trade names, service marks and logos referenced herein belong to their respective companies