RepositoryApiClient Class Reference

The Laserfiche Repository API client. More...

Inheritance diagram for RepositoryApiClient:

Static Public Member Functions
static IRepositoryApiClient	CreateFromAccessKey (string servicePrincipalKey, AccessKey accessKey, string scope=null, string baseUrlDebug=null)
	Create a Laserfiche repository client that will use Laserfiche Cloud OAuth client credentials to get access tokens. More...
static IRepositoryApiClient	CreateFromHttpRequestHandler (IHttpRequestHandler httpRequestHandler, string baseUrlDebug=null)
	Create a Laserfiche repository client. More...
static IRepositoryApiClient	CreateFromUsernamePassword (string repositoryId, string username, string password, string baseUrl)
	Create a Laserfiche repository client that will use username and password to get access tokens for Laserfiche API. Password credentials grant type is implemented by the Laserfiche Self-Hosted API server. Not available in cloud. More...

Properties
IAttributesClient	AttributesClient [get]
IAuditReasonsClient	AuditReasonsClient [get]
HttpRequestHeaders	DefaultRequestHeaders [get]
IEntriesClient	EntriesClient [get]
IFieldDefinitionsClient	FieldDefinitionsClient [get]
ILinkDefinitionsClient	LinkDefinitionsClient [get]
IRepositoriesClient	RepositoriesClient [get]
ISearchesClient	SearchesClient [get]
ISimpleSearchesClient	SimpleSearchesClient [get]
ITagDefinitionsClient	TagDefinitionsClient [get]
ITasksClient	TasksClient [get]
ITemplateDefinitionsClient	TemplateDefinitionsClient [get]
Properties inherited from IRepositoryApiClient
IAttributesClient	AttributesClient [get]
	The Laserfiche Repository Attributes API client. More...
IAuditReasonsClient	AuditReasonsClient [get]
	The Laserfiche Repository Audit Reasons API client. More...
HttpRequestHeaders	DefaultRequestHeaders [get]
	The headers which will be sent with each request. More...
IEntriesClient	EntriesClient [get]
	The Laserfiche Repository Entries API client. More...
IFieldDefinitionsClient	FieldDefinitionsClient [get]
	The Laserfiche Repository Field Definitions API client. More...
ILinkDefinitionsClient	LinkDefinitionsClient [get]
	The Laserfiche Repository Link Definitions API client. More...
IRepositoriesClient	RepositoriesClient [get]
	The Laserfiche Repository Repositories API client. More...
ISearchesClient	SearchesClient [get]
	The Laserfiche Repository Searches API client. More...
ISimpleSearchesClient	SimpleSearchesClient [get]
	The Laserfiche Repository Simple Searches API client. More...
ITagDefinitionsClient	TagDefinitionsClient [get]
	The Laserfiche Repository Tag Definitions API client. More...
ITasksClient	TasksClient [get]
	The Laserfiche Repository Tasks API client. More...
ITemplateDefinitionsClient	TemplateDefinitionsClient [get]
	The Laserfiche Repository Template Definitions API client. More...

Detailed Description

The Laserfiche Repository API client.

Member Function Documentation

CreateFromAccessKey()

static IRepositoryApiClient CreateFromAccessKey ( string  servicePrincipalKey, AccessKey  accessKey, string  scope = null, string  baseUrlDebug = null  )

inlinestatic

Create a Laserfiche repository client that will use Laserfiche Cloud OAuth client credentials to get access tokens.

Parameters

servicePrincipalKey	The service principal key created for the service principal from the Laserfiche Account Administration.
accessKey	The access key exported from the Laserfiche Developer Console.
scope	(optional) The requested space-delimited scopes for the access token.
baseUrlDebug	(optional) Override for the Laserfiche repository API base url.

Returns

IRepositoryApiClient

CreateFromHttpRequestHandler()

static IRepositoryApiClient CreateFromHttpRequestHandler ( IHttpRequestHandler  httpRequestHandler, string  baseUrlDebug = null  )

inlinestatic

Create a Laserfiche repository client.

Parameters

httpRequestHandler	The http request handler for the Laserfiche APIs.
baseUrlDebug	(optional) Override for the Laserfiche repository API base url.

Returns

IRepositoryApiClient

CreateFromUsernamePassword()

static IRepositoryApiClient CreateFromUsernamePassword ( string  repositoryId, string  username, string  password, string  baseUrl  )

inlinestatic

Create a Laserfiche repository client that will use username and password to get access tokens for Laserfiche API. Password credentials grant type is implemented by the Laserfiche Self-Hosted API server. Not available in cloud.

Parameters

repositoryId	The repository ID.
username	The username.
password	The password.
baseUrl	API server base URL e.g., https://{APIServerName}/LFRepositoryAPI.

Returns

IRepositoryApiClient

---

The documentation for this class was generated from the following file:

• src/RepositoryApiClient.cs