Namespace Innovator.Client
Classes
AmlSqlWriter
Generates a SQL statement for querying the Aras database directly from an AML query
AmlWriterSettings
Settings controlling how to serialize an AML structure
AnonymousCredentials
Credentials for a user that is not authenticated
ArasHeaders
Headers to send with each request to Aras
Command
An AML request to be submitted to the server
ConnectedAmlSqlWriterSettings
Settings and metadata used to generate a SQL statement from AML. Metadata will be queried using the specified IConnection
ConnectionExtensions
Extension methods related to IConnection.
ConnectionPool
A pool of multiple connections using the same credentials and the same database
ConnectionPreferences
Preferences for connection behavior
Core
Extension methods for retrieving core AML properties and attributes
DefaultItemFactory
Creates an instance of a strongly-typed class (which inherits from Item) that represents a specific item type
Element
Represents an XML element in an AML structure. This element could be an Item, property, result tag, or something else
ElementFactory
Class for generating mutable AML objects
ExplicitCredentials
Credentials with a specified user name and password provided by the user
ExplicitHashCredentials
Credentials with a specified user name and MD5 password hash provided by the user
Extensions
Useful extension methods
Factory
Class for generating connection to an Aras Innovator instance
HttpException
Exception that occurs when sending an HTTP request to the server.
HttpTimeoutException
Exception that occurs when an HTTP request times out.
Item
Represents an XML Item
element in an AML structure.
ItemExtensions
Various extension methods pertaining to various AML interfaces
ItemRef
A reference to an item containing just a type and ID
ItemWrapper
Wraps an Aras item so that additional functionality can be easily provided
LoggedOutException
Indicates that the current connection is not logged in with valid credentials
MD5Helper
helper class providing suporting function
MemoryTributary
MemoryTributary is a re-implementation of MemoryStream that uses a dynamic list of byte arrays as a backing store, instead of a single byte array, the allocation of which will fail for relatively small streams as it requires contiguous memory.
NoItemsFoundException
Represents an exception that was returned from the server as a SOAP fault indicating that no items were found
ParameterSubstitution
Class for substituting @-prefixed parameters with their values
Promise<T>
Represents a promise that a result of the specified type will be provided at some point in the future
PromiseResult<T1, T2>
A promise to return two results
PromiseResult<T1, T2, T3>
A promise to return three results
PromiseResult<T1, T2, T3, T4>
A promise to return four results
Promises
Various methods useful for interacting with promises
QuerySettings
SavedConnections
Access information about connection preferences that has been persisted to disk
SecureToken
A class for storing sensitive information (e.g. passwords)
SelectNode
Class for parsing and storing AML select attributes
ServerContext
Context for serializing/deserializing native types (e.g. DateTime
, double
, boolean
, etc.)
ServerException
Represents an exception that was returned from the server as a SOAP fault.
SqlBatchWriter
Class for building a large string of SQL which will be sent to the database in batches for execution using the ApplySQL action
TimeZoneData
Represents metadata for a timezone including daylight savings time history
UploadCommand
A request used for uploading files to the database
ValidationException
Represents an exception that was returned from the server as a SOAP fault containing information about properties being validated
ValidationReportException
Represents an exception that was returned from the server as a SOAP fault containing a validation report
Vault
Provides metadata for an Aras file vault
WindowsCredentials
Credentials leveraged with Windows authentication (a.k.a. NTML or Kerberos)
Structs
DateOffset
A relative date specified by a magnitude and offset
Range<T>
A strongly-typed range of values between a minimum and maximum (inclusive)
Interfaces
IAmlNode
Represents a node of AML structure that can be rendered to AML
IAmlSqlWriterSettings
Settings and metadata used to generate a SQL statement from AML. Metadata will be queried using the specified IConnection
IAmlXPath
Class which supports executing XPath against an IReadOnlyElement
IAsyncConnection
Interface for a connection to an Aras Innovator instance that allows asynchronous calls
IAsyncScript
Represents an asynchronous script
IAttribute
A modifiable AML attribute
ICancelable
Indicates that an operation can be canceled
IConnection
Interface for a connection to an Aras Innovator instance
ICredentials
Credentials for authenticating to an Aras Innovator instance
IElement
A modifiable AML element. This element could be an Item, property, result tag, or something else
IErrorBuilder
Represents an interface for building an error message
IHttpRequest
HTTP request being sent to a server (Aras, Proxy, etc.)
IHttpResponse
Data from an HTTP response (including the headers and body)
IItem
Represents an Aras Item that is mutable/modifiable
IItemFactory
Creates an instance of a strongly-typed class (which inherits from Item) that represents a specific item type
IItemRef
Reference to an Aras item specifying the type name and ID
ILink<T>
Represents an element of a linked list with a System.String key.
ILinkedElement
A IReadOnlyElement which can be part of a linked list and has a parent reference
ILogical
A logical element representing an <and>
, <or>
, or <not>
AML tag
INetCredentials
Specifies that an System.Net.ICredentials instance can be extracted from the credentials object
INullRelationship<TSource>
A model representing a relationship where the source_id
is of type TSource
IPromise
Represents a promise that a result will be provided at some point in the future
IPromise<T>
Represents a promise that a result of the specified type will be provided at some point in the future
IProperty
A modifiable property of an item
IProperty_Base
Base mutable property interface used to indicate elements which are properties
IProperty_Boolean
Property of type boolean
IProperty_Date
Property of type date
IProperty_Image
Property that is of type image or something similar
IProperty_Item<T>
Property of type item
IProperty_Number
Property of type integer, decimal, float, etc.
IProperty_Text
Property that is of type text/string or something similar
IRange
A range of values between a minimum and maximum (inclusive)
IReadOnlyAttribute
A read-only AML attribute
IReadOnlyElement
A read-only AML element. This element could be an Item, property, result tag, or something else
IReadOnlyItem
Represents an Aras Item that is read only. By default, the connection object returns IReadOnlyItems to encouarge treating the results as immutable
IReadOnlyLogical
A logical element representing an <and>
, <or>
, or <not>
AML tag
IReadOnlyProperty
A readonly property of an item
IReadOnlyProperty_Base
Base property interface used to identify elements which are properties
IReadOnlyProperty_Boolean
Represents a property of type boolean
IReadOnlyProperty_Date
Represents a property of type date
IReadOnlyProperty_Image
Represents a property that is of type image or something similar
IReadOnlyProperty_Item<T>
Represents a property of type item
IReadOnlyProperty_Number
Represents a property of type integer, decimal, float, etc.
IReadOnlyProperty_Text
Represents a property that is of type text/string or something similar
IReadOnlyRelationships
A <Relationships>
tag
IReadOnlyResult
Represents a read-only result of an Aras query that can either be a string, an exception, or zero or more items
IRelationship<TRelated>
A model representing a relationship where the related_id
is of type TRelated
IRelationships
A <Relationships>
tag
IRemoteConnection
An HTTP connection to an innovator instance (or proxy) that is not located in the same memory space as the current code
IResult
Represents a modifiable result of an Aras query that can either be a string, an exception, or zero or more items
IServerContext
Context for serializing/deserializing native types (e.g. DateTime
, double
, boolean
, etc.)
IXmlStream
A stream with a custom approach for reading XML
Enums
AmlSqlPermissionOption
What SQL permission check to include in the SQL query
AmlSqlRenderOption
What type of SQL query to render
Authentication
Method of authentication
CommandAction
Allowable SOAP actions
CompressionType
Type of HTTP compression to use
Condition
Possible value for the condition
attribute of a property for an AML get query
DateMagnitude
Unit of time used with relative dates, DateOffset
ElementAttributes
Attributes stored in AML elements for compact memory usage
LockStatusType
The lock status of the item
ParameterStyle
Indicates whether parameters are @-prefixed (e.g.
@qty</code>) or enclosed
in curly braces (e.g.
{0}
)
ParameterSubstitutionMode
Whether the query is AML or SQL
Promise<T>.Condition
Condition under which callbacks should be executed
QueryType
Identifies which item an AML get
query should return
Delegates
SecureToken.FuncRef<T1, TR>
An anonymous function for processing a value by reference