Manager responsible for database records associated with “content.”.

More...

Inherits :

• QObject
  • DzBase

Responsible for the management of database records associated with “content” (digital assets).

There is only one instance of this manager in an application. This instance is created and owned by DzApp. Request the instance via DzApp::getAssetMgr().

See Also:

• Global::App
• DzAsset
• DzAbstractAssetContainer
• DzTopLevelAssetContainer
• DzProductHolderContainer
• DzProductAssetContainer
• DzCategoryAssetContainer
• DzCompatibilityBaseAssetContainer
• DzSearchContainer
• DzContentMgr
• Samples: Metadata

---

: CompatibilityBaseType

• NoCompatibility - A value that represents “None” in the context of Compatibility Bases/Filters.
• CompatibilityBase - A value that represents the base concept of an object.
• CompatibilityFilter - A value that represents a specific configuration on the base concept of an object.
• CompatibilityBaseAndFilter - A value that represents the base concept of an object, as well as a specific configuration on the base concept of an object.

—–

: MetadataType

• NoData - Metadata that is not created, owned or maintained by the vendor (originating source) or the user - i.e. none.
• UserData - Metadata that is created, owned and maintained by the user.
• VendorData - Metadata that is created, owned and maintained by the vendor (originating source).
• UserAndVendorData - Metadata that is created, owned and maintained by the vendor (originating source) and/or the user.

—–

: SearchOptions

Search options used to search assets with the Asset Manager.

• None - No options
• WholeWord - A whole word search. Only works with file system based searches.
• RegExp - A Regular Expression search. Only works with file system based searches.
• NativeScenes - Include native scene files (*.duf, *.dsf, *.daz) in the search.
• NativeScripts - Include native script files (*.ds, *.dsa, *.dsb, *.dse) in the search.
• PoserFigures - Include Poser Character files (*.cr2, *.crz) in the search.
• PoserPoses - Include Poser Pose files (*.pz2, *.p2z) in the search.
• PoserProps - Include Poser Prop files (*.pp2, *.ppz) in the search.
• PoserHair - Include Poser Hair files (*.hr2, *.hrz) in the search.
• PoserFaces - Include Poser Face (Expression) files (*.fc2,*.fcz) in the search.
• PoserLights - Include Poser Light files (*.lt2, *.ltz) in the search.
• PoserCameras - Include Poser Camera files (*.cm2, *.cmz) in the search.
• PoserHands - Include Poser Hand files (*.hd2, *.hdz) in the search.
• PoserMaterials - Include Poser Material Collection files (*.mc6, *.mcz) in the search.
• PoserScenes - Include Poser Scene files (*.pz3, *.pzz) in the search.
• ImportFiles - Include general import files in the search.
• AllNativeFiles - Include all native files (*.duf, *.dsf, *.daz, *.ds, *.dsa, *.dsb, *.dse) in the search.
• NoNativeFilesMask - Mask for no native files in the search.
• AllPoserFiles - Include all Poser files in the search.
• NoPoserFilesMask - Mask for no Poser files in the search.
• AllFiles - Search through all files.
• DefaultOptions - Same as AllFiles.

—–

: StopModeCMS

Modes for stopping the Content Management Service (CMS).

Since:

• 4.11.0.32

• SM_Smart - Waits for all active clients to disconnect and any online backup to finish. If the service is in hot standby, recovery and streaming replication will be terminated once all clients have disconnected.
• SM_Fast - Does not wait for clients to disconnect and terminates an online backup in progress. All active transactions are rolled back and clients are forcibly disconnected, then the service is shut down.
• SM_Immediate - Aborts all service processes immediately, without a clean shutdown.

---

Array : captureSceneAssetPathsList( DzNode node, Object options=null )

Parameter(s):

• node - A node to look for scene assets on.
• options - Options to control what and how assets are gathered. Currently only supports a bool option named “selected”, which the value of is used to indicate whether to only consider selected nodes or all nodes (default).

Return Value:

• A list of paths to scene assets for the given node (if any).

Since:

• 4.20.0.11

---

Array : captureSceneAssetPathsList( Object options=null )

Parameter(s):

• options - Options to control what and how assets are gathered. Currently only supports a bool option named “selected”, which the value of is used to indicate whether to only consider selected nodes or all nodes (default).

Return Value:

• A list of paths to scene assets (if any).

Since:

• 4.20.0.11

---

String : escapeSearchTerm( String searchTerm )

Parameter(s):

• searchTerm - The search term to be escaped.

Return Value:

• An escaped version of searchTerm

---

String : fileKeyForFilename( String relativePath )

Parameter(s):

• relativePath - The relative path of the file to convert to a key.

Return Value:

• The normalized, lowercase, leading '/' removed, version of relativePath that should be used to look up relativePath in the database.

Since:

• 4.16.1.32

---

String : findCommonBaseCategoryPath( Array categoryPaths, Boolean flatten=false )

Parameter(s):

• categoryPaths - The list of category paths to find a common path in. This can be a list of strings, or a list of lists of strings.
• flatten - If true, the categories are processed as if they are a single list. If false (default), the deepest path common to all lists will be chosen. In either case, non-default categorization is preferred over default categorization.

Return Value:

• A string representing the portion of categoryPaths that is common.

Since:

• 4.9.2.68

---

String : getAssetUriForNode( DzNode node )

Parameter(s):

• node - The node to get the asset URI for.

Return Value:

• The asset URI for node, or an empty string if node is null.

---

String : getCategoriesID()

Return Value:

• An identifier for the top level categories container.

---

String : getCompatibilityBasePathForNode( DzNode node )

Parameter(s):

• node - The node to get compatibility base for.

Return Value:

• A slash (“/”) delimited string version of the node's compatibility base path (if any), otherwise an empty string.

---

String : getCompatibilityBasesID()

Return Value:

• An identifier for the top level compatibility bases container.

Since:

• 4.11.0.93

---

Number : getDAZ3DStoreID()

Return Value:

• The 64-bit integer used to represent the store id for the Daz 3D store.

Since:

• 4.20.0.11

---

String : getImportDirID()

Return Value:

• An identifier for the top level import formats container.

---

String : getPoserDirID()

Return Value:

• An identifier for the top level Poser formats container.

---

Array : getPoserVirtualDirID()

Return Value:

• The identifier for the virtual folder container within the top level Poser formats container.

Since:

• 4.9.2.68

---

String : getProductName( String name, Array choices=[], Boolean allowEmpty=false )

Prompts the user for a valid product name.

Parameter(s):

• name - The product name (if any) to use if a product with the same name does not already exist in the database. An empty string, or a non-unique name, will cause the user to be prompted for a unique name.
• choices - A list of pre-defined choices (if any) to provide the user.
• allowEmpty - If true, an empty value is considered acceptable.

Return Value:

• A string that represents a valid product name (if allowEmpty is false - default), otherwise an empty string.

Since:

• 4.12.1.100

---

Object : getProductsForFiles( Array filenames )

Parameter(s):

• filenames - A list of filenames to find products for.

Return Value:

• An object with the following members (if no errors):
• products_parent : The parent containter for the list of products.
• products : An array of products found.
• unknown : An array of files that no products were found for.

See Also:

• DzProductHolderContainer
• DzProductAssetContainer
• DzScriptHandle

Since:

• 4.20.0.11

---

String : getProductsID()

Return Value:

• An identifier for the top level products container.

---

String : getRealPathCasing( String path, String search )

Parameter(s):

• path - The path to the file/folder that real, on disk, casing is desired for.
• search - A file/folder in the path to get the on disk casing for.

Return Value:

• A string path/search combination or empty string if search is not in path.

---

String : getRelativeProductMetafilePath( String store, String token, String title, String extension=“dsx” )

Parameter(s):

• store - The store ID for the product.
• token - The token for the product.
• title - The title of the product.
• extension - The extension of the meta file.

Return Value:

• The relative metadata file path.

Since:

• 4.9.4.31

---

Array : getSpecialPoserFolders()

Return Value:

• A list of the folder names that are considered special, and thus handled in specific ways, in a Poser runtime.

---

String : getStudioDirID()

Return Value:

• An identifier for the top level DAZ Studio formats container.

---

Array : getStudioExcludes()

Return Value:

• A list of the folder names excluded when building the native user-facing folder structure.

---

Array : getStudioVirtualDirID()

Return Value:

• The identifier for the virtual folder container within the top level DAZ Studio formats container.

Since:

• 4.9.2.68

---

String : normalizePath( String type, Boolean relative=true )

Parameter(s):

• type - The path/type to be normalized.
• relative - Whether or not this is a relative (or absolute) path.

Return Value:

• A normalized version of type.

---

DzError : saveUserDBData( String dirPath, String filePrefix )

Saves user owned metadata to an XML file (or a series of XML files).

Parameter(s):

• dirPath - The path to save user metadata files in.
• filePrefix - The prefix for the filename sequence.

Return Value:

• DZ_NO_ERROR on success, otherwise an error code.

---

Boolean : setCompatibilityBaseID( String uri, Number id, Boolean markAsVendor )

Sets the compatibility base for a URI.

Parameter(s):

• uri - The asset URI to set the compatibility base for.
• id - The 64-bit integer used to identify the compatibility base.
• markAsVendor - If true, the compatibility base is marked as being owned by a vendor.

Return Value:

• true if the compatibility base is set, otherwise false.

See Also:

• getAssetUriForNode()
• getCompatibilityBasePathForNode()
• findCompatibilityBase()
• createCompatibilityBase()
• getCompatibilityBase()

Since:

• 4.11.0.183

---

Boolean : setCompatibilityBasePath( String uri, String compatibilityBasePath, Boolean markAsVendor, Boolean create=false )

Sets the compatibility base for a URI.

Parameter(s):

• uri - The asset URI to set the compatibility base for.
• compatibilityBasePath - The slash (“/”) delimited path of the compatibility base to set.
• markAsVendor - If true, the compatibility base is marked as being owned by a vendor.
• create - If true, creates the compatibility base if it does not already exist.

Return Value:

• true if the compatibility base is set, otherwise false.

See Also:

• getAssetUriForNode()
• getCompatibilityBasePathForNode()

Since:

• 4.11.0.183

---

void : setFileMetadata( String filepath, String contentType, String compatibleWith, String category, DzNode assetNode=null, String compatibilityBase=“” )

Sets the metadata associated with a file.

Parameter(s):

• filepath - The path of the file to set the metadata on.
• contentType - The content type to set.
• compatibleWith - The compatibility base the asset is an add-on for.
• category - The category to put the asset in.
• assetNode - The node to get the compatibility base from.
• compatibilityBase - The compatibility base to set; for add-ons to target.

Since:

• 4.9.0.17

---

Object : buildMinimumProductSetForFiles( Array filenames, Array products )

Parameter(s):

• filenames - The list of relative file paths to find the minimum product set for.
• products - The list of products to limit the search for filenames to - can be expressed as GUID strings, DzProductAssetContainer instances, or DzScriptHandle instances that hold DzProductAssetContainer instances.

Return Value:

• A map consisting of a list of GUIDs (“product_guids”) for the products that represent the minimum set to satisfy the list of filenames specified, and a map of product GUIDs and the files each product respectively provides (“product_found_files”).

Since:

• 4.16.1.33

---

Object : buildMinimumProductSetForFiles( Array filenames )

Parameter(s):

• filenames - The list of relative file paths to find the minimum product set for.

Return Value:

• A map consisting of a list of GUIDs (“product_guids”) for the products that represent the minimum set to satisfy the list of filenames specified, a map of product GUIDs and the files each product respectively provides (“product_found_files”), and a list of the files specified in filenames that could not be associated with a product (“unknown”).

Attention:

• This function will consult the database to find a list of products for the list of filenames specified.

Since:

• 4.16.1.33

---

Boolean : canStartAndStopCMS()

Return Value:

• true if the currently connected Content Management Service (CMS) is of the type that can be started and stopped, otherwise false.

---

void : checkforNewMetadataScripts()

Checks for new metadata scripts within the RunOnce directories.

---

void : clearAllGroupIDs( Boolean notify=true )

Removes all groups from all assets.

Parameter(s):

• notify - If true, causes product and category containers to update.

---

void : clearDBMetaFileQueue()

Clears the metadata queue.

---

void : createCategoryPaths( String paths, String settingsName=“” )

Presents the user with a category path creation dialog.

Parameter(s):

• paths - The category path (if any) to set - separate multiple paths with commas.
• settingsName - The base name of the settings to store to/restore from. If set to an empty string (default), the default will be used.

Since:

• 4.15.0.16

---

Number : createCompatibilityBase( String base )

Creates a compatibility base.

Parameter(s):

• base - The compatibility base to create.

Return Value:

• An integer used to identify base.

---

DzProductAssetContainer : createProduct( String name, String storeID=“”, String token=“” )

Creates a new product.

Parameter(s):

• name - The name for the product - used if a product with the storeID and token specified does not already exist in the database to name the product.
• storeID - The identifier (e.g., “DAZ 3D”) of the store for the product. If the store does not exist in the database or this argument is an empty string (default), the “LOCAL USER” store will be used.
• token - The token (i.e., SKU) used to identify the product in the storeID store.

Return Value:

• The product named name, from store storeID, with the token token. If a product with the storeID and token already exists, a new product will not be created and the existing product will be returned instead.

See Also:

• createStore()
• getProductName()
• DzScriptHandle

Since:

• 4.9.3.39

---

DzProductAssetContainer : createProductFromAssets( Array assets, String name=“” )

Creates a new product from a list of assets.

Parameter(s):

• assets - The list of assets to create the product from.
• name - The name for the product. If empty (default), the user will be prompted to provide a name.

See Also:

• DzScriptHandle

Since:

• 4.9.3.41

---

DzProductAssetContainer : createProductFromContainer( DzAbstractAssetContainer container, String name=“” )

Creates a new product from container and its children.

Parameter(s):

• container - The asset container to create the product from.
• name - The name for the product. If empty (default), the user will be prompted to provide a name.

See Also:

• DzScriptHandle

Since:

• 4.9.3.39

---

Boolean : createStore( String storeID, String token, String url )

Attempts to create a store in the database.

Parameter(s):

• storeID - The identifier of the store (e.g., “DAZ 3D”) to create.
• token - The value within url to be replaced by a product's identifier (e.g., SKU) within that store when the product's final URL is constructed.
• url - The URL for the store.

Return Value:

• true if the store is successfully created, otherwise false.

Attention:

• The “DAZ 3D” and “LOCAL USER” storeIDs are reserved. Attempting to create a store with either ID will fail immediately and return a value of false.

See Also:

• showMoreProductInfo()
• Sample: Add Store Id

---

DzAbstractAssetContainer : createSubContainer( DzAbstractAssetContainer parentContainer, String name=“”, String settingsName=“” )

Creates a (folder/category/compatibility base) sub-container.

Parameter(s):

• parentContainer - The container to create a sub-container on.
• name - The name of the sub-container to create. If set to an empty string (default), the user will be prompted.
• settingsName - The base name of the settings to store to/restore from. If set to an empty string (default), the default will be used.

See Also:

• DzAbstractAssetContainer::canAddSubContainer()
• DzFolderAssetContainer
• DzCategoryAssetContainer
• DzCompatibilityBaseAssetContainer

Since:

• 4.15.0.16

---

Number : createType( String type, Boolean defaultOpen )

Creates a content type.

Parameter(s):

• type - The content type to create.
• defaultOpen - If true, assets that the type is assigned to will be opened by default; the contents of the scene will be cleared prior to loading the asset. If false , assets that the type is assigned to will be merged by default; the asset will be added to the existing scene.

Return Value:

• An integer used to identify type.

---

void : emitCategoryChanged( Array idPath )

Causes the category identified by idPath to update.

Parameter(s):

• idPath - The id path of the category to update.

---

String : findAssetPathFromShortFilename( String fileName )

Parameter(s):

• fileName - The short name of the file to find the asset path for.

Return Value:

• If fileName can be found, the physical path of the asset on disk, otherwise an empty string.

---

Array : findAssetsForFile( String relativePath, Boolean userFacing, Boolean installed )

Parameter(s):

• relativePath - The relative path of a file to find assets for.
• userFacing - Whether or not the file is user-facing.
• installed - Whether or not the file is installed.

Return Value:

• A list of assets that relativePath refers to.

See Also:

• DzScriptHandle

Since:

• 4.9.2.69

---

Number : findAudienceID( String audience )

Return Value:

• The id used to identify audience.

---

Number : findCategoryID( String categoryPath, Boolean isVendor, Boolean create=false )

Parameter(s):

• categoryPath - The full path of the category to find.
• isVendor - If true, the category is marked as being owned by a vendor.
• create - If true, the category is created if it cannot be found.

Return Value:

• A 64-bit integer used to identify the category (if any), otherwise -1.

Since:

• 4.15.0.16

---

Number : findCompatibilityBaseID( String base, Boolean create=true )

Attempts to find a compatibility base, and potentially create it if it does not already exist.

Parameter(s):

• base - The compatibility base to find (or create).
• create - If true, the compatibility base is created if it cannot be found.

Return Value:

• An integer used to identify base.

---

DzProductAssetContainer : findProductByGuid( String guid )

Parameter(s):

• guid - The Globally Unique Identifier (GUID) of the product to find.

Return Value:

• The product with the globally unique identifier guid, otherwise null.

See Also:

• DzScriptHandle

Since:

• 4.9.2.69

---

DzProductAssetContainer : findProductByStoreToken( String storeID, String token )

Parameter(s):

• storeID - The identifier of the store (e.g., “DAZ 3D”) for the product.
• token - The token (i.e., SKU) used to identify the product in the storeID store.

Return Value:

• The product from storeID store with the token token, otherwise null.

See Also:

• DzScriptHandle

Since:

• 4.9.3.39

---

Array : findProductsByName( String name )

Parameter(s):

• name - The name of the products to find.

Return Value:

• A list of products (if any) that are named name.

See Also:

• DzScriptHandle

Since:

• 4.9.3.39

---

Array : findProductsForFile( String relativePath )

Parameter(s):

• relativePath - The relative path of a file to find products that contain it.

Return Value:

• A list of products that contain relativePath in their respective list of assets.

See Also:

• DzScriptHandle

Since:

• 4.8.1.73

---

Number : findTypeID( String type, Boolean create=false, Boolean defaultOpen=false )

Attempts to find the identifier used to identify a content type.

Parameter(s):

• type - The content type to find.
• create - If true, the content type is created if it cannot be found.
• defaultOpen - If true, assets that the type is assigned to will be opened by default; the contents of the scene will be cleared prior to loading the asset. If false , assets that the type is assigned to will be merged by default; the asset will be added to the existing scene.

Return Value:

• An integer used to identify type.

---

String : getAudience( Number id )

Parameter(s):

• id - The unsigned 32-bit integer used to identify the audience.

Return Value:

• The audience identified by id.

---

Array : getAudiences()

Return Value:

• The list of available audiences.

---

DzCategoryAssetContainer : getCategories()

Return Value:

• A top-level container with child containers that match the hierarchy of categories in the content database.

---

Array : getCategoryData( Boolean includeHeader=true, MetadataTypes dataType=UserAndVendorData )

Parameter(s):

• includeHeader - If true (default), the first list in the return value will contain descriptors for the values in all subsequent lists.
• dataType - The type of data to retrieve.

Return Value:

• A two dimensional list of the raw data that defines categories.

Since:

• 4.15.0.16

---

String : getCategoryPath( Number id )

Parameter(s):

• id - The 64-bit integer used to identify the category.

Return Value:

• The full slash (“/”) delimited path of the category (if any), otherwise an empty string.

Since:

• 4.9.3.11

---

String : getCMSBasePath( Boolean create=false )

Parameter(s):

• create - If true, creates any folders in the returned path that do not currently exist.

Return Value:

• The base path for the Content Management Service (CMS).

See Also:

• getDefaultCMSBasePath()

Since:

• 4.11.0.248

---

Object : getCMSOptions()

Return Value:

• A JSON object consisting of options for the currently connected Content Management Service (CMS).

---

Number : getCMSPort()

Return Value:

• The port for communicating with the Content Management Service (CMS).

See Also:

• getDefaultCMSPort()

Since:

• 4.11.0.248

---

String : getCompatibilityBase( Number id )

Parameter(s):

• id - The integer used to identify the compatibility base.

Return Value:

• The compatibility base identified by id.

---

Array : getCompatibilityBaseData( Boolean includeHeader=true, CompatibilityBaseTypes baseType=CompatibilityBaseAndFilter, MetadataTypes dataType=UserAndVendorData )

Parameter(s):

• includeHeader - If true (default), the first list in the return value will contain descriptors for the values in all subsequent lists.
• baseType - The type of compatibility bases to retrieve.
• dataType - The type of data to retrieve.

Return Value:

• A two dimensional list of the raw data that defines compatibility bases.

Since:

• 4.15.0.16

---

DzCompatibilityBaseAssetContainer : getCompatibilityBases( Boolean includeFilters=true )

Parameter(s):

• includeFilters - If true (default), child containers for filters (filter) will be included.

Return Value:

• A top-level container (if the content database is active) with child containers that match the hierarchy of compatibility bases in the content database, otherwise null.

Since:

• 4.11.0.94

---

String : getContainerName( String title, String placeHolder=“”, String settingsName=“” )

Presents the user with a (folder/category/compatibility base) sub-container creation dialog.

Parameter(s):

• title - The container to create a sub-container for- only supports DzFolderAssetContainer, DzCompatibilityBaseAssetContainer, and DzCategoryAssetContainer.
• placeHolder - The text to display as a hint to the user. If set to an empty string (default), the default will be used.
• settingsName - The base name of the settings to store to/restore from. If set to an empty string (default), the default will be used.

Since:

• 4.15.0.16

---

DzTopLevelAssetContainer : getContentDirs()

Return Value:

• A top-level container with all of the mapped native content directories.

---

String : getDatabaseDsn()

Return Value:

• The Data Source Name (DSN) -i.e. “connection string”- for the PostgreSQL server if the server version is valid, otherwise an empty string.

Since:

• 4.9.0.17

---

String : getDatabaseFilePath()

Return Value:

• The path on disk where database files are located; for backup purposes.

---

Array : getDBMetaFileQueue()

Return Value:

• A list of metadata files queued for processing.

---

Array : getDefaultCategoryPaths( String prefix=“”, Boolean append=false )

Parameter(s):

• prefix - If non-empty, this value is used to replace the leading root “Default” category in the values returned by getRootCategoryStrings(), otherwise the return value will be the same as calling getRootCategoryStrings() directly.
• append - If true and root is not an empty string, the modified values are appended to the end of the getRootCategoryStrings() list - if root is an empty string, this parameter has no affect. If false (default) and is a non-empty string, only the modified values are returned.

Return Value:

• A list of 'default' category paths.

See Also:

• getRootCategoryStrings()

Since:

• 4.15.0.15

---

String : getDefaultCMSBasePath()

Return Value:

• The default base path for the Content Management Service (CMS).

See Also:

• getCMSBasePath()

Since:

• 4.11.0.248

---

Number : getDefaultCMSPort()

Return Value:

• The default port for communicating with the Content Management Service (CMS).

See Also:

• getCMSPort()

Since:

• 4.11.0.248

---

String : getFirstCategory( String assetPath, String preferredCategory, Boolean installed=true )

Parameter(s):

• assetPath - The path of the asset to find the first category for.
• preferredCategory - The path of the category preferred if it exists and the asset at assetPath is assigned to it.
• installed - If true, assetPath is only tested against files that are installed. If false , assetPath is only tested against files that are not installed. (since 4.11.0.88)

Return Value:

• The full path of the first category that the file at assetPath is assigned to.

---

Boolean : getGroupNewProductsAsNew()

Return Value:

• true if new products should be assigned to the “New” group, otherwise false.

See Also:

• setGroupNewProductsAsNew()

Since:

• 4.9.0.23

---

DzTopLevelAssetContainer : getImportDirs()

Return Value:

• A top-level container with all of the mapped import content directories.

---

Number : getMaxFileSearchResultSize()

Return Value:

• The maximum number of items returned by a file search.

Since:

• 4.9.0.15

---

Number : getNumMaxItemsPerPage()

Return Value:

• The maximum number of items to show per page.

---

DzTopLevelAssetContainer : getPoserDirs()

Return Value:

• A top-level container with all of the mapped Poser directories.

---

DzTopLevelAssetContainer : getProducts()

Return Value:

• A top-level container with child containers for intermediate alpha-numeric organization of products by name. Each intermediate container then has its respective children for the products in the content database.

See Also:

• Sample: Metadata : List Products

---

Array : getRelativePaths( String absolutePath, Boolean useImportFolders )

Attempts to shorten absolutePath to a list of paths that are relative to one of the mapped content directories.

Parameter(s):

• absolutePath - The path to make relative.
• useImportFolders - If true, the mapped import folders will also be searched.

Return Value:

• A list of relative paths to the file if one can be made, otherwise and empty list

See Also:

• DzContentMgr::getRelativePaths()

---

Array : getRootCategoryStrings()

Return Value:

• A list of root category paths.

---

Boolean : getShowHiddenVendorCategorization()

Return Value:

• true if hidden vendor categorizations are shown, otherwise false.

Since:

• 4.9.3.4

---

Array : getStoresIDs()

Return Value:

• A list of store identifiers.

See Also:

• Sample: Store Info

---

String : getStoreToken( String storeID )

Parameter(s):

• storeID - The identifier of the store (e.g., “DAZ 3D”) to get the token for.

Return Value:

• The token used in the URL for the storeID store, which is to be replaced by a product's identifier (e.g., SKU) within that store when the product's final URL is constructed.

See Also:

• Sample: Store Info

---

String : getStoreUrl( String storeID )

Parameter(s):

• storeId - The identifier of the store (e.g., “DAZ 3D”) to get the URL for.

Return Value:

• The URL for the storeID store.

See Also:

• Sample: Store Info

---

String : getType( Number id )

Parameter(s):

• id - The integer used to identify the content type.

Return Value:

• The content type identified by id.

---

String : getTypeForContentFile( String path )

Performs a database lookup on a user-facing content file to get its content type.

Parameter(s):

• path - The path of the file to get the content type for.

Return Value:

• The content type of the file if the file is in the content database and is user-facing, otherwise an empty string.

---

String : getTypeForNode( DzNode node )

Checks the given node for content type in its presentation (if any), falls back to a source file data item and performs a content database lookup on the path it specifies (if any), and finally falls back to the content file path of the node (if any) to find its content type.

Parameter(s):

• node - The node in the scene to get the content type of.

Return Value:

• The content type for the node (if any), otherwise an empty string.

---

Array : getTypes()

Return Value:

• A list of hierarchical, slash (“/”) delimited, content types

---

String : getUniqueChildCategoryName( String categoryPath, String name )

Parameter(s):

• categoryPath - The full path of the parent category to check.
• name - The name to check for uniqueness.

Return Value:

• A unique name for the child category. If name is unique, the same value us returned. If categoryPath is invalid, an empty string is returned. If name is not unique, a dialog is

Since:

• 4.15.0.16

---

Boolean : haveDatabase()

Return Value:

• true if the PostgreSQL server version is valid and the DSN is non-empty, otherwise false.

Since:

• 4.9.0.17

See Also:

• getDatabaseDsn()

---

Array : importMetadataFiles( Array absoluteProductPaths, Boolean runSilent=false, Boolean markAsVendor=false )

Causes metadata files at absoluteProductPaths to be imported.

Parameter(s):

• absoluteProductPaths - The list of absolute paths to import product metadata from.
• runSilent - If true, the progress dialog will not be shown.
• markAsVendor - If true, the data is considered vendor owned.

---

Object : installMissingAssets( Array filenames, Boolean noPrompt=false, String productMsg=“”, String unknownMsg=“” )

Installs the assets specified if a product they belong to can be found.

Parameter(s):

• filenames - The list of relative file names to install. It is the developer's responsibility to verify that the file names passed in are not already in a mapped content directory.
• noPrompt - If true, installation of any product(s) found begins immediately without prompting the user; this does not prevent progress from being reported. The default is false , which prompts the user and waits for a response.
• productMsg - The message to display above the installable products list. If this is an empty string (default), a default string will be used.
• unknownMsg - The message to display above the unknown files list. If this is an empty string (default), a default string will be used.

Return Value:

• A JSON object consisting of a list of any products that were found to contain the missing files, a list of the files that were found per product (since 4.16.1.32), a list of the files that were not found in any product, and a list of the products that were selected for installation.

Attention:

• The “-logMissingProduct” option can be used on the command line to log “Missing Products” encountered during the asset loading process - since 4.15.0.16.

See Also:

• DzContentMgr::getAbsolutePath()

Since:

• 4.11.0.116

---

Boolean : isClothingType( String type )

Parameter(s):

• type - The content type to test.

Return Value:

• true if type is of the base type of Clothing, otherwise false.

See Also:

• DzContentReplaceMgr

---

Boolean : isConnectedToCMS()

Return Value:

• true if the Content Management Service (CMS) is currently connected, otherwise false.

---

Boolean : isFigureType( String type )

Parameter(s):

• type - The content type to test.

Return Value:

• true if type is of the base type of Figure, otherwise false.

See Also:

• DzContentReplaceMgr

---

Boolean : isFollowingType( String type )

Parameter(s):

• type - The content type to test.

Return Value:

• true if type is of a following type, otherwise false.

See Also:

• DzContentReplaceMgr

---

Boolean : isHairType( String type )

Parameter(s):

• type - The content type to test.

Return Value:

• true if type is of the base type of Hair, otherwise false.

See Also:

• DzContentReplaceMgr

---

Boolean : isNeedsBaseFigureType( String type )

Parameter(s):

• type - The content type to test.

Return Value:

• true if type is of a type that needs a base figure, otherwise false.

See Also:

• DzContentReplaceMgr

---

Boolean : isPresetForFigureType( String type )

Parameter(s):

• type - The content type to test.

Return Value:

• true if type is a Preset for a Figure, otherwise false.

See Also:

• DzContentReplaceMgr

---

Boolean : isPresetType( String type )

Parameter(s):

• type - The content type to test.

Return Value:

• true if type is of the base type of Preset, otherwise false.

See Also:

• DzContentReplaceMgr

---

Boolean : isPropType( String type )

Parameter(s):

• type - The content type to test.

Return Value:

• true if type is of the base type of Prop, otherwise false.

See Also:

• DzContentReplaceMgr

---

Boolean : isReplaceableType( String type )

Parameter(s):

• type - The content type to test.

Return Value:

• true if type is of a replaceable type, otherwise false.

See Also:

• DzContentReplaceMgr

---

Boolean : isResettingDatabase()

Return Value:

• true if the connected PostgreSQL database is currently being reset, otherwise false.

Since:

• 4.9.0.17

---

Boolean : isSynchronizing()

Return Value:

• true if the database is currently synchronizing, otherwise false.

4.9.3.71

---

void : markCategoriesChanged()

Signals that categories need to be updated.

---

void : markProductsChanged()

Signals that products need to be updated.

---

Array : processDBMetaFile( String productRelativePath, Boolean runSilent=false, Boolean markAsVendor=false, Boolean groupAsNew=true )

Causes the metadata file at productRelativePath to be processed and category containers to update.

Parameter(s):

• productRelativePath - The relative product path to import metadata from.
• runSilent - If true, the progress dialog will not be shown.
• markAsVendor - If true, the data is considered vendor owned.
• groupAsNew - If true, the product/assets are grouped as “New”.

---

Array : processDBMetaFileNoEmit( String productRelativePath, Boolean runSilent=false, Boolean markAsVendor=false, Boolean groupAsNew=true )

Causes the metadata file at productRelativePath to be processed, without causing category containers to update.

Parameter(s):

• productRelativePath - The relative product path to import metadata from.
• runSilent - If true, the progress dialog will not be shown.
• markAsVendor - If true, the data is considered vendor owned.
• groupAsNew - If true, the assets are grouped as “New”.

---

void : processDBMetaFileQueue()

If metadata files are queued, causes the metadata import dialog to be displayed and allows the user to select which products to process metadata for, then starts the import process on the selected products.

---

void : queueDBMetaFile( String productRelativePath )

Adds the file at productRelativePath to the metadata queue.

---

void : refreshCategoryRoots()

Causes the internal list of root categories to be rebuilt.

---

void : refreshStores()

Causes the internal list of stores to be rebuilt.

---

void : refreshTypes()

Causes the internal list of content types to be rebuilt

---

void : reimportDBMetaFiles()

Causes all *.dsx metadata files in the “./Runtime/Support” folder of each mapped native and Poser content directory to be queued, and then imported.

---

void : removeOrphanedAssetReferences( Array list )

Removes assets in list that have been orphaned (no longer exist) from the database.

Parameter(s):

• list - The list of DzAsset to check whether the files still exist.

Since:

• 4.9.0.17

---

Boolean : removeStore( String storeID )

Attempts to remove a store from the database.

Parameter(s):

• storeID - The identifier of the store (e.g., “DAZ 3D”) to remove.

Return Value:

• true if the store is successfully removed, otherwise false.

Attention:

• The “DAZ 3D” and “LOCAL USER” storeIDs are reserved. Attempting to remove a store with either ID will fail immediately and return a value of false.

See Also:

• Sample: Remove Store Id

Since:

• 4.9.1.24

---

void : resetDatabase()

Triggers the connected PostgreSQL server to reset (delete) the current database and re-establish the default content types, compatibility bases, and categories.

Attention:

• Stops all running searches and logs the current user out, if needed.

Since:

• 4.9.0.17

---

void : scanFiles( SearchOptions options, Boolean assignToGroup, Boolean addToCategory, Boolean onlyNewToCategory )

Performs a user-facing file scan, ultimately mapping any directories found to contain compatible content.

Parameter(s):

• options - A bitwise OR of the options to use for filtering the file scan.
• assignToGroup - If true, groups any found files as “New”.
• addToCategory - If true, found files are assigned to the “Scan Results” category.
• onlyNewToCategory - If true, only “new” files are assigned to the “Scan Results” category.

---

DzSearchContainer : searchFiles( String filename, SearchOptions options )

Performs a user-facing file search on the mapped content directories.

Parameter(s):

• filename - The name of the file to search for.
• options - A bitwise OR of the options to use for filtering the results.

Return Value:

• A container consisting of DzAsset instances for any files found during the search.

See Also:

• DzScriptHandle

---

DzSearchContainer : searchForAssetAddOns( DzAsset asset, String filterText, Array categories, SortType sorting )

Performs a user-facing asset search on the content database, where the results are confined to those that indicate they are compatible with the compatibility base of the specified asset.

Parameter(s):

• asset - The context asset; the asset to find addons for.
• filterText - The text to use for filtering the results.
• categories - A list of category paths to use for filtering the results.
• sorting - The sorting filter index to use for ordering the results.
  • 0 = None,
  • 1 = Name,
  • 2 = Date Purchased,
  • 3 = Date Installed,
  • 4 = Date Created,
  • 5 = Release Date,
  • 6 = Last Update,
  • 7 = Group ID,
  • 8 = Product ID (SKU),
  • For Descending add 0x80000000 to the value

Return Value:

• A container consisting of any DzAsset instances found during the search.

See Also:

• DzScriptHandle

Since:

• 4.9.0.32

---

DzSearchContainer : searchForAssets( String filterText, Array categories, Array compatibilityBases, Array contentTypes, SortType sorting )

Performs a user-facing asset search on the content database.

Parameter(s):

• filterText - The text to use for filtering the results.
• categories - A list of category paths to use for filtering the results.
• compatibilityBases - A list of compatibility bases to use for filtering the results.
• contentTypes - A list of content types to use for filtering the results.
• sorting - The sorting filter index to use for ordering the results.
  • 0 = None,
  • 1 = Name,
  • 2 = Date Purchased,
  • 3 = Date Installed,
  • 4 = Date Created,
  • 5 = Release Date,
  • 6 = Last Update,
  • 7 = Group ID,
  • 8 = Product ID (SKU),
  • For Descending add 0x80000000 to the value

Return Value:

• A container consisting of any DzAsset instances found during the search.

See Also:

• DzScriptHandle

Since:

• 4.9.0.32

---

DzSearchContainer : searchForAssetsByKeywords( String keywords, SearchOptions options, SortType sorting )

Performs a user-facing asset search on the content database.

Parameter(s):

• keywords - The keywords to use for filtering the results.
• options - A bitwise OR of the options to use for filtering the results.
• sorting - The sorting filter index to use for ordering the results.
  • 0 = None,
  • 1 = Name,
  • 2 = Date Purchased,
  • 3 = Date Installed,
  • 4 = Date Created,
  • 5 = Release Date,
  • 6 = Last Update,
  • 7 = Group ID,
  • 8 = Product ID (SKU),
  • For Descending add 0x80000000 to the value

Return Value:

• A container consisting of any DzAsset instances found during the search.

See Also:

• DzScriptHandle

Since:

• 4.9.0.32

---

DzSearchContainer : searchForAssetsInCategory( String categoryPath, Boolean userFacing=true, Boolean installed=true )

Parameter(s):

• categoryPath - The full path of the category to search for assets.
• userFacing - Whether or not to limit the search to user-facing assets. (since 4.9.3.56)
• installed - Whether or not to limit the search to installed assets. (since 4.9.3.56)

Return Value:

• A search container containing the assets matching the criteria specified.

See Also:

• DzScriptHandle

Since:

• 4.9.1.17

---

DzSearchContainer : searchForAssetTargets( DzAsset asset, String filterText, Array categories, SortType sorting )

Performs a user-facing asset search on the content database, where the results are confined to those that indicate they are the compatibility base of the specified asset.

Parameter(s):

• asset - The context asset; the asset to find targets for.
• filterText - The text to use for filtering the results.
• categories - A list of category paths to use for filtering the results.
• sorting - The sorting filter index to use for ordering the results.
  • 0 = None,
  • 1 = Name,
  • 2 = Date Purchased,
  • 3 = Date Installed,
  • 4 = Date Created,
  • 5 = Release Date,
  • 6 = Last Update,
  • 7 = Group ID,
  • 8 = Product ID (SKU),
  • For Descending add 0x80000000 to the value

Return Value:

• A container consisting of any DzAsset instances found during the search.

See Also:

• DzScriptHandle

Since:

• 4.9.0.32

---

DzSearchContainer : searchForProductAssets( DzProductAssetContainer product, String filterText, Array categories, Array compatibilityBases, Array contentTypes, SortType sorting )

Performs a user-facing asset search on the content database, where the results are confined to a specified product.

Parameter(s):

• product - The context product; the product to filter results by.
• filterText - The text to use for filtering the results.
• categories - A list of category paths to use for filtering the results.
• compatibilityBases - A list of compatibility bases to use for filtering the results.
• contentTypes - A list of content types to use for filtering the results.
• sorting - The sorting filter index to use for ordering the results.
  • 0 = None,
  • 1 = Name,
  • 2 = Date Purchased,
  • 3 = Date Installed,
  • 4 = Date Created,
  • 5 = Release Date,
  • 6 = Last Update,
  • 7 = Group ID,
  • 8 = Product ID (SKU),
  • For Descending add 0x80000000 to the value

Return Value:

• A container consisting of any DzAsset instances found during the search.

See Also:

• DzScriptHandle

Since:

• 4.9.0.32

---

DzProductHolderContainer : searchForProducts( String filterText, Array categories, Array compatibilityBases, Array contentTypes, ProductInstallStates installStateFlags, SortType sorting )

Parameter(s):

• filterText - The text to use for filtering the results.
• categories - A list of category paths to use for filtering the results.
• compatibilityBases - A list of compatibility bases to use for filtering the results.
• contentTypes - A list of content types to use for filtering the results.
• installStateFlags - The install state flags to use for filtering the results.
  • None = 0x0,
  • Installed = 0x1,
  • NotInstalled = 0x2,
  • Damaged = 0x4,
  • NeedsUpdate = 0x8,
  • Pending = 0x10,
  • Any = Installed | NotInstalled | Damaged | NeedsUpdate | Pending
• sorting - The sorting filter index to use for ordering the results.
  • 0 = None,
  • 1 = Name,
  • 2 = Date Purchased,
  • 3 = Date Installed,
  • 4 = Date Created,
  • 5 = Release Date,
  • 6 = Last Update,
  • 7 = Group ID,
  • 8 = Product ID (SKU),
  • For Descending add 0x80000000 to the value

Return Value:

• An asset container where child containers are the DzProductAssetContainer instances found during the search. DzTopLevelAssetContainer::getState() should be called, in a while loop, on the return value and compared for equality with the DzTopLevelAssetContainer::csBusy state. While the state is busy, results of the search are still being added.

See Also:

• DzScriptHandle

Since:

• 4.9.0.32

---

Array : selectCategoryPaths( Boolean multiSelect=false, Array startWith=[], String title=“”, String settingsName=“” )

Presents the user with a category selection dialog.

Parameter(s):

• multiSelect - Whether or not to allow multiple selection.
• startWith - A list of the category paths (if any) to start with. If multiSelect is false, the first element in the list is used.
• title - The text to display for the title of the dialog. If set to an empty string (default), the default title for the dialog will be used.
• settingsName - The base name of the settings to store to/restore from. If set to an empty string (default), the default will be used.

Return Value:

• A list of the selected category path(s).

Since:

• 4.15.0.16

---

Array : selectCompatibilityBasePaths( Boolean showFilters=true, Boolean multiSelect=false, Array startWith=[], String title=“”, String settingsName=“” )

Presents the user with a compatibility base selection dialog.

Parameter(s):

• showFilters - Whether or not to include compatibility filters.
• multiSelect - Whether or not to allow multiple selection.
• startWith - A list of the compatibility paths (if any) to start with. If multiSelect is false, the first element in the list is used.
• title - The text to display for the title of the dialog. If set to an empty string (default), the default title for the dialog will be used.
• settingsName - The base name of the settings to store to/restore from. If set to an empty string (default), the default will be used.

Return Value:

• A list of the selected compatibility base(s).

Since:

• 4.15.0.16

---

void : setCMSOptions( String clusterDirectory, Number port )

Sets the options for the Content Management Service (CMS), if it is of the type that can accept options.

Parameter(s):

• clusterDirectory - The path of the directory that contains the database files.
• port - The port number to use for connecting to the database server.

---

void : setGroupNewProductsAsNew( Boolean onOff )

Parameter(s):

• onOff - If true, new products will be assigned to the “New” group.

See Also:

• getGroupNewProductsAsNew()

Since:

• 4.9.0.23

---

void : setMaxFileSearchResultSize( Number maxNum )

Parameter(s):

• maxNum - The maximum number of items to return from a standard file search.

See Also:

• getMaxFileSearchResultsSize()

Since:

• 4.9.0.15

---

void : setMaxItemsPerPage( Number maxNum )

Parameter(s):

• maxNum - The maximum number of items to show on a page in the content view

See Also:

• getNumMaxItemsPerPage()

---

void : setProductGroupIDs( Array guids, Number groupId, Boolean groupProduct=true, Boolean groupFiles=true )

Sets the group identifier on products and/or files, for a list of products.

Parameter(s):

• guids - A list of guids for the products to set the group identifier on.
• groupId - The group identifier to set.
• groupProduct - If true, sets the group identifier on the product.
• groupFiles - If true, sets the group identifier on the user-facing files in the product.

Since:

• 4.9.0.25

---

void : setShowAssetToolTip( Boolean onOff )

Parameter(s):

• onOff - Whether or not to show tool tips on assets.

See Also:

• showAssetToolTip()

---

void : setShowExtensions( Boolean onOff )

Parameter(s):

• onOff - Whether or not to show extensions on assets.

See Also:

• showExtensions()

---

void : setShowHiddenVendorCategorization( Boolean shown )

Sets whether or not hidden vendor categorizations are shown.

Parameter(s):

• shown - If true, hidden vendor categorizations are shown.

Since:

• 4.9.3.4

---

void : setShowLargeIcons( Boolean onOff )

Parameter(s):

• onOff - Whether or not to show large icons.

See Also:

• showLargeIcons()

---

Boolean : showAssetToolTip()

Return Value:

• true if showing asset tool tips, otherwise false.

See Also:

• setShowAssetToolTip()

---

Boolean : showDatabaseEditor( DzAbstractAssetContainer assetContainer )

Causes the Content DB Editor to be displayed, allowing the user to view/edit metadata for products and/or assets all within a centralized dialog.

Parameter(s):

• assetContainer - The asset container to load into the editor. If the asset container is a DzProductAssetContainer, the dialog will display two pages: one for the product specific data, and one for the asset specific data. If the asset container is any other type, only the page for the asset specific data is displayed.

Return Value:

• true if the dialog is accepted, otherwise false.

---

Boolean : showExtensions()

Return Value:

• true if showing asset file extensions, otherwise false.

See Also:

• setShowExtensions()

---

Boolean : showLargeIcons()

Return Value:

• true if showing large asset icons, otherwise false.

See Also:

• setShowLargeIcons()

---

void : showMoreProductInfo( DzProductAssetContainer product )

Executes a script named after the store associated with product, in the ./resources/stores directory. A single anonymous JSON object is passed to the script, which can be retrieved using the global “getArguments()” function. The properties on the Object consist of values stored in the content database.

• store_id - A String containing the identifier for the store product is associated with.
• store_token - A String containing the token in store_url to be replaced by product_token.
• store_url - A String containing the URL with more information about product.
• product_token - A String containing the token (SKU) from product.
• product_name - A String containing the name of product.
• product_artists - An Array of String values containing the names of artists that contributed to product.
• product_description - A String containing the description of product.
• product_guid - A String containing the Globally Unique Identifier for product.
• product_is_vendor - A Boolean indicating whether product is provided by a vendor or the user.
• product_has_cloud_meta - A Boolean indicating whether product has metadata provided via the cloud (or manual/local).
• product_is_cloud_owned - A Boolean indicating whether product is managed via the cloud (or manual/local).

Parameter(s):

• product - The product to show more information for.

See Also:

• createStore()
• DzApp::getResourcesPath()
• DzScriptContext::getArguments()
• ./resources/stores/default.dsa

Since:

• 4.8.1.70

---

void : startCMS()

Starts the Content Management Service (CMS), if it is not already running.

---

void : stopAllSearches()

Stops all searches that were started by any of the search* methods on DzAssetMgr.

---

void : stopCMS( StopModeCMS mode, Boolean wait, Number timeout=0 )

Stops the Content Management Service (CMS), if it is running and is of the type that can be stopped.

Parameter(s):

• mode - The mode to use to stop the service.
• wait - Whether or not to wait for the CMS to stop before continuing.
• timeout - The number of seconds to wait for the service to stop before continuing.

---

void : stopFileScan()

Stops any searches that were started by DzAssetMgr::scanFiles().

---

void : stopFileSearch()

Stops any searches that were started by DzAssetMgr::searchFiles().

---

void : stopSearchForAssetAddOns()

Stops any searches that were started by DzAssetMgr::searchForAssetAddOns().

---

void : stopSearchForAssets()

Stops any searches that were started by DzAssetMgr::searchForAssets(), DzAssetMgr::searchForAssetsByKeywords() or DzAssetMgr::searchForProductAssets().

---

void : stopSearchForAssetTargets()

Stops any searches that were started by DzAssetMgr::searchForAssetTargets().

---

void : stopSearchForProducts()

Stops any searches that were started by DzAssetMgr::searchForProducts().

---

void : updateCategoryContainers()

Triggers an update to asset containers within the Categories top-level container.

See Also:

• getCategories()

Since:

• 4.8.1.65

---

void : updateContentContainers()

Triggers an update to asset containers within the native formats top-level container.

See Also:

• getContentDirs()

Since:

• 4.8.1.65

---

void : updateFolderBasedContainers()

Triggers an update to asset containers within the folder based top-level containers.

See Also:

• getContentDirs()
• getPoserDirs()
• getImportDirs()

Since:

• 4.8.1.65

---

void : updateImportContainers()

Triggers an update to asset containers within the other import formats top-level container.

See Also:

• getImportDirs()

Since:

• 4.8.1.65

---

void : updatePoserContainers()

Triggers an update to asset containers within the Poser formats top-level container.

See Also:

• getPoserDirs()

Since:

• 4.8.1.65

---

void : updateProductContainers()

Triggers an update to asset containers within the Products top-level container.

See Also:

• getProducts()

---

Boolean : vacuumDatabase()

Reclaims space in the database previously occupied by deleted or updated data.

Return Value:

• true if the operation was successful, otherwise false.

---

void : basePathsChanged()

Signature:“basePathsChanged()”

Emitted when the base paths list has changed.

---

void : categoryUpdate( Array idPath )

Signature:“categoryUpdate(QVariantList)”

Emitted when a category has been changed.

Parameter(s):

• idPath - The list of ids leading to the changed category.

---

void : cmsDSNChanged()

Signature:“cmsDSNChanged()”

Emitted when the Data Source Name (DSN) for the Content Management Service (CMS) has changed.

---

void : cmsStarted()

Signature:“cmsStarted()”

Emitted when the Content Management Service (CMS) has started.

---

void : cmsStopped()

Signature:“cmsStopped()”

Emitted when the Content Management Service (CMS) has stopped.

---

void : compatibilityBaseListChanged()

Signature:“compatibilityBaseListChanged()”

Emitted when the compatibility base list has changed.

---

void : containerUpdate( Array idPath )

Signature:“containerUpdate(QVariantList)”

Emitted when a container has been changed.

Parameter(s):

• idPath - The list of ids leading to the changed container.

---

void : groupNewProductsAsNewChanged()

Signature:“groupNewProductsAsNewChanged()”

Emitted when getGroupNewProductsAsNew() will return a new value.

---

void : itemsPerPageChanged( Number newPerPage )

Signature:“itemsPerPageChanged(int)”

Emitted when itemsPerPage() will return a new value.

Parameter(s):

• newPerPage - The number of items to show per page.

---

void : maxFileSearchResultSizeChanged( Number maxFileSearchResultSize )

Signature:“maxFileSearchResultSizeChanged(int)”

Emitted when the maximum file search result size has changed.

Parameter(s):

• maxFileSearchResultSize - The new maximum.

---

void : productCreated( String guid )

Signature:“productCreated(const QString &)”

Emitted when a product has been created.

Parameter(s):

• guid - The Globally Unique Identifier (GUID) for the created product.

---

void : showAssetToolTipChanged()

Signature:“showAssetToolTipChanged()”

Emitted when showAssetToolTipChanged() will return a new value.

---

void : showExtensionsChanged()

Signature:“showExtensionsChanged()”

Emitted when showExtensions() will return a new value.

---

void : showHiddenVendorCategorizationChanged()

Signature:“showHiddenVendorCategorizationChanged()”

Emitted when getShowHiddenVendorCategorization() will return a new value.

---

void : showLargeIconsChanged()

Signature:“showLargeIconsChanged()”

Emitted when showLargeIcons() will return a new value.

---

void : storeListChanged()

Signature:“storeListChanged()”

Emitted when the store list has changed.

---

void : typeListChanged()

Signature:“typeListChanged()”

Emitted when the type list has changed.

---

void : uiAboutToSearch( QObject sender, String text, Array categories, Array compatibilityBases, Array contentTypes )

Signature:“uiAboutToSearch(int)”

Emitted when the user interface is about to perform a database query.

Parameter(s):

• sender - The UI component that invoked the query.
• text - The search text entered by the user.
• categories - The categories to limit the query to.
• compatibilityBases - The compatibility bases to limit the query to.
• contentTypes - The content types to limit the query to.