Interface IClient
The IClient interface describes an ImageVault client.
Namespace: ImageVault.Client
Assembly: ImageVault.Client.dll
Syntax
public interface IClientProperties
Cookies
Cookies to append to each call to the server
Declaration
IDictionary<string, string> Cookies { get; set; }Property Value
| Type | Description |
|---|---|
| System.Collections.Generic.IDictionary<System.String, System.String> |
Remarks
Can be used to direct calls to a specific azure service instance by using the ARRAffinity cookie and supplying the instance Name as cookie value
PublishIdentifier
Get/Sets the PublishIdentifier of the Client
Declaration
string PublishIdentifier { get; set; }Property Value
| Type | Description |
|---|---|
| System.String | Defines the publish identifier to use |
Timeout
Get/Sets the Timeout of the IClient
Declaration
Nullable<int> Timeout { get; set; }Property Value
| Type | Description |
|---|---|
| System.Nullable<System.Int32> | The number of milliseconds to wait before the request times out. The default value is 100,000 milliseconds (100 seconds). If set to null, the default value will be used. |
Methods
CreateChannel<T>()
Creates a channel to a service
Declaration
T CreateChannel<T>()Returns
| Type | Description |
|---|---|
| T | The proxy channel to use for calling the service |
Type Parameters
| Name | Description |
|---|---|
| T | The type of the contract interface to call |
Load<T>(IEnumerable<Int32>)
Loads a set of specific items from ImageVault
Declaration
IIVQueryable<T> Load<T>(IEnumerable<int> ids)
where T : IItem<int>Parameters
| Type | Name | Description |
|---|---|---|
| System.Collections.Generic.IEnumerable<System.Int32> | ids | The System.Collections.Generic.IEnumerable<> of id of the items to load |
Returns
| Type | Description |
|---|---|
| IIVQueryable<T> | The matching objects from IV core |
Type Parameters
| Name | Description |
|---|---|
| T | The type of item to load (must be an IItem<T> of int. |
Load<T>(Int32)
Loads a specific item from ImageVault
Declaration
IIVQueryable<T> Load<T>(int id)
where T : IItem<int>Parameters
| Type | Name | Description |
|---|---|---|
| System.Int32 | id | The id of the item |
Returns
| Type | Description |
|---|---|
| IIVQueryable<T> | The matching objects from IV core |
Type Parameters
| Name | Description |
|---|---|
| T | The type of item to load (must be an IItem<T> of int. |
Query<T>()
Queries the client for items using linq syntax.
Declaration
IIVQueryable<T> Query<T>()Returns
| Type | Description |
|---|---|
| IIVQueryable<T> | The matching objects from IV core |
Type Parameters
| Name | Description |
|---|---|
| T | The type of object to get. |
Remarks
Now supports MediaItem (and subclasses) MetadataDefinition
Exceptions
| Type | Condition |
|---|---|
| System.NotImplementedException | If requesting types that is not yet implemented in the linq query provider. |
Store<T>(T)
Stores the supplied item
Declaration
void Store<T>(T item)
where T : classParameters
| Type | Name | Description |
|---|---|---|
| T | item |
Type Parameters
| Name | Description |
|---|---|
| T |
Exceptions
| Type | Condition |
|---|---|
| System.NotImplementedException | If store of . |