Class ErpConnectorClient

Wrapper for calling ERP connectors, either local or remote

Inheritance

object

IntegrationServerWcfClientBase<IErpConnectorWS>

ErpConnectorClient

Implements

IErpConnector

Inherited Members

IntegrationServerWcfClientBase<IErpConnectorWS>.ConfigureBinding(BasicHttpBinding)

Namespace: SuperOffice.ErpSync

Assembly: SuperOffice.Services.Implementation.dll

Syntax

public class ErpConnectorClient : IntegrationServerWcfClientBase<IErpConnectorWS>, IErpConnector

Methods

CreateActor(Guid, ErpActor)

Wrapper for CreateActor

Declaration

public ActorPluginResponse CreateActor(Guid connectionID, ErpActor act)

Parameters

Type	Name	Description
Guid	connectionID
ErpActor	act

Returns

Type	Description
ActorPluginResponse

CreateAsync(string, IConfiguration, CancellationToken)

Creation of a new ErpConnectorClient instance

Declaration

public static Task<ErpConnectorClient> CreateAsync(string targetUrl, IConfiguration config, CancellationToken cancellationToken = default)

Parameters

Type	Name	Description
string	targetUrl	Either plugin: or http(s): path to connector
IConfiguration	config	Configuration parameters for connector
CancellationToken	cancellationToken

Returns

Type	Description
Task<ErpConnectorClient>

DeleteConnection(Guid)

Wrapper for DeleteConnection

Declaration

public PluginResponseInfo DeleteConnection(Guid connectionID)

Parameters

Type	Name	Description
Guid	connectionID

Returns

Type	Description
PluginResponseInfo

GetActors(Guid, string, string[], string[])

Wrapper for GetActors

Declaration

public ActorArrayPluginResponse GetActors(Guid connectionID, string actorType, string[] erpKeys, string[] fieldKeys)

Parameters

Type	Name	Description
Guid	connectionID
string	actorType
string[]	erpKeys
string[]	fieldKeys

Returns

Type	Description
ActorArrayPluginResponse

GetActorsByTimestamp(Guid, string, string, string[])

Wrapper for GetActorsByTimestamp

Declaration

public ActorArrayPluginResponse GetActorsByTimestamp(Guid connectionID, string updatedOnOrAfter, string actorType, string[] fieldKeys)

Parameters

Type	Name	Description
Guid	connectionID
string	updatedOnOrAfter
string	actorType
string[]	fieldKeys

Returns

Type	Description
ActorArrayPluginResponse

GetConfigData()

Wrapper for GetConfigData

Declaration

public FieldMetadataInfoArrayPluginResponse GetConfigData()

Returns

Type	Description
FieldMetadataInfoArrayPluginResponse

GetList(Guid, string)

Wrapper for GetList

Declaration

public ListItemArrayPluginResponse GetList(Guid connectionID, string listName)

Parameters

Type	Name	Description
Guid	connectionID
string	listName

Returns

Type	Description
ListItemArrayPluginResponse

GetListItems(Guid, string, string[])

Wrapper for GetListItems

Declaration

public ListItemArrayPluginResponse GetListItems(Guid connectionID, string listName, string[] listItemKeys)

Parameters

Type	Name	Description
Guid	connectionID
string	listName
string[]	listItemKeys

Returns

Type	Description
ListItemArrayPluginResponse

GetSearchableFields(Guid, string)

Wrapper for GetSearchableFields

Declaration

public StringArrayPluginResponse GetSearchableFields(Guid connectionID, string actorType)

Parameters

Type	Name	Description
Guid	connectionID
string	actorType

Returns

Type	Description
StringArrayPluginResponse

GetSupportedActorTypeFields(Guid, string)

Wrapper for GetSupportedActorTypeFields

Declaration

public FieldMetadataInfoArrayPluginResponse GetSupportedActorTypeFields(Guid connectionID, string actorType)

Parameters

Type	Name	Description
Guid	connectionID
string	actorType

Returns

Type	Description
FieldMetadataInfoArrayPluginResponse

GetSupportedActorTypes(Guid)

Wrapper for GetSupportedActorTypes

Declaration

public StringArrayPluginResponse GetSupportedActorTypes(Guid connectionID)

Parameters

Type	Name	Description
Guid	connectionID

Returns

Type	Description
StringArrayPluginResponse

SaveActors(Guid, ErpActor[])

Wrapper for SaveActors

Declaration

public ActorArrayPluginResponse SaveActors(Guid connectionID, ErpActor[] actors)

Parameters

Type	Name	Description
Guid	connectionID
ErpActor[]	actors

Returns

Type	Description
ActorArrayPluginResponse

SaveConnection(Guid, Dictionary<string, string>)

Wrapper for SaveConnection

Declaration

public PluginResponseInfo SaveConnection(Guid connectionID, Dictionary<string, string> connectionInfo)

Parameters

Type	Name	Description
Guid	connectionID
Dictionary<string, string>	connectionInfo

Returns

Type	Description
PluginResponseInfo

SearchActorByParent(Guid, string, string, string, string, string[])

Wrapper for SearchActorByParent

Declaration

public ActorArrayPluginResponse SearchActorByParent(Guid connectionID, string actorType, string searchText, string parentActorType, string parentActorErpKey, string[] fieldKeys)

Parameters

Type	Name	Description
Guid	connectionID
string	actorType
string	searchText
string	parentActorType
string	parentActorErpKey
string[]	fieldKeys

Returns

Type	Description
ActorArrayPluginResponse

SearchActors(Guid, string, string, string[])

Wrapper for SearchActors

Declaration

public ActorArrayPluginResponse SearchActors(Guid connectionID, string actorType, string searchText, string[] fieldKeys)

Parameters

Type	Name	Description
Guid	connectionID
string	actorType
string	searchText
string[]	fieldKeys

Returns

Type	Description
ActorArrayPluginResponse

SearchActorsAdvanced(Guid, string, SearchRestrictionInfo[], string[])

Wrapper for SearchActorsAdvanced

Declaration

public ActorArrayPluginResponse SearchActorsAdvanced(Guid connectionID, string actorType, SearchRestrictionInfo[] restrictions, string[] fieldKeys)

Parameters

Type	Name	Description
Guid	connectionID
string	actorType
SearchRestrictionInfo[]	restrictions
string[]	fieldKeys

Returns

Type	Description
ActorArrayPluginResponse

TestConfigData(Dictionary<string, string>)

Wrapper for TestConfigData

Declaration

public PluginResponseInfo TestConfigData(Dictionary<string, string> connectionInfo)

Parameters

Type	Name	Description
Dictionary<string, string>	connectionInfo

Returns

Type	Description
PluginResponseInfo

TestConnection(Guid)

Wrapper for TestConnection

Declaration

public PluginResponseInfo TestConnection(Guid connectionID)

Parameters

Type	Name	Description
Guid	connectionID

Returns

Type	Description
PluginResponseInfo

Implements

SuperOffice.CRM.IErpConnector