Articy.Api Namespace |
Class | Description | |
---|---|---|
ApiConsts |
static class that contains some constants and a error code helper method
| |
ApiLocationTools |
Helper class to work with locations
| |
ApiSession |
Once the session is created successfully, all further API calls are invoked on this session object.
| |
ArticyApiException |
The standard exception used when the API has found an expected error
| |
CloseProjectArgs |
Argument class for CloseProject(CloseProjectArgs) | |
ComplexApiCallArgs |
base class for the argument objects used for API calls that have many parameters
| |
ExportDataArgs |
The abstract base class for all specialized export arguments
| |
ExportDocumentToDocxArgs |
The parameter args to be used for exporting a document object to Word
| |
ExportObjectSelectionDataArgs |
Abstract base class for all exports that allow pre-selection of to-be-exported objects.
Currently this are the office exports (DOCX and XLSX)
| |
ExportToAccessArgs |
Specialized argument class for the articy:access export
| |
ExportToDocxArgs |
Specialized argument class for the DOCX export
| |
ExportToFullXmlArgs |
Specialized argument class for the XML export
This export currently has no other configuration options
| |
ExportToXlsxArgs |
Specialized argument class for the XLSX export
| |
ExportXlsxForReimportArgs |
Argument class for the XLSX export for Re-Import
| |
FlowListNode |
Contains the information about a single node in the flow linearization
| |
FlowReference |
Contains the information about a reference in the flow linearization
| |
GenericExportDataArgs |
When using the method ExportData(GenericExportDataArgs) an instance of this object needs to be passed along.
| |
JsonExportArgs |
Export args for the JSON export
| |
ObjectPropertyInfo |
This class aggregates information about a single property that is exposed from ObjectProxy
| |
ObjectPropertyNames |
This class contains constants for all properties that are introduced by
the base objects of articy:draft.
You can find type infos and restrictions in braces after the name
| |
ObjectProxy |
Represents one articy:draft object like it is shown in the articy:draft GUI.
| |
OpenProjectArgs |
This argument object contains all parameters for the OpenProject(OpenProjectArgs) method
| |
ResultSet |
This object is the container of objects that were found from a query.
It is also internally used to cache meta/schema data for all accessed properties
from elements in the row collection. This reduces the memory footprint and
gives some extra speed when having many object of the same type in the result set.
| |
RuleSetBasedExport |
Base class for all ruleset based exports
| |
SimplePartitionActionArgs |
Base class for arguments that require a partition Guid.
Some methods only need these arguments with no additional parameters
| |
Transformer |
This class contains methods to transform a selection of location objects.
This object can only be created from an ApiLocationTools that is bound to a specific location.
| |
UnclaimPartitionArgs |
Argument class for unclaiming partition(s)
| |
Unity3DExportArgs |
Export args for the Unity plugin export
| |
Unreal4ExportArgs |
Export args for teh Unreal 4 plugin export
| |
WaitForAssetProcessingArgs |
Argument class for the WaitForAssetProcessing(WaitForAssetProcessingArgs) method.
The main purpose is to be able to specify a log source name where progress messages should be reported
|
Delegate | Description | |
---|---|---|
IsObjectAllowed |
delegate used to filter objects for the model picker
| |
LoggingCallback |
The delegate used to report logging information
|
Enumeration | Description | |
---|---|---|
ApiMode |
Enum that specifies in which context the API is used
| |
ApiSessionFocusPane |
The split-pane that should be used
| |
ApiSessionFocusTab |
The tab to be used to focus an object
| |
ApiSessionFocusWindow |
The window that should be used to focus and object
| |
CloseProgressMode |
Enumeration that describes what to do with a progress window if its operation has finished
| |
ContextMenuContext |
Is used as a context indicator when a MDK plugin requests a context menu.
| |
EntryType |
Entry type of log messages
| |
ErrorCode |
This enumeration contains error codes that are detected by the API
| |
ExportTextFormat |
The text formatter to use when exporting text to Json, Unity, Unreal
| |
ExportXlsxForReimportArgsSortObjectsBy |
Specifies the property that is used to sort the objects to be exported
| |
FlowReferenceRefType |
the different types of references
| |
HierarchyAdjustment |
Specifies the placement of a new document object in respect to the given context object.
| |
JourneyActionTypes |
Available actions to take while recording a journey
| |
ObjectContext |
Specifies the context a given object resides.
The context is calculated by checking if the given object is a child of the matching system folder
| |
ObjectType |
This enumeration contains all object types available for API access.
| |
ProjectRightLevel |
right levels of users in projects
| |
ProjectUnavailabilityReason |
The reason why a project is currently not available
| |
PropertyDataSubType |
a more detailed information about the data type
| |
PropertyDataType |
known data types of fields/properties
| |
PropertyFilter |
Flag based filter for GetAvailableProperties of ObjectProxy | |
RepartitionMode |
Specifies how repartitioning should work on the given objects
| |
SearchConflictsIn |
Flag enum for searching for conflicts
| |
SearchTextIn |
Flag enum to specify where the simple text search should look up its strings
| |
SelectionContext |
Used when reporting a selection to an MDK plugin
| |
SystemFolderNames |
Technical names of system folders.
These names can be used in the FROM clause of a query and to get the folder object when using the
GetSystemFolder(SystemFolderNames) method
| |
TextFilterRelation |
enumeration of filter relations used for SimpleFindObjects(UInt64, String, TextFilterRelation, SearchTextIn, Boolean) | |
TextFormat |
Enumeration to specify if which format the GetText(TextFormat)
overload should format the returned text.
| |
TransformerAnchorPosition |
Specifies the pivot alignment/snapping
| |
TransformerTransformMode |
Specifies the alignment for the bounding box used for the transformation
|