NZBFacadeFile documentation.

NZBFacadeFile methods.

setId

void setId(int id)

Set the file ID.

variables
int
id
returns
void
none

setFileName

void setFileName(const std::string name)

Set the NZB file name.

variables
name
File name
returns
void
none

setSize

void setSize(const size_t lsize)

Set the size of the file.

variables
lsize
File size
returns
void
none

setRemainingSize

void setRemainingSize(const size_t lsize)

Set the size remaining to be downloaded.

variables
lsize
Size remaining
returns
void
none

setPaused

void setPaused(const bool lpaused)

Set the running/paused status.

variables
lpaused
True for paused false for running.
returns
void
none

setDeleted

void setDeleted(const bool ldeleted)

When the file is deleted from the filesystem, this is set to true

variables
lpaused
True when the NZB file is deleted from the filesystem.
returns
void
none

setCompleted

void setCompleted(const int lcompleted)

Set te true when the download is completed.

variables
lcompleted
Set True when NZB is finished downloading.
returns
void
none

getId

int getId()

Set te true when the download is completed.

variables
lcompleted
Set True when NZB is finished downloading.
returns
int
Get the id the NZB file has in libNZBGet.

getFileName

const std::string &getFileName()

Set te true when the download is completed.

variables
none
none
returns
string
Filename of the NZB file.

getSize

size_t getSize() const

Get the NZB file size.

variables
none
none
returns
size_t
Size of the NZB file.

getRemainingSize

size_t getRemainingSize() const

Get the size to be downloaded.

variables
none
none
returns
size_t
Remaining Size of the NZB file.

getPaused

bool getPaused() const

Get the running/pauze state.

variables
none
none
returns
bool
True when the NZB is pauzed, otherwise, false.

getDeleted

bool getDeleted() const

When the NZB file is deleted from the filesystem, this method returns true.

variables
none
none
returns
bool
True when the NZB is deleted, otherwise, false.

getCompleted

bool getCompleted() const

This method returs true when the NZB has completed downloading.

variables
none
none
returns
bool
True when the NZB is finished downloading, otherwise, false.