HoarderServiceClient Class

A .NET client class for the Hoarder web service API. All methods, request bodies and response bodies are mapped to strongly-typed C# shared library classes.

Inheritance Hierarchy

System.Object
Orthogonal.Hoarder.StdLib.HoarderServiceClient

Namespace: Orthogonal.Hoarder.StdLib
Assembly: Orthogonal.Hoarder.StdLib (in Orthogonal.Hoarder.StdLib.dll) Version: 8.0.9

Syntax

Copy

public sealed class HoarderServiceClient : IDisposable

The HoarderServiceClient type exposes the following members.

Constructors

	Name	Description
	HoarderServiceClient	Constructs a strongly-typed .NET client to the Hoarder REST-style web service.

Top

Properties

	Name	Description
	ServiceUri	Gets the Uri of the base endpoint of the web service.
	Token	Gets the authorization token (JSON Web Token) of the web service.

Top

Methods

	Name	Description
	AddVisitorBookEntry	Adds an entry to the visitor book.
	AssignSource	Assigns a source title in a set of titles.
	BulkAssign	Bulk assigns the property values of many Titles to the same values.
	CheckApiKey	Checks an ApiKey to gain application permissions.
	ClearTitleGenres	Clears all genres from Titles with Ids that match an argument set of Ids.
	DataFixup	Performs a custom fixup (repair) of certain information in Titles, and then updates the configuration document to ensure it is synchronised with the Titles.
	DeletePictureBlob	Deletes a picture blob.
	DeleteTitle	Deletes a title.
	DeleteWorkerLog	Deletes a worker log.
	Dispose	Releases all resources used by the HoarderServiceClient
	ExportCollectionToJsonBlob	Starts an export of the entire database to a JSON document in the backup container.
	ExportCollectionToXmlBlob	Starts an export of the entire database to an XML document in the backup container.
	ExportToAzureTables	Starts an exports the entire database to Azure Tables in the backup storage account.
	ExportToTsvNormalised	Starts an export of the entire database to normalized TSV files in the backup container.
	GetDatabaseStats	Retrieves database query statistics and performance information.
	GetDatabaseSummary	Retreives a summary of the counts of different types and values in the database.
	GetGlobalConfig	Returns the Hoarder application suite configuration values.
	GetMetadata	Lists metadata about the web service and the data manager.
	GetWorkerLogLines	Gets the lines of a specific worker log.
	GlobalNameSearch	Runs a global search for a string in Title titles, Picture names, Track names, File names and Contributor names.
	ListBlobVDirMetadata	Gets metadata for picture blobs with a virtual directory prefix -- WARNING LARGE RESPONSE BODY.
	ListContributorsInverted	Gets an array of inverted contributors.
	ListDuplicateTitles	Lists duplicate titles.
	ListPicMetaShort	Gets short metadata for picture blobs.
	ListPicturesInverted	Gets an array of inverted pictures.
	ListRandomTitles	Lists random titles.
	ListThumbMetaShort	Gets short metadata for picture blobs.
	ListTitleItems
	ListTitles	This is a special method to convert a previous POST into a new GET.
	ListTitlesByContributorName	Lists titles containing a specified name as one of the contributors.
	ListTitlesByLegacyId	Lists titles with a legacy Int32 Id from previous databases.
	ListTitlesByPictureBlobName	Lists titles containing a specified blob name as one of the pictures.
	ListUniqueContributorNames	Lists unique constributor names in all titles in the database.
	ListVisitorBookEntries	Lists all visitor book entries.
	ListWorkerLogs	Lists the short blob names of all worker logs.
	Login	Converts an API Key into a JWT.
	PurgeGenre	Purges a genre from the database and removes it from all titles.
	ReadBlobMetadata	Gets metadata attached to the picture blob.
	ReadConfig	Reads the Hoarder database configuration record.
	ReadGlobalConfig	Returns the Hoarder application configuration.
	ReadTitle	Retrieves a single title by Id.
	RenameContributor	Renames a contributor and all Title references to the contributor.
	RenameLocation	Renames a Location in all titles that reference the name.
	RenameMedia	Renames a Media in all titles that reference the name.
	RenameOwner	Renames an Owner in all titles that reference the name.
	RenameTag	Renames a Tag in all titles that reference the name.
	RepairMissingPhotos	Scans the Pictures references in Titles to see if they exist as a blob.
	RepsertTitle	Replaces or inserts a title.
	SetPictureMetadata	Sets picture metadata.
	UpdateConfig	Updates the Hoarder database configuration record.
	UpdateTitleFromItem	Updates a title with values from a title list item.
	UploadPicture	Uploads a picture.
	UseCountGenre	Gets a count of titles with a specified genre name.
	UseCountLocation	Gets a count of titles with a specified location name.
	UseCountMedia	Gets a count of titles with a specified media name.
	UseCountOwner	Gets a count of titles with a specified owner name.
	UseCountRole	Gets a count of titles with a specified role name.
	UseCountTag	Gets a count of titles with a specified tag name.

Top

Fields

	Name	Description
	AuthHeaderName	This is the name of the custom request header that the Hoarder web service recognises as providing an authorisation key to access features that update the database or retrieve private information. Failure to provide the key causes the service to redact selected private information from responses or reject some operations.

Top

Remarks

The Hoarder web service only returns response codes 200, 403 and 404. This client class handles these codes as follows:

200 (OK)	Corresponds to a web service successful call. The type documented for the method is returned.
403 (Unauthorized)	Corresponds to a service failure due to lack of authorization. A valid authorization token must be placed in the Token property for the call to succeed. The absence of an authorization token will cause some service calls to return redacted data, but some calls require the token and in these cases the 403 status code is converted into a UnauthorizedAccessException.
404 (NotFound)	Only two service endpoints return status 404 (ReadTitle(String) and ReadBlobMetadata(String)), and in both cases the 404 is converted into a null return value indicating to the client caller that the requested data was not found.
Other	Any other status code is interpreted as an unhandled error and it converted in to an Exception. The main causes of this condition might be a 'bug' in the Hoarder code or data, or an external problem such as a network failure that is unrelated to the Hoarder code.

Reference

Orthogonal.Hoarder.StdLib Namespace