Interface ISummaryDisplayService
Summary Display service.
Namespace: MAT.Atlas.Automation.Api
Assembly: MAT.Atlas.Automation.Api.dll
Syntax
[AutomationService("SummaryDisplay")]
public interface ISummaryDisplayService : IAutomationService
Methods
GetSnapShotFilePath(ObjectId)
Returns the snapshot file path.
Declaration
string GetSnapShotFilePath(ObjectId displayId)
Parameters
Type | Name | Description |
---|---|---|
ObjectId | displayId | Unique identifier of a display. |
Returns
Type | Description |
---|---|
System.String | The snapshot file path. |
Remarks
Returns the snapshot file path.
SetSnapShotFilePath(ObjectId, String)
Sets the snapshot file path.
Declaration
void SetSnapShotFilePath(ObjectId displayId, string filePath)
Parameters
Type | Name | Description |
---|---|---|
ObjectId | displayId | Unique identifier of a display. |
System.String | filePath | File path to snapshot session summaries to. |
SnapShot(ObjectId)
Snapshot a summary display.
Declaration
void SnapShot(ObjectId displayId)
Parameters
Type | Name | Description |
---|---|---|
ObjectId | displayId | Unique identifier of a display. |
Remarks
Snapshots the summary display.