Interface IDatabaseAgent

Interface for the Database Agent Database schema queries and changes

Namespace: SuperOffice.CRM.Services

Assembly: SuperOffice.Services.dll

Syntax

[Agent("Database Agent", "Interface for the Database Agent. Database schema queries and changes")]
public interface IDatabaseAgent : IAgent

Examples

using SuperOffice;
using SuperOffice.CRM.Services;

using (SoSession mySession = SoSession.Authenticate("user", "pass"))
{
   using (DatabaseAgent agent = new DatabaseAgent())
   {
      // call methods on agent here...
   }
}

Methods

GetStepsFromNetServerCodeAsync(CancellationToken)

Get information about the dictionary steps that NetServer was generated for

Declaration

Task<DictionaryStepInformation[]> GetStepsFromNetServerCodeAsync(CancellationToken cancellationToken = default)

Parameters

Type	Name	Description
CancellationToken	cancellationToken

Returns

Type	Description
Task<DictionaryStepInformation[]>	Array of dictionary steps used when NetServer was generated, listing only the highest number for each step

GetStepsInDatabaseAsync(CancellationToken)

Get information about the dictionary steps that are in the currently-loggedon database

Declaration

Task<DictionaryStepInformation[]> GetStepsInDatabaseAsync(CancellationToken cancellationToken = default)

Parameters

Type	Name	Description
CancellationToken	cancellationToken

Returns

Type	Description
Task<DictionaryStepInformation[]>	Array of dictionary steps in the database, listing only the highest number for each step