Class ImageVaultClientOptions

Configuration options for the ImageVaultClient

Inheritance
System.Object
ImageVaultClientOptions
Namespace: ImageVault.Client.Configuration
Assembly: ImageVault.Client.dll
Syntax
public class ImageVaultClientOptions : Object

Constructors

ImageVaultClientOptions()

Declaration
public ImageVaultClientOptions()

Fields

ConfigurationSectionName

Default Section name for the Options class

Declaration
public const string ConfigurationSectionName = "ImageVault:Client"
Field Value
Type Description
System.String

Properties

ApiUrl

The url to Core. If not set, use the Url or UiUrl with the /apiv2/ suffix

Declaration
public Uri ApiUrl { get; set; }
Property Value
Type Description
System.Uri

ApiVersion

What version of the Api to use

Declaration
public ApiVersion ApiVersion { get; set; }
Property Value
Type Description
ApiVersion

ClientCache

Options for client cache

Declaration
public ClientCacheOptions ClientCache { get; set; }
Property Value
Type Description
ClientCacheOptions

CurrentUser

Optional configuration to configure a current user

Declaration
public CredentialsOptions CurrentUser { get; set; }
Property Value
Type Description
CredentialsOptions

DefaultMediaUrlBase

Get/Sets the media url base that is used as default for all media requests.

Declaration
public string DefaultMediaUrlBase { get; set; }
Property Value
Type Description
System.String

DefaultPublishedMediaUrlBase

Get/Sets the media url base that is used for all published media requests

Declaration
public string DefaultPublishedMediaUrlBase { get; set; }
Property Value
Type Description
System.String

PublishIdentifier

Declaration
public string PublishIdentifier { get; set; }
Property Value
Type Description
System.String

PublishIdentifierGenerator

Declaration
public Func<string> PublishIdentifierGenerator { get; set; }
Property Value
Type Description
System.Func<System.String>

SdkUser

Configuration for the SdkUser

Declaration
public CredentialsOptions SdkUser { get; set; }
Property Value
Type Description
CredentialsOptions

UiUrl

Gets the uri to the Ui

Declaration
public Uri UiUrl { get; set; }
Property Value
Type Description
System.Uri

Url

Gets the url to the ImageVault server

Declaration
public Uri Url { get; set; }
Property Value
Type Description
System.Uri

Methods

GetApiUri()

Method for building the resulting url string depending on whether host and scheme shall be reused or not.

Declaration
public Uri GetApiUri()
Returns
Type Description
System.Uri

The resulting url
Exceptions
Type Condition
System.ApplicationException

If url needs to be relative when the attribute useRelativeAddress is true. or if unknown url .

GetPublishIdentifier()

Gets the publish identifier to use when publishing media

Declaration
public string GetPublishIdentifier()
Returns
Type Description
System.String

GetUiUri()

Declaration
public Uri GetUiUri()
Returns
Type Description
System.Uri
Exceptions
Type Condition
ImageVaultConfigurationException

ReadFrom(ImageVaultClientOptions)

Reads the data from the supplied object

Declaration
public void ReadFrom(ImageVaultClientOptions configOptions)
Parameters
Type Name Description
ImageVaultClientOptions configOptions

Extension Methods