papi-dts
@papi/frontend
Module @papi/frontend
Type Aliases
Papi
Variables
app
commands
dataProviders
default
dialogs
fetch
internet
localization
logger
menuData
network
networkObjects
networkObjectStatus
notifications
projectDataProviders
projectLookup
react
scrollGroups
settings
themes
WebSocket
webViews
window
XMLHttpRequest
Settings
Member Visibility
Protected
Inherited
External
Theme
OS
Light
Dark
On This Page
Type Aliases
Papi
Variables
app
commands
data
Providers
default
dialogs
fetch
internet
localization
logger
menu
Data
network
network
Objects
network
Object
Status
notifications
project
Data
Providers
project
Lookup
react
scroll
Groups
settings
themes
Web
Socket
web
Views
window
XMLHttp
Request
papi-dts
@papi
backend
app
BaseProjectDataProviderEngine
commands
database
dataProtection
DataProviderEngine
dataProviders
default
dialogs
fetch
internet
LayeringProjectDataProviderEngineFactory
localization
logger
menuData
network
networkObjects
networkObjectStatus
notifications
ProjectDataProviderEngine
projectDataProviders
projectLookup
projectSettings
scrollGroups
settings
storage
themes
WebViewFactory
webViewProviders
webViews
window
core
default
AppInfo
ComponentsDocumentation
DataProviderDataType
DataProviderSubscriberOptions
DataProviderUpdateInstructions
DialogOptions
DialogTypes
ElevatedPrivileges
ExecutionActivationContext
ExecutionToken
ExtensionDataScope
ExtensionIdentifier
FocusSubject
GetWebViewOptions
HandleUri
HashValues
IBaseProjectDataProviderEngine
IDataProvider
IDataProviderEngine
IDisposableDataProvider
IDisposableWebViewProvider
InstalledExtensions
IProjectDataProviderEngine
IProjectDataProviderEngineFactory
IProjectDataProviderFactory
IWebViewProvider
LocalizationData
LocalizationSelector
LocalizationSelectors
ManageExtensions
MandatoryProjectDataTypes
MethodDocumentationWithoutName
NetworkableObject
NetworkObject
NetworkObjectDetails
NetworkObjectDocumentation
OpenWebViewOptions
PlatformNotification
ProjectDataProviderFactoryMetadataInfo
ProjectMetadata
ProjectMetadataFilterOptions
ProjectMetadataWithoutFactoryInfo
ProjectSettingValidator
RegisterUriHandler
SavedWebViewDefinition
ScrollGroupScrRef
SettingValidator
SimultaneousProjectSettingsChanges
SingleMethodDocumentation
UriHandler
UseDialogCallbackOptions
UseWebViewScrollGroupScrRefHook
UseWebViewStateHook
WebViewContentType
WebViewDefinition
WebViewProps
WithNotifyUpdate
frontend
Papi
app
commands
dataProviders
default
dialogs
fetch
internet
localization
logger
menuData
network
networkObjects
networkObjectStatus
notifications
projectDataProviders
projectLookup
react
scrollGroups
settings
themes
WebSocket
webViews
window
XMLHttpRequest
react
useData
useDataProvider
useDataProviderMulti
useDialogCallback
useLocalizedStrings
useProjectData
useProjectDataProvider
useProjectSetting
useScrollGroupScrRef
useSetting
useWebViewController
client/services
rpc-client
RpcClient
default
web-socket.factory
createWebSocket
web-socket.interface
IWebSocket
extension-host
extension-types
extension-activation-context.model
ExecutionActivationContext
extension-manifest.model
ExtensionManifest
extension.interface
IExtension
services
extension-host-web-socket.model
default
Server
AddressInfo
ClientOptions
CloseEvent
ErrorEvent
Event
EventListenerOptions
MessageEvent
PerMessageDeflateOptions
ServerOptions
WebSocket
WebSocketEventMap
WebSocketServer
CertMeta
Data
FinishRequestCallback
RawData
VerifyClientCallbackAsync
VerifyClientCallbackSync
WebSocket
WebSocketServer
createWebSocketStream
default
extension-storage.service
ExtensionStorageService
extensionStorageService
buildExtensionUriFromPath
setExtensionUris
default
main/services
rpc-server
RpcServer
default
rpc-websocket-listener
RpcWebSocketListener
default
node
models/execution-token.model
ExecutionToken
ExecutionTokenType
services
execution-token.service
executionTokenService
default
node-file-system.service
EntryType
BufferEncoding
DirectoryEntries
copyFile
createDir
deleteDir
deleteFile
getStats
moveFile
readDir
readFileBinary
readFileText
touch
writeFile
utils
crypto-util
createNonce
createUuid
generateHashFromBuffer
util
DISABLED_EXTENSIONS_DIR
EXTENSION_DATA_DIR
FILE_PROTOCOL
getAppDir
INSTALLED_EXTENSIONS_DIR
isNoisyDevModeEnvVariableSet
RESOURCES_PROTOCOL
UNZIPPED_EXTENSIONS_CACHE_DIR
getPathFromUri
joinUriPaths
resolveHtmlPath
papi-shared-types
CommandHandlers
DataProviders
ProjectDataProviderInterfaces
ProjectSettingTypes
SettingTypes
WebViewControllers
CommandNames
DataProviderNames
DataProviderTypes
DisposableDataProviders
IBaseProjectDataProvider
IProjectDataProvider
NotesOnlyProjectDataTypes
PlaceholderDataTypes
ProjectInterfaceDataTypes
ProjectInterfaces
ProjectSettingNames
SettingNames
StuffDataTypes
WebViewControllerTypes
WithProjectDataProviderEngineSettingMethods
renderer
components/dialogs
dialog-base.data
DialogDefinitionBase
DialogProps
DIALOG_BASE
hookUpDialogService
default
dialog-definition.model
DialogTypes
DialogDataTypes
DialogDefinition
DialogTabTypes
ProjectDialogOptionsBase
SelectBooksDialogOptions
SelectMultipleProjectsDialogOptions
SelectProjectDialogOptions
ABOUT_DIALOG_TYPE
SELECT_BOOKS_DIALOG_TYPE
SELECT_MULTIPLE_PROJECTS_DIALOG_TYPE
SELECT_PROJECT_DIALOG_TYPE
hooks
hook-generators
create-use-data-hook.util
createUseDataHook
default
create-use-network-object-hook.util
createUseNetworkObjectHook
default
papi-hooks
index
useData
useDataProvider
useDataProviderMulti
useDialogCallback
useLocalizedStrings
useProjectData
useProjectDataProvider
useProjectSetting
useScrollGroupScrRef
useSetting
useWebViewController
use-data-provider-multi.hook
useDataProviderMulti
default
use-data-provider.hook
useDataProvider
default
use-data.hook
useData
default
use-dialog-callback.hook
UseDialogCallbackOptions
useDialogCallback
default
use-localized-strings-hook
useLocalizedStrings
default
use-project-data-provider.hook
useProjectDataProvider
default
use-project-data.hook
useProjectData
default
use-project-setting.hook
useProjectSetting
default
use-scroll-group-scr-ref.hook
useScrollGroupScrRef
default
use-setting.hook
useSetting
default
use-web-view-controller.hook
useWebViewController
default
services
renderer-web-socket.service
PapiRendererWebSocket
blockWebSocketsToPapiNetwork
default
renderer-xml-http-request.service
PapiRendererXMLHttpRequest
default
scroll-group.service-host
availableScrollGroupIds
onDidUpdateScrRef
getScrRefSync
setScrRefSync
startScrollGroupService
theme.service-host
ThemeDataProviderEngine
localThemeService
testingThemeService
initialize
shared
data
file-system.model
Uri
platform.data
DEFAULT_THEME_FAMILY
DEFAULT_THEME_TYPE
DEFAULT_ZOOM_FACTOR
DEV_MODE_QUERY_PARAMETER
LOG_LEVEL_QUERY_PARAMETER
MAX_ZOOM_FACTOR
MIN_ZOOM_FACTOR
PLATFORM_NAMESPACE
rpc.model
ConnectionStatus
EventHandler
InternalRequestHandler
RequestId
RequestParams
CATEGORY_COMMAND
GET_METHODS
REGISTER_METHOD
UNREGISTER_METHOD
WEBSOCKET_PORT
createErrorResponse
createRequest
createSuccessResponse
deserializeMessage
fixupResponse
requestWithRetry
sendPayloadToWebSocket
global-this.model
ProcessType
log-error.model
LogError
default
models
base-project-data-provider-engine.model
BaseProjectDataProviderEngine
IBaseProjectDataProviderEngine
create-process-privilege.model
CreateProcess
OperatingSystemData
PlatformFork
PlatformSpawn
data-protection.service-model
IDataProtectionService
dataProtectionServiceNetworkObjectName
data-provider-engine.model
DataProviderEngine
DataProviderEngineNotifyUpdate
IDataProviderEngine
WithNotifyUpdate
default
data-provider.interface
IDataProvider
IDisposableDataProvider
default
data-provider.model
DataProviderDataType
DataProviderDataTypes
DataProviderGetter
DataProviderGetters
DataProviderInternal
DataProviderSetter
DataProviderSetters
DataProviderSubscriber
DataProviderSubscriberOptions
DataProviderSubscribers
DataProviderUpdateInstructions
DataTypeNames
getDataProviderDataTypeFromFunctionName
default
dialog-options.model
DialogData
DialogOptions
DIALOG_OPTIONS_LOCALIZABLE_PROPERTY_KEYS
docking-framework.model
FloatLayout
PanelLayout
TabLayout
FloatPosition
FloatSize
Layout
OnLayoutChangeRCDock
PanelDirection
PapiDockLayout
SavedTabInfo
TabInfo
TabLoader
TabSaver
WebViewTabProps
elevated-privilege-names.model
ElevatedPrivilegeNames
elevated-privileges.model
ElevatedPrivileges
extension-basic-data.model
ExtensionBasicData
extract-data-provider-data-types.model
ExtractDataProviderDataTypes
default
full-extension-data.model
ExtensionIcon
FullExtensionData
handle-uri-privilege.model
HandleUri
RegisterUriHandler
UriHandler
manage-extensions-privilege.model
DisableExtensionFunction
EnableExtensionFunction
ExtensionIdentifier
GetExtensionsDataFunction
GetInstalledExtensionsFunction
HashValues
InstalledExtensions
InstallExtensionFunction
ManageExtensions
network-object-status.service-model
NetworkObjectStatusRemoteServiceType
NetworkObjectStatusServiceType
networkObjectStatusServiceNetworkObjectName
network-object.model
DisposableNetworkObject
LocalObjectToProxyCreator
NetworkableObject
NetworkObject
NetworkObjectDetails
network.model
NetworkMethodHandlerOptions
notification.service-model
INotificationService
PlatformNotification
Severity
NotificationServiceNetworkObjectName
openrpc.model
Components
ComponentsReference
Contact
ContentDescriptor
Error
Example
ExamplePairingObject
ExternalDocumentation
Info
License
Link
Method
MethodDocumentationWithoutName
NetworkObjectDocumentation
OpenRpc
Reference
Schema
Server
ServerVariable
SingleMethodDocumentation
Tag
createEmptyOpenRpc
getEmptyMethodDocs
papi-network-event-emitter.model
PapiNetworkEventEmitter
default
project-data-provider-engine-factory.model
LayeringProjectDataProviderEngineFactory
IProjectDataProviderEngineFactory
project-data-provider-engine.model
ProjectDataProviderEngine
IProjectDataProviderEngine
project-data-provider-factory.interface
IProjectDataProviderFactory
ProjectMetadataFilterOptions
PDP_FACTORY_OBJECT_TYPE
default
project-data-provider.model
ExtensionDataScope
MandatoryProjectDataTypes
WithProjectDataProviderEngineExtensionDataMethods
PROJECT_INTERFACE_PLATFORM_BASE
project-lookup.service-model
ProjectLookupServiceType
NETWORK_OBJECT_NAME_PROJECT_LOOKUP_SERVICE
projectLookupServiceBase
testingProjectLookupService
areProjectInterfacesIncluded
compareProjectDataProviderFactoryMetadataInfoMinimalMatch
getPDPFactoryIdFromNetworkObjectName
getPDPFactoryNetworkObjectNameFromId
internalGetMetadata
transformGetMetadataForProjectParametersToFilter
project-metadata.model
ProjectDataProviderFactoryMetadataInfo
ProjectMetadata
ProjectMetadataWithoutFactoryInfo
rpc.interface
IRpcHandler
IRpcMethodRegistrar
RegisteredRpcMethodDetails
web-view-factory.model
WebViewFactory
web-view-provider.model
IDisposableWebViewProvider
IRegisteredWebViewProvider
IWebViewProvider
web-view.model
GetSavedWebViewDefinition
GetWebViewOptions
OpenWebViewOptions
ReloadWebViewOptions
SavedWebViewDefinition
SavedWebViewDefinitionOmittedKeys
UpdateWebViewDefinition
UseWebViewScrollGroupScrRefHook
UseWebViewStateHook
WebViewContentType
WebViewDefinition
WebViewDefinitionBase
WebViewDefinitionHtml
WebViewDefinitionReact
WebViewDefinitionUpdatableProperties
WebViewDefinitionUpdateInfo
WebViewDefinitionURL
WebViewId
WebViewProps
WebViewType
SAVED_WEBVIEW_DEFINITION_OMITTED_KEYS
WEB_VIEW_CONTENT_TYPE
WEBVIEW_DEFINITION_UPDATABLE_PROPERTY_KEYS
services
app.service
appService
app.service-model
IAppService
AppInfo
MarketingInfo
appServiceNetworkObjectName
command.service
moduleSummaryComments
createSendCommandFunction
registerCommand
sendCommand
data-protection.service
dataProtectionService
default
data-provider.service
DataProviderService
dataProviderService
getByType
registerEngineByType
default
database.service
databaseService
default
database.service-model
OpenDatabaseOptions
RunResult
IDatabaseService
databaseServiceNetworkObjectName
databaseServiceObjectToProxy
dialog.service
dialogService
default
dialog.service-model
DialogService
CATEGORY_DIALOG
internet.service
InternetService
internetService
default
localization.service
localizationService
default
localization.service-model
ILocalizationService
LocalizationData
LocalizationDataDataTypes
LocalizationSelector
LocalizationSelectors
localizationServiceObjectToProxy
localizationServiceProviderName
logger.service
logger
default
menu-data.service
menuDataService
default
menu-data.service-model
IMenuDataService
MenuDataDataTypes
menuDataServiceObjectToProxy
menuDataServiceProviderName
network-object-status.service
networkObjectStatusService
default
network-object.service
BackendNetworkObjectService
FrontendNetworkObjectService
NetworkObjectService
backendNetworkObjectService
frontendNetworkObjectService
networkObjectService
onDidCreateNetworkObject
onDidDisposeNetworkObject
overrideDispose
default
network.service
PapiNetworkService
createNetworkEventEmitter
createRequestFunction
getNetworkEvent
papiNetworkService
request
shutdown
initialize
registerRequestHandler
setRequestTimeout
notification.service
notificationService
default
project-data-provider.service
PapiBackendProjectDataProviderService
PapiFrontendProjectDataProviderService
papiBackendProjectDataProviderService
papiFrontendProjectDataProviderService
get
registerProjectDataProviderEngineFactory
project-lookup.service
projectLookupService
default
project-settings.service
projectSettingsService
filterProjectSettingsContributionsByProjectInterfaces
default
project-settings.service-model
IProjectSettingsService
AllProjectSettingsValidators
ProjectSettingValidator
SimultaneousProjectSettingsChanges
CATEGORY_EXTENSION_PROJECT_SETTING_VALIDATOR
projectSettingsServiceNetworkObjectName
projectSettingsServiceObjectToProxy
rpc-handler.factory
createRpcHandler
scroll-group.service
scrollGroupService
default
scroll-group.service-model
IScrollGroupRemoteService
IScrollGroupService
ScrollGroupScrRef
ScrollGroupUpdateInfo
EVENT_NAME_ON_DID_UPDATE_SCR_REF
NETWORK_OBJECT_NAME_SCROLL_GROUP_SERVICE
settings.service
settingsService
default
settings.service-model
AllSettingsData
AllSettingsValidators
ISettingsService
SettingDataTypes
SettingValidator
CATEGORY_EXTENSION_SETTING_VALIDATOR
settingsServiceDataProviderName
settingsServiceObjectToProxy
shared-store.service
SharedStoreValues
NetworkService
RequestTimeoutSharedStoreKey
SharedStoreKeys
sharedStoreService
get
initialize
remove
resetForTesting
set
theme-data.service
themeDataService
default
theme-data.service-model
IThemeDataService
ThemeDataDataTypes
themeDataServiceObjectToProxy
themeDataServiceProviderName
theme.service
themeService
theme.service-model
CurrentThemeSpecifier
IThemeService
IThemeServiceLocal
ThemeDataTypes
themeServiceDataProviderName
themeServiceObjectToProxy
USER_THEME_FAMILY_PREFIX
web-view-provider.service
PapiWebViewProviderService
WebViewProviderService
papiWebViewProviderService
webViewProviderService
default
web-view.service
webViewService
default
web-view.service-model
WebViewServiceType
CloseWebViewEvent
OpenWebViewEvent
UpdateWebViewEvent
WebViewMessageRequestHandler
EVENT_NAME_ON_DID_ADD_WEB_VIEW
EVENT_NAME_ON_DID_CLOSE_WEB_VIEW
EVENT_NAME_ON_DID_OPEN_WEB_VIEW
EVENT_NAME_ON_DID_UPDATE_WEB_VIEW
getWebViewControllerObjectId
NETWORK_OBJECT_NAME_WEB_VIEW_SERVICE
WEB_VIEW_CONTROLLER_OBJECT_TYPE
getWebViewController
getWebViewMessageRequestType
window.service
windowService
window.service-model
FocusSubject
FocusSubjectOther
FocusSubjectTab
FocusSubjectWebView
IWindowService
WindowDataTypes
windowServiceObjectToProxy
windowServiceProviderName
utils
internal-util
getProcessType
isClient
isExtensionHost
isRenderer
isServer
logger.utils
formatLog
setUpLogger
project-settings-document-combiner
ProjectSettingsDocumentCombiner
LocalizedProjectSettingsContributionInfo
ProjectSettingsContributionInfo
default
settings-document-combiner-base
SettingsDocumentCombinerBase
LocalizedSettingsContributionInfo
SettingsContributionInfo
default
util
RequestType
SerializedRequestType
MODULE_SIMILAR_APIS
REQUEST_TYPE_SEPARATOR
bindClassMethods
deserializeRequestType
getModuleSimilarApiMessage
newNonce
serializeRequestType
getSavedWebViewDefinition
getSavedWebViewDefinitionById
getWebViewState
isNoisyDevModeEnabled
isPackaged
logLevel
processType
resetWebViewState
resourcesPath
setWebViewState
updateWebViewDefinition
updateWebViewDefinitionById
useWebViewScrollGroupScrRef
useWebViewState
webViewComponent
webViewId
M
M
N
E
P
V
F
C
I
C
P
M
F
P
C
P
T
T
A
A
A
T
R