CFilesystemInstaller Class Reference

#include <FilesystemInstaller.h>

Public Types
using	ProgressCallback = std::function<void(unsigned int progress, unsigned int total)>

Public Member Functions
	CFilesystemInstaller ()
bool	InstallToFilesystem (const std::string &archive, const std::string &addonId, const ProgressCallback &onProgress) const
bool	UnInstallFromFilesystem (const std::string &addonPath) const

Detailed Description

Responsible for safely unpacking/copying/removing addon files from/to the addon folder.

Member Typedef Documentation

ProgressCallback

using CFilesystemInstaller::ProgressCallback = std::function<void(unsigned int progress, unsigned int total)>

Constructor & Destructor Documentation

CFilesystemInstaller()

CFilesystemInstaller::CFilesystemInstaller

(

)

Member Function Documentation

InstallToFilesystem()

bool CFilesystemInstaller::InstallToFilesystem	(	const std::string &	archive,
		const std::string &	addonId,
		const ProgressCallback &	onProgress ) const

Parameters

archive	Absolute path to zip file to install.
addonId
onProgress	Called repeatedly while unpacking, may be empty.

Returns

true on success, otherwise false.

UnInstallFromFilesystem()

bool CFilesystemInstaller::UnInstallFromFilesystem

(

const std::string &

addonPath

)

const

---

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

• FilesystemInstaller.h
• FilesystemInstaller.cpp