ItemListDataProviderFactory

Factory of Item List Data Providers. Creates data providers based on a given type. These functions are available under the `convenienceApi.itemListDataProviderFactory` namespace.

Methods

create(providerType, options) ⇒ Object

Creates an instance of the data provider based on a given type.

Properties Details

create(providerType, options) ⇒ Object

Creates an instance of the data provider based on a given type.

Returns: Object - Instance of the data provider based on ItemListDataProvider.

Param	Type	Description
providerType	String	Type of the data provider to create. Valid values are "object", "choice", or "user"
options	Object	Data provider specific options to be passed to the provider.
options.fieldArtifactId	Number	Artifact ID of the field (if creating an item list from a single or multi object field)
options.fieldName	String	Name of the field (if creating an item list from a single or multi object field)
options.workspaceId	Number	Artifact ID of the workspace.
options.customGetDataFunction	function	Optional. See PickerDataSource object documentation.
options.customGetItemListMetadataFunction	function	Optional. See documentation on customizing the stock data provider.
options.FieldCollection	Array.<Object>	Optional. Used when defining a custom view. Array of ViewField objects.
options.ViewFieldWidthCollection	Array.<Object>	Optional. Used when defining a custom view. Array of ViewField.AvfID: Width (px) key:value pairs.
option.View	Object	Optional. Used to define a custom View object.
options.objectTypeName	String	(only used when providerType = "choice")
options.filterInteractiveColumns	Boolean	(only used when providerType = "object") Whether to filter out interactive columns from the view.
options.objectTypeId	Number	(only used when providerType = "object") Artifact ID of the object type
options.textIdentifierColumnName	String	(only used when providerType = "object") Name of the "Identifier" field for the object type. This defaults to "Name", or "Control Number" (for documents)
options.viewArtifactId	Number	(only used when providerType = "object") Artifact ID of the view to use in the item list
options.textIdentifierColumnName	String	(used when providerType = "object") Name of the "Identifier" field for the object type. This defaults to "Name", or "Control Number" (for documents)
options.loggedInUserId	Number	(only used when providerType = "user") Artifact ID of the logged in user