@ctrl/nzbget
    Preparing search index...

    Interface NzbGetQueueItem

    Queue item returned by listgroups.

    interface NzbGetQueueItem {
        ActiveDownloads: number;
        Category: string;
        CriticalHealth?: number;
        Deleted?: boolean;
        DeleteStatus?: NzbGetDeleteStatus;
        DestDir?: string;
        DownloadedSizeHi?: number;
        DownloadedSizeLo?: number;
        DownloadedSizeMB?: number;
        DownloadTimeSec?: number;
        DupeKey?: string;
        DupeMode?: NzbGetDupeMode;
        DupeScore?: number;
        ExParStatus?: NzbGetExParStatus;
        ExtraParBlocks?: number;
        FailedArticles?: number;
        FileCount?: number;
        FileSizeHi: number;
        FileSizeLo: number;
        FileSizeMB?: number;
        FinalDir?: string;
        FirstID: number;
        Health?: number;
        Kind?: NzbGetQueueKind;
        LastID: number;
        Log?: NzbGetLogEntry[];
        MarkStatus?: NzbGetMarkStatus;
        MaxPostTime?: number;
        MaxPriority: number;
        MessageCount?: number;
        MinPostTime?: number;
        MinPriority: number;
        MoveStatus?: NzbGetMoveStatus;
        NZBFilename?: string;
        NZBID: number;
        NZBName: string;
        NZBNicename?: string;
        Parameters: NzbGetParameter[];
        ParStatus?: NzbGetParStatus;
        ParTimeSec?: number;
        PausedSizeHi: number;
        PausedSizeLo: number;
        PausedSizeMB?: number;
        PostInfoText?: string;
        PostStageProgress?: number;
        PostStageTimeSec?: number;
        PostTotalTimeSec?: number;
        RemainingFileCount?: number;
        RemainingParCount?: number;
        RemainingSizeHi: number;
        RemainingSizeLo: number;
        RemainingSizeMB?: number;
        RepairTimeSec?: number;
        ScriptStatus?: NzbGetScriptStatus;
        ScriptStatuses?: NzbGetScriptStatusEntry[];
        ServerStats?: NzbGetServerStat[];
        Status?: NzbGetQueueStatus;
        SuccessArticles?: number;
        TotalArticles?: number;
        UnpackStatus?: NzbGetUnpackStatus;
        UnpackTimeSec?: number;
        URL?: string;
        UrlStatus?: NzbGetUrlStatus;
        [key: string]: unknown;
    }

    Indexable

    • [key: string]: unknown
    Index
    ActiveDownloads Category CriticalHealth? Deleted? DeleteStatus? DestDir? DownloadedSizeHi? DownloadedSizeLo? DownloadedSizeMB? DownloadTimeSec? DupeKey? DupeMode? DupeScore? ExParStatus? ExtraParBlocks? FailedArticles? FileCount? FileSizeHi FileSizeLo FileSizeMB? FinalDir? FirstID Health? Kind? LastID Log? MarkStatus? MaxPostTime? MaxPriority MessageCount? MinPostTime? MinPriority MoveStatus? NZBFilename? NZBID NZBName NZBNicename? Parameters ParStatus? ParTimeSec? PausedSizeHi PausedSizeLo PausedSizeMB? PostInfoText? PostStageProgress? PostStageTimeSec? PostTotalTimeSec? RemainingFileCount? RemainingParCount? RemainingSizeHi RemainingSizeLo RemainingSizeMB? RepairTimeSec? ScriptStatus? ScriptStatuses? ServerStats? Status? SuccessArticles? TotalArticles? UnpackStatus? UnpackTimeSec? URL? UrlStatus?
    ActiveDownloads: number

    Number of files in the group currently downloading.

    Category: string

    Assigned category, or an empty string when none is set.

    CriticalHealth?: number

    Critical health threshold, in permille.

    Deleted?: boolean

    Since v12. Use DeleteStatus.

    DeleteStatus?: NzbGetDeleteStatus

    Result of delete handling during post-processing.

    DestDir?: string

    Destination directory for output file.

    DownloadedSizeHi?: number

    Downloaded size, high 32 bits.

    DownloadedSizeLo?: number

    Downloaded size, low 32 bits.

    DownloadedSizeMB?: number

    Downloaded size in megabytes.

    DownloadTimeSec?: number

    Download time in seconds.

    DupeKey?: string

    Duplicate key.

    DupeMode?: NzbGetDupeMode

    Duplicate mode.

    DupeScore?: number

    Duplicate score.

    ExParStatus?: NzbGetExParStatus

    Duplicate par-scan repair status during post-processing.

    ExtraParBlocks?: number

    Extra par blocks received from or donated to duplicates.

    FailedArticles?: number

    Number of failed article downloads.

    FileCount?: number

    Initial number of files in the group.

    FileSizeHi: number

    Total group size in bytes, high 32 bits.

    FileSizeLo: number

    Total group size in bytes, low 32 bits.

    FileSizeMB?: number

    Initial group size in megabytes.

    FinalDir?: string

    Final destination set by post-processing scripts.

    FirstID: number

    Deprecated alias for NZBID.

    Health?: number

    Current health of the group, in permille.

    Kind?: NzbGetQueueKind

    Kind of queue entry.

    LastID: number

    Deprecated alias for NZBID.

    Log?: NzbGetLogEntry[]

    Since v15. Always empty, use loadlog.

    MarkStatus?: NzbGetMarkStatus

    Final mark assigned during post-processing.

    MaxPostTime?: number

    Newest article timestamp in Unix seconds.

    MaxPriority: number

    Priority of the group. "Max" in the name has historical reasons.

    MessageCount?: number

    Number of messages stored in item log.

    MinPostTime?: number

    Oldest article timestamp in Unix seconds.

    MinPriority: number

    Since v13. Use MaxPriority.

    MoveStatus?: NzbGetMoveStatus

    Result of moving output during post-processing.

    NZBFilename?: string

    Source nzb filename, possibly including a path.

    NZBID: number

    ID of the NZB entry.

    NZBName: string

    Friendly NZB name without path or extension.

    NZBNicename?: string

    Deprecated alias for NZBName.

    Parameters: NzbGetParameter[]

    Per-item parameters attached to the queue entry.

    ParStatus?: NzbGetParStatus

    Result of par-check or repair during post-processing.

    ParTimeSec?: number

    Par-check time in seconds.

    PausedSizeHi: number

    Total paused file size in bytes, high 32 bits.

    PausedSizeLo: number

    Total paused file size in bytes, low 32 bits.

    PausedSizeMB?: number

    Total paused file size in megabytes.

    PostInfoText?: string

    Short description of the current post-processing action.

    PostStageProgress?: number

    Current post-processing stage completion in permille.

    Only valid while the group is being post-processed. Otherwise NZBGet prints a junk value (e.g. -980469752) due to a format-string mismatch in AppendPostInfoFields.

    PostStageTimeSec?: number

    Seconds spent in the current post-processing stage.

    PostTotalTimeSec?: number

    Total seconds spent in post-processing.

    RemainingFileCount?: number

    Remaining number of files in the group.

    RemainingParCount?: number

    Remaining number of par files in the group.

    RemainingSizeHi: number

    Remaining group size in bytes, high 32 bits.

    RemainingSizeLo: number

    Remaining group size in bytes, low 32 bits.

    RemainingSizeMB?: number

    Remaining group size in megabytes.

    RepairTimeSec?: number

    Repair time in seconds.

    ScriptStatus?: NzbGetScriptStatus

    Result of post-processing scripts during post-processing.

    ScriptStatuses?: NzbGetScriptStatusEntry[]

    Per-script results during post-processing.

    ServerStats?: NzbGetServerStat[]

    Per-server article statistics.

    Status?: NzbGetQueueStatus

    Aggregate group status string.

    SuccessArticles?: number

    Number of successfully downloaded articles.

    TotalArticles?: number

    Total number of articles in the group.

    UnpackStatus?: NzbGetUnpackStatus

    Result of unpacking during post-processing.

    UnpackTimeSec?: number

    Unpack time in seconds.

    URL?: string

    URL where the NZB file was fetched or should be fetched.

    UrlStatus?: NzbGetUrlStatus

    Result of the URL fetch for URL items. UNKNOWN while fetching.

    Settings
    Member Visibility

    On This Page
    Properties