api.md

Classes

Article ⇐ Work

A class to hold a journal article.

Book ⇐ Work

A class to hold a book

Collection ⇐ Work

A class to hold a collection

Contributor

Contributors are libraries and other organisations that contribute to Trove. Contributors usually have a "name", an "id" and a "url". They may also have a "nuc" (National Union Catalogue) identifier assigned to them. If you want more information, pass RECLEVEL.FULL into the "reclevel" option. See ContributorList to retrieve lists of Contributors.

ContributorList

The ContributorList class is a wrapper around the "https://api.trove.nla.gov.au/v2/contributor" API. If no "terms" are specified on construction, you will have to call the get() method to actually request the data from Trove. If the "terms" are specified on construction, the get() method will be called immediately.

Gazette

A Class to hold government gazette articles.

See: http://help.nla.gov.au/trove/building-with-trove/api-version-2-technical-guide#anchor-6

List

A class to hold a list

See: http://help.nla.gov.au/trove/building-with-trove/api-version-2-technical-guide#anchor-5

Map ⇐ Work

A class to hold a map

Music ⇐ Work

A class to hold music

NewspaperArticle

A Class to hold newspaper articles.

See: http://help.nla.gov.au/trove/building-with-trove/api-version-2-technical-guide#anchor-6

NewspaperList

The NewspaperList class is a wrapper around the "https://api.trove.nla.gov.au/v2/newspaper/titles" API. If no state is specified on construction, you will have to call the get() method to actually request the data from Trove. If the state is specified on construction, the get() method will be called immediately.

Currently the Trove servers only give basic information on each newspaper title returned. If you want the list of years and issues, you'll have to call the NewspaperTitle.get() method directly, specifying includes and range.

NewspaperTitle

The NewspaperTitle class is a wrapper around the "https://api.trove.nla.gov.au/v2/newspaper/title" API. The NewspaperList class will return a list of these objects for a state (or all states).

Person

A class to hold a person. Please note that the Trove API does not currently support People except as a result of a search.

Picture ⇐ Work

A class to hold a picture

Search

An object to perform searches

Work

A class to hold a work. Work is the parent class for other classes (Article, Book, Collection, Map, Music, Picture).

See: http://help.nla.gov.au/trove/building-with-trove/api-version-2-technical-guide#anchor-4

Functions

init(key)

Article ⇐ Work

A class to hold a journal article.

Kind: global class
Extends: Work

• Article ⇐ Work
  • new exports.Article(options)
  • .process_done()
  • .process_fail()
  • .get(options)

new exports.Article(options)

Create an Article

Param	Type
options	Object

article.process_done()

Internal

Kind: instance method of Article

article.process_fail()

Internal

Kind: instance method of Article

article.get(options)

Get the Work metadata from the Trove server.

Kind: instance method of Article

Param	Type	Description
options	Object	The options object for the query.
options.id	number | string	The Work ID for which to retrieve data.
options.done	function	The callback on receipt of data (optional).
options.fail	function	The callback on failure (optional).
options.reclevel	RECLEVEL	Whether to return the brief or full record.
options.includes	Array.<INCLUDES>

Book ⇐ Work

A class to hold a book

Kind: global class
Extends: Work

• Book ⇐ Work
  • new exports.Book(options)
  • .process_done()
  • .process_fail()
  • .get(options)

new exports.Book(options)

Create an Book

Param	Type
options	Object

book.process_done()

Internal

Kind: instance method of Book

book.process_fail()

Internal

Kind: instance method of Book

book.get(options)

Get the Work metadata from the Trove server.

Kind: instance method of Book

Param	Type	Description
options	Object	The options object for the query.
options.id	number | string	The Work ID for which to retrieve data.
options.done	function	The callback on receipt of data (optional).
options.fail	function	The callback on failure (optional).
options.reclevel	RECLEVEL	Whether to return the brief or full record.
options.includes	Array.<INCLUDES>

Collection ⇐ Work

A class to hold a collection

Kind: global class
Extends: Work

• Collection ⇐ Work
  • new exports.Collection(options)
  • .process_done()
  • .process_fail()
  • .get(options)

new exports.Collection(options)

Param	Type
options	Object

collection.process_done()

Internal

Kind: instance method of Collection

collection.process_fail()

Internal

Kind: instance method of Collection

collection.get(options)

Get the Work metadata from the Trove server.

Kind: instance method of Collection

Param	Type	Description
options	Object	The options object for the query.
options.id	number | string	The Work ID for which to retrieve data.
options.done	function	The callback on receipt of data (optional).
options.fail	function	The callback on failure (optional).
options.reclevel	RECLEVEL	Whether to return the brief or full record.
options.includes	Array.<INCLUDES>

Contributor

Contributors are libraries and other organisations that contribute to Trove. Contributors usually have a "name", an "id" and a "url". They may also have a "nuc" (National Union Catalogue) identifier assigned to them. If you want more information, pass RECLEVEL.FULL into the "reclevel" option. See ContributorList to retrieve lists of Contributors.

Kind: global class
Properties

Name	Type	Description
id	string	The Trove identifier for the contributor.
url	string	The Trove-relative URL.
name	string	The name of the contributor.
nuc	Array.<string>	The list of NUCs for the contributor.
shortname	string	The short name of the contributor.
totalholdings	number	The number of holdings for the contributor.
accesspolicy	string	The access policy for the contributor.
algentry	string	Australian Libraries Gateway URL.
parent	Object	An object holding the parents of this contributor.
parent.id	string	The ID of the parent.
parent.url	string	The Trove-relative URL of the parent.
parent.value	string	The name of the parent.

• Contributor
  • new exports.Contributor(options)
  • .get_parent(options) ⇒ Contributor
  • .get(options)

new exports.Contributor(options)

Param	Type	Description
options	Object	The options object for the contributor.
options.init	string	The contributor ID for which to retrieve data on construction (optional).
options.reclevel	RECLEVEL	Whether to return the brief or full record (optional, default=brief).
options.done	function	The callback on receipt of data (optional).
options.fail	function	The callback on failure (optional).

contributor.get_parent(options) ⇒ Contributor

Get the parent Contributor for this Contributor. The "parent" attribute is only available if RECLEVEL.FULL was specified on requesting the data from Trove.

Kind: instance method of Contributor

Param	Type	Description
options	Object
options.done	function	The callback on completion (optional).
options.fail	function	The callback on failure (optional).

contributor.get(options)

Get the Contributor metadata from the Trove server. If "done" or "fail" are set, they will be copied into the object, overwriting any existing callbacks. This is also true for "id" and "reclevel".

Kind: instance method of Contributor

Param	Type	Description
options	Object	The options object for the query.
options.id	string	The Contributor ID (NUC code) for which to retrieve data (optional if specified previously).
options.reclevel	RECLEVEL	Whether to return the brief or full record (optional).
options.done	function	The callback on receipt of data (optional).
options.fail	function	The callback on failure (optional).

ContributorList

The ContributorList class is a wrapper around the "https://api.trove.nla.gov.au/v2/contributor" API. If no "terms" are specified on construction, you will have to call the get() method to actually request the data from Trove. If the "terms" are specified on construction, the get() method will be called immediately.

Kind: global class
Properties

Name	Type	Description
contributors	Array.<Contributor>	The list of Contributors returned from the query.

• ContributorList
  • new exports.ContributorList(options)
  • .get(options)

new exports.ContributorList(options)

Param	Type	Description
options	Object	An object specifying the options for this ContributorList.
options.terms	string	The search terms for which the contributor list will be returned (optional). If specified, the request will be made immediately. The search will be performed by the Trove servers on the NUC symbol and name.
options.reclevel	RECLEVEL	Whether to return the brief or full records (optional, default=brief).
options.done	function	The callback on receipt of data (optional).
options.fail	function	The callback on failure (optional).

contributorList.get(options)

Get the data from the Trove server. If "done" or "fail" are set, they will be copied into the object, overwriting any existing callbacks. This is also true for "terms" and "reclevel".

Kind: instance method of ContributorList

Param	Type	Description
options	Object	Options for the request.
options.terms	string	The search terms for which to request data (optional).
options.reclevel	RECLEVEL	Whether to return the brief or full records (optional).
options.done	function	The callback on receipt of data (optional).
options.fail	function	The callback on failure (optional).

Gazette

A Class to hold government gazette articles.

See: http://help.nla.gov.au/trove/building-with-trove/api-version-2-technical-guide#anchor-6

Kind: global class

• Gazette
  • new exports.Gazette(options)
  • .get(options)

new exports.Gazette(options)

Param	Type	Description
options	Object	An object specifying the default options
options.init	number	The article identifier for which to retrieve data on construction.
options.done	function	The callback on receipt of data (optional).
options.fail	function	The callback on failure (optional).
options.reclevel	RECLEVEL	Whether to return the brief or full record.
options.includes	Array.<INCLUDES>

gazette.get(options)

Retrieve article information from Trove based on identifier.

Kind: instance method of Gazette

Param	Type	Description
options	Object	The options object for the query.
options.id	number	The article ID for which to retrieve data.
options.done	function	The callback on receipt of data (optional).
options.fail	function	The callback on failure (optional).
options.reclevel	RECLEVEL	Whether to return the brief or full record.
options.includes	Array.<INCLUDES>

List

A class to hold a list

See: http://help.nla.gov.au/trove/building-with-trove/api-version-2-technical-guide#anchor-5

Kind: global class

• List
  • new exports.List(options)
  • .get(options)

new exports.List(options)

Param	Type	Description
options	Object	The options object for the list.
options.init	number | string	The list identifier for which to retrieve data on construction.
options.done	function	The callback on receipt of data (optional).
options.fail	function	The callback on failure (optional).
options.reclevel	RECLEVEL	Whether to return the brief or full record.
options.includes	Array.<INCLUDES>

list.get(options)

Get the List metadata from the Trove server.

Kind: instance method of List

Param	Type	Description
options	Object	The options object for the query.
options.id	number | string	The List ID for which to retrieve data.
options.done	function	The callback on receipt of data (optional).
options.fail	function	The callback on failure (optional).
options.reclevel	RECLEVEL	Whether to return the brief or full record.
options.includes	Array.<INCLUDES>

Map ⇐ Work

A class to hold a map

Kind: global class
Extends: Work

• Map ⇐ Work
  • new exports.Map(options)
  • .process_done()
  • .process_fail()
  • .get(options)

new exports.Map(options)

Param	Type
options	Object

map.process_done()

Internal

Kind: instance method of Map

map.process_fail()

Internal

Kind: instance method of Map

map.get(options)

Get the Work metadata from the Trove server.

Kind: instance method of Map

Param	Type	Description
options	Object	The options object for the query.
options.id	number | string	The Work ID for which to retrieve data.
options.done	function	The callback on receipt of data (optional).
options.fail	function	The callback on failure (optional).
options.reclevel	RECLEVEL	Whether to return the brief or full record.
options.includes	Array.<INCLUDES>

Music ⇐ Work

A class to hold music

Kind: global class
Extends: Work

• Music ⇐ Work
  • new exports.Music(options)
  • .process_done()
  • .process_fail()
  • .get(options)

new exports.Music(options)

Param	Type
options	Object

music.process_done()

Internal

Kind: instance method of Music

music.process_fail()

Internal

Kind: instance method of Music

music.get(options)

Get the Work metadata from the Trove server.

Kind: instance method of Music

Param	Type	Description
options	Object	The options object for the query.
options.id	number | string	The Work ID for which to retrieve data.
options.done	function	The callback on receipt of data (optional).
options.fail	function	The callback on failure (optional).
options.reclevel	RECLEVEL	Whether to return the brief or full record.
options.includes	Array.<INCLUDES>

NewspaperArticle

A Class to hold newspaper articles.

See: http://help.nla.gov.au/trove/building-with-trove/api-version-2-technical-guide#anchor-6

Kind: global class
Properties

Name	Type	Description
id	string	(brief) Trove newspaper article ID.
heading	string	(brief) The article heading.
category	string	(brief) The type of article
title	Object	(brief) The name and ID of the newspaper or periodical in which this article is found.
title.id	string	(brief) The Trove ID of the newspaper or periodical.
title.value	string	(brief) The name of the newspaper or periodical.
edition	string	(brief) Name of the special edition of the newspaper or periodical in which this article is found, if applicable.
date	string	(brief) The date of the issue in which this article was published.
page	number	(brief) The page on which this article appeared.
pageSequence	number	(brief)
pageLabel	string	(reclevel=full)
status	string	(brief) Included is the article is not currently available.
relevance	string	(brief, following search) How relevant this article is to the search.
relevance.score	string	(brief, following search) A numeric representation of how relevant this article is to the search.
snippet	string	(brief, following search) A small amount of text containing one or more of the search terms.
troveUrl	string	(brief)
trovePageUrl	string	(brief)
supplement	string	(reclevel=full)
section	string	(reclevel=full)
illustrated	string	(reclevel=full)
wordCount	number	(reclevel=full)
correctionCount	number	(reclevel=full)
listCount	number	(reclevel=full)
tagCount	number	(reclevel=full)
commentCount	number	(reclevel=full)
tag	Array.<Object>	(include=tags)
tag.lastupdated	string
tag.value	string
comment	Array.<Object>	(include=comments)
comment.by	string
comment.lastupdated	string
comment.value	string
list	Array.<Object>	(include=lists)
list.by	string
list.lastupdated	string
list.url	string
lastCorrection	Object	(reclevel=full)
lastCorrection.by	string	(reclevel=full)
lastCorrection.lastupdated	string	(reclevel=full)
identifier	string	(reclevel=full)
pdf	string	(reclevel=full)
articleText	string	(include=articletext)

• NewspaperArticle
  • new exports.NewspaperArticle(options)
  • .get(options)
  • .get_newspaper(options) ⇒ NewspaperTitle

new exports.NewspaperArticle(options)

Param	Type	Description
options	Object	An object specifying the default options
options.init	number	The article identifier for which to retrieve data on construction.
options.done	function	The callback on receipt of data (optional).
options.fail	function	The callback on failure (optional).
options.reclevel	RECLEVEL	Whether to return the brief or full record.
options.includes	Array.<INCLUDES>

newspaperArticle.get(options)

Retrieve article information from Trove based on identifier.

Kind: instance method of NewspaperArticle

Param	Type	Description
options	Object	The options object for the query.
options.id	number	The article ID for which to retrieve data.
options.done	function	The callback on receipt of data (optional).
options.fail	function	The callback on failure (optional).
options.reclevel	RECLEVEL	Whether to return the brief or full record.
options.includes	Array.<INCLUDES>

newspaperArticle.get_newspaper(options) ⇒ NewspaperTitle

Retrieve newspaper title information for the article

Kind: instance method of NewspaperArticle
Returns: NewspaperTitle - The NewspaperTitle object that contains the NewspaperArticle.

Param	Type	Description
options	Object	The options object for the query.
options.done	function	The callback on receipt of data (optional).

NewspaperList

The NewspaperList class is a wrapper around the "https://api.trove.nla.gov.au/v2/newspaper/titles" API. If no state is specified on construction, you will have to call the get() method to actually request the data from Trove. If the state is specified on construction, the get() method will be called immediately.

Currently the Trove servers only give basic information on each newspaper title returned. If you want the list of years and issues, you'll have to call the NewspaperTitle.get() method directly, specifying includes and range.

Kind: global class
Properties

Name	Type	Description
newspapers	Array.<NewspaperTitle>	The list of NewspaperTitles returned from the query.

• NewspaperList
  • new exports.NewspaperList(options)
  • .get(options)

new exports.NewspaperList(options)

Param	Type	Description
options	Object	An object specifying the options for this NewspaperList.
options.state	STATES	The state for which the newspaper list will be returned (optional). If specified, the request will be made immediately.
options.done	function	The callback on receipt of data (optional).
options.fail	function	The callback on failure (optional).

newspaperList.get(options)

Get the data from the Trove server. If done or fail are set, they will be copied into the object, overwriting any existing callbacks.

Kind: instance method of NewspaperList

Param	Type	Description
options	Object	Options for the request.
options.state	STATES	The state for which to request data (optional). If not set, or set to ALL, all states will be returned.
options.done	function	The callback on receipt of data (optional).
options.fail	function	The callback on failure (optional).

NewspaperTitle

The NewspaperTitle class is a wrapper around the "https://api.trove.nla.gov.au/v2/newspaper/title" API. The NewspaperList class will return a list of these objects for a state (or all states).

Kind: global class
Properties

Name	Type	Description
id	string	The Trove identifier for the newspaper title.
title	string	Name of the newpaper (or magazine).
state	string	The state in which the newspaper title was published.
stateabbr	string	An abbreviation for the state.
issn	number	International Standard Serial Number.
troveURL	string	A link to view the newspaper title in Trove.
startDate	string	The earliest publication date of this newspaper title available in Trove.
endDate	string	The most recent publication date of this newspaper title available in Trove.
year	Array.<Object>	A list of the publication years for this newspaper title that are included in Trove.
year.date	string	A year this newspaper title was published
year.issuecount	string	The number of issues published in this year.
year.issue	Array.<Object>	List of issues within the specified range.
year.issue.id	string	The Trove issue identifier.
year.issue.date	string	The data of the issue.
year.issue.url	string	The Trove URL for the issue.

• NewspaperTitle
  • new exports.NewspaperTitle(options)
  • .get(options)

new exports.NewspaperTitle(options)

Param	Type	Description
options	Object	The options used on construction. Every object property can be set on construction through this parameter.
options.init	number | string	If specified, will request the data immediately.

newspaperTitle.get(options)

Get information about the specified newspaper title from Trove.

Kind: instance method of NewspaperTitle

Param	Type	Description
options	Object
options.id	number | string	The identifier of the newspaper title to retrieve. If not specified, will fall back to the id set on construction. (optional)
options.includes	Array.<INCLUDES>	The data to include in the results. Trove currently only supports INCLUDES.YEARS.
options.range	string	If YEARS is included, return a list of publication dates in the given range. Of the form: YYYYMMDD-YYYYMMDD.

Person

A class to hold a person. Please note that the Trove API does not currently support People except as a result of a search.

Kind: global class
Properties

Name	Type	Description
id	string	The Trove identifier for the person
troveUrl	string	The full URL for the person
url	string	The relative URL for the person

• Person
  • new exports.Person(options)
  • .get(options)

new exports.Person(options)

Param	Type	Description
options	Object	The options object for the Person.
options.init	number | string	The Person identifier for which to retrieve data on construction.
options.done	function	The callback on receipt of data (optional).
options.fail	function	The callback on failure (optional).
options.reclevel	RECLEVEL	Whether to return the brief or full record.
options.includes	Array.<INCLUDES>

person.get(options)

Get the Person metadata from the Trove server. Currently not supported by Trove.

Kind: instance method of Person

Param	Type	Description
options	Object	The options object for the query.
options.id	number | string	The person ID for which to retrieve data.
options.done	function	The callback on receipt of data (optional).
options.fail	function	The callback on failure (optional).
options.reclevel	RECLEVEL	Whether to return the brief or full record.
options.includes	Array.<INCLUDES>

Picture ⇐ Work

A class to hold a picture

Kind: global class
Extends: Work

• Picture ⇐ Work
  • new exports.Picture(options)
  • .process_done()
  • .process_fail()
  • .get(options)

new exports.Picture(options)

Param	Type
options	Object

picture.process_done()

Internal

Kind: instance method of Picture

picture.process_fail()

Internal

Kind: instance method of Picture

picture.get(options)

Get the Work metadata from the Trove server.

Kind: instance method of Picture

Param	Type	Description
options	Object	The options object for the query.
options.id	number | string	The Work ID for which to retrieve data.
options.done	function	The callback on receipt of data (optional).
options.fail	function	The callback on failure (optional).
options.reclevel	RECLEVEL	Whether to return the brief or full record.
options.includes	Array.<INCLUDES>

Search

An object to perform searches

Kind: global class
Properties

Name	Type	Description
response	Object	The raw response from the server.
items	Array.<Object>	The object containing the items created from the raw response.
facets	Array.<FACETS>	The list of facets to include in the data returned.
limits	Object	The limits imposed on the search.

• Search
  • new exports.Search(options)
  • .zone_list(zone) ⇒ Array.<Object>
  • .remove_facet(facet)
  • .add_facet(facet)
  • .clear_date_range_limit()
  • .limit_date_range(start)
  • .query(options)
  • .requery(options, delta)
  • .next(zone, options)
  • .previous(zone, options)

new exports.Search(options)

Param	Type	Description
options	Object	An object specifying the options for this Search
options.zones	Array.<ZONES>	The list of zones to search
options.done	function	The callback on receipt of data (optional).
options.fail	function	The callback on failure (optional).
options.terms	string	The search terms

search.zone_list(zone) ⇒ Array.<Object>

Return the array of items returned by the most recent query in the specified zone.

Kind: instance method of Search

Param	Type	Description
zone	ZONES	The zone for which the array should be returned.

search.remove_facet(facet)

Remove the named facet.

Kind: instance method of Search

Param	Type	Description
facet	FACETS	The name of the facet to remove

search.add_facet(facet)

Add the named facet.

Kind: instance method of Search

Param	Type	Description
facet	FACETS	The name of the facet to add

search.clear_date_range_limit()

Clear the date range limits.

Kind: instance method of Search

search.limit_date_range(start)

Set the limits on the date range returned

Kind: instance method of Search

Param	Type	Description
start	string	The date limit, one of: YYY for decade, YYYY for year, or YYYY-MM for month

search.query(options)

Query the Trove database.

Kind: instance method of Search

Param	Type	Description
options	Object	An object containing, at least, the terms to search for.
options.done	function	The callback on receipt of data (optional).
options.fail	function	The callback on failure (optional).
options.zones	Array.<ZONES>	The list of zones to search (mandatory).
options.terms	string	The search terms (mandatory).
options.start	number	Return records starting at this point (optional, default=*).
options.number	number	Return this number of records (max. 100, optional, default=20).
options.sort	SORTBY	Sort the results according to this parameter (optional, default=SORTBY.RELEVANCE).
options.reclevel	RECLEVEL	Whether to return the brief or full record.
options.includes	Array.<INCLUDES>
options.limits	Object	Limit the search results (optional, see LIMITS).
options.facets	Array.<FACETS>

search.requery(options, delta)

Repeat the last query, with a delta applied to the start.

Kind: instance method of Search

Param	Type	Description
options	Object	Options to be applied to the query
options.done	function	The callback on receipt of data (optional).
options.fail	function	The callback on failure (optional).
delta	number	The change to be applied to the start number (positive or negative).

search.next(zone, options)

Request the next search results

Although an initial search may cover more than one zone, getting results through this interface must specify a singe zone.

Kind: instance method of Search

Param	Type	Description
zone	string	The zone in which to get the results.
options	Object	Options to be applied to the query
options.done	function	The callback on receipt of data (optional).
options.fail	function	The callback on failure (optional).

search.previous(zone, options)

Request the previous search results.

Although an initial search may cover more than one zone, getting results through this interface must specify a singe zone.

Kind: instance method of Search

Param	Type	Description
zone	string	The zone in which to get the results.
options	Object	Options to be applied to the query
options.done	function	The callback on receipt of data (optional).
options.fail	function	The callback on failure (optional).

Work

A class to hold a work. Work is the parent class for other classes (Article, Book, Collection, Map, Music, Picture).

See: http://help.nla.gov.au/trove/building-with-trove/api-version-2-technical-guide#anchor-4

Kind: global class
Properties

Name	Type	Description
id	string
url	string
troveUrl	string
title	string
contributor	Array.<string>
issued	number | string	When the work was issued
type	Array.<string>	List of work types
isPartOf	string	?
subject	string	?
abstract	string	?
tableOfContents	string	?
language	Array.<string>	List of languages
wikipedia	string	?
holdingsCount	number
versionCount	number
tagCount	number
tagCount.level	string
commentCount	number
commentCount.level	string
listCount	number
tag	string
tag.lastupdated	string
comment	string
comment.lastupdated	string
comment.by	string
comment.rating	string
list	string
list.url	string
list.by	string
list.lastupdated	string
identifier	Array.<Object>
identifier.type	string
identifier.linktype	string
identifier.linktext	string
identifier.value	string
holding	string
holding.nuc	string
holding.name	string
holding.library	string
holding.url	string
holding.callNumber	string
version	string
version.id	string
version.record	string

• Work
  • new exports.Work(options)
  • .process_done()
  • .process_fail()
  • .get(options)

new exports.Work(options)

Create a Work object instance.

Param	Type	Description
options	Object	The options object for the work.
options.init	number | string	The work identifier for which to retrieve data on construction.
options.done	function	The callback on receipt of data (optional).
options.fail	function	The callback on failure (optional).
options.reclevel	RECLEVEL	Whether to return the brief or full record.
options.includes	Array.<INCLUDES>	TODO: Not complete

work.process_done()

Internal

Kind: instance method of Work

work.process_fail()

Internal

Kind: instance method of Work

work.get(options)

Get the Work metadata from the Trove server.

Kind: instance method of Work

Param	Type	Description
options	Object	The options object for the query.
options.id	number | string	The Work ID for which to retrieve data.
options.done	function	The callback on receipt of data (optional).
options.fail	function	The callback on failure (optional).
options.reclevel	RECLEVEL	Whether to return the brief or full record.
options.includes	Array.<INCLUDES>

ZONES : enum

Enumeration for zones, can include multiple as a list

Kind: global enum
Read only: true
Properties

Name	Type	Description
BOOK	string	The zone for books.
PICTURE	string	The zone for pictures
ARTICLE	string	The zone for journal articles
MUSIC	string	The zone for music
MAP	string	The zone for maps
COLLECTION	string	The zone for collections
NEWSPAPER	string	The zone for newspapers
GAZETTE	string	The zone for government gazettes
LIST	string	The zone for lists
PEOPLE	string	The zone for people
ALL	string	All of the above

FORMATS : enum

Enumeration for formats. See http://help.nla.gov.au/trove/building-with-trove/api-version-2-technical-guide#formats Used for facets and limits.

Kind: global enum
Read only: true

AVAILABILITIES : enum

(book, picture, article, music, map, collection, list) Enumeration for availability.

Used for facets and limits.

Kind: global enum
Read only: true

VENDORS : enum

(article) The vendor who sells subscriptions to access a database containing these articles.

Used for facets and limits.

Kind: global enum
Read only: true

AUDIENCES : enum

(article) Only applies to articles from Gale.

Used for facets and limits.

Kind: global enum
Read only: true
Properties

Name	Type	Description
TRADE	string	Trade
GENERAL	string	General
ACADEMIC	string	Academic
PROFESSIONAL	string	Professional
CHILDREN	string	Children's
CHILDRENUPPER	string	Children's - Upper elementry
CHILDRENLOWER	string	Children's - Lower elementry

CATEGORIES : enum

Enumeration for NewspaperArticle and Gazette categories. Returned as part of the brief record for NewspaperArticle and Gazette, and may also be used to limit the results of a search using LIMITS.CATEGORY.

Used for facets and limits.

Kind: global enum
Read only: true
Properties

Name	Type	Description
ARTICLE	string	Classified as an article (newspaper).
ADVERTISING	string	Classified as advertising (newspaper).
LISTS	string	Classified as a list (newspaper).
FAMILY_NOTICES	string	Classified as family notices (newspaper).
LITERATURE	string	Classified as literature (newspaper).
NOTICES	string	Classified as notices (gazettes).
TENDERS	string	Classified as Tenders and Contracts (gazettes).
PROCLAMATIONS	string	Classified as Proclamations And Legislation (gazettes).
PRIVATE	string	Classified as Private Notices (gazettes).
BUDGET	string	Classified as Budgetary Papers (gazettes).
INDEX	string	Classified as Index And Contents (gazettes).
APPOINTMENTS	string	Classified as Appointments And Employment (gazettes).
FOI	string	Classified as Freedom Of Information (gazettes).

FACETS : enum

Enumeration for facets.

See http://help.nla.gov.au/trove/building-with-trove/api-version-2-technical-guide#facetValues

Facets are categories that describe all the records in a particular result set. For example, if you have 10 results, you can check the format facet to find out that 8 are books and 2 are theses. You could also modify your search to retrieve only the theses, or only the books.

Kind: global enum
Read only: true

LIMITS : enum

Enumeration for limiting the results of a search.

Kind: global enum
Read only: true

SORTBY : enum

Enumeration for sort order.

Kind: global enum
Read only: true

RECLEVEL : enum

Enumeration for record level

Kind: global enum
Read only: true

INCLUDES : enum

Enumeration for includes, can include multiple as a list.

Kind: global enum
Read only: true

STATES : enum

Enumeration for Australian states. Used to specify a state for which to return Newspaper titles using the NewspaperList class. To return all Newspapers for all states, do not specify a state when making the query via NewspaperList or use ALL.

Kind: global enum
Read only: true

init(key)

Kind: global function

Param	Type	Description
key	string	The Trove API key given to you by the National Library of Australia. This function should be called before any queries are made to the Trove servers.