OSIsoft.AF Namespace

The AFActiveDirectoryProperties object is used to get and set the Active Directory configuration properties used by the PI AF Server to access contact information.

The AFDatabase object maintains the collection of all global AFCategory collections defined on a database.

The AFCategory represents a user-defined value used to categorize objects within the AF SDK. Use it to group objects by categories when generating reports or when making queries.

Provides data for the Changed event.

The AFCheckOutInfo object is used to represent the checked out status information of the current object.

AF client registration for OIDC authentication

Base class used for all collections in the AF SDK.

Provides the abstract base class used for all collections in the AF SDK that are indexed by unique identifier.

A generic list of objects that does not have name lookup. This collection can be a user-defined collection of objects which belong to different objects.

The AFConnectionInfo object is used to provide the connection configuration information and status to the PI AF Server.

A AFContact provides contact information maintained by AF.

Class used to represent individual columns when using CSV import and export.

A collection of AFCsvColumn objects.

The AFDatabase represents a single database (data archive) in a PI AF Server.

The collection of AFDatabase objects maintained by the SDK for elements on the PISystem.

This class is used to return error information.

Base class for EventArgs that can be associated with an event in the SDK.

The AFGlobalRestorer is used to restore objects persisted using the IPIPersist interface.

All the global application settings.

This class is used to return a dictionary of results along with error information.

The collection of AFLibrary objects that provides application and domain specific information that can be loaded into a PISystem.

The AFLibrary is a collection of application or domain information that can be imported into an PISystem.

This class is used to return a list of results along with error information.

Provides the abstract base class used for all collections in the AF SDK that are indexed by unique identifier and name.

A generic list of objects that support name lookups. This collection can be a user-defined collection of objects which belong to different objects.

This class provides support for the name substitution used with setting the names of objects.

Base class used for all objects in the AF SDK.

Base object that is inherited by AFRole, AFProvider, and AFClientRegistration.

The AFPlugIn contains the information about a AF plugin that is defined and installed on the PI AF Server.

Attribute used on an AFPlugIn assembly to specify the AFPlugInLoadProperties used to control the loading of the plugin.

Attribute used on an AFPlugIn to indicate that the editing of its configuration is not allowed in the user interface.

This collection contains the list of AFPlugIn objects that are installed on the server's workstation.

Provides data for a progress event.

AF Identity Provider

AF Identity Provider Role

Static class provides extension methods for classes within the AF SDK.

The AFSecurity object provides access and control to the security aspects of the associated object.

The collection of AFSecurityIdentity objects is maintained by the PISystem (PI AF Server).

The AFSecurityIdentity object represents a security identity on a PISystem (PI AF Server).

The AFSecurityMapping object represents a mapping between a Windows identity and an AFSecurityIdentity on a PISystem (PI AF Server).

The AFSecurityMappings collection represents the available AFSecurityMapping objects on a particular PISystem (PI AF Server).

Static class provides extension methods for AFSecurityRights enumeration.

Represents a numeric string comparison operation that uses special case-insensitive comparison rules for strings with numeric values.

The PISystem represents a single logical data store for the AF SDK.

The global collection of PISystem objects maintained by the AF SDK represents the known systems available from a workstation for client applications.

A universal comparer that can be used to compare any two objects for equivalence using any combination of properties.

The AFChangeInfo structure is used when returning information about objects that have changed in the server.

A filter to restrict the objects found from a path.

Represents a path token from parsing an object path.

Information about a support assembly for an AFPlugIn.

A security entry returned by the GetSecurityEntries method.

A security rights token is used to check security for an object.

This interface defines the Changed event that is implemented on objects that support notification of changes.

An interface implemented by all collections in the AF SDK.

An interface for named collections that support looking up by ID and Name.

This interface defines the properties and methods for objects which support security.

This interface defines the properties and methods for objects which support being transacted.

The IPIPersist interface allows a persistence string for an object to be obtained.

This is an enumeration that defines the possible values used when you specify the authentication mode of the PISystem.

Specifies how the AFObject is changed.

The action that caused a object to be changed.

Defines the different modes that can be specified when checking in or finding modified objects.

Defines the connection preference when connecting to an AFCollective or PICollective.

Defines the connection protocol used to communicate with the PI AF Server.

This enumeration specifies the type of AFContact.

Defines the different ways a reference to an object can be encoded using one of the AFObjectGetPath methods.

Defines the possible values for the error status.

Determine level of certificate validation

Determine default authentication behavior when connecting to PI Data Archive and AF Servers.

This is the enumeration used for the Identity property.

These filters are used when requesting the list of substitution patterns.

The type of substitution used by the AFNameSubstitution class.

The type of filter used when parsing an object path.

This enumeration specifies the properties for loading the assembly containing the AFPlugIn.

Specifies the status of a operation.

Defines the fields of the object that are searched.

The AFSecurityItem is an enumeration of the possible values for specifying security item in the method.

This enumeration defines the types of AFSecurityMapping.

The operation used when adding user security rights to objects.

The AFSecurityRights is an enumeration of the possible values for specifying security access rights of objects.

Defines the AFSession field that is sorted.

Defines the field that is sorted.

Defines the sort order.

This enumeration specifies the possible levels used when verifying the signature of an assembly.

Indicates the type of export to perform when using an ExportXml method. Since this is a bit mask, several of these values can be set at the same time.

Indicates the type of import to perform when using an ImportXml or ImportCsvmethod. Since this is a bit mask, several of these values can be set at the same time.

This enumeration represents the features that may be enabled or disabled for the PISystem.

Defines the directory options used when looking up a PISystem in the PISystems collection or a PIServer in the PIServers collection.