Show / Hide Table of Contents

Interface IConnection

Interface for a connection to an Aras Innovator instance

Namespace: Innovator.Client
Assembly: Innovator.Client.dll
Syntax
public interface IConnection

Properties

| Improve this Doc View Source

AmlContext

AML context used for creating AML objects and formatting AML statements

Declaration
ElementFactory AmlContext { get; }
Property Value
Type Description
ElementFactory
| Improve this Doc View Source

Database

Name of the connected database

Declaration
string Database { get; }
Property Value
Type Description
System.String
| Improve this Doc View Source

UserId

ID of the authenticated user

Declaration
string UserId { get; }
Property Value
Type Description
System.String

Methods

| Improve this Doc View Source

CreateUploadCommand()

Creates an upload request used for uploading files to the server

Declaration
UploadCommand CreateUploadCommand()
Returns
Type Description
UploadCommand

A new upload request used for uploading files to the server

| Improve this Doc View Source

MapClientUrl(String)

Expands a relative URL to a full URL

Declaration
string MapClientUrl(string relativeUrl)
Parameters
Type Name Description
System.String relativeUrl

The relative URL

Returns
Type Description
System.String

A full URL relative to the connection

| Improve this Doc View Source

Process(Command)

Calls a SOAP action asynchronously

Declaration
Stream Process(Command request)
Parameters
Type Name Description
Command request

Request AML and possibly files UploadCommand

Returns
Type Description
System.IO.Stream

An XML SOAP response as a string

Extension Methods

ConnectionExtensions.Apply(IConnection, Command, Object[])
ConnectionExtensions.ApplySql(IConnection, Command, Object[])
ConnectionExtensions.ItemById(IConnection, String, String)
ConnectionExtensions.ItemById<T>(IConnection, String, String, Func<IReadOnlyItem, T>)
ConnectionExtensions.ItemByKeyedName(IConnection, String, String)
ConnectionExtensions.ItemByQuery(IConnection, Command)
ConnectionExtensions.ItemByQuery(IConnection, Command, Boolean)
ConnectionExtensions.Lock(IConnection, String, String)
ConnectionExtensions.NextSequence(IConnection, String)
ConnectionExtensions.Promote(IConnection, String, String, String, String)
ConnectionExtensions.Unlock(IConnection, String, String)
  • Improve this Doc
  • View Source
Back to top Copyright © 2015-2017 Microsoft
Generated by DocFX