From 61c5f956c6762bf3b3493c5490485d2db036ec5d Mon Sep 17 00:00:00 2001 From: Jari Koivisto Date: Mon, 10 Aug 2026 14:04:31 +0300 Subject: [PATCH] Update to the UIX reference for August 2026. --- .../Reference/404.html | 8 ++++---- .../Overview/ApplicationStructure/index.html | 8 ++++---- .../Reference/Overview/Commands/index.html | 8 ++++---- .../Reference/Overview/Dashboards/index.html | 8 ++++---- .../Reference/Overview/Debugging/index.html | 8 ++++---- .../Reference/Overview/Events/index.html | 8 ++++---- .../Overview/InstallingApplications/index.html | 8 ++++---- .../Reference/Overview/ListingView/index.html | 8 ++++---- .../Overview/MFilesGlobalObject/index.html | 8 ++++---- .../Reference/Overview/Messages/index.html | 8 ++++---- .../Reference/Overview/Modules/index.html | 8 ++++---- .../Reference/Overview/Tabs/index.html | 8 ++++---- .../Reference/Overview/VaultMessages/index.html | 8 ++++---- .../Reference/Overview/exceptions/index.html | 8 ++++---- .../Reference/Overview/index.html | 8 ++++---- .../Reference/Samples/AssignToMe/index.html | 8 ++++---- .../Reference/Samples/BuiltInCommands/index.html | 8 ++++---- .../Reference/Samples/Commands/index.html | 8 ++++---- .../Reference/Samples/HelloWorld/index.html | 8 ++++---- .../Samples/ObjectOperationSupport/index.html | 8 ++++---- .../PopUpDashboardWithAccentColor/index.html | 8 ++++---- .../Reference/Samples/PopupDashboard/index.html | 8 ++++---- .../Samples/SandboxAttributesSupport/index.html | 8 ++++---- .../Samples/SearchFolderExamples/index.html | 8 ++++---- .../Samples/ShellFrameAndDashboard/index.html | 8 ++++---- .../index.html | 8 ++++---- .../Reference/Samples/TaskbarCommands/index.html | 8 ++++---- .../Reference/Samples/index.html | 8 ++++---- .../UIExt2/Enums/BuiltInIcon/index.html | 8 ++++---- .../UIExt2/Enums/BuiltinCommand/index.html | 8 ++++---- .../UIExt2/Enums/CommandLocation/index.html | 8 ++++---- .../UIExt2/Enums/CommandState/index.html | 8 ++++---- .../Reference/UIExt2/Enums/Event/index.html | 8 ++++---- .../UIExt2/Enums/FacetRangeType/index.html | 8 ++++---- .../UIExt2/Enums/FacetTransformation/index.html | 8 ++++---- .../Reference/UIExt2/Enums/FacetType/index.html | 8 ++++---- .../UIExt2/Enums/FacetValueType/index.html | 8 ++++---- .../UIExt2/Enums/IconContentType/index.html | 8 ++++---- .../UIExt2/Enums/MFBuiltInObjectType/index.html | 8 ++++---- .../UIExt2/Enums/MFBuiltInPropertyDef/index.html | 8 ++++---- .../UIExt2/Enums/MFBuiltInValueList/index.html | 8 ++++---- .../UIExt2/Enums/MFBuiltInView/index.html | 8 ++++---- .../UIExt2/Enums/MenuLocation/index.html | 8 ++++---- .../Enums/ObjectWindowResultCode/index.html | 8 ++++---- .../UIExt2/Enums/SearchEngine/index.html | 8 ++++---- .../Reference/UIExt2/Enums/ToastType/index.html | 8 ++++---- .../Reference/UIExt2/Enums/index.html | 8 ++++---- .../Reference/UIExt2/Events/index.html | 12 ++++++------ .../ICommands/AddCustomCommandToMenu/index.html | 8 ++++---- .../ICommands/CreateCustomCommand/index.html | 8 ++++---- .../ICommands/CreateSubMenuItem/index.html | 8 ++++---- .../ICommands/CreateTaskbarGroup/index.html | 8 ++++---- .../ICommands/DeleteCustomCommand/index.html | 8 ++++---- .../ICommands/ExecuteCommand/index.html | 8 ++++---- .../ICommands/GetCommandName/index.html | 8 ++++---- .../ICommands/GetCommandState/index.html | 8 ++++---- .../GetMenuIdOfBuiltInCommand/index.html | 8 ++++---- .../RemoveCustomCommandFromMenu/index.html | 8 ++++---- .../ICommands/RemoveMenuItem/index.html | 8 ++++---- .../ICommands/RemoveTaskbarGroup/index.html | 8 ++++---- .../ICommands/SetCommandState/index.html | 8 ++++---- .../Interfaces/ICommands/SetIcon/index.html | 8 ++++---- .../ICommands/SetMenuItemState/index.html | 8 ++++---- .../ICommands/SetTaskbarGroupIcon/index.html | 8 ++++---- .../UIExt2/Interfaces/ICommands/index.html | 8 ++++---- .../DeleteFromWebStorage/index.html | 8 ++++---- .../DownloadFileAsDataUri/index.html | 8 ++++---- .../ICommonFunctions/GetAccentColor/index.html | 8 ++++---- .../GetClientLanguage/index.html | 8 ++++---- .../ICommonFunctions/GetClientLocale/index.html | 8 ++++---- .../GetClientLocaleIn3Letters/index.html | 8 ++++---- .../ICommonFunctions/GetSessionInfo/index.html | 8 ++++---- .../ICommonFunctions/GetUTCOffset/index.html | 8 ++++---- .../ICommonFunctions/GetVaultInfo/index.html | 8 ++++---- .../ICommonFunctions/GetWebLink/index.html | 8 ++++---- .../OpenExternalWebLink/index.html | 8 ++++---- .../ReadFromWebStorage/index.html | 8 ++++---- .../ICommonFunctions/ReportException/index.html | 8 ++++---- .../ShowEditObjectWindow/index.html | 8 ++++---- .../ShowNewObjectWindow/index.html | 8 ++++---- .../ICommonFunctions/ShowToast/index.html | 8 ++++---- .../UploadTemporaryFiles/index.html | 8 ++++---- .../WriteToWebStorage/index.html | 8 ++++---- .../Interfaces/ICommonFunctions/index.html | 8 ++++---- .../IDashboard/GetSandboxAttributes/index.html | 8 ++++---- .../Interfaces/IDashboard/ShowMessage/index.html | 8 ++++---- .../IDashboard/ShowPopupDashboard/index.html | 8 ++++---- .../IDashboard/UpdateCustomData/index.html | 8 ++++---- .../IDashboard/WaitForClose/index.html | 8 ++++---- .../UIExt2/Interfaces/IDashboard/index.html | 8 ++++---- .../Interfaces/IEvents/Register/index.html | 8 ++++---- .../IEvents/RegisterBuiltinCommand/index.html | 8 ++++---- .../Interfaces/IEvents/Unregister/index.html | 8 ++++---- .../UIExt2/Interfaces/IEvents/index.html | 8 ++++---- .../Interfaces/ISearchPane/GetOptions/index.html | 8 ++++---- .../ISearchPane/GetSearchCriteria/index.html | 8 ++++---- .../ISearchPane/IsSearchView/index.html | 8 ++++---- .../ISearchPane/SetOptionState/index.html | 8 ++++---- .../ISearchPane/SetSearchCriteria/index.html | 8 ++++---- .../UIExt2/Interfaces/ISearchPane/index.html | 8 ++++---- .../IShellFrame/CallSimplifiedAPI/index.html | 16 ++++++++++++++++ .../IShellFrame/GetSandboxAttributes/index.html | 10 +++++----- .../IShellFrame/GetViewsById/index.html | 10 +++++----- .../IShellFrame/IsFolderLocation/index.html | 10 +++++----- .../IShellFrame/IsObjectLocation/index.html | 10 +++++----- .../IShellFrame/NavigateToFolder/index.html | 10 +++++----- .../IShellFrame/NavigateToObject/index.html | 10 +++++----- .../IShellFrame/NavigateToParent/index.html | 10 +++++----- .../IShellFrame/ShowDashboard/index.html | 10 +++++----- .../IShellFrame/ShowDefaultContent/index.html | 10 +++++----- .../IShellFrame/ShowMessage/index.html | 10 +++++----- .../IShellFrame/ShowPopupDashboard/index.html | 10 +++++----- .../IShellFrame/ShowPopupDashboards/index.html | 10 +++++----- .../UIExt2/Interfaces/IShellFrame/index.html | 10 +++++----- .../IShellItems/GetFoldersCount/index.html | 8 ++++---- .../GetObjectVersionsAndProperties/index.html | 8 ++++---- .../GetObjectVersionsCount/index.html | 8 ++++---- .../UIExt2/Interfaces/IShellItems/index.html | 8 ++++---- .../IShellListing/ActivateListing/index.html | 8 ++++---- .../IShellListing/ActivateSelected/index.html | 8 ++++---- .../IShellListing/AddListingItem/index.html | 8 ++++---- .../IShellListing/AddObjectFile/index.html | 8 ++++---- .../IShellListing/GetFolderName/index.html | 8 ++++---- .../IShellListing/RefreshListing/index.html | 8 ++++---- .../IShellListing/RefreshObject/index.html | 8 ++++---- .../IShellListing/RemoveListingItem/index.html | 8 ++++---- .../IShellListing/ReplaceFile/index.html | 8 ++++---- .../IShellListing/SelectFolder/index.html | 8 ++++---- .../IShellListing/SelectNextFolder/index.html | 8 ++++---- .../IShellListing/SelectNextObject/index.html | 8 ++++---- .../SelectNextObjectFile/index.html | 8 ++++---- .../IShellListing/SelectObjectFile/index.html | 8 ++++---- .../SelectObjectOrObjectFileVersion/index.html | 8 ++++---- .../IShellListing/SelectObjectVersion/index.html | 8 ++++---- .../IShellListing/SelectPrevFolder/index.html | 8 ++++---- .../IShellListing/SelectPrevObject/index.html | 8 ++++---- .../SelectPrevObjectFile/index.html | 8 ++++---- .../index.html | 8 ++++---- .../SetFolderSelectionStates/index.html | 8 ++++---- .../index.html | 8 ++++---- .../SetObjectVersionSelectionStates/index.html | 8 ++++---- .../IShellListing/SetVirtualSelection/index.html | 8 ++++---- .../IShellListing/UnselectAll/index.html | 8 ++++---- .../IShellListing/UpdateListingItem/index.html | 8 ++++---- .../UIExt2/Interfaces/IShellListing/index.html | 8 ++++---- .../IShellPaneContainer/AddTab/index.html | 8 ++++---- .../GetSelectedTabs/index.html | 8 ++++---- .../IShellPaneContainer/GetTab/index.html | 8 ++++---- .../Interfaces/IShellPaneContainer/index.html | 8 ++++---- .../Interfaces/IShellPaneTab/Remove/index.html | 8 ++++---- .../Interfaces/IShellPaneTab/Select/index.html | 8 ++++---- .../IShellPaneTab/SetVisible/index.html | 8 ++++---- .../IShellPaneTab/ShowDashboard/index.html | 8 ++++---- .../IShellPaneTab/ShowEmptyContent/index.html | 8 ++++---- .../Interfaces/IShellPaneTab/Unselect/index.html | 8 ++++---- .../UIExt2/Interfaces/IShellPaneTab/index.html | 8 ++++---- .../IShellUI/BroadcastMessage/index.html | 8 ++++---- .../IShellUI/GetFileTypeIconURL/index.html | 8 ++++---- .../IShellUI/GetObjectTypeIconURL/index.html | 8 ++++---- .../IShellUI/GetValueListItemIconURL/index.html | 8 ++++---- .../IShellUI/NotifyApplication/index.html | 8 ++++---- .../Interfaces/IShellUI/ShowMessage/index.html | 8 ++++---- .../IShellUI/ShowPopupDashboard/index.html | 8 ++++---- .../UIExt2/Interfaces/IShellUI/index.html | 8 ++++---- .../UIExt2/Interfaces/IWindow/Close/index.html | 8 ++++---- .../IWindow/ResizeToDefaultSize/index.html | 8 ++++---- .../IWindow/SetCloseIconVisibility/index.html | 8 ++++---- .../Interfaces/IWindow/SetDefaultSize/index.html | 8 ++++---- .../UIExt2/Interfaces/IWindow/SetSize/index.html | 8 ++++---- .../Interfaces/IWindow/SetTitle/index.html | 8 ++++---- .../UIExt2/Interfaces/IWindow/index.html | 8 ++++---- .../Interfaces/TListingActionArgs/index.html | 10 +++++----- .../Reference/UIExt2/Interfaces/index.html | 8 ++++---- .../UIExt2/Models/DashboardConfig/index.html | 8 ++++---- .../UIExt2/Models/DialogUIParams/index.html | 8 ++++---- .../Reference/UIExt2/Models/Facet/index.html | 8 ++++---- .../UIExt2/Models/FacetDefinition/index.html | 8 ++++---- .../UIExt2/Models/FacetLookupValue/index.html | 8 ++++---- .../Models/FacetNumericRangeValue/index.html | 8 ++++---- .../UIExt2/Models/FacetNumericValue/index.html | 8 ++++---- .../UIExt2/Models/FacetStringValue/index.html | 8 ++++---- .../UIExt2/Models/FacetValue/index.html | 8 ++++---- .../Reference/UIExt2/Models/FtsScope/index.html | 8 ++++---- .../UIExt2/Models/IIconInformation/index.html | 8 ++++---- .../Models/INonSensitiveVaultData/index.html | 8 ++++---- .../UIExt2/Models/ISelectedFile/index.html | 8 ++++---- .../UIExt2/Models/IVaultInfo/index.html | 8 ++++---- .../Models/IVaultInfoReturnValue/index.html | 8 ++++---- .../UIExt2/Models/LookupValue/index.html | 8 ++++---- .../Reference/UIExt2/Models/MFError/index.html | 8 ++++---- .../Models/MultiDashboardUIParams/index.html | 8 ++++---- .../Models/NonSensitiveSessionData/index.html | 8 ++++---- .../UIExt2/Models/NumericRangeValue/index.html | 8 ++++---- .../UIExt2/Models/NumericValue/index.html | 8 ++++---- .../UIExt2/Models/ObjectCreationInfo/index.html | 8 ++++---- .../UIExt2/Models/ObjectFile/index.html | 8 ++++---- .../ObjectFileVersionArgumentValue/index.html | 8 ++++---- .../Models/ObjectFileVersionParams/index.html | 8 ++++---- .../UIExt2/Models/ObjectWindowResult/index.html | 8 ++++---- .../UIExt2/Models/SearchCriteria/index.html | 8 ++++---- .../UIExt2/Models/ShellframeFolders/index.html | 8 ++++---- .../Models/ShowMessageArgumentValue/index.html | 8 ++++---- .../UIExt2/Models/ShowMessageParams/index.html | 8 ++++---- .../Models/ShowMessageReturnValue/index.html | 8 ++++---- .../UIExt2/Models/StringValue/index.html | 8 ++++---- .../Models/VaultInfoReturnValue/index.html | 8 ++++---- .../Reference/UIExt2/Models/index.html | 8 ++++---- .../Reference/UIExt2/index.html | 8 ++++---- .../Upgrading/deprecated_features/index.html | 8 ++++---- .../Reference/assets/js/37ee5f99.3a3af814.js | 1 + .../Reference/assets/js/37ee5f99.fada9eb0.js | 1 - .../Reference/assets/js/4569a837.eb50c391.js | 1 + .../Reference/assets/js/58f68e49.760d8656.js | 1 - .../Reference/assets/js/58f68e49.b632cfd0.js | 1 + ...7feb1174.5c5fdccc.js => 7feb1174.c75d7944.js} | 2 +- .../Reference/assets/js/935f2afb.21c737ca.js | 1 + .../Reference/assets/js/935f2afb.6fcafb26.js | 1 - .../Reference/assets/js/d357bae6.3bfe36f3.js | 1 + .../Reference/assets/js/d357bae6.c284c47c.js | 1 - .../Reference/assets/js/main.53138582.js | 2 ++ ....LICENSE.txt => main.53138582.js.LICENSE.txt} | 0 .../Reference/assets/js/main.ea6d7f5b.js | 2 -- .../Reference/assets/js/runtime~main.4499c87d.js | 1 - .../Reference/assets/js/runtime~main.b56d567f.js | 1 + .../gRPC/Enums/ACLEnforcingMode/index.html | 8 ++++---- .../Enums/AccessControlSubjectType/index.html | 8 ++++---- .../Reference/gRPC/Enums/AuthType/index.html | 8 ++++---- .../gRPC/Enums/AutomaticValueType/index.html | 8 ++++---- .../gRPC/Enums/CallImportance/index.html | 8 ++++---- .../gRPC/Enums/ConditionType/index.html | 8 ++++---- .../Reference/gRPC/Enums/ContentType/index.html | 8 ++++---- .../Reference/gRPC/Enums/DataFunction/index.html | 8 ++++---- .../Reference/gRPC/Enums/Datatype/index.html | 8 ++++---- .../Reference/gRPC/Enums/EventType/index.html | 8 ++++---- .../gRPC/Enums/ExpressionType/index.html | 8 ++++---- .../gRPC/Enums/ExtDBRefreshType/index.html | 8 ++++---- .../Reference/gRPC/Enums/ExtIDStatus/index.html | 8 ++++---- .../Reference/gRPC/Enums/FileIDType/index.html | 8 ++++---- .../gRPC/Enums/FileSizePrecision/index.html | 8 ++++---- .../gRPC/Enums/FileValueType/index.html | 8 ++++---- .../Reference/gRPC/Enums/FileVerType/index.html | 8 ++++---- .../gRPC/Enums/FolderListingAlgorithm/index.html | 8 ++++---- .../Reference/gRPC/Enums/FolderType/index.html | 8 ++++---- .../gRPC/Enums/FormattingType/index.html | 8 ++++---- .../Enums/IndirectPropertyIDLevelType/index.html | 8 ++++---- .../gRPC/Enums/MetadataStructureItem/index.html | 8 ++++---- .../Reference/gRPC/Enums/NACLType/index.html | 8 ++++---- .../gRPC/Enums/NamedValueType/index.html | 8 ++++---- .../gRPC/Enums/ObjFileSourceType/index.html | 8 ++++---- .../gRPC/Enums/ObjVerVersionType/index.html | 8 ++++---- .../index.html | 8 ++++---- .../index.html | 8 ++++---- .../index.html | 8 ++++---- .../gRPC/Enums/ParentChildBehavior/index.html | 8 ++++---- .../Enums/PermissionsExpressionType/index.html | 8 ++++---- .../gRPC/Enums/PropertySetByType/index.html | 8 ++++---- .../Enums/PseudoUserResolutionMode/index.html | 8 ++++---- .../gRPC/Enums/ReferenceDirection/index.html | 8 ++++---- .../gRPC/Enums/RelationshipDirection/index.html | 8 ++++---- .../Reference/gRPC/Enums/SearchMode/index.html | 8 ++++---- .../Reference/gRPC/Enums/StatusType/index.html | 8 ++++---- .../Reference/gRPC/Enums/UpdateType/index.html | 8 ++++---- .../gRPC/Enums/VLSortingType/index.html | 8 ++++---- .../gRPC/Enums/ValidationType/index.html | 8 ++++---- .../Reference/gRPC/Enums/ViewType/index.html | 8 ++++---- .../Reference/gRPC/Enums/index.html | 8 ++++---- .../NamedACLsOperations/GetNamedACLs/index.html | 8 ++++---- .../Interfaces/NamedACLsOperations/index.html | 8 ++++---- .../GetNamedValues/index.html | 8 ++++---- .../RemoveNamedValues/index.html | 8 ++++---- .../SetNamedValues/index.html | 8 ++++---- .../NamedValueStorageOperations/index.html | 8 ++++---- .../ObjectOperations/AddObjectFile/index.html | 8 ++++---- .../AddObjectWithFiles/index.html | 8 ++++---- .../ObjectOperations/ChangeSecurity/index.html | 8 ++++---- .../ObjectOperations/CheckInMultiple/index.html | 8 ++++---- .../ObjectOperations/CheckOutMultiple/index.html | 8 ++++---- .../ObjectOperations/DestroyObjects/index.html | 8 ++++---- .../ObjectOperations/FollowObject/index.html | 8 ++++---- .../GetAutomaticMetadata/index.html | 8 ++++---- .../GetDocEventSubscriptions/index.html | 8 ++++---- .../GetEffectivePermissions/index.html | 8 ++++---- .../GetLatestFileVersion/index.html | 8 ++++---- .../GetLatestObjectVersion/index.html | 8 ++++---- .../ObjectOperations/GetObjIDByGUID/index.html | 8 ++++---- .../GetObjectDataOfMultipleObjects/index.html | 8 ++++---- .../ObjectOperations/GetObjectFiles/index.html | 8 ++++---- .../GetObjectHistory2/index.html | 8 ++++---- .../ObjectOperations/GetTemplates/index.html | 8 ++++---- .../GetWorkflowStateHistory/index.html | 8 ++++---- .../GetWorkflowStates/index.html | 8 ++++---- .../GetWorkflowStatesAndTransitions/index.html | 8 ++++---- .../GetWorkflowsForClient/index.html | 8 ++++---- .../PromoteUnmanagedObject/index.html | 8 ++++---- .../ObjectOperations/RemoveObjectFile/index.html | 8 ++++---- .../ObjectOperations/RemoveObjects/index.html | 8 ++++---- .../ObjectOperations/RenameObjectFile/index.html | 8 ++++---- .../SetObjectLevelProperty/index.html | 8 ++++---- .../SetPropertiesMultiple/index.html | 8 ++++---- .../UndoCheckoutMultiple/index.html | 8 ++++---- .../UploadExistingFiles/index.html | 8 ++++---- .../gRPC/Interfaces/ObjectOperations/index.html | 8 ++++---- .../GetObjectTypes/index.html | 8 ++++---- .../Interfaces/ObjectTypesOperations/index.html | 8 ++++---- .../GetObjectClassesAndGroups/index.html | 8 ++++---- .../GetPropertyDefs/index.html | 8 ++++---- .../Interfaces/PropertyDefsOperations/index.html | 8 ++++---- .../GetFolderContents/index.html | 8 ++++---- .../SearchOperations/SearchObjects/index.html | 8 ++++---- .../gRPC/Interfaces/SearchOperations/index.html | 8 ++++---- .../GetValueListItemsWithPermissions/index.html | 8 ++++---- .../GetValueLists/index.html | 8 ++++---- .../index.html | 8 ++++---- .../Interfaces/ValueListsOperations/index.html | 8 ++++---- .../IsExtensionMethodAvailable/index.html | 8 ++++---- .../RunExtensionMethod/index.html | 8 ++++---- .../VaultExtensionMethodsOperations/index.html | 8 ++++---- .../GetMetadataStructureItemIdByAlias/index.html | 8 ++++---- .../GetMetadataStructureItemIdByGUID/index.html | 8 ++++---- .../gRPC/Interfaces/VaultOperations/index.html | 8 ++++---- .../ViewsOperations/DeleteView/index.html | 8 ++++---- .../ViewsOperations/GetViews/index.html | 8 ++++---- .../gRPC/Interfaces/ViewsOperations/index.html | 8 ++++---- .../Reference/gRPC/Interfaces/index.html | 8 ++++---- .../index.html | 8 ++++---- .../gRPC/Messages/ACTIONFLAGS/index.html | 8 ++++---- .../gRPC/Messages/AccessControlEntry/index.html | 8 ++++---- .../gRPC/Messages/AccessControlList/index.html | 8 ++++---- .../AccessControlListComponent/index.html | 8 ++++---- .../AccessControlListComponentKey/index.html | 8 ++++---- .../index.html | 8 ++++---- .../AccessControlPseudoUserSubject/index.html | 8 ++++---- .../Messages/AccessControlSubject/index.html | 8 ++++---- .../AccessControlSubjectUnion/index.html | 8 ++++---- .../Messages/AssociatedPropertyDef/index.html | 8 ++++---- .../Messages/AutomaticMetadataRequest/index.html | 8 ++++---- .../Messages/AutomaticMetadataResult/index.html | 8 ++++---- .../Messages/AutomaticPermissions/index.html | 8 ++++---- .../Reference/gRPC/Messages/Bytes/index.html | 8 ++++---- .../gRPC/Messages/ClassGroup/index.html | 8 ++++---- .../ClassPermissionsForClient/index.html | 8 ++++---- .../gRPC/Messages/DataFunctionCall/index.html | 8 ++++---- .../DataFunctionUnion/DateData/index.html | 8 ++++---- .../DataFunctionUnion/DaysFromData/index.html | 8 ++++---- .../DataFunctionUnion/DaysToData/index.html | 8 ++++---- .../InitialCharacterGroupData/index.html | 8 ++++---- .../IntegerSegmentData/index.html | 8 ++++---- .../LeftCharactersData/index.html | 8 ++++---- .../DataFunctionUnion/MonthData/index.html | 8 ++++---- .../DataFunctionUnion/NoOpData/index.html | 8 ++++---- .../YearAndMonthData/index.html | 8 ++++---- .../DataFunctionUnion/YearData/index.html | 8 ++++---- .../gRPC/Messages/DataFunctionUnion/index.html | 8 ++++---- .../DefaultReplicationConfiguration/index.html | 8 ++++---- .../gRPC/Messages/DocClassGroup/index.html | 8 ++++---- .../gRPC/Messages/EXPRESSIONEXFLAGS/index.html | 8 ++++---- .../Messages/EffectivePermissions/index.html | 8 ++++---- .../Reference/gRPC/Messages/ErrorInfo/index.html | 8 ++++---- .../gRPC/Messages/EventSubscription/index.html | 8 ++++---- .../gRPC/Messages/Expression/index.html | 8 ++++---- .../ExpressionUnion/AnyFieldData/index.html | 8 ++++---- .../ExpressionUnion/FileValueData/index.html | 8 ++++---- .../ExpressionUnion/IdSegmentData/index.html | 8 ++++---- .../ExpressionUnion/PermissionsData/index.html | 8 ++++---- .../ExpressionUnion/PropertyValueData/index.html | 8 ++++---- .../ExpressionUnion/StatusValueData/index.html | 8 ++++---- .../ExpressionUnion/TypedValueData/index.html | 8 ++++---- .../ExpressionUnion/UninitializedData/index.html | 8 ++++---- .../gRPC/Messages/ExpressionUnion/index.html | 8 ++++---- .../gRPC/Messages/ExtObjectInfo/index.html | 8 ++++---- .../Messages/ExternalRepositoryID/index.html | 8 ++++---- .../gRPC/Messages/ExternalView/index.html | 8 ++++---- .../Messages/FOLDERCAPABILITYFLAGS/index.html | 8 ++++---- .../Reference/gRPC/Messages/FTSFLAGS/index.html | 8 ++++---- .../Reference/gRPC/Messages/File/index.html | 8 ++++---- .../Reference/gRPC/Messages/FileID/index.html | 8 ++++---- .../Reference/gRPC/Messages/FileVer/index.html | 8 ++++---- .../Reference/gRPC/Messages/Folder/index.html | 8 ++++---- .../FolderInfoUnion/AnyFolderData/index.html | 8 ++++---- .../ExternalViewFolderData/index.html | 8 ++++---- .../PropertyFolderData/index.html | 8 ++++---- .../FolderInfoUnion/SearchFolderData/index.html | 8 ++++---- .../TraditionalFolderData/index.html | 8 ++++---- .../FolderInfoUnion/UnknownFolderData/index.html | 8 ++++---- .../FolderInfoUnion/ViewFolderData/index.html | 8 ++++---- .../gRPC/Messages/FolderInfoUnion/index.html | 8 ++++---- .../index.html | 8 ++++---- .../index.html | 8 ++++---- .../index.html | 8 ++++---- .../gRPC/Messages/GroupingLevel/index.html | 8 ++++---- .../Reference/gRPC/Messages/ITEMFLAGS/index.html | 8 ++++---- .../gRPC/Messages/IndirectPropertyID/index.html | 8 ++++---- .../Messages/IndirectPropertyIDLevel/index.html | 8 ++++---- .../IndirectPropertyIDLevelRef/index.html | 8 ++++---- .../gRPC/Messages/IndirectionLevel/index.html | 8 ++++---- .../Reference/gRPC/Messages/ItemID/index.html | 8 ++++---- .../Reference/gRPC/Messages/ItemInfo/index.html | 8 ++++---- .../Reference/gRPC/Messages/Lookup/index.html | 8 ++++---- .../gRPC/Messages/LookupWithMetadata/index.html | 8 ++++---- .../gRPC/Messages/MultiSelectLookup/index.html | 8 ++++---- .../MultiSelectLookupWithMetadata/index.html | 8 ++++---- .../Reference/gRPC/Messages/NamedACL/index.html | 8 ++++---- .../gRPC/Messages/NamedValue/index.html | 8 ++++---- .../Messages/OBJECTCAPABILITYFLAGS/index.html | 8 ++++---- .../Messages/OBJECTDATAREQUESTFLAGS/index.html | 8 ++++---- .../gRPC/Messages/OBJECTFILEFLAGS/index.html | 8 ++++---- .../gRPC/Messages/OBJECTOPFLAGS/index.html | 8 ++++---- .../index.html | 8 ++++---- .../OBJECTVERSIONFILEACTIVITYFLAGS/index.html | 8 ++++---- .../index.html | 8 ++++---- .../gRPC/Messages/OBJTYPEFLAGS/index.html | 8 ++++---- .../gRPC/Messages/OBJVERFLAGS/index.html | 8 ++++---- .../gRPC/Messages/ObjFileSource/index.html | 8 ++++---- .../BlankTemplateData/index.html | 8 ++++---- .../UndefinedSourceData/index.html | 8 ++++---- .../UploadedFileData/index.html | 8 ++++---- .../UploadedFilesData/index.html | 8 ++++---- .../UserDefinedTemplateData/index.html | 8 ++++---- .../gRPC/Messages/ObjFileSourceUnion/index.html | 8 ++++---- .../gRPC/Messages/ObjFileVer/index.html | 8 ++++---- .../Reference/gRPC/Messages/ObjID/index.html | 8 ++++---- .../Reference/gRPC/Messages/ObjVer/index.html | 8 ++++---- .../gRPC/Messages/ObjVerVersion/index.html | 8 ++++---- .../Messages/ObjVerWithProperties/index.html | 8 ++++---- .../gRPC/Messages/ObjectClass/index.html | 8 ++++---- .../gRPC/Messages/ObjectLevelInfo/index.html | 8 ++++---- .../ObjectPermissionsForClient/index.html | 8 ++++---- .../ObjectTypeIndexingDefinition/index.html | 8 ++++---- .../ObjectTypePermissionsForClient/index.html | 8 ++++---- .../ObjectTypeSearchCharacteristics/index.html | 8 ++++---- .../ObjectTypeTargetForBrowsing/index.html | 8 ++++---- .../gRPC/Messages/ObjectVersion/index.html | 8 ++++---- .../Messages/ObjectVersionActivity/index.html | 8 ++++---- .../ObjectVersionActivityRequest/index.html | 8 ++++---- .../ObjectVersionActivityResponse/index.html | 8 ++++---- .../index.html | 8 ++++---- .../gRPC/Messages/ObjectVersionData/index.html | 8 ++++---- .../Messages/ObjectVersionDataRequest/index.html | 8 ++++---- .../Messages/ObjectVersionDataResult/index.html | 8 ++++---- .../gRPC/Messages/ObjectVersionEx/index.html | 8 ++++---- .../gRPC/Messages/ObjectVersionExWP/index.html | 8 ++++---- .../ObjectVersionFileActivity/index.html | 8 ++++---- .../ObjectVersionPropertyActivity/index.html | 8 ++++---- .../gRPC/Messages/PROPERTYDEFFLAGS/index.html | 8 ++++---- .../gRPC/Messages/PropertyDef/index.html | 8 ++++---- .../PropertyDefPermissionsForClient/index.html | 8 ++++---- .../gRPC/Messages/PropertyValue/index.html | 8 ++++---- .../gRPC/Messages/PropertyValueArray/index.html | 8 ++++---- .../Messages/PropertyValueSuggestion/index.html | 8 ++++---- .../PropertyValueWithMetadata/index.html | 8 ++++---- .../PropertyValueWithMetadataArray/index.html | 8 ++++---- .../gRPC/Messages/RelationshipData/index.html | 8 ++++---- .../gRPC/Messages/RelationshipGroup/index.html | 8 ++++---- .../gRPC/Messages/SEARCHSTATUSFLAGS/index.html | 8 ++++---- .../gRPC/Messages/SRPREQUESTFLAGS/index.html | 8 ++++---- .../gRPC/Messages/STATEFLAGS/index.html | 8 ++++---- .../gRPC/Messages/SearchCondition/index.html | 8 ++++---- .../Messages/SearchConditionArray/index.html | 8 ++++---- .../Reference/gRPC/Messages/SearchDef/index.html | 8 ++++---- .../gRPC/Messages/SearchFlags/index.html | 8 ++++---- .../gRPC/Messages/SearchOutputInfo/index.html | 8 ++++---- .../gRPC/Messages/SearchResultsItem/index.html | 8 ++++---- .../Messages/SearchResultsPageRequest/index.html | 8 ++++---- .../Messages/SearchResultsSorting/index.html | 8 ++++---- .../gRPC/Messages/SearchTarget/index.html | 8 ++++---- .../Messages/ServerVaultCapabilities/index.html | 8 ++++---- .../gRPC/Messages/SessionInfo/index.html | 8 ++++---- .../gRPC/Messages/SetPropertiesParams/index.html | 8 ++++---- .../Reference/gRPC/Messages/SortFlags/index.html | 8 ++++---- .../Reference/gRPC/Messages/SortRule/index.html | 8 ++++---- .../gRPC/Messages/SortRuleFlags/index.html | 8 ++++---- .../gRPC/Messages/SortRuleValueArray/index.html | 8 ++++---- .../gRPC/Messages/StateBasic/index.html | 8 ++++---- .../Messages/StateTransitionBasic/index.html | 8 ++++---- .../gRPC/Messages/SubviewGroup/index.html | 8 ++++---- .../Reference/gRPC/Messages/Template/index.html | 8 ++++---- .../gRPC/Messages/TypedValue/index.html | 8 ++++---- .../gRPC/Messages/TypedValueMetadata/index.html | 8 ++++---- .../gRPC/Messages/TypedValueUnion/index.html | 8 ++++---- .../TypedValueUnionWithMetadata/index.html | 8 ++++---- .../Messages/TypedValueWithMetadata/index.html | 8 ++++---- .../gRPC/Messages/UploadedFile/index.html | 8 ++++---- .../gRPC/Messages/UploadedFileArray/index.html | 8 ++++---- .../Reference/gRPC/Messages/VIEWFLAGS/index.html | 8 ++++---- .../Reference/gRPC/Messages/ValueList/index.html | 8 ++++---- .../gRPC/Messages/ValueListItem/index.html | 8 ++++---- .../gRPC/Messages/VersionComment/index.html | 8 ++++---- .../gRPC/Messages/VersionCommentArray/index.html | 8 ++++---- .../Reference/gRPC/Messages/View/index.html | 8 ++++---- .../gRPC/Messages/ViewLocation/index.html | 8 ++++---- .../gRPC/Messages/ViewVisualization/index.html | 8 ++++---- .../Reference/gRPC/Messages/Workflow/index.html | 8 ++++---- .../gRPC/Messages/WorkflowBasic/index.html | 8 ++++---- .../Reference/gRPC/Messages/index.html | 8 ++++---- .../Reference/gRPC/index.html | 8 ++++---- .../Reference/index.html | 8 ++++---- .../Reference/samples/ErrorHandling/index.html | 8 ++++---- .../samples/VaultMessagesPackage/index.html | 8 ++++---- .../search-index-docs-default-current.json | 2 +- .../Reference/sitemap.xml | 2 +- .../Reference/upgrading/index.html | 8 ++++---- 501 files changed, 1975 insertions(+), 1958 deletions(-) create mode 100644 Frameworks/User-Interface-Extensibility-Framework/Reference/UIExt2/Interfaces/IShellFrame/CallSimplifiedAPI/index.html create mode 100644 Frameworks/User-Interface-Extensibility-Framework/Reference/assets/js/37ee5f99.3a3af814.js delete mode 100644 Frameworks/User-Interface-Extensibility-Framework/Reference/assets/js/37ee5f99.fada9eb0.js create mode 100644 Frameworks/User-Interface-Extensibility-Framework/Reference/assets/js/4569a837.eb50c391.js delete mode 100644 Frameworks/User-Interface-Extensibility-Framework/Reference/assets/js/58f68e49.760d8656.js create mode 100644 Frameworks/User-Interface-Extensibility-Framework/Reference/assets/js/58f68e49.b632cfd0.js rename Frameworks/User-Interface-Extensibility-Framework/Reference/assets/js/{7feb1174.5c5fdccc.js => 7feb1174.c75d7944.js} (89%) create mode 100644 Frameworks/User-Interface-Extensibility-Framework/Reference/assets/js/935f2afb.21c737ca.js delete mode 100644 Frameworks/User-Interface-Extensibility-Framework/Reference/assets/js/935f2afb.6fcafb26.js create mode 100644 Frameworks/User-Interface-Extensibility-Framework/Reference/assets/js/d357bae6.3bfe36f3.js delete mode 100644 Frameworks/User-Interface-Extensibility-Framework/Reference/assets/js/d357bae6.c284c47c.js create mode 100644 Frameworks/User-Interface-Extensibility-Framework/Reference/assets/js/main.53138582.js rename Frameworks/User-Interface-Extensibility-Framework/Reference/assets/js/{main.ea6d7f5b.js.LICENSE.txt => main.53138582.js.LICENSE.txt} (100%) delete mode 100644 Frameworks/User-Interface-Extensibility-Framework/Reference/assets/js/main.ea6d7f5b.js delete mode 100644 Frameworks/User-Interface-Extensibility-Framework/Reference/assets/js/runtime~main.4499c87d.js create mode 100644 Frameworks/User-Interface-Extensibility-Framework/Reference/assets/js/runtime~main.b56d567f.js diff --git a/Frameworks/User-Interface-Extensibility-Framework/Reference/404.html b/Frameworks/User-Interface-Extensibility-Framework/Reference/404.html index 3c6f06217..70bd15993 100644 --- a/Frameworks/User-Interface-Extensibility-Framework/Reference/404.html +++ b/Frameworks/User-Interface-Extensibility-Framework/Reference/404.html @@ -4,13 +4,13 @@ Page Not Found | M-Files User Interface Extensibility Framework - - + +
Skip to main content

Page Not Found

We could not find what you were looking for.

Please contact the owner of the site that linked you to the original URL and let them know their link is broken.

- - + + \ No newline at end of file diff --git a/Frameworks/User-Interface-Extensibility-Framework/Reference/Overview/ApplicationStructure/index.html b/Frameworks/User-Interface-Extensibility-Framework/Reference/Overview/ApplicationStructure/index.html index 2613b59fe..09cf6b66d 100644 --- a/Frameworks/User-Interface-Extensibility-Framework/Reference/Overview/ApplicationStructure/index.html +++ b/Frameworks/User-Interface-Extensibility-Framework/Reference/Overview/ApplicationStructure/index.html @@ -4,14 +4,14 @@ Application Structure | M-Files User Interface Extensibility Framework - - + +
Skip to main content

Application Structure

Each UI Extension Application is a JavaScript application that extends the core functionality of the associated M-Files client. Each application can use the UI Extension API to interact with other areas of the UI, and the Vault API to interact with the vault structure and contents.

Application Package​

The "Application Package" is a .zip file, e.g. Application.zip, which contains the Application Manifest appdef.xml, at least one module file, and all other associated resources such as HTML, CSS, images, or other files needed for the application to run.

Application.zip
├── appdef.xml
├── main.js
├── dashboard.html
└── public
    ├── logo.png
    ├── styles.css
    └── dashboard.js

note

Application Packages typically have a .mfappx extension when distributed to differentiate them from the normal .zip files.

Application Manifest​

The application manifest file - appdef.xml defines common attributes such as the application GUID, its name and version and also ties together the other files which are needed to make the application run. Each application manifest must refer to at least one module, and often also refer to one or more dashboards.

appdef.xml
<?xml version="1.0"?>
<application xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
  xsi:noNamespaceSchemaLocation="http://www.m-files.com/schemas/appdef-client-v5.xsd">
    <guid>5EA29AF2-1EC9-4AB7-A0D1-FE1D586310D4</guid>
    <name>Name of Application Extension</name>
    <version>0.1</version>
    <description>Description of the App</description>
    <publisher>ACME Corporation</publisher>
    <enabled-by-default>true</enabled-by-default>
    <modules>
        <module environment="shellui">
            <file>main.js</file>
        </module>
    </modules>
</application>

Modules​

The modules define the entrypoint(s) for your application. These are defined by the <module /> element(s) in the application manifest. Each module must specify at least one JavaScript file (<file />) which defines the OnNewShellUI function which will be called when the application starts.

You can learn more about modules from the modules page.

    <!-- inside appdef.xml -->
    <modules>
        <module environment="shellui">
            <file>main.js</file>
        </module>
    </modules>

Dashboards​

Dashboards are HTML pages that are shown within either a custom tab or within a popup dialog. These dashboards are not shown by default, but must be referenced by their dashboard id from within your code.

note

For a complete example see Sample for Popup Dashboard

Each dashboard has a Dashboard id defined in XML like <dashboard id="MySample">. The file that contains the HTML content is defined in the <content> element:

    <dashboards>
        <dashboard id="MySample">
            <content>index.html</content>
        </dashboard>
    </dashboards>

The dashboard id is used by the UI Extensions to open the Dashboard, for example when using ShowPopupDashboard method.

// opens Dashboard with id "MySample"
shellFrame.ShowPopupDashboard('MySample', {})

M-Files Extensibility Protocol Library in Dashboard HTML File​

The HTML file (e.g. index.html, which is mentioned in the application manifest) loads the resources required to show the content of the dashboard. Here, we should include a special script resource called mfiles.extensibility.protocol.js. The actual content of the M-Files Extensibility Protocol library is served from M-Files Server when it loads Dashboard, which ensures that the content is aligned with M-Files Server.

The M-Files Extensibility Protocol library acts as a layer between your application and the M-Files UIX application framework.

dashboard.html
<!doctype html>
<html lang="en">
  <head>
    <title>Sample</title>
    
    <!-- Load M-Files Extensibility Framework library file -->
    <script src="mfiles.extensibility.protocol.js"></script>

    <!-- Load styles and dashboard handler js file -->
    <link href="style.css" rel="stylesheet" />
    <script src="dashboard.js"></script>
  </head>
  <body>
    <div id="content"></div>
  </body>
</html>

Additional Resources​

The Application Package can include images, CSS files or other resources needed by the UI Extension. These may include images, CSS files, or other such supporting content. These files are not referenced within the application manifest, but instead referenced from the dashboard where they are needed:

dashboard.html
<!doctype html>
<html lang="en">
  <head>
    <title>Sample</title>

    <!-- Load M-Files Extensibility Framework library file -->
    <script src="mfiles.extensibility.protocol.js"></script>

    <!--
            Load styles and dashboard handler js file.  These are expected to be in the same directory as the dashboard file
        -->
    <link href="style.css" rel="stylesheet" />
    <script src="dashboard.js"></script>
  </head>
</html>
- - + + \ No newline at end of file diff --git a/Frameworks/User-Interface-Extensibility-Framework/Reference/Overview/Commands/index.html b/Frameworks/User-Interface-Extensibility-Framework/Reference/Overview/Commands/index.html index 2ac555305..56f1d88cf 100644 --- a/Frameworks/User-Interface-Extensibility-Framework/Reference/Overview/Commands/index.html +++ b/Frameworks/User-Interface-Extensibility-Framework/Reference/Overview/Commands/index.html @@ -4,13 +4,13 @@ Using Custom Commands | M-Files User Interface Extensibility Framework - - + +
Skip to main content

Using Custom Commands

The Custom Commands interface provides a set of commands for customizing menus, creating custom commands, and managing their states in M-Files UI Extensions. The ICommands provides set of tools for developers to customize the user interface, manage commands, and control their visibility and availability within the application.

Managing Commands​

note

ICommands is part of IShellFrame interface. To use this interface you have to first obtain instance of the IShellFrame.

Creating a Custom Command​

The commands created by the ICommands interface are usually so called Custom Commands which are available only for your UI Extension application.

// Create a new custom command using IShellFrame instance.
const commandId = await shellFrame.Commands.CreateCustomCommand(name);

Controlling the Command visibility​

Creating a command does not automatically add the command to the user interface. To do that the SetCommandState method must be used. This method defines the command state (hidden/visible) in specific parts of the user interface:

shellFrame.Commands.SetCommandState( 
    commandId, // The ID of the command which state is to be changed
    MFiles.CommandLocation.MainMenu, // The location in the UI where the command's state is being changed
    MFiles.CommandState.CommandState_Hidden  // New state of the command in specific location
);

Executing the Command manually​

The Custom command can executed directly using ExecuteCommand, which accepts also optional data parameter.

The data must be serializable using Structured Cloning Algorithm.

// Execute a new custom command with data parameter
await shellFrame.Commands.ExecuteCommand(commandId, {
    someCustomData: 1234
});

Listening and Responding to Custom Commands​

User can listen to custom command events using MFiles.Event.CustomCommand, which has a callback having parameters (commandId, data).

tip

It is generally recommended to have a single listener function for custom commands to avoid responding to the same command multiple times.


// Listen for the custom commands.
shellFrame.Commands.Events.Register(

    // Listen for the CustomCommand events.
    MFiles.Event.CustomCommand,

    // Each command has ID and optional data provided with it.
    ( commandId, data ) => {
    }
);

Command locations​

tip

The commands sample includes practical examples of code that adds commands to different locations.

Commands can be shown in two primary locations: within the context menu (shown when the user right-clicks on something in a listing), and within the main menu.

The context menu​

Commands can be added to the context menu which is shown when a user right-clicks on something in a listing. The command may be shown similarly to this:

The command shown in the context menu

// This code should be placed to run when the shell frame is started.

// Create the command.
const commandOneId = await shellFrame.Commands.CreateCustomCommand
(
    "My First Command"
);

// Add the command to the bottom of the context menu.
await shellFrame.Commands.AddCustomCommandToMenu
(
    commandOneId,
    MFiles.MenuLocation.MenuLocation_ContextMenu_Bottom, // Note: context menu
    1
);

// Show a message when the command is clicked.
shellFrame.Commands.Events.Register(
    MFiles.Event.CustomCommand,
    async ( commandId ) => {

        // If something other than our command was clicked then die.
        if(commandId !== commandOneId)
            return;
            
        // Our context menu command was clicked.
        await shellFrame.ShowMessage( "My context menu command was clicked." );
    }
);

The main menu​

tip

The commands sample includes practical examples of code that adds commands to different locations.

Commands can be added to the "main menu", which is located at the top-right of the user interface, as a three-dot icon. Clicking this icon expands the menu and shows commands added to the menu.

note

The main menu is not shown until one or more UI Extensions add commands to this location.

// This code should be placed to run when the shell frame is started.

// Create the command.
const commandOneId = await shellFrame.Commands.CreateCustomCommand
(
    "My First Command"
);

// Add the command to the main menu.
await shellFrame.Commands.AddCustomCommandToMenu
(
    commandOneId,
    MFiles.MenuLocation.MenuLocation_TopPaneMenu, // Note: top pane menu
    1
);

// Show a message when the command is clicked.
shellFrame.Commands.Events.Register(
    MFiles.Event.CustomCommand,
    async ( commandId ) => {

        // If something other than our command was clicked then die.
        if(commandId !== commandOneId)
            return;
            
        // Our context menu command was clicked.
        await shellFrame.ShowMessage( "My top menu command was clicked." );
    }
);

Child commands​

The main menu supports commands with sub-menu commands. This functionality allows you to group commands logically by function within your application:

A main menu command with sub-menu commands

To do this, create the parent command and then call CreateSubMenuItem to create child commands:

// This code should be placed to run when the shell frame is started.

// Create the parent command.
const commandOneId = await shellFrame.Commands.CreateCustomCommand
(
    "My First Command"
);

// Add the parent command to the main menu.
const parentMenuItemId  = await shellFrame.Commands.AddCustomCommandToMenu
(
    commandOneId,
    MFiles.MenuLocation.MenuLocation_TopPaneMenu, // Note: top pane menu
    1
);

 // Create child commands (buttons).
const commandChildOneId = await shellFrame.Commands.CreateCustomCommand
(
    "My First Child Command"
);
const commandChildTwoId = await shellFrame.Commands.CreateCustomCommand
(
    "My Second Child Command"
);

// Add the child commands to the parent.
await shellFrame.Commands.CreateSubMenuItem( parentMenuItemId, commandChildOneId, 1 );
await shellFrame.Commands.CreateSubMenuItem( parentMenuItemId, commandChildTwoId, 1 );


// Show a message when the command is clicked.
shellFrame.Commands.Events.Register(
    MFiles.Event.CustomCommand,
    async ( commandId ) => {

        // Only react when the child commands are clicked.
        if(commandId !== commandChildOneId && commandId !== commandChildTwoId)
            return;
            
        // One of the two child commands was clicked.
        await shellFrame.ShowMessage( "One of the child commands was clicked!" );
    }
);
note

Context menus do not currently support child commands.

Icons​

Commands support icons in all menu locations.

A main menu command with sub-menu commands

Adding an icon for command can be done using SetIcon method with IIconInformation configuration.

Example of setting an icon from a relative path for a custom command.​

First, create a custom command ID. Next, add the necessary information to the icon information object to set the actual icon. Finally, add the command to any menu location. All current menu locations are supported, and the added icon will appear on the left side of the menu item.

// This code should be placed to run when the shell frame is started.

// Create custom command ID.
const customCommand = await shellFrame.Commands.CreateCustomCommand("Custom command");

// Create icon information.
const iconIdInformation = { 
    content: "assets/icons/customCommandIcon.svg", 
    iconContentType: "PATH",
    alt: "Custom command icon alt",
    extension: "svg" 
};

// Set icon for created command ID.
await shellFrame.Commands.SetIcon(commandCheckoutId, iconIdInformation);

// Add command to the taskbar menu location.
await shellFrame.Commands.AddCustomCommandToMenu(commandCheckoutId, MFiles.MenuLocation.MenuLocation_TaskBar_MainActions, 1);

IIconInformation configuration examples for other content types.​

SVG string icon:​

// Icon in SVG string format.
const svgStringIcon = "<svg width='16' height='16' viewBox='0 0 16 16' fill='none' xmlns='http://www.w3.org/2000/svg'><rect x='1' y='14' width='14' height='1' rx='0.5' fill='#363A40'/><circle cx='3' cy='7' r='1.5' stroke='#363A40'/><path d='M5 8L6.5 10.5' stroke='#363A40'/><circle cx='8' cy='11' r='1.5' stroke='#363A40'/><circle cx='13' cy='3' r='1.5' stroke='#363A40'/><path d='M12.5 4L9 9.5' stroke='#363A40'/></svg>";

// Create iconInformation object.
const iconIdInformation = { 
    content: svgStringIcon, 
    iconContentType: "SVG",
    alt: "Custom command SVG string icon alt",
    extension: "svg" 
};

Base64 string:​

// Icon in base64 string format.
const base64StringIcon = "PHN2ZyB3aWR0aD0iMTYiIGhlaWdodD0iMTYiIHZpZXdCb3g9IjAgMCAxNiAxNiIgZmlsbD0ibm9uZSIgeG1sbnM9Imh0dHA6Ly93d3cudzMub3JnLzIwMDAvc3ZnIj4KPHJlY3QgeD0iMSIgeT0iMTQiIHdpZHRoPSIxNCIgaGVpZ2h0PSIxIiByeD0iMC41IiBmaWxsPSIjMzYzQTQwIi8+CjxjaXJjbGUgY3g9IjMiIGN5PSI3IiByPSIxLjUiIHN0cm9rZT0iIzM2M0E0MCIvPgo8cGF0aCBkPSJNNSA4TDYuNSAxMC41IiBzdHJva2U9IiMzNjNBNDAiLz4KPGNpcmNsZSBjeD0iOCIgY3k9IjExIiByPSIxLjUiIHN0cm9rZT0iIzM2M0E0MCIvPgo8Y2lyY2xlIGN4PSIxMyIgY3k9IjMiIHI9IjEuNSIgc3Ryb2tlPSIjMzYzQTQwIi8+CjxwYXRoIGQ9Ik0xMi41IDRMOSA5LjUiIHN0cm9rZT0iIzM2M0E0MCIvPgo8L3N2Zz4K";

// Create iconInformation object.
const iconIdInformation = { 
    content: base64StringIcon, 
    iconContentType: "BASE64",
    alt: "Custom command SVG base64 string icon alt",
    extension: "svg"
};

Note: With Base64 string, extension information must be provided in order to handle icon information correctly.

Using built-in icons:​

It is possible to use built-in icons for commands. See available built-in icon IDs from the BuiltInIcon enumeration in the IIconInformation interface.

    // Create iconInformation object for builtin Checkout icon.
    const iconIdInformation = { 
        content: 0,
        iconContentType: "BUILT_IN", 
        alt: `built-in icon alt`, 
        extension: "" 
    };
- - + + \ No newline at end of file diff --git a/Frameworks/User-Interface-Extensibility-Framework/Reference/Overview/Dashboards/index.html b/Frameworks/User-Interface-Extensibility-Framework/Reference/Overview/Dashboards/index.html index e551187db..ba76ea213 100644 --- a/Frameworks/User-Interface-Extensibility-Framework/Reference/Overview/Dashboards/index.html +++ b/Frameworks/User-Interface-Extensibility-Framework/Reference/Overview/Dashboards/index.html @@ -4,15 +4,15 @@ Dashboards | M-Files User Interface Extensibility Framework - - + +
Skip to main content

Dashboards

Dashboards are custom HTML pages defined by the application and can reference typical web content such as JavaScript and CSS files. These custom HTML pages may be shown all the time in a custom tab, shown in a tab which is shown or hidden depending upon user interaction, or shown via code as a custom popup dialog. Each dashboard, when shown, is rendered within an <iframe /> element.

Dashboards must be defined within the application manifest and given a unique ID. In the example below the ID of the dashboard is defined to be my-dashboard, and the HTML for the dashboard is contained within index.html:

    <dashboards>
        <dashboard id="my-dashboard">
            <content>index.html</content>
        </dashboard>
    </dashboards>
note

Dashboard files are standard HTML files which will be rendered by the browser.

Bootstrapping the dashboard​

The dashboard HTML file (e.g. index.html; the actual file name can be any valid filename) typically must contain code that reacts when the dashboard is shown, to gather data to render from either the supplied parameters (CustomData), or from elsewhere in the UI or vault.

When the dashboard is shown and ready to use, the framework will automatically locate and execute a function called OnNewDashboard. There must be only one function in the dashboard called this, but the function can be held within the HTML file directly or within a referenced JavaScript file. This method will be passed a single argument - named below as newDashboard - which is of type IDashboard:

// Dashboard bootstrap function
function OnNewDashboard(newDashboard) {
  // TODO: React when the dashboard is shown.
}

Bootstrapping the Dashboard in React Application​

In a React + TypeScript application you can bootstrap the dashboard using following pattern.

(window as any).OnNewDashboard = (newDashboard: IDashboard) => {
    ReactDOM.createRoot(document.getElementById("root")!).render(
        <React.StrictMode>
            <App dashboard={newDashboard} />
        </React.StrictMode>
    );
};

Showing a dashboard from within your application​

Simply declaring a dashboard does not show it within the user interface. Instead: the dashboard must be rendered either by creating a new tab and rendering it within that tab, or by showing the dashboard within a popup dialog.

Open a new dashboard using the tab​

Opening a new tab requires a dashboard ID, which is defined in you Application Manifest -file. This will create a new instance of dashboard which lives inside IFRAME as long as the Tab is finally removed.

note

Opening too many tabs can affect your application performance.

Open a popup dashboard​

Opening the popup dashboard is done using the ShowPopupDashboard method, which accepts also third parameter, which is the title of the Dialog.

shellFrame.ShowPopupDashboard(
  'my-dashboard',
  {
    message: 'Some Custom Data Here',
  },
  'Dashboard Title',
)

Passing data to and from dashboards​

Passing Custom data to the dashboard​

The dashboard can also be passed a custom data, which is visible in the dashboards CustomData property.

myTab.ShowDashboard('my-dashboard', {
  msg: 'Sample message to the dashboard',
})
myTab.Select()

The dashboard which was opened using ShowDashboard can retrieve the data from CustomData property.

// Dashboard bootstrap function
function OnNewDashboard(newDashboard) {
  const data = newDashboard.CustomData // has the data which is passed in ShowDashboard second param
}
tip

The Custom Data can include only data which can be serialized using the Structured Cloning Algorithm. This means that you can not pass callback functions inside that data to send responses from the new dashboard back to the opener. However, you can send custom command ID values and custom commands can be given a data parameter.

Passing updated data to the dashboard​

It is also possible to pass updated data to the dashboard using the IDashboard.UpdateCustomData method. There is a detailed example of how to do this on the UpdateCustomData method page:

// Create the tab and show some default custom data.
const myTab = await shellFrame.RightPane.AddTab("my-test-tab", "My dashboard", "_last");
const myDashboard = await myTab.ShowDashboard("mydb", 
{
    timeNow: "INITIAL_DATA, 5 second refresh interval!"
});

// Every 5 seconds call the UpdateCustomData method.
setInterval( () => {
    myDashboard.UpdateCustomData({
        timeNow: ( new Date() ).toISOString() // Pass the current time.
    })
}, 5000)

Passing Custom data from the dashboard to the opener​

You can create a custom command which is used to send data back to the opener. As the command is not added to any menu structure it is not visible, but can be executed from code.

From the opener:

const callbackCommandId = await shellFrame.Commands.CreateCustomCommand(name)

// Listen for the custom commands.
shellFrame.Commands.Events.Register(
  // Listen for the CustomCommand events.
  MFiles.Event.CustomCommand,

  // Each command has ID and optional data provided with it.
  (commandId, data) => {
    // Short-circuit if this is called for a command we don't care about.
    if (commandId !== callbackCommandId) return

    // Show something from the data.
    alert('The name is: ' + data.name)
  },
)

myTab.ShowDashboard('my-dashboard', {
  callbackId: callbackCommandId,
})
myTab.Select()

From the dashboard we can then return data back to the caller using ExecuteCommand

// Dashboard bootstrap function
function OnNewDashboard( newDashboard ) {

    // Get the command ID
    const commandId = newDashboard.CustomData.callbackId;

    // Send data back to the caller, in this case object { name: "ExampleObject" }
    await shellFrame.Commands.ExecuteCommand(commandId, {
        name: "Example Object"
    });

}

Closing the dashboard​

You can close the dashboard using the associated Window object which has Close method

newDashboard.Window.Close()
- - + + \ No newline at end of file diff --git a/Frameworks/User-Interface-Extensibility-Framework/Reference/Overview/Debugging/index.html b/Frameworks/User-Interface-Extensibility-Framework/Reference/Overview/Debugging/index.html index 1cb337c9a..bfe09f601 100644 --- a/Frameworks/User-Interface-Extensibility-Framework/Reference/Overview/Debugging/index.html +++ b/Frameworks/User-Interface-Extensibility-Framework/Reference/Overview/Debugging/index.html @@ -4,15 +4,15 @@ Testing and Developing | M-Files User Interface Extensibility Framework - - + +
Skip to main content

Testing and Developing

Runtime Environment​

The runtime environment of the UI Extension is inside sandboxed <iframe /> and communication between the M-Files Client and UI Extension is done internally using postMessage where the calls are serialized using Structured Clone algorithm.

When a call to an UI Extension Object is done, for example 

const commandId = await shellFrame.Commands.CreateCustomCommand(name);

The call is serialized into a postMessage message using MESP protocol (M-Files Extension Sandbox Protocol). It is possible to enable logging of the postMessage calls if you want to observe exactly what is going on during execution of specific command.

The global variables, like Enumerations are bound into MFiles variable only after the initialization message.

tip

For a complete reference of the MFiles global object and all its namespaces, see the MFiles Global Object documentation.

The MFiles Global Object​

The MFiles global variable is your primary interface for accessing enumerations and utility functions. It includes:

NamespaceDescriptionExample
MFiles.EventEvent type constantsMFiles.Event.Started, MFiles.Event.NewShellFrame
MFiles.MenuLocationMenu location constantsMFiles.MenuLocation.MenuLocation_TopPaneMenu
MFiles.CommandStateCommand state constantsMFiles.CommandState.CommandState_Active
MFiles.CommandLocationCommand location constantsMFiles.CommandLocation.MainMenu
MFiles.BuiltinCommandBuilt-in command IDsMFiles.BuiltinCommand.NewObject
MFiles.VaultEnumsVault/gRPC API enumerationsMFiles.VaultEnums.ConditionType.CONDITION_TYPE_EQUAL
MFiles.*ICommonFunctions methodsMFiles.GetAccentColor(), MFiles.ShowMessage()

See: MFiles Global Object Reference

Debugging from Developer Tools​

From the browser developer tools you can select the IFRAME and observe the global variables installed there.

You can inspect the MFiles object to see all available enumerations and methods:

// In browser console, inspect the MFiles object
console.log(MFiles);

// List all available Event types
console.log(Object.keys(MFiles.Event));

// List all available VaultEnums
console.log(Object.keys(MFiles.VaultEnums));

Calling ICommonFunctions​

MFiles global variable includes enumerations and also the ICommonFunctions properties and methods.


// Call ICommonFunctions.GetAccentColor()
await MFiles.GetAccentColor() // returns "#006eef"

// Save a key into webstorage
await MFiles.WriteToWebStorage("key", "value")

// Read from webstorage
const value = await MFiles.ReadFromWebStorage("key")

Accessing the Dashboard object​

In the dashboard code you can access the Dashboard object using _MESP global variable.


// retrieve the active dashboard object inside a dashboard IFRAME
const dashboard = _MESP.ApplicationObjects.Dashboard;

// Create a popup dashboard with ID "my-dashboard"
await dashboard.ShellFrame.ShowPopupDashboard("my-dashboard", {});

Enable postMessage logging​

If you want to enable logging of the postMessage commands into the Developer Tools console you can turn that on inside the UI Extension application using

// Enable logging of postMessage calls into console
window._MESP.logLevel = "all";
- - + + \ No newline at end of file diff --git a/Frameworks/User-Interface-Extensibility-Framework/Reference/Overview/Events/index.html b/Frameworks/User-Interface-Extensibility-Framework/Reference/Overview/Events/index.html index 24473b630..d80990be2 100644 --- a/Frameworks/User-Interface-Extensibility-Framework/Reference/Overview/Events/index.html +++ b/Frameworks/User-Interface-Extensibility-Framework/Reference/Overview/Events/index.html @@ -4,15 +4,15 @@ Events | M-Files User Interface Extensibility Framework - - + +
Skip to main content

Events

The UI Extension Application has different kinds of event handlers:

  1. Module or Dashboard Startup handlers. These functions are called once when the module or dashboard starts and are considered entry points to your application.
  2. Interface events which are are specific to the UI Extension API Interfaces. For example: you can react to an event which is fired whenever the user selects an object in a listing.
  3. Custom Command events. These are raised when a custom command - such as a context-menu item - is clicked by the user.
  4. Built-in commands, which you can listen by registering to listen to MFiles.Event.BuiltinCommand for the IShellFrame.

Module Startup​

Global function OnNewShellUI is the first function called inside the module. This function gets the new IShellUI as parameter

main.js

function OnNewShellUI( shellUI )
{
    // Called during the initialization
}

For many Extension the most important object you can get from the IShellUI is the IShellFrame instance. For that you have to listen for two events:

  1. MFiles.Event.NewShellFrame event is fired by the IShellUI instance when the IShellFrame instance is available.
  2. MFiles.Event.Started event is fired by the IShellFrame instance when that instance is ready to be used.

Sample code to illustrate the event sequence in the module to get both IShellFrame and IShellUI instances.

main.js

// This function which handles UI Extension initialization phase.
function OnNewShellUI( shellUI )
{
    // Wait for the ShellFrame to be created and started
    shellUI.Events.Register(
        MFiles.Event.NewShellFrame,
        shellFrame => {
            shellFrame.Events.Register(
                MFiles.Event.Started,
                () => {
                    Start( shellUI, shellFrame )
                });
    });
}

// Main application
async function Start( shellUI, shellFrame ) {
    // TODO: write the UI Extension code here.
}

Dashboard Startup​

The startup events are fired only once per module. The function handlers must be named functions bound to the global window object inside the dashboard.

OnNewDashboard gets instance of IDashboard as a parameter. The most common Interfaces like IShellFrame and IShellUI are accessible through that interface.

// Dashboard bootstrap function
function OnNewDashboard( newDashboard ) {

}
tip

The argument of the OnNewDashboard function is instance of UIDashboard which has the ShellFrame property, which is one of the most important interfaces for the UI Extensions: IShellFrame.

ShellFrame has ShellUI property which links to the IShellUI, which is another very important interface, because it contains the Vault property, which allows you to access the Vault API

Interface Events​

Each interface object has Event property which is instance of IEvents. This interface has two methods:

  • Register which is used to register a new event handler for a given Event. This function returns a handle, which can be used to unregister the event handler.
  • Unregister which takes the handler returned by the Register function as parameter.

Example of registering an event handler which listens to the IShellListing Selection Changed event.

// shellListing is of type IShellListing
const eventHandle = await shellListing.Events.Register(
  MFiles.Event.SelectionChanged, 
  items => {
    // When the event fires you get the IShellItems object 
  }
);
info

Notice that the Register methods return value is a Promise. You have to either await that in the async function or resolve the promise using .then( eventHandle => { ]})

To see which Interface events are available for each UI Extension Interface see the API Reference Guide for events

Unregistering an Event Handler​

To unregister an event handler simply pass the handle returned by the Register method to the Unregister method.

shellListing.Events.Unregister(eventHandle);

Cancelling built-in events​

Built-in events can be cancelled by returning false from the attached handler. This can be useful if the handler itself overrides the default behavior:

shellFrame.Commands.Events.Register(
    MFiles.Event.BuiltinCommand,
    (cmdId: number, objectType: number) => {
        // If the user has clicked to create a document then override the behavior.
        if (cmdId === MFiles.BuiltinCommand.NewObject && objectType === 0) {
            shellFrame.ShowMessage("BuiltinCommand as Cancelled by Event handler");
            return false;
        }
    }
)
- - + + \ No newline at end of file diff --git a/Frameworks/User-Interface-Extensibility-Framework/Reference/Overview/InstallingApplications/index.html b/Frameworks/User-Interface-Extensibility-Framework/Reference/Overview/InstallingApplications/index.html index 1a6cfdb8c..d2d941037 100644 --- a/Frameworks/User-Interface-Extensibility-Framework/Reference/Overview/InstallingApplications/index.html +++ b/Frameworks/User-Interface-Extensibility-Framework/Reference/Overview/InstallingApplications/index.html @@ -4,14 +4,14 @@ Installing Applications | M-Files User Interface Extensibility Framework - - + +
Skip to main content

Installing Applications

M-Files UI Extensions are managed using the M-Files Admin tool.

Prerequisites​

  1. You have created an Application Package by creating a ZIP archive from your development folder.
  2. You have access to M-Files Admin tool, which can connect to M-Files Server.
  3. You have configured the M-Files Web application, and can access this via a standard web browser.

Installing the UI Extension​

  1. Open the M-Files Admin tool and connect to your M-Files server.
  2. Right-click on the vault name on the M-Files Admin and select the Applications from the Context menu.
  3. From the Applications window (See Image 1) click the Install button from the bottom of the window.
  4. Select the Application Package you have created previously and click Open button.

Image1: Applications window where you can Install and Remove UI Extensions alt text

note

You may need to log out and back into the M-Files client to see the new application.

Updating the UI Extension​

Applications are differentiated by their Application GUID and version number, which are defined in the Application Manifest. If the Application with same version number has already been installed Already Exists error message is shown.

To update a new version the version number field in the appdef.xml file must be increased above the previous version.

<version>0.2</version>

Alternatively you can remove the application and install it again.

note

You may need to log out and back into the M-Files client to see the changes.

Removing the UI Extension​

You can remove the UI Extension application From the Applications window (See Image1)

  1. Select the application to uninstall.
  2. Click Uninstall button.
  3. Confirm the uninstall by answering Yes or No to the confirm dialog.
- - + + \ No newline at end of file diff --git a/Frameworks/User-Interface-Extensibility-Framework/Reference/Overview/ListingView/index.html b/Frameworks/User-Interface-Extensibility-Framework/Reference/Overview/ListingView/index.html index 9482fb478..ddeda6dd5 100644 --- a/Frameworks/User-Interface-Extensibility-Framework/Reference/Overview/ListingView/index.html +++ b/Frameworks/User-Interface-Extensibility-Framework/Reference/Overview/ListingView/index.html @@ -4,8 +4,8 @@ Working with the Shell Listing | M-Files User Interface Extensibility Framework - - + +
@@ -14,7 +14,7 @@ registered an event listener for MFiles.Event.NewShellListing. We've also registered a listener to the listing's MFiles.Event.SelectionChanged event, like in the previous example. The following code snippet resides inside the MFiles.Event.SelectionChanged handler.


// currentSelection refers to the current selection.
// We assume that only a single object is selected which is a multifile document. We
// will add a file to this object.

// Get objectVersionEx of the object that we want to add a file to.
const myMultiFileDocument = currentSelection.ObjectVersions[0];

// After this call, the multifile document contains a new file.
await listing.AddObjectFile(
    {
        object_info: myMultiFileDocument  // Multifile Document's ObjectVersionEx to which we add a new file to.
    },
    null,
    dataURL,  // String containing data URL (base64 + mime) representation of a file that we want to add.
    filename  // Filename to use. For example, "notes.txt"
);

Replacing a File​

Here is an comprehensive example of how to replace a file. In this example when two objects are selected, the file in object 1 is replaced by a downloaded copy of file from object 2.


// Used for unregistering previous event handler. Also store information if
// replacement is already done.
const state = {
    listing: null,
    selectionChangedEventId: 0,
    isReplaced: false
};

// Register to be notified when the ShellFrame is started.
shellFrame.Events.Register(
    MFiles.Event.NewShellListing,
    async ( listing ) => {

        // Before registering a new handler, unregister the previous event handler.
        if( state.selectionChangedEventId ) {
            state.listing.Events.Unregister( state.selectionChangedEventId );
            state.selectionChangedEventId = 0;
        }

        // Save the event handler id so that we can unregister if the view changes.
        state.selectionChangedEventId = listing.Events.Register(
            MFiles.Event.SelectionChanged,
            async (selectedItems) => {

                // Get the selected object versions.
                const selectedObjectVersions = selectedItems.ObjectVersions || [];

                // Ensure we have two selected objects.
                if( selectedObjectVersions.length == 2 && !state.isReplaced ) {

                    // Two object versions.
                    const objectVersionEx1 = selectedObjectVersions[0];
                    const objectVersionEx2 = selectedObjectVersions[1];
                    const objVer2 = {
                        obj_id: objectVersionEx2.object_info.obj_id,
                        version: objectVersionEx2.version_info.version
                    };

                    // Get two files, their relevant information and download the second file.
                    const file1 = objectVersionEx1.version_info.files[0];
                    const file1Id = file1.file_ver.file_id.internal_id;

                    const file2 = objectVersionEx2.version_info.files[0];
                    const file2Name = file2.title + '.' + file2.extension;
                    const file2DataURL = await MFiles.DownloadFileAsDataUri( objVer2, file2.file_ver );
                    // Generally, data URLs were previously known as data URIs, but the data URI
                    // naming was retired by the WHATWG. Hence the naming inconsistency.

                    // Replace the files in the object version.
                    // This will replace the file in object 1 with the file from object 2.
                    // Prematurely mark the replacement done, otherwise we would get into an infinite
                    // loop here because the replacement operation itself triggers a selection changed
                    // event due to the change to the object which is selected.
                    state.isReplaced = true;
                    await listing.ReplaceFile(
                        file1Id,  // File ID of the file that we will replace.
                        {
                            object_info: objectVersionEx1  // ObjectVersionEx of the object that contains the file1.
                        },
                        null,  // Not used parameter in this example.
                        file2DataURL,  // The content of file 2, which will replace the content of file 1.
                        file2Name  // Name of file 2 with extension.
                    );
                }

            }
        )

    }
);

Modifying Selection​

Note that these operations will trigger new selection changed events.

Selecting Next Object​

When we have a selection we can select the next object.

listing.SelectNextObject();

Selecting Previous Object​

The previous object can also be selected.

listing.SelectPrevObject();

Selecting the first object in the listing​

In this example we're selecting the first object in the listing. However, the same logic can be applied to select a certain object.

// Here, 'listing' refers to the current ShellListing.
const objVer = {
    obj_id: listing.Items.ObjectVersions[0].object_info.obj_id,
    version: listing.Items.ObjectVersions[0].version_info.version
};
listing.SelectObjectVersion(objVer);
- - + + \ No newline at end of file diff --git a/Frameworks/User-Interface-Extensibility-Framework/Reference/Overview/MFilesGlobalObject/index.html b/Frameworks/User-Interface-Extensibility-Framework/Reference/Overview/MFilesGlobalObject/index.html index bb62cbe09..daf1e5d25 100644 --- a/Frameworks/User-Interface-Extensibility-Framework/Reference/Overview/MFilesGlobalObject/index.html +++ b/Frameworks/User-Interface-Extensibility-Framework/Reference/Overview/MFilesGlobalObject/index.html @@ -4,13 +4,13 @@ MFiles Global Object | M-Files User Interface Extensibility Framework - - + +
Skip to main content

MFiles Global Object

The MFiles global object is available in your UI Extension code after initialization. It provides access to enumerations, utility functions, and the Vault API enums.

info

The MFiles global object is only available after the UI Extension has been initialized. It is automatically injected into your extension's iframe context.

Overview​

The MFiles global object contains:

Namespace/PropertyDescription
MFiles.EventUI Extension event type constants
MFiles.MenuLocationMenu location constants for custom commands
MFiles.CommandStateCommand state constants (active, inactive, hidden)
MFiles.CommandLocationCommand location constants
MFiles.BuiltinCommandBuilt-in M-Files command identifiers
MFiles.VaultEnumsgRPC/Vault API enumerations
MFiles.* (ICommonFunctions)Utility methods from ICommonFunctions

UI Extension Enumerations​

These enumerations are used when working with UI Extension features like events, commands, and menus.

MFiles.Event​

Event type constants used when registering event handlers.

// Register a handler for the Started event
shellUI.Events.Register(MFiles.Event.Started, async () => {
    console.log("ShellUI started");
});

// Register a handler for NewShellFrame event
shellUI.Events.Register(MFiles.Event.NewShellFrame, async (shellFrame) => {
    console.log("New shell frame created");
});

// Register a handler for custom commands
shellFrame.Commands.Events.Register(MFiles.Event.CustomCommand, async (commandId) => {
    console.log("Custom command executed:", commandId);
});

See: Event Enumeration

MFiles.MenuLocation​

Constants for specifying where custom commands appear in menus.

// Add command to the top pane menu
await shellFrame.Commands.AddCustomCommandToMenu(
    commandId, 
    MFiles.MenuLocation.MenuLocation_TopPaneMenu, 
    0
);

See: MenuLocation Enumeration

MFiles.CommandState​

Constants for setting the state of custom commands.

// Set command as active (enabled)
await shellFrame.Commands.SetCommandState(
    commandId, 
    MFiles.CommandLocation.MainMenu, 
    MFiles.CommandState.CommandState_Active
);

// Hide a command
await shellFrame.Commands.SetCommandState(
    commandId, 
    MFiles.CommandLocation.MainMenu, 
    MFiles.CommandState.CommandState_Hidden
);

See: CommandState Enumeration

MFiles.CommandLocation​

Constants for specifying command locations.

await shellFrame.Commands.SetCommandState(
    commandId, 
    MFiles.CommandLocation.MainMenu, 
    MFiles.CommandState.CommandState_Active
);

See: CommandLocation Enumeration

MFiles.BuiltinCommand​

Identifiers for built-in M-Files commands.

// Execute the built-in "New Object" command
await shellFrame.Commands.ExecuteCommand(MFiles.BuiltinCommand.NewObject, null);

See: BuiltinCommand Enumeration

Vault API Enumerations (MFiles.VaultEnums)​

The MFiles.VaultEnums namespace contains enumerations used when working with the Vault gRPC API. These are essential when constructing search conditions, working with property values, and interacting with vault data.

Common VaultEnums​

These are some of the most commonly used enumerations. For the complete list, see gRPC Enums Reference.

EnumerationPurpose
MFiles.VaultEnums.ConditionTypeSearch condition types (equal, contains, etc.)
MFiles.VaultEnums.DatatypeProperty data types
MFiles.VaultEnums.ExpressionTypeSearch expression types
MFiles.VaultEnums.DataFunctionData functions for search conditions
MFiles.VaultEnums.FolderTypeFolder type constants
MFiles.VaultEnums.StatusTypeStatus type constants
MFiles.VaultEnums.ObjectVersionDataRequestVersionTypeVersion request types

Example: Building a Search Condition​

// Search for documents containing "invoice" in any field
const searchCondition = {
    expression: {
        type: MFiles.VaultEnums.ExpressionType.EXPRESSION_TYPE_ANY_FIELD
    },
    type: MFiles.VaultEnums.ConditionType.CONDITION_TYPE_CONTAINS,
    typedValue: {
        value: "invoice",
        datatype: {
            type: MFiles.VaultEnums.Datatype.DATATYPE_TEXT
        }
    }
};

Example: Creating a Search Folder​

const searchFolder = {
    type: MFiles.VaultEnums.FolderType.FOLDER_TYPE_SEARCH_FOLDER,
    searchDef: {
        conditions: [
            {
                expression: {
                    propertyValue: {
                        property_def: 100,
                        data_function: MFiles.VaultEnums.DataFunction.DATA_FUNCTION_NO_OP
                    },
                    type: MFiles.VaultEnums.ExpressionType.EXPRESSION_TYPE_PROPERTY_VALUE
                },
                type: MFiles.VaultEnums.ConditionType.CONDITION_TYPE_EQUAL,
                typedValue: {
                    value: true,
                    datatype: {
                        type: MFiles.VaultEnums.Datatype.DATATYPE_BOOLEAN
                    }
                }
            }
        ]
    }
};

ICommonFunctions Methods​

The MFiles global object also includes methods from ICommonFunctions. These provide utility functions that can be called directly on the MFiles object.

Web Storage​

// Save data to web storage
await MFiles.WriteToWebStorage("myKey", "myValue");

// Read data from web storage
const value = await MFiles.ReadFromWebStorage("myKey");

UI Utilities​

// Get the current accent color
const accentColor = await MFiles.GetAccentColor(); // returns "#006eef"

// Show a message box
await MFiles.ShowMessage("Hello World!");

// Report an exception
await MFiles.ReportException(error);

Vault Access​

// Get current vault GUID
const vaultGuid = await MFiles.GetVaultGuid();

Complete Example​

Here's a complete example showing various MFiles global object usage:

// main.js - Entry point of a UI Extension

async function OnNewShellUI(shellUI) {
    // Register for the Started event
    shellUI.Events.Register(MFiles.Event.Started, async () => {
        console.log("ShellUI started");
        
        // Read a stored preference
        const lastView = await MFiles.ReadFromWebStorage("lastView");
        console.log("Last view:", lastView);
    });

    // Register for new shell frames
    shellUI.Events.Register(MFiles.Event.NewShellFrame, async (shellFrame) => {
        await OnNewShellFrame(shellFrame);
    });
}

async function OnNewShellFrame(shellFrame) {
    // Wait for the shell frame to start
    shellFrame.Events.Register(MFiles.Event.Started, async () => {
        
        // Create a custom command
        const commandId = await shellFrame.Commands.CreateCustomCommand("My Command");
        
        // Add to menu
        await shellFrame.Commands.AddCustomCommandToMenu(
            commandId, 
            MFiles.MenuLocation.MenuLocation_TopPaneMenu, 
            0
        );
        
        // Set command as active
        await shellFrame.Commands.SetCommandState(
            commandId, 
            MFiles.CommandLocation.MainMenu, 
            MFiles.CommandState.CommandState_Active
        );
        
        // Handle command execution
        shellFrame.Commands.Events.Register(MFiles.Event.CustomCommand, async (id) => {
            if (id === commandId) {
                await MFiles.ShowMessage("Custom command executed!");
            }
        });
    });
}

See Also​

- - + + \ No newline at end of file diff --git a/Frameworks/User-Interface-Extensibility-Framework/Reference/Overview/Messages/index.html b/Frameworks/User-Interface-Extensibility-Framework/Reference/Overview/Messages/index.html index 0784cbbae..2f1736217 100644 --- a/Frameworks/User-Interface-Extensibility-Framework/Reference/Overview/Messages/index.html +++ b/Frameworks/User-Interface-Extensibility-Framework/Reference/Overview/Messages/index.html @@ -4,13 +4,13 @@ Dialogs and Messages | M-Files User Interface Extensibility Framework - - + +
Skip to main content

Dialogs and Messages

UI Extension Applications can define a rich UI interface using HTML and JavaScript inside their own IFRAME. However, sometimes it is necessary to create modal dialogs which break the IFRAME boundary.

Simple and customized message boxes can be displayed in various interfaces by using ShowMessage method available on the IShellFrame instance. This method can take either single string or object as a parameter. If an object is passed, it defines the behavior of the message box.

Simple String Based Message Box​

The simplest message box type is to call the ShowMessage with just a simple string parameter.

// Here the shellFrame refers to IShellFrame object.

// Wait for the dialog to close, assuming that we are running inside async function.
const res = await shellFrame.ShowMessage('Sample Message from the Extension')

// value of "res" will be
// {selectedButton: 1, checkboxChecked: false}

alt text

The ShowMessage returns always the index of the selected button ( 1, 2 or 3 ) and checkboxChecked boolean.

{selectedButton: 1, checkboxChecked: false}

Customizing Text and the Buttons​

Optionally, you can give message box an Object parameter, where you define the text of the message box in the message property.

You can also define texts for up to three buttons using button1_title, button2_title and button3_title properties.

const result = await shellFrame.ShowMessage({
  message: 'Message Text comes Here',
  button1_title: 'Button Text 1',
  button2_title: 'Button Text 2',
  button3_title: 'Button Text 3',
})

alt text

Message with Checkbox​

You can use checkbox_title to enable checkbox in the message box.

const result = await shellFrame.ShowMessage({
  message: 'Do you want to save the Changes?',
  button1_title: 'Yes',
  button2_title: 'No',
  checkbox_title: 'Do not ask this again',
})

// result.checkboxChecked holds the checkbox value

You can also give checkbox_checked: true in the parameter Object if you want to enable the checkbox by default.

Message with Timeout​

You can use timeOutButton and timeOut to define which button will be selected after N seconds.

const result = await shellFrame.ShowMessage({
  message: 'Do you want to save the Changes?',
  checkbox_checked: true,
  button1_title: 'Yes',
  button2_title: 'No',
  checkbox_title: 'Do not ask this again',
  timeOutButton: 1,
  timeOut: 15,
})

alt text

Toasts​

// Show a Success message
MFiles.ShowToast('Toast Title', 'Toast Message', 1)

alt text

The third parameter is the type of the Toast having following variants:

NameValue
Info0
Success1
Warning2
Error3

Report Exception​

The ReportException function is provided to facilitate showing error messages and exception to the end users in a MessageBox dialog. This function helps developers communicate issues effectively, ensuring users understand what went wrong.

The ReportException function accepts MFError object, JavaScript Error object or string as its parameter. The MFError class extends JavaScript Error class with some additional properties that enable UIX developers to provide more information about the error.

The following section illustrates usage of ReportException function.

1. Showing MFError object.​

window.MFiles.ReportException({
  name: 'name of the error',
  message: 'error message',
  errorCode: 100,
  type: 'type of error',
  source: 'source of error file/class or app',
  stack: 'stack trace',
  details: 'details of the error',
})

alt text

  • The name and message properties are mandatory in MFError class.
  • The name property is shown as the title of the message box.
  • The errorCode must be number and other properties must be string.
  • The Copy link can be used to copy the details text to clipboard which make it easier for end user to report the error to the developer.
  • By default, the details section is hidden. The Show details/Hide details can be used for showing or hiding the details.

2. Showing JavaScript Error object​

try {
  // Codes which may throw exception
} catch (exp) {
  window.MFiles.ReportException(exp)
}

alt text

3. Showing simple string​

window.MFiles.ReportException('Simple string error message')

alt text

You can notice that the message box is shown without any title as we do not have any "name" property in the last example.

- - + + \ No newline at end of file diff --git a/Frameworks/User-Interface-Extensibility-Framework/Reference/Overview/Modules/index.html b/Frameworks/User-Interface-Extensibility-Framework/Reference/Overview/Modules/index.html index 9a273d6dc..c6af12912 100644 --- a/Frameworks/User-Interface-Extensibility-Framework/Reference/Overview/Modules/index.html +++ b/Frameworks/User-Interface-Extensibility-Framework/Reference/Overview/Modules/index.html @@ -4,8 +4,8 @@ Modules | M-Files User Interface Extensibility Framework - - + +
@@ -13,7 +13,7 @@ document defines the file name inside the Application Package to be executed.

    <!-- inside appdef.xml -->
    <modules>
        <module environment="shellui">
            <file>main.js</file>
        </module>
    </modules>

The module code itself must be a JavaScript application, which has a public entrypoint OnNewShellUI which is the function that will be called during the initialization of the UI Extension. The OnNewShellUI has one argument which is the instance of IShellUI. Please see the Sample Applications for examples of actual usage of the ShellUI.

main.js
// This function which handles UI Extension initialization phase.
function OnNewShellUI(shellUI) {
  // Wait for the ShellFrame to be created and started
  shellUI.Events.Register(MFiles.Event.NewShellFrame, (shellFrame) => {
    shellFrame.Events.Register(MFiles.Event.Started, () => {
      Start(shellUI, shellFrame)
    })
  })
}

// Main application
async function Start(shellUI, shellFrame) {
  // TODO: write the UI Extension code here.
}
- - + + \ No newline at end of file diff --git a/Frameworks/User-Interface-Extensibility-Framework/Reference/Overview/Tabs/index.html b/Frameworks/User-Interface-Extensibility-Framework/Reference/Overview/Tabs/index.html index 8f91ab058..3123b563d 100644 --- a/Frameworks/User-Interface-Extensibility-Framework/Reference/Overview/Tabs/index.html +++ b/Frameworks/User-Interface-Extensibility-Framework/Reference/Overview/Tabs/index.html @@ -4,8 +4,8 @@ Tabs | M-Files User Interface Extensibility Framework - - + +
@@ -13,7 +13,7 @@ create a new instance of IDashboard which lives inside an <iframe /> until the tab is removed.

note

Opening too many tabs can affect your application performance.

myTab.ShowDashboard("my-dashboard", {});
myTab.Select();

Passing data into the dashboard​

Custom information can also be passed into the dashboard by providing it as the second argument:

const customData = {
    msg: "Sample message to the dashboard"
};
myTab.ShowDashboard("my-dashboard", customData);
myTab.Select();

The dashboard which was opened using ShowDashboard can retrieve the data from CustomData property.

// Dashboard bootstrap function
function OnNewDashboard( newDashboard ) {

    const data = newDashboard.CustomData; // has the data which is passed in ShowDashboard second param
    console.log(data.msg); // Logs "Sample message to the dashboard"

}
tip

The Custom Data can include only data which can be serialized using the Structured Cloning Algorithm. This means that you can not pass callback functions inside that data to send responses from the new dashboard back to the opener. However, you can send custom command ID values and custom commands can be given a data parameter.

Passing data the dashboard opener​

You can create a custom command which is used to send data back to the opener.

From the opener:

// Create the command, but do not add it to any menu.
const customCommandId = await shellFrame.Commands.CreateCustomCommand(name);

// Listen for the custom commands.
shellFrame.Commands.Events.Register(
    MFiles.Event.CustomCommand,
    ( commandId, data ) => {

        // Disregard other commands.
        if(commandId !== customCommandId)
            return;
        
        // Log out what we were given.
        console.log(data.name); // Logs "ExampleObject"
    }
);

// Show the dashboard and pass the command ID as part of the custom data.
myTab.ShowDashboard("my-dashboard", {
    callbackId: customCommandId
});
myTab.Select();

From the dashboard we can then return data back to the caller by executing the appropriate command using ExecuteCommand

// Dashboard bootstrap function
async function OnNewDashboard( newDashboard ) {

    // Get the command ID
    const commandId = newDashboard.CustomData.callbackId;

    // Send data back to the caller, in this case object { name: "ExampleObject" }
    await shellFrame.Commands.ExecuteCommand(commandId, {
        name: "Example Object"
    });    

}

Selecting a Tab​

Selecting a tab will display the associated dashboard for the tab.

myTab.Select();

Unselecting a Tab​

Unselecting the tab will hide the associated dashboard and make the tab selection status unselected.

myTab.Unselect();

Removing a Tab​

Tab can be permanently removed using Remove method. For performance reasons it is recommended to remove tabs which are not actively needed.

myTab.Remove();
- - + + \ No newline at end of file diff --git a/Frameworks/User-Interface-Extensibility-Framework/Reference/Overview/VaultMessages/index.html b/Frameworks/User-Interface-Extensibility-Framework/Reference/Overview/VaultMessages/index.html index 27dbcdde5..6085b70a9 100644 --- a/Frameworks/User-Interface-Extensibility-Framework/Reference/Overview/VaultMessages/index.html +++ b/Frameworks/User-Interface-Extensibility-Framework/Reference/Overview/VaultMessages/index.html @@ -4,13 +4,13 @@ Vault API Helpers | M-Files User Interface Extensibility Framework - - + +
Skip to main content

Vault API Helpers

When communicating with the M-Files vault through the gRPC API, you work with structured message objects such as ObjID, PropertyValue, TypedValue, and SearchConditionArray. Constructing these objects by hand as raw JSON is verbose and error-prone.

The @m-filescorporation/uix-vault-messages NPM package provides type-safe constructors, helper properties, and convenience methods that simplify working with these messages.

Installation​

npm install @m-filescorporation/uix-vault-messages

Since UIX modules run as plain JavaScript in the M-Files shell, you need a bundler (such as Vite or webpack) to bundle the NPM package into a single file. See the Vault Messages Package sample for a complete project setup with Vite.

Why use this package?​

Compare creating a text property value with raw JSON versus the package helpers:

Raw JSON (manual construction):

const nameProperty = {
  property_def: 0,
  value: {
    type: 1, // Datatype.DATATYPE_TEXT
    is_null_value: false,
    data: {
      text: 'My Document',
    },
  },
};

With the package:

import { MFGrpc } from '@m-filescorporation/uix-vault-messages';

const nameProperty = MFGrpc.PropertyValue.Text(0, 'My Document');

The package eliminates manual union field mapping, magic numbers, and deeply nested structures.

Importing the package​

import { MFGrpc } from '@m-filescorporation/uix-vault-messages';

All message constructors and helpers are accessed through the MFGrpc namespace. No global variables are created.

Available Helpers​

The following message types have helper constructors, properties, and methods:

  • MFGrpc.TypedValue
  • MFGrpc.PropertyValue
  • MFGrpc.PropertyValueArray
  • MFGrpc.SearchCondition
  • MFGrpc.SearchConditionArray
  • MFGrpc.Expression
  • MFGrpc.ObjID
  • MFGrpc.ObjVer
  • MFGrpc.FileVer
  • MFGrpc.Lookup
  • MFGrpc.MultiSelectLookup
  • MFGrpc.ObjectVersionEx
See the Vault Messages Package sample for a complete working application demonstrating these helpers in practice.
- - + + \ No newline at end of file diff --git a/Frameworks/User-Interface-Extensibility-Framework/Reference/Overview/exceptions/index.html b/Frameworks/User-Interface-Extensibility-Framework/Reference/Overview/exceptions/index.html index 592dec01e..d7ac72cbb 100644 --- a/Frameworks/User-Interface-Extensibility-Framework/Reference/Overview/exceptions/index.html +++ b/Frameworks/User-Interface-Extensibility-Framework/Reference/Overview/exceptions/index.html @@ -4,13 +4,13 @@ Exception Reference | M-Files User Interface Extensibility Framework - - + +
Skip to main content

Exception Reference

This page provides detailed information about all exception types that can be thrown by M-Files UI Extension methods.

Error Hierarchy​

Exception Hierarchy:

  • Error (JavaScript base class)
    • MFilesError (M-Files base class)
      • All M-Files specific exceptions (ArgumentError, NotFoundError, etc.)

All M-Files specific exceptions inherit from MFilesError, which itself inherits from the standard JavaScript Error class. This means you can catch M-Files errors using MFilesError for any M-Files-related error, or catch specific derived types for more granular error handling.

Standard JavaScript Exceptions​

In addition to M-Files specific exceptions, UI Extension methods may also throw standard JavaScript exceptions such as Error, TypeError, RangeError, ReferenceError, SyntaxError, and URIError. For comprehensive documentation on JavaScript exceptions, refer to the MDN JavaScript Error Reference.

Error Handling Examples​

For examples of handling different error types in your code, see the Error Handling Sample.

M-Files Exception Types​

ArgumentError​

Thrown when one of the arguments provided to a method is not valid.

Common Causes:

  • Invalid parameter values (null, undefined, negative numbers where not allowed)
  • Arguments out of valid range
  • Incorrect argument types or formats
  • Missing required parameters

Examples:

// Invalid command ID
if (commandId < 0) {
  throw new ArgumentError("Command ID must be non-negative");
}

ConfigurationError​

Thrown when a configuration value is invalid or missing.

Common Causes:

  • Missing required configuration values
  • Invalid configuration format or syntax
  • Configuration file not found or not readable
  • Incompatible configuration for current environment

Examples:

// Missing required configuration
if (!config.apiKey) {
  throw new ConfigurationError("API key is required");
}

DuplicateCommandError​

Thrown when an operation on a command fails due to the command already existing in the target location.

Common Causes:

  • Adding the same command to a menu location multiple times
  • Command ID collision
  • Attempting to create a command that already exists

Examples:

// Attempting to add duplicate command to menu
if (menuAlreadyContainsCommand(commandId)) {
  throw new DuplicateCommandError("Command already exists in this menu");
}

InvalidOperationError​

Thrown when a method call is not valid for the object's current state.

Common Causes:

  • Object not properly initialized
  • Operation called in wrong state or lifecycle phase
  • Resource locked or unavailable
  • Method called on disposed object

Examples:

// Operation called before initialization
if (!this.isInitialized) {
  throw new InvalidOperationError("Object must be initialized first");
}

MFilesError​

Base class for all M-Files UI Extension exceptions.

NotFoundError​

Thrown when an object, command, or resource cannot be found.

Common Causes:

  • Command or menu item deleted or does not exist
  • Invalid command or object reference
  • Resource removed from vault
  • Attempting to access another application's commands

Examples:

// Command not found in vault
const command = this.findCommand(commandId);
if (!command) {
  throw new NotFoundError(`Command ${commandId} not found`);
}

NotSupportedError​

Thrown when an operation is not supported in the current context.

Common Causes:

  • Feature not available in current M-Files version
  • Operation not supported for specific object type
  • Platform limitations (e.g., web vs desktop)
  • Feature behind a feature flag that is disabled

Examples:

// Feature not available
if (!this.supportsFeature(feature)) {
  throw new NotSupportedError("Feature not available in this version");
}

TimeoutError​

Thrown when an operation times out.

Common Causes:

  • Network latency or connectivity issues
  • M-Files server not responding
  • Long-running vault operations
  • Client-side operation taking too long

Examples:

// Operation timeout
if (elapsed > timeout) {
  throw new TimeoutError("Operation timed out after 30 seconds");
}

UnauthorizedAccessError​

Thrown when access to a resource is denied due to insufficient permissions.

Common Causes:

  • User lacks required vault permissions
  • Object is checked out by another user
  • Vault access restrictions
  • Application does not own the resource (e.g., trying to modify another app's commands or taskbar groups)

Examples:

// User lacks permissions
if (!user.hasPermission(Permission.Write)) {
  throw new UnauthorizedAccessError("Write permission required");
}

JavaScript Exception Types​

These are standard JavaScript exceptions that may be thrown by UI Extension methods. For complete documentation, see the MDN JavaScript Error Reference.

Error​

The Error object represents an error when trying to execute a statement or accessing a property.

Common Causes:

  • Generic error condition
  • Uncaught exceptions
  • Manual error throwing

RangeError​

The RangeError object indicates an error when a value is not in the set or range of allowed values.

Common Causes:

  • Array length out of bounds
  • Invalid numeric values
  • Recursive function limits

ReferenceError​

The ReferenceError object represents an error when trying to access a variable that is not defined.

Common Causes:

  • Accessing undefined variables
  • Typos in variable names
  • Scope issues

SyntaxError​

The SyntaxError object represents an error when trying to interpret syntactically invalid code.

Common Causes:

  • Malformed JSON
  • Invalid regular expressions
  • Parse errors

TypeError​

The TypeError object represents an error when an operation could not be performed, typically when a value is not of the expected type.

Common Causes:

  • Calling a non-function
  • Accessing properties of null/undefined
  • Wrong argument types

URIError​

The URIError object represents an error when a global URI handling function was used in a wrong way.

Common Causes:

  • Invalid URI encoding/decoding
  • Malformed URI components
- - + + \ No newline at end of file diff --git a/Frameworks/User-Interface-Extensibility-Framework/Reference/Overview/index.html b/Frameworks/User-Interface-Extensibility-Framework/Reference/Overview/index.html index ebd34ecf3..2e15c615a 100644 --- a/Frameworks/User-Interface-Extensibility-Framework/Reference/Overview/index.html +++ b/Frameworks/User-Interface-Extensibility-Framework/Reference/Overview/index.html @@ -4,13 +4,13 @@ Overview | M-Files User Interface Extensibility Framework - - + +
Skip to main content

Overview

User Interface Extensibility Framework applications are JavaScript applications that run within the M-Files Web client. The framework provides a set of objects that allow you to interact with the user interface by adding commands to various menus, to add your own tabs/dashboards, or to react when various events fire within the user interface. Applications can also use the M-Files Vault API to perform tasks within the vault such as searching or creating objects.

What can be done using the User Interface Extensibility Framework?​

The User Interface Extensibility Framework allows third-party developers to extend the M-Files client interface in a number of ways:

  • By reacting when events fire within the user interface, such as reacting when a user selects an object of a known type.
  • By adding commands to either the main menu or context menu, and reacting when those commands are clicked.
  • By adding custom tabs to the user interface, allowing custom HTML pages ("dashboards") to be shown within M-Files.
  • By showing popup dashboards, for example when a command is clicked.
  • By interacting with other components of the user interface through the UIX API, or interacting with the vault via the Vault API.
  • Using any combination of the above.

How are UI applications structured?​

note

More information on the application structure is available in the dedicated page.

UI applications are deployed as a .mfappx file, which is a renamed .zip file. This archive contains the files that the application needs to run, including:

  • A manifest file named appdef.xml which defines the application ID, name, modules, and dashboards.
  • At least one module file which declares the application entry point.
  • Zero, one, or more dashboard HTML file, along with any supporting files such as CSS, JavaScript, or images.

How do I deploy and test my UI applications?​

- - + + \ No newline at end of file diff --git a/Frameworks/User-Interface-Extensibility-Framework/Reference/Samples/AssignToMe/index.html b/Frameworks/User-Interface-Extensibility-Framework/Reference/Samples/AssignToMe/index.html index eebdf7873..04bc564ee 100644 --- a/Frameworks/User-Interface-Extensibility-Framework/Reference/Samples/AssignToMe/index.html +++ b/Frameworks/User-Interface-Extensibility-Framework/Reference/Samples/AssignToMe/index.html @@ -4,13 +4,13 @@ Creating assignments for selected objects | M-Files User Interface Extensibility Framework - - + +
Skip to main content

Creating assignments for selected objects

⚠️ Note

Sample codes are for demonstration purposes only. Before using in production, add proper error handling such as try-catch blocks, null checks, and input validation.

Overview​

This sample creates a basic User Interface Extensibility Framework application consisting of one ShellUI module which allows the user to select objects within the M-Files vault and assign them to themselves via a button in the main menu.

This sample does not show how to create a local development folder or to deploy the code to the M-Files server. It is assumed that a local development folder already exists, and that is the location in which the development is occurring.

Creating the application structure​

Creating the application definition file​

Into this folder we will create an application definition file. This file must be named appdef.xml. The application will use version 5 of the client schema (as we are only targeting newer M-Files versions). The application will declare a single Shell UI module (with its code in main.js), and no dashboards.

appdef.xml
<?xml version="1.0"?>
<application xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="http://www.m-files.com/schemas/appdef-client-v5.xsd">
    <guid>C311B570-40F4-4893-96C8-05110A30743C</guid>
    <name>Assign to me UIX sample</name>
    <version>0.1</version>
    <description>A demonstration application for reacting to selected items and assigning them via a command.</description>
    <publisher>M-Files Corporation</publisher>
    <enabled-by-default>true</enabled-by-default>
    <modules>
        <module environment="shellui">
        <file>main.js</file>
        </module>
    </modules>
</application>

Ensure that your application has a unique GUID by using a GUID generator.

Creating the module​

Next we will create a module file to contain our actual application logic. Initially:

  • We will declare a default entry point for the ShellUI module.
  • We will react to the NewShellFrame event and obtain a reference to the shell frame.
  • We will react to the shell frame’s Started event (as using the shell frame before this point will result in an exception).
  • Create a command (button, place it into the menu area, and hide it.
  • React to the shellFrame’s CustomCommand event and add some placeholder code to execute when the command is clicked.
main.js
function OnNewShellUI(shellUI) {
  /// <summary>The entry point of ShellUI module.</summary>
  /// <param name="shellUI" type="MFiles.ShellUI">The new shell UI object.</param>

  // Register to be notified when a new shell frame (Event_NewShellFrame) is created.
  shellUI.Events.Register(MFiles.Event.NewShellFrame, handleNewShellFrame);
}

function handleNewShellFrame(shellFrame) {
  /// <summary>Handles the OnNewShellFrame event for an IShellUI.</summary>
  /// <param name="shellFrame" type="MFiles.ShellFrame">The shell frame object which was created.</param>

  // Register to listen to the started event.
  shellFrame.Events.Register(
    MFiles.Event.Started,
    getShellFrameStartedHandler(shellFrame),
  );
}

function getShellFrameStartedHandler(shellFrame) {
  /// <summary>Gets a function to handle the Started event for shell frame.</summary>
  /// <param name="shellFrame" type="MFiles.ShellFrame">The current shell frame object.</param>
  /// <returns type="MFiles.Events.OnStarted">The event handler.</returns>

  // Return the handler function for ShellFrame's Started event.
  return async () => {
    // Create a command for "assign to me".
    const assignCommandId =
      await shellFrame.Commands.CreateCustomCommand('Assign to me');

    // Add the command to the main menu.
    await shellFrame.Commands.AddCustomCommandToMenu(
      assignCommandId,
      MFiles.MenuLocation.MenuLocation_TopPaneMenu,
      1,
    );

    // Hide the command.  We will show it when the selected items change.
    await shellFrame.Commands.SetCommandState(
      assignCommandId,
      MFiles.CommandLocation.All,
      MFiles.CommandState.CommandState_Hidden,
    );

    // Register to respond to commands being clicked.
    shellFrame.Commands.Events.Register(
      MFiles.Event.CustomCommand,
      async (command) => {
        // We only care about our command.
        // If the command being clicked is something else then return.
        if (command !== assignCommandId) {
          return;
        }

        // TODO: Ensure we have items to process.

        // TODO: Create the assignment object.
      },
    );
  };
}

Reacting to shell listing selection changes​

We must be able to react to selection changes in the listing.

We will:

  • Declare a global variable to hold the currently-selected items (currentlySelectedItems).
  • React to the shell frame’s NewShellListing event to attach event handlers to each shell listing.
  • Alter the visibility of the command depending on whether or not any objects are currently selected.
  • React to each shell listing’s SelectionChanged event, saving the currently-selected items.
main.js
// The currently-selected items in the active listing.
let currentlySelectedItems = null;

function OnNewShellUI(shellUI) {
  /// <summary>The entry point of ShellUI module.</summary>
  /// <param name="shellUI" type="MFiles.ShellUI">The new shell UI object.</param>

  // Register to be notified when a new shell frame (Event_NewShellFrame) is created.
  shellUI.Events.Register(MFiles.Event.NewShellFrame, handleNewShellFrame);
}

function handleNewShellFrame(shellFrame) {
  /// <summary>Handles the OnNewShellFrame event for an IShellUI.</summary>
  /// <param name="shellFrame" type="MFiles.ShellFrame">The shell frame object which was created.</param>

  // Register to listen to the started event.
  shellFrame.Events.Register(
    MFiles.Event.Started,
    getShellFrameStartedHandler(shellFrame),
  );
}

function getShellFrameStartedHandler(shellFrame) {
  /// <summary>Gets a function to handle the Started event for shell frame.</summary>
  /// <param name="shellFrame" type="MFiles.ShellFrame">The current shell frame object.</param>
  /// <returns type="MFiles.Events.OnStarted">The event handler.</returns>

  // Return the handler function for ShellFrame's Started event.
  return async () => {
    // Create a command for "assign to me".
    const assignCommandId =
      await shellFrame.Commands.CreateCustomCommand('Assign to me');

    // Add the command to the main menu.
    await shellFrame.Commands.AddCustomCommandToMenu(
      assignCommandId,
      MFiles.MenuLocation.MenuLocation_TopPaneMenu,
      1,
    );

    // Hide the command.  We will show it when the selected items change.
    await shellFrame.Commands.SetCommandState(
      assignCommandId,
      MFiles.CommandLocation.All,
      MFiles.CommandState.CommandState_Hidden,
    );

    // Register to listen to when new shell listings are created.
    shellFrame.Events.Register(
      MFiles.Event.NewShellListing,
      getNewShellListingHandler(shellFrame, assignCommandId),
    );

    // Register to respond to commands being clicked.
    shellFrame.Commands.Events.Register(
      MFiles.Event.CustomCommand,
      async (command) => {
        // We only care about our command.
        // If the command being clicked is something else then return.
        if (command !== assignCommandId) {
          return;
        }

        // Ensure we have items to process.
        if (!currentlySelectedItems) {
          return;
        }

        // TODO: Create the assignment object.
      },
    );
  };
}

function getNewShellListingHandler(shellFrame, assignCommandId) {
  /// <summary>Gets a function to handle the NewShellListing event for shell frame.</summary>
  /// <param name="shellFrame" type="MFiles.ShellFrame">The current shell frame object.</param>
  /// <returns type="MFiles.Events.OnNewShellListing">The event handler.</returns>

  // Return the handler function for NewShellListing event.
  return (shellListing) => {
    // Listen for selection change events on the listing.
    shellListing.Events.Register(
      MFiles.Event.SelectionChanged,
      async (selectedItems) => {
        // Sanity.
        if (shellListing.IsActive === false) {
          return false;
        }

        // Set the currently-selected items to null (assume nothing selected).
        currentlySelectedItems = null;

        // Has the user got any object versions selected?
        if (selectedItems.ObjectVersions.length === 0) {
          // Hide the menu item - there's nothing selected.
          await shellFrame.Commands.SetCommandState(
            assignCommandId,
            MFiles.CommandLocation.All,
            MFiles.CommandState.CommandState_Hidden,
          );
          return false;
        }

        // Show the menu item.
        await shellFrame.Commands.SetCommandState(
          assignCommandId,
          MFiles.CommandLocation.All,
          MFiles.CommandState.CommandState_Active,
        );

        // Store the selected items.
        currentlySelectedItems = selectedItems;

        // We succeeded; return true.
        return true;
      },
    );
  };
}

Creating the assignment object​

We will:

  • Create a function that creates the assignment object (createAssigmentObject). Specifically, it will:
    • Create property values for the built-in properties used by the Assignment object type:
      • Class.
      • Name or title.
      • Single file document.
      • Assigned to.
    • Create properties to establish relationships between the assignment object and the currently-selected items.
    • Create the object and check it in immediately.
  • Call the function when the command is clicked.
main.js
// The currently-selected items in the active listing.
let currentlySelectedItems = null;

// Built in property defs.
const BuiltInPropertyDefs = {
  Class: 100,
  NameOrTitle: 0,
  SingleFlie: 22,
  AssignedTo: 44,
};

// Built in object types.
const BuiltInObjectType = {
  Assignment: 10,
};

// Null value of GUID.
const GUID_NULL = '{00000000-0000-0000-0000-000000000000}';

function OnNewShellUI(shellUI) {
  /// <summary>The entry point of ShellUI module.</summary>
  /// <param name="shellUI" type="MFiles.ShellUI">The new shell UI object.</param>

  // Register to be notified when a new shell frame (Event_NewShellFrame) is created.
  shellUI.Events.Register(MFiles.Event.NewShellFrame, handleNewShellFrame);
}

function handleNewShellFrame(shellFrame) {
  /// <summary>Handles the OnNewShellFrame event for an IShellUI.</summary>
  /// <param name="shellFrame" type="MFiles.ShellFrame">The shell frame object which was created.</param>

  // Register to listen to the started event.
  shellFrame.Events.Register(
    MFiles.Event.Started,
    getShellFrameStartedHandler(shellFrame),
  );
}

function getShellFrameStartedHandler(shellFrame) {
  /// <summary>Gets a function to handle the Started event for shell frame.</summary>
  /// <param name="shellFrame" type="MFiles.ShellFrame">The current shell frame object.</param>
  /// <returns type="MFiles.Events.OnStarted">The event handler.</returns>

  // Return the handler function for ShellFrame's Started event.
  return async () => {
    // Create a command for "assign to me".
    const assignCommandId =
      await shellFrame.Commands.CreateCustomCommand('Assign to me');;

    // Add the command to the main menu.
    await shellFrame.Commands.AddCustomCommandToMenu(
      assignCommandId,
      MFiles.MenuLocation.MenuLocation_TopPaneMenu,
      1,
    );

    // Hide the command.  We will show it when the selected items change.
    await shellFrame.Commands.SetCommandState(
      assignCommandId,
      MFiles.CommandLocation.All,
      MFiles.CommandState.CommandState_Hidden,
    );

    // Register to listen to when new shell listings are created.
    shellFrame.Events.Register(
      MFiles.Event.NewShellListing,
      getNewShellListingHandler(shellFrame, assignCommandId),
    );

    // Is there already a listing?  If so then we need to hook into it as well.
    if (shellFrame.Listing) {
      getNewShellListingHandler(shellFrame, assignCommandId)(shellFrame.Listing);
    }

    // Register to respond to commands being clicked.
    shellFrame.Commands.Events.Register(
      MFiles.Event.CustomCommand,
      async (command) => {
        // We only care about our command.
        // If the command being clicked is something else then return.
        if (command !== assignCommandId) {
          return;
        }

        // Ensure we have items to process.
        if (!currentlySelectedItems) {
          return;
        }

        // Create the assignment object.
        await createAssignmentObject(shellFrame);
      },
    );
  };
}

function getNewShellListingHandler(shellFrame, assignCommandId) {
  /// <summary>Gets a function to handle the NewShellListing event for shell frame.</summary>
  /// <param name="shellFrame" type="MFiles.ShellFrame">The current shell frame object.</param>
  /// <returns type="MFiles.Events.OnNewShellListing">The event handler.</returns>

  // Return the handler function for NewShellListing event.
  return (shellListing) => {
    // Listen for selection change events on the listing.
    shellListing.Events.Register(
      MFiles.Event.SelectionChanged,
      async (selectedItems) => {
        // Sanity.
        if (shellListing.IsActive === false) {
          return false;
        }

        // Set the currently-selected items to null (assume nothing selected).
        currentlySelectedItems = null;

        // Has the user got any object versions selected?
        if (selectedItems.ObjectVersions.length === 0) {
          // Hide the menu item - there's nothing selected.
          await shellFrame.Commands.SetCommandState(
            assignCommandId,
            MFiles.CommandLocation.All,
            MFiles.CommandState.CommandState_Hidden,
          );
          return false;
        }

        // Show the menu item.
        await shellFrame.Commands.SetCommandState(
          assignCommandId,
          MFiles.CommandLocation.All,
          MFiles.CommandState.CommandState_Active,
        );

        // Store the selected items.
        currentlySelectedItems = selectedItems;

        // We succeeded; return true.
        return true;
      },
    );
  };
}

async function retrieveRelationshipPropertyValues(shellFrame, selectedItems) {
  /// <summary>Retrieves property values representing relationships to the selected items.</summary>
  /// <param name="shellFrame" type="MFiles.ShellFrame">The current shell frame object.</param>
  /// <param name="selectedItems" type="MFiles.IShellItems">The items that are selected.</param>
  /// <param name="Promise">A promise to be resolved with the property values for the relationship.</param>

  // Create an array to store the property values.
  const relationshipPropertyValues = [];

  try {
    // Get the vault reference.
    const iVault = shellFrame.ShellUI.Vault;

    // Get all the object types.
    const allObjectTypes = await iVault.ObjectTypesOperations.GetObjectTypes({
      call_importance: 1, // CallImportance.CALL_IMPORTANCE_NORMAL
    });

    // Selected object types.
    const selectedObjectTypes = [];

    // Iterate over the objects and populate the properties for the assignment.
    for (let i = 0; i < selectedItems.ObjectVersions.length; i++) {
      // Get the item.
      const selectedItem = selectedItems.ObjectVersions[i];
      const objectType = allObjectTypes.object_types.find(
        (item) => item.id === selectedItem.object_info.obj_id.type,
      );
      selectedObjectTypes.push(objectType);
    }

    // Get the default property defs of the selected objects.
    const defaultPropertyDefs = selectedObjectTypes.map(
      (result) => result.default_property_def,
    );

    // Do we have a property value already?
    // Will happen if they select two of the same object type.
    for (let i = 0; i < defaultPropertyDefs.length; i++) {
      const defaultPropertyDef = defaultPropertyDefs[i];
      let propertyValue = relationshipPropertyValues.find(
        (relationshipPropertyValue) =>
          relationshipPropertyValue.property_def === defaultPropertyDef,
      );

      // If there isn't already a property value for this object type, we need to create it.
      if (!propertyValue) {
        propertyValue = {
          property_def: defaultPropertyDef,
          value: {
            type: 10, // Datatype.DATATYPE_MULTI_SELECT_LOOKUP,
            is_null_value: false,
            data: {
              multi_select_lookup: {
                values: [],
              },
            },
          },
        };

        // Push it to array.
        relationshipPropertyValues.push(propertyValue);
      }

      // Add this item to the lookup.
      const lookup = {
        value_list_item_info: selectedItems.ObjectVersions[i].object_info,
        version: selectedItems.ObjectVersions[i].version_info.version,
      };
      propertyValue.value.data.multi_select_lookup.values.push(lookup);
    }

    // Handle the error.
  } catch (exception) {
    console.error(exception);

    // Return the prepared property values.
  } finally {
    return relationshipPropertyValues;
  }
}

async function preparePropertyValuesForNewAssignment(shellFrame) {
  /// <summary>Prepares the property values with the hard coded values.</summary>
  /// <param name="shellFrame" type="MFiles.ShellFrame">The current shell frame object.</param>
  /// <returns type="MFiles.PropertyValueArray">The property values array.</returns>

  // Create the property values for the new object.
  const propertyValues = [];

  // Get session info.
  const sessionInfo = await MFiles.GetSessionInfo();

  // Function to create the lookup value.
  const lookupValue = (value) => {
    return {
      value_list_item_info: {
        obj_id: {
          type: -2,
          item_id: {
            internal_id: value,
            external_repository_id: {
              connection: '',
              item: '',
            },
          },
        },
        name: null,
        external_id_status: 0, // ExtIDStatus.EXT_IDSTATUS_UNKNOWN,
        external_id: null,
        guid: GUID_NULL,
        options: {
          // Note: Default value(true) enables is_deleted true and deleted flag added to prefilled value
          // So to handle it false has been set.
          all: true,
        },
        icon_id: null,
      },
      version: {
        type: 1, // ObjVerVersionType.OBJ_VER_VERSION_TYPE_LATEST,
        internal_version: -1,
        external_repository_version: '',
        external_repository_sort_key: 0,
      },
    };
  };

  // Class property value.
  const classPropertyValue = {
    property_def: BuiltInPropertyDefs.Class,
    value: {
      type: 9, // Datatype.DATATYPE_LOOKUP,
      is_null_value: false,
      data: {
        lookup: lookupValue(-100),
      },
    },
  };
  propertyValues.push(classPropertyValue);

  // Name or title property.
  const nameOrTitlePropertyValue = {
    property_def: BuiltInPropertyDefs.NameOrTitle,
    value: {
      type: 1, // Datatype.DATATYPE_TEXT,
      is_null_value: false,
      data: {
        text: 'Assignment',
      },
    },
  };
  propertyValues.push(nameOrTitlePropertyValue);

  // Single-file-document property.
  const singleFileDocumentPropertyValue = {
    property_def: BuiltInPropertyDefs.SingleFlie,
    value: {
      type: 8, // Datatype.DATATYPE_BOOLEAN,
      is_null_value: false,
      data: {
        boolean: false,
      },
    },
  };
  propertyValues.push(singleFileDocumentPropertyValue);

  // Assigned to property.
  const assignedToPropertyValue = {
    property_def: BuiltInPropertyDefs.AssignedTo,
    value: {
      type: 10, // Datatype.DATATYPE_MULTI_SELECT_LOOKUP,
      is_null_value: false,
      data: {
        multi_select_lookup: {
          values: [
            lookupValue(sessionInfo.vault_data?.user_id), // Assigned to the current login user.
          ],
        },
      },
    },
  };
  propertyValues.push(assignedToPropertyValue);

  // Return the prepared property values.
  return propertyValues;
}

async function createAssignmentObject(shellFrame) {
  /// <summary>Creates an assignment for the currently-selected items, assigning it to the current user.</summary>
  /// <param name="shellFrame" type="MFiles.ShellFrame">The current shell frame object.</param>
  /// <returns type="MFiles.ObjectVersionAndProperties">The event handler.</returns>

  try {
    // Get the relationship property values array..
    const relationshipPropertyValues = await retrieveRelationshipPropertyValues(
      shellFrame,
      currentlySelectedItems,
    );

    // Prepare the default property values for new assignment.
    propertyValues = await preparePropertyValuesForNewAssignment(shellFrame);

    // Add the relationship property values to the property values for the assignment.
    propertyValues = propertyValues.concat(relationshipPropertyValues);

    // Get the vault instance.
    const iVault = shellFrame.ShellUI.Vault;

    // Create object request.
    const createObjectRequest = {
      object_type_id: BuiltInObjectType.Assignment,
      properties: propertyValues,
      acl: {},
      object_flags: {
        all: true,
      },
      check_in: true, // Checkin the object immediately.
    };

    // Create new object in the server.
    await iVault.ObjectOperations.AddObjectWithFiles(createObjectRequest);
    await shellFrame.ShowMessage('Assigned to you.');

    // Handle the exception.
  } catch (exception) {
    console.error(exception);
  }
}

Testing the application​

The command/button appears in the menu area, and is shown/hidden as items are selected. Selecting items and clicking Assign to me shows a message that the operation was successful.

alt text

Once the button has been clicked, an assignment is created for the current user and is related to the objects that were previously selected.

alt text

- - + + \ No newline at end of file diff --git a/Frameworks/User-Interface-Extensibility-Framework/Reference/Samples/BuiltInCommands/index.html b/Frameworks/User-Interface-Extensibility-Framework/Reference/Samples/BuiltInCommands/index.html index 5851da5a5..a0e0cc2f3 100644 --- a/Frameworks/User-Interface-Extensibility-Framework/Reference/Samples/BuiltInCommands/index.html +++ b/Frameworks/User-Interface-Extensibility-Framework/Reference/Samples/BuiltInCommands/index.html @@ -4,13 +4,13 @@ Built-in Command Demonstration | M-Files User Interface Extensibility Framework - - + +
Skip to main content

Built-in Command Demonstration

⚠️ Note

Sample codes are for demonstration purposes only. Before using in production, add proper error handling such as try-catch blocks, null checks, and input validation.

Overview​

This sample creates a basic User Interface Extensibility Framework application consisting of one ShellUI module which reacts when built-in commands are clicked. Also it shows how to execute a built in command.

This sample does not show how to create a local development folder or to deploy the code to the M-Files server. It is assumed that a local development folder already exists, and that is the location in which the development is occurring.

Creating the application structure​

Creating the application definition file​

Into this folder we will create an application definition file. This file must be named appdef.xml. The application will use version 5 of the client schema (as we are only targeting newer M-Files versions). The application will declare a single Shell UI module (with its code in main.js), and no dashboards.

appdef.xml
<?xml version="1.0"?>
<application xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="http://www.m-files.com/schemas/appdef-client-v5.xsd">
    <guid>D14E6DA7-E7A6-498E-B709-C682C75DC887</guid>
    <name>Built-in Command Demonstration</name>
    <version>0.1</version>
    <description>Simple M-Files built-in command demonstration.</description>
    <publisher>M-Files Corporation</publisher>
    <enabled-by-default>true</enabled-by-default>
    <modules>
        <module environment="shellui">
        <file>main.js</file>
        </module>
    </modules>
</application>
Ensure that your application has a unique GUID by using a GUID generator.

Creating the module​

Next we will create a module file to contain our actual application logic. At this point we will just register to be notified of main lifecycle events:

  • We will declare a default entry point for the ShellUI module.
  • We will react to the NewShellFrame event and obtain a reference to the shell frame.
  • We will react to the shell frame’s Started event (as using the shell frame before this point will result in an exception).
main.js
function OnNewShellUI(shellUI) {
  /// <summary>Executed by the UIX when a ShellUI module is started.</summary>
  /// <param name="shellUI" type="MFiles.ShellUI">The shell UI object which was created.</param>

  // This is the start point of a ShellUI module.

  // Register to be notified when a new shell frame (MFiles.Event.NewShellFrame) is created.
  shellUI.Events.Register(MFiles.Event.NewShellFrame, handleNewShellFrame);
}

function handleNewShellFrame(shellFrame) {
  /// <summary>Handles the OnNewShellFrame event for an IShellUI.</summary>
  /// <param name="shellFrame" type="MFiles.ShellFrame">The shell frame object which was created.</param>

  // The shell frame was created but it cannot be used yet.
  // The following line would throw an exception ("The object cannot be accessed, because it is not ready."):
  // shellFrame.ShowMessage('A shell frame was created');

  // Register to be notified when the shell frame is started.
  shellFrame.Events.Register(
    MFiles.Event.Started,
    getShellFrameStartedHandler(shellFrame),
  );
}

function getShellFrameStartedHandler(shellFrame) {
  /// <summary>Returns a function which handles the OnStarted event for an IShellFrame.</summary>

  // The shell frame is now started and can be used.

  return async () => {};
}

Reacting to built-in commands​

Once the ShellFrame is available for use, our code can register to be notified when the BuiltinCommand event is raised. This event occurs whenever standard M-Files client functionality is used, such as clicking buttons to create new objects, or to log out.

To register, we provide a callback function which defines two parameters:

  • commandId (number) - one of the built-in commands from the BuiltinCommand enumeration.
  • param (number) - either:
    • If the commandId is MFiles.BuiltinCommand.NewObject then the ID of the object type being created (or -100 if not known), or
    • -2 otherwise.

In this sample we will simply show the values in a message box:

main.js
function OnNewShellUI(shellUI) {
  /// <summary>The entry point of ShellUI module.</summary>
  /// <param name="shellUI" type="MFiles.ShellUI">The new shell UI object.</param>

  // Note: We want to hook into the built-in commands being executed in any shell frame,
  // but we want our command to only be used in NORMAL shell frames (as the task pane etc. is not available in others).

  // Register to be notified when a new shell frame is created.
  // This will be used to hook into the built-in commands whereever they are executed.
  shellUI.Events.Register(MFiles.Event.NewShellFrame, handleNewShellFrame);
}

function handleNewShellFrame(shellFrame) {
  /// <summary>Handles the OnNewShellFrame event.</summary>
  /// <param name="shellFrame" type="MFiles.ShellFrame">The new shell frame object.</param>

  // Register to be notified of the started event.
  shellFrame.Events.Register(
    MFiles.Event.Started,
    getShellFrameStartedHandler(shellFrame),
  );
}

function getShellFrameStartedHandler(shellFrame) {
  /// <summary>Gets a function to handle the Started event for shell frame.</summary>
  /// <param name="shellFrame" type="MFiles.ShellFrame">The current shell frame object.</param>
  /// <returns type="MFiles.Events.OnStarted">The event handler.</returns>

  // Return the handler function for Started event.
  return async () => {
    // Register to be notified when a built-in command is executed.
    shellFrame.Commands.Events.Register(
      MFiles.Event.BuiltinCommand,
      async (commandId, param) => {
        /// <summary>Executed whenever a built-in command is clicked.</summary>
        /// <param name="commandId" type="BuiltinCommand">
        /// One of the built-in commands from the BuiltinCommand enumeration.
        /// </param>
        /// <param name="param">
        /// If the <paramref name="commandId"/> is MFiles.BuiltinCommand.NewObject then contains the object type id of the object to create (or -100 if not specified).
        /// Otherwise, returns -2.
        /// </param>

        // Display every built-in command as message box.
        await shellFrame.ShowMessage(
          'Command ID: ' + commandId + ', param: ' + param,
        );
      },
    );
  };
}

Executing built-in command​

Command can be executed using ExecuteCommand from ICommands interface. It has two parameters

  • commandId - The command id. It can be a built-in command enumerated value or custom command id.
  • args - Command argument or an arguments object, if the command requires arguments. Use null or empty value if the command does not require arguments.

In this example, it demonstrates how the builtin command Download File executed. It invovles four steps:

  • Creating a new ICommand using CreateCustomCommand.
  • Adding the command into the context menu using AddCustomCommandToMenu.
  • Handling NewShellListing event where enable the custom command state based on the current selected items.
  • Execute Download File command.
main.js
function OnNewShellUI(shellUI) {
  /// <summary>The entry point of ShellUI module.</summary>
  /// <param name="shellUI" type="MFiles.ShellUI">The new shell UI object.</param>

  // Note: We want to hook into the built-in commands being executed in any shell frame,
  // but we want our command to only be used in NORMAL shell frames (as the task pane etc. is not available in others).

  // Register to be notified when a new shell frame is created.
  // This will be used to hook into the built-in commands whereever they are executed.
  shellUI.Events.Register(MFiles.Event.NewShellFrame, handleNewShellFrame);
}

function handleNewShellFrame(shellFrame) {
  /// <summary>Handles the OnNewShellFrame event.</summary>
  /// <param name="shellFrame" type="MFiles.ShellFrame">The new shell frame object.</param>

  // Register to be notified of the started event.
  shellFrame.Events.Register(
    MFiles.Event.Started,
    getShellFrameStartedHandler(shellFrame),
  );
}

function getShellFrameStartedHandler(shellFrame) {
  /// <summary>Gets a function to handle the Started event for shell frame.</summary>
  /// <param name="shellFrame" type="MFiles.ShellFrame">The current shell frame object.</param>
  /// <returns type="MFiles.Events.OnStarted">The event handler.</returns>

  // Return the handler function for Started event.
  return async () => {
    // Create a command (button).  Note that it is not yet visible.
    const commandDownloadId = await shellFrame.Commands.CreateCustomCommand(
      'Download selected file(s)',
    );

    // Add the commands to the context menu.
    await shellFrame.Commands.AddCustomCommandToMenu(
      commandDownloadId,
      MFiles.MenuLocation.MenuLocation_ContextMenu_Bottom,
      1,
    );

    // Hide the command. We will show it when the selected items change.
    await shellFrame.Commands.SetCommandState(
      commandDownloadId,
      MFiles.CommandLocation.All,
      MFiles.CommandState.CommandState_Hidden,
    );

    // Register to listen when new shell listings are created.
    shellFrame.Events.Register(
      MFiles.Event.NewShellListing,
      getNewShellListingHandler(shellFrame, commandDownloadId),
    );

    // Is there already a listing?  If so then we need to hook into it as well.
    if (shellFrame.Listing) {
      getNewShellListingHandler(
        shellFrame,
        commandDownloadId,
      )(shellFrame.Listing);
    }

    // Register to be notified when a built-in command is executed.
    shellFrame.Commands.Events.Register(
      MFiles.Event.BuiltinCommand,
      async (commandId, param) => {
        /// <summary>Executed whenever a built-in command is clicked.</summary>
        /// <param name="commandId" type="BuiltinCommand">
        /// One of the built-in commands from the BuiltinCommand enumeration.
        /// </param>
        /// <param name="param">
        /// If the <paramref name="commandId"/> is MFiles.BuiltinCommand.NewObject then contains the object type id of the object to create (or -100 if not specified).
        /// Otherwise, returns -2.
        /// </param>
        /// <returns>A boolean defining whether the action should continue (true) or be cancelled (false).</returns>

        // Display every built-in command as message box.
        await shellFrame.ShowMessage(
          'Command ID: ' + commandId + ', param: ' + param,
        );
      },
    );

    // Register to be notified when a custom command is executed.
    shellFrame.Commands.Events.Register(
      MFiles.Event.CustomCommand,
      async (commandId) => {
        /// <summary>Executed whenever a custom command is clicked.</summary>
        /// <param name="commandId" type="CustomCommand">
        /// One of the built-in commands from the CustomCommand enumeration.
        /// </param>
        if (commandId === commandDownloadId) {
          await shellFrame.Commands.ExecuteCommand(
            MFiles.BuiltinCommand.DownloadFile,
            null,
          );
        }
      },
    );
  };
}

function isObjectCanBeDownload(currentSelection) {
  /// <summary>Gets the boolean flag whether the object can be download or not</summary>
  /// <param name="currentSelection" type="MFiles.ShellItems">The current selection.</param>

  let canDownload = true;

  // Nothing selected so nothing to download.
  if (currentSelection.Count === 0) {
    return false;
  }

  // Skip the download option for folders/view.
  if (currentSelection.Folders.length === 0) {
    // Check all the objects in current selection in order to
    // set the commands state properly.
    if (currentSelection.ObjectVersions.length > 0) {
      // Object version info.
      const currentObjectVersions = currentSelection.ObjectVersions;

      for (const objIdx in currentObjectVersions) {
        if (
          Object.prototype.hasOwnProperty.call(currentObjectVersions, objIdx)
        ) {
          // True, if the selected object has files.
          canDownload =
            currentSelection.ObjectVersions[objIdx].version_info.files?.length >
            0;

          // No need to show 'Download this file' option for objects which doesnt have files (e.g., customer, projects).
          if (!canDownload) {
            break;
          }
        }
      }
    }

    // Single file.
    if (currentSelection.ObjectFiles.length > 0) {
      canDownload = true;
    }
  } else {
    canDownload = false;
  }

  return canDownload;
}

function getNewShellListingHandler(shellFrame, commandDownloadId) {
  /// <summary>Gets a function to handle the NewShellListing event for shell frame.</summary>
  /// <param name="shellFrame" type="MFiles.ShellFrame">The current shell frame object.</param>
  /// <returns type="MFiles.Events.OnNewShellListing">The event handler.</returns>

  // Return the handler function for NewShellListing event.
  return async (shellListing) => {
    // Listen for selection change events on the listing.
    shellListing.Events.Register(
      MFiles.Event.SelectionChanged,
      async (selectedItems) => {
        // Has the user got any object versions selected?
        if (
          shellListing.IsActive === false ||
          !isObjectCanBeDownload(selectedItems)
        ) {
          // Hide the menu item.
          await shellFrame.Commands.SetCommandState(
            commandDownloadId,
            MFiles.CommandLocation.All,
            MFiles.CommandState.CommandState_Hidden,
          );
          return false;
        }

        // Show the menu item.
        await shellFrame.Commands.SetCommandState(
          commandDownloadId,
          MFiles.CommandLocation.All,
          MFiles.CommandState.CommandState_Active,
        );

        // We succeeded; return true.
        return true;
      },
    );
  };
}

Testing the application​

On creating new assignment object, the following message should be shown on-screen:

alt text

On context menu over the doument object, Download selected file(s) command can be seen. On clicking it, the selected file will be downloaded using the built-in command Download File.

alt text

- - + + \ No newline at end of file diff --git a/Frameworks/User-Interface-Extensibility-Framework/Reference/Samples/Commands/index.html b/Frameworks/User-Interface-Extensibility-Framework/Reference/Samples/Commands/index.html index 67efcc4d5..9a14fb645 100644 --- a/Frameworks/User-Interface-Extensibility-Framework/Reference/Samples/Commands/index.html +++ b/Frameworks/User-Interface-Extensibility-Framework/Reference/Samples/Commands/index.html @@ -4,15 +4,15 @@ Commands | M-Files User Interface Extensibility Framework - - + +
Skip to main content

Commands

⚠️ Note

Sample codes are for demonstration purposes only. Before using in production, add proper error handling such as try-catch blocks, null checks, and input validation.

Overview​

This sample creates a basic User Interface Extensibility Framework application consisting of one ShellUI module which adds buttons to the main menu and context menu that are shown/hidden depending upon the user’s actions.

Creating the application structure​

Creating the application definition file​

Into this folder we will create an application definition file. This file must be named appdef.xml. The application will use version 5 of the client schema (as we are only targeting newer M-Files versions), and the supported platform will be set as newweb only. The application will declare a single Shell UI module (with its code in main.js), and no dashboards.

appdef.xml
<?xml version="1.0"?>
<application xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="http://www.m-files.com/schemas/appdef-client-v5.xsd">
    <guid>A50FF521-9167-4366-9CDE-6CB5C3BDDAFF</guid>
    <name>Commands</name>
    <version>0.1</version>
    <description>A basic application showing how to work with commands.</description>
    <publisher>M-Files Corporation</publisher>
    <enabled-by-default>true</enabled-by-default>
    <modules>
        <module environment="shellui">
        <file>main.js</file>
        </module>
    </modules>
</application>
Ensure that your application has a unique GUID by using a GUID generator.

Creating the module​

Next we will create a module file to contain our actual application logic. At this point we will just register to be notified of main lifecycle events:

  • We will declare a default entry point for the ShellUI module.
  • We will react to the NewShellFrame event and obtain a reference to the shell frame.
  • We will react to the shell frame’s Started event (as using the shell frame before this point will result in an exception).
main.js
function OnNewShellUI( shellUI ) {

    /// <summary>Executed by the UIX when a ShellUI module is started.</summary>
    /// <param name="shellUI" type="MFiles.ShellUI">The shell UI object which was created.</param>

    // This is the start point of a ShellUI module.

    // Register to be notified when a new shell frame (MFiles.Event.NewShellFrame) is created.
    shellUI.Events.Register(
        MFiles.Event.NewShellFrame,
        handleNewShellFrame );
}

function handleNewShellFrame( shellFrame ) {

    /// <summary>Handles the OnNewShellFrame event for an IShellUI.</summary>
    /// <param name="shellFrame" type="MFiles.ShellFrame">The shell frame object which was created.</param>

    // The shell frame was created but it cannot be used yet.
    // The following line would throw an exception ("The object cannot be accessed, because it is not ready."):
    // shellFrame.ShowMessage('A shell frame was created');

    // Register to be notified when the shell frame is started.
    shellFrame.Events.Register(
        MFiles.Event.Started,
        getShellFrameStartedHandler( shellFrame ) );
}

function getShellFrameStartedHandler( shellFrame )  {

    /// <summary>Returns a function which handles the OnStarted event for an IShellFrame.</summary>

    // The shell frame is now started and can be used.

    return async () => {};
}

Creating a button in the main menu​

Adding a button into the main menu involves two steps:

  1. Creating a new ICommand using CreateCustomCommand.
  2. Adding the command into the menu using AddCustomCommandToMenu.
main.js
function OnNewShellUI( shellUI ) {

    /// <summary>Executed by the UIX when a ShellUI module is started.</summary>
    /// <param name="shellUI" type="MFiles.ShellUI">The shell UI object which was created.</param>

    // This is the start point of a ShellUI module.

    // Register to be notified when a new shell frame (MFiles.Event.NewShellFrame) is created.
    shellUI.Events.Register(
        MFiles.Event.NewShellFrame,
        handleNewShellFrame );
}

function handleNewShellFrame( shellFrame ) {

    /// <summary>Handles the OnNewShellFrame event for an IShellUI.</summary>
    /// <param name="shellFrame" type="MFiles.ShellFrame">The shell frame object which was created.</param>

    // The shell frame was created but it cannot be used yet.
    // The following line would throw an exception ("The object cannot be accessed, because it is not ready."):
    // shellFrame.ShowMessage('A shell frame was created');

    // Register to be notified when the shell frame is started.
    shellFrame.Events.Register(
        MFiles.Event.Started,
        getShellFrameStartedHandler( shellFrame ) );
}

function getShellFrameStartedHandler( shellFrame )  {

    /// <summary>Returns a function which handles the OnStarted event for an IShellFrame.</summary>

    // The shell frame is now started and can be used.

    return async () => {

        // Create a command (button).  Note that it is not yet visible.
        const commandOneId = await shellFrame.Commands.CreateCustomCommand( 'My First Command' );

        // Add the first command to the main menu.
        await shellFrame.Commands.AddCustomCommandToMenu( commandOneId, MFiles.MenuLocation.MenuLocation_TopPaneMenu, 1 );
    };
}

Logging into the M-Files vault should now show a button in the main menu (three dot menu near user icon) with the text My First Command:

alt text

Reacting when the command is clicked​

Reacting to a command being clicked involves three steps:

  • Register to be notified of the CustomCommand event.
  • Ensure that the command that was clicked was the one we want to handle.
  • Execute the required code.
main.js
function OnNewShellUI( shellUI ) {

    /// <summary>Executed by the UIX when a ShellUI module is started.</summary>
    /// <param name="shellUI" type="MFiles.ShellUI">The shell UI object which was created.</param>

    // This is the start point of a ShellUI module.

    // Register to be notified when a new shell frame (MFiles.Event.NewShellFrame) is created.
    shellUI.Events.Register(
        MFiles.Event.NewShellFrame,
        handleNewShellFrame );
}

function handleNewShellFrame( shellFrame ) {

    /// <summary>Handles the OnNewShellFrame event for an IShellUI.</summary>
    /// <param name="shellFrame" type="MFiles.ShellFrame">The shell frame object which was created.</param>

    // The shell frame was created but it cannot be used yet.
    // The following line would throw an exception ("The object cannot be accessed, because it is not ready."):
    // shellFrame.ShowMessage('A shell frame was created');

    // Register to be notified when the shell frame is started.
    shellFrame.Events.Register(
        MFiles.Event.Started,
        getShellFrameStartedHandler( shellFrame ) );
}

function getShellFrameStartedHandler( shellFrame )  {

    /// <summary>Returns a function which handles the OnStarted event for an IShellFrame.</summary>

    // The shell frame is now started and can be used.

    return async () => {

        // Create a command (button).  Note that it is not yet visible.
        const commandOneId = await shellFrame.Commands.CreateCustomCommand( 'My First Command' );

        // Add the first command to the main menu.
        await shellFrame.Commands.AddCustomCommandToMenu( commandOneId, MFiles.MenuLocation.MenuLocation_TopPaneMenu, 1 );

        // Register to be notified when a custom command is clicked.
        // Note: this will fire for ALL custom commands, so we need to filter out others.
        shellFrame.Commands.Events.Register(
            MFiles.Event.CustomCommand,
            async ( commandId ) => {

                // Branch depending on the Id of the command that was clicked.
                switch (commandId) {
                    case commandOneId:

                        // Our first command was clicked.
                        await shellFrame.ShowMessage( 'My first command clicked.' );
                        break;
                }
            } );

    };
}

alt text

Adding a command to both the main menu and the context menu​

To add a command created with CreateCustomCommand to the context menu, call AddCustomCommandToMenu. In the example below, it is the same command object added to both main menu and context menu, so our code to react when the button is clicked will be fired for the context menu item and the main menu item.

main.js
function OnNewShellUI( shellUI ) {

    /// <summary>Executed by the UIX when a ShellUI module is started.</summary>
    /// <param name="shellUI" type="MFiles.ShellUI">The shell UI object which was created.</param>

    // This is the start point of a ShellUI module.

    // Register to be notified when a new shell frame (MFiles.Event.NewShellFrame) is created.
    shellUI.Events.Register(
        MFiles.Event.NewShellFrame,
        handleNewShellFrame );
}

function handleNewShellFrame( shellFrame ) {

    /// <summary>Handles the OnNewShellFrame event for an IShellUI.</summary>
    /// <param name="shellFrame" type="MFiles.ShellFrame">The shell frame object which was created.</param>

    // The shell frame was created but it cannot be used yet.
    // The following line would throw an exception ("The object cannot be accessed, because it is not ready."):
    // shellFrame.ShowMessage('A shell frame was created');

    // Register to be notified when the shell frame is started.
    shellFrame.Events.Register(
        MFiles.Event.Started,
        getShellFrameStartedHandler( shellFrame ) );
}

function getShellFrameStartedHandler( shellFrame )  {

    /// <summary>Returns a function which handles the OnStarted event for an IShellFrame.</summary>

    // The shell frame is now started and can be used.

    return async () => {

        // Create a command (button).  Note that it is not yet visible.
        const commandOneId = await shellFrame.Commands.CreateCustomCommand( 'My First Command' );

        // Add the first command to the context menu.
        await shellFrame.Commands.AddCustomCommandToMenu( commandOneId, MFiles.MenuLocation.MenuLocation_ContextMenu_Bottom, 1 );

        // Add the first command to the main menu.
        await shellFrame.Commands.AddCustomCommandToMenu( commandOneId, MFiles.MenuLocation.MenuLocation_TopPaneMenu, 1 );

        // Register to be notified when a custom command is clicked.
        // Note: this will fire for ALL custom commands, so we need to filter out others.
        shellFrame.Commands.Events.Register(
            MFiles.Event.CustomCommand,
            async ( commandId ) => {

                // Branch depending on the Id of the command that was clicked.
                switch (commandId) {
                    case commandOneId:

                        // Our first command was clicked.
                        await shellFrame.ShowMessage( 'My first command clicked.' );
                        break;
                }
            } );

    };
}

alt text

Adding child command to the main menu​

Adding a child button into the main menu involves two steps:

  1. Creating a new ICommand using CreateCustomCommand.
  2. Adding the command into main menu using CreateSubMenuItem by giving the parent command id.
main.js
function OnNewShellUI( shellUI ) {

    /// <summary>Executed by the UIX when a ShellUI module is started.</summary>
    /// <param name="shellUI" type="MFiles.ShellUI">The shell UI object which was created.</param>

    // This is the start point of a ShellUI module.

    // Register to be notified when a new shell frame (MFiles.Event.NewShellFrame) is created.
    shellUI.Events.Register(
        MFiles.Event.NewShellFrame,
        handleNewShellFrame );
}

function handleNewShellFrame( shellFrame ) {

    /// <summary>Handles the OnNewShellFrame event for an IShellUI.</summary>
    /// <param name="shellFrame" type="MFiles.ShellFrame">The shell frame object which was created.</param>

    // The shell frame was created but it cannot be used yet.
    // The following line would throw an exception ("The object cannot be accessed, because it is not ready."):
    // shellFrame.ShowMessage('A shell frame was created');

    // Register to be notified when the shell frame is started.
    shellFrame.Events.Register(
        MFiles.Event.Started,
        getShellFrameStartedHandler( shellFrame ) );
}

function getShellFrameStartedHandler( shellFrame )  {

    /// <summary>Returns a function which handles the OnStarted event for an IShellFrame.</summary>

    // The shell frame is now started and can be used.

    return async () => {

        // Create a command (button).  Note that it is not yet visible.
        const commandOneId = await shellFrame.Commands.CreateCustomCommand( 'My First Command' );

        // Create a command (button).  Note that it is not yet visible.
        const commandTwoId = await shellFrame.Commands.CreateCustomCommand( 'My Second Command' );

        // Add the first command to the context menu.
        await shellFrame.Commands.AddCustomCommandToMenu( commandOneId, MFiles.MenuLocation.MenuLocation_ContextMenu_Bottom, 1 );

        // Add the first and second commands to the main menu.
        await shellFrame.Commands.AddCustomCommandToMenu( commandOneId, MFiles.MenuLocation.MenuLocation_TopPaneMenu, 1 );
        const parentMenuItemId = await shellFrame.Commands.AddCustomCommandToMenu( commandTwoId, MFiles.MenuLocation.MenuLocation_TopPaneMenu, 1 );

        // Create child commands (buttons).
        const commandChildOneId = await shellFrame.Commands.CreateCustomCommand( 'My First Child Command' );
        const commandChildTwoId = await shellFrame.Commands.CreateCustomCommand( 'My Second Child Command' );

        // Add created child comamnds to the parent.
        await shellFrame.Commands.CreateSubMenuItem( parentMenuItemId, commandChildOneId, 1 );
        await shellFrame.Commands.CreateSubMenuItem( parentMenuItemId, commandChildTwoId, 1 );

        // Register to be notified when a custom command is clicked.
        // Note: this will fire for ALL custom commands, so we need to filter out others.
        shellFrame.Commands.Events.Register(
            MFiles.Event.CustomCommand,
            async ( commandId ) => {

                // Branch depending on the Id of the command that was clicked.
                switch (commandId) {
                    case commandOneId:

                        // Our first command was clicked.
                        await shellFrame.ShowMessage( 'My first command clicked.' );
                        break;

                    case commandChildOneId:

                        // Our child command was clicked.
                        await shellFrame.ShowMessage( 'My child command clicked.' );
                        break;
                }
            } );
    };
}

alt text

Adding child command to the context menu​

Adding child command to custom command​

Adding a child button to custom command involves two steps:

  1. Creating a new ICommand using CreateCustomCommand.
  2. Adding the command into context menu using CreateSubMenuItem by giving the parent command id.

Adding child command to exist builtin submenu​

Adding a child button to exist builtin submenu command involves three steps:

  1. Creating a new ICommand using CreateCustomCommand.
  2. Getting parent menu item id using GetMenuIdOfBuiltInCommand.
  3. Adding the command into context menu using CreateSubMenuItem by giving the parent menu item id.
main.js
function OnNewShellUI( shellUI ) {

    /// <summary>Executed by the UIX when a ShellUI module is started.</summary>
    /// <param name="shellUI" type="MFiles.ShellUI">The shell UI object which was created.</param>

    // This is the start point of a ShellUI module.

    // Register to be notified when a new shell frame (MFiles.Event.NewShellFrame) is created.
    shellUI.Events.Register(
        MFiles.Event.NewShellFrame,
        handleNewShellFrame );
}

function handleNewShellFrame( shellFrame ) {

    /// <summary>Handles the OnNewShellFrame event for an IShellUI.</summary>
    /// <param name="shellFrame" type="MFiles.ShellFrame">The shell frame object which was created.</param>

    // The shell frame was created but it cannot be used yet.
    // The following line would throw an exception ("The object cannot be accessed, because it is not ready."):
    // shellFrame.ShowMessage('A shell frame was created');

    // Register to be notified when the shell frame is started.
    shellFrame.Events.Register(
        MFiles.Event.Started,
        getShellFrameStartedHandler( shellFrame ) );
}

function getShellFrameStartedHandler( shellFrame )  {

    /// <summary>Returns a function which handles the OnStarted event for an IShellFrame.</summary>

    // The shell frame is now started and can be used.

    return async () => {

        // Create a command (button).  Note that it is not yet visible.
        const commandOneId = await shellFrame.Commands.CreateCustomCommand( 'My First Command' );

        // Create a command (button).  Note that it is not yet visible.
        const commandTwoId = await shellFrame.Commands.CreateCustomCommand( 'My Second Command' );

        // Add the first command to the context menu.
        await shellFrame.Commands.AddCustomCommandToMenu( commandOneId, MFiles.MenuLocation.MenuLocation_ContextMenu_Bottom, 1 );

        // Add the first and second commands to the main menu.
        await shellFrame.Commands.AddCustomCommandToMenu( commandOneId, MFiles.MenuLocation.MenuLocation_TopPaneMenu, 1 );
        const parentMenuItemId = await shellFrame.Commands.AddCustomCommandToMenu( commandTwoId, MFiles.MenuLocation.MenuLocation_TopPaneMenu, 1 );

        // Create child commands (buttons).
        const commandChildOneId = await shellFrame.Commands.CreateCustomCommand( 'My First Child Command' );
        const commandChildTwoId = await shellFrame.Commands.CreateCustomCommand( 'My Second Child Command' );

        // Add created child comamnds to the parent.
        await shellFrame.Commands.CreateSubMenuItem( parentMenuItemId, commandChildOneId, 1 );
        await shellFrame.Commands.CreateSubMenuItem( parentMenuItemId, commandChildTwoId, 1 );

        // Create child command to add exist submenu in the listing context menu.
        const commandChildThreeId = await shellFrame.Commands.CreateCustomCommand( 'My Custom Convert Command' );

        // Get built in parent command menu id. Ex. Convert.
        const convertMenuId = await shellFrame.Commands.GetMenuIdOfBuiltInCommand( MFiles.BuiltinCommand.SubMenu_Convert, MFiles.CommandLocation.ContextMenu );

        // Add child command to the exist convert menu.
        await shellFrame.Commands.CreateSubMenuItem( convertMenuId, commandChildThreeId, 0 );

        // Register to be notified when a custom command is clicked.
        // Note: this will fire for ALL custom commands, so we need to filter out others.
        shellFrame.Commands.Events.Register(
            MFiles.Event.CustomCommand,
            async ( commandId ) => {

                // Branch depending on the Id of the command that was clicked.
                switch (commandId) {
                    case commandOneId:

                        // Our first command was clicked.
                        await shellFrame.ShowMessage( 'My first command clicked.' );
                        break;

                    case commandChildOneId:

                        // Our child command was clicked.
                        await shellFrame.ShowMessage( 'My child command clicked.' );
                        break;
                }
            } );
    };
}

alt text

Showing and hiding buttons​

The visibility of commands can be controlled by calling SetCommandState. To show this, we will toggle the first command visibility on clicking the child command.

main.js
function OnNewShellUI( shellUI ) {

    /// <summary>Executed by the UIX when a ShellUI module is started.</summary>
    /// <param name="shellUI" type="MFiles.ShellUI">The shell UI object which was created.</param>

    // This is the start point of a ShellUI module.

    // Register to be notified when a new shell frame (MFiles.Event.NewShellFrame) is created.
    shellUI.Events.Register(
        MFiles.Event.NewShellFrame,
        handleNewShellFrame );
}

function handleNewShellFrame( shellFrame ) {

    /// <summary>Handles the OnNewShellFrame event for an IShellUI.</summary>
    /// <param name="shellFrame" type="MFiles.ShellFrame">The shell frame object which was created.</param>

    // The shell frame was created but it cannot be used yet.
    // The following line would throw an exception ("The object cannot be accessed, because it is not ready."):
    // shellFrame.ShowMessage('A shell frame was created');

    // Register to be notified when the shell frame is started.
    shellFrame.Events.Register(
        MFiles.Event.Started,
        getShellFrameStartedHandler( shellFrame ) );
}

function getShellFrameStartedHandler( shellFrame )  {

    /// <summary>Returns a function which handles the OnStarted event for an IShellFrame.</summary>

    // The shell frame is now started and can be used.

    return async () => {

        // Create a command (button).  Note that it is not yet visible.
        const commandOneId = await shellFrame.Commands.CreateCustomCommand( 'My First Command' );

        // Create a command (button).  Note that it is not yet visible.
        const commandTwoId = await shellFrame.Commands.CreateCustomCommand( 'My Second Command' );

        // Add the first command to the context menu.
        await shellFrame.Commands.AddCustomCommandToMenu( commandOneId, MFiles.MenuLocation.MenuLocation_ContextMenu_Bottom, 1 );

        // Add the first and second commands to the main menu.
        await shellFrame.Commands.AddCustomCommandToMenu( commandOneId, MFiles.MenuLocation.MenuLocation_TopPaneMenu, 1 );
        const parentMenuItemId = await shellFrame.Commands.AddCustomCommandToMenu( commandTwoId, MFiles.MenuLocation.MenuLocation_TopPaneMenu, 1 );

        // Create child commands (buttons).
        const commandChildOneId = await shellFrame.Commands.CreateCustomCommand( 'My First Child Command' );
        const commandChildTwoId = await shellFrame.Commands.CreateCustomCommand( 'My Second Child Command' );

        // Add created child commands to the parent in the main menu.
        await shellFrame.Commands.CreateSubMenuItem( parentMenuItemId, commandChildOneId, 1 );
        const childMenuItem = await shellFrame.Commands.CreateSubMenuItem( parentMenuItemId, commandChildTwoId, 1 );

        // Create nested child command and add to the parent in the main menu.
        const toggleCommand = await shellFrame.Commands.CreateCustomCommand( 'Toggle First Command Visibility' );
        await shellFrame.Commands.CreateSubMenuItem( childMenuItem, toggleCommand, 1 );

        // Create child command to add exist submenu in the listing context menu.
        const commandChildThreeId = await shellFrame.Commands.CreateCustomCommand( 'My Custom Convert Command' );

        // Get built in parent command menu id. Ex. Convert.
        const convertMenuId = await shellFrame.Commands.GetMenuIdOfBuiltInCommand( MFiles.BuiltinCommand.SubMenu_Convert, MFiles.CommandLocation.ContextMenu );

        // Add child command to the exist convert menu.
        await shellFrame.Commands.CreateSubMenuItem( convertMenuId, commandChildThreeId, 0 );

        // Register to be notified when a custom command is clicked.
        // Note: this will fire for ALL custom commands, so we need to filter out others.
        shellFrame.Commands.Events.Register(
            MFiles.Event.CustomCommand,
            async ( commandId ) => {

                // Branch depending on the Id of the command that was clicked.
                switch (commandId) {
                    case commandOneId:

                        // Our first command was clicked.
                        await shellFrame.ShowMessage( 'My first command clicked.' );
                        break;

                    case commandChildOneId:

                        // Our child command was clicked.
                        await shellFrame.ShowMessage( 'My child command clicked.' );
                        break;

                    case commandChildThreeId:

                        // Our child command was clicked.
                        await shellFrame.ShowMessage( 'My convert child command clicked.' );
                        break;

                    case toggleCommand:

                        // Get the first command state and toggle it.
                        let firstCommandState = await shellFrame.Commands.GetCommandState( commandOneId, MFiles.CommandLocation.MainMenu, false, false );
                        firstCommandState = firstCommandState === MFiles.CommandState.CommandState_Hidden
                            ? MFiles.CommandState.CommandState_Active
                            : MFiles.CommandState.CommandState_Hidden;

                        // Toggle the command state and show message.
                        await shellFrame.Commands.SetCommandState( commandOneId, MFiles.CommandLocation.All, firstCommandState );

                        // Show the message.
                        const message = firstCommandState === MFiles.CommandState.CommandState_Active
                            ? 'First command visibility enabled'
                            : 'First command visibility disabled'
                        await shellFrame.ShowMessage( message );
                        break;
                }
            } );
    };
}

Testing the application​

alt text alt text

Adding an icon​

To set an command icon, call SetIcon(customCommand, iconInformation). The function validates the inputs, resolves the icon described by iconInformation, and — if resolution succeeds — updates the command's icon field. If the command id is not found, the function throws an invalid argument error; if icon resolution fails (network, parsing, etc.) the error is logged and the command is left unchanged.

Parameters

  • customCommand (number) – id of the custom command to update. Must be a command that exists in mFilesCommon.
  • iconInformation (IIconInformation) – description of the icon source and metadata (content type, content string or id, optional extension).

How it works

  1. Validates inputs. If customCommand or iconInformation is null/undefined, the call throws immediately.
  2. Looks up the command.
  3. Resolves the icon.
  4. If icon resolution returns a non-null value, assign it to command's icon.

Key notes

  • Signature: async SetIcon(customCommand: number, iconInformation: IIconInformation): Promise<void>
  • Stability: Experimental — API may change.
  • Inline SVG strings: if iconInformation contains raw SVG markup, the system treats it as SVG; the helper will default missing extension to svg and encode the content to a base64 data URI for reliable rendering.
  • PATH resources: the loader uses fetch then converts the response to a data URI. Same-origin/CORS restrictions apply.
  • Built-in icons: when using a built-in id, corresponding icon is being added to command and unknown built-in ids result in no icon being set.

Icon can be added to every menu location.

main.js
function OnNewShellUI( shellUI ) {

    /// <summary>Executed by the UIX when a ShellUI module is started.</summary>
    /// <param name="shellUI" type="MFiles.ShellUI">The shell UI object which was created.</param>

    // This is the start point of a ShellUI module.

    // Register to be notified when a new shell frame (MFiles.Event.NewShellFrame) is created.
    shellUI.Events.Register(
        MFiles.Event.NewShellFrame,
        handleNewShellFrame );
}

function handleNewShellFrame( shellFrame ) {

    /// <summary>Handles the OnNewShellFrame event for an IShellUI.</summary>
    /// <param name="shellFrame" type="MFiles.ShellFrame">The shell frame object which was created.</param>

    // The shell frame was created but it cannot be used yet.
    // The following line would throw an exception ("The object cannot be accessed, because it is not ready."):
    // shellFrame.ShowMessage('A shell frame was created');

    // Register to be notified when the shell frame is started.
    shellFrame.Events.Register(
        MFiles.Event.Started,
        getShellFrameStartedHandler( shellFrame ) );
}

function getShellFrameStartedHandler( shellFrame )  {

    /// <summary>Returns a function which handles the OnStarted event for an IShellFrame.</summary>

    // The shell frame is now started and can be used.

    return async () => {

        // Create custom commands.
        const commandIconSVGPathId = await shellFrame.Commands.CreateCustomCommand( 'Command icon SVG path' );
        const commandIconSVGBase64Id = await shellFrame.Commands.CreateCustomCommand( 'Command icon SVG base64' );
        const commandIconSVGStringId = await shellFrame.Commands.CreateCustomCommand( 'Command icon SVG string' );
        const commandIconPNGPathId = await shellFrame.Commands.CreateCustomCommand( 'Command icon PNG path' );
        const commandIconICOId = await shellFrame.Commands.CreateCustomCommand( 'Command icon (ICO)' );
        const commandIconJPGPathId = await shellFrame.Commands.CreateCustomCommand( 'Command icon JPG path' );
        const commandIconJPEGPathId = await shellFrame.Commands.CreateCustomCommand( 'Command icon JPEG path' );

        // Create IIconInformation interface for each supported icon.
        const SVGPathIdIconInformation = { content: 'icons/analyze.svg', iconContentType: 'PATH', alt: 'SVG icon alt', extension: 'svg' };
        const SVGBase64IconInformation = { content: svgBase64, iconContentType: 'BASE64', alt: 'SVG base64 icon alt', extension: 'svg' };
        const SVGStringIconInformation = { content: svgString, iconContentType: 'SVG', alt: 'SVG string icon alt', extension: 'svg' };
        const PNGPathIdIconInformation = { content: 'icons/vault.png', iconContentType: 'PATH', alt: 'PNG icon alt', extension: 'png' };
        const ICOPathIdIconInformation = { content: 'icons/word.ico', iconContentType: 'PATH', alt: 'ICO icon alt', extension: 'ico' };
        const JPGPathIdIconInformation = { content: 'icons/image_cropped.jpg', iconContentType: 'PATH', alt: 'JPG icon alt', extension: 'jpg' };
        const JPEGPathIdIconInformation = { content: 'icons/image2_cropped.jpeg', iconContentType: 'PATH', alt: 'JPEG icon alt', extension: 'jpeg' };

        try {

            // Set icons.
            await shellFrame.Commands.SetIcon( commandIconSVGPathId, SVGPathIdIconInformation );
            await shellFrame.Commands.SetIcon( commandIconSVGBase64Id, SVGBase64IconInformation );
            await shellFrame.Commands.SetIcon( commandIconSVGStringId, SVGStringIconInformation );
            await shellFrame.Commands.SetIcon( commandIconPNGPathId, PNGPathIdIconInformation );
            await shellFrame.Commands.SetIcon( commandIconICOId, ICOPathIdIconInformation );
            await shellFrame.Commands.SetIcon( commandIconJPGPathId, JPGPathIdIconInformation );
            await shellFrame.Commands.SetIcon( commandIconJPEGPathId, JPEGPathIdIconInformation );
        }
        catch ( error ) {

            // Log the error.
            console.error( 'Error setting icon:', error );
        }

        // Add commands to top pane menu.
        await shellFrame.Commands.AddCustomCommandToMenu( commandIconSVGPathId, MFiles.MenuLocation.MenuLocation_TopPaneMenu, 1 );
        await shellFrame.Commands.AddCustomCommandToMenu( commandIconSVGBase64Id, MFiles.MenuLocation.MenuLocation_TopPaneMenu, 1 );
        await shellFrame.Commands.AddCustomCommandToMenu( commandIconSVGStringId, MFiles.MenuLocation.MenuLocation_TopPaneMenu, 1 );
        await shellFrame.Commands.AddCustomCommandToMenu( commandIconPNGPathId, MFiles.MenuLocation.MenuLocation_TopPaneMenu, 1 );
        await shellFrame.Commands.AddCustomCommandToMenu( commandIconICOId, MFiles.MenuLocation.MenuLocation_TopPaneMenu, 1 );
        await shellFrame.Commands.AddCustomCommandToMenu( commandIconJPGPathId, MFiles.MenuLocation.MenuLocation_TopPaneMenu, 1 );
        await shellFrame.Commands.AddCustomCommandToMenu( commandIconJPEGPathId, MFiles.MenuLocation.MenuLocation_TopPaneMenu, 1 );

        // Add commands to context menu.
        await shellFrame.Commands.AddCustomCommandToMenu( commandIconSVGPathId, MFiles.MenuLocation.MenuLocation_ContextMenu_Bottom, 1 );
        await shellFrame.Commands.AddCustomCommandToMenu( commandIconSVGBase64Id, MFiles.MenuLocation.MenuLocation_ContextMenu_Bottom, 1 );
        await shellFrame.Commands.AddCustomCommandToMenu( commandIconSVGStringId, MFiles.MenuLocation.MenuLocation_ContextMenu_Bottom, 1 );
        await shellFrame.Commands.AddCustomCommandToMenu( commandIconPNGPathId, MFiles.MenuLocation.MenuLocation_ContextMenu_Bottom, 1 );
        await shellFrame.Commands.AddCustomCommandToMenu( commandIconICOId, MFiles.MenuLocation.MenuLocation_ContextMenu_Bottom, 1 );
        await shellFrame.Commands.AddCustomCommandToMenu( commandIconJPGPathId, MFiles.MenuLocation.MenuLocation_ContextMenu_Bottom, 1 );
        await shellFrame.Commands.AddCustomCommandToMenu( commandIconJPEGPathId, MFiles.MenuLocation.MenuLocation_ContextMenu_Bottom, 1 );

        // Add commands to activity context menu.
        await shellFrame.Commands.AddCustomCommandToMenu( commandIconSVGPathId, MFiles.MenuLocation.MenuLocation_ActivityContextMenu_1, 1 );
        await shellFrame.Commands.AddCustomCommandToMenu( commandIconSVGBase64Id, MFiles.MenuLocation.MenuLocation_ActivityContextMenu_1, 1 );
        await shellFrame.Commands.AddCustomCommandToMenu( commandIconSVGStringId, MFiles.MenuLocation.MenuLocation_ActivityContextMenu_1, 1 );
        await shellFrame.Commands.AddCustomCommandToMenu( commandIconPNGPathId, MFiles.MenuLocation.MenuLocation_ActivityContextMenu_1, 1 );
        await shellFrame.Commands.AddCustomCommandToMenu( commandIconICOId, MFiles.MenuLocation.MenuLocation_ActivityContextMenu_1, 1 );
        await shellFrame.Commands.AddCustomCommandToMenu( commandIconJPGPathId, MFiles.MenuLocation.MenuLocation_ActivityContextMenu_1, 1 );
        await shellFrame.Commands.AddCustomCommandToMenu( commandIconJPEGPathId, MFiles.MenuLocation.MenuLocation_ActivityContextMenu_1, 1 );

        // Add commands to taskbar.
        await shellFrame.Commands.AddCustomCommandToMenu( commandIconSVGPathId,  MFiles.MenuLocation.MenuLocation_TaskBar_MainActions, 1 );
        await shellFrame.Commands.AddCustomCommandToMenu( commandIconSVGBase64Id, MFiles.MenuLocation.MenuLocation_TaskBar_MainActions, 1 );
        await shellFrame.Commands.AddCustomCommandToMenu( commandIconSVGStringId, MFiles.MenuLocation.MenuLocation_TaskBar_MainActions, 1 );
        await shellFrame.Commands.AddCustomCommandToMenu( commandIconPNGPathId, MFiles.MenuLocation.MenuLocation_TaskBar_MainActions, 1 );
        await shellFrame.Commands.AddCustomCommandToMenu( commandIconICOId, MFiles.MenuLocation.MenuLocation_TaskBar_MainActions, 1 );
        await shellFrame.Commands.AddCustomCommandToMenu( commandIconJPGPathId, MFiles.MenuLocation.MenuLocation_TaskBar_MainActions, 1 );  
        await shellFrame.Commands.AddCustomCommandToMenu( commandIconJPEGPathId, MFiles.MenuLocation.MenuLocation_TaskBar_MainActions, 1 );

        // Register to be notified when a custom command is clicked.
        // Note: this will fire for ALL custom commands, so we need to filter out others.
        shellFrame.Commands.Events.Register(
            MFiles.Event.CustomCommand,
            async ( commandId ) => {

                // Handle command clicks.
            } );
    };
}

alt text

Adding an builtin icon​

An builtin icon for a command can be added similar way than normal icon by calling SetIcon with icon information interface. Builtin icon can be added to every menu location as well.

main.js
function OnNewShellUI( shellUI ) {

    /// <summary>Executed by the UIX when a ShellUI module is started.</summary>
    /// <param name="shellUI" type="MFiles.ShellUI">The shell UI object which was created.</param>

    // This is the start point of a ShellUI module.

    // Register to be notified when a new shell frame (MFiles.Event.NewShellFrame) is created.
    shellUI.Events.Register(
        MFiles.Event.NewShellFrame,
        handleNewShellFrame );
}

function handleNewShellFrame( shellFrame ) {

    /// <summary>Handles the OnNewShellFrame event for an IShellUI.</summary>
    /// <param name="shellFrame" type="MFiles.ShellFrame">The shell frame object which was created.</param>

    // The shell frame was created but it cannot be used yet.
    // The following line would throw an exception ("The object cannot be accessed, because it is not ready."):
    // shellFrame.ShowMessage('A shell frame was created');

    // Register to be notified when the shell frame is started.
    shellFrame.Events.Register(
        MFiles.Event.Started,
        getShellFrameStartedHandler( shellFrame ) );
}

function getShellFrameStartedHandler( shellFrame )  {

    /// <summary>Returns a function which handles the OnStarted event for an IShellFrame.</summary>

    // The shell frame is now started and can be used.

    return async () => {

        // Some builtin icons and their values.
        const builtInIcons = [
            { name: "CheckOut", value: 0 },
            { name: "CheckIn", value: 1 },
            { name: "Undo", value: 13 },
        ];

        // Create commands and set built-in icons.
        for (const bi of builtInIcons) {

            // Create command for corresponding icon.
            const cmdId = await shellFrame.Commands.CreateCustomCommand(`Built-in: ${bi.name}`);

            // Construct icon information and set icon.
            const iconInfo = { content: bi.value, iconContentType: "BUILT_IN", alt: `${bi.name} built-in icon`, extension: "" };
            await shellFrame.Commands.SetIcon(cmdId, iconInfo);

            // Add to a all menus so you can see it in different places.
            await shellFrame.Commands.AddCustomCommandToMenu(cmdId, MFiles.MenuLocation.MenuLocation_TopPaneMenu, 1);
            await shellFrame.Commands.AddCustomCommandToMenu(cmdId, MFiles.MenuLocation.MenuLocation_ContextMenu_Bottom, 1);
            await shellFrame.Commands.AddCustomCommandToMenu(cmdId, MFiles.MenuLocation.MenuLocation_ActivityContextMenu_1, 1);
            await shellFrame.Commands.AddCustomCommandToMenu(cmdId, MFiles.MenuLocation.MenuLocation_TaskBar_MainActions, 1);
        }

        // Register to be notified when a custom command is clicked.
        // Note: this will fire for ALL custom commands, so we need to filter out others.
        shellFrame.Commands.Events.Register(
            MFiles.Event.CustomCommand,
            async ( commandId ) => {

                // Handle command clicks.
            } );
    };
}

alt text

- - + + \ No newline at end of file diff --git a/Frameworks/User-Interface-Extensibility-Framework/Reference/Samples/HelloWorld/index.html b/Frameworks/User-Interface-Extensibility-Framework/Reference/Samples/HelloWorld/index.html index 4d2db65b3..6d4e2ef2e 100644 --- a/Frameworks/User-Interface-Extensibility-Framework/Reference/Samples/HelloWorld/index.html +++ b/Frameworks/User-Interface-Extensibility-Framework/Reference/Samples/HelloWorld/index.html @@ -4,14 +4,14 @@ Hello, World | M-Files User Interface Extensibility Framework - - + +
Skip to main content

Hello, World

⚠️ Note

Sample codes are for demonstration purposes only. Before using in production, add proper error handling such as try-catch blocks, null checks, and input validation.

Overview​

This sample creates a basic User Interface Extensibility Framework application consisting of one ShellUI module which shows a dialog box to the user when the shell frame is available. The shell frame is a useful object as it allows us to interact with the shell listings and commands (such as buttons) within the user interface.

Creating a local development folder​

Firstly, let’s create a local development folder for the application.

alt text

Creating the application definition file​

Into this folder we will create an application definition file. This file must be named appdef.xml. The application will use version 5 of the client schema (as we are only targeting newer M-Files versions). The application will declare a single Shell UI module (with its code in main.js), and no dashboards.

appdef.xml
<?xml version="1.0"?>
<application xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="http://www.m-files.com/schemas/appdef-client-v5.xsd">
    <guid>5EA29AF2-1EC9-4AB7-A0D1-FE1D586310D4</guid>
    <name>Hello, World</name>
    <version>0.1</version>
    <description>A basic application showing how to react to the shell frame being available.</description>
    <publisher>M-Files Corporation</publisher>
    <enabled-by-default>true</enabled-by-default>
    <modules>
        <module environment="shellui">
        <file>main.js</file>
        </module>
    </modules>
</application>
Ensure that your application has a unique GUID by using a GUID generator.

Creating the module​

Next we will create a module file to contain our actual application logic. The logic will be simple:

  • We will declare a default entry point for the ShellUI module.
  • We will react to the NewShellFrame event and obtain a reference to the shell frame.
  • We will react to the shell frame’s Started event (as using the shell frame before this point will result in an exception).
  • We will display a message to the user that the shell frame is ready for use.
main.js
function OnNewShellUI(shellUI) {
  /// <summary>Executed by the UIX when a ShellUI module is started.</summary>
  /// <param name="shellUI" type="MFiles.ShellUI">The shell UI object which was created.</param>

  // This is the start point of a ShellUI module.

  // Register to be notified when a new shell frame (MFiles.Event.NewShellFrame) is created.
  shellUI.Events.Register(MFiles.Event.NewShellFrame, handleNewShellFrame);
}

function handleNewShellFrame(shellFrame) {
  /// <summary>Handles the OnNewShellFrame event for an IShellUI.</summary>
  /// <param name="shellFrame" type="MFiles.ShellFrame">The shell frame object which was created.</param>

  // The shell frame was created but it cannot be used yet.
  // The following line would throw an exception ("The object cannot be accessed, because it is not ready."):
  // shellFrame.ShowMessage('A shell frame was created');

  // Register to be notified when the shell frame is started.
  // This time pass a reference to the function to call when the event is fired.
  shellFrame.Events.Register(
    MFiles.Event.Started,
    getShellFrameStartedHandler(shellFrame),
  );
}

function getShellFrameStartedHandler(shellFrame) {
  /// <summary>Returns a function which handles the OnStarted event for an IShellFrame.</summary>

  return async () => {
    // The shell frame is now started and can be used.
    // Note: we need to use the global-scope variable.
    await shellFrame.ShowMessage('A shell frame is available for use.');
  };
}

Deploying the application​

To deploy the application:

  1. Zip the contents of the local development folder (e.g. HelloWorld.zip).
  2. Open the M-Files Admin tool and connect to your M-Files server.
  3. Right-click on the vault to install the application to.
  4. Select Applications.
  5. Click Install... and select the zip file.
  6. Click Open and the application should be listed.

alt text

The zipped file can be renamed to have a .mfappx extension if you wish to differentiate it from other zip files.

Testing the application​

Open M-Files web and navigate to the vault. The following message should be shown on-screen:

alt text

- - + + \ No newline at end of file diff --git a/Frameworks/User-Interface-Extensibility-Framework/Reference/Samples/ObjectOperationSupport/index.html b/Frameworks/User-Interface-Extensibility-Framework/Reference/Samples/ObjectOperationSupport/index.html index d52f5346d..2655fac41 100644 --- a/Frameworks/User-Interface-Extensibility-Framework/Reference/Samples/ObjectOperationSupport/index.html +++ b/Frameworks/User-Interface-Extensibility-Framework/Reference/Samples/ObjectOperationSupport/index.html @@ -4,15 +4,15 @@ Interacting with object operation events | M-Files User Interface Extensibility Framework - - + +
Skip to main content

Interacting with object operation events

⚠️ Note

Sample codes are for demonstration purposes only. Before using in production, add proper error handling such as try-catch blocks, null checks, and input validation.

Overview​

This sample shows how to support object operation events in the ShellUI module by registering event handlers in OnNewShellUI.

The sample implementation demonstrates checkout-related events:

  • CheckOutObjects (before operation)
  • ObjectsCheckedOut (after operation)

You can apply the same pattern to other object operations supported by ShellUI Events.

Creating the application structure​

Creating the application definition file​

appdef.xml
<?xml version="1.0" encoding="utf-8"?>
<application xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="http://www.m-files.com/schemas/appdef-client-v5.xsd">
    <guid>e5236c84-a251-4611-b1cf-12549a05c86a</guid>
    <name>UIExt2</name>
    <version>1.1.1</version>
    <description>Blocks document check out requests when in a controlled state</description>
    <publisher>M-Files Corporation</publisher>
    <copyright>Copyright M-Files Corporation</copyright>
    <enabled-by-default>true</enabled-by-default>
    <modules>
        <module environment="shellui">
            <file>main.js</file>
        </module>
    </modules>
</application>

Object operation event pattern​

Use this pattern for each object operation event:

  1. Register the event in OnNewShellUI.
  2. Read event payload values.
  3. Run validation or business rules.
  4. Return a promise that resolves to true when logic is satisfied, or reject/return an error object to block the operation with additional concern to the user.

Example: CheckOutObjects (before operation)​

This example validates selected objects belongs to document type before checkout.
If validation fails, checkout is blocked and an error message is shown.

main.js
function OnNewShellUI(shellUI) {
    
    // CheckOutObjects - Before checkout is requested
    shellUI.Events.Register(MFiles.Event.CheckOutObjects, function(objIds) {

        // Check each object being checked out - Blocks for objects other than documents.
        for (var i = 0; i < objIds.length; i++) {
         
            // Skip check if the object is not a document.
            if (objIds[i].type !== 0) {
                return new Error( "Document objects are only allowed to checkout" );
            }
        }
        
        // All checks passed, allowing checkout
        return Promise.resolve(true);
    });

}

Rejecting the promise by returning an Error object with a user message displays a dialog like the image below.

alt text

Example: ObjectsCheckedOut (after operation)​

This example runs after checkout succeeds.
It builds a user-facing summary and shows a confirmation message.

main.js
function OnNewShellUI(shellUI) {

    // ObjectsCheckedOut - After checkout succeeded
    shellUI.Events.Register(MFiles.Event.ObjectsCheckedOut, function(checkedOutVersions, previousVersions) {
      
        // Build a message showing the checked out object versions
        var message = "Successfully checked out:\n";
        for (var i = 0; i < checkedOutVersions.length; i++) {
            var versionInfo = checkedOutVersions[i].object_version?.version_info;
            
            message += "\n- Title: " + (versionInfo?.title || "Unknown");
            message += ", Version: " + (versionInfo?.version?.internal_version || "?");
        }

        // Show message to user.
        shellUI.ShowMessage({
            caption: "Checkout Successful",
            message: message,
            icon: "info",
            button1_title: "Ok",
            defaultButton: 1,
            cancelButton: 1
        });
    });

}

- - + + \ No newline at end of file diff --git a/Frameworks/User-Interface-Extensibility-Framework/Reference/Samples/PopUpDashboardWithAccentColor/index.html b/Frameworks/User-Interface-Extensibility-Framework/Reference/Samples/PopUpDashboardWithAccentColor/index.html index 98788552b..0a1645718 100644 --- a/Frameworks/User-Interface-Extensibility-Framework/Reference/Samples/PopUpDashboardWithAccentColor/index.html +++ b/Frameworks/User-Interface-Extensibility-Framework/Reference/Samples/PopUpDashboardWithAccentColor/index.html @@ -4,14 +4,14 @@ PopUp Dashboard | M-Files User Interface Extensibility Framework - - + +
Skip to main content

PopUp Dashboard

⚠️ Note

Sample codes are for demonstration purposes only. Before using in production, add proper error handling such as try-catch blocks, null checks, and input validation.

Overview​

In this sample we use a Visual Studio 2022 template that is provided by M-Files to create a simple a basic User Interface Extensibility Framework application.

This sample consisting of one ShellUI module which adds one button to main menu and it will opens one dashboard to the popup. Also it shows how accent color option can be retrived and used in our UI extesion applicaton.

Downloading the Template​

The UIX templates are part of the M-Files Online Visual Studio template package, which can be downloaded from the Visual Studio Marketplace.

The application structure​

The application definition file​

In the App folder there is a file named appdef.xml, the application manifest file, containing information such as the publisher details and the current version number. We modified existing manifest file according on our sample application. The application will use version 5 of the client schema (as we are only targeting newer M-Files versions). The application will declare a single Shell UI module (with its code in main.js).

appdef.xml
<?xml version="1.0"?>
<application xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="http://www.m-files.com/schemas/appdef-client-v5.xsd">
  <guid>83A5DD0A-E386-454E-B5AB-3D52AF13B7C3</guid>
  <name>PopUp Dashboard</name>
  <version>0.1</version>
  <description>A basic application showing how to work with popup dashboards.</description>
  <publisher>M-Files Corporation</publisher>
  <enabled-by-default>true</enabled-by-default>
  <modules>
    <module environment="shellui">
      <file>main.js</file>
    </module>
  </modules>
  <dashboards>
    <dashboard id="MyPopUpDashboard">
      <content>index.html</content>
    </dashboard>
  </dashboards>
</application>

Ensure that your application has a unique GUID by using a GUID generator.

Creating the module​

Next we will create a module file to contain our actual application logic. At this point we will just register to be notified of main lifecycle events:

  • We will declare a default entry point for the ShellUI module.
  • We will react to the OnNewShellUI event and obtain a reference to the shell frame.
  • We will react to the shell frame’s onStarted event (as using the shell frame before this point will result in an exception).
main.js
function OnNewShellUI(shellUI) {
  /// <summary>Executed by the UIX when a ShellUI module is started.</summary>
  /// <param name="shellUI" type="MFiles.ShellUI">The shell UI object which was created.</param>

  // This is the start point of a ShellUI module.

  // Register to be notified when a new shell frame (MFiles.Event.NewShellFrame) is created.
  shellUI.Events.Register(MFiles.Event.NewShellFrame, handleNewShellFrame);
}

function handleNewShellFrame(shellFrame) {
  // Add tab to right pane, when the shell frame is started.
  shellFrame.Events.Register(MFiles.Event.Started, onStarted);

  // NOTE: to be on the safe side, handle the callback in "async" function and await all the
  // return values, because when the postMessage API is used, all return values will be async.
  async function onStarted() {}
}

Creating a button in the main menu​

Adding a button into the main menu involves two steps:

  1. Creating a new ICommand using CreateCustomCommand.
  2. Adding the command into the task area using AddCustomCommandToMenu.
main.js
function OnNewShellUI(shellUI) {
  /// <summary>Executed by the UIX when a ShellUI module is started.</summary>
  /// <param name="shellUI" type="MFiles.ShellUI">The shell UI object which was created.</param>

  // This is the start point of a ShellUI module.

  // Register to be notified when a new shell frame (MFiles.Event.NewShellFrame) is created.
  shellUI.Events.Register(MFiles.Event.NewShellFrame, handleNewShellFrame);
}

function handleNewShellFrame(shellFrame) {
  // Add tab to right pane, when the shell frame is started.
  shellFrame.Events.Register(MFiles.Event.Started, onStarted);

  // NOTE: to be on the safe side, handle the callback in "async" function and await all the
  // return values, because when the postMessage API is used, all return values will be async.
  async function onStarted() {
    const myCommand = await shellFrame.Commands.CreateCustomCommand(
      'Show my popup dashboard',
    );
    await shellFrame.Commands.AddCustomCommandToMenu(
      myCommand,
      MFiles.MenuLocation.MenuLocation_TopPaneMenu,
      1,
    );
  }
}

Logging into the M-Files vault should now show a button in the main menu (three dot menu near user icon) with the text Show my popup dashboard:

alt text

Creating the dashboard​

Next we will create a dashboard file that will be shown in the popup. It involves two steps:

  1. Modifying existing index.html file which will load styles and dashboard handler.
  2. Modifying existing dashboard.js file which will handle the dashboard.
index.html
<!doctype html>
<html lang="en">
  <head>
    <title>My Popup Dashboard</title>
    <script src="mfiles.extensibility.protocol.js"></script>

    <!-- Load styles and dashboard handler js file -->
    <link href="style.css" rel="stylesheet" />
    <script src="dashboard.js"></script>
  </head>
  <body>
    <div id="content">
      <h2>Welcome to M-Files!</h2>
    </div>
  </body>
</html>

Create dashboard handler using OnNewDashboard event.

dashboard.js
async function OnNewDashboard(dashboard) {}

Show the dashboard on clicking button​

Showing dashboard while clicking a command clicked involves three steps:

  • Register to be notified of the CustomCommand event.
  • Ensure that the command that was clicked was the one we want to handle.
  • Call ShowPopupDashboard from shellframe instance. We will have three parameters for this ShowPopupDashboard
    1. Id of the dashboard which is mentioned in the appdef.xml. Ex. MyPopUpDashboard
    2. data - Custom data needs to be passed to dashboard.
    3. title - The title of the popup dashboard.
main.js
function OnNewShellUI(shellUI) {
  /// <summary>Executed by the UIX when a ShellUI module is started.</summary>
  /// <param name="shellUI" type="MFiles.ShellUI">The shell UI object which was created.</param>

  // This is the start point of a ShellUI module.

  // Register to be notified when a new shell frame (MFiles.Event.NewShellFrame) is created.
  shellUI.Events.Register(MFiles.Event.NewShellFrame, handleNewShellFrame);
}

function handleNewShellFrame(shellFrame) {
  // Add tab to right pane, when the shell frame is started.
  shellFrame.Events.Register(MFiles.Event.Started, onStarted);

  // NOTE: to be on the safe side, handle the callback in "async" function and await all the
  // return values, because when the postMessage API is used, all return values will be async.
  async function onStarted() {
    const myCommand = await shellFrame.Commands.CreateCustomCommand(
      'Show my popup dashboard',
    );
    await shellFrame.Commands.AddCustomCommandToMenu(
      myCommand,
      MFiles.MenuLocation.MenuLocation_TopPaneMenu,
      1,
    );
    await shellFrame.Commands.Events.Register(
      MFiles.Event.CustomCommand,
      (command) => {
        // Execute only our custom command.
        if (command === myCommand) {
          shellFrame.ShowPopupDashboard(
            'MyPopUpDashboard',
            {},
            'My popup dashboard',
          );
        }
      },
    );
  }
}

alt text

Using accent color​

In the M-files Admin you can specify the accent color that you want to use in M-Files Web. The accent color has an effect, for example, on the header, the scrollbars, and some of the icons.

You can set the accent color value in Configurations -> Advanced Value Settings -> Configuration -> Client -> Web -> Appearance

alt text

We can retrive the accent color value and use it in our custom extension application.

dashboard.js
async function OnNewDashboard(dashboard) {
  const accentColor = await MFiles.GetAccentColor();
  document
    .querySelector(':root')
    .style.setProperty('--scrollbar-thumb-color', accentColor);
  document.getElementById('accentColorValue').textContent = accentColor;
}
index.html
<!doctype html>
<html lang="en">
  <head>
    <title>My Popup Dashboard</title>
    <script src="mfiles.extensibility.protocol.js"></script>

    <!-- Load styles and dashboard handler js file -->
    <link href="style.css" rel="stylesheet" />
    <script src="dashboard.js"></script>
  </head>
  <body>
    <div id="content">
      <h2>A simple scrollable DIV</h2>
      <div>Accent color: <span id="accentColorValue"></span></div>
      <div id="scrollableDIV">
        <h3>AI-Driven Automation</h3>
        <p>
          M-Files helps automate the entire knowledge work process from document
          creation and management to workflow automation, external
          collaboration, enterprise search, security, compliance, and audit
          trail.
        </p>
        <p>
          Powered by M-Files' generative AI technology, M-Files Aino, the
          platform helps organize information, understand the context of
          documents, and interact with their organization's knowledge using
          natural language.
        </p>

        <h3>Organize your content</h3>
        <p>
          M-Files adapts to the document flow and content of any organization.
          Classifying documents and extracting their meaning optimizes knowledge
          worker productivity by automating routines and ensuring information
          can be easily found and used in the proper business context.
        </p>
      </div>
    </div>
  </body>
</html>
style.css
html,
body {
  font-family: Lato, 'Segoe UI', Sans-Serif;
  margin: 0;
  background: #fff;
  height: 100%;
  font-size: 14px;
  padding: 0 10px;
}

:root {
  --scrollbar-thumb-color: black;
}

div {
  padding: 4px 0;
}

span {
  font-weight: 500;
}

#scrollableDIV {
  height: 200px;
  overflow-y: scroll;
  scrollbar-color: var(--scrollbar-thumb-color) lightgray;
}

Now we can see scrollbar has same color as the accent color that we have set on M-Files Admin.

alt text

- - + + \ No newline at end of file diff --git a/Frameworks/User-Interface-Extensibility-Framework/Reference/Samples/PopupDashboard/index.html b/Frameworks/User-Interface-Extensibility-Framework/Reference/Samples/PopupDashboard/index.html index 8f0d8a031..ffc3ccd21 100644 --- a/Frameworks/User-Interface-Extensibility-Framework/Reference/Samples/PopupDashboard/index.html +++ b/Frameworks/User-Interface-Extensibility-Framework/Reference/Samples/PopupDashboard/index.html @@ -4,14 +4,14 @@ PopUp Dashboard | M-Files User Interface Extensibility Framework - - + +
Skip to main content

PopUp Dashboard

⚠️ Note

Sample codes are for demonstration purposes only. Before using in production, add proper error handling such as try-catch blocks, null checks, and input validation.

Overview​

This sample creates a basic User Interface Extensibility Framework application consisting of one ShellUI module which adds one button to main menu and it will opens one dashboard to the popup.

This sample does not show how to create a local development folder or to deploy the code to the M-Files server. It is assumed that a local development folder already exists, and that is the location in which the development is occurring.

Creating the application structure​

Creating the application definition file​

Into this folder we will create an application definition file. This file must be named appdef.xml. The application will use version 5 of the client schema (as we are only targeting newer M-Files versions). The application will declare a single Shell UI module (with its code in main.js), and no dashboards.

appdef.xml
<?xml version="1.0"?>
<application xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="http://www.m-files.com/schemas/appdef-client-v5.xsd">
    <guid>83A5DD0A-E386-454E-B5AB-3D52AF13B7C3</guid>
    <name>PopUp Dashboard</name>
    <version>0.1</version>
    <description>A basic application showing how to work with dashboards.</description>
    <publisher>M-Files Corporation</publisher>
    <enabled-by-default>true</enabled-by-default>
    <modules>
        <module environment="shellui">
            <file>main.js</file>
        </module>
    </modules>
    <dashboards>
        <dashboard id="MySample">
            <content>index.html</content>
        </dashboard>
    </dashboards>
</application>

Ensure that your application has a unique GUID by using a GUID generator.

Creating the module​

Next we will create a module file to contain our actual application logic. At this point we will just register to be notified of main lifecycle events:

  • We will declare a default entry point for the ShellUI module.
  • We will react to the NewShellFrame event and obtain a reference to the shell frame.
  • We will react to the shell frame’s Started event (as using the shell frame before this point will result in an exception).
main.js
function OnNewShellUI(shellUI) {
  /// <summary>Executed by the UIX when a ShellUI module is started.</summary>
  /// <param name="shellUI" type="MFiles.ShellUI">The shell UI object which was created.</param>

  // This is the start point of a ShellUI module.

  // Register to be notified when a new shell frame (MFiles.Event.NewShellFrame) is created.
  shellUI.Events.Register(MFiles.Event.NewShellFrame, handleNewShellFrame);
}

function handleNewShellFrame(shellFrame) {
  /// <summary>Handles the OnNewShellFrame event for an IShellUI.</summary>
  /// <param name="shellFrame" type="MFiles.ShellFrame">The shell frame object which was created.</param>

  // The shell frame was created but it cannot be used yet.
  // The following line would throw an exception ("The object cannot be accessed, because it is not ready."):
  // shellFrame.ShowMessage('A shell frame was created');

  // Register to be notified when the shell frame is started.
  shellFrame.Events.Register(
    MFiles.Event.Started,
    getShellFrameStartedHandler(shellFrame),
  );
}

function getShellFrameStartedHandler(shellFrame) {
  /// <summary>Returns a function which handles the OnStarted event for an IShellFrame.</summary>

  // The shell frame is now started and can be used.

  return async () => {};
}

Creating a button in the main menu​

Adding a button into the main menu involves two steps:

  1. Creating a new ICommand using CreateCustomCommand.
  2. Adding the command into the main menu using AddCustomCommandToMenu.
main.js
function OnNewShellUI(shellUI) {
  /// <summary>Executed by the UIX when a ShellUI module is started.</summary>
  /// <param name="shellUI" type="MFiles.ShellUI">The shell UI object which was created.</param>

  // This is the start point of a ShellUI module.

  // Register to be notified when a new shell frame (MFiles.Event.NewShellFrame) is created.
  shellUI.Events.Register(MFiles.Event.NewShellFrame, handleNewShellFrame);
}

function handleNewShellFrame(shellFrame) {
  /// <summary>Handles the OnNewShellFrame event for an IShellUI.</summary>
  /// <param name="shellFrame" type="MFiles.ShellFrame">The shell frame object which was created.</param>

  // The shell frame was created but it cannot be used yet.
  // The following line would throw an exception ("The object cannot be accessed, because it is not ready."):
  // shellFrame.ShowMessage('A shell frame was created');

  // Register to be notified when the shell frame is started.
  shellFrame.Events.Register(
    MFiles.Event.Started,
    getShellFrameStartedHandler(shellFrame),
  );
}

function getShellFrameStartedHandler(shellFrame) {
  /// <summary>Returns a function which handles the OnStarted event for an IShellFrame.</summary>

  // The shell frame is now started and can be used.

  return async () => {
    // Create a command (button).  Note that it is not yet visible.
    const showViewHistoryCmd =
      await shellFrame.Commands.CreateCustomCommand('Show view history');

    // Add the first command to the main menu.
    await shellFrame.Commands.AddCustomCommandToMenu(
      showViewHistoryCmd,
      MFiles.MenuLocation.MenuLocation_TopPaneMenu,
      1,
    );

    // Set command visility.
    await shellFrame.Commands.SetCommandState(
      showViewHistoryCmd,
      MFiles.CommandLocation.MainMenu,
      MFiles.CommandState.CommandState_Active,
    );
  };
}

Logging into the M-Files vault should now show a button in the main menu (three dot menu near user icon) with the text Show view history:

alt text

Creating the dashboard​

Next we will create a dashboard file that will be shown in the popup. It involves two steps:

  1. Create a index.html file which will load styles and dashboard handler
  2. Create a dashboard.js file which will handle the dashboard.
index.html
<!doctype html>
<html lang="en">
  <head>
    <title>Sample</title>
    <script src="mfiles.extensibility.protocol.js"></script>

    <!-- Load styles and dashboard handler js file -->
    <link href="style.css" rel="stylesheet" />
    <script src="dashboard.js"></script>
  </head>
  <body>
    <div id="content"></div>
  </body>
</html>

Create dashboard handler file using OnNewDashboard event. Once the dashboard started, the html content will be loaded and the content will be updated.

dashboard.js
function OnNewDashboard(dashboard) {
  /// <summary>Executed by the UIX when a dashboared is started.</summary>
  /// <param name="dashboard" type="MFiles.Dashboard">The dashboard object which was created.</param>

  // Register a handler to listen the started event.
  dashboard.Events.Register(MFiles.Event.Started, () => {
    // Get the element from the UI.
    const contentElement = document.getElementById('content');

    // Prepare the html content that to be updated.
    const htmlContent = '<div> Hello world!</div>';

    // Update the content.
    contentElement.innerHTML = htmlContent;
  });
}

Show the dashboard on clicking button​

Showing dashboard while clicking a command clicked involves three steps:

  • Register to be notified of the CustomCommand event.
  • Ensure that the command that was clicked was the one we want to handle.
  • Call ShowPopupDashboard from shellframe instance. We will have three parameters for this ShowPopupDashboard
    1. Id of the dashboard which is mentioned in the appdef.xml. Ex. MySample
    2. customData - Data needs to be passed to dashboard.
    3. title - The title for the dashboard.
main.js
function OnNewShellUI(shellUI) {
  /// <summary>Executed by the UIX when a ShellUI module is started.</summary>
  /// <param name="shellUI" type="MFiles.ShellUI">The shell UI object which was created.</param>

  // This is the start point of a ShellUI module.

  // Register to be notified when a new shell frame (MFiles.Event.NewShellFrame) is created.
  shellUI.Events.Register(MFiles.Event.NewShellFrame, handleNewShellFrame);
}

function handleNewShellFrame(shellFrame) {
  /// <summary>Handles the OnNewShellFrame event for an IShellUI.</summary>
  /// <param name="shellFrame" type="MFiles.ShellFrame">The shell frame object which was created.</param>

  // The shell frame was created but it cannot be used yet.
  // The following line would throw an exception ("The object cannot be accessed, because it is not ready."):
  // shellFrame.ShowMessage('A shell frame was created');

  // Register to be notified when the shell frame is started.
  shellFrame.Events.Register(
    MFiles.Event.Started,
    getShellFrameStartedHandler(shellFrame),
  );
}

function getShellFrameStartedHandler(shellFrame) {
  /// <summary>Returns a function which handles the OnStarted event for an IShellFrame.</summary>

  // The shell frame is now started and can be used.

  return async () => {
    // Create a command (button).  Note that it is not yet visible.
    const showViewHistoryCmd =
      await shellFrame.Commands.CreateCustomCommand('Show view history');

    // Add the first command to the main menu.
    await shellFrame.Commands.AddCustomCommandToMenu(
      showViewHistoryCmd,
      MFiles.MenuLocation.MenuLocation_TopPaneMenu,
      1,
    );

    // Set command visility.
    await shellFrame.Commands.SetCommandState(
      showViewHistoryCmd,
      MFiles.CommandLocation.MainMenu,
      MFiles.CommandState.CommandState_Active,
    );

    // Register to be notified when a custom command is clicked.
    // Note: this will fire for ALL custom commands, so we need to filter out others.
    shellFrame.Commands.Events.Register(
      MFiles.Event.CustomCommand,
      async (command) => {
        // Execute only our custom command.
        if (command === showViewHistoryCmd) {
          // Show popup dashboard with custom data.
          await shellFrame.ShowPopupDashboard('MySample', {}, 'Views Hisotry');
        }
      },
    );
  };
}

alt text

Passing custom data to the dashboard​

On each view location change, the current path is stored in an array which will be passed to the dashboard while clicking the button in the main menu. We must be able to react to view location change.

We will:

  • React to the ViewLocationChange event.
  • Store both view id and view path information to the array.
  • Store the history in the web storage
  • Pass the viewsHistory value to the dashboard as customData.
main.js
function OnNewShellUI(shellUI) {
  /// <summary>Executed by the UIX when a ShellUI module is started.</summary>
  /// <param name="shellUI" type="MFiles.ShellUI">The shell UI object which was created.</param>

  // This is the start point of a ShellUI module.

  // Register to be notified when a new shell frame (MFiles.Event.NewShellFrame) is created.
  shellUI.Events.Register(MFiles.Event.NewShellFrame, handleNewShellFrame);
}

function handleNewShellFrame(shellFrame) {
  /// <summary>Handles the OnNewShellFrame event for an IShellUI.</summary>
  /// <param name="shellFrame" type="MFiles.ShellFrame">The shell frame object which was created.</param>

  // The shell frame was created but it cannot be used yet.
  // The following line would throw an exception ("The object cannot be accessed, because it is not ready."):
  // shellFrame.ShowMessage('A shell frame was created');

  // Register to be notified when the shell frame is started.
  shellFrame.Events.Register(
    MFiles.Event.Started,
    getShellFrameStartedHandler(shellFrame),
  );

  // Register to be notified when the view location changed.
  shellFrame.Events.Register(
    MFiles.Event.ViewLocationChanged,
    getViewLocationChangedHandler(shellFrame),
  );
}

function getShellFrameStartedHandler(shellFrame) {
  /// <summary>Returns a function which handles the OnStarted event for an IShellFrame.</summary>

  // The shell frame is now started and can be used.

  return async () => {
    // Create a command (button).  Note that it is not yet visible.
    const showViewHistoryCmd =
      await shellFrame.Commands.CreateCustomCommand('Show view history');

    // Add the first command to the main menu.
    await shellFrame.Commands.AddCustomCommandToMenu(
      showViewHistoryCmd,
      MFiles.MenuLocation.MenuLocation_TopPaneMenu,
      1,
    );

    // Set command visility.
    await shellFrame.Commands.SetCommandState(
      showViewHistoryCmd,
      MFiles.CommandLocation.MainMenu,
      MFiles.CommandState.CommandState_Active,
    );

    // Register to be notified when a custom command is clicked.
    // Note: this will fire for ALL custom commands, so we need to filter out others.
    shellFrame.Commands.Events.Register(
      MFiles.Event.CustomCommand,
      async (command) => {
        // Execute only our custom command.
        if (command === showViewHistoryCmd) {
          // Get view history from the storage.
          const viewHistoryString =
            await MFiles.ReadFromWebStorage('viewsHistory');
          let viewsHistory = [];
          if (viewHistoryString) {
            viewsHistory = JSON.parse(viewHistoryString);
          }

          // Show popup dashboard with custom data.
          await shellFrame.ShowPopupDashboard(
            'MySample',
            {
              viewsHistory: viewsHistory,
            },
            'Views History',
          );
        }
      },
    );
  };
}

function getViewLocationChangedHandler(shellFrame) {
  /// <summary>Returns a function which handles the OnViewLocationChange event.</summary>

  return async () => {
    // Get the view history from storage.
    const viewHistoryString = await MFiles.ReadFromWebStorage('viewsHistory');
    let viewHistory = [];

    // Parse the view history from the string.
    if (viewHistoryString) {
      viewHistory = JSON.parse(viewHistoryString);
    }

    // Prepare the current view object.
    viewHistory.push({
      time: Date.now(),
      viewUrl: shellFrame.CurrentUrl,
      viewPath: shellFrame.CurrentPath || 'All',
    });

    // Write viewhistory to web storage.
    await MFiles.WriteToWebStorage('viewsHistory', JSON.stringify(viewHistory));
  };
}

Handling custom data in the dashboard handler​

Custom data will be available in the dashboard instance.

dashboard.js
function OnNewDashboard(dashboard) {
  /// <summary>Executed by the UIX when a dashboared is started.</summary>
  /// <param name="dashboard" type="MFiles.Dashboard">The dashboard object which was created.</param>

  // Get the viewshistory and sort items in descending order.
  let viewsHistory = dashboard.CustomData.viewsHistory || [];
  viewsHistory = viewsHistory.sort((a, b) => b.time - a.time);

  // Register a handler to listen the started event.
  dashboard.Events.Register(MFiles.Event.Started, () => {
    // Get the element from the UI.
    const contentElement = document.getElementById('content');

    // Prepare the html content that to be updated.
    const htmlContent = `
                <div class="label">Your view history</div>
                ${viewsHistory
                  .map((value) => {
                    return `<div class="history-item">
                            <div class="viewid">${value.viewUrl} </div> 
                            <div class="viewpath">- ${value.viewPath} </div> 
                        </div>`;
                  })
                  .join('')}
            `;

    // Update the content.
    contentElement.innerHTML = htmlContent;
  });
}
style.css
html,
body {
  font-family: Lato, 'Segoe UI', Sans-Serif;
  margin: 0;
  background: #fff;
  height: 100%;
  color: #363a40;
  font-size: 14px;
  padding: 0 10px;
}

div {
  padding: 4px 0;
}

span {
  font-size: 18px;
  font-weight: 500;
}

.label {
  font-size: 18px;
  font-weight: 500;
  color: #318ccc;
  margin-top: 13px;
}

.history-item {
  width: calc(100% - 30px);
  height: 25px;
  margin: 2px 0;
  padding: 2px 15px;
  background: #e7e6e6;
  border-radius: 15px;
}

.viewid {
  display: inline-block;
  width: 30%;
}

.viewpath {
  display: inline-block;
  width: 69%;
}

Testing the application​

Open M-Files web and navigate to the different views. Now click Show view history buttin from the main menu.

alt text

- - + + \ No newline at end of file diff --git a/Frameworks/User-Interface-Extensibility-Framework/Reference/Samples/SandboxAttributesSupport/index.html b/Frameworks/User-Interface-Extensibility-Framework/Reference/Samples/SandboxAttributesSupport/index.html index 3d2df15cd..8c02e830d 100644 --- a/Frameworks/User-Interface-Extensibility-Framework/Reference/Samples/SandboxAttributesSupport/index.html +++ b/Frameworks/User-Interface-Extensibility-Framework/Reference/Samples/SandboxAttributesSupport/index.html @@ -4,13 +4,13 @@ Creating Sandbox Attributes Support. | M-Files User Interface Extensibility Framework - - + +
Skip to main content

Creating Sandbox Attributes Support.

Overview​

This sample demonstrates how to support sandbox in your application.

Creating the application structure​

Creating the application definition file​

First we should create an application definition file. This file must be named appdef.xml. The application will use version 5 of the client schema (as we are only targeting newer M-Files versions). The application level sandbox attribute will declare in Shell UI module and dashboards.

Supported Attributes​

  • "allow-downloads" // Allow downloading files
  • "allow-popups" // Allow the use of popups
  • "allow-modals" // Allow the use of modal dialogs
  • "allow-forms" // Allow the use of forms
  • "allow-popups-to-escape-sandbox" // Allow popups to escape the sandbox
appdef.xml
<?xml version="1.0"?>
<application xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="http://www.m-files.com/schemas/appdef-client-v5.xsd">
    <guid>94A65B60-1BEC-4B85-A510-6C64A713A717</guid>
    <name>Search Examples</name>
    <version>0.1</version>
    <description>A demonstration application for searches.</description>
    <publisher>M-Files Corporation</publisher>
    <enabled-by-default>true</enabled-by-default>
    <modules>
        <module environment="shellui" sandbox-attributes="allow-popups">
        <file>main.js</file>
        </module>
    </modules>
    <dashboards>
        <dashboard id="TimeZone" sandbox-attributes="allow-popups">
            <content>index.html</content>
        </dashboard>
  </dashboards>
</application>

Ensure that your application has a unique GUID by using a GUID generator.

Supporting for dashboard.​

"This example demonstrates how to open a new browser tab with JavaScript when a button is clicked."

index.html

<!DOCTYPE html>
<html>
<head>
  <title>Window Open Example</title>
  <script src="index.js" defer></script>
</head>
<body>
  <h2>Open Documentation Example</h2>

  <button id="openBtn">Open MDN Docs</button>
</body>
</html>


index.js

/**
 * Opens a new tab with the given documentation URL.
 */
function openDoc() {
  window.open(
    'https://developer.mozilla.org/en-US/docs/Web/API/Window/open'
  );
}

// Attach click event to the button
document.getElementById('openBtn').addEventListener('click', openDoc);

Supporting for Module.​

"This example demonstrates how to open a new browser tab on New ShellUI"

main.js
function OnNewShellUI( shellUI ) {

    // Custom command.
    const customCommands = {};

    /**
     * Register event handler for the shellUI started event.
     *
     * @param Event_Started - Enum for the event.
     * @param {Function} callback - Callback function.
     */
    shellUI.Events.Register( MFiles.Event.Started,
        () => {

            /**
             * Register event handler for the new normal shell frame created event.
             *
             * @param Event_NewShellFrame - Enum for the event.
             * @param {Function} callback - Callback function. Register the hanlder for shellFrame start event & New ShellListing.
             */
            shellUI.Events.Register( MFiles.Event.NewShellFrame,
                ( shellFrame ) => {

                    /**
                     * Register event handler for the shellFrame started event.
                     *
                     * @param Event_Started - Enum for the event.
                     * @param {Function} callback - Callback function.
                     */
                    shellFrame.Events.Register( MFiles.Event.Started,
                        async() => {

                            // Create custom command.
                            customCommands.TestCommand1 = await shellFrame.Commands.CreateCustomCommand( 'TestButton' );

                            // Add Commands to group.
                            shellFrame.Commands.AddCustomCommandToMenu( customCommands.TestCommand1,
                                26, // MenuLocation_ContextMenu_ObjectOperations
                                0 );

                            shellFrame.Commands.Events.Register( MFiles.Event.CustomCommand,
                                ( commandID ) => {

                                    // Test if the command id matches the TestCommand 1
                                    if( commandID === customCommands.TestCommand1 ) {

                                        // Construct alert message object.
                                        const alertMessage = {
                                            message: `TestButton is clicked! CommandID is: ${commandID} and customCommands.TestCommand1 is: ${customCommands.TestCommand1}`,
                                            icon: 'warning'
                                        };
                                        shellFrame.ShowMessage( alertMessage );

                                        // Open New window to navigate with link.
                                        window.open('https://developer.mozilla.org/en-US/docs/Web/API/Window/open');

                                    } else {
                                        const errorMessage = {
                                            message: `TestButton error! CommandID does not match clicked message! ID: ${commandID} and customCommands.TestCommand1 is: ${customCommands.TestCommand1}`,
                                            icon: 'warning'
                                        };
                                        shellFrame.ShowMessage( errorMessage );

                                        // Open New window to navigate with link.
                                        window.open('https://developer.mozilla.org/en-US/docs/Web/API/Window/open');

                                    }
                                } );
                        } );
                } );
        } );
}


- - + + \ No newline at end of file diff --git a/Frameworks/User-Interface-Extensibility-Framework/Reference/Samples/SearchFolderExamples/index.html b/Frameworks/User-Interface-Extensibility-Framework/Reference/Samples/SearchFolderExamples/index.html index 08df29877..9648cde55 100644 --- a/Frameworks/User-Interface-Extensibility-Framework/Reference/Samples/SearchFolderExamples/index.html +++ b/Frameworks/User-Interface-Extensibility-Framework/Reference/Samples/SearchFolderExamples/index.html @@ -4,13 +4,13 @@ Creating search folders | M-Files User Interface Extensibility Framework - - + +
Skip to main content

Creating search folders

⚠️ Note

Sample codes are for demonstration purposes only. Before using in production, add proper error handling such as try-catch blocks, null checks, and input validation.

Overview​

This sample demonstrates how to perform searches using folders.

Creating the application structure​

Creating the application definition file​

First we should create an application definition file. This file must be named appdef.xml. The application will use version 5 of the client schema (as we are only targeting newer M-Files versions). The application will declare a single Shell UI module (with its code in main.js), and no dashboards.

appdef.xml
<?xml version="1.0"?>
<application xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="http://www.m-files.com/schemas/appdef-client-v5.xsd">
    <guid>94A65B60-1BEC-4B85-A510-6C64A713A717</guid>
    <name>Search Examples</name>
    <version>0.1</version>
    <description>A demonstration application for searches.</description>
    <publisher>M-Files Corporation</publisher>
    <enabled-by-default>true</enabled-by-default>
    <modules>
        <module environment="shellui">
        <file>main.js</file>
        </module>
    </modules>
</application>

Ensure that your application has a unique GUID by using a GUID generator.

Creating the module​

Next we will create a module file to contain our actual application logic. Initially:

  • We will declare a default entry point for the ShellUI module
  • We will react to the NewShellFrame event and obtain a reference to the shell frame
  • We will create 5 different command buttons and place them in a menu at the top area
main.js
function OnNewShellUI(shellUI) {
  /// <summary>The entry point of ShellUI module.</summary>
  /// <param name="shellUI" type="MFiles.ShellUI">The new shell UI object.</param>

  // Register to be notified when a new shell frame (Event_NewShellFrame) is created.
  shellUI.Events.Register(MFiles.Event.NewShellFrame, handleNewShellFrame);
}

function handleNewShellFrame(shellFrame) {
  /// <summary>Handles the OnNewShellFrame event for an IShellUI.</summary>
  /// <param name="shellFrame" type="MFiles.ShellFrame">The shell frame object which was created.</param>

  // Register to listen to the started event.
  shellFrame.Events.Register(
    MFiles.Event.Started,
    getShellFrameStartedHandler(shellFrame),
  );
}

function getShellFrameStartedHandler(shellFrame) {
  /// <summary>Gets a function to handle the Started event for shell frame.</summary>
  /// <param name="shellFrame" type="MFiles.ShellFrame">The current shell frame object.</param>
  /// <returns type="MFiles.Events.OnStarted">The event handler.</returns>

  // Return the handler function for ShellFrame's Started event.
  return async () => {
    // Create a command for Search: "estt".
    const textSearchCommandId =
      await shellFrame.Commands.CreateCustomCommand('Search: \"estt\"');
      
    // Create a command for Search: 'Is template' = Yes.
    const propertyTypeSearchCommandId =
      await shellFrame.Commands.CreateCustomCommand('Search: \'Is template\' = Yes');
      
    // Create a command for Search: Object type one of 'Document'.
    const objectTypeSearchCommandId =
      await shellFrame.Commands.CreateCustomCommand('Search: Object type one of \'Document\'');

    // Create a command for Search: Object type one of 'Document; Document collection' with grouping levels.
    const groupingLevelsSearchCommandId =
      await shellFrame.Commands.CreateCustomCommand('Search: Object type one of \'Document; Document collection\' with grouping levels');
      
    // Create a command for Latest Searches.
    const latestSearchesCommandId =
      await shellFrame.Commands.CreateCustomCommand('Latest Searches');

    // Add the command to the main menu.
    await shellFrame.Commands.AddCustomCommandToMenu(
      textSearchCommandId,
      MFiles.MenuLocation.MenuLocation_TopPaneMenu,
      1,
    );
    
    // Add the command to the main menu.
    await shellFrame.Commands.AddCustomCommandToMenu(
      propertyTypeSearchCommandId,
      MFiles.MenuLocation.MenuLocation_TopPaneMenu,
      2,
    );
    
    // Add the command to the main menu.
    await shellFrame.Commands.AddCustomCommandToMenu(
      objectTypeSearchCommandId,
      MFiles.MenuLocation.MenuLocation_TopPaneMenu,
      3,
    );
    
    // Add the command to the main menu.
    await shellFrame.Commands.AddCustomCommandToMenu(
      groupingLevelsSearchCommandId,
      MFiles.MenuLocation.MenuLocation_TopPaneMenu,
      4,
    );
    
    // Add the command to the main menu.
    await shellFrame.Commands.AddCustomCommandToMenu(
      latestSearchesCommandId,
      MFiles.MenuLocation.MenuLocation_TopPaneMenu,
      5,
    );

    // Register to respond to commands being clicked.
    shellFrame.Commands.Events.Register(
      MFiles.Event.CustomCommand,
      async (commandId) => {

        // Create an object ShellFrameFolders.
        const shellFrameFolders = {
          folders: []
        };

        // Check if the command is text search.
        if (commandId === textSearchCommandId) {
          // Add text search folder to ShellFrameFolders.
              shellFrameFolders.folders.push(getTextSearchFolder());
        }

        // Check if the command is property type search.
        if (commandId === propertyTypeSearchCommandId) {
          // Add property type search folder to ShellFrameFolders.
          shellFrameFolders.folders.push(getPropertyTypeSearchFolder());
        }
        
        // Check if the command is object type search.
        if (commandId === objectTypeSearchCommandId) {
          // Add object type search folder to ShellFrameFolders.
          shellFrameFolders.folders.push(getObjectTypeSearchFolder());
        }
        
        // Check if the command is search with grouping levels.
        if (commandId === groupingLevelsSearchCommandId) {
          // Add search with grouping levels folder to ShellFrameFolders.
          shellFrameFolders.folders.push(getGroupingLevelsSearchFolder());
        }
        
        // Check if the command is latest searches.
        if (commandId === latestSearchesCommandId) {
          // Add latest searches folder to ShellFrameFolders.
          shellFrameFolders.folders.push(getLatestSearchesFolder());
        }

        // Check if some folder was added to the ShellFrameFolders.
        if(shellFrameFolders.folders.length > 0) {
          // Navigate to that folder.
          await shellFrame.NavigateToFolder(shellFrameFolders);
        }
      },
    );
  };
}

Create a text search folder (Search: "estt")​

We will create a function getTextSearchFolder to return a text search folder which will execute full text search with string estt.

Search folder data structure consists of:

  • Filter conditions array
  • Each condition has expression, condition type (operator) and value
  • Search options

This search folder will execute search with following filter:

  • Expression type is any field and in expression data we can set FTSFLAGS (full text search) options
  • As condition we use type contains
  • Value in this case is text type and data is "esst"
  • Search options includes unmanaged objects into search results
main.js
function getTextSearchFolder() {
  /// <summary>Gets a function to return the search folder for text search.</summary>
  /// <returns type="Folder">The search folder.</returns>
  
  // Create a search folder for text "estt".
  const folder = {
    type: MFiles.VaultEnums.FolderType.FOLDER_TYPE_SEARCH_FOLDER,
    data: {
      search_folder: {
        search_definition: {
          filter_conditions: [
            {
              expression: {
                data: {
                  any_field: {
                    options: {
                      all: false,
                      search_all_words: true,
                      search_filedata: true,
                      search_metadata: true,
                      use_stemming: true
                    }
                  }
                },
                type: MFiles.VaultEnums.ExpressionType.EXPRESSION_TYPE_ANY_FIELD
              },
              type: MFiles.VaultEnums.ConditionType.CONDITION_TYPE_CONTAINS,
              value: {
                data: {
                  text: 'estt'
                },
                is_null_value: false,
                type: MFiles.VaultEnums.Datatype.DATATYPE_TEXT
              }
            }
          ],
          options: {
            all: false,
            include_unmanaged_objects: true,
            separately_search_in_each_object_type: true
          }
        }
      }
    }
  };

  // Return the search folder object.
  return folder;
};

Create a property type search folder (Search: 'Is template' = Yes)​

We will create a function getPropertyTypeSearchFolder to return a property type search folder which will find all objects that have IsTemplate property set to Yes.

This search folder will execute search with following filter:

  • Expression type is property value and in expression data we can set property value to be 37 (Is template)
  • As condition we use type equals
  • Value in this case is boolean type and data is true
  • Search options is set to all
main.js
function getPropertyTypeSearchFolder() {
  /// <summary>Gets a function to return the search folder for property type search.</summary>
  /// <returns type="Folder">The search folder.</returns>
  
  // Create a search folder for 'Is template' = true.
  const folder = {
    type: MFiles.VaultEnums.FolderType.FOLDER_TYPE_SEARCH_FOLDER,
    data: {
      search_folder: {
        search_definition: {
          filter_conditions: [
            {
              expression: {
                data: {
                  property_value: {
                    data_function: {
                      data: {},
                      data_function: MFiles.VaultEnums.DataFunction.DATA_FUNCTION_NO_OP
                    },
                    parent_child_behavior: MFiles.VaultEnums.ParentChildBehavior.PARENT_CHILD_BEHAVIOR_NONE,
                    property_def: 37 // 'Is template'
                  }
                },
                type: MFiles.VaultEnums.ExpressionType.EXPRESSION_TYPE_PROPERTY_VALUE
              },
              type: MFiles.VaultEnums.ConditionType.CONDITION_TYPE_EQUAL,
              value: {
                data: {
                  boolean: true
                },
                is_null_value: false,
                type: MFiles.VaultEnums.Datatype.DATATYPE_BOOLEAN
              }
            }
          ],
          options: {
            all: false
          }
        }
      }
    }
  };

  // Return the search folder object.
  return folder;
};

Create a object type search folder (Search: Object type one of 'Document')​

We will create a function getObjectTypeSearchFolder to return a object type search folder which will find all objects of type Document.

This search folder will execute search with following filter:

  • Expression type is status value and in expression data we can set object type as status query
  • As condition we use type equals
  • Value in this case is multi select lookup where different value list values can be added
    • Only one value list value with ID 0
  • Search options is set to all
main.js
function getObjectTypeSearchFolder() {
  /// <summary>Gets a function to return the search folder for object type search.</summary>
  /// <returns type="Folder">The search folder.</returns>
  
  // Create a search folder for Object type one of 'Document'.
  const folder = {
    type: MFiles.VaultEnums.FolderType.FOLDER_TYPE_SEARCH_FOLDER,
    data: {
      search_folder: {
        search_definition: {
          filter_conditions: [
            {
              expression: {
                data: {
                  status_value: {
                    data_function: {
                      data: {},
                      data_function: MFiles.VaultEnums.DataFunction.DATA_FUNCTION_NO_OP
                    },
                    type: MFiles.VaultEnums.StatusType.STATUS_TYPE_OBJECT_TYPE
                  }
                },
                type: MFiles.VaultEnums.ExpressionType.EXPRESSION_TYPE_STATUS_VALUE
              },
              type: MFiles.VaultEnums.ConditionType.CONDITION_TYPE_EQUAL,
              value: {
                data: {
                  multi_select_lookup: {
                    values: [
                      {
                        value_list_item_info: {
                          name: 'Document',
                          obj_id: {
                            item_id: {
                              internal_id: 0 // Object type 'Document'.
                            },
                            type: -11
                          },
                          options: {
                            all: false
                          }
                        },
                        version: {
                          internal_version: -1,
                          type: MFiles.VaultEnums.ObjVerVersionType.OBJ_VER_VERSION_TYPE_LATEST
                        }
                      }
                    ]
                  }
                },
                is_null_value: false,
                type: MFiles.VaultEnums.Datatype.DATATYPE_MULTI_SELECT_LOOKUP
              }
            }
          ],
          options: {
            all: false
          }
        }
      }
    }
  };

  // Return the search folder object.
  return folder;
};

Create a search folder with grouping levels (Search: Object type one of 'Document; Document collection' with grouping levels)​

We will create a function getGroupingLevelsSearchFolder to return a object type search folder without deleted objects and there will be 2 grouping levels.

This search folder will execute search with following filter:

  • 1st expression type is status value and in expression data we can set type is deleted as status query
    • As condition we use type equals
    • Value is boolean false
  • 2nd expression type is status value and in expression data we can set object type as status query
    • As condition we use type equals
    • Value in this case is multi select lookup
      • 1st value ID is 0 (Document)
      • 2nd value ID is 9 (Document collection)
  • 2 grouping levels are defined
    • 1st level is group by object type ID 136 which is Customer in Sample Vault
    • 2nd level is group by object type ID 101 which is Project in Sample Vault
  • Search options is set to all
main.js
function getGroupingLevelsSearchFolder() {
  /// <summary>Gets a function to return the search folder with grouping levels.</summary>
  /// <returns type="Folder">The search folder.</returns>
  
  // Create a search folder which has grouping levels.
  const folder =  {
    type: MFiles.VaultEnums.FolderType.FOLDER_TYPE_SEARCH_FOLDER,
    data: {
      search_folder: {
        search_definition: {
          filter_conditions: [
            {
              expression: {
                data: {
                  status_value: {
                    data_function: {
                      data: {},
                      data_function: MFiles.VaultEnums.DataFunction.DATA_FUNCTION_NO_OP
                    },
                    type: MFiles.VaultEnums.StatusType.STATUS_TYPE_IS_DELETED
                  }
                },
                type: MFiles.VaultEnums.ExpressionType.EXPRESSION_TYPE_STATUS_VALUE
              },
              type: MFiles.VaultEnums.ConditionType.CONDITION_TYPE_EQUAL,
              value: {
                data: {
                  boolean: false
                },
                is_null_value: false,
                type: MFiles.VaultEnums.Datatype.DATATYPE_BOOLEAN
              }
            },
            {
              expression: {
                data: {
                  status_value: {
                    data_function: {
                      data: {},
                      data_function: MFiles.VaultEnums.DataFunction.DATA_FUNCTION_NO_OP
                    },
                    type: MFiles.VaultEnums.StatusType.STATUS_TYPE_OBJECT_TYPE
                  }
                },
                type: MFiles.VaultEnums.ExpressionType.EXPRESSION_TYPE_STATUS_VALUE
              },
              type: MFiles.VaultEnums.ConditionType.CONDITION_TYPE_EQUAL,
              value: {
                data: {
                  multi_select_lookup: {
                    values: [
                      {
                        value_list_item_info: {
                          name: 'Document',
                          obj_id: {
                            item_id: {
                              internal_id: 0 // Object type 'Document'.
                            },
                            type: -11
                          },
                          options: {
                            all: false
                          }
                        },
                        version: {
                          external_repository_sort_key: 0,
                          external_repository_version: '',
                          internal_version: -1,
                          type: MFiles.VaultEnums.ObjVerVersionType.OBJ_VER_VERSION_TYPE_LATEST
                        }
                      },
                      {
                        value_list_item_info: {
                          name: 'Document collection',
                          obj_id: {
                            item_id: {
                              internal_id: 9 // Object type 'Document collection'.
                            },
                            type: -11
                          },
                          options: {
                            all: false
                          }
                        },
                        version: {
                          external_repository_sort_key: 0,
                          external_repository_version: '',
                          internal_version: -1,
                          type: MFiles.VaultEnums.ObjVerVersionType.OBJ_VER_VERSION_TYPE_LATEST
                        }
                      }
                    ]
                  }
                },
                is_null_value: false,
                type: MFiles.VaultEnums.Datatype.DATATYPE_MULTI_SELECT_LOOKUP
              }
            }
          ],
          grouping_levels: [
            {
              empty_value_folder_name: '',
              expression: {
                data: {
                  typed_value: {
                    data_function: {
                      data: {},
                      data_function: MFiles.VaultEnums.DataFunction.DATA_FUNCTION_NO_OP
                    },
                    datatype: MFiles.VaultEnums.Datatype.DATATYPE_LOOKUP,
                    parent_child_behavior: MFiles.VaultEnums.ParentChildBehavior.PARENT_CHILD_BEHAVIOR_NONE,
                    value_list: 136 // Customer in Sample Vault.
                  }
                },
                type: MFiles.VaultEnums.ExpressionType.EXPRESSION_TYPE_TYPED_VALUE
              },
              expression_object_type: 136, // Customer in Sample Vault.
              options: {
                all: false,
                allow_empty_folders_for_missing_object_permissions: true,
                incompatible_with_full_text_search: false
              },
              options_obsolete: 1,
              reference_direction: false,
              show_empty_value_folder: false,
              show_folders_without_objects: true,
              show_matching_values_on_this_level: false,
              show_objects_with_empty_value: false,
              show_only_user_selected_folders: false,
              subfolder_algorithm: MFiles.VaultEnums.FolderListingAlgorithm.FOLDER_LISTING_ALGORITHM_NONE
            },
            {
              empty_value_folder_name: '',
              expression: {
                data: {
                  typed_value: {
                    data_function: {
                      data: {},
                      data_function: MFiles.VaultEnums.DataFunction.DATA_FUNCTION_NO_OP
                    },
                    datatype: MFiles.VaultEnums.Datatype.DATATYPE_LOOKUP,
                    parent_child_behavior: MFiles.VaultEnums.ParentChildBehavior.PARENT_CHILD_BEHAVIOR_NONE,
                    value_list: 101 // Project in Sample Vault.
                  }
                },
                type: MFiles.VaultEnums.ExpressionType.EXPRESSION_TYPE_TYPED_VALUE
              },
              expression_object_type: 101, // Project in Sample Vault.
              options: {
                all: false,
                allow_empty_folders_for_missing_object_permissions: true,
                incompatible_with_full_text_search: false
              },
              options_obsolete: 1,
              reference_direction: false,
              show_empty_value_folder: false,
              show_folders_without_objects: false,
              show_matching_values_on_this_level: false,
              show_objects_with_empty_value: false,
              show_only_user_selected_folders: false,
              subfolder_algorithm: MFiles.VaultEnums.FolderListingAlgorithm.FOLDER_LISTING_ALGORITHM_NONE
            }
          ],
          options: {
            all: false
          }
        }
      }
    }
  };

  // Return the search folder object.
  return folder;
};

Create a view folder for latest searches Latest Searches​

We will create a function getLatestSearchesFolder to return a latest searches view folder.

This view folder will return built-in view ID 11 (Latest Searches) content.

main.js
function getLatestSearchesFolder() {
  /// <summary>Gets a function to return the latest searches folder.</summary>
  /// <returns type="Folder">The latest searches folder.</returns>
  
  // Create a view folder for latest searches.
  const folder = {
    type: MFiles.VaultEnums.FolderType.FOLDER_TYPE_VIEW_FOLDER,
    data: {
      view_folder: {
        id: 11 // MFiles.MFBuiltInView.LatestSearches
      }
    }
  };

  // Return the search folder object.
  return folder;
};

Testing the application​

The command buttons appear in the menu area.

alt text

Selecting a command will execute the selected search.

alt text

Latest Searches view shows the executed searches.

alt text

- - + + \ No newline at end of file diff --git a/Frameworks/User-Interface-Extensibility-Framework/Reference/Samples/ShellFrameAndDashboard/index.html b/Frameworks/User-Interface-Extensibility-Framework/Reference/Samples/ShellFrameAndDashboard/index.html index 0ac49710f..7e9c67626 100644 --- a/Frameworks/User-Interface-Extensibility-Framework/Reference/Samples/ShellFrameAndDashboard/index.html +++ b/Frameworks/User-Interface-Extensibility-Framework/Reference/Samples/ShellFrameAndDashboard/index.html @@ -4,13 +4,13 @@ ShellFrame & Dashboard | M-Files User Interface Extensibility Framework - - + +
Skip to main content

ShellFrame & Dashboard

⚠️ Note

Sample codes are for demonstration purposes only. Before using in production, add proper error handling such as try-catch blocks, null checks, and input validation.

Overview​

This sample shows how we can create and show a simple dashboard. We display our own content in this dashboard and also allow users to restores the default content to the listing area. We will use React js framework for implementing the logic of the application.

Dashboard​

Application Manifest file​

First we should create Application Manifest file(appdef.xml) and specify our UI extension application data, such as the dashboard id which is required for creating it.

appdef.xml
<?xml version="1.0"?>
<application xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="http://www.m-files.com/schemas/appdef-client-v5.xsd">
  <guid>2c68aa24-4f5b-4d03-af09-0d1d8035746d</guid>
  <name>Shellframe - dashboard</name>
  <version>0.1</version>
  <description>A basic application showing how to work with Shellframe.</description>
  <publisher>M-Files Corporation</publisher>
  <enabled-by-default>true</enabled-by-default>
  <modules>
    <module environment="shellui">
      <file>shellui.js</file>
    </module>
  </modules>
  <dashboards>
    <dashboard id="MyDashboard">
      <content>index.html</content>
    </dashboard>
  </dashboards>
</application>

Ensure that your application has a unique GUID by using a GUID generator.

Creating main menu​

Now we create a module file to contain our actual application logic(shellui.js). In this file we add our custom command which is used to open our dashboard. To open the dashboard we call ShowPopupDashboard from shellframe instance.

shellui.js
function OnNewShellUI(shellUI) {
  /// <summary>Executed by the UIX when a ShellUI module is started.</summary>
  /// <param name="shellUI" type="MFiles.ShellUI">The shell UI object which was created.</param>

  // This is the start point of a ShellUI module.

  // Register to be notified when a new shell frame (MFiles.Event.NewShellFrame) is created.
  shellUI.Events.Register(MFiles.Event.NewShellFrame, handleNewShellFrame);
}

function handleNewShellFrame(shellFrame) {
  // Add tab to right pane, when the shell frame is started.
  shellFrame.Events.Register(MFiles.Event.Started, onStarted);

  // NOTE: to be on the safe side, handle the callback in "async" function and await all the
  // return values, because when the postMessage API is used, all return values will be async.
  async function onStarted() {
    const dashboardCommand =
      await shellFrame.Commands.CreateCustomCommand('Show my dashboard');
    await shellFrame.Commands.AddCustomCommandToMenu(
      dashboardCommand,
      MFiles.MenuLocation.MenuLocation_TopPaneMenu,
      1,
    );
    await shellFrame.Commands.Events.Register(
      MFiles.Event.CustomCommand,
      (command) => {
        // Execute only our custom command.
        if (command === dashboardCommand) {
          shellFrame.ShowDashboard('MyDashboard');
        }
      },
    );
  }
}

Creating the dashboard file​

Next we will create a dashboard file that will be shown in the listing view area. This is a simple html file that contains our own content.

index.html
<!doctype html>
<html lang="en">
  <head>
    <title>My Dashboard</title>
    <meta charset="utf-8" />
    <script src="mfiles.extensibility.protocol.js"></script>
  </head>
  <body>
    <div id="root">
      <h2>Welcome to M-Files!</h2>
    </div>
  </body>
</html>

After installing our application in M-Files via M-Files Admin and logging into the M-Files vault, we can see our custom command Show my dashboard. This custom command opens our dashbord in listing view area.

alt text

Dashboard handler​

Let's add some dynamic content to our dashboard. First we modifying index.html file to add styles file(style.css) and dashboard handler(index.js).

index.html
<!doctype html>
<html lang="en">
  <head>
    <title>Dashboard</title>
    <script src="mfiles.extensibility.protocol.js"></script>
    <link href="style.css" rel="stylesheet" />
  </head>
  <body>
    <div id="root"></div>
    <script src="bundle.js"></script>
  </body>
</html>

In this simple example, we retrive the current path from CurrentPath of shellFrame object and display on our dashboard. Whenever our application is loaded, OnNewDashboard is called and the content of the dashboard is updated.

We use React JS framework to implement the dashboard handler in index.js file, then bundle it in bundle.js file. You can use your favorite tool for bundling.

index.js
import React from 'react';
import { createRoot } from 'react-dom/client';

function App({ dashboard }) {
  const shellFrame = dashboard.ShellFrame;

  return (
    <div>
      <h1>My dashboard</h1>
      <div>
        Current path: <span className="label">{shellFrame.CurrentPath}</span>
      </div>
    </div>
  );
}

window.OnNewDashboard = (newDashboard) => {
  const root = createRoot(document.getElementById('root'));
  root.render(
    <React.StrictMode>
      <App dashboard={newDashboard} />
    </React.StrictMode>
  );
};

Also we need to add our style file.

style.css
html,
body {
  font-family: Lato, 'Segoe UI', Sans-Serif;
  margin: 0;
  background: #fff;
  height: 100%;
  font-size: 14px;
  padding: 0 10px;
}

div {
  padding: 2px 0;
}

button {
  width: 150px;
  height: 20px;
}

.label {
  font-weight: 500;
  color: mediumblue;
}

Now if you install the application you can see the result:

alt text

As our last path, before opening our applicatin was Pinned, you can see that Current path value is Pinned.

Restoring default content​

In some point maybe we want to restore the dashboard to the default content. In this we can call ShowDefaultContent of shellFrame object.

index.js
import React from 'react';
import { createRoot } from 'react-dom/client';

function App({ dashboard }) {
  const shellFrame = dashboard.ShellFrame;

  const showDefaultContent = () => {
    shellFrame.ShowDefaultContent();
  };

  return (
    <div>
      <h1>My dashboard</h1>
      <div>
        Current path: <span className="label">{shellFrame.CurrentPath}</span>
      </div>
      <button type="button" onClick={showDefaultContent}>
        Show default Content
      </button>
    </div>
  );
}

window.OnNewDashboard = (newDashboard) => {
  const root = createRoot(document.getElementById('root'));
  root.render(
    <React.StrictMode>
      <App dashboard={newDashboard} />
    </React.StrictMode>
  );
};

alt text

If the button is cliked the default content is shown again.

- - + + \ No newline at end of file diff --git a/Frameworks/User-Interface-Extensibility-Framework/Reference/Samples/ShowNewObjectWindow With Blank and UserDefined Template/index.html b/Frameworks/User-Interface-Extensibility-Framework/Reference/Samples/ShowNewObjectWindow With Blank and UserDefined Template/index.html index e61119dd9..b492aec96 100644 --- a/Frameworks/User-Interface-Extensibility-Framework/Reference/Samples/ShowNewObjectWindow With Blank and UserDefined Template/index.html +++ b/Frameworks/User-Interface-Extensibility-Framework/Reference/Samples/ShowNewObjectWindow With Blank and UserDefined Template/index.html @@ -4,13 +4,13 @@ ShowNewObjectWindow (Blank and UserDefined Template) | M-Files User Interface Extensibility Framework - - + +
Skip to main content

ShowNewObjectWindow (Blank and UserDefined Template)

⚠️ Note

Sample codes are for demonstration purposes only. Before using in production, add proper error handling such as try-catch blocks, null checks, and input validation.

Overview​

This sample creates a basic User Interface Extensibility Framework application consisting of one ShellUI module and dashboard which allow to create a new object with blank and user defined template.

This sample does not show how to create a local development folder or to deploy the code to the M-Files server. It is assumed that a local development folder already exists, and that is the location in which the development is occurring.

Creating the application structure​

Creating the application definition file​

Into this folder we will create an application definition file. This file must be named

appdef.xml
. The application will use version 5 of the client schema (as we are only targeting newer M-Files versions). The application will declare a single Shell UI module (with its code in
main.js
), and no dashboards.

appdef.xml

<?xml version="1.0"?>
<application xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="http://www.m-files.com/schemas/appdef-client-v5.xsd">
    <guid>4753229E-9382-4BCC-AEA9-9997E73D2370</guid>
    <name>ShowNewObjectWindow</name>
    <version>1.0</version>
    <description>A demonstration application for the support of ShowNewObjectWindow. Covered Blank template and user defined template object creations.</description>
    <publisher>M-Files Corporation</publisher>
    <modules>
        <module environment="shellui">
        <file>main.js</file>
        </module>
    </modules>
    <dashboards>
        <dashboard id="MyDashboard">
            <content>index.html</content>
        </dashboard>
    </dashboards>
</application>

Ensure that your application has a unique GUID by using a GUID generator.

Creating the module​

Next we will create a module file to contain our actual application logic. At this point we will just register to be notified of main lifecycle events:

  • We will declare a default entry point for the ShellUI module.
  • We will react to the
    NewShellFrame
    event and obtain a reference to the shell frame.
  • We will react to the shell frame’s
    Started
    event (as using the shell frame before this point will result in an exception).

main.js

function OnNewShellUI( shellUI ) {

    /// <summary>Executed by the UIX when a ShellUI module is started.</summary>
    /// <param name="shellUI" type="MFiles.ShellUI">The shell UI object which was created.</param>

    // This is the start point of a ShellUI module.

    // Register to be notified when a new shell frame (MFiles.Event.NewShellFrame) is created.
    shellUI.Events.Register(
        MFiles.Event.NewShellFrame,
        handleNewShellFrame );
}

function handleNewShellFrame( shellFrame ) {

    /// <summary>Handles the OnNewShellFrame event for an IShellUI.</summary>
    /// <param name="shellFrame" type="MFiles.ShellFrame">The shell frame object which was created.</param>

    // The shell frame was created but it cannot be used yet.
    // The following line would throw an exception ("The object cannot be accessed, because it is not ready."):
    // shellFrame.ShowMessage('A shell frame was created');

    // Register to be notified when the shell frame is started.
    shellFrame.Events.Register(
        MFiles.Event.Started,
        getShellFrameStartedHandler( shellFrame ) );
}

function getShellFrameStartedHandler( shellFrame )  {

    /// <summary>Returns a function which handles the OnStarted event for an IShellFrame.</summary>

    // The shell frame is now started and can be used.

    return async () => {};
}

Adding a new right pane tab​

Adding a right pane tab involves two steps:

  1. Creating a new tab using
    shellFrame.RightPane.AddTab
    .
  2. Set the dashboard and make the seletion.

main.js

function OnNewShellUI( shellUI ) {

    /// <summary>Executed by the UIX when a ShellUI module is started.</summary>
    /// <param name="shellUI" type="MFiles.ShellUI">The shell UI object which was created.</param>

    // This is the start point of a ShellUI module.

    // Register to be notified when a new shell frame (MFiles.Event.NewShellFrame) is created.
    shellUI.Events.Register(
        MFiles.Event.NewShellFrame,
        handleNewShellFrame );
}

function handleNewShellFrame( shellFrame ) {

    /// <summary>Handles the OnNewShellFrame event for an IShellUI.</summary>
    /// <param name="shellFrame" type="MFiles.ShellFrame">The shell frame object which was created.</param> 

    // Register to listen to the started event.
    shellFrame.Events.Register(
        MFiles.Event.Started,
        getShellFrameStartedHandler( shellFrame ) );

function getShellFrameStartedHandler( shellFrame ) {

    /// <summary>Gets a function to handle the Started event for shell frame.</summary>
    /// <param name="shellFrame" type="MFiles.ShellFrame">The current shell frame object.</param> 
    /// <returns type="MFiles.Events.OnStarted">The event handler.</returns>

    // Return the handler function for ShellFrame's Started event.
    return async () => {
    
        // Show the tab for new object creation.
        const newObjectTab = await shellFrame.RightPane.AddTab( 'newObject', 'New Object', '_last');
        newObjectTab.ShowDashboard( 'MyDashboard', {} );
        newObjectTab.Select();
        newObjectTab.SetVisible( true );
    };
}

Creating the dashboard​

Next we will create a dashboard file that will be shown in the popup. It involves two steps:

  1. Create a
    index.html
    file which will load styles and dashboard handler
  2. Create a
    dashboard.js
    file which will handle the dashboard.

index.html

<!DOCTYPE html>
<html>
  <head>
    <meta name="viewport" content="width=device-width, initial-scale=1">
    <title>Sample</title>
    <script src="mfiles.extensibility.protocol.js"></script>
    <!-- Load styles and dashboard handler js file -->
    <link href="style.css" rel="stylesheet" />
    <script src="dashboard.js"></script>
  </head>
  <body>
    <div id="Main">
      <div id="basicInfo"></div>
    </div>
    <button id="btnOpenNewObjectWindow">Open</button>
    <span id="error_message" class="error-message"></span>
  </body>
</html>

Create dashboard handler file using

OnNewDashboard
event. Once the dashboard started, the html content will be loaded and the content will be updated.

dashboard.js

function OnNewDashboard( dashboard ) {

    /// <summary>Executed by the UIX when a dashboared is started.</summary>
    /// <param name="dashboard" type="MFiles.Dashboard">The dashboard object which was created.</param>

    // Register a handler to listen the started event.
    dashboard.Events.Register(
        MFiles.Event.Started,
        () => {

            // Prepare the html content that to be updated.
            const htmlContent = getDashBoardContent();
          
            // Show and Update the dashboard content.
            mainContent = document.getElementById( 'Main' );
            mainContent.innerHTML = htmlContent;
            mainContent.style.display = 'block';

            // Bind the events.
            bindEvents();
        }
    );
}

function getDashBoardContent() {
    return `
        <div>
            <div class="method-container">
                <div class="method-title">Show New Object Window (Blank template and User defined template)</div>
                <div><div class="label">Object Type Id</div>: <input id="objectType" /></div>
                <div><div class="label">Extension (Blank Template)</div>: <input id="extension" type="text" /></div>
                <div><div class="label">Metadata card title</div>: <input id="mdCardTitle" type="text" /></div>
                <div><div class="label">Object Title </div>: <input id="objectTitle" type="text" /></div>
                <div><div class="label">Check in immediately</div>: <input id="checkin" class="checkbox" type="checkbox" /></div>
                <div id="Sourcefile"><div><div>Source file (User defined template info) </div><textarea id="srcfile" spellcheck="false">{}</textarea><div></div></div></div>
                <div>Currently we are supporting only default blank template formats such as .bmp, .accdb, .xlsx, .pptx, .pub, .vsdx, .docx, .txt. For other formats, MFD will be created by default.</div>
            </div>
        </div>
    `;
}

Show the Create object window on clicking button​

  • First bind the click event in dashboard to call the

    ShowNewObjectWindow
    from right pane content.

    • We will have 4 parameters for this

      ShowPopupDashboard

      1. objectType
        - Target Object type
      2. objectCreationInfo
        - Holds creation information, e.g., MD card button visibility, file source information, etc.,.
      3. prefillPropertyValues
        - List of properties which can be prefilled.
      4. accessControlList
        - ACL

Creating Blank template​

For document type we need to pass the extension or else it will create multifile document by default. Other then document type, no need to pass the extension information.

Currently we are supporting only default blank template formats such as .bmp, .accdb, .xlsx, .pptx, .pub, .vsdx, .docx, .txt. For other formats, MFD will be created by default.

alt text

Creating User defined template​

For User defined template we need to pass the template object information.

alt text

main.js

function OnNewShellUI( shellUI ) {

    /// <summary>The entry point of ShellUI module.</summary>
    /// <param name="shellUI" type="MFiles.ShellUI">The new shell UI object.</param> 
    
    // Register to be notified when a new shell frame (Event_NewShellFrame) is created.
    shellUI.Events.Register(
        MFiles.Event.NewShellFrame,
        handleNewShellFrame );
}

function handleNewShellFrame( shellFrame ) {

    /// <summary>Handles the OnNewShellFrame event for an IShellUI.</summary>
    /// <param name="shellFrame" type="MFiles.ShellFrame">The shell frame object which was created.</param> 

    // Register to listen to the started event.
    shellFrame.Events.Register(
        MFiles.Event.Started,
        getShellFrameStartedHandler( shellFrame ) );
}

function getShellFrameStartedHandler( shellFrame ) {

    /// <summary>Gets a function to handle the Started event for shell frame.</summary>
    /// <param name="shellFrame" type="MFiles.ShellFrame">The current shell frame object.</param> 
    /// <returns type="MFiles.Events.OnStarted">The event handler.</returns>

    // Return the handler function for ShellFrame's Started event.
    return async () => {
    
        // Show the tab for new object creation.
        const newObjectTab = await shellFrame.RightPane.AddTab( 'newObject', 'New Object', '_last');
        newObjectTab.ShowDashboard( 'MyDashboard', {} );
        newObjectTab.Select();
        newObjectTab.SetVisible( true );
    };
}

dashboard.js

function getDashBoardContent() {
    return `
        <div>
            <div class="method-container">
                <div class="method-title">Show New Object Window (Blank template and User defined template)</div>
                <div><div class="label">Object Type Id</div>: <input id="objectType" /></div>
                <div><div class="label">Extension (Blank Template)</div>: <input id="extension" type="text" /></div>
                <div><div class="label">Metadata card title</div>: <input id="mdCardTitle" type="text" /></div>
                <div><div class="label">Object Title </div>: <input id="objectTitle" type="text" /></div>
                <div><div class="label">Check in immediately</div>: <input id="checkin" class="checkbox" type="checkbox" /></div>
                <div id="Sourcefile"><div><div>Source file (User defined template info) </div><textarea id="srcfile" spellcheck="false">{}</textarea><div></div></div></div>
                <div>Currently we are supporting only default blank template formats such as .bmp, .accdb, .xlsx, .pptx, .pub, .vsdx, .docx, .txt. For other formats, MFD will be created by default.</div>
            </div>
        </div>
    `;
}

// Show new object window.
async function showNewObjectWindow() {

    // Read object type id value.
    const objectTypeID = document.getElementById( 'objectType' );
    const objectType = Number( objectTypeID?.value );

    // Read extension value.
    const extensionType = document.getElementById( 'extension' );
    const extension = extensionType.value;

    // Read metadata card title value.
    const mdCardTitle = document.getElementById( 'mdCardTitle' );
    const mdTitle = mdCardTitle.value || 'Untitled';

    // Read object title value.
    const objectTitleInfo = document.getElementById( 'objectTitle' );
    let objectTitle = objectTitleInfo.value;

    // Read Check in immediately.
    const checkin = document.getElementById( 'checkin' );
    const isCheckin = Boolean( checkin.checked );

    // Read source files info.
    const srcFile = document.getElementById( 'srcfile' );
    let srcfile = srcFile.value;

    // Validate source file.
    try {
        srcfile = typeof srcfile === 'object' ? srcfile : JSON.parse( srcfile );
    } catch( exception ) {
        console.error( exception );
        return;
    }

    // Clear all the error messages.
    showErrorMessage( '' );
    let objFileSourceType = -1;

    // Validate source file.
    if( srcfile && Object.keys( srcfile ).length > 0 ) {
        objFileSourceType = srcfile.type;
    }

    // Show error message for invalid object type.
    if( isNaN( objectType ) || objectTypeID?.value === '' ) {
        showErrorMessage( 'Invalid object type id' );
        return;
    }

    // In this example, we allowed only BLANK_TEMPLATE and USER_DEFINED_TEMPLATE.
    if( objFileSourceType != 2 && objFileSourceType >=0  ) {
        showErrorMessage( 'Invalid ObjFileSource type. Use Type \'2\' for user defined template.' );
        return;
    }

    // Create object creation info.
    let objectCreationInfo = null;
    objectCreationInfo = {
        title: objectTitle || "",
        metadata_card_title: mdTitle || "",
        extension: extension,
        object_type: objectType,
        source_files: srcfile,
        check_in_immediately_enabled: isCheckin,
        disallow_template_selection: true,
        single_file_document: extension ? true : null
    };

    // Show new object window.
    const resultFromCreationWindow = await MFiles.ShowNewObjectWindow(
        objectType, // ObjectType
        objectCreationInfo, // ObjectCreationInfo
        [], // PrefilledPropertyValues
        [] // AccessControlList
    );

    // Log the results from new object creation window.
    console.log( resultFromCreationWindow );
}

// Show error message for given method.
function showErrorMessage( errorMessage ) {
    const errorMessageElement = document.getElementById( 'error_message' );
    errorMessageElement.innerHTML = errorMessage;
}

function OnNewDashboard( dashboard ) {

    /// <summary>Executed by the UIX when a dashboared is started.</summary>
    /// <param name="dashboard" type="MFiles.Dashboard">The dashboard object which was created.</param>

    // Register a handler to listen the started event.
    dashboard.Events.Register(
        MFiles.Event.Started,
        () => {

            // Prepare the html content that to be updated.
            const htmlContent = getDashBoardContent();

            // Show and Update the dashboard content.
            mainContent = document.getElementById( 'Main' );
            mainContent.innerHTML = htmlContent;
            mainContent.style.display = 'block';

            // Bind the events.
            // For opening a prefilled object creation window.
            const btnOpenNewObjectWindow = document.getElementById( 'btnOpenNewObjectWindow' );
            btnOpenNewObjectWindow.addEventListener( 'click', showNewObjectWindow );
        }
    );
}

style.css

html, body {
    font-family: Lato, "Segoe UI", Sans-Serif;
    margin: 0;
    background: #FFF;
    height: 100%;
    color: #0a1541;
    font-size: 14px;
    padding: 0 10px;
}

div {
    padding: 4px 0;
}

.method-title {
    font-size: 16px;
    font-weight: 500;
    color: #0a1541;
}

.method-container {
    background: #F2F4F9;
    border-radius: 14px;
    padding: 10px 20px;
    margin-bottom: 15px;
}

button {
    width: 70px;
    box-sizing: border-box;
    border-width: 1px;
    border-radius: 16px;
    height: 26px;
    cursor: pointer;
    font-size: 14px;
    border-color: #006eef;
    background-color: #006eef;
    color: #fff;
}

input {
    height: 22px;
    padding: 2px 10px;
    font-size: 14px;
    line-height: 1.428571429;
    color: #0a1541;
    background-color: #fff;
    background-image: none;
    border: 1px solid #9da1b3;
    border-radius: 8px;
}

input:focus {
    border-color: #006eef;
    outline: 0;
}

.error-message {
    color: red;
}

.label {
    width: 200px;
    display: inline-block;
}

textarea {
    height: 250px;
    padding: 2px 5px;
    font-size: 14px;
    color: rgb(10, 21, 65);
    border: 1px solid rgb(157, 161, 179);
    border-radius: 8px;
    width: calc(100% - 20px);
}

.checkbox {
    height: 13px;
    padding: 0;
    margin: 0;
}

Testing the application​

Pass different object type, extensions and user defined template object info to test object creation with blank template and user defined templates.

- - + + \ No newline at end of file diff --git a/Frameworks/User-Interface-Extensibility-Framework/Reference/Samples/TaskbarCommands/index.html b/Frameworks/User-Interface-Extensibility-Framework/Reference/Samples/TaskbarCommands/index.html index dc2bb382a..ba0d97cb5 100644 --- a/Frameworks/User-Interface-Extensibility-Framework/Reference/Samples/TaskbarCommands/index.html +++ b/Frameworks/User-Interface-Extensibility-Framework/Reference/Samples/TaskbarCommands/index.html @@ -4,14 +4,14 @@ Taskbar Commands | M-Files User Interface Extensibility Framework - - + +
Skip to main content

Taskbar Commands

⚠️ Note

Sample codes are for demonstration purposes only. Before using in production, add proper error handling such as try-catch blocks, null checks, and input validation.

Overview​

This sample creates a basic User Interface Extensibility Framework application consisting of one module which adds a new command group to the taskbar and commands to it. It also adds commands to pre-defined command groups in taskbar.

Creating the application structure​

Creating the application definition file​

Into this folder we will create an application definition file. This file must be named appdef.xml. The application will use version 5 of the client schema (as we are only targeting newer M-Files versions). The application will declare a single Shell UI module (with its code in main.js), and no dashboards.

appdef.xml
<?xml version="1.0"?>
<application xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="http://www.m-files.com/schemas/appdef-client-v5.xsd">
    <guid>99EEA8CD-B990-4379-AFF9-D9DF2E2147E4</guid>
    <name>TaskBar Commands</name>
    <version>0.1</version>
    <description>A basic application showing how to work with commands in taskbar.</description>
    <publisher>M-Files Corporation</publisher>
    <enabled-by-default>true</enabled-by-default>
    <modules>
        <module environment="shellui">
        <file>main.js</file>
        </module>
    </modules>
</application>
Ensure that your application has a unique GUID by using a GUID generator.

Creating the module​

Next we will create a module file to contain our actual application logic. At this point we will just register to be notified of main lifecycle events:

  • We will declare a default entry point for the ShellUI module.
  • We will react to the NewShellFrame event and obtain a reference to the shell frame.
  • We will react to the shell frame’s Started event (as using the shell frame before this point will result in an exception).
main.js
function OnNewShellUI( shellUI ) {

    /// <summary>Executed by the UIX when a ShellUI module is started.</summary>
    /// <param name="shellUI" type="MFiles.ShellUI">The shell UI object which was created.</param>

    // This is the start point of a ShellUI module.

    // Register to be notified when a new shell frame (MFiles.Event.NewShellFrame) is created.
    shellUI.Events.Register(
        MFiles.Event.NewShellFrame,
        handleNewShellFrame );
}

function handleNewShellFrame( shellFrame ) {

    /// <summary>Handles the OnNewShellFrame event for an IShellUI.</summary>
    /// <param name="shellFrame" type="MFiles.ShellFrame">The shell frame object which was created.</param>

    // The shell frame was created but it cannot be used yet.
    // The following line would throw an exception ("The object cannot be accessed, because it is not ready."):
    // shellFrame.ShowMessage('A shell frame was created');

    // Register to be notified when the shell frame is started.
    shellFrame.Events.Register(
        MFiles.Event.Started,
        getShellFrameStartedHandler( shellFrame ) );
}

function getShellFrameStartedHandler( shellFrame )  {

    /// <summary>Returns a function which handles the OnStarted event for an IShellFrame.</summary>

    // The shell frame is now started and can be used.

    return async () => {};
}

Adding button to a taskbar group​

Command buttons are divided into groups on the taskbar.

Adding a button into existing taskbar group involves two steps:

  1. Creating a new ICommand using CreateCustomCommand.
  2. Adding the command into the taskbar group using AddCustomCommandToMenu.

Note: The AddCustomCommandToMenu function takes three parameters: the command ID, the MenuLocation, and the order priority.

MenuLocation specifies where the button will be added. If the button is added to a menu location associated with a built-in taskbar group, such as MenuLocation_TaskBar_MainActions, it will appear in the corresponding group on the taskbar (for example, the 'Main actions' group).

Order priority determines the button's position within the group; buttons with lower priority values are shown first.

main.js
function OnNewShellUI( shellUI ) {

    /// <summary>Executed by the UIX when a ShellUI module is started.</summary>
    /// <param name="shellUI" type="MFiles.ShellUI">The shell UI object which was created.</param>

    // This is the start point of a ShellUI module.

    // Register to be notified when a new shell frame (MFiles.Event.NewShellFrame) is created.
    shellUI.Events.Register(
        MFiles.Event.NewShellFrame,
        handleNewShellFrame );
}

function handleNewShellFrame( shellFrame ) {

    /// <summary>Handles the OnNewShellFrame event for an IShellUI.</summary>
    /// <param name="shellFrame" type="MFiles.ShellFrame">The shell frame object which was created.</param>

    // The shell frame was created but it cannot be used yet.
    // The following line would throw an exception ("The object cannot be accessed, because it is not ready."):
    // shellFrame.ShowMessage('A shell frame was created');

    // Register to be notified when the shell frame is started.
    shellFrame.Events.Register(
        MFiles.Event.Started,
        getShellFrameStartedHandler( shellFrame ) );
}

function getShellFrameStartedHandler( shellFrame )  {

    /// <summary>Returns a function which handles the OnStarted event for an IShellFrame.</summary>

    // The shell frame is now started and can be used.

    return async () => {

        // Create a command (button). Note that it is not yet visible.
        const helloCommandId = await shellFrame.Commands.CreateCustomCommand( 'Hello World' );

        // Add the command to the 'Main actions' command group in taskbar.
        await shellFrame.Commands.AddCustomCommandToMenu( helloCommandId, MFiles.MenuLocation.MenuLocation_TaskBar_MainActions, 99 );
    };
}

Logging into the M-Files vault should now show a button in the taskbar 'Main actions' group with the text Hello World:

alt text

Note that the 'Main actions' group also includes other built-in commands, which may vary depending on the current selection.

Reacting when the command is clicked​

Reacting to a command being clicked involves three steps:

  • Register to be notified of the CustomCommand event.
  • Ensure that the command that was clicked was the one we want to handle.
  • Execute the required code.
main.js
function OnNewShellUI( shellUI ) {

    /// <summary>Executed by the UIX when a ShellUI module is started.</summary>
    /// <param name="shellUI" type="MFiles.ShellUI">The shell UI object which was created.</param>

    // This is the start point of a ShellUI module.

    // Register to be notified when a new shell frame (MFiles.Event.NewShellFrame) is created.
    shellUI.Events.Register(
        MFiles.Event.NewShellFrame,
        handleNewShellFrame );
}

function handleNewShellFrame( shellFrame ) {

    /// <summary>Handles the OnNewShellFrame event for an IShellUI.</summary>
    /// <param name="shellFrame" type="MFiles.ShellFrame">The shell frame object which was created.</param>

    // The shell frame was created but it cannot be used yet.
    // The following line would throw an exception ("The object cannot be accessed, because it is not ready."):
    // shellFrame.ShowMessage('A shell frame was created');

    // Register to be notified when the shell frame is started.
    shellFrame.Events.Register(
        MFiles.Event.Started,
        getShellFrameStartedHandler( shellFrame ) );
}

function getShellFrameStartedHandler( shellFrame )  {

    /// <summary>Returns a function which handles the OnStarted event for an IShellFrame.</summary>

    // The shell frame is now started and can be used.

    return async () => {

        // Create a command (button). Note that it is not yet visible.
        const helloCommandId = await shellFrame.Commands.CreateCustomCommand( 'Hello World' );

        // Add the command to the 'Main actions' command group in taskbar.
        await shellFrame.Commands.AddCustomCommandToMenu( helloCommandId, MFiles.MenuLocation.MenuLocation_TaskBar_MainActions, 99 );

        // Register to be notified when a custom command is clicked.
        // Note: this will fire for ALL custom commands, so we need to filter out others.
        shellFrame.Commands.Events.Register(
            MFiles.Event.CustomCommand,
            async ( commandId ) => {

                // Branch depending on the Id of the command that was clicked.
                switch (commandId) {
                    case helloCommandId:

                        // Hello command was clicked.
                        await shellFrame.ShowMessage( 'Hello, World!' );
                        break;
                }
            } );

    };
}

Creating a custom taskbar command group and adding commands to it​

To create a new taskbar command group, call the CreateTaskbarGroup function. It returns a new MenuLocation that can be used in the AddCustomCommandToMenu call. In the example below, a new command group is created in the taskbar, and three commands ("Open", "Apply", and "Print") are added to it.

The CreateTaskbarGroup function takes three parameters: the group name, the group’s location within the taskbar, and the ordering priority.

The group location defines where in the taskbar the new group will appear. For example, it can be the leftmost group (MenuLocation_TaskBar_First), after the 'Main actions' built-in group (MenuLocation_TaskBar_MainActions), or the rightmost group (MenuLocation_TaskBar_Last).

The ordering priority determines the order of groups within the same taskbar menu location; groups with the smallest priority values appear on the left.

Note that empty command groups are not displayed. You must add commands to the group for it to become visible.

main.js
function OnNewShellUI( shellUI ) {

    /// <summary>Executed by the UIX when a ShellUI module is started.</summary>
    /// <param name="shellUI" type="MFiles.ShellUI">The shell UI object which was created.</param>

    // This is the start point of a ShellUI module.

    // Register to be notified when a new shell frame (MFiles.Event.NewShellFrame) is created.
    shellUI.Events.Register(
        MFiles.Event.NewShellFrame,
        handleNewShellFrame );
}

function handleNewShellFrame( shellFrame ) {

    /// <summary>Handles the OnNewShellFrame event for an IShellUI.</summary>
    /// <param name="shellFrame" type="MFiles.ShellFrame">The shell frame object which was created.</param>

    // The shell frame was created but it cannot be used yet.
    // The following line would throw an exception ("The object cannot be accessed, because it is not ready."):
    // shellFrame.ShowMessage('A shell frame was created');

    // Register to be notified when the shell frame is started.
    shellFrame.Events.Register(
        MFiles.Event.Started,
        getShellFrameStartedHandler( shellFrame ) );
}

function getShellFrameStartedHandler( shellFrame )  {

    /// <summary>Returns a function which handles the OnStarted event for an IShellFrame.</summary>

    // The shell frame is now started and can be used.

    return async () => {

        // Create a command group in taskbar. Note that it is not yet visible.
        const myGroupId = await shellFrame.Commands.CreateTaskbarGroup( 'My App', MFiles.MenuLocation.MenuLocation_TaskBar_Last, 1 );

        // Create commands to be added to the taskbar command group.
        const openCmdId = await shellFrame.Commands.CreateCustomCommand( 'Open' );
        const applyCmdId = await shellFrame.Commands.CreateCustomCommand( 'Apply' );
        const printCmdId = await shellFrame.Commands.CreateCustomCommand( 'Print' );

        // Add the commands to the custom command group. Commands are displayed in priority order.
        await shellFrame.Commands.AddCustomCommandToMenu( openCmdId, myGroupId, 1 );
        await shellFrame.Commands.AddCustomCommandToMenu( applyCmdId, myGroupId, 2 );
        await shellFrame.Commands.AddCustomCommandToMenu( printCmdId, myGroupId, 3 );

        // Register to be notified when a custom command is clicked.
        // Note: this will fire for ALL custom commands, so we need to filter out others.
        shellFrame.Commands.Events.Register(
            MFiles.Event.CustomCommand,
            async ( commandId ) => {

                // Branch depending on the Id of the command that was clicked.
                switch (commandId) {
                    case openCmdId:

                        // Open command was clicked.
                        await shellFrame.ShowMessage( 'Open command' );
                        break;

                    case applyCmdId:

                        // Apply command was clicked.
                        await shellFrame.ShowMessage( 'Apply command' );
                        break;

                    case printCmdId:

                        // Print command was clicked.
                        await shellFrame.ShowMessage( 'Print command' );
                        break;
                }
            } );

    };
}

Logging into the M-Files vault should now show a My App command group in taskbar and the three commands in it:

alt text

Creating a submenu in the taskbar and adding commands to it​

Taskbar commands can be organized into submenus. A submenu can contain menu items (i.e. commands) as well as other, more deeply nested submenus.

Creating a menu item that opens a submenu involves several steps:

  1. Create a new ICommand using CreateCustomCommand.
  2. Add the command to the taskbar group using AddCustomCommandToMenu.
  3. For each submenu command:

Example code below creates a taskbar group called "My App", and adds a menu item "Menu" to it. This menu item opens a submenu containing one command "Greet" and a nested submenu "SubMenu". The nested submenu includes two commands: "Hello" and "World".

main.js
function OnNewShellUI(shellUI) {

    /// <summary>Executed by the UIX when a ShellUI module is started.</summary>
    /// <param name="shellUI" type="MFiles.ShellUI">The shell UI object which was created.</param>

    // This is the start point of a ShellUI module.

    // Register to be notified when a new shell frame (MFiles.Event.NewShellFrame) is created.
    shellUI.Events.Register(
        MFiles.Event.NewShellFrame,
        handleNewShellFrame);
}

function handleNewShellFrame(shellFrame) {

    /// <summary>Handles the OnNewShellFrame event for an IShellUI.</summary>
    /// <param name="shellFrame" type="MFiles.ShellFrame">The shell frame object which was created.</param>

    // The shell frame was created but it cannot be used yet.
    // The following line would throw an exception ("The object cannot be accessed, because it is not ready."):
    // shellFrame.ShowMessage('A shell frame was created');

    // Register to be notified when the shell frame is started.
    shellFrame.Events.Register(
        MFiles.Event.Started,
        getShellFrameStartedHandler(shellFrame));
}

function getShellFrameStartedHandler(shellFrame) {

    /// <summary>Returns a function which handles the OnStarted event for an IShellFrame.</summary>

    // The shell frame is now started and can be used.

    return async () => {

        // Create a command group in taskbar. Note that it is not yet visible.
        const myGroupId = await shellFrame.Commands.CreateTaskbarGroup('My App', MFiles.MenuLocation.MenuLocation_TaskBar_Last, 1);

        // Create a custom command to be added to the taskbar command group.
        // It contains menu when submenu items are added into it.
        const mainMenuCmd = await shellFrame.Commands.CreateCustomCommand('Menu');
        const mainMenuId = await shellFrame.Commands.AddCustomCommandToMenu(mainMenuCmd, myGroupId, 1);

        // Create "Greet" command and add it to the main menu.
        const commandGreetId = await shellFrame.Commands.CreateCustomCommand('Greet');
        const commandGreetMenuId = await shellFrame.Commands.CreateSubMenuItem(mainMenuId, commandGreetId, 1);

        // Create "SubMenu" command and add it to the main menu.
        const subMenuCmd = await shellFrame.Commands.CreateCustomCommand('SubMenu');
        const subMenuId = await shellFrame.Commands.CreateSubMenuItem(mainMenuId, subMenuCmd, 2);

        // Create "Hello" command and add it to the nested menu.
        const helloCommandId = await shellFrame.Commands.CreateCustomCommand('Hello');
        const helloMenuId = await shellFrame.Commands.CreateSubMenuItem(subMenuId, helloCommandId, 1);

        // Create "World" command and add it to the nested menu.
        const worldCommandId = await shellFrame.Commands.CreateCustomCommand('World');
        const worldMenuId = await shellFrame.Commands.CreateSubMenuItem(subMenuId, worldCommandId, 2);

        // Register to be notified when a custom command is clicked.
        // Note: this will fire for ALL custom commands, so we need to filter out others.
        shellFrame.Commands.Events.Register(
            MFiles.Event.CustomCommand,
            async (commandId) => {

                // Branch depending on the Id of the command that was clicked.
                switch (commandId) {
                    case commandGreetId:

                        // Greet command was clicked.
                        await shellFrame.ShowMessage('Hello, World!');
                        break;

                    case helloCommandId:

                        // Hello command was clicked.
                        await shellFrame.ShowMessage('Hello');
                        break;

                    case worldCommandId:

                        // World command was clicked.
                        await shellFrame.ShowMessage('World');
                        break;
                }
            });
    };
}

Logging into the M-Files vault should now show a My App command group in taskbar and the commands with submenus in it:

alt text

Hiding and displaying commands in taskbar​

The command can be hidden from the taskbar using the SetCommandState function.

SetCommandState function takes three parameters:

  1. The command id.
  2. The command location (i.e. where the command state should be changed).
  3. The new command state.

To hide or show commands in the taskbar, use the CommandLocation.TaskBar command location.

Use the following command states:

  • CommandState_Active to show the command.
  • CommandState_Hidden to hide the command.
// Example: show or hide the command with commandId in taskbar.
const newState = isCommandAvailable ? CommandState.CommandState_Active : CommandState.CommandState_Hidden;
await shellFrame.Commands.SetCommandState( commandId, MFiles.CommandLocation.TaskBar, newState );

When a new command is created and added to the taskbar, its command state is CommandState_Active by default.

Adding an icon​

To set an icon for an existing custom taskbar group, call SetTaskbarGroupIcon(groupId, iconInformation) to update the icon shown for a taskbar group created by your application. The function verifies feature availability and ownership, resolves the icon using the same helpers as SetIcon, applies the icon to the group, and refreshes the taskbar so the new icon is visible.

Parameters

  • groupId (number) – id of the taskbar group to update. The group must be created by your app and owned by its Application GUID.
  • iconInformation (IIconInformation) – description of the icon (inline SVG, base64, path, built-in id, etc.).

How it works

  1. Validates inputs; throws on null/undefined parameters.
  2. Reads the application GUID and verifies ownership; throws if the group is missing or not owned by the app.
  3. Resolves the icon and sets group.icon.
  4. Refreshes taskbar commands, so the UI updates.

Key notes

  • Signature: async SetTaskbarGroupIcon(groupId: number, iconInformation: IIconInformation): Promise<void>
  • Stability: Experimental — API may change.
  • Ownership required: the call uses the application GUID; you must own the taskbar group to modify it.
  • Icon resolution: same rules as SetIcon (inline SVG default extension svg, PATH requires fetch/CORS, built-in ids map to icon helpers).
  • Errors: throws when parameters are missing, when appGUID is not available, or when the group does not exist / ownership verification fails. If getIcon throws, the error is wrapped and re-thrown with a failure message.
// Base64-encoded SVG icon for the group
const groupIconBase64 = 'PHN2ZyB3aWR0aD0iMTYiIGhlaWdodD0iMTYiIHZpZXdCb3g9IjAgMCAxNiAxNiIgZmlsbD0ibm9uZSIgeG1sbnM9Imh0dHA6Ly93d3cudzMub3JnLzIwMDAvc3ZnIj4KPHBhdGggZD0iTTggMTRBNiA2IDAgMSAwIDggMmE2IDYgMCAwIDAgMCAxMloiIGZpbGw9IiM0RkJBRjciLz4KUGF0aCBkPSJtNS45MyA4LjM4IDEuMDYgMS4wNmEuNzUuNzUgMCAwIDAgMS4wNiAwbDMuOC0zLjhhLjc1Ljc1IDAgMCAwLTEuMDYtMS4wNkw4IDcuMzJsLS43OS0uNzlhLjc1Ljc1IDAgMCAwLTEuMDYgMS4wNmwtLjIyLjIxeiIgZmlsbD0iI2ZmZiIvPgo8L3N2Zz4=';
function OnNewShellUI(shellUI) {
  shellUI.Events.Register(MFiles.Event.NewShellFrame, handleNewShellFrame);
}

function handleNewShellFrame(shellFrame) {
  shellFrame.Events.Register(MFiles.Event.Started, getShellFrameStartedHandler(shellFrame));
}

function getShellFrameStartedHandler(shellFrame) {
    return async () => {
    // Create a taskbar group with icon
    const reportingGroup = await shellFrame.Commands.CreateTaskbarGroup(
        'Reporting Tools',
        MFiles.MenuLocation.MenuLocation_TaskBar_MainActions,
        1
    );

    // Create commands for the group
    const generateReportCommand = await shellFrame.Commands.CreateCustomCommand('Generate Report');
    const viewAnalyticsCommand = await shellFrame.Commands.CreateCustomCommand('View Analytics');
   
    // Add commands to the group
    await shellFrame.Commands.AddCustomCommandToMenu(generateReportCommand, reportingGroup, 1);
    await shellFrame.Commands.AddCustomCommandToMenu(viewAnalyticsCommand, reportingGroup, 2);
   
    // Set icon for the group
    const groupIconInfo = {
        content: groupIconBase64,
        iconContentType: 'BASE64',
        alt: 'Reporting tools group icon',
        extension: 'svg'
    };

    await shellFrame.Commands.SetTaskbarGroupIcon(reportingGroup, groupIconInfo);
  };
}

alt text

- - + + \ No newline at end of file diff --git a/Frameworks/User-Interface-Extensibility-Framework/Reference/Samples/index.html b/Frameworks/User-Interface-Extensibility-Framework/Reference/Samples/index.html index b4653d6c4..7a8c8c3ff 100644 --- a/Frameworks/User-Interface-Extensibility-Framework/Reference/Samples/index.html +++ b/Frameworks/User-Interface-Extensibility-Framework/Reference/Samples/index.html @@ -4,13 +4,13 @@ Samples | M-Files User Interface Extensibility Framework - - + +
Skip to main content

Samples

note

Please note that these samples are provided “as-is” and with no warranty, explicit or otherwise. You should ensure that the functionality of these samples meet your requirements, and thoroughly test them, prior to using in any production scenarios. The items linked below are designed as teaching tools and may not be fully complete.

Please refer to Installing Applications on how to install UI Extensions into your M-Files environment.

Hello world​

Hello World is a simple application demonstrating how to create the most basic UI Extension which only displays a dialog box after the UI Extension has been successfully started.

Commands​

The Commands sample creates a basic User Interface Extensibility Framework application consisting of one ShellUI module which adds buttons to the main menu and context menu that are shown/hidden depending upon the user's actions.

Built-in commands​

The Built-in commands sample creates a basic User Interface Extensibility Framework application consisting of one module which reacts when built-in commands are clicked. Also it shows how to execute a built in command.

Taskbar commands​

The Taskbar commands sample creates a basic User Interface Extensibility Framework application consisting of one module which adds a new command group to the taskbar and commands to it. It also adds commands to pre-defined command groups in taskbar.

The Popup dashboard sample creates a User Interface Extensibility Framework application that shows a popup dashboard when a custom command is clicked. The dashboard is provided with details about the views that the user has navigated into.

The Popup dashboard with accent color sample extends the above application by also showing how to use the accent color that has been defined for this vault.

ShellFrame and dashboard​

The ShellFrame and dashboard sample shows how to replace the default listing area with a custom dashboard (and how to revert it). The sample shows how a ReactJS component could be used within the UIXv2 framework for this.

Assign to me​

The Assign to me sample creates a more complex UI Extension that allows users to select object(s) and create assignments that refer to them. This example interacts with the vault to both query vault structure and also create new objects.

Search folder examples​

The Search folder examples sample demonstrates how search folders can be used.

Sandbox Attribute support examples​

The Sandbox Attributes support examples sample demonstrates how sandbox attributes can be used.

Error handling​

The Error handling sample demonstrates how to catch and handle different types of exceptions in M-Files UI Extensions.

- - + + \ No newline at end of file diff --git a/Frameworks/User-Interface-Extensibility-Framework/Reference/UIExt2/Enums/BuiltInIcon/index.html b/Frameworks/User-Interface-Extensibility-Framework/Reference/UIExt2/Enums/BuiltInIcon/index.html index a1e4f2691..8ddfd8bf9 100644 --- a/Frameworks/User-Interface-Extensibility-Framework/Reference/UIExt2/Enums/BuiltInIcon/index.html +++ b/Frameworks/User-Interface-Extensibility-Framework/Reference/UIExt2/Enums/BuiltInIcon/index.html @@ -4,13 +4,13 @@ BuiltInIcon | M-Files User Interface Extensibility Framework - - + +
Skip to main content

BuiltInIcon

Enum representing built-in icons.

Supported in M-Files Client version 25.10 and later.

NameValueDescription
BuiltInIcon_CheckOut0
BuiltInIcon_CheckIn1
BuiltInIcon_History2
BuiltInIcon_MakeCopy3
BuiltInIcon_View4
BuiltInIcon_Workflow5
BuiltInIcon_Assignment6
BuiltInIcon_MarkComplete7
BuiltInIcon_TraditionalFolder8
BuiltInIcon_ChangeState9
BuiltInIcon_DocumentCollection10
BuiltInIcon_DefaultFile11
BuiltInIcon_Property12
BuiltInIcon_Undo13
BuiltInIcon_User14
BuiltInIcon_Group15
BuiltInIcon_NewItem16
BuiltInIcon_ContactPerson17
BuiltInIcon_StatusBlue18
BuiltInIcon_CircleBlue19
BuiltInIcon_Favorite20
BuiltInIcon_Idea21
BuiltInIcon_Bubble22
BuiltInIcon_Delete23
BuiltInIcon_ConflictResolution_KeepChanges24

Supported in M-Files Client version 25.12 and later.
BuiltInIcon_ConflictResolution_DiscardChanges25

Supported in M-Files Client version 25.12 and later.

Runtime Access​

This enumeration is available at runtime on the MFiles global object. Access enum values using MFiles.BuiltInIcon.<value>.

Example:

const value = MFiles.BuiltInIcon.BuiltInIcon_CheckOut;

See also: MFiles Global Object

- - + + \ No newline at end of file diff --git a/Frameworks/User-Interface-Extensibility-Framework/Reference/UIExt2/Enums/BuiltinCommand/index.html b/Frameworks/User-Interface-Extensibility-Framework/Reference/UIExt2/Enums/BuiltinCommand/index.html index 7a130ddb2..cd98fb086 100644 --- a/Frameworks/User-Interface-Extensibility-Framework/Reference/UIExt2/Enums/BuiltinCommand/index.html +++ b/Frameworks/User-Interface-Extensibility-Framework/Reference/UIExt2/Enums/BuiltinCommand/index.html @@ -4,14 +4,14 @@ BuiltinCommand | M-Files User Interface Extensibility Framework - - + +
Skip to main content

BuiltinCommand

The BuiltinCommand enumeration contains all the ids of the builtin commands that can be hidden, shown, disabled or enabled from the menus. This enumeration is used in conjunction with the SetCommandState method.

NameValueDescriptionCallback arguments
MakeCopy9Make a copy of the selected object.
  • shellItems (IShellItems ) The shell items being copied. If undefined, uses current selection.
CheckOut10Checkout the active selection.
  • shellItems (IShellItems ) The shell items being checked out. If undefined, uses current selection.
CheckIn11Checkin the active selection.
  • shellItems (IShellItems ) The shell items being checked in. If undefined, uses current selection.
UndoCheckOut13Undo the checkout for the selected object.
  • shellItems (IShellItems ) The shell items whose checkout is being undone. If undefined, uses current selection.
ConvertToSFD31Converts the selection into single-file document.
ConvertToMFD32Converts the selection into multi-file document. This commands works for only one selected object.
ReplaceWithFile33Triggers the file selection dialog for the currenly selected object and replaces that file with the selected file.
  • shellItems (IShellItems ) The shell items for the target object(s). If undefined, uses current selection.
ConvertToSearchablePDF46Convert to searchable pdf command.
SaveAsPDF50Save the selected object as PDF.
  • shellItems (IShellItems ) The shell items to convert. If undefined, uses current selection.
Delete76Delete the current selected object. Shows a modal dialog for confirmation.
  • shellItems (IShellItems ) The shell items being deleted. If undefined, uses current selection.
Export79Exports the content of the current view to a CSV file.
ConvertToSingleFilePDF81Converts the selection into single-file PDF.
ConvertToMultiFilePDF82Converts the selection into multi-file PDF.
NewObject87Creates a new Object.
  • objectType (number ) The object type ID for the new object.
  • objectType (number ) The object type ID for the new object.
  • isFromDragAndDrop (boolean ) true if triggered via drag and drop.
  • uploadedFiles (any ) Files uploaded via drag and drop.
  • targetFromDrop (null | IShellItems ) Drop target information.
  • clearSelection (boolean ) Whether selection should be cleared.
  • options (any ) Full options object containing TemplateInfo.
Refresh88Refresh the listing.
RollBack89Rollback command. The rollbacked object is either command argument provided as ObjVer or the current selection in the Listing View.
AddRelationship98Opens "Add relationship" dialog.

NOTE: Stability is experimental. Non-backward compatible changes or removal may occur in any future release. Use of this feature is not recommended for production environments.
  • param ({sourceObject: IObjectVersionEx }) Optional parameters.
EditRelationship99Opens "Change relationship version" dialog.

NOTE: Stability is experimental. Non-backward compatible changes or removal may occur in any future release. Use of this feature is not recommended for production environments.
  • param ({ sourceObject?: IObjectVersionEx; targetRelatedObject: IObjectVersionEx; relationshipDirections: RelationshipDirection[]; relationshipPropertyDef: number; } ) Parameters.
RemoveRelationship100Opens "Remove relationship" dialog.

NOTE: Stability is experimental. Non-backward compatible changes or removal may occur in any future release. Use of this feature is not recommended for production environments.
  • param ({ sourceObject?: IObjectVersionEx; targetRelatedObject: IObjectVersionEx; relationshipDirections: RelationshipDirection[]; relationshipPropertyDef: number; } ) Parameters.
SubMenu_NewObject101New object command which has the different object type child commands.
CheckOutForCoauthoring129Checks out the object for co-authoring.
  • shellItems (IShellItems ) The shell items to check out. If undefined, uses current selection.
ResolveConflictKeepThis134Resolves a version conflict by keeping the changes made in the selected version.
ResolveConflictDiscardThis135Resolves a version conflict by discarding the changes made in the selected version.
ViewInMFDesktop174Open the selected file in the desktop application.
  • shellItems (IShellItems ) The shell items to open. If undefined, uses current selection.
DownloadFile175Downloads the selected file.
  • shellItems (IShellItems ) The shell items being downloaded. If undefined, uses current selection.
OpenFile176Open the selected file.
  • shellItems (IShellItems ) The shell items being opened. If undefined, uses current selection.
AddPersonalTab180Add personal tab and send request to server to store related information.
RemovePersonalTab181Remove personal tab and send request to server to store related information.
RemoveFromThisView182Remove object from recent tab and send request to server to update related information.
OpenInDesktopApp183Open file in Native Desktop application using web Companion.
  • shellItems (IShellItems ) The shell items to open. If undefined, uses current selection.
OpenInBrowser184Opens the currently selected object via online office editor.
Follow185Starts following the specified object. While the object is being followed, the current user will be notified if the object changes.
Unfollow186Stop following the specified object.
LaunchDefaultApp187Open the file in associated application in desktop environment (DesktopNext).
  • shellItems (IShellItems ) The shell items being opened. If undefined, uses current selection.
SubMenu_Convert188Convert command which has the different convert child commands.
SubMenu_Show_More189Show more commands.
AddFile190Add File command.
  • shellItems (IShellItems ) The shell items for the target object(s). If undefined, uses current selection.
CopyInternalLink201Copies the link of the object to the pointed out version.
  • shellItems (IShellItems ) The shell items for link copy. If undefined, uses current selection.
SendCheckInRequest202Sends check in request to the user who has checked out a object.
  • shellItems (IShellItems ) The shell items to process. If undefined, uses current selection.
CreateView203Creates a view.
OpenInExternalEditor204Opens the file in the back-end specific external editing system.
  • shellItems (IShellItems ) The shell items to open. If undefined, uses current selection.
OpenFileForWeb205Opens the file based on the available options in a specific order for web. Order 1. Web companion 2. Office for the web 3. Download the document
  • param ({OpenMode: undefined | null | Read | Edit}) Optional open mode.
BrowseRelatedObjects206Browses related objects.
  • shellItems (IShellItems ) The shell items being browsed. If undefined, uses current selection.
SaveNewVersion208Save new version of the file
CopyWebLink209Copies the web link of the object.
  • shellItems (IShellItems ) The shell items for link copy. If undefined, uses current selection.
SPERead210Opens the currently selected object with a native desktop application in read-only mode
  • shellItems (IShellItems ) The shell items to open. If undefined, uses current selection.
ExclusiveEdit211Edit command for exclusive editing (Edit alone).
  • shellItems (IShellItems ) The shell items to check out for exclusive edit. If undefined, uses current selection.
AddToDocumentCollection213Adds the selected object to the document collection.

Supported in M-Files Client version 25.8 and later.
OpenSharingCenter214Opens Sharing Center Dialog with the selected object.

Supported in M-Files Client version 25.11 and later.
  • shellItems (IShellItems ) The shell items being shared. If undefined, uses current selection.
OpenInExternalEditorWeb215Opens the file in the back-end specific web editing system.

Supported in M-Files Client version 25.12 and later.
  • shellItems (IShellItems ) The shell items to open. If undefined, uses current selection.
DestroyHistoryVersion216Destroys a specific history version of an object. This command is only available for admin users in the history view and permanently removes the selected old version from the version history.

Supported in M-Files Client version 26.1 and later.
  • param ({obj_id: IObjID version: IObjVerVersion location: string }) Optional object/version override for history operation.
OpenInExternalEditorWebReadOnly217Opens the file in the back-end specific web editing system in read-only mode.

Supported in M-Files Client version 26.1 and later.
  • shellItems (IShellItems ) The shell items to open. If undefined, uses current selection.
SubMenu_OpenForEditing218Submenu for editing options.

Supported in M-Files Client version 26.1 and later.
SubMenu_OpenForReading219Submenu for reading options.

Supported in M-Files Client version 26.1 and later.
SubMenu_Compare220Compare submenu parent command.

Supported in M-Files Client version 26.1 and later.
CompareWithPreviousVersion221Compares the selected document with its previous version. Available for DOC/DOCX/PDF/RTF files with more than one version.

Supported in M-Files Client version 26.1 and later.
CompareWithAnotherDocument222Compares the selected document with another document that the user selects from the file explorer. Available for DOC/DOCX/PDF/RTF files.

Supported in M-Files Client version 26.1 and later.
CompareSelectedDocuments223Compares two selected documents. Available for DOC/DOCX/PDF/RTF files.

Supported in M-Files Client version 26.1 and later.
CopyWorkspaceLink224Copies the workspace link of the workspace object.

Supported in M-Files Client version 26.2 and later.
  • shellItems (IShellItems ) The shell items for link copy. If undefined, uses current selection.
ShowConflictHistory225Shows the conflict history for the selected object.

Supported in M-Files Client version 26.2 and later.
ConflictHistoryRestore229Restores the selected version from the conflict history.

Supported in M-Files Client version 26.2 and later.
  • param ({location: string }) Optional telemetry location.
EditView230Redirect to view edition page.

Supported in M-Files Client version 26.3 and later.
SubMenu_Relationships231Submenu for relationship options.

NOTE: Stability is experimental. Non-backward compatible changes or removal may occur in any future release. Use of this feature is not recommended for production environments.

Runtime Access​

This enumeration is available at runtime on the MFiles global object. Access enum values using MFiles.BuiltinCommand.<value>.

Example:

const value = MFiles.BuiltinCommand.MakeCopy;

See also: MFiles Global Object

- - + + \ No newline at end of file diff --git a/Frameworks/User-Interface-Extensibility-Framework/Reference/UIExt2/Enums/CommandLocation/index.html b/Frameworks/User-Interface-Extensibility-Framework/Reference/UIExt2/Enums/CommandLocation/index.html index 3dd73a38f..ff77eb4f8 100644 --- a/Frameworks/User-Interface-Extensibility-Framework/Reference/UIExt2/Enums/CommandLocation/index.html +++ b/Frameworks/User-Interface-Extensibility-Framework/Reference/UIExt2/Enums/CommandLocation/index.html @@ -4,15 +4,15 @@ CommandLocation | M-Files User Interface Extensibility Framework - - + +
Skip to main content

CommandLocation

The CommandLocation enumeration specifies the location for the M-Files command when it is displayed in the user interface. This enumeration is used in conjunction with the SetCommandState method.

NameValueDescription
Undefined0Undefined value.
MainMenu1Specifies the command appearance in the main menus, such as top menu and command bars.
ContextMenu2Specifies the command appearance in the context menu.
ActivityContextMenu6Specifies the command appearance in the activity context menu.
TaskBar7Specifies the command appearance on task bar.

Supported in M-Files Client version 25.10 and later.
All268435455Refers to all command locations.

NOTE: Stability is experimental. Non-backward compatible changes or removal may occur in any future release. Use of this feature is not recommended for production environments.

Runtime Access​

This enumeration is available at runtime on the MFiles global object. Access enum values using MFiles.CommandLocation.<value>.

Example:

const value = MFiles.CommandLocation.Undefined;

See also: MFiles Global Object

- - + + \ No newline at end of file diff --git a/Frameworks/User-Interface-Extensibility-Framework/Reference/UIExt2/Enums/CommandState/index.html b/Frameworks/User-Interface-Extensibility-Framework/Reference/UIExt2/Enums/CommandState/index.html index 607ee9d26..0fe803063 100644 --- a/Frameworks/User-Interface-Extensibility-Framework/Reference/UIExt2/Enums/CommandState/index.html +++ b/Frameworks/User-Interface-Extensibility-Framework/Reference/UIExt2/Enums/CommandState/index.html @@ -4,15 +4,15 @@ CommandState | M-Files User Interface Extensibility Framework - - + +
Skip to main content

CommandState

The CommandState enumeration specifies the visibility state for the M-Files command when it is displayed in the user interface. This enumeration is used in conjunction with the SetCommandState method.

NameValueDescription
CommandState_Undefined0Undefined value.
CommandState_Active1The command is visible and enabled.
CommandState_Hidden3The command is not visible.

Runtime Access​

This enumeration is available at runtime on the MFiles global object. Access enum values using MFiles.CommandState.<value>.

Example:

const value = MFiles.CommandState.CommandState_Undefined;

See also: MFiles Global Object

- - + + \ No newline at end of file diff --git a/Frameworks/User-Interface-Extensibility-Framework/Reference/UIExt2/Enums/Event/index.html b/Frameworks/User-Interface-Extensibility-Framework/Reference/UIExt2/Enums/Event/index.html index 606b66dff..a12dd75c1 100644 --- a/Frameworks/User-Interface-Extensibility-Framework/Reference/UIExt2/Enums/Event/index.html +++ b/Frameworks/User-Interface-Extensibility-Framework/Reference/UIExt2/Enums/Event/index.html @@ -4,13 +4,13 @@ Event | M-Files User Interface Extensibility Framework - - + +
Skip to main content

Event

The Event enumeration lists collectively all events.

NameValueDescription
Started2OnStarted Event.
Stop3OnStop Event.
NewShellFrame7OnNewShellFrame Event.
NewNormalShellFrame8OnNewNormalShellFrame Event.
NewRightPane14OnNewRightPane Event.
NewShellListing15OnNewShellListing Event.
NewCommands16OnNewCommands Event.
ActiveListingChanged17OnActiveListingChanged Event.
TabSelected19OnTabSelected Event (ShellPaneContainer),OnTabSelected Event (ShellPaneTab).
TabUnselected20OnTabUnselected Event (ShellPaneContainer),OnTabUnselected Event (ShellPaneTab).
BuiltinCommand22This event is triggered when built-in command is fired. To cancel the event the UI Extension can return "false" in asyncronous event handler.
CustomCommand23OnCustomCommand Event.
SelectionChanged24OnSelectionChanged Event.
SelectedItemsChanged25OnSelectedItemsChanged Event.
ContentChanged26OnContentChanged Event.
ShowContextMenu27OnShowContextMenu Event.
ListingActivated29OnListingActivated Event.
ListingDeactivated30OnListingDeactivated Event.
CloseWindow33OnCloseWindow Event.
CreateObject35OnCreateObject Event. Triggered when the creation of a new object is requested. This event occurs before the request is passed to M-Files Server.
ObjectCreated36OnObjectCreated Event. Triggered after the request to create a new object succeeded on M-Files Server.
DestroyObjects39OnDestroyObjects Event. Triggered when the destruction of one or more vault objects is requested. This event occurs before the request is passed to M-Files Server.
ObjectsDestroyed40OnObjectsDestroyed Event. Triggered after the request to destroy one or more vault objects succeeded on M-Files Server.
DestroyObjectVersions43OnDestroyObjectVersions Event. Triggered when the destruction of one or more object versions is requested. This event occurs before the request is passed to M-Files Server.

NOTE: Stability is experimental. Non-backward compatible changes or removal may occur in any future release. Use of this feature is not recommended for production environments.
ObjectVersionsDestroyed44OnObjectVersionsDestroyed Event. Triggered after the request to destroy one or more object versions succeeded on M-Files Server.

NOTE: Stability is experimental. Non-backward compatible changes or removal may occur in any future release. Use of this feature is not recommended for production environments.
RemoveObjects47OnRemoveObjects Event. Triggered when the deletion of one or more vault objects is requested. This event occurs before the request is passed to M-Files Server.
ObjectsRemoved48OnObjectsRemoved Event. Triggered after the request to delete one or more vault objects succeeded on M-Files Server.
UndeleteObjects51OnUndeleteObjects Event. Triggered when the undeletion of one or more vault objects is requested. This event occurs before the request is passed to M-Files Server.
ObjectsUndeleted52OnObjectsUndeleted Event. Triggered after the request to undelete one or more vault objects succeeded on M-Files Server.
AddObjectFile53OnAddObjectFile Event. Triggered when the addition of a new file to a document is requested. This event occurs before the request is passed to M-Files Server.
ObjectFileAdded54OnObjectFileAdded Event. Triggered after a request to add a file to a document succeeds on M-Files Server.
RemoveObjectFile55OnRemoveObjectFile Event. Triggered when the removal of a file from an object version is requested. This event occurs before the request is passed to M-Files Server.
ObjectFileRemoved56OnObjectFileRemoved Event. Triggered after a request to remove an object file from an object version succeeds on M-Files Server.
RenameObjectFile57OnRenameObjectFile Event. Triggered when the renaming of a file in a document is requested. This event occurs before the request is passed to M-Files Server.
ObjectFileRenamed58OnObjectFileRenamed Event. Triggered after a request to rename a file in a document succeeds on M-Files Server.
CheckInObjects61OnCheckInObjects Event. Triggered when the check in of one or more vault objects is requested. This event occurs before the request is passed to M-Files Server.
ObjectsCheckedIn62OnObjectsCheckedIn Event. Triggered after the request to check in one or more vault objects succeeded on M-Files Server.
CheckOutObjects65OnCheckOutObjects Event. Triggered when the checking out of one or more vault objects is requested. This event occurs before the request is passed to M-Files Server.
ObjectsCheckedOut66OnObjectsCheckedOut Event. Triggered after the request to check out one or more vault objects succeeded on M-Files Server.
UndoObjectCheckouts69OnUndoObjectCheckouts Event. Triggered when the undoing checkout of one or more vault objects is requested. This event occurs before the request is passed to M-Files Server.
ObjectCheckoutsUndone70OnObjectCheckoutsUndone Event. Triggered after the request to undo checkout of one or more vault objects succeeded on M-Files Server.
RollBackObjectVersion71OnRollBackObjectVersion Event. Triggered when the roll back of a previous vault object version is requested. This event occurs before the request is passed to M-Files Server.
ObjectVersionRolledBack72OnObjectVersionRolledBack Event. Triggered after a request to roll back a previous vault object version succeeds on M-Files Server.
SetPropertiesOfObjectVersions75OnSetPropertiesOfObjectVersions Event. Triggered when setting properties for one or more object versions is requested. This event occurs before the request is passed to M-Files Server.
PropertiesOfObjectVersionsSet76OnPropertiesOfObjectVersionsSet Event. Triggered after a request to set properties of one or more object versions succeeds on M-Files Server.
SetObjectVersionPermissions77OnSetObjectVersionPermissions Event. Triggered when changing the permissions of an object version is requested. This event occurs before the request is passed to M-Files Server.
ObjectVersionPermissionsSet78OnObjectVersionPermissionsSet Event. Triggered after a request to change the permissions of an object version succeeds on M-Files Server.
ModifyObjectVersionLabels87OnModifyObjectVersionLabels Event. Triggered when modifying the labels of an object version is requested. This event occurs before the request is passed to M-Files Server.

NOTE: Stability is experimental. Non-backward compatible changes or removal may occur in any future release. Use of this feature is not recommended for production environments.
ObjectVersionLabelsModified88OnObjectVersionLabelsModified Event. Triggered after a request to modify the labels of an object version succeeds on M-Files Server.

NOTE: Stability is experimental. Non-backward compatible changes or removal may occur in any future release. Use of this feature is not recommended for production environments.
SetObjectLevelProperty89OnSetObjectLevelProperty Event. Triggered when setting an object-level property is requested. This event occurs before the request is passed to M-Files Server.
ObjectLevelPropertySet90OnObjectLevelPropertySet Event. Triggered after a request to set an object-level property succeeds on M-Files Server.
LogOut99OnLogOut Event. Triggered when logging out of the vault is requested. This event occurs before the logout is processed.

NOTE: Stability is experimental. Non-backward compatible changes or removal may occur in any future release. Use of this feature is not recommended for production environments.
ChangeVaultLanguage100OnChangeVaultLanguage Event. Triggered when changing the vault language is requested. This event occurs before the request is passed to M-Files Server.

NOTE: Stability is experimental. Non-backward compatible changes or removal may occur in any future release. Use of this feature is not recommended for production environments.
VaultLanguageChanged101OnVaultLanguageChanged Event. Triggered after the vault language has been changed.

NOTE: Stability is experimental. Non-backward compatible changes or removal may occur in any future release. Use of this feature is not recommended for production environments.
ListItemAdded152ListItemAdded Event.
ListItemModified153ListItemModified Event.
ListItemRemoved154ListItemRemoved Event.
FacetValuesReady162FacetValuesReady Event.
CrossApplicationNotification168CrossApplicationNotification Event.
NewLeftPane170OnNewLeftPane Event.
SelectNextObject174OnSelectNextObject Event.
SelectPreviousObject175OnSelectPreviousObject Event.
SelectNextObjectFile176OnSelectNextObjectFile Event.
SelectPreviousObjectFile177OnSelectPreviousObjectFile Event.
SelectNextFolder178OnSelectNextFolder Event.
SelectPreviousFolder179OnSelectPreviousFolder Event.
ViewPageChanged180OnViewPageChanged Event.
StartPageChange181OnStartPageChange Event.
ListingPageChanged182OnListingPageChanged Event.
Refresh185OnRefresh Event.
ColumnGlobalSortingChanged187ColumnGlobalSortingChanged event.
ViewLocationChanged188ViewLocationChanged event.
ViewLocationChangedAsync189ViewLocationChangedAsync event.
ViewCreationStarted190ViewCreationStarted event.
CustomDataChanged199Custom data has changed in dashboard.

Runtime Access​

This enumeration is available at runtime on the MFiles global object. Access enum values using MFiles.Event.<value>.

Example:

const value = MFiles.Event.Started;

See also: MFiles Global Object

- - + + \ No newline at end of file diff --git a/Frameworks/User-Interface-Extensibility-Framework/Reference/UIExt2/Enums/FacetRangeType/index.html b/Frameworks/User-Interface-Extensibility-Framework/Reference/UIExt2/Enums/FacetRangeType/index.html index a28982126..20e980898 100644 --- a/Frameworks/User-Interface-Extensibility-Framework/Reference/UIExt2/Enums/FacetRangeType/index.html +++ b/Frameworks/User-Interface-Extensibility-Framework/Reference/UIExt2/Enums/FacetRangeType/index.html @@ -4,13 +4,13 @@ FacetRangeType | M-Files User Interface Extensibility Framework - - + +
Skip to main content

FacetRangeType

Facet Range Type.

NameValueDescription
predefinedpredefinedPredefined.
numericnumericNumeric.

Runtime Access​

This enumeration is available at runtime on the MFiles global object. Access enum values using MFiles.FacetRangeType.<value>.

Example:

const value = MFiles.FacetRangeType.predefined;

See also: MFiles Global Object

- - + + \ No newline at end of file diff --git a/Frameworks/User-Interface-Extensibility-Framework/Reference/UIExt2/Enums/FacetTransformation/index.html b/Frameworks/User-Interface-Extensibility-Framework/Reference/UIExt2/Enums/FacetTransformation/index.html index 3a2100fc7..f38c6cd52 100644 --- a/Frameworks/User-Interface-Extensibility-Framework/Reference/UIExt2/Enums/FacetTransformation/index.html +++ b/Frameworks/User-Interface-Extensibility-Framework/Reference/UIExt2/Enums/FacetTransformation/index.html @@ -4,13 +4,13 @@ FacetTransformation | M-Files User Interface Extensibility Framework - - + +
Skip to main content

FacetTransformation

Facet transformation type.

NameValueDescription
yearyearSpecific year from timestamp / date.
monthmonthSpecific month from timestamp / date. Typically used in combination with year.
rangerangeIDOL only, facet represents a certain range, specified by rangeType,.
nonenoneDefault, no transformations.

Runtime Access​

This enumeration is available at runtime on the MFiles global object. Access enum values using MFiles.FacetTransformation.<value>.

Example:

const value = MFiles.FacetTransformation.year;

See also: MFiles Global Object

- - + + \ No newline at end of file diff --git a/Frameworks/User-Interface-Extensibility-Framework/Reference/UIExt2/Enums/FacetType/index.html b/Frameworks/User-Interface-Extensibility-Framework/Reference/UIExt2/Enums/FacetType/index.html index c14e467e8..8f56f062e 100644 --- a/Frameworks/User-Interface-Extensibility-Framework/Reference/UIExt2/Enums/FacetType/index.html +++ b/Frameworks/User-Interface-Extensibility-Framework/Reference/UIExt2/Enums/FacetType/index.html @@ -4,13 +4,13 @@ FacetType | M-Files User Interface Extensibility Framework - - + +
Skip to main content

FacetType

Facet Type.

NameValueDescription
OTOTObject type facet.
PVPVProperty value.
PDPDSpecific property.
VLVLSpecific value list.
VLOTVLOTSpecific object type.
FILETYPEFILETYPESpecific file type ( like ".doc").

Runtime Access​

This enumeration is available at runtime on the MFiles global object. Access enum values using MFiles.FacetType.<value>.

Example:

const value = MFiles.FacetType.OT;

See also: MFiles Global Object

- - + + \ No newline at end of file diff --git a/Frameworks/User-Interface-Extensibility-Framework/Reference/UIExt2/Enums/FacetValueType/index.html b/Frameworks/User-Interface-Extensibility-Framework/Reference/UIExt2/Enums/FacetValueType/index.html index 394fe5428..1a110977b 100644 --- a/Frameworks/User-Interface-Extensibility-Framework/Reference/UIExt2/Enums/FacetValueType/index.html +++ b/Frameworks/User-Interface-Extensibility-Framework/Reference/UIExt2/Enums/FacetValueType/index.html @@ -4,13 +4,13 @@ FacetValueType | M-Files User Interface Extensibility Framework - - + +
Skip to main content

FacetValueType

Facet Value Type.

NameValueDescription
Unknown0Unknown Type.
Lookup1Lookup.
String2String.
Numeric3Numeric.
NumericRange4Numeric Range.

Runtime Access​

This enumeration is available at runtime on the MFiles global object. Access enum values using MFiles.FacetValueType.<value>.

Example:

const value = MFiles.FacetValueType.Unknown;

See also: MFiles Global Object

- - + + \ No newline at end of file diff --git a/Frameworks/User-Interface-Extensibility-Framework/Reference/UIExt2/Enums/IconContentType/index.html b/Frameworks/User-Interface-Extensibility-Framework/Reference/UIExt2/Enums/IconContentType/index.html index 27ff7d117..43bfce897 100644 --- a/Frameworks/User-Interface-Extensibility-Framework/Reference/UIExt2/Enums/IconContentType/index.html +++ b/Frameworks/User-Interface-Extensibility-Framework/Reference/UIExt2/Enums/IconContentType/index.html @@ -4,13 +4,13 @@ IconContentType | M-Files User Interface Extensibility Framework - - + +
Skip to main content

IconContentType

Enum representing possible icon types.

Supported in M-Files Client version 25.10 and later.

NameValueDescription
SVGsvgSVG in string format "<svg>...<svg>".
BASE64base64Base64 part of file without mimetype part, e.g. "iVBORw0KGgoAAAANSUhEUgAA...". Note: Extension information must be provided when using this icon content type.
PATHpathRelative path to icon file, e.g. assets/icon/icon.svg
BUILT_INbuilt_inBuilt-in icon representation.

Runtime Access​

This enumeration is available at runtime on the MFiles global object. Access enum values using MFiles.IconContentType.<value>.

Example:

const value = MFiles.IconContentType.SVG;

See also: MFiles Global Object

- - + + \ No newline at end of file diff --git a/Frameworks/User-Interface-Extensibility-Framework/Reference/UIExt2/Enums/MFBuiltInObjectType/index.html b/Frameworks/User-Interface-Extensibility-Framework/Reference/UIExt2/Enums/MFBuiltInObjectType/index.html index d89ace611..c5c0699bb 100644 --- a/Frameworks/User-Interface-Extensibility-Framework/Reference/UIExt2/Enums/MFBuiltInObjectType/index.html +++ b/Frameworks/User-Interface-Extensibility-Framework/Reference/UIExt2/Enums/MFBuiltInObjectType/index.html @@ -4,13 +4,13 @@ MFBuiltInObjectType | M-Files User Interface Extensibility Framework - - + +
Skip to main content

MFBuiltInObjectType

List of built-in object types.

NameValueDescription
Document0Document.
DocumentCollection9Document collection.
Assignment10Assignment.
Report15Report.
Email20Email.
Email_Conversation21Email_Conversation.

Runtime Access​

This enumeration is available at runtime on the MFiles global object. Access enum values using MFiles.MFBuiltInObjectType.<value>.

Example:

const value = MFiles.MFBuiltInObjectType.Document;

See also: MFiles Global Object

- - + + \ No newline at end of file diff --git a/Frameworks/User-Interface-Extensibility-Framework/Reference/UIExt2/Enums/MFBuiltInPropertyDef/index.html b/Frameworks/User-Interface-Extensibility-Framework/Reference/UIExt2/Enums/MFBuiltInPropertyDef/index.html index 68728b377..cfddb1a22 100644 --- a/Frameworks/User-Interface-Extensibility-Framework/Reference/UIExt2/Enums/MFBuiltInPropertyDef/index.html +++ b/Frameworks/User-Interface-Extensibility-Framework/Reference/UIExt2/Enums/MFBuiltInPropertyDef/index.html @@ -4,13 +4,13 @@ MFBuiltInPropertyDef | M-Files User Interface Extensibility Framework - - + +
Skip to main content

MFBuiltInPropertyDef

List of built-in properties.

NameValueDescription
NameOrTitle0Name or title.
Created20Created.
LastModified21Last modified.
SingleFileObject22Single file object.

Runtime Access​

This enumeration is available at runtime on the MFiles global object. Access enum values using MFiles.MFBuiltInPropertyDef.<value>.

Example:

const value = MFiles.MFBuiltInPropertyDef.NameOrTitle;

See also: MFiles Global Object

- - + + \ No newline at end of file diff --git a/Frameworks/User-Interface-Extensibility-Framework/Reference/UIExt2/Enums/MFBuiltInValueList/index.html b/Frameworks/User-Interface-Extensibility-Framework/Reference/UIExt2/Enums/MFBuiltInValueList/index.html index 44e9f0bde..2c965239a 100644 --- a/Frameworks/User-Interface-Extensibility-Framework/Reference/UIExt2/Enums/MFBuiltInValueList/index.html +++ b/Frameworks/User-Interface-Extensibility-Framework/Reference/UIExt2/Enums/MFBuiltInValueList/index.html @@ -4,13 +4,13 @@ MFBuiltInValueList | M-Files User Interface Extensibility Framework - - + +
Skip to main content

MFBuiltInValueList

List of built-in value lists.

NameValueDescription
Documents0Documents.
Classes1Classes.
ClassGroups2Class groups.
VersionLabels3Version labels.
TraditionalFolders4Traditional folders.
ExternalLocations5External locations.
Users6Users.
Workflows7Workflows.
States8States.
Collections9Collections.
UserGroups16User groups.
StateTransitions17State transitions.

Runtime Access​

This enumeration is available at runtime on the MFiles global object. Access enum values using MFiles.MFBuiltInValueList.<value>.

Example:

const value = MFiles.MFBuiltInValueList.Documents;

See also: MFiles Global Object

- - + + \ No newline at end of file diff --git a/Frameworks/User-Interface-Extensibility-Framework/Reference/UIExt2/Enums/MFBuiltInView/index.html b/Frameworks/User-Interface-Extensibility-Framework/Reference/UIExt2/Enums/MFBuiltInView/index.html index dafc1b006..d95f50059 100644 --- a/Frameworks/User-Interface-Extensibility-Framework/Reference/UIExt2/Enums/MFBuiltInView/index.html +++ b/Frameworks/User-Interface-Extensibility-Framework/Reference/UIExt2/Enums/MFBuiltInView/index.html @@ -4,13 +4,13 @@ MFBuiltInView | M-Files User Interface Extensibility Framework - - + +
Skip to main content

MFBuiltInView

List of built-in views.

NameValueDescription
CheckedOutToCurrentUser5Checked out to current user.
Offline6Offline.
RecentlyModifiedByMe7Recently modified by me.
Templates8Templates.
AssignedToMe9Assigned to me.
LatestSearches11Latest searches.
ByID12By id.
BuiltIn13Built-in.
RecentlyAccessedByMe14Recently accessed by me.
Favorites15Favorites.

Runtime Access​

This enumeration is available at runtime on the MFiles global object. Access enum values using MFiles.MFBuiltInView.<value>.

Example:

const value = MFiles.MFBuiltInView.CheckedOutToCurrentUser;

See also: MFiles Global Object

- - + + \ No newline at end of file diff --git a/Frameworks/User-Interface-Extensibility-Framework/Reference/UIExt2/Enums/MenuLocation/index.html b/Frameworks/User-Interface-Extensibility-Framework/Reference/UIExt2/Enums/MenuLocation/index.html index e026c9ace..c08d551cb 100644 --- a/Frameworks/User-Interface-Extensibility-Framework/Reference/UIExt2/Enums/MenuLocation/index.html +++ b/Frameworks/User-Interface-Extensibility-Framework/Reference/UIExt2/Enums/MenuLocation/index.html @@ -4,13 +4,13 @@ MenuLocation | M-Files User Interface Extensibility Framework - - + +
Skip to main content

MenuLocation

The MenuLocation enumeration contains all context menu locations into which the custom commands can be added.

NameValueDescription
MenuLocation_TopPaneMenu47TopPane Menu, typically used for the UI Extension applications.
MenuLocation_ActivityContextMenu_148Menu location for the Activity view Context menu group 1.
MenuLocation_ActivityContextMenu_249Menu location for the Activity view Context menu group 2.
MenuLocation_ActivityContextMenu_350Menu location for the Activity view Context menu group 3.
MenuLocation_ContextMenu_Open51Menu location for the context menu position for the open commands.
MenuLocation_ContextMenu_Checkout52Menu location for the context menu position for the checkout commands.
MenuLocation_ContextMenu_Share53Menu location for the context menu position for the share commands.
MenuLocation_ContextMenu_ObjectOperations26Menu location for the position of object operations in the context menu.
MenuLocation_ContextMenu_ConflictResolution40Menu location for the position of conflict resolution commands in the context menu.
MenuLocation_ContextMenu_DocumentConversions41Menu location for the context menu position for document conversions.
MenuLocation_ContextMenu_WorkflowActions54Menu location for the context menu position for the workflow action commands.
MenuLocation_ContextMenu_Organize55Menu location for the context menu position for the organize commands.
MenuLocation_ContextMenu_VersionControl56Menu location for the context menu position for the version control commands.
MenuLocation_ContextMenu_Create57Menu location for the context menu position for the create commands.
MenuLocation_ContextMenu_ViewOptions58Menu location for the context menu position for the view options commands.
MenuLocation_ContextMenu_Group59Menu location for the context menu position for the grouping commands.
MenuLocation_ContextMenu_DisplayOptions60Menu location for the context menu position for the display options commands.
MenuLocation_ContextMenu_Edit37Menu location for the context menu position for Edit commands.
MenuLocation_ContextMenu_Bottom43Menu location for the bottom of the context menu.
MenuLocation_ContextMenu_More99Menu location for the context menu position for more commands.
MenuLocation_TaskBar_First200Menu location for the first command group in the task bar.

Supported in M-Files Client version 25.10 and later.
MenuLocation_TaskBar_Workspace205Menu location for the "Workspace" command group in the task bar.

Supported in M-Files Client version 25.11 and later.
MenuLocation_TaskBar_MainActions210Menu location for the "Main Actions" command group in the task bar.

Supported in M-Files Client version 25.10 and later.
MenuLocation_TaskBar_Assignments220Menu location for the "Assignments" command group in the task bar.

Supported in M-Files Client version 25.10 and later.
MenuLocation_TaskBar_DocumentCollections230Menu location for the "Document Collections" command group in the task bar.

Supported in M-Files Client version 25.10 and later.
MenuLocation_TaskBar_CheckIn240Menu location for the "Check In" command group in the task bar.

Supported in M-Files Client version 25.10 and later.
MenuLocation_TaskBar_WorkflowStates250Menu location for the "Workflow States" command group in the task bar.

Supported in M-Files Client version 25.10 and later.
MenuLocation_TaskBar_ConflictResolution260Menu location for the "Conflict Resolution" command group in the task bar.

NOTE: Stability is experimental. Non-backward compatible changes or removal may occur in any future release. Use of this feature is not recommended for production environments.
MenuLocation_TaskBar_Last399Menu location for the last command group in the task bar.

Supported in M-Files Client version 25.10 and later.

Runtime Access​

This enumeration is available at runtime on the MFiles global object. Access enum values using MFiles.MenuLocation.<value>.

Example:

const value = MFiles.MenuLocation.MenuLocation_TopPaneMenu;

See also: MFiles Global Object

- - + + \ No newline at end of file diff --git a/Frameworks/User-Interface-Extensibility-Framework/Reference/UIExt2/Enums/ObjectWindowResultCode/index.html b/Frameworks/User-Interface-Extensibility-Framework/Reference/UIExt2/Enums/ObjectWindowResultCode/index.html index 0b2f6fdd3..096637a06 100644 --- a/Frameworks/User-Interface-Extensibility-Framework/Reference/UIExt2/Enums/ObjectWindowResultCode/index.html +++ b/Frameworks/User-Interface-Extensibility-Framework/Reference/UIExt2/Enums/ObjectWindowResultCode/index.html @@ -4,13 +4,13 @@ ObjectWindowResultCode | M-Files User Interface Extensibility Framework - - + +
Skip to main content

ObjectWindowResultCode

The ObjectWindowResultCode enumerates the defined object window modes.

NameValueDescription
MFObjectWindowResultCodeOk0The user applied the changes.
MFObjectWindowResultCodeCancel1The user cancelled the operation.
MFObjectWindowResultCodeOkToAll2The user applied the changes to all objects.
MFObjectWindowResultCodeSkipThis3The user skipped a single object.

Runtime Access​

This enumeration is available at runtime on the MFiles global object. Access enum values using MFiles.ObjectWindowResultCode.<value>.

Example:

const value = MFiles.ObjectWindowResultCode.MFObjectWindowResultCodeOk;

See also: MFiles Global Object

- - + + \ No newline at end of file diff --git a/Frameworks/User-Interface-Extensibility-Framework/Reference/UIExt2/Enums/SearchEngine/index.html b/Frameworks/User-Interface-Extensibility-Framework/Reference/UIExt2/Enums/SearchEngine/index.html index d8da110b9..092970de0 100644 --- a/Frameworks/User-Interface-Extensibility-Framework/Reference/UIExt2/Enums/SearchEngine/index.html +++ b/Frameworks/User-Interface-Extensibility-Framework/Reference/UIExt2/Enums/SearchEngine/index.html @@ -4,13 +4,13 @@ SearchEngine | M-Files User Interface Extensibility Framework - - + +
Skip to main content

SearchEngine

Enumeration of supported search engines.

NameValueDescription
SEARCH_ENGINE_UNSPECIFIED0Unspecified.
SEARCH_ENGINE_DT_SEARCH1dtSearch.
SEARCH_ENGINE_IDOL2IDOL.
SEARCH_ENGINE_AZURE_SEARCH3Azure search.
SEARCH_ENGINE_SMART_SEARCH4Smart search
SEARCH_ENGINE_AINO_SEARCH5Aino search
SEARCH_ENGINE_GOLDFISH6Goldfish - stateless reference indexer. Indexes everything, finds nothing. For testing and performance measurement purposes.

Runtime Access​

This enumeration is available at runtime on the MFiles global object. Access enum values using MFiles.SearchEngine.<value>.

Example:

const value = MFiles.SearchEngine.FullText;

See also: MFiles Global Object

- - + + \ No newline at end of file diff --git a/Frameworks/User-Interface-Extensibility-Framework/Reference/UIExt2/Enums/ToastType/index.html b/Frameworks/User-Interface-Extensibility-Framework/Reference/UIExt2/Enums/ToastType/index.html index 0bff8ec57..a1382e3f7 100644 --- a/Frameworks/User-Interface-Extensibility-Framework/Reference/UIExt2/Enums/ToastType/index.html +++ b/Frameworks/User-Interface-Extensibility-Framework/Reference/UIExt2/Enums/ToastType/index.html @@ -4,14 +4,14 @@ ToastType | M-Files User Interface Extensibility Framework - - + +
Skip to main content

ToastType

The ToastType enumeration specifies the different types of toast notifications available.

NameValueDescription
ToastType_Info0Info toast.
ToastType_Success1Success toast.
ToastType_Warning2Warning toast.
ToastType_Error3Error toast.

Runtime Access​

This enumeration is available at runtime on the MFiles global object. Access enum values using MFiles.ToastType.<value>.

Example:

const value = MFiles.ToastType.ToastType_Info;

See also: MFiles Global Object

- - + + \ No newline at end of file diff --git a/Frameworks/User-Interface-Extensibility-Framework/Reference/UIExt2/Enums/index.html b/Frameworks/User-Interface-Extensibility-Framework/Reference/UIExt2/Enums/index.html index 389da76b8..4194ab821 100644 --- a/Frameworks/User-Interface-Extensibility-Framework/Reference/UIExt2/Enums/index.html +++ b/Frameworks/User-Interface-Extensibility-Framework/Reference/UIExt2/Enums/index.html @@ -4,13 +4,13 @@ Enums | M-Files User Interface Extensibility Framework - - + +
Skip to main content

Enums

NameDescription
BuiltinCommandThe BuiltinCommand enumeration contains all the ids of the builtin commands that can be hidden, shown, disabled or enabled from the menus. This enumeration is used in conjunction with the SetCommandState method.
CommandLocationThe CommandLocation enumeration specifies the location for the M-Files command when it is displayed in the user interface. This enumeration is used in conjunction with the SetCommandState method.
CommandStateThe CommandState enumeration specifies the visibility state for the M-Files command when it is displayed in the user interface. This enumeration is used in conjunction with the SetCommandState method.
EventThe Event enumeration lists collectively all events.
MenuLocationThe MenuLocation enumeration contains all context menu locations into which the custom commands can be added.
ObjectWindowResultCodeThe ObjectWindowResultCode enumerates the defined object window modes.
ToastTypeThe ToastType enumeration specifies the different types of toast notifications available.
FacetRangeTypeFacet Range Type.
FacetTransformationFacet transformation type.
FacetTypeFacet Type.
FacetValueTypeFacet Value Type.
IconContentTypeEnum representing possible icon types.

Supported in M-Files Client version 25.10 and later.
BuiltInIconEnum representing built-in icons.

Supported in M-Files Client version 25.10 and later.
MFBuiltInPropertyDefList of built-in properties.
MFBuiltInObjectTypeList of built-in object types.
MFBuiltInViewList of built-in views.
MFBuiltInValueListList of built-in value lists.
- - + + \ No newline at end of file diff --git a/Frameworks/User-Interface-Extensibility-Framework/Reference/UIExt2/Events/index.html b/Frameworks/User-Interface-Extensibility-Framework/Reference/UIExt2/Events/index.html index bc3de9a15..899fa791c 100644 --- a/Frameworks/User-Interface-Extensibility-Framework/Reference/UIExt2/Events/index.html +++ b/Frameworks/User-Interface-Extensibility-Framework/Reference/UIExt2/Events/index.html @@ -3,14 +3,14 @@ -Events | M-Files User Interface Extensibility Framework - - +Events | M-Files User Interface Extensibility Framework + +
-
Skip to main content

Events

ISearchPaneEvents​

Interface for the Search pane events. The interface provides two methods:

  • Register( event, callback ): Registers an event handler for the specified event.
  • Unregister( eventId ): Unregisters the event handler with the specified ID.
EventDescriptionArguments
StopSent before the Searchpane is closed.
StartedRegisters event handler for the Search pane started event, which means that the Search pane
is ready to be used.

IDashboardEvents​

The IDashboard interface has Events property, which provides access to the IDashboardEvents interface. This interface provides two methods:

  • Register( event, callback ): Registers an event handler for the specified event and returns the event handler ID.
  • Unregister( eventId ): Unregisters the event handler with the specified ID.

One of the use cases for events in IDashboard is to listen for custom data changes provided by UpdateCustomData method.

Here is a JavaScript example of how to use the IDashboardEvents interface to listen for custom data changes using globally defined events.

// Register event handler for the custom data changes.
const eventId = await dashboard.Events.Register(
  MFiles.Event.CustomDataChanged,
  (data) => {
    console.log("Custom data changed: ", data);
  },
);
EventDescriptionArguments
RefreshTriggered when the dashboard data is refreshed.
StartedSent when the dashboard turns to started state.
StopSent before the dashboard is stopped.
CustomDataChangedThis event is triggered, when custom data on dashboard has changed. The event can be
used to update the dashboard based on the new data. This event will fire at least
once when the dashboard is started and initialized.		data New custom data for the dashboard

IShellFrameEvents​

IShellFrameEvents interface provides means to manage shell frame events. The interface provides two methods:

  • Register( event, callback ): Registers an event handler for the specified event.
  • Unregister( eventId ): Unregisters the event handler with the specified ID.
EventDescriptionArguments
StopSent before the IShellFrame is stopped.
StartedRegisters event handler for the IShellFrame started event, which means that the IShellFrame
is ready to be used. This event will trigger at least once for each registered callback
if the IShellFrame is already started and not yet stopped.
ViewLocationChangedRegisters event handler for the IShellFrame ViewLocationChanged event, which means that the view location has changed.
ViewLocationChangedAsyncRegisters event handler for the IShellFrame ViewLocationChangedAsync event, which means that the view location has changed.
NewCommandsRegisters event handler for the IShellFrame NewCommands event, which means that a new ICommands interface has been created and is ready to be used.
NewRightPaneRegisters event handler for the IShellFrame NewRightPane event, which means that a shell pane container is created for right shell pane.
NewShellListingRegisters event handler for the IShellFrame NewShellListing event, which means that a new shell listing object is created.newShellisting The new IShellListing object.

IShellListingEvents​

IShellListingEvents interface provides means to manage shell listing events. The interface provides two methods:

  • Register( event, callback ): Registers an event handler for the specified event.
  • Unregister( eventId ): Unregisters the event handler with the specified ID.
EventDescriptionArguments
StartedRegisters event handler for the IShellListingEvents started event.
StopRegisters event handler for the IShellListingEvents stopped event.
SelectionChangedRegisters event handler for the IShellListingEvents SelectionChanged event.
This event is triggered when the selection in the listing view is set, changed or removed.		shellItems Contains the selected items.
SelectNextObjectRegisters event handler for the IShellListingEvents SelectNextObject event. This event is triggered when the next object in the listing is selected.
SelectPreviousObjectRegisters event handler for the IShellListingEvents SelectPreviousObject event. This event is triggered when the previous object in the listing is selected.
SelectNextFolderRegisters event handler for the IShellListingEvents SelectNextFolder event. This event is triggered when the next folder in the listing is selected.folderType type of the folder, which have been selected.
SelectPreviousFolderRegisters event handler for the IShellListingEvents SelectPreviousFolder event. This event is triggered when the previous folder in the listing is selected.folderType type of the folder, which have been selected.
ListingDeactivatedRegisters event handler for the IShellListingEvents ListingDeactivated event.
This event is triggered when the listing object becomes inactive and loses the input focus.		shellListing The next active shell listing object. Can be null.
ListingActivatedRegisters event handler for the IShellListingEvents ListingActivated event.
This event is triggered when the listing object becomes active and receives the input focus.		shellListing The previous active shell listing object. Can be null.
ContentChangedRegisters event handler for the IShellListingEvents ContentChanged event.
This event is triggered when the current listing content is changed, or listed items are modified.		shellItems Contains all items in the listing.
ListItemAddedRegisters event handler for the IShellListingEvents ListItemAdded event. This event is triggered when one or more items are added to the listing.objectVersion Object
ListItemRemovedRegisters event handler for the IShellListingEvents ListItemRemoved event. This event is triggered when one or more items are removed from the listing.listItem Either an array of ObjectVersionEx if non-folder objects are removed or a single ObjectVersionEx, in case folder is removed.
removedExternalFolder In case folder was removed, include information about the old external folder item being removed in case of
ListItemModifiedRegisters event handler for the IShellListingEvents ListItemModified event.
This event is triggered when one or more of the items that are currently selected are modified.		oldServerObjVer Array of old object versions.
newObjVer Array of new objects.
SelectedItemsChangedRegisters event handler for the IShellListingEvents SelectedItemsChanged event.
This event is triggered when one or more of the items that are currently selected are modified.		shellItems Contains the selected items.

IShellPaneContainerEvents​

Interface for the Shell pane container events. The interface provides two methods:

  • Register( event, callback ): Registers an event handler for the specified event.
  • Unregister( eventId ): Unregisters the event handler with the specified ID.
EventDescriptionArguments
StopSent when the object turns to stopped state.
StartedSent when the object turns to started state.

IShellPaneTabEvents​

Interface for the Shell pane tab events. The interface provides two methods:

  • Register( event, callback ): Registers an event handler for the specified event.
  • Unregister( eventId ): Unregisters the event handler with the specified ID.
EventDescriptionArguments
StartedSent when the object turns to started state.
StopSent before the object is stopped.

IWindowEvents​

Interface for the Window events. The interface provides two methods:

  • Register( event, callback ): Registers an event handler for the specified event.
  • Unregister( eventId ): Unregisters the event handler with the specified ID.
EventDescriptionArguments
CloseWindowSent when the window is requested to closed.

IShellUIEvents​

Interface for the Shell UI events. The interface provides two methods:

  • Register( event, callback ): Registers an event handler for the specified event.
  • Unregister( eventId ): Unregisters the event handler with the specified ID.
EventDescriptionArguments
StartedSent when the object turns to started state.
StopSent when the application is stopping.
NewShellFrameTriggered when any shell frame object is created, including normal shell frames, common dialogs, and embedded or special shell frames.shellFrame - The new shell frame object.
NewNormalShellFrameTriggered when a normal shell frame object is created.
Note that this event is not triggered for common dialogs, or embedded or special shell frames.		shellFrame - The new shell frame object.
CrossApplicationNotificationBroadcasted message to multiple applications.appGUID - GUID of the target application, or null if broadcasted to all applications.
msgId - ID of the message which is sent to the other applications.
data - Custom data to be sent.
CheckInObjectsTriggered when the check in of one or more vault objects is requested.
This event occurs before the request is passed to M-Files Server.

Return a promise that resolves true to proceed, or Error object/false to cancel the operation.
When resolving with an Error object, its message will be shown to the user, enabling you to provide a custom explanation for why the operation was stopped.		objVers - The object versions being checked in.
properties - The properties to add/replace during check-in.
options - Flags that control the operation.
ObjectsCheckedInTriggered after the request to check in one or more vault objects succeeded on M-Files Server.checkedInObjects - The extended object info for checked-in objects.
CheckOutObjectsTriggered when the checking out of one or more vault objects is requested.
This event occurs before the request is passed to M-Files Server.

Return a promise that resolves true to proceed, or Error object/false to cancel the operation.
When resolving with an Error object, its message will be shown to the user, enabling you to provide a custom explanation for why the operation was stopped.		objIds - The objects being checked out.
ObjectsCheckedOutTriggered after the request to check out one or more vault objects succeeded on M-Files Server.checkedOutVersions - The new checked-out object versions with properties and ACL.
previousVersions - The previous versions before checkout.
UndoObjectCheckoutsTriggered when the undoing checkout of one or more vault objects is requested.
This event occurs before the request is passed to M-Files Server.

Return a promise that resolves true to proceed, or Error object/false to cancel the operation.
When resolving with an Error object, its message will be shown to the user, enabling you to provide a custom explanation for why the operation was stopped.		objVers - The checked-out object versions being reverted.
force - If true, undo checkout is performed even if not checked out to the caller.
ObjectCheckoutsUndoneTriggered after the request to undo checkout of one or more vault objects succeeded on M-Files Server.restoredObjects - The extended object info for restored objects.
DestroyObjectsTriggered when the destruction of one or more vault objects is requested.
This event occurs before the request is passed to M-Files Server.

Return a promise that resolves true to proceed, or Error object/false to cancel the operation.
When resolving with an Error object, its message will be shown to the user, enabling you to provide a custom explanation for why the operation was stopped.		objIds - The objects being permanently destroyed.
ObjectsDestroyedTriggered after the request to destroy one or more vault objects succeeded on M-Files Server.

NOTE: Stability is experimental. Non-backward compatible changes or removal may occur in any future release. Use of this feature is not recommended for production environments.		updatedObjects - Information about objects that were also updated during the operation.
DestroyObjectVersionsTriggered when the destruction of one or more object versions is requested.
This event occurs before the request is passed to M-Files Server.

Return a promise that resolves true to proceed, or Error object/false to cancel the operation.
When resolving with an Error object, its message will be shown to the user, enabling you to provide a custom explanation for why the operation was stopped.

NOTE: Stability is experimental. Non-backward compatible changes or removal may occur in any future release. Use of this feature is not recommended for production environments.		objVers - The object versions being permanently destroyed.
ObjectVersionsDestroyedTriggered after the request to destroy one or more object versions succeeded on M-Files Server.

NOTE: Stability is experimental. Non-backward compatible changes or removal may occur in any future release. Use of this feature is not recommended for production environments.		updatedObjects - Information about objects that were also updated during the operation.
RemoveObjectsTriggered when the deletion of one or more vault objects is requested.
This event occurs before the request is passed to M-Files Server.

Return a promise that resolves true to proceed, or Error object/false to cancel the operation.
When resolving with an Error object, its message will be shown to the user, enabling you to provide a custom explanation for why the operation was stopped.		objIds - The objects being deleted.
ObjectsRemovedTriggered after the request to delete one or more vault objects succeeded on M-Files Server.deletedObjects - The extended object info for deleted objects.
UndeleteObjectsTriggered when the undeletion of one or more vault objects is requested.
This event occurs before the request is passed to M-Files Server.

Return a promise that resolves true to proceed, or Error object/false to cancel the operation.
When resolving with an Error object, its message will be shown to the user, enabling you to provide a custom explanation for why the operation was stopped.

NOTE: Stability is experimental. Non-backward compatible changes or removal may occur in any future release. Use of this feature is not recommended for production environments.		objIds - The objects being restored from deletion.
ObjectsUndeletedTriggered after the request to undelete one or more vault objects succeeded on M-Files Server.

NOTE: Stability is experimental. Non-backward compatible changes or removal may occur in any future release. Use of this feature is not recommended for production environments.		extObjectInfos - The extended object info for undeleted objects.
RemoveObjectFileTriggered when the removal of a file from an object version is requested.
This event occurs before the request is passed to M-Files Server.

Return a promise that resolves true to proceed, or Error object/false to cancel the operation.
When resolving with an Error object, its message will be shown to the user, enabling you to provide a custom explanation for why the operation was stopped.		objVer - The object version from which the file is being removed.
fileVer - The file being removed.
ObjectFileRemovedTriggered after a request to remove an object file from an object version succeeds on M-Files Server.objectVersion - Information about the latest version of the document after the operation.
RollBackObjectVersionTriggered when the roll back of a previous vault object version is requested.
This event occurs before the request is passed to M-Files Server.

Return a promise that resolves true to proceed, or Error object/false to cancel the operation.
When resolving with an Error object, its message will be shown to the user, enabling you to provide a custom explanation for why the operation was stopped.

NOTE: Stability is experimental. Non-backward compatible changes or removal may occur in any future release. Use of this feature is not recommended for production environments.		objId - The object to roll back.
rollbackVersion - The version to roll back to. A new version is created using this as source.
ObjectVersionRolledBackTriggered after a request to roll back a previous vault object version succeeds on M-Files Server.

NOTE: Stability is experimental. Non-backward compatible changes or removal may occur in any future release. Use of this feature is not recommended for production environments.		extObjectInfo - Information about the object after the operation.
CreateObjectTriggered when the creation of a new object is requested.
This event occurs before the request is passed to M-Files Server.

Return a promise that resolves true to proceed, or Error object/false to cancel the operation.
When resolving with an Error object, its message will be shown to the user, enabling you to provide a custom explanation for why the operation was stopped.		objectTypeId - The object type ID for the new object.
properties - The properties for the new object.
acl - The access control list for the new object.
options - Flags that control the operation.
checkIn - If true, the object is checked in immediately after creation.
objFileSources - The file sources for the new object.
ObjectCreatedTriggered after the request to create a new object succeeded on M-Files Server.isVisibleToUser - True if the created object is visible to the user.
createdObject - The created object with properties and ACL.
AddObjectFileTriggered when the addition of a new file to a document is requested.
This event occurs before the request is passed to M-Files Server.

Return a promise that resolves true to proceed, or Error object/false to cancel the operation.
When resolving with an Error object, its message will be shown to the user, enabling you to provide a custom explanation for why the operation was stopped.		objVer - The object version to which the file is being added.
title - The title of the new file.
extension - The file extension (without the leading dot).
createdAtUtc - The UTC timestamp when the file was originally created.
accessedAtUtc - The UTC timestamp when the file was last accessed.
writtenAtUtc - The UTC timestamp when the file was last written to.
changedAtUtc - The UTC timestamp when the file was last changed (content or attributes).
ObjectFileAddedTriggered after a request to add a file to a document succeeds on M-Files Server.fileVer - The version information of the added file.
objectVersion - The object version after the file was added.
RenameObjectFileTriggered when the renaming of a file in a document is requested.
This event occurs before the request is passed to M-Files Server.

Return a promise that resolves true to proceed, or Error object/false to cancel the operation.
When resolving with an Error object, its message will be shown to the user, enabling you to provide a custom explanation for why the operation was stopped.		objVer - The object version containing the file.
fileVer - The file being renamed.
title - The new title for the file.
extension - The new extension for the file (without the leading dot).
ObjectFileRenamedTriggered after a request to rename a file in a document succeeds on M-Files Server.objectVersion - The object version after the file was renamed.
SetPropertiesOfObjectVersionsTriggered when setting properties for one or more object versions is requested.
This event occurs before the request is passed to M-Files Server.

Return a promise that resolves true to proceed, or Error object/false to cancel the operation.
When resolving with an Error object, its message will be shown to the user, enabling you to provide a custom explanation for why the operation was stopped.		setPropertiesParams - Array of parameters for setting properties on multiple objects.
PropertiesOfObjectVersionsSetTriggered after a request to set properties of one or more object versions succeeds on M-Files Server.extObjectInfos - Extended object info for each object after the properties were set.
SetObjectVersionPermissionsTriggered when changing the permissions of an object version is requested.
This event occurs before the request is passed to M-Files Server.

Return a promise that resolves true to proceed, or Error object/false to cancel the operation.
When resolving with an Error object, its message will be shown to the user, enabling you to provide a custom explanation for why the operation was stopped.		objVer - The object version whose permissions are being changed.
acl - The new access control list.
options - Flags that control the operation.
ObjectVersionPermissionsSetTriggered after a request to change the permissions of an object version succeeds on M-Files Server.isSpecifiedVersionStillVisible - True if the specified version is still visible after the operation.
specifiedVersion - Information about the specified version after the operation.
extObjectInfo - Extended object info after the operation.
SetObjectLevelPropertyTriggered when setting an object-level property is requested.
This event occurs before the request is passed to M-Files Server.

Return a promise that resolves true to proceed, or Error object/false to cancel the operation.
When resolving with an Error object, its message will be shown to the user, enabling you to provide a custom explanation for why the operation was stopped.		objId - The object whose property is being set.
property - The property value to set.
options - Flags that control the operation.
ObjectLevelPropertySetTriggered after a request to set an object-level property succeeds on M-Files Server.extObjectInfo - Extended object info after the operation.
ModifyObjectVersionLabelsTriggered when modifying the labels of an object version is requested.
This event occurs before the request is passed to M-Files Server.

Return a promise that resolves true to proceed, or Error object/false to cancel the operation.
When resolving with an Error object, its message will be shown to the user, enabling you to provide a custom explanation for why the operation was stopped.

NOTE: Stability is experimental. Non-backward compatible changes or removal may occur in any future release. Use of this feature is not recommended for production environments.		objVer - The object version whose labels are being modified.
clearFromOtherVersions - If true, the specified labels are cleared from other versions.
append - If true, the labels are appended to existing labels; if false, existing labels are replaced.
labelIDs - The IDs of the labels to set.
ObjectVersionLabelsModifiedTriggered after a request to modify the labels of an object version succeeds on M-Files Server.

NOTE: Stability is experimental. Non-backward compatible changes or removal may occur in any future release. Use of this feature is not recommended for production environments.		objVer - The object version whose labels were modified.
clearFromOtherVersions - If true, the specified labels were cleared from other versions.
append - If true, the labels were appended to existing labels.
labelIDs - The IDs of the labels that were set.
ChangeVaultLanguageTriggered when changing the vault language is requested.
This event occurs before the request is passed to M-Files Server.

NOTE: Stability is experimental. Non-backward compatible changes or removal may occur in any future release. Use of this feature is not recommended for production environments.		languageId - The ID of the new vault language.
VaultLanguageChangedTriggered after the vault language has been changed.

NOTE: Stability is experimental. Non-backward compatible changes or removal may occur in any future release. Use of this feature is not recommended for production environments.		languageId - The ID of the new vault language.
LogOutTriggered when logging out of the vault is requested.
This event occurs before the logout is processed.

NOTE: Stability is experimental. Non-backward compatible changes or removal may occur in any future release. Use of this feature is not recommended for production environments.

ICommandsEvents​

Ths ICommandEvents interface provides methods to register and unregister event handlers for custom commands:

  • Register( event, callback ): Registers an event handler for the specified event and returns the event handler ID.
  • Unregister( eventId ): Unregisters the event handler with the specified ID.

The ICommands interface has Events property, which provides access to the ICommandsEvents interface.

Here is a JavaScript example of how to use the ICommandsEvents interface to listen for custom command events and their data:

const commandsEvents = shellFrame.Commands.Events;
// Register event handler for the custom command
const eventId = await commandsEvents.Register(
  Event.CustomCommand,
  (commandID, data) => {
    console.log("Custom command invoked: ", commandID);
    console.log("Data: ", data);
  },
);
EventDescriptionArguments
CustomCommandTriggered when a custom command is invoked.commandID The ID of the custom command to be used.
data The data passed to the custom command.
BuiltinCommandCallback handler for Builtin commands.

Allows UI Extensibility applications to intercept and optionally cancel built-in command execution.		argument of type ( commandId : BuiltinCommand, param : any ) => Promise< boolean >
- - +
Skip to main content

Events

IDashboardEvents​

The IDashboard interface has Events property, which provides access to the IDashboardEvents interface. This interface provides two methods:

  • Register( event, callback ): Registers an event handler for the specified event and returns the event handler ID.
  • Unregister( eventId ): Unregisters the event handler with the specified ID.

One of the use cases for events in IDashboard is to listen for custom data changes provided by UpdateCustomData method.

Here is a JavaScript example of how to use the IDashboardEvents interface to listen for custom data changes using globally defined events.

// Register event handler for the custom data changes.
const eventId = await dashboard.Events.Register(
  MFiles.Event.CustomDataChanged,
  (data) => {
    console.log("Custom data changed: ", data);
  },
);
EventDescriptionArguments
RefreshTriggered when the dashboard data is refreshed.
StartedSent when the dashboard turns to started state.
StopSent before the dashboard is stopped.
CustomDataChangedThis event is triggered, when custom data on dashboard has changed. The event can be
used to update the dashboard based on the new data. This event will fire at least
once when the dashboard is started and initialized.		data New custom data for the dashboard

ISearchPaneEvents​

Interface for the Search pane events. The interface provides two methods:

  • Register( event, callback ): Registers an event handler for the specified event.
  • Unregister( eventId ): Unregisters the event handler with the specified ID.
EventDescriptionArguments
StopSent before the Searchpane is closed.
StartedRegisters event handler for the Search pane started event, which means that the Search pane
is ready to be used.

IShellFrameEvents​

IShellFrameEvents interface provides means to manage shell frame events. The interface provides two methods:

  • Register( event, callback ): Registers an event handler for the specified event.
  • Unregister( eventId ): Unregisters the event handler with the specified ID.
EventDescriptionArguments
StopSent before the IShellFrame is stopped.
StartedRegisters event handler for the IShellFrame started event, which means that the IShellFrame
is ready to be used. This event will trigger at least once for each registered callback
if the IShellFrame is already started and not yet stopped.
ViewLocationChangedRegisters event handler for the IShellFrame ViewLocationChanged event, which means that the view location has changed.
ViewLocationChangedAsyncRegisters event handler for the IShellFrame ViewLocationChangedAsync event, which means that the view location has changed.
NewCommandsRegisters event handler for the IShellFrame NewCommands event, which means that a new ICommands interface has been created and is ready to be used.
NewRightPaneRegisters event handler for the IShellFrame NewRightPane event, which means that a shell pane container is created for right shell pane.
NewShellListingRegisters event handler for the IShellFrame NewShellListing event, which means that a new shell listing object is created.newShellisting The new IShellListing object.

IShellListingEvents​

IShellListingEvents interface provides means to manage shell listing events. The interface provides two methods:

  • Register( event, callback ): Registers an event handler for the specified event and returns a handle identifying that registration.
  • Unregister( eventHandlerID ): Unregisters a single handler using the handle returned by Register (this is the registration handle, NOT an event id).
EventDescriptionArguments
StartedRegisters event handler for the IShellListingEvents started event.
StopRegisters event handler for the IShellListingEvents stopped event.
SelectionChangedRegisters event handler for the IShellListingEvents SelectionChanged event.
This event is triggered when the selection in the listing view is set, changed or removed.		shellItems Contains the selected items.
SelectNextObjectRegisters event handler for the IShellListingEvents SelectNextObject event. This event is triggered when the next object in the listing is selected.
SelectPreviousObjectRegisters event handler for the IShellListingEvents SelectPreviousObject event. This event is triggered when the previous object in the listing is selected.
SelectNextFolderRegisters event handler for the IShellListingEvents SelectNextFolder event. This event is triggered when the next folder in the listing is selected.folderType type of the folder, which have been selected.
SelectPreviousFolderRegisters event handler for the IShellListingEvents SelectPreviousFolder event. This event is triggered when the previous folder in the listing is selected.folderType type of the folder, which have been selected.
ListingDeactivatedRegisters event handler for the IShellListingEvents ListingDeactivated event.
This event is triggered when the listing object becomes inactive and loses the input focus.		shellListing The next active shell listing object. Can be null.
ListingActivatedRegisters event handler for the IShellListingEvents ListingActivated event.
This event is triggered when the listing object becomes active and receives the input focus.		shellListing The previous active shell listing object. Can be null.
ContentChangedRegisters event handler for the IShellListingEvents ContentChanged event.
This event is triggered when the current listing content is changed, or listed items are modified.		shellItems Contains all items in the listing.
ListItemAddedRegisters event handler for the IShellListingEvents ListItemAdded event. This event is triggered when one or more items are added to the listing.objectVersion Object
ListItemRemovedRegisters event handler for the IShellListingEvents ListItemRemoved event. This event is triggered when one or more items are removed from the listing.listItem Either an array of ObjectVersionEx if non-folder objects are removed or a single ObjectVersionEx, in case folder is removed.
removedExternalFolder In case folder was removed, include information about the old external folder item being removed in case of
ListItemModifiedRegisters event handler for the IShellListingEvents ListItemModified event.
This event is triggered when one or more of the items that are currently selected are modified.		oldServerObjVer Array of old object versions.
newObjVer Array of new objects.
SelectedItemsChangedRegisters event handler for the IShellListingEvents SelectedItemsChanged event.
This event is triggered when one or more of the items that are currently selected are modified.		shellItems Contains the selected items.

IShellPaneContainerEvents​

Interface for the Shell pane container events. The interface provides two methods:

  • Register( event, callback ): Registers an event handler for the specified event.
  • Unregister( eventId ): Unregisters the event handler with the specified ID.
EventDescriptionArguments
StopSent when the object turns to stopped state.
StartedSent when the object turns to started state.

IShellPaneTabEvents​

Interface for the Shell pane tab events. The interface provides two methods:

  • Register( event, callback ): Registers an event handler for the specified event.
  • Unregister( eventId ): Unregisters the event handler with the specified ID.
EventDescriptionArguments
StartedSent when the object turns to started state.
StopSent before the object is stopped.

IWindowEvents​

Interface for the Window events. The interface provides two methods:

  • Register( event, callback ): Registers an event handler for the specified event.
  • Unregister( eventId ): Unregisters the event handler with the specified ID.
EventDescriptionArguments
CloseWindowSent when the window is requested to closed.

IShellUIEvents​

Interface for the Shell UI events. The interface provides two methods:

  • Register( event, callback ): Registers an event handler for the specified event.
  • Unregister( eventId ): Unregisters the event handler with the specified ID.
EventDescriptionArguments
StartedSent when the object turns to started state.
StopSent when the application is stopping.
NewShellFrameTriggered when any shell frame object is created, including normal shell frames, common dialogs, and embedded or special shell frames.shellFrame - The new shell frame object.
NewNormalShellFrameTriggered when a normal shell frame object is created.
Note that this event is not triggered for common dialogs, or embedded or special shell frames.		shellFrame - The new shell frame object.
CrossApplicationNotificationBroadcasted message to multiple applications.appGUID - GUID of the target application, or null if broadcasted to all applications.
msgId - ID of the message which is sent to the other applications.
data - Custom data to be sent.
CheckInObjectsTriggered when the check in of one or more vault objects is requested.
This event occurs before the request is passed to M-Files Server.

Return a promise that resolves true to proceed, or Error object/false to cancel the operation.
When resolving with an Error object, its message will be shown to the user, enabling you to provide a custom explanation for why the operation was stopped.		objVers - The object versions being checked in.
properties - The properties to add/replace during check-in.
options - Flags that control the operation.
ObjectsCheckedInTriggered after the request to check in one or more vault objects succeeded on M-Files Server.checkedInObjects - The extended object info for checked-in objects.
CheckOutObjectsTriggered when the checking out of one or more vault objects is requested.
This event occurs before the request is passed to M-Files Server.

Return a promise that resolves true to proceed, or Error object/false to cancel the operation.
When resolving with an Error object, its message will be shown to the user, enabling you to provide a custom explanation for why the operation was stopped.		objIds - The objects being checked out.
ObjectsCheckedOutTriggered after the request to check out one or more vault objects succeeded on M-Files Server.checkedOutVersions - The new checked-out object versions with properties and ACL.
previousVersions - The previous versions before checkout.
UndoObjectCheckoutsTriggered when the undoing checkout of one or more vault objects is requested.
This event occurs before the request is passed to M-Files Server.

Return a promise that resolves true to proceed, or Error object/false to cancel the operation.
When resolving with an Error object, its message will be shown to the user, enabling you to provide a custom explanation for why the operation was stopped.		objVers - The checked-out object versions being reverted.
force - If true, undo checkout is performed even if not checked out to the caller.
ObjectCheckoutsUndoneTriggered after the request to undo checkout of one or more vault objects succeeded on M-Files Server.restoredObjects - The extended object info for restored objects.
DestroyObjectsTriggered when the destruction of one or more vault objects is requested.
This event occurs before the request is passed to M-Files Server.

Return a promise that resolves true to proceed, or Error object/false to cancel the operation.
When resolving with an Error object, its message will be shown to the user, enabling you to provide a custom explanation for why the operation was stopped.		objIds - The objects being permanently destroyed.
ObjectsDestroyedTriggered after the request to destroy one or more vault objects succeeded on M-Files Server.

NOTE: Stability is experimental. Non-backward compatible changes or removal may occur in any future release. Use of this feature is not recommended for production environments.		updatedObjects - Information about objects that were also updated during the operation.
DestroyObjectVersionsTriggered when the destruction of one or more object versions is requested.
This event occurs before the request is passed to M-Files Server.

Return a promise that resolves true to proceed, or Error object/false to cancel the operation.
When resolving with an Error object, its message will be shown to the user, enabling you to provide a custom explanation for why the operation was stopped.

NOTE: Stability is experimental. Non-backward compatible changes or removal may occur in any future release. Use of this feature is not recommended for production environments.		objVers - The object versions being permanently destroyed.
ObjectVersionsDestroyedTriggered after the request to destroy one or more object versions succeeded on M-Files Server.

NOTE: Stability is experimental. Non-backward compatible changes or removal may occur in any future release. Use of this feature is not recommended for production environments.		updatedObjects - Information about objects that were also updated during the operation.
RemoveObjectsTriggered when the deletion of one or more vault objects is requested.
This event occurs before the request is passed to M-Files Server.

Return a promise that resolves true to proceed, or Error object/false to cancel the operation.
When resolving with an Error object, its message will be shown to the user, enabling you to provide a custom explanation for why the operation was stopped.		objIds - The objects being deleted.
ObjectsRemovedTriggered after the request to delete one or more vault objects succeeded on M-Files Server.deletedObjects - The extended object info for deleted objects.
UndeleteObjectsTriggered when the undeletion of one or more vault objects is requested.
This event occurs before the request is passed to M-Files Server.

Return a promise that resolves true to proceed, or Error object/false to cancel the operation.
When resolving with an Error object, its message will be shown to the user, enabling you to provide a custom explanation for why the operation was stopped.

NOTE: Stability is experimental. Non-backward compatible changes or removal may occur in any future release. Use of this feature is not recommended for production environments.		objIds - The objects being restored from deletion.
ObjectsUndeletedTriggered after the request to undelete one or more vault objects succeeded on M-Files Server.

NOTE: Stability is experimental. Non-backward compatible changes or removal may occur in any future release. Use of this feature is not recommended for production environments.		extObjectInfos - The extended object info for undeleted objects.
RemoveObjectFileTriggered when the removal of a file from an object version is requested.
This event occurs before the request is passed to M-Files Server.

Return a promise that resolves true to proceed, or Error object/false to cancel the operation.
When resolving with an Error object, its message will be shown to the user, enabling you to provide a custom explanation for why the operation was stopped.		objVer - The object version from which the file is being removed.
fileVer - The file being removed.
ObjectFileRemovedTriggered after a request to remove an object file from an object version succeeds on M-Files Server.objectVersion - Information about the latest version of the document after the operation.
RollBackObjectVersionTriggered when the roll back of a previous vault object version is requested.
This event occurs before the request is passed to M-Files Server.

Return a promise that resolves true to proceed, or Error object/false to cancel the operation.
When resolving with an Error object, its message will be shown to the user, enabling you to provide a custom explanation for why the operation was stopped.

NOTE: Stability is experimental. Non-backward compatible changes or removal may occur in any future release. Use of this feature is not recommended for production environments.		objId - The object to roll back.
rollbackVersion - The version to roll back to. A new version is created using this as source.
ObjectVersionRolledBackTriggered after a request to roll back a previous vault object version succeeds on M-Files Server.

NOTE: Stability is experimental. Non-backward compatible changes or removal may occur in any future release. Use of this feature is not recommended for production environments.		extObjectInfo - Information about the object after the operation.
CreateObjectTriggered when the creation of a new object is requested.
This event occurs before the request is passed to M-Files Server.

Return a promise that resolves true to proceed, or Error object/false to cancel the operation.
When resolving with an Error object, its message will be shown to the user, enabling you to provide a custom explanation for why the operation was stopped.		objectTypeId - The object type ID for the new object.
properties - The properties for the new object.
acl - The access control list for the new object.
options - Flags that control the operation.
checkIn - If true, the object is checked in immediately after creation.
objFileSources - The file sources for the new object.
ObjectCreatedTriggered after the request to create a new object succeeded on M-Files Server.isVisibleToUser - True if the created object is visible to the user.
createdObject - The created object with properties and ACL.
AddObjectFileTriggered when the addition of a new file to a document is requested.
This event occurs before the request is passed to M-Files Server.

Return a promise that resolves true to proceed, or Error object/false to cancel the operation.
When resolving with an Error object, its message will be shown to the user, enabling you to provide a custom explanation for why the operation was stopped.		objVer - The object version to which the file is being added.
title - The title of the new file.
extension - The file extension (without the leading dot).
createdAtUtc - The UTC timestamp when the file was originally created.
accessedAtUtc - The UTC timestamp when the file was last accessed.
writtenAtUtc - The UTC timestamp when the file was last written to.
changedAtUtc - The UTC timestamp when the file was last changed (content or attributes).
ObjectFileAddedTriggered after a request to add a file to a document succeeds on M-Files Server.fileVer - The version information of the added file.
objectVersion - The object version after the file was added.
RenameObjectFileTriggered when the renaming of a file in a document is requested.
This event occurs before the request is passed to M-Files Server.

Return a promise that resolves true to proceed, or Error object/false to cancel the operation.
When resolving with an Error object, its message will be shown to the user, enabling you to provide a custom explanation for why the operation was stopped.		objVer - The object version containing the file.
fileVer - The file being renamed.
title - The new title for the file.
extension - The new extension for the file (without the leading dot).
ObjectFileRenamedTriggered after a request to rename a file in a document succeeds on M-Files Server.objectVersion - The object version after the file was renamed.
SetPropertiesOfObjectVersionsTriggered when setting properties for one or more object versions is requested.
This event occurs before the request is passed to M-Files Server.

Return a promise that resolves true to proceed, or Error object/false to cancel the operation.
When resolving with an Error object, its message will be shown to the user, enabling you to provide a custom explanation for why the operation was stopped.		setPropertiesParams - Array of parameters for setting properties on multiple objects.
PropertiesOfObjectVersionsSetTriggered after a request to set properties of one or more object versions succeeds on M-Files Server.extObjectInfos - Extended object info for each object after the properties were set.
SetObjectVersionPermissionsTriggered when changing the permissions of an object version is requested.
This event occurs before the request is passed to M-Files Server.

Return a promise that resolves true to proceed, or Error object/false to cancel the operation.
When resolving with an Error object, its message will be shown to the user, enabling you to provide a custom explanation for why the operation was stopped.		objVer - The object version whose permissions are being changed.
acl - The new access control list.
options - Flags that control the operation.
ObjectVersionPermissionsSetTriggered after a request to change the permissions of an object version succeeds on M-Files Server.isSpecifiedVersionStillVisible - True if the specified version is still visible after the operation.
specifiedVersion - Information about the specified version after the operation.
extObjectInfo - Extended object info after the operation.
SetObjectLevelPropertyTriggered when setting an object-level property is requested.
This event occurs before the request is passed to M-Files Server.

Return a promise that resolves true to proceed, or Error object/false to cancel the operation.
When resolving with an Error object, its message will be shown to the user, enabling you to provide a custom explanation for why the operation was stopped.		objId - The object whose property is being set.
property - The property value to set.
options - Flags that control the operation.
ObjectLevelPropertySetTriggered after a request to set an object-level property succeeds on M-Files Server.extObjectInfo - Extended object info after the operation.
ModifyObjectVersionLabelsTriggered when modifying the labels of an object version is requested.
This event occurs before the request is passed to M-Files Server.

Return a promise that resolves true to proceed, or Error object/false to cancel the operation.
When resolving with an Error object, its message will be shown to the user, enabling you to provide a custom explanation for why the operation was stopped.

NOTE: Stability is experimental. Non-backward compatible changes or removal may occur in any future release. Use of this feature is not recommended for production environments.		objVer - The object version whose labels are being modified.
clearFromOtherVersions - If true, the specified labels are cleared from other versions.
append - If true, the labels are appended to existing labels; if false, existing labels are replaced.
labelIDs - The IDs of the labels to set.
ObjectVersionLabelsModifiedTriggered after a request to modify the labels of an object version succeeds on M-Files Server.

NOTE: Stability is experimental. Non-backward compatible changes or removal may occur in any future release. Use of this feature is not recommended for production environments.		objVer - The object version whose labels were modified.
clearFromOtherVersions - If true, the specified labels were cleared from other versions.
append - If true, the labels were appended to existing labels.
labelIDs - The IDs of the labels that were set.
ChangeVaultLanguageTriggered when changing the vault language is requested.
This event occurs before the request is passed to M-Files Server.

NOTE: Stability is experimental. Non-backward compatible changes or removal may occur in any future release. Use of this feature is not recommended for production environments.		languageId - The ID of the new vault language.
VaultLanguageChangedTriggered after the vault language has been changed.

NOTE: Stability is experimental. Non-backward compatible changes or removal may occur in any future release. Use of this feature is not recommended for production environments.		languageId - The ID of the new vault language.
LogOutTriggered when logging out of the vault is requested.
This event occurs before the logout is processed.

NOTE: Stability is experimental. Non-backward compatible changes or removal may occur in any future release. Use of this feature is not recommended for production environments.

ICommandsEvents​

Ths ICommandEvents interface provides methods to register and unregister event handlers for custom commands:

  • Register( event, callback ): Registers an event handler for the specified event and returns the event handler ID.
  • Unregister( eventId ): Unregisters the event handler with the specified ID.

The ICommands interface has Events property, which provides access to the ICommandsEvents interface.

Here is a JavaScript example of how to use the ICommandsEvents interface to listen for custom command events and their data:

const commandsEvents = shellFrame.Commands.Events;
// Register event handler for the custom command
const eventId = await commandsEvents.Register(
  Event.CustomCommand,
  (commandID, data) => {
    console.log("Custom command invoked: ", commandID);
    console.log("Data: ", data);
  },
);
EventDescriptionArguments
CustomCommandTriggered when a custom command is invoked.commandID The ID of the custom command to be used.
data The data passed to the custom command.
BuiltinCommandCallback handler for Builtin commands.

Allows UI Extensibility applications to intercept and optionally cancel built-in command execution.		argument of type ( commandId : BuiltinCommand, param : any ) => Promise< boolean >
+ + \ No newline at end of file diff --git a/Frameworks/User-Interface-Extensibility-Framework/Reference/UIExt2/Interfaces/ICommands/AddCustomCommandToMenu/index.html b/Frameworks/User-Interface-Extensibility-Framework/Reference/UIExt2/Interfaces/ICommands/AddCustomCommandToMenu/index.html index 6b8cc1eea..ec5680034 100644 --- a/Frameworks/User-Interface-Extensibility-Framework/Reference/UIExt2/Interfaces/ICommands/AddCustomCommandToMenu/index.html +++ b/Frameworks/User-Interface-Extensibility-Framework/Reference/UIExt2/Interfaces/ICommands/AddCustomCommandToMenu/index.html @@ -4,13 +4,13 @@ AddCustomCommandToMenu | M-Files User Interface Extensibility Framework - - + +
Skip to main content

AddCustomCommandToMenu

Description​

The AddCustomCommandToMenu function is a part of the M-Files UI Extension framework and is used to include a custom command in a specific location within the M-Files user interface menu. It allows developers to define the position and priority of the custom command in the menu structure. This function typically takes parameters such as the ID of the custom command, the menu location where the command should appear, and a priority value to determine its order within the menu. This enables customization of the user interface by seamlessly integrating custom functionality into the M-Files application's menu system.

The Command to be added must be first created using CreateCustomCommand method.

Syntax​


// AddCustomCommandToMenu is part of ICommands is part of the IShellFrame interface
const menuItemId = await shellFrame.Commands.AddCustomCommandToMenu(    
    customCommandId, // ID of the custom command, created using CreateCustomCommand
    MFiles.MenuLocation.MenuLocation_TopPaneMenu, // MenuLocation using MFiles.MenuLocation enumeration
    1 // Order priority of the menuitem
);

Parameters​

NameOptionalityTypeDescription
customCommandRequirednumberThe command identifier. Use CreateCustomCommand method to create a command.
locationRequiredMenuLocationDetailed menu location where to add the existing custom command.
Possible locations are enumerated.
orderPriorityRequirednumberThe order indication for the command. Smallest priority goes top.

Possible values for the location parameter are

NameValueDescription
MenuLocation_TopPaneMenu47TopPane Menu, typically used for the UI Extension applications.
MenuLocation_ActivityContextMenu_148Menu location for the Activity view Context menu group 1.
MenuLocation_ActivityContextMenu_249Menu location for the Activity view Context menu group 2.
MenuLocation_ActivityContextMenu_350Menu location for the Activity view Context menu group 3.
MenuLocation_ContextMenu_Open51Menu location for the context menu position for the open commands.
MenuLocation_ContextMenu_Checkout52Menu location for the context menu position for the checkout commands.
MenuLocation_ContextMenu_Share53Menu location for the context menu position for the share commands.
MenuLocation_ContextMenu_ObjectOperations26Menu location for the position of object operations in the context menu.
MenuLocation_ContextMenu_ConflictResolution40Menu location for the position of conflict resolution commands in the context menu.
MenuLocation_ContextMenu_DocumentConversions41Menu location for the context menu position for document conversions.
MenuLocation_ContextMenu_WorkflowActions54Menu location for the context menu position for the workflow action commands.
MenuLocation_ContextMenu_Organize55Menu location for the context menu position for the organize commands.
MenuLocation_ContextMenu_VersionControl56Menu location for the context menu position for the version control commands.
MenuLocation_ContextMenu_Create57Menu location for the context menu position for the create commands.
MenuLocation_ContextMenu_ViewOptions58Menu location for the context menu position for the view options commands.
MenuLocation_ContextMenu_Group59Menu location for the context menu position for the grouping commands.
MenuLocation_ContextMenu_DisplayOptions60Menu location for the context menu position for the display options commands.
MenuLocation_ContextMenu_Edit37Menu location for the context menu position for Edit commands.
MenuLocation_ContextMenu_Bottom43Menu location for the bottom of the context menu.
MenuLocation_ContextMenu_More99Menu location for the context menu position for more commands.
MenuLocation_TaskBar_First200Menu location for the first command group in the task bar.

Supported in M-Files Client version 25.10 and later.
MenuLocation_TaskBar_Workspace205Menu location for the "Workspace" command group in the task bar.

Supported in M-Files Client version 25.11 and later.
MenuLocation_TaskBar_MainActions210Menu location for the "Main Actions" command group in the task bar.

Supported in M-Files Client version 25.10 and later.
MenuLocation_TaskBar_Assignments220Menu location for the "Assignments" command group in the task bar.

Supported in M-Files Client version 25.10 and later.
MenuLocation_TaskBar_DocumentCollections230Menu location for the "Document Collections" command group in the task bar.

Supported in M-Files Client version 25.10 and later.
MenuLocation_TaskBar_CheckIn240Menu location for the "Check In" command group in the task bar.

Supported in M-Files Client version 25.10 and later.
MenuLocation_TaskBar_WorkflowStates250Menu location for the "Workflow States" command group in the task bar.

Supported in M-Files Client version 25.10 and later.
MenuLocation_TaskBar_ConflictResolution260Menu location for the "Conflict Resolution" command group in the task bar.

NOTE: Stability is experimental. Non-backward compatible changes or removal may occur in any future release. Use of this feature is not recommended for production environments.
MenuLocation_TaskBar_Last399Menu location for the last command group in the task bar.

Supported in M-Files Client version 25.10 and later.

Return type​

TypeDescription
Promise < number >Returns the Menu item ID.

Example​

This JavaScript code is a UI Extension for M-Files, creating custom commands such as "Hello World" and providing functionality to dynamically show, hide, and remove these commands from the top menu based on user interactions within the M-Files shell.


// Called when the UI Extension starts
function OnNewShellUI(shellUI) {

    // Wait for the ShellFrame to be created.
    shellUI.Events.Register(
        MFiles.Event.NewShellFrame,
        async (shellFrame) => {

            // Wait for the shellframe to start
            shellFrame.Events.Register( 
                MFiles.Event.Started,
                async () => {

                    // Create a new custom command and menu item for the command
                    const createCommand = async ( name: string ) => {

                        // Create a new custom command
                        const commandId = await shellFrame.Commands.CreateCustomCommand(name);

                        // Add the command to the top menu
                        const menuItemId = await shellFrame.Commands.AddCustomCommandToMenu(
                            // Command ID
                            commands.exampleCommand,
                            // Menulocation
                            MFiles.MenuLocation.MenuLocation_TopPaneMenu, 
                            // Priority of the command
                            1 
                        );

                        // Return a data structure containing essential information about the commands
                        return {
                            id: commandId, // ID of the command
                            menuItemId     // Menu item ID, can be used to add sub menus to this menu item.
                        }
                    }

                    // Create an Example command and a set of sample commands to control it's visibility
                    const commands = {
                        // This is the sample command
                        exampleCommand : await createCommand("Hello World"),

                        // These commands control the state of the example command
                        addCommand: await createCommand("Add Command To Menu"),
                        deleteCustomCommand: await createCommand("Delete Command")
                        hideCommand: await createCommand("Hide Command"),
                        showCommand: await createCommand("Activate Command"),
                        executeCommand: await createCommand("Execute Command"),
                        getCommandName: await createCommand("Get Name"),
                        getCommandState: await createCommand("Get Command State"),
                        removeCommandFromMenu: await createCommand("Remove From Menu"), 
                        removeCommand: await createCommand("Remove Command")
                    }

                    // Add the command to the top menu
                    const menuItemId = await shellFrame.Commands.AddCustomCommandToMenu(
                        commands.exampleCommand,
                        MFiles.MenuLocation.MenuLocation_TopPaneMenu, 
                        1 // Priority of the command
                    );

                    // Listen for the custom commands.
                    shellFrame.Commands.Events.Register(

                        // Listen for the CustomCommand events.
                        MFiles.Event.CustomCommand,

                        // Each command has ID and optional data provided with it.
                        ( commandId, data ) => {
                            // Respond to the command if custom command sent by the application 
                            switch( commandId ) {

                                // Run the Example command
                                case commands.exampleCommand.id:
                                    shellFrame.ShowMessage( "Hello World!" );
                                    break;

                                // Add the new menuitem which runs the example command
                                case commands.addCommand.id:
                                    await shellFrame.Commands.AddCustomCommandToMenu(
                                        commands.exampleCommand, 
                                        MFiles.MenuLocation.MenuLocation_TopPaneMenu, 
                                        1 // Priority of the command
                                    );
                                    break;

                                // Removes the command from particular menu
                                case commands.removeCommandFromMenu.id:
                                    await shellFrame.Commands.RemoveCustomCommandFromMenu(
                                        commands.exampleCommand,
                                        MFiles.MenuLocation.MenuLocation_TopPaneMenu
                                    );
                                    break;

                                // Deletes the command permanently
                                case commands.deleteCommand.id:
                                    shellFrame.Commands.DeleteCustomCommand( 
                                        commandId
                                    );
                                    break;

                                // Hides command instance for the specified command ID from the main menu
                                case commands.hideCommand.id:
                                     // Hide the command 
                                    shellFrame.Commands.SetCommandState( 
                                        commandId, 
                                        MFiles.CommandLocation.MainMenu,
                                        MFiles.CommandState.CommandState_Hidden
                                    );
                                    break;

                                // Activates (makes visible) command instance for the specified command ID in the main menu
                                case commands.showCommand.id:
                                     // Show the command 
                                    shellFrame.Commands.SetCommandState( 
                                        commandId, 
                                        MFiles.CommandLocation.MainMenu,
                                        MFiles.CommandState.CommandState_Active
                                    );
                                    break;

                                // Get the command name
                                case commands.getCommandName.id:
                                    const name = await shellFrame.Commands.GetCommandName(commands.exampleCommand.id);
                                    shellFrame.ShowMessage( name );
                                    break;

                                // Get the Command State
                                case commands.getCommandState.id:

                                    // NOTE: the MFiles.CommandLocation.MainMenu must be used to get state of items added to the Top Menu
                                    const commandState = await shellFrame.Commands.SetCommandState(commands.exampleCommand.id, MFiles.CommandLocation.MainMenu );
                                    shellFrame.ShowMessage( `Command state: ${commandState}` );
                                    break;

                            }
                        }
                    );
                }
            )
        }
    )
}

This code is essentially setting up a simple UI extension with custom commands that can be triggered from the top menu, and it allows dynamic control over the visibility of these commands based on user interactions.

Exceptions​

ArgumentError - When customCommand, location, or orderPriority is null, undefined, or invalid (orderPriority must be non-negative).

NotFoundError - When the command is not found, or when the target taskbar group does not exist or access is denied.

DuplicateCommandError - When the command already exists in the specified menu location.

- - + + \ No newline at end of file diff --git a/Frameworks/User-Interface-Extensibility-Framework/Reference/UIExt2/Interfaces/ICommands/CreateCustomCommand/index.html b/Frameworks/User-Interface-Extensibility-Framework/Reference/UIExt2/Interfaces/ICommands/CreateCustomCommand/index.html index 134f477e8..8d0abe40d 100644 --- a/Frameworks/User-Interface-Extensibility-Framework/Reference/UIExt2/Interfaces/ICommands/CreateCustomCommand/index.html +++ b/Frameworks/User-Interface-Extensibility-Framework/Reference/UIExt2/Interfaces/ICommands/CreateCustomCommand/index.html @@ -4,15 +4,15 @@ CreateCustomCommand | M-Files User Interface Extensibility Framework - - + +
Skip to main content

CreateCustomCommand

Description​

The CreateCustomCommand function is a functionality within the M-Files UI Extension framework designed for creating custom commands dynamically. This function enables developers to define and generate new custom commands programmatically. It accepts the name of the command as a parameter, and it returns a unique identifier (ID) associated with the newly created command.

The created command ID can then be consumed for example by

You can control the visibility of the command in M-Files menus using SetCommandState.

Command can be removed using DeleteCustomCommand.

Syntax​

// Create a new custom command using IShellFrame instance.
const commandId = await shellFrame.Commands.CreateCustomCommand(name);

Parameters​

NameOptionalityTypeDescription
commandNameRequiredstringThe custom command's name.

Return type​

TypeDescription
Promise < number >Returns the command id of the created custom command.

Example​

This JavaScript code is a UI Extension for M-Files, creating custom commands such as "Hello World" and providing functionality to dynamically show, hide, and remove these commands from the top menu based on user interactions within the M-Files shell.


// Called when the UI Extension starts
function OnNewShellUI(shellUI) {

    // Wait for the ShellFrame to be created.
    shellUI.Events.Register(
        MFiles.Event.NewShellFrame,
        async (shellFrame) => {

            // Wait for the shellframe to start
            shellFrame.Events.Register( 
                MFiles.Event.Started,
                async () => {

                    // Create a new custom command and menu item for the command
                    const createCommand = async ( name: string ) => {

                        // Create a new custom command
                        const commandId = await shellFrame.Commands.CreateCustomCommand(name);

                        // Add the command to the top menu
                        const menuItemId = await shellFrame.Commands.AddCustomCommandToMenu(
                            // Command ID
                            commands.exampleCommand,
                            // Menulocation
                            MFiles.MenuLocation.MenuLocation_TopPaneMenu, 
                            // Priority of the command
                            1 
                        );

                        // Return a data structure containing essential information about the commands
                        return {
                            id: commandId, // ID of the command
                            menuItemId     // Menu item ID, can be used to add sub menus to this menu item.
                        }
                    }

                    // Create an Example command and a set of sample commands to control it's visibility
                    const commands = {
                        // This is the sample command
                        exampleCommand : await createCommand("Hello World"),

                        // These commands control the state of the example command
                        addCommand: await createCommand("Add Command To Menu"),
                        deleteCustomCommand: await createCommand("Delete Command")
                        hideCommand: await createCommand("Hide Command"),
                        showCommand: await createCommand("Activate Command"),
                        executeCommand: await createCommand("Execute Command"),
                        getCommandName: await createCommand("Get Name"),
                        getCommandState: await createCommand("Get Command State"),
                        removeCommandFromMenu: await createCommand("Remove From Menu"), 
                        removeCommand: await createCommand("Remove Command")
                    }

                    // Add the command to the top menu
                    const menuItemId = await shellFrame.Commands.AddCustomCommandToMenu(
                        commands.exampleCommand,
                        MFiles.MenuLocation.MenuLocation_TopPaneMenu, 
                        1 // Priority of the command
                    );

                    // Listen for the custom commands.
                    shellFrame.Commands.Events.Register(

                        // Listen for the CustomCommand events.
                        MFiles.Event.CustomCommand,

                        // Each command has ID and optional data provided with it.
                        ( commandId, data ) => {
                            // Respond to the command if custom command sent by the application 
                            switch( commandId ) {

                                // Run the Example command
                                case commands.exampleCommand.id:
                                    shellFrame.ShowMessage( "Hello World!" );
                                    break;

                                // Add the new menuitem which runs the example command
                                case commands.addCommand.id:
                                    await shellFrame.Commands.AddCustomCommandToMenu(
                                        commands.exampleCommand, 
                                        MFiles.MenuLocation.MenuLocation_TopPaneMenu, 
                                        1 // Priority of the command
                                    );
                                    break;

                                // Removes the command from particular menu
                                case commands.removeCommandFromMenu.id:
                                    await shellFrame.Commands.RemoveCustomCommandFromMenu(
                                        commands.exampleCommand,
                                        MFiles.MenuLocation.MenuLocation_TopPaneMenu
                                    );
                                    break;

                                // Deletes the command permanently
                                case commands.deleteCommand.id:
                                    shellFrame.Commands.DeleteCustomCommand( 
                                        commandId
                                    );
                                    break;

                                // Hides command instance for the specified command ID from the main menu
                                case commands.hideCommand.id:
                                     // Hide the command 
                                    shellFrame.Commands.SetCommandState( 
                                        commandId, 
                                        MFiles.CommandLocation.MainMenu,
                                        MFiles.CommandState.CommandState_Hidden
                                    );
                                    break;

                                // Activates (makes visible) command instance for the specified command ID in the main menu
                                case commands.showCommand.id:
                                     // Show the command 
                                    shellFrame.Commands.SetCommandState( 
                                        commandId, 
                                        MFiles.CommandLocation.MainMenu,
                                        MFiles.CommandState.CommandState_Active
                                    );
                                    break;

                                // Get the command name
                                case commands.getCommandName.id:
                                    const name = await shellFrame.Commands.GetCommandName(commands.exampleCommand.id);
                                    shellFrame.ShowMessage( name );
                                    break;

                                // Get the Command State
                                case commands.getCommandState.id:

                                    // NOTE: the MFiles.CommandLocation.MainMenu must be used to get state of items added to the Top Menu
                                    const commandState = await shellFrame.Commands.SetCommandState(commands.exampleCommand.id, MFiles.CommandLocation.MainMenu );
                                    shellFrame.ShowMessage( `Command state: ${commandState}` );
                                    break;

                            }
                        }
                    );
                }
            )
        }
    )
}

This code is essentially setting up a simple UI extension with custom commands that can be triggered from the top menu, and it allows dynamic control over the visibility of these commands based on user interactions.

Exceptions​

ArgumentError - When commandName is null or undefined.

- - + + \ No newline at end of file diff --git a/Frameworks/User-Interface-Extensibility-Framework/Reference/UIExt2/Interfaces/ICommands/CreateSubMenuItem/index.html b/Frameworks/User-Interface-Extensibility-Framework/Reference/UIExt2/Interfaces/ICommands/CreateSubMenuItem/index.html index 4609556cd..c6c703ba6 100644 --- a/Frameworks/User-Interface-Extensibility-Framework/Reference/UIExt2/Interfaces/ICommands/CreateSubMenuItem/index.html +++ b/Frameworks/User-Interface-Extensibility-Framework/Reference/UIExt2/Interfaces/ICommands/CreateSubMenuItem/index.html @@ -4,13 +4,13 @@ CreateSubMenuItem | M-Files User Interface Extensibility Framework - - + +
Skip to main content

CreateSubMenuItem

Description​

Creates a new SubMenu for already created Menu.

Syntax​

// shellFrame points here into the IShellFrame interface
const result = await shellFrame.Commands.CreateSubMenuItem(
  parentMenuItemId,
  customCommand,
  orderPriority,
);

Parameters​

NameOptionalityTypeDescription
parentMenuItemIdRequirednumberID of the Parent MenuItem.
customCommandRequirednumberCommand to execute when the MenuItem is selected.
orderPriorityRequirednumberPriority to assign to the new item.

Return type​

TypeDescription
Promise < number >ID of the newly created MenuItem.

Exceptions​

ArgumentError - parentMenuItemId, customCommand, or orderPriority is null or undefined, or when a builtin command is used as parent that doesn't support submenus.

NotFoundError - When the parent menu item or command is not found or access is denied.

DuplicateCommandError - When the command already exists in the menu.

InvalidOperationError - When the command location ID is null or undefined.

- - + + \ No newline at end of file diff --git a/Frameworks/User-Interface-Extensibility-Framework/Reference/UIExt2/Interfaces/ICommands/CreateTaskbarGroup/index.html b/Frameworks/User-Interface-Extensibility-Framework/Reference/UIExt2/Interfaces/ICommands/CreateTaskbarGroup/index.html index 26ac0605a..85b686840 100644 --- a/Frameworks/User-Interface-Extensibility-Framework/Reference/UIExt2/Interfaces/ICommands/CreateTaskbarGroup/index.html +++ b/Frameworks/User-Interface-Extensibility-Framework/Reference/UIExt2/Interfaces/ICommands/CreateTaskbarGroup/index.html @@ -4,8 +4,8 @@ CreateTaskbarGroup | M-Files User Interface Extensibility Framework - - + +
@@ -20,7 +20,7 @@ Custom commands (created using the CreateCustomCommand function) can then be added to these groups using the AddCustomCommandToMenu function.

Location parameter specifies where in the taskbar the new group will appear. It can be:

The function returns a new location ID that can be used as MenuLocation parameter in the AddCustomCommandToMenu function.

Empty groups are not visible. A group will appear in the taskbar only after at least one command has been added to it.

To remove a custom group, use the RemoveTaskbarGroup function.

See Taskbar Commands sample for example code.

Syntax​

// shellFrame points here into the IShellFrame interface
const result = await shellFrame.Commands.CreateTaskbarGroup(
  name,
  location,
  orderPriority,
);

Parameters​

NameOptionalityTypeDescription
nameRequiredstringName for the group. Group names are unique; if a custom group with the same name
already exists, its ID is returned instead and the group will be shared between applications.
locationRequiredMenuLocationThe taskbar location where the new group will be created. It can be one of
the MenuLocationTaskBar* values. MenuLocation_TaskBar_First and MenuLocation_TaskBar_Last are used to create
the group at the beginning or end of the taskbar. Other values place the group next to the corresponding
built-in command group. The recommended value is MenuLocation_TaskBar_Last to create the group at the end of the taskbar.
orderPriorityRequirednumberOrder priority of the new group. Lower priority groups are shown first.

Return type​

TypeDescription
Promise < number >Id for the new task bar group or existing group if one with the same name exists.

Exceptions​

NotSupportedError - When task bar feature support is not enabled.

Error - When application GUID is missing.

- - + + \ No newline at end of file diff --git a/Frameworks/User-Interface-Extensibility-Framework/Reference/UIExt2/Interfaces/ICommands/DeleteCustomCommand/index.html b/Frameworks/User-Interface-Extensibility-Framework/Reference/UIExt2/Interfaces/ICommands/DeleteCustomCommand/index.html index a6ab8ebe6..3e723511b 100644 --- a/Frameworks/User-Interface-Extensibility-Framework/Reference/UIExt2/Interfaces/ICommands/DeleteCustomCommand/index.html +++ b/Frameworks/User-Interface-Extensibility-Framework/Reference/UIExt2/Interfaces/ICommands/DeleteCustomCommand/index.html @@ -4,13 +4,13 @@ DeleteCustomCommand | M-Files User Interface Extensibility Framework - - + +
Skip to main content

DeleteCustomCommand

Description​

Deletes a custom command. The command is automatically removed.

Syntax​

// shellFrame points here into the IShellFrame interface
await shellFrame.Commands.DeleteCustomCommand(customCommand);

Parameters​

NameOptionalityTypeDescription
customCommandRequirednumberThe command id to delete. The command must be a custom command.

Return type​

TypeDescription
Promise < void >Method does not return a value

Exceptions​

ArgumentError - When customCommand is null or undefined.

NotFoundError - When the command is not found or access is denied.

- - + + \ No newline at end of file diff --git a/Frameworks/User-Interface-Extensibility-Framework/Reference/UIExt2/Interfaces/ICommands/ExecuteCommand/index.html b/Frameworks/User-Interface-Extensibility-Framework/Reference/UIExt2/Interfaces/ICommands/ExecuteCommand/index.html index a79fd9f3c..ce5fb2cf3 100644 --- a/Frameworks/User-Interface-Extensibility-Framework/Reference/UIExt2/Interfaces/ICommands/ExecuteCommand/index.html +++ b/Frameworks/User-Interface-Extensibility-Framework/Reference/UIExt2/Interfaces/ICommands/ExecuteCommand/index.html @@ -4,14 +4,14 @@ ExecuteCommand | M-Files User Interface Extensibility Framework - - + +
Skip to main content

ExecuteCommand

Description​

Executes a user command or a built-in command.

This method can execute both custom commands (created via CreateCustomCommand) and built-in commands (from the BuiltinCommand enumeration).

Syntax​

// Execute a new custom command with data parameter
await shellFrame.Commands.ExecuteCommand(commandId, {
    someCustomData: 1234
});

Parameters​

NameOptionalityTypeDescription
commandIdRequirednumberThe command id. Can be a built-in command enumerated value or custom command id.
argsOptionalanyCommand-specific arguments. Different commands expect different argument structures:

| Command | args type | Description |
|---------|-----------|-------------|
| NewObject | { TemplateInfo: { Type: number, ClassID?, Name? } } | Object type and optional template info |
| MakeCopy | { TemplateInfo?: { Type, ClassID, ObjectInfo } } | Optional template for the copy |
| CheckOut | { ObjectsInfo?: IShellItems } | Objects to check out (uses selection if not provided) |
| CheckIn | { ObjectsInfo?: IShellItems } | Objects to check in (uses selection if not provided) |
| UndoCheckOut | { ObjectsInfo?: IShellItems } | Objects to undo checkout (uses selection if not provided) |
| Delete | { ObjectsInfo?: IShellItems } | Objects to delete (uses selection if not provided) |
| DownloadFile | { ObjectsInfo?: IShellItems } | Files to download (uses selection if not provided) |
| OpenFile | { ObjectsInfo?: IShellItems, isDoubleClicked? } | File to open |
| LaunchDefaultApp | { ObjectsInfo?: IShellItems, isDoubleClicked? } | Open file in default application |
| BrowseRelatedObjects | { ObjectsInfo?: IShellItems, objectTypeId: number } | Browse related objects of type |
| ShowHistory | { ObjectsInfo?: IShellItems } | Show version history |
| RollBack | undefined | Uses selection in history view |
| Refresh | undefined | No arguments needed |
| Follow/Unfollow | undefined | Uses current selection |
| AddRelationship | { sourceObject?: IObjectVersionEx } | Source object (uses selection if not provided) |
| EditRelationship | { sourceObject?: IObjectVersionEx, targetRelatedObject: IObjectVersionEx, relationshipDirections: RelationshipDirection[], relationshipPropertyDef: number } | Edit relationship target version |
| RemoveRelationship | { sourceObject?: IObjectVersionEx, targetRelatedObject: IObjectVersionEx, relationshipDirections: RelationshipDirection[], relationshipPropertyDef: number } | Remove a relationship |

Return type​

TypeDescription
Promise < void >Method does not return a value

Exceptions​

ArgumentError - When commandId is null or undefined.

NotFoundError - When the command is not found or access is denied.

- - + + \ No newline at end of file diff --git a/Frameworks/User-Interface-Extensibility-Framework/Reference/UIExt2/Interfaces/ICommands/GetCommandName/index.html b/Frameworks/User-Interface-Extensibility-Framework/Reference/UIExt2/Interfaces/ICommands/GetCommandName/index.html index 7b8a797bd..7f898e1ff 100644 --- a/Frameworks/User-Interface-Extensibility-Framework/Reference/UIExt2/Interfaces/ICommands/GetCommandName/index.html +++ b/Frameworks/User-Interface-Extensibility-Framework/Reference/UIExt2/Interfaces/ICommands/GetCommandName/index.html @@ -4,13 +4,13 @@ GetCommandName | M-Files User Interface Extensibility Framework - - + +
Skip to main content

GetCommandName

Description​

Resolves the name that has been associated with the given command id.

Syntax​

// shellFrame points here into the IShellFrame interface
const result = await shellFrame.Commands.GetCommandName(commandId);

Parameters​

NameOptionalityTypeDescription
commandIdRequirednumberThe command id. Can be a builtin command, enumerated value or custom command id.

Return type​

TypeDescription
Promise < string >Returns the name of the command.

Exceptions​

ArgumentError - When commandId is null or undefined.

NotFoundError - When the command is not found or access is denied.

- - + + \ No newline at end of file diff --git a/Frameworks/User-Interface-Extensibility-Framework/Reference/UIExt2/Interfaces/ICommands/GetCommandState/index.html b/Frameworks/User-Interface-Extensibility-Framework/Reference/UIExt2/Interfaces/ICommands/GetCommandState/index.html index 6af7c1537..1ac7874cf 100644 --- a/Frameworks/User-Interface-Extensibility-Framework/Reference/UIExt2/Interfaces/ICommands/GetCommandState/index.html +++ b/Frameworks/User-Interface-Extensibility-Framework/Reference/UIExt2/Interfaces/ICommands/GetCommandState/index.html @@ -4,13 +4,13 @@ GetCommandState | M-Files User Interface Extensibility Framework - - + +
Skip to main content

GetCommandState

Description​

Gets the command state for builtin or custom command in specified location.

Syntax​

// shellFrame points here into the IShellFrame interface
const result = await shellFrame.Commands.GetCommandState(
  command,
  location,
  includeBuiltInState,
  includeScriptSpecifiedState,
);

Parameters​

NameOptionalityTypeDescription
commandRequirednumberThe command id. Can be a builtin command enumerated value or custom command id.
locationRequiredCommandLocationDetailed command location to examine. Possible locations are enumerated.
includeBuiltInStateRequiredbooleanIf true, takes the built-in state of the command into account.
includeScriptSpecifiedStateRequiredbooleanIf true, accounts for the script-specified state of the command.

Possible values for the command location are:

NameValueDescription
Undefined0Undefined value.
MainMenu1Specifies the command appearance in the main menus, such as top menu and command bars.
ContextMenu2Specifies the command appearance in the context menu.
ActivityContextMenu6Specifies the command appearance in the activity context menu.
TaskBar7Specifies the command appearance on task bar.

Supported in M-Files Client version 25.10 and later.
All268435455Refers to all command locations.

NOTE: Stability is experimental. Non-backward compatible changes or removal may occur in any future release. Use of this feature is not recommended for production environments.

Return type​

TypeDescription
Promise < CommandState >The command state.

Exceptions​

ArgumentError - When command, location, includeBuiltInState, or includeScriptSpecifiedState is null or undefined.

NotFoundError - If the command is not found or access is denied.

- - + + \ No newline at end of file diff --git a/Frameworks/User-Interface-Extensibility-Framework/Reference/UIExt2/Interfaces/ICommands/GetMenuIdOfBuiltInCommand/index.html b/Frameworks/User-Interface-Extensibility-Framework/Reference/UIExt2/Interfaces/ICommands/GetMenuIdOfBuiltInCommand/index.html index a9413812d..f6d0f390e 100644 --- a/Frameworks/User-Interface-Extensibility-Framework/Reference/UIExt2/Interfaces/ICommands/GetMenuIdOfBuiltInCommand/index.html +++ b/Frameworks/User-Interface-Extensibility-Framework/Reference/UIExt2/Interfaces/ICommands/GetMenuIdOfBuiltInCommand/index.html @@ -4,13 +4,13 @@ GetMenuIdOfBuiltInCommand | M-Files User Interface Extensibility Framework - - + +
Skip to main content

GetMenuIdOfBuiltInCommand

Description​

Gets the MenuItem ID of a built-in command by its command ID and location.

Syntax​

// shellFrame points here into the IShellFrame interface
const result = await shellFrame.Commands.GetMenuIdOfBuiltInCommand(
  commandId,
  commandLocation,
);

Parameters​

NameOptionalityTypeDescription
commandIdRequirednumberThe unique identifier for the command.
commandLocationRequiredCommandLocationThe location where the command is placed.

Return type​

TypeDescription
Promise < number >The UI ID of the built-in command if found, otherwise throw 'Not Found' error.

Exceptions​

ArgumentError - When commandId or commandLocation is null or undefined, or when commandId is not a built-in command.

NotFoundError - When the command is not found or access is denied.

- - + + \ No newline at end of file diff --git a/Frameworks/User-Interface-Extensibility-Framework/Reference/UIExt2/Interfaces/ICommands/RemoveCustomCommandFromMenu/index.html b/Frameworks/User-Interface-Extensibility-Framework/Reference/UIExt2/Interfaces/ICommands/RemoveCustomCommandFromMenu/index.html index 74a96544a..2c32770ac 100644 --- a/Frameworks/User-Interface-Extensibility-Framework/Reference/UIExt2/Interfaces/ICommands/RemoveCustomCommandFromMenu/index.html +++ b/Frameworks/User-Interface-Extensibility-Framework/Reference/UIExt2/Interfaces/ICommands/RemoveCustomCommandFromMenu/index.html @@ -4,13 +4,13 @@ RemoveCustomCommandFromMenu | M-Files User Interface Extensibility Framework - - + +
Skip to main content

RemoveCustomCommandFromMenu

Description​

Removes a custom command from the specified menu location.

Syntax​

await shellFrame.Commands.RemoveCustomCommandFromMenu(
    commandId, 
    MFiles.MenuLocation.MenuLocation_TopPaneMenu
);

Parameters​

NameOptionalityTypeDescription
customCommandRequirednumberThe custom command id.
locationRequiredMenuLocationMenu location where the command is removed. Possible locations are enumerated.

Possible values for the location parameter are

NameValueDescription
MenuLocation_TopPaneMenu47TopPane Menu, typically used for the UI Extension applications.
MenuLocation_ActivityContextMenu_148Menu location for the Activity view Context menu group 1.
MenuLocation_ActivityContextMenu_249Menu location for the Activity view Context menu group 2.
MenuLocation_ActivityContextMenu_350Menu location for the Activity view Context menu group 3.
MenuLocation_ContextMenu_Open51Menu location for the context menu position for the open commands.
MenuLocation_ContextMenu_Checkout52Menu location for the context menu position for the checkout commands.
MenuLocation_ContextMenu_Share53Menu location for the context menu position for the share commands.
MenuLocation_ContextMenu_ObjectOperations26Menu location for the position of object operations in the context menu.
MenuLocation_ContextMenu_ConflictResolution40Menu location for the position of conflict resolution commands in the context menu.
MenuLocation_ContextMenu_DocumentConversions41Menu location for the context menu position for document conversions.
MenuLocation_ContextMenu_WorkflowActions54Menu location for the context menu position for the workflow action commands.
MenuLocation_ContextMenu_Organize55Menu location for the context menu position for the organize commands.
MenuLocation_ContextMenu_VersionControl56Menu location for the context menu position for the version control commands.
MenuLocation_ContextMenu_Create57Menu location for the context menu position for the create commands.
MenuLocation_ContextMenu_ViewOptions58Menu location for the context menu position for the view options commands.
MenuLocation_ContextMenu_Group59Menu location for the context menu position for the grouping commands.
MenuLocation_ContextMenu_DisplayOptions60Menu location for the context menu position for the display options commands.
MenuLocation_ContextMenu_Edit37Menu location for the context menu position for Edit commands.
MenuLocation_ContextMenu_Bottom43Menu location for the bottom of the context menu.
MenuLocation_ContextMenu_More99Menu location for the context menu position for more commands.
MenuLocation_TaskBar_First200Menu location for the first command group in the task bar.

Supported in M-Files Client version 25.10 and later.
MenuLocation_TaskBar_Workspace205Menu location for the "Workspace" command group in the task bar.

Supported in M-Files Client version 25.11 and later.
MenuLocation_TaskBar_MainActions210Menu location for the "Main Actions" command group in the task bar.

Supported in M-Files Client version 25.10 and later.
MenuLocation_TaskBar_Assignments220Menu location for the "Assignments" command group in the task bar.

Supported in M-Files Client version 25.10 and later.
MenuLocation_TaskBar_DocumentCollections230Menu location for the "Document Collections" command group in the task bar.

Supported in M-Files Client version 25.10 and later.
MenuLocation_TaskBar_CheckIn240Menu location for the "Check In" command group in the task bar.

Supported in M-Files Client version 25.10 and later.
MenuLocation_TaskBar_WorkflowStates250Menu location for the "Workflow States" command group in the task bar.

Supported in M-Files Client version 25.10 and later.
MenuLocation_TaskBar_ConflictResolution260Menu location for the "Conflict Resolution" command group in the task bar.

NOTE: Stability is experimental. Non-backward compatible changes or removal may occur in any future release. Use of this feature is not recommended for production environments.
MenuLocation_TaskBar_Last399Menu location for the last command group in the task bar.

Supported in M-Files Client version 25.10 and later.

Return type​

TypeDescription
Promise < void >Method does not return a value

Example​

This JavaScript code is a UI Extension for M-Files, creating custom commands such as "Hello World" and providing functionality to dynamically show, hide, and remove these commands from the top menu based on user interactions within the M-Files shell.


// Called when the UI Extension starts
function OnNewShellUI(shellUI) {

    // Wait for the ShellFrame to be created.
    shellUI.Events.Register(
        MFiles.Event.NewShellFrame,
        async (shellFrame) => {

            // Wait for the shellframe to start
            shellFrame.Events.Register( 
                MFiles.Event.Started,
                async () => {

                    // Create a new custom command and menu item for the command
                    const createCommand = async ( name: string ) => {

                        // Create a new custom command
                        const commandId = await shellFrame.Commands.CreateCustomCommand(name);

                        // Add the command to the top menu
                        const menuItemId = await shellFrame.Commands.AddCustomCommandToMenu(
                            // Command ID
                            commands.exampleCommand,
                            // Menulocation
                            MFiles.MenuLocation.MenuLocation_TopPaneMenu, 
                            // Priority of the command
                            1 
                        );

                        // Return a data structure containing essential information about the commands
                        return {
                            id: commandId, // ID of the command
                            menuItemId     // Menu item ID, can be used to add sub menus to this menu item.
                        }
                    }

                    // Create an Example command and a set of sample commands to control it's visibility
                    const commands = {
                        // This is the sample command
                        exampleCommand : await createCommand("Hello World"),

                        // These commands control the state of the example command
                        addCommand: await createCommand("Add Command To Menu"),
                        deleteCustomCommand: await createCommand("Delete Command")
                        hideCommand: await createCommand("Hide Command"),
                        showCommand: await createCommand("Activate Command"),
                        executeCommand: await createCommand("Execute Command"),
                        getCommandName: await createCommand("Get Name"),
                        getCommandState: await createCommand("Get Command State"),
                        removeCommandFromMenu: await createCommand("Remove From Menu"), 
                        removeCommand: await createCommand("Remove Command")
                    }

                    // Add the command to the top menu
                    const menuItemId = await shellFrame.Commands.AddCustomCommandToMenu(
                        commands.exampleCommand,
                        MFiles.MenuLocation.MenuLocation_TopPaneMenu, 
                        1 // Priority of the command
                    );

                    // Listen for the custom commands.
                    shellFrame.Commands.Events.Register(

                        // Listen for the CustomCommand events.
                        MFiles.Event.CustomCommand,

                        // Each command has ID and optional data provided with it.
                        ( commandId, data ) => {
                            // Respond to the command if custom command sent by the application 
                            switch( commandId ) {

                                // Run the Example command
                                case commands.exampleCommand.id:
                                    shellFrame.ShowMessage( "Hello World!" );
                                    break;

                                // Add the new menuitem which runs the example command
                                case commands.addCommand.id:
                                    await shellFrame.Commands.AddCustomCommandToMenu(
                                        commands.exampleCommand, 
                                        MFiles.MenuLocation.MenuLocation_TopPaneMenu, 
                                        1 // Priority of the command
                                    );
                                    break;

                                // Removes the command from particular menu
                                case commands.removeCommandFromMenu.id:
                                    await shellFrame.Commands.RemoveCustomCommandFromMenu(
                                        commands.exampleCommand,
                                        MFiles.MenuLocation.MenuLocation_TopPaneMenu
                                    );
                                    break;

                                // Deletes the command permanently
                                case commands.deleteCommand.id:
                                    shellFrame.Commands.DeleteCustomCommand( 
                                        commandId
                                    );
                                    break;

                                // Hides command instance for the specified command ID from the main menu
                                case commands.hideCommand.id:
                                     // Hide the command 
                                    shellFrame.Commands.SetCommandState( 
                                        commandId, 
                                        MFiles.CommandLocation.MainMenu,
                                        MFiles.CommandState.CommandState_Hidden
                                    );
                                    break;

                                // Activates (makes visible) command instance for the specified command ID in the main menu
                                case commands.showCommand.id:
                                     // Show the command 
                                    shellFrame.Commands.SetCommandState( 
                                        commandId, 
                                        MFiles.CommandLocation.MainMenu,
                                        MFiles.CommandState.CommandState_Active
                                    );
                                    break;

                                // Get the command name
                                case commands.getCommandName.id:
                                    const name = await shellFrame.Commands.GetCommandName(commands.exampleCommand.id);
                                    shellFrame.ShowMessage( name );
                                    break;

                                // Get the Command State
                                case commands.getCommandState.id:

                                    // NOTE: the MFiles.CommandLocation.MainMenu must be used to get state of items added to the Top Menu
                                    const commandState = await shellFrame.Commands.SetCommandState(commands.exampleCommand.id, MFiles.CommandLocation.MainMenu );
                                    shellFrame.ShowMessage( `Command state: ${commandState}` );
                                    break;

                            }
                        }
                    );
                }
            )
        }
    )
}

This code is essentially setting up a simple UI extension with custom commands that can be triggered from the top menu, and it allows dynamic control over the visibility of these commands based on user interactions.

Exceptions​

ArgumentError - When customCommand or location is null or undefined, or when appGuid/dashboardId is missing for toolbar locations.

NotFoundError - When the command is not found or access is denied.

- - + + \ No newline at end of file diff --git a/Frameworks/User-Interface-Extensibility-Framework/Reference/UIExt2/Interfaces/ICommands/RemoveMenuItem/index.html b/Frameworks/User-Interface-Extensibility-Framework/Reference/UIExt2/Interfaces/ICommands/RemoveMenuItem/index.html index e1976e198..a42b99778 100644 --- a/Frameworks/User-Interface-Extensibility-Framework/Reference/UIExt2/Interfaces/ICommands/RemoveMenuItem/index.html +++ b/Frameworks/User-Interface-Extensibility-Framework/Reference/UIExt2/Interfaces/ICommands/RemoveMenuItem/index.html @@ -4,13 +4,13 @@ RemoveMenuItem | M-Files User Interface Extensibility Framework - - + +
Skip to main content

RemoveMenuItem

Description​

Removes menuitem from the menu.

Syntax​

// shellFrame points here into the IShellFrame interface
await shellFrame.Commands.RemoveMenuItem(menuItemId);

Parameters​

NameOptionalityTypeDescription
menuItemIdRequirednumberId of the MenuItem to remove.

Return type​

TypeDescription
Promise < void >Method does not return a value

Exceptions​

ArgumentError - When menuItemId is null or undefined.

NotFoundError - When the menu item is not found or access is denied.

- - + + \ No newline at end of file diff --git a/Frameworks/User-Interface-Extensibility-Framework/Reference/UIExt2/Interfaces/ICommands/RemoveTaskbarGroup/index.html b/Frameworks/User-Interface-Extensibility-Framework/Reference/UIExt2/Interfaces/ICommands/RemoveTaskbarGroup/index.html index ddd76c186..ac19af058 100644 --- a/Frameworks/User-Interface-Extensibility-Framework/Reference/UIExt2/Interfaces/ICommands/RemoveTaskbarGroup/index.html +++ b/Frameworks/User-Interface-Extensibility-Framework/Reference/UIExt2/Interfaces/ICommands/RemoveTaskbarGroup/index.html @@ -4,8 +4,8 @@ RemoveTaskbarGroup | M-Files User Interface Extensibility Framework - - + +
@@ -14,7 +14,7 @@ and the group is no longer available to the calling application. The group remains available for other applications using it. If the group is not shared, it is removed completely.

Supported in M-Files Client version 25.10 and later.

Syntax​

// shellFrame points here into the IShellFrame interface
await shellFrame.Commands.RemoveTaskbarGroup(groupId);

Parameters​

NameOptionalityTypeDescription
groupIdRequirednumberThe ID of the task bar group to remove.

Return type​

TypeDescription
Promise < void >Method does not return a value

Exceptions​

NotSupportedError - When task bar feature support is not enabled.

Error - When application GUID is missing or when the task bar group is invalid or not owned by the application.

- - + + \ No newline at end of file diff --git a/Frameworks/User-Interface-Extensibility-Framework/Reference/UIExt2/Interfaces/ICommands/SetCommandState/index.html b/Frameworks/User-Interface-Extensibility-Framework/Reference/UIExt2/Interfaces/ICommands/SetCommandState/index.html index cbf84f3bb..7a7916ea0 100644 --- a/Frameworks/User-Interface-Extensibility-Framework/Reference/UIExt2/Interfaces/ICommands/SetCommandState/index.html +++ b/Frameworks/User-Interface-Extensibility-Framework/Reference/UIExt2/Interfaces/ICommands/SetCommandState/index.html @@ -4,14 +4,14 @@ SetCommandState | M-Files User Interface Extensibility Framework - - + +
Skip to main content

SetCommandState

Description​

Sets the command's state to be hidden, visible, enabled or disabled. Calling this method may affect context menu, application toolbar, menus or all of them.

Syntax​

shellFrame.Commands.SetCommandState( 
    commandId, // The ID of the command which state is to be changed
    MFiles.CommandLocation.MainMenu, // The location in the UI where the command's state is being changed
    MFiles.CommandState.CommandState_Hidden  // New state of the command in specific location
);

Parameters​

NameOptionalityTypeDescription
commandIdRequirednumberThe id of the target command. The id can represent either a
custom or a builtincommand. The builtin commands are enumerated by BuiltinCommand.
locationRequiredCommandLocationMenu location where the command state change takes place.
Use All to affect in all locations.
stateRequiredCommandStateThe new command state.

CommandLocation​

Values for the location are

NameValueDescription
Undefined0Undefined value.
MainMenu1Specifies the command appearance in the main menus, such as top menu and command bars.
ContextMenu2Specifies the command appearance in the context menu.
ActivityContextMenu6Specifies the command appearance in the activity context menu.
TaskBar7Specifies the command appearance on task bar.

Supported in M-Files Client version 25.10 and later.
All268435455Refers to all command locations.

NOTE: Stability is experimental. Non-backward compatible changes or removal may occur in any future release. Use of this feature is not recommended for production environments.

CommandState​

Values for the state are

NameValueDescription
CommandState_Undefined0Undefined value.
CommandState_Active1The command is visible and enabled.
CommandState_Hidden3The command is not visible.

Return type​

TypeDescription
Promise < void >Method does not return a value

Example​

This JavaScript code is a UI Extension for M-Files, creating custom commands such as "Hello World" and providing functionality to dynamically show, hide, and remove these commands from the top menu based on user interactions within the M-Files shell.


// Called when the UI Extension starts
function OnNewShellUI(shellUI) {

    // Wait for the ShellFrame to be created.
    shellUI.Events.Register(
        MFiles.Event.NewShellFrame,
        async (shellFrame) => {

            // Wait for the shellframe to start
            shellFrame.Events.Register( 
                MFiles.Event.Started,
                async () => {

                    // Create a new custom command and menu item for the command
                    const createCommand = async ( name: string ) => {

                        // Create a new custom command
                        const commandId = await shellFrame.Commands.CreateCustomCommand(name);

                        // Add the command to the top menu
                        const menuItemId = await shellFrame.Commands.AddCustomCommandToMenu(
                            // Command ID
                            commands.exampleCommand,
                            // Menulocation
                            MFiles.MenuLocation.MenuLocation_TopPaneMenu, 
                            // Priority of the command
                            1 
                        );

                        // Return a data structure containing essential information about the commands
                        return {
                            id: commandId, // ID of the command
                            menuItemId     // Menu item ID, can be used to add sub menus to this menu item.
                        }
                    }

                    // Create an Example command and a set of sample commands to control it's visibility
                    const commands = {
                        // This is the sample command
                        exampleCommand : await createCommand("Hello World"),

                        // These commands control the state of the example command
                        addCommand: await createCommand("Add Command To Menu"),
                        deleteCustomCommand: await createCommand("Delete Command")
                        hideCommand: await createCommand("Hide Command"),
                        showCommand: await createCommand("Activate Command"),
                        executeCommand: await createCommand("Execute Command"),
                        getCommandName: await createCommand("Get Name"),
                        getCommandState: await createCommand("Get Command State"),
                        removeCommandFromMenu: await createCommand("Remove From Menu"), 
                        removeCommand: await createCommand("Remove Command")
                    }

                    // Add the command to the top menu
                    const menuItemId = await shellFrame.Commands.AddCustomCommandToMenu(
                        commands.exampleCommand,
                        MFiles.MenuLocation.MenuLocation_TopPaneMenu, 
                        1 // Priority of the command
                    );

                    // Listen for the custom commands.
                    shellFrame.Commands.Events.Register(

                        // Listen for the CustomCommand events.
                        MFiles.Event.CustomCommand,

                        // Each command has ID and optional data provided with it.
                        ( commandId, data ) => {
                            // Respond to the command if custom command sent by the application 
                            switch( commandId ) {

                                // Run the Example command
                                case commands.exampleCommand.id:
                                    shellFrame.ShowMessage( "Hello World!" );
                                    break;

                                // Add the new menuitem which runs the example command
                                case commands.addCommand.id:
                                    await shellFrame.Commands.AddCustomCommandToMenu(
                                        commands.exampleCommand, 
                                        MFiles.MenuLocation.MenuLocation_TopPaneMenu, 
                                        1 // Priority of the command
                                    );
                                    break;

                                // Removes the command from particular menu
                                case commands.removeCommandFromMenu.id:
                                    await shellFrame.Commands.RemoveCustomCommandFromMenu(
                                        commands.exampleCommand,
                                        MFiles.MenuLocation.MenuLocation_TopPaneMenu
                                    );
                                    break;

                                // Deletes the command permanently
                                case commands.deleteCommand.id:
                                    shellFrame.Commands.DeleteCustomCommand( 
                                        commandId
                                    );
                                    break;

                                // Hides command instance for the specified command ID from the main menu
                                case commands.hideCommand.id:
                                     // Hide the command 
                                    shellFrame.Commands.SetCommandState( 
                                        commandId, 
                                        MFiles.CommandLocation.MainMenu,
                                        MFiles.CommandState.CommandState_Hidden
                                    );
                                    break;

                                // Activates (makes visible) command instance for the specified command ID in the main menu
                                case commands.showCommand.id:
                                     // Show the command 
                                    shellFrame.Commands.SetCommandState( 
                                        commandId, 
                                        MFiles.CommandLocation.MainMenu,
                                        MFiles.CommandState.CommandState_Active
                                    );
                                    break;

                                // Get the command name
                                case commands.getCommandName.id:
                                    const name = await shellFrame.Commands.GetCommandName(commands.exampleCommand.id);
                                    shellFrame.ShowMessage( name );
                                    break;

                                // Get the Command State
                                case commands.getCommandState.id:

                                    // NOTE: the MFiles.CommandLocation.MainMenu must be used to get state of items added to the Top Menu
                                    const commandState = await shellFrame.Commands.SetCommandState(commands.exampleCommand.id, MFiles.CommandLocation.MainMenu );
                                    shellFrame.ShowMessage( `Command state: ${commandState}` );
                                    break;

                            }
                        }
                    );
                }
            )
        }
    )
}

This code is essentially setting up a simple UI extension with custom commands that can be triggered from the top menu, and it allows dynamic control over the visibility of these commands based on user interactions.

Exceptions​

ArgumentError - When commandId, location, or state is null or undefined.

NotFoundError - When the command is not found or access is denied.

- - + + \ No newline at end of file diff --git a/Frameworks/User-Interface-Extensibility-Framework/Reference/UIExt2/Interfaces/ICommands/SetIcon/index.html b/Frameworks/User-Interface-Extensibility-Framework/Reference/UIExt2/Interfaces/ICommands/SetIcon/index.html index 716bb2cd4..5c1611a80 100644 --- a/Frameworks/User-Interface-Extensibility-Framework/Reference/UIExt2/Interfaces/ICommands/SetIcon/index.html +++ b/Frameworks/User-Interface-Extensibility-Framework/Reference/UIExt2/Interfaces/ICommands/SetIcon/index.html @@ -4,13 +4,13 @@ SetIcon | M-Files User Interface Extensibility Framework - - + +
Skip to main content

SetIcon

Description​

Sets the icon for a custom command.

Supported in M-Files Client version 25.10 and later.

Syntax​

// shellFrame points here into the IShellFrame interface
const result = await shellFrame.Commands.SetIcon(
  customCommand,
  iconInformation,
);

Parameters​

NameOptionalityTypeDescription
customCommandRequirednumberThe custom command id.
iconInformationRequiredIIconInformationThe icon information.

Return type​

TypeDescription
Promise < void >

Exceptions​

ArgumentError - When customCommand or iconInformation is null or undefined.

NotFoundError - When the command is not found or access is denied.

- - + + \ No newline at end of file diff --git a/Frameworks/User-Interface-Extensibility-Framework/Reference/UIExt2/Interfaces/ICommands/SetMenuItemState/index.html b/Frameworks/User-Interface-Extensibility-Framework/Reference/UIExt2/Interfaces/ICommands/SetMenuItemState/index.html index f40b75627..c83f6f2b3 100644 --- a/Frameworks/User-Interface-Extensibility-Framework/Reference/UIExt2/Interfaces/ICommands/SetMenuItemState/index.html +++ b/Frameworks/User-Interface-Extensibility-Framework/Reference/UIExt2/Interfaces/ICommands/SetMenuItemState/index.html @@ -4,13 +4,13 @@ SetMenuItemState | M-Files User Interface Extensibility Framework - - + +
Skip to main content

SetMenuItemState

Description​

Sets the MenuItem state individually.

Syntax​

// shellFrame points here into the IShellFrame interface
await shellFrame.Commands.SetMenuItemState(menuItemId, state);

Parameters​

NameOptionalityTypeDescription
menuItemIdRequirednumberMenuitem to enable.
stateRequiredCommandStateState to set to the item.

Return type​

TypeDescription
Promise < void >Method does not return a value

Exceptions​

ArgumentError - When menuItemId or state is null or undefined.

NotFoundError - When the menu item is not found or access is denied.

- - + + \ No newline at end of file diff --git a/Frameworks/User-Interface-Extensibility-Framework/Reference/UIExt2/Interfaces/ICommands/SetTaskbarGroupIcon/index.html b/Frameworks/User-Interface-Extensibility-Framework/Reference/UIExt2/Interfaces/ICommands/SetTaskbarGroupIcon/index.html index f89bb5c6e..d2a649bf6 100644 --- a/Frameworks/User-Interface-Extensibility-Framework/Reference/UIExt2/Interfaces/ICommands/SetTaskbarGroupIcon/index.html +++ b/Frameworks/User-Interface-Extensibility-Framework/Reference/UIExt2/Interfaces/ICommands/SetTaskbarGroupIcon/index.html @@ -4,13 +4,13 @@ SetTaskbarGroupIcon | M-Files User Interface Extensibility Framework - - + +
Skip to main content

SetTaskbarGroupIcon

Description​

Sets the icon for a custom task bar group.

Supported in M-Files Client version 25.10 and later.

Syntax​

// shellFrame points here into the IShellFrame interface
const result = await shellFrame.Commands.SetTaskbarGroupIcon(
  groupId,
  iconInformation,
);

Parameters​

NameOptionalityTypeDescription
groupIdRequirednumberThe task bar group id.
iconInformationRequiredIIconInformationThe icon information.

Return type​

TypeDescription
Promise < void >

Exceptions​

NotSupportedError - When task bar feature support is not enabled.

ArgumentError - When groupId or iconInformation is null or undefined.

NotFoundError - When the group is not found.

Error - When icon assignment fails.

- - + + \ No newline at end of file diff --git a/Frameworks/User-Interface-Extensibility-Framework/Reference/UIExt2/Interfaces/ICommands/index.html b/Frameworks/User-Interface-Extensibility-Framework/Reference/UIExt2/Interfaces/ICommands/index.html index 4706dd9a6..bd94f3edb 100644 --- a/Frameworks/User-Interface-Extensibility-Framework/Reference/UIExt2/Interfaces/ICommands/index.html +++ b/Frameworks/User-Interface-Extensibility-Framework/Reference/UIExt2/Interfaces/ICommands/index.html @@ -4,13 +4,13 @@ ICommands | M-Files User Interface Extensibility Framework - - + +
Skip to main content

ICommands

The Commands API includes functionality for creating Custom Commands and menus.

See the Samples for more examples of how to create custom commands and menus.

Properties​

NameTypeDescription
EventsICommandsEventsReturns the event registering interface of the ICommands interface.

Methods​

NameDescription
AddCustomCommandToMenuAdds existing custom command to the specified context menu location.
CreateCustomCommandCreates a custom command that can be added to the application toolbar or to the contextmenu.
CreateSubMenuItemCreates a new SubMenu for already created Menu.
CreateTaskbarGroupCreates new custom task bar group for custom commands.

NOTE: If multiple task bar groups are created for the same MenuLocation with the same
orderPriority, their relative ordering is unspecified and may vary between runs, sessions or
versions. Do not rely on a particular order for groups with equal priority — assign distinct
orderPriority values to guarantee a deterministic ordering (lower values are shown first).

To share a custom task bar group between multiple applications, use the same name
when creating the group. The group is then shared between applications and each application
can add its own commands to the shared group.
When an application is uninstalled or removes the group, the group remains available
for other applications using it.

Supported in M-Files Client version 25.10 and later.
DeleteCustomCommandDeletes a custom command. The command is automatically removed.
ExecuteCommandExecutes a user command or a built-in command.

This method can execute both custom commands (created via CreateCustomCommand) and
built-in commands (from the BuiltinCommand enumeration).
GetCommandNameResolves the name that has been associated with the given command id.
GetCommandStateGets the command state for builtin or custom command in specified location.
GetMenuIdOfBuiltInCommandGets the MenuItem ID of a built-in command by its command ID and location.
RemoveCustomCommandFromMenuRemoves a custom command from the specified menu location.
RemoveMenuItemRemoves menuitem from the menu.
RemoveTaskbarGroupRemoves custom task bar group from the task bar.

NOTE: If the group is shared between multiple applications, it is only removed
for the calling application meaning that its commands are removed from the group
and the group is no longer available to the calling application.
The group remains available for other applications using it.
If the group is not shared, it is removed completely.

Supported in M-Files Client version 25.10 and later.
SetCommandStateSets the command's state to be hidden, visible, enabled or disabled. Calling
this method may affect context menu, application toolbar, menus or all of them.
SetIconSets the icon for a custom command.

Supported in M-Files Client version 25.10 and later.
SetMenuItemStateSets the MenuItem state individually.
SetTaskbarGroupIconSets the icon for a custom task bar group.

Supported in M-Files Client version 25.10 and later.
- - + + \ No newline at end of file diff --git a/Frameworks/User-Interface-Extensibility-Framework/Reference/UIExt2/Interfaces/ICommonFunctions/DeleteFromWebStorage/index.html b/Frameworks/User-Interface-Extensibility-Framework/Reference/UIExt2/Interfaces/ICommonFunctions/DeleteFromWebStorage/index.html index 09580d0f5..d2d6b38c7 100644 --- a/Frameworks/User-Interface-Extensibility-Framework/Reference/UIExt2/Interfaces/ICommonFunctions/DeleteFromWebStorage/index.html +++ b/Frameworks/User-Interface-Extensibility-Framework/Reference/UIExt2/Interfaces/ICommonFunctions/DeleteFromWebStorage/index.html @@ -4,13 +4,13 @@ DeleteFromWebStorage | M-Files User Interface Extensibility Framework - - + +
Skip to main content

DeleteFromWebStorage

Description​

Deletes the key value pair stored in the browser web storage for the given key.

Syntax​

// Deletes a key from application specific storage.
MFiles.DeleteFromWebStorage(keyName);

Parameters​

NameOptionalityTypeDescription
keyRequiredstringThe web storage key.

Return type​

TypeDescription
Promise < void >Method does not return a value

Example​

This sample demonstrates the use of M-Files API functions to interact with web storage: it writes "Sample Value" to storage with the key "testKey", reads it back, logs the value to the console, and finally deletes the entry from web storage.

note

Values written to web storage must be string values, because they are internally serialized into string values.


// Called when the UI Extension starts
async function OnNewShellUI(shellUI) {

    // Write to web storage some value
    await MFiles.WriteToWebStorage( "testKey", "Sample Value" );

    // Read the value from the web storage
    const storedValue = await MFiles.ReadFromWebStorage( "testKey" );

    // Outputs: "Sample Value"
    console.log( storedValue );

    // Remove key from the storage.
    await MFiles.DeleteFromWebStorage( "testKey" );

}

Exceptions​

ArgumentError - When key is null or undefined.

- - + + \ No newline at end of file diff --git a/Frameworks/User-Interface-Extensibility-Framework/Reference/UIExt2/Interfaces/ICommonFunctions/DownloadFileAsDataUri/index.html b/Frameworks/User-Interface-Extensibility-Framework/Reference/UIExt2/Interfaces/ICommonFunctions/DownloadFileAsDataUri/index.html index 0c2ff844f..4302197a6 100644 --- a/Frameworks/User-Interface-Extensibility-Framework/Reference/UIExt2/Interfaces/ICommonFunctions/DownloadFileAsDataUri/index.html +++ b/Frameworks/User-Interface-Extensibility-Framework/Reference/UIExt2/Interfaces/ICommonFunctions/DownloadFileAsDataUri/index.html @@ -4,15 +4,15 @@ DownloadFileAsDataUri | M-Files User Interface Extensibility Framework - - + +
Skip to main content

DownloadFileAsDataUri

Description​

Downloads a file from an object as a base64-encoded data URI.

Retrieves the content of a specific file version from a vault object and returns it as a data URI string with base64 encoding. This is useful for embedding file content directly in HTML or passing file data as strings.

Files larger than 64MB are rejected to prevent memory exhaustion.

Supported in M-Files Client version 25.12 and later.

Syntax​

// ICommonFunctions is bound into the MFiles global object
const result = await MFiles.DownloadFileAsDataUri(objVer, fileVer);

Parameters​

NameOptionalityTypeDescription
objVerRequiredObjVerThe object version containing the file.
fileVerRequiredFileVerThe specific file version to download.

Return type​

TypeDescription
Promise < string >Promise resolving to a data URI string (data:mime/type;base64,encodeddata).

Exceptions​

ArgumentError - When objVer, fileVer, or fileVer.file_id is null or undefined.

Error - When download URL generation/download/base64 conversion fails, or when the file is too large/access is denied.

- - + + \ No newline at end of file diff --git a/Frameworks/User-Interface-Extensibility-Framework/Reference/UIExt2/Interfaces/ICommonFunctions/GetAccentColor/index.html b/Frameworks/User-Interface-Extensibility-Framework/Reference/UIExt2/Interfaces/ICommonFunctions/GetAccentColor/index.html index c6fb7e2e1..b2b785ae4 100644 --- a/Frameworks/User-Interface-Extensibility-Framework/Reference/UIExt2/Interfaces/ICommonFunctions/GetAccentColor/index.html +++ b/Frameworks/User-Interface-Extensibility-Framework/Reference/UIExt2/Interfaces/ICommonFunctions/GetAccentColor/index.html @@ -4,13 +4,13 @@ GetAccentColor | M-Files User Interface Extensibility Framework - - + +
Skip to main content

GetAccentColor

Description​

Gets accent color.

Syntax​

// ICommonFunctions is bound into the MFiles global object
const result = await MFiles.GetAccentColor();

Return type​

TypeDescription
Promise < string >The accent color configured by user.
- - + + \ No newline at end of file diff --git a/Frameworks/User-Interface-Extensibility-Framework/Reference/UIExt2/Interfaces/ICommonFunctions/GetClientLanguage/index.html b/Frameworks/User-Interface-Extensibility-Framework/Reference/UIExt2/Interfaces/ICommonFunctions/GetClientLanguage/index.html index 24d57952f..2f6e7cf6c 100644 --- a/Frameworks/User-Interface-Extensibility-Framework/Reference/UIExt2/Interfaces/ICommonFunctions/GetClientLanguage/index.html +++ b/Frameworks/User-Interface-Extensibility-Framework/Reference/UIExt2/Interfaces/ICommonFunctions/GetClientLanguage/index.html @@ -4,13 +4,13 @@ GetClientLanguage | M-Files User Interface Extensibility Framework - - + +
Skip to main content

GetClientLanguage

Description​

Returns language code of current client language.

Syntax​

// ICommonFunctions is bound into the MFiles global object
const result = await MFiles.GetClientLanguage();

Return type​

TypeDescription
Promise < string >The language code of current client language.
- - + + \ No newline at end of file diff --git a/Frameworks/User-Interface-Extensibility-Framework/Reference/UIExt2/Interfaces/ICommonFunctions/GetClientLocale/index.html b/Frameworks/User-Interface-Extensibility-Framework/Reference/UIExt2/Interfaces/ICommonFunctions/GetClientLocale/index.html index 897044cc6..439aa8959 100644 --- a/Frameworks/User-Interface-Extensibility-Framework/Reference/UIExt2/Interfaces/ICommonFunctions/GetClientLocale/index.html +++ b/Frameworks/User-Interface-Extensibility-Framework/Reference/UIExt2/Interfaces/ICommonFunctions/GetClientLocale/index.html @@ -4,13 +4,13 @@ GetClientLocale | M-Files User Interface Extensibility Framework - - + +
Skip to main content

GetClientLocale

Description​

Returns language code of current client locale.

Syntax​

// ICommonFunctions is bound into the MFiles global object
const result = await MFiles.GetClientLocale();

Return type​

TypeDescription
Promise < string >The language code of current client language.
- - + + \ No newline at end of file diff --git a/Frameworks/User-Interface-Extensibility-Framework/Reference/UIExt2/Interfaces/ICommonFunctions/GetClientLocaleIn3Letters/index.html b/Frameworks/User-Interface-Extensibility-Framework/Reference/UIExt2/Interfaces/ICommonFunctions/GetClientLocaleIn3Letters/index.html index 0d13eb7c4..960a99bfc 100644 --- a/Frameworks/User-Interface-Extensibility-Framework/Reference/UIExt2/Interfaces/ICommonFunctions/GetClientLocaleIn3Letters/index.html +++ b/Frameworks/User-Interface-Extensibility-Framework/Reference/UIExt2/Interfaces/ICommonFunctions/GetClientLocaleIn3Letters/index.html @@ -4,13 +4,13 @@ GetClientLocaleIn3Letters | M-Files User Interface Extensibility Framework - - + +
Skip to main content

GetClientLocaleIn3Letters

Description​

Returns the 3-letter language code of the current client locale.

Supported in M-Files Client version 26.3 and later.

Syntax​

// ICommonFunctions is bound into the MFiles global object
const result = await MFiles.GetClientLocaleIn3Letters();

Return type​

TypeDescription
Promise < string >The 3-letter language code of current client language.
- - + + \ No newline at end of file diff --git a/Frameworks/User-Interface-Extensibility-Framework/Reference/UIExt2/Interfaces/ICommonFunctions/GetSessionInfo/index.html b/Frameworks/User-Interface-Extensibility-Framework/Reference/UIExt2/Interfaces/ICommonFunctions/GetSessionInfo/index.html index b2c2d7883..97cb29cbd 100644 --- a/Frameworks/User-Interface-Extensibility-Framework/Reference/UIExt2/Interfaces/ICommonFunctions/GetSessionInfo/index.html +++ b/Frameworks/User-Interface-Extensibility-Framework/Reference/UIExt2/Interfaces/ICommonFunctions/GetSessionInfo/index.html @@ -4,13 +4,13 @@ GetSessionInfo | M-Files User Interface Extensibility Framework - - + +
Skip to main content
- - + + \ No newline at end of file diff --git a/Frameworks/User-Interface-Extensibility-Framework/Reference/UIExt2/Interfaces/ICommonFunctions/GetUTCOffset/index.html b/Frameworks/User-Interface-Extensibility-Framework/Reference/UIExt2/Interfaces/ICommonFunctions/GetUTCOffset/index.html index b8396f30f..10d821a7e 100644 --- a/Frameworks/User-Interface-Extensibility-Framework/Reference/UIExt2/Interfaces/ICommonFunctions/GetUTCOffset/index.html +++ b/Frameworks/User-Interface-Extensibility-Framework/Reference/UIExt2/Interfaces/ICommonFunctions/GetUTCOffset/index.html @@ -4,13 +4,13 @@ GetUTCOffset | M-Files User Interface Extensibility Framework - - + +
Skip to main content

GetUTCOffset

Description​

Gets server based UTC offset in minutes

Syntax​

// ICommonFunctions is bound into the MFiles global object
const result = await MFiles.GetUTCOffset();

Return type​

TypeDescription
Promise < number >UTC offset in minutes
- - + + \ No newline at end of file diff --git a/Frameworks/User-Interface-Extensibility-Framework/Reference/UIExt2/Interfaces/ICommonFunctions/GetVaultInfo/index.html b/Frameworks/User-Interface-Extensibility-Framework/Reference/UIExt2/Interfaces/ICommonFunctions/GetVaultInfo/index.html index 1f3211471..88e046717 100644 --- a/Frameworks/User-Interface-Extensibility-Framework/Reference/UIExt2/Interfaces/ICommonFunctions/GetVaultInfo/index.html +++ b/Frameworks/User-Interface-Extensibility-Framework/Reference/UIExt2/Interfaces/ICommonFunctions/GetVaultInfo/index.html @@ -4,13 +4,13 @@ GetVaultInfo | M-Files User Interface Extensibility Framework - - + +
Skip to main content
- - + + \ No newline at end of file diff --git a/Frameworks/User-Interface-Extensibility-Framework/Reference/UIExt2/Interfaces/ICommonFunctions/GetWebLink/index.html b/Frameworks/User-Interface-Extensibility-Framework/Reference/UIExt2/Interfaces/ICommonFunctions/GetWebLink/index.html index 6697f6ddd..1570a13fa 100644 --- a/Frameworks/User-Interface-Extensibility-Framework/Reference/UIExt2/Interfaces/ICommonFunctions/GetWebLink/index.html +++ b/Frameworks/User-Interface-Extensibility-Framework/Reference/UIExt2/Interfaces/ICommonFunctions/GetWebLink/index.html @@ -4,13 +4,13 @@ GetWebLink | M-Files User Interface Extensibility Framework - - + +
Skip to main content

GetWebLink

Description​

Get web link for an object.

Syntax​

// ICommonFunctions is bound into the MFiles global object
const result = await MFiles.GetWebLink(
  objId,
  objGUID,
  fileGUID,
  fileID,
  isLatestVersion,
  version,
);

Parameters​

NameOptionalityTypeDescription
objIdRequiredIObjIDThe target object to prepare link.
objGUIDRequiredstringObject GUID.
fileGUIDRequiredundefined | stringObject File GUID. - Optional
fileIDRequiredundefined | stringObject File GUID. - Optional
isLatestVersionRequiredbooleanIs the object to be viewed should be of the latest version.
versionRequirednumberIf it is not requested for latest version then specify the version no here.

Return type​

TypeDescription
Promise < string >Navigation URL.

Exceptions​

ArgumentError - When objId, objGUID, and viewInfo are all null or undefined.

- - + + \ No newline at end of file diff --git a/Frameworks/User-Interface-Extensibility-Framework/Reference/UIExt2/Interfaces/ICommonFunctions/OpenExternalWebLink/index.html b/Frameworks/User-Interface-Extensibility-Framework/Reference/UIExt2/Interfaces/ICommonFunctions/OpenExternalWebLink/index.html index 87fd42c26..00112468c 100644 --- a/Frameworks/User-Interface-Extensibility-Framework/Reference/UIExt2/Interfaces/ICommonFunctions/OpenExternalWebLink/index.html +++ b/Frameworks/User-Interface-Extensibility-Framework/Reference/UIExt2/Interfaces/ICommonFunctions/OpenExternalWebLink/index.html @@ -4,14 +4,14 @@ OpenExternalWebLink | M-Files User Interface Extensibility Framework - - + +
Skip to main content

OpenExternalWebLink

Description​

Open external web link in a tab. Note: This method only supports "http", "https" and "mailto" protocols.

Syntax​

// ICommonFunctions is bound into the MFiles global object
await MFiles.OpenExternalWebLink(webUrl);

Parameters​

NameOptionalityTypeDescription
webUrlRequiredstringThe target url to be opened in new tab.

Return type​

TypeDescription
Promise < void >Method does not return a value

Exceptions​

Error - When webUrl is invalid or has an unsupported protocol.

- - + + \ No newline at end of file diff --git a/Frameworks/User-Interface-Extensibility-Framework/Reference/UIExt2/Interfaces/ICommonFunctions/ReadFromWebStorage/index.html b/Frameworks/User-Interface-Extensibility-Framework/Reference/UIExt2/Interfaces/ICommonFunctions/ReadFromWebStorage/index.html index 725682e0a..4f278ca5d 100644 --- a/Frameworks/User-Interface-Extensibility-Framework/Reference/UIExt2/Interfaces/ICommonFunctions/ReadFromWebStorage/index.html +++ b/Frameworks/User-Interface-Extensibility-Framework/Reference/UIExt2/Interfaces/ICommonFunctions/ReadFromWebStorage/index.html @@ -4,13 +4,13 @@ ReadFromWebStorage | M-Files User Interface Extensibility Framework - - + +
Skip to main content

ReadFromWebStorage

Description​

Retrieves the value stored in the browser web storage for the given key.

Syntax​

// Reads a key from application specific storage.
const value = await MFiles.ReadFromWebStorage(keyName);

Parameters​

NameOptionalityTypeDescription
keyRequiredstringThe web storage key.

Return type​

TypeDescription
Promise < string >The value as string stored in web storage for the given key.

Example​

This sample demonstrates the use of M-Files API functions to interact with web storage: it writes "Sample Value" to storage with the key "testKey", reads it back, logs the value to the console, and finally deletes the entry from web storage.

note

Values written to web storage must be string values, because they are internally serialized into string values.


// Called when the UI Extension starts
async function OnNewShellUI(shellUI) {

    // Write to web storage some value
    await MFiles.WriteToWebStorage( "testKey", "Sample Value" );

    // Read the value from the web storage
    const storedValue = await MFiles.ReadFromWebStorage( "testKey" );

    // Outputs: "Sample Value"
    console.log( storedValue );

    // Remove key from the storage.
    await MFiles.DeleteFromWebStorage( "testKey" );

}

Exceptions​

ArgumentError - When key is null or undefined.

- - + + \ No newline at end of file diff --git a/Frameworks/User-Interface-Extensibility-Framework/Reference/UIExt2/Interfaces/ICommonFunctions/ReportException/index.html b/Frameworks/User-Interface-Extensibility-Framework/Reference/UIExt2/Interfaces/ICommonFunctions/ReportException/index.html index 358013c06..9b5caf7f5 100644 --- a/Frameworks/User-Interface-Extensibility-Framework/Reference/UIExt2/Interfaces/ICommonFunctions/ReportException/index.html +++ b/Frameworks/User-Interface-Extensibility-Framework/Reference/UIExt2/Interfaces/ICommonFunctions/ReportException/index.html @@ -4,13 +4,13 @@ ReportException | M-Files User Interface Extensibility Framework - - + +
Skip to main content

ReportException

Description​

Reports an exception. The exception can be displayed to the user or written to the event log.

Syntax​

// ICommonFunctions is bound into the MFiles global object
const result = await MFiles.ReportException(exception);

Parameters​

NameOptionalityTypeDescription
exceptionRequiredstring | MFErrorThe exception to report.

Return type​

TypeDescription
Promise < number >Returns Dialog Instance.

Exceptions​

ArgumentError - When exception is null or undefined.

- - + + \ No newline at end of file diff --git a/Frameworks/User-Interface-Extensibility-Framework/Reference/UIExt2/Interfaces/ICommonFunctions/ShowEditObjectWindow/index.html b/Frameworks/User-Interface-Extensibility-Framework/Reference/UIExt2/Interfaces/ICommonFunctions/ShowEditObjectWindow/index.html index 0c45ee0eb..ec24dc9ac 100644 --- a/Frameworks/User-Interface-Extensibility-Framework/Reference/UIExt2/Interfaces/ICommonFunctions/ShowEditObjectWindow/index.html +++ b/Frameworks/User-Interface-Extensibility-Framework/Reference/UIExt2/Interfaces/ICommonFunctions/ShowEditObjectWindow/index.html @@ -4,13 +4,13 @@ ShowEditObjectWindow | M-Files User Interface Extensibility Framework - - + +
Skip to main content

ShowEditObjectWindow

Description​

Show object popup window to edit exist object.

Syntax​

// ICommonFunctions is bound into the MFiles global object
const result = await MFiles.ShowEditObjectWindow(objVer, options);

Parameters​

NameOptionalityTypeDescription
objVerRequiredObjVerThe ObjVer information which needs to be edited.
optionsRequiredDialogUIParamsTitle and UI options of the dashboard [Eg: title/isModal/isResizable/isDraggable].

Return type​

TypeDescription
Promise < ObjectWindowResult >Promise which will resolve the object window result.

Exceptions​

ArgumentError - When objVer is null or undefined.

- - + + \ No newline at end of file diff --git a/Frameworks/User-Interface-Extensibility-Framework/Reference/UIExt2/Interfaces/ICommonFunctions/ShowNewObjectWindow/index.html b/Frameworks/User-Interface-Extensibility-Framework/Reference/UIExt2/Interfaces/ICommonFunctions/ShowNewObjectWindow/index.html index de94b3a69..c103ebc97 100644 --- a/Frameworks/User-Interface-Extensibility-Framework/Reference/UIExt2/Interfaces/ICommonFunctions/ShowNewObjectWindow/index.html +++ b/Frameworks/User-Interface-Extensibility-Framework/Reference/UIExt2/Interfaces/ICommonFunctions/ShowNewObjectWindow/index.html @@ -4,13 +4,13 @@ ShowNewObjectWindow | M-Files User Interface Extensibility Framework - - + +
Skip to main content

ShowNewObjectWindow

Description​

Show new object creation window to create new object. New object can be created using prefil properties as well.

Note: Multiple files are not supported in ObjectCreationInfo.source_files.

Syntax​

// ICommonFunctions is bound into the MFiles global object
const result = await MFiles.ShowNewObjectWindow(
  objectType,
  objectCreationInfo,
  prefillPropertyValues,
  accessControlList,
  options,
);

Parameters​

NameOptionalityTypeDescription
objectTypeRequirednumberObject type id.
objectCreationInfoRequiredObjectCreationInfoThe ObjectCreationInfo specifying the initial state of the new metadata card.
prefillPropertyValuesRequiredArray < PropertyValue >PrefillPropertyValues is a collection of PropertyValue objects.
accessControlListRequiredAccessControlListThe accessControlList represents an access control list (ACL).
optionsRequiredDialogUIParamsTitle and UI options of the dashboard [Eg: title/isModal/isResizable/isDraggable].

Return type​

TypeDescription
Promise < ObjectWindowResult >Promise which will resolve the object window result.

Exceptions​

ArgumentError - When objectType is null or undefined or object creation parameters are invalid.

NotSupportedError - When multiple files upload is not supported.

- - + + \ No newline at end of file diff --git a/Frameworks/User-Interface-Extensibility-Framework/Reference/UIExt2/Interfaces/ICommonFunctions/ShowToast/index.html b/Frameworks/User-Interface-Extensibility-Framework/Reference/UIExt2/Interfaces/ICommonFunctions/ShowToast/index.html index 3fda1dae3..a0210e0e3 100644 --- a/Frameworks/User-Interface-Extensibility-Framework/Reference/UIExt2/Interfaces/ICommonFunctions/ShowToast/index.html +++ b/Frameworks/User-Interface-Extensibility-Framework/Reference/UIExt2/Interfaces/ICommonFunctions/ShowToast/index.html @@ -4,13 +4,13 @@ ShowToast | M-Files User Interface Extensibility Framework - - + +
Skip to main content

ShowToast

Description​

Show toast message.

Syntax​

// ICommonFunctions is bound into the MFiles global object
await MFiles.ShowToast(title, message, type);

Parameters​

NameOptionalityTypeDescription
titleRequiredstringToast title.
messageRequiredstringToast message.
typeRequiredToastTypeToast type.

Return type​

TypeDescription
Promise < void >Method does not return a value

Exceptions​

ArgumentError - When title, message, or type is null or undefined.

- - + + \ No newline at end of file diff --git a/Frameworks/User-Interface-Extensibility-Framework/Reference/UIExt2/Interfaces/ICommonFunctions/UploadTemporaryFiles/index.html b/Frameworks/User-Interface-Extensibility-Framework/Reference/UIExt2/Interfaces/ICommonFunctions/UploadTemporaryFiles/index.html index 9c020c9f0..166d67fb4 100644 --- a/Frameworks/User-Interface-Extensibility-Framework/Reference/UIExt2/Interfaces/ICommonFunctions/UploadTemporaryFiles/index.html +++ b/Frameworks/User-Interface-Extensibility-Framework/Reference/UIExt2/Interfaces/ICommonFunctions/UploadTemporaryFiles/index.html @@ -4,8 +4,8 @@ UploadTemporaryFiles | M-Files User Interface Extensibility Framework - - + +
@@ -15,7 +15,7 @@ perform further operations with the uploaded files before they expire.

The method also handles duplicate detection and searchable PDF conversion if the features are enabled. A user must interact with the dialogs and may cancel the upload process during these steps, causing an error to be thrown.

Supported in M-Files Client version 25.12 and later.

Syntax​

// ICommonFunctions is bound into the MFiles global object
const result = await MFiles.UploadTemporaryFiles(files);

Parameters​

NameOptionalityTypeDescription
filesRequiredFileListThe files to upload.

Return type​

TypeDescription
Promise < IObjFileSource >Source information of the uploaded temporary files.

Exceptions​

ArgumentError - When files is null or undefined.

Error - When upload fails or is cancelled during post-upload processing.

- - + + \ No newline at end of file diff --git a/Frameworks/User-Interface-Extensibility-Framework/Reference/UIExt2/Interfaces/ICommonFunctions/WriteToWebStorage/index.html b/Frameworks/User-Interface-Extensibility-Framework/Reference/UIExt2/Interfaces/ICommonFunctions/WriteToWebStorage/index.html index 97f02ffa1..fe3d9feed 100644 --- a/Frameworks/User-Interface-Extensibility-Framework/Reference/UIExt2/Interfaces/ICommonFunctions/WriteToWebStorage/index.html +++ b/Frameworks/User-Interface-Extensibility-Framework/Reference/UIExt2/Interfaces/ICommonFunctions/WriteToWebStorage/index.html @@ -4,13 +4,13 @@ WriteToWebStorage | M-Files User Interface Extensibility Framework - - + +
Skip to main content

WriteToWebStorage

Description​

Writes the value in the browser web storage.

Syntax​

// Writes a value for key "keyName" from application specific storage.
await MFiles.WriteToWebStorage( keyName, value );

Parameters​

NameOptionalityTypeDescription
keyRequiredstringThe web storage key.
valueRequiredstringThe value.

Return type​

TypeDescription
Promise < boolean >True / false based on the status.

Example​

This sample demonstrates the use of M-Files API functions to interact with web storage: it writes "Sample Value" to storage with the key "testKey", reads it back, logs the value to the console, and finally deletes the entry from web storage.

note

Values written to web storage must be string values, because they are internally serialized into string values.


// Called when the UI Extension starts
async function OnNewShellUI(shellUI) {

    // Write to web storage some value
    await MFiles.WriteToWebStorage( "testKey", "Sample Value" );

    // Read the value from the web storage
    const storedValue = await MFiles.ReadFromWebStorage( "testKey" );

    // Outputs: "Sample Value"
    console.log( storedValue );

    // Remove key from the storage.
    await MFiles.DeleteFromWebStorage( "testKey" );

}

Exceptions​

ArgumentError - When key or value is null or undefined, or when value is not a string.

- - + + \ No newline at end of file diff --git a/Frameworks/User-Interface-Extensibility-Framework/Reference/UIExt2/Interfaces/ICommonFunctions/index.html b/Frameworks/User-Interface-Extensibility-Framework/Reference/UIExt2/Interfaces/ICommonFunctions/index.html index ce2270fdd..6f54df581 100644 --- a/Frameworks/User-Interface-Extensibility-Framework/Reference/UIExt2/Interfaces/ICommonFunctions/index.html +++ b/Frameworks/User-Interface-Extensibility-Framework/Reference/UIExt2/Interfaces/ICommonFunctions/index.html @@ -4,13 +4,13 @@ ICommonFunctions | M-Files User Interface Extensibility Framework - - + +
Skip to main content

ICommonFunctions

Provides set of common functions for interacting with the environment. This interfaces is bound to the global MFiles object.

Example​

// Save a key into webstorage
await MFiles.WriteToWebStorage("key", "value")

Properties​

NameTypeDescription
AnonymousUserbooleanGets if anonymous login is used.
CurrentApplicationPlatformstringGets the current application platform.

Methods​

NameDescription
DeleteFromWebStorageDeletes the key value pair stored in the browser web storage for the given key.
DownloadFileAsDataUriDownloads a file from an object as a base64-encoded data URI.

Retrieves the content of a specific file version from a vault object and returns it
as a data URI string with base64 encoding. This is useful for embedding file content
directly in HTML or passing file data as strings.

Files larger than 64MB are rejected to prevent memory exhaustion.

Supported in M-Files Client version 25.12 and later.
GetAccentColorGets accent color.
GetClientLanguageReturns language code of current client language.
GetClientLocaleReturns language code of current client locale.
GetClientLocaleIn3LettersReturns the 3-letter language code of the current client locale.

Supported in M-Files Client version 26.3 and later.
GetSessionInfoGets the current NonSensitiveSessionData information.
GetUTCOffsetGets server based UTC offset in minutes
GetVaultInfoGets the current vault information.
GetWebLinkGet web link for an object.
OpenExternalWebLinkOpen external web link in a tab.
Note: This method only supports "http", "https" and "mailto" protocols.
ReadFromWebStorageRetrieves the value stored in the browser web storage for the given key.
ReportExceptionReports an exception. The exception can be displayed to the user or written to the event log.
ShowEditObjectWindowShow object popup window to edit exist object.
ShowNewObjectWindowShow new object creation window to create new object. New object can be created using prefil properties as well.

Note: Multiple files are not supported in ObjectCreationInfo.source_files.
ShowToastShow toast message.
UploadTemporaryFilesUploads temporary files to the server and returns a file source which other operations
can use to access the uploaded files.

The uploaded files are temporary and will be automatically removed from the server
after a certain period of time. The caller should use the returned file source to
perform further operations with the uploaded files before they expire.

The method also handles duplicate detection and searchable PDF conversion if the features
are enabled. A user must interact with the dialogs and may cancel the upload process during these steps,
causing an error to be thrown.

Supported in M-Files Client version 25.12 and later.
WriteToWebStorageWrites the value in the browser web storage.
- - + + \ No newline at end of file diff --git a/Frameworks/User-Interface-Extensibility-Framework/Reference/UIExt2/Interfaces/IDashboard/GetSandboxAttributes/index.html b/Frameworks/User-Interface-Extensibility-Framework/Reference/UIExt2/Interfaces/IDashboard/GetSandboxAttributes/index.html index 61c767e7e..ff2ea82d1 100644 --- a/Frameworks/User-Interface-Extensibility-Framework/Reference/UIExt2/Interfaces/IDashboard/GetSandboxAttributes/index.html +++ b/Frameworks/User-Interface-Extensibility-Framework/Reference/UIExt2/Interfaces/IDashboard/GetSandboxAttributes/index.html @@ -4,13 +4,13 @@ GetSandboxAttributes | M-Files User Interface Extensibility Framework - - + +
Skip to main content

GetSandboxAttributes

Description​

Gets the sandbox attributes for the specified dashboard.

Syntax​

// The dashboard variable here points to instance of IDashboard
const result = await dashboard.GetSandboxAttributes(dashboardId);

Parameters​

NameOptionalityTypeDescription
dashboardIdRequiredstring | numberThe ID of the dashboard.

Return type​

TypeDescription
Promise < string >The sandbox attributes or undefined if not found.
- - + + \ No newline at end of file diff --git a/Frameworks/User-Interface-Extensibility-Framework/Reference/UIExt2/Interfaces/IDashboard/ShowMessage/index.html b/Frameworks/User-Interface-Extensibility-Framework/Reference/UIExt2/Interfaces/IDashboard/ShowMessage/index.html index 4d926d694..d7ba4c04d 100644 --- a/Frameworks/User-Interface-Extensibility-Framework/Reference/UIExt2/Interfaces/IDashboard/ShowMessage/index.html +++ b/Frameworks/User-Interface-Extensibility-Framework/Reference/UIExt2/Interfaces/IDashboard/ShowMessage/index.html @@ -4,13 +4,13 @@ ShowMessage | M-Files User Interface Extensibility Framework - - + +
Skip to main content

ShowMessage

Description​

Shows the default M-Files message box with the specified content and appearance.

Syntax​

// The dashboard variable here points to instance of IDashboard
const result = await dashboard.ShowMessage(message);

Parameters​

NameOptionalityTypeDescription
messageRequiredstring | ShowMessageParamsMessage content to show.
String Type: The message to display. The message box contains single Ok button.
Object Type: Defines the message box content and buttons. See the M-Files UI Extensibility
framework User's Guide for more details.

Return type​

TypeDescription
Promise < ShowMessageReturnValue >Structure indication which button was clicked.
- - + + \ No newline at end of file diff --git a/Frameworks/User-Interface-Extensibility-Framework/Reference/UIExt2/Interfaces/IDashboard/ShowPopupDashboard/index.html b/Frameworks/User-Interface-Extensibility-Framework/Reference/UIExt2/Interfaces/IDashboard/ShowPopupDashboard/index.html index 8d6010b26..45c2285ee 100644 --- a/Frameworks/User-Interface-Extensibility-Framework/Reference/UIExt2/Interfaces/IDashboard/ShowPopupDashboard/index.html +++ b/Frameworks/User-Interface-Extensibility-Framework/Reference/UIExt2/Interfaces/IDashboard/ShowPopupDashboard/index.html @@ -4,13 +4,13 @@ ShowPopupDashboard | M-Files User Interface Extensibility Framework - - + +
Skip to main content

ShowPopupDashboard

Description​

Shows a dashboard in popup window.

Syntax​

// The dashboard variable here points to instance of IDashboard
const result = await dashboard.ShowPopupDashboard(
  dashboardID,
  data,
  titleOrOptions,
);

Parameters​

NameOptionalityTypeDescription
dashboardIDRequiredstringThe dashboard ID as defined
in Application Definition File (appdef file).
dataRequiredanyThe custom data that is passed for dashboard.
Can be accessed with CustomDataProperty of IDashboard Interface.
titleOrOptionsRequiredstring | DialogUIParamsTitle and UI options of the dashboard.
String Type: Defines the title of the dashboard.
Object Type: Defines the title and other UI options [Eg: title/isModal/isResizable/isDraggable].

Return type​

TypeDescription
Promise < IDashboard >The popup dashboard.

Exceptions​

ArgumentError - When dashboardID is null or undefined.

- - + + \ No newline at end of file diff --git a/Frameworks/User-Interface-Extensibility-Framework/Reference/UIExt2/Interfaces/IDashboard/UpdateCustomData/index.html b/Frameworks/User-Interface-Extensibility-Framework/Reference/UIExt2/Interfaces/IDashboard/UpdateCustomData/index.html index 32da50109..65b79aee8 100644 --- a/Frameworks/User-Interface-Extensibility-Framework/Reference/UIExt2/Interfaces/IDashboard/UpdateCustomData/index.html +++ b/Frameworks/User-Interface-Extensibility-Framework/Reference/UIExt2/Interfaces/IDashboard/UpdateCustomData/index.html @@ -4,13 +4,13 @@ UpdateCustomData | M-Files User Interface Extensibility Framework - - + +
Skip to main content

UpdateCustomData

Description​

Refreshes React metadata card content.

Syntax​

// The dashboard variable here points to instance of IDashboard
await dashboard.UpdateCustomData(customData);

Parameters​

NameOptionalityTypeDescription
customDataRequiredanyThe dashboard object's custom data.

Return type​

TypeDescription
Promise < void >Method does not return a value

Example​

The UpdateCustomData method can be used to send new custom data to an existing dashboard, without the dashboard needing to be completely reinitialized.

For this to work your dashboard must listen for the CustomDataChanged event:

function OnNewDashboard(dashboard) {
    dashboard.Events.Register( MFiles.Event.CustomDataChanged, data => {
        // Render the "timeNow" property from the custom data.
        // Will be called automatically when the dashboard first renders, then
        // every time the CustomDataChanged event is fired.
        document.body.innerHTML =  `<h1>${data.timeNow}</h1>`;
    })
}

This event can then be raised from within another part of your code, for example from within a module:

"use strict";
async function OnNewShellUI(shellUI) {

    // Wait for shell frames to be created.
    await shellUI.Events.Register(MFiles.Event.NewShellFrame, handleNewShellFrame);

    // Handler for shell frame created event.
    async function handleNewShellFrame(shellFrame)
    {
        await shellFrame.Events.Register(MFiles.Event.Started, OnStarted);
        async function OnStarted()
        {
            const myTab = await shellFrame.RightPane.AddTab("my-test-tab", "My dashboard", "_last");
            const myDashboard = await myTab.ShowDashboard("mydb", 
            {
                timeNow: "INITIAL_DATA, 5 second refresh interval!"
            });
            
            // Every 5 seconds call the UpdateCustomData method
            // to raise the event that the dashboard subscribes to.
            setInterval( () => {
                myDashboard.UpdateCustomData({
                    timeNow: ( new Date() ).toISOString() // Pass the current time.
                })
            }, 5000)
            
            myTab.Select();
        }
    }
}
- - + + \ No newline at end of file diff --git a/Frameworks/User-Interface-Extensibility-Framework/Reference/UIExt2/Interfaces/IDashboard/WaitForClose/index.html b/Frameworks/User-Interface-Extensibility-Framework/Reference/UIExt2/Interfaces/IDashboard/WaitForClose/index.html index 41a9b7e2a..7be3f3e69 100644 --- a/Frameworks/User-Interface-Extensibility-Framework/Reference/UIExt2/Interfaces/IDashboard/WaitForClose/index.html +++ b/Frameworks/User-Interface-Extensibility-Framework/Reference/UIExt2/Interfaces/IDashboard/WaitForClose/index.html @@ -4,13 +4,13 @@ WaitForClose | M-Files User Interface Extensibility Framework - - + +
Skip to main content

WaitForClose

Description​

Wait for close dashboard.

Syntax​

// The dashboard variable here points to instance of IDashboard
const result = await dashboard.WaitForClose();

Return type​

TypeDescription
Promise < any >Return the latest customData as a promise.
- - + + \ No newline at end of file diff --git a/Frameworks/User-Interface-Extensibility-Framework/Reference/UIExt2/Interfaces/IDashboard/index.html b/Frameworks/User-Interface-Extensibility-Framework/Reference/UIExt2/Interfaces/IDashboard/index.html index 9e207c49c..a321cf9c3 100644 --- a/Frameworks/User-Interface-Extensibility-Framework/Reference/UIExt2/Interfaces/IDashboard/index.html +++ b/Frameworks/User-Interface-Extensibility-Framework/Reference/UIExt2/Interfaces/IDashboard/index.html @@ -4,13 +4,13 @@ IDashboard | M-Files User Interface Extensibility Framework - - + +
Skip to main content

IDashboard

This is the programmatic interface of the dashboard. It is created during the dashboard initialization phase.

Properties​

NameTypeDescription
CustomDataanyReturns the dashboard object's custom data that was specified when the dashboard was opened.
EventsIDashboardEventsReturns the event registering interface of the IDashboard interface.
IsPopupDashboardbooleanIndicates whether the dashboard is opened in an own dialog
instead of the embedded panes (right pane or listing pane).
ShellFrameIShellFrameThe Shellframe for the dashboard.
Windowundefined | null | IWindowReturns the dashboard's underlying window object.

Methods​

NameDescription
GetSandboxAttributesGets the sandbox attributes for the specified dashboard.
ShowMessageShows the default M-Files message box with the specified content and appearance.
ShowPopupDashboardShows a dashboard in popup window.
UpdateCustomDataRefreshes React metadata card content.
WaitForCloseWait for close dashboard.

Events​

EventDescriptionArguments
RefreshTriggered when the dashboard data is refreshed.
StartedSent when the dashboard turns to started state.
StopSent before the dashboard is stopped.
CustomDataChangedThis event is triggered, when custom data on dashboard has changed. The event can be
used to update the dashboard based on the new data. This event will fire at least
once when the dashboard is started and initialized.		data New custom data for the dashboard

Here is example of using the CustomDataChanged event:

dashboard.Events.Register(Event.CustomDataChanged, (data: any) => {
  console.log("Custom data changed: ", data);
});
- - + + \ No newline at end of file diff --git a/Frameworks/User-Interface-Extensibility-Framework/Reference/UIExt2/Interfaces/IEvents/Register/index.html b/Frameworks/User-Interface-Extensibility-Framework/Reference/UIExt2/Interfaces/IEvents/Register/index.html index 1871232a5..977acc38a 100644 --- a/Frameworks/User-Interface-Extensibility-Framework/Reference/UIExt2/Interfaces/IEvents/Register/index.html +++ b/Frameworks/User-Interface-Extensibility-Framework/Reference/UIExt2/Interfaces/IEvents/Register/index.html @@ -4,13 +4,13 @@ Register | M-Files User Interface Extensibility Framework - - + +
Skip to main content

Register

Description​

Registers a handler object/function for handling the specified type of events.

Syntax​

// The events interface is available under most objects
const result = await shellFrame.Events.Register(eventToListen, eventSink);

Parameters​

NameOptionalityTypeDescription
eventToListenRequiredEventThe event type to handle.
eventSinkRequiredFunctionThe event sink to register.

Return type​

TypeDescription
Promise < null | number >Returns handle to the registered event handler.
This handle can be used later to unregister the handler.

Exceptions​

ArgumentError - When eventToListen or eventSink is null or undefined.

- - + + \ No newline at end of file diff --git a/Frameworks/User-Interface-Extensibility-Framework/Reference/UIExt2/Interfaces/IEvents/RegisterBuiltinCommand/index.html b/Frameworks/User-Interface-Extensibility-Framework/Reference/UIExt2/Interfaces/IEvents/RegisterBuiltinCommand/index.html index 08b890141..efcd08393 100644 --- a/Frameworks/User-Interface-Extensibility-Framework/Reference/UIExt2/Interfaces/IEvents/RegisterBuiltinCommand/index.html +++ b/Frameworks/User-Interface-Extensibility-Framework/Reference/UIExt2/Interfaces/IEvents/RegisterBuiltinCommand/index.html @@ -4,13 +4,13 @@ RegisterBuiltinCommand | M-Files User Interface Extensibility Framework - - + +
Skip to main content

RegisterBuiltinCommand

Description​

Registers a callback for Builtin commands.

Syntax​

// The events interface is available under most objects
const result = await shellFrame.Events.RegisterBuiltinCommand(
  eventToListen,
  eventSinkBase,
);

Parameters​

NameOptionalityTypeDescription
eventToListenRequiredBuiltinCommandbuiltin commmand to listen to
eventSinkBaseRequiredFunctioncallback function to call

Return type​

TypeDescription
Promise < null | number >Registered callback ID which can be used to cancel the event listener
- - + + \ No newline at end of file diff --git a/Frameworks/User-Interface-Extensibility-Framework/Reference/UIExt2/Interfaces/IEvents/Unregister/index.html b/Frameworks/User-Interface-Extensibility-Framework/Reference/UIExt2/Interfaces/IEvents/Unregister/index.html index 59e336b63..ad1466f07 100644 --- a/Frameworks/User-Interface-Extensibility-Framework/Reference/UIExt2/Interfaces/IEvents/Unregister/index.html +++ b/Frameworks/User-Interface-Extensibility-Framework/Reference/UIExt2/Interfaces/IEvents/Unregister/index.html @@ -4,13 +4,13 @@ Unregister | M-Files User Interface Extensibility Framework - - + +
Skip to main content

Unregister

Description​

Unregisters the event handler.

Syntax​

// The events interface is available under most objects
const result = await shellFrame.Events.Unregister(sinkHandle);

Parameters​

NameOptionalityTypeDescription
sinkHandleRequirednumberThe handle that specifies the handler to unregister.
The handle is returned by Register method.

Return type​

TypeDescription
Promise < boolean >This method returns nothing.

Exceptions​

ArgumentError - When sinkHandle is null or undefined.

- - + + \ No newline at end of file diff --git a/Frameworks/User-Interface-Extensibility-Framework/Reference/UIExt2/Interfaces/IEvents/index.html b/Frameworks/User-Interface-Extensibility-Framework/Reference/UIExt2/Interfaces/IEvents/index.html index 47c92e477..484acd624 100644 --- a/Frameworks/User-Interface-Extensibility-Framework/Reference/UIExt2/Interfaces/IEvents/index.html +++ b/Frameworks/User-Interface-Extensibility-Framework/Reference/UIExt2/Interfaces/IEvents/index.html @@ -4,13 +4,13 @@ IEvents | M-Files User Interface Extensibility Framework - - + +
Skip to main content
- - + + \ No newline at end of file diff --git a/Frameworks/User-Interface-Extensibility-Framework/Reference/UIExt2/Interfaces/ISearchPane/GetOptions/index.html b/Frameworks/User-Interface-Extensibility-Framework/Reference/UIExt2/Interfaces/ISearchPane/GetOptions/index.html index b11a53064..9e3338115 100644 --- a/Frameworks/User-Interface-Extensibility-Framework/Reference/UIExt2/Interfaces/ISearchPane/GetOptions/index.html +++ b/Frameworks/User-Interface-Extensibility-Framework/Reference/UIExt2/Interfaces/ISearchPane/GetOptions/index.html @@ -4,13 +4,13 @@ GetOptions | M-Files User Interface Extensibility Framework - - + +
Skip to main content

GetOptions

Description​

Gets the list of options to show in a specific section of the search UI.

Syntax​

// searchPane points to instance of ISearchPane
const result = await searchPane.GetOptions(sectionID, useShortList);

Parameters​

NameOptionalityTypeDescription
sectionIDRequiredstringThe ID of the section the items of which should be returned.
useShortListRequiredbooleanSpecifies if the list items should be returned in "short list" mode,
including only about five items.

Return type​

TypeDescription
Promise < { options?: any; more?: boolean; controlDisabled?: boolean; controlExpanded?: boolean; useFullList?: boolean; items?: any; } >Receives an object with the properties "options" (array) and "more" (Boolean).
Each option object in the array has properties such as "name" (string) and "selected" (Boolean).

Exceptions​

ArgumentError - When useShortList or sectionID is null or undefined.

- - + + \ No newline at end of file diff --git a/Frameworks/User-Interface-Extensibility-Framework/Reference/UIExt2/Interfaces/ISearchPane/GetSearchCriteria/index.html b/Frameworks/User-Interface-Extensibility-Framework/Reference/UIExt2/Interfaces/ISearchPane/GetSearchCriteria/index.html index f7aaf55ba..0b93ebb90 100644 --- a/Frameworks/User-Interface-Extensibility-Framework/Reference/UIExt2/Interfaces/ISearchPane/GetSearchCriteria/index.html +++ b/Frameworks/User-Interface-Extensibility-Framework/Reference/UIExt2/Interfaces/ISearchPane/GetSearchCriteria/index.html @@ -4,13 +4,13 @@ GetSearchCriteria | M-Files User Interface Extensibility Framework - - + +
Skip to main content

GetSearchCriteria

Description​

Get search criteria as Search conditions.

Syntax​

// searchPane points to instance of ISearchPane
const result = await searchPane.GetSearchCriteria();

Return type​

TypeDescription
Promise < SearchCriteria >Returns search conditions and facet filter if current view is Search View.
- - + + \ No newline at end of file diff --git a/Frameworks/User-Interface-Extensibility-Framework/Reference/UIExt2/Interfaces/ISearchPane/IsSearchView/index.html b/Frameworks/User-Interface-Extensibility-Framework/Reference/UIExt2/Interfaces/ISearchPane/IsSearchView/index.html index 9615ab53d..4feb64dbd 100644 --- a/Frameworks/User-Interface-Extensibility-Framework/Reference/UIExt2/Interfaces/ISearchPane/IsSearchView/index.html +++ b/Frameworks/User-Interface-Extensibility-Framework/Reference/UIExt2/Interfaces/ISearchPane/IsSearchView/index.html @@ -4,13 +4,13 @@ IsSearchView | M-Files User Interface Extensibility Framework - - + +
Skip to main content

IsSearchView

Description​

Is user is in search View.

Syntax​

// searchPane points to instance of ISearchPane
const result = await searchPane.IsSearchView();

Return type​

TypeDescription
Promise < boolean >True / False.
- - + + \ No newline at end of file diff --git a/Frameworks/User-Interface-Extensibility-Framework/Reference/UIExt2/Interfaces/ISearchPane/SetOptionState/index.html b/Frameworks/User-Interface-Extensibility-Framework/Reference/UIExt2/Interfaces/ISearchPane/SetOptionState/index.html index b85a1bb99..54e285226 100644 --- a/Frameworks/User-Interface-Extensibility-Framework/Reference/UIExt2/Interfaces/ISearchPane/SetOptionState/index.html +++ b/Frameworks/User-Interface-Extensibility-Framework/Reference/UIExt2/Interfaces/ISearchPane/SetOptionState/index.html @@ -4,13 +4,13 @@ SetOptionState | M-Files User Interface Extensibility Framework - - + +
Skip to main content

SetOptionState

Description​

Sets the state of the specified option.

Syntax​

// searchPane points to instance of ISearchPane
await searchPane.SetOptionState(sectionID, optionID, state);

Parameters​

NameOptionalityTypeDescription
sectionIDRequiredstringThe ID of the section.
optionIDRequiredstringThe ID of the option to select/deselect.
Note that this is the ID of the option (as specified in the "id" property of the option), and NOT the array index of the option.
stateRequiredbooleanSpecifies the new state of the option (selected/deselected).

Return type​

TypeDescription
Promise < void >Method does not return a value

Exceptions​

ArgumentError - When sectionID, optionID, or state is null or undefined.

- - + + \ No newline at end of file diff --git a/Frameworks/User-Interface-Extensibility-Framework/Reference/UIExt2/Interfaces/ISearchPane/SetSearchCriteria/index.html b/Frameworks/User-Interface-Extensibility-Framework/Reference/UIExt2/Interfaces/ISearchPane/SetSearchCriteria/index.html index ed4026832..f58730bd6 100644 --- a/Frameworks/User-Interface-Extensibility-Framework/Reference/UIExt2/Interfaces/ISearchPane/SetSearchCriteria/index.html +++ b/Frameworks/User-Interface-Extensibility-Framework/Reference/UIExt2/Interfaces/ISearchPane/SetSearchCriteria/index.html @@ -4,13 +4,13 @@ SetSearchCriteria | M-Files User Interface Extensibility Framework - - + +
Skip to main content

SetSearchCriteria

Description​

Get search criteria as Search conditions.

Syntax​

// searchPane points to instance of ISearchPane
await searchPane.SetSearchCriteria(criteria);

Parameters​

NameOptionalityTypeDescription
criteriaRequiredSearchCriteriaSearch criteria containing conditions and facet filter.

Return type​

TypeDescription
Promise < void >Method does not return a value
- - + + \ No newline at end of file diff --git a/Frameworks/User-Interface-Extensibility-Framework/Reference/UIExt2/Interfaces/ISearchPane/index.html b/Frameworks/User-Interface-Extensibility-Framework/Reference/UIExt2/Interfaces/ISearchPane/index.html index d91f3b45c..fa18d76bc 100644 --- a/Frameworks/User-Interface-Extensibility-Framework/Reference/UIExt2/Interfaces/ISearchPane/index.html +++ b/Frameworks/User-Interface-Extensibility-Framework/Reference/UIExt2/Interfaces/ISearchPane/index.html @@ -4,13 +4,13 @@ ISearchPane | M-Files User Interface Extensibility Framework - - + +
Skip to main content

ISearchPane

Represents the area reserved for the Search component and is a property of IShellFrame

Properties​

NameTypeDescription
AvailablebooleanResolves if the bar is available.Receives true if the side bar is available.
EventsISearchPaneEventsReturns the event registering interface for theISearchPane interface.
SearchWithinViewOptionVisiblebooleanResolves if the "Search within view" option is visible.

Methods​

NameDescription
GetOptionsGets the list of options to show in a specific section of the search UI.
GetSearchCriteriaGet search criteria as Search conditions.
IsSearchViewIs user is in search View.
SetOptionStateSets the state of the specified option.
SetSearchCriteriaGet search criteria as Search conditions.

Events​

EventDescriptionArguments
StopSent before the Searchpane is closed.
StartedRegisters event handler for the Search pane started event, which means that the Search pane
is ready to be used.
- - + + \ No newline at end of file diff --git a/Frameworks/User-Interface-Extensibility-Framework/Reference/UIExt2/Interfaces/IShellFrame/CallSimplifiedAPI/index.html b/Frameworks/User-Interface-Extensibility-Framework/Reference/UIExt2/Interfaces/IShellFrame/CallSimplifiedAPI/index.html new file mode 100644 index 000000000..1ae0812be --- /dev/null +++ b/Frameworks/User-Interface-Extensibility-Framework/Reference/UIExt2/Interfaces/IShellFrame/CallSimplifiedAPI/index.html @@ -0,0 +1,16 @@ + + + + + +CallSimplifiedAPI | M-Files User Interface Extensibility Framework + + + + +
+
Skip to main content

CallSimplifiedAPI

Description​

Calls a simplified M-Files API endpoint with the specified HTTP method.

NOTE: Stability is experimental. Non-backward compatible changes or removal may occur in any future release. Use of this feature is not recommended for production environments.

Syntax​

// shellFrame points to instance of IShellFrame
const result = await shellFrame.CallSimplifiedAPI(
  requestRelativeURL,
  method,
  payload,
);

Parameters​

NameOptionalityTypeDescription
requestRelativeURLRequiredstringThe relative URL path of the API endpoint to call.
Must start with "/" and may include a query string,
but cannot include fragments, backslashes,
or traversal segments.
methodRequiredstringThe HTTP method to use. Only "GET", "POST", and "DELETE" are allowed.
payloadOptionalstringOptional JSON string to include as the request body (for POST requests).

Return type​

TypeDescription
Promise < any >A promise that resolves to the parsed JSON response from the server,
or rejects with an error if the HTTP request fails or response parsing fails

Exceptions​

NotSupportedError - when the CE3224_SimplifiedCoreAPISupportUIX2 feature flag is not enabled, or when called from a non-cloud vault.

Error - an error if the HTTP response status is not ok, if the request input is invalid, if the user session is unavailable, or if there is a network or parsing error

+ + + + \ No newline at end of file diff --git a/Frameworks/User-Interface-Extensibility-Framework/Reference/UIExt2/Interfaces/IShellFrame/GetSandboxAttributes/index.html b/Frameworks/User-Interface-Extensibility-Framework/Reference/UIExt2/Interfaces/IShellFrame/GetSandboxAttributes/index.html index 6e3eee297..afede03e1 100644 --- a/Frameworks/User-Interface-Extensibility-Framework/Reference/UIExt2/Interfaces/IShellFrame/GetSandboxAttributes/index.html +++ b/Frameworks/User-Interface-Extensibility-Framework/Reference/UIExt2/Interfaces/IShellFrame/GetSandboxAttributes/index.html @@ -4,13 +4,13 @@ GetSandboxAttributes | M-Files User Interface Extensibility Framework - - + +
-
Skip to main content

GetSandboxAttributes

Description​

Gets the sandbox attributes for the specified Module.

Syntax​

// shellFrame points to instance of IShellFrame
const result = await shellFrame.GetSandboxAttributes(dashboardId);

Parameters​

NameOptionalityTypeDescription
dashboardIdRequiredstring | numberThe ID of the dashboard.

Return type​

TypeDescription
Promise < string >The sandbox attributes or undefined if not found.
- - +
Skip to main content

GetSandboxAttributes

Description​

Gets the sandbox attributes for the specified Module.

Syntax​

// shellFrame points to instance of IShellFrame
const result = await shellFrame.GetSandboxAttributes(dashboardId);

Parameters​

NameOptionalityTypeDescription
dashboardIdRequiredstring | numberThe ID of the dashboard.

Return type​

TypeDescription
Promise < string >The sandbox attributes or undefined if not found.
+ + \ No newline at end of file diff --git a/Frameworks/User-Interface-Extensibility-Framework/Reference/UIExt2/Interfaces/IShellFrame/GetViewsById/index.html b/Frameworks/User-Interface-Extensibility-Framework/Reference/UIExt2/Interfaces/IShellFrame/GetViewsById/index.html index 1871eacad..03971e92a 100644 --- a/Frameworks/User-Interface-Extensibility-Framework/Reference/UIExt2/Interfaces/IShellFrame/GetViewsById/index.html +++ b/Frameworks/User-Interface-Extensibility-Framework/Reference/UIExt2/Interfaces/IShellFrame/GetViewsById/index.html @@ -4,13 +4,13 @@ GetViewsById | M-Files User Interface Extensibility Framework - - + +
-
Skip to main content

GetViewsById

Description​

Gets known views details as key pair value of <ViewID,View Details.>

Syntax​

// shellFrame points to instance of IShellFrame
const result = await shellFrame.GetViewsById();

Return type​

TypeDescription
Map < number ,IView >The known views by id.
- - +
Skip to main content

GetViewsById

Description​

Gets known views details as key pair value of <ViewID,View Details.>

Syntax​

// shellFrame points to instance of IShellFrame
const result = await shellFrame.GetViewsById();

Return type​

TypeDescription
Map < number ,IView >The known views by id.
+ + \ No newline at end of file diff --git a/Frameworks/User-Interface-Extensibility-Framework/Reference/UIExt2/Interfaces/IShellFrame/IsFolderLocation/index.html b/Frameworks/User-Interface-Extensibility-Framework/Reference/UIExt2/Interfaces/IShellFrame/IsFolderLocation/index.html index 7dcd1917c..0e2eddd3f 100644 --- a/Frameworks/User-Interface-Extensibility-Framework/Reference/UIExt2/Interfaces/IShellFrame/IsFolderLocation/index.html +++ b/Frameworks/User-Interface-Extensibility-Framework/Reference/UIExt2/Interfaces/IShellFrame/IsFolderLocation/index.html @@ -4,15 +4,15 @@ IsFolderLocation | M-Files User Interface Extensibility Framework - - + +
-
Skip to main content

IsFolderLocation

Description​

Resolves if the shell frame represents a normal folder location. For example it is +

IsFolderLocation

Description​

Resolves if the shell frame represents a normal folder location. For example it is a search folder or view, a property folder or traditional folder, but not an object folder.

Syntax​

// shellFrame points to instance of IShellFrame
const result = await shellFrame.IsFolderLocation();

Return type​

TypeDescription
Promise < boolean >The return value is true if the location represents a normal folder.
- - + + \ No newline at end of file diff --git a/Frameworks/User-Interface-Extensibility-Framework/Reference/UIExt2/Interfaces/IShellFrame/IsObjectLocation/index.html b/Frameworks/User-Interface-Extensibility-Framework/Reference/UIExt2/Interfaces/IShellFrame/IsObjectLocation/index.html index 0fe70d41e..5aa3c1f13 100644 --- a/Frameworks/User-Interface-Extensibility-Framework/Reference/UIExt2/Interfaces/IShellFrame/IsObjectLocation/index.html +++ b/Frameworks/User-Interface-Extensibility-Framework/Reference/UIExt2/Interfaces/IShellFrame/IsObjectLocation/index.html @@ -4,13 +4,13 @@ IsObjectLocation | M-Files User Interface Extensibility Framework - - + +
-

IsObjectLocation

Description​

Resolves if the shell frame represents a object folder location.

Syntax​

// shellFrame points to instance of IShellFrame
const result = await shellFrame.IsObjectLocation();

Return type​

TypeDescription
Promise < boolean >Returns true if the shell frame location represents a object folder.
- - +

IsObjectLocation

Description​

Resolves if the shell frame represents a object folder location.

Syntax​

// shellFrame points to instance of IShellFrame
const result = await shellFrame.IsObjectLocation();

Return type​

TypeDescription
Promise < boolean >Returns true if the shell frame location represents a object folder.
+ + \ No newline at end of file diff --git a/Frameworks/User-Interface-Extensibility-Framework/Reference/UIExt2/Interfaces/IShellFrame/NavigateToFolder/index.html b/Frameworks/User-Interface-Extensibility-Framework/Reference/UIExt2/Interfaces/IShellFrame/NavigateToFolder/index.html index e2d22c934..938361c04 100644 --- a/Frameworks/User-Interface-Extensibility-Framework/Reference/UIExt2/Interfaces/IShellFrame/NavigateToFolder/index.html +++ b/Frameworks/User-Interface-Extensibility-Framework/Reference/UIExt2/Interfaces/IShellFrame/NavigateToFolder/index.html @@ -4,13 +4,13 @@ NavigateToFolder | M-Files User Interface Extensibility Framework - - + +
-

NavigateToFolder

Description​

Navigate to the given folder defs.

Syntax​

// shellFrame points to instance of IShellFrame
await shellFrame.NavigateToFolder(folders);

Parameters​

NameOptionalityTypeDescription
foldersRequiredShellFrameFoldersThe folders to be navigated to.

Return type​

TypeDescription
Promise < void >Method does not return a value

Exceptions​

ArgumentError - When folders is null or undefined.

- - +

NavigateToFolder

Description​

Navigate to the given folder defs.

Syntax​

// shellFrame points to instance of IShellFrame
await shellFrame.NavigateToFolder(folders);

Parameters​

NameOptionalityTypeDescription
foldersRequiredShellFrameFoldersThe folders to be navigated to.

Return type​

TypeDescription
Promise < void >Method does not return a value

Exceptions​

ArgumentError - When folders is null or undefined.

+ + \ No newline at end of file diff --git a/Frameworks/User-Interface-Extensibility-Framework/Reference/UIExt2/Interfaces/IShellFrame/NavigateToObject/index.html b/Frameworks/User-Interface-Extensibility-Framework/Reference/UIExt2/Interfaces/IShellFrame/NavigateToObject/index.html index 73a59a8e0..ae4d9f856 100644 --- a/Frameworks/User-Interface-Extensibility-Framework/Reference/UIExt2/Interfaces/IShellFrame/NavigateToObject/index.html +++ b/Frameworks/User-Interface-Extensibility-Framework/Reference/UIExt2/Interfaces/IShellFrame/NavigateToObject/index.html @@ -4,13 +4,13 @@ NavigateToObject | M-Files User Interface Extensibility Framework - - + +
-

NavigateToObject

Description​

Navigate to the given object.

Syntax​

// shellFrame points to instance of IShellFrame
await shellFrame.NavigateToObject(objId, newWindow, isLatestVersion, version);

Parameters​

NameOptionalityTypeDescription
objIdRequiredObjIDThe object to be navigated to.
newWindowRequiredbooleanFlag to indicate if the navigation should happen in new window/tab.
isLatestVersionOptionalbooleanFlag to indicate if the latest version of the object should be navigated. Default is true.
versionOptionalnumberThe version of the object to be navigated. Default is -1.

Return type​

TypeDescription
Promise < void >Method does not return a value

Exceptions​

ArgumentError - When objId is null or undefined.

- - +

NavigateToObject

Description​

Navigate to the given object.

Syntax​

// shellFrame points to instance of IShellFrame
await shellFrame.NavigateToObject(objId, newWindow, isLatestVersion, version);

Parameters​

NameOptionalityTypeDescription
objIdRequiredObjIDThe object to be navigated to.
newWindowRequiredbooleanFlag to indicate if the navigation should happen in new window/tab.
isLatestVersionOptionalbooleanFlag to indicate if the latest version of the object should be navigated. Default is true.
versionOptionalnumberThe version of the object to be navigated. Default is -1.

Return type​

TypeDescription
Promise < void >Method does not return a value

Exceptions​

ArgumentError - When objId is null or undefined.

+ + \ No newline at end of file diff --git a/Frameworks/User-Interface-Extensibility-Framework/Reference/UIExt2/Interfaces/IShellFrame/NavigateToParent/index.html b/Frameworks/User-Interface-Extensibility-Framework/Reference/UIExt2/Interfaces/IShellFrame/NavigateToParent/index.html index 455d0893c..18bce477f 100644 --- a/Frameworks/User-Interface-Extensibility-Framework/Reference/UIExt2/Interfaces/IShellFrame/NavigateToParent/index.html +++ b/Frameworks/User-Interface-Extensibility-Framework/Reference/UIExt2/Interfaces/IShellFrame/NavigateToParent/index.html @@ -4,13 +4,13 @@ NavigateToParent | M-Files User Interface Extensibility Framework - - + +
-

NavigateToParent

Description​

Performs navigation to the parent folder.

Syntax​

// shellFrame points to instance of IShellFrame
await shellFrame.NavigateToParent();

Return type​

TypeDescription
Promise < void >Method does not return a value
- - +

NavigateToParent

Description​

Performs navigation to the parent folder.

Syntax​

// shellFrame points to instance of IShellFrame
await shellFrame.NavigateToParent();

Return type​

TypeDescription
Promise < void >Method does not return a value
+ + \ No newline at end of file diff --git a/Frameworks/User-Interface-Extensibility-Framework/Reference/UIExt2/Interfaces/IShellFrame/ShowDashboard/index.html b/Frameworks/User-Interface-Extensibility-Framework/Reference/UIExt2/Interfaces/IShellFrame/ShowDashboard/index.html index a583d4f92..cb6a4f1e8 100644 --- a/Frameworks/User-Interface-Extensibility-Framework/Reference/UIExt2/Interfaces/IShellFrame/ShowDashboard/index.html +++ b/Frameworks/User-Interface-Extensibility-Framework/Reference/UIExt2/Interfaces/IShellFrame/ShowDashboard/index.html @@ -4,13 +4,13 @@ ShowDashboard | M-Files User Interface Extensibility Framework - - + +
-

ShowDashboard

Description​

Changes the listing area to show a dashboard.

Syntax​

// shellFrame points to instance of IShellFrame
const result = await shellFrame.ShowDashboard(dashboardID, data);

Parameters​

NameOptionalityTypeDescription
dashboardIDRequiredstringThe ID of the dashboard to show.
dataRequiredanyCustom data passed to the dashboard.

Return type​

TypeDescription
Promise < IDashboard >The dashboard shown in the listing area.

Exceptions​

ArgumentError - When dashboardID is null or undefined.

- - +

ShowDashboard

Description​

Changes the listing area to show a dashboard.

Syntax​

// shellFrame points to instance of IShellFrame
const result = await shellFrame.ShowDashboard(dashboardID, data);

Parameters​

NameOptionalityTypeDescription
dashboardIDRequiredstringThe ID of the dashboard to show.
dataRequiredanyCustom data passed to the dashboard.

Return type​

TypeDescription
Promise < IDashboard >The dashboard shown in the listing area.

Exceptions​

ArgumentError - When dashboardID is null or undefined.

+ + \ No newline at end of file diff --git a/Frameworks/User-Interface-Extensibility-Framework/Reference/UIExt2/Interfaces/IShellFrame/ShowDefaultContent/index.html b/Frameworks/User-Interface-Extensibility-Framework/Reference/UIExt2/Interfaces/IShellFrame/ShowDefaultContent/index.html index 4e28e8a9a..f368e9e66 100644 --- a/Frameworks/User-Interface-Extensibility-Framework/Reference/UIExt2/Interfaces/IShellFrame/ShowDefaultContent/index.html +++ b/Frameworks/User-Interface-Extensibility-Framework/Reference/UIExt2/Interfaces/IShellFrame/ShowDefaultContent/index.html @@ -4,13 +4,13 @@ ShowDefaultContent | M-Files User Interface Extensibility Framework - - + +
-
Skip to main content

ShowDefaultContent

Description​

Restores the normal listing to the listing area and triggers content loading.

Syntax​

// shellFrame points to instance of IShellFrame
await shellFrame.ShowDefaultContent();

Return type​

TypeDescription
Promise < void >Method does not return a value
- - +
Skip to main content

ShowDefaultContent

Description​

Restores the normal listing to the listing area and triggers content loading.

Syntax​

// shellFrame points to instance of IShellFrame
await shellFrame.ShowDefaultContent();

Return type​

TypeDescription
Promise < void >Method does not return a value
+ + \ No newline at end of file diff --git a/Frameworks/User-Interface-Extensibility-Framework/Reference/UIExt2/Interfaces/IShellFrame/ShowMessage/index.html b/Frameworks/User-Interface-Extensibility-Framework/Reference/UIExt2/Interfaces/IShellFrame/ShowMessage/index.html index bc16a891d..482e3fec2 100644 --- a/Frameworks/User-Interface-Extensibility-Framework/Reference/UIExt2/Interfaces/IShellFrame/ShowMessage/index.html +++ b/Frameworks/User-Interface-Extensibility-Framework/Reference/UIExt2/Interfaces/IShellFrame/ShowMessage/index.html @@ -4,13 +4,13 @@ ShowMessage | M-Files User Interface Extensibility Framework - - + +
-
Skip to main content

ShowMessage

Description​

Displays a modal message box.

Syntax​

// shellFrame points to instance of IShellFrame
const result = await shellFrame.ShowMessage(message);

Parameters​

NameOptionalityTypeDescription
messageRequiredstring | ShowMessageParamsString Type - The message to display. The message box contains single Ok button.
Object - Defines the message box content and buttons. Defines the message box content and buttons.

Return type​

TypeDescription
Promise < ShowMessageReturnValue >Interface to indicate if checkbox was selected and which button was clicked.

Exceptions​

ArgumentError - When message is null or undefined.

- - +
Skip to main content

ShowMessage

Description​

Displays a modal message box.

Syntax​

// shellFrame points to instance of IShellFrame
const result = await shellFrame.ShowMessage(message);

Parameters​

NameOptionalityTypeDescription
messageRequiredstring | ShowMessageParamsString Type - The message to display. The message box contains single Ok button.
Object - Defines the message box content and buttons. Defines the message box content and buttons.

Return type​

TypeDescription
Promise < ShowMessageReturnValue >Interface to indicate if checkbox was selected and which button was clicked.

Exceptions​

ArgumentError - When message is null or undefined.

+ + \ No newline at end of file diff --git a/Frameworks/User-Interface-Extensibility-Framework/Reference/UIExt2/Interfaces/IShellFrame/ShowPopupDashboard/index.html b/Frameworks/User-Interface-Extensibility-Framework/Reference/UIExt2/Interfaces/IShellFrame/ShowPopupDashboard/index.html index 2b85909c8..ac65c650f 100644 --- a/Frameworks/User-Interface-Extensibility-Framework/Reference/UIExt2/Interfaces/IShellFrame/ShowPopupDashboard/index.html +++ b/Frameworks/User-Interface-Extensibility-Framework/Reference/UIExt2/Interfaces/IShellFrame/ShowPopupDashboard/index.html @@ -4,13 +4,13 @@ ShowPopupDashboard | M-Files User Interface Extensibility Framework - - + +
-
Skip to main content

ShowPopupDashboard

Description​

Shows a dashboard in popup window.

Syntax​

// shellFrame points to instance of IShellFrame
const result = await shellFrame.ShowPopupDashboard(
  dashboardID,
  data,
  titleOrOptions,
);

Parameters​

NameOptionalityTypeDescription
dashboardIDRequiredstringThe dashboard ID as defined in Application Definition File (appdef file).
dataRequiredanyThe custom data that is passed for dashboard.
Can be accessed with CustomDataProperty of IDashboard Interface.
titleOrOptionsOptionalundefined | string | DialogUIParamsTitle and UI options of the dashboard.
String Type: Defines the title of the dashboard.
Object Type: Defines the title and other UI options [Eg: title/isModal/isResizable/isDraggable].

Return type​

TypeDescription
Promise < IDashboard >The popup dashboard.

Exceptions​

ArgumentError - When dashboardID is null or undefined.

- - +
Skip to main content

ShowPopupDashboard

Description​

Shows a dashboard in popup window.

Syntax​

// shellFrame points to instance of IShellFrame
const result = await shellFrame.ShowPopupDashboard(
  dashboardID,
  data,
  titleOrOptions,
);

Parameters​

NameOptionalityTypeDescription
dashboardIDRequiredstringThe dashboard ID as defined in Application Definition File (appdef file).
dataRequiredanyThe custom data that is passed for dashboard.
Can be accessed with CustomDataProperty of IDashboard Interface.
titleOrOptionsOptionalundefined | string | DialogUIParamsTitle and UI options of the dashboard.
String Type: Defines the title of the dashboard.
Object Type: Defines the title and other UI options [Eg: title/isModal/isResizable/isDraggable].

Return type​

TypeDescription
Promise < IDashboard >The popup dashboard.

Exceptions​

ArgumentError - When dashboardID is null or undefined.

+ + \ No newline at end of file diff --git a/Frameworks/User-Interface-Extensibility-Framework/Reference/UIExt2/Interfaces/IShellFrame/ShowPopupDashboards/index.html b/Frameworks/User-Interface-Extensibility-Framework/Reference/UIExt2/Interfaces/IShellFrame/ShowPopupDashboards/index.html index 0fcf06834..89d78cb17 100644 --- a/Frameworks/User-Interface-Extensibility-Framework/Reference/UIExt2/Interfaces/IShellFrame/ShowPopupDashboards/index.html +++ b/Frameworks/User-Interface-Extensibility-Framework/Reference/UIExt2/Interfaces/IShellFrame/ShowPopupDashboards/index.html @@ -4,13 +4,13 @@ ShowPopupDashboards | M-Files User Interface Extensibility Framework - - + +
-
Skip to main content

ShowPopupDashboards

Description​

Shows multiple dashboards in a popup window with side-by-side layout.

NOTE: Stability is experimental. Non-backward compatible changes or removal may occur in any future release. Use of this feature is not recommended for production environments.

Syntax​

// shellFrame points to instance of IShellFrame
const result = await shellFrame.ShowPopupDashboards(
  dashboardConfigs,
  titleOrOptions,
);

Parameters​

NameOptionalityTypeDescription
dashboardConfigsRequiredArray < DashboardConfig >Array of dashboard configurations. At least one dashboardConfig must be provided,
and each must have a valid dashboardID. The method supports up to three dashboards.
titleOrOptionsOptionalundefined | string | MultiDashboardUIParamsTitle and UI options for the multi-dashboard popup.
String Type: Defines the title of the popup.
Object Type: Defines the title and other UI options including split ratio.

Return type​

TypeDescription
Promise < Array < IDashboard > >Promise resolving to the array of popup dashboard instances.
- - +
Skip to main content

ShowPopupDashboards

Description​

Shows multiple dashboards in a popup window with side-by-side layout.

NOTE: Stability is experimental. Non-backward compatible changes or removal may occur in any future release. Use of this feature is not recommended for production environments.

Syntax​

// shellFrame points to instance of IShellFrame
const result = await shellFrame.ShowPopupDashboards(
  dashboardConfigs,
  titleOrOptions,
);

Parameters​

NameOptionalityTypeDescription
dashboardConfigsRequiredArray < DashboardConfig >Array of dashboard configurations. At least one dashboardConfig must be provided,
and each must have a valid dashboardID. The method supports up to three dashboards.
titleOrOptionsOptionalundefined | string | MultiDashboardUIParamsTitle and UI options for the multi-dashboard popup.
String Type: Defines the title of the popup.
Object Type: Defines the title and other UI options including split ratio.

Return type​

TypeDescription
Promise < Array < IDashboard > >Promise resolving to the array of popup dashboard instances.
+ + \ No newline at end of file diff --git a/Frameworks/User-Interface-Extensibility-Framework/Reference/UIExt2/Interfaces/IShellFrame/index.html b/Frameworks/User-Interface-Extensibility-Framework/Reference/UIExt2/Interfaces/IShellFrame/index.html index 7f065a286..786710695 100644 --- a/Frameworks/User-Interface-Extensibility-Framework/Reference/UIExt2/Interfaces/IShellFrame/index.html +++ b/Frameworks/User-Interface-Extensibility-Framework/Reference/UIExt2/Interfaces/IShellFrame/index.html @@ -4,13 +4,13 @@ IShellFrame | M-Files User Interface Extensibility Framework - - + +
-
Skip to main content

IShellFrame

The IShellFrame is a property of IDashboard.

It can also be retrieved from the IShellUI using the NewShellFrame event.

shellUI.Events.Register(
  MFiles.Event.NewShellFrame,
  (shellFrame) => {

  }
)

Properties​

NameTypeDescription
ActiveListingIShellListingAccesses the currently active listing object.
CommandsICommandsAccesses the commands of the shell frame.
CurrentFolderArray < Folder >Accesses the current folder location. Valid only if the current location is a normal folder location.
CurrentPathstringGets the path to the current folder as string.

For special views, the following built-in path strings are used:
- Search - Search view
- Workspaces - Workspaces view
- Pinned - Pinned view
- Checked Out to Me\\ - Checked Out to Me
- Recently Modified by Me\\ - Recently Modified by Me
- Assigned to Me\\ - Assigned to Me
- Recently Accessed by Me\\ - Recently Accessed by Me
- Object History - Object History
- Conflict Resolution - Conflict Resolution
- _singleObject - Single Object view (opened when navigating to an object)
CurrentUrlstringGets the current view url as a string.
EventsIShellFrameEventsReturns the event registering interface for the IShellFrame interface.
LeftPaneIShellPaneContainerAccesses the left panes of the shell frame.
ListingIShellListingAccesses the main listing object of the shell frame.
ParentFolderArray < Folder >Gets the parent folder for current location.
RightPaneIShellPaneContainerAccesses the right panes of the shell frame.
SearchPaneISearchPaneAccesses the search pane of the shell frame.
ShellUIIShellUIAccesses the parent shell UI object.

Methods​

NameDescription
GetSandboxAttributesGets the sandbox attributes for the specified Module.
GetViewsByIdGets known views details as key pair value of <ViewID,View Details.>
IsFolderLocationResolves if the shell frame represents a normal folder location. For example it is
a search folder or view, a property folder or traditional folder, but not an
object folder.
IsObjectLocationResolves if the shell frame represents a object folder location.
NavigateToFolderNavigate to the given folder defs.
NavigateToObjectNavigate to the given object.
NavigateToParentPerforms navigation to the parent folder.
ShowDashboardChanges the listing area to show a dashboard.
ShowDefaultContentRestores the normal listing to the listing area and triggers content loading.
ShowMessageDisplays a modal message box.
ShowPopupDashboardShows a dashboard in popup window.
ShowPopupDashboardsShows multiple dashboards in a popup window with side-by-side layout.

NOTE: Stability is experimental. Non-backward compatible changes or removal may occur in any future release. Use of this feature is not recommended for production environments.

Events​

EventDescriptionArguments
StopSent before the IShellFrame is stopped.
StartedRegisters event handler for the IShellFrame started event, which means that the IShellFrame
is ready to be used. This event will trigger at least once for each registered callback
if the IShellFrame is already started and not yet stopped.
ViewLocationChangedRegisters event handler for the IShellFrame ViewLocationChanged event, which means that the view location has changed.
ViewLocationChangedAsyncRegisters event handler for the IShellFrame ViewLocationChangedAsync event, which means that the view location has changed.
NewCommandsRegisters event handler for the IShellFrame NewCommands event, which means that a new ICommands interface has been created and is ready to be used.
NewRightPaneRegisters event handler for the IShellFrame NewRightPane event, which means that a shell pane container is created for right shell pane.
NewShellListingRegisters event handler for the IShellFrame NewShellListing event, which means that a new shell listing object is created.newShellisting The new IShellListing object.
shellFrame.Events.Register(
  Event.NewShellListing,
  (newShellisting: IShellListing) => {
    // Do something with the new shell listing object
  },
);
- - +
Skip to main content

IShellFrame

The IShellFrame is a property of IDashboard.

It can also be retrieved from the IShellUI using the NewShellFrame event.

shellUI.Events.Register(
  MFiles.Event.NewShellFrame,
  (shellFrame) => {

  }
)

Properties​

NameTypeDescription
ActiveListingIShellListingAccesses the currently active listing object.
CommandsICommandsAccesses the commands of the shell frame.
CurrentFolderArray < Folder >Accesses the current folder location. Valid only if the current location is a normal folder location.
CurrentPathstringGets the path to the current folder as string.

For special views, the following built-in path strings are used:
- Search - Search view
- Workspaces - Workspaces view
- Pinned - Pinned view
- Checked Out to Me\\ - Checked Out to Me
- Recently Modified by Me\\ - Recently Modified by Me
- Assigned to Me\\ - Assigned to Me
- Recently Accessed by Me\\ - Recently Accessed by Me
- Object History - Object History
- Conflict Resolution - Conflict Resolution
- _singleObject - Single Object view (opened when navigating to an object)
CurrentUrlstringGets the current view url as a string.
EventsIShellFrameEventsReturns the event registering interface for the IShellFrame interface.
LeftPaneIShellPaneContainerAccesses the left panes of the shell frame.
ListingIShellListingAccesses the main listing object of the shell frame.
ParentFolderArray < Folder >Gets the parent folder for current location.
RightPaneIShellPaneContainerAccesses the right panes of the shell frame.
SearchPaneISearchPaneAccesses the search pane of the shell frame.
ShellUIIShellUIAccesses the parent shell UI object.

Methods​

NameDescription
CallSimplifiedAPICalls a simplified M-Files API endpoint with the specified HTTP method.

NOTE: Stability is experimental. Non-backward compatible changes or removal may occur in any future release. Use of this feature is not recommended for production environments.
GetSandboxAttributesGets the sandbox attributes for the specified Module.
GetViewsByIdGets known views details as key pair value of <ViewID,View Details.>
IsFolderLocationResolves if the shell frame represents a normal folder location. For example it is
a search folder or view, a property folder or traditional folder, but not an
object folder.
IsObjectLocationResolves if the shell frame represents a object folder location.
NavigateToFolderNavigate to the given folder defs.
NavigateToObjectNavigate to the given object.
NavigateToParentPerforms navigation to the parent folder.
ShowDashboardChanges the listing area to show a dashboard.
ShowDefaultContentRestores the normal listing to the listing area and triggers content loading.
ShowMessageDisplays a modal message box.
ShowPopupDashboardShows a dashboard in popup window.
ShowPopupDashboardsShows multiple dashboards in a popup window with side-by-side layout.

NOTE: Stability is experimental. Non-backward compatible changes or removal may occur in any future release. Use of this feature is not recommended for production environments.

Events​

EventDescriptionArguments
StopSent before the IShellFrame is stopped.
StartedRegisters event handler for the IShellFrame started event, which means that the IShellFrame
is ready to be used. This event will trigger at least once for each registered callback
if the IShellFrame is already started and not yet stopped.
ViewLocationChangedRegisters event handler for the IShellFrame ViewLocationChanged event, which means that the view location has changed.
ViewLocationChangedAsyncRegisters event handler for the IShellFrame ViewLocationChangedAsync event, which means that the view location has changed.
NewCommandsRegisters event handler for the IShellFrame NewCommands event, which means that a new ICommands interface has been created and is ready to be used.
NewRightPaneRegisters event handler for the IShellFrame NewRightPane event, which means that a shell pane container is created for right shell pane.
NewShellListingRegisters event handler for the IShellFrame NewShellListing event, which means that a new shell listing object is created.newShellisting The new IShellListing object.
shellFrame.Events.Register(
  Event.NewShellListing,
  (newShellisting: IShellListing) => {
    // Do something with the new shell listing object
  },
);
+ + \ No newline at end of file diff --git a/Frameworks/User-Interface-Extensibility-Framework/Reference/UIExt2/Interfaces/IShellItems/GetFoldersCount/index.html b/Frameworks/User-Interface-Extensibility-Framework/Reference/UIExt2/Interfaces/IShellItems/GetFoldersCount/index.html index a8564ebd3..fe6f3f47d 100644 --- a/Frameworks/User-Interface-Extensibility-Framework/Reference/UIExt2/Interfaces/IShellItems/GetFoldersCount/index.html +++ b/Frameworks/User-Interface-Extensibility-Framework/Reference/UIExt2/Interfaces/IShellItems/GetFoldersCount/index.html @@ -4,13 +4,13 @@ GetFoldersCount | M-Files User Interface Extensibility Framework - - + +
Skip to main content

GetFoldersCount

Description​

Gets the number of folders.

Syntax​

// shellItems points to instance of IShellItems
const result = await shellItems.GetFoldersCount();

Return type​

TypeDescription
Promise < number >Number of folders.
- - + + \ No newline at end of file diff --git a/Frameworks/User-Interface-Extensibility-Framework/Reference/UIExt2/Interfaces/IShellItems/GetObjectVersionsAndProperties/index.html b/Frameworks/User-Interface-Extensibility-Framework/Reference/UIExt2/Interfaces/IShellItems/GetObjectVersionsAndProperties/index.html index 1b7bc6b35..87b0a7f4d 100644 --- a/Frameworks/User-Interface-Extensibility-Framework/Reference/UIExt2/Interfaces/IShellItems/GetObjectVersionsAndProperties/index.html +++ b/Frameworks/User-Interface-Extensibility-Framework/Reference/UIExt2/Interfaces/IShellItems/GetObjectVersionsAndProperties/index.html @@ -4,13 +4,13 @@ GetObjectVersionsAndProperties | M-Files User Interface Extensibility Framework - - + +
Skip to main content
- - + + \ No newline at end of file diff --git a/Frameworks/User-Interface-Extensibility-Framework/Reference/UIExt2/Interfaces/IShellItems/GetObjectVersionsCount/index.html b/Frameworks/User-Interface-Extensibility-Framework/Reference/UIExt2/Interfaces/IShellItems/GetObjectVersionsCount/index.html index 428230dea..5d14d46c2 100644 --- a/Frameworks/User-Interface-Extensibility-Framework/Reference/UIExt2/Interfaces/IShellItems/GetObjectVersionsCount/index.html +++ b/Frameworks/User-Interface-Extensibility-Framework/Reference/UIExt2/Interfaces/IShellItems/GetObjectVersionsCount/index.html @@ -4,13 +4,13 @@ GetObjectVersionsCount | M-Files User Interface Extensibility Framework - - + +
Skip to main content

GetObjectVersionsCount

Description​

Gets the number of object versions.

Syntax​

// shellItems points to instance of IShellItems
const result = await shellItems.GetObjectVersionsCount();

Return type​

TypeDescription
Promise < number >Number of versions.
- - + + \ No newline at end of file diff --git a/Frameworks/User-Interface-Extensibility-Framework/Reference/UIExt2/Interfaces/IShellItems/index.html b/Frameworks/User-Interface-Extensibility-Framework/Reference/UIExt2/Interfaces/IShellItems/index.html index 150fbabdb..d399e8840 100644 --- a/Frameworks/User-Interface-Extensibility-Framework/Reference/UIExt2/Interfaces/IShellItems/index.html +++ b/Frameworks/User-Interface-Extensibility-Framework/Reference/UIExt2/Interfaces/IShellItems/index.html @@ -4,13 +4,13 @@ IShellItems | M-Files User Interface Extensibility Framework - - + +
Skip to main content

IShellItems

IShellItems represent a list of Objects in IShellListing, usually the current selection or list of all items in the view.

See the Overview chapter Listing View for more details how to operate the Listing View.

The ObjectVersions type is ObjectVersionEx.

Properties​

NameTypeDescription
CountnumberReturns the number of items in a IShellItems instance.
FoldersArray < IFolder >List of selected Folders
ObjectFilesArray < IObjectFile >List of selected Object Files
ObjectVersionsArray < IObjectVersionEx >List of selected Object Versions

Methods​

NameDescription
GetFoldersCountGets the number of folders.
GetObjectVersionsAndPropertiesGets the object versions and properties for objects in listing.
GetObjectVersionsCountGets the number of object versions.
- - + + \ No newline at end of file diff --git a/Frameworks/User-Interface-Extensibility-Framework/Reference/UIExt2/Interfaces/IShellListing/ActivateListing/index.html b/Frameworks/User-Interface-Extensibility-Framework/Reference/UIExt2/Interfaces/IShellListing/ActivateListing/index.html index 2594bb446..05acf7732 100644 --- a/Frameworks/User-Interface-Extensibility-Framework/Reference/UIExt2/Interfaces/IShellListing/ActivateListing/index.html +++ b/Frameworks/User-Interface-Extensibility-Framework/Reference/UIExt2/Interfaces/IShellListing/ActivateListing/index.html @@ -4,13 +4,13 @@ ActivateListing | M-Files User Interface Extensibility Framework - - + +
Skip to main content

ActivateListing

Description​

Makes this listing window the active listing in the shell frame.

Syntax​

// shellListing points to instance of IShellListing
await shellListing.ActivateListing();

Return type​

TypeDescription
Promise < void >Method does not return a value
- - + + \ No newline at end of file diff --git a/Frameworks/User-Interface-Extensibility-Framework/Reference/UIExt2/Interfaces/IShellListing/ActivateSelected/index.html b/Frameworks/User-Interface-Extensibility-Framework/Reference/UIExt2/Interfaces/IShellListing/ActivateSelected/index.html index 9a8330866..84dec484e 100644 --- a/Frameworks/User-Interface-Extensibility-Framework/Reference/UIExt2/Interfaces/IShellListing/ActivateSelected/index.html +++ b/Frameworks/User-Interface-Extensibility-Framework/Reference/UIExt2/Interfaces/IShellListing/ActivateSelected/index.html @@ -4,13 +4,13 @@ ActivateSelected | M-Files User Interface Extensibility Framework - - + +
Skip to main content

ActivateSelected

Description​

Performs the default action for currently selected item.

Syntax​

// shellListing points to instance of IShellListing
await shellListing.ActivateSelected();

Return type​

TypeDescription
Promise < void >Method does not return a value
- - + + \ No newline at end of file diff --git a/Frameworks/User-Interface-Extensibility-Framework/Reference/UIExt2/Interfaces/IShellListing/AddListingItem/index.html b/Frameworks/User-Interface-Extensibility-Framework/Reference/UIExt2/Interfaces/IShellListing/AddListingItem/index.html index 513af8c45..4a0a74a61 100644 --- a/Frameworks/User-Interface-Extensibility-Framework/Reference/UIExt2/Interfaces/IShellListing/AddListingItem/index.html +++ b/Frameworks/User-Interface-Extensibility-Framework/Reference/UIExt2/Interfaces/IShellListing/AddListingItem/index.html @@ -4,14 +4,14 @@ AddListingItem | M-Files User Interface Extensibility Framework - - + +
Skip to main content

AddListingItem

Description​

Adds a new item to the relevant listings. It is a new method added for vNext.

Syntax​

// shellListing points to instance of IShellListing
await shellListing.AddListingItem(objectVersion);

Parameters​

NameOptionalityTypeDescription
objectVersionRequiredIObjectVersionExThe new object got added.

Return type​

TypeDescription
Promise < void >Method does not return a value

Exceptions​

ArgumentError - When objectVersion is null or undefined.

- - + + \ No newline at end of file diff --git a/Frameworks/User-Interface-Extensibility-Framework/Reference/UIExt2/Interfaces/IShellListing/AddObjectFile/index.html b/Frameworks/User-Interface-Extensibility-Framework/Reference/UIExt2/Interfaces/IShellListing/AddObjectFile/index.html index 4bae73202..e31cf063f 100644 --- a/Frameworks/User-Interface-Extensibility-Framework/Reference/UIExt2/Interfaces/IShellListing/AddObjectFile/index.html +++ b/Frameworks/User-Interface-Extensibility-Framework/Reference/UIExt2/Interfaces/IShellListing/AddObjectFile/index.html @@ -4,8 +4,8 @@ AddObjectFile | M-Files User Interface Extensibility Framework - - + +
@@ -13,7 +13,7 @@ (overriding fileToBeAdded). Data URLs must be base64-encoded, include a MIME type and the decoded payload must not exceed 64 MiB (67,108,864 bytes). When using a data URL you must also provide dataURLName (filename for the decoded file).

Syntax​

// shellListing points to instance of IShellListing
await shellListing.AddObjectFile(
  selectedObject,
  fileToBeAdded,
  dataURL,
  dataURLName,
  skipDuplicateCheck,
);

Parameters​

NameOptionalityTypeDescription
selectedObjectRequiredISelectedFileSelected object info.
fileToBeAddedRequirednull | FileListFile to add (ignored if dataURL provided). See
FileList from MDN
dataURLOptionalnull | stringOptional data URL (base64 + mime); overrides fileToBeAdded.

Supported in M-Files Client version 25.11 and later.
dataURLNameOptionalnull | stringFilename to use when dataURL is supplied (required with dataURL).

Supported in M-Files Client version 25.11 and later.
skipDuplicateCheckOptionalbooleanOptional flag to skip duplicate file check.

Supported in M-Files Client version 26.4 and later.

Return type​

TypeDescription
Promise < void >Method does not return a value

Exceptions​

ArgumentError - When selectedObject or fileToBeAdded is null or undefined in required scenarios.

Error - When dataURL is provided without dataURLName, or dataURLName is provided without dataURL.

- - + + \ No newline at end of file diff --git a/Frameworks/User-Interface-Extensibility-Framework/Reference/UIExt2/Interfaces/IShellListing/GetFolderName/index.html b/Frameworks/User-Interface-Extensibility-Framework/Reference/UIExt2/Interfaces/IShellListing/GetFolderName/index.html index b697b32ed..6d657555c 100644 --- a/Frameworks/User-Interface-Extensibility-Framework/Reference/UIExt2/Interfaces/IShellListing/GetFolderName/index.html +++ b/Frameworks/User-Interface-Extensibility-Framework/Reference/UIExt2/Interfaces/IShellListing/GetFolderName/index.html @@ -4,13 +4,13 @@ GetFolderName | M-Files User Interface Extensibility Framework - - + +
Skip to main content

GetFolderName

Description​

Returns the display name of a folder in the current listing.

Syntax​

// shellListing points to instance of IShellListing
const result = await shellListing.GetFolderName(folderDef);

Parameters​

NameTypeDescription
folderDefIFolderThe folder for which display name should be returned.

Return type​

TypeDescription
Promise < string >Display name of a folder in the current listing.
- - + + \ No newline at end of file diff --git a/Frameworks/User-Interface-Extensibility-Framework/Reference/UIExt2/Interfaces/IShellListing/RefreshListing/index.html b/Frameworks/User-Interface-Extensibility-Framework/Reference/UIExt2/Interfaces/IShellListing/RefreshListing/index.html index 2e65abd5a..fbf0d10e7 100644 --- a/Frameworks/User-Interface-Extensibility-Framework/Reference/UIExt2/Interfaces/IShellListing/RefreshListing/index.html +++ b/Frameworks/User-Interface-Extensibility-Framework/Reference/UIExt2/Interfaces/IShellListing/RefreshListing/index.html @@ -4,13 +4,13 @@ RefreshListing | M-Files User Interface Extensibility Framework - - + +
Skip to main content

RefreshListing

Description​

Refreshes the current listing.

Syntax​

// shellListing points to instance of IShellListing
await shellListing.RefreshListing();

Return type​

TypeDescription
Promise < void >Method does not return a value
- - + + \ No newline at end of file diff --git a/Frameworks/User-Interface-Extensibility-Framework/Reference/UIExt2/Interfaces/IShellListing/RefreshObject/index.html b/Frameworks/User-Interface-Extensibility-Framework/Reference/UIExt2/Interfaces/IShellListing/RefreshObject/index.html index 69fe55508..5b5688054 100644 --- a/Frameworks/User-Interface-Extensibility-Framework/Reference/UIExt2/Interfaces/IShellListing/RefreshObject/index.html +++ b/Frameworks/User-Interface-Extensibility-Framework/Reference/UIExt2/Interfaces/IShellListing/RefreshObject/index.html @@ -4,13 +4,13 @@ RefreshObject | M-Files User Interface Extensibility Framework - - + +
Skip to main content

RefreshObject

Description​

Refreshes the specified object in the listing.

Syntax​

// shellListing points to instance of IShellListing
const result = await shellListing.RefreshObject(
  objID,
  refreshFromServer,
  updateRelatedObjects,
);

Parameters​

NameOptionalityTypeDescription
objIDRequiredObjIDThe object to refresh.
refreshFromServerRequiredbooleanIf true, refreshes the data of the object from the server.
updateRelatedObjectsRequiredbooleanIf true, the related objects of the specified object are also updated.

Return type​

TypeDescription
Promise < void >This method returns a promise that resolves when the refresh is complete.
- - + + \ No newline at end of file diff --git a/Frameworks/User-Interface-Extensibility-Framework/Reference/UIExt2/Interfaces/IShellListing/RemoveListingItem/index.html b/Frameworks/User-Interface-Extensibility-Framework/Reference/UIExt2/Interfaces/IShellListing/RemoveListingItem/index.html index b9dd41ae2..1150d22c4 100644 --- a/Frameworks/User-Interface-Extensibility-Framework/Reference/UIExt2/Interfaces/IShellListing/RemoveListingItem/index.html +++ b/Frameworks/User-Interface-Extensibility-Framework/Reference/UIExt2/Interfaces/IShellListing/RemoveListingItem/index.html @@ -4,14 +4,14 @@ RemoveListingItem | M-Files User Interface Extensibility Framework - - + +
Skip to main content

RemoveListingItem

Description​

Removes an item or items in an array from the listing. It is a new method added for vNext.

Syntax​

// shellListing points to instance of IShellListing
await shellListing.RemoveListingItem(removedItems);

Parameters​

NameOptionalityTypeDescription
removedItemsRequiredIFolder | IObjectVersionEx | Array < IObjectVersionEx >The item or array of items that got removed.

Return type​

TypeDescription
Promise < void >Method does not return a value

Exceptions​

ArgumentError - When removedItems contains null or undefined items.

- - + + \ No newline at end of file diff --git a/Frameworks/User-Interface-Extensibility-Framework/Reference/UIExt2/Interfaces/IShellListing/ReplaceFile/index.html b/Frameworks/User-Interface-Extensibility-Framework/Reference/UIExt2/Interfaces/IShellListing/ReplaceFile/index.html index 2530e033e..3ed0f0efe 100644 --- a/Frameworks/User-Interface-Extensibility-Framework/Reference/UIExt2/Interfaces/IShellListing/ReplaceFile/index.html +++ b/Frameworks/User-Interface-Extensibility-Framework/Reference/UIExt2/Interfaces/IShellListing/ReplaceFile/index.html @@ -4,8 +4,8 @@ ReplaceFile | M-Files User Interface Extensibility Framework - - + +
@@ -13,7 +13,7 @@ (overriding fileToBeReplaced). Data URLs must be base64-encoded, include a MIME type and the decoded payload must not exceed 64 MiB (67,108,864 bytes). When using a data URL you must also provide dataURLName (filename for the decoded file).

Syntax​

// shellListing points to instance of IShellListing
await shellListing.ReplaceFile(
  selectedFileID,
  selectedObject,
  fileToBeReplaced,
  dataURL,
  dataURLName,
  skipDuplicateCheck,
);

Parameters​

NameOptionalityTypeDescription
selectedFileIDRequirednumberSelected file's ID.
selectedObjectRequiredISelectedFileSelected object info.
fileToBeReplacedRequirednull | FileListFile to replace (ignored if dataURL provided). See
FileList from MDN
dataURLOptionalnull | stringOptional data URL (base64 + mime); overrides fileToBeReplaced.

Supported in M-Files Client version 25.11 and later.
dataURLNameOptionalnull | stringFilename to use when dataURL is supplied (required with dataURL).

Supported in M-Files Client version 25.11 and later.
skipDuplicateCheckOptionalbooleanOptional flag to skip duplicate file check.

Supported in M-Files Client version 26.4 and later.

Return type​

TypeDescription
Promise < void >Method does not return a value

Exceptions​

ArgumentError - When selectedFileID, selectedObject, or fileToBeReplaced is null or undefined in required scenarios.

Error - When dataURL is provided without dataURLName, or dataURLName is provided without dataURL.

- - + + \ No newline at end of file diff --git a/Frameworks/User-Interface-Extensibility-Framework/Reference/UIExt2/Interfaces/IShellListing/SelectFolder/index.html b/Frameworks/User-Interface-Extensibility-Framework/Reference/UIExt2/Interfaces/IShellListing/SelectFolder/index.html index 1417d9557..4e4fdfe60 100644 --- a/Frameworks/User-Interface-Extensibility-Framework/Reference/UIExt2/Interfaces/IShellListing/SelectFolder/index.html +++ b/Frameworks/User-Interface-Extensibility-Framework/Reference/UIExt2/Interfaces/IShellListing/SelectFolder/index.html @@ -4,13 +4,13 @@ SelectFolder | M-Files User Interface Extensibility Framework - - + +
Skip to main content

SelectFolder

Description​

Moves the selection to the folder item.

Syntax​

// shellListing points to instance of IShellListing
await shellListing.SelectFolder(folder);

Parameters​

NameOptionalityTypeDescription
folderRequiredFolderThe folder to select.

Return type​

TypeDescription
Promise < void >Method does not return a value

Exceptions​

ArgumentError - When folder is null or undefined.

- - + + \ No newline at end of file diff --git a/Frameworks/User-Interface-Extensibility-Framework/Reference/UIExt2/Interfaces/IShellListing/SelectNextFolder/index.html b/Frameworks/User-Interface-Extensibility-Framework/Reference/UIExt2/Interfaces/IShellListing/SelectNextFolder/index.html index f53dd9efe..09c5137d2 100644 --- a/Frameworks/User-Interface-Extensibility-Framework/Reference/UIExt2/Interfaces/IShellListing/SelectNextFolder/index.html +++ b/Frameworks/User-Interface-Extensibility-Framework/Reference/UIExt2/Interfaces/IShellListing/SelectNextFolder/index.html @@ -4,13 +4,13 @@ SelectNextFolder | M-Files User Interface Extensibility Framework - - + +
Skip to main content

SelectNextFolder

Description​

Moves the current selection to the next folder item.

Syntax​

// shellListing points to instance of IShellListing
await shellListing.SelectNextFolder(folderType);

Parameters​

NameOptionalityTypeDescription
folderTypeRequirednumberFoldertype to select.

Return type​

TypeDescription
Promise < void >Method does not return a value

Exceptions​

ArgumentError - When folderType is null or undefined.

- - + + \ No newline at end of file diff --git a/Frameworks/User-Interface-Extensibility-Framework/Reference/UIExt2/Interfaces/IShellListing/SelectNextObject/index.html b/Frameworks/User-Interface-Extensibility-Framework/Reference/UIExt2/Interfaces/IShellListing/SelectNextObject/index.html index 396944c5d..271cc1d9e 100644 --- a/Frameworks/User-Interface-Extensibility-Framework/Reference/UIExt2/Interfaces/IShellListing/SelectNextObject/index.html +++ b/Frameworks/User-Interface-Extensibility-Framework/Reference/UIExt2/Interfaces/IShellListing/SelectNextObject/index.html @@ -4,13 +4,13 @@ SelectNextObject | M-Files User Interface Extensibility Framework - - + +
Skip to main content

SelectNextObject

Description​

Moves the current selection to the next object (object version) item.

Syntax​

// shellListing points to instance of IShellListing
await shellListing.SelectNextObject();

Return type​

TypeDescription
Promise < void >Method does not return a value
- - + + \ No newline at end of file diff --git a/Frameworks/User-Interface-Extensibility-Framework/Reference/UIExt2/Interfaces/IShellListing/SelectNextObjectFile/index.html b/Frameworks/User-Interface-Extensibility-Framework/Reference/UIExt2/Interfaces/IShellListing/SelectNextObjectFile/index.html index be6fe63f5..15d7f3dc5 100644 --- a/Frameworks/User-Interface-Extensibility-Framework/Reference/UIExt2/Interfaces/IShellListing/SelectNextObjectFile/index.html +++ b/Frameworks/User-Interface-Extensibility-Framework/Reference/UIExt2/Interfaces/IShellListing/SelectNextObjectFile/index.html @@ -4,13 +4,13 @@ SelectNextObjectFile | M-Files User Interface Extensibility Framework - - + +
Skip to main content

SelectNextObjectFile

Description​

Moves the current selection to the next object file.

Syntax​

// shellListing points to instance of IShellListing
await shellListing.SelectNextObjectFile(allowMoveToNextObject);

Parameters​

NameOptionalityTypeDescription
allowMoveToNextObjectRequiredbooleanTrue if the method can navigate to another object.
False to keep the selectionwithin the same parent object version.

Return type​

TypeDescription
Promise < void >Method does not return a value

Exceptions​

ArgumentError - When allowMoveToNextObject is null or undefined.

- - + + \ No newline at end of file diff --git a/Frameworks/User-Interface-Extensibility-Framework/Reference/UIExt2/Interfaces/IShellListing/SelectObjectFile/index.html b/Frameworks/User-Interface-Extensibility-Framework/Reference/UIExt2/Interfaces/IShellListing/SelectObjectFile/index.html index 54afed4ef..64fd6787f 100644 --- a/Frameworks/User-Interface-Extensibility-Framework/Reference/UIExt2/Interfaces/IShellListing/SelectObjectFile/index.html +++ b/Frameworks/User-Interface-Extensibility-Framework/Reference/UIExt2/Interfaces/IShellListing/SelectObjectFile/index.html @@ -4,13 +4,13 @@ SelectObjectFile | M-Files User Interface Extensibility Framework - - + +
Skip to main content

SelectObjectFile

Description​

Selects the object (object version) item.

Syntax​

// shellListing points to instance of IShellListing
await shellListing.SelectObjectFile(objVer, fileVer);

Parameters​

NameOptionalityTypeDescription
objVerRequiredIObjVerSpecifies the parent object version.
fileVerRequiredIFileVerSpecifies the file to select.

Return type​

TypeDescription
Promise < void >Method does not return a value

Exceptions​

ArgumentError - When objVer or fileVer is null or undefined.

- - + + \ No newline at end of file diff --git a/Frameworks/User-Interface-Extensibility-Framework/Reference/UIExt2/Interfaces/IShellListing/SelectObjectOrObjectFileVersion/index.html b/Frameworks/User-Interface-Extensibility-Framework/Reference/UIExt2/Interfaces/IShellListing/SelectObjectOrObjectFileVersion/index.html index d6c5fe8bd..dd4df9b1f 100644 --- a/Frameworks/User-Interface-Extensibility-Framework/Reference/UIExt2/Interfaces/IShellListing/SelectObjectOrObjectFileVersion/index.html +++ b/Frameworks/User-Interface-Extensibility-Framework/Reference/UIExt2/Interfaces/IShellListing/SelectObjectOrObjectFileVersion/index.html @@ -4,13 +4,13 @@ SelectObjectOrObjectFileVersion | M-Files User Interface Extensibility Framework - - + +
Skip to main content

SelectObjectOrObjectFileVersion

Description​

Selects object or file version in the listing window.

Syntax​

// shellListing points to instance of IShellListing
await shellListing.SelectObjectOrObjectFileVersion(objOrFileVer);

Parameters​

NameOptionalityTypeDescription
objOrFileVerRequiredObjectFileVersionParamsObject or object file identification.

Return type​

TypeDescription
Promise < void >Method does not return a value

Exceptions​

ArgumentError - When objOrFileVer is null or undefined.

- - + + \ No newline at end of file diff --git a/Frameworks/User-Interface-Extensibility-Framework/Reference/UIExt2/Interfaces/IShellListing/SelectObjectVersion/index.html b/Frameworks/User-Interface-Extensibility-Framework/Reference/UIExt2/Interfaces/IShellListing/SelectObjectVersion/index.html index d9f9485bd..b6dfa5b57 100644 --- a/Frameworks/User-Interface-Extensibility-Framework/Reference/UIExt2/Interfaces/IShellListing/SelectObjectVersion/index.html +++ b/Frameworks/User-Interface-Extensibility-Framework/Reference/UIExt2/Interfaces/IShellListing/SelectObjectVersion/index.html @@ -4,13 +4,13 @@ SelectObjectVersion | M-Files User Interface Extensibility Framework - - + +
Skip to main content

SelectObjectVersion

Description​

Selects the object file item.

Syntax​

// shellListing points to instance of IShellListing
const result = await shellListing.SelectObjectVersion(objVer);

Parameters​

NameOptionalityTypeDescription
objVerRequiredObjVerSpecifies the object version to select.

Return type​

TypeDescription
Promise < void >Returns nothing.

Exceptions​

ArgumentError - When objVer is null or undefined.

NotFoundError - When the object version is not found in current listing.

- - + + \ No newline at end of file diff --git a/Frameworks/User-Interface-Extensibility-Framework/Reference/UIExt2/Interfaces/IShellListing/SelectPrevFolder/index.html b/Frameworks/User-Interface-Extensibility-Framework/Reference/UIExt2/Interfaces/IShellListing/SelectPrevFolder/index.html index 3533bbb99..95f01caaf 100644 --- a/Frameworks/User-Interface-Extensibility-Framework/Reference/UIExt2/Interfaces/IShellListing/SelectPrevFolder/index.html +++ b/Frameworks/User-Interface-Extensibility-Framework/Reference/UIExt2/Interfaces/IShellListing/SelectPrevFolder/index.html @@ -4,13 +4,13 @@ SelectPrevFolder | M-Files User Interface Extensibility Framework - - + +
Skip to main content

SelectPrevFolder

Description​

Moves the current selection to the previous folder.

Syntax​

// shellListing points to instance of IShellListing
await shellListing.SelectPrevFolder(folderType);

Parameters​

NameOptionalityTypeDescription
folderTypeRequirednumberSpecifies to folder type to select.

Return type​

TypeDescription
Promise < void >Method does not return a value

Exceptions​

ArgumentError - When folderType is null or undefined.

- - + + \ No newline at end of file diff --git a/Frameworks/User-Interface-Extensibility-Framework/Reference/UIExt2/Interfaces/IShellListing/SelectPrevObject/index.html b/Frameworks/User-Interface-Extensibility-Framework/Reference/UIExt2/Interfaces/IShellListing/SelectPrevObject/index.html index d7f782bb0..28ef4afff 100644 --- a/Frameworks/User-Interface-Extensibility-Framework/Reference/UIExt2/Interfaces/IShellListing/SelectPrevObject/index.html +++ b/Frameworks/User-Interface-Extensibility-Framework/Reference/UIExt2/Interfaces/IShellListing/SelectPrevObject/index.html @@ -4,13 +4,13 @@ SelectPrevObject | M-Files User Interface Extensibility Framework - - + +
Skip to main content

SelectPrevObject

Description​

Moves the current selection to the previous object (object version) item.

Syntax​

// shellListing points to instance of IShellListing
await shellListing.SelectPrevObject();

Return type​

TypeDescription
Promise < void >Method does not return a value
- - + + \ No newline at end of file diff --git a/Frameworks/User-Interface-Extensibility-Framework/Reference/UIExt2/Interfaces/IShellListing/SelectPrevObjectFile/index.html b/Frameworks/User-Interface-Extensibility-Framework/Reference/UIExt2/Interfaces/IShellListing/SelectPrevObjectFile/index.html index fab81aee8..27e5ca234 100644 --- a/Frameworks/User-Interface-Extensibility-Framework/Reference/UIExt2/Interfaces/IShellListing/SelectPrevObjectFile/index.html +++ b/Frameworks/User-Interface-Extensibility-Framework/Reference/UIExt2/Interfaces/IShellListing/SelectPrevObjectFile/index.html @@ -4,13 +4,13 @@ SelectPrevObjectFile | M-Files User Interface Extensibility Framework - - + +
Skip to main content

SelectPrevObjectFile

Description​

Moves the current selection to the previous object file item.

Syntax​

// shellListing points to instance of IShellListing
await shellListing.SelectPrevObjectFile(allowMoveToPrevObject);

Parameters​

NameOptionalityTypeDescription
allowMoveToPrevObjectRequiredbooleanTrue if the method can navigate to another object.
False to keep the selectionwithin the same parent object version.

Return type​

TypeDescription
Promise < void >Method does not return a value

Exceptions​

ArgumentError - When allowMoveToPrevObject is null or undefined.

- - + + \ No newline at end of file diff --git a/Frameworks/User-Interface-Extensibility-Framework/Reference/UIExt2/Interfaces/IShellListing/SetFolderOrObjectVersionSelectionStates/index.html b/Frameworks/User-Interface-Extensibility-Framework/Reference/UIExt2/Interfaces/IShellListing/SetFolderOrObjectVersionSelectionStates/index.html index 72db8c922..bb5932b88 100644 --- a/Frameworks/User-Interface-Extensibility-Framework/Reference/UIExt2/Interfaces/IShellListing/SetFolderOrObjectVersionSelectionStates/index.html +++ b/Frameworks/User-Interface-Extensibility-Framework/Reference/UIExt2/Interfaces/IShellListing/SetFolderOrObjectVersionSelectionStates/index.html @@ -4,13 +4,13 @@ SetFolderOrObjectVersionSelectionStates | M-Files User Interface Extensibility Framework - - + +
Skip to main content

SetFolderOrObjectVersionSelectionStates

Description​

Selects or unselects both property folders and object versions.

Syntax​

// shellListing points to instance of IShellListing
await shellListing.SetFolderOrObjectVersionSelectionStates(
  folders,
  objVers,
  files,
  select,
);

Parameters​

NameOptionalityTypeDescription
foldersRequiredArray < Folder >FolderCollection to identify the property folders
to select or unselect.
objVersRequiredArray < ObjVer >Object versions to select or unselect.
filesRequiredArray < IObjectFile >Files to select or unselect.
selectRequiredbooleanTrue to select, false to unselect.

Return type​

TypeDescription
Promise < void >Method does not return a value

Exceptions​

ArgumentError - When folders, objVers, files, or select is null or undefined.

- - + + \ No newline at end of file diff --git a/Frameworks/User-Interface-Extensibility-Framework/Reference/UIExt2/Interfaces/IShellListing/SetFolderSelectionStates/index.html b/Frameworks/User-Interface-Extensibility-Framework/Reference/UIExt2/Interfaces/IShellListing/SetFolderSelectionStates/index.html index 6659d10c9..bac15a30b 100644 --- a/Frameworks/User-Interface-Extensibility-Framework/Reference/UIExt2/Interfaces/IShellListing/SetFolderSelectionStates/index.html +++ b/Frameworks/User-Interface-Extensibility-Framework/Reference/UIExt2/Interfaces/IShellListing/SetFolderSelectionStates/index.html @@ -4,13 +4,13 @@ SetFolderSelectionStates | M-Files User Interface Extensibility Framework - - + +
Skip to main content

SetFolderSelectionStates

Description​

Selects or unselects property folders.

Syntax​

// shellListing points to instance of IShellListing
await shellListing.SetFolderSelectionStates(folders, select);

Parameters​

NameOptionalityTypeDescription
foldersRequiredArray < IFolder >FolderCollection to identify the property folders
to select or unselect. Note:the array contains one IFolderDef item for each property
folder to select or unselect. It is not a path to single property folder.
selectRequiredbooleanTrue to select, false to unselect.

Return type​

TypeDescription
Promise < void >Method does not return a value

Exceptions​

ArgumentError - When folders or select is null or undefined.

- - + + \ No newline at end of file diff --git a/Frameworks/User-Interface-Extensibility-Framework/Reference/UIExt2/Interfaces/IShellListing/SetObjectOrObjectFileVersionSelectionStates/index.html b/Frameworks/User-Interface-Extensibility-Framework/Reference/UIExt2/Interfaces/IShellListing/SetObjectOrObjectFileVersionSelectionStates/index.html index 30bb3588e..7d2225a69 100644 --- a/Frameworks/User-Interface-Extensibility-Framework/Reference/UIExt2/Interfaces/IShellListing/SetObjectOrObjectFileVersionSelectionStates/index.html +++ b/Frameworks/User-Interface-Extensibility-Framework/Reference/UIExt2/Interfaces/IShellListing/SetObjectOrObjectFileVersionSelectionStates/index.html @@ -4,13 +4,13 @@ SetObjectOrObjectFileVersionSelectionStates | M-Files User Interface Extensibility Framework - - + +
Skip to main content

SetObjectOrObjectFileVersionSelectionStates

Description​

Selects or unselects objects or object files.

Syntax​

// shellListing points to instance of IShellListing
await shellListing.SetObjectOrObjectFileVersionSelectionStates(
  objOrFileVers,
  select,
);

Parameters​

NameOptionalityTypeDescription
objOrFileVersRequiredArray < ObjectFileVersionParams >Array of object or file versions to select or unselect.
selectRequiredbooleanTrue to select, false to unselect.

Return type​

TypeDescription
Promise < void >Method does not return a value

Exceptions​

ArgumentError - When objOrFileVers or select is null or undefined.

- - + + \ No newline at end of file diff --git a/Frameworks/User-Interface-Extensibility-Framework/Reference/UIExt2/Interfaces/IShellListing/SetObjectVersionSelectionStates/index.html b/Frameworks/User-Interface-Extensibility-Framework/Reference/UIExt2/Interfaces/IShellListing/SetObjectVersionSelectionStates/index.html index 025631f01..54f888b5a 100644 --- a/Frameworks/User-Interface-Extensibility-Framework/Reference/UIExt2/Interfaces/IShellListing/SetObjectVersionSelectionStates/index.html +++ b/Frameworks/User-Interface-Extensibility-Framework/Reference/UIExt2/Interfaces/IShellListing/SetObjectVersionSelectionStates/index.html @@ -4,13 +4,13 @@ SetObjectVersionSelectionStates | M-Files User Interface Extensibility Framework - - + +
Skip to main content

SetObjectVersionSelectionStates

Description​

Selects or unselects object versions.

Syntax​

// shellListing points to instance of IShellListing
await shellListing.SetObjectVersionSelectionStates(objVers, select);

Parameters​

NameOptionalityTypeDescription
objVersRequiredArray < ObjVer >Object versions to select or unselect.
selectRequiredbooleanTrue to select, false to unselect.

Return type​

TypeDescription
Promise < void >Method does not return a value

Exceptions​

ArgumentError - When objVers or select is null or undefined.

- - + + \ No newline at end of file diff --git a/Frameworks/User-Interface-Extensibility-Framework/Reference/UIExt2/Interfaces/IShellListing/SetVirtualSelection/index.html b/Frameworks/User-Interface-Extensibility-Framework/Reference/UIExt2/Interfaces/IShellListing/SetVirtualSelection/index.html index e17a4c751..2c61b7d41 100644 --- a/Frameworks/User-Interface-Extensibility-Framework/Reference/UIExt2/Interfaces/IShellListing/SetVirtualSelection/index.html +++ b/Frameworks/User-Interface-Extensibility-Framework/Reference/UIExt2/Interfaces/IShellListing/SetVirtualSelection/index.html @@ -4,14 +4,14 @@ SetVirtualSelection | M-Files User Interface Extensibility Framework - - + +
Skip to main content

SetVirtualSelection

Description​

Overrides the items selection with a virtual selection. Items should be valid objects, otherwise the method will throw an exception and selection will not be changed.

Syntax​

// shellListing points to instance of IShellListing
const result = await shellListing.SetVirtualSelection(objOrFileVers);

Parameters​

NameOptionalityTypeDescription
objOrFileVersRequiredArray < ObjectFileVersionParams >Array of object or file versions to select virtually.

Return type​

TypeDescription
Promise < void >

Exceptions​

ArgumentError - When objOrFileVers is null or undefined, or when required obj_ver/file_ver values are missing.

Error - When referenced object or file cannot be resolved.

- - + + \ No newline at end of file diff --git a/Frameworks/User-Interface-Extensibility-Framework/Reference/UIExt2/Interfaces/IShellListing/UnselectAll/index.html b/Frameworks/User-Interface-Extensibility-Framework/Reference/UIExt2/Interfaces/IShellListing/UnselectAll/index.html index 35b1f8e44..5ccf44a02 100644 --- a/Frameworks/User-Interface-Extensibility-Framework/Reference/UIExt2/Interfaces/IShellListing/UnselectAll/index.html +++ b/Frameworks/User-Interface-Extensibility-Framework/Reference/UIExt2/Interfaces/IShellListing/UnselectAll/index.html @@ -4,13 +4,13 @@ UnselectAll | M-Files User Interface Extensibility Framework - - + +
Skip to main content

UnselectAll

Description​

Unselects the current selection.

Syntax​

// shellListing points to instance of IShellListing
await shellListing.UnselectAll();

Return type​

TypeDescription
Promise < void >Method does not return a value
- - + + \ No newline at end of file diff --git a/Frameworks/User-Interface-Extensibility-Framework/Reference/UIExt2/Interfaces/IShellListing/UpdateListingItem/index.html b/Frameworks/User-Interface-Extensibility-Framework/Reference/UIExt2/Interfaces/IShellListing/UpdateListingItem/index.html index a84c94e77..34661d6d8 100644 --- a/Frameworks/User-Interface-Extensibility-Framework/Reference/UIExt2/Interfaces/IShellListing/UpdateListingItem/index.html +++ b/Frameworks/User-Interface-Extensibility-Framework/Reference/UIExt2/Interfaces/IShellListing/UpdateListingItem/index.html @@ -4,14 +4,14 @@ UpdateListingItem | M-Files User Interface Extensibility Framework - - + +
Skip to main content

UpdateListingItem

Description​

Update the items in the listing. It is a new method added for vNext.

Syntax​

// shellListing points to instance of IShellListing
const result = await shellListing.UpdateListingItem(
  oldObjVers,
  newObjVers,
  triggerCurrentSelection,
);

Parameters​

NameOptionalityTypeDescription
oldObjVersRequiredArray < IObjectVersionEx > | Array < ObjVer >The old object versions.
newObjVersRequiredArray < IObjectVersionEx > | Array < ObjVer >The new object versions.
triggerCurrentSelectionOptionalbooleanTrue to trigger current selection event
without any condition. By default specify false or do not pass anything for this parameter.
Only for special cases like Follow/Unfollow object actions this parameter
should be passed as true.

Return type​

TypeDescription
Promise < boolean >Return "true" if the action succeeds, otherwise "false".

Exceptions​

ArgumentError - When oldObjVers or newObjVers is null or undefined.

- - + + \ No newline at end of file diff --git a/Frameworks/User-Interface-Extensibility-Framework/Reference/UIExt2/Interfaces/IShellListing/index.html b/Frameworks/User-Interface-Extensibility-Framework/Reference/UIExt2/Interfaces/IShellListing/index.html index 4cd9b7c33..7f34afb31 100644 --- a/Frameworks/User-Interface-Extensibility-Framework/Reference/UIExt2/Interfaces/IShellListing/index.html +++ b/Frameworks/User-Interface-Extensibility-Framework/Reference/UIExt2/Interfaces/IShellListing/index.html @@ -4,14 +4,14 @@ IShellListing | M-Files User Interface Extensibility Framework - - + +
Skip to main content

IShellListing

Instances of IShellListing represent the Objects inside the Listing View tree in the M-Files Client application UI. The interface is available for example from ActiveListing property of IShellFrame.

See the Overview chapter Listing View for more details how to operate the object.

Properties​

NameTypeDescription
CurrentPathstringGets the current location as a path.
CurrentSelectionIShellItemsReturns the currently selected items as IShellItems object.
EventsIShellListingEventsReturns the event registering interface of the IShellListing interface.
IsActivebooleanChecks if this listing window is currently the active listing window.
ItemsIShellItemsGets the items.

Methods​

NameDescription
ActivateListingMakes this listing window the active listing in the shell frame.
ActivateSelectedPerforms the default action for currently selected item.
AddListingItemAdds a new item to the relevant listings.
It is a new method added for vNext.
AddObjectFilePerform add file for MFD.

If a data URL is provided it takes precedence and will be used as the added file
(overriding fileToBeAdded). Data URLs must be base64-encoded, include a MIME type and
the decoded payload must not exceed 64 MiB (67,108,864 bytes). When using a data URL you
must also provide dataURLName (filename for the decoded file).
RefreshListingRefreshes the current listing.
RefreshObjectRefreshes the specified object in the listing.
RemoveListingItemRemoves an item or items in an array from the listing.
It is a new method added for vNext.
ReplaceFilePerform file replace.

If a data URL is provided it takes precedence and will be used as the replacement file
(overriding fileToBeReplaced). Data URLs must be base64-encoded, include a MIME type and
the decoded payload must not exceed 64 MiB (67,108,864 bytes). When using a data URL you
must also provide dataURLName (filename for the decoded file).
SelectFolderMoves the selection to the folder item.
SelectNextFolderMoves the current selection to the next folder item.
SelectNextObjectMoves the current selection to the next object (object version) item.
SelectNextObjectFileMoves the current selection to the next object file.
SelectObjectFileSelects the object (object version) item.
SelectObjectOrObjectFileVersionSelects object or file version in the listing window.
SelectObjectVersionSelects the object file item.
SelectPrevFolderMoves the current selection to the previous folder.
SelectPrevObjectMoves the current selection to the previous object (object version) item.
SelectPrevObjectFileMoves the current selection to the previous object file item.
SetFolderOrObjectVersionSelectionStatesSelects or unselects both property folders and object versions.
SetFolderSelectionStatesSelects or unselects property folders.
SetObjectOrObjectFileVersionSelectionStatesSelects or unselects objects or object files.
SetObjectVersionSelectionStatesSelects or unselects object versions.
SetVirtualSelectionOverrides the items selection with a virtual selection. Items should be valid objects, otherwise the method will throw an exception
and selection will not be changed.
UnselectAllUnselects the current selection.
UpdateListingItemUpdate the items in the listing.
It is a new method added for vNext.

Events​

EventDescriptionArguments
StartedRegisters event handler for the IShellListingEvents started event.
StopRegisters event handler for the IShellListingEvents stopped event.
SelectionChangedRegisters event handler for the IShellListingEvents SelectionChanged event.
This event is triggered when the selection in the listing view is set, changed or removed.		shellItems Contains the selected items.
SelectNextObjectRegisters event handler for the IShellListingEvents SelectNextObject event. This event is triggered when the next object in the listing is selected.
SelectPreviousObjectRegisters event handler for the IShellListingEvents SelectPreviousObject event. This event is triggered when the previous object in the listing is selected.
SelectNextFolderRegisters event handler for the IShellListingEvents SelectNextFolder event. This event is triggered when the next folder in the listing is selected.folderType type of the folder, which have been selected.
SelectPreviousFolderRegisters event handler for the IShellListingEvents SelectPreviousFolder event. This event is triggered when the previous folder in the listing is selected.folderType type of the folder, which have been selected.
ListingDeactivatedRegisters event handler for the IShellListingEvents ListingDeactivated event.
This event is triggered when the listing object becomes inactive and loses the input focus.		shellListing The next active shell listing object. Can be null.
ListingActivatedRegisters event handler for the IShellListingEvents ListingActivated event.
This event is triggered when the listing object becomes active and receives the input focus.		shellListing The previous active shell listing object. Can be null.
ContentChangedRegisters event handler for the IShellListingEvents ContentChanged event.
This event is triggered when the current listing content is changed, or listed items are modified.		shellItems Contains all items in the listing.
ListItemAddedRegisters event handler for the IShellListingEvents ListItemAdded event. This event is triggered when one or more items are added to the listing.objectVersion Object
ListItemRemovedRegisters event handler for the IShellListingEvents ListItemRemoved event. This event is triggered when one or more items are removed from the listing.listItem Either an array of ObjectVersionEx if non-folder objects are removed or a single ObjectVersionEx, in case folder is removed.
removedExternalFolder In case folder was removed, include information about the old external folder item being removed in case of
ListItemModifiedRegisters event handler for the IShellListingEvents ListItemModified event.
This event is triggered when one or more of the items that are currently selected are modified.		oldServerObjVer Array of old object versions.
newObjVer Array of new objects.
SelectedItemsChangedRegisters event handler for the IShellListingEvents SelectedItemsChanged event.
This event is triggered when one or more of the items that are currently selected are modified.		shellItems Contains the selected items.
- - + + \ No newline at end of file diff --git a/Frameworks/User-Interface-Extensibility-Framework/Reference/UIExt2/Interfaces/IShellPaneContainer/AddTab/index.html b/Frameworks/User-Interface-Extensibility-Framework/Reference/UIExt2/Interfaces/IShellPaneContainer/AddTab/index.html index 1236d2dac..01fcdbf98 100644 --- a/Frameworks/User-Interface-Extensibility-Framework/Reference/UIExt2/Interfaces/IShellPaneContainer/AddTab/index.html +++ b/Frameworks/User-Interface-Extensibility-Framework/Reference/UIExt2/Interfaces/IShellPaneContainer/AddTab/index.html @@ -4,13 +4,13 @@ AddTab | M-Files User Interface Extensibility Framework - - + +
Skip to main content

AddTab

Description​

Creates a new tab and adds it to the collection of tabs.

Syntax​

// shellPaneContainer points to instance of IShellPaneContainer
const result = await shellPaneContainer.AddTab(
  tabId,
  tabTitle,
  insertBeforeTabId,
  icon,
);

Parameters​

NameOptionalityTypeDescription
tabIdRequiredstringThe id of the new tab.
tabTitleRequiredstringThe title of the new tab.
insertBeforeTabIdRequiredstringThe id of the tab before which the new tab should be inserted.
iconRequiredstringHeader tab image name.
Can refer to built-in tab or another custom-created tab. See Using Tabs
in Shell Frame Side Pane Tabs for a list of built-in tab identifiers.

Return type​

TypeDescription
Promise < null | IShellPaneTab >Returns the newly created tab, which is IShellPaneTab instance.

Exceptions​

ArgumentError - When tabId, tabTitle, or insertBeforeTabId is null or undefined.

- - + + \ No newline at end of file diff --git a/Frameworks/User-Interface-Extensibility-Framework/Reference/UIExt2/Interfaces/IShellPaneContainer/GetSelectedTabs/index.html b/Frameworks/User-Interface-Extensibility-Framework/Reference/UIExt2/Interfaces/IShellPaneContainer/GetSelectedTabs/index.html index 8b9d4bd99..4b1ce19d8 100644 --- a/Frameworks/User-Interface-Extensibility-Framework/Reference/UIExt2/Interfaces/IShellPaneContainer/GetSelectedTabs/index.html +++ b/Frameworks/User-Interface-Extensibility-Framework/Reference/UIExt2/Interfaces/IShellPaneContainer/GetSelectedTabs/index.html @@ -4,13 +4,13 @@ GetSelectedTabs | M-Files User Interface Extensibility Framework - - + +
Skip to main content
- - + + \ No newline at end of file diff --git a/Frameworks/User-Interface-Extensibility-Framework/Reference/UIExt2/Interfaces/IShellPaneContainer/GetTab/index.html b/Frameworks/User-Interface-Extensibility-Framework/Reference/UIExt2/Interfaces/IShellPaneContainer/GetTab/index.html index 6e5649583..e99b0b154 100644 --- a/Frameworks/User-Interface-Extensibility-Framework/Reference/UIExt2/Interfaces/IShellPaneContainer/GetTab/index.html +++ b/Frameworks/User-Interface-Extensibility-Framework/Reference/UIExt2/Interfaces/IShellPaneContainer/GetTab/index.html @@ -4,13 +4,13 @@ GetTab | M-Files User Interface Extensibility Framework - - + +
Skip to main content

GetTab

Description​

Gets the tab with the specified tab id.

Syntax​

// shellPaneContainer points to instance of IShellPaneContainer
const result = await shellPaneContainer.GetTab(tabId);

Parameters​

NameOptionalityTypeDescription
tabIdRequiredstringThe id of the tab to get. Can refer to built-in tab or another custom-created tab.
See Using Tabs in Shell Frame Side Pane Tabs for a list of built-in tab identifiers.

Return type​

TypeDescription
Promise < IShellPaneTab >Returns the tab with the specified tab id.

Exceptions​

ArgumentError - When tabId is null or undefined.

NotFoundError - When a tab with the specified tabId is not found.

- - + + \ No newline at end of file diff --git a/Frameworks/User-Interface-Extensibility-Framework/Reference/UIExt2/Interfaces/IShellPaneContainer/index.html b/Frameworks/User-Interface-Extensibility-Framework/Reference/UIExt2/Interfaces/IShellPaneContainer/index.html index 8fe7f2bb8..89199e8d9 100644 --- a/Frameworks/User-Interface-Extensibility-Framework/Reference/UIExt2/Interfaces/IShellPaneContainer/index.html +++ b/Frameworks/User-Interface-Extensibility-Framework/Reference/UIExt2/Interfaces/IShellPaneContainer/index.html @@ -4,13 +4,13 @@ IShellPaneContainer | M-Files User Interface Extensibility Framework - - + +
Skip to main content

IShellPaneContainer

Represents an area of the screen which is reserved for displaying the dashboards. Usually a property of IShellFrame

Properties​

NameTypeDescription
AvailablebooleanReturns a True / False if the panel is available.
EventsIShellPaneContainerEventsReturns the event registering interface for theIShellPaneContainer interface.
MinimizedbooleanGets the panel containers's Minimized status in the current context.
ShellFrameIShellFrameReturns a reference to the IShellFrame which owns this IShellPaneContainer.
SizenumberGets the panel containers's size in the current context.
VisiblebooleanGets or returns the panel container's visibility status in the current context.

Methods​

NameDescription
AddTabCreates a new tab and adds it to the collection of tabs.
GetSelectedTabsGets the selected (active) tabs.
GetTabGets the tab with the specified tab id.

Events​

EventDescriptionArguments
StopSent when the object turns to stopped state.
StartedSent when the object turns to started state.
- - + + \ No newline at end of file diff --git a/Frameworks/User-Interface-Extensibility-Framework/Reference/UIExt2/Interfaces/IShellPaneTab/Remove/index.html b/Frameworks/User-Interface-Extensibility-Framework/Reference/UIExt2/Interfaces/IShellPaneTab/Remove/index.html index b4a06d115..febb6bf84 100644 --- a/Frameworks/User-Interface-Extensibility-Framework/Reference/UIExt2/Interfaces/IShellPaneTab/Remove/index.html +++ b/Frameworks/User-Interface-Extensibility-Framework/Reference/UIExt2/Interfaces/IShellPaneTab/Remove/index.html @@ -4,13 +4,13 @@ Remove | M-Files User Interface Extensibility Framework - - + +
Skip to main content

Remove

Description​

Removes the tab.

Syntax​

// shellPaneTab points to instance of IShellPaneTab
await shellPaneTab.Remove();

Return type​

TypeDescription
Promise < void >Method does not return a value
- - + + \ No newline at end of file diff --git a/Frameworks/User-Interface-Extensibility-Framework/Reference/UIExt2/Interfaces/IShellPaneTab/Select/index.html b/Frameworks/User-Interface-Extensibility-Framework/Reference/UIExt2/Interfaces/IShellPaneTab/Select/index.html index 814a85a3f..09a91e08b 100644 --- a/Frameworks/User-Interface-Extensibility-Framework/Reference/UIExt2/Interfaces/IShellPaneTab/Select/index.html +++ b/Frameworks/User-Interface-Extensibility-Framework/Reference/UIExt2/Interfaces/IShellPaneTab/Select/index.html @@ -4,13 +4,13 @@ Select | M-Files User Interface Extensibility Framework - - + +
Skip to main content

Select

Description​

Requests the tab to be selected.

Syntax​

// shellPaneTab points to instance of IShellPaneTab
await shellPaneTab.Select();

Return type​

TypeDescription
Promise < void >Method does not return a value
- - + + \ No newline at end of file diff --git a/Frameworks/User-Interface-Extensibility-Framework/Reference/UIExt2/Interfaces/IShellPaneTab/SetVisible/index.html b/Frameworks/User-Interface-Extensibility-Framework/Reference/UIExt2/Interfaces/IShellPaneTab/SetVisible/index.html index 1f84ab7f5..4de628f8d 100644 --- a/Frameworks/User-Interface-Extensibility-Framework/Reference/UIExt2/Interfaces/IShellPaneTab/SetVisible/index.html +++ b/Frameworks/User-Interface-Extensibility-Framework/Reference/UIExt2/Interfaces/IShellPaneTab/SetVisible/index.html @@ -4,13 +4,13 @@ SetVisible | M-Files User Interface Extensibility Framework - - + +
Skip to main content

SetVisible

Description​

Set the tab visibility

Syntax​

// shellPaneTab points to instance of IShellPaneTab
await shellPaneTab.SetVisible(value);

Parameters​

NameOptionalityTypeDescription
valueRequiredbooleanVisibility value

Return type​

TypeDescription
Promise < void >Method does not return a value
- - + + \ No newline at end of file diff --git a/Frameworks/User-Interface-Extensibility-Framework/Reference/UIExt2/Interfaces/IShellPaneTab/ShowDashboard/index.html b/Frameworks/User-Interface-Extensibility-Framework/Reference/UIExt2/Interfaces/IShellPaneTab/ShowDashboard/index.html index eab2f4b10..0717878c7 100644 --- a/Frameworks/User-Interface-Extensibility-Framework/Reference/UIExt2/Interfaces/IShellPaneTab/ShowDashboard/index.html +++ b/Frameworks/User-Interface-Extensibility-Framework/Reference/UIExt2/Interfaces/IShellPaneTab/ShowDashboard/index.html @@ -4,13 +4,13 @@ ShowDashboard | M-Files User Interface Extensibility Framework - - + +
Skip to main content

ShowDashboard

Description​

Shows the specified dashboard in the tab.

Syntax​

// shellPaneTab points to instance of IShellPaneTab
const result = await shellPaneTab.ShowDashboard(dashboardID, data);

Parameters​

NameOptionalityTypeDescription
dashboardIDRequiredstringThe dashboard ID. The dashboard ID is
specified in the application definition file (appdef file).
dataRequiredanyData object to pass for the HTML code. The data object
shows as CustomDataProperty of the dashboard object.

Return type​

TypeDescription
Promise < null | IDashboard >Reference to the dashboard.

Exceptions​

ArgumentError - When dashboardID is null or undefined.

- - + + \ No newline at end of file diff --git a/Frameworks/User-Interface-Extensibility-Framework/Reference/UIExt2/Interfaces/IShellPaneTab/ShowEmptyContent/index.html b/Frameworks/User-Interface-Extensibility-Framework/Reference/UIExt2/Interfaces/IShellPaneTab/ShowEmptyContent/index.html index dd996ea21..079afe966 100644 --- a/Frameworks/User-Interface-Extensibility-Framework/Reference/UIExt2/Interfaces/IShellPaneTab/ShowEmptyContent/index.html +++ b/Frameworks/User-Interface-Extensibility-Framework/Reference/UIExt2/Interfaces/IShellPaneTab/ShowEmptyContent/index.html @@ -4,13 +4,13 @@ ShowEmptyContent | M-Files User Interface Extensibility Framework - - + +
Skip to main content

ShowEmptyContent

Description​

Clears the tab content area.

Syntax​

// shellPaneTab points to instance of IShellPaneTab
await shellPaneTab.ShowEmptyContent();

Return type​

TypeDescription
Promise < void >Method does not return a value
- - + + \ No newline at end of file diff --git a/Frameworks/User-Interface-Extensibility-Framework/Reference/UIExt2/Interfaces/IShellPaneTab/Unselect/index.html b/Frameworks/User-Interface-Extensibility-Framework/Reference/UIExt2/Interfaces/IShellPaneTab/Unselect/index.html index 997940cca..1f9bf8ecd 100644 --- a/Frameworks/User-Interface-Extensibility-Framework/Reference/UIExt2/Interfaces/IShellPaneTab/Unselect/index.html +++ b/Frameworks/User-Interface-Extensibility-Framework/Reference/UIExt2/Interfaces/IShellPaneTab/Unselect/index.html @@ -4,13 +4,13 @@ Unselect | M-Files User Interface Extensibility Framework - - + +
Skip to main content

Unselect

Description​

Requests the tab to be unselected.

Syntax​

// shellPaneTab points to instance of IShellPaneTab
const result = await shellPaneTab.Unselect();

Return type​

TypeDescription
Promise < boolean >Return True / False.
- - + + \ No newline at end of file diff --git a/Frameworks/User-Interface-Extensibility-Framework/Reference/UIExt2/Interfaces/IShellPaneTab/index.html b/Frameworks/User-Interface-Extensibility-Framework/Reference/UIExt2/Interfaces/IShellPaneTab/index.html index 9ad71cece..374315b51 100644 --- a/Frameworks/User-Interface-Extensibility-Framework/Reference/UIExt2/Interfaces/IShellPaneTab/index.html +++ b/Frameworks/User-Interface-Extensibility-Framework/Reference/UIExt2/Interfaces/IShellPaneTab/index.html @@ -4,14 +4,14 @@ IShellPaneTab | M-Files User Interface Extensibility Framework - - + +
Skip to main content

IShellPaneTab

Tabs can be accessed using IShellPaneContainer methods like AddTab or GetTab. Usually Tab is used to open a Dashboard

Properties​

NameTypeDescription
EventsIShellPaneTabEventsReturns event registering object for IShellPaneTab Interface - getter.
IsBuiltInbooleanResolves if the tab is a built-in tab - getter.
SelectedbooleanGets the tab selection state - getter.
TabIdstringGets the tab id - getter.
TitlestringGets the tab title - getter.

Methods​

NameDescription
RemoveRemoves the tab.
SelectRequests the tab to be selected.
SetVisibleSet the tab visibility
ShowDashboardShows the specified dashboard in the tab.
ShowEmptyContentClears the tab content area.
UnselectRequests the tab to be unselected.

Events​

EventDescriptionArguments
StartedSent when the object turns to started state.
StopSent before the object is stopped.
- - + + \ No newline at end of file diff --git a/Frameworks/User-Interface-Extensibility-Framework/Reference/UIExt2/Interfaces/IShellUI/BroadcastMessage/index.html b/Frameworks/User-Interface-Extensibility-Framework/Reference/UIExt2/Interfaces/IShellUI/BroadcastMessage/index.html index aefa03062..e16021b89 100644 --- a/Frameworks/User-Interface-Extensibility-Framework/Reference/UIExt2/Interfaces/IShellUI/BroadcastMessage/index.html +++ b/Frameworks/User-Interface-Extensibility-Framework/Reference/UIExt2/Interfaces/IShellUI/BroadcastMessage/index.html @@ -4,13 +4,13 @@ BroadcastMessage | M-Files User Interface Extensibility Framework - - + +
Skip to main content

BroadcastMessage

Description​

Sends a synchronous broadcast message to all shellUI modules of all applications running in the current shellUI (main-window).

Syntax​

// shellUI points to instance of IShellUI
await shellUI.BroadcastMessage(msgID, data);

Parameters​

NameOptionalityTypeDescription
msgIDRequiredstringThe broadcast message ID for the listeners.
dataRequiredanyThe broadcast payload data.

Return type​

TypeDescription
Promise < void >Method does not return a value

Exceptions​

ArgumentError - When msgID or data is null or undefined.

- - + + \ No newline at end of file diff --git a/Frameworks/User-Interface-Extensibility-Framework/Reference/UIExt2/Interfaces/IShellUI/GetFileTypeIconURL/index.html b/Frameworks/User-Interface-Extensibility-Framework/Reference/UIExt2/Interfaces/IShellUI/GetFileTypeIconURL/index.html index b063bfe9f..05df2217f 100644 --- a/Frameworks/User-Interface-Extensibility-Framework/Reference/UIExt2/Interfaces/IShellUI/GetFileTypeIconURL/index.html +++ b/Frameworks/User-Interface-Extensibility-Framework/Reference/UIExt2/Interfaces/IShellUI/GetFileTypeIconURL/index.html @@ -4,13 +4,13 @@ GetFileTypeIconURL | M-Files User Interface Extensibility Framework - - + +
Skip to main content

GetFileTypeIconURL

Description​

Returns the file type icon from the filename extension as data url.

Syntax​

// shellUI points to instance of IShellUI
const result = await shellUI.GetFileTypeIconURL(fileName);

Parameters​

NameOptionalityTypeDescription
fileNameRequiredstringName or extension of the file.

Return type​

TypeDescription
Promise < string >URL of the icon.
- - + + \ No newline at end of file diff --git a/Frameworks/User-Interface-Extensibility-Framework/Reference/UIExt2/Interfaces/IShellUI/GetObjectTypeIconURL/index.html b/Frameworks/User-Interface-Extensibility-Framework/Reference/UIExt2/Interfaces/IShellUI/GetObjectTypeIconURL/index.html index d02dd24a6..0bc65976c 100644 --- a/Frameworks/User-Interface-Extensibility-Framework/Reference/UIExt2/Interfaces/IShellUI/GetObjectTypeIconURL/index.html +++ b/Frameworks/User-Interface-Extensibility-Framework/Reference/UIExt2/Interfaces/IShellUI/GetObjectTypeIconURL/index.html @@ -4,13 +4,13 @@ GetObjectTypeIconURL | M-Files User Interface Extensibility Framework - - + +
Skip to main content

GetObjectTypeIconURL

Description​

Gets the URL of the icon for the specified object type.

Syntax​

// shellUI points to instance of IShellUI
const result = await shellUI.GetObjectTypeIconURL(objtype);

Parameters​

NameOptionalityTypeDescription
objtypeRequirednumberObject type ID.

Return type​

TypeDescription
Promise < string >the icon URL.

Exceptions​

ArgumentError - When objtype is null or undefined.

- - + + \ No newline at end of file diff --git a/Frameworks/User-Interface-Extensibility-Framework/Reference/UIExt2/Interfaces/IShellUI/GetValueListItemIconURL/index.html b/Frameworks/User-Interface-Extensibility-Framework/Reference/UIExt2/Interfaces/IShellUI/GetValueListItemIconURL/index.html index e72115145..ed2ed0228 100644 --- a/Frameworks/User-Interface-Extensibility-Framework/Reference/UIExt2/Interfaces/IShellUI/GetValueListItemIconURL/index.html +++ b/Frameworks/User-Interface-Extensibility-Framework/Reference/UIExt2/Interfaces/IShellUI/GetValueListItemIconURL/index.html @@ -4,13 +4,13 @@ GetValueListItemIconURL | M-Files User Interface Extensibility Framework - - + +
Skip to main content

GetValueListItemIconURL

Description​

Retrieves the URL of the icon associated with a specific value list item.

Syntax​

// shellUI points to instance of IShellUI
const result = await shellUI.GetValueListItemIconURL(valuelist, valuelistItem);

Parameters​

NameOptionalityTypeDescription
valuelistRequirednumberThe ID of the value list.
valuelistItemRequirednumberThe ID of the value list item.

Return type​

TypeDescription
Promise < string >A promise that resolves to the icon URL if the item has an icon; otherwise, an empty string.

Exceptions​

ArgumentError - When valuelist or valuelistItem is null or undefined.

NotFoundError - When the specified value list item is not found.

- - + + \ No newline at end of file diff --git a/Frameworks/User-Interface-Extensibility-Framework/Reference/UIExt2/Interfaces/IShellUI/NotifyApplication/index.html b/Frameworks/User-Interface-Extensibility-Framework/Reference/UIExt2/Interfaces/IShellUI/NotifyApplication/index.html index dab80357d..2741a92ff 100644 --- a/Frameworks/User-Interface-Extensibility-Framework/Reference/UIExt2/Interfaces/IShellUI/NotifyApplication/index.html +++ b/Frameworks/User-Interface-Extensibility-Framework/Reference/UIExt2/Interfaces/IShellUI/NotifyApplication/index.html @@ -4,13 +4,13 @@ NotifyApplication | M-Files User Interface Extensibility Framework - - + +
Skip to main content

NotifyApplication

Description​

Sends a synchronous notification message to all shellUI modules of a specific application running in the current shellUI (main-window).

Syntax​

// shellUI points to instance of IShellUI
await shellUI.NotifyApplication(appGUID, msgID, data);

Parameters​

NameOptionalityTypeDescription
appGUIDRequiredstringThe target application to broadcast the message to
msgIDRequiredstringThe broadcast message ID for the listeners.
dataRequiredanyThe broadcast payload data.

Return type​

TypeDescription
Promise < void >Method does not return a value

Exceptions​

ArgumentError - When appGUID, msgID, or data is null or undefined, or when appGUID is invalid.

- - + + \ No newline at end of file diff --git a/Frameworks/User-Interface-Extensibility-Framework/Reference/UIExt2/Interfaces/IShellUI/ShowMessage/index.html b/Frameworks/User-Interface-Extensibility-Framework/Reference/UIExt2/Interfaces/IShellUI/ShowMessage/index.html index 013af43d1..c71e590e3 100644 --- a/Frameworks/User-Interface-Extensibility-Framework/Reference/UIExt2/Interfaces/IShellUI/ShowMessage/index.html +++ b/Frameworks/User-Interface-Extensibility-Framework/Reference/UIExt2/Interfaces/IShellUI/ShowMessage/index.html @@ -4,13 +4,13 @@ ShowMessage | M-Files User Interface Extensibility Framework - - + +
Skip to main content

ShowMessage

Description​

Shows the default M-Files message box with the specified content and appearance.

Syntax​

// shellUI points to instance of IShellUI
const result = await shellUI.ShowMessage(message);

Parameters​

NameOptionalityTypeDescription
messageRequiredstring | ShowMessageParamsMessage content to show.
String Type: The message to display. The message box contains single Ok button.
Object Type: - Defines the message box content and buttons.

Return type​

TypeDescription
Promise < ShowMessageReturnValue >Returns the result of the button clicked by the user.

Exceptions​

ArgumentError - When message is null or undefined.

- - + + \ No newline at end of file diff --git a/Frameworks/User-Interface-Extensibility-Framework/Reference/UIExt2/Interfaces/IShellUI/ShowPopupDashboard/index.html b/Frameworks/User-Interface-Extensibility-Framework/Reference/UIExt2/Interfaces/IShellUI/ShowPopupDashboard/index.html index a973d9021..1aed1481d 100644 --- a/Frameworks/User-Interface-Extensibility-Framework/Reference/UIExt2/Interfaces/IShellUI/ShowPopupDashboard/index.html +++ b/Frameworks/User-Interface-Extensibility-Framework/Reference/UIExt2/Interfaces/IShellUI/ShowPopupDashboard/index.html @@ -4,13 +4,13 @@ ShowPopupDashboard | M-Files User Interface Extensibility Framework - - + +
Skip to main content

ShowPopupDashboard

Description​

Shows a dashboard in a separate window.

Syntax​

// shellUI points to instance of IShellUI
const result = await shellUI.ShowPopupDashboard(
  dashboardID,
  data,
  titleOrOptions,
);

Parameters​

NameOptionalityTypeDescription
dashboardIDRequiredstringThe id of the dashboard to show. The string id must match to one of the
dashboard ids in the application definition file (appdef file).
dataRequiredanyUser-defined data item that is passed to the new dashboard.
titleOrOptionsRequiredstring | DialogUIParamsTitle and UI options of the dashboard.
String Type: Defines the title of the dashboard.
Object Type: Defines the title and other UI options [Eg: title/isModal/isResizable/isDraggable].

Return type​

TypeDescription
Promise < IDashboard >The popup dashboard.

Exceptions​

ArgumentError - When dashboardID is null or undefined.

- - + + \ No newline at end of file diff --git a/Frameworks/User-Interface-Extensibility-Framework/Reference/UIExt2/Interfaces/IShellUI/index.html b/Frameworks/User-Interface-Extensibility-Framework/Reference/UIExt2/Interfaces/IShellUI/index.html index a20a61abe..d669171a4 100644 --- a/Frameworks/User-Interface-Extensibility-Framework/Reference/UIExt2/Interfaces/IShellUI/index.html +++ b/Frameworks/User-Interface-Extensibility-Framework/Reference/UIExt2/Interfaces/IShellUI/index.html @@ -4,13 +4,13 @@ IShellUI | M-Files User Interface Extensibility Framework - - + +
Skip to main content

IShellUI

The IShellUI is available for the Modules on the module startup event

The IShellUI is available for the Dashboards from the ShellFrame property of the IDashboard.

Properties​

NameTypeDescription
EventsIShellUIEventsReturns the event registering interface of the IShellUI interface.
VaultIVaultReturns the logged-in M-Files server connection.

Methods​

NameDescription
BroadcastMessageSends a synchronous broadcast message to all shellUI modules of all applications running in the current shellUI (main-window).
GetFileTypeIconURLReturns the file type icon from the filename extension as data url.
GetObjectTypeIconURLGets the URL of the icon for the specified object type.
GetValueListItemIconURLRetrieves the URL of the icon associated with a specific value list item.
NotifyApplicationSends a synchronous notification message to all shellUI modules of a specific application running in the current shellUI (main-window).
ShowMessageShows the default M-Files message box with the specified content and appearance.
ShowPopupDashboardShows a dashboard in a separate window.

Events​

EventDescriptionArguments
StartedSent when the object turns to started state.
StopSent when the application is stopping.
NewShellFrameTriggered when any shell frame object is created, including normal shell frames, common dialogs, and embedded or special shell frames.shellFrame - The new shell frame object.
NewNormalShellFrameTriggered when a normal shell frame object is created.
Note that this event is not triggered for common dialogs, or embedded or special shell frames.		shellFrame - The new shell frame object.
CrossApplicationNotificationBroadcasted message to multiple applications.appGUID - GUID of the target application, or null if broadcasted to all applications.
msgId - ID of the message which is sent to the other applications.
data - Custom data to be sent.
CheckInObjectsTriggered when the check in of one or more vault objects is requested.
This event occurs before the request is passed to M-Files Server.

Return a promise that resolves true to proceed, or Error object/false to cancel the operation.
When resolving with an Error object, its message will be shown to the user, enabling you to provide a custom explanation for why the operation was stopped.		objVers - The object versions being checked in.
properties - The properties to add/replace during check-in.
options - Flags that control the operation.
ObjectsCheckedInTriggered after the request to check in one or more vault objects succeeded on M-Files Server.checkedInObjects - The extended object info for checked-in objects.
CheckOutObjectsTriggered when the checking out of one or more vault objects is requested.
This event occurs before the request is passed to M-Files Server.

Return a promise that resolves true to proceed, or Error object/false to cancel the operation.
When resolving with an Error object, its message will be shown to the user, enabling you to provide a custom explanation for why the operation was stopped.		objIds - The objects being checked out.
ObjectsCheckedOutTriggered after the request to check out one or more vault objects succeeded on M-Files Server.checkedOutVersions - The new checked-out object versions with properties and ACL.
previousVersions - The previous versions before checkout.
UndoObjectCheckoutsTriggered when the undoing checkout of one or more vault objects is requested.
This event occurs before the request is passed to M-Files Server.

Return a promise that resolves true to proceed, or Error object/false to cancel the operation.
When resolving with an Error object, its message will be shown to the user, enabling you to provide a custom explanation for why the operation was stopped.		objVers - The checked-out object versions being reverted.
force - If true, undo checkout is performed even if not checked out to the caller.
ObjectCheckoutsUndoneTriggered after the request to undo checkout of one or more vault objects succeeded on M-Files Server.restoredObjects - The extended object info for restored objects.
DestroyObjectsTriggered when the destruction of one or more vault objects is requested.
This event occurs before the request is passed to M-Files Server.

Return a promise that resolves true to proceed, or Error object/false to cancel the operation.
When resolving with an Error object, its message will be shown to the user, enabling you to provide a custom explanation for why the operation was stopped.		objIds - The objects being permanently destroyed.
ObjectsDestroyedTriggered after the request to destroy one or more vault objects succeeded on M-Files Server.

NOTE: Stability is experimental. Non-backward compatible changes or removal may occur in any future release. Use of this feature is not recommended for production environments.		updatedObjects - Information about objects that were also updated during the operation.
DestroyObjectVersionsTriggered when the destruction of one or more object versions is requested.
This event occurs before the request is passed to M-Files Server.

Return a promise that resolves true to proceed, or Error object/false to cancel the operation.
When resolving with an Error object, its message will be shown to the user, enabling you to provide a custom explanation for why the operation was stopped.

NOTE: Stability is experimental. Non-backward compatible changes or removal may occur in any future release. Use of this feature is not recommended for production environments.		objVers - The object versions being permanently destroyed.
ObjectVersionsDestroyedTriggered after the request to destroy one or more object versions succeeded on M-Files Server.

NOTE: Stability is experimental. Non-backward compatible changes or removal may occur in any future release. Use of this feature is not recommended for production environments.		updatedObjects - Information about objects that were also updated during the operation.
RemoveObjectsTriggered when the deletion of one or more vault objects is requested.
This event occurs before the request is passed to M-Files Server.

Return a promise that resolves true to proceed, or Error object/false to cancel the operation.
When resolving with an Error object, its message will be shown to the user, enabling you to provide a custom explanation for why the operation was stopped.		objIds - The objects being deleted.
ObjectsRemovedTriggered after the request to delete one or more vault objects succeeded on M-Files Server.deletedObjects - The extended object info for deleted objects.
UndeleteObjectsTriggered when the undeletion of one or more vault objects is requested.
This event occurs before the request is passed to M-Files Server.

Return a promise that resolves true to proceed, or Error object/false to cancel the operation.
When resolving with an Error object, its message will be shown to the user, enabling you to provide a custom explanation for why the operation was stopped.

NOTE: Stability is experimental. Non-backward compatible changes or removal may occur in any future release. Use of this feature is not recommended for production environments.		objIds - The objects being restored from deletion.
ObjectsUndeletedTriggered after the request to undelete one or more vault objects succeeded on M-Files Server.

NOTE: Stability is experimental. Non-backward compatible changes or removal may occur in any future release. Use of this feature is not recommended for production environments.		extObjectInfos - The extended object info for undeleted objects.
RemoveObjectFileTriggered when the removal of a file from an object version is requested.
This event occurs before the request is passed to M-Files Server.

Return a promise that resolves true to proceed, or Error object/false to cancel the operation.
When resolving with an Error object, its message will be shown to the user, enabling you to provide a custom explanation for why the operation was stopped.		objVer - The object version from which the file is being removed.
fileVer - The file being removed.
ObjectFileRemovedTriggered after a request to remove an object file from an object version succeeds on M-Files Server.objectVersion - Information about the latest version of the document after the operation.
RollBackObjectVersionTriggered when the roll back of a previous vault object version is requested.
This event occurs before the request is passed to M-Files Server.

Return a promise that resolves true to proceed, or Error object/false to cancel the operation.
When resolving with an Error object, its message will be shown to the user, enabling you to provide a custom explanation for why the operation was stopped.

NOTE: Stability is experimental. Non-backward compatible changes or removal may occur in any future release. Use of this feature is not recommended for production environments.		objId - The object to roll back.
rollbackVersion - The version to roll back to. A new version is created using this as source.
ObjectVersionRolledBackTriggered after a request to roll back a previous vault object version succeeds on M-Files Server.

NOTE: Stability is experimental. Non-backward compatible changes or removal may occur in any future release. Use of this feature is not recommended for production environments.		extObjectInfo - Information about the object after the operation.
CreateObjectTriggered when the creation of a new object is requested.
This event occurs before the request is passed to M-Files Server.

Return a promise that resolves true to proceed, or Error object/false to cancel the operation.
When resolving with an Error object, its message will be shown to the user, enabling you to provide a custom explanation for why the operation was stopped.		objectTypeId - The object type ID for the new object.
properties - The properties for the new object.
acl - The access control list for the new object.
options - Flags that control the operation.
checkIn - If true, the object is checked in immediately after creation.
objFileSources - The file sources for the new object.
ObjectCreatedTriggered after the request to create a new object succeeded on M-Files Server.isVisibleToUser - True if the created object is visible to the user.
createdObject - The created object with properties and ACL.
AddObjectFileTriggered when the addition of a new file to a document is requested.
This event occurs before the request is passed to M-Files Server.

Return a promise that resolves true to proceed, or Error object/false to cancel the operation.
When resolving with an Error object, its message will be shown to the user, enabling you to provide a custom explanation for why the operation was stopped.		objVer - The object version to which the file is being added.
title - The title of the new file.
extension - The file extension (without the leading dot).
createdAtUtc - The UTC timestamp when the file was originally created.
accessedAtUtc - The UTC timestamp when the file was last accessed.
writtenAtUtc - The UTC timestamp when the file was last written to.
changedAtUtc - The UTC timestamp when the file was last changed (content or attributes).
ObjectFileAddedTriggered after a request to add a file to a document succeeds on M-Files Server.fileVer - The version information of the added file.
objectVersion - The object version after the file was added.
RenameObjectFileTriggered when the renaming of a file in a document is requested.
This event occurs before the request is passed to M-Files Server.

Return a promise that resolves true to proceed, or Error object/false to cancel the operation.
When resolving with an Error object, its message will be shown to the user, enabling you to provide a custom explanation for why the operation was stopped.		objVer - The object version containing the file.
fileVer - The file being renamed.
title - The new title for the file.
extension - The new extension for the file (without the leading dot).
ObjectFileRenamedTriggered after a request to rename a file in a document succeeds on M-Files Server.objectVersion - The object version after the file was renamed.
SetPropertiesOfObjectVersionsTriggered when setting properties for one or more object versions is requested.
This event occurs before the request is passed to M-Files Server.

Return a promise that resolves true to proceed, or Error object/false to cancel the operation.
When resolving with an Error object, its message will be shown to the user, enabling you to provide a custom explanation for why the operation was stopped.		setPropertiesParams - Array of parameters for setting properties on multiple objects.
PropertiesOfObjectVersionsSetTriggered after a request to set properties of one or more object versions succeeds on M-Files Server.extObjectInfos - Extended object info for each object after the properties were set.
SetObjectVersionPermissionsTriggered when changing the permissions of an object version is requested.
This event occurs before the request is passed to M-Files Server.

Return a promise that resolves true to proceed, or Error object/false to cancel the operation.
When resolving with an Error object, its message will be shown to the user, enabling you to provide a custom explanation for why the operation was stopped.		objVer - The object version whose permissions are being changed.
acl - The new access control list.
options - Flags that control the operation.
ObjectVersionPermissionsSetTriggered after a request to change the permissions of an object version succeeds on M-Files Server.isSpecifiedVersionStillVisible - True if the specified version is still visible after the operation.
specifiedVersion - Information about the specified version after the operation.
extObjectInfo - Extended object info after the operation.
SetObjectLevelPropertyTriggered when setting an object-level property is requested.
This event occurs before the request is passed to M-Files Server.

Return a promise that resolves true to proceed, or Error object/false to cancel the operation.
When resolving with an Error object, its message will be shown to the user, enabling you to provide a custom explanation for why the operation was stopped.		objId - The object whose property is being set.
property - The property value to set.
options - Flags that control the operation.
ObjectLevelPropertySetTriggered after a request to set an object-level property succeeds on M-Files Server.extObjectInfo - Extended object info after the operation.
ModifyObjectVersionLabelsTriggered when modifying the labels of an object version is requested.
This event occurs before the request is passed to M-Files Server.

Return a promise that resolves true to proceed, or Error object/false to cancel the operation.
When resolving with an Error object, its message will be shown to the user, enabling you to provide a custom explanation for why the operation was stopped.

NOTE: Stability is experimental. Non-backward compatible changes or removal may occur in any future release. Use of this feature is not recommended for production environments.		objVer - The object version whose labels are being modified.
clearFromOtherVersions - If true, the specified labels are cleared from other versions.
append - If true, the labels are appended to existing labels; if false, existing labels are replaced.
labelIDs - The IDs of the labels to set.
ObjectVersionLabelsModifiedTriggered after a request to modify the labels of an object version succeeds on M-Files Server.

NOTE: Stability is experimental. Non-backward compatible changes or removal may occur in any future release. Use of this feature is not recommended for production environments.		objVer - The object version whose labels were modified.
clearFromOtherVersions - If true, the specified labels were cleared from other versions.
append - If true, the labels were appended to existing labels.
labelIDs - The IDs of the labels that were set.
ChangeVaultLanguageTriggered when changing the vault language is requested.
This event occurs before the request is passed to M-Files Server.

NOTE: Stability is experimental. Non-backward compatible changes or removal may occur in any future release. Use of this feature is not recommended for production environments.		languageId - The ID of the new vault language.
VaultLanguageChangedTriggered after the vault language has been changed.

NOTE: Stability is experimental. Non-backward compatible changes or removal may occur in any future release. Use of this feature is not recommended for production environments.		languageId - The ID of the new vault language.
LogOutTriggered when logging out of the vault is requested.
This event occurs before the logout is processed.

NOTE: Stability is experimental. Non-backward compatible changes or removal may occur in any future release. Use of this feature is not recommended for production environments.
- - + + \ No newline at end of file diff --git a/Frameworks/User-Interface-Extensibility-Framework/Reference/UIExt2/Interfaces/IWindow/Close/index.html b/Frameworks/User-Interface-Extensibility-Framework/Reference/UIExt2/Interfaces/IWindow/Close/index.html index 954e13e94..21b8c3019 100644 --- a/Frameworks/User-Interface-Extensibility-Framework/Reference/UIExt2/Interfaces/IWindow/Close/index.html +++ b/Frameworks/User-Interface-Extensibility-Framework/Reference/UIExt2/Interfaces/IWindow/Close/index.html @@ -4,13 +4,13 @@ Close | M-Files User Interface Extensibility Framework - - + +
Skip to main content

Close

Description​

Closes the window. The close event is sent before the window is closed.

Syntax​

// window points to instance of IWindow
await window.Close();

Return type​

TypeDescription
Promise < void >Method does not return a value
- - + + \ No newline at end of file diff --git a/Frameworks/User-Interface-Extensibility-Framework/Reference/UIExt2/Interfaces/IWindow/ResizeToDefaultSize/index.html b/Frameworks/User-Interface-Extensibility-Framework/Reference/UIExt2/Interfaces/IWindow/ResizeToDefaultSize/index.html index bf3e3ab24..4e7808e92 100644 --- a/Frameworks/User-Interface-Extensibility-Framework/Reference/UIExt2/Interfaces/IWindow/ResizeToDefaultSize/index.html +++ b/Frameworks/User-Interface-Extensibility-Framework/Reference/UIExt2/Interfaces/IWindow/ResizeToDefaultSize/index.html @@ -4,13 +4,13 @@ ResizeToDefaultSize | M-Files User Interface Extensibility Framework - - + +
Skip to main content

ResizeToDefaultSize

Description​

Resize the window to the default size.

Syntax​

// window points to instance of IWindow
await window.ResizeToDefaultSize();

Return type​

TypeDescription
Promise < void >Method does not return a value
- - + + \ No newline at end of file diff --git a/Frameworks/User-Interface-Extensibility-Framework/Reference/UIExt2/Interfaces/IWindow/SetCloseIconVisibility/index.html b/Frameworks/User-Interface-Extensibility-Framework/Reference/UIExt2/Interfaces/IWindow/SetCloseIconVisibility/index.html index 48b452ac9..6b8fa49be 100644 --- a/Frameworks/User-Interface-Extensibility-Framework/Reference/UIExt2/Interfaces/IWindow/SetCloseIconVisibility/index.html +++ b/Frameworks/User-Interface-Extensibility-Framework/Reference/UIExt2/Interfaces/IWindow/SetCloseIconVisibility/index.html @@ -4,13 +4,13 @@ SetCloseIconVisibility | M-Files User Interface Extensibility Framework - - + +
Skip to main content

SetCloseIconVisibility

Description​

Sets the visibility of the Close button in the Window.

Syntax​

// window points to instance of IWindow
await window.SetCloseIconVisibility(visible);

Parameters​

NameOptionalityTypeDescription
visibleRequiredbooleanThe visibility of the close icon.

Return type​

TypeDescription
Promise < void >Method does not return a value

Exceptions​

ArgumentError - When visible is null or undefined.

- - + + \ No newline at end of file diff --git a/Frameworks/User-Interface-Extensibility-Framework/Reference/UIExt2/Interfaces/IWindow/SetDefaultSize/index.html b/Frameworks/User-Interface-Extensibility-Framework/Reference/UIExt2/Interfaces/IWindow/SetDefaultSize/index.html index 8faa28c58..1fb6a1737 100644 --- a/Frameworks/User-Interface-Extensibility-Framework/Reference/UIExt2/Interfaces/IWindow/SetDefaultSize/index.html +++ b/Frameworks/User-Interface-Extensibility-Framework/Reference/UIExt2/Interfaces/IWindow/SetDefaultSize/index.html @@ -4,13 +4,13 @@ SetDefaultSize | M-Files User Interface Extensibility Framework - - + +
Skip to main content

SetDefaultSize

Description​

Sets the default size of the window.

Syntax​

// window points to instance of IWindow
await window.SetDefaultSize(width, height, resizeToDefault);

Parameters​

NameOptionalityTypeDescription
widthRequirednumberThe default width size of the dialog.
heightRequirednumberThe default height dialog.
resizeToDefaultRequiredbooleanSpecify true to resize the window to the given default size.
If false, the default width and height are kept but resizing to these value is not done. By calling
ResizeToDefaultSize(), the window is resized to default width and height values.

Return type​

TypeDescription
Promise < void >Method does not return a value

Exceptions​

ArgumentError - When width or height is null or undefined or outside valid window bounds.

- - + + \ No newline at end of file diff --git a/Frameworks/User-Interface-Extensibility-Framework/Reference/UIExt2/Interfaces/IWindow/SetSize/index.html b/Frameworks/User-Interface-Extensibility-Framework/Reference/UIExt2/Interfaces/IWindow/SetSize/index.html index 5b0c88d35..1a2d0d1ca 100644 --- a/Frameworks/User-Interface-Extensibility-Framework/Reference/UIExt2/Interfaces/IWindow/SetSize/index.html +++ b/Frameworks/User-Interface-Extensibility-Framework/Reference/UIExt2/Interfaces/IWindow/SetSize/index.html @@ -4,13 +4,13 @@ SetSize | M-Files User Interface Extensibility Framework - - + +
Skip to main content

SetSize

Description​

Sets width and height of window

Syntax​

// window points to instance of IWindow
await window.SetSize(width, height);

Parameters​

NameOptionalityTypeDescription
widthRequirednumberNew width of window
heightRequirednumberNew height of window

Return type​

TypeDescription
Promise < void >Method does not return a value

Exceptions​

ArgumentError - When width or height is null or undefined or outside valid window bounds.

- - + + \ No newline at end of file diff --git a/Frameworks/User-Interface-Extensibility-Framework/Reference/UIExt2/Interfaces/IWindow/SetTitle/index.html b/Frameworks/User-Interface-Extensibility-Framework/Reference/UIExt2/Interfaces/IWindow/SetTitle/index.html index 9ea985c77..9359d37e2 100644 --- a/Frameworks/User-Interface-Extensibility-Framework/Reference/UIExt2/Interfaces/IWindow/SetTitle/index.html +++ b/Frameworks/User-Interface-Extensibility-Framework/Reference/UIExt2/Interfaces/IWindow/SetTitle/index.html @@ -4,13 +4,13 @@ SetTitle | M-Files User Interface Extensibility Framework - - + +
Skip to main content

SetTitle

Description​

Sets title of window

Syntax​

// window points to instance of IWindow
await window.SetTitle(title);

Parameters​

NameOptionalityTypeDescription
titleRequiredstringNew title of window

Return type​

TypeDescription
Promise < void >Method does not return a value

Exceptions​

ArgumentError - When title is null or undefined.

- - + + \ No newline at end of file diff --git a/Frameworks/User-Interface-Extensibility-Framework/Reference/UIExt2/Interfaces/IWindow/index.html b/Frameworks/User-Interface-Extensibility-Framework/Reference/UIExt2/Interfaces/IWindow/index.html index 6f1cedf30..605fc8bf0 100644 --- a/Frameworks/User-Interface-Extensibility-Framework/Reference/UIExt2/Interfaces/IWindow/index.html +++ b/Frameworks/User-Interface-Extensibility-Framework/Reference/UIExt2/Interfaces/IWindow/index.html @@ -4,13 +4,13 @@ IWindow | M-Files User Interface Extensibility Framework - - + +
Skip to main content

IWindow

Instance of IWindow is found from Window property of IDashboard when the dashboard is created as a popup dashboard

Properties​

NameTypeDescription
EventsIWindowEventsReturns the event registering interface for the IWindow interface.

Methods​

NameDescription
CloseCloses the window. The close event is sent before the window is closed.
ResizeToDefaultSizeResize the window to the default size.
SetCloseIconVisibilitySets the visibility of the Close button in the Window.
SetDefaultSizeSets the default size of the window.
SetSizeSets width and height of window
SetTitleSets title of window

Events​

EventDescriptionArguments
CloseWindowSent when the window is requested to closed.
- - + + \ No newline at end of file diff --git a/Frameworks/User-Interface-Extensibility-Framework/Reference/UIExt2/Interfaces/TListingActionArgs/index.html b/Frameworks/User-Interface-Extensibility-Framework/Reference/UIExt2/Interfaces/TListingActionArgs/index.html index 671bd73ca..6d06e1f76 100644 --- a/Frameworks/User-Interface-Extensibility-Framework/Reference/UIExt2/Interfaces/TListingActionArgs/index.html +++ b/Frameworks/User-Interface-Extensibility-Framework/Reference/UIExt2/Interfaces/TListingActionArgs/index.html @@ -4,16 +4,16 @@ TListingActionArgs | M-Files User Interface Extensibility Framework - - + +
Skip to main content

TListingActionArgs

Context data for event subscribers when the modification was triggered by a known caller (e.g. createRelationship). Subscribers use it to react with context the listing itself does not know — for example, to expand the new relationship's group on -the source row after a refresh.

Properties​

NameTypeOptionalDescription
relationshipPropertyDefIdnumberNo
- - +the source row after a refresh.

Properties​

NameTypeOptionalDescription
relationshipPropertyDefIdnumberNoThe multi-select lookup property whose newly-added items should be revealed — a
relationship property (relationship drops) or the collection-member property
(add-to-collection drops). The listing diffs this property to find what was added and
resolves the group to expand by object identity, so it is agnostic to the group type.
expansionAnchorRowIdstringYesExplicit drop-target row id to anchor the auto-expansion on, independent of the current
listing selection. Set on the drag-and-drop path only (selection there reflects the
dragged objects, not the drop target). When absent (e.g. the context-menu path), the
listing falls back to resolving the anchor from the current selection.
+ + \ No newline at end of file diff --git a/Frameworks/User-Interface-Extensibility-Framework/Reference/UIExt2/Interfaces/index.html b/Frameworks/User-Interface-Extensibility-Framework/Reference/UIExt2/Interfaces/index.html index 91d97e423..e191ee76d 100644 --- a/Frameworks/User-Interface-Extensibility-Framework/Reference/UIExt2/Interfaces/index.html +++ b/Frameworks/User-Interface-Extensibility-Framework/Reference/UIExt2/Interfaces/index.html @@ -4,13 +4,13 @@ Interfaces | M-Files User Interface Extensibility Framework - - + +
Skip to main content

Interfaces

NameDescription
ICommandsICommands interface provides methods for managing user defined (custom) commands.
ICommonFunctionsICommonFunctions interface provides helper methods for M-Files API object creation, error handling and data persistency. This interface is accessible directly through the MFiles variable.
IDashboardIDashboard interface can be used from the dashboard's implementation. It enables access to the parent object and the underlying window. Also the access to the custom data that was passed to the dashboard when it was opened is provided.
IEventsIEvents interface allows explicit event handler registrations to be made. The alternative is to use the implicit mechanism by implementing the event handlers with pre-defined names e.g. Started -> OnStarted, Stop -> OnStop etc.
ISearchPaneISearchPane interface provides means to manage search pane visibility and to query its availability.
IShellFrameThe IShellFrame is the central interface that models the whole M-Files Shell. It provides access to all the other UI parts: listing, side panes, and search pane. It enables access to the custom commands creation interface.
IShellItemsIShellItems is an interface for accessing the content of M-Files Shell listing items. The set of all items currently visible in the listing are represented as an IShellItems as well as the set of currently selected items.
IShellListingThe IShellListing interface enables managing the listing in M-Files Shell. The items in the listing as well as the selection can be tracked and modified.
IShellPaneContainerIShellPaneContainer is a common interface for the embedded bottom pane and rightpane. The interface enables managing the pane content, size and visibility.
IShellPaneTabAn interface for managing a shell pane tab.
IShellUIThe IShellUI interface corresponds to the Windows Explorer window. It outlives the IShellFrame instances that get destroyed and re-created every time the folder or view is changed. IShellUI makes it possible to control the Windows explorer window, to show message boxes and dashboards so that the dashboards' parent object is not invalidated when navigating to a different view in the M-Files.
IWindowIWindow interface makes it possible to control dashboard's outer window objectwhen it has been opened as a popup.
TListingActionArgsContext data for event subscribers when the modification was triggered by a known caller (e.g. createRelationship). Subscribers use it to react with context the listing itself does not know — for example, to expand the new relationship's group on the source row after a refresh.
- - + + \ No newline at end of file diff --git a/Frameworks/User-Interface-Extensibility-Framework/Reference/UIExt2/Models/DashboardConfig/index.html b/Frameworks/User-Interface-Extensibility-Framework/Reference/UIExt2/Models/DashboardConfig/index.html index 12ffd8a62..ffc91c110 100644 --- a/Frameworks/User-Interface-Extensibility-Framework/Reference/UIExt2/Models/DashboardConfig/index.html +++ b/Frameworks/User-Interface-Extensibility-Framework/Reference/UIExt2/Models/DashboardConfig/index.html @@ -4,13 +4,13 @@ DashboardConfig | M-Files User Interface Extensibility Framework - - + +
Skip to main content

DashboardConfig

Description​

Data structure for popup dashboard configuration.

NOTE: Stability is experimental. Non-backward compatible changes or removal may occur in any future release. Use of this feature is not recommended for production environments.

Properties​

NameTypeDescription
dashboardIDstringThe ID of the dashboard to show.
dataanyCustom data passed to the dashboard.
- - + + \ No newline at end of file diff --git a/Frameworks/User-Interface-Extensibility-Framework/Reference/UIExt2/Models/DialogUIParams/index.html b/Frameworks/User-Interface-Extensibility-Framework/Reference/UIExt2/Models/DialogUIParams/index.html index 6d8b0a705..63fa04274 100644 --- a/Frameworks/User-Interface-Extensibility-Framework/Reference/UIExt2/Models/DialogUIParams/index.html +++ b/Frameworks/User-Interface-Extensibility-Framework/Reference/UIExt2/Models/DialogUIParams/index.html @@ -4,13 +4,13 @@ DialogUIParams | M-Files User Interface Extensibility Framework - - + +
Skip to main content

DialogUIParams

Description​

Data structure for show popup dashboard UI params.

Properties​

NameTypeDescription
hasCloseButtonbooleanSet close button visibility for the dialog.
isDraggablebooleanSet draggable state for the dialog.
isModalbooleanSet modal state for the dialog.
isResizablebooleanSet resizable state for the dialog.
titlestringTitle to show.
- - + + \ No newline at end of file diff --git a/Frameworks/User-Interface-Extensibility-Framework/Reference/UIExt2/Models/Facet/index.html b/Frameworks/User-Interface-Extensibility-Framework/Reference/UIExt2/Models/Facet/index.html index 5c7697bd2..e2b4b588c 100644 --- a/Frameworks/User-Interface-Extensibility-Framework/Reference/UIExt2/Models/Facet/index.html +++ b/Frameworks/User-Interface-Extensibility-Framework/Reference/UIExt2/Models/Facet/index.html @@ -4,13 +4,13 @@ Facet | M-Files User Interface Extensibility Framework - - + +
Skip to main content

Facet

Description​

Search Facet.

Properties​

NameTypeDescription
definitionFacetDefinitionFacet definition.
displayNamestringDisplay name of the facet.
expandedbooleanExpansion status of the facet.
sortedbooleanSorting status of the facet.
valuesArray < FacetValue >Facet values of this facet.
- - + + \ No newline at end of file diff --git a/Frameworks/User-Interface-Extensibility-Framework/Reference/UIExt2/Models/FacetDefinition/index.html b/Frameworks/User-Interface-Extensibility-Framework/Reference/UIExt2/Models/FacetDefinition/index.html index f39f66c39..1fe0eebd8 100644 --- a/Frameworks/User-Interface-Extensibility-Framework/Reference/UIExt2/Models/FacetDefinition/index.html +++ b/Frameworks/User-Interface-Extensibility-Framework/Reference/UIExt2/Models/FacetDefinition/index.html @@ -4,13 +4,13 @@ FacetDefinition | M-Files User Interface Extensibility Framework - - + +
Skip to main content

FacetDefinition

Description​

Definition of Facet.

Properties​

NameTypeDescription
aliasstringAlias for property definitions and object types.
exclude{ ids: number[]; }IDs to be excluded (valid for lookup values only).
idnumberID of property def, object type or value list.
objectTypenumberObject type, if type = VLOT.
ordinalnumberFacet ordinal. Order of the facet in UI.
rangeTypeFacetRangeTypeType of range facet ( applies for range facets only ).
rangeValuesstringValues of range.
showMorebooleanTrue to allow "Show more" link.
sortFieldstringFacet value sort field.
sortModestringFacet value sort mode.
transformationFacetTransformationFacet value transformation.
typeFacetTypeFacet type.
valueListnumberValue list ID, if type = VL.
- - + + \ No newline at end of file diff --git a/Frameworks/User-Interface-Extensibility-Framework/Reference/UIExt2/Models/FacetLookupValue/index.html b/Frameworks/User-Interface-Extensibility-Framework/Reference/UIExt2/Models/FacetLookupValue/index.html index 2c055b21f..aee9f9da1 100644 --- a/Frameworks/User-Interface-Extensibility-Framework/Reference/UIExt2/Models/FacetLookupValue/index.html +++ b/Frameworks/User-Interface-Extensibility-Framework/Reference/UIExt2/Models/FacetLookupValue/index.html @@ -4,13 +4,13 @@ FacetLookupValue | M-Files User Interface Extensibility Framework - - + +
Skip to main content

FacetLookupValue

Description​

Facet Lookup based Value.

Properties​

NameTypeDescription
idnumberLookup Id.
- - + + \ No newline at end of file diff --git a/Frameworks/User-Interface-Extensibility-Framework/Reference/UIExt2/Models/FacetNumericRangeValue/index.html b/Frameworks/User-Interface-Extensibility-Framework/Reference/UIExt2/Models/FacetNumericRangeValue/index.html index af16f912e..ba17fdbc4 100644 --- a/Frameworks/User-Interface-Extensibility-Framework/Reference/UIExt2/Models/FacetNumericRangeValue/index.html +++ b/Frameworks/User-Interface-Extensibility-Framework/Reference/UIExt2/Models/FacetNumericRangeValue/index.html @@ -4,13 +4,13 @@ FacetNumericRangeValue | M-Files User Interface Extensibility Framework - - + +
Skip to main content

FacetNumericRangeValue

Description​

Numeric Range Value for Facet Value.

Properties​

NameTypeDescription
numericRangeLowernumberNumeric Range Lower.
numericRangeUppernumberNumeric Range Upper.
- - + + \ No newline at end of file diff --git a/Frameworks/User-Interface-Extensibility-Framework/Reference/UIExt2/Models/FacetNumericValue/index.html b/Frameworks/User-Interface-Extensibility-Framework/Reference/UIExt2/Models/FacetNumericValue/index.html index 8d7a91046..99933fe84 100644 --- a/Frameworks/User-Interface-Extensibility-Framework/Reference/UIExt2/Models/FacetNumericValue/index.html +++ b/Frameworks/User-Interface-Extensibility-Framework/Reference/UIExt2/Models/FacetNumericValue/index.html @@ -4,13 +4,13 @@ FacetNumericValue | M-Files User Interface Extensibility Framework - - + +
Skip to main content

FacetNumericValue

Description​

Facet Numeric Value.

Properties​

NameTypeDescription
numericnumberNumeric Value.
- - + + \ No newline at end of file diff --git a/Frameworks/User-Interface-Extensibility-Framework/Reference/UIExt2/Models/FacetStringValue/index.html b/Frameworks/User-Interface-Extensibility-Framework/Reference/UIExt2/Models/FacetStringValue/index.html index 9206b1bb3..24de685bb 100644 --- a/Frameworks/User-Interface-Extensibility-Framework/Reference/UIExt2/Models/FacetStringValue/index.html +++ b/Frameworks/User-Interface-Extensibility-Framework/Reference/UIExt2/Models/FacetStringValue/index.html @@ -4,13 +4,13 @@ FacetStringValue | M-Files User Interface Extensibility Framework - - + +
Skip to main content

FacetStringValue

Description​

String Value type for Facet Value.

Properties​

NameTypeDescription
stringstringValue.
- - + + \ No newline at end of file diff --git a/Frameworks/User-Interface-Extensibility-Framework/Reference/UIExt2/Models/FacetValue/index.html b/Frameworks/User-Interface-Extensibility-Framework/Reference/UIExt2/Models/FacetValue/index.html index 078acc649..365544bdb 100644 --- a/Frameworks/User-Interface-Extensibility-Framework/Reference/UIExt2/Models/FacetValue/index.html +++ b/Frameworks/User-Interface-Extensibility-Framework/Reference/UIExt2/Models/FacetValue/index.html @@ -4,13 +4,13 @@ FacetValue | M-Files User Interface Extensibility Framework - - + +
Skip to main content

FacetValue

Description​

Facet value.

Properties​

NameTypeDescription
countnumberNumber of objects associated with this facet value.
displayNamestringDisplay name of the facet value.
ordinalnumberFacet value ordinal. Order number of the value ( for ui ).
sortingKeynumberAn explicit sorting key that is used for determining sorting order before the normal sorting field. Sorting by the explicit sorting key is always ascending.
valueFacetStringValue | FacetNumericRangeValue | FacetNumericValue | FacetLookupValueFacet value.
valueTypeFacetValueTypeValue Type.
- - + + \ No newline at end of file diff --git a/Frameworks/User-Interface-Extensibility-Framework/Reference/UIExt2/Models/FtsScope/index.html b/Frameworks/User-Interface-Extensibility-Framework/Reference/UIExt2/Models/FtsScope/index.html index 6a7d0fb01..3c54ac30b 100644 --- a/Frameworks/User-Interface-Extensibility-Framework/Reference/UIExt2/Models/FtsScope/index.html +++ b/Frameworks/User-Interface-Extensibility-Framework/Reference/UIExt2/Models/FtsScope/index.html @@ -4,14 +4,14 @@ FtsScope | M-Files User Interface Extensibility Framework - - + +
Skip to main content

FtsScope

Description​

Full text search scope interface. Metadata or file contents.

Properties​

NameTypeDescription
iconDatastringIcon data in base64 format.
idstringIdentifier of the scope.
namestringName of the scope.
selectedbooleanIndicates whether the scope is selected.
- - + + \ No newline at end of file diff --git a/Frameworks/User-Interface-Extensibility-Framework/Reference/UIExt2/Models/IIconInformation/index.html b/Frameworks/User-Interface-Extensibility-Framework/Reference/UIExt2/Models/IIconInformation/index.html index 93958172c..17401a2b6 100644 --- a/Frameworks/User-Interface-Extensibility-Framework/Reference/UIExt2/Models/IIconInformation/index.html +++ b/Frameworks/User-Interface-Extensibility-Framework/Reference/UIExt2/Models/IIconInformation/index.html @@ -4,13 +4,13 @@ IIconInformation | M-Files User Interface Extensibility Framework - - + +
Skip to main content

IIconInformation

Description​

Represents icon information for command icons.

Supported in M-Files Client version 25.10 and later.

Properties​

NameTypeDescription
altstringAlt text for accessibility.
contentstring | BuiltInIconContent of the icon.
extensionstringExtension of the icon file ("svg", "png", "jpg", "jpeg", "ico").
This information must be provided if using BASE64 icon content type.
iconContentTypeIconContentTypeType of the icon content.
- - + + \ No newline at end of file diff --git a/Frameworks/User-Interface-Extensibility-Framework/Reference/UIExt2/Models/INonSensitiveVaultData/index.html b/Frameworks/User-Interface-Extensibility-Framework/Reference/UIExt2/Models/INonSensitiveVaultData/index.html index 1e1a3cdfc..fd5a6eebb 100644 --- a/Frameworks/User-Interface-Extensibility-Framework/Reference/UIExt2/Models/INonSensitiveVaultData/index.html +++ b/Frameworks/User-Interface-Extensibility-Framework/Reference/UIExt2/Models/INonSensitiveVaultData/index.html @@ -4,13 +4,13 @@ INonSensitiveVaultData | M-Files User Interface Extensibility Framework - - + +
Skip to main content

INonSensitiveVaultData

Description​

Data structure for the session information that does not contain sensitive data.

Properties​

NameTypeDescription
search_engineSearchEngineSpecifies the search engine of the vault.
substitute_usersArray < IUserOrUserGroupID >The user ID of this session's account, as well as the users for which the user is a substitute.
user_idnumberThe M-Files Account ID of the logged-in user.
- - + + \ No newline at end of file diff --git a/Frameworks/User-Interface-Extensibility-Framework/Reference/UIExt2/Models/ISelectedFile/index.html b/Frameworks/User-Interface-Extensibility-Framework/Reference/UIExt2/Models/ISelectedFile/index.html index 03cbaf896..25b3513f7 100644 --- a/Frameworks/User-Interface-Extensibility-Framework/Reference/UIExt2/Models/ISelectedFile/index.html +++ b/Frameworks/User-Interface-Extensibility-Framework/Reference/UIExt2/Models/ISelectedFile/index.html @@ -4,13 +4,13 @@ ISelectedFile | M-Files User Interface Extensibility Framework - - + +
Skip to main content
- - + + \ No newline at end of file diff --git a/Frameworks/User-Interface-Extensibility-Framework/Reference/UIExt2/Models/IVaultInfo/index.html b/Frameworks/User-Interface-Extensibility-Framework/Reference/UIExt2/Models/IVaultInfo/index.html index 9483415a7..75b012aca 100644 --- a/Frameworks/User-Interface-Extensibility-Framework/Reference/UIExt2/Models/IVaultInfo/index.html +++ b/Frameworks/User-Interface-Extensibility-Framework/Reference/UIExt2/Models/IVaultInfo/index.html @@ -4,14 +4,14 @@ IVaultInfo | M-Files User Interface Extensibility Framework - - + +
Skip to main content

IVaultInfo

Description​

IVaultInfo interface represents basic information about a vault. Includes the vault's name and GUID.

Properties​

NameTypeDescription
GUIDstringThe GUID of the vault.
NamestringThe name of the vault.
- - + + \ No newline at end of file diff --git a/Frameworks/User-Interface-Extensibility-Framework/Reference/UIExt2/Models/IVaultInfoReturnValue/index.html b/Frameworks/User-Interface-Extensibility-Framework/Reference/UIExt2/Models/IVaultInfoReturnValue/index.html index be47a3878..48ead41c2 100644 --- a/Frameworks/User-Interface-Extensibility-Framework/Reference/UIExt2/Models/IVaultInfoReturnValue/index.html +++ b/Frameworks/User-Interface-Extensibility-Framework/Reference/UIExt2/Models/IVaultInfoReturnValue/index.html @@ -4,13 +4,13 @@ IVaultInfoReturnValue | M-Files User Interface Extensibility Framework - - + +
Skip to main content

IVaultInfoReturnValue

Description​

Return value for the GetVaultInfo method.

Properties​

NameTypeDescription
GUIDstring
Namestring
- - + + \ No newline at end of file diff --git a/Frameworks/User-Interface-Extensibility-Framework/Reference/UIExt2/Models/LookupValue/index.html b/Frameworks/User-Interface-Extensibility-Framework/Reference/UIExt2/Models/LookupValue/index.html index 7bf30c73c..3c3b90834 100644 --- a/Frameworks/User-Interface-Extensibility-Framework/Reference/UIExt2/Models/LookupValue/index.html +++ b/Frameworks/User-Interface-Extensibility-Framework/Reference/UIExt2/Models/LookupValue/index.html @@ -4,13 +4,13 @@ LookupValue | M-Files User Interface Extensibility Framework - - + +
Skip to main content
- - + + \ No newline at end of file diff --git a/Frameworks/User-Interface-Extensibility-Framework/Reference/UIExt2/Models/MFError/index.html b/Frameworks/User-Interface-Extensibility-Framework/Reference/UIExt2/Models/MFError/index.html index f4140efb0..ad0af8e3b 100644 --- a/Frameworks/User-Interface-Extensibility-Framework/Reference/UIExt2/Models/MFError/index.html +++ b/Frameworks/User-Interface-Extensibility-Framework/Reference/UIExt2/Models/MFError/index.html @@ -4,13 +4,13 @@ MFError | M-Files User Interface Extensibility Framework - - + +
Skip to main content

MFError

Description​

DesktopError class that extends the Error class. this class is used for ReportException function.

Properties​

NameTypeDescription
detailsstringDetail message to show.
errorCodenumberCode of the error.
sourcestringSource of the error.
stackstringError stack.
typestringType of the error.
- - + + \ No newline at end of file diff --git a/Frameworks/User-Interface-Extensibility-Framework/Reference/UIExt2/Models/MultiDashboardUIParams/index.html b/Frameworks/User-Interface-Extensibility-Framework/Reference/UIExt2/Models/MultiDashboardUIParams/index.html index 1cbbea424..1d072769e 100644 --- a/Frameworks/User-Interface-Extensibility-Framework/Reference/UIExt2/Models/MultiDashboardUIParams/index.html +++ b/Frameworks/User-Interface-Extensibility-Framework/Reference/UIExt2/Models/MultiDashboardUIParams/index.html @@ -4,13 +4,13 @@ MultiDashboardUIParams | M-Files User Interface Extensibility Framework - - + +
Skip to main content

MultiDashboardUIParams

Description​

Extended the DialogUIParams interface for showing popup with multiple dashboards.

NOTE: Stability is experimental. Non-backward compatible changes or removal may occur in any future release. Use of this feature is not recommended for production environments.

Properties​

NameTypeDescription
initialSplitRationumberInitial split ratio between dashboards (0.0 to 1.0).
Default is 0.5 for equal split.
minPanelSizenumberMinimum size for each dashboard panel in pixels.
Default is 200.
- - + + \ No newline at end of file diff --git a/Frameworks/User-Interface-Extensibility-Framework/Reference/UIExt2/Models/NonSensitiveSessionData/index.html b/Frameworks/User-Interface-Extensibility-Framework/Reference/UIExt2/Models/NonSensitiveSessionData/index.html index 7b85f8f04..e247295c3 100644 --- a/Frameworks/User-Interface-Extensibility-Framework/Reference/UIExt2/Models/NonSensitiveSessionData/index.html +++ b/Frameworks/User-Interface-Extensibility-Framework/Reference/UIExt2/Models/NonSensitiveSessionData/index.html @@ -4,13 +4,13 @@ NonSensitiveSessionData | M-Files User Interface Extensibility Framework - - + +
Skip to main content

NonSensitiveSessionData

Description​

Data structure for custom session data.

Properties​

NameTypeDescription
access_rightsISessionAccessAccess rights for the user.
account_namestringThe user name.
hostnamestringThe hostname of the M-Files Web application.
license_typeLicenseTypeThe user license type.
vault_dataINonSensitiveVaultDataVault data for the user.
- - + + \ No newline at end of file diff --git a/Frameworks/User-Interface-Extensibility-Framework/Reference/UIExt2/Models/NumericRangeValue/index.html b/Frameworks/User-Interface-Extensibility-Framework/Reference/UIExt2/Models/NumericRangeValue/index.html index 89b39b8ce..683e28c78 100644 --- a/Frameworks/User-Interface-Extensibility-Framework/Reference/UIExt2/Models/NumericRangeValue/index.html +++ b/Frameworks/User-Interface-Extensibility-Framework/Reference/UIExt2/Models/NumericRangeValue/index.html @@ -4,13 +4,13 @@ NumericRangeValue | M-Files User Interface Extensibility Framework - - + +
Skip to main content

NumericRangeValue

Properties​

NameTypeDescription
numericRangeLowerlong
numericRangeUpperlong

Methods​

NameDescription
- - + + \ No newline at end of file diff --git a/Frameworks/User-Interface-Extensibility-Framework/Reference/UIExt2/Models/NumericValue/index.html b/Frameworks/User-Interface-Extensibility-Framework/Reference/UIExt2/Models/NumericValue/index.html index e877cb4f5..f4d6a4efa 100644 --- a/Frameworks/User-Interface-Extensibility-Framework/Reference/UIExt2/Models/NumericValue/index.html +++ b/Frameworks/User-Interface-Extensibility-Framework/Reference/UIExt2/Models/NumericValue/index.html @@ -4,13 +4,13 @@ NumericValue | M-Files User Interface Extensibility Framework - - + +
Skip to main content
- - + + \ No newline at end of file diff --git a/Frameworks/User-Interface-Extensibility-Framework/Reference/UIExt2/Models/ObjectCreationInfo/index.html b/Frameworks/User-Interface-Extensibility-Framework/Reference/UIExt2/Models/ObjectCreationInfo/index.html index dd793ef01..463391d4d 100644 --- a/Frameworks/User-Interface-Extensibility-Framework/Reference/UIExt2/Models/ObjectCreationInfo/index.html +++ b/Frameworks/User-Interface-Extensibility-Framework/Reference/UIExt2/Models/ObjectCreationInfo/index.html @@ -4,13 +4,13 @@ ObjectCreationInfo | M-Files User Interface Extensibility Framework - - + +
Skip to main content

ObjectCreationInfo

Description​

The ObjectCreationInfo class is used for specifying the initial state of the new metadata card.

Properties​

NameTypeDescription
check_in_immediately_enabledbooleanCheck-in immediately while object creation.
disallow_template_selectionbooleanSpecifies whether the template selection user interface can be shown.
extensionstringThe extension of the new object.
metadata_card_titlestringThe title for the metadata card.
object_typenull | numberThe object type for the new object
ok_to_all_button_visiblebooleanOK button visibility in the metadata card.
single_file_documentbooleanThe single file document creation.
skip_this_button_visiblebooleanSKIP button visiblity in the metadata card.
source_filesObjFileSourceInput files for object creation. It Can be object source files or template (blank/user defined).
titlestringAn initial object title.
- - + + \ No newline at end of file diff --git a/Frameworks/User-Interface-Extensibility-Framework/Reference/UIExt2/Models/ObjectFile/index.html b/Frameworks/User-Interface-Extensibility-Framework/Reference/UIExt2/Models/ObjectFile/index.html index 6fbb0fdcc..ea7ac8657 100644 --- a/Frameworks/User-Interface-Extensibility-Framework/Reference/UIExt2/Models/ObjectFile/index.html +++ b/Frameworks/User-Interface-Extensibility-Framework/Reference/UIExt2/Models/ObjectFile/index.html @@ -4,13 +4,13 @@ ObjectFile | M-Files User Interface Extensibility Framework - - + +
Skip to main content

ObjectFile

Description​

The ObjectFile class extends the file and adds the parent information.

Properties​

NameTypeDescription
accessed_at_utc{seconds: number nanos: number }
changed_at_utc{seconds: number nanos: number }
created_at_utc{seconds: number nanos: number }
extensionstring
file_verIFileVer
flagsIOBJECTFILEFLAGS
guidstring
is_content_volatileboolean
is_missingboolean
master_storage_file_refstring
md5_checksumstring
parentObjectVersionExThe parent object version info.
sizenumber
size_precisionFileSizePrecision
titlestring
written_at_utc{seconds: number nanos: number }
- - + + \ No newline at end of file diff --git a/Frameworks/User-Interface-Extensibility-Framework/Reference/UIExt2/Models/ObjectFileVersionArgumentValue/index.html b/Frameworks/User-Interface-Extensibility-Framework/Reference/UIExt2/Models/ObjectFileVersionArgumentValue/index.html index 684c0148f..abd9ddad2 100644 --- a/Frameworks/User-Interface-Extensibility-Framework/Reference/UIExt2/Models/ObjectFileVersionArgumentValue/index.html +++ b/Frameworks/User-Interface-Extensibility-Framework/Reference/UIExt2/Models/ObjectFileVersionArgumentValue/index.html @@ -4,13 +4,13 @@ ObjectFileVersionArgumentValue | M-Files User Interface Extensibility Framework - - + +
Skip to main content

ObjectFileVersionArgumentValue

Properties​

NameTypeDescription
file_verFileVerIf file object, use FileVer
isFilebooleanIs this a file object
obj_verObjVerIf not file object use ObjVer

Methods​

NameDescription
- - + + \ No newline at end of file diff --git a/Frameworks/User-Interface-Extensibility-Framework/Reference/UIExt2/Models/ObjectFileVersionParams/index.html b/Frameworks/User-Interface-Extensibility-Framework/Reference/UIExt2/Models/ObjectFileVersionParams/index.html index 11f28276a..1f5cf7c1f 100644 --- a/Frameworks/User-Interface-Extensibility-Framework/Reference/UIExt2/Models/ObjectFileVersionParams/index.html +++ b/Frameworks/User-Interface-Extensibility-Framework/Reference/UIExt2/Models/ObjectFileVersionParams/index.html @@ -4,13 +4,13 @@ ObjectFileVersionParams | M-Files User Interface Extensibility Framework - - + +
Skip to main content

ObjectFileVersionParams

Description​

Argument for function SelectObjectOrObjectFileVersion

Properties​

NameTypeDescription
file_verFileVerIf file object, use FileVer
isFilebooleanIs this a file object
obj_verObjVerIf not file object use ObjVer
- - + + \ No newline at end of file diff --git a/Frameworks/User-Interface-Extensibility-Framework/Reference/UIExt2/Models/ObjectWindowResult/index.html b/Frameworks/User-Interface-Extensibility-Framework/Reference/UIExt2/Models/ObjectWindowResult/index.html index 515d93dfe..62eadbafe 100644 --- a/Frameworks/User-Interface-Extensibility-Framework/Reference/UIExt2/Models/ObjectWindowResult/index.html +++ b/Frameworks/User-Interface-Extensibility-Framework/Reference/UIExt2/Models/ObjectWindowResult/index.html @@ -4,13 +4,13 @@ ObjectWindowResult | M-Files User Interface Extensibility Framework - - + +
Skip to main content

ObjectWindowResult

Description​

The ObjectWindowResult class encapsulates the return values of showing the metadata card.

Properties​

NameTypeDescription
aclAccessControlListReceives the access control list of the object.
object_versionnull | ObjectVersionExReceives the object version of the object after displaying the metadata card.
propertiesArray < IPropertyValue >Current property values of the object displayed in the metadata card.
result_codeanyThe dialog box result code.
visiblebooleanSpecifies whether the object is still visible for the current user.
- - + + \ No newline at end of file diff --git a/Frameworks/User-Interface-Extensibility-Framework/Reference/UIExt2/Models/SearchCriteria/index.html b/Frameworks/User-Interface-Extensibility-Framework/Reference/UIExt2/Models/SearchCriteria/index.html index 03a2036f6..3faa40e69 100644 --- a/Frameworks/User-Interface-Extensibility-Framework/Reference/UIExt2/Models/SearchCriteria/index.html +++ b/Frameworks/User-Interface-Extensibility-Framework/Reference/UIExt2/Models/SearchCriteria/index.html @@ -4,13 +4,13 @@ SearchCriteria | M-Files User Interface Extensibility Framework - - + +
Skip to main content

SearchCriteria

Description​

Represents Search Criteria.

Properties​

NameTypeDescription
conditionsArray < SearchCondition >Search Conditions of Quick Search, Basic Filter( ObjectType, Repository ) and Advance Search Filter.
facetFilterArray < Facet >Selected Facet filters.
- - + + \ No newline at end of file diff --git a/Frameworks/User-Interface-Extensibility-Framework/Reference/UIExt2/Models/ShellframeFolders/index.html b/Frameworks/User-Interface-Extensibility-Framework/Reference/UIExt2/Models/ShellframeFolders/index.html index b4a7f2971..7317859b5 100644 --- a/Frameworks/User-Interface-Extensibility-Framework/Reference/UIExt2/Models/ShellframeFolders/index.html +++ b/Frameworks/User-Interface-Extensibility-Framework/Reference/UIExt2/Models/ShellframeFolders/index.html @@ -4,13 +4,13 @@ ShellFrameFolders | M-Files User Interface Extensibility Framework - - + +
Skip to main content

ShellFrameFolders

Description​

Argument for the IShellFrame NavigateToFolder

Properties​

NameTypeDescription
foldersArray < Folder >The folder which navigate into.
- - + + \ No newline at end of file diff --git a/Frameworks/User-Interface-Extensibility-Framework/Reference/UIExt2/Models/ShowMessageArgumentValue/index.html b/Frameworks/User-Interface-Extensibility-Framework/Reference/UIExt2/Models/ShowMessageArgumentValue/index.html index 30255116f..a680f5559 100644 --- a/Frameworks/User-Interface-Extensibility-Framework/Reference/UIExt2/Models/ShowMessageArgumentValue/index.html +++ b/Frameworks/User-Interface-Extensibility-Framework/Reference/UIExt2/Models/ShowMessageArgumentValue/index.html @@ -4,13 +4,13 @@ ShowMessageArgumentValue | M-Files User Interface Extensibility Framework - - + +
Skip to main content

ShowMessageArgumentValue

Description​

Data structure returned by the ShowMessage call.

Properties​

NameTypeDescription
button1_titlestringTitle for the button 1
button2_titlestringTitle for the button 2
button3_titlestringTitle for the button 3
checkbox_checkedbooleanShould the checkbox be initialized as checked ( default = false)
checkbox_titlestringLabel for the checkbox.
messagestringMessage to show
timeOutnumberTimeout for the dialog.
timeOutButtonnumberButton to select (1-3) after the timeout

Methods​

NameDescription
- - + + \ No newline at end of file diff --git a/Frameworks/User-Interface-Extensibility-Framework/Reference/UIExt2/Models/ShowMessageParams/index.html b/Frameworks/User-Interface-Extensibility-Framework/Reference/UIExt2/Models/ShowMessageParams/index.html index 12beb44a8..a0e89bc81 100644 --- a/Frameworks/User-Interface-Extensibility-Framework/Reference/UIExt2/Models/ShowMessageParams/index.html +++ b/Frameworks/User-Interface-Extensibility-Framework/Reference/UIExt2/Models/ShowMessageParams/index.html @@ -4,13 +4,13 @@ ShowMessageParams | M-Files User Interface Extensibility Framework - - + +
Skip to main content

ShowMessageParams

Description​

Data structure returned by the ShowMessage call.

Properties​

NameTypeDescription
button1_titlestringTitle for the button 1
button2_titlestringTitle for the button 2
button3_titlestringTitle for the button 3
checkbox_checkedbooleanShould the checkbox be initialized as checked ( default = false)
checkbox_titlestringLabel for the checkbox.
defaultButtonnumberDefault button to select (1-3).
messagestringMessage to show
timeOutnumberTimeout for the dialog.
timeOutButtonnumberButton to select (1-3) after the timeout
- - + + \ No newline at end of file diff --git a/Frameworks/User-Interface-Extensibility-Framework/Reference/UIExt2/Models/ShowMessageReturnValue/index.html b/Frameworks/User-Interface-Extensibility-Framework/Reference/UIExt2/Models/ShowMessageReturnValue/index.html index b5e0f1f65..70eb00265 100644 --- a/Frameworks/User-Interface-Extensibility-Framework/Reference/UIExt2/Models/ShowMessageReturnValue/index.html +++ b/Frameworks/User-Interface-Extensibility-Framework/Reference/UIExt2/Models/ShowMessageReturnValue/index.html @@ -4,13 +4,13 @@ ShowMessageReturnValue | M-Files User Interface Extensibility Framework - - + +
Skip to main content

ShowMessageReturnValue

Description​

Data structure returned by the ShowMessage call.

Properties​

NameTypeDescription
checkboxCheckedbooleanFlag to indicate if the checkbox was checked.
selectedButtonnumberIndex of the button selected (1-3)
- - + + \ No newline at end of file diff --git a/Frameworks/User-Interface-Extensibility-Framework/Reference/UIExt2/Models/StringValue/index.html b/Frameworks/User-Interface-Extensibility-Framework/Reference/UIExt2/Models/StringValue/index.html index ee71d4481..0a4c6a31b 100644 --- a/Frameworks/User-Interface-Extensibility-Framework/Reference/UIExt2/Models/StringValue/index.html +++ b/Frameworks/User-Interface-Extensibility-Framework/Reference/UIExt2/Models/StringValue/index.html @@ -4,13 +4,13 @@ StringValue | M-Files User Interface Extensibility Framework - - + +
Skip to main content
- - + + \ No newline at end of file diff --git a/Frameworks/User-Interface-Extensibility-Framework/Reference/UIExt2/Models/VaultInfoReturnValue/index.html b/Frameworks/User-Interface-Extensibility-Framework/Reference/UIExt2/Models/VaultInfoReturnValue/index.html index ba56a7ee3..40db12258 100644 --- a/Frameworks/User-Interface-Extensibility-Framework/Reference/UIExt2/Models/VaultInfoReturnValue/index.html +++ b/Frameworks/User-Interface-Extensibility-Framework/Reference/UIExt2/Models/VaultInfoReturnValue/index.html @@ -4,13 +4,13 @@ VaultInfoReturnValue | M-Files User Interface Extensibility Framework - - + +
Skip to main content

VaultInfoReturnValue

Description​

Return value for the GetVaultInfo method.

Properties​

NameTypeDescription
GUIDstringThe GUID for the current vault.
NamestringName of the current vault.

Methods​

NameDescription
- - + + \ No newline at end of file diff --git a/Frameworks/User-Interface-Extensibility-Framework/Reference/UIExt2/Models/index.html b/Frameworks/User-Interface-Extensibility-Framework/Reference/UIExt2/Models/index.html index 826c956ed..d288ec44c 100644 --- a/Frameworks/User-Interface-Extensibility-Framework/Reference/UIExt2/Models/index.html +++ b/Frameworks/User-Interface-Extensibility-Framework/Reference/UIExt2/Models/index.html @@ -4,13 +4,13 @@ Models | M-Files User Interface Extensibility Framework - - + +
Skip to main content

Models

NameDescription
ObjectCreationInfoThe ObjectCreationInfo class is used for specifying the initial state of the new metadata card.
ObjectFileThe ObjectFile class extends the file and adds the parent information.
ObjectWindowResultThe ObjectWindowResult class encapsulates the return values of showing the metadata card.
DashboardConfigData structure for popup dashboard configuration.

NOTE: Stability is experimental. Non-backward compatible changes or removal may occur in any future release. Use of this feature is not recommended for production environments.
DialogUIParamsData structure for show popup dashboard UI params.
MultiDashboardUIParamsExtended the DialogUIParams interface for showing popup with multiple dashboards.

NOTE: Stability is experimental. Non-backward compatible changes or removal may occur in any future release. Use of this feature is not recommended for production environments.
FacetSearch Facet.
FacetDefinitionDefinition of Facet.
FacetStringValueString Value type for Facet Value.
FacetNumericRangeValueNumeric Range Value for Facet Value.
FacetNumericValueFacet Numeric Value.
FacetLookupValueFacet Lookup based Value.
FacetValueFacet value.
FtsScopeFull text search scope interface. Metadata or file contents.
IIconInformationRepresents icon information for command icons.

Supported in M-Files Client version 25.10 and later.
ISelectedFileRepresents a selected file.
IVaultInfoIVaultInfo interface represents basic information about a vault. Includes the vault's name and GUID.
MFErrorDesktopError class that extends the Error class. this class is used for ReportException function.
INonSensitiveVaultDataData structure for the session information that does not contain sensitive data.
NonSensitiveSessionDataData structure for custom session data.
ObjectFileVersionParamsArgument for function SelectObjectOrObjectFileVersion
SearchCriteriaRepresents Search Criteria.
ShellFrameFoldersArgument for the IShellFrame NavigateToFolder
ShowMessageParamsData structure returned by the ShowMessage call.
ShowMessageReturnValueData structure returned by the ShowMessage call.
- - + + \ No newline at end of file diff --git a/Frameworks/User-Interface-Extensibility-Framework/Reference/UIExt2/index.html b/Frameworks/User-Interface-Extensibility-Framework/Reference/UIExt2/index.html index 38cd66c74..a2e10b12a 100644 --- a/Frameworks/User-Interface-Extensibility-Framework/Reference/UIExt2/index.html +++ b/Frameworks/User-Interface-Extensibility-Framework/Reference/UIExt2/index.html @@ -4,13 +4,13 @@ API Reference Guide | M-Files User Interface Extensibility Framework - - + +
Skip to main content

API Reference Guide

The M-Files User Interface Extensibility Framework exposes a number of items that are used to interact with the user interface. Use the navigation on the left to view the various interfaces, enumerations, and events that are available to you.

The easiest way to use this section is to start from the pages under the Overview section on the left. These pages include links to the appropriate interfaces or other references that you need. As an example: the Modules page states that the "OnNewShellUI" method will be passed one argument which is an instance of IShellUI; clicking on the interface name will take you to a section which defines which properties or methods are available within that instance.

Note that many methods within the User Interface Extensibility Framework 2.0 are asynchronous. This is a change from the older User Interface Extensibility Framework approach. You can choose whether to use async functions (and the await keyword), or whether to use a Promise-style syntax, when calling these functions. Examples on this website typically use async functions.

- - + + \ No newline at end of file diff --git a/Frameworks/User-Interface-Extensibility-Framework/Reference/Upgrading/deprecated_features/index.html b/Frameworks/User-Interface-Extensibility-Framework/Reference/Upgrading/deprecated_features/index.html index ee0fbe4fc..10f9f0a91 100644 --- a/Frameworks/User-Interface-Extensibility-Framework/Reference/Upgrading/deprecated_features/index.html +++ b/Frameworks/User-Interface-Extensibility-Framework/Reference/Upgrading/deprecated_features/index.html @@ -4,13 +4,13 @@ Deprecated features and alternatives | M-Files User Interface Extensibility Framework - - + +
Skip to main content

Deprecated features and alternatives

note

This is a preview version of the User Interface Extensibility Framework v2.0. We may have not identified all missing features and this list may not be comprehensive.

The User Interface Extensibility Framework 2.0 introduces significant architectural changes from previous versions. Notably, certain v1 interfaces are no longer available—some have been replaced with alternative implementations, while others have been deprecated entirely. This document outlines the key differences, available alternatives, and deprecated functionality.

API v2 targets execution in a modern, sandboxed browser environment. As a result, certain legacy client APIs and platform features (e.g. ActiveX, COM) are no longer permitted. Where possible, we provide supported alternatives.

UIX Interface Alternatives​

The following table lists UIX 1.0 interfaces that are not available in version 2.0, along with their recommended alternatives.

UIX 1.0 InterfaceAlternative in v2.0
CommandLocation_TaskPaneUse CommandLocation enum value TaskBar with the ICommands interface. See Taskbar Commands for samples on working with TaskBar.
IShellFrame.ITaskPaneUse ICommands interface. See Taskbar Commands for samples on working with TaskBar.
ITaskPane.Available/VisibleTaskbar is available starting from version 25.10.15296.9. For backwards compatibility check whether the CommandLocation enumeration value TaskBar is available. This enumeration value was added with TaskBar. The TaskBar is always visible.
ITaskPane.CreateGroupUse CreateTaskbarGroup in the ICommands interface for creating groups in the Taskbar.
TaskPane.AddCustomCommandToGroupUse AddCustomCommandToMenu in the ICommands interface. Here is an example on how to add commands to a custom taskbar command group.
ICommands.SetIconFromPathUse SetIcon or SetTaskbarGroupIcon for setting icons for commands or Taskbar groups.
ICommonFunctions.ExecuteURLUse OpenExternalWebLink.
ICommonFunction.ReadTextFileVAF (Vault Application Framework) can be used as a workaround.
IDashboard.VaultUse IDashboard's reference to ShellFrame, which provides access to ShellUI which then has access to Vault.
MFiles.CreateInstanceUse the new keyword for creating M-Files API objects. E.g.const objVer = new MFiles.ObjVer();
SessionInfo.ClientCultureUse GetClientLocale.
IShellFrame.CurrentFolder (for special views)In UIX 1.0, special views like SearchView were listed in CurrentFolder. In UIXv2, use CurrentPath to identify special views by their path string. See Built-in View Paths below for the list of path values.

Built-in View Paths​

The CurrentPath property of IShellFrame returns a string that identifies the current view. For special views, the following built-in path strings are used:

Path StringView
SearchSearch view
WorkspacesWorkspaces view
PinnedPinned view
Checked Out to Me\\Checked Out to Me
Recently Modified by Me\\Recently Modified by Me
Assigned to Me\\Assigned to Me
Recently Accessed by Me\\Recently Accessed by Me
Favorites\\Favorites
Object HistoryObject History
Conflict ResolutionConflict Resolution
_singleObjectSingle Object view (shown when navigating to an object)

Example usage:

// Check if the current view is the Search view
if (shellFrame.CurrentPath === "Search") {
    console.log("Currently in Search view");
}

// Check if the current view is a Workspace
if (shellFrame.CurrentPath === "Workspaces") {
    console.log("Currently in Workspaces view");
}

Vault API Alternatives​

The following table lists Vault API methods that are not directly available in version 2.0, along with their recommended alternatives.

Vault API MethodAlternative in v2.0
ClassOperations.GetObjectClassUse GetObjectClassesAndGroups.
ClassOperations.GetObjectClassIDByAliasUse GetMetadataStructureItemIdByAlias.
ObjectFileOperations.AddEmptyFile / AddFileUse AddObjectFile as a workaround. The original method expected a source path, which is insecure. Create file content (e.g., via drag-and-drop) and use AddObjectFile. Currently supported only for objects in the current listing.
ObjectOperations.CheckInUse CheckInMultiple.
ObjectOperations.CheckOutUse CheckOutMultiple.
ObjectOperations.CreateNewObjectUse AddObjectWithFiles.
ObjectOperations.CreateNewObjectExUse AddObjectWithFiles.
ObjectOperations.GetLatestObjectVersionAndPropertiesUse GetObjectDataOfMultipleObjects.
ObjectOperations.GetMFilesURLForObjectUse GetWebLink.
ObjectOperations.GetObjectInfoUse GetObjectDataOfMultipleObjects with the required OBJECTDATAREQUESTFLAGS.
ObjectOperations.GetObjectPermissionsUse GetEffectivePermissions.
ObjectOperations.IsObjectCheckedOutUse GetObjectDataOfMultipleObjects with the object_version flag. The return value(s)'s ObjVer's ObjVerVersion contains ObjVerVersionType.
ObjectPropertyOperations.SetPropertyUse SetPropertiesMultiple.
ObjectSearchOperations.SearchForObjectsByConditionsUse SearchObjects.
ObjectSearchOperations.SearchForObjectsByConditionsExUse SearchObjects.
ObjectTypeOperations.GetObjectTypeIDByAliasUse GetMetadataStructureItemIdByAlias.
IObjectVersionPermissions.AccessControlListUse GetEffectivePermissions.
PropertyDefOperations.GetPropertyDefIDByAliasUse GetMetadataStructureItemIdByAlias.
UserGroupOperations.GetUserGroupIDByAliasUse GetMetadataStructureItemIdByAlias.
IValueListItem.GetIconAsPNGUse GetValueListItemIconURL.
ValueListItemOperations.GetValueListItemByIDUse SearchValueListItemsWithPermissions.
WorkflowOperations.GetWorkflowIDByAliasUse GetMetadataStructureItemIdByAlias.
WorkflowOperations.GetWorkflowStateIDByAliasUse GetMetadataStructureItemIdByAlias.

Deprecated Features​

The following features from version 1.0 are deprecated and will not be supported in the new framework.

FeatureNotes
IShellUI.CreatePersistentBrowserContentNot supported in the new framework.

Unsupported Environment Features​

Due UIXv2 applications running in web-based environment, the following features and objects are not directly supported.

Browser APIs​

FeatureReason
window.open()Requires allow-popups iframe sandbox attribute
window.alert()Requires allow-modals iframe sandbox attribute
window.prompt()Requires allow-modals iframe sandbox attribute
parentUsage restricted by browser security
documentSandboxed application can access its own DOM, but not the parent's
msFullscreenElementMicrosoft-specific Legacy API not available.
navigator.msSaveOrOpenBlobMicrosoft-specific Legacy API not available.
Enabling Sandbox Attributes

Some browser APIs like window.open(), window.alert(), and window.prompt() can be enabled by configuring sandbox attributes in your application manifest. See the Sandbox Attributes Support sample for details on how to configure allow-popups, allow-modals, and other sandbox permissions for your UIXv2 application.

ActiveX and COM Objects​

UIXv2 applications execute within sandboxed iframes in modern browser execution environment, which enforce strict security boundaries. Unlike the legacy Internet Explorer environment—where web applications could instantiate COM objects and run with near-native privileges—modern browsers isolate JavaScript execution and explicitly block access to native OS APIs.

Why these objects cannot work:

  • Browser sandbox isolation: Modern browsers enforce strict process isolation. JavaScript running in an iframe cannot escape the sandbox to invoke native OS APIs, spawn processes, or access the Windows registry.
  • No ActiveXObject API: The new ActiveXObject() constructor was an IE-specific extension, never part of web standards. No modern browser implements it.
  • Cross-origin security model: Sandboxed iframes operate under Same-Origin Policy and Content Security Policy (CSP), blocking calls to local resources.
  • No in-process COM hosting: ActiveX controls ran in-process with IE, sharing its memory space. Modern browsers isolate renderer processes and block loading arbitrary native DLLs.

The following ActiveX and COM-based objects are not supported:

ObjectOriginal PurposeWhy It's Blocked
ActiveXObjectInstantiate COM objects from JavaScriptIE-specific API; not implemented in any modern browser
WScript.ShellExecute programs, manipulate registry, create shortcutsRequires direct OS access; would allow arbitrary code execution
Microsoft.XMLDOMParse and manipulate XML documentsIE-specific; replaced by native DOMParser and XMLSerializer APIs
Outlook.ApplicationCompose emails, access calendar and contactsRequires COM automation of Outlook process; major security risk
Scripting.FileSystemObjectRead/write local files and foldersDirect filesystem access violates browser sandbox model
Shell.ApplicationWindows Shell operations (browse folders, invoke verbs)Requires native Windows Shell integration
SenchaToolbox.ToolboxM-Files proprietary IE integrationRelied on IE plugin architecture (NPAPI/ActiveX)
MFilesAPI.MFilesClientApplicationDirect access to M-Files COM APIRequires in-process COM instantiation on client machine

Migration Alternatives​

Deprecated FunctionalityModern Replacement
XML parsing (Microsoft.XMLDOM)Native DOMParser, fetch() with XML response
File operations (Scripting.FileSystemObject)File System Access API (with user permission), or server-side processing via VAF
Email composition (Outlook.Application)mailto: links, or server-side email APIs (Microsoft Graph API, SMTP)
Shell operations (Shell.Application, WScript.Shell)Server-side automation via VAF, or companion desktop application
M-Files client access (MFilesAPI.MFilesClientApplication)gRPC API or UIXv2 methods
tip

For functionality previously provided by COM or ActiveX, consider using server-side implementations via the Vault Application Framework (VAF).

- - + + \ No newline at end of file diff --git a/Frameworks/User-Interface-Extensibility-Framework/Reference/assets/js/37ee5f99.3a3af814.js b/Frameworks/User-Interface-Extensibility-Framework/Reference/assets/js/37ee5f99.3a3af814.js new file mode 100644 index 000000000..828a73975 --- /dev/null +++ b/Frameworks/User-Interface-Extensibility-Framework/Reference/assets/js/37ee5f99.3a3af814.js @@ -0,0 +1 @@ +"use strict";(self.webpackChunkuix_2=self.webpackChunkuix_2||[]).push([[1170],{3905:(e,t,n)=>{n.d(t,{Zo:()=>p,kt:()=>c});var r=n(67294);function a(e,t,n){return t in e?Object.defineProperty(e,t,{value:n,enumerable:!0,configurable:!0,writable:!0}):e[t]=n,e}function l(e,t){var n=Object.keys(e);if(Object.getOwnPropertySymbols){var r=Object.getOwnPropertySymbols(e);t&&(r=r.filter((function(t){return Object.getOwnPropertyDescriptor(e,t).enumerable}))),n.push.apply(n,r)}return n}function o(e){for(var t=1;t=0||(a[n]=e[n]);return a}(e,t);if(Object.getOwnPropertySymbols){var l=Object.getOwnPropertySymbols(e);for(r=0;r=0||Object.prototype.propertyIsEnumerable.call(e,n)&&(a[n]=e[n])}return a}var s=r.createContext({}),d=function(e){var t=r.useContext(s),n=t;return e&&(n="function"==typeof e?e(t):o(o({},t),e)),n},p=function(e){var t=d(e.components);return r.createElement(s.Provider,{value:t},e.children)},m="mdxType",u={inlineCode:"code",wrapper:function(e){var t=e.children;return r.createElement(r.Fragment,{},t)}},h=r.forwardRef((function(e,t){var n=e.components,a=e.mdxType,l=e.originalType,s=e.parentName,p=i(e,["components","mdxType","originalType","parentName"]),m=d(n),h=a,c=m["".concat(s,".").concat(h)]||m[h]||u[h]||l;return n?r.createElement(c,o(o({ref:t},p),{},{components:n})):r.createElement(c,o({ref:t},p))}));function c(e,t){var n=arguments,a=t&&t.mdxType;if("string"==typeof e||a){var l=n.length,o=new Array(l);o[0]=h;var i={};for(var s in t)hasOwnProperty.call(t,s)&&(i[s]=t[s]);i.originalType=e,i[m]="string"==typeof e?e:a,o[1]=i;for(var d=2;d{n.r(t),n.d(t,{assets:()=>s,contentTitle:()=>o,default:()=>u,frontMatter:()=>l,metadata:()=>i,toc:()=>d});var r=n(87462),a=(n(67294),n(3905));const l={sidebar_position:1},o=void 0,i={unversionedId:"UIExt2/Events",id:"UIExt2/Events",title:"Events",description:"IDashboardEvents",source:"@site/docs/UIExt2/Events.mdx",sourceDirName:"UIExt2",slug:"/UIExt2/Events",permalink:"/Frameworks/User-Interface-Extensibility-Framework/Reference/UIExt2/Events",draft:!1,tags:[],version:"current",sidebarPosition:1,frontMatter:{sidebar_position:1},sidebar:"tutorialSidebar",previous:{title:"API Reference Guide",permalink:"/Frameworks/User-Interface-Extensibility-Framework/Reference/UIExt2/"},next:{title:"Enums",permalink:"/Frameworks/User-Interface-Extensibility-Framework/Reference/UIExt2/Enums/"}},s={},d=[{value:"IDashboardEvents",id:"idashboardevents",level:2},{value:"ISearchPaneEvents",id:"isearchpaneevents",level:2},{value:"IShellFrameEvents",id:"ishellframeevents",level:2},{value:"IShellListingEvents",id:"ishelllistingevents",level:2},{value:"IShellPaneContainerEvents",id:"ishellpanecontainerevents",level:2},{value:"IShellPaneTabEvents",id:"ishellpanetabevents",level:2},{value:"IWindowEvents",id:"iwindowevents",level:2},{value:"IShellUIEvents",id:"ishelluievents",level:2},{value:"ICommandsEvents",id:"icommandsevents",level:2}],p={toc:d},m="wrapper";function u(e){let{components:t,...n}=e;return(0,a.kt)(m,(0,r.Z)({},p,n,{components:t,mdxType:"MDXLayout"}),(0,a.kt)("h2",{id:"idashboardevents"},"IDashboardEvents"),(0,a.kt)("p",null,"The IDashboard interface has Events property, which provides access to the IDashboardEvents interface. This interface provides two methods:"),(0,a.kt)("ul",null,(0,a.kt)("li",{parentName:"ul"},(0,a.kt)("strong",{parentName:"li"},"Register( event, callback )"),": Registers an event handler for the specified event and returns the event handler ID."),(0,a.kt)("li",{parentName:"ul"},(0,a.kt)("strong",{parentName:"li"},"Unregister( eventId )"),": Unregisters the event handler with the specified ID.")),(0,a.kt)("p",null,"One of the use cases for events in IDashboard is to listen for custom data changes provided by UpdateCustomData method."),(0,a.kt)("p",null,"Here is a JavaScript example of how to use the IDashboardEvents interface to listen for custom data changes using globally defined events."),(0,a.kt)("pre",null,(0,a.kt)("code",{parentName:"pre",className:"language-javascript"},'// Register event handler for the custom data changes.\nconst eventId = await dashboard.Events.Register(\n MFiles.Event.CustomDataChanged,\n (data) => {\n console.log("Custom data changed: ", data);\n },\n);\n')),(0,a.kt)("table",null,(0,a.kt)("thead",{parentName:"table"},(0,a.kt)("tr",{parentName:"thead"},(0,a.kt)("th",{parentName:"tr",align:null},"Event"),(0,a.kt)("th",{parentName:"tr",align:null},"Description"),(0,a.kt)("th",{parentName:"tr",align:null},"Arguments"))),(0,a.kt)("tbody",{parentName:"table"},(0,a.kt)("tr",{parentName:"tbody"},(0,a.kt)("td",{parentName:"tr",align:null},"Refresh"),(0,a.kt)("td",{parentName:"tr",align:null},"Triggered when the dashboard data is refreshed."),(0,a.kt)("td",{parentName:"tr",align:null})),(0,a.kt)("tr",{parentName:"tbody"},(0,a.kt)("td",{parentName:"tr",align:null},"Started"),(0,a.kt)("td",{parentName:"tr",align:null},"Sent when the dashboard turns to started state."),(0,a.kt)("td",{parentName:"tr",align:null})),(0,a.kt)("tr",{parentName:"tbody"},(0,a.kt)("td",{parentName:"tr",align:null},"Stop"),(0,a.kt)("td",{parentName:"tr",align:null},"Sent before the dashboard is stopped."),(0,a.kt)("td",{parentName:"tr",align:null})),(0,a.kt)("tr",{parentName:"tbody"},(0,a.kt)("td",{parentName:"tr",align:null},"CustomDataChanged"),(0,a.kt)("td",{parentName:"tr",align:null},"This event is triggered, when custom data on dashboard has changed. The event can be ",(0,a.kt)("br",null),"used to update the dashboard based on the new data. This event will fire at least ",(0,a.kt)("br",null),"once when the dashboard is started and initialized."),(0,a.kt)("td",{parentName:"tr",align:null},(0,a.kt)("strong",{parentName:"td"},"data")," New custom data for the dashboard")))),(0,a.kt)("h2",{id:"isearchpaneevents"},"ISearchPaneEvents"),(0,a.kt)("p",null,"Interface for the Search pane events. The interface provides two methods:"),(0,a.kt)("ul",null,(0,a.kt)("li",{parentName:"ul"},(0,a.kt)("strong",{parentName:"li"},"Register( event, callback )"),": Registers an event handler for the specified event."),(0,a.kt)("li",{parentName:"ul"},(0,a.kt)("strong",{parentName:"li"},"Unregister( eventId )"),": Unregisters the event handler with the specified ID.")),(0,a.kt)("table",null,(0,a.kt)("thead",{parentName:"table"},(0,a.kt)("tr",{parentName:"thead"},(0,a.kt)("th",{parentName:"tr",align:null},"Event"),(0,a.kt)("th",{parentName:"tr",align:null},"Description"),(0,a.kt)("th",{parentName:"tr",align:null},"Arguments"))),(0,a.kt)("tbody",{parentName:"table"},(0,a.kt)("tr",{parentName:"tbody"},(0,a.kt)("td",{parentName:"tr",align:null},"Stop"),(0,a.kt)("td",{parentName:"tr",align:null},"Sent before the Searchpane is closed."),(0,a.kt)("td",{parentName:"tr",align:null})),(0,a.kt)("tr",{parentName:"tbody"},(0,a.kt)("td",{parentName:"tr",align:null},"Started"),(0,a.kt)("td",{parentName:"tr",align:null},"Registers event handler for the Search pane started event, which means that the Search pane ",(0,a.kt)("br",null),"is ready to be used."),(0,a.kt)("td",{parentName:"tr",align:null})))),(0,a.kt)("h2",{id:"ishellframeevents"},"IShellFrameEvents"),(0,a.kt)("p",null,"IShellFrameEvents interface provides means to manage shell frame events. The interface provides two methods:"),(0,a.kt)("ul",null,(0,a.kt)("li",{parentName:"ul"},(0,a.kt)("strong",{parentName:"li"},"Register( event, callback )"),": Registers an event handler for the specified event."),(0,a.kt)("li",{parentName:"ul"},(0,a.kt)("strong",{parentName:"li"},"Unregister( eventId )"),": Unregisters the event handler with the specified ID.")),(0,a.kt)("table",null,(0,a.kt)("thead",{parentName:"table"},(0,a.kt)("tr",{parentName:"thead"},(0,a.kt)("th",{parentName:"tr",align:null},"Event"),(0,a.kt)("th",{parentName:"tr",align:null},"Description"),(0,a.kt)("th",{parentName:"tr",align:null},"Arguments"))),(0,a.kt)("tbody",{parentName:"table"},(0,a.kt)("tr",{parentName:"tbody"},(0,a.kt)("td",{parentName:"tr",align:null},"Stop"),(0,a.kt)("td",{parentName:"tr",align:null},"Sent before the IShellFrame is stopped."),(0,a.kt)("td",{parentName:"tr",align:null})),(0,a.kt)("tr",{parentName:"tbody"},(0,a.kt)("td",{parentName:"tr",align:null},"Started"),(0,a.kt)("td",{parentName:"tr",align:null},"Registers event handler for the IShellFrame started event, which means that the IShellFrame ",(0,a.kt)("br",null),"is ready to be used. This event will trigger at least once for each registered callback ",(0,a.kt)("br",null),"if the IShellFrame is already started and not yet stopped."),(0,a.kt)("td",{parentName:"tr",align:null})),(0,a.kt)("tr",{parentName:"tbody"},(0,a.kt)("td",{parentName:"tr",align:null},"ViewLocationChanged"),(0,a.kt)("td",{parentName:"tr",align:null},"Registers event handler for the IShellFrame ViewLocationChanged event, which means that the view location has changed."),(0,a.kt)("td",{parentName:"tr",align:null})),(0,a.kt)("tr",{parentName:"tbody"},(0,a.kt)("td",{parentName:"tr",align:null},"ViewLocationChangedAsync"),(0,a.kt)("td",{parentName:"tr",align:null},"Registers event handler for the IShellFrame ViewLocationChangedAsync event, which means that the view location has changed."),(0,a.kt)("td",{parentName:"tr",align:null})),(0,a.kt)("tr",{parentName:"tbody"},(0,a.kt)("td",{parentName:"tr",align:null},"NewCommands"),(0,a.kt)("td",{parentName:"tr",align:null},"Registers event handler for the IShellFrame NewCommands event, which means that a new ICommands interface has been created and is ready to be used."),(0,a.kt)("td",{parentName:"tr",align:null})),(0,a.kt)("tr",{parentName:"tbody"},(0,a.kt)("td",{parentName:"tr",align:null},"NewRightPane"),(0,a.kt)("td",{parentName:"tr",align:null},"Registers event handler for the IShellFrame NewRightPane event, which means that a shell pane container is created for right shell pane."),(0,a.kt)("td",{parentName:"tr",align:null})),(0,a.kt)("tr",{parentName:"tbody"},(0,a.kt)("td",{parentName:"tr",align:null},"NewShellListing"),(0,a.kt)("td",{parentName:"tr",align:null},"Registers event handler for the IShellFrame NewShellListing event, which means that a new shell listing object is created."),(0,a.kt)("td",{parentName:"tr",align:null},(0,a.kt)("strong",{parentName:"td"},"newShellisting")," The new IShellListing object.")))),(0,a.kt)("h2",{id:"ishelllistingevents"},"IShellListingEvents"),(0,a.kt)("p",null,"IShellListingEvents interface provides means to manage shell listing events. The interface provides two methods:"),(0,a.kt)("ul",null,(0,a.kt)("li",{parentName:"ul"},(0,a.kt)("strong",{parentName:"li"},"Register( event, callback )"),": Registers an event handler for the specified event and returns a handle identifying that registration."),(0,a.kt)("li",{parentName:"ul"},(0,a.kt)("strong",{parentName:"li"},"Unregister( eventHandlerID )"),": Unregisters a single handler using the handle returned by Register (this is the registration handle, NOT an event id).")),(0,a.kt)("table",null,(0,a.kt)("thead",{parentName:"table"},(0,a.kt)("tr",{parentName:"thead"},(0,a.kt)("th",{parentName:"tr",align:null},"Event"),(0,a.kt)("th",{parentName:"tr",align:null},"Description"),(0,a.kt)("th",{parentName:"tr",align:null},"Arguments"))),(0,a.kt)("tbody",{parentName:"table"},(0,a.kt)("tr",{parentName:"tbody"},(0,a.kt)("td",{parentName:"tr",align:null},"Started"),(0,a.kt)("td",{parentName:"tr",align:null},"Registers event handler for the IShellListingEvents started event."),(0,a.kt)("td",{parentName:"tr",align:null})),(0,a.kt)("tr",{parentName:"tbody"},(0,a.kt)("td",{parentName:"tr",align:null},"Stop"),(0,a.kt)("td",{parentName:"tr",align:null},"Registers event handler for the IShellListingEvents stopped event."),(0,a.kt)("td",{parentName:"tr",align:null})),(0,a.kt)("tr",{parentName:"tbody"},(0,a.kt)("td",{parentName:"tr",align:null},"SelectionChanged"),(0,a.kt)("td",{parentName:"tr",align:null},"Registers event handler for the IShellListingEvents SelectionChanged event. ",(0,a.kt)("br",null),"This event is triggered when the selection in the listing view is set, changed or removed."),(0,a.kt)("td",{parentName:"tr",align:null},(0,a.kt)("strong",{parentName:"td"},"shellItems")," Contains the selected items.")),(0,a.kt)("tr",{parentName:"tbody"},(0,a.kt)("td",{parentName:"tr",align:null},"SelectNextObject"),(0,a.kt)("td",{parentName:"tr",align:null},"Registers event handler for the IShellListingEvents SelectNextObject event. This event is triggered when the next object in the listing is selected."),(0,a.kt)("td",{parentName:"tr",align:null})),(0,a.kt)("tr",{parentName:"tbody"},(0,a.kt)("td",{parentName:"tr",align:null},"SelectPreviousObject"),(0,a.kt)("td",{parentName:"tr",align:null},"Registers event handler for the IShellListingEvents SelectPreviousObject event. This event is triggered when the previous object in the listing is selected."),(0,a.kt)("td",{parentName:"tr",align:null})),(0,a.kt)("tr",{parentName:"tbody"},(0,a.kt)("td",{parentName:"tr",align:null},"SelectNextFolder"),(0,a.kt)("td",{parentName:"tr",align:null},"Registers event handler for the IShellListingEvents SelectNextFolder event. This event is triggered when the next folder in the listing is selected."),(0,a.kt)("td",{parentName:"tr",align:null},(0,a.kt)("strong",{parentName:"td"},"folderType")," type of the folder, which have been selected.")),(0,a.kt)("tr",{parentName:"tbody"},(0,a.kt)("td",{parentName:"tr",align:null},"SelectPreviousFolder"),(0,a.kt)("td",{parentName:"tr",align:null},"Registers event handler for the IShellListingEvents SelectPreviousFolder event. This event is triggered when the previous folder in the listing is selected."),(0,a.kt)("td",{parentName:"tr",align:null},(0,a.kt)("strong",{parentName:"td"},"folderType")," type of the folder, which have been selected.")),(0,a.kt)("tr",{parentName:"tbody"},(0,a.kt)("td",{parentName:"tr",align:null},"ListingDeactivated"),(0,a.kt)("td",{parentName:"tr",align:null},"Registers event handler for the IShellListingEvents ListingDeactivated event. ",(0,a.kt)("br",null),"This event is triggered when the listing object becomes inactive and loses the input focus."),(0,a.kt)("td",{parentName:"tr",align:null},(0,a.kt)("strong",{parentName:"td"},"shellListing")," The next active shell listing object. Can be null.")),(0,a.kt)("tr",{parentName:"tbody"},(0,a.kt)("td",{parentName:"tr",align:null},"ListingActivated"),(0,a.kt)("td",{parentName:"tr",align:null},"Registers event handler for the IShellListingEvents ListingActivated event. ",(0,a.kt)("br",null),"This event is triggered when the listing object becomes active and receives the input focus."),(0,a.kt)("td",{parentName:"tr",align:null},(0,a.kt)("strong",{parentName:"td"},"shellListing")," The previous active shell listing object. Can be null.")),(0,a.kt)("tr",{parentName:"tbody"},(0,a.kt)("td",{parentName:"tr",align:null},"ContentChanged"),(0,a.kt)("td",{parentName:"tr",align:null},"Registers event handler for the IShellListingEvents ContentChanged event. ",(0,a.kt)("br",null),"This event is triggered when the current listing content is changed, or listed items are modified."),(0,a.kt)("td",{parentName:"tr",align:null},(0,a.kt)("strong",{parentName:"td"},"shellItems")," Contains all items in the listing.")),(0,a.kt)("tr",{parentName:"tbody"},(0,a.kt)("td",{parentName:"tr",align:null},"ListItemAdded"),(0,a.kt)("td",{parentName:"tr",align:null},"Registers event handler for the IShellListingEvents ListItemAdded event. This event is triggered when one or more items are added to the listing."),(0,a.kt)("td",{parentName:"tr",align:null},(0,a.kt)("strong",{parentName:"td"},"objectVersion")," Object")),(0,a.kt)("tr",{parentName:"tbody"},(0,a.kt)("td",{parentName:"tr",align:null},"ListItemRemoved"),(0,a.kt)("td",{parentName:"tr",align:null},"Registers event handler for the IShellListingEvents ListItemRemoved event. This event is triggered when one or more items are removed from the listing."),(0,a.kt)("td",{parentName:"tr",align:null},(0,a.kt)("strong",{parentName:"td"},"listItem")," Either an array of ObjectVersionEx if non-folder objects are removed or a single ObjectVersionEx, in case folder is removed. ",(0,a.kt)("br",null),(0,a.kt)("strong",{parentName:"td"},"removedExternalFolder")," In case folder was removed, include information about the old external folder item being removed in case of")),(0,a.kt)("tr",{parentName:"tbody"},(0,a.kt)("td",{parentName:"tr",align:null},"ListItemModified"),(0,a.kt)("td",{parentName:"tr",align:null},"Registers event handler for the IShellListingEvents ListItemModified event. ",(0,a.kt)("br",null),"This event is triggered when one or more of the items that are currently selected are modified."),(0,a.kt)("td",{parentName:"tr",align:null},(0,a.kt)("strong",{parentName:"td"},"oldServerObjVer")," Array of old object versions. ",(0,a.kt)("br",null),(0,a.kt)("strong",{parentName:"td"},"newObjVer")," Array of new objects.")),(0,a.kt)("tr",{parentName:"tbody"},(0,a.kt)("td",{parentName:"tr",align:null},"SelectedItemsChanged"),(0,a.kt)("td",{parentName:"tr",align:null},"Registers event handler for the IShellListingEvents SelectedItemsChanged event. ",(0,a.kt)("br",null),"This event is triggered when one or more of the items that are currently selected are modified."),(0,a.kt)("td",{parentName:"tr",align:null},(0,a.kt)("strong",{parentName:"td"},"shellItems")," Contains the selected items.")))),(0,a.kt)("h2",{id:"ishellpanecontainerevents"},"IShellPaneContainerEvents"),(0,a.kt)("p",null,"Interface for the Shell pane container events. The interface provides two methods:"),(0,a.kt)("ul",null,(0,a.kt)("li",{parentName:"ul"},(0,a.kt)("strong",{parentName:"li"},"Register( event, callback )"),": Registers an event handler for the specified event."),(0,a.kt)("li",{parentName:"ul"},(0,a.kt)("strong",{parentName:"li"},"Unregister( eventId )"),": Unregisters the event handler with the specified ID.")),(0,a.kt)("table",null,(0,a.kt)("thead",{parentName:"table"},(0,a.kt)("tr",{parentName:"thead"},(0,a.kt)("th",{parentName:"tr",align:null},"Event"),(0,a.kt)("th",{parentName:"tr",align:null},"Description"),(0,a.kt)("th",{parentName:"tr",align:null},"Arguments"))),(0,a.kt)("tbody",{parentName:"table"},(0,a.kt)("tr",{parentName:"tbody"},(0,a.kt)("td",{parentName:"tr",align:null},"Stop"),(0,a.kt)("td",{parentName:"tr",align:null},"Sent when the object turns to stopped state."),(0,a.kt)("td",{parentName:"tr",align:null})),(0,a.kt)("tr",{parentName:"tbody"},(0,a.kt)("td",{parentName:"tr",align:null},"Started"),(0,a.kt)("td",{parentName:"tr",align:null},"Sent when the object turns to started state."),(0,a.kt)("td",{parentName:"tr",align:null})))),(0,a.kt)("h2",{id:"ishellpanetabevents"},"IShellPaneTabEvents"),(0,a.kt)("p",null,"Interface for the Shell pane tab events. The interface provides two methods:"),(0,a.kt)("ul",null,(0,a.kt)("li",{parentName:"ul"},(0,a.kt)("strong",{parentName:"li"},"Register( event, callback )"),": Registers an event handler for the specified event."),(0,a.kt)("li",{parentName:"ul"},(0,a.kt)("strong",{parentName:"li"},"Unregister( eventId )"),": Unregisters the event handler with the specified ID.")),(0,a.kt)("table",null,(0,a.kt)("thead",{parentName:"table"},(0,a.kt)("tr",{parentName:"thead"},(0,a.kt)("th",{parentName:"tr",align:null},"Event"),(0,a.kt)("th",{parentName:"tr",align:null},"Description"),(0,a.kt)("th",{parentName:"tr",align:null},"Arguments"))),(0,a.kt)("tbody",{parentName:"table"},(0,a.kt)("tr",{parentName:"tbody"},(0,a.kt)("td",{parentName:"tr",align:null},"Started"),(0,a.kt)("td",{parentName:"tr",align:null},"Sent when the object turns to started state."),(0,a.kt)("td",{parentName:"tr",align:null})),(0,a.kt)("tr",{parentName:"tbody"},(0,a.kt)("td",{parentName:"tr",align:null},"Stop"),(0,a.kt)("td",{parentName:"tr",align:null},"Sent before the object is stopped."),(0,a.kt)("td",{parentName:"tr",align:null})))),(0,a.kt)("h2",{id:"iwindowevents"},"IWindowEvents"),(0,a.kt)("p",null,"Interface for the Window events. The interface provides two methods:"),(0,a.kt)("ul",null,(0,a.kt)("li",{parentName:"ul"},(0,a.kt)("strong",{parentName:"li"},"Register( event, callback )"),": Registers an event handler for the specified event."),(0,a.kt)("li",{parentName:"ul"},(0,a.kt)("strong",{parentName:"li"},"Unregister( eventId )"),": Unregisters the event handler with the specified ID.")),(0,a.kt)("table",null,(0,a.kt)("thead",{parentName:"table"},(0,a.kt)("tr",{parentName:"thead"},(0,a.kt)("th",{parentName:"tr",align:null},"Event"),(0,a.kt)("th",{parentName:"tr",align:null},"Description"),(0,a.kt)("th",{parentName:"tr",align:null},"Arguments"))),(0,a.kt)("tbody",{parentName:"table"},(0,a.kt)("tr",{parentName:"tbody"},(0,a.kt)("td",{parentName:"tr",align:null},"CloseWindow"),(0,a.kt)("td",{parentName:"tr",align:null},"Sent when the window is requested to closed."),(0,a.kt)("td",{parentName:"tr",align:null})))),(0,a.kt)("h2",{id:"ishelluievents"},"IShellUIEvents"),(0,a.kt)("p",null,"Interface for the Shell UI events. The interface provides two methods:"),(0,a.kt)("ul",null,(0,a.kt)("li",{parentName:"ul"},(0,a.kt)("strong",{parentName:"li"},"Register( event, callback )"),": Registers an event handler for the specified event."),(0,a.kt)("li",{parentName:"ul"},(0,a.kt)("strong",{parentName:"li"},"Unregister( eventId )"),": Unregisters the event handler with the specified ID.")),(0,a.kt)("table",null,(0,a.kt)("thead",{parentName:"table"},(0,a.kt)("tr",{parentName:"thead"},(0,a.kt)("th",{parentName:"tr",align:null},"Event"),(0,a.kt)("th",{parentName:"tr",align:null},"Description"),(0,a.kt)("th",{parentName:"tr",align:null},"Arguments"))),(0,a.kt)("tbody",{parentName:"table"},(0,a.kt)("tr",{parentName:"tbody"},(0,a.kt)("td",{parentName:"tr",align:null},"Started"),(0,a.kt)("td",{parentName:"tr",align:null},"Sent when the object turns to started state."),(0,a.kt)("td",{parentName:"tr",align:null})),(0,a.kt)("tr",{parentName:"tbody"},(0,a.kt)("td",{parentName:"tr",align:null},"Stop"),(0,a.kt)("td",{parentName:"tr",align:null},"Sent when the application is stopping."),(0,a.kt)("td",{parentName:"tr",align:null})),(0,a.kt)("tr",{parentName:"tbody"},(0,a.kt)("td",{parentName:"tr",align:null},"NewShellFrame"),(0,a.kt)("td",{parentName:"tr",align:null},"Triggered when any shell frame object is created, including normal shell frames, common dialogs, and embedded or special shell frames."),(0,a.kt)("td",{parentName:"tr",align:null},(0,a.kt)("strong",{parentName:"td"},"shellFrame")," - The new shell frame object.")),(0,a.kt)("tr",{parentName:"tbody"},(0,a.kt)("td",{parentName:"tr",align:null},"NewNormalShellFrame"),(0,a.kt)("td",{parentName:"tr",align:null},"Triggered when a normal shell frame object is created. ",(0,a.kt)("br",null),"Note that this event is not triggered for common dialogs, or embedded or special shell frames."),(0,a.kt)("td",{parentName:"tr",align:null},(0,a.kt)("strong",{parentName:"td"},"shellFrame")," - The new shell frame object.")),(0,a.kt)("tr",{parentName:"tbody"},(0,a.kt)("td",{parentName:"tr",align:null},"CrossApplicationNotification"),(0,a.kt)("td",{parentName:"tr",align:null},"Broadcasted message to multiple applications."),(0,a.kt)("td",{parentName:"tr",align:null},(0,a.kt)("strong",{parentName:"td"},"appGUID")," - GUID of the target application, or null if broadcasted to all applications. ",(0,a.kt)("br",null),(0,a.kt)("strong",{parentName:"td"},"msgId")," - ID of the message which is sent to the other applications. ",(0,a.kt)("br",null),(0,a.kt)("strong",{parentName:"td"},"data")," - Custom data to be sent.")),(0,a.kt)("tr",{parentName:"tbody"},(0,a.kt)("td",{parentName:"tr",align:null},"CheckInObjects"),(0,a.kt)("td",{parentName:"tr",align:null},"Triggered when the check in of one or more vault objects is requested. ",(0,a.kt)("br",null),"This event occurs before the request is passed to M-Files Server. ",(0,a.kt)("br",null)," ",(0,a.kt)("br",null),"Return a promise that resolves true to proceed, or Error object/false to cancel the operation. ",(0,a.kt)("br",null),"When resolving with an Error object, its message will be shown to the user, enabling you to provide a custom explanation for why the operation was stopped."),(0,a.kt)("td",{parentName:"tr",align:null},(0,a.kt)("strong",{parentName:"td"},"objVers")," - The object versions being checked in. ",(0,a.kt)("br",null),(0,a.kt)("strong",{parentName:"td"},"properties")," - The properties to add/replace during check-in. ",(0,a.kt)("br",null),(0,a.kt)("strong",{parentName:"td"},"options")," - Flags that control the operation.")),(0,a.kt)("tr",{parentName:"tbody"},(0,a.kt)("td",{parentName:"tr",align:null},"ObjectsCheckedIn"),(0,a.kt)("td",{parentName:"tr",align:null},"Triggered after the request to check in one or more vault objects succeeded on M-Files Server."),(0,a.kt)("td",{parentName:"tr",align:null},(0,a.kt)("strong",{parentName:"td"},"checkedInObjects")," - The extended object info for checked-in objects.")),(0,a.kt)("tr",{parentName:"tbody"},(0,a.kt)("td",{parentName:"tr",align:null},"CheckOutObjects"),(0,a.kt)("td",{parentName:"tr",align:null},"Triggered when the checking out of one or more vault objects is requested. ",(0,a.kt)("br",null),"This event occurs before the request is passed to M-Files Server. ",(0,a.kt)("br",null)," ",(0,a.kt)("br",null),"Return a promise that resolves true to proceed, or Error object/false to cancel the operation. ",(0,a.kt)("br",null),"When resolving with an Error object, its message will be shown to the user, enabling you to provide a custom explanation for why the operation was stopped."),(0,a.kt)("td",{parentName:"tr",align:null},(0,a.kt)("strong",{parentName:"td"},"objIds")," - The objects being checked out.")),(0,a.kt)("tr",{parentName:"tbody"},(0,a.kt)("td",{parentName:"tr",align:null},"ObjectsCheckedOut"),(0,a.kt)("td",{parentName:"tr",align:null},"Triggered after the request to check out one or more vault objects succeeded on M-Files Server."),(0,a.kt)("td",{parentName:"tr",align:null},(0,a.kt)("strong",{parentName:"td"},"checkedOutVersions")," - The new checked-out object versions with properties and ACL. ",(0,a.kt)("br",null),(0,a.kt)("strong",{parentName:"td"},"previousVersions")," - The previous versions before checkout.")),(0,a.kt)("tr",{parentName:"tbody"},(0,a.kt)("td",{parentName:"tr",align:null},"UndoObjectCheckouts"),(0,a.kt)("td",{parentName:"tr",align:null},"Triggered when the undoing checkout of one or more vault objects is requested. ",(0,a.kt)("br",null),"This event occurs before the request is passed to M-Files Server. ",(0,a.kt)("br",null)," ",(0,a.kt)("br",null),"Return a promise that resolves true to proceed, or Error object/false to cancel the operation. ",(0,a.kt)("br",null),"When resolving with an Error object, its message will be shown to the user, enabling you to provide a custom explanation for why the operation was stopped."),(0,a.kt)("td",{parentName:"tr",align:null},(0,a.kt)("strong",{parentName:"td"},"objVers")," - The checked-out object versions being reverted. ",(0,a.kt)("br",null),(0,a.kt)("strong",{parentName:"td"},"force")," - If true, undo checkout is performed even if not checked out to the caller.")),(0,a.kt)("tr",{parentName:"tbody"},(0,a.kt)("td",{parentName:"tr",align:null},"ObjectCheckoutsUndone"),(0,a.kt)("td",{parentName:"tr",align:null},"Triggered after the request to undo checkout of one or more vault objects succeeded on M-Files Server."),(0,a.kt)("td",{parentName:"tr",align:null},(0,a.kt)("strong",{parentName:"td"},"restoredObjects")," - The extended object info for restored objects.")),(0,a.kt)("tr",{parentName:"tbody"},(0,a.kt)("td",{parentName:"tr",align:null},"DestroyObjects"),(0,a.kt)("td",{parentName:"tr",align:null},"Triggered when the destruction of one or more vault objects is requested. ",(0,a.kt)("br",null),"This event occurs before the request is passed to M-Files Server. ",(0,a.kt)("br",null)," ",(0,a.kt)("br",null),"Return a promise that resolves true to proceed, or Error object/false to cancel the operation. ",(0,a.kt)("br",null),"When resolving with an Error object, its message will be shown to the user, enabling you to provide a custom explanation for why the operation was stopped."),(0,a.kt)("td",{parentName:"tr",align:null},(0,a.kt)("strong",{parentName:"td"},"objIds")," - The objects being permanently destroyed.")),(0,a.kt)("tr",{parentName:"tbody"},(0,a.kt)("td",{parentName:"tr",align:null},"ObjectsDestroyed"),(0,a.kt)("td",{parentName:"tr",align:null},"Triggered after the request to destroy one or more vault objects succeeded on M-Files Server.",(0,a.kt)("br",null),(0,a.kt)("br",null),"NOTE: Stability is experimental. Non-backward compatible changes or removal may occur in any future release. Use of this feature is not recommended for production environments."),(0,a.kt)("td",{parentName:"tr",align:null},(0,a.kt)("strong",{parentName:"td"},"updatedObjects")," - Information about objects that were also updated during the operation.")),(0,a.kt)("tr",{parentName:"tbody"},(0,a.kt)("td",{parentName:"tr",align:null},"DestroyObjectVersions"),(0,a.kt)("td",{parentName:"tr",align:null},"Triggered when the destruction of one or more object versions is requested. ",(0,a.kt)("br",null),"This event occurs before the request is passed to M-Files Server. ",(0,a.kt)("br",null)," ",(0,a.kt)("br",null),"Return a promise that resolves true to proceed, or Error object/false to cancel the operation. ",(0,a.kt)("br",null),"When resolving with an Error object, its message will be shown to the user, enabling you to provide a custom explanation for why the operation was stopped.",(0,a.kt)("br",null),(0,a.kt)("br",null),"NOTE: Stability is experimental. Non-backward compatible changes or removal may occur in any future release. Use of this feature is not recommended for production environments."),(0,a.kt)("td",{parentName:"tr",align:null},(0,a.kt)("strong",{parentName:"td"},"objVers")," - The object versions being permanently destroyed.")),(0,a.kt)("tr",{parentName:"tbody"},(0,a.kt)("td",{parentName:"tr",align:null},"ObjectVersionsDestroyed"),(0,a.kt)("td",{parentName:"tr",align:null},"Triggered after the request to destroy one or more object versions succeeded on M-Files Server.",(0,a.kt)("br",null),(0,a.kt)("br",null),"NOTE: Stability is experimental. Non-backward compatible changes or removal may occur in any future release. Use of this feature is not recommended for production environments."),(0,a.kt)("td",{parentName:"tr",align:null},(0,a.kt)("strong",{parentName:"td"},"updatedObjects")," - Information about objects that were also updated during the operation.")),(0,a.kt)("tr",{parentName:"tbody"},(0,a.kt)("td",{parentName:"tr",align:null},"RemoveObjects"),(0,a.kt)("td",{parentName:"tr",align:null},"Triggered when the deletion of one or more vault objects is requested. ",(0,a.kt)("br",null),"This event occurs before the request is passed to M-Files Server. ",(0,a.kt)("br",null)," ",(0,a.kt)("br",null),"Return a promise that resolves true to proceed, or Error object/false to cancel the operation. ",(0,a.kt)("br",null),"When resolving with an Error object, its message will be shown to the user, enabling you to provide a custom explanation for why the operation was stopped."),(0,a.kt)("td",{parentName:"tr",align:null},(0,a.kt)("strong",{parentName:"td"},"objIds")," - The objects being deleted.")),(0,a.kt)("tr",{parentName:"tbody"},(0,a.kt)("td",{parentName:"tr",align:null},"ObjectsRemoved"),(0,a.kt)("td",{parentName:"tr",align:null},"Triggered after the request to delete one or more vault objects succeeded on M-Files Server."),(0,a.kt)("td",{parentName:"tr",align:null},(0,a.kt)("strong",{parentName:"td"},"deletedObjects")," - The extended object info for deleted objects.")),(0,a.kt)("tr",{parentName:"tbody"},(0,a.kt)("td",{parentName:"tr",align:null},"UndeleteObjects"),(0,a.kt)("td",{parentName:"tr",align:null},"Triggered when the undeletion of one or more vault objects is requested. ",(0,a.kt)("br",null),"This event occurs before the request is passed to M-Files Server. ",(0,a.kt)("br",null)," ",(0,a.kt)("br",null),"Return a promise that resolves true to proceed, or Error object/false to cancel the operation. ",(0,a.kt)("br",null),"When resolving with an Error object, its message will be shown to the user, enabling you to provide a custom explanation for why the operation was stopped.",(0,a.kt)("br",null),(0,a.kt)("br",null),"NOTE: Stability is experimental. Non-backward compatible changes or removal may occur in any future release. Use of this feature is not recommended for production environments."),(0,a.kt)("td",{parentName:"tr",align:null},(0,a.kt)("strong",{parentName:"td"},"objIds")," - The objects being restored from deletion.")),(0,a.kt)("tr",{parentName:"tbody"},(0,a.kt)("td",{parentName:"tr",align:null},"ObjectsUndeleted"),(0,a.kt)("td",{parentName:"tr",align:null},"Triggered after the request to undelete one or more vault objects succeeded on M-Files Server.",(0,a.kt)("br",null),(0,a.kt)("br",null),"NOTE: Stability is experimental. Non-backward compatible changes or removal may occur in any future release. Use of this feature is not recommended for production environments."),(0,a.kt)("td",{parentName:"tr",align:null},(0,a.kt)("strong",{parentName:"td"},"extObjectInfos")," - The extended object info for undeleted objects.")),(0,a.kt)("tr",{parentName:"tbody"},(0,a.kt)("td",{parentName:"tr",align:null},"RemoveObjectFile"),(0,a.kt)("td",{parentName:"tr",align:null},"Triggered when the removal of a file from an object version is requested. ",(0,a.kt)("br",null),"This event occurs before the request is passed to M-Files Server. ",(0,a.kt)("br",null)," ",(0,a.kt)("br",null),"Return a promise that resolves true to proceed, or Error object/false to cancel the operation. ",(0,a.kt)("br",null),"When resolving with an Error object, its message will be shown to the user, enabling you to provide a custom explanation for why the operation was stopped."),(0,a.kt)("td",{parentName:"tr",align:null},(0,a.kt)("strong",{parentName:"td"},"objVer")," - The object version from which the file is being removed. ",(0,a.kt)("br",null),(0,a.kt)("strong",{parentName:"td"},"fileVer")," - The file being removed.")),(0,a.kt)("tr",{parentName:"tbody"},(0,a.kt)("td",{parentName:"tr",align:null},"ObjectFileRemoved"),(0,a.kt)("td",{parentName:"tr",align:null},"Triggered after a request to remove an object file from an object version succeeds on M-Files Server."),(0,a.kt)("td",{parentName:"tr",align:null},(0,a.kt)("strong",{parentName:"td"},"objectVersion")," - Information about the latest version of the document after the operation.")),(0,a.kt)("tr",{parentName:"tbody"},(0,a.kt)("td",{parentName:"tr",align:null},"RollBackObjectVersion"),(0,a.kt)("td",{parentName:"tr",align:null},"Triggered when the roll back of a previous vault object version is requested. ",(0,a.kt)("br",null),"This event occurs before the request is passed to M-Files Server. ",(0,a.kt)("br",null)," ",(0,a.kt)("br",null),"Return a promise that resolves true to proceed, or Error object/false to cancel the operation. ",(0,a.kt)("br",null),"When resolving with an Error object, its message will be shown to the user, enabling you to provide a custom explanation for why the operation was stopped.",(0,a.kt)("br",null),(0,a.kt)("br",null),"NOTE: Stability is experimental. Non-backward compatible changes or removal may occur in any future release. Use of this feature is not recommended for production environments."),(0,a.kt)("td",{parentName:"tr",align:null},(0,a.kt)("strong",{parentName:"td"},"objId")," - The object to roll back. ",(0,a.kt)("br",null),(0,a.kt)("strong",{parentName:"td"},"rollbackVersion")," - The version to roll back to. A new version is created using this as source.")),(0,a.kt)("tr",{parentName:"tbody"},(0,a.kt)("td",{parentName:"tr",align:null},"ObjectVersionRolledBack"),(0,a.kt)("td",{parentName:"tr",align:null},"Triggered after a request to roll back a previous vault object version succeeds on M-Files Server.",(0,a.kt)("br",null),(0,a.kt)("br",null),"NOTE: Stability is experimental. Non-backward compatible changes or removal may occur in any future release. Use of this feature is not recommended for production environments."),(0,a.kt)("td",{parentName:"tr",align:null},(0,a.kt)("strong",{parentName:"td"},"extObjectInfo")," - Information about the object after the operation.")),(0,a.kt)("tr",{parentName:"tbody"},(0,a.kt)("td",{parentName:"tr",align:null},"CreateObject"),(0,a.kt)("td",{parentName:"tr",align:null},"Triggered when the creation of a new object is requested. ",(0,a.kt)("br",null),"This event occurs before the request is passed to M-Files Server. ",(0,a.kt)("br",null)," ",(0,a.kt)("br",null),"Return a promise that resolves true to proceed, or Error object/false to cancel the operation. ",(0,a.kt)("br",null),"When resolving with an Error object, its message will be shown to the user, enabling you to provide a custom explanation for why the operation was stopped."),(0,a.kt)("td",{parentName:"tr",align:null},(0,a.kt)("strong",{parentName:"td"},"objectTypeId")," - The object type ID for the new object. ",(0,a.kt)("br",null),(0,a.kt)("strong",{parentName:"td"},"properties")," - The properties for the new object. ",(0,a.kt)("br",null),(0,a.kt)("strong",{parentName:"td"},"acl")," - The access control list for the new object. ",(0,a.kt)("br",null),(0,a.kt)("strong",{parentName:"td"},"options")," - Flags that control the operation. ",(0,a.kt)("br",null),(0,a.kt)("strong",{parentName:"td"},"checkIn")," - If true, the object is checked in immediately after creation. ",(0,a.kt)("br",null),(0,a.kt)("strong",{parentName:"td"},"objFileSources")," - The file sources for the new object.")),(0,a.kt)("tr",{parentName:"tbody"},(0,a.kt)("td",{parentName:"tr",align:null},"ObjectCreated"),(0,a.kt)("td",{parentName:"tr",align:null},"Triggered after the request to create a new object succeeded on M-Files Server."),(0,a.kt)("td",{parentName:"tr",align:null},(0,a.kt)("strong",{parentName:"td"},"isVisibleToUser")," - True if the created object is visible to the user. ",(0,a.kt)("br",null),(0,a.kt)("strong",{parentName:"td"},"createdObject")," - The created object with properties and ACL.")),(0,a.kt)("tr",{parentName:"tbody"},(0,a.kt)("td",{parentName:"tr",align:null},"AddObjectFile"),(0,a.kt)("td",{parentName:"tr",align:null},"Triggered when the addition of a new file to a document is requested. ",(0,a.kt)("br",null),"This event occurs before the request is passed to M-Files Server. ",(0,a.kt)("br",null)," ",(0,a.kt)("br",null),"Return a promise that resolves true to proceed, or Error object/false to cancel the operation. ",(0,a.kt)("br",null),"When resolving with an Error object, its message will be shown to the user, enabling you to provide a custom explanation for why the operation was stopped."),(0,a.kt)("td",{parentName:"tr",align:null},(0,a.kt)("strong",{parentName:"td"},"objVer")," - The object version to which the file is being added. ",(0,a.kt)("br",null),(0,a.kt)("strong",{parentName:"td"},"title")," - The title of the new file. ",(0,a.kt)("br",null),(0,a.kt)("strong",{parentName:"td"},"extension")," - The file extension (without the leading dot). ",(0,a.kt)("br",null),(0,a.kt)("strong",{parentName:"td"},"createdAtUtc")," - The UTC timestamp when the file was originally created. ",(0,a.kt)("br",null),(0,a.kt)("strong",{parentName:"td"},"accessedAtUtc")," - The UTC timestamp when the file was last accessed. ",(0,a.kt)("br",null),(0,a.kt)("strong",{parentName:"td"},"writtenAtUtc")," - The UTC timestamp when the file was last written to. ",(0,a.kt)("br",null),(0,a.kt)("strong",{parentName:"td"},"changedAtUtc")," - The UTC timestamp when the file was last changed (content or attributes).")),(0,a.kt)("tr",{parentName:"tbody"},(0,a.kt)("td",{parentName:"tr",align:null},"ObjectFileAdded"),(0,a.kt)("td",{parentName:"tr",align:null},"Triggered after a request to add a file to a document succeeds on M-Files Server."),(0,a.kt)("td",{parentName:"tr",align:null},(0,a.kt)("strong",{parentName:"td"},"fileVer")," - The version information of the added file. ",(0,a.kt)("br",null),(0,a.kt)("strong",{parentName:"td"},"objectVersion")," - The object version after the file was added.")),(0,a.kt)("tr",{parentName:"tbody"},(0,a.kt)("td",{parentName:"tr",align:null},"RenameObjectFile"),(0,a.kt)("td",{parentName:"tr",align:null},"Triggered when the renaming of a file in a document is requested. ",(0,a.kt)("br",null),"This event occurs before the request is passed to M-Files Server. ",(0,a.kt)("br",null)," ",(0,a.kt)("br",null),"Return a promise that resolves true to proceed, or Error object/false to cancel the operation. ",(0,a.kt)("br",null),"When resolving with an Error object, its message will be shown to the user, enabling you to provide a custom explanation for why the operation was stopped."),(0,a.kt)("td",{parentName:"tr",align:null},(0,a.kt)("strong",{parentName:"td"},"objVer")," - The object version containing the file. ",(0,a.kt)("br",null),(0,a.kt)("strong",{parentName:"td"},"fileVer")," - The file being renamed. ",(0,a.kt)("br",null),(0,a.kt)("strong",{parentName:"td"},"title")," - The new title for the file. ",(0,a.kt)("br",null),(0,a.kt)("strong",{parentName:"td"},"extension")," - The new extension for the file (without the leading dot).")),(0,a.kt)("tr",{parentName:"tbody"},(0,a.kt)("td",{parentName:"tr",align:null},"ObjectFileRenamed"),(0,a.kt)("td",{parentName:"tr",align:null},"Triggered after a request to rename a file in a document succeeds on M-Files Server."),(0,a.kt)("td",{parentName:"tr",align:null},(0,a.kt)("strong",{parentName:"td"},"objectVersion")," - The object version after the file was renamed.")),(0,a.kt)("tr",{parentName:"tbody"},(0,a.kt)("td",{parentName:"tr",align:null},"SetPropertiesOfObjectVersions"),(0,a.kt)("td",{parentName:"tr",align:null},"Triggered when setting properties for one or more object versions is requested. ",(0,a.kt)("br",null),"This event occurs before the request is passed to M-Files Server. ",(0,a.kt)("br",null)," ",(0,a.kt)("br",null),"Return a promise that resolves true to proceed, or Error object/false to cancel the operation. ",(0,a.kt)("br",null),"When resolving with an Error object, its message will be shown to the user, enabling you to provide a custom explanation for why the operation was stopped."),(0,a.kt)("td",{parentName:"tr",align:null},(0,a.kt)("strong",{parentName:"td"},"setPropertiesParams")," - Array of parameters for setting properties on multiple objects.")),(0,a.kt)("tr",{parentName:"tbody"},(0,a.kt)("td",{parentName:"tr",align:null},"PropertiesOfObjectVersionsSet"),(0,a.kt)("td",{parentName:"tr",align:null},"Triggered after a request to set properties of one or more object versions succeeds on M-Files Server."),(0,a.kt)("td",{parentName:"tr",align:null},(0,a.kt)("strong",{parentName:"td"},"extObjectInfos")," - Extended object info for each object after the properties were set.")),(0,a.kt)("tr",{parentName:"tbody"},(0,a.kt)("td",{parentName:"tr",align:null},"SetObjectVersionPermissions"),(0,a.kt)("td",{parentName:"tr",align:null},"Triggered when changing the permissions of an object version is requested. ",(0,a.kt)("br",null),"This event occurs before the request is passed to M-Files Server. ",(0,a.kt)("br",null)," ",(0,a.kt)("br",null),"Return a promise that resolves true to proceed, or Error object/false to cancel the operation. ",(0,a.kt)("br",null),"When resolving with an Error object, its message will be shown to the user, enabling you to provide a custom explanation for why the operation was stopped."),(0,a.kt)("td",{parentName:"tr",align:null},(0,a.kt)("strong",{parentName:"td"},"objVer")," - The object version whose permissions are being changed. ",(0,a.kt)("br",null),(0,a.kt)("strong",{parentName:"td"},"acl")," - The new access control list. ",(0,a.kt)("br",null),(0,a.kt)("strong",{parentName:"td"},"options")," - Flags that control the operation.")),(0,a.kt)("tr",{parentName:"tbody"},(0,a.kt)("td",{parentName:"tr",align:null},"ObjectVersionPermissionsSet"),(0,a.kt)("td",{parentName:"tr",align:null},"Triggered after a request to change the permissions of an object version succeeds on M-Files Server."),(0,a.kt)("td",{parentName:"tr",align:null},(0,a.kt)("strong",{parentName:"td"},"isSpecifiedVersionStillVisible")," - True if the specified version is still visible after the operation. ",(0,a.kt)("br",null),(0,a.kt)("strong",{parentName:"td"},"specifiedVersion")," - Information about the specified version after the operation. ",(0,a.kt)("br",null),(0,a.kt)("strong",{parentName:"td"},"extObjectInfo")," - Extended object info after the operation.")),(0,a.kt)("tr",{parentName:"tbody"},(0,a.kt)("td",{parentName:"tr",align:null},"SetObjectLevelProperty"),(0,a.kt)("td",{parentName:"tr",align:null},"Triggered when setting an object-level property is requested. ",(0,a.kt)("br",null),"This event occurs before the request is passed to M-Files Server. ",(0,a.kt)("br",null)," ",(0,a.kt)("br",null),"Return a promise that resolves true to proceed, or Error object/false to cancel the operation. ",(0,a.kt)("br",null),"When resolving with an Error object, its message will be shown to the user, enabling you to provide a custom explanation for why the operation was stopped."),(0,a.kt)("td",{parentName:"tr",align:null},(0,a.kt)("strong",{parentName:"td"},"objId")," - The object whose property is being set. ",(0,a.kt)("br",null),(0,a.kt)("strong",{parentName:"td"},"property")," - The property value to set. ",(0,a.kt)("br",null),(0,a.kt)("strong",{parentName:"td"},"options")," - Flags that control the operation.")),(0,a.kt)("tr",{parentName:"tbody"},(0,a.kt)("td",{parentName:"tr",align:null},"ObjectLevelPropertySet"),(0,a.kt)("td",{parentName:"tr",align:null},"Triggered after a request to set an object-level property succeeds on M-Files Server."),(0,a.kt)("td",{parentName:"tr",align:null},(0,a.kt)("strong",{parentName:"td"},"extObjectInfo")," - Extended object info after the operation.")),(0,a.kt)("tr",{parentName:"tbody"},(0,a.kt)("td",{parentName:"tr",align:null},"ModifyObjectVersionLabels"),(0,a.kt)("td",{parentName:"tr",align:null},"Triggered when modifying the labels of an object version is requested. ",(0,a.kt)("br",null),"This event occurs before the request is passed to M-Files Server. ",(0,a.kt)("br",null)," ",(0,a.kt)("br",null),"Return a promise that resolves true to proceed, or Error object/false to cancel the operation. ",(0,a.kt)("br",null),"When resolving with an Error object, its message will be shown to the user, enabling you to provide a custom explanation for why the operation was stopped.",(0,a.kt)("br",null),(0,a.kt)("br",null),"NOTE: Stability is experimental. Non-backward compatible changes or removal may occur in any future release. Use of this feature is not recommended for production environments."),(0,a.kt)("td",{parentName:"tr",align:null},(0,a.kt)("strong",{parentName:"td"},"objVer")," - The object version whose labels are being modified. ",(0,a.kt)("br",null),(0,a.kt)("strong",{parentName:"td"},"clearFromOtherVersions")," - If true, the specified labels are cleared from other versions. ",(0,a.kt)("br",null),(0,a.kt)("strong",{parentName:"td"},"append")," - If true, the labels are appended to existing labels; if false, existing labels are replaced. ",(0,a.kt)("br",null),(0,a.kt)("strong",{parentName:"td"},"labelIDs")," - The IDs of the labels to set.")),(0,a.kt)("tr",{parentName:"tbody"},(0,a.kt)("td",{parentName:"tr",align:null},"ObjectVersionLabelsModified"),(0,a.kt)("td",{parentName:"tr",align:null},"Triggered after a request to modify the labels of an object version succeeds on M-Files Server.",(0,a.kt)("br",null),(0,a.kt)("br",null),"NOTE: Stability is experimental. Non-backward compatible changes or removal may occur in any future release. Use of this feature is not recommended for production environments."),(0,a.kt)("td",{parentName:"tr",align:null},(0,a.kt)("strong",{parentName:"td"},"objVer")," - The object version whose labels were modified. ",(0,a.kt)("br",null),(0,a.kt)("strong",{parentName:"td"},"clearFromOtherVersions")," - If true, the specified labels were cleared from other versions. ",(0,a.kt)("br",null),(0,a.kt)("strong",{parentName:"td"},"append")," - If true, the labels were appended to existing labels. ",(0,a.kt)("br",null),(0,a.kt)("strong",{parentName:"td"},"labelIDs")," - The IDs of the labels that were set.")),(0,a.kt)("tr",{parentName:"tbody"},(0,a.kt)("td",{parentName:"tr",align:null},"ChangeVaultLanguage"),(0,a.kt)("td",{parentName:"tr",align:null},"Triggered when changing the vault language is requested. ",(0,a.kt)("br",null),"This event occurs before the request is passed to M-Files Server.",(0,a.kt)("br",null),(0,a.kt)("br",null),"NOTE: Stability is experimental. Non-backward compatible changes or removal may occur in any future release. Use of this feature is not recommended for production environments."),(0,a.kt)("td",{parentName:"tr",align:null},(0,a.kt)("strong",{parentName:"td"},"languageId")," - The ID of the new vault language.")),(0,a.kt)("tr",{parentName:"tbody"},(0,a.kt)("td",{parentName:"tr",align:null},"VaultLanguageChanged"),(0,a.kt)("td",{parentName:"tr",align:null},"Triggered after the vault language has been changed.",(0,a.kt)("br",null),(0,a.kt)("br",null),"NOTE: Stability is experimental. Non-backward compatible changes or removal may occur in any future release. Use of this feature is not recommended for production environments."),(0,a.kt)("td",{parentName:"tr",align:null},(0,a.kt)("strong",{parentName:"td"},"languageId")," - The ID of the new vault language.")),(0,a.kt)("tr",{parentName:"tbody"},(0,a.kt)("td",{parentName:"tr",align:null},"LogOut"),(0,a.kt)("td",{parentName:"tr",align:null},"Triggered when logging out of the vault is requested. ",(0,a.kt)("br",null),"This event occurs before the logout is processed.",(0,a.kt)("br",null),(0,a.kt)("br",null),"NOTE: Stability is experimental. Non-backward compatible changes or removal may occur in any future release. Use of this feature is not recommended for production environments."),(0,a.kt)("td",{parentName:"tr",align:null})))),(0,a.kt)("h2",{id:"icommandsevents"},"ICommandsEvents"),(0,a.kt)("p",null,"Ths ICommandEvents interface provides methods to register and unregister event handlers for custom commands:"),(0,a.kt)("ul",null,(0,a.kt)("li",{parentName:"ul"},(0,a.kt)("strong",{parentName:"li"},"Register( event, callback )"),": Registers an event handler for the specified event and returns the event handler ID."),(0,a.kt)("li",{parentName:"ul"},(0,a.kt)("strong",{parentName:"li"},"Unregister( eventId )"),": Unregisters the event handler with the specified ID.")),(0,a.kt)("p",null,"The ",(0,a.kt)("a",{parentName:"p",href:"../Interfaces/ICommands/"},"ICommands")," interface has Events property, which provides access to the ICommandsEvents interface."),(0,a.kt)("p",null,"Here is a JavaScript example of how to use the ICommandsEvents interface to listen for custom command events and their data:"),(0,a.kt)("pre",null,(0,a.kt)("code",{parentName:"pre",className:"language-typescript"},'const commandsEvents = shellFrame.Commands.Events;\n// Register event handler for the custom command\nconst eventId = await commandsEvents.Register(\n Event.CustomCommand,\n (commandID, data) => {\n console.log("Custom command invoked: ", commandID);\n console.log("Data: ", data);\n },\n);\n')),(0,a.kt)("table",null,(0,a.kt)("thead",{parentName:"table"},(0,a.kt)("tr",{parentName:"thead"},(0,a.kt)("th",{parentName:"tr",align:null},"Event"),(0,a.kt)("th",{parentName:"tr",align:null},"Description"),(0,a.kt)("th",{parentName:"tr",align:null},"Arguments"))),(0,a.kt)("tbody",{parentName:"table"},(0,a.kt)("tr",{parentName:"tbody"},(0,a.kt)("td",{parentName:"tr",align:null},"CustomCommand"),(0,a.kt)("td",{parentName:"tr",align:null},"Triggered when a custom command is invoked."),(0,a.kt)("td",{parentName:"tr",align:null},(0,a.kt)("strong",{parentName:"td"},"commandID")," The ID of the custom command to be used. ",(0,a.kt)("br",null),(0,a.kt)("strong",{parentName:"td"},"data")," The data passed to the custom command.")),(0,a.kt)("tr",{parentName:"tbody"},(0,a.kt)("td",{parentName:"tr",align:null},"BuiltinCommand"),(0,a.kt)("td",{parentName:"tr",align:null},"Callback handler for Builtin commands. ",(0,a.kt)("br",null)," ",(0,a.kt)("br",null),"Allows UI Extensibility applications to intercept and optionally cancel built-in command execution."),(0,a.kt)("td",{parentName:"tr",align:null},"argument of type ( commandId : BuiltinCommand, param : any ) =",">"," Promise","<"," boolean ",">")))))}u.isMDXComponent=!0}}]); \ No newline at end of file diff --git a/Frameworks/User-Interface-Extensibility-Framework/Reference/assets/js/37ee5f99.fada9eb0.js b/Frameworks/User-Interface-Extensibility-Framework/Reference/assets/js/37ee5f99.fada9eb0.js deleted file mode 100644 index 6f6080632..000000000 --- a/Frameworks/User-Interface-Extensibility-Framework/Reference/assets/js/37ee5f99.fada9eb0.js +++ /dev/null @@ -1 +0,0 @@ -"use strict";(self.webpackChunkuix_2=self.webpackChunkuix_2||[]).push([[1170],{3905:(e,t,n)=>{n.d(t,{Zo:()=>p,kt:()=>c});var r=n(67294);function a(e,t,n){return t in e?Object.defineProperty(e,t,{value:n,enumerable:!0,configurable:!0,writable:!0}):e[t]=n,e}function l(e,t){var n=Object.keys(e);if(Object.getOwnPropertySymbols){var r=Object.getOwnPropertySymbols(e);t&&(r=r.filter((function(t){return Object.getOwnPropertyDescriptor(e,t).enumerable}))),n.push.apply(n,r)}return n}function o(e){for(var t=1;t=0||(a[n]=e[n]);return a}(e,t);if(Object.getOwnPropertySymbols){var l=Object.getOwnPropertySymbols(e);for(r=0;r=0||Object.prototype.propertyIsEnumerable.call(e,n)&&(a[n]=e[n])}return a}var s=r.createContext({}),d=function(e){var t=r.useContext(s),n=t;return e&&(n="function"==typeof e?e(t):o(o({},t),e)),n},p=function(e){var t=d(e.components);return r.createElement(s.Provider,{value:t},e.children)},m="mdxType",u={inlineCode:"code",wrapper:function(e){var t=e.children;return r.createElement(r.Fragment,{},t)}},h=r.forwardRef((function(e,t){var n=e.components,a=e.mdxType,l=e.originalType,s=e.parentName,p=i(e,["components","mdxType","originalType","parentName"]),m=d(n),h=a,c=m["".concat(s,".").concat(h)]||m[h]||u[h]||l;return n?r.createElement(c,o(o({ref:t},p),{},{components:n})):r.createElement(c,o({ref:t},p))}));function c(e,t){var n=arguments,a=t&&t.mdxType;if("string"==typeof e||a){var l=n.length,o=new Array(l);o[0]=h;var i={};for(var s in t)hasOwnProperty.call(t,s)&&(i[s]=t[s]);i.originalType=e,i[m]="string"==typeof e?e:a,o[1]=i;for(var d=2;d{n.r(t),n.d(t,{assets:()=>s,contentTitle:()=>o,default:()=>u,frontMatter:()=>l,metadata:()=>i,toc:()=>d});var r=n(87462),a=(n(67294),n(3905));const l={sidebar_position:1},o=void 0,i={unversionedId:"UIExt2/Events",id:"UIExt2/Events",title:"Events",description:"ISearchPaneEvents",source:"@site/docs/UIExt2/Events.mdx",sourceDirName:"UIExt2",slug:"/UIExt2/Events",permalink:"/Frameworks/User-Interface-Extensibility-Framework/Reference/UIExt2/Events",draft:!1,tags:[],version:"current",sidebarPosition:1,frontMatter:{sidebar_position:1},sidebar:"tutorialSidebar",previous:{title:"API Reference Guide",permalink:"/Frameworks/User-Interface-Extensibility-Framework/Reference/UIExt2/"},next:{title:"Enums",permalink:"/Frameworks/User-Interface-Extensibility-Framework/Reference/UIExt2/Enums/"}},s={},d=[{value:"ISearchPaneEvents",id:"isearchpaneevents",level:2},{value:"IDashboardEvents",id:"idashboardevents",level:2},{value:"IShellFrameEvents",id:"ishellframeevents",level:2},{value:"IShellListingEvents",id:"ishelllistingevents",level:2},{value:"IShellPaneContainerEvents",id:"ishellpanecontainerevents",level:2},{value:"IShellPaneTabEvents",id:"ishellpanetabevents",level:2},{value:"IWindowEvents",id:"iwindowevents",level:2},{value:"IShellUIEvents",id:"ishelluievents",level:2},{value:"ICommandsEvents",id:"icommandsevents",level:2}],p={toc:d},m="wrapper";function u(e){let{components:t,...n}=e;return(0,a.kt)(m,(0,r.Z)({},p,n,{components:t,mdxType:"MDXLayout"}),(0,a.kt)("h2",{id:"isearchpaneevents"},"ISearchPaneEvents"),(0,a.kt)("p",null,"Interface for the Search pane events. The interface provides two methods:"),(0,a.kt)("ul",null,(0,a.kt)("li",{parentName:"ul"},(0,a.kt)("strong",{parentName:"li"},"Register( event, callback )"),": Registers an event handler for the specified event."),(0,a.kt)("li",{parentName:"ul"},(0,a.kt)("strong",{parentName:"li"},"Unregister( eventId )"),": Unregisters the event handler with the specified ID.")),(0,a.kt)("table",null,(0,a.kt)("thead",{parentName:"table"},(0,a.kt)("tr",{parentName:"thead"},(0,a.kt)("th",{parentName:"tr",align:null},"Event"),(0,a.kt)("th",{parentName:"tr",align:null},"Description"),(0,a.kt)("th",{parentName:"tr",align:null},"Arguments"))),(0,a.kt)("tbody",{parentName:"table"},(0,a.kt)("tr",{parentName:"tbody"},(0,a.kt)("td",{parentName:"tr",align:null},"Stop"),(0,a.kt)("td",{parentName:"tr",align:null},"Sent before the Searchpane is closed."),(0,a.kt)("td",{parentName:"tr",align:null})),(0,a.kt)("tr",{parentName:"tbody"},(0,a.kt)("td",{parentName:"tr",align:null},"Started"),(0,a.kt)("td",{parentName:"tr",align:null},"Registers event handler for the Search pane started event, which means that the Search pane ",(0,a.kt)("br",null),"is ready to be used."),(0,a.kt)("td",{parentName:"tr",align:null})))),(0,a.kt)("h2",{id:"idashboardevents"},"IDashboardEvents"),(0,a.kt)("p",null,"The IDashboard interface has Events property, which provides access to the IDashboardEvents interface. This interface provides two methods:"),(0,a.kt)("ul",null,(0,a.kt)("li",{parentName:"ul"},(0,a.kt)("strong",{parentName:"li"},"Register( event, callback )"),": Registers an event handler for the specified event and returns the event handler ID."),(0,a.kt)("li",{parentName:"ul"},(0,a.kt)("strong",{parentName:"li"},"Unregister( eventId )"),": Unregisters the event handler with the specified ID.")),(0,a.kt)("p",null,"One of the use cases for events in IDashboard is to listen for custom data changes provided by UpdateCustomData method."),(0,a.kt)("p",null,"Here is a JavaScript example of how to use the IDashboardEvents interface to listen for custom data changes using globally defined events."),(0,a.kt)("pre",null,(0,a.kt)("code",{parentName:"pre",className:"language-javascript"},'// Register event handler for the custom data changes.\nconst eventId = await dashboard.Events.Register(\n MFiles.Event.CustomDataChanged,\n (data) => {\n console.log("Custom data changed: ", data);\n },\n);\n')),(0,a.kt)("table",null,(0,a.kt)("thead",{parentName:"table"},(0,a.kt)("tr",{parentName:"thead"},(0,a.kt)("th",{parentName:"tr",align:null},"Event"),(0,a.kt)("th",{parentName:"tr",align:null},"Description"),(0,a.kt)("th",{parentName:"tr",align:null},"Arguments"))),(0,a.kt)("tbody",{parentName:"table"},(0,a.kt)("tr",{parentName:"tbody"},(0,a.kt)("td",{parentName:"tr",align:null},"Refresh"),(0,a.kt)("td",{parentName:"tr",align:null},"Triggered when the dashboard data is refreshed."),(0,a.kt)("td",{parentName:"tr",align:null})),(0,a.kt)("tr",{parentName:"tbody"},(0,a.kt)("td",{parentName:"tr",align:null},"Started"),(0,a.kt)("td",{parentName:"tr",align:null},"Sent when the dashboard turns to started state."),(0,a.kt)("td",{parentName:"tr",align:null})),(0,a.kt)("tr",{parentName:"tbody"},(0,a.kt)("td",{parentName:"tr",align:null},"Stop"),(0,a.kt)("td",{parentName:"tr",align:null},"Sent before the dashboard is stopped."),(0,a.kt)("td",{parentName:"tr",align:null})),(0,a.kt)("tr",{parentName:"tbody"},(0,a.kt)("td",{parentName:"tr",align:null},"CustomDataChanged"),(0,a.kt)("td",{parentName:"tr",align:null},"This event is triggered, when custom data on dashboard has changed. The event can be ",(0,a.kt)("br",null),"used to update the dashboard based on the new data. This event will fire at least ",(0,a.kt)("br",null),"once when the dashboard is started and initialized."),(0,a.kt)("td",{parentName:"tr",align:null},(0,a.kt)("strong",{parentName:"td"},"data")," New custom data for the dashboard")))),(0,a.kt)("h2",{id:"ishellframeevents"},"IShellFrameEvents"),(0,a.kt)("p",null,"IShellFrameEvents interface provides means to manage shell frame events. The interface provides two methods:"),(0,a.kt)("ul",null,(0,a.kt)("li",{parentName:"ul"},(0,a.kt)("strong",{parentName:"li"},"Register( event, callback )"),": Registers an event handler for the specified event."),(0,a.kt)("li",{parentName:"ul"},(0,a.kt)("strong",{parentName:"li"},"Unregister( eventId )"),": Unregisters the event handler with the specified ID.")),(0,a.kt)("table",null,(0,a.kt)("thead",{parentName:"table"},(0,a.kt)("tr",{parentName:"thead"},(0,a.kt)("th",{parentName:"tr",align:null},"Event"),(0,a.kt)("th",{parentName:"tr",align:null},"Description"),(0,a.kt)("th",{parentName:"tr",align:null},"Arguments"))),(0,a.kt)("tbody",{parentName:"table"},(0,a.kt)("tr",{parentName:"tbody"},(0,a.kt)("td",{parentName:"tr",align:null},"Stop"),(0,a.kt)("td",{parentName:"tr",align:null},"Sent before the IShellFrame is stopped."),(0,a.kt)("td",{parentName:"tr",align:null})),(0,a.kt)("tr",{parentName:"tbody"},(0,a.kt)("td",{parentName:"tr",align:null},"Started"),(0,a.kt)("td",{parentName:"tr",align:null},"Registers event handler for the IShellFrame started event, which means that the IShellFrame ",(0,a.kt)("br",null),"is ready to be used. This event will trigger at least once for each registered callback ",(0,a.kt)("br",null),"if the IShellFrame is already started and not yet stopped."),(0,a.kt)("td",{parentName:"tr",align:null})),(0,a.kt)("tr",{parentName:"tbody"},(0,a.kt)("td",{parentName:"tr",align:null},"ViewLocationChanged"),(0,a.kt)("td",{parentName:"tr",align:null},"Registers event handler for the IShellFrame ViewLocationChanged event, which means that the view location has changed."),(0,a.kt)("td",{parentName:"tr",align:null})),(0,a.kt)("tr",{parentName:"tbody"},(0,a.kt)("td",{parentName:"tr",align:null},"ViewLocationChangedAsync"),(0,a.kt)("td",{parentName:"tr",align:null},"Registers event handler for the IShellFrame ViewLocationChangedAsync event, which means that the view location has changed."),(0,a.kt)("td",{parentName:"tr",align:null})),(0,a.kt)("tr",{parentName:"tbody"},(0,a.kt)("td",{parentName:"tr",align:null},"NewCommands"),(0,a.kt)("td",{parentName:"tr",align:null},"Registers event handler for the IShellFrame NewCommands event, which means that a new ICommands interface has been created and is ready to be used."),(0,a.kt)("td",{parentName:"tr",align:null})),(0,a.kt)("tr",{parentName:"tbody"},(0,a.kt)("td",{parentName:"tr",align:null},"NewRightPane"),(0,a.kt)("td",{parentName:"tr",align:null},"Registers event handler for the IShellFrame NewRightPane event, which means that a shell pane container is created for right shell pane."),(0,a.kt)("td",{parentName:"tr",align:null})),(0,a.kt)("tr",{parentName:"tbody"},(0,a.kt)("td",{parentName:"tr",align:null},"NewShellListing"),(0,a.kt)("td",{parentName:"tr",align:null},"Registers event handler for the IShellFrame NewShellListing event, which means that a new shell listing object is created."),(0,a.kt)("td",{parentName:"tr",align:null},(0,a.kt)("strong",{parentName:"td"},"newShellisting")," The new IShellListing object.")))),(0,a.kt)("h2",{id:"ishelllistingevents"},"IShellListingEvents"),(0,a.kt)("p",null,"IShellListingEvents interface provides means to manage shell listing events. The interface provides two methods:"),(0,a.kt)("ul",null,(0,a.kt)("li",{parentName:"ul"},(0,a.kt)("strong",{parentName:"li"},"Register( event, callback )"),": Registers an event handler for the specified event."),(0,a.kt)("li",{parentName:"ul"},(0,a.kt)("strong",{parentName:"li"},"Unregister( eventId )"),": Unregisters the event handler with the specified ID.")),(0,a.kt)("table",null,(0,a.kt)("thead",{parentName:"table"},(0,a.kt)("tr",{parentName:"thead"},(0,a.kt)("th",{parentName:"tr",align:null},"Event"),(0,a.kt)("th",{parentName:"tr",align:null},"Description"),(0,a.kt)("th",{parentName:"tr",align:null},"Arguments"))),(0,a.kt)("tbody",{parentName:"table"},(0,a.kt)("tr",{parentName:"tbody"},(0,a.kt)("td",{parentName:"tr",align:null},"Started"),(0,a.kt)("td",{parentName:"tr",align:null},"Registers event handler for the IShellListingEvents started event."),(0,a.kt)("td",{parentName:"tr",align:null})),(0,a.kt)("tr",{parentName:"tbody"},(0,a.kt)("td",{parentName:"tr",align:null},"Stop"),(0,a.kt)("td",{parentName:"tr",align:null},"Registers event handler for the IShellListingEvents stopped event."),(0,a.kt)("td",{parentName:"tr",align:null})),(0,a.kt)("tr",{parentName:"tbody"},(0,a.kt)("td",{parentName:"tr",align:null},"SelectionChanged"),(0,a.kt)("td",{parentName:"tr",align:null},"Registers event handler for the IShellListingEvents SelectionChanged event. ",(0,a.kt)("br",null),"This event is triggered when the selection in the listing view is set, changed or removed."),(0,a.kt)("td",{parentName:"tr",align:null},(0,a.kt)("strong",{parentName:"td"},"shellItems")," Contains the selected items.")),(0,a.kt)("tr",{parentName:"tbody"},(0,a.kt)("td",{parentName:"tr",align:null},"SelectNextObject"),(0,a.kt)("td",{parentName:"tr",align:null},"Registers event handler for the IShellListingEvents SelectNextObject event. This event is triggered when the next object in the listing is selected."),(0,a.kt)("td",{parentName:"tr",align:null})),(0,a.kt)("tr",{parentName:"tbody"},(0,a.kt)("td",{parentName:"tr",align:null},"SelectPreviousObject"),(0,a.kt)("td",{parentName:"tr",align:null},"Registers event handler for the IShellListingEvents SelectPreviousObject event. This event is triggered when the previous object in the listing is selected."),(0,a.kt)("td",{parentName:"tr",align:null})),(0,a.kt)("tr",{parentName:"tbody"},(0,a.kt)("td",{parentName:"tr",align:null},"SelectNextFolder"),(0,a.kt)("td",{parentName:"tr",align:null},"Registers event handler for the IShellListingEvents SelectNextFolder event. This event is triggered when the next folder in the listing is selected."),(0,a.kt)("td",{parentName:"tr",align:null},(0,a.kt)("strong",{parentName:"td"},"folderType")," type of the folder, which have been selected.")),(0,a.kt)("tr",{parentName:"tbody"},(0,a.kt)("td",{parentName:"tr",align:null},"SelectPreviousFolder"),(0,a.kt)("td",{parentName:"tr",align:null},"Registers event handler for the IShellListingEvents SelectPreviousFolder event. This event is triggered when the previous folder in the listing is selected."),(0,a.kt)("td",{parentName:"tr",align:null},(0,a.kt)("strong",{parentName:"td"},"folderType")," type of the folder, which have been selected.")),(0,a.kt)("tr",{parentName:"tbody"},(0,a.kt)("td",{parentName:"tr",align:null},"ListingDeactivated"),(0,a.kt)("td",{parentName:"tr",align:null},"Registers event handler for the IShellListingEvents ListingDeactivated event. ",(0,a.kt)("br",null),"This event is triggered when the listing object becomes inactive and loses the input focus."),(0,a.kt)("td",{parentName:"tr",align:null},(0,a.kt)("strong",{parentName:"td"},"shellListing")," The next active shell listing object. Can be null.")),(0,a.kt)("tr",{parentName:"tbody"},(0,a.kt)("td",{parentName:"tr",align:null},"ListingActivated"),(0,a.kt)("td",{parentName:"tr",align:null},"Registers event handler for the IShellListingEvents ListingActivated event. ",(0,a.kt)("br",null),"This event is triggered when the listing object becomes active and receives the input focus."),(0,a.kt)("td",{parentName:"tr",align:null},(0,a.kt)("strong",{parentName:"td"},"shellListing")," The previous active shell listing object. Can be null.")),(0,a.kt)("tr",{parentName:"tbody"},(0,a.kt)("td",{parentName:"tr",align:null},"ContentChanged"),(0,a.kt)("td",{parentName:"tr",align:null},"Registers event handler for the IShellListingEvents ContentChanged event. ",(0,a.kt)("br",null),"This event is triggered when the current listing content is changed, or listed items are modified."),(0,a.kt)("td",{parentName:"tr",align:null},(0,a.kt)("strong",{parentName:"td"},"shellItems")," Contains all items in the listing.")),(0,a.kt)("tr",{parentName:"tbody"},(0,a.kt)("td",{parentName:"tr",align:null},"ListItemAdded"),(0,a.kt)("td",{parentName:"tr",align:null},"Registers event handler for the IShellListingEvents ListItemAdded event. This event is triggered when one or more items are added to the listing."),(0,a.kt)("td",{parentName:"tr",align:null},(0,a.kt)("strong",{parentName:"td"},"objectVersion")," Object")),(0,a.kt)("tr",{parentName:"tbody"},(0,a.kt)("td",{parentName:"tr",align:null},"ListItemRemoved"),(0,a.kt)("td",{parentName:"tr",align:null},"Registers event handler for the IShellListingEvents ListItemRemoved event. This event is triggered when one or more items are removed from the listing."),(0,a.kt)("td",{parentName:"tr",align:null},(0,a.kt)("strong",{parentName:"td"},"listItem")," Either an array of ObjectVersionEx if non-folder objects are removed or a single ObjectVersionEx, in case folder is removed. ",(0,a.kt)("br",null),(0,a.kt)("strong",{parentName:"td"},"removedExternalFolder")," In case folder was removed, include information about the old external folder item being removed in case of")),(0,a.kt)("tr",{parentName:"tbody"},(0,a.kt)("td",{parentName:"tr",align:null},"ListItemModified"),(0,a.kt)("td",{parentName:"tr",align:null},"Registers event handler for the IShellListingEvents ListItemModified event. ",(0,a.kt)("br",null),"This event is triggered when one or more of the items that are currently selected are modified."),(0,a.kt)("td",{parentName:"tr",align:null},(0,a.kt)("strong",{parentName:"td"},"oldServerObjVer")," Array of old object versions. ",(0,a.kt)("br",null),(0,a.kt)("strong",{parentName:"td"},"newObjVer")," Array of new objects.")),(0,a.kt)("tr",{parentName:"tbody"},(0,a.kt)("td",{parentName:"tr",align:null},"SelectedItemsChanged"),(0,a.kt)("td",{parentName:"tr",align:null},"Registers event handler for the IShellListingEvents SelectedItemsChanged event. ",(0,a.kt)("br",null),"This event is triggered when one or more of the items that are currently selected are modified."),(0,a.kt)("td",{parentName:"tr",align:null},(0,a.kt)("strong",{parentName:"td"},"shellItems")," Contains the selected items.")))),(0,a.kt)("h2",{id:"ishellpanecontainerevents"},"IShellPaneContainerEvents"),(0,a.kt)("p",null,"Interface for the Shell pane container events. The interface provides two methods:"),(0,a.kt)("ul",null,(0,a.kt)("li",{parentName:"ul"},(0,a.kt)("strong",{parentName:"li"},"Register( event, callback )"),": Registers an event handler for the specified event."),(0,a.kt)("li",{parentName:"ul"},(0,a.kt)("strong",{parentName:"li"},"Unregister( eventId )"),": Unregisters the event handler with the specified ID.")),(0,a.kt)("table",null,(0,a.kt)("thead",{parentName:"table"},(0,a.kt)("tr",{parentName:"thead"},(0,a.kt)("th",{parentName:"tr",align:null},"Event"),(0,a.kt)("th",{parentName:"tr",align:null},"Description"),(0,a.kt)("th",{parentName:"tr",align:null},"Arguments"))),(0,a.kt)("tbody",{parentName:"table"},(0,a.kt)("tr",{parentName:"tbody"},(0,a.kt)("td",{parentName:"tr",align:null},"Stop"),(0,a.kt)("td",{parentName:"tr",align:null},"Sent when the object turns to stopped state."),(0,a.kt)("td",{parentName:"tr",align:null})),(0,a.kt)("tr",{parentName:"tbody"},(0,a.kt)("td",{parentName:"tr",align:null},"Started"),(0,a.kt)("td",{parentName:"tr",align:null},"Sent when the object turns to started state."),(0,a.kt)("td",{parentName:"tr",align:null})))),(0,a.kt)("h2",{id:"ishellpanetabevents"},"IShellPaneTabEvents"),(0,a.kt)("p",null,"Interface for the Shell pane tab events. The interface provides two methods:"),(0,a.kt)("ul",null,(0,a.kt)("li",{parentName:"ul"},(0,a.kt)("strong",{parentName:"li"},"Register( event, callback )"),": Registers an event handler for the specified event."),(0,a.kt)("li",{parentName:"ul"},(0,a.kt)("strong",{parentName:"li"},"Unregister( eventId )"),": Unregisters the event handler with the specified ID.")),(0,a.kt)("table",null,(0,a.kt)("thead",{parentName:"table"},(0,a.kt)("tr",{parentName:"thead"},(0,a.kt)("th",{parentName:"tr",align:null},"Event"),(0,a.kt)("th",{parentName:"tr",align:null},"Description"),(0,a.kt)("th",{parentName:"tr",align:null},"Arguments"))),(0,a.kt)("tbody",{parentName:"table"},(0,a.kt)("tr",{parentName:"tbody"},(0,a.kt)("td",{parentName:"tr",align:null},"Started"),(0,a.kt)("td",{parentName:"tr",align:null},"Sent when the object turns to started state."),(0,a.kt)("td",{parentName:"tr",align:null})),(0,a.kt)("tr",{parentName:"tbody"},(0,a.kt)("td",{parentName:"tr",align:null},"Stop"),(0,a.kt)("td",{parentName:"tr",align:null},"Sent before the object is stopped."),(0,a.kt)("td",{parentName:"tr",align:null})))),(0,a.kt)("h2",{id:"iwindowevents"},"IWindowEvents"),(0,a.kt)("p",null,"Interface for the Window events. The interface provides two methods:"),(0,a.kt)("ul",null,(0,a.kt)("li",{parentName:"ul"},(0,a.kt)("strong",{parentName:"li"},"Register( event, callback )"),": Registers an event handler for the specified event."),(0,a.kt)("li",{parentName:"ul"},(0,a.kt)("strong",{parentName:"li"},"Unregister( eventId )"),": Unregisters the event handler with the specified ID.")),(0,a.kt)("table",null,(0,a.kt)("thead",{parentName:"table"},(0,a.kt)("tr",{parentName:"thead"},(0,a.kt)("th",{parentName:"tr",align:null},"Event"),(0,a.kt)("th",{parentName:"tr",align:null},"Description"),(0,a.kt)("th",{parentName:"tr",align:null},"Arguments"))),(0,a.kt)("tbody",{parentName:"table"},(0,a.kt)("tr",{parentName:"tbody"},(0,a.kt)("td",{parentName:"tr",align:null},"CloseWindow"),(0,a.kt)("td",{parentName:"tr",align:null},"Sent when the window is requested to closed."),(0,a.kt)("td",{parentName:"tr",align:null})))),(0,a.kt)("h2",{id:"ishelluievents"},"IShellUIEvents"),(0,a.kt)("p",null,"Interface for the Shell UI events. The interface provides two methods:"),(0,a.kt)("ul",null,(0,a.kt)("li",{parentName:"ul"},(0,a.kt)("strong",{parentName:"li"},"Register( event, callback )"),": Registers an event handler for the specified event."),(0,a.kt)("li",{parentName:"ul"},(0,a.kt)("strong",{parentName:"li"},"Unregister( eventId )"),": Unregisters the event handler with the specified ID.")),(0,a.kt)("table",null,(0,a.kt)("thead",{parentName:"table"},(0,a.kt)("tr",{parentName:"thead"},(0,a.kt)("th",{parentName:"tr",align:null},"Event"),(0,a.kt)("th",{parentName:"tr",align:null},"Description"),(0,a.kt)("th",{parentName:"tr",align:null},"Arguments"))),(0,a.kt)("tbody",{parentName:"table"},(0,a.kt)("tr",{parentName:"tbody"},(0,a.kt)("td",{parentName:"tr",align:null},"Started"),(0,a.kt)("td",{parentName:"tr",align:null},"Sent when the object turns to started state."),(0,a.kt)("td",{parentName:"tr",align:null})),(0,a.kt)("tr",{parentName:"tbody"},(0,a.kt)("td",{parentName:"tr",align:null},"Stop"),(0,a.kt)("td",{parentName:"tr",align:null},"Sent when the application is stopping."),(0,a.kt)("td",{parentName:"tr",align:null})),(0,a.kt)("tr",{parentName:"tbody"},(0,a.kt)("td",{parentName:"tr",align:null},"NewShellFrame"),(0,a.kt)("td",{parentName:"tr",align:null},"Triggered when any shell frame object is created, including normal shell frames, common dialogs, and embedded or special shell frames."),(0,a.kt)("td",{parentName:"tr",align:null},(0,a.kt)("strong",{parentName:"td"},"shellFrame")," - The new shell frame object.")),(0,a.kt)("tr",{parentName:"tbody"},(0,a.kt)("td",{parentName:"tr",align:null},"NewNormalShellFrame"),(0,a.kt)("td",{parentName:"tr",align:null},"Triggered when a normal shell frame object is created. ",(0,a.kt)("br",null),"Note that this event is not triggered for common dialogs, or embedded or special shell frames."),(0,a.kt)("td",{parentName:"tr",align:null},(0,a.kt)("strong",{parentName:"td"},"shellFrame")," - The new shell frame object.")),(0,a.kt)("tr",{parentName:"tbody"},(0,a.kt)("td",{parentName:"tr",align:null},"CrossApplicationNotification"),(0,a.kt)("td",{parentName:"tr",align:null},"Broadcasted message to multiple applications."),(0,a.kt)("td",{parentName:"tr",align:null},(0,a.kt)("strong",{parentName:"td"},"appGUID")," - GUID of the target application, or null if broadcasted to all applications. ",(0,a.kt)("br",null),(0,a.kt)("strong",{parentName:"td"},"msgId")," - ID of the message which is sent to the other applications. ",(0,a.kt)("br",null),(0,a.kt)("strong",{parentName:"td"},"data")," - Custom data to be sent.")),(0,a.kt)("tr",{parentName:"tbody"},(0,a.kt)("td",{parentName:"tr",align:null},"CheckInObjects"),(0,a.kt)("td",{parentName:"tr",align:null},"Triggered when the check in of one or more vault objects is requested. ",(0,a.kt)("br",null),"This event occurs before the request is passed to M-Files Server. ",(0,a.kt)("br",null)," ",(0,a.kt)("br",null),"Return a promise that resolves true to proceed, or Error object/false to cancel the operation. ",(0,a.kt)("br",null),"When resolving with an Error object, its message will be shown to the user, enabling you to provide a custom explanation for why the operation was stopped."),(0,a.kt)("td",{parentName:"tr",align:null},(0,a.kt)("strong",{parentName:"td"},"objVers")," - The object versions being checked in. ",(0,a.kt)("br",null),(0,a.kt)("strong",{parentName:"td"},"properties")," - The properties to add/replace during check-in. ",(0,a.kt)("br",null),(0,a.kt)("strong",{parentName:"td"},"options")," - Flags that control the operation.")),(0,a.kt)("tr",{parentName:"tbody"},(0,a.kt)("td",{parentName:"tr",align:null},"ObjectsCheckedIn"),(0,a.kt)("td",{parentName:"tr",align:null},"Triggered after the request to check in one or more vault objects succeeded on M-Files Server."),(0,a.kt)("td",{parentName:"tr",align:null},(0,a.kt)("strong",{parentName:"td"},"checkedInObjects")," - The extended object info for checked-in objects.")),(0,a.kt)("tr",{parentName:"tbody"},(0,a.kt)("td",{parentName:"tr",align:null},"CheckOutObjects"),(0,a.kt)("td",{parentName:"tr",align:null},"Triggered when the checking out of one or more vault objects is requested. ",(0,a.kt)("br",null),"This event occurs before the request is passed to M-Files Server. ",(0,a.kt)("br",null)," ",(0,a.kt)("br",null),"Return a promise that resolves true to proceed, or Error object/false to cancel the operation. ",(0,a.kt)("br",null),"When resolving with an Error object, its message will be shown to the user, enabling you to provide a custom explanation for why the operation was stopped."),(0,a.kt)("td",{parentName:"tr",align:null},(0,a.kt)("strong",{parentName:"td"},"objIds")," - The objects being checked out.")),(0,a.kt)("tr",{parentName:"tbody"},(0,a.kt)("td",{parentName:"tr",align:null},"ObjectsCheckedOut"),(0,a.kt)("td",{parentName:"tr",align:null},"Triggered after the request to check out one or more vault objects succeeded on M-Files Server."),(0,a.kt)("td",{parentName:"tr",align:null},(0,a.kt)("strong",{parentName:"td"},"checkedOutVersions")," - The new checked-out object versions with properties and ACL. ",(0,a.kt)("br",null),(0,a.kt)("strong",{parentName:"td"},"previousVersions")," - The previous versions before checkout.")),(0,a.kt)("tr",{parentName:"tbody"},(0,a.kt)("td",{parentName:"tr",align:null},"UndoObjectCheckouts"),(0,a.kt)("td",{parentName:"tr",align:null},"Triggered when the undoing checkout of one or more vault objects is requested. ",(0,a.kt)("br",null),"This event occurs before the request is passed to M-Files Server. ",(0,a.kt)("br",null)," ",(0,a.kt)("br",null),"Return a promise that resolves true to proceed, or Error object/false to cancel the operation. ",(0,a.kt)("br",null),"When resolving with an Error object, its message will be shown to the user, enabling you to provide a custom explanation for why the operation was stopped."),(0,a.kt)("td",{parentName:"tr",align:null},(0,a.kt)("strong",{parentName:"td"},"objVers")," - The checked-out object versions being reverted. ",(0,a.kt)("br",null),(0,a.kt)("strong",{parentName:"td"},"force")," - If true, undo checkout is performed even if not checked out to the caller.")),(0,a.kt)("tr",{parentName:"tbody"},(0,a.kt)("td",{parentName:"tr",align:null},"ObjectCheckoutsUndone"),(0,a.kt)("td",{parentName:"tr",align:null},"Triggered after the request to undo checkout of one or more vault objects succeeded on M-Files Server."),(0,a.kt)("td",{parentName:"tr",align:null},(0,a.kt)("strong",{parentName:"td"},"restoredObjects")," - The extended object info for restored objects.")),(0,a.kt)("tr",{parentName:"tbody"},(0,a.kt)("td",{parentName:"tr",align:null},"DestroyObjects"),(0,a.kt)("td",{parentName:"tr",align:null},"Triggered when the destruction of one or more vault objects is requested. ",(0,a.kt)("br",null),"This event occurs before the request is passed to M-Files Server. ",(0,a.kt)("br",null)," ",(0,a.kt)("br",null),"Return a promise that resolves true to proceed, or Error object/false to cancel the operation. ",(0,a.kt)("br",null),"When resolving with an Error object, its message will be shown to the user, enabling you to provide a custom explanation for why the operation was stopped."),(0,a.kt)("td",{parentName:"tr",align:null},(0,a.kt)("strong",{parentName:"td"},"objIds")," - The objects being permanently destroyed.")),(0,a.kt)("tr",{parentName:"tbody"},(0,a.kt)("td",{parentName:"tr",align:null},"ObjectsDestroyed"),(0,a.kt)("td",{parentName:"tr",align:null},"Triggered after the request to destroy one or more vault objects succeeded on M-Files Server.",(0,a.kt)("br",null),(0,a.kt)("br",null),"NOTE: Stability is experimental. Non-backward compatible changes or removal may occur in any future release. Use of this feature is not recommended for production environments."),(0,a.kt)("td",{parentName:"tr",align:null},(0,a.kt)("strong",{parentName:"td"},"updatedObjects")," - Information about objects that were also updated during the operation.")),(0,a.kt)("tr",{parentName:"tbody"},(0,a.kt)("td",{parentName:"tr",align:null},"DestroyObjectVersions"),(0,a.kt)("td",{parentName:"tr",align:null},"Triggered when the destruction of one or more object versions is requested. ",(0,a.kt)("br",null),"This event occurs before the request is passed to M-Files Server. ",(0,a.kt)("br",null)," ",(0,a.kt)("br",null),"Return a promise that resolves true to proceed, or Error object/false to cancel the operation. ",(0,a.kt)("br",null),"When resolving with an Error object, its message will be shown to the user, enabling you to provide a custom explanation for why the operation was stopped.",(0,a.kt)("br",null),(0,a.kt)("br",null),"NOTE: Stability is experimental. Non-backward compatible changes or removal may occur in any future release. Use of this feature is not recommended for production environments."),(0,a.kt)("td",{parentName:"tr",align:null},(0,a.kt)("strong",{parentName:"td"},"objVers")," - The object versions being permanently destroyed.")),(0,a.kt)("tr",{parentName:"tbody"},(0,a.kt)("td",{parentName:"tr",align:null},"ObjectVersionsDestroyed"),(0,a.kt)("td",{parentName:"tr",align:null},"Triggered after the request to destroy one or more object versions succeeded on M-Files Server.",(0,a.kt)("br",null),(0,a.kt)("br",null),"NOTE: Stability is experimental. Non-backward compatible changes or removal may occur in any future release. Use of this feature is not recommended for production environments."),(0,a.kt)("td",{parentName:"tr",align:null},(0,a.kt)("strong",{parentName:"td"},"updatedObjects")," - Information about objects that were also updated during the operation.")),(0,a.kt)("tr",{parentName:"tbody"},(0,a.kt)("td",{parentName:"tr",align:null},"RemoveObjects"),(0,a.kt)("td",{parentName:"tr",align:null},"Triggered when the deletion of one or more vault objects is requested. ",(0,a.kt)("br",null),"This event occurs before the request is passed to M-Files Server. ",(0,a.kt)("br",null)," ",(0,a.kt)("br",null),"Return a promise that resolves true to proceed, or Error object/false to cancel the operation. ",(0,a.kt)("br",null),"When resolving with an Error object, its message will be shown to the user, enabling you to provide a custom explanation for why the operation was stopped."),(0,a.kt)("td",{parentName:"tr",align:null},(0,a.kt)("strong",{parentName:"td"},"objIds")," - The objects being deleted.")),(0,a.kt)("tr",{parentName:"tbody"},(0,a.kt)("td",{parentName:"tr",align:null},"ObjectsRemoved"),(0,a.kt)("td",{parentName:"tr",align:null},"Triggered after the request to delete one or more vault objects succeeded on M-Files Server."),(0,a.kt)("td",{parentName:"tr",align:null},(0,a.kt)("strong",{parentName:"td"},"deletedObjects")," - The extended object info for deleted objects.")),(0,a.kt)("tr",{parentName:"tbody"},(0,a.kt)("td",{parentName:"tr",align:null},"UndeleteObjects"),(0,a.kt)("td",{parentName:"tr",align:null},"Triggered when the undeletion of one or more vault objects is requested. ",(0,a.kt)("br",null),"This event occurs before the request is passed to M-Files Server. ",(0,a.kt)("br",null)," ",(0,a.kt)("br",null),"Return a promise that resolves true to proceed, or Error object/false to cancel the operation. ",(0,a.kt)("br",null),"When resolving with an Error object, its message will be shown to the user, enabling you to provide a custom explanation for why the operation was stopped.",(0,a.kt)("br",null),(0,a.kt)("br",null),"NOTE: Stability is experimental. Non-backward compatible changes or removal may occur in any future release. Use of this feature is not recommended for production environments."),(0,a.kt)("td",{parentName:"tr",align:null},(0,a.kt)("strong",{parentName:"td"},"objIds")," - The objects being restored from deletion.")),(0,a.kt)("tr",{parentName:"tbody"},(0,a.kt)("td",{parentName:"tr",align:null},"ObjectsUndeleted"),(0,a.kt)("td",{parentName:"tr",align:null},"Triggered after the request to undelete one or more vault objects succeeded on M-Files Server.",(0,a.kt)("br",null),(0,a.kt)("br",null),"NOTE: Stability is experimental. Non-backward compatible changes or removal may occur in any future release. Use of this feature is not recommended for production environments."),(0,a.kt)("td",{parentName:"tr",align:null},(0,a.kt)("strong",{parentName:"td"},"extObjectInfos")," - The extended object info for undeleted objects.")),(0,a.kt)("tr",{parentName:"tbody"},(0,a.kt)("td",{parentName:"tr",align:null},"RemoveObjectFile"),(0,a.kt)("td",{parentName:"tr",align:null},"Triggered when the removal of a file from an object version is requested. ",(0,a.kt)("br",null),"This event occurs before the request is passed to M-Files Server. ",(0,a.kt)("br",null)," ",(0,a.kt)("br",null),"Return a promise that resolves true to proceed, or Error object/false to cancel the operation. ",(0,a.kt)("br",null),"When resolving with an Error object, its message will be shown to the user, enabling you to provide a custom explanation for why the operation was stopped."),(0,a.kt)("td",{parentName:"tr",align:null},(0,a.kt)("strong",{parentName:"td"},"objVer")," - The object version from which the file is being removed. ",(0,a.kt)("br",null),(0,a.kt)("strong",{parentName:"td"},"fileVer")," - The file being removed.")),(0,a.kt)("tr",{parentName:"tbody"},(0,a.kt)("td",{parentName:"tr",align:null},"ObjectFileRemoved"),(0,a.kt)("td",{parentName:"tr",align:null},"Triggered after a request to remove an object file from an object version succeeds on M-Files Server."),(0,a.kt)("td",{parentName:"tr",align:null},(0,a.kt)("strong",{parentName:"td"},"objectVersion")," - Information about the latest version of the document after the operation.")),(0,a.kt)("tr",{parentName:"tbody"},(0,a.kt)("td",{parentName:"tr",align:null},"RollBackObjectVersion"),(0,a.kt)("td",{parentName:"tr",align:null},"Triggered when the roll back of a previous vault object version is requested. ",(0,a.kt)("br",null),"This event occurs before the request is passed to M-Files Server. ",(0,a.kt)("br",null)," ",(0,a.kt)("br",null),"Return a promise that resolves true to proceed, or Error object/false to cancel the operation. ",(0,a.kt)("br",null),"When resolving with an Error object, its message will be shown to the user, enabling you to provide a custom explanation for why the operation was stopped.",(0,a.kt)("br",null),(0,a.kt)("br",null),"NOTE: Stability is experimental. Non-backward compatible changes or removal may occur in any future release. Use of this feature is not recommended for production environments."),(0,a.kt)("td",{parentName:"tr",align:null},(0,a.kt)("strong",{parentName:"td"},"objId")," - The object to roll back. ",(0,a.kt)("br",null),(0,a.kt)("strong",{parentName:"td"},"rollbackVersion")," - The version to roll back to. A new version is created using this as source.")),(0,a.kt)("tr",{parentName:"tbody"},(0,a.kt)("td",{parentName:"tr",align:null},"ObjectVersionRolledBack"),(0,a.kt)("td",{parentName:"tr",align:null},"Triggered after a request to roll back a previous vault object version succeeds on M-Files Server.",(0,a.kt)("br",null),(0,a.kt)("br",null),"NOTE: Stability is experimental. Non-backward compatible changes or removal may occur in any future release. Use of this feature is not recommended for production environments."),(0,a.kt)("td",{parentName:"tr",align:null},(0,a.kt)("strong",{parentName:"td"},"extObjectInfo")," - Information about the object after the operation.")),(0,a.kt)("tr",{parentName:"tbody"},(0,a.kt)("td",{parentName:"tr",align:null},"CreateObject"),(0,a.kt)("td",{parentName:"tr",align:null},"Triggered when the creation of a new object is requested. ",(0,a.kt)("br",null),"This event occurs before the request is passed to M-Files Server. ",(0,a.kt)("br",null)," ",(0,a.kt)("br",null),"Return a promise that resolves true to proceed, or Error object/false to cancel the operation. ",(0,a.kt)("br",null),"When resolving with an Error object, its message will be shown to the user, enabling you to provide a custom explanation for why the operation was stopped."),(0,a.kt)("td",{parentName:"tr",align:null},(0,a.kt)("strong",{parentName:"td"},"objectTypeId")," - The object type ID for the new object. ",(0,a.kt)("br",null),(0,a.kt)("strong",{parentName:"td"},"properties")," - The properties for the new object. ",(0,a.kt)("br",null),(0,a.kt)("strong",{parentName:"td"},"acl")," - The access control list for the new object. ",(0,a.kt)("br",null),(0,a.kt)("strong",{parentName:"td"},"options")," - Flags that control the operation. ",(0,a.kt)("br",null),(0,a.kt)("strong",{parentName:"td"},"checkIn")," - If true, the object is checked in immediately after creation. ",(0,a.kt)("br",null),(0,a.kt)("strong",{parentName:"td"},"objFileSources")," - The file sources for the new object.")),(0,a.kt)("tr",{parentName:"tbody"},(0,a.kt)("td",{parentName:"tr",align:null},"ObjectCreated"),(0,a.kt)("td",{parentName:"tr",align:null},"Triggered after the request to create a new object succeeded on M-Files Server."),(0,a.kt)("td",{parentName:"tr",align:null},(0,a.kt)("strong",{parentName:"td"},"isVisibleToUser")," - True if the created object is visible to the user. ",(0,a.kt)("br",null),(0,a.kt)("strong",{parentName:"td"},"createdObject")," - The created object with properties and ACL.")),(0,a.kt)("tr",{parentName:"tbody"},(0,a.kt)("td",{parentName:"tr",align:null},"AddObjectFile"),(0,a.kt)("td",{parentName:"tr",align:null},"Triggered when the addition of a new file to a document is requested. ",(0,a.kt)("br",null),"This event occurs before the request is passed to M-Files Server. ",(0,a.kt)("br",null)," ",(0,a.kt)("br",null),"Return a promise that resolves true to proceed, or Error object/false to cancel the operation. ",(0,a.kt)("br",null),"When resolving with an Error object, its message will be shown to the user, enabling you to provide a custom explanation for why the operation was stopped."),(0,a.kt)("td",{parentName:"tr",align:null},(0,a.kt)("strong",{parentName:"td"},"objVer")," - The object version to which the file is being added. ",(0,a.kt)("br",null),(0,a.kt)("strong",{parentName:"td"},"title")," - The title of the new file. ",(0,a.kt)("br",null),(0,a.kt)("strong",{parentName:"td"},"extension")," - The file extension (without the leading dot). ",(0,a.kt)("br",null),(0,a.kt)("strong",{parentName:"td"},"createdAtUtc")," - The UTC timestamp when the file was originally created. ",(0,a.kt)("br",null),(0,a.kt)("strong",{parentName:"td"},"accessedAtUtc")," - The UTC timestamp when the file was last accessed. ",(0,a.kt)("br",null),(0,a.kt)("strong",{parentName:"td"},"writtenAtUtc")," - The UTC timestamp when the file was last written to. ",(0,a.kt)("br",null),(0,a.kt)("strong",{parentName:"td"},"changedAtUtc")," - The UTC timestamp when the file was last changed (content or attributes).")),(0,a.kt)("tr",{parentName:"tbody"},(0,a.kt)("td",{parentName:"tr",align:null},"ObjectFileAdded"),(0,a.kt)("td",{parentName:"tr",align:null},"Triggered after a request to add a file to a document succeeds on M-Files Server."),(0,a.kt)("td",{parentName:"tr",align:null},(0,a.kt)("strong",{parentName:"td"},"fileVer")," - The version information of the added file. ",(0,a.kt)("br",null),(0,a.kt)("strong",{parentName:"td"},"objectVersion")," - The object version after the file was added.")),(0,a.kt)("tr",{parentName:"tbody"},(0,a.kt)("td",{parentName:"tr",align:null},"RenameObjectFile"),(0,a.kt)("td",{parentName:"tr",align:null},"Triggered when the renaming of a file in a document is requested. ",(0,a.kt)("br",null),"This event occurs before the request is passed to M-Files Server. ",(0,a.kt)("br",null)," ",(0,a.kt)("br",null),"Return a promise that resolves true to proceed, or Error object/false to cancel the operation. ",(0,a.kt)("br",null),"When resolving with an Error object, its message will be shown to the user, enabling you to provide a custom explanation for why the operation was stopped."),(0,a.kt)("td",{parentName:"tr",align:null},(0,a.kt)("strong",{parentName:"td"},"objVer")," - The object version containing the file. ",(0,a.kt)("br",null),(0,a.kt)("strong",{parentName:"td"},"fileVer")," - The file being renamed. ",(0,a.kt)("br",null),(0,a.kt)("strong",{parentName:"td"},"title")," - The new title for the file. ",(0,a.kt)("br",null),(0,a.kt)("strong",{parentName:"td"},"extension")," - The new extension for the file (without the leading dot).")),(0,a.kt)("tr",{parentName:"tbody"},(0,a.kt)("td",{parentName:"tr",align:null},"ObjectFileRenamed"),(0,a.kt)("td",{parentName:"tr",align:null},"Triggered after a request to rename a file in a document succeeds on M-Files Server."),(0,a.kt)("td",{parentName:"tr",align:null},(0,a.kt)("strong",{parentName:"td"},"objectVersion")," - The object version after the file was renamed.")),(0,a.kt)("tr",{parentName:"tbody"},(0,a.kt)("td",{parentName:"tr",align:null},"SetPropertiesOfObjectVersions"),(0,a.kt)("td",{parentName:"tr",align:null},"Triggered when setting properties for one or more object versions is requested. ",(0,a.kt)("br",null),"This event occurs before the request is passed to M-Files Server. ",(0,a.kt)("br",null)," ",(0,a.kt)("br",null),"Return a promise that resolves true to proceed, or Error object/false to cancel the operation. ",(0,a.kt)("br",null),"When resolving with an Error object, its message will be shown to the user, enabling you to provide a custom explanation for why the operation was stopped."),(0,a.kt)("td",{parentName:"tr",align:null},(0,a.kt)("strong",{parentName:"td"},"setPropertiesParams")," - Array of parameters for setting properties on multiple objects.")),(0,a.kt)("tr",{parentName:"tbody"},(0,a.kt)("td",{parentName:"tr",align:null},"PropertiesOfObjectVersionsSet"),(0,a.kt)("td",{parentName:"tr",align:null},"Triggered after a request to set properties of one or more object versions succeeds on M-Files Server."),(0,a.kt)("td",{parentName:"tr",align:null},(0,a.kt)("strong",{parentName:"td"},"extObjectInfos")," - Extended object info for each object after the properties were set.")),(0,a.kt)("tr",{parentName:"tbody"},(0,a.kt)("td",{parentName:"tr",align:null},"SetObjectVersionPermissions"),(0,a.kt)("td",{parentName:"tr",align:null},"Triggered when changing the permissions of an object version is requested. ",(0,a.kt)("br",null),"This event occurs before the request is passed to M-Files Server. ",(0,a.kt)("br",null)," ",(0,a.kt)("br",null),"Return a promise that resolves true to proceed, or Error object/false to cancel the operation. ",(0,a.kt)("br",null),"When resolving with an Error object, its message will be shown to the user, enabling you to provide a custom explanation for why the operation was stopped."),(0,a.kt)("td",{parentName:"tr",align:null},(0,a.kt)("strong",{parentName:"td"},"objVer")," - The object version whose permissions are being changed. ",(0,a.kt)("br",null),(0,a.kt)("strong",{parentName:"td"},"acl")," - The new access control list. ",(0,a.kt)("br",null),(0,a.kt)("strong",{parentName:"td"},"options")," - Flags that control the operation.")),(0,a.kt)("tr",{parentName:"tbody"},(0,a.kt)("td",{parentName:"tr",align:null},"ObjectVersionPermissionsSet"),(0,a.kt)("td",{parentName:"tr",align:null},"Triggered after a request to change the permissions of an object version succeeds on M-Files Server."),(0,a.kt)("td",{parentName:"tr",align:null},(0,a.kt)("strong",{parentName:"td"},"isSpecifiedVersionStillVisible")," - True if the specified version is still visible after the operation. ",(0,a.kt)("br",null),(0,a.kt)("strong",{parentName:"td"},"specifiedVersion")," - Information about the specified version after the operation. ",(0,a.kt)("br",null),(0,a.kt)("strong",{parentName:"td"},"extObjectInfo")," - Extended object info after the operation.")),(0,a.kt)("tr",{parentName:"tbody"},(0,a.kt)("td",{parentName:"tr",align:null},"SetObjectLevelProperty"),(0,a.kt)("td",{parentName:"tr",align:null},"Triggered when setting an object-level property is requested. ",(0,a.kt)("br",null),"This event occurs before the request is passed to M-Files Server. ",(0,a.kt)("br",null)," ",(0,a.kt)("br",null),"Return a promise that resolves true to proceed, or Error object/false to cancel the operation. ",(0,a.kt)("br",null),"When resolving with an Error object, its message will be shown to the user, enabling you to provide a custom explanation for why the operation was stopped."),(0,a.kt)("td",{parentName:"tr",align:null},(0,a.kt)("strong",{parentName:"td"},"objId")," - The object whose property is being set. ",(0,a.kt)("br",null),(0,a.kt)("strong",{parentName:"td"},"property")," - The property value to set. ",(0,a.kt)("br",null),(0,a.kt)("strong",{parentName:"td"},"options")," - Flags that control the operation.")),(0,a.kt)("tr",{parentName:"tbody"},(0,a.kt)("td",{parentName:"tr",align:null},"ObjectLevelPropertySet"),(0,a.kt)("td",{parentName:"tr",align:null},"Triggered after a request to set an object-level property succeeds on M-Files Server."),(0,a.kt)("td",{parentName:"tr",align:null},(0,a.kt)("strong",{parentName:"td"},"extObjectInfo")," - Extended object info after the operation.")),(0,a.kt)("tr",{parentName:"tbody"},(0,a.kt)("td",{parentName:"tr",align:null},"ModifyObjectVersionLabels"),(0,a.kt)("td",{parentName:"tr",align:null},"Triggered when modifying the labels of an object version is requested. ",(0,a.kt)("br",null),"This event occurs before the request is passed to M-Files Server. ",(0,a.kt)("br",null)," ",(0,a.kt)("br",null),"Return a promise that resolves true to proceed, or Error object/false to cancel the operation. ",(0,a.kt)("br",null),"When resolving with an Error object, its message will be shown to the user, enabling you to provide a custom explanation for why the operation was stopped.",(0,a.kt)("br",null),(0,a.kt)("br",null),"NOTE: Stability is experimental. Non-backward compatible changes or removal may occur in any future release. Use of this feature is not recommended for production environments."),(0,a.kt)("td",{parentName:"tr",align:null},(0,a.kt)("strong",{parentName:"td"},"objVer")," - The object version whose labels are being modified. ",(0,a.kt)("br",null),(0,a.kt)("strong",{parentName:"td"},"clearFromOtherVersions")," - If true, the specified labels are cleared from other versions. ",(0,a.kt)("br",null),(0,a.kt)("strong",{parentName:"td"},"append")," - If true, the labels are appended to existing labels; if false, existing labels are replaced. ",(0,a.kt)("br",null),(0,a.kt)("strong",{parentName:"td"},"labelIDs")," - The IDs of the labels to set.")),(0,a.kt)("tr",{parentName:"tbody"},(0,a.kt)("td",{parentName:"tr",align:null},"ObjectVersionLabelsModified"),(0,a.kt)("td",{parentName:"tr",align:null},"Triggered after a request to modify the labels of an object version succeeds on M-Files Server.",(0,a.kt)("br",null),(0,a.kt)("br",null),"NOTE: Stability is experimental. Non-backward compatible changes or removal may occur in any future release. Use of this feature is not recommended for production environments."),(0,a.kt)("td",{parentName:"tr",align:null},(0,a.kt)("strong",{parentName:"td"},"objVer")," - The object version whose labels were modified. ",(0,a.kt)("br",null),(0,a.kt)("strong",{parentName:"td"},"clearFromOtherVersions")," - If true, the specified labels were cleared from other versions. ",(0,a.kt)("br",null),(0,a.kt)("strong",{parentName:"td"},"append")," - If true, the labels were appended to existing labels. ",(0,a.kt)("br",null),(0,a.kt)("strong",{parentName:"td"},"labelIDs")," - The IDs of the labels that were set.")),(0,a.kt)("tr",{parentName:"tbody"},(0,a.kt)("td",{parentName:"tr",align:null},"ChangeVaultLanguage"),(0,a.kt)("td",{parentName:"tr",align:null},"Triggered when changing the vault language is requested. ",(0,a.kt)("br",null),"This event occurs before the request is passed to M-Files Server.",(0,a.kt)("br",null),(0,a.kt)("br",null),"NOTE: Stability is experimental. Non-backward compatible changes or removal may occur in any future release. Use of this feature is not recommended for production environments."),(0,a.kt)("td",{parentName:"tr",align:null},(0,a.kt)("strong",{parentName:"td"},"languageId")," - The ID of the new vault language.")),(0,a.kt)("tr",{parentName:"tbody"},(0,a.kt)("td",{parentName:"tr",align:null},"VaultLanguageChanged"),(0,a.kt)("td",{parentName:"tr",align:null},"Triggered after the vault language has been changed.",(0,a.kt)("br",null),(0,a.kt)("br",null),"NOTE: Stability is experimental. Non-backward compatible changes or removal may occur in any future release. Use of this feature is not recommended for production environments."),(0,a.kt)("td",{parentName:"tr",align:null},(0,a.kt)("strong",{parentName:"td"},"languageId")," - The ID of the new vault language.")),(0,a.kt)("tr",{parentName:"tbody"},(0,a.kt)("td",{parentName:"tr",align:null},"LogOut"),(0,a.kt)("td",{parentName:"tr",align:null},"Triggered when logging out of the vault is requested. ",(0,a.kt)("br",null),"This event occurs before the logout is processed.",(0,a.kt)("br",null),(0,a.kt)("br",null),"NOTE: Stability is experimental. Non-backward compatible changes or removal may occur in any future release. Use of this feature is not recommended for production environments."),(0,a.kt)("td",{parentName:"tr",align:null})))),(0,a.kt)("h2",{id:"icommandsevents"},"ICommandsEvents"),(0,a.kt)("p",null,"Ths ICommandEvents interface provides methods to register and unregister event handlers for custom commands:"),(0,a.kt)("ul",null,(0,a.kt)("li",{parentName:"ul"},(0,a.kt)("strong",{parentName:"li"},"Register( event, callback )"),": Registers an event handler for the specified event and returns the event handler ID."),(0,a.kt)("li",{parentName:"ul"},(0,a.kt)("strong",{parentName:"li"},"Unregister( eventId )"),": Unregisters the event handler with the specified ID.")),(0,a.kt)("p",null,"The ",(0,a.kt)("a",{parentName:"p",href:"../Interfaces/ICommands/"},"ICommands")," interface has Events property, which provides access to the ICommandsEvents interface."),(0,a.kt)("p",null,"Here is a JavaScript example of how to use the ICommandsEvents interface to listen for custom command events and their data:"),(0,a.kt)("pre",null,(0,a.kt)("code",{parentName:"pre",className:"language-typescript"},'const commandsEvents = shellFrame.Commands.Events;\n// Register event handler for the custom command\nconst eventId = await commandsEvents.Register(\n Event.CustomCommand,\n (commandID, data) => {\n console.log("Custom command invoked: ", commandID);\n console.log("Data: ", data);\n },\n);\n')),(0,a.kt)("table",null,(0,a.kt)("thead",{parentName:"table"},(0,a.kt)("tr",{parentName:"thead"},(0,a.kt)("th",{parentName:"tr",align:null},"Event"),(0,a.kt)("th",{parentName:"tr",align:null},"Description"),(0,a.kt)("th",{parentName:"tr",align:null},"Arguments"))),(0,a.kt)("tbody",{parentName:"table"},(0,a.kt)("tr",{parentName:"tbody"},(0,a.kt)("td",{parentName:"tr",align:null},"CustomCommand"),(0,a.kt)("td",{parentName:"tr",align:null},"Triggered when a custom command is invoked."),(0,a.kt)("td",{parentName:"tr",align:null},(0,a.kt)("strong",{parentName:"td"},"commandID")," The ID of the custom command to be used. ",(0,a.kt)("br",null),(0,a.kt)("strong",{parentName:"td"},"data")," The data passed to the custom command.")),(0,a.kt)("tr",{parentName:"tbody"},(0,a.kt)("td",{parentName:"tr",align:null},"BuiltinCommand"),(0,a.kt)("td",{parentName:"tr",align:null},"Callback handler for Builtin commands. ",(0,a.kt)("br",null)," ",(0,a.kt)("br",null),"Allows UI Extensibility applications to intercept and optionally cancel built-in command execution."),(0,a.kt)("td",{parentName:"tr",align:null},"argument of type ( commandId : BuiltinCommand, param : any ) =",">"," Promise","<"," boolean ",">")))))}u.isMDXComponent=!0}}]); \ No newline at end of file diff --git a/Frameworks/User-Interface-Extensibility-Framework/Reference/assets/js/4569a837.eb50c391.js b/Frameworks/User-Interface-Extensibility-Framework/Reference/assets/js/4569a837.eb50c391.js new file mode 100644 index 000000000..26d395bd5 --- /dev/null +++ b/Frameworks/User-Interface-Extensibility-Framework/Reference/assets/js/4569a837.eb50c391.js @@ -0,0 +1 @@ +"use strict";(self.webpackChunkuix_2=self.webpackChunkuix_2||[]).push([[2524],{3905:(e,t,r)=>{r.d(t,{Zo:()=>c,kt:()=>f});var n=r(67294);function a(e,t,r){return t in e?Object.defineProperty(e,t,{value:r,enumerable:!0,configurable:!0,writable:!0}):e[t]=r,e}function l(e,t){var r=Object.keys(e);if(Object.getOwnPropertySymbols){var n=Object.getOwnPropertySymbols(e);t&&(n=n.filter((function(t){return Object.getOwnPropertyDescriptor(e,t).enumerable}))),r.push.apply(r,n)}return r}function o(e){for(var t=1;t=0||(a[r]=e[r]);return a}(e,t);if(Object.getOwnPropertySymbols){var l=Object.getOwnPropertySymbols(e);for(n=0;n=0||Object.prototype.propertyIsEnumerable.call(e,r)&&(a[r]=e[r])}return a}var s=n.createContext({}),u=function(e){var t=n.useContext(s),r=t;return e&&(r="function"==typeof e?e(t):o(o({},t),e)),r},c=function(e){var t=u(e.components);return n.createElement(s.Provider,{value:t},e.children)},p="mdxType",m={inlineCode:"code",wrapper:function(e){var t=e.children;return n.createElement(n.Fragment,{},t)}},d=n.forwardRef((function(e,t){var r=e.components,a=e.mdxType,l=e.originalType,s=e.parentName,c=i(e,["components","mdxType","originalType","parentName"]),p=u(r),d=a,f=p["".concat(s,".").concat(d)]||p[d]||m[d]||l;return r?n.createElement(f,o(o({ref:t},c),{},{components:r})):n.createElement(f,o({ref:t},c))}));function f(e,t){var r=arguments,a=t&&t.mdxType;if("string"==typeof e||a){var l=r.length,o=new Array(l);o[0]=d;var i={};for(var s in t)hasOwnProperty.call(t,s)&&(i[s]=t[s]);i.originalType=e,i[p]="string"==typeof e?e:a,o[1]=i;for(var u=2;u{r.d(t,{Z:()=>o});var n=r(67294),a=r(86010);const l={tabItem:"tabItem_Ymn6"};function o(e){let{children:t,hidden:r,className:o}=e;return n.createElement("div",{role:"tabpanel",className:(0,a.Z)(l.tabItem,o),hidden:r},t)}},73992:(e,t,r)=>{r.d(t,{Z:()=>I});var n=r(87462),a=r(67294),l=r(86010),o=r(72957),i=r(16550),s=r(75238),u=r(33609),c=r(92560);function p(e){return function(e){return a.Children.map(e,(e=>{if(!e||(0,a.isValidElement)(e)&&function(e){const{props:t}=e;return!!t&&"object"==typeof t&&"value"in t}(e))return e;throw new Error(`Docusaurus error: Bad child <${"string"==typeof e.type?e.type:e.type.name}>: all children of the component should be , and every should have a unique "value" prop.`)}))?.filter(Boolean)??[]}(e).map((e=>{let{props:{value:t,label:r,attributes:n,default:a}}=e;return{value:t,label:r,attributes:n,default:a}}))}function m(e){const{values:t,children:r}=e;return(0,a.useMemo)((()=>{const e=t??p(r);return function(e){const t=(0,u.l)(e,((e,t)=>e.value===t.value));if(t.length>0)throw new Error(`Docusaurus error: Duplicate values "${t.map((e=>e.value)).join(", ")}" found in . Every value needs to be unique.`)}(e),e}),[t,r])}function d(e){let{value:t,tabValues:r}=e;return r.some((e=>e.value===t))}function f(e){let{queryString:t=!1,groupId:r}=e;const n=(0,i.k6)(),l=function(e){let{queryString:t=!1,groupId:r}=e;if("string"==typeof t)return t;if(!1===t)return null;if(!0===t&&!r)throw new Error('Docusaurus error: The component groupId prop is required if queryString=true, because this value is used as the search param name. You can also provide an explicit value such as queryString="my-search-param".');return r??null}({queryString:t,groupId:r});return[(0,s._X)(l),(0,a.useCallback)((e=>{if(!l)return;const t=new URLSearchParams(n.location.search);t.set(l,e),n.replace({...n.location,search:t.toString()})}),[l,n])]}function b(e){const{defaultValue:t,queryString:r=!1,groupId:n}=e,l=m(e),[o,i]=(0,a.useState)((()=>function(e){let{defaultValue:t,tabValues:r}=e;if(0===r.length)throw new Error("Docusaurus error: the component requires at least one children component");if(t){if(!d({value:t,tabValues:r}))throw new Error(`Docusaurus error: The has a defaultValue "${t}" but none of its children has the corresponding value. Available values are: ${r.map((e=>e.value)).join(", ")}. If you intend to show no default tab, use defaultValue={null} instead.`);return t}const n=r.find((e=>e.default))??r[0];if(!n)throw new Error("Unexpected error: 0 tabValues");return n.value}({defaultValue:t,tabValues:l}))),[s,u]=f({queryString:r,groupId:n}),[p,b]=function(e){let{groupId:t}=e;const r=function(e){return e?`docusaurus.tab.${e}`:null}(t),[n,l]=(0,c.Nk)(r);return[n,(0,a.useCallback)((e=>{r&&l.set(e)}),[r,l])]}({groupId:n}),h=(()=>{const e=s??p;return d({value:e,tabValues:l})?e:null})();(0,a.useLayoutEffect)((()=>{h&&i(h)}),[h]);return{selectedValue:o,selectValue:(0,a.useCallback)((e=>{if(!d({value:e,tabValues:l}))throw new Error(`Can't select invalid tab value=${e}`);i(e),u(e),b(e)}),[u,b,l]),tabValues:l}}var h=r(51048);const y={tabList:"tabList__CuJ",tabItem:"tabItem_LNqP"};function k(e){let{className:t,block:r,selectedValue:i,selectValue:s,tabValues:u}=e;const c=[],{blockElementScrollPositionUntilNextRender:p}=(0,o.o5)(),m=e=>{const t=e.currentTarget,r=c.indexOf(t),n=u[r].value;n!==i&&(p(t),s(n))},d=e=>{let t=null;switch(e.key){case"Enter":m(e);break;case"ArrowRight":{const r=c.indexOf(e.currentTarget)+1;t=c[r]??c[0];break}case"ArrowLeft":{const r=c.indexOf(e.currentTarget)-1;t=c[r]??c[c.length-1];break}}t?.focus()};return a.createElement("ul",{role:"tablist","aria-orientation":"horizontal",className:(0,l.Z)("tabs",{"tabs--block":r},t)},u.map((e=>{let{value:t,label:r,attributes:o}=e;return a.createElement("li",(0,n.Z)({role:"tab",tabIndex:i===t?0:-1,"aria-selected":i===t,key:t,ref:e=>c.push(e),onKeyDown:d,onClick:m},o,{className:(0,l.Z)("tabs__item",y.tabItem,o?.className,{"tabs__item--active":i===t})}),r??t)})))}function v(e){let{lazy:t,children:r,selectedValue:n}=e;const l=(Array.isArray(r)?r:[r]).filter(Boolean);if(t){const e=l.find((e=>e.props.value===n));return e?(0,a.cloneElement)(e,{className:"margin-top--md"}):null}return a.createElement("div",{className:"margin-top--md"},l.map(((e,t)=>(0,a.cloneElement)(e,{key:t,hidden:e.props.value!==n}))))}function g(e){const t=b(e);return a.createElement("div",{className:(0,l.Z)("tabs-container",y.tabList)},a.createElement(k,(0,n.Z)({},e,t)),a.createElement(v,(0,n.Z)({},e,t)))}function I(e){const t=(0,h.Z)();return a.createElement(g,(0,n.Z)({key:String(t)},e))}},52528:(e,t,r)=>{r.r(t),r.d(t,{assets:()=>x,contentTitle:()=>N,default:()=>O,frontMatter:()=>I,metadata:()=>w,toc:()=>E});var n=r(87462),a=(r(67294),r(3905));const l={toc:[]},o="wrapper";function i(e){let{components:t,...r}=e;return(0,a.kt)(o,(0,n.Z)({},l,r,{components:t,mdxType:"MDXLayout"}),(0,a.kt)("p",null,(0,a.kt)("strong",{parentName:"p"},(0,a.kt)("a",{parentName:"strong",href:"/Overview/exceptions#notsupportederror"},(0,a.kt)("inlineCode",{parentName:"a"},"NotSupportedError")))," - when the CE3224_SimplifiedCoreAPISupportUIX2 feature flag is not enabled, or when called from a non-cloud vault."),(0,a.kt)("p",null,(0,a.kt)("strong",{parentName:"p"},(0,a.kt)("a",{parentName:"strong",href:"/Overview/exceptions#error"},(0,a.kt)("inlineCode",{parentName:"a"},"Error")))," - an error if the HTTP response status is not ok, if the request input is invalid, if the user session is unavailable, or if there is a network or parsing error"))}i.isMDXComponent=!0;const s={toc:[]},u="wrapper";function c(e){let{components:t,...r}=e;return(0,a.kt)(u,(0,n.Z)({},s,r,{components:t,mdxType:"MDXLayout"}),(0,a.kt)("table",null,(0,a.kt)("thead",{parentName:"table"},(0,a.kt)("tr",{parentName:"thead"},(0,a.kt)("th",{parentName:"tr",align:null},"Type"),(0,a.kt)("th",{parentName:"tr",align:null},"Description"))),(0,a.kt)("tbody",{parentName:"table"},(0,a.kt)("tr",{parentName:"tbody"},(0,a.kt)("td",{parentName:"tr",align:null},(0,a.kt)("inlineCode",{parentName:"td"},"Promise")," < ",(0,a.kt)("inlineCode",{parentName:"td"},"any")," >"),(0,a.kt)("td",{parentName:"tr",align:null},"A promise that resolves to the parsed JSON response from the server, ",(0,a.kt)("br",null),"or rejects with an error if the HTTP request fails or response parsing fails")))))}c.isMDXComponent=!0;const p={toc:[]},m="wrapper";function d(e){let{components:t,...r}=e;return(0,a.kt)(m,(0,n.Z)({},p,r,{components:t,mdxType:"MDXLayout"}),(0,a.kt)("table",null,(0,a.kt)("thead",{parentName:"table"},(0,a.kt)("tr",{parentName:"thead"},(0,a.kt)("th",{parentName:"tr",align:null},"Name"),(0,a.kt)("th",{parentName:"tr",align:null},"Optionality"),(0,a.kt)("th",{parentName:"tr",align:null},"Type"),(0,a.kt)("th",{parentName:"tr",align:null},"Description"))),(0,a.kt)("tbody",{parentName:"table"},(0,a.kt)("tr",{parentName:"tbody"},(0,a.kt)("td",{parentName:"tr",align:null},"requestRelativeURL"),(0,a.kt)("td",{parentName:"tr",align:null},"Required"),(0,a.kt)("td",{parentName:"tr",align:null},(0,a.kt)("inlineCode",{parentName:"td"},"string")),(0,a.kt)("td",{parentName:"tr",align:null},"The relative URL path of the API endpoint to call. ",(0,a.kt)("br",null),"Must start with ",'"',"/",'"'," and may include a query string, ",(0,a.kt)("br",null),"but cannot include fragments, backslashes, ",(0,a.kt)("br",null),"or traversal segments.")),(0,a.kt)("tr",{parentName:"tbody"},(0,a.kt)("td",{parentName:"tr",align:null},"method"),(0,a.kt)("td",{parentName:"tr",align:null},"Required"),(0,a.kt)("td",{parentName:"tr",align:null},(0,a.kt)("inlineCode",{parentName:"td"},"string")),(0,a.kt)("td",{parentName:"tr",align:null},"The HTTP method to use. Only ",'"',"GET",'"',", ",'"',"POST",'"',", and ",'"',"DELETE",'"'," are allowed.")),(0,a.kt)("tr",{parentName:"tbody"},(0,a.kt)("td",{parentName:"tr",align:null},"payload"),(0,a.kt)("td",{parentName:"tr",align:null},"Optional"),(0,a.kt)("td",{parentName:"tr",align:null},(0,a.kt)("inlineCode",{parentName:"td"},"string")),(0,a.kt)("td",{parentName:"tr",align:null},"Optional JSON string to include as the request body (for POST requests).")))))}d.isMDXComponent=!0;r(73992);var f=r(18679);const b={toc:[]},h="wrapper";function y(e){let{components:t,...r}=e;return(0,a.kt)(h,(0,n.Z)({},b,r,{components:t,mdxType:"MDXLayout"}),(0,a.kt)(f.Z,{value:"js",label:"JavaScript",mdxType:"TabItem"},(0,a.kt)("pre",null,(0,a.kt)("code",{parentName:"pre",className:"language-js"},"// shellFrame points to instance of IShellFrame\nconst result = await shellFrame.CallSimplifiedAPI(\n requestRelativeURL,\n method,\n payload,\n);\n"))))}y.isMDXComponent=!0;const k={toc:[]},v="wrapper";function g(e){let{components:t,...r}=e;return(0,a.kt)(v,(0,n.Z)({},k,r,{components:t,mdxType:"MDXLayout"}),(0,a.kt)("p",null,"Calls a simplified M-Files API endpoint with the specified HTTP method."),(0,a.kt)("p",null,"NOTE: Stability is experimental. Non-backward compatible changes or removal may occur in any future release. Use of this feature is not recommended for production environments."))}g.isMDXComponent=!0;const I={},N="CallSimplifiedAPI",w={unversionedId:"UIExt2/Interfaces/IShellFrame/CallSimplifiedAPI/index",id:"UIExt2/Interfaces/IShellFrame/CallSimplifiedAPI/index",title:"CallSimplifiedAPI",description:"Description",source:"@site/docs/UIExt2/Interfaces/IShellFrame/CallSimplifiedAPI/index.mdx",sourceDirName:"UIExt2/Interfaces/IShellFrame/CallSimplifiedAPI",slug:"/UIExt2/Interfaces/IShellFrame/CallSimplifiedAPI/",permalink:"/Frameworks/User-Interface-Extensibility-Framework/Reference/UIExt2/Interfaces/IShellFrame/CallSimplifiedAPI/",draft:!1,tags:[],version:"current",frontMatter:{},sidebar:"tutorialSidebar",previous:{title:"IShellFrame",permalink:"/Frameworks/User-Interface-Extensibility-Framework/Reference/UIExt2/Interfaces/IShellFrame/"},next:{title:"GetSandboxAttributes",permalink:"/Frameworks/User-Interface-Extensibility-Framework/Reference/UIExt2/Interfaces/IShellFrame/GetSandboxAttributes/"}},x={},E=[{value:"Description",id:"description",level:2},{value:"Syntax",id:"syntax",level:2},{value:"Parameters",id:"parameters",level:2},{value:"Return type",id:"return-type",level:2},{value:"Exceptions",id:"exceptions",level:2}],T={toc:E},S="wrapper";function O(e){let{components:t,...r}=e;return(0,a.kt)(S,(0,n.Z)({},T,r,{components:t,mdxType:"MDXLayout"}),(0,a.kt)("h1",{id:"callsimplifiedapi"},"CallSimplifiedAPI"),(0,a.kt)("h2",{id:"description"},"Description"),(0,a.kt)(g,{components:r.components,mdxType:"Description"}),(0,a.kt)("h2",{id:"syntax"},"Syntax"),(0,a.kt)(y,{components:r.components,mdxType:"Syntax"}),(0,a.kt)("h2",{id:"parameters"},"Parameters"),(0,a.kt)(d,{components:r.components,mdxType:"Params"}),(0,a.kt)("h2",{id:"return-type"},"Return type"),(0,a.kt)(c,{components:r.components,mdxType:"Returns"}),(0,a.kt)("h2",{id:"exceptions"},"Exceptions"),(0,a.kt)(i,{components:r.components,mdxType:"Throws"}))}O.isMDXComponent=!0}}]); \ No newline at end of file diff --git a/Frameworks/User-Interface-Extensibility-Framework/Reference/assets/js/58f68e49.760d8656.js b/Frameworks/User-Interface-Extensibility-Framework/Reference/assets/js/58f68e49.760d8656.js deleted file mode 100644 index aa2304003..000000000 --- a/Frameworks/User-Interface-Extensibility-Framework/Reference/assets/js/58f68e49.760d8656.js +++ /dev/null @@ -1 +0,0 @@ -"use strict";(self.webpackChunkuix_2=self.webpackChunkuix_2||[]).push([[1516],{3905:(e,t,a)=>{a.d(t,{Zo:()=>p,kt:()=>k});var n=a(67294);function r(e,t,a){return t in e?Object.defineProperty(e,t,{value:a,enumerable:!0,configurable:!0,writable:!0}):e[t]=a,e}function l(e,t){var a=Object.keys(e);if(Object.getOwnPropertySymbols){var n=Object.getOwnPropertySymbols(e);t&&(n=n.filter((function(t){return Object.getOwnPropertyDescriptor(e,t).enumerable}))),a.push.apply(a,n)}return a}function i(e){for(var t=1;t=0||(r[a]=e[a]);return r}(e,t);if(Object.getOwnPropertySymbols){var l=Object.getOwnPropertySymbols(e);for(n=0;n=0||Object.prototype.propertyIsEnumerable.call(e,a)&&(r[a]=e[a])}return r}var s=n.createContext({}),d=function(e){var t=n.useContext(s),a=t;return e&&(a="function"==typeof e?e(t):i(i({},t),e)),a},p=function(e){var t=d(e.components);return n.createElement(s.Provider,{value:t},e.children)},m="mdxType",h={inlineCode:"code",wrapper:function(e){var t=e.children;return n.createElement(n.Fragment,{},t)}},c=n.forwardRef((function(e,t){var a=e.components,r=e.mdxType,l=e.originalType,s=e.parentName,p=o(e,["components","mdxType","originalType","parentName"]),m=d(a),c=r,k=m["".concat(s,".").concat(c)]||m[c]||h[c]||l;return a?n.createElement(k,i(i({ref:t},p),{},{components:a})):n.createElement(k,i({ref:t},p))}));function k(e,t){var a=arguments,r=t&&t.mdxType;if("string"==typeof e||r){var l=a.length,i=new Array(l);i[0]=c;var o={};for(var s in t)hasOwnProperty.call(t,s)&&(o[s]=t[s]);o.originalType=e,o[m]="string"==typeof e?e:r,i[1]=o;for(var d=2;d{a.r(t),a.d(t,{assets:()=>g,contentTitle:()=>u,default:()=>I,frontMatter:()=>k,metadata:()=>N,toc:()=>f});var n=a(87462),r=(a(67294),a(3905));const l={toc:[]},i="wrapper";function o(e){let{components:t,...a}=e;return(0,r.kt)(i,(0,n.Z)({},l,a,{components:t,mdxType:"MDXLayout"}),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:null},"Event"),(0,r.kt)("th",{parentName:"tr",align:null},"Description"),(0,r.kt)("th",{parentName:"tr",align:null},"Arguments"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:null},"Stop"),(0,r.kt)("td",{parentName:"tr",align:null},"Sent before the IShellFrame is stopped."),(0,r.kt)("td",{parentName:"tr",align:null})),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:null},"Started"),(0,r.kt)("td",{parentName:"tr",align:null},"Registers event handler for the IShellFrame started event, which means that the IShellFrame ",(0,r.kt)("br",null),"is ready to be used. This event will trigger at least once for each registered callback ",(0,r.kt)("br",null),"if the IShellFrame is already started and not yet stopped."),(0,r.kt)("td",{parentName:"tr",align:null})),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:null},"ViewLocationChanged"),(0,r.kt)("td",{parentName:"tr",align:null},"Registers event handler for the IShellFrame ViewLocationChanged event, which means that the view location has changed."),(0,r.kt)("td",{parentName:"tr",align:null})),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:null},"ViewLocationChangedAsync"),(0,r.kt)("td",{parentName:"tr",align:null},"Registers event handler for the IShellFrame ViewLocationChangedAsync event, which means that the view location has changed."),(0,r.kt)("td",{parentName:"tr",align:null})),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:null},"NewCommands"),(0,r.kt)("td",{parentName:"tr",align:null},"Registers event handler for the IShellFrame NewCommands event, which means that a new ICommands interface has been created and is ready to be used."),(0,r.kt)("td",{parentName:"tr",align:null})),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:null},"NewRightPane"),(0,r.kt)("td",{parentName:"tr",align:null},"Registers event handler for the IShellFrame NewRightPane event, which means that a shell pane container is created for right shell pane."),(0,r.kt)("td",{parentName:"tr",align:null})),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:null},"NewShellListing"),(0,r.kt)("td",{parentName:"tr",align:null},"Registers event handler for the IShellFrame NewShellListing event, which means that a new shell listing object is created."),(0,r.kt)("td",{parentName:"tr",align:null},(0,r.kt)("strong",{parentName:"td"},"newShellisting")," The new IShellListing object.")))),(0,r.kt)("pre",null,(0,r.kt)("code",{parentName:"pre",className:"language-typescript"},"shellFrame.Events.Register(\n Event.NewShellListing,\n (newShellisting: IShellListing) => {\n // Do something with the new shell listing object\n },\n);\n")))}o.isMDXComponent=!0;const s={toc:[]},d="wrapper";function p(e){let{components:t,...a}=e;return(0,r.kt)(d,(0,n.Z)({},s,a,{components:t,mdxType:"MDXLayout"}),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:null},"Name"),(0,r.kt)("th",{parentName:"tr",align:null},"Description"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:null},(0,r.kt)("a",{parentName:"td",href:"./GetSandboxAttributes/"},"GetSandboxAttributes")),(0,r.kt)("td",{parentName:"tr",align:null},"Gets the sandbox attributes for the specified Module.")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:null},(0,r.kt)("a",{parentName:"td",href:"./GetViewsById/"},"GetViewsById")),(0,r.kt)("td",{parentName:"tr",align:null},"Gets known views details as key pair value of ","<","ViewID,View Details.",">")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:null},(0,r.kt)("a",{parentName:"td",href:"./IsFolderLocation/"},"IsFolderLocation")),(0,r.kt)("td",{parentName:"tr",align:null},"Resolves if the shell frame represents a normal folder location. For example it is ",(0,r.kt)("br",null),"a search folder or view, a property folder or traditional folder, but not an ",(0,r.kt)("br",null),"object folder.")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:null},(0,r.kt)("a",{parentName:"td",href:"./IsObjectLocation/"},"IsObjectLocation")),(0,r.kt)("td",{parentName:"tr",align:null},"Resolves if the shell frame represents a object folder location.")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:null},(0,r.kt)("a",{parentName:"td",href:"./NavigateToFolder/"},"NavigateToFolder")),(0,r.kt)("td",{parentName:"tr",align:null},"Navigate to the given folder defs.")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:null},(0,r.kt)("a",{parentName:"td",href:"./NavigateToObject/"},"NavigateToObject")),(0,r.kt)("td",{parentName:"tr",align:null},"Navigate to the given object.")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:null},(0,r.kt)("a",{parentName:"td",href:"./NavigateToParent/"},"NavigateToParent")),(0,r.kt)("td",{parentName:"tr",align:null},"Performs navigation to the parent folder.")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:null},(0,r.kt)("a",{parentName:"td",href:"./ShowDashboard/"},"ShowDashboard")),(0,r.kt)("td",{parentName:"tr",align:null},"Changes the listing area to show a dashboard.")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:null},(0,r.kt)("a",{parentName:"td",href:"./ShowDefaultContent/"},"ShowDefaultContent")),(0,r.kt)("td",{parentName:"tr",align:null},"Restores the normal listing to the listing area and triggers content loading.")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:null},(0,r.kt)("a",{parentName:"td",href:"./ShowMessage/"},"ShowMessage")),(0,r.kt)("td",{parentName:"tr",align:null},"Displays a modal message box.")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:null},(0,r.kt)("a",{parentName:"td",href:"./ShowPopupDashboard/"},"ShowPopupDashboard")),(0,r.kt)("td",{parentName:"tr",align:null},"Shows a dashboard in popup window.")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:null},(0,r.kt)("a",{parentName:"td",href:"./ShowPopupDashboards/"},"ShowPopupDashboards")),(0,r.kt)("td",{parentName:"tr",align:null},"Shows multiple dashboards in a popup window with side-by-side layout.",(0,r.kt)("br",null),(0,r.kt)("br",null),"NOTE: Stability is experimental. Non-backward compatible changes or removal may occur in any future release. Use of this feature is not recommended for production environments.")))))}p.isMDXComponent=!0;const m={toc:[]},h="wrapper";function c(e){let{components:t,...a}=e;return(0,r.kt)(h,(0,n.Z)({},m,a,{components:t,mdxType:"MDXLayout"}),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:null},"Name"),(0,r.kt)("th",{parentName:"tr",align:null},"Type"),(0,r.kt)("th",{parentName:"tr",align:null},"Description"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:null},"ActiveListing"),(0,r.kt)("td",{parentName:"tr",align:null},(0,r.kt)("a",{parentName:"td",href:"/UIExt2/Interfaces/IShellListing/"},"IShellListing")),(0,r.kt)("td",{parentName:"tr",align:null},"Accesses the currently active listing object.")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:null},"Commands"),(0,r.kt)("td",{parentName:"tr",align:null},(0,r.kt)("a",{parentName:"td",href:"/UIExt2/Interfaces/ICommands/"},"ICommands")),(0,r.kt)("td",{parentName:"tr",align:null},"Accesses the commands of the shell frame.")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:null},"CurrentFolder"),(0,r.kt)("td",{parentName:"tr",align:null},(0,r.kt)("inlineCode",{parentName:"td"},"Array")," < ",(0,r.kt)("a",{parentName:"td",href:"/gRPC/Messages/Folder/"},"Folder")," >"),(0,r.kt)("td",{parentName:"tr",align:null},"Accesses the current folder location. Valid only if the current location is a normal folder location.")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:null},"CurrentPath"),(0,r.kt)("td",{parentName:"tr",align:null},(0,r.kt)("inlineCode",{parentName:"td"},"string")),(0,r.kt)("td",{parentName:"tr",align:null},"Gets the path to the current folder as string. ",(0,r.kt)("br",null)," ",(0,r.kt)("br",null),"For special views, the following built-in path strings are used: ",(0,r.kt)("br",null),"- ",(0,r.kt)("inlineCode",{parentName:"td"},"Search")," - Search view ",(0,r.kt)("br",null),"- ",(0,r.kt)("inlineCode",{parentName:"td"},"Workspaces")," - Workspaces view ",(0,r.kt)("br",null),"- ",(0,r.kt)("inlineCode",{parentName:"td"},"Pinned")," - Pinned view ",(0,r.kt)("br",null),"- ",(0,r.kt)("inlineCode",{parentName:"td"},"Checked Out to Me\\\\")," - Checked Out to Me ",(0,r.kt)("br",null),"- ",(0,r.kt)("inlineCode",{parentName:"td"},"Recently Modified by Me\\\\")," - Recently Modified by Me ",(0,r.kt)("br",null),"- ",(0,r.kt)("inlineCode",{parentName:"td"},"Assigned to Me\\\\")," - Assigned to Me ",(0,r.kt)("br",null),"- ",(0,r.kt)("inlineCode",{parentName:"td"},"Recently Accessed by Me\\\\")," - Recently Accessed by Me ",(0,r.kt)("br",null),"- ",(0,r.kt)("inlineCode",{parentName:"td"},"Object History")," - Object History ",(0,r.kt)("br",null),"- ",(0,r.kt)("inlineCode",{parentName:"td"},"Conflict Resolution")," - Conflict Resolution ",(0,r.kt)("br",null),"- ",(0,r.kt)("inlineCode",{parentName:"td"},"_singleObject")," - Single Object view (opened when navigating to an object)")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:null},"CurrentUrl"),(0,r.kt)("td",{parentName:"tr",align:null},(0,r.kt)("inlineCode",{parentName:"td"},"string")),(0,r.kt)("td",{parentName:"tr",align:null},"Gets the current view url as a string.")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:null},"Events"),(0,r.kt)("td",{parentName:"tr",align:null},(0,r.kt)("a",{parentName:"td",href:"/UIExt2/Events/#ishellframeevents"},"IShellFrameEvents")),(0,r.kt)("td",{parentName:"tr",align:null},"Returns the event registering interface for the IShellFrame interface.")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:null},"LeftPane"),(0,r.kt)("td",{parentName:"tr",align:null},(0,r.kt)("a",{parentName:"td",href:"/UIExt2/Interfaces/IShellPaneContainer/"},"IShellPaneContainer")),(0,r.kt)("td",{parentName:"tr",align:null},"Accesses the left panes of the shell frame.")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:null},"Listing"),(0,r.kt)("td",{parentName:"tr",align:null},(0,r.kt)("a",{parentName:"td",href:"/UIExt2/Interfaces/IShellListing/"},"IShellListing")),(0,r.kt)("td",{parentName:"tr",align:null},"Accesses the main listing object of the shell frame.")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:null},"ParentFolder"),(0,r.kt)("td",{parentName:"tr",align:null},(0,r.kt)("inlineCode",{parentName:"td"},"Array")," < ",(0,r.kt)("a",{parentName:"td",href:"/gRPC/Messages/Folder/"},"Folder")," >"),(0,r.kt)("td",{parentName:"tr",align:null},"Gets the parent folder for current location.")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:null},"RightPane"),(0,r.kt)("td",{parentName:"tr",align:null},(0,r.kt)("a",{parentName:"td",href:"/UIExt2/Interfaces/IShellPaneContainer/"},"IShellPaneContainer")),(0,r.kt)("td",{parentName:"tr",align:null},"Accesses the right panes of the shell frame.")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:null},"SearchPane"),(0,r.kt)("td",{parentName:"tr",align:null},(0,r.kt)("a",{parentName:"td",href:"/UIExt2/Interfaces/ISearchPane/"},"ISearchPane")),(0,r.kt)("td",{parentName:"tr",align:null},"Accesses the search pane of the shell frame.")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:null},"ShellUI"),(0,r.kt)("td",{parentName:"tr",align:null},(0,r.kt)("a",{parentName:"td",href:"/UIExt2/Interfaces/IShellUI/"},"IShellUI")),(0,r.kt)("td",{parentName:"tr",align:null},"Accesses the parent shell UI object.")))))}c.isMDXComponent=!0;const k={},u="IShellFrame",N={unversionedId:"UIExt2/Interfaces/IShellFrame/index",id:"UIExt2/Interfaces/IShellFrame/index",title:"IShellFrame",description:"The IShellFrame is a property of IDashboard.",source:"@site/docs/UIExt2/Interfaces/IShellFrame/index.mdx",sourceDirName:"UIExt2/Interfaces/IShellFrame",slug:"/UIExt2/Interfaces/IShellFrame/",permalink:"/Frameworks/User-Interface-Extensibility-Framework/Reference/UIExt2/Interfaces/IShellFrame/",draft:!1,tags:[],version:"current",frontMatter:{},sidebar:"tutorialSidebar",previous:{title:"SetSearchCriteria",permalink:"/Frameworks/User-Interface-Extensibility-Framework/Reference/UIExt2/Interfaces/ISearchPane/SetSearchCriteria/"},next:{title:"GetSandboxAttributes",permalink:"/Frameworks/User-Interface-Extensibility-Framework/Reference/UIExt2/Interfaces/IShellFrame/GetSandboxAttributes/"}},g={},f=[{value:"Properties",id:"properties",level:2},{value:"Methods",id:"methods",level:2},{value:"Events",id:"events",level:2}],b={toc:f},y="wrapper";function I(e){let{components:t,...a}=e;return(0,r.kt)(y,(0,n.Z)({},b,a,{components:t,mdxType:"MDXLayout"}),(0,r.kt)("h1",{id:"ishellframe"},"IShellFrame"),(0,r.kt)("p",null,"The IShellFrame is a property of ",(0,r.kt)("a",{parentName:"p",href:"../IDashboard/"},"IDashboard"),"."),(0,r.kt)("p",null,"It can also be retrieved from the ",(0,r.kt)("a",{parentName:"p",href:"../IShellUI/"},"IShellUI")," using the ",(0,r.kt)("inlineCode",{parentName:"p"},"NewShellFrame")," event."),(0,r.kt)("pre",null,(0,r.kt)("code",{parentName:"pre",className:"language-javascript"},"shellUI.Events.Register(\n MFiles.Event.NewShellFrame,\n (shellFrame) => {\n\n }\n)\n")),(0,r.kt)("h2",{id:"properties"},"Properties"),(0,r.kt)(c,{components:a.components,mdxType:"Properties"}),(0,r.kt)("h2",{id:"methods"},"Methods"),(0,r.kt)(p,{components:a.components,mdxType:"Methods"}),(0,r.kt)("h2",{id:"events"},"Events"),(0,r.kt)(o,{components:a.components,mdxType:"Events"}))}I.isMDXComponent=!0}}]); \ No newline at end of file diff --git a/Frameworks/User-Interface-Extensibility-Framework/Reference/assets/js/58f68e49.b632cfd0.js b/Frameworks/User-Interface-Extensibility-Framework/Reference/assets/js/58f68e49.b632cfd0.js new file mode 100644 index 000000000..a7c72db48 --- /dev/null +++ b/Frameworks/User-Interface-Extensibility-Framework/Reference/assets/js/58f68e49.b632cfd0.js @@ -0,0 +1 @@ +"use strict";(self.webpackChunkuix_2=self.webpackChunkuix_2||[]).push([[1516],{3905:(e,t,a)=>{a.d(t,{Zo:()=>p,kt:()=>k});var n=a(67294);function r(e,t,a){return t in e?Object.defineProperty(e,t,{value:a,enumerable:!0,configurable:!0,writable:!0}):e[t]=a,e}function l(e,t){var a=Object.keys(e);if(Object.getOwnPropertySymbols){var n=Object.getOwnPropertySymbols(e);t&&(n=n.filter((function(t){return Object.getOwnPropertyDescriptor(e,t).enumerable}))),a.push.apply(a,n)}return a}function i(e){for(var t=1;t=0||(r[a]=e[a]);return r}(e,t);if(Object.getOwnPropertySymbols){var l=Object.getOwnPropertySymbols(e);for(n=0;n=0||Object.prototype.propertyIsEnumerable.call(e,a)&&(r[a]=e[a])}return r}var s=n.createContext({}),d=function(e){var t=n.useContext(s),a=t;return e&&(a="function"==typeof e?e(t):i(i({},t),e)),a},p=function(e){var t=d(e.components);return n.createElement(s.Provider,{value:t},e.children)},m="mdxType",h={inlineCode:"code",wrapper:function(e){var t=e.children;return n.createElement(n.Fragment,{},t)}},c=n.forwardRef((function(e,t){var a=e.components,r=e.mdxType,l=e.originalType,s=e.parentName,p=o(e,["components","mdxType","originalType","parentName"]),m=d(a),c=r,k=m["".concat(s,".").concat(c)]||m[c]||h[c]||l;return a?n.createElement(k,i(i({ref:t},p),{},{components:a})):n.createElement(k,i({ref:t},p))}));function k(e,t){var a=arguments,r=t&&t.mdxType;if("string"==typeof e||r){var l=a.length,i=new Array(l);i[0]=c;var o={};for(var s in t)hasOwnProperty.call(t,s)&&(o[s]=t[s]);o.originalType=e,o[m]="string"==typeof e?e:r,i[1]=o;for(var d=2;d{a.r(t),a.d(t,{assets:()=>g,contentTitle:()=>u,default:()=>I,frontMatter:()=>k,metadata:()=>N,toc:()=>f});var n=a(87462),r=(a(67294),a(3905));const l={toc:[]},i="wrapper";function o(e){let{components:t,...a}=e;return(0,r.kt)(i,(0,n.Z)({},l,a,{components:t,mdxType:"MDXLayout"}),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:null},"Event"),(0,r.kt)("th",{parentName:"tr",align:null},"Description"),(0,r.kt)("th",{parentName:"tr",align:null},"Arguments"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:null},"Stop"),(0,r.kt)("td",{parentName:"tr",align:null},"Sent before the IShellFrame is stopped."),(0,r.kt)("td",{parentName:"tr",align:null})),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:null},"Started"),(0,r.kt)("td",{parentName:"tr",align:null},"Registers event handler for the IShellFrame started event, which means that the IShellFrame ",(0,r.kt)("br",null),"is ready to be used. This event will trigger at least once for each registered callback ",(0,r.kt)("br",null),"if the IShellFrame is already started and not yet stopped."),(0,r.kt)("td",{parentName:"tr",align:null})),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:null},"ViewLocationChanged"),(0,r.kt)("td",{parentName:"tr",align:null},"Registers event handler for the IShellFrame ViewLocationChanged event, which means that the view location has changed."),(0,r.kt)("td",{parentName:"tr",align:null})),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:null},"ViewLocationChangedAsync"),(0,r.kt)("td",{parentName:"tr",align:null},"Registers event handler for the IShellFrame ViewLocationChangedAsync event, which means that the view location has changed."),(0,r.kt)("td",{parentName:"tr",align:null})),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:null},"NewCommands"),(0,r.kt)("td",{parentName:"tr",align:null},"Registers event handler for the IShellFrame NewCommands event, which means that a new ICommands interface has been created and is ready to be used."),(0,r.kt)("td",{parentName:"tr",align:null})),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:null},"NewRightPane"),(0,r.kt)("td",{parentName:"tr",align:null},"Registers event handler for the IShellFrame NewRightPane event, which means that a shell pane container is created for right shell pane."),(0,r.kt)("td",{parentName:"tr",align:null})),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:null},"NewShellListing"),(0,r.kt)("td",{parentName:"tr",align:null},"Registers event handler for the IShellFrame NewShellListing event, which means that a new shell listing object is created."),(0,r.kt)("td",{parentName:"tr",align:null},(0,r.kt)("strong",{parentName:"td"},"newShellisting")," The new IShellListing object.")))),(0,r.kt)("pre",null,(0,r.kt)("code",{parentName:"pre",className:"language-typescript"},"shellFrame.Events.Register(\n Event.NewShellListing,\n (newShellisting: IShellListing) => {\n // Do something with the new shell listing object\n },\n);\n")))}o.isMDXComponent=!0;const s={toc:[]},d="wrapper";function p(e){let{components:t,...a}=e;return(0,r.kt)(d,(0,n.Z)({},s,a,{components:t,mdxType:"MDXLayout"}),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:null},"Name"),(0,r.kt)("th",{parentName:"tr",align:null},"Description"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:null},(0,r.kt)("a",{parentName:"td",href:"./CallSimplifiedAPI/"},"CallSimplifiedAPI")),(0,r.kt)("td",{parentName:"tr",align:null},"Calls a simplified M-Files API endpoint with the specified HTTP method.",(0,r.kt)("br",null),(0,r.kt)("br",null),"NOTE: Stability is experimental. Non-backward compatible changes or removal may occur in any future release. Use of this feature is not recommended for production environments.")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:null},(0,r.kt)("a",{parentName:"td",href:"./GetSandboxAttributes/"},"GetSandboxAttributes")),(0,r.kt)("td",{parentName:"tr",align:null},"Gets the sandbox attributes for the specified Module.")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:null},(0,r.kt)("a",{parentName:"td",href:"./GetViewsById/"},"GetViewsById")),(0,r.kt)("td",{parentName:"tr",align:null},"Gets known views details as key pair value of ","<","ViewID,View Details.",">")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:null},(0,r.kt)("a",{parentName:"td",href:"./IsFolderLocation/"},"IsFolderLocation")),(0,r.kt)("td",{parentName:"tr",align:null},"Resolves if the shell frame represents a normal folder location. For example it is ",(0,r.kt)("br",null),"a search folder or view, a property folder or traditional folder, but not an ",(0,r.kt)("br",null),"object folder.")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:null},(0,r.kt)("a",{parentName:"td",href:"./IsObjectLocation/"},"IsObjectLocation")),(0,r.kt)("td",{parentName:"tr",align:null},"Resolves if the shell frame represents a object folder location.")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:null},(0,r.kt)("a",{parentName:"td",href:"./NavigateToFolder/"},"NavigateToFolder")),(0,r.kt)("td",{parentName:"tr",align:null},"Navigate to the given folder defs.")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:null},(0,r.kt)("a",{parentName:"td",href:"./NavigateToObject/"},"NavigateToObject")),(0,r.kt)("td",{parentName:"tr",align:null},"Navigate to the given object.")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:null},(0,r.kt)("a",{parentName:"td",href:"./NavigateToParent/"},"NavigateToParent")),(0,r.kt)("td",{parentName:"tr",align:null},"Performs navigation to the parent folder.")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:null},(0,r.kt)("a",{parentName:"td",href:"./ShowDashboard/"},"ShowDashboard")),(0,r.kt)("td",{parentName:"tr",align:null},"Changes the listing area to show a dashboard.")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:null},(0,r.kt)("a",{parentName:"td",href:"./ShowDefaultContent/"},"ShowDefaultContent")),(0,r.kt)("td",{parentName:"tr",align:null},"Restores the normal listing to the listing area and triggers content loading.")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:null},(0,r.kt)("a",{parentName:"td",href:"./ShowMessage/"},"ShowMessage")),(0,r.kt)("td",{parentName:"tr",align:null},"Displays a modal message box.")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:null},(0,r.kt)("a",{parentName:"td",href:"./ShowPopupDashboard/"},"ShowPopupDashboard")),(0,r.kt)("td",{parentName:"tr",align:null},"Shows a dashboard in popup window.")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:null},(0,r.kt)("a",{parentName:"td",href:"./ShowPopupDashboards/"},"ShowPopupDashboards")),(0,r.kt)("td",{parentName:"tr",align:null},"Shows multiple dashboards in a popup window with side-by-side layout.",(0,r.kt)("br",null),(0,r.kt)("br",null),"NOTE: Stability is experimental. Non-backward compatible changes or removal may occur in any future release. Use of this feature is not recommended for production environments.")))))}p.isMDXComponent=!0;const m={toc:[]},h="wrapper";function c(e){let{components:t,...a}=e;return(0,r.kt)(h,(0,n.Z)({},m,a,{components:t,mdxType:"MDXLayout"}),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:null},"Name"),(0,r.kt)("th",{parentName:"tr",align:null},"Type"),(0,r.kt)("th",{parentName:"tr",align:null},"Description"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:null},"ActiveListing"),(0,r.kt)("td",{parentName:"tr",align:null},(0,r.kt)("a",{parentName:"td",href:"/UIExt2/Interfaces/IShellListing/"},"IShellListing")),(0,r.kt)("td",{parentName:"tr",align:null},"Accesses the currently active listing object.")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:null},"Commands"),(0,r.kt)("td",{parentName:"tr",align:null},(0,r.kt)("a",{parentName:"td",href:"/UIExt2/Interfaces/ICommands/"},"ICommands")),(0,r.kt)("td",{parentName:"tr",align:null},"Accesses the commands of the shell frame.")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:null},"CurrentFolder"),(0,r.kt)("td",{parentName:"tr",align:null},(0,r.kt)("inlineCode",{parentName:"td"},"Array")," < ",(0,r.kt)("a",{parentName:"td",href:"/gRPC/Messages/Folder/"},"Folder")," >"),(0,r.kt)("td",{parentName:"tr",align:null},"Accesses the current folder location. Valid only if the current location is a normal folder location.")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:null},"CurrentPath"),(0,r.kt)("td",{parentName:"tr",align:null},(0,r.kt)("inlineCode",{parentName:"td"},"string")),(0,r.kt)("td",{parentName:"tr",align:null},"Gets the path to the current folder as string. ",(0,r.kt)("br",null)," ",(0,r.kt)("br",null),"For special views, the following built-in path strings are used: ",(0,r.kt)("br",null),"- ",(0,r.kt)("inlineCode",{parentName:"td"},"Search")," - Search view ",(0,r.kt)("br",null),"- ",(0,r.kt)("inlineCode",{parentName:"td"},"Workspaces")," - Workspaces view ",(0,r.kt)("br",null),"- ",(0,r.kt)("inlineCode",{parentName:"td"},"Pinned")," - Pinned view ",(0,r.kt)("br",null),"- ",(0,r.kt)("inlineCode",{parentName:"td"},"Checked Out to Me\\\\")," - Checked Out to Me ",(0,r.kt)("br",null),"- ",(0,r.kt)("inlineCode",{parentName:"td"},"Recently Modified by Me\\\\")," - Recently Modified by Me ",(0,r.kt)("br",null),"- ",(0,r.kt)("inlineCode",{parentName:"td"},"Assigned to Me\\\\")," - Assigned to Me ",(0,r.kt)("br",null),"- ",(0,r.kt)("inlineCode",{parentName:"td"},"Recently Accessed by Me\\\\")," - Recently Accessed by Me ",(0,r.kt)("br",null),"- ",(0,r.kt)("inlineCode",{parentName:"td"},"Object History")," - Object History ",(0,r.kt)("br",null),"- ",(0,r.kt)("inlineCode",{parentName:"td"},"Conflict Resolution")," - Conflict Resolution ",(0,r.kt)("br",null),"- ",(0,r.kt)("inlineCode",{parentName:"td"},"_singleObject")," - Single Object view (opened when navigating to an object)")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:null},"CurrentUrl"),(0,r.kt)("td",{parentName:"tr",align:null},(0,r.kt)("inlineCode",{parentName:"td"},"string")),(0,r.kt)("td",{parentName:"tr",align:null},"Gets the current view url as a string.")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:null},"Events"),(0,r.kt)("td",{parentName:"tr",align:null},(0,r.kt)("a",{parentName:"td",href:"/UIExt2/Events/#ishellframeevents"},"IShellFrameEvents")),(0,r.kt)("td",{parentName:"tr",align:null},"Returns the event registering interface for the IShellFrame interface.")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:null},"LeftPane"),(0,r.kt)("td",{parentName:"tr",align:null},(0,r.kt)("a",{parentName:"td",href:"/UIExt2/Interfaces/IShellPaneContainer/"},"IShellPaneContainer")),(0,r.kt)("td",{parentName:"tr",align:null},"Accesses the left panes of the shell frame.")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:null},"Listing"),(0,r.kt)("td",{parentName:"tr",align:null},(0,r.kt)("a",{parentName:"td",href:"/UIExt2/Interfaces/IShellListing/"},"IShellListing")),(0,r.kt)("td",{parentName:"tr",align:null},"Accesses the main listing object of the shell frame.")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:null},"ParentFolder"),(0,r.kt)("td",{parentName:"tr",align:null},(0,r.kt)("inlineCode",{parentName:"td"},"Array")," < ",(0,r.kt)("a",{parentName:"td",href:"/gRPC/Messages/Folder/"},"Folder")," >"),(0,r.kt)("td",{parentName:"tr",align:null},"Gets the parent folder for current location.")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:null},"RightPane"),(0,r.kt)("td",{parentName:"tr",align:null},(0,r.kt)("a",{parentName:"td",href:"/UIExt2/Interfaces/IShellPaneContainer/"},"IShellPaneContainer")),(0,r.kt)("td",{parentName:"tr",align:null},"Accesses the right panes of the shell frame.")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:null},"SearchPane"),(0,r.kt)("td",{parentName:"tr",align:null},(0,r.kt)("a",{parentName:"td",href:"/UIExt2/Interfaces/ISearchPane/"},"ISearchPane")),(0,r.kt)("td",{parentName:"tr",align:null},"Accesses the search pane of the shell frame.")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:null},"ShellUI"),(0,r.kt)("td",{parentName:"tr",align:null},(0,r.kt)("a",{parentName:"td",href:"/UIExt2/Interfaces/IShellUI/"},"IShellUI")),(0,r.kt)("td",{parentName:"tr",align:null},"Accesses the parent shell UI object.")))))}c.isMDXComponent=!0;const k={},u="IShellFrame",N={unversionedId:"UIExt2/Interfaces/IShellFrame/index",id:"UIExt2/Interfaces/IShellFrame/index",title:"IShellFrame",description:"The IShellFrame is a property of IDashboard.",source:"@site/docs/UIExt2/Interfaces/IShellFrame/index.mdx",sourceDirName:"UIExt2/Interfaces/IShellFrame",slug:"/UIExt2/Interfaces/IShellFrame/",permalink:"/Frameworks/User-Interface-Extensibility-Framework/Reference/UIExt2/Interfaces/IShellFrame/",draft:!1,tags:[],version:"current",frontMatter:{},sidebar:"tutorialSidebar",previous:{title:"SetSearchCriteria",permalink:"/Frameworks/User-Interface-Extensibility-Framework/Reference/UIExt2/Interfaces/ISearchPane/SetSearchCriteria/"},next:{title:"CallSimplifiedAPI",permalink:"/Frameworks/User-Interface-Extensibility-Framework/Reference/UIExt2/Interfaces/IShellFrame/CallSimplifiedAPI/"}},g={},f=[{value:"Properties",id:"properties",level:2},{value:"Methods",id:"methods",level:2},{value:"Events",id:"events",level:2}],b={toc:f},y="wrapper";function I(e){let{components:t,...a}=e;return(0,r.kt)(y,(0,n.Z)({},b,a,{components:t,mdxType:"MDXLayout"}),(0,r.kt)("h1",{id:"ishellframe"},"IShellFrame"),(0,r.kt)("p",null,"The IShellFrame is a property of ",(0,r.kt)("a",{parentName:"p",href:"../IDashboard/"},"IDashboard"),"."),(0,r.kt)("p",null,"It can also be retrieved from the ",(0,r.kt)("a",{parentName:"p",href:"../IShellUI/"},"IShellUI")," using the ",(0,r.kt)("inlineCode",{parentName:"p"},"NewShellFrame")," event."),(0,r.kt)("pre",null,(0,r.kt)("code",{parentName:"pre",className:"language-javascript"},"shellUI.Events.Register(\n MFiles.Event.NewShellFrame,\n (shellFrame) => {\n\n }\n)\n")),(0,r.kt)("h2",{id:"properties"},"Properties"),(0,r.kt)(c,{components:a.components,mdxType:"Properties"}),(0,r.kt)("h2",{id:"methods"},"Methods"),(0,r.kt)(p,{components:a.components,mdxType:"Methods"}),(0,r.kt)("h2",{id:"events"},"Events"),(0,r.kt)(o,{components:a.components,mdxType:"Events"}))}I.isMDXComponent=!0}}]); \ No newline at end of file diff --git a/Frameworks/User-Interface-Extensibility-Framework/Reference/assets/js/7feb1174.5c5fdccc.js b/Frameworks/User-Interface-Extensibility-Framework/Reference/assets/js/7feb1174.c75d7944.js similarity index 89% rename from Frameworks/User-Interface-Extensibility-Framework/Reference/assets/js/7feb1174.5c5fdccc.js rename to Frameworks/User-Interface-Extensibility-Framework/Reference/assets/js/7feb1174.c75d7944.js index 49d79d4cf..7c46bb6af 100644 --- a/Frameworks/User-Interface-Extensibility-Framework/Reference/assets/js/7feb1174.5c5fdccc.js +++ b/Frameworks/User-Interface-Extensibility-Framework/Reference/assets/js/7feb1174.c75d7944.js @@ -1 +1 @@ -"use strict";(self.webpackChunkuix_2=self.webpackChunkuix_2||[]).push([[4433],{3905:(e,t,r)=>{r.d(t,{Zo:()=>c,kt:()=>b});var n=r(67294);function a(e,t,r){return t in e?Object.defineProperty(e,t,{value:r,enumerable:!0,configurable:!0,writable:!0}):e[t]=r,e}function o(e,t){var r=Object.keys(e);if(Object.getOwnPropertySymbols){var n=Object.getOwnPropertySymbols(e);t&&(n=n.filter((function(t){return Object.getOwnPropertyDescriptor(e,t).enumerable}))),r.push.apply(r,n)}return r}function l(e){for(var t=1;t=0||(a[r]=e[r]);return a}(e,t);if(Object.getOwnPropertySymbols){var o=Object.getOwnPropertySymbols(e);for(n=0;n=0||Object.prototype.propertyIsEnumerable.call(e,r)&&(a[r]=e[r])}return a}var i=n.createContext({}),s=function(e){var t=n.useContext(i),r=t;return e&&(r="function"==typeof e?e(t):l(l({},t),e)),r},c=function(e){var t=s(e.components);return n.createElement(i.Provider,{value:t},e.children)},p="mdxType",m={inlineCode:"code",wrapper:function(e){var t=e.children;return n.createElement(n.Fragment,{},t)}},d=n.forwardRef((function(e,t){var r=e.components,a=e.mdxType,o=e.originalType,i=e.parentName,c=u(e,["components","mdxType","originalType","parentName"]),p=s(r),d=a,b=p["".concat(i,".").concat(d)]||p[d]||m[d]||o;return r?n.createElement(b,l(l({ref:t},c),{},{components:r})):n.createElement(b,l({ref:t},c))}));function b(e,t){var r=arguments,a=t&&t.mdxType;if("string"==typeof e||a){var o=r.length,l=new Array(o);l[0]=d;var u={};for(var i in t)hasOwnProperty.call(t,i)&&(u[i]=t[i]);u.originalType=e,u[p]="string"==typeof e?e:a,l[1]=u;for(var s=2;s{r.d(t,{Z:()=>l});var n=r(67294),a=r(86010);const o={tabItem:"tabItem_Ymn6"};function l(e){let{children:t,hidden:r,className:l}=e;return n.createElement("div",{role:"tabpanel",className:(0,a.Z)(o.tabItem,l),hidden:r},t)}},73992:(e,t,r)=>{r.d(t,{Z:()=>x});var n=r(87462),a=r(67294),o=r(86010),l=r(72957),u=r(16550),i=r(75238),s=r(33609),c=r(92560);function p(e){return function(e){return a.Children.map(e,(e=>{if(!e||(0,a.isValidElement)(e)&&function(e){const{props:t}=e;return!!t&&"object"==typeof t&&"value"in t}(e))return e;throw new Error(`Docusaurus error: Bad child <${"string"==typeof e.type?e.type:e.type.name}>: all children of the component should be , and every should have a unique "value" prop.`)}))?.filter(Boolean)??[]}(e).map((e=>{let{props:{value:t,label:r,attributes:n,default:a}}=e;return{value:t,label:r,attributes:n,default:a}}))}function m(e){const{values:t,children:r}=e;return(0,a.useMemo)((()=>{const e=t??p(r);return function(e){const t=(0,s.l)(e,((e,t)=>e.value===t.value));if(t.length>0)throw new Error(`Docusaurus error: Duplicate values "${t.map((e=>e.value)).join(", ")}" found in . Every value needs to be unique.`)}(e),e}),[t,r])}function d(e){let{value:t,tabValues:r}=e;return r.some((e=>e.value===t))}function b(e){let{queryString:t=!1,groupId:r}=e;const n=(0,u.k6)(),o=function(e){let{queryString:t=!1,groupId:r}=e;if("string"==typeof t)return t;if(!1===t)return null;if(!0===t&&!r)throw new Error('Docusaurus error: The component groupId prop is required if queryString=true, because this value is used as the search param name. You can also provide an explicit value such as queryString="my-search-param".');return r??null}({queryString:t,groupId:r});return[(0,i._X)(o),(0,a.useCallback)((e=>{if(!o)return;const t=new URLSearchParams(n.location.search);t.set(o,e),n.replace({...n.location,search:t.toString()})}),[o,n])]}function f(e){const{defaultValue:t,queryString:r=!1,groupId:n}=e,o=m(e),[l,u]=(0,a.useState)((()=>function(e){let{defaultValue:t,tabValues:r}=e;if(0===r.length)throw new Error("Docusaurus error: the component requires at least one children component");if(t){if(!d({value:t,tabValues:r}))throw new Error(`Docusaurus error: The has a defaultValue "${t}" but none of its children has the corresponding value. Available values are: ${r.map((e=>e.value)).join(", ")}. If you intend to show no default tab, use defaultValue={null} instead.`);return t}const n=r.find((e=>e.default))??r[0];if(!n)throw new Error("Unexpected error: 0 tabValues");return n.value}({defaultValue:t,tabValues:o}))),[i,s]=b({queryString:r,groupId:n}),[p,f]=function(e){let{groupId:t}=e;const r=function(e){return e?`docusaurus.tab.${e}`:null}(t),[n,o]=(0,c.Nk)(r);return[n,(0,a.useCallback)((e=>{r&&o.set(e)}),[r,o])]}({groupId:n}),y=(()=>{const e=i??p;return d({value:e,tabValues:o})?e:null})();(0,a.useLayoutEffect)((()=>{y&&u(y)}),[y]);return{selectedValue:l,selectValue:(0,a.useCallback)((e=>{if(!d({value:e,tabValues:o}))throw new Error(`Can't select invalid tab value=${e}`);u(e),s(e),f(e)}),[s,f,o]),tabValues:o}}var y=r(51048);const h={tabList:"tabList__CuJ",tabItem:"tabItem_LNqP"};function k(e){let{className:t,block:r,selectedValue:u,selectValue:i,tabValues:s}=e;const c=[],{blockElementScrollPositionUntilNextRender:p}=(0,l.o5)(),m=e=>{const t=e.currentTarget,r=c.indexOf(t),n=s[r].value;n!==u&&(p(t),i(n))},d=e=>{let t=null;switch(e.key){case"Enter":m(e);break;case"ArrowRight":{const r=c.indexOf(e.currentTarget)+1;t=c[r]??c[0];break}case"ArrowLeft":{const r=c.indexOf(e.currentTarget)-1;t=c[r]??c[c.length-1];break}}t?.focus()};return a.createElement("ul",{role:"tablist","aria-orientation":"horizontal",className:(0,o.Z)("tabs",{"tabs--block":r},t)},s.map((e=>{let{value:t,label:r,attributes:l}=e;return a.createElement("li",(0,n.Z)({role:"tab",tabIndex:u===t?0:-1,"aria-selected":u===t,key:t,ref:e=>c.push(e),onKeyDown:d,onClick:m},l,{className:(0,o.Z)("tabs__item",h.tabItem,l?.className,{"tabs__item--active":u===t})}),r??t)})))}function v(e){let{lazy:t,children:r,selectedValue:n}=e;const o=(Array.isArray(r)?r:[r]).filter(Boolean);if(t){const e=o.find((e=>e.props.value===n));return e?(0,a.cloneElement)(e,{className:"margin-top--md"}):null}return a.createElement("div",{className:"margin-top--md"},o.map(((e,t)=>(0,a.cloneElement)(e,{key:t,hidden:e.props.value!==n}))))}function g(e){const t=f(e);return a.createElement("div",{className:(0,o.Z)("tabs-container",h.tabList)},a.createElement(k,(0,n.Z)({},e,t)),a.createElement(v,(0,n.Z)({},e,t)))}function x(e){const t=(0,y.Z)();return a.createElement(g,(0,n.Z)({key:String(t)},e))}},86844:(e,t,r)=>{r.r(t),r.d(t,{assets:()=>x,contentTitle:()=>v,default:()=>N,frontMatter:()=>k,metadata:()=>g,toc:()=>I});var n=r(87462),a=(r(67294),r(3905));const o={toc:[]},l="wrapper";function u(e){let{components:t,...r}=e;return(0,a.kt)(l,(0,n.Z)({},o,r,{components:t,mdxType:"MDXLayout"}),(0,a.kt)("table",null,(0,a.kt)("thead",{parentName:"table"},(0,a.kt)("tr",{parentName:"thead"},(0,a.kt)("th",{parentName:"tr",align:null},"Type"),(0,a.kt)("th",{parentName:"tr",align:null},"Description"))),(0,a.kt)("tbody",{parentName:"table"},(0,a.kt)("tr",{parentName:"tbody"},(0,a.kt)("td",{parentName:"tr",align:null},"Promise < ",(0,a.kt)("inlineCode",{parentName:"td"},"string")," >"),(0,a.kt)("td",{parentName:"tr",align:null},"The sandbox attributes or undefined if not found.")))))}u.isMDXComponent=!0;const i={toc:[]},s="wrapper";function c(e){let{components:t,...r}=e;return(0,a.kt)(s,(0,n.Z)({},i,r,{components:t,mdxType:"MDXLayout"}),(0,a.kt)("table",null,(0,a.kt)("thead",{parentName:"table"},(0,a.kt)("tr",{parentName:"thead"},(0,a.kt)("th",{parentName:"tr",align:null},"Name"),(0,a.kt)("th",{parentName:"tr",align:null},"Optionality"),(0,a.kt)("th",{parentName:"tr",align:null},"Type"),(0,a.kt)("th",{parentName:"tr",align:null},"Description"))),(0,a.kt)("tbody",{parentName:"table"},(0,a.kt)("tr",{parentName:"tbody"},(0,a.kt)("td",{parentName:"tr",align:null},"dashboardId"),(0,a.kt)("td",{parentName:"tr",align:null},"Required"),(0,a.kt)("td",{parentName:"tr",align:null},(0,a.kt)("inlineCode",{parentName:"td"},"string")," ","|"," ",(0,a.kt)("inlineCode",{parentName:"td"},"number")),(0,a.kt)("td",{parentName:"tr",align:null},"The ID of the dashboard.")))))}c.isMDXComponent=!0;r(73992);var p=r(18679);const m={toc:[]},d="wrapper";function b(e){let{components:t,...r}=e;return(0,a.kt)(d,(0,n.Z)({},m,r,{components:t,mdxType:"MDXLayout"}),(0,a.kt)(p.Z,{value:"js",label:"JavaScript",mdxType:"TabItem"},(0,a.kt)("pre",null,(0,a.kt)("code",{parentName:"pre",className:"language-js"},"// shellFrame points to instance of IShellFrame\nconst result = await shellFrame.GetSandboxAttributes(dashboardId);\n"))))}b.isMDXComponent=!0;const f={toc:[]},y="wrapper";function h(e){let{components:t,...r}=e;return(0,a.kt)(y,(0,n.Z)({},f,r,{components:t,mdxType:"MDXLayout"}),(0,a.kt)("p",null,"Gets the sandbox attributes for the specified Module."))}h.isMDXComponent=!0;const k={},v="GetSandboxAttributes",g={unversionedId:"UIExt2/Interfaces/IShellFrame/GetSandboxAttributes/index",id:"UIExt2/Interfaces/IShellFrame/GetSandboxAttributes/index",title:"GetSandboxAttributes",description:"Description",source:"@site/docs/UIExt2/Interfaces/IShellFrame/GetSandboxAttributes/index.mdx",sourceDirName:"UIExt2/Interfaces/IShellFrame/GetSandboxAttributes",slug:"/UIExt2/Interfaces/IShellFrame/GetSandboxAttributes/",permalink:"/Frameworks/User-Interface-Extensibility-Framework/Reference/UIExt2/Interfaces/IShellFrame/GetSandboxAttributes/",draft:!1,tags:[],version:"current",frontMatter:{},sidebar:"tutorialSidebar",previous:{title:"IShellFrame",permalink:"/Frameworks/User-Interface-Extensibility-Framework/Reference/UIExt2/Interfaces/IShellFrame/"},next:{title:"GetViewsById",permalink:"/Frameworks/User-Interface-Extensibility-Framework/Reference/UIExt2/Interfaces/IShellFrame/GetViewsById/"}},x={},I=[{value:"Description",id:"description",level:2},{value:"Syntax",id:"syntax",level:2},{value:"Parameters",id:"parameters",level:2},{value:"Return type",id:"return-type",level:2}],w={toc:I},E="wrapper";function N(e){let{components:t,...r}=e;return(0,a.kt)(E,(0,n.Z)({},w,r,{components:t,mdxType:"MDXLayout"}),(0,a.kt)("h1",{id:"getsandboxattributes"},"GetSandboxAttributes"),(0,a.kt)("h2",{id:"description"},"Description"),(0,a.kt)(h,{components:r.components,mdxType:"Description"}),(0,a.kt)("h2",{id:"syntax"},"Syntax"),(0,a.kt)(b,{components:r.components,mdxType:"Syntax"}),(0,a.kt)("h2",{id:"parameters"},"Parameters"),(0,a.kt)(c,{components:r.components,mdxType:"Params"}),(0,a.kt)("h2",{id:"return-type"},"Return type"),(0,a.kt)(u,{components:r.components,mdxType:"Returns"}))}N.isMDXComponent=!0}}]); \ No newline at end of file +"use strict";(self.webpackChunkuix_2=self.webpackChunkuix_2||[]).push([[4433],{3905:(e,t,r)=>{r.d(t,{Zo:()=>c,kt:()=>b});var n=r(67294);function a(e,t,r){return t in e?Object.defineProperty(e,t,{value:r,enumerable:!0,configurable:!0,writable:!0}):e[t]=r,e}function o(e,t){var r=Object.keys(e);if(Object.getOwnPropertySymbols){var n=Object.getOwnPropertySymbols(e);t&&(n=n.filter((function(t){return Object.getOwnPropertyDescriptor(e,t).enumerable}))),r.push.apply(r,n)}return r}function l(e){for(var t=1;t=0||(a[r]=e[r]);return a}(e,t);if(Object.getOwnPropertySymbols){var o=Object.getOwnPropertySymbols(e);for(n=0;n=0||Object.prototype.propertyIsEnumerable.call(e,r)&&(a[r]=e[r])}return a}var i=n.createContext({}),s=function(e){var t=n.useContext(i),r=t;return e&&(r="function"==typeof e?e(t):l(l({},t),e)),r},c=function(e){var t=s(e.components);return n.createElement(i.Provider,{value:t},e.children)},p="mdxType",m={inlineCode:"code",wrapper:function(e){var t=e.children;return n.createElement(n.Fragment,{},t)}},d=n.forwardRef((function(e,t){var r=e.components,a=e.mdxType,o=e.originalType,i=e.parentName,c=u(e,["components","mdxType","originalType","parentName"]),p=s(r),d=a,b=p["".concat(i,".").concat(d)]||p[d]||m[d]||o;return r?n.createElement(b,l(l({ref:t},c),{},{components:r})):n.createElement(b,l({ref:t},c))}));function b(e,t){var r=arguments,a=t&&t.mdxType;if("string"==typeof e||a){var o=r.length,l=new Array(o);l[0]=d;var u={};for(var i in t)hasOwnProperty.call(t,i)&&(u[i]=t[i]);u.originalType=e,u[p]="string"==typeof e?e:a,l[1]=u;for(var s=2;s{r.d(t,{Z:()=>l});var n=r(67294),a=r(86010);const o={tabItem:"tabItem_Ymn6"};function l(e){let{children:t,hidden:r,className:l}=e;return n.createElement("div",{role:"tabpanel",className:(0,a.Z)(o.tabItem,l),hidden:r},t)}},73992:(e,t,r)=>{r.d(t,{Z:()=>x});var n=r(87462),a=r(67294),o=r(86010),l=r(72957),u=r(16550),i=r(75238),s=r(33609),c=r(92560);function p(e){return function(e){return a.Children.map(e,(e=>{if(!e||(0,a.isValidElement)(e)&&function(e){const{props:t}=e;return!!t&&"object"==typeof t&&"value"in t}(e))return e;throw new Error(`Docusaurus error: Bad child <${"string"==typeof e.type?e.type:e.type.name}>: all children of the component should be , and every should have a unique "value" prop.`)}))?.filter(Boolean)??[]}(e).map((e=>{let{props:{value:t,label:r,attributes:n,default:a}}=e;return{value:t,label:r,attributes:n,default:a}}))}function m(e){const{values:t,children:r}=e;return(0,a.useMemo)((()=>{const e=t??p(r);return function(e){const t=(0,s.l)(e,((e,t)=>e.value===t.value));if(t.length>0)throw new Error(`Docusaurus error: Duplicate values "${t.map((e=>e.value)).join(", ")}" found in . Every value needs to be unique.`)}(e),e}),[t,r])}function d(e){let{value:t,tabValues:r}=e;return r.some((e=>e.value===t))}function b(e){let{queryString:t=!1,groupId:r}=e;const n=(0,u.k6)(),o=function(e){let{queryString:t=!1,groupId:r}=e;if("string"==typeof t)return t;if(!1===t)return null;if(!0===t&&!r)throw new Error('Docusaurus error: The component groupId prop is required if queryString=true, because this value is used as the search param name. You can also provide an explicit value such as queryString="my-search-param".');return r??null}({queryString:t,groupId:r});return[(0,i._X)(o),(0,a.useCallback)((e=>{if(!o)return;const t=new URLSearchParams(n.location.search);t.set(o,e),n.replace({...n.location,search:t.toString()})}),[o,n])]}function f(e){const{defaultValue:t,queryString:r=!1,groupId:n}=e,o=m(e),[l,u]=(0,a.useState)((()=>function(e){let{defaultValue:t,tabValues:r}=e;if(0===r.length)throw new Error("Docusaurus error: the component requires at least one children component");if(t){if(!d({value:t,tabValues:r}))throw new Error(`Docusaurus error: The has a defaultValue "${t}" but none of its children has the corresponding value. Available values are: ${r.map((e=>e.value)).join(", ")}. If you intend to show no default tab, use defaultValue={null} instead.`);return t}const n=r.find((e=>e.default))??r[0];if(!n)throw new Error("Unexpected error: 0 tabValues");return n.value}({defaultValue:t,tabValues:o}))),[i,s]=b({queryString:r,groupId:n}),[p,f]=function(e){let{groupId:t}=e;const r=function(e){return e?`docusaurus.tab.${e}`:null}(t),[n,o]=(0,c.Nk)(r);return[n,(0,a.useCallback)((e=>{r&&o.set(e)}),[r,o])]}({groupId:n}),y=(()=>{const e=i??p;return d({value:e,tabValues:o})?e:null})();(0,a.useLayoutEffect)((()=>{y&&u(y)}),[y]);return{selectedValue:l,selectValue:(0,a.useCallback)((e=>{if(!d({value:e,tabValues:o}))throw new Error(`Can't select invalid tab value=${e}`);u(e),s(e),f(e)}),[s,f,o]),tabValues:o}}var y=r(51048);const h={tabList:"tabList__CuJ",tabItem:"tabItem_LNqP"};function k(e){let{className:t,block:r,selectedValue:u,selectValue:i,tabValues:s}=e;const c=[],{blockElementScrollPositionUntilNextRender:p}=(0,l.o5)(),m=e=>{const t=e.currentTarget,r=c.indexOf(t),n=s[r].value;n!==u&&(p(t),i(n))},d=e=>{let t=null;switch(e.key){case"Enter":m(e);break;case"ArrowRight":{const r=c.indexOf(e.currentTarget)+1;t=c[r]??c[0];break}case"ArrowLeft":{const r=c.indexOf(e.currentTarget)-1;t=c[r]??c[c.length-1];break}}t?.focus()};return a.createElement("ul",{role:"tablist","aria-orientation":"horizontal",className:(0,o.Z)("tabs",{"tabs--block":r},t)},s.map((e=>{let{value:t,label:r,attributes:l}=e;return a.createElement("li",(0,n.Z)({role:"tab",tabIndex:u===t?0:-1,"aria-selected":u===t,key:t,ref:e=>c.push(e),onKeyDown:d,onClick:m},l,{className:(0,o.Z)("tabs__item",h.tabItem,l?.className,{"tabs__item--active":u===t})}),r??t)})))}function v(e){let{lazy:t,children:r,selectedValue:n}=e;const o=(Array.isArray(r)?r:[r]).filter(Boolean);if(t){const e=o.find((e=>e.props.value===n));return e?(0,a.cloneElement)(e,{className:"margin-top--md"}):null}return a.createElement("div",{className:"margin-top--md"},o.map(((e,t)=>(0,a.cloneElement)(e,{key:t,hidden:e.props.value!==n}))))}function g(e){const t=f(e);return a.createElement("div",{className:(0,o.Z)("tabs-container",h.tabList)},a.createElement(k,(0,n.Z)({},e,t)),a.createElement(v,(0,n.Z)({},e,t)))}function x(e){const t=(0,y.Z)();return a.createElement(g,(0,n.Z)({key:String(t)},e))}},86844:(e,t,r)=>{r.r(t),r.d(t,{assets:()=>x,contentTitle:()=>v,default:()=>N,frontMatter:()=>k,metadata:()=>g,toc:()=>I});var n=r(87462),a=(r(67294),r(3905));const o={toc:[]},l="wrapper";function u(e){let{components:t,...r}=e;return(0,a.kt)(l,(0,n.Z)({},o,r,{components:t,mdxType:"MDXLayout"}),(0,a.kt)("table",null,(0,a.kt)("thead",{parentName:"table"},(0,a.kt)("tr",{parentName:"thead"},(0,a.kt)("th",{parentName:"tr",align:null},"Type"),(0,a.kt)("th",{parentName:"tr",align:null},"Description"))),(0,a.kt)("tbody",{parentName:"table"},(0,a.kt)("tr",{parentName:"tbody"},(0,a.kt)("td",{parentName:"tr",align:null},"Promise < ",(0,a.kt)("inlineCode",{parentName:"td"},"string")," >"),(0,a.kt)("td",{parentName:"tr",align:null},"The sandbox attributes or undefined if not found.")))))}u.isMDXComponent=!0;const i={toc:[]},s="wrapper";function c(e){let{components:t,...r}=e;return(0,a.kt)(s,(0,n.Z)({},i,r,{components:t,mdxType:"MDXLayout"}),(0,a.kt)("table",null,(0,a.kt)("thead",{parentName:"table"},(0,a.kt)("tr",{parentName:"thead"},(0,a.kt)("th",{parentName:"tr",align:null},"Name"),(0,a.kt)("th",{parentName:"tr",align:null},"Optionality"),(0,a.kt)("th",{parentName:"tr",align:null},"Type"),(0,a.kt)("th",{parentName:"tr",align:null},"Description"))),(0,a.kt)("tbody",{parentName:"table"},(0,a.kt)("tr",{parentName:"tbody"},(0,a.kt)("td",{parentName:"tr",align:null},"dashboardId"),(0,a.kt)("td",{parentName:"tr",align:null},"Required"),(0,a.kt)("td",{parentName:"tr",align:null},(0,a.kt)("inlineCode",{parentName:"td"},"string")," ","|"," ",(0,a.kt)("inlineCode",{parentName:"td"},"number")),(0,a.kt)("td",{parentName:"tr",align:null},"The ID of the dashboard.")))))}c.isMDXComponent=!0;r(73992);var p=r(18679);const m={toc:[]},d="wrapper";function b(e){let{components:t,...r}=e;return(0,a.kt)(d,(0,n.Z)({},m,r,{components:t,mdxType:"MDXLayout"}),(0,a.kt)(p.Z,{value:"js",label:"JavaScript",mdxType:"TabItem"},(0,a.kt)("pre",null,(0,a.kt)("code",{parentName:"pre",className:"language-js"},"// shellFrame points to instance of IShellFrame\nconst result = await shellFrame.GetSandboxAttributes(dashboardId);\n"))))}b.isMDXComponent=!0;const f={toc:[]},y="wrapper";function h(e){let{components:t,...r}=e;return(0,a.kt)(y,(0,n.Z)({},f,r,{components:t,mdxType:"MDXLayout"}),(0,a.kt)("p",null,"Gets the sandbox attributes for the specified Module."))}h.isMDXComponent=!0;const k={},v="GetSandboxAttributes",g={unversionedId:"UIExt2/Interfaces/IShellFrame/GetSandboxAttributes/index",id:"UIExt2/Interfaces/IShellFrame/GetSandboxAttributes/index",title:"GetSandboxAttributes",description:"Description",source:"@site/docs/UIExt2/Interfaces/IShellFrame/GetSandboxAttributes/index.mdx",sourceDirName:"UIExt2/Interfaces/IShellFrame/GetSandboxAttributes",slug:"/UIExt2/Interfaces/IShellFrame/GetSandboxAttributes/",permalink:"/Frameworks/User-Interface-Extensibility-Framework/Reference/UIExt2/Interfaces/IShellFrame/GetSandboxAttributes/",draft:!1,tags:[],version:"current",frontMatter:{},sidebar:"tutorialSidebar",previous:{title:"CallSimplifiedAPI",permalink:"/Frameworks/User-Interface-Extensibility-Framework/Reference/UIExt2/Interfaces/IShellFrame/CallSimplifiedAPI/"},next:{title:"GetViewsById",permalink:"/Frameworks/User-Interface-Extensibility-Framework/Reference/UIExt2/Interfaces/IShellFrame/GetViewsById/"}},x={},I=[{value:"Description",id:"description",level:2},{value:"Syntax",id:"syntax",level:2},{value:"Parameters",id:"parameters",level:2},{value:"Return type",id:"return-type",level:2}],w={toc:I},E="wrapper";function N(e){let{components:t,...r}=e;return(0,a.kt)(E,(0,n.Z)({},w,r,{components:t,mdxType:"MDXLayout"}),(0,a.kt)("h1",{id:"getsandboxattributes"},"GetSandboxAttributes"),(0,a.kt)("h2",{id:"description"},"Description"),(0,a.kt)(h,{components:r.components,mdxType:"Description"}),(0,a.kt)("h2",{id:"syntax"},"Syntax"),(0,a.kt)(b,{components:r.components,mdxType:"Syntax"}),(0,a.kt)("h2",{id:"parameters"},"Parameters"),(0,a.kt)(c,{components:r.components,mdxType:"Params"}),(0,a.kt)("h2",{id:"return-type"},"Return type"),(0,a.kt)(u,{components:r.components,mdxType:"Returns"}))}N.isMDXComponent=!0}}]); \ No newline at end of file diff --git a/Frameworks/User-Interface-Extensibility-Framework/Reference/assets/js/935f2afb.21c737ca.js b/Frameworks/User-Interface-Extensibility-Framework/Reference/assets/js/935f2afb.21c737ca.js new file mode 100644 index 000000000..af7ab735b --- /dev/null +++ b/Frameworks/User-Interface-Extensibility-Framework/Reference/assets/js/935f2afb.21c737ca.js @@ -0,0 +1 @@ +"use strict";(self.webpackChunkuix_2=self.webpackChunkuix_2||[]).push([[53],{1109:e=>{e.exports=JSON.parse('{"pluginId":"default","version":"current","label":"Next","banner":null,"badge":false,"noIndex":false,"className":"docs-version-current","isLast":true,"docsSidebars":{"tutorialSidebar":[{"type":"link","label":"Getting Started","href":"/Frameworks/User-Interface-Extensibility-Framework/Reference/","docId":"getting_started"},{"type":"category","label":"Overview","collapsible":true,"collapsed":true,"items":[{"type":"link","label":"Application Structure","href":"/Frameworks/User-Interface-Extensibility-Framework/Reference/Overview/ApplicationStructure","docId":"Overview/ApplicationStructure"},{"type":"link","label":"Modules","href":"/Frameworks/User-Interface-Extensibility-Framework/Reference/Overview/Modules","docId":"Overview/Modules"},{"type":"link","label":"Events","href":"/Frameworks/User-Interface-Extensibility-Framework/Reference/Overview/Events","docId":"Overview/Events"},{"type":"link","label":"Dashboards","href":"/Frameworks/User-Interface-Extensibility-Framework/Reference/Overview/Dashboards","docId":"Overview/Dashboards"},{"type":"link","label":"Dialogs and Messages","href":"/Frameworks/User-Interface-Extensibility-Framework/Reference/Overview/Messages","docId":"Overview/Messages"},{"type":"link","label":"Using Custom Commands","href":"/Frameworks/User-Interface-Extensibility-Framework/Reference/Overview/Commands","docId":"Overview/Commands"},{"type":"link","label":"Vault API Helpers","href":"/Frameworks/User-Interface-Extensibility-Framework/Reference/Overview/VaultMessages","docId":"Overview/VaultMessages"},{"type":"link","label":"Working with the Shell Listing","href":"/Frameworks/User-Interface-Extensibility-Framework/Reference/Overview/ListingView","docId":"Overview/ListingView"},{"type":"link","label":"Tabs","href":"/Frameworks/User-Interface-Extensibility-Framework/Reference/Overview/Tabs","docId":"Overview/Tabs"},{"type":"link","label":"Installing Applications","href":"/Frameworks/User-Interface-Extensibility-Framework/Reference/Overview/InstallingApplications","docId":"Overview/InstallingApplications"},{"type":"link","label":"Testing and Developing","href":"/Frameworks/User-Interface-Extensibility-Framework/Reference/Overview/Debugging","docId":"Overview/Debugging"},{"type":"link","label":"MFiles Global Object","href":"/Frameworks/User-Interface-Extensibility-Framework/Reference/Overview/MFilesGlobalObject","docId":"Overview/MFilesGlobalObject"},{"type":"link","label":"Exception Reference","href":"/Frameworks/User-Interface-Extensibility-Framework/Reference/Overview/exceptions","docId":"Overview/exceptions"}],"href":"/Frameworks/User-Interface-Extensibility-Framework/Reference/Overview/"},{"type":"category","label":"API Reference Guide","collapsible":true,"collapsed":true,"items":[{"type":"link","label":"Events","href":"/Frameworks/User-Interface-Extensibility-Framework/Reference/UIExt2/Events","docId":"UIExt2/Events"},{"type":"category","label":"Enums","collapsible":true,"collapsed":true,"items":[{"type":"link","label":"BuiltInIcon","href":"/Frameworks/User-Interface-Extensibility-Framework/Reference/UIExt2/Enums/BuiltInIcon/","docId":"UIExt2/Enums/BuiltInIcon/index"},{"type":"link","label":"BuiltinCommand","href":"/Frameworks/User-Interface-Extensibility-Framework/Reference/UIExt2/Enums/BuiltinCommand/","docId":"UIExt2/Enums/BuiltinCommand/index"},{"type":"link","label":"CommandLocation","href":"/Frameworks/User-Interface-Extensibility-Framework/Reference/UIExt2/Enums/CommandLocation/","docId":"UIExt2/Enums/CommandLocation/index"},{"type":"link","label":"CommandState","href":"/Frameworks/User-Interface-Extensibility-Framework/Reference/UIExt2/Enums/CommandState/","docId":"UIExt2/Enums/CommandState/index"},{"type":"link","label":"Event","href":"/Frameworks/User-Interface-Extensibility-Framework/Reference/UIExt2/Enums/Event/","docId":"UIExt2/Enums/Event/index"},{"type":"link","label":"FacetRangeType","href":"/Frameworks/User-Interface-Extensibility-Framework/Reference/UIExt2/Enums/FacetRangeType/","docId":"UIExt2/Enums/FacetRangeType/index"},{"type":"link","label":"FacetTransformation","href":"/Frameworks/User-Interface-Extensibility-Framework/Reference/UIExt2/Enums/FacetTransformation/","docId":"UIExt2/Enums/FacetTransformation/index"},{"type":"link","label":"FacetType","href":"/Frameworks/User-Interface-Extensibility-Framework/Reference/UIExt2/Enums/FacetType/","docId":"UIExt2/Enums/FacetType/index"},{"type":"link","label":"FacetValueType","href":"/Frameworks/User-Interface-Extensibility-Framework/Reference/UIExt2/Enums/FacetValueType/","docId":"UIExt2/Enums/FacetValueType/index"},{"type":"link","label":"IconContentType","href":"/Frameworks/User-Interface-Extensibility-Framework/Reference/UIExt2/Enums/IconContentType/","docId":"UIExt2/Enums/IconContentType/index"},{"type":"link","label":"MFBuiltInObjectType","href":"/Frameworks/User-Interface-Extensibility-Framework/Reference/UIExt2/Enums/MFBuiltInObjectType/","docId":"UIExt2/Enums/MFBuiltInObjectType/index"},{"type":"link","label":"MFBuiltInPropertyDef","href":"/Frameworks/User-Interface-Extensibility-Framework/Reference/UIExt2/Enums/MFBuiltInPropertyDef/","docId":"UIExt2/Enums/MFBuiltInPropertyDef/index"},{"type":"link","label":"MFBuiltInValueList","href":"/Frameworks/User-Interface-Extensibility-Framework/Reference/UIExt2/Enums/MFBuiltInValueList/","docId":"UIExt2/Enums/MFBuiltInValueList/index"},{"type":"link","label":"MFBuiltInView","href":"/Frameworks/User-Interface-Extensibility-Framework/Reference/UIExt2/Enums/MFBuiltInView/","docId":"UIExt2/Enums/MFBuiltInView/index"},{"type":"link","label":"MenuLocation","href":"/Frameworks/User-Interface-Extensibility-Framework/Reference/UIExt2/Enums/MenuLocation/","docId":"UIExt2/Enums/MenuLocation/index"},{"type":"link","label":"ObjectWindowResultCode","href":"/Frameworks/User-Interface-Extensibility-Framework/Reference/UIExt2/Enums/ObjectWindowResultCode/","docId":"UIExt2/Enums/ObjectWindowResultCode/index"},{"type":"link","label":"SearchEngine","href":"/Frameworks/User-Interface-Extensibility-Framework/Reference/UIExt2/Enums/SearchEngine/","docId":"UIExt2/Enums/SearchEngine/index"},{"type":"link","label":"ToastType","href":"/Frameworks/User-Interface-Extensibility-Framework/Reference/UIExt2/Enums/ToastType/","docId":"UIExt2/Enums/ToastType/index"}],"href":"/Frameworks/User-Interface-Extensibility-Framework/Reference/UIExt2/Enums/"},{"type":"category","label":"Interfaces","collapsible":true,"collapsed":true,"items":[{"type":"category","label":"ICommands","collapsible":true,"collapsed":true,"items":[{"type":"link","label":"AddCustomCommandToMenu","href":"/Frameworks/User-Interface-Extensibility-Framework/Reference/UIExt2/Interfaces/ICommands/AddCustomCommandToMenu/","docId":"UIExt2/Interfaces/ICommands/AddCustomCommandToMenu/index"},{"type":"link","label":"CreateCustomCommand","href":"/Frameworks/User-Interface-Extensibility-Framework/Reference/UIExt2/Interfaces/ICommands/CreateCustomCommand/","docId":"UIExt2/Interfaces/ICommands/CreateCustomCommand/index"},{"type":"link","label":"CreateSubMenuItem","href":"/Frameworks/User-Interface-Extensibility-Framework/Reference/UIExt2/Interfaces/ICommands/CreateSubMenuItem/","docId":"UIExt2/Interfaces/ICommands/CreateSubMenuItem/index"},{"type":"link","label":"CreateTaskbarGroup","href":"/Frameworks/User-Interface-Extensibility-Framework/Reference/UIExt2/Interfaces/ICommands/CreateTaskbarGroup/","docId":"UIExt2/Interfaces/ICommands/CreateTaskbarGroup/index"},{"type":"link","label":"DeleteCustomCommand","href":"/Frameworks/User-Interface-Extensibility-Framework/Reference/UIExt2/Interfaces/ICommands/DeleteCustomCommand/","docId":"UIExt2/Interfaces/ICommands/DeleteCustomCommand/index"},{"type":"link","label":"ExecuteCommand","href":"/Frameworks/User-Interface-Extensibility-Framework/Reference/UIExt2/Interfaces/ICommands/ExecuteCommand/","docId":"UIExt2/Interfaces/ICommands/ExecuteCommand/index"},{"type":"link","label":"GetCommandName","href":"/Frameworks/User-Interface-Extensibility-Framework/Reference/UIExt2/Interfaces/ICommands/GetCommandName/","docId":"UIExt2/Interfaces/ICommands/GetCommandName/index"},{"type":"link","label":"GetCommandState","href":"/Frameworks/User-Interface-Extensibility-Framework/Reference/UIExt2/Interfaces/ICommands/GetCommandState/","docId":"UIExt2/Interfaces/ICommands/GetCommandState/index"},{"type":"link","label":"GetMenuIdOfBuiltInCommand","href":"/Frameworks/User-Interface-Extensibility-Framework/Reference/UIExt2/Interfaces/ICommands/GetMenuIdOfBuiltInCommand/","docId":"UIExt2/Interfaces/ICommands/GetMenuIdOfBuiltInCommand/index"},{"type":"link","label":"RemoveCustomCommandFromMenu","href":"/Frameworks/User-Interface-Extensibility-Framework/Reference/UIExt2/Interfaces/ICommands/RemoveCustomCommandFromMenu/","docId":"UIExt2/Interfaces/ICommands/RemoveCustomCommandFromMenu/index"},{"type":"link","label":"RemoveMenuItem","href":"/Frameworks/User-Interface-Extensibility-Framework/Reference/UIExt2/Interfaces/ICommands/RemoveMenuItem/","docId":"UIExt2/Interfaces/ICommands/RemoveMenuItem/index"},{"type":"link","label":"RemoveTaskbarGroup","href":"/Frameworks/User-Interface-Extensibility-Framework/Reference/UIExt2/Interfaces/ICommands/RemoveTaskbarGroup/","docId":"UIExt2/Interfaces/ICommands/RemoveTaskbarGroup/index"},{"type":"link","label":"SetCommandState","href":"/Frameworks/User-Interface-Extensibility-Framework/Reference/UIExt2/Interfaces/ICommands/SetCommandState/","docId":"UIExt2/Interfaces/ICommands/SetCommandState/index"},{"type":"link","label":"SetIcon","href":"/Frameworks/User-Interface-Extensibility-Framework/Reference/UIExt2/Interfaces/ICommands/SetIcon/","docId":"UIExt2/Interfaces/ICommands/SetIcon/index"},{"type":"link","label":"SetMenuItemState","href":"/Frameworks/User-Interface-Extensibility-Framework/Reference/UIExt2/Interfaces/ICommands/SetMenuItemState/","docId":"UIExt2/Interfaces/ICommands/SetMenuItemState/index"},{"type":"link","label":"SetTaskbarGroupIcon","href":"/Frameworks/User-Interface-Extensibility-Framework/Reference/UIExt2/Interfaces/ICommands/SetTaskbarGroupIcon/","docId":"UIExt2/Interfaces/ICommands/SetTaskbarGroupIcon/index"}],"href":"/Frameworks/User-Interface-Extensibility-Framework/Reference/UIExt2/Interfaces/ICommands/"},{"type":"category","label":"ICommonFunctions","collapsible":true,"collapsed":true,"items":[{"type":"link","label":"DeleteFromWebStorage","href":"/Frameworks/User-Interface-Extensibility-Framework/Reference/UIExt2/Interfaces/ICommonFunctions/DeleteFromWebStorage/","docId":"UIExt2/Interfaces/ICommonFunctions/DeleteFromWebStorage/index"},{"type":"link","label":"DownloadFileAsDataUri","href":"/Frameworks/User-Interface-Extensibility-Framework/Reference/UIExt2/Interfaces/ICommonFunctions/DownloadFileAsDataUri/","docId":"UIExt2/Interfaces/ICommonFunctions/DownloadFileAsDataUri/index"},{"type":"link","label":"GetAccentColor","href":"/Frameworks/User-Interface-Extensibility-Framework/Reference/UIExt2/Interfaces/ICommonFunctions/GetAccentColor/","docId":"UIExt2/Interfaces/ICommonFunctions/GetAccentColor/index"},{"type":"link","label":"GetClientLanguage","href":"/Frameworks/User-Interface-Extensibility-Framework/Reference/UIExt2/Interfaces/ICommonFunctions/GetClientLanguage/","docId":"UIExt2/Interfaces/ICommonFunctions/GetClientLanguage/index"},{"type":"link","label":"GetClientLocale","href":"/Frameworks/User-Interface-Extensibility-Framework/Reference/UIExt2/Interfaces/ICommonFunctions/GetClientLocale/","docId":"UIExt2/Interfaces/ICommonFunctions/GetClientLocale/index"},{"type":"link","label":"GetClientLocaleIn3Letters","href":"/Frameworks/User-Interface-Extensibility-Framework/Reference/UIExt2/Interfaces/ICommonFunctions/GetClientLocaleIn3Letters/","docId":"UIExt2/Interfaces/ICommonFunctions/GetClientLocaleIn3Letters/index"},{"type":"link","label":"GetSessionInfo","href":"/Frameworks/User-Interface-Extensibility-Framework/Reference/UIExt2/Interfaces/ICommonFunctions/GetSessionInfo/","docId":"UIExt2/Interfaces/ICommonFunctions/GetSessionInfo/index"},{"type":"link","label":"GetUTCOffset","href":"/Frameworks/User-Interface-Extensibility-Framework/Reference/UIExt2/Interfaces/ICommonFunctions/GetUTCOffset/","docId":"UIExt2/Interfaces/ICommonFunctions/GetUTCOffset/index"},{"type":"link","label":"GetVaultInfo","href":"/Frameworks/User-Interface-Extensibility-Framework/Reference/UIExt2/Interfaces/ICommonFunctions/GetVaultInfo/","docId":"UIExt2/Interfaces/ICommonFunctions/GetVaultInfo/index"},{"type":"link","label":"GetWebLink","href":"/Frameworks/User-Interface-Extensibility-Framework/Reference/UIExt2/Interfaces/ICommonFunctions/GetWebLink/","docId":"UIExt2/Interfaces/ICommonFunctions/GetWebLink/index"},{"type":"link","label":"OpenExternalWebLink","href":"/Frameworks/User-Interface-Extensibility-Framework/Reference/UIExt2/Interfaces/ICommonFunctions/OpenExternalWebLink/","docId":"UIExt2/Interfaces/ICommonFunctions/OpenExternalWebLink/index"},{"type":"link","label":"ReadFromWebStorage","href":"/Frameworks/User-Interface-Extensibility-Framework/Reference/UIExt2/Interfaces/ICommonFunctions/ReadFromWebStorage/","docId":"UIExt2/Interfaces/ICommonFunctions/ReadFromWebStorage/index"},{"type":"link","label":"ReportException","href":"/Frameworks/User-Interface-Extensibility-Framework/Reference/UIExt2/Interfaces/ICommonFunctions/ReportException/","docId":"UIExt2/Interfaces/ICommonFunctions/ReportException/index"},{"type":"link","label":"ShowEditObjectWindow","href":"/Frameworks/User-Interface-Extensibility-Framework/Reference/UIExt2/Interfaces/ICommonFunctions/ShowEditObjectWindow/","docId":"UIExt2/Interfaces/ICommonFunctions/ShowEditObjectWindow/index"},{"type":"link","label":"ShowNewObjectWindow","href":"/Frameworks/User-Interface-Extensibility-Framework/Reference/UIExt2/Interfaces/ICommonFunctions/ShowNewObjectWindow/","docId":"UIExt2/Interfaces/ICommonFunctions/ShowNewObjectWindow/index"},{"type":"link","label":"ShowToast","href":"/Frameworks/User-Interface-Extensibility-Framework/Reference/UIExt2/Interfaces/ICommonFunctions/ShowToast/","docId":"UIExt2/Interfaces/ICommonFunctions/ShowToast/index"},{"type":"link","label":"UploadTemporaryFiles","href":"/Frameworks/User-Interface-Extensibility-Framework/Reference/UIExt2/Interfaces/ICommonFunctions/UploadTemporaryFiles/","docId":"UIExt2/Interfaces/ICommonFunctions/UploadTemporaryFiles/index"},{"type":"link","label":"WriteToWebStorage","href":"/Frameworks/User-Interface-Extensibility-Framework/Reference/UIExt2/Interfaces/ICommonFunctions/WriteToWebStorage/","docId":"UIExt2/Interfaces/ICommonFunctions/WriteToWebStorage/index"}],"href":"/Frameworks/User-Interface-Extensibility-Framework/Reference/UIExt2/Interfaces/ICommonFunctions/"},{"type":"category","label":"IDashboard","collapsible":true,"collapsed":true,"items":[{"type":"link","label":"GetSandboxAttributes","href":"/Frameworks/User-Interface-Extensibility-Framework/Reference/UIExt2/Interfaces/IDashboard/GetSandboxAttributes/","docId":"UIExt2/Interfaces/IDashboard/GetSandboxAttributes/index"},{"type":"link","label":"ShowMessage","href":"/Frameworks/User-Interface-Extensibility-Framework/Reference/UIExt2/Interfaces/IDashboard/ShowMessage/","docId":"UIExt2/Interfaces/IDashboard/ShowMessage/index"},{"type":"link","label":"ShowPopupDashboard","href":"/Frameworks/User-Interface-Extensibility-Framework/Reference/UIExt2/Interfaces/IDashboard/ShowPopupDashboard/","docId":"UIExt2/Interfaces/IDashboard/ShowPopupDashboard/index"},{"type":"link","label":"UpdateCustomData","href":"/Frameworks/User-Interface-Extensibility-Framework/Reference/UIExt2/Interfaces/IDashboard/UpdateCustomData/","docId":"UIExt2/Interfaces/IDashboard/UpdateCustomData/index"},{"type":"link","label":"WaitForClose","href":"/Frameworks/User-Interface-Extensibility-Framework/Reference/UIExt2/Interfaces/IDashboard/WaitForClose/","docId":"UIExt2/Interfaces/IDashboard/WaitForClose/index"}],"href":"/Frameworks/User-Interface-Extensibility-Framework/Reference/UIExt2/Interfaces/IDashboard/"},{"type":"category","label":"IEvents","collapsible":true,"collapsed":true,"items":[{"type":"link","label":"Register","href":"/Frameworks/User-Interface-Extensibility-Framework/Reference/UIExt2/Interfaces/IEvents/Register/","docId":"UIExt2/Interfaces/IEvents/Register/index"},{"type":"link","label":"RegisterBuiltinCommand","href":"/Frameworks/User-Interface-Extensibility-Framework/Reference/UIExt2/Interfaces/IEvents/RegisterBuiltinCommand/","docId":"UIExt2/Interfaces/IEvents/RegisterBuiltinCommand/index"},{"type":"link","label":"Unregister","href":"/Frameworks/User-Interface-Extensibility-Framework/Reference/UIExt2/Interfaces/IEvents/Unregister/","docId":"UIExt2/Interfaces/IEvents/Unregister/index"}],"href":"/Frameworks/User-Interface-Extensibility-Framework/Reference/UIExt2/Interfaces/IEvents/"},{"type":"category","label":"ISearchPane","collapsible":true,"collapsed":true,"items":[{"type":"link","label":"GetOptions","href":"/Frameworks/User-Interface-Extensibility-Framework/Reference/UIExt2/Interfaces/ISearchPane/GetOptions/","docId":"UIExt2/Interfaces/ISearchPane/GetOptions/index"},{"type":"link","label":"GetSearchCriteria","href":"/Frameworks/User-Interface-Extensibility-Framework/Reference/UIExt2/Interfaces/ISearchPane/GetSearchCriteria/","docId":"UIExt2/Interfaces/ISearchPane/GetSearchCriteria/index"},{"type":"link","label":"IsSearchView","href":"/Frameworks/User-Interface-Extensibility-Framework/Reference/UIExt2/Interfaces/ISearchPane/IsSearchView/","docId":"UIExt2/Interfaces/ISearchPane/IsSearchView/index"},{"type":"link","label":"SetOptionState","href":"/Frameworks/User-Interface-Extensibility-Framework/Reference/UIExt2/Interfaces/ISearchPane/SetOptionState/","docId":"UIExt2/Interfaces/ISearchPane/SetOptionState/index"},{"type":"link","label":"SetSearchCriteria","href":"/Frameworks/User-Interface-Extensibility-Framework/Reference/UIExt2/Interfaces/ISearchPane/SetSearchCriteria/","docId":"UIExt2/Interfaces/ISearchPane/SetSearchCriteria/index"}],"href":"/Frameworks/User-Interface-Extensibility-Framework/Reference/UIExt2/Interfaces/ISearchPane/"},{"type":"category","label":"IShellFrame","collapsible":true,"collapsed":true,"items":[{"type":"link","label":"CallSimplifiedAPI","href":"/Frameworks/User-Interface-Extensibility-Framework/Reference/UIExt2/Interfaces/IShellFrame/CallSimplifiedAPI/","docId":"UIExt2/Interfaces/IShellFrame/CallSimplifiedAPI/index"},{"type":"link","label":"GetSandboxAttributes","href":"/Frameworks/User-Interface-Extensibility-Framework/Reference/UIExt2/Interfaces/IShellFrame/GetSandboxAttributes/","docId":"UIExt2/Interfaces/IShellFrame/GetSandboxAttributes/index"},{"type":"link","label":"GetViewsById","href":"/Frameworks/User-Interface-Extensibility-Framework/Reference/UIExt2/Interfaces/IShellFrame/GetViewsById/","docId":"UIExt2/Interfaces/IShellFrame/GetViewsById/index"},{"type":"link","label":"IsFolderLocation","href":"/Frameworks/User-Interface-Extensibility-Framework/Reference/UIExt2/Interfaces/IShellFrame/IsFolderLocation/","docId":"UIExt2/Interfaces/IShellFrame/IsFolderLocation/index"},{"type":"link","label":"IsObjectLocation","href":"/Frameworks/User-Interface-Extensibility-Framework/Reference/UIExt2/Interfaces/IShellFrame/IsObjectLocation/","docId":"UIExt2/Interfaces/IShellFrame/IsObjectLocation/index"},{"type":"link","label":"NavigateToFolder","href":"/Frameworks/User-Interface-Extensibility-Framework/Reference/UIExt2/Interfaces/IShellFrame/NavigateToFolder/","docId":"UIExt2/Interfaces/IShellFrame/NavigateToFolder/index"},{"type":"link","label":"NavigateToObject","href":"/Frameworks/User-Interface-Extensibility-Framework/Reference/UIExt2/Interfaces/IShellFrame/NavigateToObject/","docId":"UIExt2/Interfaces/IShellFrame/NavigateToObject/index"},{"type":"link","label":"NavigateToParent","href":"/Frameworks/User-Interface-Extensibility-Framework/Reference/UIExt2/Interfaces/IShellFrame/NavigateToParent/","docId":"UIExt2/Interfaces/IShellFrame/NavigateToParent/index"},{"type":"link","label":"ShowDashboard","href":"/Frameworks/User-Interface-Extensibility-Framework/Reference/UIExt2/Interfaces/IShellFrame/ShowDashboard/","docId":"UIExt2/Interfaces/IShellFrame/ShowDashboard/index"},{"type":"link","label":"ShowDefaultContent","href":"/Frameworks/User-Interface-Extensibility-Framework/Reference/UIExt2/Interfaces/IShellFrame/ShowDefaultContent/","docId":"UIExt2/Interfaces/IShellFrame/ShowDefaultContent/index"},{"type":"link","label":"ShowMessage","href":"/Frameworks/User-Interface-Extensibility-Framework/Reference/UIExt2/Interfaces/IShellFrame/ShowMessage/","docId":"UIExt2/Interfaces/IShellFrame/ShowMessage/index"},{"type":"link","label":"ShowPopupDashboard","href":"/Frameworks/User-Interface-Extensibility-Framework/Reference/UIExt2/Interfaces/IShellFrame/ShowPopupDashboard/","docId":"UIExt2/Interfaces/IShellFrame/ShowPopupDashboard/index"},{"type":"link","label":"ShowPopupDashboards","href":"/Frameworks/User-Interface-Extensibility-Framework/Reference/UIExt2/Interfaces/IShellFrame/ShowPopupDashboards/","docId":"UIExt2/Interfaces/IShellFrame/ShowPopupDashboards/index"}],"href":"/Frameworks/User-Interface-Extensibility-Framework/Reference/UIExt2/Interfaces/IShellFrame/"},{"type":"category","label":"IShellItems","collapsible":true,"collapsed":true,"items":[{"type":"link","label":"GetFoldersCount","href":"/Frameworks/User-Interface-Extensibility-Framework/Reference/UIExt2/Interfaces/IShellItems/GetFoldersCount/","docId":"UIExt2/Interfaces/IShellItems/GetFoldersCount/index"},{"type":"link","label":"GetObjectVersionsAndProperties","href":"/Frameworks/User-Interface-Extensibility-Framework/Reference/UIExt2/Interfaces/IShellItems/GetObjectVersionsAndProperties/","docId":"UIExt2/Interfaces/IShellItems/GetObjectVersionsAndProperties/index"},{"type":"link","label":"GetObjectVersionsCount","href":"/Frameworks/User-Interface-Extensibility-Framework/Reference/UIExt2/Interfaces/IShellItems/GetObjectVersionsCount/","docId":"UIExt2/Interfaces/IShellItems/GetObjectVersionsCount/index"}],"href":"/Frameworks/User-Interface-Extensibility-Framework/Reference/UIExt2/Interfaces/IShellItems/"},{"type":"category","label":"IShellListing","collapsible":true,"collapsed":true,"items":[{"type":"link","label":"ActivateListing","href":"/Frameworks/User-Interface-Extensibility-Framework/Reference/UIExt2/Interfaces/IShellListing/ActivateListing/","docId":"UIExt2/Interfaces/IShellListing/ActivateListing/index"},{"type":"link","label":"ActivateSelected","href":"/Frameworks/User-Interface-Extensibility-Framework/Reference/UIExt2/Interfaces/IShellListing/ActivateSelected/","docId":"UIExt2/Interfaces/IShellListing/ActivateSelected/index"},{"type":"link","label":"AddListingItem","href":"/Frameworks/User-Interface-Extensibility-Framework/Reference/UIExt2/Interfaces/IShellListing/AddListingItem/","docId":"UIExt2/Interfaces/IShellListing/AddListingItem/index"},{"type":"link","label":"AddObjectFile","href":"/Frameworks/User-Interface-Extensibility-Framework/Reference/UIExt2/Interfaces/IShellListing/AddObjectFile/","docId":"UIExt2/Interfaces/IShellListing/AddObjectFile/index"},{"type":"link","label":"GetFolderName","href":"/Frameworks/User-Interface-Extensibility-Framework/Reference/UIExt2/Interfaces/IShellListing/GetFolderName/","docId":"UIExt2/Interfaces/IShellListing/GetFolderName/index"},{"type":"link","label":"RefreshListing","href":"/Frameworks/User-Interface-Extensibility-Framework/Reference/UIExt2/Interfaces/IShellListing/RefreshListing/","docId":"UIExt2/Interfaces/IShellListing/RefreshListing/index"},{"type":"link","label":"RefreshObject","href":"/Frameworks/User-Interface-Extensibility-Framework/Reference/UIExt2/Interfaces/IShellListing/RefreshObject/","docId":"UIExt2/Interfaces/IShellListing/RefreshObject/index"},{"type":"link","label":"RemoveListingItem","href":"/Frameworks/User-Interface-Extensibility-Framework/Reference/UIExt2/Interfaces/IShellListing/RemoveListingItem/","docId":"UIExt2/Interfaces/IShellListing/RemoveListingItem/index"},{"type":"link","label":"ReplaceFile","href":"/Frameworks/User-Interface-Extensibility-Framework/Reference/UIExt2/Interfaces/IShellListing/ReplaceFile/","docId":"UIExt2/Interfaces/IShellListing/ReplaceFile/index"},{"type":"link","label":"SelectFolder","href":"/Frameworks/User-Interface-Extensibility-Framework/Reference/UIExt2/Interfaces/IShellListing/SelectFolder/","docId":"UIExt2/Interfaces/IShellListing/SelectFolder/index"},{"type":"link","label":"SelectNextFolder","href":"/Frameworks/User-Interface-Extensibility-Framework/Reference/UIExt2/Interfaces/IShellListing/SelectNextFolder/","docId":"UIExt2/Interfaces/IShellListing/SelectNextFolder/index"},{"type":"link","label":"SelectNextObject","href":"/Frameworks/User-Interface-Extensibility-Framework/Reference/UIExt2/Interfaces/IShellListing/SelectNextObject/","docId":"UIExt2/Interfaces/IShellListing/SelectNextObject/index"},{"type":"link","label":"SelectNextObjectFile","href":"/Frameworks/User-Interface-Extensibility-Framework/Reference/UIExt2/Interfaces/IShellListing/SelectNextObjectFile/","docId":"UIExt2/Interfaces/IShellListing/SelectNextObjectFile/index"},{"type":"link","label":"SelectObjectFile","href":"/Frameworks/User-Interface-Extensibility-Framework/Reference/UIExt2/Interfaces/IShellListing/SelectObjectFile/","docId":"UIExt2/Interfaces/IShellListing/SelectObjectFile/index"},{"type":"link","label":"SelectObjectOrObjectFileVersion","href":"/Frameworks/User-Interface-Extensibility-Framework/Reference/UIExt2/Interfaces/IShellListing/SelectObjectOrObjectFileVersion/","docId":"UIExt2/Interfaces/IShellListing/SelectObjectOrObjectFileVersion/index"},{"type":"link","label":"SelectObjectVersion","href":"/Frameworks/User-Interface-Extensibility-Framework/Reference/UIExt2/Interfaces/IShellListing/SelectObjectVersion/","docId":"UIExt2/Interfaces/IShellListing/SelectObjectVersion/index"},{"type":"link","label":"SelectPrevFolder","href":"/Frameworks/User-Interface-Extensibility-Framework/Reference/UIExt2/Interfaces/IShellListing/SelectPrevFolder/","docId":"UIExt2/Interfaces/IShellListing/SelectPrevFolder/index"},{"type":"link","label":"SelectPrevObject","href":"/Frameworks/User-Interface-Extensibility-Framework/Reference/UIExt2/Interfaces/IShellListing/SelectPrevObject/","docId":"UIExt2/Interfaces/IShellListing/SelectPrevObject/index"},{"type":"link","label":"SelectPrevObjectFile","href":"/Frameworks/User-Interface-Extensibility-Framework/Reference/UIExt2/Interfaces/IShellListing/SelectPrevObjectFile/","docId":"UIExt2/Interfaces/IShellListing/SelectPrevObjectFile/index"},{"type":"link","label":"SetFolderOrObjectVersionSelectionStates","href":"/Frameworks/User-Interface-Extensibility-Framework/Reference/UIExt2/Interfaces/IShellListing/SetFolderOrObjectVersionSelectionStates/","docId":"UIExt2/Interfaces/IShellListing/SetFolderOrObjectVersionSelectionStates/index"},{"type":"link","label":"SetFolderSelectionStates","href":"/Frameworks/User-Interface-Extensibility-Framework/Reference/UIExt2/Interfaces/IShellListing/SetFolderSelectionStates/","docId":"UIExt2/Interfaces/IShellListing/SetFolderSelectionStates/index"},{"type":"link","label":"SetObjectOrObjectFileVersionSelectionStates","href":"/Frameworks/User-Interface-Extensibility-Framework/Reference/UIExt2/Interfaces/IShellListing/SetObjectOrObjectFileVersionSelectionStates/","docId":"UIExt2/Interfaces/IShellListing/SetObjectOrObjectFileVersionSelectionStates/index"},{"type":"link","label":"SetObjectVersionSelectionStates","href":"/Frameworks/User-Interface-Extensibility-Framework/Reference/UIExt2/Interfaces/IShellListing/SetObjectVersionSelectionStates/","docId":"UIExt2/Interfaces/IShellListing/SetObjectVersionSelectionStates/index"},{"type":"link","label":"SetVirtualSelection","href":"/Frameworks/User-Interface-Extensibility-Framework/Reference/UIExt2/Interfaces/IShellListing/SetVirtualSelection/","docId":"UIExt2/Interfaces/IShellListing/SetVirtualSelection/index"},{"type":"link","label":"UnselectAll","href":"/Frameworks/User-Interface-Extensibility-Framework/Reference/UIExt2/Interfaces/IShellListing/UnselectAll/","docId":"UIExt2/Interfaces/IShellListing/UnselectAll/index"},{"type":"link","label":"UpdateListingItem","href":"/Frameworks/User-Interface-Extensibility-Framework/Reference/UIExt2/Interfaces/IShellListing/UpdateListingItem/","docId":"UIExt2/Interfaces/IShellListing/UpdateListingItem/index"}],"href":"/Frameworks/User-Interface-Extensibility-Framework/Reference/UIExt2/Interfaces/IShellListing/"},{"type":"category","label":"IShellPaneContainer","collapsible":true,"collapsed":true,"items":[{"type":"link","label":"AddTab","href":"/Frameworks/User-Interface-Extensibility-Framework/Reference/UIExt2/Interfaces/IShellPaneContainer/AddTab/","docId":"UIExt2/Interfaces/IShellPaneContainer/AddTab/index"},{"type":"link","label":"GetSelectedTabs","href":"/Frameworks/User-Interface-Extensibility-Framework/Reference/UIExt2/Interfaces/IShellPaneContainer/GetSelectedTabs/","docId":"UIExt2/Interfaces/IShellPaneContainer/GetSelectedTabs/index"},{"type":"link","label":"GetTab","href":"/Frameworks/User-Interface-Extensibility-Framework/Reference/UIExt2/Interfaces/IShellPaneContainer/GetTab/","docId":"UIExt2/Interfaces/IShellPaneContainer/GetTab/index"}],"href":"/Frameworks/User-Interface-Extensibility-Framework/Reference/UIExt2/Interfaces/IShellPaneContainer/"},{"type":"category","label":"IShellPaneTab","collapsible":true,"collapsed":true,"items":[{"type":"link","label":"Remove","href":"/Frameworks/User-Interface-Extensibility-Framework/Reference/UIExt2/Interfaces/IShellPaneTab/Remove/","docId":"UIExt2/Interfaces/IShellPaneTab/Remove/index"},{"type":"link","label":"Select","href":"/Frameworks/User-Interface-Extensibility-Framework/Reference/UIExt2/Interfaces/IShellPaneTab/Select/","docId":"UIExt2/Interfaces/IShellPaneTab/Select/index"},{"type":"link","label":"SetVisible","href":"/Frameworks/User-Interface-Extensibility-Framework/Reference/UIExt2/Interfaces/IShellPaneTab/SetVisible/","docId":"UIExt2/Interfaces/IShellPaneTab/SetVisible/index"},{"type":"link","label":"ShowDashboard","href":"/Frameworks/User-Interface-Extensibility-Framework/Reference/UIExt2/Interfaces/IShellPaneTab/ShowDashboard/","docId":"UIExt2/Interfaces/IShellPaneTab/ShowDashboard/index"},{"type":"link","label":"ShowEmptyContent","href":"/Frameworks/User-Interface-Extensibility-Framework/Reference/UIExt2/Interfaces/IShellPaneTab/ShowEmptyContent/","docId":"UIExt2/Interfaces/IShellPaneTab/ShowEmptyContent/index"},{"type":"link","label":"Unselect","href":"/Frameworks/User-Interface-Extensibility-Framework/Reference/UIExt2/Interfaces/IShellPaneTab/Unselect/","docId":"UIExt2/Interfaces/IShellPaneTab/Unselect/index"}],"href":"/Frameworks/User-Interface-Extensibility-Framework/Reference/UIExt2/Interfaces/IShellPaneTab/"},{"type":"category","label":"IShellUI","collapsible":true,"collapsed":true,"items":[{"type":"link","label":"BroadcastMessage","href":"/Frameworks/User-Interface-Extensibility-Framework/Reference/UIExt2/Interfaces/IShellUI/BroadcastMessage/","docId":"UIExt2/Interfaces/IShellUI/BroadcastMessage/index"},{"type":"link","label":"GetFileTypeIconURL","href":"/Frameworks/User-Interface-Extensibility-Framework/Reference/UIExt2/Interfaces/IShellUI/GetFileTypeIconURL/","docId":"UIExt2/Interfaces/IShellUI/GetFileTypeIconURL/index"},{"type":"link","label":"GetObjectTypeIconURL","href":"/Frameworks/User-Interface-Extensibility-Framework/Reference/UIExt2/Interfaces/IShellUI/GetObjectTypeIconURL/","docId":"UIExt2/Interfaces/IShellUI/GetObjectTypeIconURL/index"},{"type":"link","label":"GetValueListItemIconURL","href":"/Frameworks/User-Interface-Extensibility-Framework/Reference/UIExt2/Interfaces/IShellUI/GetValueListItemIconURL/","docId":"UIExt2/Interfaces/IShellUI/GetValueListItemIconURL/index"},{"type":"link","label":"NotifyApplication","href":"/Frameworks/User-Interface-Extensibility-Framework/Reference/UIExt2/Interfaces/IShellUI/NotifyApplication/","docId":"UIExt2/Interfaces/IShellUI/NotifyApplication/index"},{"type":"link","label":"ShowMessage","href":"/Frameworks/User-Interface-Extensibility-Framework/Reference/UIExt2/Interfaces/IShellUI/ShowMessage/","docId":"UIExt2/Interfaces/IShellUI/ShowMessage/index"},{"type":"link","label":"ShowPopupDashboard","href":"/Frameworks/User-Interface-Extensibility-Framework/Reference/UIExt2/Interfaces/IShellUI/ShowPopupDashboard/","docId":"UIExt2/Interfaces/IShellUI/ShowPopupDashboard/index"}],"href":"/Frameworks/User-Interface-Extensibility-Framework/Reference/UIExt2/Interfaces/IShellUI/"},{"type":"category","label":"IWindow","collapsible":true,"collapsed":true,"items":[{"type":"link","label":"Close","href":"/Frameworks/User-Interface-Extensibility-Framework/Reference/UIExt2/Interfaces/IWindow/Close/","docId":"UIExt2/Interfaces/IWindow/Close/index"},{"type":"link","label":"ResizeToDefaultSize","href":"/Frameworks/User-Interface-Extensibility-Framework/Reference/UIExt2/Interfaces/IWindow/ResizeToDefaultSize/","docId":"UIExt2/Interfaces/IWindow/ResizeToDefaultSize/index"},{"type":"link","label":"SetCloseIconVisibility","href":"/Frameworks/User-Interface-Extensibility-Framework/Reference/UIExt2/Interfaces/IWindow/SetCloseIconVisibility/","docId":"UIExt2/Interfaces/IWindow/SetCloseIconVisibility/index"},{"type":"link","label":"SetDefaultSize","href":"/Frameworks/User-Interface-Extensibility-Framework/Reference/UIExt2/Interfaces/IWindow/SetDefaultSize/","docId":"UIExt2/Interfaces/IWindow/SetDefaultSize/index"},{"type":"link","label":"SetSize","href":"/Frameworks/User-Interface-Extensibility-Framework/Reference/UIExt2/Interfaces/IWindow/SetSize/","docId":"UIExt2/Interfaces/IWindow/SetSize/index"},{"type":"link","label":"SetTitle","href":"/Frameworks/User-Interface-Extensibility-Framework/Reference/UIExt2/Interfaces/IWindow/SetTitle/","docId":"UIExt2/Interfaces/IWindow/SetTitle/index"}],"href":"/Frameworks/User-Interface-Extensibility-Framework/Reference/UIExt2/Interfaces/IWindow/"},{"type":"link","label":"TListingActionArgs","href":"/Frameworks/User-Interface-Extensibility-Framework/Reference/UIExt2/Interfaces/TListingActionArgs/","docId":"UIExt2/Interfaces/TListingActionArgs/index"}],"href":"/Frameworks/User-Interface-Extensibility-Framework/Reference/UIExt2/Interfaces/"},{"type":"category","label":"Models","collapsible":true,"collapsed":true,"items":[{"type":"link","label":"DashboardConfig","href":"/Frameworks/User-Interface-Extensibility-Framework/Reference/UIExt2/Models/DashboardConfig/","docId":"UIExt2/Models/DashboardConfig/index"},{"type":"link","label":"DialogUIParams","href":"/Frameworks/User-Interface-Extensibility-Framework/Reference/UIExt2/Models/DialogUIParams/","docId":"UIExt2/Models/DialogUIParams/index"},{"type":"link","label":"Facet","href":"/Frameworks/User-Interface-Extensibility-Framework/Reference/UIExt2/Models/Facet/","docId":"UIExt2/Models/Facet/index"},{"type":"link","label":"FacetDefinition","href":"/Frameworks/User-Interface-Extensibility-Framework/Reference/UIExt2/Models/FacetDefinition/","docId":"UIExt2/Models/FacetDefinition/index"},{"type":"link","label":"FacetLookupValue","href":"/Frameworks/User-Interface-Extensibility-Framework/Reference/UIExt2/Models/FacetLookupValue/","docId":"UIExt2/Models/FacetLookupValue/index"},{"type":"link","label":"FacetNumericRangeValue","href":"/Frameworks/User-Interface-Extensibility-Framework/Reference/UIExt2/Models/FacetNumericRangeValue/","docId":"UIExt2/Models/FacetNumericRangeValue/index"},{"type":"link","label":"FacetNumericValue","href":"/Frameworks/User-Interface-Extensibility-Framework/Reference/UIExt2/Models/FacetNumericValue/","docId":"UIExt2/Models/FacetNumericValue/index"},{"type":"link","label":"FacetStringValue","href":"/Frameworks/User-Interface-Extensibility-Framework/Reference/UIExt2/Models/FacetStringValue/","docId":"UIExt2/Models/FacetStringValue/index"},{"type":"link","label":"FacetValue","href":"/Frameworks/User-Interface-Extensibility-Framework/Reference/UIExt2/Models/FacetValue/","docId":"UIExt2/Models/FacetValue/index"},{"type":"link","label":"FtsScope","href":"/Frameworks/User-Interface-Extensibility-Framework/Reference/UIExt2/Models/FtsScope/","docId":"UIExt2/Models/FtsScope/index"},{"type":"link","label":"IIconInformation","href":"/Frameworks/User-Interface-Extensibility-Framework/Reference/UIExt2/Models/IIconInformation/","docId":"UIExt2/Models/IIconInformation/index"},{"type":"link","label":"INonSensitiveVaultData","href":"/Frameworks/User-Interface-Extensibility-Framework/Reference/UIExt2/Models/INonSensitiveVaultData/","docId":"UIExt2/Models/INonSensitiveVaultData/index"},{"type":"link","label":"ISelectedFile","href":"/Frameworks/User-Interface-Extensibility-Framework/Reference/UIExt2/Models/ISelectedFile/","docId":"UIExt2/Models/ISelectedFile/index"},{"type":"link","label":"IVaultInfo","href":"/Frameworks/User-Interface-Extensibility-Framework/Reference/UIExt2/Models/IVaultInfo/","docId":"UIExt2/Models/IVaultInfo/index"},{"type":"link","label":"IVaultInfoReturnValue","href":"/Frameworks/User-Interface-Extensibility-Framework/Reference/UIExt2/Models/IVaultInfoReturnValue/","docId":"UIExt2/Models/IVaultInfoReturnValue/index"},{"type":"link","label":"LookupValue","href":"/Frameworks/User-Interface-Extensibility-Framework/Reference/UIExt2/Models/LookupValue/","docId":"UIExt2/Models/LookupValue/index"},{"type":"link","label":"MFError","href":"/Frameworks/User-Interface-Extensibility-Framework/Reference/UIExt2/Models/MFError/","docId":"UIExt2/Models/MFError/index"},{"type":"link","label":"MultiDashboardUIParams","href":"/Frameworks/User-Interface-Extensibility-Framework/Reference/UIExt2/Models/MultiDashboardUIParams/","docId":"UIExt2/Models/MultiDashboardUIParams/index"},{"type":"link","label":"NonSensitiveSessionData","href":"/Frameworks/User-Interface-Extensibility-Framework/Reference/UIExt2/Models/NonSensitiveSessionData/","docId":"UIExt2/Models/NonSensitiveSessionData/index"},{"type":"link","label":"NumericRangeValue","href":"/Frameworks/User-Interface-Extensibility-Framework/Reference/UIExt2/Models/NumericRangeValue/","docId":"UIExt2/Models/NumericRangeValue/index"},{"type":"link","label":"NumericValue","href":"/Frameworks/User-Interface-Extensibility-Framework/Reference/UIExt2/Models/NumericValue/","docId":"UIExt2/Models/NumericValue/index"},{"type":"link","label":"ObjectCreationInfo","href":"/Frameworks/User-Interface-Extensibility-Framework/Reference/UIExt2/Models/ObjectCreationInfo/","docId":"UIExt2/Models/ObjectCreationInfo/index"},{"type":"link","label":"ObjectFile","href":"/Frameworks/User-Interface-Extensibility-Framework/Reference/UIExt2/Models/ObjectFile/","docId":"UIExt2/Models/ObjectFile/index"},{"type":"link","label":"ObjectFileVersionArgumentValue","href":"/Frameworks/User-Interface-Extensibility-Framework/Reference/UIExt2/Models/ObjectFileVersionArgumentValue/","docId":"UIExt2/Models/ObjectFileVersionArgumentValue/index"},{"type":"link","label":"ObjectFileVersionParams","href":"/Frameworks/User-Interface-Extensibility-Framework/Reference/UIExt2/Models/ObjectFileVersionParams/","docId":"UIExt2/Models/ObjectFileVersionParams/index"},{"type":"link","label":"ObjectWindowResult","href":"/Frameworks/User-Interface-Extensibility-Framework/Reference/UIExt2/Models/ObjectWindowResult/","docId":"UIExt2/Models/ObjectWindowResult/index"},{"type":"link","label":"SearchCriteria","href":"/Frameworks/User-Interface-Extensibility-Framework/Reference/UIExt2/Models/SearchCriteria/","docId":"UIExt2/Models/SearchCriteria/index"},{"type":"link","label":"ShellFrameFolders","href":"/Frameworks/User-Interface-Extensibility-Framework/Reference/UIExt2/Models/ShellFrameFolders/","docId":"UIExt2/Models/ShellFrameFolders/index"},{"type":"link","label":"ShowMessageArgumentValue","href":"/Frameworks/User-Interface-Extensibility-Framework/Reference/UIExt2/Models/ShowMessageArgumentValue/","docId":"UIExt2/Models/ShowMessageArgumentValue/index"},{"type":"link","label":"ShowMessageParams","href":"/Frameworks/User-Interface-Extensibility-Framework/Reference/UIExt2/Models/ShowMessageParams/","docId":"UIExt2/Models/ShowMessageParams/index"},{"type":"link","label":"ShowMessageReturnValue","href":"/Frameworks/User-Interface-Extensibility-Framework/Reference/UIExt2/Models/ShowMessageReturnValue/","docId":"UIExt2/Models/ShowMessageReturnValue/index"},{"type":"link","label":"StringValue","href":"/Frameworks/User-Interface-Extensibility-Framework/Reference/UIExt2/Models/StringValue/","docId":"UIExt2/Models/StringValue/index"},{"type":"link","label":"VaultInfoReturnValue","href":"/Frameworks/User-Interface-Extensibility-Framework/Reference/UIExt2/Models/VaultInfoReturnValue/","docId":"UIExt2/Models/VaultInfoReturnValue/index"}],"href":"/Frameworks/User-Interface-Extensibility-Framework/Reference/UIExt2/Models/"}],"href":"/Frameworks/User-Interface-Extensibility-Framework/Reference/UIExt2/"},{"type":"category","label":"Vault API Reference Guide","collapsible":true,"collapsed":true,"items":[{"type":"category","label":"Enums","collapsible":true,"collapsed":true,"items":[{"type":"link","label":"ACLEnforcingMode","href":"/Frameworks/User-Interface-Extensibility-Framework/Reference/gRPC/Enums/ACLEnforcingMode/","docId":"gRPC/Enums/ACLEnforcingMode/index"},{"type":"link","label":"AccessControlSubjectType","href":"/Frameworks/User-Interface-Extensibility-Framework/Reference/gRPC/Enums/AccessControlSubjectType/","docId":"gRPC/Enums/AccessControlSubjectType/index"},{"type":"link","label":"AuthType","href":"/Frameworks/User-Interface-Extensibility-Framework/Reference/gRPC/Enums/AuthType/","docId":"gRPC/Enums/AuthType/index"},{"type":"link","label":"AutomaticValueType","href":"/Frameworks/User-Interface-Extensibility-Framework/Reference/gRPC/Enums/AutomaticValueType/","docId":"gRPC/Enums/AutomaticValueType/index"},{"type":"link","label":"CallImportance","href":"/Frameworks/User-Interface-Extensibility-Framework/Reference/gRPC/Enums/CallImportance/","docId":"gRPC/Enums/CallImportance/index"},{"type":"link","label":"ConditionType","href":"/Frameworks/User-Interface-Extensibility-Framework/Reference/gRPC/Enums/ConditionType/","docId":"gRPC/Enums/ConditionType/index"},{"type":"link","label":"ContentType","href":"/Frameworks/User-Interface-Extensibility-Framework/Reference/gRPC/Enums/ContentType/","docId":"gRPC/Enums/ContentType/index"},{"type":"link","label":"DataFunction","href":"/Frameworks/User-Interface-Extensibility-Framework/Reference/gRPC/Enums/DataFunction/","docId":"gRPC/Enums/DataFunction/index"},{"type":"link","label":"Datatype","href":"/Frameworks/User-Interface-Extensibility-Framework/Reference/gRPC/Enums/Datatype/","docId":"gRPC/Enums/Datatype/index"},{"type":"link","label":"EventType","href":"/Frameworks/User-Interface-Extensibility-Framework/Reference/gRPC/Enums/EventType/","docId":"gRPC/Enums/EventType/index"},{"type":"link","label":"ExpressionType","href":"/Frameworks/User-Interface-Extensibility-Framework/Reference/gRPC/Enums/ExpressionType/","docId":"gRPC/Enums/ExpressionType/index"},{"type":"link","label":"ExtDBRefreshType","href":"/Frameworks/User-Interface-Extensibility-Framework/Reference/gRPC/Enums/ExtDBRefreshType/","docId":"gRPC/Enums/ExtDBRefreshType/index"},{"type":"link","label":"ExtIDStatus","href":"/Frameworks/User-Interface-Extensibility-Framework/Reference/gRPC/Enums/ExtIDStatus/","docId":"gRPC/Enums/ExtIDStatus/index"},{"type":"link","label":"FileIDType","href":"/Frameworks/User-Interface-Extensibility-Framework/Reference/gRPC/Enums/FileIDType/","docId":"gRPC/Enums/FileIDType/index"},{"type":"link","label":"FileSizePrecision","href":"/Frameworks/User-Interface-Extensibility-Framework/Reference/gRPC/Enums/FileSizePrecision/","docId":"gRPC/Enums/FileSizePrecision/index"},{"type":"link","label":"FileValueType","href":"/Frameworks/User-Interface-Extensibility-Framework/Reference/gRPC/Enums/FileValueType/","docId":"gRPC/Enums/FileValueType/index"},{"type":"link","label":"FileVerType","href":"/Frameworks/User-Interface-Extensibility-Framework/Reference/gRPC/Enums/FileVerType/","docId":"gRPC/Enums/FileVerType/index"},{"type":"link","label":"FolderListingAlgorithm","href":"/Frameworks/User-Interface-Extensibility-Framework/Reference/gRPC/Enums/FolderListingAlgorithm/","docId":"gRPC/Enums/FolderListingAlgorithm/index"},{"type":"link","label":"FolderType","href":"/Frameworks/User-Interface-Extensibility-Framework/Reference/gRPC/Enums/FolderType/","docId":"gRPC/Enums/FolderType/index"},{"type":"link","label":"FormattingType","href":"/Frameworks/User-Interface-Extensibility-Framework/Reference/gRPC/Enums/FormattingType/","docId":"gRPC/Enums/FormattingType/index"},{"type":"link","label":"IndirectPropertyIDLevelType","href":"/Frameworks/User-Interface-Extensibility-Framework/Reference/gRPC/Enums/IndirectPropertyIDLevelType/","docId":"gRPC/Enums/IndirectPropertyIDLevelType/index"},{"type":"link","label":"MetadataStructureItem","href":"/Frameworks/User-Interface-Extensibility-Framework/Reference/gRPC/Enums/MetadataStructureItem/","docId":"gRPC/Enums/MetadataStructureItem/index"},{"type":"link","label":"NACLType","href":"/Frameworks/User-Interface-Extensibility-Framework/Reference/gRPC/Enums/NACLType/","docId":"gRPC/Enums/NACLType/index"},{"type":"link","label":"NamedValueType","href":"/Frameworks/User-Interface-Extensibility-Framework/Reference/gRPC/Enums/NamedValueType/","docId":"gRPC/Enums/NamedValueType/index"},{"type":"link","label":"ObjFileSourceType","href":"/Frameworks/User-Interface-Extensibility-Framework/Reference/gRPC/Enums/ObjFileSourceType/","docId":"gRPC/Enums/ObjFileSourceType/index"},{"type":"link","label":"ObjVerVersionType","href":"/Frameworks/User-Interface-Extensibility-Framework/Reference/gRPC/Enums/ObjVerVersionType/","docId":"gRPC/Enums/ObjVerVersionType/index"},{"type":"link","label":"ObjectVersionDataRequestErrorTolerance","href":"/Frameworks/User-Interface-Extensibility-Framework/Reference/gRPC/Enums/ObjectVersionDataRequestErrorTolerance/","docId":"gRPC/Enums/ObjectVersionDataRequestErrorTolerance/index"},{"type":"link","label":"ObjectVersionDataRequestIdentityType","href":"/Frameworks/User-Interface-Extensibility-Framework/Reference/gRPC/Enums/ObjectVersionDataRequestIdentityType/","docId":"gRPC/Enums/ObjectVersionDataRequestIdentityType/index"},{"type":"link","label":"ObjectVersionDataRequestVersionType","href":"/Frameworks/User-Interface-Extensibility-Framework/Reference/gRPC/Enums/ObjectVersionDataRequestVersionType/","docId":"gRPC/Enums/ObjectVersionDataRequestVersionType/index"},{"type":"link","label":"ParentChildBehavior","href":"/Frameworks/User-Interface-Extensibility-Framework/Reference/gRPC/Enums/ParentChildBehavior/","docId":"gRPC/Enums/ParentChildBehavior/index"},{"type":"link","label":"PermissionsExpressionType","href":"/Frameworks/User-Interface-Extensibility-Framework/Reference/gRPC/Enums/PermissionsExpressionType/","docId":"gRPC/Enums/PermissionsExpressionType/index"},{"type":"link","label":"PropertySetByType","href":"/Frameworks/User-Interface-Extensibility-Framework/Reference/gRPC/Enums/PropertySetByType/","docId":"gRPC/Enums/PropertySetByType/index"},{"type":"link","label":"PseudoUserResolutionMode","href":"/Frameworks/User-Interface-Extensibility-Framework/Reference/gRPC/Enums/PseudoUserResolutionMode/","docId":"gRPC/Enums/PseudoUserResolutionMode/index"},{"type":"link","label":"ReferenceDirection","href":"/Frameworks/User-Interface-Extensibility-Framework/Reference/gRPC/Enums/ReferenceDirection/","docId":"gRPC/Enums/ReferenceDirection/index"},{"type":"link","label":"RelationshipDirection","href":"/Frameworks/User-Interface-Extensibility-Framework/Reference/gRPC/Enums/RelationshipDirection/","docId":"gRPC/Enums/RelationshipDirection/index"},{"type":"link","label":"SearchMode","href":"/Frameworks/User-Interface-Extensibility-Framework/Reference/gRPC/Enums/SearchMode/","docId":"gRPC/Enums/SearchMode/index"},{"type":"link","label":"StatusType","href":"/Frameworks/User-Interface-Extensibility-Framework/Reference/gRPC/Enums/StatusType/","docId":"gRPC/Enums/StatusType/index"},{"type":"link","label":"UpdateType","href":"/Frameworks/User-Interface-Extensibility-Framework/Reference/gRPC/Enums/UpdateType/","docId":"gRPC/Enums/UpdateType/index"},{"type":"link","label":"VLSortingType","href":"/Frameworks/User-Interface-Extensibility-Framework/Reference/gRPC/Enums/VLSortingType/","docId":"gRPC/Enums/VLSortingType/index"},{"type":"link","label":"ValidationType","href":"/Frameworks/User-Interface-Extensibility-Framework/Reference/gRPC/Enums/ValidationType/","docId":"gRPC/Enums/ValidationType/index"},{"type":"link","label":"ViewType","href":"/Frameworks/User-Interface-Extensibility-Framework/Reference/gRPC/Enums/ViewType/","docId":"gRPC/Enums/ViewType/index"}],"href":"/Frameworks/User-Interface-Extensibility-Framework/Reference/gRPC/Enums/"},{"type":"category","label":"Interfaces","collapsible":true,"collapsed":true,"items":[{"type":"category","label":"NamedACLsOperations","collapsible":true,"collapsed":true,"items":[{"type":"link","label":"GetNamedACLs","href":"/Frameworks/User-Interface-Extensibility-Framework/Reference/gRPC/Interfaces/NamedACLsOperations/GetNamedACLs/","docId":"gRPC/Interfaces/NamedACLsOperations/GetNamedACLs/index"}],"href":"/Frameworks/User-Interface-Extensibility-Framework/Reference/gRPC/Interfaces/NamedACLsOperations/"},{"type":"category","label":"NamedValueStorageOperations","collapsible":true,"collapsed":true,"items":[{"type":"link","label":"GetNamedValues","href":"/Frameworks/User-Interface-Extensibility-Framework/Reference/gRPC/Interfaces/NamedValueStorageOperations/GetNamedValues/","docId":"gRPC/Interfaces/NamedValueStorageOperations/GetNamedValues/index"},{"type":"link","label":"RemoveNamedValues","href":"/Frameworks/User-Interface-Extensibility-Framework/Reference/gRPC/Interfaces/NamedValueStorageOperations/RemoveNamedValues/","docId":"gRPC/Interfaces/NamedValueStorageOperations/RemoveNamedValues/index"},{"type":"link","label":"SetNamedValues","href":"/Frameworks/User-Interface-Extensibility-Framework/Reference/gRPC/Interfaces/NamedValueStorageOperations/SetNamedValues/","docId":"gRPC/Interfaces/NamedValueStorageOperations/SetNamedValues/index"}],"href":"/Frameworks/User-Interface-Extensibility-Framework/Reference/gRPC/Interfaces/NamedValueStorageOperations/"},{"type":"category","label":"ObjectOperations","collapsible":true,"collapsed":true,"items":[{"type":"link","label":"AddObjectFile","href":"/Frameworks/User-Interface-Extensibility-Framework/Reference/gRPC/Interfaces/ObjectOperations/AddObjectFile/","docId":"gRPC/Interfaces/ObjectOperations/AddObjectFile/index"},{"type":"link","label":"AddObjectWithFiles","href":"/Frameworks/User-Interface-Extensibility-Framework/Reference/gRPC/Interfaces/ObjectOperations/AddObjectWithFiles/","docId":"gRPC/Interfaces/ObjectOperations/AddObjectWithFiles/index"},{"type":"link","label":"ChangeSecurity","href":"/Frameworks/User-Interface-Extensibility-Framework/Reference/gRPC/Interfaces/ObjectOperations/ChangeSecurity/","docId":"gRPC/Interfaces/ObjectOperations/ChangeSecurity/index"},{"type":"link","label":"CheckInMultiple","href":"/Frameworks/User-Interface-Extensibility-Framework/Reference/gRPC/Interfaces/ObjectOperations/CheckInMultiple/","docId":"gRPC/Interfaces/ObjectOperations/CheckInMultiple/index"},{"type":"link","label":"CheckOutMultiple","href":"/Frameworks/User-Interface-Extensibility-Framework/Reference/gRPC/Interfaces/ObjectOperations/CheckOutMultiple/","docId":"gRPC/Interfaces/ObjectOperations/CheckOutMultiple/index"},{"type":"link","label":"DestroyObjects","href":"/Frameworks/User-Interface-Extensibility-Framework/Reference/gRPC/Interfaces/ObjectOperations/DestroyObjects/","docId":"gRPC/Interfaces/ObjectOperations/DestroyObjects/index"},{"type":"link","label":"FollowObject","href":"/Frameworks/User-Interface-Extensibility-Framework/Reference/gRPC/Interfaces/ObjectOperations/FollowObject/","docId":"gRPC/Interfaces/ObjectOperations/FollowObject/index"},{"type":"link","label":"GetAutomaticMetadata","href":"/Frameworks/User-Interface-Extensibility-Framework/Reference/gRPC/Interfaces/ObjectOperations/GetAutomaticMetadata/","docId":"gRPC/Interfaces/ObjectOperations/GetAutomaticMetadata/index"},{"type":"link","label":"GetDocEventSubscriptions","href":"/Frameworks/User-Interface-Extensibility-Framework/Reference/gRPC/Interfaces/ObjectOperations/GetDocEventSubscriptions/","docId":"gRPC/Interfaces/ObjectOperations/GetDocEventSubscriptions/index"},{"type":"link","label":"GetEffectivePermissions","href":"/Frameworks/User-Interface-Extensibility-Framework/Reference/gRPC/Interfaces/ObjectOperations/GetEffectivePermissions/","docId":"gRPC/Interfaces/ObjectOperations/GetEffectivePermissions/index"},{"type":"link","label":"GetLatestFileVersion","href":"/Frameworks/User-Interface-Extensibility-Framework/Reference/gRPC/Interfaces/ObjectOperations/GetLatestFileVersion/","docId":"gRPC/Interfaces/ObjectOperations/GetLatestFileVersion/index"},{"type":"link","label":"GetLatestObjectVersion","href":"/Frameworks/User-Interface-Extensibility-Framework/Reference/gRPC/Interfaces/ObjectOperations/GetLatestObjectVersion/","docId":"gRPC/Interfaces/ObjectOperations/GetLatestObjectVersion/index"},{"type":"link","label":"GetObjIDByGUID","href":"/Frameworks/User-Interface-Extensibility-Framework/Reference/gRPC/Interfaces/ObjectOperations/GetObjIDByGUID/","docId":"gRPC/Interfaces/ObjectOperations/GetObjIDByGUID/index"},{"type":"link","label":"GetObjectDataOfMultipleObjects","href":"/Frameworks/User-Interface-Extensibility-Framework/Reference/gRPC/Interfaces/ObjectOperations/GetObjectDataOfMultipleObjects/","docId":"gRPC/Interfaces/ObjectOperations/GetObjectDataOfMultipleObjects/index"},{"type":"link","label":"GetObjectFiles","href":"/Frameworks/User-Interface-Extensibility-Framework/Reference/gRPC/Interfaces/ObjectOperations/GetObjectFiles/","docId":"gRPC/Interfaces/ObjectOperations/GetObjectFiles/index"},{"type":"link","label":"GetObjectHistory2","href":"/Frameworks/User-Interface-Extensibility-Framework/Reference/gRPC/Interfaces/ObjectOperations/GetObjectHistory2/","docId":"gRPC/Interfaces/ObjectOperations/GetObjectHistory2/index"},{"type":"link","label":"GetTemplates","href":"/Frameworks/User-Interface-Extensibility-Framework/Reference/gRPC/Interfaces/ObjectOperations/GetTemplates/","docId":"gRPC/Interfaces/ObjectOperations/GetTemplates/index"},{"type":"link","label":"GetWorkflowStateHistory","href":"/Frameworks/User-Interface-Extensibility-Framework/Reference/gRPC/Interfaces/ObjectOperations/GetWorkflowStateHistory/","docId":"gRPC/Interfaces/ObjectOperations/GetWorkflowStateHistory/index"},{"type":"link","label":"GetWorkflowStates","href":"/Frameworks/User-Interface-Extensibility-Framework/Reference/gRPC/Interfaces/ObjectOperations/GetWorkflowStates/","docId":"gRPC/Interfaces/ObjectOperations/GetWorkflowStates/index"},{"type":"link","label":"GetWorkflowStatesAndTransitions","href":"/Frameworks/User-Interface-Extensibility-Framework/Reference/gRPC/Interfaces/ObjectOperations/GetWorkflowStatesAndTransitions/","docId":"gRPC/Interfaces/ObjectOperations/GetWorkflowStatesAndTransitions/index"},{"type":"link","label":"GetWorkflowsForClient","href":"/Frameworks/User-Interface-Extensibility-Framework/Reference/gRPC/Interfaces/ObjectOperations/GetWorkflowsForClient/","docId":"gRPC/Interfaces/ObjectOperations/GetWorkflowsForClient/index"},{"type":"link","label":"PromoteUnmanagedObject","href":"/Frameworks/User-Interface-Extensibility-Framework/Reference/gRPC/Interfaces/ObjectOperations/PromoteUnmanagedObject/","docId":"gRPC/Interfaces/ObjectOperations/PromoteUnmanagedObject/index"},{"type":"link","label":"RemoveObjectFile","href":"/Frameworks/User-Interface-Extensibility-Framework/Reference/gRPC/Interfaces/ObjectOperations/RemoveObjectFile/","docId":"gRPC/Interfaces/ObjectOperations/RemoveObjectFile/index"},{"type":"link","label":"RemoveObjects","href":"/Frameworks/User-Interface-Extensibility-Framework/Reference/gRPC/Interfaces/ObjectOperations/RemoveObjects/","docId":"gRPC/Interfaces/ObjectOperations/RemoveObjects/index"},{"type":"link","label":"RenameObjectFile","href":"/Frameworks/User-Interface-Extensibility-Framework/Reference/gRPC/Interfaces/ObjectOperations/RenameObjectFile/","docId":"gRPC/Interfaces/ObjectOperations/RenameObjectFile/index"},{"type":"link","label":"SetObjectLevelProperty","href":"/Frameworks/User-Interface-Extensibility-Framework/Reference/gRPC/Interfaces/ObjectOperations/SetObjectLevelProperty/","docId":"gRPC/Interfaces/ObjectOperations/SetObjectLevelProperty/index"},{"type":"link","label":"SetPropertiesMultiple","href":"/Frameworks/User-Interface-Extensibility-Framework/Reference/gRPC/Interfaces/ObjectOperations/SetPropertiesMultiple/","docId":"gRPC/Interfaces/ObjectOperations/SetPropertiesMultiple/index"},{"type":"link","label":"UndoCheckoutMultiple","href":"/Frameworks/User-Interface-Extensibility-Framework/Reference/gRPC/Interfaces/ObjectOperations/UndoCheckoutMultiple/","docId":"gRPC/Interfaces/ObjectOperations/UndoCheckoutMultiple/index"},{"type":"link","label":"UploadExistingFiles","href":"/Frameworks/User-Interface-Extensibility-Framework/Reference/gRPC/Interfaces/ObjectOperations/UploadExistingFiles/","docId":"gRPC/Interfaces/ObjectOperations/UploadExistingFiles/index"}],"href":"/Frameworks/User-Interface-Extensibility-Framework/Reference/gRPC/Interfaces/ObjectOperations/"},{"type":"category","label":"ObjectTypesOperations","collapsible":true,"collapsed":true,"items":[{"type":"link","label":"GetObjectTypes","href":"/Frameworks/User-Interface-Extensibility-Framework/Reference/gRPC/Interfaces/ObjectTypesOperations/GetObjectTypes/","docId":"gRPC/Interfaces/ObjectTypesOperations/GetObjectTypes/index"}],"href":"/Frameworks/User-Interface-Extensibility-Framework/Reference/gRPC/Interfaces/ObjectTypesOperations/"},{"type":"category","label":"PropertyDefsOperations","collapsible":true,"collapsed":true,"items":[{"type":"link","label":"GetObjectClassesAndGroups","href":"/Frameworks/User-Interface-Extensibility-Framework/Reference/gRPC/Interfaces/PropertyDefsOperations/GetObjectClassesAndGroups/","docId":"gRPC/Interfaces/PropertyDefsOperations/GetObjectClassesAndGroups/index"},{"type":"link","label":"GetPropertyDefs","href":"/Frameworks/User-Interface-Extensibility-Framework/Reference/gRPC/Interfaces/PropertyDefsOperations/GetPropertyDefs/","docId":"gRPC/Interfaces/PropertyDefsOperations/GetPropertyDefs/index"}],"href":"/Frameworks/User-Interface-Extensibility-Framework/Reference/gRPC/Interfaces/PropertyDefsOperations/"},{"type":"category","label":"SearchOperations","collapsible":true,"collapsed":true,"items":[{"type":"link","label":"GetFolderContents","href":"/Frameworks/User-Interface-Extensibility-Framework/Reference/gRPC/Interfaces/SearchOperations/GetFolderContents/","docId":"gRPC/Interfaces/SearchOperations/GetFolderContents/index"},{"type":"link","label":"SearchObjects","href":"/Frameworks/User-Interface-Extensibility-Framework/Reference/gRPC/Interfaces/SearchOperations/SearchObjects/","docId":"gRPC/Interfaces/SearchOperations/SearchObjects/index"}],"href":"/Frameworks/User-Interface-Extensibility-Framework/Reference/gRPC/Interfaces/SearchOperations/"},{"type":"category","label":"ValueListsOperations","collapsible":true,"collapsed":true,"items":[{"type":"link","label":"GetValueListItemsWithPermissions","href":"/Frameworks/User-Interface-Extensibility-Framework/Reference/gRPC/Interfaces/ValueListsOperations/GetValueListItemsWithPermissions/","docId":"gRPC/Interfaces/ValueListsOperations/GetValueListItemsWithPermissions/index"},{"type":"link","label":"GetValueLists","href":"/Frameworks/User-Interface-Extensibility-Framework/Reference/gRPC/Interfaces/ValueListsOperations/GetValueLists/","docId":"gRPC/Interfaces/ValueListsOperations/GetValueLists/index"},{"type":"link","label":"SearchValueListItemsWithPermissions","href":"/Frameworks/User-Interface-Extensibility-Framework/Reference/gRPC/Interfaces/ValueListsOperations/SearchValueListItemsWithPermissions/","docId":"gRPC/Interfaces/ValueListsOperations/SearchValueListItemsWithPermissions/index"}],"href":"/Frameworks/User-Interface-Extensibility-Framework/Reference/gRPC/Interfaces/ValueListsOperations/"},{"type":"category","label":"VaultExtensionMethodsOperations","collapsible":true,"collapsed":true,"items":[{"type":"link","label":"IsExtensionMethodAvailable","href":"/Frameworks/User-Interface-Extensibility-Framework/Reference/gRPC/Interfaces/VaultExtensionMethodsOperations/IsExtensionMethodAvailable/","docId":"gRPC/Interfaces/VaultExtensionMethodsOperations/IsExtensionMethodAvailable/index"},{"type":"link","label":"RunExtensionMethod","href":"/Frameworks/User-Interface-Extensibility-Framework/Reference/gRPC/Interfaces/VaultExtensionMethodsOperations/RunExtensionMethod/","docId":"gRPC/Interfaces/VaultExtensionMethodsOperations/RunExtensionMethod/index"}],"href":"/Frameworks/User-Interface-Extensibility-Framework/Reference/gRPC/Interfaces/VaultExtensionMethodsOperations/"},{"type":"category","label":"VaultOperations","collapsible":true,"collapsed":true,"items":[{"type":"link","label":"GetMetadataStructureItemIdByAlias","href":"/Frameworks/User-Interface-Extensibility-Framework/Reference/gRPC/Interfaces/VaultOperations/GetMetadataStructureItemIdByAlias/","docId":"gRPC/Interfaces/VaultOperations/GetMetadataStructureItemIdByAlias/index"},{"type":"link","label":"GetMetadataStructureItemIdByGUID","href":"/Frameworks/User-Interface-Extensibility-Framework/Reference/gRPC/Interfaces/VaultOperations/GetMetadataStructureItemIdByGUID/","docId":"gRPC/Interfaces/VaultOperations/GetMetadataStructureItemIdByGUID/index"}],"href":"/Frameworks/User-Interface-Extensibility-Framework/Reference/gRPC/Interfaces/VaultOperations/"},{"type":"category","label":"ViewsOperations","collapsible":true,"collapsed":true,"items":[{"type":"link","label":"DeleteView","href":"/Frameworks/User-Interface-Extensibility-Framework/Reference/gRPC/Interfaces/ViewsOperations/DeleteView/","docId":"gRPC/Interfaces/ViewsOperations/DeleteView/index"},{"type":"link","label":"GetViews","href":"/Frameworks/User-Interface-Extensibility-Framework/Reference/gRPC/Interfaces/ViewsOperations/GetViews/","docId":"gRPC/Interfaces/ViewsOperations/GetViews/index"}],"href":"/Frameworks/User-Interface-Extensibility-Framework/Reference/gRPC/Interfaces/ViewsOperations/"}],"href":"/Frameworks/User-Interface-Extensibility-Framework/Reference/gRPC/Interfaces/"},{"type":"category","label":"Messages","collapsible":true,"collapsed":true,"items":[{"type":"link","label":"ACCESSCONTROLLISTCOMPONENTSTATUSFLAGS","href":"/Frameworks/User-Interface-Extensibility-Framework/Reference/gRPC/Messages/ACCESSCONTROLLISTCOMPONENTSTATUSFLAGS/","docId":"gRPC/Messages/ACCESSCONTROLLISTCOMPONENTSTATUSFLAGS/index"},{"type":"link","label":"ACTIONFLAGS","href":"/Frameworks/User-Interface-Extensibility-Framework/Reference/gRPC/Messages/ACTIONFLAGS/","docId":"gRPC/Messages/ACTIONFLAGS/index"},{"type":"link","label":"AccessControlEntry","href":"/Frameworks/User-Interface-Extensibility-Framework/Reference/gRPC/Messages/AccessControlEntry/","docId":"gRPC/Messages/AccessControlEntry/index"},{"type":"link","label":"AccessControlList","href":"/Frameworks/User-Interface-Extensibility-Framework/Reference/gRPC/Messages/AccessControlList/","docId":"gRPC/Messages/AccessControlList/index"},{"type":"link","label":"AccessControlListComponent","href":"/Frameworks/User-Interface-Extensibility-Framework/Reference/gRPC/Messages/AccessControlListComponent/","docId":"gRPC/Messages/AccessControlListComponent/index"},{"type":"link","label":"AccessControlListComponentKey","href":"/Frameworks/User-Interface-Extensibility-Framework/Reference/gRPC/Messages/AccessControlListComponentKey/","docId":"gRPC/Messages/AccessControlListComponentKey/index"},{"type":"link","label":"AccessControlListComponentMapEntry","href":"/Frameworks/User-Interface-Extensibility-Framework/Reference/gRPC/Messages/AccessControlListComponentMapEntry/","docId":"gRPC/Messages/AccessControlListComponentMapEntry/index"},{"type":"link","label":"AccessControlPseudoUserSubject","href":"/Frameworks/User-Interface-Extensibility-Framework/Reference/gRPC/Messages/AccessControlPseudoUserSubject/","docId":"gRPC/Messages/AccessControlPseudoUserSubject/index"},{"type":"link","label":"AccessControlSubject","href":"/Frameworks/User-Interface-Extensibility-Framework/Reference/gRPC/Messages/AccessControlSubject/","docId":"gRPC/Messages/AccessControlSubject/index"},{"type":"link","label":"AccessControlSubjectUnion","href":"/Frameworks/User-Interface-Extensibility-Framework/Reference/gRPC/Messages/AccessControlSubjectUnion/","docId":"gRPC/Messages/AccessControlSubjectUnion/index"},{"type":"link","label":"AssociatedPropertyDef","href":"/Frameworks/User-Interface-Extensibility-Framework/Reference/gRPC/Messages/AssociatedPropertyDef/","docId":"gRPC/Messages/AssociatedPropertyDef/index"},{"type":"link","label":"AutomaticMetadataRequest","href":"/Frameworks/User-Interface-Extensibility-Framework/Reference/gRPC/Messages/AutomaticMetadataRequest/","docId":"gRPC/Messages/AutomaticMetadataRequest/index"},{"type":"link","label":"AutomaticMetadataResult","href":"/Frameworks/User-Interface-Extensibility-Framework/Reference/gRPC/Messages/AutomaticMetadataResult/","docId":"gRPC/Messages/AutomaticMetadataResult/index"},{"type":"link","label":"AutomaticPermissions","href":"/Frameworks/User-Interface-Extensibility-Framework/Reference/gRPC/Messages/AutomaticPermissions/","docId":"gRPC/Messages/AutomaticPermissions/index"},{"type":"link","label":"Bytes","href":"/Frameworks/User-Interface-Extensibility-Framework/Reference/gRPC/Messages/Bytes/","docId":"gRPC/Messages/Bytes/index"},{"type":"link","label":"ClassGroup","href":"/Frameworks/User-Interface-Extensibility-Framework/Reference/gRPC/Messages/ClassGroup/","docId":"gRPC/Messages/ClassGroup/index"},{"type":"link","label":"ClassPermissionsForClient","href":"/Frameworks/User-Interface-Extensibility-Framework/Reference/gRPC/Messages/ClassPermissionsForClient/","docId":"gRPC/Messages/ClassPermissionsForClient/index"},{"type":"link","label":"DataFunctionCall","href":"/Frameworks/User-Interface-Extensibility-Framework/Reference/gRPC/Messages/DataFunctionCall/","docId":"gRPC/Messages/DataFunctionCall/index"},{"type":"category","label":"DataFunctionUnion","collapsible":true,"collapsed":true,"items":[{"type":"link","label":"DateData","href":"/Frameworks/User-Interface-Extensibility-Framework/Reference/gRPC/Messages/DataFunctionUnion/DateData/","docId":"gRPC/Messages/DataFunctionUnion/DateData/index"},{"type":"link","label":"DaysFromData","href":"/Frameworks/User-Interface-Extensibility-Framework/Reference/gRPC/Messages/DataFunctionUnion/DaysFromData/","docId":"gRPC/Messages/DataFunctionUnion/DaysFromData/index"},{"type":"link","label":"DaysToData","href":"/Frameworks/User-Interface-Extensibility-Framework/Reference/gRPC/Messages/DataFunctionUnion/DaysToData/","docId":"gRPC/Messages/DataFunctionUnion/DaysToData/index"},{"type":"link","label":"InitialCharacterGroupData","href":"/Frameworks/User-Interface-Extensibility-Framework/Reference/gRPC/Messages/DataFunctionUnion/InitialCharacterGroupData/","docId":"gRPC/Messages/DataFunctionUnion/InitialCharacterGroupData/index"},{"type":"link","label":"IntegerSegmentData","href":"/Frameworks/User-Interface-Extensibility-Framework/Reference/gRPC/Messages/DataFunctionUnion/IntegerSegmentData/","docId":"gRPC/Messages/DataFunctionUnion/IntegerSegmentData/index"},{"type":"link","label":"LeftCharactersData","href":"/Frameworks/User-Interface-Extensibility-Framework/Reference/gRPC/Messages/DataFunctionUnion/LeftCharactersData/","docId":"gRPC/Messages/DataFunctionUnion/LeftCharactersData/index"},{"type":"link","label":"MonthData","href":"/Frameworks/User-Interface-Extensibility-Framework/Reference/gRPC/Messages/DataFunctionUnion/MonthData/","docId":"gRPC/Messages/DataFunctionUnion/MonthData/index"},{"type":"link","label":"NoOpData","href":"/Frameworks/User-Interface-Extensibility-Framework/Reference/gRPC/Messages/DataFunctionUnion/NoOpData/","docId":"gRPC/Messages/DataFunctionUnion/NoOpData/index"},{"type":"link","label":"YearAndMonthData","href":"/Frameworks/User-Interface-Extensibility-Framework/Reference/gRPC/Messages/DataFunctionUnion/YearAndMonthData/","docId":"gRPC/Messages/DataFunctionUnion/YearAndMonthData/index"},{"type":"link","label":"YearData","href":"/Frameworks/User-Interface-Extensibility-Framework/Reference/gRPC/Messages/DataFunctionUnion/YearData/","docId":"gRPC/Messages/DataFunctionUnion/YearData/index"}],"href":"/Frameworks/User-Interface-Extensibility-Framework/Reference/gRPC/Messages/DataFunctionUnion/"},{"type":"link","label":"DefaultReplicationConfiguration","href":"/Frameworks/User-Interface-Extensibility-Framework/Reference/gRPC/Messages/DefaultReplicationConfiguration/","docId":"gRPC/Messages/DefaultReplicationConfiguration/index"},{"type":"link","label":"DocClassGroup","href":"/Frameworks/User-Interface-Extensibility-Framework/Reference/gRPC/Messages/DocClassGroup/","docId":"gRPC/Messages/DocClassGroup/index"},{"type":"link","label":"EXPRESSIONEXFLAGS","href":"/Frameworks/User-Interface-Extensibility-Framework/Reference/gRPC/Messages/EXPRESSIONEXFLAGS/","docId":"gRPC/Messages/EXPRESSIONEXFLAGS/index"},{"type":"link","label":"EffectivePermissions","href":"/Frameworks/User-Interface-Extensibility-Framework/Reference/gRPC/Messages/EffectivePermissions/","docId":"gRPC/Messages/EffectivePermissions/index"},{"type":"link","label":"ErrorInfo","href":"/Frameworks/User-Interface-Extensibility-Framework/Reference/gRPC/Messages/ErrorInfo/","docId":"gRPC/Messages/ErrorInfo/index"},{"type":"link","label":"EventSubscription","href":"/Frameworks/User-Interface-Extensibility-Framework/Reference/gRPC/Messages/EventSubscription/","docId":"gRPC/Messages/EventSubscription/index"},{"type":"link","label":"Expression","href":"/Frameworks/User-Interface-Extensibility-Framework/Reference/gRPC/Messages/Expression/","docId":"gRPC/Messages/Expression/index"},{"type":"category","label":"ExpressionUnion","collapsible":true,"collapsed":true,"items":[{"type":"link","label":"AnyFieldData","href":"/Frameworks/User-Interface-Extensibility-Framework/Reference/gRPC/Messages/ExpressionUnion/AnyFieldData/","docId":"gRPC/Messages/ExpressionUnion/AnyFieldData/index"},{"type":"link","label":"FileValueData","href":"/Frameworks/User-Interface-Extensibility-Framework/Reference/gRPC/Messages/ExpressionUnion/FileValueData/","docId":"gRPC/Messages/ExpressionUnion/FileValueData/index"},{"type":"link","label":"IdSegmentData","href":"/Frameworks/User-Interface-Extensibility-Framework/Reference/gRPC/Messages/ExpressionUnion/IdSegmentData/","docId":"gRPC/Messages/ExpressionUnion/IdSegmentData/index"},{"type":"link","label":"PermissionsData","href":"/Frameworks/User-Interface-Extensibility-Framework/Reference/gRPC/Messages/ExpressionUnion/PermissionsData/","docId":"gRPC/Messages/ExpressionUnion/PermissionsData/index"},{"type":"link","label":"PropertyValueData","href":"/Frameworks/User-Interface-Extensibility-Framework/Reference/gRPC/Messages/ExpressionUnion/PropertyValueData/","docId":"gRPC/Messages/ExpressionUnion/PropertyValueData/index"},{"type":"link","label":"StatusValueData","href":"/Frameworks/User-Interface-Extensibility-Framework/Reference/gRPC/Messages/ExpressionUnion/StatusValueData/","docId":"gRPC/Messages/ExpressionUnion/StatusValueData/index"},{"type":"link","label":"TypedValueData","href":"/Frameworks/User-Interface-Extensibility-Framework/Reference/gRPC/Messages/ExpressionUnion/TypedValueData/","docId":"gRPC/Messages/ExpressionUnion/TypedValueData/index"},{"type":"link","label":"UninitializedData","href":"/Frameworks/User-Interface-Extensibility-Framework/Reference/gRPC/Messages/ExpressionUnion/UninitializedData/","docId":"gRPC/Messages/ExpressionUnion/UninitializedData/index"}],"href":"/Frameworks/User-Interface-Extensibility-Framework/Reference/gRPC/Messages/ExpressionUnion/"},{"type":"link","label":"ExtObjectInfo","href":"/Frameworks/User-Interface-Extensibility-Framework/Reference/gRPC/Messages/ExtObjectInfo/","docId":"gRPC/Messages/ExtObjectInfo/index"},{"type":"link","label":"ExternalRepositoryID","href":"/Frameworks/User-Interface-Extensibility-Framework/Reference/gRPC/Messages/ExternalRepositoryID/","docId":"gRPC/Messages/ExternalRepositoryID/index"},{"type":"link","label":"ExternalView","href":"/Frameworks/User-Interface-Extensibility-Framework/Reference/gRPC/Messages/ExternalView/","docId":"gRPC/Messages/ExternalView/index"},{"type":"link","label":"FOLDERCAPABILITYFLAGS","href":"/Frameworks/User-Interface-Extensibility-Framework/Reference/gRPC/Messages/FOLDERCAPABILITYFLAGS/","docId":"gRPC/Messages/FOLDERCAPABILITYFLAGS/index"},{"type":"link","label":"FTSFLAGS","href":"/Frameworks/User-Interface-Extensibility-Framework/Reference/gRPC/Messages/FTSFLAGS/","docId":"gRPC/Messages/FTSFLAGS/index"},{"type":"link","label":"File","href":"/Frameworks/User-Interface-Extensibility-Framework/Reference/gRPC/Messages/File/","docId":"gRPC/Messages/File/index"},{"type":"link","label":"FileID","href":"/Frameworks/User-Interface-Extensibility-Framework/Reference/gRPC/Messages/FileID/","docId":"gRPC/Messages/FileID/index"},{"type":"link","label":"FileVer","href":"/Frameworks/User-Interface-Extensibility-Framework/Reference/gRPC/Messages/FileVer/","docId":"gRPC/Messages/FileVer/index"},{"type":"link","label":"Folder","href":"/Frameworks/User-Interface-Extensibility-Framework/Reference/gRPC/Messages/Folder/","docId":"gRPC/Messages/Folder/index"},{"type":"category","label":"FolderInfoUnion","collapsible":true,"collapsed":true,"items":[{"type":"link","label":"AnyFolderData","href":"/Frameworks/User-Interface-Extensibility-Framework/Reference/gRPC/Messages/FolderInfoUnion/AnyFolderData/","docId":"gRPC/Messages/FolderInfoUnion/AnyFolderData/index"},{"type":"link","label":"ExternalViewFolderData","href":"/Frameworks/User-Interface-Extensibility-Framework/Reference/gRPC/Messages/FolderInfoUnion/ExternalViewFolderData/","docId":"gRPC/Messages/FolderInfoUnion/ExternalViewFolderData/index"},{"type":"link","label":"PropertyFolderData","href":"/Frameworks/User-Interface-Extensibility-Framework/Reference/gRPC/Messages/FolderInfoUnion/PropertyFolderData/","docId":"gRPC/Messages/FolderInfoUnion/PropertyFolderData/index"},{"type":"link","label":"SearchFolderData","href":"/Frameworks/User-Interface-Extensibility-Framework/Reference/gRPC/Messages/FolderInfoUnion/SearchFolderData/","docId":"gRPC/Messages/FolderInfoUnion/SearchFolderData/index"},{"type":"link","label":"TraditionalFolderData","href":"/Frameworks/User-Interface-Extensibility-Framework/Reference/gRPC/Messages/FolderInfoUnion/TraditionalFolderData/","docId":"gRPC/Messages/FolderInfoUnion/TraditionalFolderData/index"},{"type":"link","label":"UnknownFolderData","href":"/Frameworks/User-Interface-Extensibility-Framework/Reference/gRPC/Messages/FolderInfoUnion/UnknownFolderData/","docId":"gRPC/Messages/FolderInfoUnion/UnknownFolderData/index"},{"type":"link","label":"ViewFolderData","href":"/Frameworks/User-Interface-Extensibility-Framework/Reference/gRPC/Messages/FolderInfoUnion/ViewFolderData/","docId":"gRPC/Messages/FolderInfoUnion/ViewFolderData/index"}],"href":"/Frameworks/User-Interface-Extensibility-Framework/Reference/gRPC/Messages/FolderInfoUnion/"},{"type":"link","label":"GetMetadataStructureItemIdByGUIDRequest","href":"/Frameworks/User-Interface-Extensibility-Framework/Reference/gRPC/Messages/GetMetadataStructureItemIdByGUIDRequest/","docId":"gRPC/Messages/GetMetadataStructureItemIdByGUIDRequest/index"},{"type":"link","label":"GetMetadataStructureItemIdByGUIDResponse","href":"/Frameworks/User-Interface-Extensibility-Framework/Reference/gRPC/Messages/GetMetadataStructureItemIdByGUIDResponse/","docId":"gRPC/Messages/GetMetadataStructureItemIdByGUIDResponse/index"},{"type":"link","label":"GetObjectVersionAndPropertiesOfMultipleObjectsResponse","href":"/Frameworks/User-Interface-Extensibility-Framework/Reference/gRPC/Messages/GetObjectVersionAndPropertiesOfMultipleObjectsResponse/","docId":"gRPC/Messages/GetObjectVersionAndPropertiesOfMultipleObjectsResponse/index"},{"type":"link","label":"GroupingLevel","href":"/Frameworks/User-Interface-Extensibility-Framework/Reference/gRPC/Messages/GroupingLevel/","docId":"gRPC/Messages/GroupingLevel/index"},{"type":"link","label":"ITEMFLAGS","href":"/Frameworks/User-Interface-Extensibility-Framework/Reference/gRPC/Messages/ITEMFLAGS/","docId":"gRPC/Messages/ITEMFLAGS/index"},{"type":"link","label":"IndirectPropertyID","href":"/Frameworks/User-Interface-Extensibility-Framework/Reference/gRPC/Messages/IndirectPropertyID/","docId":"gRPC/Messages/IndirectPropertyID/index"},{"type":"link","label":"IndirectPropertyIDLevel","href":"/Frameworks/User-Interface-Extensibility-Framework/Reference/gRPC/Messages/IndirectPropertyIDLevel/","docId":"gRPC/Messages/IndirectPropertyIDLevel/index"},{"type":"link","label":"IndirectPropertyIDLevelRef","href":"/Frameworks/User-Interface-Extensibility-Framework/Reference/gRPC/Messages/IndirectPropertyIDLevelRef/","docId":"gRPC/Messages/IndirectPropertyIDLevelRef/index"},{"type":"link","label":"IndirectionLevel","href":"/Frameworks/User-Interface-Extensibility-Framework/Reference/gRPC/Messages/IndirectionLevel/","docId":"gRPC/Messages/IndirectionLevel/index"},{"type":"link","label":"ItemID","href":"/Frameworks/User-Interface-Extensibility-Framework/Reference/gRPC/Messages/ItemID/","docId":"gRPC/Messages/ItemID/index"},{"type":"link","label":"ItemInfo","href":"/Frameworks/User-Interface-Extensibility-Framework/Reference/gRPC/Messages/ItemInfo/","docId":"gRPC/Messages/ItemInfo/index"},{"type":"link","label":"Lookup","href":"/Frameworks/User-Interface-Extensibility-Framework/Reference/gRPC/Messages/Lookup/","docId":"gRPC/Messages/Lookup/index"},{"type":"link","label":"LookupWithMetadata","href":"/Frameworks/User-Interface-Extensibility-Framework/Reference/gRPC/Messages/LookupWithMetadata/","docId":"gRPC/Messages/LookupWithMetadata/index"},{"type":"link","label":"MultiSelectLookup","href":"/Frameworks/User-Interface-Extensibility-Framework/Reference/gRPC/Messages/MultiSelectLookup/","docId":"gRPC/Messages/MultiSelectLookup/index"},{"type":"link","label":"MultiSelectLookupWithMetadata","href":"/Frameworks/User-Interface-Extensibility-Framework/Reference/gRPC/Messages/MultiSelectLookupWithMetadata/","docId":"gRPC/Messages/MultiSelectLookupWithMetadata/index"},{"type":"link","label":"NamedACL","href":"/Frameworks/User-Interface-Extensibility-Framework/Reference/gRPC/Messages/NamedACL/","docId":"gRPC/Messages/NamedACL/index"},{"type":"link","label":"NamedValue","href":"/Frameworks/User-Interface-Extensibility-Framework/Reference/gRPC/Messages/NamedValue/","docId":"gRPC/Messages/NamedValue/index"},{"type":"link","label":"OBJECTCAPABILITYFLAGS","href":"/Frameworks/User-Interface-Extensibility-Framework/Reference/gRPC/Messages/OBJECTCAPABILITYFLAGS/","docId":"gRPC/Messages/OBJECTCAPABILITYFLAGS/index"},{"type":"link","label":"OBJECTDATAREQUESTFLAGS","href":"/Frameworks/User-Interface-Extensibility-Framework/Reference/gRPC/Messages/OBJECTDATAREQUESTFLAGS/","docId":"gRPC/Messages/OBJECTDATAREQUESTFLAGS/index"},{"type":"link","label":"OBJECTFILEFLAGS","href":"/Frameworks/User-Interface-Extensibility-Framework/Reference/gRPC/Messages/OBJECTFILEFLAGS/","docId":"gRPC/Messages/OBJECTFILEFLAGS/index"},{"type":"link","label":"OBJECTOPFLAGS","href":"/Frameworks/User-Interface-Extensibility-Framework/Reference/gRPC/Messages/OBJECTOPFLAGS/","docId":"gRPC/Messages/OBJECTOPFLAGS/index"},{"type":"link","label":"OBJECTVERSIONACTIVITYCATEGORYFLAGS","href":"/Frameworks/User-Interface-Extensibility-Framework/Reference/gRPC/Messages/OBJECTVERSIONACTIVITYCATEGORYFLAGS/","docId":"gRPC/Messages/OBJECTVERSIONACTIVITYCATEGORYFLAGS/index"},{"type":"link","label":"OBJECTVERSIONFILEACTIVITYFLAGS","href":"/Frameworks/User-Interface-Extensibility-Framework/Reference/gRPC/Messages/OBJECTVERSIONFILEACTIVITYFLAGS/","docId":"gRPC/Messages/OBJECTVERSIONFILEACTIVITYFLAGS/index"},{"type":"link","label":"OBJECTVERSIONPROPERTYACTIVITYFLAGS","href":"/Frameworks/User-Interface-Extensibility-Framework/Reference/gRPC/Messages/OBJECTVERSIONPROPERTYACTIVITYFLAGS/","docId":"gRPC/Messages/OBJECTVERSIONPROPERTYACTIVITYFLAGS/index"},{"type":"link","label":"OBJTYPEFLAGS","href":"/Frameworks/User-Interface-Extensibility-Framework/Reference/gRPC/Messages/OBJTYPEFLAGS/","docId":"gRPC/Messages/OBJTYPEFLAGS/index"},{"type":"link","label":"OBJVERFLAGS","href":"/Frameworks/User-Interface-Extensibility-Framework/Reference/gRPC/Messages/OBJVERFLAGS/","docId":"gRPC/Messages/OBJVERFLAGS/index"},{"type":"link","label":"ObjFileSource","href":"/Frameworks/User-Interface-Extensibility-Framework/Reference/gRPC/Messages/ObjFileSource/","docId":"gRPC/Messages/ObjFileSource/index"},{"type":"category","label":"ObjFileSourceUnion","collapsible":true,"collapsed":true,"items":[{"type":"link","label":"BlankTemplateData","href":"/Frameworks/User-Interface-Extensibility-Framework/Reference/gRPC/Messages/ObjFileSourceUnion/BlankTemplateData/","docId":"gRPC/Messages/ObjFileSourceUnion/BlankTemplateData/index"},{"type":"link","label":"UndefinedSourceData","href":"/Frameworks/User-Interface-Extensibility-Framework/Reference/gRPC/Messages/ObjFileSourceUnion/UndefinedSourceData/","docId":"gRPC/Messages/ObjFileSourceUnion/UndefinedSourceData/index"},{"type":"link","label":"UploadedFileData","href":"/Frameworks/User-Interface-Extensibility-Framework/Reference/gRPC/Messages/ObjFileSourceUnion/UploadedFileData/","docId":"gRPC/Messages/ObjFileSourceUnion/UploadedFileData/index"},{"type":"link","label":"UploadedFilesData","href":"/Frameworks/User-Interface-Extensibility-Framework/Reference/gRPC/Messages/ObjFileSourceUnion/UploadedFilesData/","docId":"gRPC/Messages/ObjFileSourceUnion/UploadedFilesData/index"},{"type":"link","label":"UserDefinedTemplateData","href":"/Frameworks/User-Interface-Extensibility-Framework/Reference/gRPC/Messages/ObjFileSourceUnion/UserDefinedTemplateData/","docId":"gRPC/Messages/ObjFileSourceUnion/UserDefinedTemplateData/index"}],"href":"/Frameworks/User-Interface-Extensibility-Framework/Reference/gRPC/Messages/ObjFileSourceUnion/"},{"type":"link","label":"ObjFileVer","href":"/Frameworks/User-Interface-Extensibility-Framework/Reference/gRPC/Messages/ObjFileVer/","docId":"gRPC/Messages/ObjFileVer/index"},{"type":"link","label":"ObjID","href":"/Frameworks/User-Interface-Extensibility-Framework/Reference/gRPC/Messages/ObjID/","docId":"gRPC/Messages/ObjID/index"},{"type":"link","label":"ObjVer","href":"/Frameworks/User-Interface-Extensibility-Framework/Reference/gRPC/Messages/ObjVer/","docId":"gRPC/Messages/ObjVer/index"},{"type":"link","label":"ObjVerVersion","href":"/Frameworks/User-Interface-Extensibility-Framework/Reference/gRPC/Messages/ObjVerVersion/","docId":"gRPC/Messages/ObjVerVersion/index"},{"type":"link","label":"ObjVerWithProperties","href":"/Frameworks/User-Interface-Extensibility-Framework/Reference/gRPC/Messages/ObjVerWithProperties/","docId":"gRPC/Messages/ObjVerWithProperties/index"},{"type":"link","label":"ObjectClass","href":"/Frameworks/User-Interface-Extensibility-Framework/Reference/gRPC/Messages/ObjectClass/","docId":"gRPC/Messages/ObjectClass/index"},{"type":"link","label":"ObjectLevelInfo","href":"/Frameworks/User-Interface-Extensibility-Framework/Reference/gRPC/Messages/ObjectLevelInfo/","docId":"gRPC/Messages/ObjectLevelInfo/index"},{"type":"link","label":"ObjectPermissionsForClient","href":"/Frameworks/User-Interface-Extensibility-Framework/Reference/gRPC/Messages/ObjectPermissionsForClient/","docId":"gRPC/Messages/ObjectPermissionsForClient/index"},{"type":"link","label":"ObjectTypeIndexingDefinition","href":"/Frameworks/User-Interface-Extensibility-Framework/Reference/gRPC/Messages/ObjectTypeIndexingDefinition/","docId":"gRPC/Messages/ObjectTypeIndexingDefinition/index"},{"type":"link","label":"ObjectTypePermissionsForClient","href":"/Frameworks/User-Interface-Extensibility-Framework/Reference/gRPC/Messages/ObjectTypePermissionsForClient/","docId":"gRPC/Messages/ObjectTypePermissionsForClient/index"},{"type":"link","label":"ObjectTypeSearchCharacteristics","href":"/Frameworks/User-Interface-Extensibility-Framework/Reference/gRPC/Messages/ObjectTypeSearchCharacteristics/","docId":"gRPC/Messages/ObjectTypeSearchCharacteristics/index"},{"type":"link","label":"ObjectTypeTargetForBrowsing","href":"/Frameworks/User-Interface-Extensibility-Framework/Reference/gRPC/Messages/ObjectTypeTargetForBrowsing/","docId":"gRPC/Messages/ObjectTypeTargetForBrowsing/index"},{"type":"link","label":"ObjectVersion","href":"/Frameworks/User-Interface-Extensibility-Framework/Reference/gRPC/Messages/ObjectVersion/","docId":"gRPC/Messages/ObjectVersion/index"},{"type":"link","label":"ObjectVersionActivity","href":"/Frameworks/User-Interface-Extensibility-Framework/Reference/gRPC/Messages/ObjectVersionActivity/","docId":"gRPC/Messages/ObjectVersionActivity/index"},{"type":"link","label":"ObjectVersionActivityRequest","href":"/Frameworks/User-Interface-Extensibility-Framework/Reference/gRPC/Messages/ObjectVersionActivityRequest/","docId":"gRPC/Messages/ObjectVersionActivityRequest/index"},{"type":"link","label":"ObjectVersionActivityResponse","href":"/Frameworks/User-Interface-Extensibility-Framework/Reference/gRPC/Messages/ObjectVersionActivityResponse/","docId":"gRPC/Messages/ObjectVersionActivityResponse/index"},{"type":"link","label":"ObjectVersionAndPropertiesWithMetadata","href":"/Frameworks/User-Interface-Extensibility-Framework/Reference/gRPC/Messages/ObjectVersionAndPropertiesWithMetadata/","docId":"gRPC/Messages/ObjectVersionAndPropertiesWithMetadata/index"},{"type":"link","label":"ObjectVersionData","href":"/Frameworks/User-Interface-Extensibility-Framework/Reference/gRPC/Messages/ObjectVersionData/","docId":"gRPC/Messages/ObjectVersionData/index"},{"type":"link","label":"ObjectVersionDataRequest","href":"/Frameworks/User-Interface-Extensibility-Framework/Reference/gRPC/Messages/ObjectVersionDataRequest/","docId":"gRPC/Messages/ObjectVersionDataRequest/index"},{"type":"link","label":"ObjectVersionDataResult","href":"/Frameworks/User-Interface-Extensibility-Framework/Reference/gRPC/Messages/ObjectVersionDataResult/","docId":"gRPC/Messages/ObjectVersionDataResult/index"},{"type":"link","label":"ObjectVersionEx","href":"/Frameworks/User-Interface-Extensibility-Framework/Reference/gRPC/Messages/ObjectVersionEx/","docId":"gRPC/Messages/ObjectVersionEx/index"},{"type":"link","label":"ObjectVersionExWP","href":"/Frameworks/User-Interface-Extensibility-Framework/Reference/gRPC/Messages/ObjectVersionExWP/","docId":"gRPC/Messages/ObjectVersionExWP/index"},{"type":"link","label":"ObjectVersionFileActivity","href":"/Frameworks/User-Interface-Extensibility-Framework/Reference/gRPC/Messages/ObjectVersionFileActivity/","docId":"gRPC/Messages/ObjectVersionFileActivity/index"},{"type":"link","label":"ObjectVersionPropertyActivity","href":"/Frameworks/User-Interface-Extensibility-Framework/Reference/gRPC/Messages/ObjectVersionPropertyActivity/","docId":"gRPC/Messages/ObjectVersionPropertyActivity/index"},{"type":"link","label":"PROPERTYDEFFLAGS","href":"/Frameworks/User-Interface-Extensibility-Framework/Reference/gRPC/Messages/PROPERTYDEFFLAGS/","docId":"gRPC/Messages/PROPERTYDEFFLAGS/index"},{"type":"link","label":"PropertyDef","href":"/Frameworks/User-Interface-Extensibility-Framework/Reference/gRPC/Messages/PropertyDef/","docId":"gRPC/Messages/PropertyDef/index"},{"type":"link","label":"PropertyDefPermissionsForClient","href":"/Frameworks/User-Interface-Extensibility-Framework/Reference/gRPC/Messages/PropertyDefPermissionsForClient/","docId":"gRPC/Messages/PropertyDefPermissionsForClient/index"},{"type":"link","label":"PropertyValue","href":"/Frameworks/User-Interface-Extensibility-Framework/Reference/gRPC/Messages/PropertyValue/","docId":"gRPC/Messages/PropertyValue/index"},{"type":"link","label":"PropertyValueArray","href":"/Frameworks/User-Interface-Extensibility-Framework/Reference/gRPC/Messages/PropertyValueArray/","docId":"gRPC/Messages/PropertyValueArray/index"},{"type":"link","label":"PropertyValueSuggestion","href":"/Frameworks/User-Interface-Extensibility-Framework/Reference/gRPC/Messages/PropertyValueSuggestion/","docId":"gRPC/Messages/PropertyValueSuggestion/index"},{"type":"link","label":"PropertyValueWithMetadata","href":"/Frameworks/User-Interface-Extensibility-Framework/Reference/gRPC/Messages/PropertyValueWithMetadata/","docId":"gRPC/Messages/PropertyValueWithMetadata/index"},{"type":"link","label":"PropertyValueWithMetadataArray","href":"/Frameworks/User-Interface-Extensibility-Framework/Reference/gRPC/Messages/PropertyValueWithMetadataArray/","docId":"gRPC/Messages/PropertyValueWithMetadataArray/index"},{"type":"link","label":"RelationshipData","href":"/Frameworks/User-Interface-Extensibility-Framework/Reference/gRPC/Messages/RelationshipData/","docId":"gRPC/Messages/RelationshipData/index"},{"type":"link","label":"RelationshipGroup","href":"/Frameworks/User-Interface-Extensibility-Framework/Reference/gRPC/Messages/RelationshipGroup/","docId":"gRPC/Messages/RelationshipGroup/index"},{"type":"link","label":"SEARCHSTATUSFLAGS","href":"/Frameworks/User-Interface-Extensibility-Framework/Reference/gRPC/Messages/SEARCHSTATUSFLAGS/","docId":"gRPC/Messages/SEARCHSTATUSFLAGS/index"},{"type":"link","label":"SRPREQUESTFLAGS","href":"/Frameworks/User-Interface-Extensibility-Framework/Reference/gRPC/Messages/SRPREQUESTFLAGS/","docId":"gRPC/Messages/SRPREQUESTFLAGS/index"},{"type":"link","label":"STATEFLAGS","href":"/Frameworks/User-Interface-Extensibility-Framework/Reference/gRPC/Messages/STATEFLAGS/","docId":"gRPC/Messages/STATEFLAGS/index"},{"type":"link","label":"SearchCondition","href":"/Frameworks/User-Interface-Extensibility-Framework/Reference/gRPC/Messages/SearchCondition/","docId":"gRPC/Messages/SearchCondition/index"},{"type":"link","label":"SearchConditionArray","href":"/Frameworks/User-Interface-Extensibility-Framework/Reference/gRPC/Messages/SearchConditionArray/","docId":"gRPC/Messages/SearchConditionArray/index"},{"type":"link","label":"SearchDef","href":"/Frameworks/User-Interface-Extensibility-Framework/Reference/gRPC/Messages/SearchDef/","docId":"gRPC/Messages/SearchDef/index"},{"type":"link","label":"SearchFlags","href":"/Frameworks/User-Interface-Extensibility-Framework/Reference/gRPC/Messages/SearchFlags/","docId":"gRPC/Messages/SearchFlags/index"},{"type":"link","label":"SearchOutputInfo","href":"/Frameworks/User-Interface-Extensibility-Framework/Reference/gRPC/Messages/SearchOutputInfo/","docId":"gRPC/Messages/SearchOutputInfo/index"},{"type":"link","label":"SearchResultsItem","href":"/Frameworks/User-Interface-Extensibility-Framework/Reference/gRPC/Messages/SearchResultsItem/","docId":"gRPC/Messages/SearchResultsItem/index"},{"type":"link","label":"SearchResultsPageRequest","href":"/Frameworks/User-Interface-Extensibility-Framework/Reference/gRPC/Messages/SearchResultsPageRequest/","docId":"gRPC/Messages/SearchResultsPageRequest/index"},{"type":"link","label":"SearchResultsSorting","href":"/Frameworks/User-Interface-Extensibility-Framework/Reference/gRPC/Messages/SearchResultsSorting/","docId":"gRPC/Messages/SearchResultsSorting/index"},{"type":"link","label":"SearchTarget","href":"/Frameworks/User-Interface-Extensibility-Framework/Reference/gRPC/Messages/SearchTarget/","docId":"gRPC/Messages/SearchTarget/index"},{"type":"link","label":"ServerVaultCapabilities","href":"/Frameworks/User-Interface-Extensibility-Framework/Reference/gRPC/Messages/ServerVaultCapabilities/","docId":"gRPC/Messages/ServerVaultCapabilities/index"},{"type":"link","label":"SessionInfo","href":"/Frameworks/User-Interface-Extensibility-Framework/Reference/gRPC/Messages/SessionInfo/","docId":"gRPC/Messages/SessionInfo/index"},{"type":"link","label":"SetPropertiesParams","href":"/Frameworks/User-Interface-Extensibility-Framework/Reference/gRPC/Messages/SetPropertiesParams/","docId":"gRPC/Messages/SetPropertiesParams/index"},{"type":"link","label":"SortFlags","href":"/Frameworks/User-Interface-Extensibility-Framework/Reference/gRPC/Messages/SortFlags/","docId":"gRPC/Messages/SortFlags/index"},{"type":"link","label":"SortRule","href":"/Frameworks/User-Interface-Extensibility-Framework/Reference/gRPC/Messages/SortRule/","docId":"gRPC/Messages/SortRule/index"},{"type":"link","label":"SortRuleFlags","href":"/Frameworks/User-Interface-Extensibility-Framework/Reference/gRPC/Messages/SortRuleFlags/","docId":"gRPC/Messages/SortRuleFlags/index"},{"type":"link","label":"SortRuleValueArray","href":"/Frameworks/User-Interface-Extensibility-Framework/Reference/gRPC/Messages/SortRuleValueArray/","docId":"gRPC/Messages/SortRuleValueArray/index"},{"type":"link","label":"StateBasic","href":"/Frameworks/User-Interface-Extensibility-Framework/Reference/gRPC/Messages/StateBasic/","docId":"gRPC/Messages/StateBasic/index"},{"type":"link","label":"StateTransitionBasic","href":"/Frameworks/User-Interface-Extensibility-Framework/Reference/gRPC/Messages/StateTransitionBasic/","docId":"gRPC/Messages/StateTransitionBasic/index"},{"type":"link","label":"SubviewGroup","href":"/Frameworks/User-Interface-Extensibility-Framework/Reference/gRPC/Messages/SubviewGroup/","docId":"gRPC/Messages/SubviewGroup/index"},{"type":"link","label":"Template","href":"/Frameworks/User-Interface-Extensibility-Framework/Reference/gRPC/Messages/Template/","docId":"gRPC/Messages/Template/index"},{"type":"link","label":"TypedValue","href":"/Frameworks/User-Interface-Extensibility-Framework/Reference/gRPC/Messages/TypedValue/","docId":"gRPC/Messages/TypedValue/index"},{"type":"link","label":"TypedValueMetadata","href":"/Frameworks/User-Interface-Extensibility-Framework/Reference/gRPC/Messages/TypedValueMetadata/","docId":"gRPC/Messages/TypedValueMetadata/index"},{"type":"link","label":"TypedValueUnion","href":"/Frameworks/User-Interface-Extensibility-Framework/Reference/gRPC/Messages/TypedValueUnion/","docId":"gRPC/Messages/TypedValueUnion/index"},{"type":"link","label":"TypedValueUnionWithMetadata","href":"/Frameworks/User-Interface-Extensibility-Framework/Reference/gRPC/Messages/TypedValueUnionWithMetadata/","docId":"gRPC/Messages/TypedValueUnionWithMetadata/index"},{"type":"link","label":"TypedValueWithMetadata","href":"/Frameworks/User-Interface-Extensibility-Framework/Reference/gRPC/Messages/TypedValueWithMetadata/","docId":"gRPC/Messages/TypedValueWithMetadata/index"},{"type":"link","label":"UploadedFile","href":"/Frameworks/User-Interface-Extensibility-Framework/Reference/gRPC/Messages/UploadedFile/","docId":"gRPC/Messages/UploadedFile/index"},{"type":"link","label":"UploadedFileArray","href":"/Frameworks/User-Interface-Extensibility-Framework/Reference/gRPC/Messages/UploadedFileArray/","docId":"gRPC/Messages/UploadedFileArray/index"},{"type":"link","label":"VIEWFLAGS","href":"/Frameworks/User-Interface-Extensibility-Framework/Reference/gRPC/Messages/VIEWFLAGS/","docId":"gRPC/Messages/VIEWFLAGS/index"},{"type":"link","label":"ValueList","href":"/Frameworks/User-Interface-Extensibility-Framework/Reference/gRPC/Messages/ValueList/","docId":"gRPC/Messages/ValueList/index"},{"type":"link","label":"ValueListItem","href":"/Frameworks/User-Interface-Extensibility-Framework/Reference/gRPC/Messages/ValueListItem/","docId":"gRPC/Messages/ValueListItem/index"},{"type":"link","label":"VersionComment","href":"/Frameworks/User-Interface-Extensibility-Framework/Reference/gRPC/Messages/VersionComment/","docId":"gRPC/Messages/VersionComment/index"},{"type":"link","label":"VersionCommentArray","href":"/Frameworks/User-Interface-Extensibility-Framework/Reference/gRPC/Messages/VersionCommentArray/","docId":"gRPC/Messages/VersionCommentArray/index"},{"type":"link","label":"View","href":"/Frameworks/User-Interface-Extensibility-Framework/Reference/gRPC/Messages/View/","docId":"gRPC/Messages/View/index"},{"type":"link","label":"ViewLocation","href":"/Frameworks/User-Interface-Extensibility-Framework/Reference/gRPC/Messages/ViewLocation/","docId":"gRPC/Messages/ViewLocation/index"},{"type":"link","label":"ViewVisualization","href":"/Frameworks/User-Interface-Extensibility-Framework/Reference/gRPC/Messages/ViewVisualization/","docId":"gRPC/Messages/ViewVisualization/index"},{"type":"link","label":"Workflow","href":"/Frameworks/User-Interface-Extensibility-Framework/Reference/gRPC/Messages/Workflow/","docId":"gRPC/Messages/Workflow/index"},{"type":"link","label":"WorkflowBasic","href":"/Frameworks/User-Interface-Extensibility-Framework/Reference/gRPC/Messages/WorkflowBasic/","docId":"gRPC/Messages/WorkflowBasic/index"}],"href":"/Frameworks/User-Interface-Extensibility-Framework/Reference/gRPC/Messages/"}],"href":"/Frameworks/User-Interface-Extensibility-Framework/Reference/gRPC/"},{"type":"category","label":"Samples","collapsible":true,"collapsed":true,"items":[{"type":"link","label":"Hello, World","href":"/Frameworks/User-Interface-Extensibility-Framework/Reference/Samples/HelloWorld/","docId":"Samples/HelloWorld/index"},{"type":"link","label":"Commands","href":"/Frameworks/User-Interface-Extensibility-Framework/Reference/Samples/Commands/","docId":"Samples/Commands/index"},{"type":"link","label":"ShowNewObjectWindow","href":"/Frameworks/User-Interface-Extensibility-Framework/Reference/Samples/ShowNewObjectWindow With Blank and UserDefined Template/","docId":"Samples/ShowNewObjectWindow With Blank and UserDefined Template/index"},{"type":"link","label":"Built-in Command Demonstration","href":"/Frameworks/User-Interface-Extensibility-Framework/Reference/Samples/BuiltInCommands/","docId":"Samples/BuiltInCommands/index"},{"type":"link","label":"Taskbar Commands","href":"/Frameworks/User-Interface-Extensibility-Framework/Reference/Samples/TaskbarCommands/","docId":"Samples/TaskbarCommands/index"},{"type":"link","label":"PopUp Dashboard","href":"/Frameworks/User-Interface-Extensibility-Framework/Reference/Samples/PopupDashboard/","docId":"Samples/PopupDashboard/index"},{"type":"link","label":"PopUp Dashboard & Accent Color","href":"/Frameworks/User-Interface-Extensibility-Framework/Reference/Samples/PopUpDashboardWithAccentColor/","docId":"Samples/PopUpDashboardWithAccentColor/index"},{"type":"link","label":"ShellFrame & Dashboard","href":"/Frameworks/User-Interface-Extensibility-Framework/Reference/Samples/ShellFrameAndDashboard/","docId":"Samples/ShellFrameAndDashboard/index"},{"type":"link","label":"Assign to me UIX sample","href":"/Frameworks/User-Interface-Extensibility-Framework/Reference/Samples/AssignToMe/","docId":"Samples/AssignToMe/index"},{"type":"link","label":"Interacting with object operation events","href":"/Frameworks/User-Interface-Extensibility-Framework/Reference/Samples/ObjectOperationSupport/","docId":"Samples/ObjectOperationSupport/index"},{"type":"link","label":"Sandbox Attributes support","href":"/Frameworks/User-Interface-Extensibility-Framework/Reference/Samples/SandboxAttributesSupport/","docId":"Samples/SandboxAttributesSupport/index"},{"type":"link","label":"Search Folder Examples","href":"/Frameworks/User-Interface-Extensibility-Framework/Reference/Samples/SearchFolderExamples/","docId":"Samples/SearchFolderExamples/index"},{"type":"link","label":"Error Handling","href":"/Frameworks/User-Interface-Extensibility-Framework/Reference/Samples/ErrorHandling/","docId":"Samples/ErrorHandling/index"},{"type":"link","label":"Vault Messages Package","href":"/Frameworks/User-Interface-Extensibility-Framework/Reference/Samples/VaultMessagesPackage/","docId":"Samples/VaultMessagesPackage/index"}],"href":"/Frameworks/User-Interface-Extensibility-Framework/Reference/Samples/"},{"type":"category","label":"Upgrading applications","collapsible":true,"collapsed":true,"items":[{"type":"link","label":"Deprecated features and alternatives","href":"/Frameworks/User-Interface-Extensibility-Framework/Reference/Upgrading/deprecated_features","docId":"Upgrading/deprecated_features"}],"href":"/Frameworks/User-Interface-Extensibility-Framework/Reference/Upgrading/"}]},"docs":{"getting_started":{"id":"getting_started","title":"Getting Started","description":"Welcome to the documentation on the User Interface Extensibility Framework 2.0 (\\"UIXv2\\"). This framework allows developers to build client-side applications which can extend the M-Files client interface in supported clients.","sidebar":"tutorialSidebar"},"gRPC/Enums/AccessControlSubjectType/index":{"id":"gRPC/Enums/AccessControlSubjectType/index","title":"AccessControlSubjectType","description":"Indirect property ID level type enumeration.","sidebar":"tutorialSidebar"},"gRPC/Enums/ACLEnforcingMode/index":{"id":"gRPC/Enums/ACLEnforcingMode/index","title":"ACLEnforcingMode","description":"ACL enforcing modes.","sidebar":"tutorialSidebar"},"gRPC/Enums/AuthType/index":{"id":"gRPC/Enums/AuthType/index","title":"AuthType","description":"AuthType enumeration.","sidebar":"tutorialSidebar"},"gRPC/Enums/AutomaticValueType/index":{"id":"gRPC/Enums/AutomaticValueType/index","title":"AutomaticValueType","description":"Types of automatic values.","sidebar":"tutorialSidebar"},"gRPC/Enums/CallImportance/index":{"id":"gRPC/Enums/CallImportance/index","title":"CallImportance","description":"Used by MFServer to distinguish between incoming calls of different","sidebar":"tutorialSidebar"},"gRPC/Enums/ConditionType/index":{"id":"gRPC/Enums/ConditionType/index","title":"ConditionType","description":"Condition types enumeration.","sidebar":"tutorialSidebar"},"gRPC/Enums/ContentType/index":{"id":"gRPC/Enums/ContentType/index","title":"ContentType","description":"Content types (sub-datatypes).","sidebar":"tutorialSidebar"},"gRPC/Enums/DataFunction/index":{"id":"gRPC/Enums/DataFunction/index","title":"DataFunction","description":"Functions that operate on a property value, for example.","sidebar":"tutorialSidebar"},"gRPC/Enums/Datatype/index":{"id":"gRPC/Enums/Datatype/index","title":"Datatype","description":"Datatype enumeration.","sidebar":"tutorialSidebar"},"gRPC/Enums/EventType/index":{"id":"gRPC/Enums/EventType/index","title":"EventType","description":"Event type enumeration.","sidebar":"tutorialSidebar"},"gRPC/Enums/ExpressionType/index":{"id":"gRPC/Enums/ExpressionType/index","title":"ExpressionType","description":"Expression types.","sidebar":"tutorialSidebar"},"gRPC/Enums/ExtDBRefreshType/index":{"id":"gRPC/Enums/ExtDBRefreshType/index","title":"ExtDBRefreshType","description":"External database refresh type enumeration.","sidebar":"tutorialSidebar"},"gRPC/Enums/ExtIDStatus/index":{"id":"gRPC/Enums/ExtIDStatus/index","title":"ExtIDStatus","description":"ExtID status enumeration.","sidebar":"tutorialSidebar"},"gRPC/Enums/FileIDType/index":{"id":"gRPC/Enums/FileIDType/index","title":"FileIDType","description":"File id type.","sidebar":"tutorialSidebar"},"gRPC/Enums/FileSizePrecision/index":{"id":"gRPC/Enums/FileSizePrecision/index","title":"FileSizePrecision","description":"Enumeration for specifying the file size precision settings.","sidebar":"tutorialSidebar"},"gRPC/Enums/FileValueType/index":{"id":"gRPC/Enums/FileValueType/index","title":"FileValueType","description":"Enumeration for different conditions regarding file information.","sidebar":"tutorialSidebar"},"gRPC/Enums/FileVerType/index":{"id":"gRPC/Enums/FileVerType/index","title":"FileVerType","description":"File version type.","sidebar":"tutorialSidebar"},"gRPC/Enums/FolderListingAlgorithm/index":{"id":"gRPC/Enums/FolderListingAlgorithm/index","title":"FolderListingAlgorithm","description":"Folder listing algorithm. Used to optimize property folder listings on intermediate view levels.","sidebar":"tutorialSidebar"},"gRPC/Enums/FolderType/index":{"id":"gRPC/Enums/FolderType/index","title":"FolderType","description":"Folder type enumeration.","sidebar":"tutorialSidebar"},"gRPC/Enums/FormattingType/index":{"id":"gRPC/Enums/FormattingType/index","title":"FormattingType","description":"Formatting types.","sidebar":"tutorialSidebar"},"gRPC/Enums/index":{"id":"gRPC/Enums/index","title":"Enums","description":"","sidebar":"tutorialSidebar"},"gRPC/Enums/IndirectPropertyIDLevelType/index":{"id":"gRPC/Enums/IndirectPropertyIDLevelType/index","title":"IndirectPropertyIDLevelType","description":"Indirect property ID level type enumeration.","sidebar":"tutorialSidebar"},"gRPC/Enums/MetadataStructureItem/index":{"id":"gRPC/Enums/MetadataStructureItem/index","title":"MetadataStructureItem","description":"","sidebar":"tutorialSidebar"},"gRPC/Enums/NACLType/index":{"id":"gRPC/Enums/NACLType/index","title":"NACLType","description":"Each named ACL belongs to exactly one type. Types are defined as bit flags so that multiple types can be combined with bitwise OR for filtering purposes, such as in GetNamedACLs.","sidebar":"tutorialSidebar"},"gRPC/Enums/NamedValueType/index":{"id":"gRPC/Enums/NamedValueType/index","title":"NamedValueType","description":"Enumeration of possible named value types.","sidebar":"tutorialSidebar"},"gRPC/Enums/ObjectVersionDataRequestErrorTolerance/index":{"id":"gRPC/Enums/ObjectVersionDataRequestErrorTolerance/index","title":"ObjectVersionDataRequestErrorTolerance","description":"Error tolerance enumeration for object version data request.","sidebar":"tutorialSidebar"},"gRPC/Enums/ObjectVersionDataRequestIdentityType/index":{"id":"gRPC/Enums/ObjectVersionDataRequestIdentityType/index","title":"ObjectVersionDataRequestIdentityType","description":"Identity type enumeration for object version data request. Specifies how objects with changed identities are handled.","sidebar":"tutorialSidebar"},"gRPC/Enums/ObjectVersionDataRequestVersionType/index":{"id":"gRPC/Enums/ObjectVersionDataRequestVersionType/index","title":"ObjectVersionDataRequestVersionType","description":"Version type enumeration for object version data request.","sidebar":"tutorialSidebar"},"gRPC/Enums/ObjFileSourceType/index":{"id":"gRPC/Enums/ObjFileSourceType/index","title":"ObjFileSourceType","description":"Object file source type enumeration.","sidebar":"tutorialSidebar"},"gRPC/Enums/ObjVerVersionType/index":{"id":"gRPC/Enums/ObjVerVersionType/index","title":"ObjVerVersionType","description":"Indirect property ID level type enumeration.","sidebar":"tutorialSidebar"},"gRPC/Enums/ParentChildBehavior/index":{"id":"gRPC/Enums/ParentChildBehavior/index","title":"ParentChildBehavior","description":"Parent-child behavior enumeration (affects searching and view levels).","sidebar":"tutorialSidebar"},"gRPC/Enums/PermissionsExpressionType/index":{"id":"gRPC/Enums/PermissionsExpressionType/index","title":"PermissionsExpressionType","description":"Permission expression types.","sidebar":"tutorialSidebar"},"gRPC/Enums/PropertySetByType/index":{"id":"gRPC/Enums/PropertySetByType/index","title":"PropertySetByType","description":"Property set by enumeration","sidebar":"tutorialSidebar"},"gRPC/Enums/PseudoUserResolutionMode/index":{"id":"gRPC/Enums/PseudoUserResolutionMode/index","title":"PseudoUserResolutionMode","description":"Pseudo-user resolution mode enumeration.","sidebar":"tutorialSidebar"},"gRPC/Enums/ReferenceDirection/index":{"id":"gRPC/Enums/ReferenceDirection/index","title":"ReferenceDirection","description":"Reference direction enumeration.","sidebar":"tutorialSidebar"},"gRPC/Enums/RelationshipDirection/index":{"id":"gRPC/Enums/RelationshipDirection/index","title":"RelationshipDirection","description":"Relationships direction enumeration.","sidebar":"tutorialSidebar"},"gRPC/Enums/SearchMode/index":{"id":"gRPC/Enums/SearchMode/index","title":"SearchMode","description":"Search mode enumeration.","sidebar":"tutorialSidebar"},"gRPC/Enums/StatusType/index":{"id":"gRPC/Enums/StatusType/index","title":"StatusType","description":"Enumeration for different conditions to status information.","sidebar":"tutorialSidebar"},"gRPC/Enums/UpdateType/index":{"id":"gRPC/Enums/UpdateType/index","title":"UpdateType","description":"Update type enumeration.","sidebar":"tutorialSidebar"},"gRPC/Enums/ValidationType/index":{"id":"gRPC/Enums/ValidationType/index","title":"ValidationType","description":"Validation types.","sidebar":"tutorialSidebar"},"gRPC/Enums/ViewType/index":{"id":"gRPC/Enums/ViewType/index","title":"ViewType","description":"View type enumeration.","sidebar":"tutorialSidebar"},"gRPC/Enums/VLSortingType/index":{"id":"gRPC/Enums/VLSortingType/index","title":"VLSortingType","description":"Value list sorting types.","sidebar":"tutorialSidebar"},"gRPC/gRPC":{"id":"gRPC/gRPC","title":"Vault API Reference Guide","description":"The M-Files User Interface Extensibility Framework 2.0 leverages the structures and methods defined within the M-Files gRPC API, thus has a slightly different structure and approach to other development environments such as the Vault Application Framework.","sidebar":"tutorialSidebar"},"gRPC/Interfaces/index":{"id":"gRPC/Interfaces/index","title":"Interfaces","description":"NamedACLsOperations","sidebar":"tutorialSidebar"},"gRPC/Interfaces/NamedACLsOperations/GetNamedACLs/index":{"id":"gRPC/Interfaces/NamedACLsOperations/GetNamedACLs/index","title":"GetNamedACLs","description":"Syntax","sidebar":"tutorialSidebar"},"gRPC/Interfaces/NamedACLsOperations/index":{"id":"gRPC/Interfaces/NamedACLsOperations/index","title":"NamedACLsOperations","description":"Methods","sidebar":"tutorialSidebar"},"gRPC/Interfaces/NamedValueStorageOperations/GetNamedValues/index":{"id":"gRPC/Interfaces/NamedValueStorageOperations/GetNamedValues/index","title":"GetNamedValues","description":"Syntax","sidebar":"tutorialSidebar"},"gRPC/Interfaces/NamedValueStorageOperations/index":{"id":"gRPC/Interfaces/NamedValueStorageOperations/index","title":"NamedValueStorageOperations","description":"Methods","sidebar":"tutorialSidebar"},"gRPC/Interfaces/NamedValueStorageOperations/RemoveNamedValues/index":{"id":"gRPC/Interfaces/NamedValueStorageOperations/RemoveNamedValues/index","title":"RemoveNamedValues","description":"Syntax","sidebar":"tutorialSidebar"},"gRPC/Interfaces/NamedValueStorageOperations/SetNamedValues/index":{"id":"gRPC/Interfaces/NamedValueStorageOperations/SetNamedValues/index","title":"SetNamedValues","description":"Syntax","sidebar":"tutorialSidebar"},"gRPC/Interfaces/ObjectOperations/AddObjectFile/index":{"id":"gRPC/Interfaces/ObjectOperations/AddObjectFile/index","title":"AddObjectFile","description":"Syntax","sidebar":"tutorialSidebar"},"gRPC/Interfaces/ObjectOperations/AddObjectWithFiles/index":{"id":"gRPC/Interfaces/ObjectOperations/AddObjectWithFiles/index","title":"AddObjectWithFiles","description":"Syntax","sidebar":"tutorialSidebar"},"gRPC/Interfaces/ObjectOperations/ChangeSecurity/index":{"id":"gRPC/Interfaces/ObjectOperations/ChangeSecurity/index","title":"ChangeSecurity","description":"Syntax","sidebar":"tutorialSidebar"},"gRPC/Interfaces/ObjectOperations/CheckInMultiple/index":{"id":"gRPC/Interfaces/ObjectOperations/CheckInMultiple/index","title":"CheckInMultiple","description":"Syntax","sidebar":"tutorialSidebar"},"gRPC/Interfaces/ObjectOperations/CheckOutMultiple/index":{"id":"gRPC/Interfaces/ObjectOperations/CheckOutMultiple/index","title":"CheckOutMultiple","description":"Syntax","sidebar":"tutorialSidebar"},"gRPC/Interfaces/ObjectOperations/DestroyObjects/index":{"id":"gRPC/Interfaces/ObjectOperations/DestroyObjects/index","title":"DestroyObjects","description":"Syntax","sidebar":"tutorialSidebar"},"gRPC/Interfaces/ObjectOperations/FollowObject/index":{"id":"gRPC/Interfaces/ObjectOperations/FollowObject/index","title":"FollowObject","description":"Syntax","sidebar":"tutorialSidebar"},"gRPC/Interfaces/ObjectOperations/GetAutomaticMetadata/index":{"id":"gRPC/Interfaces/ObjectOperations/GetAutomaticMetadata/index","title":"GetAutomaticMetadata","description":"Syntax","sidebar":"tutorialSidebar"},"gRPC/Interfaces/ObjectOperations/GetDocEventSubscriptions/index":{"id":"gRPC/Interfaces/ObjectOperations/GetDocEventSubscriptions/index","title":"GetDocEventSubscriptions","description":"Syntax","sidebar":"tutorialSidebar"},"gRPC/Interfaces/ObjectOperations/GetEffectivePermissions/index":{"id":"gRPC/Interfaces/ObjectOperations/GetEffectivePermissions/index","title":"GetEffectivePermissions","description":"Syntax","sidebar":"tutorialSidebar"},"gRPC/Interfaces/ObjectOperations/GetLatestFileVersion/index":{"id":"gRPC/Interfaces/ObjectOperations/GetLatestFileVersion/index","title":"GetLatestFileVersion","description":"Syntax","sidebar":"tutorialSidebar"},"gRPC/Interfaces/ObjectOperations/GetLatestObjectVersion/index":{"id":"gRPC/Interfaces/ObjectOperations/GetLatestObjectVersion/index","title":"GetLatestObjectVersion","description":"Syntax","sidebar":"tutorialSidebar"},"gRPC/Interfaces/ObjectOperations/GetObjectDataOfMultipleObjects/index":{"id":"gRPC/Interfaces/ObjectOperations/GetObjectDataOfMultipleObjects/index","title":"GetObjectDataOfMultipleObjects","description":"Syntax","sidebar":"tutorialSidebar"},"gRPC/Interfaces/ObjectOperations/GetObjectFiles/index":{"id":"gRPC/Interfaces/ObjectOperations/GetObjectFiles/index","title":"GetObjectFiles","description":"Syntax","sidebar":"tutorialSidebar"},"gRPC/Interfaces/ObjectOperations/GetObjectHistory2/index":{"id":"gRPC/Interfaces/ObjectOperations/GetObjectHistory2/index","title":"GetObjectHistory2","description":"Syntax","sidebar":"tutorialSidebar"},"gRPC/Interfaces/ObjectOperations/GetObjIDByGUID/index":{"id":"gRPC/Interfaces/ObjectOperations/GetObjIDByGUID/index","title":"GetObjIDByGUID","description":"Syntax","sidebar":"tutorialSidebar"},"gRPC/Interfaces/ObjectOperations/GetTemplates/index":{"id":"gRPC/Interfaces/ObjectOperations/GetTemplates/index","title":"GetTemplates","description":"Syntax","sidebar":"tutorialSidebar"},"gRPC/Interfaces/ObjectOperations/GetWorkflowsForClient/index":{"id":"gRPC/Interfaces/ObjectOperations/GetWorkflowsForClient/index","title":"GetWorkflowsForClient","description":"Syntax","sidebar":"tutorialSidebar"},"gRPC/Interfaces/ObjectOperations/GetWorkflowStateHistory/index":{"id":"gRPC/Interfaces/ObjectOperations/GetWorkflowStateHistory/index","title":"GetWorkflowStateHistory","description":"Syntax","sidebar":"tutorialSidebar"},"gRPC/Interfaces/ObjectOperations/GetWorkflowStates/index":{"id":"gRPC/Interfaces/ObjectOperations/GetWorkflowStates/index","title":"GetWorkflowStates","description":"Syntax","sidebar":"tutorialSidebar"},"gRPC/Interfaces/ObjectOperations/GetWorkflowStatesAndTransitions/index":{"id":"gRPC/Interfaces/ObjectOperations/GetWorkflowStatesAndTransitions/index","title":"GetWorkflowStatesAndTransitions","description":"Syntax","sidebar":"tutorialSidebar"},"gRPC/Interfaces/ObjectOperations/index":{"id":"gRPC/Interfaces/ObjectOperations/index","title":"ObjectOperations","description":"Methods","sidebar":"tutorialSidebar"},"gRPC/Interfaces/ObjectOperations/PromoteUnmanagedObject/index":{"id":"gRPC/Interfaces/ObjectOperations/PromoteUnmanagedObject/index","title":"PromoteUnmanagedObject","description":"Syntax","sidebar":"tutorialSidebar"},"gRPC/Interfaces/ObjectOperations/RemoveObjectFile/index":{"id":"gRPC/Interfaces/ObjectOperations/RemoveObjectFile/index","title":"RemoveObjectFile","description":"Syntax","sidebar":"tutorialSidebar"},"gRPC/Interfaces/ObjectOperations/RemoveObjects/index":{"id":"gRPC/Interfaces/ObjectOperations/RemoveObjects/index","title":"RemoveObjects","description":"Syntax","sidebar":"tutorialSidebar"},"gRPC/Interfaces/ObjectOperations/RenameObjectFile/index":{"id":"gRPC/Interfaces/ObjectOperations/RenameObjectFile/index","title":"RenameObjectFile","description":"Syntax","sidebar":"tutorialSidebar"},"gRPC/Interfaces/ObjectOperations/SetObjectLevelProperty/index":{"id":"gRPC/Interfaces/ObjectOperations/SetObjectLevelProperty/index","title":"SetObjectLevelProperty","description":"Syntax","sidebar":"tutorialSidebar"},"gRPC/Interfaces/ObjectOperations/SetPropertiesMultiple/index":{"id":"gRPC/Interfaces/ObjectOperations/SetPropertiesMultiple/index","title":"SetPropertiesMultiple","description":"Syntax","sidebar":"tutorialSidebar"},"gRPC/Interfaces/ObjectOperations/UndoCheckoutMultiple/index":{"id":"gRPC/Interfaces/ObjectOperations/UndoCheckoutMultiple/index","title":"UndoCheckoutMultiple","description":"Syntax","sidebar":"tutorialSidebar"},"gRPC/Interfaces/ObjectOperations/UploadExistingFiles/index":{"id":"gRPC/Interfaces/ObjectOperations/UploadExistingFiles/index","title":"UploadExistingFiles","description":"Syntax","sidebar":"tutorialSidebar"},"gRPC/Interfaces/ObjectTypesOperations/GetObjectTypes/index":{"id":"gRPC/Interfaces/ObjectTypesOperations/GetObjectTypes/index","title":"GetObjectTypes","description":"Syntax","sidebar":"tutorialSidebar"},"gRPC/Interfaces/ObjectTypesOperations/index":{"id":"gRPC/Interfaces/ObjectTypesOperations/index","title":"ObjectTypesOperations","description":"Methods","sidebar":"tutorialSidebar"},"gRPC/Interfaces/PropertyDefsOperations/GetObjectClassesAndGroups/index":{"id":"gRPC/Interfaces/PropertyDefsOperations/GetObjectClassesAndGroups/index","title":"GetObjectClassesAndGroups","description":"Syntax","sidebar":"tutorialSidebar"},"gRPC/Interfaces/PropertyDefsOperations/GetPropertyDefs/index":{"id":"gRPC/Interfaces/PropertyDefsOperations/GetPropertyDefs/index","title":"GetPropertyDefs","description":"Syntax","sidebar":"tutorialSidebar"},"gRPC/Interfaces/PropertyDefsOperations/index":{"id":"gRPC/Interfaces/PropertyDefsOperations/index","title":"PropertyDefsOperations","description":"Methods","sidebar":"tutorialSidebar"},"gRPC/Interfaces/SearchOperations/GetFolderContents/index":{"id":"gRPC/Interfaces/SearchOperations/GetFolderContents/index","title":"GetFolderContents","description":"Syntax","sidebar":"tutorialSidebar"},"gRPC/Interfaces/SearchOperations/index":{"id":"gRPC/Interfaces/SearchOperations/index","title":"SearchOperations","description":"Methods","sidebar":"tutorialSidebar"},"gRPC/Interfaces/SearchOperations/SearchObjects/index":{"id":"gRPC/Interfaces/SearchOperations/SearchObjects/index","title":"SearchObjects","description":"Syntax","sidebar":"tutorialSidebar"},"gRPC/Interfaces/ValueListsOperations/GetValueListItemsWithPermissions/index":{"id":"gRPC/Interfaces/ValueListsOperations/GetValueListItemsWithPermissions/index","title":"GetValueListItemsWithPermissions","description":"Syntax","sidebar":"tutorialSidebar"},"gRPC/Interfaces/ValueListsOperations/GetValueLists/index":{"id":"gRPC/Interfaces/ValueListsOperations/GetValueLists/index","title":"GetValueLists","description":"Syntax","sidebar":"tutorialSidebar"},"gRPC/Interfaces/ValueListsOperations/index":{"id":"gRPC/Interfaces/ValueListsOperations/index","title":"ValueListsOperations","description":"Methods","sidebar":"tutorialSidebar"},"gRPC/Interfaces/ValueListsOperations/SearchValueListItemsWithPermissions/index":{"id":"gRPC/Interfaces/ValueListsOperations/SearchValueListItemsWithPermissions/index","title":"SearchValueListItemsWithPermissions","description":"Syntax","sidebar":"tutorialSidebar"},"gRPC/Interfaces/VaultExtensionMethodsOperations/index":{"id":"gRPC/Interfaces/VaultExtensionMethodsOperations/index","title":"VaultExtensionMethodsOperations","description":"Methods","sidebar":"tutorialSidebar"},"gRPC/Interfaces/VaultExtensionMethodsOperations/IsExtensionMethodAvailable/index":{"id":"gRPC/Interfaces/VaultExtensionMethodsOperations/IsExtensionMethodAvailable/index","title":"IsExtensionMethodAvailable","description":"Syntax","sidebar":"tutorialSidebar"},"gRPC/Interfaces/VaultExtensionMethodsOperations/RunExtensionMethod/index":{"id":"gRPC/Interfaces/VaultExtensionMethodsOperations/RunExtensionMethod/index","title":"RunExtensionMethod","description":"Syntax","sidebar":"tutorialSidebar"},"gRPC/Interfaces/VaultOperations/GetMetadataStructureItemIdByAlias/index":{"id":"gRPC/Interfaces/VaultOperations/GetMetadataStructureItemIdByAlias/index","title":"GetMetadataStructureItemIdByAlias","description":"Syntax","sidebar":"tutorialSidebar"},"gRPC/Interfaces/VaultOperations/GetMetadataStructureItemIdByGUID/index":{"id":"gRPC/Interfaces/VaultOperations/GetMetadataStructureItemIdByGUID/index","title":"GetMetadataStructureItemIdByGUID","description":"Syntax","sidebar":"tutorialSidebar"},"gRPC/Interfaces/VaultOperations/index":{"id":"gRPC/Interfaces/VaultOperations/index","title":"VaultOperations","description":"Methods","sidebar":"tutorialSidebar"},"gRPC/Interfaces/ViewsOperations/DeleteView/index":{"id":"gRPC/Interfaces/ViewsOperations/DeleteView/index","title":"DeleteView","description":"Syntax","sidebar":"tutorialSidebar"},"gRPC/Interfaces/ViewsOperations/GetViews/index":{"id":"gRPC/Interfaces/ViewsOperations/GetViews/index","title":"GetViews","description":"Syntax","sidebar":"tutorialSidebar"},"gRPC/Interfaces/ViewsOperations/index":{"id":"gRPC/Interfaces/ViewsOperations/index","title":"ViewsOperations","description":"Methods","sidebar":"tutorialSidebar"},"gRPC/Messages/AccessControlEntry/index":{"id":"gRPC/Messages/AccessControlEntry/index","title":"AccessControlEntry","description":"Example","sidebar":"tutorialSidebar"},"gRPC/Messages/AccessControlList/index":{"id":"gRPC/Messages/AccessControlList/index","title":"AccessControlList","description":"Example","sidebar":"tutorialSidebar"},"gRPC/Messages/AccessControlListComponent/index":{"id":"gRPC/Messages/AccessControlListComponent/index","title":"AccessControlListComponent","description":"Example","sidebar":"tutorialSidebar"},"gRPC/Messages/AccessControlListComponentKey/index":{"id":"gRPC/Messages/AccessControlListComponentKey/index","title":"AccessControlListComponentKey","description":"Example","sidebar":"tutorialSidebar"},"gRPC/Messages/AccessControlListComponentMapEntry/index":{"id":"gRPC/Messages/AccessControlListComponentMapEntry/index","title":"AccessControlListComponentMapEntry","description":"Example","sidebar":"tutorialSidebar"},"gRPC/Messages/ACCESSCONTROLLISTCOMPONENTSTATUSFLAGS/index":{"id":"gRPC/Messages/ACCESSCONTROLLISTCOMPONENTSTATUSFLAGS/index","title":"ACCESSCONTROLLISTCOMPONENTSTATUSFLAGS","description":"Example","sidebar":"tutorialSidebar"},"gRPC/Messages/AccessControlPseudoUserSubject/index":{"id":"gRPC/Messages/AccessControlPseudoUserSubject/index","title":"AccessControlPseudoUserSubject","description":"Example","sidebar":"tutorialSidebar"},"gRPC/Messages/AccessControlSubject/index":{"id":"gRPC/Messages/AccessControlSubject/index","title":"AccessControlSubject","description":"Example","sidebar":"tutorialSidebar"},"gRPC/Messages/AccessControlSubjectUnion/index":{"id":"gRPC/Messages/AccessControlSubjectUnion/index","title":"AccessControlSubjectUnion","description":"Examples","sidebar":"tutorialSidebar"},"gRPC/Messages/ACTIONFLAGS/index":{"id":"gRPC/Messages/ACTIONFLAGS/index","title":"ACTIONFLAGS","description":"Example","sidebar":"tutorialSidebar"},"gRPC/Messages/AssociatedPropertyDef/index":{"id":"gRPC/Messages/AssociatedPropertyDef/index","title":"AssociatedPropertyDef","description":"Example","sidebar":"tutorialSidebar"},"gRPC/Messages/AutomaticMetadataRequest/index":{"id":"gRPC/Messages/AutomaticMetadataRequest/index","title":"AutomaticMetadataRequest","description":"Example","sidebar":"tutorialSidebar"},"gRPC/Messages/AutomaticMetadataResult/index":{"id":"gRPC/Messages/AutomaticMetadataResult/index","title":"AutomaticMetadataResult","description":"Example","sidebar":"tutorialSidebar"},"gRPC/Messages/AutomaticPermissions/index":{"id":"gRPC/Messages/AutomaticPermissions/index","title":"AutomaticPermissions","description":"Example","sidebar":"tutorialSidebar"},"gRPC/Messages/Bytes/index":{"id":"gRPC/Messages/Bytes/index","title":"Bytes","description":"Example","sidebar":"tutorialSidebar"},"gRPC/Messages/ClassGroup/index":{"id":"gRPC/Messages/ClassGroup/index","title":"ClassGroup","description":"Example","sidebar":"tutorialSidebar"},"gRPC/Messages/ClassPermissionsForClient/index":{"id":"gRPC/Messages/ClassPermissionsForClient/index","title":"ClassPermissionsForClient","description":"Example","sidebar":"tutorialSidebar"},"gRPC/Messages/DataFunctionCall/index":{"id":"gRPC/Messages/DataFunctionCall/index","title":"DataFunctionCall","description":"Example","sidebar":"tutorialSidebar"},"gRPC/Messages/DataFunctionUnion/DateData/index":{"id":"gRPC/Messages/DataFunctionUnion/DateData/index","title":"DateData","description":"Example","sidebar":"tutorialSidebar"},"gRPC/Messages/DataFunctionUnion/DaysFromData/index":{"id":"gRPC/Messages/DataFunctionUnion/DaysFromData/index","title":"DaysFromData","description":"Example","sidebar":"tutorialSidebar"},"gRPC/Messages/DataFunctionUnion/DaysToData/index":{"id":"gRPC/Messages/DataFunctionUnion/DaysToData/index","title":"DaysToData","description":"Example","sidebar":"tutorialSidebar"},"gRPC/Messages/DataFunctionUnion/index":{"id":"gRPC/Messages/DataFunctionUnion/index","title":"DataFunctionUnion","description":"Examples","sidebar":"tutorialSidebar"},"gRPC/Messages/DataFunctionUnion/InitialCharacterGroupData/index":{"id":"gRPC/Messages/DataFunctionUnion/InitialCharacterGroupData/index","title":"InitialCharacterGroupData","description":"Example","sidebar":"tutorialSidebar"},"gRPC/Messages/DataFunctionUnion/IntegerSegmentData/index":{"id":"gRPC/Messages/DataFunctionUnion/IntegerSegmentData/index","title":"IntegerSegmentData","description":"Example","sidebar":"tutorialSidebar"},"gRPC/Messages/DataFunctionUnion/LeftCharactersData/index":{"id":"gRPC/Messages/DataFunctionUnion/LeftCharactersData/index","title":"LeftCharactersData","description":"Example","sidebar":"tutorialSidebar"},"gRPC/Messages/DataFunctionUnion/MonthData/index":{"id":"gRPC/Messages/DataFunctionUnion/MonthData/index","title":"MonthData","description":"Example","sidebar":"tutorialSidebar"},"gRPC/Messages/DataFunctionUnion/NoOpData/index":{"id":"gRPC/Messages/DataFunctionUnion/NoOpData/index","title":"NoOpData","description":"Example","sidebar":"tutorialSidebar"},"gRPC/Messages/DataFunctionUnion/YearAndMonthData/index":{"id":"gRPC/Messages/DataFunctionUnion/YearAndMonthData/index","title":"YearAndMonthData","description":"Example","sidebar":"tutorialSidebar"},"gRPC/Messages/DataFunctionUnion/YearData/index":{"id":"gRPC/Messages/DataFunctionUnion/YearData/index","title":"YearData","description":"Example","sidebar":"tutorialSidebar"},"gRPC/Messages/DefaultReplicationConfiguration/index":{"id":"gRPC/Messages/DefaultReplicationConfiguration/index","title":"DefaultReplicationConfiguration","description":"Example","sidebar":"tutorialSidebar"},"gRPC/Messages/DocClassGroup/index":{"id":"gRPC/Messages/DocClassGroup/index","title":"DocClassGroup","description":"Example","sidebar":"tutorialSidebar"},"gRPC/Messages/EffectivePermissions/index":{"id":"gRPC/Messages/EffectivePermissions/index","title":"EffectivePermissions","description":"Example","sidebar":"tutorialSidebar"},"gRPC/Messages/ErrorInfo/index":{"id":"gRPC/Messages/ErrorInfo/index","title":"ErrorInfo","description":"Example","sidebar":"tutorialSidebar"},"gRPC/Messages/EventSubscription/index":{"id":"gRPC/Messages/EventSubscription/index","title":"EventSubscription","description":"Example","sidebar":"tutorialSidebar"},"gRPC/Messages/Expression/index":{"id":"gRPC/Messages/Expression/index","title":"Expression","description":"Helper Methods and Properties","sidebar":"tutorialSidebar"},"gRPC/Messages/EXPRESSIONEXFLAGS/index":{"id":"gRPC/Messages/EXPRESSIONEXFLAGS/index","title":"EXPRESSIONEXFLAGS","description":"Example","sidebar":"tutorialSidebar"},"gRPC/Messages/ExpressionUnion/AnyFieldData/index":{"id":"gRPC/Messages/ExpressionUnion/AnyFieldData/index","title":"AnyFieldData","description":"Example","sidebar":"tutorialSidebar"},"gRPC/Messages/ExpressionUnion/FileValueData/index":{"id":"gRPC/Messages/ExpressionUnion/FileValueData/index","title":"FileValueData","description":"Example","sidebar":"tutorialSidebar"},"gRPC/Messages/ExpressionUnion/IdSegmentData/index":{"id":"gRPC/Messages/ExpressionUnion/IdSegmentData/index","title":"IdSegmentData","description":"Example","sidebar":"tutorialSidebar"},"gRPC/Messages/ExpressionUnion/index":{"id":"gRPC/Messages/ExpressionUnion/index","title":"ExpressionUnion","description":"Examples","sidebar":"tutorialSidebar"},"gRPC/Messages/ExpressionUnion/PermissionsData/index":{"id":"gRPC/Messages/ExpressionUnion/PermissionsData/index","title":"PermissionsData","description":"Example","sidebar":"tutorialSidebar"},"gRPC/Messages/ExpressionUnion/PropertyValueData/index":{"id":"gRPC/Messages/ExpressionUnion/PropertyValueData/index","title":"PropertyValueData","description":"Example","sidebar":"tutorialSidebar"},"gRPC/Messages/ExpressionUnion/StatusValueData/index":{"id":"gRPC/Messages/ExpressionUnion/StatusValueData/index","title":"StatusValueData","description":"Example","sidebar":"tutorialSidebar"},"gRPC/Messages/ExpressionUnion/TypedValueData/index":{"id":"gRPC/Messages/ExpressionUnion/TypedValueData/index","title":"TypedValueData","description":"Example","sidebar":"tutorialSidebar"},"gRPC/Messages/ExpressionUnion/UninitializedData/index":{"id":"gRPC/Messages/ExpressionUnion/UninitializedData/index","title":"UninitializedData","description":"Example","sidebar":"tutorialSidebar"},"gRPC/Messages/ExternalRepositoryID/index":{"id":"gRPC/Messages/ExternalRepositoryID/index","title":"ExternalRepositoryID","description":"Example","sidebar":"tutorialSidebar"},"gRPC/Messages/ExternalView/index":{"id":"gRPC/Messages/ExternalView/index","title":"ExternalView","description":"Example","sidebar":"tutorialSidebar"},"gRPC/Messages/ExtObjectInfo/index":{"id":"gRPC/Messages/ExtObjectInfo/index","title":"ExtObjectInfo","description":"Example","sidebar":"tutorialSidebar"},"gRPC/Messages/File/index":{"id":"gRPC/Messages/File/index","title":"File","description":"Example","sidebar":"tutorialSidebar"},"gRPC/Messages/FileID/index":{"id":"gRPC/Messages/FileID/index","title":"FileID","description":"Example","sidebar":"tutorialSidebar"},"gRPC/Messages/FileVer/index":{"id":"gRPC/Messages/FileVer/index","title":"FileVer","description":"Helper Methods and Properties","sidebar":"tutorialSidebar"},"gRPC/Messages/Folder/index":{"id":"gRPC/Messages/Folder/index","title":"Folder","description":"Example","sidebar":"tutorialSidebar"},"gRPC/Messages/FOLDERCAPABILITYFLAGS/index":{"id":"gRPC/Messages/FOLDERCAPABILITYFLAGS/index","title":"FOLDERCAPABILITYFLAGS","description":"Example","sidebar":"tutorialSidebar"},"gRPC/Messages/FolderInfoUnion/AnyFolderData/index":{"id":"gRPC/Messages/FolderInfoUnion/AnyFolderData/index","title":"AnyFolderData","description":"Example","sidebar":"tutorialSidebar"},"gRPC/Messages/FolderInfoUnion/ExternalViewFolderData/index":{"id":"gRPC/Messages/FolderInfoUnion/ExternalViewFolderData/index","title":"ExternalViewFolderData","description":"Example","sidebar":"tutorialSidebar"},"gRPC/Messages/FolderInfoUnion/index":{"id":"gRPC/Messages/FolderInfoUnion/index","title":"FolderInfoUnion","description":"Examples","sidebar":"tutorialSidebar"},"gRPC/Messages/FolderInfoUnion/PropertyFolderData/index":{"id":"gRPC/Messages/FolderInfoUnion/PropertyFolderData/index","title":"PropertyFolderData","description":"Example","sidebar":"tutorialSidebar"},"gRPC/Messages/FolderInfoUnion/SearchFolderData/index":{"id":"gRPC/Messages/FolderInfoUnion/SearchFolderData/index","title":"SearchFolderData","description":"Example","sidebar":"tutorialSidebar"},"gRPC/Messages/FolderInfoUnion/TraditionalFolderData/index":{"id":"gRPC/Messages/FolderInfoUnion/TraditionalFolderData/index","title":"TraditionalFolderData","description":"Example","sidebar":"tutorialSidebar"},"gRPC/Messages/FolderInfoUnion/UnknownFolderData/index":{"id":"gRPC/Messages/FolderInfoUnion/UnknownFolderData/index","title":"UnknownFolderData","description":"Example","sidebar":"tutorialSidebar"},"gRPC/Messages/FolderInfoUnion/ViewFolderData/index":{"id":"gRPC/Messages/FolderInfoUnion/ViewFolderData/index","title":"ViewFolderData","description":"Example","sidebar":"tutorialSidebar"},"gRPC/Messages/FTSFLAGS/index":{"id":"gRPC/Messages/FTSFLAGS/index","title":"FTSFLAGS","description":"Example","sidebar":"tutorialSidebar"},"gRPC/Messages/GetMetadataStructureItemIdByGUIDRequest/index":{"id":"gRPC/Messages/GetMetadataStructureItemIdByGUIDRequest/index","title":"GetMetadataStructureItemIdByGUIDRequest","description":"Example","sidebar":"tutorialSidebar"},"gRPC/Messages/GetMetadataStructureItemIdByGUIDResponse/index":{"id":"gRPC/Messages/GetMetadataStructureItemIdByGUIDResponse/index","title":"GetMetadataStructureItemIdByGUIDResponse","description":"Example","sidebar":"tutorialSidebar"},"gRPC/Messages/GetObjectVersionAndPropertiesOfMultipleObjectsResponse/index":{"id":"gRPC/Messages/GetObjectVersionAndPropertiesOfMultipleObjectsResponse/index","title":"GetObjectVersionAndPropertiesOfMultipleObjectsResponse","description":"Example","sidebar":"tutorialSidebar"},"gRPC/Messages/GroupingLevel/index":{"id":"gRPC/Messages/GroupingLevel/index","title":"GroupingLevel","description":"Example","sidebar":"tutorialSidebar"},"gRPC/Messages/index":{"id":"gRPC/Messages/index","title":"Messages","description":"","sidebar":"tutorialSidebar"},"gRPC/Messages/IndirectionLevel/index":{"id":"gRPC/Messages/IndirectionLevel/index","title":"IndirectionLevel","description":"Example","sidebar":"tutorialSidebar"},"gRPC/Messages/IndirectPropertyID/index":{"id":"gRPC/Messages/IndirectPropertyID/index","title":"IndirectPropertyID","description":"Example","sidebar":"tutorialSidebar"},"gRPC/Messages/IndirectPropertyIDLevel/index":{"id":"gRPC/Messages/IndirectPropertyIDLevel/index","title":"IndirectPropertyIDLevel","description":"Example","sidebar":"tutorialSidebar"},"gRPC/Messages/IndirectPropertyIDLevelRef/index":{"id":"gRPC/Messages/IndirectPropertyIDLevelRef/index","title":"IndirectPropertyIDLevelRef","description":"Example","sidebar":"tutorialSidebar"},"gRPC/Messages/ITEMFLAGS/index":{"id":"gRPC/Messages/ITEMFLAGS/index","title":"ITEMFLAGS","description":"Example","sidebar":"tutorialSidebar"},"gRPC/Messages/ItemID/index":{"id":"gRPC/Messages/ItemID/index","title":"ItemID","description":"Helper Methods and Properties","sidebar":"tutorialSidebar"},"gRPC/Messages/ItemInfo/index":{"id":"gRPC/Messages/ItemInfo/index","title":"ItemInfo","description":"Example","sidebar":"tutorialSidebar"},"gRPC/Messages/Lookup/index":{"id":"gRPC/Messages/Lookup/index","title":"Lookup","description":"Helper Methods and Properties","sidebar":"tutorialSidebar"},"gRPC/Messages/LookupWithMetadata/index":{"id":"gRPC/Messages/LookupWithMetadata/index","title":"LookupWithMetadata","description":"Example","sidebar":"tutorialSidebar"},"gRPC/Messages/MultiSelectLookup/index":{"id":"gRPC/Messages/MultiSelectLookup/index","title":"MultiSelectLookup","description":"Helper Methods and Properties","sidebar":"tutorialSidebar"},"gRPC/Messages/MultiSelectLookupWithMetadata/index":{"id":"gRPC/Messages/MultiSelectLookupWithMetadata/index","title":"MultiSelectLookupWithMetadata","description":"Example","sidebar":"tutorialSidebar"},"gRPC/Messages/NamedACL/index":{"id":"gRPC/Messages/NamedACL/index","title":"NamedACL","description":"Example","sidebar":"tutorialSidebar"},"gRPC/Messages/NamedValue/index":{"id":"gRPC/Messages/NamedValue/index","title":"NamedValue","description":"Example","sidebar":"tutorialSidebar"},"gRPC/Messages/OBJECTCAPABILITYFLAGS/index":{"id":"gRPC/Messages/OBJECTCAPABILITYFLAGS/index","title":"OBJECTCAPABILITYFLAGS","description":"Example","sidebar":"tutorialSidebar"},"gRPC/Messages/ObjectClass/index":{"id":"gRPC/Messages/ObjectClass/index","title":"ObjectClass","description":"Example","sidebar":"tutorialSidebar"},"gRPC/Messages/OBJECTDATAREQUESTFLAGS/index":{"id":"gRPC/Messages/OBJECTDATAREQUESTFLAGS/index","title":"OBJECTDATAREQUESTFLAGS","description":"Example","sidebar":"tutorialSidebar"},"gRPC/Messages/OBJECTFILEFLAGS/index":{"id":"gRPC/Messages/OBJECTFILEFLAGS/index","title":"OBJECTFILEFLAGS","description":"Example","sidebar":"tutorialSidebar"},"gRPC/Messages/ObjectLevelInfo/index":{"id":"gRPC/Messages/ObjectLevelInfo/index","title":"ObjectLevelInfo","description":"Example","sidebar":"tutorialSidebar"},"gRPC/Messages/OBJECTOPFLAGS/index":{"id":"gRPC/Messages/OBJECTOPFLAGS/index","title":"OBJECTOPFLAGS","description":"Example","sidebar":"tutorialSidebar"},"gRPC/Messages/ObjectPermissionsForClient/index":{"id":"gRPC/Messages/ObjectPermissionsForClient/index","title":"ObjectPermissionsForClient","description":"Example","sidebar":"tutorialSidebar"},"gRPC/Messages/ObjectTypeIndexingDefinition/index":{"id":"gRPC/Messages/ObjectTypeIndexingDefinition/index","title":"ObjectTypeIndexingDefinition","description":"Example","sidebar":"tutorialSidebar"},"gRPC/Messages/ObjectTypePermissionsForClient/index":{"id":"gRPC/Messages/ObjectTypePermissionsForClient/index","title":"ObjectTypePermissionsForClient","description":"Example","sidebar":"tutorialSidebar"},"gRPC/Messages/ObjectTypeSearchCharacteristics/index":{"id":"gRPC/Messages/ObjectTypeSearchCharacteristics/index","title":"ObjectTypeSearchCharacteristics","description":"Example","sidebar":"tutorialSidebar"},"gRPC/Messages/ObjectTypeTargetForBrowsing/index":{"id":"gRPC/Messages/ObjectTypeTargetForBrowsing/index","title":"ObjectTypeTargetForBrowsing","description":"Example","sidebar":"tutorialSidebar"},"gRPC/Messages/ObjectVersion/index":{"id":"gRPC/Messages/ObjectVersion/index","title":"ObjectVersion","description":"Example","sidebar":"tutorialSidebar"},"gRPC/Messages/ObjectVersionActivity/index":{"id":"gRPC/Messages/ObjectVersionActivity/index","title":"ObjectVersionActivity","description":"Example","sidebar":"tutorialSidebar"},"gRPC/Messages/OBJECTVERSIONACTIVITYCATEGORYFLAGS/index":{"id":"gRPC/Messages/OBJECTVERSIONACTIVITYCATEGORYFLAGS/index","title":"OBJECTVERSIONACTIVITYCATEGORYFLAGS","description":"Example","sidebar":"tutorialSidebar"},"gRPC/Messages/ObjectVersionActivityRequest/index":{"id":"gRPC/Messages/ObjectVersionActivityRequest/index","title":"ObjectVersionActivityRequest","description":"Example","sidebar":"tutorialSidebar"},"gRPC/Messages/ObjectVersionActivityResponse/index":{"id":"gRPC/Messages/ObjectVersionActivityResponse/index","title":"ObjectVersionActivityResponse","description":"Example","sidebar":"tutorialSidebar"},"gRPC/Messages/ObjectVersionAndPropertiesWithMetadata/index":{"id":"gRPC/Messages/ObjectVersionAndPropertiesWithMetadata/index","title":"ObjectVersionAndPropertiesWithMetadata","description":"Example","sidebar":"tutorialSidebar"},"gRPC/Messages/ObjectVersionData/index":{"id":"gRPC/Messages/ObjectVersionData/index","title":"ObjectVersionData","description":"Example","sidebar":"tutorialSidebar"},"gRPC/Messages/ObjectVersionDataRequest/index":{"id":"gRPC/Messages/ObjectVersionDataRequest/index","title":"ObjectVersionDataRequest","description":"Example","sidebar":"tutorialSidebar"},"gRPC/Messages/ObjectVersionDataResult/index":{"id":"gRPC/Messages/ObjectVersionDataResult/index","title":"ObjectVersionDataResult","description":"Example","sidebar":"tutorialSidebar"},"gRPC/Messages/ObjectVersionEx/index":{"id":"gRPC/Messages/ObjectVersionEx/index","title":"ObjectVersionEx","description":"Helper Methods and Properties","sidebar":"tutorialSidebar"},"gRPC/Messages/ObjectVersionExWP/index":{"id":"gRPC/Messages/ObjectVersionExWP/index","title":"ObjectVersionExWP","description":"Example","sidebar":"tutorialSidebar"},"gRPC/Messages/ObjectVersionFileActivity/index":{"id":"gRPC/Messages/ObjectVersionFileActivity/index","title":"ObjectVersionFileActivity","description":"Example","sidebar":"tutorialSidebar"},"gRPC/Messages/OBJECTVERSIONFILEACTIVITYFLAGS/index":{"id":"gRPC/Messages/OBJECTVERSIONFILEACTIVITYFLAGS/index","title":"OBJECTVERSIONFILEACTIVITYFLAGS","description":"Example","sidebar":"tutorialSidebar"},"gRPC/Messages/ObjectVersionPropertyActivity/index":{"id":"gRPC/Messages/ObjectVersionPropertyActivity/index","title":"ObjectVersionPropertyActivity","description":"Example","sidebar":"tutorialSidebar"},"gRPC/Messages/OBJECTVERSIONPROPERTYACTIVITYFLAGS/index":{"id":"gRPC/Messages/OBJECTVERSIONPROPERTYACTIVITYFLAGS/index","title":"OBJECTVERSIONPROPERTYACTIVITYFLAGS","description":"Example","sidebar":"tutorialSidebar"},"gRPC/Messages/ObjFileSource/index":{"id":"gRPC/Messages/ObjFileSource/index","title":"ObjFileSource","description":"Example","sidebar":"tutorialSidebar"},"gRPC/Messages/ObjFileSourceUnion/BlankTemplateData/index":{"id":"gRPC/Messages/ObjFileSourceUnion/BlankTemplateData/index","title":"BlankTemplateData","description":"Example","sidebar":"tutorialSidebar"},"gRPC/Messages/ObjFileSourceUnion/index":{"id":"gRPC/Messages/ObjFileSourceUnion/index","title":"ObjFileSourceUnion","description":"Examples","sidebar":"tutorialSidebar"},"gRPC/Messages/ObjFileSourceUnion/UndefinedSourceData/index":{"id":"gRPC/Messages/ObjFileSourceUnion/UndefinedSourceData/index","title":"UndefinedSourceData","description":"Example","sidebar":"tutorialSidebar"},"gRPC/Messages/ObjFileSourceUnion/UploadedFileData/index":{"id":"gRPC/Messages/ObjFileSourceUnion/UploadedFileData/index","title":"UploadedFileData","description":"Example","sidebar":"tutorialSidebar"},"gRPC/Messages/ObjFileSourceUnion/UploadedFilesData/index":{"id":"gRPC/Messages/ObjFileSourceUnion/UploadedFilesData/index","title":"UploadedFilesData","description":"Example","sidebar":"tutorialSidebar"},"gRPC/Messages/ObjFileSourceUnion/UserDefinedTemplateData/index":{"id":"gRPC/Messages/ObjFileSourceUnion/UserDefinedTemplateData/index","title":"UserDefinedTemplateData","description":"Example","sidebar":"tutorialSidebar"},"gRPC/Messages/ObjFileVer/index":{"id":"gRPC/Messages/ObjFileVer/index","title":"ObjFileVer","description":"Example","sidebar":"tutorialSidebar"},"gRPC/Messages/ObjID/index":{"id":"gRPC/Messages/ObjID/index","title":"ObjID","description":"Helper Methods and Properties","sidebar":"tutorialSidebar"},"gRPC/Messages/OBJTYPEFLAGS/index":{"id":"gRPC/Messages/OBJTYPEFLAGS/index","title":"OBJTYPEFLAGS","description":"Example","sidebar":"tutorialSidebar"},"gRPC/Messages/ObjVer/index":{"id":"gRPC/Messages/ObjVer/index","title":"ObjVer","description":"Helper Methods and Properties","sidebar":"tutorialSidebar"},"gRPC/Messages/OBJVERFLAGS/index":{"id":"gRPC/Messages/OBJVERFLAGS/index","title":"OBJVERFLAGS","description":"Example","sidebar":"tutorialSidebar"},"gRPC/Messages/ObjVerVersion/index":{"id":"gRPC/Messages/ObjVerVersion/index","title":"ObjVerVersion","description":"Helper Methods and Properties","sidebar":"tutorialSidebar"},"gRPC/Messages/ObjVerWithProperties/index":{"id":"gRPC/Messages/ObjVerWithProperties/index","title":"ObjVerWithProperties","description":"Example","sidebar":"tutorialSidebar"},"gRPC/Messages/PropertyDef/index":{"id":"gRPC/Messages/PropertyDef/index","title":"PropertyDef","description":"Example","sidebar":"tutorialSidebar"},"gRPC/Messages/PROPERTYDEFFLAGS/index":{"id":"gRPC/Messages/PROPERTYDEFFLAGS/index","title":"PROPERTYDEFFLAGS","description":"Example","sidebar":"tutorialSidebar"},"gRPC/Messages/PropertyDefPermissionsForClient/index":{"id":"gRPC/Messages/PropertyDefPermissionsForClient/index","title":"PropertyDefPermissionsForClient","description":"Example","sidebar":"tutorialSidebar"},"gRPC/Messages/PropertyValue/index":{"id":"gRPC/Messages/PropertyValue/index","title":"PropertyValue","description":"Helper Methods and Properties","sidebar":"tutorialSidebar"},"gRPC/Messages/PropertyValueArray/index":{"id":"gRPC/Messages/PropertyValueArray/index","title":"PropertyValueArray","description":"Helper Methods and Properties","sidebar":"tutorialSidebar"},"gRPC/Messages/PropertyValueSuggestion/index":{"id":"gRPC/Messages/PropertyValueSuggestion/index","title":"PropertyValueSuggestion","description":"Example","sidebar":"tutorialSidebar"},"gRPC/Messages/PropertyValueWithMetadata/index":{"id":"gRPC/Messages/PropertyValueWithMetadata/index","title":"PropertyValueWithMetadata","description":"Example","sidebar":"tutorialSidebar"},"gRPC/Messages/PropertyValueWithMetadataArray/index":{"id":"gRPC/Messages/PropertyValueWithMetadataArray/index","title":"PropertyValueWithMetadataArray","description":"Example","sidebar":"tutorialSidebar"},"gRPC/Messages/RelationshipData/index":{"id":"gRPC/Messages/RelationshipData/index","title":"RelationshipData","description":"Example","sidebar":"tutorialSidebar"},"gRPC/Messages/RelationshipGroup/index":{"id":"gRPC/Messages/RelationshipGroup/index","title":"RelationshipGroup","description":"Example","sidebar":"tutorialSidebar"},"gRPC/Messages/SearchCondition/index":{"id":"gRPC/Messages/SearchCondition/index","title":"SearchCondition","description":"Helper Methods and Properties","sidebar":"tutorialSidebar"},"gRPC/Messages/SearchConditionArray/index":{"id":"gRPC/Messages/SearchConditionArray/index","title":"SearchConditionArray","description":"Helper Methods and Properties","sidebar":"tutorialSidebar"},"gRPC/Messages/SearchDef/index":{"id":"gRPC/Messages/SearchDef/index","title":"SearchDef","description":"Example","sidebar":"tutorialSidebar"},"gRPC/Messages/SearchFlags/index":{"id":"gRPC/Messages/SearchFlags/index","title":"SearchFlags","description":"Example","sidebar":"tutorialSidebar"},"gRPC/Messages/SearchOutputInfo/index":{"id":"gRPC/Messages/SearchOutputInfo/index","title":"SearchOutputInfo","description":"Example","sidebar":"tutorialSidebar"},"gRPC/Messages/SearchResultsItem/index":{"id":"gRPC/Messages/SearchResultsItem/index","title":"SearchResultsItem","description":"Example","sidebar":"tutorialSidebar"},"gRPC/Messages/SearchResultsPageRequest/index":{"id":"gRPC/Messages/SearchResultsPageRequest/index","title":"SearchResultsPageRequest","description":"Example","sidebar":"tutorialSidebar"},"gRPC/Messages/SearchResultsSorting/index":{"id":"gRPC/Messages/SearchResultsSorting/index","title":"SearchResultsSorting","description":"Example","sidebar":"tutorialSidebar"},"gRPC/Messages/SEARCHSTATUSFLAGS/index":{"id":"gRPC/Messages/SEARCHSTATUSFLAGS/index","title":"SEARCHSTATUSFLAGS","description":"Example","sidebar":"tutorialSidebar"},"gRPC/Messages/SearchTarget/index":{"id":"gRPC/Messages/SearchTarget/index","title":"SearchTarget","description":"Example","sidebar":"tutorialSidebar"},"gRPC/Messages/ServerVaultCapabilities/index":{"id":"gRPC/Messages/ServerVaultCapabilities/index","title":"ServerVaultCapabilities","description":"Example","sidebar":"tutorialSidebar"},"gRPC/Messages/SessionInfo/index":{"id":"gRPC/Messages/SessionInfo/index","title":"SessionInfo","description":"Example","sidebar":"tutorialSidebar"},"gRPC/Messages/SetPropertiesParams/index":{"id":"gRPC/Messages/SetPropertiesParams/index","title":"SetPropertiesParams","description":"Example","sidebar":"tutorialSidebar"},"gRPC/Messages/SortFlags/index":{"id":"gRPC/Messages/SortFlags/index","title":"SortFlags","description":"Example","sidebar":"tutorialSidebar"},"gRPC/Messages/SortRule/index":{"id":"gRPC/Messages/SortRule/index","title":"SortRule","description":"Example","sidebar":"tutorialSidebar"},"gRPC/Messages/SortRuleFlags/index":{"id":"gRPC/Messages/SortRuleFlags/index","title":"SortRuleFlags","description":"Example","sidebar":"tutorialSidebar"},"gRPC/Messages/SortRuleValueArray/index":{"id":"gRPC/Messages/SortRuleValueArray/index","title":"SortRuleValueArray","description":"Example","sidebar":"tutorialSidebar"},"gRPC/Messages/SRPREQUESTFLAGS/index":{"id":"gRPC/Messages/SRPREQUESTFLAGS/index","title":"SRPREQUESTFLAGS","description":"Example","sidebar":"tutorialSidebar"},"gRPC/Messages/StateBasic/index":{"id":"gRPC/Messages/StateBasic/index","title":"StateBasic","description":"Example","sidebar":"tutorialSidebar"},"gRPC/Messages/STATEFLAGS/index":{"id":"gRPC/Messages/STATEFLAGS/index","title":"STATEFLAGS","description":"Example","sidebar":"tutorialSidebar"},"gRPC/Messages/StateTransitionBasic/index":{"id":"gRPC/Messages/StateTransitionBasic/index","title":"StateTransitionBasic","description":"Example","sidebar":"tutorialSidebar"},"gRPC/Messages/SubviewGroup/index":{"id":"gRPC/Messages/SubviewGroup/index","title":"SubviewGroup","description":"Example","sidebar":"tutorialSidebar"},"gRPC/Messages/Template/index":{"id":"gRPC/Messages/Template/index","title":"Template","description":"Example","sidebar":"tutorialSidebar"},"gRPC/Messages/TypedValue/index":{"id":"gRPC/Messages/TypedValue/index","title":"TypedValue","description":"Helper Methods and Properties","sidebar":"tutorialSidebar"},"gRPC/Messages/TypedValueMetadata/index":{"id":"gRPC/Messages/TypedValueMetadata/index","title":"TypedValueMetadata","description":"Example","sidebar":"tutorialSidebar"},"gRPC/Messages/TypedValueUnion/index":{"id":"gRPC/Messages/TypedValueUnion/index","title":"TypedValueUnion","description":"Examples","sidebar":"tutorialSidebar"},"gRPC/Messages/TypedValueUnionWithMetadata/index":{"id":"gRPC/Messages/TypedValueUnionWithMetadata/index","title":"TypedValueUnionWithMetadata","description":"Examples","sidebar":"tutorialSidebar"},"gRPC/Messages/TypedValueWithMetadata/index":{"id":"gRPC/Messages/TypedValueWithMetadata/index","title":"TypedValueWithMetadata","description":"Example","sidebar":"tutorialSidebar"},"gRPC/Messages/UploadedFile/index":{"id":"gRPC/Messages/UploadedFile/index","title":"UploadedFile","description":"Example","sidebar":"tutorialSidebar"},"gRPC/Messages/UploadedFileArray/index":{"id":"gRPC/Messages/UploadedFileArray/index","title":"UploadedFileArray","description":"Example","sidebar":"tutorialSidebar"},"gRPC/Messages/ValueList/index":{"id":"gRPC/Messages/ValueList/index","title":"ValueList","description":"Example","sidebar":"tutorialSidebar"},"gRPC/Messages/ValueListItem/index":{"id":"gRPC/Messages/ValueListItem/index","title":"ValueListItem","description":"Example","sidebar":"tutorialSidebar"},"gRPC/Messages/VersionComment/index":{"id":"gRPC/Messages/VersionComment/index","title":"VersionComment","description":"Example","sidebar":"tutorialSidebar"},"gRPC/Messages/VersionCommentArray/index":{"id":"gRPC/Messages/VersionCommentArray/index","title":"VersionCommentArray","description":"Example","sidebar":"tutorialSidebar"},"gRPC/Messages/View/index":{"id":"gRPC/Messages/View/index","title":"View","description":"Example","sidebar":"tutorialSidebar"},"gRPC/Messages/VIEWFLAGS/index":{"id":"gRPC/Messages/VIEWFLAGS/index","title":"VIEWFLAGS","description":"Example","sidebar":"tutorialSidebar"},"gRPC/Messages/ViewLocation/index":{"id":"gRPC/Messages/ViewLocation/index","title":"ViewLocation","description":"Example","sidebar":"tutorialSidebar"},"gRPC/Messages/ViewVisualization/index":{"id":"gRPC/Messages/ViewVisualization/index","title":"ViewVisualization","description":"Example","sidebar":"tutorialSidebar"},"gRPC/Messages/Workflow/index":{"id":"gRPC/Messages/Workflow/index","title":"Workflow","description":"Example","sidebar":"tutorialSidebar"},"gRPC/Messages/WorkflowBasic/index":{"id":"gRPC/Messages/WorkflowBasic/index","title":"WorkflowBasic","description":"Example","sidebar":"tutorialSidebar"},"Overview/ApplicationStructure":{"id":"Overview/ApplicationStructure","title":"Application Structure","description":"Each UI Extension Application is a JavaScript application that extends the core functionality of the associated M-Files client. Each application can use the UI Extension API to interact with other areas of the UI, and the Vault API to interact with the vault structure and contents.","sidebar":"tutorialSidebar"},"Overview/Commands":{"id":"Overview/Commands","title":"Using Custom Commands","description":"The Custom Commands interface provides a set of commands for customizing menus, creating custom commands, and managing their states in M-Files UI Extensions. The ICommands provides set of tools for developers to customize the user interface, manage commands, and control their visibility and availability within the application.","sidebar":"tutorialSidebar"},"Overview/Dashboards":{"id":"Overview/Dashboards","title":"Dashboards","description":"Dashboards are custom HTML pages defined by the application and can reference typical web content such as JavaScript and CSS files. These custom HTML pages may be shown all the time in a custom tab, shown in a tab which is shown or hidden depending upon user interaction, or shown via code as a custom popup dialog. Each dashboard, when shown, is rendered within an `` element.","sidebar":"tutorialSidebar"},"Overview/Debugging":{"id":"Overview/Debugging","title":"Testing and Developing","description":"Runtime Environment","sidebar":"tutorialSidebar"},"Overview/Events":{"id":"Overview/Events","title":"Events","description":"The UI Extension Application has different kinds of event handlers:","sidebar":"tutorialSidebar"},"Overview/exceptions":{"id":"Overview/exceptions","title":"Exception Reference","description":"This page provides detailed information about all exception types that can be thrown by M-Files UI Extension methods.","sidebar":"tutorialSidebar"},"Overview/InstallingApplications":{"id":"Overview/InstallingApplications","title":"Installing Applications","description":"M-Files UI Extensions are managed using the M-Files Admin tool.","sidebar":"tutorialSidebar"},"Overview/ListingView":{"id":"Overview/ListingView","title":"Working with the Shell Listing","description":"The Shell Listing represents the list of files, objects, views, groupings, or other content shown within the current object listing. Changes in the listing view affect various parts of the client. For example: when objects are selected or deselected the Preview and Metadata tabs display information about the selected object(s).","sidebar":"tutorialSidebar"},"Overview/Messages":{"id":"Overview/Messages","title":"Dialogs and Messages","description":"UI Extension Applications can define a rich UI interface using HTML and JavaScript inside their own IFRAME. However, sometimes it is necessary to create modal dialogs which break the IFRAME boundary.","sidebar":"tutorialSidebar"},"Overview/MFilesGlobalObject":{"id":"Overview/MFilesGlobalObject","title":"MFiles Global Object","description":"The MFiles global object is available in your UI Extension code after initialization. It provides access to enumerations, utility functions, and the Vault API enums.","sidebar":"tutorialSidebar"},"Overview/Modules":{"id":"Overview/Modules","title":"Modules","description":"The modules inside the Application Manifest define the entrypoint JavaScript file which is to be executed for the extension. Specifically the `` node in the XML","sidebar":"tutorialSidebar"},"Overview/Overview":{"id":"Overview/Overview","title":"Overview","description":"User Interface Extensibility Framework applications are JavaScript applications that run within the M-Files Web client. The framework provides a set of objects that allow you to interact with the user interface by adding commands to various menus, to add your own tabs/dashboards, or to react when various events fire within the user interface. Applications can also use the M-Files Vault API to perform tasks within the vault such as searching or creating objects.","sidebar":"tutorialSidebar"},"Overview/Tabs":{"id":"Overview/Tabs","title":"Tabs","description":"The M-Files user interface typically shows two tabs on the right of the screen: Metadata and Preview. As users interact with the object listings (e.g. they select an object), these two tabs react and show the associated metadata and preview respectively.","sidebar":"tutorialSidebar"},"Overview/VaultMessages":{"id":"Overview/VaultMessages","title":"Vault API Helpers","description":"When communicating with the M-Files vault through the gRPC API, you work with structured message objects such as ObjID, PropertyValue, TypedValue, and SearchConditionArray. Constructing these objects by hand as raw JSON is verbose and error-prone.","sidebar":"tutorialSidebar"},"Samples/AssignToMe/index":{"id":"Samples/AssignToMe/index","title":"Creating assignments for selected objects","description":"Overview","sidebar":"tutorialSidebar"},"Samples/BuiltInCommands/index":{"id":"Samples/BuiltInCommands/index","title":"Built-in Command Demonstration","description":"Overview","sidebar":"tutorialSidebar"},"Samples/Commands/index":{"id":"Samples/Commands/index","title":"Commands","description":"Overview","sidebar":"tutorialSidebar"},"Samples/ErrorHandling/index":{"id":"Samples/ErrorHandling/index","title":"Error Handling","description":"Overview","sidebar":"tutorialSidebar"},"Samples/HelloWorld/index":{"id":"Samples/HelloWorld/index","title":"Hello, World","description":"Overview","sidebar":"tutorialSidebar"},"Samples/ObjectOperationSupport/index":{"id":"Samples/ObjectOperationSupport/index","title":"Interacting with object operation events","description":"Overview","sidebar":"tutorialSidebar"},"Samples/PopupDashboard/index":{"id":"Samples/PopupDashboard/index","title":"PopUp Dashboard","description":"Overview","sidebar":"tutorialSidebar"},"Samples/PopUpDashboardWithAccentColor/index":{"id":"Samples/PopUpDashboardWithAccentColor/index","title":"PopUp Dashboard","description":"Overview","sidebar":"tutorialSidebar"},"Samples/Samples":{"id":"Samples/Samples","title":"Samples","description":"Please note that these samples are provided \u201cas-is\u201d and with no warranty, explicit or otherwise. You should ensure that the functionality of these samples meet your requirements, and thoroughly test them, prior to using in any production scenarios. The items linked below are designed as teaching tools and may not be fully complete.","sidebar":"tutorialSidebar"},"Samples/SandboxAttributesSupport/index":{"id":"Samples/SandboxAttributesSupport/index","title":"Creating Sandbox Attributes Support.","description":"Overview","sidebar":"tutorialSidebar"},"Samples/SearchFolderExamples/index":{"id":"Samples/SearchFolderExamples/index","title":"Creating search folders","description":"Overview","sidebar":"tutorialSidebar"},"Samples/ShellFrameAndDashboard/index":{"id":"Samples/ShellFrameAndDashboard/index","title":"ShellFrame & Dashboard","description":"Overview","sidebar":"tutorialSidebar"},"Samples/ShowNewObjectWindow With Blank and UserDefined Template/index":{"id":"Samples/ShowNewObjectWindow With Blank and UserDefined Template/index","title":"ShowNewObjectWindow (Blank and UserDefined Template)","description":"Overview","sidebar":"tutorialSidebar"},"Samples/TaskbarCommands/index":{"id":"Samples/TaskbarCommands/index","title":"Taskbar Commands","description":"Overview","sidebar":"tutorialSidebar"},"Samples/VaultMessagesPackage/index":{"id":"Samples/VaultMessagesPackage/index","title":"Using the Vault Messages Package","description":"Overview","sidebar":"tutorialSidebar"},"UIExt2/Enums/BuiltinCommand/index":{"id":"UIExt2/Enums/BuiltinCommand/index","title":"BuiltinCommand","description":"","sidebar":"tutorialSidebar"},"UIExt2/Enums/BuiltInIcon/index":{"id":"UIExt2/Enums/BuiltInIcon/index","title":"BuiltInIcon","description":"","sidebar":"tutorialSidebar"},"UIExt2/Enums/CommandLocation/index":{"id":"UIExt2/Enums/CommandLocation/index","title":"CommandLocation","description":"","sidebar":"tutorialSidebar"},"UIExt2/Enums/CommandState/index":{"id":"UIExt2/Enums/CommandState/index","title":"CommandState","description":"","sidebar":"tutorialSidebar"},"UIExt2/Enums/Event/index":{"id":"UIExt2/Enums/Event/index","title":"Event","description":"","sidebar":"tutorialSidebar"},"UIExt2/Enums/FacetRangeType/index":{"id":"UIExt2/Enums/FacetRangeType/index","title":"FacetRangeType","description":"","sidebar":"tutorialSidebar"},"UIExt2/Enums/FacetTransformation/index":{"id":"UIExt2/Enums/FacetTransformation/index","title":"FacetTransformation","description":"","sidebar":"tutorialSidebar"},"UIExt2/Enums/FacetType/index":{"id":"UIExt2/Enums/FacetType/index","title":"FacetType","description":"","sidebar":"tutorialSidebar"},"UIExt2/Enums/FacetValueType/index":{"id":"UIExt2/Enums/FacetValueType/index","title":"FacetValueType","description":"","sidebar":"tutorialSidebar"},"UIExt2/Enums/IconContentType/index":{"id":"UIExt2/Enums/IconContentType/index","title":"IconContentType","description":"","sidebar":"tutorialSidebar"},"UIExt2/Enums/index":{"id":"UIExt2/Enums/index","title":"Enums","description":"","sidebar":"tutorialSidebar"},"UIExt2/Enums/MenuLocation/index":{"id":"UIExt2/Enums/MenuLocation/index","title":"MenuLocation","description":"","sidebar":"tutorialSidebar"},"UIExt2/Enums/MFBuiltInObjectType/index":{"id":"UIExt2/Enums/MFBuiltInObjectType/index","title":"MFBuiltInObjectType","description":"","sidebar":"tutorialSidebar"},"UIExt2/Enums/MFBuiltInPropertyDef/index":{"id":"UIExt2/Enums/MFBuiltInPropertyDef/index","title":"MFBuiltInPropertyDef","description":"","sidebar":"tutorialSidebar"},"UIExt2/Enums/MFBuiltInValueList/index":{"id":"UIExt2/Enums/MFBuiltInValueList/index","title":"MFBuiltInValueList","description":"","sidebar":"tutorialSidebar"},"UIExt2/Enums/MFBuiltInView/index":{"id":"UIExt2/Enums/MFBuiltInView/index","title":"MFBuiltInView","description":"","sidebar":"tutorialSidebar"},"UIExt2/Enums/ObjectWindowResultCode/index":{"id":"UIExt2/Enums/ObjectWindowResultCode/index","title":"ObjectWindowResultCode","description":"","sidebar":"tutorialSidebar"},"UIExt2/Enums/SearchEngine/index":{"id":"UIExt2/Enums/SearchEngine/index","title":"SearchEngine","description":"","sidebar":"tutorialSidebar"},"UIExt2/Enums/ToastType/index":{"id":"UIExt2/Enums/ToastType/index","title":"ToastType","description":"","sidebar":"tutorialSidebar"},"UIExt2/Events":{"id":"UIExt2/Events","title":"Events","description":"IDashboardEvents","sidebar":"tutorialSidebar"},"UIExt2/Interfaces/ICommands/AddCustomCommandToMenu/index":{"id":"UIExt2/Interfaces/ICommands/AddCustomCommandToMenu/index","title":"AddCustomCommandToMenu","description":"Description","sidebar":"tutorialSidebar"},"UIExt2/Interfaces/ICommands/CreateCustomCommand/index":{"id":"UIExt2/Interfaces/ICommands/CreateCustomCommand/index","title":"CreateCustomCommand","description":"Description","sidebar":"tutorialSidebar"},"UIExt2/Interfaces/ICommands/CreateSubMenuItem/index":{"id":"UIExt2/Interfaces/ICommands/CreateSubMenuItem/index","title":"CreateSubMenuItem","description":"Description","sidebar":"tutorialSidebar"},"UIExt2/Interfaces/ICommands/CreateTaskbarGroup/index":{"id":"UIExt2/Interfaces/ICommands/CreateTaskbarGroup/index","title":"CreateTaskbarGroup","description":"Description","sidebar":"tutorialSidebar"},"UIExt2/Interfaces/ICommands/DeleteCustomCommand/index":{"id":"UIExt2/Interfaces/ICommands/DeleteCustomCommand/index","title":"DeleteCustomCommand","description":"Description","sidebar":"tutorialSidebar"},"UIExt2/Interfaces/ICommands/ExecuteCommand/index":{"id":"UIExt2/Interfaces/ICommands/ExecuteCommand/index","title":"ExecuteCommand","description":"Description","sidebar":"tutorialSidebar"},"UIExt2/Interfaces/ICommands/GetCommandName/index":{"id":"UIExt2/Interfaces/ICommands/GetCommandName/index","title":"GetCommandName","description":"Description","sidebar":"tutorialSidebar"},"UIExt2/Interfaces/ICommands/GetCommandState/index":{"id":"UIExt2/Interfaces/ICommands/GetCommandState/index","title":"GetCommandState","description":"Description","sidebar":"tutorialSidebar"},"UIExt2/Interfaces/ICommands/GetMenuIdOfBuiltInCommand/index":{"id":"UIExt2/Interfaces/ICommands/GetMenuIdOfBuiltInCommand/index","title":"GetMenuIdOfBuiltInCommand","description":"Description","sidebar":"tutorialSidebar"},"UIExt2/Interfaces/ICommands/index":{"id":"UIExt2/Interfaces/ICommands/index","title":"ICommands","description":"The Commands API includes functionality for creating Custom Commands and menus.","sidebar":"tutorialSidebar"},"UIExt2/Interfaces/ICommands/RemoveCustomCommandFromMenu/index":{"id":"UIExt2/Interfaces/ICommands/RemoveCustomCommandFromMenu/index","title":"RemoveCustomCommandFromMenu","description":"Description","sidebar":"tutorialSidebar"},"UIExt2/Interfaces/ICommands/RemoveMenuItem/index":{"id":"UIExt2/Interfaces/ICommands/RemoveMenuItem/index","title":"RemoveMenuItem","description":"Description","sidebar":"tutorialSidebar"},"UIExt2/Interfaces/ICommands/RemoveTaskbarGroup/index":{"id":"UIExt2/Interfaces/ICommands/RemoveTaskbarGroup/index","title":"RemoveTaskbarGroup","description":"Description","sidebar":"tutorialSidebar"},"UIExt2/Interfaces/ICommands/SetCommandState/index":{"id":"UIExt2/Interfaces/ICommands/SetCommandState/index","title":"SetCommandState","description":"Description","sidebar":"tutorialSidebar"},"UIExt2/Interfaces/ICommands/SetIcon/index":{"id":"UIExt2/Interfaces/ICommands/SetIcon/index","title":"SetIcon","description":"Description","sidebar":"tutorialSidebar"},"UIExt2/Interfaces/ICommands/SetMenuItemState/index":{"id":"UIExt2/Interfaces/ICommands/SetMenuItemState/index","title":"SetMenuItemState","description":"Description","sidebar":"tutorialSidebar"},"UIExt2/Interfaces/ICommands/SetTaskbarGroupIcon/index":{"id":"UIExt2/Interfaces/ICommands/SetTaskbarGroupIcon/index","title":"SetTaskbarGroupIcon","description":"Description","sidebar":"tutorialSidebar"},"UIExt2/Interfaces/ICommonFunctions/DeleteFromWebStorage/index":{"id":"UIExt2/Interfaces/ICommonFunctions/DeleteFromWebStorage/index","title":"DeleteFromWebStorage","description":"Description","sidebar":"tutorialSidebar"},"UIExt2/Interfaces/ICommonFunctions/DownloadFileAsDataUri/index":{"id":"UIExt2/Interfaces/ICommonFunctions/DownloadFileAsDataUri/index","title":"DownloadFileAsDataUri","description":"Description","sidebar":"tutorialSidebar"},"UIExt2/Interfaces/ICommonFunctions/GetAccentColor/index":{"id":"UIExt2/Interfaces/ICommonFunctions/GetAccentColor/index","title":"GetAccentColor","description":"Description","sidebar":"tutorialSidebar"},"UIExt2/Interfaces/ICommonFunctions/GetClientLanguage/index":{"id":"UIExt2/Interfaces/ICommonFunctions/GetClientLanguage/index","title":"GetClientLanguage","description":"Description","sidebar":"tutorialSidebar"},"UIExt2/Interfaces/ICommonFunctions/GetClientLocale/index":{"id":"UIExt2/Interfaces/ICommonFunctions/GetClientLocale/index","title":"GetClientLocale","description":"Description","sidebar":"tutorialSidebar"},"UIExt2/Interfaces/ICommonFunctions/GetClientLocaleIn3Letters/index":{"id":"UIExt2/Interfaces/ICommonFunctions/GetClientLocaleIn3Letters/index","title":"GetClientLocaleIn3Letters","description":"Description","sidebar":"tutorialSidebar"},"UIExt2/Interfaces/ICommonFunctions/GetSessionInfo/index":{"id":"UIExt2/Interfaces/ICommonFunctions/GetSessionInfo/index","title":"GetSessionInfo","description":"Description","sidebar":"tutorialSidebar"},"UIExt2/Interfaces/ICommonFunctions/GetUTCOffset/index":{"id":"UIExt2/Interfaces/ICommonFunctions/GetUTCOffset/index","title":"GetUTCOffset","description":"Description","sidebar":"tutorialSidebar"},"UIExt2/Interfaces/ICommonFunctions/GetVaultInfo/index":{"id":"UIExt2/Interfaces/ICommonFunctions/GetVaultInfo/index","title":"GetVaultInfo","description":"Description","sidebar":"tutorialSidebar"},"UIExt2/Interfaces/ICommonFunctions/GetWebLink/index":{"id":"UIExt2/Interfaces/ICommonFunctions/GetWebLink/index","title":"GetWebLink","description":"Description","sidebar":"tutorialSidebar"},"UIExt2/Interfaces/ICommonFunctions/index":{"id":"UIExt2/Interfaces/ICommonFunctions/index","title":"ICommonFunctions","description":"Provides set of common functions for interacting with the environment. This interfaces is bound to the global MFiles object.","sidebar":"tutorialSidebar"},"UIExt2/Interfaces/ICommonFunctions/OpenExternalWebLink/index":{"id":"UIExt2/Interfaces/ICommonFunctions/OpenExternalWebLink/index","title":"OpenExternalWebLink","description":"Description","sidebar":"tutorialSidebar"},"UIExt2/Interfaces/ICommonFunctions/ReadFromWebStorage/index":{"id":"UIExt2/Interfaces/ICommonFunctions/ReadFromWebStorage/index","title":"ReadFromWebStorage","description":"Description","sidebar":"tutorialSidebar"},"UIExt2/Interfaces/ICommonFunctions/ReportException/index":{"id":"UIExt2/Interfaces/ICommonFunctions/ReportException/index","title":"ReportException","description":"Description","sidebar":"tutorialSidebar"},"UIExt2/Interfaces/ICommonFunctions/ShowEditObjectWindow/index":{"id":"UIExt2/Interfaces/ICommonFunctions/ShowEditObjectWindow/index","title":"ShowEditObjectWindow","description":"Description","sidebar":"tutorialSidebar"},"UIExt2/Interfaces/ICommonFunctions/ShowNewObjectWindow/index":{"id":"UIExt2/Interfaces/ICommonFunctions/ShowNewObjectWindow/index","title":"ShowNewObjectWindow","description":"Description","sidebar":"tutorialSidebar"},"UIExt2/Interfaces/ICommonFunctions/ShowToast/index":{"id":"UIExt2/Interfaces/ICommonFunctions/ShowToast/index","title":"ShowToast","description":"Description","sidebar":"tutorialSidebar"},"UIExt2/Interfaces/ICommonFunctions/UploadTemporaryFiles/index":{"id":"UIExt2/Interfaces/ICommonFunctions/UploadTemporaryFiles/index","title":"UploadTemporaryFiles","description":"Description","sidebar":"tutorialSidebar"},"UIExt2/Interfaces/ICommonFunctions/WriteToWebStorage/index":{"id":"UIExt2/Interfaces/ICommonFunctions/WriteToWebStorage/index","title":"WriteToWebStorage","description":"Description","sidebar":"tutorialSidebar"},"UIExt2/Interfaces/IDashboard/GetSandboxAttributes/index":{"id":"UIExt2/Interfaces/IDashboard/GetSandboxAttributes/index","title":"GetSandboxAttributes","description":"Description","sidebar":"tutorialSidebar"},"UIExt2/Interfaces/IDashboard/index":{"id":"UIExt2/Interfaces/IDashboard/index","title":"IDashboard","description":"This is the programmatic interface of the dashboard. It is created during the dashboard initialization phase.","sidebar":"tutorialSidebar"},"UIExt2/Interfaces/IDashboard/ShowMessage/index":{"id":"UIExt2/Interfaces/IDashboard/ShowMessage/index","title":"ShowMessage","description":"Description","sidebar":"tutorialSidebar"},"UIExt2/Interfaces/IDashboard/ShowPopupDashboard/index":{"id":"UIExt2/Interfaces/IDashboard/ShowPopupDashboard/index","title":"ShowPopupDashboard","description":"Description","sidebar":"tutorialSidebar"},"UIExt2/Interfaces/IDashboard/UpdateCustomData/index":{"id":"UIExt2/Interfaces/IDashboard/UpdateCustomData/index","title":"UpdateCustomData","description":"Description","sidebar":"tutorialSidebar"},"UIExt2/Interfaces/IDashboard/WaitForClose/index":{"id":"UIExt2/Interfaces/IDashboard/WaitForClose/index","title":"WaitForClose","description":"Description","sidebar":"tutorialSidebar"},"UIExt2/Interfaces/IEvents/index":{"id":"UIExt2/Interfaces/IEvents/index","title":"IEvents","description":"This is the generic events interface. See the list of supported events for each interface","sidebar":"tutorialSidebar"},"UIExt2/Interfaces/IEvents/Register/index":{"id":"UIExt2/Interfaces/IEvents/Register/index","title":"Register","description":"Description","sidebar":"tutorialSidebar"},"UIExt2/Interfaces/IEvents/RegisterBuiltinCommand/index":{"id":"UIExt2/Interfaces/IEvents/RegisterBuiltinCommand/index","title":"RegisterBuiltinCommand","description":"Description","sidebar":"tutorialSidebar"},"UIExt2/Interfaces/IEvents/Unregister/index":{"id":"UIExt2/Interfaces/IEvents/Unregister/index","title":"Unregister","description":"Description","sidebar":"tutorialSidebar"},"UIExt2/Interfaces/index":{"id":"UIExt2/Interfaces/index","title":"Interfaces","description":"","sidebar":"tutorialSidebar"},"UIExt2/Interfaces/ISearchPane/GetOptions/index":{"id":"UIExt2/Interfaces/ISearchPane/GetOptions/index","title":"GetOptions","description":"Description","sidebar":"tutorialSidebar"},"UIExt2/Interfaces/ISearchPane/GetSearchCriteria/index":{"id":"UIExt2/Interfaces/ISearchPane/GetSearchCriteria/index","title":"GetSearchCriteria","description":"Description","sidebar":"tutorialSidebar"},"UIExt2/Interfaces/ISearchPane/index":{"id":"UIExt2/Interfaces/ISearchPane/index","title":"ISearchPane","description":"Represents the area reserved for the Search component and is a property of IShellFrame","sidebar":"tutorialSidebar"},"UIExt2/Interfaces/ISearchPane/IsSearchView/index":{"id":"UIExt2/Interfaces/ISearchPane/IsSearchView/index","title":"IsSearchView","description":"Description","sidebar":"tutorialSidebar"},"UIExt2/Interfaces/ISearchPane/SetOptionState/index":{"id":"UIExt2/Interfaces/ISearchPane/SetOptionState/index","title":"SetOptionState","description":"Description","sidebar":"tutorialSidebar"},"UIExt2/Interfaces/ISearchPane/SetSearchCriteria/index":{"id":"UIExt2/Interfaces/ISearchPane/SetSearchCriteria/index","title":"SetSearchCriteria","description":"Description","sidebar":"tutorialSidebar"},"UIExt2/Interfaces/IShellFrame/CallSimplifiedAPI/index":{"id":"UIExt2/Interfaces/IShellFrame/CallSimplifiedAPI/index","title":"CallSimplifiedAPI","description":"Description","sidebar":"tutorialSidebar"},"UIExt2/Interfaces/IShellFrame/GetSandboxAttributes/index":{"id":"UIExt2/Interfaces/IShellFrame/GetSandboxAttributes/index","title":"GetSandboxAttributes","description":"Description","sidebar":"tutorialSidebar"},"UIExt2/Interfaces/IShellFrame/GetViewsById/index":{"id":"UIExt2/Interfaces/IShellFrame/GetViewsById/index","title":"GetViewsById","description":"Description","sidebar":"tutorialSidebar"},"UIExt2/Interfaces/IShellFrame/index":{"id":"UIExt2/Interfaces/IShellFrame/index","title":"IShellFrame","description":"The IShellFrame is a property of IDashboard.","sidebar":"tutorialSidebar"},"UIExt2/Interfaces/IShellFrame/IsFolderLocation/index":{"id":"UIExt2/Interfaces/IShellFrame/IsFolderLocation/index","title":"IsFolderLocation","description":"Description","sidebar":"tutorialSidebar"},"UIExt2/Interfaces/IShellFrame/IsObjectLocation/index":{"id":"UIExt2/Interfaces/IShellFrame/IsObjectLocation/index","title":"IsObjectLocation","description":"Description","sidebar":"tutorialSidebar"},"UIExt2/Interfaces/IShellFrame/NavigateToFolder/index":{"id":"UIExt2/Interfaces/IShellFrame/NavigateToFolder/index","title":"NavigateToFolder","description":"Description","sidebar":"tutorialSidebar"},"UIExt2/Interfaces/IShellFrame/NavigateToObject/index":{"id":"UIExt2/Interfaces/IShellFrame/NavigateToObject/index","title":"NavigateToObject","description":"Description","sidebar":"tutorialSidebar"},"UIExt2/Interfaces/IShellFrame/NavigateToParent/index":{"id":"UIExt2/Interfaces/IShellFrame/NavigateToParent/index","title":"NavigateToParent","description":"Description","sidebar":"tutorialSidebar"},"UIExt2/Interfaces/IShellFrame/ShowDashboard/index":{"id":"UIExt2/Interfaces/IShellFrame/ShowDashboard/index","title":"ShowDashboard","description":"Description","sidebar":"tutorialSidebar"},"UIExt2/Interfaces/IShellFrame/ShowDefaultContent/index":{"id":"UIExt2/Interfaces/IShellFrame/ShowDefaultContent/index","title":"ShowDefaultContent","description":"Description","sidebar":"tutorialSidebar"},"UIExt2/Interfaces/IShellFrame/ShowMessage/index":{"id":"UIExt2/Interfaces/IShellFrame/ShowMessage/index","title":"ShowMessage","description":"Description","sidebar":"tutorialSidebar"},"UIExt2/Interfaces/IShellFrame/ShowPopupDashboard/index":{"id":"UIExt2/Interfaces/IShellFrame/ShowPopupDashboard/index","title":"ShowPopupDashboard","description":"Description","sidebar":"tutorialSidebar"},"UIExt2/Interfaces/IShellFrame/ShowPopupDashboards/index":{"id":"UIExt2/Interfaces/IShellFrame/ShowPopupDashboards/index","title":"ShowPopupDashboards","description":"Description","sidebar":"tutorialSidebar"},"UIExt2/Interfaces/IShellItems/GetFoldersCount/index":{"id":"UIExt2/Interfaces/IShellItems/GetFoldersCount/index","title":"GetFoldersCount","description":"Description","sidebar":"tutorialSidebar"},"UIExt2/Interfaces/IShellItems/GetObjectVersionsAndProperties/index":{"id":"UIExt2/Interfaces/IShellItems/GetObjectVersionsAndProperties/index","title":"GetObjectVersionsAndProperties","description":"Description","sidebar":"tutorialSidebar"},"UIExt2/Interfaces/IShellItems/GetObjectVersionsCount/index":{"id":"UIExt2/Interfaces/IShellItems/GetObjectVersionsCount/index","title":"GetObjectVersionsCount","description":"Description","sidebar":"tutorialSidebar"},"UIExt2/Interfaces/IShellItems/index":{"id":"UIExt2/Interfaces/IShellItems/index","title":"IShellItems","description":"IShellItems represent a list of Objects in IShellListing, usually the current selection or list of all items in the view.","sidebar":"tutorialSidebar"},"UIExt2/Interfaces/IShellListing/ActivateListing/index":{"id":"UIExt2/Interfaces/IShellListing/ActivateListing/index","title":"ActivateListing","description":"Description","sidebar":"tutorialSidebar"},"UIExt2/Interfaces/IShellListing/ActivateSelected/index":{"id":"UIExt2/Interfaces/IShellListing/ActivateSelected/index","title":"ActivateSelected","description":"Description","sidebar":"tutorialSidebar"},"UIExt2/Interfaces/IShellListing/AddListingItem/index":{"id":"UIExt2/Interfaces/IShellListing/AddListingItem/index","title":"AddListingItem","description":"Description","sidebar":"tutorialSidebar"},"UIExt2/Interfaces/IShellListing/AddObjectFile/index":{"id":"UIExt2/Interfaces/IShellListing/AddObjectFile/index","title":"AddObjectFile","description":"Description","sidebar":"tutorialSidebar"},"UIExt2/Interfaces/IShellListing/GetFolderName/index":{"id":"UIExt2/Interfaces/IShellListing/GetFolderName/index","title":"GetFolderName","description":"Description","sidebar":"tutorialSidebar"},"UIExt2/Interfaces/IShellListing/index":{"id":"UIExt2/Interfaces/IShellListing/index","title":"IShellListing","description":"Instances of IShellListing represent the Objects inside the Listing View tree in the M-Files Client application UI. The interface","sidebar":"tutorialSidebar"},"UIExt2/Interfaces/IShellListing/RefreshListing/index":{"id":"UIExt2/Interfaces/IShellListing/RefreshListing/index","title":"RefreshListing","description":"Description","sidebar":"tutorialSidebar"},"UIExt2/Interfaces/IShellListing/RefreshObject/index":{"id":"UIExt2/Interfaces/IShellListing/RefreshObject/index","title":"RefreshObject","description":"Description","sidebar":"tutorialSidebar"},"UIExt2/Interfaces/IShellListing/RemoveListingItem/index":{"id":"UIExt2/Interfaces/IShellListing/RemoveListingItem/index","title":"RemoveListingItem","description":"Description","sidebar":"tutorialSidebar"},"UIExt2/Interfaces/IShellListing/ReplaceFile/index":{"id":"UIExt2/Interfaces/IShellListing/ReplaceFile/index","title":"ReplaceFile","description":"Description","sidebar":"tutorialSidebar"},"UIExt2/Interfaces/IShellListing/SelectFolder/index":{"id":"UIExt2/Interfaces/IShellListing/SelectFolder/index","title":"SelectFolder","description":"Description","sidebar":"tutorialSidebar"},"UIExt2/Interfaces/IShellListing/SelectNextFolder/index":{"id":"UIExt2/Interfaces/IShellListing/SelectNextFolder/index","title":"SelectNextFolder","description":"Description","sidebar":"tutorialSidebar"},"UIExt2/Interfaces/IShellListing/SelectNextObject/index":{"id":"UIExt2/Interfaces/IShellListing/SelectNextObject/index","title":"SelectNextObject","description":"Description","sidebar":"tutorialSidebar"},"UIExt2/Interfaces/IShellListing/SelectNextObjectFile/index":{"id":"UIExt2/Interfaces/IShellListing/SelectNextObjectFile/index","title":"SelectNextObjectFile","description":"Description","sidebar":"tutorialSidebar"},"UIExt2/Interfaces/IShellListing/SelectObjectFile/index":{"id":"UIExt2/Interfaces/IShellListing/SelectObjectFile/index","title":"SelectObjectFile","description":"Description","sidebar":"tutorialSidebar"},"UIExt2/Interfaces/IShellListing/SelectObjectOrObjectFileVersion/index":{"id":"UIExt2/Interfaces/IShellListing/SelectObjectOrObjectFileVersion/index","title":"SelectObjectOrObjectFileVersion","description":"Description","sidebar":"tutorialSidebar"},"UIExt2/Interfaces/IShellListing/SelectObjectVersion/index":{"id":"UIExt2/Interfaces/IShellListing/SelectObjectVersion/index","title":"SelectObjectVersion","description":"Description","sidebar":"tutorialSidebar"},"UIExt2/Interfaces/IShellListing/SelectPrevFolder/index":{"id":"UIExt2/Interfaces/IShellListing/SelectPrevFolder/index","title":"SelectPrevFolder","description":"Description","sidebar":"tutorialSidebar"},"UIExt2/Interfaces/IShellListing/SelectPrevObject/index":{"id":"UIExt2/Interfaces/IShellListing/SelectPrevObject/index","title":"SelectPrevObject","description":"Description","sidebar":"tutorialSidebar"},"UIExt2/Interfaces/IShellListing/SelectPrevObjectFile/index":{"id":"UIExt2/Interfaces/IShellListing/SelectPrevObjectFile/index","title":"SelectPrevObjectFile","description":"Description","sidebar":"tutorialSidebar"},"UIExt2/Interfaces/IShellListing/SetFolderOrObjectVersionSelectionStates/index":{"id":"UIExt2/Interfaces/IShellListing/SetFolderOrObjectVersionSelectionStates/index","title":"SetFolderOrObjectVersionSelectionStates","description":"Description","sidebar":"tutorialSidebar"},"UIExt2/Interfaces/IShellListing/SetFolderSelectionStates/index":{"id":"UIExt2/Interfaces/IShellListing/SetFolderSelectionStates/index","title":"SetFolderSelectionStates","description":"Description","sidebar":"tutorialSidebar"},"UIExt2/Interfaces/IShellListing/SetObjectOrObjectFileVersionSelectionStates/index":{"id":"UIExt2/Interfaces/IShellListing/SetObjectOrObjectFileVersionSelectionStates/index","title":"SetObjectOrObjectFileVersionSelectionStates","description":"Description","sidebar":"tutorialSidebar"},"UIExt2/Interfaces/IShellListing/SetObjectVersionSelectionStates/index":{"id":"UIExt2/Interfaces/IShellListing/SetObjectVersionSelectionStates/index","title":"SetObjectVersionSelectionStates","description":"Description","sidebar":"tutorialSidebar"},"UIExt2/Interfaces/IShellListing/SetVirtualSelection/index":{"id":"UIExt2/Interfaces/IShellListing/SetVirtualSelection/index","title":"SetVirtualSelection","description":"Description","sidebar":"tutorialSidebar"},"UIExt2/Interfaces/IShellListing/UnselectAll/index":{"id":"UIExt2/Interfaces/IShellListing/UnselectAll/index","title":"UnselectAll","description":"Description","sidebar":"tutorialSidebar"},"UIExt2/Interfaces/IShellListing/UpdateListingItem/index":{"id":"UIExt2/Interfaces/IShellListing/UpdateListingItem/index","title":"UpdateListingItem","description":"Description","sidebar":"tutorialSidebar"},"UIExt2/Interfaces/IShellPaneContainer/AddTab/index":{"id":"UIExt2/Interfaces/IShellPaneContainer/AddTab/index","title":"AddTab","description":"Description","sidebar":"tutorialSidebar"},"UIExt2/Interfaces/IShellPaneContainer/GetSelectedTabs/index":{"id":"UIExt2/Interfaces/IShellPaneContainer/GetSelectedTabs/index","title":"GetSelectedTabs","description":"Description","sidebar":"tutorialSidebar"},"UIExt2/Interfaces/IShellPaneContainer/GetTab/index":{"id":"UIExt2/Interfaces/IShellPaneContainer/GetTab/index","title":"GetTab","description":"Description","sidebar":"tutorialSidebar"},"UIExt2/Interfaces/IShellPaneContainer/index":{"id":"UIExt2/Interfaces/IShellPaneContainer/index","title":"IShellPaneContainer","description":"Represents an area of the screen which is reserved for displaying the dashboards. Usually a property of IShellFrame","sidebar":"tutorialSidebar"},"UIExt2/Interfaces/IShellPaneTab/index":{"id":"UIExt2/Interfaces/IShellPaneTab/index","title":"IShellPaneTab","description":"Tabs can be accessed using IShellPaneContainer methods like AddTab or GetTab. Usually Tab is used to","sidebar":"tutorialSidebar"},"UIExt2/Interfaces/IShellPaneTab/Remove/index":{"id":"UIExt2/Interfaces/IShellPaneTab/Remove/index","title":"Remove","description":"Description","sidebar":"tutorialSidebar"},"UIExt2/Interfaces/IShellPaneTab/Select/index":{"id":"UIExt2/Interfaces/IShellPaneTab/Select/index","title":"Select","description":"Description","sidebar":"tutorialSidebar"},"UIExt2/Interfaces/IShellPaneTab/SetVisible/index":{"id":"UIExt2/Interfaces/IShellPaneTab/SetVisible/index","title":"SetVisible","description":"Description","sidebar":"tutorialSidebar"},"UIExt2/Interfaces/IShellPaneTab/ShowDashboard/index":{"id":"UIExt2/Interfaces/IShellPaneTab/ShowDashboard/index","title":"ShowDashboard","description":"Description","sidebar":"tutorialSidebar"},"UIExt2/Interfaces/IShellPaneTab/ShowEmptyContent/index":{"id":"UIExt2/Interfaces/IShellPaneTab/ShowEmptyContent/index","title":"ShowEmptyContent","description":"Description","sidebar":"tutorialSidebar"},"UIExt2/Interfaces/IShellPaneTab/Unselect/index":{"id":"UIExt2/Interfaces/IShellPaneTab/Unselect/index","title":"Unselect","description":"Description","sidebar":"tutorialSidebar"},"UIExt2/Interfaces/IShellUI/BroadcastMessage/index":{"id":"UIExt2/Interfaces/IShellUI/BroadcastMessage/index","title":"BroadcastMessage","description":"Description","sidebar":"tutorialSidebar"},"UIExt2/Interfaces/IShellUI/GetFileTypeIconURL/index":{"id":"UIExt2/Interfaces/IShellUI/GetFileTypeIconURL/index","title":"GetFileTypeIconURL","description":"Description","sidebar":"tutorialSidebar"},"UIExt2/Interfaces/IShellUI/GetObjectTypeIconURL/index":{"id":"UIExt2/Interfaces/IShellUI/GetObjectTypeIconURL/index","title":"GetObjectTypeIconURL","description":"Description","sidebar":"tutorialSidebar"},"UIExt2/Interfaces/IShellUI/GetValueListItemIconURL/index":{"id":"UIExt2/Interfaces/IShellUI/GetValueListItemIconURL/index","title":"GetValueListItemIconURL","description":"Description","sidebar":"tutorialSidebar"},"UIExt2/Interfaces/IShellUI/index":{"id":"UIExt2/Interfaces/IShellUI/index","title":"IShellUI","description":"The IShellUI is available for the Modules on the module startup event","sidebar":"tutorialSidebar"},"UIExt2/Interfaces/IShellUI/NotifyApplication/index":{"id":"UIExt2/Interfaces/IShellUI/NotifyApplication/index","title":"NotifyApplication","description":"Description","sidebar":"tutorialSidebar"},"UIExt2/Interfaces/IShellUI/ShowMessage/index":{"id":"UIExt2/Interfaces/IShellUI/ShowMessage/index","title":"ShowMessage","description":"Description","sidebar":"tutorialSidebar"},"UIExt2/Interfaces/IShellUI/ShowPopupDashboard/index":{"id":"UIExt2/Interfaces/IShellUI/ShowPopupDashboard/index","title":"ShowPopupDashboard","description":"Description","sidebar":"tutorialSidebar"},"UIExt2/Interfaces/IWindow/Close/index":{"id":"UIExt2/Interfaces/IWindow/Close/index","title":"Close","description":"Description","sidebar":"tutorialSidebar"},"UIExt2/Interfaces/IWindow/index":{"id":"UIExt2/Interfaces/IWindow/index","title":"IWindow","description":"Instance of IWindow is found from Window property of IDashboard when the dashboard is created as a popup dashboard","sidebar":"tutorialSidebar"},"UIExt2/Interfaces/IWindow/ResizeToDefaultSize/index":{"id":"UIExt2/Interfaces/IWindow/ResizeToDefaultSize/index","title":"ResizeToDefaultSize","description":"Description","sidebar":"tutorialSidebar"},"UIExt2/Interfaces/IWindow/SetCloseIconVisibility/index":{"id":"UIExt2/Interfaces/IWindow/SetCloseIconVisibility/index","title":"SetCloseIconVisibility","description":"Description","sidebar":"tutorialSidebar"},"UIExt2/Interfaces/IWindow/SetDefaultSize/index":{"id":"UIExt2/Interfaces/IWindow/SetDefaultSize/index","title":"SetDefaultSize","description":"Description","sidebar":"tutorialSidebar"},"UIExt2/Interfaces/IWindow/SetSize/index":{"id":"UIExt2/Interfaces/IWindow/SetSize/index","title":"SetSize","description":"Description","sidebar":"tutorialSidebar"},"UIExt2/Interfaces/IWindow/SetTitle/index":{"id":"UIExt2/Interfaces/IWindow/SetTitle/index","title":"SetTitle","description":"Description","sidebar":"tutorialSidebar"},"UIExt2/Interfaces/TListingActionArgs/index":{"id":"UIExt2/Interfaces/TListingActionArgs/index","title":"TListingActionArgs","description":"Properties","sidebar":"tutorialSidebar"},"UIExt2/Models/DashboardConfig/index":{"id":"UIExt2/Models/DashboardConfig/index","title":"DashboardConfig","description":"Description","sidebar":"tutorialSidebar"},"UIExt2/Models/DialogUIParams/index":{"id":"UIExt2/Models/DialogUIParams/index","title":"DialogUIParams","description":"Description","sidebar":"tutorialSidebar"},"UIExt2/Models/Facet/index":{"id":"UIExt2/Models/Facet/index","title":"Facet","description":"Description","sidebar":"tutorialSidebar"},"UIExt2/Models/FacetDefinition/index":{"id":"UIExt2/Models/FacetDefinition/index","title":"FacetDefinition","description":"Description","sidebar":"tutorialSidebar"},"UIExt2/Models/FacetLookupValue/index":{"id":"UIExt2/Models/FacetLookupValue/index","title":"FacetLookupValue","description":"Description","sidebar":"tutorialSidebar"},"UIExt2/Models/FacetNumericRangeValue/index":{"id":"UIExt2/Models/FacetNumericRangeValue/index","title":"FacetNumericRangeValue","description":"Description","sidebar":"tutorialSidebar"},"UIExt2/Models/FacetNumericValue/index":{"id":"UIExt2/Models/FacetNumericValue/index","title":"FacetNumericValue","description":"Description","sidebar":"tutorialSidebar"},"UIExt2/Models/FacetStringValue/index":{"id":"UIExt2/Models/FacetStringValue/index","title":"FacetStringValue","description":"Description","sidebar":"tutorialSidebar"},"UIExt2/Models/FacetValue/index":{"id":"UIExt2/Models/FacetValue/index","title":"FacetValue","description":"Description","sidebar":"tutorialSidebar"},"UIExt2/Models/FtsScope/index":{"id":"UIExt2/Models/FtsScope/index","title":"FtsScope","description":"Description","sidebar":"tutorialSidebar"},"UIExt2/Models/IIconInformation/index":{"id":"UIExt2/Models/IIconInformation/index","title":"IIconInformation","description":"Description","sidebar":"tutorialSidebar"},"UIExt2/Models/index":{"id":"UIExt2/Models/index","title":"Models","description":"","sidebar":"tutorialSidebar"},"UIExt2/Models/INonSensitiveVaultData/index":{"id":"UIExt2/Models/INonSensitiveVaultData/index","title":"INonSensitiveVaultData","description":"Description","sidebar":"tutorialSidebar"},"UIExt2/Models/ISelectedFile/index":{"id":"UIExt2/Models/ISelectedFile/index","title":"ISelectedFile","description":"Description","sidebar":"tutorialSidebar"},"UIExt2/Models/IVaultInfo/index":{"id":"UIExt2/Models/IVaultInfo/index","title":"IVaultInfo","description":"Description","sidebar":"tutorialSidebar"},"UIExt2/Models/IVaultInfoReturnValue/index":{"id":"UIExt2/Models/IVaultInfoReturnValue/index","title":"IVaultInfoReturnValue","description":"Description","sidebar":"tutorialSidebar"},"UIExt2/Models/LookupValue/index":{"id":"UIExt2/Models/LookupValue/index","title":"LookupValue","description":"Properties","sidebar":"tutorialSidebar"},"UIExt2/Models/MFError/index":{"id":"UIExt2/Models/MFError/index","title":"MFError","description":"Description","sidebar":"tutorialSidebar"},"UIExt2/Models/MultiDashboardUIParams/index":{"id":"UIExt2/Models/MultiDashboardUIParams/index","title":"MultiDashboardUIParams","description":"Description","sidebar":"tutorialSidebar"},"UIExt2/Models/NonSensitiveSessionData/index":{"id":"UIExt2/Models/NonSensitiveSessionData/index","title":"NonSensitiveSessionData","description":"Description","sidebar":"tutorialSidebar"},"UIExt2/Models/NumericRangeValue/index":{"id":"UIExt2/Models/NumericRangeValue/index","title":"NumericRangeValue","description":"Properties","sidebar":"tutorialSidebar"},"UIExt2/Models/NumericValue/index":{"id":"UIExt2/Models/NumericValue/index","title":"NumericValue","description":"Properties","sidebar":"tutorialSidebar"},"UIExt2/Models/ObjectCreationInfo/index":{"id":"UIExt2/Models/ObjectCreationInfo/index","title":"ObjectCreationInfo","description":"Description","sidebar":"tutorialSidebar"},"UIExt2/Models/ObjectFile/index":{"id":"UIExt2/Models/ObjectFile/index","title":"ObjectFile","description":"Description","sidebar":"tutorialSidebar"},"UIExt2/Models/ObjectFileVersionArgumentValue/index":{"id":"UIExt2/Models/ObjectFileVersionArgumentValue/index","title":"ObjectFileVersionArgumentValue","description":"Properties","sidebar":"tutorialSidebar"},"UIExt2/Models/ObjectFileVersionParams/index":{"id":"UIExt2/Models/ObjectFileVersionParams/index","title":"ObjectFileVersionParams","description":"Description","sidebar":"tutorialSidebar"},"UIExt2/Models/ObjectWindowResult/index":{"id":"UIExt2/Models/ObjectWindowResult/index","title":"ObjectWindowResult","description":"Description","sidebar":"tutorialSidebar"},"UIExt2/Models/SearchCriteria/index":{"id":"UIExt2/Models/SearchCriteria/index","title":"SearchCriteria","description":"Description","sidebar":"tutorialSidebar"},"UIExt2/Models/ShellFrameFolders/index":{"id":"UIExt2/Models/ShellFrameFolders/index","title":"ShellFrameFolders","description":"Description","sidebar":"tutorialSidebar"},"UIExt2/Models/ShowMessageArgumentValue/index":{"id":"UIExt2/Models/ShowMessageArgumentValue/index","title":"ShowMessageArgumentValue","description":"Description","sidebar":"tutorialSidebar"},"UIExt2/Models/ShowMessageParams/index":{"id":"UIExt2/Models/ShowMessageParams/index","title":"ShowMessageParams","description":"Description","sidebar":"tutorialSidebar"},"UIExt2/Models/ShowMessageReturnValue/index":{"id":"UIExt2/Models/ShowMessageReturnValue/index","title":"ShowMessageReturnValue","description":"Description","sidebar":"tutorialSidebar"},"UIExt2/Models/StringValue/index":{"id":"UIExt2/Models/StringValue/index","title":"StringValue","description":"Properties","sidebar":"tutorialSidebar"},"UIExt2/Models/VaultInfoReturnValue/index":{"id":"UIExt2/Models/VaultInfoReturnValue/index","title":"VaultInfoReturnValue","description":"Description","sidebar":"tutorialSidebar"},"UIExt2/UIExt2":{"id":"UIExt2/UIExt2","title":"API Reference Guide","description":"The M-Files User Interface Extensibility Framework exposes a number of items that are used to interact with the user interface. Use the navigation on the left to view the various interfaces, enumerations, and events that are available to you.","sidebar":"tutorialSidebar"},"Upgrading/deprecated_features":{"id":"Upgrading/deprecated_features","title":"Deprecated features and alternatives","description":"This is a preview version of the User Interface Extensibility Framework v2.0. We may have not identified all missing features and this list may not be comprehensive.","sidebar":"tutorialSidebar"},"Upgrading/index":{"id":"Upgrading/index","title":"Upgrading from previous versions","description":"Version 2.0 of the M-Files User Interface Extensibility Framework contains some significant differences to previous versions. Depending upon the functionality of the application it may require significant refactoring for an application to run in the new framework version. Some functionality may not be supported at all.","sidebar":"tutorialSidebar"}}}')}}]); \ No newline at end of file diff --git a/Frameworks/User-Interface-Extensibility-Framework/Reference/assets/js/935f2afb.6fcafb26.js b/Frameworks/User-Interface-Extensibility-Framework/Reference/assets/js/935f2afb.6fcafb26.js deleted file mode 100644 index f2f241b60..000000000 --- a/Frameworks/User-Interface-Extensibility-Framework/Reference/assets/js/935f2afb.6fcafb26.js +++ /dev/null @@ -1 +0,0 @@ -"use strict";(self.webpackChunkuix_2=self.webpackChunkuix_2||[]).push([[53],{1109:e=>{e.exports=JSON.parse('{"pluginId":"default","version":"current","label":"Next","banner":null,"badge":false,"noIndex":false,"className":"docs-version-current","isLast":true,"docsSidebars":{"tutorialSidebar":[{"type":"link","label":"Getting Started","href":"/Frameworks/User-Interface-Extensibility-Framework/Reference/","docId":"getting_started"},{"type":"category","label":"Overview","collapsible":true,"collapsed":true,"items":[{"type":"link","label":"Application Structure","href":"/Frameworks/User-Interface-Extensibility-Framework/Reference/Overview/ApplicationStructure","docId":"Overview/ApplicationStructure"},{"type":"link","label":"Modules","href":"/Frameworks/User-Interface-Extensibility-Framework/Reference/Overview/Modules","docId":"Overview/Modules"},{"type":"link","label":"Events","href":"/Frameworks/User-Interface-Extensibility-Framework/Reference/Overview/Events","docId":"Overview/Events"},{"type":"link","label":"Dashboards","href":"/Frameworks/User-Interface-Extensibility-Framework/Reference/Overview/Dashboards","docId":"Overview/Dashboards"},{"type":"link","label":"Dialogs and Messages","href":"/Frameworks/User-Interface-Extensibility-Framework/Reference/Overview/Messages","docId":"Overview/Messages"},{"type":"link","label":"Using Custom Commands","href":"/Frameworks/User-Interface-Extensibility-Framework/Reference/Overview/Commands","docId":"Overview/Commands"},{"type":"link","label":"Vault API Helpers","href":"/Frameworks/User-Interface-Extensibility-Framework/Reference/Overview/VaultMessages","docId":"Overview/VaultMessages"},{"type":"link","label":"Working with the Shell Listing","href":"/Frameworks/User-Interface-Extensibility-Framework/Reference/Overview/ListingView","docId":"Overview/ListingView"},{"type":"link","label":"Tabs","href":"/Frameworks/User-Interface-Extensibility-Framework/Reference/Overview/Tabs","docId":"Overview/Tabs"},{"type":"link","label":"Installing Applications","href":"/Frameworks/User-Interface-Extensibility-Framework/Reference/Overview/InstallingApplications","docId":"Overview/InstallingApplications"},{"type":"link","label":"Testing and Developing","href":"/Frameworks/User-Interface-Extensibility-Framework/Reference/Overview/Debugging","docId":"Overview/Debugging"},{"type":"link","label":"MFiles Global Object","href":"/Frameworks/User-Interface-Extensibility-Framework/Reference/Overview/MFilesGlobalObject","docId":"Overview/MFilesGlobalObject"},{"type":"link","label":"Exception Reference","href":"/Frameworks/User-Interface-Extensibility-Framework/Reference/Overview/exceptions","docId":"Overview/exceptions"}],"href":"/Frameworks/User-Interface-Extensibility-Framework/Reference/Overview/"},{"type":"category","label":"API Reference Guide","collapsible":true,"collapsed":true,"items":[{"type":"link","label":"Events","href":"/Frameworks/User-Interface-Extensibility-Framework/Reference/UIExt2/Events","docId":"UIExt2/Events"},{"type":"category","label":"Enums","collapsible":true,"collapsed":true,"items":[{"type":"link","label":"BuiltInIcon","href":"/Frameworks/User-Interface-Extensibility-Framework/Reference/UIExt2/Enums/BuiltInIcon/","docId":"UIExt2/Enums/BuiltInIcon/index"},{"type":"link","label":"BuiltinCommand","href":"/Frameworks/User-Interface-Extensibility-Framework/Reference/UIExt2/Enums/BuiltinCommand/","docId":"UIExt2/Enums/BuiltinCommand/index"},{"type":"link","label":"CommandLocation","href":"/Frameworks/User-Interface-Extensibility-Framework/Reference/UIExt2/Enums/CommandLocation/","docId":"UIExt2/Enums/CommandLocation/index"},{"type":"link","label":"CommandState","href":"/Frameworks/User-Interface-Extensibility-Framework/Reference/UIExt2/Enums/CommandState/","docId":"UIExt2/Enums/CommandState/index"},{"type":"link","label":"Event","href":"/Frameworks/User-Interface-Extensibility-Framework/Reference/UIExt2/Enums/Event/","docId":"UIExt2/Enums/Event/index"},{"type":"link","label":"FacetRangeType","href":"/Frameworks/User-Interface-Extensibility-Framework/Reference/UIExt2/Enums/FacetRangeType/","docId":"UIExt2/Enums/FacetRangeType/index"},{"type":"link","label":"FacetTransformation","href":"/Frameworks/User-Interface-Extensibility-Framework/Reference/UIExt2/Enums/FacetTransformation/","docId":"UIExt2/Enums/FacetTransformation/index"},{"type":"link","label":"FacetType","href":"/Frameworks/User-Interface-Extensibility-Framework/Reference/UIExt2/Enums/FacetType/","docId":"UIExt2/Enums/FacetType/index"},{"type":"link","label":"FacetValueType","href":"/Frameworks/User-Interface-Extensibility-Framework/Reference/UIExt2/Enums/FacetValueType/","docId":"UIExt2/Enums/FacetValueType/index"},{"type":"link","label":"IconContentType","href":"/Frameworks/User-Interface-Extensibility-Framework/Reference/UIExt2/Enums/IconContentType/","docId":"UIExt2/Enums/IconContentType/index"},{"type":"link","label":"MFBuiltInObjectType","href":"/Frameworks/User-Interface-Extensibility-Framework/Reference/UIExt2/Enums/MFBuiltInObjectType/","docId":"UIExt2/Enums/MFBuiltInObjectType/index"},{"type":"link","label":"MFBuiltInPropertyDef","href":"/Frameworks/User-Interface-Extensibility-Framework/Reference/UIExt2/Enums/MFBuiltInPropertyDef/","docId":"UIExt2/Enums/MFBuiltInPropertyDef/index"},{"type":"link","label":"MFBuiltInValueList","href":"/Frameworks/User-Interface-Extensibility-Framework/Reference/UIExt2/Enums/MFBuiltInValueList/","docId":"UIExt2/Enums/MFBuiltInValueList/index"},{"type":"link","label":"MFBuiltInView","href":"/Frameworks/User-Interface-Extensibility-Framework/Reference/UIExt2/Enums/MFBuiltInView/","docId":"UIExt2/Enums/MFBuiltInView/index"},{"type":"link","label":"MenuLocation","href":"/Frameworks/User-Interface-Extensibility-Framework/Reference/UIExt2/Enums/MenuLocation/","docId":"UIExt2/Enums/MenuLocation/index"},{"type":"link","label":"ObjectWindowResultCode","href":"/Frameworks/User-Interface-Extensibility-Framework/Reference/UIExt2/Enums/ObjectWindowResultCode/","docId":"UIExt2/Enums/ObjectWindowResultCode/index"},{"type":"link","label":"SearchEngine","href":"/Frameworks/User-Interface-Extensibility-Framework/Reference/UIExt2/Enums/SearchEngine/","docId":"UIExt2/Enums/SearchEngine/index"},{"type":"link","label":"ToastType","href":"/Frameworks/User-Interface-Extensibility-Framework/Reference/UIExt2/Enums/ToastType/","docId":"UIExt2/Enums/ToastType/index"}],"href":"/Frameworks/User-Interface-Extensibility-Framework/Reference/UIExt2/Enums/"},{"type":"category","label":"Interfaces","collapsible":true,"collapsed":true,"items":[{"type":"category","label":"ICommands","collapsible":true,"collapsed":true,"items":[{"type":"link","label":"AddCustomCommandToMenu","href":"/Frameworks/User-Interface-Extensibility-Framework/Reference/UIExt2/Interfaces/ICommands/AddCustomCommandToMenu/","docId":"UIExt2/Interfaces/ICommands/AddCustomCommandToMenu/index"},{"type":"link","label":"CreateCustomCommand","href":"/Frameworks/User-Interface-Extensibility-Framework/Reference/UIExt2/Interfaces/ICommands/CreateCustomCommand/","docId":"UIExt2/Interfaces/ICommands/CreateCustomCommand/index"},{"type":"link","label":"CreateSubMenuItem","href":"/Frameworks/User-Interface-Extensibility-Framework/Reference/UIExt2/Interfaces/ICommands/CreateSubMenuItem/","docId":"UIExt2/Interfaces/ICommands/CreateSubMenuItem/index"},{"type":"link","label":"CreateTaskbarGroup","href":"/Frameworks/User-Interface-Extensibility-Framework/Reference/UIExt2/Interfaces/ICommands/CreateTaskbarGroup/","docId":"UIExt2/Interfaces/ICommands/CreateTaskbarGroup/index"},{"type":"link","label":"DeleteCustomCommand","href":"/Frameworks/User-Interface-Extensibility-Framework/Reference/UIExt2/Interfaces/ICommands/DeleteCustomCommand/","docId":"UIExt2/Interfaces/ICommands/DeleteCustomCommand/index"},{"type":"link","label":"ExecuteCommand","href":"/Frameworks/User-Interface-Extensibility-Framework/Reference/UIExt2/Interfaces/ICommands/ExecuteCommand/","docId":"UIExt2/Interfaces/ICommands/ExecuteCommand/index"},{"type":"link","label":"GetCommandName","href":"/Frameworks/User-Interface-Extensibility-Framework/Reference/UIExt2/Interfaces/ICommands/GetCommandName/","docId":"UIExt2/Interfaces/ICommands/GetCommandName/index"},{"type":"link","label":"GetCommandState","href":"/Frameworks/User-Interface-Extensibility-Framework/Reference/UIExt2/Interfaces/ICommands/GetCommandState/","docId":"UIExt2/Interfaces/ICommands/GetCommandState/index"},{"type":"link","label":"GetMenuIdOfBuiltInCommand","href":"/Frameworks/User-Interface-Extensibility-Framework/Reference/UIExt2/Interfaces/ICommands/GetMenuIdOfBuiltInCommand/","docId":"UIExt2/Interfaces/ICommands/GetMenuIdOfBuiltInCommand/index"},{"type":"link","label":"RemoveCustomCommandFromMenu","href":"/Frameworks/User-Interface-Extensibility-Framework/Reference/UIExt2/Interfaces/ICommands/RemoveCustomCommandFromMenu/","docId":"UIExt2/Interfaces/ICommands/RemoveCustomCommandFromMenu/index"},{"type":"link","label":"RemoveMenuItem","href":"/Frameworks/User-Interface-Extensibility-Framework/Reference/UIExt2/Interfaces/ICommands/RemoveMenuItem/","docId":"UIExt2/Interfaces/ICommands/RemoveMenuItem/index"},{"type":"link","label":"RemoveTaskbarGroup","href":"/Frameworks/User-Interface-Extensibility-Framework/Reference/UIExt2/Interfaces/ICommands/RemoveTaskbarGroup/","docId":"UIExt2/Interfaces/ICommands/RemoveTaskbarGroup/index"},{"type":"link","label":"SetCommandState","href":"/Frameworks/User-Interface-Extensibility-Framework/Reference/UIExt2/Interfaces/ICommands/SetCommandState/","docId":"UIExt2/Interfaces/ICommands/SetCommandState/index"},{"type":"link","label":"SetIcon","href":"/Frameworks/User-Interface-Extensibility-Framework/Reference/UIExt2/Interfaces/ICommands/SetIcon/","docId":"UIExt2/Interfaces/ICommands/SetIcon/index"},{"type":"link","label":"SetMenuItemState","href":"/Frameworks/User-Interface-Extensibility-Framework/Reference/UIExt2/Interfaces/ICommands/SetMenuItemState/","docId":"UIExt2/Interfaces/ICommands/SetMenuItemState/index"},{"type":"link","label":"SetTaskbarGroupIcon","href":"/Frameworks/User-Interface-Extensibility-Framework/Reference/UIExt2/Interfaces/ICommands/SetTaskbarGroupIcon/","docId":"UIExt2/Interfaces/ICommands/SetTaskbarGroupIcon/index"}],"href":"/Frameworks/User-Interface-Extensibility-Framework/Reference/UIExt2/Interfaces/ICommands/"},{"type":"category","label":"ICommonFunctions","collapsible":true,"collapsed":true,"items":[{"type":"link","label":"DeleteFromWebStorage","href":"/Frameworks/User-Interface-Extensibility-Framework/Reference/UIExt2/Interfaces/ICommonFunctions/DeleteFromWebStorage/","docId":"UIExt2/Interfaces/ICommonFunctions/DeleteFromWebStorage/index"},{"type":"link","label":"DownloadFileAsDataUri","href":"/Frameworks/User-Interface-Extensibility-Framework/Reference/UIExt2/Interfaces/ICommonFunctions/DownloadFileAsDataUri/","docId":"UIExt2/Interfaces/ICommonFunctions/DownloadFileAsDataUri/index"},{"type":"link","label":"GetAccentColor","href":"/Frameworks/User-Interface-Extensibility-Framework/Reference/UIExt2/Interfaces/ICommonFunctions/GetAccentColor/","docId":"UIExt2/Interfaces/ICommonFunctions/GetAccentColor/index"},{"type":"link","label":"GetClientLanguage","href":"/Frameworks/User-Interface-Extensibility-Framework/Reference/UIExt2/Interfaces/ICommonFunctions/GetClientLanguage/","docId":"UIExt2/Interfaces/ICommonFunctions/GetClientLanguage/index"},{"type":"link","label":"GetClientLocale","href":"/Frameworks/User-Interface-Extensibility-Framework/Reference/UIExt2/Interfaces/ICommonFunctions/GetClientLocale/","docId":"UIExt2/Interfaces/ICommonFunctions/GetClientLocale/index"},{"type":"link","label":"GetClientLocaleIn3Letters","href":"/Frameworks/User-Interface-Extensibility-Framework/Reference/UIExt2/Interfaces/ICommonFunctions/GetClientLocaleIn3Letters/","docId":"UIExt2/Interfaces/ICommonFunctions/GetClientLocaleIn3Letters/index"},{"type":"link","label":"GetSessionInfo","href":"/Frameworks/User-Interface-Extensibility-Framework/Reference/UIExt2/Interfaces/ICommonFunctions/GetSessionInfo/","docId":"UIExt2/Interfaces/ICommonFunctions/GetSessionInfo/index"},{"type":"link","label":"GetUTCOffset","href":"/Frameworks/User-Interface-Extensibility-Framework/Reference/UIExt2/Interfaces/ICommonFunctions/GetUTCOffset/","docId":"UIExt2/Interfaces/ICommonFunctions/GetUTCOffset/index"},{"type":"link","label":"GetVaultInfo","href":"/Frameworks/User-Interface-Extensibility-Framework/Reference/UIExt2/Interfaces/ICommonFunctions/GetVaultInfo/","docId":"UIExt2/Interfaces/ICommonFunctions/GetVaultInfo/index"},{"type":"link","label":"GetWebLink","href":"/Frameworks/User-Interface-Extensibility-Framework/Reference/UIExt2/Interfaces/ICommonFunctions/GetWebLink/","docId":"UIExt2/Interfaces/ICommonFunctions/GetWebLink/index"},{"type":"link","label":"OpenExternalWebLink","href":"/Frameworks/User-Interface-Extensibility-Framework/Reference/UIExt2/Interfaces/ICommonFunctions/OpenExternalWebLink/","docId":"UIExt2/Interfaces/ICommonFunctions/OpenExternalWebLink/index"},{"type":"link","label":"ReadFromWebStorage","href":"/Frameworks/User-Interface-Extensibility-Framework/Reference/UIExt2/Interfaces/ICommonFunctions/ReadFromWebStorage/","docId":"UIExt2/Interfaces/ICommonFunctions/ReadFromWebStorage/index"},{"type":"link","label":"ReportException","href":"/Frameworks/User-Interface-Extensibility-Framework/Reference/UIExt2/Interfaces/ICommonFunctions/ReportException/","docId":"UIExt2/Interfaces/ICommonFunctions/ReportException/index"},{"type":"link","label":"ShowEditObjectWindow","href":"/Frameworks/User-Interface-Extensibility-Framework/Reference/UIExt2/Interfaces/ICommonFunctions/ShowEditObjectWindow/","docId":"UIExt2/Interfaces/ICommonFunctions/ShowEditObjectWindow/index"},{"type":"link","label":"ShowNewObjectWindow","href":"/Frameworks/User-Interface-Extensibility-Framework/Reference/UIExt2/Interfaces/ICommonFunctions/ShowNewObjectWindow/","docId":"UIExt2/Interfaces/ICommonFunctions/ShowNewObjectWindow/index"},{"type":"link","label":"ShowToast","href":"/Frameworks/User-Interface-Extensibility-Framework/Reference/UIExt2/Interfaces/ICommonFunctions/ShowToast/","docId":"UIExt2/Interfaces/ICommonFunctions/ShowToast/index"},{"type":"link","label":"UploadTemporaryFiles","href":"/Frameworks/User-Interface-Extensibility-Framework/Reference/UIExt2/Interfaces/ICommonFunctions/UploadTemporaryFiles/","docId":"UIExt2/Interfaces/ICommonFunctions/UploadTemporaryFiles/index"},{"type":"link","label":"WriteToWebStorage","href":"/Frameworks/User-Interface-Extensibility-Framework/Reference/UIExt2/Interfaces/ICommonFunctions/WriteToWebStorage/","docId":"UIExt2/Interfaces/ICommonFunctions/WriteToWebStorage/index"}],"href":"/Frameworks/User-Interface-Extensibility-Framework/Reference/UIExt2/Interfaces/ICommonFunctions/"},{"type":"category","label":"IDashboard","collapsible":true,"collapsed":true,"items":[{"type":"link","label":"GetSandboxAttributes","href":"/Frameworks/User-Interface-Extensibility-Framework/Reference/UIExt2/Interfaces/IDashboard/GetSandboxAttributes/","docId":"UIExt2/Interfaces/IDashboard/GetSandboxAttributes/index"},{"type":"link","label":"ShowMessage","href":"/Frameworks/User-Interface-Extensibility-Framework/Reference/UIExt2/Interfaces/IDashboard/ShowMessage/","docId":"UIExt2/Interfaces/IDashboard/ShowMessage/index"},{"type":"link","label":"ShowPopupDashboard","href":"/Frameworks/User-Interface-Extensibility-Framework/Reference/UIExt2/Interfaces/IDashboard/ShowPopupDashboard/","docId":"UIExt2/Interfaces/IDashboard/ShowPopupDashboard/index"},{"type":"link","label":"UpdateCustomData","href":"/Frameworks/User-Interface-Extensibility-Framework/Reference/UIExt2/Interfaces/IDashboard/UpdateCustomData/","docId":"UIExt2/Interfaces/IDashboard/UpdateCustomData/index"},{"type":"link","label":"WaitForClose","href":"/Frameworks/User-Interface-Extensibility-Framework/Reference/UIExt2/Interfaces/IDashboard/WaitForClose/","docId":"UIExt2/Interfaces/IDashboard/WaitForClose/index"}],"href":"/Frameworks/User-Interface-Extensibility-Framework/Reference/UIExt2/Interfaces/IDashboard/"},{"type":"category","label":"IEvents","collapsible":true,"collapsed":true,"items":[{"type":"link","label":"Register","href":"/Frameworks/User-Interface-Extensibility-Framework/Reference/UIExt2/Interfaces/IEvents/Register/","docId":"UIExt2/Interfaces/IEvents/Register/index"},{"type":"link","label":"RegisterBuiltinCommand","href":"/Frameworks/User-Interface-Extensibility-Framework/Reference/UIExt2/Interfaces/IEvents/RegisterBuiltinCommand/","docId":"UIExt2/Interfaces/IEvents/RegisterBuiltinCommand/index"},{"type":"link","label":"Unregister","href":"/Frameworks/User-Interface-Extensibility-Framework/Reference/UIExt2/Interfaces/IEvents/Unregister/","docId":"UIExt2/Interfaces/IEvents/Unregister/index"}],"href":"/Frameworks/User-Interface-Extensibility-Framework/Reference/UIExt2/Interfaces/IEvents/"},{"type":"category","label":"ISearchPane","collapsible":true,"collapsed":true,"items":[{"type":"link","label":"GetOptions","href":"/Frameworks/User-Interface-Extensibility-Framework/Reference/UIExt2/Interfaces/ISearchPane/GetOptions/","docId":"UIExt2/Interfaces/ISearchPane/GetOptions/index"},{"type":"link","label":"GetSearchCriteria","href":"/Frameworks/User-Interface-Extensibility-Framework/Reference/UIExt2/Interfaces/ISearchPane/GetSearchCriteria/","docId":"UIExt2/Interfaces/ISearchPane/GetSearchCriteria/index"},{"type":"link","label":"IsSearchView","href":"/Frameworks/User-Interface-Extensibility-Framework/Reference/UIExt2/Interfaces/ISearchPane/IsSearchView/","docId":"UIExt2/Interfaces/ISearchPane/IsSearchView/index"},{"type":"link","label":"SetOptionState","href":"/Frameworks/User-Interface-Extensibility-Framework/Reference/UIExt2/Interfaces/ISearchPane/SetOptionState/","docId":"UIExt2/Interfaces/ISearchPane/SetOptionState/index"},{"type":"link","label":"SetSearchCriteria","href":"/Frameworks/User-Interface-Extensibility-Framework/Reference/UIExt2/Interfaces/ISearchPane/SetSearchCriteria/","docId":"UIExt2/Interfaces/ISearchPane/SetSearchCriteria/index"}],"href":"/Frameworks/User-Interface-Extensibility-Framework/Reference/UIExt2/Interfaces/ISearchPane/"},{"type":"category","label":"IShellFrame","collapsible":true,"collapsed":true,"items":[{"type":"link","label":"GetSandboxAttributes","href":"/Frameworks/User-Interface-Extensibility-Framework/Reference/UIExt2/Interfaces/IShellFrame/GetSandboxAttributes/","docId":"UIExt2/Interfaces/IShellFrame/GetSandboxAttributes/index"},{"type":"link","label":"GetViewsById","href":"/Frameworks/User-Interface-Extensibility-Framework/Reference/UIExt2/Interfaces/IShellFrame/GetViewsById/","docId":"UIExt2/Interfaces/IShellFrame/GetViewsById/index"},{"type":"link","label":"IsFolderLocation","href":"/Frameworks/User-Interface-Extensibility-Framework/Reference/UIExt2/Interfaces/IShellFrame/IsFolderLocation/","docId":"UIExt2/Interfaces/IShellFrame/IsFolderLocation/index"},{"type":"link","label":"IsObjectLocation","href":"/Frameworks/User-Interface-Extensibility-Framework/Reference/UIExt2/Interfaces/IShellFrame/IsObjectLocation/","docId":"UIExt2/Interfaces/IShellFrame/IsObjectLocation/index"},{"type":"link","label":"NavigateToFolder","href":"/Frameworks/User-Interface-Extensibility-Framework/Reference/UIExt2/Interfaces/IShellFrame/NavigateToFolder/","docId":"UIExt2/Interfaces/IShellFrame/NavigateToFolder/index"},{"type":"link","label":"NavigateToObject","href":"/Frameworks/User-Interface-Extensibility-Framework/Reference/UIExt2/Interfaces/IShellFrame/NavigateToObject/","docId":"UIExt2/Interfaces/IShellFrame/NavigateToObject/index"},{"type":"link","label":"NavigateToParent","href":"/Frameworks/User-Interface-Extensibility-Framework/Reference/UIExt2/Interfaces/IShellFrame/NavigateToParent/","docId":"UIExt2/Interfaces/IShellFrame/NavigateToParent/index"},{"type":"link","label":"ShowDashboard","href":"/Frameworks/User-Interface-Extensibility-Framework/Reference/UIExt2/Interfaces/IShellFrame/ShowDashboard/","docId":"UIExt2/Interfaces/IShellFrame/ShowDashboard/index"},{"type":"link","label":"ShowDefaultContent","href":"/Frameworks/User-Interface-Extensibility-Framework/Reference/UIExt2/Interfaces/IShellFrame/ShowDefaultContent/","docId":"UIExt2/Interfaces/IShellFrame/ShowDefaultContent/index"},{"type":"link","label":"ShowMessage","href":"/Frameworks/User-Interface-Extensibility-Framework/Reference/UIExt2/Interfaces/IShellFrame/ShowMessage/","docId":"UIExt2/Interfaces/IShellFrame/ShowMessage/index"},{"type":"link","label":"ShowPopupDashboard","href":"/Frameworks/User-Interface-Extensibility-Framework/Reference/UIExt2/Interfaces/IShellFrame/ShowPopupDashboard/","docId":"UIExt2/Interfaces/IShellFrame/ShowPopupDashboard/index"},{"type":"link","label":"ShowPopupDashboards","href":"/Frameworks/User-Interface-Extensibility-Framework/Reference/UIExt2/Interfaces/IShellFrame/ShowPopupDashboards/","docId":"UIExt2/Interfaces/IShellFrame/ShowPopupDashboards/index"}],"href":"/Frameworks/User-Interface-Extensibility-Framework/Reference/UIExt2/Interfaces/IShellFrame/"},{"type":"category","label":"IShellItems","collapsible":true,"collapsed":true,"items":[{"type":"link","label":"GetFoldersCount","href":"/Frameworks/User-Interface-Extensibility-Framework/Reference/UIExt2/Interfaces/IShellItems/GetFoldersCount/","docId":"UIExt2/Interfaces/IShellItems/GetFoldersCount/index"},{"type":"link","label":"GetObjectVersionsAndProperties","href":"/Frameworks/User-Interface-Extensibility-Framework/Reference/UIExt2/Interfaces/IShellItems/GetObjectVersionsAndProperties/","docId":"UIExt2/Interfaces/IShellItems/GetObjectVersionsAndProperties/index"},{"type":"link","label":"GetObjectVersionsCount","href":"/Frameworks/User-Interface-Extensibility-Framework/Reference/UIExt2/Interfaces/IShellItems/GetObjectVersionsCount/","docId":"UIExt2/Interfaces/IShellItems/GetObjectVersionsCount/index"}],"href":"/Frameworks/User-Interface-Extensibility-Framework/Reference/UIExt2/Interfaces/IShellItems/"},{"type":"category","label":"IShellListing","collapsible":true,"collapsed":true,"items":[{"type":"link","label":"ActivateListing","href":"/Frameworks/User-Interface-Extensibility-Framework/Reference/UIExt2/Interfaces/IShellListing/ActivateListing/","docId":"UIExt2/Interfaces/IShellListing/ActivateListing/index"},{"type":"link","label":"ActivateSelected","href":"/Frameworks/User-Interface-Extensibility-Framework/Reference/UIExt2/Interfaces/IShellListing/ActivateSelected/","docId":"UIExt2/Interfaces/IShellListing/ActivateSelected/index"},{"type":"link","label":"AddListingItem","href":"/Frameworks/User-Interface-Extensibility-Framework/Reference/UIExt2/Interfaces/IShellListing/AddListingItem/","docId":"UIExt2/Interfaces/IShellListing/AddListingItem/index"},{"type":"link","label":"AddObjectFile","href":"/Frameworks/User-Interface-Extensibility-Framework/Reference/UIExt2/Interfaces/IShellListing/AddObjectFile/","docId":"UIExt2/Interfaces/IShellListing/AddObjectFile/index"},{"type":"link","label":"GetFolderName","href":"/Frameworks/User-Interface-Extensibility-Framework/Reference/UIExt2/Interfaces/IShellListing/GetFolderName/","docId":"UIExt2/Interfaces/IShellListing/GetFolderName/index"},{"type":"link","label":"RefreshListing","href":"/Frameworks/User-Interface-Extensibility-Framework/Reference/UIExt2/Interfaces/IShellListing/RefreshListing/","docId":"UIExt2/Interfaces/IShellListing/RefreshListing/index"},{"type":"link","label":"RefreshObject","href":"/Frameworks/User-Interface-Extensibility-Framework/Reference/UIExt2/Interfaces/IShellListing/RefreshObject/","docId":"UIExt2/Interfaces/IShellListing/RefreshObject/index"},{"type":"link","label":"RemoveListingItem","href":"/Frameworks/User-Interface-Extensibility-Framework/Reference/UIExt2/Interfaces/IShellListing/RemoveListingItem/","docId":"UIExt2/Interfaces/IShellListing/RemoveListingItem/index"},{"type":"link","label":"ReplaceFile","href":"/Frameworks/User-Interface-Extensibility-Framework/Reference/UIExt2/Interfaces/IShellListing/ReplaceFile/","docId":"UIExt2/Interfaces/IShellListing/ReplaceFile/index"},{"type":"link","label":"SelectFolder","href":"/Frameworks/User-Interface-Extensibility-Framework/Reference/UIExt2/Interfaces/IShellListing/SelectFolder/","docId":"UIExt2/Interfaces/IShellListing/SelectFolder/index"},{"type":"link","label":"SelectNextFolder","href":"/Frameworks/User-Interface-Extensibility-Framework/Reference/UIExt2/Interfaces/IShellListing/SelectNextFolder/","docId":"UIExt2/Interfaces/IShellListing/SelectNextFolder/index"},{"type":"link","label":"SelectNextObject","href":"/Frameworks/User-Interface-Extensibility-Framework/Reference/UIExt2/Interfaces/IShellListing/SelectNextObject/","docId":"UIExt2/Interfaces/IShellListing/SelectNextObject/index"},{"type":"link","label":"SelectNextObjectFile","href":"/Frameworks/User-Interface-Extensibility-Framework/Reference/UIExt2/Interfaces/IShellListing/SelectNextObjectFile/","docId":"UIExt2/Interfaces/IShellListing/SelectNextObjectFile/index"},{"type":"link","label":"SelectObjectFile","href":"/Frameworks/User-Interface-Extensibility-Framework/Reference/UIExt2/Interfaces/IShellListing/SelectObjectFile/","docId":"UIExt2/Interfaces/IShellListing/SelectObjectFile/index"},{"type":"link","label":"SelectObjectOrObjectFileVersion","href":"/Frameworks/User-Interface-Extensibility-Framework/Reference/UIExt2/Interfaces/IShellListing/SelectObjectOrObjectFileVersion/","docId":"UIExt2/Interfaces/IShellListing/SelectObjectOrObjectFileVersion/index"},{"type":"link","label":"SelectObjectVersion","href":"/Frameworks/User-Interface-Extensibility-Framework/Reference/UIExt2/Interfaces/IShellListing/SelectObjectVersion/","docId":"UIExt2/Interfaces/IShellListing/SelectObjectVersion/index"},{"type":"link","label":"SelectPrevFolder","href":"/Frameworks/User-Interface-Extensibility-Framework/Reference/UIExt2/Interfaces/IShellListing/SelectPrevFolder/","docId":"UIExt2/Interfaces/IShellListing/SelectPrevFolder/index"},{"type":"link","label":"SelectPrevObject","href":"/Frameworks/User-Interface-Extensibility-Framework/Reference/UIExt2/Interfaces/IShellListing/SelectPrevObject/","docId":"UIExt2/Interfaces/IShellListing/SelectPrevObject/index"},{"type":"link","label":"SelectPrevObjectFile","href":"/Frameworks/User-Interface-Extensibility-Framework/Reference/UIExt2/Interfaces/IShellListing/SelectPrevObjectFile/","docId":"UIExt2/Interfaces/IShellListing/SelectPrevObjectFile/index"},{"type":"link","label":"SetFolderOrObjectVersionSelectionStates","href":"/Frameworks/User-Interface-Extensibility-Framework/Reference/UIExt2/Interfaces/IShellListing/SetFolderOrObjectVersionSelectionStates/","docId":"UIExt2/Interfaces/IShellListing/SetFolderOrObjectVersionSelectionStates/index"},{"type":"link","label":"SetFolderSelectionStates","href":"/Frameworks/User-Interface-Extensibility-Framework/Reference/UIExt2/Interfaces/IShellListing/SetFolderSelectionStates/","docId":"UIExt2/Interfaces/IShellListing/SetFolderSelectionStates/index"},{"type":"link","label":"SetObjectOrObjectFileVersionSelectionStates","href":"/Frameworks/User-Interface-Extensibility-Framework/Reference/UIExt2/Interfaces/IShellListing/SetObjectOrObjectFileVersionSelectionStates/","docId":"UIExt2/Interfaces/IShellListing/SetObjectOrObjectFileVersionSelectionStates/index"},{"type":"link","label":"SetObjectVersionSelectionStates","href":"/Frameworks/User-Interface-Extensibility-Framework/Reference/UIExt2/Interfaces/IShellListing/SetObjectVersionSelectionStates/","docId":"UIExt2/Interfaces/IShellListing/SetObjectVersionSelectionStates/index"},{"type":"link","label":"SetVirtualSelection","href":"/Frameworks/User-Interface-Extensibility-Framework/Reference/UIExt2/Interfaces/IShellListing/SetVirtualSelection/","docId":"UIExt2/Interfaces/IShellListing/SetVirtualSelection/index"},{"type":"link","label":"UnselectAll","href":"/Frameworks/User-Interface-Extensibility-Framework/Reference/UIExt2/Interfaces/IShellListing/UnselectAll/","docId":"UIExt2/Interfaces/IShellListing/UnselectAll/index"},{"type":"link","label":"UpdateListingItem","href":"/Frameworks/User-Interface-Extensibility-Framework/Reference/UIExt2/Interfaces/IShellListing/UpdateListingItem/","docId":"UIExt2/Interfaces/IShellListing/UpdateListingItem/index"}],"href":"/Frameworks/User-Interface-Extensibility-Framework/Reference/UIExt2/Interfaces/IShellListing/"},{"type":"category","label":"IShellPaneContainer","collapsible":true,"collapsed":true,"items":[{"type":"link","label":"AddTab","href":"/Frameworks/User-Interface-Extensibility-Framework/Reference/UIExt2/Interfaces/IShellPaneContainer/AddTab/","docId":"UIExt2/Interfaces/IShellPaneContainer/AddTab/index"},{"type":"link","label":"GetSelectedTabs","href":"/Frameworks/User-Interface-Extensibility-Framework/Reference/UIExt2/Interfaces/IShellPaneContainer/GetSelectedTabs/","docId":"UIExt2/Interfaces/IShellPaneContainer/GetSelectedTabs/index"},{"type":"link","label":"GetTab","href":"/Frameworks/User-Interface-Extensibility-Framework/Reference/UIExt2/Interfaces/IShellPaneContainer/GetTab/","docId":"UIExt2/Interfaces/IShellPaneContainer/GetTab/index"}],"href":"/Frameworks/User-Interface-Extensibility-Framework/Reference/UIExt2/Interfaces/IShellPaneContainer/"},{"type":"category","label":"IShellPaneTab","collapsible":true,"collapsed":true,"items":[{"type":"link","label":"Remove","href":"/Frameworks/User-Interface-Extensibility-Framework/Reference/UIExt2/Interfaces/IShellPaneTab/Remove/","docId":"UIExt2/Interfaces/IShellPaneTab/Remove/index"},{"type":"link","label":"Select","href":"/Frameworks/User-Interface-Extensibility-Framework/Reference/UIExt2/Interfaces/IShellPaneTab/Select/","docId":"UIExt2/Interfaces/IShellPaneTab/Select/index"},{"type":"link","label":"SetVisible","href":"/Frameworks/User-Interface-Extensibility-Framework/Reference/UIExt2/Interfaces/IShellPaneTab/SetVisible/","docId":"UIExt2/Interfaces/IShellPaneTab/SetVisible/index"},{"type":"link","label":"ShowDashboard","href":"/Frameworks/User-Interface-Extensibility-Framework/Reference/UIExt2/Interfaces/IShellPaneTab/ShowDashboard/","docId":"UIExt2/Interfaces/IShellPaneTab/ShowDashboard/index"},{"type":"link","label":"ShowEmptyContent","href":"/Frameworks/User-Interface-Extensibility-Framework/Reference/UIExt2/Interfaces/IShellPaneTab/ShowEmptyContent/","docId":"UIExt2/Interfaces/IShellPaneTab/ShowEmptyContent/index"},{"type":"link","label":"Unselect","href":"/Frameworks/User-Interface-Extensibility-Framework/Reference/UIExt2/Interfaces/IShellPaneTab/Unselect/","docId":"UIExt2/Interfaces/IShellPaneTab/Unselect/index"}],"href":"/Frameworks/User-Interface-Extensibility-Framework/Reference/UIExt2/Interfaces/IShellPaneTab/"},{"type":"category","label":"IShellUI","collapsible":true,"collapsed":true,"items":[{"type":"link","label":"BroadcastMessage","href":"/Frameworks/User-Interface-Extensibility-Framework/Reference/UIExt2/Interfaces/IShellUI/BroadcastMessage/","docId":"UIExt2/Interfaces/IShellUI/BroadcastMessage/index"},{"type":"link","label":"GetFileTypeIconURL","href":"/Frameworks/User-Interface-Extensibility-Framework/Reference/UIExt2/Interfaces/IShellUI/GetFileTypeIconURL/","docId":"UIExt2/Interfaces/IShellUI/GetFileTypeIconURL/index"},{"type":"link","label":"GetObjectTypeIconURL","href":"/Frameworks/User-Interface-Extensibility-Framework/Reference/UIExt2/Interfaces/IShellUI/GetObjectTypeIconURL/","docId":"UIExt2/Interfaces/IShellUI/GetObjectTypeIconURL/index"},{"type":"link","label":"GetValueListItemIconURL","href":"/Frameworks/User-Interface-Extensibility-Framework/Reference/UIExt2/Interfaces/IShellUI/GetValueListItemIconURL/","docId":"UIExt2/Interfaces/IShellUI/GetValueListItemIconURL/index"},{"type":"link","label":"NotifyApplication","href":"/Frameworks/User-Interface-Extensibility-Framework/Reference/UIExt2/Interfaces/IShellUI/NotifyApplication/","docId":"UIExt2/Interfaces/IShellUI/NotifyApplication/index"},{"type":"link","label":"ShowMessage","href":"/Frameworks/User-Interface-Extensibility-Framework/Reference/UIExt2/Interfaces/IShellUI/ShowMessage/","docId":"UIExt2/Interfaces/IShellUI/ShowMessage/index"},{"type":"link","label":"ShowPopupDashboard","href":"/Frameworks/User-Interface-Extensibility-Framework/Reference/UIExt2/Interfaces/IShellUI/ShowPopupDashboard/","docId":"UIExt2/Interfaces/IShellUI/ShowPopupDashboard/index"}],"href":"/Frameworks/User-Interface-Extensibility-Framework/Reference/UIExt2/Interfaces/IShellUI/"},{"type":"category","label":"IWindow","collapsible":true,"collapsed":true,"items":[{"type":"link","label":"Close","href":"/Frameworks/User-Interface-Extensibility-Framework/Reference/UIExt2/Interfaces/IWindow/Close/","docId":"UIExt2/Interfaces/IWindow/Close/index"},{"type":"link","label":"ResizeToDefaultSize","href":"/Frameworks/User-Interface-Extensibility-Framework/Reference/UIExt2/Interfaces/IWindow/ResizeToDefaultSize/","docId":"UIExt2/Interfaces/IWindow/ResizeToDefaultSize/index"},{"type":"link","label":"SetCloseIconVisibility","href":"/Frameworks/User-Interface-Extensibility-Framework/Reference/UIExt2/Interfaces/IWindow/SetCloseIconVisibility/","docId":"UIExt2/Interfaces/IWindow/SetCloseIconVisibility/index"},{"type":"link","label":"SetDefaultSize","href":"/Frameworks/User-Interface-Extensibility-Framework/Reference/UIExt2/Interfaces/IWindow/SetDefaultSize/","docId":"UIExt2/Interfaces/IWindow/SetDefaultSize/index"},{"type":"link","label":"SetSize","href":"/Frameworks/User-Interface-Extensibility-Framework/Reference/UIExt2/Interfaces/IWindow/SetSize/","docId":"UIExt2/Interfaces/IWindow/SetSize/index"},{"type":"link","label":"SetTitle","href":"/Frameworks/User-Interface-Extensibility-Framework/Reference/UIExt2/Interfaces/IWindow/SetTitle/","docId":"UIExt2/Interfaces/IWindow/SetTitle/index"}],"href":"/Frameworks/User-Interface-Extensibility-Framework/Reference/UIExt2/Interfaces/IWindow/"},{"type":"link","label":"TListingActionArgs","href":"/Frameworks/User-Interface-Extensibility-Framework/Reference/UIExt2/Interfaces/TListingActionArgs/","docId":"UIExt2/Interfaces/TListingActionArgs/index"}],"href":"/Frameworks/User-Interface-Extensibility-Framework/Reference/UIExt2/Interfaces/"},{"type":"category","label":"Models","collapsible":true,"collapsed":true,"items":[{"type":"link","label":"DashboardConfig","href":"/Frameworks/User-Interface-Extensibility-Framework/Reference/UIExt2/Models/DashboardConfig/","docId":"UIExt2/Models/DashboardConfig/index"},{"type":"link","label":"DialogUIParams","href":"/Frameworks/User-Interface-Extensibility-Framework/Reference/UIExt2/Models/DialogUIParams/","docId":"UIExt2/Models/DialogUIParams/index"},{"type":"link","label":"Facet","href":"/Frameworks/User-Interface-Extensibility-Framework/Reference/UIExt2/Models/Facet/","docId":"UIExt2/Models/Facet/index"},{"type":"link","label":"FacetDefinition","href":"/Frameworks/User-Interface-Extensibility-Framework/Reference/UIExt2/Models/FacetDefinition/","docId":"UIExt2/Models/FacetDefinition/index"},{"type":"link","label":"FacetLookupValue","href":"/Frameworks/User-Interface-Extensibility-Framework/Reference/UIExt2/Models/FacetLookupValue/","docId":"UIExt2/Models/FacetLookupValue/index"},{"type":"link","label":"FacetNumericRangeValue","href":"/Frameworks/User-Interface-Extensibility-Framework/Reference/UIExt2/Models/FacetNumericRangeValue/","docId":"UIExt2/Models/FacetNumericRangeValue/index"},{"type":"link","label":"FacetNumericValue","href":"/Frameworks/User-Interface-Extensibility-Framework/Reference/UIExt2/Models/FacetNumericValue/","docId":"UIExt2/Models/FacetNumericValue/index"},{"type":"link","label":"FacetStringValue","href":"/Frameworks/User-Interface-Extensibility-Framework/Reference/UIExt2/Models/FacetStringValue/","docId":"UIExt2/Models/FacetStringValue/index"},{"type":"link","label":"FacetValue","href":"/Frameworks/User-Interface-Extensibility-Framework/Reference/UIExt2/Models/FacetValue/","docId":"UIExt2/Models/FacetValue/index"},{"type":"link","label":"FtsScope","href":"/Frameworks/User-Interface-Extensibility-Framework/Reference/UIExt2/Models/FtsScope/","docId":"UIExt2/Models/FtsScope/index"},{"type":"link","label":"IIconInformation","href":"/Frameworks/User-Interface-Extensibility-Framework/Reference/UIExt2/Models/IIconInformation/","docId":"UIExt2/Models/IIconInformation/index"},{"type":"link","label":"INonSensitiveVaultData","href":"/Frameworks/User-Interface-Extensibility-Framework/Reference/UIExt2/Models/INonSensitiveVaultData/","docId":"UIExt2/Models/INonSensitiveVaultData/index"},{"type":"link","label":"ISelectedFile","href":"/Frameworks/User-Interface-Extensibility-Framework/Reference/UIExt2/Models/ISelectedFile/","docId":"UIExt2/Models/ISelectedFile/index"},{"type":"link","label":"IVaultInfo","href":"/Frameworks/User-Interface-Extensibility-Framework/Reference/UIExt2/Models/IVaultInfo/","docId":"UIExt2/Models/IVaultInfo/index"},{"type":"link","label":"IVaultInfoReturnValue","href":"/Frameworks/User-Interface-Extensibility-Framework/Reference/UIExt2/Models/IVaultInfoReturnValue/","docId":"UIExt2/Models/IVaultInfoReturnValue/index"},{"type":"link","label":"LookupValue","href":"/Frameworks/User-Interface-Extensibility-Framework/Reference/UIExt2/Models/LookupValue/","docId":"UIExt2/Models/LookupValue/index"},{"type":"link","label":"MFError","href":"/Frameworks/User-Interface-Extensibility-Framework/Reference/UIExt2/Models/MFError/","docId":"UIExt2/Models/MFError/index"},{"type":"link","label":"MultiDashboardUIParams","href":"/Frameworks/User-Interface-Extensibility-Framework/Reference/UIExt2/Models/MultiDashboardUIParams/","docId":"UIExt2/Models/MultiDashboardUIParams/index"},{"type":"link","label":"NonSensitiveSessionData","href":"/Frameworks/User-Interface-Extensibility-Framework/Reference/UIExt2/Models/NonSensitiveSessionData/","docId":"UIExt2/Models/NonSensitiveSessionData/index"},{"type":"link","label":"NumericRangeValue","href":"/Frameworks/User-Interface-Extensibility-Framework/Reference/UIExt2/Models/NumericRangeValue/","docId":"UIExt2/Models/NumericRangeValue/index"},{"type":"link","label":"NumericValue","href":"/Frameworks/User-Interface-Extensibility-Framework/Reference/UIExt2/Models/NumericValue/","docId":"UIExt2/Models/NumericValue/index"},{"type":"link","label":"ObjectCreationInfo","href":"/Frameworks/User-Interface-Extensibility-Framework/Reference/UIExt2/Models/ObjectCreationInfo/","docId":"UIExt2/Models/ObjectCreationInfo/index"},{"type":"link","label":"ObjectFile","href":"/Frameworks/User-Interface-Extensibility-Framework/Reference/UIExt2/Models/ObjectFile/","docId":"UIExt2/Models/ObjectFile/index"},{"type":"link","label":"ObjectFileVersionArgumentValue","href":"/Frameworks/User-Interface-Extensibility-Framework/Reference/UIExt2/Models/ObjectFileVersionArgumentValue/","docId":"UIExt2/Models/ObjectFileVersionArgumentValue/index"},{"type":"link","label":"ObjectFileVersionParams","href":"/Frameworks/User-Interface-Extensibility-Framework/Reference/UIExt2/Models/ObjectFileVersionParams/","docId":"UIExt2/Models/ObjectFileVersionParams/index"},{"type":"link","label":"ObjectWindowResult","href":"/Frameworks/User-Interface-Extensibility-Framework/Reference/UIExt2/Models/ObjectWindowResult/","docId":"UIExt2/Models/ObjectWindowResult/index"},{"type":"link","label":"SearchCriteria","href":"/Frameworks/User-Interface-Extensibility-Framework/Reference/UIExt2/Models/SearchCriteria/","docId":"UIExt2/Models/SearchCriteria/index"},{"type":"link","label":"ShellFrameFolders","href":"/Frameworks/User-Interface-Extensibility-Framework/Reference/UIExt2/Models/ShellFrameFolders/","docId":"UIExt2/Models/ShellFrameFolders/index"},{"type":"link","label":"ShowMessageArgumentValue","href":"/Frameworks/User-Interface-Extensibility-Framework/Reference/UIExt2/Models/ShowMessageArgumentValue/","docId":"UIExt2/Models/ShowMessageArgumentValue/index"},{"type":"link","label":"ShowMessageParams","href":"/Frameworks/User-Interface-Extensibility-Framework/Reference/UIExt2/Models/ShowMessageParams/","docId":"UIExt2/Models/ShowMessageParams/index"},{"type":"link","label":"ShowMessageReturnValue","href":"/Frameworks/User-Interface-Extensibility-Framework/Reference/UIExt2/Models/ShowMessageReturnValue/","docId":"UIExt2/Models/ShowMessageReturnValue/index"},{"type":"link","label":"StringValue","href":"/Frameworks/User-Interface-Extensibility-Framework/Reference/UIExt2/Models/StringValue/","docId":"UIExt2/Models/StringValue/index"},{"type":"link","label":"VaultInfoReturnValue","href":"/Frameworks/User-Interface-Extensibility-Framework/Reference/UIExt2/Models/VaultInfoReturnValue/","docId":"UIExt2/Models/VaultInfoReturnValue/index"}],"href":"/Frameworks/User-Interface-Extensibility-Framework/Reference/UIExt2/Models/"}],"href":"/Frameworks/User-Interface-Extensibility-Framework/Reference/UIExt2/"},{"type":"category","label":"Vault API Reference Guide","collapsible":true,"collapsed":true,"items":[{"type":"category","label":"Enums","collapsible":true,"collapsed":true,"items":[{"type":"link","label":"ACLEnforcingMode","href":"/Frameworks/User-Interface-Extensibility-Framework/Reference/gRPC/Enums/ACLEnforcingMode/","docId":"gRPC/Enums/ACLEnforcingMode/index"},{"type":"link","label":"AccessControlSubjectType","href":"/Frameworks/User-Interface-Extensibility-Framework/Reference/gRPC/Enums/AccessControlSubjectType/","docId":"gRPC/Enums/AccessControlSubjectType/index"},{"type":"link","label":"AuthType","href":"/Frameworks/User-Interface-Extensibility-Framework/Reference/gRPC/Enums/AuthType/","docId":"gRPC/Enums/AuthType/index"},{"type":"link","label":"AutomaticValueType","href":"/Frameworks/User-Interface-Extensibility-Framework/Reference/gRPC/Enums/AutomaticValueType/","docId":"gRPC/Enums/AutomaticValueType/index"},{"type":"link","label":"CallImportance","href":"/Frameworks/User-Interface-Extensibility-Framework/Reference/gRPC/Enums/CallImportance/","docId":"gRPC/Enums/CallImportance/index"},{"type":"link","label":"ConditionType","href":"/Frameworks/User-Interface-Extensibility-Framework/Reference/gRPC/Enums/ConditionType/","docId":"gRPC/Enums/ConditionType/index"},{"type":"link","label":"ContentType","href":"/Frameworks/User-Interface-Extensibility-Framework/Reference/gRPC/Enums/ContentType/","docId":"gRPC/Enums/ContentType/index"},{"type":"link","label":"DataFunction","href":"/Frameworks/User-Interface-Extensibility-Framework/Reference/gRPC/Enums/DataFunction/","docId":"gRPC/Enums/DataFunction/index"},{"type":"link","label":"Datatype","href":"/Frameworks/User-Interface-Extensibility-Framework/Reference/gRPC/Enums/Datatype/","docId":"gRPC/Enums/Datatype/index"},{"type":"link","label":"EventType","href":"/Frameworks/User-Interface-Extensibility-Framework/Reference/gRPC/Enums/EventType/","docId":"gRPC/Enums/EventType/index"},{"type":"link","label":"ExpressionType","href":"/Frameworks/User-Interface-Extensibility-Framework/Reference/gRPC/Enums/ExpressionType/","docId":"gRPC/Enums/ExpressionType/index"},{"type":"link","label":"ExtDBRefreshType","href":"/Frameworks/User-Interface-Extensibility-Framework/Reference/gRPC/Enums/ExtDBRefreshType/","docId":"gRPC/Enums/ExtDBRefreshType/index"},{"type":"link","label":"ExtIDStatus","href":"/Frameworks/User-Interface-Extensibility-Framework/Reference/gRPC/Enums/ExtIDStatus/","docId":"gRPC/Enums/ExtIDStatus/index"},{"type":"link","label":"FileIDType","href":"/Frameworks/User-Interface-Extensibility-Framework/Reference/gRPC/Enums/FileIDType/","docId":"gRPC/Enums/FileIDType/index"},{"type":"link","label":"FileSizePrecision","href":"/Frameworks/User-Interface-Extensibility-Framework/Reference/gRPC/Enums/FileSizePrecision/","docId":"gRPC/Enums/FileSizePrecision/index"},{"type":"link","label":"FileValueType","href":"/Frameworks/User-Interface-Extensibility-Framework/Reference/gRPC/Enums/FileValueType/","docId":"gRPC/Enums/FileValueType/index"},{"type":"link","label":"FileVerType","href":"/Frameworks/User-Interface-Extensibility-Framework/Reference/gRPC/Enums/FileVerType/","docId":"gRPC/Enums/FileVerType/index"},{"type":"link","label":"FolderListingAlgorithm","href":"/Frameworks/User-Interface-Extensibility-Framework/Reference/gRPC/Enums/FolderListingAlgorithm/","docId":"gRPC/Enums/FolderListingAlgorithm/index"},{"type":"link","label":"FolderType","href":"/Frameworks/User-Interface-Extensibility-Framework/Reference/gRPC/Enums/FolderType/","docId":"gRPC/Enums/FolderType/index"},{"type":"link","label":"FormattingType","href":"/Frameworks/User-Interface-Extensibility-Framework/Reference/gRPC/Enums/FormattingType/","docId":"gRPC/Enums/FormattingType/index"},{"type":"link","label":"IndirectPropertyIDLevelType","href":"/Frameworks/User-Interface-Extensibility-Framework/Reference/gRPC/Enums/IndirectPropertyIDLevelType/","docId":"gRPC/Enums/IndirectPropertyIDLevelType/index"},{"type":"link","label":"MetadataStructureItem","href":"/Frameworks/User-Interface-Extensibility-Framework/Reference/gRPC/Enums/MetadataStructureItem/","docId":"gRPC/Enums/MetadataStructureItem/index"},{"type":"link","label":"NACLType","href":"/Frameworks/User-Interface-Extensibility-Framework/Reference/gRPC/Enums/NACLType/","docId":"gRPC/Enums/NACLType/index"},{"type":"link","label":"NamedValueType","href":"/Frameworks/User-Interface-Extensibility-Framework/Reference/gRPC/Enums/NamedValueType/","docId":"gRPC/Enums/NamedValueType/index"},{"type":"link","label":"ObjFileSourceType","href":"/Frameworks/User-Interface-Extensibility-Framework/Reference/gRPC/Enums/ObjFileSourceType/","docId":"gRPC/Enums/ObjFileSourceType/index"},{"type":"link","label":"ObjVerVersionType","href":"/Frameworks/User-Interface-Extensibility-Framework/Reference/gRPC/Enums/ObjVerVersionType/","docId":"gRPC/Enums/ObjVerVersionType/index"},{"type":"link","label":"ObjectVersionDataRequestErrorTolerance","href":"/Frameworks/User-Interface-Extensibility-Framework/Reference/gRPC/Enums/ObjectVersionDataRequestErrorTolerance/","docId":"gRPC/Enums/ObjectVersionDataRequestErrorTolerance/index"},{"type":"link","label":"ObjectVersionDataRequestIdentityType","href":"/Frameworks/User-Interface-Extensibility-Framework/Reference/gRPC/Enums/ObjectVersionDataRequestIdentityType/","docId":"gRPC/Enums/ObjectVersionDataRequestIdentityType/index"},{"type":"link","label":"ObjectVersionDataRequestVersionType","href":"/Frameworks/User-Interface-Extensibility-Framework/Reference/gRPC/Enums/ObjectVersionDataRequestVersionType/","docId":"gRPC/Enums/ObjectVersionDataRequestVersionType/index"},{"type":"link","label":"ParentChildBehavior","href":"/Frameworks/User-Interface-Extensibility-Framework/Reference/gRPC/Enums/ParentChildBehavior/","docId":"gRPC/Enums/ParentChildBehavior/index"},{"type":"link","label":"PermissionsExpressionType","href":"/Frameworks/User-Interface-Extensibility-Framework/Reference/gRPC/Enums/PermissionsExpressionType/","docId":"gRPC/Enums/PermissionsExpressionType/index"},{"type":"link","label":"PropertySetByType","href":"/Frameworks/User-Interface-Extensibility-Framework/Reference/gRPC/Enums/PropertySetByType/","docId":"gRPC/Enums/PropertySetByType/index"},{"type":"link","label":"PseudoUserResolutionMode","href":"/Frameworks/User-Interface-Extensibility-Framework/Reference/gRPC/Enums/PseudoUserResolutionMode/","docId":"gRPC/Enums/PseudoUserResolutionMode/index"},{"type":"link","label":"ReferenceDirection","href":"/Frameworks/User-Interface-Extensibility-Framework/Reference/gRPC/Enums/ReferenceDirection/","docId":"gRPC/Enums/ReferenceDirection/index"},{"type":"link","label":"RelationshipDirection","href":"/Frameworks/User-Interface-Extensibility-Framework/Reference/gRPC/Enums/RelationshipDirection/","docId":"gRPC/Enums/RelationshipDirection/index"},{"type":"link","label":"SearchMode","href":"/Frameworks/User-Interface-Extensibility-Framework/Reference/gRPC/Enums/SearchMode/","docId":"gRPC/Enums/SearchMode/index"},{"type":"link","label":"StatusType","href":"/Frameworks/User-Interface-Extensibility-Framework/Reference/gRPC/Enums/StatusType/","docId":"gRPC/Enums/StatusType/index"},{"type":"link","label":"UpdateType","href":"/Frameworks/User-Interface-Extensibility-Framework/Reference/gRPC/Enums/UpdateType/","docId":"gRPC/Enums/UpdateType/index"},{"type":"link","label":"VLSortingType","href":"/Frameworks/User-Interface-Extensibility-Framework/Reference/gRPC/Enums/VLSortingType/","docId":"gRPC/Enums/VLSortingType/index"},{"type":"link","label":"ValidationType","href":"/Frameworks/User-Interface-Extensibility-Framework/Reference/gRPC/Enums/ValidationType/","docId":"gRPC/Enums/ValidationType/index"},{"type":"link","label":"ViewType","href":"/Frameworks/User-Interface-Extensibility-Framework/Reference/gRPC/Enums/ViewType/","docId":"gRPC/Enums/ViewType/index"}],"href":"/Frameworks/User-Interface-Extensibility-Framework/Reference/gRPC/Enums/"},{"type":"category","label":"Interfaces","collapsible":true,"collapsed":true,"items":[{"type":"category","label":"NamedACLsOperations","collapsible":true,"collapsed":true,"items":[{"type":"link","label":"GetNamedACLs","href":"/Frameworks/User-Interface-Extensibility-Framework/Reference/gRPC/Interfaces/NamedACLsOperations/GetNamedACLs/","docId":"gRPC/Interfaces/NamedACLsOperations/GetNamedACLs/index"}],"href":"/Frameworks/User-Interface-Extensibility-Framework/Reference/gRPC/Interfaces/NamedACLsOperations/"},{"type":"category","label":"NamedValueStorageOperations","collapsible":true,"collapsed":true,"items":[{"type":"link","label":"GetNamedValues","href":"/Frameworks/User-Interface-Extensibility-Framework/Reference/gRPC/Interfaces/NamedValueStorageOperations/GetNamedValues/","docId":"gRPC/Interfaces/NamedValueStorageOperations/GetNamedValues/index"},{"type":"link","label":"RemoveNamedValues","href":"/Frameworks/User-Interface-Extensibility-Framework/Reference/gRPC/Interfaces/NamedValueStorageOperations/RemoveNamedValues/","docId":"gRPC/Interfaces/NamedValueStorageOperations/RemoveNamedValues/index"},{"type":"link","label":"SetNamedValues","href":"/Frameworks/User-Interface-Extensibility-Framework/Reference/gRPC/Interfaces/NamedValueStorageOperations/SetNamedValues/","docId":"gRPC/Interfaces/NamedValueStorageOperations/SetNamedValues/index"}],"href":"/Frameworks/User-Interface-Extensibility-Framework/Reference/gRPC/Interfaces/NamedValueStorageOperations/"},{"type":"category","label":"ObjectOperations","collapsible":true,"collapsed":true,"items":[{"type":"link","label":"AddObjectFile","href":"/Frameworks/User-Interface-Extensibility-Framework/Reference/gRPC/Interfaces/ObjectOperations/AddObjectFile/","docId":"gRPC/Interfaces/ObjectOperations/AddObjectFile/index"},{"type":"link","label":"AddObjectWithFiles","href":"/Frameworks/User-Interface-Extensibility-Framework/Reference/gRPC/Interfaces/ObjectOperations/AddObjectWithFiles/","docId":"gRPC/Interfaces/ObjectOperations/AddObjectWithFiles/index"},{"type":"link","label":"ChangeSecurity","href":"/Frameworks/User-Interface-Extensibility-Framework/Reference/gRPC/Interfaces/ObjectOperations/ChangeSecurity/","docId":"gRPC/Interfaces/ObjectOperations/ChangeSecurity/index"},{"type":"link","label":"CheckInMultiple","href":"/Frameworks/User-Interface-Extensibility-Framework/Reference/gRPC/Interfaces/ObjectOperations/CheckInMultiple/","docId":"gRPC/Interfaces/ObjectOperations/CheckInMultiple/index"},{"type":"link","label":"CheckOutMultiple","href":"/Frameworks/User-Interface-Extensibility-Framework/Reference/gRPC/Interfaces/ObjectOperations/CheckOutMultiple/","docId":"gRPC/Interfaces/ObjectOperations/CheckOutMultiple/index"},{"type":"link","label":"DestroyObjects","href":"/Frameworks/User-Interface-Extensibility-Framework/Reference/gRPC/Interfaces/ObjectOperations/DestroyObjects/","docId":"gRPC/Interfaces/ObjectOperations/DestroyObjects/index"},{"type":"link","label":"FollowObject","href":"/Frameworks/User-Interface-Extensibility-Framework/Reference/gRPC/Interfaces/ObjectOperations/FollowObject/","docId":"gRPC/Interfaces/ObjectOperations/FollowObject/index"},{"type":"link","label":"GetAutomaticMetadata","href":"/Frameworks/User-Interface-Extensibility-Framework/Reference/gRPC/Interfaces/ObjectOperations/GetAutomaticMetadata/","docId":"gRPC/Interfaces/ObjectOperations/GetAutomaticMetadata/index"},{"type":"link","label":"GetDocEventSubscriptions","href":"/Frameworks/User-Interface-Extensibility-Framework/Reference/gRPC/Interfaces/ObjectOperations/GetDocEventSubscriptions/","docId":"gRPC/Interfaces/ObjectOperations/GetDocEventSubscriptions/index"},{"type":"link","label":"GetEffectivePermissions","href":"/Frameworks/User-Interface-Extensibility-Framework/Reference/gRPC/Interfaces/ObjectOperations/GetEffectivePermissions/","docId":"gRPC/Interfaces/ObjectOperations/GetEffectivePermissions/index"},{"type":"link","label":"GetLatestFileVersion","href":"/Frameworks/User-Interface-Extensibility-Framework/Reference/gRPC/Interfaces/ObjectOperations/GetLatestFileVersion/","docId":"gRPC/Interfaces/ObjectOperations/GetLatestFileVersion/index"},{"type":"link","label":"GetLatestObjectVersion","href":"/Frameworks/User-Interface-Extensibility-Framework/Reference/gRPC/Interfaces/ObjectOperations/GetLatestObjectVersion/","docId":"gRPC/Interfaces/ObjectOperations/GetLatestObjectVersion/index"},{"type":"link","label":"GetObjIDByGUID","href":"/Frameworks/User-Interface-Extensibility-Framework/Reference/gRPC/Interfaces/ObjectOperations/GetObjIDByGUID/","docId":"gRPC/Interfaces/ObjectOperations/GetObjIDByGUID/index"},{"type":"link","label":"GetObjectDataOfMultipleObjects","href":"/Frameworks/User-Interface-Extensibility-Framework/Reference/gRPC/Interfaces/ObjectOperations/GetObjectDataOfMultipleObjects/","docId":"gRPC/Interfaces/ObjectOperations/GetObjectDataOfMultipleObjects/index"},{"type":"link","label":"GetObjectFiles","href":"/Frameworks/User-Interface-Extensibility-Framework/Reference/gRPC/Interfaces/ObjectOperations/GetObjectFiles/","docId":"gRPC/Interfaces/ObjectOperations/GetObjectFiles/index"},{"type":"link","label":"GetObjectHistory2","href":"/Frameworks/User-Interface-Extensibility-Framework/Reference/gRPC/Interfaces/ObjectOperations/GetObjectHistory2/","docId":"gRPC/Interfaces/ObjectOperations/GetObjectHistory2/index"},{"type":"link","label":"GetTemplates","href":"/Frameworks/User-Interface-Extensibility-Framework/Reference/gRPC/Interfaces/ObjectOperations/GetTemplates/","docId":"gRPC/Interfaces/ObjectOperations/GetTemplates/index"},{"type":"link","label":"GetWorkflowStateHistory","href":"/Frameworks/User-Interface-Extensibility-Framework/Reference/gRPC/Interfaces/ObjectOperations/GetWorkflowStateHistory/","docId":"gRPC/Interfaces/ObjectOperations/GetWorkflowStateHistory/index"},{"type":"link","label":"GetWorkflowStates","href":"/Frameworks/User-Interface-Extensibility-Framework/Reference/gRPC/Interfaces/ObjectOperations/GetWorkflowStates/","docId":"gRPC/Interfaces/ObjectOperations/GetWorkflowStates/index"},{"type":"link","label":"GetWorkflowStatesAndTransitions","href":"/Frameworks/User-Interface-Extensibility-Framework/Reference/gRPC/Interfaces/ObjectOperations/GetWorkflowStatesAndTransitions/","docId":"gRPC/Interfaces/ObjectOperations/GetWorkflowStatesAndTransitions/index"},{"type":"link","label":"GetWorkflowsForClient","href":"/Frameworks/User-Interface-Extensibility-Framework/Reference/gRPC/Interfaces/ObjectOperations/GetWorkflowsForClient/","docId":"gRPC/Interfaces/ObjectOperations/GetWorkflowsForClient/index"},{"type":"link","label":"PromoteUnmanagedObject","href":"/Frameworks/User-Interface-Extensibility-Framework/Reference/gRPC/Interfaces/ObjectOperations/PromoteUnmanagedObject/","docId":"gRPC/Interfaces/ObjectOperations/PromoteUnmanagedObject/index"},{"type":"link","label":"RemoveObjectFile","href":"/Frameworks/User-Interface-Extensibility-Framework/Reference/gRPC/Interfaces/ObjectOperations/RemoveObjectFile/","docId":"gRPC/Interfaces/ObjectOperations/RemoveObjectFile/index"},{"type":"link","label":"RemoveObjects","href":"/Frameworks/User-Interface-Extensibility-Framework/Reference/gRPC/Interfaces/ObjectOperations/RemoveObjects/","docId":"gRPC/Interfaces/ObjectOperations/RemoveObjects/index"},{"type":"link","label":"RenameObjectFile","href":"/Frameworks/User-Interface-Extensibility-Framework/Reference/gRPC/Interfaces/ObjectOperations/RenameObjectFile/","docId":"gRPC/Interfaces/ObjectOperations/RenameObjectFile/index"},{"type":"link","label":"SetObjectLevelProperty","href":"/Frameworks/User-Interface-Extensibility-Framework/Reference/gRPC/Interfaces/ObjectOperations/SetObjectLevelProperty/","docId":"gRPC/Interfaces/ObjectOperations/SetObjectLevelProperty/index"},{"type":"link","label":"SetPropertiesMultiple","href":"/Frameworks/User-Interface-Extensibility-Framework/Reference/gRPC/Interfaces/ObjectOperations/SetPropertiesMultiple/","docId":"gRPC/Interfaces/ObjectOperations/SetPropertiesMultiple/index"},{"type":"link","label":"UndoCheckoutMultiple","href":"/Frameworks/User-Interface-Extensibility-Framework/Reference/gRPC/Interfaces/ObjectOperations/UndoCheckoutMultiple/","docId":"gRPC/Interfaces/ObjectOperations/UndoCheckoutMultiple/index"},{"type":"link","label":"UploadExistingFiles","href":"/Frameworks/User-Interface-Extensibility-Framework/Reference/gRPC/Interfaces/ObjectOperations/UploadExistingFiles/","docId":"gRPC/Interfaces/ObjectOperations/UploadExistingFiles/index"}],"href":"/Frameworks/User-Interface-Extensibility-Framework/Reference/gRPC/Interfaces/ObjectOperations/"},{"type":"category","label":"ObjectTypesOperations","collapsible":true,"collapsed":true,"items":[{"type":"link","label":"GetObjectTypes","href":"/Frameworks/User-Interface-Extensibility-Framework/Reference/gRPC/Interfaces/ObjectTypesOperations/GetObjectTypes/","docId":"gRPC/Interfaces/ObjectTypesOperations/GetObjectTypes/index"}],"href":"/Frameworks/User-Interface-Extensibility-Framework/Reference/gRPC/Interfaces/ObjectTypesOperations/"},{"type":"category","label":"PropertyDefsOperations","collapsible":true,"collapsed":true,"items":[{"type":"link","label":"GetObjectClassesAndGroups","href":"/Frameworks/User-Interface-Extensibility-Framework/Reference/gRPC/Interfaces/PropertyDefsOperations/GetObjectClassesAndGroups/","docId":"gRPC/Interfaces/PropertyDefsOperations/GetObjectClassesAndGroups/index"},{"type":"link","label":"GetPropertyDefs","href":"/Frameworks/User-Interface-Extensibility-Framework/Reference/gRPC/Interfaces/PropertyDefsOperations/GetPropertyDefs/","docId":"gRPC/Interfaces/PropertyDefsOperations/GetPropertyDefs/index"}],"href":"/Frameworks/User-Interface-Extensibility-Framework/Reference/gRPC/Interfaces/PropertyDefsOperations/"},{"type":"category","label":"SearchOperations","collapsible":true,"collapsed":true,"items":[{"type":"link","label":"GetFolderContents","href":"/Frameworks/User-Interface-Extensibility-Framework/Reference/gRPC/Interfaces/SearchOperations/GetFolderContents/","docId":"gRPC/Interfaces/SearchOperations/GetFolderContents/index"},{"type":"link","label":"SearchObjects","href":"/Frameworks/User-Interface-Extensibility-Framework/Reference/gRPC/Interfaces/SearchOperations/SearchObjects/","docId":"gRPC/Interfaces/SearchOperations/SearchObjects/index"}],"href":"/Frameworks/User-Interface-Extensibility-Framework/Reference/gRPC/Interfaces/SearchOperations/"},{"type":"category","label":"ValueListsOperations","collapsible":true,"collapsed":true,"items":[{"type":"link","label":"GetValueListItemsWithPermissions","href":"/Frameworks/User-Interface-Extensibility-Framework/Reference/gRPC/Interfaces/ValueListsOperations/GetValueListItemsWithPermissions/","docId":"gRPC/Interfaces/ValueListsOperations/GetValueListItemsWithPermissions/index"},{"type":"link","label":"GetValueLists","href":"/Frameworks/User-Interface-Extensibility-Framework/Reference/gRPC/Interfaces/ValueListsOperations/GetValueLists/","docId":"gRPC/Interfaces/ValueListsOperations/GetValueLists/index"},{"type":"link","label":"SearchValueListItemsWithPermissions","href":"/Frameworks/User-Interface-Extensibility-Framework/Reference/gRPC/Interfaces/ValueListsOperations/SearchValueListItemsWithPermissions/","docId":"gRPC/Interfaces/ValueListsOperations/SearchValueListItemsWithPermissions/index"}],"href":"/Frameworks/User-Interface-Extensibility-Framework/Reference/gRPC/Interfaces/ValueListsOperations/"},{"type":"category","label":"VaultExtensionMethodsOperations","collapsible":true,"collapsed":true,"items":[{"type":"link","label":"IsExtensionMethodAvailable","href":"/Frameworks/User-Interface-Extensibility-Framework/Reference/gRPC/Interfaces/VaultExtensionMethodsOperations/IsExtensionMethodAvailable/","docId":"gRPC/Interfaces/VaultExtensionMethodsOperations/IsExtensionMethodAvailable/index"},{"type":"link","label":"RunExtensionMethod","href":"/Frameworks/User-Interface-Extensibility-Framework/Reference/gRPC/Interfaces/VaultExtensionMethodsOperations/RunExtensionMethod/","docId":"gRPC/Interfaces/VaultExtensionMethodsOperations/RunExtensionMethod/index"}],"href":"/Frameworks/User-Interface-Extensibility-Framework/Reference/gRPC/Interfaces/VaultExtensionMethodsOperations/"},{"type":"category","label":"VaultOperations","collapsible":true,"collapsed":true,"items":[{"type":"link","label":"GetMetadataStructureItemIdByAlias","href":"/Frameworks/User-Interface-Extensibility-Framework/Reference/gRPC/Interfaces/VaultOperations/GetMetadataStructureItemIdByAlias/","docId":"gRPC/Interfaces/VaultOperations/GetMetadataStructureItemIdByAlias/index"},{"type":"link","label":"GetMetadataStructureItemIdByGUID","href":"/Frameworks/User-Interface-Extensibility-Framework/Reference/gRPC/Interfaces/VaultOperations/GetMetadataStructureItemIdByGUID/","docId":"gRPC/Interfaces/VaultOperations/GetMetadataStructureItemIdByGUID/index"}],"href":"/Frameworks/User-Interface-Extensibility-Framework/Reference/gRPC/Interfaces/VaultOperations/"},{"type":"category","label":"ViewsOperations","collapsible":true,"collapsed":true,"items":[{"type":"link","label":"DeleteView","href":"/Frameworks/User-Interface-Extensibility-Framework/Reference/gRPC/Interfaces/ViewsOperations/DeleteView/","docId":"gRPC/Interfaces/ViewsOperations/DeleteView/index"},{"type":"link","label":"GetViews","href":"/Frameworks/User-Interface-Extensibility-Framework/Reference/gRPC/Interfaces/ViewsOperations/GetViews/","docId":"gRPC/Interfaces/ViewsOperations/GetViews/index"}],"href":"/Frameworks/User-Interface-Extensibility-Framework/Reference/gRPC/Interfaces/ViewsOperations/"}],"href":"/Frameworks/User-Interface-Extensibility-Framework/Reference/gRPC/Interfaces/"},{"type":"category","label":"Messages","collapsible":true,"collapsed":true,"items":[{"type":"link","label":"ACCESSCONTROLLISTCOMPONENTSTATUSFLAGS","href":"/Frameworks/User-Interface-Extensibility-Framework/Reference/gRPC/Messages/ACCESSCONTROLLISTCOMPONENTSTATUSFLAGS/","docId":"gRPC/Messages/ACCESSCONTROLLISTCOMPONENTSTATUSFLAGS/index"},{"type":"link","label":"ACTIONFLAGS","href":"/Frameworks/User-Interface-Extensibility-Framework/Reference/gRPC/Messages/ACTIONFLAGS/","docId":"gRPC/Messages/ACTIONFLAGS/index"},{"type":"link","label":"AccessControlEntry","href":"/Frameworks/User-Interface-Extensibility-Framework/Reference/gRPC/Messages/AccessControlEntry/","docId":"gRPC/Messages/AccessControlEntry/index"},{"type":"link","label":"AccessControlList","href":"/Frameworks/User-Interface-Extensibility-Framework/Reference/gRPC/Messages/AccessControlList/","docId":"gRPC/Messages/AccessControlList/index"},{"type":"link","label":"AccessControlListComponent","href":"/Frameworks/User-Interface-Extensibility-Framework/Reference/gRPC/Messages/AccessControlListComponent/","docId":"gRPC/Messages/AccessControlListComponent/index"},{"type":"link","label":"AccessControlListComponentKey","href":"/Frameworks/User-Interface-Extensibility-Framework/Reference/gRPC/Messages/AccessControlListComponentKey/","docId":"gRPC/Messages/AccessControlListComponentKey/index"},{"type":"link","label":"AccessControlListComponentMapEntry","href":"/Frameworks/User-Interface-Extensibility-Framework/Reference/gRPC/Messages/AccessControlListComponentMapEntry/","docId":"gRPC/Messages/AccessControlListComponentMapEntry/index"},{"type":"link","label":"AccessControlPseudoUserSubject","href":"/Frameworks/User-Interface-Extensibility-Framework/Reference/gRPC/Messages/AccessControlPseudoUserSubject/","docId":"gRPC/Messages/AccessControlPseudoUserSubject/index"},{"type":"link","label":"AccessControlSubject","href":"/Frameworks/User-Interface-Extensibility-Framework/Reference/gRPC/Messages/AccessControlSubject/","docId":"gRPC/Messages/AccessControlSubject/index"},{"type":"link","label":"AccessControlSubjectUnion","href":"/Frameworks/User-Interface-Extensibility-Framework/Reference/gRPC/Messages/AccessControlSubjectUnion/","docId":"gRPC/Messages/AccessControlSubjectUnion/index"},{"type":"link","label":"AssociatedPropertyDef","href":"/Frameworks/User-Interface-Extensibility-Framework/Reference/gRPC/Messages/AssociatedPropertyDef/","docId":"gRPC/Messages/AssociatedPropertyDef/index"},{"type":"link","label":"AutomaticMetadataRequest","href":"/Frameworks/User-Interface-Extensibility-Framework/Reference/gRPC/Messages/AutomaticMetadataRequest/","docId":"gRPC/Messages/AutomaticMetadataRequest/index"},{"type":"link","label":"AutomaticMetadataResult","href":"/Frameworks/User-Interface-Extensibility-Framework/Reference/gRPC/Messages/AutomaticMetadataResult/","docId":"gRPC/Messages/AutomaticMetadataResult/index"},{"type":"link","label":"AutomaticPermissions","href":"/Frameworks/User-Interface-Extensibility-Framework/Reference/gRPC/Messages/AutomaticPermissions/","docId":"gRPC/Messages/AutomaticPermissions/index"},{"type":"link","label":"Bytes","href":"/Frameworks/User-Interface-Extensibility-Framework/Reference/gRPC/Messages/Bytes/","docId":"gRPC/Messages/Bytes/index"},{"type":"link","label":"ClassGroup","href":"/Frameworks/User-Interface-Extensibility-Framework/Reference/gRPC/Messages/ClassGroup/","docId":"gRPC/Messages/ClassGroup/index"},{"type":"link","label":"ClassPermissionsForClient","href":"/Frameworks/User-Interface-Extensibility-Framework/Reference/gRPC/Messages/ClassPermissionsForClient/","docId":"gRPC/Messages/ClassPermissionsForClient/index"},{"type":"link","label":"DataFunctionCall","href":"/Frameworks/User-Interface-Extensibility-Framework/Reference/gRPC/Messages/DataFunctionCall/","docId":"gRPC/Messages/DataFunctionCall/index"},{"type":"category","label":"DataFunctionUnion","collapsible":true,"collapsed":true,"items":[{"type":"link","label":"DateData","href":"/Frameworks/User-Interface-Extensibility-Framework/Reference/gRPC/Messages/DataFunctionUnion/DateData/","docId":"gRPC/Messages/DataFunctionUnion/DateData/index"},{"type":"link","label":"DaysFromData","href":"/Frameworks/User-Interface-Extensibility-Framework/Reference/gRPC/Messages/DataFunctionUnion/DaysFromData/","docId":"gRPC/Messages/DataFunctionUnion/DaysFromData/index"},{"type":"link","label":"DaysToData","href":"/Frameworks/User-Interface-Extensibility-Framework/Reference/gRPC/Messages/DataFunctionUnion/DaysToData/","docId":"gRPC/Messages/DataFunctionUnion/DaysToData/index"},{"type":"link","label":"InitialCharacterGroupData","href":"/Frameworks/User-Interface-Extensibility-Framework/Reference/gRPC/Messages/DataFunctionUnion/InitialCharacterGroupData/","docId":"gRPC/Messages/DataFunctionUnion/InitialCharacterGroupData/index"},{"type":"link","label":"IntegerSegmentData","href":"/Frameworks/User-Interface-Extensibility-Framework/Reference/gRPC/Messages/DataFunctionUnion/IntegerSegmentData/","docId":"gRPC/Messages/DataFunctionUnion/IntegerSegmentData/index"},{"type":"link","label":"LeftCharactersData","href":"/Frameworks/User-Interface-Extensibility-Framework/Reference/gRPC/Messages/DataFunctionUnion/LeftCharactersData/","docId":"gRPC/Messages/DataFunctionUnion/LeftCharactersData/index"},{"type":"link","label":"MonthData","href":"/Frameworks/User-Interface-Extensibility-Framework/Reference/gRPC/Messages/DataFunctionUnion/MonthData/","docId":"gRPC/Messages/DataFunctionUnion/MonthData/index"},{"type":"link","label":"NoOpData","href":"/Frameworks/User-Interface-Extensibility-Framework/Reference/gRPC/Messages/DataFunctionUnion/NoOpData/","docId":"gRPC/Messages/DataFunctionUnion/NoOpData/index"},{"type":"link","label":"YearAndMonthData","href":"/Frameworks/User-Interface-Extensibility-Framework/Reference/gRPC/Messages/DataFunctionUnion/YearAndMonthData/","docId":"gRPC/Messages/DataFunctionUnion/YearAndMonthData/index"},{"type":"link","label":"YearData","href":"/Frameworks/User-Interface-Extensibility-Framework/Reference/gRPC/Messages/DataFunctionUnion/YearData/","docId":"gRPC/Messages/DataFunctionUnion/YearData/index"}],"href":"/Frameworks/User-Interface-Extensibility-Framework/Reference/gRPC/Messages/DataFunctionUnion/"},{"type":"link","label":"DefaultReplicationConfiguration","href":"/Frameworks/User-Interface-Extensibility-Framework/Reference/gRPC/Messages/DefaultReplicationConfiguration/","docId":"gRPC/Messages/DefaultReplicationConfiguration/index"},{"type":"link","label":"DocClassGroup","href":"/Frameworks/User-Interface-Extensibility-Framework/Reference/gRPC/Messages/DocClassGroup/","docId":"gRPC/Messages/DocClassGroup/index"},{"type":"link","label":"EXPRESSIONEXFLAGS","href":"/Frameworks/User-Interface-Extensibility-Framework/Reference/gRPC/Messages/EXPRESSIONEXFLAGS/","docId":"gRPC/Messages/EXPRESSIONEXFLAGS/index"},{"type":"link","label":"EffectivePermissions","href":"/Frameworks/User-Interface-Extensibility-Framework/Reference/gRPC/Messages/EffectivePermissions/","docId":"gRPC/Messages/EffectivePermissions/index"},{"type":"link","label":"ErrorInfo","href":"/Frameworks/User-Interface-Extensibility-Framework/Reference/gRPC/Messages/ErrorInfo/","docId":"gRPC/Messages/ErrorInfo/index"},{"type":"link","label":"EventSubscription","href":"/Frameworks/User-Interface-Extensibility-Framework/Reference/gRPC/Messages/EventSubscription/","docId":"gRPC/Messages/EventSubscription/index"},{"type":"link","label":"Expression","href":"/Frameworks/User-Interface-Extensibility-Framework/Reference/gRPC/Messages/Expression/","docId":"gRPC/Messages/Expression/index"},{"type":"category","label":"ExpressionUnion","collapsible":true,"collapsed":true,"items":[{"type":"link","label":"AnyFieldData","href":"/Frameworks/User-Interface-Extensibility-Framework/Reference/gRPC/Messages/ExpressionUnion/AnyFieldData/","docId":"gRPC/Messages/ExpressionUnion/AnyFieldData/index"},{"type":"link","label":"FileValueData","href":"/Frameworks/User-Interface-Extensibility-Framework/Reference/gRPC/Messages/ExpressionUnion/FileValueData/","docId":"gRPC/Messages/ExpressionUnion/FileValueData/index"},{"type":"link","label":"IdSegmentData","href":"/Frameworks/User-Interface-Extensibility-Framework/Reference/gRPC/Messages/ExpressionUnion/IdSegmentData/","docId":"gRPC/Messages/ExpressionUnion/IdSegmentData/index"},{"type":"link","label":"PermissionsData","href":"/Frameworks/User-Interface-Extensibility-Framework/Reference/gRPC/Messages/ExpressionUnion/PermissionsData/","docId":"gRPC/Messages/ExpressionUnion/PermissionsData/index"},{"type":"link","label":"PropertyValueData","href":"/Frameworks/User-Interface-Extensibility-Framework/Reference/gRPC/Messages/ExpressionUnion/PropertyValueData/","docId":"gRPC/Messages/ExpressionUnion/PropertyValueData/index"},{"type":"link","label":"StatusValueData","href":"/Frameworks/User-Interface-Extensibility-Framework/Reference/gRPC/Messages/ExpressionUnion/StatusValueData/","docId":"gRPC/Messages/ExpressionUnion/StatusValueData/index"},{"type":"link","label":"TypedValueData","href":"/Frameworks/User-Interface-Extensibility-Framework/Reference/gRPC/Messages/ExpressionUnion/TypedValueData/","docId":"gRPC/Messages/ExpressionUnion/TypedValueData/index"},{"type":"link","label":"UninitializedData","href":"/Frameworks/User-Interface-Extensibility-Framework/Reference/gRPC/Messages/ExpressionUnion/UninitializedData/","docId":"gRPC/Messages/ExpressionUnion/UninitializedData/index"}],"href":"/Frameworks/User-Interface-Extensibility-Framework/Reference/gRPC/Messages/ExpressionUnion/"},{"type":"link","label":"ExtObjectInfo","href":"/Frameworks/User-Interface-Extensibility-Framework/Reference/gRPC/Messages/ExtObjectInfo/","docId":"gRPC/Messages/ExtObjectInfo/index"},{"type":"link","label":"ExternalRepositoryID","href":"/Frameworks/User-Interface-Extensibility-Framework/Reference/gRPC/Messages/ExternalRepositoryID/","docId":"gRPC/Messages/ExternalRepositoryID/index"},{"type":"link","label":"ExternalView","href":"/Frameworks/User-Interface-Extensibility-Framework/Reference/gRPC/Messages/ExternalView/","docId":"gRPC/Messages/ExternalView/index"},{"type":"link","label":"FOLDERCAPABILITYFLAGS","href":"/Frameworks/User-Interface-Extensibility-Framework/Reference/gRPC/Messages/FOLDERCAPABILITYFLAGS/","docId":"gRPC/Messages/FOLDERCAPABILITYFLAGS/index"},{"type":"link","label":"FTSFLAGS","href":"/Frameworks/User-Interface-Extensibility-Framework/Reference/gRPC/Messages/FTSFLAGS/","docId":"gRPC/Messages/FTSFLAGS/index"},{"type":"link","label":"File","href":"/Frameworks/User-Interface-Extensibility-Framework/Reference/gRPC/Messages/File/","docId":"gRPC/Messages/File/index"},{"type":"link","label":"FileID","href":"/Frameworks/User-Interface-Extensibility-Framework/Reference/gRPC/Messages/FileID/","docId":"gRPC/Messages/FileID/index"},{"type":"link","label":"FileVer","href":"/Frameworks/User-Interface-Extensibility-Framework/Reference/gRPC/Messages/FileVer/","docId":"gRPC/Messages/FileVer/index"},{"type":"link","label":"Folder","href":"/Frameworks/User-Interface-Extensibility-Framework/Reference/gRPC/Messages/Folder/","docId":"gRPC/Messages/Folder/index"},{"type":"category","label":"FolderInfoUnion","collapsible":true,"collapsed":true,"items":[{"type":"link","label":"AnyFolderData","href":"/Frameworks/User-Interface-Extensibility-Framework/Reference/gRPC/Messages/FolderInfoUnion/AnyFolderData/","docId":"gRPC/Messages/FolderInfoUnion/AnyFolderData/index"},{"type":"link","label":"ExternalViewFolderData","href":"/Frameworks/User-Interface-Extensibility-Framework/Reference/gRPC/Messages/FolderInfoUnion/ExternalViewFolderData/","docId":"gRPC/Messages/FolderInfoUnion/ExternalViewFolderData/index"},{"type":"link","label":"PropertyFolderData","href":"/Frameworks/User-Interface-Extensibility-Framework/Reference/gRPC/Messages/FolderInfoUnion/PropertyFolderData/","docId":"gRPC/Messages/FolderInfoUnion/PropertyFolderData/index"},{"type":"link","label":"SearchFolderData","href":"/Frameworks/User-Interface-Extensibility-Framework/Reference/gRPC/Messages/FolderInfoUnion/SearchFolderData/","docId":"gRPC/Messages/FolderInfoUnion/SearchFolderData/index"},{"type":"link","label":"TraditionalFolderData","href":"/Frameworks/User-Interface-Extensibility-Framework/Reference/gRPC/Messages/FolderInfoUnion/TraditionalFolderData/","docId":"gRPC/Messages/FolderInfoUnion/TraditionalFolderData/index"},{"type":"link","label":"UnknownFolderData","href":"/Frameworks/User-Interface-Extensibility-Framework/Reference/gRPC/Messages/FolderInfoUnion/UnknownFolderData/","docId":"gRPC/Messages/FolderInfoUnion/UnknownFolderData/index"},{"type":"link","label":"ViewFolderData","href":"/Frameworks/User-Interface-Extensibility-Framework/Reference/gRPC/Messages/FolderInfoUnion/ViewFolderData/","docId":"gRPC/Messages/FolderInfoUnion/ViewFolderData/index"}],"href":"/Frameworks/User-Interface-Extensibility-Framework/Reference/gRPC/Messages/FolderInfoUnion/"},{"type":"link","label":"GetMetadataStructureItemIdByGUIDRequest","href":"/Frameworks/User-Interface-Extensibility-Framework/Reference/gRPC/Messages/GetMetadataStructureItemIdByGUIDRequest/","docId":"gRPC/Messages/GetMetadataStructureItemIdByGUIDRequest/index"},{"type":"link","label":"GetMetadataStructureItemIdByGUIDResponse","href":"/Frameworks/User-Interface-Extensibility-Framework/Reference/gRPC/Messages/GetMetadataStructureItemIdByGUIDResponse/","docId":"gRPC/Messages/GetMetadataStructureItemIdByGUIDResponse/index"},{"type":"link","label":"GetObjectVersionAndPropertiesOfMultipleObjectsResponse","href":"/Frameworks/User-Interface-Extensibility-Framework/Reference/gRPC/Messages/GetObjectVersionAndPropertiesOfMultipleObjectsResponse/","docId":"gRPC/Messages/GetObjectVersionAndPropertiesOfMultipleObjectsResponse/index"},{"type":"link","label":"GroupingLevel","href":"/Frameworks/User-Interface-Extensibility-Framework/Reference/gRPC/Messages/GroupingLevel/","docId":"gRPC/Messages/GroupingLevel/index"},{"type":"link","label":"ITEMFLAGS","href":"/Frameworks/User-Interface-Extensibility-Framework/Reference/gRPC/Messages/ITEMFLAGS/","docId":"gRPC/Messages/ITEMFLAGS/index"},{"type":"link","label":"IndirectPropertyID","href":"/Frameworks/User-Interface-Extensibility-Framework/Reference/gRPC/Messages/IndirectPropertyID/","docId":"gRPC/Messages/IndirectPropertyID/index"},{"type":"link","label":"IndirectPropertyIDLevel","href":"/Frameworks/User-Interface-Extensibility-Framework/Reference/gRPC/Messages/IndirectPropertyIDLevel/","docId":"gRPC/Messages/IndirectPropertyIDLevel/index"},{"type":"link","label":"IndirectPropertyIDLevelRef","href":"/Frameworks/User-Interface-Extensibility-Framework/Reference/gRPC/Messages/IndirectPropertyIDLevelRef/","docId":"gRPC/Messages/IndirectPropertyIDLevelRef/index"},{"type":"link","label":"IndirectionLevel","href":"/Frameworks/User-Interface-Extensibility-Framework/Reference/gRPC/Messages/IndirectionLevel/","docId":"gRPC/Messages/IndirectionLevel/index"},{"type":"link","label":"ItemID","href":"/Frameworks/User-Interface-Extensibility-Framework/Reference/gRPC/Messages/ItemID/","docId":"gRPC/Messages/ItemID/index"},{"type":"link","label":"ItemInfo","href":"/Frameworks/User-Interface-Extensibility-Framework/Reference/gRPC/Messages/ItemInfo/","docId":"gRPC/Messages/ItemInfo/index"},{"type":"link","label":"Lookup","href":"/Frameworks/User-Interface-Extensibility-Framework/Reference/gRPC/Messages/Lookup/","docId":"gRPC/Messages/Lookup/index"},{"type":"link","label":"LookupWithMetadata","href":"/Frameworks/User-Interface-Extensibility-Framework/Reference/gRPC/Messages/LookupWithMetadata/","docId":"gRPC/Messages/LookupWithMetadata/index"},{"type":"link","label":"MultiSelectLookup","href":"/Frameworks/User-Interface-Extensibility-Framework/Reference/gRPC/Messages/MultiSelectLookup/","docId":"gRPC/Messages/MultiSelectLookup/index"},{"type":"link","label":"MultiSelectLookupWithMetadata","href":"/Frameworks/User-Interface-Extensibility-Framework/Reference/gRPC/Messages/MultiSelectLookupWithMetadata/","docId":"gRPC/Messages/MultiSelectLookupWithMetadata/index"},{"type":"link","label":"NamedACL","href":"/Frameworks/User-Interface-Extensibility-Framework/Reference/gRPC/Messages/NamedACL/","docId":"gRPC/Messages/NamedACL/index"},{"type":"link","label":"NamedValue","href":"/Frameworks/User-Interface-Extensibility-Framework/Reference/gRPC/Messages/NamedValue/","docId":"gRPC/Messages/NamedValue/index"},{"type":"link","label":"OBJECTCAPABILITYFLAGS","href":"/Frameworks/User-Interface-Extensibility-Framework/Reference/gRPC/Messages/OBJECTCAPABILITYFLAGS/","docId":"gRPC/Messages/OBJECTCAPABILITYFLAGS/index"},{"type":"link","label":"OBJECTDATAREQUESTFLAGS","href":"/Frameworks/User-Interface-Extensibility-Framework/Reference/gRPC/Messages/OBJECTDATAREQUESTFLAGS/","docId":"gRPC/Messages/OBJECTDATAREQUESTFLAGS/index"},{"type":"link","label":"OBJECTFILEFLAGS","href":"/Frameworks/User-Interface-Extensibility-Framework/Reference/gRPC/Messages/OBJECTFILEFLAGS/","docId":"gRPC/Messages/OBJECTFILEFLAGS/index"},{"type":"link","label":"OBJECTOPFLAGS","href":"/Frameworks/User-Interface-Extensibility-Framework/Reference/gRPC/Messages/OBJECTOPFLAGS/","docId":"gRPC/Messages/OBJECTOPFLAGS/index"},{"type":"link","label":"OBJECTVERSIONACTIVITYCATEGORYFLAGS","href":"/Frameworks/User-Interface-Extensibility-Framework/Reference/gRPC/Messages/OBJECTVERSIONACTIVITYCATEGORYFLAGS/","docId":"gRPC/Messages/OBJECTVERSIONACTIVITYCATEGORYFLAGS/index"},{"type":"link","label":"OBJECTVERSIONFILEACTIVITYFLAGS","href":"/Frameworks/User-Interface-Extensibility-Framework/Reference/gRPC/Messages/OBJECTVERSIONFILEACTIVITYFLAGS/","docId":"gRPC/Messages/OBJECTVERSIONFILEACTIVITYFLAGS/index"},{"type":"link","label":"OBJECTVERSIONPROPERTYACTIVITYFLAGS","href":"/Frameworks/User-Interface-Extensibility-Framework/Reference/gRPC/Messages/OBJECTVERSIONPROPERTYACTIVITYFLAGS/","docId":"gRPC/Messages/OBJECTVERSIONPROPERTYACTIVITYFLAGS/index"},{"type":"link","label":"OBJTYPEFLAGS","href":"/Frameworks/User-Interface-Extensibility-Framework/Reference/gRPC/Messages/OBJTYPEFLAGS/","docId":"gRPC/Messages/OBJTYPEFLAGS/index"},{"type":"link","label":"OBJVERFLAGS","href":"/Frameworks/User-Interface-Extensibility-Framework/Reference/gRPC/Messages/OBJVERFLAGS/","docId":"gRPC/Messages/OBJVERFLAGS/index"},{"type":"link","label":"ObjFileSource","href":"/Frameworks/User-Interface-Extensibility-Framework/Reference/gRPC/Messages/ObjFileSource/","docId":"gRPC/Messages/ObjFileSource/index"},{"type":"category","label":"ObjFileSourceUnion","collapsible":true,"collapsed":true,"items":[{"type":"link","label":"BlankTemplateData","href":"/Frameworks/User-Interface-Extensibility-Framework/Reference/gRPC/Messages/ObjFileSourceUnion/BlankTemplateData/","docId":"gRPC/Messages/ObjFileSourceUnion/BlankTemplateData/index"},{"type":"link","label":"UndefinedSourceData","href":"/Frameworks/User-Interface-Extensibility-Framework/Reference/gRPC/Messages/ObjFileSourceUnion/UndefinedSourceData/","docId":"gRPC/Messages/ObjFileSourceUnion/UndefinedSourceData/index"},{"type":"link","label":"UploadedFileData","href":"/Frameworks/User-Interface-Extensibility-Framework/Reference/gRPC/Messages/ObjFileSourceUnion/UploadedFileData/","docId":"gRPC/Messages/ObjFileSourceUnion/UploadedFileData/index"},{"type":"link","label":"UploadedFilesData","href":"/Frameworks/User-Interface-Extensibility-Framework/Reference/gRPC/Messages/ObjFileSourceUnion/UploadedFilesData/","docId":"gRPC/Messages/ObjFileSourceUnion/UploadedFilesData/index"},{"type":"link","label":"UserDefinedTemplateData","href":"/Frameworks/User-Interface-Extensibility-Framework/Reference/gRPC/Messages/ObjFileSourceUnion/UserDefinedTemplateData/","docId":"gRPC/Messages/ObjFileSourceUnion/UserDefinedTemplateData/index"}],"href":"/Frameworks/User-Interface-Extensibility-Framework/Reference/gRPC/Messages/ObjFileSourceUnion/"},{"type":"link","label":"ObjFileVer","href":"/Frameworks/User-Interface-Extensibility-Framework/Reference/gRPC/Messages/ObjFileVer/","docId":"gRPC/Messages/ObjFileVer/index"},{"type":"link","label":"ObjID","href":"/Frameworks/User-Interface-Extensibility-Framework/Reference/gRPC/Messages/ObjID/","docId":"gRPC/Messages/ObjID/index"},{"type":"link","label":"ObjVer","href":"/Frameworks/User-Interface-Extensibility-Framework/Reference/gRPC/Messages/ObjVer/","docId":"gRPC/Messages/ObjVer/index"},{"type":"link","label":"ObjVerVersion","href":"/Frameworks/User-Interface-Extensibility-Framework/Reference/gRPC/Messages/ObjVerVersion/","docId":"gRPC/Messages/ObjVerVersion/index"},{"type":"link","label":"ObjVerWithProperties","href":"/Frameworks/User-Interface-Extensibility-Framework/Reference/gRPC/Messages/ObjVerWithProperties/","docId":"gRPC/Messages/ObjVerWithProperties/index"},{"type":"link","label":"ObjectClass","href":"/Frameworks/User-Interface-Extensibility-Framework/Reference/gRPC/Messages/ObjectClass/","docId":"gRPC/Messages/ObjectClass/index"},{"type":"link","label":"ObjectLevelInfo","href":"/Frameworks/User-Interface-Extensibility-Framework/Reference/gRPC/Messages/ObjectLevelInfo/","docId":"gRPC/Messages/ObjectLevelInfo/index"},{"type":"link","label":"ObjectPermissionsForClient","href":"/Frameworks/User-Interface-Extensibility-Framework/Reference/gRPC/Messages/ObjectPermissionsForClient/","docId":"gRPC/Messages/ObjectPermissionsForClient/index"},{"type":"link","label":"ObjectTypeIndexingDefinition","href":"/Frameworks/User-Interface-Extensibility-Framework/Reference/gRPC/Messages/ObjectTypeIndexingDefinition/","docId":"gRPC/Messages/ObjectTypeIndexingDefinition/index"},{"type":"link","label":"ObjectTypePermissionsForClient","href":"/Frameworks/User-Interface-Extensibility-Framework/Reference/gRPC/Messages/ObjectTypePermissionsForClient/","docId":"gRPC/Messages/ObjectTypePermissionsForClient/index"},{"type":"link","label":"ObjectTypeSearchCharacteristics","href":"/Frameworks/User-Interface-Extensibility-Framework/Reference/gRPC/Messages/ObjectTypeSearchCharacteristics/","docId":"gRPC/Messages/ObjectTypeSearchCharacteristics/index"},{"type":"link","label":"ObjectTypeTargetForBrowsing","href":"/Frameworks/User-Interface-Extensibility-Framework/Reference/gRPC/Messages/ObjectTypeTargetForBrowsing/","docId":"gRPC/Messages/ObjectTypeTargetForBrowsing/index"},{"type":"link","label":"ObjectVersion","href":"/Frameworks/User-Interface-Extensibility-Framework/Reference/gRPC/Messages/ObjectVersion/","docId":"gRPC/Messages/ObjectVersion/index"},{"type":"link","label":"ObjectVersionActivity","href":"/Frameworks/User-Interface-Extensibility-Framework/Reference/gRPC/Messages/ObjectVersionActivity/","docId":"gRPC/Messages/ObjectVersionActivity/index"},{"type":"link","label":"ObjectVersionActivityRequest","href":"/Frameworks/User-Interface-Extensibility-Framework/Reference/gRPC/Messages/ObjectVersionActivityRequest/","docId":"gRPC/Messages/ObjectVersionActivityRequest/index"},{"type":"link","label":"ObjectVersionActivityResponse","href":"/Frameworks/User-Interface-Extensibility-Framework/Reference/gRPC/Messages/ObjectVersionActivityResponse/","docId":"gRPC/Messages/ObjectVersionActivityResponse/index"},{"type":"link","label":"ObjectVersionAndPropertiesWithMetadata","href":"/Frameworks/User-Interface-Extensibility-Framework/Reference/gRPC/Messages/ObjectVersionAndPropertiesWithMetadata/","docId":"gRPC/Messages/ObjectVersionAndPropertiesWithMetadata/index"},{"type":"link","label":"ObjectVersionData","href":"/Frameworks/User-Interface-Extensibility-Framework/Reference/gRPC/Messages/ObjectVersionData/","docId":"gRPC/Messages/ObjectVersionData/index"},{"type":"link","label":"ObjectVersionDataRequest","href":"/Frameworks/User-Interface-Extensibility-Framework/Reference/gRPC/Messages/ObjectVersionDataRequest/","docId":"gRPC/Messages/ObjectVersionDataRequest/index"},{"type":"link","label":"ObjectVersionDataResult","href":"/Frameworks/User-Interface-Extensibility-Framework/Reference/gRPC/Messages/ObjectVersionDataResult/","docId":"gRPC/Messages/ObjectVersionDataResult/index"},{"type":"link","label":"ObjectVersionEx","href":"/Frameworks/User-Interface-Extensibility-Framework/Reference/gRPC/Messages/ObjectVersionEx/","docId":"gRPC/Messages/ObjectVersionEx/index"},{"type":"link","label":"ObjectVersionExWP","href":"/Frameworks/User-Interface-Extensibility-Framework/Reference/gRPC/Messages/ObjectVersionExWP/","docId":"gRPC/Messages/ObjectVersionExWP/index"},{"type":"link","label":"ObjectVersionFileActivity","href":"/Frameworks/User-Interface-Extensibility-Framework/Reference/gRPC/Messages/ObjectVersionFileActivity/","docId":"gRPC/Messages/ObjectVersionFileActivity/index"},{"type":"link","label":"ObjectVersionPropertyActivity","href":"/Frameworks/User-Interface-Extensibility-Framework/Reference/gRPC/Messages/ObjectVersionPropertyActivity/","docId":"gRPC/Messages/ObjectVersionPropertyActivity/index"},{"type":"link","label":"PROPERTYDEFFLAGS","href":"/Frameworks/User-Interface-Extensibility-Framework/Reference/gRPC/Messages/PROPERTYDEFFLAGS/","docId":"gRPC/Messages/PROPERTYDEFFLAGS/index"},{"type":"link","label":"PropertyDef","href":"/Frameworks/User-Interface-Extensibility-Framework/Reference/gRPC/Messages/PropertyDef/","docId":"gRPC/Messages/PropertyDef/index"},{"type":"link","label":"PropertyDefPermissionsForClient","href":"/Frameworks/User-Interface-Extensibility-Framework/Reference/gRPC/Messages/PropertyDefPermissionsForClient/","docId":"gRPC/Messages/PropertyDefPermissionsForClient/index"},{"type":"link","label":"PropertyValue","href":"/Frameworks/User-Interface-Extensibility-Framework/Reference/gRPC/Messages/PropertyValue/","docId":"gRPC/Messages/PropertyValue/index"},{"type":"link","label":"PropertyValueArray","href":"/Frameworks/User-Interface-Extensibility-Framework/Reference/gRPC/Messages/PropertyValueArray/","docId":"gRPC/Messages/PropertyValueArray/index"},{"type":"link","label":"PropertyValueSuggestion","href":"/Frameworks/User-Interface-Extensibility-Framework/Reference/gRPC/Messages/PropertyValueSuggestion/","docId":"gRPC/Messages/PropertyValueSuggestion/index"},{"type":"link","label":"PropertyValueWithMetadata","href":"/Frameworks/User-Interface-Extensibility-Framework/Reference/gRPC/Messages/PropertyValueWithMetadata/","docId":"gRPC/Messages/PropertyValueWithMetadata/index"},{"type":"link","label":"PropertyValueWithMetadataArray","href":"/Frameworks/User-Interface-Extensibility-Framework/Reference/gRPC/Messages/PropertyValueWithMetadataArray/","docId":"gRPC/Messages/PropertyValueWithMetadataArray/index"},{"type":"link","label":"RelationshipData","href":"/Frameworks/User-Interface-Extensibility-Framework/Reference/gRPC/Messages/RelationshipData/","docId":"gRPC/Messages/RelationshipData/index"},{"type":"link","label":"RelationshipGroup","href":"/Frameworks/User-Interface-Extensibility-Framework/Reference/gRPC/Messages/RelationshipGroup/","docId":"gRPC/Messages/RelationshipGroup/index"},{"type":"link","label":"SEARCHSTATUSFLAGS","href":"/Frameworks/User-Interface-Extensibility-Framework/Reference/gRPC/Messages/SEARCHSTATUSFLAGS/","docId":"gRPC/Messages/SEARCHSTATUSFLAGS/index"},{"type":"link","label":"SRPREQUESTFLAGS","href":"/Frameworks/User-Interface-Extensibility-Framework/Reference/gRPC/Messages/SRPREQUESTFLAGS/","docId":"gRPC/Messages/SRPREQUESTFLAGS/index"},{"type":"link","label":"STATEFLAGS","href":"/Frameworks/User-Interface-Extensibility-Framework/Reference/gRPC/Messages/STATEFLAGS/","docId":"gRPC/Messages/STATEFLAGS/index"},{"type":"link","label":"SearchCondition","href":"/Frameworks/User-Interface-Extensibility-Framework/Reference/gRPC/Messages/SearchCondition/","docId":"gRPC/Messages/SearchCondition/index"},{"type":"link","label":"SearchConditionArray","href":"/Frameworks/User-Interface-Extensibility-Framework/Reference/gRPC/Messages/SearchConditionArray/","docId":"gRPC/Messages/SearchConditionArray/index"},{"type":"link","label":"SearchDef","href":"/Frameworks/User-Interface-Extensibility-Framework/Reference/gRPC/Messages/SearchDef/","docId":"gRPC/Messages/SearchDef/index"},{"type":"link","label":"SearchFlags","href":"/Frameworks/User-Interface-Extensibility-Framework/Reference/gRPC/Messages/SearchFlags/","docId":"gRPC/Messages/SearchFlags/index"},{"type":"link","label":"SearchOutputInfo","href":"/Frameworks/User-Interface-Extensibility-Framework/Reference/gRPC/Messages/SearchOutputInfo/","docId":"gRPC/Messages/SearchOutputInfo/index"},{"type":"link","label":"SearchResultsItem","href":"/Frameworks/User-Interface-Extensibility-Framework/Reference/gRPC/Messages/SearchResultsItem/","docId":"gRPC/Messages/SearchResultsItem/index"},{"type":"link","label":"SearchResultsPageRequest","href":"/Frameworks/User-Interface-Extensibility-Framework/Reference/gRPC/Messages/SearchResultsPageRequest/","docId":"gRPC/Messages/SearchResultsPageRequest/index"},{"type":"link","label":"SearchResultsSorting","href":"/Frameworks/User-Interface-Extensibility-Framework/Reference/gRPC/Messages/SearchResultsSorting/","docId":"gRPC/Messages/SearchResultsSorting/index"},{"type":"link","label":"SearchTarget","href":"/Frameworks/User-Interface-Extensibility-Framework/Reference/gRPC/Messages/SearchTarget/","docId":"gRPC/Messages/SearchTarget/index"},{"type":"link","label":"ServerVaultCapabilities","href":"/Frameworks/User-Interface-Extensibility-Framework/Reference/gRPC/Messages/ServerVaultCapabilities/","docId":"gRPC/Messages/ServerVaultCapabilities/index"},{"type":"link","label":"SessionInfo","href":"/Frameworks/User-Interface-Extensibility-Framework/Reference/gRPC/Messages/SessionInfo/","docId":"gRPC/Messages/SessionInfo/index"},{"type":"link","label":"SetPropertiesParams","href":"/Frameworks/User-Interface-Extensibility-Framework/Reference/gRPC/Messages/SetPropertiesParams/","docId":"gRPC/Messages/SetPropertiesParams/index"},{"type":"link","label":"SortFlags","href":"/Frameworks/User-Interface-Extensibility-Framework/Reference/gRPC/Messages/SortFlags/","docId":"gRPC/Messages/SortFlags/index"},{"type":"link","label":"SortRule","href":"/Frameworks/User-Interface-Extensibility-Framework/Reference/gRPC/Messages/SortRule/","docId":"gRPC/Messages/SortRule/index"},{"type":"link","label":"SortRuleFlags","href":"/Frameworks/User-Interface-Extensibility-Framework/Reference/gRPC/Messages/SortRuleFlags/","docId":"gRPC/Messages/SortRuleFlags/index"},{"type":"link","label":"SortRuleValueArray","href":"/Frameworks/User-Interface-Extensibility-Framework/Reference/gRPC/Messages/SortRuleValueArray/","docId":"gRPC/Messages/SortRuleValueArray/index"},{"type":"link","label":"StateBasic","href":"/Frameworks/User-Interface-Extensibility-Framework/Reference/gRPC/Messages/StateBasic/","docId":"gRPC/Messages/StateBasic/index"},{"type":"link","label":"StateTransitionBasic","href":"/Frameworks/User-Interface-Extensibility-Framework/Reference/gRPC/Messages/StateTransitionBasic/","docId":"gRPC/Messages/StateTransitionBasic/index"},{"type":"link","label":"SubviewGroup","href":"/Frameworks/User-Interface-Extensibility-Framework/Reference/gRPC/Messages/SubviewGroup/","docId":"gRPC/Messages/SubviewGroup/index"},{"type":"link","label":"Template","href":"/Frameworks/User-Interface-Extensibility-Framework/Reference/gRPC/Messages/Template/","docId":"gRPC/Messages/Template/index"},{"type":"link","label":"TypedValue","href":"/Frameworks/User-Interface-Extensibility-Framework/Reference/gRPC/Messages/TypedValue/","docId":"gRPC/Messages/TypedValue/index"},{"type":"link","label":"TypedValueMetadata","href":"/Frameworks/User-Interface-Extensibility-Framework/Reference/gRPC/Messages/TypedValueMetadata/","docId":"gRPC/Messages/TypedValueMetadata/index"},{"type":"link","label":"TypedValueUnion","href":"/Frameworks/User-Interface-Extensibility-Framework/Reference/gRPC/Messages/TypedValueUnion/","docId":"gRPC/Messages/TypedValueUnion/index"},{"type":"link","label":"TypedValueUnionWithMetadata","href":"/Frameworks/User-Interface-Extensibility-Framework/Reference/gRPC/Messages/TypedValueUnionWithMetadata/","docId":"gRPC/Messages/TypedValueUnionWithMetadata/index"},{"type":"link","label":"TypedValueWithMetadata","href":"/Frameworks/User-Interface-Extensibility-Framework/Reference/gRPC/Messages/TypedValueWithMetadata/","docId":"gRPC/Messages/TypedValueWithMetadata/index"},{"type":"link","label":"UploadedFile","href":"/Frameworks/User-Interface-Extensibility-Framework/Reference/gRPC/Messages/UploadedFile/","docId":"gRPC/Messages/UploadedFile/index"},{"type":"link","label":"UploadedFileArray","href":"/Frameworks/User-Interface-Extensibility-Framework/Reference/gRPC/Messages/UploadedFileArray/","docId":"gRPC/Messages/UploadedFileArray/index"},{"type":"link","label":"VIEWFLAGS","href":"/Frameworks/User-Interface-Extensibility-Framework/Reference/gRPC/Messages/VIEWFLAGS/","docId":"gRPC/Messages/VIEWFLAGS/index"},{"type":"link","label":"ValueList","href":"/Frameworks/User-Interface-Extensibility-Framework/Reference/gRPC/Messages/ValueList/","docId":"gRPC/Messages/ValueList/index"},{"type":"link","label":"ValueListItem","href":"/Frameworks/User-Interface-Extensibility-Framework/Reference/gRPC/Messages/ValueListItem/","docId":"gRPC/Messages/ValueListItem/index"},{"type":"link","label":"VersionComment","href":"/Frameworks/User-Interface-Extensibility-Framework/Reference/gRPC/Messages/VersionComment/","docId":"gRPC/Messages/VersionComment/index"},{"type":"link","label":"VersionCommentArray","href":"/Frameworks/User-Interface-Extensibility-Framework/Reference/gRPC/Messages/VersionCommentArray/","docId":"gRPC/Messages/VersionCommentArray/index"},{"type":"link","label":"View","href":"/Frameworks/User-Interface-Extensibility-Framework/Reference/gRPC/Messages/View/","docId":"gRPC/Messages/View/index"},{"type":"link","label":"ViewLocation","href":"/Frameworks/User-Interface-Extensibility-Framework/Reference/gRPC/Messages/ViewLocation/","docId":"gRPC/Messages/ViewLocation/index"},{"type":"link","label":"ViewVisualization","href":"/Frameworks/User-Interface-Extensibility-Framework/Reference/gRPC/Messages/ViewVisualization/","docId":"gRPC/Messages/ViewVisualization/index"},{"type":"link","label":"Workflow","href":"/Frameworks/User-Interface-Extensibility-Framework/Reference/gRPC/Messages/Workflow/","docId":"gRPC/Messages/Workflow/index"},{"type":"link","label":"WorkflowBasic","href":"/Frameworks/User-Interface-Extensibility-Framework/Reference/gRPC/Messages/WorkflowBasic/","docId":"gRPC/Messages/WorkflowBasic/index"}],"href":"/Frameworks/User-Interface-Extensibility-Framework/Reference/gRPC/Messages/"}],"href":"/Frameworks/User-Interface-Extensibility-Framework/Reference/gRPC/"},{"type":"category","label":"Samples","collapsible":true,"collapsed":true,"items":[{"type":"link","label":"Hello, World","href":"/Frameworks/User-Interface-Extensibility-Framework/Reference/Samples/HelloWorld/","docId":"Samples/HelloWorld/index"},{"type":"link","label":"Commands","href":"/Frameworks/User-Interface-Extensibility-Framework/Reference/Samples/Commands/","docId":"Samples/Commands/index"},{"type":"link","label":"ShowNewObjectWindow","href":"/Frameworks/User-Interface-Extensibility-Framework/Reference/Samples/ShowNewObjectWindow With Blank and UserDefined Template/","docId":"Samples/ShowNewObjectWindow With Blank and UserDefined Template/index"},{"type":"link","label":"Built-in Command Demonstration","href":"/Frameworks/User-Interface-Extensibility-Framework/Reference/Samples/BuiltInCommands/","docId":"Samples/BuiltInCommands/index"},{"type":"link","label":"Taskbar Commands","href":"/Frameworks/User-Interface-Extensibility-Framework/Reference/Samples/TaskbarCommands/","docId":"Samples/TaskbarCommands/index"},{"type":"link","label":"PopUp Dashboard","href":"/Frameworks/User-Interface-Extensibility-Framework/Reference/Samples/PopupDashboard/","docId":"Samples/PopupDashboard/index"},{"type":"link","label":"PopUp Dashboard & Accent Color","href":"/Frameworks/User-Interface-Extensibility-Framework/Reference/Samples/PopUpDashboardWithAccentColor/","docId":"Samples/PopUpDashboardWithAccentColor/index"},{"type":"link","label":"ShellFrame & Dashboard","href":"/Frameworks/User-Interface-Extensibility-Framework/Reference/Samples/ShellFrameAndDashboard/","docId":"Samples/ShellFrameAndDashboard/index"},{"type":"link","label":"Assign to me UIX sample","href":"/Frameworks/User-Interface-Extensibility-Framework/Reference/Samples/AssignToMe/","docId":"Samples/AssignToMe/index"},{"type":"link","label":"Interacting with object operation events","href":"/Frameworks/User-Interface-Extensibility-Framework/Reference/Samples/ObjectOperationSupport/","docId":"Samples/ObjectOperationSupport/index"},{"type":"link","label":"Sandbox Attributes support","href":"/Frameworks/User-Interface-Extensibility-Framework/Reference/Samples/SandboxAttributesSupport/","docId":"Samples/SandboxAttributesSupport/index"},{"type":"link","label":"Search Folder Examples","href":"/Frameworks/User-Interface-Extensibility-Framework/Reference/Samples/SearchFolderExamples/","docId":"Samples/SearchFolderExamples/index"},{"type":"link","label":"Error Handling","href":"/Frameworks/User-Interface-Extensibility-Framework/Reference/Samples/ErrorHandling/","docId":"Samples/ErrorHandling/index"},{"type":"link","label":"Vault Messages Package","href":"/Frameworks/User-Interface-Extensibility-Framework/Reference/Samples/VaultMessagesPackage/","docId":"Samples/VaultMessagesPackage/index"}],"href":"/Frameworks/User-Interface-Extensibility-Framework/Reference/Samples/"},{"type":"category","label":"Upgrading applications","collapsible":true,"collapsed":true,"items":[{"type":"link","label":"Deprecated features and alternatives","href":"/Frameworks/User-Interface-Extensibility-Framework/Reference/Upgrading/deprecated_features","docId":"Upgrading/deprecated_features"}],"href":"/Frameworks/User-Interface-Extensibility-Framework/Reference/Upgrading/"}]},"docs":{"getting_started":{"id":"getting_started","title":"Getting Started","description":"Welcome to the documentation on the User Interface Extensibility Framework 2.0 (\\"UIXv2\\"). This framework allows developers to build client-side applications which can extend the M-Files client interface in supported clients.","sidebar":"tutorialSidebar"},"gRPC/Enums/AccessControlSubjectType/index":{"id":"gRPC/Enums/AccessControlSubjectType/index","title":"AccessControlSubjectType","description":"Indirect property ID level type enumeration.","sidebar":"tutorialSidebar"},"gRPC/Enums/ACLEnforcingMode/index":{"id":"gRPC/Enums/ACLEnforcingMode/index","title":"ACLEnforcingMode","description":"ACL enforcing modes.","sidebar":"tutorialSidebar"},"gRPC/Enums/AuthType/index":{"id":"gRPC/Enums/AuthType/index","title":"AuthType","description":"AuthType enumeration.","sidebar":"tutorialSidebar"},"gRPC/Enums/AutomaticValueType/index":{"id":"gRPC/Enums/AutomaticValueType/index","title":"AutomaticValueType","description":"Types of automatic values.","sidebar":"tutorialSidebar"},"gRPC/Enums/CallImportance/index":{"id":"gRPC/Enums/CallImportance/index","title":"CallImportance","description":"Used by MFServer to distinguish between incoming calls of different","sidebar":"tutorialSidebar"},"gRPC/Enums/ConditionType/index":{"id":"gRPC/Enums/ConditionType/index","title":"ConditionType","description":"Condition types enumeration.","sidebar":"tutorialSidebar"},"gRPC/Enums/ContentType/index":{"id":"gRPC/Enums/ContentType/index","title":"ContentType","description":"Content types (sub-datatypes).","sidebar":"tutorialSidebar"},"gRPC/Enums/DataFunction/index":{"id":"gRPC/Enums/DataFunction/index","title":"DataFunction","description":"Functions that operate on a property value, for example.","sidebar":"tutorialSidebar"},"gRPC/Enums/Datatype/index":{"id":"gRPC/Enums/Datatype/index","title":"Datatype","description":"Datatype enumeration.","sidebar":"tutorialSidebar"},"gRPC/Enums/EventType/index":{"id":"gRPC/Enums/EventType/index","title":"EventType","description":"Event type enumeration.","sidebar":"tutorialSidebar"},"gRPC/Enums/ExpressionType/index":{"id":"gRPC/Enums/ExpressionType/index","title":"ExpressionType","description":"Expression types.","sidebar":"tutorialSidebar"},"gRPC/Enums/ExtDBRefreshType/index":{"id":"gRPC/Enums/ExtDBRefreshType/index","title":"ExtDBRefreshType","description":"External database refresh type enumeration.","sidebar":"tutorialSidebar"},"gRPC/Enums/ExtIDStatus/index":{"id":"gRPC/Enums/ExtIDStatus/index","title":"ExtIDStatus","description":"ExtID status enumeration.","sidebar":"tutorialSidebar"},"gRPC/Enums/FileIDType/index":{"id":"gRPC/Enums/FileIDType/index","title":"FileIDType","description":"File id type.","sidebar":"tutorialSidebar"},"gRPC/Enums/FileSizePrecision/index":{"id":"gRPC/Enums/FileSizePrecision/index","title":"FileSizePrecision","description":"Enumeration for specifying the file size precision settings.","sidebar":"tutorialSidebar"},"gRPC/Enums/FileValueType/index":{"id":"gRPC/Enums/FileValueType/index","title":"FileValueType","description":"Enumeration for different conditions regarding file information.","sidebar":"tutorialSidebar"},"gRPC/Enums/FileVerType/index":{"id":"gRPC/Enums/FileVerType/index","title":"FileVerType","description":"File version type.","sidebar":"tutorialSidebar"},"gRPC/Enums/FolderListingAlgorithm/index":{"id":"gRPC/Enums/FolderListingAlgorithm/index","title":"FolderListingAlgorithm","description":"Folder listing algorithm. Used to optimize property folder listings on intermediate view levels.","sidebar":"tutorialSidebar"},"gRPC/Enums/FolderType/index":{"id":"gRPC/Enums/FolderType/index","title":"FolderType","description":"Folder type enumeration.","sidebar":"tutorialSidebar"},"gRPC/Enums/FormattingType/index":{"id":"gRPC/Enums/FormattingType/index","title":"FormattingType","description":"Formatting types.","sidebar":"tutorialSidebar"},"gRPC/Enums/index":{"id":"gRPC/Enums/index","title":"Enums","description":"","sidebar":"tutorialSidebar"},"gRPC/Enums/IndirectPropertyIDLevelType/index":{"id":"gRPC/Enums/IndirectPropertyIDLevelType/index","title":"IndirectPropertyIDLevelType","description":"Indirect property ID level type enumeration.","sidebar":"tutorialSidebar"},"gRPC/Enums/MetadataStructureItem/index":{"id":"gRPC/Enums/MetadataStructureItem/index","title":"MetadataStructureItem","description":"","sidebar":"tutorialSidebar"},"gRPC/Enums/NACLType/index":{"id":"gRPC/Enums/NACLType/index","title":"NACLType","description":"Each named ACL belongs to exactly one type. Types are defined as bit flags so that multiple types can be combined with bitwise OR for filtering purposes, such as in GetNamedACLs.","sidebar":"tutorialSidebar"},"gRPC/Enums/NamedValueType/index":{"id":"gRPC/Enums/NamedValueType/index","title":"NamedValueType","description":"Enumeration of possible named value types.","sidebar":"tutorialSidebar"},"gRPC/Enums/ObjectVersionDataRequestErrorTolerance/index":{"id":"gRPC/Enums/ObjectVersionDataRequestErrorTolerance/index","title":"ObjectVersionDataRequestErrorTolerance","description":"Error tolerance enumeration for object version data request.","sidebar":"tutorialSidebar"},"gRPC/Enums/ObjectVersionDataRequestIdentityType/index":{"id":"gRPC/Enums/ObjectVersionDataRequestIdentityType/index","title":"ObjectVersionDataRequestIdentityType","description":"Identity type enumeration for object version data request. Specifies how objects with changed identities are handled.","sidebar":"tutorialSidebar"},"gRPC/Enums/ObjectVersionDataRequestVersionType/index":{"id":"gRPC/Enums/ObjectVersionDataRequestVersionType/index","title":"ObjectVersionDataRequestVersionType","description":"Version type enumeration for object version data request.","sidebar":"tutorialSidebar"},"gRPC/Enums/ObjFileSourceType/index":{"id":"gRPC/Enums/ObjFileSourceType/index","title":"ObjFileSourceType","description":"Object file source type enumeration.","sidebar":"tutorialSidebar"},"gRPC/Enums/ObjVerVersionType/index":{"id":"gRPC/Enums/ObjVerVersionType/index","title":"ObjVerVersionType","description":"Indirect property ID level type enumeration.","sidebar":"tutorialSidebar"},"gRPC/Enums/ParentChildBehavior/index":{"id":"gRPC/Enums/ParentChildBehavior/index","title":"ParentChildBehavior","description":"Parent-child behavior enumeration (affects searching and view levels).","sidebar":"tutorialSidebar"},"gRPC/Enums/PermissionsExpressionType/index":{"id":"gRPC/Enums/PermissionsExpressionType/index","title":"PermissionsExpressionType","description":"Permission expression types.","sidebar":"tutorialSidebar"},"gRPC/Enums/PropertySetByType/index":{"id":"gRPC/Enums/PropertySetByType/index","title":"PropertySetByType","description":"Property set by enumeration","sidebar":"tutorialSidebar"},"gRPC/Enums/PseudoUserResolutionMode/index":{"id":"gRPC/Enums/PseudoUserResolutionMode/index","title":"PseudoUserResolutionMode","description":"Pseudo-user resolution mode enumeration.","sidebar":"tutorialSidebar"},"gRPC/Enums/ReferenceDirection/index":{"id":"gRPC/Enums/ReferenceDirection/index","title":"ReferenceDirection","description":"Reference direction enumeration.","sidebar":"tutorialSidebar"},"gRPC/Enums/RelationshipDirection/index":{"id":"gRPC/Enums/RelationshipDirection/index","title":"RelationshipDirection","description":"Relationships direction enumeration.","sidebar":"tutorialSidebar"},"gRPC/Enums/SearchMode/index":{"id":"gRPC/Enums/SearchMode/index","title":"SearchMode","description":"Search mode enumeration.","sidebar":"tutorialSidebar"},"gRPC/Enums/StatusType/index":{"id":"gRPC/Enums/StatusType/index","title":"StatusType","description":"Enumeration for different conditions to status information.","sidebar":"tutorialSidebar"},"gRPC/Enums/UpdateType/index":{"id":"gRPC/Enums/UpdateType/index","title":"UpdateType","description":"Update type enumeration.","sidebar":"tutorialSidebar"},"gRPC/Enums/ValidationType/index":{"id":"gRPC/Enums/ValidationType/index","title":"ValidationType","description":"Validation types.","sidebar":"tutorialSidebar"},"gRPC/Enums/ViewType/index":{"id":"gRPC/Enums/ViewType/index","title":"ViewType","description":"View type enumeration.","sidebar":"tutorialSidebar"},"gRPC/Enums/VLSortingType/index":{"id":"gRPC/Enums/VLSortingType/index","title":"VLSortingType","description":"Value list sorting types.","sidebar":"tutorialSidebar"},"gRPC/gRPC":{"id":"gRPC/gRPC","title":"Vault API Reference Guide","description":"The M-Files User Interface Extensibility Framework 2.0 leverages the structures and methods defined within the M-Files gRPC API, thus has a slightly different structure and approach to other development environments such as the Vault Application Framework.","sidebar":"tutorialSidebar"},"gRPC/Interfaces/index":{"id":"gRPC/Interfaces/index","title":"Interfaces","description":"NamedACLsOperations","sidebar":"tutorialSidebar"},"gRPC/Interfaces/NamedACLsOperations/GetNamedACLs/index":{"id":"gRPC/Interfaces/NamedACLsOperations/GetNamedACLs/index","title":"GetNamedACLs","description":"Syntax","sidebar":"tutorialSidebar"},"gRPC/Interfaces/NamedACLsOperations/index":{"id":"gRPC/Interfaces/NamedACLsOperations/index","title":"NamedACLsOperations","description":"Methods","sidebar":"tutorialSidebar"},"gRPC/Interfaces/NamedValueStorageOperations/GetNamedValues/index":{"id":"gRPC/Interfaces/NamedValueStorageOperations/GetNamedValues/index","title":"GetNamedValues","description":"Syntax","sidebar":"tutorialSidebar"},"gRPC/Interfaces/NamedValueStorageOperations/index":{"id":"gRPC/Interfaces/NamedValueStorageOperations/index","title":"NamedValueStorageOperations","description":"Methods","sidebar":"tutorialSidebar"},"gRPC/Interfaces/NamedValueStorageOperations/RemoveNamedValues/index":{"id":"gRPC/Interfaces/NamedValueStorageOperations/RemoveNamedValues/index","title":"RemoveNamedValues","description":"Syntax","sidebar":"tutorialSidebar"},"gRPC/Interfaces/NamedValueStorageOperations/SetNamedValues/index":{"id":"gRPC/Interfaces/NamedValueStorageOperations/SetNamedValues/index","title":"SetNamedValues","description":"Syntax","sidebar":"tutorialSidebar"},"gRPC/Interfaces/ObjectOperations/AddObjectFile/index":{"id":"gRPC/Interfaces/ObjectOperations/AddObjectFile/index","title":"AddObjectFile","description":"Syntax","sidebar":"tutorialSidebar"},"gRPC/Interfaces/ObjectOperations/AddObjectWithFiles/index":{"id":"gRPC/Interfaces/ObjectOperations/AddObjectWithFiles/index","title":"AddObjectWithFiles","description":"Syntax","sidebar":"tutorialSidebar"},"gRPC/Interfaces/ObjectOperations/ChangeSecurity/index":{"id":"gRPC/Interfaces/ObjectOperations/ChangeSecurity/index","title":"ChangeSecurity","description":"Syntax","sidebar":"tutorialSidebar"},"gRPC/Interfaces/ObjectOperations/CheckInMultiple/index":{"id":"gRPC/Interfaces/ObjectOperations/CheckInMultiple/index","title":"CheckInMultiple","description":"Syntax","sidebar":"tutorialSidebar"},"gRPC/Interfaces/ObjectOperations/CheckOutMultiple/index":{"id":"gRPC/Interfaces/ObjectOperations/CheckOutMultiple/index","title":"CheckOutMultiple","description":"Syntax","sidebar":"tutorialSidebar"},"gRPC/Interfaces/ObjectOperations/DestroyObjects/index":{"id":"gRPC/Interfaces/ObjectOperations/DestroyObjects/index","title":"DestroyObjects","description":"Syntax","sidebar":"tutorialSidebar"},"gRPC/Interfaces/ObjectOperations/FollowObject/index":{"id":"gRPC/Interfaces/ObjectOperations/FollowObject/index","title":"FollowObject","description":"Syntax","sidebar":"tutorialSidebar"},"gRPC/Interfaces/ObjectOperations/GetAutomaticMetadata/index":{"id":"gRPC/Interfaces/ObjectOperations/GetAutomaticMetadata/index","title":"GetAutomaticMetadata","description":"Syntax","sidebar":"tutorialSidebar"},"gRPC/Interfaces/ObjectOperations/GetDocEventSubscriptions/index":{"id":"gRPC/Interfaces/ObjectOperations/GetDocEventSubscriptions/index","title":"GetDocEventSubscriptions","description":"Syntax","sidebar":"tutorialSidebar"},"gRPC/Interfaces/ObjectOperations/GetEffectivePermissions/index":{"id":"gRPC/Interfaces/ObjectOperations/GetEffectivePermissions/index","title":"GetEffectivePermissions","description":"Syntax","sidebar":"tutorialSidebar"},"gRPC/Interfaces/ObjectOperations/GetLatestFileVersion/index":{"id":"gRPC/Interfaces/ObjectOperations/GetLatestFileVersion/index","title":"GetLatestFileVersion","description":"Syntax","sidebar":"tutorialSidebar"},"gRPC/Interfaces/ObjectOperations/GetLatestObjectVersion/index":{"id":"gRPC/Interfaces/ObjectOperations/GetLatestObjectVersion/index","title":"GetLatestObjectVersion","description":"Syntax","sidebar":"tutorialSidebar"},"gRPC/Interfaces/ObjectOperations/GetObjectDataOfMultipleObjects/index":{"id":"gRPC/Interfaces/ObjectOperations/GetObjectDataOfMultipleObjects/index","title":"GetObjectDataOfMultipleObjects","description":"Syntax","sidebar":"tutorialSidebar"},"gRPC/Interfaces/ObjectOperations/GetObjectFiles/index":{"id":"gRPC/Interfaces/ObjectOperations/GetObjectFiles/index","title":"GetObjectFiles","description":"Syntax","sidebar":"tutorialSidebar"},"gRPC/Interfaces/ObjectOperations/GetObjectHistory2/index":{"id":"gRPC/Interfaces/ObjectOperations/GetObjectHistory2/index","title":"GetObjectHistory2","description":"Syntax","sidebar":"tutorialSidebar"},"gRPC/Interfaces/ObjectOperations/GetObjIDByGUID/index":{"id":"gRPC/Interfaces/ObjectOperations/GetObjIDByGUID/index","title":"GetObjIDByGUID","description":"Syntax","sidebar":"tutorialSidebar"},"gRPC/Interfaces/ObjectOperations/GetTemplates/index":{"id":"gRPC/Interfaces/ObjectOperations/GetTemplates/index","title":"GetTemplates","description":"Syntax","sidebar":"tutorialSidebar"},"gRPC/Interfaces/ObjectOperations/GetWorkflowsForClient/index":{"id":"gRPC/Interfaces/ObjectOperations/GetWorkflowsForClient/index","title":"GetWorkflowsForClient","description":"Syntax","sidebar":"tutorialSidebar"},"gRPC/Interfaces/ObjectOperations/GetWorkflowStateHistory/index":{"id":"gRPC/Interfaces/ObjectOperations/GetWorkflowStateHistory/index","title":"GetWorkflowStateHistory","description":"Syntax","sidebar":"tutorialSidebar"},"gRPC/Interfaces/ObjectOperations/GetWorkflowStates/index":{"id":"gRPC/Interfaces/ObjectOperations/GetWorkflowStates/index","title":"GetWorkflowStates","description":"Syntax","sidebar":"tutorialSidebar"},"gRPC/Interfaces/ObjectOperations/GetWorkflowStatesAndTransitions/index":{"id":"gRPC/Interfaces/ObjectOperations/GetWorkflowStatesAndTransitions/index","title":"GetWorkflowStatesAndTransitions","description":"Syntax","sidebar":"tutorialSidebar"},"gRPC/Interfaces/ObjectOperations/index":{"id":"gRPC/Interfaces/ObjectOperations/index","title":"ObjectOperations","description":"Methods","sidebar":"tutorialSidebar"},"gRPC/Interfaces/ObjectOperations/PromoteUnmanagedObject/index":{"id":"gRPC/Interfaces/ObjectOperations/PromoteUnmanagedObject/index","title":"PromoteUnmanagedObject","description":"Syntax","sidebar":"tutorialSidebar"},"gRPC/Interfaces/ObjectOperations/RemoveObjectFile/index":{"id":"gRPC/Interfaces/ObjectOperations/RemoveObjectFile/index","title":"RemoveObjectFile","description":"Syntax","sidebar":"tutorialSidebar"},"gRPC/Interfaces/ObjectOperations/RemoveObjects/index":{"id":"gRPC/Interfaces/ObjectOperations/RemoveObjects/index","title":"RemoveObjects","description":"Syntax","sidebar":"tutorialSidebar"},"gRPC/Interfaces/ObjectOperations/RenameObjectFile/index":{"id":"gRPC/Interfaces/ObjectOperations/RenameObjectFile/index","title":"RenameObjectFile","description":"Syntax","sidebar":"tutorialSidebar"},"gRPC/Interfaces/ObjectOperations/SetObjectLevelProperty/index":{"id":"gRPC/Interfaces/ObjectOperations/SetObjectLevelProperty/index","title":"SetObjectLevelProperty","description":"Syntax","sidebar":"tutorialSidebar"},"gRPC/Interfaces/ObjectOperations/SetPropertiesMultiple/index":{"id":"gRPC/Interfaces/ObjectOperations/SetPropertiesMultiple/index","title":"SetPropertiesMultiple","description":"Syntax","sidebar":"tutorialSidebar"},"gRPC/Interfaces/ObjectOperations/UndoCheckoutMultiple/index":{"id":"gRPC/Interfaces/ObjectOperations/UndoCheckoutMultiple/index","title":"UndoCheckoutMultiple","description":"Syntax","sidebar":"tutorialSidebar"},"gRPC/Interfaces/ObjectOperations/UploadExistingFiles/index":{"id":"gRPC/Interfaces/ObjectOperations/UploadExistingFiles/index","title":"UploadExistingFiles","description":"Syntax","sidebar":"tutorialSidebar"},"gRPC/Interfaces/ObjectTypesOperations/GetObjectTypes/index":{"id":"gRPC/Interfaces/ObjectTypesOperations/GetObjectTypes/index","title":"GetObjectTypes","description":"Syntax","sidebar":"tutorialSidebar"},"gRPC/Interfaces/ObjectTypesOperations/index":{"id":"gRPC/Interfaces/ObjectTypesOperations/index","title":"ObjectTypesOperations","description":"Methods","sidebar":"tutorialSidebar"},"gRPC/Interfaces/PropertyDefsOperations/GetObjectClassesAndGroups/index":{"id":"gRPC/Interfaces/PropertyDefsOperations/GetObjectClassesAndGroups/index","title":"GetObjectClassesAndGroups","description":"Syntax","sidebar":"tutorialSidebar"},"gRPC/Interfaces/PropertyDefsOperations/GetPropertyDefs/index":{"id":"gRPC/Interfaces/PropertyDefsOperations/GetPropertyDefs/index","title":"GetPropertyDefs","description":"Syntax","sidebar":"tutorialSidebar"},"gRPC/Interfaces/PropertyDefsOperations/index":{"id":"gRPC/Interfaces/PropertyDefsOperations/index","title":"PropertyDefsOperations","description":"Methods","sidebar":"tutorialSidebar"},"gRPC/Interfaces/SearchOperations/GetFolderContents/index":{"id":"gRPC/Interfaces/SearchOperations/GetFolderContents/index","title":"GetFolderContents","description":"Syntax","sidebar":"tutorialSidebar"},"gRPC/Interfaces/SearchOperations/index":{"id":"gRPC/Interfaces/SearchOperations/index","title":"SearchOperations","description":"Methods","sidebar":"tutorialSidebar"},"gRPC/Interfaces/SearchOperations/SearchObjects/index":{"id":"gRPC/Interfaces/SearchOperations/SearchObjects/index","title":"SearchObjects","description":"Syntax","sidebar":"tutorialSidebar"},"gRPC/Interfaces/ValueListsOperations/GetValueListItemsWithPermissions/index":{"id":"gRPC/Interfaces/ValueListsOperations/GetValueListItemsWithPermissions/index","title":"GetValueListItemsWithPermissions","description":"Syntax","sidebar":"tutorialSidebar"},"gRPC/Interfaces/ValueListsOperations/GetValueLists/index":{"id":"gRPC/Interfaces/ValueListsOperations/GetValueLists/index","title":"GetValueLists","description":"Syntax","sidebar":"tutorialSidebar"},"gRPC/Interfaces/ValueListsOperations/index":{"id":"gRPC/Interfaces/ValueListsOperations/index","title":"ValueListsOperations","description":"Methods","sidebar":"tutorialSidebar"},"gRPC/Interfaces/ValueListsOperations/SearchValueListItemsWithPermissions/index":{"id":"gRPC/Interfaces/ValueListsOperations/SearchValueListItemsWithPermissions/index","title":"SearchValueListItemsWithPermissions","description":"Syntax","sidebar":"tutorialSidebar"},"gRPC/Interfaces/VaultExtensionMethodsOperations/index":{"id":"gRPC/Interfaces/VaultExtensionMethodsOperations/index","title":"VaultExtensionMethodsOperations","description":"Methods","sidebar":"tutorialSidebar"},"gRPC/Interfaces/VaultExtensionMethodsOperations/IsExtensionMethodAvailable/index":{"id":"gRPC/Interfaces/VaultExtensionMethodsOperations/IsExtensionMethodAvailable/index","title":"IsExtensionMethodAvailable","description":"Syntax","sidebar":"tutorialSidebar"},"gRPC/Interfaces/VaultExtensionMethodsOperations/RunExtensionMethod/index":{"id":"gRPC/Interfaces/VaultExtensionMethodsOperations/RunExtensionMethod/index","title":"RunExtensionMethod","description":"Syntax","sidebar":"tutorialSidebar"},"gRPC/Interfaces/VaultOperations/GetMetadataStructureItemIdByAlias/index":{"id":"gRPC/Interfaces/VaultOperations/GetMetadataStructureItemIdByAlias/index","title":"GetMetadataStructureItemIdByAlias","description":"Syntax","sidebar":"tutorialSidebar"},"gRPC/Interfaces/VaultOperations/GetMetadataStructureItemIdByGUID/index":{"id":"gRPC/Interfaces/VaultOperations/GetMetadataStructureItemIdByGUID/index","title":"GetMetadataStructureItemIdByGUID","description":"Syntax","sidebar":"tutorialSidebar"},"gRPC/Interfaces/VaultOperations/index":{"id":"gRPC/Interfaces/VaultOperations/index","title":"VaultOperations","description":"Methods","sidebar":"tutorialSidebar"},"gRPC/Interfaces/ViewsOperations/DeleteView/index":{"id":"gRPC/Interfaces/ViewsOperations/DeleteView/index","title":"DeleteView","description":"Syntax","sidebar":"tutorialSidebar"},"gRPC/Interfaces/ViewsOperations/GetViews/index":{"id":"gRPC/Interfaces/ViewsOperations/GetViews/index","title":"GetViews","description":"Syntax","sidebar":"tutorialSidebar"},"gRPC/Interfaces/ViewsOperations/index":{"id":"gRPC/Interfaces/ViewsOperations/index","title":"ViewsOperations","description":"Methods","sidebar":"tutorialSidebar"},"gRPC/Messages/AccessControlEntry/index":{"id":"gRPC/Messages/AccessControlEntry/index","title":"AccessControlEntry","description":"Example","sidebar":"tutorialSidebar"},"gRPC/Messages/AccessControlList/index":{"id":"gRPC/Messages/AccessControlList/index","title":"AccessControlList","description":"Example","sidebar":"tutorialSidebar"},"gRPC/Messages/AccessControlListComponent/index":{"id":"gRPC/Messages/AccessControlListComponent/index","title":"AccessControlListComponent","description":"Example","sidebar":"tutorialSidebar"},"gRPC/Messages/AccessControlListComponentKey/index":{"id":"gRPC/Messages/AccessControlListComponentKey/index","title":"AccessControlListComponentKey","description":"Example","sidebar":"tutorialSidebar"},"gRPC/Messages/AccessControlListComponentMapEntry/index":{"id":"gRPC/Messages/AccessControlListComponentMapEntry/index","title":"AccessControlListComponentMapEntry","description":"Example","sidebar":"tutorialSidebar"},"gRPC/Messages/ACCESSCONTROLLISTCOMPONENTSTATUSFLAGS/index":{"id":"gRPC/Messages/ACCESSCONTROLLISTCOMPONENTSTATUSFLAGS/index","title":"ACCESSCONTROLLISTCOMPONENTSTATUSFLAGS","description":"Example","sidebar":"tutorialSidebar"},"gRPC/Messages/AccessControlPseudoUserSubject/index":{"id":"gRPC/Messages/AccessControlPseudoUserSubject/index","title":"AccessControlPseudoUserSubject","description":"Example","sidebar":"tutorialSidebar"},"gRPC/Messages/AccessControlSubject/index":{"id":"gRPC/Messages/AccessControlSubject/index","title":"AccessControlSubject","description":"Example","sidebar":"tutorialSidebar"},"gRPC/Messages/AccessControlSubjectUnion/index":{"id":"gRPC/Messages/AccessControlSubjectUnion/index","title":"AccessControlSubjectUnion","description":"Examples","sidebar":"tutorialSidebar"},"gRPC/Messages/ACTIONFLAGS/index":{"id":"gRPC/Messages/ACTIONFLAGS/index","title":"ACTIONFLAGS","description":"Example","sidebar":"tutorialSidebar"},"gRPC/Messages/AssociatedPropertyDef/index":{"id":"gRPC/Messages/AssociatedPropertyDef/index","title":"AssociatedPropertyDef","description":"Example","sidebar":"tutorialSidebar"},"gRPC/Messages/AutomaticMetadataRequest/index":{"id":"gRPC/Messages/AutomaticMetadataRequest/index","title":"AutomaticMetadataRequest","description":"Example","sidebar":"tutorialSidebar"},"gRPC/Messages/AutomaticMetadataResult/index":{"id":"gRPC/Messages/AutomaticMetadataResult/index","title":"AutomaticMetadataResult","description":"Example","sidebar":"tutorialSidebar"},"gRPC/Messages/AutomaticPermissions/index":{"id":"gRPC/Messages/AutomaticPermissions/index","title":"AutomaticPermissions","description":"Example","sidebar":"tutorialSidebar"},"gRPC/Messages/Bytes/index":{"id":"gRPC/Messages/Bytes/index","title":"Bytes","description":"Example","sidebar":"tutorialSidebar"},"gRPC/Messages/ClassGroup/index":{"id":"gRPC/Messages/ClassGroup/index","title":"ClassGroup","description":"Example","sidebar":"tutorialSidebar"},"gRPC/Messages/ClassPermissionsForClient/index":{"id":"gRPC/Messages/ClassPermissionsForClient/index","title":"ClassPermissionsForClient","description":"Example","sidebar":"tutorialSidebar"},"gRPC/Messages/DataFunctionCall/index":{"id":"gRPC/Messages/DataFunctionCall/index","title":"DataFunctionCall","description":"Example","sidebar":"tutorialSidebar"},"gRPC/Messages/DataFunctionUnion/DateData/index":{"id":"gRPC/Messages/DataFunctionUnion/DateData/index","title":"DateData","description":"Example","sidebar":"tutorialSidebar"},"gRPC/Messages/DataFunctionUnion/DaysFromData/index":{"id":"gRPC/Messages/DataFunctionUnion/DaysFromData/index","title":"DaysFromData","description":"Example","sidebar":"tutorialSidebar"},"gRPC/Messages/DataFunctionUnion/DaysToData/index":{"id":"gRPC/Messages/DataFunctionUnion/DaysToData/index","title":"DaysToData","description":"Example","sidebar":"tutorialSidebar"},"gRPC/Messages/DataFunctionUnion/index":{"id":"gRPC/Messages/DataFunctionUnion/index","title":"DataFunctionUnion","description":"Examples","sidebar":"tutorialSidebar"},"gRPC/Messages/DataFunctionUnion/InitialCharacterGroupData/index":{"id":"gRPC/Messages/DataFunctionUnion/InitialCharacterGroupData/index","title":"InitialCharacterGroupData","description":"Example","sidebar":"tutorialSidebar"},"gRPC/Messages/DataFunctionUnion/IntegerSegmentData/index":{"id":"gRPC/Messages/DataFunctionUnion/IntegerSegmentData/index","title":"IntegerSegmentData","description":"Example","sidebar":"tutorialSidebar"},"gRPC/Messages/DataFunctionUnion/LeftCharactersData/index":{"id":"gRPC/Messages/DataFunctionUnion/LeftCharactersData/index","title":"LeftCharactersData","description":"Example","sidebar":"tutorialSidebar"},"gRPC/Messages/DataFunctionUnion/MonthData/index":{"id":"gRPC/Messages/DataFunctionUnion/MonthData/index","title":"MonthData","description":"Example","sidebar":"tutorialSidebar"},"gRPC/Messages/DataFunctionUnion/NoOpData/index":{"id":"gRPC/Messages/DataFunctionUnion/NoOpData/index","title":"NoOpData","description":"Example","sidebar":"tutorialSidebar"},"gRPC/Messages/DataFunctionUnion/YearAndMonthData/index":{"id":"gRPC/Messages/DataFunctionUnion/YearAndMonthData/index","title":"YearAndMonthData","description":"Example","sidebar":"tutorialSidebar"},"gRPC/Messages/DataFunctionUnion/YearData/index":{"id":"gRPC/Messages/DataFunctionUnion/YearData/index","title":"YearData","description":"Example","sidebar":"tutorialSidebar"},"gRPC/Messages/DefaultReplicationConfiguration/index":{"id":"gRPC/Messages/DefaultReplicationConfiguration/index","title":"DefaultReplicationConfiguration","description":"Example","sidebar":"tutorialSidebar"},"gRPC/Messages/DocClassGroup/index":{"id":"gRPC/Messages/DocClassGroup/index","title":"DocClassGroup","description":"Example","sidebar":"tutorialSidebar"},"gRPC/Messages/EffectivePermissions/index":{"id":"gRPC/Messages/EffectivePermissions/index","title":"EffectivePermissions","description":"Example","sidebar":"tutorialSidebar"},"gRPC/Messages/ErrorInfo/index":{"id":"gRPC/Messages/ErrorInfo/index","title":"ErrorInfo","description":"Example","sidebar":"tutorialSidebar"},"gRPC/Messages/EventSubscription/index":{"id":"gRPC/Messages/EventSubscription/index","title":"EventSubscription","description":"Example","sidebar":"tutorialSidebar"},"gRPC/Messages/Expression/index":{"id":"gRPC/Messages/Expression/index","title":"Expression","description":"Helper Methods and Properties","sidebar":"tutorialSidebar"},"gRPC/Messages/EXPRESSIONEXFLAGS/index":{"id":"gRPC/Messages/EXPRESSIONEXFLAGS/index","title":"EXPRESSIONEXFLAGS","description":"Example","sidebar":"tutorialSidebar"},"gRPC/Messages/ExpressionUnion/AnyFieldData/index":{"id":"gRPC/Messages/ExpressionUnion/AnyFieldData/index","title":"AnyFieldData","description":"Example","sidebar":"tutorialSidebar"},"gRPC/Messages/ExpressionUnion/FileValueData/index":{"id":"gRPC/Messages/ExpressionUnion/FileValueData/index","title":"FileValueData","description":"Example","sidebar":"tutorialSidebar"},"gRPC/Messages/ExpressionUnion/IdSegmentData/index":{"id":"gRPC/Messages/ExpressionUnion/IdSegmentData/index","title":"IdSegmentData","description":"Example","sidebar":"tutorialSidebar"},"gRPC/Messages/ExpressionUnion/index":{"id":"gRPC/Messages/ExpressionUnion/index","title":"ExpressionUnion","description":"Examples","sidebar":"tutorialSidebar"},"gRPC/Messages/ExpressionUnion/PermissionsData/index":{"id":"gRPC/Messages/ExpressionUnion/PermissionsData/index","title":"PermissionsData","description":"Example","sidebar":"tutorialSidebar"},"gRPC/Messages/ExpressionUnion/PropertyValueData/index":{"id":"gRPC/Messages/ExpressionUnion/PropertyValueData/index","title":"PropertyValueData","description":"Example","sidebar":"tutorialSidebar"},"gRPC/Messages/ExpressionUnion/StatusValueData/index":{"id":"gRPC/Messages/ExpressionUnion/StatusValueData/index","title":"StatusValueData","description":"Example","sidebar":"tutorialSidebar"},"gRPC/Messages/ExpressionUnion/TypedValueData/index":{"id":"gRPC/Messages/ExpressionUnion/TypedValueData/index","title":"TypedValueData","description":"Example","sidebar":"tutorialSidebar"},"gRPC/Messages/ExpressionUnion/UninitializedData/index":{"id":"gRPC/Messages/ExpressionUnion/UninitializedData/index","title":"UninitializedData","description":"Example","sidebar":"tutorialSidebar"},"gRPC/Messages/ExternalRepositoryID/index":{"id":"gRPC/Messages/ExternalRepositoryID/index","title":"ExternalRepositoryID","description":"Example","sidebar":"tutorialSidebar"},"gRPC/Messages/ExternalView/index":{"id":"gRPC/Messages/ExternalView/index","title":"ExternalView","description":"Example","sidebar":"tutorialSidebar"},"gRPC/Messages/ExtObjectInfo/index":{"id":"gRPC/Messages/ExtObjectInfo/index","title":"ExtObjectInfo","description":"Example","sidebar":"tutorialSidebar"},"gRPC/Messages/File/index":{"id":"gRPC/Messages/File/index","title":"File","description":"Example","sidebar":"tutorialSidebar"},"gRPC/Messages/FileID/index":{"id":"gRPC/Messages/FileID/index","title":"FileID","description":"Example","sidebar":"tutorialSidebar"},"gRPC/Messages/FileVer/index":{"id":"gRPC/Messages/FileVer/index","title":"FileVer","description":"Helper Methods and Properties","sidebar":"tutorialSidebar"},"gRPC/Messages/Folder/index":{"id":"gRPC/Messages/Folder/index","title":"Folder","description":"Example","sidebar":"tutorialSidebar"},"gRPC/Messages/FOLDERCAPABILITYFLAGS/index":{"id":"gRPC/Messages/FOLDERCAPABILITYFLAGS/index","title":"FOLDERCAPABILITYFLAGS","description":"Example","sidebar":"tutorialSidebar"},"gRPC/Messages/FolderInfoUnion/AnyFolderData/index":{"id":"gRPC/Messages/FolderInfoUnion/AnyFolderData/index","title":"AnyFolderData","description":"Example","sidebar":"tutorialSidebar"},"gRPC/Messages/FolderInfoUnion/ExternalViewFolderData/index":{"id":"gRPC/Messages/FolderInfoUnion/ExternalViewFolderData/index","title":"ExternalViewFolderData","description":"Example","sidebar":"tutorialSidebar"},"gRPC/Messages/FolderInfoUnion/index":{"id":"gRPC/Messages/FolderInfoUnion/index","title":"FolderInfoUnion","description":"Examples","sidebar":"tutorialSidebar"},"gRPC/Messages/FolderInfoUnion/PropertyFolderData/index":{"id":"gRPC/Messages/FolderInfoUnion/PropertyFolderData/index","title":"PropertyFolderData","description":"Example","sidebar":"tutorialSidebar"},"gRPC/Messages/FolderInfoUnion/SearchFolderData/index":{"id":"gRPC/Messages/FolderInfoUnion/SearchFolderData/index","title":"SearchFolderData","description":"Example","sidebar":"tutorialSidebar"},"gRPC/Messages/FolderInfoUnion/TraditionalFolderData/index":{"id":"gRPC/Messages/FolderInfoUnion/TraditionalFolderData/index","title":"TraditionalFolderData","description":"Example","sidebar":"tutorialSidebar"},"gRPC/Messages/FolderInfoUnion/UnknownFolderData/index":{"id":"gRPC/Messages/FolderInfoUnion/UnknownFolderData/index","title":"UnknownFolderData","description":"Example","sidebar":"tutorialSidebar"},"gRPC/Messages/FolderInfoUnion/ViewFolderData/index":{"id":"gRPC/Messages/FolderInfoUnion/ViewFolderData/index","title":"ViewFolderData","description":"Example","sidebar":"tutorialSidebar"},"gRPC/Messages/FTSFLAGS/index":{"id":"gRPC/Messages/FTSFLAGS/index","title":"FTSFLAGS","description":"Example","sidebar":"tutorialSidebar"},"gRPC/Messages/GetMetadataStructureItemIdByGUIDRequest/index":{"id":"gRPC/Messages/GetMetadataStructureItemIdByGUIDRequest/index","title":"GetMetadataStructureItemIdByGUIDRequest","description":"Example","sidebar":"tutorialSidebar"},"gRPC/Messages/GetMetadataStructureItemIdByGUIDResponse/index":{"id":"gRPC/Messages/GetMetadataStructureItemIdByGUIDResponse/index","title":"GetMetadataStructureItemIdByGUIDResponse","description":"Example","sidebar":"tutorialSidebar"},"gRPC/Messages/GetObjectVersionAndPropertiesOfMultipleObjectsResponse/index":{"id":"gRPC/Messages/GetObjectVersionAndPropertiesOfMultipleObjectsResponse/index","title":"GetObjectVersionAndPropertiesOfMultipleObjectsResponse","description":"Example","sidebar":"tutorialSidebar"},"gRPC/Messages/GroupingLevel/index":{"id":"gRPC/Messages/GroupingLevel/index","title":"GroupingLevel","description":"Example","sidebar":"tutorialSidebar"},"gRPC/Messages/index":{"id":"gRPC/Messages/index","title":"Messages","description":"","sidebar":"tutorialSidebar"},"gRPC/Messages/IndirectionLevel/index":{"id":"gRPC/Messages/IndirectionLevel/index","title":"IndirectionLevel","description":"Example","sidebar":"tutorialSidebar"},"gRPC/Messages/IndirectPropertyID/index":{"id":"gRPC/Messages/IndirectPropertyID/index","title":"IndirectPropertyID","description":"Example","sidebar":"tutorialSidebar"},"gRPC/Messages/IndirectPropertyIDLevel/index":{"id":"gRPC/Messages/IndirectPropertyIDLevel/index","title":"IndirectPropertyIDLevel","description":"Example","sidebar":"tutorialSidebar"},"gRPC/Messages/IndirectPropertyIDLevelRef/index":{"id":"gRPC/Messages/IndirectPropertyIDLevelRef/index","title":"IndirectPropertyIDLevelRef","description":"Example","sidebar":"tutorialSidebar"},"gRPC/Messages/ITEMFLAGS/index":{"id":"gRPC/Messages/ITEMFLAGS/index","title":"ITEMFLAGS","description":"Example","sidebar":"tutorialSidebar"},"gRPC/Messages/ItemID/index":{"id":"gRPC/Messages/ItemID/index","title":"ItemID","description":"Helper Methods and Properties","sidebar":"tutorialSidebar"},"gRPC/Messages/ItemInfo/index":{"id":"gRPC/Messages/ItemInfo/index","title":"ItemInfo","description":"Example","sidebar":"tutorialSidebar"},"gRPC/Messages/Lookup/index":{"id":"gRPC/Messages/Lookup/index","title":"Lookup","description":"Helper Methods and Properties","sidebar":"tutorialSidebar"},"gRPC/Messages/LookupWithMetadata/index":{"id":"gRPC/Messages/LookupWithMetadata/index","title":"LookupWithMetadata","description":"Example","sidebar":"tutorialSidebar"},"gRPC/Messages/MultiSelectLookup/index":{"id":"gRPC/Messages/MultiSelectLookup/index","title":"MultiSelectLookup","description":"Helper Methods and Properties","sidebar":"tutorialSidebar"},"gRPC/Messages/MultiSelectLookupWithMetadata/index":{"id":"gRPC/Messages/MultiSelectLookupWithMetadata/index","title":"MultiSelectLookupWithMetadata","description":"Example","sidebar":"tutorialSidebar"},"gRPC/Messages/NamedACL/index":{"id":"gRPC/Messages/NamedACL/index","title":"NamedACL","description":"Example","sidebar":"tutorialSidebar"},"gRPC/Messages/NamedValue/index":{"id":"gRPC/Messages/NamedValue/index","title":"NamedValue","description":"Example","sidebar":"tutorialSidebar"},"gRPC/Messages/OBJECTCAPABILITYFLAGS/index":{"id":"gRPC/Messages/OBJECTCAPABILITYFLAGS/index","title":"OBJECTCAPABILITYFLAGS","description":"Example","sidebar":"tutorialSidebar"},"gRPC/Messages/ObjectClass/index":{"id":"gRPC/Messages/ObjectClass/index","title":"ObjectClass","description":"Example","sidebar":"tutorialSidebar"},"gRPC/Messages/OBJECTDATAREQUESTFLAGS/index":{"id":"gRPC/Messages/OBJECTDATAREQUESTFLAGS/index","title":"OBJECTDATAREQUESTFLAGS","description":"Example","sidebar":"tutorialSidebar"},"gRPC/Messages/OBJECTFILEFLAGS/index":{"id":"gRPC/Messages/OBJECTFILEFLAGS/index","title":"OBJECTFILEFLAGS","description":"Example","sidebar":"tutorialSidebar"},"gRPC/Messages/ObjectLevelInfo/index":{"id":"gRPC/Messages/ObjectLevelInfo/index","title":"ObjectLevelInfo","description":"Example","sidebar":"tutorialSidebar"},"gRPC/Messages/OBJECTOPFLAGS/index":{"id":"gRPC/Messages/OBJECTOPFLAGS/index","title":"OBJECTOPFLAGS","description":"Example","sidebar":"tutorialSidebar"},"gRPC/Messages/ObjectPermissionsForClient/index":{"id":"gRPC/Messages/ObjectPermissionsForClient/index","title":"ObjectPermissionsForClient","description":"Example","sidebar":"tutorialSidebar"},"gRPC/Messages/ObjectTypeIndexingDefinition/index":{"id":"gRPC/Messages/ObjectTypeIndexingDefinition/index","title":"ObjectTypeIndexingDefinition","description":"Example","sidebar":"tutorialSidebar"},"gRPC/Messages/ObjectTypePermissionsForClient/index":{"id":"gRPC/Messages/ObjectTypePermissionsForClient/index","title":"ObjectTypePermissionsForClient","description":"Example","sidebar":"tutorialSidebar"},"gRPC/Messages/ObjectTypeSearchCharacteristics/index":{"id":"gRPC/Messages/ObjectTypeSearchCharacteristics/index","title":"ObjectTypeSearchCharacteristics","description":"Example","sidebar":"tutorialSidebar"},"gRPC/Messages/ObjectTypeTargetForBrowsing/index":{"id":"gRPC/Messages/ObjectTypeTargetForBrowsing/index","title":"ObjectTypeTargetForBrowsing","description":"Example","sidebar":"tutorialSidebar"},"gRPC/Messages/ObjectVersion/index":{"id":"gRPC/Messages/ObjectVersion/index","title":"ObjectVersion","description":"Example","sidebar":"tutorialSidebar"},"gRPC/Messages/ObjectVersionActivity/index":{"id":"gRPC/Messages/ObjectVersionActivity/index","title":"ObjectVersionActivity","description":"Example","sidebar":"tutorialSidebar"},"gRPC/Messages/OBJECTVERSIONACTIVITYCATEGORYFLAGS/index":{"id":"gRPC/Messages/OBJECTVERSIONACTIVITYCATEGORYFLAGS/index","title":"OBJECTVERSIONACTIVITYCATEGORYFLAGS","description":"Example","sidebar":"tutorialSidebar"},"gRPC/Messages/ObjectVersionActivityRequest/index":{"id":"gRPC/Messages/ObjectVersionActivityRequest/index","title":"ObjectVersionActivityRequest","description":"Example","sidebar":"tutorialSidebar"},"gRPC/Messages/ObjectVersionActivityResponse/index":{"id":"gRPC/Messages/ObjectVersionActivityResponse/index","title":"ObjectVersionActivityResponse","description":"Example","sidebar":"tutorialSidebar"},"gRPC/Messages/ObjectVersionAndPropertiesWithMetadata/index":{"id":"gRPC/Messages/ObjectVersionAndPropertiesWithMetadata/index","title":"ObjectVersionAndPropertiesWithMetadata","description":"Example","sidebar":"tutorialSidebar"},"gRPC/Messages/ObjectVersionData/index":{"id":"gRPC/Messages/ObjectVersionData/index","title":"ObjectVersionData","description":"Example","sidebar":"tutorialSidebar"},"gRPC/Messages/ObjectVersionDataRequest/index":{"id":"gRPC/Messages/ObjectVersionDataRequest/index","title":"ObjectVersionDataRequest","description":"Example","sidebar":"tutorialSidebar"},"gRPC/Messages/ObjectVersionDataResult/index":{"id":"gRPC/Messages/ObjectVersionDataResult/index","title":"ObjectVersionDataResult","description":"Example","sidebar":"tutorialSidebar"},"gRPC/Messages/ObjectVersionEx/index":{"id":"gRPC/Messages/ObjectVersionEx/index","title":"ObjectVersionEx","description":"Helper Methods and Properties","sidebar":"tutorialSidebar"},"gRPC/Messages/ObjectVersionExWP/index":{"id":"gRPC/Messages/ObjectVersionExWP/index","title":"ObjectVersionExWP","description":"Example","sidebar":"tutorialSidebar"},"gRPC/Messages/ObjectVersionFileActivity/index":{"id":"gRPC/Messages/ObjectVersionFileActivity/index","title":"ObjectVersionFileActivity","description":"Example","sidebar":"tutorialSidebar"},"gRPC/Messages/OBJECTVERSIONFILEACTIVITYFLAGS/index":{"id":"gRPC/Messages/OBJECTVERSIONFILEACTIVITYFLAGS/index","title":"OBJECTVERSIONFILEACTIVITYFLAGS","description":"Example","sidebar":"tutorialSidebar"},"gRPC/Messages/ObjectVersionPropertyActivity/index":{"id":"gRPC/Messages/ObjectVersionPropertyActivity/index","title":"ObjectVersionPropertyActivity","description":"Example","sidebar":"tutorialSidebar"},"gRPC/Messages/OBJECTVERSIONPROPERTYACTIVITYFLAGS/index":{"id":"gRPC/Messages/OBJECTVERSIONPROPERTYACTIVITYFLAGS/index","title":"OBJECTVERSIONPROPERTYACTIVITYFLAGS","description":"Example","sidebar":"tutorialSidebar"},"gRPC/Messages/ObjFileSource/index":{"id":"gRPC/Messages/ObjFileSource/index","title":"ObjFileSource","description":"Example","sidebar":"tutorialSidebar"},"gRPC/Messages/ObjFileSourceUnion/BlankTemplateData/index":{"id":"gRPC/Messages/ObjFileSourceUnion/BlankTemplateData/index","title":"BlankTemplateData","description":"Example","sidebar":"tutorialSidebar"},"gRPC/Messages/ObjFileSourceUnion/index":{"id":"gRPC/Messages/ObjFileSourceUnion/index","title":"ObjFileSourceUnion","description":"Examples","sidebar":"tutorialSidebar"},"gRPC/Messages/ObjFileSourceUnion/UndefinedSourceData/index":{"id":"gRPC/Messages/ObjFileSourceUnion/UndefinedSourceData/index","title":"UndefinedSourceData","description":"Example","sidebar":"tutorialSidebar"},"gRPC/Messages/ObjFileSourceUnion/UploadedFileData/index":{"id":"gRPC/Messages/ObjFileSourceUnion/UploadedFileData/index","title":"UploadedFileData","description":"Example","sidebar":"tutorialSidebar"},"gRPC/Messages/ObjFileSourceUnion/UploadedFilesData/index":{"id":"gRPC/Messages/ObjFileSourceUnion/UploadedFilesData/index","title":"UploadedFilesData","description":"Example","sidebar":"tutorialSidebar"},"gRPC/Messages/ObjFileSourceUnion/UserDefinedTemplateData/index":{"id":"gRPC/Messages/ObjFileSourceUnion/UserDefinedTemplateData/index","title":"UserDefinedTemplateData","description":"Example","sidebar":"tutorialSidebar"},"gRPC/Messages/ObjFileVer/index":{"id":"gRPC/Messages/ObjFileVer/index","title":"ObjFileVer","description":"Example","sidebar":"tutorialSidebar"},"gRPC/Messages/ObjID/index":{"id":"gRPC/Messages/ObjID/index","title":"ObjID","description":"Helper Methods and Properties","sidebar":"tutorialSidebar"},"gRPC/Messages/OBJTYPEFLAGS/index":{"id":"gRPC/Messages/OBJTYPEFLAGS/index","title":"OBJTYPEFLAGS","description":"Example","sidebar":"tutorialSidebar"},"gRPC/Messages/ObjVer/index":{"id":"gRPC/Messages/ObjVer/index","title":"ObjVer","description":"Helper Methods and Properties","sidebar":"tutorialSidebar"},"gRPC/Messages/OBJVERFLAGS/index":{"id":"gRPC/Messages/OBJVERFLAGS/index","title":"OBJVERFLAGS","description":"Example","sidebar":"tutorialSidebar"},"gRPC/Messages/ObjVerVersion/index":{"id":"gRPC/Messages/ObjVerVersion/index","title":"ObjVerVersion","description":"Helper Methods and Properties","sidebar":"tutorialSidebar"},"gRPC/Messages/ObjVerWithProperties/index":{"id":"gRPC/Messages/ObjVerWithProperties/index","title":"ObjVerWithProperties","description":"Example","sidebar":"tutorialSidebar"},"gRPC/Messages/PropertyDef/index":{"id":"gRPC/Messages/PropertyDef/index","title":"PropertyDef","description":"Example","sidebar":"tutorialSidebar"},"gRPC/Messages/PROPERTYDEFFLAGS/index":{"id":"gRPC/Messages/PROPERTYDEFFLAGS/index","title":"PROPERTYDEFFLAGS","description":"Example","sidebar":"tutorialSidebar"},"gRPC/Messages/PropertyDefPermissionsForClient/index":{"id":"gRPC/Messages/PropertyDefPermissionsForClient/index","title":"PropertyDefPermissionsForClient","description":"Example","sidebar":"tutorialSidebar"},"gRPC/Messages/PropertyValue/index":{"id":"gRPC/Messages/PropertyValue/index","title":"PropertyValue","description":"Helper Methods and Properties","sidebar":"tutorialSidebar"},"gRPC/Messages/PropertyValueArray/index":{"id":"gRPC/Messages/PropertyValueArray/index","title":"PropertyValueArray","description":"Helper Methods and Properties","sidebar":"tutorialSidebar"},"gRPC/Messages/PropertyValueSuggestion/index":{"id":"gRPC/Messages/PropertyValueSuggestion/index","title":"PropertyValueSuggestion","description":"Example","sidebar":"tutorialSidebar"},"gRPC/Messages/PropertyValueWithMetadata/index":{"id":"gRPC/Messages/PropertyValueWithMetadata/index","title":"PropertyValueWithMetadata","description":"Example","sidebar":"tutorialSidebar"},"gRPC/Messages/PropertyValueWithMetadataArray/index":{"id":"gRPC/Messages/PropertyValueWithMetadataArray/index","title":"PropertyValueWithMetadataArray","description":"Example","sidebar":"tutorialSidebar"},"gRPC/Messages/RelationshipData/index":{"id":"gRPC/Messages/RelationshipData/index","title":"RelationshipData","description":"Example","sidebar":"tutorialSidebar"},"gRPC/Messages/RelationshipGroup/index":{"id":"gRPC/Messages/RelationshipGroup/index","title":"RelationshipGroup","description":"Example","sidebar":"tutorialSidebar"},"gRPC/Messages/SearchCondition/index":{"id":"gRPC/Messages/SearchCondition/index","title":"SearchCondition","description":"Helper Methods and Properties","sidebar":"tutorialSidebar"},"gRPC/Messages/SearchConditionArray/index":{"id":"gRPC/Messages/SearchConditionArray/index","title":"SearchConditionArray","description":"Helper Methods and Properties","sidebar":"tutorialSidebar"},"gRPC/Messages/SearchDef/index":{"id":"gRPC/Messages/SearchDef/index","title":"SearchDef","description":"Example","sidebar":"tutorialSidebar"},"gRPC/Messages/SearchFlags/index":{"id":"gRPC/Messages/SearchFlags/index","title":"SearchFlags","description":"Example","sidebar":"tutorialSidebar"},"gRPC/Messages/SearchOutputInfo/index":{"id":"gRPC/Messages/SearchOutputInfo/index","title":"SearchOutputInfo","description":"Example","sidebar":"tutorialSidebar"},"gRPC/Messages/SearchResultsItem/index":{"id":"gRPC/Messages/SearchResultsItem/index","title":"SearchResultsItem","description":"Example","sidebar":"tutorialSidebar"},"gRPC/Messages/SearchResultsPageRequest/index":{"id":"gRPC/Messages/SearchResultsPageRequest/index","title":"SearchResultsPageRequest","description":"Example","sidebar":"tutorialSidebar"},"gRPC/Messages/SearchResultsSorting/index":{"id":"gRPC/Messages/SearchResultsSorting/index","title":"SearchResultsSorting","description":"Example","sidebar":"tutorialSidebar"},"gRPC/Messages/SEARCHSTATUSFLAGS/index":{"id":"gRPC/Messages/SEARCHSTATUSFLAGS/index","title":"SEARCHSTATUSFLAGS","description":"Example","sidebar":"tutorialSidebar"},"gRPC/Messages/SearchTarget/index":{"id":"gRPC/Messages/SearchTarget/index","title":"SearchTarget","description":"Example","sidebar":"tutorialSidebar"},"gRPC/Messages/ServerVaultCapabilities/index":{"id":"gRPC/Messages/ServerVaultCapabilities/index","title":"ServerVaultCapabilities","description":"Example","sidebar":"tutorialSidebar"},"gRPC/Messages/SessionInfo/index":{"id":"gRPC/Messages/SessionInfo/index","title":"SessionInfo","description":"Example","sidebar":"tutorialSidebar"},"gRPC/Messages/SetPropertiesParams/index":{"id":"gRPC/Messages/SetPropertiesParams/index","title":"SetPropertiesParams","description":"Example","sidebar":"tutorialSidebar"},"gRPC/Messages/SortFlags/index":{"id":"gRPC/Messages/SortFlags/index","title":"SortFlags","description":"Example","sidebar":"tutorialSidebar"},"gRPC/Messages/SortRule/index":{"id":"gRPC/Messages/SortRule/index","title":"SortRule","description":"Example","sidebar":"tutorialSidebar"},"gRPC/Messages/SortRuleFlags/index":{"id":"gRPC/Messages/SortRuleFlags/index","title":"SortRuleFlags","description":"Example","sidebar":"tutorialSidebar"},"gRPC/Messages/SortRuleValueArray/index":{"id":"gRPC/Messages/SortRuleValueArray/index","title":"SortRuleValueArray","description":"Example","sidebar":"tutorialSidebar"},"gRPC/Messages/SRPREQUESTFLAGS/index":{"id":"gRPC/Messages/SRPREQUESTFLAGS/index","title":"SRPREQUESTFLAGS","description":"Example","sidebar":"tutorialSidebar"},"gRPC/Messages/StateBasic/index":{"id":"gRPC/Messages/StateBasic/index","title":"StateBasic","description":"Example","sidebar":"tutorialSidebar"},"gRPC/Messages/STATEFLAGS/index":{"id":"gRPC/Messages/STATEFLAGS/index","title":"STATEFLAGS","description":"Example","sidebar":"tutorialSidebar"},"gRPC/Messages/StateTransitionBasic/index":{"id":"gRPC/Messages/StateTransitionBasic/index","title":"StateTransitionBasic","description":"Example","sidebar":"tutorialSidebar"},"gRPC/Messages/SubviewGroup/index":{"id":"gRPC/Messages/SubviewGroup/index","title":"SubviewGroup","description":"Example","sidebar":"tutorialSidebar"},"gRPC/Messages/Template/index":{"id":"gRPC/Messages/Template/index","title":"Template","description":"Example","sidebar":"tutorialSidebar"},"gRPC/Messages/TypedValue/index":{"id":"gRPC/Messages/TypedValue/index","title":"TypedValue","description":"Helper Methods and Properties","sidebar":"tutorialSidebar"},"gRPC/Messages/TypedValueMetadata/index":{"id":"gRPC/Messages/TypedValueMetadata/index","title":"TypedValueMetadata","description":"Example","sidebar":"tutorialSidebar"},"gRPC/Messages/TypedValueUnion/index":{"id":"gRPC/Messages/TypedValueUnion/index","title":"TypedValueUnion","description":"Examples","sidebar":"tutorialSidebar"},"gRPC/Messages/TypedValueUnionWithMetadata/index":{"id":"gRPC/Messages/TypedValueUnionWithMetadata/index","title":"TypedValueUnionWithMetadata","description":"Examples","sidebar":"tutorialSidebar"},"gRPC/Messages/TypedValueWithMetadata/index":{"id":"gRPC/Messages/TypedValueWithMetadata/index","title":"TypedValueWithMetadata","description":"Example","sidebar":"tutorialSidebar"},"gRPC/Messages/UploadedFile/index":{"id":"gRPC/Messages/UploadedFile/index","title":"UploadedFile","description":"Example","sidebar":"tutorialSidebar"},"gRPC/Messages/UploadedFileArray/index":{"id":"gRPC/Messages/UploadedFileArray/index","title":"UploadedFileArray","description":"Example","sidebar":"tutorialSidebar"},"gRPC/Messages/ValueList/index":{"id":"gRPC/Messages/ValueList/index","title":"ValueList","description":"Example","sidebar":"tutorialSidebar"},"gRPC/Messages/ValueListItem/index":{"id":"gRPC/Messages/ValueListItem/index","title":"ValueListItem","description":"Example","sidebar":"tutorialSidebar"},"gRPC/Messages/VersionComment/index":{"id":"gRPC/Messages/VersionComment/index","title":"VersionComment","description":"Example","sidebar":"tutorialSidebar"},"gRPC/Messages/VersionCommentArray/index":{"id":"gRPC/Messages/VersionCommentArray/index","title":"VersionCommentArray","description":"Example","sidebar":"tutorialSidebar"},"gRPC/Messages/View/index":{"id":"gRPC/Messages/View/index","title":"View","description":"Example","sidebar":"tutorialSidebar"},"gRPC/Messages/VIEWFLAGS/index":{"id":"gRPC/Messages/VIEWFLAGS/index","title":"VIEWFLAGS","description":"Example","sidebar":"tutorialSidebar"},"gRPC/Messages/ViewLocation/index":{"id":"gRPC/Messages/ViewLocation/index","title":"ViewLocation","description":"Example","sidebar":"tutorialSidebar"},"gRPC/Messages/ViewVisualization/index":{"id":"gRPC/Messages/ViewVisualization/index","title":"ViewVisualization","description":"Example","sidebar":"tutorialSidebar"},"gRPC/Messages/Workflow/index":{"id":"gRPC/Messages/Workflow/index","title":"Workflow","description":"Example","sidebar":"tutorialSidebar"},"gRPC/Messages/WorkflowBasic/index":{"id":"gRPC/Messages/WorkflowBasic/index","title":"WorkflowBasic","description":"Example","sidebar":"tutorialSidebar"},"Overview/ApplicationStructure":{"id":"Overview/ApplicationStructure","title":"Application Structure","description":"Each UI Extension Application is a JavaScript application that extends the core functionality of the associated M-Files client. Each application can use the UI Extension API to interact with other areas of the UI, and the Vault API to interact with the vault structure and contents.","sidebar":"tutorialSidebar"},"Overview/Commands":{"id":"Overview/Commands","title":"Using Custom Commands","description":"The Custom Commands interface provides a set of commands for customizing menus, creating custom commands, and managing their states in M-Files UI Extensions. The ICommands provides set of tools for developers to customize the user interface, manage commands, and control their visibility and availability within the application.","sidebar":"tutorialSidebar"},"Overview/Dashboards":{"id":"Overview/Dashboards","title":"Dashboards","description":"Dashboards are custom HTML pages defined by the application and can reference typical web content such as JavaScript and CSS files. These custom HTML pages may be shown all the time in a custom tab, shown in a tab which is shown or hidden depending upon user interaction, or shown via code as a custom popup dialog. Each dashboard, when shown, is rendered within an `` element.","sidebar":"tutorialSidebar"},"Overview/Debugging":{"id":"Overview/Debugging","title":"Testing and Developing","description":"Runtime Environment","sidebar":"tutorialSidebar"},"Overview/Events":{"id":"Overview/Events","title":"Events","description":"The UI Extension Application has different kinds of event handlers:","sidebar":"tutorialSidebar"},"Overview/exceptions":{"id":"Overview/exceptions","title":"Exception Reference","description":"This page provides detailed information about all exception types that can be thrown by M-Files UI Extension methods.","sidebar":"tutorialSidebar"},"Overview/InstallingApplications":{"id":"Overview/InstallingApplications","title":"Installing Applications","description":"M-Files UI Extensions are managed using the M-Files Admin tool.","sidebar":"tutorialSidebar"},"Overview/ListingView":{"id":"Overview/ListingView","title":"Working with the Shell Listing","description":"The Shell Listing represents the list of files, objects, views, groupings, or other content shown within the current object listing. Changes in the listing view affect various parts of the client. For example: when objects are selected or deselected the Preview and Metadata tabs display information about the selected object(s).","sidebar":"tutorialSidebar"},"Overview/Messages":{"id":"Overview/Messages","title":"Dialogs and Messages","description":"UI Extension Applications can define a rich UI interface using HTML and JavaScript inside their own IFRAME. However, sometimes it is necessary to create modal dialogs which break the IFRAME boundary.","sidebar":"tutorialSidebar"},"Overview/MFilesGlobalObject":{"id":"Overview/MFilesGlobalObject","title":"MFiles Global Object","description":"The MFiles global object is available in your UI Extension code after initialization. It provides access to enumerations, utility functions, and the Vault API enums.","sidebar":"tutorialSidebar"},"Overview/Modules":{"id":"Overview/Modules","title":"Modules","description":"The modules inside the Application Manifest define the entrypoint JavaScript file which is to be executed for the extension. Specifically the `` node in the XML","sidebar":"tutorialSidebar"},"Overview/Overview":{"id":"Overview/Overview","title":"Overview","description":"User Interface Extensibility Framework applications are JavaScript applications that run within the M-Files Web client. The framework provides a set of objects that allow you to interact with the user interface by adding commands to various menus, to add your own tabs/dashboards, or to react when various events fire within the user interface. Applications can also use the M-Files Vault API to perform tasks within the vault such as searching or creating objects.","sidebar":"tutorialSidebar"},"Overview/Tabs":{"id":"Overview/Tabs","title":"Tabs","description":"The M-Files user interface typically shows two tabs on the right of the screen: Metadata and Preview. As users interact with the object listings (e.g. they select an object), these two tabs react and show the associated metadata and preview respectively.","sidebar":"tutorialSidebar"},"Overview/VaultMessages":{"id":"Overview/VaultMessages","title":"Vault API Helpers","description":"When communicating with the M-Files vault through the gRPC API, you work with structured message objects such as ObjID, PropertyValue, TypedValue, and SearchConditionArray. Constructing these objects by hand as raw JSON is verbose and error-prone.","sidebar":"tutorialSidebar"},"Samples/AssignToMe/index":{"id":"Samples/AssignToMe/index","title":"Creating assignments for selected objects","description":"Overview","sidebar":"tutorialSidebar"},"Samples/BuiltInCommands/index":{"id":"Samples/BuiltInCommands/index","title":"Built-in Command Demonstration","description":"Overview","sidebar":"tutorialSidebar"},"Samples/Commands/index":{"id":"Samples/Commands/index","title":"Commands","description":"Overview","sidebar":"tutorialSidebar"},"Samples/ErrorHandling/index":{"id":"Samples/ErrorHandling/index","title":"Error Handling","description":"Overview","sidebar":"tutorialSidebar"},"Samples/HelloWorld/index":{"id":"Samples/HelloWorld/index","title":"Hello, World","description":"Overview","sidebar":"tutorialSidebar"},"Samples/ObjectOperationSupport/index":{"id":"Samples/ObjectOperationSupport/index","title":"Interacting with object operation events","description":"Overview","sidebar":"tutorialSidebar"},"Samples/PopupDashboard/index":{"id":"Samples/PopupDashboard/index","title":"PopUp Dashboard","description":"Overview","sidebar":"tutorialSidebar"},"Samples/PopUpDashboardWithAccentColor/index":{"id":"Samples/PopUpDashboardWithAccentColor/index","title":"PopUp Dashboard","description":"Overview","sidebar":"tutorialSidebar"},"Samples/Samples":{"id":"Samples/Samples","title":"Samples","description":"Please note that these samples are provided \u201cas-is\u201d and with no warranty, explicit or otherwise. You should ensure that the functionality of these samples meet your requirements, and thoroughly test them, prior to using in any production scenarios. The items linked below are designed as teaching tools and may not be fully complete.","sidebar":"tutorialSidebar"},"Samples/SandboxAttributesSupport/index":{"id":"Samples/SandboxAttributesSupport/index","title":"Creating Sandbox Attributes Support.","description":"Overview","sidebar":"tutorialSidebar"},"Samples/SearchFolderExamples/index":{"id":"Samples/SearchFolderExamples/index","title":"Creating search folders","description":"Overview","sidebar":"tutorialSidebar"},"Samples/ShellFrameAndDashboard/index":{"id":"Samples/ShellFrameAndDashboard/index","title":"ShellFrame & Dashboard","description":"Overview","sidebar":"tutorialSidebar"},"Samples/ShowNewObjectWindow With Blank and UserDefined Template/index":{"id":"Samples/ShowNewObjectWindow With Blank and UserDefined Template/index","title":"ShowNewObjectWindow (Blank and UserDefined Template)","description":"Overview","sidebar":"tutorialSidebar"},"Samples/TaskbarCommands/index":{"id":"Samples/TaskbarCommands/index","title":"Taskbar Commands","description":"Overview","sidebar":"tutorialSidebar"},"Samples/VaultMessagesPackage/index":{"id":"Samples/VaultMessagesPackage/index","title":"Using the Vault Messages Package","description":"Overview","sidebar":"tutorialSidebar"},"UIExt2/Enums/BuiltinCommand/index":{"id":"UIExt2/Enums/BuiltinCommand/index","title":"BuiltinCommand","description":"","sidebar":"tutorialSidebar"},"UIExt2/Enums/BuiltInIcon/index":{"id":"UIExt2/Enums/BuiltInIcon/index","title":"BuiltInIcon","description":"","sidebar":"tutorialSidebar"},"UIExt2/Enums/CommandLocation/index":{"id":"UIExt2/Enums/CommandLocation/index","title":"CommandLocation","description":"","sidebar":"tutorialSidebar"},"UIExt2/Enums/CommandState/index":{"id":"UIExt2/Enums/CommandState/index","title":"CommandState","description":"","sidebar":"tutorialSidebar"},"UIExt2/Enums/Event/index":{"id":"UIExt2/Enums/Event/index","title":"Event","description":"","sidebar":"tutorialSidebar"},"UIExt2/Enums/FacetRangeType/index":{"id":"UIExt2/Enums/FacetRangeType/index","title":"FacetRangeType","description":"","sidebar":"tutorialSidebar"},"UIExt2/Enums/FacetTransformation/index":{"id":"UIExt2/Enums/FacetTransformation/index","title":"FacetTransformation","description":"","sidebar":"tutorialSidebar"},"UIExt2/Enums/FacetType/index":{"id":"UIExt2/Enums/FacetType/index","title":"FacetType","description":"","sidebar":"tutorialSidebar"},"UIExt2/Enums/FacetValueType/index":{"id":"UIExt2/Enums/FacetValueType/index","title":"FacetValueType","description":"","sidebar":"tutorialSidebar"},"UIExt2/Enums/IconContentType/index":{"id":"UIExt2/Enums/IconContentType/index","title":"IconContentType","description":"","sidebar":"tutorialSidebar"},"UIExt2/Enums/index":{"id":"UIExt2/Enums/index","title":"Enums","description":"","sidebar":"tutorialSidebar"},"UIExt2/Enums/MenuLocation/index":{"id":"UIExt2/Enums/MenuLocation/index","title":"MenuLocation","description":"","sidebar":"tutorialSidebar"},"UIExt2/Enums/MFBuiltInObjectType/index":{"id":"UIExt2/Enums/MFBuiltInObjectType/index","title":"MFBuiltInObjectType","description":"","sidebar":"tutorialSidebar"},"UIExt2/Enums/MFBuiltInPropertyDef/index":{"id":"UIExt2/Enums/MFBuiltInPropertyDef/index","title":"MFBuiltInPropertyDef","description":"","sidebar":"tutorialSidebar"},"UIExt2/Enums/MFBuiltInValueList/index":{"id":"UIExt2/Enums/MFBuiltInValueList/index","title":"MFBuiltInValueList","description":"","sidebar":"tutorialSidebar"},"UIExt2/Enums/MFBuiltInView/index":{"id":"UIExt2/Enums/MFBuiltInView/index","title":"MFBuiltInView","description":"","sidebar":"tutorialSidebar"},"UIExt2/Enums/ObjectWindowResultCode/index":{"id":"UIExt2/Enums/ObjectWindowResultCode/index","title":"ObjectWindowResultCode","description":"","sidebar":"tutorialSidebar"},"UIExt2/Enums/SearchEngine/index":{"id":"UIExt2/Enums/SearchEngine/index","title":"SearchEngine","description":"","sidebar":"tutorialSidebar"},"UIExt2/Enums/ToastType/index":{"id":"UIExt2/Enums/ToastType/index","title":"ToastType","description":"","sidebar":"tutorialSidebar"},"UIExt2/Events":{"id":"UIExt2/Events","title":"Events","description":"ISearchPaneEvents","sidebar":"tutorialSidebar"},"UIExt2/Interfaces/ICommands/AddCustomCommandToMenu/index":{"id":"UIExt2/Interfaces/ICommands/AddCustomCommandToMenu/index","title":"AddCustomCommandToMenu","description":"Description","sidebar":"tutorialSidebar"},"UIExt2/Interfaces/ICommands/CreateCustomCommand/index":{"id":"UIExt2/Interfaces/ICommands/CreateCustomCommand/index","title":"CreateCustomCommand","description":"Description","sidebar":"tutorialSidebar"},"UIExt2/Interfaces/ICommands/CreateSubMenuItem/index":{"id":"UIExt2/Interfaces/ICommands/CreateSubMenuItem/index","title":"CreateSubMenuItem","description":"Description","sidebar":"tutorialSidebar"},"UIExt2/Interfaces/ICommands/CreateTaskbarGroup/index":{"id":"UIExt2/Interfaces/ICommands/CreateTaskbarGroup/index","title":"CreateTaskbarGroup","description":"Description","sidebar":"tutorialSidebar"},"UIExt2/Interfaces/ICommands/DeleteCustomCommand/index":{"id":"UIExt2/Interfaces/ICommands/DeleteCustomCommand/index","title":"DeleteCustomCommand","description":"Description","sidebar":"tutorialSidebar"},"UIExt2/Interfaces/ICommands/ExecuteCommand/index":{"id":"UIExt2/Interfaces/ICommands/ExecuteCommand/index","title":"ExecuteCommand","description":"Description","sidebar":"tutorialSidebar"},"UIExt2/Interfaces/ICommands/GetCommandName/index":{"id":"UIExt2/Interfaces/ICommands/GetCommandName/index","title":"GetCommandName","description":"Description","sidebar":"tutorialSidebar"},"UIExt2/Interfaces/ICommands/GetCommandState/index":{"id":"UIExt2/Interfaces/ICommands/GetCommandState/index","title":"GetCommandState","description":"Description","sidebar":"tutorialSidebar"},"UIExt2/Interfaces/ICommands/GetMenuIdOfBuiltInCommand/index":{"id":"UIExt2/Interfaces/ICommands/GetMenuIdOfBuiltInCommand/index","title":"GetMenuIdOfBuiltInCommand","description":"Description","sidebar":"tutorialSidebar"},"UIExt2/Interfaces/ICommands/index":{"id":"UIExt2/Interfaces/ICommands/index","title":"ICommands","description":"The Commands API includes functionality for creating Custom Commands and menus.","sidebar":"tutorialSidebar"},"UIExt2/Interfaces/ICommands/RemoveCustomCommandFromMenu/index":{"id":"UIExt2/Interfaces/ICommands/RemoveCustomCommandFromMenu/index","title":"RemoveCustomCommandFromMenu","description":"Description","sidebar":"tutorialSidebar"},"UIExt2/Interfaces/ICommands/RemoveMenuItem/index":{"id":"UIExt2/Interfaces/ICommands/RemoveMenuItem/index","title":"RemoveMenuItem","description":"Description","sidebar":"tutorialSidebar"},"UIExt2/Interfaces/ICommands/RemoveTaskbarGroup/index":{"id":"UIExt2/Interfaces/ICommands/RemoveTaskbarGroup/index","title":"RemoveTaskbarGroup","description":"Description","sidebar":"tutorialSidebar"},"UIExt2/Interfaces/ICommands/SetCommandState/index":{"id":"UIExt2/Interfaces/ICommands/SetCommandState/index","title":"SetCommandState","description":"Description","sidebar":"tutorialSidebar"},"UIExt2/Interfaces/ICommands/SetIcon/index":{"id":"UIExt2/Interfaces/ICommands/SetIcon/index","title":"SetIcon","description":"Description","sidebar":"tutorialSidebar"},"UIExt2/Interfaces/ICommands/SetMenuItemState/index":{"id":"UIExt2/Interfaces/ICommands/SetMenuItemState/index","title":"SetMenuItemState","description":"Description","sidebar":"tutorialSidebar"},"UIExt2/Interfaces/ICommands/SetTaskbarGroupIcon/index":{"id":"UIExt2/Interfaces/ICommands/SetTaskbarGroupIcon/index","title":"SetTaskbarGroupIcon","description":"Description","sidebar":"tutorialSidebar"},"UIExt2/Interfaces/ICommonFunctions/DeleteFromWebStorage/index":{"id":"UIExt2/Interfaces/ICommonFunctions/DeleteFromWebStorage/index","title":"DeleteFromWebStorage","description":"Description","sidebar":"tutorialSidebar"},"UIExt2/Interfaces/ICommonFunctions/DownloadFileAsDataUri/index":{"id":"UIExt2/Interfaces/ICommonFunctions/DownloadFileAsDataUri/index","title":"DownloadFileAsDataUri","description":"Description","sidebar":"tutorialSidebar"},"UIExt2/Interfaces/ICommonFunctions/GetAccentColor/index":{"id":"UIExt2/Interfaces/ICommonFunctions/GetAccentColor/index","title":"GetAccentColor","description":"Description","sidebar":"tutorialSidebar"},"UIExt2/Interfaces/ICommonFunctions/GetClientLanguage/index":{"id":"UIExt2/Interfaces/ICommonFunctions/GetClientLanguage/index","title":"GetClientLanguage","description":"Description","sidebar":"tutorialSidebar"},"UIExt2/Interfaces/ICommonFunctions/GetClientLocale/index":{"id":"UIExt2/Interfaces/ICommonFunctions/GetClientLocale/index","title":"GetClientLocale","description":"Description","sidebar":"tutorialSidebar"},"UIExt2/Interfaces/ICommonFunctions/GetClientLocaleIn3Letters/index":{"id":"UIExt2/Interfaces/ICommonFunctions/GetClientLocaleIn3Letters/index","title":"GetClientLocaleIn3Letters","description":"Description","sidebar":"tutorialSidebar"},"UIExt2/Interfaces/ICommonFunctions/GetSessionInfo/index":{"id":"UIExt2/Interfaces/ICommonFunctions/GetSessionInfo/index","title":"GetSessionInfo","description":"Description","sidebar":"tutorialSidebar"},"UIExt2/Interfaces/ICommonFunctions/GetUTCOffset/index":{"id":"UIExt2/Interfaces/ICommonFunctions/GetUTCOffset/index","title":"GetUTCOffset","description":"Description","sidebar":"tutorialSidebar"},"UIExt2/Interfaces/ICommonFunctions/GetVaultInfo/index":{"id":"UIExt2/Interfaces/ICommonFunctions/GetVaultInfo/index","title":"GetVaultInfo","description":"Description","sidebar":"tutorialSidebar"},"UIExt2/Interfaces/ICommonFunctions/GetWebLink/index":{"id":"UIExt2/Interfaces/ICommonFunctions/GetWebLink/index","title":"GetWebLink","description":"Description","sidebar":"tutorialSidebar"},"UIExt2/Interfaces/ICommonFunctions/index":{"id":"UIExt2/Interfaces/ICommonFunctions/index","title":"ICommonFunctions","description":"Provides set of common functions for interacting with the environment. This interfaces is bound to the global MFiles object.","sidebar":"tutorialSidebar"},"UIExt2/Interfaces/ICommonFunctions/OpenExternalWebLink/index":{"id":"UIExt2/Interfaces/ICommonFunctions/OpenExternalWebLink/index","title":"OpenExternalWebLink","description":"Description","sidebar":"tutorialSidebar"},"UIExt2/Interfaces/ICommonFunctions/ReadFromWebStorage/index":{"id":"UIExt2/Interfaces/ICommonFunctions/ReadFromWebStorage/index","title":"ReadFromWebStorage","description":"Description","sidebar":"tutorialSidebar"},"UIExt2/Interfaces/ICommonFunctions/ReportException/index":{"id":"UIExt2/Interfaces/ICommonFunctions/ReportException/index","title":"ReportException","description":"Description","sidebar":"tutorialSidebar"},"UIExt2/Interfaces/ICommonFunctions/ShowEditObjectWindow/index":{"id":"UIExt2/Interfaces/ICommonFunctions/ShowEditObjectWindow/index","title":"ShowEditObjectWindow","description":"Description","sidebar":"tutorialSidebar"},"UIExt2/Interfaces/ICommonFunctions/ShowNewObjectWindow/index":{"id":"UIExt2/Interfaces/ICommonFunctions/ShowNewObjectWindow/index","title":"ShowNewObjectWindow","description":"Description","sidebar":"tutorialSidebar"},"UIExt2/Interfaces/ICommonFunctions/ShowToast/index":{"id":"UIExt2/Interfaces/ICommonFunctions/ShowToast/index","title":"ShowToast","description":"Description","sidebar":"tutorialSidebar"},"UIExt2/Interfaces/ICommonFunctions/UploadTemporaryFiles/index":{"id":"UIExt2/Interfaces/ICommonFunctions/UploadTemporaryFiles/index","title":"UploadTemporaryFiles","description":"Description","sidebar":"tutorialSidebar"},"UIExt2/Interfaces/ICommonFunctions/WriteToWebStorage/index":{"id":"UIExt2/Interfaces/ICommonFunctions/WriteToWebStorage/index","title":"WriteToWebStorage","description":"Description","sidebar":"tutorialSidebar"},"UIExt2/Interfaces/IDashboard/GetSandboxAttributes/index":{"id":"UIExt2/Interfaces/IDashboard/GetSandboxAttributes/index","title":"GetSandboxAttributes","description":"Description","sidebar":"tutorialSidebar"},"UIExt2/Interfaces/IDashboard/index":{"id":"UIExt2/Interfaces/IDashboard/index","title":"IDashboard","description":"This is the programmatic interface of the dashboard. It is created during the dashboard initialization phase.","sidebar":"tutorialSidebar"},"UIExt2/Interfaces/IDashboard/ShowMessage/index":{"id":"UIExt2/Interfaces/IDashboard/ShowMessage/index","title":"ShowMessage","description":"Description","sidebar":"tutorialSidebar"},"UIExt2/Interfaces/IDashboard/ShowPopupDashboard/index":{"id":"UIExt2/Interfaces/IDashboard/ShowPopupDashboard/index","title":"ShowPopupDashboard","description":"Description","sidebar":"tutorialSidebar"},"UIExt2/Interfaces/IDashboard/UpdateCustomData/index":{"id":"UIExt2/Interfaces/IDashboard/UpdateCustomData/index","title":"UpdateCustomData","description":"Description","sidebar":"tutorialSidebar"},"UIExt2/Interfaces/IDashboard/WaitForClose/index":{"id":"UIExt2/Interfaces/IDashboard/WaitForClose/index","title":"WaitForClose","description":"Description","sidebar":"tutorialSidebar"},"UIExt2/Interfaces/IEvents/index":{"id":"UIExt2/Interfaces/IEvents/index","title":"IEvents","description":"This is the generic events interface. See the list of supported events for each interface","sidebar":"tutorialSidebar"},"UIExt2/Interfaces/IEvents/Register/index":{"id":"UIExt2/Interfaces/IEvents/Register/index","title":"Register","description":"Description","sidebar":"tutorialSidebar"},"UIExt2/Interfaces/IEvents/RegisterBuiltinCommand/index":{"id":"UIExt2/Interfaces/IEvents/RegisterBuiltinCommand/index","title":"RegisterBuiltinCommand","description":"Description","sidebar":"tutorialSidebar"},"UIExt2/Interfaces/IEvents/Unregister/index":{"id":"UIExt2/Interfaces/IEvents/Unregister/index","title":"Unregister","description":"Description","sidebar":"tutorialSidebar"},"UIExt2/Interfaces/index":{"id":"UIExt2/Interfaces/index","title":"Interfaces","description":"","sidebar":"tutorialSidebar"},"UIExt2/Interfaces/ISearchPane/GetOptions/index":{"id":"UIExt2/Interfaces/ISearchPane/GetOptions/index","title":"GetOptions","description":"Description","sidebar":"tutorialSidebar"},"UIExt2/Interfaces/ISearchPane/GetSearchCriteria/index":{"id":"UIExt2/Interfaces/ISearchPane/GetSearchCriteria/index","title":"GetSearchCriteria","description":"Description","sidebar":"tutorialSidebar"},"UIExt2/Interfaces/ISearchPane/index":{"id":"UIExt2/Interfaces/ISearchPane/index","title":"ISearchPane","description":"Represents the area reserved for the Search component and is a property of IShellFrame","sidebar":"tutorialSidebar"},"UIExt2/Interfaces/ISearchPane/IsSearchView/index":{"id":"UIExt2/Interfaces/ISearchPane/IsSearchView/index","title":"IsSearchView","description":"Description","sidebar":"tutorialSidebar"},"UIExt2/Interfaces/ISearchPane/SetOptionState/index":{"id":"UIExt2/Interfaces/ISearchPane/SetOptionState/index","title":"SetOptionState","description":"Description","sidebar":"tutorialSidebar"},"UIExt2/Interfaces/ISearchPane/SetSearchCriteria/index":{"id":"UIExt2/Interfaces/ISearchPane/SetSearchCriteria/index","title":"SetSearchCriteria","description":"Description","sidebar":"tutorialSidebar"},"UIExt2/Interfaces/IShellFrame/GetSandboxAttributes/index":{"id":"UIExt2/Interfaces/IShellFrame/GetSandboxAttributes/index","title":"GetSandboxAttributes","description":"Description","sidebar":"tutorialSidebar"},"UIExt2/Interfaces/IShellFrame/GetViewsById/index":{"id":"UIExt2/Interfaces/IShellFrame/GetViewsById/index","title":"GetViewsById","description":"Description","sidebar":"tutorialSidebar"},"UIExt2/Interfaces/IShellFrame/index":{"id":"UIExt2/Interfaces/IShellFrame/index","title":"IShellFrame","description":"The IShellFrame is a property of IDashboard.","sidebar":"tutorialSidebar"},"UIExt2/Interfaces/IShellFrame/IsFolderLocation/index":{"id":"UIExt2/Interfaces/IShellFrame/IsFolderLocation/index","title":"IsFolderLocation","description":"Description","sidebar":"tutorialSidebar"},"UIExt2/Interfaces/IShellFrame/IsObjectLocation/index":{"id":"UIExt2/Interfaces/IShellFrame/IsObjectLocation/index","title":"IsObjectLocation","description":"Description","sidebar":"tutorialSidebar"},"UIExt2/Interfaces/IShellFrame/NavigateToFolder/index":{"id":"UIExt2/Interfaces/IShellFrame/NavigateToFolder/index","title":"NavigateToFolder","description":"Description","sidebar":"tutorialSidebar"},"UIExt2/Interfaces/IShellFrame/NavigateToObject/index":{"id":"UIExt2/Interfaces/IShellFrame/NavigateToObject/index","title":"NavigateToObject","description":"Description","sidebar":"tutorialSidebar"},"UIExt2/Interfaces/IShellFrame/NavigateToParent/index":{"id":"UIExt2/Interfaces/IShellFrame/NavigateToParent/index","title":"NavigateToParent","description":"Description","sidebar":"tutorialSidebar"},"UIExt2/Interfaces/IShellFrame/ShowDashboard/index":{"id":"UIExt2/Interfaces/IShellFrame/ShowDashboard/index","title":"ShowDashboard","description":"Description","sidebar":"tutorialSidebar"},"UIExt2/Interfaces/IShellFrame/ShowDefaultContent/index":{"id":"UIExt2/Interfaces/IShellFrame/ShowDefaultContent/index","title":"ShowDefaultContent","description":"Description","sidebar":"tutorialSidebar"},"UIExt2/Interfaces/IShellFrame/ShowMessage/index":{"id":"UIExt2/Interfaces/IShellFrame/ShowMessage/index","title":"ShowMessage","description":"Description","sidebar":"tutorialSidebar"},"UIExt2/Interfaces/IShellFrame/ShowPopupDashboard/index":{"id":"UIExt2/Interfaces/IShellFrame/ShowPopupDashboard/index","title":"ShowPopupDashboard","description":"Description","sidebar":"tutorialSidebar"},"UIExt2/Interfaces/IShellFrame/ShowPopupDashboards/index":{"id":"UIExt2/Interfaces/IShellFrame/ShowPopupDashboards/index","title":"ShowPopupDashboards","description":"Description","sidebar":"tutorialSidebar"},"UIExt2/Interfaces/IShellItems/GetFoldersCount/index":{"id":"UIExt2/Interfaces/IShellItems/GetFoldersCount/index","title":"GetFoldersCount","description":"Description","sidebar":"tutorialSidebar"},"UIExt2/Interfaces/IShellItems/GetObjectVersionsAndProperties/index":{"id":"UIExt2/Interfaces/IShellItems/GetObjectVersionsAndProperties/index","title":"GetObjectVersionsAndProperties","description":"Description","sidebar":"tutorialSidebar"},"UIExt2/Interfaces/IShellItems/GetObjectVersionsCount/index":{"id":"UIExt2/Interfaces/IShellItems/GetObjectVersionsCount/index","title":"GetObjectVersionsCount","description":"Description","sidebar":"tutorialSidebar"},"UIExt2/Interfaces/IShellItems/index":{"id":"UIExt2/Interfaces/IShellItems/index","title":"IShellItems","description":"IShellItems represent a list of Objects in IShellListing, usually the current selection or list of all items in the view.","sidebar":"tutorialSidebar"},"UIExt2/Interfaces/IShellListing/ActivateListing/index":{"id":"UIExt2/Interfaces/IShellListing/ActivateListing/index","title":"ActivateListing","description":"Description","sidebar":"tutorialSidebar"},"UIExt2/Interfaces/IShellListing/ActivateSelected/index":{"id":"UIExt2/Interfaces/IShellListing/ActivateSelected/index","title":"ActivateSelected","description":"Description","sidebar":"tutorialSidebar"},"UIExt2/Interfaces/IShellListing/AddListingItem/index":{"id":"UIExt2/Interfaces/IShellListing/AddListingItem/index","title":"AddListingItem","description":"Description","sidebar":"tutorialSidebar"},"UIExt2/Interfaces/IShellListing/AddObjectFile/index":{"id":"UIExt2/Interfaces/IShellListing/AddObjectFile/index","title":"AddObjectFile","description":"Description","sidebar":"tutorialSidebar"},"UIExt2/Interfaces/IShellListing/GetFolderName/index":{"id":"UIExt2/Interfaces/IShellListing/GetFolderName/index","title":"GetFolderName","description":"Description","sidebar":"tutorialSidebar"},"UIExt2/Interfaces/IShellListing/index":{"id":"UIExt2/Interfaces/IShellListing/index","title":"IShellListing","description":"Instances of IShellListing represent the Objects inside the Listing View tree in the M-Files Client application UI. The interface","sidebar":"tutorialSidebar"},"UIExt2/Interfaces/IShellListing/RefreshListing/index":{"id":"UIExt2/Interfaces/IShellListing/RefreshListing/index","title":"RefreshListing","description":"Description","sidebar":"tutorialSidebar"},"UIExt2/Interfaces/IShellListing/RefreshObject/index":{"id":"UIExt2/Interfaces/IShellListing/RefreshObject/index","title":"RefreshObject","description":"Description","sidebar":"tutorialSidebar"},"UIExt2/Interfaces/IShellListing/RemoveListingItem/index":{"id":"UIExt2/Interfaces/IShellListing/RemoveListingItem/index","title":"RemoveListingItem","description":"Description","sidebar":"tutorialSidebar"},"UIExt2/Interfaces/IShellListing/ReplaceFile/index":{"id":"UIExt2/Interfaces/IShellListing/ReplaceFile/index","title":"ReplaceFile","description":"Description","sidebar":"tutorialSidebar"},"UIExt2/Interfaces/IShellListing/SelectFolder/index":{"id":"UIExt2/Interfaces/IShellListing/SelectFolder/index","title":"SelectFolder","description":"Description","sidebar":"tutorialSidebar"},"UIExt2/Interfaces/IShellListing/SelectNextFolder/index":{"id":"UIExt2/Interfaces/IShellListing/SelectNextFolder/index","title":"SelectNextFolder","description":"Description","sidebar":"tutorialSidebar"},"UIExt2/Interfaces/IShellListing/SelectNextObject/index":{"id":"UIExt2/Interfaces/IShellListing/SelectNextObject/index","title":"SelectNextObject","description":"Description","sidebar":"tutorialSidebar"},"UIExt2/Interfaces/IShellListing/SelectNextObjectFile/index":{"id":"UIExt2/Interfaces/IShellListing/SelectNextObjectFile/index","title":"SelectNextObjectFile","description":"Description","sidebar":"tutorialSidebar"},"UIExt2/Interfaces/IShellListing/SelectObjectFile/index":{"id":"UIExt2/Interfaces/IShellListing/SelectObjectFile/index","title":"SelectObjectFile","description":"Description","sidebar":"tutorialSidebar"},"UIExt2/Interfaces/IShellListing/SelectObjectOrObjectFileVersion/index":{"id":"UIExt2/Interfaces/IShellListing/SelectObjectOrObjectFileVersion/index","title":"SelectObjectOrObjectFileVersion","description":"Description","sidebar":"tutorialSidebar"},"UIExt2/Interfaces/IShellListing/SelectObjectVersion/index":{"id":"UIExt2/Interfaces/IShellListing/SelectObjectVersion/index","title":"SelectObjectVersion","description":"Description","sidebar":"tutorialSidebar"},"UIExt2/Interfaces/IShellListing/SelectPrevFolder/index":{"id":"UIExt2/Interfaces/IShellListing/SelectPrevFolder/index","title":"SelectPrevFolder","description":"Description","sidebar":"tutorialSidebar"},"UIExt2/Interfaces/IShellListing/SelectPrevObject/index":{"id":"UIExt2/Interfaces/IShellListing/SelectPrevObject/index","title":"SelectPrevObject","description":"Description","sidebar":"tutorialSidebar"},"UIExt2/Interfaces/IShellListing/SelectPrevObjectFile/index":{"id":"UIExt2/Interfaces/IShellListing/SelectPrevObjectFile/index","title":"SelectPrevObjectFile","description":"Description","sidebar":"tutorialSidebar"},"UIExt2/Interfaces/IShellListing/SetFolderOrObjectVersionSelectionStates/index":{"id":"UIExt2/Interfaces/IShellListing/SetFolderOrObjectVersionSelectionStates/index","title":"SetFolderOrObjectVersionSelectionStates","description":"Description","sidebar":"tutorialSidebar"},"UIExt2/Interfaces/IShellListing/SetFolderSelectionStates/index":{"id":"UIExt2/Interfaces/IShellListing/SetFolderSelectionStates/index","title":"SetFolderSelectionStates","description":"Description","sidebar":"tutorialSidebar"},"UIExt2/Interfaces/IShellListing/SetObjectOrObjectFileVersionSelectionStates/index":{"id":"UIExt2/Interfaces/IShellListing/SetObjectOrObjectFileVersionSelectionStates/index","title":"SetObjectOrObjectFileVersionSelectionStates","description":"Description","sidebar":"tutorialSidebar"},"UIExt2/Interfaces/IShellListing/SetObjectVersionSelectionStates/index":{"id":"UIExt2/Interfaces/IShellListing/SetObjectVersionSelectionStates/index","title":"SetObjectVersionSelectionStates","description":"Description","sidebar":"tutorialSidebar"},"UIExt2/Interfaces/IShellListing/SetVirtualSelection/index":{"id":"UIExt2/Interfaces/IShellListing/SetVirtualSelection/index","title":"SetVirtualSelection","description":"Description","sidebar":"tutorialSidebar"},"UIExt2/Interfaces/IShellListing/UnselectAll/index":{"id":"UIExt2/Interfaces/IShellListing/UnselectAll/index","title":"UnselectAll","description":"Description","sidebar":"tutorialSidebar"},"UIExt2/Interfaces/IShellListing/UpdateListingItem/index":{"id":"UIExt2/Interfaces/IShellListing/UpdateListingItem/index","title":"UpdateListingItem","description":"Description","sidebar":"tutorialSidebar"},"UIExt2/Interfaces/IShellPaneContainer/AddTab/index":{"id":"UIExt2/Interfaces/IShellPaneContainer/AddTab/index","title":"AddTab","description":"Description","sidebar":"tutorialSidebar"},"UIExt2/Interfaces/IShellPaneContainer/GetSelectedTabs/index":{"id":"UIExt2/Interfaces/IShellPaneContainer/GetSelectedTabs/index","title":"GetSelectedTabs","description":"Description","sidebar":"tutorialSidebar"},"UIExt2/Interfaces/IShellPaneContainer/GetTab/index":{"id":"UIExt2/Interfaces/IShellPaneContainer/GetTab/index","title":"GetTab","description":"Description","sidebar":"tutorialSidebar"},"UIExt2/Interfaces/IShellPaneContainer/index":{"id":"UIExt2/Interfaces/IShellPaneContainer/index","title":"IShellPaneContainer","description":"Represents an area of the screen which is reserved for displaying the dashboards. Usually a property of IShellFrame","sidebar":"tutorialSidebar"},"UIExt2/Interfaces/IShellPaneTab/index":{"id":"UIExt2/Interfaces/IShellPaneTab/index","title":"IShellPaneTab","description":"Tabs can be accessed using IShellPaneContainer methods like AddTab or GetTab. Usually Tab is used to","sidebar":"tutorialSidebar"},"UIExt2/Interfaces/IShellPaneTab/Remove/index":{"id":"UIExt2/Interfaces/IShellPaneTab/Remove/index","title":"Remove","description":"Description","sidebar":"tutorialSidebar"},"UIExt2/Interfaces/IShellPaneTab/Select/index":{"id":"UIExt2/Interfaces/IShellPaneTab/Select/index","title":"Select","description":"Description","sidebar":"tutorialSidebar"},"UIExt2/Interfaces/IShellPaneTab/SetVisible/index":{"id":"UIExt2/Interfaces/IShellPaneTab/SetVisible/index","title":"SetVisible","description":"Description","sidebar":"tutorialSidebar"},"UIExt2/Interfaces/IShellPaneTab/ShowDashboard/index":{"id":"UIExt2/Interfaces/IShellPaneTab/ShowDashboard/index","title":"ShowDashboard","description":"Description","sidebar":"tutorialSidebar"},"UIExt2/Interfaces/IShellPaneTab/ShowEmptyContent/index":{"id":"UIExt2/Interfaces/IShellPaneTab/ShowEmptyContent/index","title":"ShowEmptyContent","description":"Description","sidebar":"tutorialSidebar"},"UIExt2/Interfaces/IShellPaneTab/Unselect/index":{"id":"UIExt2/Interfaces/IShellPaneTab/Unselect/index","title":"Unselect","description":"Description","sidebar":"tutorialSidebar"},"UIExt2/Interfaces/IShellUI/BroadcastMessage/index":{"id":"UIExt2/Interfaces/IShellUI/BroadcastMessage/index","title":"BroadcastMessage","description":"Description","sidebar":"tutorialSidebar"},"UIExt2/Interfaces/IShellUI/GetFileTypeIconURL/index":{"id":"UIExt2/Interfaces/IShellUI/GetFileTypeIconURL/index","title":"GetFileTypeIconURL","description":"Description","sidebar":"tutorialSidebar"},"UIExt2/Interfaces/IShellUI/GetObjectTypeIconURL/index":{"id":"UIExt2/Interfaces/IShellUI/GetObjectTypeIconURL/index","title":"GetObjectTypeIconURL","description":"Description","sidebar":"tutorialSidebar"},"UIExt2/Interfaces/IShellUI/GetValueListItemIconURL/index":{"id":"UIExt2/Interfaces/IShellUI/GetValueListItemIconURL/index","title":"GetValueListItemIconURL","description":"Description","sidebar":"tutorialSidebar"},"UIExt2/Interfaces/IShellUI/index":{"id":"UIExt2/Interfaces/IShellUI/index","title":"IShellUI","description":"The IShellUI is available for the Modules on the module startup event","sidebar":"tutorialSidebar"},"UIExt2/Interfaces/IShellUI/NotifyApplication/index":{"id":"UIExt2/Interfaces/IShellUI/NotifyApplication/index","title":"NotifyApplication","description":"Description","sidebar":"tutorialSidebar"},"UIExt2/Interfaces/IShellUI/ShowMessage/index":{"id":"UIExt2/Interfaces/IShellUI/ShowMessage/index","title":"ShowMessage","description":"Description","sidebar":"tutorialSidebar"},"UIExt2/Interfaces/IShellUI/ShowPopupDashboard/index":{"id":"UIExt2/Interfaces/IShellUI/ShowPopupDashboard/index","title":"ShowPopupDashboard","description":"Description","sidebar":"tutorialSidebar"},"UIExt2/Interfaces/IWindow/Close/index":{"id":"UIExt2/Interfaces/IWindow/Close/index","title":"Close","description":"Description","sidebar":"tutorialSidebar"},"UIExt2/Interfaces/IWindow/index":{"id":"UIExt2/Interfaces/IWindow/index","title":"IWindow","description":"Instance of IWindow is found from Window property of IDashboard when the dashboard is created as a popup dashboard","sidebar":"tutorialSidebar"},"UIExt2/Interfaces/IWindow/ResizeToDefaultSize/index":{"id":"UIExt2/Interfaces/IWindow/ResizeToDefaultSize/index","title":"ResizeToDefaultSize","description":"Description","sidebar":"tutorialSidebar"},"UIExt2/Interfaces/IWindow/SetCloseIconVisibility/index":{"id":"UIExt2/Interfaces/IWindow/SetCloseIconVisibility/index","title":"SetCloseIconVisibility","description":"Description","sidebar":"tutorialSidebar"},"UIExt2/Interfaces/IWindow/SetDefaultSize/index":{"id":"UIExt2/Interfaces/IWindow/SetDefaultSize/index","title":"SetDefaultSize","description":"Description","sidebar":"tutorialSidebar"},"UIExt2/Interfaces/IWindow/SetSize/index":{"id":"UIExt2/Interfaces/IWindow/SetSize/index","title":"SetSize","description":"Description","sidebar":"tutorialSidebar"},"UIExt2/Interfaces/IWindow/SetTitle/index":{"id":"UIExt2/Interfaces/IWindow/SetTitle/index","title":"SetTitle","description":"Description","sidebar":"tutorialSidebar"},"UIExt2/Interfaces/TListingActionArgs/index":{"id":"UIExt2/Interfaces/TListingActionArgs/index","title":"TListingActionArgs","description":"Properties","sidebar":"tutorialSidebar"},"UIExt2/Models/DashboardConfig/index":{"id":"UIExt2/Models/DashboardConfig/index","title":"DashboardConfig","description":"Description","sidebar":"tutorialSidebar"},"UIExt2/Models/DialogUIParams/index":{"id":"UIExt2/Models/DialogUIParams/index","title":"DialogUIParams","description":"Description","sidebar":"tutorialSidebar"},"UIExt2/Models/Facet/index":{"id":"UIExt2/Models/Facet/index","title":"Facet","description":"Description","sidebar":"tutorialSidebar"},"UIExt2/Models/FacetDefinition/index":{"id":"UIExt2/Models/FacetDefinition/index","title":"FacetDefinition","description":"Description","sidebar":"tutorialSidebar"},"UIExt2/Models/FacetLookupValue/index":{"id":"UIExt2/Models/FacetLookupValue/index","title":"FacetLookupValue","description":"Description","sidebar":"tutorialSidebar"},"UIExt2/Models/FacetNumericRangeValue/index":{"id":"UIExt2/Models/FacetNumericRangeValue/index","title":"FacetNumericRangeValue","description":"Description","sidebar":"tutorialSidebar"},"UIExt2/Models/FacetNumericValue/index":{"id":"UIExt2/Models/FacetNumericValue/index","title":"FacetNumericValue","description":"Description","sidebar":"tutorialSidebar"},"UIExt2/Models/FacetStringValue/index":{"id":"UIExt2/Models/FacetStringValue/index","title":"FacetStringValue","description":"Description","sidebar":"tutorialSidebar"},"UIExt2/Models/FacetValue/index":{"id":"UIExt2/Models/FacetValue/index","title":"FacetValue","description":"Description","sidebar":"tutorialSidebar"},"UIExt2/Models/FtsScope/index":{"id":"UIExt2/Models/FtsScope/index","title":"FtsScope","description":"Description","sidebar":"tutorialSidebar"},"UIExt2/Models/IIconInformation/index":{"id":"UIExt2/Models/IIconInformation/index","title":"IIconInformation","description":"Description","sidebar":"tutorialSidebar"},"UIExt2/Models/index":{"id":"UIExt2/Models/index","title":"Models","description":"","sidebar":"tutorialSidebar"},"UIExt2/Models/INonSensitiveVaultData/index":{"id":"UIExt2/Models/INonSensitiveVaultData/index","title":"INonSensitiveVaultData","description":"Description","sidebar":"tutorialSidebar"},"UIExt2/Models/ISelectedFile/index":{"id":"UIExt2/Models/ISelectedFile/index","title":"ISelectedFile","description":"Description","sidebar":"tutorialSidebar"},"UIExt2/Models/IVaultInfo/index":{"id":"UIExt2/Models/IVaultInfo/index","title":"IVaultInfo","description":"Description","sidebar":"tutorialSidebar"},"UIExt2/Models/IVaultInfoReturnValue/index":{"id":"UIExt2/Models/IVaultInfoReturnValue/index","title":"IVaultInfoReturnValue","description":"Description","sidebar":"tutorialSidebar"},"UIExt2/Models/LookupValue/index":{"id":"UIExt2/Models/LookupValue/index","title":"LookupValue","description":"Properties","sidebar":"tutorialSidebar"},"UIExt2/Models/MFError/index":{"id":"UIExt2/Models/MFError/index","title":"MFError","description":"Description","sidebar":"tutorialSidebar"},"UIExt2/Models/MultiDashboardUIParams/index":{"id":"UIExt2/Models/MultiDashboardUIParams/index","title":"MultiDashboardUIParams","description":"Description","sidebar":"tutorialSidebar"},"UIExt2/Models/NonSensitiveSessionData/index":{"id":"UIExt2/Models/NonSensitiveSessionData/index","title":"NonSensitiveSessionData","description":"Description","sidebar":"tutorialSidebar"},"UIExt2/Models/NumericRangeValue/index":{"id":"UIExt2/Models/NumericRangeValue/index","title":"NumericRangeValue","description":"Properties","sidebar":"tutorialSidebar"},"UIExt2/Models/NumericValue/index":{"id":"UIExt2/Models/NumericValue/index","title":"NumericValue","description":"Properties","sidebar":"tutorialSidebar"},"UIExt2/Models/ObjectCreationInfo/index":{"id":"UIExt2/Models/ObjectCreationInfo/index","title":"ObjectCreationInfo","description":"Description","sidebar":"tutorialSidebar"},"UIExt2/Models/ObjectFile/index":{"id":"UIExt2/Models/ObjectFile/index","title":"ObjectFile","description":"Description","sidebar":"tutorialSidebar"},"UIExt2/Models/ObjectFileVersionArgumentValue/index":{"id":"UIExt2/Models/ObjectFileVersionArgumentValue/index","title":"ObjectFileVersionArgumentValue","description":"Properties","sidebar":"tutorialSidebar"},"UIExt2/Models/ObjectFileVersionParams/index":{"id":"UIExt2/Models/ObjectFileVersionParams/index","title":"ObjectFileVersionParams","description":"Description","sidebar":"tutorialSidebar"},"UIExt2/Models/ObjectWindowResult/index":{"id":"UIExt2/Models/ObjectWindowResult/index","title":"ObjectWindowResult","description":"Description","sidebar":"tutorialSidebar"},"UIExt2/Models/SearchCriteria/index":{"id":"UIExt2/Models/SearchCriteria/index","title":"SearchCriteria","description":"Description","sidebar":"tutorialSidebar"},"UIExt2/Models/ShellFrameFolders/index":{"id":"UIExt2/Models/ShellFrameFolders/index","title":"ShellFrameFolders","description":"Description","sidebar":"tutorialSidebar"},"UIExt2/Models/ShowMessageArgumentValue/index":{"id":"UIExt2/Models/ShowMessageArgumentValue/index","title":"ShowMessageArgumentValue","description":"Description","sidebar":"tutorialSidebar"},"UIExt2/Models/ShowMessageParams/index":{"id":"UIExt2/Models/ShowMessageParams/index","title":"ShowMessageParams","description":"Description","sidebar":"tutorialSidebar"},"UIExt2/Models/ShowMessageReturnValue/index":{"id":"UIExt2/Models/ShowMessageReturnValue/index","title":"ShowMessageReturnValue","description":"Description","sidebar":"tutorialSidebar"},"UIExt2/Models/StringValue/index":{"id":"UIExt2/Models/StringValue/index","title":"StringValue","description":"Properties","sidebar":"tutorialSidebar"},"UIExt2/Models/VaultInfoReturnValue/index":{"id":"UIExt2/Models/VaultInfoReturnValue/index","title":"VaultInfoReturnValue","description":"Description","sidebar":"tutorialSidebar"},"UIExt2/UIExt2":{"id":"UIExt2/UIExt2","title":"API Reference Guide","description":"The M-Files User Interface Extensibility Framework exposes a number of items that are used to interact with the user interface. Use the navigation on the left to view the various interfaces, enumerations, and events that are available to you.","sidebar":"tutorialSidebar"},"Upgrading/deprecated_features":{"id":"Upgrading/deprecated_features","title":"Deprecated features and alternatives","description":"This is a preview version of the User Interface Extensibility Framework v2.0. We may have not identified all missing features and this list may not be comprehensive.","sidebar":"tutorialSidebar"},"Upgrading/index":{"id":"Upgrading/index","title":"Upgrading from previous versions","description":"Version 2.0 of the M-Files User Interface Extensibility Framework contains some significant differences to previous versions. Depending upon the functionality of the application it may require significant refactoring for an application to run in the new framework version. Some functionality may not be supported at all.","sidebar":"tutorialSidebar"}}}')}}]); \ No newline at end of file diff --git a/Frameworks/User-Interface-Extensibility-Framework/Reference/assets/js/d357bae6.3bfe36f3.js b/Frameworks/User-Interface-Extensibility-Framework/Reference/assets/js/d357bae6.3bfe36f3.js new file mode 100644 index 000000000..703f7e9dc --- /dev/null +++ b/Frameworks/User-Interface-Extensibility-Framework/Reference/assets/js/d357bae6.3bfe36f3.js @@ -0,0 +1 @@ +"use strict";(self.webpackChunkuix_2=self.webpackChunkuix_2||[]).push([[873],{3905:(e,t,n)=>{n.d(t,{Zo:()=>c,kt:()=>f});var r=n(67294);function o(e,t,n){return t in e?Object.defineProperty(e,t,{value:n,enumerable:!0,configurable:!0,writable:!0}):e[t]=n,e}function i(e,t){var n=Object.keys(e);if(Object.getOwnPropertySymbols){var r=Object.getOwnPropertySymbols(e);t&&(r=r.filter((function(t){return Object.getOwnPropertyDescriptor(e,t).enumerable}))),n.push.apply(n,r)}return n}function a(e){for(var t=1;t=0||(o[n]=e[n]);return o}(e,t);if(Object.getOwnPropertySymbols){var i=Object.getOwnPropertySymbols(e);for(r=0;r=0||Object.prototype.propertyIsEnumerable.call(e,n)&&(o[n]=e[n])}return o}var s=r.createContext({}),p=function(e){var t=r.useContext(s),n=t;return e&&(n="function"==typeof e?e(t):a(a({},t),e)),n},c=function(e){var t=p(e.components);return r.createElement(s.Provider,{value:t},e.children)},u="mdxType",d={inlineCode:"code",wrapper:function(e){var t=e.children;return r.createElement(r.Fragment,{},t)}},m=r.forwardRef((function(e,t){var n=e.components,o=e.mdxType,i=e.originalType,s=e.parentName,c=l(e,["components","mdxType","originalType","parentName"]),u=p(n),m=o,f=u["".concat(s,".").concat(m)]||u[m]||d[m]||i;return n?r.createElement(f,a(a({ref:t},c),{},{components:n})):r.createElement(f,a({ref:t},c))}));function f(e,t){var n=arguments,o=t&&t.mdxType;if("string"==typeof e||o){var i=n.length,a=new Array(i);a[0]=m;var l={};for(var s in t)hasOwnProperty.call(t,s)&&(l[s]=t[s]);l.originalType=e,l[u]="string"==typeof e?e:o,a[1]=l;for(var p=2;p{n.r(t),n.d(t,{assets:()=>f,contentTitle:()=>d,default:()=>b,frontMatter:()=>u,metadata:()=>m,toc:()=>g});var r=n(87462),o=(n(67294),n(3905));const i={toc:[]},a="wrapper";function l(e){let{components:t,...n}=e;return(0,o.kt)(a,(0,r.Z)({},i,n,{components:t,mdxType:"MDXLayout"}),(0,o.kt)("table",null,(0,o.kt)("thead",{parentName:"table"},(0,o.kt)("tr",{parentName:"thead"},(0,o.kt)("th",{parentName:"tr",align:null},"Name"),(0,o.kt)("th",{parentName:"tr",align:null},"Type"),(0,o.kt)("th",{parentName:"tr",align:null},"Optional"),(0,o.kt)("th",{parentName:"tr",align:null},"Description"))),(0,o.kt)("tbody",{parentName:"table"},(0,o.kt)("tr",{parentName:"tbody"},(0,o.kt)("td",{parentName:"tr",align:null},"relationshipPropertyDefId"),(0,o.kt)("td",{parentName:"tr",align:null},(0,o.kt)("inlineCode",{parentName:"td"},"number")),(0,o.kt)("td",{parentName:"tr",align:null},"No"),(0,o.kt)("td",{parentName:"tr",align:null},"The multi-select lookup property whose newly-added items should be revealed \u2014 a ",(0,o.kt)("br",null),"relationship property (relationship drops) or the collection-member property ",(0,o.kt)("br",null),"(add-to-collection drops). The listing diffs this property to find what was added and ",(0,o.kt)("br",null),"resolves the group to expand by object identity, so it is agnostic to the group type.")),(0,o.kt)("tr",{parentName:"tbody"},(0,o.kt)("td",{parentName:"tr",align:null},"expansionAnchorRowId"),(0,o.kt)("td",{parentName:"tr",align:null},(0,o.kt)("inlineCode",{parentName:"td"},"string")),(0,o.kt)("td",{parentName:"tr",align:null},"Yes"),(0,o.kt)("td",{parentName:"tr",align:null},"Explicit drop-target row id to anchor the auto-expansion on, independent of the current ",(0,o.kt)("br",null),"listing selection. Set on the drag-and-drop path only (selection there reflects the ",(0,o.kt)("br",null),"dragged objects, not the drop target). When absent (e.g. the context-menu path), the ",(0,o.kt)("br",null),"listing falls back to resolving the anchor from the current selection.")))))}l.isMDXComponent=!0;const s={toc:[]},p="wrapper";function c(e){let{components:t,...n}=e;return(0,o.kt)(p,(0,r.Z)({},s,n,{components:t,mdxType:"MDXLayout"}),(0,o.kt)("p",null,"Context data for event subscribers when the modification was triggered by\na known caller (e.g. createRelationship). Subscribers use it to react with context the\nlisting itself does not know \u2014 for example, to expand the new relationship's group on\nthe source row after a refresh."))}c.isMDXComponent=!0;const u={},d="TListingActionArgs",m={unversionedId:"UIExt2/Interfaces/TListingActionArgs/index",id:"UIExt2/Interfaces/TListingActionArgs/index",title:"TListingActionArgs",description:"Properties",source:"@site/docs/UIExt2/Interfaces/TListingActionArgs/index.mdx",sourceDirName:"UIExt2/Interfaces/TListingActionArgs",slug:"/UIExt2/Interfaces/TListingActionArgs/",permalink:"/Frameworks/User-Interface-Extensibility-Framework/Reference/UIExt2/Interfaces/TListingActionArgs/",draft:!1,tags:[],version:"current",frontMatter:{},sidebar:"tutorialSidebar",previous:{title:"SetTitle",permalink:"/Frameworks/User-Interface-Extensibility-Framework/Reference/UIExt2/Interfaces/IWindow/SetTitle/"},next:{title:"Models",permalink:"/Frameworks/User-Interface-Extensibility-Framework/Reference/UIExt2/Models/"}},f={},g=[{value:"Properties",id:"properties",level:2}],y={toc:g},h="wrapper";function b(e){let{components:t,...n}=e;return(0,o.kt)(h,(0,r.Z)({},y,n,{components:t,mdxType:"MDXLayout"}),(0,o.kt)("h1",{id:"tlistingactionargs"},"TListingActionArgs"),(0,o.kt)(c,{components:n.components,mdxType:"Description"}),(0,o.kt)("h2",{id:"properties"},"Properties"),(0,o.kt)(l,{components:n.components,mdxType:"Properties"}))}b.isMDXComponent=!0}}]); \ No newline at end of file diff --git a/Frameworks/User-Interface-Extensibility-Framework/Reference/assets/js/d357bae6.c284c47c.js b/Frameworks/User-Interface-Extensibility-Framework/Reference/assets/js/d357bae6.c284c47c.js deleted file mode 100644 index 56c405cc8..000000000 --- a/Frameworks/User-Interface-Extensibility-Framework/Reference/assets/js/d357bae6.c284c47c.js +++ /dev/null @@ -1 +0,0 @@ -"use strict";(self.webpackChunkuix_2=self.webpackChunkuix_2||[]).push([[873],{3905:(e,t,r)=>{r.d(t,{Zo:()=>p,kt:()=>d});var n=r(67294);function o(e,t,r){return t in e?Object.defineProperty(e,t,{value:r,enumerable:!0,configurable:!0,writable:!0}):e[t]=r,e}function i(e,t){var r=Object.keys(e);if(Object.getOwnPropertySymbols){var n=Object.getOwnPropertySymbols(e);t&&(n=n.filter((function(t){return Object.getOwnPropertyDescriptor(e,t).enumerable}))),r.push.apply(r,n)}return r}function a(e){for(var t=1;t=0||(o[r]=e[r]);return o}(e,t);if(Object.getOwnPropertySymbols){var i=Object.getOwnPropertySymbols(e);for(n=0;n=0||Object.prototype.propertyIsEnumerable.call(e,r)&&(o[r]=e[r])}return o}var c=n.createContext({}),l=function(e){var t=n.useContext(c),r=t;return e&&(r="function"==typeof e?e(t):a(a({},t),e)),r},p=function(e){var t=l(e.components);return n.createElement(c.Provider,{value:t},e.children)},u="mdxType",m={inlineCode:"code",wrapper:function(e){var t=e.children;return n.createElement(n.Fragment,{},t)}},f=n.forwardRef((function(e,t){var r=e.components,o=e.mdxType,i=e.originalType,c=e.parentName,p=s(e,["components","mdxType","originalType","parentName"]),u=l(r),f=o,d=u["".concat(c,".").concat(f)]||u[f]||m[f]||i;return r?n.createElement(d,a(a({ref:t},p),{},{components:r})):n.createElement(d,a({ref:t},p))}));function d(e,t){var r=arguments,o=t&&t.mdxType;if("string"==typeof e||o){var i=r.length,a=new Array(i);a[0]=f;var s={};for(var c in t)hasOwnProperty.call(t,c)&&(s[c]=t[c]);s.originalType=e,s[u]="string"==typeof e?e:o,a[1]=s;for(var l=2;l{r.r(t),r.d(t,{assets:()=>d,contentTitle:()=>m,default:()=>k,frontMatter:()=>u,metadata:()=>f,toc:()=>g});var n=r(87462),o=(r(67294),r(3905));const i={toc:[]},a="wrapper";function s(e){let{components:t,...r}=e;return(0,o.kt)(a,(0,n.Z)({},i,r,{components:t,mdxType:"MDXLayout"}),(0,o.kt)("table",null,(0,o.kt)("thead",{parentName:"table"},(0,o.kt)("tr",{parentName:"thead"},(0,o.kt)("th",{parentName:"tr",align:null},"Name"),(0,o.kt)("th",{parentName:"tr",align:null},"Type"),(0,o.kt)("th",{parentName:"tr",align:null},"Optional"),(0,o.kt)("th",{parentName:"tr",align:null},"Description"))),(0,o.kt)("tbody",{parentName:"table"},(0,o.kt)("tr",{parentName:"tbody"},(0,o.kt)("td",{parentName:"tr",align:null},"relationshipPropertyDefId"),(0,o.kt)("td",{parentName:"tr",align:null},(0,o.kt)("inlineCode",{parentName:"td"},"number")),(0,o.kt)("td",{parentName:"tr",align:null},"No"),(0,o.kt)("td",{parentName:"tr",align:null})))))}s.isMDXComponent=!0;const c={toc:[]},l="wrapper";function p(e){let{components:t,...r}=e;return(0,o.kt)(l,(0,n.Z)({},c,r,{components:t,mdxType:"MDXLayout"}),(0,o.kt)("p",null,"Context data for event subscribers when the modification was triggered by\na known caller (e.g. createRelationship). Subscribers use it to react with context the\nlisting itself does not know \u2014 for example, to expand the new relationship's group on\nthe source row after a refresh."))}p.isMDXComponent=!0;const u={},m="TListingActionArgs",f={unversionedId:"UIExt2/Interfaces/TListingActionArgs/index",id:"UIExt2/Interfaces/TListingActionArgs/index",title:"TListingActionArgs",description:"Properties",source:"@site/docs/UIExt2/Interfaces/TListingActionArgs/index.mdx",sourceDirName:"UIExt2/Interfaces/TListingActionArgs",slug:"/UIExt2/Interfaces/TListingActionArgs/",permalink:"/Frameworks/User-Interface-Extensibility-Framework/Reference/UIExt2/Interfaces/TListingActionArgs/",draft:!1,tags:[],version:"current",frontMatter:{},sidebar:"tutorialSidebar",previous:{title:"SetTitle",permalink:"/Frameworks/User-Interface-Extensibility-Framework/Reference/UIExt2/Interfaces/IWindow/SetTitle/"},next:{title:"Models",permalink:"/Frameworks/User-Interface-Extensibility-Framework/Reference/UIExt2/Models/"}},d={},g=[{value:"Properties",id:"properties",level:2}],y={toc:g},b="wrapper";function k(e){let{components:t,...r}=e;return(0,o.kt)(b,(0,n.Z)({},y,r,{components:t,mdxType:"MDXLayout"}),(0,o.kt)("h1",{id:"tlistingactionargs"},"TListingActionArgs"),(0,o.kt)(p,{components:r.components,mdxType:"Description"}),(0,o.kt)("h2",{id:"properties"},"Properties"),(0,o.kt)(s,{components:r.components,mdxType:"Properties"}))}k.isMDXComponent=!0}}]); \ No newline at end of file diff --git a/Frameworks/User-Interface-Extensibility-Framework/Reference/assets/js/main.53138582.js b/Frameworks/User-Interface-Extensibility-Framework/Reference/assets/js/main.53138582.js new file mode 100644 index 000000000..d4d92261b --- /dev/null +++ b/Frameworks/User-Interface-Extensibility-Framework/Reference/assets/js/main.53138582.js @@ -0,0 +1,2 @@ +/*! For license information please see main.53138582.js.LICENSE.txt */ +(self.webpackChunkuix_2=self.webpackChunkuix_2||[]).push([[179],{50997:(e,t,r)=>{"use strict";r.d(t,{Z:()=>m});var n=r(67294),a=r(87462),i=r(68356),o=r.n(i),s=r(16887);const c={"00a1a352":[()=>Promise.all([r.e(3312),r.e(9027)]).then(r.bind(r,47441)),"@site/docs/Samples/TaskbarCommands/index.mdx",47441],"00badb69":[()=>r.e(6928).then(r.bind(r,17964)),"@site/docs/gRPC/Messages/SetPropertiesParams/index.mdx",17964],"00dc6027":[()=>r.e(587).then(r.bind(r,83753)),"@site/docs/gRPC/Messages/NamedValue/index.mdx",83753],"02004f22":[()=>Promise.all([r.e(3312),r.e(3381)]).then(r.bind(r,83756)),"@site/docs/UIExt2/Interfaces/IDashboard/GetSandboxAttributes/index.mdx",83756],"023fe960":[()=>Promise.all([r.e(3312),r.e(4855)]).then(r.bind(r,11575)),"@site/docs/UIExt2/Interfaces/IShellListing/RemoveListingItem/index.mdx",11575],"0242ce88":[()=>Promise.all([r.e(3312),r.e(6766)]).then(r.bind(r,59260)),"@site/docs/UIExt2/Interfaces/IShellUI/ShowMessage/index.mdx",59260],"026580b3":[()=>r.e(8475).then(r.bind(r,48409)),"@site/docs/UIExt2/Enums/FacetType/index.mdx",48409],"02b6ad52":[()=>r.e(8523).then(r.bind(r,94481)),"@site/docs/gRPC/Messages/WorkflowBasic/index.mdx",94481],"02da5699":[()=>r.e(4338).then(r.bind(r,93034)),"@site/docs/gRPC/Messages/ValueList/index.mdx",93034],"02e7af0b":[()=>r.e(4919).then(r.bind(r,7296)),"@site/docs/UIExt2/Enums/ObjectWindowResultCode/index.mdx",7296],"03043b00":[()=>r.e(4567).then(r.bind(r,44166)),"@site/docs/gRPC/Messages/SearchOutputInfo/index.mdx",44166],"032e2d29":[()=>r.e(1474).then(r.bind(r,52699)),"@site/docs/gRPC/Messages/PropertyValue/index.mdx",52699],"03928161":[()=>r.e(4897).then(r.bind(r,12968)),"@site/docs/gRPC/Messages/ExpressionUnion/index.mdx",12968],"044793e8":[()=>r.e(9325).then(r.bind(r,90089)),"@site/docs/gRPC/Messages/OBJECTCAPABILITYFLAGS/index.mdx",90089],"055b800b":[()=>r.e(1600).then(r.bind(r,72216)),"@site/docs/gRPC/Messages/ExpressionUnion/StatusValueData/index.mdx",72216],"05a4f829":[()=>r.e(9871).then(r.bind(r,22783)),"@site/docs/gRPC/Enums/FileIDType/index.mdx",22783],"05a8af3c":[()=>r.e(89).then(r.bind(r,99144)),"@site/docs/gRPC/Messages/FolderInfoUnion/ExternalViewFolderData/index.mdx",99144],"062f6f19":[()=>Promise.all([r.e(3312),r.e(3938)]).then(r.bind(r,95357)),"@site/docs/UIExt2/Interfaces/IDashboard/ShowMessage/index.mdx",95357],"06997115":[()=>r.e(7346).then(r.bind(r,49553)),"@site/docs/gRPC/Messages/TypedValue/index.mdx",49553],"077be933":[()=>Promise.all([r.e(3312),r.e(752)]).then(r.bind(r,85735)),"@site/docs/UIExt2/Interfaces/ICommands/CreateCustomCommand/index.mdx",85735],"0796eb76":[()=>r.e(5052).then(r.bind(r,51525)),"@site/docs/gRPC/Messages/PropertyValueWithMetadataArray/index.mdx",51525],"084a533d":[()=>Promise.all([r.e(3312),r.e(1040)]).then(r.bind(r,94686)),"@site/docs/UIExt2/Interfaces/IShellListing/SetObjectVersionSelectionStates/index.mdx",94686],"09fc7042":[()=>r.e(3315).then(r.bind(r,99561)),"@site/docs/UIExt2/Enums/MFBuiltInPropertyDef/index.mdx",99561],"0a0d9837":[()=>r.e(5601).then(r.bind(r,41038)),"@site/docs/gRPC/Enums/ObjectVersionDataRequestErrorTolerance/index.mdx",41038],"0a2f31e7":[()=>r.e(7842).then(r.bind(r,22487)),"@site/docs/gRPC/Messages/ObjVerWithProperties/index.mdx",22487],"0a4ea76a":[()=>Promise.all([r.e(3312),r.e(8975)]).then(r.bind(r,36603)),"@site/docs/gRPC/Interfaces/VaultOperations/GetMetadataStructureItemIdByAlias/index.mdx",36603],"0ac9f55a":[()=>r.e(4461).then(r.bind(r,97435)),"@site/docs/gRPC/Messages/EXPRESSIONEXFLAGS/index.mdx",97435],"0ae78c6c":[()=>r.e(1964).then(r.bind(r,18014)),"@site/docs/gRPC/Messages/NamedACL/index.mdx",18014],"0b43b026":[()=>Promise.all([r.e(3312),r.e(4945)]).then(r.bind(r,24820)),"@site/docs/UIExt2/Interfaces/IShellPaneContainer/AddTab/index.mdx",24820],"0b51fd32":[()=>Promise.all([r.e(3312),r.e(4531)]).then(r.bind(r,46715)),"@site/docs/UIExt2/Interfaces/IShellListing/SetFolderSelectionStates/index.mdx",46715],"0ba729d8":[()=>r.e(2235).then(r.bind(r,5312)),"@site/docs/UIExt2/Models/NumericRangeValue/index.mdx",5312],"0be31aea":[()=>Promise.all([r.e(3312),r.e(6307)]).then(r.bind(r,38946)),"@site/docs/UIExt2/Interfaces/IWindow/SetCloseIconVisibility/index.mdx",38946],"0c4a3a1b":[()=>Promise.all([r.e(3312),r.e(5359)]).then(r.bind(r,33555)),"@site/docs/gRPC/Interfaces/ObjectOperations/AddObjectFile/index.mdx",33555],"0c99769f":[()=>Promise.all([r.e(3312),r.e(3019)]).then(r.bind(r,86004)),"@site/docs/gRPC/Interfaces/ObjectOperations/DestroyObjects/index.mdx",86004],"0ceb8378":[()=>r.e(8362).then(r.bind(r,88619)),"@site/docs/gRPC/Messages/FolderInfoUnion/AnyFolderData/index.mdx",88619],"0d5b6fea":[()=>Promise.all([r.e(3312),r.e(9519)]).then(r.bind(r,46019)),"@site/docs/gRPC/Interfaces/ObjectOperations/AddObjectWithFiles/index.mdx",46019],"0dc14e6f":[()=>Promise.all([r.e(3312),r.e(6385)]).then(r.bind(r,6181)),"@site/docs/UIExt2/Interfaces/IShellListing/SelectPrevObject/index.mdx",6181],"0dcf823b":[()=>r.e(5027).then(r.bind(r,78363)),"@site/docs/gRPC/Messages/ErrorInfo/index.mdx",78363],"0dfc5aa5":[()=>Promise.all([r.e(3312),r.e(9294)]).then(r.bind(r,3441)),"@site/docs/Samples/BuiltInCommands/index.mdx",3441],"0ee52587":[()=>Promise.all([r.e(3312),r.e(3567)]).then(r.bind(r,72679)),"@site/docs/gRPC/Interfaces/SearchOperations/GetFolderContents/index.mdx",72679],"0f766d91":[()=>r.e(9316).then(r.bind(r,1534)),"@site/docs/gRPC/Messages/IndirectPropertyID/index.mdx",1534],"0f822863":[()=>Promise.all([r.e(3312),r.e(9626)]).then(r.bind(r,90774)),"@site/docs/UIExt2/Interfaces/ICommonFunctions/ReadFromWebStorage/index.mdx",90774],"0fbca248":[()=>Promise.all([r.e(3312),r.e(14)]).then(r.bind(r,85702)),"@site/docs/gRPC/Interfaces/ValueListsOperations/SearchValueListItemsWithPermissions/index.mdx",85702],"0fbff9bf":[()=>Promise.all([r.e(3312),r.e(3240)]).then(r.bind(r,68516)),"@site/docs/UIExt2/Interfaces/IShellListing/AddObjectFile/index.mdx",68516],"1359b449":[()=>r.e(7304).then(r.bind(r,85971)),"@site/docs/UIExt2/Models/ISelectedFile/index.mdx",85971],"13db8ece":[()=>Promise.all([r.e(3312),r.e(7212)]).then(r.bind(r,45010)),"@site/docs/UIExt2/Interfaces/IShellListing/SelectObjectOrObjectFileVersion/index.mdx",45010],"13fb562b":[()=>Promise.all([r.e(3312),r.e(8829)]).then(r.bind(r,38043)),"@site/docs/gRPC/Interfaces/ObjectOperations/PromoteUnmanagedObject/index.mdx",38043],"14dd368d":[()=>r.e(162).then(r.bind(r,9343)),"@site/docs/UIExt2/Models/NonSensitiveSessionData/index.mdx",9343],"15e841b4":[()=>r.e(2572).then(r.bind(r,2073)),"@site/docs/gRPC/Messages/TypedValueUnionWithMetadata/index.mdx",2073],"16c03ecb":[()=>r.e(9739).then(r.bind(r,47460)),"@site/docs/UIExt2/Enums/CommandLocation/index.mdx",47460],"172f513c":[()=>r.e(9059).then(r.bind(r,16152)),"@site/docs/gRPC/Messages/UploadedFile/index.mdx",16152],"1735e8b5":[()=>r.e(9175).then(r.bind(r,56024)),"@site/docs/gRPC/Messages/FolderInfoUnion/UnknownFolderData/index.mdx",56024],"177f6776":[()=>r.e(2827).then(r.bind(r,51638)),"@site/docs/UIExt2/Models/FacetStringValue/index.mdx",51638],17896441:[()=>Promise.all([r.e(3312),r.e(6072),r.e(7918)]).then(r.bind(r,14868)),"@theme/DocItem",14868],"178dc7e6":[()=>r.e(4149).then(r.bind(r,9170)),"@site/docs/Overview/ListingView.mdx",9170],"18e6f2e8":[()=>r.e(3444).then(r.bind(r,6039)),"@site/docs/gRPC/Messages/SEARCHSTATUSFLAGS/index.mdx",6039],"18f1aaa5":[()=>r.e(7334).then(r.bind(r,56745)),"@site/docs/gRPC/Messages/SearchTarget/index.mdx",56745],"192efea6":[()=>r.e(5199).then(r.bind(r,54091)),"@site/docs/gRPC/Enums/FileValueType/index.mdx",54091],"1a26721c":[()=>r.e(6309).then(r.bind(r,35996)),"@site/docs/UIExt2/Models/IIconInformation/index.mdx",35996],"1a424987":[()=>Promise.all([r.e(3312),r.e(4519)]).then(r.bind(r,99546)),"@site/docs/UIExt2/Interfaces/IWindow/SetSize/index.mdx",99546],"1b273c28":[()=>r.e(7310).then(r.bind(r,56025)),"@site/docs/UIExt2/Models/ShowMessageArgumentValue/index.mdx",56025],"1b387f9e":[()=>Promise.all([r.e(3312),r.e(5145)]).then(r.bind(r,86126)),"@site/docs/UIExt2/Interfaces/IShellListing/RefreshObject/index.mdx",86126],"1b777610":[()=>Promise.all([r.e(3312),r.e(1875)]).then(r.bind(r,78337)),"@site/docs/UIExt2/Interfaces/ICommands/SetMenuItemState/index.mdx",78337],"1bd20cba":[()=>Promise.all([r.e(3312),r.e(5288)]).then(r.bind(r,44331)),"@site/docs/UIExt2/Interfaces/ICommonFunctions/GetClientLanguage/index.mdx",44331],"1be78505":[()=>Promise.all([r.e(3312),r.e(9514)]).then(r.bind(r,81299)),"@theme/DocPage",81299],"1c39ee2e":[()=>r.e(9247).then(r.bind(r,40701)),"@site/docs/gRPC/Messages/Template/index.mdx",40701],"1e5fcfb2":[()=>r.e(6057).then(r.bind(r,72402)),"@site/docs/gRPC/Messages/ObjectVersionDataRequest/index.mdx",72402],"1e945f19":[()=>r.e(2542).then(r.bind(r,3157)),"@site/docs/gRPC/Messages/IndirectPropertyIDLevelRef/index.mdx",3157],"213b1148":[()=>r.e(710).then(r.bind(r,15927)),"@site/docs/gRPC/Messages/MultiSelectLookupWithMetadata/index.mdx",15927],"2168c993":[()=>r.e(9528).then(r.bind(r,5345)),"@site/docs/gRPC/Messages/GroupingLevel/index.mdx",5345],"217650e6":[()=>Promise.all([r.e(3312),r.e(4554)]).then(r.bind(r,25238)),"@site/docs/gRPC/Interfaces/ObjectOperations/CheckOutMultiple/index.mdx",25238],"220a8f43":[()=>r.e(7953).then(r.bind(r,21126)),"@site/docs/gRPC/Messages/ObjectTypeIndexingDefinition/index.mdx",21126],"227054b4":[()=>r.e(4289).then(r.bind(r,48293)),"@site/docs/UIExt2/UIExt2.mdx",48293],"22c025b1":[()=>r.e(2078).then(r.bind(r,82674)),"@site/docs/UIExt2/Enums/MFBuiltInValueList/index.mdx",82674],"22c7c454":[()=>r.e(4663).then(r.bind(r,37031)),"@site/docs/gRPC/Messages/OBJECTVERSIONFILEACTIVITYFLAGS/index.mdx",37031],"23034d35":[()=>r.e(7965).then(r.bind(r,5148)),"@site/docs/gRPC/Messages/ExternalRepositoryID/index.mdx",5148],"23546d6a":[()=>r.e(1399).then(r.bind(r,37473)),"@site/docs/UIExt2/Enums/MFBuiltInObjectType/index.mdx",37473],"23df34d8":[()=>r.e(8369).then(r.bind(r,97299)),"@site/docs/gRPC/Messages/FileID/index.mdx",97299],"24378eaf":[()=>Promise.all([r.e(3312),r.e(382)]).then(r.bind(r,44906)),"@site/docs/UIExt2/Interfaces/IShellUI/GetFileTypeIconURL/index.mdx",44906],25885813:[()=>Promise.all([r.e(3312),r.e(3990)]).then(r.bind(r,19812)),"@site/docs/Samples/ObjectOperationSupport/index.mdx",19812],"260ed563":[()=>r.e(3083).then(r.bind(r,40451)),"@site/docs/UIExt2/Enums/SearchEngine/index.mdx",40451],"27029d0b":[()=>Promise.all([r.e(3312),r.e(6280)]).then(r.bind(r,24148)),"@site/docs/UIExt2/Interfaces/IShellListing/SelectNextFolder/index.mdx",24148],27602243:[()=>r.e(5425).then(r.bind(r,56579)),"@site/docs/gRPC/Messages/StateTransitionBasic/index.mdx",56579],"29c1f067":[()=>r.e(1982).then(r.bind(r,1981)),"@site/docs/gRPC/Messages/LookupWithMetadata/index.mdx",1981],"2a5d50d8":[()=>r.e(2608).then(r.bind(r,42969)),"@site/docs/gRPC/Messages/ObjectLevelInfo/index.mdx",42969],"2ac857bf":[()=>r.e(4085).then(r.bind(r,76386)),"@site/docs/gRPC/Messages/AccessControlList/index.mdx",76386],"2c32efe7":[()=>Promise.all([r.e(3312),r.e(5520)]).then(r.bind(r,19874)),"@site/docs/Overview/VaultMessages.mdx",19874],"2dc1053a":[()=>Promise.all([r.e(3312),r.e(411)]).then(r.bind(r,45998)),"@site/docs/UIExt2/Interfaces/ICommonFunctions/UploadTemporaryFiles/index.mdx",45998],"2e5f95a8":[()=>Promise.all([r.e(3312),r.e(8153)]).then(r.bind(r,16378)),"@site/docs/UIExt2/Interfaces/ICommands/DeleteCustomCommand/index.mdx",16378],"2efea495":[()=>r.e(20).then(r.bind(r,35458)),"@site/docs/gRPC/Messages/SearchConditionArray/index.mdx",35458],"2ff231af":[()=>Promise.all([r.e(3312),r.e(5243)]).then(r.bind(r,93395)),"@site/docs/UIExt2/Interfaces/ICommonFunctions/ShowNewObjectWindow/index.mdx",93395],"30fbb789":[()=>r.e(3388).then(r.bind(r,33846)),"@site/docs/Upgrading/index.mdx",33846],"321eeb23":[()=>Promise.all([r.e(3312),r.e(1608)]).then(r.bind(r,22356)),"@site/docs/UIExt2/Interfaces/IShellListing/UnselectAll/index.mdx",22356],"3319a51f":[()=>r.e(3069).then(r.bind(r,68645)),"@site/docs/UIExt2/Models/DashboardConfig/index.mdx",68645],"36676de2":[()=>Promise.all([r.e(3312),r.e(8642)]).then(r.bind(r,62606)),"@site/docs/UIExt2/Interfaces/IShellPaneTab/Select/index.mdx",62606],"367eb14d":[()=>r.e(5925).then(r.bind(r,81875)),"@site/docs/UIExt2/Enums/IconContentType/index.mdx",81875],"36e0ac8f":[()=>r.e(3917).then(r.bind(r,55298)),"@site/docs/gRPC/Messages/AccessControlListComponentKey/index.mdx",55298],"37ee5f99":[()=>r.e(1170).then(r.bind(r,26627)),"@site/docs/UIExt2/Events.mdx",26627],"389f1350":[()=>r.e(9096).then(r.bind(r,49320)),"@site/docs/gRPC/Interfaces/NamedValueStorageOperations/index.mdx",49320],"3973b105":[()=>r.e(8988).then(r.bind(r,8585)),"@site/docs/gRPC/Messages/ExpressionUnion/UninitializedData/index.mdx",8585],"3a57da52":[()=>Promise.all([r.e(3312),r.e(6798)]).then(r.bind(r,68069)),"@site/docs/UIExt2/Interfaces/IShellFrame/NavigateToObject/index.mdx",68069],"3bb18669":[()=>r.e(753).then(r.bind(r,91453)),"@site/docs/gRPC/Enums/AutomaticValueType/index.mdx",91453],"3c3e2dc1":[()=>r.e(6100).then(r.bind(r,67781)),"@site/docs/Overview/Messages.mdx",67781],"3c6e849e":[()=>Promise.all([r.e(3312),r.e(8634)]).then(r.bind(r,83813)),"@site/docs/UIExt2/Interfaces/ICommands/SetTaskbarGroupIcon/index.mdx",83813],"3c72c5ce":[()=>r.e(5042).then(r.bind(r,79724)),"@site/docs/gRPC/Messages/ObjFileSourceUnion/UploadedFilesData/index.mdx",79724],"3ccf52c5":[()=>r.e(760).then(r.bind(r,84041)),"@site/docs/gRPC/Messages/SortFlags/index.mdx",84041],"3d955392":[()=>r.e(6576).then(r.bind(r,18047)),"@site/docs/UIExt2/Models/ObjectFileVersionArgumentValue/index.mdx",18047],"3e048190":[()=>Promise.all([r.e(3312),r.e(1654)]).then(r.bind(r,4390)),"@site/docs/gRPC/Interfaces/NamedValueStorageOperations/SetNamedValues/index.mdx",4390],"3e2e5729":[()=>Promise.all([r.e(3312),r.e(6314)]).then(r.bind(r,74088)),"@site/docs/UIExt2/Interfaces/ISearchPane/SetOptionState/index.mdx",74088],"3e2f23f0":[()=>r.e(3486).then(r.bind(r,66874)),"@site/docs/UIExt2/Enums/index.mdx",66874],"3efe859d":[()=>r.e(5685).then(r.bind(r,23829)),"@site/docs/gRPC/Messages/ValueListItem/index.mdx",23829],"3f003559":[()=>Promise.all([r.e(3312),r.e(2435)]).then(r.bind(r,83405)),"@site/docs/UIExt2/Interfaces/IShellFrame/ShowMessage/index.mdx",83405],"3f0a6e92":[()=>Promise.all([r.e(3312),r.e(5056)]).then(r.bind(r,38153)),"@site/docs/UIExt2/Interfaces/ICommonFunctions/ReportException/index.mdx",38153],"3f164b0b":[()=>r.e(771).then(r.bind(r,87570)),"@site/docs/gRPC/Messages/ExpressionUnion/FileValueData/index.mdx",87570],"3f686d77":[()=>Promise.all([r.e(3312),r.e(8360)]).then(r.bind(r,40024)),"@site/docs/UIExt2/Interfaces/ICommonFunctions/GetAccentColor/index.mdx",40024],"41fe0998":[()=>r.e(6024).then(r.bind(r,45364)),"@site/docs/gRPC/Messages/FTSFLAGS/index.mdx",45364],"4215f152":[()=>Promise.all([r.e(3312),r.e(1381)]).then(r.bind(r,56333)),"@site/docs/UIExt2/Interfaces/IShellFrame/ShowPopupDashboard/index.mdx",56333],"423f3781":[()=>Promise.all([r.e(3312),r.e(9911)]).then(r.bind(r,9495)),"@site/docs/gRPC/Interfaces/PropertyDefsOperations/GetPropertyDefs/index.mdx",9495],42631131:[()=>r.e(7236).then(r.bind(r,24013)),"@site/docs/gRPC/Messages/OBJECTOPFLAGS/index.mdx",24013],"42d41108":[()=>Promise.all([r.e(3312),r.e(2402)]).then(r.bind(r,36647)),"@site/docs/gRPC/Interfaces/ObjectOperations/ChangeSecurity/index.mdx",36647],"42fe11d7":[()=>Promise.all([r.e(3312),r.e(2745)]).then(r.bind(r,71750)),"@site/docs/Samples/SandboxAttributesSupport/index.mdx",71750],"434bb66d":[()=>Promise.all([r.e(3312),r.e(4336)]).then(r.bind(r,90866)),"@site/docs/UIExt2/Interfaces/ICommands/SetIcon/index.mdx",90866],"447b5361":[()=>Promise.all([r.e(3312),r.e(5386)]).then(r.bind(r,55572)),"@site/docs/UIExt2/Interfaces/IShellUI/NotifyApplication/index.mdx",55572],"44afa6ba":[()=>Promise.all([r.e(3312),r.e(2304)]).then(r.bind(r,69030)),"@site/docs/Overview/Events.mdx",69030],"452c116f":[()=>r.e(7326).then(r.bind(r,15338)),"@site/docs/gRPC/Messages/DataFunctionUnion/DateData/index.mdx",15338],"454cbe4a":[()=>r.e(1475).then(r.bind(r,22863)),"@site/docs/gRPC/Enums/AccessControlSubjectType/index.mdx",22863],"4555785a":[()=>r.e(2457).then(r.bind(r,24369)),"@site/docs/UIExt2/Models/Facet/index.mdx",24369],"4569a837":[()=>Promise.all([r.e(3312),r.e(2524)]).then(r.bind(r,52528)),"@site/docs/UIExt2/Interfaces/IShellFrame/CallSimplifiedAPI/index.mdx",52528],"456dc1ab":[()=>r.e(9533).then(r.bind(r,52954)),"@site/docs/getting_started.mdx",52954],"462969dd":[()=>r.e(2776).then(r.bind(r,22954)),"@site/docs/gRPC/Enums/ViewType/index.mdx",22954],"46426cef":[()=>r.e(9322).then(r.bind(r,42678)),"@site/docs/UIExt2/Models/ShowMessageParams/index.mdx",42678],"4646d90e":[()=>r.e(202).then(r.bind(r,50333)),"@site/docs/UIExt2/Models/FacetNumericRangeValue/index.mdx",50333],"47355b08":[()=>Promise.all([r.e(3312),r.e(6065)]).then(r.bind(r,75780)),"@site/docs/UIExt2/Interfaces/ICommands/RemoveTaskbarGroup/index.mdx",75780],"4843a057":[()=>Promise.all([r.e(3312),r.e(2254)]).then(r.bind(r,60291)),"@site/docs/gRPC/Interfaces/ObjectOperations/RenameObjectFile/index.mdx",60291],"48445a43":[()=>r.e(6148).then(r.bind(r,41990)),"@site/docs/gRPC/Enums/FolderType/index.mdx",41990],48456343:[()=>Promise.all([r.e(3312),r.e(6452)]).then(r.bind(r,96241)),"@site/docs/UIExt2/Interfaces/ICommands/GetMenuIdOfBuiltInCommand/index.mdx",96241],"48f91159":[()=>r.e(2105).then(r.bind(r,32337)),"@site/docs/gRPC/Messages/FolderInfoUnion/TraditionalFolderData/index.mdx",32337],"49672d2d":[()=>r.e(5929).then(r.bind(r,39636)),"@site/docs/UIExt2/Models/IVaultInfo/index.mdx",39636],49774049:[()=>r.e(2258).then(r.bind(r,64631)),"@site/docs/gRPC/Messages/index.mdx",64631],"49e4e61b":[()=>r.e(9745).then(r.bind(r,40946)),"@site/docs/gRPC/Interfaces/PropertyDefsOperations/index.mdx",40946],"4b0a32fe":[()=>Promise.all([r.e(3312),r.e(2985)]).then(r.bind(r,42699)),"@site/docs/UIExt2/Interfaces/IShellFrame/IsObjectLocation/index.mdx",42699],"4b2238b5":[()=>r.e(2763).then(r.bind(r,50236)),"@site/docs/gRPC/Enums/Datatype/index.mdx",50236],"4b33f12a":[()=>r.e(6427).then(r.bind(r,42261)),"@site/docs/gRPC/Messages/OBJECTDATAREQUESTFLAGS/index.mdx",42261],"4b6cdf45":[()=>r.e(1589).then(r.bind(r,4448)),"@site/docs/UIExt2/Interfaces/IWindow/index.mdx",4448],"4bceb49e":[()=>r.e(1483).then(r.bind(r,69901)),"@site/docs/gRPC/Interfaces/VaultOperations/index.mdx",69901],"4c14bd05":[()=>r.e(536).then(r.bind(r,19240)),"@site/docs/gRPC/Messages/AccessControlListComponentMapEntry/index.mdx",19240],"4c72923f":[()=>r.e(1838).then(r.bind(r,1221)),"@site/docs/Overview/Overview.mdx",1221],"4cbdde10":[()=>r.e(8699).then(r.bind(r,90990)),"@site/docs/gRPC/Messages/SearchCondition/index.mdx",90990],"4d21d6b7":[()=>r.e(6702).then(r.bind(r,91143)),"@site/docs/UIExt2/Models/ObjectCreationInfo/index.mdx",91143],"4d47ac32":[()=>r.e(7984).then(r.bind(r,79243)),"@site/docs/gRPC/Messages/ExpressionUnion/TypedValueData/index.mdx",79243],"4d6ffd70":[()=>r.e(3432).then(r.bind(r,47947)),"@site/docs/gRPC/Messages/SearchDef/index.mdx",47947],"4d8936bc":[()=>r.e(660).then(r.bind(r,5659)),"@site/docs/gRPC/Messages/FOLDERCAPABILITYFLAGS/index.mdx",5659],"4d9746c7":[()=>r.e(6678).then(r.bind(r,29402)),"@site/docs/gRPC/Messages/ObjectTypeSearchCharacteristics/index.mdx",29402],"4e37f062":[()=>Promise.all([r.e(3312),r.e(3135)]).then(r.bind(r,76823)),"@site/docs/UIExt2/Interfaces/IShellUI/GetObjectTypeIconURL/index.mdx",76823],"4ea8df8c":[()=>r.e(8469).then(r.bind(r,59007)),"@site/docs/gRPC/Messages/ObjectVersionActivity/index.mdx",59007],"4ec54ab1":[()=>Promise.all([r.e(3312),r.e(2066)]).then(r.bind(r,82054)),"@site/docs/gRPC/Interfaces/ObjectOperations/GetWorkflowStates/index.mdx",82054],"4ed8cfc2":[()=>r.e(7241).then(r.bind(r,72984)),"@site/docs/gRPC/Interfaces/NamedACLsOperations/index.mdx",72984],"4f862d10":[()=>r.e(1440).then(r.bind(r,74961)),"@site/docs/gRPC/Messages/ObjectVersionActivityRequest/index.mdx",74961],"4f9b42f5":[()=>r.e(1708).then(r.bind(r,95458)),"@site/docs/gRPC/Messages/TypedValueWithMetadata/index.mdx",95458],"4fcfb77f":[()=>r.e(9946).then(r.bind(r,82584)),"@site/docs/gRPC/Messages/AutomaticMetadataRequest/index.mdx",82584],"506345ba":[()=>r.e(5956).then(r.bind(r,70230)),"@site/docs/gRPC/Enums/CallImportance/index.mdx",70230],"513ceec9":[()=>r.e(4379).then(r.bind(r,57757)),"@site/docs/gRPC/Enums/NACLType/index.mdx",57757],"51ac7ed1":[()=>r.e(4969).then(r.bind(r,78634)),"@site/docs/UIExt2/Models/INonSensitiveVaultData/index.mdx",78634],"51b3bd58":[()=>Promise.all([r.e(3312),r.e(7710)]).then(r.bind(r,2035)),"@site/docs/gRPC/Interfaces/ObjectOperations/UploadExistingFiles/index.mdx",2035],"51ca72a3":[()=>r.e(4726).then(r.bind(r,23397)),"@site/docs/gRPC/Messages/File/index.mdx",23397],"5265fdfd":[()=>r.e(3729).then(r.bind(r,52370)),"@site/docs/gRPC/Enums/NamedValueType/index.mdx",52370],"52ed2d7a":[()=>Promise.all([r.e(3312),r.e(508)]).then(r.bind(r,95845)),"@site/docs/UIExt2/Interfaces/ICommonFunctions/GetClientLocaleIn3Letters/index.mdx",95845],"534198c9":[()=>r.e(642).then(r.bind(r,41301)),"@site/docs/gRPC/Messages/PropertyDefPermissionsForClient/index.mdx",41301],"538555da":[()=>r.e(4183).then(r.bind(r,8954)),"@site/docs/UIExt2/Interfaces/IShellPaneContainer/index.mdx",8954],"54a67ac4":[()=>Promise.all([r.e(3312),r.e(8759)]).then(r.bind(r,60619)),"@site/docs/UIExt2/Interfaces/IShellPaneTab/Unselect/index.mdx",60619],55323835:[()=>Promise.all([r.e(3312),r.e(1674)]).then(r.bind(r,16404)),"@site/docs/Overview/Modules.mdx",16404],"556a54dd":[()=>r.e(4676).then(r.bind(r,78677)),"@site/docs/gRPC/Messages/ObjectPermissionsForClient/index.mdx",78677],"5585d983":[()=>Promise.all([r.e(3312),r.e(5010)]).then(r.bind(r,24208)),"@site/docs/UIExt2/Interfaces/IShellListing/ReplaceFile/index.mdx",24208],"561469fa":[()=>Promise.all([r.e(3312),r.e(2949)]).then(r.bind(r,25534)),"@site/docs/UIExt2/Interfaces/IShellPaneTab/ShowEmptyContent/index.mdx",25534],"569ad79a":[()=>r.e(1275).then(r.bind(r,84028)),"@site/docs/gRPC/Enums/PropertySetByType/index.mdx",84028],"570f5e0e":[()=>Promise.all([r.e(3312),r.e(4375)]).then(r.bind(r,51250)),"@site/docs/UIExt2/Interfaces/IShellListing/RefreshListing/index.mdx",51250],"574be0f9":[()=>r.e(5274).then(r.bind(r,34957)),"@site/docs/gRPC/Messages/TypedValueMetadata/index.mdx",34957],"5845f2a3":[()=>r.e(3803).then(r.bind(r,8883)),"@site/docs/gRPC/Messages/PROPERTYDEFFLAGS/index.mdx",8883],"588b146f":[()=>Promise.all([r.e(3312),r.e(4842)]).then(r.bind(r,77319)),"@site/docs/UIExt2/Interfaces/ICommonFunctions/GetUTCOffset/index.mdx",77319],"58aebda7":[()=>Promise.all([r.e(3312),r.e(8027)]).then(r.bind(r,14391)),"@site/docs/UIExt2/Interfaces/IShellPaneTab/ShowDashboard/index.mdx",14391],"58f68e49":[()=>r.e(1516).then(r.bind(r,9938)),"@site/docs/UIExt2/Interfaces/IShellFrame/index.mdx",9938],"59b831e5":[()=>Promise.all([r.e(3312),r.e(4180)]).then(r.bind(r,48035)),"@site/docs/UIExt2/Interfaces/IShellListing/SelectNextObjectFile/index.mdx",48035],"59dcee1d":[()=>r.e(4737).then(r.bind(r,99909)),"@site/docs/gRPC/Messages/ObjectVersionActivityResponse/index.mdx",99909],"5a161bc6":[()=>r.e(9882).then(r.bind(r,27995)),"@site/docs/Overview/Commands.mdx",27995],"5c9db9cf":[()=>r.e(1957).then(r.bind(r,53862)),"@site/docs/UIExt2/Enums/BuiltInIcon/index.mdx",53862],"5d48d1ba":[()=>Promise.all([r.e(3312),r.e(3974)]).then(r.bind(r,83490)),"@site/docs/UIExt2/Interfaces/IShellFrame/GetViewsById/index.mdx",83490],"5d53ca09":[()=>Promise.all([r.e(3312),r.e(5449)]).then(r.bind(r,31132)),"@site/docs/UIExt2/Interfaces/IShellListing/GetFolderName/index.mdx",31132],"5d61ff49":[()=>r.e(4142).then(r.bind(r,14060)),"@site/docs/gRPC/Messages/ExpressionUnion/PermissionsData/index.mdx",14060],"5da3f42f":[()=>r.e(9261).then(r.bind(r,67268)),"@site/docs/gRPC/Messages/ObjVer/index.mdx",67268],"5f451d9f":[()=>r.e(6992).then(r.t.bind(r,83769,19)),"C:\\workarea\\m-files-spec-collector\\test\\output\\docs\\uix2\\.docusaurus\\docusaurus-plugin-content-docs\\default\\plugin-route-context-module-100.json",83769],"5f6c97ad":[()=>Promise.all([r.e(3312),r.e(5057)]).then(r.bind(r,52414)),"@site/docs/gRPC/Interfaces/VaultOperations/GetMetadataStructureItemIdByGUID/index.mdx",52414],"611da069":[()=>r.e(9601).then(r.bind(r,97356)),"@site/docs/UIExt2/Models/SearchCriteria/index.mdx",97356],61733134:[()=>r.e(7819).then(r.bind(r,58724)),"@site/docs/UIExt2/Enums/MFBuiltInView/index.mdx",58724],"62d01ed0":[()=>r.e(1129).then(r.bind(r,83013)),"@site/docs/gRPC/Messages/ObjFileVer/index.mdx",83013],"6587d525":[()=>Promise.all([r.e(3312),r.e(3929)]).then(r.bind(r,52952)),"@site/docs/UIExt2/Interfaces/IShellPaneContainer/GetTab/index.mdx",52952],"659f7a7a":[()=>r.e(6689).then(r.bind(r,80895)),"@site/docs/gRPC/Messages/ItemID/index.mdx",80895],"661847fd":[()=>Promise.all([r.e(3312),r.e(1746)]).then(r.bind(r,40830)),"@site/docs/UIExt2/Interfaces/IShellUI/GetValueListItemIconURL/index.mdx",40830],"6625d7b2":[()=>r.e(6948).then(r.bind(r,55386)),"@site/docs/gRPC/Interfaces/ValueListsOperations/index.mdx",55386],"672bbd31":[()=>Promise.all([r.e(3312),r.e(1)]).then(r.bind(r,25410)),"@site/docs/UIExt2/Interfaces/IEvents/Unregister/index.mdx",25410],"676a459b":[()=>r.e(2960).then(r.bind(r,26841)),"@site/docs/gRPC/Enums/FileSizePrecision/index.mdx",26841],"69681e67":[()=>Promise.all([r.e(3312),r.e(3413)]).then(r.bind(r,47868)),"@site/docs/UIExt2/Interfaces/ICommonFunctions/GetSessionInfo/index.mdx",47868],"696d7af6":[()=>Promise.all([r.e(3312),r.e(7183)]).then(r.bind(r,1357)),"@site/docs/UIExt2/Interfaces/ICommands/GetCommandState/index.mdx",1357],"6ad4349d":[()=>r.e(6810).then(r.bind(r,17145)),"@site/docs/Overview/MFilesGlobalObject.mdx",17145],"6b02bdcc":[()=>r.e(7664).then(r.bind(r,92365)),"@site/docs/gRPC/Messages/RelationshipData/index.mdx",92365],"6bfbab4d":[()=>Promise.all([r.e(3312),r.e(2316)]).then(r.bind(r,5508)),"@site/docs/gRPC/Interfaces/ObjectOperations/GetLatestObjectVersion/index.mdx",5508],"6cc139e9":[()=>Promise.all([r.e(3312),r.e(7119)]).then(r.bind(r,24926)),"@site/docs/UIExt2/Interfaces/ICommonFunctions/DownloadFileAsDataUri/index.mdx",24926],"6d34c0a7":[()=>Promise.all([r.e(3312),r.e(8253)]).then(r.bind(r,17585)),"@site/docs/UIExt2/Interfaces/IShellListing/SelectObjectVersion/index.mdx",17585],"6fb95ab1":[()=>r.e(2073).then(r.bind(r,67713)),"@site/docs/gRPC/Messages/AccessControlEntry/index.mdx",67713],"700249ec":[()=>r.e(7).then(r.bind(r,28347)),"@site/docs/gRPC/Messages/ObjectVersionData/index.mdx",28347],"70327e69":[()=>r.e(7530).then(r.bind(r,71603)),"@site/docs/UIExt2/Models/DialogUIParams/index.mdx",71603],"7048193a":[()=>Promise.all([r.e(3312),r.e(5345)]).then(r.bind(r,28575)),"@site/docs/UIExt2/Interfaces/IShellFrame/ShowPopupDashboards/index.mdx",28575],"706fdde3":[()=>Promise.all([r.e(3312),r.e(927)]).then(r.bind(r,69606)),"@site/docs/UIExt2/Interfaces/ICommonFunctions/WriteToWebStorage/index.mdx",69606],"70b9fe84":[()=>r.e(1141).then(r.bind(r,67638)),"@site/docs/UIExt2/Interfaces/IShellListing/index.mdx",67638],"70bacdcb":[()=>Promise.all([r.e(3312),r.e(8402)]).then(r.bind(r,40785)),"@site/docs/gRPC/Interfaces/ObjectOperations/GetWorkflowStateHistory/index.mdx",40785],"71b0dbc1":[()=>Promise.all([r.e(3312),r.e(532)]).then(r.bind(r,46680)),"@site/docs/gRPC/Interfaces/ObjectOperations/RemoveObjectFile/index.mdx",46680],"725dfaa8":[()=>r.e(2372).then(r.bind(r,44947)),"@site/docs/gRPC/Messages/ObjectVersionPropertyActivity/index.mdx",44947],"7315127c":[()=>Promise.all([r.e(3312),r.e(334)]).then(r.bind(r,51697)),"@site/docs/Samples/PopUpDashboardWithAccentColor/index.mdx",51697],"734ce7c8":[()=>r.e(7551).then(r.bind(r,57449)),"@site/docs/UIExt2/Models/MultiDashboardUIParams/index.mdx",57449],"736620ae":[()=>r.e(3258).then(r.bind(r,83628)),"@site/docs/Overview/Tabs.mdx",83628],74917094:[()=>Promise.all([r.e(3312),r.e(9051)]).then(r.bind(r,16438)),"@site/docs/Samples/VaultMessagesPackage/index.mdx",16438],"74e3de7b":[()=>Promise.all([r.e(3312),r.e(952)]).then(r.bind(r,42122)),"@site/docs/UIExt2/Interfaces/IShellListing/UpdateListingItem/index.mdx",42122],"74f04e55":[()=>r.e(9864).then(r.bind(r,96585)),"@site/docs/gRPC/Messages/SortRule/index.mdx",96585],"7557bec9":[()=>Promise.all([r.e(3312),r.e(6778)]).then(r.bind(r,21327)),"@site/docs/UIExt2/Interfaces/ICommonFunctions/GetClientLocale/index.mdx",21327],"75d6fe36":[()=>Promise.all([r.e(3312),r.e(6077)]).then(r.bind(r,51821)),"@site/docs/gRPC/Interfaces/VaultExtensionMethodsOperations/IsExtensionMethodAvailable/index.mdx",51821],"75e006f6":[()=>r.e(158).then(r.bind(r,8465)),"@site/docs/UIExt2/Models/FacetDefinition/index.mdx",8465],"75f8d1f8":[()=>Promise.all([r.e(3312),r.e(1522)]).then(r.bind(r,7351)),"@site/docs/Overview/InstallingApplications.mdx",7351],"7602eeef":[()=>r.e(3786).then(r.bind(r,79217)),"@site/docs/UIExt2/Interfaces/IEvents/index.mdx",79217],"7606288c":[()=>r.e(63).then(r.bind(r,12984)),"@site/docs/gRPC/Enums/RelationshipDirection/index.mdx",12984],"78a7c1a8":[()=>r.e(4429).then(r.bind(r,57340)),"@site/docs/gRPC/Messages/DataFunctionUnion/DaysFromData/index.mdx",57340],"791fe046":[()=>r.e(2597).then(r.bind(r,22655)),"@site/docs/gRPC/Enums/ACLEnforcingMode/index.mdx",22655],"792a5cf8":[()=>r.e(1068).then(r.bind(r,14258)),"@site/docs/gRPC/Enums/MetadataStructureItem/index.mdx",14258],"79afb607":[()=>r.e(1062).then(r.bind(r,61940)),"@site/docs/gRPC/Enums/ObjectVersionDataRequestVersionType/index.mdx",61940],"7ceee8b4":[()=>r.e(2834).then(r.bind(r,47059)),"@site/docs/UIExt2/Interfaces/ICommands/index.mdx",47059],"7d8ebf0a":[()=>r.e(9749).then(r.bind(r,44980)),"@site/docs/gRPC/Messages/EffectivePermissions/index.mdx",44980],"7dcba6fc":[()=>r.e(8940).then(r.bind(r,42923)),"@site/docs/gRPC/Enums/ObjFileSourceType/index.mdx",42923],"7e161ef0":[()=>Promise.all([r.e(3312),r.e(1990)]).then(r.bind(r,36113)),"@site/docs/gRPC/Interfaces/ObjectOperations/GetAutomaticMetadata/index.mdx",36113],"7f1b4966":[()=>Promise.all([r.e(3312),r.e(9724)]).then(r.bind(r,86385)),"@site/docs/UIExt2/Interfaces/ISearchPane/GetSearchCriteria/index.mdx",86385],"7f346bfa":[()=>Promise.all([r.e(3312),r.e(6115)]).then(r.bind(r,80430)),"@site/docs/UIExt2/Interfaces/IShellPaneContainer/GetSelectedTabs/index.mdx",80430],"7f9a2e60":[()=>r.e(2427).then(r.bind(r,58082)),"@site/docs/gRPC/Messages/PropertyDef/index.mdx",58082],"7fbaade5":[()=>r.e(4358).then(r.bind(r,65613)),"@site/docs/gRPC/Messages/GetMetadataStructureItemIdByGUIDResponse/index.mdx",65613],"7fdf9515":[()=>Promise.all([r.e(3312),r.e(9934)]).then(r.bind(r,72567)),"@site/docs/gRPC/Interfaces/ValueListsOperations/GetValueListItemsWithPermissions/index.mdx",72567],"7feb1174":[()=>Promise.all([r.e(3312),r.e(4433)]).then(r.bind(r,86844)),"@site/docs/UIExt2/Interfaces/IShellFrame/GetSandboxAttributes/index.mdx",86844],"804108fb":[()=>r.e(7873).then(r.bind(r,39939)),"@site/docs/gRPC/gRPC.mdx",39939],"8066e605":[()=>Promise.all([r.e(3312),r.e(4553)]).then(r.bind(r,77402)),"@site/docs/UIExt2/Interfaces/IWindow/Close/index.mdx",77402],"829697da":[()=>r.e(9854).then(r.bind(r,72800)),"@site/docs/gRPC/Messages/FileVer/index.mdx",72800],"844ef9c5":[()=>Promise.all([r.e(3312),r.e(353)]).then(r.bind(r,27790)),"@site/docs/UIExt2/Interfaces/IShellListing/SelectFolder/index.mdx",27790],85470096:[()=>r.e(2164).then(r.bind(r,21991)),"@site/docs/gRPC/Messages/PropertyValueArray/index.mdx",21991],"85c4740b":[()=>Promise.all([r.e(3312),r.e(7076)]).then(r.bind(r,81950)),"@site/docs/UIExt2/Interfaces/IShellListing/ActivateListing/index.mdx",81950],"85fa73c6":[()=>Promise.all([r.e(3312),r.e(7003)]).then(r.bind(r,20675)),"@site/docs/Overview/ApplicationStructure.mdx",20675],"86ea37b9":[()=>r.e(3456).then(r.bind(r,9822)),"@site/docs/gRPC/Messages/VersionCommentArray/index.mdx",9822],"8767d72f":[()=>r.e(6023).then(r.bind(r,39338)),"@site/docs/gRPC/Messages/AssociatedPropertyDef/index.mdx",39338],"879dd42a":[()=>r.e(7481).then(r.bind(r,23797)),"@site/docs/gRPC/Messages/OBJTYPEFLAGS/index.mdx",23797],"881afc32":[()=>r.e(9039).then(r.bind(r,52864)),"@site/docs/gRPC/Messages/ExtObjectInfo/index.mdx",52864],"887773d7":[()=>r.e(5579).then(r.bind(r,48646)),"@site/docs/gRPC/Messages/GetObjectVersionAndPropertiesOfMultipleObjectsResponse/index.mdx",48646],"892cf734":[()=>r.e(8897).then(r.bind(r,20731)),"@site/docs/gRPC/Messages/Bytes/index.mdx",20731],"8a412671":[()=>Promise.all([r.e(3312),r.e(8941)]).then(r.bind(r,94856)),"@site/docs/UIExt2/Interfaces/ISearchPane/IsSearchView/index.mdx",94856],"8b0617a3":[()=>Promise.all([r.e(3312),r.e(2140)]).then(r.bind(r,28733)),"@site/docs/UIExt2/Interfaces/IShellListing/SetObjectOrObjectFileVersionSelectionStates/index.mdx",28733],"8b1c5eb4":[()=>r.e(4962).then(r.bind(r,62179)),"@site/docs/UIExt2/Models/ObjectFileVersionParams/index.mdx",62179],"8b241dce":[()=>Promise.all([r.e(3312),r.e(4523)]).then(r.bind(r,81385)),"@site/docs/UIExt2/Interfaces/IShellListing/AddListingItem/index.mdx",81385],"8c0086ab":[()=>r.e(3116).then(r.bind(r,28765)),"@site/docs/gRPC/Messages/OBJECTVERSIONACTIVITYCATEGORYFLAGS/index.mdx",28765],"8c343c4d":[()=>Promise.all([r.e(3312),r.e(2968)]).then(r.bind(r,55762)),"@site/docs/UIExt2/Interfaces/ISearchPane/GetOptions/index.mdx",55762],"8c544060":[()=>r.e(3270).then(r.bind(r,75008)),"@site/docs/gRPC/Messages/ClassGroup/index.mdx",75008],"8cf04d8a":[()=>Promise.all([r.e(3312),r.e(6154)]).then(r.bind(r,84169)),"@site/docs/UIExt2/Interfaces/ICommands/SetCommandState/index.mdx",84169],"8d129bf9":[()=>r.e(9412).then(r.bind(r,88386)),"@site/docs/gRPC/Messages/ServerVaultCapabilities/index.mdx",88386],"8d40df90":[()=>r.e(393).then(r.bind(r,94272)),"@site/docs/gRPC/Enums/VLSortingType/index.mdx",94272],"8dcbc962":[()=>r.e(926).then(r.bind(r,20772)),"@site/docs/gRPC/Messages/AutomaticMetadataResult/index.mdx",20772],"8e52f2d2":[()=>Promise.all([r.e(3312),r.e(9688)]).then(r.bind(r,62913)),"@site/docs/Samples/AssignToMe/index.mdx",62913],"8e62fd53":[()=>r.e(3242).then(r.bind(r,65362)),"@site/docs/gRPC/Enums/AuthType/index.mdx",65362],"8e8abe00":[()=>Promise.all([r.e(3312),r.e(7803)]).then(r.bind(r,7983)),"@site/docs/Samples/ErrorHandling/index.mdx",7983],"8ea71e52":[()=>r.e(735).then(r.bind(r,27208)),"@site/docs/gRPC/Interfaces/index.mdx",27208],"8ef37325":[()=>r.e(3496).then(r.bind(r,58659)),"@site/docs/UIExt2/Interfaces/index.mdx",58659],"8f576c48":[()=>r.e(8998).then(r.bind(r,51544)),"@site/docs/Overview/Dashboards.mdx",51544],"8fba77aa":[()=>r.e(8111).then(r.bind(r,71489)),"@site/docs/gRPC/Enums/ConditionType/index.mdx",71489],"9039bb87":[()=>r.e(115).then(r.bind(r,17757)),"@site/docs/gRPC/Messages/ExpressionUnion/AnyFieldData/index.mdx",17757],"90f4e341":[()=>r.e(323).then(r.bind(r,76104)),"@site/docs/Samples/ShowNewObjectWindow With Blank and UserDefined Template/index.mdx",76104],"914121af":[()=>Promise.all([r.e(3312),r.e(2868)]).then(r.bind(r,73119)),"@site/docs/UIExt2/Interfaces/IShellListing/SelectObjectFile/index.mdx",73119],"928c3efa":[()=>r.e(1086).then(r.bind(r,76922)),"@site/docs/gRPC/Messages/DataFunctionUnion/MonthData/index.mdx",76922],"935f2afb":[()=>r.e(53).then(r.t.bind(r,1109,19)),"~docs/default/version-current-metadata-prop-751.json",1109],"947642c0":[()=>r.e(9332).then(r.bind(r,22504)),"@site/docs/gRPC/Messages/ObjectClass/index.mdx",22504],"94f33bb6":[()=>r.e(5474).then(r.bind(r,31474)),"@site/docs/gRPC/Messages/SortRuleFlags/index.mdx",31474],"954bfcc2":[()=>r.e(4199).then(r.bind(r,84186)),"@site/docs/gRPC/Messages/ObjFileSource/index.mdx",84186],95693476:[()=>r.e(885).then(r.bind(r,11503)),"@site/docs/UIExt2/Models/VaultInfoReturnValue/index.mdx",11503],"9594f8c7":[()=>r.e(6011).then(r.bind(r,80218)),"@site/docs/UIExt2/Models/ObjectWindowResult/index.mdx",80218],"96594a3e":[()=>r.e(2804).then(r.bind(r,17491)),"@site/docs/Overview/exceptions.mdx",17491],"96fa1c1e":[()=>Promise.all([r.e(3312),r.e(1687)]).then(r.bind(r,13271)),"@site/docs/UIExt2/Interfaces/IShellFrame/ShowDashboard/index.mdx",13271],"973ea1a1":[()=>Promise.all([r.e(3312),r.e(369)]).then(r.bind(r,52693)),"@site/docs/UIExt2/Interfaces/ICommonFunctions/GetVaultInfo/index.mdx",52693],97527335:[()=>r.e(939).then(r.bind(r,18367)),"@site/docs/gRPC/Messages/DataFunctionUnion/DaysToData/index.mdx",18367],"97db5e93":[()=>r.e(8313).then(r.bind(r,44540)),"@site/docs/gRPC/Enums/ExpressionType/index.mdx",44540],"98344aab":[()=>r.e(336).then(r.bind(r,100)),"@site/docs/gRPC/Messages/ObjectVersionEx/index.mdx",100],"99829e13":[()=>r.e(3609).then(r.bind(r,97945)),"@site/docs/gRPC/Messages/SRPREQUESTFLAGS/index.mdx",97945],"99e8270a":[()=>r.e(2916).then(r.bind(r,27149)),"@site/docs/gRPC/Messages/SearchResultsPageRequest/index.mdx",27149],"99f73a53":[()=>r.e(4958).then(r.bind(r,22553)),"@site/docs/gRPC/Messages/SortRuleValueArray/index.mdx",22553],"9a55586e":[()=>Promise.all([r.e(3312),r.e(2501)]).then(r.bind(r,5939)),"@site/docs/UIExt2/Interfaces/IShellPaneTab/Remove/index.mdx",5939],"9a6c634d":[()=>Promise.all([r.e(3312),r.e(5838)]).then(r.bind(r,65772)),"@site/docs/gRPC/Interfaces/ObjectOperations/GetWorkflowStatesAndTransitions/index.mdx",65772],"9b4d1e0e":[()=>Promise.all([r.e(3312),r.e(3434)]).then(r.bind(r,86707)),"@site/docs/gRPC/Interfaces/ObjectOperations/GetObjectFiles/index.mdx",86707],"9b77d754":[()=>r.e(1234).then(r.bind(r,22294)),"@site/docs/gRPC/Messages/OBJVERFLAGS/index.mdx",22294],"9be4119f":[()=>r.e(6448).then(r.bind(r,59646)),"@site/docs/UIExt2/Interfaces/ISearchPane/index.mdx",59646],"9be46b5f":[()=>r.e(6485).then(r.bind(r,86372)),"@site/docs/UIExt2/Models/FacetValue/index.mdx",86372],"9c50e33b":[()=>Promise.all([r.e(3312),r.e(3362)]).then(r.bind(r,9960)),"@site/docs/UIExt2/Interfaces/ICommands/ExecuteCommand/index.mdx",9960],"9c84e54e":[()=>Promise.all([r.e(3312),r.e(5541)]).then(r.bind(r,42029)),"@site/docs/UIExt2/Interfaces/ICommands/RemoveMenuItem/index.mdx",42029],"9cd2eb6e":[()=>r.e(618).then(r.bind(r,71313)),"@site/docs/gRPC/Messages/ITEMFLAGS/index.mdx",71313],"9d7ef52a":[()=>r.e(4755).then(r.bind(r,63737)),"@site/docs/gRPC/Messages/VIEWFLAGS/index.mdx",63737],"9e32eea6":[()=>r.e(7966).then(r.bind(r,36762)),"@site/docs/gRPC/Interfaces/ObjectTypesOperations/index.mdx",36762],"9fd72e02":[()=>r.e(1734).then(r.bind(r,56659)),"@site/docs/gRPC/Messages/ObjFileSourceUnion/UndefinedSourceData/index.mdx",56659],a164aca9:[()=>r.e(9898).then(r.bind(r,95346)),"@site/docs/UIExt2/Models/FacetNumericValue/index.mdx",95346],a21ca3c6:[()=>Promise.all([r.e(3312),r.e(416)]).then(r.bind(r,38869)),"@site/docs/gRPC/Interfaces/ViewsOperations/DeleteView/index.mdx",38869],a3247bb3:[()=>r.e(1728).then(r.bind(r,93948)),"@site/docs/UIExt2/Enums/BuiltinCommand/index.mdx",93948],a331e251:[()=>Promise.all([r.e(3312),r.e(5745)]).then(r.bind(r,27840)),"@site/docs/gRPC/Interfaces/ObjectOperations/GetTemplates/index.mdx",27840],a3b2e1cb:[()=>r.e(5038).then(r.bind(r,11832)),"@site/docs/gRPC/Interfaces/SearchOperations/index.mdx",11832],a4f6fe5f:[()=>r.e(4618).then(r.bind(r,76604)),"@site/docs/gRPC/Messages/DataFunctionUnion/index.mdx",76604],a75888b1:[()=>r.e(7730).then(r.bind(r,36412)),"@site/docs/gRPC/Messages/ViewVisualization/index.mdx",36412],a75aeaa2:[()=>r.e(4662).then(r.bind(r,89397)),"@site/docs/gRPC/Messages/STATEFLAGS/index.mdx",89397],a85e0b52:[()=>r.e(2530).then(r.bind(r,12850)),"@site/docs/UIExt2/Interfaces/IShellItems/index.mdx",12850],a9bb6895:[()=>r.e(2712).then(r.bind(r,93130)),"@site/docs/UIExt2/Models/FacetLookupValue/index.mdx",93130],a9e6f9fd:[()=>r.e(1854).then(r.bind(r,35786)),"@site/docs/UIExt2/Interfaces/IDashboard/index.mdx",35786],aac056c0:[()=>r.e(4955).then(r.bind(r,45192)),"@site/docs/gRPC/Messages/ObjectTypePermissionsForClient/index.mdx",45192],aae90ecd:[()=>r.e(4286).then(r.bind(r,29736)),"@site/docs/gRPC/Messages/AutomaticPermissions/index.mdx",29736],ac75203c:[()=>Promise.all([r.e(3312),r.e(2888)]).then(r.bind(r,30122)),"@site/docs/UIExt2/Interfaces/ICommands/RemoveCustomCommandFromMenu/index.mdx",30122],acf5d81f:[()=>Promise.all([r.e(3312),r.e(3328)]).then(r.bind(r,956)),"@site/docs/gRPC/Interfaces/NamedValueStorageOperations/GetNamedValues/index.mdx",956],aeca9f0e:[()=>r.e(5439).then(r.bind(r,10010)),"@site/docs/gRPC/Messages/Workflow/index.mdx",10010],af2f952f:[()=>r.e(7523).then(r.bind(r,63921)),"@site/docs/gRPC/Messages/FolderInfoUnion/ViewFolderData/index.mdx",63921],af97eba5:[()=>r.e(4356).then(r.bind(r,92779)),"@site/docs/UIExt2/Models/StringValue/index.mdx",92779],afa269d6:[()=>Promise.all([r.e(3312),r.e(220)]).then(r.bind(r,31306)),"@site/docs/gRPC/Interfaces/ObjectOperations/SetObjectLevelProperty/index.mdx",31306],afd057dc:[()=>Promise.all([r.e(3312),r.e(3327)]).then(r.bind(r,69979)),"@site/docs/UIExt2/Interfaces/IShellListing/SelectPrevObjectFile/index.mdx",69979],b02dfc26:[()=>r.e(9666).then(r.bind(r,78631)),"@site/docs/gRPC/Enums/UpdateType/index.mdx",78631],b078c762:[()=>Promise.all([r.e(3312),r.e(9009)]).then(r.bind(r,16598)),"@site/docs/gRPC/Interfaces/NamedValueStorageOperations/RemoveNamedValues/index.mdx",16598],b08a4d52:[()=>Promise.all([r.e(3312),r.e(7189)]).then(r.bind(r,46553)),"@site/docs/UIExt2/Interfaces/ICommands/GetCommandName/index.mdx",46553],b1348f93:[()=>Promise.all([r.e(3312),r.e(4854)]).then(r.bind(r,53158)),"@site/docs/UIExt2/Interfaces/IEvents/RegisterBuiltinCommand/index.mdx",53158],b1a5caff:[()=>r.e(3697).then(r.bind(r,98758)),"@site/docs/gRPC/Interfaces/ObjectOperations/index.mdx",98758],b38589ba:[()=>r.e(2029).then(r.bind(r,20656)),"@site/docs/gRPC/Messages/ObjectTypeTargetForBrowsing/index.mdx",20656],b6273dc1:[()=>r.e(2451).then(r.bind(r,36520)),"@site/docs/gRPC/Messages/IndirectPropertyIDLevel/index.mdx",36520],b6b0b2af:[()=>r.e(8302).then(r.bind(r,49702)),"@site/docs/gRPC/Messages/ObjID/index.mdx",49702],b7d27134:[()=>r.e(6963).then(r.bind(r,67658)),"@site/docs/gRPC/Enums/index.mdx",67658],b859730c:[()=>Promise.all([r.e(3312),r.e(976)]).then(r.bind(r,54011)),"@site/docs/gRPC/Interfaces/ObjectOperations/CheckInMultiple/index.mdx",54011],b8989274:[()=>Promise.all([r.e(3312),r.e(5214)]).then(r.bind(r,96463)),"@site/docs/UIExt2/Interfaces/IEvents/Register/index.mdx",96463],b8ec0f96:[()=>r.e(1398).then(r.bind(r,63328)),"@site/docs/gRPC/Messages/FolderInfoUnion/PropertyFolderData/index.mdx",63328],b94048ca:[()=>r.e(6842).then(r.bind(r,50002)),"@site/docs/UIExt2/Models/ShowMessageReturnValue/index.mdx",50002],b9bafd8b:[()=>r.e(3447).then(r.bind(r,17343)),"@site/docs/gRPC/Messages/Expression/index.mdx",17343],ba4379ee:[()=>Promise.all([r.e(3312),r.e(3342)]).then(r.bind(r,82079)),"@site/docs/gRPC/Interfaces/ObjectOperations/GetDocEventSubscriptions/index.mdx",82079],bb9b07ea:[()=>r.e(7505).then(r.bind(r,7213)),"@site/docs/UIExt2/Models/MFError/index.mdx",7213],bbcfbb71:[()=>r.e(6398).then(r.bind(r,83164)),"@site/docs/gRPC/Messages/VersionComment/index.mdx",83164],bc733190:[()=>Promise.all([r.e(3312),r.e(3977)]).then(r.bind(r,58173)),"@site/docs/gRPC/Interfaces/ObjectOperations/RemoveObjects/index.mdx",58173],bd56a136:[()=>Promise.all([r.e(3312),r.e(2279)]).then(r.bind(r,40533)),"@site/docs/UIExt2/Interfaces/IShellItems/GetObjectVersionsAndProperties/index.mdx",40533],bd9361b1:[()=>r.e(5189).then(r.bind(r,34221)),"@site/docs/gRPC/Messages/FolderInfoUnion/index.mdx",34221],bdd698e4:[()=>Promise.all([r.e(3312),r.e(6535)]).then(r.bind(r,35265)),"@site/docs/UIExt2/Interfaces/IShellListing/SelectNextObject/index.mdx",35265],be24d9e7:[()=>r.e(7315).then(r.bind(r,129)),"@site/docs/UIExt2/Models/IVaultInfoReturnValue/index.mdx",129],be61d4cc:[()=>r.e(4418).then(r.bind(r,69311)),"@site/docs/gRPC/Messages/ViewLocation/index.mdx",69311],be62366d:[()=>r.e(4473).then(r.bind(r,6870)),"@site/docs/gRPC/Enums/PermissionsExpressionType/index.mdx",6870],be9475ad:[()=>r.e(2621).then(r.bind(r,22340)),"@site/docs/UIExt2/Models/ObjectFile/index.mdx",22340],beacfbe4:[()=>r.e(6609).then(r.bind(r,33085)),"@site/docs/gRPC/Messages/ObjectVersionExWP/index.mdx",33085],bf2af1e9:[()=>Promise.all([r.e(3312),r.e(5103)]).then(r.bind(r,942)),"@site/docs/UIExt2/Interfaces/ICommonFunctions/ShowToast/index.mdx",942],c02d69a8:[()=>Promise.all([r.e(3312),r.e(8237)]).then(r.bind(r,49889)),"@site/docs/UIExt2/Interfaces/IDashboard/ShowPopupDashboard/index.mdx",49889],c0b49bd1:[()=>Promise.all([r.e(3312),r.e(7399)]).then(r.bind(r,21054)),"@site/docs/UIExt2/Interfaces/IShellFrame/IsFolderLocation/index.mdx",21054],c0db0d0d:[()=>r.e(6441).then(r.bind(r,8058)),"@site/docs/gRPC/Messages/AccessControlSubjectUnion/index.mdx",8058],c13f11ab:[()=>Promise.all([r.e(3312),r.e(5870)]).then(r.bind(r,80244)),"@site/docs/UIExt2/Interfaces/ICommands/AddCustomCommandToMenu/index.mdx",80244],c2063bd0:[()=>r.e(9223).then(r.bind(r,51406)),"@site/docs/gRPC/Messages/DefaultReplicationConfiguration/index.mdx",51406],c243010a:[()=>r.e(6676).then(r.bind(r,80183)),"@site/docs/gRPC/Enums/StatusType/index.mdx",80183],c26f41da:[()=>Promise.all([r.e(3312),r.e(5287)]).then(r.bind(r,72796)),"@site/docs/gRPC/Interfaces/ObjectTypesOperations/GetObjectTypes/index.mdx",72796],c2d25d02:[()=>r.e(3796).then(r.bind(r,44022)),"@site/docs/gRPC/Enums/ContentType/index.mdx",44022],c38419b7:[()=>Promise.all([r.e(3312),r.e(1633)]).then(r.bind(r,48536)),"@site/docs/gRPC/Interfaces/ValueListsOperations/GetValueLists/index.mdx",48536],c38b7a02:[()=>r.e(8350).then(r.bind(r,72747)),"@site/docs/gRPC/Messages/PropertyValueSuggestion/index.mdx",72747],c4192489:[()=>r.e(2836).then(r.bind(r,26327)),"@site/docs/gRPC/Enums/ExtIDStatus/index.mdx",26327],c4f0fce3:[()=>Promise.all([r.e(3312),r.e(7005)]).then(r.bind(r,28360)),"@site/docs/UIExt2/Interfaces/IShellUI/ShowPopupDashboard/index.mdx",28360],c686169f:[()=>r.e(9338).then(r.bind(r,55300)),"@site/docs/gRPC/Enums/ObjVerVersionType/index.mdx",55300],c68b0c1a:[()=>r.e(6415).then(r.bind(r,89256)),"@site/docs/gRPC/Enums/ReferenceDirection/index.mdx",89256],c6c0394b:[()=>Promise.all([r.e(3312),r.e(3619)]).then(r.bind(r,64967)),"@site/docs/UIExt2/Interfaces/IShellFrame/NavigateToParent/index.mdx",64967],c70f3b07:[()=>r.e(3650).then(r.bind(r,86831)),"@site/docs/gRPC/Messages/ObjVerVersion/index.mdx",86831],c72ce83d:[()=>r.e(8343).then(r.bind(r,90093)),"@site/docs/gRPC/Enums/EventType/index.mdx",90093],c73cea84:[()=>r.e(1120).then(r.bind(r,55849)),"@site/docs/gRPC/Messages/FolderInfoUnion/SearchFolderData/index.mdx",55849],c74d6a6f:[()=>Promise.all([r.e(3312),r.e(2249)]).then(r.bind(r,4893)),"@site/docs/UIExt2/Interfaces/ICommonFunctions/ShowEditObjectWindow/index.mdx",4893],c7c88dec:[()=>Promise.all([r.e(3312),r.e(1836)]).then(r.bind(r,24353)),"@site/docs/UIExt2/Interfaces/IShellFrame/NavigateToFolder/index.mdx",24353],c7e75944:[()=>r.e(9184).then(r.bind(r,1464)),"@site/docs/UIExt2/Models/LookupValue/index.mdx",1464],c87fa999:[()=>r.e(7004).then(r.bind(r,51443)),"@site/docs/gRPC/Enums/ParentChildBehavior/index.mdx",51443],c8f24b48:[()=>Promise.all([r.e(3312),r.e(9344)]).then(r.bind(r,62942)),"@site/docs/UIExt2/Interfaces/ICommonFunctions/OpenExternalWebLink/index.mdx",62942],c8f40f81:[()=>r.e(9374).then(r.bind(r,88050)),"@site/docs/gRPC/Messages/StateBasic/index.mdx",88050],c91631fc:[()=>r.e(6070).then(r.bind(r,20050)),"@site/docs/gRPC/Messages/SearchResultsItem/index.mdx",20050],c92c902f:[()=>Promise.all([r.e(3312),r.e(7275)]).then(r.bind(r,87506)),"@site/docs/Samples/HelloWorld/index.mdx",87506],cb289da8:[()=>Promise.all([r.e(3312),r.e(669)]).then(r.bind(r,15951)),"@site/docs/UIExt2/Interfaces/IWindow/SetTitle/index.mdx",15951],cbd9c674:[()=>r.e(890).then(r.bind(r,69711)),"@site/docs/gRPC/Enums/SearchMode/index.mdx",69711],cc07613b:[()=>r.e(5688).then(r.bind(r,41831)),"@site/docs/gRPC/Messages/PropertyValueWithMetadata/index.mdx",41831],cc3339af:[()=>r.e(1292).then(r.bind(r,79714)),"@site/docs/gRPC/Enums/ExtDBRefreshType/index.mdx",79714],cc9630b3:[()=>r.e(9940).then(r.bind(r,28608)),"@site/docs/gRPC/Messages/IndirectionLevel/index.mdx",28608],cd31e5b1:[()=>r.e(5400).then(r.bind(r,92390)),"@site/docs/UIExt2/Interfaces/ICommonFunctions/index.mdx",92390],ce0e6e97:[()=>r.e(9317).then(r.bind(r,37629)),"@site/docs/gRPC/Messages/DataFunctionUnion/YearData/index.mdx",37629],ce74077b:[()=>r.e(794).then(r.bind(r,14476)),"@site/docs/gRPC/Messages/UploadedFileArray/index.mdx",14476],ce85f96c:[()=>r.e(6290).then(r.bind(r,96512)),"@site/docs/gRPC/Messages/RelationshipGroup/index.mdx",96512],cf561272:[()=>r.e(5940).then(r.bind(r,26423)),"@site/docs/gRPC/Messages/ObjectVersionAndPropertiesWithMetadata/index.mdx",26423],d0242deb:[()=>r.e(5328).then(r.bind(r,44363)),"@site/docs/gRPC/Messages/Folder/index.mdx",44363],d0f0abec:[()=>Promise.all([r.e(3312),r.e(1552)]).then(r.bind(r,10260)),"@site/docs/Samples/ShellFrameAndDashboard/index.mdx",10260],d118a084:[()=>r.e(7385).then(r.bind(r,81796)),"@site/docs/Upgrading/deprecated_features.mdx",81796],d1842d32:[()=>r.e(5356).then(r.bind(r,43671)),"@site/docs/gRPC/Enums/FolderListingAlgorithm/index.mdx",43671],d257a0fa:[()=>Promise.all([r.e(3312),r.e(7180)]).then(r.bind(r,11765)),"@site/docs/UIExt2/Interfaces/IShellPaneTab/SetVisible/index.mdx",11765],d357bae6:[()=>r.e(873).then(r.bind(r,98917)),"@site/docs/UIExt2/Interfaces/TListingActionArgs/index.mdx",98917],d3aea37f:[()=>Promise.all([r.e(3312),r.e(5176)]).then(r.bind(r,14851)),"@site/docs/UIExt2/Interfaces/IShellListing/SetFolderOrObjectVersionSelectionStates/index.mdx",14851],d57f5ba2:[()=>Promise.all([r.e(3312),r.e(5958)]).then(r.bind(r,99596)),"@site/docs/UIExt2/Interfaces/IShellItems/GetObjectVersionsCount/index.mdx",99596],d5e24e80:[()=>r.e(1128).then(r.bind(r,62394)),"@site/docs/UIExt2/Interfaces/IShellUI/index.mdx",62394],d60caa91:[()=>r.e(4067).then(r.bind(r,67637)),"@site/docs/gRPC/Enums/IndirectPropertyIDLevelType/index.mdx",67637],d6db25d2:[()=>r.e(5205).then(r.bind(r,41785)),"@site/docs/UIExt2/Models/FtsScope/index.mdx",41785],d79ebd61:[()=>r.e(1555).then(r.bind(r,27067)),"@site/docs/gRPC/Enums/ValidationType/index.mdx",27067],d7b30ae8:[()=>Promise.all([r.e(3312),r.e(8212)]).then(r.bind(r,53605)),"@site/docs/gRPC/Interfaces/ObjectOperations/UndoCheckoutMultiple/index.mdx",53605],d85facc4:[()=>r.e(522).then(r.bind(r,24879)),"@site/docs/gRPC/Messages/DataFunctionCall/index.mdx",24879],d87fce4c:[()=>r.e(4834).then(r.bind(r,19624)),"@site/docs/gRPC/Enums/PseudoUserResolutionMode/index.mdx",19624],d8c12e0d:[()=>r.e(5611).then(r.bind(r,89075)),"@site/docs/gRPC/Enums/FormattingType/index.mdx",89075],d9bf549e:[()=>Promise.all([r.e(3312),r.e(2470)]).then(r.bind(r,3918)),"@site/docs/UIExt2/Interfaces/ICommonFunctions/GetWebLink/index.mdx",3918],db047a76:[()=>r.e(9208).then(r.bind(r,79516)),"@site/docs/gRPC/Messages/EventSubscription/index.mdx",79516],dbce6da7:[()=>r.e(4101).then(r.bind(r,27900)),"@site/docs/gRPC/Messages/Lookup/index.mdx",27900],dbd02d6b:[()=>r.e(9402).then(r.bind(r,42291)),"@site/docs/gRPC/Enums/ObjectVersionDataRequestIdentityType/index.mdx",42291],dbd14f15:[()=>Promise.all([r.e(3312),r.e(2426)]).then(r.bind(r,42583)),"@site/docs/UIExt2/Interfaces/IShellListing/SelectPrevFolder/index.mdx",42583],dbd6b45d:[()=>Promise.all([r.e(3312),r.e(4093)]).then(r.bind(r,65473)),"@site/docs/Samples/PopupDashboard/index.mdx",65473],dc0004a3:[()=>r.e(3570).then(r.bind(r,83142)),"@site/docs/gRPC/Messages/ExpressionUnion/PropertyValueData/index.mdx",83142],dc05f522:[()=>Promise.all([r.e(3312),r.e(5810)]).then(r.bind(r,86658)),"@site/docs/UIExt2/Interfaces/IShellItems/GetFoldersCount/index.mdx",86658],dc0941f0:[()=>r.e(8856).then(r.bind(r,68963)),"@site/docs/gRPC/Messages/ObjFileSourceUnion/UserDefinedTemplateData/index.mdx",68963],dc39a59d:[()=>Promise.all([r.e(3312),r.e(5485)]).then(r.bind(r,50354)),"@site/docs/gRPC/Interfaces/VaultExtensionMethodsOperations/RunExtensionMethod/index.mdx",50354],dc8c03df:[()=>r.e(5188).then(r.bind(r,21642)),"@site/docs/gRPC/Messages/ObjFileSourceUnion/UploadedFileData/index.mdx",21642],dc8d7593:[()=>r.e(6984).then(r.bind(r,85779)),"@site/docs/gRPC/Messages/ObjectVersion/index.mdx",85779],dd4c0408:[()=>r.e(7724).then(r.bind(r,57307)),"@site/docs/UIExt2/Enums/MenuLocation/index.mdx",57307],ddd000c6:[()=>r.e(9785).then(r.bind(r,22927)),"@site/docs/gRPC/Messages/SessionInfo/index.mdx",22927],ddf216b7:[()=>Promise.all([r.e(3312),r.e(2299)]).then(r.bind(r,77627)),"@site/docs/UIExt2/Interfaces/IWindow/SetDefaultSize/index.mdx",77627],dee8ae98:[()=>Promise.all([r.e(3312),r.e(1386)]).then(r.bind(r,68811)),"@site/docs/UIExt2/Interfaces/IWindow/ResizeToDefaultSize/index.mdx",68811],defc41ad:[()=>Promise.all([r.e(3312),r.e(4486)]).then(r.bind(r,27441)),"@site/docs/gRPC/Interfaces/ObjectOperations/GetWorkflowsForClient/index.mdx",27441],df098e19:[()=>Promise.all([r.e(3312),r.e(2812)]).then(r.bind(r,64430)),"@site/docs/UIExt2/Interfaces/IShellUI/BroadcastMessage/index.mdx",64430],e08d0656:[()=>Promise.all([r.e(3312),r.e(8279)]).then(r.bind(r,84320)),"@site/docs/UIExt2/Interfaces/ISearchPane/SetSearchCriteria/index.mdx",84320],e0dff15d:[()=>r.e(7582).then(r.bind(r,34287)),"@site/docs/gRPC/Enums/DataFunction/index.mdx",34287],e104e4f1:[()=>r.e(6850).then(r.bind(r,8977)),"@site/docs/UIExt2/Models/index.mdx",8977],e1a1769e:[()=>r.e(3823).then(r.bind(r,40892)),"@site/docs/gRPC/Messages/TypedValueUnion/index.mdx",40892],e39e9de6:[()=>r.e(6083).then(r.bind(r,1596)),"@site/docs/gRPC/Messages/ACCESSCONTROLLISTCOMPONENTSTATUSFLAGS/index.mdx",1596],e438ddcc:[()=>r.e(6787).then(r.bind(r,2712)),"@site/docs/gRPC/Interfaces/VaultExtensionMethodsOperations/index.mdx",2712],e517b3c3:[()=>r.e(15).then(r.bind(r,97368)),"@site/docs/gRPC/Messages/ACTIONFLAGS/index.mdx",97368],e5d3ced3:[()=>Promise.all([r.e(3312),r.e(7807)]).then(r.bind(r,74376)),"@site/docs/gRPC/Interfaces/ObjectOperations/GetObjectHistory2/index.mdx",74376],e6080429:[()=>r.e(8485).then(r.bind(r,7427)),"@site/docs/gRPC/Messages/AccessControlSubject/index.mdx",7427],e6148c4d:[()=>Promise.all([r.e(3312),r.e(6143)]).then(r.bind(r,49209)),"@site/docs/gRPC/Interfaces/ObjectOperations/GetEffectivePermissions/index.mdx",49209],e67da486:[()=>r.e(932).then(r.bind(r,26547)),"@site/docs/gRPC/Messages/ObjFileSourceUnion/BlankTemplateData/index.mdx",26547],e69505df:[()=>r.e(1894).then(r.bind(r,62208)),"@site/docs/UIExt2/Models/NumericValue/index.mdx",62208],e6a71575:[()=>Promise.all([r.e(3312),r.e(3704)]).then(r.bind(r,88639)),"@site/docs/gRPC/Interfaces/SearchOperations/SearchObjects/index.mdx",88639],e7298be3:[()=>Promise.all([r.e(3312),r.e(4097)]).then(r.bind(r,6464)),"@site/docs/UIExt2/Interfaces/ICommonFunctions/DeleteFromWebStorage/index.mdx",6464],e7b7f80f:[()=>r.e(2043).then(r.bind(r,88090)),"@site/docs/gRPC/Messages/DocClassGroup/index.mdx",88090],e7e74022:[()=>Promise.all([r.e(3312),r.e(8026)]).then(r.bind(r,50568)),"@site/docs/gRPC/Interfaces/PropertyDefsOperations/GetObjectClassesAndGroups/index.mdx",50568],e80177c2:[()=>r.e(9363).then(r.bind(r,55141)),"@site/docs/gRPC/Messages/SubviewGroup/index.mdx",55141],e9031238:[()=>Promise.all([r.e(3312),r.e(3994)]).then(r.bind(r,46317)),"@site/docs/UIExt2/Interfaces/IDashboard/WaitForClose/index.mdx",46317],e9fd5bee:[()=>r.e(1816).then(r.bind(r,48997)),"@site/docs/gRPC/Messages/MultiSelectLookup/index.mdx",48997],ea06490a:[()=>r.e(934).then(r.bind(r,80894)),"@site/docs/gRPC/Messages/ObjectVersionFileActivity/index.mdx",80894],ea295e2c:[()=>Promise.all([r.e(3312),r.e(782)]).then(r.bind(r,9302)),"@site/docs/gRPC/Interfaces/ObjectOperations/FollowObject/index.mdx",9302],ea74cdc1:[()=>Promise.all([r.e(3312),r.e(929)]).then(r.bind(r,75667)),"@site/docs/gRPC/Interfaces/ObjectOperations/GetObjectDataOfMultipleObjects/index.mdx",75667],ead5e6c2:[()=>Promise.all([r.e(3312),r.e(7011)]).then(r.bind(r,73186)),"@site/docs/Samples/Samples.mdx",73186],ead7927e:[()=>r.e(6319).then(r.bind(r,80922)),"@site/docs/gRPC/Messages/DataFunctionUnion/InitialCharacterGroupData/index.mdx",80922],eae52052:[()=>r.e(1853).then(r.bind(r,31713)),"@site/docs/gRPC/Messages/GetMetadataStructureItemIdByGUIDRequest/index.mdx",31713],eba70964:[()=>r.e(6249).then(r.bind(r,14976)),"@site/docs/gRPC/Messages/ObjFileSourceUnion/index.mdx",14976],ec572293:[()=>r.e(6969).then(r.bind(r,20132)),"@site/docs/UIExt2/Interfaces/IShellPaneTab/index.mdx",20132],edb08ed6:[()=>r.e(4470).then(r.bind(r,47345)),"@site/docs/gRPC/Messages/OBJECTVERSIONPROPERTYACTIVITYFLAGS/index.mdx",47345],edb257ef:[()=>Promise.all([r.e(3312),r.e(5859)]).then(r.bind(r,62474)),"@site/docs/gRPC/Interfaces/ObjectOperations/GetObjIDByGUID/index.mdx",62474],edfce69c:[()=>r.e(7506).then(r.bind(r,14757)),"@site/docs/gRPC/Messages/DataFunctionUnion/IntegerSegmentData/index.mdx",14757],ee1e7a10:[()=>r.e(318).then(r.bind(r,37521)),"@site/docs/gRPC/Messages/DataFunctionUnion/LeftCharactersData/index.mdx",37521],ee7f8904:[()=>Promise.all([r.e(3312),r.e(1714)]).then(r.bind(r,67163)),"@site/docs/UIExt2/Interfaces/IDashboard/UpdateCustomData/index.mdx",67163],eebc9080:[()=>r.e(5734).then(r.bind(r,52507)),"@site/docs/UIExt2/Enums/FacetValueType/index.mdx",52507],efe658fc:[()=>Promise.all([r.e(3312),r.e(5577)]).then(r.bind(r,75701)),"@site/docs/UIExt2/Interfaces/ICommands/CreateTaskbarGroup/index.mdx",75701],f03c8625:[()=>Promise.all([r.e(3312),r.e(3590)]).then(r.bind(r,46862)),"@site/docs/UIExt2/Interfaces/IShellListing/ActivateSelected/index.mdx",46862],f091a8da:[()=>Promise.all([r.e(3312),r.e(2281)]).then(r.bind(r,41544)),"@site/docs/Overview/Debugging.mdx",41544],f0a5f73e:[()=>Promise.all([r.e(3312),r.e(4928)]).then(r.bind(r,25595)),"@site/docs/UIExt2/Interfaces/ICommands/CreateSubMenuItem/index.mdx",25595],f104d11e:[()=>Promise.all([r.e(3312),r.e(3624)]).then(r.bind(r,43758)),"@site/docs/gRPC/Interfaces/NamedACLsOperations/GetNamedACLs/index.mdx",43758],f1629263:[()=>r.e(7555).then(r.bind(r,87659)),"@site/docs/UIExt2/Enums/CommandState/index.mdx",87659],f1979d24:[()=>r.e(6822).then(r.bind(r,18565)),"@site/docs/gRPC/Messages/View/index.mdx",18565],f212de0b:[()=>r.e(4960).then(r.bind(r,41429)),"@site/docs/gRPC/Messages/ExpressionUnion/IdSegmentData/index.mdx",41429],f21c3c5d:[()=>r.e(7876).then(r.bind(r,85725)),"@site/docs/gRPC/Messages/AccessControlPseudoUserSubject/index.mdx",85725],f23abb53:[()=>r.e(1568).then(r.bind(r,41476)),"@site/docs/gRPC/Enums/FileVerType/index.mdx",41476],f343403d:[()=>r.e(4087).then(r.bind(r,51953)),"@site/docs/gRPC/Messages/ObjectVersionDataResult/index.mdx",51953],f389ec95:[()=>r.e(3255).then(r.bind(r,31897)),"@site/docs/UIExt2/Models/ShellFrameFolders/index.mdx",31897],f415f621:[()=>Promise.all([r.e(3312),r.e(4484)]).then(r.bind(r,37267)),"@site/docs/gRPC/Interfaces/ViewsOperations/GetViews/index.mdx",37267],f47932a1:[()=>Promise.all([r.e(3312),r.e(7952)]).then(r.bind(r,84572)),"@site/docs/gRPC/Interfaces/ObjectOperations/GetLatestFileVersion/index.mdx",84572],f4b9c33e:[()=>Promise.all([r.e(3312),r.e(8665)]).then(r.bind(r,34949)),"@site/docs/Samples/SearchFolderExamples/index.mdx",34949],f4fc9543:[()=>r.e(5236).then(r.bind(r,35905)),"@site/docs/gRPC/Interfaces/ViewsOperations/index.mdx",35905],f638657e:[()=>r.e(4769).then(r.bind(r,23968)),"@site/docs/gRPC/Messages/ExternalView/index.mdx",23968],f7bb69b9:[()=>r.e(363).then(r.bind(r,85969)),"@site/docs/gRPC/Messages/DataFunctionUnion/NoOpData/index.mdx",85969],f8944fbd:[()=>r.e(912).then(r.bind(r,93503)),"@site/docs/gRPC/Messages/SearchFlags/index.mdx",93503],f8e24fc8:[()=>Promise.all([r.e(3312),r.e(3913)]).then(r.bind(r,83009)),"@site/docs/UIExt2/Interfaces/IShellListing/SetVirtualSelection/index.mdx",83009],f8fb96b5:[()=>r.e(9).then(r.bind(r,39869)),"@site/docs/gRPC/Messages/DataFunctionUnion/YearAndMonthData/index.mdx",39869],f9fbd59f:[()=>Promise.all([r.e(3312),r.e(8374)]).then(r.bind(r,4486)),"@site/docs/UIExt2/Interfaces/IShellFrame/ShowDefaultContent/index.mdx",4486],fab7e231:[()=>r.e(3787).then(r.bind(r,76451)),"@site/docs/gRPC/Messages/AccessControlListComponent/index.mdx",76451],fac6a602:[()=>r.e(6586).then(r.bind(r,85158)),"@site/docs/UIExt2/Enums/ToastType/index.mdx",85158],fb2b3e75:[()=>r.e(402).then(r.bind(r,1910)),"@site/docs/UIExt2/Enums/Event/index.mdx",1910],fb4945d3:[()=>r.e(1059).then(r.bind(r,74688)),"@site/docs/gRPC/Messages/OBJECTFILEFLAGS/index.mdx",74688],fb71ca7f:[()=>r.e(2744).then(r.bind(r,37413)),"@site/docs/gRPC/Messages/ClassPermissionsForClient/index.mdx",37413],fbf3b37b:[()=>r.e(2167).then(r.bind(r,3259)),"@site/docs/gRPC/Messages/SearchResultsSorting/index.mdx",3259],fc2f0709:[()=>Promise.all([r.e(3312),r.e(3139)]).then(r.bind(r,76086)),"@site/docs/gRPC/Interfaces/ObjectOperations/SetPropertiesMultiple/index.mdx",76086],fe89bdc8:[()=>Promise.all([r.e(3312),r.e(6264)]).then(r.bind(r,67012)),"@site/docs/Samples/Commands/index.mdx",67012],fec40015:[()=>r.e(389).then(r.bind(r,92096)),"@site/docs/gRPC/Messages/ItemInfo/index.mdx",92096],fef3f344:[()=>r.e(6220).then(r.bind(r,79601)),"@site/docs/UIExt2/Enums/FacetTransformation/index.mdx",79601],ff83e11c:[()=>r.e(5054).then(r.bind(r,31932)),"@site/docs/UIExt2/Enums/FacetRangeType/index.mdx",31932]};function l(e){let{error:t,retry:r,pastDelay:a}=e;return t?n.createElement("div",{style:{textAlign:"center",color:"#fff",backgroundColor:"#fa383e",borderColor:"#fa383e",borderStyle:"solid",borderRadius:"0.25rem",borderWidth:"1px",boxSizing:"border-box",display:"block",padding:"1rem",flex:"0 0 50%",marginLeft:"25%",marginRight:"25%",marginTop:"5rem",maxWidth:"50%",width:"100%"}},n.createElement("p",null,String(t)),n.createElement("div",null,n.createElement("button",{type:"button",onClick:r},"Retry"))):a?n.createElement("div",{style:{display:"flex",justifyContent:"center",alignItems:"center",height:"100vh"}},n.createElement("svg",{id:"loader",style:{width:128,height:110,position:"absolute",top:"calc(100vh - 64%)"},viewBox:"0 0 45 45",xmlns:"http://www.w3.org/2000/svg",stroke:"#61dafb"},n.createElement("g",{fill:"none",fillRule:"evenodd",transform:"translate(1 1)",strokeWidth:"2"},n.createElement("circle",{cx:"22",cy:"22",r:"6",strokeOpacity:"0"},n.createElement("animate",{attributeName:"r",begin:"1.5s",dur:"3s",values:"6;22",calcMode:"linear",repeatCount:"indefinite"}),n.createElement("animate",{attributeName:"stroke-opacity",begin:"1.5s",dur:"3s",values:"1;0",calcMode:"linear",repeatCount:"indefinite"}),n.createElement("animate",{attributeName:"stroke-width",begin:"1.5s",dur:"3s",values:"2;0",calcMode:"linear",repeatCount:"indefinite"})),n.createElement("circle",{cx:"22",cy:"22",r:"6",strokeOpacity:"0"},n.createElement("animate",{attributeName:"r",begin:"3s",dur:"3s",values:"6;22",calcMode:"linear",repeatCount:"indefinite"}),n.createElement("animate",{attributeName:"stroke-opacity",begin:"3s",dur:"3s",values:"1;0",calcMode:"linear",repeatCount:"indefinite"}),n.createElement("animate",{attributeName:"stroke-width",begin:"3s",dur:"3s",values:"2;0",calcMode:"linear",repeatCount:"indefinite"})),n.createElement("circle",{cx:"22",cy:"22",r:"8"},n.createElement("animate",{attributeName:"r",begin:"0s",dur:"1.5s",values:"6;1;2;3;4;5;6",calcMode:"linear",repeatCount:"indefinite"}))))):null}var u=r(5304),d=r(69656);function f(e,t){if("*"===e)return o()({loading:l,loader:()=>r.e(4248).then(r.bind(r,74248)),modules:["@theme/NotFound"],webpack:()=>[74248],render(e,t){const r=e.default;return n.createElement(d.z,{value:{plugin:{name:"native",id:"default"}}},n.createElement(r,t))}});const i=s[`${e}-${t}`],f={},m=[],p=[],b=(0,u.Z)(i);return Object.entries(b).forEach((e=>{let[t,r]=e;const n=c[r];n&&(f[t]=n[0],m.push(n[1]),p.push(n[2]))})),o().Map({loading:l,loader:f,modules:m,webpack:()=>p,render(t,r){const o=JSON.parse(JSON.stringify(i));Object.entries(t).forEach((t=>{let[r,n]=t;const a=n.default;if(!a)throw new Error(`The page component at ${e} doesn't have a default export. This makes it impossible to render anything. Consider default-exporting a React component.`);"object"!=typeof a&&"function"!=typeof a||Object.keys(n).filter((e=>"default"!==e)).forEach((e=>{a[e]=n[e]}));let i=o;const s=r.split(".");s.slice(0,-1).forEach((e=>{i=i[e]})),i[s[s.length-1]]=a}));const s=o.__comp;delete o.__comp;const c=o.__context;return delete o.__context,n.createElement(d.z,{value:c},n.createElement(s,(0,a.Z)({},o,r)))}})}const m=[{path:"/Frameworks/User-Interface-Extensibility-Framework/Reference/",component:f("/Frameworks/User-Interface-Extensibility-Framework/Reference/","a6b"),routes:[{path:"/Frameworks/User-Interface-Extensibility-Framework/Reference/",component:f("/Frameworks/User-Interface-Extensibility-Framework/Reference/","1b6"),exact:!0,sidebar:"tutorialSidebar"},{path:"/Frameworks/User-Interface-Extensibility-Framework/Reference/gRPC/",component:f("/Frameworks/User-Interface-Extensibility-Framework/Reference/gRPC/","a49"),exact:!0,sidebar:"tutorialSidebar"},{path:"/Frameworks/User-Interface-Extensibility-Framework/Reference/gRPC/Enums/",component:f("/Frameworks/User-Interface-Extensibility-Framework/Reference/gRPC/Enums/","975"),exact:!0,sidebar:"tutorialSidebar"},{path:"/Frameworks/User-Interface-Extensibility-Framework/Reference/gRPC/Enums/AccessControlSubjectType/",component:f("/Frameworks/User-Interface-Extensibility-Framework/Reference/gRPC/Enums/AccessControlSubjectType/","6ca"),exact:!0,sidebar:"tutorialSidebar"},{path:"/Frameworks/User-Interface-Extensibility-Framework/Reference/gRPC/Enums/ACLEnforcingMode/",component:f("/Frameworks/User-Interface-Extensibility-Framework/Reference/gRPC/Enums/ACLEnforcingMode/","2de"),exact:!0,sidebar:"tutorialSidebar"},{path:"/Frameworks/User-Interface-Extensibility-Framework/Reference/gRPC/Enums/AuthType/",component:f("/Frameworks/User-Interface-Extensibility-Framework/Reference/gRPC/Enums/AuthType/","2da"),exact:!0,sidebar:"tutorialSidebar"},{path:"/Frameworks/User-Interface-Extensibility-Framework/Reference/gRPC/Enums/AutomaticValueType/",component:f("/Frameworks/User-Interface-Extensibility-Framework/Reference/gRPC/Enums/AutomaticValueType/","403"),exact:!0,sidebar:"tutorialSidebar"},{path:"/Frameworks/User-Interface-Extensibility-Framework/Reference/gRPC/Enums/CallImportance/",component:f("/Frameworks/User-Interface-Extensibility-Framework/Reference/gRPC/Enums/CallImportance/","515"),exact:!0,sidebar:"tutorialSidebar"},{path:"/Frameworks/User-Interface-Extensibility-Framework/Reference/gRPC/Enums/ConditionType/",component:f("/Frameworks/User-Interface-Extensibility-Framework/Reference/gRPC/Enums/ConditionType/","c6c"),exact:!0,sidebar:"tutorialSidebar"},{path:"/Frameworks/User-Interface-Extensibility-Framework/Reference/gRPC/Enums/ContentType/",component:f("/Frameworks/User-Interface-Extensibility-Framework/Reference/gRPC/Enums/ContentType/","bff"),exact:!0,sidebar:"tutorialSidebar"},{path:"/Frameworks/User-Interface-Extensibility-Framework/Reference/gRPC/Enums/DataFunction/",component:f("/Frameworks/User-Interface-Extensibility-Framework/Reference/gRPC/Enums/DataFunction/","fe9"),exact:!0,sidebar:"tutorialSidebar"},{path:"/Frameworks/User-Interface-Extensibility-Framework/Reference/gRPC/Enums/Datatype/",component:f("/Frameworks/User-Interface-Extensibility-Framework/Reference/gRPC/Enums/Datatype/","b23"),exact:!0,sidebar:"tutorialSidebar"},{path:"/Frameworks/User-Interface-Extensibility-Framework/Reference/gRPC/Enums/EventType/",component:f("/Frameworks/User-Interface-Extensibility-Framework/Reference/gRPC/Enums/EventType/","b17"),exact:!0,sidebar:"tutorialSidebar"},{path:"/Frameworks/User-Interface-Extensibility-Framework/Reference/gRPC/Enums/ExpressionType/",component:f("/Frameworks/User-Interface-Extensibility-Framework/Reference/gRPC/Enums/ExpressionType/","937"),exact:!0,sidebar:"tutorialSidebar"},{path:"/Frameworks/User-Interface-Extensibility-Framework/Reference/gRPC/Enums/ExtDBRefreshType/",component:f("/Frameworks/User-Interface-Extensibility-Framework/Reference/gRPC/Enums/ExtDBRefreshType/","706"),exact:!0,sidebar:"tutorialSidebar"},{path:"/Frameworks/User-Interface-Extensibility-Framework/Reference/gRPC/Enums/ExtIDStatus/",component:f("/Frameworks/User-Interface-Extensibility-Framework/Reference/gRPC/Enums/ExtIDStatus/","b26"),exact:!0,sidebar:"tutorialSidebar"},{path:"/Frameworks/User-Interface-Extensibility-Framework/Reference/gRPC/Enums/FileIDType/",component:f("/Frameworks/User-Interface-Extensibility-Framework/Reference/gRPC/Enums/FileIDType/","0ce"),exact:!0,sidebar:"tutorialSidebar"},{path:"/Frameworks/User-Interface-Extensibility-Framework/Reference/gRPC/Enums/FileSizePrecision/",component:f("/Frameworks/User-Interface-Extensibility-Framework/Reference/gRPC/Enums/FileSizePrecision/","ce1"),exact:!0,sidebar:"tutorialSidebar"},{path:"/Frameworks/User-Interface-Extensibility-Framework/Reference/gRPC/Enums/FileValueType/",component:f("/Frameworks/User-Interface-Extensibility-Framework/Reference/gRPC/Enums/FileValueType/","9d1"),exact:!0,sidebar:"tutorialSidebar"},{path:"/Frameworks/User-Interface-Extensibility-Framework/Reference/gRPC/Enums/FileVerType/",component:f("/Frameworks/User-Interface-Extensibility-Framework/Reference/gRPC/Enums/FileVerType/","0f2"),exact:!0,sidebar:"tutorialSidebar"},{path:"/Frameworks/User-Interface-Extensibility-Framework/Reference/gRPC/Enums/FolderListingAlgorithm/",component:f("/Frameworks/User-Interface-Extensibility-Framework/Reference/gRPC/Enums/FolderListingAlgorithm/","238"),exact:!0,sidebar:"tutorialSidebar"},{path:"/Frameworks/User-Interface-Extensibility-Framework/Reference/gRPC/Enums/FolderType/",component:f("/Frameworks/User-Interface-Extensibility-Framework/Reference/gRPC/Enums/FolderType/","211"),exact:!0,sidebar:"tutorialSidebar"},{path:"/Frameworks/User-Interface-Extensibility-Framework/Reference/gRPC/Enums/FormattingType/",component:f("/Frameworks/User-Interface-Extensibility-Framework/Reference/gRPC/Enums/FormattingType/","c84"),exact:!0,sidebar:"tutorialSidebar"},{path:"/Frameworks/User-Interface-Extensibility-Framework/Reference/gRPC/Enums/IndirectPropertyIDLevelType/",component:f("/Frameworks/User-Interface-Extensibility-Framework/Reference/gRPC/Enums/IndirectPropertyIDLevelType/","2bf"),exact:!0,sidebar:"tutorialSidebar"},{path:"/Frameworks/User-Interface-Extensibility-Framework/Reference/gRPC/Enums/MetadataStructureItem/",component:f("/Frameworks/User-Interface-Extensibility-Framework/Reference/gRPC/Enums/MetadataStructureItem/","ed3"),exact:!0,sidebar:"tutorialSidebar"},{path:"/Frameworks/User-Interface-Extensibility-Framework/Reference/gRPC/Enums/NACLType/",component:f("/Frameworks/User-Interface-Extensibility-Framework/Reference/gRPC/Enums/NACLType/","58f"),exact:!0,sidebar:"tutorialSidebar"},{path:"/Frameworks/User-Interface-Extensibility-Framework/Reference/gRPC/Enums/NamedValueType/",component:f("/Frameworks/User-Interface-Extensibility-Framework/Reference/gRPC/Enums/NamedValueType/","857"),exact:!0,sidebar:"tutorialSidebar"},{path:"/Frameworks/User-Interface-Extensibility-Framework/Reference/gRPC/Enums/ObjectVersionDataRequestErrorTolerance/",component:f("/Frameworks/User-Interface-Extensibility-Framework/Reference/gRPC/Enums/ObjectVersionDataRequestErrorTolerance/","911"),exact:!0,sidebar:"tutorialSidebar"},{path:"/Frameworks/User-Interface-Extensibility-Framework/Reference/gRPC/Enums/ObjectVersionDataRequestIdentityType/",component:f("/Frameworks/User-Interface-Extensibility-Framework/Reference/gRPC/Enums/ObjectVersionDataRequestIdentityType/","218"),exact:!0,sidebar:"tutorialSidebar"},{path:"/Frameworks/User-Interface-Extensibility-Framework/Reference/gRPC/Enums/ObjectVersionDataRequestVersionType/",component:f("/Frameworks/User-Interface-Extensibility-Framework/Reference/gRPC/Enums/ObjectVersionDataRequestVersionType/","646"),exact:!0,sidebar:"tutorialSidebar"},{path:"/Frameworks/User-Interface-Extensibility-Framework/Reference/gRPC/Enums/ObjFileSourceType/",component:f("/Frameworks/User-Interface-Extensibility-Framework/Reference/gRPC/Enums/ObjFileSourceType/","da6"),exact:!0,sidebar:"tutorialSidebar"},{path:"/Frameworks/User-Interface-Extensibility-Framework/Reference/gRPC/Enums/ObjVerVersionType/",component:f("/Frameworks/User-Interface-Extensibility-Framework/Reference/gRPC/Enums/ObjVerVersionType/","20b"),exact:!0,sidebar:"tutorialSidebar"},{path:"/Frameworks/User-Interface-Extensibility-Framework/Reference/gRPC/Enums/ParentChildBehavior/",component:f("/Frameworks/User-Interface-Extensibility-Framework/Reference/gRPC/Enums/ParentChildBehavior/","0b5"),exact:!0,sidebar:"tutorialSidebar"},{path:"/Frameworks/User-Interface-Extensibility-Framework/Reference/gRPC/Enums/PermissionsExpressionType/",component:f("/Frameworks/User-Interface-Extensibility-Framework/Reference/gRPC/Enums/PermissionsExpressionType/","9c2"),exact:!0,sidebar:"tutorialSidebar"},{path:"/Frameworks/User-Interface-Extensibility-Framework/Reference/gRPC/Enums/PropertySetByType/",component:f("/Frameworks/User-Interface-Extensibility-Framework/Reference/gRPC/Enums/PropertySetByType/","bf4"),exact:!0,sidebar:"tutorialSidebar"},{path:"/Frameworks/User-Interface-Extensibility-Framework/Reference/gRPC/Enums/PseudoUserResolutionMode/",component:f("/Frameworks/User-Interface-Extensibility-Framework/Reference/gRPC/Enums/PseudoUserResolutionMode/","5f5"),exact:!0,sidebar:"tutorialSidebar"},{path:"/Frameworks/User-Interface-Extensibility-Framework/Reference/gRPC/Enums/ReferenceDirection/",component:f("/Frameworks/User-Interface-Extensibility-Framework/Reference/gRPC/Enums/ReferenceDirection/","aab"),exact:!0,sidebar:"tutorialSidebar"},{path:"/Frameworks/User-Interface-Extensibility-Framework/Reference/gRPC/Enums/RelationshipDirection/",component:f("/Frameworks/User-Interface-Extensibility-Framework/Reference/gRPC/Enums/RelationshipDirection/","e6e"),exact:!0,sidebar:"tutorialSidebar"},{path:"/Frameworks/User-Interface-Extensibility-Framework/Reference/gRPC/Enums/SearchMode/",component:f("/Frameworks/User-Interface-Extensibility-Framework/Reference/gRPC/Enums/SearchMode/","95d"),exact:!0,sidebar:"tutorialSidebar"},{path:"/Frameworks/User-Interface-Extensibility-Framework/Reference/gRPC/Enums/StatusType/",component:f("/Frameworks/User-Interface-Extensibility-Framework/Reference/gRPC/Enums/StatusType/","935"),exact:!0,sidebar:"tutorialSidebar"},{path:"/Frameworks/User-Interface-Extensibility-Framework/Reference/gRPC/Enums/UpdateType/",component:f("/Frameworks/User-Interface-Extensibility-Framework/Reference/gRPC/Enums/UpdateType/","091"),exact:!0,sidebar:"tutorialSidebar"},{path:"/Frameworks/User-Interface-Extensibility-Framework/Reference/gRPC/Enums/ValidationType/",component:f("/Frameworks/User-Interface-Extensibility-Framework/Reference/gRPC/Enums/ValidationType/","9c9"),exact:!0,sidebar:"tutorialSidebar"},{path:"/Frameworks/User-Interface-Extensibility-Framework/Reference/gRPC/Enums/ViewType/",component:f("/Frameworks/User-Interface-Extensibility-Framework/Reference/gRPC/Enums/ViewType/","c90"),exact:!0,sidebar:"tutorialSidebar"},{path:"/Frameworks/User-Interface-Extensibility-Framework/Reference/gRPC/Enums/VLSortingType/",component:f("/Frameworks/User-Interface-Extensibility-Framework/Reference/gRPC/Enums/VLSortingType/","a9c"),exact:!0,sidebar:"tutorialSidebar"},{path:"/Frameworks/User-Interface-Extensibility-Framework/Reference/gRPC/Interfaces/",component:f("/Frameworks/User-Interface-Extensibility-Framework/Reference/gRPC/Interfaces/","055"),exact:!0,sidebar:"tutorialSidebar"},{path:"/Frameworks/User-Interface-Extensibility-Framework/Reference/gRPC/Interfaces/NamedACLsOperations/",component:f("/Frameworks/User-Interface-Extensibility-Framework/Reference/gRPC/Interfaces/NamedACLsOperations/","bd6"),exact:!0,sidebar:"tutorialSidebar"},{path:"/Frameworks/User-Interface-Extensibility-Framework/Reference/gRPC/Interfaces/NamedACLsOperations/GetNamedACLs/",component:f("/Frameworks/User-Interface-Extensibility-Framework/Reference/gRPC/Interfaces/NamedACLsOperations/GetNamedACLs/","b58"),exact:!0,sidebar:"tutorialSidebar"},{path:"/Frameworks/User-Interface-Extensibility-Framework/Reference/gRPC/Interfaces/NamedValueStorageOperations/",component:f("/Frameworks/User-Interface-Extensibility-Framework/Reference/gRPC/Interfaces/NamedValueStorageOperations/","d6f"),exact:!0,sidebar:"tutorialSidebar"},{path:"/Frameworks/User-Interface-Extensibility-Framework/Reference/gRPC/Interfaces/NamedValueStorageOperations/GetNamedValues/",component:f("/Frameworks/User-Interface-Extensibility-Framework/Reference/gRPC/Interfaces/NamedValueStorageOperations/GetNamedValues/","7cf"),exact:!0,sidebar:"tutorialSidebar"},{path:"/Frameworks/User-Interface-Extensibility-Framework/Reference/gRPC/Interfaces/NamedValueStorageOperations/RemoveNamedValues/",component:f("/Frameworks/User-Interface-Extensibility-Framework/Reference/gRPC/Interfaces/NamedValueStorageOperations/RemoveNamedValues/","6dd"),exact:!0,sidebar:"tutorialSidebar"},{path:"/Frameworks/User-Interface-Extensibility-Framework/Reference/gRPC/Interfaces/NamedValueStorageOperations/SetNamedValues/",component:f("/Frameworks/User-Interface-Extensibility-Framework/Reference/gRPC/Interfaces/NamedValueStorageOperations/SetNamedValues/","ab7"),exact:!0,sidebar:"tutorialSidebar"},{path:"/Frameworks/User-Interface-Extensibility-Framework/Reference/gRPC/Interfaces/ObjectOperations/",component:f("/Frameworks/User-Interface-Extensibility-Framework/Reference/gRPC/Interfaces/ObjectOperations/","0be"),exact:!0,sidebar:"tutorialSidebar"},{path:"/Frameworks/User-Interface-Extensibility-Framework/Reference/gRPC/Interfaces/ObjectOperations/AddObjectFile/",component:f("/Frameworks/User-Interface-Extensibility-Framework/Reference/gRPC/Interfaces/ObjectOperations/AddObjectFile/","7dd"),exact:!0,sidebar:"tutorialSidebar"},{path:"/Frameworks/User-Interface-Extensibility-Framework/Reference/gRPC/Interfaces/ObjectOperations/AddObjectWithFiles/",component:f("/Frameworks/User-Interface-Extensibility-Framework/Reference/gRPC/Interfaces/ObjectOperations/AddObjectWithFiles/","fc3"),exact:!0,sidebar:"tutorialSidebar"},{path:"/Frameworks/User-Interface-Extensibility-Framework/Reference/gRPC/Interfaces/ObjectOperations/ChangeSecurity/",component:f("/Frameworks/User-Interface-Extensibility-Framework/Reference/gRPC/Interfaces/ObjectOperations/ChangeSecurity/","296"),exact:!0,sidebar:"tutorialSidebar"},{path:"/Frameworks/User-Interface-Extensibility-Framework/Reference/gRPC/Interfaces/ObjectOperations/CheckInMultiple/",component:f("/Frameworks/User-Interface-Extensibility-Framework/Reference/gRPC/Interfaces/ObjectOperations/CheckInMultiple/","263"),exact:!0,sidebar:"tutorialSidebar"},{path:"/Frameworks/User-Interface-Extensibility-Framework/Reference/gRPC/Interfaces/ObjectOperations/CheckOutMultiple/",component:f("/Frameworks/User-Interface-Extensibility-Framework/Reference/gRPC/Interfaces/ObjectOperations/CheckOutMultiple/","c6c"),exact:!0,sidebar:"tutorialSidebar"},{path:"/Frameworks/User-Interface-Extensibility-Framework/Reference/gRPC/Interfaces/ObjectOperations/DestroyObjects/",component:f("/Frameworks/User-Interface-Extensibility-Framework/Reference/gRPC/Interfaces/ObjectOperations/DestroyObjects/","447"),exact:!0,sidebar:"tutorialSidebar"},{path:"/Frameworks/User-Interface-Extensibility-Framework/Reference/gRPC/Interfaces/ObjectOperations/FollowObject/",component:f("/Frameworks/User-Interface-Extensibility-Framework/Reference/gRPC/Interfaces/ObjectOperations/FollowObject/","d71"),exact:!0,sidebar:"tutorialSidebar"},{path:"/Frameworks/User-Interface-Extensibility-Framework/Reference/gRPC/Interfaces/ObjectOperations/GetAutomaticMetadata/",component:f("/Frameworks/User-Interface-Extensibility-Framework/Reference/gRPC/Interfaces/ObjectOperations/GetAutomaticMetadata/","3fe"),exact:!0,sidebar:"tutorialSidebar"},{path:"/Frameworks/User-Interface-Extensibility-Framework/Reference/gRPC/Interfaces/ObjectOperations/GetDocEventSubscriptions/",component:f("/Frameworks/User-Interface-Extensibility-Framework/Reference/gRPC/Interfaces/ObjectOperations/GetDocEventSubscriptions/","200"),exact:!0,sidebar:"tutorialSidebar"},{path:"/Frameworks/User-Interface-Extensibility-Framework/Reference/gRPC/Interfaces/ObjectOperations/GetEffectivePermissions/",component:f("/Frameworks/User-Interface-Extensibility-Framework/Reference/gRPC/Interfaces/ObjectOperations/GetEffectivePermissions/","34a"),exact:!0,sidebar:"tutorialSidebar"},{path:"/Frameworks/User-Interface-Extensibility-Framework/Reference/gRPC/Interfaces/ObjectOperations/GetLatestFileVersion/",component:f("/Frameworks/User-Interface-Extensibility-Framework/Reference/gRPC/Interfaces/ObjectOperations/GetLatestFileVersion/","d32"),exact:!0,sidebar:"tutorialSidebar"},{path:"/Frameworks/User-Interface-Extensibility-Framework/Reference/gRPC/Interfaces/ObjectOperations/GetLatestObjectVersion/",component:f("/Frameworks/User-Interface-Extensibility-Framework/Reference/gRPC/Interfaces/ObjectOperations/GetLatestObjectVersion/","573"),exact:!0,sidebar:"tutorialSidebar"},{path:"/Frameworks/User-Interface-Extensibility-Framework/Reference/gRPC/Interfaces/ObjectOperations/GetObjectDataOfMultipleObjects/",component:f("/Frameworks/User-Interface-Extensibility-Framework/Reference/gRPC/Interfaces/ObjectOperations/GetObjectDataOfMultipleObjects/","68e"),exact:!0,sidebar:"tutorialSidebar"},{path:"/Frameworks/User-Interface-Extensibility-Framework/Reference/gRPC/Interfaces/ObjectOperations/GetObjectFiles/",component:f("/Frameworks/User-Interface-Extensibility-Framework/Reference/gRPC/Interfaces/ObjectOperations/GetObjectFiles/","da8"),exact:!0,sidebar:"tutorialSidebar"},{path:"/Frameworks/User-Interface-Extensibility-Framework/Reference/gRPC/Interfaces/ObjectOperations/GetObjectHistory2/",component:f("/Frameworks/User-Interface-Extensibility-Framework/Reference/gRPC/Interfaces/ObjectOperations/GetObjectHistory2/","6d5"),exact:!0,sidebar:"tutorialSidebar"},{path:"/Frameworks/User-Interface-Extensibility-Framework/Reference/gRPC/Interfaces/ObjectOperations/GetObjIDByGUID/",component:f("/Frameworks/User-Interface-Extensibility-Framework/Reference/gRPC/Interfaces/ObjectOperations/GetObjIDByGUID/","57b"),exact:!0,sidebar:"tutorialSidebar"},{path:"/Frameworks/User-Interface-Extensibility-Framework/Reference/gRPC/Interfaces/ObjectOperations/GetTemplates/",component:f("/Frameworks/User-Interface-Extensibility-Framework/Reference/gRPC/Interfaces/ObjectOperations/GetTemplates/","ba7"),exact:!0,sidebar:"tutorialSidebar"},{path:"/Frameworks/User-Interface-Extensibility-Framework/Reference/gRPC/Interfaces/ObjectOperations/GetWorkflowsForClient/",component:f("/Frameworks/User-Interface-Extensibility-Framework/Reference/gRPC/Interfaces/ObjectOperations/GetWorkflowsForClient/","ea1"),exact:!0,sidebar:"tutorialSidebar"},{path:"/Frameworks/User-Interface-Extensibility-Framework/Reference/gRPC/Interfaces/ObjectOperations/GetWorkflowStateHistory/",component:f("/Frameworks/User-Interface-Extensibility-Framework/Reference/gRPC/Interfaces/ObjectOperations/GetWorkflowStateHistory/","d3b"),exact:!0,sidebar:"tutorialSidebar"},{path:"/Frameworks/User-Interface-Extensibility-Framework/Reference/gRPC/Interfaces/ObjectOperations/GetWorkflowStates/",component:f("/Frameworks/User-Interface-Extensibility-Framework/Reference/gRPC/Interfaces/ObjectOperations/GetWorkflowStates/","595"),exact:!0,sidebar:"tutorialSidebar"},{path:"/Frameworks/User-Interface-Extensibility-Framework/Reference/gRPC/Interfaces/ObjectOperations/GetWorkflowStatesAndTransitions/",component:f("/Frameworks/User-Interface-Extensibility-Framework/Reference/gRPC/Interfaces/ObjectOperations/GetWorkflowStatesAndTransitions/","b3a"),exact:!0,sidebar:"tutorialSidebar"},{path:"/Frameworks/User-Interface-Extensibility-Framework/Reference/gRPC/Interfaces/ObjectOperations/PromoteUnmanagedObject/",component:f("/Frameworks/User-Interface-Extensibility-Framework/Reference/gRPC/Interfaces/ObjectOperations/PromoteUnmanagedObject/","17c"),exact:!0,sidebar:"tutorialSidebar"},{path:"/Frameworks/User-Interface-Extensibility-Framework/Reference/gRPC/Interfaces/ObjectOperations/RemoveObjectFile/",component:f("/Frameworks/User-Interface-Extensibility-Framework/Reference/gRPC/Interfaces/ObjectOperations/RemoveObjectFile/","02b"),exact:!0,sidebar:"tutorialSidebar"},{path:"/Frameworks/User-Interface-Extensibility-Framework/Reference/gRPC/Interfaces/ObjectOperations/RemoveObjects/",component:f("/Frameworks/User-Interface-Extensibility-Framework/Reference/gRPC/Interfaces/ObjectOperations/RemoveObjects/","020"),exact:!0,sidebar:"tutorialSidebar"},{path:"/Frameworks/User-Interface-Extensibility-Framework/Reference/gRPC/Interfaces/ObjectOperations/RenameObjectFile/",component:f("/Frameworks/User-Interface-Extensibility-Framework/Reference/gRPC/Interfaces/ObjectOperations/RenameObjectFile/","39f"),exact:!0,sidebar:"tutorialSidebar"},{path:"/Frameworks/User-Interface-Extensibility-Framework/Reference/gRPC/Interfaces/ObjectOperations/SetObjectLevelProperty/",component:f("/Frameworks/User-Interface-Extensibility-Framework/Reference/gRPC/Interfaces/ObjectOperations/SetObjectLevelProperty/","86a"),exact:!0,sidebar:"tutorialSidebar"},{path:"/Frameworks/User-Interface-Extensibility-Framework/Reference/gRPC/Interfaces/ObjectOperations/SetPropertiesMultiple/",component:f("/Frameworks/User-Interface-Extensibility-Framework/Reference/gRPC/Interfaces/ObjectOperations/SetPropertiesMultiple/","ff3"),exact:!0,sidebar:"tutorialSidebar"},{path:"/Frameworks/User-Interface-Extensibility-Framework/Reference/gRPC/Interfaces/ObjectOperations/UndoCheckoutMultiple/",component:f("/Frameworks/User-Interface-Extensibility-Framework/Reference/gRPC/Interfaces/ObjectOperations/UndoCheckoutMultiple/","bfd"),exact:!0,sidebar:"tutorialSidebar"},{path:"/Frameworks/User-Interface-Extensibility-Framework/Reference/gRPC/Interfaces/ObjectOperations/UploadExistingFiles/",component:f("/Frameworks/User-Interface-Extensibility-Framework/Reference/gRPC/Interfaces/ObjectOperations/UploadExistingFiles/","056"),exact:!0,sidebar:"tutorialSidebar"},{path:"/Frameworks/User-Interface-Extensibility-Framework/Reference/gRPC/Interfaces/ObjectTypesOperations/",component:f("/Frameworks/User-Interface-Extensibility-Framework/Reference/gRPC/Interfaces/ObjectTypesOperations/","402"),exact:!0,sidebar:"tutorialSidebar"},{path:"/Frameworks/User-Interface-Extensibility-Framework/Reference/gRPC/Interfaces/ObjectTypesOperations/GetObjectTypes/",component:f("/Frameworks/User-Interface-Extensibility-Framework/Reference/gRPC/Interfaces/ObjectTypesOperations/GetObjectTypes/","c1d"),exact:!0,sidebar:"tutorialSidebar"},{path:"/Frameworks/User-Interface-Extensibility-Framework/Reference/gRPC/Interfaces/PropertyDefsOperations/",component:f("/Frameworks/User-Interface-Extensibility-Framework/Reference/gRPC/Interfaces/PropertyDefsOperations/","ff4"),exact:!0,sidebar:"tutorialSidebar"},{path:"/Frameworks/User-Interface-Extensibility-Framework/Reference/gRPC/Interfaces/PropertyDefsOperations/GetObjectClassesAndGroups/",component:f("/Frameworks/User-Interface-Extensibility-Framework/Reference/gRPC/Interfaces/PropertyDefsOperations/GetObjectClassesAndGroups/","d0d"),exact:!0,sidebar:"tutorialSidebar"},{path:"/Frameworks/User-Interface-Extensibility-Framework/Reference/gRPC/Interfaces/PropertyDefsOperations/GetPropertyDefs/",component:f("/Frameworks/User-Interface-Extensibility-Framework/Reference/gRPC/Interfaces/PropertyDefsOperations/GetPropertyDefs/","de3"),exact:!0,sidebar:"tutorialSidebar"},{path:"/Frameworks/User-Interface-Extensibility-Framework/Reference/gRPC/Interfaces/SearchOperations/",component:f("/Frameworks/User-Interface-Extensibility-Framework/Reference/gRPC/Interfaces/SearchOperations/","3f0"),exact:!0,sidebar:"tutorialSidebar"},{path:"/Frameworks/User-Interface-Extensibility-Framework/Reference/gRPC/Interfaces/SearchOperations/GetFolderContents/",component:f("/Frameworks/User-Interface-Extensibility-Framework/Reference/gRPC/Interfaces/SearchOperations/GetFolderContents/","b5c"),exact:!0,sidebar:"tutorialSidebar"},{path:"/Frameworks/User-Interface-Extensibility-Framework/Reference/gRPC/Interfaces/SearchOperations/SearchObjects/",component:f("/Frameworks/User-Interface-Extensibility-Framework/Reference/gRPC/Interfaces/SearchOperations/SearchObjects/","e0c"),exact:!0,sidebar:"tutorialSidebar"},{path:"/Frameworks/User-Interface-Extensibility-Framework/Reference/gRPC/Interfaces/ValueListsOperations/",component:f("/Frameworks/User-Interface-Extensibility-Framework/Reference/gRPC/Interfaces/ValueListsOperations/","1e1"),exact:!0,sidebar:"tutorialSidebar"},{path:"/Frameworks/User-Interface-Extensibility-Framework/Reference/gRPC/Interfaces/ValueListsOperations/GetValueListItemsWithPermissions/",component:f("/Frameworks/User-Interface-Extensibility-Framework/Reference/gRPC/Interfaces/ValueListsOperations/GetValueListItemsWithPermissions/","688"),exact:!0,sidebar:"tutorialSidebar"},{path:"/Frameworks/User-Interface-Extensibility-Framework/Reference/gRPC/Interfaces/ValueListsOperations/GetValueLists/",component:f("/Frameworks/User-Interface-Extensibility-Framework/Reference/gRPC/Interfaces/ValueListsOperations/GetValueLists/","439"),exact:!0,sidebar:"tutorialSidebar"},{path:"/Frameworks/User-Interface-Extensibility-Framework/Reference/gRPC/Interfaces/ValueListsOperations/SearchValueListItemsWithPermissions/",component:f("/Frameworks/User-Interface-Extensibility-Framework/Reference/gRPC/Interfaces/ValueListsOperations/SearchValueListItemsWithPermissions/","81b"),exact:!0,sidebar:"tutorialSidebar"},{path:"/Frameworks/User-Interface-Extensibility-Framework/Reference/gRPC/Interfaces/VaultExtensionMethodsOperations/",component:f("/Frameworks/User-Interface-Extensibility-Framework/Reference/gRPC/Interfaces/VaultExtensionMethodsOperations/","6ce"),exact:!0,sidebar:"tutorialSidebar"},{path:"/Frameworks/User-Interface-Extensibility-Framework/Reference/gRPC/Interfaces/VaultExtensionMethodsOperations/IsExtensionMethodAvailable/",component:f("/Frameworks/User-Interface-Extensibility-Framework/Reference/gRPC/Interfaces/VaultExtensionMethodsOperations/IsExtensionMethodAvailable/","350"),exact:!0,sidebar:"tutorialSidebar"},{path:"/Frameworks/User-Interface-Extensibility-Framework/Reference/gRPC/Interfaces/VaultExtensionMethodsOperations/RunExtensionMethod/",component:f("/Frameworks/User-Interface-Extensibility-Framework/Reference/gRPC/Interfaces/VaultExtensionMethodsOperations/RunExtensionMethod/","09e"),exact:!0,sidebar:"tutorialSidebar"},{path:"/Frameworks/User-Interface-Extensibility-Framework/Reference/gRPC/Interfaces/VaultOperations/",component:f("/Frameworks/User-Interface-Extensibility-Framework/Reference/gRPC/Interfaces/VaultOperations/","c39"),exact:!0,sidebar:"tutorialSidebar"},{path:"/Frameworks/User-Interface-Extensibility-Framework/Reference/gRPC/Interfaces/VaultOperations/GetMetadataStructureItemIdByAlias/",component:f("/Frameworks/User-Interface-Extensibility-Framework/Reference/gRPC/Interfaces/VaultOperations/GetMetadataStructureItemIdByAlias/","419"),exact:!0,sidebar:"tutorialSidebar"},{path:"/Frameworks/User-Interface-Extensibility-Framework/Reference/gRPC/Interfaces/VaultOperations/GetMetadataStructureItemIdByGUID/",component:f("/Frameworks/User-Interface-Extensibility-Framework/Reference/gRPC/Interfaces/VaultOperations/GetMetadataStructureItemIdByGUID/","fc1"),exact:!0,sidebar:"tutorialSidebar"},{path:"/Frameworks/User-Interface-Extensibility-Framework/Reference/gRPC/Interfaces/ViewsOperations/",component:f("/Frameworks/User-Interface-Extensibility-Framework/Reference/gRPC/Interfaces/ViewsOperations/","a19"),exact:!0,sidebar:"tutorialSidebar"},{path:"/Frameworks/User-Interface-Extensibility-Framework/Reference/gRPC/Interfaces/ViewsOperations/DeleteView/",component:f("/Frameworks/User-Interface-Extensibility-Framework/Reference/gRPC/Interfaces/ViewsOperations/DeleteView/","f0e"),exact:!0,sidebar:"tutorialSidebar"},{path:"/Frameworks/User-Interface-Extensibility-Framework/Reference/gRPC/Interfaces/ViewsOperations/GetViews/",component:f("/Frameworks/User-Interface-Extensibility-Framework/Reference/gRPC/Interfaces/ViewsOperations/GetViews/","cd2"),exact:!0,sidebar:"tutorialSidebar"},{path:"/Frameworks/User-Interface-Extensibility-Framework/Reference/gRPC/Messages/",component:f("/Frameworks/User-Interface-Extensibility-Framework/Reference/gRPC/Messages/","ec9"),exact:!0,sidebar:"tutorialSidebar"},{path:"/Frameworks/User-Interface-Extensibility-Framework/Reference/gRPC/Messages/AccessControlEntry/",component:f("/Frameworks/User-Interface-Extensibility-Framework/Reference/gRPC/Messages/AccessControlEntry/","772"),exact:!0,sidebar:"tutorialSidebar"},{path:"/Frameworks/User-Interface-Extensibility-Framework/Reference/gRPC/Messages/AccessControlList/",component:f("/Frameworks/User-Interface-Extensibility-Framework/Reference/gRPC/Messages/AccessControlList/","529"),exact:!0,sidebar:"tutorialSidebar"},{path:"/Frameworks/User-Interface-Extensibility-Framework/Reference/gRPC/Messages/AccessControlListComponent/",component:f("/Frameworks/User-Interface-Extensibility-Framework/Reference/gRPC/Messages/AccessControlListComponent/","0c4"),exact:!0,sidebar:"tutorialSidebar"},{path:"/Frameworks/User-Interface-Extensibility-Framework/Reference/gRPC/Messages/AccessControlListComponentKey/",component:f("/Frameworks/User-Interface-Extensibility-Framework/Reference/gRPC/Messages/AccessControlListComponentKey/","5e9"),exact:!0,sidebar:"tutorialSidebar"},{path:"/Frameworks/User-Interface-Extensibility-Framework/Reference/gRPC/Messages/AccessControlListComponentMapEntry/",component:f("/Frameworks/User-Interface-Extensibility-Framework/Reference/gRPC/Messages/AccessControlListComponentMapEntry/","707"),exact:!0,sidebar:"tutorialSidebar"},{path:"/Frameworks/User-Interface-Extensibility-Framework/Reference/gRPC/Messages/ACCESSCONTROLLISTCOMPONENTSTATUSFLAGS/",component:f("/Frameworks/User-Interface-Extensibility-Framework/Reference/gRPC/Messages/ACCESSCONTROLLISTCOMPONENTSTATUSFLAGS/","493"),exact:!0,sidebar:"tutorialSidebar"},{path:"/Frameworks/User-Interface-Extensibility-Framework/Reference/gRPC/Messages/AccessControlPseudoUserSubject/",component:f("/Frameworks/User-Interface-Extensibility-Framework/Reference/gRPC/Messages/AccessControlPseudoUserSubject/","e86"),exact:!0,sidebar:"tutorialSidebar"},{path:"/Frameworks/User-Interface-Extensibility-Framework/Reference/gRPC/Messages/AccessControlSubject/",component:f("/Frameworks/User-Interface-Extensibility-Framework/Reference/gRPC/Messages/AccessControlSubject/","bb8"),exact:!0,sidebar:"tutorialSidebar"},{path:"/Frameworks/User-Interface-Extensibility-Framework/Reference/gRPC/Messages/AccessControlSubjectUnion/",component:f("/Frameworks/User-Interface-Extensibility-Framework/Reference/gRPC/Messages/AccessControlSubjectUnion/","85f"),exact:!0,sidebar:"tutorialSidebar"},{path:"/Frameworks/User-Interface-Extensibility-Framework/Reference/gRPC/Messages/ACTIONFLAGS/",component:f("/Frameworks/User-Interface-Extensibility-Framework/Reference/gRPC/Messages/ACTIONFLAGS/","02d"),exact:!0,sidebar:"tutorialSidebar"},{path:"/Frameworks/User-Interface-Extensibility-Framework/Reference/gRPC/Messages/AssociatedPropertyDef/",component:f("/Frameworks/User-Interface-Extensibility-Framework/Reference/gRPC/Messages/AssociatedPropertyDef/","f70"),exact:!0,sidebar:"tutorialSidebar"},{path:"/Frameworks/User-Interface-Extensibility-Framework/Reference/gRPC/Messages/AutomaticMetadataRequest/",component:f("/Frameworks/User-Interface-Extensibility-Framework/Reference/gRPC/Messages/AutomaticMetadataRequest/","822"),exact:!0,sidebar:"tutorialSidebar"},{path:"/Frameworks/User-Interface-Extensibility-Framework/Reference/gRPC/Messages/AutomaticMetadataResult/",component:f("/Frameworks/User-Interface-Extensibility-Framework/Reference/gRPC/Messages/AutomaticMetadataResult/","fb8"),exact:!0,sidebar:"tutorialSidebar"},{path:"/Frameworks/User-Interface-Extensibility-Framework/Reference/gRPC/Messages/AutomaticPermissions/",component:f("/Frameworks/User-Interface-Extensibility-Framework/Reference/gRPC/Messages/AutomaticPermissions/","5c3"),exact:!0,sidebar:"tutorialSidebar"},{path:"/Frameworks/User-Interface-Extensibility-Framework/Reference/gRPC/Messages/Bytes/",component:f("/Frameworks/User-Interface-Extensibility-Framework/Reference/gRPC/Messages/Bytes/","4e2"),exact:!0,sidebar:"tutorialSidebar"},{path:"/Frameworks/User-Interface-Extensibility-Framework/Reference/gRPC/Messages/ClassGroup/",component:f("/Frameworks/User-Interface-Extensibility-Framework/Reference/gRPC/Messages/ClassGroup/","9cd"),exact:!0,sidebar:"tutorialSidebar"},{path:"/Frameworks/User-Interface-Extensibility-Framework/Reference/gRPC/Messages/ClassPermissionsForClient/",component:f("/Frameworks/User-Interface-Extensibility-Framework/Reference/gRPC/Messages/ClassPermissionsForClient/","a53"),exact:!0,sidebar:"tutorialSidebar"},{path:"/Frameworks/User-Interface-Extensibility-Framework/Reference/gRPC/Messages/DataFunctionCall/",component:f("/Frameworks/User-Interface-Extensibility-Framework/Reference/gRPC/Messages/DataFunctionCall/","317"),exact:!0,sidebar:"tutorialSidebar"},{path:"/Frameworks/User-Interface-Extensibility-Framework/Reference/gRPC/Messages/DataFunctionUnion/",component:f("/Frameworks/User-Interface-Extensibility-Framework/Reference/gRPC/Messages/DataFunctionUnion/","a54"),exact:!0,sidebar:"tutorialSidebar"},{path:"/Frameworks/User-Interface-Extensibility-Framework/Reference/gRPC/Messages/DataFunctionUnion/DateData/",component:f("/Frameworks/User-Interface-Extensibility-Framework/Reference/gRPC/Messages/DataFunctionUnion/DateData/","4f1"),exact:!0,sidebar:"tutorialSidebar"},{path:"/Frameworks/User-Interface-Extensibility-Framework/Reference/gRPC/Messages/DataFunctionUnion/DaysFromData/",component:f("/Frameworks/User-Interface-Extensibility-Framework/Reference/gRPC/Messages/DataFunctionUnion/DaysFromData/","b2f"),exact:!0,sidebar:"tutorialSidebar"},{path:"/Frameworks/User-Interface-Extensibility-Framework/Reference/gRPC/Messages/DataFunctionUnion/DaysToData/",component:f("/Frameworks/User-Interface-Extensibility-Framework/Reference/gRPC/Messages/DataFunctionUnion/DaysToData/","fed"),exact:!0,sidebar:"tutorialSidebar"},{path:"/Frameworks/User-Interface-Extensibility-Framework/Reference/gRPC/Messages/DataFunctionUnion/InitialCharacterGroupData/",component:f("/Frameworks/User-Interface-Extensibility-Framework/Reference/gRPC/Messages/DataFunctionUnion/InitialCharacterGroupData/","6e3"),exact:!0,sidebar:"tutorialSidebar"},{path:"/Frameworks/User-Interface-Extensibility-Framework/Reference/gRPC/Messages/DataFunctionUnion/IntegerSegmentData/",component:f("/Frameworks/User-Interface-Extensibility-Framework/Reference/gRPC/Messages/DataFunctionUnion/IntegerSegmentData/","30a"),exact:!0,sidebar:"tutorialSidebar"},{path:"/Frameworks/User-Interface-Extensibility-Framework/Reference/gRPC/Messages/DataFunctionUnion/LeftCharactersData/",component:f("/Frameworks/User-Interface-Extensibility-Framework/Reference/gRPC/Messages/DataFunctionUnion/LeftCharactersData/","3b8"),exact:!0,sidebar:"tutorialSidebar"},{path:"/Frameworks/User-Interface-Extensibility-Framework/Reference/gRPC/Messages/DataFunctionUnion/MonthData/",component:f("/Frameworks/User-Interface-Extensibility-Framework/Reference/gRPC/Messages/DataFunctionUnion/MonthData/","5b6"),exact:!0,sidebar:"tutorialSidebar"},{path:"/Frameworks/User-Interface-Extensibility-Framework/Reference/gRPC/Messages/DataFunctionUnion/NoOpData/",component:f("/Frameworks/User-Interface-Extensibility-Framework/Reference/gRPC/Messages/DataFunctionUnion/NoOpData/","c0b"),exact:!0,sidebar:"tutorialSidebar"},{path:"/Frameworks/User-Interface-Extensibility-Framework/Reference/gRPC/Messages/DataFunctionUnion/YearAndMonthData/",component:f("/Frameworks/User-Interface-Extensibility-Framework/Reference/gRPC/Messages/DataFunctionUnion/YearAndMonthData/","dab"),exact:!0,sidebar:"tutorialSidebar"},{path:"/Frameworks/User-Interface-Extensibility-Framework/Reference/gRPC/Messages/DataFunctionUnion/YearData/",component:f("/Frameworks/User-Interface-Extensibility-Framework/Reference/gRPC/Messages/DataFunctionUnion/YearData/","bf6"),exact:!0,sidebar:"tutorialSidebar"},{path:"/Frameworks/User-Interface-Extensibility-Framework/Reference/gRPC/Messages/DefaultReplicationConfiguration/",component:f("/Frameworks/User-Interface-Extensibility-Framework/Reference/gRPC/Messages/DefaultReplicationConfiguration/","14e"),exact:!0,sidebar:"tutorialSidebar"},{path:"/Frameworks/User-Interface-Extensibility-Framework/Reference/gRPC/Messages/DocClassGroup/",component:f("/Frameworks/User-Interface-Extensibility-Framework/Reference/gRPC/Messages/DocClassGroup/","6a4"),exact:!0,sidebar:"tutorialSidebar"},{path:"/Frameworks/User-Interface-Extensibility-Framework/Reference/gRPC/Messages/EffectivePermissions/",component:f("/Frameworks/User-Interface-Extensibility-Framework/Reference/gRPC/Messages/EffectivePermissions/","02b"),exact:!0,sidebar:"tutorialSidebar"},{path:"/Frameworks/User-Interface-Extensibility-Framework/Reference/gRPC/Messages/ErrorInfo/",component:f("/Frameworks/User-Interface-Extensibility-Framework/Reference/gRPC/Messages/ErrorInfo/","235"),exact:!0,sidebar:"tutorialSidebar"},{path:"/Frameworks/User-Interface-Extensibility-Framework/Reference/gRPC/Messages/EventSubscription/",component:f("/Frameworks/User-Interface-Extensibility-Framework/Reference/gRPC/Messages/EventSubscription/","64b"),exact:!0,sidebar:"tutorialSidebar"},{path:"/Frameworks/User-Interface-Extensibility-Framework/Reference/gRPC/Messages/Expression/",component:f("/Frameworks/User-Interface-Extensibility-Framework/Reference/gRPC/Messages/Expression/","6c2"),exact:!0,sidebar:"tutorialSidebar"},{path:"/Frameworks/User-Interface-Extensibility-Framework/Reference/gRPC/Messages/EXPRESSIONEXFLAGS/",component:f("/Frameworks/User-Interface-Extensibility-Framework/Reference/gRPC/Messages/EXPRESSIONEXFLAGS/","06b"),exact:!0,sidebar:"tutorialSidebar"},{path:"/Frameworks/User-Interface-Extensibility-Framework/Reference/gRPC/Messages/ExpressionUnion/",component:f("/Frameworks/User-Interface-Extensibility-Framework/Reference/gRPC/Messages/ExpressionUnion/","6b2"),exact:!0,sidebar:"tutorialSidebar"},{path:"/Frameworks/User-Interface-Extensibility-Framework/Reference/gRPC/Messages/ExpressionUnion/AnyFieldData/",component:f("/Frameworks/User-Interface-Extensibility-Framework/Reference/gRPC/Messages/ExpressionUnion/AnyFieldData/","437"),exact:!0,sidebar:"tutorialSidebar"},{path:"/Frameworks/User-Interface-Extensibility-Framework/Reference/gRPC/Messages/ExpressionUnion/FileValueData/",component:f("/Frameworks/User-Interface-Extensibility-Framework/Reference/gRPC/Messages/ExpressionUnion/FileValueData/","e33"),exact:!0,sidebar:"tutorialSidebar"},{path:"/Frameworks/User-Interface-Extensibility-Framework/Reference/gRPC/Messages/ExpressionUnion/IdSegmentData/",component:f("/Frameworks/User-Interface-Extensibility-Framework/Reference/gRPC/Messages/ExpressionUnion/IdSegmentData/","294"),exact:!0,sidebar:"tutorialSidebar"},{path:"/Frameworks/User-Interface-Extensibility-Framework/Reference/gRPC/Messages/ExpressionUnion/PermissionsData/",component:f("/Frameworks/User-Interface-Extensibility-Framework/Reference/gRPC/Messages/ExpressionUnion/PermissionsData/","489"),exact:!0,sidebar:"tutorialSidebar"},{path:"/Frameworks/User-Interface-Extensibility-Framework/Reference/gRPC/Messages/ExpressionUnion/PropertyValueData/",component:f("/Frameworks/User-Interface-Extensibility-Framework/Reference/gRPC/Messages/ExpressionUnion/PropertyValueData/","1c1"),exact:!0,sidebar:"tutorialSidebar"},{path:"/Frameworks/User-Interface-Extensibility-Framework/Reference/gRPC/Messages/ExpressionUnion/StatusValueData/",component:f("/Frameworks/User-Interface-Extensibility-Framework/Reference/gRPC/Messages/ExpressionUnion/StatusValueData/","68f"),exact:!0,sidebar:"tutorialSidebar"},{path:"/Frameworks/User-Interface-Extensibility-Framework/Reference/gRPC/Messages/ExpressionUnion/TypedValueData/",component:f("/Frameworks/User-Interface-Extensibility-Framework/Reference/gRPC/Messages/ExpressionUnion/TypedValueData/","a7d"),exact:!0,sidebar:"tutorialSidebar"},{path:"/Frameworks/User-Interface-Extensibility-Framework/Reference/gRPC/Messages/ExpressionUnion/UninitializedData/",component:f("/Frameworks/User-Interface-Extensibility-Framework/Reference/gRPC/Messages/ExpressionUnion/UninitializedData/","d4d"),exact:!0,sidebar:"tutorialSidebar"},{path:"/Frameworks/User-Interface-Extensibility-Framework/Reference/gRPC/Messages/ExternalRepositoryID/",component:f("/Frameworks/User-Interface-Extensibility-Framework/Reference/gRPC/Messages/ExternalRepositoryID/","87d"),exact:!0,sidebar:"tutorialSidebar"},{path:"/Frameworks/User-Interface-Extensibility-Framework/Reference/gRPC/Messages/ExternalView/",component:f("/Frameworks/User-Interface-Extensibility-Framework/Reference/gRPC/Messages/ExternalView/","d2d"),exact:!0,sidebar:"tutorialSidebar"},{path:"/Frameworks/User-Interface-Extensibility-Framework/Reference/gRPC/Messages/ExtObjectInfo/",component:f("/Frameworks/User-Interface-Extensibility-Framework/Reference/gRPC/Messages/ExtObjectInfo/","ad4"),exact:!0,sidebar:"tutorialSidebar"},{path:"/Frameworks/User-Interface-Extensibility-Framework/Reference/gRPC/Messages/File/",component:f("/Frameworks/User-Interface-Extensibility-Framework/Reference/gRPC/Messages/File/","b28"),exact:!0,sidebar:"tutorialSidebar"},{path:"/Frameworks/User-Interface-Extensibility-Framework/Reference/gRPC/Messages/FileID/",component:f("/Frameworks/User-Interface-Extensibility-Framework/Reference/gRPC/Messages/FileID/","3a6"),exact:!0,sidebar:"tutorialSidebar"},{path:"/Frameworks/User-Interface-Extensibility-Framework/Reference/gRPC/Messages/FileVer/",component:f("/Frameworks/User-Interface-Extensibility-Framework/Reference/gRPC/Messages/FileVer/","c4d"),exact:!0,sidebar:"tutorialSidebar"},{path:"/Frameworks/User-Interface-Extensibility-Framework/Reference/gRPC/Messages/Folder/",component:f("/Frameworks/User-Interface-Extensibility-Framework/Reference/gRPC/Messages/Folder/","78d"),exact:!0,sidebar:"tutorialSidebar"},{path:"/Frameworks/User-Interface-Extensibility-Framework/Reference/gRPC/Messages/FOLDERCAPABILITYFLAGS/",component:f("/Frameworks/User-Interface-Extensibility-Framework/Reference/gRPC/Messages/FOLDERCAPABILITYFLAGS/","5d5"),exact:!0,sidebar:"tutorialSidebar"},{path:"/Frameworks/User-Interface-Extensibility-Framework/Reference/gRPC/Messages/FolderInfoUnion/",component:f("/Frameworks/User-Interface-Extensibility-Framework/Reference/gRPC/Messages/FolderInfoUnion/","e66"),exact:!0,sidebar:"tutorialSidebar"},{path:"/Frameworks/User-Interface-Extensibility-Framework/Reference/gRPC/Messages/FolderInfoUnion/AnyFolderData/",component:f("/Frameworks/User-Interface-Extensibility-Framework/Reference/gRPC/Messages/FolderInfoUnion/AnyFolderData/","591"),exact:!0,sidebar:"tutorialSidebar"},{path:"/Frameworks/User-Interface-Extensibility-Framework/Reference/gRPC/Messages/FolderInfoUnion/ExternalViewFolderData/",component:f("/Frameworks/User-Interface-Extensibility-Framework/Reference/gRPC/Messages/FolderInfoUnion/ExternalViewFolderData/","ced"),exact:!0,sidebar:"tutorialSidebar"},{path:"/Frameworks/User-Interface-Extensibility-Framework/Reference/gRPC/Messages/FolderInfoUnion/PropertyFolderData/",component:f("/Frameworks/User-Interface-Extensibility-Framework/Reference/gRPC/Messages/FolderInfoUnion/PropertyFolderData/","008"),exact:!0,sidebar:"tutorialSidebar"},{path:"/Frameworks/User-Interface-Extensibility-Framework/Reference/gRPC/Messages/FolderInfoUnion/SearchFolderData/",component:f("/Frameworks/User-Interface-Extensibility-Framework/Reference/gRPC/Messages/FolderInfoUnion/SearchFolderData/","00d"),exact:!0,sidebar:"tutorialSidebar"},{path:"/Frameworks/User-Interface-Extensibility-Framework/Reference/gRPC/Messages/FolderInfoUnion/TraditionalFolderData/",component:f("/Frameworks/User-Interface-Extensibility-Framework/Reference/gRPC/Messages/FolderInfoUnion/TraditionalFolderData/","d4a"),exact:!0,sidebar:"tutorialSidebar"},{path:"/Frameworks/User-Interface-Extensibility-Framework/Reference/gRPC/Messages/FolderInfoUnion/UnknownFolderData/",component:f("/Frameworks/User-Interface-Extensibility-Framework/Reference/gRPC/Messages/FolderInfoUnion/UnknownFolderData/","7c8"),exact:!0,sidebar:"tutorialSidebar"},{path:"/Frameworks/User-Interface-Extensibility-Framework/Reference/gRPC/Messages/FolderInfoUnion/ViewFolderData/",component:f("/Frameworks/User-Interface-Extensibility-Framework/Reference/gRPC/Messages/FolderInfoUnion/ViewFolderData/","81d"),exact:!0,sidebar:"tutorialSidebar"},{path:"/Frameworks/User-Interface-Extensibility-Framework/Reference/gRPC/Messages/FTSFLAGS/",component:f("/Frameworks/User-Interface-Extensibility-Framework/Reference/gRPC/Messages/FTSFLAGS/","8a7"),exact:!0,sidebar:"tutorialSidebar"},{path:"/Frameworks/User-Interface-Extensibility-Framework/Reference/gRPC/Messages/GetMetadataStructureItemIdByGUIDRequest/",component:f("/Frameworks/User-Interface-Extensibility-Framework/Reference/gRPC/Messages/GetMetadataStructureItemIdByGUIDRequest/","bee"),exact:!0,sidebar:"tutorialSidebar"},{path:"/Frameworks/User-Interface-Extensibility-Framework/Reference/gRPC/Messages/GetMetadataStructureItemIdByGUIDResponse/",component:f("/Frameworks/User-Interface-Extensibility-Framework/Reference/gRPC/Messages/GetMetadataStructureItemIdByGUIDResponse/","a25"),exact:!0,sidebar:"tutorialSidebar"},{path:"/Frameworks/User-Interface-Extensibility-Framework/Reference/gRPC/Messages/GetObjectVersionAndPropertiesOfMultipleObjectsResponse/",component:f("/Frameworks/User-Interface-Extensibility-Framework/Reference/gRPC/Messages/GetObjectVersionAndPropertiesOfMultipleObjectsResponse/","22b"),exact:!0,sidebar:"tutorialSidebar"},{path:"/Frameworks/User-Interface-Extensibility-Framework/Reference/gRPC/Messages/GroupingLevel/",component:f("/Frameworks/User-Interface-Extensibility-Framework/Reference/gRPC/Messages/GroupingLevel/","537"),exact:!0,sidebar:"tutorialSidebar"},{path:"/Frameworks/User-Interface-Extensibility-Framework/Reference/gRPC/Messages/IndirectionLevel/",component:f("/Frameworks/User-Interface-Extensibility-Framework/Reference/gRPC/Messages/IndirectionLevel/","8b3"),exact:!0,sidebar:"tutorialSidebar"},{path:"/Frameworks/User-Interface-Extensibility-Framework/Reference/gRPC/Messages/IndirectPropertyID/",component:f("/Frameworks/User-Interface-Extensibility-Framework/Reference/gRPC/Messages/IndirectPropertyID/","8ab"),exact:!0,sidebar:"tutorialSidebar"},{path:"/Frameworks/User-Interface-Extensibility-Framework/Reference/gRPC/Messages/IndirectPropertyIDLevel/",component:f("/Frameworks/User-Interface-Extensibility-Framework/Reference/gRPC/Messages/IndirectPropertyIDLevel/","f0b"),exact:!0,sidebar:"tutorialSidebar"},{path:"/Frameworks/User-Interface-Extensibility-Framework/Reference/gRPC/Messages/IndirectPropertyIDLevelRef/",component:f("/Frameworks/User-Interface-Extensibility-Framework/Reference/gRPC/Messages/IndirectPropertyIDLevelRef/","592"),exact:!0,sidebar:"tutorialSidebar"},{path:"/Frameworks/User-Interface-Extensibility-Framework/Reference/gRPC/Messages/ITEMFLAGS/",component:f("/Frameworks/User-Interface-Extensibility-Framework/Reference/gRPC/Messages/ITEMFLAGS/","822"),exact:!0,sidebar:"tutorialSidebar"},{path:"/Frameworks/User-Interface-Extensibility-Framework/Reference/gRPC/Messages/ItemID/",component:f("/Frameworks/User-Interface-Extensibility-Framework/Reference/gRPC/Messages/ItemID/","cc8"),exact:!0,sidebar:"tutorialSidebar"},{path:"/Frameworks/User-Interface-Extensibility-Framework/Reference/gRPC/Messages/ItemInfo/",component:f("/Frameworks/User-Interface-Extensibility-Framework/Reference/gRPC/Messages/ItemInfo/","a94"),exact:!0,sidebar:"tutorialSidebar"},{path:"/Frameworks/User-Interface-Extensibility-Framework/Reference/gRPC/Messages/Lookup/",component:f("/Frameworks/User-Interface-Extensibility-Framework/Reference/gRPC/Messages/Lookup/","0c5"),exact:!0,sidebar:"tutorialSidebar"},{path:"/Frameworks/User-Interface-Extensibility-Framework/Reference/gRPC/Messages/LookupWithMetadata/",component:f("/Frameworks/User-Interface-Extensibility-Framework/Reference/gRPC/Messages/LookupWithMetadata/","fb9"),exact:!0,sidebar:"tutorialSidebar"},{path:"/Frameworks/User-Interface-Extensibility-Framework/Reference/gRPC/Messages/MultiSelectLookup/",component:f("/Frameworks/User-Interface-Extensibility-Framework/Reference/gRPC/Messages/MultiSelectLookup/","cbd"),exact:!0,sidebar:"tutorialSidebar"},{path:"/Frameworks/User-Interface-Extensibility-Framework/Reference/gRPC/Messages/MultiSelectLookupWithMetadata/",component:f("/Frameworks/User-Interface-Extensibility-Framework/Reference/gRPC/Messages/MultiSelectLookupWithMetadata/","033"),exact:!0,sidebar:"tutorialSidebar"},{path:"/Frameworks/User-Interface-Extensibility-Framework/Reference/gRPC/Messages/NamedACL/",component:f("/Frameworks/User-Interface-Extensibility-Framework/Reference/gRPC/Messages/NamedACL/","53d"),exact:!0,sidebar:"tutorialSidebar"},{path:"/Frameworks/User-Interface-Extensibility-Framework/Reference/gRPC/Messages/NamedValue/",component:f("/Frameworks/User-Interface-Extensibility-Framework/Reference/gRPC/Messages/NamedValue/","7ed"),exact:!0,sidebar:"tutorialSidebar"},{path:"/Frameworks/User-Interface-Extensibility-Framework/Reference/gRPC/Messages/OBJECTCAPABILITYFLAGS/",component:f("/Frameworks/User-Interface-Extensibility-Framework/Reference/gRPC/Messages/OBJECTCAPABILITYFLAGS/","5e2"),exact:!0,sidebar:"tutorialSidebar"},{path:"/Frameworks/User-Interface-Extensibility-Framework/Reference/gRPC/Messages/ObjectClass/",component:f("/Frameworks/User-Interface-Extensibility-Framework/Reference/gRPC/Messages/ObjectClass/","b03"),exact:!0,sidebar:"tutorialSidebar"},{path:"/Frameworks/User-Interface-Extensibility-Framework/Reference/gRPC/Messages/OBJECTDATAREQUESTFLAGS/",component:f("/Frameworks/User-Interface-Extensibility-Framework/Reference/gRPC/Messages/OBJECTDATAREQUESTFLAGS/","842"),exact:!0,sidebar:"tutorialSidebar"},{path:"/Frameworks/User-Interface-Extensibility-Framework/Reference/gRPC/Messages/OBJECTFILEFLAGS/",component:f("/Frameworks/User-Interface-Extensibility-Framework/Reference/gRPC/Messages/OBJECTFILEFLAGS/","597"),exact:!0,sidebar:"tutorialSidebar"},{path:"/Frameworks/User-Interface-Extensibility-Framework/Reference/gRPC/Messages/ObjectLevelInfo/",component:f("/Frameworks/User-Interface-Extensibility-Framework/Reference/gRPC/Messages/ObjectLevelInfo/","115"),exact:!0,sidebar:"tutorialSidebar"},{path:"/Frameworks/User-Interface-Extensibility-Framework/Reference/gRPC/Messages/OBJECTOPFLAGS/",component:f("/Frameworks/User-Interface-Extensibility-Framework/Reference/gRPC/Messages/OBJECTOPFLAGS/","f7f"),exact:!0,sidebar:"tutorialSidebar"},{path:"/Frameworks/User-Interface-Extensibility-Framework/Reference/gRPC/Messages/ObjectPermissionsForClient/",component:f("/Frameworks/User-Interface-Extensibility-Framework/Reference/gRPC/Messages/ObjectPermissionsForClient/","4f9"),exact:!0,sidebar:"tutorialSidebar"},{path:"/Frameworks/User-Interface-Extensibility-Framework/Reference/gRPC/Messages/ObjectTypeIndexingDefinition/",component:f("/Frameworks/User-Interface-Extensibility-Framework/Reference/gRPC/Messages/ObjectTypeIndexingDefinition/","0eb"),exact:!0,sidebar:"tutorialSidebar"},{path:"/Frameworks/User-Interface-Extensibility-Framework/Reference/gRPC/Messages/ObjectTypePermissionsForClient/",component:f("/Frameworks/User-Interface-Extensibility-Framework/Reference/gRPC/Messages/ObjectTypePermissionsForClient/","888"),exact:!0,sidebar:"tutorialSidebar"},{path:"/Frameworks/User-Interface-Extensibility-Framework/Reference/gRPC/Messages/ObjectTypeSearchCharacteristics/",component:f("/Frameworks/User-Interface-Extensibility-Framework/Reference/gRPC/Messages/ObjectTypeSearchCharacteristics/","333"),exact:!0,sidebar:"tutorialSidebar"},{path:"/Frameworks/User-Interface-Extensibility-Framework/Reference/gRPC/Messages/ObjectTypeTargetForBrowsing/",component:f("/Frameworks/User-Interface-Extensibility-Framework/Reference/gRPC/Messages/ObjectTypeTargetForBrowsing/","fed"),exact:!0,sidebar:"tutorialSidebar"},{path:"/Frameworks/User-Interface-Extensibility-Framework/Reference/gRPC/Messages/ObjectVersion/",component:f("/Frameworks/User-Interface-Extensibility-Framework/Reference/gRPC/Messages/ObjectVersion/","51f"),exact:!0,sidebar:"tutorialSidebar"},{path:"/Frameworks/User-Interface-Extensibility-Framework/Reference/gRPC/Messages/ObjectVersionActivity/",component:f("/Frameworks/User-Interface-Extensibility-Framework/Reference/gRPC/Messages/ObjectVersionActivity/","f76"),exact:!0,sidebar:"tutorialSidebar"},{path:"/Frameworks/User-Interface-Extensibility-Framework/Reference/gRPC/Messages/OBJECTVERSIONACTIVITYCATEGORYFLAGS/",component:f("/Frameworks/User-Interface-Extensibility-Framework/Reference/gRPC/Messages/OBJECTVERSIONACTIVITYCATEGORYFLAGS/","2b8"),exact:!0,sidebar:"tutorialSidebar"},{path:"/Frameworks/User-Interface-Extensibility-Framework/Reference/gRPC/Messages/ObjectVersionActivityRequest/",component:f("/Frameworks/User-Interface-Extensibility-Framework/Reference/gRPC/Messages/ObjectVersionActivityRequest/","4d4"),exact:!0,sidebar:"tutorialSidebar"},{path:"/Frameworks/User-Interface-Extensibility-Framework/Reference/gRPC/Messages/ObjectVersionActivityResponse/",component:f("/Frameworks/User-Interface-Extensibility-Framework/Reference/gRPC/Messages/ObjectVersionActivityResponse/","dc6"),exact:!0,sidebar:"tutorialSidebar"},{path:"/Frameworks/User-Interface-Extensibility-Framework/Reference/gRPC/Messages/ObjectVersionAndPropertiesWithMetadata/",component:f("/Frameworks/User-Interface-Extensibility-Framework/Reference/gRPC/Messages/ObjectVersionAndPropertiesWithMetadata/","3d7"),exact:!0,sidebar:"tutorialSidebar"},{path:"/Frameworks/User-Interface-Extensibility-Framework/Reference/gRPC/Messages/ObjectVersionData/",component:f("/Frameworks/User-Interface-Extensibility-Framework/Reference/gRPC/Messages/ObjectVersionData/","e89"),exact:!0,sidebar:"tutorialSidebar"},{path:"/Frameworks/User-Interface-Extensibility-Framework/Reference/gRPC/Messages/ObjectVersionDataRequest/",component:f("/Frameworks/User-Interface-Extensibility-Framework/Reference/gRPC/Messages/ObjectVersionDataRequest/","e17"),exact:!0,sidebar:"tutorialSidebar"},{path:"/Frameworks/User-Interface-Extensibility-Framework/Reference/gRPC/Messages/ObjectVersionDataResult/",component:f("/Frameworks/User-Interface-Extensibility-Framework/Reference/gRPC/Messages/ObjectVersionDataResult/","d3f"),exact:!0,sidebar:"tutorialSidebar"},{path:"/Frameworks/User-Interface-Extensibility-Framework/Reference/gRPC/Messages/ObjectVersionEx/",component:f("/Frameworks/User-Interface-Extensibility-Framework/Reference/gRPC/Messages/ObjectVersionEx/","aac"),exact:!0,sidebar:"tutorialSidebar"},{path:"/Frameworks/User-Interface-Extensibility-Framework/Reference/gRPC/Messages/ObjectVersionExWP/",component:f("/Frameworks/User-Interface-Extensibility-Framework/Reference/gRPC/Messages/ObjectVersionExWP/","b26"),exact:!0,sidebar:"tutorialSidebar"},{path:"/Frameworks/User-Interface-Extensibility-Framework/Reference/gRPC/Messages/ObjectVersionFileActivity/",component:f("/Frameworks/User-Interface-Extensibility-Framework/Reference/gRPC/Messages/ObjectVersionFileActivity/","8ec"),exact:!0,sidebar:"tutorialSidebar"},{path:"/Frameworks/User-Interface-Extensibility-Framework/Reference/gRPC/Messages/OBJECTVERSIONFILEACTIVITYFLAGS/",component:f("/Frameworks/User-Interface-Extensibility-Framework/Reference/gRPC/Messages/OBJECTVERSIONFILEACTIVITYFLAGS/","dd6"),exact:!0,sidebar:"tutorialSidebar"},{path:"/Frameworks/User-Interface-Extensibility-Framework/Reference/gRPC/Messages/ObjectVersionPropertyActivity/",component:f("/Frameworks/User-Interface-Extensibility-Framework/Reference/gRPC/Messages/ObjectVersionPropertyActivity/","c48"),exact:!0,sidebar:"tutorialSidebar"},{path:"/Frameworks/User-Interface-Extensibility-Framework/Reference/gRPC/Messages/OBJECTVERSIONPROPERTYACTIVITYFLAGS/",component:f("/Frameworks/User-Interface-Extensibility-Framework/Reference/gRPC/Messages/OBJECTVERSIONPROPERTYACTIVITYFLAGS/","50d"),exact:!0,sidebar:"tutorialSidebar"},{path:"/Frameworks/User-Interface-Extensibility-Framework/Reference/gRPC/Messages/ObjFileSource/",component:f("/Frameworks/User-Interface-Extensibility-Framework/Reference/gRPC/Messages/ObjFileSource/","793"),exact:!0,sidebar:"tutorialSidebar"},{path:"/Frameworks/User-Interface-Extensibility-Framework/Reference/gRPC/Messages/ObjFileSourceUnion/",component:f("/Frameworks/User-Interface-Extensibility-Framework/Reference/gRPC/Messages/ObjFileSourceUnion/","88b"),exact:!0,sidebar:"tutorialSidebar"},{path:"/Frameworks/User-Interface-Extensibility-Framework/Reference/gRPC/Messages/ObjFileSourceUnion/BlankTemplateData/",component:f("/Frameworks/User-Interface-Extensibility-Framework/Reference/gRPC/Messages/ObjFileSourceUnion/BlankTemplateData/","782"),exact:!0,sidebar:"tutorialSidebar"},{path:"/Frameworks/User-Interface-Extensibility-Framework/Reference/gRPC/Messages/ObjFileSourceUnion/UndefinedSourceData/",component:f("/Frameworks/User-Interface-Extensibility-Framework/Reference/gRPC/Messages/ObjFileSourceUnion/UndefinedSourceData/","407"),exact:!0,sidebar:"tutorialSidebar"},{path:"/Frameworks/User-Interface-Extensibility-Framework/Reference/gRPC/Messages/ObjFileSourceUnion/UploadedFileData/",component:f("/Frameworks/User-Interface-Extensibility-Framework/Reference/gRPC/Messages/ObjFileSourceUnion/UploadedFileData/","89f"),exact:!0,sidebar:"tutorialSidebar"},{path:"/Frameworks/User-Interface-Extensibility-Framework/Reference/gRPC/Messages/ObjFileSourceUnion/UploadedFilesData/",component:f("/Frameworks/User-Interface-Extensibility-Framework/Reference/gRPC/Messages/ObjFileSourceUnion/UploadedFilesData/","3f1"),exact:!0,sidebar:"tutorialSidebar"},{path:"/Frameworks/User-Interface-Extensibility-Framework/Reference/gRPC/Messages/ObjFileSourceUnion/UserDefinedTemplateData/",component:f("/Frameworks/User-Interface-Extensibility-Framework/Reference/gRPC/Messages/ObjFileSourceUnion/UserDefinedTemplateData/","c31"),exact:!0,sidebar:"tutorialSidebar"},{path:"/Frameworks/User-Interface-Extensibility-Framework/Reference/gRPC/Messages/ObjFileVer/",component:f("/Frameworks/User-Interface-Extensibility-Framework/Reference/gRPC/Messages/ObjFileVer/","974"),exact:!0,sidebar:"tutorialSidebar"},{path:"/Frameworks/User-Interface-Extensibility-Framework/Reference/gRPC/Messages/ObjID/",component:f("/Frameworks/User-Interface-Extensibility-Framework/Reference/gRPC/Messages/ObjID/","8e2"),exact:!0,sidebar:"tutorialSidebar"},{path:"/Frameworks/User-Interface-Extensibility-Framework/Reference/gRPC/Messages/OBJTYPEFLAGS/",component:f("/Frameworks/User-Interface-Extensibility-Framework/Reference/gRPC/Messages/OBJTYPEFLAGS/","f83"),exact:!0,sidebar:"tutorialSidebar"},{path:"/Frameworks/User-Interface-Extensibility-Framework/Reference/gRPC/Messages/ObjVer/",component:f("/Frameworks/User-Interface-Extensibility-Framework/Reference/gRPC/Messages/ObjVer/","c09"),exact:!0,sidebar:"tutorialSidebar"},{path:"/Frameworks/User-Interface-Extensibility-Framework/Reference/gRPC/Messages/OBJVERFLAGS/",component:f("/Frameworks/User-Interface-Extensibility-Framework/Reference/gRPC/Messages/OBJVERFLAGS/","535"),exact:!0,sidebar:"tutorialSidebar"},{path:"/Frameworks/User-Interface-Extensibility-Framework/Reference/gRPC/Messages/ObjVerVersion/",component:f("/Frameworks/User-Interface-Extensibility-Framework/Reference/gRPC/Messages/ObjVerVersion/","178"),exact:!0,sidebar:"tutorialSidebar"},{path:"/Frameworks/User-Interface-Extensibility-Framework/Reference/gRPC/Messages/ObjVerWithProperties/",component:f("/Frameworks/User-Interface-Extensibility-Framework/Reference/gRPC/Messages/ObjVerWithProperties/","24b"),exact:!0,sidebar:"tutorialSidebar"},{path:"/Frameworks/User-Interface-Extensibility-Framework/Reference/gRPC/Messages/PropertyDef/",component:f("/Frameworks/User-Interface-Extensibility-Framework/Reference/gRPC/Messages/PropertyDef/","c60"),exact:!0,sidebar:"tutorialSidebar"},{path:"/Frameworks/User-Interface-Extensibility-Framework/Reference/gRPC/Messages/PROPERTYDEFFLAGS/",component:f("/Frameworks/User-Interface-Extensibility-Framework/Reference/gRPC/Messages/PROPERTYDEFFLAGS/","c33"),exact:!0,sidebar:"tutorialSidebar"},{path:"/Frameworks/User-Interface-Extensibility-Framework/Reference/gRPC/Messages/PropertyDefPermissionsForClient/",component:f("/Frameworks/User-Interface-Extensibility-Framework/Reference/gRPC/Messages/PropertyDefPermissionsForClient/","976"),exact:!0,sidebar:"tutorialSidebar"},{path:"/Frameworks/User-Interface-Extensibility-Framework/Reference/gRPC/Messages/PropertyValue/",component:f("/Frameworks/User-Interface-Extensibility-Framework/Reference/gRPC/Messages/PropertyValue/","bcd"),exact:!0,sidebar:"tutorialSidebar"},{path:"/Frameworks/User-Interface-Extensibility-Framework/Reference/gRPC/Messages/PropertyValueArray/",component:f("/Frameworks/User-Interface-Extensibility-Framework/Reference/gRPC/Messages/PropertyValueArray/","28c"),exact:!0,sidebar:"tutorialSidebar"},{path:"/Frameworks/User-Interface-Extensibility-Framework/Reference/gRPC/Messages/PropertyValueSuggestion/",component:f("/Frameworks/User-Interface-Extensibility-Framework/Reference/gRPC/Messages/PropertyValueSuggestion/","18c"),exact:!0,sidebar:"tutorialSidebar"},{path:"/Frameworks/User-Interface-Extensibility-Framework/Reference/gRPC/Messages/PropertyValueWithMetadata/",component:f("/Frameworks/User-Interface-Extensibility-Framework/Reference/gRPC/Messages/PropertyValueWithMetadata/","028"),exact:!0,sidebar:"tutorialSidebar"},{path:"/Frameworks/User-Interface-Extensibility-Framework/Reference/gRPC/Messages/PropertyValueWithMetadataArray/",component:f("/Frameworks/User-Interface-Extensibility-Framework/Reference/gRPC/Messages/PropertyValueWithMetadataArray/","118"),exact:!0,sidebar:"tutorialSidebar"},{path:"/Frameworks/User-Interface-Extensibility-Framework/Reference/gRPC/Messages/RelationshipData/",component:f("/Frameworks/User-Interface-Extensibility-Framework/Reference/gRPC/Messages/RelationshipData/","d6e"),exact:!0,sidebar:"tutorialSidebar"},{path:"/Frameworks/User-Interface-Extensibility-Framework/Reference/gRPC/Messages/RelationshipGroup/",component:f("/Frameworks/User-Interface-Extensibility-Framework/Reference/gRPC/Messages/RelationshipGroup/","1ff"),exact:!0,sidebar:"tutorialSidebar"},{path:"/Frameworks/User-Interface-Extensibility-Framework/Reference/gRPC/Messages/SearchCondition/",component:f("/Frameworks/User-Interface-Extensibility-Framework/Reference/gRPC/Messages/SearchCondition/","78c"),exact:!0,sidebar:"tutorialSidebar"},{path:"/Frameworks/User-Interface-Extensibility-Framework/Reference/gRPC/Messages/SearchConditionArray/",component:f("/Frameworks/User-Interface-Extensibility-Framework/Reference/gRPC/Messages/SearchConditionArray/","bb7"),exact:!0,sidebar:"tutorialSidebar"},{path:"/Frameworks/User-Interface-Extensibility-Framework/Reference/gRPC/Messages/SearchDef/",component:f("/Frameworks/User-Interface-Extensibility-Framework/Reference/gRPC/Messages/SearchDef/","301"),exact:!0,sidebar:"tutorialSidebar"},{path:"/Frameworks/User-Interface-Extensibility-Framework/Reference/gRPC/Messages/SearchFlags/",component:f("/Frameworks/User-Interface-Extensibility-Framework/Reference/gRPC/Messages/SearchFlags/","658"),exact:!0,sidebar:"tutorialSidebar"},{path:"/Frameworks/User-Interface-Extensibility-Framework/Reference/gRPC/Messages/SearchOutputInfo/",component:f("/Frameworks/User-Interface-Extensibility-Framework/Reference/gRPC/Messages/SearchOutputInfo/","865"),exact:!0,sidebar:"tutorialSidebar"},{path:"/Frameworks/User-Interface-Extensibility-Framework/Reference/gRPC/Messages/SearchResultsItem/",component:f("/Frameworks/User-Interface-Extensibility-Framework/Reference/gRPC/Messages/SearchResultsItem/","981"),exact:!0,sidebar:"tutorialSidebar"},{path:"/Frameworks/User-Interface-Extensibility-Framework/Reference/gRPC/Messages/SearchResultsPageRequest/",component:f("/Frameworks/User-Interface-Extensibility-Framework/Reference/gRPC/Messages/SearchResultsPageRequest/","369"),exact:!0,sidebar:"tutorialSidebar"},{path:"/Frameworks/User-Interface-Extensibility-Framework/Reference/gRPC/Messages/SearchResultsSorting/",component:f("/Frameworks/User-Interface-Extensibility-Framework/Reference/gRPC/Messages/SearchResultsSorting/","49e"),exact:!0,sidebar:"tutorialSidebar"},{path:"/Frameworks/User-Interface-Extensibility-Framework/Reference/gRPC/Messages/SEARCHSTATUSFLAGS/",component:f("/Frameworks/User-Interface-Extensibility-Framework/Reference/gRPC/Messages/SEARCHSTATUSFLAGS/","adb"),exact:!0,sidebar:"tutorialSidebar"},{path:"/Frameworks/User-Interface-Extensibility-Framework/Reference/gRPC/Messages/SearchTarget/",component:f("/Frameworks/User-Interface-Extensibility-Framework/Reference/gRPC/Messages/SearchTarget/","df2"),exact:!0,sidebar:"tutorialSidebar"},{path:"/Frameworks/User-Interface-Extensibility-Framework/Reference/gRPC/Messages/ServerVaultCapabilities/",component:f("/Frameworks/User-Interface-Extensibility-Framework/Reference/gRPC/Messages/ServerVaultCapabilities/","6ec"),exact:!0,sidebar:"tutorialSidebar"},{path:"/Frameworks/User-Interface-Extensibility-Framework/Reference/gRPC/Messages/SessionInfo/",component:f("/Frameworks/User-Interface-Extensibility-Framework/Reference/gRPC/Messages/SessionInfo/","faf"),exact:!0,sidebar:"tutorialSidebar"},{path:"/Frameworks/User-Interface-Extensibility-Framework/Reference/gRPC/Messages/SetPropertiesParams/",component:f("/Frameworks/User-Interface-Extensibility-Framework/Reference/gRPC/Messages/SetPropertiesParams/","724"),exact:!0,sidebar:"tutorialSidebar"},{path:"/Frameworks/User-Interface-Extensibility-Framework/Reference/gRPC/Messages/SortFlags/",component:f("/Frameworks/User-Interface-Extensibility-Framework/Reference/gRPC/Messages/SortFlags/","89e"),exact:!0,sidebar:"tutorialSidebar"},{path:"/Frameworks/User-Interface-Extensibility-Framework/Reference/gRPC/Messages/SortRule/",component:f("/Frameworks/User-Interface-Extensibility-Framework/Reference/gRPC/Messages/SortRule/","141"),exact:!0,sidebar:"tutorialSidebar"},{path:"/Frameworks/User-Interface-Extensibility-Framework/Reference/gRPC/Messages/SortRuleFlags/",component:f("/Frameworks/User-Interface-Extensibility-Framework/Reference/gRPC/Messages/SortRuleFlags/","2f5"),exact:!0,sidebar:"tutorialSidebar"},{path:"/Frameworks/User-Interface-Extensibility-Framework/Reference/gRPC/Messages/SortRuleValueArray/",component:f("/Frameworks/User-Interface-Extensibility-Framework/Reference/gRPC/Messages/SortRuleValueArray/","c99"),exact:!0,sidebar:"tutorialSidebar"},{path:"/Frameworks/User-Interface-Extensibility-Framework/Reference/gRPC/Messages/SRPREQUESTFLAGS/",component:f("/Frameworks/User-Interface-Extensibility-Framework/Reference/gRPC/Messages/SRPREQUESTFLAGS/","706"),exact:!0,sidebar:"tutorialSidebar"},{path:"/Frameworks/User-Interface-Extensibility-Framework/Reference/gRPC/Messages/StateBasic/",component:f("/Frameworks/User-Interface-Extensibility-Framework/Reference/gRPC/Messages/StateBasic/","65e"),exact:!0,sidebar:"tutorialSidebar"},{path:"/Frameworks/User-Interface-Extensibility-Framework/Reference/gRPC/Messages/STATEFLAGS/",component:f("/Frameworks/User-Interface-Extensibility-Framework/Reference/gRPC/Messages/STATEFLAGS/","4fd"),exact:!0,sidebar:"tutorialSidebar"},{path:"/Frameworks/User-Interface-Extensibility-Framework/Reference/gRPC/Messages/StateTransitionBasic/",component:f("/Frameworks/User-Interface-Extensibility-Framework/Reference/gRPC/Messages/StateTransitionBasic/","c5c"),exact:!0,sidebar:"tutorialSidebar"},{path:"/Frameworks/User-Interface-Extensibility-Framework/Reference/gRPC/Messages/SubviewGroup/",component:f("/Frameworks/User-Interface-Extensibility-Framework/Reference/gRPC/Messages/SubviewGroup/","92e"),exact:!0,sidebar:"tutorialSidebar"},{path:"/Frameworks/User-Interface-Extensibility-Framework/Reference/gRPC/Messages/Template/",component:f("/Frameworks/User-Interface-Extensibility-Framework/Reference/gRPC/Messages/Template/","733"),exact:!0,sidebar:"tutorialSidebar"},{path:"/Frameworks/User-Interface-Extensibility-Framework/Reference/gRPC/Messages/TypedValue/",component:f("/Frameworks/User-Interface-Extensibility-Framework/Reference/gRPC/Messages/TypedValue/","f04"),exact:!0,sidebar:"tutorialSidebar"},{path:"/Frameworks/User-Interface-Extensibility-Framework/Reference/gRPC/Messages/TypedValueMetadata/",component:f("/Frameworks/User-Interface-Extensibility-Framework/Reference/gRPC/Messages/TypedValueMetadata/","973"),exact:!0,sidebar:"tutorialSidebar"},{path:"/Frameworks/User-Interface-Extensibility-Framework/Reference/gRPC/Messages/TypedValueUnion/",component:f("/Frameworks/User-Interface-Extensibility-Framework/Reference/gRPC/Messages/TypedValueUnion/","e50"),exact:!0,sidebar:"tutorialSidebar"},{path:"/Frameworks/User-Interface-Extensibility-Framework/Reference/gRPC/Messages/TypedValueUnionWithMetadata/",component:f("/Frameworks/User-Interface-Extensibility-Framework/Reference/gRPC/Messages/TypedValueUnionWithMetadata/","ed7"),exact:!0,sidebar:"tutorialSidebar"},{path:"/Frameworks/User-Interface-Extensibility-Framework/Reference/gRPC/Messages/TypedValueWithMetadata/",component:f("/Frameworks/User-Interface-Extensibility-Framework/Reference/gRPC/Messages/TypedValueWithMetadata/","e3f"),exact:!0,sidebar:"tutorialSidebar"},{path:"/Frameworks/User-Interface-Extensibility-Framework/Reference/gRPC/Messages/UploadedFile/",component:f("/Frameworks/User-Interface-Extensibility-Framework/Reference/gRPC/Messages/UploadedFile/","b72"),exact:!0,sidebar:"tutorialSidebar"},{path:"/Frameworks/User-Interface-Extensibility-Framework/Reference/gRPC/Messages/UploadedFileArray/",component:f("/Frameworks/User-Interface-Extensibility-Framework/Reference/gRPC/Messages/UploadedFileArray/","d48"),exact:!0,sidebar:"tutorialSidebar"},{path:"/Frameworks/User-Interface-Extensibility-Framework/Reference/gRPC/Messages/ValueList/",component:f("/Frameworks/User-Interface-Extensibility-Framework/Reference/gRPC/Messages/ValueList/","52c"),exact:!0,sidebar:"tutorialSidebar"},{path:"/Frameworks/User-Interface-Extensibility-Framework/Reference/gRPC/Messages/ValueListItem/",component:f("/Frameworks/User-Interface-Extensibility-Framework/Reference/gRPC/Messages/ValueListItem/","0c0"),exact:!0,sidebar:"tutorialSidebar"},{path:"/Frameworks/User-Interface-Extensibility-Framework/Reference/gRPC/Messages/VersionComment/",component:f("/Frameworks/User-Interface-Extensibility-Framework/Reference/gRPC/Messages/VersionComment/","cc4"),exact:!0,sidebar:"tutorialSidebar"},{path:"/Frameworks/User-Interface-Extensibility-Framework/Reference/gRPC/Messages/VersionCommentArray/",component:f("/Frameworks/User-Interface-Extensibility-Framework/Reference/gRPC/Messages/VersionCommentArray/","ef9"),exact:!0,sidebar:"tutorialSidebar"},{path:"/Frameworks/User-Interface-Extensibility-Framework/Reference/gRPC/Messages/View/",component:f("/Frameworks/User-Interface-Extensibility-Framework/Reference/gRPC/Messages/View/","a08"),exact:!0,sidebar:"tutorialSidebar"},{path:"/Frameworks/User-Interface-Extensibility-Framework/Reference/gRPC/Messages/VIEWFLAGS/",component:f("/Frameworks/User-Interface-Extensibility-Framework/Reference/gRPC/Messages/VIEWFLAGS/","016"),exact:!0,sidebar:"tutorialSidebar"},{path:"/Frameworks/User-Interface-Extensibility-Framework/Reference/gRPC/Messages/ViewLocation/",component:f("/Frameworks/User-Interface-Extensibility-Framework/Reference/gRPC/Messages/ViewLocation/","cf3"),exact:!0,sidebar:"tutorialSidebar"},{path:"/Frameworks/User-Interface-Extensibility-Framework/Reference/gRPC/Messages/ViewVisualization/",component:f("/Frameworks/User-Interface-Extensibility-Framework/Reference/gRPC/Messages/ViewVisualization/","4fd"),exact:!0,sidebar:"tutorialSidebar"},{path:"/Frameworks/User-Interface-Extensibility-Framework/Reference/gRPC/Messages/Workflow/",component:f("/Frameworks/User-Interface-Extensibility-Framework/Reference/gRPC/Messages/Workflow/","6ea"),exact:!0,sidebar:"tutorialSidebar"},{path:"/Frameworks/User-Interface-Extensibility-Framework/Reference/gRPC/Messages/WorkflowBasic/",component:f("/Frameworks/User-Interface-Extensibility-Framework/Reference/gRPC/Messages/WorkflowBasic/","1db"),exact:!0,sidebar:"tutorialSidebar"},{path:"/Frameworks/User-Interface-Extensibility-Framework/Reference/Overview/",component:f("/Frameworks/User-Interface-Extensibility-Framework/Reference/Overview/","138"),exact:!0,sidebar:"tutorialSidebar"},{path:"/Frameworks/User-Interface-Extensibility-Framework/Reference/Overview/ApplicationStructure/",component:f("/Frameworks/User-Interface-Extensibility-Framework/Reference/Overview/ApplicationStructure/","c08"),exact:!0,sidebar:"tutorialSidebar"},{path:"/Frameworks/User-Interface-Extensibility-Framework/Reference/Overview/Commands/",component:f("/Frameworks/User-Interface-Extensibility-Framework/Reference/Overview/Commands/","9e8"),exact:!0,sidebar:"tutorialSidebar"},{path:"/Frameworks/User-Interface-Extensibility-Framework/Reference/Overview/Dashboards/",component:f("/Frameworks/User-Interface-Extensibility-Framework/Reference/Overview/Dashboards/","27a"),exact:!0,sidebar:"tutorialSidebar"},{path:"/Frameworks/User-Interface-Extensibility-Framework/Reference/Overview/Debugging/",component:f("/Frameworks/User-Interface-Extensibility-Framework/Reference/Overview/Debugging/","05e"),exact:!0,sidebar:"tutorialSidebar"},{path:"/Frameworks/User-Interface-Extensibility-Framework/Reference/Overview/Events/",component:f("/Frameworks/User-Interface-Extensibility-Framework/Reference/Overview/Events/","058"),exact:!0,sidebar:"tutorialSidebar"},{path:"/Frameworks/User-Interface-Extensibility-Framework/Reference/Overview/exceptions/",component:f("/Frameworks/User-Interface-Extensibility-Framework/Reference/Overview/exceptions/","e2b"),exact:!0,sidebar:"tutorialSidebar"},{path:"/Frameworks/User-Interface-Extensibility-Framework/Reference/Overview/InstallingApplications/",component:f("/Frameworks/User-Interface-Extensibility-Framework/Reference/Overview/InstallingApplications/","802"),exact:!0,sidebar:"tutorialSidebar"},{path:"/Frameworks/User-Interface-Extensibility-Framework/Reference/Overview/ListingView/",component:f("/Frameworks/User-Interface-Extensibility-Framework/Reference/Overview/ListingView/","5b9"),exact:!0,sidebar:"tutorialSidebar"},{path:"/Frameworks/User-Interface-Extensibility-Framework/Reference/Overview/Messages/",component:f("/Frameworks/User-Interface-Extensibility-Framework/Reference/Overview/Messages/","511"),exact:!0,sidebar:"tutorialSidebar"},{path:"/Frameworks/User-Interface-Extensibility-Framework/Reference/Overview/MFilesGlobalObject/",component:f("/Frameworks/User-Interface-Extensibility-Framework/Reference/Overview/MFilesGlobalObject/","74d"),exact:!0,sidebar:"tutorialSidebar"},{path:"/Frameworks/User-Interface-Extensibility-Framework/Reference/Overview/Modules/",component:f("/Frameworks/User-Interface-Extensibility-Framework/Reference/Overview/Modules/","449"),exact:!0,sidebar:"tutorialSidebar"},{path:"/Frameworks/User-Interface-Extensibility-Framework/Reference/Overview/Tabs/",component:f("/Frameworks/User-Interface-Extensibility-Framework/Reference/Overview/Tabs/","cfa"),exact:!0,sidebar:"tutorialSidebar"},{path:"/Frameworks/User-Interface-Extensibility-Framework/Reference/Overview/VaultMessages/",component:f("/Frameworks/User-Interface-Extensibility-Framework/Reference/Overview/VaultMessages/","fb9"),exact:!0,sidebar:"tutorialSidebar"},{path:"/Frameworks/User-Interface-Extensibility-Framework/Reference/Samples/",component:f("/Frameworks/User-Interface-Extensibility-Framework/Reference/Samples/","759"),exact:!0,sidebar:"tutorialSidebar"},{path:"/Frameworks/User-Interface-Extensibility-Framework/Reference/Samples/AssignToMe/",component:f("/Frameworks/User-Interface-Extensibility-Framework/Reference/Samples/AssignToMe/","3f0"),exact:!0,sidebar:"tutorialSidebar"},{path:"/Frameworks/User-Interface-Extensibility-Framework/Reference/Samples/BuiltInCommands/",component:f("/Frameworks/User-Interface-Extensibility-Framework/Reference/Samples/BuiltInCommands/","4c7"),exact:!0,sidebar:"tutorialSidebar"},{path:"/Frameworks/User-Interface-Extensibility-Framework/Reference/Samples/Commands/",component:f("/Frameworks/User-Interface-Extensibility-Framework/Reference/Samples/Commands/","2c9"),exact:!0,sidebar:"tutorialSidebar"},{path:"/Frameworks/User-Interface-Extensibility-Framework/Reference/Samples/ErrorHandling/",component:f("/Frameworks/User-Interface-Extensibility-Framework/Reference/Samples/ErrorHandling/","cab"),exact:!0,sidebar:"tutorialSidebar"},{path:"/Frameworks/User-Interface-Extensibility-Framework/Reference/Samples/HelloWorld/",component:f("/Frameworks/User-Interface-Extensibility-Framework/Reference/Samples/HelloWorld/","e94"),exact:!0,sidebar:"tutorialSidebar"},{path:"/Frameworks/User-Interface-Extensibility-Framework/Reference/Samples/ObjectOperationSupport/",component:f("/Frameworks/User-Interface-Extensibility-Framework/Reference/Samples/ObjectOperationSupport/","491"),exact:!0,sidebar:"tutorialSidebar"},{path:"/Frameworks/User-Interface-Extensibility-Framework/Reference/Samples/PopupDashboard/",component:f("/Frameworks/User-Interface-Extensibility-Framework/Reference/Samples/PopupDashboard/","c01"),exact:!0,sidebar:"tutorialSidebar"},{path:"/Frameworks/User-Interface-Extensibility-Framework/Reference/Samples/PopUpDashboardWithAccentColor/",component:f("/Frameworks/User-Interface-Extensibility-Framework/Reference/Samples/PopUpDashboardWithAccentColor/","eb1"),exact:!0,sidebar:"tutorialSidebar"},{path:"/Frameworks/User-Interface-Extensibility-Framework/Reference/Samples/SandboxAttributesSupport/",component:f("/Frameworks/User-Interface-Extensibility-Framework/Reference/Samples/SandboxAttributesSupport/","45c"),exact:!0,sidebar:"tutorialSidebar"},{path:"/Frameworks/User-Interface-Extensibility-Framework/Reference/Samples/SearchFolderExamples/",component:f("/Frameworks/User-Interface-Extensibility-Framework/Reference/Samples/SearchFolderExamples/","855"),exact:!0,sidebar:"tutorialSidebar"},{path:"/Frameworks/User-Interface-Extensibility-Framework/Reference/Samples/ShellFrameAndDashboard/",component:f("/Frameworks/User-Interface-Extensibility-Framework/Reference/Samples/ShellFrameAndDashboard/","fa7"),exact:!0,sidebar:"tutorialSidebar"},{path:"/Frameworks/User-Interface-Extensibility-Framework/Reference/Samples/ShowNewObjectWindow With Blank and UserDefined Template/",component:f("/Frameworks/User-Interface-Extensibility-Framework/Reference/Samples/ShowNewObjectWindow With Blank and UserDefined Template/","bbf"),exact:!0,sidebar:"tutorialSidebar"},{path:"/Frameworks/User-Interface-Extensibility-Framework/Reference/Samples/TaskbarCommands/",component:f("/Frameworks/User-Interface-Extensibility-Framework/Reference/Samples/TaskbarCommands/","705"),exact:!0,sidebar:"tutorialSidebar"},{path:"/Frameworks/User-Interface-Extensibility-Framework/Reference/Samples/VaultMessagesPackage/",component:f("/Frameworks/User-Interface-Extensibility-Framework/Reference/Samples/VaultMessagesPackage/","e04"),exact:!0,sidebar:"tutorialSidebar"},{path:"/Frameworks/User-Interface-Extensibility-Framework/Reference/UIExt2/",component:f("/Frameworks/User-Interface-Extensibility-Framework/Reference/UIExt2/","153"),exact:!0,sidebar:"tutorialSidebar"},{path:"/Frameworks/User-Interface-Extensibility-Framework/Reference/UIExt2/Enums/",component:f("/Frameworks/User-Interface-Extensibility-Framework/Reference/UIExt2/Enums/","340"),exact:!0,sidebar:"tutorialSidebar"},{path:"/Frameworks/User-Interface-Extensibility-Framework/Reference/UIExt2/Enums/BuiltinCommand/",component:f("/Frameworks/User-Interface-Extensibility-Framework/Reference/UIExt2/Enums/BuiltinCommand/","bbe"),exact:!0,sidebar:"tutorialSidebar"},{path:"/Frameworks/User-Interface-Extensibility-Framework/Reference/UIExt2/Enums/BuiltInIcon/",component:f("/Frameworks/User-Interface-Extensibility-Framework/Reference/UIExt2/Enums/BuiltInIcon/","a6e"),exact:!0,sidebar:"tutorialSidebar"},{path:"/Frameworks/User-Interface-Extensibility-Framework/Reference/UIExt2/Enums/CommandLocation/",component:f("/Frameworks/User-Interface-Extensibility-Framework/Reference/UIExt2/Enums/CommandLocation/","1af"),exact:!0,sidebar:"tutorialSidebar"},{path:"/Frameworks/User-Interface-Extensibility-Framework/Reference/UIExt2/Enums/CommandState/",component:f("/Frameworks/User-Interface-Extensibility-Framework/Reference/UIExt2/Enums/CommandState/","52b"),exact:!0,sidebar:"tutorialSidebar"},{path:"/Frameworks/User-Interface-Extensibility-Framework/Reference/UIExt2/Enums/Event/",component:f("/Frameworks/User-Interface-Extensibility-Framework/Reference/UIExt2/Enums/Event/","d9d"),exact:!0,sidebar:"tutorialSidebar"},{path:"/Frameworks/User-Interface-Extensibility-Framework/Reference/UIExt2/Enums/FacetRangeType/",component:f("/Frameworks/User-Interface-Extensibility-Framework/Reference/UIExt2/Enums/FacetRangeType/","2e2"),exact:!0,sidebar:"tutorialSidebar"},{path:"/Frameworks/User-Interface-Extensibility-Framework/Reference/UIExt2/Enums/FacetTransformation/",component:f("/Frameworks/User-Interface-Extensibility-Framework/Reference/UIExt2/Enums/FacetTransformation/","3c5"),exact:!0,sidebar:"tutorialSidebar"},{path:"/Frameworks/User-Interface-Extensibility-Framework/Reference/UIExt2/Enums/FacetType/",component:f("/Frameworks/User-Interface-Extensibility-Framework/Reference/UIExt2/Enums/FacetType/","037"),exact:!0,sidebar:"tutorialSidebar"},{path:"/Frameworks/User-Interface-Extensibility-Framework/Reference/UIExt2/Enums/FacetValueType/",component:f("/Frameworks/User-Interface-Extensibility-Framework/Reference/UIExt2/Enums/FacetValueType/","ee4"),exact:!0,sidebar:"tutorialSidebar"},{path:"/Frameworks/User-Interface-Extensibility-Framework/Reference/UIExt2/Enums/IconContentType/",component:f("/Frameworks/User-Interface-Extensibility-Framework/Reference/UIExt2/Enums/IconContentType/","033"),exact:!0,sidebar:"tutorialSidebar"},{path:"/Frameworks/User-Interface-Extensibility-Framework/Reference/UIExt2/Enums/MenuLocation/",component:f("/Frameworks/User-Interface-Extensibility-Framework/Reference/UIExt2/Enums/MenuLocation/","8f3"),exact:!0,sidebar:"tutorialSidebar"},{path:"/Frameworks/User-Interface-Extensibility-Framework/Reference/UIExt2/Enums/MFBuiltInObjectType/",component:f("/Frameworks/User-Interface-Extensibility-Framework/Reference/UIExt2/Enums/MFBuiltInObjectType/","498"),exact:!0,sidebar:"tutorialSidebar"},{path:"/Frameworks/User-Interface-Extensibility-Framework/Reference/UIExt2/Enums/MFBuiltInPropertyDef/",component:f("/Frameworks/User-Interface-Extensibility-Framework/Reference/UIExt2/Enums/MFBuiltInPropertyDef/","94b"),exact:!0,sidebar:"tutorialSidebar"},{path:"/Frameworks/User-Interface-Extensibility-Framework/Reference/UIExt2/Enums/MFBuiltInValueList/",component:f("/Frameworks/User-Interface-Extensibility-Framework/Reference/UIExt2/Enums/MFBuiltInValueList/","8d3"),exact:!0,sidebar:"tutorialSidebar"},{path:"/Frameworks/User-Interface-Extensibility-Framework/Reference/UIExt2/Enums/MFBuiltInView/",component:f("/Frameworks/User-Interface-Extensibility-Framework/Reference/UIExt2/Enums/MFBuiltInView/","a38"),exact:!0,sidebar:"tutorialSidebar"},{path:"/Frameworks/User-Interface-Extensibility-Framework/Reference/UIExt2/Enums/ObjectWindowResultCode/",component:f("/Frameworks/User-Interface-Extensibility-Framework/Reference/UIExt2/Enums/ObjectWindowResultCode/","0f1"),exact:!0,sidebar:"tutorialSidebar"},{path:"/Frameworks/User-Interface-Extensibility-Framework/Reference/UIExt2/Enums/SearchEngine/",component:f("/Frameworks/User-Interface-Extensibility-Framework/Reference/UIExt2/Enums/SearchEngine/","add"),exact:!0,sidebar:"tutorialSidebar"},{path:"/Frameworks/User-Interface-Extensibility-Framework/Reference/UIExt2/Enums/ToastType/",component:f("/Frameworks/User-Interface-Extensibility-Framework/Reference/UIExt2/Enums/ToastType/","55b"),exact:!0,sidebar:"tutorialSidebar"},{path:"/Frameworks/User-Interface-Extensibility-Framework/Reference/UIExt2/Events/",component:f("/Frameworks/User-Interface-Extensibility-Framework/Reference/UIExt2/Events/","686"),exact:!0,sidebar:"tutorialSidebar"},{path:"/Frameworks/User-Interface-Extensibility-Framework/Reference/UIExt2/Interfaces/",component:f("/Frameworks/User-Interface-Extensibility-Framework/Reference/UIExt2/Interfaces/","27e"),exact:!0,sidebar:"tutorialSidebar"},{path:"/Frameworks/User-Interface-Extensibility-Framework/Reference/UIExt2/Interfaces/ICommands/",component:f("/Frameworks/User-Interface-Extensibility-Framework/Reference/UIExt2/Interfaces/ICommands/","eb3"),exact:!0,sidebar:"tutorialSidebar"},{path:"/Frameworks/User-Interface-Extensibility-Framework/Reference/UIExt2/Interfaces/ICommands/AddCustomCommandToMenu/",component:f("/Frameworks/User-Interface-Extensibility-Framework/Reference/UIExt2/Interfaces/ICommands/AddCustomCommandToMenu/","f20"),exact:!0,sidebar:"tutorialSidebar"},{path:"/Frameworks/User-Interface-Extensibility-Framework/Reference/UIExt2/Interfaces/ICommands/CreateCustomCommand/",component:f("/Frameworks/User-Interface-Extensibility-Framework/Reference/UIExt2/Interfaces/ICommands/CreateCustomCommand/","7d5"),exact:!0,sidebar:"tutorialSidebar"},{path:"/Frameworks/User-Interface-Extensibility-Framework/Reference/UIExt2/Interfaces/ICommands/CreateSubMenuItem/",component:f("/Frameworks/User-Interface-Extensibility-Framework/Reference/UIExt2/Interfaces/ICommands/CreateSubMenuItem/","d75"),exact:!0,sidebar:"tutorialSidebar"},{path:"/Frameworks/User-Interface-Extensibility-Framework/Reference/UIExt2/Interfaces/ICommands/CreateTaskbarGroup/",component:f("/Frameworks/User-Interface-Extensibility-Framework/Reference/UIExt2/Interfaces/ICommands/CreateTaskbarGroup/","db7"),exact:!0,sidebar:"tutorialSidebar"},{path:"/Frameworks/User-Interface-Extensibility-Framework/Reference/UIExt2/Interfaces/ICommands/DeleteCustomCommand/",component:f("/Frameworks/User-Interface-Extensibility-Framework/Reference/UIExt2/Interfaces/ICommands/DeleteCustomCommand/","5ac"),exact:!0,sidebar:"tutorialSidebar"},{path:"/Frameworks/User-Interface-Extensibility-Framework/Reference/UIExt2/Interfaces/ICommands/ExecuteCommand/",component:f("/Frameworks/User-Interface-Extensibility-Framework/Reference/UIExt2/Interfaces/ICommands/ExecuteCommand/","28d"),exact:!0,sidebar:"tutorialSidebar"},{path:"/Frameworks/User-Interface-Extensibility-Framework/Reference/UIExt2/Interfaces/ICommands/GetCommandName/",component:f("/Frameworks/User-Interface-Extensibility-Framework/Reference/UIExt2/Interfaces/ICommands/GetCommandName/","590"),exact:!0,sidebar:"tutorialSidebar"},{path:"/Frameworks/User-Interface-Extensibility-Framework/Reference/UIExt2/Interfaces/ICommands/GetCommandState/",component:f("/Frameworks/User-Interface-Extensibility-Framework/Reference/UIExt2/Interfaces/ICommands/GetCommandState/","a39"),exact:!0,sidebar:"tutorialSidebar"},{path:"/Frameworks/User-Interface-Extensibility-Framework/Reference/UIExt2/Interfaces/ICommands/GetMenuIdOfBuiltInCommand/",component:f("/Frameworks/User-Interface-Extensibility-Framework/Reference/UIExt2/Interfaces/ICommands/GetMenuIdOfBuiltInCommand/","030"),exact:!0,sidebar:"tutorialSidebar"},{path:"/Frameworks/User-Interface-Extensibility-Framework/Reference/UIExt2/Interfaces/ICommands/RemoveCustomCommandFromMenu/",component:f("/Frameworks/User-Interface-Extensibility-Framework/Reference/UIExt2/Interfaces/ICommands/RemoveCustomCommandFromMenu/","909"),exact:!0,sidebar:"tutorialSidebar"},{path:"/Frameworks/User-Interface-Extensibility-Framework/Reference/UIExt2/Interfaces/ICommands/RemoveMenuItem/",component:f("/Frameworks/User-Interface-Extensibility-Framework/Reference/UIExt2/Interfaces/ICommands/RemoveMenuItem/","f44"),exact:!0,sidebar:"tutorialSidebar"},{path:"/Frameworks/User-Interface-Extensibility-Framework/Reference/UIExt2/Interfaces/ICommands/RemoveTaskbarGroup/",component:f("/Frameworks/User-Interface-Extensibility-Framework/Reference/UIExt2/Interfaces/ICommands/RemoveTaskbarGroup/","2f7"),exact:!0,sidebar:"tutorialSidebar"},{path:"/Frameworks/User-Interface-Extensibility-Framework/Reference/UIExt2/Interfaces/ICommands/SetCommandState/",component:f("/Frameworks/User-Interface-Extensibility-Framework/Reference/UIExt2/Interfaces/ICommands/SetCommandState/","d3a"),exact:!0,sidebar:"tutorialSidebar"},{path:"/Frameworks/User-Interface-Extensibility-Framework/Reference/UIExt2/Interfaces/ICommands/SetIcon/",component:f("/Frameworks/User-Interface-Extensibility-Framework/Reference/UIExt2/Interfaces/ICommands/SetIcon/","a22"),exact:!0,sidebar:"tutorialSidebar"},{path:"/Frameworks/User-Interface-Extensibility-Framework/Reference/UIExt2/Interfaces/ICommands/SetMenuItemState/",component:f("/Frameworks/User-Interface-Extensibility-Framework/Reference/UIExt2/Interfaces/ICommands/SetMenuItemState/","d86"),exact:!0,sidebar:"tutorialSidebar"},{path:"/Frameworks/User-Interface-Extensibility-Framework/Reference/UIExt2/Interfaces/ICommands/SetTaskbarGroupIcon/",component:f("/Frameworks/User-Interface-Extensibility-Framework/Reference/UIExt2/Interfaces/ICommands/SetTaskbarGroupIcon/","3d7"),exact:!0,sidebar:"tutorialSidebar"},{path:"/Frameworks/User-Interface-Extensibility-Framework/Reference/UIExt2/Interfaces/ICommonFunctions/",component:f("/Frameworks/User-Interface-Extensibility-Framework/Reference/UIExt2/Interfaces/ICommonFunctions/","fff"),exact:!0,sidebar:"tutorialSidebar"},{path:"/Frameworks/User-Interface-Extensibility-Framework/Reference/UIExt2/Interfaces/ICommonFunctions/DeleteFromWebStorage/",component:f("/Frameworks/User-Interface-Extensibility-Framework/Reference/UIExt2/Interfaces/ICommonFunctions/DeleteFromWebStorage/","252"),exact:!0,sidebar:"tutorialSidebar"},{path:"/Frameworks/User-Interface-Extensibility-Framework/Reference/UIExt2/Interfaces/ICommonFunctions/DownloadFileAsDataUri/",component:f("/Frameworks/User-Interface-Extensibility-Framework/Reference/UIExt2/Interfaces/ICommonFunctions/DownloadFileAsDataUri/","006"),exact:!0,sidebar:"tutorialSidebar"},{path:"/Frameworks/User-Interface-Extensibility-Framework/Reference/UIExt2/Interfaces/ICommonFunctions/GetAccentColor/",component:f("/Frameworks/User-Interface-Extensibility-Framework/Reference/UIExt2/Interfaces/ICommonFunctions/GetAccentColor/","56b"),exact:!0,sidebar:"tutorialSidebar"},{path:"/Frameworks/User-Interface-Extensibility-Framework/Reference/UIExt2/Interfaces/ICommonFunctions/GetClientLanguage/",component:f("/Frameworks/User-Interface-Extensibility-Framework/Reference/UIExt2/Interfaces/ICommonFunctions/GetClientLanguage/","d48"),exact:!0,sidebar:"tutorialSidebar"},{path:"/Frameworks/User-Interface-Extensibility-Framework/Reference/UIExt2/Interfaces/ICommonFunctions/GetClientLocale/",component:f("/Frameworks/User-Interface-Extensibility-Framework/Reference/UIExt2/Interfaces/ICommonFunctions/GetClientLocale/","a29"),exact:!0,sidebar:"tutorialSidebar"},{path:"/Frameworks/User-Interface-Extensibility-Framework/Reference/UIExt2/Interfaces/ICommonFunctions/GetClientLocaleIn3Letters/",component:f("/Frameworks/User-Interface-Extensibility-Framework/Reference/UIExt2/Interfaces/ICommonFunctions/GetClientLocaleIn3Letters/","47f"),exact:!0,sidebar:"tutorialSidebar"},{path:"/Frameworks/User-Interface-Extensibility-Framework/Reference/UIExt2/Interfaces/ICommonFunctions/GetSessionInfo/",component:f("/Frameworks/User-Interface-Extensibility-Framework/Reference/UIExt2/Interfaces/ICommonFunctions/GetSessionInfo/","a30"),exact:!0,sidebar:"tutorialSidebar"},{path:"/Frameworks/User-Interface-Extensibility-Framework/Reference/UIExt2/Interfaces/ICommonFunctions/GetUTCOffset/",component:f("/Frameworks/User-Interface-Extensibility-Framework/Reference/UIExt2/Interfaces/ICommonFunctions/GetUTCOffset/","d30"),exact:!0,sidebar:"tutorialSidebar"},{path:"/Frameworks/User-Interface-Extensibility-Framework/Reference/UIExt2/Interfaces/ICommonFunctions/GetVaultInfo/",component:f("/Frameworks/User-Interface-Extensibility-Framework/Reference/UIExt2/Interfaces/ICommonFunctions/GetVaultInfo/","e52"),exact:!0,sidebar:"tutorialSidebar"},{path:"/Frameworks/User-Interface-Extensibility-Framework/Reference/UIExt2/Interfaces/ICommonFunctions/GetWebLink/",component:f("/Frameworks/User-Interface-Extensibility-Framework/Reference/UIExt2/Interfaces/ICommonFunctions/GetWebLink/","3f2"),exact:!0,sidebar:"tutorialSidebar"},{path:"/Frameworks/User-Interface-Extensibility-Framework/Reference/UIExt2/Interfaces/ICommonFunctions/OpenExternalWebLink/",component:f("/Frameworks/User-Interface-Extensibility-Framework/Reference/UIExt2/Interfaces/ICommonFunctions/OpenExternalWebLink/","21c"),exact:!0,sidebar:"tutorialSidebar"},{path:"/Frameworks/User-Interface-Extensibility-Framework/Reference/UIExt2/Interfaces/ICommonFunctions/ReadFromWebStorage/",component:f("/Frameworks/User-Interface-Extensibility-Framework/Reference/UIExt2/Interfaces/ICommonFunctions/ReadFromWebStorage/","811"),exact:!0,sidebar:"tutorialSidebar"},{path:"/Frameworks/User-Interface-Extensibility-Framework/Reference/UIExt2/Interfaces/ICommonFunctions/ReportException/",component:f("/Frameworks/User-Interface-Extensibility-Framework/Reference/UIExt2/Interfaces/ICommonFunctions/ReportException/","5c0"),exact:!0,sidebar:"tutorialSidebar"},{path:"/Frameworks/User-Interface-Extensibility-Framework/Reference/UIExt2/Interfaces/ICommonFunctions/ShowEditObjectWindow/",component:f("/Frameworks/User-Interface-Extensibility-Framework/Reference/UIExt2/Interfaces/ICommonFunctions/ShowEditObjectWindow/","ddb"),exact:!0,sidebar:"tutorialSidebar"},{path:"/Frameworks/User-Interface-Extensibility-Framework/Reference/UIExt2/Interfaces/ICommonFunctions/ShowNewObjectWindow/",component:f("/Frameworks/User-Interface-Extensibility-Framework/Reference/UIExt2/Interfaces/ICommonFunctions/ShowNewObjectWindow/","769"),exact:!0,sidebar:"tutorialSidebar"},{path:"/Frameworks/User-Interface-Extensibility-Framework/Reference/UIExt2/Interfaces/ICommonFunctions/ShowToast/",component:f("/Frameworks/User-Interface-Extensibility-Framework/Reference/UIExt2/Interfaces/ICommonFunctions/ShowToast/","01d"),exact:!0,sidebar:"tutorialSidebar"},{path:"/Frameworks/User-Interface-Extensibility-Framework/Reference/UIExt2/Interfaces/ICommonFunctions/UploadTemporaryFiles/",component:f("/Frameworks/User-Interface-Extensibility-Framework/Reference/UIExt2/Interfaces/ICommonFunctions/UploadTemporaryFiles/","cd0"),exact:!0,sidebar:"tutorialSidebar"},{path:"/Frameworks/User-Interface-Extensibility-Framework/Reference/UIExt2/Interfaces/ICommonFunctions/WriteToWebStorage/",component:f("/Frameworks/User-Interface-Extensibility-Framework/Reference/UIExt2/Interfaces/ICommonFunctions/WriteToWebStorage/","c36"),exact:!0,sidebar:"tutorialSidebar"},{path:"/Frameworks/User-Interface-Extensibility-Framework/Reference/UIExt2/Interfaces/IDashboard/",component:f("/Frameworks/User-Interface-Extensibility-Framework/Reference/UIExt2/Interfaces/IDashboard/","0f6"),exact:!0,sidebar:"tutorialSidebar"},{path:"/Frameworks/User-Interface-Extensibility-Framework/Reference/UIExt2/Interfaces/IDashboard/GetSandboxAttributes/",component:f("/Frameworks/User-Interface-Extensibility-Framework/Reference/UIExt2/Interfaces/IDashboard/GetSandboxAttributes/","68f"),exact:!0,sidebar:"tutorialSidebar"},{path:"/Frameworks/User-Interface-Extensibility-Framework/Reference/UIExt2/Interfaces/IDashboard/ShowMessage/",component:f("/Frameworks/User-Interface-Extensibility-Framework/Reference/UIExt2/Interfaces/IDashboard/ShowMessage/","c18"),exact:!0,sidebar:"tutorialSidebar"},{path:"/Frameworks/User-Interface-Extensibility-Framework/Reference/UIExt2/Interfaces/IDashboard/ShowPopupDashboard/",component:f("/Frameworks/User-Interface-Extensibility-Framework/Reference/UIExt2/Interfaces/IDashboard/ShowPopupDashboard/","4cd"),exact:!0,sidebar:"tutorialSidebar"},{path:"/Frameworks/User-Interface-Extensibility-Framework/Reference/UIExt2/Interfaces/IDashboard/UpdateCustomData/",component:f("/Frameworks/User-Interface-Extensibility-Framework/Reference/UIExt2/Interfaces/IDashboard/UpdateCustomData/","e68"),exact:!0,sidebar:"tutorialSidebar"},{path:"/Frameworks/User-Interface-Extensibility-Framework/Reference/UIExt2/Interfaces/IDashboard/WaitForClose/",component:f("/Frameworks/User-Interface-Extensibility-Framework/Reference/UIExt2/Interfaces/IDashboard/WaitForClose/","191"),exact:!0,sidebar:"tutorialSidebar"},{path:"/Frameworks/User-Interface-Extensibility-Framework/Reference/UIExt2/Interfaces/IEvents/",component:f("/Frameworks/User-Interface-Extensibility-Framework/Reference/UIExt2/Interfaces/IEvents/","c9a"),exact:!0,sidebar:"tutorialSidebar"},{path:"/Frameworks/User-Interface-Extensibility-Framework/Reference/UIExt2/Interfaces/IEvents/Register/",component:f("/Frameworks/User-Interface-Extensibility-Framework/Reference/UIExt2/Interfaces/IEvents/Register/","d2f"),exact:!0,sidebar:"tutorialSidebar"},{path:"/Frameworks/User-Interface-Extensibility-Framework/Reference/UIExt2/Interfaces/IEvents/RegisterBuiltinCommand/",component:f("/Frameworks/User-Interface-Extensibility-Framework/Reference/UIExt2/Interfaces/IEvents/RegisterBuiltinCommand/","bb7"),exact:!0,sidebar:"tutorialSidebar"},{path:"/Frameworks/User-Interface-Extensibility-Framework/Reference/UIExt2/Interfaces/IEvents/Unregister/",component:f("/Frameworks/User-Interface-Extensibility-Framework/Reference/UIExt2/Interfaces/IEvents/Unregister/","698"),exact:!0,sidebar:"tutorialSidebar"},{path:"/Frameworks/User-Interface-Extensibility-Framework/Reference/UIExt2/Interfaces/ISearchPane/",component:f("/Frameworks/User-Interface-Extensibility-Framework/Reference/UIExt2/Interfaces/ISearchPane/","a1a"),exact:!0,sidebar:"tutorialSidebar"},{path:"/Frameworks/User-Interface-Extensibility-Framework/Reference/UIExt2/Interfaces/ISearchPane/GetOptions/",component:f("/Frameworks/User-Interface-Extensibility-Framework/Reference/UIExt2/Interfaces/ISearchPane/GetOptions/","e50"),exact:!0,sidebar:"tutorialSidebar"},{path:"/Frameworks/User-Interface-Extensibility-Framework/Reference/UIExt2/Interfaces/ISearchPane/GetSearchCriteria/",component:f("/Frameworks/User-Interface-Extensibility-Framework/Reference/UIExt2/Interfaces/ISearchPane/GetSearchCriteria/","0b7"),exact:!0,sidebar:"tutorialSidebar"},{path:"/Frameworks/User-Interface-Extensibility-Framework/Reference/UIExt2/Interfaces/ISearchPane/IsSearchView/",component:f("/Frameworks/User-Interface-Extensibility-Framework/Reference/UIExt2/Interfaces/ISearchPane/IsSearchView/","395"),exact:!0,sidebar:"tutorialSidebar"},{path:"/Frameworks/User-Interface-Extensibility-Framework/Reference/UIExt2/Interfaces/ISearchPane/SetOptionState/",component:f("/Frameworks/User-Interface-Extensibility-Framework/Reference/UIExt2/Interfaces/ISearchPane/SetOptionState/","2d6"),exact:!0,sidebar:"tutorialSidebar"},{path:"/Frameworks/User-Interface-Extensibility-Framework/Reference/UIExt2/Interfaces/ISearchPane/SetSearchCriteria/",component:f("/Frameworks/User-Interface-Extensibility-Framework/Reference/UIExt2/Interfaces/ISearchPane/SetSearchCriteria/","691"),exact:!0,sidebar:"tutorialSidebar"},{path:"/Frameworks/User-Interface-Extensibility-Framework/Reference/UIExt2/Interfaces/IShellFrame/",component:f("/Frameworks/User-Interface-Extensibility-Framework/Reference/UIExt2/Interfaces/IShellFrame/","71e"),exact:!0,sidebar:"tutorialSidebar"},{path:"/Frameworks/User-Interface-Extensibility-Framework/Reference/UIExt2/Interfaces/IShellFrame/CallSimplifiedAPI/",component:f("/Frameworks/User-Interface-Extensibility-Framework/Reference/UIExt2/Interfaces/IShellFrame/CallSimplifiedAPI/","715"),exact:!0,sidebar:"tutorialSidebar"},{path:"/Frameworks/User-Interface-Extensibility-Framework/Reference/UIExt2/Interfaces/IShellFrame/GetSandboxAttributes/",component:f("/Frameworks/User-Interface-Extensibility-Framework/Reference/UIExt2/Interfaces/IShellFrame/GetSandboxAttributes/","4dc"),exact:!0,sidebar:"tutorialSidebar"},{path:"/Frameworks/User-Interface-Extensibility-Framework/Reference/UIExt2/Interfaces/IShellFrame/GetViewsById/",component:f("/Frameworks/User-Interface-Extensibility-Framework/Reference/UIExt2/Interfaces/IShellFrame/GetViewsById/","8e9"),exact:!0,sidebar:"tutorialSidebar"},{path:"/Frameworks/User-Interface-Extensibility-Framework/Reference/UIExt2/Interfaces/IShellFrame/IsFolderLocation/",component:f("/Frameworks/User-Interface-Extensibility-Framework/Reference/UIExt2/Interfaces/IShellFrame/IsFolderLocation/","2db"),exact:!0,sidebar:"tutorialSidebar"},{path:"/Frameworks/User-Interface-Extensibility-Framework/Reference/UIExt2/Interfaces/IShellFrame/IsObjectLocation/",component:f("/Frameworks/User-Interface-Extensibility-Framework/Reference/UIExt2/Interfaces/IShellFrame/IsObjectLocation/","123"),exact:!0,sidebar:"tutorialSidebar"},{path:"/Frameworks/User-Interface-Extensibility-Framework/Reference/UIExt2/Interfaces/IShellFrame/NavigateToFolder/",component:f("/Frameworks/User-Interface-Extensibility-Framework/Reference/UIExt2/Interfaces/IShellFrame/NavigateToFolder/","e77"),exact:!0,sidebar:"tutorialSidebar"},{path:"/Frameworks/User-Interface-Extensibility-Framework/Reference/UIExt2/Interfaces/IShellFrame/NavigateToObject/",component:f("/Frameworks/User-Interface-Extensibility-Framework/Reference/UIExt2/Interfaces/IShellFrame/NavigateToObject/","190"),exact:!0,sidebar:"tutorialSidebar"},{path:"/Frameworks/User-Interface-Extensibility-Framework/Reference/UIExt2/Interfaces/IShellFrame/NavigateToParent/",component:f("/Frameworks/User-Interface-Extensibility-Framework/Reference/UIExt2/Interfaces/IShellFrame/NavigateToParent/","993"),exact:!0,sidebar:"tutorialSidebar"},{path:"/Frameworks/User-Interface-Extensibility-Framework/Reference/UIExt2/Interfaces/IShellFrame/ShowDashboard/",component:f("/Frameworks/User-Interface-Extensibility-Framework/Reference/UIExt2/Interfaces/IShellFrame/ShowDashboard/","97a"),exact:!0,sidebar:"tutorialSidebar"},{path:"/Frameworks/User-Interface-Extensibility-Framework/Reference/UIExt2/Interfaces/IShellFrame/ShowDefaultContent/",component:f("/Frameworks/User-Interface-Extensibility-Framework/Reference/UIExt2/Interfaces/IShellFrame/ShowDefaultContent/","a66"),exact:!0,sidebar:"tutorialSidebar"},{path:"/Frameworks/User-Interface-Extensibility-Framework/Reference/UIExt2/Interfaces/IShellFrame/ShowMessage/",component:f("/Frameworks/User-Interface-Extensibility-Framework/Reference/UIExt2/Interfaces/IShellFrame/ShowMessage/","3c0"),exact:!0,sidebar:"tutorialSidebar"},{path:"/Frameworks/User-Interface-Extensibility-Framework/Reference/UIExt2/Interfaces/IShellFrame/ShowPopupDashboard/",component:f("/Frameworks/User-Interface-Extensibility-Framework/Reference/UIExt2/Interfaces/IShellFrame/ShowPopupDashboard/","263"),exact:!0,sidebar:"tutorialSidebar"},{path:"/Frameworks/User-Interface-Extensibility-Framework/Reference/UIExt2/Interfaces/IShellFrame/ShowPopupDashboards/",component:f("/Frameworks/User-Interface-Extensibility-Framework/Reference/UIExt2/Interfaces/IShellFrame/ShowPopupDashboards/","d38"),exact:!0,sidebar:"tutorialSidebar"},{path:"/Frameworks/User-Interface-Extensibility-Framework/Reference/UIExt2/Interfaces/IShellItems/",component:f("/Frameworks/User-Interface-Extensibility-Framework/Reference/UIExt2/Interfaces/IShellItems/","b00"),exact:!0,sidebar:"tutorialSidebar"},{path:"/Frameworks/User-Interface-Extensibility-Framework/Reference/UIExt2/Interfaces/IShellItems/GetFoldersCount/",component:f("/Frameworks/User-Interface-Extensibility-Framework/Reference/UIExt2/Interfaces/IShellItems/GetFoldersCount/","799"),exact:!0,sidebar:"tutorialSidebar"},{path:"/Frameworks/User-Interface-Extensibility-Framework/Reference/UIExt2/Interfaces/IShellItems/GetObjectVersionsAndProperties/",component:f("/Frameworks/User-Interface-Extensibility-Framework/Reference/UIExt2/Interfaces/IShellItems/GetObjectVersionsAndProperties/","e16"),exact:!0,sidebar:"tutorialSidebar"},{path:"/Frameworks/User-Interface-Extensibility-Framework/Reference/UIExt2/Interfaces/IShellItems/GetObjectVersionsCount/",component:f("/Frameworks/User-Interface-Extensibility-Framework/Reference/UIExt2/Interfaces/IShellItems/GetObjectVersionsCount/","204"),exact:!0,sidebar:"tutorialSidebar"},{path:"/Frameworks/User-Interface-Extensibility-Framework/Reference/UIExt2/Interfaces/IShellListing/",component:f("/Frameworks/User-Interface-Extensibility-Framework/Reference/UIExt2/Interfaces/IShellListing/","d77"),exact:!0,sidebar:"tutorialSidebar"},{path:"/Frameworks/User-Interface-Extensibility-Framework/Reference/UIExt2/Interfaces/IShellListing/ActivateListing/",component:f("/Frameworks/User-Interface-Extensibility-Framework/Reference/UIExt2/Interfaces/IShellListing/ActivateListing/","78e"),exact:!0,sidebar:"tutorialSidebar"},{path:"/Frameworks/User-Interface-Extensibility-Framework/Reference/UIExt2/Interfaces/IShellListing/ActivateSelected/",component:f("/Frameworks/User-Interface-Extensibility-Framework/Reference/UIExt2/Interfaces/IShellListing/ActivateSelected/","861"),exact:!0,sidebar:"tutorialSidebar"},{path:"/Frameworks/User-Interface-Extensibility-Framework/Reference/UIExt2/Interfaces/IShellListing/AddListingItem/",component:f("/Frameworks/User-Interface-Extensibility-Framework/Reference/UIExt2/Interfaces/IShellListing/AddListingItem/","15c"),exact:!0,sidebar:"tutorialSidebar"},{path:"/Frameworks/User-Interface-Extensibility-Framework/Reference/UIExt2/Interfaces/IShellListing/AddObjectFile/",component:f("/Frameworks/User-Interface-Extensibility-Framework/Reference/UIExt2/Interfaces/IShellListing/AddObjectFile/","c49"),exact:!0,sidebar:"tutorialSidebar"},{path:"/Frameworks/User-Interface-Extensibility-Framework/Reference/UIExt2/Interfaces/IShellListing/GetFolderName/",component:f("/Frameworks/User-Interface-Extensibility-Framework/Reference/UIExt2/Interfaces/IShellListing/GetFolderName/","1f1"),exact:!0,sidebar:"tutorialSidebar"},{path:"/Frameworks/User-Interface-Extensibility-Framework/Reference/UIExt2/Interfaces/IShellListing/RefreshListing/",component:f("/Frameworks/User-Interface-Extensibility-Framework/Reference/UIExt2/Interfaces/IShellListing/RefreshListing/","76e"),exact:!0,sidebar:"tutorialSidebar"},{path:"/Frameworks/User-Interface-Extensibility-Framework/Reference/UIExt2/Interfaces/IShellListing/RefreshObject/",component:f("/Frameworks/User-Interface-Extensibility-Framework/Reference/UIExt2/Interfaces/IShellListing/RefreshObject/","d3e"),exact:!0,sidebar:"tutorialSidebar"},{path:"/Frameworks/User-Interface-Extensibility-Framework/Reference/UIExt2/Interfaces/IShellListing/RemoveListingItem/",component:f("/Frameworks/User-Interface-Extensibility-Framework/Reference/UIExt2/Interfaces/IShellListing/RemoveListingItem/","9b5"),exact:!0,sidebar:"tutorialSidebar"},{path:"/Frameworks/User-Interface-Extensibility-Framework/Reference/UIExt2/Interfaces/IShellListing/ReplaceFile/",component:f("/Frameworks/User-Interface-Extensibility-Framework/Reference/UIExt2/Interfaces/IShellListing/ReplaceFile/","f9d"),exact:!0,sidebar:"tutorialSidebar"},{path:"/Frameworks/User-Interface-Extensibility-Framework/Reference/UIExt2/Interfaces/IShellListing/SelectFolder/",component:f("/Frameworks/User-Interface-Extensibility-Framework/Reference/UIExt2/Interfaces/IShellListing/SelectFolder/","7a2"),exact:!0,sidebar:"tutorialSidebar"},{path:"/Frameworks/User-Interface-Extensibility-Framework/Reference/UIExt2/Interfaces/IShellListing/SelectNextFolder/",component:f("/Frameworks/User-Interface-Extensibility-Framework/Reference/UIExt2/Interfaces/IShellListing/SelectNextFolder/","0f0"),exact:!0,sidebar:"tutorialSidebar"},{path:"/Frameworks/User-Interface-Extensibility-Framework/Reference/UIExt2/Interfaces/IShellListing/SelectNextObject/",component:f("/Frameworks/User-Interface-Extensibility-Framework/Reference/UIExt2/Interfaces/IShellListing/SelectNextObject/","710"),exact:!0,sidebar:"tutorialSidebar"},{path:"/Frameworks/User-Interface-Extensibility-Framework/Reference/UIExt2/Interfaces/IShellListing/SelectNextObjectFile/",component:f("/Frameworks/User-Interface-Extensibility-Framework/Reference/UIExt2/Interfaces/IShellListing/SelectNextObjectFile/","374"),exact:!0,sidebar:"tutorialSidebar"},{path:"/Frameworks/User-Interface-Extensibility-Framework/Reference/UIExt2/Interfaces/IShellListing/SelectObjectFile/",component:f("/Frameworks/User-Interface-Extensibility-Framework/Reference/UIExt2/Interfaces/IShellListing/SelectObjectFile/","6a6"),exact:!0,sidebar:"tutorialSidebar"},{path:"/Frameworks/User-Interface-Extensibility-Framework/Reference/UIExt2/Interfaces/IShellListing/SelectObjectOrObjectFileVersion/",component:f("/Frameworks/User-Interface-Extensibility-Framework/Reference/UIExt2/Interfaces/IShellListing/SelectObjectOrObjectFileVersion/","ae8"),exact:!0,sidebar:"tutorialSidebar"},{path:"/Frameworks/User-Interface-Extensibility-Framework/Reference/UIExt2/Interfaces/IShellListing/SelectObjectVersion/",component:f("/Frameworks/User-Interface-Extensibility-Framework/Reference/UIExt2/Interfaces/IShellListing/SelectObjectVersion/","7bd"),exact:!0,sidebar:"tutorialSidebar"},{path:"/Frameworks/User-Interface-Extensibility-Framework/Reference/UIExt2/Interfaces/IShellListing/SelectPrevFolder/",component:f("/Frameworks/User-Interface-Extensibility-Framework/Reference/UIExt2/Interfaces/IShellListing/SelectPrevFolder/","5b2"),exact:!0,sidebar:"tutorialSidebar"},{path:"/Frameworks/User-Interface-Extensibility-Framework/Reference/UIExt2/Interfaces/IShellListing/SelectPrevObject/",component:f("/Frameworks/User-Interface-Extensibility-Framework/Reference/UIExt2/Interfaces/IShellListing/SelectPrevObject/","e90"),exact:!0,sidebar:"tutorialSidebar"},{path:"/Frameworks/User-Interface-Extensibility-Framework/Reference/UIExt2/Interfaces/IShellListing/SelectPrevObjectFile/",component:f("/Frameworks/User-Interface-Extensibility-Framework/Reference/UIExt2/Interfaces/IShellListing/SelectPrevObjectFile/","31c"),exact:!0,sidebar:"tutorialSidebar"},{path:"/Frameworks/User-Interface-Extensibility-Framework/Reference/UIExt2/Interfaces/IShellListing/SetFolderOrObjectVersionSelectionStates/",component:f("/Frameworks/User-Interface-Extensibility-Framework/Reference/UIExt2/Interfaces/IShellListing/SetFolderOrObjectVersionSelectionStates/","f5c"),exact:!0,sidebar:"tutorialSidebar"},{path:"/Frameworks/User-Interface-Extensibility-Framework/Reference/UIExt2/Interfaces/IShellListing/SetFolderSelectionStates/",component:f("/Frameworks/User-Interface-Extensibility-Framework/Reference/UIExt2/Interfaces/IShellListing/SetFolderSelectionStates/","9ad"),exact:!0,sidebar:"tutorialSidebar"},{path:"/Frameworks/User-Interface-Extensibility-Framework/Reference/UIExt2/Interfaces/IShellListing/SetObjectOrObjectFileVersionSelectionStates/",component:f("/Frameworks/User-Interface-Extensibility-Framework/Reference/UIExt2/Interfaces/IShellListing/SetObjectOrObjectFileVersionSelectionStates/","115"),exact:!0,sidebar:"tutorialSidebar"},{path:"/Frameworks/User-Interface-Extensibility-Framework/Reference/UIExt2/Interfaces/IShellListing/SetObjectVersionSelectionStates/",component:f("/Frameworks/User-Interface-Extensibility-Framework/Reference/UIExt2/Interfaces/IShellListing/SetObjectVersionSelectionStates/","534"),exact:!0,sidebar:"tutorialSidebar"},{path:"/Frameworks/User-Interface-Extensibility-Framework/Reference/UIExt2/Interfaces/IShellListing/SetVirtualSelection/",component:f("/Frameworks/User-Interface-Extensibility-Framework/Reference/UIExt2/Interfaces/IShellListing/SetVirtualSelection/","f5d"),exact:!0,sidebar:"tutorialSidebar"},{path:"/Frameworks/User-Interface-Extensibility-Framework/Reference/UIExt2/Interfaces/IShellListing/UnselectAll/",component:f("/Frameworks/User-Interface-Extensibility-Framework/Reference/UIExt2/Interfaces/IShellListing/UnselectAll/","8f5"),exact:!0,sidebar:"tutorialSidebar"},{path:"/Frameworks/User-Interface-Extensibility-Framework/Reference/UIExt2/Interfaces/IShellListing/UpdateListingItem/",component:f("/Frameworks/User-Interface-Extensibility-Framework/Reference/UIExt2/Interfaces/IShellListing/UpdateListingItem/","8f2"),exact:!0,sidebar:"tutorialSidebar"},{path:"/Frameworks/User-Interface-Extensibility-Framework/Reference/UIExt2/Interfaces/IShellPaneContainer/",component:f("/Frameworks/User-Interface-Extensibility-Framework/Reference/UIExt2/Interfaces/IShellPaneContainer/","608"),exact:!0,sidebar:"tutorialSidebar"},{path:"/Frameworks/User-Interface-Extensibility-Framework/Reference/UIExt2/Interfaces/IShellPaneContainer/AddTab/",component:f("/Frameworks/User-Interface-Extensibility-Framework/Reference/UIExt2/Interfaces/IShellPaneContainer/AddTab/","67e"),exact:!0,sidebar:"tutorialSidebar"},{path:"/Frameworks/User-Interface-Extensibility-Framework/Reference/UIExt2/Interfaces/IShellPaneContainer/GetSelectedTabs/",component:f("/Frameworks/User-Interface-Extensibility-Framework/Reference/UIExt2/Interfaces/IShellPaneContainer/GetSelectedTabs/","939"),exact:!0,sidebar:"tutorialSidebar"},{path:"/Frameworks/User-Interface-Extensibility-Framework/Reference/UIExt2/Interfaces/IShellPaneContainer/GetTab/",component:f("/Frameworks/User-Interface-Extensibility-Framework/Reference/UIExt2/Interfaces/IShellPaneContainer/GetTab/","58d"),exact:!0,sidebar:"tutorialSidebar"},{path:"/Frameworks/User-Interface-Extensibility-Framework/Reference/UIExt2/Interfaces/IShellPaneTab/",component:f("/Frameworks/User-Interface-Extensibility-Framework/Reference/UIExt2/Interfaces/IShellPaneTab/","235"),exact:!0,sidebar:"tutorialSidebar"},{path:"/Frameworks/User-Interface-Extensibility-Framework/Reference/UIExt2/Interfaces/IShellPaneTab/Remove/",component:f("/Frameworks/User-Interface-Extensibility-Framework/Reference/UIExt2/Interfaces/IShellPaneTab/Remove/","b7f"),exact:!0,sidebar:"tutorialSidebar"},{path:"/Frameworks/User-Interface-Extensibility-Framework/Reference/UIExt2/Interfaces/IShellPaneTab/Select/",component:f("/Frameworks/User-Interface-Extensibility-Framework/Reference/UIExt2/Interfaces/IShellPaneTab/Select/","e4b"),exact:!0,sidebar:"tutorialSidebar"},{path:"/Frameworks/User-Interface-Extensibility-Framework/Reference/UIExt2/Interfaces/IShellPaneTab/SetVisible/",component:f("/Frameworks/User-Interface-Extensibility-Framework/Reference/UIExt2/Interfaces/IShellPaneTab/SetVisible/","e46"),exact:!0,sidebar:"tutorialSidebar"},{path:"/Frameworks/User-Interface-Extensibility-Framework/Reference/UIExt2/Interfaces/IShellPaneTab/ShowDashboard/",component:f("/Frameworks/User-Interface-Extensibility-Framework/Reference/UIExt2/Interfaces/IShellPaneTab/ShowDashboard/","643"),exact:!0,sidebar:"tutorialSidebar"},{path:"/Frameworks/User-Interface-Extensibility-Framework/Reference/UIExt2/Interfaces/IShellPaneTab/ShowEmptyContent/",component:f("/Frameworks/User-Interface-Extensibility-Framework/Reference/UIExt2/Interfaces/IShellPaneTab/ShowEmptyContent/","185"),exact:!0,sidebar:"tutorialSidebar"},{path:"/Frameworks/User-Interface-Extensibility-Framework/Reference/UIExt2/Interfaces/IShellPaneTab/Unselect/",component:f("/Frameworks/User-Interface-Extensibility-Framework/Reference/UIExt2/Interfaces/IShellPaneTab/Unselect/","46a"),exact:!0,sidebar:"tutorialSidebar"},{path:"/Frameworks/User-Interface-Extensibility-Framework/Reference/UIExt2/Interfaces/IShellUI/",component:f("/Frameworks/User-Interface-Extensibility-Framework/Reference/UIExt2/Interfaces/IShellUI/","cf7"),exact:!0,sidebar:"tutorialSidebar"},{path:"/Frameworks/User-Interface-Extensibility-Framework/Reference/UIExt2/Interfaces/IShellUI/BroadcastMessage/",component:f("/Frameworks/User-Interface-Extensibility-Framework/Reference/UIExt2/Interfaces/IShellUI/BroadcastMessage/","ea5"),exact:!0,sidebar:"tutorialSidebar"},{path:"/Frameworks/User-Interface-Extensibility-Framework/Reference/UIExt2/Interfaces/IShellUI/GetFileTypeIconURL/",component:f("/Frameworks/User-Interface-Extensibility-Framework/Reference/UIExt2/Interfaces/IShellUI/GetFileTypeIconURL/","25d"),exact:!0,sidebar:"tutorialSidebar"},{path:"/Frameworks/User-Interface-Extensibility-Framework/Reference/UIExt2/Interfaces/IShellUI/GetObjectTypeIconURL/",component:f("/Frameworks/User-Interface-Extensibility-Framework/Reference/UIExt2/Interfaces/IShellUI/GetObjectTypeIconURL/","f34"),exact:!0,sidebar:"tutorialSidebar"},{path:"/Frameworks/User-Interface-Extensibility-Framework/Reference/UIExt2/Interfaces/IShellUI/GetValueListItemIconURL/",component:f("/Frameworks/User-Interface-Extensibility-Framework/Reference/UIExt2/Interfaces/IShellUI/GetValueListItemIconURL/","3f5"),exact:!0,sidebar:"tutorialSidebar"},{path:"/Frameworks/User-Interface-Extensibility-Framework/Reference/UIExt2/Interfaces/IShellUI/NotifyApplication/",component:f("/Frameworks/User-Interface-Extensibility-Framework/Reference/UIExt2/Interfaces/IShellUI/NotifyApplication/","322"),exact:!0,sidebar:"tutorialSidebar"},{path:"/Frameworks/User-Interface-Extensibility-Framework/Reference/UIExt2/Interfaces/IShellUI/ShowMessage/",component:f("/Frameworks/User-Interface-Extensibility-Framework/Reference/UIExt2/Interfaces/IShellUI/ShowMessage/","b67"),exact:!0,sidebar:"tutorialSidebar"},{path:"/Frameworks/User-Interface-Extensibility-Framework/Reference/UIExt2/Interfaces/IShellUI/ShowPopupDashboard/",component:f("/Frameworks/User-Interface-Extensibility-Framework/Reference/UIExt2/Interfaces/IShellUI/ShowPopupDashboard/","f68"),exact:!0,sidebar:"tutorialSidebar"},{path:"/Frameworks/User-Interface-Extensibility-Framework/Reference/UIExt2/Interfaces/IWindow/",component:f("/Frameworks/User-Interface-Extensibility-Framework/Reference/UIExt2/Interfaces/IWindow/","2a7"),exact:!0,sidebar:"tutorialSidebar"},{path:"/Frameworks/User-Interface-Extensibility-Framework/Reference/UIExt2/Interfaces/IWindow/Close/",component:f("/Frameworks/User-Interface-Extensibility-Framework/Reference/UIExt2/Interfaces/IWindow/Close/","2f7"),exact:!0,sidebar:"tutorialSidebar"},{path:"/Frameworks/User-Interface-Extensibility-Framework/Reference/UIExt2/Interfaces/IWindow/ResizeToDefaultSize/",component:f("/Frameworks/User-Interface-Extensibility-Framework/Reference/UIExt2/Interfaces/IWindow/ResizeToDefaultSize/","226"),exact:!0,sidebar:"tutorialSidebar"},{path:"/Frameworks/User-Interface-Extensibility-Framework/Reference/UIExt2/Interfaces/IWindow/SetCloseIconVisibility/",component:f("/Frameworks/User-Interface-Extensibility-Framework/Reference/UIExt2/Interfaces/IWindow/SetCloseIconVisibility/","cb4"),exact:!0,sidebar:"tutorialSidebar"},{path:"/Frameworks/User-Interface-Extensibility-Framework/Reference/UIExt2/Interfaces/IWindow/SetDefaultSize/",component:f("/Frameworks/User-Interface-Extensibility-Framework/Reference/UIExt2/Interfaces/IWindow/SetDefaultSize/","e19"),exact:!0,sidebar:"tutorialSidebar"},{path:"/Frameworks/User-Interface-Extensibility-Framework/Reference/UIExt2/Interfaces/IWindow/SetSize/",component:f("/Frameworks/User-Interface-Extensibility-Framework/Reference/UIExt2/Interfaces/IWindow/SetSize/","c75"),exact:!0,sidebar:"tutorialSidebar"},{path:"/Frameworks/User-Interface-Extensibility-Framework/Reference/UIExt2/Interfaces/IWindow/SetTitle/",component:f("/Frameworks/User-Interface-Extensibility-Framework/Reference/UIExt2/Interfaces/IWindow/SetTitle/","14b"),exact:!0,sidebar:"tutorialSidebar"},{path:"/Frameworks/User-Interface-Extensibility-Framework/Reference/UIExt2/Interfaces/TListingActionArgs/",component:f("/Frameworks/User-Interface-Extensibility-Framework/Reference/UIExt2/Interfaces/TListingActionArgs/","547"),exact:!0,sidebar:"tutorialSidebar"},{path:"/Frameworks/User-Interface-Extensibility-Framework/Reference/UIExt2/Models/",component:f("/Frameworks/User-Interface-Extensibility-Framework/Reference/UIExt2/Models/","028"),exact:!0,sidebar:"tutorialSidebar"},{path:"/Frameworks/User-Interface-Extensibility-Framework/Reference/UIExt2/Models/DashboardConfig/",component:f("/Frameworks/User-Interface-Extensibility-Framework/Reference/UIExt2/Models/DashboardConfig/","b33"),exact:!0,sidebar:"tutorialSidebar"},{path:"/Frameworks/User-Interface-Extensibility-Framework/Reference/UIExt2/Models/DialogUIParams/",component:f("/Frameworks/User-Interface-Extensibility-Framework/Reference/UIExt2/Models/DialogUIParams/","9b9"),exact:!0,sidebar:"tutorialSidebar"},{path:"/Frameworks/User-Interface-Extensibility-Framework/Reference/UIExt2/Models/Facet/",component:f("/Frameworks/User-Interface-Extensibility-Framework/Reference/UIExt2/Models/Facet/","539"),exact:!0,sidebar:"tutorialSidebar"},{path:"/Frameworks/User-Interface-Extensibility-Framework/Reference/UIExt2/Models/FacetDefinition/",component:f("/Frameworks/User-Interface-Extensibility-Framework/Reference/UIExt2/Models/FacetDefinition/","517"),exact:!0,sidebar:"tutorialSidebar"},{path:"/Frameworks/User-Interface-Extensibility-Framework/Reference/UIExt2/Models/FacetLookupValue/",component:f("/Frameworks/User-Interface-Extensibility-Framework/Reference/UIExt2/Models/FacetLookupValue/","eb6"),exact:!0,sidebar:"tutorialSidebar"},{path:"/Frameworks/User-Interface-Extensibility-Framework/Reference/UIExt2/Models/FacetNumericRangeValue/",component:f("/Frameworks/User-Interface-Extensibility-Framework/Reference/UIExt2/Models/FacetNumericRangeValue/","2a0"),exact:!0,sidebar:"tutorialSidebar"},{path:"/Frameworks/User-Interface-Extensibility-Framework/Reference/UIExt2/Models/FacetNumericValue/",component:f("/Frameworks/User-Interface-Extensibility-Framework/Reference/UIExt2/Models/FacetNumericValue/","6d3"),exact:!0,sidebar:"tutorialSidebar"},{path:"/Frameworks/User-Interface-Extensibility-Framework/Reference/UIExt2/Models/FacetStringValue/",component:f("/Frameworks/User-Interface-Extensibility-Framework/Reference/UIExt2/Models/FacetStringValue/","a9d"),exact:!0,sidebar:"tutorialSidebar"},{path:"/Frameworks/User-Interface-Extensibility-Framework/Reference/UIExt2/Models/FacetValue/",component:f("/Frameworks/User-Interface-Extensibility-Framework/Reference/UIExt2/Models/FacetValue/","29a"),exact:!0,sidebar:"tutorialSidebar"},{path:"/Frameworks/User-Interface-Extensibility-Framework/Reference/UIExt2/Models/FtsScope/",component:f("/Frameworks/User-Interface-Extensibility-Framework/Reference/UIExt2/Models/FtsScope/","73c"),exact:!0,sidebar:"tutorialSidebar"},{path:"/Frameworks/User-Interface-Extensibility-Framework/Reference/UIExt2/Models/IIconInformation/",component:f("/Frameworks/User-Interface-Extensibility-Framework/Reference/UIExt2/Models/IIconInformation/","054"),exact:!0,sidebar:"tutorialSidebar"},{path:"/Frameworks/User-Interface-Extensibility-Framework/Reference/UIExt2/Models/INonSensitiveVaultData/",component:f("/Frameworks/User-Interface-Extensibility-Framework/Reference/UIExt2/Models/INonSensitiveVaultData/","fbd"),exact:!0,sidebar:"tutorialSidebar"},{path:"/Frameworks/User-Interface-Extensibility-Framework/Reference/UIExt2/Models/ISelectedFile/",component:f("/Frameworks/User-Interface-Extensibility-Framework/Reference/UIExt2/Models/ISelectedFile/","822"),exact:!0,sidebar:"tutorialSidebar"},{path:"/Frameworks/User-Interface-Extensibility-Framework/Reference/UIExt2/Models/IVaultInfo/",component:f("/Frameworks/User-Interface-Extensibility-Framework/Reference/UIExt2/Models/IVaultInfo/","e0f"),exact:!0,sidebar:"tutorialSidebar"},{path:"/Frameworks/User-Interface-Extensibility-Framework/Reference/UIExt2/Models/IVaultInfoReturnValue/",component:f("/Frameworks/User-Interface-Extensibility-Framework/Reference/UIExt2/Models/IVaultInfoReturnValue/","51c"),exact:!0,sidebar:"tutorialSidebar"},{path:"/Frameworks/User-Interface-Extensibility-Framework/Reference/UIExt2/Models/LookupValue/",component:f("/Frameworks/User-Interface-Extensibility-Framework/Reference/UIExt2/Models/LookupValue/","36b"),exact:!0,sidebar:"tutorialSidebar"},{path:"/Frameworks/User-Interface-Extensibility-Framework/Reference/UIExt2/Models/MFError/",component:f("/Frameworks/User-Interface-Extensibility-Framework/Reference/UIExt2/Models/MFError/","dcb"),exact:!0,sidebar:"tutorialSidebar"},{path:"/Frameworks/User-Interface-Extensibility-Framework/Reference/UIExt2/Models/MultiDashboardUIParams/",component:f("/Frameworks/User-Interface-Extensibility-Framework/Reference/UIExt2/Models/MultiDashboardUIParams/","208"),exact:!0,sidebar:"tutorialSidebar"},{path:"/Frameworks/User-Interface-Extensibility-Framework/Reference/UIExt2/Models/NonSensitiveSessionData/",component:f("/Frameworks/User-Interface-Extensibility-Framework/Reference/UIExt2/Models/NonSensitiveSessionData/","f34"),exact:!0,sidebar:"tutorialSidebar"},{path:"/Frameworks/User-Interface-Extensibility-Framework/Reference/UIExt2/Models/NumericRangeValue/",component:f("/Frameworks/User-Interface-Extensibility-Framework/Reference/UIExt2/Models/NumericRangeValue/","917"),exact:!0,sidebar:"tutorialSidebar"},{path:"/Frameworks/User-Interface-Extensibility-Framework/Reference/UIExt2/Models/NumericValue/",component:f("/Frameworks/User-Interface-Extensibility-Framework/Reference/UIExt2/Models/NumericValue/","463"),exact:!0,sidebar:"tutorialSidebar"},{path:"/Frameworks/User-Interface-Extensibility-Framework/Reference/UIExt2/Models/ObjectCreationInfo/",component:f("/Frameworks/User-Interface-Extensibility-Framework/Reference/UIExt2/Models/ObjectCreationInfo/","8b3"),exact:!0,sidebar:"tutorialSidebar"},{path:"/Frameworks/User-Interface-Extensibility-Framework/Reference/UIExt2/Models/ObjectFile/",component:f("/Frameworks/User-Interface-Extensibility-Framework/Reference/UIExt2/Models/ObjectFile/","3bc"),exact:!0,sidebar:"tutorialSidebar"},{path:"/Frameworks/User-Interface-Extensibility-Framework/Reference/UIExt2/Models/ObjectFileVersionArgumentValue/",component:f("/Frameworks/User-Interface-Extensibility-Framework/Reference/UIExt2/Models/ObjectFileVersionArgumentValue/","f49"),exact:!0,sidebar:"tutorialSidebar"},{path:"/Frameworks/User-Interface-Extensibility-Framework/Reference/UIExt2/Models/ObjectFileVersionParams/",component:f("/Frameworks/User-Interface-Extensibility-Framework/Reference/UIExt2/Models/ObjectFileVersionParams/","5b0"),exact:!0,sidebar:"tutorialSidebar"},{path:"/Frameworks/User-Interface-Extensibility-Framework/Reference/UIExt2/Models/ObjectWindowResult/",component:f("/Frameworks/User-Interface-Extensibility-Framework/Reference/UIExt2/Models/ObjectWindowResult/","c87"),exact:!0,sidebar:"tutorialSidebar"},{path:"/Frameworks/User-Interface-Extensibility-Framework/Reference/UIExt2/Models/SearchCriteria/",component:f("/Frameworks/User-Interface-Extensibility-Framework/Reference/UIExt2/Models/SearchCriteria/","833"),exact:!0,sidebar:"tutorialSidebar"},{path:"/Frameworks/User-Interface-Extensibility-Framework/Reference/UIExt2/Models/ShellFrameFolders/",component:f("/Frameworks/User-Interface-Extensibility-Framework/Reference/UIExt2/Models/ShellFrameFolders/","360"),exact:!0,sidebar:"tutorialSidebar"},{path:"/Frameworks/User-Interface-Extensibility-Framework/Reference/UIExt2/Models/ShowMessageArgumentValue/",component:f("/Frameworks/User-Interface-Extensibility-Framework/Reference/UIExt2/Models/ShowMessageArgumentValue/","33c"),exact:!0,sidebar:"tutorialSidebar"},{path:"/Frameworks/User-Interface-Extensibility-Framework/Reference/UIExt2/Models/ShowMessageParams/",component:f("/Frameworks/User-Interface-Extensibility-Framework/Reference/UIExt2/Models/ShowMessageParams/","f41"),exact:!0,sidebar:"tutorialSidebar"},{path:"/Frameworks/User-Interface-Extensibility-Framework/Reference/UIExt2/Models/ShowMessageReturnValue/",component:f("/Frameworks/User-Interface-Extensibility-Framework/Reference/UIExt2/Models/ShowMessageReturnValue/","f6d"),exact:!0,sidebar:"tutorialSidebar"},{path:"/Frameworks/User-Interface-Extensibility-Framework/Reference/UIExt2/Models/StringValue/",component:f("/Frameworks/User-Interface-Extensibility-Framework/Reference/UIExt2/Models/StringValue/","1c7"),exact:!0,sidebar:"tutorialSidebar"},{path:"/Frameworks/User-Interface-Extensibility-Framework/Reference/UIExt2/Models/VaultInfoReturnValue/",component:f("/Frameworks/User-Interface-Extensibility-Framework/Reference/UIExt2/Models/VaultInfoReturnValue/","c58"),exact:!0,sidebar:"tutorialSidebar"},{path:"/Frameworks/User-Interface-Extensibility-Framework/Reference/Upgrading/",component:f("/Frameworks/User-Interface-Extensibility-Framework/Reference/Upgrading/","686"),exact:!0,sidebar:"tutorialSidebar"},{path:"/Frameworks/User-Interface-Extensibility-Framework/Reference/Upgrading/deprecated_features/",component:f("/Frameworks/User-Interface-Extensibility-Framework/Reference/Upgrading/deprecated_features/","f5f"),exact:!0,sidebar:"tutorialSidebar"}]},{path:"*",component:f("*")}]},55351:(e,t,r)=>{var n,a;!function(){var i,o,s,c,l,u,d,f,m,p,b,g,h,w,I,x,y,k,E,F,R,S,v,U,C,P,O,_,M,T,j=function(e){var t=new j.Builder;return t.pipeline.add(j.trimmer,j.stopWordFilter,j.stemmer),t.searchPipeline.add(j.stemmer),e.call(t,t),t.build()};j.version="2.3.9",j.utils={},j.utils.warn=(i=this,function(e){i.console&&console.warn&&console.warn(e)}),j.utils.asString=function(e){return null==e?"":e.toString()},j.utils.clone=function(e){if(null==e)return e;for(var t=Object.create(null),r=Object.keys(e),n=0;n0){var c=j.utils.clone(t)||{};c.position=[o,s],c.index=a.length,a.push(new j.Token(r.slice(o,i),c))}o=i+1}}return a},j.tokenizer.separator=/[\s\-]+/,j.Pipeline=function(){this._stack=[]},j.Pipeline.registeredFunctions=Object.create(null),j.Pipeline.registerFunction=function(e,t){t in this.registeredFunctions&&j.utils.warn("Overwriting existing registered function: "+t),e.label=t,j.Pipeline.registeredFunctions[e.label]=e},j.Pipeline.warnIfFunctionNotRegistered=function(e){e.label&&e.label in this.registeredFunctions||j.utils.warn("Function is not registered with pipeline. This may cause problems when serialising the index.\n",e)},j.Pipeline.load=function(e){var t=new j.Pipeline;return e.forEach((function(e){var r=j.Pipeline.registeredFunctions[e];if(!r)throw new Error("Cannot load unregistered function: "+e);t.add(r)})),t},j.Pipeline.prototype.add=function(){Array.prototype.slice.call(arguments).forEach((function(e){j.Pipeline.warnIfFunctionNotRegistered(e),this._stack.push(e)}),this)},j.Pipeline.prototype.after=function(e,t){j.Pipeline.warnIfFunctionNotRegistered(t);var r=this._stack.indexOf(e);if(-1==r)throw new Error("Cannot find existingFn");r+=1,this._stack.splice(r,0,t)},j.Pipeline.prototype.before=function(e,t){j.Pipeline.warnIfFunctionNotRegistered(t);var r=this._stack.indexOf(e);if(-1==r)throw new Error("Cannot find existingFn");this._stack.splice(r,0,t)},j.Pipeline.prototype.remove=function(e){var t=this._stack.indexOf(e);-1!=t&&this._stack.splice(t,1)},j.Pipeline.prototype.run=function(e){for(var t=this._stack.length,r=0;r1&&(ie&&(r=a),i!=e);)n=r-t,a=t+Math.floor(n/2),i=this.elements[2*a];return i==e||i>e?2*a:is?l+=2:o==s&&(t+=r[c+1]*n[l+1],c+=2,l+=2);return t},j.Vector.prototype.similarity=function(e){return this.dot(e)/this.magnitude()||0},j.Vector.prototype.toArray=function(){for(var e=new Array(this.elements.length/2),t=1,r=0;t0){var i,o=a.str.charAt(0);o in a.node.edges?i=a.node.edges[o]:(i=new j.TokenSet,a.node.edges[o]=i),1==a.str.length&&(i.final=!0),n.push({node:i,editsRemaining:a.editsRemaining,str:a.str.slice(1)})}if(0!=a.editsRemaining){if("*"in a.node.edges)var s=a.node.edges["*"];else{s=new j.TokenSet;a.node.edges["*"]=s}if(0==a.str.length&&(s.final=!0),n.push({node:s,editsRemaining:a.editsRemaining-1,str:a.str}),a.str.length>1&&n.push({node:a.node,editsRemaining:a.editsRemaining-1,str:a.str.slice(1)}),1==a.str.length&&(a.node.final=!0),a.str.length>=1){if("*"in a.node.edges)var c=a.node.edges["*"];else{c=new j.TokenSet;a.node.edges["*"]=c}1==a.str.length&&(c.final=!0),n.push({node:c,editsRemaining:a.editsRemaining-1,str:a.str.slice(1)})}if(a.str.length>1){var l,u=a.str.charAt(0),d=a.str.charAt(1);d in a.node.edges?l=a.node.edges[d]:(l=new j.TokenSet,a.node.edges[d]=l),1==a.str.length&&(l.final=!0),n.push({node:l,editsRemaining:a.editsRemaining-1,str:u+a.str.slice(2)})}}}return r},j.TokenSet.fromString=function(e){for(var t=new j.TokenSet,r=t,n=0,a=e.length;n=e;t--){var r=this.uncheckedNodes[t],n=r.child.toString();n in this.minimizedNodes?r.parent.edges[r.char]=this.minimizedNodes[n]:(r.child._str=n,this.minimizedNodes[n]=r.child),this.uncheckedNodes.pop()}},j.Index=function(e){this.invertedIndex=e.invertedIndex,this.fieldVectors=e.fieldVectors,this.tokenSet=e.tokenSet,this.fields=e.fields,this.pipeline=e.pipeline},j.Index.prototype.search=function(e){return this.query((function(t){new j.QueryParser(e,t).parse()}))},j.Index.prototype.query=function(e){for(var t=new j.Query(this.fields),r=Object.create(null),n=Object.create(null),a=Object.create(null),i=Object.create(null),o=Object.create(null),s=0;s1?1:e},j.Builder.prototype.k1=function(e){this._k1=e},j.Builder.prototype.add=function(e,t){var r=e[this._ref],n=Object.keys(this._fields);this._documents[r]=t||{},this.documentCount+=1;for(var a=0;a=this.length)return j.QueryLexer.EOS;var e=this.str.charAt(this.pos);return this.pos+=1,e},j.QueryLexer.prototype.width=function(){return this.pos-this.start},j.QueryLexer.prototype.ignore=function(){this.start==this.pos&&(this.pos+=1),this.start=this.pos},j.QueryLexer.prototype.backup=function(){this.pos-=1},j.QueryLexer.prototype.acceptDigitRun=function(){var e,t;do{t=(e=this.next()).charCodeAt(0)}while(t>47&&t<58);e!=j.QueryLexer.EOS&&this.backup()},j.QueryLexer.prototype.more=function(){return this.pos1&&(e.backup(),e.emit(j.QueryLexer.TERM)),e.ignore(),e.more())return j.QueryLexer.lexText},j.QueryLexer.lexEditDistance=function(e){return e.ignore(),e.acceptDigitRun(),e.emit(j.QueryLexer.EDIT_DISTANCE),j.QueryLexer.lexText},j.QueryLexer.lexBoost=function(e){return e.ignore(),e.acceptDigitRun(),e.emit(j.QueryLexer.BOOST),j.QueryLexer.lexText},j.QueryLexer.lexEOS=function(e){e.width()>0&&e.emit(j.QueryLexer.TERM)},j.QueryLexer.termSeparator=j.tokenizer.separator,j.QueryLexer.lexText=function(e){for(;;){var t=e.next();if(t==j.QueryLexer.EOS)return j.QueryLexer.lexEOS;if(92!=t.charCodeAt(0)){if(":"==t)return j.QueryLexer.lexField;if("~"==t)return e.backup(),e.width()>0&&e.emit(j.QueryLexer.TERM),j.QueryLexer.lexEditDistance;if("^"==t)return e.backup(),e.width()>0&&e.emit(j.QueryLexer.TERM),j.QueryLexer.lexBoost;if("+"==t&&1===e.width())return e.emit(j.QueryLexer.PRESENCE),j.QueryLexer.lexText;if("-"==t&&1===e.width())return e.emit(j.QueryLexer.PRESENCE),j.QueryLexer.lexText;if(t.match(j.QueryLexer.termSeparator))return j.QueryLexer.lexTerm}else e.escapeCharacter()}},j.QueryParser=function(e,t){this.lexer=new j.QueryLexer(e),this.query=t,this.currentClause={},this.lexemeIdx=0},j.QueryParser.prototype.parse=function(){this.lexer.run(),this.lexemes=this.lexer.lexemes;for(var e=j.QueryParser.parseClause;e;)e=e(this);return this.query},j.QueryParser.prototype.peekLexeme=function(){return this.lexemes[this.lexemeIdx]},j.QueryParser.prototype.consumeLexeme=function(){var e=this.peekLexeme();return this.lexemeIdx+=1,e},j.QueryParser.prototype.nextClause=function(){var e=this.currentClause;this.query.clause(e),this.currentClause={}},j.QueryParser.parseClause=function(e){var t=e.peekLexeme();if(null!=t)switch(t.type){case j.QueryLexer.PRESENCE:return j.QueryParser.parsePresence;case j.QueryLexer.FIELD:return j.QueryParser.parseField;case j.QueryLexer.TERM:return j.QueryParser.parseTerm;default:var r="expected either a field or a term, found "+t.type;throw t.str.length>=1&&(r+=" with value '"+t.str+"'"),new j.QueryParseError(r,t.start,t.end)}},j.QueryParser.parsePresence=function(e){var t=e.consumeLexeme();if(null!=t){switch(t.str){case"-":e.currentClause.presence=j.Query.presence.PROHIBITED;break;case"+":e.currentClause.presence=j.Query.presence.REQUIRED;break;default:var r="unrecognised presence operator'"+t.str+"'";throw new j.QueryParseError(r,t.start,t.end)}var n=e.peekLexeme();if(null==n){r="expecting term or field, found nothing";throw new j.QueryParseError(r,t.start,t.end)}switch(n.type){case j.QueryLexer.FIELD:return j.QueryParser.parseField;case j.QueryLexer.TERM:return j.QueryParser.parseTerm;default:r="expecting term or field, found '"+n.type+"'";throw new j.QueryParseError(r,n.start,n.end)}}},j.QueryParser.parseField=function(e){var t=e.consumeLexeme();if(null!=t){if(-1==e.query.allFields.indexOf(t.str)){var r=e.query.allFields.map((function(e){return"'"+e+"'"})).join(", "),n="unrecognised field '"+t.str+"', possible fields: "+r;throw new j.QueryParseError(n,t.start,t.end)}e.currentClause.fields=[t.str];var a=e.peekLexeme();if(null==a){n="expecting term, found nothing";throw new j.QueryParseError(n,t.start,t.end)}if(a.type===j.QueryLexer.TERM)return j.QueryParser.parseTerm;n="expecting term, found '"+a.type+"'";throw new j.QueryParseError(n,a.start,a.end)}},j.QueryParser.parseTerm=function(e){var t=e.consumeLexeme();if(null!=t){e.currentClause.term=t.str.toLowerCase(),-1!=t.str.indexOf("*")&&(e.currentClause.usePipeline=!1);var r=e.peekLexeme();if(null!=r)switch(r.type){case j.QueryLexer.TERM:return e.nextClause(),j.QueryParser.parseTerm;case j.QueryLexer.FIELD:return e.nextClause(),j.QueryParser.parseField;case j.QueryLexer.EDIT_DISTANCE:return j.QueryParser.parseEditDistance;case j.QueryLexer.BOOST:return j.QueryParser.parseBoost;case j.QueryLexer.PRESENCE:return e.nextClause(),j.QueryParser.parsePresence;default:var n="Unexpected lexeme type '"+r.type+"'";throw new j.QueryParseError(n,r.start,r.end)}else e.nextClause()}},j.QueryParser.parseEditDistance=function(e){var t=e.consumeLexeme();if(null!=t){var r=parseInt(t.str,10);if(isNaN(r)){var n="edit distance must be numeric";throw new j.QueryParseError(n,t.start,t.end)}e.currentClause.editDistance=r;var a=e.peekLexeme();if(null!=a)switch(a.type){case j.QueryLexer.TERM:return e.nextClause(),j.QueryParser.parseTerm;case j.QueryLexer.FIELD:return e.nextClause(),j.QueryParser.parseField;case j.QueryLexer.EDIT_DISTANCE:return j.QueryParser.parseEditDistance;case j.QueryLexer.BOOST:return j.QueryParser.parseBoost;case j.QueryLexer.PRESENCE:return e.nextClause(),j.QueryParser.parsePresence;default:n="Unexpected lexeme type '"+a.type+"'";throw new j.QueryParseError(n,a.start,a.end)}else e.nextClause()}},j.QueryParser.parseBoost=function(e){var t=e.consumeLexeme();if(null!=t){var r=parseInt(t.str,10);if(isNaN(r)){var n="boost must be numeric";throw new j.QueryParseError(n,t.start,t.end)}e.currentClause.boost=r;var a=e.peekLexeme();if(null!=a)switch(a.type){case j.QueryLexer.TERM:return e.nextClause(),j.QueryParser.parseTerm;case j.QueryLexer.FIELD:return e.nextClause(),j.QueryParser.parseField;case j.QueryLexer.EDIT_DISTANCE:return j.QueryParser.parseEditDistance;case j.QueryLexer.BOOST:return j.QueryParser.parseBoost;case j.QueryLexer.PRESENCE:return e.nextClause(),j.QueryParser.parsePresence;default:n="Unexpected lexeme type '"+a.type+"'";throw new j.QueryParseError(n,a.start,a.end)}else e.nextClause()}},void 0===(a="function"==typeof(n=function(){return j})?n.call(t,r,t,e):n)||(e.exports=a)}()},88121:(e,t,r)=>{"use strict";r.d(t,{_:()=>a,t:()=>i});var n=r(67294);const a=n.createContext(!1);function i(e){let{children:t}=e;const[r,i]=(0,n.useState)(!1);return(0,n.useEffect)((()=>{i(!0)}),[]),n.createElement(a.Provider,{value:r},t)}},49717:(e,t,r)=>{"use strict";var n=r(67294),a=r(73935),i=r(73727),o=r(70405),s=r(36136);const c=[r(30984),r(82251),r(79957),r(46930)];var l=r(50997),u=r(16550),d=r(18790);function f(e){let{children:t}=e;return n.createElement(n.Fragment,null,t)}var m=r(87462),p=r(31514),b=r(39962),g=r(79524),h=r(20107),w=r(35463),I=r(40626),x=r(78181),y=r(60246),k=r(63905),E=r(33647);function F(){const{i18n:{defaultLocale:e,localeConfigs:t}}=(0,b.Z)(),r=(0,I.l)();return n.createElement(p.Z,null,Object.entries(t).map((e=>{let[t,{htmlLang:a}]=e;return n.createElement("link",{key:t,rel:"alternate",href:r.createUrl({locale:t,fullyQualified:!0}),hrefLang:a})})),n.createElement("link",{rel:"alternate",href:r.createUrl({locale:e,fullyQualified:!0}),hrefLang:"x-default"}))}function R(e){let{permalink:t}=e;const{siteConfig:{url:r}}=(0,b.Z)(),a=function(){const{siteConfig:{url:e,baseUrl:t,trailingSlash:r}}=(0,b.Z)(),{pathname:n}=(0,u.TH)();return e+(0,k.applyTrailingSlash)((0,g.Z)(n),{trailingSlash:r,baseUrl:t})}(),i=t?`${r}${t}`:a;return n.createElement(p.Z,null,n.createElement("meta",{property:"og:url",content:i}),n.createElement("link",{rel:"canonical",href:i}))}function S(){const{i18n:{currentLocale:e}}=(0,b.Z)(),{metadata:t,image:r}=(0,h.L)();return n.createElement(n.Fragment,null,n.createElement(p.Z,null,n.createElement("meta",{name:"twitter:card",content:"summary_large_image"}),n.createElement("body",{className:x.h})),r&&n.createElement(w.d,{image:r}),n.createElement(R,null),n.createElement(F,null),n.createElement(E.Z,{tag:y.HX,locale:e}),n.createElement(p.Z,null,t.map(((e,t)=>n.createElement("meta",(0,m.Z)({key:t},e))))))}const v=new Map;function U(e){if(v.has(e.pathname))return{...e,pathname:v.get(e.pathname)};if((0,d.f)(l.Z,e.pathname).some((e=>{let{route:t}=e;return!0===t.exact})))return v.set(e.pathname,e.pathname),e;const t=e.pathname.trim().replace(/(?:\/index)?\.html$/,"")||"/";return v.set(e.pathname,t),{...e,pathname:t}}var C=r(88121),P=r(80694);function O(e){for(var t=arguments.length,r=new Array(t>1?t-1:0),n=1;n{const n=t.default?.[e]??t[e];return n?.(...r)}));return()=>a.forEach((e=>e?.()))}const _=function(e){let{children:t,location:r,previousLocation:a}=e;return(0,n.useLayoutEffect)((()=>{a!==r&&(!function(e){let{location:t,previousLocation:r}=e;if(!r)return;const n=t.pathname===r.pathname,a=t.hash===r.hash,i=t.search===r.search;if(n&&a&&!i)return;const{hash:o}=t;if(o){const e=decodeURIComponent(o.substring(1)),t=document.getElementById(e);t?.scrollIntoView()}else window.scrollTo(0,0)}({location:r,previousLocation:a}),O("onRouteDidUpdate",{previousLocation:a,location:r}))}),[a,r]),t};function M(e){const t=Array.from(new Set([e,decodeURI(e)])).map((e=>(0,d.f)(l.Z,e))).flat();return Promise.all(t.map((e=>e.route.component.preload?.())))}class T extends n.Component{previousLocation;routeUpdateCleanupCb;constructor(e){super(e),this.previousLocation=null,this.routeUpdateCleanupCb=s.Z.canUseDOM?O("onRouteUpdate",{previousLocation:null,location:this.props.location}):()=>{},this.state={nextRouteHasLoaded:!0}}shouldComponentUpdate(e,t){if(e.location===this.props.location)return t.nextRouteHasLoaded;const r=e.location;return this.previousLocation=this.props.location,this.setState({nextRouteHasLoaded:!1}),this.routeUpdateCleanupCb=O("onRouteUpdate",{previousLocation:this.previousLocation,location:r}),M(r.pathname).then((()=>{this.routeUpdateCleanupCb(),this.setState({nextRouteHasLoaded:!0})})).catch((e=>{console.warn(e),window.location.reload()})),!1}render(){const{children:e,location:t}=this.props;return n.createElement(_,{previousLocation:this.previousLocation,location:t},n.createElement(u.AW,{location:t,render:()=>e}))}}const j=T,A="__docusaurus-base-url-issue-banner-container",L="__docusaurus-base-url-issue-banner",D="__docusaurus-base-url-issue-banner-suggestion-container",N="__DOCUSAURUS_INSERT_BASEURL_BANNER";function V(e){return`\nwindow['${N}'] = true;\n\ndocument.addEventListener('DOMContentLoaded', maybeInsertBanner);\n\nfunction maybeInsertBanner() {\n var shouldInsert = window['${N}'];\n shouldInsert && insertBanner();\n}\n\nfunction insertBanner() {\n var bannerContainer = document.getElementById('${A}');\n if (!bannerContainer) {\n return;\n }\n var bannerHtml = ${JSON.stringify(function(e){return`\n
\n

Your Docusaurus site did not load properly.

\n

A very common reason is a wrong site baseUrl configuration.

\n

Current configured baseUrl = ${e} ${"/"===e?" (default value)":""}

\n

We suggest trying baseUrl =

\n
\n`}(e)).replace(/{window[N]=!1}),[]),n.createElement(n.Fragment,null,!s.Z.canUseDOM&&n.createElement(p.Z,null,n.createElement("script",null,V(e))),n.createElement("div",{id:A}))}function G(){const{siteConfig:{baseUrl:e,baseUrlIssueBanner:t}}=(0,b.Z)(),{pathname:r}=(0,u.TH)();return t&&r===e?n.createElement(B,null):null}function W(){const{siteConfig:{favicon:e,title:t,noIndex:r},i18n:{currentLocale:a,localeConfigs:i}}=(0,b.Z)(),o=(0,g.Z)(e),{htmlLang:s,direction:c}=i[a];return n.createElement(p.Z,null,n.createElement("html",{lang:s,dir:c}),n.createElement("title",null,t),n.createElement("meta",{property:"og:title",content:t}),n.createElement("meta",{name:"viewport",content:"width=device-width, initial-scale=1.0"}),r&&n.createElement("meta",{name:"robots",content:"noindex, nofollow"}),e&&n.createElement("link",{rel:"icon",href:o}))}var z=r(73256),q=r(51048);function $(){const e=(0,q.Z)();return n.createElement(p.Z,null,n.createElement("html",{"data-has-hydrated":e}))}function H(){const e=(0,d.H)(l.Z),t=(0,u.TH)();return n.createElement(z.Z,null,n.createElement(P.M,null,n.createElement(C.t,null,n.createElement(f,null,n.createElement(W,null),n.createElement(S,null),n.createElement(G,null),n.createElement(j,{location:U(t)},e)),n.createElement($,null))))}var Q=r(16887);const Z=function(e){try{return document.createElement("link").relList.supports(e)}catch{return!1}}("prefetch")?function(e){return new Promise(((t,r)=>{if("undefined"==typeof document)return void r();const n=document.createElement("link");n.setAttribute("rel","prefetch"),n.setAttribute("href",e),n.onload=()=>t(),n.onerror=()=>r();const a=document.getElementsByTagName("head")[0]??document.getElementsByName("script")[0]?.parentNode;a?.appendChild(n)}))}:function(e){return new Promise(((t,r)=>{const n=new XMLHttpRequest;n.open("GET",e,!0),n.withCredentials=!0,n.onload=()=>{200===n.status?t():r()},n.send(null)}))};var Y=r(5304);const J=new Set,K=new Set,X=()=>navigator.connection?.effectiveType.includes("2g")||navigator.connection?.saveData,ee={prefetch(e){if(!(e=>!X()&&!K.has(e)&&!J.has(e))(e))return!1;J.add(e);const t=(0,d.f)(l.Z,e).flatMap((e=>{return t=e.route.path,Object.entries(Q).filter((e=>{let[r]=e;return r.replace(/-[^-]+$/,"")===t})).flatMap((e=>{let[,t]=e;return Object.values((0,Y.Z)(t))}));var t}));return Promise.all(t.map((e=>{const t=r.gca(e);return t&&!t.includes("undefined")?Z(t).catch((()=>{})):Promise.resolve()})))},preload:e=>!!(e=>!X()&&!K.has(e))(e)&&(K.add(e),M(e))},te=Object.freeze(ee);if(s.Z.canUseDOM){window.docusaurus=te;const e=a.hydrate;M(window.location.pathname).then((()=>{e(n.createElement(o.B6,null,n.createElement(i.VK,null,n.createElement(H,null))),document.getElementById("__docusaurus"))}))}},80694:(e,t,r)=>{"use strict";r.d(t,{_:()=>u,M:()=>d});var n=r(67294),a=r(36809);const i=JSON.parse('{"@cmfcmf/docusaurus-search-local":{"default":{"titleBoost":5,"contentBoost":1,"tagsBoost":3,"parentCategoriesBoost":2,"indexDocSidebarParentCategories":0,"maxSearchResults":8}},"docusaurus-plugin-content-docs":{"default":{"path":"/Frameworks/User-Interface-Extensibility-Framework/Reference/","versions":[{"name":"current","label":"Next","isLast":true,"path":"/Frameworks/User-Interface-Extensibility-Framework/Reference/","mainDocId":"getting_started","docs":[{"id":"getting_started","path":"/Frameworks/User-Interface-Extensibility-Framework/Reference/","sidebar":"tutorialSidebar"},{"id":"gRPC/Enums/AccessControlSubjectType/index","path":"/Frameworks/User-Interface-Extensibility-Framework/Reference/gRPC/Enums/AccessControlSubjectType/","sidebar":"tutorialSidebar"},{"id":"gRPC/Enums/ACLEnforcingMode/index","path":"/Frameworks/User-Interface-Extensibility-Framework/Reference/gRPC/Enums/ACLEnforcingMode/","sidebar":"tutorialSidebar"},{"id":"gRPC/Enums/AuthType/index","path":"/Frameworks/User-Interface-Extensibility-Framework/Reference/gRPC/Enums/AuthType/","sidebar":"tutorialSidebar"},{"id":"gRPC/Enums/AutomaticValueType/index","path":"/Frameworks/User-Interface-Extensibility-Framework/Reference/gRPC/Enums/AutomaticValueType/","sidebar":"tutorialSidebar"},{"id":"gRPC/Enums/CallImportance/index","path":"/Frameworks/User-Interface-Extensibility-Framework/Reference/gRPC/Enums/CallImportance/","sidebar":"tutorialSidebar"},{"id":"gRPC/Enums/ConditionType/index","path":"/Frameworks/User-Interface-Extensibility-Framework/Reference/gRPC/Enums/ConditionType/","sidebar":"tutorialSidebar"},{"id":"gRPC/Enums/ContentType/index","path":"/Frameworks/User-Interface-Extensibility-Framework/Reference/gRPC/Enums/ContentType/","sidebar":"tutorialSidebar"},{"id":"gRPC/Enums/DataFunction/index","path":"/Frameworks/User-Interface-Extensibility-Framework/Reference/gRPC/Enums/DataFunction/","sidebar":"tutorialSidebar"},{"id":"gRPC/Enums/Datatype/index","path":"/Frameworks/User-Interface-Extensibility-Framework/Reference/gRPC/Enums/Datatype/","sidebar":"tutorialSidebar"},{"id":"gRPC/Enums/EventType/index","path":"/Frameworks/User-Interface-Extensibility-Framework/Reference/gRPC/Enums/EventType/","sidebar":"tutorialSidebar"},{"id":"gRPC/Enums/ExpressionType/index","path":"/Frameworks/User-Interface-Extensibility-Framework/Reference/gRPC/Enums/ExpressionType/","sidebar":"tutorialSidebar"},{"id":"gRPC/Enums/ExtDBRefreshType/index","path":"/Frameworks/User-Interface-Extensibility-Framework/Reference/gRPC/Enums/ExtDBRefreshType/","sidebar":"tutorialSidebar"},{"id":"gRPC/Enums/ExtIDStatus/index","path":"/Frameworks/User-Interface-Extensibility-Framework/Reference/gRPC/Enums/ExtIDStatus/","sidebar":"tutorialSidebar"},{"id":"gRPC/Enums/FileIDType/index","path":"/Frameworks/User-Interface-Extensibility-Framework/Reference/gRPC/Enums/FileIDType/","sidebar":"tutorialSidebar"},{"id":"gRPC/Enums/FileSizePrecision/index","path":"/Frameworks/User-Interface-Extensibility-Framework/Reference/gRPC/Enums/FileSizePrecision/","sidebar":"tutorialSidebar"},{"id":"gRPC/Enums/FileValueType/index","path":"/Frameworks/User-Interface-Extensibility-Framework/Reference/gRPC/Enums/FileValueType/","sidebar":"tutorialSidebar"},{"id":"gRPC/Enums/FileVerType/index","path":"/Frameworks/User-Interface-Extensibility-Framework/Reference/gRPC/Enums/FileVerType/","sidebar":"tutorialSidebar"},{"id":"gRPC/Enums/FolderListingAlgorithm/index","path":"/Frameworks/User-Interface-Extensibility-Framework/Reference/gRPC/Enums/FolderListingAlgorithm/","sidebar":"tutorialSidebar"},{"id":"gRPC/Enums/FolderType/index","path":"/Frameworks/User-Interface-Extensibility-Framework/Reference/gRPC/Enums/FolderType/","sidebar":"tutorialSidebar"},{"id":"gRPC/Enums/FormattingType/index","path":"/Frameworks/User-Interface-Extensibility-Framework/Reference/gRPC/Enums/FormattingType/","sidebar":"tutorialSidebar"},{"id":"gRPC/Enums/index","path":"/Frameworks/User-Interface-Extensibility-Framework/Reference/gRPC/Enums/","sidebar":"tutorialSidebar"},{"id":"gRPC/Enums/IndirectPropertyIDLevelType/index","path":"/Frameworks/User-Interface-Extensibility-Framework/Reference/gRPC/Enums/IndirectPropertyIDLevelType/","sidebar":"tutorialSidebar"},{"id":"gRPC/Enums/MetadataStructureItem/index","path":"/Frameworks/User-Interface-Extensibility-Framework/Reference/gRPC/Enums/MetadataStructureItem/","sidebar":"tutorialSidebar"},{"id":"gRPC/Enums/NACLType/index","path":"/Frameworks/User-Interface-Extensibility-Framework/Reference/gRPC/Enums/NACLType/","sidebar":"tutorialSidebar"},{"id":"gRPC/Enums/NamedValueType/index","path":"/Frameworks/User-Interface-Extensibility-Framework/Reference/gRPC/Enums/NamedValueType/","sidebar":"tutorialSidebar"},{"id":"gRPC/Enums/ObjectVersionDataRequestErrorTolerance/index","path":"/Frameworks/User-Interface-Extensibility-Framework/Reference/gRPC/Enums/ObjectVersionDataRequestErrorTolerance/","sidebar":"tutorialSidebar"},{"id":"gRPC/Enums/ObjectVersionDataRequestIdentityType/index","path":"/Frameworks/User-Interface-Extensibility-Framework/Reference/gRPC/Enums/ObjectVersionDataRequestIdentityType/","sidebar":"tutorialSidebar"},{"id":"gRPC/Enums/ObjectVersionDataRequestVersionType/index","path":"/Frameworks/User-Interface-Extensibility-Framework/Reference/gRPC/Enums/ObjectVersionDataRequestVersionType/","sidebar":"tutorialSidebar"},{"id":"gRPC/Enums/ObjFileSourceType/index","path":"/Frameworks/User-Interface-Extensibility-Framework/Reference/gRPC/Enums/ObjFileSourceType/","sidebar":"tutorialSidebar"},{"id":"gRPC/Enums/ObjVerVersionType/index","path":"/Frameworks/User-Interface-Extensibility-Framework/Reference/gRPC/Enums/ObjVerVersionType/","sidebar":"tutorialSidebar"},{"id":"gRPC/Enums/ParentChildBehavior/index","path":"/Frameworks/User-Interface-Extensibility-Framework/Reference/gRPC/Enums/ParentChildBehavior/","sidebar":"tutorialSidebar"},{"id":"gRPC/Enums/PermissionsExpressionType/index","path":"/Frameworks/User-Interface-Extensibility-Framework/Reference/gRPC/Enums/PermissionsExpressionType/","sidebar":"tutorialSidebar"},{"id":"gRPC/Enums/PropertySetByType/index","path":"/Frameworks/User-Interface-Extensibility-Framework/Reference/gRPC/Enums/PropertySetByType/","sidebar":"tutorialSidebar"},{"id":"gRPC/Enums/PseudoUserResolutionMode/index","path":"/Frameworks/User-Interface-Extensibility-Framework/Reference/gRPC/Enums/PseudoUserResolutionMode/","sidebar":"tutorialSidebar"},{"id":"gRPC/Enums/ReferenceDirection/index","path":"/Frameworks/User-Interface-Extensibility-Framework/Reference/gRPC/Enums/ReferenceDirection/","sidebar":"tutorialSidebar"},{"id":"gRPC/Enums/RelationshipDirection/index","path":"/Frameworks/User-Interface-Extensibility-Framework/Reference/gRPC/Enums/RelationshipDirection/","sidebar":"tutorialSidebar"},{"id":"gRPC/Enums/SearchMode/index","path":"/Frameworks/User-Interface-Extensibility-Framework/Reference/gRPC/Enums/SearchMode/","sidebar":"tutorialSidebar"},{"id":"gRPC/Enums/StatusType/index","path":"/Frameworks/User-Interface-Extensibility-Framework/Reference/gRPC/Enums/StatusType/","sidebar":"tutorialSidebar"},{"id":"gRPC/Enums/UpdateType/index","path":"/Frameworks/User-Interface-Extensibility-Framework/Reference/gRPC/Enums/UpdateType/","sidebar":"tutorialSidebar"},{"id":"gRPC/Enums/ValidationType/index","path":"/Frameworks/User-Interface-Extensibility-Framework/Reference/gRPC/Enums/ValidationType/","sidebar":"tutorialSidebar"},{"id":"gRPC/Enums/ViewType/index","path":"/Frameworks/User-Interface-Extensibility-Framework/Reference/gRPC/Enums/ViewType/","sidebar":"tutorialSidebar"},{"id":"gRPC/Enums/VLSortingType/index","path":"/Frameworks/User-Interface-Extensibility-Framework/Reference/gRPC/Enums/VLSortingType/","sidebar":"tutorialSidebar"},{"id":"gRPC/gRPC","path":"/Frameworks/User-Interface-Extensibility-Framework/Reference/gRPC/","sidebar":"tutorialSidebar"},{"id":"gRPC/Interfaces/index","path":"/Frameworks/User-Interface-Extensibility-Framework/Reference/gRPC/Interfaces/","sidebar":"tutorialSidebar"},{"id":"gRPC/Interfaces/NamedACLsOperations/GetNamedACLs/index","path":"/Frameworks/User-Interface-Extensibility-Framework/Reference/gRPC/Interfaces/NamedACLsOperations/GetNamedACLs/","sidebar":"tutorialSidebar"},{"id":"gRPC/Interfaces/NamedACLsOperations/index","path":"/Frameworks/User-Interface-Extensibility-Framework/Reference/gRPC/Interfaces/NamedACLsOperations/","sidebar":"tutorialSidebar"},{"id":"gRPC/Interfaces/NamedValueStorageOperations/GetNamedValues/index","path":"/Frameworks/User-Interface-Extensibility-Framework/Reference/gRPC/Interfaces/NamedValueStorageOperations/GetNamedValues/","sidebar":"tutorialSidebar"},{"id":"gRPC/Interfaces/NamedValueStorageOperations/index","path":"/Frameworks/User-Interface-Extensibility-Framework/Reference/gRPC/Interfaces/NamedValueStorageOperations/","sidebar":"tutorialSidebar"},{"id":"gRPC/Interfaces/NamedValueStorageOperations/RemoveNamedValues/index","path":"/Frameworks/User-Interface-Extensibility-Framework/Reference/gRPC/Interfaces/NamedValueStorageOperations/RemoveNamedValues/","sidebar":"tutorialSidebar"},{"id":"gRPC/Interfaces/NamedValueStorageOperations/SetNamedValues/index","path":"/Frameworks/User-Interface-Extensibility-Framework/Reference/gRPC/Interfaces/NamedValueStorageOperations/SetNamedValues/","sidebar":"tutorialSidebar"},{"id":"gRPC/Interfaces/ObjectOperations/AddObjectFile/index","path":"/Frameworks/User-Interface-Extensibility-Framework/Reference/gRPC/Interfaces/ObjectOperations/AddObjectFile/","sidebar":"tutorialSidebar"},{"id":"gRPC/Interfaces/ObjectOperations/AddObjectWithFiles/index","path":"/Frameworks/User-Interface-Extensibility-Framework/Reference/gRPC/Interfaces/ObjectOperations/AddObjectWithFiles/","sidebar":"tutorialSidebar"},{"id":"gRPC/Interfaces/ObjectOperations/ChangeSecurity/index","path":"/Frameworks/User-Interface-Extensibility-Framework/Reference/gRPC/Interfaces/ObjectOperations/ChangeSecurity/","sidebar":"tutorialSidebar"},{"id":"gRPC/Interfaces/ObjectOperations/CheckInMultiple/index","path":"/Frameworks/User-Interface-Extensibility-Framework/Reference/gRPC/Interfaces/ObjectOperations/CheckInMultiple/","sidebar":"tutorialSidebar"},{"id":"gRPC/Interfaces/ObjectOperations/CheckOutMultiple/index","path":"/Frameworks/User-Interface-Extensibility-Framework/Reference/gRPC/Interfaces/ObjectOperations/CheckOutMultiple/","sidebar":"tutorialSidebar"},{"id":"gRPC/Interfaces/ObjectOperations/DestroyObjects/index","path":"/Frameworks/User-Interface-Extensibility-Framework/Reference/gRPC/Interfaces/ObjectOperations/DestroyObjects/","sidebar":"tutorialSidebar"},{"id":"gRPC/Interfaces/ObjectOperations/FollowObject/index","path":"/Frameworks/User-Interface-Extensibility-Framework/Reference/gRPC/Interfaces/ObjectOperations/FollowObject/","sidebar":"tutorialSidebar"},{"id":"gRPC/Interfaces/ObjectOperations/GetAutomaticMetadata/index","path":"/Frameworks/User-Interface-Extensibility-Framework/Reference/gRPC/Interfaces/ObjectOperations/GetAutomaticMetadata/","sidebar":"tutorialSidebar"},{"id":"gRPC/Interfaces/ObjectOperations/GetDocEventSubscriptions/index","path":"/Frameworks/User-Interface-Extensibility-Framework/Reference/gRPC/Interfaces/ObjectOperations/GetDocEventSubscriptions/","sidebar":"tutorialSidebar"},{"id":"gRPC/Interfaces/ObjectOperations/GetEffectivePermissions/index","path":"/Frameworks/User-Interface-Extensibility-Framework/Reference/gRPC/Interfaces/ObjectOperations/GetEffectivePermissions/","sidebar":"tutorialSidebar"},{"id":"gRPC/Interfaces/ObjectOperations/GetLatestFileVersion/index","path":"/Frameworks/User-Interface-Extensibility-Framework/Reference/gRPC/Interfaces/ObjectOperations/GetLatestFileVersion/","sidebar":"tutorialSidebar"},{"id":"gRPC/Interfaces/ObjectOperations/GetLatestObjectVersion/index","path":"/Frameworks/User-Interface-Extensibility-Framework/Reference/gRPC/Interfaces/ObjectOperations/GetLatestObjectVersion/","sidebar":"tutorialSidebar"},{"id":"gRPC/Interfaces/ObjectOperations/GetObjectDataOfMultipleObjects/index","path":"/Frameworks/User-Interface-Extensibility-Framework/Reference/gRPC/Interfaces/ObjectOperations/GetObjectDataOfMultipleObjects/","sidebar":"tutorialSidebar"},{"id":"gRPC/Interfaces/ObjectOperations/GetObjectFiles/index","path":"/Frameworks/User-Interface-Extensibility-Framework/Reference/gRPC/Interfaces/ObjectOperations/GetObjectFiles/","sidebar":"tutorialSidebar"},{"id":"gRPC/Interfaces/ObjectOperations/GetObjectHistory2/index","path":"/Frameworks/User-Interface-Extensibility-Framework/Reference/gRPC/Interfaces/ObjectOperations/GetObjectHistory2/","sidebar":"tutorialSidebar"},{"id":"gRPC/Interfaces/ObjectOperations/GetObjIDByGUID/index","path":"/Frameworks/User-Interface-Extensibility-Framework/Reference/gRPC/Interfaces/ObjectOperations/GetObjIDByGUID/","sidebar":"tutorialSidebar"},{"id":"gRPC/Interfaces/ObjectOperations/GetTemplates/index","path":"/Frameworks/User-Interface-Extensibility-Framework/Reference/gRPC/Interfaces/ObjectOperations/GetTemplates/","sidebar":"tutorialSidebar"},{"id":"gRPC/Interfaces/ObjectOperations/GetWorkflowsForClient/index","path":"/Frameworks/User-Interface-Extensibility-Framework/Reference/gRPC/Interfaces/ObjectOperations/GetWorkflowsForClient/","sidebar":"tutorialSidebar"},{"id":"gRPC/Interfaces/ObjectOperations/GetWorkflowStateHistory/index","path":"/Frameworks/User-Interface-Extensibility-Framework/Reference/gRPC/Interfaces/ObjectOperations/GetWorkflowStateHistory/","sidebar":"tutorialSidebar"},{"id":"gRPC/Interfaces/ObjectOperations/GetWorkflowStates/index","path":"/Frameworks/User-Interface-Extensibility-Framework/Reference/gRPC/Interfaces/ObjectOperations/GetWorkflowStates/","sidebar":"tutorialSidebar"},{"id":"gRPC/Interfaces/ObjectOperations/GetWorkflowStatesAndTransitions/index","path":"/Frameworks/User-Interface-Extensibility-Framework/Reference/gRPC/Interfaces/ObjectOperations/GetWorkflowStatesAndTransitions/","sidebar":"tutorialSidebar"},{"id":"gRPC/Interfaces/ObjectOperations/index","path":"/Frameworks/User-Interface-Extensibility-Framework/Reference/gRPC/Interfaces/ObjectOperations/","sidebar":"tutorialSidebar"},{"id":"gRPC/Interfaces/ObjectOperations/PromoteUnmanagedObject/index","path":"/Frameworks/User-Interface-Extensibility-Framework/Reference/gRPC/Interfaces/ObjectOperations/PromoteUnmanagedObject/","sidebar":"tutorialSidebar"},{"id":"gRPC/Interfaces/ObjectOperations/RemoveObjectFile/index","path":"/Frameworks/User-Interface-Extensibility-Framework/Reference/gRPC/Interfaces/ObjectOperations/RemoveObjectFile/","sidebar":"tutorialSidebar"},{"id":"gRPC/Interfaces/ObjectOperations/RemoveObjects/index","path":"/Frameworks/User-Interface-Extensibility-Framework/Reference/gRPC/Interfaces/ObjectOperations/RemoveObjects/","sidebar":"tutorialSidebar"},{"id":"gRPC/Interfaces/ObjectOperations/RenameObjectFile/index","path":"/Frameworks/User-Interface-Extensibility-Framework/Reference/gRPC/Interfaces/ObjectOperations/RenameObjectFile/","sidebar":"tutorialSidebar"},{"id":"gRPC/Interfaces/ObjectOperations/SetObjectLevelProperty/index","path":"/Frameworks/User-Interface-Extensibility-Framework/Reference/gRPC/Interfaces/ObjectOperations/SetObjectLevelProperty/","sidebar":"tutorialSidebar"},{"id":"gRPC/Interfaces/ObjectOperations/SetPropertiesMultiple/index","path":"/Frameworks/User-Interface-Extensibility-Framework/Reference/gRPC/Interfaces/ObjectOperations/SetPropertiesMultiple/","sidebar":"tutorialSidebar"},{"id":"gRPC/Interfaces/ObjectOperations/UndoCheckoutMultiple/index","path":"/Frameworks/User-Interface-Extensibility-Framework/Reference/gRPC/Interfaces/ObjectOperations/UndoCheckoutMultiple/","sidebar":"tutorialSidebar"},{"id":"gRPC/Interfaces/ObjectOperations/UploadExistingFiles/index","path":"/Frameworks/User-Interface-Extensibility-Framework/Reference/gRPC/Interfaces/ObjectOperations/UploadExistingFiles/","sidebar":"tutorialSidebar"},{"id":"gRPC/Interfaces/ObjectTypesOperations/GetObjectTypes/index","path":"/Frameworks/User-Interface-Extensibility-Framework/Reference/gRPC/Interfaces/ObjectTypesOperations/GetObjectTypes/","sidebar":"tutorialSidebar"},{"id":"gRPC/Interfaces/ObjectTypesOperations/index","path":"/Frameworks/User-Interface-Extensibility-Framework/Reference/gRPC/Interfaces/ObjectTypesOperations/","sidebar":"tutorialSidebar"},{"id":"gRPC/Interfaces/PropertyDefsOperations/GetObjectClassesAndGroups/index","path":"/Frameworks/User-Interface-Extensibility-Framework/Reference/gRPC/Interfaces/PropertyDefsOperations/GetObjectClassesAndGroups/","sidebar":"tutorialSidebar"},{"id":"gRPC/Interfaces/PropertyDefsOperations/GetPropertyDefs/index","path":"/Frameworks/User-Interface-Extensibility-Framework/Reference/gRPC/Interfaces/PropertyDefsOperations/GetPropertyDefs/","sidebar":"tutorialSidebar"},{"id":"gRPC/Interfaces/PropertyDefsOperations/index","path":"/Frameworks/User-Interface-Extensibility-Framework/Reference/gRPC/Interfaces/PropertyDefsOperations/","sidebar":"tutorialSidebar"},{"id":"gRPC/Interfaces/SearchOperations/GetFolderContents/index","path":"/Frameworks/User-Interface-Extensibility-Framework/Reference/gRPC/Interfaces/SearchOperations/GetFolderContents/","sidebar":"tutorialSidebar"},{"id":"gRPC/Interfaces/SearchOperations/index","path":"/Frameworks/User-Interface-Extensibility-Framework/Reference/gRPC/Interfaces/SearchOperations/","sidebar":"tutorialSidebar"},{"id":"gRPC/Interfaces/SearchOperations/SearchObjects/index","path":"/Frameworks/User-Interface-Extensibility-Framework/Reference/gRPC/Interfaces/SearchOperations/SearchObjects/","sidebar":"tutorialSidebar"},{"id":"gRPC/Interfaces/ValueListsOperations/GetValueListItemsWithPermissions/index","path":"/Frameworks/User-Interface-Extensibility-Framework/Reference/gRPC/Interfaces/ValueListsOperations/GetValueListItemsWithPermissions/","sidebar":"tutorialSidebar"},{"id":"gRPC/Interfaces/ValueListsOperations/GetValueLists/index","path":"/Frameworks/User-Interface-Extensibility-Framework/Reference/gRPC/Interfaces/ValueListsOperations/GetValueLists/","sidebar":"tutorialSidebar"},{"id":"gRPC/Interfaces/ValueListsOperations/index","path":"/Frameworks/User-Interface-Extensibility-Framework/Reference/gRPC/Interfaces/ValueListsOperations/","sidebar":"tutorialSidebar"},{"id":"gRPC/Interfaces/ValueListsOperations/SearchValueListItemsWithPermissions/index","path":"/Frameworks/User-Interface-Extensibility-Framework/Reference/gRPC/Interfaces/ValueListsOperations/SearchValueListItemsWithPermissions/","sidebar":"tutorialSidebar"},{"id":"gRPC/Interfaces/VaultExtensionMethodsOperations/index","path":"/Frameworks/User-Interface-Extensibility-Framework/Reference/gRPC/Interfaces/VaultExtensionMethodsOperations/","sidebar":"tutorialSidebar"},{"id":"gRPC/Interfaces/VaultExtensionMethodsOperations/IsExtensionMethodAvailable/index","path":"/Frameworks/User-Interface-Extensibility-Framework/Reference/gRPC/Interfaces/VaultExtensionMethodsOperations/IsExtensionMethodAvailable/","sidebar":"tutorialSidebar"},{"id":"gRPC/Interfaces/VaultExtensionMethodsOperations/RunExtensionMethod/index","path":"/Frameworks/User-Interface-Extensibility-Framework/Reference/gRPC/Interfaces/VaultExtensionMethodsOperations/RunExtensionMethod/","sidebar":"tutorialSidebar"},{"id":"gRPC/Interfaces/VaultOperations/GetMetadataStructureItemIdByAlias/index","path":"/Frameworks/User-Interface-Extensibility-Framework/Reference/gRPC/Interfaces/VaultOperations/GetMetadataStructureItemIdByAlias/","sidebar":"tutorialSidebar"},{"id":"gRPC/Interfaces/VaultOperations/GetMetadataStructureItemIdByGUID/index","path":"/Frameworks/User-Interface-Extensibility-Framework/Reference/gRPC/Interfaces/VaultOperations/GetMetadataStructureItemIdByGUID/","sidebar":"tutorialSidebar"},{"id":"gRPC/Interfaces/VaultOperations/index","path":"/Frameworks/User-Interface-Extensibility-Framework/Reference/gRPC/Interfaces/VaultOperations/","sidebar":"tutorialSidebar"},{"id":"gRPC/Interfaces/ViewsOperations/DeleteView/index","path":"/Frameworks/User-Interface-Extensibility-Framework/Reference/gRPC/Interfaces/ViewsOperations/DeleteView/","sidebar":"tutorialSidebar"},{"id":"gRPC/Interfaces/ViewsOperations/GetViews/index","path":"/Frameworks/User-Interface-Extensibility-Framework/Reference/gRPC/Interfaces/ViewsOperations/GetViews/","sidebar":"tutorialSidebar"},{"id":"gRPC/Interfaces/ViewsOperations/index","path":"/Frameworks/User-Interface-Extensibility-Framework/Reference/gRPC/Interfaces/ViewsOperations/","sidebar":"tutorialSidebar"},{"id":"gRPC/Messages/AccessControlEntry/index","path":"/Frameworks/User-Interface-Extensibility-Framework/Reference/gRPC/Messages/AccessControlEntry/","sidebar":"tutorialSidebar"},{"id":"gRPC/Messages/AccessControlList/index","path":"/Frameworks/User-Interface-Extensibility-Framework/Reference/gRPC/Messages/AccessControlList/","sidebar":"tutorialSidebar"},{"id":"gRPC/Messages/AccessControlListComponent/index","path":"/Frameworks/User-Interface-Extensibility-Framework/Reference/gRPC/Messages/AccessControlListComponent/","sidebar":"tutorialSidebar"},{"id":"gRPC/Messages/AccessControlListComponentKey/index","path":"/Frameworks/User-Interface-Extensibility-Framework/Reference/gRPC/Messages/AccessControlListComponentKey/","sidebar":"tutorialSidebar"},{"id":"gRPC/Messages/AccessControlListComponentMapEntry/index","path":"/Frameworks/User-Interface-Extensibility-Framework/Reference/gRPC/Messages/AccessControlListComponentMapEntry/","sidebar":"tutorialSidebar"},{"id":"gRPC/Messages/ACCESSCONTROLLISTCOMPONENTSTATUSFLAGS/index","path":"/Frameworks/User-Interface-Extensibility-Framework/Reference/gRPC/Messages/ACCESSCONTROLLISTCOMPONENTSTATUSFLAGS/","sidebar":"tutorialSidebar"},{"id":"gRPC/Messages/AccessControlPseudoUserSubject/index","path":"/Frameworks/User-Interface-Extensibility-Framework/Reference/gRPC/Messages/AccessControlPseudoUserSubject/","sidebar":"tutorialSidebar"},{"id":"gRPC/Messages/AccessControlSubject/index","path":"/Frameworks/User-Interface-Extensibility-Framework/Reference/gRPC/Messages/AccessControlSubject/","sidebar":"tutorialSidebar"},{"id":"gRPC/Messages/AccessControlSubjectUnion/index","path":"/Frameworks/User-Interface-Extensibility-Framework/Reference/gRPC/Messages/AccessControlSubjectUnion/","sidebar":"tutorialSidebar"},{"id":"gRPC/Messages/ACTIONFLAGS/index","path":"/Frameworks/User-Interface-Extensibility-Framework/Reference/gRPC/Messages/ACTIONFLAGS/","sidebar":"tutorialSidebar"},{"id":"gRPC/Messages/AssociatedPropertyDef/index","path":"/Frameworks/User-Interface-Extensibility-Framework/Reference/gRPC/Messages/AssociatedPropertyDef/","sidebar":"tutorialSidebar"},{"id":"gRPC/Messages/AutomaticMetadataRequest/index","path":"/Frameworks/User-Interface-Extensibility-Framework/Reference/gRPC/Messages/AutomaticMetadataRequest/","sidebar":"tutorialSidebar"},{"id":"gRPC/Messages/AutomaticMetadataResult/index","path":"/Frameworks/User-Interface-Extensibility-Framework/Reference/gRPC/Messages/AutomaticMetadataResult/","sidebar":"tutorialSidebar"},{"id":"gRPC/Messages/AutomaticPermissions/index","path":"/Frameworks/User-Interface-Extensibility-Framework/Reference/gRPC/Messages/AutomaticPermissions/","sidebar":"tutorialSidebar"},{"id":"gRPC/Messages/Bytes/index","path":"/Frameworks/User-Interface-Extensibility-Framework/Reference/gRPC/Messages/Bytes/","sidebar":"tutorialSidebar"},{"id":"gRPC/Messages/ClassGroup/index","path":"/Frameworks/User-Interface-Extensibility-Framework/Reference/gRPC/Messages/ClassGroup/","sidebar":"tutorialSidebar"},{"id":"gRPC/Messages/ClassPermissionsForClient/index","path":"/Frameworks/User-Interface-Extensibility-Framework/Reference/gRPC/Messages/ClassPermissionsForClient/","sidebar":"tutorialSidebar"},{"id":"gRPC/Messages/DataFunctionCall/index","path":"/Frameworks/User-Interface-Extensibility-Framework/Reference/gRPC/Messages/DataFunctionCall/","sidebar":"tutorialSidebar"},{"id":"gRPC/Messages/DataFunctionUnion/DateData/index","path":"/Frameworks/User-Interface-Extensibility-Framework/Reference/gRPC/Messages/DataFunctionUnion/DateData/","sidebar":"tutorialSidebar"},{"id":"gRPC/Messages/DataFunctionUnion/DaysFromData/index","path":"/Frameworks/User-Interface-Extensibility-Framework/Reference/gRPC/Messages/DataFunctionUnion/DaysFromData/","sidebar":"tutorialSidebar"},{"id":"gRPC/Messages/DataFunctionUnion/DaysToData/index","path":"/Frameworks/User-Interface-Extensibility-Framework/Reference/gRPC/Messages/DataFunctionUnion/DaysToData/","sidebar":"tutorialSidebar"},{"id":"gRPC/Messages/DataFunctionUnion/index","path":"/Frameworks/User-Interface-Extensibility-Framework/Reference/gRPC/Messages/DataFunctionUnion/","sidebar":"tutorialSidebar"},{"id":"gRPC/Messages/DataFunctionUnion/InitialCharacterGroupData/index","path":"/Frameworks/User-Interface-Extensibility-Framework/Reference/gRPC/Messages/DataFunctionUnion/InitialCharacterGroupData/","sidebar":"tutorialSidebar"},{"id":"gRPC/Messages/DataFunctionUnion/IntegerSegmentData/index","path":"/Frameworks/User-Interface-Extensibility-Framework/Reference/gRPC/Messages/DataFunctionUnion/IntegerSegmentData/","sidebar":"tutorialSidebar"},{"id":"gRPC/Messages/DataFunctionUnion/LeftCharactersData/index","path":"/Frameworks/User-Interface-Extensibility-Framework/Reference/gRPC/Messages/DataFunctionUnion/LeftCharactersData/","sidebar":"tutorialSidebar"},{"id":"gRPC/Messages/DataFunctionUnion/MonthData/index","path":"/Frameworks/User-Interface-Extensibility-Framework/Reference/gRPC/Messages/DataFunctionUnion/MonthData/","sidebar":"tutorialSidebar"},{"id":"gRPC/Messages/DataFunctionUnion/NoOpData/index","path":"/Frameworks/User-Interface-Extensibility-Framework/Reference/gRPC/Messages/DataFunctionUnion/NoOpData/","sidebar":"tutorialSidebar"},{"id":"gRPC/Messages/DataFunctionUnion/YearAndMonthData/index","path":"/Frameworks/User-Interface-Extensibility-Framework/Reference/gRPC/Messages/DataFunctionUnion/YearAndMonthData/","sidebar":"tutorialSidebar"},{"id":"gRPC/Messages/DataFunctionUnion/YearData/index","path":"/Frameworks/User-Interface-Extensibility-Framework/Reference/gRPC/Messages/DataFunctionUnion/YearData/","sidebar":"tutorialSidebar"},{"id":"gRPC/Messages/DefaultReplicationConfiguration/index","path":"/Frameworks/User-Interface-Extensibility-Framework/Reference/gRPC/Messages/DefaultReplicationConfiguration/","sidebar":"tutorialSidebar"},{"id":"gRPC/Messages/DocClassGroup/index","path":"/Frameworks/User-Interface-Extensibility-Framework/Reference/gRPC/Messages/DocClassGroup/","sidebar":"tutorialSidebar"},{"id":"gRPC/Messages/EffectivePermissions/index","path":"/Frameworks/User-Interface-Extensibility-Framework/Reference/gRPC/Messages/EffectivePermissions/","sidebar":"tutorialSidebar"},{"id":"gRPC/Messages/ErrorInfo/index","path":"/Frameworks/User-Interface-Extensibility-Framework/Reference/gRPC/Messages/ErrorInfo/","sidebar":"tutorialSidebar"},{"id":"gRPC/Messages/EventSubscription/index","path":"/Frameworks/User-Interface-Extensibility-Framework/Reference/gRPC/Messages/EventSubscription/","sidebar":"tutorialSidebar"},{"id":"gRPC/Messages/Expression/index","path":"/Frameworks/User-Interface-Extensibility-Framework/Reference/gRPC/Messages/Expression/","sidebar":"tutorialSidebar"},{"id":"gRPC/Messages/EXPRESSIONEXFLAGS/index","path":"/Frameworks/User-Interface-Extensibility-Framework/Reference/gRPC/Messages/EXPRESSIONEXFLAGS/","sidebar":"tutorialSidebar"},{"id":"gRPC/Messages/ExpressionUnion/AnyFieldData/index","path":"/Frameworks/User-Interface-Extensibility-Framework/Reference/gRPC/Messages/ExpressionUnion/AnyFieldData/","sidebar":"tutorialSidebar"},{"id":"gRPC/Messages/ExpressionUnion/FileValueData/index","path":"/Frameworks/User-Interface-Extensibility-Framework/Reference/gRPC/Messages/ExpressionUnion/FileValueData/","sidebar":"tutorialSidebar"},{"id":"gRPC/Messages/ExpressionUnion/IdSegmentData/index","path":"/Frameworks/User-Interface-Extensibility-Framework/Reference/gRPC/Messages/ExpressionUnion/IdSegmentData/","sidebar":"tutorialSidebar"},{"id":"gRPC/Messages/ExpressionUnion/index","path":"/Frameworks/User-Interface-Extensibility-Framework/Reference/gRPC/Messages/ExpressionUnion/","sidebar":"tutorialSidebar"},{"id":"gRPC/Messages/ExpressionUnion/PermissionsData/index","path":"/Frameworks/User-Interface-Extensibility-Framework/Reference/gRPC/Messages/ExpressionUnion/PermissionsData/","sidebar":"tutorialSidebar"},{"id":"gRPC/Messages/ExpressionUnion/PropertyValueData/index","path":"/Frameworks/User-Interface-Extensibility-Framework/Reference/gRPC/Messages/ExpressionUnion/PropertyValueData/","sidebar":"tutorialSidebar"},{"id":"gRPC/Messages/ExpressionUnion/StatusValueData/index","path":"/Frameworks/User-Interface-Extensibility-Framework/Reference/gRPC/Messages/ExpressionUnion/StatusValueData/","sidebar":"tutorialSidebar"},{"id":"gRPC/Messages/ExpressionUnion/TypedValueData/index","path":"/Frameworks/User-Interface-Extensibility-Framework/Reference/gRPC/Messages/ExpressionUnion/TypedValueData/","sidebar":"tutorialSidebar"},{"id":"gRPC/Messages/ExpressionUnion/UninitializedData/index","path":"/Frameworks/User-Interface-Extensibility-Framework/Reference/gRPC/Messages/ExpressionUnion/UninitializedData/","sidebar":"tutorialSidebar"},{"id":"gRPC/Messages/ExternalRepositoryID/index","path":"/Frameworks/User-Interface-Extensibility-Framework/Reference/gRPC/Messages/ExternalRepositoryID/","sidebar":"tutorialSidebar"},{"id":"gRPC/Messages/ExternalView/index","path":"/Frameworks/User-Interface-Extensibility-Framework/Reference/gRPC/Messages/ExternalView/","sidebar":"tutorialSidebar"},{"id":"gRPC/Messages/ExtObjectInfo/index","path":"/Frameworks/User-Interface-Extensibility-Framework/Reference/gRPC/Messages/ExtObjectInfo/","sidebar":"tutorialSidebar"},{"id":"gRPC/Messages/File/index","path":"/Frameworks/User-Interface-Extensibility-Framework/Reference/gRPC/Messages/File/","sidebar":"tutorialSidebar"},{"id":"gRPC/Messages/FileID/index","path":"/Frameworks/User-Interface-Extensibility-Framework/Reference/gRPC/Messages/FileID/","sidebar":"tutorialSidebar"},{"id":"gRPC/Messages/FileVer/index","path":"/Frameworks/User-Interface-Extensibility-Framework/Reference/gRPC/Messages/FileVer/","sidebar":"tutorialSidebar"},{"id":"gRPC/Messages/Folder/index","path":"/Frameworks/User-Interface-Extensibility-Framework/Reference/gRPC/Messages/Folder/","sidebar":"tutorialSidebar"},{"id":"gRPC/Messages/FOLDERCAPABILITYFLAGS/index","path":"/Frameworks/User-Interface-Extensibility-Framework/Reference/gRPC/Messages/FOLDERCAPABILITYFLAGS/","sidebar":"tutorialSidebar"},{"id":"gRPC/Messages/FolderInfoUnion/AnyFolderData/index","path":"/Frameworks/User-Interface-Extensibility-Framework/Reference/gRPC/Messages/FolderInfoUnion/AnyFolderData/","sidebar":"tutorialSidebar"},{"id":"gRPC/Messages/FolderInfoUnion/ExternalViewFolderData/index","path":"/Frameworks/User-Interface-Extensibility-Framework/Reference/gRPC/Messages/FolderInfoUnion/ExternalViewFolderData/","sidebar":"tutorialSidebar"},{"id":"gRPC/Messages/FolderInfoUnion/index","path":"/Frameworks/User-Interface-Extensibility-Framework/Reference/gRPC/Messages/FolderInfoUnion/","sidebar":"tutorialSidebar"},{"id":"gRPC/Messages/FolderInfoUnion/PropertyFolderData/index","path":"/Frameworks/User-Interface-Extensibility-Framework/Reference/gRPC/Messages/FolderInfoUnion/PropertyFolderData/","sidebar":"tutorialSidebar"},{"id":"gRPC/Messages/FolderInfoUnion/SearchFolderData/index","path":"/Frameworks/User-Interface-Extensibility-Framework/Reference/gRPC/Messages/FolderInfoUnion/SearchFolderData/","sidebar":"tutorialSidebar"},{"id":"gRPC/Messages/FolderInfoUnion/TraditionalFolderData/index","path":"/Frameworks/User-Interface-Extensibility-Framework/Reference/gRPC/Messages/FolderInfoUnion/TraditionalFolderData/","sidebar":"tutorialSidebar"},{"id":"gRPC/Messages/FolderInfoUnion/UnknownFolderData/index","path":"/Frameworks/User-Interface-Extensibility-Framework/Reference/gRPC/Messages/FolderInfoUnion/UnknownFolderData/","sidebar":"tutorialSidebar"},{"id":"gRPC/Messages/FolderInfoUnion/ViewFolderData/index","path":"/Frameworks/User-Interface-Extensibility-Framework/Reference/gRPC/Messages/FolderInfoUnion/ViewFolderData/","sidebar":"tutorialSidebar"},{"id":"gRPC/Messages/FTSFLAGS/index","path":"/Frameworks/User-Interface-Extensibility-Framework/Reference/gRPC/Messages/FTSFLAGS/","sidebar":"tutorialSidebar"},{"id":"gRPC/Messages/GetMetadataStructureItemIdByGUIDRequest/index","path":"/Frameworks/User-Interface-Extensibility-Framework/Reference/gRPC/Messages/GetMetadataStructureItemIdByGUIDRequest/","sidebar":"tutorialSidebar"},{"id":"gRPC/Messages/GetMetadataStructureItemIdByGUIDResponse/index","path":"/Frameworks/User-Interface-Extensibility-Framework/Reference/gRPC/Messages/GetMetadataStructureItemIdByGUIDResponse/","sidebar":"tutorialSidebar"},{"id":"gRPC/Messages/GetObjectVersionAndPropertiesOfMultipleObjectsResponse/index","path":"/Frameworks/User-Interface-Extensibility-Framework/Reference/gRPC/Messages/GetObjectVersionAndPropertiesOfMultipleObjectsResponse/","sidebar":"tutorialSidebar"},{"id":"gRPC/Messages/GroupingLevel/index","path":"/Frameworks/User-Interface-Extensibility-Framework/Reference/gRPC/Messages/GroupingLevel/","sidebar":"tutorialSidebar"},{"id":"gRPC/Messages/index","path":"/Frameworks/User-Interface-Extensibility-Framework/Reference/gRPC/Messages/","sidebar":"tutorialSidebar"},{"id":"gRPC/Messages/IndirectionLevel/index","path":"/Frameworks/User-Interface-Extensibility-Framework/Reference/gRPC/Messages/IndirectionLevel/","sidebar":"tutorialSidebar"},{"id":"gRPC/Messages/IndirectPropertyID/index","path":"/Frameworks/User-Interface-Extensibility-Framework/Reference/gRPC/Messages/IndirectPropertyID/","sidebar":"tutorialSidebar"},{"id":"gRPC/Messages/IndirectPropertyIDLevel/index","path":"/Frameworks/User-Interface-Extensibility-Framework/Reference/gRPC/Messages/IndirectPropertyIDLevel/","sidebar":"tutorialSidebar"},{"id":"gRPC/Messages/IndirectPropertyIDLevelRef/index","path":"/Frameworks/User-Interface-Extensibility-Framework/Reference/gRPC/Messages/IndirectPropertyIDLevelRef/","sidebar":"tutorialSidebar"},{"id":"gRPC/Messages/ITEMFLAGS/index","path":"/Frameworks/User-Interface-Extensibility-Framework/Reference/gRPC/Messages/ITEMFLAGS/","sidebar":"tutorialSidebar"},{"id":"gRPC/Messages/ItemID/index","path":"/Frameworks/User-Interface-Extensibility-Framework/Reference/gRPC/Messages/ItemID/","sidebar":"tutorialSidebar"},{"id":"gRPC/Messages/ItemInfo/index","path":"/Frameworks/User-Interface-Extensibility-Framework/Reference/gRPC/Messages/ItemInfo/","sidebar":"tutorialSidebar"},{"id":"gRPC/Messages/Lookup/index","path":"/Frameworks/User-Interface-Extensibility-Framework/Reference/gRPC/Messages/Lookup/","sidebar":"tutorialSidebar"},{"id":"gRPC/Messages/LookupWithMetadata/index","path":"/Frameworks/User-Interface-Extensibility-Framework/Reference/gRPC/Messages/LookupWithMetadata/","sidebar":"tutorialSidebar"},{"id":"gRPC/Messages/MultiSelectLookup/index","path":"/Frameworks/User-Interface-Extensibility-Framework/Reference/gRPC/Messages/MultiSelectLookup/","sidebar":"tutorialSidebar"},{"id":"gRPC/Messages/MultiSelectLookupWithMetadata/index","path":"/Frameworks/User-Interface-Extensibility-Framework/Reference/gRPC/Messages/MultiSelectLookupWithMetadata/","sidebar":"tutorialSidebar"},{"id":"gRPC/Messages/NamedACL/index","path":"/Frameworks/User-Interface-Extensibility-Framework/Reference/gRPC/Messages/NamedACL/","sidebar":"tutorialSidebar"},{"id":"gRPC/Messages/NamedValue/index","path":"/Frameworks/User-Interface-Extensibility-Framework/Reference/gRPC/Messages/NamedValue/","sidebar":"tutorialSidebar"},{"id":"gRPC/Messages/OBJECTCAPABILITYFLAGS/index","path":"/Frameworks/User-Interface-Extensibility-Framework/Reference/gRPC/Messages/OBJECTCAPABILITYFLAGS/","sidebar":"tutorialSidebar"},{"id":"gRPC/Messages/ObjectClass/index","path":"/Frameworks/User-Interface-Extensibility-Framework/Reference/gRPC/Messages/ObjectClass/","sidebar":"tutorialSidebar"},{"id":"gRPC/Messages/OBJECTDATAREQUESTFLAGS/index","path":"/Frameworks/User-Interface-Extensibility-Framework/Reference/gRPC/Messages/OBJECTDATAREQUESTFLAGS/","sidebar":"tutorialSidebar"},{"id":"gRPC/Messages/OBJECTFILEFLAGS/index","path":"/Frameworks/User-Interface-Extensibility-Framework/Reference/gRPC/Messages/OBJECTFILEFLAGS/","sidebar":"tutorialSidebar"},{"id":"gRPC/Messages/ObjectLevelInfo/index","path":"/Frameworks/User-Interface-Extensibility-Framework/Reference/gRPC/Messages/ObjectLevelInfo/","sidebar":"tutorialSidebar"},{"id":"gRPC/Messages/OBJECTOPFLAGS/index","path":"/Frameworks/User-Interface-Extensibility-Framework/Reference/gRPC/Messages/OBJECTOPFLAGS/","sidebar":"tutorialSidebar"},{"id":"gRPC/Messages/ObjectPermissionsForClient/index","path":"/Frameworks/User-Interface-Extensibility-Framework/Reference/gRPC/Messages/ObjectPermissionsForClient/","sidebar":"tutorialSidebar"},{"id":"gRPC/Messages/ObjectTypeIndexingDefinition/index","path":"/Frameworks/User-Interface-Extensibility-Framework/Reference/gRPC/Messages/ObjectTypeIndexingDefinition/","sidebar":"tutorialSidebar"},{"id":"gRPC/Messages/ObjectTypePermissionsForClient/index","path":"/Frameworks/User-Interface-Extensibility-Framework/Reference/gRPC/Messages/ObjectTypePermissionsForClient/","sidebar":"tutorialSidebar"},{"id":"gRPC/Messages/ObjectTypeSearchCharacteristics/index","path":"/Frameworks/User-Interface-Extensibility-Framework/Reference/gRPC/Messages/ObjectTypeSearchCharacteristics/","sidebar":"tutorialSidebar"},{"id":"gRPC/Messages/ObjectTypeTargetForBrowsing/index","path":"/Frameworks/User-Interface-Extensibility-Framework/Reference/gRPC/Messages/ObjectTypeTargetForBrowsing/","sidebar":"tutorialSidebar"},{"id":"gRPC/Messages/ObjectVersion/index","path":"/Frameworks/User-Interface-Extensibility-Framework/Reference/gRPC/Messages/ObjectVersion/","sidebar":"tutorialSidebar"},{"id":"gRPC/Messages/ObjectVersionActivity/index","path":"/Frameworks/User-Interface-Extensibility-Framework/Reference/gRPC/Messages/ObjectVersionActivity/","sidebar":"tutorialSidebar"},{"id":"gRPC/Messages/OBJECTVERSIONACTIVITYCATEGORYFLAGS/index","path":"/Frameworks/User-Interface-Extensibility-Framework/Reference/gRPC/Messages/OBJECTVERSIONACTIVITYCATEGORYFLAGS/","sidebar":"tutorialSidebar"},{"id":"gRPC/Messages/ObjectVersionActivityRequest/index","path":"/Frameworks/User-Interface-Extensibility-Framework/Reference/gRPC/Messages/ObjectVersionActivityRequest/","sidebar":"tutorialSidebar"},{"id":"gRPC/Messages/ObjectVersionActivityResponse/index","path":"/Frameworks/User-Interface-Extensibility-Framework/Reference/gRPC/Messages/ObjectVersionActivityResponse/","sidebar":"tutorialSidebar"},{"id":"gRPC/Messages/ObjectVersionAndPropertiesWithMetadata/index","path":"/Frameworks/User-Interface-Extensibility-Framework/Reference/gRPC/Messages/ObjectVersionAndPropertiesWithMetadata/","sidebar":"tutorialSidebar"},{"id":"gRPC/Messages/ObjectVersionData/index","path":"/Frameworks/User-Interface-Extensibility-Framework/Reference/gRPC/Messages/ObjectVersionData/","sidebar":"tutorialSidebar"},{"id":"gRPC/Messages/ObjectVersionDataRequest/index","path":"/Frameworks/User-Interface-Extensibility-Framework/Reference/gRPC/Messages/ObjectVersionDataRequest/","sidebar":"tutorialSidebar"},{"id":"gRPC/Messages/ObjectVersionDataResult/index","path":"/Frameworks/User-Interface-Extensibility-Framework/Reference/gRPC/Messages/ObjectVersionDataResult/","sidebar":"tutorialSidebar"},{"id":"gRPC/Messages/ObjectVersionEx/index","path":"/Frameworks/User-Interface-Extensibility-Framework/Reference/gRPC/Messages/ObjectVersionEx/","sidebar":"tutorialSidebar"},{"id":"gRPC/Messages/ObjectVersionExWP/index","path":"/Frameworks/User-Interface-Extensibility-Framework/Reference/gRPC/Messages/ObjectVersionExWP/","sidebar":"tutorialSidebar"},{"id":"gRPC/Messages/ObjectVersionFileActivity/index","path":"/Frameworks/User-Interface-Extensibility-Framework/Reference/gRPC/Messages/ObjectVersionFileActivity/","sidebar":"tutorialSidebar"},{"id":"gRPC/Messages/OBJECTVERSIONFILEACTIVITYFLAGS/index","path":"/Frameworks/User-Interface-Extensibility-Framework/Reference/gRPC/Messages/OBJECTVERSIONFILEACTIVITYFLAGS/","sidebar":"tutorialSidebar"},{"id":"gRPC/Messages/ObjectVersionPropertyActivity/index","path":"/Frameworks/User-Interface-Extensibility-Framework/Reference/gRPC/Messages/ObjectVersionPropertyActivity/","sidebar":"tutorialSidebar"},{"id":"gRPC/Messages/OBJECTVERSIONPROPERTYACTIVITYFLAGS/index","path":"/Frameworks/User-Interface-Extensibility-Framework/Reference/gRPC/Messages/OBJECTVERSIONPROPERTYACTIVITYFLAGS/","sidebar":"tutorialSidebar"},{"id":"gRPC/Messages/ObjFileSource/index","path":"/Frameworks/User-Interface-Extensibility-Framework/Reference/gRPC/Messages/ObjFileSource/","sidebar":"tutorialSidebar"},{"id":"gRPC/Messages/ObjFileSourceUnion/BlankTemplateData/index","path":"/Frameworks/User-Interface-Extensibility-Framework/Reference/gRPC/Messages/ObjFileSourceUnion/BlankTemplateData/","sidebar":"tutorialSidebar"},{"id":"gRPC/Messages/ObjFileSourceUnion/index","path":"/Frameworks/User-Interface-Extensibility-Framework/Reference/gRPC/Messages/ObjFileSourceUnion/","sidebar":"tutorialSidebar"},{"id":"gRPC/Messages/ObjFileSourceUnion/UndefinedSourceData/index","path":"/Frameworks/User-Interface-Extensibility-Framework/Reference/gRPC/Messages/ObjFileSourceUnion/UndefinedSourceData/","sidebar":"tutorialSidebar"},{"id":"gRPC/Messages/ObjFileSourceUnion/UploadedFileData/index","path":"/Frameworks/User-Interface-Extensibility-Framework/Reference/gRPC/Messages/ObjFileSourceUnion/UploadedFileData/","sidebar":"tutorialSidebar"},{"id":"gRPC/Messages/ObjFileSourceUnion/UploadedFilesData/index","path":"/Frameworks/User-Interface-Extensibility-Framework/Reference/gRPC/Messages/ObjFileSourceUnion/UploadedFilesData/","sidebar":"tutorialSidebar"},{"id":"gRPC/Messages/ObjFileSourceUnion/UserDefinedTemplateData/index","path":"/Frameworks/User-Interface-Extensibility-Framework/Reference/gRPC/Messages/ObjFileSourceUnion/UserDefinedTemplateData/","sidebar":"tutorialSidebar"},{"id":"gRPC/Messages/ObjFileVer/index","path":"/Frameworks/User-Interface-Extensibility-Framework/Reference/gRPC/Messages/ObjFileVer/","sidebar":"tutorialSidebar"},{"id":"gRPC/Messages/ObjID/index","path":"/Frameworks/User-Interface-Extensibility-Framework/Reference/gRPC/Messages/ObjID/","sidebar":"tutorialSidebar"},{"id":"gRPC/Messages/OBJTYPEFLAGS/index","path":"/Frameworks/User-Interface-Extensibility-Framework/Reference/gRPC/Messages/OBJTYPEFLAGS/","sidebar":"tutorialSidebar"},{"id":"gRPC/Messages/ObjVer/index","path":"/Frameworks/User-Interface-Extensibility-Framework/Reference/gRPC/Messages/ObjVer/","sidebar":"tutorialSidebar"},{"id":"gRPC/Messages/OBJVERFLAGS/index","path":"/Frameworks/User-Interface-Extensibility-Framework/Reference/gRPC/Messages/OBJVERFLAGS/","sidebar":"tutorialSidebar"},{"id":"gRPC/Messages/ObjVerVersion/index","path":"/Frameworks/User-Interface-Extensibility-Framework/Reference/gRPC/Messages/ObjVerVersion/","sidebar":"tutorialSidebar"},{"id":"gRPC/Messages/ObjVerWithProperties/index","path":"/Frameworks/User-Interface-Extensibility-Framework/Reference/gRPC/Messages/ObjVerWithProperties/","sidebar":"tutorialSidebar"},{"id":"gRPC/Messages/PropertyDef/index","path":"/Frameworks/User-Interface-Extensibility-Framework/Reference/gRPC/Messages/PropertyDef/","sidebar":"tutorialSidebar"},{"id":"gRPC/Messages/PROPERTYDEFFLAGS/index","path":"/Frameworks/User-Interface-Extensibility-Framework/Reference/gRPC/Messages/PROPERTYDEFFLAGS/","sidebar":"tutorialSidebar"},{"id":"gRPC/Messages/PropertyDefPermissionsForClient/index","path":"/Frameworks/User-Interface-Extensibility-Framework/Reference/gRPC/Messages/PropertyDefPermissionsForClient/","sidebar":"tutorialSidebar"},{"id":"gRPC/Messages/PropertyValue/index","path":"/Frameworks/User-Interface-Extensibility-Framework/Reference/gRPC/Messages/PropertyValue/","sidebar":"tutorialSidebar"},{"id":"gRPC/Messages/PropertyValueArray/index","path":"/Frameworks/User-Interface-Extensibility-Framework/Reference/gRPC/Messages/PropertyValueArray/","sidebar":"tutorialSidebar"},{"id":"gRPC/Messages/PropertyValueSuggestion/index","path":"/Frameworks/User-Interface-Extensibility-Framework/Reference/gRPC/Messages/PropertyValueSuggestion/","sidebar":"tutorialSidebar"},{"id":"gRPC/Messages/PropertyValueWithMetadata/index","path":"/Frameworks/User-Interface-Extensibility-Framework/Reference/gRPC/Messages/PropertyValueWithMetadata/","sidebar":"tutorialSidebar"},{"id":"gRPC/Messages/PropertyValueWithMetadataArray/index","path":"/Frameworks/User-Interface-Extensibility-Framework/Reference/gRPC/Messages/PropertyValueWithMetadataArray/","sidebar":"tutorialSidebar"},{"id":"gRPC/Messages/RelationshipData/index","path":"/Frameworks/User-Interface-Extensibility-Framework/Reference/gRPC/Messages/RelationshipData/","sidebar":"tutorialSidebar"},{"id":"gRPC/Messages/RelationshipGroup/index","path":"/Frameworks/User-Interface-Extensibility-Framework/Reference/gRPC/Messages/RelationshipGroup/","sidebar":"tutorialSidebar"},{"id":"gRPC/Messages/SearchCondition/index","path":"/Frameworks/User-Interface-Extensibility-Framework/Reference/gRPC/Messages/SearchCondition/","sidebar":"tutorialSidebar"},{"id":"gRPC/Messages/SearchConditionArray/index","path":"/Frameworks/User-Interface-Extensibility-Framework/Reference/gRPC/Messages/SearchConditionArray/","sidebar":"tutorialSidebar"},{"id":"gRPC/Messages/SearchDef/index","path":"/Frameworks/User-Interface-Extensibility-Framework/Reference/gRPC/Messages/SearchDef/","sidebar":"tutorialSidebar"},{"id":"gRPC/Messages/SearchFlags/index","path":"/Frameworks/User-Interface-Extensibility-Framework/Reference/gRPC/Messages/SearchFlags/","sidebar":"tutorialSidebar"},{"id":"gRPC/Messages/SearchOutputInfo/index","path":"/Frameworks/User-Interface-Extensibility-Framework/Reference/gRPC/Messages/SearchOutputInfo/","sidebar":"tutorialSidebar"},{"id":"gRPC/Messages/SearchResultsItem/index","path":"/Frameworks/User-Interface-Extensibility-Framework/Reference/gRPC/Messages/SearchResultsItem/","sidebar":"tutorialSidebar"},{"id":"gRPC/Messages/SearchResultsPageRequest/index","path":"/Frameworks/User-Interface-Extensibility-Framework/Reference/gRPC/Messages/SearchResultsPageRequest/","sidebar":"tutorialSidebar"},{"id":"gRPC/Messages/SearchResultsSorting/index","path":"/Frameworks/User-Interface-Extensibility-Framework/Reference/gRPC/Messages/SearchResultsSorting/","sidebar":"tutorialSidebar"},{"id":"gRPC/Messages/SEARCHSTATUSFLAGS/index","path":"/Frameworks/User-Interface-Extensibility-Framework/Reference/gRPC/Messages/SEARCHSTATUSFLAGS/","sidebar":"tutorialSidebar"},{"id":"gRPC/Messages/SearchTarget/index","path":"/Frameworks/User-Interface-Extensibility-Framework/Reference/gRPC/Messages/SearchTarget/","sidebar":"tutorialSidebar"},{"id":"gRPC/Messages/ServerVaultCapabilities/index","path":"/Frameworks/User-Interface-Extensibility-Framework/Reference/gRPC/Messages/ServerVaultCapabilities/","sidebar":"tutorialSidebar"},{"id":"gRPC/Messages/SessionInfo/index","path":"/Frameworks/User-Interface-Extensibility-Framework/Reference/gRPC/Messages/SessionInfo/","sidebar":"tutorialSidebar"},{"id":"gRPC/Messages/SetPropertiesParams/index","path":"/Frameworks/User-Interface-Extensibility-Framework/Reference/gRPC/Messages/SetPropertiesParams/","sidebar":"tutorialSidebar"},{"id":"gRPC/Messages/SortFlags/index","path":"/Frameworks/User-Interface-Extensibility-Framework/Reference/gRPC/Messages/SortFlags/","sidebar":"tutorialSidebar"},{"id":"gRPC/Messages/SortRule/index","path":"/Frameworks/User-Interface-Extensibility-Framework/Reference/gRPC/Messages/SortRule/","sidebar":"tutorialSidebar"},{"id":"gRPC/Messages/SortRuleFlags/index","path":"/Frameworks/User-Interface-Extensibility-Framework/Reference/gRPC/Messages/SortRuleFlags/","sidebar":"tutorialSidebar"},{"id":"gRPC/Messages/SortRuleValueArray/index","path":"/Frameworks/User-Interface-Extensibility-Framework/Reference/gRPC/Messages/SortRuleValueArray/","sidebar":"tutorialSidebar"},{"id":"gRPC/Messages/SRPREQUESTFLAGS/index","path":"/Frameworks/User-Interface-Extensibility-Framework/Reference/gRPC/Messages/SRPREQUESTFLAGS/","sidebar":"tutorialSidebar"},{"id":"gRPC/Messages/StateBasic/index","path":"/Frameworks/User-Interface-Extensibility-Framework/Reference/gRPC/Messages/StateBasic/","sidebar":"tutorialSidebar"},{"id":"gRPC/Messages/STATEFLAGS/index","path":"/Frameworks/User-Interface-Extensibility-Framework/Reference/gRPC/Messages/STATEFLAGS/","sidebar":"tutorialSidebar"},{"id":"gRPC/Messages/StateTransitionBasic/index","path":"/Frameworks/User-Interface-Extensibility-Framework/Reference/gRPC/Messages/StateTransitionBasic/","sidebar":"tutorialSidebar"},{"id":"gRPC/Messages/SubviewGroup/index","path":"/Frameworks/User-Interface-Extensibility-Framework/Reference/gRPC/Messages/SubviewGroup/","sidebar":"tutorialSidebar"},{"id":"gRPC/Messages/Template/index","path":"/Frameworks/User-Interface-Extensibility-Framework/Reference/gRPC/Messages/Template/","sidebar":"tutorialSidebar"},{"id":"gRPC/Messages/TypedValue/index","path":"/Frameworks/User-Interface-Extensibility-Framework/Reference/gRPC/Messages/TypedValue/","sidebar":"tutorialSidebar"},{"id":"gRPC/Messages/TypedValueMetadata/index","path":"/Frameworks/User-Interface-Extensibility-Framework/Reference/gRPC/Messages/TypedValueMetadata/","sidebar":"tutorialSidebar"},{"id":"gRPC/Messages/TypedValueUnion/index","path":"/Frameworks/User-Interface-Extensibility-Framework/Reference/gRPC/Messages/TypedValueUnion/","sidebar":"tutorialSidebar"},{"id":"gRPC/Messages/TypedValueUnionWithMetadata/index","path":"/Frameworks/User-Interface-Extensibility-Framework/Reference/gRPC/Messages/TypedValueUnionWithMetadata/","sidebar":"tutorialSidebar"},{"id":"gRPC/Messages/TypedValueWithMetadata/index","path":"/Frameworks/User-Interface-Extensibility-Framework/Reference/gRPC/Messages/TypedValueWithMetadata/","sidebar":"tutorialSidebar"},{"id":"gRPC/Messages/UploadedFile/index","path":"/Frameworks/User-Interface-Extensibility-Framework/Reference/gRPC/Messages/UploadedFile/","sidebar":"tutorialSidebar"},{"id":"gRPC/Messages/UploadedFileArray/index","path":"/Frameworks/User-Interface-Extensibility-Framework/Reference/gRPC/Messages/UploadedFileArray/","sidebar":"tutorialSidebar"},{"id":"gRPC/Messages/ValueList/index","path":"/Frameworks/User-Interface-Extensibility-Framework/Reference/gRPC/Messages/ValueList/","sidebar":"tutorialSidebar"},{"id":"gRPC/Messages/ValueListItem/index","path":"/Frameworks/User-Interface-Extensibility-Framework/Reference/gRPC/Messages/ValueListItem/","sidebar":"tutorialSidebar"},{"id":"gRPC/Messages/VersionComment/index","path":"/Frameworks/User-Interface-Extensibility-Framework/Reference/gRPC/Messages/VersionComment/","sidebar":"tutorialSidebar"},{"id":"gRPC/Messages/VersionCommentArray/index","path":"/Frameworks/User-Interface-Extensibility-Framework/Reference/gRPC/Messages/VersionCommentArray/","sidebar":"tutorialSidebar"},{"id":"gRPC/Messages/View/index","path":"/Frameworks/User-Interface-Extensibility-Framework/Reference/gRPC/Messages/View/","sidebar":"tutorialSidebar"},{"id":"gRPC/Messages/VIEWFLAGS/index","path":"/Frameworks/User-Interface-Extensibility-Framework/Reference/gRPC/Messages/VIEWFLAGS/","sidebar":"tutorialSidebar"},{"id":"gRPC/Messages/ViewLocation/index","path":"/Frameworks/User-Interface-Extensibility-Framework/Reference/gRPC/Messages/ViewLocation/","sidebar":"tutorialSidebar"},{"id":"gRPC/Messages/ViewVisualization/index","path":"/Frameworks/User-Interface-Extensibility-Framework/Reference/gRPC/Messages/ViewVisualization/","sidebar":"tutorialSidebar"},{"id":"gRPC/Messages/Workflow/index","path":"/Frameworks/User-Interface-Extensibility-Framework/Reference/gRPC/Messages/Workflow/","sidebar":"tutorialSidebar"},{"id":"gRPC/Messages/WorkflowBasic/index","path":"/Frameworks/User-Interface-Extensibility-Framework/Reference/gRPC/Messages/WorkflowBasic/","sidebar":"tutorialSidebar"},{"id":"Overview/ApplicationStructure","path":"/Frameworks/User-Interface-Extensibility-Framework/Reference/Overview/ApplicationStructure","sidebar":"tutorialSidebar"},{"id":"Overview/Commands","path":"/Frameworks/User-Interface-Extensibility-Framework/Reference/Overview/Commands","sidebar":"tutorialSidebar"},{"id":"Overview/Dashboards","path":"/Frameworks/User-Interface-Extensibility-Framework/Reference/Overview/Dashboards","sidebar":"tutorialSidebar"},{"id":"Overview/Debugging","path":"/Frameworks/User-Interface-Extensibility-Framework/Reference/Overview/Debugging","sidebar":"tutorialSidebar"},{"id":"Overview/Events","path":"/Frameworks/User-Interface-Extensibility-Framework/Reference/Overview/Events","sidebar":"tutorialSidebar"},{"id":"Overview/exceptions","path":"/Frameworks/User-Interface-Extensibility-Framework/Reference/Overview/exceptions","sidebar":"tutorialSidebar"},{"id":"Overview/InstallingApplications","path":"/Frameworks/User-Interface-Extensibility-Framework/Reference/Overview/InstallingApplications","sidebar":"tutorialSidebar"},{"id":"Overview/ListingView","path":"/Frameworks/User-Interface-Extensibility-Framework/Reference/Overview/ListingView","sidebar":"tutorialSidebar"},{"id":"Overview/Messages","path":"/Frameworks/User-Interface-Extensibility-Framework/Reference/Overview/Messages","sidebar":"tutorialSidebar"},{"id":"Overview/MFilesGlobalObject","path":"/Frameworks/User-Interface-Extensibility-Framework/Reference/Overview/MFilesGlobalObject","sidebar":"tutorialSidebar"},{"id":"Overview/Modules","path":"/Frameworks/User-Interface-Extensibility-Framework/Reference/Overview/Modules","sidebar":"tutorialSidebar"},{"id":"Overview/Overview","path":"/Frameworks/User-Interface-Extensibility-Framework/Reference/Overview/","sidebar":"tutorialSidebar"},{"id":"Overview/Tabs","path":"/Frameworks/User-Interface-Extensibility-Framework/Reference/Overview/Tabs","sidebar":"tutorialSidebar"},{"id":"Overview/VaultMessages","path":"/Frameworks/User-Interface-Extensibility-Framework/Reference/Overview/VaultMessages","sidebar":"tutorialSidebar"},{"id":"Samples/AssignToMe/index","path":"/Frameworks/User-Interface-Extensibility-Framework/Reference/Samples/AssignToMe/","sidebar":"tutorialSidebar"},{"id":"Samples/BuiltInCommands/index","path":"/Frameworks/User-Interface-Extensibility-Framework/Reference/Samples/BuiltInCommands/","sidebar":"tutorialSidebar"},{"id":"Samples/Commands/index","path":"/Frameworks/User-Interface-Extensibility-Framework/Reference/Samples/Commands/","sidebar":"tutorialSidebar"},{"id":"Samples/ErrorHandling/index","path":"/Frameworks/User-Interface-Extensibility-Framework/Reference/Samples/ErrorHandling/","sidebar":"tutorialSidebar"},{"id":"Samples/HelloWorld/index","path":"/Frameworks/User-Interface-Extensibility-Framework/Reference/Samples/HelloWorld/","sidebar":"tutorialSidebar"},{"id":"Samples/ObjectOperationSupport/index","path":"/Frameworks/User-Interface-Extensibility-Framework/Reference/Samples/ObjectOperationSupport/","sidebar":"tutorialSidebar"},{"id":"Samples/PopupDashboard/index","path":"/Frameworks/User-Interface-Extensibility-Framework/Reference/Samples/PopupDashboard/","sidebar":"tutorialSidebar"},{"id":"Samples/PopUpDashboardWithAccentColor/index","path":"/Frameworks/User-Interface-Extensibility-Framework/Reference/Samples/PopUpDashboardWithAccentColor/","sidebar":"tutorialSidebar"},{"id":"Samples/Samples","path":"/Frameworks/User-Interface-Extensibility-Framework/Reference/Samples/","sidebar":"tutorialSidebar"},{"id":"Samples/SandboxAttributesSupport/index","path":"/Frameworks/User-Interface-Extensibility-Framework/Reference/Samples/SandboxAttributesSupport/","sidebar":"tutorialSidebar"},{"id":"Samples/SearchFolderExamples/index","path":"/Frameworks/User-Interface-Extensibility-Framework/Reference/Samples/SearchFolderExamples/","sidebar":"tutorialSidebar"},{"id":"Samples/ShellFrameAndDashboard/index","path":"/Frameworks/User-Interface-Extensibility-Framework/Reference/Samples/ShellFrameAndDashboard/","sidebar":"tutorialSidebar"},{"id":"Samples/ShowNewObjectWindow With Blank and UserDefined Template/index","path":"/Frameworks/User-Interface-Extensibility-Framework/Reference/Samples/ShowNewObjectWindow With Blank and UserDefined Template/","sidebar":"tutorialSidebar"},{"id":"Samples/TaskbarCommands/index","path":"/Frameworks/User-Interface-Extensibility-Framework/Reference/Samples/TaskbarCommands/","sidebar":"tutorialSidebar"},{"id":"Samples/VaultMessagesPackage/index","path":"/Frameworks/User-Interface-Extensibility-Framework/Reference/Samples/VaultMessagesPackage/","sidebar":"tutorialSidebar"},{"id":"UIExt2/Enums/BuiltinCommand/index","path":"/Frameworks/User-Interface-Extensibility-Framework/Reference/UIExt2/Enums/BuiltinCommand/","sidebar":"tutorialSidebar"},{"id":"UIExt2/Enums/BuiltInIcon/index","path":"/Frameworks/User-Interface-Extensibility-Framework/Reference/UIExt2/Enums/BuiltInIcon/","sidebar":"tutorialSidebar"},{"id":"UIExt2/Enums/CommandLocation/index","path":"/Frameworks/User-Interface-Extensibility-Framework/Reference/UIExt2/Enums/CommandLocation/","sidebar":"tutorialSidebar"},{"id":"UIExt2/Enums/CommandState/index","path":"/Frameworks/User-Interface-Extensibility-Framework/Reference/UIExt2/Enums/CommandState/","sidebar":"tutorialSidebar"},{"id":"UIExt2/Enums/Event/index","path":"/Frameworks/User-Interface-Extensibility-Framework/Reference/UIExt2/Enums/Event/","sidebar":"tutorialSidebar"},{"id":"UIExt2/Enums/FacetRangeType/index","path":"/Frameworks/User-Interface-Extensibility-Framework/Reference/UIExt2/Enums/FacetRangeType/","sidebar":"tutorialSidebar"},{"id":"UIExt2/Enums/FacetTransformation/index","path":"/Frameworks/User-Interface-Extensibility-Framework/Reference/UIExt2/Enums/FacetTransformation/","sidebar":"tutorialSidebar"},{"id":"UIExt2/Enums/FacetType/index","path":"/Frameworks/User-Interface-Extensibility-Framework/Reference/UIExt2/Enums/FacetType/","sidebar":"tutorialSidebar"},{"id":"UIExt2/Enums/FacetValueType/index","path":"/Frameworks/User-Interface-Extensibility-Framework/Reference/UIExt2/Enums/FacetValueType/","sidebar":"tutorialSidebar"},{"id":"UIExt2/Enums/IconContentType/index","path":"/Frameworks/User-Interface-Extensibility-Framework/Reference/UIExt2/Enums/IconContentType/","sidebar":"tutorialSidebar"},{"id":"UIExt2/Enums/index","path":"/Frameworks/User-Interface-Extensibility-Framework/Reference/UIExt2/Enums/","sidebar":"tutorialSidebar"},{"id":"UIExt2/Enums/MenuLocation/index","path":"/Frameworks/User-Interface-Extensibility-Framework/Reference/UIExt2/Enums/MenuLocation/","sidebar":"tutorialSidebar"},{"id":"UIExt2/Enums/MFBuiltInObjectType/index","path":"/Frameworks/User-Interface-Extensibility-Framework/Reference/UIExt2/Enums/MFBuiltInObjectType/","sidebar":"tutorialSidebar"},{"id":"UIExt2/Enums/MFBuiltInPropertyDef/index","path":"/Frameworks/User-Interface-Extensibility-Framework/Reference/UIExt2/Enums/MFBuiltInPropertyDef/","sidebar":"tutorialSidebar"},{"id":"UIExt2/Enums/MFBuiltInValueList/index","path":"/Frameworks/User-Interface-Extensibility-Framework/Reference/UIExt2/Enums/MFBuiltInValueList/","sidebar":"tutorialSidebar"},{"id":"UIExt2/Enums/MFBuiltInView/index","path":"/Frameworks/User-Interface-Extensibility-Framework/Reference/UIExt2/Enums/MFBuiltInView/","sidebar":"tutorialSidebar"},{"id":"UIExt2/Enums/ObjectWindowResultCode/index","path":"/Frameworks/User-Interface-Extensibility-Framework/Reference/UIExt2/Enums/ObjectWindowResultCode/","sidebar":"tutorialSidebar"},{"id":"UIExt2/Enums/SearchEngine/index","path":"/Frameworks/User-Interface-Extensibility-Framework/Reference/UIExt2/Enums/SearchEngine/","sidebar":"tutorialSidebar"},{"id":"UIExt2/Enums/ToastType/index","path":"/Frameworks/User-Interface-Extensibility-Framework/Reference/UIExt2/Enums/ToastType/","sidebar":"tutorialSidebar"},{"id":"UIExt2/Events","path":"/Frameworks/User-Interface-Extensibility-Framework/Reference/UIExt2/Events","sidebar":"tutorialSidebar"},{"id":"UIExt2/Interfaces/ICommands/AddCustomCommandToMenu/index","path":"/Frameworks/User-Interface-Extensibility-Framework/Reference/UIExt2/Interfaces/ICommands/AddCustomCommandToMenu/","sidebar":"tutorialSidebar"},{"id":"UIExt2/Interfaces/ICommands/CreateCustomCommand/index","path":"/Frameworks/User-Interface-Extensibility-Framework/Reference/UIExt2/Interfaces/ICommands/CreateCustomCommand/","sidebar":"tutorialSidebar"},{"id":"UIExt2/Interfaces/ICommands/CreateSubMenuItem/index","path":"/Frameworks/User-Interface-Extensibility-Framework/Reference/UIExt2/Interfaces/ICommands/CreateSubMenuItem/","sidebar":"tutorialSidebar"},{"id":"UIExt2/Interfaces/ICommands/CreateTaskbarGroup/index","path":"/Frameworks/User-Interface-Extensibility-Framework/Reference/UIExt2/Interfaces/ICommands/CreateTaskbarGroup/","sidebar":"tutorialSidebar"},{"id":"UIExt2/Interfaces/ICommands/DeleteCustomCommand/index","path":"/Frameworks/User-Interface-Extensibility-Framework/Reference/UIExt2/Interfaces/ICommands/DeleteCustomCommand/","sidebar":"tutorialSidebar"},{"id":"UIExt2/Interfaces/ICommands/ExecuteCommand/index","path":"/Frameworks/User-Interface-Extensibility-Framework/Reference/UIExt2/Interfaces/ICommands/ExecuteCommand/","sidebar":"tutorialSidebar"},{"id":"UIExt2/Interfaces/ICommands/GetCommandName/index","path":"/Frameworks/User-Interface-Extensibility-Framework/Reference/UIExt2/Interfaces/ICommands/GetCommandName/","sidebar":"tutorialSidebar"},{"id":"UIExt2/Interfaces/ICommands/GetCommandState/index","path":"/Frameworks/User-Interface-Extensibility-Framework/Reference/UIExt2/Interfaces/ICommands/GetCommandState/","sidebar":"tutorialSidebar"},{"id":"UIExt2/Interfaces/ICommands/GetMenuIdOfBuiltInCommand/index","path":"/Frameworks/User-Interface-Extensibility-Framework/Reference/UIExt2/Interfaces/ICommands/GetMenuIdOfBuiltInCommand/","sidebar":"tutorialSidebar"},{"id":"UIExt2/Interfaces/ICommands/index","path":"/Frameworks/User-Interface-Extensibility-Framework/Reference/UIExt2/Interfaces/ICommands/","sidebar":"tutorialSidebar"},{"id":"UIExt2/Interfaces/ICommands/RemoveCustomCommandFromMenu/index","path":"/Frameworks/User-Interface-Extensibility-Framework/Reference/UIExt2/Interfaces/ICommands/RemoveCustomCommandFromMenu/","sidebar":"tutorialSidebar"},{"id":"UIExt2/Interfaces/ICommands/RemoveMenuItem/index","path":"/Frameworks/User-Interface-Extensibility-Framework/Reference/UIExt2/Interfaces/ICommands/RemoveMenuItem/","sidebar":"tutorialSidebar"},{"id":"UIExt2/Interfaces/ICommands/RemoveTaskbarGroup/index","path":"/Frameworks/User-Interface-Extensibility-Framework/Reference/UIExt2/Interfaces/ICommands/RemoveTaskbarGroup/","sidebar":"tutorialSidebar"},{"id":"UIExt2/Interfaces/ICommands/SetCommandState/index","path":"/Frameworks/User-Interface-Extensibility-Framework/Reference/UIExt2/Interfaces/ICommands/SetCommandState/","sidebar":"tutorialSidebar"},{"id":"UIExt2/Interfaces/ICommands/SetIcon/index","path":"/Frameworks/User-Interface-Extensibility-Framework/Reference/UIExt2/Interfaces/ICommands/SetIcon/","sidebar":"tutorialSidebar"},{"id":"UIExt2/Interfaces/ICommands/SetMenuItemState/index","path":"/Frameworks/User-Interface-Extensibility-Framework/Reference/UIExt2/Interfaces/ICommands/SetMenuItemState/","sidebar":"tutorialSidebar"},{"id":"UIExt2/Interfaces/ICommands/SetTaskbarGroupIcon/index","path":"/Frameworks/User-Interface-Extensibility-Framework/Reference/UIExt2/Interfaces/ICommands/SetTaskbarGroupIcon/","sidebar":"tutorialSidebar"},{"id":"UIExt2/Interfaces/ICommonFunctions/DeleteFromWebStorage/index","path":"/Frameworks/User-Interface-Extensibility-Framework/Reference/UIExt2/Interfaces/ICommonFunctions/DeleteFromWebStorage/","sidebar":"tutorialSidebar"},{"id":"UIExt2/Interfaces/ICommonFunctions/DownloadFileAsDataUri/index","path":"/Frameworks/User-Interface-Extensibility-Framework/Reference/UIExt2/Interfaces/ICommonFunctions/DownloadFileAsDataUri/","sidebar":"tutorialSidebar"},{"id":"UIExt2/Interfaces/ICommonFunctions/GetAccentColor/index","path":"/Frameworks/User-Interface-Extensibility-Framework/Reference/UIExt2/Interfaces/ICommonFunctions/GetAccentColor/","sidebar":"tutorialSidebar"},{"id":"UIExt2/Interfaces/ICommonFunctions/GetClientLanguage/index","path":"/Frameworks/User-Interface-Extensibility-Framework/Reference/UIExt2/Interfaces/ICommonFunctions/GetClientLanguage/","sidebar":"tutorialSidebar"},{"id":"UIExt2/Interfaces/ICommonFunctions/GetClientLocale/index","path":"/Frameworks/User-Interface-Extensibility-Framework/Reference/UIExt2/Interfaces/ICommonFunctions/GetClientLocale/","sidebar":"tutorialSidebar"},{"id":"UIExt2/Interfaces/ICommonFunctions/GetClientLocaleIn3Letters/index","path":"/Frameworks/User-Interface-Extensibility-Framework/Reference/UIExt2/Interfaces/ICommonFunctions/GetClientLocaleIn3Letters/","sidebar":"tutorialSidebar"},{"id":"UIExt2/Interfaces/ICommonFunctions/GetSessionInfo/index","path":"/Frameworks/User-Interface-Extensibility-Framework/Reference/UIExt2/Interfaces/ICommonFunctions/GetSessionInfo/","sidebar":"tutorialSidebar"},{"id":"UIExt2/Interfaces/ICommonFunctions/GetUTCOffset/index","path":"/Frameworks/User-Interface-Extensibility-Framework/Reference/UIExt2/Interfaces/ICommonFunctions/GetUTCOffset/","sidebar":"tutorialSidebar"},{"id":"UIExt2/Interfaces/ICommonFunctions/GetVaultInfo/index","path":"/Frameworks/User-Interface-Extensibility-Framework/Reference/UIExt2/Interfaces/ICommonFunctions/GetVaultInfo/","sidebar":"tutorialSidebar"},{"id":"UIExt2/Interfaces/ICommonFunctions/GetWebLink/index","path":"/Frameworks/User-Interface-Extensibility-Framework/Reference/UIExt2/Interfaces/ICommonFunctions/GetWebLink/","sidebar":"tutorialSidebar"},{"id":"UIExt2/Interfaces/ICommonFunctions/index","path":"/Frameworks/User-Interface-Extensibility-Framework/Reference/UIExt2/Interfaces/ICommonFunctions/","sidebar":"tutorialSidebar"},{"id":"UIExt2/Interfaces/ICommonFunctions/OpenExternalWebLink/index","path":"/Frameworks/User-Interface-Extensibility-Framework/Reference/UIExt2/Interfaces/ICommonFunctions/OpenExternalWebLink/","sidebar":"tutorialSidebar"},{"id":"UIExt2/Interfaces/ICommonFunctions/ReadFromWebStorage/index","path":"/Frameworks/User-Interface-Extensibility-Framework/Reference/UIExt2/Interfaces/ICommonFunctions/ReadFromWebStorage/","sidebar":"tutorialSidebar"},{"id":"UIExt2/Interfaces/ICommonFunctions/ReportException/index","path":"/Frameworks/User-Interface-Extensibility-Framework/Reference/UIExt2/Interfaces/ICommonFunctions/ReportException/","sidebar":"tutorialSidebar"},{"id":"UIExt2/Interfaces/ICommonFunctions/ShowEditObjectWindow/index","path":"/Frameworks/User-Interface-Extensibility-Framework/Reference/UIExt2/Interfaces/ICommonFunctions/ShowEditObjectWindow/","sidebar":"tutorialSidebar"},{"id":"UIExt2/Interfaces/ICommonFunctions/ShowNewObjectWindow/index","path":"/Frameworks/User-Interface-Extensibility-Framework/Reference/UIExt2/Interfaces/ICommonFunctions/ShowNewObjectWindow/","sidebar":"tutorialSidebar"},{"id":"UIExt2/Interfaces/ICommonFunctions/ShowToast/index","path":"/Frameworks/User-Interface-Extensibility-Framework/Reference/UIExt2/Interfaces/ICommonFunctions/ShowToast/","sidebar":"tutorialSidebar"},{"id":"UIExt2/Interfaces/ICommonFunctions/UploadTemporaryFiles/index","path":"/Frameworks/User-Interface-Extensibility-Framework/Reference/UIExt2/Interfaces/ICommonFunctions/UploadTemporaryFiles/","sidebar":"tutorialSidebar"},{"id":"UIExt2/Interfaces/ICommonFunctions/WriteToWebStorage/index","path":"/Frameworks/User-Interface-Extensibility-Framework/Reference/UIExt2/Interfaces/ICommonFunctions/WriteToWebStorage/","sidebar":"tutorialSidebar"},{"id":"UIExt2/Interfaces/IDashboard/GetSandboxAttributes/index","path":"/Frameworks/User-Interface-Extensibility-Framework/Reference/UIExt2/Interfaces/IDashboard/GetSandboxAttributes/","sidebar":"tutorialSidebar"},{"id":"UIExt2/Interfaces/IDashboard/index","path":"/Frameworks/User-Interface-Extensibility-Framework/Reference/UIExt2/Interfaces/IDashboard/","sidebar":"tutorialSidebar"},{"id":"UIExt2/Interfaces/IDashboard/ShowMessage/index","path":"/Frameworks/User-Interface-Extensibility-Framework/Reference/UIExt2/Interfaces/IDashboard/ShowMessage/","sidebar":"tutorialSidebar"},{"id":"UIExt2/Interfaces/IDashboard/ShowPopupDashboard/index","path":"/Frameworks/User-Interface-Extensibility-Framework/Reference/UIExt2/Interfaces/IDashboard/ShowPopupDashboard/","sidebar":"tutorialSidebar"},{"id":"UIExt2/Interfaces/IDashboard/UpdateCustomData/index","path":"/Frameworks/User-Interface-Extensibility-Framework/Reference/UIExt2/Interfaces/IDashboard/UpdateCustomData/","sidebar":"tutorialSidebar"},{"id":"UIExt2/Interfaces/IDashboard/WaitForClose/index","path":"/Frameworks/User-Interface-Extensibility-Framework/Reference/UIExt2/Interfaces/IDashboard/WaitForClose/","sidebar":"tutorialSidebar"},{"id":"UIExt2/Interfaces/IEvents/index","path":"/Frameworks/User-Interface-Extensibility-Framework/Reference/UIExt2/Interfaces/IEvents/","sidebar":"tutorialSidebar"},{"id":"UIExt2/Interfaces/IEvents/Register/index","path":"/Frameworks/User-Interface-Extensibility-Framework/Reference/UIExt2/Interfaces/IEvents/Register/","sidebar":"tutorialSidebar"},{"id":"UIExt2/Interfaces/IEvents/RegisterBuiltinCommand/index","path":"/Frameworks/User-Interface-Extensibility-Framework/Reference/UIExt2/Interfaces/IEvents/RegisterBuiltinCommand/","sidebar":"tutorialSidebar"},{"id":"UIExt2/Interfaces/IEvents/Unregister/index","path":"/Frameworks/User-Interface-Extensibility-Framework/Reference/UIExt2/Interfaces/IEvents/Unregister/","sidebar":"tutorialSidebar"},{"id":"UIExt2/Interfaces/index","path":"/Frameworks/User-Interface-Extensibility-Framework/Reference/UIExt2/Interfaces/","sidebar":"tutorialSidebar"},{"id":"UIExt2/Interfaces/ISearchPane/GetOptions/index","path":"/Frameworks/User-Interface-Extensibility-Framework/Reference/UIExt2/Interfaces/ISearchPane/GetOptions/","sidebar":"tutorialSidebar"},{"id":"UIExt2/Interfaces/ISearchPane/GetSearchCriteria/index","path":"/Frameworks/User-Interface-Extensibility-Framework/Reference/UIExt2/Interfaces/ISearchPane/GetSearchCriteria/","sidebar":"tutorialSidebar"},{"id":"UIExt2/Interfaces/ISearchPane/index","path":"/Frameworks/User-Interface-Extensibility-Framework/Reference/UIExt2/Interfaces/ISearchPane/","sidebar":"tutorialSidebar"},{"id":"UIExt2/Interfaces/ISearchPane/IsSearchView/index","path":"/Frameworks/User-Interface-Extensibility-Framework/Reference/UIExt2/Interfaces/ISearchPane/IsSearchView/","sidebar":"tutorialSidebar"},{"id":"UIExt2/Interfaces/ISearchPane/SetOptionState/index","path":"/Frameworks/User-Interface-Extensibility-Framework/Reference/UIExt2/Interfaces/ISearchPane/SetOptionState/","sidebar":"tutorialSidebar"},{"id":"UIExt2/Interfaces/ISearchPane/SetSearchCriteria/index","path":"/Frameworks/User-Interface-Extensibility-Framework/Reference/UIExt2/Interfaces/ISearchPane/SetSearchCriteria/","sidebar":"tutorialSidebar"},{"id":"UIExt2/Interfaces/IShellFrame/CallSimplifiedAPI/index","path":"/Frameworks/User-Interface-Extensibility-Framework/Reference/UIExt2/Interfaces/IShellFrame/CallSimplifiedAPI/","sidebar":"tutorialSidebar"},{"id":"UIExt2/Interfaces/IShellFrame/GetSandboxAttributes/index","path":"/Frameworks/User-Interface-Extensibility-Framework/Reference/UIExt2/Interfaces/IShellFrame/GetSandboxAttributes/","sidebar":"tutorialSidebar"},{"id":"UIExt2/Interfaces/IShellFrame/GetViewsById/index","path":"/Frameworks/User-Interface-Extensibility-Framework/Reference/UIExt2/Interfaces/IShellFrame/GetViewsById/","sidebar":"tutorialSidebar"},{"id":"UIExt2/Interfaces/IShellFrame/index","path":"/Frameworks/User-Interface-Extensibility-Framework/Reference/UIExt2/Interfaces/IShellFrame/","sidebar":"tutorialSidebar"},{"id":"UIExt2/Interfaces/IShellFrame/IsFolderLocation/index","path":"/Frameworks/User-Interface-Extensibility-Framework/Reference/UIExt2/Interfaces/IShellFrame/IsFolderLocation/","sidebar":"tutorialSidebar"},{"id":"UIExt2/Interfaces/IShellFrame/IsObjectLocation/index","path":"/Frameworks/User-Interface-Extensibility-Framework/Reference/UIExt2/Interfaces/IShellFrame/IsObjectLocation/","sidebar":"tutorialSidebar"},{"id":"UIExt2/Interfaces/IShellFrame/NavigateToFolder/index","path":"/Frameworks/User-Interface-Extensibility-Framework/Reference/UIExt2/Interfaces/IShellFrame/NavigateToFolder/","sidebar":"tutorialSidebar"},{"id":"UIExt2/Interfaces/IShellFrame/NavigateToObject/index","path":"/Frameworks/User-Interface-Extensibility-Framework/Reference/UIExt2/Interfaces/IShellFrame/NavigateToObject/","sidebar":"tutorialSidebar"},{"id":"UIExt2/Interfaces/IShellFrame/NavigateToParent/index","path":"/Frameworks/User-Interface-Extensibility-Framework/Reference/UIExt2/Interfaces/IShellFrame/NavigateToParent/","sidebar":"tutorialSidebar"},{"id":"UIExt2/Interfaces/IShellFrame/ShowDashboard/index","path":"/Frameworks/User-Interface-Extensibility-Framework/Reference/UIExt2/Interfaces/IShellFrame/ShowDashboard/","sidebar":"tutorialSidebar"},{"id":"UIExt2/Interfaces/IShellFrame/ShowDefaultContent/index","path":"/Frameworks/User-Interface-Extensibility-Framework/Reference/UIExt2/Interfaces/IShellFrame/ShowDefaultContent/","sidebar":"tutorialSidebar"},{"id":"UIExt2/Interfaces/IShellFrame/ShowMessage/index","path":"/Frameworks/User-Interface-Extensibility-Framework/Reference/UIExt2/Interfaces/IShellFrame/ShowMessage/","sidebar":"tutorialSidebar"},{"id":"UIExt2/Interfaces/IShellFrame/ShowPopupDashboard/index","path":"/Frameworks/User-Interface-Extensibility-Framework/Reference/UIExt2/Interfaces/IShellFrame/ShowPopupDashboard/","sidebar":"tutorialSidebar"},{"id":"UIExt2/Interfaces/IShellFrame/ShowPopupDashboards/index","path":"/Frameworks/User-Interface-Extensibility-Framework/Reference/UIExt2/Interfaces/IShellFrame/ShowPopupDashboards/","sidebar":"tutorialSidebar"},{"id":"UIExt2/Interfaces/IShellItems/GetFoldersCount/index","path":"/Frameworks/User-Interface-Extensibility-Framework/Reference/UIExt2/Interfaces/IShellItems/GetFoldersCount/","sidebar":"tutorialSidebar"},{"id":"UIExt2/Interfaces/IShellItems/GetObjectVersionsAndProperties/index","path":"/Frameworks/User-Interface-Extensibility-Framework/Reference/UIExt2/Interfaces/IShellItems/GetObjectVersionsAndProperties/","sidebar":"tutorialSidebar"},{"id":"UIExt2/Interfaces/IShellItems/GetObjectVersionsCount/index","path":"/Frameworks/User-Interface-Extensibility-Framework/Reference/UIExt2/Interfaces/IShellItems/GetObjectVersionsCount/","sidebar":"tutorialSidebar"},{"id":"UIExt2/Interfaces/IShellItems/index","path":"/Frameworks/User-Interface-Extensibility-Framework/Reference/UIExt2/Interfaces/IShellItems/","sidebar":"tutorialSidebar"},{"id":"UIExt2/Interfaces/IShellListing/ActivateListing/index","path":"/Frameworks/User-Interface-Extensibility-Framework/Reference/UIExt2/Interfaces/IShellListing/ActivateListing/","sidebar":"tutorialSidebar"},{"id":"UIExt2/Interfaces/IShellListing/ActivateSelected/index","path":"/Frameworks/User-Interface-Extensibility-Framework/Reference/UIExt2/Interfaces/IShellListing/ActivateSelected/","sidebar":"tutorialSidebar"},{"id":"UIExt2/Interfaces/IShellListing/AddListingItem/index","path":"/Frameworks/User-Interface-Extensibility-Framework/Reference/UIExt2/Interfaces/IShellListing/AddListingItem/","sidebar":"tutorialSidebar"},{"id":"UIExt2/Interfaces/IShellListing/AddObjectFile/index","path":"/Frameworks/User-Interface-Extensibility-Framework/Reference/UIExt2/Interfaces/IShellListing/AddObjectFile/","sidebar":"tutorialSidebar"},{"id":"UIExt2/Interfaces/IShellListing/GetFolderName/index","path":"/Frameworks/User-Interface-Extensibility-Framework/Reference/UIExt2/Interfaces/IShellListing/GetFolderName/","sidebar":"tutorialSidebar"},{"id":"UIExt2/Interfaces/IShellListing/index","path":"/Frameworks/User-Interface-Extensibility-Framework/Reference/UIExt2/Interfaces/IShellListing/","sidebar":"tutorialSidebar"},{"id":"UIExt2/Interfaces/IShellListing/RefreshListing/index","path":"/Frameworks/User-Interface-Extensibility-Framework/Reference/UIExt2/Interfaces/IShellListing/RefreshListing/","sidebar":"tutorialSidebar"},{"id":"UIExt2/Interfaces/IShellListing/RefreshObject/index","path":"/Frameworks/User-Interface-Extensibility-Framework/Reference/UIExt2/Interfaces/IShellListing/RefreshObject/","sidebar":"tutorialSidebar"},{"id":"UIExt2/Interfaces/IShellListing/RemoveListingItem/index","path":"/Frameworks/User-Interface-Extensibility-Framework/Reference/UIExt2/Interfaces/IShellListing/RemoveListingItem/","sidebar":"tutorialSidebar"},{"id":"UIExt2/Interfaces/IShellListing/ReplaceFile/index","path":"/Frameworks/User-Interface-Extensibility-Framework/Reference/UIExt2/Interfaces/IShellListing/ReplaceFile/","sidebar":"tutorialSidebar"},{"id":"UIExt2/Interfaces/IShellListing/SelectFolder/index","path":"/Frameworks/User-Interface-Extensibility-Framework/Reference/UIExt2/Interfaces/IShellListing/SelectFolder/","sidebar":"tutorialSidebar"},{"id":"UIExt2/Interfaces/IShellListing/SelectNextFolder/index","path":"/Frameworks/User-Interface-Extensibility-Framework/Reference/UIExt2/Interfaces/IShellListing/SelectNextFolder/","sidebar":"tutorialSidebar"},{"id":"UIExt2/Interfaces/IShellListing/SelectNextObject/index","path":"/Frameworks/User-Interface-Extensibility-Framework/Reference/UIExt2/Interfaces/IShellListing/SelectNextObject/","sidebar":"tutorialSidebar"},{"id":"UIExt2/Interfaces/IShellListing/SelectNextObjectFile/index","path":"/Frameworks/User-Interface-Extensibility-Framework/Reference/UIExt2/Interfaces/IShellListing/SelectNextObjectFile/","sidebar":"tutorialSidebar"},{"id":"UIExt2/Interfaces/IShellListing/SelectObjectFile/index","path":"/Frameworks/User-Interface-Extensibility-Framework/Reference/UIExt2/Interfaces/IShellListing/SelectObjectFile/","sidebar":"tutorialSidebar"},{"id":"UIExt2/Interfaces/IShellListing/SelectObjectOrObjectFileVersion/index","path":"/Frameworks/User-Interface-Extensibility-Framework/Reference/UIExt2/Interfaces/IShellListing/SelectObjectOrObjectFileVersion/","sidebar":"tutorialSidebar"},{"id":"UIExt2/Interfaces/IShellListing/SelectObjectVersion/index","path":"/Frameworks/User-Interface-Extensibility-Framework/Reference/UIExt2/Interfaces/IShellListing/SelectObjectVersion/","sidebar":"tutorialSidebar"},{"id":"UIExt2/Interfaces/IShellListing/SelectPrevFolder/index","path":"/Frameworks/User-Interface-Extensibility-Framework/Reference/UIExt2/Interfaces/IShellListing/SelectPrevFolder/","sidebar":"tutorialSidebar"},{"id":"UIExt2/Interfaces/IShellListing/SelectPrevObject/index","path":"/Frameworks/User-Interface-Extensibility-Framework/Reference/UIExt2/Interfaces/IShellListing/SelectPrevObject/","sidebar":"tutorialSidebar"},{"id":"UIExt2/Interfaces/IShellListing/SelectPrevObjectFile/index","path":"/Frameworks/User-Interface-Extensibility-Framework/Reference/UIExt2/Interfaces/IShellListing/SelectPrevObjectFile/","sidebar":"tutorialSidebar"},{"id":"UIExt2/Interfaces/IShellListing/SetFolderOrObjectVersionSelectionStates/index","path":"/Frameworks/User-Interface-Extensibility-Framework/Reference/UIExt2/Interfaces/IShellListing/SetFolderOrObjectVersionSelectionStates/","sidebar":"tutorialSidebar"},{"id":"UIExt2/Interfaces/IShellListing/SetFolderSelectionStates/index","path":"/Frameworks/User-Interface-Extensibility-Framework/Reference/UIExt2/Interfaces/IShellListing/SetFolderSelectionStates/","sidebar":"tutorialSidebar"},{"id":"UIExt2/Interfaces/IShellListing/SetObjectOrObjectFileVersionSelectionStates/index","path":"/Frameworks/User-Interface-Extensibility-Framework/Reference/UIExt2/Interfaces/IShellListing/SetObjectOrObjectFileVersionSelectionStates/","sidebar":"tutorialSidebar"},{"id":"UIExt2/Interfaces/IShellListing/SetObjectVersionSelectionStates/index","path":"/Frameworks/User-Interface-Extensibility-Framework/Reference/UIExt2/Interfaces/IShellListing/SetObjectVersionSelectionStates/","sidebar":"tutorialSidebar"},{"id":"UIExt2/Interfaces/IShellListing/SetVirtualSelection/index","path":"/Frameworks/User-Interface-Extensibility-Framework/Reference/UIExt2/Interfaces/IShellListing/SetVirtualSelection/","sidebar":"tutorialSidebar"},{"id":"UIExt2/Interfaces/IShellListing/UnselectAll/index","path":"/Frameworks/User-Interface-Extensibility-Framework/Reference/UIExt2/Interfaces/IShellListing/UnselectAll/","sidebar":"tutorialSidebar"},{"id":"UIExt2/Interfaces/IShellListing/UpdateListingItem/index","path":"/Frameworks/User-Interface-Extensibility-Framework/Reference/UIExt2/Interfaces/IShellListing/UpdateListingItem/","sidebar":"tutorialSidebar"},{"id":"UIExt2/Interfaces/IShellPaneContainer/AddTab/index","path":"/Frameworks/User-Interface-Extensibility-Framework/Reference/UIExt2/Interfaces/IShellPaneContainer/AddTab/","sidebar":"tutorialSidebar"},{"id":"UIExt2/Interfaces/IShellPaneContainer/GetSelectedTabs/index","path":"/Frameworks/User-Interface-Extensibility-Framework/Reference/UIExt2/Interfaces/IShellPaneContainer/GetSelectedTabs/","sidebar":"tutorialSidebar"},{"id":"UIExt2/Interfaces/IShellPaneContainer/GetTab/index","path":"/Frameworks/User-Interface-Extensibility-Framework/Reference/UIExt2/Interfaces/IShellPaneContainer/GetTab/","sidebar":"tutorialSidebar"},{"id":"UIExt2/Interfaces/IShellPaneContainer/index","path":"/Frameworks/User-Interface-Extensibility-Framework/Reference/UIExt2/Interfaces/IShellPaneContainer/","sidebar":"tutorialSidebar"},{"id":"UIExt2/Interfaces/IShellPaneTab/index","path":"/Frameworks/User-Interface-Extensibility-Framework/Reference/UIExt2/Interfaces/IShellPaneTab/","sidebar":"tutorialSidebar"},{"id":"UIExt2/Interfaces/IShellPaneTab/Remove/index","path":"/Frameworks/User-Interface-Extensibility-Framework/Reference/UIExt2/Interfaces/IShellPaneTab/Remove/","sidebar":"tutorialSidebar"},{"id":"UIExt2/Interfaces/IShellPaneTab/Select/index","path":"/Frameworks/User-Interface-Extensibility-Framework/Reference/UIExt2/Interfaces/IShellPaneTab/Select/","sidebar":"tutorialSidebar"},{"id":"UIExt2/Interfaces/IShellPaneTab/SetVisible/index","path":"/Frameworks/User-Interface-Extensibility-Framework/Reference/UIExt2/Interfaces/IShellPaneTab/SetVisible/","sidebar":"tutorialSidebar"},{"id":"UIExt2/Interfaces/IShellPaneTab/ShowDashboard/index","path":"/Frameworks/User-Interface-Extensibility-Framework/Reference/UIExt2/Interfaces/IShellPaneTab/ShowDashboard/","sidebar":"tutorialSidebar"},{"id":"UIExt2/Interfaces/IShellPaneTab/ShowEmptyContent/index","path":"/Frameworks/User-Interface-Extensibility-Framework/Reference/UIExt2/Interfaces/IShellPaneTab/ShowEmptyContent/","sidebar":"tutorialSidebar"},{"id":"UIExt2/Interfaces/IShellPaneTab/Unselect/index","path":"/Frameworks/User-Interface-Extensibility-Framework/Reference/UIExt2/Interfaces/IShellPaneTab/Unselect/","sidebar":"tutorialSidebar"},{"id":"UIExt2/Interfaces/IShellUI/BroadcastMessage/index","path":"/Frameworks/User-Interface-Extensibility-Framework/Reference/UIExt2/Interfaces/IShellUI/BroadcastMessage/","sidebar":"tutorialSidebar"},{"id":"UIExt2/Interfaces/IShellUI/GetFileTypeIconURL/index","path":"/Frameworks/User-Interface-Extensibility-Framework/Reference/UIExt2/Interfaces/IShellUI/GetFileTypeIconURL/","sidebar":"tutorialSidebar"},{"id":"UIExt2/Interfaces/IShellUI/GetObjectTypeIconURL/index","path":"/Frameworks/User-Interface-Extensibility-Framework/Reference/UIExt2/Interfaces/IShellUI/GetObjectTypeIconURL/","sidebar":"tutorialSidebar"},{"id":"UIExt2/Interfaces/IShellUI/GetValueListItemIconURL/index","path":"/Frameworks/User-Interface-Extensibility-Framework/Reference/UIExt2/Interfaces/IShellUI/GetValueListItemIconURL/","sidebar":"tutorialSidebar"},{"id":"UIExt2/Interfaces/IShellUI/index","path":"/Frameworks/User-Interface-Extensibility-Framework/Reference/UIExt2/Interfaces/IShellUI/","sidebar":"tutorialSidebar"},{"id":"UIExt2/Interfaces/IShellUI/NotifyApplication/index","path":"/Frameworks/User-Interface-Extensibility-Framework/Reference/UIExt2/Interfaces/IShellUI/NotifyApplication/","sidebar":"tutorialSidebar"},{"id":"UIExt2/Interfaces/IShellUI/ShowMessage/index","path":"/Frameworks/User-Interface-Extensibility-Framework/Reference/UIExt2/Interfaces/IShellUI/ShowMessage/","sidebar":"tutorialSidebar"},{"id":"UIExt2/Interfaces/IShellUI/ShowPopupDashboard/index","path":"/Frameworks/User-Interface-Extensibility-Framework/Reference/UIExt2/Interfaces/IShellUI/ShowPopupDashboard/","sidebar":"tutorialSidebar"},{"id":"UIExt2/Interfaces/IWindow/Close/index","path":"/Frameworks/User-Interface-Extensibility-Framework/Reference/UIExt2/Interfaces/IWindow/Close/","sidebar":"tutorialSidebar"},{"id":"UIExt2/Interfaces/IWindow/index","path":"/Frameworks/User-Interface-Extensibility-Framework/Reference/UIExt2/Interfaces/IWindow/","sidebar":"tutorialSidebar"},{"id":"UIExt2/Interfaces/IWindow/ResizeToDefaultSize/index","path":"/Frameworks/User-Interface-Extensibility-Framework/Reference/UIExt2/Interfaces/IWindow/ResizeToDefaultSize/","sidebar":"tutorialSidebar"},{"id":"UIExt2/Interfaces/IWindow/SetCloseIconVisibility/index","path":"/Frameworks/User-Interface-Extensibility-Framework/Reference/UIExt2/Interfaces/IWindow/SetCloseIconVisibility/","sidebar":"tutorialSidebar"},{"id":"UIExt2/Interfaces/IWindow/SetDefaultSize/index","path":"/Frameworks/User-Interface-Extensibility-Framework/Reference/UIExt2/Interfaces/IWindow/SetDefaultSize/","sidebar":"tutorialSidebar"},{"id":"UIExt2/Interfaces/IWindow/SetSize/index","path":"/Frameworks/User-Interface-Extensibility-Framework/Reference/UIExt2/Interfaces/IWindow/SetSize/","sidebar":"tutorialSidebar"},{"id":"UIExt2/Interfaces/IWindow/SetTitle/index","path":"/Frameworks/User-Interface-Extensibility-Framework/Reference/UIExt2/Interfaces/IWindow/SetTitle/","sidebar":"tutorialSidebar"},{"id":"UIExt2/Interfaces/TListingActionArgs/index","path":"/Frameworks/User-Interface-Extensibility-Framework/Reference/UIExt2/Interfaces/TListingActionArgs/","sidebar":"tutorialSidebar"},{"id":"UIExt2/Models/DashboardConfig/index","path":"/Frameworks/User-Interface-Extensibility-Framework/Reference/UIExt2/Models/DashboardConfig/","sidebar":"tutorialSidebar"},{"id":"UIExt2/Models/DialogUIParams/index","path":"/Frameworks/User-Interface-Extensibility-Framework/Reference/UIExt2/Models/DialogUIParams/","sidebar":"tutorialSidebar"},{"id":"UIExt2/Models/Facet/index","path":"/Frameworks/User-Interface-Extensibility-Framework/Reference/UIExt2/Models/Facet/","sidebar":"tutorialSidebar"},{"id":"UIExt2/Models/FacetDefinition/index","path":"/Frameworks/User-Interface-Extensibility-Framework/Reference/UIExt2/Models/FacetDefinition/","sidebar":"tutorialSidebar"},{"id":"UIExt2/Models/FacetLookupValue/index","path":"/Frameworks/User-Interface-Extensibility-Framework/Reference/UIExt2/Models/FacetLookupValue/","sidebar":"tutorialSidebar"},{"id":"UIExt2/Models/FacetNumericRangeValue/index","path":"/Frameworks/User-Interface-Extensibility-Framework/Reference/UIExt2/Models/FacetNumericRangeValue/","sidebar":"tutorialSidebar"},{"id":"UIExt2/Models/FacetNumericValue/index","path":"/Frameworks/User-Interface-Extensibility-Framework/Reference/UIExt2/Models/FacetNumericValue/","sidebar":"tutorialSidebar"},{"id":"UIExt2/Models/FacetStringValue/index","path":"/Frameworks/User-Interface-Extensibility-Framework/Reference/UIExt2/Models/FacetStringValue/","sidebar":"tutorialSidebar"},{"id":"UIExt2/Models/FacetValue/index","path":"/Frameworks/User-Interface-Extensibility-Framework/Reference/UIExt2/Models/FacetValue/","sidebar":"tutorialSidebar"},{"id":"UIExt2/Models/FtsScope/index","path":"/Frameworks/User-Interface-Extensibility-Framework/Reference/UIExt2/Models/FtsScope/","sidebar":"tutorialSidebar"},{"id":"UIExt2/Models/IIconInformation/index","path":"/Frameworks/User-Interface-Extensibility-Framework/Reference/UIExt2/Models/IIconInformation/","sidebar":"tutorialSidebar"},{"id":"UIExt2/Models/index","path":"/Frameworks/User-Interface-Extensibility-Framework/Reference/UIExt2/Models/","sidebar":"tutorialSidebar"},{"id":"UIExt2/Models/INonSensitiveVaultData/index","path":"/Frameworks/User-Interface-Extensibility-Framework/Reference/UIExt2/Models/INonSensitiveVaultData/","sidebar":"tutorialSidebar"},{"id":"UIExt2/Models/ISelectedFile/index","path":"/Frameworks/User-Interface-Extensibility-Framework/Reference/UIExt2/Models/ISelectedFile/","sidebar":"tutorialSidebar"},{"id":"UIExt2/Models/IVaultInfo/index","path":"/Frameworks/User-Interface-Extensibility-Framework/Reference/UIExt2/Models/IVaultInfo/","sidebar":"tutorialSidebar"},{"id":"UIExt2/Models/IVaultInfoReturnValue/index","path":"/Frameworks/User-Interface-Extensibility-Framework/Reference/UIExt2/Models/IVaultInfoReturnValue/","sidebar":"tutorialSidebar"},{"id":"UIExt2/Models/LookupValue/index","path":"/Frameworks/User-Interface-Extensibility-Framework/Reference/UIExt2/Models/LookupValue/","sidebar":"tutorialSidebar"},{"id":"UIExt2/Models/MFError/index","path":"/Frameworks/User-Interface-Extensibility-Framework/Reference/UIExt2/Models/MFError/","sidebar":"tutorialSidebar"},{"id":"UIExt2/Models/MultiDashboardUIParams/index","path":"/Frameworks/User-Interface-Extensibility-Framework/Reference/UIExt2/Models/MultiDashboardUIParams/","sidebar":"tutorialSidebar"},{"id":"UIExt2/Models/NonSensitiveSessionData/index","path":"/Frameworks/User-Interface-Extensibility-Framework/Reference/UIExt2/Models/NonSensitiveSessionData/","sidebar":"tutorialSidebar"},{"id":"UIExt2/Models/NumericRangeValue/index","path":"/Frameworks/User-Interface-Extensibility-Framework/Reference/UIExt2/Models/NumericRangeValue/","sidebar":"tutorialSidebar"},{"id":"UIExt2/Models/NumericValue/index","path":"/Frameworks/User-Interface-Extensibility-Framework/Reference/UIExt2/Models/NumericValue/","sidebar":"tutorialSidebar"},{"id":"UIExt2/Models/ObjectCreationInfo/index","path":"/Frameworks/User-Interface-Extensibility-Framework/Reference/UIExt2/Models/ObjectCreationInfo/","sidebar":"tutorialSidebar"},{"id":"UIExt2/Models/ObjectFile/index","path":"/Frameworks/User-Interface-Extensibility-Framework/Reference/UIExt2/Models/ObjectFile/","sidebar":"tutorialSidebar"},{"id":"UIExt2/Models/ObjectFileVersionArgumentValue/index","path":"/Frameworks/User-Interface-Extensibility-Framework/Reference/UIExt2/Models/ObjectFileVersionArgumentValue/","sidebar":"tutorialSidebar"},{"id":"UIExt2/Models/ObjectFileVersionParams/index","path":"/Frameworks/User-Interface-Extensibility-Framework/Reference/UIExt2/Models/ObjectFileVersionParams/","sidebar":"tutorialSidebar"},{"id":"UIExt2/Models/ObjectWindowResult/index","path":"/Frameworks/User-Interface-Extensibility-Framework/Reference/UIExt2/Models/ObjectWindowResult/","sidebar":"tutorialSidebar"},{"id":"UIExt2/Models/SearchCriteria/index","path":"/Frameworks/User-Interface-Extensibility-Framework/Reference/UIExt2/Models/SearchCriteria/","sidebar":"tutorialSidebar"},{"id":"UIExt2/Models/ShellFrameFolders/index","path":"/Frameworks/User-Interface-Extensibility-Framework/Reference/UIExt2/Models/ShellFrameFolders/","sidebar":"tutorialSidebar"},{"id":"UIExt2/Models/ShowMessageArgumentValue/index","path":"/Frameworks/User-Interface-Extensibility-Framework/Reference/UIExt2/Models/ShowMessageArgumentValue/","sidebar":"tutorialSidebar"},{"id":"UIExt2/Models/ShowMessageParams/index","path":"/Frameworks/User-Interface-Extensibility-Framework/Reference/UIExt2/Models/ShowMessageParams/","sidebar":"tutorialSidebar"},{"id":"UIExt2/Models/ShowMessageReturnValue/index","path":"/Frameworks/User-Interface-Extensibility-Framework/Reference/UIExt2/Models/ShowMessageReturnValue/","sidebar":"tutorialSidebar"},{"id":"UIExt2/Models/StringValue/index","path":"/Frameworks/User-Interface-Extensibility-Framework/Reference/UIExt2/Models/StringValue/","sidebar":"tutorialSidebar"},{"id":"UIExt2/Models/VaultInfoReturnValue/index","path":"/Frameworks/User-Interface-Extensibility-Framework/Reference/UIExt2/Models/VaultInfoReturnValue/","sidebar":"tutorialSidebar"},{"id":"UIExt2/UIExt2","path":"/Frameworks/User-Interface-Extensibility-Framework/Reference/UIExt2/","sidebar":"tutorialSidebar"},{"id":"Upgrading/deprecated_features","path":"/Frameworks/User-Interface-Extensibility-Framework/Reference/Upgrading/deprecated_features","sidebar":"tutorialSidebar"},{"id":"Upgrading/index","path":"/Frameworks/User-Interface-Extensibility-Framework/Reference/Upgrading/","sidebar":"tutorialSidebar"}],"draftIds":[],"sidebars":{"tutorialSidebar":{"link":{"path":"/Frameworks/User-Interface-Extensibility-Framework/Reference/","label":"Getting Started"}}}}],"breadcrumbs":true}}}'),o=JSON.parse('{"defaultLocale":"en","locales":["en"],"path":"i18n","currentLocale":"en","localeConfigs":{"en":{"label":"English","direction":"ltr","htmlLang":"en","calendar":"gregory","path":"en"}}}');var s=r(57529);const c=JSON.parse('{"docusaurusVersion":"2.4.3","siteVersion":"0.0.0","pluginVersions":{"docusaurus-plugin-content-docs":{"type":"package","name":"@docusaurus/plugin-content-docs","version":"2.4.3"},"docusaurus-plugin-content-pages":{"type":"package","name":"@docusaurus/plugin-content-pages","version":"2.4.3"},"docusaurus-plugin-sitemap":{"type":"package","name":"@docusaurus/plugin-sitemap","version":"2.4.3"},"docusaurus-theme-classic":{"type":"package","name":"@docusaurus/theme-classic","version":"2.4.3"},"@cmfcmf/docusaurus-search-local":{"type":"package","name":"@cmfcmf/docusaurus-search-local","version":"1.1.0"}}}'),l={siteConfig:a.default,siteMetadata:c,globalData:i,i18n:o,codeTranslations:s},u=n.createContext(l);function d(e){let{children:t}=e;return n.createElement(u.Provider,{value:l},t)}},73256:(e,t,r)=>{"use strict";r.d(t,{Z:()=>f});var n=r(67294),a=r(36136),i=r(31514),o=r(63905),s=r(59986);function c(e){let{error:t,tryAgain:r}=e;return n.createElement("div",{style:{display:"flex",flexDirection:"column",justifyContent:"center",alignItems:"flex-start",minHeight:"100vh",width:"100%",maxWidth:"80ch",fontSize:"20px",margin:"0 auto",padding:"1rem"}},n.createElement("h1",{style:{fontSize:"3rem"}},"This page crashed"),n.createElement("button",{type:"button",onClick:r,style:{margin:"1rem 0",fontSize:"2rem",cursor:"pointer",borderRadius:20,padding:"1rem"}},"Try again"),n.createElement(l,{error:t}))}function l(e){let{error:t}=e;const r=(0,o.getErrorCausalChain)(t).map((e=>e.message)).join("\n\nCause:\n");return n.createElement("p",{style:{whiteSpace:"pre-wrap"}},r)}function u(e){let{error:t,tryAgain:r}=e;return n.createElement(f,{fallback:()=>n.createElement(c,{error:t,tryAgain:r})},n.createElement(i.Z,null,n.createElement("title",null,"Page Error")),n.createElement(s.Z,null,n.createElement(c,{error:t,tryAgain:r})))}const d=e=>n.createElement(u,e);class f extends n.Component{constructor(e){super(e),this.state={error:null}}componentDidCatch(e){a.Z.canUseDOM&&this.setState({error:e})}render(){const{children:e}=this.props,{error:t}=this.state;if(t){const e={error:t,tryAgain:()=>this.setState({error:null})};return(this.props.fallback??d)(e)}return e??null}}},36136:(e,t,r)=>{"use strict";r.d(t,{Z:()=>a});const n="undefined"!=typeof window&&"document"in window&&"createElement"in window.document,a={canUseDOM:n,canUseEventListeners:n&&("addEventListener"in window||"attachEvent"in window),canUseIntersectionObserver:n&&"IntersectionObserver"in window,canUseViewport:n&&"screen"in window}},31514:(e,t,r)=>{"use strict";r.d(t,{Z:()=>i});var n=r(67294),a=r(70405);function i(e){return n.createElement(a.ql,e)}},83699:(e,t,r)=>{"use strict";r.d(t,{Z:()=>m});var n=r(87462),a=r(67294),i=r(73727),o=r(63905),s=r(39962),c=r(2735),l=r(36136);const u=a.createContext({collectLink:()=>{}});var d=r(79524);function f(e,t){let{isNavLink:r,to:f,href:m,activeClassName:p,isActive:b,"data-noBrokenLinkCheck":g,autoAddBaseUrl:h=!0,...w}=e;const{siteConfig:{trailingSlash:I,baseUrl:x}}=(0,s.Z)(),{withBaseUrl:y}=(0,d.C)(),k=(0,a.useContext)(u),E=(0,a.useRef)(null);(0,a.useImperativeHandle)(t,(()=>E.current));const F=f||m;const R=(0,c.Z)(F),S=F?.replace("pathname://","");let v=void 0!==S?(U=S,h&&(e=>e.startsWith("/"))(U)?y(U):U):void 0;var U;v&&R&&(v=(0,o.applyTrailingSlash)(v,{trailingSlash:I,baseUrl:x}));const C=(0,a.useRef)(!1),P=r?i.OL:i.rU,O=l.Z.canUseIntersectionObserver,_=(0,a.useRef)(),M=()=>{C.current||null==v||(window.docusaurus.preload(v),C.current=!0)};(0,a.useEffect)((()=>(!O&&R&&null!=v&&window.docusaurus.prefetch(v),()=>{O&&_.current&&_.current.disconnect()})),[_,v,O,R]);const T=v?.startsWith("#")??!1,j=!v||!R||T;return j||g||k.collectLink(v),j?a.createElement("a",(0,n.Z)({ref:E,href:v},F&&!R&&{target:"_blank",rel:"noopener noreferrer"},w)):a.createElement(P,(0,n.Z)({},w,{onMouseEnter:M,onTouchStart:M,innerRef:e=>{E.current=e,O&&e&&R&&(_.current=new window.IntersectionObserver((t=>{t.forEach((t=>{e===t.target&&(t.isIntersecting||t.intersectionRatio>0)&&(_.current.unobserve(e),_.current.disconnect(),null!=v&&window.docusaurus.prefetch(v))}))})),_.current.observe(e))},to:v},r&&{isActive:b,activeClassName:p}))}const m=a.forwardRef(f)},97325:(e,t,r)=>{"use strict";r.d(t,{Z:()=>c,I:()=>s});var n=r(67294);function a(e,t){const r=e.split(/(\{\w+\})/).map(((e,r)=>{if(r%2==1){const r=t?.[e.slice(1,-1)];if(void 0!==r)return r}return e}));return r.some((e=>(0,n.isValidElement)(e)))?r.map(((e,t)=>(0,n.isValidElement)(e)?n.cloneElement(e,{key:t}):e)).filter((e=>""!==e)):r.join("")}var i=r(57529);function o(e){let{id:t,message:r}=e;if(void 0===t&&void 0===r)throw new Error("Docusaurus translation declarations must have at least a translation id or a default translation message");return i[t??r]??r??t}function s(e,t){let{message:r,id:n}=e;return a(o({message:r,id:n}),t)}function c(e){let{children:t,id:r,values:i}=e;if(t&&"string"!=typeof t)throw console.warn("Illegal children",t),new Error("The Docusaurus component only accept simple string values");const s=o({message:t,id:r});return n.createElement(n.Fragment,null,a(s,i))}},6875:(e,t,r)=>{"use strict";r.d(t,{m:()=>n});const n="default"},2735:(e,t,r)=>{"use strict";function n(e){return/^(?:\w*:|\/\/)/.test(e)}function a(e){return void 0!==e&&!n(e)}r.d(t,{Z:()=>a,b:()=>n})},79524:(e,t,r)=>{"use strict";r.d(t,{C:()=>o,Z:()=>s});var n=r(67294),a=r(39962),i=r(2735);function o(){const{siteConfig:{baseUrl:e,url:t}}=(0,a.Z)(),r=(0,n.useCallback)(((r,n)=>function(e,t,r,n){let{forcePrependBaseUrl:a=!1,absolute:o=!1}=void 0===n?{}:n;if(!r||r.startsWith("#")||(0,i.b)(r))return r;if(a)return t+r.replace(/^\//,"");if(r===t.replace(/\/$/,""))return t;const s=r.startsWith(t)?r:t+r.replace(/^\//,"");return o?e+s:s}(t,e,r,n)),[t,e]);return{withBaseUrl:r}}function s(e,t){void 0===t&&(t={});const{withBaseUrl:r}=o();return r(e,t)}},39962:(e,t,r)=>{"use strict";r.d(t,{Z:()=>i});var n=r(67294),a=r(80694);function i(){return(0,n.useContext)(a._)}},31610:(e,t,r)=>{"use strict";r.d(t,{OD:()=>i,eZ:()=>o});var n=r(39962),a=r(6875);function i(e,t){void 0===t&&(t={});const r=function(){const{globalData:e}=(0,n.Z)();return e}()[e];if(!r&&t.failfast)throw new Error(`Docusaurus plugin global data not found for "${e}" plugin.`);return r}function o(e,t,r){void 0===t&&(t=a.m),void 0===r&&(r={});const n=i(e),o=n?.[t];if(!o&&r.failfast)throw new Error(`Docusaurus plugin global data not found for "${e}" plugin with id "${t}".`);return o}},51048:(e,t,r)=>{"use strict";r.d(t,{Z:()=>i});var n=r(67294),a=r(88121);function i(){return(0,n.useContext)(a._)}},5304:(e,t,r)=>{"use strict";r.d(t,{Z:()=>a});const n=e=>"object"==typeof e&&!!e&&Object.keys(e).length>0;function a(e){const t={};return function e(r,a){Object.entries(r).forEach((r=>{let[i,o]=r;const s=a?`${a}.${i}`:i;n(o)?e(o,s):t[s]=o}))}(e),t}},69656:(e,t,r)=>{"use strict";r.d(t,{_:()=>a,z:()=>i});var n=r(67294);const a=n.createContext(null);function i(e){let{children:t,value:r}=e;const i=n.useContext(a),o=(0,n.useMemo)((()=>function(e){let{parent:t,value:r}=e;if(!t){if(!r)throw new Error("Unexpected: no Docusaurus route context found");if(!("plugin"in r))throw new Error("Unexpected: Docusaurus topmost route context has no `plugin` attribute");return r}const n={...t.data,...r?.data};return{plugin:t.plugin,data:n}}({parent:i,value:r})),[i,r]);return n.createElement(a.Provider,{value:o},t)}},30868:(e,t,r)=>{"use strict";r.d(t,{Iw:()=>b,gA:()=>d,WS:()=>f,_r:()=>l,Jo:()=>g,zh:()=>u,yW:()=>p,gB:()=>m});var n=r(16550),a=r(31610);const i=e=>e.versions.find((e=>e.isLast));function o(e,t){const r=i(e);return[...e.versions.filter((e=>e!==r)),r].find((e=>!!(0,n.LX)(t,{path:e.path,exact:!1,strict:!1})))}function s(e,t){const r=o(e,t),a=r?.docs.find((e=>!!(0,n.LX)(t,{path:e.path,exact:!0,strict:!1})));return{activeVersion:r,activeDoc:a,alternateDocVersions:a?function(t){const r={};return e.versions.forEach((e=>{e.docs.forEach((n=>{n.id===t&&(r[e.name]=n)}))})),r}(a.id):{}}}const c={},l=()=>(0,a.OD)("docusaurus-plugin-content-docs")??c,u=e=>(0,a.eZ)("docusaurus-plugin-content-docs",e,{failfast:!0});function d(e){void 0===e&&(e={});const t=l(),{pathname:r}=(0,n.TH)();return function(e,t,r){void 0===r&&(r={});const a=Object.entries(e).sort(((e,t)=>t[1].path.localeCompare(e[1].path))).find((e=>{let[,r]=e;return!!(0,n.LX)(t,{path:r.path,exact:!1,strict:!1})})),i=a?{pluginId:a[0],pluginData:a[1]}:void 0;if(!i&&r.failfast)throw new Error(`Can't find active docs plugin for "${t}" pathname, while it was expected to be found. Maybe you tried to use a docs feature that can only be used on a docs-related page? Existing docs plugin paths are: ${Object.values(e).map((e=>e.path)).join(", ")}`);return i}(t,r,e)}function f(e){void 0===e&&(e={});const t=d(e),{pathname:r}=(0,n.TH)();if(!t)return;return{activePlugin:t,activeVersion:o(t.pluginData,r)}}function m(e){return u(e).versions}function p(e){const t=u(e);return i(t)}function b(e){const t=u(e),{pathname:r}=(0,n.TH)();return s(t,r)}function g(e){const t=u(e),{pathname:r}=(0,n.TH)();return function(e,t){const r=i(e);return{latestDocSuggestion:s(e,t).alternateDocVersions[r.name],latestVersionSuggestion:r}}(t,r)}},79957:(e,t,r)=>{"use strict";r.r(t),r.d(t,{default:()=>i});var n=r(74865),a=r.n(n);a().configure({showSpinner:!1});const i={onRouteUpdate(e){let{location:t,previousLocation:r}=e;if(r&&t.pathname!==r.pathname){const e=window.setTimeout((()=>{a().start()}),200);return()=>window.clearTimeout(e)}},onRouteDidUpdate(){a().done()}}},82251:(e,t,r)=>{"use strict";r.r(t);var n=r(87410),a=r(36809);!function(e){const{themeConfig:{prism:t}}=a.default,{additionalLanguages:n}=t;globalThis.Prism=e,n.forEach((e=>{r(6726)(`./prism-${e}`)})),delete globalThis.Prism}(n.Z)},14082:(e,t,r)=>{"use strict";r.d(t,{Z:()=>i});var n=r(67294);const a={iconExternalLink:"iconExternalLink_nPIU"};function i(e){let{width:t=13.5,height:r=13.5}=e;return n.createElement("svg",{width:t,height:r,"aria-hidden":"true",viewBox:"0 0 24 24",className:a.iconExternalLink},n.createElement("path",{fill:"currentColor",d:"M21 13v10h-21v-19h12v2h-10v15h17v-8h2zm3-12h-10.988l4.035 4-6.977 7.07 2.828 2.828 6.977-7.07 4.125 4.172v-11z"}))}},59986:(e,t,r)=>{"use strict";r.d(t,{Z:()=>so});var n=r(67294),a=r(86010),i=r(73256),o=r(35463),s=r(87462),c=r(16550),l=r(97325),u=r(43266);const d="__docusaurus_skipToContent_fallback";function f(e){e.setAttribute("tabindex","-1"),e.focus(),e.removeAttribute("tabindex")}function m(){const e=(0,n.useRef)(null),{action:t}=(0,c.k6)(),r=(0,n.useCallback)((e=>{e.preventDefault();const t=document.querySelector("main:first-of-type")??document.getElementById(d);t&&f(t)}),[]);return(0,u.S)((r=>{let{location:n}=r;e.current&&!n.hash&&"PUSH"===t&&f(e.current)})),{containerRef:e,onClick:r}}const p=(0,l.I)({id:"theme.common.skipToMainContent",description:"The skip to content label used for accessibility, allowing to rapidly navigate to main content with keyboard tab/enter navigation",message:"Skip to main content"});function b(e){const t=e.children??p,{containerRef:r,onClick:a}=m();return n.createElement("div",{ref:r,role:"region","aria-label":p},n.createElement("a",(0,s.Z)({},e,{href:`#${d}`,onClick:a}),t))}var g=r(23702),h=r(78181);const w={skipToContent:"skipToContent_fXgn"};function I(){return n.createElement(b,{className:w.skipToContent})}var x=r(20107),y=r(65830);function k(e){let{width:t=21,height:r=21,color:a="currentColor",strokeWidth:i=1.2,className:o,...c}=e;return n.createElement("svg",(0,s.Z)({viewBox:"0 0 15 15",width:t,height:r},c),n.createElement("g",{stroke:a,strokeWidth:i},n.createElement("path",{d:"M.75.75l13.5 13.5M14.25.75L.75 14.25"})))}const E={closeButton:"closeButton_CVFx"};function F(e){return n.createElement("button",(0,s.Z)({type:"button","aria-label":(0,l.I)({id:"theme.AnnouncementBar.closeButtonAriaLabel",message:"Close",description:"The ARIA label for close button of announcement bar"})},e,{className:(0,a.Z)("clean-btn close",E.closeButton,e.className)}),n.createElement(k,{width:14,height:14,strokeWidth:3.1}))}const R={content:"content_knG7"};function S(e){const{announcementBar:t}=(0,x.L)(),{content:r}=t;return n.createElement("div",(0,s.Z)({},e,{className:(0,a.Z)(R.content,e.className),dangerouslySetInnerHTML:{__html:r}}))}const v={announcementBar:"announcementBar_mb4j",announcementBarPlaceholder:"announcementBarPlaceholder_vyr4",announcementBarClose:"announcementBarClose_gvF7",announcementBarContent:"announcementBarContent_xLdY"};function U(){const{announcementBar:e}=(0,x.L)(),{isActive:t,close:r}=(0,y.nT)();if(!t)return null;const{backgroundColor:a,textColor:i,isCloseable:o}=e;return n.createElement("div",{className:v.announcementBar,style:{backgroundColor:a,color:i},role:"banner"},o&&n.createElement("div",{className:v.announcementBarPlaceholder}),n.createElement(S,{className:v.announcementBarContent}),o&&n.createElement(F,{onClick:r,className:v.announcementBarClose}))}var C=r(60735),P=r(72957);var O=r(43768),_=r(53086);const M=n.createContext(null);function T(e){let{children:t}=e;const r=function(){const e=(0,C.e)(),t=(0,_.HY)(),[r,a]=(0,n.useState)(!1),i=null!==t.component,o=(0,O.D9)(i);return(0,n.useEffect)((()=>{i&&!o&&a(!0)}),[i,o]),(0,n.useEffect)((()=>{i?e.shown||a(!0):a(!1)}),[e.shown,i]),(0,n.useMemo)((()=>[r,a]),[r])}();return n.createElement(M.Provider,{value:r},t)}function j(e){if(e.component){const t=e.component;return n.createElement(t,e.props)}}function A(){const e=(0,n.useContext)(M);if(!e)throw new O.i6("NavbarSecondaryMenuDisplayProvider");const[t,r]=e,a=(0,n.useCallback)((()=>r(!1)),[r]),i=(0,_.HY)();return(0,n.useMemo)((()=>({shown:t,hide:a,content:j(i)})),[a,i,t])}function L(e){let{header:t,primaryMenu:r,secondaryMenu:i}=e;const{shown:o}=A();return n.createElement("div",{className:"navbar-sidebar"},t,n.createElement("div",{className:(0,a.Z)("navbar-sidebar__items",{"navbar-sidebar__items--show-secondary":o})},n.createElement("div",{className:"navbar-sidebar__item menu"},r),n.createElement("div",{className:"navbar-sidebar__item menu"},i)))}var D=r(9200),N=r(51048);function V(e){return n.createElement("svg",(0,s.Z)({viewBox:"0 0 24 24",width:24,height:24},e),n.createElement("path",{fill:"currentColor",d:"M12,9c1.65,0,3,1.35,3,3s-1.35,3-3,3s-3-1.35-3-3S10.35,9,12,9 M12,7c-2.76,0-5,2.24-5,5s2.24,5,5,5s5-2.24,5-5 S14.76,7,12,7L12,7z M2,13l2,0c0.55,0,1-0.45,1-1s-0.45-1-1-1l-2,0c-0.55,0-1,0.45-1,1S1.45,13,2,13z M20,13l2,0c0.55,0,1-0.45,1-1 s-0.45-1-1-1l-2,0c-0.55,0-1,0.45-1,1S19.45,13,20,13z M11,2v2c0,0.55,0.45,1,1,1s1-0.45,1-1V2c0-0.55-0.45-1-1-1S11,1.45,11,2z M11,20v2c0,0.55,0.45,1,1,1s1-0.45,1-1v-2c0-0.55-0.45-1-1-1C11.45,19,11,19.45,11,20z M5.99,4.58c-0.39-0.39-1.03-0.39-1.41,0 c-0.39,0.39-0.39,1.03,0,1.41l1.06,1.06c0.39,0.39,1.03,0.39,1.41,0s0.39-1.03,0-1.41L5.99,4.58z M18.36,16.95 c-0.39-0.39-1.03-0.39-1.41,0c-0.39,0.39-0.39,1.03,0,1.41l1.06,1.06c0.39,0.39,1.03,0.39,1.41,0c0.39-0.39,0.39-1.03,0-1.41 L18.36,16.95z M19.42,5.99c0.39-0.39,0.39-1.03,0-1.41c-0.39-0.39-1.03-0.39-1.41,0l-1.06,1.06c-0.39,0.39-0.39,1.03,0,1.41 s1.03,0.39,1.41,0L19.42,5.99z M7.05,18.36c0.39-0.39,0.39-1.03,0-1.41c-0.39-0.39-1.03-0.39-1.41,0l-1.06,1.06 c-0.39,0.39-0.39,1.03,0,1.41s1.03,0.39,1.41,0L7.05,18.36z"}))}function B(e){return n.createElement("svg",(0,s.Z)({viewBox:"0 0 24 24",width:24,height:24},e),n.createElement("path",{fill:"currentColor",d:"M9.37,5.51C9.19,6.15,9.1,6.82,9.1,7.5c0,4.08,3.32,7.4,7.4,7.4c0.68,0,1.35-0.09,1.99-0.27C17.45,17.19,14.93,19,12,19 c-3.86,0-7-3.14-7-7C5,9.07,6.81,6.55,9.37,5.51z M12,3c-4.97,0-9,4.03-9,9s4.03,9,9,9s9-4.03,9-9c0-0.46-0.04-0.92-0.1-1.36 c-0.98,1.37-2.58,2.26-4.4,2.26c-2.98,0-5.4-2.42-5.4-5.4c0-1.81,0.89-3.42,2.26-4.4C12.92,3.04,12.46,3,12,3L12,3z"}))}const G={toggle:"toggle_vylO",toggleButton:"toggleButton_gllP",darkToggleIcon:"darkToggleIcon_wfgR",lightToggleIcon:"lightToggleIcon_pyhR",toggleButtonDisabled:"toggleButtonDisabled_aARS"};function W(e){let{className:t,buttonClassName:r,value:i,onChange:o}=e;const s=(0,N.Z)(),c=(0,l.I)({message:"Switch between dark and light mode (currently {mode})",id:"theme.colorToggle.ariaLabel",description:"The ARIA label for the navbar color mode toggle"},{mode:"dark"===i?(0,l.I)({message:"dark mode",id:"theme.colorToggle.ariaLabel.mode.dark",description:"The name for the dark color mode"}):(0,l.I)({message:"light mode",id:"theme.colorToggle.ariaLabel.mode.light",description:"The name for the light color mode"})});return n.createElement("div",{className:(0,a.Z)(G.toggle,t)},n.createElement("button",{className:(0,a.Z)("clean-btn",G.toggleButton,!s&&G.toggleButtonDisabled,r),type:"button",onClick:()=>o("dark"===i?"light":"dark"),disabled:!s,title:c,"aria-label":c,"aria-live":"polite"},n.createElement(V,{className:(0,a.Z)(G.toggleIcon,G.lightToggleIcon)}),n.createElement(B,{className:(0,a.Z)(G.toggleIcon,G.darkToggleIcon)})))}const z=n.memo(W),q={darkNavbarColorModeToggle:"darkNavbarColorModeToggle_X3D1"};function $(e){let{className:t}=e;const r=(0,x.L)().navbar.style,a=(0,x.L)().colorMode.disableSwitch,{colorMode:i,setColorMode:o}=(0,D.I)();return a?null:n.createElement(z,{className:t,buttonClassName:"dark"===r?q.darkNavbarColorModeToggle:void 0,value:i,onChange:o})}var H=r(96811);function Q(){return n.createElement(H.Z,{className:"navbar__brand",imageClassName:"navbar__logo",titleClassName:"navbar__title text--truncate"})}function Z(){const e=(0,C.e)();return n.createElement("button",{type:"button","aria-label":(0,l.I)({id:"theme.docs.sidebar.closeSidebarButtonAriaLabel",message:"Close navigation bar",description:"The ARIA label for close button of mobile sidebar"}),className:"clean-btn navbar-sidebar__close",onClick:()=>e.toggle()},n.createElement(k,{color:"var(--ifm-color-emphasis-600)"}))}function Y(){return n.createElement("div",{className:"navbar-sidebar__brand"},n.createElement(Q,null),n.createElement($,{className:"margin-right--md"}),n.createElement(Z,null))}var J=r(83699),K=r(79524),X=r(2735);function ee(e,t){return void 0!==e&&void 0!==t&&new RegExp(e,"gi").test(t)}var te=r(14082);function re(e){let{activeBasePath:t,activeBaseRegex:r,to:a,href:i,label:o,html:c,isDropdownLink:l,prependBaseUrlToHref:u,...d}=e;const f=(0,K.Z)(a),m=(0,K.Z)(t),p=(0,K.Z)(i,{forcePrependBaseUrl:!0}),b=o&&i&&!(0,X.Z)(i),g=c?{dangerouslySetInnerHTML:{__html:c}}:{children:n.createElement(n.Fragment,null,o,b&&n.createElement(te.Z,l&&{width:12,height:12}))};return i?n.createElement(J.Z,(0,s.Z)({href:u?p:i},d,g)):n.createElement(J.Z,(0,s.Z)({to:f,isNavLink:!0},(t||r)&&{isActive:(e,t)=>r?ee(r,t.pathname):t.pathname.startsWith(m)},d,g))}function ne(e){let{className:t,isDropdownItem:r=!1,...i}=e;const o=n.createElement(re,(0,s.Z)({className:(0,a.Z)(r?"dropdown__link":"navbar__item navbar__link",t),isDropdownLink:r},i));return r?n.createElement("li",null,o):o}function ae(e){let{className:t,isDropdownItem:r,...i}=e;return n.createElement("li",{className:"menu__list-item"},n.createElement(re,(0,s.Z)({className:(0,a.Z)("menu__link",t)},i)))}function ie(e){let{mobile:t=!1,position:r,...a}=e;const i=t?ae:ne;return n.createElement(i,(0,s.Z)({},a,{activeClassName:a.activeClassName??(t?"menu__link--active":"navbar__link--active")}))}var oe=r(54639),se=r(69003),ce=r(39962);function le(e,t){return e.some((e=>function(e,t){return!!(0,se.Mg)(e.to,t)||!!ee(e.activeBaseRegex,t)||!(!e.activeBasePath||!t.startsWith(e.activeBasePath))}(e,t)))}function ue(e){let{items:t,position:r,className:i,onClick:o,...c}=e;const l=(0,n.useRef)(null),[u,d]=(0,n.useState)(!1);return(0,n.useEffect)((()=>{const e=e=>{l.current&&!l.current.contains(e.target)&&d(!1)};return document.addEventListener("mousedown",e),document.addEventListener("touchstart",e),document.addEventListener("focusin",e),()=>{document.removeEventListener("mousedown",e),document.removeEventListener("touchstart",e),document.removeEventListener("focusin",e)}}),[l]),n.createElement("div",{ref:l,className:(0,a.Z)("navbar__item","dropdown","dropdown--hoverable",{"dropdown--right":"right"===r,"dropdown--show":u})},n.createElement(re,(0,s.Z)({"aria-haspopup":"true","aria-expanded":u,role:"button",href:c.to?void 0:"#",className:(0,a.Z)("navbar__link",i)},c,{onClick:c.to?void 0:e=>e.preventDefault(),onKeyDown:e=>{"Enter"===e.key&&(e.preventDefault(),d(!u))}}),c.children??c.label),n.createElement("ul",{className:"dropdown__menu"},t.map(((e,t)=>n.createElement(xi,(0,s.Z)({isDropdownItem:!0,activeClassName:"dropdown__link--active"},e,{key:t}))))))}function de(e){let{items:t,className:r,position:i,onClick:o,...l}=e;const u=function(){const{siteConfig:{baseUrl:e}}=(0,ce.Z)(),{pathname:t}=(0,c.TH)();return t.replace(e,"/")}(),d=le(t,u),{collapsed:f,toggleCollapsed:m,setCollapsed:p}=(0,oe.u)({initialState:()=>!d});return(0,n.useEffect)((()=>{d&&p(!d)}),[u,d,p]),n.createElement("li",{className:(0,a.Z)("menu__list-item",{"menu__list-item--collapsed":f})},n.createElement(re,(0,s.Z)({role:"button",className:(0,a.Z)("menu__link menu__link--sublist menu__link--sublist-caret",r)},l,{onClick:e=>{e.preventDefault(),m()}}),l.children??l.label),n.createElement(oe.z,{lazy:!0,as:"ul",className:"menu__list",collapsed:f},t.map(((e,t)=>n.createElement(xi,(0,s.Z)({mobile:!0,isDropdownItem:!0,onClick:o,activeClassName:"menu__link--active"},e,{key:t}))))))}function fe(e){let{mobile:t=!1,...r}=e;const a=t?de:ue;return n.createElement(a,r)}var me=r(40626);function pe(e){let{width:t=20,height:r=20,...a}=e;return n.createElement("svg",(0,s.Z)({viewBox:"0 0 24 24",width:t,height:r,"aria-hidden":!0},a),n.createElement("path",{fill:"currentColor",d:"M12.87 15.07l-2.54-2.51.03-.03c1.74-1.94 2.98-4.17 3.71-6.53H17V4h-7V2H8v2H1v1.99h11.17C11.5 7.92 10.44 9.75 9 11.35 8.07 10.32 7.3 9.19 6.69 8h-2c.73 1.63 1.73 3.17 2.98 4.56l-5.09 5.02L4 19l5-5 3.11 3.11.76-2.04zM18.5 10h-2L12 22h2l1.12-3h4.75L21 22h2l-4.5-12zm-2.62 7l1.62-4.33L19.12 17h-3.24z"}))}const be="iconLanguage_nlXk";var ge=r(73935);function he(e,t){var r=void 0;return function(){for(var n=arguments.length,a=new Array(n),i=0;ie.length)&&(t=e.length);for(var r=0,n=new Array(t);re.length)&&(t=e.length);for(var r=0,n=new Array(t);r=0||(a[r]=e[r]);return a}(e,t);if(Object.getOwnPropertySymbols){var i=Object.getOwnPropertySymbols(e);for(n=0;n=0||Object.prototype.propertyIsEnumerable.call(e,r)&&(a[r]=e[r])}return a}function Oe(e,t){var r=Object.keys(e);if(Object.getOwnPropertySymbols){var n=Object.getOwnPropertySymbols(e);t&&(n=n.filter((function(t){return Object.getOwnPropertyDescriptor(e,t).enumerable}))),r.push.apply(r,n)}return r}function _e(e){for(var t=1;t=3||2===r&&n>=4||1===r&&n>=10}(e);function r(r,n,a){if(t&&void 0!==a){var i=a[0].__autocomplete_algoliaCredentials,o={"X-Algolia-Application-Id":i.appId,"X-Algolia-API-Key":i.apiKey};e.apply(void 0,[r].concat(Ue(n),[{headers:o}]))}else e.apply(void 0,[r].concat(Ue(n)))}return{init:function(t,r){e("init",{appId:t,apiKey:r})},setAuthenticatedUserToken:function(t){e("setAuthenticatedUserToken",t)},setUserToken:function(t){e("setUserToken",t)},clickedObjectIDsAfterSearch:function(){for(var e=arguments.length,t=new Array(e),n=0;n0&&r("clickedObjectIDsAfterSearch",Te(t),t[0].items)},clickedObjectIDs:function(){for(var e=arguments.length,t=new Array(e),n=0;n0&&r("clickedObjectIDs",Te(t),t[0].items)},clickedFilters:function(){for(var t=arguments.length,r=new Array(t),n=0;n0&&e.apply(void 0,["clickedFilters"].concat(r))},convertedObjectIDsAfterSearch:function(){for(var e=arguments.length,t=new Array(e),n=0;n0&&r("convertedObjectIDsAfterSearch",Te(t),t[0].items)},convertedObjectIDs:function(){for(var e=arguments.length,t=new Array(e),n=0;n0&&r("convertedObjectIDs",Te(t),t[0].items)},convertedFilters:function(){for(var t=arguments.length,r=new Array(t),n=0;n0&&e.apply(void 0,["convertedFilters"].concat(r))},viewedObjectIDs:function(){for(var e=arguments.length,t=new Array(e),n=0;n0&&t.reduce((function(e,t){var r=t.items,n=Pe(t,Se);return[].concat(Ue(e),Ue(function(e){for(var t=arguments.length>1&&void 0!==arguments[1]?arguments[1]:20,r=[],n=0;n0&&e.apply(void 0,["viewedFilters"].concat(r))}}}function Ae(e){var t=e.items.reduce((function(e,t){var r;return e[t.__autocomplete_indexName]=(null!==(r=e[t.__autocomplete_indexName])&&void 0!==r?r:[]).concat(t),e}),{});return Object.keys(t).map((function(e){return{index:e,items:t[e],algoliaSource:["autocomplete"]}}))}function Le(e){return e.objectID&&e.__autocomplete_indexName&&e.__autocomplete_queryID}function De(e){return De="function"==typeof Symbol&&"symbol"==typeof Symbol.iterator?function(e){return typeof e}:function(e){return e&&"function"==typeof Symbol&&e.constructor===Symbol&&e!==Symbol.prototype?"symbol":typeof e},De(e)}function Ne(e){return function(e){if(Array.isArray(e))return Ve(e)}(e)||function(e){if("undefined"!=typeof Symbol&&null!=e[Symbol.iterator]||null!=e["@@iterator"])return Array.from(e)}(e)||function(e,t){if(!e)return;if("string"==typeof e)return Ve(e,t);var r=Object.prototype.toString.call(e).slice(8,-1);"Object"===r&&e.constructor&&(r=e.constructor.name);if("Map"===r||"Set"===r)return Array.from(e);if("Arguments"===r||/^(?:Ui|I)nt(?:8|16|32)(?:Clamped)?Array$/.test(r))return Ve(e,t)}(e)||function(){throw new TypeError("Invalid attempt to spread non-iterable instance.\nIn order to be iterable, non-array objects must have a [Symbol.iterator]() method.")}()}function Ve(e,t){(null==t||t>e.length)&&(t=e.length);for(var r=0,n=new Array(t);r0&&$e({onItemsChange:a,items:r,insights:l,state:t}))}}),0);return{name:"aa.algoliaInsightsPlugin",subscribe:function(e){var t=e.setContext,r=e.onSelect,n=e.onActive,a=!1;function u(e){t({algoliaInsightsPlugin:{__algoliaSearchParameters:Ge(Ge({},s?{clickAnalytics:!0}:{}),e?{userToken:Ze(e)}:{}),insights:l}})}c("addAlgoliaAgent","insights-plugin"),u(),c("onUserTokenChange",(function(e){a||u(e)})),c("getUserToken",null,(function(e,t){a||u(t)})),c("onAuthenticatedUserTokenChange",(function(e){e?(a=!0,u(e)):(a=!1,c("getUserToken",null,(function(e,t){return u(t)})))})),c("getAuthenticatedUserToken",null,(function(e,t){t&&(a=!0,u(t))})),r((function(e){var t=e.item,r=e.state,n=e.event,a=e.source;Le(t)&&i({state:r,event:n,insights:l,item:t,insightsEvents:[Ge({eventName:"Item Selected"},ke({item:t,items:a.getItems().filter(Le)}))]})})),n((function(e){var t=e.item,r=e.source,n=e.state,a=e.event;Le(t)&&o({state:n,event:a,insights:l,item:t,insightsEvents:[Ge({eventName:"Item Active"},ke({item:t,items:r.getItems().filter(Le)}))]})}))},onStateChange:function(e){var t=e.state;d({state:t})},__autocomplete_pluginOptions:e}}function Qe(){var e,t=arguments.length>1?arguments[1]:void 0;return[].concat(Ne(arguments.length>0&&void 0!==arguments[0]?arguments[0]:[]),["autocomplete-internal"],Ne(null!==(e=t.algoliaInsightsPlugin)&&void 0!==e&&e.__automaticInsights?["autocomplete-automatic"]:[]))}function Ze(e){return"number"==typeof e?e.toString():e}function Ye(e){return Ye="function"==typeof Symbol&&"symbol"==typeof Symbol.iterator?function(e){return typeof e}:function(e){return e&&"function"==typeof Symbol&&e.constructor===Symbol&&e!==Symbol.prototype?"symbol":typeof e},Ye(e)}function Je(e,t){var r=Object.keys(e);if(Object.getOwnPropertySymbols){var n=Object.getOwnPropertySymbols(e);t&&(n=n.filter((function(t){return Object.getOwnPropertyDescriptor(e,t).enumerable}))),r.push.apply(r,n)}return r}function Ke(e,t,r){return(t=function(e){var t=function(e,t){if("object"!==Ye(e)||null===e)return e;var r=e[Symbol.toPrimitive];if(void 0!==r){var n=r.call(e,t||"default");if("object"!==Ye(n))return n;throw new TypeError("@@toPrimitive must return a primitive value.")}return("string"===t?String:Number)(e)}(e,"string");return"symbol"===Ye(t)?t:String(t)}(t))in e?Object.defineProperty(e,t,{value:r,enumerable:!0,configurable:!0,writable:!0}):e[t]=r,e}function Xe(e,t,r){var n,a=t.initialState;return{getState:function(){return a},dispatch:function(n,i){var o=function(e){for(var t=1;te.length)&&(t=e.length);for(var r=0,n=new Array(t);r0},reshape:function(e){return e.sources}},e),{},{id:null!==(r=e.id)&&void 0!==r?r:st(),plugins:a,initialState:gt({activeItemId:null,query:"",completion:null,collections:[],isOpen:!1,status:"idle",context:{}},e.initialState),onStateChange:function(t){var r;null===(r=e.onStateChange)||void 0===r||r.call(e,t),a.forEach((function(e){var r;return null===(r=e.onStateChange)||void 0===r?void 0:r.call(e,t)}))},onSubmit:function(t){var r;null===(r=e.onSubmit)||void 0===r||r.call(e,t),a.forEach((function(e){var r;return null===(r=e.onSubmit)||void 0===r?void 0:r.call(e,t)}))},onReset:function(t){var r;null===(r=e.onReset)||void 0===r||r.call(e,t),a.forEach((function(e){var r;return null===(r=e.onReset)||void 0===r?void 0:r.call(e,t)}))},getSources:function(r){return Promise.all([].concat(mt(a.map((function(e){return e.getSources}))),[e.getSources]).filter(Boolean).map((function(e){return function(e,t){var r=[];return Promise.resolve(e(t)).then((function(e){return Array.isArray(e),Promise.all(e.filter((function(e){return Boolean(e)})).map((function(e){if(e.sourceId,r.includes(e.sourceId))throw new Error("[Autocomplete] The `sourceId` ".concat(JSON.stringify(e.sourceId)," is not unique."));r.push(e.sourceId);var t={getItemInputValue:function(e){return e.state.query},getItemUrl:function(){},onSelect:function(e){(0,e.setIsOpen)(!1)},onActive:ye,onResolve:ye};Object.keys(t).forEach((function(e){t[e].__default=!0}));var n=lt(lt({},t),e);return Promise.resolve(n)})))}))}(e,r)}))).then((function(e){return et(e)})).then((function(e){return e.map((function(e){return gt(gt({},e),{},{onSelect:function(r){e.onSelect(r),t.forEach((function(e){var t;return null===(t=e.onSelect)||void 0===t?void 0:t.call(e,r)}))},onActive:function(r){e.onActive(r),t.forEach((function(e){var t;return null===(t=e.onActive)||void 0===t?void 0:t.call(e,r)}))},onResolve:function(r){e.onResolve(r),t.forEach((function(e){var t;return null===(t=e.onResolve)||void 0===t?void 0:t.call(e,r)}))}})}))}))},navigator:gt({navigate:function(e){var t=e.itemUrl;n.location.assign(t)},navigateNewTab:function(e){var t=e.itemUrl,r=n.open(t,"_blank","noopener");null==r||r.focus()},navigateNewWindow:function(e){var t=e.itemUrl;n.open(t,"_blank","noopener")}},e.navigator)})}function It(e){return It="function"==typeof Symbol&&"symbol"==typeof Symbol.iterator?function(e){return typeof e}:function(e){return e&&"function"==typeof Symbol&&e.constructor===Symbol&&e!==Symbol.prototype?"symbol":typeof e},It(e)}function xt(e,t){var r=Object.keys(e);if(Object.getOwnPropertySymbols){var n=Object.getOwnPropertySymbols(e);t&&(n=n.filter((function(t){return Object.getOwnPropertyDescriptor(e,t).enumerable}))),r.push.apply(r,n)}return r}function yt(e){for(var t=1;te.length)&&(t=e.length);for(var r=0,n=new Array(t);r=0||(a[r]=e[r]);return a}(e,t);if(Object.getOwnPropertySymbols){var i=Object.getOwnPropertySymbols(e);for(n=0;n=0||Object.prototype.propertyIsEnumerable.call(e,r)&&(a[r]=e[r])}return a}var zt,qt,$t,Ht=null,Qt=(zt=-1,qt=-1,$t=void 0,function(e){var t=++zt;return Promise.resolve(e).then((function(e){return $t&&t=0||(a[r]=e[r]);return a}(e,t);if(Object.getOwnPropertySymbols){var i=Object.getOwnPropertySymbols(e);for(n=0;n=0||Object.prototype.propertyIsEnumerable.call(e,r)&&(a[r]=e[r])}return a}var nr=/((gt|sm)-|galaxy nexus)|samsung[- ]|samsungbrowser/i;function ar(e){return e.nativeEvent||e}function ir(e){return ir="function"==typeof Symbol&&"symbol"==typeof Symbol.iterator?function(e){return typeof e}:function(e){return e&&"function"==typeof Symbol&&e.constructor===Symbol&&e!==Symbol.prototype?"symbol":typeof e},ir(e)}var or=["props","refresh","store"],sr=["inputElement","formElement","panelElement"],cr=["inputElement"],lr=["inputElement","maxLength"],ur=["source"],dr=["item","source"];function fr(e,t){var r=Object.keys(e);if(Object.getOwnPropertySymbols){var n=Object.getOwnPropertySymbols(e);t&&(n=n.filter((function(t){return Object.getOwnPropertyDescriptor(e,t).enumerable}))),r.push.apply(r,n)}return r}function mr(e){for(var t=1;t=0||(a[r]=e[r]);return a}(e,t);if(Object.getOwnPropertySymbols){var i=Object.getOwnPropertySymbols(e);for(n=0;n=0||Object.prototype.propertyIsEnumerable.call(e,r)&&(a[r]=e[r])}return a}function gr(e){var t=e.props,r=e.refresh,n=e.store,a=br(e,or);return{getEnvironmentProps:function(e){var r=e.inputElement,a=e.formElement,i=e.panelElement;function o(e){!n.getState().isOpen&&n.pendingRequests.isEmpty()||e.target===r||!1===[a,i].some((function(t){return r=t,n=e.target,r===n||r.contains(n);var r,n}))&&(n.dispatch("blur",null),t.debug||n.pendingRequests.cancelAll())}return mr({onTouchStart:o,onMouseDown:o,onTouchMove:function(e){!1!==n.getState().isOpen&&r===t.environment.document.activeElement&&e.target!==r&&r.blur()}},br(e,sr))},getRootProps:function(e){return mr({role:"combobox","aria-expanded":n.getState().isOpen,"aria-haspopup":"listbox","aria-owns":n.getState().isOpen?n.getState().collections.map((function(e){var r=e.source;return Yt(t.id,"list",r)})).join(" "):void 0,"aria-labelledby":Yt(t.id,"label")},e)},getFormProps:function(e){e.inputElement;return mr({action:"",noValidate:!0,role:"search",onSubmit:function(i){var o;i.preventDefault(),t.onSubmit(mr({event:i,refresh:r,state:n.getState()},a)),n.dispatch("submit",null),null===(o=e.inputElement)||void 0===o||o.blur()},onReset:function(i){var o;i.preventDefault(),t.onReset(mr({event:i,refresh:r,state:n.getState()},a)),n.dispatch("reset",null),null===(o=e.inputElement)||void 0===o||o.focus()}},br(e,cr))},getLabelProps:function(e){return mr({htmlFor:Yt(t.id,"input"),id:Yt(t.id,"label")},e)},getInputProps:function(e){var i;function o(e){(t.openOnFocus||Boolean(n.getState().query))&&Zt(mr({event:e,props:t,query:n.getState().completion||n.getState().query,refresh:r,store:n},a)),n.dispatch("focus",null)}var s=e||{},c=(s.inputElement,s.maxLength),l=void 0===c?512:c,u=br(s,lr),d=Lt(n.getState()),f=function(e){return Boolean(e&&e.match(nr))}((null===(i=t.environment.navigator)||void 0===i?void 0:i.userAgent)||""),m=t.enterKeyHint||(null!=d&&d.itemUrl&&!f?"go":"search");return mr({"aria-autocomplete":"both","aria-activedescendant":n.getState().isOpen&&null!==n.getState().activeItemId?Yt(t.id,"item-".concat(n.getState().activeItemId),null==d?void 0:d.source):void 0,"aria-controls":n.getState().isOpen?n.getState().collections.map((function(e){var r=e.source;return Yt(t.id,"list",r)})).join(" "):void 0,"aria-labelledby":Yt(t.id,"label"),value:n.getState().completion||n.getState().query,id:Yt(t.id,"input"),autoComplete:"off",autoCorrect:"off",autoCapitalize:"off",enterKeyHint:m,spellCheck:"false",autoFocus:t.autoFocus,placeholder:t.placeholder,maxLength:l,type:"search",onChange:function(e){var i=e.currentTarget.value;t.ignoreCompositionEvents&&ar(e).isComposing?a.setQuery(i):Zt(mr({event:e,props:t,query:i.slice(0,l),refresh:r,store:n},a))},onCompositionEnd:function(e){Zt(mr({event:e,props:t,query:e.currentTarget.value.slice(0,l),refresh:r,store:n},a))},onKeyDown:function(e){ar(e).isComposing||function(e){var t=e.event,r=e.props,n=e.refresh,a=e.store,i=rr(e,Kt);if("ArrowUp"===t.key||"ArrowDown"===t.key){var o=function(){var e=Lt(a.getState()),t=r.environment.document.getElementById(Yt(r.id,"item-".concat(a.getState().activeItemId),null==e?void 0:e.source));t&&(t.scrollIntoViewIfNeeded?t.scrollIntoViewIfNeeded(!1):t.scrollIntoView(!1))},s=function(){var e=Lt(a.getState());if(null!==a.getState().activeItemId&&e){var r=e.item,o=e.itemInputValue,s=e.itemUrl,c=e.source;c.onActive(er({event:t,item:r,itemInputValue:o,itemUrl:s,refresh:n,source:c,state:a.getState()},i))}};t.preventDefault(),!1===a.getState().isOpen&&(r.openOnFocus||Boolean(a.getState().query))?Zt(er({event:t,props:r,query:a.getState().query,refresh:n,store:a},i)).then((function(){a.dispatch(t.key,{nextActiveItemId:r.defaultActiveItemId}),s(),setTimeout(o,0)})):(a.dispatch(t.key,{}),s(),o())}else if("Escape"===t.key)t.preventDefault(),a.dispatch(t.key,null),a.pendingRequests.cancelAll();else if("Tab"===t.key)a.dispatch("blur",null),a.pendingRequests.cancelAll();else if("Enter"===t.key){if(null===a.getState().activeItemId||a.getState().collections.every((function(e){return 0===e.items.length})))return void(r.debug||a.pendingRequests.cancelAll());t.preventDefault();var c=Lt(a.getState()),l=c.item,u=c.itemInputValue,d=c.itemUrl,f=c.source;if(t.metaKey||t.ctrlKey)void 0!==d&&(f.onSelect(er({event:t,item:l,itemInputValue:u,itemUrl:d,refresh:n,source:f,state:a.getState()},i)),r.navigator.navigateNewTab({itemUrl:d,item:l,state:a.getState()}));else if(t.shiftKey)void 0!==d&&(f.onSelect(er({event:t,item:l,itemInputValue:u,itemUrl:d,refresh:n,source:f,state:a.getState()},i)),r.navigator.navigateNewWindow({itemUrl:d,item:l,state:a.getState()}));else if(t.altKey);else{if(void 0!==d)return f.onSelect(er({event:t,item:l,itemInputValue:u,itemUrl:d,refresh:n,source:f,state:a.getState()},i)),void r.navigator.navigate({itemUrl:d,item:l,state:a.getState()});Zt(er({event:t,nextState:{isOpen:!1},props:r,query:u,refresh:n,store:a},i)).then((function(){f.onSelect(er({event:t,item:l,itemInputValue:u,itemUrl:d,refresh:n,source:f,state:a.getState()},i))}))}}}(mr({event:e,props:t,refresh:r,store:n},a))},onFocus:o,onBlur:ye,onClick:function(r){e.inputElement!==t.environment.document.activeElement||n.getState().isOpen||o(r)}},u)},getPanelProps:function(e){return mr({onMouseDown:function(e){e.preventDefault()},onMouseLeave:function(){n.dispatch("mouseleave",null)}},e)},getListProps:function(e){var r=e||{},n=r.source,a=br(r,ur);return mr({role:"listbox","aria-labelledby":Yt(t.id,"label"),id:Yt(t.id,"list",n)},a)},getItemProps:function(e){var i=e.item,o=e.source,s=br(e,dr);return mr({id:Yt(t.id,"item-".concat(i.__autocomplete_id),o),role:"option","aria-selected":n.getState().activeItemId===i.__autocomplete_id,onMouseMove:function(e){if(i.__autocomplete_id!==n.getState().activeItemId){n.dispatch("mousemove",i.__autocomplete_id);var t=Lt(n.getState());if(null!==n.getState().activeItemId&&t){var o=t.item,s=t.itemInputValue,c=t.itemUrl,l=t.source;l.onActive(mr({event:e,item:o,itemInputValue:s,itemUrl:c,refresh:r,source:l,state:n.getState()},a))}}},onMouseDown:function(e){e.preventDefault()},onClick:function(e){var s=o.getItemInputValue({item:i,state:n.getState()}),c=o.getItemUrl({item:i,state:n.getState()});(c?Promise.resolve():Zt(mr({event:e,nextState:{isOpen:!1},props:t,query:s,refresh:r,store:n},a))).then((function(){o.onSelect(mr({event:e,item:i,itemInputValue:s,itemUrl:c,refresh:r,source:o,state:n.getState()},a))}))}},s)}}}var hr="1.17.0",wr=[{segment:"autocomplete-core",version:hr}];function Ir(e){return Ir="function"==typeof Symbol&&"symbol"==typeof Symbol.iterator?function(e){return typeof e}:function(e){return e&&"function"==typeof Symbol&&e.constructor===Symbol&&e!==Symbol.prototype?"symbol":typeof e},Ir(e)}function xr(e,t){var r=Object.keys(e);if(Object.getOwnPropertySymbols){var n=Object.getOwnPropertySymbols(e);t&&(n=n.filter((function(t){return Object.getOwnPropertyDescriptor(e,t).enumerable}))),r.push.apply(r,n)}return r}function yr(e){for(var t=1;t=r?null===n?null:0:a}function Sr(e){return Sr="function"==typeof Symbol&&"symbol"==typeof Symbol.iterator?function(e){return typeof e}:function(e){return e&&"function"==typeof Symbol&&e.constructor===Symbol&&e!==Symbol.prototype?"symbol":typeof e},Sr(e)}function vr(e,t){var r=Object.keys(e);if(Object.getOwnPropertySymbols){var n=Object.getOwnPropertySymbols(e);t&&(n=n.filter((function(t){return Object.getOwnPropertyDescriptor(e,t).enumerable}))),r.push.apply(r,n)}return r}function Ur(e){for(var t=1;t=5&&((a||!e&&5===n)&&(o.push(n,0,a,r),n=6),e&&(o.push(n,e,0,r),n=6)),a=""},c=0;c"===t?(n=1,a=""):a=t+a[0]:i?t===i?i="":a+=t:'"'===t||"'"===t?i=t:">"===t?(s(),n=1):n&&("="===t?(n=5,r=a,a=""):"/"===t&&(n<5||">"===e[c][l+1])?(s(),3===n&&(o=o[0]),n=o,(o=o[0]).push(2,0,n),n=0):" "===t||"\t"===t||"\n"===t||"\r"===t?(s(),n=2):a+=t),3===n&&"!--"===a&&(n=4,o=o[0])}return s(),o}(e)),t),arguments,[])).length>1?t:t[0]}var Nr=function(e){var t=e.environment,r=t.document.createElementNS("http://www.w3.org/2000/svg","svg");r.setAttribute("class","aa-SubmitIcon"),r.setAttribute("viewBox","0 0 24 24"),r.setAttribute("width","20"),r.setAttribute("height","20"),r.setAttribute("fill","currentColor");var n=t.document.createElementNS("http://www.w3.org/2000/svg","path");return n.setAttribute("d","M16.041 15.856c-0.034 0.026-0.067 0.055-0.099 0.087s-0.060 0.064-0.087 0.099c-1.258 1.213-2.969 1.958-4.855 1.958-1.933 0-3.682-0.782-4.95-2.050s-2.050-3.017-2.050-4.95 0.782-3.682 2.050-4.95 3.017-2.050 4.95-2.050 3.682 0.782 4.95 2.050 2.050 3.017 2.050 4.95c0 1.886-0.745 3.597-1.959 4.856zM21.707 20.293l-3.675-3.675c1.231-1.54 1.968-3.493 1.968-5.618 0-2.485-1.008-4.736-2.636-6.364s-3.879-2.636-6.364-2.636-4.736 1.008-6.364 2.636-2.636 3.879-2.636 6.364 1.008 4.736 2.636 6.364 3.879 2.636 6.364 2.636c2.125 0 4.078-0.737 5.618-1.968l3.675 3.675c0.391 0.391 1.024 0.391 1.414 0s0.391-1.024 0-1.414z"),r.appendChild(n),r},Vr=function(e){var t=e.environment,r=t.document.createElementNS("http://www.w3.org/2000/svg","svg");r.setAttribute("class","aa-ClearIcon"),r.setAttribute("viewBox","0 0 24 24"),r.setAttribute("width","18"),r.setAttribute("height","18"),r.setAttribute("fill","currentColor");var n=t.document.createElementNS("http://www.w3.org/2000/svg","path");return n.setAttribute("d","M5.293 6.707l5.293 5.293-5.293 5.293c-0.391 0.391-0.391 1.024 0 1.414s1.024 0.391 1.414 0l5.293-5.293 5.293 5.293c0.391 0.391 1.024 0.391 1.414 0s0.391-1.024 0-1.414l-5.293-5.293 5.293-5.293c0.391-0.391 0.391-1.024 0-1.414s-1.024-0.391-1.414 0l-5.293 5.293-5.293-5.293c-0.391-0.391-1.024-0.391-1.414 0s-0.391 1.024 0 1.414z"),r.appendChild(n),r},Br=function(e){var t=e.environment.document.createElementNS("http://www.w3.org/2000/svg","svg");return t.setAttribute("class","aa-LoadingIcon"),t.setAttribute("viewBox","0 0 100 100"),t.setAttribute("width","20"),t.setAttribute("height","20"),t.innerHTML='\n \n',t},Gr=["ontouchstart","ontouchend","ontouchmove","ontouchcancel"];function Wr(e,t,r){e[t]=null===r?"":"number"!=typeof r?r:r+"px"}function zr(e){this._listeners[e.type](e)}function qr(e,t,r){var n,a,i=e[t];if("style"===t)if("string"==typeof r)e.style=r;else if(null===r)e.style="";else for(t in r)i&&r[t]===i[t]||Wr(e.style,t,r[t]);else"o"===t[0]&&"n"===t[1]?(n=t!==(t=t.replace(/Capture$/,"")),((a=t.toLowerCase())in e||Gr.includes(a))&&(t=a),t=t.slice(2),e._listeners||(e._listeners={}),e._listeners[t]=r,r?i||e.addEventListener(t,zr,n):e.removeEventListener(t,zr,n)):"list"!==t&&"tagName"!==t&&"form"!==t&&"type"!==t&&"size"!==t&&"download"!==t&&"href"!==t&&t in e?e[t]=null==r?"":r:"function"!=typeof r&&"dangerouslySetInnerHTML"!==t&&(null==r||!1===r&&!/^ar/.test(t)?e.removeAttribute(t):e.setAttribute(t,r))}function $r(e){switch(e){case"onChange":return"onInput";case"onCompositionEnd":return"oncompositionend";default:return e}}function Hr(e,t){for(var r in t)qr(e,$r(r),t[r])}function Qr(e,t){for(var r in t)"o"===r[0]&&"n"===r[1]||qr(e,$r(r),t[r])}var Zr=["children"];function Yr(e){return function(e){if(Array.isArray(e))return Jr(e)}(e)||function(e){if("undefined"!=typeof Symbol&&null!=e[Symbol.iterator]||null!=e["@@iterator"])return Array.from(e)}(e)||function(e,t){if(!e)return;if("string"==typeof e)return Jr(e,t);var r=Object.prototype.toString.call(e).slice(8,-1);"Object"===r&&e.constructor&&(r=e.constructor.name);if("Map"===r||"Set"===r)return Array.from(e);if("Arguments"===r||/^(?:Ui|I)nt(?:8|16|32)(?:Clamped)?Array$/.test(r))return Jr(e,t)}(e)||function(){throw new TypeError("Invalid attempt to spread non-iterable instance.\nIn order to be iterable, non-array objects must have a [Symbol.iterator]() method.")}()}function Jr(e,t){(null==t||t>e.length)&&(t=e.length);for(var r=0,n=new Array(t);r=0||(a[r]=e[r]);return a}(e,t);if(Object.getOwnPropertySymbols){var i=Object.getOwnPropertySymbols(e);for(n=0;n=0||Object.prototype.propertyIsEnumerable.call(e,r)&&(a[r]=e[r])}return a}function Xr(e){return function(t,r){var n=r.children,a=void 0===n?[]:n,i=Kr(r,Zr),o=e.document.createElement(t);return Hr(o,i),o.append.apply(o,Yr(a)),o}}function en(e){return en="function"==typeof Symbol&&"symbol"==typeof Symbol.iterator?function(e){return typeof e}:function(e){return e&&"function"==typeof Symbol&&e.constructor===Symbol&&e!==Symbol.prototype?"symbol":typeof e},en(e)}var tn=["autocompleteScopeApi","environment","classNames","getInputProps","getInputPropsCore","isDetached","state"];function rn(e,t){var r=Object.keys(e);if(Object.getOwnPropertySymbols){var n=Object.getOwnPropertySymbols(e);t&&(n=n.filter((function(t){return Object.getOwnPropertyDescriptor(e,t).enumerable}))),r.push.apply(r,n)}return r}function nn(e){for(var t=1;t=0||(a[r]=e[r]);return a}(e,t);if(Object.getOwnPropertySymbols){var i=Object.getOwnPropertySymbols(e);for(n=0;n=0||Object.prototype.propertyIsEnumerable.call(e,r)&&(a[r]=e[r])}return a}var sn=function(e){var t=e.autocompleteScopeApi,r=e.environment,n=(e.classNames,e.getInputProps),a=e.getInputPropsCore,i=e.isDetached,o=e.state,s=on(e,tn),c=Xr(r)("input",s),l=n(nn({state:o,props:a({inputElement:c}),inputElement:c},t));return Hr(c,nn(nn({},l),{},{onKeyDown:function(e){i&&"Tab"===e.key||l.onKeyDown(e)}})),c};function cn(e){return cn="function"==typeof Symbol&&"symbol"==typeof Symbol.iterator?function(e){return typeof e}:function(e){return e&&"function"==typeof Symbol&&e.constructor===Symbol&&e!==Symbol.prototype?"symbol":typeof e},cn(e)}function ln(e,t){var r=Object.keys(e);if(Object.getOwnPropertySymbols){var n=Object.getOwnPropertySymbols(e);t&&(n=n.filter((function(t){return Object.getOwnPropertyDescriptor(e,t).enumerable}))),r.push.apply(r,n)}return r}function un(e){for(var t=1;t2&&(o.children=arguments.length>3?fn.call(arguments,2):r),"function"==typeof e&&null!=e.defaultProps)for(i in e.defaultProps)void 0===o[i]&&(o[i]=e.defaultProps[i]);return Sn(e,o,n,a,null)}function Sn(e,t,r,n,a){var i={type:e,props:t,key:r,ref:n,__k:null,__:null,__b:0,__e:null,__d:void 0,__c:null,constructor:void 0,__v:null==a?++pn:a,__i:-1,__u:0};return null==a&&null!=mn.vnode&&mn.vnode(i),i}function vn(e){return e.children}function Un(e,t){this.props=e,this.context=t}function Cn(e,t){if(null==t)return e.__?Cn(e.__,e.__i+1):null;for(var r;tr?(Wn(n,t,a),a.length=n.length=0,t=void 0,bn.sort(wn)):t&&mn.__c&&mn.__c(t,xn));t&&Wn(n,t,a),Mn.__r=0}function Tn(e,t,r,n,a,i,o,s,c,l,u){var d,f,m,p,b,g=n&&n.__k||xn,h=t.length;for(r.__d=c,jn(r,t,g),c=r.__d,d=0;d0?Sn(a.type,a.props,a.key,a.ref?a.ref:null,a.__v):a)?(a.__=e,a.__b=e.__b+1,s=Ln(a,r,o,u),a.__i=s,i=null,-1!==s&&(u--,(i=r[s])&&(i.__u|=131072)),null==i||null===i.__v?(-1==s&&d--,"function"!=typeof a.type&&(a.__u|=65536)):s!==o&&(s===o+1?d++:s>o?u>c-o?d+=s-o:d--:s(null!=c&&0==(131072&c.__u)?1:0))for(;o>=0||s=0){if((c=t[o])&&0==(131072&c.__u)&&a==c.key&&i===c.type)return o;o--}if(s0&&void 0!==arguments[0]?arguments[0]:[];return{get:function(){return e},add:function(t){var r=e[e.length-1];(null==r?void 0:r.isHighlighted)===t.isHighlighted?e[e.length-1]={value:r.value+t.value,isHighlighted:r.isHighlighted}:e.push(t)}}}(r?[{value:r,isHighlighted:!1}]:[]);return t.forEach((function(e){var t=e.split(Jn);n.add({value:t[0],isHighlighted:!0}),""!==t[1]&&n.add({value:t[1],isHighlighted:!1})})),n.get()}function Xn(e){return function(e){if(Array.isArray(e))return ea(e)}(e)||function(e){if("undefined"!=typeof Symbol&&null!=e[Symbol.iterator]||null!=e["@@iterator"])return Array.from(e)}(e)||function(e,t){if(!e)return;if("string"==typeof e)return ea(e,t);var r=Object.prototype.toString.call(e).slice(8,-1);"Object"===r&&e.constructor&&(r=e.constructor.name);if("Map"===r||"Set"===r)return Array.from(e);if("Arguments"===r||/^(?:Ui|I)nt(?:8|16|32)(?:Clamped)?Array$/.test(r))return ea(e,t)}(e)||function(){throw new TypeError("Invalid attempt to spread non-iterable instance.\nIn order to be iterable, non-array objects must have a [Symbol.iterator]() method.")}()}function ea(e,t){(null==t||t>e.length)&&(t=e.length);for(var r=0,n=new Array(t);r",""":'"',"'":"'"},aa=new RegExp(/\w/i),ia=/&(amp|quot|lt|gt|#39);/g,oa=RegExp(ia.source);function sa(e,t){var r,n,a,i=e[t],o=(null===(r=e[t+1])||void 0===r?void 0:r.isHighlighted)||!0,s=(null===(n=e[t-1])||void 0===n?void 0:n.isHighlighted)||!0;return aa.test((a=i.value)&&oa.test(a)?a.replace(ia,(function(e){return na[e]})):a)||s!==o?i.isHighlighted:s}function ca(e){return ca="function"==typeof Symbol&&"symbol"==typeof Symbol.iterator?function(e){return typeof e}:function(e){return e&&"function"==typeof Symbol&&e.constructor===Symbol&&e!==Symbol.prototype?"symbol":typeof e},ca(e)}function la(e,t){var r=Object.keys(e);if(Object.getOwnPropertySymbols){var n=Object.getOwnPropertySymbols(e);t&&(n=n.filter((function(t){return Object.getOwnPropertyDescriptor(e,t).enumerable}))),r.push.apply(r,n)}return r}function ua(e){for(var t=1;te.length)&&(t=e.length);for(var r=0,n=new Array(t);r=0||(a[r]=e[r]);return a}(e,t);if(Object.getOwnPropertySymbols){var i=Object.getOwnPropertySymbols(e);for(n=0;n=0||Object.prototype.propertyIsEnumerable.call(e,r)&&(a[r]=e[r])}return a}var va={clearButton:"aa-ClearButton",detachedCancelButton:"aa-DetachedCancelButton",detachedContainer:"aa-DetachedContainer",detachedFormContainer:"aa-DetachedFormContainer",detachedOverlay:"aa-DetachedOverlay",detachedSearchButton:"aa-DetachedSearchButton",detachedSearchButtonIcon:"aa-DetachedSearchButtonIcon",detachedSearchButtonPlaceholder:"aa-DetachedSearchButtonPlaceholder",detachedSearchButtonQuery:"aa-DetachedSearchButtonQuery",form:"aa-Form",input:"aa-Input",inputWrapper:"aa-InputWrapper",inputWrapperPrefix:"aa-InputWrapperPrefix",inputWrapperSuffix:"aa-InputWrapperSuffix",item:"aa-Item",label:"aa-Label",list:"aa-List",loadingIndicator:"aa-LoadingIndicator",panel:"aa-Panel",panelLayout:"aa-PanelLayout aa-Panel--scrollable",root:"aa-Autocomplete",source:"aa-Source",sourceFooter:"aa-SourceFooter",sourceHeader:"aa-SourceHeader",sourceNoResults:"aa-SourceNoResults",submitButton:"aa-SubmitButton"},Ua=function(e,t){var r=e.children;(0,e.render)(r,t)},Ca={createElement:Rn,Fragment:vn,render:Qn};function Pa(e){var t=e.panelPlacement,r=e.container,n=e.form,a=e.environment,i=r.getBoundingClientRect(),o=(a.pageYOffset||a.document.documentElement.scrollTop||a.document.body.scrollTop||0)+i.top+i.height;switch(t){case"start":return{top:o,left:i.left};case"end":return{top:o,right:a.document.documentElement.clientWidth-(i.left+i.width)};case"full-width":return{top:o,left:0,right:0,width:"unset",maxWidth:"unset"};case"input-wrapper-width":var s=n.getBoundingClientRect();return{top:o,left:s.left,right:a.document.documentElement.clientWidth-(s.left+s.width),width:"unset",maxWidth:"unset"};default:throw new Error("[Autocomplete] The `panelPlacement` value ".concat(JSON.stringify(t)," is not valid."))}}function Oa(e){return Oa="function"==typeof Symbol&&"symbol"==typeof Symbol.iterator?function(e){return typeof e}:function(e){return e&&"function"==typeof Symbol&&e.constructor===Symbol&&e!==Symbol.prototype?"symbol":typeof e},Oa(e)}function _a(){return _a=Object.assign?Object.assign.bind():function(e){for(var t=1;te.length)&&(t=e.length);for(var r=0,n=new Array(t);re.length)&&(t=e.length);for(var r=0,n=new Array(t);r=0||(a[r]=e[r]);return a}(e,t);if(Object.getOwnPropertySymbols){var i=Object.getOwnPropertySymbols(e);for(n=0;n=0||Object.prototype.propertyIsEnumerable.call(e,r)&&(a[r]=e[r])}return a}function Ja(e,t){var r=Object.keys(e);if(Object.getOwnPropertySymbols){var n=Object.getOwnPropertySymbols(e);t&&(n=n.filter((function(t){return Object.getOwnPropertyDescriptor(e,t).enumerable}))),r.push.apply(r,n)}return r}function Ka(e){for(var t=1;t0;if(!f.value.core.openOnFocus&&!t.query)return r;var n=Boolean(l.current||f.value.renderer.renderNoResults);return!r&&n||r},__autocomplete_metadata:{userAgents:Aa,options:e}}))})),b=we(Ka({collections:[],completion:null,context:{},isOpen:!1,query:"",activeItemId:null,status:"idle"},f.value.core.initialState)),g={getEnvironmentProps:f.value.renderer.getEnvironmentProps,getFormProps:f.value.renderer.getFormProps,getInputProps:f.value.renderer.getInputProps,getItemProps:f.value.renderer.getItemProps,getLabelProps:f.value.renderer.getLabelProps,getListProps:f.value.renderer.getListProps,getPanelProps:f.value.renderer.getPanelProps,getRootProps:f.value.renderer.getRootProps},h={setActiveItemId:p.value.setActiveItemId,setQuery:p.value.setQuery,setCollections:p.value.setCollections,setIsOpen:p.value.setIsOpen,setStatus:p.value.setStatus,setContext:p.value.setContext,refresh:p.value.refresh,navigator:p.value.navigator},w=s((function(){return Dr.bind(f.value.renderer.renderer.createElement)})),I=s((function(){return function(e){var t=e.autocomplete,r=e.autocompleteScopeApi,n=e.classNames,a=e.environment,i=e.isDetached,o=e.placeholder,s=void 0===o?"Search":o,c=e.propGetters,l=e.setIsModalOpen,u=e.state,d=e.translations,f=Xr(a),m=c.getRootProps(un({state:u,props:t.getRootProps({})},r)),p=f("div",un({class:n.root},m)),b=f("div",{class:n.detachedContainer,onMouseDown:function(e){e.stopPropagation()}}),g=f("div",{class:n.detachedOverlay,children:[b],onMouseDown:function(){l(!1),t.setIsOpen(!1)}}),h=c.getLabelProps(un({state:u,props:t.getLabelProps({})},r)),w=f("button",{class:n.submitButton,type:"submit",title:d.submitButtonTitle,children:[Nr({environment:a})]}),I=f("label",un({class:n.label,children:[w]},h)),x=f("button",{class:n.clearButton,type:"reset",title:d.clearButtonTitle,children:[Vr({environment:a})]}),y=f("div",{class:n.loadingIndicator,children:[Br({environment:a})]}),k=sn({class:n.input,environment:a,state:u,getInputProps:c.getInputProps,getInputPropsCore:t.getInputProps,autocompleteScopeApi:r,isDetached:i}),E=f("div",{class:n.inputWrapperPrefix,children:[I,y]}),F=f("div",{class:n.inputWrapperSuffix,children:[x]}),R=f("div",{class:n.inputWrapper,children:[k]}),S=c.getFormProps(un({state:u,props:t.getFormProps({inputElement:k})},r)),v=f("form",un({class:n.form,children:[E,R,F]},S)),U=c.getPanelProps(un({state:u,props:t.getPanelProps({})},r)),C=f("div",un({class:n.panel},U)),P=f("div",{class:n.detachedSearchButtonQuery,textContent:u.query}),O=f("div",{class:n.detachedSearchButtonPlaceholder,hidden:Boolean(u.query),textContent:s});if(i){var _=f("div",{class:n.detachedSearchButtonIcon,children:[Nr({environment:a})]}),M=f("button",{type:"button",class:n.detachedSearchButton,title:d.detachedSearchButtonTitle,id:h.id,onClick:function(){l(!0)},children:[_,O,P]}),T=f("button",{type:"button",class:n.detachedCancelButton,textContent:d.detachedCancelButtonText,onTouchStart:function(e){e.stopPropagation()},onClick:function(){t.setIsOpen(!1),l(!1)}}),j=f("div",{class:n.detachedFormContainer,children:[v,T]});b.appendChild(j),p.appendChild(M)}else p.appendChild(v);return{detachedContainer:b,detachedOverlay:g,detachedSearchButtonQuery:P,detachedSearchButtonPlaceholder:O,inputWrapper:R,input:k,root:p,form:v,label:I,submitButton:w,clearButton:x,loadingIndicator:y,panel:C}}({autocomplete:p.value,autocompleteScopeApi:h,classNames:f.value.renderer.classNames,environment:f.value.core.environment,isDetached:m.value,placeholder:f.value.core.placeholder,propGetters:g,setIsModalOpen:E,state:b.current,translations:f.value.renderer.translations})}));function x(){Hr(I.value.panel,{style:m.value?{}:Pa({panelPlacement:f.value.renderer.panelPlacement,container:I.value.root,form:I.value.form,environment:f.value.core.environment})})}function y(e){b.current=e;var t={autocomplete:p.value,autocompleteScopeApi:h,classNames:f.value.renderer.classNames,components:f.value.renderer.components,container:f.value.renderer.container,html:w.value,dom:I.value,panelContainer:m.value?I.value.detachedContainer:f.value.renderer.panelContainer,propGetters:g,state:b.current,renderer:f.value.renderer.renderer},r=!it(e)&&!l.current&&f.value.renderer.renderNoResults||f.value.renderer.render;!function(e){var t=e.autocomplete,r=e.autocompleteScopeApi,n=e.dom,a=e.propGetters,i=e.state;Qr(n.root,a.getRootProps(Ta({state:i,props:t.getRootProps({})},r))),Qr(n.input,a.getInputProps(Ta({state:i,props:t.getInputProps({inputElement:n.input}),inputElement:n.input},r))),Hr(n.label,{hidden:"stalled"===i.status}),Hr(n.loadingIndicator,{hidden:"stalled"!==i.status}),Hr(n.clearButton,{hidden:!i.query}),Hr(n.detachedSearchButtonQuery,{textContent:i.query}),Hr(n.detachedSearchButtonPlaceholder,{hidden:Boolean(i.query)})}(t),function(e,t){var r=t.autocomplete,n=t.autocompleteScopeApi,a=t.classNames,i=t.html,o=t.dom,s=t.panelContainer,c=t.propGetters,l=t.state,u=t.components,d=t.renderer;if(l.isOpen){s.contains(o.panel)||"loading"===l.status||s.appendChild(o.panel),o.panel.classList.toggle("aa-Panel--stalled","stalled"===l.status);var f=l.collections.filter((function(e){var t=e.source,r=e.items;return t.templates.noResults||r.length>0})).map((function(e,t){var o=e.source,s=e.items;return d.createElement("section",{key:t,className:a.source,"data-autocomplete-source-id":o.sourceId},o.templates.header&&d.createElement("div",{className:a.sourceHeader},o.templates.header({components:u,createElement:d.createElement,Fragment:d.Fragment,items:s,source:o,state:l,html:i})),o.templates.noResults&&0===s.length?d.createElement("div",{className:a.sourceNoResults},o.templates.noResults({components:u,createElement:d.createElement,Fragment:d.Fragment,source:o,state:l,html:i})):d.createElement("ul",_a({className:a.list},c.getListProps(Ta({state:l,props:r.getListProps({source:o})},n))),s.map((function(e){var t=r.getItemProps({item:e,source:o});return d.createElement("li",_a({key:t.id,className:a.item},c.getItemProps(Ta({state:l,props:t},n))),o.templates.item({components:u,createElement:d.createElement,Fragment:d.Fragment,item:e,state:l,html:i}))}))),o.templates.footer&&d.createElement("div",{className:a.sourceFooter},o.templates.footer({components:u,createElement:d.createElement,Fragment:d.Fragment,items:s,source:o,state:l,html:i})))})),m=d.createElement(d.Fragment,null,d.createElement("div",{className:a.panelLayout},f),d.createElement("div",{className:"aa-GradientBottom"})),p=f.reduce((function(e,t){return e[t.props["data-autocomplete-source-id"]]=t,e}),{});e(Ta(Ta({children:m,state:l,sections:f,elements:p},d),{},{components:u,html:i},n),o.panel)}else s.contains(o.panel)&&s.removeChild(o.panel)}(r,t)}function k(){var e=arguments.length>0&&void 0!==arguments[0]?arguments[0]:{};a();var t,r,n=f.value.renderer,o=n.components,s=Ya(n,Qa);u.current=Ba(s,f.value.core,{components:(t=o,r=function(e){return!e.value.hasOwnProperty("__autocomplete_componentName")},Object.entries(t).reduce((function(e,t){var n=$a(t,2),a=n[0],i=n[1];return r({key:a,value:i})?za(za({},e),{},qa({},a,i)):e}),{})),initialState:b.current},e),c(),i(),p.value.refresh().then((function(){y(b.current)}))}function E(e){e!==f.value.core.environment.document.body.contains(I.value.detachedOverlay)&&(e?(f.value.core.environment.document.body.appendChild(I.value.detachedOverlay),f.value.core.environment.document.body.classList.add("aa-Detached"),I.value.input.focus()):(f.value.core.environment.document.body.removeChild(I.value.detachedOverlay),f.value.core.environment.document.body.classList.remove("aa-Detached")))}return n((function(){var e=p.value.getEnvironmentProps({formElement:I.value.form,panelElement:I.value.panel,inputElement:I.value.input});return Hr(f.value.core.environment,e),function(){Hr(f.value.core.environment,Object.keys(e).reduce((function(e,t){return Ka(Ka({},e),{},Xa({},t,void 0))}),{}))}})),n((function(){var e=m.value?f.value.core.environment.document.body:f.value.renderer.panelContainer,t=m.value?I.value.detachedOverlay:I.value.panel;return m.value&&b.current.isOpen&&E(!0),y(b.current),function(){e.contains(t)&&e.removeChild(t)}})),n((function(){var e=f.value.renderer.container;return e.appendChild(I.value.root),function(){e.removeChild(I.value.root)}})),n((function(){var e=he((function(e){y(e.state)}),0);return d.current=function(t){var r=t.state,n=t.prevState;(m.value&&n.isOpen!==r.isOpen&&E(r.isOpen),m.value||!r.isOpen||n.isOpen||x(),r.query!==n.query)&&f.value.core.environment.document.querySelectorAll(".aa-Panel--scrollable").forEach((function(e){0!==e.scrollTop&&(e.scrollTop=0)}));e({state:r})},function(){d.current=void 0}})),n((function(){var e=he((function(){var e=m.value;m.value=f.value.core.environment.matchMedia(f.value.renderer.detachedMediaQuery).matches,e!==m.value?k({}):requestAnimationFrame(x)}),20);return f.value.core.environment.addEventListener("resize",e),function(){f.value.core.environment.removeEventListener("resize",e)}})),n((function(){if(!m.value)return function(){};function e(e){I.value.detachedContainer.classList.toggle("aa-DetachedContainer--modal",e)}function t(t){e(t.matches)}var r=f.value.core.environment.matchMedia(getComputedStyle(f.value.core.environment.document.documentElement).getPropertyValue("--aa-detached-modal-media-query"));e(r.matches);var n=Boolean(r.addEventListener);return n?r.addEventListener("change",t):r.addListener(t),function(){n?r.removeEventListener("change",t):r.removeListener(t)}})),n((function(){return requestAnimationFrame(x),function(){}})),Ka(Ka({},h),{},{update:k,destroy:function(){a()}})}var ti=r(31514);const ri=r(55351),ni=ri;var ai=r(813),ii=r.n(ai);function oi(){const e=(0,c.TH)(),t=(0,c.k6)(),{siteConfig:{baseUrl:r}}=(0,ce.Z)(),[a,i]=(0,n.useState)({terms:[],isDocsOrBlog:!1});return(0,n.useEffect)((()=>{if(!e.state?.cmfcmfhighlight||0===e.state.cmfcmfhighlight.terms.length)return;i(e.state.cmfcmfhighlight);const{cmfcmfhighlight:r,...n}=e.state;t.replace({...e,state:n})}),[e.state?.cmfcmfhighlight,t,e]),(0,n.useEffect)((()=>{if(0===a.terms.length)return;const e=a.isDocsOrBlog?document.getElementsByTagName("article")[0]:document.getElementsByTagName("main")[0];if(!e)return;const t=new(ii())(e),r={ignoreJoiners:!0};return t.mark(a.terms,r),()=>t.unmark(r)}),[a,r]),null}var si=r(31610),ci=r(60246);function li(e){let{document:t}=e;const[r,n]=t.sectionRoute.split("#");let a=r;return n&&(a+="#"+n),a}const ui={documents:[],index:ni((function(){this.ref("id"),this.field("title"),this.field("content")}))};const di=()=>{const e=(0,N.Z)(),[t,r]=(0,n.useState)((()=>!!e&&"dark"===document.documentElement.getAttribute("data-theme")));(0,n.useEffect)((()=>{const e=new MutationObserver((()=>{r("dark"===document.documentElement.getAttribute("data-theme"))}));return e.observe(document.documentElement,{attributes:!0,attributeFilter:["data-theme"]}),()=>e.disconnect()}),[]);const{siteConfig:{baseUrl:a}}=(0,ce.Z)(),{titleBoost:i,contentBoost:o,tagsBoost:s,parentCategoriesBoost:u,indexDocSidebarParentCategories:d,maxSearchResults:f}=(0,si.eZ)("@cmfcmf/docusaurus-search-local"),m=(0,c.k6)(),{tags:p}=(0,ci._q)(),b=(0,n.useRef)(p);(0,n.useEffect)((()=>{b.current=p}),[p]);const g=(0,n.useRef)({}),h=async e=>{const t=g.current[e];switch(t?.state){case"ready":return t;case void 0:{const t=[];g.current[e]={state:"loading",callbacks:t};const r=await async function(e,t){{let n;try{const r=await fetch(`${e}search-index-${t}.json`);if(!r.ok)return ui;n=await r.json()}catch(r){return ui}return{documents:n.documents,index:ni.Index.load(n.index)}}}(a,e);return t.forEach((e=>e(r))),g.current[e]={state:"ready",...r}}case"loading":return new Promise((e=>{t.callbacks.push(e)}))}},w=(0,l.I)({message:"cmfcmf/d-s-l.searchBar.placeholder",description:"Placeholder shown in the searchbar"}),I=(0,n.useRef)(null),x=(0,n.useRef)(null);return(0,n.useEffect)((()=>{if(I.current)return x.current=ei({container:I.current,placeholder:w,renderer:{createElement:n.createElement,Fragment:n.Fragment,render:ge.render},navigator:{navigate(e){let{item:t,itemUrl:r}=e;m.push(r,{cmfcmfhighlight:{terms:t.terms,isDocsOrBlog:"docs"===t.document.type||"blog"===t.document.type}})}},detachedMediaQuery:"",defaultActiveItemId:0,translations:{clearButtonTitle:(0,l.I)({message:"cmfcmf/d-s-l.searchBar.clearButtonTitle",description:"Title of the button to clear the current search input"}),detachedCancelButtonText:(0,l.I)({message:"cmfcmf/d-s-l.searchBar.detachedCancelButtonText",description:"Text of the button to close the detached search window"}),submitButtonTitle:(0,l.I)({message:"cmfcmf/d-s-l.searchBar.submitButtonTitle",description:"Title of the button to submit a new search"})},getSources(e){let{query:t}=e;return[{sourceId:"search-results",templates:{item(e){let{item:t}=e;const r=li(t);return n.createElement("a",{href:r,className:"aa-ItemLink",onClick:e=>{e.preventDefault(),m.push(r,{cmfcmfhighlight:{terms:t.terms,isDocsOrBlog:"docs"===t.document.type||"blog"===t.document.type}})}},n.createElement("div",{className:"aa-ItemContent"},n.createElement("div",{className:"aa-ItemContentBody"},n.createElement("div",{className:"aa-ItemContentTitle"},t.document.sectionTitle),t.document.pageTitle!==t.document.sectionTitle&&n.createElement("div",{className:"aa-ItemContentDescription"},t.document.pageTitle))),n.createElement("div",{className:"aa-ItemActions"},n.createElement("button",{className:"aa-ItemActionButton aa-DesktopOnly aa-ActiveOnly",type:"button",title:"Select"},n.createElement("svg",{viewBox:"0 0 24 24",width:"20",height:"20",fill:"currentColor"},n.createElement("path",{d:"M18.984 6.984h2.016v6h-15.188l3.609 3.609-1.406 1.406-6-6 6-6 1.406 1.406-3.609 3.609h13.172v-4.031z"})))))},noResults:()=>n.createElement("div",{className:"aa-ItemContent"},n.createElement("div",{className:"aa-ItemContentBody"},(0,l.I)({message:"cmfcmf/d-s-l.searchBar.noResults",description:"message shown if no results are found"})))},getItemUrl(e){let{item:t}=e;return li(t)},async getItems(){const e=b.current,r=await Promise.all(e.map((e=>h(e)))),n=(e=>ri.tokenizer(e).map((e=>e.str)))(t);return r.flatMap((e=>{let{index:t,documents:r}=e;return t.query((e=>{e.term(n,{fields:["title"],boost:i}),e.term(n,{fields:["title"],boost:i,wildcard:ni.Query.wildcard.TRAILING}),e.term(n,{fields:["content"],boost:o}),e.term(n,{fields:["content"],boost:o,wildcard:ni.Query.wildcard.TRAILING}),e.term(n,{fields:["tags"],boost:s}),e.term(n,{fields:["tags"],boost:s,wildcard:ni.Query.wildcard.TRAILING}),d&&(e.term(n,{fields:["sidebarParentCategories"],boost:u}),e.term(n,{fields:["sidebarParentCategories"],boost:u,wildcard:ni.Query.wildcard.TRAILING}))})).slice(0,f).map((e=>({document:r.find((t=>t.id.toString()===e.ref)),score:e.score,terms:n})))})).sort(((e,t)=>t.score-e.score)).slice(0,f)}}]}}),()=>x.current?.destroy()}),[f]),n.createElement(n.Fragment,null,n.createElement(ti.Z,null,n.createElement("body",{"data-theme":t?"dark":"light"})),n.createElement(oi,null),n.createElement("div",{className:"dsla-search-wrapper"},n.createElement("div",{className:"dsla-search-field",ref:I,"data-tags":p.join(",")})))},fi={searchBox:"searchBox_ZlJk"};function mi(e){let{children:t,className:r}=e;return n.createElement("div",{className:(0,a.Z)(r,fi.searchBox)},t)}var pi=r(30868),bi=r(78259);var gi=r(86409);const hi=e=>e.docs.find((t=>t.id===e.mainDocId));const wi={default:ie,localeDropdown:function(e){let{mobile:t,dropdownItemsBefore:r,dropdownItemsAfter:a,...i}=e;const{i18n:{currentLocale:o,locales:u,localeConfigs:d}}=(0,ce.Z)(),f=(0,me.l)(),{search:m,hash:p}=(0,c.TH)(),b=[...r,...u.map((e=>{const r=`${`pathname://${f.createUrl({locale:e,fullyQualified:!1})}`}${m}${p}`;return{label:d[e].label,lang:d[e].htmlLang,to:r,target:"_self",autoAddBaseUrl:!1,className:e===o?t?"menu__link--active":"dropdown__link--active":""}})),...a],g=t?(0,l.I)({message:"Languages",id:"theme.navbar.mobileLanguageDropdown.label",description:"The label for the mobile language switcher dropdown"}):d[o].label;return n.createElement(fe,(0,s.Z)({},i,{mobile:t,label:n.createElement(n.Fragment,null,n.createElement(pe,{className:be}),g),items:b}))},search:function(e){let{mobile:t,className:r}=e;return t?null:n.createElement(mi,{className:r},n.createElement(di,null))},dropdown:fe,html:function(e){let{value:t,className:r,mobile:i=!1,isDropdownItem:o=!1}=e;const s=o?"li":"div";return n.createElement(s,{className:(0,a.Z)({navbar__item:!i&&!o,"menu__list-item":i},r),dangerouslySetInnerHTML:{__html:t}})},doc:function(e){let{docId:t,label:r,docsPluginId:a,...i}=e;const{activeDoc:o}=(0,pi.Iw)(a),c=(0,bi.vY)(t,a);return null===c?null:n.createElement(ie,(0,s.Z)({exact:!0},i,{isActive:()=>o?.path===c.path||!!o?.sidebar&&o.sidebar===c.sidebar,label:r??c.id,to:c.path}))},docSidebar:function(e){let{sidebarId:t,label:r,docsPluginId:a,...i}=e;const{activeDoc:o}=(0,pi.Iw)(a),c=(0,bi.oz)(t,a).link;if(!c)throw new Error(`DocSidebarNavbarItem: Sidebar with ID "${t}" doesn't have anything to be linked to.`);return n.createElement(ie,(0,s.Z)({exact:!0},i,{isActive:()=>o?.sidebar===t,label:r??c.label,to:c.path}))},docsVersion:function(e){let{label:t,to:r,docsPluginId:a,...i}=e;const o=(0,bi.lO)(a)[0],c=t??o.label,l=r??(e=>e.docs.find((t=>t.id===e.mainDocId)))(o).path;return n.createElement(ie,(0,s.Z)({},i,{label:c,to:l}))},docsVersionDropdown:function(e){let{mobile:t,docsPluginId:r,dropdownActiveClassDisabled:a,dropdownItemsBefore:i,dropdownItemsAfter:o,...u}=e;const{search:d,hash:f}=(0,c.TH)(),m=(0,pi.Iw)(r),p=(0,pi.gB)(r),{savePreferredVersionName:b}=(0,gi.J)(r),g=p.map((e=>{const t=m.alternateDocVersions[e.name]??hi(e);return{label:e.label,to:`${t.path}${d}${f}`,isActive:()=>e===m.activeVersion,onClick:()=>b(e.name)}})),h=[...i,...g,...o],w=(0,bi.lO)(r)[0],I=t&&h.length>1?(0,l.I)({id:"theme.navbar.mobileVersionsDropdown.label",message:"Versions",description:"The label for the navbar versions dropdown on mobile view"}):w.label,x=t&&h.length>1?void 0:hi(w).path;return h.length<=1?n.createElement(ie,(0,s.Z)({},u,{mobile:t,label:I,to:x,isActive:a?()=>!1:void 0})):n.createElement(fe,(0,s.Z)({},u,{mobile:t,label:I,to:x,items:h,isActive:a?()=>!1:void 0}))}},Ii=wi;function xi(e){let{type:t,...r}=e;const a=function(e,t){return e&&"default"!==e?e:"items"in t?"dropdown":"default"}(t,r),i=Ii[a];if(!i)throw new Error(`No NavbarItem component found for type "${t}".`);return n.createElement(i,r)}function yi(){const e=(0,C.e)(),t=(0,x.L)().navbar.items;return n.createElement("ul",{className:"menu__list"},t.map(((t,r)=>n.createElement(xi,(0,s.Z)({mobile:!0},t,{onClick:()=>e.toggle(),key:r})))))}function ki(e){return n.createElement("button",(0,s.Z)({},e,{type:"button",className:"clean-btn navbar-sidebar__back"}),n.createElement(l.Z,{id:"theme.navbar.mobileSidebarSecondaryMenu.backButtonLabel",description:"The label of the back button to return to main menu, inside the mobile navbar sidebar secondary menu (notably used to display the docs sidebar)"},"\u2190 Back to main menu"))}function Ei(){const e=0===(0,x.L)().navbar.items.length,t=A();return n.createElement(n.Fragment,null,!e&&n.createElement(ki,{onClick:()=>t.hide()}),t.content)}function Fi(){const e=(0,C.e)();var t;return void 0===(t=e.shown)&&(t=!0),(0,n.useEffect)((()=>(document.body.style.overflow=t?"hidden":"visible",()=>{document.body.style.overflow="visible"})),[t]),e.shouldRender?n.createElement(L,{header:n.createElement(Y,null),primaryMenu:n.createElement(yi,null),secondaryMenu:n.createElement(Ei,null)}):null}const Ri={navbarHideable:"navbarHideable_m1mJ",navbarHidden:"navbarHidden_jGov"};function Si(e){return n.createElement("div",(0,s.Z)({role:"presentation"},e,{className:(0,a.Z)("navbar-sidebar__backdrop",e.className)}))}function vi(e){let{children:t}=e;const{navbar:{hideOnScroll:r,style:i}}=(0,x.L)(),o=(0,C.e)(),{navbarRef:s,isNavbarVisible:c}=function(e){const[t,r]=(0,n.useState)(e),a=(0,n.useRef)(!1),i=(0,n.useRef)(0),o=(0,n.useCallback)((e=>{null!==e&&(i.current=e.getBoundingClientRect().height)}),[]);return(0,P.RF)(((t,n)=>{let{scrollY:o}=t;if(!e)return;if(o=s?r(!1):o+l{if(!e)return;const n=t.location.hash;if(n?document.getElementById(n.substring(1)):void 0)return a.current=!0,void r(!1);r(!0)})),{navbarRef:o,isNavbarVisible:t}}(r);return n.createElement("nav",{ref:s,"aria-label":(0,l.I)({id:"theme.NavBar.navAriaLabel",message:"Main",description:"The ARIA label for the main navigation"}),className:(0,a.Z)("navbar","navbar--fixed-top",r&&[Ri.navbarHideable,!c&&Ri.navbarHidden],{"navbar--dark":"dark"===i,"navbar--primary":"primary"===i,"navbar-sidebar--show":o.shown})},t,n.createElement(Si,{onClick:o.toggle}),n.createElement(Fi,null))}var Ui=r(63905);const Ci={errorBoundaryError:"errorBoundaryError_a6uf"};function Pi(e){return n.createElement("button",(0,s.Z)({type:"button"},e),n.createElement(l.Z,{id:"theme.ErrorPageContent.tryAgain",description:"The label of the button to try again rendering when the React error boundary captures an error"},"Try again"))}function Oi(e){let{error:t}=e;const r=(0,Ui.getErrorCausalChain)(t).map((e=>e.message)).join("\n\nCause:\n");return n.createElement("p",{className:Ci.errorBoundaryError},r)}class _i extends n.Component{componentDidCatch(e,t){throw this.props.onError(e,t)}render(){return this.props.children}}const Mi="right";function Ti(e){let{width:t=30,height:r=30,className:a,...i}=e;return n.createElement("svg",(0,s.Z)({className:a,width:t,height:r,viewBox:"0 0 30 30","aria-hidden":"true"},i),n.createElement("path",{stroke:"currentColor",strokeLinecap:"round",strokeMiterlimit:"10",strokeWidth:"2",d:"M4 7h22M4 15h22M4 23h22"}))}function ji(){const{toggle:e,shown:t}=(0,C.e)();return n.createElement("button",{onClick:e,"aria-label":(0,l.I)({id:"theme.docs.sidebar.toggleSidebarButtonAriaLabel",message:"Toggle navigation bar",description:"The ARIA label for hamburger menu button of mobile navigation"}),"aria-expanded":t,className:"navbar__toggle clean-btn",type:"button"},n.createElement(Ti,null))}const Ai={colorModeToggle:"colorModeToggle_DEke"};function Li(e){let{items:t}=e;return n.createElement(n.Fragment,null,t.map(((e,t)=>n.createElement(_i,{key:t,onError:t=>new Error(`A theme navbar item failed to render.\nPlease double-check the following navbar item (themeConfig.navbar.items) of your Docusaurus config:\n${JSON.stringify(e,null,2)}`,{cause:t})},n.createElement(xi,e)))))}function Di(e){let{left:t,right:r}=e;return n.createElement("div",{className:"navbar__inner"},n.createElement("div",{className:"navbar__items"},t),n.createElement("div",{className:"navbar__items navbar__items--right"},r))}function Ni(){const e=(0,C.e)(),t=(0,x.L)().navbar.items,[r,a]=function(e){function t(e){return"left"===(e.position??Mi)}return[e.filter(t),e.filter((e=>!t(e)))]}(t),i=t.find((e=>"search"===e.type));return n.createElement(Di,{left:n.createElement(n.Fragment,null,!e.disabled&&n.createElement(ji,null),n.createElement(Q,null),n.createElement(Li,{items:r})),right:n.createElement(n.Fragment,null,n.createElement(Li,{items:a}),n.createElement($,{className:Ai.colorModeToggle}),!i&&n.createElement(mi,null,n.createElement(di,null)))})}function Vi(){return n.createElement(vi,null,n.createElement(Ni,null))}function Bi(e){let{item:t}=e;const{to:r,href:a,label:i,prependBaseUrlToHref:o,...c}=t,l=(0,K.Z)(r),u=(0,K.Z)(a,{forcePrependBaseUrl:!0});return n.createElement(J.Z,(0,s.Z)({className:"footer__link-item"},a?{href:o?u:a}:{to:l},c),i,a&&!(0,X.Z)(a)&&n.createElement(te.Z,null))}function Gi(e){let{item:t}=e;return t.html?n.createElement("li",{className:"footer__item",dangerouslySetInnerHTML:{__html:t.html}}):n.createElement("li",{key:t.href??t.to,className:"footer__item"},n.createElement(Bi,{item:t}))}function Wi(e){let{column:t}=e;return n.createElement("div",{className:"col footer__col"},n.createElement("div",{className:"footer__title"},t.title),n.createElement("ul",{className:"footer__items clean-list"},t.items.map(((e,t)=>n.createElement(Gi,{key:t,item:e})))))}function zi(e){let{columns:t}=e;return n.createElement("div",{className:"row footer__links"},t.map(((e,t)=>n.createElement(Wi,{key:t,column:e}))))}function qi(){return n.createElement("span",{className:"footer__link-separator"},"\xb7")}function $i(e){let{item:t}=e;return t.html?n.createElement("span",{className:"footer__link-item",dangerouslySetInnerHTML:{__html:t.html}}):n.createElement(Bi,{item:t})}function Hi(e){let{links:t}=e;return n.createElement("div",{className:"footer__links text--center"},n.createElement("div",{className:"footer__links"},t.map(((e,r)=>n.createElement(n.Fragment,{key:r},n.createElement($i,{item:e}),t.length!==r+1&&n.createElement(qi,null))))))}function Qi(e){let{links:t}=e;return function(e){return"title"in e[0]}(t)?n.createElement(zi,{columns:t}):n.createElement(Hi,{links:t})}var Zi=r(7909);const Yi={footerLogoLink:"footerLogoLink_BH7S"};function Ji(e){let{logo:t}=e;const{withBaseUrl:r}=(0,K.C)(),i={light:r(t.src),dark:r(t.srcDark??t.src)};return n.createElement(Zi.Z,{className:(0,a.Z)("footer__logo",t.className),alt:t.alt,sources:i,width:t.width,height:t.height,style:t.style})}function Ki(e){let{logo:t}=e;return t.href?n.createElement(J.Z,{href:t.href,className:Yi.footerLogoLink,target:t.target},n.createElement(Ji,{logo:t})):n.createElement(Ji,{logo:t})}function Xi(e){let{copyright:t}=e;return n.createElement("div",{className:"footer__copyright",dangerouslySetInnerHTML:{__html:t}})}function eo(e){let{style:t,links:r,logo:i,copyright:o}=e;return n.createElement("footer",{className:(0,a.Z)("footer",{"footer--dark":"dark"===t})},n.createElement("div",{className:"container container-fluid"},r,(i||o)&&n.createElement("div",{className:"footer__bottom text--center"},i&&n.createElement("div",{className:"margin-bottom--sm"},i),o)))}function to(){const{footer:e}=(0,x.L)();if(!e)return null;const{copyright:t,links:r,logo:a,style:i}=e;return n.createElement(eo,{style:i,links:r&&r.length>0&&n.createElement(Qi,{links:r}),logo:a&&n.createElement(Ki,{logo:a}),copyright:t&&n.createElement(Xi,{copyright:t})})}const ro=n.memo(to),no=(0,O.Qc)([D.S,y.pl,P.OC,gi.L5,o.VC,function(e){let{children:t}=e;return n.createElement(_.n2,null,n.createElement(C.M,null,n.createElement(T,null,t)))}]);function ao(e){let{children:t}=e;return n.createElement(no,null,t)}function io(e){let{error:t,tryAgain:r}=e;return n.createElement("main",{className:"container margin-vert--xl"},n.createElement("div",{className:"row"},n.createElement("div",{className:"col col--6 col--offset-3"},n.createElement("h1",{className:"hero__title"},n.createElement(l.Z,{id:"theme.ErrorPageContent.title",description:"The title of the fallback page when the page crashed"},"This page crashed.")),n.createElement("div",{className:"margin-vert--lg"},n.createElement(Pi,{onClick:r,className:"button button--primary shadow--lw"})),n.createElement("hr",null),n.createElement("div",{className:"margin-vert--md"},n.createElement(Oi,{error:t})))))}const oo={mainWrapper:"mainWrapper_z2l0"};function so(e){const{children:t,noFooter:r,wrapperClassName:s,title:c,description:l}=e;return(0,h.t)(),n.createElement(ao,null,n.createElement(o.d,{title:c,description:l}),n.createElement(I,null),n.createElement(U,null),n.createElement(Vi,null),n.createElement("div",{id:d,className:(0,a.Z)(g.k.wrapper.main,oo.mainWrapper,s)},n.createElement(i.Z,{fallback:e=>n.createElement(io,e)},t)),!r&&n.createElement(ro,null))}},96811:(e,t,r)=>{"use strict";r.d(t,{Z:()=>d});var n=r(87462),a=r(67294),i=r(83699),o=r(79524),s=r(39962),c=r(20107),l=r(7909);function u(e){let{logo:t,alt:r,imageClassName:n}=e;const i={light:(0,o.Z)(t.src),dark:(0,o.Z)(t.srcDark||t.src)},s=a.createElement(l.Z,{className:t.className,sources:i,height:t.height,width:t.width,alt:r,style:t.style});return n?a.createElement("div",{className:n},s):s}function d(e){const{siteConfig:{title:t}}=(0,s.Z)(),{navbar:{title:r,logo:l}}=(0,c.L)(),{imageClassName:d,titleClassName:f,...m}=e,p=(0,o.Z)(l?.href||"/"),b=r?"":t,g=l?.alt??b;return a.createElement(i.Z,(0,n.Z)({to:p},m,l?.target&&{target:l.target}),l&&a.createElement(u,{logo:l,alt:g,imageClassName:d}),null!=r&&a.createElement("b",{className:f},r))}},33647:(e,t,r)=>{"use strict";r.d(t,{Z:()=>i});var n=r(67294),a=r(31514);function i(e){let{locale:t,version:r,tag:i}=e;const o=t;return n.createElement(a.Z,null,t&&n.createElement("meta",{name:"docusaurus_locale",content:t}),r&&n.createElement("meta",{name:"docusaurus_version",content:r}),i&&n.createElement("meta",{name:"docusaurus_tag",content:i}),o&&n.createElement("meta",{name:"docsearch:language",content:o}),r&&n.createElement("meta",{name:"docsearch:version",content:r}),i&&n.createElement("meta",{name:"docsearch:docusaurus_tag",content:i}))}},7909:(e,t,r)=>{"use strict";r.d(t,{Z:()=>l});var n=r(87462),a=r(67294),i=r(86010),o=r(51048),s=r(9200);const c={themedImage:"themedImage_ToTc","themedImage--light":"themedImage--light_HNdA","themedImage--dark":"themedImage--dark_i4oU"};function l(e){const t=(0,o.Z)(),{colorMode:r}=(0,s.I)(),{sources:l,className:u,alt:d,...f}=e,m=t?"dark"===r?["dark"]:["light"]:["light","dark"];return a.createElement(a.Fragment,null,m.map((e=>a.createElement("img",(0,n.Z)({key:e,src:l[e],alt:d,className:(0,i.Z)(c.themedImage,c[`themedImage--${e}`],u)},f)))))}},54639:(e,t,r)=>{"use strict";r.d(t,{u:()=>c,z:()=>g});var n=r(87462),a=r(67294),i=r(36136),o=r(58986);const s="ease-in-out";function c(e){let{initialState:t}=e;const[r,n]=(0,a.useState)(t??!1),i=(0,a.useCallback)((()=>{n((e=>!e))}),[]);return{collapsed:r,setCollapsed:n,toggleCollapsed:i}}const l={display:"none",overflow:"hidden",height:"0px"},u={display:"block",overflow:"visible",height:"auto"};function d(e,t){const r=t?l:u;e.style.display=r.display,e.style.overflow=r.overflow,e.style.height=r.height}function f(e){let{collapsibleRef:t,collapsed:r,animation:n}=e;const i=(0,a.useRef)(!1);(0,a.useEffect)((()=>{const e=t.current;function a(){const t=e.scrollHeight,r=n?.duration??function(e){if((0,o.n)())return 1;const t=e/36;return Math.round(10*(4+15*t**.25+t/5))}(t);return{transition:`height ${r}ms ${n?.easing??s}`,height:`${t}px`}}function c(){const t=a();e.style.transition=t.transition,e.style.height=t.height}if(!i.current)return d(e,r),void(i.current=!0);return e.style.willChange="height",function(){const t=requestAnimationFrame((()=>{r?(c(),requestAnimationFrame((()=>{e.style.height=l.height,e.style.overflow=l.overflow}))):(e.style.display="block",requestAnimationFrame((()=>{c()})))}));return()=>cancelAnimationFrame(t)}()}),[t,r,n])}function m(e){if(!i.Z.canUseDOM)return e?l:u}function p(e){let{as:t="div",collapsed:r,children:n,animation:i,onCollapseTransitionEnd:o,className:s,disableSSRStyle:c}=e;const l=(0,a.useRef)(null);return f({collapsibleRef:l,collapsed:r,animation:i}),a.createElement(t,{ref:l,style:c?void 0:m(r),onTransitionEnd:e=>{"height"===e.propertyName&&(d(l.current,r),o?.(r))},className:s},n)}function b(e){let{collapsed:t,...r}=e;const[i,o]=(0,a.useState)(!t),[s,c]=(0,a.useState)(t);return(0,a.useLayoutEffect)((()=>{t||o(!0)}),[t]),(0,a.useLayoutEffect)((()=>{i&&c(t)}),[i,t]),i?a.createElement(p,(0,n.Z)({},r,{collapsed:s})):null}function g(e){let{lazy:t,...r}=e;const n=t?b:p;return a.createElement(n,r)}},65830:(e,t,r)=>{"use strict";r.d(t,{nT:()=>p,pl:()=>m});var n=r(67294),a=r(51048),i=r(92560),o=r(43768),s=r(20107);const c=(0,i.WA)("docusaurus.announcement.dismiss"),l=(0,i.WA)("docusaurus.announcement.id"),u=()=>"true"===c.get(),d=e=>c.set(String(e)),f=n.createContext(null);function m(e){let{children:t}=e;const r=function(){const{announcementBar:e}=(0,s.L)(),t=(0,a.Z)(),[r,i]=(0,n.useState)((()=>!!t&&u()));(0,n.useEffect)((()=>{i(u())}),[]);const o=(0,n.useCallback)((()=>{d(!0),i(!0)}),[]);return(0,n.useEffect)((()=>{if(!e)return;const{id:t}=e;let r=l.get();"annoucement-bar"===r&&(r="announcement-bar");const n=t!==r;l.set(t),n&&d(!1),!n&&u()||i(!1)}),[e]),(0,n.useMemo)((()=>({isActive:!!e&&!r,close:o})),[e,r,o])}();return n.createElement(f.Provider,{value:r},t)}function p(){const e=(0,n.useContext)(f);if(!e)throw new o.i6("AnnouncementBarProvider");return e}},9200:(e,t,r)=>{"use strict";r.d(t,{I:()=>g,S:()=>b});var n=r(67294),a=r(36136),i=r(43768),o=r(92560),s=r(20107);const c=n.createContext(void 0),l="theme",u=(0,o.WA)(l),d={light:"light",dark:"dark"},f=e=>e===d.dark?d.dark:d.light,m=e=>a.Z.canUseDOM?f(document.documentElement.getAttribute("data-theme")):f(e),p=e=>{u.set(f(e))};function b(e){let{children:t}=e;const r=function(){const{colorMode:{defaultMode:e,disableSwitch:t,respectPrefersColorScheme:r}}=(0,s.L)(),[a,i]=(0,n.useState)(m(e));(0,n.useEffect)((()=>{t&&u.del()}),[t]);const o=(0,n.useCallback)((function(t,n){void 0===n&&(n={});const{persist:a=!0}=n;t?(i(t),a&&p(t)):(i(r?window.matchMedia("(prefers-color-scheme: dark)").matches?d.dark:d.light:e),u.del())}),[r,e]);(0,n.useEffect)((()=>{document.documentElement.setAttribute("data-theme",f(a))}),[a]),(0,n.useEffect)((()=>{if(t)return;const e=e=>{if(e.key!==l)return;const t=u.get();null!==t&&o(f(t))};return window.addEventListener("storage",e),()=>window.removeEventListener("storage",e)}),[t,o]);const c=(0,n.useRef)(!1);return(0,n.useEffect)((()=>{if(t&&!r)return;const e=window.matchMedia("(prefers-color-scheme: dark)"),n=()=>{window.matchMedia("print").matches||c.current?c.current=window.matchMedia("print").matches:o(null)};return e.addListener(n),()=>e.removeListener(n)}),[o,t,r]),(0,n.useMemo)((()=>({colorMode:a,setColorMode:o,get isDarkTheme(){return a===d.dark},setLightTheme(){o(d.light)},setDarkTheme(){o(d.dark)}})),[a,o])}();return n.createElement(c.Provider,{value:r},t)}function g(){const e=(0,n.useContext)(c);if(null==e)throw new i.i6("ColorModeProvider","Please see https://docusaurus.io/docs/api/themes/configuration#use-color-mode.");return e}},86409:(e,t,r)=>{"use strict";r.d(t,{J:()=>w,L5:()=>g,Oh:()=>I});var n=r(67294),a=r(30868),i=r(6875),o=r(20107),s=r(78259),c=r(43768),l=r(92560);const u=e=>`docs-preferred-version-${e}`,d={save:(e,t,r)=>{(0,l.WA)(u(e),{persistence:t}).set(r)},read:(e,t)=>(0,l.WA)(u(e),{persistence:t}).get(),clear:(e,t)=>{(0,l.WA)(u(e),{persistence:t}).del()}},f=e=>Object.fromEntries(e.map((e=>[e,{preferredVersionName:null}])));const m=n.createContext(null);function p(){const e=(0,a._r)(),t=(0,o.L)().docs.versionPersistence,r=(0,n.useMemo)((()=>Object.keys(e)),[e]),[i,s]=(0,n.useState)((()=>f(r)));(0,n.useEffect)((()=>{s(function(e){let{pluginIds:t,versionPersistence:r,allDocsData:n}=e;function a(e){const t=d.read(e,r);return n[e].versions.some((e=>e.name===t))?{preferredVersionName:t}:(d.clear(e,r),{preferredVersionName:null})}return Object.fromEntries(t.map((e=>[e,a(e)])))}({allDocsData:e,versionPersistence:t,pluginIds:r}))}),[e,t,r]);return[i,(0,n.useMemo)((()=>({savePreferredVersion:function(e,r){d.save(e,t,r),s((t=>({...t,[e]:{preferredVersionName:r}})))}})),[t])]}function b(e){let{children:t}=e;const r=p();return n.createElement(m.Provider,{value:r},t)}function g(e){let{children:t}=e;return s.cE?n.createElement(b,null,t):n.createElement(n.Fragment,null,t)}function h(){const e=(0,n.useContext)(m);if(!e)throw new c.i6("DocsPreferredVersionContextProvider");return e}function w(e){void 0===e&&(e=i.m);const t=(0,a.zh)(e),[r,o]=h(),{preferredVersionName:s}=r[e];return{preferredVersion:t.versions.find((e=>e.name===s))??null,savePreferredVersionName:(0,n.useCallback)((t=>{o.savePreferredVersion(e,t)}),[o,e])}}function I(){const e=(0,a._r)(),[t]=h();function r(r){const n=e[r],{preferredVersionName:a}=t[r];return n.versions.find((e=>e.name===a))??null}const n=Object.keys(e);return Object.fromEntries(n.map((e=>[e,r(e)])))}},84432:(e,t,r)=>{"use strict";r.d(t,{V:()=>c,b:()=>s});var n=r(67294),a=r(43768);const i=Symbol("EmptyContext"),o=n.createContext(i);function s(e){let{children:t,name:r,items:a}=e;const i=(0,n.useMemo)((()=>r&&a?{name:r,items:a}:null),[r,a]);return n.createElement(o.Provider,{value:i},t)}function c(){const e=(0,n.useContext)(o);if(e===i)throw new a.i6("DocsSidebarProvider");return e}},60735:(e,t,r)=>{"use strict";r.d(t,{M:()=>d,e:()=>f});var n=r(67294),a=r(53086),i=r(13488),o=r(75238),s=r(20107),c=r(43768);const l=n.createContext(void 0);function u(){const e=function(){const e=(0,a.HY)(),{items:t}=(0,s.L)().navbar;return 0===t.length&&!e.component}(),t=(0,i.i)(),r=!e&&"mobile"===t,[c,l]=(0,n.useState)(!1);(0,o.Rb)((()=>{if(c)return l(!1),!1}));const u=(0,n.useCallback)((()=>{l((e=>!e))}),[]);return(0,n.useEffect)((()=>{"desktop"===t&&l(!1)}),[t]),(0,n.useMemo)((()=>({disabled:e,shouldRender:r,toggle:u,shown:c})),[e,r,u,c])}function d(e){let{children:t}=e;const r=u();return n.createElement(l.Provider,{value:r},t)}function f(){const e=n.useContext(l);if(void 0===e)throw new c.i6("NavbarMobileSidebarProvider");return e}},53086:(e,t,r)=>{"use strict";r.d(t,{HY:()=>s,Zo:()=>c,n2:()=>o});var n=r(67294),a=r(43768);const i=n.createContext(null);function o(e){let{children:t}=e;const r=(0,n.useState)({component:null,props:null});return n.createElement(i.Provider,{value:r},t)}function s(){const e=(0,n.useContext)(i);if(!e)throw new a.i6("NavbarSecondaryMenuContentProvider");return e[0]}function c(e){let{component:t,props:r}=e;const o=(0,n.useContext)(i);if(!o)throw new a.i6("NavbarSecondaryMenuContentProvider");const[,s]=o,c=(0,a.Ql)(r);return(0,n.useEffect)((()=>{s({component:t,props:c})}),[s,t,c]),(0,n.useEffect)((()=>()=>s({component:null,props:null})),[s]),null}},78181:(e,t,r)=>{"use strict";r.d(t,{h:()=>a,t:()=>i});var n=r(67294);const a="navigation-with-keyboard";function i(){(0,n.useEffect)((()=>{function e(e){"keydown"===e.type&&"Tab"===e.key&&document.body.classList.add(a),"mousedown"===e.type&&document.body.classList.remove(a)}return document.addEventListener("keydown",e),document.addEventListener("mousedown",e),()=>{document.body.classList.remove(a),document.removeEventListener("keydown",e),document.removeEventListener("mousedown",e)}}),[])}},13488:(e,t,r)=>{"use strict";r.d(t,{i:()=>l});var n=r(67294),a=r(36136);const i={desktop:"desktop",mobile:"mobile",ssr:"ssr"},o=996;function s(){return a.Z.canUseDOM?window.innerWidth>o?i.desktop:i.mobile:i.ssr}const c=!1;function l(){const[e,t]=(0,n.useState)((()=>c?"ssr":s()));return(0,n.useEffect)((()=>{function e(){t(s())}const r=c?window.setTimeout(e,1e3):void 0;return window.addEventListener("resize",e),()=>{window.removeEventListener("resize",e),clearTimeout(r)}}),[]),e}},23702:(e,t,r)=>{"use strict";r.d(t,{k:()=>n});const n={page:{blogListPage:"blog-list-page",blogPostPage:"blog-post-page",blogTagsListPage:"blog-tags-list-page",blogTagPostListPage:"blog-tags-post-list-page",docsDocPage:"docs-doc-page",docsTagsListPage:"docs-tags-list-page",docsTagDocListPage:"docs-tags-doc-list-page",mdxPage:"mdx-page"},wrapper:{main:"main-wrapper",blogPages:"blog-wrapper",docsPages:"docs-wrapper",mdxPages:"mdx-wrapper"},common:{editThisPage:"theme-edit-this-page",lastUpdated:"theme-last-updated",backToTopButton:"theme-back-to-top-button",codeBlock:"theme-code-block",admonition:"theme-admonition",admonitionType:e=>`theme-admonition-${e}`},layout:{},docs:{docVersionBanner:"theme-doc-version-banner",docVersionBadge:"theme-doc-version-badge",docBreadcrumbs:"theme-doc-breadcrumbs",docMarkdown:"theme-doc-markdown",docTocMobile:"theme-doc-toc-mobile",docTocDesktop:"theme-doc-toc-desktop",docFooter:"theme-doc-footer",docFooterTagsRow:"theme-doc-footer-tags-row",docFooterEditMetaRow:"theme-doc-footer-edit-meta-row",docSidebarContainer:"theme-doc-sidebar-container",docSidebarMenu:"theme-doc-sidebar-menu",docSidebarItemCategory:"theme-doc-sidebar-item-category",docSidebarItemLink:"theme-doc-sidebar-item-link",docSidebarItemCategoryLevel:e=>`theme-doc-sidebar-item-category-level-${e}`,docSidebarItemLinkLevel:e=>`theme-doc-sidebar-item-link-level-${e}`},blog:{}}},58986:(e,t,r)=>{"use strict";function n(){return window.matchMedia("(prefers-reduced-motion: reduce)").matches}r.d(t,{n:()=>n})},78259:(e,t,r)=>{"use strict";r.d(t,{Wl:()=>f,_F:()=>b,cE:()=>d,hI:()=>y,lO:()=>w,oz:()=>I,s1:()=>h,vY:()=>x});var n=r(67294),a=r(16550),i=r(18790),o=r(30868),s=r(86409),c=r(84432),l=r(33609),u=r(69003);const d=!!o._r;function f(e){if(e.href)return e.href;for(const t of e.items){if("link"===t.type)return t.href;if("category"===t.type){const e=f(t);if(e)return e}}}const m=(e,t)=>void 0!==e&&(0,u.Mg)(e,t),p=(e,t)=>e.some((e=>b(e,t)));function b(e,t){return"link"===e.type?m(e.href,t):"category"===e.type&&(m(e.href,t)||p(e.items,t))}function g(e){let{sidebarItems:t,pathname:r,onlyCategories:n=!1}=e;const a=[];return function e(t){for(const i of t)if("category"===i.type&&((0,u.Mg)(i.href,r)||e(i.items))||"link"===i.type&&(0,u.Mg)(i.href,r)){return n&&"category"!==i.type||a.unshift(i),!0}return!1}(t),a}function h(){const e=(0,c.V)(),{pathname:t}=(0,a.TH)(),r=(0,o.gA)()?.pluginData.breadcrumbs;return!1!==r&&e?g({sidebarItems:e.items,pathname:t}):null}function w(e){const{activeVersion:t}=(0,o.Iw)(e),{preferredVersion:r}=(0,s.J)(e),a=(0,o.yW)(e);return(0,n.useMemo)((()=>(0,l.j)([t,r,a].filter(Boolean))),[t,r,a])}function I(e,t){const r=w(t);return(0,n.useMemo)((()=>{const t=r.flatMap((e=>e.sidebars?Object.entries(e.sidebars):[])),n=t.find((t=>t[0]===e));if(!n)throw new Error(`Can't find any sidebar with id "${e}" in version${r.length>1?"s":""} ${r.map((e=>e.name)).join(", ")}".\nAvailable sidebar ids are:\n- ${t.map((e=>e[0])).join("\n- ")}`);return n[1]}),[e,r])}function x(e,t){const r=w(t);return(0,n.useMemo)((()=>{const t=r.flatMap((e=>e.docs)),n=t.find((t=>t.id===e));if(!n){if(r.flatMap((e=>e.draftIds)).includes(e))return null;throw new Error(`Couldn't find any doc with id "${e}" in version${r.length>1?"s":""} "${r.map((e=>e.name)).join(", ")}".\nAvailable doc ids are:\n- ${(0,l.j)(t.map((e=>e.id))).join("\n- ")}`)}return n}),[e,r])}function y(e){let{route:t,versionMetadata:r}=e;const n=(0,a.TH)(),o=t.routes,s=o.find((e=>(0,a.LX)(n.pathname,e)));if(!s)return null;const c=s.sidebar,l=c?r.docsSidebars[c]:void 0;return{docElement:(0,i.H)(o),sidebarName:c,sidebarItems:l}}},75238:(e,t,r)=>{"use strict";r.d(t,{Rb:()=>s,_X:()=>c});var n=r(67294),a=r(16550),i=r(61688),o=r(43768);function s(e){!function(e){const t=(0,a.k6)(),r=(0,o.zX)(e);(0,n.useEffect)((()=>t.block(((e,t)=>r(e,t)))),[t,r])}(((t,r)=>{if("POP"===r)return e(t,r)}))}function c(e){return function(e){const t=(0,a.k6)();return(0,i.useSyncExternalStore)(t.listen,(()=>e(t)),(()=>e(t)))}((t=>null===e?null:new URLSearchParams(t.location.search).get(e)))}},33609:(e,t,r)=>{"use strict";function n(e,t){return void 0===t&&(t=(e,t)=>e===t),e.filter(((r,n)=>e.findIndex((e=>t(e,r)))!==n))}function a(e){return Array.from(new Set(e))}r.d(t,{j:()=>a,l:()=>n})},35463:(e,t,r)=>{"use strict";r.d(t,{FG:()=>f,d:()=>u,VC:()=>m});var n=r(67294),a=r(86010),i=r(31514),o=r(69656);function s(){const e=n.useContext(o._);if(!e)throw new Error("Unexpected: no Docusaurus route context found");return e}var c=r(79524),l=r(39962);function u(e){let{title:t,description:r,keywords:a,image:o,children:s}=e;const u=function(e){const{siteConfig:t}=(0,l.Z)(),{title:r,titleDelimiter:n}=t;return e?.trim().length?`${e.trim()} ${n} ${r}`:r}(t),{withBaseUrl:d}=(0,c.C)(),f=o?d(o,{absolute:!0}):void 0;return n.createElement(i.Z,null,t&&n.createElement("title",null,u),t&&n.createElement("meta",{property:"og:title",content:u}),r&&n.createElement("meta",{name:"description",content:r}),r&&n.createElement("meta",{property:"og:description",content:r}),a&&n.createElement("meta",{name:"keywords",content:Array.isArray(a)?a.join(","):a}),f&&n.createElement("meta",{property:"og:image",content:f}),f&&n.createElement("meta",{name:"twitter:image",content:f}),s)}const d=n.createContext(void 0);function f(e){let{className:t,children:r}=e;const o=n.useContext(d),s=(0,a.Z)(o,t);return n.createElement(d.Provider,{value:s},n.createElement(i.Z,null,n.createElement("html",{className:s})),r)}function m(e){let{children:t}=e;const r=s(),i=`plugin-${r.plugin.name.replace(/docusaurus-(?:plugin|theme)-(?:content-)?/gi,"")}`;const o=`plugin-id-${r.plugin.id}`;return n.createElement(f,{className:(0,a.Z)(i,o)},t)}},43768:(e,t,r)=>{"use strict";r.d(t,{D9:()=>o,Qc:()=>l,Ql:()=>c,i6:()=>s,zX:()=>i});var n=r(67294);const a=r(36136).Z.canUseDOM?n.useLayoutEffect:n.useEffect;function i(e){const t=(0,n.useRef)(e);return a((()=>{t.current=e}),[e]),(0,n.useCallback)((function(){return t.current(...arguments)}),[])}function o(e){const t=(0,n.useRef)();return a((()=>{t.current=e})),t.current}class s extends Error{constructor(e,t){super(),this.name="ReactContextError",this.message=`Hook ${this.stack?.split("\n")[1]?.match(/at (?:\w+\.)?(?\w+)/)?.groups.name??""} is called outside the <${e}>. ${t??""}`}}function c(e){const t=Object.entries(e);return t.sort(((e,t)=>e[0].localeCompare(t[0]))),(0,n.useMemo)((()=>e),t.flat())}function l(e){return t=>{let{children:r}=t;return n.createElement(n.Fragment,null,e.reduceRight(((e,t)=>n.createElement(t,null,e)),r))}}},69003:(e,t,r)=>{"use strict";r.d(t,{Mg:()=>o,Ns:()=>s});var n=r(67294),a=r(50997),i=r(39962);function o(e,t){const r=e=>(!e||e.endsWith("/")?e:`${e}/`)?.toLowerCase();return r(e)===r(t)}function s(){const{baseUrl:e}=(0,i.Z)().siteConfig;return(0,n.useMemo)((()=>function(e){let{baseUrl:t,routes:r}=e;function n(e){return e.path===t&&!0===e.exact}function a(e){return e.path===t&&!e.exact}return function e(t){if(0===t.length)return;return t.find(n)||e(t.filter(a).flatMap((e=>e.routes??[])))}(r)}({routes:a.Z,baseUrl:e})),[e])}},72957:(e,t,r)=>{"use strict";r.d(t,{Ct:()=>m,OC:()=>c,RF:()=>d,o5:()=>f});var n=r(67294),a=r(36136),i=r(51048),o=r(43768);const s=n.createContext(void 0);function c(e){let{children:t}=e;const r=function(){const e=(0,n.useRef)(!0);return(0,n.useMemo)((()=>({scrollEventsEnabledRef:e,enableScrollEvents:()=>{e.current=!0},disableScrollEvents:()=>{e.current=!1}})),[])}();return n.createElement(s.Provider,{value:r},t)}function l(){const e=(0,n.useContext)(s);if(null==e)throw new o.i6("ScrollControllerProvider");return e}const u=()=>a.Z.canUseDOM?{scrollX:window.pageXOffset,scrollY:window.pageYOffset}:null;function d(e,t){void 0===t&&(t=[]);const{scrollEventsEnabledRef:r}=l(),a=(0,n.useRef)(u()),i=(0,o.zX)(e);(0,n.useEffect)((()=>{const e=()=>{if(!r.current)return;const e=u();i(e,a.current),a.current=e},t={passive:!0};return e(),window.addEventListener("scroll",e,t),()=>window.removeEventListener("scroll",e,t)}),[i,r,...t])}function f(){const e=l(),t=function(){const e=(0,n.useRef)({elem:null,top:0}),t=(0,n.useCallback)((t=>{e.current={elem:t,top:t.getBoundingClientRect().top}}),[]),r=(0,n.useCallback)((()=>{const{current:{elem:t,top:r}}=e;if(!t)return{restored:!1};const n=t.getBoundingClientRect().top-r;return n&&window.scrollBy({left:0,top:n}),e.current={elem:null,top:0},{restored:0!==n}}),[]);return(0,n.useMemo)((()=>({save:t,restore:r})),[r,t])}(),r=(0,n.useRef)(void 0),a=(0,n.useCallback)((n=>{t.save(n),e.disableScrollEvents(),r.current=()=>{const{restored:n}=t.restore();if(r.current=void 0,n){const t=()=>{e.enableScrollEvents(),window.removeEventListener("scroll",t)};window.addEventListener("scroll",t)}else e.enableScrollEvents()}}),[e,t]);return(0,n.useLayoutEffect)((()=>{queueMicrotask((()=>r.current?.()))})),{blockElementScrollPositionUntilNextRender:a}}function m(){const e=(0,n.useRef)(null),t=(0,i.Z)()&&"smooth"===getComputedStyle(document.documentElement).scrollBehavior;return{startScroll:r=>{e.current=t?function(e){return window.scrollTo({top:e,behavior:"smooth"}),()=>{}}(r):function(e){let t=null;const r=document.documentElement.scrollTop>e;return function n(){const a=document.documentElement.scrollTop;(r&&a>e||!r&&at&&cancelAnimationFrame(t)}(r)},cancelScroll:()=>e.current?.()}}},60246:(e,t,r)=>{"use strict";r.d(t,{HX:()=>o,_q:()=>c,os:()=>s});var n=r(30868),a=r(39962),i=r(86409);const o="default";function s(e,t){return`docs-${e}-${t}`}function c(){const{i18n:e}=(0,a.Z)(),t=(0,n._r)(),r=(0,n.WS)(),c=(0,i.Oh)();const l=[o,...Object.keys(t).map((function(e){const n=r?.activePlugin.pluginId===e?r.activeVersion:void 0,a=c[e],i=t[e].versions.find((e=>e.isLast));return s(e,(n??a??i).name)}))];return{locale:e.currentLocale,tags:l}}},92560:(e,t,r)=>{"use strict";r.d(t,{Nk:()=>d,WA:()=>u});var n=r(67294),a=r(61688);const i="localStorage";function o(e){let{key:t,oldValue:r,newValue:n,storage:a}=e;if(r===n)return;const i=document.createEvent("StorageEvent");i.initStorageEvent("storage",!1,!1,t,r,n,window.location.href,a),window.dispatchEvent(i)}function s(e){if(void 0===e&&(e=i),"undefined"==typeof window)throw new Error("Browser storage is not available on Node.js/Docusaurus SSR process.");if("none"===e)return null;try{return window[e]}catch(r){return t=r,c||(console.warn("Docusaurus browser storage is not available.\nPossible reasons: running Docusaurus in an iframe, in an incognito browser session, or using too strict browser privacy settings.",t),c=!0),null}var t}let c=!1;const l={get:()=>null,set:()=>{},del:()=>{},listen:()=>()=>{}};function u(e,t){if("undefined"==typeof window)return function(e){function t(){throw new Error(`Illegal storage API usage for storage key "${e}".\nDocusaurus storage APIs are not supposed to be called on the server-rendering process.\nPlease only call storage APIs in effects and event handlers.`)}return{get:t,set:t,del:t,listen:t}}(e);const r=s(t?.persistence);return null===r?l:{get:()=>{try{return r.getItem(e)}catch(t){return console.error(`Docusaurus storage error, can't get key=${e}`,t),null}},set:t=>{try{const n=r.getItem(e);r.setItem(e,t),o({key:e,oldValue:n,newValue:t,storage:r})}catch(n){console.error(`Docusaurus storage error, can't set ${e}=${t}`,n)}},del:()=>{try{const t=r.getItem(e);r.removeItem(e),o({key:e,oldValue:t,newValue:null,storage:r})}catch(t){console.error(`Docusaurus storage error, can't delete key=${e}`,t)}},listen:t=>{try{const n=n=>{n.storageArea===r&&n.key===e&&t(n)};return window.addEventListener("storage",n),()=>window.removeEventListener("storage",n)}catch(n){return console.error(`Docusaurus storage error, can't listen for changes of key=${e}`,n),()=>{}}}}}function d(e,t){const r=(0,n.useRef)((()=>null===e?l:u(e,t))).current(),i=(0,n.useCallback)((e=>"undefined"==typeof window?()=>{}:r.listen(e)),[r]);return[(0,a.useSyncExternalStore)(i,(()=>"undefined"==typeof window?null:r.get()),(()=>null)),r]}},40626:(e,t,r)=>{"use strict";r.d(t,{l:()=>o});var n=r(39962),a=r(16550),i=r(63905);function o(){const{siteConfig:{baseUrl:e,url:t,trailingSlash:r},i18n:{defaultLocale:o,currentLocale:s}}=(0,n.Z)(),{pathname:c}=(0,a.TH)(),l=(0,i.applyTrailingSlash)(c,{trailingSlash:r,baseUrl:e}),u=s===o?e:e.replace(`/${s}/`,"/"),d=l.replace(e,"");return{createUrl:function(e){let{locale:r,fullyQualified:n}=e;return`${n?t:""}${function(e){return e===o?`${u}`:`${u}${e}/`}(r)}${d}`}}}},43266:(e,t,r)=>{"use strict";r.d(t,{S:()=>o});var n=r(67294),a=r(16550),i=r(43768);function o(e){const t=(0,a.TH)(),r=(0,i.D9)(t),o=(0,i.zX)(e);(0,n.useEffect)((()=>{r&&t!==r&&o({location:t,previousLocation:r})}),[o,t,r])}},20107:(e,t,r)=>{"use strict";r.d(t,{L:()=>a});var n=r(39962);function a(){return(0,n.Z)().siteConfig.themeConfig}},84136:(e,t)=>{"use strict";Object.defineProperty(t,"__esModule",{value:!0}),t.default=function(e,t){const{trailingSlash:r,baseUrl:n}=t;if(e.startsWith("#"))return e;if(void 0===r)return e;const[a]=e.split(/[#?]/),i="/"===a||a===n?a:(o=a,r?function(e){return e.endsWith("/")?e:`${e}/`}(o):function(e){return e.endsWith("/")?e.slice(0,-1):e}(o));var o;return e.replace(a,i)}},15806:(e,t)=>{"use strict";Object.defineProperty(t,"__esModule",{value:!0}),t.getErrorCausalChain=void 0,t.getErrorCausalChain=function e(t){return t.cause?[t,...e(t.cause)]:[t]}},63905:function(e,t,r){"use strict";var n=this&&this.__importDefault||function(e){return e&&e.__esModule?e:{default:e}};Object.defineProperty(t,"__esModule",{value:!0}),t.getErrorCausalChain=t.applyTrailingSlash=t.blogPostContainerID=void 0,t.blogPostContainerID="__blog-post-container";var a=r(84136);Object.defineProperty(t,"applyTrailingSlash",{enumerable:!0,get:function(){return n(a).default}});var i=r(15806);Object.defineProperty(t,"getErrorCausalChain",{enumerable:!0,get:function(){return i.getErrorCausalChain}})},86010:(e,t,r)=>{"use strict";function n(e){var t,r,a="";if("string"==typeof e||"number"==typeof e)a+=e;else if("object"==typeof e)if(Array.isArray(e))for(t=0;ta});const a=function(){for(var e,t,r=0,a="";r{"use strict";r.d(t,{lX:()=>x,q_:()=>S,ob:()=>m,PP:()=>U,Ep:()=>f});var n=r(87462);function a(e){return"/"===e.charAt(0)}function i(e,t){for(var r=t,n=r+1,a=e.length;n=0;f--){var m=o[f];"."===m?i(o,f):".."===m?(i(o,f),d++):d&&(i(o,f),d--)}if(!l)for(;d--;d)o.unshift("..");!l||""===o[0]||o[0]&&a(o[0])||o.unshift("");var p=o.join("/");return r&&"/"!==p.substr(-1)&&(p+="/"),p};var s=r(38776);function c(e){return"/"===e.charAt(0)?e:"/"+e}function l(e){return"/"===e.charAt(0)?e.substr(1):e}function u(e,t){return function(e,t){return 0===e.toLowerCase().indexOf(t.toLowerCase())&&-1!=="/?#".indexOf(e.charAt(t.length))}(e,t)?e.substr(t.length):e}function d(e){return"/"===e.charAt(e.length-1)?e.slice(0,-1):e}function f(e){var t=e.pathname,r=e.search,n=e.hash,a=t||"/";return r&&"?"!==r&&(a+="?"===r.charAt(0)?r:"?"+r),n&&"#"!==n&&(a+="#"===n.charAt(0)?n:"#"+n),a}function m(e,t,r,a){var i;"string"==typeof e?(i=function(e){var t=e||"/",r="",n="",a=t.indexOf("#");-1!==a&&(n=t.substr(a),t=t.substr(0,a));var i=t.indexOf("?");return-1!==i&&(r=t.substr(i),t=t.substr(0,i)),{pathname:t,search:"?"===r?"":r,hash:"#"===n?"":n}}(e),i.state=t):(void 0===(i=(0,n.Z)({},e)).pathname&&(i.pathname=""),i.search?"?"!==i.search.charAt(0)&&(i.search="?"+i.search):i.search="",i.hash?"#"!==i.hash.charAt(0)&&(i.hash="#"+i.hash):i.hash="",void 0!==t&&void 0===i.state&&(i.state=t));try{i.pathname=decodeURI(i.pathname)}catch(s){throw s instanceof URIError?new URIError('Pathname "'+i.pathname+'" could not be decoded. This is likely caused by an invalid percent-encoding.'):s}return r&&(i.key=r),a?i.pathname?"/"!==i.pathname.charAt(0)&&(i.pathname=o(i.pathname,a.pathname)):i.pathname=a.pathname:i.pathname||(i.pathname="/"),i}function p(){var e=null;var t=[];return{setPrompt:function(t){return e=t,function(){e===t&&(e=null)}},confirmTransitionTo:function(t,r,n,a){if(null!=e){var i="function"==typeof e?e(t,r):e;"string"==typeof i?"function"==typeof n?n(i,a):a(!0):a(!1!==i)}else a(!0)},appendListener:function(e){var r=!0;function n(){r&&e.apply(void 0,arguments)}return t.push(n),function(){r=!1,t=t.filter((function(e){return e!==n}))}},notifyListeners:function(){for(var e=arguments.length,r=new Array(e),n=0;nt?r.splice(t,r.length-t,a):r.push(a),d({action:n,location:a,index:t,entries:r})}}))},replace:function(e,t){var n="REPLACE",a=m(e,t,b(),x.location);u.confirmTransitionTo(a,n,r,(function(e){e&&(x.entries[x.index]=a,d({action:n,location:a}))}))},go:I,goBack:function(){I(-1)},goForward:function(){I(1)},canGo:function(e){var t=x.index+e;return t>=0&&t{"use strict";var n=r(59864),a={childContextTypes:!0,contextType:!0,contextTypes:!0,defaultProps:!0,displayName:!0,getDefaultProps:!0,getDerivedStateFromError:!0,getDerivedStateFromProps:!0,mixins:!0,propTypes:!0,type:!0},i={name:!0,length:!0,prototype:!0,caller:!0,callee:!0,arguments:!0,arity:!0},o={$$typeof:!0,compare:!0,defaultProps:!0,displayName:!0,propTypes:!0,type:!0},s={};function c(e){return n.isMemo(e)?o:s[e.$$typeof]||a}s[n.ForwardRef]={$$typeof:!0,render:!0,defaultProps:!0,displayName:!0,propTypes:!0},s[n.Memo]=o;var l=Object.defineProperty,u=Object.getOwnPropertyNames,d=Object.getOwnPropertySymbols,f=Object.getOwnPropertyDescriptor,m=Object.getPrototypeOf,p=Object.prototype;e.exports=function e(t,r,n){if("string"!=typeof r){if(p){var a=m(r);a&&a!==p&&e(t,a,n)}var o=u(r);d&&(o=o.concat(d(r)));for(var s=c(t),b=c(r),g=0;g{"use strict";e.exports=function(e,t,r,n,a,i,o,s){if(!e){var c;if(void 0===t)c=new Error("Minified exception occurred; use the non-minified dev environment for the full error message and additional helpful warnings.");else{var l=[r,n,a,i,o,s],u=0;(c=new Error(t.replace(/%s/g,(function(){return l[u++]})))).name="Invariant Violation"}throw c.framesToPop=1,c}}},5826:e=>{e.exports=Array.isArray||function(e){return"[object Array]"==Object.prototype.toString.call(e)}},813:function(e){e.exports=function(){"use strict";var e="function"==typeof Symbol&&"symbol"==typeof Symbol.iterator?function(e){return typeof e}:function(e){return e&&"function"==typeof Symbol&&e.constructor===Symbol&&e!==Symbol.prototype?"symbol":typeof e},t=function(e,t){if(!(e instanceof t))throw new TypeError("Cannot call a class as a function")},r=function(){function e(e,t){for(var r=0;r1&&void 0!==arguments[1])||arguments[1],a=arguments.length>2&&void 0!==arguments[2]?arguments[2]:[],i=arguments.length>3&&void 0!==arguments[3]?arguments[3]:5e3;t(this,e),this.ctx=r,this.iframes=n,this.exclude=a,this.iframesTimeout=i}return r(e,[{key:"getContexts",value:function(){var e=[];return(void 0!==this.ctx&&this.ctx?NodeList.prototype.isPrototypeOf(this.ctx)?Array.prototype.slice.call(this.ctx):Array.isArray(this.ctx)?this.ctx:"string"==typeof this.ctx?Array.prototype.slice.call(document.querySelectorAll(this.ctx)):[this.ctx]:[]).forEach((function(t){var r=e.filter((function(e){return e.contains(t)})).length>0;-1!==e.indexOf(t)||r||e.push(t)})),e}},{key:"getIframeContents",value:function(e,t){var r=arguments.length>2&&void 0!==arguments[2]?arguments[2]:function(){},n=void 0;try{var a=e.contentWindow;if(n=a.document,!a||!n)throw new Error("iframe inaccessible")}catch(i){r()}n&&t(n)}},{key:"isIframeBlank",value:function(e){var t="about:blank",r=e.getAttribute("src").trim();return e.contentWindow.location.href===t&&r!==t&&r}},{key:"observeIframeLoad",value:function(e,t,r){var n=this,a=!1,i=null,o=function o(){if(!a){a=!0,clearTimeout(i);try{n.isIframeBlank(e)||(e.removeEventListener("load",o),n.getIframeContents(e,t,r))}catch(s){r()}}};e.addEventListener("load",o),i=setTimeout(o,this.iframesTimeout)}},{key:"onIframeReady",value:function(e,t,r){try{"complete"===e.contentWindow.document.readyState?this.isIframeBlank(e)?this.observeIframeLoad(e,t,r):this.getIframeContents(e,t,r):this.observeIframeLoad(e,t,r)}catch(n){r()}}},{key:"waitForIframes",value:function(e,t){var r=this,n=0;this.forEachIframe(e,(function(){return!0}),(function(e){n++,r.waitForIframes(e.querySelector("html"),(function(){--n||t()}))}),(function(e){e||t()}))}},{key:"forEachIframe",value:function(t,r,n){var a=this,i=arguments.length>3&&void 0!==arguments[3]?arguments[3]:function(){},o=t.querySelectorAll("iframe"),s=o.length,c=0;o=Array.prototype.slice.call(o);var l=function(){--s<=0&&i(c)};s||l(),o.forEach((function(t){e.matches(t,a.exclude)?l():a.onIframeReady(t,(function(e){r(t)&&(c++,n(e)),l()}),l)}))}},{key:"createIterator",value:function(e,t,r){return document.createNodeIterator(e,t,r,!1)}},{key:"createInstanceOnIframe",value:function(t){return new e(t.querySelector("html"),this.iframes)}},{key:"compareNodeIframe",value:function(e,t,r){if(e.compareDocumentPosition(r)&Node.DOCUMENT_POSITION_PRECEDING){if(null===t)return!0;if(t.compareDocumentPosition(r)&Node.DOCUMENT_POSITION_FOLLOWING)return!0}return!1}},{key:"getIteratorNode",value:function(e){var t=e.previousNode();return{prevNode:t,node:(null===t||e.nextNode())&&e.nextNode()}}},{key:"checkIframeFilter",value:function(e,t,r,n){var a=!1,i=!1;return n.forEach((function(e,t){e.val===r&&(a=t,i=e.handled)})),this.compareNodeIframe(e,t,r)?(!1!==a||i?!1===a||i||(n[a].handled=!0):n.push({val:r,handled:!0}),!0):(!1===a&&n.push({val:r,handled:!1}),!1)}},{key:"handleOpenIframes",value:function(e,t,r,n){var a=this;e.forEach((function(e){e.handled||a.getIframeContents(e.val,(function(e){a.createInstanceOnIframe(e).forEachNode(t,r,n)}))}))}},{key:"iterateThroughNodes",value:function(e,t,r,n,a){for(var i=this,o=this.createIterator(t,e,n),s=[],c=[],l=void 0,u=void 0,d=function(){var e=i.getIteratorNode(o);return u=e.prevNode,l=e.node};d();)this.iframes&&this.forEachIframe(t,(function(e){return i.checkIframeFilter(l,u,e,s)}),(function(t){i.createInstanceOnIframe(t).forEachNode(e,(function(e){return c.push(e)}),n)})),c.push(l);c.forEach((function(e){r(e)})),this.iframes&&this.handleOpenIframes(s,e,r,n),a()}},{key:"forEachNode",value:function(e,t,r){var n=this,a=arguments.length>3&&void 0!==arguments[3]?arguments[3]:function(){},i=this.getContexts(),o=i.length;o||a(),i.forEach((function(i){var s=function(){n.iterateThroughNodes(e,i,t,r,(function(){--o<=0&&a()}))};n.iframes?n.waitForIframes(i,s):s()}))}}],[{key:"matches",value:function(e,t){var r="string"==typeof t?[t]:t,n=e.matches||e.matchesSelector||e.msMatchesSelector||e.mozMatchesSelector||e.oMatchesSelector||e.webkitMatchesSelector;if(n){var a=!1;return r.every((function(t){return!n.call(e,t)||(a=!0,!1)})),a}return!1}}]),e}(),i=function(){function i(e){t(this,i),this.ctx=e,this.ie=!1;var r=window.navigator.userAgent;(r.indexOf("MSIE")>-1||r.indexOf("Trident")>-1)&&(this.ie=!0)}return r(i,[{key:"log",value:function(t){var r=arguments.length>1&&void 0!==arguments[1]?arguments[1]:"debug",n=this.opt.log;this.opt.debug&&"object"===(void 0===n?"undefined":e(n))&&"function"==typeof n[r]&&n[r]("mark.js: "+t)}},{key:"escapeStr",value:function(e){return e.replace(/[\-\[\]\/\{\}\(\)\*\+\?\.\\\^\$\|]/g,"\\$&")}},{key:"createRegExp",value:function(e){return"disabled"!==this.opt.wildcards&&(e=this.setupWildcardsRegExp(e)),e=this.escapeStr(e),Object.keys(this.opt.synonyms).length&&(e=this.createSynonymsRegExp(e)),(this.opt.ignoreJoiners||this.opt.ignorePunctuation.length)&&(e=this.setupIgnoreJoinersRegExp(e)),this.opt.diacritics&&(e=this.createDiacriticsRegExp(e)),e=this.createMergedBlanksRegExp(e),(this.opt.ignoreJoiners||this.opt.ignorePunctuation.length)&&(e=this.createJoinersRegExp(e)),"disabled"!==this.opt.wildcards&&(e=this.createWildcardsRegExp(e)),e=this.createAccuracyRegExp(e)}},{key:"createSynonymsRegExp",value:function(e){var t=this.opt.synonyms,r=this.opt.caseSensitive?"":"i",n=this.opt.ignoreJoiners||this.opt.ignorePunctuation.length?"\0":"";for(var a in t)if(t.hasOwnProperty(a)){var i=t[a],o="disabled"!==this.opt.wildcards?this.setupWildcardsRegExp(a):this.escapeStr(a),s="disabled"!==this.opt.wildcards?this.setupWildcardsRegExp(i):this.escapeStr(i);""!==o&&""!==s&&(e=e.replace(new RegExp("("+this.escapeStr(o)+"|"+this.escapeStr(s)+")","gm"+r),n+"("+this.processSynomyms(o)+"|"+this.processSynomyms(s)+")"+n))}return e}},{key:"processSynomyms",value:function(e){return(this.opt.ignoreJoiners||this.opt.ignorePunctuation.length)&&(e=this.setupIgnoreJoinersRegExp(e)),e}},{key:"setupWildcardsRegExp",value:function(e){return(e=e.replace(/(?:\\)*\?/g,(function(e){return"\\"===e.charAt(0)?"?":"\x01"}))).replace(/(?:\\)*\*/g,(function(e){return"\\"===e.charAt(0)?"*":"\x02"}))}},{key:"createWildcardsRegExp",value:function(e){var t="withSpaces"===this.opt.wildcards;return e.replace(/\u0001/g,t?"[\\S\\s]?":"\\S?").replace(/\u0002/g,t?"[\\S\\s]*?":"\\S*")}},{key:"setupIgnoreJoinersRegExp",value:function(e){return e.replace(/[^(|)\\]/g,(function(e,t,r){var n=r.charAt(t+1);return/[(|)\\]/.test(n)||""===n?e:e+"\0"}))}},{key:"createJoinersRegExp",value:function(e){var t=[],r=this.opt.ignorePunctuation;return Array.isArray(r)&&r.length&&t.push(this.escapeStr(r.join(""))),this.opt.ignoreJoiners&&t.push("\\u00ad\\u200b\\u200c\\u200d"),t.length?e.split(/\u0000+/).join("["+t.join("")+"]*"):e}},{key:"createDiacriticsRegExp",value:function(e){var t=this.opt.caseSensitive?"":"i",r=this.opt.caseSensitive?["a\xe0\xe1\u1ea3\xe3\u1ea1\u0103\u1eb1\u1eaf\u1eb3\u1eb5\u1eb7\xe2\u1ea7\u1ea5\u1ea9\u1eab\u1ead\xe4\xe5\u0101\u0105","A\xc0\xc1\u1ea2\xc3\u1ea0\u0102\u1eb0\u1eae\u1eb2\u1eb4\u1eb6\xc2\u1ea6\u1ea4\u1ea8\u1eaa\u1eac\xc4\xc5\u0100\u0104","c\xe7\u0107\u010d","C\xc7\u0106\u010c","d\u0111\u010f","D\u0110\u010e","e\xe8\xe9\u1ebb\u1ebd\u1eb9\xea\u1ec1\u1ebf\u1ec3\u1ec5\u1ec7\xeb\u011b\u0113\u0119","E\xc8\xc9\u1eba\u1ebc\u1eb8\xca\u1ec0\u1ebe\u1ec2\u1ec4\u1ec6\xcb\u011a\u0112\u0118","i\xec\xed\u1ec9\u0129\u1ecb\xee\xef\u012b","I\xcc\xcd\u1ec8\u0128\u1eca\xce\xcf\u012a","l\u0142","L\u0141","n\xf1\u0148\u0144","N\xd1\u0147\u0143","o\xf2\xf3\u1ecf\xf5\u1ecd\xf4\u1ed3\u1ed1\u1ed5\u1ed7\u1ed9\u01a1\u1edf\u1ee1\u1edb\u1edd\u1ee3\xf6\xf8\u014d","O\xd2\xd3\u1ece\xd5\u1ecc\xd4\u1ed2\u1ed0\u1ed4\u1ed6\u1ed8\u01a0\u1ede\u1ee0\u1eda\u1edc\u1ee2\xd6\xd8\u014c","r\u0159","R\u0158","s\u0161\u015b\u0219\u015f","S\u0160\u015a\u0218\u015e","t\u0165\u021b\u0163","T\u0164\u021a\u0162","u\xf9\xfa\u1ee7\u0169\u1ee5\u01b0\u1eeb\u1ee9\u1eed\u1eef\u1ef1\xfb\xfc\u016f\u016b","U\xd9\xda\u1ee6\u0168\u1ee4\u01af\u1eea\u1ee8\u1eec\u1eee\u1ef0\xdb\xdc\u016e\u016a","y\xfd\u1ef3\u1ef7\u1ef9\u1ef5\xff","Y\xdd\u1ef2\u1ef6\u1ef8\u1ef4\u0178","z\u017e\u017c\u017a","Z\u017d\u017b\u0179"]:["a\xe0\xe1\u1ea3\xe3\u1ea1\u0103\u1eb1\u1eaf\u1eb3\u1eb5\u1eb7\xe2\u1ea7\u1ea5\u1ea9\u1eab\u1ead\xe4\xe5\u0101\u0105A\xc0\xc1\u1ea2\xc3\u1ea0\u0102\u1eb0\u1eae\u1eb2\u1eb4\u1eb6\xc2\u1ea6\u1ea4\u1ea8\u1eaa\u1eac\xc4\xc5\u0100\u0104","c\xe7\u0107\u010dC\xc7\u0106\u010c","d\u0111\u010fD\u0110\u010e","e\xe8\xe9\u1ebb\u1ebd\u1eb9\xea\u1ec1\u1ebf\u1ec3\u1ec5\u1ec7\xeb\u011b\u0113\u0119E\xc8\xc9\u1eba\u1ebc\u1eb8\xca\u1ec0\u1ebe\u1ec2\u1ec4\u1ec6\xcb\u011a\u0112\u0118","i\xec\xed\u1ec9\u0129\u1ecb\xee\xef\u012bI\xcc\xcd\u1ec8\u0128\u1eca\xce\xcf\u012a","l\u0142L\u0141","n\xf1\u0148\u0144N\xd1\u0147\u0143","o\xf2\xf3\u1ecf\xf5\u1ecd\xf4\u1ed3\u1ed1\u1ed5\u1ed7\u1ed9\u01a1\u1edf\u1ee1\u1edb\u1edd\u1ee3\xf6\xf8\u014dO\xd2\xd3\u1ece\xd5\u1ecc\xd4\u1ed2\u1ed0\u1ed4\u1ed6\u1ed8\u01a0\u1ede\u1ee0\u1eda\u1edc\u1ee2\xd6\xd8\u014c","r\u0159R\u0158","s\u0161\u015b\u0219\u015fS\u0160\u015a\u0218\u015e","t\u0165\u021b\u0163T\u0164\u021a\u0162","u\xf9\xfa\u1ee7\u0169\u1ee5\u01b0\u1eeb\u1ee9\u1eed\u1eef\u1ef1\xfb\xfc\u016f\u016bU\xd9\xda\u1ee6\u0168\u1ee4\u01af\u1eea\u1ee8\u1eec\u1eee\u1ef0\xdb\xdc\u016e\u016a","y\xfd\u1ef3\u1ef7\u1ef9\u1ef5\xffY\xdd\u1ef2\u1ef6\u1ef8\u1ef4\u0178","z\u017e\u017c\u017aZ\u017d\u017b\u0179"],n=[];return e.split("").forEach((function(a){r.every((function(r){if(-1!==r.indexOf(a)){if(n.indexOf(r)>-1)return!1;e=e.replace(new RegExp("["+r+"]","gm"+t),"["+r+"]"),n.push(r)}return!0}))})),e}},{key:"createMergedBlanksRegExp",value:function(e){return e.replace(/[\s]+/gim,"[\\s]+")}},{key:"createAccuracyRegExp",value:function(e){var t=this,r="!\"#$%&'()*+,-./:;<=>?@[\\]^_`{|}~\xa1\xbf",n=this.opt.accuracy,a="string"==typeof n?n:n.value,i="string"==typeof n?[]:n.limiters,o="";switch(i.forEach((function(e){o+="|"+t.escapeStr(e)})),a){case"partially":default:return"()("+e+")";case"complementary":return"()([^"+(o="\\s"+(o||this.escapeStr(r)))+"]*"+e+"[^"+o+"]*)";case"exactly":return"(^|\\s"+o+")("+e+")(?=$|\\s"+o+")"}}},{key:"getSeparatedKeywords",value:function(e){var t=this,r=[];return e.forEach((function(e){t.opt.separateWordSearch?e.split(" ").forEach((function(e){e.trim()&&-1===r.indexOf(e)&&r.push(e)})):e.trim()&&-1===r.indexOf(e)&&r.push(e)})),{keywords:r.sort((function(e,t){return t.length-e.length})),length:r.length}}},{key:"isNumeric",value:function(e){return Number(parseFloat(e))==e}},{key:"checkRanges",value:function(e){var t=this;if(!Array.isArray(e)||"[object Object]"!==Object.prototype.toString.call(e[0]))return this.log("markRanges() will only accept an array of objects"),this.opt.noMatch(e),[];var r=[],n=0;return e.sort((function(e,t){return e.start-t.start})).forEach((function(e){var a=t.callNoMatchOnInvalidRanges(e,n),i=a.start,o=a.end;a.valid&&(e.start=i,e.length=o-i,r.push(e),n=o)})),r}},{key:"callNoMatchOnInvalidRanges",value:function(e,t){var r=void 0,n=void 0,a=!1;return e&&void 0!==e.start?(n=(r=parseInt(e.start,10))+parseInt(e.length,10),this.isNumeric(e.start)&&this.isNumeric(e.length)&&n-t>0&&n-r>0?a=!0:(this.log("Ignoring invalid or overlapping range: "+JSON.stringify(e)),this.opt.noMatch(e))):(this.log("Ignoring invalid range: "+JSON.stringify(e)),this.opt.noMatch(e)),{start:r,end:n,valid:a}}},{key:"checkWhitespaceRanges",value:function(e,t,r){var n=void 0,a=!0,i=r.length,o=t-i,s=parseInt(e.start,10)-o;return(n=(s=s>i?i:s)+parseInt(e.length,10))>i&&(n=i,this.log("End range automatically set to the max value of "+i)),s<0||n-s<0||s>i||n>i?(a=!1,this.log("Invalid range: "+JSON.stringify(e)),this.opt.noMatch(e)):""===r.substring(s,n).replace(/\s+/g,"")&&(a=!1,this.log("Skipping whitespace only range: "+JSON.stringify(e)),this.opt.noMatch(e)),{start:s,end:n,valid:a}}},{key:"getTextNodes",value:function(e){var t=this,r="",n=[];this.iterator.forEachNode(NodeFilter.SHOW_TEXT,(function(e){n.push({start:r.length,end:(r+=e.textContent).length,node:e})}),(function(e){return t.matchesExclude(e.parentNode)?NodeFilter.FILTER_REJECT:NodeFilter.FILTER_ACCEPT}),(function(){e({value:r,nodes:n})}))}},{key:"matchesExclude",value:function(e){return a.matches(e,this.opt.exclude.concat(["script","style","title","head","html"]))}},{key:"wrapRangeInTextNode",value:function(e,t,r){var n=this.opt.element?this.opt.element:"mark",a=e.splitText(t),i=a.splitText(r-t),o=document.createElement(n);return o.setAttribute("data-markjs","true"),this.opt.className&&o.setAttribute("class",this.opt.className),o.textContent=a.textContent,a.parentNode.replaceChild(o,a),i}},{key:"wrapRangeInMappedTextNode",value:function(e,t,r,n,a){var i=this;e.nodes.every((function(o,s){var c=e.nodes[s+1];if(void 0===c||c.start>t){if(!n(o.node))return!1;var l=t-o.start,u=(r>o.end?o.end:r)-o.start,d=e.value.substr(0,o.start),f=e.value.substr(u+o.start);if(o.node=i.wrapRangeInTextNode(o.node,l,u),e.value=d+f,e.nodes.forEach((function(t,r){r>=s&&(e.nodes[r].start>0&&r!==s&&(e.nodes[r].start-=u),e.nodes[r].end-=u)})),r-=u,a(o.node.previousSibling,o.start),!(r>o.end))return!1;t=o.end}return!0}))}},{key:"wrapMatches",value:function(e,t,r,n,a){var i=this,o=0===t?0:t+1;this.getTextNodes((function(t){t.nodes.forEach((function(t){t=t.node;for(var a=void 0;null!==(a=e.exec(t.textContent))&&""!==a[o];)if(r(a[o],t)){var s=a.index;if(0!==o)for(var c=1;c{"use strict";r.r(t)},46930:(e,t,r)=>{"use strict";r.r(t)},74865:function(e,t,r){var n,a;n=function(){var e,t,r={version:"0.2.0"},n=r.settings={minimum:.08,easing:"ease",positionUsing:"",speed:200,trickle:!0,trickleRate:.02,trickleSpeed:800,showSpinner:!0,barSelector:'[role="bar"]',spinnerSelector:'[role="spinner"]',parent:"body",template:'
'};function a(e,t,r){return er?r:e}function i(e){return 100*(-1+e)}function o(e,t,r){var a;return(a="translate3d"===n.positionUsing?{transform:"translate3d("+i(e)+"%,0,0)"}:"translate"===n.positionUsing?{transform:"translate("+i(e)+"%,0)"}:{"margin-left":i(e)+"%"}).transition="all "+t+"ms "+r,a}r.configure=function(e){var t,r;for(t in e)void 0!==(r=e[t])&&e.hasOwnProperty(t)&&(n[t]=r);return this},r.status=null,r.set=function(e){var t=r.isStarted();e=a(e,n.minimum,1),r.status=1===e?null:e;var i=r.render(!t),l=i.querySelector(n.barSelector),u=n.speed,d=n.easing;return i.offsetWidth,s((function(t){""===n.positionUsing&&(n.positionUsing=r.getPositioningCSS()),c(l,o(e,u,d)),1===e?(c(i,{transition:"none",opacity:1}),i.offsetWidth,setTimeout((function(){c(i,{transition:"all "+u+"ms linear",opacity:0}),setTimeout((function(){r.remove(),t()}),u)}),u)):setTimeout(t,u)})),this},r.isStarted=function(){return"number"==typeof r.status},r.start=function(){r.status||r.set(0);var e=function(){setTimeout((function(){r.status&&(r.trickle(),e())}),n.trickleSpeed)};return n.trickle&&e(),this},r.done=function(e){return e||r.status?r.inc(.3+.5*Math.random()).set(1):this},r.inc=function(e){var t=r.status;return t?("number"!=typeof e&&(e=(1-t)*a(Math.random()*t,.1,.95)),t=a(t+e,0,.994),r.set(t)):r.start()},r.trickle=function(){return r.inc(Math.random()*n.trickleRate)},e=0,t=0,r.promise=function(n){return n&&"resolved"!==n.state()?(0===t&&r.start(),e++,t++,n.always((function(){0==--t?(e=0,r.done()):r.set((e-t)/e)})),this):this},r.render=function(e){if(r.isRendered())return document.getElementById("nprogress");u(document.documentElement,"nprogress-busy");var t=document.createElement("div");t.id="nprogress",t.innerHTML=n.template;var a,o=t.querySelector(n.barSelector),s=e?"-100":i(r.status||0),l=document.querySelector(n.parent);return c(o,{transition:"all 0 linear",transform:"translate3d("+s+"%,0,0)"}),n.showSpinner||(a=t.querySelector(n.spinnerSelector))&&m(a),l!=document.body&&u(l,"nprogress-custom-parent"),l.appendChild(t),t},r.remove=function(){d(document.documentElement,"nprogress-busy"),d(document.querySelector(n.parent),"nprogress-custom-parent");var e=document.getElementById("nprogress");e&&m(e)},r.isRendered=function(){return!!document.getElementById("nprogress")},r.getPositioningCSS=function(){var e=document.body.style,t="WebkitTransform"in e?"Webkit":"MozTransform"in e?"Moz":"msTransform"in e?"ms":"OTransform"in e?"O":"";return t+"Perspective"in e?"translate3d":t+"Transform"in e?"translate":"margin"};var s=function(){var e=[];function t(){var r=e.shift();r&&r(t)}return function(r){e.push(r),1==e.length&&t()}}(),c=function(){var e=["Webkit","O","Moz","ms"],t={};function r(e){return e.replace(/^-ms-/,"ms-").replace(/-([\da-z])/gi,(function(e,t){return t.toUpperCase()}))}function n(t){var r=document.body.style;if(t in r)return t;for(var n,a=e.length,i=t.charAt(0).toUpperCase()+t.slice(1);a--;)if((n=e[a]+i)in r)return n;return t}function a(e){return e=r(e),t[e]||(t[e]=n(e))}function i(e,t,r){t=a(t),e.style[t]=r}return function(e,t){var r,n,a=arguments;if(2==a.length)for(r in t)void 0!==(n=t[r])&&t.hasOwnProperty(r)&&i(e,r,n);else i(e,a[1],a[2])}}();function l(e,t){return("string"==typeof e?e:f(e)).indexOf(" "+t+" ")>=0}function u(e,t){var r=f(e),n=r+t;l(r,t)||(e.className=n.substring(1))}function d(e,t){var r,n=f(e);l(e,t)&&(r=n.replace(" "+t+" "," "),e.className=r.substring(1,r.length-1))}function f(e){return(" "+(e.className||"")+" ").replace(/\s+/gi," ")}function m(e){e&&e.parentNode&&e.parentNode.removeChild(e)}return r},void 0===(a="function"==typeof n?n.call(t,r,t,e):n)||(e.exports=a)},27418:e=>{"use strict";var t=Object.getOwnPropertySymbols,r=Object.prototype.hasOwnProperty,n=Object.prototype.propertyIsEnumerable;e.exports=function(){try{if(!Object.assign)return!1;var e=new String("abc");if(e[5]="de","5"===Object.getOwnPropertyNames(e)[0])return!1;for(var t={},r=0;r<10;r++)t["_"+String.fromCharCode(r)]=r;if("0123456789"!==Object.getOwnPropertyNames(t).map((function(e){return t[e]})).join(""))return!1;var n={};return"abcdefghijklmnopqrst".split("").forEach((function(e){n[e]=e})),"abcdefghijklmnopqrst"===Object.keys(Object.assign({},n)).join("")}catch(a){return!1}}()?Object.assign:function(e,a){for(var i,o,s=function(e){if(null==e)throw new TypeError("Object.assign cannot be called with null or undefined");return Object(e)}(e),c=1;c{var n=r(5826);e.exports=m,e.exports.parse=i,e.exports.compile=function(e,t){return s(i(e,t),t)},e.exports.tokensToFunction=s,e.exports.tokensToRegExp=f;var a=new RegExp(["(\\\\.)","([\\/.])?(?:(?:\\:(\\w+)(?:\\(((?:\\\\.|[^\\\\()])+)\\))?|\\(((?:\\\\.|[^\\\\()])+)\\))([+*?])?|(\\*))"].join("|"),"g");function i(e,t){for(var r,n=[],i=0,o=0,s="",u=t&&t.delimiter||"/";null!=(r=a.exec(e));){var d=r[0],f=r[1],m=r.index;if(s+=e.slice(o,m),o=m+d.length,f)s+=f[1];else{var p=e[o],b=r[2],g=r[3],h=r[4],w=r[5],I=r[6],x=r[7];s&&(n.push(s),s="");var y=null!=b&&null!=p&&p!==b,k="+"===I||"*"===I,E="?"===I||"*"===I,F=r[2]||u,R=h||w;n.push({name:g||i++,prefix:b||"",delimiter:F,optional:E,repeat:k,partial:y,asterisk:!!x,pattern:R?l(R):x?".*":"[^"+c(F)+"]+?"})}}return o{"use strict";r.d(t,{Z:()=>i});var n=function(){var e=/(?:^|\s)lang(?:uage)?-([\w-]+)(?=\s|$)/i,t=0,r={},n={util:{encode:function e(t){return t instanceof a?new a(t.type,e(t.content),t.alias):Array.isArray(t)?t.map(e):t.replace(/&/g,"&").replace(/=d.reach);E+=k.value.length,k=k.next){var F=k.value;if(t.length>e.length)return;if(!(F instanceof a)){var R,S=1;if(w){if(!(R=i(y,E,e,h))||R.index>=e.length)break;var v=R.index,U=R.index+R[0].length,C=E;for(C+=k.value.length;v>=C;)C+=(k=k.next).value.length;if(E=C-=k.value.length,k.value instanceof a)continue;for(var P=k;P!==t.tail&&(Cd.reach&&(d.reach=T);var j=k.prev;if(_&&(j=c(t,j,_),E+=_.length),l(t,j,S),k=c(t,j,new a(f,g?n.tokenize(O,g):O,I,O)),M&&c(t,k,M),S>1){var A={cause:f+","+p,reach:T};o(e,t,r,k.prev,E,A),d&&A.reach>d.reach&&(d.reach=A.reach)}}}}}}function s(){var e={value:null,prev:null,next:null},t={value:null,prev:e,next:null};e.next=t,this.head=e,this.tail=t,this.length=0}function c(e,t,r){var n=t.next,a={value:r,prev:t,next:n};return t.next=a,n.prev=a,e.length++,a}function l(e,t,r){for(var n=t.next,a=0;a"+i.content+""},n}(),a=n;n.default=n,a.languages.markup={comment:{pattern://,greedy:!0},prolog:{pattern:/<\?[\s\S]+?\?>/,greedy:!0},doctype:{pattern:/"'[\]]|"[^"]*"|'[^']*')+(?:\[(?:[^<"'\]]|"[^"]*"|'[^']*'|<(?!!--)|)*\]\s*)?>/i,greedy:!0,inside:{"internal-subset":{pattern:/(^[^\[]*\[)[\s\S]+(?=\]>$)/,lookbehind:!0,greedy:!0,inside:null},string:{pattern:/"[^"]*"|'[^']*'/,greedy:!0},punctuation:/^$|[[\]]/,"doctype-tag":/^DOCTYPE/i,name:/[^\s<>'"]+/}},cdata:{pattern://i,greedy:!0},tag:{pattern:/<\/?(?!\d)[^\s>\/=$<%]+(?:\s(?:\s*[^\s>\/=]+(?:\s*=\s*(?:"[^"]*"|'[^']*'|[^\s'">=]+(?=[\s>]))|(?=[\s/>])))+)?\s*\/?>/,greedy:!0,inside:{tag:{pattern:/^<\/?[^\s>\/]+/,inside:{punctuation:/^<\/?/,namespace:/^[^\s>\/:]+:/}},"special-attr":[],"attr-value":{pattern:/=\s*(?:"[^"]*"|'[^']*'|[^\s'">=]+)/,inside:{punctuation:[{pattern:/^=/,alias:"attr-equals"},/"|'/]}},punctuation:/\/?>/,"attr-name":{pattern:/[^\s>\/]+/,inside:{namespace:/^[^\s>\/:]+:/}}}},entity:[{pattern:/&[\da-z]{1,8};/i,alias:"named-entity"},/&#x?[\da-f]{1,8};/i]},a.languages.markup.tag.inside["attr-value"].inside.entity=a.languages.markup.entity,a.languages.markup.doctype.inside["internal-subset"].inside=a.languages.markup,a.hooks.add("wrap",(function(e){"entity"===e.type&&(e.attributes.title=e.content.replace(/&/,"&"))})),Object.defineProperty(a.languages.markup.tag,"addInlined",{value:function(e,t){var r={};r["language-"+t]={pattern:/(^$)/i,lookbehind:!0,inside:a.languages[t]},r.cdata=/^$/i;var n={"included-cdata":{pattern://i,inside:r}};n["language-"+t]={pattern:/[\s\S]+/,inside:a.languages[t]};var i={};i[e]={pattern:RegExp(/(<__[^>]*>)(?:))*\]\]>|(?!)/.source.replace(/__/g,(function(){return e})),"i"),lookbehind:!0,greedy:!0,inside:n},a.languages.insertBefore("markup","cdata",i)}}),Object.defineProperty(a.languages.markup.tag,"addAttribute",{value:function(e,t){a.languages.markup.tag.inside["special-attr"].push({pattern:RegExp(/(^|["'\s])/.source+"(?:"+e+")"+/\s*=\s*(?:"[^"]*"|'[^']*'|[^\s'">=]+(?=[\s>]))/.source,"i"),lookbehind:!0,inside:{"attr-name":/^[^\s=]+/,"attr-value":{pattern:/=[\s\S]+/,inside:{value:{pattern:/(^=\s*(["']|(?!["'])))\S[\s\S]*(?=\2$)/,lookbehind:!0,alias:[t,"language-"+t],inside:a.languages[t]},punctuation:[{pattern:/^=/,alias:"attr-equals"},/"|'/]}}}})}}),a.languages.html=a.languages.markup,a.languages.mathml=a.languages.markup,a.languages.svg=a.languages.markup,a.languages.xml=a.languages.extend("markup",{}),a.languages.ssml=a.languages.xml,a.languages.atom=a.languages.xml,a.languages.rss=a.languages.xml,function(e){var t="\\b(?:BASH|BASHOPTS|BASH_ALIASES|BASH_ARGC|BASH_ARGV|BASH_CMDS|BASH_COMPLETION_COMPAT_DIR|BASH_LINENO|BASH_REMATCH|BASH_SOURCE|BASH_VERSINFO|BASH_VERSION|COLORTERM|COLUMNS|COMP_WORDBREAKS|DBUS_SESSION_BUS_ADDRESS|DEFAULTS_PATH|DESKTOP_SESSION|DIRSTACK|DISPLAY|EUID|GDMSESSION|GDM_LANG|GNOME_KEYRING_CONTROL|GNOME_KEYRING_PID|GPG_AGENT_INFO|GROUPS|HISTCONTROL|HISTFILE|HISTFILESIZE|HISTSIZE|HOME|HOSTNAME|HOSTTYPE|IFS|INSTANCE|JOB|LANG|LANGUAGE|LC_ADDRESS|LC_ALL|LC_IDENTIFICATION|LC_MEASUREMENT|LC_MONETARY|LC_NAME|LC_NUMERIC|LC_PAPER|LC_TELEPHONE|LC_TIME|LESSCLOSE|LESSOPEN|LINES|LOGNAME|LS_COLORS|MACHTYPE|MAILCHECK|MANDATORY_PATH|NO_AT_BRIDGE|OLDPWD|OPTERR|OPTIND|ORBIT_SOCKETDIR|OSTYPE|PAPERSIZE|PATH|PIPESTATUS|PPID|PS1|PS2|PS3|PS4|PWD|RANDOM|REPLY|SECONDS|SELINUX_INIT|SESSION|SESSIONTYPE|SESSION_MANAGER|SHELL|SHELLOPTS|SHLVL|SSH_AUTH_SOCK|TERM|UID|UPSTART_EVENTS|UPSTART_INSTANCE|UPSTART_JOB|UPSTART_SESSION|USER|WINDOWID|XAUTHORITY|XDG_CONFIG_DIRS|XDG_CURRENT_DESKTOP|XDG_DATA_DIRS|XDG_GREETER_DATA_DIR|XDG_MENU_PREFIX|XDG_RUNTIME_DIR|XDG_SEAT|XDG_SEAT_PATH|XDG_SESSION_DESKTOP|XDG_SESSION_ID|XDG_SESSION_PATH|XDG_SESSION_TYPE|XDG_VTNR|XMODIFIERS)\\b",r={pattern:/(^(["']?)\w+\2)[ \t]+\S.*/,lookbehind:!0,alias:"punctuation",inside:null},n={bash:r,environment:{pattern:RegExp("\\$"+t),alias:"constant"},variable:[{pattern:/\$?\(\([\s\S]+?\)\)/,greedy:!0,inside:{variable:[{pattern:/(^\$\(\([\s\S]+)\)\)/,lookbehind:!0},/^\$\(\(/],number:/\b0x[\dA-Fa-f]+\b|(?:\b\d+(?:\.\d*)?|\B\.\d+)(?:[Ee]-?\d+)?/,operator:/--|\+\+|\*\*=?|<<=?|>>=?|&&|\|\||[=!+\-*/%<>^&|]=?|[?~:]/,punctuation:/\(\(?|\)\)?|,|;/}},{pattern:/\$\((?:\([^)]+\)|[^()])+\)|`[^`]+`/,greedy:!0,inside:{variable:/^\$\(|^`|\)$|`$/}},{pattern:/\$\{[^}]+\}/,greedy:!0,inside:{operator:/:[-=?+]?|[!\/]|##?|%%?|\^\^?|,,?/,punctuation:/[\[\]]/,environment:{pattern:RegExp("(\\{)"+t),lookbehind:!0,alias:"constant"}}},/\$(?:\w+|[#?*!@$])/],entity:/\\(?:[abceEfnrtv\\"]|O?[0-7]{1,3}|U[0-9a-fA-F]{8}|u[0-9a-fA-F]{4}|x[0-9a-fA-F]{1,2})/};e.languages.bash={shebang:{pattern:/^#!\s*\/.*/,alias:"important"},comment:{pattern:/(^|[^"{\\$])#.*/,lookbehind:!0},"function-name":[{pattern:/(\bfunction\s+)[\w-]+(?=(?:\s*\(?:\s*\))?\s*\{)/,lookbehind:!0,alias:"function"},{pattern:/\b[\w-]+(?=\s*\(\s*\)\s*\{)/,alias:"function"}],"for-or-select":{pattern:/(\b(?:for|select)\s+)\w+(?=\s+in\s)/,alias:"variable",lookbehind:!0},"assign-left":{pattern:/(^|[\s;|&]|[<>]\()\w+(?=\+?=)/,inside:{environment:{pattern:RegExp("(^|[\\s;|&]|[<>]\\()"+t),lookbehind:!0,alias:"constant"}},alias:"variable",lookbehind:!0},string:[{pattern:/((?:^|[^<])<<-?\s*)(\w+)\s[\s\S]*?(?:\r?\n|\r)\2/,lookbehind:!0,greedy:!0,inside:n},{pattern:/((?:^|[^<])<<-?\s*)(["'])(\w+)\2\s[\s\S]*?(?:\r?\n|\r)\3/,lookbehind:!0,greedy:!0,inside:{bash:r}},{pattern:/(^|[^\\](?:\\\\)*)"(?:\\[\s\S]|\$\([^)]+\)|\$(?!\()|`[^`]+`|[^"\\`$])*"/,lookbehind:!0,greedy:!0,inside:n},{pattern:/(^|[^$\\])'[^']*'/,lookbehind:!0,greedy:!0},{pattern:/\$'(?:[^'\\]|\\[\s\S])*'/,greedy:!0,inside:{entity:n.entity}}],environment:{pattern:RegExp("\\$?"+t),alias:"constant"},variable:n.variable,function:{pattern:/(^|[\s;|&]|[<>]\()(?:add|apropos|apt|apt-cache|apt-get|aptitude|aspell|automysqlbackup|awk|basename|bash|bc|bconsole|bg|bzip2|cal|cat|cfdisk|chgrp|chkconfig|chmod|chown|chroot|cksum|clear|cmp|column|comm|composer|cp|cron|crontab|csplit|curl|cut|date|dc|dd|ddrescue|debootstrap|df|diff|diff3|dig|dir|dircolors|dirname|dirs|dmesg|docker|docker-compose|du|egrep|eject|env|ethtool|expand|expect|expr|fdformat|fdisk|fg|fgrep|file|find|fmt|fold|format|free|fsck|ftp|fuser|gawk|git|gparted|grep|groupadd|groupdel|groupmod|groups|grub-mkconfig|gzip|halt|head|hg|history|host|hostname|htop|iconv|id|ifconfig|ifdown|ifup|import|install|ip|jobs|join|kill|killall|less|link|ln|locate|logname|logrotate|look|lpc|lpr|lprint|lprintd|lprintq|lprm|ls|lsof|lynx|make|man|mc|mdadm|mkconfig|mkdir|mke2fs|mkfifo|mkfs|mkisofs|mknod|mkswap|mmv|more|most|mount|mtools|mtr|mutt|mv|nano|nc|netstat|nice|nl|node|nohup|notify-send|npm|nslookup|op|open|parted|passwd|paste|pathchk|ping|pkill|pnpm|podman|podman-compose|popd|pr|printcap|printenv|ps|pushd|pv|quota|quotacheck|quotactl|ram|rar|rcp|reboot|remsync|rename|renice|rev|rm|rmdir|rpm|rsync|scp|screen|sdiff|sed|sendmail|seq|service|sftp|sh|shellcheck|shuf|shutdown|sleep|slocate|sort|split|ssh|stat|strace|su|sudo|sum|suspend|swapon|sync|tac|tail|tar|tee|time|timeout|top|touch|tr|traceroute|tsort|tty|umount|uname|unexpand|uniq|units|unrar|unshar|unzip|update-grub|uptime|useradd|userdel|usermod|users|uudecode|uuencode|v|vcpkg|vdir|vi|vim|virsh|vmstat|wait|watch|wc|wget|whereis|which|who|whoami|write|xargs|xdg-open|yarn|yes|zenity|zip|zsh|zypper)(?=$|[)\s;|&])/,lookbehind:!0},keyword:{pattern:/(^|[\s;|&]|[<>]\()(?:case|do|done|elif|else|esac|fi|for|function|if|in|select|then|until|while)(?=$|[)\s;|&])/,lookbehind:!0},builtin:{pattern:/(^|[\s;|&]|[<>]\()(?:\.|:|alias|bind|break|builtin|caller|cd|command|continue|declare|echo|enable|eval|exec|exit|export|getopts|hash|help|let|local|logout|mapfile|printf|pwd|read|readarray|readonly|return|set|shift|shopt|source|test|times|trap|type|typeset|ulimit|umask|unalias|unset)(?=$|[)\s;|&])/,lookbehind:!0,alias:"class-name"},boolean:{pattern:/(^|[\s;|&]|[<>]\()(?:false|true)(?=$|[)\s;|&])/,lookbehind:!0},"file-descriptor":{pattern:/\B&\d\b/,alias:"important"},operator:{pattern:/\d?<>|>\||\+=|=[=~]?|!=?|<<[<-]?|[&\d]?>>|\d[<>]&?|[<>][&=]?|&[>&]?|\|[&|]?/,inside:{"file-descriptor":{pattern:/^\d/,alias:"important"}}},punctuation:/\$?\(\(?|\)\)?|\.\.|[{}[\];\\]/,number:{pattern:/(^|\s)(?:[1-9]\d*|0)(?:[.,]\d+)?\b/,lookbehind:!0}},r.inside=e.languages.bash;for(var a=["comment","function-name","for-or-select","assign-left","string","environment","function","keyword","builtin","boolean","file-descriptor","operator","punctuation","number"],i=n.variable[1].inside,o=0;o]=?|[!=]=?=?|--?|\+\+?|&&?|\|\|?|[?*/~^%]/,punctuation:/[{}[\];(),.:]/},a.languages.c=a.languages.extend("clike",{comment:{pattern:/\/\/(?:[^\r\n\\]|\\(?:\r\n?|\n|(?![\r\n])))*|\/\*[\s\S]*?(?:\*\/|$)/,greedy:!0},string:{pattern:/"(?:\\(?:\r\n|[\s\S])|[^"\\\r\n])*"/,greedy:!0},"class-name":{pattern:/(\b(?:enum|struct)\s+(?:__attribute__\s*\(\([\s\S]*?\)\)\s*)?)\w+|\b[a-z]\w*_t\b/,lookbehind:!0},keyword:/\b(?:_Alignas|_Alignof|_Atomic|_Bool|_Complex|_Generic|_Imaginary|_Noreturn|_Static_assert|_Thread_local|__attribute__|asm|auto|break|case|char|const|continue|default|do|double|else|enum|extern|float|for|goto|if|inline|int|long|register|return|short|signed|sizeof|static|struct|switch|typedef|typeof|union|unsigned|void|volatile|while)\b/,function:/\b[a-z_]\w*(?=\s*\()/i,number:/(?:\b0x(?:[\da-f]+(?:\.[\da-f]*)?|\.[\da-f]+)(?:p[+-]?\d+)?|(?:\b\d+(?:\.\d*)?|\B\.\d+)(?:e[+-]?\d+)?)[ful]{0,4}/i,operator:/>>=?|<<=?|->|([-+&|:])\1|[?:~]|[-+*/%&|^!=<>]=?/}),a.languages.insertBefore("c","string",{char:{pattern:/'(?:\\(?:\r\n|[\s\S])|[^'\\\r\n]){0,32}'/,greedy:!0}}),a.languages.insertBefore("c","string",{macro:{pattern:/(^[\t ]*)#\s*[a-z](?:[^\r\n\\/]|\/(?!\*)|\/\*(?:[^*]|\*(?!\/))*\*\/|\\(?:\r\n|[\s\S]))*/im,lookbehind:!0,greedy:!0,alias:"property",inside:{string:[{pattern:/^(#\s*include\s*)<[^>]+>/,lookbehind:!0},a.languages.c.string],char:a.languages.c.char,comment:a.languages.c.comment,"macro-name":[{pattern:/(^#\s*define\s+)\w+\b(?!\()/i,lookbehind:!0},{pattern:/(^#\s*define\s+)\w+\b(?=\()/i,lookbehind:!0,alias:"function"}],directive:{pattern:/^(#\s*)[a-z]+/,lookbehind:!0,alias:"keyword"},"directive-hash":/^#/,punctuation:/##|\\(?=[\r\n])/,expression:{pattern:/\S[\s\S]*/,inside:a.languages.c}}}}),a.languages.insertBefore("c","function",{constant:/\b(?:EOF|NULL|SEEK_CUR|SEEK_END|SEEK_SET|__DATE__|__FILE__|__LINE__|__TIMESTAMP__|__TIME__|__func__|stderr|stdin|stdout)\b/}),delete a.languages.c.boolean,function(e){var t=/\b(?:alignas|alignof|asm|auto|bool|break|case|catch|char|char16_t|char32_t|char8_t|class|co_await|co_return|co_yield|compl|concept|const|const_cast|consteval|constexpr|constinit|continue|decltype|default|delete|do|double|dynamic_cast|else|enum|explicit|export|extern|final|float|for|friend|goto|if|import|inline|int|int16_t|int32_t|int64_t|int8_t|long|module|mutable|namespace|new|noexcept|nullptr|operator|override|private|protected|public|register|reinterpret_cast|requires|return|short|signed|sizeof|static|static_assert|static_cast|struct|switch|template|this|thread_local|throw|try|typedef|typeid|typename|uint16_t|uint32_t|uint64_t|uint8_t|union|unsigned|using|virtual|void|volatile|wchar_t|while)\b/,r=/\b(?!)\w+(?:\s*\.\s*\w+)*\b/.source.replace(//g,(function(){return t.source}));e.languages.cpp=e.languages.extend("c",{"class-name":[{pattern:RegExp(/(\b(?:class|concept|enum|struct|typename)\s+)(?!)\w+/.source.replace(//g,(function(){return t.source}))),lookbehind:!0},/\b[A-Z]\w*(?=\s*::\s*\w+\s*\()/,/\b[A-Z_]\w*(?=\s*::\s*~\w+\s*\()/i,/\b\w+(?=\s*<(?:[^<>]|<(?:[^<>]|<[^<>]*>)*>)*>\s*::\s*\w+\s*\()/],keyword:t,number:{pattern:/(?:\b0b[01']+|\b0x(?:[\da-f']+(?:\.[\da-f']*)?|\.[\da-f']+)(?:p[+-]?[\d']+)?|(?:\b[\d']+(?:\.[\d']*)?|\B\.[\d']+)(?:e[+-]?[\d']+)?)[ful]{0,4}/i,greedy:!0},operator:/>>=?|<<=?|->|--|\+\+|&&|\|\||[?:~]|<=>|[-+*/%&|^!=<>]=?|\b(?:and|and_eq|bitand|bitor|not|not_eq|or|or_eq|xor|xor_eq)\b/,boolean:/\b(?:false|true)\b/}),e.languages.insertBefore("cpp","string",{module:{pattern:RegExp(/(\b(?:import|module)\s+)/.source+"(?:"+/"(?:\\(?:\r\n|[\s\S])|[^"\\\r\n])*"|<[^<>\r\n]*>/.source+"|"+/(?:\s*:\s*)?|:\s*/.source.replace(//g,(function(){return r}))+")"),lookbehind:!0,greedy:!0,inside:{string:/^[<"][\s\S]+/,operator:/:/,punctuation:/\./}},"raw-string":{pattern:/R"([^()\\ ]{0,16})\([\s\S]*?\)\1"/,alias:"string",greedy:!0}}),e.languages.insertBefore("cpp","keyword",{"generic-function":{pattern:/\b(?!operator\b)[a-z_]\w*\s*<(?:[^<>]|<[^<>]*>)*>(?=\s*\()/i,inside:{function:/^\w+/,generic:{pattern:/<[\s\S]+/,alias:"class-name",inside:e.languages.cpp}}}}),e.languages.insertBefore("cpp","operator",{"double-colon":{pattern:/::/,alias:"punctuation"}}),e.languages.insertBefore("cpp","class-name",{"base-clause":{pattern:/(\b(?:class|struct)\s+\w+\s*:\s*)[^;{}"'\s]+(?:\s+[^;{}"'\s]+)*(?=\s*[;{])/,lookbehind:!0,greedy:!0,inside:e.languages.extend("cpp",{})}}),e.languages.insertBefore("inside","double-colon",{"class-name":/\b[a-z_]\w*\b(?!\s*::)/i},e.languages.cpp["base-clause"])}(a),function(e){var t=/(?:"(?:\\(?:\r\n|[\s\S])|[^"\\\r\n])*"|'(?:\\(?:\r\n|[\s\S])|[^'\\\r\n])*')/;e.languages.css={comment:/\/\*[\s\S]*?\*\//,atrule:{pattern:/@[\w-](?:[^;{\s]|\s+(?![\s{]))*(?:;|(?=\s*\{))/,inside:{rule:/^@[\w-]+/,"selector-function-argument":{pattern:/(\bselector\s*\(\s*(?![\s)]))(?:[^()\s]|\s+(?![\s)])|\((?:[^()]|\([^()]*\))*\))+(?=\s*\))/,lookbehind:!0,alias:"selector"},keyword:{pattern:/(^|[^\w-])(?:and|not|only|or)(?![\w-])/,lookbehind:!0}}},url:{pattern:RegExp("\\burl\\((?:"+t.source+"|"+/(?:[^\\\r\n()"']|\\[\s\S])*/.source+")\\)","i"),greedy:!0,inside:{function:/^url/i,punctuation:/^\(|\)$/,string:{pattern:RegExp("^"+t.source+"$"),alias:"url"}}},selector:{pattern:RegExp("(^|[{}\\s])[^{}\\s](?:[^{};\"'\\s]|\\s+(?![\\s{])|"+t.source+")*(?=\\s*\\{)"),lookbehind:!0},string:{pattern:t,greedy:!0},property:{pattern:/(^|[^-\w\xA0-\uFFFF])(?!\s)[-_a-z\xA0-\uFFFF](?:(?!\s)[-\w\xA0-\uFFFF])*(?=\s*:)/i,lookbehind:!0},important:/!important\b/i,function:{pattern:/(^|[^-a-z0-9])[-a-z0-9]+(?=\()/i,lookbehind:!0},punctuation:/[(){};:,]/},e.languages.css.atrule.inside.rest=e.languages.css;var r=e.languages.markup;r&&(r.tag.addInlined("style","css"),r.tag.addAttribute("style","css"))}(a),function(e){var t,r=/("|')(?:\\(?:\r\n|[\s\S])|(?!\1)[^\\\r\n])*\1/;e.languages.css.selector={pattern:e.languages.css.selector.pattern,lookbehind:!0,inside:t={"pseudo-element":/:(?:after|before|first-letter|first-line|selection)|::[-\w]+/,"pseudo-class":/:[-\w]+/,class:/\.[-\w]+/,id:/#[-\w]+/,attribute:{pattern:RegExp("\\[(?:[^[\\]\"']|"+r.source+")*\\]"),greedy:!0,inside:{punctuation:/^\[|\]$/,"case-sensitivity":{pattern:/(\s)[si]$/i,lookbehind:!0,alias:"keyword"},namespace:{pattern:/^(\s*)(?:(?!\s)[-*\w\xA0-\uFFFF])*\|(?!=)/,lookbehind:!0,inside:{punctuation:/\|$/}},"attr-name":{pattern:/^(\s*)(?:(?!\s)[-\w\xA0-\uFFFF])+/,lookbehind:!0},"attr-value":[r,{pattern:/(=\s*)(?:(?!\s)[-\w\xA0-\uFFFF])+(?=\s*$)/,lookbehind:!0}],operator:/[|~*^$]?=/}},"n-th":[{pattern:/(\(\s*)[+-]?\d*[\dn](?:\s*[+-]\s*\d+)?(?=\s*\))/,lookbehind:!0,inside:{number:/[\dn]+/,operator:/[+-]/}},{pattern:/(\(\s*)(?:even|odd)(?=\s*\))/i,lookbehind:!0}],combinator:/>|\+|~|\|\|/,punctuation:/[(),]/}},e.languages.css.atrule.inside["selector-function-argument"].inside=t,e.languages.insertBefore("css","property",{variable:{pattern:/(^|[^-\w\xA0-\uFFFF])--(?!\s)[-_a-z\xA0-\uFFFF](?:(?!\s)[-\w\xA0-\uFFFF])*/i,lookbehind:!0}});var n={pattern:/(\b\d+)(?:%|[a-z]+(?![\w-]))/,lookbehind:!0},a={pattern:/(^|[^\w.-])-?(?:\d+(?:\.\d+)?|\.\d+)/,lookbehind:!0};e.languages.insertBefore("css","function",{operator:{pattern:/(\s)[+\-*\/](?=\s)/,lookbehind:!0},hexcode:{pattern:/\B#[\da-f]{3,8}\b/i,alias:"color"},color:[{pattern:/(^|[^\w-])(?:AliceBlue|AntiqueWhite|Aqua|Aquamarine|Azure|Beige|Bisque|Black|BlanchedAlmond|Blue|BlueViolet|Brown|BurlyWood|CadetBlue|Chartreuse|Chocolate|Coral|CornflowerBlue|Cornsilk|Crimson|Cyan|DarkBlue|DarkCyan|DarkGoldenRod|DarkGr[ae]y|DarkGreen|DarkKhaki|DarkMagenta|DarkOliveGreen|DarkOrange|DarkOrchid|DarkRed|DarkSalmon|DarkSeaGreen|DarkSlateBlue|DarkSlateGr[ae]y|DarkTurquoise|DarkViolet|DeepPink|DeepSkyBlue|DimGr[ae]y|DodgerBlue|FireBrick|FloralWhite|ForestGreen|Fuchsia|Gainsboro|GhostWhite|Gold|GoldenRod|Gr[ae]y|Green|GreenYellow|HoneyDew|HotPink|IndianRed|Indigo|Ivory|Khaki|Lavender|LavenderBlush|LawnGreen|LemonChiffon|LightBlue|LightCoral|LightCyan|LightGoldenRodYellow|LightGr[ae]y|LightGreen|LightPink|LightSalmon|LightSeaGreen|LightSkyBlue|LightSlateGr[ae]y|LightSteelBlue|LightYellow|Lime|LimeGreen|Linen|Magenta|Maroon|MediumAquaMarine|MediumBlue|MediumOrchid|MediumPurple|MediumSeaGreen|MediumSlateBlue|MediumSpringGreen|MediumTurquoise|MediumVioletRed|MidnightBlue|MintCream|MistyRose|Moccasin|NavajoWhite|Navy|OldLace|Olive|OliveDrab|Orange|OrangeRed|Orchid|PaleGoldenRod|PaleGreen|PaleTurquoise|PaleVioletRed|PapayaWhip|PeachPuff|Peru|Pink|Plum|PowderBlue|Purple|Red|RosyBrown|RoyalBlue|SaddleBrown|Salmon|SandyBrown|SeaGreen|SeaShell|Sienna|Silver|SkyBlue|SlateBlue|SlateGr[ae]y|Snow|SpringGreen|SteelBlue|Tan|Teal|Thistle|Tomato|Transparent|Turquoise|Violet|Wheat|White|WhiteSmoke|Yellow|YellowGreen)(?![\w-])/i,lookbehind:!0},{pattern:/\b(?:hsl|rgb)\(\s*\d{1,3}\s*,\s*\d{1,3}%?\s*,\s*\d{1,3}%?\s*\)\B|\b(?:hsl|rgb)a\(\s*\d{1,3}\s*,\s*\d{1,3}%?\s*,\s*\d{1,3}%?\s*,\s*(?:0|0?\.\d+|1)\s*\)\B/i,inside:{unit:n,number:a,function:/[\w-]+(?=\()/,punctuation:/[(),]/}}],entity:/\\[\da-f]{1,8}/i,unit:n,number:a})}(a),a.languages.javascript=a.languages.extend("clike",{"class-name":[a.languages.clike["class-name"],{pattern:/(^|[^$\w\xA0-\uFFFF])(?!\s)[_$A-Z\xA0-\uFFFF](?:(?!\s)[$\w\xA0-\uFFFF])*(?=\.(?:constructor|prototype))/,lookbehind:!0}],keyword:[{pattern:/((?:^|\})\s*)catch\b/,lookbehind:!0},{pattern:/(^|[^.]|\.\.\.\s*)\b(?:as|assert(?=\s*\{)|async(?=\s*(?:function\b|\(|[$\w\xA0-\uFFFF]|$))|await|break|case|class|const|continue|debugger|default|delete|do|else|enum|export|extends|finally(?=\s*(?:\{|$))|for|from(?=\s*(?:['"]|$))|function|(?:get|set)(?=\s*(?:[#\[$\w\xA0-\uFFFF]|$))|if|implements|import|in|instanceof|interface|let|new|null|of|package|private|protected|public|return|static|super|switch|this|throw|try|typeof|undefined|var|void|while|with|yield)\b/,lookbehind:!0}],function:/#?(?!\s)[_$a-zA-Z\xA0-\uFFFF](?:(?!\s)[$\w\xA0-\uFFFF])*(?=\s*(?:\.\s*(?:apply|bind|call)\s*)?\()/,number:{pattern:RegExp(/(^|[^\w$])/.source+"(?:"+/NaN|Infinity/.source+"|"+/0[bB][01]+(?:_[01]+)*n?/.source+"|"+/0[oO][0-7]+(?:_[0-7]+)*n?/.source+"|"+/0[xX][\dA-Fa-f]+(?:_[\dA-Fa-f]+)*n?/.source+"|"+/\d+(?:_\d+)*n/.source+"|"+/(?:\d+(?:_\d+)*(?:\.(?:\d+(?:_\d+)*)?)?|\.\d+(?:_\d+)*)(?:[Ee][+-]?\d+(?:_\d+)*)?/.source+")"+/(?![\w$])/.source),lookbehind:!0},operator:/--|\+\+|\*\*=?|=>|&&=?|\|\|=?|[!=]==|<<=?|>>>?=?|[-+*/%&|^!=<>]=?|\.{3}|\?\?=?|\?\.?|[~:]/}),a.languages.javascript["class-name"][0].pattern=/(\b(?:class|extends|implements|instanceof|interface|new)\s+)[\w.\\]+/,a.languages.insertBefore("javascript","keyword",{regex:{pattern:/((?:^|[^$\w\xA0-\uFFFF."'\])\s]|\b(?:return|yield))\s*)\/(?:\[(?:[^\]\\\r\n]|\\.)*\]|\\.|[^/\\\[\r\n])+\/[dgimyus]{0,7}(?=(?:\s|\/\*(?:[^*]|\*(?!\/))*\*\/)*(?:$|[\r\n,.;:})\]]|\/\/))/,lookbehind:!0,greedy:!0,inside:{"regex-source":{pattern:/^(\/)[\s\S]+(?=\/[a-z]*$)/,lookbehind:!0,alias:"language-regex",inside:a.languages.regex},"regex-delimiter":/^\/|\/$/,"regex-flags":/^[a-z]+$/}},"function-variable":{pattern:/#?(?!\s)[_$a-zA-Z\xA0-\uFFFF](?:(?!\s)[$\w\xA0-\uFFFF])*(?=\s*[=:]\s*(?:async\s*)?(?:\bfunction\b|(?:\((?:[^()]|\([^()]*\))*\)|(?!\s)[_$a-zA-Z\xA0-\uFFFF](?:(?!\s)[$\w\xA0-\uFFFF])*)\s*=>))/,alias:"function"},parameter:[{pattern:/(function(?:\s+(?!\s)[_$a-zA-Z\xA0-\uFFFF](?:(?!\s)[$\w\xA0-\uFFFF])*)?\s*\(\s*)(?!\s)(?:[^()\s]|\s+(?![\s)])|\([^()]*\))+(?=\s*\))/,lookbehind:!0,inside:a.languages.javascript},{pattern:/(^|[^$\w\xA0-\uFFFF])(?!\s)[_$a-z\xA0-\uFFFF](?:(?!\s)[$\w\xA0-\uFFFF])*(?=\s*=>)/i,lookbehind:!0,inside:a.languages.javascript},{pattern:/(\(\s*)(?!\s)(?:[^()\s]|\s+(?![\s)])|\([^()]*\))+(?=\s*\)\s*=>)/,lookbehind:!0,inside:a.languages.javascript},{pattern:/((?:\b|\s|^)(?!(?:as|async|await|break|case|catch|class|const|continue|debugger|default|delete|do|else|enum|export|extends|finally|for|from|function|get|if|implements|import|in|instanceof|interface|let|new|null|of|package|private|protected|public|return|set|static|super|switch|this|throw|try|typeof|undefined|var|void|while|with|yield)(?![$\w\xA0-\uFFFF]))(?:(?!\s)[_$a-zA-Z\xA0-\uFFFF](?:(?!\s)[$\w\xA0-\uFFFF])*\s*)\(\s*|\]\s*\(\s*)(?!\s)(?:[^()\s]|\s+(?![\s)])|\([^()]*\))+(?=\s*\)\s*\{)/,lookbehind:!0,inside:a.languages.javascript}],constant:/\b[A-Z](?:[A-Z_]|\dx?)*\b/}),a.languages.insertBefore("javascript","string",{hashbang:{pattern:/^#!.*/,greedy:!0,alias:"comment"},"template-string":{pattern:/`(?:\\[\s\S]|\$\{(?:[^{}]|\{(?:[^{}]|\{[^}]*\})*\})+\}|(?!\$\{)[^\\`])*`/,greedy:!0,inside:{"template-punctuation":{pattern:/^`|`$/,alias:"string"},interpolation:{pattern:/((?:^|[^\\])(?:\\{2})*)\$\{(?:[^{}]|\{(?:[^{}]|\{[^}]*\})*\})+\}/,lookbehind:!0,inside:{"interpolation-punctuation":{pattern:/^\$\{|\}$/,alias:"punctuation"},rest:a.languages.javascript}},string:/[\s\S]+/}},"string-property":{pattern:/((?:^|[,{])[ \t]*)(["'])(?:\\(?:\r\n|[\s\S])|(?!\2)[^\\\r\n])*\2(?=\s*:)/m,lookbehind:!0,greedy:!0,alias:"property"}}),a.languages.insertBefore("javascript","operator",{"literal-property":{pattern:/((?:^|[,{])[ \t]*)(?!\s)[_$a-zA-Z\xA0-\uFFFF](?:(?!\s)[$\w\xA0-\uFFFF])*(?=\s*:)/m,lookbehind:!0,alias:"property"}}),a.languages.markup&&(a.languages.markup.tag.addInlined("script","javascript"),a.languages.markup.tag.addAttribute(/on(?:abort|blur|change|click|composition(?:end|start|update)|dblclick|error|focus(?:in|out)?|key(?:down|up)|load|mouse(?:down|enter|leave|move|out|over|up)|reset|resize|scroll|select|slotchange|submit|unload|wheel)/.source,"javascript")),a.languages.js=a.languages.javascript,function(e){var t=/#(?!\{).+/,r={pattern:/#\{[^}]+\}/,alias:"variable"};e.languages.coffeescript=e.languages.extend("javascript",{comment:t,string:[{pattern:/'(?:\\[\s\S]|[^\\'])*'/,greedy:!0},{pattern:/"(?:\\[\s\S]|[^\\"])*"/,greedy:!0,inside:{interpolation:r}}],keyword:/\b(?:and|break|by|catch|class|continue|debugger|delete|do|each|else|extend|extends|false|finally|for|if|in|instanceof|is|isnt|let|loop|namespace|new|no|not|null|of|off|on|or|own|return|super|switch|then|this|throw|true|try|typeof|undefined|unless|until|when|while|window|with|yes|yield)\b/,"class-member":{pattern:/@(?!\d)\w+/,alias:"variable"}}),e.languages.insertBefore("coffeescript","comment",{"multiline-comment":{pattern:/###[\s\S]+?###/,alias:"comment"},"block-regex":{pattern:/\/{3}[\s\S]*?\/{3}/,alias:"regex",inside:{comment:t,interpolation:r}}}),e.languages.insertBefore("coffeescript","string",{"inline-javascript":{pattern:/`(?:\\[\s\S]|[^\\`])*`/,inside:{delimiter:{pattern:/^`|`$/,alias:"punctuation"},script:{pattern:/[\s\S]+/,alias:"language-javascript",inside:e.languages.javascript}}},"multiline-string":[{pattern:/'''[\s\S]*?'''/,greedy:!0,alias:"string"},{pattern:/"""[\s\S]*?"""/,greedy:!0,alias:"string",inside:{interpolation:r}}]}),e.languages.insertBefore("coffeescript","keyword",{property:/(?!\d)\w+(?=\s*:(?!:))/}),delete e.languages.coffeescript["template-string"],e.languages.coffee=e.languages.coffeescript}(a),function(e){var t=/[*&][^\s[\]{},]+/,r=/!(?:<[\w\-%#;/?:@&=+$,.!~*'()[\]]+>|(?:[a-zA-Z\d-]*!)?[\w\-%#;/?:@&=+$.~*'()]+)?/,n="(?:"+r.source+"(?:[ \t]+"+t.source+")?|"+t.source+"(?:[ \t]+"+r.source+")?)",a=/(?:[^\s\x00-\x08\x0e-\x1f!"#%&'*,\-:>?@[\]`{|}\x7f-\x84\x86-\x9f\ud800-\udfff\ufffe\uffff]|[?:-])(?:[ \t]*(?:(?![#:])|:))*/.source.replace(//g,(function(){return/[^\s\x00-\x08\x0e-\x1f,[\]{}\x7f-\x84\x86-\x9f\ud800-\udfff\ufffe\uffff]/.source})),i=/"(?:[^"\\\r\n]|\\.)*"|'(?:[^'\\\r\n]|\\.)*'/.source;function o(e,t){t=(t||"").replace(/m/g,"")+"m";var r=/([:\-,[{]\s*(?:\s<>[ \t]+)?)(?:<>)(?=[ \t]*(?:$|,|\]|\}|(?:[\r\n]\s*)?#))/.source.replace(/<>/g,(function(){return n})).replace(/<>/g,(function(){return e}));return RegExp(r,t)}e.languages.yaml={scalar:{pattern:RegExp(/([\-:]\s*(?:\s<>[ \t]+)?[|>])[ \t]*(?:((?:\r?\n|\r)[ \t]+)\S[^\r\n]*(?:\2[^\r\n]+)*)/.source.replace(/<>/g,(function(){return n}))),lookbehind:!0,alias:"string"},comment:/#.*/,key:{pattern:RegExp(/((?:^|[:\-,[{\r\n?])[ \t]*(?:<>[ \t]+)?)<>(?=\s*:\s)/.source.replace(/<>/g,(function(){return n})).replace(/<>/g,(function(){return"(?:"+a+"|"+i+")"}))),lookbehind:!0,greedy:!0,alias:"atrule"},directive:{pattern:/(^[ \t]*)%.+/m,lookbehind:!0,alias:"important"},datetime:{pattern:o(/\d{4}-\d\d?-\d\d?(?:[tT]|[ \t]+)\d\d?:\d{2}:\d{2}(?:\.\d*)?(?:[ \t]*(?:Z|[-+]\d\d?(?::\d{2})?))?|\d{4}-\d{2}-\d{2}|\d\d?:\d{2}(?::\d{2}(?:\.\d*)?)?/.source),lookbehind:!0,alias:"number"},boolean:{pattern:o(/false|true/.source,"i"),lookbehind:!0,alias:"important"},null:{pattern:o(/null|~/.source,"i"),lookbehind:!0,alias:"important"},string:{pattern:o(i),lookbehind:!0,greedy:!0},number:{pattern:o(/[+-]?(?:0x[\da-f]+|0o[0-7]+|(?:\d+(?:\.\d*)?|\.\d+)(?:e[+-]?\d+)?|\.inf|\.nan)/.source,"i"),lookbehind:!0},tag:r,important:t,punctuation:/---|[:[\]{}\-,|>?]|\.\.\./},e.languages.yml=e.languages.yaml}(a),function(e){var t=/(?:\\.|[^\\\n\r]|(?:\n|\r\n?)(?![\r\n]))/.source;function r(e){return e=e.replace(//g,(function(){return t})),RegExp(/((?:^|[^\\])(?:\\{2})*)/.source+"(?:"+e+")")}var n=/(?:\\.|``(?:[^`\r\n]|`(?!`))+``|`[^`\r\n]+`|[^\\|\r\n`])+/.source,a=/\|?__(?:\|__)+\|?(?:(?:\n|\r\n?)|(?![\s\S]))/.source.replace(/__/g,(function(){return n})),i=/\|?[ \t]*:?-{3,}:?[ \t]*(?:\|[ \t]*:?-{3,}:?[ \t]*)+\|?(?:\n|\r\n?)/.source;e.languages.markdown=e.languages.extend("markup",{}),e.languages.insertBefore("markdown","prolog",{"front-matter-block":{pattern:/(^(?:\s*[\r\n])?)---(?!.)[\s\S]*?[\r\n]---(?!.)/,lookbehind:!0,greedy:!0,inside:{punctuation:/^---|---$/,"front-matter":{pattern:/\S+(?:\s+\S+)*/,alias:["yaml","language-yaml"],inside:e.languages.yaml}}},blockquote:{pattern:/^>(?:[\t ]*>)*/m,alias:"punctuation"},table:{pattern:RegExp("^"+a+i+"(?:"+a+")*","m"),inside:{"table-data-rows":{pattern:RegExp("^("+a+i+")(?:"+a+")*$"),lookbehind:!0,inside:{"table-data":{pattern:RegExp(n),inside:e.languages.markdown},punctuation:/\|/}},"table-line":{pattern:RegExp("^("+a+")"+i+"$"),lookbehind:!0,inside:{punctuation:/\||:?-{3,}:?/}},"table-header-row":{pattern:RegExp("^"+a+"$"),inside:{"table-header":{pattern:RegExp(n),alias:"important",inside:e.languages.markdown},punctuation:/\|/}}}},code:[{pattern:/((?:^|\n)[ \t]*\n|(?:^|\r\n?)[ \t]*\r\n?)(?: {4}|\t).+(?:(?:\n|\r\n?)(?: {4}|\t).+)*/,lookbehind:!0,alias:"keyword"},{pattern:/^```[\s\S]*?^```$/m,greedy:!0,inside:{"code-block":{pattern:/^(```.*(?:\n|\r\n?))[\s\S]+?(?=(?:\n|\r\n?)^```$)/m,lookbehind:!0},"code-language":{pattern:/^(```).+/,lookbehind:!0},punctuation:/```/}}],title:[{pattern:/\S.*(?:\n|\r\n?)(?:==+|--+)(?=[ \t]*$)/m,alias:"important",inside:{punctuation:/==+$|--+$/}},{pattern:/(^\s*)#.+/m,lookbehind:!0,alias:"important",inside:{punctuation:/^#+|#+$/}}],hr:{pattern:/(^\s*)([*-])(?:[\t ]*\2){2,}(?=\s*$)/m,lookbehind:!0,alias:"punctuation"},list:{pattern:/(^\s*)(?:[*+-]|\d+\.)(?=[\t ].)/m,lookbehind:!0,alias:"punctuation"},"url-reference":{pattern:/!?\[[^\]]+\]:[\t ]+(?:\S+|<(?:\\.|[^>\\])+>)(?:[\t ]+(?:"(?:\\.|[^"\\])*"|'(?:\\.|[^'\\])*'|\((?:\\.|[^)\\])*\)))?/,inside:{variable:{pattern:/^(!?\[)[^\]]+/,lookbehind:!0},string:/(?:"(?:\\.|[^"\\])*"|'(?:\\.|[^'\\])*'|\((?:\\.|[^)\\])*\))$/,punctuation:/^[\[\]!:]|[<>]/},alias:"url"},bold:{pattern:r(/\b__(?:(?!_)|_(?:(?!_))+_)+__\b|\*\*(?:(?!\*)|\*(?:(?!\*))+\*)+\*\*/.source),lookbehind:!0,greedy:!0,inside:{content:{pattern:/(^..)[\s\S]+(?=..$)/,lookbehind:!0,inside:{}},punctuation:/\*\*|__/}},italic:{pattern:r(/\b_(?:(?!_)|__(?:(?!_))+__)+_\b|\*(?:(?!\*)|\*\*(?:(?!\*))+\*\*)+\*/.source),lookbehind:!0,greedy:!0,inside:{content:{pattern:/(^.)[\s\S]+(?=.$)/,lookbehind:!0,inside:{}},punctuation:/[*_]/}},strike:{pattern:r(/(~~?)(?:(?!~))+\2/.source),lookbehind:!0,greedy:!0,inside:{content:{pattern:/(^~~?)[\s\S]+(?=\1$)/,lookbehind:!0,inside:{}},punctuation:/~~?/}},"code-snippet":{pattern:/(^|[^\\`])(?:``[^`\r\n]+(?:`[^`\r\n]+)*``(?!`)|`[^`\r\n]+`(?!`))/,lookbehind:!0,greedy:!0,alias:["code","keyword"]},url:{pattern:r(/!?\[(?:(?!\]))+\](?:\([^\s)]+(?:[\t ]+"(?:\\.|[^"\\])*")?\)|[ \t]?\[(?:(?!\]))+\])/.source),lookbehind:!0,greedy:!0,inside:{operator:/^!/,content:{pattern:/(^\[)[^\]]+(?=\])/,lookbehind:!0,inside:{}},variable:{pattern:/(^\][ \t]?\[)[^\]]+(?=\]$)/,lookbehind:!0},url:{pattern:/(^\]\()[^\s)]+/,lookbehind:!0},string:{pattern:/(^[ \t]+)"(?:\\.|[^"\\])*"(?=\)$)/,lookbehind:!0}}}}),["url","bold","italic","strike"].forEach((function(t){["url","bold","italic","strike","code-snippet"].forEach((function(r){t!==r&&(e.languages.markdown[t].inside.content.inside[r]=e.languages.markdown[r])}))})),e.hooks.add("after-tokenize",(function(e){"markdown"!==e.language&&"md"!==e.language||function e(t){if(t&&"string"!=typeof t)for(var r=0,n=t.length;r",quot:'"'},c=String.fromCodePoint||String.fromCharCode;e.languages.md=e.languages.markdown}(a),a.languages.graphql={comment:/#.*/,description:{pattern:/(?:"""(?:[^"]|(?!""")")*"""|"(?:\\.|[^\\"\r\n])*")(?=\s*[a-z_])/i,greedy:!0,alias:"string",inside:{"language-markdown":{pattern:/(^"(?:"")?)(?!\1)[\s\S]+(?=\1$)/,lookbehind:!0,inside:a.languages.markdown}}},string:{pattern:/"""(?:[^"]|(?!""")")*"""|"(?:\\.|[^\\"\r\n])*"/,greedy:!0},number:/(?:\B-|\b)\d+(?:\.\d+)?(?:e[+-]?\d+)?\b/i,boolean:/\b(?:false|true)\b/,variable:/\$[a-z_]\w*/i,directive:{pattern:/@[a-z_]\w*/i,alias:"function"},"attr-name":{pattern:/\b[a-z_]\w*(?=\s*(?:\((?:[^()"]|"(?:\\.|[^\\"\r\n])*")*\))?:)/i,greedy:!0},"atom-input":{pattern:/\b[A-Z]\w*Input\b/,alias:"class-name"},scalar:/\b(?:Boolean|Float|ID|Int|String)\b/,constant:/\b[A-Z][A-Z_\d]*\b/,"class-name":{pattern:/(\b(?:enum|implements|interface|on|scalar|type|union)\s+|&\s*|:\s*|\[)[A-Z_]\w*/,lookbehind:!0},fragment:{pattern:/(\bfragment\s+|\.{3}\s*(?!on\b))[a-zA-Z_]\w*/,lookbehind:!0,alias:"function"},"definition-mutation":{pattern:/(\bmutation\s+)[a-zA-Z_]\w*/,lookbehind:!0,alias:"function"},"definition-query":{pattern:/(\bquery\s+)[a-zA-Z_]\w*/,lookbehind:!0,alias:"function"},keyword:/\b(?:directive|enum|extend|fragment|implements|input|interface|mutation|on|query|repeatable|scalar|schema|subscription|type|union)\b/,operator:/[!=|&]|\.{3}/,"property-query":/\w+(?=\s*\()/,object:/\w+(?=\s*\{)/,punctuation:/[!(){}\[\]:=,]/,property:/\w+/},a.hooks.add("after-tokenize",(function(e){if("graphql"===e.language)for(var t=e.tokens.filter((function(e){return"string"!=typeof e&&"comment"!==e.type&&"scalar"!==e.type})),r=0;r0)){var s=f(/^\{$/,/^\}$/);if(-1===s)continue;for(var c=r;c=0&&m(l,"variable-input")}}}}function u(e){return t[r+e]}function d(e,t){t=t||0;for(var r=0;r?|<|>)?|>[>=]?|\b(?:AND|BETWEEN|DIV|ILIKE|IN|IS|LIKE|NOT|OR|REGEXP|RLIKE|SOUNDS LIKE|XOR)\b/i,punctuation:/[;[\]()`,.]/},function(e){var t=e.languages.javascript["template-string"],r=t.pattern.source,n=t.inside.interpolation,a=n.inside["interpolation-punctuation"],i=n.pattern.source;function o(t,n){if(e.languages[t])return{pattern:RegExp("((?:"+n+")\\s*)"+r),lookbehind:!0,greedy:!0,inside:{"template-punctuation":{pattern:/^`|`$/,alias:"string"},"embedded-code":{pattern:/[\s\S]+/,alias:t}}}}function s(e,t){return"___"+t.toUpperCase()+"_"+e+"___"}function c(t,r,n){var a={code:t,grammar:r,language:n};return e.hooks.run("before-tokenize",a),a.tokens=e.tokenize(a.code,a.grammar),e.hooks.run("after-tokenize",a),a.tokens}function l(t){var r={};r["interpolation-punctuation"]=a;var i=e.tokenize(t,r);if(3===i.length){var o=[1,1];o.push.apply(o,c(i[1],e.languages.javascript,"javascript")),i.splice.apply(i,o)}return new e.Token("interpolation",i,n.alias,t)}function u(t,r,n){var a=e.tokenize(t,{interpolation:{pattern:RegExp(i),lookbehind:!0}}),o=0,u={},d=c(a.map((function(e){if("string"==typeof e)return e;for(var r,a=e.content;-1!==t.indexOf(r=s(o++,n)););return u[r]=a,r})).join(""),r,n),f=Object.keys(u);return o=0,function e(t){for(var r=0;r=f.length)return;var n=t[r];if("string"==typeof n||"string"==typeof n.content){var a=f[o],i="string"==typeof n?n:n.content,s=i.indexOf(a);if(-1!==s){++o;var c=i.substring(0,s),d=l(u[a]),m=i.substring(s+a.length),p=[];if(c&&p.push(c),p.push(d),m){var b=[m];e(b),p.push.apply(p,b)}"string"==typeof n?(t.splice.apply(t,[r,1].concat(p)),r+=p.length-1):n.content=p}}else{var g=n.content;Array.isArray(g)?e(g):e([g])}}}(d),new e.Token(n,d,"language-"+n,t)}e.languages.javascript["template-string"]=[o("css",/\b(?:styled(?:\([^)]*\))?(?:\s*\.\s*\w+(?:\([^)]*\))*)*|css(?:\s*\.\s*(?:global|resolve))?|createGlobalStyle|keyframes)/.source),o("html",/\bhtml|\.\s*(?:inner|outer)HTML\s*\+?=/.source),o("svg",/\bsvg/.source),o("markdown",/\b(?:markdown|md)/.source),o("graphql",/\b(?:gql|graphql(?:\s*\.\s*experimental)?)/.source),o("sql",/\bsql/.source),t].filter(Boolean);var d={javascript:!0,js:!0,typescript:!0,ts:!0,jsx:!0,tsx:!0};function f(e){return"string"==typeof e?e:Array.isArray(e)?e.map(f).join(""):f(e.content)}e.hooks.add("after-tokenize",(function(t){t.language in d&&function t(r){for(var n=0,a=r.length;n]|<(?:[^<>]|<[^<>]*>)*>)*>)?/,lookbehind:!0,greedy:!0,inside:null},builtin:/\b(?:Array|Function|Promise|any|boolean|console|never|number|string|symbol|unknown)\b/}),e.languages.typescript.keyword.push(/\b(?:abstract|declare|is|keyof|readonly|require)\b/,/\b(?:asserts|infer|interface|module|namespace|type)\b(?=\s*(?:[{_$a-zA-Z\xA0-\uFFFF]|$))/,/\btype\b(?=\s*(?:[\{*]|$))/),delete e.languages.typescript.parameter,delete e.languages.typescript["literal-property"];var t=e.languages.extend("typescript",{});delete t["class-name"],e.languages.typescript["class-name"].inside=t,e.languages.insertBefore("typescript","function",{decorator:{pattern:/@[$\w\xA0-\uFFFF]+/,inside:{at:{pattern:/^@/,alias:"operator"},function:/^[\s\S]+/}},"generic-function":{pattern:/#?(?!\s)[_$a-zA-Z\xA0-\uFFFF](?:(?!\s)[$\w\xA0-\uFFFF])*\s*<(?:[^<>]|<(?:[^<>]|<[^<>]*>)*>)*>(?=\s*\()/,greedy:!0,inside:{function:/^#?(?!\s)[_$a-zA-Z\xA0-\uFFFF](?:(?!\s)[$\w\xA0-\uFFFF])*/,generic:{pattern:/<[\s\S]+/,alias:"class-name",inside:t}}}}),e.languages.ts=e.languages.typescript}(a),function(e){function t(e,t){return RegExp(e.replace(//g,(function(){return/(?!\s)[_$a-zA-Z\xA0-\uFFFF](?:(?!\s)[$\w\xA0-\uFFFF])*/.source})),t)}e.languages.insertBefore("javascript","function-variable",{"method-variable":{pattern:RegExp("(\\.\\s*)"+e.languages.javascript["function-variable"].pattern.source),lookbehind:!0,alias:["function-variable","method","function","property-access"]}}),e.languages.insertBefore("javascript","function",{method:{pattern:RegExp("(\\.\\s*)"+e.languages.javascript.function.source),lookbehind:!0,alias:["function","property-access"]}}),e.languages.insertBefore("javascript","constant",{"known-class-name":[{pattern:/\b(?:(?:Float(?:32|64)|(?:Int|Uint)(?:8|16|32)|Uint8Clamped)?Array|ArrayBuffer|BigInt|Boolean|DataView|Date|Error|Function|Intl|JSON|(?:Weak)?(?:Map|Set)|Math|Number|Object|Promise|Proxy|Reflect|RegExp|String|Symbol|WebAssembly)\b/,alias:"class-name"},{pattern:/\b(?:[A-Z]\w*)Error\b/,alias:"class-name"}]}),e.languages.insertBefore("javascript","keyword",{imports:{pattern:t(/(\bimport\b\s*)(?:(?:\s*,\s*(?:\*\s*as\s+|\{[^{}]*\}))?|\*\s*as\s+|\{[^{}]*\})(?=\s*\bfrom\b)/.source),lookbehind:!0,inside:e.languages.javascript},exports:{pattern:t(/(\bexport\b\s*)(?:\*(?:\s*as\s+)?(?=\s*\bfrom\b)|\{[^{}]*\})/.source),lookbehind:!0,inside:e.languages.javascript}}),e.languages.javascript.keyword.unshift({pattern:/\b(?:as|default|export|from|import)\b/,alias:"module"},{pattern:/\b(?:await|break|catch|continue|do|else|finally|for|if|return|switch|throw|try|while|yield)\b/,alias:"control-flow"},{pattern:/\bnull\b/,alias:["null","nil"]},{pattern:/\bundefined\b/,alias:"nil"}),e.languages.insertBefore("javascript","operator",{spread:{pattern:/\.{3}/,alias:"operator"},arrow:{pattern:/=>/,alias:"operator"}}),e.languages.insertBefore("javascript","punctuation",{"property-access":{pattern:t(/(\.\s*)#?/.source),lookbehind:!0},"maybe-class-name":{pattern:/(^|[^$\w\xA0-\uFFFF])[A-Z][$\w\xA0-\uFFFF]+/,lookbehind:!0},dom:{pattern:/\b(?:document|(?:local|session)Storage|location|navigator|performance|window)\b/,alias:"variable"},console:{pattern:/\bconsole(?=\s*\.)/,alias:"class-name"}});for(var r=["function","function-variable","method","method-variable","property-access"],n=0;n*\.{3}(?:[^{}]|)*\})/.source;function i(e,t){return e=e.replace(//g,(function(){return r})).replace(//g,(function(){return n})).replace(//g,(function(){return a})),RegExp(e,t)}a=i(a).source,e.languages.jsx=e.languages.extend("markup",t),e.languages.jsx.tag.pattern=i(/<\/?(?:[\w.:-]+(?:+(?:[\w.:$-]+(?:=(?:"(?:\\[\s\S]|[^\\"])*"|'(?:\\[\s\S]|[^\\'])*'|[^\s{'"/>=]+|))?|))**\/?)?>/.source),e.languages.jsx.tag.inside.tag.pattern=/^<\/?[^\s>\/]*/,e.languages.jsx.tag.inside["attr-value"].pattern=/=(?!\{)(?:"(?:\\[\s\S]|[^\\"])*"|'(?:\\[\s\S]|[^\\'])*'|[^\s'">]+)/,e.languages.jsx.tag.inside.tag.inside["class-name"]=/^[A-Z]\w*(?:\.[A-Z]\w*)*$/,e.languages.jsx.tag.inside.comment=t.comment,e.languages.insertBefore("inside","attr-name",{spread:{pattern:i(//.source),inside:e.languages.jsx}},e.languages.jsx.tag),e.languages.insertBefore("inside","special-attr",{script:{pattern:i(/=/.source),alias:"language-javascript",inside:{"script-punctuation":{pattern:/^=(?=\{)/,alias:"punctuation"},rest:e.languages.jsx}}},e.languages.jsx.tag);var o=function(e){return e?"string"==typeof e?e:"string"==typeof e.content?e.content:e.content.map(o).join(""):""},s=function(t){for(var r=[],n=0;n0&&r[r.length-1].tagName===o(a.content[0].content[1])&&r.pop():"/>"===a.content[a.content.length-1].content||r.push({tagName:o(a.content[0].content[1]),openedBraces:0}):r.length>0&&"punctuation"===a.type&&"{"===a.content?r[r.length-1].openedBraces++:r.length>0&&r[r.length-1].openedBraces>0&&"punctuation"===a.type&&"}"===a.content?r[r.length-1].openedBraces--:i=!0),(i||"string"==typeof a)&&r.length>0&&0===r[r.length-1].openedBraces){var c=o(a);n0&&("string"==typeof t[n-1]||"plain-text"===t[n-1].type)&&(c=o(t[n-1])+c,t.splice(n-1,1),n--),t[n]=new e.Token("plain-text",c,null,c)}a.content&&"string"!=typeof a.content&&s(a.content)}};e.hooks.add("after-tokenize",(function(e){"jsx"!==e.language&&"tsx"!==e.language||s(e.tokens)}))}(a),function(e){e.languages.diff={coord:[/^(?:\*{3}|-{3}|\+{3}).*$/m,/^@@.*@@$/m,/^\d.*$/m]};var t={"deleted-sign":"-","deleted-arrow":"<","inserted-sign":"+","inserted-arrow":">",unchanged:" ",diff:"!"};Object.keys(t).forEach((function(r){var n=t[r],a=[];/^\w+$/.test(r)||a.push(/\w+/.exec(r)[0]),"diff"===r&&a.push("bold"),e.languages.diff[r]={pattern:RegExp("^(?:["+n+"].*(?:\r\n?|\n|(?![\\s\\S])))+","m"),alias:a,inside:{line:{pattern:/(.)(?=[\s\S]).*(?:\r\n?|\n)?/,lookbehind:!0},prefix:{pattern:/[\s\S]/,alias:/\w+/.exec(r)[0]}}}})),Object.defineProperty(e.languages.diff,"PREFIXES",{value:t})}(a),a.languages.git={comment:/^#.*/m,deleted:/^[-\u2013].*/m,inserted:/^\+.*/m,string:/("|')(?:\\.|(?!\1)[^\\\r\n])*\1/,command:{pattern:/^.*\$ git .*$/m,inside:{parameter:/\s--?\w+/}},coord:/^@@.*@@$/m,"commit-sha1":/^commit \w{40}$/m},a.languages.go=a.languages.extend("clike",{string:{pattern:/(^|[^\\])"(?:\\.|[^"\\\r\n])*"|`[^`]*`/,lookbehind:!0,greedy:!0},keyword:/\b(?:break|case|chan|const|continue|default|defer|else|fallthrough|for|func|go(?:to)?|if|import|interface|map|package|range|return|select|struct|switch|type|var)\b/,boolean:/\b(?:_|false|iota|nil|true)\b/,number:[/\b0(?:b[01_]+|o[0-7_]+)i?\b/i,/\b0x(?:[a-f\d_]+(?:\.[a-f\d_]*)?|\.[a-f\d_]+)(?:p[+-]?\d+(?:_\d+)*)?i?(?!\w)/i,/(?:\b\d[\d_]*(?:\.[\d_]*)?|\B\.\d[\d_]*)(?:e[+-]?[\d_]+)?i?(?!\w)/i],operator:/[*\/%^!=]=?|\+[=+]?|-[=-]?|\|[=|]?|&(?:=|&|\^=?)?|>(?:>=?|=)?|<(?:<=?|=|-)?|:=|\.\.\./,builtin:/\b(?:append|bool|byte|cap|close|complex|complex(?:64|128)|copy|delete|error|float(?:32|64)|u?int(?:8|16|32|64)?|imag|len|make|new|panic|print(?:ln)?|real|recover|rune|string|uintptr)\b/}),a.languages.insertBefore("go","string",{char:{pattern:/'(?:\\.|[^'\\\r\n]){0,10}'/,greedy:!0}}),delete a.languages.go["class-name"],function(e){function t(e,t){return"___"+e.toUpperCase()+t+"___"}Object.defineProperties(e.languages["markup-templating"]={},{buildPlaceholders:{value:function(r,n,a,i){if(r.language===n){var o=r.tokenStack=[];r.code=r.code.replace(a,(function(e){if("function"==typeof i&&!i(e))return e;for(var a,s=o.length;-1!==r.code.indexOf(a=t(n,s));)++s;return o[s]=e,a})),r.grammar=e.languages.markup}}},tokenizePlaceholders:{value:function(r,n){if(r.language===n&&r.tokenStack){r.grammar=e.languages[n];var a=0,i=Object.keys(r.tokenStack);!function o(s){for(var c=0;c=i.length);c++){var l=s[c];if("string"==typeof l||l.content&&"string"==typeof l.content){var u=i[a],d=r.tokenStack[u],f="string"==typeof l?l:l.content,m=t(n,u),p=f.indexOf(m);if(p>-1){++a;var b=f.substring(0,p),g=new e.Token(n,e.tokenize(d,r.grammar),"language-"+n,d),h=f.substring(p+m.length),w=[];b&&w.push.apply(w,o([b])),w.push(g),h&&w.push.apply(w,o([h])),"string"==typeof l?s.splice.apply(s,[c,1].concat(w)):l.content=w}}else l.content&&o(l.content)}return s}(r.tokens)}}}})}(a),function(e){e.languages.handlebars={comment:/\{\{![\s\S]*?\}\}/,delimiter:{pattern:/^\{\{\{?|\}\}\}?$/,alias:"punctuation"},string:/(["'])(?:\\.|(?!\1)[^\\\r\n])*\1/,number:/\b0x[\dA-Fa-f]+\b|(?:\b\d+(?:\.\d*)?|\B\.\d+)(?:[Ee][+-]?\d+)?/,boolean:/\b(?:false|true)\b/,block:{pattern:/^(\s*(?:~\s*)?)[#\/]\S+?(?=\s*(?:~\s*)?$|\s)/,lookbehind:!0,alias:"keyword"},brackets:{pattern:/\[[^\]]+\]/,inside:{punctuation:/\[|\]/,variable:/[\s\S]+/}},punctuation:/[!"#%&':()*+,.\/;<=>@\[\\\]^`{|}~]/,variable:/[^!"#%&'()*+,\/;<=>@\[\\\]^`{|}~\s]+/},e.hooks.add("before-tokenize",(function(t){e.languages["markup-templating"].buildPlaceholders(t,"handlebars",/\{\{\{[\s\S]+?\}\}\}|\{\{[\s\S]+?\}\}/g)})),e.hooks.add("after-tokenize",(function(t){e.languages["markup-templating"].tokenizePlaceholders(t,"handlebars")})),e.languages.hbs=e.languages.handlebars}(a),a.languages.json={property:{pattern:/(^|[^\\])"(?:\\.|[^\\"\r\n])*"(?=\s*:)/,lookbehind:!0,greedy:!0},string:{pattern:/(^|[^\\])"(?:\\.|[^\\"\r\n])*"(?!\s*:)/,lookbehind:!0,greedy:!0},comment:{pattern:/\/\/.*|\/\*[\s\S]*?(?:\*\/|$)/,greedy:!0},number:/-?\b\d+(?:\.\d+)?(?:e[+-]?\d+)?\b/i,punctuation:/[{}[\],]/,operator:/:/,boolean:/\b(?:false|true)\b/,null:{pattern:/\bnull\b/,alias:"keyword"}},a.languages.webmanifest=a.languages.json,a.languages.less=a.languages.extend("css",{comment:[/\/\*[\s\S]*?\*\//,{pattern:/(^|[^\\])\/\/.*/,lookbehind:!0}],atrule:{pattern:/@[\w-](?:\((?:[^(){}]|\([^(){}]*\))*\)|[^(){};\s]|\s+(?!\s))*?(?=\s*\{)/,inside:{punctuation:/[:()]/}},selector:{pattern:/(?:@\{[\w-]+\}|[^{};\s@])(?:@\{[\w-]+\}|\((?:[^(){}]|\([^(){}]*\))*\)|[^(){};@\s]|\s+(?!\s))*?(?=\s*\{)/,inside:{variable:/@+[\w-]+/}},property:/(?:@\{[\w-]+\}|[\w-])+(?:\+_?)?(?=\s*:)/,operator:/[+\-*\/]/}),a.languages.insertBefore("less","property",{variable:[{pattern:/@[\w-]+\s*:/,inside:{punctuation:/:/}},/@@?[\w-]+/],"mixin-usage":{pattern:/([{;]\s*)[.#](?!\d)[\w-].*?(?=[(;])/,lookbehind:!0,alias:"function"}}),a.languages.makefile={comment:{pattern:/(^|[^\\])#(?:\\(?:\r\n|[\s\S])|[^\\\r\n])*/,lookbehind:!0},string:{pattern:/(["'])(?:\\(?:\r\n|[\s\S])|(?!\1)[^\\\r\n])*\1/,greedy:!0},"builtin-target":{pattern:/\.[A-Z][^:#=\s]+(?=\s*:(?!=))/,alias:"builtin"},target:{pattern:/^(?:[^:=\s]|[ \t]+(?![\s:]))+(?=\s*:(?!=))/m,alias:"symbol",inside:{variable:/\$+(?:(?!\$)[^(){}:#=\s]+|(?=[({]))/}},variable:/\$+(?:(?!\$)[^(){}:#=\s]+|\([@*%<^+?][DF]\)|(?=[({]))/,keyword:/-include\b|\b(?:define|else|endef|endif|export|ifn?def|ifn?eq|include|override|private|sinclude|undefine|unexport|vpath)\b/,function:{pattern:/(\()(?:abspath|addsuffix|and|basename|call|dir|error|eval|file|filter(?:-out)?|findstring|firstword|flavor|foreach|guile|if|info|join|lastword|load|notdir|or|origin|patsubst|realpath|shell|sort|strip|subst|suffix|value|warning|wildcard|word(?:list|s)?)(?=[ \t])/,lookbehind:!0},operator:/(?:::|[?:+!])?=|[|@]/,punctuation:/[:;(){}]/},a.languages.objectivec=a.languages.extend("c",{string:{pattern:/@?"(?:\\(?:\r\n|[\s\S])|[^"\\\r\n])*"/,greedy:!0},keyword:/\b(?:asm|auto|break|case|char|const|continue|default|do|double|else|enum|extern|float|for|goto|if|in|inline|int|long|register|return|self|short|signed|sizeof|static|struct|super|switch|typedef|typeof|union|unsigned|void|volatile|while)\b|(?:@interface|@end|@implementation|@protocol|@class|@public|@protected|@private|@property|@try|@catch|@finally|@throw|@synthesize|@dynamic|@selector)\b/,operator:/-[->]?|\+\+?|!=?|<>?=?|==?|&&?|\|\|?|[~^%?*\/@]/}),delete a.languages.objectivec["class-name"],a.languages.objc=a.languages.objectivec,a.languages.ocaml={comment:{pattern:/\(\*[\s\S]*?\*\)/,greedy:!0},char:{pattern:/'(?:[^\\\r\n']|\\(?:.|[ox]?[0-9a-f]{1,3}))'/i,greedy:!0},string:[{pattern:/"(?:\\(?:[\s\S]|\r\n)|[^\\\r\n"])*"/,greedy:!0},{pattern:/\{([a-z_]*)\|[\s\S]*?\|\1\}/,greedy:!0}],number:[/\b(?:0b[01][01_]*|0o[0-7][0-7_]*)\b/i,/\b0x[a-f0-9][a-f0-9_]*(?:\.[a-f0-9_]*)?(?:p[+-]?\d[\d_]*)?(?!\w)/i,/\b\d[\d_]*(?:\.[\d_]*)?(?:e[+-]?\d[\d_]*)?(?!\w)/i],directive:{pattern:/\B#\w+/,alias:"property"},label:{pattern:/\B~\w+/,alias:"property"},"type-variable":{pattern:/\B'\w+/,alias:"function"},variant:{pattern:/`\w+/,alias:"symbol"},keyword:/\b(?:as|assert|begin|class|constraint|do|done|downto|else|end|exception|external|for|fun|function|functor|if|in|include|inherit|initializer|lazy|let|match|method|module|mutable|new|nonrec|object|of|open|private|rec|sig|struct|then|to|try|type|val|value|virtual|when|where|while|with)\b/,boolean:/\b(?:false|true)\b/,"operator-like-punctuation":{pattern:/\[[<>|]|[>|]\]|\{<|>\}/,alias:"punctuation"},operator:/\.[.~]|:[=>]|[=<>@^|&+\-*\/$%!?~][!$%&*+\-.\/:<=>?@^|~]*|\b(?:and|asr|land|lor|lsl|lsr|lxor|mod|or)\b/,punctuation:/;;|::|[(){}\[\].,:;#]|\b_\b/},a.languages.python={comment:{pattern:/(^|[^\\])#.*/,lookbehind:!0,greedy:!0},"string-interpolation":{pattern:/(?:f|fr|rf)(?:("""|''')[\s\S]*?\1|("|')(?:\\.|(?!\2)[^\\\r\n])*\2)/i,greedy:!0,inside:{interpolation:{pattern:/((?:^|[^{])(?:\{\{)*)\{(?!\{)(?:[^{}]|\{(?!\{)(?:[^{}]|\{(?!\{)(?:[^{}])+\})+\})+\}/,lookbehind:!0,inside:{"format-spec":{pattern:/(:)[^:(){}]+(?=\}$)/,lookbehind:!0},"conversion-option":{pattern:/![sra](?=[:}]$)/,alias:"punctuation"},rest:null}},string:/[\s\S]+/}},"triple-quoted-string":{pattern:/(?:[rub]|br|rb)?("""|''')[\s\S]*?\1/i,greedy:!0,alias:"string"},string:{pattern:/(?:[rub]|br|rb)?("|')(?:\\.|(?!\1)[^\\\r\n])*\1/i,greedy:!0},function:{pattern:/((?:^|\s)def[ \t]+)[a-zA-Z_]\w*(?=\s*\()/g,lookbehind:!0},"class-name":{pattern:/(\bclass\s+)\w+/i,lookbehind:!0},decorator:{pattern:/(^[\t ]*)@\w+(?:\.\w+)*/m,lookbehind:!0,alias:["annotation","punctuation"],inside:{punctuation:/\./}},keyword:/\b(?:_(?=\s*:)|and|as|assert|async|await|break|case|class|continue|def|del|elif|else|except|exec|finally|for|from|global|if|import|in|is|lambda|match|nonlocal|not|or|pass|print|raise|return|try|while|with|yield)\b/,builtin:/\b(?:__import__|abs|all|any|apply|ascii|basestring|bin|bool|buffer|bytearray|bytes|callable|chr|classmethod|cmp|coerce|compile|complex|delattr|dict|dir|divmod|enumerate|eval|execfile|file|filter|float|format|frozenset|getattr|globals|hasattr|hash|help|hex|id|input|int|intern|isinstance|issubclass|iter|len|list|locals|long|map|max|memoryview|min|next|object|oct|open|ord|pow|property|range|raw_input|reduce|reload|repr|reversed|round|set|setattr|slice|sorted|staticmethod|str|sum|super|tuple|type|unichr|unicode|vars|xrange|zip)\b/,boolean:/\b(?:False|None|True)\b/,number:/\b0(?:b(?:_?[01])+|o(?:_?[0-7])+|x(?:_?[a-f0-9])+)\b|(?:\b\d+(?:_\d+)*(?:\.(?:\d+(?:_\d+)*)?)?|\B\.\d+(?:_\d+)*)(?:e[+-]?\d+(?:_\d+)*)?j?(?!\w)/i,operator:/[-+%=]=?|!=|:=|\*\*?=?|\/\/?=?|<[<=>]?|>[=>]?|[&|^~]/,punctuation:/[{}[\];(),.:]/},a.languages.python["string-interpolation"].inside.interpolation.inside.rest=a.languages.python,a.languages.py=a.languages.python,a.languages.reason=a.languages.extend("clike",{string:{pattern:/"(?:\\(?:\r\n|[\s\S])|[^\\\r\n"])*"/,greedy:!0},"class-name":/\b[A-Z]\w*/,keyword:/\b(?:and|as|assert|begin|class|constraint|do|done|downto|else|end|exception|external|for|fun|function|functor|if|in|include|inherit|initializer|lazy|let|method|module|mutable|new|nonrec|object|of|open|or|private|rec|sig|struct|switch|then|to|try|type|val|virtual|when|while|with)\b/,operator:/\.{3}|:[:=]|\|>|->|=(?:==?|>)?|<=?|>=?|[|^?'#!~`]|[+\-*\/]\.?|\b(?:asr|land|lor|lsl|lsr|lxor|mod)\b/}),a.languages.insertBefore("reason","class-name",{char:{pattern:/'(?:\\x[\da-f]{2}|\\o[0-3][0-7][0-7]|\\\d{3}|\\.|[^'\\\r\n])'/,greedy:!0},constructor:/\b[A-Z]\w*\b(?!\s*\.)/,label:{pattern:/\b[a-z]\w*(?=::)/,alias:"symbol"}}),delete a.languages.reason.function,function(e){e.languages.sass=e.languages.extend("css",{comment:{pattern:/^([ \t]*)\/[\/*].*(?:(?:\r?\n|\r)\1[ \t].+)*/m,lookbehind:!0,greedy:!0}}),e.languages.insertBefore("sass","atrule",{"atrule-line":{pattern:/^(?:[ \t]*)[@+=].+/m,greedy:!0,inside:{atrule:/(?:@[\w-]+|[+=])/}}}),delete e.languages.sass.atrule;var t=/\$[-\w]+|#\{\$[-\w]+\}/,r=[/[+*\/%]|[=!]=|<=?|>=?|\b(?:and|not|or)\b/,{pattern:/(\s)-(?=\s)/,lookbehind:!0}];e.languages.insertBefore("sass","property",{"variable-line":{pattern:/^[ \t]*\$.+/m,greedy:!0,inside:{punctuation:/:/,variable:t,operator:r}},"property-line":{pattern:/^[ \t]*(?:[^:\s]+ *:.*|:[^:\s].*)/m,greedy:!0,inside:{property:[/[^:\s]+(?=\s*:)/,{pattern:/(:)[^:\s]+/,lookbehind:!0}],punctuation:/:/,variable:t,operator:r,important:e.languages.sass.important}}}),delete e.languages.sass.property,delete e.languages.sass.important,e.languages.insertBefore("sass","punctuation",{selector:{pattern:/^([ \t]*)\S(?:,[^,\r\n]+|[^,\r\n]*)(?:,[^,\r\n]+)*(?:,(?:\r?\n|\r)\1[ \t]+\S(?:,[^,\r\n]+|[^,\r\n]*)(?:,[^,\r\n]+)*)*/m,lookbehind:!0,greedy:!0}})}(a),a.languages.scss=a.languages.extend("css",{comment:{pattern:/(^|[^\\])(?:\/\*[\s\S]*?\*\/|\/\/.*)/,lookbehind:!0},atrule:{pattern:/@[\w-](?:\([^()]+\)|[^()\s]|\s+(?!\s))*?(?=\s+[{;])/,inside:{rule:/@[\w-]+/}},url:/(?:[-a-z]+-)?url(?=\()/i,selector:{pattern:/(?=\S)[^@;{}()]?(?:[^@;{}()\s]|\s+(?!\s)|#\{\$[-\w]+\})+(?=\s*\{(?:\}|\s|[^}][^:{}]*[:{][^}]))/,inside:{parent:{pattern:/&/,alias:"important"},placeholder:/%[-\w]+/,variable:/\$[-\w]+|#\{\$[-\w]+\}/}},property:{pattern:/(?:[-\w]|\$[-\w]|#\{\$[-\w]+\})+(?=\s*:)/,inside:{variable:/\$[-\w]+|#\{\$[-\w]+\}/}}}),a.languages.insertBefore("scss","atrule",{keyword:[/@(?:content|debug|each|else(?: if)?|extend|for|forward|function|if|import|include|mixin|return|use|warn|while)\b/i,{pattern:/( )(?:from|through)(?= )/,lookbehind:!0}]}),a.languages.insertBefore("scss","important",{variable:/\$[-\w]+|#\{\$[-\w]+\}/}),a.languages.insertBefore("scss","function",{"module-modifier":{pattern:/\b(?:as|hide|show|with)\b/i,alias:"keyword"},placeholder:{pattern:/%[-\w]+/,alias:"selector"},statement:{pattern:/\B!(?:default|optional)\b/i,alias:"keyword"},boolean:/\b(?:false|true)\b/,null:{pattern:/\bnull\b/,alias:"keyword"},operator:{pattern:/(\s)(?:[-+*\/%]|[=!]=|<=?|>=?|and|not|or)(?=\s)/,lookbehind:!0}}),a.languages.scss.atrule.inside.rest=a.languages.scss,function(e){var t={pattern:/(\b\d+)(?:%|[a-z]+)/,lookbehind:!0},r={pattern:/(^|[^\w.-])-?(?:\d+(?:\.\d+)?|\.\d+)/,lookbehind:!0},n={comment:{pattern:/(^|[^\\])(?:\/\*[\s\S]*?\*\/|\/\/.*)/,lookbehind:!0},url:{pattern:/\burl\((["']?).*?\1\)/i,greedy:!0},string:{pattern:/("|')(?:(?!\1)[^\\\r\n]|\\(?:\r\n|[\s\S]))*\1/,greedy:!0},interpolation:null,func:null,important:/\B!(?:important|optional)\b/i,keyword:{pattern:/(^|\s+)(?:(?:else|for|if|return|unless)(?=\s|$)|@[\w-]+)/,lookbehind:!0},hexcode:/#[\da-f]{3,6}/i,color:[/\b(?:AliceBlue|AntiqueWhite|Aqua|Aquamarine|Azure|Beige|Bisque|Black|BlanchedAlmond|Blue|BlueViolet|Brown|BurlyWood|CadetBlue|Chartreuse|Chocolate|Coral|CornflowerBlue|Cornsilk|Crimson|Cyan|DarkBlue|DarkCyan|DarkGoldenRod|DarkGr[ae]y|DarkGreen|DarkKhaki|DarkMagenta|DarkOliveGreen|DarkOrange|DarkOrchid|DarkRed|DarkSalmon|DarkSeaGreen|DarkSlateBlue|DarkSlateGr[ae]y|DarkTurquoise|DarkViolet|DeepPink|DeepSkyBlue|DimGr[ae]y|DodgerBlue|FireBrick|FloralWhite|ForestGreen|Fuchsia|Gainsboro|GhostWhite|Gold|GoldenRod|Gr[ae]y|Green|GreenYellow|HoneyDew|HotPink|IndianRed|Indigo|Ivory|Khaki|Lavender|LavenderBlush|LawnGreen|LemonChiffon|LightBlue|LightCoral|LightCyan|LightGoldenRodYellow|LightGr[ae]y|LightGreen|LightPink|LightSalmon|LightSeaGreen|LightSkyBlue|LightSlateGr[ae]y|LightSteelBlue|LightYellow|Lime|LimeGreen|Linen|Magenta|Maroon|MediumAquaMarine|MediumBlue|MediumOrchid|MediumPurple|MediumSeaGreen|MediumSlateBlue|MediumSpringGreen|MediumTurquoise|MediumVioletRed|MidnightBlue|MintCream|MistyRose|Moccasin|NavajoWhite|Navy|OldLace|Olive|OliveDrab|Orange|OrangeRed|Orchid|PaleGoldenRod|PaleGreen|PaleTurquoise|PaleVioletRed|PapayaWhip|PeachPuff|Peru|Pink|Plum|PowderBlue|Purple|Red|RosyBrown|RoyalBlue|SaddleBrown|Salmon|SandyBrown|SeaGreen|SeaShell|Sienna|Silver|SkyBlue|SlateBlue|SlateGr[ae]y|Snow|SpringGreen|SteelBlue|Tan|Teal|Thistle|Tomato|Transparent|Turquoise|Violet|Wheat|White|WhiteSmoke|Yellow|YellowGreen)\b/i,{pattern:/\b(?:hsl|rgb)\(\s*\d{1,3}\s*,\s*\d{1,3}%?\s*,\s*\d{1,3}%?\s*\)\B|\b(?:hsl|rgb)a\(\s*\d{1,3}\s*,\s*\d{1,3}%?\s*,\s*\d{1,3}%?\s*,\s*(?:0|0?\.\d+|1)\s*\)\B/i,inside:{unit:t,number:r,function:/[\w-]+(?=\()/,punctuation:/[(),]/}}],entity:/\\[\da-f]{1,8}/i,unit:t,boolean:/\b(?:false|true)\b/,operator:[/~|[+!\/%<>?=]=?|[-:]=|\*[*=]?|\.{2,3}|&&|\|\||\B-\B|\b(?:and|in|is(?: a| defined| not|nt)?|not|or)\b/],number:r,punctuation:/[{}()\[\];:,]/};n.interpolation={pattern:/\{[^\r\n}:]+\}/,alias:"variable",inside:{delimiter:{pattern:/^\{|\}$/,alias:"punctuation"},rest:n}},n.func={pattern:/[\w-]+\([^)]*\).*/,inside:{function:/^[^(]+/,rest:n}},e.languages.stylus={"atrule-declaration":{pattern:/(^[ \t]*)@.+/m,lookbehind:!0,inside:{atrule:/^@[\w-]+/,rest:n}},"variable-declaration":{pattern:/(^[ \t]*)[\w$-]+\s*.?=[ \t]*(?:\{[^{}]*\}|\S.*|$)/m,lookbehind:!0,inside:{variable:/^\S+/,rest:n}},statement:{pattern:/(^[ \t]*)(?:else|for|if|return|unless)[ \t].+/m,lookbehind:!0,inside:{keyword:/^\S+/,rest:n}},"property-declaration":{pattern:/((?:^|\{)([ \t]*))(?:[\w-]|\{[^}\r\n]+\})+(?:\s*:\s*|[ \t]+)(?!\s)[^{\r\n]*(?:;|[^{\r\n,]$(?!(?:\r?\n|\r)(?:\{|\2[ \t])))/m,lookbehind:!0,inside:{property:{pattern:/^[^\s:]+/,inside:{interpolation:n.interpolation}},rest:n}},selector:{pattern:/(^[ \t]*)(?:(?=\S)(?:[^{}\r\n:()]|::?[\w-]+(?:\([^)\r\n]*\)|(?![\w-]))|\{[^}\r\n]+\})+)(?:(?:\r?\n|\r)(?:\1(?:(?=\S)(?:[^{}\r\n:()]|::?[\w-]+(?:\([^)\r\n]*\)|(?![\w-]))|\{[^}\r\n]+\})+)))*(?:,$|\{|(?=(?:\r?\n|\r)(?:\{|\1[ \t])))/m,lookbehind:!0,inside:{interpolation:n.interpolation,comment:n.comment,punctuation:/[{},]/}},func:n.func,string:n.string,comment:{pattern:/(^|[^\\])(?:\/\*[\s\S]*?\*\/|\/\/.*)/,lookbehind:!0,greedy:!0},interpolation:n.interpolation,punctuation:/[{}()\[\];:.]/}}(a),function(e){var t=e.util.clone(e.languages.typescript);e.languages.tsx=e.languages.extend("jsx",t),delete e.languages.tsx.parameter,delete e.languages.tsx["literal-property"];var r=e.languages.tsx.tag;r.pattern=RegExp(/(^|[^\w$]|(?=<\/))/.source+"(?:"+r.pattern.source+")",r.pattern.flags),r.lookbehind=!0}(a),a.languages.wasm={comment:[/\(;[\s\S]*?;\)/,{pattern:/;;.*/,greedy:!0}],string:{pattern:/"(?:\\[\s\S]|[^"\\])*"/,greedy:!0},keyword:[{pattern:/\b(?:align|offset)=/,inside:{operator:/=/}},{pattern:/\b(?:(?:f32|f64|i32|i64)(?:\.(?:abs|add|and|ceil|clz|const|convert_[su]\/i(?:32|64)|copysign|ctz|demote\/f64|div(?:_[su])?|eqz?|extend_[su]\/i32|floor|ge(?:_[su])?|gt(?:_[su])?|le(?:_[su])?|load(?:(?:8|16|32)_[su])?|lt(?:_[su])?|max|min|mul|neg?|nearest|or|popcnt|promote\/f32|reinterpret\/[fi](?:32|64)|rem_[su]|rot[lr]|shl|shr_[su]|sqrt|store(?:8|16|32)?|sub|trunc(?:_[su]\/f(?:32|64))?|wrap\/i64|xor))?|memory\.(?:grow|size))\b/,inside:{punctuation:/\./}},/\b(?:anyfunc|block|br(?:_if|_table)?|call(?:_indirect)?|data|drop|elem|else|end|export|func|get_(?:global|local)|global|if|import|local|loop|memory|module|mut|nop|offset|param|result|return|select|set_(?:global|local)|start|table|tee_local|then|type|unreachable)\b/],variable:/\$[\w!#$%&'*+\-./:<=>?@\\^`|~]+/,number:/[+-]?\b(?:\d(?:_?\d)*(?:\.\d(?:_?\d)*)?(?:[eE][+-]?\d(?:_?\d)*)?|0x[\da-fA-F](?:_?[\da-fA-F])*(?:\.[\da-fA-F](?:_?[\da-fA-D])*)?(?:[pP][+-]?\d(?:_?\d)*)?)\b|\binf\b|\bnan(?::0x[\da-fA-F](?:_?[\da-fA-D])*)?\b/,punctuation:/[()]/};const i=a},29901:e=>{e.exports&&(e.exports={core:{meta:{path:"components/prism-core.js",option:"mandatory"},core:"Core"},themes:{meta:{path:"themes/{id}.css",link:"index.html?theme={id}",exclusive:!0},prism:{title:"Default",option:"default"},"prism-dark":"Dark","prism-funky":"Funky","prism-okaidia":{title:"Okaidia",owner:"ocodia"},"prism-twilight":{title:"Twilight",owner:"remybach"},"prism-coy":{title:"Coy",owner:"tshedor"},"prism-solarizedlight":{title:"Solarized Light",owner:"hectormatos2011 "},"prism-tomorrow":{title:"Tomorrow Night",owner:"Rosey"}},languages:{meta:{path:"components/prism-{id}",noCSS:!0,examplesPath:"examples/prism-{id}",addCheckAll:!0},markup:{title:"Markup",alias:["html","xml","svg","mathml","ssml","atom","rss"],aliasTitles:{html:"HTML",xml:"XML",svg:"SVG",mathml:"MathML",ssml:"SSML",atom:"Atom",rss:"RSS"},option:"default"},css:{title:"CSS",option:"default",modify:"markup"},clike:{title:"C-like",option:"default"},javascript:{title:"JavaScript",require:"clike",modify:"markup",optional:"regex",alias:"js",option:"default"},abap:{title:"ABAP",owner:"dellagustin"},abnf:{title:"ABNF",owner:"RunDevelopment"},actionscript:{title:"ActionScript",require:"javascript",modify:"markup",owner:"Golmote"},ada:{title:"Ada",owner:"Lucretia"},agda:{title:"Agda",owner:"xy-ren"},al:{title:"AL",owner:"RunDevelopment"},antlr4:{title:"ANTLR4",alias:"g4",owner:"RunDevelopment"},apacheconf:{title:"Apache Configuration",owner:"GuiTeK"},apex:{title:"Apex",require:["clike","sql"],owner:"RunDevelopment"},apl:{title:"APL",owner:"ngn"},applescript:{title:"AppleScript",owner:"Golmote"},aql:{title:"AQL",owner:"RunDevelopment"},arduino:{title:"Arduino",require:"cpp",alias:"ino",owner:"dkern"},arff:{title:"ARFF",owner:"Golmote"},armasm:{title:"ARM Assembly",alias:"arm-asm",owner:"RunDevelopment"},arturo:{title:"Arturo",alias:"art",optional:["bash","css","javascript","markup","markdown","sql"],owner:"drkameleon"},asciidoc:{alias:"adoc",title:"AsciiDoc",owner:"Golmote"},aspnet:{title:"ASP.NET (C#)",require:["markup","csharp"],owner:"nauzilus"},asm6502:{title:"6502 Assembly",owner:"kzurawel"},asmatmel:{title:"Atmel AVR Assembly",owner:"cerkit"},autohotkey:{title:"AutoHotkey",owner:"aviaryan"},autoit:{title:"AutoIt",owner:"Golmote"},avisynth:{title:"AviSynth",alias:"avs",owner:"Zinfidel"},"avro-idl":{title:"Avro IDL",alias:"avdl",owner:"RunDevelopment"},awk:{title:"AWK",alias:"gawk",aliasTitles:{gawk:"GAWK"},owner:"RunDevelopment"},bash:{title:"Bash",alias:["sh","shell"],aliasTitles:{sh:"Shell",shell:"Shell"},owner:"zeitgeist87"},basic:{title:"BASIC",owner:"Golmote"},batch:{title:"Batch",owner:"Golmote"},bbcode:{title:"BBcode",alias:"shortcode",aliasTitles:{shortcode:"Shortcode"},owner:"RunDevelopment"},bbj:{title:"BBj",owner:"hyyan"},bicep:{title:"Bicep",owner:"johnnyreilly"},birb:{title:"Birb",require:"clike",owner:"Calamity210"},bison:{title:"Bison",require:"c",owner:"Golmote"},bnf:{title:"BNF",alias:"rbnf",aliasTitles:{rbnf:"RBNF"},owner:"RunDevelopment"},bqn:{title:"BQN",owner:"yewscion"},brainfuck:{title:"Brainfuck",owner:"Golmote"},brightscript:{title:"BrightScript",owner:"RunDevelopment"},bro:{title:"Bro",owner:"wayward710"},bsl:{title:"BSL (1C:Enterprise)",alias:"oscript",aliasTitles:{oscript:"OneScript"},owner:"Diversus23"},c:{title:"C",require:"clike",owner:"zeitgeist87"},csharp:{title:"C#",require:"clike",alias:["cs","dotnet"],owner:"mvalipour"},cpp:{title:"C++",require:"c",owner:"zeitgeist87"},cfscript:{title:"CFScript",require:"clike",alias:"cfc",owner:"mjclemente"},chaiscript:{title:"ChaiScript",require:["clike","cpp"],owner:"RunDevelopment"},cil:{title:"CIL",owner:"sbrl"},cilkc:{title:"Cilk/C",require:"c",alias:"cilk-c",owner:"OpenCilk"},cilkcpp:{title:"Cilk/C++",require:"cpp",alias:["cilk-cpp","cilk"],owner:"OpenCilk"},clojure:{title:"Clojure",owner:"troglotit"},cmake:{title:"CMake",owner:"mjrogozinski"},cobol:{title:"COBOL",owner:"RunDevelopment"},coffeescript:{title:"CoffeeScript",require:"javascript",alias:"coffee",owner:"R-osey"},concurnas:{title:"Concurnas",alias:"conc",owner:"jasontatton"},csp:{title:"Content-Security-Policy",owner:"ScottHelme"},cooklang:{title:"Cooklang",owner:"ahue"},coq:{title:"Coq",owner:"RunDevelopment"},crystal:{title:"Crystal",require:"ruby",owner:"MakeNowJust"},"css-extras":{title:"CSS Extras",require:"css",modify:"css",owner:"milesj"},csv:{title:"CSV",owner:"RunDevelopment"},cue:{title:"CUE",owner:"RunDevelopment"},cypher:{title:"Cypher",owner:"RunDevelopment"},d:{title:"D",require:"clike",owner:"Golmote"},dart:{title:"Dart",require:"clike",owner:"Golmote"},dataweave:{title:"DataWeave",owner:"machaval"},dax:{title:"DAX",owner:"peterbud"},dhall:{title:"Dhall",owner:"RunDevelopment"},diff:{title:"Diff",owner:"uranusjr"},django:{title:"Django/Jinja2",require:"markup-templating",alias:"jinja2",owner:"romanvm"},"dns-zone-file":{title:"DNS zone file",owner:"RunDevelopment",alias:"dns-zone"},docker:{title:"Docker",alias:"dockerfile",owner:"JustinBeckwith"},dot:{title:"DOT (Graphviz)",alias:"gv",optional:"markup",owner:"RunDevelopment"},ebnf:{title:"EBNF",owner:"RunDevelopment"},editorconfig:{title:"EditorConfig",owner:"osipxd"},eiffel:{title:"Eiffel",owner:"Conaclos"},ejs:{title:"EJS",require:["javascript","markup-templating"],owner:"RunDevelopment",alias:"eta",aliasTitles:{eta:"Eta"}},elixir:{title:"Elixir",owner:"Golmote"},elm:{title:"Elm",owner:"zwilias"},etlua:{title:"Embedded Lua templating",require:["lua","markup-templating"],owner:"RunDevelopment"},erb:{title:"ERB",require:["ruby","markup-templating"],owner:"Golmote"},erlang:{title:"Erlang",owner:"Golmote"},"excel-formula":{title:"Excel Formula",alias:["xlsx","xls"],owner:"RunDevelopment"},fsharp:{title:"F#",require:"clike",owner:"simonreynolds7"},factor:{title:"Factor",owner:"catb0t"},false:{title:"False",owner:"edukisto"},"firestore-security-rules":{title:"Firestore security rules",require:"clike",owner:"RunDevelopment"},flow:{title:"Flow",require:"javascript",owner:"Golmote"},fortran:{title:"Fortran",owner:"Golmote"},ftl:{title:"FreeMarker Template Language",require:"markup-templating",owner:"RunDevelopment"},gml:{title:"GameMaker Language",alias:"gamemakerlanguage",require:"clike",owner:"LiarOnce"},gap:{title:"GAP (CAS)",owner:"RunDevelopment"},gcode:{title:"G-code",owner:"RunDevelopment"},gdscript:{title:"GDScript",owner:"RunDevelopment"},gedcom:{title:"GEDCOM",owner:"Golmote"},gettext:{title:"gettext",alias:"po",owner:"RunDevelopment"},gherkin:{title:"Gherkin",owner:"hason"},git:{title:"Git",owner:"lgiraudel"},glsl:{title:"GLSL",require:"c",owner:"Golmote"},gn:{title:"GN",alias:"gni",owner:"RunDevelopment"},"linker-script":{title:"GNU Linker Script",alias:"ld",owner:"RunDevelopment"},go:{title:"Go",require:"clike",owner:"arnehormann"},"go-module":{title:"Go module",alias:"go-mod",owner:"RunDevelopment"},gradle:{title:"Gradle",require:"clike",owner:"zeabdelkhalek-badido18"},graphql:{title:"GraphQL",optional:"markdown",owner:"Golmote"},groovy:{title:"Groovy",require:"clike",owner:"robfletcher"},haml:{title:"Haml",require:"ruby",optional:["css","css-extras","coffeescript","erb","javascript","less","markdown","scss","textile"],owner:"Golmote"},handlebars:{title:"Handlebars",require:"markup-templating",alias:["hbs","mustache"],aliasTitles:{mustache:"Mustache"},owner:"Golmote"},haskell:{title:"Haskell",alias:"hs",owner:"bholst"},haxe:{title:"Haxe",require:"clike",optional:"regex",owner:"Golmote"},hcl:{title:"HCL",owner:"outsideris"},hlsl:{title:"HLSL",require:"c",owner:"RunDevelopment"},hoon:{title:"Hoon",owner:"matildepark"},http:{title:"HTTP",optional:["csp","css","hpkp","hsts","javascript","json","markup","uri"],owner:"danielgtaylor"},hpkp:{title:"HTTP Public-Key-Pins",owner:"ScottHelme"},hsts:{title:"HTTP Strict-Transport-Security",owner:"ScottHelme"},ichigojam:{title:"IchigoJam",owner:"BlueCocoa"},icon:{title:"Icon",owner:"Golmote"},"icu-message-format":{title:"ICU Message Format",owner:"RunDevelopment"},idris:{title:"Idris",alias:"idr",owner:"KeenS",require:"haskell"},ignore:{title:".ignore",owner:"osipxd",alias:["gitignore","hgignore","npmignore"],aliasTitles:{gitignore:".gitignore",hgignore:".hgignore",npmignore:".npmignore"}},inform7:{title:"Inform 7",owner:"Golmote"},ini:{title:"Ini",owner:"aviaryan"},io:{title:"Io",owner:"AlesTsurko"},j:{title:"J",owner:"Golmote"},java:{title:"Java",require:"clike",owner:"sherblot"},javadoc:{title:"JavaDoc",require:["markup","java","javadoclike"],modify:"java",optional:"scala",owner:"RunDevelopment"},javadoclike:{title:"JavaDoc-like",modify:["java","javascript","php"],owner:"RunDevelopment"},javastacktrace:{title:"Java stack trace",owner:"RunDevelopment"},jexl:{title:"Jexl",owner:"czosel"},jolie:{title:"Jolie",require:"clike",owner:"thesave"},jq:{title:"JQ",owner:"RunDevelopment"},jsdoc:{title:"JSDoc",require:["javascript","javadoclike","typescript"],modify:"javascript",optional:["actionscript","coffeescript"],owner:"RunDevelopment"},"js-extras":{title:"JS Extras",require:"javascript",modify:"javascript",optional:["actionscript","coffeescript","flow","n4js","typescript"],owner:"RunDevelopment"},json:{title:"JSON",alias:"webmanifest",aliasTitles:{webmanifest:"Web App Manifest"},owner:"CupOfTea696"},json5:{title:"JSON5",require:"json",owner:"RunDevelopment"},jsonp:{title:"JSONP",require:"json",owner:"RunDevelopment"},jsstacktrace:{title:"JS stack trace",owner:"sbrl"},"js-templates":{title:"JS Templates",require:"javascript",modify:"javascript",optional:["css","css-extras","graphql","markdown","markup","sql"],owner:"RunDevelopment"},julia:{title:"Julia",owner:"cdagnino"},keepalived:{title:"Keepalived Configure",owner:"dev-itsheng"},keyman:{title:"Keyman",owner:"mcdurdin"},kotlin:{title:"Kotlin",alias:["kt","kts"],aliasTitles:{kts:"Kotlin Script"},require:"clike",owner:"Golmote"},kumir:{title:"KuMir (\u041a\u0443\u041c\u0438\u0440)",alias:"kum",owner:"edukisto"},kusto:{title:"Kusto",owner:"RunDevelopment"},latex:{title:"LaTeX",alias:["tex","context"],aliasTitles:{tex:"TeX",context:"ConTeXt"},owner:"japborst"},latte:{title:"Latte",require:["clike","markup-templating","php"],owner:"nette"},less:{title:"Less",require:"css",optional:"css-extras",owner:"Golmote"},lilypond:{title:"LilyPond",require:"scheme",alias:"ly",owner:"RunDevelopment"},liquid:{title:"Liquid",require:"markup-templating",owner:"cinhtau"},lisp:{title:"Lisp",alias:["emacs","elisp","emacs-lisp"],owner:"JuanCaicedo"},livescript:{title:"LiveScript",owner:"Golmote"},llvm:{title:"LLVM IR",owner:"porglezomp"},log:{title:"Log file",optional:"javastacktrace",owner:"RunDevelopment"},lolcode:{title:"LOLCODE",owner:"Golmote"},lua:{title:"Lua",owner:"Golmote"},magma:{title:"Magma (CAS)",owner:"RunDevelopment"},makefile:{title:"Makefile",owner:"Golmote"},markdown:{title:"Markdown",require:"markup",optional:"yaml",alias:"md",owner:"Golmote"},"markup-templating":{title:"Markup templating",require:"markup",owner:"Golmote"},mata:{title:"Mata",owner:"RunDevelopment"},matlab:{title:"MATLAB",owner:"Golmote"},maxscript:{title:"MAXScript",owner:"RunDevelopment"},mel:{title:"MEL",owner:"Golmote"},mermaid:{title:"Mermaid",owner:"RunDevelopment"},metafont:{title:"METAFONT",owner:"LaeriExNihilo"},mizar:{title:"Mizar",owner:"Golmote"},mongodb:{title:"MongoDB",owner:"airs0urce",require:"javascript"},monkey:{title:"Monkey",owner:"Golmote"},moonscript:{title:"MoonScript",alias:"moon",owner:"RunDevelopment"},n1ql:{title:"N1QL",owner:"TMWilds"},n4js:{title:"N4JS",require:"javascript",optional:"jsdoc",alias:"n4jsd",owner:"bsmith-n4"},"nand2tetris-hdl":{title:"Nand To Tetris HDL",owner:"stephanmax"},naniscript:{title:"Naninovel Script",owner:"Elringus",alias:"nani"},nasm:{title:"NASM",owner:"rbmj"},neon:{title:"NEON",owner:"nette"},nevod:{title:"Nevod",owner:"nezaboodka"},nginx:{title:"nginx",owner:"volado"},nim:{title:"Nim",owner:"Golmote"},nix:{title:"Nix",owner:"Golmote"},nsis:{title:"NSIS",owner:"idleberg"},objectivec:{title:"Objective-C",require:"c",alias:"objc",owner:"uranusjr"},ocaml:{title:"OCaml",owner:"Golmote"},odin:{title:"Odin",owner:"edukisto"},opencl:{title:"OpenCL",require:"c",modify:["c","cpp"],owner:"Milania1"},openqasm:{title:"OpenQasm",alias:"qasm",owner:"RunDevelopment"},oz:{title:"Oz",owner:"Golmote"},parigp:{title:"PARI/GP",owner:"Golmote"},parser:{title:"Parser",require:"markup",owner:"Golmote"},pascal:{title:"Pascal",alias:"objectpascal",aliasTitles:{objectpascal:"Object Pascal"},owner:"Golmote"},pascaligo:{title:"Pascaligo",owner:"DefinitelyNotAGoat"},psl:{title:"PATROL Scripting Language",owner:"bertysentry"},pcaxis:{title:"PC-Axis",alias:"px",owner:"RunDevelopment"},peoplecode:{title:"PeopleCode",alias:"pcode",owner:"RunDevelopment"},perl:{title:"Perl",owner:"Golmote"},php:{title:"PHP",require:"markup-templating",owner:"milesj"},phpdoc:{title:"PHPDoc",require:["php","javadoclike"],modify:"php",owner:"RunDevelopment"},"php-extras":{title:"PHP Extras",require:"php",modify:"php",owner:"milesj"},"plant-uml":{title:"PlantUML",alias:"plantuml",owner:"RunDevelopment"},plsql:{title:"PL/SQL",require:"sql",owner:"Golmote"},powerquery:{title:"PowerQuery",alias:["pq","mscript"],owner:"peterbud"},powershell:{title:"PowerShell",owner:"nauzilus"},processing:{title:"Processing",require:"clike",owner:"Golmote"},prolog:{title:"Prolog",owner:"Golmote"},promql:{title:"PromQL",owner:"arendjr"},properties:{title:".properties",owner:"Golmote"},protobuf:{title:"Protocol Buffers",require:"clike",owner:"just-boris"},pug:{title:"Pug",require:["markup","javascript"],optional:["coffeescript","ejs","handlebars","less","livescript","markdown","scss","stylus","twig"],owner:"Golmote"},puppet:{title:"Puppet",owner:"Golmote"},pure:{title:"Pure",optional:["c","cpp","fortran"],owner:"Golmote"},purebasic:{title:"PureBasic",require:"clike",alias:"pbfasm",owner:"HeX0R101"},purescript:{title:"PureScript",require:"haskell",alias:"purs",owner:"sriharshachilakapati"},python:{title:"Python",alias:"py",owner:"multipetros"},qsharp:{title:"Q#",require:"clike",alias:"qs",owner:"fedonman"},q:{title:"Q (kdb+ database)",owner:"Golmote"},qml:{title:"QML",require:"javascript",owner:"RunDevelopment"},qore:{title:"Qore",require:"clike",owner:"temnroegg"},r:{title:"R",owner:"Golmote"},racket:{title:"Racket",require:"scheme",alias:"rkt",owner:"RunDevelopment"},cshtml:{title:"Razor C#",alias:"razor",require:["markup","csharp"],optional:["css","css-extras","javascript","js-extras"],owner:"RunDevelopment"},jsx:{title:"React JSX",require:["markup","javascript"],optional:["jsdoc","js-extras","js-templates"],owner:"vkbansal"},tsx:{title:"React TSX",require:["jsx","typescript"]},reason:{title:"Reason",require:"clike",owner:"Golmote"},regex:{title:"Regex",owner:"RunDevelopment"},rego:{title:"Rego",owner:"JordanSh"},renpy:{title:"Ren'py",alias:"rpy",owner:"HyuchiaDiego"},rescript:{title:"ReScript",alias:"res",owner:"vmarcosp"},rest:{title:"reST (reStructuredText)",owner:"Golmote"},rip:{title:"Rip",owner:"ravinggenius"},roboconf:{title:"Roboconf",owner:"Golmote"},robotframework:{title:"Robot Framework",alias:"robot",owner:"RunDevelopment"},ruby:{title:"Ruby",require:"clike",alias:"rb",owner:"samflores"},rust:{title:"Rust",owner:"Golmote"},sas:{title:"SAS",optional:["groovy","lua","sql"],owner:"Golmote"},sass:{title:"Sass (Sass)",require:"css",optional:"css-extras",owner:"Golmote"},scss:{title:"Sass (SCSS)",require:"css",optional:"css-extras",owner:"MoOx"},scala:{title:"Scala",require:"java",owner:"jozic"},scheme:{title:"Scheme",owner:"bacchus123"},"shell-session":{title:"Shell session",require:"bash",alias:["sh-session","shellsession"],owner:"RunDevelopment"},smali:{title:"Smali",owner:"RunDevelopment"},smalltalk:{title:"Smalltalk",owner:"Golmote"},smarty:{title:"Smarty",require:"markup-templating",optional:"php",owner:"Golmote"},sml:{title:"SML",alias:"smlnj",aliasTitles:{smlnj:"SML/NJ"},owner:"RunDevelopment"},solidity:{title:"Solidity (Ethereum)",alias:"sol",require:"clike",owner:"glachaud"},"solution-file":{title:"Solution file",alias:"sln",owner:"RunDevelopment"},soy:{title:"Soy (Closure Template)",require:"markup-templating",owner:"Golmote"},sparql:{title:"SPARQL",require:"turtle",owner:"Triply-Dev",alias:"rq"},"splunk-spl":{title:"Splunk SPL",owner:"RunDevelopment"},sqf:{title:"SQF: Status Quo Function (Arma 3)",require:"clike",owner:"RunDevelopment"},sql:{title:"SQL",owner:"multipetros"},squirrel:{title:"Squirrel",require:"clike",owner:"RunDevelopment"},stan:{title:"Stan",owner:"RunDevelopment"},stata:{title:"Stata Ado",require:["mata","java","python"],owner:"RunDevelopment"},iecst:{title:"Structured Text (IEC 61131-3)",owner:"serhioromano"},stylus:{title:"Stylus",owner:"vkbansal"},supercollider:{title:"SuperCollider",alias:"sclang",owner:"RunDevelopment"},swift:{title:"Swift",owner:"chrischares"},systemd:{title:"Systemd configuration file",owner:"RunDevelopment"},"t4-templating":{title:"T4 templating",owner:"RunDevelopment"},"t4-cs":{title:"T4 Text Templates (C#)",require:["t4-templating","csharp"],alias:"t4",owner:"RunDevelopment"},"t4-vb":{title:"T4 Text Templates (VB)",require:["t4-templating","vbnet"],owner:"RunDevelopment"},tap:{title:"TAP",owner:"isaacs",require:"yaml"},tcl:{title:"Tcl",owner:"PeterChaplin"},tt2:{title:"Template Toolkit 2",require:["clike","markup-templating"],owner:"gflohr"},textile:{title:"Textile",require:"markup",optional:"css",owner:"Golmote"},toml:{title:"TOML",owner:"RunDevelopment"},tremor:{title:"Tremor",alias:["trickle","troy"],owner:"darach",aliasTitles:{trickle:"trickle",troy:"troy"}},turtle:{title:"Turtle",alias:"trig",aliasTitles:{trig:"TriG"},owner:"jakubklimek"},twig:{title:"Twig",require:"markup-templating",owner:"brandonkelly"},typescript:{title:"TypeScript",require:"javascript",optional:"js-templates",alias:"ts",owner:"vkbansal"},typoscript:{title:"TypoScript",alias:"tsconfig",aliasTitles:{tsconfig:"TSConfig"},owner:"dkern"},unrealscript:{title:"UnrealScript",alias:["uscript","uc"],owner:"RunDevelopment"},uorazor:{title:"UO Razor Script",owner:"jaseowns"},uri:{title:"URI",alias:"url",aliasTitles:{url:"URL"},owner:"RunDevelopment"},v:{title:"V",require:"clike",owner:"taggon"},vala:{title:"Vala",require:"clike",optional:"regex",owner:"TemplarVolk"},vbnet:{title:"VB.Net",require:"basic",owner:"Bigsby"},velocity:{title:"Velocity",require:"markup",owner:"Golmote"},verilog:{title:"Verilog",owner:"a-rey"},vhdl:{title:"VHDL",owner:"a-rey"},vim:{title:"vim",owner:"westonganger"},"visual-basic":{title:"Visual Basic",alias:["vb","vba"],aliasTitles:{vba:"VBA"},owner:"Golmote"},warpscript:{title:"WarpScript",owner:"RunDevelopment"},wasm:{title:"WebAssembly",owner:"Golmote"},"web-idl":{title:"Web IDL",alias:"webidl",owner:"RunDevelopment"},wgsl:{title:"WGSL",owner:"Dr4gonthree"},wiki:{title:"Wiki markup",require:"markup",owner:"Golmote"},wolfram:{title:"Wolfram language",alias:["mathematica","nb","wl"],aliasTitles:{mathematica:"Mathematica",nb:"Mathematica Notebook"},owner:"msollami"},wren:{title:"Wren",owner:"clsource"},xeora:{title:"Xeora",require:"markup",alias:"xeoracube",aliasTitles:{xeoracube:"XeoraCube"},owner:"freakmaxi"},"xml-doc":{title:"XML doc (.net)",require:"markup",modify:["csharp","fsharp","vbnet"],owner:"RunDevelopment"},xojo:{title:"Xojo (REALbasic)",owner:"Golmote"},xquery:{title:"XQuery",require:"markup",owner:"Golmote"},yaml:{title:"YAML",alias:"yml",owner:"hason"},yang:{title:"YANG",owner:"RunDevelopment"},zig:{title:"Zig",owner:"RunDevelopment"}},plugins:{meta:{path:"plugins/{id}/prism-{id}",link:"plugins/{id}/"},"line-highlight":{title:"Line Highlight",description:"Highlights specific lines and/or line ranges."},"line-numbers":{title:"Line Numbers",description:"Line number at the beginning of code lines.",owner:"kuba-kubula"},"show-invisibles":{title:"Show Invisibles",description:"Show hidden characters such as tabs and line breaks.",optional:["autolinker","data-uri-highlight"]},autolinker:{title:"Autolinker",description:"Converts URLs and emails in code to clickable links. Parses Markdown links in comments."},wpd:{title:"WebPlatform Docs",description:'Makes tokens link to WebPlatform.org documentation. The links open in a new tab.'},"custom-class":{title:"Custom Class",description:"This plugin allows you to prefix Prism's default classes (.comment can become .namespace--comment) or replace them with your defined ones (like .editor__comment). You can even add new classes.",owner:"dvkndn",noCSS:!0},"file-highlight":{title:"File Highlight",description:"Fetch external files and highlight them with Prism. Used on the Prism website itself.",noCSS:!0},"show-language":{title:"Show Language",description:"Display the highlighted language in code blocks (inline code does not show the label).",owner:"nauzilus",noCSS:!0,require:"toolbar"},"jsonp-highlight":{title:"JSONP Highlight",description:"Fetch content with JSONP and highlight some interesting content (e.g. GitHub/Gists or Bitbucket API).",noCSS:!0,owner:"nauzilus"},"highlight-keywords":{title:"Highlight Keywords",description:"Adds special CSS classes for each keyword for fine-grained highlighting.",owner:"vkbansal",noCSS:!0},"remove-initial-line-feed":{title:"Remove initial line feed",description:"Removes the initial line feed in code blocks.",owner:"Golmote",noCSS:!0},"inline-color":{title:"Inline color",description:"Adds a small inline preview for colors in style sheets.",require:"css-extras",owner:"RunDevelopment"},previewers:{title:"Previewers",description:"Previewers for angles, colors, gradients, easing and time.",require:"css-extras",owner:"Golmote"},autoloader:{title:"Autoloader",description:"Automatically loads the needed languages to highlight the code blocks.",owner:"Golmote",noCSS:!0},"keep-markup":{title:"Keep Markup",description:"Prevents custom markup from being dropped out during highlighting.",owner:"Golmote",optional:"normalize-whitespace",noCSS:!0},"command-line":{title:"Command Line",description:"Display a command line with a prompt and, optionally, the output/response from the commands.",owner:"chriswells0"},"unescaped-markup":{title:"Unescaped Markup",description:"Write markup without having to escape anything."},"normalize-whitespace":{title:"Normalize Whitespace",description:"Supports multiple operations to normalize whitespace in code blocks.",owner:"zeitgeist87",optional:"unescaped-markup",noCSS:!0},"data-uri-highlight":{title:"Data-URI Highlight",description:"Highlights data-URI contents.",owner:"Golmote",noCSS:!0},toolbar:{title:"Toolbar",description:"Attach a toolbar for plugins to easily register buttons on the top of a code block.",owner:"mAAdhaTTah"},"copy-to-clipboard":{title:"Copy to Clipboard Button",description:"Add a button that copies the code block to the clipboard when clicked.",owner:"mAAdhaTTah",require:"toolbar",noCSS:!0},"download-button":{title:"Download Button",description:"A button in the toolbar of a code block adding a convenient way to download a code file.",owner:"Golmote",require:"toolbar",noCSS:!0},"match-braces":{title:"Match braces",description:"Highlights matching braces.",owner:"RunDevelopment"},"diff-highlight":{title:"Diff Highlight",description:"Highlights the code inside diff blocks.",owner:"RunDevelopment",require:"diff"},"filter-highlight-all":{title:"Filter highlightAll",description:"Filters the elements the highlightAll and highlightAllUnder methods actually highlight.",owner:"RunDevelopment",noCSS:!0},treeview:{title:"Treeview",description:"A language with special styles to highlight file system tree structures.",owner:"Golmote"}}})},2885:(e,t,r)=>{const n=r(29901),a=r(39642),i=new Set;function o(e){void 0===e?e=Object.keys(n.languages).filter((e=>"meta"!=e)):Array.isArray(e)||(e=[e]);const t=[...i,...Object.keys(Prism.languages)];a(n,e,t).load((e=>{if(!(e in n.languages))return void(o.silent||console.warn("Language does not exist: "+e));const t="./prism-"+e;delete r.c[r(16500).resolve(t)],delete Prism.languages[e],r(16500)(t),i.add(e)}))}o.silent=!1,e.exports=o},6726:(e,t,r)=>{var n={"./":2885};function a(e){var t=i(e);return r(t)}function i(e){if(!r.o(n,e)){var t=new Error("Cannot find module '"+e+"'");throw t.code="MODULE_NOT_FOUND",t}return n[e]}a.keys=function(){return Object.keys(n)},a.resolve=i,e.exports=a,a.id=6726},16500:(e,t,r)=>{var n={"./":2885};function a(e){var t=i(e);return r(t)}function i(e){if(!r.o(n,e)){var t=new Error("Cannot find module '"+e+"'");throw t.code="MODULE_NOT_FOUND",t}return n[e]}a.keys=function(){return Object.keys(n)},a.resolve=i,e.exports=a,a.id=16500},39642:e=>{"use strict";var t=function(){var e=function(){};function t(e,t){Array.isArray(e)?e.forEach(t):null!=e&&t(e,0)}function r(e){for(var t={},r=0,n=e.length;r "));var s={},c=e[n];if(c){function l(t){if(!(t in e))throw new Error(n+" depends on an unknown component "+t);if(!(t in s))for(var o in a(t,i),s[t]=!0,r[t])s[o]=!0}t(c.require,l),t(c.optional,l),t(c.modify,l)}r[n]=s,i.pop()}}return function(e){var t=r[e];return t||(a(e,n),t=r[e]),t}}function a(e){for(var t in e)return!0;return!1}return function(i,o,s){var c=function(e){var t={};for(var r in e){var n=e[r];for(var a in n)if("meta"!=a){var i=n[a];t[a]="string"==typeof i?{title:i}:i}}return t}(i),l=function(e){var r;return function(n){if(n in e)return n;if(!r)for(var a in r={},e){var i=e[a];t(i&&i.alias,(function(t){if(t in r)throw new Error(t+" cannot be alias for both "+a+" and "+r[t]);if(t in e)throw new Error(t+" cannot be alias of "+a+" because it is a component.");r[t]=a}))}return r[n]||n}}(c);o=o.map(l),s=(s||[]).map(l);var u=r(o),d=r(s);o.forEach((function e(r){var n=c[r];t(n&&n.require,(function(t){t in d||(u[t]=!0,e(t))}))}));for(var f,m=n(c),p=u;a(p);){for(var b in f={},p){var g=c[b];t(g&&g.modify,(function(e){e in d&&(f[e]=!0)}))}for(var h in d)if(!(h in u))for(var w in m(h))if(w in u){f[h]=!0;break}for(var I in p=f)u[I]=!0}var x={getIds:function(){var e=[];return x.load((function(t){e.push(t)})),e},load:function(t,r){return function(t,r,n,a){var i=a?a.series:void 0,o=a?a.parallel:e,s={},c={};function l(e){if(e in s)return s[e];c[e]=!0;var a,u=[];for(var d in t(e))d in r&&u.push(d);if(0===u.length)a=n(e);else{var f=o(u.map((function(e){var t=l(e);return delete c[e],t})));i?a=i(f,(function(){return n(e)})):n(e)}return s[e]=a}for(var u in r)l(u);var d=[];for(var f in c)d.push(s[f]);return o(d)}(m,u,t,r)}};return x}}();e.exports=t},92703:(e,t,r)=>{"use strict";var n=r(50414);function a(){}function i(){}i.resetWarningCache=a,e.exports=function(){function e(e,t,r,a,i,o){if(o!==n){var s=new Error("Calling PropTypes validators directly is not supported by the `prop-types` package. Use PropTypes.checkPropTypes() to call them. Read more at http://fb.me/use-check-prop-types");throw s.name="Invariant Violation",s}}function t(){return e}e.isRequired=e;var r={array:e,bigint:e,bool:e,func:e,number:e,object:e,string:e,symbol:e,any:e,arrayOf:t,element:e,elementType:e,instanceOf:t,node:e,objectOf:t,oneOf:t,oneOfType:t,shape:t,exact:t,checkPropTypes:i,resetWarningCache:a};return r.PropTypes=r,r}},45697:(e,t,r)=>{e.exports=r(92703)()},50414:e=>{"use strict";e.exports="SECRET_DO_NOT_PASS_THIS_OR_YOU_WILL_BE_FIRED"},64448:(e,t,r)=>{"use strict";var n=r(67294),a=r(27418),i=r(63840);function o(e){for(var t="https://reactjs.org/docs/error-decoder.html?invariant="+e,r=1;r