ApiSession Class
Once the session is created successfully, all further API calls are invoked on this session object.
Definition
Namespace: Articy.Api
Assembly: ArticyApp (in ArticyApp.dll) Version: 1.0.0
Assembly: ArticyApp (in ArticyApp.dll) Version: 1.0.0
C#
public class ApiSession : IDisposable- Inheritance
- Object ApiSession
- Implements
- IDisposable
Properties
| CurrentProjectGuid | returns the Guid of the currently loaded project |
| ExclusivelyOpen | returns true when a project is exclusively open, false otherwise |
| Instance | |
| Mode | |
| ProjectOpen | returns true when a project is currently open, false Fea |
Methods
| AddLanguage | |
| BeginModifyFeature(ObjectProxy) | Modify an existing feature. This is a longer process, utilizing a description object, called a Blueprint. Set all necessary values and properties on the blueprint, and then call EndFeature(FeatureDescriptorBlueprint) to actually modify the feature in articy. |
| BeginModifyFeature(UInt64) | Modify an existing feature. This is a longer process, utilizing a description object, called a Blueprint. The whole process is called a "blueprint session" Set all necessary values and properties on the blueprint, and then call EndFeature(FeatureDescriptorBlueprint) to actually modify the feature in articy. |
| BeginModifyObjectTemplate(ObjectProxy) | Modify an existing object template. This is a longer process, utilizing a description object, called a blueprint. The whole process is called a "blueprint session" Set all necessary values and properties on the blueprint, and then call EndObjectTemplate(ObjectTemplateBlueprint) to actually modify the model template in articy. |
| BeginModifyObjectTemplate(UInt64) | Modify an existing object template. This is a longer process, utilizing a description object, called a blueprint. The whole process is called a "blueprint session" Set all necessary values and properties on the blueprint, and then call EndObjectTemplate(ObjectTemplateBlueprint) to actually modify the model template in articy. |
| BeginModifyPropertyDefinitionTPropertyBlueprint | Create a new property definition for the given model customization property type. |
| BeginNewFeature | Creates a new feature. This is a longer process, utilizing a description object, called a Blueprint. The whole process is called a "blueprint session" Set all necessary values and properties on the blueprint, and then call EndFeature(FeatureDescriptorBlueprint) to actually create the feature in articy. |
| BeginNewObjectTemplate | Creates a new object template. This is a longer process, utilizing a description object, called a blueprint. The whole process is called a "blueprint session" Set all necessary values and properties on the blueprint, and then call EndObjectTemplate(ObjectTemplateBlueprint) to actually create the model template in articy. |
| BeginNewPropertyDefinitionTPropertyBlueprint | Create a new property definition for the given model customization property type. |
| BringObjectIntoView | Brings the given object into view |
| BrowseForFolder | Opens a dialog to search for a path |
| ChangeAsset | Schedules a re-import of an asset from a new filename (Change asset source). The methods return immediately. It just enqueues a job that is processing in the background. Use WaitForAssetProcessing(WaitForAssetProcessingArgs) when you need the job(s) to be completed before proceeding |
| ChangeAssets | Batch operation to change a given list of assets and new filenames |
| ChangePrimaryLanguage | Use this to update the primary language (or Content creation language) information |
| ChangesAssets | |
| ClaimPartition(Guid) | Before making any changes to articy objects, your program needs to claim the partition the object in question resides in. |
| ClaimPartition(SimplePartitionActionArgs) | Before making any changes to articy objects, the external program needs to claim the partition the object in question resides in. |
| ClaimPartitions(IEnumerableObjectProxy) | Claims all distinct partitions required for the given list of objects. |
| ClaimPartitions(IEnumerableObjectProxy, String) | Claims all distinct partitions required for the given list of objects. |
| ClaimPartitions(IEnumerableObjectProxy, String, ListGuid, DictionaryGuid, Exception) | Claims all distinct partitions required for the given list of objects. |
| CloneChildren | Like CloneObject, but clones all children of aObject instead of just aObject. aObject itself is not cloned. Connections from a child to aObject are not cloned as they cannot necessarily be connected to aParent. |
| CloneObject | Creates a deep copy of the given object, i.e. all children of that object will be copied, too. |
| CloneRuleSet | Create a clone of the given ruleset |
| CloseProject | Closes the currently opened project. |
| ConnectPins | Creates a connection between two pins. This function will throw an exception if the connection cannot be created, e.g. when the pins are on different hierarchy levels. |
| ConnectToServer | Connects to an articy:server |
| ConvertBitmapToBrush | Converts a drawing bitmap (e.g. resource) to a WPF brush. The given bitmap is disposed by this call |
| CreateBrushFromArray | Create a brush from an image stored in a byte array (PNG/JPG) |
| CreateBrushFromBitmap | Creates a WPF brush from a drawing bitmap (e.g. resource) |
| CreateBrushFromFile | Create a brush from an image file |
| CreateBrushFromStream | Create a brush from an image that can be access from a stream object |
| CreateComment | Creates a new comment/annotation object in the flow area. |
| CreateCondition(ObjectProxy, String) | Creates a new condition node in the flow area. |
| CreateCondition(UInt64, String) | Creates a new condition node in the flow area. |
| CreateCondition(ObjectProxy, String, String) | Creates a new condition node in the flow area. |
| CreateCondition(UInt64, String, String) | Creates a new condition node in the flow area. |
| CreateDialogue(ObjectProxy, String) | Creates a new dialogue in the flow area. |
| CreateDialogue(UInt64, String) | Creates a new dialogue in the flow area. |
| CreateDialogue(ObjectProxy, String, String) | Creates a new dialogue in the flow area. |
| CreateDialogue(UInt64, String, String) | Creates a new dialogue in the flow area. |
| CreateDialogueFragment(ObjectProxy, String) | Creates a new dialogue fragment inside a dialog. |
| CreateDialogueFragment(UInt64, String) | Creates a new dialogue fragment inside a dialog. |
| CreateDialogueFragment(ObjectProxy, String, String) | Creates a new dialogue fragment inside a dialog. |
| CreateDialogueFragment(UInt64, String, String) | Creates a new dialogue fragment inside a dialog. |
| CreateDocument(ObjectProxy, String, String) | Creates a new Document object as child of the given parent |
| CreateDocument(UInt64, String, String) | Creates a new Document object as child of the given parent |
| CreateDocumentDialogue(ObjectProxy, HierarchyAdjustment, String, String, String) | Adds a new dialogue section to a document |
| CreateDocumentDialogue(UInt64, HierarchyAdjustment, String, String, String) | Adds a new dialogue section to a document |
| CreateDocumentImage(ObjectProxy, HierarchyAdjustment, ObjectProxy, String, String) | Adds a new image section to a document |
| CreateDocumentImage(UInt64, HierarchyAdjustment, UInt64, String, String) | Adds a new image section to a document |
| CreateDocumentText(ObjectProxy, HierarchyAdjustment, String, String, String) | Adds a new Text section to a document |
| CreateDocumentText(UInt64, HierarchyAdjustment, String, String, String) | Adds a new Text section to a document |
| CreateEntity(ObjectProxy, String) | Creates a new entity object in the articy project tree. |
| CreateEntity(UInt64, String) | Creates a new entity object in the articy project tree. |
| CreateEntity(ObjectProxy, String, String) | Creates a new entity object in the articy project tree. |
| CreateEntity(UInt64, String, String) | Creates a new entity object in the articy project tree. |
| CreateFlowFragment(ObjectProxy, String) | Creates a new flow fragment in the flow area. |
| CreateFlowFragment(UInt64, String) | Creates a new flow fragment in the flow area. |
| CreateFlowFragment(ObjectProxy, String, String) | Creates a new flow fragment in the flow area. |
| CreateFlowFragment(UInt64, String, String) | Creates a new flow fragment in the flow area. |
| CreateFolder(ObjectProxy, String) | Creates a new user folder within the articy project tree. |
| CreateFolder(UInt64, String) | Creates a new user folder within the articy project tree. |
| CreateGlobalVariable(String, Boolean, String) | Creates a new boolean variable via a full qualified name. If the supplied namespace doesn't exist, it will be created. |
| CreateGlobalVariable(String, Int32, String) | Creates a new integer variable via a full qualified name. If the supplied namespace doesn't exist, it will be created. |
| CreateGlobalVariable(String, String, String) | Creates a new string variable via a full qualified name. If the supplied namespace doesn't exist, it will be created. |
| CreateGlobalVariable(ObjectProxy, String, VariableType, String) | Creates a new variable in the given variable set with the given type. |
| CreateGlobalVariable(ObjectProxy, String, Boolean, String) | Creates a new boolean variable in the given namespace with the given type. |
| CreateGlobalVariable(ObjectProxy, String, Int32, String) | Creates a new integer variable in the given namespace with the given type. |
| CreateGlobalVariable(ObjectProxy, String, String, String) | Creates a new string variable in the given namespace with the given type. |
| CreateGlobalVariable(String, Boolean, ObjectProxy, String) | Creates a new boolean variable via a full qualified name. If the supplied namespace doesn't exist, it will be created. |
| CreateGlobalVariable(String, Int32, ObjectProxy, String) | Creates a new integer variable via a full qualified name. If the supplied namespace doesn't exist, it will be created. |
| CreateGlobalVariable(String, String, ObjectProxy, String) | Creates a new string variable via a full qualified name. If the supplied namespace doesn't exist, it will be created. |
| CreateGlobalVariable(String, String, VariableType, String) | Creates a new variable in the given variable set with the given type. |
| CreateHub(ObjectProxy, String) | Creates a new hub in the flow area. |
| CreateHub(UInt64, String) | Creates a new hub in the flow area. |
| CreateHub(ObjectProxy, String, String) | Creates a new hub in the flow area. |
| CreateHub(UInt64, String, String) | Creates a new hub in the flow area. |
| CreateInstruction(ObjectProxy, String) | Creates a new instruction in the flow area. |
| CreateInstruction(UInt64, String) | Creates a new instruction node in the flow area. |
| CreateInstruction(ObjectProxy, String, String) | Creates a new instruction in the flow area. |
| CreateInstruction(UInt64, String, String) | Creates a new instruction in the flow area. |
| CreateJump(ObjectProxy, String) | Creates a new jump in the flow area. |
| CreateJump(UInt64, String) | Creates a new jump in the flow area. |
| CreateJump(ObjectProxy, String, String) | Creates a new jump in the flow area. |
| CreateJump(UInt64, String, String) | Creates a new jump in the flow area. |
| CreateLink(ObjectProxy, Point) | Creates a new link inside a location. |
| CreateLink(UInt64, Point) | Creates a new link inside a location. |
| CreateLink(ObjectProxy, String, Point) | Creates a new link inside a location. |
| CreateLink(UInt64, String, Point) | Creates a new link inside a location. |
| CreateLink(ObjectProxy, String, Point, ObjectProxy) | Creates a new link inside a location. |
| CreateLink(ObjectProxy, String, Point, UInt64) | Creates a new link inside a location. |
| CreateLink(UInt64, String, Point, ObjectProxy) | Creates a new link inside a location. |
| CreateLink(UInt64, String, Point, UInt64) | Creates a new link inside a location. |
| CreateLocation(ObjectProxy, String) | Creates a new location object in the articy project tree. |
| CreateLocation(UInt64, String) | Creates a new location object in the articy project tree. |
| CreateLocation(ObjectProxy, String, String) | Creates a new location object in the articy project tree. |
| CreateLocation(UInt64, String, String) | Creates a new location object in the articy project tree. |
| CreateLocationGroup | Creates a new location group within in an existing location or location group. |
| CreateLocationImage(ObjectProxy, String, Point, ObjectProxy) | Creates a new image inside a location. |
| CreateLocationImage(UInt64, String, Point, UInt64) | Creates a new image inside a location. |
| CreateLocationImage(ObjectProxy, String, Point, ObjectProxy, String) | Creates a new image inside a location. |
| CreateLocationImage(UInt64, String, Point, UInt64, String) | Creates a new image inside a location. |
| CreateLocationLayerFolder | Creates a new location layer folder within in an existing location or location layer folder. |
| CreateLocationText(ObjectProxy, Point, String, Double, Double) | Creates a new text inside a location. |
| CreateLocationText(UInt64, Point, String, Double, Double) | Creates a new text inside a location. |
| CreateLocationText(ObjectProxy, Point, String, Double, Double, String) | Creates a new text inside a location. |
| CreateLocationText(UInt64, Point, String, Double, Double, String) | Creates a new text inside a location. |
| CreatePath(ObjectProxy, String, Point) | Creates a new path inside a location. |
| CreatePath(UInt64, String, Point) | Creates a new path inside a location. |
| CreatePath(ObjectProxy, String, String, Point) | Creates a new path inside a location. |
| CreatePath(UInt64, String, String, Point) | Creates a new path inside a location. |
| CreateRuleSet | Creates a new ruleset and returns a handle to manipulate the ruleset further |
| CreateSpot(ObjectProxy, String, Point) | Creates a new spot inside a location. |
| CreateSpot(UInt64, String, Point) | Creates a new spot inside a location. |
| CreateSpot(ObjectProxy, String, String, Point) | Creates a new spot inside a location. |
| CreateSpot(UInt64, String, String, Point) | Creates a new spot inside a location. |
| CreateVariableSet | Creates a new variable set in the "Global Variables" system folder. |
| CreateZoneCircle(ObjectProxy, String, Point, Double) | Creates a new spherical zone inside a location. |
| CreateZoneCircle(UInt64, String, Point, Double) | Creates a new spherical zone inside a location. |
| CreateZoneCircle(ObjectProxy, String, String, Point, Double) | Creates a new spherical zone inside a location. |
| CreateZoneCircle(UInt64, String, String, Point, Double) | Creates a new spherical zone inside a location. |
| CreateZonePolygon(ObjectProxy, String, Point) | Creates a new custom-shaped zone inside a location. |
| CreateZonePolygon(UInt64, String, Point) | Creates a new custom-shaped zone inside a location. |
| CreateZonePolygon(ObjectProxy, String, String, Point) | Creates a new custom-shaped zone inside a location. |
| CreateZonePolygon(UInt64, String, String, Point) | Creates a new custom-shaped zone inside a location. |
| CreateZoneRect(ObjectProxy, String, Rect) | Creates a new rectangular zone inside a location. |
| CreateZoneRect(UInt64, String, Rect) | Creates a new rectangular zone inside a location. |
| CreateZoneRect(ObjectProxy, String, String, Rect) | Creates a new rectangular zone inside a location. |
| CreateZoneRect(UInt64, String, String, Rect) | Creates a new rectangular zone inside a location. |
| DeleteObject | Deletes the given object and all its dependencies. E.g. when you delete a folder, all elements within will also be deleted; when you delete a FlowFragment, all inner elements will be deleted, all connected pins and connections to this flow fragment get also deleted |
| DiscardChangesToPartition(Guid) | Discard changes in a single partition which is given by its Guid. |
| DiscardChangesToPartition(SimplePartitionActionArgs) | Discard changes in a single partition which is given by its Guid. |
| DiscardPartitions(DiscardingArgs) | Overload. Discard all changes to the partitions identified by the GUIDs in the DiscardingArgs argument. |
| DiscardPartitions(Boolean, Guid) | Discard all changes to the partitions identified by aGuids. |
| DiscardProject | Discard all changes to the partitions you have currently claimed. |
| DisconnectServer | Disconnects your application from the currently connected articy:server. |
| Dispose | Dispose the session object. |
| DoCustomImport | Run an import as an automated task. The execution is |
| EndFeature(FeatureDescriptorBlueprint) | Call to create or modify an actual Feature using the given blueprint |
| EndFeature(FeatureDescriptorBlueprint, IObjectCustomizationGridLayout) | Call to create or modify an actual Feature using the given blueprint |
| EndObjectTemplate | Call to create or modify an actual object template using the given blueprint |
| EndPropertyDefinitionTPropertyBlueprint | Finish the blueprint session and create the described property definition |
| Equals | Determines whether the specified object is equal to the current object. (Inherited from Object) |
| ExecuteQueryInSearchNavigator | Executes a search in the current navigator search tab |
| ExecuteTaskWithProgressDialog | Executes the given task as background process while the foreground process shows a progress dialog. Use this method for long-running tasks to prevent "application not responding" conditions |
| ExportData(ExportDataArgs) | Starts an export using the information given in the specialized ExportDataArgs descriptor |
| ExportData(GenericExportDataArgs) | This method starts an export with a generic XML based parameter descriptor. |
| ExportDocument(ObjectProxy, ExportDocumentToDocxArgs) | Exports a document objects using the specific document export |
| ExportDocument(ObjectProxy, String) | Exports a document objects using the specific document export. Uses all the defaults from the ExportDocumentToDocxArgs A valid output filename must be given |
| FeaturePresent | Checks if the given feature exists |
| FindFlowPosition | Helper method to find the transformed position in the flow. If snap-to-grid option is enabled the coordinate is also snapped to coordinates on the active grid. |
| FindLocationPosition | |
| FindTransformedPosition | |
| ForcefullyUnclaimPartition(Guid) | Forcefully unclaims a partition that was claimed by another user. |
| ForcefullyUnclaimPartition(SimplePartitionActionArgs) | Forcefully unclaims a partition that was claimed by another user. |
| FormatException | Formats the given exception to a string |
| GetAllowedObjectsForContext | Returns a HashSet containing all ObjectTypes that can appear as children object in the given context |
| GetClaimingStateInfo | Requests a statistics object about the partitions that |
| GetClassPropertyInfo | Requests the PropertyInfo object for a object class property. |
| GetCurrentUser | Gets the currently logged in user |
| GetExporter | Fetches the descriptor object of the named custom exporter |
| GetExportSettings | Gets the XML version of the export settings |
| GetFeatureByTechName | This will find an model customization feature by its tech name |
| GetFeaturePropertyInfo | Requests the PropertyInfo object for a feature property |
| GetFeaturePropertyNames | Requests a list of all properties of a given feature |
| GetGlobalVariable(String) | Gets a global variable whose full qualified name, namespace & variable name, is known. For example "game.IsRunning" |
| GetGlobalVariable(ObjectProxy, String) | Fetches a variable from a given VariableSet |
| GetHashCode | Serves as the default hash function. (Inherited from Object) |
| GetImporter | Get the Descriptor of an known importer |
| GetIsLocalizable | Checks if a given property is set to be localizable |
| GetIsVoiceOver | Checks if a given property can be voiced-over |
| GetLanguage(Int32) | Get a language info object by the id of the language |
| GetLanguage(String) | Get a language info object by specifying the iso-name |
| GetLanguageIcon | requests a brush for the given iso-language |
| GetLanguages | Request all languages in the project filtered with the given selector |
| GetLocationToolsFor | Create an ApiLocationTool object |
| GetObjectById | Gets an object whose ID is known. |
| GetObjectByTechName | Gets an object whose technical name is known. |
| GetObjectIcon | |
| GetObjectsByType | Gets all objects of the given type |
| GetObjectsWithFeature(FeatureDescriptorBlueprint) | Returns a list of all the objects with a given feature |
| GetObjectsWithFeature(ObjectProxy) | Returns a list of all the objects with a given feature |
| GetObjectsWithFeature(String) | Returns a list of all the objects with a given feature |
| GetObjectTypeDisplayName | Requests the display name of the given type |
| GetPartitionInfo | Request the information object for a single partition. |
| GetPartitionInfos | Requests a list of the opened project's partitions and their current states. |
| GetPartitionsWithUpdates | Gets a list of all partitions that have updated files in the SCM |
| GetPrimaryLanguage | Get the language info object for the primary language |
| GetProjectFolderPath | Returns the current path to the project data |
| GetProjectList | Once logged into an articy:server successfully, a list of available projects can be queried using this method. |
| GetProjectRoot | Gets the projects root object. |
| GetRuleSetByName | Convenience method to get a ruleset by Displayname. (since MDK 1.5) |
| GetServerOrCommandLineValue | |
| GetSystemFolder | Gets the given "system folder" object |
| GetSystemFolderId | Gets the ID of a system folder |
| GetTemplate | Gets the template with the given name |
| GetTemplateByTechName | This will find an object template by its tech name |
| GetTextCounts | Requests the text metrics for the given text |
| GetTextLanguages | Request a list of all registered languages |
| GetType | Gets the Type of the current instance. (Inherited from Object) |
| GetUser | Get a record of a specific user within the project from the server This list this record is fetched from is cached in the session for about 5 minutes, but may be forced to be re-request |
| GetUsers | Requests the list of all users within the current project from the server. This list is cached in the session for about 5 minutes, but may be forced to be re-read |
| GetVariableSetByName | Gets a variable set with the given name. |
| GetVoiceOverLanguages | Request a list of all registered languages that have voice over enabled |
| HasServerOrCommandLineValue | |
| ImportAsset(ObjectProxy, String, String) | Imports the specified file and creates a new asset object. |
| ImportAsset(UInt64, String, String) | Imports the specified file and creates a new asset object. |
| ImportAsset(ObjectProxy, String, String, String) | Imports the specified file and creates a new asset object. |
| ImportAsset(UInt64, String, String, String) | Imports the specified file and creates a new asset object. |
| ImportAssets | Bulk asset import. The method returns directly after creating the Asset objects, copying the asset files from the given source to the project folder is done in a background thread and may take some time to complete. If you need to access the files from the asset objects, you should call WaitForAssetProcessing(WaitForAssetProcessingArgs) or its overload first. |
| IsConnected | returns true if an active connection to the articy:server exists |
| IsLoggedIn | returns true if a user is logged in to the current articy:server |
| IsPartitionUpdateAvailable | Checks if a given partition has updates in the used source control system |
| LinearizeFlowSegment | Create a linear list of a possible branching flow subtree. Tries to keep connected parts together and in linear order. Provides |
| LoadExportPreset | Loads an export preset and constructs a ExportArgs class that can be used with ExportData. You should add the selected objects, set up the Log source and may override the filename parameter. |
| LocalizeString | looks up a localized string with the given Loca-Id and formats the resulting text with the given parameters using the normal string.Format patterns |
| LocalizeStringNoFormat | looks up a localized string with the given Loca-Id |
| Login | Logs a user in to the connected articy:server |
| Logout | Before logging into as another user, use this method to logout from the articy:server. |
| ModifyRuleSet | Edit an existing ruleset |
| MoveObject | Moves the given object into the given target/parent container. The new parent must already be claimed and must allow the given object. Cross partition moves will also fail |
| MoveObjects | Moves the given objects into the given target/parent container The new parent must already be claimed and must allow the given objects. Cross partition moves will also fail |
| OpenProject | Once logged into an articy:server successfully, open a project using this method. |
| PublishProject | Saves the project and publishes all partitions that are claimed and contain changes. The partitions will stay claimed. |
| PublishProjectPartitions | Saves the project and publishes or unclaims all partitions that are claimed and contain changes. |
| RefactorVariableReferences | Searches expression fields for variable that are named like a certain variable but not actually linked to it. A so called stray variable reference is created when a variable is deleted while still in use by an expression field. When creating a new variable by the same name, that old reference is weak-linked to the new variable by its name. Stray references will not react on renaming or moving unless they are linked to the actual variable by using this function. Expression fields containing such stray variables will be modified and are claimed during the course of this function. Objects in partitions that are claimed by other users will be ignored. The affected partitions will not be unclaimed automatically. |
| RegisterExporter | Register a new exporter for the export dialog |
| RegisterExportGroup | Registers a custom group in the export dialog |
| RegisterImporter | Register a custom importer by specifying its descriptor object |
| RegisterTextCountCalculator | registers a custom character/word/line count calculator for texts |
| ReimportAsset | Schedules a re-import of an asset from its "OriginalSource" filename. The methods return immediately. It just enqueues a job that is processing in the background. Use WaitForAssetProcessing(WaitForAssetProcessingArgs) when you need the job(s) to be completed before proceeding |
| RemoveLanguage | |
| Repartition | Changes the partition configuration of a project. The changes will be published and the project will be saved during this function. Only certain objects can be passed to this function. Invalid objects will cause an exception. See ObjectProxy.CanBePartitioned. |
| ResumeLocaStateHandling | remove normal localization/voice-over state handling |
| RunQuery(String) | Searches the opened project for articy objects. |
| RunQuery(String, ObjectProxy) | Searches the opened project for articy objects. |
| SaveProject | Once retrieved objects have been changed via this API, calling this method causes the changes to be written to the local project folder. Most partition handling methods of this API call this method implicitly upfront. However, if you may want to save changes on your own use this method. |
| SelectObject |
Opens an object picker where the user can select a given object
|
| SetIsLocalizable | Change the text localization flag for a property |
| SetIsVoiceOver | Change the voice-over localization flag for a property |
| SetLanguage | |
| SetPrimaryLanguage | |
| ShowDialog | Shows a window and sets the main application window as owner of the given window |
| ShowMessageBox | Shows a message box with the given parameters |
| ShowQueryBox | Shows a query box to enter a single value. |
| SimpleFindConflicts | Searches the project for object that have conflicts. |
| SimpleFindObjects(String, ApiLanguageInfo) | The simplest form of the search. Searches if any text contains the given string. (not case-sensitive) Search is started at the project root node. |
| SimpleFindObjects(UInt64, String, ApiLanguageInfo) | Searches if any text contains the given string starting at a given node. (not case-sensitive) |
| SimpleFindObjects(UInt64, String, TextFilterRelation, SearchTextIn, Boolean, ApiLanguageInfo) | Searches if a text matches under the given compare operator. |
| StartJourneyOn | |
| SuspendLocaStateHandling | Suspend the internal localization/voice-over state handling e.g. when changing a primary text. States not are changed independently and only for the accessed object/langauge |
| TemplatePresent | Checks if the given template exists |
| ToString | Returns a string that represents the current object. (Inherited from Object) |
| UnclaimAllMyPartitions | Unclaims all partitions the currently logged-in user has claimed. |
| UnclaimAllMyPartitions(UnclaimPartitionArgs) | Unclaims all partitions the currently logged-in user has claimed |
| UnclaimPartition(Guid) | Unclaims a single partition which is given by its Guid. |
| UnclaimPartition(UnclaimPartitionArgs) | Unclaims a single partition which is given by its Guid. |
| UnclaimPartitions(ListGuid) | Unclaims all partitions in the list of partition guids in one single transaction |
| UnclaimPartitions(ListGuid, UnclaimPartitionArgs) | Unclaims all partitions in the list of partition guids in one single transaction |
| UnclaimProject | Saves the project and unclaims all partitions that are claimed and contain changes. The partitions will be unclaimed. |
| UnregisterExporter | Unregisters a custom export from the export dialog |
| UnregisterExportGroup | Unregister/Remove a custom export dialog group |
| UnregisterImporter | Unregister a custom importer by specifying its technical name |
| UnregisterTextCountCalculator | Unregisters the custom text metric counting and reverts back to the articy:draft default handling |
| UpdatePartition(Guid) | Updates the given partition. |
| UpdatePartition(SimplePartitionActionArgs) | Updates the given partition. Using this overload you can add the output to a log |
| UpdatePartitions(ListGuid) | A convenience wrapper over the UpdatePartitions call that also allows to specify an optional log source value |
| UpdatePartitions(ListGuid, String) | Updates all partitions in the given list. This is a smart implementation that skips already up-to-data partitions and also does the pre- and post-tasks of updating a partition once on entry and exit of the loop over the given partitions. |
| WaitForAssetProcessing(WaitForAssetProcessingArgs) | Blocking call that waits until the asset system has processed all assets. This has to be completed before partitions can be published or the exclusive mode can be left. After claiming a partition, opening a project in exclusive mode and importing assets, the asset system starts checking the status of each corresponding asset. |
| WaitForAssetProcessing(WaitForAssetProcessingArgs, IListString) | Blocking call that waits until the asset system has processed all assets. This has to be completed before partitions can be published or the exclusive mode can be left. After claiming a partition, opening a project in exclusive mode and importing assets, the asset system starts checking the status of each corresponding asset. |
Fields
Extension Methods
| TraceError | (Defined by TraceHelper) |
| TraceInfo | (Defined by TraceHelper) |
| TraceWarning | (Defined by TraceHelper) |