listgroups
struct[] listgroups(int NumberOfLogEntries);
Request for list of downloads (nzb-files). This method returns summary information for each group (nzb-file).
(int)
- v15.0
Log
), which should be returned for the top (currently processing) item in post-processing state. Deprecated, must be 0.This method returns array of structures with following fields:
(int)
- ID of NZB-file.(int)
- v13.0
NZBID
instead.(int)
- v13.0
NZBID
instead.(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 without path and extension. Ready for user-friendly output.(string)
- v15.0
NZBName
instead.(string)
- Kind of queue entry: NZB or URL.(string)
- URL where the NZB-file was fetched (Kind=NZB)
or should be fetched (Kind=URL)
.(string)
- Destination directory for output file.(string)
- Final destination if set by one of post-processing scripts. Can be set only for items in post-processing state.(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)
- Remaining size of all (remaining) files in group in bytes, Low 32-bits of 64-bit value.(int)
- Remaining size of all (remaining) files in group in bytes, High 32-bits of 64-bit value.(int)
- Remaining size of all (remaining) files in group in MiB.(int)
- Size of all paused files in group in bytes, Low 32-bits of 64-bit value.(int)
- Size of all paused files in group in bytes, High 32-bits of 64-bit value.(int)
- Size of all paused files in group in MiB.(int)
- Initial number of files in group.(int)
- Remaining (current) number of files in group.(int)
- Remaining (current) number of par-files in group.(int)
- Date/time when the oldest file in the group was posted to newsgroup (Time is in C/Unix format).(int)
- Date/time when the newest file in the group was posted to newsgroup (Time is in C/Unix format).(int)
- v13.0
MaxPriority
instead.(int)
- Priority of the group. “Max” in the field name has historical reasons.(int)
- Number of active downloads in the group. With this filed can be determined what group(s) is (are) being currently downloaded. In most cases only one group is downloaded at a time however more that one group can be downloaded simultaneously when the first group is almost completely downloaded.(string)
- Status of the group:(Kind=URL)
;(int)
- Total number of articles in all files of the group.(int)
- Number of successfully downloaded articles.(int)
- Number of failed article downloads.(int)
- Current health of the group, in permille. 1000 means 100.0%. The health can go down below this valued during download if more article fails. It can never increase (unless merging of groups). 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.(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)
- v15.0
Number of messages stored in the item log. Messages can be retrieved with method loadlog.(string)
- Duplicate key. RSS.(int)
- Duplicate score. RSS.(string)
- Duplicate mode. One of SCORE, ALL, FORCE. RSS.(struct[])
- Post-processing parameters for group. An array of structures with following fields:(string)
- Name of post-processing parameter.(string)
- Value of post-processing parameter.(bool)
- v12.0
(struct[])
- Per news-server download statistics. For description see method history.(string)
- Text with short description of current action in post processor. For example: Verifying file myfile.rar
. Only for a group which is being currently post-processed.(int)
- Completing of current stage, in permille. 1000 means 100.0%. Only for a group which is being currently post-processed.(int)
- Number of seconds this post-job is being processed (after it first changed the state from PP-QUEUED). Only for a group which is being currently post-processed.(int)
- Number of seconds the current stage is being processed. Only for a group which is being currently post-processed.(struct[])
- v15.0
NumberOfLogEntries
. Deprecated, use method loadlog instead.