Provides interfaces related to WebShare. More...

#include <lswebshare.h>

Inheritance diagram for LSWebShare:

Static Public Member Functions
static LSResult::Result	getWebShareDataPath (const ref_ptr< const LSProject > &project, LSString &path)
	Gets the folder path of the most recent WebShare Cloud export of the provided project, with a trailing backslash. More...

static LSResult::Result	createWebShareData (const ref_ptr< const LSProject > &project, const ref_ptr< const LSWebShareSettings > &webshareSettings, const ref_ptr< const LSLoginSettings > &loginSettings=nullptr)
	Carries out a WebShare Cloud data export, including a parallel upload to a WebShare Cloud server if the login settings are provided as well. More...

Additional Inherited Members
Protected Member Functions inherited from LSRefType
void	ref () const
	Increments the internal reference counter. More...

void	unref () const
	Decrements the internal reference counter. More...

Detailed Description

Provides interfaces related to WebShare.

Member Function Documentation

static LSResult::Result getWebShareDataPath	(	const ref_ptr< const LSProject > &	project,
		LSString &	path
	)

static

Gets the folder path of the most recent WebShare Cloud export of the provided project, with a trailing backslash.

Parameters

	project	Project to use.
[out]	path	Found folder path. Guaranteed to be not empty if LSResult::Ok is returned. Guaranteed to be empty if an error code is returned.

Returns: An LSResult result code. Ok on success InvalidRequest on project-related failures Unauthorized on missing API key

static LSResult::Result createWebShareData	(	const ref_ptr< const LSProject > &	project,
		const ref_ptr< const LSWebShareSettings > &	webshareSettings,
		const ref_ptr< const LSLoginSettings > &	loginSettings = `nullptr`
	)

static

Carries out a WebShare Cloud data export, including a parallel upload to a WebShare Cloud server if the login settings are provided as well.

Calls the check methods of the settings objects to ensure that valid values are provided.

Parameters

project	Project for which the WebShare Cloud data should be created.
webshareSettings	Export settings that specify various aspects of the data export.
[loginSettings]	Login settings for establishing a connection to a WebShare Cloud server for a parallel upload.

Returns: An LSResult result code. Ok on success InvalidRequest on invalid settings, invalid context state or on user-initiated cancellation of the process ReadWrite on all kinds of file operation errors DuplicateName on duplicate name errors Unauthorized on all kinds of authentication and authorization errors and missing API key Network on all kinds of server connection errors Internal on all other errors