---
myst:
  substitutions:
    class: |-
      ```{image} /img/code_reference/class.ico
      ```
    enum: |-
      ```{image} /img/code_reference/enum.ico
      ```
    interface: |-
      ```{image} /img/code_reference/interface.ico
      ```
---

# .NET Library

```{toctree}
:glob: true
:hidden: true

net_library/*
```

The powerGate .NET library contains a set of classes, interfaces, and value types that provide the functionality to automate data synchronization with ERP systems.

```{image} /img/code_reference/utilities.png
:align: right
:width: 160px
```

The library supports:

- .Net Framework 4.7 or higher
- OData Version v1, v2, v3, v4.

The library tries to perform **as less server requests as possible**, in order to keep a **high performance** when communicating over the network or the internet.

:::{admonition} Metadata
This means that e.g. the service **metadata** will be retrieved **only when required**, and only for the required services.

After retrieving metadata once, **no further metadata request is required**, because powerGate caches the server results!
:::

## Classes

| Class                                                               | Description                                                                       |
| ------------------------------------------------------------------- | --------------------------------------------------------------------------------- |
| {{class}} [ConnectionSettings](<net_library/connectionsettings>)    | Settings used to connect with the ERP Service.                                    |
| {{class}} [ErpClientSettings](<net_library/erpclientsettings>)      | Settings used to manipulate requests, timeouts etc. send by the client.           |
| {{class}} [ErpClient](<net_library/erpclient>)                      | Class used to connect with ERP services.                                          |
| {{class}} [ErpObject](<net_library/erpobject>)                      | Provides the data for the ERP entity.                                             |
| {{class}} [MediaCreateOptions](<net_library/mediacreateoptions>)    | Specifies options to use for creating Media Resources.                            |
| {{class}} [MediaUpdateOptions](<net_library/mediaupdateoptions>)    | Specifies options to use for updating Media Resources.                            |
| {{class}} [NavigationProperty](<net_library/navigationproperty>)    | Provides metadata informations about the NavigationProperty.                      |
| {{class}} [OrderBy](<net_library/orderby>)                          | Specifies options to use for ordering ERP entities.                               |
| {{class}} [Property](<net_library/property>)                        | Provides metadata informations about the Property.                                |
| {{class}} [QueryOptions](<net_library/queryoptions>)                | Specifies options to use for searching entities in ERP.                           |
| {{class}} [SearchOptions](<net_library/searchoptions>)              | Specifies options to use for retrieving a single entity from ERP.                 |
| {{class}} [SapConnect](<net_library/connectionsettings/sapconnect>) | Class which provides prepared connection to use for connecting with SAP services. |
| {{class}} [WebRequestException](<net_library/webrequestexception>)  | The exception that is thrown when an error occurs while sending a request.        |


## Interfaces

| Interface                                                                         | Description                                                                                                   |
| --------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------- |
| {{interface}} [IErpClient](<net_library/ierpclient>)                              | Provides the base interface for the [ErpClient](<net_library/ierpclient>) class.                              |
| {{interface}} [IErpEntitySet](<net_library/ierpentityset>)                        | Provides the interface for working with an EntitySet: Adding, Getting, Updating and/or Removing -ErpEntities. |
| {{interface}} [IErpEntitySets](<net_library/ierpentitysets>)                      | Provides the interface for working with a list of EntitySets.                                                 |
| {{interface}} [IErpEntityType](<net_library/ierpentitytype>)                      | Provides the interface holding data about the EntityType.                                                     |
| {{interface}} [IErpEntityTypes](<net_library/ierpentitytypes>)                    | Provides the interface for working with a list of EntityTypes.                                                |
| {{interface}} [IErpNavigationProperties](<net_library/ierpnavigationsproperties>) | Provides the interface for working with a list of NavigationProperties.                                       |
| {{interface}} [IErpProperties](<net_library/ierpproperties>)                      | Provides the interface for working with a list of ERP Properties.                                             |
| {{interface}} [IErpService](<net_library/ierpservice>)                            | Provides the interface for working with an ERP Service.                                                       |
| {{interface}} [IErpServices](<net_library/ierpservices>)                          | Provides the interface for working with a list of ERP Services.                                               |
| {{interface}} [IMediaResources](<net_library/imediaresources>)                    | Provides the interface for working with MediaResources: Adding, Getting and/or Updating -ErpMedias.           |


## Enumerations

| Enumeration                                             | Description                                                  |
| ------------------------------------------------------- | ------------------------------------------------------------ |
| {{enum}} [Multiplicity](<net_library/multiplicity>)     | Enumerates the multiplicities of navigation properties.      |
| {{enum}} [OrderDirection](<net_library/orderdirection>) | Specifies the order of a sequence (ascending or descending). |
| {{enum}} [UpdateMethod](<net_library/updatemethod>)     | Specifies the HTTP method used for updating.                 |