Interface ISetService
Set service.
Namespace: MAT.Atlas.Automation.Api
Assembly: MAT.Atlas.Automation.Api.dll
Syntax
[AutomationService("Set")]
public interface ISetService : IAutomationService
Methods
GetCompositeSessions(ObjectId)
Get the properties of all composite sessions associated with a set.
Declaration
CompositeSession[] GetCompositeSessions(ObjectId setId)
Parameters
Type | Name | Description |
---|---|---|
ObjectId | setId | Unique identifier of a set. |
Returns
Type | Description |
---|---|
CompositeSession[] | Collection of composite session properties. |
GetPrimarySession(ObjectId)
Get the properties of the primary composite session.
Declaration
CompositeSession GetPrimarySession(ObjectId setId)
Parameters
Type | Name | Description |
---|---|---|
ObjectId | setId | Unique identifier of a set. |
Returns
Type | Description |
---|---|
CompositeSession | Composite session properties. |
GetSet(ObjectId)
Get the properties of a set.
Declaration
Set GetSet(ObjectId setId)
Parameters
Type | Name | Description |
---|---|---|
ObjectId | setId | Unique identifier of a set. |
Returns
Type | Description |
---|---|
Set | Set properties. |
RemoveSet(ObjectId)
Remove a set.
Declaration
void RemoveSet(ObjectId setId)
Parameters
Type | Name | Description |
---|---|---|
ObjectId | setId | Unique identifier of a set. |
RenameSet(ObjectId, String)
Change the title of a set.
Declaration
void RenameSet(ObjectId setId, string name)
Parameters
Type | Name | Description |
---|---|---|
ObjectId | setId | Unique identifier of a set. |
System.String | name | New title for the set. |
SetCompareMode(ObjectId, CompareModeType)
Sets the session compare mode.
Declaration
void SetCompareMode(ObjectId setId, CompareModeType type)
Parameters
Type | Name | Description |
---|---|---|
ObjectId | setId | Unique identifier of a set. |
CompareModeType | type | Compare mode type. |