Interface IReportAgent

Interface for the Report Agent Run reports, set favourites, labels

Namespace: SuperOffice.CRM.Services

Assembly: SuperOffice.Services.dll

Syntax

[Agent("Report Agent", "Interface for the Report Agent. Run reports, set favourites, labels")]
public interface IReportAgent : IAgent

Examples

using SuperOffice;
using SuperOffice.CRM.Services;

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

Methods

CreateDefaultReportLabelLayoutEntityAsync(CancellationToken)

Loading default values into a new ReportLabelLayoutEntity.

Declaration

Task<ReportLabelLayoutEntity> CreateDefaultReportLabelLayoutEntityAsync(CancellationToken cancellationToken = default)

Parameters

Type	Name	Description
CancellationToken	cancellationToken

Returns

Type	Description
Task<ReportLabelLayoutEntity>	New ReportLabelLayoutEntity with default values

DeleteReportLabelLayoutEntityAsync(int, CancellationToken)

Deletes the ReportLabelLayoutEntity

Declaration

Task DeleteReportLabelLayoutEntityAsync(int reportLabelLayoutEntityId, CancellationToken cancellationToken = default)

Parameters

Type	Name	Description
int	reportLabelLayoutEntityId	The identity of the ReportLabelLayoutEntity
CancellationToken	cancellationToken

Returns

Type	Description
Task	This method has no return value

GetReportLabelLayoutEntityAsync(int, CancellationToken)

Gets a ReportLabelLayoutEntity object.

Declaration

Task<ReportLabelLayoutEntity> GetReportLabelLayoutEntityAsync(int reportLabelLayoutEntityId, CancellationToken cancellationToken = default)

Parameters

Type	Name	Description
int	reportLabelLayoutEntityId	The identifier of the ReportLabelLayoutEntity object
CancellationToken	cancellationToken

Returns

Type	Description
Task<ReportLabelLayoutEntity>	A single ReportLabelLayoutEntity

SaveReportLabelLayoutEntityAsync(ReportLabelLayoutEntity, CancellationToken)

Updates the existing ReportLabelLayoutEntity or creates a new ReportLabelLayoutEntity if the id parameter is 0.

Declaration

Task<ReportLabelLayoutEntity> SaveReportLabelLayoutEntityAsync(ReportLabelLayoutEntity reportLabelLayoutEntity, CancellationToken cancellationToken = default)

Parameters

Type	Name	Description
ReportLabelLayoutEntity	reportLabelLayoutEntity	The ReportLabelLayoutEntity that is saved
CancellationToken	cancellationToken

Returns

Type	Description
Task<ReportLabelLayoutEntity>	New or updated ReportLabelLayoutEntity