history
struct[] history(bool Hidden);
Request for list of items in history-list.
(bool)
- Also return hidden history records. Use this only if you need to see the old (hidden) history records (Kind=DUP). Normal (unhidden) records are always returned.This method returns an array of structures with following fields:
(int)
- ID of NZB-file.v13.0
NZBID
instead.(string)
- Kind of history item. One of the predefined text constants:(string)
- Name of nzb-file, this file was added to queue from. The filename could include fullpath (if client sent it by adding the file to queue).(string)
- The name of nzb-file or info-name of URL, without path and extension. Ready for user-friendly output.(string)
- nzb-file name.(string)
- v12.0
NZBName
instead.(string)
- URL.(bool)
- Has completed files.(int)
- Date/time when the file was added to history (Time is in C/Unix format).(string)
- Destination directory for output files.(string)
- Final destination if set by one of post-processing scripts.(string)
- Category for group or empty string if none category is assigned.(int)
- Initial size of all files in group in bytes, Low 32-bits of 64-bit value.(int)
- Initial size of all files in group in bytes, High 32-bits of 64-bit value.(int)
- Initial size of all files in group in MiB.(int)
- Initial number of files in group.(int)
- Number of parked files in group. If this number is greater than 0
, the history item can be returned to download queue using command HistoryReturn
of method editqueue.(int)
- Date/time when the oldest file in the item was posted to newsgroup (Time is in C/Unix format).(int)
- Date/time when the newest file in the item was posted to newsgroup (Time is in C/Unix format).(int)
- Total number of articles in all files of the group.(int)
- Number of successfully downloaded articles.(int)
- Number of failed article downloads.(int)
- Final health of the group, in permille. 1000 means 100.0%. Higher values are better.(int)
- Calculated critical health of the group, in permille. 1000 means 100.0%. The critical health is calculated based on the number and size of par-files. Lower values are better.(bool)
- v12.0
(int)
- v14.0
Amount of downloaded data for group in bytes, Low 32-bits of 64-bit value.(int)
- v14.0 Amount of downloaded data for group in bytes, High 32-bits of 64-bit value.(int)
- v14.0
Amount of downloaded data for group in MiB.(int)
- v14.0
Download time in seconds.(int)
- v14.0
Total post-processing time in seconds.(int)
- v14.0
Par-check time in seconds (incl. verification and repair).(int)
- v14.0
Par-repair time in seconds.(int)
- v14.0
Unpack time in seconds.(int)
- v15.0
Number of messages stored in the item log. Messages can be retrieved with method loadlog.(string)
- Duplicate key. See RSS.(int)
- Duplicate score. See RSS.(string)
- Duplicate mode. One of SCORE, ALL, FORCE. See RSS.(string)
- Total status of the download. One of the predefined text constants such as SUCCESS/ALL
or FAILURE/UNPACK
, etc. For the complete list see below.(string)
- Result of par-check/repair:ParCheck
is set to Manual
.(string)
- v16.0
Indicates if the download was repaired using duplicate par-scan mode (option ParScan=dupe
):(string)
- Result of unpack:(string)
- Result of URL-download:(string)
- Accumulated result of all post-processing scripts. One of the predefined text constants: NONE
, FAILURE
, SUCCESS
. Also see field ScriptStatuses
.(struct[])
- Status info of each post-processing script. See below.(string)
- Result of moving files from intermediate directory into final directory:InterDir
is not in use or the par-check or unpack have failed;(string)
- Indicates if the download was deleted:v14.0
the download was marked as BAD
by a queue-script during download;v16.0
the download was deleted because the nzb-file could not be parsed (malformed nzb-file);v16.0
the download was deleted by duplicate check because an nzb-file with exactly same content exists in download queue or in history.(string)
- Indicates if the download was marked by user:Mark as good
in history dialog;Mark as bad
in history dialog;(int)
- v16.0
amount of extra par-blocks received from other duplicates or donated to other duplicates, when duplicate par-scan mode was used (option ParScan
=dupe
):(struct[])
- Post-processing parameters for group. For description of struct see method listgroups.(struct[])
- Per-server article completion statistics.(struct[])
- v13.0
Field Status
can be set to one of the following values:
For history items with Kind=NZB
SUCCESS/ALL
but no post-processing scripts were executed. Downloaded and unpacked successfully. Par-check was successful or was not necessary.SUCCESS/ALL
but no post-processing scripts were executed. Downloaded and par-checked successfully. No unpack was made (there are no archive files or unpack was disabled for that download or globally). At least one of the post-processing scripts has failed.v15.0
The download was marked as success by user using command Mark as success
in history dialog.ParCheck=Manual
).ParRepair=no
).v16.0
The download was deleted by duplicate check because this nzb-file already exists in download queue or in history.v16.0
The download was deleted by duplicate check because there is a duplicate history item with status GOOD
or a duplicate hidden history item with statusSUCCESS
which do not have any visible duplicates.v16.0
nzb-file could not be parsed (malformed nzb-file).Mark as bad
in history dialog.For history items with Kind=URL
For history items with Kind=DUP
SUCCESS
.FAILURE
.Mark as bad
in history dialog.Contains an array of structs with following fields:
(string)
- Script name.(string)
- Result of post-processing script exection. One of the predefined text constants: NONE
, FAILURE
, SUCCESS
.Contains an array of structs with following fields:
(int)
- Server number as defined in section news servers
of the configuration file.(int)
- Number of successfully downloaded articles.(int)
- Number of failed articles.