# IO

> Python API types

### CloudDirectory

Select between:

* local: [io.LocalDirectoryAccess](./io_types#localdirectoryaccess)
* openStack: [io.OpenStackAccess](./io_types#openstackaccess)
* dropBox: [io.DropBoxAccess](./io_types#dropboxaccess)
* ownCloud: [io.OwnCloudAccess](./io_types#owncloudaccess)
* webDAV: [io.WebDAVAccess](./io_types#webdavaccess)

***

### CloudFile

Select between:

* local: [io.LocalFileAccess](./io_types#localfileaccess)
* openStack: [io.OpenStackAccess](./io_types#openstackaccess)
* dropBox: [io.DropBoxAccess](./io_types#dropboxaccess)
* ownCloud: [io.OwnCloudAccess](./io_types#owncloudaccess)
* webDAV: [io.WebDAVAccess](./io_types#webdavaccess)

***

### DropBoxAccess

DropBox connection informations.
Fields

| Type  | Name   | Default | Description |
| ----- | ------ | ------- | ----------- |
| path  | String |         |             |
| token | String |         |             |

***

### ExportFilePath

File path of a supported file for export.
Base class: [core.OutputFilePath](./core_types#outputfilepath)


**Frame:**
```mermaid
classDiagram
    class ExportFilePath
    OutputFilePath <|-- ExportFilePath
```

Functions accepting this type or a list of this type as a parameter:

* [core.save](./core_functions#save)
* [core.generateActivationCode](./core_functions#generateactivationcode)
* [core.generateDeactivationCode](./core_functions#generatedeactivationcode)
* [core.setCoreDumpFile](./core_functions#setcoredumpfile)
* [core.setLogFile](./core_functions#setlogfile)
* [io.exportScene](./io_functions#exportscene)
* [io.exportSelection](./io_functions#exportselection)
* [material.exportImage](./material_functions#exportimage)
* [view.takeScreenshot](./view_functions#takescreenshot)
* [core.load](./core_functions#load)
* [core.installLicense](./core_functions#installlicense)
* [core.getModuleDescFromXML](./core_functions#getmoduledescfromxml)
* [io.importPicture](./io_functions#importpicture)
* [io.importScene](./io_functions#importscene)
* [io.listVariants](./io_functions#listvariants)
* [io.splitPointCloud](./io_functions#splitpointcloud)
* [material.importImage](./material_functions#importimage)
* [scene.exportFilterLibrary](./scene_functions#exportfilterlibrary)
* [scene.importFilterLibrary](./scene_functions#importfilterlibrary)
* [algo.configureFunctionLogger](./algo_functions#configurefunctionlogger)
* [algo.bakeMaterialPropertyMap](./algo_functions#bakematerialpropertymap)
* [algo.bakeOccurrencePropertyMap](./algo_functions#bakeoccurrencepropertymap)
* [algo.sawWithAABB](./algo_functions#sawwithaabb)
* [algo.sawWithOBB](./algo_functions#sawwithobb)
* [algo.sawWithPlane](./algo_functions#sawwithplane)
* [cad.configureFunctionLogger](./cad_functions#configurefunctionlogger)
* [core.configureFunctionLogger](./core_functions#configurefunctionlogger)
* [core.getEvent](./core_functions#getevent)
* [core.getEvents](./core_functions#getevents)
* [core.getFunction](./core_functions#getfunction)
* [core.getFunctions](./core_functions#getfunctions)
* [core.getGroup](./core_functions#getgroup)
* [core.getGroups](./core_functions#getgroups)
* [core.getModuleTypes](./core_functions#getmoduletypes)
* [core.getType](./core_functions#gettype)
* [core.getTypeAttributes](./core_functions#gettypeattributes)
* [core.addWantedToken](./core_functions#addwantedtoken)
* [core.checkWebLogin](./core_functions#checkweblogin)
* [core.configureLicenseServer](./core_functions#configurelicenseserver)
* [core.needToken](./core_functions#needtoken)
* [core.ownToken](./core_functions#owntoken)
* [core.releaseToken](./core_functions#releasetoken)
* [core.releaseWebLicense](./core_functions#releaseweblicense)
* [core.removeWantedToken](./core_functions#removewantedtoken)
* [core.requestWebLicense](./core_functions#requestweblicense)
* [core.retrieveWebLicenses](./core_functions#retrieveweblicenses)
* [core.tokenValid](./core_functions#tokenvalid)
* [core.parallelStart](./core_functions#parallelstart)
* [core.removeModule](./core_functions#removemodule)
* [core.pushProgression](./core_functions#pushprogression)
* [core.addCustomProperties](./core_functions#addcustomproperties)
* [core.addCustomProperty](./core_functions#addcustomproperty)
* [core.getModuleProperty](./core_functions#getmoduleproperty)
* [core.getModulePropertyInfo](./core_functions#getmodulepropertyinfo)
* [core.getProperties](./core_functions#getproperties)
* [core.getProperty](./core_functions#getproperty)
* [core.getPropertyInfo](./core_functions#getpropertyinfo)
* [core.hasCustomProperty](./core_functions#hascustomproperty)
* [core.hasProperty](./core_functions#hasproperty)
* [core.listModuleProperties](./core_functions#listmoduleproperties)
* [core.removeCustomProperty](./core_functions#removecustomproperty)
* [core.restoreModulePropertyDefaultValue](./core_functions#restoremodulepropertydefaultvalue)
* [core.setModuleProperty](./core_functions#setmoduleproperty)
* [core.setProperties](./core_functions#setproperties)
* [core.setProperty](./core_functions#setproperty)
* [core.unsetProperty](./core_functions#unsetproperty)
* [core.startUndoRedoStep](./core_functions#startundoredostep)
* [core.log](./core_functions#log)
* [geom.configureFunctionLogger](./geom_functions#configurefunctionlogger)
* [io.configureFunctionLogger](./io_functions#configurefunctionlogger)
* [io.addAssetPaths](./io_functions#addassetpaths)
* [io.findInDirectories](./io_functions#findindirectories)
* [io.setAssetPaths](./io_functions#setassetpaths)
* [io.importRemote3mxFile](./io_functions#importremote3mxfile)
* [io.registerIOCallbacks](./io_functions#registeriocallbacks)
* [io.getExtensionPriority](./io_functions#getextensionpriority)
* [material.addUniformProperty](./material_functions#adduniformproperty)
* [material.configureFunctionLogger](./material_functions#configurefunctionlogger)
* [material.createCustomMaterialPattern](./material_functions#createcustommaterialpattern)
* [material.createMaterial](./material_functions#creatematerial)
* [material.findCustomMaterialPatternByName](./material_functions#findcustommaterialpatternbyname)
* [material.findMaterialsByPattern](./material_functions#findmaterialsbypattern)
* [material.findMaterialsByProperty](./material_functions#findmaterialsbyproperty)
* [material.getPointsAndMaterialFromText](./material_functions#getpointsandmaterialfromtext)
* [material.getUniformPropertyType](./material_functions#getuniformpropertytype)
* [material.setCoeffOrTextureProperty](./material_functions#setcoeffortextureproperty)
* [material.setColorAlphaProperty](./material_functions#setcoloralphaproperty)
* [material.setColorOrTextureProperty](./material_functions#setcolorortextureproperty)
* [material.setFragmentShader](./material_functions#setfragmentshader)
* [material.setMaterialPattern](./material_functions#setmaterialpattern)
* [material.setVertexShader](./material_functions#setvertexshader)
* [material.createImageFromData](./material_functions#createimagefromdata)
* [polygonal.configureFunctionLogger](./polygonal_functions#configurefunctionlogger)
* [polygonal.createMeshFromText](./polygonal_functions#createmeshfromtext)
* [scene.configureFunctionLogger](./scene_functions#configurefunctionlogger)
* [scene.createOccurrence](./scene_functions#createoccurrence)
* [scene.createOccurrenceFromSelection](./scene_functions#createoccurrencefromselection)
* [scene.createOccurrenceFromText](./scene_functions#createoccurrencefromtext)
* [scene.createOccurrences](./scene_functions#createoccurrences)
* [scene.getActivePropertyValue](./scene_functions#getactivepropertyvalue)
* [scene.getActivePropertyValues](./scene_functions#getactivepropertyvalues)
* [scene.setOccurrenceName](./scene_functions#setoccurrencename)
* [scene.findOccurrencesByMetadata](./scene_functions#findoccurrencesbymetadata)
* [scene.findOccurrencesByProperty](./scene_functions#findoccurrencesbyproperty)
* [scene.createLight](./scene_functions#createlight)
* [scene.addMetadata](./scene_functions#addmetadata)
* [scene.addMetadataBlock](./scene_functions#addmetadatablock)
* [scene.getMetadata](./scene_functions#getmetadata)
* [scene.removeMetadata](./scene_functions#removemetadata)
* [scene.createAlternativeTree](./scene_functions#createalternativetree)
* [scene.createAnimation](./scene_functions#createanimation)
* [scene.getSubChannel](./scene_functions#getsubchannel)
* [scene.linkPropertyToAnimation](./scene_functions#linkpropertytoanimation)
* [scene.unlinkPropertyToAnimation](./scene_functions#unlinkpropertytoanimation)
* [scene.addFilterToLibrary](./scene_functions#addfiltertolibrary)
* [scene.findFilterByName](./scene_functions#findfilterbyname)
* [scene.setReferencedDataComponentPath](./scene_functions#setreferenceddatacomponentpath)
* [scene.addAnnotationGroup](./scene_functions#addannotationgroup)
* [scene.addVariant](./scene_functions#addvariant)
* [scene.duplicateVariant](./scene_functions#duplicatevariant)
* [unity.configureFunctionLogger](./unity_functions#configurefunctionlogger)
* [view.configureFunctionLogger](./view_functions#configurefunctionlogger)
* [view.getViewerProperty](./view_functions#getviewerproperty)
* [view.getViewerPropertyInfo](./view_functions#getviewerpropertyinfo)
* [view.setViewerProperty](./view_functions#setviewerproperty)
* [view.startRecording](./view_functions#startrecording)

***

### ExportFilePathList

List of [io.ExportFilePath](./io_types#exportfilepath)

***

### FileFormat

Describe the file format.
Fields

| Type                   | Name                  | Default         | Description                                    |
| ---------------------- | --------------------- | --------------- | ---------------------------------------------- |
| product                | String                |                 |                                                |
| extension              | String                |                 |                                                |
| version                | String                |                 |                                                |
| priority               | PriorityImportLevel   | Priority\_1     |                                                |
| read                   | Boolean               | False           |                                                |
| write                  | Boolean               | False           |                                                |
| hasTessellated         | FileFormatDescription | NOT\_APPLICABLE |                                                |
| hasBREP                | FileFormatDescription | NOT\_APPLICABLE |                                                |
| hasAlternativeImporter | FileFormatDescription | NOT\_APPLICABLE |                                                |
| hasMetadata            | FileFormatDescription | NOT\_APPLICABLE |                                                |
| hasPMI                 | FileFormatDescription | NOT\_APPLICABLE |                                                |
| osMask                 | Int                   | 7               | Mask based on Windows (1), Linux (2), OSX (4). |

Functions accepting this type or a list of this type as a parameter:

* [io.registerIOCallbacks](./io_functions#registeriocallbacks)

***

### FileFormatDescription

Enumeration of option states.
Enum of [core.Int](./core_types#int)

| Name            | Value |
| --------------- | ----- |
| NO              | 0     |
| YES             | 1     |
| NOT\_APPLICABLE | 2     |

***

### FileFormatList

List of [io.FileFormat](./io_types#fileformat)

Functions accepting this type or a list of this type as a parameter:

* [io.registerIOCallbacks](./io_functions#registeriocallbacks)

***

### FilesList

List of [core.FilePath](./core_types#filepath)

Functions accepting this type or a list of this type as a parameter:

* [io.importFiles](./io_functions#importfiles)

***

### ImportFilePath

File path of a supported file for import.
Base class: [core.FilePath](./core_types#filepath)


**Frame:**
```mermaid
classDiagram
    class ImportFilePath
    FilePath <|-- ImportFilePath
```

Functions accepting this type or a list of this type as a parameter:

* [core.load](./core_functions#load)
* [core.installLicense](./core_functions#installlicense)
* [core.getModuleDescFromXML](./core_functions#getmoduledescfromxml)
* [io.importPicture](./io_functions#importpicture)
* [io.importScene](./io_functions#importscene)
* [io.listVariants](./io_functions#listvariants)
* [io.splitPointCloud](./io_functions#splitpointcloud)
* [material.importImage](./material_functions#importimage)
* [scene.exportFilterLibrary](./scene_functions#exportfilterlibrary)
* [scene.importFilterLibrary](./scene_functions#importfilterlibrary)
* [algo.configureFunctionLogger](./algo_functions#configurefunctionlogger)
* [algo.bakeMaterialPropertyMap](./algo_functions#bakematerialpropertymap)
* [algo.bakeOccurrencePropertyMap](./algo_functions#bakeoccurrencepropertymap)
* [algo.sawWithAABB](./algo_functions#sawwithaabb)
* [algo.sawWithOBB](./algo_functions#sawwithobb)
* [algo.sawWithPlane](./algo_functions#sawwithplane)
* [cad.configureFunctionLogger](./cad_functions#configurefunctionlogger)
* [core.configureFunctionLogger](./core_functions#configurefunctionlogger)
* [core.getEvent](./core_functions#getevent)
* [core.getEvents](./core_functions#getevents)
* [core.getFunction](./core_functions#getfunction)
* [core.getFunctions](./core_functions#getfunctions)
* [core.getGroup](./core_functions#getgroup)
* [core.getGroups](./core_functions#getgroups)
* [core.getModuleTypes](./core_functions#getmoduletypes)
* [core.getType](./core_functions#gettype)
* [core.getTypeAttributes](./core_functions#gettypeattributes)
* [core.addWantedToken](./core_functions#addwantedtoken)
* [core.checkWebLogin](./core_functions#checkweblogin)
* [core.configureLicenseServer](./core_functions#configurelicenseserver)
* [core.needToken](./core_functions#needtoken)
* [core.ownToken](./core_functions#owntoken)
* [core.releaseToken](./core_functions#releasetoken)
* [core.releaseWebLicense](./core_functions#releaseweblicense)
* [core.removeWantedToken](./core_functions#removewantedtoken)
* [core.requestWebLicense](./core_functions#requestweblicense)
* [core.retrieveWebLicenses](./core_functions#retrieveweblicenses)
* [core.tokenValid](./core_functions#tokenvalid)
* [core.parallelStart](./core_functions#parallelstart)
* [core.removeModule](./core_functions#removemodule)
* [core.pushProgression](./core_functions#pushprogression)
* [core.addCustomProperties](./core_functions#addcustomproperties)
* [core.addCustomProperty](./core_functions#addcustomproperty)
* [core.getModuleProperty](./core_functions#getmoduleproperty)
* [core.getModulePropertyInfo](./core_functions#getmodulepropertyinfo)
* [core.getProperties](./core_functions#getproperties)
* [core.getProperty](./core_functions#getproperty)
* [core.getPropertyInfo](./core_functions#getpropertyinfo)
* [core.hasCustomProperty](./core_functions#hascustomproperty)
* [core.hasProperty](./core_functions#hasproperty)
* [core.listModuleProperties](./core_functions#listmoduleproperties)
* [core.removeCustomProperty](./core_functions#removecustomproperty)
* [core.restoreModulePropertyDefaultValue](./core_functions#restoremodulepropertydefaultvalue)
* [core.setModuleProperty](./core_functions#setmoduleproperty)
* [core.setProperties](./core_functions#setproperties)
* [core.setProperty](./core_functions#setproperty)
* [core.unsetProperty](./core_functions#unsetproperty)
* [core.startUndoRedoStep](./core_functions#startundoredostep)
* [core.log](./core_functions#log)
* [geom.configureFunctionLogger](./geom_functions#configurefunctionlogger)
* [io.configureFunctionLogger](./io_functions#configurefunctionlogger)
* [io.addAssetPaths](./io_functions#addassetpaths)
* [io.findInDirectories](./io_functions#findindirectories)
* [io.setAssetPaths](./io_functions#setassetpaths)
* [io.importRemote3mxFile](./io_functions#importremote3mxfile)
* [io.registerIOCallbacks](./io_functions#registeriocallbacks)
* [io.getExtensionPriority](./io_functions#getextensionpriority)
* [material.addUniformProperty](./material_functions#adduniformproperty)
* [material.configureFunctionLogger](./material_functions#configurefunctionlogger)
* [material.createCustomMaterialPattern](./material_functions#createcustommaterialpattern)
* [material.createMaterial](./material_functions#creatematerial)
* [material.findCustomMaterialPatternByName](./material_functions#findcustommaterialpatternbyname)
* [material.findMaterialsByPattern](./material_functions#findmaterialsbypattern)
* [material.findMaterialsByProperty](./material_functions#findmaterialsbyproperty)
* [material.getPointsAndMaterialFromText](./material_functions#getpointsandmaterialfromtext)
* [material.getUniformPropertyType](./material_functions#getuniformpropertytype)
* [material.setCoeffOrTextureProperty](./material_functions#setcoeffortextureproperty)
* [material.setColorAlphaProperty](./material_functions#setcoloralphaproperty)
* [material.setColorOrTextureProperty](./material_functions#setcolorortextureproperty)
* [material.setFragmentShader](./material_functions#setfragmentshader)
* [material.setMaterialPattern](./material_functions#setmaterialpattern)
* [material.setVertexShader](./material_functions#setvertexshader)
* [material.createImageFromData](./material_functions#createimagefromdata)
* [polygonal.configureFunctionLogger](./polygonal_functions#configurefunctionlogger)
* [polygonal.createMeshFromText](./polygonal_functions#createmeshfromtext)
* [scene.configureFunctionLogger](./scene_functions#configurefunctionlogger)
* [scene.createOccurrence](./scene_functions#createoccurrence)
* [scene.createOccurrenceFromSelection](./scene_functions#createoccurrencefromselection)
* [scene.createOccurrenceFromText](./scene_functions#createoccurrencefromtext)
* [scene.createOccurrences](./scene_functions#createoccurrences)
* [scene.getActivePropertyValue](./scene_functions#getactivepropertyvalue)
* [scene.getActivePropertyValues](./scene_functions#getactivepropertyvalues)
* [scene.setOccurrenceName](./scene_functions#setoccurrencename)
* [scene.findOccurrencesByMetadata](./scene_functions#findoccurrencesbymetadata)
* [scene.findOccurrencesByProperty](./scene_functions#findoccurrencesbyproperty)
* [scene.createLight](./scene_functions#createlight)
* [scene.addMetadata](./scene_functions#addmetadata)
* [scene.addMetadataBlock](./scene_functions#addmetadatablock)
* [scene.getMetadata](./scene_functions#getmetadata)
* [scene.removeMetadata](./scene_functions#removemetadata)
* [scene.createAlternativeTree](./scene_functions#createalternativetree)
* [scene.createAnimation](./scene_functions#createanimation)
* [scene.getSubChannel](./scene_functions#getsubchannel)
* [scene.linkPropertyToAnimation](./scene_functions#linkpropertytoanimation)
* [scene.unlinkPropertyToAnimation](./scene_functions#unlinkpropertytoanimation)
* [scene.addFilterToLibrary](./scene_functions#addfiltertolibrary)
* [scene.findFilterByName](./scene_functions#findfilterbyname)
* [scene.setReferencedDataComponentPath](./scene_functions#setreferenceddatacomponentpath)
* [scene.addAnnotationGroup](./scene_functions#addannotationgroup)
* [scene.addVariant](./scene_functions#addvariant)
* [scene.duplicateVariant](./scene_functions#duplicatevariant)
* [unity.configureFunctionLogger](./unity_functions#configurefunctionlogger)
* [view.configureFunctionLogger](./view_functions#configurefunctionlogger)
* [view.getViewerProperty](./view_functions#getviewerproperty)
* [view.getViewerPropertyInfo](./view_functions#getviewerpropertyinfo)
* [view.setViewerProperty](./view_functions#setviewerproperty)
* [view.startRecording](./view_functions#startrecording)

***

### ImportFilePathList

List of [io.ImportFilePath](./io_types#importfilepath)

***

### LocalDirectoryAccess

Local file.
Fields

| Type | Name          | Default | Description |
| ---- | ------------- | ------- | ----------- |
| path | DirectoryPath |         |             |

***

### LocalFileAccess

Local file.
Fields

| Type | Name     | Default | Description |
| ---- | -------- | ------- | ----------- |
| path | FilePath |         |             |

***

### OpenStackAccess

OpenStack connection informations.
Fields

| Type        | Name     | Default | Description |
| ----------- | -------- | ------- | ----------- |
| path        | String   |         |             |
| authUrl     | String   |         |             |
| region      | String   |         |             |
| user        | String   |         |             |
| password    | Password |         |             |
| domainId    | String   |         |             |
| projectId   | String   |         |             |
| container   | String   |         |             |
| objectStore | String   | swift   |             |

***

### OwnCloudAccess

OwnCloud connection informations.
Fields

| Type     | Name     | Default | Description |
| -------- | -------- | ------- | ----------- |
| path     | String   |         |             |
| authUrl  | String   |         |             |
| user     | String   |         |             |
| password | Password |         |             |

***

### PriorityImportLevel

Priority levels for importer.
Enum of [core.Int](./core_types#int)

| Name         | Value |
| ------------ | ----- |
| unavailable  | 0     |
| Priority\_1  | 1     |
| Priority\_2  | 2     |
| Priority\_3  | 3     |
| Priority\_4  | 4     |
| Priority\_5  | 5     |
| Priority\_6  | 6     |
| Priority\_7  | 7     |
| Priority\_8  | 8     |
| Priority\_9  | 9     |
| Priority\_10 | 10    |

***

### Protocol

Web access protocol.
Enum of [core.Int](./core_types#int)

| Name  | Value |
| ----- | ----- |
| HTTP  | 1     |
| HTTPS | 2     |

***

### VariantNameList

List of [core.String](./core_types#string)

***

### WebDAVAccess

WebDAV connection informations.
Fields

| Type     | Name     | Default | Description |
| -------- | -------- | ------- | ----------- |
| path     | String   |         |             |
| host     | String   |         |             |
| port     | UShort   | 0       |             |
| protocol | Protocol | HTTP    |             |
| user     | String   |         |             |
| password | Password |         |             |
| url      | String   |         |             |

***

### exportFileCallback

Functions accepting this type or a list of this type as a parameter:

* [io.registerIOCallbacks](./io_functions#registeriocallbacks)

***

### importFileCallback

Functions accepting this type or a list of this type as a parameter:

* [io.registerIOCallbacks](./io_functions#registeriocallbacks)