From 36510fc0be8343bc74ca116f4faf21299b7f9f33 Mon Sep 17 00:00:00 2001 From: rolfheij-sil <108285668+rolfheij-sil@users.noreply.github.com> Date: Fri, 22 Dec 2023 17:51:00 +0000 Subject: [PATCH] =?UTF-8?q?Deploying=20to=20github-pages=20from=20@=20para?= =?UTF-8?q?next/paranext-core@8607101e4d625949e87a2f190a0a65f35b2bbc0c=20?= =?UTF-8?q?=F0=9F=9A=80?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- papi-components/enums/LabelPosition.html | 4 +- papi-components/functions/Button.html | 2 +- .../functions/ChapterRangeSelector.html | 2 +- papi-components/functions/Checkbox.html | 2 +- papi-components/functions/ComboBox.html | 2 +- papi-components/functions/GridMenu.html | 2 +- papi-components/functions/IconButton.html | 2 +- papi-components/functions/MenuItem.html | 2 +- papi-components/functions/RefSelector.html | 2 +- papi-components/functions/SearchBar.html | 2 +- papi-components/functions/Slider.html | 2 +- papi-components/functions/Snackbar.html | 2 +- papi-components/functions/Switch.html | 2 +- papi-components/functions/Table.html | 2 +- papi-components/functions/TextField.html | 2 +- papi-components/functions/Toolbar.html | 2 +- .../functions/getChaptersForBook.html | 2 +- .../interfaces/ScrRefSelectorProps.html | 4 +- .../interfaces/TableCalculatedColumn.html | 12 ++-- .../types/ChapterRangeSelectorProps.html | 2 +- papi-components/types/GridMenuProps.html | 2 +- papi-components/types/MenuColumn.html | 2 +- papi-components/types/TableCellClickArgs.html | 2 +- .../types/TableCellKeyDownArgs.html | 2 +- .../types/TableCellKeyboardEvent.html | 2 +- .../types/TableCellMouseEvent.html | 2 +- papi-components/types/TableColumn.html | 2 +- papi-components/types/TableCopyEvent.html | 2 +- papi-components/types/TableEditorProps.html | 2 +- papi-components/types/TablePasteEvent.html | 2 +- papi-components/types/TableProps.html | 2 +- .../types/TableRowsChangeData.html | 2 +- papi-components/types/TableSortColumn.html | 2 +- papi-components/types/ToolbarProps.html | 2 +- ...nt_network_connector_service_.default.html | 44 ++++++------- ...er_network_connector_service_.default.html | 62 +++++++++---------- ...execution_token_model_.ExecutionToken.html | 4 +- ..._renderer_web_socket_service_.default.html | 4 +- ...rer_xml_http_request_service_.default.html | 4 +- ...els_papi_event_emitter_model_.default.html | 22 +++---- ..._network_event_emitter_model_.default.html | 22 +++---- ..._provider_service_.DataProviderEngine.html | 4 +- ..._shared_utils_async_variable_.default.html | 14 ++--- ...tils_unsubscriber_async_list_.default.html | 8 +-- ...s_node_file_system_service_.EntryType.html | 4 +- ...al_connection_model_.ConnectionStatus.html | 8 +-- ..._network_connector_model_.MessageType.html | 4 +- ...shared_global_this_model_.ProcessType.html | 4 +- ...ls_web_view_model_.WebViewContentType.html | 8 +-- ...d_utils_papi_util_.RequestHandlerType.html | 4 +- ...s_web_socket_factory_.createWebSocket.html | 2 +- ...e_service_.buildExtensionPathFromName.html | 2 +- ...ion_storage_service_.setExtensionUris.html | 2 +- ...es_node_file_system_service_.copyFile.html | 2 +- ...s_node_file_system_service_.createDir.html | 2 +- ...s_node_file_system_service_.deleteDir.html | 2 +- ..._node_file_system_service_.deleteFile.html | 2 +- ...es_node_file_system_service_.getStats.html | 2 +- ...ces_node_file_system_service_.readDir.html | 2 +- ...e_file_system_service_.readFileBinary.html | 2 +- ...ode_file_system_service_.readFileText.html | 2 +- ...vices_node_file_system_service_.touch.html | 2 +- ...s_node_file_system_service_.writeFile.html | 2 +- .../_node_utils_crypto_util_.createNonce.html | 2 +- .../_node_utils_crypto_util_.createUuid.html | 2 +- .../_node_utils_util_.getPathFromUri.html | 2 +- .../_node_utils_util_.joinUriPaths.html | 2 +- .../_node_utils_util_.resolveHtmlPath.html | 2 +- ...dialog_base_data_.hookUpDialogService.html | 2 +- ...rs_create_use_data_hook_util_.default.html | 2 +- ...use_network_object_hook_util_.default.html | 2 +- ...oks_papi_hooks_use_data_hook_.default.html | 2 +- ...hooks_use_data_provider_hook_.default.html | 2 +- ...use_data_provider_multi_hook_.default.html | 2 +- ...oks_use_dialog_callback_hook_.default.html | 2 +- ...i_hooks_use_event_async_hook_.default.html | 2 +- ...ks_papi_hooks_use_event_hook_.default.html | 2 +- ..._hooks_use_project_data_hook_.default.html | 2 +- ...e_project_data_provider_hook_.default.html | 2 +- ..._papi_hooks_use_promise_hook_.default.html | 2 +- ..._papi_hooks_use_setting_hook_.default.html | 2 +- ...service_.blockWebSocketsToPapiNetwork.html | 2 +- ...tDataProviderDataTypeFromFunctionName.html | 2 +- ...ed_services_command_service_.addThree.html | 2 +- ...nd_service_.createSendCommandFunction.html | 2 +- ..._services_command_service_.initialize.html | 2 +- ...ices_command_service_.registerCommand.html | 2 +- ...services_command_service_.sendCommand.html | 2 +- ...ices_command_service_.squareAndConcat.html | 2 +- ..._services_connection_service_.connect.html | 2 +- ...rvices_connection_service_.disconnect.html | 2 +- ...onnection_service_.emitEventOnNetwork.html | 2 +- ...vices_connection_service_.getClientId.html | 2 +- ..._services_connection_service_.request.html | 2 +- ...ices_data_provider_service_.getByType.html | 2 +- ...rovider_service_.registerEngineByType.html | 2 +- ...ed_services_logger_service_.formatLog.html | 2 +- ...ector_factory_.createNetworkConnector.html | 2 +- ...ect_service_.onDidCreateNetworkObject.html | 2 +- ...ct_service_.onDidDisposeNetworkObject.html | 2 +- ...twork_object_service_.overrideDispose.html | 2 +- ...rk_service_.createNetworkEventEmitter.html | 2 +- ...etwork_service_.createRequestFunction.html | 2 +- ...ices_network_service_.getNetworkEvent.html | 2 +- ..._services_network_service_.initialize.html | 2 +- ...s_network_service_.onDidClientConnect.html | 2 +- ...etwork_service_.onDidClientDisconnect.html | 2 +- ...twork_service_.registerRequestHandler.html | 2 +- ...red_services_network_service_.request.html | 2 +- ...ed_services_network_service_.shutdown.html | 2 +- ...es_project_data_provider_service_.get.html | 2 +- ...isterProjectDataProviderEngineFactory.html | 2 +- ...d_utils_internal_util_.getProcessType.html | 2 +- ..._shared_utils_internal_util_.isClient.html | 2 +- ..._utils_internal_util_.isExtensionHost.html | 2 +- ...hared_utils_internal_util_.isRenderer.html | 2 +- ..._shared_utils_internal_util_.isServer.html | 2 +- ...api_util_.aggregateUnsubscriberAsyncs.html | 2 +- ...ils_papi_util_.aggregateUnsubscribers.html | 2 +- ...utils_papi_util_.createSafeRegisterFn.html | 2 +- .../_shared_utils_papi_util_.deepEqual.html | 2 +- .../_shared_utils_papi_util_.deserialize.html | 2 +- ...ils_papi_util_.deserializeRequestType.html | 2 +- ...papi_util_.getModuleSimilarApiMessage.html | 2 +- .../_shared_utils_papi_util_.htmlEncode.html | 2 +- ...hared_utils_papi_util_.isSerializable.html | 2 +- .../_shared_utils_papi_util_.serialize.html | 2 +- ...utils_papi_util_.serializeRequestType.html | 2 +- .../_shared_utils_util_.debounce.html | 2 +- ...utils_util_.getAllObjectFunctionNames.html | 2 +- .../_shared_utils_util_.getErrorMessage.html | 2 +- .../_shared_utils_util_.groupBy.html | 2 +- .../_shared_utils_util_.isString.html | 2 +- .../_shared_utils_util_.newGuid.html | 2 +- .../_shared_utils_util_.newNonce.html | 2 +- .../functions/_shared_utils_util_.wait.html | 2 +- .../_shared_utils_util_.waitForDuration.html | 2 +- ...tWebViewDefinitionUpdatableProperties.html | 2 +- ...ViewDefinitionUpdatablePropertiesById.html | 2 +- papi-dts/functions/getWebViewState.html | 2 +- papi-dts/functions/setWebViewState.html | 2 +- .../functions/updateWebViewDefinition.html | 2 +- .../updateWebViewDefinitionById.html | 2 +- papi-dts/functions/useWebViewState.html | 2 +- ...types_extension_interface_.IExtension.html | 6 +- ...rage_service_.ExtensionStorageService.html | 12 ++-- .../_papi_shared_types_.CommandHandlers.html | 4 +- .../_papi_shared_types_.DataProviders.html | 4 +- .../_papi_shared_types_.ProjectDataTypes.html | 4 +- .../_papi_shared_types_.SettingTypes.html | 4 +- ..._dialog_definition_model_.DialogTypes.html | 4 +- ...isposal_model_.CannotHaveOnDidDispose.html | 6 +- ...shared_models_disposal_model_.Dispose.html | 4 +- ...d_models_disposal_model_.OnDidDispose.html | 4 +- ..._docking_framework_model_.FloatLayout.html | 6 +- ..._docking_framework_model_.PanelLayout.html | 6 +- ...ls_docking_framework_model_.TabLayout.html | 4 +- ...del_.ProjectDataProviderEngineFactory.html | 4 +- ...ider_model_.DisposableWebViewProvider.html | 8 +-- ...view_provider_model_.IWebViewProvider.html | 8 +-- ..._view_provider_model_.WebViewProvider.html | 8 +-- ...provider_service_.DataProviderService.html | 12 ++-- ...s_dialog_service_model_.DialogService.html | 6 +- ...ces_internet_service_.InternetService.html | 4 +- ..._network_connector_interface_.default.html | 16 ++--- ....NetworkObjectStatusRemoteServiceType.html | 4 +- ...model_.NetworkObjectStatusServiceType.html | 6 +- ...s_network_service_.PapiNetworkService.html | 6 +- ...PapiBackendProjectDataProviderService.html | 6 +- ...apiFrontendProjectDataProviderService.html | 4 +- ...rvice_model_.ProjectLookupServiceType.html | 6 +- ...ces_settings_service_.SettingsService.html | 8 +-- ...r_service_.PapiWebViewProviderService.html | 4 +- ...vider_service_.WebViewProviderService.html | 10 +-- ...iew_service_model_.WebViewServiceType.html | 6 +- papi-dts/modules/__papi_backend_.html | 2 +- papi-dts/modules/__papi_core_.html | 2 +- papi-dts/modules/__papi_frontend_.html | 2 +- papi-dts/modules/__papi_frontend_react_.html | 2 +- ...ces_client_network_connector_service_.html | 2 +- .../_client_services_web_socket_factory_.html | 2 +- ...client_services_web_socket_interface_.html | 2 +- ...s_extension_activation_context_model_.html | 2 +- ..._extension_types_extension_interface_.html | 2 +- ...nsion_types_extension_manifest_model_.html | 2 +- ...ices_extension_host_web_socket_model_.html | 2 +- ...t_services_extension_storage_service_.html | 2 +- ...ces_server_network_connector_service_.html | 2 +- .../_node_models_execution_token_model_.html | 2 +- ...ode_services_execution_token_service_.html | 2 +- ...de_services_node_file_system_service_.html | 2 +- .../modules/_node_utils_crypto_util_.html | 2 +- .../modules/_node_utils_util_.getAppDir.html | 2 +- papi-dts/modules/_node_utils_util_.html | 2 +- papi-dts/modules/_papi_shared_types_.html | 2 +- ..._components_dialogs_dialog_base_data_.html | 2 +- ...ents_dialogs_dialog_definition_model_.html | 2 +- ...generators_create_use_data_hook_util_.html | 2 +- ..._create_use_network_object_hook_util_.html | 2 +- .../_renderer_hooks_papi_hooks_index_.html | 2 +- ...derer_hooks_papi_hooks_use_data_hook_.html | 2 +- ...ks_papi_hooks_use_data_provider_hook_.html | 2 +- ...i_hooks_use_data_provider_multi_hook_.html | 2 +- ..._papi_hooks_use_dialog_callback_hook_.html | 2 +- ...ooks_papi_hooks_use_event_async_hook_.html | 2 +- ...erer_hooks_papi_hooks_use_event_hook_.html | 2 +- ...oks_papi_hooks_use_project_data_hook_.html | 2 +- ...hooks_use_project_data_provider_hook_.html | 2 +- ...er_hooks_papi_hooks_use_promise_hook_.html | 2 +- ...er_hooks_papi_hooks_use_setting_hook_.html | 2 +- ...services_renderer_web_socket_service_.html | 2 +- ...es_renderer_xml_http_request_service_.html | 2 +- .../_shared_data_file_system_model_.html | 2 +- ...hared_data_internal_connection_model_.html | 2 +- ..._shared_data_network_connector_model_.html | 2 +- .../modules/_shared_global_this_model_.html | 2 +- ...ed_models_data_provider_engine_model_.html | 2 +- ...hared_models_data_provider_interface_.html | 2 +- .../_shared_models_data_provider_model_.html | 2 +- .../_shared_models_dialog_options_model_.html | 2 +- .../_shared_models_disposal_model_.html | 2 +- ...hared_models_docking_framework_model_.html | 2 +- ...tract_data_provider_data_types_model_.html | 2 +- .../_shared_models_network_object_model_.html | 2 +- ...ared_models_papi_event_emitter_model_.html | 2 +- .../_shared_models_papi_event_model_.html | 2 +- ...els_papi_network_event_emitter_model_.html | 2 +- ...s_project_data_provider_engine_model_.html | 2 +- ...d_models_project_data_provider_model_.html | 2 +- ...shared_models_project_metadata_model_.html | 2 +- .../_shared_models_web_view_model_.html | 2 +- ...hared_models_web_view_provider_model_.html | 2 +- .../_shared_services_command_service_.html | 2 +- .../_shared_services_connection_service_.html | 2 +- ...hared_services_data_provider_service_.html | 2 +- .../_shared_services_dialog_service_.html | 2 +- ...shared_services_dialog_service_model_.html | 2 +- .../_shared_services_internet_service_.html | 2 +- .../_shared_services_logger_service_.html | 2 +- ...d_services_network_connector_factory_.html | 2 +- ...services_network_connector_interface_.html | 2 +- ...ared_services_network_object_service_.html | 2 +- ...rvices_network_object_status_service_.html | 2 +- ..._network_object_status_service_model_.html | 2 +- .../_shared_services_network_service_.html | 2 +- ...rvices_project_data_provider_service_.html | 2 +- ...ared_services_project_lookup_service_.html | 2 +- ...ervices_project_lookup_service_model_.html | 2 +- .../_shared_services_settings_service_.html | 2 +- ...d_services_web_view_provider_service_.html | 2 +- .../_shared_services_web_view_service_.html | 2 +- ...ared_services_web_view_service_model_.html | 2 +- .../_shared_utils_async_variable_.html | 2 +- .../modules/_shared_utils_internal_util_.html | 2 +- .../modules/_shared_utils_papi_util_.html | 2 +- ...shared_utils_unsubscriber_async_list_.html | 2 +- papi-dts/modules/_shared_utils_util_.html | 2 +- papi-dts/modules/webViewComponent.html | 2 +- papi-dts/types/__papi_frontend_.Papi.html | 2 +- ...ices_web_socket_interface_.IWebSocket.html | 2 +- ...ext_model_.ExecutionActivationContext.html | 2 +- ...ion_manifest_model_.ExtensionManifest.html | 2 +- ...ution_token_model_.ExecutionTokenType.html | 2 +- ...file_system_service_.DirectoryEntries.html | 2 +- .../_papi_shared_types_.CommandNames.html | 2 +- ..._papi_shared_types_.DataProviderNames.html | 2 +- ..._papi_shared_types_.DataProviderTypes.html | 2 +- ...shared_types_.DisposableDataProviders.html | 2 +- ...ared_types_.NotesOnlyProjectDataTypes.html | 2 +- ...pi_shared_types_.PlaceholderDataTypes.html | 2 +- .../_papi_shared_types_.ProjectTypes.html | 2 +- .../_papi_shared_types_.SettingNames.html | 2 +- .../_papi_shared_types_.StuffDataTypes.html | 2 +- ...ialog_base_data_.DialogDefinitionBase.html | 2 +- ...dialogs_dialog_base_data_.DialogProps.html | 6 +- ...log_definition_model_.DialogDataTypes.html | 2 +- ...og_definition_model_.DialogDefinition.html | 2 +- ...alog_definition_model_.DialogTabTypes.html | 2 +- ..._.SelectMultipleProjectsDialogOptions.html | 2 +- ...ion_model_.SelectProjectDialogOptions.html | 2 +- .../_shared_data_file_system_model_.Uri.html | 2 +- ..._connection_model_.ClientConnectEvent.html | 2 +- ...nnection_model_.ClientDisconnectEvent.html | 2 +- ...ernal_connection_model_.InternalEvent.html | 2 +- ...on_model_.InternalNetworkEventHandler.html | 2 +- ...nal_connection_model_.InternalRequest.html | 2 +- ...nection_model_.InternalRequestHandler.html | 2 +- ...al_connection_model_.InternalResponse.html | 2 +- ..._model_.NetworkConnectorEventHandlers.html | 2 +- ...onnection_model_.NetworkConnectorInfo.html | 2 +- ...connection_model_.NetworkEventHandler.html | 2 +- ...rnal_connection_model_.RequestHandler.html | 2 +- ...ernal_connection_model_.RequestRouter.html | 2 +- ...etwork_connector_model_.ClientConnect.html | 2 +- ...a_network_connector_model_.InitClient.html | 2 +- ...data_network_connector_model_.Message.html | 2 +- ...twork_connector_model_.WebSocketEvent.html | 2 +- ...ork_connector_model_.WebSocketRequest.html | 2 +- ...rk_connector_model_.WebSocketResponse.html | 2 +- ...model_.DataProviderEngineNotifyUpdate.html | 2 +- ...ovider_engine_model_.WithNotifyUpdate.html | 2 +- ...s_data_provider_engine_model_.default.html | 2 +- ...er_interface_.IDisposableDataProvider.html | 2 +- ...dels_data_provider_interface_.default.html | 2 +- ..._provider_model_.DataProviderDataType.html | 2 +- ...provider_model_.DataProviderDataTypes.html | 2 +- ...ta_provider_model_.DataProviderGetter.html | 2 +- ...a_provider_model_.DataProviderGetters.html | 2 +- ...ta_provider_model_.DataProviderSetter.html | 2 +- ...a_provider_model_.DataProviderSetters.html | 2 +- ...rovider_model_.DataProviderSubscriber.html | 2 +- ..._model_.DataProviderSubscriberOptions.html | 2 +- ...ovider_model_.DataProviderSubscribers.html | 2 +- ...model_.DataProviderUpdateInstructions.html | 2 +- ...ls_data_provider_model_.DataTypeNames.html | 2 +- ...d_models_data_provider_model_.default.html | 2 +- ...dels_dialog_options_model_.DialogData.html | 2 +- ...s_dialog_options_model_.DialogOptions.html | 2 +- ...s_disposal_model_.CanHaveOnDidDispose.html | 2 +- ...king_framework_model_.AddWebViewEvent.html | 2 +- ...ocking_framework_model_.FloatPosition.html | 2 +- ...ls_docking_framework_model_.FloatSize.html | 2 +- ...odels_docking_framework_model_.Layout.html | 2 +- ...framework_model_.OnLayoutChangeRCDock.html | 2 +- ...cking_framework_model_.PanelDirection.html | 2 +- ...cking_framework_model_.PapiDockLayout.html | 2 +- ...docking_framework_model_.SavedTabInfo.html | 2 +- ...dels_docking_framework_model_.TabInfo.html | 2 +- ...ls_docking_framework_model_.TabLoader.html | 2 +- ...els_docking_framework_model_.TabSaver.html | 2 +- ...king_framework_model_.WebViewTabProps.html | 2 +- ...ta_provider_data_types_model_.default.html | 2 +- ...object_model_.DisposableNetworkObject.html | 2 +- ...ject_model_.LocalObjectToProxyCreator.html | 2 +- ...s_network_object_model_.NetworkObject.html | 2 +- ...rk_object_model_.NetworkObjectDetails.html | 2 +- ...twork_object_model_.NetworkableObject.html | 2 +- ...ed_models_papi_event_model_.PapiEvent.html | 2 +- ...dels_papi_event_model_.PapiEventAsync.html | 2 +- ...ls_papi_event_model_.PapiEventHandler.html | 2 +- ...der_engine_model_.ProjectDataProvider.html | 2 +- ...model_.ProjectDataProviderEngineTypes.html | 2 +- ...ta_provider_model_.ExtensionDataScope.html | 2 +- ...vider_model_.MandatoryProjectDataType.html | 2 +- ...oject_metadata_model_.ProjectMetadata.html | 2 +- ...tWebViewDefinitionUpdatableProperties.html | 2 +- ...els_web_view_model_.GetWebViewOptions.html | 2 +- ...eb_view_model_.SavedWebViewDefinition.html | 2 +- ...b_view_model_.UpdateWebViewDefinition.html | 2 +- ...s_web_view_model_.UseWebViewStateHook.html | 2 +- ...els_web_view_model_.WebViewDefinition.html | 2 +- ...web_view_model_.WebViewDefinitionBase.html | 2 +- ...web_view_model_.WebViewDefinitionHtml.html | 2 +- ...eb_view_model_.WebViewDefinitionReact.html | 2 +- ..._web_view_model_.WebViewDefinitionURL.html | 2 +- ....WebViewDefinitionUpdatableProperties.html | 2 +- ...ew_model_.WebViewDefinitionUpdateInfo.html | 2 +- ...ared_models_web_view_model_.WebViewId.html | 2 +- ...d_models_web_view_model_.WebViewProps.html | 2 +- ...ed_models_web_view_model_.WebViewType.html | 2 +- ...ommand_service_.moduleSummaryComments.html | 2 +- ...s_network_service_.ArgsRequestHandler.html | 2 +- ...etwork_service_.ComplexRequestHandler.html | 2 +- ...twork_service_.ContentsRequestHandler.html | 2 +- ...hared_utils_papi_util_.ComplexRequest.html | 2 +- ...ared_utils_papi_util_.ComplexResponse.html | 2 +- ...ils_papi_util_.ComplexResponseFailure.html | 2 +- ...ils_papi_util_.ComplexResponseSuccess.html | 2 +- .../_shared_utils_papi_util_.RequestType.html | 2 +- ...tils_papi_util_.SerializedRequestType.html | 2 +- ..._shared_utils_papi_util_.Unsubscriber.html | 2 +- ...ed_utils_papi_util_.UnsubscriberAsync.html | 2 +- ...tils_papi_util_.moduleSummaryComments.html | 2 +- .../__papi_backend_.DataProviderEngine.html | 2 +- .../__papi_backend_.EventEmitter.html | 2 +- .../variables/__papi_backend_.commands.html | 2 +- .../__papi_backend_.dataProviders.html | 2 +- .../variables/__papi_backend_.default.html | 2 +- .../variables/__papi_backend_.dialogs.html | 2 +- .../variables/__papi_backend_.internet.html | 2 +- .../variables/__papi_backend_.logger.html | 2 +- .../variables/__papi_backend_.network.html | 2 +- .../__papi_backend_.projectDataProviders.html | 2 +- .../__papi_backend_.projectLookup.html | 2 +- .../variables/__papi_backend_.storage.html | 2 +- papi-dts/variables/__papi_backend_.utils.html | 2 +- .../__papi_backend_.webViewProviders.html | 2 +- .../variables/__papi_backend_.webViews.html | 2 +- papi-dts/variables/__papi_core_.default.html | 2 +- .../__papi_frontend_.EventEmitter.html | 2 +- .../variables/__papi_frontend_.WebSocket.html | 2 +- .../__papi_frontend_.XMLHttpRequest.html | 2 +- .../variables/__papi_frontend_.commands.html | 2 +- .../__papi_frontend_.dataProviders.html | 2 +- .../variables/__papi_frontend_.default.html | 2 +- .../variables/__papi_frontend_.dialogs.html | 2 +- .../variables/__papi_frontend_.internet.html | 2 +- .../variables/__papi_frontend_.logger.html | 2 +- .../variables/__papi_frontend_.network.html | 2 +- ...__papi_frontend_.projectDataProviders.html | 2 +- .../__papi_frontend_.projectLookup.html | 2 +- .../variables/__papi_frontend_.react.html | 2 +- .../variables/__papi_frontend_.settings.html | 2 +- .../variables/__papi_frontend_.utils.html | 2 +- .../variables/__papi_frontend_.webViews.html | 2 +- ...es_extension_storage_service_.default.html | 2 +- ...ices_execution_token_service_.default.html | 2 +- .../_node_utils_util_.FILE_PROTOCOL.html | 2 +- .../_node_utils_util_.RESOURCES_PROTOCOL.html | 2 +- ...nts_dialogs_dialog_base_data_.default.html | 2 +- ....SELECT_MULTIPLE_PROJECTS_DIALOG_TYPE.html | 2 +- ...ion_model_.SELECT_PROJECT_DIALOG_TYPE.html | 2 +- ...al_connection_model_.CATEGORY_COMMAND.html | 2 +- ...al_connection_model_.CLIENT_ID_SERVER.html | 2 +- ...onnection_model_.CLIENT_ID_UNASSIGNED.html | 2 +- ...on_model_.CONNECTOR_INFO_DISCONNECTED.html | 2 +- ...nnector_model_.WEBSOCKET_ATTEMPTS_MAX.html | 2 +- ...nector_model_.WEBSOCKET_ATTEMPTS_WAIT.html | 2 +- ...twork_connector_model_.WEBSOCKET_PORT.html | 2 +- ...rvices_data_provider_service_.default.html | 2 +- ...ared_services_dialog_service_.default.html | 2 +- ...dialog_service_model_.CATEGORY_DIALOG.html | 2 +- ...ed_services_internet_service_.default.html | 2 +- ...red_services_logger_service_.WARN_TAG.html | 2 +- ...ared_services_logger_service_.default.html | 2 +- ...vices_network_object_service_.default.html | 2 +- ...etwork_object_status_service_.default.html | 2 +- ...kObjectStatusServiceNetworkObjectName.html | 2 +- ...network_service_.papiNetworkService-1.html | 2 +- ...piBackendProjectDataProviderService-1.html | 2 +- ...iFrontendProjectDataProviderService-1.html | 2 +- ...vices_project_lookup_service_.default.html | 2 +- ...projectLookupServiceNetworkObjectName.html | 2 +- ...ed_services_settings_service_.default.html | 2 +- ...es_web_view_provider_service_.default.html | 2 +- ...service_.papiWebViewProviderService-1.html | 2 +- ...ed_services_web_view_service_.default.html | 2 +- ...model_.EVENT_NAME_ON_DID_ADD_WEB_VIEW.html | 2 +- ....NETWORK_OBJECT_NAME_WEB_VIEW_SERVICE.html | 2 +- ..._utils_papi_util_.MODULE_SIMILAR_APIS.html | 2 +- ...ils_papi_util_.REQUEST_TYPE_SEPARATOR.html | 2 +- papi-dts/variables/isPackaged.html | 2 +- papi-dts/variables/logLevel.html | 2 +- papi-dts/variables/processType.html | 2 +- papi-dts/variables/resourcesPath.html | 2 +- 445 files changed, 614 insertions(+), 614 deletions(-) diff --git a/papi-components/enums/LabelPosition.html b/papi-components/enums/LabelPosition.html index f0700fb627..ccf350154b 100644 --- a/papi-components/enums/LabelPosition.html +++ b/papi-components/enums/LabelPosition.html @@ -1,5 +1,5 @@ -LabelPosition | papi-components

Enumeration LabelPosition

Enumeration Members

Above +LabelPosition | papi-components

Enumeration LabelPosition

Enumeration Members

Enumeration Members

Above: "above"
After: "after"
Before: "before"
Below: "below"

Generated using TypeDoc

\ No newline at end of file +

Enumeration Members

Above: "above"
After: "after"
Before: "before"
Below: "below"

Generated using TypeDoc

\ No newline at end of file diff --git a/papi-components/functions/Button.html b/papi-components/functions/Button.html index 9e4f566054..d44e53ef57 100644 --- a/papi-components/functions/Button.html +++ b/papi-components/functions/Button.html @@ -1,4 +1,4 @@ Button | papi-components

Function Button

Generated using TypeDoc

\ No newline at end of file +

Parameters

Returns Element

Generated using TypeDoc

\ No newline at end of file diff --git a/papi-components/functions/ChapterRangeSelector.html b/papi-components/functions/ChapterRangeSelector.html index 3a9c44d3e4..4f4f4ba842 100644 --- a/papi-components/functions/ChapterRangeSelector.html +++ b/papi-components/functions/ChapterRangeSelector.html @@ -1 +1 @@ -ChapterRangeSelector | papi-components

Function ChapterRangeSelector

Generated using TypeDoc

\ No newline at end of file +ChapterRangeSelector | papi-components

Function ChapterRangeSelector

Generated using TypeDoc

\ No newline at end of file diff --git a/papi-components/functions/Checkbox.html b/papi-components/functions/Checkbox.html index d944d27ac4..23db142a1a 100644 --- a/papi-components/functions/Checkbox.html +++ b/papi-components/functions/Checkbox.html @@ -1,2 +1,2 @@ Checkbox | papi-components

Function Checkbox

  • Primary UI component for user interaction

    -

    Parameters

    • __namedParameters: CheckboxProps

    Returns Element

Generated using TypeDoc

\ No newline at end of file +

Parameters

Returns Element

Generated using TypeDoc

\ No newline at end of file diff --git a/papi-components/functions/ComboBox.html b/papi-components/functions/ComboBox.html index 9df8b4bb33..1ee83d69e7 100644 --- a/papi-components/functions/ComboBox.html +++ b/papi-components/functions/ComboBox.html @@ -1,4 +1,4 @@ ComboBox | papi-components

Function ComboBox

Generated using TypeDoc

\ No newline at end of file +

Type Parameters

Parameters

Returns Element

Generated using TypeDoc

\ No newline at end of file diff --git a/papi-components/functions/GridMenu.html b/papi-components/functions/GridMenu.html index ea8fb0d3a2..c2c2dfe0f3 100644 --- a/papi-components/functions/GridMenu.html +++ b/papi-components/functions/GridMenu.html @@ -1 +1 @@ -GridMenu | papi-components

Function GridMenu

Generated using TypeDoc

\ No newline at end of file +GridMenu | papi-components

Function GridMenu

Generated using TypeDoc

\ No newline at end of file diff --git a/papi-components/functions/IconButton.html b/papi-components/functions/IconButton.html index cab2559127..3b8ec2eb92 100644 --- a/papi-components/functions/IconButton.html +++ b/papi-components/functions/IconButton.html @@ -1,4 +1,4 @@ IconButton | papi-components

Function IconButton

Generated using TypeDoc

\ No newline at end of file +

Parameters

Returns Element

Generated using TypeDoc

\ No newline at end of file diff --git a/papi-components/functions/MenuItem.html b/papi-components/functions/MenuItem.html index 26a1f632ed..46140c769f 100644 --- a/papi-components/functions/MenuItem.html +++ b/papi-components/functions/MenuItem.html @@ -1 +1 @@ -MenuItem | papi-components

Function MenuItem

Generated using TypeDoc

\ No newline at end of file +MenuItem | papi-components

Function MenuItem

Generated using TypeDoc

\ No newline at end of file diff --git a/papi-components/functions/RefSelector.html b/papi-components/functions/RefSelector.html index 876cf9bca5..636619a65f 100644 --- a/papi-components/functions/RefSelector.html +++ b/papi-components/functions/RefSelector.html @@ -1 +1 @@ -RefSelector | papi-components

Function RefSelector

Generated using TypeDoc

\ No newline at end of file +RefSelector | papi-components

Function RefSelector

Generated using TypeDoc

\ No newline at end of file diff --git a/papi-components/functions/SearchBar.html b/papi-components/functions/SearchBar.html index 3d0bc8d571..29708900de 100644 --- a/papi-components/functions/SearchBar.html +++ b/papi-components/functions/SearchBar.html @@ -1 +1 @@ -SearchBar | papi-components

Function SearchBar

Generated using TypeDoc

\ No newline at end of file +SearchBar | papi-components

Function SearchBar

Generated using TypeDoc

\ No newline at end of file diff --git a/papi-components/functions/Slider.html b/papi-components/functions/Slider.html index 78ba4d695f..159e9088fe 100644 --- a/papi-components/functions/Slider.html +++ b/papi-components/functions/Slider.html @@ -1,4 +1,4 @@ Slider | papi-components

Function Slider

Generated using TypeDoc

\ No newline at end of file +

Parameters

Returns Element

Generated using TypeDoc

\ No newline at end of file diff --git a/papi-components/functions/Snackbar.html b/papi-components/functions/Snackbar.html index 7ad6f33332..4bd5a8748b 100644 --- a/papi-components/functions/Snackbar.html +++ b/papi-components/functions/Snackbar.html @@ -1,4 +1,4 @@ Snackbar | papi-components

Function Snackbar

Generated using TypeDoc

\ No newline at end of file +

Parameters

Returns Element

Generated using TypeDoc

\ No newline at end of file diff --git a/papi-components/functions/Switch.html b/papi-components/functions/Switch.html index 241fe471f6..60b28f4cb7 100644 --- a/papi-components/functions/Switch.html +++ b/papi-components/functions/Switch.html @@ -1,4 +1,4 @@ Switch | papi-components

Function Switch

Generated using TypeDoc

\ No newline at end of file +

Parameters

Returns Element

Generated using TypeDoc

\ No newline at end of file diff --git a/papi-components/functions/Table.html b/papi-components/functions/Table.html index aab1dab560..169f6f6e24 100644 --- a/papi-components/functions/Table.html +++ b/papi-components/functions/Table.html @@ -1,4 +1,4 @@ Table | papi-components

Function Table

Generated using TypeDoc

\ No newline at end of file +

Type Parameters

Parameters

Returns Element

Generated using TypeDoc

\ No newline at end of file diff --git a/papi-components/functions/TextField.html b/papi-components/functions/TextField.html index ab1cd79dac..318004f652 100644 --- a/papi-components/functions/TextField.html +++ b/papi-components/functions/TextField.html @@ -1,4 +1,4 @@ TextField | papi-components

Function TextField

Generated using TypeDoc

\ No newline at end of file +

Parameters

Returns Element

Generated using TypeDoc

\ No newline at end of file diff --git a/papi-components/functions/Toolbar.html b/papi-components/functions/Toolbar.html index 27a0c487d8..76158f4093 100644 --- a/papi-components/functions/Toolbar.html +++ b/papi-components/functions/Toolbar.html @@ -1 +1 @@ -Toolbar | papi-components

Function Toolbar

Generated using TypeDoc

\ No newline at end of file +Toolbar | papi-components

Function Toolbar

Generated using TypeDoc

\ No newline at end of file diff --git a/papi-components/functions/getChaptersForBook.html b/papi-components/functions/getChaptersForBook.html index 855738bb89..b75baf9db2 100644 --- a/papi-components/functions/getChaptersForBook.html +++ b/papi-components/functions/getChaptersForBook.html @@ -1 +1 @@ -getChaptersForBook | papi-components

Function getChaptersForBook

Generated using TypeDoc

\ No newline at end of file +getChaptersForBook | papi-components

Function getChaptersForBook

Generated using TypeDoc

\ No newline at end of file diff --git a/papi-components/interfaces/ScrRefSelectorProps.html b/papi-components/interfaces/ScrRefSelectorProps.html index c28b01746d..7b2b216606 100644 --- a/papi-components/interfaces/ScrRefSelectorProps.html +++ b/papi-components/interfaces/ScrRefSelectorProps.html @@ -1,4 +1,4 @@ -ScrRefSelectorProps | papi-components

Interface ScrRefSelectorProps

interface ScrRefSelectorProps {
    handleSubmit: ((scrRef) => void);
    id?: string;
    scrRef: ScriptureReference;
}

Properties

handleSubmit +ScrRefSelectorProps | papi-components

Interface ScrRefSelectorProps

interface ScrRefSelectorProps {
    handleSubmit: ((scrRef) => void);
    id?: string;
    scrRef: ScriptureReference;
}

Properties

Properties

handleSubmit: ((scrRef) => void)

Type declaration

    • (scrRef): void
    • Parameters

      • scrRef: ScriptureReference

      Returns void

id?: string
scrRef: ScriptureReference

Generated using TypeDoc

\ No newline at end of file +

Properties

handleSubmit: ((scrRef) => void)

Type declaration

    • (scrRef): void
    • Parameters

      • scrRef: ScriptureReference

      Returns void

id?: string
scrRef: ScriptureReference

Generated using TypeDoc

\ No newline at end of file diff --git a/papi-components/interfaces/TableCalculatedColumn.html b/papi-components/interfaces/TableCalculatedColumn.html index 2f46c2944e..c523c5814f 100644 --- a/papi-components/interfaces/TableCalculatedColumn.html +++ b/papi-components/interfaces/TableCalculatedColumn.html @@ -1,4 +1,4 @@ -TableCalculatedColumn | papi-components

Interface TableCalculatedColumn<R>

interface TableCalculatedColumn {
    editable?: null | boolean | ((row) => boolean);
    frozen: boolean;
    idx: number;
    isLastFrozenColumn: boolean;
    key: string;
    maxWidth: undefined | number;
    minWidth: number;
    name: string | ReactElement<any, string | JSXElementConstructor<any>>;
    renderCell: ((props) => ReactNode);
    renderEditCell?: null | ((props) => ReactNode);
    resizable: boolean;
    rowGroup: boolean;
    sortDescendingFirst?: null | boolean;
    sortable: boolean;
    width: string | number;
}

Type Parameters

  • R

Hierarchy

Properties

editable? +TableCalculatedColumn | papi-components

Interface TableCalculatedColumn<R>

interface TableCalculatedColumn {
    editable?: null | boolean | ((row) => boolean);
    frozen: boolean;
    idx: number;
    isLastFrozenColumn: boolean;
    key: string;
    maxWidth: undefined | number;
    minWidth: number;
    name: string | ReactElement<any, string | JSXElementConstructor<any>>;
    renderCell: ((props) => ReactNode);
    renderEditCell?: null | ((props) => ReactNode);
    resizable: boolean;
    rowGroup: boolean;
    sortDescendingFirst?: null | boolean;
    sortable: boolean;
    width: string | number;
}

Type Parameters

  • R

Hierarchy

Properties

editable? frozen idx isLastFrozenColumn @@ -17,10 +17,10 @@ the default text editor will be used for editing. Note: If editable is set to 'true' and no custom renderEditCell is provided, the internal logic that sets the renderEditCell will shallow clone the column.

-

Type declaration

    • (row): boolean
    • Parameters

      • row: R

      Returns boolean

frozen: boolean
idx: number
isLastFrozenColumn: boolean
key: string

A unique key to distinguish each column

-
maxWidth: undefined | number
minWidth: number
name: string | ReactElement<any, string | JSXElementConstructor<any>>

The name of the column. By default it will be displayed in the header cell

-
renderCell: ((props) => ReactNode)

Type declaration

    • (props): ReactNode
    • Parameters

      • props: RenderCellProps<R, unknown>

      Returns ReactNode

renderEditCell?: null | ((props) => ReactNode)

Editor to be rendered when cell of column is being edited. Don't forget to also set the +

Type declaration

    • (row): boolean
    • Parameters

      • row: R

      Returns boolean

frozen: boolean
idx: number
isLastFrozenColumn: boolean
key: string

A unique key to distinguish each column

+
maxWidth: undefined | number
minWidth: number
name: string | ReactElement<any, string | JSXElementConstructor<any>>

The name of the column. By default it will be displayed in the header cell

+
renderCell: ((props) => ReactNode)

Type declaration

    • (props): ReactNode
    • Parameters

      • props: RenderCellProps<R, unknown>

      Returns ReactNode

renderEditCell?: null | ((props) => ReactNode)

Editor to be rendered when cell of column is being edited. Don't forget to also set the editable prop to true in order to enable editing.

-

Type declaration

resizable: boolean
rowGroup: boolean
sortDescendingFirst?: null | boolean

Sets the column sort order to be descending instead of ascending the first time the column is +

Type declaration

resizable: boolean
rowGroup: boolean
sortDescendingFirst?: null | boolean

Sets the column sort order to be descending instead of ascending the first time the column is sorted

-
sortable: boolean
width: string | number

Generated using TypeDoc

\ No newline at end of file +
sortable: boolean
width: string | number

Generated using TypeDoc

\ No newline at end of file diff --git a/papi-components/types/ChapterRangeSelectorProps.html b/papi-components/types/ChapterRangeSelectorProps.html index 99c08ff2e3..270b054762 100644 --- a/papi-components/types/ChapterRangeSelectorProps.html +++ b/papi-components/types/ChapterRangeSelectorProps.html @@ -1 +1 @@ -ChapterRangeSelectorProps | papi-components

Type alias ChapterRangeSelectorProps

ChapterRangeSelectorProps: {
    chapterCount: number;
    endChapter: number;
    handleSelectEndChapter: ((chapter) => void);
    handleSelectStartChapter: ((chapter) => void);
    isDisabled?: boolean;
    startChapter: number;
}

Type declaration

  • chapterCount: number
  • endChapter: number
  • handleSelectEndChapter: ((chapter) => void)
      • (chapter): void
      • Parameters

        • chapter: number

        Returns void

  • handleSelectStartChapter: ((chapter) => void)
      • (chapter): void
      • Parameters

        • chapter: number

        Returns void

  • Optional isDisabled?: boolean
  • startChapter: number

Generated using TypeDoc

\ No newline at end of file +ChapterRangeSelectorProps | papi-components

Type alias ChapterRangeSelectorProps

ChapterRangeSelectorProps: {
    chapterCount: number;
    endChapter: number;
    handleSelectEndChapter: ((chapter) => void);
    handleSelectStartChapter: ((chapter) => void);
    isDisabled?: boolean;
    startChapter: number;
}

Type declaration

  • chapterCount: number
  • endChapter: number
  • handleSelectEndChapter: ((chapter) => void)
      • (chapter): void
      • Parameters

        • chapter: number

        Returns void

  • handleSelectStartChapter: ((chapter) => void)
      • (chapter): void
      • Parameters

        • chapter: number

        Returns void

  • Optional isDisabled?: boolean
  • startChapter: number

Generated using TypeDoc

\ No newline at end of file diff --git a/papi-components/types/GridMenuProps.html b/papi-components/types/GridMenuProps.html index 9ad1f242db..6c1dcf1b41 100644 --- a/papi-components/types/GridMenuProps.html +++ b/papi-components/types/GridMenuProps.html @@ -1,3 +1,3 @@ GridMenuProps | papi-components

Type alias GridMenuProps

GridMenuProps: GridMenuInfo & {
    className?: string;
    commandHandler: CommandHandler;
    id?: string;
}

Type declaration

  • Optional className?: string

    Additional css classes to help with unique styling of the toolbar

  • commandHandler: CommandHandler
  • Optional id?: string

    Optional unique identifier

    -

Generated using TypeDoc

\ No newline at end of file +

Generated using TypeDoc

\ No newline at end of file diff --git a/papi-components/types/MenuColumn.html b/papi-components/types/MenuColumn.html index bf78ba0f36..ca459f57e2 100644 --- a/papi-components/types/MenuColumn.html +++ b/papi-components/types/MenuColumn.html @@ -1,2 +1,2 @@ MenuColumn | papi-components

Type alias MenuColumn

MenuColumn: {
    items: MenuItemInfo[];
    name: string;
}

Type declaration

  • items: MenuItemInfo[]
  • name: string

    The name of the menu (displayed as the column header).

    -

Generated using TypeDoc

\ No newline at end of file +

Generated using TypeDoc

\ No newline at end of file diff --git a/papi-components/types/TableCellClickArgs.html b/papi-components/types/TableCellClickArgs.html index 6f746fed38..6d7b4c945f 100644 --- a/papi-components/types/TableCellClickArgs.html +++ b/papi-components/types/TableCellClickArgs.html @@ -1 +1 @@ -TableCellClickArgs | papi-components

Type alias TableCellClickArgs<R>

TableCellClickArgs<R>: CellClickArgs<R>

Type Parameters

  • R

Generated using TypeDoc

\ No newline at end of file +TableCellClickArgs | papi-components

Type alias TableCellClickArgs<R>

TableCellClickArgs<R>: CellClickArgs<R>

Type Parameters

  • R

Generated using TypeDoc

\ No newline at end of file diff --git a/papi-components/types/TableCellKeyDownArgs.html b/papi-components/types/TableCellKeyDownArgs.html index cc21ce4de4..130888802c 100644 --- a/papi-components/types/TableCellKeyDownArgs.html +++ b/papi-components/types/TableCellKeyDownArgs.html @@ -1 +1 @@ -TableCellKeyDownArgs | papi-components

Type alias TableCellKeyDownArgs<R>

TableCellKeyDownArgs<R>: CellKeyDownArgs<R>

Type Parameters

  • R

Generated using TypeDoc

\ No newline at end of file +TableCellKeyDownArgs | papi-components

Type alias TableCellKeyDownArgs<R>

TableCellKeyDownArgs<R>: CellKeyDownArgs<R>

Type Parameters

  • R

Generated using TypeDoc

\ No newline at end of file diff --git a/papi-components/types/TableCellKeyboardEvent.html b/papi-components/types/TableCellKeyboardEvent.html index 99fad913c0..c8d4a57f52 100644 --- a/papi-components/types/TableCellKeyboardEvent.html +++ b/papi-components/types/TableCellKeyboardEvent.html @@ -1 +1 @@ -TableCellKeyboardEvent | papi-components

Type alias TableCellKeyboardEvent

TableCellKeyboardEvent: CellKeyboardEvent

Generated using TypeDoc

\ No newline at end of file +TableCellKeyboardEvent | papi-components

Type alias TableCellKeyboardEvent

TableCellKeyboardEvent: CellKeyboardEvent

Generated using TypeDoc

\ No newline at end of file diff --git a/papi-components/types/TableCellMouseEvent.html b/papi-components/types/TableCellMouseEvent.html index 1b9d6b3985..25dea8da77 100644 --- a/papi-components/types/TableCellMouseEvent.html +++ b/papi-components/types/TableCellMouseEvent.html @@ -1 +1 @@ -TableCellMouseEvent | papi-components

Type alias TableCellMouseEvent

TableCellMouseEvent: CellMouseEvent

Generated using TypeDoc

\ No newline at end of file +TableCellMouseEvent | papi-components

Type alias TableCellMouseEvent

TableCellMouseEvent: CellMouseEvent

Generated using TypeDoc

\ No newline at end of file diff --git a/papi-components/types/TableColumn.html b/papi-components/types/TableColumn.html index c845658406..79ea51b4c3 100644 --- a/papi-components/types/TableColumn.html +++ b/papi-components/types/TableColumn.html @@ -15,4 +15,4 @@
  • Optional Readonly sortable?: boolean

    Enable sorting of a column

  • Optional Readonly width?: number | string

    Column width. If not specified, it will be determined automatically based on grid width and specified widths of other columns

    -
  • Generated using TypeDoc

    \ No newline at end of file +

    Generated using TypeDoc

    \ No newline at end of file diff --git a/papi-components/types/TableCopyEvent.html b/papi-components/types/TableCopyEvent.html index be2578cfe0..245bfff719 100644 --- a/papi-components/types/TableCopyEvent.html +++ b/papi-components/types/TableCopyEvent.html @@ -1 +1 @@ -TableCopyEvent | papi-components

    Type alias TableCopyEvent<R>

    TableCopyEvent<R>: CopyEvent<R>

    Type Parameters

    • R

    Generated using TypeDoc

    \ No newline at end of file +TableCopyEvent | papi-components

    Type alias TableCopyEvent<R>

    TableCopyEvent<R>: CopyEvent<R>

    Type Parameters

    • R

    Generated using TypeDoc

    \ No newline at end of file diff --git a/papi-components/types/TableEditorProps.html b/papi-components/types/TableEditorProps.html index d5721820f6..89e47984c2 100644 --- a/papi-components/types/TableEditorProps.html +++ b/papi-components/types/TableEditorProps.html @@ -1 +1 @@ -TableEditorProps | papi-components

    Type alias TableEditorProps<R>

    TableEditorProps<R>: {
        column: TableCalculatedColumn<R>;
        onClose: ((commitChanges?) => void);
        onRowChange: ((row, commitChanges?) => void);
        row: R;
    }

    Type Parameters

    • R

    Type declaration

    • column: TableCalculatedColumn<R>
    • onClose: ((commitChanges?) => void)
        • (commitChanges?): void
        • Parameters

          • Optional commitChanges: boolean

          Returns void

    • onRowChange: ((row, commitChanges?) => void)
        • (row, commitChanges?): void
        • Parameters

          • row: R
          • Optional commitChanges: boolean

          Returns void

    • row: R

    Generated using TypeDoc

    \ No newline at end of file +TableEditorProps | papi-components

    Type alias TableEditorProps<R>

    TableEditorProps<R>: {
        column: TableCalculatedColumn<R>;
        onClose: ((commitChanges?) => void);
        onRowChange: ((row, commitChanges?) => void);
        row: R;
    }

    Type Parameters

    • R

    Type declaration

    • column: TableCalculatedColumn<R>
    • onClose: ((commitChanges?) => void)
        • (commitChanges?): void
        • Parameters

          • Optional commitChanges: boolean

          Returns void

    • onRowChange: ((row, commitChanges?) => void)
        • (row, commitChanges?): void
        • Parameters

          • row: R
          • Optional commitChanges: boolean

          Returns void

    • row: R

    Generated using TypeDoc

    \ No newline at end of file diff --git a/papi-components/types/TablePasteEvent.html b/papi-components/types/TablePasteEvent.html index eb58f0dd93..fb90f420c9 100644 --- a/papi-components/types/TablePasteEvent.html +++ b/papi-components/types/TablePasteEvent.html @@ -1 +1 @@ -TablePasteEvent | papi-components

    Type alias TablePasteEvent<R>

    TablePasteEvent<R>: PasteEvent<R>

    Type Parameters

    • R

    Generated using TypeDoc

    \ No newline at end of file +TablePasteEvent | papi-components

    Type alias TablePasteEvent<R>

    TablePasteEvent<R>: PasteEvent<R>

    Type Parameters

    • R

    Generated using TypeDoc

    \ No newline at end of file diff --git a/papi-components/types/TableProps.html b/papi-components/types/TableProps.html index ea061a6be5..dba4606317 100644 --- a/papi-components/types/TableProps.html +++ b/papi-components/types/TableProps.html @@ -52,4 +52,4 @@
  • Optional selectedRows?: ReadonlySet<Key>

    A set of keys representing the currently selected rows

  • Optional sortColumns?: readonly TableSortColumn[]

    An array of objects representing the currently sorted columns

    -
  • Generated using TypeDoc

    \ No newline at end of file +

    Generated using TypeDoc

    \ No newline at end of file diff --git a/papi-components/types/TableRowsChangeData.html b/papi-components/types/TableRowsChangeData.html index 8f44731aa0..37dbd5a606 100644 --- a/papi-components/types/TableRowsChangeData.html +++ b/papi-components/types/TableRowsChangeData.html @@ -1 +1 @@ -TableRowsChangeData | papi-components

    Type alias TableRowsChangeData<R>

    TableRowsChangeData<R>: RowsChangeData<R>

    Type Parameters

    • R

    Generated using TypeDoc

    \ No newline at end of file +TableRowsChangeData | papi-components

    Type alias TableRowsChangeData<R>

    TableRowsChangeData<R>: RowsChangeData<R>

    Type Parameters

    • R

    Generated using TypeDoc

    \ No newline at end of file diff --git a/papi-components/types/TableSortColumn.html b/papi-components/types/TableSortColumn.html index 8684d11d7e..9be0a057f5 100644 --- a/papi-components/types/TableSortColumn.html +++ b/papi-components/types/TableSortColumn.html @@ -1 +1 @@ -TableSortColumn | papi-components

    Type alias TableSortColumn

    TableSortColumn: SortColumn

    Generated using TypeDoc

    \ No newline at end of file +TableSortColumn | papi-components

    Type alias TableSortColumn

    TableSortColumn: SortColumn

    Generated using TypeDoc

    \ No newline at end of file diff --git a/papi-components/types/ToolbarProps.html b/papi-components/types/ToolbarProps.html index dd9ddfad72..370f51f2fa 100644 --- a/papi-components/types/ToolbarProps.html +++ b/papi-components/types/ToolbarProps.html @@ -3,4 +3,4 @@
  • Optional dataHandler?: DataHandler

    The handler to use for menu data if there is no menu provided.

  • Optional id?: string

    Optional unique identifier

  • Optional menu?: GridMenuInfo

    The optional grid menu to display. If not specified, the "hamburger" menu will not display.

    -
  • Generated using TypeDoc

    \ No newline at end of file +

    Generated using TypeDoc

    \ No newline at end of file diff --git a/papi-dts/classes/_client_services_client_network_connector_service_.default.html b/papi-dts/classes/_client_services_client_network_connector_service_.default.html index 28dd47ad3d..ad44ae74ff 100644 --- a/papi-dts/classes/_client_services_client_network_connector_service_.default.html +++ b/papi-dts/classes/_client_services_client_network_connector_service_.default.html @@ -1,5 +1,5 @@ default | papi-dts

    Handles the connection from the client to the server

    -

    Implements

    Constructors

    Implements

    Constructors

    Properties

    clientGuid: any

    Unique Guid associated with this connection. Used to verify certain things with server

    -
    connect: ((localRequestHandler, requestRouter, localEventHandler) => Promise<Readonly<{
        clientId: number;
    }>>)

    Type declaration

    connectPromise?: any

    Promise that resolves when the connection is finished or rejects if disconnected before the +

    connect: ((localRequestHandler, requestRouter, localEventHandler) => Promise<Readonly<{
        clientId: number;
    }>>)

    Type declaration

    connectPromise?: any

    Promise that resolves when the connection is finished or rejects if disconnected before the connection finishes

    -
    connectionStatus: ConnectionStatus

    Whether this connector is setting up or has finished setting up its connection and is ready to +

    connectionStatus: ConnectionStatus

    Whether this connector is setting up or has finished setting up its connection and is ready to communicate on the network

    -
    connectorInfo: Readonly<{
        clientId: number;
    }>

    Information about the connector. Populated by the server while connecting

    -

    Type declaration

    • clientId: number
    disconnect: (() => void)

    Type declaration

      • (): void
      • Returns void

    emitEventOnNetwork: (<T>(eventType, event) => Promise<void>)

    Type declaration

      • <T>(eventType, event): Promise<void>
      • Type Parameters

        • T

        Parameters

        Returns Promise<void>

    handleEventMessage: any

    Function that handles incoming webSocket messages of type Event. Runs the eventHandler provided +

    connectorInfo: Readonly<{
        clientId: number;
    }>

    Information about the connector. Populated by the server while connecting

    +

    Type declaration

    • clientId: number
    disconnect: (() => void)

    Type declaration

      • (): void
      • Returns void

    emitEventOnNetwork: (<T>(eventType, event) => Promise<void>)

    Type declaration

      • <T>(eventType, event): Promise<void>
      • Type Parameters

        • T

        Parameters

        Returns Promise<void>

    handleEventMessage: any

    Function that handles incoming webSocket messages of type Event. Runs the eventHandler provided in connect()

    Param: eventMessage

    Event message to handle

    -
    handleRequestMessage: any

    Function that handles incoming webSocket messages and locally sent messages of type Request. +

    handleRequestMessage: any

    Function that handles incoming webSocket messages and locally sent messages of type Request. Runs the requestHandler provided in connect() and sends a message with the response

    Param: requestMessage

    Request message to handle

    Param: isIncoming

    Whether this message is coming from the server and we should definitely handle it locally or if it is a locally sent request and we should send to the server if we don't have a local handler

    -
    handleResponseMessage: any

    Function that handles webSocket messages of type Response. Resolves the request associated with +

    handleResponseMessage: any

    Function that handles webSocket messages of type Response. Resolves the request associated with the received response message

    Param: response

    Response message to resolve

    -
    localEventHandler?: any

    Function to call when we receive an event. Handles events from the connection by emitting the +

    localEventHandler?: any

    Function to call when we receive an event. Handles events from the connection by emitting the event locally

    -
    localRequestHandler?: any

    Function to call when we receive a request that is registered on this connector. Handles +

    localRequestHandler?: any

    Function to call when we receive a request that is registered on this connector. Handles requests from the connection and returns a response to send back

    -
    messageEmitters: any

    All message subscriptions - emitters that emit an event each time a message with a specific +

    messageEmitters: any

    All message subscriptions - emitters that emit an event each time a message with a specific message type comes in

    -
    notifyClientConnected: (() => Promise<void>)

    Type declaration

      • (): Promise<void>
      • Returns Promise<void>

    onMessage: any

    Receives and appropriately publishes server webSocket messages

    +
    notifyClientConnected: (() => Promise<void>)

    Type declaration

      • (): Promise<void>
      • Returns Promise<void>

    onMessage: any

    Receives and appropriately publishes server webSocket messages

    Param: event

    WebSocket message information

    Param: fromSelf

    Whether this message is from this connector instead of from someone else

    -
    request: (<TParam, TReturn>(requestType, request) => Promise<InternalResponse<TReturn>>)

    Send a request to the server/a client and resolve after receiving a response

    +
    request: (<TParam, TReturn>(requestType, request) => Promise<InternalResponse<TReturn>>)

    Send a request to the server/a client and resolve after receiving a response

    Type declaration

    Param: requestType

    The type of request

    Param: contents

    Contents to send in the request

    Returns

    Promise that resolves with the response message

    -
    requestRouter?: any

    Function to call when we are sending a request. Returns a clientId to which to send the request +

    requestRouter?: any

    Function to call when we are sending a request. Returns a clientId to which to send the request based on the requestType

    -
    requests: any

    All requests that are waiting for a response

    -
    sendMessage: any

    Send a message to the server via webSocket. Throws if not connected

    +
    requests: any

    All requests that are waiting for a response

    +
    sendMessage: any

    Send a message to the server via webSocket. Throws if not connected

    Param: message

    Message to send

    -
    subscribe: any

    Subscribes a function to run on webSocket messages of a particular type

    +
    subscribe: any

    Subscribes a function to run on webSocket messages of a particular type

    Param: messageType

    The type of message on which to subscribe the function

    Param: callback

    Function to run with the contents of the webSocket message

    Returns

    Unsubscriber function to run to stop calling the passed-in function on webSocket messages

    -
    unsubscribeHandleEventMessage?: any

    Function that removes this handleEvent from the connection

    -
    unsubscribeHandleInitClientMessage?: any

    Function that removes this initClient handler from the connection

    -
    unsubscribeHandleRequestMessage?: any

    Function that removes this handleRequest from the connection

    -
    unsubscribeHandleResponseMessage?: any

    Function that removes this response handler from the connection

    -
    webSocket?: any

    The webSocket connected to the server

    -

    Generated using TypeDoc

    \ No newline at end of file +
    unsubscribeHandleEventMessage?: any

    Function that removes this handleEvent from the connection

    +
    unsubscribeHandleInitClientMessage?: any

    Function that removes this initClient handler from the connection

    +
    unsubscribeHandleRequestMessage?: any

    Function that removes this handleRequest from the connection

    +
    unsubscribeHandleResponseMessage?: any

    Function that removes this response handler from the connection

    +
    webSocket?: any

    The webSocket connected to the server

    +

    Generated using TypeDoc

    \ No newline at end of file diff --git a/papi-dts/classes/_main_services_server_network_connector_service_.default.html b/papi-dts/classes/_main_services_server_network_connector_service_.default.html index 79fc15e29f..7db3ac2dd0 100644 --- a/papi-dts/classes/_main_services_server_network_connector_service_.default.html +++ b/papi-dts/classes/_main_services_server_network_connector_service_.default.html @@ -1,5 +1,5 @@ default | papi-dts

    Handles the endpoint and connections from the server to the clients

    -

    Implements

    Constructors

    Implements

    Constructors

    Properties

    clientSockets: any

    The webSocket clients that are connected and information about them

    -
    connect: ((localRequestHandler, requestRouter, localEventHandler, networkConnectorEventHandlers) => Promise<Readonly<{
        clientId: number;
    }>>)

    Type declaration

    connectPromise?: any

    Promise that resolves when finished starting the server or rejects if disconnected before the +

    connect: ((localRequestHandler, requestRouter, localEventHandler, networkConnectorEventHandlers) => Promise<Readonly<{
        clientId: number;
    }>>)

    Type declaration

    connectPromise?: any

    Promise that resolves when finished starting the server or rejects if disconnected before the server finishes

    -
    connectionStatus: ConnectionStatus

    Whether this connector is setting up or has finished setting up its connection and is ready to +

    connectionStatus: ConnectionStatus

    Whether this connector is setting up or has finished setting up its connection and is ready to communicate on the network

    -
    connectorInfo: Readonly<{
        clientId: number;
    }>

    Information about the connector. Populated by the server while connecting

    -

    Type declaration

    • clientId: number
    disconnect: (() => void)

    Type declaration

      • (): void
      • Returns void

    disconnectClient: any

    Closes connection and unregisters a client webSocket when it has disconnected

    -
    emitEventOnNetwork: (<T>(eventType, event) => Promise<void>)

    Type declaration

      • <T>(eventType, event): Promise<void>
      • Type Parameters

        • T

        Parameters

        Returns Promise<void>

    getClientIdFromSocket: any

    Get the clientId for a certain webSocket. Throws if not found

    -
    getClientSocket: any

    Get the client socket for a certain clientId. Throws if not found

    -
    getClientSocketFromGuid: any

    Attempts to get the client socket for a certain clientGuid. Returns undefined if not found. +

    connectorInfo: Readonly<{
        clientId: number;
    }>

    Information about the connector. Populated by the server while connecting

    +

    Type declaration

    • clientId: number
    disconnect: (() => void)

    Type declaration

      • (): void
      • Returns void

    disconnectClient: any

    Closes connection and unregisters a client webSocket when it has disconnected

    +
    emitEventOnNetwork: (<T>(eventType, event) => Promise<void>)

    Type declaration

      • <T>(eventType, event): Promise<void>
      • Type Parameters

        • T

        Parameters

        Returns Promise<void>

    getClientIdFromSocket: any

    Get the clientId for a certain webSocket. Throws if not found

    +
    getClientSocket: any

    Get the client socket for a certain clientId. Throws if not found

    +
    getClientSocketFromGuid: any

    Attempts to get the client socket for a certain clientGuid. Returns undefined if not found. This does not throw because it will likely be very common that we do not have a clientId for a certain clientGuid as connecting clients will often supply old clientGuids.

    -
    handleClientConnectMessage: any

    Function that handles webSocket messages of type ClientConnect. Mark the connection fully +

    handleClientConnectMessage: any

    Function that handles webSocket messages of type ClientConnect. Mark the connection fully connected and notify that a client connected or reconnected

    Param: clientConnect

    Message from the client about the connection

    Param: connectorId

    ClientId of the client who is sending this ClientConnect message

    -
    handleEventMessage: any

    Function that handles incoming webSocket messages of type Event. Runs the eventHandler provided +

    handleEventMessage: any

    Function that handles incoming webSocket messages of type Event. Runs the eventHandler provided in connect() and forwards the event to other clients

    Param: eventMessage

    Event message to handle

    -
    handleRequestMessage: any

    Function that handles incoming webSocket messages and locally sent messages of type Request. +

    handleRequestMessage: any

    Function that handles incoming webSocket messages and locally sent messages of type Request. Handles the request and sends a response if we have a handler or forwards to the appropriate client

    Param: requestMessage

    Request to handle

    Param: requesterId

    Who sent this message

    -
    handleResponseMessage: any

    Function that handles webSocket messages of type Response. Resolves the request associated with +

    handleResponseMessage: any

    Function that handles webSocket messages of type Response. Resolves the request associated with the received response message or forwards to appropriate client

    Param: response

    Response message to resolve

    Param: responderId

    Responding client

    -
    localEventHandler?: any

    Function to call when we receive an event. Handles events from connections and emits the event +

    localEventHandler?: any

    Function to call when we receive an event. Handles events from connections and emits the event locally

    -
    localRequestHandler?: any

    Function to call when we receive a request that is registered on this connector. Handles +

    localRequestHandler?: any

    Function to call when we receive a request that is registered on this connector. Handles requests from connections and returns a response to send back

    -
    messageEmitters: any

    All message subscriptions - emitters that emit an event each time a message with a specific +

    messageEmitters: any

    All message subscriptions - emitters that emit an event each time a message with a specific message type comes in

    -
    networkConnectorEventHandlers?: any

    Functions to run when network connector events occur like when clients are disconnected

    -
    nextClientId: any

    The next client id to use for a new connection. Starts at 1 because the server is 0

    -
    notifyClientConnected: (() => Promise<void>)

    Type declaration

      • (): Promise<void>
      • Returns Promise<void>

    onClientConnect: any

    Registers an incoming webSocket connection and sends connection info with InitClient. Does not +

    networkConnectorEventHandlers?: any

    Functions to run when network connector events occur like when clients are disconnected

    +
    nextClientId: any

    The next client id to use for a new connection. Starts at 1 because the server is 0

    +
    notifyClientConnected: (() => Promise<void>)

    Type declaration

      • (): Promise<void>
      • Returns Promise<void>

    onClientConnect: any

    Registers an incoming webSocket connection and sends connection info with InitClient. Does not consider the client fully connected yet until they respond and tell us they connected with ClientConnect

    -
    onClientDisconnect: any

    Handles when client connection disconnects. Unregisters and such

    -
    onMessage: any

    Receives and appropriately publishes webSocket messages

    +
    onClientDisconnect: any

    Handles when client connection disconnects. Unregisters and such

    +
    onMessage: any

    Receives and appropriately publishes webSocket messages

    Param: event

    WebSocket message information

    Param: fromSelf

    Whether this message is from this connector instead of from someone else

    -
    request: (<TParam, TReturn>(requestType, request) => Promise<InternalResponse<TReturn>>)

    Send a request to the server/a client and resolve after receiving a response

    +
    request: (<TParam, TReturn>(requestType, request) => Promise<InternalResponse<TReturn>>)

    Send a request to the server/a client and resolve after receiving a response

    Type declaration

    Param: requestType

    The type of request

    Param: contents

    Contents to send in the request

    Returns

    Promise that resolves with the response message

    -
    requestRouter?: any

    Function to call when we are sending a request. Returns a clientId to which to send the request +

    requestRouter?: any

    Function to call when we are sending a request. Returns a clientId to which to send the request based on the requestType

    -
    requests: any

    All requests that are waiting for a response

    -
    sendMessage: any

    Send a message to a client via webSocket. Throws if not connected

    +
    requests: any

    All requests that are waiting for a response

    +
    sendMessage: any

    Send a message to a client via webSocket. Throws if not connected

    Param: message

    Message to send

    Param: recipientId

    The client to which to send the message. TODO: determine if we can intuit this instead

    -
    subscribe: any

    Subscribes a function to run on webSocket messages of a particular type

    +
    subscribe: any

    Subscribes a function to run on webSocket messages of a particular type

    Param: messageType

    The type of message on which to subscribe the function

    Param: callback

    Function to run with the contents of the webSocket message

    Returns

    Unsubscriber function to run to stop calling the passed-in function on webSocket messages

    -
    unsubscribeHandleClientConnectMessage?: any

    Function that removes this clientConnect handler from connections

    -
    unsubscribeHandleEventMessage?: any

    Function that removes this handleEvent from the connection

    -
    unsubscribeHandleRequestMessage?: any

    Function that removes this handleRequest from connections

    -
    unsubscribeHandleResponseMessage?: any

    Function that removes this response handler from connections

    -
    webSocketServer?: any

    The webSocket connected to the server

    -

    Generated using TypeDoc

    \ No newline at end of file +
    unsubscribeHandleClientConnectMessage?: any

    Function that removes this clientConnect handler from connections

    +
    unsubscribeHandleEventMessage?: any

    Function that removes this handleEvent from the connection

    +
    unsubscribeHandleRequestMessage?: any

    Function that removes this handleRequest from connections

    +
    unsubscribeHandleResponseMessage?: any

    Function that removes this response handler from connections

    +
    webSocketServer?: any

    The webSocket connected to the server

    +

    Generated using TypeDoc

    \ No newline at end of file diff --git a/papi-dts/classes/_node_models_execution_token_model_.ExecutionToken.html b/papi-dts/classes/_node_models_execution_token_model_.ExecutionToken.html index 4d421adf03..9662924a28 100644 --- a/papi-dts/classes/_node_models_execution_token_model_.ExecutionToken.html +++ b/papi-dts/classes/_node_models_execution_token_model_.ExecutionToken.html @@ -1,7 +1,7 @@ ExecutionToken | papi-dts

    Execution tokens can be passed into API calls to provide context about their identity

    -

    Constructors

    Constructors

    Properties

    Methods

    Constructors

    Properties

    name: string
    nonce: string
    type: "extension"

    Methods

    Generated using TypeDoc

    \ No newline at end of file +

    Constructors

    Properties

    name: string
    nonce: string
    type: "extension"

    Methods

    Generated using TypeDoc

    \ No newline at end of file diff --git a/papi-dts/classes/_renderer_services_renderer_web_socket_service_.default.html b/papi-dts/classes/_renderer_services_renderer_web_socket_service_.default.html index ad5b932227..240dc71d86 100644 --- a/papi-dts/classes/_renderer_services_renderer_web_socket_service_.default.html +++ b/papi-dts/classes/_renderer_services_renderer_web_socket_service_.default.html @@ -2,7 +2,7 @@ better control over internet access. It is isomorphic with the standard WebSocket, so it should act as a drop-in replacement.

    Note that the Node WebSocket implementation is different and not wrapped here.

    -

    Implements

    Constructors

    Implements

    • WebSocket

    Constructors

    Properties

    Constructors

    Properties

    CLOSED: 3
    CLOSING: 2
    CONNECTING: 0
    OPEN: 1
    addEventListener: (<K>(type, listener, options?) => void)

    Type declaration

      • <K>(type, listener, options?): void
      • Type Parameters

        • K extends keyof WebSocketEventMap

        Parameters

        • type: K
        • listener: ((this, ev) => any)
            • (this, ev): any
            • Parameters

              • this: WebSocket
              • ev: WebSocketEventMap[K]

              Returns any

        • Optional options: boolean | AddEventListenerOptions

        Returns void

    binaryType: BinaryType
    bufferedAmount: number
    close: ((code?, reason?) => void)

    Type declaration

      • (code?, reason?): void
      • Parameters

        • Optional code: number
        • Optional reason: string

        Returns void

    dispatchEvent: ((event) => boolean)

    Type declaration

      • (event): boolean
      • Parameters

        • event: Event

        Returns boolean

    extensions: string
    onclose: null | ((this, ev) => any)

    Type declaration

      • (this, ev): any
      • Parameters

        • this: WebSocket
        • ev: CloseEvent

        Returns any

    onerror: null | ((this, ev) => any)

    Type declaration

      • (this, ev): any
      • Parameters

        • this: WebSocket
        • ev: Event

        Returns any

    onmessage: null | ((this, ev) => any)

    Type declaration

      • (this, ev): any
      • Parameters

        • this: WebSocket
        • ev: MessageEvent<any>

        Returns any

    onopen: null | ((this, ev) => any)

    Type declaration

      • (this, ev): any
      • Parameters

        • this: WebSocket
        • ev: Event

        Returns any

    protocol: string
    readyState: number
    removeEventListener: (<K>(type, listener, options?) => void)

    Type declaration

      • <K>(type, listener, options?): void
      • Type Parameters

        • K extends keyof WebSocketEventMap

        Parameters

        • type: K
        • listener: ((this, ev) => any)
            • (this, ev): any
            • Parameters

              • this: WebSocket
              • ev: WebSocketEventMap[K]

              Returns any

        • Optional options: boolean | EventListenerOptions

        Returns void

    send: ((data) => void)

    Type declaration

      • (data): void
      • Parameters

        • data: string | ArrayBufferLike | ArrayBufferView | Blob

        Returns void

    url: string

    Generated using TypeDoc

    \ No newline at end of file +

    Constructors

    Properties

    CLOSED: 3
    CLOSING: 2
    CONNECTING: 0
    OPEN: 1
    addEventListener: (<K>(type, listener, options?) => void)

    Type declaration

      • <K>(type, listener, options?): void
      • Type Parameters

        • K extends keyof WebSocketEventMap

        Parameters

        • type: K
        • listener: ((this, ev) => any)
            • (this, ev): any
            • Parameters

              • this: WebSocket
              • ev: WebSocketEventMap[K]

              Returns any

        • Optional options: boolean | AddEventListenerOptions

        Returns void

    binaryType: BinaryType
    bufferedAmount: number
    close: ((code?, reason?) => void)

    Type declaration

      • (code?, reason?): void
      • Parameters

        • Optional code: number
        • Optional reason: string

        Returns void

    dispatchEvent: ((event) => boolean)

    Type declaration

      • (event): boolean
      • Parameters

        • event: Event

        Returns boolean

    extensions: string
    onclose: null | ((this, ev) => any)

    Type declaration

      • (this, ev): any
      • Parameters

        • this: WebSocket
        • ev: CloseEvent

        Returns any

    onerror: null | ((this, ev) => any)

    Type declaration

      • (this, ev): any
      • Parameters

        • this: WebSocket
        • ev: Event

        Returns any

    onmessage: null | ((this, ev) => any)

    Type declaration

      • (this, ev): any
      • Parameters

        • this: WebSocket
        • ev: MessageEvent<any>

        Returns any

    onopen: null | ((this, ev) => any)

    Type declaration

      • (this, ev): any
      • Parameters

        • this: WebSocket
        • ev: Event

        Returns any

    protocol: string
    readyState: number
    removeEventListener: (<K>(type, listener, options?) => void)

    Type declaration

      • <K>(type, listener, options?): void
      • Type Parameters

        • K extends keyof WebSocketEventMap

        Parameters

        • type: K
        • listener: ((this, ev) => any)
            • (this, ev): any
            • Parameters

              • this: WebSocket
              • ev: WebSocketEventMap[K]

              Returns any

        • Optional options: boolean | EventListenerOptions

        Returns void

    send: ((data) => void)

    Type declaration

      • (data): void
      • Parameters

        • data: string | ArrayBufferLike | ArrayBufferView | Blob

        Returns void

    url: string

    Generated using TypeDoc

    \ No newline at end of file diff --git a/papi-dts/classes/_renderer_services_renderer_xml_http_request_service_.default.html b/papi-dts/classes/_renderer_services_renderer_xml_http_request_service_.default.html index 6e7937039d..16e5cc5e46 100644 --- a/papi-dts/classes/_renderer_services_renderer_xml_http_request_service_.default.html +++ b/papi-dts/classes/_renderer_services_renderer_xml_http_request_service_.default.html @@ -2,7 +2,7 @@ provide better control over internet access. It is isomorphic with the standard XMLHttpRequest, so it should act as a drop-in replacement.

    Note that Node doesn't have a native implementation, so this is only for the renderer.

    -

    Implements

    Constructors

    Implements

    • XMLHttpRequest

    Constructors

    Properties

    Constructors

    Properties

    DONE: 4
    HEADERS_RECEIVED: 2
    LOADING: 3
    OPENED: 1
    UNSENT: 0
    abort: (() => void)

    Type declaration

      • (): void
      • Returns void

    addEventListener: (<K>(type, listener, options?) => void)

    Type declaration

      • <K>(type, listener, options?): void
      • Type Parameters

        • K extends keyof XMLHttpRequestEventMap

        Parameters

        • type: K
        • listener: ((this, ev) => any)
            • (this, ev): any
            • Parameters

              • this: XMLHttpRequest
              • ev: XMLHttpRequestEventMap[K]

              Returns any

        • Optional options: boolean | AddEventListenerOptions

        Returns void

    dispatchEvent: ((event) => boolean)

    Type declaration

      • (event): boolean
      • Parameters

        • event: Event

        Returns boolean

    getAllResponseHeaders: (() => string)

    Type declaration

      • (): string
      • Returns string

    getResponseHeader: ((name) => null | string)

    Type declaration

      • (name): null | string
      • Parameters

        • name: string

        Returns null | string

    onabort: null | ((this, ev) => any)

    Type declaration

      • (this, ev): any
      • Parameters

        • this: XMLHttpRequest
        • ev: ProgressEvent<EventTarget>

        Returns any

    onerror: null | ((this, ev) => any)

    Type declaration

      • (this, ev): any
      • Parameters

        • this: XMLHttpRequest
        • ev: ProgressEvent<EventTarget>

        Returns any

    onload: null | ((this, ev) => any)

    Type declaration

      • (this, ev): any
      • Parameters

        • this: XMLHttpRequest
        • ev: ProgressEvent<EventTarget>

        Returns any

    onloadend: null | ((this, ev) => any)

    Type declaration

      • (this, ev): any
      • Parameters

        • this: XMLHttpRequest
        • ev: ProgressEvent<EventTarget>

        Returns any

    onloadstart: null | ((this, ev) => any)

    Type declaration

      • (this, ev): any
      • Parameters

        • this: XMLHttpRequest
        • ev: ProgressEvent<EventTarget>

        Returns any

    onprogress: null | ((this, ev) => any)

    Type declaration

      • (this, ev): any
      • Parameters

        • this: XMLHttpRequest
        • ev: ProgressEvent<EventTarget>

        Returns any

    onreadystatechange: null | ((this, ev) => any)

    Type declaration

      • (this, ev): any
      • Parameters

        • this: XMLHttpRequest
        • ev: Event

        Returns any

    ontimeout: null | ((this, ev) => any)

    Type declaration

      • (this, ev): any
      • Parameters

        • this: XMLHttpRequest
        • ev: ProgressEvent<EventTarget>

        Returns any

    open: ((method, url, async?, username?, password?) => void)

    Type declaration

      • (method, url, async?, username?, password?): void
      • Parameters

        • method: string
        • url: string
        • Optional async: boolean
        • Optional username: null | string
        • Optional password: null | string

        Returns void

    overrideMimeType: ((mime) => void)

    Type declaration

      • (mime): void
      • Parameters

        • mime: string

        Returns void

    readyState: number
    removeEventListener: (<K>(type, listener, options?) => void)

    Type declaration

      • <K>(type, listener, options?): void
      • Type Parameters

        • K extends keyof XMLHttpRequestEventMap

        Parameters

        • type: K
        • listener: ((this, ev) => any)
            • (this, ev): any
            • Parameters

              • this: XMLHttpRequest
              • ev: XMLHttpRequestEventMap[K]

              Returns any

        • Optional options: boolean | EventListenerOptions

        Returns void

    response: any
    responseText: string
    responseType: XMLHttpRequestResponseType
    responseURL: string
    responseXML: null | Document
    send: ((body?) => void)

    Type declaration

      • (body?): void
      • Parameters

        • Optional body: null | Document | XMLHttpRequestBodyInit

        Returns void

    setRequestHeader: ((name, value) => void)

    Type declaration

      • (name, value): void
      • Parameters

        • name: string
        • value: string

        Returns void

    status: number
    statusText: string
    timeout: number
    upload: XMLHttpRequestUpload
    withCredentials: boolean

    Generated using TypeDoc

    \ No newline at end of file +

    Constructors

    Properties

    DONE: 4
    HEADERS_RECEIVED: 2
    LOADING: 3
    OPENED: 1
    UNSENT: 0
    abort: (() => void)

    Type declaration

      • (): void
      • Returns void

    addEventListener: (<K>(type, listener, options?) => void)

    Type declaration

      • <K>(type, listener, options?): void
      • Type Parameters

        • K extends keyof XMLHttpRequestEventMap

        Parameters

        • type: K
        • listener: ((this, ev) => any)
            • (this, ev): any
            • Parameters

              • this: XMLHttpRequest
              • ev: XMLHttpRequestEventMap[K]

              Returns any

        • Optional options: boolean | AddEventListenerOptions

        Returns void

    dispatchEvent: ((event) => boolean)

    Type declaration

      • (event): boolean
      • Parameters

        • event: Event

        Returns boolean

    getAllResponseHeaders: (() => string)

    Type declaration

      • (): string
      • Returns string

    getResponseHeader: ((name) => null | string)

    Type declaration

      • (name): null | string
      • Parameters

        • name: string

        Returns null | string

    onabort: null | ((this, ev) => any)

    Type declaration

      • (this, ev): any
      • Parameters

        • this: XMLHttpRequest
        • ev: ProgressEvent<EventTarget>

        Returns any

    onerror: null | ((this, ev) => any)

    Type declaration

      • (this, ev): any
      • Parameters

        • this: XMLHttpRequest
        • ev: ProgressEvent<EventTarget>

        Returns any

    onload: null | ((this, ev) => any)

    Type declaration

      • (this, ev): any
      • Parameters

        • this: XMLHttpRequest
        • ev: ProgressEvent<EventTarget>

        Returns any

    onloadend: null | ((this, ev) => any)

    Type declaration

      • (this, ev): any
      • Parameters

        • this: XMLHttpRequest
        • ev: ProgressEvent<EventTarget>

        Returns any

    onloadstart: null | ((this, ev) => any)

    Type declaration

      • (this, ev): any
      • Parameters

        • this: XMLHttpRequest
        • ev: ProgressEvent<EventTarget>

        Returns any

    onprogress: null | ((this, ev) => any)

    Type declaration

      • (this, ev): any
      • Parameters

        • this: XMLHttpRequest
        • ev: ProgressEvent<EventTarget>

        Returns any

    onreadystatechange: null | ((this, ev) => any)

    Type declaration

      • (this, ev): any
      • Parameters

        • this: XMLHttpRequest
        • ev: Event

        Returns any

    ontimeout: null | ((this, ev) => any)

    Type declaration

      • (this, ev): any
      • Parameters

        • this: XMLHttpRequest
        • ev: ProgressEvent<EventTarget>

        Returns any

    open: ((method, url, async?, username?, password?) => void)

    Type declaration

      • (method, url, async?, username?, password?): void
      • Parameters

        • method: string
        • url: string
        • Optional async: boolean
        • Optional username: null | string
        • Optional password: null | string

        Returns void

    overrideMimeType: ((mime) => void)

    Type declaration

      • (mime): void
      • Parameters

        • mime: string

        Returns void

    readyState: number
    removeEventListener: (<K>(type, listener, options?) => void)

    Type declaration

      • <K>(type, listener, options?): void
      • Type Parameters

        • K extends keyof XMLHttpRequestEventMap

        Parameters

        • type: K
        • listener: ((this, ev) => any)
            • (this, ev): any
            • Parameters

              • this: XMLHttpRequest
              • ev: XMLHttpRequestEventMap[K]

              Returns any

        • Optional options: boolean | EventListenerOptions

        Returns void

    response: any
    responseText: string
    responseType: XMLHttpRequestResponseType
    responseURL: string
    responseXML: null | Document
    send: ((body?) => void)

    Type declaration

      • (body?): void
      • Parameters

        • Optional body: null | Document | XMLHttpRequestBodyInit

        Returns void

    setRequestHeader: ((name, value) => void)

    Type declaration

      • (name, value): void
      • Parameters

        • name: string
        • value: string

        Returns void

    status: number
    statusText: string
    timeout: number
    upload: XMLHttpRequestUpload
    withCredentials: boolean

    Generated using TypeDoc

    \ No newline at end of file diff --git a/papi-dts/classes/_shared_models_papi_event_emitter_model_.default.html b/papi-dts/classes/_shared_models_papi_event_emitter_model_.default.html index 875e3174b4..b0dfdb3ef0 100644 --- a/papi-dts/classes/_shared_models_papi_event_emitter_model_.default.html +++ b/papi-dts/classes/_shared_models_papi_event_emitter_model_.default.html @@ -3,7 +3,7 @@ eventEmitter.emit(event) to run the subscriptions. Generally, this EventEmitter should be private, and its event should be public. That way, the emitter is not publicized, but anyone can subscribe to the event.

    -

    Type Parameters

    Hierarchy

    Implements

    Constructors

    Type Parameters

    • T

    Hierarchy

    Implements

    Constructors

    Properties

    dispose emit isDisposed @@ -16,23 +16,23 @@ emitFn

    Constructors

    Properties

    dispose: (() => Promise<boolean>)

    Release resources and notify dependent services when tearing down an object

    Type declaration

      • (): Promise<boolean>
      • Disposes of this event, preparing it to release from memory

        -

        Returns Promise<boolean>

    emit: ((event) => void)

    Type declaration

      • (event): void
      • Runs the subscriptions for the event

        +

        Returns Promise<boolean>

    emit: ((event) => void)

    Type declaration

      • (event): void
      • Runs the subscriptions for the event

        Parameters

        • event: T

          Event data to provide to subscribed callbacks

          -

        Returns void

    isDisposed: any

    Whether this emitter has been disposed

    -
    lazyEvent?: any

    Event for listeners to subscribe to. Lazy loaded

    -
    subscribe: PapiEvent<T>

    Subscribes a function to run when this event is emitted.

    +

    Returns void

    isDisposed: any

    Whether this emitter has been disposed

    +
    lazyEvent?: any

    Event for listeners to subscribe to. Lazy loaded

    +
    subscribe: PapiEvent<T>

    Subscribes a function to run when this event is emitted.

    Param: callback

    Function to run with the event when it is emitted

    Returns

    Unsubscriber function to run to stop calling the passed-in function when the event is emitted

    Alias

    event

    -
    subscriptions?: any

    All callback functions that will run when this event is emitted. Lazy loaded

    -

    Accessors

    subscriptions?: any

    All callback functions that will run when this event is emitted. Lazy loaded

    +

    Accessors

    Methods

    Methods

    Generated using TypeDoc

    \ No newline at end of file +

    Parameters

    Returns void

    Generated using TypeDoc

    \ No newline at end of file diff --git a/papi-dts/classes/_shared_models_papi_network_event_emitter_model_.default.html b/papi-dts/classes/_shared_models_papi_network_event_emitter_model_.default.html index b9d496ebf0..04012f020b 100644 --- a/papi-dts/classes/_shared_models_papi_network_event_emitter_model_.default.html +++ b/papi-dts/classes/_shared_models_papi_network_event_emitter_model_.default.html @@ -7,7 +7,7 @@

    WARNING: Do not use this class directly outside of NetworkService, or it will not do what you expect. Use NetworkService.createNetworkEventEmitter.

    WARNING: You cannot emit events with complex types on the network.

    -

    Type Parameters

    Hierarchy

    Constructors

    Type Parameters

    • T

    Hierarchy

    Constructors

    Properties

    dispose emit networkDisposer @@ -22,23 +22,23 @@

    Type Parameters

    • T

    Parameters

    • networkSubscriber: PapiEventHandler<T>

      Callback that accepts the event and emits it to other processes

    • networkDisposer: (() => void)

      Callback that unlinks this emitter from the network

        • (): void
        • Callback that runs when the emitter is disposed - should handle unlinking from the network

          -

          Returns void

    Returns "shared/models/papi-network-event-emitter.model".default<T>

    Properties

    dispose: (() => Promise<boolean>)

    Release resources and notify dependent services when tearing down an object

    -

    Type declaration

      • (): Promise<boolean>
      • Returns Promise<boolean>

    emit: ((event) => void)

    Type declaration

      • (event): void
      • Parameters

        • event: T

        Returns void

    networkDisposer: any

    Callback that runs when the emitter is disposed - should handle unlinking from the network

    -
    networkSubscriber: any

    Callback that sends the event to other processes on the network when it is emitted

    -
    subscribe: PapiEvent<T>

    Subscribes a function to run when this event is emitted.

    +

    Returns void

    Returns "shared/models/papi-network-event-emitter.model".default<T>

    Properties

    dispose: (() => Promise<boolean>)

    Release resources and notify dependent services when tearing down an object

    +

    Type declaration

      • (): Promise<boolean>
      • Returns Promise<boolean>

    emit: ((event) => void)

    Type declaration

      • (event): void
      • Parameters

        • event: T

        Returns void

    networkDisposer: any

    Callback that runs when the emitter is disposed - should handle unlinking from the network

    +
    networkSubscriber: any

    Callback that sends the event to other processes on the network when it is emitted

    +
    subscribe: PapiEvent<T>

    Subscribes a function to run when this event is emitted.

    Param: callback

    Function to run with the event when it is emitted

    Returns

    Unsubscriber function to run to stop calling the passed-in function when the event is emitted

    Alias

    event

    -

    Accessors

    Accessors

    Methods

    Methods

    Generated using TypeDoc

    \ No newline at end of file +

    Returns void

    Generated using TypeDoc

    \ No newline at end of file diff --git a/papi-dts/classes/_shared_services_data_provider_service_.DataProviderEngine.html b/papi-dts/classes/_shared_services_data_provider_service_.DataProviderEngine.html index 197307c0df..0b9cb3958e 100644 --- a/papi-dts/classes/_shared_services_data_provider_service_.DataProviderEngine.html +++ b/papi-dts/classes/_shared_services_data_provider_service_.DataProviderEngine.html @@ -2,6 +2,6 @@ data provider engine class extends this class, it doesn't have to specify its own notifyUpdate function in order to use notifyUpdate.

    See

    IDataProviderEngine for more information on extending this class.

    -

    Type Parameters

    Constructors

    Type Parameters

    Constructors

    Properties

    Constructors

    Properties

    notifyUpdate: DataProviderEngineNotifyUpdate<TDataTypes>

    Generated using TypeDoc

    \ No newline at end of file +

    Constructors

    Properties

    notifyUpdate: DataProviderEngineNotifyUpdate<TDataTypes>

    Generated using TypeDoc

    \ No newline at end of file diff --git a/papi-dts/classes/_shared_utils_async_variable_.default.html b/papi-dts/classes/_shared_utils_async_variable_.default.html index 83e9ef4026..9585b378e4 100644 --- a/papi-dts/classes/_shared_utils_async_variable_.default.html +++ b/papi-dts/classes/_shared_utils_async_variable_.default.html @@ -1,5 +1,5 @@ default | papi-dts

    This class provides a convenient way for one task to wait on a variable that another task sets.

    -

    Type Parameters

    • T

    Constructors

    Type Parameters

    • T

    Constructors

    Properties

    complete promiseToValue rejecter @@ -14,18 +14,18 @@
  • Optional rejectIfNotSettledWithinMS: number

    Milliseconds to wait before verifying if the promise was settled (resolved or rejected); will reject if it has not settled by that time. Use -1 if you do not want a timeout at all.

    -
  • Returns "shared/utils/async-variable".default<T>

    Properties

    complete: any

    Prevent any further updates to this variable

    -
    promiseToValue: any
    rejecter: any
    resolver: any
    variableName: any

    Accessors

    • get hasSettled(): boolean
    • A simple way to see if this variable's promise was resolved or rejected already

      +

    Returns "shared/utils/async-variable".default<T>

    Properties

    complete: any

    Prevent any further updates to this variable

    +
    promiseToValue: any
    rejecter: any
    resolver: any
    variableName: any

    Accessors

    • get hasSettled(): boolean
    • A simple way to see if this variable's promise was resolved or rejected already

      Returns boolean

      Whether the variable was already resolved or rejected

      -
    • get promise(): Promise<T>
    • Get this variable's promise to a value. This always returns the same promise even after the +

    • get promise(): Promise<T>
    • Get this variable's promise to a value. This always returns the same promise even after the value has been resolved or rejected.

      Returns Promise<T>

      The promise for the value to be set

      -

    Methods

    • Reject this variable's promise for the value with the given reason

      +

    Methods

    • Reject this variable's promise for the value with the given reason

      Parameters

      • reason: string

        This variable's promise will be rejected with this reason

      • Optional throwIfAlreadySettled: boolean

        Determines whether to throw if the variable was already resolved or rejected

        -

      Returns void

    • Resolve this variable's promise to the given value

      +

    Returns void

    Generated using TypeDoc

    \ No newline at end of file +

    Returns void

    Generated using TypeDoc

    \ No newline at end of file diff --git a/papi-dts/classes/_shared_utils_unsubscriber_async_list_.default.html b/papi-dts/classes/_shared_utils_unsubscriber_async_list_.default.html index ac593195bb..c4961754cd 100644 --- a/papi-dts/classes/_shared_utils_unsubscriber_async_list_.default.html +++ b/papi-dts/classes/_shared_utils_unsubscriber_async_list_.default.html @@ -1,11 +1,11 @@ default | papi-dts

    Simple collection for UnsubscriberAsync objects that also provides an easy way to run them.

    -

    Constructors

    Constructors

    Properties

    Methods

    Constructors

    Properties

    name: any
    unsubscribers: Set<Unsubscriber | UnsubscriberAsync>

    Methods

    • Add unsubscribers to the list. Note that duplicates are not added twice.

      +

    Constructors

    Properties

    name: any
    unsubscribers: Set<Unsubscriber | UnsubscriberAsync>

    Methods

    • Run all unsubscribers added to this list and then clear the list.

      +

    Returns void

    Generated using TypeDoc

    \ No newline at end of file +

    Generated using TypeDoc

    \ No newline at end of file diff --git a/papi-dts/enums/_node_services_node_file_system_service_.EntryType.html b/papi-dts/enums/_node_services_node_file_system_service_.EntryType.html index 60f98aca58..aab7a99afc 100644 --- a/papi-dts/enums/_node_services_node_file_system_service_.EntryType.html +++ b/papi-dts/enums/_node_services_node_file_system_service_.EntryType.html @@ -1,5 +1,5 @@ EntryType | papi-dts

    Type of file system item in a directory

    -

    Enumeration Members

    Enumeration Members

    Enumeration Members

    Directory: "directory"
    File: "file"
    Unknown: "unknown"

    Generated using TypeDoc

    \ No newline at end of file +

    Enumeration Members

    Directory: "directory"
    File: "file"
    Unknown: "unknown"

    Generated using TypeDoc

    \ No newline at end of file diff --git a/papi-dts/enums/_shared_data_internal_connection_model_.ConnectionStatus.html b/papi-dts/enums/_shared_data_internal_connection_model_.ConnectionStatus.html index 64c714b86c..d4764e719d 100644 --- a/papi-dts/enums/_shared_data_internal_connection_model_.ConnectionStatus.html +++ b/papi-dts/enums/_shared_data_internal_connection_model_.ConnectionStatus.html @@ -1,9 +1,9 @@ ConnectionStatus | papi-dts

    Whether this connector is setting up or has finished setting up its connection and is ready to communicate on the network

    -

    Enumeration Members

    Enumeration Members

    Enumeration Members

    Connected: 2

    This connector has finished setting up its connection - has connectorInfo and such

    -
    Connecting: 1

    This connector is attempting to connect to the network and retrieve connectorInfo

    -
    Disconnected: 0

    This connector is not connected to the network

    -

    Generated using TypeDoc

    \ No newline at end of file +
    Connecting: 1

    This connector is attempting to connect to the network and retrieve connectorInfo

    +
    Disconnected: 0

    This connector is not connected to the network

    +

    Generated using TypeDoc

    \ No newline at end of file diff --git a/papi-dts/enums/_shared_data_network_connector_model_.MessageType.html b/papi-dts/enums/_shared_data_network_connector_model_.MessageType.html index e40b2a3c59..06742bd957 100644 --- a/papi-dts/enums/_shared_data_network_connector_model_.MessageType.html +++ b/papi-dts/enums/_shared_data_network_connector_model_.MessageType.html @@ -1,7 +1,7 @@ MessageType | papi-dts

    WebSocket message type that indicates how to handle it

    -

    Enumeration Members

    Enumeration Members

    ClientConnect: "client-connect"
    Event: "event"
    InitClient: "init-client"
    Request: "request"
    Response: "response"

    Generated using TypeDoc

    \ No newline at end of file +

    Enumeration Members

    ClientConnect: "client-connect"
    Event: "event"
    InitClient: "init-client"
    Request: "request"
    Response: "response"

    Generated using TypeDoc

    \ No newline at end of file diff --git a/papi-dts/enums/_shared_global_this_model_.ProcessType.html b/papi-dts/enums/_shared_global_this_model_.ProcessType.html index c38075ef0d..49fb7bab86 100644 --- a/papi-dts/enums/_shared_global_this_model_.ProcessType.html +++ b/papi-dts/enums/_shared_global_this_model_.ProcessType.html @@ -1,5 +1,5 @@ ProcessType | papi-dts

    Type of Paranext process

    -

    Enumeration Members

    Enumeration Members

    Enumeration Members

    ExtensionHost: "extension-host"
    Main: "main"
    Renderer: "renderer"

    Generated using TypeDoc

    \ No newline at end of file +

    Enumeration Members

    ExtensionHost: "extension-host"
    Main: "main"
    Renderer: "renderer"

    Generated using TypeDoc

    \ No newline at end of file diff --git a/papi-dts/enums/_shared_models_web_view_model_.WebViewContentType.html b/papi-dts/enums/_shared_models_web_view_model_.WebViewContentType.html index 11e00cfe7a..9c00faf5bf 100644 --- a/papi-dts/enums/_shared_models_web_view_model_.WebViewContentType.html +++ b/papi-dts/enums/_shared_models_web_view_model_.WebViewContentType.html @@ -1,11 +1,11 @@ WebViewContentType | papi-dts

    The type of code that defines a webview's content

    -

    Enumeration Members

    Enumeration Members

    Enumeration Members

    HTML: "html"

    This webview is a raw HTML/JS/CSS webview.

    -
    React: "react"

    This webview is a React webview. It must specify its component by setting it to +

    React: "react"

    This webview is a React webview. It must specify its component by setting it to globalThis.webViewComponent

    -
    URL: "url"

    This webview's content is fetched from the url specified (iframe src attribute). Note that +

    URL: "url"

    This webview's content is fetched from the url specified (iframe src attribute). Note that webViews of this type cannot access the papi because they cannot be on the same origin as the parent window.

    -

    Generated using TypeDoc

    \ No newline at end of file +

    Generated using TypeDoc

    \ No newline at end of file diff --git a/papi-dts/enums/_shared_utils_papi_util_.RequestHandlerType.html b/papi-dts/enums/_shared_utils_papi_util_.RequestHandlerType.html index a9967e463b..781bc7680d 100644 --- a/papi-dts/enums/_shared_utils_papi_util_.RequestHandlerType.html +++ b/papi-dts/enums/_shared_utils_papi_util_.RequestHandlerType.html @@ -1,5 +1,5 @@ RequestHandlerType | papi-dts

    Type of request handler - indicates what type of parameters and what return type the handler has

    -

    Enumeration Members

    Enumeration Members

    Enumeration Members

    Args: "args"
    Complex: "complex"
    Contents: "contents"

    Generated using TypeDoc

    \ No newline at end of file +

    Enumeration Members

    Args: "args"
    Complex: "complex"
    Contents: "contents"

    Generated using TypeDoc

    \ No newline at end of file diff --git a/papi-dts/functions/_client_services_web_socket_factory_.createWebSocket.html b/papi-dts/functions/_client_services_web_socket_factory_.createWebSocket.html index 0689bc445e..8c5f4d4e05 100644 --- a/papi-dts/functions/_client_services_web_socket_factory_.createWebSocket.html +++ b/papi-dts/functions/_client_services_web_socket_factory_.createWebSocket.html @@ -1,3 +1,3 @@ createWebSocket | papi-dts
    • Creates a WebSocket for the renderer or extension host depending on where you're running

      Parameters

      • url: string

      Returns Promise<WebSocket>

      WebSocket

      -

    Generated using TypeDoc

    \ No newline at end of file +

    Generated using TypeDoc

    \ No newline at end of file diff --git a/papi-dts/functions/_extension_host_services_extension_storage_service_.buildExtensionPathFromName.html b/papi-dts/functions/_extension_host_services_extension_storage_service_.buildExtensionPathFromName.html index 7efec059c2..0e2a2e5a1f 100644 --- a/papi-dts/functions/_extension_host_services_extension_storage_service_.buildExtensionPathFromName.html +++ b/papi-dts/functions/_extension_host_services_extension_storage_service_.buildExtensionPathFromName.html @@ -1,2 +1,2 @@ buildExtensionPathFromName | papi-dts
    • Return a path to the specified file within the extension's installation directory

      -

      Parameters

      • extensionName: string
      • fileName: string

      Returns string

    Generated using TypeDoc

    \ No newline at end of file +

    Parameters

    Returns string

    Generated using TypeDoc

    \ No newline at end of file diff --git a/papi-dts/functions/_extension_host_services_extension_storage_service_.setExtensionUris.html b/papi-dts/functions/_extension_host_services_extension_storage_service_.setExtensionUris.html index e198c04dad..692db6ae28 100644 --- a/papi-dts/functions/_extension_host_services_extension_storage_service_.setExtensionUris.html +++ b/papi-dts/functions/_extension_host_services_extension_storage_service_.setExtensionUris.html @@ -1,3 +1,3 @@ setExtensionUris | papi-dts
    • This is only intended to be called by the extension service. This service cannot call into the extension service or it causes a circular dependency.

      -

      Parameters

      • urisPerExtension: Map<string, string>

      Returns void

    Generated using TypeDoc

    \ No newline at end of file +

    Parameters

    Returns void

    Generated using TypeDoc

    \ No newline at end of file diff --git a/papi-dts/functions/_node_services_node_file_system_service_.copyFile.html b/papi-dts/functions/_node_services_node_file_system_service_.copyFile.html index 1b808fcb9a..b984ff0e66 100644 --- a/papi-dts/functions/_node_services_node_file_system_service_.copyFile.html +++ b/papi-dts/functions/_node_services_node_file_system_service_.copyFile.html @@ -5,4 +5,4 @@
  • Optional mode: number

    Bitwise modifiers that affect how the copy works. See fsPromises.copyFile for more information

    -
  • Returns Promise<void>

    Generated using TypeDoc

    \ No newline at end of file +

    Returns Promise<void>

    Generated using TypeDoc

    \ No newline at end of file diff --git a/papi-dts/functions/_node_services_node_file_system_service_.createDir.html b/papi-dts/functions/_node_services_node_file_system_service_.createDir.html index 60c799273f..eecbfcd939 100644 --- a/papi-dts/functions/_node_services_node_file_system_service_.createDir.html +++ b/papi-dts/functions/_node_services_node_file_system_service_.createDir.html @@ -1,4 +1,4 @@ createDir | papi-dts
    • Create a directory in the file system if it does not exist. Does not throw if it already exists.

      Parameters

      • uri: string

        URI of directory

      Returns Promise<void>

      Promise that resolves once the directory has been created

      -

    Generated using TypeDoc

    \ No newline at end of file +

    Generated using TypeDoc

    \ No newline at end of file diff --git a/papi-dts/functions/_node_services_node_file_system_service_.deleteDir.html b/papi-dts/functions/_node_services_node_file_system_service_.deleteDir.html index 1dded17910..7d278867e9 100644 --- a/papi-dts/functions/_node_services_node_file_system_service_.deleteDir.html +++ b/papi-dts/functions/_node_services_node_file_system_service_.deleteDir.html @@ -1,4 +1,4 @@ deleteDir | papi-dts
    • Remove a directory and all its contents recursively from the file system

      Parameters

      • uri: string

        URI of directory

      Returns Promise<void>

      Promise that resolves when the delete operation finishes

      -

    Generated using TypeDoc

    \ No newline at end of file +

    Generated using TypeDoc

    \ No newline at end of file diff --git a/papi-dts/functions/_node_services_node_file_system_service_.deleteFile.html b/papi-dts/functions/_node_services_node_file_system_service_.deleteFile.html index aaa73f8ca9..ef8fc05b21 100644 --- a/papi-dts/functions/_node_services_node_file_system_service_.deleteFile.html +++ b/papi-dts/functions/_node_services_node_file_system_service_.deleteFile.html @@ -1,4 +1,4 @@ deleteFile | papi-dts
    • Delete a file if it exists

      Parameters

      • uri: string

        URI of file

      Returns Promise<void>

      Promise that resolves when the file is deleted or determined to not exist

      -

    Generated using TypeDoc

    \ No newline at end of file +

    Generated using TypeDoc

    \ No newline at end of file diff --git a/papi-dts/functions/_node_services_node_file_system_service_.getStats.html b/papi-dts/functions/_node_services_node_file_system_service_.getStats.html index f5ddb1b0ba..844fdcf896 100644 --- a/papi-dts/functions/_node_services_node_file_system_service_.getStats.html +++ b/papi-dts/functions/_node_services_node_file_system_service_.getStats.html @@ -3,4 +3,4 @@

    Parameters

    Returns Promise<BigIntStats | undefined>

    Promise that resolves to object of type https://nodejs.org/api/fs.html#class-fsstats if file or directory exists, undefined if it doesn't

    -

    Generated using TypeDoc

    \ No newline at end of file +

    Generated using TypeDoc

    \ No newline at end of file diff --git a/papi-dts/functions/_node_services_node_file_system_service_.readDir.html b/papi-dts/functions/_node_services_node_file_system_service_.readDir.html index 8a194c9699..91174b0093 100644 --- a/papi-dts/functions/_node_services_node_file_system_service_.readDir.html +++ b/papi-dts/functions/_node_services_node_file_system_service_.readDir.html @@ -2,4 +2,4 @@

    Parameters

    Returns Promise<DirectoryEntries>

    Map of entry type to list of uris for each entry in the directory with that type.

    -

    Generated using TypeDoc

    \ No newline at end of file +

    Generated using TypeDoc

    \ No newline at end of file diff --git a/papi-dts/functions/_node_services_node_file_system_service_.readFileBinary.html b/papi-dts/functions/_node_services_node_file_system_service_.readFileBinary.html index 4e4985bd1b..ddfaea2996 100644 --- a/papi-dts/functions/_node_services_node_file_system_service_.readFileBinary.html +++ b/papi-dts/functions/_node_services_node_file_system_service_.readFileBinary.html @@ -1,4 +1,4 @@ readFileBinary | papi-dts
    • Read a binary file

      Parameters

      • uri: string

        URI of file

      Returns Promise<Buffer>

      Promise that resolves to the contents of the file

      -

    Generated using TypeDoc

    \ No newline at end of file +

    Generated using TypeDoc

    \ No newline at end of file diff --git a/papi-dts/functions/_node_services_node_file_system_service_.readFileText.html b/papi-dts/functions/_node_services_node_file_system_service_.readFileText.html index d7928a5b1c..f59cf9bf0e 100644 --- a/papi-dts/functions/_node_services_node_file_system_service_.readFileText.html +++ b/papi-dts/functions/_node_services_node_file_system_service_.readFileText.html @@ -1,4 +1,4 @@ readFileText | papi-dts
    • Read a text file

      Parameters

      • uri: string

        URI of file

      Returns Promise<string>

      Promise that resolves to the contents of the file

      -

    Generated using TypeDoc

    \ No newline at end of file +

    Generated using TypeDoc

    \ No newline at end of file diff --git a/papi-dts/functions/_node_services_node_file_system_service_.touch.html b/papi-dts/functions/_node_services_node_file_system_service_.touch.html index d6447d99e4..414c5278e0 100644 --- a/papi-dts/functions/_node_services_node_file_system_service_.touch.html +++ b/papi-dts/functions/_node_services_node_file_system_service_.touch.html @@ -1,4 +1,4 @@ touch | papi-dts
    • Set the last modified and accessed times for the file or directory

      Parameters

      • uri: string

        URI of file or directory

      • date: Date

      Returns Promise<void>

      Promise that resolves once the touch operation finishes

      -

    Generated using TypeDoc

    \ No newline at end of file +

    Generated using TypeDoc

    \ No newline at end of file diff --git a/papi-dts/functions/_node_services_node_file_system_service_.writeFile.html b/papi-dts/functions/_node_services_node_file_system_service_.writeFile.html index 0e93e932b3..df4039434d 100644 --- a/papi-dts/functions/_node_services_node_file_system_service_.writeFile.html +++ b/papi-dts/functions/_node_services_node_file_system_service_.writeFile.html @@ -2,4 +2,4 @@

    Parameters

    Returns Promise<void>

    Promise that resolves after writing the file

    -

    Generated using TypeDoc

    \ No newline at end of file +

    Generated using TypeDoc

    \ No newline at end of file diff --git a/papi-dts/functions/_node_utils_crypto_util_.createNonce.html b/papi-dts/functions/_node_utils_crypto_util_.createNonce.html index 4c2ffd853d..eb236422f5 100644 --- a/papi-dts/functions/_node_utils_crypto_util_.createNonce.html +++ b/papi-dts/functions/_node_utils_crypto_util_.createNonce.html @@ -1,4 +1,4 @@ createNonce | papi-dts

    Generated using TypeDoc

    \ No newline at end of file +

    Generated using TypeDoc

    \ No newline at end of file diff --git a/papi-dts/functions/_node_utils_crypto_util_.createUuid.html b/papi-dts/functions/_node_utils_crypto_util_.createUuid.html index 7c8e6b742d..ce90dbbfad 100644 --- a/papi-dts/functions/_node_utils_crypto_util_.createUuid.html +++ b/papi-dts/functions/_node_utils_crypto_util_.createUuid.html @@ -1 +1 @@ -createUuid | papi-dts

    Generated using TypeDoc

    \ No newline at end of file +createUuid | papi-dts

    Generated using TypeDoc

    \ No newline at end of file diff --git a/papi-dts/functions/_node_utils_util_.getPathFromUri.html b/papi-dts/functions/_node_utils_util_.getPathFromUri.html index 0400a6f385..0930ddec2a 100644 --- a/papi-dts/functions/_node_utils_util_.getPathFromUri.html +++ b/papi-dts/functions/_node_utils_util_.getPathFromUri.html @@ -1,4 +1,4 @@ getPathFromUri | papi-dts
    • Resolves the uri to a path

      Parameters

      • uri: string

        The uri to resolve

      Returns string

      Real path to the uri supplied

      -

    Generated using TypeDoc

    \ No newline at end of file +

    Generated using TypeDoc

    \ No newline at end of file diff --git a/papi-dts/functions/_node_utils_util_.joinUriPaths.html b/papi-dts/functions/_node_utils_util_.joinUriPaths.html index 2433f9c3e6..caa4d74b69 100644 --- a/papi-dts/functions/_node_utils_util_.joinUriPaths.html +++ b/papi-dts/functions/_node_utils_util_.joinUriPaths.html @@ -2,4 +2,4 @@

    Parameters

    Returns Uri

    One uri that combines the uri and the paths in left-to-right order

    -

    Generated using TypeDoc

    \ No newline at end of file +

    Generated using TypeDoc

    \ No newline at end of file diff --git a/papi-dts/functions/_node_utils_util_.resolveHtmlPath.html b/papi-dts/functions/_node_utils_util_.resolveHtmlPath.html index ee92ed8026..c99d3af6f5 100644 --- a/papi-dts/functions/_node_utils_util_.resolveHtmlPath.html +++ b/papi-dts/functions/_node_utils_util_.resolveHtmlPath.html @@ -1 +1 @@ -resolveHtmlPath | papi-dts

    Generated using TypeDoc

    \ No newline at end of file +resolveHtmlPath | papi-dts

    Generated using TypeDoc

    \ No newline at end of file diff --git a/papi-dts/functions/_renderer_components_dialogs_dialog_base_data_.hookUpDialogService.html b/papi-dts/functions/_renderer_components_dialogs_dialog_base_data_.hookUpDialogService.html index bea77ea043..5c5c289e33 100644 --- a/papi-dts/functions/_renderer_components_dialogs_dialog_base_data_.hookUpDialogService.html +++ b/papi-dts/functions/_renderer_components_dialogs_dialog_base_data_.hookUpDialogService.html @@ -3,4 +3,4 @@ mitigate a dependency cycle

    Parameters

    Returns void

    Generated using TypeDoc

    \ No newline at end of file +

    Returns void

    Generated using TypeDoc

    \ No newline at end of file diff --git a/papi-dts/functions/_renderer_hooks_hook_generators_create_use_data_hook_util_.default.html b/papi-dts/functions/_renderer_hooks_hook_generators_create_use_data_hook_util_.default.html index 274d99e967..e9a33c59aa 100644 --- a/papi-dts/functions/_renderer_hooks_hook_generators_create_use_data_hook_util_.default.html +++ b/papi-dts/functions/_renderer_hooks_hook_generators_create_use_data_hook_util_.default.html @@ -3,4 +3,4 @@

    Type Parameters

    Parameters

    Returns UseDataHookGeneric<TUseDataProviderParams>

    useData hook for getting data from a data provider

    -

    Generated using TypeDoc

    \ No newline at end of file +

    Generated using TypeDoc

    \ No newline at end of file diff --git a/papi-dts/functions/_renderer_hooks_hook_generators_create_use_network_object_hook_util_.default.html b/papi-dts/functions/_renderer_hooks_hook_generators_create_use_network_object_hook_util_.default.html index 36c11b2a1f..49123e2570 100644 --- a/papi-dts/functions/_renderer_hooks_hook_generators_create_use_network_object_hook_util_.default.html +++ b/papi-dts/functions/_renderer_hooks_hook_generators_create_use_network_object_hook_util_.default.html @@ -9,4 +9,4 @@ (result of this hook, if you want this hook to just return the network object again)

    Returns ((...args) => NetworkObject<object> | undefined)

    A function that takes in a networkObjectSource and returns a NetworkObject

    -

    Generated using TypeDoc

    \ No newline at end of file +

    Generated using TypeDoc

    \ No newline at end of file diff --git a/papi-dts/functions/_renderer_hooks_papi_hooks_use_data_hook_.default.html b/papi-dts/functions/_renderer_hooks_papi_hooks_use_data_hook_.default.html index 092f665ba7..708b7d5dfd 100644 --- a/papi-dts/functions/_renderer_hooks_papi_hooks_use_data_hook_.default.html +++ b/papi-dts/functions/_renderer_hooks_papi_hooks_use_data_hook_.default.html @@ -29,4 +29,4 @@
  • isLoading: whether the data with the data type and selector is awaiting retrieval from the data provider
  • -

    Type Parameters

    Parameters

    Returns {
        [TDataType in string | number | symbol]: ((selector, defaultValue, subscriberOptions?) => [DataProviderTypes[DataProviderName][TDataType]["getData"], undefined | ((newData) => Promise<DataProviderUpdateInstructions<DataProviderTypes[DataProviderName]>>), boolean])
    }

    Generated using TypeDoc

    \ No newline at end of file +

    Type Parameters

    Parameters

    Returns {
        [TDataType in string | number | symbol]: ((selector, defaultValue, subscriberOptions?) => [DataProviderTypes[DataProviderName][TDataType]["getData"], undefined | ((newData) => Promise<DataProviderUpdateInstructions<DataProviderTypes[DataProviderName]>>), boolean])
    }

    Generated using TypeDoc

    \ No newline at end of file diff --git a/papi-dts/functions/_renderer_hooks_papi_hooks_use_data_provider_hook_.default.html b/papi-dts/functions/_renderer_hooks_papi_hooks_use_data_provider_hook_.default.html index 6b3bc538dc..116b84695c 100644 --- a/papi-dts/functions/_renderer_hooks_papi_hooks_use_data_provider_hook_.default.html +++ b/papi-dts/functions/_renderer_hooks_papi_hooks_use_data_provider_hook_.default.html @@ -3,4 +3,4 @@ useDataProvider, if you want this hook to just return the data provider again)

    Returns undefined | DataProviders[DataProviderName]

    Undefined if the data provider has not been retrieved, data provider if it has been retrieved and is not disposed, and undefined again if the data provider is disposed

    -

    Generated using TypeDoc

    \ No newline at end of file +

    Generated using TypeDoc

    \ No newline at end of file diff --git a/papi-dts/functions/_renderer_hooks_papi_hooks_use_data_provider_multi_hook_.default.html b/papi-dts/functions/_renderer_hooks_papi_hooks_use_data_provider_multi_hook_.default.html index 490d4c54f9..21152baeec 100644 --- a/papi-dts/functions/_renderer_hooks_papi_hooks_use_data_provider_multi_hook_.default.html +++ b/papi-dts/functions/_renderer_hooks_papi_hooks_use_data_provider_multi_hook_.default.html @@ -9,4 +9,4 @@ dataProviderSources. Each item in the array will be (a) undefined if the data provider has not been retrieved or has been disposed, or (b) a data provider if it has been retrieved and is not disposed.

    -

    Generated using TypeDoc

    \ No newline at end of file +

    Generated using TypeDoc

    \ No newline at end of file diff --git a/papi-dts/functions/_renderer_hooks_papi_hooks_use_dialog_callback_hook_.default.html b/papi-dts/functions/_renderer_hooks_papi_hooks_use_dialog_callback_hook_.default.html index 20beb15943..00d4695279 100644 --- a/papi-dts/functions/_renderer_hooks_papi_hooks_use_dialog_callback_hook_.default.html +++ b/papi-dts/functions/_renderer_hooks_papi_hooks_use_dialog_callback_hook_.default.html @@ -23,4 +23,4 @@
  • isShowingDialog - whether this dialog is showing (the callback has been run but has not responded)
  • -

    Generated using TypeDoc

    \ No newline at end of file +

    Generated using TypeDoc

    \ No newline at end of file diff --git a/papi-dts/functions/_renderer_hooks_papi_hooks_use_event_async_hook_.default.html b/papi-dts/functions/_renderer_hooks_papi_hooks_use_event_async_hook_.default.html index 46afbf65d0..5f387ad021 100644 --- a/papi-dts/functions/_renderer_hooks_papi_hooks_use_event_async_hook_.default.html +++ b/papi-dts/functions/_renderer_hooks_papi_hooks_use_event_async_hook_.default.html @@ -11,4 +11,4 @@
  • eventHandler: PapiEventHandler<T>

    The callback to run when the event is emitted

    WARNING: MUST BE STABLE - const or wrapped in useCallback. The reference must not be updated every render

    -
  • Returns void

    Generated using TypeDoc

    \ No newline at end of file +

    Returns void

    Generated using TypeDoc

    \ No newline at end of file diff --git a/papi-dts/functions/_renderer_hooks_papi_hooks_use_event_hook_.default.html b/papi-dts/functions/_renderer_hooks_papi_hooks_use_event_hook_.default.html index d18146474b..36644b1682 100644 --- a/papi-dts/functions/_renderer_hooks_papi_hooks_use_event_hook_.default.html +++ b/papi-dts/functions/_renderer_hooks_papi_hooks_use_event_hook_.default.html @@ -9,4 +9,4 @@
  • eventHandler: PapiEventHandler<T>

    The callback to run when the event is emitted

    WARNING: MUST BE STABLE - const or wrapped in useCallback. The reference must not be updated every render

    -
  • Returns void

    Generated using TypeDoc

    \ No newline at end of file +

    Returns void

    Generated using TypeDoc

    \ No newline at end of file diff --git a/papi-dts/functions/_renderer_hooks_papi_hooks_use_project_data_hook_.default.html b/papi-dts/functions/_renderer_hooks_papi_hooks_use_project_data_hook_.default.html index 3e90c7fe1a..9bb22e960f 100644 --- a/papi-dts/functions/_renderer_hooks_papi_hooks_use_project_data_hook_.default.html +++ b/papi-dts/functions/_renderer_hooks_papi_hooks_use_project_data_hook_.default.html @@ -27,4 +27,4 @@

    WARNING: If provided, MUST BE STABLE - const or wrapped in useState, useMemo, etc. The reference must not be updated every render

    ï¼ returns [data, setData, isLoading]

    -

    Type Parameters

    Parameters

    Returns {
        [TDataType in string | number | symbol]: ((selector, defaultValue, subscriberOptions?) => [ProjectDataTypes[ProjectType][TDataType]["getData"], undefined | ((newData) => Promise<DataProviderUpdateInstructions<ProjectDataTypes[ProjectType]>>), boolean])
    }

    Generated using TypeDoc

    \ No newline at end of file +

    Type Parameters

    Parameters

    Returns {
        [TDataType in string | number | symbol]: ((selector, defaultValue, subscriberOptions?) => [ProjectDataTypes[ProjectType][TDataType]["getData"], undefined | ((newData) => Promise<DataProviderUpdateInstructions<ProjectDataTypes[ProjectType]>>), boolean])
    }

    Generated using TypeDoc

    \ No newline at end of file diff --git a/papi-dts/functions/_renderer_hooks_papi_hooks_use_project_data_provider_hook_.default.html b/papi-dts/functions/_renderer_hooks_papi_hooks_use_project_data_provider_hook_.default.html index f7271a89ef..40d59bdfda 100644 --- a/papi-dts/functions/_renderer_hooks_papi_hooks_use_project_data_provider_hook_.default.html +++ b/papi-dts/functions/_renderer_hooks_papi_hooks_use_project_data_provider_hook_.default.html @@ -9,4 +9,4 @@

    Returns undefined | "shared/models/data-provider.interface".default<ProjectDataTypes[ProjectType]>

    undefined if the project data provider has not been retrieved, the requested project data provider if it has been retrieved and is not disposed, and undefined again if the project data provider is disposed

    -

    Generated using TypeDoc

    \ No newline at end of file +

    Generated using TypeDoc

    \ No newline at end of file diff --git a/papi-dts/functions/_renderer_hooks_papi_hooks_use_promise_hook_.default.html b/papi-dts/functions/_renderer_hooks_papi_hooks_use_promise_hook_.default.html index 0a448532a3..5c1603f301 100644 --- a/papi-dts/functions/_renderer_hooks_papi_hooks_use_promise_hook_.default.html +++ b/papi-dts/functions/_renderer_hooks_papi_hooks_use_promise_hook_.default.html @@ -16,4 +16,4 @@
  • value: the current value for the promise, either the defaultValue or the resolved promise value
  • isLoading: whether the promise is waiting to be resolved
  • -

    Generated using TypeDoc

    \ No newline at end of file +

    Generated using TypeDoc

    \ No newline at end of file diff --git a/papi-dts/functions/_renderer_hooks_papi_hooks_use_setting_hook_.default.html b/papi-dts/functions/_renderer_hooks_papi_hooks_use_setting_hook_.default.html index c9887c8624..5dafa16db8 100644 --- a/papi-dts/functions/_renderer_hooks_papi_hooks_use_setting_hook_.default.html +++ b/papi-dts/functions/_renderer_hooks_papi_hooks_use_setting_hook_.default.html @@ -14,4 +14,4 @@ papi, if any
  • setSetting: Function that updates the setting to a new value
  • -

    Generated using TypeDoc

    \ No newline at end of file +

    Generated using TypeDoc

    \ No newline at end of file diff --git a/papi-dts/functions/_renderer_services_renderer_web_socket_service_.blockWebSocketsToPapiNetwork.html b/papi-dts/functions/_renderer_services_renderer_web_socket_service_.blockWebSocketsToPapiNetwork.html index ccddcd8847..8787bfb9ff 100644 --- a/papi-dts/functions/_renderer_services_renderer_web_socket_service_.blockWebSocketsToPapiNetwork.html +++ b/papi-dts/functions/_renderer_services_renderer_web_socket_service_.blockWebSocketsToPapiNetwork.html @@ -1,2 +1,2 @@ blockWebSocketsToPapiNetwork | papi-dts
    • Once our network is running, run this to stop extensions from connecting to it directly

      -

      Returns void

    Generated using TypeDoc

    \ No newline at end of file +

    Returns void

    Generated using TypeDoc

    \ No newline at end of file diff --git a/papi-dts/functions/_shared_models_data_provider_model_.getDataProviderDataTypeFromFunctionName.html b/papi-dts/functions/_shared_models_data_provider_model_.getDataProviderDataTypeFromFunctionName.html index 3fb529180b..a0c8ab8542 100644 --- a/papi-dts/functions/_shared_models_data_provider_model_.getDataProviderDataTypeFromFunctionName.html +++ b/papi-dts/functions/_shared_models_data_provider_model_.getDataProviderDataTypeFromFunctionName.html @@ -1,4 +1,4 @@ getDataProviderDataTypeFromFunctionName | papi-dts

    Generated using TypeDoc

    \ No newline at end of file +

    Generated using TypeDoc

    \ No newline at end of file diff --git a/papi-dts/functions/_shared_services_command_service_.addThree.html b/papi-dts/functions/_shared_services_command_service_.addThree.html index 352b242737..7ecfadc818 100644 --- a/papi-dts/functions/_shared_services_command_service_.addThree.html +++ b/papi-dts/functions/_shared_services_command_service_.addThree.html @@ -1 +1 @@ -addThree | papi-dts

    Generated using TypeDoc

    \ No newline at end of file +addThree | papi-dts

    Generated using TypeDoc

    \ No newline at end of file diff --git a/papi-dts/functions/_shared_services_command_service_.createSendCommandFunction.html b/papi-dts/functions/_shared_services_command_service_.createSendCommandFunction.html index f4e990c8ee..3484d275d5 100644 --- a/papi-dts/functions/_shared_services_command_service_.createSendCommandFunction.html +++ b/papi-dts/functions/_shared_services_command_service_.createSendCommandFunction.html @@ -3,4 +3,4 @@

    Type Parameters

    Parameters

    Returns ((...args) => Promise<Awaited<ReturnType<CommandHandlers[CommandName]>>>)

    Function to call with arguments of command that sends the command and resolves with the result of the command

    -

    Generated using TypeDoc

    \ No newline at end of file +

    Generated using TypeDoc

    \ No newline at end of file diff --git a/papi-dts/functions/_shared_services_command_service_.initialize.html b/papi-dts/functions/_shared_services_command_service_.initialize.html index 8a896307c4..3f28e2584d 100644 --- a/papi-dts/functions/_shared_services_command_service_.initialize.html +++ b/papi-dts/functions/_shared_services_command_service_.initialize.html @@ -1,2 +1,2 @@ initialize | papi-dts
    • Sets up the CommandService. Only runs once and always returns the same promise after that

      -

      Returns Promise<void>

    Generated using TypeDoc

    \ No newline at end of file +

    Returns Promise<void>

    Generated using TypeDoc

    \ No newline at end of file diff --git a/papi-dts/functions/_shared_services_command_service_.registerCommand.html b/papi-dts/functions/_shared_services_command_service_.registerCommand.html index 9b20fcccfb..dbc7f85296 100644 --- a/papi-dts/functions/_shared_services_command_service_.registerCommand.html +++ b/papi-dts/functions/_shared_services_command_service_.registerCommand.html @@ -6,4 +6,4 @@
  • handler: CommandHandlers[CommandName]

    Function to run when the command is invoked

  • Returns Promise<UnsubscriberAsync>

    True if successfully registered, throws with error message if not

    -

    Generated using TypeDoc

    \ No newline at end of file +

    Generated using TypeDoc

    \ No newline at end of file diff --git a/papi-dts/functions/_shared_services_command_service_.sendCommand.html b/papi-dts/functions/_shared_services_command_service_.sendCommand.html index 7f3eabbe0c..8c234d1e8b 100644 --- a/papi-dts/functions/_shared_services_command_service_.sendCommand.html +++ b/papi-dts/functions/_shared_services_command_service_.sendCommand.html @@ -1,2 +1,2 @@ sendCommand | papi-dts
    • Send a command to the backend.

      -

      Type Parameters

      • CommandName extends keyof CommandHandlers

      Parameters

      • commandName: CommandName
      • Rest ...args: Parameters<CommandHandlers[CommandName]>

      Returns Promise<Awaited<ReturnType<CommandHandlers[CommandName]>>>

    Generated using TypeDoc

    \ No newline at end of file +

    Type Parameters

    Parameters

    Returns Promise<Awaited<ReturnType<CommandHandlers[CommandName]>>>

    Generated using TypeDoc

    \ No newline at end of file diff --git a/papi-dts/functions/_shared_services_command_service_.squareAndConcat.html b/papi-dts/functions/_shared_services_command_service_.squareAndConcat.html index 3b3f88167b..b0be704d6c 100644 --- a/papi-dts/functions/_shared_services_command_service_.squareAndConcat.html +++ b/papi-dts/functions/_shared_services_command_service_.squareAndConcat.html @@ -1 +1 @@ -squareAndConcat | papi-dts

    Generated using TypeDoc

    \ No newline at end of file +squareAndConcat | papi-dts

    Generated using TypeDoc

    \ No newline at end of file diff --git a/papi-dts/functions/_shared_services_connection_service_.connect.html b/papi-dts/functions/_shared_services_connection_service_.connect.html index 16e07a2c56..ee5d6ab2d7 100644 --- a/papi-dts/functions/_shared_services_connection_service_.connect.html +++ b/papi-dts/functions/_shared_services_connection_service_.connect.html @@ -8,4 +8,4 @@
  • connectorEventHandlers: NetworkConnectorEventHandlers

    Functions that run when network connector events occur like when clients are disconnected

  • Returns Promise<void>

    Promise that resolves when finished connecting

    -

    Generated using TypeDoc

    \ No newline at end of file +

    Generated using TypeDoc

    \ No newline at end of file diff --git a/papi-dts/functions/_shared_services_connection_service_.disconnect.html b/papi-dts/functions/_shared_services_connection_service_.disconnect.html index c4402d3721..1c207e6b35 100644 --- a/papi-dts/functions/_shared_services_connection_service_.disconnect.html +++ b/papi-dts/functions/_shared_services_connection_service_.disconnect.html @@ -1,2 +1,2 @@ disconnect | papi-dts

    Generated using TypeDoc

    \ No newline at end of file +

    Returns void

    Generated using TypeDoc

    \ No newline at end of file diff --git a/papi-dts/functions/_shared_services_connection_service_.emitEventOnNetwork.html b/papi-dts/functions/_shared_services_connection_service_.emitEventOnNetwork.html index 683fb13812..6872116e00 100644 --- a/papi-dts/functions/_shared_services_connection_service_.emitEventOnNetwork.html +++ b/papi-dts/functions/_shared_services_connection_service_.emitEventOnNetwork.html @@ -2,4 +2,4 @@ run by NetworkEventEmitter after sending on network.

    Type Parameters

    Parameters

    Returns Promise<void>

    Generated using TypeDoc

    \ No newline at end of file +

    Returns Promise<void>

    Generated using TypeDoc

    \ No newline at end of file diff --git a/papi-dts/functions/_shared_services_connection_service_.getClientId.html b/papi-dts/functions/_shared_services_connection_service_.getClientId.html index 1b746b0b22..36bad57804 100644 --- a/papi-dts/functions/_shared_services_connection_service_.getClientId.html +++ b/papi-dts/functions/_shared_services_connection_service_.getClientId.html @@ -1,2 +1,2 @@ getClientId | papi-dts

    Generated using TypeDoc

    \ No newline at end of file +

    Returns number

    Generated using TypeDoc

    \ No newline at end of file diff --git a/papi-dts/functions/_shared_services_connection_service_.request.html b/papi-dts/functions/_shared_services_connection_service_.request.html index d9f1c48106..9ee57cdbae 100644 --- a/papi-dts/functions/_shared_services_connection_service_.request.html +++ b/papi-dts/functions/_shared_services_connection_service_.request.html @@ -2,4 +2,4 @@

    Type Parameters

    Parameters

    Returns Promise<ComplexResponse<TReturn>>

    Promise that resolves with the response message

    -

    Generated using TypeDoc

    \ No newline at end of file +

    Generated using TypeDoc

    \ No newline at end of file diff --git a/papi-dts/functions/_shared_services_data_provider_service_.getByType.html b/papi-dts/functions/_shared_services_data_provider_service_.getByType.html index d1772ac5d4..2635e9dbfd 100644 --- a/papi-dts/functions/_shared_services_data_provider_service_.getByType.html +++ b/papi-dts/functions/_shared_services_data_provider_service_.getByType.html @@ -1,4 +1,4 @@ getByType | papi-dts
    • Get a data provider that has previously been set up

      Type Parameters

      Parameters

      • providerName: string

        Name of the desired data provider

      Returns Promise<T | undefined>

      The data provider with the given name if one exists, undefined otherwise

      -

    Generated using TypeDoc

    \ No newline at end of file +

    Generated using TypeDoc

    \ No newline at end of file diff --git a/papi-dts/functions/_shared_services_data_provider_service_.registerEngineByType.html b/papi-dts/functions/_shared_services_data_provider_service_.registerEngineByType.html index f0c84d1240..d3a530ea74 100644 --- a/papi-dts/functions/_shared_services_data_provider_service_.registerEngineByType.html +++ b/papi-dts/functions/_shared_services_data_provider_service_.registerEngineByType.html @@ -6,4 +6,4 @@

    Returns Promise<IDisposableDataProvider<"shared/models/data-provider.interface".default<TDataTypes>>>

    Local data provider object that represents a remote data provider

    Creates a data provider to be shared on the network layering over the provided data provider engine.

    -

    Generated using TypeDoc

    \ No newline at end of file +

    Generated using TypeDoc

    \ No newline at end of file diff --git a/papi-dts/functions/_shared_services_logger_service_.formatLog.html b/papi-dts/functions/_shared_services_logger_service_.formatLog.html index 6cf38826b5..79d69eaedb 100644 --- a/papi-dts/functions/_shared_services_logger_service_.formatLog.html +++ b/papi-dts/functions/_shared_services_logger_service_.formatLog.html @@ -3,4 +3,4 @@
  • serviceName: string

    Name of the service to show in the log

  • Optional tag: string

    Optional tag at the end of the service name

  • Returns string

    Formatted string of a service message

    -

    Generated using TypeDoc

    \ No newline at end of file +

    Generated using TypeDoc

    \ No newline at end of file diff --git a/papi-dts/functions/_shared_services_network_connector_factory_.createNetworkConnector.html b/papi-dts/functions/_shared_services_network_connector_factory_.createNetworkConnector.html index b35df8bfc0..3f32851b4a 100644 --- a/papi-dts/functions/_shared_services_network_connector_factory_.createNetworkConnector.html +++ b/papi-dts/functions/_shared_services_network_connector_factory_.createNetworkConnector.html @@ -1,3 +1,3 @@ createNetworkConnector | papi-dts

    Generated using TypeDoc

    \ No newline at end of file +

    Generated using TypeDoc

    \ No newline at end of file diff --git a/papi-dts/functions/_shared_services_network_object_service_.onDidCreateNetworkObject.html b/papi-dts/functions/_shared_services_network_object_service_.onDidCreateNetworkObject.html index a5514feb33..5f225bad71 100644 --- a/papi-dts/functions/_shared_services_network_object_service_.onDidCreateNetworkObject.html +++ b/papi-dts/functions/_shared_services_network_object_service_.onDidCreateNetworkObject.html @@ -1,3 +1,3 @@ onDidCreateNetworkObject | papi-dts

    Generated using TypeDoc

    \ No newline at end of file +

    Parameters

    Returns Unsubscriber

    Generated using TypeDoc

    \ No newline at end of file diff --git a/papi-dts/functions/_shared_services_network_object_service_.onDidDisposeNetworkObject.html b/papi-dts/functions/_shared_services_network_object_service_.onDidDisposeNetworkObject.html index 9a418a1521..bfed72e60a 100644 --- a/papi-dts/functions/_shared_services_network_object_service_.onDidDisposeNetworkObject.html +++ b/papi-dts/functions/_shared_services_network_object_service_.onDidDisposeNetworkObject.html @@ -1,2 +1,2 @@ onDidDisposeNetworkObject | papi-dts

    Generated using TypeDoc

    \ No newline at end of file +

    Parameters

    Returns Unsubscriber

    Generated using TypeDoc

    \ No newline at end of file diff --git a/papi-dts/functions/_shared_services_network_object_service_.overrideDispose.html b/papi-dts/functions/_shared_services_network_object_service_.overrideDispose.html index 327eee287e..4b392a3a0d 100644 --- a/papi-dts/functions/_shared_services_network_object_service_.overrideDispose.html +++ b/papi-dts/functions/_shared_services_network_object_service_.overrideDispose.html @@ -1,2 +1,2 @@ overrideDispose | papi-dts
    • If dispose already exists on objectToMutate, we will call it in addition to newDispose

      -

      Parameters

      Returns void

    Generated using TypeDoc

    \ No newline at end of file +

    Parameters

    Returns void

    Generated using TypeDoc

    \ No newline at end of file diff --git a/papi-dts/functions/_shared_services_network_service_.createNetworkEventEmitter.html b/papi-dts/functions/_shared_services_network_service_.createNetworkEventEmitter.html index 190dbc12f9..feb844d3f8 100644 --- a/papi-dts/functions/_shared_services_network_service_.createNetworkEventEmitter.html +++ b/papi-dts/functions/_shared_services_network_service_.createNetworkEventEmitter.html @@ -5,4 +5,4 @@

    WARNING: You cannot emit events with complex types on the network.

    Type Parameters

    Parameters

    Returns "shared/models/papi-event-emitter.model".default<T>

    Event emitter whose event works between connections

    -

    Generated using TypeDoc

    \ No newline at end of file +

    Generated using TypeDoc

    \ No newline at end of file diff --git a/papi-dts/functions/_shared_services_network_service_.createRequestFunction.html b/papi-dts/functions/_shared_services_network_service_.createRequestFunction.html index e81f15350f..618098375f 100644 --- a/papi-dts/functions/_shared_services_network_service_.createRequestFunction.html +++ b/papi-dts/functions/_shared_services_network_service_.createRequestFunction.html @@ -3,4 +3,4 @@

    Type Parameters

    Parameters

    Returns ((...args) => Promise<TReturn>)

    Function to call with arguments of request that performs the request and resolves with the response contents

    -

    Generated using TypeDoc

    \ No newline at end of file +

    Generated using TypeDoc

    \ No newline at end of file diff --git a/papi-dts/functions/_shared_services_network_service_.getNetworkEvent.html b/papi-dts/functions/_shared_services_network_service_.getNetworkEvent.html index 60b1e2d61d..c0e4437f01 100644 --- a/papi-dts/functions/_shared_services_network_service_.getNetworkEvent.html +++ b/papi-dts/functions/_shared_services_network_service_.getNetworkEvent.html @@ -1,4 +1,4 @@ getNetworkEvent | papi-dts
    • Gets the network event with the specified type. Creates the emitter if it does not exist

      Type Parameters

      • T

      Parameters

      • eventType: string

        Unique network event type for coordinating between connections

      Returns PapiEvent<T>

      Event for the event type that runs the callback provided when the event is emitted

      -

    Generated using TypeDoc

    \ No newline at end of file +

    Generated using TypeDoc

    \ No newline at end of file diff --git a/papi-dts/functions/_shared_services_network_service_.initialize.html b/papi-dts/functions/_shared_services_network_service_.initialize.html index ac167c8544..d2c8ffbc75 100644 --- a/papi-dts/functions/_shared_services_network_service_.initialize.html +++ b/papi-dts/functions/_shared_services_network_service_.initialize.html @@ -1,2 +1,2 @@ initialize | papi-dts

    Generated using TypeDoc

    \ No newline at end of file +

    Returns Promise<void>

    Generated using TypeDoc

    \ No newline at end of file diff --git a/papi-dts/functions/_shared_services_network_service_.onDidClientConnect.html b/papi-dts/functions/_shared_services_network_service_.onDidClientConnect.html index 0896b2585a..85d3e5497b 100644 --- a/papi-dts/functions/_shared_services_network_service_.onDidClientConnect.html +++ b/papi-dts/functions/_shared_services_network_service_.onDidClientConnect.html @@ -1,2 +1,2 @@ onDidClientConnect | papi-dts

    Generated using TypeDoc

    \ No newline at end of file +

    Parameters

    Returns Unsubscriber

    Generated using TypeDoc

    \ No newline at end of file diff --git a/papi-dts/functions/_shared_services_network_service_.onDidClientDisconnect.html b/papi-dts/functions/_shared_services_network_service_.onDidClientDisconnect.html index af38285970..aaee7c936c 100644 --- a/papi-dts/functions/_shared_services_network_service_.onDidClientDisconnect.html +++ b/papi-dts/functions/_shared_services_network_service_.onDidClientDisconnect.html @@ -1,2 +1,2 @@ onDidClientDisconnect | papi-dts

    Generated using TypeDoc

    \ No newline at end of file +

    Parameters

    Returns Unsubscriber

    Generated using TypeDoc

    \ No newline at end of file diff --git a/papi-dts/functions/_shared_services_network_service_.registerRequestHandler.html b/papi-dts/functions/_shared_services_network_service_.registerRequestHandler.html index 9c6ac32f2f..86e2ba0a2a 100644 --- a/papi-dts/functions/_shared_services_network_service_.registerRequestHandler.html +++ b/papi-dts/functions/_shared_services_network_service_.registerRequestHandler.html @@ -5,4 +5,4 @@ type the handler has

    Returns Promise<UnsubscriberAsync>

    Promise that resolves if the request successfully registered and unsubscriber function to run to stop the passed-in function from handling requests

    -
  • Parameters

    Returns Promise<UnsubscriberAsync>

  • Parameters

    Returns Promise<UnsubscriberAsync>

  • Generated using TypeDoc

    \ No newline at end of file +
  • Parameters

    Returns Promise<UnsubscriberAsync>

  • Parameters

    Returns Promise<UnsubscriberAsync>

  • Generated using TypeDoc

    \ No newline at end of file diff --git a/papi-dts/functions/_shared_services_network_service_.request.html b/papi-dts/functions/_shared_services_network_service_.request.html index 35e3385e2a..c20f2e623c 100644 --- a/papi-dts/functions/_shared_services_network_service_.request.html +++ b/papi-dts/functions/_shared_services_network_service_.request.html @@ -2,4 +2,4 @@

    Type Parameters

    Parameters

    Returns Promise<TReturn>

    Promise that resolves with the response message

    -

    Generated using TypeDoc

    \ No newline at end of file +

    Generated using TypeDoc

    \ No newline at end of file diff --git a/papi-dts/functions/_shared_services_network_service_.shutdown.html b/papi-dts/functions/_shared_services_network_service_.shutdown.html index cfdbd983d5..1fa496219d 100644 --- a/papi-dts/functions/_shared_services_network_service_.shutdown.html +++ b/papi-dts/functions/_shared_services_network_service_.shutdown.html @@ -1,2 +1,2 @@ shutdown | papi-dts

    Generated using TypeDoc

    \ No newline at end of file +

    Returns void

    Generated using TypeDoc

    \ No newline at end of file diff --git a/papi-dts/functions/_shared_services_project_data_provider_service_.get.html b/papi-dts/functions/_shared_services_project_data_provider_service_.get.html index 8547dcd4c7..91c78e7698 100644 --- a/papi-dts/functions/_shared_services_project_data_provider_service_.get.html +++ b/papi-dts/functions/_shared_services_project_data_provider_service_.get.html @@ -7,4 +7,4 @@

    Returns Promise<ProjectDataProvider[ProjectType]>

    Data provider with types that are associated with the given project type

    Example

    const pdp = await get('ParatextStandard', 'ProjectID12345');
    pdp.getVerse(new VerseRef('JHN', '1', '1'));
    -

    Generated using TypeDoc

    \ No newline at end of file +

    Generated using TypeDoc

    \ No newline at end of file diff --git a/papi-dts/functions/_shared_services_project_data_provider_service_.registerProjectDataProviderEngineFactory.html b/papi-dts/functions/_shared_services_project_data_provider_service_.registerProjectDataProviderEngineFactory.html index 3ea71f6856..ab7aebeb39 100644 --- a/papi-dts/functions/_shared_services_project_data_provider_service_.registerProjectDataProviderEngineFactory.html +++ b/papi-dts/functions/_shared_services_project_data_provider_service_.registerProjectDataProviderEngineFactory.html @@ -3,4 +3,4 @@

    Type Parameters

    Parameters

    Returns Promise<Dispose>

    Promise that resolves to a disposable object when the registration operation completes

    -

    Generated using TypeDoc

    \ No newline at end of file +

    Generated using TypeDoc

    \ No newline at end of file diff --git a/papi-dts/functions/_shared_utils_internal_util_.getProcessType.html b/papi-dts/functions/_shared_utils_internal_util_.getProcessType.html index 66c01e168e..0a99cff74d 100644 --- a/papi-dts/functions/_shared_utils_internal_util_.getProcessType.html +++ b/papi-dts/functions/_shared_utils_internal_util_.getProcessType.html @@ -1,3 +1,3 @@ getProcessType | papi-dts

    Generated using TypeDoc

    \ No newline at end of file +

    Generated using TypeDoc

    \ No newline at end of file diff --git a/papi-dts/functions/_shared_utils_internal_util_.isClient.html b/papi-dts/functions/_shared_utils_internal_util_.isClient.html index 6f7b831297..1e7270ce66 100644 --- a/papi-dts/functions/_shared_utils_internal_util_.isClient.html +++ b/papi-dts/functions/_shared_utils_internal_util_.isClient.html @@ -1,3 +1,3 @@ isClient | papi-dts
    • Determine if running on a client process (renderer, extension-host) or on the server.

      Returns boolean

      Returns true if running on a client, false otherwise

      -

    Generated using TypeDoc

    \ No newline at end of file +

    Generated using TypeDoc

    \ No newline at end of file diff --git a/papi-dts/functions/_shared_utils_internal_util_.isExtensionHost.html b/papi-dts/functions/_shared_utils_internal_util_.isExtensionHost.html index 0d163c4bef..8493be745f 100644 --- a/papi-dts/functions/_shared_utils_internal_util_.isExtensionHost.html +++ b/papi-dts/functions/_shared_utils_internal_util_.isExtensionHost.html @@ -1,3 +1,3 @@ isExtensionHost | papi-dts
    • Determine if running on the extension host

      Returns boolean

      Returns true if running on the extension host, false otherwise

      -

    Generated using TypeDoc

    \ No newline at end of file +

    Generated using TypeDoc

    \ No newline at end of file diff --git a/papi-dts/functions/_shared_utils_internal_util_.isRenderer.html b/papi-dts/functions/_shared_utils_internal_util_.isRenderer.html index e88e6a53f2..c3b990fbe2 100644 --- a/papi-dts/functions/_shared_utils_internal_util_.isRenderer.html +++ b/papi-dts/functions/_shared_utils_internal_util_.isRenderer.html @@ -1,3 +1,3 @@ isRenderer | papi-dts
    • Determine if running on the renderer process

      Returns boolean

      Returns true if running on the renderer, false otherwise

      -

    Generated using TypeDoc

    \ No newline at end of file +

    Generated using TypeDoc

    \ No newline at end of file diff --git a/papi-dts/functions/_shared_utils_internal_util_.isServer.html b/papi-dts/functions/_shared_utils_internal_util_.isServer.html index 3da14bbab2..ab319fd72e 100644 --- a/papi-dts/functions/_shared_utils_internal_util_.isServer.html +++ b/papi-dts/functions/_shared_utils_internal_util_.isServer.html @@ -1,3 +1,3 @@ isServer | papi-dts
    • Determine if running on the server process (main)

      Returns boolean

      Returns true if running on the server, false otherwise

      -

    Generated using TypeDoc

    \ No newline at end of file +

    Generated using TypeDoc

    \ No newline at end of file diff --git a/papi-dts/functions/_shared_utils_papi_util_.aggregateUnsubscriberAsyncs.html b/papi-dts/functions/_shared_utils_papi_util_.aggregateUnsubscriberAsyncs.html index 00293838f5..c273dee892 100644 --- a/papi-dts/functions/_shared_utils_papi_util_.aggregateUnsubscriberAsyncs.html +++ b/papi-dts/functions/_shared_utils_papi_util_.aggregateUnsubscriberAsyncs.html @@ -1,4 +1,4 @@ aggregateUnsubscriberAsyncs | papi-dts

    Generated using TypeDoc

    \ No newline at end of file +

    Generated using TypeDoc

    \ No newline at end of file diff --git a/papi-dts/functions/_shared_utils_papi_util_.aggregateUnsubscribers.html b/papi-dts/functions/_shared_utils_papi_util_.aggregateUnsubscribers.html index 9637fab8d1..ebc51c0de7 100644 --- a/papi-dts/functions/_shared_utils_papi_util_.aggregateUnsubscribers.html +++ b/papi-dts/functions/_shared_utils_papi_util_.aggregateUnsubscribers.html @@ -1,4 +1,4 @@ aggregateUnsubscribers | papi-dts
    • Returns an Unsubscriber function that combines all the unsubscribers passed in.

      Parameters

      • unsubscribers: Unsubscriber[]

        All unsubscribers to aggregate into one unsubscriber

      Returns Unsubscriber

      Function that unsubscribes from all passed in unsubscribers when run

      -

    Generated using TypeDoc

    \ No newline at end of file +

    Generated using TypeDoc

    \ No newline at end of file diff --git a/papi-dts/functions/_shared_utils_papi_util_.createSafeRegisterFn.html b/papi-dts/functions/_shared_utils_papi_util_.createSafeRegisterFn.html index c3d9cbba61..107f3bbef5 100644 --- a/papi-dts/functions/_shared_utils_papi_util_.createSafeRegisterFn.html +++ b/papi-dts/functions/_shared_utils_papi_util_.createSafeRegisterFn.html @@ -6,4 +6,4 @@
  • initialize: (() => Promise<void>)

    Promise that resolves when the service is finished initializing

  • Returns ((...args) => Promise<UnsubscriberAsync>)

    Safe version of an unsafe function that returns a promise to an UnsubscriberAsync (meaning it will wait to register until the service is initialized)

    -

    Generated using TypeDoc

    \ No newline at end of file +

    Generated using TypeDoc

    \ No newline at end of file diff --git a/papi-dts/functions/_shared_utils_papi_util_.deepEqual.html b/papi-dts/functions/_shared_utils_papi_util_.deepEqual.html index f5dd06b233..2daa9d45a4 100644 --- a/papi-dts/functions/_shared_utils_papi_util_.deepEqual.html +++ b/papi-dts/functions/_shared_utils_papi_util_.deepEqual.html @@ -15,4 +15,4 @@ CodeSandbox.

    Returns boolean

    True if a and b are deeply equal; false otherwise

    -

    Generated using TypeDoc

    \ No newline at end of file +

    Generated using TypeDoc

    \ No newline at end of file diff --git a/papi-dts/functions/_shared_utils_papi_util_.deserialize.html b/papi-dts/functions/_shared_utils_papi_util_.deserialize.html index da8a6948c3..90055d8c72 100644 --- a/papi-dts/functions/_shared_utils_papi_util_.deserialize.html +++ b/papi-dts/functions/_shared_utils_papi_util_.deserialize.html @@ -9,4 +9,4 @@

    Parameters

    Returns any

    Generated using TypeDoc

    \ No newline at end of file +

    Returns any

    Generated using TypeDoc

    \ No newline at end of file diff --git a/papi-dts/functions/_shared_utils_papi_util_.deserializeRequestType.html b/papi-dts/functions/_shared_utils_papi_util_.deserializeRequestType.html index 11ed815d8a..3df58a3974 100644 --- a/papi-dts/functions/_shared_utils_papi_util_.deserializeRequestType.html +++ b/papi-dts/functions/_shared_utils_papi_util_.deserializeRequestType.html @@ -1,2 +1,2 @@ deserializeRequestType | papi-dts

    Generated using TypeDoc

    \ No newline at end of file +

    Parameters

    Returns RequestType

    Generated using TypeDoc

    \ No newline at end of file diff --git a/papi-dts/functions/_shared_utils_papi_util_.getModuleSimilarApiMessage.html b/papi-dts/functions/_shared_utils_papi_util_.getModuleSimilarApiMessage.html index f157aee533..1763ca0590 100644 --- a/papi-dts/functions/_shared_utils_papi_util_.getModuleSimilarApiMessage.html +++ b/papi-dts/functions/_shared_utils_papi_util_.getModuleSimilarApiMessage.html @@ -1,4 +1,4 @@ getModuleSimilarApiMessage | papi-dts
    • Get a message that says the module import was rejected and to try a similar api if available.

      Parameters

      • moduleName: string

        Name of required module that was rejected

      Returns string

      String that says the import was rejected and a similar api to try

      -

    Generated using TypeDoc

    \ No newline at end of file +

    Generated using TypeDoc

    \ No newline at end of file diff --git a/papi-dts/functions/_shared_utils_papi_util_.htmlEncode.html b/papi-dts/functions/_shared_utils_papi_util_.htmlEncode.html index 5f014a783c..9e668af81b 100644 --- a/papi-dts/functions/_shared_utils_papi_util_.htmlEncode.html +++ b/papi-dts/functions/_shared_utils_papi_util_.htmlEncode.html @@ -1,4 +1,4 @@ htmlEncode | papi-dts
    • HTML Encodes the provided string. Thanks to ChatGPT

      Parameters

      • str: string

        String to HTML encode

      Returns string

      HTML-encoded string

      -

    Generated using TypeDoc

    \ No newline at end of file +

    Generated using TypeDoc

    \ No newline at end of file diff --git a/papi-dts/functions/_shared_utils_papi_util_.isSerializable.html b/papi-dts/functions/_shared_utils_papi_util_.isSerializable.html index fc45b6a157..68cbbf1623 100644 --- a/papi-dts/functions/_shared_utils_papi_util_.isSerializable.html +++ b/papi-dts/functions/_shared_utils_papi_util_.isSerializable.html @@ -14,4 +14,4 @@

    We intend to improve this in the future if it becomes important to do so. See JSON.stringify documentation for more information.

    -

    Generated using TypeDoc

    \ No newline at end of file +

    Generated using TypeDoc

    \ No newline at end of file diff --git a/papi-dts/functions/_shared_utils_papi_util_.serialize.html b/papi-dts/functions/_shared_utils_papi_util_.serialize.html index 3467fb4e54..db76c5b278 100644 --- a/papi-dts/functions/_shared_utils_papi_util_.serialize.html +++ b/papi-dts/functions/_shared_utils_papi_util_.serialize.html @@ -14,4 +14,4 @@
  • Optional space: string | number

    Adds indentation, white space, and line break characters to the return-value JSON text to make it easier to read. See the space parameter of JSON.stringify for more details.

    -
  • Returns string

    Generated using TypeDoc

    \ No newline at end of file +

    Returns string

    Generated using TypeDoc

    \ No newline at end of file diff --git a/papi-dts/functions/_shared_utils_papi_util_.serializeRequestType.html b/papi-dts/functions/_shared_utils_papi_util_.serializeRequestType.html index cbc1badc40..49d87bc9c3 100644 --- a/papi-dts/functions/_shared_utils_papi_util_.serializeRequestType.html +++ b/papi-dts/functions/_shared_utils_papi_util_.serializeRequestType.html @@ -2,4 +2,4 @@

    Parameters

    Returns SerializedRequestType

    Full requestType for use in network calls

    -

    Generated using TypeDoc

    \ No newline at end of file +

    Generated using TypeDoc

    \ No newline at end of file diff --git a/papi-dts/functions/_shared_utils_util_.debounce.html b/papi-dts/functions/_shared_utils_util_.debounce.html index 45e83a5dfe..d7deb8d881 100644 --- a/papi-dts/functions/_shared_utils_util_.debounce.html +++ b/papi-dts/functions/_shared_utils_util_.debounce.html @@ -3,4 +3,4 @@
  • Optional delay: number

    How much delay in milliseconds after the most recent call to the debounced function to call the function

  • Returns T

    Function that, when called, only calls the function passed in at maximum every delay ms

    -

    Generated using TypeDoc

    \ No newline at end of file +

    Generated using TypeDoc

    \ No newline at end of file diff --git a/papi-dts/functions/_shared_utils_util_.getAllObjectFunctionNames.html b/papi-dts/functions/_shared_utils_util_.getAllObjectFunctionNames.html index dab1534afe..5263d52746 100644 --- a/papi-dts/functions/_shared_utils_util_.getAllObjectFunctionNames.html +++ b/papi-dts/functions/_shared_utils_util_.getAllObjectFunctionNames.html @@ -5,4 +5,4 @@

    Parameters

    Returns Set<string>

    Array of all function names on an object

    -

    Generated using TypeDoc

    \ No newline at end of file +

    Generated using TypeDoc

    \ No newline at end of file diff --git a/papi-dts/functions/_shared_utils_util_.getErrorMessage.html b/papi-dts/functions/_shared_utils_util_.getErrorMessage.html index ae4298f380..686a9e4ad0 100644 --- a/papi-dts/functions/_shared_utils_util_.getErrorMessage.html +++ b/papi-dts/functions/_shared_utils_util_.getErrorMessage.html @@ -5,4 +5,4 @@ stringify

    Example

    `try {...} catch (e) { logger.info(getErrorMessage(e)) }`
     
    -

    Generated using TypeDoc

    \ No newline at end of file +

    Generated using TypeDoc

    \ No newline at end of file diff --git a/papi-dts/functions/_shared_utils_util_.groupBy.html b/papi-dts/functions/_shared_utils_util_.groupBy.html index c00e0890eb..aec6544992 100644 --- a/papi-dts/functions/_shared_utils_util_.groupBy.html +++ b/papi-dts/functions/_shared_utils_util_.groupBy.html @@ -2,4 +2,4 @@

    Type Parameters

    Parameters

    Returns Map<K, T[]>

    Map of keys to groups of values corresponding to each item

    -
  • Type Parameters

    Parameters

    Returns Map<K, V[]>

  • Generated using TypeDoc

    \ No newline at end of file +
  • Type Parameters

    Parameters

    Returns Map<K, V[]>

  • Generated using TypeDoc

    \ No newline at end of file diff --git a/papi-dts/functions/_shared_utils_util_.isString.html b/papi-dts/functions/_shared_utils_util_.isString.html index 42c42cd5c4..36214eb177 100644 --- a/papi-dts/functions/_shared_utils_util_.isString.html +++ b/papi-dts/functions/_shared_utils_util_.isString.html @@ -1,4 +1,4 @@ isString | papi-dts
    • Determine whether the object is a string

      Parameters

      • o: unknown

        Object to determine if it is a string

      Returns o is string

      True if the object is a string; false otherwise

      -

    Generated using TypeDoc

    \ No newline at end of file +

    Generated using TypeDoc

    \ No newline at end of file diff --git a/papi-dts/functions/_shared_utils_util_.newGuid.html b/papi-dts/functions/_shared_utils_util_.newGuid.html index 9ea34eedc9..4ec3324d79 100644 --- a/papi-dts/functions/_shared_utils_util_.newGuid.html +++ b/papi-dts/functions/_shared_utils_util_.newGuid.html @@ -1 +1 @@ -newGuid | papi-dts

    Generated using TypeDoc

    \ No newline at end of file +newGuid | papi-dts

    Generated using TypeDoc

    \ No newline at end of file diff --git a/papi-dts/functions/_shared_utils_util_.newNonce.html b/papi-dts/functions/_shared_utils_util_.newNonce.html index 8aa4a3a4d2..68c1246364 100644 --- a/papi-dts/functions/_shared_utils_util_.newNonce.html +++ b/papi-dts/functions/_shared_utils_util_.newNonce.html @@ -3,4 +3,4 @@

    WARNING: THIS IS NOT CURRENTLY CRYPTOGRAPHICALLY SECURE! TODO: Make this cryptographically random! Use some polymorphic library that works in all contexts? https://developer.mozilla.org/en-US/docs/Web/API/Crypto/getRandomValues only works in browser

    -

    Returns string

    Generated using TypeDoc

    \ No newline at end of file +

    Returns string

    Generated using TypeDoc

    \ No newline at end of file diff --git a/papi-dts/functions/_shared_utils_util_.wait.html b/papi-dts/functions/_shared_utils_util_.wait.html index 60167eb63b..0d699d2e6e 100644 --- a/papi-dts/functions/_shared_utils_util_.wait.html +++ b/papi-dts/functions/_shared_utils_util_.wait.html @@ -1,2 +1,2 @@ wait | papi-dts
    • Asynchronously waits for the specified number of milliseconds. (wraps setTimeout in a promise)

      -

      Parameters

      • ms: number

      Returns Promise<void>

    Generated using TypeDoc

    \ No newline at end of file +

    Parameters

    Returns Promise<void>

    Generated using TypeDoc

    \ No newline at end of file diff --git a/papi-dts/functions/_shared_utils_util_.waitForDuration.html b/papi-dts/functions/_shared_utils_util_.waitForDuration.html index 843d7badac..eab9bbd0d5 100644 --- a/papi-dts/functions/_shared_utils_util_.waitForDuration.html +++ b/papi-dts/functions/_shared_utils_util_.waitForDuration.html @@ -3,4 +3,4 @@
  • maxWaitTimeInMS: number

    The maximum amount of time to wait for the function to resolve

  • Returns Promise<Awaited<TResult> | undefined>

    Promise that resolves to the resolved value of the function or undefined if it ran longer than the specified wait time

    -

    Generated using TypeDoc

    \ No newline at end of file +

    Generated using TypeDoc

    \ No newline at end of file diff --git a/papi-dts/functions/getWebViewDefinitionUpdatableProperties.html b/papi-dts/functions/getWebViewDefinitionUpdatableProperties.html index b82fca994f..6c6a87f2a1 100644 --- a/papi-dts/functions/getWebViewDefinitionUpdatableProperties.html +++ b/papi-dts/functions/getWebViewDefinitionUpdatableProperties.html @@ -1,4 +1,4 @@ getWebViewDefinitionUpdatableProperties | papi-dts

    Function getWebViewDefinitionUpdatableProperties

    Generated using TypeDoc

    \ No newline at end of file +

    Returns undefined | WebViewDefinitionUpdatableProperties

    Generated using TypeDoc

    \ No newline at end of file diff --git a/papi-dts/functions/getWebViewDefinitionUpdatablePropertiesById.html b/papi-dts/functions/getWebViewDefinitionUpdatablePropertiesById.html index e078fedd93..83978fc19f 100644 --- a/papi-dts/functions/getWebViewDefinitionUpdatablePropertiesById.html +++ b/papi-dts/functions/getWebViewDefinitionUpdatablePropertiesById.html @@ -1 +1 @@ -getWebViewDefinitionUpdatablePropertiesById | papi-dts

    Function getWebViewDefinitionUpdatablePropertiesById

    Generated using TypeDoc

    \ No newline at end of file +getWebViewDefinitionUpdatablePropertiesById | papi-dts

    Function getWebViewDefinitionUpdatablePropertiesById

    Generated using TypeDoc

    \ No newline at end of file diff --git a/papi-dts/functions/getWebViewState.html b/papi-dts/functions/getWebViewState.html index 26c1f983fb..e06d399754 100644 --- a/papi-dts/functions/getWebViewState.html +++ b/papi-dts/functions/getWebViewState.html @@ -1,2 +1,2 @@ getWebViewState | papi-dts

    Function getWebViewState

    • Retrieve the value from web view state with the given 'stateKey', if it exists.

      -

      Type Parameters

      • T

      Parameters

      • stateKey: string

      Returns undefined | T

    Generated using TypeDoc

    \ No newline at end of file +

    Type Parameters

    Parameters

    Returns undefined | T

    Generated using TypeDoc

    \ No newline at end of file diff --git a/papi-dts/functions/setWebViewState.html b/papi-dts/functions/setWebViewState.html index 46340be943..57316f4049 100644 --- a/papi-dts/functions/setWebViewState.html +++ b/papi-dts/functions/setWebViewState.html @@ -1,2 +1,2 @@ setWebViewState | papi-dts

    Function setWebViewState

    • Set the value for a given key in the web view state.

      -

      Type Parameters

      • T

      Parameters

      • stateKey: string
      • stateValue: NonNullable<T>

      Returns void

    Generated using TypeDoc

    \ No newline at end of file +

    Type Parameters

    Parameters

    Returns void

    Generated using TypeDoc

    \ No newline at end of file diff --git a/papi-dts/functions/updateWebViewDefinition.html b/papi-dts/functions/updateWebViewDefinition.html index a245183878..278d87c044 100644 --- a/papi-dts/functions/updateWebViewDefinition.html +++ b/papi-dts/functions/updateWebViewDefinition.html @@ -5,4 +5,4 @@

    ï¼ example

    updateWebViewDefinition({ title: `Hello ${name}` });
     
    -

    Parameters

    Returns boolean

    Generated using TypeDoc

    \ No newline at end of file +

    Parameters

    Returns boolean

    Generated using TypeDoc

    \ No newline at end of file diff --git a/papi-dts/functions/updateWebViewDefinitionById.html b/papi-dts/functions/updateWebViewDefinitionById.html index cff075bd9c..37ea4ed634 100644 --- a/papi-dts/functions/updateWebViewDefinitionById.html +++ b/papi-dts/functions/updateWebViewDefinitionById.html @@ -1 +1 @@ -updateWebViewDefinitionById | papi-dts

    Function updateWebViewDefinitionById

    Generated using TypeDoc

    \ No newline at end of file +updateWebViewDefinitionById | papi-dts

    Function updateWebViewDefinitionById

    Generated using TypeDoc

    \ No newline at end of file diff --git a/papi-dts/functions/useWebViewState.html b/papi-dts/functions/useWebViewState.html index 7c0e5c271c..2dbb660c20 100644 --- a/papi-dts/functions/useWebViewState.html +++ b/papi-dts/functions/useWebViewState.html @@ -15,4 +15,4 @@

    ï¼ example

    const [lastPersonSeen, setLastPersonSeen] = useWebViewState('lastSeen', 'No one');
     
    -

    Type Parameters

    Parameters

    Returns [webViewState: NonNullable<T>, setWebViewState: Dispatch<SetStateAction<NonNullable<T>>>]

    Generated using TypeDoc

    \ No newline at end of file +

    Type Parameters

    Parameters

    Returns [webViewState: NonNullable<T>, setWebViewState: Dispatch<SetStateAction<NonNullable<T>>>]

    Generated using TypeDoc

    \ No newline at end of file diff --git a/papi-dts/interfaces/_extension_host_extension_types_extension_interface_.IExtension.html b/papi-dts/interfaces/_extension_host_extension_types_extension_interface_.IExtension.html index 32106c332f..a5514a4ca8 100644 --- a/papi-dts/interfaces/_extension_host_extension_types_extension_interface_.IExtension.html +++ b/papi-dts/interfaces/_extension_host_extension_types_extension_interface_.IExtension.html @@ -1,10 +1,10 @@ IExtension | papi-dts

    Interface for all extensions to implement

    -
    interface IExtension {
        activate: ((context) => Promise<void>);
        deactivate?: UnsubscriberAsync;
    }

    Properties

    interface IExtension {
        activate: ((context) => Promise<void>);
        deactivate?: UnsubscriberAsync;
    }

    Properties

    activate: ((context) => Promise<void>)

    Type declaration

      • (context): Promise<void>
      • Sets up this extension! Runs when paranext wants this extension to activate. For example, activate() should register commands for this extension

        Parameters

        Returns Promise<void>

    deactivate?: UnsubscriberAsync

    Deactivate anything in this extension that is not covered by the registrations in the context +

    Returns Promise<void>

    deactivate?: UnsubscriberAsync

    Deactivate anything in this extension that is not covered by the registrations in the context object given to activate().

    Returns

    Promise that resolves to true if successfully deactivated

    -

    Generated using TypeDoc

    \ No newline at end of file +

    Generated using TypeDoc

    \ No newline at end of file diff --git a/papi-dts/interfaces/_extension_host_services_extension_storage_service_.ExtensionStorageService.html b/papi-dts/interfaces/_extension_host_services_extension_storage_service_.ExtensionStorageService.html index 3f515dff0c..25cfe0b9d6 100644 --- a/papi-dts/interfaces/_extension_host_services_extension_storage_service_.ExtensionStorageService.html +++ b/papi-dts/interfaces/_extension_host_services_extension_storage_service_.ExtensionStorageService.html @@ -1,4 +1,4 @@ -ExtensionStorageService | papi-dts
    interface ExtensionStorageService {
        deleteUserData: ((token, key) => Promise<void>);
        readBinaryFileFromInstallDirectory: ((token, fileName) => Promise<Buffer>);
        readTextFileFromInstallDirectory: ((token, fileName) => Promise<string>);
        readUserData: ((token, key) => Promise<string>);
        writeUserData: ((token, key, data) => Promise<void>);
    }

    Properties

    deleteUserData +ExtensionStorageService | papi-dts
    interface ExtensionStorageService {
        deleteUserData: ((token, key) => Promise<void>);
        readBinaryFileFromInstallDirectory: ((token, fileName) => Promise<Buffer>);
        readTextFileFromInstallDirectory: ((token, fileName) => Promise<string>);
        readUserData: ((token, key) => Promise<string>);
        writeUserData: ((token, key, data) => Promise<void>);
    }

    Properties

    Parameters

    • token: ExecutionToken

      ExecutionToken provided to the extension when activate() was called

    • key: string

      Unique identifier of the data

    Returns Promise<void>

    Promise that will resolve if the data is deleted successfully

    -
    readBinaryFileFromInstallDirectory: ((token, fileName) => Promise<Buffer>)

    Type declaration

      • (token, fileName): Promise<Buffer>
      • Read a binary file from the the extension's installation directory

        +
    readBinaryFileFromInstallDirectory: ((token, fileName) => Promise<Buffer>)

    Type declaration

      • (token, fileName): Promise<Buffer>
      • Read a binary file from the the extension's installation directory

        Parameters

        • token: ExecutionToken

          ExecutionToken provided to the extension when activate() was called

        • fileName: string

          Name of the file to be read

        Returns Promise<Buffer>

        Promise for a Buffer with the contents of the file

        -
    readTextFileFromInstallDirectory: ((token, fileName) => Promise<string>)

    Type declaration

      • (token, fileName): Promise<string>
      • Read a text file from the the extension's installation directory

        +
    readTextFileFromInstallDirectory: ((token, fileName) => Promise<string>)

    Type declaration

      • (token, fileName): Promise<string>
      • Read a text file from the the extension's installation directory

        Parameters

        • token: ExecutionToken

          ExecutionToken provided to the extension when activate() was called

        • fileName: string

          Name of the file to be read

        Returns Promise<string>

        Promise for a string with the contents of the file

        -
    readUserData: ((token, key) => Promise<string>)

    Type declaration

      • (token, key): Promise<string>
      • Read data specific to the user (as identified by the OS) and extension (as identified by the +

    readUserData: ((token, key) => Promise<string>)

    Type declaration

      • (token, key): Promise<string>
      • Read data specific to the user (as identified by the OS) and extension (as identified by the ExecutionToken)

        Parameters

        • token: ExecutionToken

          ExecutionToken provided to the extension when activate() was called

        • key: string

          Unique identifier of the data

        Returns Promise<string>

        Promise for a string containing the data

        -
    writeUserData: ((token, key, data) => Promise<void>)

    Type declaration

      • (token, key, data): Promise<void>
      • Write data specific to the user (as identified by the OS) and extension (as identified by the +

    writeUserData: ((token, key, data) => Promise<void>)

    Type declaration

      • (token, key, data): Promise<void>
      • Write data specific to the user (as identified by the OS) and extension (as identified by the ExecutionToken)

        Parameters

        • token: ExecutionToken

          ExecutionToken provided to the extension when activate() was called

        • key: string

          Unique identifier of the data

        • data: string

          Data to be written

        Returns Promise<void>

        Promise that will resolve if the data is written successfully

        -

    Generated using TypeDoc

    \ No newline at end of file +

    Generated using TypeDoc

    \ No newline at end of file diff --git a/papi-dts/interfaces/_papi_shared_types_.CommandHandlers.html b/papi-dts/interfaces/_papi_shared_types_.CommandHandlers.html index fd31919366..0f7ff13386 100644 --- a/papi-dts/interfaces/_papi_shared_types_.CommandHandlers.html +++ b/papi-dts/interfaces/_papi_shared_types_.CommandHandlers.html @@ -6,7 +6,7 @@ following to its .d.ts file:

    Example

    declare module 'papi-shared-types' {
    export interface CommandHandlers {
    'myExtension.myCommand1': (foo: string, bar: number) => string;
    'myExtension.myCommand2': (foo: string) => Promise<void>;
    }
    }
    -
    interface CommandHandlers {
        platform.quit: (() => Promise<void>);
        platform.restartExtensionHost: (() => Promise<void>);
        test.addMany: ((...nums) => number);
        test.echo: ((message) => string);
        test.echoExtensionHost: ((message) => Promise<string>);
        test.echoRenderer: ((message) => Promise<string>);
        test.throwError: ((message) => void);
        test.throwErrorExtensionHost: ((message) => void);
    }

    Properties

    interface CommandHandlers {
        platform.quit: (() => Promise<void>);
        platform.restartExtensionHost: (() => Promise<void>);
        test.addMany: ((...nums) => number);
        test.echo: ((message) => string);
        test.echoExtensionHost: ((message) => Promise<string>);
        test.echoRenderer: ((message) => Promise<string>);
        test.throwError: ((message) => void);
        test.throwErrorExtensionHost: ((message) => void);
    }

    Properties

    platform.quit: (() => Promise<void>)

    Type declaration

      • (): Promise<void>
      • Returns Promise<void>

    platform.restartExtensionHost: (() => Promise<void>)

    Type declaration

      • (): Promise<void>
      • Returns Promise<void>

    test.addMany: ((...nums) => number)

    Type declaration

      • (...nums): number
      • Parameters

        • Rest ...nums: number[]

        Returns number

    test.echo: ((message) => string)

    Type declaration

      • (message): string
      • Parameters

        • message: string

        Returns string

    test.echoExtensionHost: ((message) => Promise<string>)

    Type declaration

      • (message): Promise<string>
      • Parameters

        • message: string

        Returns Promise<string>

    test.echoRenderer: ((message) => Promise<string>)

    Type declaration

      • (message): Promise<string>
      • Parameters

        • message: string

        Returns Promise<string>

    test.throwError: ((message) => void)

    Type declaration

      • (message): void
      • Parameters

        • message: string

        Returns void

    test.throwErrorExtensionHost: ((message) => void)

    Type declaration

      • (message): void
      • Parameters

        • message: string

        Returns void

    Generated using TypeDoc

    \ No newline at end of file +

    Properties

    platform.quit: (() => Promise<void>)

    Type declaration

      • (): Promise<void>
      • Returns Promise<void>

    platform.restartExtensionHost: (() => Promise<void>)

    Type declaration

      • (): Promise<void>
      • Returns Promise<void>

    test.addMany: ((...nums) => number)

    Type declaration

      • (...nums): number
      • Parameters

        • Rest ...nums: number[]

        Returns number

    test.echo: ((message) => string)

    Type declaration

      • (message): string
      • Parameters

        • message: string

        Returns string

    test.echoExtensionHost: ((message) => Promise<string>)

    Type declaration

      • (message): Promise<string>
      • Parameters

        • message: string

        Returns Promise<string>

    test.echoRenderer: ((message) => Promise<string>)

    Type declaration

      • (message): Promise<string>
      • Parameters

        • message: string

        Returns Promise<string>

    test.throwError: ((message) => void)

    Type declaration

      • (message): void
      • Parameters

        • message: string

        Returns void

    test.throwErrorExtensionHost: ((message) => void)

    Type declaration

      • (message): void
      • Parameters

        • message: string

        Returns void

    Generated using TypeDoc

    \ No newline at end of file diff --git a/papi-dts/interfaces/_papi_shared_types_.DataProviders.html b/papi-dts/interfaces/_papi_shared_types_.DataProviders.html index 4d7a4cf40e..1050cce767 100644 --- a/papi-dts/interfaces/_papi_shared_types_.DataProviders.html +++ b/papi-dts/interfaces/_papi_shared_types_.DataProviders.html @@ -10,6 +10,6 @@ 'helloSomeone.people' data provider types):

    Example

    declare module 'papi-shared-types' {
    export type PeopleDataTypes = {
    Greeting: DataProviderDataType<string, string | undefined, string>;
    Age: DataProviderDataType<string, number | undefined, number>;
    People: DataProviderDataType<undefined, PeopleData, never>;
    };

    export type PeopleDataMethods = {
    deletePerson(name: string): Promise<boolean>;
    testRandomMethod(things: string): Promise<string>;
    };

    export type PeopleDataProvider = IDataProvider<PeopleDataTypes> & PeopleDataMethods;

    export interface DataProviders {
    'helloSomeone.people': PeopleDataProvider;
    }
    }
    -
    interface DataProviders {
        platform.placeholder: "shared/models/data-provider.interface".default<PlaceholderDataTypes>;
        platform.stuff: "shared/models/data-provider.interface".default<StuffDataTypes>;
    }

    Generated using TypeDoc

    \ No newline at end of file +

    Properties

    Generated using TypeDoc

    \ No newline at end of file diff --git a/papi-dts/interfaces/_papi_shared_types_.ProjectDataTypes.html b/papi-dts/interfaces/_papi_shared_types_.ProjectDataTypes.html index c468deeb12..d4e78eaca4 100644 --- a/papi-dts/interfaces/_papi_shared_types_.ProjectDataTypes.html +++ b/papi-dts/interfaces/_papi_shared_types_.ProjectDataTypes.html @@ -3,6 +3,6 @@ all project data types should extend MandatoryProjectDataTypes like the following example.

    Example

    declare module 'papi-shared-types' {
    export type MyProjectDataTypes = MandatoryProjectDataTypes & {
    MyProjectData1: DataProviderDataType<string, string, string>;
    MyProjectData2: DataProviderDataType<string, string, string>;
    };

    export interface ProjectDataTypes {
    MyExtensionProjectTypeName: MyProjectDataTypes;
    }
    }
    -
    interface ProjectDataTypes {
        NotesOnly: NotesOnlyProjectDataTypes;
        placeholder: MandatoryProjectDataType;
    }

    Properties

    interface ProjectDataTypes {
        NotesOnly: NotesOnlyProjectDataTypes;
        placeholder: MandatoryProjectDataType;
    }

    Properties

    Generated using TypeDoc

    \ No newline at end of file +

    Properties

    Generated using TypeDoc

    \ No newline at end of file diff --git a/papi-dts/interfaces/_papi_shared_types_.SettingTypes.html b/papi-dts/interfaces/_papi_shared_types_.SettingTypes.html index 0def3e6a50..c5481ebbc3 100644 --- a/papi-dts/interfaces/_papi_shared_types_.SettingTypes.html +++ b/papi-dts/interfaces/_papi_shared_types_.SettingTypes.html @@ -1,3 +1,3 @@ -SettingTypes | papi-dts
    interface SettingTypes {
        placeholder: undefined;
        platform.verseRef: ScriptureReference;
    }

    Properties

    placeholder +SettingTypes | papi-dts

    Generated using TypeDoc

    \ No newline at end of file +

    Properties

    placeholder: undefined
    platform.verseRef: ScriptureReference

    Generated using TypeDoc

    \ No newline at end of file diff --git a/papi-dts/interfaces/_renderer_components_dialogs_dialog_definition_model_.DialogTypes.html b/papi-dts/interfaces/_renderer_components_dialogs_dialog_definition_model_.DialogTypes.html index ea8905fc35..22138eb4d9 100644 --- a/papi-dts/interfaces/_renderer_components_dialogs_dialog_definition_model_.DialogTypes.html +++ b/papi-dts/interfaces/_renderer_components_dialogs_dialog_definition_model_.DialogTypes.html @@ -1,6 +1,6 @@ DialogTypes | papi-dts

    Mapped type for dialog functions to use in getting various types for dialogs

    Keys should be dialog names, and values should be DialogDataTypes

    If you add a dialog here, you must also add it on DIALOGS

    -

    Properties

    Properties

    platform.selectMultipleProjects: DialogDataTypes<SelectMultipleProjectsDialogOptions, string[]>
    platform.selectProject: DialogDataTypes<SelectProjectDialogOptions, string>

    Generated using TypeDoc

    \ No newline at end of file +

    Properties

    platform.selectMultipleProjects: DialogDataTypes<SelectMultipleProjectsDialogOptions, string[]>
    platform.selectProject: DialogDataTypes<SelectProjectDialogOptions, string>

    Generated using TypeDoc

    \ No newline at end of file diff --git a/papi-dts/interfaces/_shared_models_disposal_model_.CannotHaveOnDidDispose.html b/papi-dts/interfaces/_shared_models_disposal_model_.CannotHaveOnDidDispose.html index 68dd672f7b..6f1a83fc9a 100644 --- a/papi-dts/interfaces/_shared_models_disposal_model_.CannotHaveOnDidDispose.html +++ b/papi-dts/interfaces/_shared_models_disposal_model_.CannotHaveOnDidDispose.html @@ -1,7 +1,7 @@ CannotHaveOnDidDispose | papi-dts

    Indicates than an object cannot have an onDidDispose event. Also allows an object to include a dispose function.

    -
    interface CannotHaveOnDidDispose {
        dispose?: UnsubscriberAsync;
        onDidDispose?: undefined;
    }

    Properties

    interface CannotHaveOnDidDispose {
        dispose?: UnsubscriberAsync;
        onDidDispose?: undefined;
    }

    Properties

    Release resources and notify dependent services when tearing down an object

    -
    onDidDispose?: undefined

    Event that emits when dispose is called on an object

    -

    Generated using TypeDoc

    \ No newline at end of file +
    onDidDispose?: undefined

    Event that emits when dispose is called on an object

    +

    Generated using TypeDoc

    \ No newline at end of file diff --git a/papi-dts/interfaces/_shared_models_disposal_model_.Dispose.html b/papi-dts/interfaces/_shared_models_disposal_model_.Dispose.html index 0ad1bda0d7..55f0766bf1 100644 --- a/papi-dts/interfaces/_shared_models_disposal_model_.Dispose.html +++ b/papi-dts/interfaces/_shared_models_disposal_model_.Dispose.html @@ -1,4 +1,4 @@ Dispose | papi-dts

    Require a dispose function

    -
    interface Dispose {
        dispose: UnsubscriberAsync;
    }

    Implemented by

    Properties

    interface Dispose {
        dispose: UnsubscriberAsync;
    }

    Implemented by

    Properties

    Properties

    Release resources and notify dependent services when tearing down an object

    -

    Generated using TypeDoc

    \ No newline at end of file +

    Generated using TypeDoc

    \ No newline at end of file diff --git a/papi-dts/interfaces/_shared_models_disposal_model_.OnDidDispose.html b/papi-dts/interfaces/_shared_models_disposal_model_.OnDidDispose.html index 6d9ad81d05..906f164827 100644 --- a/papi-dts/interfaces/_shared_models_disposal_model_.OnDidDispose.html +++ b/papi-dts/interfaces/_shared_models_disposal_model_.OnDidDispose.html @@ -1,4 +1,4 @@ OnDidDispose | papi-dts

    Require an onDidDispose event

    -
    interface OnDidDispose {
        onDidDispose: PapiEvent<void>;
    }

    Properties

    interface OnDidDispose {
        onDidDispose: PapiEvent<void>;
    }

    Properties

    Properties

    onDidDispose: PapiEvent<void>

    Event that emits when dispose is called on an object

    -

    Generated using TypeDoc

    \ No newline at end of file +

    Generated using TypeDoc

    \ No newline at end of file diff --git a/papi-dts/interfaces/_shared_models_docking_framework_model_.FloatLayout.html b/papi-dts/interfaces/_shared_models_docking_framework_model_.FloatLayout.html index 422c963fd8..245d2a38c4 100644 --- a/papi-dts/interfaces/_shared_models_docking_framework_model_.FloatLayout.html +++ b/papi-dts/interfaces/_shared_models_docking_framework_model_.FloatLayout.html @@ -1,6 +1,6 @@ FloatLayout | papi-dts

    Information about a floating window

    -
    interface FloatLayout {
        floatSize?: FloatSize;
        position?: FloatPosition;
        type: "float";
    }

    Properties

    interface FloatLayout {
        floatSize?: FloatSize;
        position?: FloatPosition;
        type: "float";
    }

    Properties

    floatSize?: FloatSize
    position?: FloatPosition

    Where to display the floating window. Defaults to cascade

    -
    type: "float"

    Generated using TypeDoc

    \ No newline at end of file +

    Properties

    floatSize?: FloatSize
    position?: FloatPosition

    Where to display the floating window. Defaults to cascade

    +
    type: "float"

    Generated using TypeDoc

    \ No newline at end of file diff --git a/papi-dts/interfaces/_shared_models_docking_framework_model_.PanelLayout.html b/papi-dts/interfaces/_shared_models_docking_framework_model_.PanelLayout.html index a38ca6cb47..74dc08ab19 100644 --- a/papi-dts/interfaces/_shared_models_docking_framework_model_.PanelLayout.html +++ b/papi-dts/interfaces/_shared_models_docking_framework_model_.PanelLayout.html @@ -1,6 +1,6 @@ PanelLayout | papi-dts

    Information about a panel

    -
    interface PanelLayout {
        direction?: PanelDirection;
        targetTabId?: string;
        type: "panel";
    }

    Properties

    interface PanelLayout {
        direction?: PanelDirection;
        targetTabId?: string;
        type: "panel";
    }

    Properties

    direction?: PanelDirection
    targetTabId?: string

    If undefined, it will add in the direction relative to the previously added tab.

    -
    type: "panel"

    Generated using TypeDoc

    \ No newline at end of file +

    Properties

    direction?: PanelDirection
    targetTabId?: string

    If undefined, it will add in the direction relative to the previously added tab.

    +
    type: "panel"

    Generated using TypeDoc

    \ No newline at end of file diff --git a/papi-dts/interfaces/_shared_models_docking_framework_model_.TabLayout.html b/papi-dts/interfaces/_shared_models_docking_framework_model_.TabLayout.html index 12c8e65d46..3da615a33a 100644 --- a/papi-dts/interfaces/_shared_models_docking_framework_model_.TabLayout.html +++ b/papi-dts/interfaces/_shared_models_docking_framework_model_.TabLayout.html @@ -1,3 +1,3 @@ TabLayout | papi-dts

    Information about a tab in a panel

    -
    interface TabLayout {
        type: "tab";
    }

    Properties

    Properties

    type: "tab"

    Generated using TypeDoc

    \ No newline at end of file +
    interface TabLayout {
        type: "tab";
    }

    Properties

    Properties

    type: "tab"

    Generated using TypeDoc

    \ No newline at end of file diff --git a/papi-dts/interfaces/_shared_models_project_data_provider_engine_model_.ProjectDataProviderEngineFactory.html b/papi-dts/interfaces/_shared_models_project_data_provider_engine_model_.ProjectDataProviderEngineFactory.html index 25dc7cedb8..a31d649525 100644 --- a/papi-dts/interfaces/_shared_models_project_data_provider_engine_model_.ProjectDataProviderEngineFactory.html +++ b/papi-dts/interfaces/_shared_models_project_data_provider_engine_model_.ProjectDataProviderEngineFactory.html @@ -1,2 +1,2 @@ -ProjectDataProviderEngineFactory | papi-dts
    interface ProjectDataProviderEngineFactory {
        createProjectDataProviderEngine(projectId, projectStorageInterpreterId): ProjectDataProviderEngineTypes[ProjectType];
    }

    Type Parameters

    Methods

    Generated using TypeDoc

    \ No newline at end of file +ProjectDataProviderEngineFactory | papi-dts
    interface ProjectDataProviderEngineFactory {
        createProjectDataProviderEngine(projectId, projectStorageInterpreterId): ProjectDataProviderEngineTypes[ProjectType];
    }

    Type Parameters

    Methods

    Generated using TypeDoc

    \ No newline at end of file diff --git a/papi-dts/interfaces/_shared_models_web_view_provider_model_.DisposableWebViewProvider.html b/papi-dts/interfaces/_shared_models_web_view_provider_model_.DisposableWebViewProvider.html index 0be9fba70b..13a51a110a 100644 --- a/papi-dts/interfaces/_shared_models_web_view_provider_model_.DisposableWebViewProvider.html +++ b/papi-dts/interfaces/_shared_models_web_view_provider_model_.DisposableWebViewProvider.html @@ -1,10 +1,10 @@ DisposableWebViewProvider | papi-dts

    An object of this type is returned from networkObjectService.set.

    See

    networkObjectService

    -
    interface DisposableWebViewProvider {
        dispose: UnsubscriberAsync;
        onDidDispose: PapiEvent<void>;
        getWebView(savedWebView, getWebViewOptions): Promise<undefined | WebViewDefinition>;
    }

    Hierarchy

    Properties

    interface DisposableWebViewProvider {
        dispose: UnsubscriberAsync;
        onDidDispose: PapiEvent<void>;
        getWebView(savedWebView, getWebViewOptions): Promise<undefined | WebViewDefinition>;
    }

    Hierarchy

    Properties

    Methods

    Properties

    Release resources and notify dependent services when tearing down an object

    -
    onDidDispose: PapiEvent<void>

    Event that emits when dispose is called on an object

    -

    Methods

    onDidDispose: PapiEvent<void>

    Event that emits when dispose is called on an object

    +

    Methods

    Generated using TypeDoc

    \ No newline at end of file +
  • getWebViewOptions: GetWebViewOptions
  • Returns Promise<undefined | WebViewDefinition>

    Generated using TypeDoc

    \ No newline at end of file diff --git a/papi-dts/interfaces/_shared_models_web_view_provider_model_.IWebViewProvider.html b/papi-dts/interfaces/_shared_models_web_view_provider_model_.IWebViewProvider.html index 960bef4add..f202277470 100644 --- a/papi-dts/interfaces/_shared_models_web_view_provider_model_.IWebViewProvider.html +++ b/papi-dts/interfaces/_shared_models_web_view_provider_model_.IWebViewProvider.html @@ -1,10 +1,10 @@ IWebViewProvider | papi-dts

    An object of this type is passed into networkObjectService.set.

    See

    networkObjectService

    -
    interface IWebViewProvider {
        dispose?: UnsubscriberAsync;
        onDidDispose?: undefined;
        getWebView(savedWebView, getWebViewOptions): Promise<undefined | WebViewDefinition>;
    }

    Hierarchy

    Properties

    interface IWebViewProvider {
        dispose?: UnsubscriberAsync;
        onDidDispose?: undefined;
        getWebView(savedWebView, getWebViewOptions): Promise<undefined | WebViewDefinition>;
    }

    Hierarchy

    Properties

    Release resources and notify dependent services when tearing down an object

    -
    onDidDispose?: undefined

    Event that emits when dispose is called on an object

    -

    Methods

    onDidDispose?: undefined

    Event that emits when dispose is called on an object

    +

    Methods

    Generated using TypeDoc

    \ No newline at end of file +
  • getWebViewOptions: GetWebViewOptions
  • Returns Promise<undefined | WebViewDefinition>

    Generated using TypeDoc

    \ No newline at end of file diff --git a/papi-dts/interfaces/_shared_models_web_view_provider_model_.WebViewProvider.html b/papi-dts/interfaces/_shared_models_web_view_provider_model_.WebViewProvider.html index 2d83643742..0d68b580c9 100644 --- a/papi-dts/interfaces/_shared_models_web_view_provider_model_.WebViewProvider.html +++ b/papi-dts/interfaces/_shared_models_web_view_provider_model_.WebViewProvider.html @@ -5,11 +5,11 @@ call that method. This is because we don't want users of network objects to dispose of them. Only the caller of networkObjectService.set should be able to dispose of the network object.

    See

    networkObjectService

    -
    interface WebViewProvider {
        dispose?: UnsubscriberAsync;
        onDidDispose: PapiEvent<void>;
        getWebView(savedWebView, getWebViewOptions): Promise<undefined | WebViewDefinition>;
    }

    Hierarchy

    Properties

    interface WebViewProvider {
        dispose?: UnsubscriberAsync;
        onDidDispose: PapiEvent<void>;
        getWebView(savedWebView, getWebViewOptions): Promise<undefined | WebViewDefinition>;
    }

    Hierarchy

    Properties

    Methods

    Properties

    Release resources and notify dependent services when tearing down an object

    -
    onDidDispose: PapiEvent<void>

    Event that emits when dispose is called on an object

    -

    Methods

    onDidDispose: PapiEvent<void>

    Event that emits when dispose is called on an object

    +

    Methods

    Generated using TypeDoc

    \ No newline at end of file +
  • getWebViewOptions: GetWebViewOptions
  • Returns Promise<undefined | WebViewDefinition>

    Generated using TypeDoc

    \ No newline at end of file diff --git a/papi-dts/interfaces/_shared_services_data_provider_service_.DataProviderService.html b/papi-dts/interfaces/_shared_services_data_provider_service_.DataProviderService.html index 4d1a0b8b06..cb8fe0d7ec 100644 --- a/papi-dts/interfaces/_shared_services_data_provider_service_.DataProviderService.html +++ b/papi-dts/interfaces/_shared_services_data_provider_service_.DataProviderService.html @@ -1,9 +1,9 @@ -DataProviderService | papi-dts
    interface DataProviderService {
        DataProviderEngine: typeof "shared/services/data-provider.service".DataProviderEngine;
        decorators: {
            ignore: {
                (method): void;
                <T>(target, member): void;
            };
        };
        get: (<DataProviderName>(providerName) => Promise<DataProviders[DataProviderName] | undefined>);
        hasKnown: ((providerName) => boolean);
        registerEngine: (<DataProviderName>(providerName, dataProviderEngine) => Promise<DisposableDataProviders[DataProviderName]>);
    }

    Properties

    DataProviderEngine +DataProviderService | papi-dts
    interface DataProviderService {
        DataProviderEngine: typeof "shared/services/data-provider.service".DataProviderEngine;
        decorators: {
            ignore: {
                (method): void;
                <T>(target, member): void;
            };
        };
        get: (<DataProviderName>(providerName) => Promise<DataProviders[DataProviderName] | undefined>);
        hasKnown: ((providerName) => boolean);
        registerEngine: (<DataProviderName>(providerName, dataProviderEngine) => Promise<DisposableDataProviders[DataProviderName]>);
    }

    Properties

    decorators: {
        ignore: {
            (method): void;
            <T>(target, member): void;
        };
    }

    Type declaration

    • ignore: {
          (method): void;
          <T>(target, member): void;
      }
        • (method): void
        • Decorator function that marks a data provider engine set___ or get___ method to be ignored. +

    Properties

    decorators: {
        ignore: {
            (method): void;
            <T>(target, member): void;
        };
    }

    Type declaration

    • ignore: {
          (method): void;
          <T>(target, member): void;
      }
        • (method): void
        • Decorator function that marks a data provider engine set___ or get___ method to be ignored. papi will not layer over these methods or consider them to be data type methods

          Parameters

          • method: Function & {
                isIgnored?: boolean;
            }

            The method to ignore

          Returns void

          Example: Use this as a decorator on a class's method:

          class MyDataProviderEngine {
          ï¼ papi.dataProviders.decorators.ignore
          async getInternal() {}
          } @@ -20,13 +20,13 @@

          Example: Call this function signature on an object's method:

        • member: keyof T

          The name of the method to ignore

          Note: this is the signature that provides the actual decorator functionality. However, since users will not be using this signature, the example usage is provided in the signature above.

          -

    Returns void

    get: (<DataProviderName>(providerName) => Promise<DataProviders[DataProviderName] | undefined>)

    Type declaration

      • <DataProviderName>(providerName): Promise<DataProviders[DataProviderName] | undefined>
      • Get a data provider that has previously been set up

        +

    Returns void

    get: (<DataProviderName>(providerName) => Promise<DataProviders[DataProviderName] | undefined>)

    Type declaration

      • <DataProviderName>(providerName): Promise<DataProviders[DataProviderName] | undefined>
      • Get a data provider that has previously been set up

        Type Parameters

        Parameters

        • providerName: DataProviderName

          Name of the desired data provider

        Returns Promise<DataProviders[DataProviderName] | undefined>

        The data provider with the given name if one exists, undefined otherwise

        -
    hasKnown: ((providerName) => boolean)

    Type declaration

      • (providerName): boolean
      • Indicate if we are aware of an existing data provider with the given name. If a data provider +

    hasKnown: ((providerName) => boolean)

    Type declaration

      • (providerName): boolean
      • Indicate if we are aware of an existing data provider with the given name. If a data provider with the given name is somewhere else on the network, this function won't tell you about it unless something else in the existing process is subscribed to it.

        -

        Parameters

        • providerName: string

        Returns boolean

    registerEngine: (<DataProviderName>(providerName, dataProviderEngine) => Promise<DisposableDataProviders[DataProviderName]>)

    Type declaration

      • <DataProviderName>(providerName, dataProviderEngine): Promise<DisposableDataProviders[DataProviderName]>
      • Creates a data provider to be shared on the network layering over the provided data provider +

        Parameters

        • providerName: string

        Returns boolean

    registerEngine: (<DataProviderName>(providerName, dataProviderEngine) => Promise<DisposableDataProviders[DataProviderName]>)

    Type declaration

    Generated using TypeDoc

    \ No newline at end of file +

    Generated using TypeDoc

    \ No newline at end of file diff --git a/papi-dts/interfaces/_shared_services_dialog_service_model_.DialogService.html b/papi-dts/interfaces/_shared_services_dialog_service_model_.DialogService.html index 28e2b7c918..09b7ee0549 100644 --- a/papi-dts/interfaces/_shared_services_dialog_service_model_.DialogService.html +++ b/papi-dts/interfaces/_shared_services_dialog_service_model_.DialogService.html @@ -1,11 +1,11 @@ DialogService | papi-dts

    Prompt the user for responses with dialogs

    -
    interface DialogService {
        selectProject(options?): Promise<undefined | string>;
        showDialog<DialogTabType>(dialogType, options?): Promise<undefined | DialogTypes[DialogTabType]["responseType"]>;
    }

    Methods

    interface DialogService {
        selectProject(options?): Promise<undefined | string>;
        showDialog<DialogTabType>(dialogType, options?): Promise<undefined | DialogTypes[DialogTabType]["responseType"]>;
    }

    Methods

    • Shows a select project dialog to the user and prompts the user to select a dialog

      Parameters

      • Optional options: DialogOptions

        Various options for configuring the dialog that shows

      Returns Promise<undefined | string>

      Returns the user's selected project id or undefined if the user cancels

      -
    • Shows a dialog to the user and prompts the user to respond

      +
    • Shows a dialog to the user and prompts the user to respond

      Type Parameters

      Parameters

      • dialogType: DialogTabType

        The type of dialog to show the user

      • Optional options: DialogTypes[DialogTabType]["options"]

        Various options for configuring the dialog that shows

      Returns Promise<undefined | DialogTypes[DialogTabType]["responseType"]>

      Returns the user's response or undefined if the user cancels

      -

    Generated using TypeDoc

    \ No newline at end of file +

    Generated using TypeDoc

    \ No newline at end of file diff --git a/papi-dts/interfaces/_shared_services_internet_service_.InternetService.html b/papi-dts/interfaces/_shared_services_internet_service_.InternetService.html index 4339a9f799..91c083ea6a 100644 --- a/papi-dts/interfaces/_shared_services_internet_service_.InternetService.html +++ b/papi-dts/interfaces/_shared_services_internet_service_.InternetService.html @@ -1,3 +1,3 @@ -InternetService | papi-dts
    interface InternetService {
        fetch: ((input, init?) => Promise<Response>);
    }

    Properties

    fetch +InternetService | papi-dts

    Generated using TypeDoc

    \ No newline at end of file +

    Parameters

    • input: RequestInfo | URL
    • Optional init: RequestInit

    Returns Promise<Response>

    Generated using TypeDoc

    \ No newline at end of file diff --git a/papi-dts/interfaces/_shared_services_network_connector_interface_.default.html b/papi-dts/interfaces/_shared_services_network_connector_interface_.default.html index 2db88292b4..ac89c73ac2 100644 --- a/papi-dts/interfaces/_shared_services_network_connector_interface_.default.html +++ b/papi-dts/interfaces/_shared_services_network_connector_interface_.default.html @@ -1,7 +1,7 @@ default | papi-dts

    Interface that defines the network connection functionality the server and the client must implement. Used by NetworkConnectorFactory to supply the right kind of NetworkConnector to ConnectionService

    -
    interface default {
        connect: ((localRequestHandler, requestRouter, localEventHandler, networkConnectorEventHandlers) => Promise<Readonly<{
            clientId: number;
        }>>);
        connectionStatus: ConnectionStatus;
        connectorInfo: Readonly<{
            clientId: number;
        }>;
        disconnect: (() => void);
        emitEventOnNetwork: (<T>(eventType, event) => Promise<void>);
        notifyClientConnected: (() => Promise<void>);
        request: InternalRequestHandler;
    }

    Implemented by

    Properties

    interface default {
        connect: ((localRequestHandler, requestRouter, localEventHandler, networkConnectorEventHandlers) => Promise<Readonly<{
            clientId: number;
        }>>);
        connectionStatus: ConnectionStatus;
        connectorInfo: Readonly<{
            clientId: number;
        }>;
        disconnect: (() => void);
        emitEventOnNetwork: (<T>(eventType, event) => Promise<void>);
        notifyClientConnected: (() => Promise<void>);
        request: InternalRequestHandler;
    }

    Implemented by

    Properties

  • networkConnectorEventHandlers: NetworkConnectorEventHandlers

    Functions that run when network connector events occur like when clients are disconnected

  • Returns Promise<Readonly<{
        clientId: number;
    }>>

    Promise that resolves with connector info when finished connecting

    -
    connectionStatus: ConnectionStatus

    Whether this connector is setting up or has finished setting up its connection and is ready to +

    connectionStatus: ConnectionStatus

    Whether this connector is setting up or has finished setting up its connection and is ready to communicate on the network

    -
    connectorInfo: Readonly<{
        clientId: number;
    }>

    Information about the connector. Populated by the server while connecting

    -

    Type declaration

    • clientId: number
    disconnect: (() => void)

    Type declaration

    connectorInfo: Readonly<{
        clientId: number;
    }>

    Information about the connector. Populated by the server while connecting

    +

    Type declaration

    • clientId: number
    disconnect: (() => void)

    Type declaration

      • (): void
      • Disconnects from the connection:

        • On Client: disconnects from the server
        • On Server: disconnects from clients and closes its connection endpoint
        -

        Returns void

    emitEventOnNetwork: (<T>(eventType, event) => Promise<void>)

    Type declaration

      • <T>(eventType, event): Promise<void>
      • Sends an event to other processes. Does NOT run the local event subscriptions as they should be +

        Returns void

    emitEventOnNetwork: (<T>(eventType, event) => Promise<void>)

    Type declaration

      • <T>(eventType, event): Promise<void>
      • Sends an event to other processes. Does NOT run the local event subscriptions as they should be run by NetworkEventEmitter after sending on network.

        Type Parameters

        • T

        Parameters

        • eventType: string

          Unique network event type for coordinating between processes

        • event: InternalEvent<T>

          Event to emit on the network

          -

        Returns Promise<void>

    notifyClientConnected: (() => Promise<void>)

    Type declaration

      • (): Promise<void>
      • Notify the server that this client has received its connectorInfo and is ready to go.

        +

    Returns Promise<void>

    notifyClientConnected: (() => Promise<void>)

    Type declaration

      • (): Promise<void>
      • Notify the server that this client has received its connectorInfo and is ready to go.

        MUST RUN AFTER connect() WHEN ITS PROMISE RESOLVES

        TODO: Is this necessary?

        -

        Returns Promise<void>

    Send a request to the server/a client and resolve after receiving a response

    +

    Returns Promise<void>

    Send a request to the server/a client and resolve after receiving a response

    Param: requestType

    The type of request

    Param: contents

    Contents to send in the request

    Returns

    Promise that resolves with the response message

    -

    Generated using TypeDoc

    \ No newline at end of file +

    Generated using TypeDoc

    \ No newline at end of file diff --git a/papi-dts/interfaces/_shared_services_network_object_status_service_model_.NetworkObjectStatusRemoteServiceType.html b/papi-dts/interfaces/_shared_services_network_object_status_service_model_.NetworkObjectStatusRemoteServiceType.html index b0d5bd51a3..3ce0b3a333 100644 --- a/papi-dts/interfaces/_shared_services_network_object_status_service_model_.NetworkObjectStatusRemoteServiceType.html +++ b/papi-dts/interfaces/_shared_services_network_object_status_service_model_.NetworkObjectStatusRemoteServiceType.html @@ -1,5 +1,5 @@ -NetworkObjectStatusRemoteServiceType | papi-dts
    interface NetworkObjectStatusRemoteServiceType {
        getAllNetworkObjectDetails: (() => Promise<Record<string, NetworkObjectDetails>>);
    }

    Hierarchy

    Properties

    getAllNetworkObjectDetails +NetworkObjectStatusRemoteServiceType | papi-dts
    interface NetworkObjectStatusRemoteServiceType {
        getAllNetworkObjectDetails: (() => Promise<Record<string, NetworkObjectDetails>>);
    }

    Hierarchy

    Properties

    getAllNetworkObjectDetails: (() => Promise<Record<string, NetworkObjectDetails>>)

    Type declaration

    Generated using TypeDoc

    \ No newline at end of file +

    Generated using TypeDoc

    \ No newline at end of file diff --git a/papi-dts/interfaces/_shared_services_network_object_status_service_model_.NetworkObjectStatusServiceType.html b/papi-dts/interfaces/_shared_services_network_object_status_service_model_.NetworkObjectStatusServiceType.html index 5fc57a7653..ae29cba45b 100644 --- a/papi-dts/interfaces/_shared_services_network_object_status_service_model_.NetworkObjectStatusServiceType.html +++ b/papi-dts/interfaces/_shared_services_network_object_status_service_model_.NetworkObjectStatusServiceType.html @@ -1,11 +1,11 @@ NetworkObjectStatusServiceType | papi-dts

    Provides functions related to the set of available network objects

    -
    interface NetworkObjectStatusServiceType {
        getAllNetworkObjectDetails: (() => Promise<Record<string, NetworkObjectDetails>>);
        waitForNetworkObject: ((id, timeoutInMS?) => Promise<NetworkObjectDetails>);
    }

    Hierarchy

    Properties

    interface NetworkObjectStatusServiceType {
        getAllNetworkObjectDetails: (() => Promise<Record<string, NetworkObjectDetails>>);
        waitForNetworkObject: ((id, timeoutInMS?) => Promise<NetworkObjectDetails>);
    }

    Hierarchy

    Properties

    getAllNetworkObjectDetails: (() => Promise<Record<string, NetworkObjectDetails>>)

    Type declaration

    waitForNetworkObject: ((id, timeoutInMS?) => Promise<NetworkObjectDetails>)

    Type declaration

      • (id, timeoutInMS?): Promise<NetworkObjectDetails>
      • Get a promise that resolves when a network object is registered or rejects if a timeout is hit

        +
    waitForNetworkObject: ((id, timeoutInMS?) => Promise<NetworkObjectDetails>)

    Type declaration

      • (id, timeoutInMS?): Promise<NetworkObjectDetails>
      • Get a promise that resolves when a network object is registered or rejects if a timeout is hit

        Parameters

        • id: string
        • Optional timeoutInMS: number

        Returns Promise<NetworkObjectDetails>

        Promise that either resolves to the NetworkObjectDetails for a network object once the network object is registered, or rejects if a timeout is provided and the timeout is reached before the network object is registered

        -

    Generated using TypeDoc

    \ No newline at end of file +

    Generated using TypeDoc

    \ No newline at end of file diff --git a/papi-dts/interfaces/_shared_services_network_service_.PapiNetworkService.html b/papi-dts/interfaces/_shared_services_network_service_.PapiNetworkService.html index b26a28ddef..0b8c61deba 100644 --- a/papi-dts/interfaces/_shared_services_network_service_.PapiNetworkService.html +++ b/papi-dts/interfaces/_shared_services_network_service_.PapiNetworkService.html @@ -1,4 +1,4 @@ -PapiNetworkService | papi-dts
    interface PapiNetworkService {
        createNetworkEventEmitter: (<T>(eventType) => "shared/models/papi-event-emitter.model".default<T>);
        getNetworkEvent: (<T>(eventType) => PapiEvent<T>);
        onDidClientConnect: PapiEvent<ClientConnectEvent>;
        onDidClientDisconnect: PapiEvent<ClientDisconnectEvent>;
    }

    Properties

    createNetworkEventEmitter +PapiNetworkService | papi-dts
    interface PapiNetworkService {
        createNetworkEventEmitter: (<T>(eventType) => "shared/models/papi-event-emitter.model".default<T>);
        getNetworkEvent: (<T>(eventType) => PapiEvent<T>);
        onDidClientConnect: PapiEvent<ClientConnectEvent>;
        onDidClientDisconnect: PapiEvent<ClientDisconnectEvent>;
    }

    Properties

    createNetworkEventEmitter getNetworkEvent onDidClientConnect onDidClientDisconnect @@ -9,7 +9,7 @@

    WARNING: You cannot emit events with complex types on the network.

    Type Parameters

    • T

    Parameters

    • eventType: string

      Unique network event type for coordinating between connections

    Returns "shared/models/papi-event-emitter.model".default<T>

    Event emitter whose event works between connections

    -
    getNetworkEvent: (<T>(eventType) => PapiEvent<T>)

    Type declaration

      • <T>(eventType): PapiEvent<T>
      • Gets the network event with the specified type. Creates the emitter if it does not exist

        +
    getNetworkEvent: (<T>(eventType) => PapiEvent<T>)

    Type declaration

      • <T>(eventType): PapiEvent<T>
      • Gets the network event with the specified type. Creates the emitter if it does not exist

        Type Parameters

        • T

        Parameters

        • eventType: string

          Unique network event type for coordinating between connections

        Returns PapiEvent<T>

        Event for the event type that runs the callback provided when the event is emitted

        -
    onDidClientConnect: PapiEvent<ClientConnectEvent>
    onDidClientDisconnect: PapiEvent<ClientDisconnectEvent>

    Generated using TypeDoc

    \ No newline at end of file +
    onDidClientConnect: PapiEvent<ClientConnectEvent>
    onDidClientDisconnect: PapiEvent<ClientDisconnectEvent>

    Generated using TypeDoc

    \ No newline at end of file diff --git a/papi-dts/interfaces/_shared_services_project_data_provider_service_.PapiBackendProjectDataProviderService.html b/papi-dts/interfaces/_shared_services_project_data_provider_service_.PapiBackendProjectDataProviderService.html index 9c21972d7b..58bf2ca5e9 100644 --- a/papi-dts/interfaces/_shared_services_project_data_provider_service_.PapiBackendProjectDataProviderService.html +++ b/papi-dts/interfaces/_shared_services_project_data_provider_service_.PapiBackendProjectDataProviderService.html @@ -1,4 +1,4 @@ -PapiBackendProjectDataProviderService | papi-dts
    interface PapiBackendProjectDataProviderService {
        get: (<ProjectType>(projectType, projectId) => Promise<ProjectDataProvider[ProjectType]>);
        registerProjectDataProviderEngineFactory: (<ProjectType>(projectType, pdpEngineFactory) => Promise<Dispose>);
    }

    Properties

    get +PapiBackendProjectDataProviderService | papi-dts
    interface PapiBackendProjectDataProviderService {
        get: (<ProjectType>(projectType, projectId) => Promise<ProjectDataProvider[ProjectType]>);
        registerProjectDataProviderEngineFactory: (<ProjectType>(projectType, pdpEngineFactory) => Promise<Dispose>);
    }

    Properties

    get: (<ProjectType>(projectType, projectId) => Promise<ProjectDataProvider[ProjectType]>)

    Type declaration

      • <ProjectType>(projectType, projectId): Promise<ProjectDataProvider[ProjectType]>
      • Get a Project Data Provider for the given project ID.

        Type Parameters

        Parameters

        • projectType: ProjectType

          Indicates what you expect the projectType to be for the project with the @@ -9,9 +9,9 @@

        Returns Promise<ProjectDataProvider[ProjectType]>

        Data provider with types that are associated with the given project type

        Example

        const pdp = await get('ParatextStandard', 'ProjectID12345');
        pdp.getVerse(new VerseRef('JHN', '1', '1'));
        -
    registerProjectDataProviderEngineFactory: (<ProjectType>(projectType, pdpEngineFactory) => Promise<Dispose>)

    Type declaration

      • <ProjectType>(projectType, pdpEngineFactory): Promise<Dispose>
      • Add a new Project Data Provider Factory to PAPI that uses the given engine. There must not be an +

    registerProjectDataProviderEngineFactory: (<ProjectType>(projectType, pdpEngineFactory) => Promise<Dispose>)

    Type declaration

      • <ProjectType>(projectType, pdpEngineFactory): Promise<Dispose>
      • Add a new Project Data Provider Factory to PAPI that uses the given engine. There must not be an existing factory already that handles the same project type or this operation will fail.

        Type Parameters

        Parameters

        • projectType: ProjectType

          Type of project that pdpEngineFactory supports

        • pdpEngineFactory: ProjectDataProviderEngineFactory<ProjectType>

          Used in a ProjectDataProviderFactory to create ProjectDataProviders

        Returns Promise<Dispose>

        Promise that resolves to a disposable object when the registration operation completes

        -

    Generated using TypeDoc

    \ No newline at end of file +

    Generated using TypeDoc

    \ No newline at end of file diff --git a/papi-dts/interfaces/_shared_services_project_data_provider_service_.PapiFrontendProjectDataProviderService.html b/papi-dts/interfaces/_shared_services_project_data_provider_service_.PapiFrontendProjectDataProviderService.html index 68977aee9c..1d3e14095d 100644 --- a/papi-dts/interfaces/_shared_services_project_data_provider_service_.PapiFrontendProjectDataProviderService.html +++ b/papi-dts/interfaces/_shared_services_project_data_provider_service_.PapiFrontendProjectDataProviderService.html @@ -1,4 +1,4 @@ -PapiFrontendProjectDataProviderService | papi-dts
    interface PapiFrontendProjectDataProviderService {
        get: (<ProjectType>(projectType, projectId) => Promise<ProjectDataProvider[ProjectType]>);
    }

    Properties

    get +PapiFrontendProjectDataProviderService | papi-dts
    interface PapiFrontendProjectDataProviderService {
        get: (<ProjectType>(projectType, projectId) => Promise<ProjectDataProvider[ProjectType]>);
    }

    Properties

    Properties

    get: (<ProjectType>(projectType, projectId) => Promise<ProjectDataProvider[ProjectType]>)

    Type declaration

      • <ProjectType>(projectType, projectId): Promise<ProjectDataProvider[ProjectType]>
      • Get a Project Data Provider for the given project ID.

        Type Parameters

        Parameters

        • projectType: ProjectType

          Indicates what you expect the projectType to be for the project with the specified id. The TypeScript type for the returned project data provider will have the project @@ -8,4 +8,4 @@

        Returns Promise<ProjectDataProvider[ProjectType]>

        Data provider with types that are associated with the given project type

        Example

        const pdp = await get('ParatextStandard', 'ProjectID12345');
        pdp.getVerse(new VerseRef('JHN', '1', '1'));
        -

    Generated using TypeDoc

    \ No newline at end of file +

    Generated using TypeDoc

    \ No newline at end of file diff --git a/papi-dts/interfaces/_shared_services_project_lookup_service_model_.ProjectLookupServiceType.html b/papi-dts/interfaces/_shared_services_project_lookup_service_model_.ProjectLookupServiceType.html index dd9a1ad092..80cc9cf423 100644 --- a/papi-dts/interfaces/_shared_services_project_lookup_service_model_.ProjectLookupServiceType.html +++ b/papi-dts/interfaces/_shared_services_project_lookup_service_model_.ProjectLookupServiceType.html @@ -1,9 +1,9 @@ ProjectLookupServiceType | papi-dts

    Provides metadata for projects known by the platform

    -
    interface ProjectLookupServiceType {
        getMetadataForAllProjects: (() => Promise<ProjectMetadata[]>);
        getMetadataForProject: ((projectId) => Promise<ProjectMetadata>);
    }

    Properties

    interface ProjectLookupServiceType {
        getMetadataForAllProjects: (() => Promise<ProjectMetadata[]>);
        getMetadataForProject: ((projectId) => Promise<ProjectMetadata>);
    }

    Properties

    getMetadataForAllProjects: (() => Promise<ProjectMetadata[]>)

    Type declaration

      • (): Promise<ProjectMetadata[]>
      • Provide metadata for all projects found on the local system

        Returns Promise<ProjectMetadata[]>

        ProjectMetadata for all projects stored on the local system

        -
    getMetadataForProject: ((projectId) => Promise<ProjectMetadata>)

    Type declaration

      • (projectId): Promise<ProjectMetadata>
      • Look up metadata for a specific project ID

        +
    getMetadataForProject: ((projectId) => Promise<ProjectMetadata>)

    Type declaration

      • (projectId): Promise<ProjectMetadata>
      • Look up metadata for a specific project ID

        Parameters

        • projectId: string

          ID of the project to load

        Returns Promise<ProjectMetadata>

        ProjectMetadata from the 'meta.json' file for the given project

        -

    Generated using TypeDoc

    \ No newline at end of file +

    Generated using TypeDoc

    \ No newline at end of file diff --git a/papi-dts/interfaces/_shared_services_settings_service_.SettingsService.html b/papi-dts/interfaces/_shared_services_settings_service_.SettingsService.html index 0434532260..a797af1974 100644 --- a/papi-dts/interfaces/_shared_services_settings_service_.SettingsService.html +++ b/papi-dts/interfaces/_shared_services_settings_service_.SettingsService.html @@ -1,17 +1,17 @@ -SettingsService | papi-dts
    interface SettingsService {
        get: (<SettingName>(key) => undefined | SettingTypes[SettingName]);
        set: (<SettingName>(key, newSetting) => void);
        subscribe: (<SettingName>(key, callback) => Unsubscriber);
    }

    Properties

    get +SettingsService | papi-dts
    interface SettingsService {
        get: (<SettingName>(key) => undefined | SettingTypes[SettingName]);
        set: (<SettingName>(key, newSetting) => void);
        subscribe: (<SettingName>(key, callback) => Unsubscriber);
    }

    Properties

    Properties

    get: (<SettingName>(key) => undefined | SettingTypes[SettingName])

    Type declaration

      • <SettingName>(key): undefined | SettingTypes[SettingName]
      • Retrieves the value of the specified setting

        Type Parameters

        Parameters

        • key: SettingName

          The string id of the setting for which the value is being retrieved

        Returns undefined | SettingTypes[SettingName]

        The value of the specified setting, parsed to an object. Returns undefined if setting is not present or no value is available

        -
    set: (<SettingName>(key, newSetting) => void)

    Type declaration

      • <SettingName>(key, newSetting): void
      • Sets the value of the specified setting

        +
    set: (<SettingName>(key, newSetting) => void)

    Type declaration

      • <SettingName>(key, newSetting): void
      • Sets the value of the specified setting

        Type Parameters

        Parameters

        • key: SettingName

          The string id of the setting for which the value is being retrieved

        • newSetting: undefined | SettingTypes[SettingName]

          The value that is to be stored. Setting the new value to undefined is the equivalent of deleting the setting

          -

        Returns void

    subscribe: (<SettingName>(key, callback) => Unsubscriber)

    Type declaration

      • <SettingName>(key, callback): Unsubscriber
      • Subscribes to updates of the specified setting. Whenever the value of the setting changes, the +

    Returns void

    subscribe: (<SettingName>(key, callback) => Unsubscriber)

    Type declaration

      • <SettingName>(key, callback): Unsubscriber
      • Subscribes to updates of the specified setting. Whenever the value of the setting changes, the callback function is executed.

        Type Parameters

        Parameters

        • key: SettingName

          The string id of the setting for which the value is being subscribed to

        • callback: ((newSetting) => void)

          The function that will be called whenever the specified setting is updated

            • (newSetting): void
            • Parameters

              Returns void

        Returns Unsubscriber

        Unsubscriber that should be called whenever the subscription should be deleted

        -

    Generated using TypeDoc

    \ No newline at end of file +

    Generated using TypeDoc

    \ No newline at end of file diff --git a/papi-dts/interfaces/_shared_services_web_view_provider_service_.PapiWebViewProviderService.html b/papi-dts/interfaces/_shared_services_web_view_provider_service_.PapiWebViewProviderService.html index 65a5206703..24c60e78ba 100644 --- a/papi-dts/interfaces/_shared_services_web_view_provider_service_.PapiWebViewProviderService.html +++ b/papi-dts/interfaces/_shared_services_web_view_provider_service_.PapiWebViewProviderService.html @@ -1,8 +1,8 @@ -PapiWebViewProviderService | papi-dts
    interface PapiWebViewProviderService {
        register: ((webViewType, webViewProvider) => Promise<DisposableWebViewProvider>);
    }

    Properties

    register +PapiWebViewProviderService | papi-dts
    interface PapiWebViewProviderService {
        register: ((webViewType, webViewProvider) => Promise<DisposableWebViewProvider>);
    }

    Properties

    Properties

    register: ((webViewType, webViewProvider) => Promise<DisposableWebViewProvider>)

    Type declaration

      • (webViewType, webViewProvider): Promise<DisposableWebViewProvider>
      • Register a web view provider to serve webViews for a specified type of webViews

        Parameters

        • webViewType: string

          Type of web view to provide

        • webViewProvider: IWebViewProvider

          Object to register as a webView provider including control over disposing of it.

          WARNING: setting a webView provider mutates the provided object.

        Returns Promise<DisposableWebViewProvider>

        webViewProvider modified to be a network object

        -

    Generated using TypeDoc

    \ No newline at end of file +

    Generated using TypeDoc

    \ No newline at end of file diff --git a/papi-dts/interfaces/_shared_services_web_view_provider_service_.WebViewProviderService.html b/papi-dts/interfaces/_shared_services_web_view_provider_service_.WebViewProviderService.html index b5b182ae00..92dba709f7 100644 --- a/papi-dts/interfaces/_shared_services_web_view_provider_service_.WebViewProviderService.html +++ b/papi-dts/interfaces/_shared_services_web_view_provider_service_.WebViewProviderService.html @@ -1,19 +1,19 @@ -WebViewProviderService | papi-dts
    interface WebViewProviderService {
        get: ((webViewType) => Promise<WebViewProvider | undefined>);
        hasKnown: ((webViewType) => boolean);
        initialize: (() => Promise<void>);
        register: ((webViewType, webViewProvider) => Promise<DisposableWebViewProvider>);
    }

    Properties

    get +WebViewProviderService | papi-dts
    interface WebViewProviderService {
        get: ((webViewType) => Promise<WebViewProvider | undefined>);
        hasKnown: ((webViewType) => boolean);
        initialize: (() => Promise<void>);
        register: ((webViewType, webViewProvider) => Promise<DisposableWebViewProvider>);
    }

    Properties

    get: ((webViewType) => Promise<WebViewProvider | undefined>)

    Type declaration

      • (webViewType): Promise<WebViewProvider | undefined>
      • Get a web view provider that has previously been set up

        Parameters

        • webViewType: string

          Type of webview provider to get

        Returns Promise<WebViewProvider | undefined>

        Web view provider with the given name if one exists, undefined otherwise

        -
    hasKnown: ((webViewType) => boolean)

    Type declaration

      • (webViewType): boolean
      • Indicate if we are aware of an existing web view provider with the given type. If a web view +

    hasKnown: ((webViewType) => boolean)

    Type declaration

      • (webViewType): boolean
      • Indicate if we are aware of an existing web view provider with the given type. If a web view provider with the given type is somewhere else on the network, this function won't tell you about it unless something else in the existing process is subscribed to it.

        Parameters

        • webViewType: string

          Type of webView to check for

          -

        Returns boolean

    initialize: (() => Promise<void>)

    Type declaration

      • (): Promise<void>
      • Sets up the service. Only runs once and always returns the same promise after that

        -

        Returns Promise<void>

    register: ((webViewType, webViewProvider) => Promise<DisposableWebViewProvider>)

    Type declaration

      • (webViewType, webViewProvider): Promise<DisposableWebViewProvider>
      • Register a web view provider to serve webViews for a specified type of webViews

        +

    Returns boolean

    initialize: (() => Promise<void>)

    Type declaration

      • (): Promise<void>
      • Sets up the service. Only runs once and always returns the same promise after that

        +

        Returns Promise<void>

    register: ((webViewType, webViewProvider) => Promise<DisposableWebViewProvider>)

    Type declaration

      • (webViewType, webViewProvider): Promise<DisposableWebViewProvider>
      • Register a web view provider to serve webViews for a specified type of webViews

        Parameters

        • webViewType: string

          Type of web view to provide

        • webViewProvider: IWebViewProvider

          Object to register as a webView provider including control over disposing of it.

          WARNING: setting a webView provider mutates the provided object.

        Returns Promise<DisposableWebViewProvider>

        webViewProvider modified to be a network object

        -

    Generated using TypeDoc

    \ No newline at end of file +

    Generated using TypeDoc

    \ No newline at end of file diff --git a/papi-dts/interfaces/_shared_services_web_view_service_model_.WebViewServiceType.html b/papi-dts/interfaces/_shared_services_web_view_service_model_.WebViewServiceType.html index 2a0f43b5c8..487eb193da 100644 --- a/papi-dts/interfaces/_shared_services_web_view_service_model_.WebViewServiceType.html +++ b/papi-dts/interfaces/_shared_services_web_view_service_model_.WebViewServiceType.html @@ -1,7 +1,7 @@ WebViewServiceType | papi-dts

    Service exposing various functions related to using webViews

    WebViews are iframes in the Platform.Bible UI into which extensions load frontend code, either HTML or React components.

    -
    interface WebViewServiceType {
        getWebView: ((webViewType, layout?, options?) => Promise<undefined | string>);
        onDidAddWebView: PapiEvent<AddWebViewEvent>;
    }

    Properties

    interface WebViewServiceType {
        getWebView: ((webViewType, layout?, options?) => Promise<undefined | string>);
        onDidAddWebView: PapiEvent<AddWebViewEvent>;
    }

    Properties

    getWebView: ((webViewType, layout?, options?) => Promise<undefined | string>)

    Type declaration

      • (webViewType, layout?, options?): Promise<undefined | string>
      • Creates a new web view or gets an existing one depending on if you request an existing one and if the web view provider decides to give that existing one to you (it is up to the provider).

        @@ -12,5 +12,5 @@

    Returns Promise<undefined | string>

    Promise that resolves to the ID of the webview we got or undefined if the provider did not create a WebView for this request.

    Throws

    If something went wrong like the provider for the webViewType was not found

    -
    onDidAddWebView: PapiEvent<AddWebViewEvent>

    Event that emits with webView info when a webView is added

    -

    Generated using TypeDoc

    \ No newline at end of file +
    onDidAddWebView: PapiEvent<AddWebViewEvent>

    Event that emits with webView info when a webView is added

    +

    Generated using TypeDoc

    \ No newline at end of file diff --git a/papi-dts/modules/__papi_backend_.html b/papi-dts/modules/__papi_backend_.html index f4c7594466..9a6e9624a7 100644 --- a/papi-dts/modules/__papi_backend_.html +++ b/papi-dts/modules/__papi_backend_.html @@ -1,4 +1,4 @@ -"@papi/backend" | papi-dts

    Namespace "@papi/backend"

    Index

    Variables

    DataProviderEngine +"@papi/backend" | papi-dts

    Namespace "@papi/backend"

    Index

    Variables

    DataProviderEngine EventEmitter commands dataProviders diff --git a/papi-dts/modules/__papi_core_.html b/papi-dts/modules/__papi_core_.html index b08cec8a78..41b6747fde 100644 --- a/papi-dts/modules/__papi_core_.html +++ b/papi-dts/modules/__papi_core_.html @@ -1,4 +1,4 @@ -"@papi/core" | papi-dts

    Namespace "@papi/core"

    References

    DataProviderDataType +"@papi/core" | papi-dts

    Namespace "@papi/core"

    References

    DataProviderDataType DataProviderSubscriberOptions DataProviderUpdateInstructions DialogOptions diff --git a/papi-dts/modules/__papi_frontend_.html b/papi-dts/modules/__papi_frontend_.html index f19fb5ee26..cbbd6e65ce 100644 --- a/papi-dts/modules/__papi_frontend_.html +++ b/papi-dts/modules/__papi_frontend_.html @@ -1,4 +1,4 @@ -"@papi/frontend" | papi-dts

    Namespace "@papi/frontend"

    Index

    Type Aliases

    Papi +"@papi/frontend" | papi-dts

    Namespace "@papi/frontend"

    Index

    Type Aliases

    Variables

    EventEmitter WebSocket XMLHttpRequest diff --git a/papi-dts/modules/__papi_frontend_react_.html b/papi-dts/modules/__papi_frontend_react_.html index b35c8931fe..62ef94a183 100644 --- a/papi-dts/modules/__papi_frontend_react_.html +++ b/papi-dts/modules/__papi_frontend_react_.html @@ -1,4 +1,4 @@ -"@papi/frontend/react" | papi-dts

    Namespace "@papi/frontend/react"

    References

    useData +"@papi/frontend/react" | papi-dts

    Namespace "@papi/frontend/react"

    References

    useData useDataProvider useDataProviderMulti useDialogCallback diff --git a/papi-dts/modules/_client_services_client_network_connector_service_.html b/papi-dts/modules/_client_services_client_network_connector_service_.html index 20bf49779a..7ccacf4342 100644 --- a/papi-dts/modules/_client_services_client_network_connector_service_.html +++ b/papi-dts/modules/_client_services_client_network_connector_service_.html @@ -1,2 +1,2 @@ -"client/services/client-network-connector.service" | papi-dts

    Namespace "client/services/client-network-connector.service"

    Index

    Classes

    default +"client/services/client-network-connector.service" | papi-dts

    Generated using TypeDoc

    \ No newline at end of file diff --git a/papi-dts/modules/_client_services_web_socket_factory_.html b/papi-dts/modules/_client_services_web_socket_factory_.html index edd357172b..a81ba9a67d 100644 --- a/papi-dts/modules/_client_services_web_socket_factory_.html +++ b/papi-dts/modules/_client_services_web_socket_factory_.html @@ -1,2 +1,2 @@ -"client/services/web-socket.factory" | papi-dts

    Namespace "client/services/web-socket.factory"

    Index

    Functions

    createWebSocket +"client/services/web-socket.factory" | papi-dts

    Generated using TypeDoc

    \ No newline at end of file diff --git a/papi-dts/modules/_client_services_web_socket_interface_.html b/papi-dts/modules/_client_services_web_socket_interface_.html index 3b3cb1d96b..c2e26dba0f 100644 --- a/papi-dts/modules/_client_services_web_socket_interface_.html +++ b/papi-dts/modules/_client_services_web_socket_interface_.html @@ -1,2 +1,2 @@ -"client/services/web-socket.interface" | papi-dts

    Namespace "client/services/web-socket.interface"

    Index

    Type Aliases

    IWebSocket +"client/services/web-socket.interface" | papi-dts

    Generated using TypeDoc

    \ No newline at end of file diff --git a/papi-dts/modules/_extension_host_extension_types_extension_activation_context_model_.html b/papi-dts/modules/_extension_host_extension_types_extension_activation_context_model_.html index bd363bc245..2d524c0b36 100644 --- a/papi-dts/modules/_extension_host_extension_types_extension_activation_context_model_.html +++ b/papi-dts/modules/_extension_host_extension_types_extension_activation_context_model_.html @@ -1,2 +1,2 @@ -"extension-host/extension-types/extension-activation-context.model" | papi-dts

    Namespace "extension-host/extension-types/extension-activation-context.model"

    Index

    Type Aliases

    ExecutionActivationContext +"extension-host/extension-types/extension-activation-context.model" | papi-dts

    Generated using TypeDoc

    \ No newline at end of file diff --git a/papi-dts/modules/_extension_host_extension_types_extension_interface_.html b/papi-dts/modules/_extension_host_extension_types_extension_interface_.html index 00ddafd7c3..d33edcddcc 100644 --- a/papi-dts/modules/_extension_host_extension_types_extension_interface_.html +++ b/papi-dts/modules/_extension_host_extension_types_extension_interface_.html @@ -1,2 +1,2 @@ -"extension-host/extension-types/extension.interface" | papi-dts

    Namespace "extension-host/extension-types/extension.interface"

    Index

    Interfaces

    IExtension +"extension-host/extension-types/extension.interface" | papi-dts

    Generated using TypeDoc

    \ No newline at end of file diff --git a/papi-dts/modules/_extension_host_extension_types_extension_manifest_model_.html b/papi-dts/modules/_extension_host_extension_types_extension_manifest_model_.html index d4a9ad1998..c10b5182cc 100644 --- a/papi-dts/modules/_extension_host_extension_types_extension_manifest_model_.html +++ b/papi-dts/modules/_extension_host_extension_types_extension_manifest_model_.html @@ -1,2 +1,2 @@ -"extension-host/extension-types/extension-manifest.model" | papi-dts

    Namespace "extension-host/extension-types/extension-manifest.model"

    Index

    Type Aliases

    ExtensionManifest +"extension-host/extension-types/extension-manifest.model" | papi-dts

    Generated using TypeDoc

    \ No newline at end of file diff --git a/papi-dts/modules/_extension_host_services_extension_host_web_socket_model_.html b/papi-dts/modules/_extension_host_services_extension_host_web_socket_model_.html index 45cae17a1e..163d610f35 100644 --- a/papi-dts/modules/_extension_host_services_extension_host_web_socket_model_.html +++ b/papi-dts/modules/_extension_host_services_extension_host_web_socket_model_.html @@ -1,3 +1,3 @@ -"extension-host/services/extension-host-web-socket.model" | papi-dts

    Namespace "extension-host/services/extension-host-web-socket.model"

    Index

    Namespaces

    default +"extension-host/services/extension-host-web-socket.model" | papi-dts

    Generated using TypeDoc

    \ No newline at end of file diff --git a/papi-dts/modules/_extension_host_services_extension_storage_service_.html b/papi-dts/modules/_extension_host_services_extension_storage_service_.html index 0e2e5bcf8d..34386ed20c 100644 --- a/papi-dts/modules/_extension_host_services_extension_storage_service_.html +++ b/papi-dts/modules/_extension_host_services_extension_storage_service_.html @@ -1,4 +1,4 @@ -"extension-host/services/extension-storage.service" | papi-dts

    Namespace "extension-host/services/extension-storage.service"

    Index

    Interfaces

    ExtensionStorageService +"extension-host/services/extension-storage.service" | papi-dts

    Namespace "extension-host/services/extension-storage.service"

    Index

    Interfaces

    Variables

    Functions

    buildExtensionPathFromName setExtensionUris diff --git a/papi-dts/modules/_main_services_server_network_connector_service_.html b/papi-dts/modules/_main_services_server_network_connector_service_.html index b9208d9dee..e19afd9d3e 100644 --- a/papi-dts/modules/_main_services_server_network_connector_service_.html +++ b/papi-dts/modules/_main_services_server_network_connector_service_.html @@ -1,2 +1,2 @@ -"main/services/server-network-connector.service" | papi-dts

    Namespace "main/services/server-network-connector.service"

    Index

    Classes

    default +"main/services/server-network-connector.service" | papi-dts

    Generated using TypeDoc

    \ No newline at end of file diff --git a/papi-dts/modules/_node_models_execution_token_model_.html b/papi-dts/modules/_node_models_execution_token_model_.html index 168cc8c8b4..3e5686bf43 100644 --- a/papi-dts/modules/_node_models_execution_token_model_.html +++ b/papi-dts/modules/_node_models_execution_token_model_.html @@ -1,3 +1,3 @@ -"node/models/execution-token.model" | papi-dts

    Namespace "node/models/execution-token.model"

    Index

    Classes

    ExecutionToken +"node/models/execution-token.model" | papi-dts

    Generated using TypeDoc

    \ No newline at end of file diff --git a/papi-dts/modules/_node_services_execution_token_service_.html b/papi-dts/modules/_node_services_execution_token_service_.html index 7f28dae7c9..6a7cc4ddca 100644 --- a/papi-dts/modules/_node_services_execution_token_service_.html +++ b/papi-dts/modules/_node_services_execution_token_service_.html @@ -1,2 +1,2 @@ -"node/services/execution-token.service" | papi-dts

    Namespace "node/services/execution-token.service"

    Index

    Variables

    default +"node/services/execution-token.service" | papi-dts

    Generated using TypeDoc

    \ No newline at end of file diff --git a/papi-dts/modules/_node_services_node_file_system_service_.html b/papi-dts/modules/_node_services_node_file_system_service_.html index 6d4e33cba1..5be295a041 100644 --- a/papi-dts/modules/_node_services_node_file_system_service_.html +++ b/papi-dts/modules/_node_services_node_file_system_service_.html @@ -1,4 +1,4 @@ -"node/services/node-file-system.service" | papi-dts

    Namespace "node/services/node-file-system.service"

    Index

    Enumerations

    EntryType +"node/services/node-file-system.service" | papi-dts

    Namespace "node/services/node-file-system.service"

    Index

    Enumerations

    Type Aliases

    Functions

    copyFile createDir diff --git a/papi-dts/modules/_node_utils_crypto_util_.html b/papi-dts/modules/_node_utils_crypto_util_.html index 9e727bacd1..ac759a6169 100644 --- a/papi-dts/modules/_node_utils_crypto_util_.html +++ b/papi-dts/modules/_node_utils_crypto_util_.html @@ -1,3 +1,3 @@ -"node/utils/crypto-util" | papi-dts

    Namespace "node/utils/crypto-util"

    Index

    Functions

    createNonce +"node/utils/crypto-util" | papi-dts

    Generated using TypeDoc

    \ No newline at end of file diff --git a/papi-dts/modules/_node_utils_util_.getAppDir.html b/papi-dts/modules/_node_utils_util_.getAppDir.html index e5c5134390..62ec1624aa 100644 --- a/papi-dts/modules/_node_utils_util_.getAppDir.html +++ b/papi-dts/modules/_node_utils_util_.getAppDir.html @@ -1,5 +1,5 @@ getAppDir | papi-dts

    Generated using TypeDoc

    \ No newline at end of file diff --git a/papi-dts/modules/_node_utils_util_.html b/papi-dts/modules/_node_utils_util_.html index ac1bfc959c..277e74d610 100644 --- a/papi-dts/modules/_node_utils_util_.html +++ b/papi-dts/modules/_node_utils_util_.html @@ -1,4 +1,4 @@ -"node/utils/util" | papi-dts

    Namespace "node/utils/util"

    Index

    Namespaces

    getAppDir +"node/utils/util" | papi-dts

    Namespace "node/utils/util"

    Index

    Namespaces

    Variables

    Functions

    getAppDir diff --git a/papi-dts/modules/_papi_shared_types_.html b/papi-dts/modules/_papi_shared_types_.html index be769e94b6..a9e268f446 100644 --- a/papi-dts/modules/_papi_shared_types_.html +++ b/papi-dts/modules/_papi_shared_types_.html @@ -1,4 +1,4 @@ -"papi-shared-types" | papi-dts

    Namespace "papi-shared-types"

    Index

    Interfaces

    CommandHandlers +"papi-shared-types" | papi-dts

    Namespace "papi-shared-types"

    Index

    Interfaces

    CommandHandlers DataProviders ProjectDataTypes SettingTypes diff --git a/papi-dts/modules/_renderer_components_dialogs_dialog_base_data_.html b/papi-dts/modules/_renderer_components_dialogs_dialog_base_data_.html index 05c3c27a6f..56376d9e15 100644 --- a/papi-dts/modules/_renderer_components_dialogs_dialog_base_data_.html +++ b/papi-dts/modules/_renderer_components_dialogs_dialog_base_data_.html @@ -1,4 +1,4 @@ -"renderer/components/dialogs/dialog-base.data" | papi-dts

    Namespace "renderer/components/dialogs/dialog-base.data"

    Index

    Type Aliases

    DialogDefinitionBase +"renderer/components/dialogs/dialog-base.data" | papi-dts

    Namespace "renderer/components/dialogs/dialog-base.data"

    Index

    Type Aliases

    Variables

    Functions

    hookUpDialogService diff --git a/papi-dts/modules/_renderer_components_dialogs_dialog_definition_model_.html b/papi-dts/modules/_renderer_components_dialogs_dialog_definition_model_.html index 9b420b4b37..621446cbf5 100644 --- a/papi-dts/modules/_renderer_components_dialogs_dialog_definition_model_.html +++ b/papi-dts/modules/_renderer_components_dialogs_dialog_definition_model_.html @@ -1,4 +1,4 @@ -"renderer/components/dialogs/dialog-definition.model" | papi-dts

    Namespace "renderer/components/dialogs/dialog-definition.model"

    Index

    Interfaces

    DialogTypes +"renderer/components/dialogs/dialog-definition.model" | papi-dts

    Namespace "renderer/components/dialogs/dialog-definition.model"

    Index

    Interfaces

    Type Aliases

    DialogDataTypes DialogDefinition DialogTabTypes diff --git a/papi-dts/modules/_renderer_hooks_hook_generators_create_use_data_hook_util_.html b/papi-dts/modules/_renderer_hooks_hook_generators_create_use_data_hook_util_.html index ff086fa030..fbaf9b798f 100644 --- a/papi-dts/modules/_renderer_hooks_hook_generators_create_use_data_hook_util_.html +++ b/papi-dts/modules/_renderer_hooks_hook_generators_create_use_data_hook_util_.html @@ -1,2 +1,2 @@ -"renderer/hooks/hook-generators/create-use-data-hook.util" | papi-dts

    Namespace "renderer/hooks/hook-generators/create-use-data-hook.util"

    Index

    Functions

    default +"renderer/hooks/hook-generators/create-use-data-hook.util" | papi-dts

    Generated using TypeDoc

    \ No newline at end of file diff --git a/papi-dts/modules/_renderer_hooks_hook_generators_create_use_network_object_hook_util_.html b/papi-dts/modules/_renderer_hooks_hook_generators_create_use_network_object_hook_util_.html index 3371c6e20c..f29b754610 100644 --- a/papi-dts/modules/_renderer_hooks_hook_generators_create_use_network_object_hook_util_.html +++ b/papi-dts/modules/_renderer_hooks_hook_generators_create_use_network_object_hook_util_.html @@ -1,2 +1,2 @@ -"renderer/hooks/hook-generators/create-use-network-object-hook.util" | papi-dts

    Namespace "renderer/hooks/hook-generators/create-use-network-object-hook.util"

    Index

    Functions

    default +"renderer/hooks/hook-generators/create-use-network-object-hook.util" | papi-dts

    Generated using TypeDoc

    \ No newline at end of file diff --git a/papi-dts/modules/_renderer_hooks_papi_hooks_index_.html b/papi-dts/modules/_renderer_hooks_papi_hooks_index_.html index 5532ba1c20..eed7a8ad3a 100644 --- a/papi-dts/modules/_renderer_hooks_papi_hooks_index_.html +++ b/papi-dts/modules/_renderer_hooks_papi_hooks_index_.html @@ -1,4 +1,4 @@ -"renderer/hooks/papi-hooks/index" | papi-dts

    Namespace "renderer/hooks/papi-hooks/index"

    References

    useData +"renderer/hooks/papi-hooks/index" | papi-dts

    Namespace "renderer/hooks/papi-hooks/index"

    References

    useData useDataProvider useDataProviderMulti useDialogCallback diff --git a/papi-dts/modules/_renderer_hooks_papi_hooks_use_data_hook_.html b/papi-dts/modules/_renderer_hooks_papi_hooks_use_data_hook_.html index 73a4156f72..d766cbe6f9 100644 --- a/papi-dts/modules/_renderer_hooks_papi_hooks_use_data_hook_.html +++ b/papi-dts/modules/_renderer_hooks_papi_hooks_use_data_hook_.html @@ -1,2 +1,2 @@ -"renderer/hooks/papi-hooks/use-data.hook" | papi-dts

    Namespace "renderer/hooks/papi-hooks/use-data.hook"

    Index

    Functions

    default +"renderer/hooks/papi-hooks/use-data.hook" | papi-dts

    Generated using TypeDoc

    \ No newline at end of file diff --git a/papi-dts/modules/_renderer_hooks_papi_hooks_use_data_provider_hook_.html b/papi-dts/modules/_renderer_hooks_papi_hooks_use_data_provider_hook_.html index b57a65c167..545ab37835 100644 --- a/papi-dts/modules/_renderer_hooks_papi_hooks_use_data_provider_hook_.html +++ b/papi-dts/modules/_renderer_hooks_papi_hooks_use_data_provider_hook_.html @@ -1,2 +1,2 @@ -"renderer/hooks/papi-hooks/use-data-provider.hook" | papi-dts

    Namespace "renderer/hooks/papi-hooks/use-data-provider.hook"

    Index

    Functions

    default +"renderer/hooks/papi-hooks/use-data-provider.hook" | papi-dts

    Generated using TypeDoc

    \ No newline at end of file diff --git a/papi-dts/modules/_renderer_hooks_papi_hooks_use_data_provider_multi_hook_.html b/papi-dts/modules/_renderer_hooks_papi_hooks_use_data_provider_multi_hook_.html index b53e31241a..47d8b7719b 100644 --- a/papi-dts/modules/_renderer_hooks_papi_hooks_use_data_provider_multi_hook_.html +++ b/papi-dts/modules/_renderer_hooks_papi_hooks_use_data_provider_multi_hook_.html @@ -1,2 +1,2 @@ -"renderer/hooks/papi-hooks/use-data-provider-multi.hook" | papi-dts

    Namespace "renderer/hooks/papi-hooks/use-data-provider-multi.hook"

    Index

    Functions

    default +"renderer/hooks/papi-hooks/use-data-provider-multi.hook" | papi-dts

    Generated using TypeDoc

    \ No newline at end of file diff --git a/papi-dts/modules/_renderer_hooks_papi_hooks_use_dialog_callback_hook_.html b/papi-dts/modules/_renderer_hooks_papi_hooks_use_dialog_callback_hook_.html index 4b241b10c5..b3532d4911 100644 --- a/papi-dts/modules/_renderer_hooks_papi_hooks_use_dialog_callback_hook_.html +++ b/papi-dts/modules/_renderer_hooks_papi_hooks_use_dialog_callback_hook_.html @@ -1,2 +1,2 @@ -"renderer/hooks/papi-hooks/use-dialog-callback.hook" | papi-dts

    Namespace "renderer/hooks/papi-hooks/use-dialog-callback.hook"

    Index

    Functions

    default +"renderer/hooks/papi-hooks/use-dialog-callback.hook" | papi-dts

    Generated using TypeDoc

    \ No newline at end of file diff --git a/papi-dts/modules/_renderer_hooks_papi_hooks_use_event_async_hook_.html b/papi-dts/modules/_renderer_hooks_papi_hooks_use_event_async_hook_.html index 5df1904e02..6690a44c10 100644 --- a/papi-dts/modules/_renderer_hooks_papi_hooks_use_event_async_hook_.html +++ b/papi-dts/modules/_renderer_hooks_papi_hooks_use_event_async_hook_.html @@ -1,2 +1,2 @@ -"renderer/hooks/papi-hooks/use-event-async.hook" | papi-dts

    Namespace "renderer/hooks/papi-hooks/use-event-async.hook"

    Index

    Functions

    default +"renderer/hooks/papi-hooks/use-event-async.hook" | papi-dts

    Generated using TypeDoc

    \ No newline at end of file diff --git a/papi-dts/modules/_renderer_hooks_papi_hooks_use_event_hook_.html b/papi-dts/modules/_renderer_hooks_papi_hooks_use_event_hook_.html index 11f5662fe6..b518903744 100644 --- a/papi-dts/modules/_renderer_hooks_papi_hooks_use_event_hook_.html +++ b/papi-dts/modules/_renderer_hooks_papi_hooks_use_event_hook_.html @@ -1,2 +1,2 @@ -"renderer/hooks/papi-hooks/use-event.hook" | papi-dts

    Namespace "renderer/hooks/papi-hooks/use-event.hook"

    Index

    Functions

    default +"renderer/hooks/papi-hooks/use-event.hook" | papi-dts

    Generated using TypeDoc

    \ No newline at end of file diff --git a/papi-dts/modules/_renderer_hooks_papi_hooks_use_project_data_hook_.html b/papi-dts/modules/_renderer_hooks_papi_hooks_use_project_data_hook_.html index ea2c2dfaf6..6039883d80 100644 --- a/papi-dts/modules/_renderer_hooks_papi_hooks_use_project_data_hook_.html +++ b/papi-dts/modules/_renderer_hooks_papi_hooks_use_project_data_hook_.html @@ -1,2 +1,2 @@ -"renderer/hooks/papi-hooks/use-project-data.hook" | papi-dts

    Namespace "renderer/hooks/papi-hooks/use-project-data.hook"

    Index

    Functions

    default +"renderer/hooks/papi-hooks/use-project-data.hook" | papi-dts

    Generated using TypeDoc

    \ No newline at end of file diff --git a/papi-dts/modules/_renderer_hooks_papi_hooks_use_project_data_provider_hook_.html b/papi-dts/modules/_renderer_hooks_papi_hooks_use_project_data_provider_hook_.html index 9bebb45b59..5a0cb40bff 100644 --- a/papi-dts/modules/_renderer_hooks_papi_hooks_use_project_data_provider_hook_.html +++ b/papi-dts/modules/_renderer_hooks_papi_hooks_use_project_data_provider_hook_.html @@ -1,2 +1,2 @@ -"renderer/hooks/papi-hooks/use-project-data-provider.hook" | papi-dts

    Namespace "renderer/hooks/papi-hooks/use-project-data-provider.hook"

    Index

    Functions

    default +"renderer/hooks/papi-hooks/use-project-data-provider.hook" | papi-dts

    Generated using TypeDoc

    \ No newline at end of file diff --git a/papi-dts/modules/_renderer_hooks_papi_hooks_use_promise_hook_.html b/papi-dts/modules/_renderer_hooks_papi_hooks_use_promise_hook_.html index ff29fa5771..811a8a64c1 100644 --- a/papi-dts/modules/_renderer_hooks_papi_hooks_use_promise_hook_.html +++ b/papi-dts/modules/_renderer_hooks_papi_hooks_use_promise_hook_.html @@ -1,2 +1,2 @@ -"renderer/hooks/papi-hooks/use-promise.hook" | papi-dts

    Namespace "renderer/hooks/papi-hooks/use-promise.hook"

    Index

    Functions

    default +"renderer/hooks/papi-hooks/use-promise.hook" | papi-dts

    Generated using TypeDoc

    \ No newline at end of file diff --git a/papi-dts/modules/_renderer_hooks_papi_hooks_use_setting_hook_.html b/papi-dts/modules/_renderer_hooks_papi_hooks_use_setting_hook_.html index 990f893136..2ead4cc627 100644 --- a/papi-dts/modules/_renderer_hooks_papi_hooks_use_setting_hook_.html +++ b/papi-dts/modules/_renderer_hooks_papi_hooks_use_setting_hook_.html @@ -1,2 +1,2 @@ -"renderer/hooks/papi-hooks/use-setting.hook" | papi-dts

    Namespace "renderer/hooks/papi-hooks/use-setting.hook"

    Index

    Functions

    default +"renderer/hooks/papi-hooks/use-setting.hook" | papi-dts

    Generated using TypeDoc

    \ No newline at end of file diff --git a/papi-dts/modules/_renderer_services_renderer_web_socket_service_.html b/papi-dts/modules/_renderer_services_renderer_web_socket_service_.html index 325dd1ea0c..e0221ee594 100644 --- a/papi-dts/modules/_renderer_services_renderer_web_socket_service_.html +++ b/papi-dts/modules/_renderer_services_renderer_web_socket_service_.html @@ -1,3 +1,3 @@ -"renderer/services/renderer-web-socket.service" | papi-dts

    Namespace "renderer/services/renderer-web-socket.service"

    Index

    Classes

    default +"renderer/services/renderer-web-socket.service" | papi-dts

    Generated using TypeDoc

    \ No newline at end of file diff --git a/papi-dts/modules/_renderer_services_renderer_xml_http_request_service_.html b/papi-dts/modules/_renderer_services_renderer_xml_http_request_service_.html index 35dbb3c1c0..ca54fe18a7 100644 --- a/papi-dts/modules/_renderer_services_renderer_xml_http_request_service_.html +++ b/papi-dts/modules/_renderer_services_renderer_xml_http_request_service_.html @@ -1,2 +1,2 @@ -"renderer/services/renderer-xml-http-request.service" | papi-dts

    Namespace "renderer/services/renderer-xml-http-request.service"

    Index

    Classes

    default +"renderer/services/renderer-xml-http-request.service" | papi-dts

    Generated using TypeDoc

    \ No newline at end of file diff --git a/papi-dts/modules/_shared_data_file_system_model_.html b/papi-dts/modules/_shared_data_file_system_model_.html index 78a058c590..01cfae31e4 100644 --- a/papi-dts/modules/_shared_data_file_system_model_.html +++ b/papi-dts/modules/_shared_data_file_system_model_.html @@ -1,2 +1,2 @@ -"shared/data/file-system.model" | papi-dts

    Namespace "shared/data/file-system.model"

    Index

    Type Aliases

    Uri +"shared/data/file-system.model" | papi-dts

    Generated using TypeDoc

    \ No newline at end of file diff --git a/papi-dts/modules/_shared_data_internal_connection_model_.html b/papi-dts/modules/_shared_data_internal_connection_model_.html index 74b0d9f3c0..d1e7a191a0 100644 --- a/papi-dts/modules/_shared_data_internal_connection_model_.html +++ b/papi-dts/modules/_shared_data_internal_connection_model_.html @@ -1,4 +1,4 @@ -"shared/data/internal-connection.model" | papi-dts

    Namespace "shared/data/internal-connection.model"

    Index

    Enumerations

    ConnectionStatus +"shared/data/internal-connection.model" | papi-dts

    Namespace "shared/data/internal-connection.model"

    Index

    Enumerations

    Type Aliases

    ClientConnectEvent ClientDisconnectEvent InternalEvent diff --git a/papi-dts/modules/_shared_data_network_connector_model_.html b/papi-dts/modules/_shared_data_network_connector_model_.html index 9395213b25..59716d3d42 100644 --- a/papi-dts/modules/_shared_data_network_connector_model_.html +++ b/papi-dts/modules/_shared_data_network_connector_model_.html @@ -1,4 +1,4 @@ -"shared/data/network-connector.model" | papi-dts

    Namespace "shared/data/network-connector.model"

    Index

    Enumerations

    MessageType +"shared/data/network-connector.model" | papi-dts

    Namespace "shared/data/network-connector.model"

    Index

    Enumerations

    Type Aliases

    ClientConnect InitClient Message diff --git a/papi-dts/modules/_shared_global_this_model_.html b/papi-dts/modules/_shared_global_this_model_.html index 3bd2295c9d..634aac64b4 100644 --- a/papi-dts/modules/_shared_global_this_model_.html +++ b/papi-dts/modules/_shared_global_this_model_.html @@ -1,2 +1,2 @@ -"shared/global-this.model" | papi-dts

    Namespace "shared/global-this.model"

    Index

    Enumerations

    ProcessType +"shared/global-this.model" | papi-dts

    Generated using TypeDoc

    \ No newline at end of file diff --git a/papi-dts/modules/_shared_models_data_provider_engine_model_.html b/papi-dts/modules/_shared_models_data_provider_engine_model_.html index beea75bdd4..17f2e42760 100644 --- a/papi-dts/modules/_shared_models_data_provider_engine_model_.html +++ b/papi-dts/modules/_shared_models_data_provider_engine_model_.html @@ -1,4 +1,4 @@ -"shared/models/data-provider-engine.model" | papi-dts

    Namespace "shared/models/data-provider-engine.model"

    Index

    Type Aliases

    DataProviderEngineNotifyUpdate +"shared/models/data-provider-engine.model" | papi-dts

    Generated using TypeDoc

    \ No newline at end of file diff --git a/papi-dts/modules/_shared_models_data_provider_interface_.html b/papi-dts/modules/_shared_models_data_provider_interface_.html index 1bdb7d75b6..05ca851a47 100644 --- a/papi-dts/modules/_shared_models_data_provider_interface_.html +++ b/papi-dts/modules/_shared_models_data_provider_interface_.html @@ -1,3 +1,3 @@ -"shared/models/data-provider.interface" | papi-dts

    Namespace "shared/models/data-provider.interface"

    Index

    Type Aliases

    IDisposableDataProvider +"shared/models/data-provider.interface" | papi-dts

    Generated using TypeDoc

    \ No newline at end of file diff --git a/papi-dts/modules/_shared_models_data_provider_model_.html b/papi-dts/modules/_shared_models_data_provider_model_.html index 28a301e14f..eb5e5afd95 100644 --- a/papi-dts/modules/_shared_models_data_provider_model_.html +++ b/papi-dts/modules/_shared_models_data_provider_model_.html @@ -1,4 +1,4 @@ -"shared/models/data-provider.model" | papi-dts

    Namespace "shared/models/data-provider.model"

    Index

    Type Aliases

    DataProviderDataType +"shared/models/data-provider.model" | papi-dts

    Namespace "shared/models/data-provider.model"

    Index

    Type Aliases

    DataProviderDataType DataProviderDataTypes DataProviderGetter DataProviderGetters diff --git a/papi-dts/modules/_shared_models_dialog_options_model_.html b/papi-dts/modules/_shared_models_dialog_options_model_.html index ba8e2211b8..bec26f3b20 100644 --- a/papi-dts/modules/_shared_models_dialog_options_model_.html +++ b/papi-dts/modules/_shared_models_dialog_options_model_.html @@ -1,3 +1,3 @@ -"shared/models/dialog-options.model" | papi-dts

    Namespace "shared/models/dialog-options.model"

    Index

    Type Aliases

    DialogData +"shared/models/dialog-options.model" | papi-dts

    Generated using TypeDoc

    \ No newline at end of file diff --git a/papi-dts/modules/_shared_models_disposal_model_.html b/papi-dts/modules/_shared_models_disposal_model_.html index 15bd69fc2c..bb182a4fe6 100644 --- a/papi-dts/modules/_shared_models_disposal_model_.html +++ b/papi-dts/modules/_shared_models_disposal_model_.html @@ -1,4 +1,4 @@ -"shared/models/disposal.model" | papi-dts

    Namespace "shared/models/disposal.model"

    Index

    Interfaces

    CannotHaveOnDidDispose +"shared/models/disposal.model" | papi-dts

    Namespace "shared/models/disposal.model"

    Index

    Interfaces

    Type Aliases

    CanHaveOnDidDispose diff --git a/papi-dts/modules/_shared_models_docking_framework_model_.html b/papi-dts/modules/_shared_models_docking_framework_model_.html index 378901bac3..bbd2c9da35 100644 --- a/papi-dts/modules/_shared_models_docking_framework_model_.html +++ b/papi-dts/modules/_shared_models_docking_framework_model_.html @@ -1,4 +1,4 @@ -"shared/models/docking-framework.model" | papi-dts

    Namespace "shared/models/docking-framework.model"

    Index

    Interfaces

    FloatLayout +"shared/models/docking-framework.model" | papi-dts

    Namespace "shared/models/docking-framework.model"

    Index

    Interfaces

    Type Aliases

    AddWebViewEvent diff --git a/papi-dts/modules/_shared_models_extract_data_provider_data_types_model_.html b/papi-dts/modules/_shared_models_extract_data_provider_data_types_model_.html index 75a51b51d4..eb10f9a393 100644 --- a/papi-dts/modules/_shared_models_extract_data_provider_data_types_model_.html +++ b/papi-dts/modules/_shared_models_extract_data_provider_data_types_model_.html @@ -1,2 +1,2 @@ -"shared/models/extract-data-provider-data-types.model" | papi-dts

    Namespace "shared/models/extract-data-provider-data-types.model"

    Index

    Type Aliases

    default +"shared/models/extract-data-provider-data-types.model" | papi-dts

    Generated using TypeDoc

    \ No newline at end of file diff --git a/papi-dts/modules/_shared_models_network_object_model_.html b/papi-dts/modules/_shared_models_network_object_model_.html index 42497ba33f..abc46c5e1a 100644 --- a/papi-dts/modules/_shared_models_network_object_model_.html +++ b/papi-dts/modules/_shared_models_network_object_model_.html @@ -1,4 +1,4 @@ -"shared/models/network-object.model" | papi-dts

    Namespace "shared/models/network-object.model"

    Index

    Type Aliases

    DisposableNetworkObject +"shared/models/network-object.model" | papi-dts

    Namespace "shared/models/network-object.model"

    Index

    Type Aliases

    DisposableNetworkObject LocalObjectToProxyCreator NetworkObject NetworkObjectDetails diff --git a/papi-dts/modules/_shared_models_papi_event_emitter_model_.html b/papi-dts/modules/_shared_models_papi_event_emitter_model_.html index 8092785e06..a2d73f2ac2 100644 --- a/papi-dts/modules/_shared_models_papi_event_emitter_model_.html +++ b/papi-dts/modules/_shared_models_papi_event_emitter_model_.html @@ -1,2 +1,2 @@ -"shared/models/papi-event-emitter.model" | papi-dts

    Namespace "shared/models/papi-event-emitter.model"

    Index

    Classes

    default +"shared/models/papi-event-emitter.model" | papi-dts

    Generated using TypeDoc

    \ No newline at end of file diff --git a/papi-dts/modules/_shared_models_papi_event_model_.html b/papi-dts/modules/_shared_models_papi_event_model_.html index 807bf2d5b0..0d6d40cc3e 100644 --- a/papi-dts/modules/_shared_models_papi_event_model_.html +++ b/papi-dts/modules/_shared_models_papi_event_model_.html @@ -1,4 +1,4 @@ -"shared/models/papi-event.model" | papi-dts

    Namespace "shared/models/papi-event.model"

    Index

    Type Aliases

    PapiEvent +"shared/models/papi-event.model" | papi-dts

    Generated using TypeDoc

    \ No newline at end of file diff --git a/papi-dts/modules/_shared_models_papi_network_event_emitter_model_.html b/papi-dts/modules/_shared_models_papi_network_event_emitter_model_.html index 80ace34ca7..3863ab2219 100644 --- a/papi-dts/modules/_shared_models_papi_network_event_emitter_model_.html +++ b/papi-dts/modules/_shared_models_papi_network_event_emitter_model_.html @@ -1,2 +1,2 @@ -"shared/models/papi-network-event-emitter.model" | papi-dts

    Namespace "shared/models/papi-network-event-emitter.model"

    Index

    Classes

    default +"shared/models/papi-network-event-emitter.model" | papi-dts

    Generated using TypeDoc

    \ No newline at end of file diff --git a/papi-dts/modules/_shared_models_project_data_provider_engine_model_.html b/papi-dts/modules/_shared_models_project_data_provider_engine_model_.html index 16c3dc79f1..a13ffef75c 100644 --- a/papi-dts/modules/_shared_models_project_data_provider_engine_model_.html +++ b/papi-dts/modules/_shared_models_project_data_provider_engine_model_.html @@ -1,4 +1,4 @@ -"shared/models/project-data-provider-engine.model" | papi-dts

    Namespace "shared/models/project-data-provider-engine.model"

    Index

    Interfaces

    ProjectDataProviderEngineFactory +"shared/models/project-data-provider-engine.model" | papi-dts

    Generated using TypeDoc

    \ No newline at end of file diff --git a/papi-dts/modules/_shared_models_project_data_provider_model_.html b/papi-dts/modules/_shared_models_project_data_provider_model_.html index ff4148f975..089a4eea42 100644 --- a/papi-dts/modules/_shared_models_project_data_provider_model_.html +++ b/papi-dts/modules/_shared_models_project_data_provider_model_.html @@ -1,3 +1,3 @@ -"shared/models/project-data-provider.model" | papi-dts

    Namespace "shared/models/project-data-provider.model"

    Index

    Type Aliases

    ExtensionDataScope +"shared/models/project-data-provider.model" | papi-dts

    Generated using TypeDoc

    \ No newline at end of file diff --git a/papi-dts/modules/_shared_models_project_metadata_model_.html b/papi-dts/modules/_shared_models_project_metadata_model_.html index a3a7c88c7e..20e212eb6c 100644 --- a/papi-dts/modules/_shared_models_project_metadata_model_.html +++ b/papi-dts/modules/_shared_models_project_metadata_model_.html @@ -1,2 +1,2 @@ -"shared/models/project-metadata.model" | papi-dts

    Namespace "shared/models/project-metadata.model"

    Index

    Type Aliases

    ProjectMetadata +"shared/models/project-metadata.model" | papi-dts

    Generated using TypeDoc

    \ No newline at end of file diff --git a/papi-dts/modules/_shared_models_web_view_model_.html b/papi-dts/modules/_shared_models_web_view_model_.html index 35d030e410..b02acbce7d 100644 --- a/papi-dts/modules/_shared_models_web_view_model_.html +++ b/papi-dts/modules/_shared_models_web_view_model_.html @@ -1,4 +1,4 @@ -"shared/models/web-view.model" | papi-dts

    Namespace "shared/models/web-view.model"

    Index

    Enumerations

    WebViewContentType +"shared/models/web-view.model" | papi-dts

    Namespace "shared/models/web-view.model"

    Index

    Enumerations

    Type Aliases

    GetWebViewDefinitionUpdatableProperties GetWebViewOptions SavedWebViewDefinition diff --git a/papi-dts/modules/_shared_models_web_view_provider_model_.html b/papi-dts/modules/_shared_models_web_view_provider_model_.html index a23249ecaf..9420e2d763 100644 --- a/papi-dts/modules/_shared_models_web_view_provider_model_.html +++ b/papi-dts/modules/_shared_models_web_view_provider_model_.html @@ -1,4 +1,4 @@ -"shared/models/web-view-provider.model" | papi-dts

    Namespace "shared/models/web-view-provider.model"

    Index

    Interfaces

    DisposableWebViewProvider +"shared/models/web-view-provider.model" | papi-dts

    Generated using TypeDoc

    \ No newline at end of file diff --git a/papi-dts/modules/_shared_services_command_service_.html b/papi-dts/modules/_shared_services_command_service_.html index f1ef8f83fb..d364777b37 100644 --- a/papi-dts/modules/_shared_services_command_service_.html +++ b/papi-dts/modules/_shared_services_command_service_.html @@ -1,4 +1,4 @@ -"shared/services/command.service" | papi-dts

    Namespace "shared/services/command.service"

    Index

    Type Aliases

    moduleSummaryComments +"shared/services/command.service" | papi-dts

    Namespace "shared/services/command.service"

    Index

    Type Aliases

    Functions

    addThree createSendCommandFunction initialize diff --git a/papi-dts/modules/_shared_services_connection_service_.html b/papi-dts/modules/_shared_services_connection_service_.html index 287b425537..4cd67095eb 100644 --- a/papi-dts/modules/_shared_services_connection_service_.html +++ b/papi-dts/modules/_shared_services_connection_service_.html @@ -1,4 +1,4 @@ -"shared/services/connection.service" | papi-dts

    Namespace "shared/services/connection.service"

    Index

    Functions

    connect +"shared/services/connection.service" | papi-dts

    Namespace "shared/services/connection.service"

    Index

    Functions

    connect disconnect emitEventOnNetwork getClientId diff --git a/papi-dts/modules/_shared_services_data_provider_service_.html b/papi-dts/modules/_shared_services_data_provider_service_.html index 0ace7f9c62..b3f17259dc 100644 --- a/papi-dts/modules/_shared_services_data_provider_service_.html +++ b/papi-dts/modules/_shared_services_data_provider_service_.html @@ -1,4 +1,4 @@ -"shared/services/data-provider.service" | papi-dts

    Namespace "shared/services/data-provider.service"

    Index

    Classes

    DataProviderEngine +"shared/services/data-provider.service" | papi-dts

    Namespace "shared/services/data-provider.service"

    Index

    Classes

    Interfaces

    Variables

    Functions

    getByType diff --git a/papi-dts/modules/_shared_services_dialog_service_.html b/papi-dts/modules/_shared_services_dialog_service_.html index c16aa7feb0..9ebeeae4fa 100644 --- a/papi-dts/modules/_shared_services_dialog_service_.html +++ b/papi-dts/modules/_shared_services_dialog_service_.html @@ -1,2 +1,2 @@ -"shared/services/dialog.service" | papi-dts

    Namespace "shared/services/dialog.service"

    Index

    Variables

    default +"shared/services/dialog.service" | papi-dts

    Generated using TypeDoc

    \ No newline at end of file diff --git a/papi-dts/modules/_shared_services_dialog_service_model_.html b/papi-dts/modules/_shared_services_dialog_service_model_.html index e03198ebe9..5b0e5e6f0e 100644 --- a/papi-dts/modules/_shared_services_dialog_service_model_.html +++ b/papi-dts/modules/_shared_services_dialog_service_model_.html @@ -1,3 +1,3 @@ -"shared/services/dialog.service-model" | papi-dts

    Namespace "shared/services/dialog.service-model"

    Index

    Interfaces

    DialogService +"shared/services/dialog.service-model" | papi-dts

    Generated using TypeDoc

    \ No newline at end of file diff --git a/papi-dts/modules/_shared_services_internet_service_.html b/papi-dts/modules/_shared_services_internet_service_.html index affb713171..d48b6c38df 100644 --- a/papi-dts/modules/_shared_services_internet_service_.html +++ b/papi-dts/modules/_shared_services_internet_service_.html @@ -1,3 +1,3 @@ -"shared/services/internet.service" | papi-dts

    Namespace "shared/services/internet.service"

    Index

    Interfaces

    InternetService +"shared/services/internet.service" | papi-dts

    Generated using TypeDoc

    \ No newline at end of file diff --git a/papi-dts/modules/_shared_services_logger_service_.html b/papi-dts/modules/_shared_services_logger_service_.html index b14fe075d0..f29e432f30 100644 --- a/papi-dts/modules/_shared_services_logger_service_.html +++ b/papi-dts/modules/_shared_services_logger_service_.html @@ -1,4 +1,4 @@ -"shared/services/logger.service" | papi-dts

    Namespace "shared/services/logger.service"

    Index

    Variables

    WARN_TAG +"shared/services/logger.service" | papi-dts

    Generated using TypeDoc

    \ No newline at end of file diff --git a/papi-dts/modules/_shared_services_network_connector_factory_.html b/papi-dts/modules/_shared_services_network_connector_factory_.html index f7a91b128d..08ca37ac8e 100644 --- a/papi-dts/modules/_shared_services_network_connector_factory_.html +++ b/papi-dts/modules/_shared_services_network_connector_factory_.html @@ -1,2 +1,2 @@ -"shared/services/network-connector.factory" | papi-dts

    Namespace "shared/services/network-connector.factory"

    Index

    Functions

    createNetworkConnector +"shared/services/network-connector.factory" | papi-dts

    Generated using TypeDoc

    \ No newline at end of file diff --git a/papi-dts/modules/_shared_services_network_connector_interface_.html b/papi-dts/modules/_shared_services_network_connector_interface_.html index 7acca2b45a..1f4bcb72c6 100644 --- a/papi-dts/modules/_shared_services_network_connector_interface_.html +++ b/papi-dts/modules/_shared_services_network_connector_interface_.html @@ -1,2 +1,2 @@ -"shared/services/network-connector.interface" | papi-dts

    Namespace "shared/services/network-connector.interface"

    Index

    Interfaces

    default +"shared/services/network-connector.interface" | papi-dts

    Generated using TypeDoc

    \ No newline at end of file diff --git a/papi-dts/modules/_shared_services_network_object_service_.html b/papi-dts/modules/_shared_services_network_object_service_.html index 3e06005c1a..3500a93fb0 100644 --- a/papi-dts/modules/_shared_services_network_object_service_.html +++ b/papi-dts/modules/_shared_services_network_object_service_.html @@ -1,4 +1,4 @@ -"shared/services/network-object.service" | papi-dts

    Namespace "shared/services/network-object.service"

    Index

    Variables

    default +"shared/services/network-object.service" | papi-dts

    Namespace "shared/services/network-object.service"

    Index

    Variables

    Functions

    onDidCreateNetworkObject onDidDisposeNetworkObject overrideDispose diff --git a/papi-dts/modules/_shared_services_network_object_status_service_.html b/papi-dts/modules/_shared_services_network_object_status_service_.html index 866c37e54a..4d6a4728b0 100644 --- a/papi-dts/modules/_shared_services_network_object_status_service_.html +++ b/papi-dts/modules/_shared_services_network_object_status_service_.html @@ -1,2 +1,2 @@ -"shared/services/network-object-status.service" | papi-dts

    Namespace "shared/services/network-object-status.service"

    Index

    Variables

    default +"shared/services/network-object-status.service" | papi-dts

    Generated using TypeDoc

    \ No newline at end of file diff --git a/papi-dts/modules/_shared_services_network_object_status_service_model_.html b/papi-dts/modules/_shared_services_network_object_status_service_model_.html index 9692d6ddcd..fe9aad9065 100644 --- a/papi-dts/modules/_shared_services_network_object_status_service_model_.html +++ b/papi-dts/modules/_shared_services_network_object_status_service_model_.html @@ -1,4 +1,4 @@ -"shared/services/network-object-status.service-model" | papi-dts

    Namespace "shared/services/network-object-status.service-model"

    Index

    Interfaces

    NetworkObjectStatusRemoteServiceType +"shared/services/network-object-status.service-model" | papi-dts

    Generated using TypeDoc

    \ No newline at end of file diff --git a/papi-dts/modules/_shared_services_network_service_.html b/papi-dts/modules/_shared_services_network_service_.html index 3f708ac2d1..9f95a57be7 100644 --- a/papi-dts/modules/_shared_services_network_service_.html +++ b/papi-dts/modules/_shared_services_network_service_.html @@ -1,4 +1,4 @@ -"shared/services/network.service" | papi-dts

    Namespace "shared/services/network.service"

    Index

    Interfaces

    PapiNetworkService +"shared/services/network.service" | papi-dts

    Namespace "shared/services/network.service"

    Index

    Interfaces

    Type Aliases

    ArgsRequestHandler ComplexRequestHandler ContentsRequestHandler diff --git a/papi-dts/modules/_shared_services_project_data_provider_service_.html b/papi-dts/modules/_shared_services_project_data_provider_service_.html index 66308861c4..e4d9a023b7 100644 --- a/papi-dts/modules/_shared_services_project_data_provider_service_.html +++ b/papi-dts/modules/_shared_services_project_data_provider_service_.html @@ -1,4 +1,4 @@ -"shared/services/project-data-provider.service" | papi-dts

    Namespace "shared/services/project-data-provider.service"

    Index

    Interfaces

    PapiBackendProjectDataProviderService +"shared/services/project-data-provider.service" | papi-dts

    Namespace "shared/services/project-data-provider.service"

    Index

    Interfaces

    Variables

    papiBackendProjectDataProviderService papiFrontendProjectDataProviderService diff --git a/papi-dts/modules/_shared_services_project_lookup_service_.html b/papi-dts/modules/_shared_services_project_lookup_service_.html index 7f643ef34c..99d57a4a75 100644 --- a/papi-dts/modules/_shared_services_project_lookup_service_.html +++ b/papi-dts/modules/_shared_services_project_lookup_service_.html @@ -1,2 +1,2 @@ -"shared/services/project-lookup.service" | papi-dts

    Namespace "shared/services/project-lookup.service"

    Index

    Variables

    default +"shared/services/project-lookup.service" | papi-dts

    Generated using TypeDoc

    \ No newline at end of file diff --git a/papi-dts/modules/_shared_services_project_lookup_service_model_.html b/papi-dts/modules/_shared_services_project_lookup_service_model_.html index 1baad744c8..193df84c39 100644 --- a/papi-dts/modules/_shared_services_project_lookup_service_model_.html +++ b/papi-dts/modules/_shared_services_project_lookup_service_model_.html @@ -1,3 +1,3 @@ -"shared/services/project-lookup.service-model" | papi-dts

    Namespace "shared/services/project-lookup.service-model"

    Index

    Interfaces

    ProjectLookupServiceType +"shared/services/project-lookup.service-model" | papi-dts

    Generated using TypeDoc

    \ No newline at end of file diff --git a/papi-dts/modules/_shared_services_settings_service_.html b/papi-dts/modules/_shared_services_settings_service_.html index ade6085a5a..65fc19a472 100644 --- a/papi-dts/modules/_shared_services_settings_service_.html +++ b/papi-dts/modules/_shared_services_settings_service_.html @@ -1,3 +1,3 @@ -"shared/services/settings.service" | papi-dts

    Namespace "shared/services/settings.service"

    Index

    Interfaces

    SettingsService +"shared/services/settings.service" | papi-dts

    Generated using TypeDoc

    \ No newline at end of file diff --git a/papi-dts/modules/_shared_services_web_view_provider_service_.html b/papi-dts/modules/_shared_services_web_view_provider_service_.html index 2ca726587b..5b78b86b19 100644 --- a/papi-dts/modules/_shared_services_web_view_provider_service_.html +++ b/papi-dts/modules/_shared_services_web_view_provider_service_.html @@ -1,4 +1,4 @@ -"shared/services/web-view-provider.service" | papi-dts

    Namespace "shared/services/web-view-provider.service"

    Index

    Interfaces

    PapiWebViewProviderService +"shared/services/web-view-provider.service" | papi-dts

    Namespace "shared/services/web-view-provider.service"

    Index

    Interfaces

    Variables

    default papiWebViewProviderService diff --git a/papi-dts/modules/_shared_services_web_view_service_.html b/papi-dts/modules/_shared_services_web_view_service_.html index 684415326e..4240bfc835 100644 --- a/papi-dts/modules/_shared_services_web_view_service_.html +++ b/papi-dts/modules/_shared_services_web_view_service_.html @@ -1,2 +1,2 @@ -"shared/services/web-view.service" | papi-dts

    Namespace "shared/services/web-view.service"

    Index

    Variables

    default +"shared/services/web-view.service" | papi-dts

    Generated using TypeDoc

    \ No newline at end of file diff --git a/papi-dts/modules/_shared_services_web_view_service_model_.html b/papi-dts/modules/_shared_services_web_view_service_model_.html index 8ee20729d5..215004343c 100644 --- a/papi-dts/modules/_shared_services_web_view_service_model_.html +++ b/papi-dts/modules/_shared_services_web_view_service_model_.html @@ -1,4 +1,4 @@ -"shared/services/web-view.service-model" | papi-dts

    Namespace "shared/services/web-view.service-model"

    Index

    Interfaces

    WebViewServiceType +"shared/services/web-view.service-model" | papi-dts

    Generated using TypeDoc

    \ No newline at end of file diff --git a/papi-dts/modules/_shared_utils_async_variable_.html b/papi-dts/modules/_shared_utils_async_variable_.html index 83d2e5517b..f3275f1e32 100644 --- a/papi-dts/modules/_shared_utils_async_variable_.html +++ b/papi-dts/modules/_shared_utils_async_variable_.html @@ -1,2 +1,2 @@ -"shared/utils/async-variable" | papi-dts

    Namespace "shared/utils/async-variable"

    Index

    Classes

    default +"shared/utils/async-variable" | papi-dts

    Generated using TypeDoc

    \ No newline at end of file diff --git a/papi-dts/modules/_shared_utils_internal_util_.html b/papi-dts/modules/_shared_utils_internal_util_.html index 58d9add1b5..f0ea52e0a5 100644 --- a/papi-dts/modules/_shared_utils_internal_util_.html +++ b/papi-dts/modules/_shared_utils_internal_util_.html @@ -1,4 +1,4 @@ -"shared/utils/internal-util" | papi-dts

    Namespace "shared/utils/internal-util"

    Index

    Functions

    getProcessType +"shared/utils/internal-util" | papi-dts

    Namespace "shared/utils/internal-util"

    Index

    Functions

    getProcessType isClient isExtensionHost isRenderer diff --git a/papi-dts/modules/_shared_utils_papi_util_.html b/papi-dts/modules/_shared_utils_papi_util_.html index 481519885a..b03dd0af9f 100644 --- a/papi-dts/modules/_shared_utils_papi_util_.html +++ b/papi-dts/modules/_shared_utils_papi_util_.html @@ -1,4 +1,4 @@ -"shared/utils/papi-util" | papi-dts

    Namespace "shared/utils/papi-util"

    Index

    Enumerations

    RequestHandlerType +"shared/utils/papi-util" | papi-dts

    Namespace "shared/utils/papi-util"

    Index

    Enumerations

    Type Aliases

    ComplexRequest ComplexResponse ComplexResponseFailure diff --git a/papi-dts/modules/_shared_utils_unsubscriber_async_list_.html b/papi-dts/modules/_shared_utils_unsubscriber_async_list_.html index f14f9961db..6d4196942e 100644 --- a/papi-dts/modules/_shared_utils_unsubscriber_async_list_.html +++ b/papi-dts/modules/_shared_utils_unsubscriber_async_list_.html @@ -1,2 +1,2 @@ -"shared/utils/unsubscriber-async-list" | papi-dts

    Namespace "shared/utils/unsubscriber-async-list"

    Index

    Classes

    default +"shared/utils/unsubscriber-async-list" | papi-dts

    Generated using TypeDoc

    \ No newline at end of file diff --git a/papi-dts/modules/_shared_utils_util_.html b/papi-dts/modules/_shared_utils_util_.html index ed611bb6ac..4fe6dcbf66 100644 --- a/papi-dts/modules/_shared_utils_util_.html +++ b/papi-dts/modules/_shared_utils_util_.html @@ -1,4 +1,4 @@ -"shared/utils/util" | papi-dts

    Namespace "shared/utils/util"

    Index

    Functions

    debounce +"shared/utils/util" | papi-dts

    Namespace "shared/utils/util"

    Index

    Functions

    debounce getAllObjectFunctionNames getErrorMessage groupBy diff --git a/papi-dts/modules/webViewComponent.html b/papi-dts/modules/webViewComponent.html index 853e292db3..c00c5d0fb5 100644 --- a/papi-dts/modules/webViewComponent.html +++ b/papi-dts/modules/webViewComponent.html @@ -1,6 +1,6 @@ webViewComponent | papi-dts

    Namespace webViewComponent

    A function that each React WebView extension must provide for Paranext to display it. Only used in WebView iframes.

    -

    Index

    Variables

    Index

    Variables

    contextTypes? defaultProps? displayName? propTypes? diff --git a/papi-dts/types/__papi_frontend_.Papi.html b/papi-dts/types/__papi_frontend_.Papi.html index 7ff65b9344..a7554b3390 100644 --- a/papi-dts/types/__papi_frontend_.Papi.html +++ b/papi-dts/types/__papi_frontend_.Papi.html @@ -1 +1 @@ -Papi | papi-dts

    Generated using TypeDoc

    \ No newline at end of file +Papi | papi-dts

    Generated using TypeDoc

    \ No newline at end of file diff --git a/papi-dts/types/_client_services_web_socket_interface_.IWebSocket.html b/papi-dts/types/_client_services_web_socket_interface_.IWebSocket.html index b89fae0d74..66dd8ab714 100644 --- a/papi-dts/types/_client_services_web_socket_interface_.IWebSocket.html +++ b/papi-dts/types/_client_services_web_socket_interface_.IWebSocket.html @@ -3,4 +3,4 @@ ClientNetworkConnector. For now, we are just using the browser WebSocket type. We may need specific functionality that don't line up between the ws library's implementation and the browser implementation. We can adjust as needed at that point.

    -

    Generated using TypeDoc

    \ No newline at end of file +

    Generated using TypeDoc

    \ No newline at end of file diff --git a/papi-dts/types/_extension_host_extension_types_extension_activation_context_model_.ExecutionActivationContext.html b/papi-dts/types/_extension_host_extension_types_extension_activation_context_model_.ExecutionActivationContext.html index 0b536e9483..f78e641b0f 100644 --- a/papi-dts/types/_extension_host_extension_types_extension_activation_context_model_.ExecutionActivationContext.html +++ b/papi-dts/types/_extension_host_extension_types_extension_activation_context_model_.ExecutionActivationContext.html @@ -2,4 +2,4 @@

    Type declaration

    Generated using TypeDoc

    \ No newline at end of file +

    Generated using TypeDoc

    \ No newline at end of file diff --git a/papi-dts/types/_extension_host_extension_types_extension_manifest_model_.ExtensionManifest.html b/papi-dts/types/_extension_host_extension_types_extension_manifest_model_.ExtensionManifest.html index c8d700dd60..60dd6c307f 100644 --- a/papi-dts/types/_extension_host_extension_types_extension_manifest_model_.ExtensionManifest.html +++ b/papi-dts/types/_extension_host_extension_types_extension_manifest_model_.ExtensionManifest.html @@ -18,4 +18,4 @@ for more information about extension type declaration files.

  • version: string

    Extension version - expected to be semver like "0.1.3".

    Note: semver may become a hard requirement in the future, so we recommend using it now.

    -
  • Generated using TypeDoc

    \ No newline at end of file +

    Generated using TypeDoc

    \ No newline at end of file diff --git a/papi-dts/types/_node_models_execution_token_model_.ExecutionTokenType.html b/papi-dts/types/_node_models_execution_token_model_.ExecutionTokenType.html index 4ee79c067c..f7a61bd539 100644 --- a/papi-dts/types/_node_models_execution_token_model_.ExecutionTokenType.html +++ b/papi-dts/types/_node_models_execution_token_model_.ExecutionTokenType.html @@ -1,2 +1,2 @@ ExecutionTokenType | papi-dts

    Generated using TypeDoc

    \ No newline at end of file +

    Generated using TypeDoc

    \ No newline at end of file diff --git a/papi-dts/types/_node_services_node_file_system_service_.DirectoryEntries.html b/papi-dts/types/_node_services_node_file_system_service_.DirectoryEntries.html index 2798b4d3f6..9f52564f4f 100644 --- a/papi-dts/types/_node_services_node_file_system_service_.DirectoryEntries.html +++ b/papi-dts/types/_node_services_node_file_system_service_.DirectoryEntries.html @@ -1,2 +1,2 @@ DirectoryEntries | papi-dts

    Generated using TypeDoc

    \ No newline at end of file +

    Generated using TypeDoc

    \ No newline at end of file diff --git a/papi-dts/types/_papi_shared_types_.CommandNames.html b/papi-dts/types/_papi_shared_types_.CommandNames.html index 854087bdd9..d60a5a9d02 100644 --- a/papi-dts/types/_papi_shared_types_.CommandNames.html +++ b/papi-dts/types/_papi_shared_types_.CommandNames.html @@ -2,4 +2,4 @@

    Automatically includes all extensions' commands that are added to CommandHandlers.

    Example

    'platform.quit';
     
    -

    Generated using TypeDoc

    \ No newline at end of file +

    Generated using TypeDoc

    \ No newline at end of file diff --git a/papi-dts/types/_papi_shared_types_.DataProviderNames.html b/papi-dts/types/_papi_shared_types_.DataProviderNames.html index 58dc3995e8..19f4c77125 100644 --- a/papi-dts/types/_papi_shared_types_.DataProviderNames.html +++ b/papi-dts/types/_papi_shared_types_.DataProviderNames.html @@ -2,4 +2,4 @@

    Automatically includes all extensions' data providers that are added to DataProviders.

    Example

    'platform.placeholder'
     
    -

    Generated using TypeDoc

    \ No newline at end of file +

    Generated using TypeDoc

    \ No newline at end of file diff --git a/papi-dts/types/_papi_shared_types_.DataProviderTypes.html b/papi-dts/types/_papi_shared_types_.DataProviderTypes.html index d517276db9..c6e775c69e 100644 --- a/papi-dts/types/_papi_shared_types_.DataProviderTypes.html +++ b/papi-dts/types/_papi_shared_types_.DataProviderTypes.html @@ -3,4 +3,4 @@

    Automatically includes all extensions' data providers that are added to DataProviders.

    Example

    DataProviderTypes['helloSomeone.people'] => {
    Greeting: DataProviderDataType<string, string | undefined, string>;
    Age: DataProviderDataType<string, number | undefined, number>;
    People: DataProviderDataType<undefined, PeopleData, never>;
    }
    -

    Generated using TypeDoc

    \ No newline at end of file +

    Generated using TypeDoc

    \ No newline at end of file diff --git a/papi-dts/types/_papi_shared_types_.DisposableDataProviders.html b/papi-dts/types/_papi_shared_types_.DisposableDataProviders.html index 8cf570aa7d..0e74e7248f 100644 --- a/papi-dts/types/_papi_shared_types_.DisposableDataProviders.html +++ b/papi-dts/types/_papi_shared_types_.DisposableDataProviders.html @@ -2,4 +2,4 @@ returned from papi.dataProviders.registerEngine - only the one who registers a data provider engine is allowed to dispose of the data provider.

    Automatically includes all extensions' data providers that are added to DataProviders.

    -

    Generated using TypeDoc

    \ No newline at end of file +

    Generated using TypeDoc

    \ No newline at end of file diff --git a/papi-dts/types/_papi_shared_types_.NotesOnlyProjectDataTypes.html b/papi-dts/types/_papi_shared_types_.NotesOnlyProjectDataTypes.html index 99f4d5d99a..b2098e43ba 100644 --- a/papi-dts/types/_papi_shared_types_.NotesOnlyProjectDataTypes.html +++ b/papi-dts/types/_papi_shared_types_.NotesOnlyProjectDataTypes.html @@ -1,2 +1,2 @@ NotesOnlyProjectDataTypes | papi-dts

    Generated using TypeDoc

    \ No newline at end of file +

    Type declaration

    Generated using TypeDoc

    \ No newline at end of file diff --git a/papi-dts/types/_papi_shared_types_.PlaceholderDataTypes.html b/papi-dts/types/_papi_shared_types_.PlaceholderDataTypes.html index 1f60caf7f8..fc6bdfa5da 100644 --- a/papi-dts/types/_papi_shared_types_.PlaceholderDataTypes.html +++ b/papi-dts/types/_papi_shared_types_.PlaceholderDataTypes.html @@ -1 +1 @@ -PlaceholderDataTypes | papi-dts

    Generated using TypeDoc

    \ No newline at end of file +PlaceholderDataTypes | papi-dts

    Generated using TypeDoc

    \ No newline at end of file diff --git a/papi-dts/types/_papi_shared_types_.ProjectTypes.html b/papi-dts/types/_papi_shared_types_.ProjectTypes.html index 610f59500e..3e01aa3a6f 100644 --- a/papi-dts/types/_papi_shared_types_.ProjectTypes.html +++ b/papi-dts/types/_papi_shared_types_.ProjectTypes.html @@ -1,3 +1,3 @@ ProjectTypes | papi-dts

    Generated using TypeDoc

    \ No newline at end of file +

    Generated using TypeDoc

    \ No newline at end of file diff --git a/papi-dts/types/_papi_shared_types_.SettingNames.html b/papi-dts/types/_papi_shared_types_.SettingNames.html index 14901211cb..b50f948d35 100644 --- a/papi-dts/types/_papi_shared_types_.SettingNames.html +++ b/papi-dts/types/_papi_shared_types_.SettingNames.html @@ -1 +1 @@ -SettingNames | papi-dts

    Generated using TypeDoc

    \ No newline at end of file +SettingNames | papi-dts

    Generated using TypeDoc

    \ No newline at end of file diff --git a/papi-dts/types/_papi_shared_types_.StuffDataTypes.html b/papi-dts/types/_papi_shared_types_.StuffDataTypes.html index 97775cb1d9..2774849a62 100644 --- a/papi-dts/types/_papi_shared_types_.StuffDataTypes.html +++ b/papi-dts/types/_papi_shared_types_.StuffDataTypes.html @@ -1 +1 @@ -StuffDataTypes | papi-dts

    Generated using TypeDoc

    \ No newline at end of file +StuffDataTypes | papi-dts

    Generated using TypeDoc

    \ No newline at end of file diff --git a/papi-dts/types/_renderer_components_dialogs_dialog_base_data_.DialogDefinitionBase.html b/papi-dts/types/_renderer_components_dialogs_dialog_base_data_.DialogDefinitionBase.html index c19745a954..cac4243312 100644 --- a/papi-dts/types/_renderer_components_dialogs_dialog_base_data_.DialogDefinitionBase.html +++ b/papi-dts/types/_renderer_components_dialogs_dialog_base_data_.DialogDefinitionBase.html @@ -14,4 +14,4 @@

    TODO: preserve requests between refreshes - save the dialog info in such a way that it works when loading again after refresh

  • Optional tabType?: string

    Overwritten in DialogDefinition. Must be specified by all DialogDefinitions

    -
  • Generated using TypeDoc

    \ No newline at end of file +

    Generated using TypeDoc

    \ No newline at end of file diff --git a/papi-dts/types/_renderer_components_dialogs_dialog_base_data_.DialogProps.html b/papi-dts/types/_renderer_components_dialogs_dialog_base_data_.DialogProps.html index 878ba5aa20..e2aa33edc8 100644 --- a/papi-dts/types/_renderer_components_dialogs_dialog_base_data_.DialogProps.html +++ b/papi-dts/types/_renderer_components_dialogs_dialog_base_data_.DialogProps.html @@ -1,7 +1,7 @@ DialogProps | papi-dts
    DialogProps<TData>: DialogData & {
        cancelDialog(): void;
        rejectDialog(errorMessage): void;
        submitDialog(data): void;
    }

    Props provided to the dialog component

    Type Parameters

    • TData = unknown

    Type declaration

    • cancelDialog:function
      • Cancels the dialog request (resolves the response with undefined) and closes the dialog

        -

        Returns void

    • rejectDialog:function
      • Rejects the dialog request with the specified message and closes the dialog

        +

        Returns void

    • rejectDialog:function
      • Rejects the dialog request with the specified message and closes the dialog

        Parameters

        • errorMessage: string

          Message to explain why the dialog request was rejected

          -

        Returns void

    • submitDialog:function
      • Sends the data as a resolved response to the dialog request and closes the dialog

        +

    Returns void

  • submitDialog:function
    • Sends the data as a resolved response to the dialog request and closes the dialog

      Parameters

      • data: TData

        Data with which to resolve the request

        -

      Returns void

  • Generated using TypeDoc

    \ No newline at end of file +

    Returns void

    Generated using TypeDoc

    \ No newline at end of file diff --git a/papi-dts/types/_renderer_components_dialogs_dialog_definition_model_.DialogDataTypes.html b/papi-dts/types/_renderer_components_dialogs_dialog_definition_model_.DialogDataTypes.html index 5125eb5ff1..64af0bc713 100644 --- a/papi-dts/types/_renderer_components_dialogs_dialog_definition_model_.DialogDataTypes.html +++ b/papi-dts/types/_renderer_components_dialogs_dialog_definition_model_.DialogDataTypes.html @@ -5,4 +5,4 @@ as props

  • props: DialogProps<TReturnType> & TOptions

    Props provided to the dialog component

  • responseType: TReturnType

    The type of the response to the dialog request

    -
  • Generated using TypeDoc

    \ No newline at end of file +

    Generated using TypeDoc

    \ No newline at end of file diff --git a/papi-dts/types/_renderer_components_dialogs_dialog_definition_model_.DialogDefinition.html b/papi-dts/types/_renderer_components_dialogs_dialog_definition_model_.DialogDefinition.html index 38010fd0cd..94dadef93a 100644 --- a/papi-dts/types/_renderer_components_dialogs_dialog_definition_model_.DialogDefinition.html +++ b/papi-dts/types/_renderer_components_dialogs_dialog_definition_model_.DialogDefinition.html @@ -1 +1 @@ -DialogDefinition | papi-dts

    Generated using TypeDoc

    \ No newline at end of file +DialogDefinition | papi-dts

    Generated using TypeDoc

    \ No newline at end of file diff --git a/papi-dts/types/_renderer_components_dialogs_dialog_definition_model_.DialogTabTypes.html b/papi-dts/types/_renderer_components_dialogs_dialog_definition_model_.DialogTabTypes.html index 455f77c847..8b3e4993ca 100644 --- a/papi-dts/types/_renderer_components_dialogs_dialog_definition_model_.DialogTabTypes.html +++ b/papi-dts/types/_renderer_components_dialogs_dialog_definition_model_.DialogTabTypes.html @@ -1,2 +1,2 @@ DialogTabTypes | papi-dts

    Generated using TypeDoc

    \ No newline at end of file +

    Generated using TypeDoc

    \ No newline at end of file diff --git a/papi-dts/types/_renderer_components_dialogs_dialog_definition_model_.SelectMultipleProjectsDialogOptions.html b/papi-dts/types/_renderer_components_dialogs_dialog_definition_model_.SelectMultipleProjectsDialogOptions.html index ca525d61a2..8793ec7a41 100644 --- a/papi-dts/types/_renderer_components_dialogs_dialog_definition_model_.SelectMultipleProjectsDialogOptions.html +++ b/papi-dts/types/_renderer_components_dialogs_dialog_definition_model_.SelectMultipleProjectsDialogOptions.html @@ -1,4 +1,4 @@ SelectMultipleProjectsDialogOptions | papi-dts

    Generated using TypeDoc

    \ No newline at end of file +

    Generated using TypeDoc

    \ No newline at end of file diff --git a/papi-dts/types/_renderer_components_dialogs_dialog_definition_model_.SelectProjectDialogOptions.html b/papi-dts/types/_renderer_components_dialogs_dialog_definition_model_.SelectProjectDialogOptions.html index 177f56c633..007f70aca5 100644 --- a/papi-dts/types/_renderer_components_dialogs_dialog_definition_model_.SelectProjectDialogOptions.html +++ b/papi-dts/types/_renderer_components_dialogs_dialog_definition_model_.SelectProjectDialogOptions.html @@ -1,3 +1,3 @@ SelectProjectDialogOptions | papi-dts

    Generated using TypeDoc

    \ No newline at end of file +

    Generated using TypeDoc

    \ No newline at end of file diff --git a/papi-dts/types/_shared_data_file_system_model_.Uri.html b/papi-dts/types/_shared_data_file_system_model_.Uri.html index e58306ec67..61916d7286 100644 --- a/papi-dts/types/_shared_data_file_system_model_.Uri.html +++ b/papi-dts/types/_shared_data_file_system_model_.Uri.html @@ -7,4 +7,4 @@
  • resources:// - goes to the resources directory installed in the app
  • file:// - an absolute file path from root
  • -

    Generated using TypeDoc

    \ No newline at end of file +

    Generated using TypeDoc

    \ No newline at end of file diff --git a/papi-dts/types/_shared_data_internal_connection_model_.ClientConnectEvent.html b/papi-dts/types/_shared_data_internal_connection_model_.ClientConnectEvent.html index 595cedf276..21cf0ba3fb 100644 --- a/papi-dts/types/_shared_data_internal_connection_model_.ClientConnectEvent.html +++ b/papi-dts/types/_shared_data_internal_connection_model_.ClientConnectEvent.html @@ -1,2 +1,2 @@ ClientConnectEvent | papi-dts

    Generated using TypeDoc

    \ No newline at end of file +

    Type declaration

    • clientId: number
    • didReconnect: boolean

    Generated using TypeDoc

    \ No newline at end of file diff --git a/papi-dts/types/_shared_data_internal_connection_model_.ClientDisconnectEvent.html b/papi-dts/types/_shared_data_internal_connection_model_.ClientDisconnectEvent.html index 4903c57415..6050c1864c 100644 --- a/papi-dts/types/_shared_data_internal_connection_model_.ClientDisconnectEvent.html +++ b/papi-dts/types/_shared_data_internal_connection_model_.ClientDisconnectEvent.html @@ -1,2 +1,2 @@ ClientDisconnectEvent | papi-dts

    Generated using TypeDoc

    \ No newline at end of file +

    Type declaration

    • clientId: number

    Generated using TypeDoc

    \ No newline at end of file diff --git a/papi-dts/types/_shared_data_internal_connection_model_.InternalEvent.html b/papi-dts/types/_shared_data_internal_connection_model_.InternalEvent.html index 02ea8f2410..e84da31197 100644 --- a/papi-dts/types/_shared_data_internal_connection_model_.InternalEvent.html +++ b/papi-dts/types/_shared_data_internal_connection_model_.InternalEvent.html @@ -1,4 +1,4 @@ InternalEvent | papi-dts

    Generated using TypeDoc

    \ No newline at end of file +

    Generated using TypeDoc

    \ No newline at end of file diff --git a/papi-dts/types/_shared_data_internal_connection_model_.InternalNetworkEventHandler.html b/papi-dts/types/_shared_data_internal_connection_model_.InternalNetworkEventHandler.html index 06d102f600..27559f3197 100644 --- a/papi-dts/types/_shared_data_internal_connection_model_.InternalNetworkEventHandler.html +++ b/papi-dts/types/_shared_data_internal_connection_model_.InternalNetworkEventHandler.html @@ -1,3 +1,3 @@ InternalNetworkEventHandler | papi-dts

    Generated using TypeDoc

    \ No newline at end of file +

    Type Parameters

    • T

    Parameters

    Returns void

    Generated using TypeDoc

    \ No newline at end of file diff --git a/papi-dts/types/_shared_data_internal_connection_model_.InternalRequest.html b/papi-dts/types/_shared_data_internal_connection_model_.InternalRequest.html index 4db1f1a23e..93c751126e 100644 --- a/papi-dts/types/_shared_data_internal_connection_model_.InternalRequest.html +++ b/papi-dts/types/_shared_data_internal_connection_model_.InternalRequest.html @@ -1,2 +1,2 @@ InternalRequest | papi-dts

    Generated using TypeDoc

    \ No newline at end of file +

    Type Parameters

    • TParam = unknown

    Type declaration

    • requestId: number
    • senderId: number

    Generated using TypeDoc

    \ No newline at end of file diff --git a/papi-dts/types/_shared_data_internal_connection_model_.InternalRequestHandler.html b/papi-dts/types/_shared_data_internal_connection_model_.InternalRequestHandler.html index 565ae4509e..797ce94d6f 100644 --- a/papi-dts/types/_shared_data_internal_connection_model_.InternalRequestHandler.html +++ b/papi-dts/types/_shared_data_internal_connection_model_.InternalRequestHandler.html @@ -1,3 +1,3 @@ InternalRequestHandler | papi-dts

    Generated using TypeDoc

    \ No newline at end of file +

    Type Parameters

    • TParam

    • TReturn

    Parameters

    Returns Promise<InternalResponse<TReturn>>

    Generated using TypeDoc

    \ No newline at end of file diff --git a/papi-dts/types/_shared_data_internal_connection_model_.InternalResponse.html b/papi-dts/types/_shared_data_internal_connection_model_.InternalResponse.html index e9dc9f453b..3c32290d42 100644 --- a/papi-dts/types/_shared_data_internal_connection_model_.InternalResponse.html +++ b/papi-dts/types/_shared_data_internal_connection_model_.InternalResponse.html @@ -1,4 +1,4 @@ InternalResponse | papi-dts

    Generated using TypeDoc

    \ No newline at end of file +

    Generated using TypeDoc

    \ No newline at end of file diff --git a/papi-dts/types/_shared_data_internal_connection_model_.NetworkConnectorEventHandlers.html b/papi-dts/types/_shared_data_internal_connection_model_.NetworkConnectorEventHandlers.html index 5a7d677934..1bb52109c5 100644 --- a/papi-dts/types/_shared_data_internal_connection_model_.NetworkConnectorEventHandlers.html +++ b/papi-dts/types/_shared_data_internal_connection_model_.NetworkConnectorEventHandlers.html @@ -2,4 +2,4 @@ from NetworkEventEmitters so the events inform all interested connections

    Type declaration

    • Optional didClientConnectHandler?: ((event) => void)
        • (event): void
        • Handles when a new connection is established

          Parameters

          Returns void

    • Optional didClientDisconnectHandler?: ((event) => void)

    Generated using TypeDoc

    \ No newline at end of file +

    Parameters

    Returns void

    Generated using TypeDoc

    \ No newline at end of file diff --git a/papi-dts/types/_shared_data_internal_connection_model_.NetworkConnectorInfo.html b/papi-dts/types/_shared_data_internal_connection_model_.NetworkConnectorInfo.html index fcde5452bf..e79a7473fe 100644 --- a/papi-dts/types/_shared_data_internal_connection_model_.NetworkConnectorInfo.html +++ b/papi-dts/types/_shared_data_internal_connection_model_.NetworkConnectorInfo.html @@ -1,2 +1,2 @@ NetworkConnectorInfo | papi-dts

    Generated using TypeDoc

    \ No newline at end of file +

    Type declaration

    • clientId: number

    Generated using TypeDoc

    \ No newline at end of file diff --git a/papi-dts/types/_shared_data_internal_connection_model_.NetworkEventHandler.html b/papi-dts/types/_shared_data_internal_connection_model_.NetworkEventHandler.html index beb1361fff..d6408a6fad 100644 --- a/papi-dts/types/_shared_data_internal_connection_model_.NetworkEventHandler.html +++ b/papi-dts/types/_shared_data_internal_connection_model_.NetworkEventHandler.html @@ -1,2 +1,2 @@ NetworkEventHandler | papi-dts

    Generated using TypeDoc

    \ No newline at end of file +

    Type Parameters

    • T

    Parameters

    • eventType: string
    • event: T

    Returns void

    Generated using TypeDoc

    \ No newline at end of file diff --git a/papi-dts/types/_shared_data_internal_connection_model_.RequestHandler.html b/papi-dts/types/_shared_data_internal_connection_model_.RequestHandler.html index d873befac9..b31652742c 100644 --- a/papi-dts/types/_shared_data_internal_connection_model_.RequestHandler.html +++ b/papi-dts/types/_shared_data_internal_connection_model_.RequestHandler.html @@ -1,2 +1,2 @@ RequestHandler | papi-dts

    Generated using TypeDoc

    \ No newline at end of file +

    Type Parameters

    • TParam

    • TReturn

    Parameters

    Returns Promise<ComplexResponse<TReturn>>

    Generated using TypeDoc

    \ No newline at end of file diff --git a/papi-dts/types/_shared_data_internal_connection_model_.RequestRouter.html b/papi-dts/types/_shared_data_internal_connection_model_.RequestRouter.html index 8053ad1625..09e41d0d5d 100644 --- a/papi-dts/types/_shared_data_internal_connection_model_.RequestRouter.html +++ b/papi-dts/types/_shared_data_internal_connection_model_.RequestRouter.html @@ -1,2 +1,2 @@ RequestRouter | papi-dts

    Generated using TypeDoc

    \ No newline at end of file +

    Parameters

    • requestType: string

    Returns number

    Generated using TypeDoc

    \ No newline at end of file diff --git a/papi-dts/types/_shared_data_network_connector_model_.ClientConnect.html b/papi-dts/types/_shared_data_network_connector_model_.ClientConnect.html index 15d493a35f..e2e07a9b2b 100644 --- a/papi-dts/types/_shared_data_network_connector_model_.ClientConnect.html +++ b/papi-dts/types/_shared_data_network_connector_model_.ClientConnect.html @@ -3,4 +3,4 @@ (like if the browser refreshes): if the server has a connection with this clientGuid, it will unregister all requests on that client so the reconnecting client can register its request handlers again.

    -
  • senderId: number
  • type: ClientConnect
  • Generated using TypeDoc

    \ No newline at end of file +
  • senderId: number
  • type: ClientConnect
  • Generated using TypeDoc

    \ No newline at end of file diff --git a/papi-dts/types/_shared_data_network_connector_model_.InitClient.html b/papi-dts/types/_shared_data_network_connector_model_.InitClient.html index 952e1a0713..01057102a5 100644 --- a/papi-dts/types/_shared_data_network_connector_model_.InitClient.html +++ b/papi-dts/types/_shared_data_network_connector_model_.InitClient.html @@ -1,3 +1,3 @@ InitClient | papi-dts

    Generated using TypeDoc

    \ No newline at end of file +
  • connectorInfo: NetworkConnectorInfo
  • senderId: number
  • type: InitClient
  • Generated using TypeDoc

    \ No newline at end of file diff --git a/papi-dts/types/_shared_data_network_connector_model_.Message.html b/papi-dts/types/_shared_data_network_connector_model_.Message.html index f467f0dc54..913f99b7fb 100644 --- a/papi-dts/types/_shared_data_network_connector_model_.Message.html +++ b/papi-dts/types/_shared_data_network_connector_model_.Message.html @@ -1,2 +1,2 @@ Message | papi-dts

    Generated using TypeDoc

    \ No newline at end of file +

    Generated using TypeDoc

    \ No newline at end of file diff --git a/papi-dts/types/_shared_data_network_connector_model_.WebSocketEvent.html b/papi-dts/types/_shared_data_network_connector_model_.WebSocketEvent.html index 4355da9458..5eac5bc332 100644 --- a/papi-dts/types/_shared_data_network_connector_model_.WebSocketEvent.html +++ b/papi-dts/types/_shared_data_network_connector_model_.WebSocketEvent.html @@ -1,3 +1,3 @@ WebSocketEvent | papi-dts

    Generated using TypeDoc

    \ No newline at end of file +
  • type: Event
  • Generated using TypeDoc

    \ No newline at end of file diff --git a/papi-dts/types/_shared_data_network_connector_model_.WebSocketRequest.html b/papi-dts/types/_shared_data_network_connector_model_.WebSocketRequest.html index bc1752e86e..e38d2e12b0 100644 --- a/papi-dts/types/_shared_data_network_connector_model_.WebSocketRequest.html +++ b/papi-dts/types/_shared_data_network_connector_model_.WebSocketRequest.html @@ -1,3 +1,3 @@ WebSocketRequest | papi-dts

    Generated using TypeDoc

    \ No newline at end of file +
  • type: Request
  • Generated using TypeDoc

    \ No newline at end of file diff --git a/papi-dts/types/_shared_data_network_connector_model_.WebSocketResponse.html b/papi-dts/types/_shared_data_network_connector_model_.WebSocketResponse.html index e3f2c07693..06823d4ec2 100644 --- a/papi-dts/types/_shared_data_network_connector_model_.WebSocketResponse.html +++ b/papi-dts/types/_shared_data_network_connector_model_.WebSocketResponse.html @@ -1,3 +1,3 @@ WebSocketResponse | papi-dts

    Generated using TypeDoc

    \ No newline at end of file +
  • type: Response
  • Generated using TypeDoc

    \ No newline at end of file diff --git a/papi-dts/types/_shared_models_data_provider_engine_model_.DataProviderEngineNotifyUpdate.html b/papi-dts/types/_shared_models_data_provider_engine_model_.DataProviderEngineNotifyUpdate.html index 4ce1f3ed46..b5483105b1 100644 --- a/papi-dts/types/_shared_models_data_provider_engine_model_.DataProviderEngineNotifyUpdate.html +++ b/papi-dts/types/_shared_models_data_provider_engine_model_.DataProviderEngineNotifyUpdate.html @@ -17,4 +17,4 @@

    Example: You can log the manual updates in your data provider engine by spec

    See

    DataProviderUpdateInstructions for more info on the updateInstructions parameter

    WARNING: Do not update a data type in its get<data_type> method (unless you make a base case)! It will create a destructive infinite loop.

    -

    Generated using TypeDoc

    \ No newline at end of file +

    Generated using TypeDoc

    \ No newline at end of file diff --git a/papi-dts/types/_shared_models_data_provider_engine_model_.WithNotifyUpdate.html b/papi-dts/types/_shared_models_data_provider_engine_model_.WithNotifyUpdate.html index 8c76d9597d..c5e3a1e59e 100644 --- a/papi-dts/types/_shared_models_data_provider_engine_model_.WithNotifyUpdate.html +++ b/papi-dts/types/_shared_models_data_provider_engine_model_.WithNotifyUpdate.html @@ -24,4 +24,4 @@

    See

    DataProviderUpdateInstructions for more info on the updateI

  • DataProviderEngineNotifyUpdate for more information on notifyUpdate.
  • IDataProviderEngine for more information on using this type.
  • -

    Generated using TypeDoc

    \ No newline at end of file +

    Generated using TypeDoc

    \ No newline at end of file diff --git a/papi-dts/types/_shared_models_data_provider_engine_model_.default.html b/papi-dts/types/_shared_models_data_provider_engine_model_.default.html index f1e2361226..28cee36ed8 100644 --- a/papi-dts/types/_shared_models_data_provider_engine_model_.default.html +++ b/papi-dts/types/_shared_models_data_provider_engine_model_.default.html @@ -23,4 +23,4 @@
    class MyDPE extends DataProviderEngine<MyDataTypes> implements IDataProviderEngine<MyDataTypes> {
    ...
    }
    -

    Generated using TypeDoc

    \ No newline at end of file +

    Generated using TypeDoc

    \ No newline at end of file diff --git a/papi-dts/types/_shared_models_data_provider_interface_.IDisposableDataProvider.html b/papi-dts/types/_shared_models_data_provider_interface_.IDisposableDataProvider.html index b272f5d75c..0face73091 100644 --- a/papi-dts/types/_shared_models_data_provider_interface_.IDisposableDataProvider.html +++ b/papi-dts/types/_shared_models_data_provider_interface_.IDisposableDataProvider.html @@ -2,4 +2,4 @@ data provider (only the service that set it up should dispose of it) with dataProviderService.registerEngine

    Type Parameters

    See

    IDataProvider

    -

    Generated using TypeDoc

    \ No newline at end of file +

    Generated using TypeDoc

    \ No newline at end of file diff --git a/papi-dts/types/_shared_models_data_provider_interface_.default.html b/papi-dts/types/_shared_models_data_provider_interface_.default.html index d66e68227f..103224ccdf 100644 --- a/papi-dts/types/_shared_models_data_provider_interface_.default.html +++ b/papi-dts/types/_shared_models_data_provider_interface_.default.html @@ -3,4 +3,4 @@ getting a data provider with dataProviderService.get.

    Note: each set<data_type> method has a corresponding get<data_type> and subscribe<data_type> method.

    -

    Type Parameters

    Generated using TypeDoc

    \ No newline at end of file +

    Type Parameters

    Generated using TypeDoc

    \ No newline at end of file diff --git a/papi-dts/types/_shared_models_data_provider_model_.DataProviderDataType.html b/papi-dts/types/_shared_models_data_provider_model_.DataProviderDataType.html index 77c58e5169..3f210908e6 100644 --- a/papi-dts/types/_shared_models_data_provider_model_.DataProviderDataType.html +++ b/papi-dts/types/_shared_models_data_provider_model_.DataProviderDataType.html @@ -7,4 +7,4 @@ wants at this data type.

  • setData: TSetData

    The type of data ingested by this data provider when you run set<data_type> based on a provided selector

    -
  • Generated using TypeDoc

    \ No newline at end of file +

    Generated using TypeDoc

    \ No newline at end of file diff --git a/papi-dts/types/_shared_models_data_provider_model_.DataProviderDataTypes.html b/papi-dts/types/_shared_models_data_provider_model_.DataProviderDataTypes.html index c6f448d8d9..5f9038a7a8 100644 --- a/papi-dts/types/_shared_models_data_provider_model_.DataProviderDataTypes.html +++ b/papi-dts/types/_shared_models_data_provider_model_.DataProviderDataTypes.html @@ -7,4 +7,4 @@ following:

    {
    Greeting: DataProviderDataType<string, string | undefined, string>;
    Age: DataProviderDataType<string, number | undefined, number>;
    All: DataProviderDataType<undefined, { greeting: string, age: number }, never>;
    }
    -

    Generated using TypeDoc

    \ No newline at end of file +

    Generated using TypeDoc

    \ No newline at end of file diff --git a/papi-dts/types/_shared_models_data_provider_model_.DataProviderGetter.html b/papi-dts/types/_shared_models_data_provider_model_.DataProviderGetter.html index 6b0fcdcb06..b51fc1a072 100644 --- a/papi-dts/types/_shared_models_data_provider_model_.DataProviderGetter.html +++ b/papi-dts/types/_shared_models_data_provider_model_.DataProviderGetter.html @@ -4,4 +4,4 @@ up-to-date.

    Parameters

    • selector: TDataType["selector"]

      Tells the provider what subset of data to get

    Returns Promise<TDataType["getData"]>

    The subset of data represented by the selector

    -

    Generated using TypeDoc

    \ No newline at end of file +

    Generated using TypeDoc

    \ No newline at end of file diff --git a/papi-dts/types/_shared_models_data_provider_model_.DataProviderGetters.html b/papi-dts/types/_shared_models_data_provider_model_.DataProviderGetters.html index de7d09233b..38286bc63e 100644 --- a/papi-dts/types/_shared_models_data_provider_model_.DataProviderGetters.html +++ b/papi-dts/types/_shared_models_data_provider_model_.DataProviderGetters.html @@ -1,3 +1,3 @@ DataProviderGetters | papi-dts

    Generated using TypeDoc

    \ No newline at end of file +

    Generated using TypeDoc

    \ No newline at end of file diff --git a/papi-dts/types/_shared_models_data_provider_model_.DataProviderSetter.html b/papi-dts/types/_shared_models_data_provider_model_.DataProviderSetter.html index ef82b4fece..8fb64c8e8f 100644 --- a/papi-dts/types/_shared_models_data_provider_model_.DataProviderSetter.html +++ b/papi-dts/types/_shared_models_data_provider_model_.DataProviderSetter.html @@ -6,4 +6,4 @@

    Returns Promise<DataProviderUpdateInstructions<TDataTypes>>

    Information that papi uses to interpret whether to send out updates. Defaults to true (meaning send updates only for this data type).

    See

    DataProviderUpdateInstructions for more info on what to return

    -

    Generated using TypeDoc

    \ No newline at end of file +

    Generated using TypeDoc

    \ No newline at end of file diff --git a/papi-dts/types/_shared_models_data_provider_model_.DataProviderSetters.html b/papi-dts/types/_shared_models_data_provider_model_.DataProviderSetters.html index 396bf8b83f..691f05027a 100644 --- a/papi-dts/types/_shared_models_data_provider_model_.DataProviderSetters.html +++ b/papi-dts/types/_shared_models_data_provider_model_.DataProviderSetters.html @@ -1,3 +1,3 @@ DataProviderSetters | papi-dts

    Generated using TypeDoc

    \ No newline at end of file +

    Generated using TypeDoc

    \ No newline at end of file diff --git a/papi-dts/types/_shared_models_data_provider_model_.DataProviderSubscriber.html b/papi-dts/types/_shared_models_data_provider_model_.DataProviderSubscriber.html index ce6076dea8..d745070556 100644 --- a/papi-dts/types/_shared_models_data_provider_model_.DataProviderSubscriber.html +++ b/papi-dts/types/_shared_models_data_provider_model_.DataProviderSubscriber.html @@ -8,4 +8,4 @@
  • callback: PapiEventHandler<TDataType["getData"]>

    Function to run with the updated data for this selector

  • Optional options: DataProviderSubscriberOptions

    Various options to adjust how the subscriber emits updates

  • Returns Promise<UnsubscriberAsync>

    Unsubscriber to stop listening for updates

    -

    Generated using TypeDoc

    \ No newline at end of file +

    Generated using TypeDoc

    \ No newline at end of file diff --git a/papi-dts/types/_shared_models_data_provider_model_.DataProviderSubscriberOptions.html b/papi-dts/types/_shared_models_data_provider_model_.DataProviderSubscriberOptions.html index c679b7c76c..1ab6a34d46 100644 --- a/papi-dts/types/_shared_models_data_provider_model_.DataProviderSubscriberOptions.html +++ b/papi-dts/types/_shared_models_data_provider_model_.DataProviderSubscriberOptions.html @@ -21,4 +21,4 @@

    Default

    'deeply-equal'
     
    -

    Generated using TypeDoc

    \ No newline at end of file +

    Generated using TypeDoc

    \ No newline at end of file diff --git a/papi-dts/types/_shared_models_data_provider_model_.DataProviderSubscribers.html b/papi-dts/types/_shared_models_data_provider_model_.DataProviderSubscribers.html index c081d625a2..953a95e8fd 100644 --- a/papi-dts/types/_shared_models_data_provider_model_.DataProviderSubscribers.html +++ b/papi-dts/types/_shared_models_data_provider_model_.DataProviderSubscribers.html @@ -1,4 +1,4 @@ DataProviderSubscribers | papi-dts

    Generated using TypeDoc

    \ No newline at end of file +

    Generated using TypeDoc

    \ No newline at end of file diff --git a/papi-dts/types/_shared_models_data_provider_model_.DataProviderUpdateInstructions.html b/papi-dts/types/_shared_models_data_provider_model_.DataProviderUpdateInstructions.html index 1da0556185..e2e70e87b7 100644 --- a/papi-dts/types/_shared_models_data_provider_model_.DataProviderUpdateInstructions.html +++ b/papi-dts/types/_shared_models_data_provider_model_.DataProviderUpdateInstructions.html @@ -16,4 +16,4 @@
  • false (or falsy) do not update subscriptions

  • -

    Type Parameters

    Generated using TypeDoc

    \ No newline at end of file +

    Type Parameters

    Generated using TypeDoc

    \ No newline at end of file diff --git a/papi-dts/types/_shared_models_data_provider_model_.DataTypeNames.html b/papi-dts/types/_shared_models_data_provider_model_.DataTypeNames.html index c294fd62b3..7cf80da57b 100644 --- a/papi-dts/types/_shared_models_data_provider_model_.DataTypeNames.html +++ b/papi-dts/types/_shared_models_data_provider_model_.DataTypeNames.html @@ -1,4 +1,4 @@ DataTypeNames | papi-dts

    Generated using TypeDoc

    \ No newline at end of file +

    Generated using TypeDoc

    \ No newline at end of file diff --git a/papi-dts/types/_shared_models_data_provider_model_.default.html b/papi-dts/types/_shared_models_data_provider_model_.default.html index 66c0a67092..341ca49198 100644 --- a/papi-dts/types/_shared_models_data_provider_model_.default.html +++ b/papi-dts/types/_shared_models_data_provider_model_.default.html @@ -2,4 +2,4 @@ object layers over the data provider engine and runs its methods along with other methods. This object is transformed into an IDataProvider by networkObjectService.set.

    Type Parameters

    See

    IDataProvider

    -

    Generated using TypeDoc

    \ No newline at end of file +

    Generated using TypeDoc

    \ No newline at end of file diff --git a/papi-dts/types/_shared_models_dialog_options_model_.DialogData.html b/papi-dts/types/_shared_models_dialog_options_model_.DialogData.html index e2efd78d74..b12fe1a8f7 100644 --- a/papi-dts/types/_shared_models_dialog_options_model_.DialogData.html +++ b/papi-dts/types/_shared_models_dialog_options_model_.DialogData.html @@ -1,2 +1,2 @@ DialogData | papi-dts

    Generated using TypeDoc

    \ No newline at end of file +

    Type declaration

    • isDialog: true

    Generated using TypeDoc

    \ No newline at end of file diff --git a/papi-dts/types/_shared_models_dialog_options_model_.DialogOptions.html b/papi-dts/types/_shared_models_dialog_options_model_.DialogOptions.html index 95b35e1b6d..1a6aea86a0 100644 --- a/papi-dts/types/_shared_models_dialog_options_model_.DialogOptions.html +++ b/papi-dts/types/_shared_models_dialog_options_model_.DialogOptions.html @@ -2,4 +2,4 @@

    Type declaration

    • Optional iconUrl?: string

      Url of dialog icon to display in the header. Default is Platform.Bible logo

    • Optional prompt?: string

      The message to show the user in the dialog. Default depends on the dialog

    • Optional title?: string

      Dialog title to display in the header. Default depends on the dialog

      -

    Generated using TypeDoc

    \ No newline at end of file +

    Generated using TypeDoc

    \ No newline at end of file diff --git a/papi-dts/types/_shared_models_disposal_model_.CanHaveOnDidDispose.html b/papi-dts/types/_shared_models_disposal_model_.CanHaveOnDidDispose.html index 1cbeafcf23..4de1a8e05c 100644 --- a/papi-dts/types/_shared_models_disposal_model_.CanHaveOnDidDispose.html +++ b/papi-dts/types/_shared_models_disposal_model_.CanHaveOnDidDispose.html @@ -1,2 +1,2 @@ CanHaveOnDidDispose | papi-dts

    Generated using TypeDoc

    \ No newline at end of file +

    Type Parameters

    Generated using TypeDoc

    \ No newline at end of file diff --git a/papi-dts/types/_shared_models_docking_framework_model_.AddWebViewEvent.html b/papi-dts/types/_shared_models_docking_framework_model_.AddWebViewEvent.html index 0b2c8f04f3..bc8554ad69 100644 --- a/papi-dts/types/_shared_models_docking_framework_model_.AddWebViewEvent.html +++ b/papi-dts/types/_shared_models_docking_framework_model_.AddWebViewEvent.html @@ -1,2 +1,2 @@ AddWebViewEvent | papi-dts

    Generated using TypeDoc

    \ No newline at end of file +

    Type declaration

    Generated using TypeDoc

    \ No newline at end of file diff --git a/papi-dts/types/_shared_models_docking_framework_model_.FloatPosition.html b/papi-dts/types/_shared_models_docking_framework_model_.FloatPosition.html index d48ca81704..d3137f0a3c 100644 --- a/papi-dts/types/_shared_models_docking_framework_model_.FloatPosition.html +++ b/papi-dts/types/_shared_models_docking_framework_model_.FloatPosition.html @@ -4,4 +4,4 @@ window
  • center - center the window in the dock layout
  • -

    Generated using TypeDoc

    \ No newline at end of file +

    Generated using TypeDoc

    \ No newline at end of file diff --git a/papi-dts/types/_shared_models_docking_framework_model_.FloatSize.html b/papi-dts/types/_shared_models_docking_framework_model_.FloatSize.html index f045d829d2..cff2052cb0 100644 --- a/papi-dts/types/_shared_models_docking_framework_model_.FloatSize.html +++ b/papi-dts/types/_shared_models_docking_framework_model_.FloatSize.html @@ -1,2 +1,2 @@ FloatSize | papi-dts

    Generated using TypeDoc

    \ No newline at end of file +

    Type declaration

    • height: number
    • width: number

    Generated using TypeDoc

    \ No newline at end of file diff --git a/papi-dts/types/_shared_models_docking_framework_model_.Layout.html b/papi-dts/types/_shared_models_docking_framework_model_.Layout.html index 6df73ca987..c56ee44c93 100644 --- a/papi-dts/types/_shared_models_docking_framework_model_.Layout.html +++ b/papi-dts/types/_shared_models_docking_framework_model_.Layout.html @@ -1,2 +1,2 @@ Layout | papi-dts

    Generated using TypeDoc

    \ No newline at end of file +

    Generated using TypeDoc

    \ No newline at end of file diff --git a/papi-dts/types/_shared_models_docking_framework_model_.OnLayoutChangeRCDock.html b/papi-dts/types/_shared_models_docking_framework_model_.OnLayoutChangeRCDock.html index ec2660d157..d6636e6199 100644 --- a/papi-dts/types/_shared_models_docking_framework_model_.OnLayoutChangeRCDock.html +++ b/papi-dts/types/_shared_models_docking_framework_model_.OnLayoutChangeRCDock.html @@ -1,2 +1,2 @@ OnLayoutChangeRCDock | papi-dts

    Generated using TypeDoc

    \ No newline at end of file +

    Parameters

    • newLayout: LayoutBase
    • Optional currentTabId: string
    • Optional direction: DropDirection

    Returns Promise<void>

    Generated using TypeDoc

    \ No newline at end of file diff --git a/papi-dts/types/_shared_models_docking_framework_model_.PanelDirection.html b/papi-dts/types/_shared_models_docking_framework_model_.PanelDirection.html index 2b08d63070..2c9ad3e301 100644 --- a/papi-dts/types/_shared_models_docking_framework_model_.PanelDirection.html +++ b/papi-dts/types/_shared_models_docking_framework_model_.PanelDirection.html @@ -1 +1 @@ -PanelDirection | papi-dts

    Generated using TypeDoc

    \ No newline at end of file +PanelDirection | papi-dts

    Generated using TypeDoc

    \ No newline at end of file diff --git a/papi-dts/types/_shared_models_docking_framework_model_.PapiDockLayout.html b/papi-dts/types/_shared_models_docking_framework_model_.PapiDockLayout.html index 32b8d2c9ba..c1b57ad17b 100644 --- a/papi-dts/types/_shared_models_docking_framework_model_.PapiDockLayout.html +++ b/papi-dts/types/_shared_models_docking_framework_model_.PapiDockLayout.html @@ -27,4 +27,4 @@
  • updateInfo: WebViewDefinitionUpdateInfo

    Properties to update on the WebView. Any unspecified properties will stay the same

  • Returns boolean

    True if successfully found the WebView to update; false otherwise

    -

    Generated using TypeDoc

    \ No newline at end of file +

    Generated using TypeDoc

    \ No newline at end of file diff --git a/papi-dts/types/_shared_models_docking_framework_model_.SavedTabInfo.html b/papi-dts/types/_shared_models_docking_framework_model_.SavedTabInfo.html index 377e47dbf9..e6d046610e 100644 --- a/papi-dts/types/_shared_models_docking_framework_model_.SavedTabInfo.html +++ b/papi-dts/types/_shared_models_docking_framework_model_.SavedTabInfo.html @@ -7,4 +7,4 @@
  • id: string

    Tab ID - a unique identifier that identifies this tab. If this tab is a WebView, this ID will match the WebViewDefinition.id

  • tabType: string

    Type of tab - indicates what kind of built-in tab this info represents

    -
  • Generated using TypeDoc

    \ No newline at end of file +

    Generated using TypeDoc

    \ No newline at end of file diff --git a/papi-dts/types/_shared_models_docking_framework_model_.TabInfo.html b/papi-dts/types/_shared_models_docking_framework_model_.TabInfo.html index 5ecbff5de4..47211500e7 100644 --- a/papi-dts/types/_shared_models_docking_framework_model_.TabInfo.html +++ b/papi-dts/types/_shared_models_docking_framework_model_.TabInfo.html @@ -10,4 +10,4 @@

    Defaults to Platform.Bible logo

  • tabTitle: string

    Text to show on the title bar of the tab

  • Optional tabTooltip?: string

    Text to show when hovering over the title bar of the tab

    -
  • Generated using TypeDoc

    \ No newline at end of file +

    Generated using TypeDoc

    \ No newline at end of file diff --git a/papi-dts/types/_shared_models_docking_framework_model_.TabLoader.html b/papi-dts/types/_shared_models_docking_framework_model_.TabLoader.html index 0d031e3351..f521c1b653 100644 --- a/papi-dts/types/_shared_models_docking_framework_model_.TabLoader.html +++ b/papi-dts/types/_shared_models_docking_framework_model_.TabLoader.html @@ -1,4 +1,4 @@ TabLoader | papi-dts

    Generated using TypeDoc

    \ No newline at end of file +

    Parameters

    Returns TabInfo

    Generated using TypeDoc

    \ No newline at end of file diff --git a/papi-dts/types/_shared_models_docking_framework_model_.TabSaver.html b/papi-dts/types/_shared_models_docking_framework_model_.TabSaver.html index 28931eebb8..ad0ab2f82e 100644 --- a/papi-dts/types/_shared_models_docking_framework_model_.TabSaver.html +++ b/papi-dts/types/_shared_models_docking_framework_model_.TabSaver.html @@ -3,4 +3,4 @@ stripped from TabInfo by saveTabInfoBase before saving (so it is just a SavedTabInfo).

    Parameters

    • tabInfo: TabInfo

      The Paranext tab to save

    Returns SavedTabInfo | undefined

    The saved tab info for Paranext to persist. If undefined, does not save the tab

    -

    Generated using TypeDoc

    \ No newline at end of file +

    Generated using TypeDoc

    \ No newline at end of file diff --git a/papi-dts/types/_shared_models_docking_framework_model_.WebViewTabProps.html b/papi-dts/types/_shared_models_docking_framework_model_.WebViewTabProps.html index 712ebd648c..c8bb0c7f3f 100644 --- a/papi-dts/types/_shared_models_docking_framework_model_.WebViewTabProps.html +++ b/papi-dts/types/_shared_models_docking_framework_model_.WebViewTabProps.html @@ -1,2 +1,2 @@ WebViewTabProps | papi-dts

    Generated using TypeDoc

    \ No newline at end of file +

    Generated using TypeDoc

    \ No newline at end of file diff --git a/papi-dts/types/_shared_models_extract_data_provider_data_types_model_.default.html b/papi-dts/types/_shared_models_extract_data_provider_data_types_model_.default.html index b06eb122d1..86b19eb676 100644 --- a/papi-dts/types/_shared_models_extract_data_provider_data_types_model_.default.html +++ b/papi-dts/types/_shared_models_extract_data_provider_data_types_model_.default.html @@ -3,4 +3,4 @@

    Works with generic types IDataProvider, DataProviderInternal, IDisposableDataProvider, and IDataProviderEngine along with the papi-shared-types extensible interfaces DataProviders and DisposableDataProviders

    -

    Type Parameters

    • TDataProvider

    Generated using TypeDoc

    \ No newline at end of file +

    Type Parameters

    • TDataProvider

    Generated using TypeDoc

    \ No newline at end of file diff --git a/papi-dts/types/_shared_models_network_object_model_.DisposableNetworkObject.html b/papi-dts/types/_shared_models_network_object_model_.DisposableNetworkObject.html index 88a4307eda..3f7ee1ce42 100644 --- a/papi-dts/types/_shared_models_network_object_model_.DisposableNetworkObject.html +++ b/papi-dts/types/_shared_models_network_object_model_.DisposableNetworkObject.html @@ -1,3 +1,3 @@ DisposableNetworkObject | papi-dts

    Generated using TypeDoc

    \ No newline at end of file +

    Generated using TypeDoc

    \ No newline at end of file diff --git a/papi-dts/types/_shared_models_network_object_model_.LocalObjectToProxyCreator.html b/papi-dts/types/_shared_models_network_object_model_.LocalObjectToProxyCreator.html index ec09a9f8a9..c67ef2b9a2 100644 --- a/papi-dts/types/_shared_models_network_object_model_.LocalObjectToProxyCreator.html +++ b/papi-dts/types/_shared_models_network_object_model_.LocalObjectToProxyCreator.html @@ -9,4 +9,4 @@ (probably has to do with that it's a wrapped and layered type). Functions that implement this type should return Partial

    See

    networkObjectService

    -

    Generated using TypeDoc

    \ No newline at end of file +

    Generated using TypeDoc

    \ No newline at end of file diff --git a/papi-dts/types/_shared_models_network_object_model_.NetworkObject.html b/papi-dts/types/_shared_models_network_object_model_.NetworkObject.html index a806ff3899..4726b02054 100644 --- a/papi-dts/types/_shared_models_network_object_model_.NetworkObject.html +++ b/papi-dts/types/_shared_models_network_object_model_.NetworkObject.html @@ -5,4 +5,4 @@ call that method. This is because we don't want users of network objects to dispose of them. Only the caller of networkObjectService.set should be able to dispose of the network object.

    Type Parameters

    See

    networkObjectService

    -

    Generated using TypeDoc

    \ No newline at end of file +

    Generated using TypeDoc

    \ No newline at end of file diff --git a/papi-dts/types/_shared_models_network_object_model_.NetworkObjectDetails.html b/papi-dts/types/_shared_models_network_object_model_.NetworkObjectDetails.html index 7588ede628..068feecdd1 100644 --- a/papi-dts/types/_shared_models_network_object_model_.NetworkObjectDetails.html +++ b/papi-dts/types/_shared_models_network_object_model_.NetworkObjectDetails.html @@ -1,4 +1,4 @@ NetworkObjectDetails | papi-dts

    Generated using TypeDoc

    \ No newline at end of file +

    Generated using TypeDoc

    \ No newline at end of file diff --git a/papi-dts/types/_shared_models_network_object_model_.NetworkableObject.html b/papi-dts/types/_shared_models_network_object_model_.NetworkableObject.html index c5e8956c88..63962e6d9a 100644 --- a/papi-dts/types/_shared_models_network_object_model_.NetworkableObject.html +++ b/papi-dts/types/_shared_models_network_object_model_.NetworkableObject.html @@ -1,3 +1,3 @@ NetworkableObject | papi-dts

    Generated using TypeDoc

    \ No newline at end of file +

    Generated using TypeDoc

    \ No newline at end of file diff --git a/papi-dts/types/_shared_models_papi_event_model_.PapiEvent.html b/papi-dts/types/_shared_models_papi_event_model_.PapiEvent.html index 8eeaae41a0..240f062584 100644 --- a/papi-dts/types/_shared_models_papi_event_model_.PapiEvent.html +++ b/papi-dts/types/_shared_models_papi_event_model_.PapiEvent.html @@ -2,4 +2,4 @@

    Parameters

    Returns Unsubscriber

    Unsubscriber function to run to stop calling the passed-in function when the event is emitted

    -

    Generated using TypeDoc

    \ No newline at end of file +

    Generated using TypeDoc

    \ No newline at end of file diff --git a/papi-dts/types/_shared_models_papi_event_model_.PapiEventAsync.html b/papi-dts/types/_shared_models_papi_event_model_.PapiEventAsync.html index 5174055863..4d0eccf932 100644 --- a/papi-dts/types/_shared_models_papi_event_model_.PapiEventAsync.html +++ b/papi-dts/types/_shared_models_papi_event_model_.PapiEventAsync.html @@ -1,3 +1,3 @@ PapiEventAsync | papi-dts

    Generated using TypeDoc

    \ No newline at end of file +

    Parameters

    Returns Promise<UnsubscriberAsync>

    Generated using TypeDoc

    \ No newline at end of file diff --git a/papi-dts/types/_shared_models_papi_event_model_.PapiEventHandler.html b/papi-dts/types/_shared_models_papi_event_model_.PapiEventHandler.html index 6fa136e0cd..9d0fcbc0a7 100644 --- a/papi-dts/types/_shared_models_papi_event_model_.PapiEventHandler.html +++ b/papi-dts/types/_shared_models_papi_event_model_.PapiEventHandler.html @@ -1,2 +1,2 @@ PapiEventHandler | papi-dts

    Generated using TypeDoc

    \ No newline at end of file +

    Parameters

    • event: T

    Returns void

    Generated using TypeDoc

    \ No newline at end of file diff --git a/papi-dts/types/_shared_models_project_data_provider_engine_model_.ProjectDataProvider.html b/papi-dts/types/_shared_models_project_data_provider_engine_model_.ProjectDataProvider.html index 1397cf8cf3..5714b71bcc 100644 --- a/papi-dts/types/_shared_models_project_data_provider_engine_model_.ProjectDataProvider.html +++ b/papi-dts/types/_shared_models_project_data_provider_engine_model_.ProjectDataProvider.html @@ -1,2 +1,2 @@ ProjectDataProvider | papi-dts

    Generated using TypeDoc

    \ No newline at end of file +

    Generated using TypeDoc

    \ No newline at end of file diff --git a/papi-dts/types/_shared_models_project_data_provider_engine_model_.ProjectDataProviderEngineTypes.html b/papi-dts/types/_shared_models_project_data_provider_engine_model_.ProjectDataProviderEngineTypes.html index 10722632f0..5b103064b9 100644 --- a/papi-dts/types/_shared_models_project_data_provider_engine_model_.ProjectDataProviderEngineTypes.html +++ b/papi-dts/types/_shared_models_project_data_provider_engine_model_.ProjectDataProviderEngineTypes.html @@ -1,2 +1,2 @@ ProjectDataProviderEngineTypes | papi-dts

    Generated using TypeDoc

    \ No newline at end of file +

    Generated using TypeDoc

    \ No newline at end of file diff --git a/papi-dts/types/_shared_models_project_data_provider_model_.ExtensionDataScope.html b/papi-dts/types/_shared_models_project_data_provider_model_.ExtensionDataScope.html index 4bf8d59285..b0a469ae51 100644 --- a/papi-dts/types/_shared_models_project_data_provider_model_.ExtensionDataScope.html +++ b/papi-dts/types/_shared_models_project_data_provider_model_.ExtensionDataScope.html @@ -9,4 +9,4 @@

    This is the smallest level of granularity provided by a PDP for accessing extension data. There is no way to get or set just a portion of data identified by a single dataQualifier value.

  • extensionName: string

    Name of an extension as provided in its manifest

    -
  • Generated using TypeDoc

    \ No newline at end of file +

    Generated using TypeDoc

    \ No newline at end of file diff --git a/papi-dts/types/_shared_models_project_data_provider_model_.MandatoryProjectDataType.html b/papi-dts/types/_shared_models_project_data_provider_model_.MandatoryProjectDataType.html index ff9b8d1521..c6d62d7a39 100644 --- a/papi-dts/types/_shared_models_project_data_provider_model_.MandatoryProjectDataType.html +++ b/papi-dts/types/_shared_models_project_data_provider_model_.MandatoryProjectDataType.html @@ -11,4 +11,4 @@ so following this interface ensures your PDP will not break if such a requirement is implemented. -

    Type declaration

    Generated using TypeDoc

    \ No newline at end of file +

    Type declaration

    Generated using TypeDoc

    \ No newline at end of file diff --git a/papi-dts/types/_shared_models_project_metadata_model_.ProjectMetadata.html b/papi-dts/types/_shared_models_project_metadata_model_.ProjectMetadata.html index d7d12b3ae9..ce58b2c1c5 100644 --- a/papi-dts/types/_shared_models_project_metadata_model_.ProjectMetadata.html +++ b/papi-dts/types/_shared_models_project_metadata_model_.ProjectMetadata.html @@ -5,4 +5,4 @@
  • projectType: ProjectTypes

    Indicates what sort of project this is which implies its data shape (e.g., what data streams should be available)

  • storageType: string

    Indicates how the project is persisted to storage

    -
  • Generated using TypeDoc

    \ No newline at end of file +

    Generated using TypeDoc

    \ No newline at end of file diff --git a/papi-dts/types/_shared_models_web_view_model_.GetWebViewDefinitionUpdatableProperties.html b/papi-dts/types/_shared_models_web_view_model_.GetWebViewDefinitionUpdatableProperties.html index 112500fba4..24edd06857 100644 --- a/papi-dts/types/_shared_models_web_view_model_.GetWebViewDefinitionUpdatableProperties.html +++ b/papi-dts/types/_shared_models_web_view_model_.GetWebViewDefinitionUpdatableProperties.html @@ -1,4 +1,4 @@ GetWebViewDefinitionUpdatableProperties | papi-dts

    Generated using TypeDoc

    \ No newline at end of file +

    Returns WebViewDefinitionUpdatableProperties | undefined

    Generated using TypeDoc

    \ No newline at end of file diff --git a/papi-dts/types/_shared_models_web_view_model_.GetWebViewOptions.html b/papi-dts/types/_shared_models_web_view_model_.GetWebViewOptions.html index 1644baf291..4ed1c37e22 100644 --- a/papi-dts/types/_shared_models_web_view_model_.GetWebViewOptions.html +++ b/papi-dts/types/_shared_models_web_view_model_.GetWebViewOptions.html @@ -11,4 +11,4 @@

    Note: setting existingId to undefined counts as providing in this case (providing is tested with 'existingId' in options, not just testing if existingId is truthy). Not providing an existingId at all is the only way to specify we are not looking for an existing webView

    -

    Generated using TypeDoc

    \ No newline at end of file +

    Generated using TypeDoc

    \ No newline at end of file diff --git a/papi-dts/types/_shared_models_web_view_model_.SavedWebViewDefinition.html b/papi-dts/types/_shared_models_web_view_model_.SavedWebViewDefinition.html index 73c671c494..3798a5320f 100644 --- a/papi-dts/types/_shared_models_web_view_model_.SavedWebViewDefinition.html +++ b/papi-dts/types/_shared_models_web_view_model_.SavedWebViewDefinition.html @@ -1,4 +1,4 @@ SavedWebViewDefinition | papi-dts
    SavedWebViewDefinition: (Partial<Omit<WebViewDefinitionReact, "content" | "styles" | "allowScripts">> | Partial<Omit<WebViewDefinitionHtml, "content" | "allowScripts">> | Partial<Omit<WebViewDefinitionURL, "content" | "allowScripts">>) & Pick<WebViewDefinitionBase, "id" | "webViewType">

    Saved WebView information that does not contain the actual content of the WebView. Saved into layouts. Could have as little as the type and ID. WebView providers load these into actual WebViewDefinitions and verify any existing properties on the WebViews.

    -

    Generated using TypeDoc

    \ No newline at end of file +

    Generated using TypeDoc

    \ No newline at end of file diff --git a/papi-dts/types/_shared_models_web_view_model_.UpdateWebViewDefinition.html b/papi-dts/types/_shared_models_web_view_model_.UpdateWebViewDefinition.html index 93a6dc3a3b..ad219b642b 100644 --- a/papi-dts/types/_shared_models_web_view_model_.UpdateWebViewDefinition.html +++ b/papi-dts/types/_shared_models_web_view_model_.UpdateWebViewDefinition.html @@ -5,4 +5,4 @@

    ï¼ example

    updateWebViewDefinition({ title: `Hello ${name}` });
     
    -

    Parameters

    Returns boolean

    Generated using TypeDoc

    \ No newline at end of file +

    Parameters

    Returns boolean

    Generated using TypeDoc

    \ No newline at end of file diff --git a/papi-dts/types/_shared_models_web_view_model_.UseWebViewStateHook.html b/papi-dts/types/_shared_models_web_view_model_.UseWebViewStateHook.html index bb3412dad6..4ae4e07926 100644 --- a/papi-dts/types/_shared_models_web_view_model_.UseWebViewStateHook.html +++ b/papi-dts/types/_shared_models_web_view_model_.UseWebViewStateHook.html @@ -15,4 +15,4 @@

    ï¼ example

    const [lastPersonSeen, setLastPersonSeen] = useWebViewState('lastSeen', 'No one');
     
    -

    Type Parameters

    • T

    Parameters

    • stateKey: string
    • defaultStateValue: NonNullable<T>

    Returns [webViewState: NonNullable<T>, setWebViewState: Dispatch<SetStateAction<NonNullable<T>>>]

    Generated using TypeDoc

    \ No newline at end of file +

    Type Parameters

    • T

    Parameters

    • stateKey: string
    • defaultStateValue: NonNullable<T>

    Returns [webViewState: NonNullable<T>, setWebViewState: Dispatch<SetStateAction<NonNullable<T>>>]

    Generated using TypeDoc

    \ No newline at end of file diff --git a/papi-dts/types/_shared_models_web_view_model_.WebViewDefinition.html b/papi-dts/types/_shared_models_web_view_model_.WebViewDefinition.html index baba28bd07..804d6d5741 100644 --- a/papi-dts/types/_shared_models_web_view_model_.WebViewDefinition.html +++ b/papi-dts/types/_shared_models_web_view_model_.WebViewDefinition.html @@ -1,2 +1,2 @@ WebViewDefinition | papi-dts

    Generated using TypeDoc

    \ No newline at end of file +

    Generated using TypeDoc

    \ No newline at end of file diff --git a/papi-dts/types/_shared_models_web_view_model_.WebViewDefinitionBase.html b/papi-dts/types/_shared_models_web_view_model_.WebViewDefinitionBase.html index dc34b88245..7c5d1317cd 100644 --- a/papi-dts/types/_shared_models_web_view_model_.WebViewDefinitionBase.html +++ b/papi-dts/types/_shared_models_web_view_model_.WebViewDefinitionBase.html @@ -65,4 +65,4 @@
  • Optional title?: string

    Name of the tab for the WebView

  • Optional tooltip?: string

    Tooltip that is shown when hovering over the webview title

  • webViewType: WebViewType

    What type of WebView this is. Unique to all other WebView definitions

    -
  • Generated using TypeDoc

    \ No newline at end of file +

    Generated using TypeDoc

    \ No newline at end of file diff --git a/papi-dts/types/_shared_models_web_view_model_.WebViewDefinitionHtml.html b/papi-dts/types/_shared_models_web_view_model_.WebViewDefinitionHtml.html index 78b02a63b5..f1069c36e9 100644 --- a/papi-dts/types/_shared_models_web_view_model_.WebViewDefinitionHtml.html +++ b/papi-dts/types/_shared_models_web_view_model_.WebViewDefinitionHtml.html @@ -1,3 +1,3 @@ WebViewDefinitionHtml | papi-dts

    Generated using TypeDoc

    \ No newline at end of file +

    Generated using TypeDoc

    \ No newline at end of file diff --git a/papi-dts/types/_shared_models_web_view_model_.WebViewDefinitionReact.html b/papi-dts/types/_shared_models_web_view_model_.WebViewDefinitionReact.html index 7d80f48455..1cc0aa251a 100644 --- a/papi-dts/types/_shared_models_web_view_model_.WebViewDefinitionReact.html +++ b/papi-dts/types/_shared_models_web_view_model_.WebViewDefinitionReact.html @@ -1,4 +1,4 @@ WebViewDefinitionReact | papi-dts

    Generated using TypeDoc

    \ No newline at end of file +

    Generated using TypeDoc

    \ No newline at end of file diff --git a/papi-dts/types/_shared_models_web_view_model_.WebViewDefinitionURL.html b/papi-dts/types/_shared_models_web_view_model_.WebViewDefinitionURL.html index bc55c21362..730c590067 100644 --- a/papi-dts/types/_shared_models_web_view_model_.WebViewDefinitionURL.html +++ b/papi-dts/types/_shared_models_web_view_model_.WebViewDefinitionURL.html @@ -1,4 +1,4 @@ WebViewDefinitionURL | papi-dts

    Generated using TypeDoc

    \ No newline at end of file +

    Generated using TypeDoc

    \ No newline at end of file diff --git a/papi-dts/types/_shared_models_web_view_model_.WebViewDefinitionUpdatableProperties.html b/papi-dts/types/_shared_models_web_view_model_.WebViewDefinitionUpdatableProperties.html index 8944e45288..1882edd03e 100644 --- a/papi-dts/types/_shared_models_web_view_model_.WebViewDefinitionUpdatableProperties.html +++ b/papi-dts/types/_shared_models_web_view_model_.WebViewDefinitionUpdatableProperties.html @@ -1,2 +1,2 @@ WebViewDefinitionUpdatableProperties | papi-dts

    Generated using TypeDoc

    \ No newline at end of file +

    Generated using TypeDoc

    \ No newline at end of file diff --git a/papi-dts/types/_shared_models_web_view_model_.WebViewDefinitionUpdateInfo.html b/papi-dts/types/_shared_models_web_view_model_.WebViewDefinitionUpdateInfo.html index 2eedca815c..4a0a393f12 100644 --- a/papi-dts/types/_shared_models_web_view_model_.WebViewDefinitionUpdateInfo.html +++ b/papi-dts/types/_shared_models_web_view_model_.WebViewDefinitionUpdateInfo.html @@ -1,3 +1,3 @@ WebViewDefinitionUpdateInfo | papi-dts

    Generated using TypeDoc

    \ No newline at end of file +

    Generated using TypeDoc

    \ No newline at end of file diff --git a/papi-dts/types/_shared_models_web_view_model_.WebViewId.html b/papi-dts/types/_shared_models_web_view_model_.WebViewId.html index 88809843f7..5a27776ca4 100644 --- a/papi-dts/types/_shared_models_web_view_model_.WebViewId.html +++ b/papi-dts/types/_shared_models_web_view_model_.WebViewId.html @@ -1,2 +1,2 @@ WebViewId | papi-dts

    Generated using TypeDoc

    \ No newline at end of file +

    Generated using TypeDoc

    \ No newline at end of file diff --git a/papi-dts/types/_shared_models_web_view_model_.WebViewProps.html b/papi-dts/types/_shared_models_web_view_model_.WebViewProps.html index cf9a1b9094..3194e7b763 100644 --- a/papi-dts/types/_shared_models_web_view_model_.WebViewProps.html +++ b/papi-dts/types/_shared_models_web_view_model_.WebViewProps.html @@ -26,4 +26,4 @@

    ï¼ example

    const [lastPersonSeen, setLastPersonSeen] = useWebViewState('lastSeen', 'No one');
     
    -

    Generated using TypeDoc

    \ No newline at end of file +

    Generated using TypeDoc

    \ No newline at end of file diff --git a/papi-dts/types/_shared_models_web_view_model_.WebViewType.html b/papi-dts/types/_shared_models_web_view_model_.WebViewType.html index 12816b8eea..e6186a0c2e 100644 --- a/papi-dts/types/_shared_models_web_view_model_.WebViewType.html +++ b/papi-dts/types/_shared_models_web_view_model_.WebViewType.html @@ -1,2 +1,2 @@ WebViewType | papi-dts

    Generated using TypeDoc

    \ No newline at end of file +

    Generated using TypeDoc

    \ No newline at end of file diff --git a/papi-dts/types/_shared_services_command_service_.moduleSummaryComments.html b/papi-dts/types/_shared_services_command_service_.moduleSummaryComments.html index eb2e29cb07..6bfbf04995 100644 --- a/papi-dts/types/_shared_services_command_service_.moduleSummaryComments.html +++ b/papi-dts/types/_shared_services_command_service_.moduleSummaryComments.html @@ -1,4 +1,4 @@ moduleSummaryComments | papi-dts

    Generated using TypeDoc

    \ No newline at end of file +

    Type declaration

      Generated using TypeDoc

      \ No newline at end of file diff --git a/papi-dts/types/_shared_services_network_service_.ArgsRequestHandler.html b/papi-dts/types/_shared_services_network_service_.ArgsRequestHandler.html index 07879a9f97..8b7531976e 100644 --- a/papi-dts/types/_shared_services_network_service_.ArgsRequestHandler.html +++ b/papi-dts/types/_shared_services_network_service_.ArgsRequestHandler.html @@ -2,4 +2,4 @@ the spread of the contents array of the request as its parameters. The function should return an object that becomes the contents object of the response. This type of handler is a normal function.

      -

      Parameters

      • Rest ...args: TParam

      Returns Promise<TReturn> | TReturn

      Generated using TypeDoc

      \ No newline at end of file +

      Parameters

      • Rest ...args: TParam

      Returns Promise<TReturn> | TReturn

      Generated using TypeDoc

      \ No newline at end of file diff --git a/papi-dts/types/_shared_services_network_service_.ComplexRequestHandler.html b/papi-dts/types/_shared_services_network_service_.ComplexRequestHandler.html index 325452bdc1..df10305a0e 100644 --- a/papi-dts/types/_shared_services_network_service_.ComplexRequestHandler.html +++ b/papi-dts/types/_shared_services_network_service_.ComplexRequestHandler.html @@ -2,4 +2,4 @@ accept a ComplexRequest object as its single parameter. The function should return a ComplexResponse object that becomes the response.. This type of handler is the most flexible of the request handlers.

      -

      Parameters

      Returns Promise<ComplexResponse<TReturn>>

      Generated using TypeDoc

      \ No newline at end of file +

      Parameters

      Returns Promise<ComplexResponse<TReturn>>

      Generated using TypeDoc

      \ No newline at end of file diff --git a/papi-dts/types/_shared_services_network_service_.ContentsRequestHandler.html b/papi-dts/types/_shared_services_network_service_.ContentsRequestHandler.html index 660addca04..5cd442bbb4 100644 --- a/papi-dts/types/_shared_services_network_service_.ContentsRequestHandler.html +++ b/papi-dts/types/_shared_services_network_service_.ContentsRequestHandler.html @@ -1,4 +1,4 @@ ContentsRequestHandler | papi-dts

      Type alias ContentsRequestHandler<TParam, TReturn>

      ContentsRequestHandler<TParam, TReturn>: ((contents) => Promise<TReturn>)

      Type Parameters

      • TParam = any

      • TReturn = any

      Type declaration

        • (contents): Promise<TReturn>
        • Contents handler function for a request. Called when a request is handled. The function should accept the contents object of the request as its single parameter. The function should return an object that becomes the contents object of the response.

          -

          Parameters

          • contents: TParam

          Returns Promise<TReturn>

      Generated using TypeDoc

      \ No newline at end of file +

      Parameters

      • contents: TParam

      Returns Promise<TReturn>

      Generated using TypeDoc

      \ No newline at end of file diff --git a/papi-dts/types/_shared_utils_papi_util_.ComplexRequest.html b/papi-dts/types/_shared_utils_papi_util_.ComplexRequest.html index 582616ca92..118e089d7b 100644 --- a/papi-dts/types/_shared_utils_papi_util_.ComplexRequest.html +++ b/papi-dts/types/_shared_utils_papi_util_.ComplexRequest.html @@ -1,3 +1,3 @@ ComplexRequest | papi-dts

      Generated using TypeDoc

      \ No newline at end of file +

      Type Parameters

      • TParam = unknown

      Type declaration

      • contents: TParam

      Generated using TypeDoc

      \ No newline at end of file diff --git a/papi-dts/types/_shared_utils_papi_util_.ComplexResponse.html b/papi-dts/types/_shared_utils_papi_util_.ComplexResponse.html index 030aef223c..31f0ff55c2 100644 --- a/papi-dts/types/_shared_utils_papi_util_.ComplexResponse.html +++ b/papi-dts/types/_shared_utils_papi_util_.ComplexResponse.html @@ -1,4 +1,4 @@ ComplexResponse | papi-dts

      Generated using TypeDoc

      \ No newline at end of file +

      Type Parameters

      • TReturn = unknown

      Generated using TypeDoc

      \ No newline at end of file diff --git a/papi-dts/types/_shared_utils_papi_util_.ComplexResponseFailure.html b/papi-dts/types/_shared_utils_papi_util_.ComplexResponseFailure.html index 26a0d0b0fb..0ac3f0f9b1 100644 --- a/papi-dts/types/_shared_utils_papi_util_.ComplexResponseFailure.html +++ b/papi-dts/types/_shared_utils_papi_util_.ComplexResponseFailure.html @@ -1,3 +1,3 @@ ComplexResponseFailure | papi-dts

      Generated using TypeDoc

      \ No newline at end of file +

      Generated using TypeDoc

      \ No newline at end of file diff --git a/papi-dts/types/_shared_utils_papi_util_.ComplexResponseSuccess.html b/papi-dts/types/_shared_utils_papi_util_.ComplexResponseSuccess.html index 2a384427dc..4ca50ae213 100644 --- a/papi-dts/types/_shared_utils_papi_util_.ComplexResponseSuccess.html +++ b/papi-dts/types/_shared_utils_papi_util_.ComplexResponseSuccess.html @@ -1,4 +1,4 @@ ComplexResponseSuccess | papi-dts

      Generated using TypeDoc

      \ No newline at end of file +

      Generated using TypeDoc

      \ No newline at end of file diff --git a/papi-dts/types/_shared_utils_papi_util_.RequestType.html b/papi-dts/types/_shared_utils_papi_util_.RequestType.html index 9b7f4a9b95..e42a227bb8 100644 --- a/papi-dts/types/_shared_utils_papi_util_.RequestType.html +++ b/papi-dts/types/_shared_utils_papi_util_.RequestType.html @@ -1,4 +1,4 @@ RequestType | papi-dts

      Generated using TypeDoc

      \ No newline at end of file +

      Generated using TypeDoc

      \ No newline at end of file diff --git a/papi-dts/types/_shared_utils_papi_util_.SerializedRequestType.html b/papi-dts/types/_shared_utils_papi_util_.SerializedRequestType.html index 0c1056980f..e611836f58 100644 --- a/papi-dts/types/_shared_utils_papi_util_.SerializedRequestType.html +++ b/papi-dts/types/_shared_utils_papi_util_.SerializedRequestType.html @@ -1,3 +1,3 @@ SerializedRequestType | papi-dts

      Generated using TypeDoc

      \ No newline at end of file +

      Generated using TypeDoc

      \ No newline at end of file diff --git a/papi-dts/types/_shared_utils_papi_util_.Unsubscriber.html b/papi-dts/types/_shared_utils_papi_util_.Unsubscriber.html index 7b28173c8c..2b68c006da 100644 --- a/papi-dts/types/_shared_utils_papi_util_.Unsubscriber.html +++ b/papi-dts/types/_shared_utils_papi_util_.Unsubscriber.html @@ -1,2 +1,2 @@ Unsubscriber | papi-dts

      Generated using TypeDoc

      \ No newline at end of file +

      Returns boolean

      Generated using TypeDoc

      \ No newline at end of file diff --git a/papi-dts/types/_shared_utils_papi_util_.UnsubscriberAsync.html b/papi-dts/types/_shared_utils_papi_util_.UnsubscriberAsync.html index 7025c95fd1..3b0011cfbb 100644 --- a/papi-dts/types/_shared_utils_papi_util_.UnsubscriberAsync.html +++ b/papi-dts/types/_shared_utils_papi_util_.UnsubscriberAsync.html @@ -1,3 +1,3 @@ UnsubscriberAsync | papi-dts

      Generated using TypeDoc

      \ No newline at end of file +

      Returns Promise<boolean>

      Generated using TypeDoc

      \ No newline at end of file diff --git a/papi-dts/types/_shared_utils_papi_util_.moduleSummaryComments.html b/papi-dts/types/_shared_utils_papi_util_.moduleSummaryComments.html index ac42d4114e..bb66ba79d6 100644 --- a/papi-dts/types/_shared_utils_papi_util_.moduleSummaryComments.html +++ b/papi-dts/types/_shared_utils_papi_util_.moduleSummaryComments.html @@ -1,4 +1,4 @@ moduleSummaryComments | papi-dts

      Generated using TypeDoc

      \ No newline at end of file +

      Type declaration

        Generated using TypeDoc

        \ No newline at end of file diff --git a/papi-dts/variables/__papi_backend_.DataProviderEngine.html b/papi-dts/variables/__papi_backend_.DataProviderEngine.html index bc0d14a11e..ef5cce71fa 100644 --- a/papi-dts/variables/__papi_backend_.DataProviderEngine.html +++ b/papi-dts/variables/__papi_backend_.DataProviderEngine.html @@ -2,4 +2,4 @@ data provider engine class extends this class, it doesn't have to specify its own notifyUpdate function in order to use notifyUpdate.

        See

        IDataProviderEngine for more information on extending this class.

        -

        Generated using TypeDoc

        \ No newline at end of file +

        Generated using TypeDoc

        \ No newline at end of file diff --git a/papi-dts/variables/__papi_backend_.EventEmitter.html b/papi-dts/variables/__papi_backend_.EventEmitter.html index 13e2f43d46..e4057ebf7b 100644 --- a/papi-dts/variables/__papi_backend_.EventEmitter.html +++ b/papi-dts/variables/__papi_backend_.EventEmitter.html @@ -3,4 +3,4 @@ eventEmitter.emit(event) to run the subscriptions. Generally, this EventEmitter should be private, and its event should be public. That way, the emitter is not publicized, but anyone can subscribe to the event.

        -

        Generated using TypeDoc

        \ No newline at end of file +

        Generated using TypeDoc

        \ No newline at end of file diff --git a/papi-dts/variables/__papi_backend_.commands.html b/papi-dts/variables/__papi_backend_.commands.html index e651be77e3..dd7577b6be 100644 --- a/papi-dts/variables/__papi_backend_.commands.html +++ b/papi-dts/variables/__papi_backend_.commands.html @@ -1,4 +1,4 @@ commands | papi-dts

        Generated using TypeDoc

        \ No newline at end of file +

        Generated using TypeDoc

        \ No newline at end of file diff --git a/papi-dts/variables/__papi_backend_.dataProviders.html b/papi-dts/variables/__papi_backend_.dataProviders.html index c5a9f1f5be..7f05d9275a 100644 --- a/papi-dts/variables/__papi_backend_.dataProviders.html +++ b/papi-dts/variables/__papi_backend_.dataProviders.html @@ -1,2 +1,2 @@ dataProviders | papi-dts

        Generated using TypeDoc

        \ No newline at end of file +

        Generated using TypeDoc

        \ No newline at end of file diff --git a/papi-dts/variables/__papi_backend_.default.html b/papi-dts/variables/__papi_backend_.default.html index 3884d63fb3..fe1fd66276 100644 --- a/papi-dts/variables/__papi_backend_.default.html +++ b/papi-dts/variables/__papi_backend_.default.html @@ -28,4 +28,4 @@
      • webViews: WebViewServiceType

        Service exposing various functions related to using webViews

        WebViews are iframes in the Platform.Bible UI into which extensions load frontend code, either HTML or React components.

        -
      • Generated using TypeDoc

        \ No newline at end of file +

        Generated using TypeDoc

        \ No newline at end of file diff --git a/papi-dts/variables/__papi_backend_.dialogs.html b/papi-dts/variables/__papi_backend_.dialogs.html index f902be7997..70261347b5 100644 --- a/papi-dts/variables/__papi_backend_.dialogs.html +++ b/papi-dts/variables/__papi_backend_.dialogs.html @@ -1,2 +1,2 @@ dialogs | papi-dts

        Generated using TypeDoc

        \ No newline at end of file +

        Generated using TypeDoc

        \ No newline at end of file diff --git a/papi-dts/variables/__papi_backend_.internet.html b/papi-dts/variables/__papi_backend_.internet.html index 39c4f7f63c..bfa0bd61b1 100644 --- a/papi-dts/variables/__papi_backend_.internet.html +++ b/papi-dts/variables/__papi_backend_.internet.html @@ -1,2 +1,2 @@ internet | papi-dts

        Generated using TypeDoc

        \ No newline at end of file +

        Generated using TypeDoc

        \ No newline at end of file diff --git a/papi-dts/variables/__papi_backend_.logger.html b/papi-dts/variables/__papi_backend_.logger.html index b186b9ba01..2ef57812fa 100644 --- a/papi-dts/variables/__papi_backend_.logger.html +++ b/papi-dts/variables/__papi_backend_.logger.html @@ -1,2 +1,2 @@ logger | papi-dts

        Generated using TypeDoc

        \ No newline at end of file +

        Type declaration

        • default: MainLogger

        Generated using TypeDoc

        \ No newline at end of file diff --git a/papi-dts/variables/__papi_backend_.network.html b/papi-dts/variables/__papi_backend_.network.html index c8b3f97b66..bc2befeb5d 100644 --- a/papi-dts/variables/__papi_backend_.network.html +++ b/papi-dts/variables/__papi_backend_.network.html @@ -1,2 +1,2 @@ network | papi-dts

        Generated using TypeDoc

        \ No newline at end of file +

        Generated using TypeDoc

        \ No newline at end of file diff --git a/papi-dts/variables/__papi_backend_.projectDataProviders.html b/papi-dts/variables/__papi_backend_.projectDataProviders.html index dfd3708fb4..84a88e67ab 100644 --- a/papi-dts/variables/__papi_backend_.projectDataProviders.html +++ b/papi-dts/variables/__papi_backend_.projectDataProviders.html @@ -1,2 +1,2 @@ projectDataProviders | papi-dts

        Generated using TypeDoc

        \ No newline at end of file +

        Generated using TypeDoc

        \ No newline at end of file diff --git a/papi-dts/variables/__papi_backend_.projectLookup.html b/papi-dts/variables/__papi_backend_.projectLookup.html index a7693d27f0..8bd30bd202 100644 --- a/papi-dts/variables/__papi_backend_.projectLookup.html +++ b/papi-dts/variables/__papi_backend_.projectLookup.html @@ -1,2 +1,2 @@ projectLookup | papi-dts

        Generated using TypeDoc

        \ No newline at end of file +

        Generated using TypeDoc

        \ No newline at end of file diff --git a/papi-dts/variables/__papi_backend_.storage.html b/papi-dts/variables/__papi_backend_.storage.html index 99e1ba7eb7..85fb8a54e9 100644 --- a/papi-dts/variables/__papi_backend_.storage.html +++ b/papi-dts/variables/__papi_backend_.storage.html @@ -1,4 +1,4 @@ storage | papi-dts

        Generated using TypeDoc

        \ No newline at end of file +

        Generated using TypeDoc

        \ No newline at end of file diff --git a/papi-dts/variables/__papi_backend_.utils.html b/papi-dts/variables/__papi_backend_.utils.html index f9b6183588..e4753b4e88 100644 --- a/papi-dts/variables/__papi_backend_.utils.html +++ b/papi-dts/variables/__papi_backend_.utils.html @@ -1,4 +1,4 @@ utils | papi-dts

        Generated using TypeDoc

        \ No newline at end of file +

        Generated using TypeDoc

        \ No newline at end of file diff --git a/papi-dts/variables/__papi_backend_.webViewProviders.html b/papi-dts/variables/__papi_backend_.webViewProviders.html index 6e16566808..5eb8e483f4 100644 --- a/papi-dts/variables/__papi_backend_.webViewProviders.html +++ b/papi-dts/variables/__papi_backend_.webViewProviders.html @@ -1,2 +1,2 @@ webViewProviders | papi-dts

        Generated using TypeDoc

        \ No newline at end of file +

        Generated using TypeDoc

        \ No newline at end of file diff --git a/papi-dts/variables/__papi_backend_.webViews.html b/papi-dts/variables/__papi_backend_.webViews.html index b842e305d6..35560ea611 100644 --- a/papi-dts/variables/__papi_backend_.webViews.html +++ b/papi-dts/variables/__papi_backend_.webViews.html @@ -1,4 +1,4 @@ webViews | papi-dts

        Generated using TypeDoc

        \ No newline at end of file +

        Generated using TypeDoc

        \ No newline at end of file diff --git a/papi-dts/variables/__papi_core_.default.html b/papi-dts/variables/__papi_core_.default.html index 6c0bab7a43..192f3b15ab 100644 --- a/papi-dts/variables/__papi_core_.default.html +++ b/papi-dts/variables/__papi_core_.default.html @@ -1,2 +1,2 @@ default | papi-dts

        Generated using TypeDoc

        \ No newline at end of file +

        Type declaration

          Generated using TypeDoc

          \ No newline at end of file diff --git a/papi-dts/variables/__papi_frontend_.EventEmitter.html b/papi-dts/variables/__papi_frontend_.EventEmitter.html index 55ff649442..045c81dcf8 100644 --- a/papi-dts/variables/__papi_frontend_.EventEmitter.html +++ b/papi-dts/variables/__papi_frontend_.EventEmitter.html @@ -3,4 +3,4 @@ eventEmitter.emit(event) to run the subscriptions. Generally, this EventEmitter should be private, and its event should be public. That way, the emitter is not publicized, but anyone can subscribe to the event.

          -

          Generated using TypeDoc

          \ No newline at end of file +

          Generated using TypeDoc

          \ No newline at end of file diff --git a/papi-dts/variables/__papi_frontend_.WebSocket.html b/papi-dts/variables/__papi_frontend_.WebSocket.html index 4f417fff31..c2787fb273 100644 --- a/papi-dts/variables/__papi_frontend_.WebSocket.html +++ b/papi-dts/variables/__papi_frontend_.WebSocket.html @@ -2,4 +2,4 @@ better control over internet access. It is isomorphic with the standard WebSocket, so it should act as a drop-in replacement.

          Note that the Node WebSocket implementation is different and not wrapped here.

          -

          Generated using TypeDoc

          \ No newline at end of file +

          Generated using TypeDoc

          \ No newline at end of file diff --git a/papi-dts/variables/__papi_frontend_.XMLHttpRequest.html b/papi-dts/variables/__papi_frontend_.XMLHttpRequest.html index e7fde698ee..a6268d674f 100644 --- a/papi-dts/variables/__papi_frontend_.XMLHttpRequest.html +++ b/papi-dts/variables/__papi_frontend_.XMLHttpRequest.html @@ -2,4 +2,4 @@ provide better control over internet access. It is isomorphic with the standard XMLHttpRequest, so it should act as a drop-in replacement.

          Note that Node doesn't have a native implementation, so this is only for the renderer.

          -

          Generated using TypeDoc

          \ No newline at end of file +

          Generated using TypeDoc

          \ No newline at end of file diff --git a/papi-dts/variables/__papi_frontend_.commands.html b/papi-dts/variables/__papi_frontend_.commands.html index 3e0a941a22..1cfebdb8ef 100644 --- a/papi-dts/variables/__papi_frontend_.commands.html +++ b/papi-dts/variables/__papi_frontend_.commands.html @@ -1,4 +1,4 @@ commands | papi-dts

          Generated using TypeDoc

          \ No newline at end of file +

          Generated using TypeDoc

          \ No newline at end of file diff --git a/papi-dts/variables/__papi_frontend_.dataProviders.html b/papi-dts/variables/__papi_frontend_.dataProviders.html index 6ff398f322..89e9b19925 100644 --- a/papi-dts/variables/__papi_frontend_.dataProviders.html +++ b/papi-dts/variables/__papi_frontend_.dataProviders.html @@ -1,2 +1,2 @@ dataProviders | papi-dts

          Generated using TypeDoc

          \ No newline at end of file +

          Generated using TypeDoc

          \ No newline at end of file diff --git a/papi-dts/variables/__papi_frontend_.default.html b/papi-dts/variables/__papi_frontend_.default.html index ec5e896576..20f15f7466 100644 --- a/papi-dts/variables/__papi_frontend_.default.html +++ b/papi-dts/variables/__papi_frontend_.default.html @@ -30,4 +30,4 @@
        • webViews: WebViewServiceType

          Service exposing various functions related to using webViews

          WebViews are iframes in the Platform.Bible UI into which extensions load frontend code, either HTML or React components.

          -
        • Generated using TypeDoc

          \ No newline at end of file +

          Generated using TypeDoc

          \ No newline at end of file diff --git a/papi-dts/variables/__papi_frontend_.dialogs.html b/papi-dts/variables/__papi_frontend_.dialogs.html index 882842f167..5c97f6bd39 100644 --- a/papi-dts/variables/__papi_frontend_.dialogs.html +++ b/papi-dts/variables/__papi_frontend_.dialogs.html @@ -1,2 +1,2 @@ dialogs | papi-dts

          Generated using TypeDoc

          \ No newline at end of file +

          Generated using TypeDoc

          \ No newline at end of file diff --git a/papi-dts/variables/__papi_frontend_.internet.html b/papi-dts/variables/__papi_frontend_.internet.html index 05d24b99ee..d2b91b6802 100644 --- a/papi-dts/variables/__papi_frontend_.internet.html +++ b/papi-dts/variables/__papi_frontend_.internet.html @@ -1,2 +1,2 @@ internet | papi-dts

          Generated using TypeDoc

          \ No newline at end of file +

          Generated using TypeDoc

          \ No newline at end of file diff --git a/papi-dts/variables/__papi_frontend_.logger.html b/papi-dts/variables/__papi_frontend_.logger.html index 6eb32d8832..f79508898f 100644 --- a/papi-dts/variables/__papi_frontend_.logger.html +++ b/papi-dts/variables/__papi_frontend_.logger.html @@ -1,2 +1,2 @@ logger | papi-dts

          Generated using TypeDoc

          \ No newline at end of file +

          Type declaration

          • default: MainLogger

          Generated using TypeDoc

          \ No newline at end of file diff --git a/papi-dts/variables/__papi_frontend_.network.html b/papi-dts/variables/__papi_frontend_.network.html index f613a392cb..acf9294a5d 100644 --- a/papi-dts/variables/__papi_frontend_.network.html +++ b/papi-dts/variables/__papi_frontend_.network.html @@ -1,2 +1,2 @@ network | papi-dts

          Generated using TypeDoc

          \ No newline at end of file +

          Generated using TypeDoc

          \ No newline at end of file diff --git a/papi-dts/variables/__papi_frontend_.projectDataProviders.html b/papi-dts/variables/__papi_frontend_.projectDataProviders.html index 91951ceb2e..ad04761412 100644 --- a/papi-dts/variables/__papi_frontend_.projectDataProviders.html +++ b/papi-dts/variables/__papi_frontend_.projectDataProviders.html @@ -1,2 +1,2 @@ projectDataProviders | papi-dts

          Generated using TypeDoc

          \ No newline at end of file +

          Generated using TypeDoc

          \ No newline at end of file diff --git a/papi-dts/variables/__papi_frontend_.projectLookup.html b/papi-dts/variables/__papi_frontend_.projectLookup.html index c5157c45df..ce1b8d7207 100644 --- a/papi-dts/variables/__papi_frontend_.projectLookup.html +++ b/papi-dts/variables/__papi_frontend_.projectLookup.html @@ -1,2 +1,2 @@ projectLookup | papi-dts

          Generated using TypeDoc

          \ No newline at end of file +

          Generated using TypeDoc

          \ No newline at end of file diff --git a/papi-dts/variables/__papi_frontend_.react.html b/papi-dts/variables/__papi_frontend_.react.html index 639603ee68..4145772e6a 100644 --- a/papi-dts/variables/__papi_frontend_.react.html +++ b/papi-dts/variables/__papi_frontend_.react.html @@ -1,2 +1,2 @@ react | papi-dts

          Generated using TypeDoc

          \ No newline at end of file +

          Generated using TypeDoc

          \ No newline at end of file diff --git a/papi-dts/variables/__papi_frontend_.settings.html b/papi-dts/variables/__papi_frontend_.settings.html index 70f0a316d3..24f9dcf849 100644 --- a/papi-dts/variables/__papi_frontend_.settings.html +++ b/papi-dts/variables/__papi_frontend_.settings.html @@ -1,2 +1,2 @@ settings | papi-dts

          Generated using TypeDoc

          \ No newline at end of file +

          Generated using TypeDoc

          \ No newline at end of file diff --git a/papi-dts/variables/__papi_frontend_.utils.html b/papi-dts/variables/__papi_frontend_.utils.html index 49bedd9d24..003a59d9cf 100644 --- a/papi-dts/variables/__papi_frontend_.utils.html +++ b/papi-dts/variables/__papi_frontend_.utils.html @@ -1,4 +1,4 @@ utils | papi-dts

          Generated using TypeDoc

          \ No newline at end of file +

          Generated using TypeDoc

          \ No newline at end of file diff --git a/papi-dts/variables/__papi_frontend_.webViews.html b/papi-dts/variables/__papi_frontend_.webViews.html index 79959bb2d5..d4a8df6cc5 100644 --- a/papi-dts/variables/__papi_frontend_.webViews.html +++ b/papi-dts/variables/__papi_frontend_.webViews.html @@ -1,4 +1,4 @@ webViews | papi-dts

          Generated using TypeDoc

          \ No newline at end of file +

          Generated using TypeDoc

          \ No newline at end of file diff --git a/papi-dts/variables/_extension_host_services_extension_storage_service_.default.html b/papi-dts/variables/_extension_host_services_extension_storage_service_.default.html index b094cf09b3..8279f75ca5 100644 --- a/papi-dts/variables/_extension_host_services_extension_storage_service_.default.html +++ b/papi-dts/variables/_extension_host_services_extension_storage_service_.default.html @@ -1,4 +1,4 @@ default | papi-dts

          Generated using TypeDoc

          \ No newline at end of file +

          Generated using TypeDoc

          \ No newline at end of file diff --git a/papi-dts/variables/_node_services_execution_token_service_.default.html b/papi-dts/variables/_node_services_execution_token_service_.default.html index 28ea954156..6301c95c49 100644 --- a/papi-dts/variables/_node_services_execution_token_service_.default.html +++ b/papi-dts/variables/_node_services_execution_token_service_.default.html @@ -1 +1 @@ -default | papi-dts

          Generated using TypeDoc

          \ No newline at end of file +default | papi-dts

          Generated using TypeDoc

          \ No newline at end of file diff --git a/papi-dts/variables/_node_utils_util_.FILE_PROTOCOL.html b/papi-dts/variables/_node_utils_util_.FILE_PROTOCOL.html index 6871d854b0..2b57cc2d10 100644 --- a/papi-dts/variables/_node_utils_util_.FILE_PROTOCOL.html +++ b/papi-dts/variables/_node_utils_util_.FILE_PROTOCOL.html @@ -1 +1 @@ -FILE_PROTOCOL | papi-dts

          Generated using TypeDoc

          \ No newline at end of file +FILE_PROTOCOL | papi-dts

          Generated using TypeDoc

          \ No newline at end of file diff --git a/papi-dts/variables/_node_utils_util_.RESOURCES_PROTOCOL.html b/papi-dts/variables/_node_utils_util_.RESOURCES_PROTOCOL.html index d6c8c0d886..0f2ebae5c9 100644 --- a/papi-dts/variables/_node_utils_util_.RESOURCES_PROTOCOL.html +++ b/papi-dts/variables/_node_utils_util_.RESOURCES_PROTOCOL.html @@ -1 +1 @@ -RESOURCES_PROTOCOL | papi-dts

          Generated using TypeDoc

          \ No newline at end of file +RESOURCES_PROTOCOL | papi-dts

          Generated using TypeDoc

          \ No newline at end of file diff --git a/papi-dts/variables/_renderer_components_dialogs_dialog_base_data_.default.html b/papi-dts/variables/_renderer_components_dialogs_dialog_base_data_.default.html index d240a27470..9fd144c1d2 100644 --- a/papi-dts/variables/_renderer_components_dialogs_dialog_base_data_.default.html +++ b/papi-dts/variables/_renderer_components_dialogs_dialog_base_data_.default.html @@ -5,4 +5,4 @@ we would not be able to use the default loadDialog because it would be using a static reference to a nonexistent Component. Instead of inheriting this as a class, any dialog definition can spread this { ...DIALOG_BASE }

          -

          Generated using TypeDoc

          \ No newline at end of file +

          Generated using TypeDoc

          \ No newline at end of file diff --git a/papi-dts/variables/_renderer_components_dialogs_dialog_definition_model_.SELECT_MULTIPLE_PROJECTS_DIALOG_TYPE.html b/papi-dts/variables/_renderer_components_dialogs_dialog_definition_model_.SELECT_MULTIPLE_PROJECTS_DIALOG_TYPE.html index 3b92917334..1b79ef06e2 100644 --- a/papi-dts/variables/_renderer_components_dialogs_dialog_definition_model_.SELECT_MULTIPLE_PROJECTS_DIALOG_TYPE.html +++ b/papi-dts/variables/_renderer_components_dialogs_dialog_definition_model_.SELECT_MULTIPLE_PROJECTS_DIALOG_TYPE.html @@ -1,2 +1,2 @@ SELECT_MULTIPLE_PROJECTS_DIALOG_TYPE | papi-dts

          Generated using TypeDoc

          \ No newline at end of file +

          Generated using TypeDoc

          \ No newline at end of file diff --git a/papi-dts/variables/_renderer_components_dialogs_dialog_definition_model_.SELECT_PROJECT_DIALOG_TYPE.html b/papi-dts/variables/_renderer_components_dialogs_dialog_definition_model_.SELECT_PROJECT_DIALOG_TYPE.html index f5f50b97da..dcb4942dcd 100644 --- a/papi-dts/variables/_renderer_components_dialogs_dialog_definition_model_.SELECT_PROJECT_DIALOG_TYPE.html +++ b/papi-dts/variables/_renderer_components_dialogs_dialog_definition_model_.SELECT_PROJECT_DIALOG_TYPE.html @@ -1,2 +1,2 @@ SELECT_PROJECT_DIALOG_TYPE | papi-dts

          Generated using TypeDoc

          \ No newline at end of file +

          Generated using TypeDoc

          \ No newline at end of file diff --git a/papi-dts/variables/_shared_data_internal_connection_model_.CATEGORY_COMMAND.html b/papi-dts/variables/_shared_data_internal_connection_model_.CATEGORY_COMMAND.html index 9824573afe..34c0301694 100644 --- a/papi-dts/variables/_shared_data_internal_connection_model_.CATEGORY_COMMAND.html +++ b/papi-dts/variables/_shared_data_internal_connection_model_.CATEGORY_COMMAND.html @@ -1,2 +1,2 @@ CATEGORY_COMMAND | papi-dts

          Generated using TypeDoc

          \ No newline at end of file +

          Generated using TypeDoc

          \ No newline at end of file diff --git a/papi-dts/variables/_shared_data_internal_connection_model_.CLIENT_ID_SERVER.html b/papi-dts/variables/_shared_data_internal_connection_model_.CLIENT_ID_SERVER.html index 3e8b11febc..865ce48354 100644 --- a/papi-dts/variables/_shared_data_internal_connection_model_.CLIENT_ID_SERVER.html +++ b/papi-dts/variables/_shared_data_internal_connection_model_.CLIENT_ID_SERVER.html @@ -1,2 +1,2 @@ CLIENT_ID_SERVER | papi-dts

          Generated using TypeDoc

          \ No newline at end of file +

          Generated using TypeDoc

          \ No newline at end of file diff --git a/papi-dts/variables/_shared_data_internal_connection_model_.CLIENT_ID_UNASSIGNED.html b/papi-dts/variables/_shared_data_internal_connection_model_.CLIENT_ID_UNASSIGNED.html index e1e3e8d20c..5463562604 100644 --- a/papi-dts/variables/_shared_data_internal_connection_model_.CLIENT_ID_UNASSIGNED.html +++ b/papi-dts/variables/_shared_data_internal_connection_model_.CLIENT_ID_UNASSIGNED.html @@ -1,2 +1,2 @@ CLIENT_ID_UNASSIGNED | papi-dts

          Generated using TypeDoc

          \ No newline at end of file +

          Generated using TypeDoc

          \ No newline at end of file diff --git a/papi-dts/variables/_shared_data_internal_connection_model_.CONNECTOR_INFO_DISCONNECTED.html b/papi-dts/variables/_shared_data_internal_connection_model_.CONNECTOR_INFO_DISCONNECTED.html index 551ae928e9..9c38c74f94 100644 --- a/papi-dts/variables/_shared_data_internal_connection_model_.CONNECTOR_INFO_DISCONNECTED.html +++ b/papi-dts/variables/_shared_data_internal_connection_model_.CONNECTOR_INFO_DISCONNECTED.html @@ -1,2 +1,2 @@ CONNECTOR_INFO_DISCONNECTED | papi-dts

          Generated using TypeDoc

          \ No newline at end of file +

          Type declaration

          • clientId: -1

          Generated using TypeDoc

          \ No newline at end of file diff --git a/papi-dts/variables/_shared_data_network_connector_model_.WEBSOCKET_ATTEMPTS_MAX.html b/papi-dts/variables/_shared_data_network_connector_model_.WEBSOCKET_ATTEMPTS_MAX.html index b37e9fe73b..504e17fbf7 100644 --- a/papi-dts/variables/_shared_data_network_connector_model_.WEBSOCKET_ATTEMPTS_MAX.html +++ b/papi-dts/variables/_shared_data_network_connector_model_.WEBSOCKET_ATTEMPTS_MAX.html @@ -1,2 +1,2 @@ WEBSOCKET_ATTEMPTS_MAX | papi-dts

          Generated using TypeDoc

          \ No newline at end of file +

          Generated using TypeDoc

          \ No newline at end of file diff --git a/papi-dts/variables/_shared_data_network_connector_model_.WEBSOCKET_ATTEMPTS_WAIT.html b/papi-dts/variables/_shared_data_network_connector_model_.WEBSOCKET_ATTEMPTS_WAIT.html index 5f4ca9ab65..d35a699705 100644 --- a/papi-dts/variables/_shared_data_network_connector_model_.WEBSOCKET_ATTEMPTS_WAIT.html +++ b/papi-dts/variables/_shared_data_network_connector_model_.WEBSOCKET_ATTEMPTS_WAIT.html @@ -1,3 +1,3 @@ WEBSOCKET_ATTEMPTS_WAIT | papi-dts

          Generated using TypeDoc

          \ No newline at end of file +

          Generated using TypeDoc

          \ No newline at end of file diff --git a/papi-dts/variables/_shared_data_network_connector_model_.WEBSOCKET_PORT.html b/papi-dts/variables/_shared_data_network_connector_model_.WEBSOCKET_PORT.html index c15a3b47fd..3ec166b52d 100644 --- a/papi-dts/variables/_shared_data_network_connector_model_.WEBSOCKET_PORT.html +++ b/papi-dts/variables/_shared_data_network_connector_model_.WEBSOCKET_PORT.html @@ -1,2 +1,2 @@ WEBSOCKET_PORT | papi-dts

          Generated using TypeDoc

          \ No newline at end of file +

          Generated using TypeDoc

          \ No newline at end of file diff --git a/papi-dts/variables/_shared_services_data_provider_service_.default.html b/papi-dts/variables/_shared_services_data_provider_service_.default.html index 986e9bb46d..a266fc6713 100644 --- a/papi-dts/variables/_shared_services_data_provider_service_.default.html +++ b/papi-dts/variables/_shared_services_data_provider_service_.default.html @@ -1,2 +1,2 @@ default | papi-dts

          Generated using TypeDoc

          \ No newline at end of file +

          Generated using TypeDoc

          \ No newline at end of file diff --git a/papi-dts/variables/_shared_services_dialog_service_.default.html b/papi-dts/variables/_shared_services_dialog_service_.default.html index 26d32a7939..80bdd60c3c 100644 --- a/papi-dts/variables/_shared_services_dialog_service_.default.html +++ b/papi-dts/variables/_shared_services_dialog_service_.default.html @@ -1 +1 @@ -default | papi-dts

          Generated using TypeDoc

          \ No newline at end of file +default | papi-dts

          Generated using TypeDoc

          \ No newline at end of file diff --git a/papi-dts/variables/_shared_services_dialog_service_model_.CATEGORY_DIALOG.html b/papi-dts/variables/_shared_services_dialog_service_model_.CATEGORY_DIALOG.html index 7e9f79d808..e445a66d5d 100644 --- a/papi-dts/variables/_shared_services_dialog_service_model_.CATEGORY_DIALOG.html +++ b/papi-dts/variables/_shared_services_dialog_service_model_.CATEGORY_DIALOG.html @@ -1,2 +1,2 @@ CATEGORY_DIALOG | papi-dts

          Generated using TypeDoc

          \ No newline at end of file +

          Generated using TypeDoc

          \ No newline at end of file diff --git a/papi-dts/variables/_shared_services_internet_service_.default.html b/papi-dts/variables/_shared_services_internet_service_.default.html index 3dbbf046ab..7704d76eef 100644 --- a/papi-dts/variables/_shared_services_internet_service_.default.html +++ b/papi-dts/variables/_shared_services_internet_service_.default.html @@ -1,2 +1,2 @@ default | papi-dts

          Generated using TypeDoc

          \ No newline at end of file +

          Generated using TypeDoc

          \ No newline at end of file diff --git a/papi-dts/variables/_shared_services_logger_service_.WARN_TAG.html b/papi-dts/variables/_shared_services_logger_service_.WARN_TAG.html index 9f4e2954af..1dfb5417b3 100644 --- a/papi-dts/variables/_shared_services_logger_service_.WARN_TAG.html +++ b/papi-dts/variables/_shared_services_logger_service_.WARN_TAG.html @@ -1 +1 @@ -WARN_TAG | papi-dts

          Generated using TypeDoc

          \ No newline at end of file +WARN_TAG | papi-dts

          Generated using TypeDoc

          \ No newline at end of file diff --git a/papi-dts/variables/_shared_services_logger_service_.default.html b/papi-dts/variables/_shared_services_logger_service_.default.html index 3ef05633da..027b3df387 100644 --- a/papi-dts/variables/_shared_services_logger_service_.default.html +++ b/papi-dts/variables/_shared_services_logger_service_.default.html @@ -1,2 +1,2 @@ default | papi-dts

          Generated using TypeDoc

          \ No newline at end of file +

          Type declaration

          • default: log.MainLogger

          Generated using TypeDoc

          \ No newline at end of file diff --git a/papi-dts/variables/_shared_services_network_object_service_.default.html b/papi-dts/variables/_shared_services_network_object_service_.default.html index 231a021d35..fc0b491317 100644 --- a/papi-dts/variables/_shared_services_network_object_service_.default.html +++ b/papi-dts/variables/_shared_services_network_object_service_.default.html @@ -18,4 +18,4 @@

          When an object is disposed by calling dispose, all functions registered with the onDidDispose event handler will be called. After an object is disposed, calls to its functions will no longer be proxied to the original object.

          -

          Generated using TypeDoc

          \ No newline at end of file +

          Generated using TypeDoc

          \ No newline at end of file diff --git a/papi-dts/variables/_shared_services_network_object_status_service_.default.html b/papi-dts/variables/_shared_services_network_object_status_service_.default.html index e47453de15..6261b1210d 100644 --- a/papi-dts/variables/_shared_services_network_object_status_service_.default.html +++ b/papi-dts/variables/_shared_services_network_object_status_service_.default.html @@ -1 +1 @@ -default | papi-dts

          Generated using TypeDoc

          \ No newline at end of file +default | papi-dts

          Generated using TypeDoc

          \ No newline at end of file diff --git a/papi-dts/variables/_shared_services_network_object_status_service_model_.networkObjectStatusServiceNetworkObjectName.html b/papi-dts/variables/_shared_services_network_object_status_service_model_.networkObjectStatusServiceNetworkObjectName.html index 574304f83f..194eb26ab3 100644 --- a/papi-dts/variables/_shared_services_network_object_status_service_model_.networkObjectStatusServiceNetworkObjectName.html +++ b/papi-dts/variables/_shared_services_network_object_status_service_model_.networkObjectStatusServiceNetworkObjectName.html @@ -1 +1 @@ -networkObjectStatusServiceNetworkObjectName | papi-dts

          Generated using TypeDoc

          \ No newline at end of file +networkObjectStatusServiceNetworkObjectName | papi-dts

          Generated using TypeDoc

          \ No newline at end of file diff --git a/papi-dts/variables/_shared_services_network_service_.papiNetworkService-1.html b/papi-dts/variables/_shared_services_network_service_.papiNetworkService-1.html index 5dfeee1513..5c2dc2b925 100644 --- a/papi-dts/variables/_shared_services_network_service_.papiNetworkService-1.html +++ b/papi-dts/variables/_shared_services_network_service_.papiNetworkService-1.html @@ -1,2 +1,2 @@ papiNetworkService | papi-dts

          Generated using TypeDoc

          \ No newline at end of file +

          Generated using TypeDoc

          \ No newline at end of file diff --git a/papi-dts/variables/_shared_services_project_data_provider_service_.papiBackendProjectDataProviderService-1.html b/papi-dts/variables/_shared_services_project_data_provider_service_.papiBackendProjectDataProviderService-1.html index 9eba3713d1..36e36a94c8 100644 --- a/papi-dts/variables/_shared_services_project_data_provider_service_.papiBackendProjectDataProviderService-1.html +++ b/papi-dts/variables/_shared_services_project_data_provider_service_.papiBackendProjectDataProviderService-1.html @@ -1,2 +1,2 @@ papiBackendProjectDataProviderService | papi-dts

          Generated using TypeDoc

          \ No newline at end of file +

          Generated using TypeDoc

          \ No newline at end of file diff --git a/papi-dts/variables/_shared_services_project_data_provider_service_.papiFrontendProjectDataProviderService-1.html b/papi-dts/variables/_shared_services_project_data_provider_service_.papiFrontendProjectDataProviderService-1.html index 0459f16485..70c0e0794b 100644 --- a/papi-dts/variables/_shared_services_project_data_provider_service_.papiFrontendProjectDataProviderService-1.html +++ b/papi-dts/variables/_shared_services_project_data_provider_service_.papiFrontendProjectDataProviderService-1.html @@ -1,2 +1,2 @@ papiFrontendProjectDataProviderService | papi-dts

          Generated using TypeDoc

          \ No newline at end of file +

          Type declaration

          • get: typeof get

          Generated using TypeDoc

          \ No newline at end of file diff --git a/papi-dts/variables/_shared_services_project_lookup_service_.default.html b/papi-dts/variables/_shared_services_project_lookup_service_.default.html index c92a5c21e0..42b2b64e7a 100644 --- a/papi-dts/variables/_shared_services_project_lookup_service_.default.html +++ b/papi-dts/variables/_shared_services_project_lookup_service_.default.html @@ -1 +1 @@ -default | papi-dts

          Generated using TypeDoc

          \ No newline at end of file +default | papi-dts

          Generated using TypeDoc

          \ No newline at end of file diff --git a/papi-dts/variables/_shared_services_project_lookup_service_model_.projectLookupServiceNetworkObjectName.html b/papi-dts/variables/_shared_services_project_lookup_service_model_.projectLookupServiceNetworkObjectName.html index c771401e2a..0a7e1ffc2c 100644 --- a/papi-dts/variables/_shared_services_project_lookup_service_model_.projectLookupServiceNetworkObjectName.html +++ b/papi-dts/variables/_shared_services_project_lookup_service_model_.projectLookupServiceNetworkObjectName.html @@ -1 +1 @@ -projectLookupServiceNetworkObjectName | papi-dts

          Generated using TypeDoc

          \ No newline at end of file +projectLookupServiceNetworkObjectName | papi-dts

          Generated using TypeDoc

          \ No newline at end of file diff --git a/papi-dts/variables/_shared_services_settings_service_.default.html b/papi-dts/variables/_shared_services_settings_service_.default.html index 9eec1bb6e5..dd2747107f 100644 --- a/papi-dts/variables/_shared_services_settings_service_.default.html +++ b/papi-dts/variables/_shared_services_settings_service_.default.html @@ -1,2 +1,2 @@ default | papi-dts

          Generated using TypeDoc

          \ No newline at end of file +

          Generated using TypeDoc

          \ No newline at end of file diff --git a/papi-dts/variables/_shared_services_web_view_provider_service_.default.html b/papi-dts/variables/_shared_services_web_view_provider_service_.default.html index 47be02ec60..61d0202437 100644 --- a/papi-dts/variables/_shared_services_web_view_provider_service_.default.html +++ b/papi-dts/variables/_shared_services_web_view_provider_service_.default.html @@ -1 +1 @@ -default | papi-dts

          Generated using TypeDoc

          \ No newline at end of file +default | papi-dts

          Generated using TypeDoc

          \ No newline at end of file diff --git a/papi-dts/variables/_shared_services_web_view_provider_service_.papiWebViewProviderService-1.html b/papi-dts/variables/_shared_services_web_view_provider_service_.papiWebViewProviderService-1.html index 7ba19a31fc..f6c32a803a 100644 --- a/papi-dts/variables/_shared_services_web_view_provider_service_.papiWebViewProviderService-1.html +++ b/papi-dts/variables/_shared_services_web_view_provider_service_.papiWebViewProviderService-1.html @@ -1,2 +1,2 @@ papiWebViewProviderService | papi-dts

          Generated using TypeDoc

          \ No newline at end of file +

          Generated using TypeDoc

          \ No newline at end of file diff --git a/papi-dts/variables/_shared_services_web_view_service_.default.html b/papi-dts/variables/_shared_services_web_view_service_.default.html index 0e5c119b4b..60adab2483 100644 --- a/papi-dts/variables/_shared_services_web_view_service_.default.html +++ b/papi-dts/variables/_shared_services_web_view_service_.default.html @@ -1 +1 @@ -default | papi-dts

          Generated using TypeDoc

          \ No newline at end of file +default | papi-dts

          Generated using TypeDoc

          \ No newline at end of file diff --git a/papi-dts/variables/_shared_services_web_view_service_model_.EVENT_NAME_ON_DID_ADD_WEB_VIEW.html b/papi-dts/variables/_shared_services_web_view_service_model_.EVENT_NAME_ON_DID_ADD_WEB_VIEW.html index 0be34f4e1e..4294dd6211 100644 --- a/papi-dts/variables/_shared_services_web_view_service_model_.EVENT_NAME_ON_DID_ADD_WEB_VIEW.html +++ b/papi-dts/variables/_shared_services_web_view_service_model_.EVENT_NAME_ON_DID_ADD_WEB_VIEW.html @@ -1,2 +1,2 @@ EVENT_NAME_ON_DID_ADD_WEB_VIEW | papi-dts

          Generated using TypeDoc

          \ No newline at end of file +

          Generated using TypeDoc

          \ No newline at end of file diff --git a/papi-dts/variables/_shared_services_web_view_service_model_.NETWORK_OBJECT_NAME_WEB_VIEW_SERVICE.html b/papi-dts/variables/_shared_services_web_view_service_model_.NETWORK_OBJECT_NAME_WEB_VIEW_SERVICE.html index 702e15810c..da032dcc62 100644 --- a/papi-dts/variables/_shared_services_web_view_service_model_.NETWORK_OBJECT_NAME_WEB_VIEW_SERVICE.html +++ b/papi-dts/variables/_shared_services_web_view_service_model_.NETWORK_OBJECT_NAME_WEB_VIEW_SERVICE.html @@ -1 +1 @@ -NETWORK_OBJECT_NAME_WEB_VIEW_SERVICE | papi-dts

          Generated using TypeDoc

          \ No newline at end of file +NETWORK_OBJECT_NAME_WEB_VIEW_SERVICE | papi-dts

          Generated using TypeDoc

          \ No newline at end of file diff --git a/papi-dts/variables/_shared_utils_papi_util_.MODULE_SIMILAR_APIS.html b/papi-dts/variables/_shared_utils_papi_util_.MODULE_SIMILAR_APIS.html index 81060b570b..2dafe14578 100644 --- a/papi-dts/variables/_shared_utils_papi_util_.MODULE_SIMILAR_APIS.html +++ b/papi-dts/variables/_shared_utils_papi_util_.MODULE_SIMILAR_APIS.html @@ -1,3 +1,3 @@ MODULE_SIMILAR_APIS | papi-dts

          Variable MODULE_SIMILAR_APISConst

          MODULE_SIMILAR_APIS: Readonly<{
              [moduleName: string]: string | {
                  [process in ProcessType | "default"]?: string
              } | undefined;
          }>

          Modules that someone might try to require in their extensions that we have similar apis for. When an extension requires these modules, an error throws that lets them know about our similar api.

          -

          Type declaration

          • [moduleName: string]: string | {
                [process in ProcessType | "default"]?: string
            } | undefined

          Generated using TypeDoc

          \ No newline at end of file +

          Type declaration

          • [moduleName: string]: string | {
                [process in ProcessType | "default"]?: string
            } | undefined

          Generated using TypeDoc

          \ No newline at end of file diff --git a/papi-dts/variables/_shared_utils_papi_util_.REQUEST_TYPE_SEPARATOR.html b/papi-dts/variables/_shared_utils_papi_util_.REQUEST_TYPE_SEPARATOR.html index d2cea3f54a..46cb7af88c 100644 --- a/papi-dts/variables/_shared_utils_papi_util_.REQUEST_TYPE_SEPARATOR.html +++ b/papi-dts/variables/_shared_utils_papi_util_.REQUEST_TYPE_SEPARATOR.html @@ -1,2 +1,2 @@ REQUEST_TYPE_SEPARATOR | papi-dts

          Generated using TypeDoc

          \ No newline at end of file +

          Generated using TypeDoc

          \ No newline at end of file diff --git a/papi-dts/variables/isPackaged.html b/papi-dts/variables/isPackaged.html index 0214991005..73f016d19b 100644 --- a/papi-dts/variables/isPackaged.html +++ b/papi-dts/variables/isPackaged.html @@ -1,2 +1,2 @@ isPackaged | papi-dts

          Generated using TypeDoc

          \ No newline at end of file +

          Generated using TypeDoc

          \ No newline at end of file diff --git a/papi-dts/variables/logLevel.html b/papi-dts/variables/logLevel.html index f229a1f453..ffc4130664 100644 --- a/papi-dts/variables/logLevel.html +++ b/papi-dts/variables/logLevel.html @@ -1,2 +1,2 @@ logLevel | papi-dts

          Generated using TypeDoc

          \ No newline at end of file +

          Generated using TypeDoc

          \ No newline at end of file diff --git a/papi-dts/variables/processType.html b/papi-dts/variables/processType.html index 26f90d9725..003469c752 100644 --- a/papi-dts/variables/processType.html +++ b/papi-dts/variables/processType.html @@ -1,2 +1,2 @@ processType | papi-dts

          Generated using TypeDoc

          \ No newline at end of file +

          Generated using TypeDoc

          \ No newline at end of file diff --git a/papi-dts/variables/resourcesPath.html b/papi-dts/variables/resourcesPath.html index e7d1a07e79..5fb5cdb481 100644 --- a/papi-dts/variables/resourcesPath.html +++ b/papi-dts/variables/resourcesPath.html @@ -1,3 +1,3 @@ resourcesPath | papi-dts

          Generated using TypeDoc

          \ No newline at end of file +

          Generated using TypeDoc

          \ No newline at end of file