Class UploadCommand

A request used for uploading files to the database

Inheritance
System.Object
Command
UploadCommand
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)
Namespace: Innovator.Client
Assembly: Innovator.Client.dll
Syntax
public class UploadCommand : Command

Constructors

| Improve this Doc View Source

UploadCommand(Vault)

Create an upload command with the specified vault metadata

Declaration
public UploadCommand(Vault vault)
Parameters
Type Name Description
Vault vault

Vault metadata

Properties

| Improve this Doc View Source

Aml

The AML query. If not explicitly set, it is built based on the files which have been added to the requested.

Declaration
public override string Aml { get; set; }
Property Value
Type Description
System.String
Overrides

Methods

| Improve this Doc View Source

AddFile(String, Stream, Boolean)

Add a file to the request without specifying an ID

Declaration
public string AddFile(string path, Stream data, bool isNew = true)
Parameters
Type Name Description
System.String path

Path (or pseudo path) of the file
System.IO.Stream data

Stream of data representing the file
System.Boolean isNew

Is this a new file being added to the database for the first time?
Returns
Type Description
System.String

AML file string useful for building a larger AML statement
| Improve this Doc View Source

AddFile(String, String, Boolean)

Add a file to the upload request

Declaration
public string AddFile(string id, string path, bool isNew = true)
Parameters
Type Name Description
System.String id

Aras ID of the file
System.String path

Physical path of the file
System.Boolean isNew

Is this a new file being added to the database for the first time?
Returns
Type Description
System.String

AML file string useful for building a larger AML statement
| Improve this Doc View Source

AddFile(String, String, Stream, Boolean)

Add a file to the upload request

Declaration
public string AddFile(string id, string path, Stream data, bool isNew = true)
Parameters
Type Name Description
System.String id

Aras ID of the file
System.String path

Path (or pseudo path) of the file
System.IO.Stream data

Stream of data representing the file
System.Boolean isNew

Is this a new file being added to the database for the first time?
Returns
Type Description
System.String

AML file string useful for building a larger AML statement
| Improve this Doc View Source

AddFileQuery(String)

Adds a file Item query to the request where the path to the file is specified as the actual_filename property

Declaration
public void AddFileQuery(string query)
Parameters
Type Name Description
System.String query

Query to add to the request

Extension Methods