electron/shell/browser/api/electron_api_download_item.h

92 lines
2.8 KiB
C
Raw Normal View History

// Copyright (c) 2015 GitHub, Inc.
// Use of this source code is governed by the MIT license that can be
// found in the LICENSE file.
#ifndef SHELL_BROWSER_API_ELECTRON_API_DOWNLOAD_ITEM_H_
#define SHELL_BROWSER_API_ELECTRON_API_DOWNLOAD_ITEM_H_
#include <string>
2015-09-24 07:55:45 +00:00
#include "base/files/file_path.h"
2020-04-03 00:22:46 +00:00
#include "base/memory/weak_ptr.h"
#include "components/download/public/common/download_item.h"
#include "gin/handle.h"
2020-04-03 00:22:46 +00:00
#include "gin/wrappable.h"
#include "shell/browser/event_emitter_mixin.h"
#include "shell/browser/ui/file_dialog.h"
2020-04-03 00:22:46 +00:00
#include "shell/common/gin_helper/pinnable.h"
#include "url/gurl.h"
namespace electron {
namespace api {
2020-04-03 00:22:46 +00:00
class DownloadItem : public gin::Wrappable<DownloadItem>,
public gin_helper::Pinnable<DownloadItem>,
public gin_helper::EventEmitterMixin<DownloadItem>,
public download::DownloadItem::Observer {
public:
2020-04-03 00:22:46 +00:00
static gin::Handle<DownloadItem> FromOrCreate(v8::Isolate* isolate,
download::DownloadItem* item);
2015-09-24 11:31:09 +00:00
static DownloadItem* FromDownloadItem(download::DownloadItem* item);
2020-04-03 00:22:46 +00:00
// gin::Wrappable
static gin::WrapperInfo kWrapperInfo;
gin::ObjectTemplateBuilder GetObjectTemplateBuilder(
v8::Isolate* isolate) override;
const char* GetTypeName() override;
// JS API, but also C++ calls it sometimes
void SetSavePath(const base::FilePath& path);
base::FilePath GetSavePath() const;
file_dialog::DialogSettings GetSaveDialogOptions() const;
private:
DownloadItem(v8::Isolate* isolate, download::DownloadItem* item);
2020-04-03 00:22:46 +00:00
~DownloadItem() override;
bool CheckAlive() const;
// download::DownloadItem::Observer
void OnDownloadUpdated(download::DownloadItem* item) override;
void OnDownloadDestroyed(download::DownloadItem* item) override;
2020-04-03 00:22:46 +00:00
// JS API
2016-02-02 12:11:39 +00:00
void Pause();
2016-06-09 11:51:01 +00:00
bool IsPaused() const;
2016-02-02 12:11:39 +00:00
void Resume();
2016-06-09 11:51:01 +00:00
bool CanResume() const;
2016-02-02 12:11:39 +00:00
void Cancel();
2016-03-08 14:28:53 +00:00
int64_t GetReceivedBytes() const;
int64_t GetTotalBytes() const;
2016-02-02 12:11:39 +00:00
std::string GetMimeType() const;
bool HasUserGesture() const;
std::string GetFilename() const;
std::string GetContentDisposition() const;
const GURL& GetURL() const;
v8::Local<v8::Value> GetURLChain() const;
download::DownloadItem::DownloadState GetState() const;
2016-06-09 11:51:01 +00:00
bool IsDone() const;
void SetSaveDialogOptions(const file_dialog::DialogSettings& options);
std::string GetLastModifiedTime() const;
std::string GetETag() const;
double GetStartTime() const;
2016-02-02 12:11:39 +00:00
base::FilePath save_path_;
file_dialog::DialogSettings dialog_options_;
download::DownloadItem* download_item_;
v8::Isolate* isolate_;
2020-04-03 00:22:46 +00:00
base::WeakPtrFactory<DownloadItem> weak_factory_{this};
DISALLOW_COPY_AND_ASSIGN(DownloadItem);
};
} // namespace api
} // namespace electron
#endif // SHELL_BROWSER_API_ELECTRON_API_DOWNLOAD_ITEM_H_