Quaero.DW.Queue

Quaero.DW.Queue

Quaero.DW.Queue Class

public class Quaero.DW.Queue : Quaero.DW.Links;
Details of one processing queue. See REST API processing queues

name Field

System.String (Quaero.DW.Queue)queue.name;
Short name of this processing queue. See JSON name.

accepts Field

System.String[] (Quaero.DW.Queue)queue.accepts;
List of file categories this queue accepts. May contain "meta" or "document" or both. See JSON accepts.

accepts_meta Property

System.Boolean (Quaero.DW.Queue)queue.accepts_meta;
Returns true if this queue accepts document information files.

accepts_document Property

System.Boolean (Quaero.DW.Queue)queue.accepts_document;
Returns true if this queue accepts document files.

upload() Method

Quaero.DW.Batch Quaero.DW.Queue.upload(System.String src, System.String dest);
Upload one file to this queue.

Parameters

src
Full pathname to the file you want uploaded.
[System.String]
dest
Name of file on the server. Optional; defaults to the base name of src.
[System.String]

Returns

Example

using Quaero;
DW.Batch batch = q.upload( doc );
DW.Queue incoming = agent.scanner( "todo" );
batch.upload( @"C:\temp\scan1-20190912-124221-0001.tif" );
batch.close();

upload_req() Method

System.Net.Http.HttpRequestMessage Quaero.DW.Queue.upload_req(System.String src, System.String dest);
Build an HTTP request to upload a file

Parameters

src
Full pathname to the file you want uploaded.
[System.String]
dest
Name of file on the server. Optional; defaults to the base name of src.
[System.String]

Returns

upload() Method

Quaero.DW.Batch Quaero.DW.Queue.upload(Quaero.DW.Document doc);
Upload a [Quaero.DW.Document].

Parameters

doc
The document information to be uploaded
[Quaero.DW.Document]

Returns

Example

using Quaero;

DW.Document doc = new DW.Document ();
doc.NUM = agent.sequence( "TG" );
doc.type = "contract";
doc.date = "2019-04-03";
doc.set( "client", "Something inc" );        
doc.set( "year", "2019" );
// ... any other information fields get set here.

DW.Queue q = agent.queue( "incoming" );
DW.Batch batch = q.upload( doc );
batch.upload( @"C:\temp\contract.pdf", doc.NUM + ".pdf" );
batch.close();

upload_req() Method

System.Net.Http.HttpRequestMessage Quaero.DW.Queue.upload_req(Quaero.DW.Document doc);
Build a REST API request that uploads a Document.

Parameters

doc
The document you wish to upload.
[Quaero.DW.Document]

Returns

ToString() Method

 Quaero.DW.Queue.ToString();
Returns the short name of this processing queue.

Implicit Conversion To System.String

implicit public static operator System.String (Quaero.DW.Queue o);
Implicit conversion of a processing queue into it's short name.

Parameters

o
[Quaero.DW.Queue]

Returns