Fields

N
meta

Properties

DID
MJD
NUM
TID
date
datetime
format
pages
time
type

Methods

add()
field()
has()
remove()
set()

Quaero.DW.Document

Quaero.DW.Document Class

public class Quaero.DW.Document : Quaero.DW.Links;

One archived document.

N Field

System.Int32 (Quaero.DW.Document)document.N;

Number of this document within a search result. Starts at 1. See JSON n.

meta Field

System.Collections.Generic.Dictionary<System.String,System.String> (Quaero.DW.Document)document.meta;

A group of information fields and their value.

DID Property

System.Int64 (Quaero.DW.Document)document.DID;

Unique document ID. This is different from NUM in that it is a number, it is assigned by Quaero Archive and it will never be reused. See JSON did.

type Property

System.String (Quaero.DW.Document)document.type;

Short name of the document type. See JSON type and [Quero.REST.Agent.doc_type()].

NUM Property

System.String (Quaero.DW.Document)document.NUM;

Unique document number. This is the unique name you have assigned to the document. See JSON num.

date Property

System.String (Quaero.DW.Document)document.date;

Date the document was created. This is not necessarily the date it was uploaded to Quaero Archive. See JSON date.

time Property

System.String (Quaero.DW.Document)document.time;

Time at which the document was created. See JSON time.

pages Property

System.Int64 (Quaero.DW.Document)document.pages;

Number of pages in the document. Note that some file formats can't be parsed by Quaero Archive and will have pages = 0. See JSON pages.

MJD Property

System.Int64 (Quaero.DW.Document)document.MJD;

Modified Julian Date the document was created. This differs from date in that it is a number, not a string. See JSON mjd.

TID Property

System.Int64 (Quaero.DW.Document)document.TID;

Document type ID. This is a number unique to a given document type. See JSON tid.

format Property

System.String (Quaero.DW.Document)document.format;

Short name of the document file format. See JSON format and [Quaero.DW.Formats].

datetime Property

System.DateTime (Quaero.DW.Document)document.datetime;

Creates a [System.DateTime] object for when this document was created. See JSON datetime.

add() Method

void Quaero.DW.Document.add(System.String name, System.String value);

Add a new information field to the document.

Parameters

name: Name of the information field.
[System.String]
value: Value of the information field.
[System.String]

remove() Method

void Quaero.DW.Document.remove(System.String name);

Remove an information field from the document.

Parameters

name: Name of the information field.
[System.String]

has() Method

System.Boolean Quaero.DW.Document.has(System.String name);

Returns true if the document has the named information field.

Parameters

name: Name of the information field.
[System.String]

Returns

[System.Boolean]

field() Method

System.String Quaero.DW.Document.field(System.String name);

Fetches the value of the named information field.

Parameters

name: Name of the information field.
[System.String]

Returns

[System.String]

set() Method

void Quaero.DW.Document.set(System.String name, System.String value);

Set an information field to a new value. If the field doesn't exist, it is added.

Parameters

name: Name of the information field.
[System.String]
value: New value for the information field.
[System.String]