Show / Hide Table of Contents

Class ArasVaultConnection

Class for uploading files to and downloading files from an Aras vault

Inheritance
System.Object
ArasVaultConnection
Inherited Members
System.Object.Equals(System.Object)
System.Object.Equals(System.Object, System.Object)
System.Object.GetHashCode()
System.Object.GetType()
System.Object.MemberwiseClone()
System.Object.ReferenceEquals(System.Object, System.Object)
System.Object.ToString()
Namespace: Innovator.Client.Connection
Assembly: Innovator.Client.dll
Syntax
public class ArasVaultConnection

Constructors

| Improve this Doc View Source

ArasVaultConnection(IArasConnection)

Initializes a new instance of the ArasVaultConnection class for a given IArasConnection

Declaration
public ArasVaultConnection(IArasConnection conn)
Parameters
Type Name Description
IArasConnection conn

The corresponding IArasConnection.

Properties

| Improve this Doc View Source

VaultStrategy

Gets or sets the vault strategy for determining which vaults to read from and write to for a given IAsyncConnection

Declaration
public IVaultStrategy VaultStrategy { get; set; }
Property Value
Type Description
IVaultStrategy

The vault strategy.

Methods

| Improve this Doc View Source

Download(Command, Boolean)

Downloads the specified file.

Declaration
public IPromise<Stream> Download(Command request, bool async)
Parameters
Type Name Description
Command request

The file to download.

System.Boolean async

if set to true, download asynchronously. Otherwise, a resolved promise will be returned

Returns
Type Description
IPromise<System.IO.Stream>

A promise to return a stream of the file's bytes

| Improve this Doc View Source

InitializeStrategy()

Initializes the strategy.

Declaration
public void InitializeStrategy()
| Improve this Doc View Source

Upload(UploadCommand, Boolean)

Uploads the specified file to the vault.

Declaration
public IPromise<Stream> Upload(UploadCommand upload, bool async)
Parameters
Type Name Description
UploadCommand upload

The file to upload.

System.Boolean async

if set to true, download asynchronously. Otherwise, a resolved promise will be returned

Returns
Type Description
IPromise<System.IO.Stream>

A promise to return a stream of the resulting AML

  • Improve this Doc
  • View Source
Back to top Copyright © 2015-2017 Microsoft
Generated by DocFX