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 ee083600ae..1a0428d1c0 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

Class default

Handles the connection from the client to the server

-

Implements

Constructors

constructor +

Implements

Constructors

constructor

Properties

clientGuid connect connectPromise? @@ -26,7 +26,7 @@ unsubscribeHandleResponseMessage? webSocket?

Constructors

constructor

Properties

Private clientGuid

clientGuid: any

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

-

connect

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

Sets up the NetworkConnector by populating connector info, setting up event handlers, and doing +

connect

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

Sets up the NetworkConnector by populating connector info, setting up event handlers, and doing one of the following:

  • On Client: connecting to the server.
    • @@ -34,59 +34,59 @@

MUST ALSO RUN notifyClientConnected() WHEN PROMISE RESOLVES

Type declaration

Returns

Promise that resolves with connector info when finished connecting

-

Private Optional connectPromise

connectPromise?: any

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

Private Optional connectPromise

connectPromise?: any

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

-

connectionStatus

connectionStatus: ConnectionStatus

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

connectionStatus

connectionStatus: ConnectionStatus

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

-

connectorInfo

connectorInfo: Readonly<{
    clientId: number;
}>

Information about the connector. Populated by the server while connecting

-

Type declaration

  • clientId: number

disconnect

disconnect: (() => void)

Disconnects from the connection:

+

connectorInfo

connectorInfo: Readonly<{
    clientId: number;
}>

Information about the connector. Populated by the server while connecting

+

Type declaration

  • clientId: number

disconnect

disconnect: (() => void)

Disconnects from the connection:

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

Type declaration

    • (): void

    • Returns void

emitEventOnNetwork

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

Sends an event to other processes. Does NOT run the local event subscriptions as they should be +

Type declaration

    • (): void

    • Returns void

emitEventOnNetwork

emitEventOnNetwork: (<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 declaration

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

    • Type Parameters

      • T

      Parameters

      Returns Promise<void>

Private handleEventMessage

handleEventMessage: any

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

Type declaration

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

    • Type Parameters

      • T

      Parameters

      Returns Promise<void>

Private handleEventMessage

handleEventMessage: any

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

Param: eventMessage

Event message to handle

-

Private handleRequestMessage

handleRequestMessage: any

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

Private handleRequestMessage

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

-

Private handleResponseMessage

handleResponseMessage: any

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

Private handleResponseMessage

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

-

Private Optional localEventHandler

localEventHandler?: any

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

Private Optional localEventHandler

localEventHandler?: any

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

-

Private Optional localRequestHandler

localRequestHandler?: any

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

Private Optional localRequestHandler

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

-

Private messageEmitters

messageEmitters: any

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

Private messageEmitters

messageEmitters: any

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

-

notifyClientConnected

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

Notify the server that this client has received its connectorInfo and is ready to go.

+

notifyClientConnected

notifyClientConnected: (() => 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?

-

Type declaration

    • (): Promise<void>

    • Returns Promise<void>

Private onMessage

onMessage: any

Receives and appropriately publishes server webSocket messages

+

Type declaration

    • (): Promise<void>

    • Returns Promise<void>

Private onMessage

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

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

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

+

request

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

-

Private Optional requestRouter

requestRouter?: any

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

Private Optional requestRouter

requestRouter?: any

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

-

Private requests

requests: any

All requests that are waiting for a response

-

Private sendMessage

sendMessage: any

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

+

Private requests

requests: any

All requests that are waiting for a response

+

Private sendMessage

sendMessage: any

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

Param: message

Message to send

-

Private subscribe

subscribe: any

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

+

Private subscribe

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

-

Private Optional unsubscribeHandleEventMessage

unsubscribeHandleEventMessage?: any

Function that removes this handleEvent from the connection

-

Private Optional unsubscribeHandleInitClientMessage

unsubscribeHandleInitClientMessage?: any

Function that removes this initClient handler from the connection

-

Private Optional unsubscribeHandleRequestMessage

unsubscribeHandleRequestMessage?: any

Function that removes this handleRequest from the connection

-

Private Optional unsubscribeHandleResponseMessage

unsubscribeHandleResponseMessage?: any

Function that removes this response handler from the connection

-

Private Optional webSocket

webSocket?: any

The webSocket connected to the server

-

Settings

Member Visibility

Theme

On This Page

constructorclientGuidconnectconnectPromiseconnectionStatusconnectorInfodisconnectemitEventOnNetworkhandleEventMessagehandleRequestMessagehandleResponseMessagelocalEventHandlerlocalRequestHandlermessageEmittersnotifyClientConnectedonMessagerequestrequestRouterrequestssendMessagesubscribeunsubscribeHandleEventMessageunsubscribeHandleInitClientMessageunsubscribeHandleRequestMessageunsubscribeHandleResponseMessagewebSocket
\ No newline at end of file +

Private Optional unsubscribeHandleEventMessage

unsubscribeHandleEventMessage?: any

Function that removes this handleEvent from the connection

+

Private Optional unsubscribeHandleInitClientMessage

unsubscribeHandleInitClientMessage?: any

Function that removes this initClient handler from the connection

+

Private Optional unsubscribeHandleRequestMessage

unsubscribeHandleRequestMessage?: any

Function that removes this handleRequest from the connection

+

Private Optional unsubscribeHandleResponseMessage

unsubscribeHandleResponseMessage?: any

Function that removes this response handler from the connection

+

Private Optional webSocket

webSocket?: any

The webSocket connected to the server

+

Settings

Member Visibility

Theme

On This Page

constructorclientGuidconnectconnectPromiseconnectionStatusconnectorInfodisconnectemitEventOnNetworkhandleEventMessagehandleRequestMessagehandleResponseMessagelocalEventHandlerlocalRequestHandlermessageEmittersnotifyClientConnectedonMessagerequestrequestRouterrequestssendMessagesubscribeunsubscribeHandleEventMessageunsubscribeHandleInitClientMessageunsubscribeHandleRequestMessageunsubscribeHandleResponseMessagewebSocket
\ 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 102966222c..edc123d4de 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

Class default

Handles the endpoint and connections from the server to the clients

-

Implements

Constructors

constructor +

Implements

Constructors

constructor

Properties

clientSockets connect connectPromise? @@ -35,7 +35,7 @@ unsubscribeHandleResponseMessage? webSocketServer?

Constructors

constructor

Properties

Private clientSockets

clientSockets: any

The webSocket clients that are connected and information about them

-

connect

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

Sets up the NetworkConnector by populating connector info, setting up event handlers, and doing +

connect

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

Sets up the NetworkConnector by populating connector info, setting up event handlers, and doing one of the following:

  • On Client: connecting to the server.
    • @@ -43,77 +43,77 @@

MUST ALSO RUN notifyClientConnected() WHEN PROMISE RESOLVES

Type declaration

Returns

Promise that resolves with connector info when finished connecting

-

Private Optional connectPromise

connectPromise?: any

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

Private Optional connectPromise

connectPromise?: any

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

-

connectionStatus

connectionStatus: ConnectionStatus

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

connectionStatus

connectionStatus: ConnectionStatus

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

-

connectorInfo

connectorInfo: Readonly<{
    clientId: number;
}>

Information about the connector. Populated by the server while connecting

-

Type declaration

  • clientId: number

disconnect

disconnect: (() => void)

Disconnects from the connection:

+

connectorInfo

connectorInfo: Readonly<{
    clientId: number;
}>

Information about the connector. Populated by the server while connecting

+

Type declaration

  • clientId: number

disconnect

disconnect: (() => void)

Disconnects from the connection:

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

Type declaration

    • (): void

    • Returns void

Private disconnectClient

disconnectClient: any

Closes connection and unregisters a client webSocket when it has disconnected

-

emitEventOnNetwork

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

Sends an event to other processes. Does NOT run the local event subscriptions as they should be +

Type declaration

    • (): void

    • Returns void

Private disconnectClient

disconnectClient: any

Closes connection and unregisters a client webSocket when it has disconnected

+

emitEventOnNetwork

emitEventOnNetwork: (<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 declaration

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

    • Type Parameters

      • T

      Parameters

      Returns Promise<void>

Private getClientIdFromSocket

getClientIdFromSocket: any

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

-

Private getClientSocket

getClientSocket: any

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

-

Private getClientSocketFromGuid

getClientSocketFromGuid: any

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

Type declaration

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

    • Type Parameters

      • T

      Parameters

      Returns Promise<void>

Private getClientIdFromSocket

getClientIdFromSocket: any

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

+

Private getClientSocket

getClientSocket: any

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

+

Private getClientSocketFromGuid

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.

-

Private handleClientConnectMessage

handleClientConnectMessage: any

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

Private handleClientConnectMessage

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

-

Private handleEventMessage

handleEventMessage: any

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

Private handleEventMessage

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

-

Private handleRequestMessage

handleRequestMessage: any

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

Private handleRequestMessage

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

-

Private handleResponseMessage

handleResponseMessage: any

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

Private handleResponseMessage

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

-

Private Optional localEventHandler

localEventHandler?: any

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

Private Optional localEventHandler

localEventHandler?: any

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

-

Private Optional localRequestHandler

localRequestHandler?: any

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

Private Optional localRequestHandler

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

-

Private messageEmitters

messageEmitters: any

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

Private messageEmitters

messageEmitters: any

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

-

Private Optional networkConnectorEventHandlers

networkConnectorEventHandlers?: any

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

-

Private nextClientId

nextClientId: any

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

-

notifyClientConnected

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

Notify the server that this client has received its connectorInfo and is ready to go.

+

Private Optional networkConnectorEventHandlers

networkConnectorEventHandlers?: any

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

+

Private nextClientId

nextClientId: any

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

+

notifyClientConnected

notifyClientConnected: (() => 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?

-

Type declaration

    • (): Promise<void>

    • Returns Promise<void>

Private onClientConnect

onClientConnect: any

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

Type declaration

    • (): Promise<void>

    • Returns Promise<void>

Private onClientConnect

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

-

Private onClientDisconnect

onClientDisconnect: any

Handles when client connection disconnects. Unregisters and such

-

Private onMessage

onMessage: any

Receives and appropriately publishes webSocket messages

+

Private onClientDisconnect

onClientDisconnect: any

Handles when client connection disconnects. Unregisters and such

+

Private onMessage

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

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

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

+

request

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

-

Private Optional requestRouter

requestRouter?: any

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

Private Optional requestRouter

requestRouter?: any

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

-

Private requests

requests: any

All requests that are waiting for a response

-

Private sendMessage

sendMessage: any

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

+

Private requests

requests: any

All requests that are waiting for a response

+

Private sendMessage

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

-

Private subscribe

subscribe: any

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

+

Private subscribe

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

-

Private Optional unsubscribeHandleClientConnectMessage

unsubscribeHandleClientConnectMessage?: any

Function that removes this clientConnect handler from connections

-

Private Optional unsubscribeHandleEventMessage

unsubscribeHandleEventMessage?: any

Function that removes this handleEvent from the connection

-

Private Optional unsubscribeHandleRequestMessage

unsubscribeHandleRequestMessage?: any

Function that removes this handleRequest from connections

-

Private Optional unsubscribeHandleResponseMessage

unsubscribeHandleResponseMessage?: any

Function that removes this response handler from connections

-

Private Optional webSocketServer

webSocketServer?: any

The webSocket connected to the server

-

Settings

Member Visibility

Theme

On This Page

constructorclientSocketsconnectconnectPromiseconnectionStatusconnectorInfodisconnectdisconnectClientemitEventOnNetworkgetClientIdFromSocketgetClientSocketgetClientSocketFromGuidhandleClientConnectMessagehandleEventMessagehandleRequestMessagehandleResponseMessagelocalEventHandlerlocalRequestHandlermessageEmittersnetworkConnectorEventHandlersnextClientIdnotifyClientConnectedonClientConnectonClientDisconnectonMessagerequestrequestRouterrequestssendMessagesubscribeunsubscribeHandleClientConnectMessageunsubscribeHandleEventMessageunsubscribeHandleRequestMessageunsubscribeHandleResponseMessagewebSocketServer
\ No newline at end of file +

Private Optional unsubscribeHandleClientConnectMessage

unsubscribeHandleClientConnectMessage?: any

Function that removes this clientConnect handler from connections

+

Private Optional unsubscribeHandleEventMessage

unsubscribeHandleEventMessage?: any

Function that removes this handleEvent from the connection

+

Private Optional unsubscribeHandleRequestMessage

unsubscribeHandleRequestMessage?: any

Function that removes this handleRequest from connections

+

Private Optional unsubscribeHandleResponseMessage

unsubscribeHandleResponseMessage?: any

Function that removes this response handler from connections

+

Private Optional webSocketServer

webSocketServer?: any

The webSocket connected to the server

+

Settings

Member Visibility

Theme

On This Page

constructorclientSocketsconnectconnectPromiseconnectionStatusconnectorInfodisconnectdisconnectClientemitEventOnNetworkgetClientIdFromSocketgetClientSocketgetClientSocketFromGuidhandleClientConnectMessagehandleEventMessagehandleRequestMessagehandleResponseMessagelocalEventHandlerlocalRequestHandlermessageEmittersnetworkConnectorEventHandlersnextClientIdnotifyClientConnectedonClientConnectonClientDisconnectonMessagerequestrequestRouterrequestssendMessagesubscribeunsubscribeHandleClientConnectMessageunsubscribeHandleEventMessageunsubscribeHandleRequestMessageunsubscribeHandleResponseMessagewebSocketServer
\ 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 1cd8139a43..7eb817d5ee 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

Class ExecutionToken

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

-

Constructors

constructor +

Constructors

constructor

Properties

name nonce type

Methods

getHash -

Constructors

constructor

Properties

Readonly name

name: string

Readonly nonce

nonce: string

Readonly type

type: "extension"

Methods

getHash

Settings

Member Visibility

Theme

On This Page

constructornamenoncetypegetHash
\ No newline at end of file +

Constructors

constructor

Properties

Readonly name

name: string

Readonly nonce

nonce: string

Readonly type

type: "extension"

Methods

getHash

Settings

Member Visibility

Theme

On This Page

constructornamenoncetypegetHash
\ 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 6b473f647b..5e12ea2360 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

constructor +

Implements

  • WebSocket

Constructors

constructor

Properties

CLOSED CLOSING CONNECTING @@ -22,4 +22,4 @@ removeEventListener send url -

Constructors

constructor

Properties

Readonly CLOSED

CLOSED: 3

Readonly CLOSING

CLOSING: 2

Readonly CONNECTING

CONNECTING: 0

Readonly OPEN

OPEN: 1

addEventListener

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: BinaryType

bufferedAmount

bufferedAmount: number

close

close: ((code?, reason?) => void)

Type declaration

    • (code?, reason?): void

    • Parameters

      • Optional code: number
      • Optional reason: string

      Returns void

dispatchEvent

dispatchEvent: ((event) => boolean)

Type declaration

    • (event): boolean

    • Parameters

      • event: Event

      Returns boolean

extensions

extensions: string

onclose

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

Type declaration

    • (this, ev): any

    • Parameters

      • this: WebSocket
      • ev: CloseEvent

      Returns any

onerror

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

Type declaration

    • (this, ev): any

    • Parameters

      • this: WebSocket
      • ev: Event

      Returns any

onmessage

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

Type declaration

    • (this, ev): any

    • Parameters

      • this: WebSocket
      • ev: MessageEvent<any>

      Returns any

onopen

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

Type declaration

    • (this, ev): any

    • Parameters

      • this: WebSocket
      • ev: Event

      Returns any

protocol

protocol: string

readyState

readyState: number

removeEventListener

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

send: ((data) => void)

Type declaration

    • (data): void

    • Parameters

      • data: string | ArrayBufferLike | ArrayBufferView | Blob

      Returns void

url

url: string

Settings

Member Visibility

Theme

On This Page

constructorCLOSEDCLOSINGCONNECTINGOPENaddEventListenerbinaryTypebufferedAmountclosedispatchEventextensionsoncloseonerroronmessageonopenprotocolreadyStateremoveEventListenersendurl
\ No newline at end of file +

Constructors

constructor

Properties

Readonly CLOSED

CLOSED: 3

Readonly CLOSING

CLOSING: 2

Readonly CONNECTING

CONNECTING: 0

Readonly OPEN

OPEN: 1

addEventListener

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: BinaryType

bufferedAmount

bufferedAmount: number

close

close: ((code?, reason?) => void)

Type declaration

    • (code?, reason?): void

    • Parameters

      • Optional code: number
      • Optional reason: string

      Returns void

dispatchEvent

dispatchEvent: ((event) => boolean)

Type declaration

    • (event): boolean

    • Parameters

      • event: Event

      Returns boolean

extensions

extensions: string

onclose

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

Type declaration

    • (this, ev): any

    • Parameters

      • this: WebSocket
      • ev: CloseEvent

      Returns any

onerror

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

Type declaration

    • (this, ev): any

    • Parameters

      • this: WebSocket
      • ev: Event

      Returns any

onmessage

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

Type declaration

    • (this, ev): any

    • Parameters

      • this: WebSocket
      • ev: MessageEvent<any>

      Returns any

onopen

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

Type declaration

    • (this, ev): any

    • Parameters

      • this: WebSocket
      • ev: Event

      Returns any

protocol

protocol: string

readyState

readyState: number

removeEventListener

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

send: ((data) => void)

Type declaration

    • (data): void

    • Parameters

      • data: string | ArrayBufferLike | ArrayBufferView | Blob

      Returns void

url

url: string

Settings

Member Visibility

Theme

On This Page

constructorCLOSEDCLOSINGCONNECTINGOPENaddEventListenerbinaryTypebufferedAmountclosedispatchEventextensionsoncloseonerroronmessageonopenprotocolreadyStateremoveEventListenersendurl
\ 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 aaf793250a..c3abdb2552 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

constructor +

Implements

  • XMLHttpRequest

Constructors

constructor

Properties

DONE HEADERS_RECEIVED LOADING @@ -37,4 +37,4 @@ timeout upload withCredentials -

Constructors

constructor

Properties

Readonly DONE

DONE: 4

Readonly HEADERS_RECEIVED

HEADERS_RECEIVED: 2

Readonly LOADING

LOADING: 3

Readonly OPENED

OPENED: 1

Readonly UNSENT

UNSENT: 0

abort

abort: (() => void)

Type declaration

    • (): void

    • Returns void

addEventListener

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

dispatchEvent: ((event) => boolean)

Type declaration

    • (event): boolean

    • Parameters

      • event: Event

      Returns boolean

getAllResponseHeaders

getAllResponseHeaders: (() => string)

Type declaration

    • (): string

    • Returns string

getResponseHeader

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

Type declaration

    • (name): null | string

    • Parameters

      • name: string

      Returns null | string

onabort

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

Type declaration

    • (this, ev): any

    • Parameters

      • this: XMLHttpRequest
      • ev: ProgressEvent<EventTarget>

      Returns any

onerror

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

Type declaration

    • (this, ev): any

    • Parameters

      • this: XMLHttpRequest
      • ev: ProgressEvent<EventTarget>

      Returns any

onload

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

Type declaration

    • (this, ev): any

    • Parameters

      • this: XMLHttpRequest
      • ev: ProgressEvent<EventTarget>

      Returns any

onloadend

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

Type declaration

    • (this, ev): any

    • Parameters

      • this: XMLHttpRequest
      • ev: ProgressEvent<EventTarget>

      Returns any

onloadstart

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

Type declaration

    • (this, ev): any

    • Parameters

      • this: XMLHttpRequest
      • ev: ProgressEvent<EventTarget>

      Returns any

onprogress

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

Type declaration

    • (this, ev): any

    • Parameters

      • this: XMLHttpRequest
      • ev: ProgressEvent<EventTarget>

      Returns any

onreadystatechange

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

Type declaration

    • (this, ev): any

    • Parameters

      • this: XMLHttpRequest
      • ev: Event

      Returns any

ontimeout

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

Type declaration

    • (this, ev): any

    • Parameters

      • this: XMLHttpRequest
      • ev: ProgressEvent<EventTarget>

      Returns any

open

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

overrideMimeType: ((mime) => void)

Type declaration

    • (mime): void

    • Parameters

      • mime: string

      Returns void

readyState

readyState: number

removeEventListener

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

response: any

responseText

responseText: string

responseType

responseType: XMLHttpRequestResponseType

responseURL

responseURL: string

responseXML

responseXML: null | Document

send

send: ((body?) => void)

Type declaration

    • (body?): void

    • Parameters

      • Optional body: null | Document | XMLHttpRequestBodyInit

      Returns void

setRequestHeader

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

Type declaration

    • (name, value): void

    • Parameters

      • name: string
      • value: string

      Returns void

status

status: number

statusText

statusText: string

timeout

timeout: number

upload

upload: XMLHttpRequestUpload

withCredentials

withCredentials: boolean

Settings

Member Visibility

Theme

On This Page

constructorDONEHEADERS_RECEIVEDLOADINGOPENEDUNSENTabortaddEventListenerdispatchEventgetAllResponseHeadersgetResponseHeaderonabortonerroronloadonloadendonloadstartonprogressonreadystatechangeontimeoutopenoverrideMimeTypereadyStateremoveEventListenerresponseresponseTextresponseTyperesponseURLresponseXMLsendsetRequestHeaderstatusstatusTexttimeoutuploadwithCredentials
\ No newline at end of file +

Constructors

constructor

Properties

Readonly DONE

DONE: 4

Readonly HEADERS_RECEIVED

HEADERS_RECEIVED: 2

Readonly LOADING

LOADING: 3

Readonly OPENED

OPENED: 1

Readonly UNSENT

UNSENT: 0

abort

abort: (() => void)

Type declaration

    • (): void

    • Returns void

addEventListener

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

dispatchEvent: ((event) => boolean)

Type declaration

    • (event): boolean

    • Parameters

      • event: Event

      Returns boolean

getAllResponseHeaders

getAllResponseHeaders: (() => string)

Type declaration

    • (): string

    • Returns string

getResponseHeader

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

Type declaration

    • (name): null | string

    • Parameters

      • name: string

      Returns null | string

onabort

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

Type declaration

    • (this, ev): any

    • Parameters

      • this: XMLHttpRequest
      • ev: ProgressEvent<EventTarget>

      Returns any

onerror

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

Type declaration

    • (this, ev): any

    • Parameters

      • this: XMLHttpRequest
      • ev: ProgressEvent<EventTarget>

      Returns any

onload

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

Type declaration

    • (this, ev): any

    • Parameters

      • this: XMLHttpRequest
      • ev: ProgressEvent<EventTarget>

      Returns any

onloadend

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

Type declaration

    • (this, ev): any

    • Parameters

      • this: XMLHttpRequest
      • ev: ProgressEvent<EventTarget>

      Returns any

onloadstart

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

Type declaration

    • (this, ev): any

    • Parameters

      • this: XMLHttpRequest
      • ev: ProgressEvent<EventTarget>

      Returns any

onprogress

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

Type declaration

    • (this, ev): any

    • Parameters

      • this: XMLHttpRequest
      • ev: ProgressEvent<EventTarget>

      Returns any

onreadystatechange

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

Type declaration

    • (this, ev): any

    • Parameters

      • this: XMLHttpRequest
      • ev: Event

      Returns any

ontimeout

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

Type declaration

    • (this, ev): any

    • Parameters

      • this: XMLHttpRequest
      • ev: ProgressEvent<EventTarget>

      Returns any

open

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

overrideMimeType: ((mime) => void)

Type declaration

    • (mime): void

    • Parameters

      • mime: string

      Returns void

readyState

readyState: number

removeEventListener

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

response: any

responseText

responseText: string

responseType

responseType: XMLHttpRequestResponseType

responseURL

responseURL: string

responseXML

responseXML: null | Document

send

send: ((body?) => void)

Type declaration

    • (body?): void

    • Parameters

      • Optional body: null | Document | XMLHttpRequestBodyInit

      Returns void

setRequestHeader

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

Type declaration

    • (name, value): void

    • Parameters

      • name: string
      • value: string

      Returns void

status

status: number

statusText

statusText: string

timeout

timeout: number

upload

upload: XMLHttpRequestUpload

withCredentials

withCredentials: boolean

Settings

Member Visibility

Theme

On This Page

constructorDONEHEADERS_RECEIVEDLOADINGOPENEDUNSENTabortaddEventListenerdispatchEventgetAllResponseHeadersgetResponseHeaderonabortonerroronloadonloadendonloadstartonprogressonreadystatechangeontimeoutopenoverrideMimeTypereadyStateremoveEventListenerresponseresponseTextresponseTyperesponseURLresponseXMLsendsetRequestHeaderstatusstatusTexttimeoutuploadwithCredentials
\ No newline at end of file diff --git a/papi-dts/classes/_shared_models_data_provider_engine_model_.DataProviderEngine.html b/papi-dts/classes/_shared_models_data_provider_engine_model_.DataProviderEngine.html index 457c2a0f48..7613745a6d 100644 --- a/papi-dts/classes/_shared_models_data_provider_engine_model_.DataProviderEngine.html +++ b/papi-dts/classes/_shared_models_data_provider_engine_model_.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

Hierarchy (view full)

Implements

Constructors

constructor +

Type Parameters

Hierarchy (view full)

Implements

Constructors

constructor

Methods

notifyUpdate -

Constructors

constructor

Methods

notifyUpdate

Settings

Member Visibility

Theme

On This Page

constructornotifyUpdate
\ No newline at end of file +

Constructors

constructor

Methods

notifyUpdate

Settings

Member Visibility

Theme

On This Page

constructornotifyUpdate
\ 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 b77449b0b7..992cee19eb 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

constructor +

Type Parameters

  • T

Hierarchy

  • PlatformEventEmitter<T>
    • default

Constructors

constructor

Properties

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

Constructors

constructor

Properties

dispose

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

Type declaration

    • (): Promise<boolean>

    • Returns Promise<boolean>

emit

emit: ((event) => void)

Type declaration

    • (event): void

    • Parameters

      • event: T

      Returns void

Private networkDisposer

networkDisposer: any

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

-

Private networkSubscriber

networkSubscriber: any

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

-

subscribe

subscribe: PlatformEvent<T>

Subscribes a function to run when this event is emitted.

+
    • (): void

    • Returns void

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

Properties

dispose

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

Type declaration

    • (): Promise<boolean>

    • Returns Promise<boolean>

emit

emit: ((event) => void)

Type declaration

    • (event): void

    • Parameters

      • event: T

      Returns void

Private networkDisposer

networkDisposer: any

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

+

Private networkSubscriber

networkSubscriber: any

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

+

subscribe

subscribe: PlatformEvent<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

event

Accessors

event

Methods

Protected assertNotDisposed

Protected disposeFn

Methods

Protected assertNotDisposed

Protected disposeFn

Protected emitFn

Protected emitFn

emitLocal

emitLocal

Settings

Member Visibility

Theme

On This Page

constructordisposeemitnetworkDisposernetworkSubscribersubscribeeventassertNotDisposeddisposeFnemitFnemitLocal
\ No newline at end of file +

Returns void

Settings

Member Visibility

Theme

On This Page

constructordisposeemitnetworkDisposernetworkSubscribersubscribeeventassertNotDisposeddisposeFnemitFnemitLocal
\ No newline at end of file diff --git a/papi-dts/classes/_shared_models_project_data_provider_engine_model_.ProjectDataProviderEngine.html b/papi-dts/classes/_shared_models_project_data_provider_engine_model_.ProjectDataProviderEngine.html index 1e06371c31..363fa3846f 100644 --- a/papi-dts/classes/_shared_models_project_data_provider_engine_model_.ProjectDataProviderEngine.html +++ b/papi-dts/classes/_shared_models_project_data_provider_engine_model_.ProjectDataProviderEngine.html @@ -8,7 +8,7 @@ If a Project Data Provider Engine class extends this class, it doesn't have to specify its own notifyUpdate function in order to use notifyUpdate.

See

IProjectDataProviderEngine for more information on extending this class.

-

Type Parameters

Hierarchy (view full)

Implements

Constructors

constructor +

Type Parameters

Hierarchy (view full)

Implements

Constructors

constructor

Properties

projectId projectStorageInterpreter projectStorageInterpreterId @@ -25,19 +25,19 @@ setSetting

Constructors

Protected constructor

Properties

Protected Readonly projectId

projectId: string

Protected Readonly projectStorageInterpreter

projectStorageInterpreter: ProjectStorageInterpreters[ProjectType]

Protected Readonly projectStorageInterpreterId

projectStorageInterpreterId: string

Private psiExtensionDataUnsubscriberPromise

psiExtensionDataUnsubscriberPromise: any

Private psiSettingUnsubscriberPromise

psiSettingUnsubscriberPromise: any

Methods

dispose

  • dispose(): Promise<boolean>

  • Disposes of this Project Data Provider Engine. Unsubscribes from listening to the Project +

  • projectStorageInterpreterId: string

Returns "shared/models/project-data-provider-engine.model".ProjectDataProviderEngine<ProjectType>

Properties

Protected Readonly projectId

projectId: string

Protected Readonly projectStorageInterpreter

projectStorageInterpreter: ProjectStorageInterpreters[ProjectType]

Protected Readonly projectStorageInterpreterId

projectStorageInterpreterId: string

Private psiExtensionDataUnsubscriberPromise

psiExtensionDataUnsubscriberPromise: any

Private psiSettingUnsubscriberPromise

psiSettingUnsubscriberPromise: any

Methods

dispose

getExtensionData

Protected getProjectStorageExtensionDataScope

getExtensionData

Protected getProjectStorageExtensionDataScope

Protected getProjectStorageSettingDataScope

Protected getProjectStorageSettingDataScope

getSetting

notifyUpdate

resetSetting

setExtensionData

setSetting

Settings

Member Visibility

Theme

On This Page

constructorprojectIdprojectStorageInterpreterprojectStorageInterpreterIdpsiExtensionDataUnsubscriberPromisepsiSettingUnsubscriberPromisedisposegetExtensionDatagetProjectStorageExtensionDataScopegetProjectStorageSettingDataScopegetSettingnotifyUpdateresetSettingsetExtensionDatasetSetting
\ No newline at end of file +

getSetting

notifyUpdate

resetSetting

setExtensionData

setSetting

Settings

Member Visibility

Theme

On This Page

constructorprojectIdprojectStorageInterpreterprojectStorageInterpreterIdpsiExtensionDataUnsubscriberPromisepsiSettingUnsubscriberPromisedisposegetExtensionDatagetProjectStorageExtensionDataScopegetProjectStorageSettingDataScopegetSettingnotifyUpdateresetSettingsetExtensionDatasetSetting
\ 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 82292b41d7..fc579105d1 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

Enumeration EntryType

Type of file system item in a directory

-

Enumeration Members

Directory +

Enumeration Members

Directory File Unknown -

Enumeration Members

Directory

Directory: "directory"

File

File: "file"

Unknown

Unknown: "unknown"

Settings

Member Visibility

Theme

On This Page

DirectoryFileUnknown
\ No newline at end of file +

Enumeration Members

Directory

Directory: "directory"

File

File: "file"

Unknown

Unknown: "unknown"

Settings

Member Visibility

Theme

On This Page

DirectoryFileUnknown
\ 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 6db9faa47b..329c3bab4c 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

Enumeration ConnectionStatus

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

-

Enumeration Members

Connected +

Enumeration Members

Connected Connecting Disconnected

Enumeration Members

Connected

Connected: 2

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

-

Connecting

Connecting: 1

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

-

Disconnected

Disconnected: 0

This connector is not connected to the network

-

Settings

Member Visibility

Theme

On This Page

ConnectedConnectingDisconnected
\ No newline at end of file +

Connecting

Connecting: 1

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

+

Disconnected

Disconnected: 0

This connector is not connected to the network

+

Settings

Member Visibility

Theme

On This Page

ConnectedConnectingDisconnected
\ 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 d7591d74a7..17a8f909de 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

Enumeration MessageType

WebSocket message type that indicates how to handle it

-

Enumeration Members

ClientConnect +

Enumeration Members

ClientConnect Event InitClient Request Response -

Enumeration Members

ClientConnect

ClientConnect: "client-connect"

Event

Event: "event"

InitClient

InitClient: "init-client"

Request

Request: "request"

Response

Response: "response"

Settings

Member Visibility

Theme

On This Page

ClientConnectEventInitClientRequestResponse
\ No newline at end of file +

Enumeration Members

ClientConnect

ClientConnect: "client-connect"

Event

Event: "event"

InitClient

InitClient: "init-client"

Request

Request: "request"

Response

Response: "response"

Settings

Member Visibility

Theme

On This Page

ClientConnectEventInitClientRequestResponse
\ 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 05049355eb..b69f1f7942 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

Enumeration ProcessType

Type of Paranext process

-

Enumeration Members

ExtensionHost +

Enumeration Members

ExtensionHost Main Renderer -

Enumeration Members

ExtensionHost

ExtensionHost: "extension-host"

Main

Main: "main"

Renderer

Renderer: "renderer"

Settings

Member Visibility

Theme

On This Page

ExtensionHostMainRenderer
\ No newline at end of file +

Enumeration Members

ExtensionHost

ExtensionHost: "extension-host"

Main

Main: "main"

Renderer

Renderer: "renderer"

Settings

Member Visibility

Theme

On This Page

ExtensionHostMainRenderer
\ 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 507e8be1f3..3427fed512 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

Enumeration WebViewContentType

The type of code that defines a webview's content

-

Enumeration Members

HTML +

Enumeration Members

HTML React URL

Enumeration Members

HTML

HTML: "html"

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

-

React

React: "react"

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

React

React: "react"

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

-

URL

URL: "url"

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

URL

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.

-

Settings

Member Visibility

Theme

On This Page

HTMLReactURL
\ No newline at end of file +

Settings

Member Visibility

Theme

On This Page

HTMLReactURL
\ No newline at end of file diff --git a/papi-dts/enums/_shared_utils_util_.RequestHandlerType.html b/papi-dts/enums/_shared_utils_util_.RequestHandlerType.html index 8803769933..b3cef7d47d 100644 --- a/papi-dts/enums/_shared_utils_util_.RequestHandlerType.html +++ b/papi-dts/enums/_shared_utils_util_.RequestHandlerType.html @@ -1,5 +1,5 @@ RequestHandlerType | papi-dts

Enumeration RequestHandlerType

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

-

Enumeration Members

Args +

Enumeration Members

Args Complex Contents -

Enumeration Members

Args

Args: "args"

Complex

Complex: "complex"

Contents

Contents: "contents"

Settings

Member Visibility

Theme

On This Page

ArgsComplexContents
\ No newline at end of file +

Enumeration Members

Args

Args: "args"

Complex

Complex: "complex"

Contents

Contents: "contents"

Settings

Member Visibility

Theme

On This Page

ArgsComplexContents
\ No newline at end of file diff --git a/papi-dts/functions/__papi_backend_.fetch.html b/papi-dts/functions/__papi_backend_.fetch.html index c9823bae1d..0e6bd948ae 100644 --- a/papi-dts/functions/__papi_backend_.fetch.html +++ b/papi-dts/functions/__papi_backend_.fetch.html @@ -1,3 +1,3 @@ fetch | papi-dts

Function fetch

  • fetch(input, init?): Promise<Response>

  • This is just an alias for internet.fetch

    -

    Parameters

    • input: RequestInfo | URL
    • Optional init: RequestInit

    Returns Promise<Response>

  • fetch(input, init?): Promise<Response>

  • This is just an alias for internet.fetch

    -

    Parameters

    • input: string | Request | URL
    • Optional init: RequestInit

    Returns Promise<Response>

Settings

Member Visibility

Theme

\ No newline at end of file +

Parameters

Returns Promise<Response>

  • fetch(input, init?): Promise<Response>

  • This is just an alias for internet.fetch

    +

    Parameters

    Returns Promise<Response>

    • Settings

    Member Visibility

    Theme

    \ No newline at end of file diff --git a/papi-dts/functions/__papi_frontend_.fetch.html b/papi-dts/functions/__papi_frontend_.fetch.html index 9c9b351d16..596450b254 100644 --- a/papi-dts/functions/__papi_frontend_.fetch.html +++ b/papi-dts/functions/__papi_frontend_.fetch.html @@ -1,3 +1,3 @@ fetch | papi-dts

    Function fetch

    • fetch(input, init?): Promise<Response>

    • This is just an alias for internet.fetch

      -

      Parameters

      • input: RequestInfo | URL
      • Optional init: RequestInit

      Returns Promise<Response>

    • fetch(input, init?): Promise<Response>

    • This is just an alias for internet.fetch

      -

      Parameters

      • input: string | Request | URL
      • Optional init: RequestInit

      Returns Promise<Response>

    Settings

    Member Visibility

    Theme

    \ No newline at end of file +

    Parameters

    Returns Promise<Response>

  • fetch(input, init?): Promise<Response>

  • This is just an alias for internet.fetch

    +

    Parameters

    Returns Promise<Response>

    • Settings

    Member Visibility

    Theme

    \ 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 e8849f20db..4340bb7172 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

    Function createWebSocket

    • createWebSocket(url): Promise<WebSocket>

    • Creates a WebSocket for the renderer or extension host depending on where you're running

      Parameters

      • url: string

      Returns Promise<WebSocket>

      WebSocket

      -

    Settings

    Member Visibility

    Theme

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    \ 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 712a0b7813..1ec987176d 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

    Function buildExtensionPathFromName

    • buildExtensionPathFromName(extensionName, fileName): string

    • Return a path to the specified file within the extension's installation directory

      -

      Parameters

      • extensionName: string
      • fileName: string

      Returns string

    Settings

    Member Visibility

    Theme

    \ No newline at end of file +

    Parameters

    Returns string

    Settings

    Member Visibility

    Theme

    \ 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 5b7f4c8fa7..75c68ff682 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

    Function setExtensionUris

    • setExtensionUris(urisPerExtension): void

    • 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

    Settings

    Member Visibility

    Theme

    \ No newline at end of file +

    Parameters

    Returns void

    Settings

    Member Visibility

    Theme

    \ 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 0de33f9c23..30df37a4d7 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>

    Settings

    Member Visibility

    Theme

    \ No newline at end of file +

    Returns Promise<void>

    Settings

    Member Visibility

    Theme

    \ 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 1477c3bcd9..1959d964d6 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

    Function createDir

    • createDir(uri): Promise<void>

    • 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

      -

    Settings

    Member Visibility

    Theme

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    \ 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 55046c1941..be43af2915 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

    Function deleteDir

    • deleteDir(uri): Promise<void>

    • 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

      -

    Settings

    Member Visibility

    Theme

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    \ 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 d9cd88bad7..3dbcd168c0 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

    Function deleteFile

    • deleteFile(uri): Promise<void>

    • 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

      -

    Settings

    Member Visibility

    Theme

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    \ 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 7a4a8ba4e9..13f40f7198 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

    -

    Settings

    Member Visibility

    Theme

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    \ 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 84f2558fca..ad2a251952 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.

    -

    Settings

    Member Visibility

    Theme

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    \ 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 25c0ee7d9f..2603a29ef8 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

    Function readFileBinary

    • readFileBinary(uri): Promise<Buffer>

    • Read a binary file

      Parameters

      • uri: string

        URI of file

      Returns Promise<Buffer>

      Promise that resolves to the contents of the file

      -

    Settings

    Member Visibility

    Theme

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    \ 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 5989998d5e..9796c5f6ee 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

    Function readFileText

    • readFileText(uri): Promise<string>

    • Read a text file

      Parameters

      • uri: string

        URI of file

      Returns Promise<string>

      Promise that resolves to the contents of the file

      -

    Settings

    Member Visibility

    Theme

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    \ 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 6c71a51f97..b8c39d6ac2 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

    Function touch

    • touch(uri, date): Promise<void>

    • 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

      -

    Settings

    Member Visibility

    Theme

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    \ 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 61dd4116a7..d0433ac2df 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

    -

    Settings

    Member Visibility

    Theme

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    \ 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 a686bc4b08..c4c9bbd23e 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

    Function createNonce

    Settings

    Member Visibility

    Theme

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    \ 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 1176fc8215..bfb57b4300 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

    Function createUuid

    Settings

    Member Visibility

    Theme

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

    Function createUuid

    Settings

    Member Visibility

    Theme

    \ No newline at end of file diff --git a/papi-dts/functions/_node_utils_util_.getAppDir.html b/papi-dts/functions/_node_utils_util_.getAppDir.html index 0160c3f633..1d0ee076af 100644 --- a/papi-dts/functions/_node_utils_util_.getAppDir.html +++ b/papi-dts/functions/_node_utils_util_.getAppDir.html @@ -1,5 +1,5 @@ getAppDir | papi-dts

    Function getAppDir

    • getAppDir(this, ...args): string

    • Gets the platform-specific user Platform.Bible folder for this application

      When running in development: <repo_directory>/dev-appdata

      When packaged: <user_home_directory>/.platform.bible

      -

      Parameters

      • this: unknown
      • Rest ...args: []

      Returns string

    Properties

    clear +

    Parameters

    • this: unknown
    • Rest ...args: []

    Returns string

    Properties

    clear

    Properties

    clear

    clear: (() => void)

    Type declaration

      • (): void

      • Returns void

    Settings

    Member Visibility

    Theme

    On This Page

    clear
    \ 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 fbe21ca12f..f93a0b6c44 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

    Function getPathFromUri

    • getPathFromUri(uri): string

    • Resolves the uri to a path

      Parameters

      • uri: string

        The uri to resolve

      Returns string

      Real path to the uri supplied

      -

    Settings

    Member Visibility

    Theme

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    \ 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 5e9a5623b3..d60e94cb04 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

    -

    Settings

    Member Visibility

    Theme

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    \ 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 f8a798e9e2..593a612257 100644 --- a/papi-dts/functions/_node_utils_util_.resolveHtmlPath.html +++ b/papi-dts/functions/_node_utils_util_.resolveHtmlPath.html @@ -1 +1 @@ -resolveHtmlPath | papi-dts

    Function resolveHtmlPath

    Settings

    Member Visibility

    Theme

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

    Function resolveHtmlPath

    Settings

    Member Visibility

    Theme

    \ 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 7c2fa6c550..297b444a47 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

    Settings

    Member Visibility

    Theme

    \ No newline at end of file +

    Returns void

    Settings

    Member Visibility

    Theme

    \ 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 7a1f1508f3..a065b6282e 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

    -

    Settings

    Member Visibility

    Theme

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    \ 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 47e4878714..c35c611c08 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

    -

    Settings

    Member Visibility

    Theme

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    \ 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 79705b0e1a..f2616f5314 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])
    }

    Settings

    Member Visibility

    Theme

    \ 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])
    }

    Settings

    Member Visibility

    Theme

    \ 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 7cb2a898c8..eba985d95c 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

    -

    Settings

    Member Visibility

    Theme

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    \ 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 79abce7709..d1d0bb0cdd 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.

    -

    Settings

    Member Visibility

    Theme

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    \ 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 b31edd8dbe..62c35403f0 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 @@ -59,7 +59,7 @@ specify as many or as few properties here as you want to overwrite the properties in the options you provide to the hook -
  • default<DialogTabType, DialogOptions>(dialogType, options, resolveCallback): ((optionOverrides?) => Promise<void>)

  • Enables using papi.dialogs.showDialog in React more easily. Returns a callback to run that will +

  • default<DialogTabType, DialogOptions>(dialogType, options, resolveCallback): ((optionOverrides?) => Promise<void>)

  • Enables using papi.dialogs.showDialog in React more easily. Returns a callback to run that will open a dialog with the provided dialogType and options then run the resolveCallback with the dialog response or rejectCallback if there is an error. By default, only one dialog can be open at a time.

    @@ -105,4 +105,4 @@ specify as many or as few properties here as you want to overwrite the properties in the options you provide to the hook
    • -

    Settings

    Member Visibility

    Theme

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    \ 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 91fd6cdc56..1e8fdf7ae6 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 @@ -37,4 +37,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?) => [ProjectDataTypes[ProjectType][TDataType]["getData"], undefined | ((newData) => Promise<DataProviderUpdateInstructions<ProjectDataTypes[ProjectType]>>), boolean])
    }

    Settings

    Member Visibility

    Theme

    \ 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])
    }

    Settings

    Member Visibility

    Theme

    \ 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 d471c76694..3c90f101f5 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 | ProjectDataProviders[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

    -

    Settings

    Member Visibility

    Theme

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    \ No newline at end of file diff --git a/papi-dts/functions/_renderer_hooks_papi_hooks_use_project_setting_hook_.default.html b/papi-dts/functions/_renderer_hooks_papi_hooks_use_project_setting_hook_.default.html index d0bd6dce76..2efed75cf3 100644 --- a/papi-dts/functions/_renderer_hooks_papi_hooks_use_project_setting_hook_.default.html +++ b/papi-dts/functions/_renderer_hooks_papi_hooks_use_project_setting_hook_.default.html @@ -31,4 +31,4 @@

    Throws

    When subscription callback function is called with an update that has an unexpected message type

    -

    Settings

    Member Visibility

    Theme

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    \ 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 99a7610a4a..ef783ac785 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 @@ -18,4 +18,4 @@

    Throws

    When subscription callback function is called with an update that has an unexpected message type

    -

    Settings

    Member Visibility

    Theme

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    \ 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 77807e5b45..e85300ffa1 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

    Function blockWebSocketsToPapiNetwork

    • blockWebSocketsToPapiNetwork(): void

    • Once our network is running, run this to stop extensions from connecting to it directly

      -

      Returns void

    Settings

    Member Visibility

    Theme

    \ No newline at end of file +

    Returns void

    Settings

    Member Visibility

    Theme

    \ 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 a6d183e801..466f6b99a2 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

    Function getDataProviderDataTypeFromFunctionName

    Settings

    Member Visibility

    Theme

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    \ 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 2d7349f77f..ba0132ddf9 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

    Function addThree

    Settings

    Member Visibility

    Theme

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

    Function addThree

    Settings

    Member Visibility

    Theme

    \ 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 e4d387f70c..8252e7caca 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

    -

    Settings

    Member Visibility

    Theme

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    \ 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 460ab76461..36cabefc69 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

    Function initialize

    • initialize(): Promise<void>

    • Sets up the CommandService. Only runs once and always returns the same promise after that

      -

      Returns Promise<void>

    Settings

    Member Visibility

    Theme

    \ No newline at end of file +

    Returns Promise<void>

    Settings

    Member Visibility

    Theme

    \ 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 0a1ab01627..8d1231bd27 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

    -

    Settings

    Member Visibility

    Theme

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    \ 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 ddc1a8b480..036cb3b9e2 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

    Function sendCommand

    Settings

    Member Visibility

    Theme

    \ No newline at end of file +

    Type Parameters

    Parameters

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

    Settings

    Member Visibility

    Theme

    \ 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 5f1317e592..4b5eba811f 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

    Function squareAndConcat

    Settings

    Member Visibility

    Theme

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

    Function squareAndConcat

    Settings

    Member Visibility

    Theme

    \ 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 7125e61d36..ff3df8f7ba 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

    -

    Settings

    Member Visibility

    Theme

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    \ 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 5822f91479..c52cbb2970 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

    Function disconnect

    Settings

    Member Visibility

    Theme

    \ No newline at end of file +

    Returns void

    Settings

    Member Visibility

    Theme

    \ 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 404e0ec6bb..9a2e698fc7 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>

    Settings

    Member Visibility

    Theme

    \ No newline at end of file +

    Returns Promise<void>

    Settings

    Member Visibility

    Theme

    \ 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 a1b0998c6a..d37b37f07e 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

    Function getClientId

    Settings

    Member Visibility

    Theme

    \ No newline at end of file +

    Returns number

    Settings

    Member Visibility

    Theme

    \ 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 646245a123..c9c4abe43b 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

    -

    Settings

    Member Visibility

    Theme

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    \ 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 f6b2e8978b..adc416907e 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

    Function getByType

    • getByType<T>(providerName): Promise<T | undefined>

    • 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

      -

    Settings

    Member Visibility

    Theme

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    \ 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 063d7f38e5..b1a6a36e9d 100644 --- a/papi-dts/functions/_shared_services_data_provider_service_.registerEngineByType.html +++ b/papi-dts/functions/_shared_services_data_provider_service_.registerEngineByType.html @@ -12,4 +12,4 @@ set methods are layered over to facilitate data provider subscriptions.

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

    The data provider including control over disposing of it. Note that this data provider is a new object distinct from the data provider engine passed in.

    -

    Settings

    Member Visibility

    Theme

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    \ 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 527feed64f..40aec44baa 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

    -

    Settings

    Member Visibility

    Theme

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    \ 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 02c84744f7..28fe5fad26 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

    Function createNetworkConnector

    Settings

    Member Visibility

    Theme

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    \ 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 f3e696dac0..1d19c03818 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

    Function onDidCreateNetworkObject

    • onDidCreateNetworkObject(callback): Unsubscriber

    • Event that fires when a new object has been created on the network (locally or remotely). The event contains information about the new network object.

      -

      Parameters

      Returns Unsubscriber

    Settings

    Member Visibility

    Theme

    \ No newline at end of file +

    Parameters

    Returns Unsubscriber

    Settings

    Member Visibility

    Theme

    \ 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 fc09c0519a..50bf513c39 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

    Function onDidDisposeNetworkObject

    • onDidDisposeNetworkObject(callback): Unsubscriber

    • Event that fires with a network object ID when that object is disposed locally or remotely

      -

      Parameters

      • callback: PlatformEventHandler<string>

      Returns Unsubscriber

    Settings

    Member Visibility

    Theme

    \ No newline at end of file +

    Parameters

    Returns Unsubscriber

    Settings

    Member Visibility

    Theme

    \ 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 e924c48fcc..a979d5765d 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

    Function overrideDispose

    • overrideDispose(objectToMutate, newDispose): void

    • If dispose already exists on objectToMutate, we will call it in addition to newDispose

      -

      Parameters

      • objectToMutate: IDisposableObject
      • newDispose: UnsubscriberAsync

      Returns void

    Settings

    Member Visibility

    Theme

    \ No newline at end of file +

    Parameters

    Returns void

    Settings

    Member Visibility

    Theme

    \ 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 85287f3d0f..5a7b08d578 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 PlatformEventEmitter<T>

    Event emitter whose event works between connections

    -

    Settings

    Member Visibility

    Theme

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    \ 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 6fb8466679..3fd755c621 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

    -

    Settings

    Member Visibility

    Theme

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    \ 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 e6a412d697..6616623f8c 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

    Function getNetworkEvent

    • getNetworkEvent<T>(eventType): PlatformEvent<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 PlatformEvent<T>

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

      -

    Settings

    Member Visibility

    Theme

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    \ 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 3c614fad5d..bb55f4d01f 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

    Function initialize

    Settings

    Member Visibility

    Theme

    \ No newline at end of file +

    Returns Promise<void>

    Settings

    Member Visibility

    Theme

    \ 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 1b88321986..ecb6696c9c 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

    Function onDidClientConnect

    Settings

    Member Visibility

    Theme

    \ No newline at end of file +

    Parameters

    Returns Unsubscriber

    Settings

    Member Visibility

    Theme

    \ 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 50b4b11570..a9f41a2584 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

    Function onDidClientDisconnect

    Settings

    Member Visibility

    Theme

    \ No newline at end of file +

    Parameters

    Returns Unsubscriber

    Settings

    Member Visibility

    Theme

    \ 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 f2b43ab1b3..5229726644 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

    -
  • registerRequestHandler(requestType, handler, handlerType?): Promise<UnsubscriberAsync>

  • Parameters

    Returns Promise<UnsubscriberAsync>

  • registerRequestHandler(requestType, handler, handlerType?): Promise<UnsubscriberAsync>

  • Parameters

    Returns Promise<UnsubscriberAsync>

    • Settings

    Member Visibility

    Theme

    \ No newline at end of file +
  • registerRequestHandler(requestType, handler, handlerType?): Promise<UnsubscriberAsync>

  • Parameters

    Returns Promise<UnsubscriberAsync>

  • registerRequestHandler(requestType, handler, handlerType?): Promise<UnsubscriberAsync>

  • Parameters

    Returns Promise<UnsubscriberAsync>

    • Settings

    Member Visibility

    Theme

    \ 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 a3e400ddb3..86eafa6b09 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

    -

    Settings

    Member Visibility

    Theme

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    \ 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 f61d8e24ba..af30e7ce96 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

    Function shutdown

    Settings

    Member Visibility

    Theme

    \ No newline at end of file +

    Returns void

    Settings

    Member Visibility

    Theme

    \ 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 56533e60ee..fba183bf9a 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<ProjectDataProviders[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'));
    -

    Settings

    Member Visibility

    Theme

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    \ 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 9303676970..fbe25ed40b 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

    -

    Settings

    Member Visibility

    Theme

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    \ No newline at end of file diff --git a/papi-dts/functions/_shared_services_project_lookup_service_.filterProjectsMetadata.html b/papi-dts/functions/_shared_services_project_lookup_service_.filterProjectsMetadata.html index 0962d5d8cc..0bf70f9083 100644 --- a/papi-dts/functions/_shared_services_project_lookup_service_.filterProjectsMetadata.html +++ b/papi-dts/functions/_shared_services_project_lookup_service_.filterProjectsMetadata.html @@ -1 +1 @@ -filterProjectsMetadata | papi-dts

    Function filterProjectsMetadata

    Settings

    Member Visibility

    Theme

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

    Function filterProjectsMetadata

    Settings

    Member Visibility

    Theme

    \ 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 ed079f8396..cf3d360195 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

    Function getProcessType

    Settings

    Member Visibility

    Theme

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    \ 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 b154e46d5a..948cbf270e 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

    Function isClient

    • isClient(): boolean

    • 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

      -

    Settings

    Member Visibility

    Theme

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    \ 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 adc389511b..cc913fada7 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

    Function isExtensionHost

    • isExtensionHost(): boolean

    • Determine if running on the extension host

      Returns boolean

      Returns true if running on the extension host, false otherwise

      -

    Settings

    Member Visibility

    Theme

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    \ 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 7acc5a4ad4..19faf28f8d 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

    Function isRenderer

    • isRenderer(): boolean

    • Determine if running on the renderer process

      Returns boolean

      Returns true if running on the renderer, false otherwise

      -

    Settings

    Member Visibility

    Theme

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    \ 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 46140322a7..f9f19aea3f 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

    Function isServer

    • isServer(): boolean

    • Determine if running on the server process (main)

      Returns boolean

      Returns true if running on the server, false otherwise

      -

    Settings

    Member Visibility

    Theme

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    \ No newline at end of file diff --git a/papi-dts/functions/_shared_utils_util_.createSafeRegisterFn.html b/papi-dts/functions/_shared_utils_util_.createSafeRegisterFn.html index c26b5a7d43..9f36f82d42 100644 --- a/papi-dts/functions/_shared_utils_util_.createSafeRegisterFn.html +++ b/papi-dts/functions/_shared_utils_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)

    -

    Settings

    Member Visibility

    Theme

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    \ No newline at end of file diff --git a/papi-dts/functions/_shared_utils_util_.deserializeRequestType.html b/papi-dts/functions/_shared_utils_util_.deserializeRequestType.html index 61238d63a2..1132d92d05 100644 --- a/papi-dts/functions/_shared_utils_util_.deserializeRequestType.html +++ b/papi-dts/functions/_shared_utils_util_.deserializeRequestType.html @@ -1,2 +1,2 @@ deserializeRequestType | papi-dts

    Function deserializeRequestType

    Settings

    Member Visibility

    Theme

    \ No newline at end of file +

    Parameters

    Returns RequestType

    Settings

    Member Visibility

    Theme

    \ No newline at end of file diff --git a/papi-dts/functions/_shared_utils_util_.getModuleSimilarApiMessage.html b/papi-dts/functions/_shared_utils_util_.getModuleSimilarApiMessage.html index 5e9a0341da..bbbdbd0e10 100644 --- a/papi-dts/functions/_shared_utils_util_.getModuleSimilarApiMessage.html +++ b/papi-dts/functions/_shared_utils_util_.getModuleSimilarApiMessage.html @@ -1,4 +1,4 @@ getModuleSimilarApiMessage | papi-dts

    Function getModuleSimilarApiMessage

    • getModuleSimilarApiMessage(moduleName): string

    • 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

      -

    Settings

    Member Visibility

    Theme

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    \ 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 04683f7350..e8ed8f2704 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

    Settings

    Member Visibility

    Theme

    \ No newline at end of file +

    Returns string

    Settings

    Member Visibility

    Theme

    \ No newline at end of file diff --git a/papi-dts/functions/_shared_utils_util_.serializeRequestType.html b/papi-dts/functions/_shared_utils_util_.serializeRequestType.html index 596e71e2b1..84114c8f66 100644 --- a/papi-dts/functions/_shared_utils_util_.serializeRequestType.html +++ b/papi-dts/functions/_shared_utils_util_.serializeRequestType.html @@ -2,4 +2,4 @@

    Parameters

    Returns SerializedRequestType

    Full requestType for use in network calls

    -

    Settings

    Member Visibility

    Theme

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

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

    Function getWebViewDefinitionUpdatableProperties

    Settings

    Member Visibility

    Theme

    \ No newline at end of file +

    Returns undefined | WebViewDefinitionUpdatableProperties

    Settings

    Member Visibility

    Theme

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

    Function getWebViewDefinitionUpdatablePropertiesById

    Settings

    Member Visibility

    Theme

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

    Function getWebViewDefinitionUpdatablePropertiesById

    Settings

    Member Visibility

    Theme

    \ No newline at end of file diff --git a/papi-dts/functions/getWebViewState.html b/papi-dts/functions/getWebViewState.html index a291fe063f..5ea09ff8d3 100644 --- a/papi-dts/functions/getWebViewState.html +++ b/papi-dts/functions/getWebViewState.html @@ -1,3 +1,3 @@ getWebViewState | papi-dts

    Function getWebViewState

    • getWebViewState<T>(stateKey, defaultValue): T

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

      -

      Type Parameters

      • T

      Parameters

      • stateKey: string
      • defaultValue: T

      Returns T

    Settings

    Member Visibility

    Theme

    \ No newline at end of file +

    Type Parameters

    Parameters

    Returns T

    Settings

    Member Visibility

    Theme

    \ No newline at end of file diff --git a/papi-dts/functions/resetWebViewState.html b/papi-dts/functions/resetWebViewState.html index 5c449b5b94..04975b9ef3 100644 --- a/papi-dts/functions/resetWebViewState.html +++ b/papi-dts/functions/resetWebViewState.html @@ -1,2 +1,2 @@ resetWebViewState | papi-dts

    Function resetWebViewState

    • resetWebViewState(stateKey): void

    • Remove the value for a given key in the web view state

      -

      Parameters

      • stateKey: string

      Returns void

    Settings

    Member Visibility

    Theme

    \ No newline at end of file +

    Parameters

    Returns void

    Settings

    Member Visibility

    Theme

    \ No newline at end of file diff --git a/papi-dts/functions/setWebViewState.html b/papi-dts/functions/setWebViewState.html index 99bcd1881c..e799b73d6f 100644 --- a/papi-dts/functions/setWebViewState.html +++ b/papi-dts/functions/setWebViewState.html @@ -1,2 +1,2 @@ setWebViewState | papi-dts

    Function setWebViewState

    • setWebViewState<T>(stateKey, stateValue): void

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

      -

      Type Parameters

      • T

      Parameters

      • stateKey: string
      • stateValue: T

      Returns void

    Settings

    Member Visibility

    Theme

    \ No newline at end of file +

    Type Parameters

    Parameters

    Returns void

    Settings

    Member Visibility

    Theme

    \ No newline at end of file diff --git a/papi-dts/functions/updateWebViewDefinition.html b/papi-dts/functions/updateWebViewDefinition.html index 0e91b8e28b..63b80a1e00 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

    Settings

    Member Visibility

    Theme

    \ No newline at end of file +

    Parameters

    Returns boolean

    Settings

    Member Visibility

    Theme

    \ No newline at end of file diff --git a/papi-dts/functions/updateWebViewDefinitionById.html b/papi-dts/functions/updateWebViewDefinitionById.html index 4c926ac5a7..6a972fd2b7 100644 --- a/papi-dts/functions/updateWebViewDefinitionById.html +++ b/papi-dts/functions/updateWebViewDefinitionById.html @@ -1 +1 @@ -updateWebViewDefinitionById | papi-dts

    Function updateWebViewDefinitionById

    Settings

    Member Visibility

    Theme

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

    Function updateWebViewDefinitionById

    Settings

    Member Visibility

    Theme

    \ No newline at end of file diff --git a/papi-dts/functions/useWebViewState.html b/papi-dts/functions/useWebViewState.html index 106fc54944..a0730d2724 100644 --- a/papi-dts/functions/useWebViewState.html +++ b/papi-dts/functions/useWebViewState.html @@ -24,4 +24,4 @@

    ＠example

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

    Type Parameters

    Parameters

    Returns [webViewStateValue: T, setWebViewState: ((stateValue) => void), resetWebViewState: (() => void)]

    Settings

    Member Visibility

    Theme

    \ No newline at end of file +

    Type Parameters

    Parameters

    Returns [webViewStateValue: T, setWebViewState: ((stateValue) => void), resetWebViewState: (() => void)]

    Settings

    Member Visibility

    Theme

    \ No newline at end of file diff --git a/papi-dts/functions/webViewComponent.html b/papi-dts/functions/webViewComponent.html index 6f1797fbe6..27bf2be5a1 100644 --- a/papi-dts/functions/webViewComponent.html +++ b/papi-dts/functions/webViewComponent.html @@ -1,6 +1,6 @@ webViewComponent | papi-dts

    Function webViewComponent

    • webViewComponent(props, context?): ReactNode

    • A function that each React WebView extension must provide for Paranext to display it. Only used in WebView iframes.

      -

      Parameters

      Returns ReactNode

    Properties

    contextTypes? +

    Parameters

    Returns ReactNode

    Properties

    contextTypes? defaultProps? displayName? propTypes? 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 053516d6e9..428b62a5b5 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 IExtension

    Interface for all extensions to implement

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

    Properties

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

    Properties

    activate deactivate?

    Properties

    activate

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

    Sets up this extension! Runs when paranext wants this extension to activate. For example, activate() should register commands for this extension

    Type declaration

      • (context): Promise<void>

      • Parameters

        Returns Promise<void>

    Optional deactivate

    deactivate?: UnsubscriberAsync

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

    Returns Promise<void>

    Optional deactivate

    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

    -

    Settings

    Member Visibility

    Theme

    On This Page

    activatedeactivate
    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    On This Page

    activatedeactivate
    \ 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 46a2a849fe..cbdf99adbd 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

    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

    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 readBinaryFileFromInstallDirectory readTextFileFromInstallDirectory readUserData @@ -8,23 +8,23 @@

    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

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

    Type declaration

      • (token, fileName): Promise<Buffer>

      • Read a binary file from the the extension's installation directory

        +

    readBinaryFileFromInstallDirectory

    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

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

    Type declaration

      • (token, fileName): Promise<string>

      • Read a text file from the the extension's installation directory

        +

    readTextFileFromInstallDirectory

    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

    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

    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

    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

    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

        -

    Settings

    Member Visibility

    Theme

    On This Page

    deleteUserDatareadBinaryFileFromInstallDirectoryreadTextFileFromInstallDirectoryreadUserDatawriteUserData
    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    On This Page

    deleteUserDatareadBinaryFileFromInstallDirectoryreadTextFileFromInstallDirectoryreadUserDatawriteUserData
    \ 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 90e31d1487..3c69cc28b2 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

    platform.quit +
    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 platform.restartExtensionHost test.addMany test.echo @@ -14,4 +14,4 @@ test.echoRenderer test.throwError test.throwErrorExtensionHost -

    Properties

    platform.quit

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

    Type declaration

      • (): Promise<void>

      • Returns Promise<void>

    platform.restartExtensionHost

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

    Type declaration

      • (): Promise<void>

      • Returns Promise<void>

    test.addMany

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

    Type declaration

      • (...nums): number

      • Parameters

        • Rest ...nums: number[]

        Returns number

    test.echo

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

    Type declaration

      • (message): string

      • Parameters

        • message: string

        Returns string

    test.echoExtensionHost

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

    Type declaration

      • (message): Promise<string>

      • Parameters

        • message: string

        Returns Promise<string>

    test.echoRenderer

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

    Type declaration

      • (message): Promise<string>

      • Parameters

        • message: string

        Returns Promise<string>

    test.throwError

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

    Type declaration

      • (message): void

      • Parameters

        • message: string

        Returns void

    test.throwErrorExtensionHost

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

    Type declaration

      • (message): void

      • Parameters

        • message: string

        Returns void

    Settings

    Member Visibility

    Theme

    On This Page

    platform.quitplatform.restartExtensionHosttest.addManytest.echotest.echoExtensionHosttest.echoRenderertest.throwErrortest.throwErrorExtensionHost
    \ No newline at end of file +

    Properties

    platform.quit

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

    Type declaration

      • (): Promise<void>

      • Returns Promise<void>

    platform.restartExtensionHost

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

    Type declaration

      • (): Promise<void>

      • Returns Promise<void>

    test.addMany

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

    Type declaration

      • (...nums): number

      • Parameters

        • Rest ...nums: number[]

        Returns number

    test.echo

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

    Type declaration

      • (message): string

      • Parameters

        • message: string

        Returns string

    test.echoExtensionHost

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

    Type declaration

      • (message): Promise<string>

      • Parameters

        • message: string

        Returns Promise<string>

    test.echoRenderer

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

    Type declaration

      • (message): Promise<string>

      • Parameters

        • message: string

        Returns Promise<string>

    test.throwError

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

    Type declaration

      • (message): void

      • Parameters

        • message: string

        Returns void

    test.throwErrorExtensionHost

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

    Type declaration

      • (message): void

      • Parameters

        • message: string

        Returns void

    Settings

    Member Visibility

    Theme

    On This Page

    platform.quitplatform.restartExtensionHosttest.addManytest.echotest.echoExtensionHosttest.echoRenderertest.throwErrortest.throwErrorExtensionHost
    \ 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 54c18d0f2c..2f8e1b5601 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>;
    }

    Properties

    platform.placeholder +
    interface DataProviders {
        platform.placeholder: "shared/models/data-provider.interface".default<PlaceholderDataTypes>;
        platform.stuff: "shared/models/data-provider.interface".default<StuffDataTypes>;
    }

    Properties

    platform.placeholder platform.stuff -

    Properties

    platform.placeholder

    platform.placeholder: "shared/models/data-provider.interface".default<PlaceholderDataTypes>

    platform.stuff

    platform.stuff: "shared/models/data-provider.interface".default<StuffDataTypes>

    Settings

    Member Visibility

    Theme

    On This Page

    platform.placeholderplatform.stuff
    \ No newline at end of file +

    Properties

    platform.placeholder

    platform.placeholder: "shared/models/data-provider.interface".default<PlaceholderDataTypes>

    platform.stuff

    platform.stuff: "shared/models/data-provider.interface".default<StuffDataTypes>

    Settings

    Member Visibility

    Theme

    On This Page

    platform.placeholderplatform.stuff
    \ No newline at end of file diff --git a/papi-dts/interfaces/_papi_shared_types_.ProjectDataProviders.html b/papi-dts/interfaces/_papi_shared_types_.ProjectDataProviders.html index c2c0d3daa8..51ea76e834 100644 --- a/papi-dts/interfaces/_papi_shared_types_.ProjectDataProviders.html +++ b/papi-dts/interfaces/_papi_shared_types_.ProjectDataProviders.html @@ -18,6 +18,6 @@ are adding a Project Data Provider type for the MyExtensionProjectTypeName projectType):

    Example

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

      export interface ProjectDataProviders {
        MyExtensionProjectTypeName: IDataProvider<MyProjectDataTypes>;
      }
    }
    -
    interface ProjectDataProviders {
        platform.notesOnly: IProjectDataProvider<NotesOnlyProjectDataTypes>;
        platform.placeholder: IProjectDataProvider<PlaceholderDataTypes>;
    }

    Properties

    platform.notesOnly +
    interface ProjectDataProviders {
        platform.notesOnly: IProjectDataProvider<NotesOnlyProjectDataTypes>;
        platform.placeholder: IProjectDataProvider<PlaceholderDataTypes>;
    }

    Properties

    platform.notesOnly platform.placeholder -

    Properties

    platform.notesOnly

    platform.notesOnly: IProjectDataProvider<NotesOnlyProjectDataTypes>

    platform.placeholder

    platform.placeholder: IProjectDataProvider<PlaceholderDataTypes>

    Settings

    Member Visibility

    Theme

    On This Page

    platform.notesOnlyplatform.placeholder
    \ No newline at end of file +

    Properties

    platform.notesOnly

    platform.notesOnly: IProjectDataProvider<NotesOnlyProjectDataTypes>

    platform.placeholder

    platform.placeholder: IProjectDataProvider<PlaceholderDataTypes>

    Settings

    Member Visibility

    Theme

    On This Page

    platform.notesOnlyplatform.placeholder
    \ No newline at end of file diff --git a/papi-dts/interfaces/_papi_shared_types_.ProjectSettingTypes.html b/papi-dts/interfaces/_papi_shared_types_.ProjectSettingTypes.html index cbdab87ff8..eac8262ee0 100644 --- a/papi-dts/interfaces/_papi_shared_types_.ProjectSettingTypes.html +++ b/papi-dts/interfaces/_papi_shared_types_.ProjectSettingTypes.html @@ -9,13 +9,13 @@ myExtension.highlightColor project setting):

    Example

    declare module 'papi-shared-types' {
      export interface ProjectSettingTypes {
        'myExtension.highlightColor': string | { r: number; g: number; b: number };
      }
    }
    -
    interface ProjectSettingTypes {
        platform.fullName: string;
        platform.language: string;
    }

    Properties

    platform.fullName +
    interface ProjectSettingTypes {
        platform.fullName: string;
        platform.language: string;
    }

    Properties

    platform.fullName platform.language

    Properties

    platform.fullName

    platform.fullName: string

    Localized full name of the project. This will be displayed directly in the UI.

    Example

    'World English Bible'
    -

    platform.language

    platform.language: string

    Localized name of the language in which this project is written. This will be displayed +

    platform.language

    platform.language: string

    Localized name of the language in which this project is written. This will be displayed directly in the UI.

    Example

    'English'
    -

    Settings

    Member Visibility

    Theme

    On This Page

    platform.fullNameplatform.language
    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    On This Page

    platform.fullNameplatform.language
    \ No newline at end of file diff --git a/papi-dts/interfaces/_papi_shared_types_.ProjectStorageInterpreters.html b/papi-dts/interfaces/_papi_shared_types_.ProjectStorageInterpreters.html index 75f8860c46..7f1880a1e7 100644 --- a/papi-dts/interfaces/_papi_shared_types_.ProjectStorageInterpreters.html +++ b/papi-dts/interfaces/_papi_shared_types_.ProjectStorageInterpreters.html @@ -16,6 +16,6 @@ adding a Project Storage Interpreter type for the MyExtensionProjectTypeName projectType):

    Example

    declare module 'papi-shared-types' {
      export type MyProjectStorageDataType = MandatoryProjectStorageDataTypes & {
        ProjectData: DataProviderDataType<
          { projectId: string; section: number },
          string | undefined,
          string
        >;
      };

      export interface ProjectStorageInterpreters {
        MyExtensionProjectTypeName: IProjectStorageInterpreter<MyProjectStorageDataType>;
      }
    }
    -
    interface ProjectStorageInterpreters {
        platform.notesOnly: IProjectStorageInterpreter<DefaultProjectStorageDataTypes>;
        platform.placeholder: IProjectStorageInterpreter<DefaultProjectStorageDataTypes>;
    }

    Properties

    platform.notesOnly +
    interface ProjectStorageInterpreters {
        platform.notesOnly: IProjectStorageInterpreter<DefaultProjectStorageDataTypes>;
        platform.placeholder: IProjectStorageInterpreter<DefaultProjectStorageDataTypes>;
    }

    Properties

    platform.notesOnly platform.placeholder -

    Properties

    platform.notesOnly

    platform.notesOnly: IProjectStorageInterpreter<DefaultProjectStorageDataTypes>

    platform.placeholder

    platform.placeholder: IProjectStorageInterpreter<DefaultProjectStorageDataTypes>

    Settings

    Member Visibility

    Theme

    On This Page

    platform.notesOnlyplatform.placeholder
    \ No newline at end of file +

    Properties

    platform.notesOnly

    platform.notesOnly: IProjectStorageInterpreter<DefaultProjectStorageDataTypes>

    platform.placeholder

    platform.placeholder: IProjectStorageInterpreter<DefaultProjectStorageDataTypes>

    Settings

    Member Visibility

    Theme

    On This Page

    platform.notesOnlyplatform.placeholder
    \ 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 4c5aad6bd3..55d256dbd9 100644 --- a/papi-dts/interfaces/_papi_shared_types_.SettingTypes.html +++ b/papi-dts/interfaces/_papi_shared_types_.SettingTypes.html @@ -8,6 +8,6 @@ myExtension.highlightColor setting):

    Example

    declare module 'papi-shared-types' {
      export interface SettingTypes {
        'myExtension.highlightColor': string | { r: number; g: number; b: number };
      }
    }
    -
    interface SettingTypes {
        platform.interfaceLanguage: string[];
        platform.verseRef: ScriptureReference;
    }

    Properties

    platform.interfaceLanguage +
    interface SettingTypes {
        platform.interfaceLanguage: string[];
        platform.verseRef: ScriptureReference;
    }

    Properties

    platform.interfaceLanguage platform.verseRef -

    Properties

    platform.interfaceLanguage

    platform.interfaceLanguage: string[]

    platform.verseRef

    platform.verseRef: ScriptureReference

    Settings

    Member Visibility

    Theme

    On This Page

    platform.interfaceLanguageplatform.verseRef
    \ No newline at end of file +

    Properties

    platform.interfaceLanguage

    platform.interfaceLanguage: string[]

    platform.verseRef

    platform.verseRef: ScriptureReference

    Settings

    Member Visibility

    Theme

    On This Page

    platform.interfaceLanguageplatform.verseRef
    \ 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 6afe7b4b40..4e9c79b7f8 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

    Interface DialogTypes

    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

    -
    interface DialogTypes {
        platform.selectMultipleProjects: DialogDataTypes<SelectMultipleProjectsDialogOptions, string[]>;
        platform.selectProject: DialogDataTypes<ProjectDialogOptionsBase, string>;
    }

    Properties

    platform.selectMultipleProjects +
    interface DialogTypes {
        platform.selectMultipleProjects: DialogDataTypes<SelectMultipleProjectsDialogOptions, string[]>;
        platform.selectProject: DialogDataTypes<ProjectDialogOptionsBase, string>;
    }

    Properties

    platform.selectMultipleProjects platform.selectProject -

    Properties

    platform.selectMultipleProjects

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

    platform.selectProject

    platform.selectProject: DialogDataTypes<ProjectDialogOptionsBase, string>

    Settings

    Member Visibility

    Theme

    On This Page

    platform.selectMultipleProjectsplatform.selectProject
    \ No newline at end of file +

    Properties

    platform.selectMultipleProjects

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

    platform.selectProject

    platform.selectProject: DialogDataTypes<ProjectDialogOptionsBase, string>

    Settings

    Member Visibility

    Theme

    On This Page

    platform.selectMultipleProjectsplatform.selectProject
    \ 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 29e56c17f1..404eb4e173 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

    Interface FloatLayout

    Information about a floating window

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

    Properties

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

    Properties

    floatSize? position? type -

    Properties

    Optional floatSize

    floatSize?: FloatSize

    Optional position

    position?: FloatPosition

    Where to display the floating window. Defaults to cascade

    -

    type

    type: "float"

    Settings

    Member Visibility

    Theme

    On This Page

    floatSizepositiontype
    \ No newline at end of file +

    Properties

    Optional floatSize

    floatSize?: FloatSize

    Optional position

    position?: FloatPosition

    Where to display the floating window. Defaults to cascade

    +

    type

    type: "float"

    Settings

    Member Visibility

    Theme

    On This Page

    floatSizepositiontype
    \ 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 9258108f0c..c0dab39962 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

    Interface PanelLayout

    Information about a panel

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

    Properties

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

    Properties

    direction? targetTabId? type -

    Properties

    Optional direction

    direction?: PanelDirection

    Optional targetTabId

    targetTabId?: string

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

    -

    type

    type: "panel"

    Settings

    Member Visibility

    Theme

    On This Page

    directiontargetTabIdtype
    \ No newline at end of file +

    Properties

    Optional direction

    direction?: PanelDirection

    Optional targetTabId

    targetTabId?: string

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

    +

    type

    type: "panel"

    Settings

    Member Visibility

    Theme

    On This Page

    directiontargetTabIdtype
    \ 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 9f58193c1a..3bf2ef72a6 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

    Interface TabLayout

    Information about a tab in a panel

    -
    interface TabLayout {
        type: "tab";
    }

    Properties

    type -

    Properties

    type

    type: "tab"

    Settings

    Member Visibility

    Theme

    On This Page

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

    Properties

    type +

    Properties

    type

    type: "tab"

    Settings

    Member Visibility

    Theme

    On This Page

    type
    \ No newline at end of file diff --git a/papi-dts/interfaces/_shared_models_project_data_provider_engine_model_.IProjectDataProviderEngineFactory.html b/papi-dts/interfaces/_shared_models_project_data_provider_engine_model_.IProjectDataProviderEngineFactory.html index 77c00aa913..96d66fdbaf 100644 --- a/papi-dts/interfaces/_shared_models_project_data_provider_engine_model_.IProjectDataProviderEngineFactory.html +++ b/papi-dts/interfaces/_shared_models_project_data_provider_engine_model_.IProjectDataProviderEngineFactory.html @@ -8,7 +8,7 @@

    Project Data Provider Engine Factories create Project Data Provider Engines for a specific projectType. For each project available, a new instance of a PDP with that project's projectType is created by the Project Data Provider Factory with that project's projectType.

    -
    interface IProjectDataProviderEngineFactory<ProjectType> {
        createProjectDataProviderEngine(projectId, projectStorageInterpreterId): ProjectDataProviderEngineTypes[ProjectType];
    }

    Type Parameters

    Methods

    createProjectDataProviderEngine +
    interface IProjectDataProviderEngineFactory<ProjectType> {
        createProjectDataProviderEngine(projectId, projectStorageInterpreterId): ProjectDataProviderEngineTypes[ProjectType];
    }

    Type Parameters

    Methods

    createProjectDataProviderEngine

    Methods

    createProjectDataProviderEngine

    • createProjectDataProviderEngine(projectId, projectStorageInterpreterId): ProjectDataProviderEngineTypes[ProjectType]

    • Create a IProjectDataProviderEngine for the project requested so the papi can create an IProjectDataProvider for the project. This project will have the same projectType as this Project Data Provider Engine Factory

      @@ -16,4 +16,4 @@
    • projectStorageInterpreterId: string

      Id of the IProjectStorageInterpreter that the IProjectDataProviderEngine should use to retrieve project data

    Returns ProjectDataProviderEngineTypes[ProjectType]

    A IProjectDataProviderEngine for the project passed in

    -

    Settings

    Member Visibility

    Theme

    On This Page

    createProjectDataProviderEngine
    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    On This Page

    createProjectDataProviderEngine
    \ No newline at end of file diff --git a/papi-dts/interfaces/_shared_models_project_data_provider_factory_interface_.default.html b/papi-dts/interfaces/_shared_models_project_data_provider_factory_interface_.default.html index ecd4cc75de..4d041e61e3 100644 --- a/papi-dts/interfaces/_shared_models_project_data_provider_factory_interface_.default.html +++ b/papi-dts/interfaces/_shared_models_project_data_provider_factory_interface_.default.html @@ -2,10 +2,10 @@ the papi. These are created internally within the platform to layer over TypeScript-extension-provided IProjectDataProviderEngineFactory or are created by independent processes on the papi.

    -
    interface default {
        dispose: UnsubscriberAsync;
        getProjectDataProviderId(projectId, projectStorageInterpreterId): Promise<string>;
    }

    Hierarchy

    Properties

    dispose +
    interface default {
        dispose: UnsubscriberAsync;
        getProjectDataProviderId(projectId, projectStorageInterpreterId): Promise<string>;
    }

    Hierarchy

    • Dispose
      • default

    Properties

    dispose

    Methods

    getProjectDataProviderId

    Properties

    dispose

    dispose: UnsubscriberAsync

    Release resources and notify dependent services when tearing down an object

    -

    Methods

    getProjectDataProviderId

    • getProjectDataProviderId(projectId, projectStorageInterpreterId): Promise<string>

    • Returns the registered network object name of a PDP for the given project ID and PSI. Called by +

    Methods

    getProjectDataProviderId

    • getProjectDataProviderId(projectId, projectStorageInterpreterId): Promise<string>

    • Returns the registered network object name of a PDP for the given project ID and PSI. Called by the platform when someone uses the project data provider service to access a project's data.

      Parameters

      • projectId: string

        Id of the project for which to return a project data provider.

      • projectStorageInterpreterId: string

        Id of the project storage interpreter that corresponds to @@ -14,4 +14,4 @@ project id. It should return the same project data provider for the same combination of parameters throughout one session (in other words, in general, there should just be one project data provider for one project id).

        -

    Settings

    Member Visibility

    Theme

    On This Page

    disposegetProjectDataProviderId
    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    On This Page

    disposegetProjectDataProviderId
    \ 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 413bb15b94..424a59e966 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

    Interface DisposableWebViewProvider

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

    See

    networkObjectService

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

    Hierarchy (view full)

    Properties

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

    Hierarchy (view full)

    Properties

    dispose onDidDispose

    Methods

    getWebView

    Properties

    dispose

    dispose: UnsubscriberAsync

    Release resources and notify dependent services when tearing down an object

    -

    onDidDispose

    onDidDispose: PlatformEvent<void>

    Event that emits when dispose is called on an object

    -

    Methods

    getWebView

    onDidDispose

    onDidDispose: PlatformEvent<void>

    Event that emits when dispose is called on an object

    +

    Methods

    getWebView

    Settings

    Member Visibility

    Theme

    On This Page

    disposeonDidDisposegetWebView
    \ No newline at end of file +
  • getWebViewOptions: GetWebViewOptions

    • Returns Promise<undefined | WebViewDefinition>

    Settings

    Member Visibility

    Theme

    On This Page

    disposeonDidDisposegetWebView
    \ 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 4fe0e51ad9..be3728cac1 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

    Interface IWebViewProvider

    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 (view full)

    Properties

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

    Hierarchy (view full)

    Properties

    dispose? onDidDispose?

    Methods

    getWebView

    Properties

    Optional dispose

    dispose?: UnsubscriberAsync

    Release resources and notify dependent services when tearing down an object

    -

    Optional onDidDispose

    onDidDispose?: undefined

    Event that emits when dispose is called on an object

    -

    Methods

    getWebView

    Optional onDidDispose

    onDidDispose?: undefined

    Event that emits when dispose is called on an object

    +

    Methods

    getWebView

    Settings

    Member Visibility

    Theme

    On This Page

    disposeonDidDisposegetWebView
    \ No newline at end of file +
  • getWebViewOptions: GetWebViewOptions

    • Returns Promise<undefined | WebViewDefinition>

    Settings

    Member Visibility

    Theme

    On This Page

    disposeonDidDisposegetWebView
    \ 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 aa694eb6c4..b1846ed321 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: PlatformEvent<void>;
        getWebView(savedWebView, getWebViewOptions): Promise<undefined | WebViewDefinition>;
    }

    Hierarchy (view full)

    Properties

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

    Hierarchy (view full)

    Properties

    dispose? onDidDispose

    Methods

    getWebView

    Properties

    Optional dispose

    dispose?: UnsubscriberAsync

    Release resources and notify dependent services when tearing down an object

    -

    onDidDispose

    onDidDispose: PlatformEvent<void>

    Event that emits when dispose is called on an object

    -

    Methods

    getWebView

    onDidDispose

    onDidDispose: PlatformEvent<void>

    Event that emits when dispose is called on an object

    +

    Methods

    getWebView

    Settings

    Member Visibility

    Theme

    On This Page

    disposeonDidDisposegetWebView
    \ No newline at end of file +
  • getWebViewOptions: GetWebViewOptions

    • Returns Promise<undefined | WebViewDefinition>

    Settings

    Member Visibility

    Theme

    On This Page

    disposeonDidDisposegetWebView
    \ 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 7ec91cc00b..e3aa106ae3 100644 --- a/papi-dts/interfaces/_shared_services_data_provider_service_.DataProviderService.html +++ b/papi-dts/interfaces/_shared_services_data_provider_service_.DataProviderService.html @@ -1,4 +1,4 @@ -DataProviderService | papi-dts

    Interface DataProviderService

    interface DataProviderService {
        DataProviderEngine: typeof "shared/models/data-provider-engine.model".DataProviderEngine;
        decorators: {
            doNotNotify: {
                (method): void;
                (target, member): void;
            };
            ignore: {
                (method): void;
                (target, member): void;
            };
        };
        get: (<DataProviderName>(providerName) => Promise<DataProviders[DataProviderName] | undefined>);
        hasKnown: ((providerName) => boolean);
        registerEngine: (<DataProviderName>(providerName, dataProviderEngine, dataProviderType?, dataProviderAttributes?) => Promise<DisposableDataProviders[DataProviderName]>);
    }

    Properties

    DataProviderEngine +DataProviderService | papi-dts

    Interface DataProviderService

    interface DataProviderService {
        DataProviderEngine: typeof "shared/models/data-provider-engine.model".DataProviderEngine;
        decorators: {
            doNotNotify: {
                (method): void;
                (target, member): void;
            };
            ignore: {
                (method): void;
                (target, member): void;
            };
        };
        get: (<DataProviderName>(providerName) => Promise<DataProviders[DataProviderName] | undefined>);
        hasKnown: ((providerName) => boolean);
        registerEngine: (<DataProviderName>(providerName, dataProviderEngine, dataProviderType?, dataProviderAttributes?) => Promise<DisposableDataProviders[DataProviderName]>);
    }

    Properties

    DataProviderEngine decorators get hasKnown @@ -7,7 +7,7 @@ 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.

    -

    decorators

    decorators: {
        doNotNotify: {
            (method): void;
            (target, member): void;
        };
        ignore: {
            (method): void;
            (target, member): void;
        };
    }

    A collection of decorators to be used with the data provider service

    +

    decorators

    decorators: {
        doNotNotify: {
            (method): void;
            (target, member): void;
        };
        ignore: {
            (method): void;
            (target, member): void;
        };
    }

    A collection of decorators to be used with the data provider service

    Type declaration

    • doNotNotify: {
          (method): void;
          (target, member): void;
      }

      Decorator function that marks a data provider engine set<data_type> method not to automatically emit an update and notify subscribers of a change to the data. papi will still consider the set<data_type> method to be a data type method, but it will not layer over it to emit updates.

      @@ -36,13 +36,13 @@

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

      WARNING: Do not copy and paste this example. The @ symbol does not render correctly in JSDoc
 code blocks, so a different unicode character was used. Please use a normal @ when using a
 decorator.
      
-

    get

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

    Get a data provider that has previously been set up

    +

    get

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

    Get a data provider that has previously been set up

    Type declaration

    Returns

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

    -

    hasKnown

    hasKnown: ((providerName) => boolean)

    Indicate if we are aware of an existing data provider with the given name. If a data provider +

    hasKnown

    hasKnown: ((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.

    -

    Type declaration

      • (providerName): boolean

      • Parameters

        • providerName: string

        Returns boolean

    registerEngine

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

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

    Type declaration

      • (providerName): boolean

      • Parameters

        • providerName: string

        Returns boolean

    registerEngine

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

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

    Type declaration

    Returns

    The data provider including control over disposing of it. Note that this data provider is a new object distinct from the data provider engine passed in.

    -

    Settings

    Member Visibility

    Theme

    On This Page

    DataProviderEnginedecoratorsgethasKnownregisterEngine
    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    On This Page

    DataProviderEnginedecoratorsgethasKnownregisterEngine
    \ 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 376a7a5d78..a273b2bea8 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

    Interface DialogService

    Prompt the user for responses with dialogs

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

    Methods

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

    Methods

    selectProject showDialog

    Methods

    selectProject

    • selectProject(options?): Promise<undefined | string>

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

      Parameters

      Returns Promise<undefined | string>

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

      -

    showDialog

    showDialog

    Settings

    Member Visibility

    Theme

    On This Page

    selectProjectshowDialog
    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    On This Page

    selectProjectshowDialog
    \ 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 5e92bbe7fd..06370b5f72 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

    interface InternetService {
        fetch: {
            (input, init?): Promise<Response>;
            (input, init?): Promise<Response>;
        };
    }

    Properties

    fetch +InternetService | papi-dts

    Interface InternetService

    interface InternetService {
        fetch: {
            (input, init?): Promise<Response>;
            (input, init?): Promise<Response>;
        };
    }

    Properties

    fetch

    Properties

    fetch

    fetch: {
        (input, init?): Promise<Response>;
        (input, init?): Promise<Response>;
    }

    Type declaration

      • (input, init?): Promise<Response>

      • MDN Reference

        -

        Parameters

        • input: RequestInfo | URL
        • Optional init: RequestInit

        Returns Promise<Response>

      • (input, init?): Promise<Response>

      • Parameters

        • input: string | Request | URL
        • Optional init: RequestInit

        Returns Promise<Response>

    Settings

    Member Visibility

    Theme

    On This Page

    fetch
    \ No newline at end of file +

    Parameters

    • input: RequestInfo | URL
    • Optional init: RequestInit

    Returns Promise<Response>

  • (input, init?): Promise<Response>

  • Parameters

    • input: string | Request | URL
    • Optional init: RequestInit

    Returns Promise<Response>

    • Settings

    Member Visibility

    Theme

    On This Page

    fetch
    \ 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 4fd3aedf37..b3fc5d04d7 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 default

    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

    connect +
    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

    connect connectionStatus connectorInfo disconnect @@ -24,23 +24,23 @@
  • networkConnectorEventHandlers: NetworkConnectorEventHandlers

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

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

    Returns

    Promise that resolves with connector info when finished connecting

    -

    connectionStatus

    connectionStatus: ConnectionStatus

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

    connectionStatus

    connectionStatus: ConnectionStatus

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

    -

    connectorInfo

    connectorInfo: Readonly<{
        clientId: number;
    }>

    Information about the connector. Populated by the server while connecting

    -

    Type declaration

    • clientId: number

    disconnect

    disconnect: (() => void)

    Disconnects from the connection:

    +

    connectorInfo

    connectorInfo: Readonly<{
        clientId: number;
    }>

    Information about the connector. Populated by the server while connecting

    +

    Type declaration

    • clientId: number

    disconnect

    disconnect: (() => void)

    Disconnects from the connection:

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

    Type declaration

      • (): void

      • Returns void

    emitEventOnNetwork

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

    Sends an event to other processes. Does NOT run the local event subscriptions as they should be +

    Type declaration

      • (): void

      • Returns void

    emitEventOnNetwork

    emitEventOnNetwork: (<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 declaration

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

      • 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

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

    Notify the server that this client has received its connectorInfo and is ready to go.

    +

    Returns Promise<void>

    notifyClientConnected

    notifyClientConnected: (() => 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?

    -

    Type declaration

    request

    request: InternalRequestHandler

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

    +

    Type declaration

    request

    request: InternalRequestHandler

    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

    -

    Settings

    Member Visibility

    Theme

    On This Page

    connectconnectionStatusconnectorInfodisconnectemitEventOnNetworknotifyClientConnectedrequest
    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    On This Page

    connectconnectionStatusconnectorInfodisconnectemitEventOnNetworknotifyClientConnectedrequest
    \ 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 e29be102cd..cb841c9869 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

    interface NetworkObjectStatusRemoteServiceType {
        getAllNetworkObjectDetails: (() => Promise<Record<string, NetworkObjectDetails>>);
    }

    Hierarchy (view full)

    Properties

    getAllNetworkObjectDetails +NetworkObjectStatusRemoteServiceType | papi-dts

    Interface NetworkObjectStatusRemoteServiceType

    interface NetworkObjectStatusRemoteServiceType {
        getAllNetworkObjectDetails: (() => Promise<Record<string, NetworkObjectDetails>>);
    }

    Hierarchy (view full)

    Properties

    getAllNetworkObjectDetails

    Properties

    getAllNetworkObjectDetails

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

    Get details about all available network objects

    Type declaration

    Returns

    Object whose keys are the names of the network objects and whose values are the NetworkObjectDetails for each network object

    -

    Settings

    Member Visibility

    Theme

    On This Page

    getAllNetworkObjectDetails
    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    On This Page

    getAllNetworkObjectDetails
    \ 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 75313e7e28..a78e053bab 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

    Interface NetworkObjectStatusServiceType

    Provides functions related to the set of available network objects

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

    Hierarchy (view full)

    Properties

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

    Hierarchy (view full)

    Properties

    getAllNetworkObjectDetails waitForNetworkObject

    Properties

    getAllNetworkObjectDetails

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

    Get details about all available network objects

    Type declaration

    Returns

    Object whose keys are the names of the network objects and whose values are the NetworkObjectDetails for each network object

    -

    waitForNetworkObject

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

    Get a promise that resolves when a network object is registered or rejects if a timeout is hit

    +

    waitForNetworkObject

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

    Get a promise that resolves when a network object is registered or rejects if a timeout is hit

    Type declaration

    Returns

    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

    -

    Settings

    Member Visibility

    Theme

    On This Page

    getAllNetworkObjectDetailswaitForNetworkObject
    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    On This Page

    getAllNetworkObjectDetailswaitForNetworkObject
    \ 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 09922bf377..7bb1510705 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

    interface PapiNetworkService {
        createNetworkEventEmitter: (<T>(eventType) => PlatformEventEmitter<T>);
        getNetworkEvent: (<T>(eventType) => PlatformEvent<T>);
        onDidClientConnect: PlatformEvent<ClientConnectEvent>;
        onDidClientDisconnect: PlatformEvent<ClientDisconnectEvent>;
    }

    Properties

    createNetworkEventEmitter +PapiNetworkService | papi-dts

    Interface PapiNetworkService

    interface PapiNetworkService {
        createNetworkEventEmitter: (<T>(eventType) => PlatformEventEmitter<T>);
        getNetworkEvent: (<T>(eventType) => PlatformEvent<T>);
        onDidClientConnect: PlatformEvent<ClientConnectEvent>;
        onDidClientDisconnect: PlatformEvent<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 PlatformEventEmitter<T>

    Event emitter whose event works between connections

    -

    getNetworkEvent

    getNetworkEvent: (<T>(eventType) => PlatformEvent<T>)

    Type declaration

      • <T>(eventType): PlatformEvent<T>

      • Gets the network event with the specified type. Creates the emitter if it does not exist

        +

    getNetworkEvent

    getNetworkEvent: (<T>(eventType) => PlatformEvent<T>)

    Type declaration

      • <T>(eventType): PlatformEvent<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 PlatformEvent<T>

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

        -

    onDidClientConnect

    onDidClientConnect: PlatformEvent<ClientConnectEvent>

    onDidClientDisconnect

    onDidClientDisconnect: PlatformEvent<ClientDisconnectEvent>

    Settings

    Member Visibility

    Theme

    On This Page

    createNetworkEventEmittergetNetworkEventonDidClientConnectonDidClientDisconnect
    \ No newline at end of file +

    onDidClientConnect

    onDidClientConnect: PlatformEvent<ClientConnectEvent>

    onDidClientDisconnect

    onDidClientDisconnect: PlatformEvent<ClientDisconnectEvent>

    Settings

    Member Visibility

    Theme

    On This Page

    createNetworkEventEmittergetNetworkEventonDidClientConnectonDidClientDisconnect
    \ 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 ebdcea6b34..84ce440f21 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

    interface PapiBackendProjectDataProviderService {
        get: (<ProjectType>(projectType, projectId) => Promise<ProjectDataProviders[ProjectType]>);
        registerProjectDataProviderEngineFactory: (<ProjectType>(projectType, pdpEngineFactory) => Promise<Dispose>);
    }

    Properties

    get +PapiBackendProjectDataProviderService | papi-dts

    Interface PapiBackendProjectDataProviderService

    interface PapiBackendProjectDataProviderService {
        get: (<ProjectType>(projectType, projectId) => Promise<ProjectDataProviders[ProjectType]>);
        registerProjectDataProviderEngineFactory: (<ProjectType>(projectType, pdpEngineFactory) => Promise<Dispose>);
    }

    Properties

    get registerProjectDataProviderEngineFactory

    Properties

    get

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

    Type declaration

      • <ProjectType>(projectType, projectId): Promise<ProjectDataProviders[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<ProjectDataProviders[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

    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

    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

        Returns Promise<Dispose>

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

        -

    Settings

    Member Visibility

    Theme

    On This Page

    getregisterProjectDataProviderEngineFactory
    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    On This Page

    getregisterProjectDataProviderEngineFactory
    \ 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 87f8b02a27..2e970a94ca 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

    interface PapiFrontendProjectDataProviderService {
        get: (<ProjectType>(projectType, projectId) => Promise<ProjectDataProviders[ProjectType]>);
    }

    Properties

    get +PapiFrontendProjectDataProviderService | papi-dts

    Interface PapiFrontendProjectDataProviderService

    interface PapiFrontendProjectDataProviderService {
        get: (<ProjectType>(projectType, projectId) => Promise<ProjectDataProviders[ProjectType]>);
    }

    Properties

    get

    Properties

    get

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

    Type declaration

      • <ProjectType>(projectType, projectId): Promise<ProjectDataProviders[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<ProjectDataProviders[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'));
        -

    Settings

    Member Visibility

    Theme

    On This Page

    get
    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    On This Page

    get
    \ 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 30e65f9a35..f34c4a925f 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

    Interface ProjectLookupServiceType

    Provides metadata for projects known by the platform

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

    Properties

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

    Properties

    getMetadataForAllProjects getMetadataForProject

    Properties

    getMetadataForAllProjects

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

    Provide metadata for all projects found on the local system

    Type declaration

    Returns

    ProjectMetadata for all projects stored on the local system

    -

    getMetadataForProject

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

    Look up metadata for a specific project ID

    +

    getMetadataForProject

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

    Look up metadata for a specific project ID

    Type declaration

    Returns

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

    -

    Settings

    Member Visibility

    Theme

    On This Page

    getMetadataForAllProjectsgetMetadataForProject
    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    On This Page

    getMetadataForAllProjectsgetMetadataForProject
    \ No newline at end of file diff --git a/papi-dts/interfaces/_shared_services_project_settings_service_model_.IProjectSettingsService.html b/papi-dts/interfaces/_shared_services_project_settings_service_model_.IProjectSettingsService.html index cc89505be0..a17c98ea82 100644 --- a/papi-dts/interfaces/_shared_services_project_settings_service_model_.IProjectSettingsService.html +++ b/papi-dts/interfaces/_shared_services_project_settings_service_model_.IProjectSettingsService.html @@ -1,6 +1,6 @@ IProjectSettingsService | papi-dts

    Interface IProjectSettingsService

    Provides utility functions that project storage interpreters should call when handling project settings

    -
    interface IProjectSettingsService {
        getDefault<ProjectSettingName>(key, projectType): Promise<ProjectSettingTypes[ProjectSettingName]>;
        isValid<ProjectSettingName>(key, newValue, currentValue, projectType, allChanges?): Promise<boolean>;
        registerValidator<ProjectSettingName>(key, validatorCallback): Promise<UnsubscriberAsync>;
    }

    Methods

    getDefault +
    interface IProjectSettingsService {
        getDefault<ProjectSettingName>(key, projectType): Promise<ProjectSettingTypes[ProjectSettingName]>;
        isValid<ProjectSettingName>(key, newValue, currentValue, projectType, allChanges?): Promise<boolean>;
        registerValidator<ProjectSettingName>(key, validatorCallback): Promise<UnsubscriberAsync>;
    }

    Methods

    getDefault isValid registerValidator

    Methods

    getDefault

    Returns Promise<ProjectSettingTypes[ProjectSettingName]>

    The default value for the setting if a default value is registered

    Throws

    If a default value is not registered for the setting

    -

    isValid

    • isValid<ProjectSettingName>(key, newValue, currentValue, projectType, allChanges?): Promise<boolean>

    • Calls registered project settings validators to determine whether or not a project setting +

    isValid

    • isValid<ProjectSettingName>(key, newValue, currentValue, projectType, allChanges?): Promise<boolean>

    • Calls registered project settings validators to determine whether or not a project setting change is valid.

      Every Project Storage Interpreter must run this function when it receives a request to set a project setting before changing the value of the setting.

      @@ -22,7 +22,7 @@
    • projectType: keyof ProjectDataProviders

      The projectType for the project whose setting is being changed

    • Optional allChanges: SimultaneousProjectSettingsChanges

      All project settings changes being set in one batch

    Returns Promise<boolean>

    true if change is valid, false otherwise

    -

    registerValidator

    registerValidator

    Settings

    Member Visibility

    Theme

    On This Page

    getDefaultisValidregisterValidator
    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    On This Page

    getDefaultisValidregisterValidator
    \ 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 654c64ec6a..ebc768589a 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

    interface PapiWebViewProviderService {
        register: ((webViewType, webViewProvider) => Promise<DisposableWebViewProvider>);
    }

    Properties

    register +PapiWebViewProviderService | papi-dts

    Interface PapiWebViewProviderService

    interface PapiWebViewProviderService {
        register: ((webViewType, webViewProvider) => Promise<DisposableWebViewProvider>);
    }

    Properties

    register

    Properties

    register

    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

        -

    Settings

    Member Visibility

    Theme

    On This Page

    register
    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    On This Page

    register
    \ 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 85ae68fb33..3cc4ff884d 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

    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

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

    Properties

    get hasKnown initialize register

    Properties

    get

    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

    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

    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

    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

    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

    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

    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

        -

    Settings

    Member Visibility

    Theme

    On This Page

    gethasKnowninitializeregister
    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    On This Page

    gethasKnowninitializeregister
    \ 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 77ced87bb8..bd0f620b4f 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

    Interface 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.

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

    Properties

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

    Properties

    getWebView onDidAddWebView

    Properties

    getWebView

    getWebView: ((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>

    Returns

    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

    onDidAddWebView: PlatformEvent<AddWebViewEvent>

    Event that emits with webView info when a webView is added

    -

    Settings

    Member Visibility

    Theme

    On This Page

    getWebViewonDidAddWebView
    \ No newline at end of file +

    onDidAddWebView

    onDidAddWebView: PlatformEvent<AddWebViewEvent>

    Event that emits with webView info when a webView is added

    +

    Settings

    Member Visibility

    Theme

    On This Page

    getWebViewonDidAddWebView
    \ No newline at end of file diff --git a/papi-dts/modules/__papi_backend_.html b/papi-dts/modules/__papi_backend_.html index ad2cd70424..b7187b2527 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 ProjectDataProviderEngine commands dataProviders diff --git a/papi-dts/modules/__papi_core_.html b/papi-dts/modules/__papi_core_.html index 3583679db6..5b9fbcc0ee 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 01e4c57c29..e118930352 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

    Papi

    Variables

    WebSocket XMLHttpRequest commands diff --git a/papi-dts/modules/__papi_frontend_react_.html b/papi-dts/modules/__papi_frontend_react_.html index ce67101cc5..15fa4600f2 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 41e784cb12..55c3e932ff 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

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

    Index

    Classes

    default

    Settings

    Member Visibility

    Theme

    \ 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 69a0fe586c..4409e0cb12 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

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

    Index

    Functions

    createWebSocket

    Settings

    Member Visibility

    Theme

    \ 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 f82a6fbe0c..3749d5601e 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

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

    Index

    Type Aliases

    IWebSocket

    Settings

    Member Visibility

    Theme

    \ 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 b4a7f44df8..149676f55a 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

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

    Index

    Type Aliases

    ExecutionActivationContext

    Settings

    Member Visibility

    Theme

    \ 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 adf965b740..5e7b7517f1 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

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

    Index

    Interfaces

    IExtension

    Settings

    Member Visibility

    Theme

    \ 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 ad2be66c3c..5381599f42 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

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

    Index

    Type Aliases

    ExtensionManifest

    Settings

    Member Visibility

    Theme

    \ 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 35c2aeb52f..1a79f30aec 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

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

    Index

    Namespaces

    default

    Classes

    default

    Settings

    Member Visibility

    Theme

    \ 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 a57429c4c5..ce66011bee 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

    ExtensionStorageService

    Variables

    default

    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 aa9456d3fd..bc124e612f 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

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

    Index

    Classes

    default

    Settings

    Member Visibility

    Theme

    \ 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 e7c2d2ba1b..12b0b792d7 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

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

    Index

    Classes

    ExecutionToken

    Type Aliases

    ExecutionTokenType

    Settings

    Member Visibility

    Theme

    \ 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 4af7a3ef7c..cfa91a9549 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

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

    Index

    Variables

    default

    Settings

    Member Visibility

    Theme

    \ 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 4787a049bb..23bf1425bb 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

    EntryType

    Type Aliases

    DirectoryEntries

    Functions

    copyFile createDir diff --git a/papi-dts/modules/_node_utils_crypto_util_.html b/papi-dts/modules/_node_utils_crypto_util_.html index 872776bb07..19ddecba87 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

    Namespace "node/utils/crypto-util"

    Index

    Functions

    createNonce createUuid

    Settings

    Member Visibility

    Theme

    \ 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 455d9eec0d..26e3af8b5d 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

    Variables

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

    Namespace "node/utils/util"

    Index

    Variables

    FILE_PROTOCOL RESOURCES_PROTOCOL

    Functions

    getAppDir getPathFromUri diff --git a/papi-dts/modules/_papi_shared_types_.html b/papi-dts/modules/_papi_shared_types_.html index 09a71241a1..d97fffa40a 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 ProjectDataProviders ProjectSettingTypes 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 7870d570b1..322446a30b 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

    DialogDefinitionBase DialogProps

    Variables

    default

    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 62841b7151..6e9a9ae3a0 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

    DialogTypes

    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 8d7b859c72..68decf02ee 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

    Namespace "renderer/hooks/hook-generators/create-use-data-hook.util"

    Index

    Functions

    default

    Settings

    Member Visibility

    Theme

    \ 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 798996c85d..b0a26b016d 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

    Namespace "renderer/hooks/hook-generators/create-use-network-object-hook.util"

    Index

    Functions

    default

    Settings

    Member Visibility

    Theme

    \ 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 acf743d774..c12ceee97b 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 2fed274fb5..269e56ef93 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

    Namespace "renderer/hooks/papi-hooks/use-data.hook"

    Index

    Functions

    default

    Settings

    Member Visibility

    Theme

    \ 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 a90ac3c138..dc2f403208 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

    Namespace "renderer/hooks/papi-hooks/use-data-provider.hook"

    Index

    Functions

    default

    Settings

    Member Visibility

    Theme

    \ 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 b7deaaad13..d0b97ef938 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

    Namespace "renderer/hooks/papi-hooks/use-data-provider-multi.hook"

    Index

    Functions

    default

    Settings

    Member Visibility

    Theme

    \ 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 3d3d0485f6..322d477d52 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,3 +1,3 @@ -"renderer/hooks/papi-hooks/use-dialog-callback.hook" | papi-dts

    Namespace "renderer/hooks/papi-hooks/use-dialog-callback.hook"

    Index

    Type Aliases

    UseDialogCallbackOptions +"renderer/hooks/papi-hooks/use-dialog-callback.hook" | papi-dts

    Namespace "renderer/hooks/papi-hooks/use-dialog-callback.hook"

    Index

    Type Aliases

    UseDialogCallbackOptions

    Functions

    default

    Settings

    Member Visibility

    Theme

    \ 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 6b424da668..5f66f6f43a 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

    Namespace "renderer/hooks/papi-hooks/use-project-data.hook"

    Index

    Functions

    default

    Settings

    Member Visibility

    Theme

    \ 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 0199902992..c7b9b1d094 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

    Namespace "renderer/hooks/papi-hooks/use-project-data-provider.hook"

    Index

    Functions

    default

    Settings

    Member Visibility

    Theme

    \ No newline at end of file diff --git a/papi-dts/modules/_renderer_hooks_papi_hooks_use_project_setting_hook_.html b/papi-dts/modules/_renderer_hooks_papi_hooks_use_project_setting_hook_.html index 3d70a576da..ee32ba6ac2 100644 --- a/papi-dts/modules/_renderer_hooks_papi_hooks_use_project_setting_hook_.html +++ b/papi-dts/modules/_renderer_hooks_papi_hooks_use_project_setting_hook_.html @@ -1,2 +1,2 @@ -"renderer/hooks/papi-hooks/use-project-setting.hook" | papi-dts

    Namespace "renderer/hooks/papi-hooks/use-project-setting.hook"

    Index

    Functions

    default +"renderer/hooks/papi-hooks/use-project-setting.hook" | papi-dts

    Namespace "renderer/hooks/papi-hooks/use-project-setting.hook"

    Index

    Functions

    default

    Settings

    Member Visibility

    Theme

    \ 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 4534053f90..ccc3dbe22b 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

    Namespace "renderer/hooks/papi-hooks/use-setting.hook"

    Index

    Functions

    default

    Settings

    Member Visibility

    Theme

    \ 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 323623324c..27a996ae38 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

    Namespace "renderer/services/renderer-web-socket.service"

    Index

    Classes

    default

    Functions

    blockWebSocketsToPapiNetwork

    Settings

    Member Visibility

    Theme

    \ 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 11238dc1f0..7d182a99f4 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

    Namespace "renderer/services/renderer-xml-http-request.service"

    Index

    Classes

    default

    Settings

    Member Visibility

    Theme

    \ 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 fc4ef2fddb..4e406baf38 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

    Namespace "shared/data/file-system.model"

    Index

    Type Aliases

    Uri

    Settings

    Member Visibility

    Theme

    \ 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 9c7cd5fc03..20ed5dff36 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

    ConnectionStatus

    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 80b591d922..dbc7bed763 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

    MessageType

    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 958a06499e..0c583e1dbf 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

    Namespace "shared/global-this.model"

    Index

    Enumerations

    ProcessType

    Settings

    Member Visibility

    Theme

    \ 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 b2823d30ae..08d5052a65 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

    Classes

    DataProviderEngine +"shared/models/data-provider-engine.model" | papi-dts

    Namespace "shared/models/data-provider-engine.model"

    Index

    Classes

    DataProviderEngine

    Type Aliases

    DataProviderEngineNotifyUpdate WithNotifyUpdate default diff --git a/papi-dts/modules/_shared_models_data_provider_interface_.html b/papi-dts/modules/_shared_models_data_provider_interface_.html index 339803a2f0..5d0acc4c7b 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

    Namespace "shared/models/data-provider.interface"

    Index

    Type Aliases

    IDisposableDataProvider default

    Settings

    Member Visibility

    Theme

    \ 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 d184054a29..51fe0797fa 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 5679245a81..5d4a81a548 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

    Namespace "shared/models/dialog-options.model"

    Index

    Type Aliases

    DialogData DialogOptions

    Settings

    Member Visibility

    Theme

    \ No newline at end of file diff --git a/papi-dts/modules/_shared_models_docking_framework_model_.html b/papi-dts/modules/_shared_models_docking_framework_model_.html index 96cc6d1324..22162d31d5 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

    FloatLayout PanelLayout TabLayout

    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 4bb9968051..99e724143a 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

    Namespace "shared/models/extract-data-provider-data-types.model"

    Index

    Type Aliases

    default

    Settings

    Member Visibility

    Theme

    \ 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 0506a63ef8..903c092c83 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_network_event_emitter_model_.html b/papi-dts/modules/_shared_models_papi_network_event_emitter_model_.html index 886991d1c6..194729d95f 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

    Namespace "shared/models/papi-network-event-emitter.model"

    Index

    Classes

    default

    Settings

    Member Visibility

    Theme

    \ 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 0547b2e516..f4c3d56c72 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

    Classes

    ProjectDataProviderEngine +"shared/models/project-data-provider-engine.model" | papi-dts

    Namespace "shared/models/project-data-provider-engine.model"

    Index

    Classes

    ProjectDataProviderEngine

    Interfaces

    IProjectDataProviderEngineFactory

    Type Aliases

    IProjectDataProviderEngine ProjectDataProviderEngineTypes diff --git a/papi-dts/modules/_shared_models_project_data_provider_factory_interface_.html b/papi-dts/modules/_shared_models_project_data_provider_factory_interface_.html index 20c59dad22..7959916bf7 100644 --- a/papi-dts/modules/_shared_models_project_data_provider_factory_interface_.html +++ b/papi-dts/modules/_shared_models_project_data_provider_factory_interface_.html @@ -1,2 +1,2 @@ -"shared/models/project-data-provider-factory.interface" | papi-dts

    Namespace "shared/models/project-data-provider-factory.interface"

    Index

    Interfaces

    default +"shared/models/project-data-provider-factory.interface" | papi-dts

    Namespace "shared/models/project-data-provider-factory.interface"

    Index

    Interfaces

    default

    Settings

    Member Visibility

    Theme

    \ 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 dca0c128e8..0634b28773 100644 --- a/papi-dts/modules/_shared_models_project_data_provider_model_.html +++ b/papi-dts/modules/_shared_models_project_data_provider_model_.html @@ -1,4 +1,4 @@ -"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

    Namespace "shared/models/project-data-provider.model"

    Index

    Type Aliases

    ExtensionDataScope MandatoryProjectDataTypes WithProjectDataProviderEngineExtensionDataMethods

    Settings

    Member Visibility

    Theme

    \ 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 022ed0033f..9868cc423f 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

    Namespace "shared/models/project-metadata.model"

    Index

    Type Aliases

    ProjectMetadata

    Settings

    Member Visibility

    Theme

    \ No newline at end of file diff --git a/papi-dts/modules/_shared_models_project_storage_interpreter_model_.html b/papi-dts/modules/_shared_models_project_storage_interpreter_model_.html index d124ee5b1e..e4ff5f4bee 100644 --- a/papi-dts/modules/_shared_models_project_storage_interpreter_model_.html +++ b/papi-dts/modules/_shared_models_project_storage_interpreter_model_.html @@ -1,4 +1,4 @@ -"shared/models/project-storage-interpreter.model" | papi-dts

    Namespace "shared/models/project-storage-interpreter.model"

    Index

    Type Aliases

    DefaultProjectStorageDataTypes +"shared/models/project-storage-interpreter.model" | papi-dts

    Namespace "shared/models/project-storage-interpreter.model"

    Index

    Type Aliases

    DefaultProjectStorageDataTypes MandatoryProjectStorageDataTypes ProjectStorageExtensionDataScope ProjectStorageProjectDataScope diff --git a/papi-dts/modules/_shared_models_web_view_model_.html b/papi-dts/modules/_shared_models_web_view_model_.html index 8b13a490f9..2d5326fb26 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

    WebViewContentType

    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 fd7e357602..c1c776d471 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

    Namespace "shared/models/web-view-provider.model"

    Index

    Interfaces

    DisposableWebViewProvider IWebViewProvider WebViewProvider

    Settings

    Member Visibility

    Theme

    \ 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 ded9885657..4deb1ebff7 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

    moduleSummaryComments

    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 e70a3596e9..901e52eb6c 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 47dcc33816..2b25230d2d 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

    Interfaces

    DataProviderService +"shared/services/data-provider.service" | papi-dts

    Namespace "shared/services/data-provider.service"

    Index

    Interfaces

    DataProviderService

    Variables

    default

    Functions

    getByType registerEngineByType diff --git a/papi-dts/modules/_shared_services_dialog_service_.html b/papi-dts/modules/_shared_services_dialog_service_.html index 424c78fe16..7a5ba37cef 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

    Namespace "shared/services/dialog.service"

    Index

    Variables

    default

    Settings

    Member Visibility

    Theme

    \ 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 254fe5e784..9443e4901d 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

    Namespace "shared/services/dialog.service-model"

    Index

    Interfaces

    DialogService

    Variables

    CATEGORY_DIALOG

    Settings

    Member Visibility

    Theme

    \ 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 6eeab97072..f680aa0ff0 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

    Namespace "shared/services/internet.service"

    Index

    Interfaces

    InternetService

    Variables

    default

    Settings

    Member Visibility

    Theme

    \ No newline at end of file diff --git a/papi-dts/modules/_shared_services_localization_service_.html b/papi-dts/modules/_shared_services_localization_service_.html index 9fa2509052..ae26fd11ad 100644 --- a/papi-dts/modules/_shared_services_localization_service_.html +++ b/papi-dts/modules/_shared_services_localization_service_.html @@ -1,2 +1,2 @@ -"shared/services/localization.service" | papi-dts

    Namespace "shared/services/localization.service"

    Index

    Variables

    default +"shared/services/localization.service" | papi-dts

    Namespace "shared/services/localization.service"

    Index

    Variables

    default

    Settings

    Member Visibility

    Theme

    \ No newline at end of file diff --git a/papi-dts/modules/_shared_services_localization_service_model_.html b/papi-dts/modules/_shared_services_localization_service_model_.html index a5382e5660..a220fddde9 100644 --- a/papi-dts/modules/_shared_services_localization_service_model_.html +++ b/papi-dts/modules/_shared_services_localization_service_model_.html @@ -1,4 +1,4 @@ -"shared/services/localization.service-model" | papi-dts

    Namespace "shared/services/localization.service-model"

    Index

    Type Aliases

    ILocalizationService +"shared/services/localization.service-model" | papi-dts

    Namespace "shared/services/localization.service-model"

    Index

    Type Aliases

    ILocalizationService LocalizationData LocalizationDataDataTypes LocalizationMetadata diff --git a/papi-dts/modules/_shared_services_logger_service_.html b/papi-dts/modules/_shared_services_logger_service_.html index 6781c1a81b..30406a050a 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

    Namespace "shared/services/logger.service"

    Index

    Variables

    WARN_TAG default

    Functions

    formatLog

    Settings

    Member Visibility

    Theme

    \ No newline at end of file diff --git a/papi-dts/modules/_shared_services_menu_data_service_.html b/papi-dts/modules/_shared_services_menu_data_service_.html index c57c60337f..f0b12cecc2 100644 --- a/papi-dts/modules/_shared_services_menu_data_service_.html +++ b/papi-dts/modules/_shared_services_menu_data_service_.html @@ -1,2 +1,2 @@ -"shared/services/menu-data.service" | papi-dts

    Namespace "shared/services/menu-data.service"

    Index

    Variables

    default +"shared/services/menu-data.service" | papi-dts

    Namespace "shared/services/menu-data.service"

    Index

    Variables

    default

    Settings

    Member Visibility

    Theme

    \ No newline at end of file diff --git a/papi-dts/modules/_shared_services_menu_data_service_model_.html b/papi-dts/modules/_shared_services_menu_data_service_model_.html index ec44cf5d21..8ea03c2e70 100644 --- a/papi-dts/modules/_shared_services_menu_data_service_model_.html +++ b/papi-dts/modules/_shared_services_menu_data_service_model_.html @@ -1,4 +1,4 @@ -"shared/services/menu-data.service-model" | papi-dts

    Namespace "shared/services/menu-data.service-model"

    Index

    Type Aliases

    IMenuDataService +"shared/services/menu-data.service-model" | papi-dts

    Namespace "shared/services/menu-data.service-model"

    Index

    Type Aliases

    IMenuDataService MenuDataDataTypes

    Variables

    menuDataServiceObjectToProxy menuDataServiceProviderName diff --git a/papi-dts/modules/_shared_services_network_connector_factory_.html b/papi-dts/modules/_shared_services_network_connector_factory_.html index 498563d350..b2328744cd 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

    Namespace "shared/services/network-connector.factory"

    Index

    Functions

    createNetworkConnector

    Settings

    Member Visibility

    Theme

    \ 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 91f95a59d3..2c5ac1ceb5 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

    Namespace "shared/services/network-connector.interface"

    Index

    Interfaces

    default

    Settings

    Member Visibility

    Theme

    \ 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 8a80820fbb..79dc66c6b0 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

    default

    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 44a01d8eed..7939f97f67 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

    Namespace "shared/services/network-object-status.service"

    Index

    Variables

    default

    Settings

    Member Visibility

    Theme

    \ 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 5e0976c5a2..d5bf266ae3 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

    Namespace "shared/services/network-object-status.service-model"

    Index

    Interfaces

    NetworkObjectStatusRemoteServiceType NetworkObjectStatusServiceType

    Variables

    networkObjectStatusServiceNetworkObjectName

    Settings

    Member Visibility

    Theme

    \ 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 582209a5eb..4916d1860c 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

    PapiNetworkService

    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 3ddce9c7f6..4dfd0e4a0b 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

    PapiBackendProjectDataProviderService PapiFrontendProjectDataProviderService

    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 05ef7b990e..354c734e69 100644 --- a/papi-dts/modules/_shared_services_project_lookup_service_.html +++ b/papi-dts/modules/_shared_services_project_lookup_service_.html @@ -1,3 +1,3 @@ -"shared/services/project-lookup.service" | papi-dts

    Namespace "shared/services/project-lookup.service"

    Index

    Variables

    default +"shared/services/project-lookup.service" | papi-dts

    Namespace "shared/services/project-lookup.service"

    Index

    Variables

    default

    Functions

    filterProjectsMetadata

    Settings

    Member Visibility

    Theme

    \ 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 6f14071a9f..ca3ac6fffc 100644 --- a/papi-dts/modules/_shared_services_project_lookup_service_model_.html +++ b/papi-dts/modules/_shared_services_project_lookup_service_model_.html @@ -1,4 +1,4 @@ -"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

    Namespace "shared/services/project-lookup.service-model"

    Index

    Interfaces

    ProjectLookupServiceType

    Type Aliases

    ProjectMetadataFilterOptions

    Variables

    projectLookupServiceNetworkObjectName

    Settings

    Member Visibility

    Theme

    \ No newline at end of file diff --git a/papi-dts/modules/_shared_services_project_settings_service_.html b/papi-dts/modules/_shared_services_project_settings_service_.html index a8bf26698a..ae6f90fd1b 100644 --- a/papi-dts/modules/_shared_services_project_settings_service_.html +++ b/papi-dts/modules/_shared_services_project_settings_service_.html @@ -1,2 +1,2 @@ -"shared/services/project-settings.service" | papi-dts

    Namespace "shared/services/project-settings.service"

    Index

    Variables

    default +"shared/services/project-settings.service" | papi-dts

    Namespace "shared/services/project-settings.service"

    Index

    Variables

    default

    Settings

    Member Visibility

    Theme

    \ No newline at end of file diff --git a/papi-dts/modules/_shared_services_project_settings_service_model_.html b/papi-dts/modules/_shared_services_project_settings_service_model_.html index abdf94cc20..ca1235c68a 100644 --- a/papi-dts/modules/_shared_services_project_settings_service_model_.html +++ b/papi-dts/modules/_shared_services_project_settings_service_model_.html @@ -1,4 +1,4 @@ -"shared/services/project-settings.service-model" | papi-dts

    Namespace "shared/services/project-settings.service-model"

    Index

    Interfaces

    IProjectSettingsService +"shared/services/project-settings.service-model" | papi-dts

    Namespace "shared/services/project-settings.service-model"

    Index

    Interfaces

    IProjectSettingsService

    Type Aliases

    AllProjectSettingsValidators ProjectSettingValidator SimultaneousProjectSettingsChanges diff --git a/papi-dts/modules/_shared_services_settings_service_.html b/papi-dts/modules/_shared_services_settings_service_.html index 7e49973ade..4d3b070a99 100644 --- a/papi-dts/modules/_shared_services_settings_service_.html +++ b/papi-dts/modules/_shared_services_settings_service_.html @@ -1,2 +1,2 @@ -"shared/services/settings.service" | papi-dts

    Namespace "shared/services/settings.service"

    Index

    Variables

    default +"shared/services/settings.service" | papi-dts

    Namespace "shared/services/settings.service"

    Index

    Variables

    default

    Settings

    Member Visibility

    Theme

    \ No newline at end of file diff --git a/papi-dts/modules/_shared_services_settings_service_model_.html b/papi-dts/modules/_shared_services_settings_service_model_.html index 45ed294398..fca3b97de5 100644 --- a/papi-dts/modules/_shared_services_settings_service_model_.html +++ b/papi-dts/modules/_shared_services_settings_service_model_.html @@ -1,4 +1,4 @@ -"shared/services/settings.service-model" | papi-dts

    Namespace "shared/services/settings.service-model"

    Index

    Type Aliases

    AllSettingsData +"shared/services/settings.service-model" | papi-dts

    Namespace "shared/services/settings.service-model"

    Index

    Type Aliases

    AllSettingsData AllSettingsValidators ISettingsService SettingDataTypes 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 148e504804..7c5dd9ed90 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

    PapiWebViewProviderService WebViewProviderService

    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 4302856931..ae02628924 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

    Namespace "shared/services/web-view.service"

    Index

    Variables

    default

    Settings

    Member Visibility

    Theme

    \ 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 a8f2a6e9f4..5fc5fa086b 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

    Namespace "shared/services/web-view.service-model"

    Index

    Interfaces

    WebViewServiceType

    Variables

    EVENT_NAME_ON_DID_ADD_WEB_VIEW NETWORK_OBJECT_NAME_WEB_VIEW_SERVICE

    Settings

    Member Visibility

    Theme

    \ 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 4ef0ba48fa..6add8ec414 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_util_.html b/papi-dts/modules/_shared_utils_util_.html index a4e003b588..0177d422a1 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

    Enumerations

    RequestHandlerType +"shared/utils/util" | papi-dts

    Namespace "shared/utils/util"

    Index

    Enumerations

    RequestHandlerType

    Type Aliases

    ComplexRequest ComplexResponse ComplexResponseFailure diff --git a/papi-dts/types/__papi_frontend_.Papi.html b/papi-dts/types/__papi_frontend_.Papi.html index 1d46f46f0c..0cc20c99d8 100644 --- a/papi-dts/types/__papi_frontend_.Papi.html +++ b/papi-dts/types/__papi_frontend_.Papi.html @@ -1 +1 @@ -Papi | papi-dts

    Type alias Papi

    Papi: typeof "@papi/frontend".default

    Settings

    Member Visibility

    Theme

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

    Type alias Papi

    Papi: typeof "@papi/frontend".default

    Settings

    Member Visibility

    Theme

    \ 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 d2345a5712..6986e4bbfc 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.

    -

    Settings

    Member Visibility

    Theme

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    \ 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 d444bcef0a..c83fbbf90f 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

    • executionToken: ExecutionToken

      Used to save and load data from the storage service.

    • name: string

      Canonical name of the extension

    • registrations: UnsubscriberAsyncList

      Tracks all registrations made by an extension so they can be cleaned up when it is unloaded

      -

    Settings

    Member Visibility

    Theme

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    \ 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 d9b4c654b7..1c46ff43f3 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 @@ -21,4 +21,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.

    -

    • Settings

    Member Visibility

    Theme

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    \ 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 e4b8137f56..7a75aaa065 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

    Type alias ExecutionTokenType

    ExecutionTokenType: "extension"

    For now this is just for extensions, but maybe we will want to expand this in the future

    -

    Settings

    Member Visibility

    Theme

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    \ 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 a2693379a8..e02d2fc174 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

    Type alias DirectoryEntries

    DirectoryEntries: Readonly<{
        [entryType in EntryType]: Uri[]
    }>

    All entries in a directory, mapped from entry type to array of uris for the entries

    -

    Settings

    Member Visibility

    Theme

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    \ 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 b23d4e9b22..87bfca1178 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';
    -

    Settings

    Member Visibility

    Theme

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    \ 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 2da0337bde..5684b3c85a 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'
    -

    Settings

    Member Visibility

    Theme

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    \ 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 ecb7a4b3d9..ec4fdaeea5 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>;
      }
    -

    Settings

    Member Visibility

    Theme

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    \ 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 d008528a84..d00123e63b 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.

    -

    Settings

    Member Visibility

    Theme

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    \ No newline at end of file diff --git a/papi-dts/types/_papi_shared_types_.IProjectDataProvider.html b/papi-dts/types/_papi_shared_types_.IProjectDataProvider.html index 384c3d842f..d5fdbe0ea2 100644 --- a/papi-dts/types/_papi_shared_types_.IProjectDataProvider.html +++ b/papi-dts/types/_papi_shared_types_.IProjectDataProvider.html @@ -20,4 +20,4 @@

    Settings

    Member Visibility

    Theme

    \ No newline at end of file +

    Returns Promise<UnsubscriberAsync>

    Settings

    Member Visibility

    Theme

    \ No newline at end of file diff --git a/papi-dts/types/_papi_shared_types_.IProjectStorageInterpreter.html b/papi-dts/types/_papi_shared_types_.IProjectStorageInterpreter.html index aa69788d17..f0b2b32c05 100644 --- a/papi-dts/types/_papi_shared_types_.IProjectStorageInterpreter.html +++ b/papi-dts/types/_papi_shared_types_.IProjectStorageInterpreter.html @@ -50,4 +50,4 @@

    See

  • callback: ((value) => void)

    Function to run with the updated project setting value

  • options: DataProviderSubscriberOptions

    Various options to adjust how the subscriber emits updates

    -

    • Returns Promise<UnsubscriberAsync>

    Settings

    Member Visibility

    Theme

    \ No newline at end of file +

    Returns Promise<UnsubscriberAsync>

    Settings

    Member Visibility

    Theme

    \ 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 ade00ded6c..4693e24c86 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

    Type alias NotesOnlyProjectDataTypes

    NotesOnlyProjectDataTypes: MandatoryProjectDataTypes & {
        Notes: DataProviderDataType<string, string | undefined, string>;
    }

    This is just a simple example so we have more than one. It's not intended to be real.

    -

    Type declaration

    Settings

    Member Visibility

    Theme

    \ No newline at end of file +

    Type declaration

    Settings

    Member Visibility

    Theme

    \ 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 492a00df1c..f668d6c725 100644 --- a/papi-dts/types/_papi_shared_types_.PlaceholderDataTypes.html +++ b/papi-dts/types/_papi_shared_types_.PlaceholderDataTypes.html @@ -1 +1 @@ -PlaceholderDataTypes | papi-dts

    Type alias PlaceholderDataTypes

    PlaceholderDataTypes: {
        Placeholder: DataProviderDataType<{
            thing: number;
        }, string[], number>;
    }

    Type declaration

    Settings

    Member Visibility

    Theme

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

    Type alias PlaceholderDataTypes

    PlaceholderDataTypes: {
        Placeholder: DataProviderDataType<{
            thing: number;
        }, string[], number>;
    }

    Type declaration

    Settings

    Member Visibility

    Theme

    \ No newline at end of file diff --git a/papi-dts/types/_papi_shared_types_.ProjectDataTypes.html b/papi-dts/types/_papi_shared_types_.ProjectDataTypes.html index 3f13e55f86..f82cea7ff7 100644 --- a/papi-dts/types/_papi_shared_types_.ProjectDataTypes.html +++ b/papi-dts/types/_papi_shared_types_.ProjectDataTypes.html @@ -6,4 +6,4 @@ provider data types.

    Example

    ProjectDataTypes['MyExtensionProjectTypeName'] => MandatoryProjectDataTypes & {
        MyProjectData: DataProviderDataType<string, string, string>;
      }
    -

    Settings

    Member Visibility

    Theme

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    \ No newline at end of file diff --git a/papi-dts/types/_papi_shared_types_.ProjectSettingNames.html b/papi-dts/types/_papi_shared_types_.ProjectSettingNames.html index 295cbfe012..757c4d4ece 100644 --- a/papi-dts/types/_papi_shared_types_.ProjectSettingNames.html +++ b/papi-dts/types/_papi_shared_types_.ProjectSettingNames.html @@ -3,4 +3,4 @@ ProjectSettingTypes.

    Example

    'platform.fullName'
    -

    Settings

    Member Visibility

    Theme

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    \ No newline at end of file diff --git a/papi-dts/types/_papi_shared_types_.ProjectStorageDataTypes.html b/papi-dts/types/_papi_shared_types_.ProjectStorageDataTypes.html index 056cabf49c..52be073d42 100644 --- a/papi-dts/types/_papi_shared_types_.ProjectStorageDataTypes.html +++ b/papi-dts/types/_papi_shared_types_.ProjectStorageDataTypes.html @@ -7,4 +7,4 @@ Interpreters.

    Example

    ProjectStorageDataTypes['MyExtensionProjectTypeName'] => MandatoryProjectStorageDataTypes & {
        ProjectData: DataProviderDataType<
          { projectId: string; section: number },
          string | undefined,
          string
        >;
      }
    -

    Settings

    Member Visibility

    Theme

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    \ No newline at end of file diff --git a/papi-dts/types/_papi_shared_types_.ProjectStorageProjectTypes.html b/papi-dts/types/_papi_shared_types_.ProjectStorageProjectTypes.html index 015e7d9eb2..bf3a3dac7c 100644 --- a/papi-dts/types/_papi_shared_types_.ProjectStorageProjectTypes.html +++ b/papi-dts/types/_papi_shared_types_.ProjectStorageProjectTypes.html @@ -8,4 +8,4 @@ make PSIs available to support the PDPs available.

    Example

    'platform.notesOnly'
    -

    Settings

    Member Visibility

    Theme

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    \ No newline at end of file diff --git a/papi-dts/types/_papi_shared_types_.ProjectStorageSettingDataScope.html b/papi-dts/types/_papi_shared_types_.ProjectStorageSettingDataScope.html index cfb8f8eb70..66db84fa57 100644 --- a/papi-dts/types/_papi_shared_types_.ProjectStorageSettingDataScope.html +++ b/papi-dts/types/_papi_shared_types_.ProjectStorageSettingDataScope.html @@ -3,4 +3,4 @@ PSI and adds the projectId.

    Type Parameters

    Type declaration

    • key: ProjectSettingName

      Key of the Project Setting to select

    • projectId: string

      ID for the project whose extension data to get

      -

    Settings

    Member Visibility

    Theme

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    \ 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 3b097c3ace..e199a1c35b 100644 --- a/papi-dts/types/_papi_shared_types_.ProjectTypes.html +++ b/papi-dts/types/_papi_shared_types_.ProjectTypes.html @@ -7,4 +7,4 @@ make PSIs available to support the PDPs available.

    Example

    'platform.notesOnly'
    -

    Settings

    Member Visibility

    Theme

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    \ 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 55376c5e7e..8946f2f45b 100644 --- a/papi-dts/types/_papi_shared_types_.SettingNames.html +++ b/papi-dts/types/_papi_shared_types_.SettingNames.html @@ -2,4 +2,4 @@

    Automatically includes all extensions' user settings that are added to SettingTypes.

    Example

    'platform.verseRef'
    -

    Settings

    Member Visibility

    Theme

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    \ 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 9572df0e14..6301f29067 100644 --- a/papi-dts/types/_papi_shared_types_.StuffDataTypes.html +++ b/papi-dts/types/_papi_shared_types_.StuffDataTypes.html @@ -1 +1 @@ -StuffDataTypes | papi-dts

    Type alias StuffDataTypes

    StuffDataTypes: {
        Stuff: DataProviderDataType<string, number, never>;
    }

    Type declaration

    Settings

    Member Visibility

    Theme

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

    Type alias StuffDataTypes

    StuffDataTypes: {
        Stuff: DataProviderDataType<string, number, never>;
    }

    Type declaration

    Settings

    Member Visibility

    Theme

    \ No newline at end of file diff --git a/papi-dts/types/_papi_shared_types_.WithProjectDataProviderEngineSettingMethods.html b/papi-dts/types/_papi_shared_types_.WithProjectDataProviderEngineSettingMethods.html index b0db41f57b..139e641670 100644 --- a/papi-dts/types/_papi_shared_types_.WithProjectDataProviderEngineSettingMethods.html +++ b/papi-dts/types/_papi_shared_types_.WithProjectDataProviderEngineSettingMethods.html @@ -24,4 +24,4 @@

    Throws

    If the setting validator failed.

    See

    DataProviderUpdateInstructions for more info on what to return

    Settings

    Member Visibility

    Theme

    \ No newline at end of file +

    Returns Promise<DataProviderUpdateInstructions<TProjectDataTypes & MandatoryProjectDataTypes>>

    Settings

    Member Visibility

    Theme

    \ 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 f0257f6c00..f8468527ed 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

    -

    • Settings

    Member Visibility

    Theme

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    \ 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 0e36004f2a..271c67f5d0 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

    Type alias DialogProps<TData>

    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
      • cancelDialog(): void

      • Cancels the dialog request (resolves the response with undefined) and closes the dialog

        -

        Returns void

    • rejectDialog:function
      • rejectDialog(errorMessage): void

      • Rejects the dialog request with the specified message and closes the dialog

        +

        Returns void

    • rejectDialog:function
      • rejectDialog(errorMessage): void

      • 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
      • submitDialog(data): void

      • Sends the data as a resolved response to the dialog request and closes the dialog

        +

    Returns void

  • submitDialog:function
    • submitDialog(data): void

    • 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

    • Settings

    Member Visibility

    Theme

    \ No newline at end of file +

    Returns void

    Settings

    Member Visibility

    Theme

    \ 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 3574c2e31c..4f13c679c3 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

    -

    • Settings

    Member Visibility

    Theme

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    \ 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 4b35d2e5fa..7d0433f5f4 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

    Type alias DialogDefinition<DialogTabType>

    DialogDefinition<DialogTabType>: Readonly<DialogDefinitionBase & {
        Component: ((props) => ReactElement);
        tabType: DialogTabType;
    }>

    Type Parameters

    Settings

    Member Visibility

    Theme

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

    Type alias DialogDefinition<DialogTabType>

    DialogDefinition<DialogTabType>: Readonly<DialogDefinitionBase & {
        Component: ((props) => ReactElement);
        tabType: DialogTabType;
    }>

    Type Parameters

    Settings

    Member Visibility

    Theme

    \ 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 e67a636e6e..4eb8c574c8 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

    Type alias DialogTabTypes

    DialogTabTypes: keyof DialogTypes

    Each type of dialog. These are the tab types used in the dock layout

    -

    Settings

    Member Visibility

    Theme

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    \ No newline at end of file diff --git a/papi-dts/types/_renderer_components_dialogs_dialog_definition_model_.ProjectDialogOptionsBase.html b/papi-dts/types/_renderer_components_dialogs_dialog_definition_model_.ProjectDialogOptionsBase.html index bb9fcdfe12..3fcc9a9710 100644 --- a/papi-dts/types/_renderer_components_dialogs_dialog_definition_model_.ProjectDialogOptionsBase.html +++ b/papi-dts/types/_renderer_components_dialogs_dialog_definition_model_.ProjectDialogOptionsBase.html @@ -1 +1 @@ -ProjectDialogOptionsBase | papi-dts

    Type alias ProjectDialogOptionsBase

    ProjectDialogOptionsBase: DialogOptions & ProjectMetadataFilterOptions

    Settings

    Member Visibility

    Theme

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

    Type alias ProjectDialogOptionsBase

    ProjectDialogOptionsBase: DialogOptions & ProjectMetadataFilterOptions

    Settings

    Member Visibility

    Theme

    \ 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 badb70be77..1965a41d39 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,3 +1,3 @@ SelectMultipleProjectsDialogOptions | papi-dts

    Type alias SelectMultipleProjectsDialogOptions

    SelectMultipleProjectsDialogOptions: ProjectDialogOptionsBase & {
        selectedProjectIds?: string[];
    }

    Options to provide when showing the Select Multiple Project dialog

    Type declaration

    • Optional selectedProjectIds?: string[]

      Project IDs that should start selected in the dialog

      -

    Settings

    Member Visibility

    Theme

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    \ 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 4cf5bad0d9..8b80cd1e74 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,2 +1,2 @@ SelectProjectDialogOptions | papi-dts

    Type alias SelectProjectDialogOptions

    SelectProjectDialogOptions: ProjectDialogOptionsBase

    Options to provide when showing the Select Project dialog

    -

    Settings

    Member Visibility

    Theme

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    \ No newline at end of file diff --git a/papi-dts/types/_renderer_hooks_papi_hooks_use_dialog_callback_hook_.UseDialogCallbackOptions.html b/papi-dts/types/_renderer_hooks_papi_hooks_use_dialog_callback_hook_.UseDialogCallbackOptions.html index 6d070f038c..8ebe13fc25 100644 --- a/papi-dts/types/_renderer_hooks_papi_hooks_use_dialog_callback_hook_.UseDialogCallbackOptions.html +++ b/papi-dts/types/_renderer_hooks_papi_hooks_use_dialog_callback_hook_.UseDialogCallbackOptions.html @@ -1,4 +1,4 @@ UseDialogCallbackOptions | papi-dts

    Type alias UseDialogCallbackOptions

    UseDialogCallbackOptions: {
        maximumOpenDialogs?: number;
    }

    Type declaration

    • Optional maximumOpenDialogs?: number

      How many dialogs are allowed to be open at once from this dialog callback. Calling the callback when this number of maximum open dialogs has been reached does nothing. Set to -1 for unlimited. Defaults to 1.

      -

    Settings

    Member Visibility

    Theme

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    \ 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 25a2782c7c..efd9b41fdd 100644 --- a/papi-dts/types/_shared_data_file_system_model_.Uri.html +++ b/papi-dts/types/_shared_data_file_system_model_.Uri.html @@ -24,4 +24,4 @@

    Note: projects are stored in the production version of app://projects regardless of whether you are in production or development

    -

    Settings

    Member Visibility

    Theme

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    \ 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 3f8c4cd0a1..fff1da9119 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

    Type alias ClientConnectEvent

    ClientConnectEvent: {
        clientId: number;
        didReconnect: boolean;
    }

    Event emitted when client connections are established

    -

    Type declaration

    • clientId: number
    • didReconnect: boolean

    Settings

    Member Visibility

    Theme

    \ No newline at end of file +

    Type declaration

    • clientId: number
    • didReconnect: boolean

    Settings

    Member Visibility

    Theme

    \ 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 3d1b0a7713..3a67599070 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

    Type alias ClientDisconnectEvent

    ClientDisconnectEvent: {
        clientId: number;
    }

    Event emitted when client connections are lost

    -

    Type declaration

    • clientId: number

    Settings

    Member Visibility

    Theme

    \ No newline at end of file +

    Type declaration

    • clientId: number

    Settings

    Member Visibility

    Theme

    \ 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 72af16d1a4..ba3bf8f098 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

    Type alias InternalEvent<T>

    InternalEvent<T>: {
        event: T;
        senderId: number;
    }

    Event to be sent out throughout all processes

    Type Parameters

    • T

    Type declaration

    • event: T

      Contents of the event

    • senderId: number

      The process that emitted this Event

      -

    Settings

    Member Visibility

    Theme

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    \ 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 d1fe270093..db5a447140 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

    Type alias InternalNetworkEventHandler

    InternalNetworkEventHandler: (<T>(eventType, incomingEvent) => void)

    Handler for events from on the network. Used internally between network connector and Connection Service

    -

    Type declaration

      • <T>(eventType, incomingEvent): void

      • Type Parameters

        • T

        Parameters

        Returns void

    Settings

    Member Visibility

    Theme

    \ No newline at end of file +

    Type declaration

      • <T>(eventType, incomingEvent): void

      • Type Parameters

        • T

        Parameters

        Returns void

    Settings

    Member Visibility

    Theme

    \ 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 1afd04cf15..d78f17c7f1 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

    Type alias InternalRequest<TParam>

    InternalRequest<TParam>: {
        requestId: number;
    } & ComplexRequest<TParam>

    Request to do something and to respond

    -

    Type Parameters

    • TParam = unknown

    Type declaration

    • requestId: number

    Settings

    Member Visibility

    Theme

    \ No newline at end of file +

    Type Parameters

    • TParam = unknown

    Type declaration

    • requestId: number

    Settings

    Member Visibility

    Theme

    \ 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 32f6db3963..321a6f647f 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

    Type alias InternalRequestHandler

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

    Handler for requests from the server. Used internally between network connector and Connection Service

    -

    Type declaration

    Settings

    Member Visibility

    Theme

    \ No newline at end of file +

    Type declaration

    Settings

    Member Visibility

    Theme

    \ 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 ac8d76ddb8..03b0694eaa 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

    Type alias InternalResponse<TReturn>

    InternalResponse<TReturn>: {
        requestId: number;
        requesterId: number;
        senderId: number;
    } & ComplexResponse<TReturn>

    Response to a request

    Type Parameters

    • TReturn = unknown

    Type declaration

    • requestId: number
    • requesterId: number

      The process that originally sent the Request that matches to this response

    • senderId: number

      The process that sent this Response

      -

    Settings

    Member Visibility

    Theme

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    \ 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 825dc9a92f..51f7c7cf65 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)

      Handles when a new connection is established

    • Optional didClientDisconnectHandler?: ((event) => void)

      Handles when a client disconnects

      -

    Settings

    Member Visibility

    Theme

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    \ 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 8ae6646dbb..eb2a81c1d7 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

    Type alias NetworkConnectorInfo

    NetworkConnectorInfo: Readonly<{
        clientId: number;
    }>

    Information about the network connector

    -

    Type declaration

    • clientId: number

    Settings

    Member Visibility

    Theme

    \ No newline at end of file +

    Type declaration

    • clientId: number

    Settings

    Member Visibility

    Theme

    \ 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 9242877caa..db092a2af7 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

    Type alias NetworkEventHandler

    NetworkEventHandler: (<T>(eventType, event) => void)

    Handler for events from on the network

    -

    Type declaration

      • <T>(eventType, event): void

      • Type Parameters

        • T

        Parameters

        • eventType: string
        • event: T

        Returns void

    Settings

    Member Visibility

    Theme

    \ No newline at end of file +

    Type declaration

      • <T>(eventType, event): void

      • Type Parameters

        • T

        Parameters

        • eventType: string
        • event: T

        Returns void

    Settings

    Member Visibility

    Theme

    \ 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 25662a1b02..1c204e2073 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

    Type alias RequestHandler

    RequestHandler: (<TParam, TReturn>(requestType, request) => Promise<ComplexResponse<TReturn>>)

    Handler for requests from the server

    -

    Type declaration

    Settings

    Member Visibility

    Theme

    \ No newline at end of file +

    Type declaration

    Settings

    Member Visibility

    Theme

    \ 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 1ceb3b7ab3..c4e3b1e7d1 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

    Type alias RequestRouter

    RequestRouter: ((requestType) => number)

    Function that returns a clientId to which to send the request based on the requestType

    -

    Type declaration

      • (requestType): number

      • Parameters

        • requestType: string

        Returns number

    Settings

    Member Visibility

    Theme

    \ No newline at end of file +

    Type declaration

      • (requestType): number

      • Parameters

        • requestType: string

        Returns number

    Settings

    Member Visibility

    Theme

    \ 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 d1148aa96d..3092d25d99 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

    • Settings

    Member Visibility

    Theme

    \ No newline at end of file +
  • senderId: number
  • type: ClientConnect

    • Settings

    Member Visibility

    Theme

    \ 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 cd65ad7daf..2ecdd984d8 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

    Type alias InitClient

    InitClient: {
        clientGuid: string;
        connectorInfo: NetworkConnectorInfo;
        senderId: number;
        type: InitClient;
    }

    Message sent to the client to give it NetworkConnectorInfo

    Type declaration

    • clientGuid: string

      Guid unique to this connection. Used to verify important messages like reconnecting

      -
    • connectorInfo: NetworkConnectorInfo
    • senderId: number
    • type: InitClient

    Settings

    Member Visibility

    Theme

    \ No newline at end of file +
  • connectorInfo: NetworkConnectorInfo
  • senderId: number
  • type: InitClient

    • Settings

    Member Visibility

    Theme

    \ 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 9dd0aca11b..8080779062 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

    Type alias Message

    Message: InitClient | ClientConnect | WebSocketRequest | WebSocketResponse | WebSocketEvent<unknown>

    Messages send by the WebSocket

    -

    Settings

    Member Visibility

    Theme

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    \ 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 1867e5e448..0188f30309 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

    Type alias WebSocketEvent<T>

    WebSocketEvent<T>: {
        eventType: string;
        type: Event;
    } & InternalEvent<T>

    Event to be sent out throughout all processes

    Type Parameters

    • T

    Type declaration

    • eventType: string

      What kind of event this is

      -
    • type: Event

    Settings

    Member Visibility

    Theme

    \ No newline at end of file +
  • type: Event

    • Settings

    Member Visibility

    Theme

    \ 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 55f0937a61..b184bb6f15 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

    Type alias WebSocketRequest<TParam>

    WebSocketRequest<TParam>: {
        requestType: string;
        type: Request;
    } & InternalRequest<TParam>

    Request to do something and to respond

    Type Parameters

    • TParam = unknown

    Type declaration

    • requestType: string

      What kind of request this is. Certain command, etc

      -
    • type: Request

    Settings

    Member Visibility

    Theme

    \ No newline at end of file +
  • type: Request

    • Settings

    Member Visibility

    Theme

    \ 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 a632d176bc..613c24e4bb 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

    Type alias WebSocketResponse<TReturn>

    WebSocketResponse<TReturn>: {
        requestType: string;
        type: Response;
    } & InternalResponse<TReturn>

    Response to a request

    Type Parameters

    • TReturn = unknown

    Type declaration

    • requestType: string

      What kind of request this is. Certain command, etc

      -
    • type: Response

    Settings

    Member Visibility

    Theme

    \ No newline at end of file +
  • type: Response

    • Settings

    Member Visibility

    Theme

    \ 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 05000c6f98..be45254905 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 @@ -20,4 +20,4 @@

    ＠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.

    -

    Type Parameters

    Type declaration

    Settings

    Member Visibility

    Theme

    \ No newline at end of file +

    Type Parameters

    Type declaration

    Settings

    Member Visibility

    Theme

    \ 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 7dc22c74f7..7c51f1dab4 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 @@ -27,4 +27,4 @@
  • DataProviderEngineNotifyUpdate for more information on notifyUpdate.
  • IDataProviderEngine for more information on using this type.
    • -

    Settings

    Member Visibility

    Theme

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    \ 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 b14fff55d9..995c9ef7e2 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 @@

    OR

    class MyDPE implements IDataProviderEngine<MyDataTypes> {
      notifyUpdate(updateInstructions?: DataProviderEngineNotifyUpdate<MyDataTypes>) {}
      ...
    }
    -

    Settings

    Member Visibility

    Theme

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    \ 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 d81f8d7fc7..5219aa497c 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

    -

    Settings

    Member Visibility

    Theme

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    \ 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 705e4e64b9..dfb7d3e10c 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 papi.dataProviders.get.

    Note: each set<data_type> method has a corresponding get<data_type> and subscribe<data_type> method.

    -

    Type Parameters

    Settings

    Member Visibility

    Theme

    \ No newline at end of file +

    Type Parameters

    Settings

    Member Visibility

    Theme

    \ 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 672845bbb5..d9236d2267 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

    -

    • Settings

    Member Visibility

    Theme

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    \ 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 d8841d458c..03ec1fb888 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>;
    }
    -

    Settings

    Member Visibility

    Theme

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    \ 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 e91afb6d56..8ac6b22df5 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.

    Type Parameters

    Type declaration

      • (selector): Promise<TDataType["getData"]>

      • Parameters

        • selector: TDataType["selector"]

          Tells the provider what subset of data to get

        Returns Promise<TDataType["getData"]>

    Returns

    The subset of data represented by the selector

    -

    Settings

    Member Visibility

    Theme

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    \ 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 b37d21ad7a..ff92141ec8 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

    Type alias DataProviderGetters<TDataTypes>

    DataProviderGetters<TDataTypes>: {
        [DataType in keyof TDataTypes as `get${DataType & string}`]: DataProviderGetter<TDataTypes[DataType]>
    }

    Set of all get<data_type> methods that a data provider provides according to its data types.

    Type Parameters

    See

    DataProviderGetter for more information

    -

    Settings

    Member Visibility

    Theme

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    \ 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 7c07dbeca9..7d77da05d9 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>>

    Returns

    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

    -

    Settings

    Member Visibility

    Theme

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    \ 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 7de4a4f25a..2a2e2968a6 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

    Type alias DataProviderSetters<TDataTypes>

    DataProviderSetters<TDataTypes>: {
        [DataType in keyof TDataTypes as `set${DataType & string}`]: DataProviderSetter<TDataTypes, DataType>
    }

    Set of all set<data_type> methods that a data provider provides according to its data types.

    Type Parameters

    See

    DataProviderSetter for more information

    -

    Settings

    Member Visibility

    Theme

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    \ 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 edc06b23c0..4a83e4af76 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: PlatformEventHandler<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>

    Returns

    Unsubscriber to stop listening for updates

    -

    Settings

    Member Visibility

    Theme

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    \ 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 b304fa4794..eec79e12ac 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'
    -

    Settings

    Member Visibility

    Theme

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    \ 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 97d511d0fd..50c32675f8 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

    Type alias DataProviderSubscribers<TDataTypes>

    DataProviderSubscribers<TDataTypes>: {
        [DataType in keyof TDataTypes as `subscribe${DataType & string}`]: DataProviderSubscriber<TDataTypes[DataType]>
    }

    Set of all subscribe<data_type> methods that a data provider provides according to its data types.

    Type Parameters

    See

    DataProviderSubscriber for more information

    -

    Settings

    Member Visibility

    Theme

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    \ 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 cdef698b0e..3a02e721b0 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

    Settings

    Member Visibility

    Theme

    \ No newline at end of file +

    Type Parameters

    Settings

    Member Visibility

    Theme

    \ 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 b889020600..8af361cc82 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

    Type alias DataTypeNames<TDataTypes>

    DataTypeNames<TDataTypes>: keyof TDataTypes & string

    Names of data types in a DataProviderDataTypes type. Indicates the data types that a data provider can handle (so it will have methods with these names like set<data_type>)

    Type Parameters

    See

    DataProviderDataTypes for more information

    -

    Settings

    Member Visibility

    Theme

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    \ 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 687c350d08..75d910552a 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

    -

    Settings

    Member Visibility

    Theme

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    \ 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 4c4cd7a289..3b71bca307 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

    Type alias DialogData

    DialogData: DialogOptions & {
        isDialog: true;
    }

    Data in each tab that is a dialog. Added to DialogOptions in dialog.service-host.ts

    -

    Type declaration

    • isDialog: true

    Settings

    Member Visibility

    Theme

    \ No newline at end of file +

    Type declaration

    • isDialog: true

    Settings

    Member Visibility

    Theme

    \ 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 f435bd3e9a..6e66ebee94 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

      -

    Settings

    Member Visibility

    Theme

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    \ 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 6f8ce9926d..0ac2eb012a 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

    Type alias AddWebViewEvent

    AddWebViewEvent: {
        layout: Layout;
        webView: SavedWebViewDefinition;
    }

    Event emitted when webViews are created

    -

    Type declaration

    Settings

    Member Visibility

    Theme

    \ No newline at end of file +

    Type declaration

    Settings

    Member Visibility

    Theme

    \ 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 d80e6aa389..d461e81e84 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
    • -

    Settings

    Member Visibility

    Theme

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    \ 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 0d3d37e52e..65a37bc456 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

    Type alias FloatSize

    FloatSize: {
        height: number;
        width: number;
    }

    The dimensions for a floating tab in CSS px units

    -

    Type declaration

    • height: number
    • width: number

    Settings

    Member Visibility

    Theme

    \ No newline at end of file +

    Type declaration

    Settings

    Member Visibility

    Theme

    \ 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 122362e3c8..697df8f874 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

    Type alias Layout

    Layout: TabLayout | FloatLayout | PanelLayout

    Information about how a Paranext tab fits into the dock layout

    -

    Settings

    Member Visibility

    Theme

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    \ 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 b4dcceee28..090cbb43de 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

    Type alias OnLayoutChangeRCDock

    OnLayoutChangeRCDock: ((newLayout, currentTabId?, direction?) => Promise<void>)

    Rc-dock's onLayoutChange prop made asynchronous - resolves

    -

    Type declaration

      • (newLayout, currentTabId?, direction?): Promise<void>

      • Parameters

        • newLayout: LayoutBase
        • Optional currentTabId: string
        • Optional direction: DropDirection

        Returns Promise<void>

    Settings

    Member Visibility

    Theme

    \ No newline at end of file +

    Type declaration

    Settings

    Member Visibility

    Theme

    \ 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 1919907d9b..98749edc5a 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

    Type alias PanelDirection

    PanelDirection: "left" | "right" | "bottom" | "top" | "before-tab" | "after-tab" | "maximize" | "move" | "active" | "update"

    Settings

    Member Visibility

    Theme

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

    Type alias PanelDirection

    PanelDirection: "left" | "right" | "bottom" | "top" | "before-tab" | "after-tab" | "maximize" | "move" | "active" | "update"

    Settings

    Member Visibility

    Theme

    \ 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 0b0d4b79f4..5845556237 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 @@

    Settings

    Member Visibility

    Theme

    \ No newline at end of file +

    Returns boolean

    Settings

    Member Visibility

    Theme

    \ 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 123ee49160..c181562b1b 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

    -

    • Settings

    Member Visibility

    Theme

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    \ 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 9864a268f3..5eafb88eed 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

    -

    • Settings

    Member Visibility

    Theme

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    \ 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 11b7c7c941..0b5a799011 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

    Type alias TabLoader

    TabLoader: ((savedTabInfo) => TabInfo)

    Function that takes a SavedTabInfo and creates a Paranext tab out of it. Each type of tab must provide a TabLoader.

    For now all tab creators must do their own data type verification

    -

    Type declaration

    Settings

    Member Visibility

    Theme

    \ No newline at end of file +

    Type declaration

    Settings

    Member Visibility

    Theme

    \ 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 1c0540aac7..02bacdfc31 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).

    Type declaration

    Returns

    The saved tab info for Paranext to persist. If undefined, does not save the tab

    -

    Settings

    Member Visibility

    Theme

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    \ 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 b93a975bfc..71d13668bc 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

    Type alias WebViewTabProps

    WebViewTabProps: WebViewDefinition

    Props that are passed to the web view tab component

    -

    Settings

    Member Visibility

    Theme

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    \ 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 d2454d2112..16475e8432 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

    Settings

    Member Visibility

    Theme

    \ No newline at end of file +

    Type Parameters

    Settings

    Member Visibility

    Theme

    \ 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 aa55a1e658..80df1179f3 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

    Type alias DisposableNetworkObject<T>

    DisposableNetworkObject<T>: NetworkObject<T> & Dispose

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

    Type Parameters

    See

    networkObjectService

    -

    Settings

    Member Visibility

    Theme

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    \ 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 760a10e613..d9429532be 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

    -

    Settings

    Member Visibility

    Theme

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    \ 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 1128ebca84..1ca665fd87 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

    -

    Settings

    Member Visibility

    Theme

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    \ 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 f738d38fcf..d36d778cf4 100644 --- a/papi-dts/types/_shared_models_network_object_model_.NetworkObjectDetails.html +++ b/papi-dts/types/_shared_models_network_object_model_.NetworkObjectDetails.html @@ -8,4 +8,4 @@ Data Providers => pdp) should be the same across all process on the network regardless of what programming language they use. For generic network objects, networkObject is appropriate.

    -

    Settings

    Member Visibility

    Theme

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    \ 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 8c9064cb3c..0918f668da 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

    Type alias NetworkableObject<T>

    NetworkableObject<T>: T & CannotHaveOnDidDispose

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

    Type Parameters

    • T = object

    See

    networkObjectService

    -

    Settings

    Member Visibility

    Theme

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    \ No newline at end of file diff --git a/papi-dts/types/_shared_models_project_data_provider_engine_model_.IProjectDataProviderEngine.html b/papi-dts/types/_shared_models_project_data_provider_engine_model_.IProjectDataProviderEngine.html index 6de2d43d40..b7346b94d9 100644 --- a/papi-dts/types/_shared_models_project_data_provider_engine_model_.IProjectDataProviderEngine.html +++ b/papi-dts/types/_shared_models_project_data_provider_engine_model_.IProjectDataProviderEngine.html @@ -27,4 +27,4 @@

    OR

    class MyPDPE implements IProjectDataProviderEngine<'MyProjectData'> {
      notifyUpdate(updateInstructions?: DataProviderEngineNotifyUpdate<ProjectDataTypes['MyProjectData']>) {}
      ...
    }
    -

    Settings

    Member Visibility

    Theme

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    \ 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 fd77691052..ab58b4479b 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

    Type alias ProjectDataProviderEngineTypes

    ProjectDataProviderEngineTypes: {
        [ProjectType in ProjectTypes]: IProjectDataProviderEngine<ProjectType>
    }

    All possible types for ProjectDataProviderEngines: IProjectDataProviderEngine

    -

    Settings

    Member Visibility

    Theme

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    \ 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 8e0c15bb85..d0bf1bb08a 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

    -

    • Settings

    Member Visibility

    Theme

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    \ No newline at end of file diff --git a/papi-dts/types/_shared_models_project_data_provider_model_.MandatoryProjectDataTypes.html b/papi-dts/types/_shared_models_project_data_provider_model_.MandatoryProjectDataTypes.html index bff479d976..486255a84b 100644 --- a/papi-dts/types/_shared_models_project_data_provider_model_.MandatoryProjectDataTypes.html +++ b/papi-dts/types/_shared_models_project_data_provider_model_.MandatoryProjectDataTypes.html @@ -33,4 +33,4 @@ so following this interface ensures your PDP will not break if such a requirement is implemented. -

    Type declaration

    Settings

    Member Visibility

    Theme

    On This Page

    SettingExtensionData
    \ No newline at end of file +

    Type declaration

    Settings

    Member Visibility

    Theme

    On This Page

    SettingExtensionData
    \ No newline at end of file diff --git a/papi-dts/types/_shared_models_project_data_provider_model_.WithProjectDataProviderEngineExtensionDataMethods.html b/papi-dts/types/_shared_models_project_data_provider_model_.WithProjectDataProviderEngineExtensionDataMethods.html index 6b9341cfa0..0da909c349 100644 --- a/papi-dts/types/_shared_models_project_data_provider_model_.WithProjectDataProviderEngineExtensionDataMethods.html +++ b/papi-dts/types/_shared_models_project_data_provider_model_.WithProjectDataProviderEngineExtensionDataMethods.html @@ -7,11 +7,11 @@ to this Project Data Provider

    Returns Promise<undefined | string>

    Extension project data in this project for an extension to use in serving its extension project data

    -
  • setExtensionData:function
  • setExtensionData:function

    • Settings

    Member Visibility

    Theme

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    \ 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 82d11eff88..b17af4abd2 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

    -

    • Settings

    Member Visibility

    Theme

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    \ No newline at end of file diff --git a/papi-dts/types/_shared_models_project_storage_interpreter_model_.DefaultProjectStorageDataTypes.html b/papi-dts/types/_shared_models_project_storage_interpreter_model_.DefaultProjectStorageDataTypes.html index 32601e6f49..e46f0b7fbf 100644 --- a/papi-dts/types/_shared_models_project_storage_interpreter_model_.DefaultProjectStorageDataTypes.html +++ b/papi-dts/types/_shared_models_project_storage_interpreter_model_.DefaultProjectStorageDataTypes.html @@ -20,4 +20,4 @@
  • This is an easy pattern to follow when starting to learn how to make new projectTypes in Platform.Bible.
    • -

    Type declaration

    Settings

    Member Visibility

    Theme

    On This Page

    ProjectData
    \ No newline at end of file +

    Type declaration

    Settings

    Member Visibility

    Theme

    On This Page

    ProjectData
    \ No newline at end of file diff --git a/papi-dts/types/_shared_models_project_storage_interpreter_model_.MandatoryProjectStorageDataTypes.html b/papi-dts/types/_shared_models_project_storage_interpreter_model_.MandatoryProjectStorageDataTypes.html index 94380937b9..3a4540214c 100644 --- a/papi-dts/types/_shared_models_project_storage_interpreter_model_.MandatoryProjectStorageDataTypes.html +++ b/papi-dts/types/_shared_models_project_storage_interpreter_model_.MandatoryProjectStorageDataTypes.html @@ -50,4 +50,4 @@ so following this interface ensures your PSI will not break if such a requirement is implemented. -

    Type declaration

    Settings

    Member Visibility

    Theme

    On This Page

    SettingExtensionData
    \ No newline at end of file +

    Type declaration

    Settings

    Member Visibility

    Theme

    On This Page

    SettingExtensionData
    \ No newline at end of file diff --git a/papi-dts/types/_shared_models_project_storage_interpreter_model_.ProjectStorageExtensionDataScope.html b/papi-dts/types/_shared_models_project_storage_interpreter_model_.ProjectStorageExtensionDataScope.html index 350a4978c7..fd0823f12e 100644 --- a/papi-dts/types/_shared_models_project_storage_interpreter_model_.ProjectStorageExtensionDataScope.html +++ b/papi-dts/types/_shared_models_project_storage_interpreter_model_.ProjectStorageExtensionDataScope.html @@ -1,4 +1,4 @@ ProjectStorageExtensionDataScope | papi-dts

    Type alias ProjectStorageExtensionDataScope

    ProjectStorageExtensionDataScope: ExtensionDataScope & {
        projectId: string;
    }

    Indicates to a PSI what extension data is being referenced on what project. Generally, a PDP passes calls to ExtensionData data type methods to its PSI and adds the projectId.

    Type declaration

    • projectId: string

      ID for the project whose extension data to get

      -

    Settings

    Member Visibility

    Theme

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    \ No newline at end of file diff --git a/papi-dts/types/_shared_models_project_storage_interpreter_model_.ProjectStorageProjectDataScope.html b/papi-dts/types/_shared_models_project_storage_interpreter_model_.ProjectStorageProjectDataScope.html index 27517d2f37..d4643a5a90 100644 --- a/papi-dts/types/_shared_models_project_storage_interpreter_model_.ProjectStorageProjectDataScope.html +++ b/papi-dts/types/_shared_models_project_storage_interpreter_model_.ProjectStorageProjectDataScope.html @@ -10,4 +10,4 @@ There is no way to get or set just a portion of data identified by a single dataQualifier value.

  • projectId: string

    ID for the project whose raw data chunk to get

    -

    • Settings

    Member Visibility

    Theme

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    \ 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 dcc980f6f1..b722da622c 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

    Type alias GetWebViewDefinitionUpdatableProperties

    GetWebViewDefinitionUpdatableProperties: (() => WebViewDefinitionUpdatableProperties | undefined)

    Gets the updatable properties on this WebView's WebView definition

    ＠returns updatable properties this WebView's WebView definition or undefined if not found for some reason

    -

    Type declaration

    Settings

    Member Visibility

    Theme

    \ No newline at end of file +

    Type declaration

    Settings

    Member Visibility

    Theme

    \ 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 8b3ed9d9f9..979f1fd791 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

    -

    Settings

    Member Visibility

    Theme

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    \ 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 1b88f7d4e1..bc49946f5c 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

    Type alias SavedWebViewDefinition

    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.

    -

    Settings

    Member Visibility

    Theme

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    \ 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 073c3730f6..52b85c75ff 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}` });
    -

    Type declaration

    Settings

    Member Visibility

    Theme

    \ No newline at end of file +

    Type declaration

    Settings

    Member Visibility

    Theme

    \ 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 6845a8b9eb..0af37c4a39 100644 --- a/papi-dts/types/_shared_models_web_view_model_.UseWebViewStateHook.html +++ b/papi-dts/types/_shared_models_web_view_model_.UseWebViewStateHook.html @@ -24,4 +24,4 @@

    ＠example

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

    Type declaration

    Settings

    Member Visibility

    Theme

    \ No newline at end of file +

    Type declaration

    Settings

    Member Visibility

    Theme

    \ 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 6ac0fb1319..7ff512df1f 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

    Type alias WebViewDefinition

    WebViewDefinition: WebViewDefinitionReact | WebViewDefinitionHtml | WebViewDefinitionURL

    Properties defining a type of WebView created by extensions to show web content

    -

    Settings

    Member Visibility

    Theme

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    \ 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 e493de2bd1..930a628e85 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

    -

    • Settings

    Member Visibility

    Theme

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    \ 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 e54bac7624..b5156a2198 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

    Type alias WebViewDefinitionHtml

    WebViewDefinitionHtml: WebViewDefinitionBase & {
        contentType: HTML;
    }

    WebView representation using HTML

    Type declaration

    • contentType: HTML

      Indicates this WebView uses HTML

      -

    Settings

    Member Visibility

    Theme

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    \ 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 6c21114ee0..75ba15bda2 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

    Type alias WebViewDefinitionReact

    WebViewDefinitionReact: WebViewDefinitionBase & {
        contentType?: React;
        styles?: string;
    }

    WebView representation using React

    Type declaration

    • Optional contentType?: React

      Indicates this WebView uses React

    • Optional styles?: string

      String of styles to be loaded into the iframe for this WebView

      -

    Settings

    Member Visibility

    Theme

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    \ 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 b25b85225d..c5ef24d21f 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

    Type alias WebViewDefinitionURL

    WebViewDefinitionURL: WebViewDefinitionBase & {
        contentType: URL;
    }

    WebView representation using a URL.

    Note: you can only use papi-extension: and https: urls

    Type declaration

    • contentType: URL

      Indicates this WebView uses a URL

      -

    Settings

    Member Visibility

    Theme

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    \ 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 166b9b00da..d47e67669b 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

    Type alias WebViewDefinitionUpdatableProperties

    WebViewDefinitionUpdatableProperties: Pick<WebViewDefinitionBase, "iconUrl" | "title" | "tooltip">

    The properties on a WebViewDefinition that may be updated when that webview is already displayed

    -

    Settings

    Member Visibility

    Theme

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    \ 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 a31cf8ab85..8dc7449871 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

    Type alias WebViewDefinitionUpdateInfo

    WebViewDefinitionUpdateInfo: Partial<WebViewDefinitionUpdatableProperties>

    WebViewDefinition properties for updating a WebView that is already displayed. Any unspecified properties will stay the same

    -

    Settings

    Member Visibility

    Theme

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    \ 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 8f41c1911b..cb487fc1ff 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

    Type alias WebViewId

    WebViewId: string

    ID for a specific WebView. Each WebView has a unique ID

    -

    Settings

    Member Visibility

    Theme

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    \ 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 868fb8186e..6fcdc9a32e 100644 --- a/papi-dts/types/_shared_models_web_view_model_.WebViewProps.html +++ b/papi-dts/types/_shared_models_web_view_model_.WebViewProps.html @@ -35,4 +35,4 @@

    ＠example

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

    Settings

    Member Visibility

    Theme

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    \ 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 711c0eae96..261e504c50 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

    Type alias WebViewType

    WebViewType: string

    What type a WebView is. Each WebView definition must have a unique type.

    -

    Settings

    Member Visibility

    Theme

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    \ 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 191809f77c..a58f44875b 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

    Type alias moduleSummaryComments

    moduleSummaryComments: {}

    The command service allows you to exchange messages with other components in the platform. You can register a command that other services and extensions can send you. You can send commands to other services and extensions that have registered commands.

    -

    Type declaration

      Settings

      Member Visibility

      Theme

      \ No newline at end of file +

      Type declaration

      Settings

      Member Visibility

      Theme

      \ No newline at end of file diff --git a/papi-dts/types/_shared_services_localization_service_model_.ILocalizationService.html b/papi-dts/types/_shared_services_localization_service_model_.ILocalizationService.html index 17dc72b67f..99341458b7 100644 --- a/papi-dts/types/_shared_services_localization_service_model_.ILocalizationService.html +++ b/papi-dts/types/_shared_services_localization_service_model_.ILocalizationService.html @@ -9,8 +9,8 @@ string key that corresponds to a localized value and an array of BCP 47 language codes

      Returns Promise<LocalizationData>

    • setLocalizedString:function
    • setLocalizedStrings:function
    • setLocalizedStrings:function

      • Type declaration

      Type declaration

      Settings

      Member Visibility

      Theme

      \ No newline at end of file +

      Parameters

      Returns Promise<string>

      Settings

      Member Visibility

      Theme

      \ No newline at end of file diff --git a/papi-dts/types/_shared_services_localization_service_model_.LocalizationData.html b/papi-dts/types/_shared_services_localization_service_model_.LocalizationData.html index 85bffdc040..0b50a3006f 100644 --- a/papi-dts/types/_shared_services_localization_service_model_.LocalizationData.html +++ b/papi-dts/types/_shared_services_localization_service_model_.LocalizationData.html @@ -1 +1 @@ -LocalizationData | papi-dts

      Type alias LocalizationData

      LocalizationData: {
          [localizeKey: string]: string;
      }

      Type declaration

      • [localizeKey: string]: string

      Settings

      Member Visibility

      Theme

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

      Type alias LocalizationData

      LocalizationData: {
          [localizeKey: string]: string;
      }

      Type declaration

      • [localizeKey: string]: string

      Settings

      Member Visibility

      Theme

      \ No newline at end of file diff --git a/papi-dts/types/_shared_services_localization_service_model_.LocalizationDataDataTypes.html b/papi-dts/types/_shared_services_localization_service_model_.LocalizationDataDataTypes.html index cd78de1434..c365cab3be 100644 --- a/papi-dts/types/_shared_services_localization_service_model_.LocalizationDataDataTypes.html +++ b/papi-dts/types/_shared_services_localization_service_model_.LocalizationDataDataTypes.html @@ -1 +1 @@ -LocalizationDataDataTypes | papi-dts

      Type alias LocalizationDataDataTypes

      LocalizationDataDataTypes: {
          LocalizedString: DataProviderDataType<LocalizationSelector, string, never>;
          LocalizedStrings: DataProviderDataType<LocalizationSelectors, {
              [localizeKey: string]: string;
          }, never>;
      }

      Type declaration

      Settings

      Member Visibility

      Theme

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

      Type alias LocalizationDataDataTypes

      LocalizationDataDataTypes: {
          LocalizedString: DataProviderDataType<LocalizationSelector, string, never>;
          LocalizedStrings: DataProviderDataType<LocalizationSelectors, {
              [localizeKey: string]: string;
          }, never>;
      }

      Type declaration

      Settings

      Member Visibility

      Theme

      \ No newline at end of file diff --git a/papi-dts/types/_shared_services_localization_service_model_.LocalizationMetadata.html b/papi-dts/types/_shared_services_localization_service_model_.LocalizationMetadata.html index 02b657c67b..4415e35b3d 100644 --- a/papi-dts/types/_shared_services_localization_service_model_.LocalizationMetadata.html +++ b/papi-dts/types/_shared_services_localization_service_model_.LocalizationMetadata.html @@ -1 +1 @@ -LocalizationMetadata | papi-dts

      Type alias LocalizationMetadata

      LocalizationMetadata: {
          fallbackKey: string;
          notes: string;
      }

      Type declaration

      • fallbackKey: string
      • notes: string

      Settings

      Member Visibility

      Theme

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

      Type alias LocalizationMetadata

      LocalizationMetadata: {
          fallbackKey: string;
          notes: string;
      }

      Type declaration

      • fallbackKey: string
      • notes: string

      Settings

      Member Visibility

      Theme

      \ No newline at end of file diff --git a/papi-dts/types/_shared_services_localization_service_model_.LocalizationSelector.html b/papi-dts/types/_shared_services_localization_service_model_.LocalizationSelector.html index e205f850b8..2d6d85e2a4 100644 --- a/papi-dts/types/_shared_services_localization_service_model_.LocalizationSelector.html +++ b/papi-dts/types/_shared_services_localization_service_model_.LocalizationSelector.html @@ -1 +1 @@ -LocalizationSelector | papi-dts

      Type alias LocalizationSelector

      LocalizationSelector: {
          locales?: string[];
          localizeKey: string;
      }

      Type declaration

      • Optional locales?: string[]
      • localizeKey: string

      Settings

      Member Visibility

      Theme

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

      Type alias LocalizationSelector

      LocalizationSelector: {
          locales?: string[];
          localizeKey: string;
      }

      Type declaration

      • Optional locales?: string[]
      • localizeKey: string

      Settings

      Member Visibility

      Theme

      \ No newline at end of file diff --git a/papi-dts/types/_shared_services_localization_service_model_.LocalizationSelectors.html b/papi-dts/types/_shared_services_localization_service_model_.LocalizationSelectors.html index 6e9a50c38b..5a2e30dd7b 100644 --- a/papi-dts/types/_shared_services_localization_service_model_.LocalizationSelectors.html +++ b/papi-dts/types/_shared_services_localization_service_model_.LocalizationSelectors.html @@ -1 +1 @@ -LocalizationSelectors | papi-dts

      Type alias LocalizationSelectors

      LocalizationSelectors: {
          locales?: string[];
          localizeKeys: string[];
      }

      Type declaration

      • Optional locales?: string[]
      • localizeKeys: string[]

      Settings

      Member Visibility

      Theme

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

      Type alias LocalizationSelectors

      LocalizationSelectors: {
          locales?: string[];
          localizeKeys: string[];
      }

      Type declaration

      • Optional locales?: string[]
      • localizeKeys: string[]

      Settings

      Member Visibility

      Theme

      \ No newline at end of file diff --git a/papi-dts/types/_shared_services_localization_service_model_.LocalizedStringMetadata.html b/papi-dts/types/_shared_services_localization_service_model_.LocalizedStringMetadata.html index 70b8f78d59..a7e4b585dc 100644 --- a/papi-dts/types/_shared_services_localization_service_model_.LocalizedStringMetadata.html +++ b/papi-dts/types/_shared_services_localization_service_model_.LocalizedStringMetadata.html @@ -1 +1 @@ -LocalizedStringMetadata | papi-dts

      Type alias LocalizedStringMetadata

      LocalizedStringMetadata: {
          [localizedStringKey: string]: LocalizationMetadata;
      }

      Type declaration

      Settings

      Member Visibility

      Theme

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

      Type alias LocalizedStringMetadata

      LocalizedStringMetadata: {
          [localizedStringKey: string]: LocalizationMetadata;
      }

      Type declaration

      Settings

      Member Visibility

      Theme

      \ No newline at end of file diff --git a/papi-dts/types/_shared_services_menu_data_service_model_.IMenuDataService.html b/papi-dts/types/_shared_services_menu_data_service_model_.IMenuDataService.html index cf3402cc43..630cefd693 100644 --- a/papi-dts/types/_shared_services_menu_data_service_model_.IMenuDataService.html +++ b/papi-dts/types/_shared_services_menu_data_service_model_.IMenuDataService.html @@ -2,21 +2,21 @@

      Type declaration

      Settings

      Member Visibility

      Theme

      \ No newline at end of file +

      Settings

      Member Visibility

      Theme

      \ No newline at end of file diff --git a/papi-dts/types/_shared_services_menu_data_service_model_.MenuDataDataTypes.html b/papi-dts/types/_shared_services_menu_data_service_model_.MenuDataDataTypes.html index 883fe13c1f..bef4649c63 100644 --- a/papi-dts/types/_shared_services_menu_data_service_model_.MenuDataDataTypes.html +++ b/papi-dts/types/_shared_services_menu_data_service_model_.MenuDataDataTypes.html @@ -1 +1 @@ -MenuDataDataTypes | papi-dts

      Type alias MenuDataDataTypes

      MenuDataDataTypes: {
          MainMenu: DataProviderDataType<undefined, Localized<MultiColumnMenu>, never>;
          WebViewMenu: DataProviderDataType<ReferencedItem, Localized<WebViewMenu>, never>;
      }

      Type declaration

      Settings

      Member Visibility

      Theme

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

      Type alias MenuDataDataTypes

      MenuDataDataTypes: {
          MainMenu: DataProviderDataType<undefined, Localized<MultiColumnMenu>, never>;
          WebViewMenu: DataProviderDataType<ReferencedItem, Localized<WebViewMenu>, never>;
      }

      Type declaration

      Settings

      Member Visibility

      Theme

      \ 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 3304525f66..1d8a41661b 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.

      -

      Type Parameters

      Type declaration

      Settings

      Member Visibility

      Theme

      \ No newline at end of file +

      Type Parameters

      Type declaration

      Settings

      Member Visibility

      Theme

      \ 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 8ba932c5fc..360dc1f399 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.

      -

      Type Parameters

      Type declaration

      Settings

      Member Visibility

      Theme

      \ No newline at end of file +

      Type Parameters

      Type declaration

      Settings

      Member Visibility

      Theme

      \ 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 df1648c0ce..1a447da870 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>)

      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.

      -

      Type Parameters

      • TParam = any
      • TReturn = any

      Type declaration

      Settings

      Member Visibility

      Theme

      \ No newline at end of file +

      Type Parameters

      Type declaration

      Settings

      Member Visibility

      Theme

      \ No newline at end of file diff --git a/papi-dts/types/_shared_services_project_lookup_service_model_.ProjectMetadataFilterOptions.html b/papi-dts/types/_shared_services_project_lookup_service_model_.ProjectMetadataFilterOptions.html index 2a08fa44d5..a91206ed6f 100644 --- a/papi-dts/types/_shared_services_project_lookup_service_model_.ProjectMetadataFilterOptions.html +++ b/papi-dts/types/_shared_services_project_lookup_service_model_.ProjectMetadataFilterOptions.html @@ -12,4 +12,4 @@ function) to determine if they should be included.

      Defaults to all ProjectTypes, so all projects that do not match excludeProjectTypes will be included

      -

      Settings

      Member Visibility

      Theme

      \ No newline at end of file +

      Settings

      Member Visibility

      Theme

      \ No newline at end of file diff --git a/papi-dts/types/_shared_services_project_settings_service_model_.AllProjectSettingsValidators.html b/papi-dts/types/_shared_services_project_settings_service_model_.AllProjectSettingsValidators.html index c51ddba662..668b42ca9e 100644 --- a/papi-dts/types/_shared_services_project_settings_service_model_.AllProjectSettingsValidators.html +++ b/papi-dts/types/_shared_services_project_settings_service_model_.AllProjectSettingsValidators.html @@ -1,3 +1,3 @@ AllProjectSettingsValidators | papi-dts

      Type alias AllProjectSettingsValidators

      AllProjectSettingsValidators: {
          [ProjectSettingName in ProjectSettingNames]: ProjectSettingValidator<ProjectSettingName>
      }

      Validators for all project settings. Keys are setting keys, values are functions to validate new settings

      -

      Settings

      Member Visibility

      Theme

      \ No newline at end of file +

      Settings

      Member Visibility

      Theme

      \ No newline at end of file diff --git a/papi-dts/types/_shared_services_project_settings_service_model_.ProjectSettingValidator.html b/papi-dts/types/_shared_services_project_settings_service_model_.ProjectSettingValidator.html index aa668ef7e5..c8a0f74865 100644 --- a/papi-dts/types/_shared_services_project_settings_service_model_.ProjectSettingValidator.html +++ b/papi-dts/types/_shared_services_project_settings_service_model_.ProjectSettingValidator.html @@ -1,2 +1,2 @@ ProjectSettingValidator | papi-dts

      Type alias ProjectSettingValidator<ProjectSettingName>

      ProjectSettingValidator<ProjectSettingName>: ((newValue, currentValue, allChanges, projectType) => Promise<boolean>)

      Function that validates whether a new project setting value should be allowed to be set

      -

      Type Parameters

      Type declaration

      Settings

      Member Visibility

      Theme

      \ No newline at end of file +

      Type Parameters

      Type declaration

      Settings

      Member Visibility

      Theme

      \ No newline at end of file diff --git a/papi-dts/types/_shared_services_project_settings_service_model_.SimultaneousProjectSettingsChanges.html b/papi-dts/types/_shared_services_project_settings_service_model_.SimultaneousProjectSettingsChanges.html index 19cf56b499..d4fbe98f49 100644 --- a/papi-dts/types/_shared_services_project_settings_service_model_.SimultaneousProjectSettingsChanges.html +++ b/papi-dts/types/_shared_services_project_settings_service_model_.SimultaneousProjectSettingsChanges.html @@ -1,4 +1,4 @@ SimultaneousProjectSettingsChanges | papi-dts

      Type alias SimultaneousProjectSettingsChanges

      SimultaneousProjectSettingsChanges: {
          [ProjectSettingName in ProjectSettingNames]?: {
              currentValue: ProjectSettingTypes[ProjectSettingName];
              newValue: ProjectSettingTypes[ProjectSettingName];
          }
      }

      All project settings changes being set in one batch

      Project settings may be circularly dependent on one another, so multiple project settings may need to be changed at once in some cases

      -

      Settings

      Member Visibility

      Theme

      \ No newline at end of file +

      Settings

      Member Visibility

      Theme

      \ No newline at end of file diff --git a/papi-dts/types/_shared_services_settings_service_model_.AllSettingsData.html b/papi-dts/types/_shared_services_settings_service_model_.AllSettingsData.html index 399514a235..f2c4e841f3 100644 --- a/papi-dts/types/_shared_services_settings_service_model_.AllSettingsData.html +++ b/papi-dts/types/_shared_services_settings_service_model_.AllSettingsData.html @@ -1 +1 @@ -AllSettingsData | papi-dts

      Type alias AllSettingsData

      AllSettingsData: {
          [SettingName in SettingNames]: SettingTypes[SettingName]
      }

      Settings

      Member Visibility

      Theme

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

      Type alias AllSettingsData

      AllSettingsData: {
          [SettingName in SettingNames]: SettingTypes[SettingName]
      }

      Settings

      Member Visibility

      Theme

      \ No newline at end of file diff --git a/papi-dts/types/_shared_services_settings_service_model_.AllSettingsValidators.html b/papi-dts/types/_shared_services_settings_service_model_.AllSettingsValidators.html index ad96f5754f..e89b5d7ad0 100644 --- a/papi-dts/types/_shared_services_settings_service_model_.AllSettingsValidators.html +++ b/papi-dts/types/_shared_services_settings_service_model_.AllSettingsValidators.html @@ -1,2 +1,2 @@ AllSettingsValidators | papi-dts

      Type alias AllSettingsValidators

      AllSettingsValidators: {
          [SettingName in SettingNames]: SettingValidator<SettingName>
      }

      Validators for all settings. Keys are setting keys, values are functions to validate new settings

      -

      Settings

      Member Visibility

      Theme

      \ No newline at end of file +

      Settings

      Member Visibility

      Theme

      \ No newline at end of file diff --git a/papi-dts/types/_shared_services_settings_service_model_.ISettingsService.html b/papi-dts/types/_shared_services_settings_service_model_.ISettingsService.html index cc103915ad..49df1605fc 100644 --- a/papi-dts/types/_shared_services_settings_service_model_.ISettingsService.html +++ b/papi-dts/types/_shared_services_settings_service_model_.ISettingsService.html @@ -3,23 +3,23 @@

      Returns Promise<SettingTypes[SettingName]>

      The value of the specified setting, parsed to an object. Returns default setting if setting does not exist

      Throws

      If no default value is available for the setting.

      -
    • registerValidator:function
    • registerValidator:function
    • reset:function
    • reset:function
    • set:function
    • set:function
    • subscribe:function
    • subscribe:function

      • Settings

      Member Visibility

      Theme

      \ No newline at end of file +

      Settings

      Member Visibility

      Theme

      \ No newline at end of file diff --git a/papi-dts/types/_shared_services_settings_service_model_.SettingDataTypes.html b/papi-dts/types/_shared_services_settings_service_model_.SettingDataTypes.html index 8192f34fbc..55dffcb960 100644 --- a/papi-dts/types/_shared_services_settings_service_model_.SettingDataTypes.html +++ b/papi-dts/types/_shared_services_settings_service_model_.SettingDataTypes.html @@ -9,4 +9,4 @@

      The closest possible representation of the unnamed (````) data type follows:

      '': DataProviderDataType<SettingName, SettingTypes[SettingName], SettingTypes[SettingName]>;
      -

      Type declaration

      Settings

      Member Visibility

      Theme

      \ No newline at end of file +

      Type declaration

      Settings

      Member Visibility

      Theme

      \ No newline at end of file diff --git a/papi-dts/types/_shared_services_settings_service_model_.SettingValidator.html b/papi-dts/types/_shared_services_settings_service_model_.SettingValidator.html index 770da179c6..a5713cee5f 100644 --- a/papi-dts/types/_shared_services_settings_service_model_.SettingValidator.html +++ b/papi-dts/types/_shared_services_settings_service_model_.SettingValidator.html @@ -1,2 +1,2 @@ SettingValidator | papi-dts

      Type alias SettingValidator<SettingName>

      SettingValidator<SettingName>: ((newValue, currentValue, allChanges) => Promise<boolean>)

      Function that validates whether a new setting value should be allowed to be set

      -

      Type Parameters

      Type declaration

      Settings

      Member Visibility

      Theme

      \ No newline at end of file +

      Type Parameters

      Type declaration

      Settings

      Member Visibility

      Theme

      \ No newline at end of file diff --git a/papi-dts/types/_shared_utils_util_.ComplexRequest.html b/papi-dts/types/_shared_utils_util_.ComplexRequest.html index 40d61adbe4..9e8d19db06 100644 --- a/papi-dts/types/_shared_utils_util_.ComplexRequest.html +++ b/papi-dts/types/_shared_utils_util_.ComplexRequest.html @@ -1,4 +1,4 @@ ComplexRequest | papi-dts

      Type alias ComplexRequest<TParam>

      ComplexRequest<TParam>: {
          contents: TParam;
          senderId: number;
      }

      Type of object passed to a complex request handler that provides information about the request. This type is used as the public-facing interface for requests

      Type Parameters

      • TParam = unknown

      Type declaration

      • contents: TParam
      • senderId: number

        The one who sent the request

        -

      Settings

      Member Visibility

      Theme

      \ No newline at end of file +

      Settings

      Member Visibility

      Theme

      \ No newline at end of file diff --git a/papi-dts/types/_shared_utils_util_.ComplexResponse.html b/papi-dts/types/_shared_utils_util_.ComplexResponse.html index 50603271e7..be2ac9c28d 100644 --- a/papi-dts/types/_shared_utils_util_.ComplexResponse.html +++ b/papi-dts/types/_shared_utils_util_.ComplexResponse.html @@ -1,4 +1,4 @@ ComplexResponse | papi-dts

      Type alias ComplexResponse<TReturn>

      ComplexResponse<TReturn>: ComplexResponseSuccess<TReturn> | ComplexResponseFailure

      Type of object to create when handling a complex request where you desire to provide additional information beyond the contents of the response This type is used as the public-facing interface for responses

      -

      Type Parameters

      • TReturn = unknown

      Settings

      Member Visibility

      Theme

      \ No newline at end of file +

      Type Parameters

      Settings

      Member Visibility

      Theme

      \ No newline at end of file diff --git a/papi-dts/types/_shared_utils_util_.ComplexResponseFailure.html b/papi-dts/types/_shared_utils_util_.ComplexResponseFailure.html index 402c5facea..abc8756801 100644 --- a/papi-dts/types/_shared_utils_util_.ComplexResponseFailure.html +++ b/papi-dts/types/_shared_utils_util_.ComplexResponseFailure.html @@ -1,3 +1,3 @@ ComplexResponseFailure | papi-dts

      Type alias ComplexResponseFailure

      ComplexResponseFailure: {
          errorMessage: string;
          success: false;
      }

      Type declaration

      • errorMessage: string

        Error explaining the problem that is only populated if success is false

      • success: false

        Whether the handler that created this response was successful in handling the request

        -

      Settings

      Member Visibility

      Theme

      \ No newline at end of file +

      Settings

      Member Visibility

      Theme

      \ No newline at end of file diff --git a/papi-dts/types/_shared_utils_util_.ComplexResponseSuccess.html b/papi-dts/types/_shared_utils_util_.ComplexResponseSuccess.html index 273464e0ef..e189140ed6 100644 --- a/papi-dts/types/_shared_utils_util_.ComplexResponseSuccess.html +++ b/papi-dts/types/_shared_utils_util_.ComplexResponseSuccess.html @@ -1,4 +1,4 @@ ComplexResponseSuccess | papi-dts

      Type alias ComplexResponseSuccess<TReturn>

      ComplexResponseSuccess<TReturn>: {
          contents: TReturn;
          success: true;
      }

      Type Parameters

      • TReturn = unknown

      Type declaration

      • contents: TReturn

        Content with which to respond to the request. Must be provided unless the response failed or TReturn is undefined

      • success: true

        Whether the handler that created this response was successful in handling the request

        -

      Settings

      Member Visibility

      Theme

      \ No newline at end of file +

      Settings

      Member Visibility

      Theme

      \ No newline at end of file diff --git a/papi-dts/types/_shared_utils_util_.RequestType.html b/papi-dts/types/_shared_utils_util_.RequestType.html index 6d540c0bcc..3c42f81873 100644 --- a/papi-dts/types/_shared_utils_util_.RequestType.html +++ b/papi-dts/types/_shared_utils_util_.RequestType.html @@ -1,4 +1,4 @@ RequestType | papi-dts

      Type alias RequestType

      RequestType: {
          category: string;
          directive: string;
      }

      Information about a request that tells us what to do with it

      Type declaration

      • category: string

        The general category of request

      • directive: string

        Specific identifier for this type of request

        -

      Settings

      Member Visibility

      Theme

      \ No newline at end of file +

      Settings

      Member Visibility

      Theme

      \ No newline at end of file diff --git a/papi-dts/types/_shared_utils_util_.SerializedRequestType.html b/papi-dts/types/_shared_utils_util_.SerializedRequestType.html index 3d255bae83..19653b5717 100644 --- a/papi-dts/types/_shared_utils_util_.SerializedRequestType.html +++ b/papi-dts/types/_shared_utils_util_.SerializedRequestType.html @@ -1,3 +1,3 @@ SerializedRequestType | papi-dts

      Type alias SerializedRequestType

      SerializedRequestType: `${string}${typeof REQUEST_TYPE_SEPARATOR}${string}`

      String version of a request type that tells us what to do with a request.

      Consists of two strings concatenated by a colon

      -

      Settings

      Member Visibility

      Theme

      \ No newline at end of file +

      Settings

      Member Visibility

      Theme

      \ 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 0270b34f10..bcd99172ec 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.

      -

      Settings

      Member Visibility

      Theme

      \ No newline at end of file +

      Settings

      Member Visibility

      Theme

      \ No newline at end of file diff --git a/papi-dts/variables/__papi_backend_.ProjectDataProviderEngine.html b/papi-dts/variables/__papi_backend_.ProjectDataProviderEngine.html index 553a8b04d7..9b675eebc3 100644 --- a/papi-dts/variables/__papi_backend_.ProjectDataProviderEngine.html +++ b/papi-dts/variables/__papi_backend_.ProjectDataProviderEngine.html @@ -8,4 +8,4 @@ If a Project Data Provider Engine class extends this class, it doesn't have to specify its own notifyUpdate function in order to use notifyUpdate.

      See

      IProjectDataProviderEngine for more information on extending this class.

      -

      Settings

      Member Visibility

      Theme

      \ No newline at end of file +

      Settings

      Member Visibility

      Theme

      \ 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 1b27a36ca0..0bc85bf6da 100644 --- a/papi-dts/variables/__papi_backend_.commands.html +++ b/papi-dts/variables/__papi_backend_.commands.html @@ -1,4 +1,4 @@ commands | papi-dts

      Variable commandsConst

      commands: typeof "shared/services/command.service"

      The command service allows you to exchange messages with other components in the platform. You can register a command that other services and extensions can send you. You can send commands to other services and extensions that have registered commands.

      -

      Settings

      Member Visibility

      Theme

      \ No newline at end of file +

      Settings

      Member Visibility

      Theme

      \ 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 aa96273f80..7b7158541f 100644 --- a/papi-dts/variables/__papi_backend_.dataProviders.html +++ b/papi-dts/variables/__papi_backend_.dataProviders.html @@ -1,2 +1,2 @@ dataProviders | papi-dts

      Variable dataProvidersConst

      dataProviders: DataProviderService

      Service that allows extensions to send and receive data to/from other extensions

      -

      Settings

      Member Visibility

      Theme

      \ No newline at end of file +

      Settings

      Member Visibility

      Theme

      \ 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 d510c3b618..5fd5422764 100644 --- a/papi-dts/variables/__papi_backend_.default.html +++ b/papi-dts/variables/__papi_backend_.default.html @@ -34,4 +34,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.

      -

      • Settings

      Member Visibility

      Theme

      \ No newline at end of file +

      Settings

      Member Visibility

      Theme

      \ 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 ba26605b8f..8fcbb01c18 100644 --- a/papi-dts/variables/__papi_backend_.dialogs.html +++ b/papi-dts/variables/__papi_backend_.dialogs.html @@ -1,2 +1,2 @@ dialogs | papi-dts

      Variable dialogsConst

      dialogs: DialogService

      Prompt the user for responses with dialogs

      -

      Settings

      Member Visibility

      Theme

      \ No newline at end of file +

      Settings

      Member Visibility

      Theme

      \ 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 b5ab929851..b1491a6e62 100644 --- a/papi-dts/variables/__papi_backend_.internet.html +++ b/papi-dts/variables/__papi_backend_.internet.html @@ -1,2 +1,2 @@ internet | papi-dts

      Variable internetConst

      internet: InternetService

      Service that provides a way to call fetch since the original function is not available

      -

      Settings

      Member Visibility

      Theme

      \ No newline at end of file +

      Settings

      Member Visibility

      Theme

      \ No newline at end of file diff --git a/papi-dts/variables/__papi_backend_.localization.html b/papi-dts/variables/__papi_backend_.localization.html index 3e28fa5b1a..8626e1ae2a 100644 --- a/papi-dts/variables/__papi_backend_.localization.html +++ b/papi-dts/variables/__papi_backend_.localization.html @@ -1,2 +1,2 @@ localization | papi-dts

      Variable localizationConst

      localization: ILocalizationService

      Service that allows to get and store localizations

      -

      Settings

      Member Visibility

      Theme

      \ No newline at end of file +

      Settings

      Member Visibility

      Theme

      \ 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 dbd489e432..c2d6e9ee27 100644 --- a/papi-dts/variables/__papi_backend_.logger.html +++ b/papi-dts/variables/__papi_backend_.logger.html @@ -1,2 +1,2 @@ logger | papi-dts

      Variable loggerConst

      logger: MainLogger & {
          default: MainLogger;
      }

      All extensions and services should use this logger to provide a unified output of logs

      -

      Type declaration

      • default: MainLogger

      Settings

      Member Visibility

      Theme

      \ No newline at end of file +

      Type declaration

      Settings

      Member Visibility

      Theme

      \ No newline at end of file diff --git a/papi-dts/variables/__papi_backend_.menuData.html b/papi-dts/variables/__papi_backend_.menuData.html index b873797e31..19f314bc7d 100644 --- a/papi-dts/variables/__papi_backend_.menuData.html +++ b/papi-dts/variables/__papi_backend_.menuData.html @@ -1,2 +1,2 @@ menuData | papi-dts

      Variable menuDataConst

      menuData: IMenuDataService

      Service that allows to get and store menu data

      -

      Settings

      Member Visibility

      Theme

      \ No newline at end of file +

      Settings

      Member Visibility

      Theme

      \ 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 0df2a34307..26dfda5e6e 100644 --- a/papi-dts/variables/__papi_backend_.network.html +++ b/papi-dts/variables/__papi_backend_.network.html @@ -1,2 +1,2 @@ network | papi-dts

      Variable networkConst

      network: PapiNetworkService

      Service that provides a way to send and receive network events

      -

      Settings

      Member Visibility

      Theme

      \ No newline at end of file +

      Settings

      Member Visibility

      Theme

      \ 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 385ca55888..337c7cb3d3 100644 --- a/papi-dts/variables/__papi_backend_.projectDataProviders.html +++ b/papi-dts/variables/__papi_backend_.projectDataProviders.html @@ -1,2 +1,2 @@ projectDataProviders | papi-dts

      Variable projectDataProvidersConst

      projectDataProviders: PapiBackendProjectDataProviderService

      Service that registers and gets project data providers

      -

      Settings

      Member Visibility

      Theme

      \ No newline at end of file +

      Settings

      Member Visibility

      Theme

      \ 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 2c9b349856..3b7ddf3475 100644 --- a/papi-dts/variables/__papi_backend_.projectLookup.html +++ b/papi-dts/variables/__papi_backend_.projectLookup.html @@ -1,2 +1,2 @@ projectLookup | papi-dts

      Variable projectLookupConst

      projectLookup: ProjectLookupServiceType

      Provides metadata for projects known by the platform

      -

      Settings

      Member Visibility

      Theme

      \ No newline at end of file +

      Settings

      Member Visibility

      Theme

      \ No newline at end of file diff --git a/papi-dts/variables/__papi_backend_.projectSettings.html b/papi-dts/variables/__papi_backend_.projectSettings.html index e874215561..19b22ffd07 100644 --- a/papi-dts/variables/__papi_backend_.projectSettings.html +++ b/papi-dts/variables/__papi_backend_.projectSettings.html @@ -1,3 +1,3 @@ projectSettings | papi-dts

      Variable projectSettingsConst

      projectSettings: IProjectSettingsService

      Provides utility functions that project storage interpreters should call when handling project settings

      -

      Settings

      Member Visibility

      Theme

      \ No newline at end of file +

      Settings

      Member Visibility

      Theme

      \ 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 77fe7bb181..aefc42ade2 100644 --- a/papi-dts/variables/__papi_backend_.storage.html +++ b/papi-dts/variables/__papi_backend_.storage.html @@ -1,4 +1,4 @@ storage | papi-dts

      Variable storageConst

      storage: ExtensionStorageService

      This service provides extensions in the extension host the ability to read/write data based on the extension identity and current user (as identified by the OS). This service will not work within the renderer.

      -

      Settings

      Member Visibility

      Theme

      \ No newline at end of file +

      Settings

      Member Visibility

      Theme

      \ 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 285ce586b5..84d1ea0709 100644 --- a/papi-dts/variables/__papi_backend_.webViewProviders.html +++ b/papi-dts/variables/__papi_backend_.webViewProviders.html @@ -1,2 +1,2 @@ webViewProviders | papi-dts

      Variable webViewProvidersConst

      webViewProviders: PapiWebViewProviderService

      Interface for registering webView providers

      -

      Settings

      Member Visibility

      Theme

      \ No newline at end of file +

      Settings

      Member Visibility

      Theme

      \ 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 5670c4a362..15e0579308 100644 --- a/papi-dts/variables/__papi_backend_.webViews.html +++ b/papi-dts/variables/__papi_backend_.webViews.html @@ -1,4 +1,4 @@ webViews | papi-dts

      Variable webViewsConst

      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.

      -

      Settings

      Member Visibility

      Theme

      \ No newline at end of file +

      Settings

      Member Visibility

      Theme

      \ 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 25889baaa7..11c9646bfd 100644 --- a/papi-dts/variables/__papi_core_.default.html +++ b/papi-dts/variables/__papi_core_.default.html @@ -1,2 +1,2 @@ default | papi-dts

      Variable defaultConst

      default: {}

      Exporting empty object so people don't have to put 'type' in their import statements

      -

      Type declaration

        Settings

        Member Visibility

        Theme

        \ No newline at end of file +

        Type declaration

        Settings

        Member Visibility

        Theme

        \ 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 78278ddd9d..167b0363e4 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.

        -

        Settings

        Member Visibility

        Theme

        \ No newline at end of file +

        Settings

        Member Visibility

        Theme

        \ 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 f1d59239e3..9947257287 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.

        -

        Settings

        Member Visibility

        Theme

        \ No newline at end of file +

        Settings

        Member Visibility

        Theme

        \ 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 f5a8e774a1..070ff5ad99 100644 --- a/papi-dts/variables/__papi_frontend_.commands.html +++ b/papi-dts/variables/__papi_frontend_.commands.html @@ -1,4 +1,4 @@ commands | papi-dts

        Variable commandsConst

        commands: typeof "shared/services/command.service"

        The command service allows you to exchange messages with other components in the platform. You can register a command that other services and extensions can send you. You can send commands to other services and extensions that have registered commands.

        -

        Settings

        Member Visibility

        Theme

        \ No newline at end of file +

        Settings

        Member Visibility

        Theme

        \ 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 b38b507f6e..a6b1dba3d3 100644 --- a/papi-dts/variables/__papi_frontend_.dataProviders.html +++ b/papi-dts/variables/__papi_frontend_.dataProviders.html @@ -1,2 +1,2 @@ dataProviders | papi-dts

        Variable dataProvidersConst

        dataProviders: DataProviderService

        Service that allows extensions to send and receive data to/from other extensions

        -

        Settings

        Member Visibility

        Theme

        \ No newline at end of file +

        Settings

        Member Visibility

        Theme

        \ 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 3cb4512202..49ad796632 100644 --- a/papi-dts/variables/__papi_frontend_.default.html +++ b/papi-dts/variables/__papi_frontend_.default.html @@ -23,4 +23,4 @@
      • settings: ISettingsService
      • 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.

        -

        • Settings

        Member Visibility

        Theme

        \ No newline at end of file +

        Settings

        Member Visibility

        Theme

        \ 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 619bd4f09f..ece6af1292 100644 --- a/papi-dts/variables/__papi_frontend_.dialogs.html +++ b/papi-dts/variables/__papi_frontend_.dialogs.html @@ -1,2 +1,2 @@ dialogs | papi-dts

        Variable dialogsConst

        dialogs: DialogService

        Prompt the user for responses with dialogs

        -

        Settings

        Member Visibility

        Theme

        \ No newline at end of file +

        Settings

        Member Visibility

        Theme

        \ 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 346e17f6a3..7bb6358bbc 100644 --- a/papi-dts/variables/__papi_frontend_.internet.html +++ b/papi-dts/variables/__papi_frontend_.internet.html @@ -1,2 +1,2 @@ internet | papi-dts

        Variable internetConst

        internet: InternetService

        Service that provides a way to call fetch since the original function is not available

        -

        Settings

        Member Visibility

        Theme

        \ No newline at end of file +

        Settings

        Member Visibility

        Theme

        \ No newline at end of file diff --git a/papi-dts/variables/__papi_frontend_.localization.html b/papi-dts/variables/__papi_frontend_.localization.html index cec358d2d2..46bbfeccc9 100644 --- a/papi-dts/variables/__papi_frontend_.localization.html +++ b/papi-dts/variables/__papi_frontend_.localization.html @@ -1,2 +1,2 @@ localization | papi-dts

        Variable localizationConst

        localization: ILocalizationService

        Service that allows to get and store localizations

        -

        Settings

        Member Visibility

        Theme

        \ No newline at end of file +

        Settings

        Member Visibility

        Theme

        \ 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 eba0257f86..77c4ec4ff9 100644 --- a/papi-dts/variables/__papi_frontend_.logger.html +++ b/papi-dts/variables/__papi_frontend_.logger.html @@ -1,2 +1,2 @@ logger | papi-dts

        Variable loggerConst

        logger: MainLogger & {
            default: MainLogger;
        }

        All extensions and services should use this logger to provide a unified output of logs

        -

        Type declaration

        • default: MainLogger

        Settings

        Member Visibility

        Theme

        \ No newline at end of file +

        Type declaration

        Settings

        Member Visibility

        Theme

        \ No newline at end of file diff --git a/papi-dts/variables/__papi_frontend_.menuData.html b/papi-dts/variables/__papi_frontend_.menuData.html index ff39896d8a..4c369af5bc 100644 --- a/papi-dts/variables/__papi_frontend_.menuData.html +++ b/papi-dts/variables/__papi_frontend_.menuData.html @@ -1,2 +1,2 @@ menuData | papi-dts

        Variable menuDataConst

        menuData: IMenuDataService

        Service that allows to get and store menu data

        -

        Settings

        Member Visibility

        Theme

        \ No newline at end of file +

        Settings

        Member Visibility

        Theme

        \ 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 fdb24472d2..c11b2538db 100644 --- a/papi-dts/variables/__papi_frontend_.network.html +++ b/papi-dts/variables/__papi_frontend_.network.html @@ -1,2 +1,2 @@ network | papi-dts

        Variable networkConst

        network: PapiNetworkService

        Service that provides a way to send and receive network events

        -

        Settings

        Member Visibility

        Theme

        \ No newline at end of file +

        Settings

        Member Visibility

        Theme

        \ 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 f6a6d49c26..184f3029cb 100644 --- a/papi-dts/variables/__papi_frontend_.projectDataProviders.html +++ b/papi-dts/variables/__papi_frontend_.projectDataProviders.html @@ -1,2 +1,2 @@ projectDataProviders | papi-dts

        Variable projectDataProvidersConst

        projectDataProviders: PapiFrontendProjectDataProviderService

        Service that registers and gets project data providers

        -

        Settings

        Member Visibility

        Theme

        \ No newline at end of file +

        Settings

        Member Visibility

        Theme

        \ 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 12b2df928e..141a1a80af 100644 --- a/papi-dts/variables/__papi_frontend_.projectLookup.html +++ b/papi-dts/variables/__papi_frontend_.projectLookup.html @@ -1,2 +1,2 @@ projectLookup | papi-dts

        Variable projectLookupConst

        projectLookup: ProjectLookupServiceType

        Provides metadata for projects known by the platform

        -

        Settings

        Member Visibility

        Theme

        \ No newline at end of file +

        Settings

        Member Visibility

        Theme

        \ 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 e57b7dd87a..e4504cae2e 100644 --- a/papi-dts/variables/__papi_frontend_.react.html +++ b/papi-dts/variables/__papi_frontend_.react.html @@ -1,2 +1,2 @@ react | papi-dts

        Variable reactConst

        react: typeof "@papi/frontend/react"

        React hooks that enable interacting with the papi in React components more easily.

        -

        Settings

        Member Visibility

        Theme

        \ No newline at end of file +

        Settings

        Member Visibility

        Theme

        \ 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 817d4b1717..08aa4b5173 100644 --- a/papi-dts/variables/__papi_frontend_.settings.html +++ b/papi-dts/variables/__papi_frontend_.settings.html @@ -1 +1 @@ -settings | papi-dts

        Variable settingsConst

        settings: ISettingsService

        Settings

        Member Visibility

        Theme

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

        Variable settingsConst

        settings: ISettingsService

        Settings

        Member Visibility

        Theme

        \ 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 c73a607372..5baa008eba 100644 --- a/papi-dts/variables/__papi_frontend_.webViews.html +++ b/papi-dts/variables/__papi_frontend_.webViews.html @@ -1,4 +1,4 @@ webViews | papi-dts

        Variable webViewsConst

        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.

        -

        Settings

        Member Visibility

        Theme

        \ No newline at end of file +

        Settings

        Member Visibility

        Theme

        \ 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 0acdb67e51..71e01226b7 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

        Variable defaultConst

        default: ExtensionStorageService

        This service provides extensions in the extension host the ability to read/write data based on the extension identity and current user (as identified by the OS). This service will not work within the renderer.

        -

        Settings

        Member Visibility

        Theme

        \ No newline at end of file +

        Settings

        Member Visibility

        Theme

        \ 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 694b785646..3c25fc03b0 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

        Variable defaultConst

        default: {
            registerExtension: typeof registerExtension;
            tokenIsValid: typeof tokenIsValid;
            unregisterExtension: typeof unregisterExtension;
        }

        Type declaration

        • registerExtension: typeof registerExtension
        • tokenIsValid: typeof tokenIsValid
        • unregisterExtension: typeof unregisterExtension

        Settings

        Member Visibility

        Theme

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

        Variable defaultConst

        default: {
            registerExtension: typeof registerExtension;
            tokenIsValid: typeof tokenIsValid;
            unregisterExtension: typeof unregisterExtension;
        }

        Type declaration

        • registerExtension: typeof registerExtension
        • tokenIsValid: typeof tokenIsValid
        • unregisterExtension: typeof unregisterExtension

        Settings

        Member Visibility

        Theme

        \ 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 90417e1aaf..6f39668d64 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

        Variable FILE_PROTOCOLConst

        FILE_PROTOCOL: "file://" = 'file://'

        Settings

        Member Visibility

        Theme

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

        Variable FILE_PROTOCOLConst

        FILE_PROTOCOL: "file://" = 'file://'

        Settings

        Member Visibility

        Theme

        \ 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 0888a365c1..c6ab498805 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

        Variable RESOURCES_PROTOCOLConst

        RESOURCES_PROTOCOL: "resources://" = 'resources://'

        Settings

        Member Visibility

        Theme

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

        Variable RESOURCES_PROTOCOLConst

        RESOURCES_PROTOCOL: "resources://" = 'resources://'

        Settings

        Member Visibility

        Theme

        \ 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 f58e4749e7..8c04c439d8 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 }

        -

        Settings

        Member Visibility

        Theme

        \ No newline at end of file +

        Settings

        Member Visibility

        Theme

        \ 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 c1b788318b..7d3497de17 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

        Variable SELECT_MULTIPLE_PROJECTS_DIALOG_TYPEConst

        SELECT_MULTIPLE_PROJECTS_DIALOG_TYPE: "platform.selectMultipleProjects" = 'platform.selectMultipleProjects'

        The tabType for the select multiple projects dialog in select-multiple-projects.dialog.tsx

        -

        Settings

        Member Visibility

        Theme

        \ No newline at end of file +

        Settings

        Member Visibility

        Theme

        \ 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 3dd96cee2e..b2a1308c95 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

        Variable SELECT_PROJECT_DIALOG_TYPEConst

        SELECT_PROJECT_DIALOG_TYPE: "platform.selectProject" = 'platform.selectProject'

        The tabType for the select project dialog in select-project.dialog.tsx

        -

        Settings

        Member Visibility

        Theme

        \ No newline at end of file +

        Settings

        Member Visibility

        Theme

        \ 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 b893493ff0..8d41e0a24e 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

        Variable CATEGORY_COMMANDConst

        CATEGORY_COMMAND: "command" = 'command'

        Prefix on requests that indicates that the request is a command

        -

        Settings

        Member Visibility

        Theme

        \ No newline at end of file +

        Settings

        Member Visibility

        Theme

        \ 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 32826fc180..cc4cc0c359 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

        Variable CLIENT_ID_SERVERConst

        CLIENT_ID_SERVER: 0 = 0

        "Client id" for the server

        -

        Settings

        Member Visibility

        Theme

        \ No newline at end of file +

        Settings

        Member Visibility

        Theme

        \ 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 99bce997eb..c10c8ee0e8 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

        Variable CLIENT_ID_UNASSIGNEDConst

        CLIENT_ID_UNASSIGNED: -1 = -1

        Represents when the client id has not been assigned by the server

        -

        Settings

        Member Visibility

        Theme

        \ No newline at end of file +

        Settings

        Member Visibility

        Theme

        \ 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 b83feddba7..191d6e406e 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

        Variable CONNECTOR_INFO_DISCONNECTEDConst

        CONNECTOR_INFO_DISCONNECTED: Readonly<{
            clientId: -1;
        }>

        Represents when the connector info has not been populated by the server

        -

        Type declaration

        • clientId: -1

        Settings

        Member Visibility

        Theme

        \ No newline at end of file +

        Type declaration

        Settings

        Member Visibility

        Theme

        \ 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 42823a1233..2dca32a3ee 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

        Variable WEBSOCKET_ATTEMPTS_MAXConst

        WEBSOCKET_ATTEMPTS_MAX: 5 = 5

        Number of attempts a client will make to connect to the WebSocket server before failing

        -

        Settings

        Member Visibility

        Theme

        \ No newline at end of file +

        Settings

        Member Visibility

        Theme

        \ 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 7ea243f292..1635593b80 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

        Variable WEBSOCKET_ATTEMPTS_WAITConst

        WEBSOCKET_ATTEMPTS_WAIT: 1000 = 1000

        Time in ms for the client to wait before attempting to connect to the WebSocket server again after a failure

        -

        Settings

        Member Visibility

        Theme

        \ No newline at end of file +

        Settings

        Member Visibility

        Theme

        \ 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 072396e34b..8c0146be33 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

        Variable WEBSOCKET_PORTConst

        WEBSOCKET_PORT: 8876 = 8876

        Port to use for the webSocket

        -

        Settings

        Member Visibility

        Theme

        \ No newline at end of file +

        Settings

        Member Visibility

        Theme

        \ 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 bda70e9823..ca2db73a78 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

        Variable defaultConst

        default: DataProviderService

        Service that allows extensions to send and receive data to/from other extensions

        -

        Settings

        Member Visibility

        Theme

        \ No newline at end of file +

        Settings

        Member Visibility

        Theme

        \ 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 3e11213eea..f8379389fb 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

        Variable defaultConst

        default: DialogService

        Settings

        Member Visibility

        Theme

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

        Variable defaultConst

        default: DialogService

        Settings

        Member Visibility

        Theme

        \ 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 7c3a085f1f..96491f2656 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

        Variable CATEGORY_DIALOGConst

        CATEGORY_DIALOG: "dialog" = 'dialog'

        Prefix on requests that indicates that the request is related to dialog operations

        -

        Settings

        Member Visibility

        Theme

        \ No newline at end of file +

        Settings

        Member Visibility

        Theme

        \ 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 ce867474d6..c030dcb550 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

        Variable defaultConst

        default: InternetService

        Service that provides a way to call fetch since the original function is not available

        -

        Settings

        Member Visibility

        Theme

        \ No newline at end of file +

        Settings

        Member Visibility

        Theme

        \ No newline at end of file diff --git a/papi-dts/variables/_shared_services_localization_service_.default.html b/papi-dts/variables/_shared_services_localization_service_.default.html index e15e4955b3..1fe686a63d 100644 --- a/papi-dts/variables/_shared_services_localization_service_.default.html +++ b/papi-dts/variables/_shared_services_localization_service_.default.html @@ -1 +1 @@ -default | papi-dts

        Variable defaultConst

        default: ILocalizationService

        Settings

        Member Visibility

        Theme

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

        Variable defaultConst

        default: ILocalizationService

        Settings

        Member Visibility

        Theme

        \ No newline at end of file diff --git a/papi-dts/variables/_shared_services_localization_service_model_.localizationServiceObjectToProxy.html b/papi-dts/variables/_shared_services_localization_service_model_.localizationServiceObjectToProxy.html index 0f0f9823ea..a08ef29df4 100644 --- a/papi-dts/variables/_shared_services_localization_service_model_.localizationServiceObjectToProxy.html +++ b/papi-dts/variables/_shared_services_localization_service_model_.localizationServiceObjectToProxy.html @@ -1,3 +1,3 @@ localizationServiceObjectToProxy | papi-dts

        Variable localizationServiceObjectToProxyConst

        localizationServiceObjectToProxy: Readonly<{
            dataProviderName: "platform.localizationDataServiceDataProvider";
        }>

        Type declaration

        • dataProviderName: "platform.localizationDataServiceDataProvider"

          This name is used to register the localization data provider on the papi. You can use this name to find the data provider when accessing it using the useData hook

          -

        Settings

        Member Visibility

        Theme

        \ No newline at end of file +

        Settings

        Member Visibility

        Theme

        \ No newline at end of file diff --git a/papi-dts/variables/_shared_services_localization_service_model_.localizationServiceProviderName.html b/papi-dts/variables/_shared_services_localization_service_model_.localizationServiceProviderName.html index 67714d32d7..f0cfedcd32 100644 --- a/papi-dts/variables/_shared_services_localization_service_model_.localizationServiceProviderName.html +++ b/papi-dts/variables/_shared_services_localization_service_model_.localizationServiceProviderName.html @@ -1,3 +1,3 @@ localizationServiceProviderName | papi-dts

        Variable localizationServiceProviderNameConst

        localizationServiceProviderName: "platform.localizationDataServiceDataProvider" = 'platform.localizationDataServiceDataProvider'

        This name is used to register the localization data provider on the papi. You can use this name to find the data provider when accessing it using the useData hook

        -

        Settings

        Member Visibility

        Theme

        \ No newline at end of file +

        Settings

        Member Visibility

        Theme

        \ 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 03dde9674c..1be5d5c64b 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

        Variable WARN_TAGConst

        WARN_TAG: "<WARN>" = '<WARN>'

        Settings

        Member Visibility

        Theme

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

        Variable WARN_TAGConst

        WARN_TAG: "<WARN>" = '<WARN>'

        Settings

        Member Visibility

        Theme

        \ 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 d351c1a32c..271a29eee4 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

        Variable defaultConst

        default: log.MainLogger & {
            default: log.MainLogger;
        }

        All extensions and services should use this logger to provide a unified output of logs

        -

        Type declaration

        • default: log.MainLogger

        Settings

        Member Visibility

        Theme

        \ No newline at end of file +

        Type declaration

        Settings

        Member Visibility

        Theme

        \ No newline at end of file diff --git a/papi-dts/variables/_shared_services_menu_data_service_.default.html b/papi-dts/variables/_shared_services_menu_data_service_.default.html index 349167e9ac..841e13f17d 100644 --- a/papi-dts/variables/_shared_services_menu_data_service_.default.html +++ b/papi-dts/variables/_shared_services_menu_data_service_.default.html @@ -1 +1 @@ -default | papi-dts

        Variable defaultConst

        default: IMenuDataService

        Settings

        Member Visibility

        Theme

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

        Variable defaultConst

        default: IMenuDataService

        Settings

        Member Visibility

        Theme

        \ No newline at end of file diff --git a/papi-dts/variables/_shared_services_menu_data_service_model_.menuDataServiceObjectToProxy.html b/papi-dts/variables/_shared_services_menu_data_service_model_.menuDataServiceObjectToProxy.html index bfdb543a69..724dba2eb1 100644 --- a/papi-dts/variables/_shared_services_menu_data_service_model_.menuDataServiceObjectToProxy.html +++ b/papi-dts/variables/_shared_services_menu_data_service_model_.menuDataServiceObjectToProxy.html @@ -1,3 +1,3 @@ menuDataServiceObjectToProxy | papi-dts

        Variable menuDataServiceObjectToProxyConst

        menuDataServiceObjectToProxy: Readonly<{
            dataProviderName: "platform.menuDataServiceDataProvider";
        }>

        Type declaration

        • dataProviderName: "platform.menuDataServiceDataProvider"

          This name is used to register the menu data data provider on the papi. You can use this name to find the data provider when accessing it using the useData hook

          -

        Settings

        Member Visibility

        Theme

        \ No newline at end of file +

        Settings

        Member Visibility

        Theme

        \ No newline at end of file diff --git a/papi-dts/variables/_shared_services_menu_data_service_model_.menuDataServiceProviderName.html b/papi-dts/variables/_shared_services_menu_data_service_model_.menuDataServiceProviderName.html index 391e9bb7dd..0914c33f80 100644 --- a/papi-dts/variables/_shared_services_menu_data_service_model_.menuDataServiceProviderName.html +++ b/papi-dts/variables/_shared_services_menu_data_service_model_.menuDataServiceProviderName.html @@ -1,3 +1,3 @@ menuDataServiceProviderName | papi-dts

        Variable menuDataServiceProviderNameConst

        menuDataServiceProviderName: "platform.menuDataServiceDataProvider" = 'platform.menuDataServiceDataProvider'

        This name is used to register the menu data data provider on the papi. You can use this name to find the data provider when accessing it using the useData hook

        -

        Settings

        Member Visibility

        Theme

        \ No newline at end of file +

        Settings

        Member Visibility

        Theme

        \ 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 d78840f4ff..603521bf0e 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.

        -

        Settings

        Member Visibility

        Theme

        \ No newline at end of file +

        Settings

        Member Visibility

        Theme

        \ 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 00b4168f7c..b1cba4a1ad 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

        Variable defaultConst

        default: NetworkObjectStatusServiceType

        Settings

        Member Visibility

        Theme

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

        Variable defaultConst

        default: NetworkObjectStatusServiceType

        Settings

        Member Visibility

        Theme

        \ 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 58650896eb..28181d1b98 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

        Variable networkObjectStatusServiceNetworkObjectNameConst

        networkObjectStatusServiceNetworkObjectName: "NetworkObjectStatusService" = 'NetworkObjectStatusService'

        Settings

        Member Visibility

        Theme

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

        Variable networkObjectStatusServiceNetworkObjectNameConst

        networkObjectStatusServiceNetworkObjectName: "NetworkObjectStatusService" = 'NetworkObjectStatusService'

        Settings

        Member Visibility

        Theme

        \ 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 a2d66924f7..c8fae65fb7 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

        Variable papiNetworkServiceConst

        papiNetworkService: PapiNetworkService

        Service that provides a way to send and receive network events

        -

        Settings

        Member Visibility

        Theme

        \ No newline at end of file +

        Settings

        Member Visibility

        Theme

        \ 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 79969e7e52..d9f7e1b2ae 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

        Variable papiBackendProjectDataProviderServiceConst

        papiBackendProjectDataProviderService: PapiBackendProjectDataProviderService

        Service that registers and gets project data providers

        -

        Settings

        Member Visibility

        Theme

        \ No newline at end of file +

        Settings

        Member Visibility

        Theme

        \ 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 4ec842e9ba..f27cc7589a 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

        Variable papiFrontendProjectDataProviderServiceConst

        papiFrontendProjectDataProviderService: {
            get: typeof get;
        }

        Service that gets project data providers

        -

        Type declaration

        • get: typeof get

        Settings

        Member Visibility

        Theme

        \ No newline at end of file +

        Type declaration

        Settings

        Member Visibility

        Theme

        \ 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 2ded9cbbd1..7b4fd18b2d 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

        Variable defaultConst

        default: ProjectLookupServiceType

        Settings

        Member Visibility

        Theme

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

        Variable defaultConst

        default: ProjectLookupServiceType

        Settings

        Member Visibility

        Theme

        \ 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 da11d2341c..d569e98311 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

        Variable projectLookupServiceNetworkObjectNameConst

        projectLookupServiceNetworkObjectName: "ProjectLookupService" = 'ProjectLookupService'

        Settings

        Member Visibility

        Theme

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

        Variable projectLookupServiceNetworkObjectNameConst

        projectLookupServiceNetworkObjectName: "ProjectLookupService" = 'ProjectLookupService'

        Settings

        Member Visibility

        Theme

        \ No newline at end of file diff --git a/papi-dts/variables/_shared_services_project_settings_service_.default.html b/papi-dts/variables/_shared_services_project_settings_service_.default.html index ac9f6228dc..37a742bb31 100644 --- a/papi-dts/variables/_shared_services_project_settings_service_.default.html +++ b/papi-dts/variables/_shared_services_project_settings_service_.default.html @@ -1 +1 @@ -default | papi-dts

        Variable defaultConst

        default: IProjectSettingsService

        Settings

        Member Visibility

        Theme

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

        Variable defaultConst

        default: IProjectSettingsService

        Settings

        Member Visibility

        Theme

        \ No newline at end of file diff --git a/papi-dts/variables/_shared_services_project_settings_service_model_.CATEGORY_EXTENSION_PROJECT_SETTING_VALIDATOR.html b/papi-dts/variables/_shared_services_project_settings_service_model_.CATEGORY_EXTENSION_PROJECT_SETTING_VALIDATOR.html index ea4635b371..e36a32502e 100644 --- a/papi-dts/variables/_shared_services_project_settings_service_model_.CATEGORY_EXTENSION_PROJECT_SETTING_VALIDATOR.html +++ b/papi-dts/variables/_shared_services_project_settings_service_model_.CATEGORY_EXTENSION_PROJECT_SETTING_VALIDATOR.html @@ -1,2 +1,2 @@ CATEGORY_EXTENSION_PROJECT_SETTING_VALIDATOR | papi-dts

        Variable CATEGORY_EXTENSION_PROJECT_SETTING_VALIDATORConst

        CATEGORY_EXTENSION_PROJECT_SETTING_VALIDATOR: "extensionProjectSettingValidator" = 'extensionProjectSettingValidator'

        Name prefix for registered commands that call project settings validators

        -

        Settings

        Member Visibility

        Theme

        \ No newline at end of file +

        Settings

        Member Visibility

        Theme

        \ No newline at end of file diff --git a/papi-dts/variables/_shared_services_project_settings_service_model_.projectSettingsServiceNetworkObjectName.html b/papi-dts/variables/_shared_services_project_settings_service_model_.projectSettingsServiceNetworkObjectName.html index e2f7872641..61f0c617e0 100644 --- a/papi-dts/variables/_shared_services_project_settings_service_model_.projectSettingsServiceNetworkObjectName.html +++ b/papi-dts/variables/_shared_services_project_settings_service_model_.projectSettingsServiceNetworkObjectName.html @@ -1 +1 @@ -projectSettingsServiceNetworkObjectName | papi-dts

        Variable projectSettingsServiceNetworkObjectNameConst

        projectSettingsServiceNetworkObjectName: "ProjectSettingsService" = 'ProjectSettingsService'

        Settings

        Member Visibility

        Theme

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

        Variable projectSettingsServiceNetworkObjectNameConst

        projectSettingsServiceNetworkObjectName: "ProjectSettingsService" = 'ProjectSettingsService'

        Settings

        Member Visibility

        Theme

        \ No newline at end of file diff --git a/papi-dts/variables/_shared_services_project_settings_service_model_.projectSettingsServiceObjectToProxy.html b/papi-dts/variables/_shared_services_project_settings_service_model_.projectSettingsServiceObjectToProxy.html index c3c3e9a951..1fecbf5b54 100644 --- a/papi-dts/variables/_shared_services_project_settings_service_model_.projectSettingsServiceObjectToProxy.html +++ b/papi-dts/variables/_shared_services_project_settings_service_model_.projectSettingsServiceObjectToProxy.html @@ -2,4 +2,4 @@

        Returns

        Unsubscriber that should be called whenever the providing extension is deactivated

        Settings

        Member Visibility

        Theme

        \ No newline at end of file +

        Returns Promise<UnsubscriberAsync>

        Settings

        Member Visibility

        Theme

        \ 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 7deeb90d07..44827f8fd8 100644 --- a/papi-dts/variables/_shared_services_settings_service_.default.html +++ b/papi-dts/variables/_shared_services_settings_service_.default.html @@ -1 +1 @@ -default | papi-dts

        Variable defaultConst

        default: ISettingsService

        Settings

        Member Visibility

        Theme

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

        Variable defaultConst

        default: ISettingsService

        Settings

        Member Visibility

        Theme

        \ No newline at end of file diff --git a/papi-dts/variables/_shared_services_settings_service_model_.CATEGORY_EXTENSION_SETTING_VALIDATOR.html b/papi-dts/variables/_shared_services_settings_service_model_.CATEGORY_EXTENSION_SETTING_VALIDATOR.html index 098ea4e6c8..c976845645 100644 --- a/papi-dts/variables/_shared_services_settings_service_model_.CATEGORY_EXTENSION_SETTING_VALIDATOR.html +++ b/papi-dts/variables/_shared_services_settings_service_model_.CATEGORY_EXTENSION_SETTING_VALIDATOR.html @@ -1,2 +1,2 @@ CATEGORY_EXTENSION_SETTING_VALIDATOR | papi-dts

        Variable CATEGORY_EXTENSION_SETTING_VALIDATORConst

        CATEGORY_EXTENSION_SETTING_VALIDATOR: "extensionSettingValidator" = 'extensionSettingValidator'

        Name prefix for registered commands that call settings validators

        -

        Settings

        Member Visibility

        Theme

        \ No newline at end of file +

        Settings

        Member Visibility

        Theme

        \ No newline at end of file diff --git a/papi-dts/variables/_shared_services_settings_service_model_.settingsServiceDataProviderName.html b/papi-dts/variables/_shared_services_settings_service_model_.settingsServiceDataProviderName.html index 022a0dfff1..bac49b9aa2 100644 --- a/papi-dts/variables/_shared_services_settings_service_model_.settingsServiceDataProviderName.html +++ b/papi-dts/variables/_shared_services_settings_service_model_.settingsServiceDataProviderName.html @@ -1,3 +1,3 @@ settingsServiceDataProviderName | papi-dts

        Variable settingsServiceDataProviderNameConst

        settingsServiceDataProviderName: "platform.settingsServiceDataProvider" = 'platform.settingsServiceDataProvider'

        This name is used to register the settings service data provider on the papi. You can use this name to find the data provider when accessing it using the useData hook

        -

        Settings

        Member Visibility

        Theme

        \ No newline at end of file +

        Settings

        Member Visibility

        Theme

        \ No newline at end of file diff --git a/papi-dts/variables/_shared_services_settings_service_model_.settingsServiceObjectToProxy.html b/papi-dts/variables/_shared_services_settings_service_model_.settingsServiceObjectToProxy.html index 2fc5067581..77301f7874 100644 --- a/papi-dts/variables/_shared_services_settings_service_model_.settingsServiceObjectToProxy.html +++ b/papi-dts/variables/_shared_services_settings_service_model_.settingsServiceObjectToProxy.html @@ -4,4 +4,4 @@

        Returns

        Unsubscriber that should be called whenever the providing extension is deactivated

        Settings

        Member Visibility

        Theme

        \ No newline at end of file +

        Returns Promise<UnsubscriberAsync>

        Settings

        Member Visibility

        Theme

        \ 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 740dbea8b3..fefa344599 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

        Variable defaultConst

        default: WebViewProviderService

        Settings

        Member Visibility

        Theme

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

        Variable defaultConst

        default: WebViewProviderService

        Settings

        Member Visibility

        Theme

        \ 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 7ca1083534..aab784d44b 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

        Variable papiWebViewProviderServiceConst

        papiWebViewProviderService: PapiWebViewProviderService

        Interface for registering webView providers

        -

        Settings

        Member Visibility

        Theme

        \ No newline at end of file +

        Settings

        Member Visibility

        Theme

        \ 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 8910d2f993..347ca089fd 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

        Variable defaultConst

        default: WebViewServiceType

        Settings

        Member Visibility

        Theme

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

        Variable defaultConst

        default: WebViewServiceType

        Settings

        Member Visibility

        Theme

        \ 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 6aba0a53b4..06a37fece4 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

        Variable EVENT_NAME_ON_DID_ADD_WEB_VIEWConst

        EVENT_NAME_ON_DID_ADD_WEB_VIEW: `${string}:${string}`

        Name to use when creating a network event that is fired when webViews are created

        -

        Settings

        Member Visibility

        Theme

        \ No newline at end of file +

        Settings

        Member Visibility

        Theme

        \ 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 75149f381e..9da9e00575 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

        Variable NETWORK_OBJECT_NAME_WEB_VIEW_SERVICEConst

        NETWORK_OBJECT_NAME_WEB_VIEW_SERVICE: "WebViewService" = 'WebViewService'

        Settings

        Member Visibility

        Theme

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

        Variable NETWORK_OBJECT_NAME_WEB_VIEW_SERVICEConst

        NETWORK_OBJECT_NAME_WEB_VIEW_SERVICE: "WebViewService" = 'WebViewService'

        Settings

        Member Visibility

        Theme

        \ No newline at end of file diff --git a/papi-dts/variables/_shared_utils_util_.MODULE_SIMILAR_APIS.html b/papi-dts/variables/_shared_utils_util_.MODULE_SIMILAR_APIS.html index 13d47b1d57..17cda9af3d 100644 --- a/papi-dts/variables/_shared_utils_util_.MODULE_SIMILAR_APIS.html +++ b/papi-dts/variables/_shared_utils_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

        Settings

        Member Visibility

        Theme

        \ No newline at end of file +

        Type declaration

        Settings

        Member Visibility

        Theme

        \ No newline at end of file diff --git a/papi-dts/variables/_shared_utils_util_.REQUEST_TYPE_SEPARATOR.html b/papi-dts/variables/_shared_utils_util_.REQUEST_TYPE_SEPARATOR.html index 8c42c2e433..aa4db23a47 100644 --- a/papi-dts/variables/_shared_utils_util_.REQUEST_TYPE_SEPARATOR.html +++ b/papi-dts/variables/_shared_utils_util_.REQUEST_TYPE_SEPARATOR.html @@ -1,2 +1,2 @@ REQUEST_TYPE_SEPARATOR | papi-dts

        Variable REQUEST_TYPE_SEPARATORConst

        REQUEST_TYPE_SEPARATOR: ":" = ':'

        Separator between parts of a serialized request

        -

        Settings

        Member Visibility

        Theme

        \ No newline at end of file +

        Settings

        Member Visibility

        Theme

        \ No newline at end of file diff --git a/papi-dts/variables/isPackaged.html b/papi-dts/variables/isPackaged.html index f4027f3562..61c9737dfb 100644 --- a/papi-dts/variables/isPackaged.html +++ b/papi-dts/variables/isPackaged.html @@ -1,2 +1,2 @@ isPackaged | papi-dts

        Variable isPackaged

        isPackaged: boolean

        Whether this process is packaged or running from sources

        -

        Settings

        Member Visibility

        Theme

        \ No newline at end of file +

        Settings

        Member Visibility

        Theme

        \ No newline at end of file diff --git a/papi-dts/variables/logLevel.html b/papi-dts/variables/logLevel.html index 74752d1d24..cb40470492 100644 --- a/papi-dts/variables/logLevel.html +++ b/papi-dts/variables/logLevel.html @@ -1,2 +1,2 @@ logLevel | papi-dts

        Variable logLevel

        logLevel: LogLevel

        How much logging should be recorded. Defaults to 'debug' if not packaged, 'info' if packaged

        -

        Settings

        Member Visibility

        Theme

        \ No newline at end of file +

        Settings

        Member Visibility

        Theme

        \ No newline at end of file diff --git a/papi-dts/variables/processType.html b/papi-dts/variables/processType.html index 72317ee807..997cd27169 100644 --- a/papi-dts/variables/processType.html +++ b/papi-dts/variables/processType.html @@ -1,2 +1,2 @@ processType | papi-dts

        Variable processType

        processType: ProcessType

        Type of process this is. Helps with running specific code based on which process you're in

        -

        Settings

        Member Visibility

        Theme

        \ No newline at end of file +

        Settings

        Member Visibility

        Theme

        \ No newline at end of file diff --git a/papi-dts/variables/resourcesPath.html b/papi-dts/variables/resourcesPath.html index 01c48041fc..466ff02cfa 100644 --- a/papi-dts/variables/resourcesPath.html +++ b/papi-dts/variables/resourcesPath.html @@ -1,3 +1,3 @@ resourcesPath | papi-dts

        Variable resourcesPath

        resourcesPath: string

        Path to the app's resources directory. This is a string representation of the resources uri on frontend

        -

        Settings

        Member Visibility

        Theme

        \ No newline at end of file +

        Settings

        Member Visibility

        Theme

        \ No newline at end of file diff --git a/platform-bible-react/enums/LabelPosition.html b/platform-bible-react/enums/LabelPosition.html index 694c09379c..7928b58568 100644 --- a/platform-bible-react/enums/LabelPosition.html +++ b/platform-bible-react/enums/LabelPosition.html @@ -1,5 +1,5 @@ -LabelPosition | platform-bible-react

        Enumeration LabelPosition

        Enumeration Members

        Above +LabelPosition | platform-bible-react

        Enumeration LabelPosition

        Enumeration Members

        Above After Before Below -

        Enumeration Members

        Above

        Above: "above"

        After

        After: "after"

        Before

        Before: "before"

        Below

        Below: "below"

        Settings

        Member Visibility

        Theme

        On This Page

        AboveAfterBeforeBelow
        \ No newline at end of file +

        Enumeration Members

        Above

        Above: "above"

        After

        After: "after"

        Before

        Before: "before"

        Below

        Below: "below"

        Settings

        Member Visibility

        Theme

        On This Page

        AboveAfterBeforeBelow
        \ No newline at end of file diff --git a/platform-bible-react/functions/BookChapterControl.html b/platform-bible-react/functions/BookChapterControl.html index e98889f25c..51d4ff0571 100644 --- a/platform-bible-react/functions/BookChapterControl.html +++ b/platform-bible-react/functions/BookChapterControl.html @@ -1 +1 @@ -BookChapterControl | platform-bible-react

        Function BookChapterControl

        Settings

        Member Visibility

        Theme

        \ No newline at end of file +BookChapterControl | platform-bible-react

        Function BookChapterControl

        Settings

        Member Visibility

        Theme

        \ No newline at end of file diff --git a/platform-bible-react/functions/Button.html b/platform-bible-react/functions/Button.html index 687e65844e..ae681af995 100644 --- a/platform-bible-react/functions/Button.html +++ b/platform-bible-react/functions/Button.html @@ -1,4 +1,4 @@ Button | platform-bible-react

        Function Button

        Settings

        Member Visibility

        Theme

        \ No newline at end of file +

        Parameters

        Returns Element

        Settings

        Member Visibility

        Theme

        \ No newline at end of file diff --git a/platform-bible-react/functions/ChapterRangeSelector.html b/platform-bible-react/functions/ChapterRangeSelector.html index 2e0a11e8b8..cf49fe6861 100644 --- a/platform-bible-react/functions/ChapterRangeSelector.html +++ b/platform-bible-react/functions/ChapterRangeSelector.html @@ -1 +1 @@ -ChapterRangeSelector | platform-bible-react

        Function ChapterRangeSelector

        Settings

        Member Visibility

        Theme

        \ No newline at end of file +ChapterRangeSelector | platform-bible-react

        Function ChapterRangeSelector

        Settings

        Member Visibility

        Theme

        \ No newline at end of file diff --git a/platform-bible-react/functions/Checkbox.html b/platform-bible-react/functions/Checkbox.html index a945a7d7a2..815b0adb15 100644 --- a/platform-bible-react/functions/Checkbox.html +++ b/platform-bible-react/functions/Checkbox.html @@ -1,2 +1,2 @@ Checkbox | platform-bible-react

        Function Checkbox

        Settings

        Member Visibility

        Theme

        \ No newline at end of file +

        Parameters

        Returns Element

        Settings

        Member Visibility

        Theme

        \ No newline at end of file diff --git a/platform-bible-react/functions/ComboBox.html b/platform-bible-react/functions/ComboBox.html index 3147986870..c174bd721d 100644 --- a/platform-bible-react/functions/ComboBox.html +++ b/platform-bible-react/functions/ComboBox.html @@ -1,4 +1,4 @@ ComboBox | platform-bible-react

        Function ComboBox

        Settings

        Member Visibility

        Theme

        \ No newline at end of file +

        Type Parameters

        Parameters

        Returns Element

        Settings

        Member Visibility

        Theme

        \ No newline at end of file diff --git a/platform-bible-react/functions/ContextMenu.html b/platform-bible-react/functions/ContextMenu.html index 4ba4923c5f..3ebf459904 100644 --- a/platform-bible-react/functions/ContextMenu.html +++ b/platform-bible-react/functions/ContextMenu.html @@ -4,4 +4,4 @@ component which define what menu items to display and supply a command handler for when a menu item is clicked.

        Returns undefined | null | string | number | boolean | Iterable<ReactNode> | Element

        The ContextMenu component (including the wrapped children)

        -

        Settings

        Member Visibility

        Theme

        \ No newline at end of file +

        Settings

        Member Visibility

        Theme

        \ No newline at end of file diff --git a/platform-bible-react/functions/GridMenu.html b/platform-bible-react/functions/GridMenu.html index 8c46eaf2c6..4b857f01bb 100644 --- a/platform-bible-react/functions/GridMenu.html +++ b/platform-bible-react/functions/GridMenu.html @@ -1 +1 @@ -GridMenu | platform-bible-react

        Function GridMenu

        Settings

        Member Visibility

        Theme

        \ No newline at end of file +GridMenu | platform-bible-react

        Function GridMenu

        Settings

        Member Visibility

        Theme

        \ No newline at end of file diff --git a/platform-bible-react/functions/HamburgerMenuButton.html b/platform-bible-react/functions/HamburgerMenuButton.html index 500c572a3c..574f232072 100644 --- a/platform-bible-react/functions/HamburgerMenuButton.html +++ b/platform-bible-react/functions/HamburgerMenuButton.html @@ -1 +1 @@ -HamburgerMenuButton | platform-bible-react

        Function HamburgerMenuButton

        Settings

        Member Visibility

        Theme

        \ No newline at end of file +HamburgerMenuButton | platform-bible-react

        Function HamburgerMenuButton

        Settings

        Member Visibility

        Theme

        \ No newline at end of file diff --git a/platform-bible-react/functions/IconButton.html b/platform-bible-react/functions/IconButton.html index 5f87f039c2..c0b2ee5022 100644 --- a/platform-bible-react/functions/IconButton.html +++ b/platform-bible-react/functions/IconButton.html @@ -1,4 +1,4 @@ IconButton | platform-bible-react

        Function IconButton

        Settings

        Member Visibility

        Theme

        \ No newline at end of file +

        Parameters

        Returns Element

        Settings

        Member Visibility

        Theme

        \ No newline at end of file diff --git a/platform-bible-react/functions/MenuItem.html b/platform-bible-react/functions/MenuItem.html index b8734ba9fe..5ec8659178 100644 --- a/platform-bible-react/functions/MenuItem.html +++ b/platform-bible-react/functions/MenuItem.html @@ -1 +1 @@ -MenuItem | platform-bible-react

        Function MenuItem

        Settings

        Member Visibility

        Theme

        \ No newline at end of file +MenuItem | platform-bible-react

        Function MenuItem

        Settings

        Member Visibility

        Theme

        \ No newline at end of file diff --git a/platform-bible-react/functions/RefSelector.html b/platform-bible-react/functions/RefSelector.html index 203a2381b6..b34530f964 100644 --- a/platform-bible-react/functions/RefSelector.html +++ b/platform-bible-react/functions/RefSelector.html @@ -1 +1 @@ -RefSelector | platform-bible-react

        Function RefSelector

        Settings

        Member Visibility

        Theme

        \ No newline at end of file +RefSelector | platform-bible-react

        Function RefSelector

        Settings

        Member Visibility

        Theme

        \ No newline at end of file diff --git a/platform-bible-react/functions/SearchBar.html b/platform-bible-react/functions/SearchBar.html index ad114ed42f..510d3f836d 100644 --- a/platform-bible-react/functions/SearchBar.html +++ b/platform-bible-react/functions/SearchBar.html @@ -1 +1 @@ -SearchBar | platform-bible-react

        Function SearchBar

        Settings

        Member Visibility

        Theme

        \ No newline at end of file +SearchBar | platform-bible-react

        Function SearchBar

        Settings

        Member Visibility

        Theme

        \ No newline at end of file diff --git a/platform-bible-react/functions/Slider.html b/platform-bible-react/functions/Slider.html index bad124b34a..141f29a7a6 100644 --- a/platform-bible-react/functions/Slider.html +++ b/platform-bible-react/functions/Slider.html @@ -1,4 +1,4 @@ Slider | platform-bible-react

        Function Slider

        Settings

        Member Visibility

        Theme

        \ No newline at end of file +

        Parameters

        Returns Element

        Settings

        Member Visibility

        Theme

        \ No newline at end of file diff --git a/platform-bible-react/functions/Snackbar.html b/platform-bible-react/functions/Snackbar.html index 2b032d0811..9696b8fb8a 100644 --- a/platform-bible-react/functions/Snackbar.html +++ b/platform-bible-react/functions/Snackbar.html @@ -1,4 +1,4 @@ Snackbar | platform-bible-react

        Function Snackbar

        Settings

        Member Visibility

        Theme

        \ No newline at end of file +

        Parameters

        Returns Element

        Settings

        Member Visibility

        Theme

        \ No newline at end of file diff --git a/platform-bible-react/functions/Switch.html b/platform-bible-react/functions/Switch.html index 1efe6c6cf5..dfa0392e12 100644 --- a/platform-bible-react/functions/Switch.html +++ b/platform-bible-react/functions/Switch.html @@ -1,4 +1,4 @@ Switch | platform-bible-react

        Function Switch

        Settings

        Member Visibility

        Theme

        \ No newline at end of file +

        Parameters

        Returns Element

        Settings

        Member Visibility

        Theme

        \ No newline at end of file diff --git a/platform-bible-react/functions/Table.html b/platform-bible-react/functions/Table.html index b01ce90c06..c586a7a1b8 100644 --- a/platform-bible-react/functions/Table.html +++ b/platform-bible-react/functions/Table.html @@ -1,4 +1,4 @@ Table | platform-bible-react

        Function Table

        Settings

        Member Visibility

        Theme

        \ No newline at end of file +

        Type Parameters

        Parameters

        Returns Element

        Settings

        Member Visibility

        Theme

        \ No newline at end of file diff --git a/platform-bible-react/functions/TextField.html b/platform-bible-react/functions/TextField.html index 03671b76ec..d9568df397 100644 --- a/platform-bible-react/functions/TextField.html +++ b/platform-bible-react/functions/TextField.html @@ -1,4 +1,4 @@ TextField | platform-bible-react

        Function TextField

        Settings

        Member Visibility

        Theme

        \ No newline at end of file +

        Parameters

        Returns Element

        Settings

        Member Visibility

        Theme

        \ No newline at end of file diff --git a/platform-bible-react/functions/Toolbar.html b/platform-bible-react/functions/Toolbar.html index d78760a9da..9c2424a1b1 100644 --- a/platform-bible-react/functions/Toolbar.html +++ b/platform-bible-react/functions/Toolbar.html @@ -1 +1 @@ -Toolbar | platform-bible-react

        Function Toolbar

        Settings

        Member Visibility

        Theme

        \ No newline at end of file +Toolbar | platform-bible-react

        Function Toolbar

        Settings

        Member Visibility

        Theme

        \ No newline at end of file diff --git a/platform-bible-react/functions/useEvent.html b/platform-bible-react/functions/useEvent.html index 9ecc5739d4..080579d4b2 100644 --- a/platform-bible-react/functions/useEvent.html +++ b/platform-bible-react/functions/useEvent.html @@ -9,4 +9,4 @@
      • eventHandler: PlatformEventHandler<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

        Settings

        Member Visibility

        Theme

        \ No newline at end of file +

        Returns void

        Settings

        Member Visibility

        Theme

        \ No newline at end of file diff --git a/platform-bible-react/functions/useEventAsync.html b/platform-bible-react/functions/useEventAsync.html index c9502db55f..85fa1f2402 100644 --- a/platform-bible-react/functions/useEventAsync.html +++ b/platform-bible-react/functions/useEventAsync.html @@ -10,4 +10,4 @@
      • eventHandler: PlatformEventHandler<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

        Settings

        Member Visibility

        Theme

        \ No newline at end of file +

        Returns void

        Settings

        Member Visibility

        Theme

        \ No newline at end of file diff --git a/platform-bible-react/functions/usePromise.html b/platform-bible-react/functions/usePromise.html index e7507fe68d..1a01108375 100644 --- a/platform-bible-react/functions/usePromise.html +++ b/platform-bible-react/functions/usePromise.html @@ -21,4 +21,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
        • -

        Settings

        Member Visibility

        Theme

        \ No newline at end of file +

        Settings

        Member Visibility

        Theme

        \ No newline at end of file diff --git a/platform-bible-react/interfaces/CommandHandler.html b/platform-bible-react/interfaces/CommandHandler.html index 73efafe5f3..6d9f168755 100644 --- a/platform-bible-react/interfaces/CommandHandler.html +++ b/platform-bible-react/interfaces/CommandHandler.html @@ -1 +1 @@ -CommandHandler | platform-bible-react

        Interface CommandHandler

        interface CommandHandler ((command) => void)

        Settings

        Member Visibility

        Theme

        \ No newline at end of file +CommandHandler | platform-bible-react

        Interface CommandHandler

        interface CommandHandler ((command) => void)

        Settings

        Member Visibility

        Theme

        \ No newline at end of file diff --git a/platform-bible-react/interfaces/MultiColumnMenuProvider.html b/platform-bible-react/interfaces/MultiColumnMenuProvider.html index e0f59b37ad..7d21153851 100644 --- a/platform-bible-react/interfaces/MultiColumnMenuProvider.html +++ b/platform-bible-react/interfaces/MultiColumnMenuProvider.html @@ -1 +1 @@ -MultiColumnMenuProvider | platform-bible-react

        Interface MultiColumnMenuProvider

        interface MultiColumnMenuProvider ((isSupportAndDevelopment) => Promise<{
            columns: {
                isExtensible?: boolean;
            };
            groups: {};
            items: ({
                group: string;
                id: string;
                label: string;
                localizeNotes: string;
                order: number;
                searchTerms?: string;
                tooltip?: string;
            } | {
                command: string;
                group: string;
                iconPathAfter?: string;
                iconPathBefore?: string;
                label: string;
                localizeNotes: string;
                order: number;
                searchTerms?: string;
                tooltip?: string;
            })[];
        }>)
        • MultiColumnMenuProvider(isSupportAndDevelopment): Promise<{
              columns: {
                  isExtensible?: boolean;
              };
              groups: {};
              items: ({
                  group: string;
                  id: string;
                  label: string;
                  localizeNotes: string;
                  order: number;
                  searchTerms?: string;
                  tooltip?: string;
              } | {
                  command: string;
                  group: string;
                  iconPathAfter?: string;
                  iconPathBefore?: string;
                  label: string;
                  localizeNotes: string;
                  order: number;
                  searchTerms?: string;
                  tooltip?: string;
              })[];
          }>

        • Parameters

          • isSupportAndDevelopment: boolean

          Returns Promise<{
              columns: {
                  isExtensible?: boolean;
              };
              groups: {};
              items: ({
                  group: string;
                  id: string;
                  label: string;
                  localizeNotes: string;
                  order: number;
                  searchTerms?: string;
                  tooltip?: string;
              } | {
                  command: string;
                  group: string;
                  iconPathAfter?: string;
                  iconPathBefore?: string;
                  label: string;
                  localizeNotes: string;
                  order: number;
                  searchTerms?: string;
                  tooltip?: string;
              })[];
          }>

        Settings

        Member Visibility

        Theme

        \ No newline at end of file +MultiColumnMenuProvider | platform-bible-react

        Interface MultiColumnMenuProvider

        interface MultiColumnMenuProvider ((isSupportAndDevelopment) => Promise<{
            columns: {
                isExtensible?: boolean;
            };
            groups: {};
            items: ({
                group: string;
                id: string;
                label: string;
                localizeNotes: string;
                order: number;
                searchTerms?: string;
                tooltip?: string;
            } | {
                command: string;
                group: string;
                iconPathAfter?: string;
                iconPathBefore?: string;
                label: string;
                localizeNotes: string;
                order: number;
                searchTerms?: string;
                tooltip?: string;
            })[];
        }>)
        • MultiColumnMenuProvider(isSupportAndDevelopment): Promise<{
              columns: {
                  isExtensible?: boolean;
              };
              groups: {};
              items: ({
                  group: string;
                  id: string;
                  label: string;
                  localizeNotes: string;
                  order: number;
                  searchTerms?: string;
                  tooltip?: string;
              } | {
                  command: string;
                  group: string;
                  iconPathAfter?: string;
                  iconPathBefore?: string;
                  label: string;
                  localizeNotes: string;
                  order: number;
                  searchTerms?: string;
                  tooltip?: string;
              })[];
          }>

        • Parameters

          • isSupportAndDevelopment: boolean

          Returns Promise<{
              columns: {
                  isExtensible?: boolean;
              };
              groups: {};
              items: ({
                  group: string;
                  id: string;
                  label: string;
                  localizeNotes: string;
                  order: number;
                  searchTerms?: string;
                  tooltip?: string;
              } | {
                  command: string;
                  group: string;
                  iconPathAfter?: string;
                  iconPathBefore?: string;
                  label: string;
                  localizeNotes: string;
                  order: number;
                  searchTerms?: string;
                  tooltip?: string;
              })[];
          }>

        Settings

        Member Visibility

        Theme

        \ No newline at end of file diff --git a/platform-bible-react/interfaces/ScrRefSelectorProps.html b/platform-bible-react/interfaces/ScrRefSelectorProps.html index b9ed7ebcc7..c91e6a0640 100644 --- a/platform-bible-react/interfaces/ScrRefSelectorProps.html +++ b/platform-bible-react/interfaces/ScrRefSelectorProps.html @@ -1,4 +1,4 @@ -ScrRefSelectorProps | platform-bible-react

        Interface ScrRefSelectorProps

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

        Properties

        handleSubmit +ScrRefSelectorProps | platform-bible-react

        Interface ScrRefSelectorProps

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

        Properties

        handleSubmit id? scrRef -

        Properties

        handleSubmit

        handleSubmit: ((scrRef) => void)

        Type declaration

          • (scrRef): void

          • Parameters

            • scrRef: ScriptureReference

            Returns void

        Optional id

        id?: string

        scrRef

        scrRef: ScriptureReference

        Settings

        Member Visibility

        Theme

        On This Page

        handleSubmitidscrRef
        \ No newline at end of file +

        Properties

        handleSubmit

        handleSubmit: ((scrRef) => void)

        Type declaration

          • (scrRef): void

          • Parameters

            • scrRef: ScriptureReference

            Returns void

        Optional id

        id?: string

        scrRef

        scrRef: ScriptureReference

        Settings

        Member Visibility

        Theme

        On This Page

        handleSubmitidscrRef
        \ No newline at end of file diff --git a/platform-bible-react/interfaces/TableCalculatedColumn.html b/platform-bible-react/interfaces/TableCalculatedColumn.html index 3de5b69d4f..1c2e7bfcca 100644 --- a/platform-bible-react/interfaces/TableCalculatedColumn.html +++ b/platform-bible-react/interfaces/TableCalculatedColumn.html @@ -1,4 +1,4 @@ -TableCalculatedColumn | platform-bible-react

        Interface TableCalculatedColumn<R>

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

        Type Parameters

        • R

        Hierarchy (view full)

        Properties

        draggable +TableCalculatedColumn | platform-bible-react

        Interface TableCalculatedColumn<R>

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

        Type Parameters

        • R

        Hierarchy (view full)

        Properties

        draggable editable? frozen idx @@ -15,14 +15,14 @@ sortDescendingFirst? sortable width -

        Properties

        Readonly draggable

        draggable: boolean

        Optional Readonly editable

        editable?: null | boolean | ((row) => boolean)

        If true, editing is enabled. If no custom cell editor is provided through renderEditCell +

        Properties

        Readonly draggable

        draggable: boolean

        Optional Readonly editable

        editable?: null | boolean | ((row) => boolean)

        If true, editing is enabled. If no custom cell editor is provided through renderEditCell 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

        Readonly frozen

        frozen: boolean

        Readonly idx

        idx: number

        Readonly isLastFrozenColumn

        isLastFrozenColumn: boolean

        Readonly key

        key: string

        A unique key to distinguish each column

        -

        Readonly level

        level: number

        Readonly maxWidth

        maxWidth: undefined | number

        Readonly minWidth

        minWidth: number

        Readonly name

        name: string | ReactElement<any, string | JSXElementConstructor<any>>

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

        -

        Readonly parent

        parent: undefined | TableCalculatedColumnParent<R>

        Readonly renderCell

        renderCell: ((props) => ReactNode)

        Type declaration

          • (props): ReactNode

          • Parameters

            • props: RenderCellProps<R, unknown>

            Returns ReactNode

        Optional Readonly renderEditCell

        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

        Readonly frozen

        frozen: boolean

        Readonly idx

        idx: number

        Readonly isLastFrozenColumn

        isLastFrozenColumn: boolean

        Readonly key

        key: string

        A unique key to distinguish each column

        +

        Readonly level

        level: number

        Readonly maxWidth

        maxWidth: undefined | number

        Readonly minWidth

        minWidth: number

        Readonly name

        name: string | ReactElement<any, string | JSXElementConstructor<any>>

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

        +

        Readonly parent

        parent: undefined | TableCalculatedColumnParent<R>

        Readonly renderCell

        renderCell: ((props) => ReactNode)

        Type declaration

          • (props): ReactNode

          • Parameters

            • props: RenderCellProps<R, unknown>

            Returns ReactNode

        Optional Readonly renderEditCell

        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

        Readonly resizable

        resizable: boolean

        Optional Readonly sortDescendingFirst

        sortDescendingFirst?: null | boolean

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

        Type declaration

        Readonly resizable

        resizable: boolean

        Optional Readonly sortDescendingFirst

        sortDescendingFirst?: null | boolean

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

        -

        Readonly sortable

        sortable: boolean

        Readonly width

        width: string | number

        Settings

        Member Visibility

        Theme

        On This Page

        draggableeditablefrozenidxisLastFrozenColumnkeylevelmaxWidthminWidthnameparentrenderCellrenderEditCellresizablesortDescendingFirstsortablewidth
        \ No newline at end of file +

        Readonly sortable

        sortable: boolean

        Readonly width

        width: string | number

        Settings

        Member Visibility

        Theme

        On This Page

        draggableeditablefrozenidxisLastFrozenColumnkeylevelmaxWidthminWidthnameparentrenderCellrenderEditCellresizablesortDescendingFirstsortablewidth
        \ No newline at end of file diff --git a/platform-bible-react/types/AnchorOrigin.html b/platform-bible-react/types/AnchorOrigin.html index d4a1493ff0..9ef38a0ae5 100644 --- a/platform-bible-react/types/AnchorOrigin.html +++ b/platform-bible-react/types/AnchorOrigin.html @@ -1 +1 @@ -AnchorOrigin | platform-bible-react

        Type alias AnchorOrigin

        AnchorOrigin: SnackbarOrigin

        Settings

        Member Visibility

        Theme

        \ No newline at end of file +AnchorOrigin | platform-bible-react

        Type alias AnchorOrigin

        AnchorOrigin: SnackbarOrigin

        Settings

        Member Visibility

        Theme

        \ No newline at end of file diff --git a/platform-bible-react/types/ButtonProps.html b/platform-bible-react/types/ButtonProps.html index 2ef4af83e8..3af5b33acc 100644 --- a/platform-bible-react/types/ButtonProps.html +++ b/platform-bible-react/types/ButtonProps.html @@ -5,4 +5,4 @@
      • Optional onClick?: MouseEventHandler<HTMLButtonElement>

        Optional click handler

      • Optional onContextMenu?: MouseEventHandler<HTMLButtonElement>

        Optional context menu handler

        -

        • Settings

        Member Visibility

        Theme

        \ No newline at end of file +

        Settings

        Member Visibility

        Theme

        \ No newline at end of file diff --git a/platform-bible-react/types/ChapterRangeSelectorProps.html b/platform-bible-react/types/ChapterRangeSelectorProps.html index da807e90c9..7fe26bcc4c 100644 --- a/platform-bible-react/types/ChapterRangeSelectorProps.html +++ b/platform-bible-react/types/ChapterRangeSelectorProps.html @@ -1 +1 @@ -ChapterRangeSelectorProps | platform-bible-react

        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

        Settings

        Member Visibility

        Theme

        \ No newline at end of file +ChapterRangeSelectorProps | platform-bible-react

        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

        Settings

        Member Visibility

        Theme

        \ No newline at end of file diff --git a/platform-bible-react/types/CheckboxProps.html b/platform-bible-react/types/CheckboxProps.html index 0baf0ab291..0de83cbeee 100644 --- a/platform-bible-react/types/CheckboxProps.html +++ b/platform-bible-react/types/CheckboxProps.html @@ -21,4 +21,4 @@

        Settings

        Member Visibility

        Theme

        \ No newline at end of file +

        Returns void

        Settings

        Member Visibility

        Theme

        \ No newline at end of file diff --git a/platform-bible-react/types/CloseReason.html b/platform-bible-react/types/CloseReason.html index 1a92cfa98a..2e98c5e63c 100644 --- a/platform-bible-react/types/CloseReason.html +++ b/platform-bible-react/types/CloseReason.html @@ -1 +1 @@ -CloseReason | platform-bible-react

        Type alias CloseReason

        CloseReason: SnackbarCloseReason

        Settings

        Member Visibility

        Theme

        \ No newline at end of file +CloseReason | platform-bible-react

        Type alias CloseReason

        CloseReason: SnackbarCloseReason

        Settings

        Member Visibility

        Theme

        \ No newline at end of file diff --git a/platform-bible-react/types/ComboBoxChangeDetails.html b/platform-bible-react/types/ComboBoxChangeDetails.html index e675ecdb90..805fca79c6 100644 --- a/platform-bible-react/types/ComboBoxChangeDetails.html +++ b/platform-bible-react/types/ComboBoxChangeDetails.html @@ -1 +1 @@ -ComboBoxChangeDetails | platform-bible-react

        Type alias ComboBoxChangeDetails<T>

        ComboBoxChangeDetails<T>: AutocompleteChangeDetails<T>

        Type Parameters

        • T

        Settings

        Member Visibility

        Theme

        \ No newline at end of file +ComboBoxChangeDetails | platform-bible-react

        Type alias ComboBoxChangeDetails<T>

        ComboBoxChangeDetails<T>: AutocompleteChangeDetails<T>

        Type Parameters

        • T

        Settings

        Member Visibility

        Theme

        \ No newline at end of file diff --git a/platform-bible-react/types/ComboBoxChangeReason.html b/platform-bible-react/types/ComboBoxChangeReason.html index 604a1d2ccc..31d5ff4fd9 100644 --- a/platform-bible-react/types/ComboBoxChangeReason.html +++ b/platform-bible-react/types/ComboBoxChangeReason.html @@ -1 +1 @@ -ComboBoxChangeReason | platform-bible-react

        Type alias ComboBoxChangeReason

        ComboBoxChangeReason: AutocompleteChangeReason

        Settings

        Member Visibility

        Theme

        \ No newline at end of file +ComboBoxChangeReason | platform-bible-react

        Type alias ComboBoxChangeReason

        ComboBoxChangeReason: AutocompleteChangeReason

        Settings

        Member Visibility

        Theme

        \ No newline at end of file diff --git a/platform-bible-react/types/ComboBoxLabelOption.html b/platform-bible-react/types/ComboBoxLabelOption.html index d81de4554b..9bdd08bb98 100644 --- a/platform-bible-react/types/ComboBoxLabelOption.html +++ b/platform-bible-react/types/ComboBoxLabelOption.html @@ -1 +1 @@ -ComboBoxLabelOption | platform-bible-react

        Type alias ComboBoxLabelOption

        ComboBoxLabelOption: {
            label: string;
        }

        Type declaration

        • label: string

        Settings

        Member Visibility

        Theme

        \ No newline at end of file +ComboBoxLabelOption | platform-bible-react

        Type alias ComboBoxLabelOption

        ComboBoxLabelOption: {
            label: string;
        }

        Type declaration

        • label: string

        Settings

        Member Visibility

        Theme

        \ No newline at end of file diff --git a/platform-bible-react/types/ComboBoxOption.html b/platform-bible-react/types/ComboBoxOption.html index 20458e1231..feb4e5cf45 100644 --- a/platform-bible-react/types/ComboBoxOption.html +++ b/platform-bible-react/types/ComboBoxOption.html @@ -1 +1 @@ -ComboBoxOption | platform-bible-react

        Type alias ComboBoxOption

        ComboBoxOption: string | number | ComboBoxLabelOption

        Settings

        Member Visibility

        Theme

        \ No newline at end of file +ComboBoxOption | platform-bible-react

        Type alias ComboBoxOption

        ComboBoxOption: string | number | ComboBoxLabelOption

        Settings

        Member Visibility

        Theme

        \ No newline at end of file diff --git a/platform-bible-react/types/ComboBoxProps.html b/platform-bible-react/types/ComboBoxProps.html index bd58992670..9954f18275 100644 --- a/platform-bible-react/types/ComboBoxProps.html +++ b/platform-bible-react/types/ComboBoxProps.html @@ -21,4 +21,4 @@
      • Optional value?: T

        The selected value that the combo box currently holds. Must be shallow equal to one of the options entries.

      • Optional width?: number

        Width of the combobox in pixels. Setting this prop overrides the isFullWidth prop

        -

        • Settings

        Member Visibility

        Theme

        \ No newline at end of file +

        Settings

        Member Visibility

        Theme

        \ No newline at end of file diff --git a/platform-bible-react/types/ComboBoxValue.html b/platform-bible-react/types/ComboBoxValue.html index 2c266426d8..bc4f6e2603 100644 --- a/platform-bible-react/types/ComboBoxValue.html +++ b/platform-bible-react/types/ComboBoxValue.html @@ -1 +1 @@ -ComboBoxValue | platform-bible-react

        Type alias ComboBoxValue<T, X, Y, Z>

        ComboBoxValue<T, X, Y, Z>: AutocompleteValue<T, X, Y, Z>

        Type Parameters

        • T
        • X
        • Y
        • Z

        Settings

        Member Visibility

        Theme

        \ No newline at end of file +ComboBoxValue | platform-bible-react

        Type alias ComboBoxValue<T, X, Y, Z>

        ComboBoxValue<T, X, Y, Z>: AutocompleteValue<T, X, Y, Z>

        Type Parameters

        • T
        • X
        • Y
        • Z

        Settings

        Member Visibility

        Theme

        \ No newline at end of file diff --git a/platform-bible-react/types/GridMenuInfo.html b/platform-bible-react/types/GridMenuInfo.html index 23b221e3e0..86ff96cf0b 100644 --- a/platform-bible-react/types/GridMenuInfo.html +++ b/platform-bible-react/types/GridMenuInfo.html @@ -1,2 +1,2 @@ GridMenuInfo | platform-bible-react

        Type alias GridMenuInfo

        GridMenuInfo: {
            multiColumnMenu: Localized<MultiColumnMenu>;
        }

        Type declaration

        • multiColumnMenu: Localized<MultiColumnMenu>

          The menu object containing information about the columns, groups, and items to display.

          -

        Settings

        Member Visibility

        Theme

        \ No newline at end of file +

        Settings

        Member Visibility

        Theme

        \ No newline at end of file diff --git a/platform-bible-react/types/GridMenuProps.html b/platform-bible-react/types/GridMenuProps.html index 00abfaace9..6a135216be 100644 --- a/platform-bible-react/types/GridMenuProps.html +++ b/platform-bible-react/types/GridMenuProps.html @@ -1,3 +1,3 @@ GridMenuProps | platform-bible-react

        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 grid menu

        • commandHandler: CommandHandler
        • Optional id?: string

          Optional unique identifier

          -

        Settings

        Member Visibility

        Theme

        \ No newline at end of file +

        Settings

        Member Visibility

        Theme

        \ No newline at end of file diff --git a/platform-bible-react/types/IconButtonProps.html b/platform-bible-react/types/IconButtonProps.html index 9eac2de67a..9e46567329 100644 --- a/platform-bible-react/types/IconButtonProps.html +++ b/platform-bible-react/types/IconButtonProps.html @@ -16,4 +16,4 @@

        Default

        false
      • Optional tooltip?: string

        Optional tooltip to display if different from the aria-label.

        -

        • Settings

        Member Visibility

        Theme

        \ No newline at end of file +

        Settings

        Member Visibility

        Theme

        \ No newline at end of file diff --git a/platform-bible-react/types/MenuItemListProps.html b/platform-bible-react/types/MenuItemListProps.html index c1c21c1705..974136953b 100644 --- a/platform-bible-react/types/MenuItemListProps.html +++ b/platform-bible-react/types/MenuItemListProps.html @@ -1,2 +1,2 @@ MenuItemListProps | platform-bible-react

        Type alias MenuItemListProps

        MenuItemListProps: MenuPropsBase & {
            columnId?: ReferencedItem;
        }

        Type declaration

        • Optional columnId?: ReferencedItem

          Optional unique (column) identifier

          -

        Settings

        Member Visibility

        Theme

        \ No newline at end of file +

        Settings

        Member Visibility

        Theme

        \ No newline at end of file diff --git a/platform-bible-react/types/SearchBarProps.html b/platform-bible-react/types/SearchBarProps.html index 57286de2ee..893d354a37 100644 --- a/platform-bible-react/types/SearchBarProps.html +++ b/platform-bible-react/types/SearchBarProps.html @@ -1,4 +1,4 @@ SearchBarProps | platform-bible-react

        Type alias SearchBarProps

        SearchBarProps: {
            isFullWidth?: boolean;
            onSearch: ((searchQuery) => void);
            placeholder?: string;
        }

        Type declaration

        • Optional isFullWidth?: boolean

          Optional boolean to set the input base to full width

        • onSearch: ((searchQuery) => void)

          Callback fired to handle the search query when button pressed

            • (searchQuery): void

            • Parameters

              • searchQuery: string

              Returns void

        • Optional placeholder?: string

          Optional string that appears in the search bar without a search string

          -

        Settings

        Member Visibility

        Theme

        \ No newline at end of file +

        Settings

        Member Visibility

        Theme

        \ No newline at end of file diff --git a/platform-bible-react/types/SliderProps.html b/platform-bible-react/types/SliderProps.html index d1cbb47dc8..6b3f875817 100644 --- a/platform-bible-react/types/SliderProps.html +++ b/platform-bible-react/types/SliderProps.html @@ -40,4 +40,4 @@

        Default

        'off'
        -

        Settings

        Member Visibility

        Theme

        \ No newline at end of file +

        Settings

        Member Visibility

        Theme

        \ No newline at end of file diff --git a/platform-bible-react/types/SnackbarContentProps.html b/platform-bible-react/types/SnackbarContentProps.html index b818730ea5..d06d6c8fd7 100644 --- a/platform-bible-react/types/SnackbarContentProps.html +++ b/platform-bible-react/types/SnackbarContentProps.html @@ -1,4 +1,4 @@ SnackbarContentProps | platform-bible-react

        Type alias SnackbarContentProps

        SnackbarContentProps: {
            action?: ReactNode;
            className?: string;
            message?: ReactNode;
        }

        Type declaration

        • Optional action?: ReactNode

          The action to display, renders after the message

        • Optional className?: string

          Additional css classes to help with unique styling of the snackbar, internal

        • Optional message?: ReactNode

          The message to display

          -

        Settings

        Member Visibility

        Theme

        \ No newline at end of file +

        Settings

        Member Visibility

        Theme

        \ No newline at end of file diff --git a/platform-bible-react/types/SnackbarProps.html b/platform-bible-react/types/SnackbarProps.html index 5104ab576b..3b0effbe6a 100644 --- a/platform-bible-react/types/SnackbarProps.html +++ b/platform-bible-react/types/SnackbarProps.html @@ -12,4 +12,4 @@
      • Optional onClose?: ((event, reason) => void)

        Optional, used to control the open prop event: Event | SyntheticEvent<Element, Event>, reason: string

        -

        • Settings

        Member Visibility

        Theme

        \ No newline at end of file +

        Settings

        Member Visibility

        Theme

        \ No newline at end of file diff --git a/platform-bible-react/types/SwitchProps.html b/platform-bible-react/types/SwitchProps.html index 8215000884..2179e11419 100644 --- a/platform-bible-react/types/SwitchProps.html +++ b/platform-bible-react/types/SwitchProps.html @@ -11,4 +11,4 @@

        Settings

        Member Visibility

        Theme

        \ No newline at end of file +

        Returns void

        Settings

        Member Visibility

        Theme

        \ No newline at end of file diff --git a/platform-bible-react/types/TableCellClickArgs.html b/platform-bible-react/types/TableCellClickArgs.html index c1de7f0b41..2a4c71b2e6 100644 --- a/platform-bible-react/types/TableCellClickArgs.html +++ b/platform-bible-react/types/TableCellClickArgs.html @@ -1 +1 @@ -TableCellClickArgs | platform-bible-react

        Type alias TableCellClickArgs<R>

        TableCellClickArgs<R>: CellClickArgs<R>

        Type Parameters

        • R

        Settings

        Member Visibility

        Theme

        \ No newline at end of file +TableCellClickArgs | platform-bible-react

        Type alias TableCellClickArgs<R>

        TableCellClickArgs<R>: CellClickArgs<R>

        Type Parameters

        • R

        Settings

        Member Visibility

        Theme

        \ No newline at end of file diff --git a/platform-bible-react/types/TableCellKeyDownArgs.html b/platform-bible-react/types/TableCellKeyDownArgs.html index 9af241d3ef..a7e8fc2c66 100644 --- a/platform-bible-react/types/TableCellKeyDownArgs.html +++ b/platform-bible-react/types/TableCellKeyDownArgs.html @@ -1 +1 @@ -TableCellKeyDownArgs | platform-bible-react

        Type alias TableCellKeyDownArgs<R>

        TableCellKeyDownArgs<R>: CellKeyDownArgs<R>

        Type Parameters

        • R

        Settings

        Member Visibility

        Theme

        \ No newline at end of file +TableCellKeyDownArgs | platform-bible-react

        Type alias TableCellKeyDownArgs<R>

        TableCellKeyDownArgs<R>: CellKeyDownArgs<R>

        Type Parameters

        • R

        Settings

        Member Visibility

        Theme

        \ No newline at end of file diff --git a/platform-bible-react/types/TableCellKeyboardEvent.html b/platform-bible-react/types/TableCellKeyboardEvent.html index 58b14e17be..ea27154a5d 100644 --- a/platform-bible-react/types/TableCellKeyboardEvent.html +++ b/platform-bible-react/types/TableCellKeyboardEvent.html @@ -1 +1 @@ -TableCellKeyboardEvent | platform-bible-react

        Type alias TableCellKeyboardEvent

        TableCellKeyboardEvent: CellKeyboardEvent

        Settings

        Member Visibility

        Theme

        \ No newline at end of file +TableCellKeyboardEvent | platform-bible-react

        Type alias TableCellKeyboardEvent

        TableCellKeyboardEvent: CellKeyboardEvent

        Settings

        Member Visibility

        Theme

        \ No newline at end of file diff --git a/platform-bible-react/types/TableCellMouseEvent.html b/platform-bible-react/types/TableCellMouseEvent.html index b6fe6d8632..cd1b4f797d 100644 --- a/platform-bible-react/types/TableCellMouseEvent.html +++ b/platform-bible-react/types/TableCellMouseEvent.html @@ -1 +1 @@ -TableCellMouseEvent | platform-bible-react

        Type alias TableCellMouseEvent

        TableCellMouseEvent: CellMouseEvent

        Settings

        Member Visibility

        Theme

        \ No newline at end of file +TableCellMouseEvent | platform-bible-react

        Type alias TableCellMouseEvent

        TableCellMouseEvent: CellMouseEvent

        Settings

        Member Visibility

        Theme

        \ No newline at end of file diff --git a/platform-bible-react/types/TableColumn.html b/platform-bible-react/types/TableColumn.html index e7e2111c38..093ff53c45 100644 --- a/platform-bible-react/types/TableColumn.html +++ b/platform-bible-react/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

        -

        • Settings

        Member Visibility

        Theme

        \ No newline at end of file +

        Settings

        Member Visibility

        Theme

        \ No newline at end of file diff --git a/platform-bible-react/types/TableCopyEvent.html b/platform-bible-react/types/TableCopyEvent.html index 8ee56a11e2..e4c56692ba 100644 --- a/platform-bible-react/types/TableCopyEvent.html +++ b/platform-bible-react/types/TableCopyEvent.html @@ -1 +1 @@ -TableCopyEvent | platform-bible-react

        Type alias TableCopyEvent<R>

        TableCopyEvent<R>: CopyEvent<R>

        Type Parameters

        • R

        Settings

        Member Visibility

        Theme

        \ No newline at end of file +TableCopyEvent | platform-bible-react

        Type alias TableCopyEvent<R>

        TableCopyEvent<R>: CopyEvent<R>

        Type Parameters

        • R

        Settings

        Member Visibility

        Theme

        \ No newline at end of file diff --git a/platform-bible-react/types/TableEditorProps.html b/platform-bible-react/types/TableEditorProps.html index cdf745789e..97339ba284 100644 --- a/platform-bible-react/types/TableEditorProps.html +++ b/platform-bible-react/types/TableEditorProps.html @@ -1 +1 @@ -TableEditorProps | platform-bible-react

        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

        Settings

        Member Visibility

        Theme

        \ No newline at end of file +TableEditorProps | platform-bible-react

        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

        Settings

        Member Visibility

        Theme

        \ No newline at end of file diff --git a/platform-bible-react/types/TablePasteEvent.html b/platform-bible-react/types/TablePasteEvent.html index 6399e1aabd..9a56a0c5f1 100644 --- a/platform-bible-react/types/TablePasteEvent.html +++ b/platform-bible-react/types/TablePasteEvent.html @@ -1 +1 @@ -TablePasteEvent | platform-bible-react

        Type alias TablePasteEvent<R>

        TablePasteEvent<R>: PasteEvent<R>

        Type Parameters

        • R

        Settings

        Member Visibility

        Theme

        \ No newline at end of file +TablePasteEvent | platform-bible-react

        Type alias TablePasteEvent<R>

        TablePasteEvent<R>: PasteEvent<R>

        Type Parameters

        • R

        Settings

        Member Visibility

        Theme

        \ No newline at end of file diff --git a/platform-bible-react/types/TableProps.html b/platform-bible-react/types/TableProps.html index c33c3e606f..7306b3affd 100644 --- a/platform-bible-react/types/TableProps.html +++ b/platform-bible-react/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

        -

        • Settings

        Member Visibility

        Theme

        \ No newline at end of file +

        Settings

        Member Visibility

        Theme

        \ No newline at end of file diff --git a/platform-bible-react/types/TableRowsChangeData.html b/platform-bible-react/types/TableRowsChangeData.html index aa5b0220b8..08f1c468af 100644 --- a/platform-bible-react/types/TableRowsChangeData.html +++ b/platform-bible-react/types/TableRowsChangeData.html @@ -1 +1 @@ -TableRowsChangeData | platform-bible-react

        Type alias TableRowsChangeData<R>

        TableRowsChangeData<R>: RowsChangeData<R>

        Type Parameters

        • R

        Settings

        Member Visibility

        Theme

        \ No newline at end of file +TableRowsChangeData | platform-bible-react

        Type alias TableRowsChangeData<R>

        TableRowsChangeData<R>: RowsChangeData<R>

        Type Parameters

        • R

        Settings

        Member Visibility

        Theme

        \ No newline at end of file diff --git a/platform-bible-react/types/TableSortColumn.html b/platform-bible-react/types/TableSortColumn.html index 98b4be5131..c503783498 100644 --- a/platform-bible-react/types/TableSortColumn.html +++ b/platform-bible-react/types/TableSortColumn.html @@ -1 +1 @@ -TableSortColumn | platform-bible-react

        Type alias TableSortColumn

        TableSortColumn: SortColumn

        Settings

        Member Visibility

        Theme

        \ No newline at end of file +TableSortColumn | platform-bible-react

        Type alias TableSortColumn

        TableSortColumn: SortColumn

        Settings

        Member Visibility

        Theme

        \ No newline at end of file diff --git a/platform-bible-react/types/TextFieldProps.html b/platform-bible-react/types/TextFieldProps.html index 7a236f48c3..0033c6dabb 100644 --- a/platform-bible-react/types/TextFieldProps.html +++ b/platform-bible-react/types/TextFieldProps.html @@ -23,4 +23,4 @@
      • Optional variant?: "outlined" | "filled"

        The variant to use.

        Default

        'outlined'
        -

        • Settings

        Member Visibility

        Theme

        \ No newline at end of file +

        Settings

        Member Visibility

        Theme

        \ No newline at end of file diff --git a/platform-bible-react/types/ToolbarProps.html b/platform-bible-react/types/ToolbarProps.html index 2410b0360f..f38e79b05a 100644 --- a/platform-bible-react/types/ToolbarProps.html +++ b/platform-bible-react/types/ToolbarProps.html @@ -3,4 +3,4 @@
      • Optional id?: string

        Optional unique identifier

      • Optional menuProvider?: MultiColumnMenuProvider

        The optional delegate to use to get the menu data. If not specified, the "hamburger" menu will not display.

        -

        • Settings

        Member Visibility

        Theme

        \ No newline at end of file +

        Settings

        Member Visibility

        Theme

        \ No newline at end of file diff --git a/platform-bible-react/types/UsePromiseOptions.html b/platform-bible-react/types/UsePromiseOptions.html index c47f26f056..599cf01d8d 100644 --- a/platform-bible-react/types/UsePromiseOptions.html +++ b/platform-bible-react/types/UsePromiseOptions.html @@ -1,3 +1,3 @@ UsePromiseOptions | platform-bible-react

        Type alias UsePromiseOptions

        UsePromiseOptions: {
            preserveValue?: boolean;
        }

        Type declaration

        • Optional preserveValue?: boolean

          Whether to leave the value as the most recent resolved promise value or set it back to defaultValue while running the promise again. Defaults to true

          -

        Settings

        Member Visibility

        Theme

        \ No newline at end of file +

        Settings

        Member Visibility

        Theme

        \ No newline at end of file diff --git a/platform-bible-utils/classes/AsyncVariable.html b/platform-bible-utils/classes/AsyncVariable.html index 6aef232dd2..b371d84cc5 100644 --- a/platform-bible-utils/classes/AsyncVariable.html +++ b/platform-bible-utils/classes/AsyncVariable.html @@ -1,5 +1,5 @@ AsyncVariable | platform-bible-utils

        Class AsyncVariable<T>

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

        -

        Type Parameters

        • T

        Constructors

        constructor +

        Type Parameters

        • T

        Constructors

        constructor

        Properties

        promiseToValue rejecter resolver @@ -14,18 +14,18 @@
      • rejectIfNotSettledWithinMS: number = 10000

        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 AsyncVariable<T>

        Properties

        Private Readonly promiseToValue

        promiseToValue: Promise<T>

        Private rejecter

        rejecter: undefined | ((reason) => void)

        Type declaration

          • (reason): void

          • Parameters

            • reason: undefined | string

            Returns void

        Private resolver

        resolver: undefined | ((value) => void)

        Type declaration

          • (value): void

          • Parameters

            • value: T

            Returns void

        Private Readonly variableName

        variableName: string

        Accessors

        hasSettled

        • get hasSettled(): boolean

        • A simple way to see if this variable's promise was resolved or rejected already

          +

        Returns AsyncVariable<T>

        Properties

        Private Readonly promiseToValue

        promiseToValue: Promise<T>

        Private rejecter

        rejecter: undefined | ((reason) => void)

        Type declaration

          • (reason): void

          • Parameters

            • reason: undefined | string

            Returns void

        Private resolver

        resolver: undefined | ((value) => void)

        Type declaration

          • (value): void

          • Parameters

            • value: T

            Returns void

        Private Readonly variableName

        variableName: string

        Accessors

        hasSettled

        promise

        promise

        • 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

        Private complete

        rejectWithReason

        Methods

        Private complete

        rejectWithReason

        • rejectWithReason(reason, throwIfAlreadySettled?): void

        • 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

          • throwIfAlreadySettled: boolean = false

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

            -

          Returns void

        resolveToValue

        • resolveToValue(value, throwIfAlreadySettled?): void

        • Resolve this variable's promise to the given value

          +

        Returns void

        resolveToValue

        • resolveToValue(value, throwIfAlreadySettled?): void

        • Resolve this variable's promise to the given value

          Parameters

          • value: T

            This variable's promise will resolve to this value

          • throwIfAlreadySettled: boolean = false

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

            -

          Returns void

        Settings

        Member Visibility

        Theme

        On This Page

        constructorpromiseToValuerejecterresolvervariableNamehasSettledpromisecompleterejectWithReasonresolveToValue
        \ No newline at end of file +

        Returns void

        Settings

        Member Visibility

        Theme

        On This Page

        constructorpromiseToValuerejecterresolvervariableNamehasSettledpromisecompleterejectWithReasonresolveToValue
        \ No newline at end of file diff --git a/platform-bible-utils/classes/DocumentCombiner.html b/platform-bible-utils/classes/DocumentCombiner.html index 8b3e2ce58c..eb19734f04 100644 --- a/platform-bible-utils/classes/DocumentCombiner.html +++ b/platform-bible-utils/classes/DocumentCombiner.html @@ -1,6 +1,6 @@ DocumentCombiner | platform-bible-utils

        Class DocumentCombiner

        Base class for any code that wants to compose JSON documents (primarily in the form of JS objects or arrays) together into a single output document.

        -

        Hierarchy (view full)

        Constructors

        constructor +

        Hierarchy (view full)

        Constructors

        constructor

        Properties

        baseDocument contributions latestOutput @@ -21,8 +21,8 @@

        Constructors

        Protected constructor

        Properties

        Protected baseDocument

        baseDocument: JsonDocumentLike

        Protected Readonly contributions

        contributions: Map<string, JsonDocumentLike> = ...

        Protected latestOutput

        latestOutput: undefined | JsonDocumentLike

        Readonly onDidRebuild

        onDidRebuild: PlatformEvent<undefined> = ...

        Event that emits to announce that the document has been rebuilt and the output has been updated

        -

        Private Readonly onDidRebuildEmitter

        onDidRebuildEmitter: PlatformEventEmitter<undefined> = ...

        Protected Readonly options

        options: DocumentCombinerOptions

        Methods

        addOrUpdateContribution

        • addOrUpdateContribution(documentName, document): undefined | JsonDocumentLike

        • Add or update one of the contribution documents for the composition process

          +

        Returns DocumentCombiner

        Properties

        Protected baseDocument

        baseDocument: JsonDocumentLike

        Protected Readonly contributions

        contributions: Map<string, JsonDocumentLike> = ...

        Protected latestOutput

        latestOutput: undefined | JsonDocumentLike

        Readonly onDidRebuild

        onDidRebuild: PlatformEvent<undefined> = ...

        Event that emits to announce that the document has been rebuilt and the output has been updated

        +

        Private Readonly onDidRebuildEmitter

        onDidRebuildEmitter: PlatformEventEmitter<undefined> = ...

        Protected Readonly options

        options: DocumentCombinerOptions

        Methods

        addOrUpdateContribution

        • addOrUpdateContribution(documentName, document): undefined | JsonDocumentLike

        • Add or update one of the contribution documents for the composition process

          Note: the order in which contribution documents are added can be considered to be indeterminate as it is currently ordered by however Map.forEach provides the contributions. The order matters when merging two arrays into one. Also, when options.ignoreDuplicateProperties is @@ -33,22 +33,22 @@

        • document: JsonDocumentLike

          Content of the contributed document to combine

        Returns undefined | JsonDocumentLike

        Recalculated output document given the new or updated contribution and existing other documents

        -

        deleteAllContributions

        deleteAllContributions

        deleteContribution

        deleteContribution

        rebuild

        rebuild

        Protected transformBaseDocumentAfterValidation

        Protected transformBaseDocumentAfterValidation

        • transformBaseDocumentAfterValidation(baseDocument): JsonDocumentLike

        • Transform the starting document that is given to the combiner. This transformation occurs after validating the base document and before combining any contributions.

          WARNING: If you do not create the combiner with option copyDocuments: true or clone inside this method, this method will directly modify the baseDocument passed in.

          Parameters

          • baseDocument: JsonDocumentLike

            Initial input document. Already validated via validateBaseDocument

          Returns JsonDocumentLike

          Transformed base document

          -

        Protected transformContributionAfterValidation

        Protected transformContributionAfterValidation

        • transformContributionAfterValidation(documentName, document): JsonDocumentLike

        • Transform the contributed document associated with documentName. This transformation occurs after validating the contributed document and before combining with other documents.

          WARNING: If you do not create the combiner with option copyDocuments: true or clone inside this method, this method will directly modify the contributed document passed in.

          @@ -56,19 +56,19 @@
        • document: JsonDocumentLike

          Content of the contributed document to combine. Already validated via validateContribution

        Returns JsonDocumentLike

        Transformed contributed document

        -

        Protected transformFinalOutputBeforeValidation

        Protected transformFinalOutputBeforeValidation

        updateBaseDocument

        Returns JsonDocumentLike

        updateBaseDocument

        Protected validateBaseDocument

        Protected validateBaseDocument

        Protected validateContribution

        Returns void

        Protected validateContribution

        Protected validateOutput

        Returns void

        Protected validateOutput

        Settings

        Member Visibility

        Theme

        On This Page

        constructorbaseDocumentcontributionslatestOutputonDidRebuildonDidRebuildEmitteroptionsaddOrUpdateContributiondeleteAllContributionsdeleteContributionrebuildtransformBaseDocumentAfterValidationtransformContributionAfterValidationtransformFinalOutputBeforeValidationupdateBaseDocumentvalidateBaseDocumentvalidateContributionvalidateOutput
        \ No newline at end of file +

        Returns void

        Settings

        Member Visibility

        Theme

        On This Page

        constructorbaseDocumentcontributionslatestOutputonDidRebuildonDidRebuildEmitteroptionsaddOrUpdateContributiondeleteAllContributionsdeleteContributionrebuildtransformBaseDocumentAfterValidationtransformContributionAfterValidationtransformFinalOutputBeforeValidationupdateBaseDocumentvalidateBaseDocumentvalidateContributionvalidateOutput
        \ No newline at end of file diff --git a/platform-bible-utils/classes/Mutex.html b/platform-bible-utils/classes/Mutex.html index d4356feb16..1ec41f4894 100644 --- a/platform-bible-utils/classes/Mutex.html +++ b/platform-bible-utils/classes/Mutex.html @@ -3,7 +3,7 @@

        Example

        const mutex = new Mutex();

        mutex.runExclusive(async () => {
          // Do some asynchronous stuff
          console.log('These run one-at-a-time');
        });

        mutex.runExclusive(async () => {
          // Do some asynchronous stuff
          console.log('These run one-at-a-time');
        });

        See async-mutex for more information.

        -

        Hierarchy

        Constructors

        constructor +

        Hierarchy

        • Mutex
          • Mutex

        Constructors

        constructor

        Methods

        acquire cancel isLocked diff --git a/platform-bible-utils/classes/MutexMap.html b/platform-bible-utils/classes/MutexMap.html index c45e2c3b1c..e3e21d16cd 100644 --- a/platform-bible-utils/classes/MutexMap.html +++ b/platform-bible-utils/classes/MutexMap.html @@ -1,5 +1,5 @@ MutexMap | platform-bible-utils

        Class MutexMap

        Map of Mutexes that automatically (lazily) generates a new Mutex for any new key

        -

        Constructors

        constructor +

        Constructors

        constructor

        Properties

        mutexesByID

        Methods

        get -

        Constructors

        constructor

        Properties

        Private mutexesByID

        mutexesByID: Map<string, Mutex> = ...

        Methods

        get

        Settings

        Member Visibility

        Theme

        On This Page

        constructormutexesByIDget
        \ No newline at end of file +

        Constructors

        constructor

        Properties

        Private mutexesByID

        mutexesByID: Map<string, Mutex> = ...

        Methods

        get

        Settings

        Member Visibility

        Theme

        On This Page

        constructormutexesByIDget
        \ No newline at end of file diff --git a/platform-bible-utils/classes/NonValidatingDocumentCombiner.html b/platform-bible-utils/classes/NonValidatingDocumentCombiner.html index 9ffa6c884c..f1b7f70ab1 100644 --- a/platform-bible-utils/classes/NonValidatingDocumentCombiner.html +++ b/platform-bible-utils/classes/NonValidatingDocumentCombiner.html @@ -1,6 +1,6 @@ NonValidatingDocumentCombiner | platform-bible-utils

        Class NonValidatingDocumentCombiner

        Base class for any code that wants to compose JSON documents (primarily in the form of JS objects or arrays) together into a single output document.

        -

        Hierarchy (view full)

        Constructors

        constructor +

        Hierarchy (view full)

        Constructors

        constructor

        Properties

        baseDocument contributions latestOutput @@ -18,8 +18,8 @@ validateBaseDocument validateContribution validateOutput -

        Constructors

        constructor

        Properties

        Protected baseDocument

        baseDocument: JsonDocumentLike

        Protected Readonly contributions

        contributions: Map<string, JsonDocumentLike> = ...

        Protected latestOutput

        latestOutput: undefined | JsonDocumentLike

        Readonly onDidRebuild

        onDidRebuild: PlatformEvent<undefined> = ...

        Event that emits to announce that the document has been rebuilt and the output has been updated

        -

        Protected Readonly options

        options: DocumentCombinerOptions

        Accessors

        output

        Methods

        addOrUpdateContribution

        • addOrUpdateContribution(documentName, document): undefined | JsonDocumentLike

        • Add or update one of the contribution documents for the composition process

          +

        Constructors

        constructor

        Properties

        Protected baseDocument

        baseDocument: JsonDocumentLike

        Protected Readonly contributions

        contributions: Map<string, JsonDocumentLike> = ...

        Protected latestOutput

        latestOutput: undefined | JsonDocumentLike

        Readonly onDidRebuild

        onDidRebuild: PlatformEvent<undefined> = ...

        Event that emits to announce that the document has been rebuilt and the output has been updated

        +

        Protected Readonly options

        options: DocumentCombinerOptions

        Accessors

        output

        Methods

        addOrUpdateContribution

        • addOrUpdateContribution(documentName, document): undefined | JsonDocumentLike

        • Add or update one of the contribution documents for the composition process

          Note: the order in which contribution documents are added can be considered to be indeterminate as it is currently ordered by however Map.forEach provides the contributions. The order matters when merging two arrays into one. Also, when options.ignoreDuplicateProperties is @@ -30,22 +30,22 @@

        • document: JsonDocumentLike

          Content of the contributed document to combine

        Returns undefined | JsonDocumentLike

        Recalculated output document given the new or updated contribution and existing other documents

        -

        deleteAllContributions

        deleteAllContributions

        deleteContribution

        deleteContribution

        rebuild

        rebuild

        Protected transformBaseDocumentAfterValidation

        Protected transformBaseDocumentAfterValidation

        Protected transformContributionAfterValidation

        Protected transformContributionAfterValidation

        • transformContributionAfterValidation(documentName, document): JsonDocumentLike

        • Transform the contributed document associated with documentName. This transformation occurs after validating the contributed document and before combining with other documents.

          WARNING: If you do not create the combiner with option copyDocuments: true or clone inside this method, this method will directly modify the contributed document passed in.

          @@ -53,19 +53,19 @@
        • document: JsonDocumentLike

          Content of the contributed document to combine. Already validated via validateContribution

        Returns JsonDocumentLike

        Transformed contributed document

        -

        Protected transformFinalOutputBeforeValidation

        Protected transformFinalOutputBeforeValidation

        updateBaseDocument

        • updateBaseDocument(baseDocument): undefined | JsonDocumentLike

        • Update the starting document for composition process

          +

        Returns JsonDocumentLike

        updateBaseDocument

        Protected validateBaseDocument

        Protected validateBaseDocument

        Protected validateContribution

        • validateContribution(documentName, document): void

        • Throw an error if the provided document is not a valid contribution document.

          +

        Returns void

        Protected validateContribution

        Protected validateOutput

        • validateOutput(output): void

        • Throw an error if the provided output is not valid.

          +

        Returns void

        Protected validateOutput

        Settings

        Member Visibility

        Theme

        On This Page

        constructorbaseDocumentcontributionslatestOutputonDidRebuildoptionsoutputaddOrUpdateContributiondeleteAllContributionsdeleteContributionrebuildtransformBaseDocumentAfterValidationtransformContributionAfterValidationtransformFinalOutputBeforeValidationupdateBaseDocumentvalidateBaseDocumentvalidateContributionvalidateOutput
        \ No newline at end of file +

        Returns void

        Settings

        Member Visibility

        Theme

        On This Page

        constructorbaseDocumentcontributionslatestOutputonDidRebuildoptionsoutputaddOrUpdateContributiondeleteAllContributionsdeleteContributionrebuildtransformBaseDocumentAfterValidationtransformContributionAfterValidationtransformFinalOutputBeforeValidationupdateBaseDocumentvalidateBaseDocumentvalidateContributionvalidateOutput
        \ No newline at end of file diff --git a/platform-bible-utils/classes/PlatformEventEmitter.html b/platform-bible-utils/classes/PlatformEventEmitter.html index d3ccb9511a..8563ee7e71 100644 --- a/platform-bible-utils/classes/PlatformEventEmitter.html +++ b/platform-bible-utils/classes/PlatformEventEmitter.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

        Implements

        Constructors

        constructor +

        Type Parameters

        • T

        Implements

        Constructors

        constructor

        Properties

        isDisposed lazyEvent? subscribe @@ -15,23 +15,23 @@ emit emitFn

        Constructors

        constructor

        Properties

        Private isDisposed

        isDisposed: boolean = false

        Whether this emitter has been disposed

        -

        Private Optional lazyEvent

        lazyEvent?: PlatformEvent<T>

        Event for listeners to subscribe to. Lazy loaded

        -

        subscribe

        subscribe: PlatformEvent<T> = ...

        Subscribes a function to run when this event is emitted.

        +

        Private Optional lazyEvent

        lazyEvent?: PlatformEvent<T>

        Event for listeners to subscribe to. Lazy loaded

        +

        subscribe

        subscribe: PlatformEvent<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

        -

        Private Optional subscriptions

        subscriptions?: PlatformEventHandler<T>[]

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

        -

        Accessors

        event

        Private Optional subscriptions

        subscriptions?: PlatformEventHandler<T>[]

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

        +

        Accessors

        event

        Methods

        Protected assertNotDisposed

        dispose

        Protected disposeFn

        Methods

        Protected assertNotDisposed

        dispose

        Protected disposeFn

        emit

        emit

        Protected emitFn

        • emitFn(event): void

        • Function that runs the subscriptions for the event. Added here so children can override emit +

        Returns void

        Protected emitFn

        Settings

        Member Visibility

        Theme

        On This Page

        constructorisDisposedlazyEventsubscribesubscriptionseventassertNotDisposeddisposedisposeFnemitemitFn
        \ No newline at end of file +

        Parameters

        Returns void

        Settings

        Member Visibility

        Theme

        On This Page

        constructorisDisposedlazyEventsubscribesubscriptionseventassertNotDisposeddisposedisposeFnemitemitFn
        \ No newline at end of file diff --git a/platform-bible-utils/classes/UnsubscriberAsyncList.html b/platform-bible-utils/classes/UnsubscriberAsyncList.html index 8525ad9983..a2e12d4d12 100644 --- a/platform-bible-utils/classes/UnsubscriberAsyncList.html +++ b/platform-bible-utils/classes/UnsubscriberAsyncList.html @@ -1,11 +1,11 @@ UnsubscriberAsyncList | platform-bible-utils

        Class UnsubscriberAsyncList

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

        -

        Constructors

        constructor +

        Constructors

        constructor

        Properties

        name unsubscribers

        Methods

        add runAllUnsubscribers -

        Constructors

        constructor

        Properties

        Private name

        name: string = 'Anonymous'

        Readonly unsubscribers

        unsubscribers: Set<Unsubscriber | UnsubscriberAsync> = ...

        Methods

        add

        • add(...unsubscribers): void

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

          +

        Constructors

        constructor

        Properties

        Private name

        name: string = 'Anonymous'

        Readonly unsubscribers

        unsubscribers: Set<Unsubscriber | UnsubscriberAsync> = ...

        Methods

        add

        runAllUnsubscribers

        • runAllUnsubscribers(): Promise<boolean>

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

          +

        Returns void

        runAllUnsubscribers

        Settings

        Member Visibility

        Theme

        On This Page

        constructornameunsubscribersaddrunAllUnsubscribers
        \ No newline at end of file +

        Settings

        Member Visibility

        Theme

        On This Page

        constructornameunsubscribersaddrunAllUnsubscribers
        \ No newline at end of file diff --git a/platform-bible-utils/functions/aggregateUnsubscriberAsyncs.html b/platform-bible-utils/functions/aggregateUnsubscriberAsyncs.html index ba75bec49e..47a4ab451f 100644 --- a/platform-bible-utils/functions/aggregateUnsubscriberAsyncs.html +++ b/platform-bible-utils/functions/aggregateUnsubscriberAsyncs.html @@ -1,4 +1,4 @@ aggregateUnsubscriberAsyncs | platform-bible-utils

        Function aggregateUnsubscriberAsyncs

        Settings

        Member Visibility

        Theme

        \ No newline at end of file +

        Settings

        Member Visibility

        Theme

        \ No newline at end of file diff --git a/platform-bible-utils/functions/aggregateUnsubscribers.html b/platform-bible-utils/functions/aggregateUnsubscribers.html index c28670b2df..15905625eb 100644 --- a/platform-bible-utils/functions/aggregateUnsubscribers.html +++ b/platform-bible-utils/functions/aggregateUnsubscribers.html @@ -1,4 +1,4 @@ aggregateUnsubscribers | platform-bible-utils

        Function aggregateUnsubscribers

        Settings

        Member Visibility

        Theme

        \ No newline at end of file +

        Settings

        Member Visibility

        Theme

        \ No newline at end of file diff --git a/platform-bible-utils/functions/at.html b/platform-bible-utils/functions/at.html index 423c0ef332..f2f41338b0 100644 --- a/platform-bible-utils/functions/at.html +++ b/platform-bible-utils/functions/at.html @@ -6,4 +6,4 @@ length(string)

        Returns string | undefined

        New string consisting of the Unicode code point located at the specified offset, undefined if index is out of bounds

        -

        Settings

        Member Visibility

        Theme

        \ No newline at end of file +

        Settings

        Member Visibility

        Theme

        \ No newline at end of file diff --git a/platform-bible-utils/functions/charAt.html b/platform-bible-utils/functions/charAt.html index 30bf56a20b..d750ef0141 100644 --- a/platform-bible-utils/functions/charAt.html +++ b/platform-bible-utils/functions/charAt.html @@ -6,4 +6,4 @@ length(string)-1

        Returns string

        New string consisting of the Unicode code point located at the specified offset, empty string if index is out of bounds

        -

        Settings

        Member Visibility

        Theme

        \ No newline at end of file +

        Settings

        Member Visibility

        Theme

        \ No newline at end of file diff --git a/platform-bible-utils/functions/codePointAt.html b/platform-bible-utils/functions/codePointAt.html index e2f9017aa2..7102be0c6d 100644 --- a/platform-bible-utils/functions/codePointAt.html +++ b/platform-bible-utils/functions/codePointAt.html @@ -7,4 +7,4 @@ length(string)-1

        Returns number | undefined

        Non-negative integer representing the code point value of the character at the given index, or undefined if there is no element at that position

        -

        Settings

        Member Visibility

        Theme

        \ No newline at end of file +

        Settings

        Member Visibility

        Theme

        \ No newline at end of file diff --git a/platform-bible-utils/functions/createSyncProxyForAsyncObject.html b/platform-bible-utils/functions/createSyncProxyForAsyncObject.html index 008a7a67dd..71927b7161 100644 --- a/platform-bible-utils/functions/createSyncProxyForAsyncObject.html +++ b/platform-bible-utils/functions/createSyncProxyForAsyncObject.html @@ -7,4 +7,4 @@ does not exist on this object, it will be considered to be an asynchronous method called on the object returned from getObject.

        Returns T

        A synchronous proxy for the asynchronous object.

        -

        Settings

        Member Visibility

        Theme

        \ No newline at end of file +

        Settings

        Member Visibility

        Theme

        \ No newline at end of file diff --git a/platform-bible-utils/functions/debounce.html b/platform-bible-utils/functions/debounce.html index ab547b6eb0..5f52e2015f 100644 --- a/platform-bible-utils/functions/debounce.html +++ b/platform-bible-utils/functions/debounce.html @@ -3,4 +3,4 @@
      • delay: number = 300

        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

        -

        Settings

        Member Visibility

        Theme

        \ No newline at end of file +

        Settings

        Member Visibility

        Theme

        \ No newline at end of file diff --git a/platform-bible-utils/functions/deepClone.html b/platform-bible-utils/functions/deepClone.html index acf3f66b66..a49dd53294 100644 --- a/platform-bible-utils/functions/deepClone.html +++ b/platform-bible-utils/functions/deepClone.html @@ -2,4 +2,4 @@ references between the source and target of property copying operations.

        Type Parameters

        Parameters

        Returns T

        Duplicate copy of obj without any references back to the original one

        -

        Settings

        Member Visibility

        Theme

        \ No newline at end of file +

        Settings

        Member Visibility

        Theme

        \ No newline at end of file diff --git a/platform-bible-utils/functions/deepEqual.html b/platform-bible-utils/functions/deepEqual.html index a4f485282e..c768fc12e5 100644 --- a/platform-bible-utils/functions/deepEqual.html +++ b/platform-bible-utils/functions/deepEqual.html @@ -15,4 +15,4 @@ CodeSandbox.

        Returns boolean

        True if a and b are deeply equal; false otherwise

        -

        Settings

        Member Visibility

        Theme

        \ No newline at end of file +

        Settings

        Member Visibility

        Theme

        \ No newline at end of file diff --git a/platform-bible-utils/functions/deserialize.html b/platform-bible-utils/functions/deserialize.html index c08bf7efee..d41435509d 100644 --- a/platform-bible-utils/functions/deserialize.html +++ b/platform-bible-utils/functions/deserialize.html @@ -9,4 +9,4 @@ the object. If a member contains nested objects, the nested objects are transformed before the parent object is. Note that null values are converted into undefined values after the reviver has run.

        -

        Returns any

        Settings

        Member Visibility

        Theme

        \ No newline at end of file +

        Returns any

        Settings

        Member Visibility

        Theme

        \ No newline at end of file diff --git a/platform-bible-utils/functions/endsWith.html b/platform-bible-utils/functions/endsWith.html index 2943dfca3f..1dd9508827 100644 --- a/platform-bible-utils/functions/endsWith.html +++ b/platform-bible-utils/functions/endsWith.html @@ -6,4 +6,4 @@
      • endPosition: number = ...

        End position where searchString is expected to be found. Default is length(string)

        • Returns boolean

        True if it ends with searchString, false if it does not

        -

        Settings

        Member Visibility

        Theme

        \ No newline at end of file +

        Settings

        Member Visibility

        Theme

        \ No newline at end of file diff --git a/platform-bible-utils/functions/getAllObjectFunctionNames.html b/platform-bible-utils/functions/getAllObjectFunctionNames.html index 41b06ef85e..deb7bb4a84 100644 --- a/platform-bible-utils/functions/getAllObjectFunctionNames.html +++ b/platform-bible-utils/functions/getAllObjectFunctionNames.html @@ -5,4 +5,4 @@

        Parameters

        Returns Set<string>

        Array of all function names on an object

        -

        Settings

        Member Visibility

        Theme

        \ No newline at end of file +

        Settings

        Member Visibility

        Theme

        \ No newline at end of file diff --git a/platform-bible-utils/functions/getChaptersForBook.html b/platform-bible-utils/functions/getChaptersForBook.html index 34a0fd8333..8c7c0f291c 100644 --- a/platform-bible-utils/functions/getChaptersForBook.html +++ b/platform-bible-utils/functions/getChaptersForBook.html @@ -1 +1 @@ -getChaptersForBook | platform-bible-utils

        Function getChaptersForBook

        Settings

        Member Visibility

        Theme

        \ No newline at end of file +getChaptersForBook | platform-bible-utils

        Function getChaptersForBook

        Settings

        Member Visibility

        Theme

        \ No newline at end of file diff --git a/platform-bible-utils/functions/getErrorMessage.html b/platform-bible-utils/functions/getErrorMessage.html index ba6feeb320..baf69cf693 100644 --- a/platform-bible-utils/functions/getErrorMessage.html +++ b/platform-bible-utils/functions/getErrorMessage.html @@ -5,4 +5,4 @@ stringify

        Example

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

        Settings

        Member Visibility

        Theme

        \ No newline at end of file +

        Settings

        Member Visibility

        Theme

        \ No newline at end of file diff --git a/platform-bible-utils/functions/getLocalizedIdFromBookNumber.html b/platform-bible-utils/functions/getLocalizedIdFromBookNumber.html index b9853c225f..c8395a8053 100644 --- a/platform-bible-utils/functions/getLocalizedIdFromBookNumber.html +++ b/platform-bible-utils/functions/getLocalizedIdFromBookNumber.html @@ -6,4 +6,4 @@

        Parameters

        Returns Promise<string>

        Settings

        Member Visibility

        Theme

        \ No newline at end of file +

        Returns Promise<string>

        Settings

        Member Visibility

        Theme

        \ No newline at end of file diff --git a/platform-bible-utils/functions/groupBy.html b/platform-bible-utils/functions/groupBy.html index a3a3657653..74aa9c6571 100644 --- a/platform-bible-utils/functions/groupBy.html +++ b/platform-bible-utils/functions/groupBy.html @@ -2,4 +2,4 @@

        Type Parameters

        Parameters

        Returns Map<K, T[]>

        Map of keys to groups of values corresponding to each item

        -
      • groupBy<T, K, V>(items, keySelector, valueSelector): Map<K, V[]>

      • Type Parameters

        • T
        • K
        • V

        Parameters

        • items: T[]
        • keySelector: ((item) => K)
            • (item): K

            • Parameters

              • item: T

              Returns K

        • valueSelector: ((item, key) => V)
            • (item, key): V

            • Parameters

              • item: T
              • key: K

              Returns V

        Returns Map<K, V[]>

        • Settings

        Member Visibility

        Theme

        \ No newline at end of file +
      • groupBy<T, K, V>(items, keySelector, valueSelector): Map<K, V[]>

      • Type Parameters

        • T
        • K
        • V

        Parameters

        • items: T[]
        • keySelector: ((item) => K)
            • (item): K

            • Parameters

              • item: T

              Returns K

        • valueSelector: ((item, key) => V)
            • (item, key): V

            • Parameters

              • item: T
              • key: K

              Returns V

        Returns Map<K, V[]>

        • Settings

        Member Visibility

        Theme

        \ No newline at end of file diff --git a/platform-bible-utils/functions/htmlEncode.html b/platform-bible-utils/functions/htmlEncode.html index 36e3e7791b..80ff74cb87 100644 --- a/platform-bible-utils/functions/htmlEncode.html +++ b/platform-bible-utils/functions/htmlEncode.html @@ -1,4 +1,4 @@ htmlEncode | platform-bible-utils

        Function htmlEncode

        Settings

        Member Visibility

        Theme

        \ No newline at end of file +

        Settings

        Member Visibility

        Theme

        \ No newline at end of file diff --git a/platform-bible-utils/functions/includes.html b/platform-bible-utils/functions/includes.html index 51e6135cfa..f8367a73a0 100644 --- a/platform-bible-utils/functions/includes.html +++ b/platform-bible-utils/functions/includes.html @@ -5,4 +5,4 @@
      • searchString: string

        String to search for

      • position: number = 0

        Position within the string to start searching for searchString. Default is 0

        • Returns boolean

        True if search string is found, false if it is not

        -

        Settings

        Member Visibility

        Theme

        \ No newline at end of file +

        Settings

        Member Visibility

        Theme

        \ No newline at end of file diff --git a/platform-bible-utils/functions/indexOf.html b/platform-bible-utils/functions/indexOf.html index 905ae59bfb..c53df79145 100644 --- a/platform-bible-utils/functions/indexOf.html +++ b/platform-bible-utils/functions/indexOf.html @@ -5,4 +5,4 @@
      • searchString: string

        The string to search for

      • position: undefined | number = 0

        Start of searching. Default is 0

        • Returns number

        Index of the first occurrence of a given string

        -

        Settings

        Member Visibility

        Theme

        \ No newline at end of file +

        Settings

        Member Visibility

        Theme

        \ No newline at end of file diff --git a/platform-bible-utils/functions/isSerializable.html b/platform-bible-utils/functions/isSerializable.html index 6fc4f99fee..fc03135edc 100644 --- a/platform-bible-utils/functions/isSerializable.html +++ b/platform-bible-utils/functions/isSerializable.html @@ -13,4 +13,4 @@

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

        -

        Settings

        Member Visibility

        Theme

        \ No newline at end of file +

        Settings

        Member Visibility

        Theme

        \ No newline at end of file diff --git a/platform-bible-utils/functions/isString.html b/platform-bible-utils/functions/isString.html index e2d75865f6..6e2df2c178 100644 --- a/platform-bible-utils/functions/isString.html +++ b/platform-bible-utils/functions/isString.html @@ -1,4 +1,4 @@ isString | platform-bible-utils

        Function isString

        • isString(o): o is string

        • 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

          -

        Settings

        Member Visibility

        Theme

        \ No newline at end of file +

        Settings

        Member Visibility

        Theme

        \ No newline at end of file diff --git a/platform-bible-utils/functions/lastIndexOf.html b/platform-bible-utils/functions/lastIndexOf.html index 36426446aa..2d91540c29 100644 --- a/platform-bible-utils/functions/lastIndexOf.html +++ b/platform-bible-utils/functions/lastIndexOf.html @@ -6,4 +6,4 @@
      • Optional position: number

        The index at which to begin searching. If omitted, the search begins at the end of the string. Default is undefined

        • Returns number

        Index of the last occurrence of searchString found, or -1 if not found.

        -

        Settings

        Member Visibility

        Theme

        \ No newline at end of file +

        Settings

        Member Visibility

        Theme

        \ No newline at end of file diff --git a/platform-bible-utils/functions/newGuid.html b/platform-bible-utils/functions/newGuid.html index d5f1680752..99b24bdcff 100644 --- a/platform-bible-utils/functions/newGuid.html +++ b/platform-bible-utils/functions/newGuid.html @@ -1,2 +1,2 @@ newGuid | platform-bible-utils

        Function newGuid

        Settings

        Member Visibility

        Theme

        \ No newline at end of file +

        Returns string

        Settings

        Member Visibility

        Theme

        \ No newline at end of file diff --git a/platform-bible-utils/functions/normalize.html b/platform-bible-utils/functions/normalize.html index 983331061b..73551f8357 100644 --- a/platform-bible-utils/functions/normalize.html +++ b/platform-bible-utils/functions/normalize.html @@ -4,4 +4,4 @@

        Parameters

        Returns string

        A string containing the Unicode Normalization Form of the given string.

        -

        Settings

        Member Visibility

        Theme

        \ No newline at end of file +

        Settings

        Member Visibility

        Theme

        \ No newline at end of file diff --git a/platform-bible-utils/functions/offsetBook.html b/platform-bible-utils/functions/offsetBook.html index 9e293fa52b..718c9c5ea1 100644 --- a/platform-bible-utils/functions/offsetBook.html +++ b/platform-bible-utils/functions/offsetBook.html @@ -1 +1 @@ -offsetBook | platform-bible-utils

        Function offsetBook

        Settings

        Member Visibility

        Theme

        \ No newline at end of file +offsetBook | platform-bible-utils

        Function offsetBook

        Settings

        Member Visibility

        Theme

        \ No newline at end of file diff --git a/platform-bible-utils/functions/offsetChapter.html b/platform-bible-utils/functions/offsetChapter.html index cde676fdd0..669e50e660 100644 --- a/platform-bible-utils/functions/offsetChapter.html +++ b/platform-bible-utils/functions/offsetChapter.html @@ -1 +1 @@ -offsetChapter | platform-bible-utils

        Function offsetChapter

        Settings

        Member Visibility

        Theme

        \ No newline at end of file +offsetChapter | platform-bible-utils

        Function offsetChapter

        Settings

        Member Visibility

        Theme

        \ No newline at end of file diff --git a/platform-bible-utils/functions/offsetVerse.html b/platform-bible-utils/functions/offsetVerse.html index 38ea6427fd..0365f4d0e5 100644 --- a/platform-bible-utils/functions/offsetVerse.html +++ b/platform-bible-utils/functions/offsetVerse.html @@ -1 +1 @@ -offsetVerse | platform-bible-utils

        Function offsetVerse

        Settings

        Member Visibility

        Theme

        \ No newline at end of file +offsetVerse | platform-bible-utils

        Function offsetVerse

        Settings

        Member Visibility

        Theme

        \ No newline at end of file diff --git a/platform-bible-utils/functions/padEnd.html b/platform-bible-utils/functions/padEnd.html index 25b17f8ed8..0ec9ec79d8 100644 --- a/platform-bible-utils/functions/padEnd.html +++ b/platform-bible-utils/functions/padEnd.html @@ -8,4 +8,4 @@
      • padString: string = ' '

        The string to pad the current string with. If padString is too long to stay within targetLength, it will be truncated. Default is " "

        • Returns string

        String with appropriate padding at the end

        -

        Settings

        Member Visibility

        Theme

        \ No newline at end of file +

        Settings

        Member Visibility

        Theme

        \ No newline at end of file diff --git a/platform-bible-utils/functions/padStart.html b/platform-bible-utils/functions/padStart.html index be4f5da4fe..89f5545cb5 100644 --- a/platform-bible-utils/functions/padStart.html +++ b/platform-bible-utils/functions/padStart.html @@ -8,4 +8,4 @@
      • padString: string = ' '

        The string to pad the current string with. If padString is too long to stay within the targetLength, it will be truncated from the end. Default is " "

        • Returns string

        String with of specified targetLength with padString applied from the start

        -

        Settings

        Member Visibility

        Theme

        \ No newline at end of file +

        Settings

        Member Visibility

        Theme

        \ No newline at end of file diff --git a/platform-bible-utils/functions/serialize.html b/platform-bible-utils/functions/serialize.html index 5d9843831d..c5940b012c 100644 --- a/platform-bible-utils/functions/serialize.html +++ b/platform-bible-utils/functions/serialize.html @@ -10,4 +10,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

        Settings

        Member Visibility

        Theme

        \ No newline at end of file +

        Returns string

        Settings

        Member Visibility

        Theme

        \ No newline at end of file diff --git a/platform-bible-utils/functions/slice.html b/platform-bible-utils/functions/slice.html index f0d8a2847e..c4e78b6268 100644 --- a/platform-bible-utils/functions/slice.html +++ b/platform-bible-utils/functions/slice.html @@ -6,4 +6,4 @@
      • indexStart: number

        The index of the first character to include in the returned substring.

      • Optional indexEnd: number

        The index of the first character to exclude from the returned substring.

        • Returns string

        A new string containing the extracted section of the string.

        -

        Settings

        Member Visibility

        Theme

        \ No newline at end of file +

        Settings

        Member Visibility

        Theme

        \ No newline at end of file diff --git a/platform-bible-utils/functions/split.html b/platform-bible-utils/functions/split.html index 7b77eae3e8..2029778e62 100644 --- a/platform-bible-utils/functions/split.html +++ b/platform-bible-utils/functions/split.html @@ -9,4 +9,4 @@ in the array.

        Returns string[]

        An array of strings, split at each point where separator occurs in the starting string. Returns undefined if separator is not found in string.

        -

        Settings

        Member Visibility

        Theme

        \ No newline at end of file +

        Settings

        Member Visibility

        Theme

        \ No newline at end of file diff --git a/platform-bible-utils/functions/startsWith.html b/platform-bible-utils/functions/startsWith.html index d617280917..0efcca704d 100644 --- a/platform-bible-utils/functions/startsWith.html +++ b/platform-bible-utils/functions/startsWith.html @@ -8,4 +8,4 @@ searchString's first character). Default is 0

        Returns boolean

        True if the given characters are found at the beginning of the string, including when searchString is an empty string; otherwise, false.

        -

        Settings

        Member Visibility

        Theme

        \ No newline at end of file +

        Settings

        Member Visibility

        Theme

        \ No newline at end of file diff --git a/platform-bible-utils/functions/stringLength.html b/platform-bible-utils/functions/stringLength.html index 057faf45bc..fd0abf4d1c 100644 --- a/platform-bible-utils/functions/stringLength.html +++ b/platform-bible-utils/functions/stringLength.html @@ -4,4 +4,4 @@

        Returns the length of a string.

        Parameters

        Returns number

        Number that is length of the starting string

        -

        Settings

        Member Visibility

        Theme

        \ No newline at end of file +

        Settings

        Member Visibility

        Theme

        \ No newline at end of file diff --git a/platform-bible-utils/functions/substring.html b/platform-bible-utils/functions/substring.html index 8f7f625f20..a0e2248813 100644 --- a/platform-bible-utils/functions/substring.html +++ b/platform-bible-utils/functions/substring.html @@ -5,4 +5,4 @@
      • begin: number

        Start position

      • end: number = ...

        End position. Default is End of string

        • Returns string

        Substring from starting string

        -

        Settings

        Member Visibility

        Theme

        \ No newline at end of file +

        Settings

        Member Visibility

        Theme

        \ No newline at end of file diff --git a/platform-bible-utils/functions/toArray.html b/platform-bible-utils/functions/toArray.html index 590a08de92..75cf557890 100644 --- a/platform-bible-utils/functions/toArray.html +++ b/platform-bible-utils/functions/toArray.html @@ -3,4 +3,4 @@

        Converts a string to an array of string characters.

        Parameters

        Returns string[]

        An array of characters from the starting string

        -

        Settings

        Member Visibility

        Theme

        \ No newline at end of file +

        Settings

        Member Visibility

        Theme

        \ No newline at end of file diff --git a/platform-bible-utils/functions/wait.html b/platform-bible-utils/functions/wait.html index c2e818448c..d167116c92 100644 --- a/platform-bible-utils/functions/wait.html +++ b/platform-bible-utils/functions/wait.html @@ -1,2 +1,2 @@ wait | platform-bible-utils

        Function wait

        • wait(ms): Promise<void>

        • Asynchronously waits for the specified number of milliseconds. (wraps setTimeout in a promise)

          -

          Parameters

          • ms: number

          Returns Promise<void>

        Settings

        Member Visibility

        Theme

        \ No newline at end of file +

        Parameters

        Returns Promise<void>

        Settings

        Member Visibility

        Theme

        \ No newline at end of file diff --git a/platform-bible-utils/functions/waitForDuration.html b/platform-bible-utils/functions/waitForDuration.html index f7bd44a826..4e21fbf58e 100644 --- a/platform-bible-utils/functions/waitForDuration.html +++ b/platform-bible-utils/functions/waitForDuration.html @@ -3,4 +3,4 @@
      • maxWaitTimeInMS: number

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

        • Returns Promise<undefined | Awaited<TResult>>

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

        -

        Settings

        Member Visibility

        Theme

        \ No newline at end of file +

        Settings

        Member Visibility

        Theme

        \ No newline at end of file diff --git a/platform-bible-utils/interfaces/BookInfo.html b/platform-bible-utils/interfaces/BookInfo.html index 3085190e98..3cb4628f4b 100644 --- a/platform-bible-utils/interfaces/BookInfo.html +++ b/platform-bible-utils/interfaces/BookInfo.html @@ -1,4 +1,4 @@ -BookInfo | platform-bible-utils

        Interface BookInfo

        interface BookInfo {
            chapters: number;
            fullNames: string[];
            shortName: string;
        }

        Properties

        chapters +BookInfo | platform-bible-utils

        Interface BookInfo

        interface BookInfo {
            chapters: number;
            fullNames: string[];
            shortName: string;
        }

        Properties

        chapters fullNames shortName -

        Properties

        chapters

        chapters: number

        fullNames

        fullNames: string[]

        shortName

        shortName: string

        Settings

        Member Visibility

        Theme

        On This Page

        chaptersfullNamesshortName
        \ No newline at end of file +

        Properties

        chapters

        chapters: number

        fullNames

        fullNames: string[]

        shortName

        shortName: string

        Settings

        Member Visibility

        Theme

        On This Page

        chaptersfullNamesshortName
        \ No newline at end of file diff --git a/platform-bible-utils/interfaces/CannotHaveOnDidDispose.html b/platform-bible-utils/interfaces/CannotHaveOnDidDispose.html index e99bed56d6..97e02740f3 100644 --- a/platform-bible-utils/interfaces/CannotHaveOnDidDispose.html +++ b/platform-bible-utils/interfaces/CannotHaveOnDidDispose.html @@ -1,7 +1,7 @@ CannotHaveOnDidDispose | platform-bible-utils

        Interface CannotHaveOnDidDispose

        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

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

        Properties

        dispose? onDidDispose?

        Properties

        Optional dispose

        dispose?: UnsubscriberAsync

        Release resources and notify dependent services when tearing down an object

        -

        Optional onDidDispose

        onDidDispose?: undefined

        Event that emits when dispose is called on an object

        -

        Settings

        Member Visibility

        Theme

        On This Page

        disposeonDidDispose
        \ No newline at end of file +

        Optional onDidDispose

        onDidDispose?: undefined

        Event that emits when dispose is called on an object

        +

        Settings

        Member Visibility

        Theme

        On This Page

        disposeonDidDispose
        \ No newline at end of file diff --git a/platform-bible-utils/interfaces/Dispose.html b/platform-bible-utils/interfaces/Dispose.html index 6f0a379198..6f1bf9e010 100644 --- a/platform-bible-utils/interfaces/Dispose.html +++ b/platform-bible-utils/interfaces/Dispose.html @@ -1,4 +1,4 @@ Dispose | platform-bible-utils

        Interface Dispose

        Require a dispose function

        -
        interface Dispose {
            dispose: UnsubscriberAsync;
        }

        Implemented by

        Properties

        dispose +
        interface Dispose {
            dispose: UnsubscriberAsync;
        }

        Implemented by

        Properties

        dispose

        Properties

        dispose

        dispose: UnsubscriberAsync

        Release resources and notify dependent services when tearing down an object

        -

        Settings

        Member Visibility

        Theme

        On This Page

        dispose
        \ No newline at end of file +

        Settings

        Member Visibility

        Theme

        On This Page

        dispose
        \ No newline at end of file diff --git a/platform-bible-utils/interfaces/ModifierExtensionControlled.html b/platform-bible-utils/interfaces/ModifierExtensionControlled.html index 5614db1001..1d9775f61b 100644 --- a/platform-bible-utils/interfaces/ModifierExtensionControlled.html +++ b/platform-bible-utils/interfaces/ModifierExtensionControlled.html @@ -1,6 +1,6 @@ ModifierExtensionControlled | platform-bible-utils

        Interface ModifierExtensionControlled

        Modifies state/setting type to be extension-controlled. "Extension-controlled" means the extension provides the component and the validator for the state/setting, so the state/setting is controlled by the extension.

        -
        interface ModifierExtensionControlled {
            platformType?: undefined;
            type?: undefined;
            [k: string]: unknown;
        }

        Indexable

        [k: string]: unknown

        Properties

        platformType? +
        interface ModifierExtensionControlled {
            platformType?: undefined;
            type?: undefined;
            [k: string]: unknown;
        }

        Indexable

        [k: string]: unknown

        Properties

        platformType? type? -

        Properties

        Optional platformType

        platformType?: undefined

        Optional type

        type?: undefined

        Settings

        Member Visibility

        Theme

        On This Page

        platformTypetype
        \ No newline at end of file +

        Properties

        Optional platformType

        platformType?: undefined

        Optional type

        type?: undefined

        Settings

        Member Visibility

        Theme

        On This Page

        platformTypetype
        \ No newline at end of file diff --git a/platform-bible-utils/interfaces/ModifierProject.html b/platform-bible-utils/interfaces/ModifierProject.html index c1676e792e..081162ba40 100644 --- a/platform-bible-utils/interfaces/ModifierProject.html +++ b/platform-bible-utils/interfaces/ModifierProject.html @@ -1,11 +1,11 @@ ModifierProject | platform-bible-utils

        Interface ModifierProject

        Modifies setting type to be project setting

        -
        interface ModifierProject {
            excludeProjectTypes?: string | string[];
            includeProjectTypes?: string | string[];
            [k: string]: unknown;
        }

        Indexable

        [k: string]: unknown

        Properties

        excludeProjectTypes? +
        interface ModifierProject {
            excludeProjectTypes?: string | string[];
            includeProjectTypes?: string | string[];
            [k: string]: unknown;
        }

        Indexable

        [k: string]: unknown

        Properties

        excludeProjectTypes? includeProjectTypes?

        Properties

        Optional excludeProjectTypes

        excludeProjectTypes?: string | string[]

        RegExp pattern to match against projectType to determine if this project setting should absolutely not be displayed in the Project Settings dialog of that projectType even if it matches with includeProjectTypes

        -

        Optional includeProjectTypes

        includeProjectTypes?: string | string[]

        RegExp pattern(s) to match against projectType (using the +

        Optional includeProjectTypes

        includeProjectTypes?: string | string[]

        RegExp pattern(s) to match against projectType (using the test function) to determine whether this project setting should be displayed in the Project Settings Dialog of that projectType. null means do not show on any Project Settings dialog

        -

        Settings

        Member Visibility

        Theme

        On This Page

        excludeProjectTypesincludeProjectTypes
        \ No newline at end of file +

        Settings

        Member Visibility

        Theme

        On This Page

        excludeProjectTypesincludeProjectTypes
        \ No newline at end of file diff --git a/platform-bible-utils/interfaces/OnDidDispose.html b/platform-bible-utils/interfaces/OnDidDispose.html index 55031ae25e..18da750240 100644 --- a/platform-bible-utils/interfaces/OnDidDispose.html +++ b/platform-bible-utils/interfaces/OnDidDispose.html @@ -1,4 +1,4 @@ OnDidDispose | platform-bible-utils

        Interface OnDidDispose

        Require an onDidDispose event

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

        Properties

        onDidDispose +
        interface OnDidDispose {
            onDidDispose: PlatformEvent<void>;
        }

        Properties

        onDidDispose

        Properties

        onDidDispose

        onDidDispose: PlatformEvent<void>

        Event that emits when dispose is called on an object

        -

        Settings

        Member Visibility

        Theme

        On This Page

        onDidDispose
        \ No newline at end of file +

        Settings

        Member Visibility

        Theme

        On This Page

        onDidDispose
        \ No newline at end of file diff --git a/platform-bible-utils/interfaces/ProjectSettingProperties.html b/platform-bible-utils/interfaces/ProjectSettingProperties.html index 3a8da1ab2c..30294ab2d5 100644 --- a/platform-bible-utils/interfaces/ProjectSettingProperties.html +++ b/platform-bible-utils/interfaces/ProjectSettingProperties.html @@ -1,2 +1,2 @@ ProjectSettingProperties | platform-bible-utils

        Interface ProjectSettingProperties

        Object whose keys are setting IDs and whose values are settings objects

        -
        interface ProjectSettingProperties {
            [k: ReferencedItem]: ProjectSetting;
        }

        Indexable

        [k: ReferencedItem]: ProjectSetting

        Settings

        Member Visibility

        Theme

        \ No newline at end of file +
        interface ProjectSettingProperties {
            [k: ReferencedItem]: ProjectSetting;
        }

        Indexable

        [k: ReferencedItem]: ProjectSetting

        Settings

        Member Visibility

        Theme

        \ No newline at end of file diff --git a/platform-bible-utils/interfaces/ProjectSettingsGroup.html b/platform-bible-utils/interfaces/ProjectSettingsGroup.html index d73c8fa874..0d996d17e4 100644 --- a/platform-bible-utils/interfaces/ProjectSettingsGroup.html +++ b/platform-bible-utils/interfaces/ProjectSettingsGroup.html @@ -1,7 +1,7 @@ ProjectSettingsGroup | platform-bible-utils

        Interface ProjectSettingsGroup

        Group of related settings definitions

        -
        interface ProjectSettingsGroup {
            description?: `%${string}%`;
            label: `%${string}%`;
            properties: ProjectSettingProperties;
            [k: string]: unknown;
        }

        Indexable

        [k: string]: unknown

        Properties

        description? +
        interface ProjectSettingsGroup {
            description?: `%${string}%`;
            label: `%${string}%`;
            properties: ProjectSettingProperties;
            [k: string]: unknown;
        }

        Indexable

        [k: string]: unknown

        Properties

        description? label properties

        Properties

        Optional description

        description?: `%${string}%`

        LocalizeKey that displays in the project settings dialog to describe the group

        -

        label

        label: `%${string}%`

        LocalizeKey that displays in the project settings dialog as the group name

        -

        properties

        properties: ProjectSettingProperties

        Settings

        Member Visibility

        Theme

        On This Page

        descriptionlabelproperties
        \ No newline at end of file +

        label

        label: `%${string}%`

        LocalizeKey that displays in the project settings dialog as the group name

        +

        properties

        properties: ProjectSettingProperties

        Settings

        Member Visibility

        Theme

        On This Page

        descriptionlabelproperties
        \ No newline at end of file diff --git a/platform-bible-utils/interfaces/ProjectStateContribution.html b/platform-bible-utils/interfaces/ProjectStateContribution.html index 7394d39a80..520227a907 100644 --- a/platform-bible-utils/interfaces/ProjectStateContribution.html +++ b/platform-bible-utils/interfaces/ProjectStateContribution.html @@ -1,2 +1,2 @@ ProjectStateContribution | platform-bible-utils

        Interface ProjectStateContribution

        The data an extension provides to inform Platform.Bible of the project state it provides

        -
        interface ProjectStateContribution {
            [k: ReferencedItem]: UserState;
        }

        Indexable

        [k: ReferencedItem]: UserState

        Settings

        Member Visibility

        Theme

        \ No newline at end of file +
        interface ProjectStateContribution {
            [k: ReferencedItem]: UserState;
        }

        Indexable

        [k: ReferencedItem]: UserState

        Settings

        Member Visibility

        Theme

        \ No newline at end of file diff --git a/platform-bible-utils/interfaces/ScriptureReference.html b/platform-bible-utils/interfaces/ScriptureReference.html index 5df20a12f2..265185be81 100644 --- a/platform-bible-utils/interfaces/ScriptureReference.html +++ b/platform-bible-utils/interfaces/ScriptureReference.html @@ -1,4 +1,4 @@ -ScriptureReference | platform-bible-utils

        Interface ScriptureReference

        interface ScriptureReference {
            bookNum: number;
            chapterNum: number;
            verseNum: number;
        }

        Properties

        bookNum +ScriptureReference | platform-bible-utils

        Interface ScriptureReference

        interface ScriptureReference {
            bookNum: number;
            chapterNum: number;
            verseNum: number;
        }

        Properties

        bookNum chapterNum verseNum -

        Properties

        bookNum

        bookNum: number

        chapterNum

        chapterNum: number

        verseNum

        verseNum: number

        Settings

        Member Visibility

        Theme

        On This Page

        bookNumchapterNumverseNum
        \ No newline at end of file +

        Properties

        bookNum

        bookNum: number

        chapterNum

        chapterNum: number

        verseNum

        verseNum: number

        Settings

        Member Visibility

        Theme

        On This Page

        bookNumchapterNumverseNum
        \ No newline at end of file diff --git a/platform-bible-utils/interfaces/SettingProperties.html b/platform-bible-utils/interfaces/SettingProperties.html index bc1e285a67..ae44f435ca 100644 --- a/platform-bible-utils/interfaces/SettingProperties.html +++ b/platform-bible-utils/interfaces/SettingProperties.html @@ -1,2 +1,2 @@ SettingProperties | platform-bible-utils

        Interface SettingProperties

        Object whose keys are setting IDs and whose values are settings objects

        -
        interface SettingProperties {
            [k: ReferencedItem]: Setting;
        }

        Indexable

        [k: ReferencedItem]: Setting

        Settings

        Member Visibility

        Theme

        \ No newline at end of file +
        interface SettingProperties {
            [k: ReferencedItem]: Setting;
        }

        Indexable

        [k: ReferencedItem]: Setting

        Settings

        Member Visibility

        Theme

        \ No newline at end of file diff --git a/platform-bible-utils/interfaces/SettingsGroup.html b/platform-bible-utils/interfaces/SettingsGroup.html index b062e6b6cf..f8998db912 100644 --- a/platform-bible-utils/interfaces/SettingsGroup.html +++ b/platform-bible-utils/interfaces/SettingsGroup.html @@ -1,7 +1,7 @@ SettingsGroup | platform-bible-utils

        Interface SettingsGroup

        Group of related settings definitions

        -
        interface SettingsGroup {
            description?: `%${string}%`;
            label: `%${string}%`;
            properties: SettingProperties;
            [k: string]: unknown;
        }

        Indexable

        [k: string]: unknown

        Properties

        description? +
        interface SettingsGroup {
            description?: `%${string}%`;
            label: `%${string}%`;
            properties: SettingProperties;
            [k: string]: unknown;
        }

        Indexable

        [k: string]: unknown

        Properties

        description? label properties

        Properties

        Optional description

        description?: `%${string}%`

        LocalizeKey that displays in the settings dialog to describe the group

        -

        label

        label: `%${string}%`

        LocalizeKey that displays in the settings dialog as the group name

        -

        properties

        properties: SettingProperties

        Settings

        Member Visibility

        Theme

        On This Page

        descriptionlabelproperties
        \ No newline at end of file +

        label

        label: `%${string}%`

        LocalizeKey that displays in the settings dialog as the group name

        +

        properties

        properties: SettingProperties

        Settings

        Member Visibility

        Theme

        On This Page

        descriptionlabelproperties
        \ No newline at end of file diff --git a/platform-bible-utils/interfaces/StateBase.html b/platform-bible-utils/interfaces/StateBase.html index 5755992485..257210cd0c 100644 --- a/platform-bible-utils/interfaces/StateBase.html +++ b/platform-bible-utils/interfaces/StateBase.html @@ -1,7 +1,7 @@ StateBase | platform-bible-utils

        Interface StateBase

        Base information needed to describe a state entry

        -
        interface StateBase {
            default: unknown;
            derivesFrom?: `${string}.${string}`;
            [k: string]: unknown;
        }

        Indexable

        [k: string]: unknown

        Properties

        default +
        interface StateBase {
            default: unknown;
            derivesFrom?: `${string}.${string}`;
            [k: string]: unknown;
        }

        Indexable

        [k: string]: unknown

        Properties

        default derivesFrom?

        Properties

        default

        default: unknown

        Default value for the state/setting

        -

        Optional derivesFrom

        derivesFrom?: `${string}.${string}`

        A state/setting ID whose value to set to this state/setting's starting value the first time +

        Optional derivesFrom

        derivesFrom?: `${string}.${string}`

        A state/setting ID whose value to set to this state/setting's starting value the first time this state/setting is loaded

        -

        Settings

        Member Visibility

        Theme

        On This Page

        defaultderivesFrom
        \ No newline at end of file +

        Settings

        Member Visibility

        Theme

        On This Page

        defaultderivesFrom
        \ No newline at end of file diff --git a/platform-bible-utils/interfaces/UserStateContribution.html b/platform-bible-utils/interfaces/UserStateContribution.html index 680ccebfae..fe40369198 100644 --- a/platform-bible-utils/interfaces/UserStateContribution.html +++ b/platform-bible-utils/interfaces/UserStateContribution.html @@ -1,2 +1,2 @@ UserStateContribution | platform-bible-utils

        Interface UserStateContribution

        The data an extension provides to inform Platform.Bible of the user state it provides

        -
        interface UserStateContribution {
            [k: ReferencedItem]: UserState;
        }

        Indexable

        [k: ReferencedItem]: UserState

        Settings

        Member Visibility

        Theme

        \ No newline at end of file +
        interface UserStateContribution {
            [k: ReferencedItem]: UserState;
        }

        Indexable

        [k: ReferencedItem]: UserState

        Settings

        Member Visibility

        Theme

        \ No newline at end of file diff --git a/platform-bible-utils/types/CanHaveOnDidDispose.html b/platform-bible-utils/types/CanHaveOnDidDispose.html index 1e52a18b7a..4e73db84c0 100644 --- a/platform-bible-utils/types/CanHaveOnDidDispose.html +++ b/platform-bible-utils/types/CanHaveOnDidDispose.html @@ -1,2 +1,2 @@ CanHaveOnDidDispose | platform-bible-utils

        Type alias CanHaveOnDidDispose<T>

        CanHaveOnDidDispose<T>: Omit<T, "onDidDispose">

        Allow onDidDispose to exist on the type if it was previously disallowed by CannotHaveOnDidDispose

        -

        Type Parameters

        Settings

        Member Visibility

        Theme

        \ No newline at end of file +

        Type Parameters

        Settings

        Member Visibility

        Theme

        \ No newline at end of file diff --git a/platform-bible-utils/types/ColumnsWithHeaders.html b/platform-bible-utils/types/ColumnsWithHeaders.html index 1767d2a81f..21647da1fd 100644 --- a/platform-bible-utils/types/ColumnsWithHeaders.html +++ b/platform-bible-utils/types/ColumnsWithHeaders.html @@ -1,4 +1,4 @@ ColumnsWithHeaders | platform-bible-utils

        Type alias ColumnsWithHeaders

        ColumnsWithHeaders: {
            isExtensible?: boolean;
            [property: ReferencedItem]: MenuColumnWithHeader;
        }

        Group of columns that can be combined with other columns to form a multi-column menu

        Type declaration

        Settings

        Member Visibility

        Theme

        \ No newline at end of file +

        Settings

        Member Visibility

        Theme

        \ No newline at end of file diff --git a/platform-bible-utils/types/DeepPartial.html b/platform-bible-utils/types/DeepPartial.html index 934af4cf76..1a6b6266a8 100644 --- a/platform-bible-utils/types/DeepPartial.html +++ b/platform-bible-utils/types/DeepPartial.html @@ -1,2 +1,2 @@ DeepPartial | platform-bible-utils

        Type alias DeepPartial<T>

        DeepPartial<T>: T extends object
            ? {
                [P in keyof T]?: DeepPartial<T[P]>
            }
            : T

        Within type T, recursively change all properties to be optional

        -

        Type Parameters

        • T

        Settings

        Member Visibility

        Theme

        \ No newline at end of file +

        Type Parameters

        Settings

        Member Visibility

        Theme

        \ No newline at end of file diff --git a/platform-bible-utils/types/DocumentCombinerOptions.html b/platform-bible-utils/types/DocumentCombinerOptions.html index 3b2af8e2b1..70b8af5dff 100644 --- a/platform-bible-utils/types/DocumentCombinerOptions.html +++ b/platform-bible-utils/types/DocumentCombinerOptions.html @@ -7,4 +7,4 @@ contributed documents. If false, then throw when duplicate properties are seen in contributed documents. -

        Type declaration

        Settings

        Member Visibility

        Theme

        \ No newline at end of file +

        Type declaration

        Settings

        Member Visibility

        Theme

        \ No newline at end of file diff --git a/platform-bible-utils/types/ExtensionControlledProjectSetting.html b/platform-bible-utils/types/ExtensionControlledProjectSetting.html index a9e54ea2dc..84205593c7 100644 --- a/platform-bible-utils/types/ExtensionControlledProjectSetting.html +++ b/platform-bible-utils/types/ExtensionControlledProjectSetting.html @@ -1,2 +1,2 @@ ExtensionControlledProjectSetting | platform-bible-utils

        Type alias ExtensionControlledProjectSetting

        ExtensionControlledProjectSetting: ProjectSettingBase & ModifierExtensionControlled

        Setting definition that is validated by the extension.

        -

        Settings

        Member Visibility

        Theme

        \ No newline at end of file +

        Settings

        Member Visibility

        Theme

        \ No newline at end of file diff --git a/platform-bible-utils/types/ExtensionControlledSetting.html b/platform-bible-utils/types/ExtensionControlledSetting.html index 239f4ca4c6..499acbc060 100644 --- a/platform-bible-utils/types/ExtensionControlledSetting.html +++ b/platform-bible-utils/types/ExtensionControlledSetting.html @@ -1,2 +1,2 @@ ExtensionControlledSetting | platform-bible-utils

        Type alias ExtensionControlledSetting

        ExtensionControlledSetting: SettingBase & ModifierExtensionControlled

        Setting definition that is validated by the extension.

        -

        Settings

        Member Visibility

        Theme

        \ No newline at end of file +

        Settings

        Member Visibility

        Theme

        \ No newline at end of file diff --git a/platform-bible-utils/types/ExtensionControlledState.html b/platform-bible-utils/types/ExtensionControlledState.html index 812e36bff8..9663aae0f1 100644 --- a/platform-bible-utils/types/ExtensionControlledState.html +++ b/platform-bible-utils/types/ExtensionControlledState.html @@ -1,2 +1,2 @@ ExtensionControlledState | platform-bible-utils

        Type alias ExtensionControlledState

        ExtensionControlledState: StateBase & ModifierExtensionControlled

        State definition that is validated by the extension.

        -

        Settings

        Member Visibility

        Theme

        \ No newline at end of file +

        Settings

        Member Visibility

        Theme

        \ No newline at end of file diff --git a/platform-bible-utils/types/GroupsInMultiColumnMenu.html b/platform-bible-utils/types/GroupsInMultiColumnMenu.html index 17bc4f8192..7523d4f0d5 100644 --- a/platform-bible-utils/types/GroupsInMultiColumnMenu.html +++ b/platform-bible-utils/types/GroupsInMultiColumnMenu.html @@ -1,4 +1,4 @@ GroupsInMultiColumnMenu | platform-bible-utils

        Type alias GroupsInMultiColumnMenu

        GroupsInMultiColumnMenu: {
            [property: ReferencedItem]: MenuGroupDetailsInColumn | MenuGroupDetailsInSubMenu;
        }

        Group of menu items that can be combined with other groups to form a single menu/submenu within a multi-column menu. Groups are separated using a line within the menu/submenu.

        Type declaration

        Settings

        Member Visibility

        Theme

        \ No newline at end of file +

        Settings

        Member Visibility

        Theme

        \ No newline at end of file diff --git a/platform-bible-utils/types/GroupsInSingleColumnMenu.html b/platform-bible-utils/types/GroupsInSingleColumnMenu.html index 01d768855a..80e9803851 100644 --- a/platform-bible-utils/types/GroupsInSingleColumnMenu.html +++ b/platform-bible-utils/types/GroupsInSingleColumnMenu.html @@ -1,4 +1,4 @@ GroupsInSingleColumnMenu | platform-bible-utils

        Type alias GroupsInSingleColumnMenu

        GroupsInSingleColumnMenu: {
            [property: ReferencedItem]: OrderedExtensibleContainer | MenuGroupDetailsInSubMenu;
        }

        Group of menu items that can be combined with other groups to form a single context menu/submenu. Groups are separated using a line within the menu/submenu.

        Type declaration

        Settings

        Member Visibility

        Theme

        \ No newline at end of file +

        Settings

        Member Visibility

        Theme

        \ No newline at end of file diff --git a/platform-bible-utils/types/JsonDocumentLike.html b/platform-bible-utils/types/JsonDocumentLike.html index c24122dad2..ee164b3fb2 100644 --- a/platform-bible-utils/types/JsonDocumentLike.html +++ b/platform-bible-utils/types/JsonDocumentLike.html @@ -1 +1 @@ -JsonDocumentLike | platform-bible-utils

        Type alias JsonDocumentLike

        JsonDocumentLike: JsonObjectLike | JsonArrayLike

        Settings

        Member Visibility

        Theme

        \ No newline at end of file +JsonDocumentLike | platform-bible-utils

        Type alias JsonDocumentLike

        JsonDocumentLike: JsonObjectLike | JsonArrayLike

        Settings

        Member Visibility

        Theme

        \ No newline at end of file diff --git a/platform-bible-utils/types/LocalizeKey.html b/platform-bible-utils/types/LocalizeKey.html index 2c1e44fc4b..af98557e4d 100644 --- a/platform-bible-utils/types/LocalizeKey.html +++ b/platform-bible-utils/types/LocalizeKey.html @@ -1,2 +1,2 @@ LocalizeKey | platform-bible-utils

        Type alias LocalizeKey

        LocalizeKey: `%${string}%`

        Identifier for a string that will be localized in a menu based on the user's UI language

        -

        Settings

        Member Visibility

        Theme

        \ No newline at end of file +

        Settings

        Member Visibility

        Theme

        \ No newline at end of file diff --git a/platform-bible-utils/types/Localized.html b/platform-bible-utils/types/Localized.html index a4d6bc0655..e0af402c3b 100644 --- a/platform-bible-utils/types/Localized.html +++ b/platform-bible-utils/types/Localized.html @@ -1,3 +1,3 @@ Localized | platform-bible-utils

        Type alias Localized<T>

        Localized<T>: ReplaceType<ReplaceType<T, LocalizeKey, string>, ReferencedItem, string>

        Type that converts any menu type before it is localized to what it is after it is localized. This can be applied to any menu type as needed.

        -

        Type Parameters

        • T

        Settings

        Member Visibility

        Theme

        \ No newline at end of file +

        Type Parameters

        Settings

        Member Visibility

        Theme

        \ No newline at end of file diff --git a/platform-bible-utils/types/MenuColumnWithHeader.html b/platform-bible-utils/types/MenuColumnWithHeader.html index 77b90932ef..b7352ac69a 100644 --- a/platform-bible-utils/types/MenuColumnWithHeader.html +++ b/platform-bible-utils/types/MenuColumnWithHeader.html @@ -1,3 +1,3 @@ MenuColumnWithHeader | platform-bible-utils

        Type alias MenuColumnWithHeader

        MenuColumnWithHeader: OrderedExtensibleContainer & {
            label: LocalizeKey;
        }

        Column that includes header text in a menu

        Type declaration

        • label: LocalizeKey

          Key that represents the text of the header text of the column

          -

        Settings

        Member Visibility

        Theme

        \ No newline at end of file +

        Settings

        Member Visibility

        Theme

        \ No newline at end of file diff --git a/platform-bible-utils/types/MenuGroupDetailsInColumn.html b/platform-bible-utils/types/MenuGroupDetailsInColumn.html index d6df4a6283..e6d2125a48 100644 --- a/platform-bible-utils/types/MenuGroupDetailsInColumn.html +++ b/platform-bible-utils/types/MenuGroupDetailsInColumn.html @@ -1,3 +1,3 @@ MenuGroupDetailsInColumn | platform-bible-utils

        Type alias MenuGroupDetailsInColumn

        MenuGroupDetailsInColumn: OrderedExtensibleContainer & {
            column: ReferencedItem;
        }

        Group of menu items that belongs in a column

        Type declaration

        Settings

        Member Visibility

        Theme

        \ No newline at end of file +

        Settings

        Member Visibility

        Theme

        \ No newline at end of file diff --git a/platform-bible-utils/types/MenuGroupDetailsInSubMenu.html b/platform-bible-utils/types/MenuGroupDetailsInSubMenu.html index 41e0ac7e05..f14f6ed37e 100644 --- a/platform-bible-utils/types/MenuGroupDetailsInSubMenu.html +++ b/platform-bible-utils/types/MenuGroupDetailsInSubMenu.html @@ -1,3 +1,3 @@ MenuGroupDetailsInSubMenu | platform-bible-utils

        Type alias MenuGroupDetailsInSubMenu

        MenuGroupDetailsInSubMenu: OrderedExtensibleContainer & {
            menuItem: ReferencedItem;
        }

        Group of menu items that belongs in a submenu

        Type declaration

        • menuItem: ReferencedItem

          ID of menu item hosting the submenu in which this group resides

          -

        Settings

        Member Visibility

        Theme

        \ No newline at end of file +

        Settings

        Member Visibility

        Theme

        \ No newline at end of file diff --git a/platform-bible-utils/types/MenuItemBase.html b/platform-bible-utils/types/MenuItemBase.html index 547fd266a8..0276264502 100644 --- a/platform-bible-utils/types/MenuItemBase.html +++ b/platform-bible-utils/types/MenuItemBase.html @@ -3,4 +3,4 @@
      • localizeNotes: string

        Additional information provided by developers to help people who perform localization

      • Optional searchTerms?: LocalizeKey

        Key that represents words the platform should reference when users are searching for menu items

      • Optional tooltip?: LocalizeKey

        Key that represents the text to display if a mouse pointer hovers over the menu item

        -

        • Settings

        Member Visibility

        Theme

        \ No newline at end of file +

        Settings

        Member Visibility

        Theme

        \ No newline at end of file diff --git a/platform-bible-utils/types/MenuItemContainingCommand.html b/platform-bible-utils/types/MenuItemContainingCommand.html index a30687e372..2138a0a27e 100644 --- a/platform-bible-utils/types/MenuItemContainingCommand.html +++ b/platform-bible-utils/types/MenuItemContainingCommand.html @@ -2,4 +2,4 @@

        Type declaration

        Settings

        Member Visibility

        Theme

        \ No newline at end of file +

        Settings

        Member Visibility

        Theme

        \ No newline at end of file diff --git a/platform-bible-utils/types/MenuItemContainingSubmenu.html b/platform-bible-utils/types/MenuItemContainingSubmenu.html index e5d0577e9d..9ef42eb453 100644 --- a/platform-bible-utils/types/MenuItemContainingSubmenu.html +++ b/platform-bible-utils/types/MenuItemContainingSubmenu.html @@ -1,3 +1,3 @@ MenuItemContainingSubmenu | platform-bible-utils

        Type alias MenuItemContainingSubmenu

        MenuItemContainingSubmenu: MenuItemBase & {
            id: ReferencedItem;
        }

        Menu item that hosts a submenu

        Type declaration

        Settings

        Member Visibility

        Theme

        \ No newline at end of file +

        Settings

        Member Visibility

        Theme

        \ No newline at end of file diff --git a/platform-bible-utils/types/MultiColumnMenu.html b/platform-bible-utils/types/MultiColumnMenu.html index cc6c7c2dda..13276f0d7b 100644 --- a/platform-bible-utils/types/MultiColumnMenu.html +++ b/platform-bible-utils/types/MultiColumnMenu.html @@ -2,4 +2,4 @@

        Type declaration

        Settings

        Member Visibility

        Theme

        \ No newline at end of file +

        Settings

        Member Visibility

        Theme

        \ No newline at end of file diff --git a/platform-bible-utils/types/OrderedExtensibleContainer.html b/platform-bible-utils/types/OrderedExtensibleContainer.html index 231a9a7d04..cc086feab3 100644 --- a/platform-bible-utils/types/OrderedExtensibleContainer.html +++ b/platform-bible-utils/types/OrderedExtensibleContainer.html @@ -1,2 +1,2 @@ OrderedExtensibleContainer | platform-bible-utils

        Type alias OrderedExtensibleContainer

        OrderedExtensibleContainer: OrderedItem & {
            isExtensible?: boolean;
        }

        Type declaration

        • Optional isExtensible?: boolean

          Determines whether other items can be added to this after it has been defined

          -

        Settings

        Member Visibility

        Theme

        \ No newline at end of file +

        Settings

        Member Visibility

        Theme

        \ No newline at end of file diff --git a/platform-bible-utils/types/OrderedItem.html b/platform-bible-utils/types/OrderedItem.html index 0d36821c17..b9ea4d42fb 100644 --- a/platform-bible-utils/types/OrderedItem.html +++ b/platform-bible-utils/types/OrderedItem.html @@ -1,2 +1,2 @@ OrderedItem | platform-bible-utils

        Type alias OrderedItem

        OrderedItem: {
            order: number;
        }

        Type declaration

        • order: number

          Relative order of this item compared to other items in the same parent/scope (sorted ascending)

          -

        Settings

        Member Visibility

        Theme

        \ No newline at end of file +

        Settings

        Member Visibility

        Theme

        \ No newline at end of file diff --git a/platform-bible-utils/types/PlatformEvent.html b/platform-bible-utils/types/PlatformEvent.html index 756251fa78..53e3101a6e 100644 --- a/platform-bible-utils/types/PlatformEvent.html +++ b/platform-bible-utils/types/PlatformEvent.html @@ -2,4 +2,4 @@

        Type Parameters

        Type declaration

        Returns

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

        -

        Settings

        Member Visibility

        Theme

        \ No newline at end of file +

        Settings

        Member Visibility

        Theme

        \ No newline at end of file diff --git a/platform-bible-utils/types/PlatformEventAsync.html b/platform-bible-utils/types/PlatformEventAsync.html index f1f9af5548..91ff9481af 100644 --- a/platform-bible-utils/types/PlatformEventAsync.html +++ b/platform-bible-utils/types/PlatformEventAsync.html @@ -1,3 +1,3 @@ PlatformEventAsync | platform-bible-utils

        Type alias PlatformEventAsync<T>

        PlatformEventAsync<T>: ((callback) => Promise<UnsubscriberAsync>)

        A PapiEvent that subscribes asynchronously and resolves an asynchronous unsubscriber.

        Note: The callback itself is not asynchronous.

        -

        Type Parameters

        • T

        Type declaration

        Settings

        Member Visibility

        Theme

        \ No newline at end of file +

        Type Parameters

        Type declaration

        Settings

        Member Visibility

        Theme

        \ No newline at end of file diff --git a/platform-bible-utils/types/PlatformEventHandler.html b/platform-bible-utils/types/PlatformEventHandler.html index 95629579ee..299e3424a1 100644 --- a/platform-bible-utils/types/PlatformEventHandler.html +++ b/platform-bible-utils/types/PlatformEventHandler.html @@ -1,2 +1,2 @@ PlatformEventHandler | platform-bible-utils

        Type alias PlatformEventHandler<T>

        PlatformEventHandler<T>: ((event) => void)

        Callback function that accepts an event and should run when an event is emitted

        -

        Type Parameters

        • T

        Type declaration

          • (event): void

          • Parameters

            • event: T

            Returns void

        Settings

        Member Visibility

        Theme

        \ No newline at end of file +

        Type Parameters

        Type declaration

        Settings

        Member Visibility

        Theme

        \ No newline at end of file diff --git a/platform-bible-utils/types/PlatformMenus.html b/platform-bible-utils/types/PlatformMenus.html index 50228bb987..4f01eb9578 100644 --- a/platform-bible-utils/types/PlatformMenus.html +++ b/platform-bible-utils/types/PlatformMenus.html @@ -3,4 +3,4 @@
      • defaultWebViewTopMenu: MultiColumnMenu

        Default top menu for web views that don't specify their own

      • mainMenu: MultiColumnMenu

        Top level menu for the application

      • webViewMenus: WebViewMenus

        Menus that apply per web view in the application

        -

        • Settings

        Member Visibility

        Theme

        \ No newline at end of file +

        Settings

        Member Visibility

        Theme

        \ No newline at end of file diff --git a/platform-bible-utils/types/ProjectSetting.html b/platform-bible-utils/types/ProjectSetting.html index 7f35cf7640..05bed940e1 100644 --- a/platform-bible-utils/types/ProjectSetting.html +++ b/platform-bible-utils/types/ProjectSetting.html @@ -1,2 +1,2 @@ ProjectSetting | platform-bible-utils

        Type alias ProjectSetting

        ProjectSetting: ExtensionControlledProjectSetting

        A description of an extension's setting entry

        -

        Settings

        Member Visibility

        Theme

        \ No newline at end of file +

        Settings

        Member Visibility

        Theme

        \ No newline at end of file diff --git a/platform-bible-utils/types/ProjectSettingBase.html b/platform-bible-utils/types/ProjectSettingBase.html index 711442be5f..8e8f44cf52 100644 --- a/platform-bible-utils/types/ProjectSettingBase.html +++ b/platform-bible-utils/types/ProjectSettingBase.html @@ -1,2 +1,2 @@ ProjectSettingBase | platform-bible-utils

        Type alias ProjectSettingBase

        ProjectSettingBase: SettingBase & ModifierProject

        Base information needed to describe a project setting entry

        -

        Settings

        Member Visibility

        Theme

        \ No newline at end of file +

        Settings

        Member Visibility

        Theme

        \ No newline at end of file diff --git a/platform-bible-utils/types/ProjectSettingsContribution.html b/platform-bible-utils/types/ProjectSettingsContribution.html index a5204d8b3f..d0ddc57710 100644 --- a/platform-bible-utils/types/ProjectSettingsContribution.html +++ b/platform-bible-utils/types/ProjectSettingsContribution.html @@ -1,2 +1,2 @@ ProjectSettingsContribution | platform-bible-utils

        Type alias ProjectSettingsContribution

        ProjectSettingsContribution: ProjectSettingsGroup | ProjectSettingsGroup[]

        The data an extension provides to inform Platform.Bible of the project settings it provides

        -

        Settings

        Member Visibility

        Theme

        \ No newline at end of file +

        Settings

        Member Visibility

        Theme

        \ No newline at end of file diff --git a/platform-bible-utils/types/ReferencedItem.html b/platform-bible-utils/types/ReferencedItem.html index 2fbcaafdfd..fa699a0ebd 100644 --- a/platform-bible-utils/types/ReferencedItem.html +++ b/platform-bible-utils/types/ReferencedItem.html @@ -1,2 +1,2 @@ ReferencedItem | platform-bible-utils

        Type alias ReferencedItem

        ReferencedItem: `${string}.${string}`

        Name of some UI element (i.e., tab, column, group, menu item) or some PAPI object (i.e., command)

        -

        Settings

        Member Visibility

        Theme

        \ No newline at end of file +

        Settings

        Member Visibility

        Theme

        \ No newline at end of file diff --git a/platform-bible-utils/types/ReplaceType.html b/platform-bible-utils/types/ReplaceType.html index cd91dfef50..14531867ec 100644 --- a/platform-bible-utils/types/ReplaceType.html +++ b/platform-bible-utils/types/ReplaceType.html @@ -1,2 +1,2 @@ ReplaceType | platform-bible-utils

        Type alias ReplaceType<T, A, B>

        ReplaceType<T, A, B>: T extends A
            ? B
            : T extends object
                ? {
                    [K in keyof T]: ReplaceType<T[K], A, B>
                }
                : T

        Within type T, recursively change properties that were of type A to be of type B

        -

        Type Parameters

        • T
        • A
        • B

        Settings

        Member Visibility

        Theme

        \ No newline at end of file +

        Type Parameters

        Settings

        Member Visibility

        Theme

        \ No newline at end of file diff --git a/platform-bible-utils/types/Setting.html b/platform-bible-utils/types/Setting.html index 0add0cba9f..54a2660149 100644 --- a/platform-bible-utils/types/Setting.html +++ b/platform-bible-utils/types/Setting.html @@ -1,2 +1,2 @@ Setting | platform-bible-utils

        Type alias Setting

        Setting: ExtensionControlledSetting

        A description of an extension's setting entry

        -

        Settings

        Member Visibility

        Theme

        \ No newline at end of file +

        Settings

        Member Visibility

        Theme

        \ No newline at end of file diff --git a/platform-bible-utils/types/SettingBase.html b/platform-bible-utils/types/SettingBase.html index ee581b324a..66d84ce79c 100644 --- a/platform-bible-utils/types/SettingBase.html +++ b/platform-bible-utils/types/SettingBase.html @@ -1,4 +1,4 @@ SettingBase | platform-bible-utils

        Type alias SettingBase

        SettingBase: StateBase & {
            description?: LocalizeKey;
            label: LocalizeKey;
            [k: string]: unknown;
        }

        Base information needed to describe a setting entry

        Type declaration

        • [k: string]: unknown
        • Optional description?: LocalizeKey

          LocalizeKey that displays in the settings dialog to describe the setting

        • label: LocalizeKey

          LocalizeKey that displays in the settings dialog as the setting name

          -

        Settings

        Member Visibility

        Theme

        \ No newline at end of file +

        Settings

        Member Visibility

        Theme

        \ No newline at end of file diff --git a/platform-bible-utils/types/SettingsContribution.html b/platform-bible-utils/types/SettingsContribution.html index ecb563918c..6f81b25575 100644 --- a/platform-bible-utils/types/SettingsContribution.html +++ b/platform-bible-utils/types/SettingsContribution.html @@ -1,2 +1,2 @@ SettingsContribution | platform-bible-utils

        Type alias SettingsContribution

        SettingsContribution: SettingsGroup | SettingsGroup[]

        The data an extension provides to inform Platform.Bible of the settings it provides

        -

        Settings

        Member Visibility

        Theme

        \ No newline at end of file +

        Settings

        Member Visibility

        Theme

        \ No newline at end of file diff --git a/platform-bible-utils/types/SingleColumnMenu.html b/platform-bible-utils/types/SingleColumnMenu.html index 644195b7a2..2c3863ae9b 100644 --- a/platform-bible-utils/types/SingleColumnMenu.html +++ b/platform-bible-utils/types/SingleColumnMenu.html @@ -1,4 +1,4 @@ SingleColumnMenu | platform-bible-utils

        Type alias SingleColumnMenu

        SingleColumnMenu: {
            groups: GroupsInSingleColumnMenu;
            items: (MenuItemContainingCommand | MenuItemContainingSubmenu)[];
        }

        Menu that contains a column without a header

        Type declaration

        Settings

        Member Visibility

        Theme

        \ No newline at end of file +

        Settings

        Member Visibility

        Theme

        \ No newline at end of file diff --git a/platform-bible-utils/types/Unsubscriber.html b/platform-bible-utils/types/Unsubscriber.html index d82e89ead4..27e21cff09 100644 --- a/platform-bible-utils/types/Unsubscriber.html +++ b/platform-bible-utils/types/Unsubscriber.html @@ -1,2 +1,2 @@ Unsubscriber | platform-bible-utils

        Type alias Unsubscriber

        Unsubscriber: (() => boolean)

        Function to run to dispose of something. Returns true if successfully unsubscribed

        -

        Type declaration

          • (): boolean

          • Returns boolean

        Settings

        Member Visibility

        Theme

        \ No newline at end of file +

        Type declaration

        Settings

        Member Visibility

        Theme

        \ No newline at end of file diff --git a/platform-bible-utils/types/UnsubscriberAsync.html b/platform-bible-utils/types/UnsubscriberAsync.html index 7d86f70e30..e3e40b2d87 100644 --- a/platform-bible-utils/types/UnsubscriberAsync.html +++ b/platform-bible-utils/types/UnsubscriberAsync.html @@ -1,3 +1,3 @@ UnsubscriberAsync | platform-bible-utils

        Type alias UnsubscriberAsync

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

        Function to run to dispose of something that runs asynchronously. The promise resolves to true if successfully unsubscribed

        -

        Type declaration

          • (): Promise<boolean>

          • Returns Promise<boolean>

        Settings

        Member Visibility

        Theme

        \ No newline at end of file +

        Type declaration

        Settings

        Member Visibility

        Theme

        \ No newline at end of file diff --git a/platform-bible-utils/types/UserState.html b/platform-bible-utils/types/UserState.html index 4b1550a6e2..4c9c56ecd9 100644 --- a/platform-bible-utils/types/UserState.html +++ b/platform-bible-utils/types/UserState.html @@ -1,2 +1,2 @@ UserState | platform-bible-utils

        Type alias UserState

        UserState: ExtensionControlledState

        A description of an extension's user state entry

        -

        Settings

        Member Visibility

        Theme

        \ No newline at end of file +

        Settings

        Member Visibility

        Theme

        \ No newline at end of file diff --git a/platform-bible-utils/types/WebViewMenu.html b/platform-bible-utils/types/WebViewMenu.html index 22e28d05a7..b9815e1cf0 100644 --- a/platform-bible-utils/types/WebViewMenu.html +++ b/platform-bible-utils/types/WebViewMenu.html @@ -2,4 +2,4 @@

        Type declaration

        Settings

        Member Visibility

        Theme

        \ No newline at end of file +

        Settings

        Member Visibility

        Theme

        \ No newline at end of file diff --git a/platform-bible-utils/types/WebViewMenus.html b/platform-bible-utils/types/WebViewMenus.html index 831942759a..17da5a9fe1 100644 --- a/platform-bible-utils/types/WebViewMenus.html +++ b/platform-bible-utils/types/WebViewMenus.html @@ -1,3 +1,3 @@ WebViewMenus | platform-bible-utils

        Type alias WebViewMenus

        WebViewMenus: {
            [property: ReferencedItem]: WebViewMenu;
        }

        Menus for all web views

        Type declaration

        Settings

        Member Visibility

        Theme

        \ No newline at end of file +

        Settings

        Member Visibility

        Theme

        \ No newline at end of file diff --git a/platform-bible-utils/variables/FIRST_SCR_BOOK_NUM.html b/platform-bible-utils/variables/FIRST_SCR_BOOK_NUM.html index a99a135b4a..701d7a6b2a 100644 --- a/platform-bible-utils/variables/FIRST_SCR_BOOK_NUM.html +++ b/platform-bible-utils/variables/FIRST_SCR_BOOK_NUM.html @@ -1 +1 @@ -FIRST_SCR_BOOK_NUM | platform-bible-utils

        Variable FIRST_SCR_BOOK_NUMConst

        FIRST_SCR_BOOK_NUM: 1 = 1

        Settings

        Member Visibility

        Theme

        \ No newline at end of file +FIRST_SCR_BOOK_NUM | platform-bible-utils

        Variable FIRST_SCR_BOOK_NUMConst

        FIRST_SCR_BOOK_NUM: 1 = 1

        Settings

        Member Visibility

        Theme

        \ No newline at end of file diff --git a/platform-bible-utils/variables/FIRST_SCR_CHAPTER_NUM.html b/platform-bible-utils/variables/FIRST_SCR_CHAPTER_NUM.html index 31d89d24af..a326a4403c 100644 --- a/platform-bible-utils/variables/FIRST_SCR_CHAPTER_NUM.html +++ b/platform-bible-utils/variables/FIRST_SCR_CHAPTER_NUM.html @@ -1 +1 @@ -FIRST_SCR_CHAPTER_NUM | platform-bible-utils

        Variable FIRST_SCR_CHAPTER_NUMConst

        FIRST_SCR_CHAPTER_NUM: 1 = 1

        Settings

        Member Visibility

        Theme

        \ No newline at end of file +FIRST_SCR_CHAPTER_NUM | platform-bible-utils

        Variable FIRST_SCR_CHAPTER_NUMConst

        FIRST_SCR_CHAPTER_NUM: 1 = 1

        Settings

        Member Visibility

        Theme

        \ No newline at end of file diff --git a/platform-bible-utils/variables/FIRST_SCR_VERSE_NUM.html b/platform-bible-utils/variables/FIRST_SCR_VERSE_NUM.html index 492038ff3e..4b92bf3546 100644 --- a/platform-bible-utils/variables/FIRST_SCR_VERSE_NUM.html +++ b/platform-bible-utils/variables/FIRST_SCR_VERSE_NUM.html @@ -1 +1 @@ -FIRST_SCR_VERSE_NUM | platform-bible-utils

        Variable FIRST_SCR_VERSE_NUMConst

        FIRST_SCR_VERSE_NUM: 1 = 1

        Settings

        Member Visibility

        Theme

        \ No newline at end of file +FIRST_SCR_VERSE_NUM | platform-bible-utils

        Variable FIRST_SCR_VERSE_NUMConst

        FIRST_SCR_VERSE_NUM: 1 = 1

        Settings

        Member Visibility

        Theme

        \ No newline at end of file diff --git a/platform-bible-utils/variables/LAST_SCR_BOOK_NUM.html b/platform-bible-utils/variables/LAST_SCR_BOOK_NUM.html index 522d929666..da644fb75b 100644 --- a/platform-bible-utils/variables/LAST_SCR_BOOK_NUM.html +++ b/platform-bible-utils/variables/LAST_SCR_BOOK_NUM.html @@ -1 +1 @@ -LAST_SCR_BOOK_NUM | platform-bible-utils

        Variable LAST_SCR_BOOK_NUMConst

        LAST_SCR_BOOK_NUM: number = ...

        Settings

        Member Visibility

        Theme

        \ No newline at end of file +LAST_SCR_BOOK_NUM | platform-bible-utils

        Variable LAST_SCR_BOOK_NUMConst

        LAST_SCR_BOOK_NUM: number = ...

        Settings

        Member Visibility

        Theme

        \ No newline at end of file diff --git a/platform-bible-utils/variables/menuDocumentSchema.html b/platform-bible-utils/variables/menuDocumentSchema.html index d6f6a14cb3..c36da0cd0e 100644 --- a/platform-bible-utils/variables/menuDocumentSchema.html +++ b/platform-bible-utils/variables/menuDocumentSchema.html @@ -1,2 +1,2 @@ menuDocumentSchema | platform-bible-utils

        Variable menuDocumentSchemaConst

        menuDocumentSchema: {
            $defs: {
                columnsWithHeaders: {
                    description: string;
                    patternProperties: {
                        ^[\w\-]+\.[\w\-]+$: {
                            additionalProperties: boolean;
                            description: string;
                            properties: {
                                isExtensible: {
                                    description: string;
                                    type: string;
                                };
                                label: {
                                    $ref: string;
                                    description: string;
                                };
                                localizeNotes: {
                                    description: string;
                                    type: string;
                                };
                                order: {
                                    description: string;
                                    type: string;
                                };
                            };
                            required: string[];
                            type: string;
                        };
                    };
                    properties: {
                        isExtensible: {
                            description: string;
                            type: string;
                        };
                    };
                    type: string;
                };
                groupsAndItems: {
                    description: string;
                    properties: {
                        groups: {
                            $ref: string;
                            description: string;
                        };
                        items: {
                            description: string;
                            items: {
                                $ref: string;
                            };
                            type: string;
                            uniqueItems: boolean;
                        };
                    };
                    required: string[];
                    type: string;
                };
                localizeKey: {
                    description: string;
                    pattern: string;
                    type: string;
                };
                menuGroups: {
                    additionalProperties: boolean;
                    description: string;
                    patternProperties: {
                        ^[\w\-]+\.[\w\-]+$: {
                            description: string;
                            oneOf: ({
                                additionalProperties: boolean;
                                properties: {
                                    column: {
                                        $ref: string;
                                        description: string;
                                    };
                                    isExtensible: {
                                        description: string;
                                        type: string;
                                    };
                                    menuItem?: undefined;
                                    order: {
                                        description: string;
                                        type: string;
                                    };
                                };
                                required: string[];
                            } | {
                                additionalProperties: boolean;
                                properties: {
                                    column?: undefined;
                                    isExtensible: {
                                        description: string;
                                        type: string;
                                    };
                                    menuItem: {
                                        $ref: string;
                                        description: string;
                                    };
                                    order: {
                                        description: string;
                                        type: string;
                                    };
                                };
                                required: string[];
                            })[];
                            type: string;
                        };
                    };
                    type: string;
                };
                menuItem: {
                    description: string;
                    oneOf: ({
                        properties: {
                            command?: undefined;
                            iconPathAfter?: undefined;
                            iconPathBefore?: undefined;
                            id: {
                                $ref: string;
                                description: string;
                            };
                        };
                        required: string[];
                    } | {
                        properties: {
                            command: {
                                $ref: string;
                                description: string;
                            };
                            iconPathAfter: {
                                description: string;
                                type: string;
                            };
                            iconPathBefore: {
                                description: string;
                                type: string;
                            };
                            id?: undefined;
                        };
                        required: string[];
                    })[];
                    properties: {
                        group: {
                            $ref: string;
                            description: string;
                        };
                        label: {
                            $ref: string;
                            description: string;
                        };
                        localizeNotes: {
                            description: string;
                            type: string;
                        };
                        order: {
                            description: string;
                            type: string;
                        };
                        searchTerms: {
                            $ref: string;
                            description: string;
                        };
                        tooltip: {
                            $ref: string;
                            description: string;
                        };
                    };
                    required: string[];
                    type: string;
                    unevaluatedProperties: boolean;
                };
                menusForOneWebView: {
                    additionalProperties: boolean;
                    description: string;
                    properties: {
                        contextMenu: {
                            $ref: string;
                            description: string;
                        };
                        includeDefaults: {
                            description: string;
                            type: string;
                        };
                        topMenu: {
                            $ref: string;
                            description: string;
                        };
                    };
                    type: string;
                };
                multiColumnMenu: {
                    allOf: ({
                        $ref: string;
                        properties?: undefined;
                        required?: undefined;
                    } | {
                        $ref?: undefined;
                        properties: {
                            columns: {
                                $ref: string;
                                description: string;
                            };
                        };
                        required: string[];
                    })[];
                    description: string;
                    type: string;
                    unevaluatedProperties: boolean;
                };
                referencedItem: {
                    description: string;
                    pattern: string;
                    type: string;
                };
                singleColumnMenu: {
                    allOf: {
                        $ref: string;
                    }[];
                    description: string;
                    type: string;
                    unevaluatedProperties: boolean;
                };
            };
            additionalProperties: boolean;
            properties: {
                defaultWebViewContextMenu: {
                    $ref: string;
                    description: string;
                };
                defaultWebViewTopMenu: {
                    $ref: string;
                    description: string;
                };
                mainMenu: {
                    $ref: string;
                    description: string;
                };
                webViewMenus: {
                    additionalProperties: boolean;
                    description: string;
                    patternProperties: {
                        ^[\w\-]+\.[\w\-]+$: {
                            $ref: string;
                        };
                    };
                    type: string;
                };
            };
            required: string[];
            title: string;
            type: string;
        } = ...

        JSON schema object that aligns with the PlatformMenus type

        -

        Type declaration

        • $defs: {
              columnsWithHeaders: {
                  description: string;
                  patternProperties: {
                      ^[\w\-]+\.[\w\-]+$: {
                          additionalProperties: boolean;
                          description: string;
                          properties: {
                              isExtensible: {
                                  description: string;
                                  type: string;
                              };
                              label: {
                                  $ref: string;
                                  description: string;
                              };
                              localizeNotes: {
                                  description: string;
                                  type: string;
                              };
                              order: {
                                  description: string;
                                  type: string;
                              };
                          };
                          required: string[];
                          type: string;
                      };
                  };
                  properties: {
                      isExtensible: {
                          description: string;
                          type: string;
                      };
                  };
                  type: string;
              };
              groupsAndItems: {
                  description: string;
                  properties: {
                      groups: {
                          $ref: string;
                          description: string;
                      };
                      items: {
                          description: string;
                          items: {
                              $ref: string;
                          };
                          type: string;
                          uniqueItems: boolean;
                      };
                  };
                  required: string[];
                  type: string;
              };
              localizeKey: {
                  description: string;
                  pattern: string;
                  type: string;
              };
              menuGroups: {
                  additionalProperties: boolean;
                  description: string;
                  patternProperties: {
                      ^[\w\-]+\.[\w\-]+$: {
                          description: string;
                          oneOf: ({
                              additionalProperties: boolean;
                              properties: {
                                  column: {
                                      $ref: string;
                                      description: string;
                                  };
                                  isExtensible: {
                                      description: string;
                                      type: string;
                                  };
                                  menuItem?: undefined;
                                  order: {
                                      description: string;
                                      type: string;
                                  };
                              };
                              required: string[];
                          } | {
                              additionalProperties: boolean;
                              properties: {
                                  column?: undefined;
                                  isExtensible: {
                                      description: string;
                                      type: string;
                                  };
                                  menuItem: {
                                      $ref: string;
                                      description: string;
                                  };
                                  order: {
                                      description: string;
                                      type: string;
                                  };
                              };
                              required: string[];
                          })[];
                          type: string;
                      };
                  };
                  type: string;
              };
              menuItem: {
                  description: string;
                  oneOf: ({
                      properties: {
                          command?: undefined;
                          iconPathAfter?: undefined;
                          iconPathBefore?: undefined;
                          id: {
                              $ref: string;
                              description: string;
                          };
                      };
                      required: string[];
                  } | {
                      properties: {
                          command: {
                              $ref: string;
                              description: string;
                          };
                          iconPathAfter: {
                              description: string;
                              type: string;
                          };
                          iconPathBefore: {
                              description: string;
                              type: string;
                          };
                          id?: undefined;
                      };
                      required: string[];
                  })[];
                  properties: {
                      group: {
                          $ref: string;
                          description: string;
                      };
                      label: {
                          $ref: string;
                          description: string;
                      };
                      localizeNotes: {
                          description: string;
                          type: string;
                      };
                      order: {
                          description: string;
                          type: string;
                      };
                      searchTerms: {
                          $ref: string;
                          description: string;
                      };
                      tooltip: {
                          $ref: string;
                          description: string;
                      };
                  };
                  required: string[];
                  type: string;
                  unevaluatedProperties: boolean;
              };
              menusForOneWebView: {
                  additionalProperties: boolean;
                  description: string;
                  properties: {
                      contextMenu: {
                          $ref: string;
                          description: string;
                      };
                      includeDefaults: {
                          description: string;
                          type: string;
                      };
                      topMenu: {
                          $ref: string;
                          description: string;
                      };
                  };
                  type: string;
              };
              multiColumnMenu: {
                  allOf: ({
                      $ref: string;
                      properties?: undefined;
                      required?: undefined;
                  } | {
                      $ref?: undefined;
                      properties: {
                          columns: {
                              $ref: string;
                              description: string;
                          };
                      };
                      required: string[];
                  })[];
                  description: string;
                  type: string;
                  unevaluatedProperties: boolean;
              };
              referencedItem: {
                  description: string;
                  pattern: string;
                  type: string;
              };
              singleColumnMenu: {
                  allOf: {
                      $ref: string;
                  }[];
                  description: string;
                  type: string;
                  unevaluatedProperties: boolean;
              };
          }
          • columnsWithHeaders: {
                description: string;
                patternProperties: {
                    ^[\w\-]+\.[\w\-]+$: {
                        additionalProperties: boolean;
                        description: string;
                        properties: {
                            isExtensible: {
                                description: string;
                                type: string;
                            };
                            label: {
                                $ref: string;
                                description: string;
                            };
                            localizeNotes: {
                                description: string;
                                type: string;
                            };
                            order: {
                                description: string;
                                type: string;
                            };
                        };
                        required: string[];
                        type: string;
                    };
                };
                properties: {
                    isExtensible: {
                        description: string;
                        type: string;
                    };
                };
                type: string;
            }
            • description: string
            • patternProperties: {
                  ^[\w\-]+\.[\w\-]+$: {
                      additionalProperties: boolean;
                      description: string;
                      properties: {
                          isExtensible: {
                              description: string;
                              type: string;
                          };
                          label: {
                              $ref: string;
                              description: string;
                          };
                          localizeNotes: {
                              description: string;
                              type: string;
                          };
                          order: {
                              description: string;
                              type: string;
                          };
                      };
                      required: string[];
                      type: string;
                  };
              }
              • ^[\w\-]+\.[\w\-]+$: {
                    additionalProperties: boolean;
                    description: string;
                    properties: {
                        isExtensible: {
                            description: string;
                            type: string;
                        };
                        label: {
                            $ref: string;
                            description: string;
                        };
                        localizeNotes: {
                            description: string;
                            type: string;
                        };
                        order: {
                            description: string;
                            type: string;
                        };
                    };
                    required: string[];
                    type: string;
                }
                • additionalProperties: boolean
                • description: string
                • properties: {
                      isExtensible: {
                          description: string;
                          type: string;
                      };
                      label: {
                          $ref: string;
                          description: string;
                      };
                      localizeNotes: {
                          description: string;
                          type: string;
                      };
                      order: {
                          description: string;
                          type: string;
                      };
                  }
                  • isExtensible: {
                        description: string;
                        type: string;
                    }
                    • description: string
                    • type: string
                  • label: {
                        $ref: string;
                        description: string;
                    }
                    • $ref: string
                    • description: string
                  • localizeNotes: {
                        description: string;
                        type: string;
                    }
                    • description: string
                    • type: string
                  • order: {
                        description: string;
                        type: string;
                    }
                    • description: string
                    • type: string
                • required: string[]
                • type: string
            • properties: {
                  isExtensible: {
                      description: string;
                      type: string;
                  };
              }
              • isExtensible: {
                    description: string;
                    type: string;
                }
                • description: string
                • type: string
            • type: string
          • groupsAndItems: {
                description: string;
                properties: {
                    groups: {
                        $ref: string;
                        description: string;
                    };
                    items: {
                        description: string;
                        items: {
                            $ref: string;
                        };
                        type: string;
                        uniqueItems: boolean;
                    };
                };
                required: string[];
                type: string;
            }
            • description: string
            • properties: {
                  groups: {
                      $ref: string;
                      description: string;
                  };
                  items: {
                      description: string;
                      items: {
                          $ref: string;
                      };
                      type: string;
                      uniqueItems: boolean;
                  };
              }
              • groups: {
                    $ref: string;
                    description: string;
                }
                • $ref: string
                • description: string
              • items: {
                    description: string;
                    items: {
                        $ref: string;
                    };
                    type: string;
                    uniqueItems: boolean;
                }
                • description: string
                • items: {
                      $ref: string;
                  }
                  • $ref: string
                • type: string
                • uniqueItems: boolean
            • required: string[]
            • type: string
          • localizeKey: {
                description: string;
                pattern: string;
                type: string;
            }
            • description: string
            • pattern: string
            • type: string
          • menuGroups: {
                additionalProperties: boolean;
                description: string;
                patternProperties: {
                    ^[\w\-]+\.[\w\-]+$: {
                        description: string;
                        oneOf: ({
                            additionalProperties: boolean;
                            properties: {
                                column: {
                                    $ref: string;
                                    description: string;
                                };
                                isExtensible: {
                                    description: string;
                                    type: string;
                                };
                                menuItem?: undefined;
                                order: {
                                    description: string;
                                    type: string;
                                };
                            };
                            required: string[];
                        } | {
                            additionalProperties: boolean;
                            properties: {
                                column?: undefined;
                                isExtensible: {
                                    description: string;
                                    type: string;
                                };
                                menuItem: {
                                    $ref: string;
                                    description: string;
                                };
                                order: {
                                    description: string;
                                    type: string;
                                };
                            };
                            required: string[];
                        })[];
                        type: string;
                    };
                };
                type: string;
            }
            • additionalProperties: boolean
            • description: string
            • patternProperties: {
                  ^[\w\-]+\.[\w\-]+$: {
                      description: string;
                      oneOf: ({
                          additionalProperties: boolean;
                          properties: {
                              column: {
                                  $ref: string;
                                  description: string;
                              };
                              isExtensible: {
                                  description: string;
                                  type: string;
                              };
                              menuItem?: undefined;
                              order: {
                                  description: string;
                                  type: string;
                              };
                          };
                          required: string[];
                      } | {
                          additionalProperties: boolean;
                          properties: {
                              column?: undefined;
                              isExtensible: {
                                  description: string;
                                  type: string;
                              };
                              menuItem: {
                                  $ref: string;
                                  description: string;
                              };
                              order: {
                                  description: string;
                                  type: string;
                              };
                          };
                          required: string[];
                      })[];
                      type: string;
                  };
              }
              • ^[\w\-]+\.[\w\-]+$: {
                    description: string;
                    oneOf: ({
                        additionalProperties: boolean;
                        properties: {
                            column: {
                                $ref: string;
                                description: string;
                            };
                            isExtensible: {
                                description: string;
                                type: string;
                            };
                            menuItem?: undefined;
                            order: {
                                description: string;
                                type: string;
                            };
                        };
                        required: string[];
                    } | {
                        additionalProperties: boolean;
                        properties: {
                            column?: undefined;
                            isExtensible: {
                                description: string;
                                type: string;
                            };
                            menuItem: {
                                $ref: string;
                                description: string;
                            };
                            order: {
                                description: string;
                                type: string;
                            };
                        };
                        required: string[];
                    })[];
                    type: string;
                }
                • description: string
                • oneOf: ({
                      additionalProperties: boolean;
                      properties: {
                          column: {
                              $ref: string;
                              description: string;
                          };
                          isExtensible: {
                              description: string;
                              type: string;
                          };
                          menuItem?: undefined;
                          order: {
                              description: string;
                              type: string;
                          };
                      };
                      required: string[];
                  } | {
                      additionalProperties: boolean;
                      properties: {
                          column?: undefined;
                          isExtensible: {
                              description: string;
                              type: string;
                          };
                          menuItem: {
                              $ref: string;
                              description: string;
                          };
                          order: {
                              description: string;
                              type: string;
                          };
                      };
                      required: string[];
                  })[]
                • type: string
            • type: string
          • menuItem: {
                description: string;
                oneOf: ({
                    properties: {
                        command?: undefined;
                        iconPathAfter?: undefined;
                        iconPathBefore?: undefined;
                        id: {
                            $ref: string;
                            description: string;
                        };
                    };
                    required: string[];
                } | {
                    properties: {
                        command: {
                            $ref: string;
                            description: string;
                        };
                        iconPathAfter: {
                            description: string;
                            type: string;
                        };
                        iconPathBefore: {
                            description: string;
                            type: string;
                        };
                        id?: undefined;
                    };
                    required: string[];
                })[];
                properties: {
                    group: {
                        $ref: string;
                        description: string;
                    };
                    label: {
                        $ref: string;
                        description: string;
                    };
                    localizeNotes: {
                        description: string;
                        type: string;
                    };
                    order: {
                        description: string;
                        type: string;
                    };
                    searchTerms: {
                        $ref: string;
                        description: string;
                    };
                    tooltip: {
                        $ref: string;
                        description: string;
                    };
                };
                required: string[];
                type: string;
                unevaluatedProperties: boolean;
            }
            • description: string
            • oneOf: ({
                  properties: {
                      command?: undefined;
                      iconPathAfter?: undefined;
                      iconPathBefore?: undefined;
                      id: {
                          $ref: string;
                          description: string;
                      };
                  };
                  required: string[];
              } | {
                  properties: {
                      command: {
                          $ref: string;
                          description: string;
                      };
                      iconPathAfter: {
                          description: string;
                          type: string;
                      };
                      iconPathBefore: {
                          description: string;
                          type: string;
                      };
                      id?: undefined;
                  };
                  required: string[];
              })[]
            • properties: {
                  group: {
                      $ref: string;
                      description: string;
                  };
                  label: {
                      $ref: string;
                      description: string;
                  };
                  localizeNotes: {
                      description: string;
                      type: string;
                  };
                  order: {
                      description: string;
                      type: string;
                  };
                  searchTerms: {
                      $ref: string;
                      description: string;
                  };
                  tooltip: {
                      $ref: string;
                      description: string;
                  };
              }
              • group: {
                    $ref: string;
                    description: string;
                }
                • $ref: string
                • description: string
              • label: {
                    $ref: string;
                    description: string;
                }
                • $ref: string
                • description: string
              • localizeNotes: {
                    description: string;
                    type: string;
                }
                • description: string
                • type: string
              • order: {
                    description: string;
                    type: string;
                }
                • description: string
                • type: string
              • searchTerms: {
                    $ref: string;
                    description: string;
                }
                • $ref: string
                • description: string
              • tooltip: {
                    $ref: string;
                    description: string;
                }
                • $ref: string
                • description: string
            • required: string[]
            • type: string
            • unevaluatedProperties: boolean
          • menusForOneWebView: {
                additionalProperties: boolean;
                description: string;
                properties: {
                    contextMenu: {
                        $ref: string;
                        description: string;
                    };
                    includeDefaults: {
                        description: string;
                        type: string;
                    };
                    topMenu: {
                        $ref: string;
                        description: string;
                    };
                };
                type: string;
            }
            • additionalProperties: boolean
            • description: string
            • properties: {
                  contextMenu: {
                      $ref: string;
                      description: string;
                  };
                  includeDefaults: {
                      description: string;
                      type: string;
                  };
                  topMenu: {
                      $ref: string;
                      description: string;
                  };
              }
              • contextMenu: {
                    $ref: string;
                    description: string;
                }
                • $ref: string
                • description: string
              • includeDefaults: {
                    description: string;
                    type: string;
                }
                • description: string
                • type: string
              • topMenu: {
                    $ref: string;
                    description: string;
                }
                • $ref: string
                • description: string
            • type: string
          • multiColumnMenu: {
                allOf: ({
                    $ref: string;
                    properties?: undefined;
                    required?: undefined;
                } | {
                    $ref?: undefined;
                    properties: {
                        columns: {
                            $ref: string;
                            description: string;
                        };
                    };
                    required: string[];
                })[];
                description: string;
                type: string;
                unevaluatedProperties: boolean;
            }
            • allOf: ({
                  $ref: string;
                  properties?: undefined;
                  required?: undefined;
              } | {
                  $ref?: undefined;
                  properties: {
                      columns: {
                          $ref: string;
                          description: string;
                      };
                  };
                  required: string[];
              })[]
            • description: string
            • type: string
            • unevaluatedProperties: boolean
          • referencedItem: {
                description: string;
                pattern: string;
                type: string;
            }
            • description: string
            • pattern: string
            • type: string
          • singleColumnMenu: {
                allOf: {
                    $ref: string;
                }[];
                description: string;
                type: string;
                unevaluatedProperties: boolean;
            }
            • allOf: {
                  $ref: string;
              }[]
            • description: string
            • type: string
            • unevaluatedProperties: boolean
        • additionalProperties: boolean
        • properties: {
              defaultWebViewContextMenu: {
                  $ref: string;
                  description: string;
              };
              defaultWebViewTopMenu: {
                  $ref: string;
                  description: string;
              };
              mainMenu: {
                  $ref: string;
                  description: string;
              };
              webViewMenus: {
                  additionalProperties: boolean;
                  description: string;
                  patternProperties: {
                      ^[\w\-]+\.[\w\-]+$: {
                          $ref: string;
                      };
                  };
                  type: string;
              };
          }
          • defaultWebViewContextMenu: {
                $ref: string;
                description: string;
            }
            • $ref: string
            • description: string
          • defaultWebViewTopMenu: {
                $ref: string;
                description: string;
            }
            • $ref: string
            • description: string
          • mainMenu: {
                $ref: string;
                description: string;
            }
            • $ref: string
            • description: string
          • webViewMenus: {
                additionalProperties: boolean;
                description: string;
                patternProperties: {
                    ^[\w\-]+\.[\w\-]+$: {
                        $ref: string;
                    };
                };
                type: string;
            }
            • additionalProperties: boolean
            • description: string
            • patternProperties: {
                  ^[\w\-]+\.[\w\-]+$: {
                      $ref: string;
                  };
              }
              • ^[\w\-]+\.[\w\-]+$: {
                    $ref: string;
                }
                • $ref: string
            • type: string
        • required: string[]
        • title: string
        • type: string

        Settings

        Member Visibility

        Theme

        \ No newline at end of file +

        Type declaration

        Settings

        Member Visibility

        Theme

        \ No newline at end of file diff --git a/platform-bible-utils/variables/projectSettingsDocumentSchema.html b/platform-bible-utils/variables/projectSettingsDocumentSchema.html index c9ddad3a8d..ad0bb1acb1 100644 --- a/platform-bible-utils/variables/projectSettingsDocumentSchema.html +++ b/platform-bible-utils/variables/projectSettingsDocumentSchema.html @@ -1,2 +1,2 @@ projectSettingsDocumentSchema | platform-bible-utils

        Variable projectSettingsDocumentSchemaConst

        projectSettingsDocumentSchema: {
            $defs: {
                extensionControlledProjectSetting: {
                    allOf: {
                        $ref: string;
                    }[];
                    description: string;
                };
                extensionControlledSetting: {
                    allOf: {
                        $ref: string;
                    }[];
                    description: string;
                };
                extensionControlledState: {
                    allOf: {
                        $ref: string;
                    }[];
                    description: string;
                };
                id: {
                    description: string;
                    pattern: string;
                    tsType: string;
                    type: string;
                };
                localizeKey: {
                    description: string;
                    pattern: string;
                    tsType: string;
                    type: string;
                };
                modifierExtensionControlled: {
                    description: string;
                    not: {
                        anyOf: {
                            required: string[];
                            type: string;
                        }[];
                    };
                };
                modifierProject: {
                    description: string;
                    properties: {
                        excludeProjectTypes: {
                            anyOf: ({
                                items?: undefined;
                                type: string;
                            } | {
                                items: {
                                    type: string;
                                };
                                type: string;
                            })[];
                            description: string;
                        };
                        includeProjectTypes: {
                            anyOf: ({
                                items?: undefined;
                                type: string;
                            } | {
                                items: {
                                    type: string;
                                };
                                type: string;
                            })[];
                            description: string;
                        };
                    };
                    type: string;
                };
                projectSetting: {
                    anyOf: {
                        $ref: string;
                    }[];
                    description: string;
                };
                projectSettingBase: {
                    allOf: {
                        $ref: string;
                    }[];
                    description: string;
                };
                projectSettingProperties: {
                    additionalProperties: boolean;
                    description: string;
                    patternProperties: {
                        ^[\w\-]+\.[\w\-]+$: {
                            $ref: string;
                        };
                    };
                    type: string;
                };
                projectSettingsContribution: {
                    anyOf: ({
                        $ref: string;
                        items?: undefined;
                        type?: undefined;
                    } | {
                        $ref?: undefined;
                        items: {
                            $ref: string;
                        };
                        type: string;
                    })[];
                    description: string;
                };
                projectSettingsGroup: {
                    description: string;
                    properties: {
                        description: {
                            $ref: string;
                            description: string;
                        };
                        label: {
                            $ref: string;
                            description: string;
                        };
                        properties: {
                            $ref: string;
                        };
                    };
                    required: string[];
                    type: string;
                };
                projectStateContribution: {
                    $ref: string;
                    description: string;
                };
                setting: {
                    anyOf: {
                        $ref: string;
                    }[];
                    description: string;
                };
                settingBase: {
                    allOf: ({
                        $ref: string;
                        properties?: undefined;
                        required?: undefined;
                        type?: undefined;
                    } | {
                        $ref?: undefined;
                        properties: {
                            description: {
                                $ref: string;
                                description: string;
                            };
                            label: {
                                $ref: string;
                                description: string;
                            };
                        };
                        required: string[];
                        type: string;
                    })[];
                    description: string;
                };
                settingProperties: {
                    additionalProperties: boolean;
                    description: string;
                    patternProperties: {
                        ^[\w-]+\.[\w-]+$: {
                            $ref: string;
                        };
                    };
                    type: string;
                };
                settingsContribution: {
                    anyOf: ({
                        $ref: string;
                        items?: undefined;
                        type?: undefined;
                    } | {
                        $ref?: undefined;
                        items: {
                            $ref: string;
                        };
                        type: string;
                    })[];
                    description: string;
                };
                settingsGroup: {
                    description: string;
                    properties: {
                        description: {
                            $ref: string;
                            description: string;
                        };
                        label: {
                            $ref: string;
                            description: string;
                        };
                        properties: {
                            $ref: string;
                        };
                    };
                    required: string[];
                    type: string;
                };
                stateBase: {
                    description: string;
                    properties: {
                        default: {
                            description: string;
                            type: string;
                        };
                        derivesFrom: {
                            $ref: string;
                            description: string;
                        };
                    };
                    required: string[];
                    type: string;
                };
                userState: {
                    anyOf: {
                        $ref: string;
                    }[];
                    description: string;
                };
                userStateContribution: {
                    $ref: string;
                    description: string;
                };
                userStateProperties: {
                    additionalProperties: boolean;
                    description: string;
                    patternProperties: {
                        ^[\w\-]+\.[\w\-]+$: {
                            $ref: string;
                        };
                    };
                    type: string;
                };
            };
            $schema: string;
            anyOf: ({
                $ref: string;
                items?: undefined;
                type?: undefined;
            } | {
                $ref?: undefined;
                items: {
                    $ref: string;
                };
                type: string;
            })[];
            description: string;
            title: string;
        } = ...

        JSON schema object that aligns with the ProjectSettingsContribution type

        -

        Type declaration

        • $defs: {
              extensionControlledProjectSetting: {
                  allOf: {
                      $ref: string;
                  }[];
                  description: string;
              };
              extensionControlledSetting: {
                  allOf: {
                      $ref: string;
                  }[];
                  description: string;
              };
              extensionControlledState: {
                  allOf: {
                      $ref: string;
                  }[];
                  description: string;
              };
              id: {
                  description: string;
                  pattern: string;
                  tsType: string;
                  type: string;
              };
              localizeKey: {
                  description: string;
                  pattern: string;
                  tsType: string;
                  type: string;
              };
              modifierExtensionControlled: {
                  description: string;
                  not: {
                      anyOf: {
                          required: string[];
                          type: string;
                      }[];
                  };
              };
              modifierProject: {
                  description: string;
                  properties: {
                      excludeProjectTypes: {
                          anyOf: ({
                              items?: undefined;
                              type: string;
                          } | {
                              items: {
                                  type: string;
                              };
                              type: string;
                          })[];
                          description: string;
                      };
                      includeProjectTypes: {
                          anyOf: ({
                              items?: undefined;
                              type: string;
                          } | {
                              items: {
                                  type: string;
                              };
                              type: string;
                          })[];
                          description: string;
                      };
                  };
                  type: string;
              };
              projectSetting: {
                  anyOf: {
                      $ref: string;
                  }[];
                  description: string;
              };
              projectSettingBase: {
                  allOf: {
                      $ref: string;
                  }[];
                  description: string;
              };
              projectSettingProperties: {
                  additionalProperties: boolean;
                  description: string;
                  patternProperties: {
                      ^[\w\-]+\.[\w\-]+$: {
                          $ref: string;
                      };
                  };
                  type: string;
              };
              projectSettingsContribution: {
                  anyOf: ({
                      $ref: string;
                      items?: undefined;
                      type?: undefined;
                  } | {
                      $ref?: undefined;
                      items: {
                          $ref: string;
                      };
                      type: string;
                  })[];
                  description: string;
              };
              projectSettingsGroup: {
                  description: string;
                  properties: {
                      description: {
                          $ref: string;
                          description: string;
                      };
                      label: {
                          $ref: string;
                          description: string;
                      };
                      properties: {
                          $ref: string;
                      };
                  };
                  required: string[];
                  type: string;
              };
              projectStateContribution: {
                  $ref: string;
                  description: string;
              };
              setting: {
                  anyOf: {
                      $ref: string;
                  }[];
                  description: string;
              };
              settingBase: {
                  allOf: ({
                      $ref: string;
                      properties?: undefined;
                      required?: undefined;
                      type?: undefined;
                  } | {
                      $ref?: undefined;
                      properties: {
                          description: {
                              $ref: string;
                              description: string;
                          };
                          label: {
                              $ref: string;
                              description: string;
                          };
                      };
                      required: string[];
                      type: string;
                  })[];
                  description: string;
              };
              settingProperties: {
                  additionalProperties: boolean;
                  description: string;
                  patternProperties: {
                      ^[\w-]+\.[\w-]+$: {
                          $ref: string;
                      };
                  };
                  type: string;
              };
              settingsContribution: {
                  anyOf: ({
                      $ref: string;
                      items?: undefined;
                      type?: undefined;
                  } | {
                      $ref?: undefined;
                      items: {
                          $ref: string;
                      };
                      type: string;
                  })[];
                  description: string;
              };
              settingsGroup: {
                  description: string;
                  properties: {
                      description: {
                          $ref: string;
                          description: string;
                      };
                      label: {
                          $ref: string;
                          description: string;
                      };
                      properties: {
                          $ref: string;
                      };
                  };
                  required: string[];
                  type: string;
              };
              stateBase: {
                  description: string;
                  properties: {
                      default: {
                          description: string;
                          type: string;
                      };
                      derivesFrom: {
                          $ref: string;
                          description: string;
                      };
                  };
                  required: string[];
                  type: string;
              };
              userState: {
                  anyOf: {
                      $ref: string;
                  }[];
                  description: string;
              };
              userStateContribution: {
                  $ref: string;
                  description: string;
              };
              userStateProperties: {
                  additionalProperties: boolean;
                  description: string;
                  patternProperties: {
                      ^[\w\-]+\.[\w\-]+$: {
                          $ref: string;
                      };
                  };
                  type: string;
              };
          }
          • extensionControlledProjectSetting: {
                allOf: {
                    $ref: string;
                }[];
                description: string;
            }
            • allOf: {
                  $ref: string;
              }[]
            • description: string
          • extensionControlledSetting: {
                allOf: {
                    $ref: string;
                }[];
                description: string;
            }
            • allOf: {
                  $ref: string;
              }[]
            • description: string
          • extensionControlledState: {
                allOf: {
                    $ref: string;
                }[];
                description: string;
            }
            • allOf: {
                  $ref: string;
              }[]
            • description: string
          • id: {
                description: string;
                pattern: string;
                tsType: string;
                type: string;
            }
            • description: string
            • pattern: string
            • tsType: string
            • type: string
          • localizeKey: {
                description: string;
                pattern: string;
                tsType: string;
                type: string;
            }
            • description: string
            • pattern: string
            • tsType: string
            • type: string
          • modifierExtensionControlled: {
                description: string;
                not: {
                    anyOf: {
                        required: string[];
                        type: string;
                    }[];
                };
            }
            • description: string
            • not: {
                  anyOf: {
                      required: string[];
                      type: string;
                  }[];
              }
              • anyOf: {
                    required: string[];
                    type: string;
                }[]
          • modifierProject: {
                description: string;
                properties: {
                    excludeProjectTypes: {
                        anyOf: ({
                            items?: undefined;
                            type: string;
                        } | {
                            items: {
                                type: string;
                            };
                            type: string;
                        })[];
                        description: string;
                    };
                    includeProjectTypes: {
                        anyOf: ({
                            items?: undefined;
                            type: string;
                        } | {
                            items: {
                                type: string;
                            };
                            type: string;
                        })[];
                        description: string;
                    };
                };
                type: string;
            }
            • description: string
            • properties: {
                  excludeProjectTypes: {
                      anyOf: ({
                          items?: undefined;
                          type: string;
                      } | {
                          items: {
                              type: string;
                          };
                          type: string;
                      })[];
                      description: string;
                  };
                  includeProjectTypes: {
                      anyOf: ({
                          items?: undefined;
                          type: string;
                      } | {
                          items: {
                              type: string;
                          };
                          type: string;
                      })[];
                      description: string;
                  };
              }
              • excludeProjectTypes: {
                    anyOf: ({
                        items?: undefined;
                        type: string;
                    } | {
                        items: {
                            type: string;
                        };
                        type: string;
                    })[];
                    description: string;
                }
                • anyOf: ({
                      items?: undefined;
                      type: string;
                  } | {
                      items: {
                          type: string;
                      };
                      type: string;
                  })[]
                • description: string
              • includeProjectTypes: {
                    anyOf: ({
                        items?: undefined;
                        type: string;
                    } | {
                        items: {
                            type: string;
                        };
                        type: string;
                    })[];
                    description: string;
                }
                • anyOf: ({
                      items?: undefined;
                      type: string;
                  } | {
                      items: {
                          type: string;
                      };
                      type: string;
                  })[]
                • description: string
            • type: string
          • projectSetting: {
                anyOf: {
                    $ref: string;
                }[];
                description: string;
            }
            • anyOf: {
                  $ref: string;
              }[]
            • description: string
          • projectSettingBase: {
                allOf: {
                    $ref: string;
                }[];
                description: string;
            }
            • allOf: {
                  $ref: string;
              }[]
            • description: string
          • projectSettingProperties: {
                additionalProperties: boolean;
                description: string;
                patternProperties: {
                    ^[\w\-]+\.[\w\-]+$: {
                        $ref: string;
                    };
                };
                type: string;
            }
            • additionalProperties: boolean
            • description: string
            • patternProperties: {
                  ^[\w\-]+\.[\w\-]+$: {
                      $ref: string;
                  };
              }
              • ^[\w\-]+\.[\w\-]+$: {
                    $ref: string;
                }
                • $ref: string
            • type: string
          • projectSettingsContribution: {
                anyOf: ({
                    $ref: string;
                    items?: undefined;
                    type?: undefined;
                } | {
                    $ref?: undefined;
                    items: {
                        $ref: string;
                    };
                    type: string;
                })[];
                description: string;
            }
            • anyOf: ({
                  $ref: string;
                  items?: undefined;
                  type?: undefined;
              } | {
                  $ref?: undefined;
                  items: {
                      $ref: string;
                  };
                  type: string;
              })[]
            • description: string
          • projectSettingsGroup: {
                description: string;
                properties: {
                    description: {
                        $ref: string;
                        description: string;
                    };
                    label: {
                        $ref: string;
                        description: string;
                    };
                    properties: {
                        $ref: string;
                    };
                };
                required: string[];
                type: string;
            }
            • description: string
            • properties: {
                  description: {
                      $ref: string;
                      description: string;
                  };
                  label: {
                      $ref: string;
                      description: string;
                  };
                  properties: {
                      $ref: string;
                  };
              }
              • description: {
                    $ref: string;
                    description: string;
                }
                • $ref: string
                • description: string
              • label: {
                    $ref: string;
                    description: string;
                }
                • $ref: string
                • description: string
              • properties: {
                    $ref: string;
                }
                • $ref: string
            • required: string[]
            • type: string
          • projectStateContribution: {
                $ref: string;
                description: string;
            }
            • $ref: string
            • description: string
          • setting: {
                anyOf: {
                    $ref: string;
                }[];
                description: string;
            }
            • anyOf: {
                  $ref: string;
              }[]
            • description: string
          • settingBase: {
                allOf: ({
                    $ref: string;
                    properties?: undefined;
                    required?: undefined;
                    type?: undefined;
                } | {
                    $ref?: undefined;
                    properties: {
                        description: {
                            $ref: string;
                            description: string;
                        };
                        label: {
                            $ref: string;
                            description: string;
                        };
                    };
                    required: string[];
                    type: string;
                })[];
                description: string;
            }
            • allOf: ({
                  $ref: string;
                  properties?: undefined;
                  required?: undefined;
                  type?: undefined;
              } | {
                  $ref?: undefined;
                  properties: {
                      description: {
                          $ref: string;
                          description: string;
                      };
                      label: {
                          $ref: string;
                          description: string;
                      };
                  };
                  required: string[];
                  type: string;
              })[]
            • description: string
          • settingProperties: {
                additionalProperties: boolean;
                description: string;
                patternProperties: {
                    ^[\w-]+\.[\w-]+$: {
                        $ref: string;
                    };
                };
                type: string;
            }
            • additionalProperties: boolean
            • description: string
            • patternProperties: {
                  ^[\w-]+\.[\w-]+$: {
                      $ref: string;
                  };
              }
              • ^[\w-]+\.[\w-]+$: {
                    $ref: string;
                }
                • $ref: string
            • type: string
          • settingsContribution: {
                anyOf: ({
                    $ref: string;
                    items?: undefined;
                    type?: undefined;
                } | {
                    $ref?: undefined;
                    items: {
                        $ref: string;
                    };
                    type: string;
                })[];
                description: string;
            }
            • anyOf: ({
                  $ref: string;
                  items?: undefined;
                  type?: undefined;
              } | {
                  $ref?: undefined;
                  items: {
                      $ref: string;
                  };
                  type: string;
              })[]
            • description: string
          • settingsGroup: {
                description: string;
                properties: {
                    description: {
                        $ref: string;
                        description: string;
                    };
                    label: {
                        $ref: string;
                        description: string;
                    };
                    properties: {
                        $ref: string;
                    };
                };
                required: string[];
                type: string;
            }
            • description: string
            • properties: {
                  description: {
                      $ref: string;
                      description: string;
                  };
                  label: {
                      $ref: string;
                      description: string;
                  };
                  properties: {
                      $ref: string;
                  };
              }
              • description: {
                    $ref: string;
                    description: string;
                }
                • $ref: string
                • description: string
              • label: {
                    $ref: string;
                    description: string;
                }
                • $ref: string
                • description: string
              • properties: {
                    $ref: string;
                }
                • $ref: string
            • required: string[]
            • type: string
          • stateBase: {
                description: string;
                properties: {
                    default: {
                        description: string;
                        type: string;
                    };
                    derivesFrom: {
                        $ref: string;
                        description: string;
                    };
                };
                required: string[];
                type: string;
            }
            • description: string
            • properties: {
                  default: {
                      description: string;
                      type: string;
                  };
                  derivesFrom: {
                      $ref: string;
                      description: string;
                  };
              }
              • default: {
                    description: string;
                    type: string;
                }
                • description: string
                • type: string
              • derivesFrom: {
                    $ref: string;
                    description: string;
                }
                • $ref: string
                • description: string
            • required: string[]
            • type: string
          • userState: {
                anyOf: {
                    $ref: string;
                }[];
                description: string;
            }
            • anyOf: {
                  $ref: string;
              }[]
            • description: string
          • userStateContribution: {
                $ref: string;
                description: string;
            }
            • $ref: string
            • description: string
          • userStateProperties: {
                additionalProperties: boolean;
                description: string;
                patternProperties: {
                    ^[\w\-]+\.[\w\-]+$: {
                        $ref: string;
                    };
                };
                type: string;
            }
            • additionalProperties: boolean
            • description: string
            • patternProperties: {
                  ^[\w\-]+\.[\w\-]+$: {
                      $ref: string;
                  };
              }
              • ^[\w\-]+\.[\w\-]+$: {
                    $ref: string;
                }
                • $ref: string
            • type: string
        • $schema: string
        • anyOf: ({
              $ref: string;
              items?: undefined;
              type?: undefined;
          } | {
              $ref?: undefined;
              items: {
                  $ref: string;
              };
              type: string;
          })[]
        • description: string
        • title: string

        Settings

        Member Visibility

        Theme

        \ No newline at end of file +

        Type declaration

        Settings

        Member Visibility

        Theme

        \ No newline at end of file diff --git a/platform-bible-utils/variables/settingsDocumentSchema.html b/platform-bible-utils/variables/settingsDocumentSchema.html index ac8d8569f9..bff89a373d 100644 --- a/platform-bible-utils/variables/settingsDocumentSchema.html +++ b/platform-bible-utils/variables/settingsDocumentSchema.html @@ -1,2 +1,2 @@ settingsDocumentSchema | platform-bible-utils

        Variable settingsDocumentSchemaConst

        settingsDocumentSchema: {
            $defs: {
                extensionControlledProjectSetting: {
                    allOf: {
                        $ref: string;
                    }[];
                    description: string;
                };
                extensionControlledSetting: {
                    allOf: {
                        $ref: string;
                    }[];
                    description: string;
                };
                extensionControlledState: {
                    allOf: {
                        $ref: string;
                    }[];
                    description: string;
                };
                id: {
                    description: string;
                    pattern: string;
                    tsType: string;
                    type: string;
                };
                localizeKey: {
                    description: string;
                    pattern: string;
                    tsType: string;
                    type: string;
                };
                modifierExtensionControlled: {
                    description: string;
                    not: {
                        anyOf: {
                            required: string[];
                            type: string;
                        }[];
                    };
                };
                modifierProject: {
                    description: string;
                    properties: {
                        excludeProjectTypes: {
                            anyOf: ({
                                items?: undefined;
                                type: string;
                            } | {
                                items: {
                                    type: string;
                                };
                                type: string;
                            })[];
                            description: string;
                        };
                        includeProjectTypes: {
                            anyOf: ({
                                items?: undefined;
                                type: string;
                            } | {
                                items: {
                                    type: string;
                                };
                                type: string;
                            })[];
                            description: string;
                        };
                    };
                    type: string;
                };
                projectSetting: {
                    anyOf: {
                        $ref: string;
                    }[];
                    description: string;
                };
                projectSettingBase: {
                    allOf: {
                        $ref: string;
                    }[];
                    description: string;
                };
                projectSettingProperties: {
                    additionalProperties: boolean;
                    description: string;
                    patternProperties: {
                        ^[\w\-]+\.[\w\-]+$: {
                            $ref: string;
                        };
                    };
                    type: string;
                };
                projectSettingsContribution: {
                    anyOf: ({
                        $ref: string;
                        items?: undefined;
                        type?: undefined;
                    } | {
                        $ref?: undefined;
                        items: {
                            $ref: string;
                        };
                        type: string;
                    })[];
                    description: string;
                };
                projectSettingsGroup: {
                    description: string;
                    properties: {
                        description: {
                            $ref: string;
                            description: string;
                        };
                        label: {
                            $ref: string;
                            description: string;
                        };
                        properties: {
                            $ref: string;
                        };
                    };
                    required: string[];
                    type: string;
                };
                projectStateContribution: {
                    $ref: string;
                    description: string;
                };
                setting: {
                    anyOf: {
                        $ref: string;
                    }[];
                    description: string;
                };
                settingBase: {
                    allOf: ({
                        $ref: string;
                        properties?: undefined;
                        required?: undefined;
                        type?: undefined;
                    } | {
                        $ref?: undefined;
                        properties: {
                            description: {
                                $ref: string;
                                description: string;
                            };
                            label: {
                                $ref: string;
                                description: string;
                            };
                        };
                        required: string[];
                        type: string;
                    })[];
                    description: string;
                };
                settingProperties: {
                    additionalProperties: boolean;
                    description: string;
                    patternProperties: {
                        ^[\w-]+\.[\w-]+$: {
                            $ref: string;
                        };
                    };
                    type: string;
                };
                settingsContribution: {
                    anyOf: ({
                        $ref: string;
                        items?: undefined;
                        type?: undefined;
                    } | {
                        $ref?: undefined;
                        items: {
                            $ref: string;
                        };
                        type: string;
                    })[];
                    description: string;
                };
                settingsGroup: {
                    description: string;
                    properties: {
                        description: {
                            $ref: string;
                            description: string;
                        };
                        label: {
                            $ref: string;
                            description: string;
                        };
                        properties: {
                            $ref: string;
                        };
                    };
                    required: string[];
                    type: string;
                };
                stateBase: {
                    description: string;
                    properties: {
                        default: {
                            description: string;
                            type: string;
                        };
                        derivesFrom: {
                            $ref: string;
                            description: string;
                        };
                    };
                    required: string[];
                    type: string;
                };
                userState: {
                    anyOf: {
                        $ref: string;
                    }[];
                    description: string;
                };
                userStateContribution: {
                    $ref: string;
                    description: string;
                };
                userStateProperties: {
                    additionalProperties: boolean;
                    description: string;
                    patternProperties: {
                        ^[\w\-]+\.[\w\-]+$: {
                            $ref: string;
                        };
                    };
                    type: string;
                };
            };
            $schema: string;
            anyOf: ({
                $ref: string;
                items?: undefined;
                type?: undefined;
            } | {
                $ref?: undefined;
                items: {
                    $ref: string;
                };
                type: string;
            })[];
            description: string;
            title: string;
        } = ...

        JSON schema object that aligns with the SettingsContribution type

        -

        Type declaration

        • $defs: {
              extensionControlledProjectSetting: {
                  allOf: {
                      $ref: string;
                  }[];
                  description: string;
              };
              extensionControlledSetting: {
                  allOf: {
                      $ref: string;
                  }[];
                  description: string;
              };
              extensionControlledState: {
                  allOf: {
                      $ref: string;
                  }[];
                  description: string;
              };
              id: {
                  description: string;
                  pattern: string;
                  tsType: string;
                  type: string;
              };
              localizeKey: {
                  description: string;
                  pattern: string;
                  tsType: string;
                  type: string;
              };
              modifierExtensionControlled: {
                  description: string;
                  not: {
                      anyOf: {
                          required: string[];
                          type: string;
                      }[];
                  };
              };
              modifierProject: {
                  description: string;
                  properties: {
                      excludeProjectTypes: {
                          anyOf: ({
                              items?: undefined;
                              type: string;
                          } | {
                              items: {
                                  type: string;
                              };
                              type: string;
                          })[];
                          description: string;
                      };
                      includeProjectTypes: {
                          anyOf: ({
                              items?: undefined;
                              type: string;
                          } | {
                              items: {
                                  type: string;
                              };
                              type: string;
                          })[];
                          description: string;
                      };
                  };
                  type: string;
              };
              projectSetting: {
                  anyOf: {
                      $ref: string;
                  }[];
                  description: string;
              };
              projectSettingBase: {
                  allOf: {
                      $ref: string;
                  }[];
                  description: string;
              };
              projectSettingProperties: {
                  additionalProperties: boolean;
                  description: string;
                  patternProperties: {
                      ^[\w\-]+\.[\w\-]+$: {
                          $ref: string;
                      };
                  };
                  type: string;
              };
              projectSettingsContribution: {
                  anyOf: ({
                      $ref: string;
                      items?: undefined;
                      type?: undefined;
                  } | {
                      $ref?: undefined;
                      items: {
                          $ref: string;
                      };
                      type: string;
                  })[];
                  description: string;
              };
              projectSettingsGroup: {
                  description: string;
                  properties: {
                      description: {
                          $ref: string;
                          description: string;
                      };
                      label: {
                          $ref: string;
                          description: string;
                      };
                      properties: {
                          $ref: string;
                      };
                  };
                  required: string[];
                  type: string;
              };
              projectStateContribution: {
                  $ref: string;
                  description: string;
              };
              setting: {
                  anyOf: {
                      $ref: string;
                  }[];
                  description: string;
              };
              settingBase: {
                  allOf: ({
                      $ref: string;
                      properties?: undefined;
                      required?: undefined;
                      type?: undefined;
                  } | {
                      $ref?: undefined;
                      properties: {
                          description: {
                              $ref: string;
                              description: string;
                          };
                          label: {
                              $ref: string;
                              description: string;
                          };
                      };
                      required: string[];
                      type: string;
                  })[];
                  description: string;
              };
              settingProperties: {
                  additionalProperties: boolean;
                  description: string;
                  patternProperties: {
                      ^[\w-]+\.[\w-]+$: {
                          $ref: string;
                      };
                  };
                  type: string;
              };
              settingsContribution: {
                  anyOf: ({
                      $ref: string;
                      items?: undefined;
                      type?: undefined;
                  } | {
                      $ref?: undefined;
                      items: {
                          $ref: string;
                      };
                      type: string;
                  })[];
                  description: string;
              };
              settingsGroup: {
                  description: string;
                  properties: {
                      description: {
                          $ref: string;
                          description: string;
                      };
                      label: {
                          $ref: string;
                          description: string;
                      };
                      properties: {
                          $ref: string;
                      };
                  };
                  required: string[];
                  type: string;
              };
              stateBase: {
                  description: string;
                  properties: {
                      default: {
                          description: string;
                          type: string;
                      };
                      derivesFrom: {
                          $ref: string;
                          description: string;
                      };
                  };
                  required: string[];
                  type: string;
              };
              userState: {
                  anyOf: {
                      $ref: string;
                  }[];
                  description: string;
              };
              userStateContribution: {
                  $ref: string;
                  description: string;
              };
              userStateProperties: {
                  additionalProperties: boolean;
                  description: string;
                  patternProperties: {
                      ^[\w\-]+\.[\w\-]+$: {
                          $ref: string;
                      };
                  };
                  type: string;
              };
          }
          • extensionControlledProjectSetting: {
                allOf: {
                    $ref: string;
                }[];
                description: string;
            }
            • allOf: {
                  $ref: string;
              }[]
            • description: string
          • extensionControlledSetting: {
                allOf: {
                    $ref: string;
                }[];
                description: string;
            }
            • allOf: {
                  $ref: string;
              }[]
            • description: string
          • extensionControlledState: {
                allOf: {
                    $ref: string;
                }[];
                description: string;
            }
            • allOf: {
                  $ref: string;
              }[]
            • description: string
          • id: {
                description: string;
                pattern: string;
                tsType: string;
                type: string;
            }
            • description: string
            • pattern: string
            • tsType: string
            • type: string
          • localizeKey: {
                description: string;
                pattern: string;
                tsType: string;
                type: string;
            }
            • description: string
            • pattern: string
            • tsType: string
            • type: string
          • modifierExtensionControlled: {
                description: string;
                not: {
                    anyOf: {
                        required: string[];
                        type: string;
                    }[];
                };
            }
            • description: string
            • not: {
                  anyOf: {
                      required: string[];
                      type: string;
                  }[];
              }
              • anyOf: {
                    required: string[];
                    type: string;
                }[]
          • modifierProject: {
                description: string;
                properties: {
                    excludeProjectTypes: {
                        anyOf: ({
                            items?: undefined;
                            type: string;
                        } | {
                            items: {
                                type: string;
                            };
                            type: string;
                        })[];
                        description: string;
                    };
                    includeProjectTypes: {
                        anyOf: ({
                            items?: undefined;
                            type: string;
                        } | {
                            items: {
                                type: string;
                            };
                            type: string;
                        })[];
                        description: string;
                    };
                };
                type: string;
            }
            • description: string
            • properties: {
                  excludeProjectTypes: {
                      anyOf: ({
                          items?: undefined;
                          type: string;
                      } | {
                          items: {
                              type: string;
                          };
                          type: string;
                      })[];
                      description: string;
                  };
                  includeProjectTypes: {
                      anyOf: ({
                          items?: undefined;
                          type: string;
                      } | {
                          items: {
                              type: string;
                          };
                          type: string;
                      })[];
                      description: string;
                  };
              }
              • excludeProjectTypes: {
                    anyOf: ({
                        items?: undefined;
                        type: string;
                    } | {
                        items: {
                            type: string;
                        };
                        type: string;
                    })[];
                    description: string;
                }
                • anyOf: ({
                      items?: undefined;
                      type: string;
                  } | {
                      items: {
                          type: string;
                      };
                      type: string;
                  })[]
                • description: string
              • includeProjectTypes: {
                    anyOf: ({
                        items?: undefined;
                        type: string;
                    } | {
                        items: {
                            type: string;
                        };
                        type: string;
                    })[];
                    description: string;
                }
                • anyOf: ({
                      items?: undefined;
                      type: string;
                  } | {
                      items: {
                          type: string;
                      };
                      type: string;
                  })[]
                • description: string
            • type: string
          • projectSetting: {
                anyOf: {
                    $ref: string;
                }[];
                description: string;
            }
            • anyOf: {
                  $ref: string;
              }[]
            • description: string
          • projectSettingBase: {
                allOf: {
                    $ref: string;
                }[];
                description: string;
            }
            • allOf: {
                  $ref: string;
              }[]
            • description: string
          • projectSettingProperties: {
                additionalProperties: boolean;
                description: string;
                patternProperties: {
                    ^[\w\-]+\.[\w\-]+$: {
                        $ref: string;
                    };
                };
                type: string;
            }
            • additionalProperties: boolean
            • description: string
            • patternProperties: {
                  ^[\w\-]+\.[\w\-]+$: {
                      $ref: string;
                  };
              }
              • ^[\w\-]+\.[\w\-]+$: {
                    $ref: string;
                }
                • $ref: string
            • type: string
          • projectSettingsContribution: {
                anyOf: ({
                    $ref: string;
                    items?: undefined;
                    type?: undefined;
                } | {
                    $ref?: undefined;
                    items: {
                        $ref: string;
                    };
                    type: string;
                })[];
                description: string;
            }
            • anyOf: ({
                  $ref: string;
                  items?: undefined;
                  type?: undefined;
              } | {
                  $ref?: undefined;
                  items: {
                      $ref: string;
                  };
                  type: string;
              })[]
            • description: string
          • projectSettingsGroup: {
                description: string;
                properties: {
                    description: {
                        $ref: string;
                        description: string;
                    };
                    label: {
                        $ref: string;
                        description: string;
                    };
                    properties: {
                        $ref: string;
                    };
                };
                required: string[];
                type: string;
            }
            • description: string
            • properties: {
                  description: {
                      $ref: string;
                      description: string;
                  };
                  label: {
                      $ref: string;
                      description: string;
                  };
                  properties: {
                      $ref: string;
                  };
              }
              • description: {
                    $ref: string;
                    description: string;
                }
                • $ref: string
                • description: string
              • label: {
                    $ref: string;
                    description: string;
                }
                • $ref: string
                • description: string
              • properties: {
                    $ref: string;
                }
                • $ref: string
            • required: string[]
            • type: string
          • projectStateContribution: {
                $ref: string;
                description: string;
            }
            • $ref: string
            • description: string
          • setting: {
                anyOf: {
                    $ref: string;
                }[];
                description: string;
            }
            • anyOf: {
                  $ref: string;
              }[]
            • description: string
          • settingBase: {
                allOf: ({
                    $ref: string;
                    properties?: undefined;
                    required?: undefined;
                    type?: undefined;
                } | {
                    $ref?: undefined;
                    properties: {
                        description: {
                            $ref: string;
                            description: string;
                        };
                        label: {
                            $ref: string;
                            description: string;
                        };
                    };
                    required: string[];
                    type: string;
                })[];
                description: string;
            }
            • allOf: ({
                  $ref: string;
                  properties?: undefined;
                  required?: undefined;
                  type?: undefined;
              } | {
                  $ref?: undefined;
                  properties: {
                      description: {
                          $ref: string;
                          description: string;
                      };
                      label: {
                          $ref: string;
                          description: string;
                      };
                  };
                  required: string[];
                  type: string;
              })[]
            • description: string
          • settingProperties: {
                additionalProperties: boolean;
                description: string;
                patternProperties: {
                    ^[\w-]+\.[\w-]+$: {
                        $ref: string;
                    };
                };
                type: string;
            }
            • additionalProperties: boolean
            • description: string
            • patternProperties: {
                  ^[\w-]+\.[\w-]+$: {
                      $ref: string;
                  };
              }
              • ^[\w-]+\.[\w-]+$: {
                    $ref: string;
                }
                • $ref: string
            • type: string
          • settingsContribution: {
                anyOf: ({
                    $ref: string;
                    items?: undefined;
                    type?: undefined;
                } | {
                    $ref?: undefined;
                    items: {
                        $ref: string;
                    };
                    type: string;
                })[];
                description: string;
            }
            • anyOf: ({
                  $ref: string;
                  items?: undefined;
                  type?: undefined;
              } | {
                  $ref?: undefined;
                  items: {
                      $ref: string;
                  };
                  type: string;
              })[]
            • description: string
          • settingsGroup: {
                description: string;
                properties: {
                    description: {
                        $ref: string;
                        description: string;
                    };
                    label: {
                        $ref: string;
                        description: string;
                    };
                    properties: {
                        $ref: string;
                    };
                };
                required: string[];
                type: string;
            }
            • description: string
            • properties: {
                  description: {
                      $ref: string;
                      description: string;
                  };
                  label: {
                      $ref: string;
                      description: string;
                  };
                  properties: {
                      $ref: string;
                  };
              }
              • description: {
                    $ref: string;
                    description: string;
                }
                • $ref: string
                • description: string
              • label: {
                    $ref: string;
                    description: string;
                }
                • $ref: string
                • description: string
              • properties: {
                    $ref: string;
                }
                • $ref: string
            • required: string[]
            • type: string
          • stateBase: {
                description: string;
                properties: {
                    default: {
                        description: string;
                        type: string;
                    };
                    derivesFrom: {
                        $ref: string;
                        description: string;
                    };
                };
                required: string[];
                type: string;
            }
            • description: string
            • properties: {
                  default: {
                      description: string;
                      type: string;
                  };
                  derivesFrom: {
                      $ref: string;
                      description: string;
                  };
              }
              • default: {
                    description: string;
                    type: string;
                }
                • description: string
                • type: string
              • derivesFrom: {
                    $ref: string;
                    description: string;
                }
                • $ref: string
                • description: string
            • required: string[]
            • type: string
          • userState: {
                anyOf: {
                    $ref: string;
                }[];
                description: string;
            }
            • anyOf: {
                  $ref: string;
              }[]
            • description: string
          • userStateContribution: {
                $ref: string;
                description: string;
            }
            • $ref: string
            • description: string
          • userStateProperties: {
                additionalProperties: boolean;
                description: string;
                patternProperties: {
                    ^[\w\-]+\.[\w\-]+$: {
                        $ref: string;
                    };
                };
                type: string;
            }
            • additionalProperties: boolean
            • description: string
            • patternProperties: {
                  ^[\w\-]+\.[\w\-]+$: {
                      $ref: string;
                  };
              }
              • ^[\w\-]+\.[\w\-]+$: {
                    $ref: string;
                }
                • $ref: string
            • type: string
        • $schema: string
        • anyOf: ({
              $ref: string;
              items?: undefined;
              type?: undefined;
          } | {
              $ref?: undefined;
              items: {
                  $ref: string;
              };
              type: string;
          })[]
        • description: string
        • title: string

        Settings

        Member Visibility

        Theme

        \ No newline at end of file +

        Type declaration

        Settings

        Member Visibility

        Theme

        \ No newline at end of file