Class ReportAgent
Proxy class for the Report Agent Used when communicating remote using WebServices. Avoid using directly. Use the AgentFactory to create the proxy instead.
Inherited Members
Namespace: SuperOffice.CRM.Services
Assembly: SuperOffice.Services.Implementation.dll
Syntax
public class ReportAgent : IReportAgent, IAgent
Constructors
ReportAgent(IReportLabelLayoutEntityImplementation, ISoRequestItemsAccessor)
Proxy class for the Report Agent Used when communicating remote using WebServices. Avoid using directly. Use the AgentFactory to create the proxy instead.
Declaration
public ReportAgent(IReportLabelLayoutEntityImplementation reportLabelLayoutEntityImplementation, ISoRequestItemsAccessor accessor)
Parameters
| Type | Name | Description |
|---|---|---|
| IReportLabelLayoutEntityImplementation | reportLabelLayoutEntityImplementation | |
| ISoRequestItemsAccessor | accessor |
ReportAgent(IReportLabelLayoutEntityImplementation, ISoRequestItemsAccessor, IDebugUser, IServiceCallsRepository, IScriptingConfiguration, IOnlineConfiguration)
Proxy class for the Report Agent Used when communicating remote using WebServices. Avoid using directly. Use the AgentFactory to create the proxy instead.
Declaration
public ReportAgent(IReportLabelLayoutEntityImplementation reportLabelLayoutEntityImplementation, ISoRequestItemsAccessor accessor, IDebugUser debugUser, IServiceCallsRepository serviceCallsRepository, ConfigFile.IScriptingConfiguration scriptingConfiguration, ConfigFile.IOnlineConfiguration onlineConfiguration)
Parameters
| Type | Name | Description |
|---|---|---|
| IReportLabelLayoutEntityImplementation | reportLabelLayoutEntityImplementation | |
| ISoRequestItemsAccessor | accessor | |
| IDebugUser | debugUser | |
| IServiceCallsRepository | serviceCallsRepository | |
| IScriptingConfiguration | scriptingConfiguration | |
| IOnlineConfiguration | onlineConfiguration |
Methods
CreateDefaultReportLabelLayoutEntityAsync(CancellationToken)
Loading default values into a new ReportLabelLayoutEntity.
Declaration
public Task<ReportLabelLayoutEntity> CreateDefaultReportLabelLayoutEntityAsync(CancellationToken cancellationToken = default)
Parameters
| Type | Name | Description |
|---|---|---|
| CancellationToken | cancellationToken | This operation cannot be cancelled; the cancellationToken parameter is ignored |
Returns
| Type | Description |
|---|---|
| Task<ReportLabelLayoutEntity> | New ReportLabelLayoutEntity with default values |
DeleteReportLabelLayoutEntityAsync(int, CancellationToken)
Deletes the ReportLabelLayoutEntity
Declaration
public Task DeleteReportLabelLayoutEntityAsync(int reportLabelLayoutEntityId, CancellationToken cancellationToken = default)
Parameters
| Type | Name | Description |
|---|---|---|
| int | reportLabelLayoutEntityId | The identity of the ReportLabelLayoutEntity |
| CancellationToken | cancellationToken | This operation cannot be cancelled; the cancellationToken parameter is ignored |
Returns
| Type | Description |
|---|---|
| Task | This method has no return value |
GetReportLabelLayoutEntityAsync(int, CancellationToken)
Gets a ReportLabelLayoutEntity object.
Declaration
public Task<ReportLabelLayoutEntity> GetReportLabelLayoutEntityAsync(int reportLabelLayoutEntityId, CancellationToken cancellationToken = default)
Parameters
| Type | Name | Description |
|---|---|---|
| int | reportLabelLayoutEntityId | The identifier of the ReportLabelLayoutEntity object |
| CancellationToken | cancellationToken | This operation cannot be cancelled; the cancellationToken parameter is ignored |
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
public Task<ReportLabelLayoutEntity> SaveReportLabelLayoutEntityAsync(ReportLabelLayoutEntity reportLabelLayoutEntity, CancellationToken cancellationToken = default)
Parameters
| Type | Name | Description |
|---|---|---|
| ReportLabelLayoutEntity | reportLabelLayoutEntity | The ReportLabelLayoutEntity that is saved |
| CancellationToken | cancellationToken | This operation cannot be cancelled; the cancellationToken parameter is ignored |
Returns
| Type | Description |
|---|---|
| Task<ReportLabelLayoutEntity> | New or updated ReportLabelLayoutEntity |