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 03d8405104..d0dfc2c292 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,49 +26,49 @@ 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;
}>>)

Type declaration

Private Optional connectPromise

connectPromise?: any

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

connect

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

Type declaration

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)

Type declaration

    • (): void

    • Returns void

emitEventOnNetwork

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

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 +

connectorInfo

connectorInfo: Readonly<{
    clientId: number;
}>

Information about the connector. Populated by the server while connecting

+

Type declaration

  • clientId: number

disconnect

disconnect: (() => void)

Type declaration

    • (): void

    • Returns void

emitEventOnNetwork

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

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>)

Type declaration

    • (): Promise<void>

    • Returns Promise<void>

Private onMessage

onMessage: any

Receives and appropriately publishes server webSocket messages

+

notifyClientConnected

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

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

Generated using TypeDoc

\ 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

Generated using TypeDoc

\ No newline at end of file diff --git a/papi-dts/classes/_main_services_server_network_connector_service_.default.html b/papi-dts/classes/_main_services_server_network_connector_service_.default.html index e148380570..d632e24ff4 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,67 +35,67 @@ 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;
}>>)

Type declaration

Private Optional connectPromise

connectPromise?: any

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

connect

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

Type declaration

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)

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>)

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

connectorInfo

connectorInfo: Readonly<{
    clientId: number;
}>

Information about the connector. Populated by the server while connecting

+

Type declaration

  • clientId: number

disconnect

disconnect: (() => void)

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>)

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>)

Type declaration

    • (): Promise<void>

    • Returns Promise<void>

Private onClientConnect

onClientConnect: any

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

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>)

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

Generated using TypeDoc

\ 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

Generated using TypeDoc

\ No newline at end of file diff --git a/papi-dts/classes/_node_models_execution_token_model_.ExecutionToken.html b/papi-dts/classes/_node_models_execution_token_model_.ExecutionToken.html index 03923febb2..13ab1d9178 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

Generated using TypeDoc

\ 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

Generated using TypeDoc

\ No newline at end of file diff --git a/papi-dts/classes/_renderer_services_renderer_web_socket_service_.default.html b/papi-dts/classes/_renderer_services_renderer_web_socket_service_.default.html index 7c6d5c1aae..bfd3326961 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

Generated using TypeDoc

\ 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

Generated using TypeDoc

\ No newline at end of file diff --git a/papi-dts/classes/_renderer_services_renderer_xml_http_request_service_.default.html b/papi-dts/classes/_renderer_services_renderer_xml_http_request_service_.default.html index 4534b79333..b9ca6199a4 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

Generated using TypeDoc

\ 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

Generated using TypeDoc

\ No newline at end of file diff --git a/papi-dts/classes/_shared_models_papi_network_event_emitter_model_.default.html b/papi-dts/classes/_shared_models_papi_network_event_emitter_model_.default.html index 33cb69d178..aaf3aa7aee 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 @@ -22,22 +22,22 @@

Type Parameters

  • T

Parameters

  • networkSubscriber: PlatformEventHandler<T>

    Callback that accepts the event and emits it to other processes

  • networkDisposer: (() => void)

    Callback that unlinks this emitter from the network

      • (): void

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

        -

        Returns void

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

Properties

dispose

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.

+

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

Generated using TypeDoc

\ No newline at end of file +

Returns void

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

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

See

IDataProviderEngine for more information on extending this class.

-

Type Parameters

Constructors

constructor +

Type Parameters

Constructors

constructor

Properties

notifyUpdate -

Constructors

constructor

Properties

notifyUpdate

notifyUpdate: DataProviderEngineNotifyUpdate<TDataTypes>

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file +

Constructors

constructor

Properties

notifyUpdate

notifyUpdate: DataProviderEngineNotifyUpdate<TDataTypes>

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file diff --git a/papi-dts/enums/_node_services_node_file_system_service_.EntryType.html b/papi-dts/enums/_node_services_node_file_system_service_.EntryType.html index 493541fcb3..6df82b4acf 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

Generated using TypeDoc

\ No newline at end of file +

Enumeration Members

Directory

Directory: "directory"

File

File: "file"

Unknown

Unknown: "unknown"

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file diff --git a/papi-dts/enums/_shared_data_internal_connection_model_.ConnectionStatus.html b/papi-dts/enums/_shared_data_internal_connection_model_.ConnectionStatus.html index 925ca80feb..b628173c6d 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

Generated using TypeDoc

\ 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

Generated using TypeDoc

\ No newline at end of file diff --git a/papi-dts/enums/_shared_data_network_connector_model_.MessageType.html b/papi-dts/enums/_shared_data_network_connector_model_.MessageType.html index a24bb0761f..20abedd866 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

Generated using TypeDoc

\ 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

Generated using TypeDoc

\ No newline at end of file diff --git a/papi-dts/enums/_shared_global_this_model_.ProcessType.html b/papi-dts/enums/_shared_global_this_model_.ProcessType.html index 9a3c39599f..d42cb942c5 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

Generated using TypeDoc

\ 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

Generated using TypeDoc

\ No newline at end of file diff --git a/papi-dts/enums/_shared_models_web_view_model_.WebViewContentType.html b/papi-dts/enums/_shared_models_web_view_model_.WebViewContentType.html index 5529fe2a2b..e2bdf81bc5 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

Generated using TypeDoc

\ No newline at end of file +

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ 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 4565f4d240..ec75ff44a3 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

Generated using TypeDoc

\ No newline at end of file +

Enumeration Members

Args

Args: "args"

Complex

Complex: "complex"

Contents

Contents: "contents"

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file diff --git a/papi-dts/functions/_client_services_web_socket_factory_.createWebSocket.html b/papi-dts/functions/_client_services_web_socket_factory_.createWebSocket.html index 538ae31533..d2f268d1d1 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

Generated using TypeDoc

\ No newline at end of file +

Settings

Member Visibility

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/papi-dts/functions/_extension_host_services_extension_storage_service_.buildExtensionPathFromName.html b/papi-dts/functions/_extension_host_services_extension_storage_service_.buildExtensionPathFromName.html index f67c5460f5..7a8c2f9912 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

Generated using TypeDoc

\ No newline at end of file +

Parameters

Returns string

Settings

Member Visibility

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/papi-dts/functions/_extension_host_services_extension_storage_service_.setExtensionUris.html b/papi-dts/functions/_extension_host_services_extension_storage_service_.setExtensionUris.html index 5582a11020..1ec0fb6f65 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

Generated using TypeDoc

\ No newline at end of file +

Parameters

Returns void

Settings

Member Visibility

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/papi-dts/functions/_node_services_node_file_system_service_.copyFile.html b/papi-dts/functions/_node_services_node_file_system_service_.copyFile.html index 1f67c2db6a..04c579c17e 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

    Generated using TypeDoc

    \ No newline at end of file +

    Returns Promise<void>

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/papi-dts/functions/_node_services_node_file_system_service_.createDir.html b/papi-dts/functions/_node_services_node_file_system_service_.createDir.html index 9ecb2cf9c8..7dcddc3555 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

    Generated using TypeDoc

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/papi-dts/functions/_node_services_node_file_system_service_.deleteDir.html b/papi-dts/functions/_node_services_node_file_system_service_.deleteDir.html index b050db858b..6870057a8c 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

    Generated using TypeDoc

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/papi-dts/functions/_node_services_node_file_system_service_.deleteFile.html b/papi-dts/functions/_node_services_node_file_system_service_.deleteFile.html index 4b677613f1..c840d05976 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

    Generated using TypeDoc

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/papi-dts/functions/_node_services_node_file_system_service_.getStats.html b/papi-dts/functions/_node_services_node_file_system_service_.getStats.html index e6b7e3eafd..907def4a23 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

    Generated using TypeDoc

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/papi-dts/functions/_node_services_node_file_system_service_.readDir.html b/papi-dts/functions/_node_services_node_file_system_service_.readDir.html index 52b83a092b..55847be857 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

    Generated using TypeDoc

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/papi-dts/functions/_node_services_node_file_system_service_.readFileBinary.html b/papi-dts/functions/_node_services_node_file_system_service_.readFileBinary.html index 6d10e3eaf4..dba6afe5c4 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

    Generated using TypeDoc

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/papi-dts/functions/_node_services_node_file_system_service_.readFileText.html b/papi-dts/functions/_node_services_node_file_system_service_.readFileText.html index 6aa6655607..7a80db5d0a 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

    Generated using TypeDoc

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/papi-dts/functions/_node_services_node_file_system_service_.touch.html b/papi-dts/functions/_node_services_node_file_system_service_.touch.html index 03663ea948..794be6d39d 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

    Generated using TypeDoc

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/papi-dts/functions/_node_services_node_file_system_service_.writeFile.html b/papi-dts/functions/_node_services_node_file_system_service_.writeFile.html index e6f282e4b5..87847cedb0 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

    Generated using TypeDoc

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/papi-dts/functions/_node_utils_crypto_util_.createNonce.html b/papi-dts/functions/_node_utils_crypto_util_.createNonce.html index 234b1abf58..37014dd475 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

    Generated using TypeDoc

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/papi-dts/functions/_node_utils_crypto_util_.createUuid.html b/papi-dts/functions/_node_utils_crypto_util_.createUuid.html index df164f7381..079a9c0d83 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

    Generated using TypeDoc

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

    Function createUuid

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/papi-dts/functions/_node_utils_util_.getPathFromUri.html b/papi-dts/functions/_node_utils_util_.getPathFromUri.html index 4b710a973f..10a3f0afe2 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

    Generated using TypeDoc

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/papi-dts/functions/_node_utils_util_.joinUriPaths.html b/papi-dts/functions/_node_utils_util_.joinUriPaths.html index d597a39cca..15417c1e9b 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

    Generated using TypeDoc

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/papi-dts/functions/_node_utils_util_.resolveHtmlPath.html b/papi-dts/functions/_node_utils_util_.resolveHtmlPath.html index aa5e101d41..20fd2ea891 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

    Generated using TypeDoc

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

    Function resolveHtmlPath

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/papi-dts/functions/_renderer_components_dialogs_dialog_base_data_.hookUpDialogService.html b/papi-dts/functions/_renderer_components_dialogs_dialog_base_data_.hookUpDialogService.html index 4282113365..c766bd017b 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

    Generated using TypeDoc

    \ No newline at end of file +

    Returns void

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/papi-dts/functions/_renderer_hooks_hook_generators_create_use_data_hook_util_.default.html b/papi-dts/functions/_renderer_hooks_hook_generators_create_use_data_hook_util_.default.html index bfb65757a5..a826d00560 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

    Generated using TypeDoc

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/papi-dts/functions/_renderer_hooks_hook_generators_create_use_network_object_hook_util_.default.html b/papi-dts/functions/_renderer_hooks_hook_generators_create_use_network_object_hook_util_.default.html index 4252fd3b12..00e55b957c 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

    Generated using TypeDoc

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/papi-dts/functions/_renderer_hooks_papi_hooks_use_data_hook_.default.html b/papi-dts/functions/_renderer_hooks_papi_hooks_use_data_hook_.default.html index 610a61fc97..d22f6e948f 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

    Generated using TypeDoc

    \ No newline at end of file +

    Type Parameters

    Parameters

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

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/papi-dts/functions/_renderer_hooks_papi_hooks_use_data_provider_hook_.default.html b/papi-dts/functions/_renderer_hooks_papi_hooks_use_data_provider_hook_.default.html index 83a30fe3ee..7bbe052325 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

    Generated using TypeDoc

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/papi-dts/functions/_renderer_hooks_papi_hooks_use_data_provider_multi_hook_.default.html b/papi-dts/functions/_renderer_hooks_papi_hooks_use_data_provider_multi_hook_.default.html index 8f384b077e..f9e5ed127f 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

    Generated using TypeDoc

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/papi-dts/functions/_renderer_hooks_papi_hooks_use_dialog_callback_hook_.default.html b/papi-dts/functions/_renderer_hooks_papi_hooks_use_dialog_callback_hook_.default.html index 37ae150d07..ef70b14725 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

    Generated using TypeDoc

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/papi-dts/functions/_renderer_hooks_papi_hooks_use_project_data_hook_.default.html b/papi-dts/functions/_renderer_hooks_papi_hooks_use_project_data_hook_.default.html index b09acc5423..61cddf3851 100644 --- a/papi-dts/functions/_renderer_hooks_papi_hooks_use_project_data_hook_.default.html +++ b/papi-dts/functions/_renderer_hooks_papi_hooks_use_project_data_hook_.default.html @@ -27,4 +27,4 @@ data provider's subscribe<data_type> method as soon as possible and will not be updated again until projectDataProviderSource or selector changes.

    ＠returns [data, setData, isLoading]

    -

    Type Parameters

    Parameters

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

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Type Parameters

    Parameters

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

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/papi-dts/functions/_renderer_hooks_papi_hooks_use_project_data_provider_hook_.default.html b/papi-dts/functions/_renderer_hooks_papi_hooks_use_project_data_provider_hook_.default.html index 369fe24658..1556570fd2 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

    Generated using TypeDoc

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/papi-dts/functions/_renderer_hooks_papi_hooks_use_setting_hook_.default.html b/papi-dts/functions/_renderer_hooks_papi_hooks_use_setting_hook_.default.html index d1215a049d..17e4f4011d 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 @@ -20,4 +20,4 @@

    Throws

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

    -

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/papi-dts/functions/_renderer_services_renderer_web_socket_service_.blockWebSocketsToPapiNetwork.html b/papi-dts/functions/_renderer_services_renderer_web_socket_service_.blockWebSocketsToPapiNetwork.html index e6729182cd..755a49f268 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

    Generated using TypeDoc

    \ No newline at end of file +

    Returns void

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/papi-dts/functions/_shared_models_data_provider_model_.getDataProviderDataTypeFromFunctionName.html b/papi-dts/functions/_shared_models_data_provider_model_.getDataProviderDataTypeFromFunctionName.html index d9b05f39fb..aa37c4935b 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

    Generated using TypeDoc

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/papi-dts/functions/_shared_services_command_service_.addThree.html b/papi-dts/functions/_shared_services_command_service_.addThree.html index ac56ce8a46..a7a7047525 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

    Generated using TypeDoc

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

    Function addThree

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/papi-dts/functions/_shared_services_command_service_.createSendCommandFunction.html b/papi-dts/functions/_shared_services_command_service_.createSendCommandFunction.html index de04cfde10..95511370a8 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

    Generated using TypeDoc

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/papi-dts/functions/_shared_services_command_service_.initialize.html b/papi-dts/functions/_shared_services_command_service_.initialize.html index 1fdbfd094a..24fe271340 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

    Generated using TypeDoc

    \ No newline at end of file +

    Returns Promise<void>

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/papi-dts/functions/_shared_services_command_service_.registerCommand.html b/papi-dts/functions/_shared_services_command_service_.registerCommand.html index 2f416843a1..1250ee2cd8 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

    Generated using TypeDoc

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/papi-dts/functions/_shared_services_command_service_.sendCommand.html b/papi-dts/functions/_shared_services_command_service_.sendCommand.html index dace46cc8c..714dd61d67 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

    • sendCommand<CommandName>(commandName, ...args): Promise<Awaited<ReturnType<CommandHandlers[CommandName]>>>

    • Send a command to the backend.

      -

      Type Parameters

      • CommandName extends keyof CommandHandlers

      Parameters

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

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

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Type Parameters

    Parameters

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

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/papi-dts/functions/_shared_services_command_service_.squareAndConcat.html b/papi-dts/functions/_shared_services_command_service_.squareAndConcat.html index f67ec32d93..56c054e30d 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

    Generated using TypeDoc

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

    Function squareAndConcat

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/papi-dts/functions/_shared_services_connection_service_.connect.html b/papi-dts/functions/_shared_services_connection_service_.connect.html index 0b18fb9631..d1da604da5 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

    Generated using TypeDoc

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/papi-dts/functions/_shared_services_connection_service_.disconnect.html b/papi-dts/functions/_shared_services_connection_service_.disconnect.html index 0f747b8dc4..705136d9c1 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

    Generated using TypeDoc

    \ No newline at end of file +

    Returns void

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/papi-dts/functions/_shared_services_connection_service_.emitEventOnNetwork.html b/papi-dts/functions/_shared_services_connection_service_.emitEventOnNetwork.html index 91ba14dce8..a86f39bc6c 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

    Generated using TypeDoc

    \ No newline at end of file +

    Returns Promise<void>

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/papi-dts/functions/_shared_services_connection_service_.getClientId.html b/papi-dts/functions/_shared_services_connection_service_.getClientId.html index b1d8c8918e..2b64040b3d 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

    Generated using TypeDoc

    \ No newline at end of file +

    Returns number

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/papi-dts/functions/_shared_services_connection_service_.request.html b/papi-dts/functions/_shared_services_connection_service_.request.html index c36e424cfe..6e851332d6 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

    Generated using TypeDoc

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/papi-dts/functions/_shared_services_data_provider_service_.getByType.html b/papi-dts/functions/_shared_services_data_provider_service_.getByType.html index f766e545fb..b006d743eb 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

    Generated using TypeDoc

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/papi-dts/functions/_shared_services_data_provider_service_.registerEngineByType.html b/papi-dts/functions/_shared_services_data_provider_service_.registerEngineByType.html index bab52237a7..46decfe512 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

    Generated using TypeDoc

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/papi-dts/functions/_shared_services_logger_service_.formatLog.html b/papi-dts/functions/_shared_services_logger_service_.formatLog.html index 1ef31425dd..7fc32d5ffc 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

    Generated using TypeDoc

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/papi-dts/functions/_shared_services_network_connector_factory_.createNetworkConnector.html b/papi-dts/functions/_shared_services_network_connector_factory_.createNetworkConnector.html index 5304b13576..f0c4bcec7b 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

    Generated using TypeDoc

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/papi-dts/functions/_shared_services_network_object_service_.onDidCreateNetworkObject.html b/papi-dts/functions/_shared_services_network_object_service_.onDidCreateNetworkObject.html index 4137c52218..af6bef2a68 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

    Generated using TypeDoc

    \ No newline at end of file +

    Parameters

    Returns Unsubscriber

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/papi-dts/functions/_shared_services_network_object_service_.onDidDisposeNetworkObject.html b/papi-dts/functions/_shared_services_network_object_service_.onDidDisposeNetworkObject.html index e3379d5b1a..93967ec4b1 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

    Generated using TypeDoc

    \ No newline at end of file +

    Parameters

    Returns Unsubscriber

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/papi-dts/functions/_shared_services_network_object_service_.overrideDispose.html b/papi-dts/functions/_shared_services_network_object_service_.overrideDispose.html index 035c63de53..9ae14c56c9 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

    Generated using TypeDoc

    \ No newline at end of file +

    Parameters

    Returns void

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/papi-dts/functions/_shared_services_network_service_.createNetworkEventEmitter.html b/papi-dts/functions/_shared_services_network_service_.createNetworkEventEmitter.html index f1b5355375..5af124a2c0 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

    Generated using TypeDoc

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/papi-dts/functions/_shared_services_network_service_.createRequestFunction.html b/papi-dts/functions/_shared_services_network_service_.createRequestFunction.html index 6a23f3f4ae..46d65ab3e6 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

    Generated using TypeDoc

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/papi-dts/functions/_shared_services_network_service_.getNetworkEvent.html b/papi-dts/functions/_shared_services_network_service_.getNetworkEvent.html index d9372f8103..02e52608d7 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

    Generated using TypeDoc

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/papi-dts/functions/_shared_services_network_service_.initialize.html b/papi-dts/functions/_shared_services_network_service_.initialize.html index d0ec1b9393..40e3e726a0 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

    Generated using TypeDoc

    \ No newline at end of file +

    Returns Promise<void>

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/papi-dts/functions/_shared_services_network_service_.onDidClientConnect.html b/papi-dts/functions/_shared_services_network_service_.onDidClientConnect.html index 8aab7ee148..e06016c0d4 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

    Generated using TypeDoc

    \ No newline at end of file +

    Parameters

    Returns Unsubscriber

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/papi-dts/functions/_shared_services_network_service_.onDidClientDisconnect.html b/papi-dts/functions/_shared_services_network_service_.onDidClientDisconnect.html index 7ca68e920d..f84fe28544 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

    Generated using TypeDoc

    \ No newline at end of file +

    Parameters

    Returns Unsubscriber

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/papi-dts/functions/_shared_services_network_service_.registerRequestHandler.html b/papi-dts/functions/_shared_services_network_service_.registerRequestHandler.html index a07fee519e..8e9e0f6672 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

    Generated using TypeDoc

    \ 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

    Generated using TypeDoc

    \ No newline at end of file diff --git a/papi-dts/functions/_shared_services_network_service_.request.html b/papi-dts/functions/_shared_services_network_service_.request.html index 6a78a876a9..1485767d31 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

    Generated using TypeDoc

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/papi-dts/functions/_shared_services_network_service_.shutdown.html b/papi-dts/functions/_shared_services_network_service_.shutdown.html index 00f6d8ebed..5ef977508a 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

    Generated using TypeDoc

    \ No newline at end of file +

    Returns void

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/papi-dts/functions/_shared_services_project_data_provider_service_.get.html b/papi-dts/functions/_shared_services_project_data_provider_service_.get.html index b86b5712ac..c18c1d4fae 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

    Generated using TypeDoc

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/papi-dts/functions/_shared_services_project_data_provider_service_.registerProjectDataProviderEngineFactory.html b/papi-dts/functions/_shared_services_project_data_provider_service_.registerProjectDataProviderEngineFactory.html index 2d4f23a4bc..e846b9844e 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

    Generated using TypeDoc

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/papi-dts/functions/_shared_utils_internal_util_.getProcessType.html b/papi-dts/functions/_shared_utils_internal_util_.getProcessType.html index 3c0acecea2..f02ad12c50 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

    Generated using TypeDoc

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/papi-dts/functions/_shared_utils_internal_util_.isClient.html b/papi-dts/functions/_shared_utils_internal_util_.isClient.html index ee11b3128a..4372dd8bb2 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

    Generated using TypeDoc

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/papi-dts/functions/_shared_utils_internal_util_.isExtensionHost.html b/papi-dts/functions/_shared_utils_internal_util_.isExtensionHost.html index b10e939581..62541042a0 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

    Generated using TypeDoc

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/papi-dts/functions/_shared_utils_internal_util_.isRenderer.html b/papi-dts/functions/_shared_utils_internal_util_.isRenderer.html index f0e2ce4984..107bdbf3a9 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

    Generated using TypeDoc

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/papi-dts/functions/_shared_utils_internal_util_.isServer.html b/papi-dts/functions/_shared_utils_internal_util_.isServer.html index 93f8f07714..e845554819 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

    Generated using TypeDoc

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ 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 8a94e8284c..dcf3c3b1a3 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

    Generated using TypeDoc

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ 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 81e9550abc..8ac908787d 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

    Generated using TypeDoc

    \ No newline at end of file +

    Parameters

    Returns RequestType

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ 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 6845822f56..9f2299aeab 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

    Generated using TypeDoc

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/papi-dts/functions/_shared_utils_util_.newNonce.html b/papi-dts/functions/_shared_utils_util_.newNonce.html index db0e9e98c9..b7e99a1bbe 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

    Generated using TypeDoc

    \ No newline at end of file +

    Returns string

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ 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 4a288cd667..f035033858 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

    Generated using TypeDoc

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/papi-dts/functions/getWebViewDefinitionUpdatableProperties.html b/papi-dts/functions/getWebViewDefinitionUpdatableProperties.html index db3a51f21d..a117ac087c 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

    Generated using TypeDoc

    \ No newline at end of file +

    Returns undefined | WebViewDefinitionUpdatableProperties

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

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

    Function getWebViewDefinitionUpdatablePropertiesById

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

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

    Function getWebViewDefinitionUpdatablePropertiesById

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/papi-dts/functions/getWebViewState.html b/papi-dts/functions/getWebViewState.html index e232e5aebe..9c6470830f 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

    Generated using TypeDoc

    \ No newline at end of file +

    Type Parameters

    Parameters

    Returns T

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/papi-dts/functions/resetWebViewState.html b/papi-dts/functions/resetWebViewState.html index de2c54b8b3..a919d0affa 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

    Generated using TypeDoc

    \ No newline at end of file +

    Parameters

    Returns void

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/papi-dts/functions/setWebViewState.html b/papi-dts/functions/setWebViewState.html index 03ee812008..2665ff0b0c 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

    Generated using TypeDoc

    \ No newline at end of file +

    Type Parameters

    Parameters

    Returns void

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/papi-dts/functions/updateWebViewDefinition.html b/papi-dts/functions/updateWebViewDefinition.html index 936ffefea3..f9cdd9f91c 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

    Generated using TypeDoc

    \ No newline at end of file +

    Parameters

    Returns boolean

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/papi-dts/functions/updateWebViewDefinitionById.html b/papi-dts/functions/updateWebViewDefinitionById.html index 350e37310a..056823057c 100644 --- a/papi-dts/functions/updateWebViewDefinitionById.html +++ b/papi-dts/functions/updateWebViewDefinitionById.html @@ -1 +1 @@ -updateWebViewDefinitionById | papi-dts

    Function updateWebViewDefinitionById

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

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

    Function updateWebViewDefinitionById

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/papi-dts/functions/useWebViewState.html b/papi-dts/functions/useWebViewState.html index 85a4a97452..0822c53b92 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

    Generated using TypeDoc

    \ No newline at end of file +

    Type Parameters

    Parameters

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

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/papi-dts/interfaces/_extension_host_extension_types_extension_interface_.IExtension.html b/papi-dts/interfaces/_extension_host_extension_types_extension_interface_.IExtension.html index f8d23d8df5..f0939b2fa2 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>)

    Type declaration

      • (context): Promise<void>

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

        Parameters

        Returns Promise<void>

    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

    Generated using TypeDoc

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file diff --git a/papi-dts/interfaces/_extension_host_services_extension_storage_service_.ExtensionStorageService.html b/papi-dts/interfaces/_extension_host_services_extension_storage_service_.ExtensionStorageService.html index 6c057037cc..064d6002c3 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

    Generated using TypeDoc

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file diff --git a/papi-dts/interfaces/_papi_shared_types_.CommandHandlers.html b/papi-dts/interfaces/_papi_shared_types_.CommandHandlers.html index 5c25b8730a..49bcdc7a16 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

    Generated using TypeDoc

    \ 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

    Generated using TypeDoc

    \ No newline at end of file diff --git a/papi-dts/interfaces/_papi_shared_types_.DataProviders.html b/papi-dts/interfaces/_papi_shared_types_.DataProviders.html index 60f33481b7..c9218e6c9a 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

    Generated using TypeDoc

    \ 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

    Generated using TypeDoc

    \ 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 76d6ff7ff2..e134f85f38 100644 --- a/papi-dts/interfaces/_papi_shared_types_.ProjectDataProviders.html +++ b/papi-dts/interfaces/_papi_shared_types_.ProjectDataProviders.html @@ -10,6 +10,6 @@ MyExtensionProjectTypeName data provider types):

    Example

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

      export interface ProjectDataProviders {
        MyExtensionProjectTypeName: IDataProvider<MyProjectDataType>;
      }
    }
    -
    interface ProjectDataProviders {
        platform.notesOnly: "shared/models/data-provider.interface".default<MandatoryProjectDataType & {
            Notes: DataProviderDataType<string, undefined | string, string>;
        }>;
        platform.placeholder: "shared/models/data-provider.interface".default<PlaceholderDataTypes & MandatoryProjectDataType>;
    }

    Properties

    platform.notesOnly +
    interface ProjectDataProviders {
        platform.notesOnly: "shared/models/data-provider.interface".default<MandatoryProjectDataType & {
            Notes: DataProviderDataType<string, undefined | string, string>;
        }>;
        platform.placeholder: "shared/models/data-provider.interface".default<PlaceholderDataTypes & MandatoryProjectDataType>;
    }

    Properties

    platform.notesOnly platform.placeholder -

    Properties

    platform.notesOnly

    platform.notesOnly: "shared/models/data-provider.interface".default<MandatoryProjectDataType & {
        Notes: DataProviderDataType<string, undefined | string, string>;
    }>

    platform.placeholder

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

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file +

    Properties

    platform.notesOnly

    platform.notesOnly: "shared/models/data-provider.interface".default<MandatoryProjectDataType & {
        Notes: DataProviderDataType<string, undefined | string, string>;
    }>

    platform.placeholder

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

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file diff --git a/papi-dts/interfaces/_papi_shared_types_.SettingTypes.html b/papi-dts/interfaces/_papi_shared_types_.SettingTypes.html index 41b5065a55..e8b7837e10 100644 --- a/papi-dts/interfaces/_papi_shared_types_.SettingTypes.html +++ b/papi-dts/interfaces/_papi_shared_types_.SettingTypes.html @@ -1,3 +1,3 @@ -SettingTypes | papi-dts

    Interface SettingTypes

    interface SettingTypes {
        placeholder: undefined;
        platform.verseRef: ScriptureReference;
    }

    Properties

    placeholder +SettingTypes | papi-dts

    Interface SettingTypes

    interface SettingTypes {
        placeholder: undefined;
        platform.verseRef: ScriptureReference;
    }

    Properties

    placeholder platform.verseRef -

    Properties

    placeholder

    placeholder: undefined

    platform.verseRef

    platform.verseRef: ScriptureReference

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file +

    Properties

    placeholder

    placeholder: undefined

    platform.verseRef

    platform.verseRef: ScriptureReference

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file diff --git a/papi-dts/interfaces/_renderer_components_dialogs_dialog_definition_model_.DialogTypes.html b/papi-dts/interfaces/_renderer_components_dialogs_dialog_definition_model_.DialogTypes.html index 7b5ac63f5a..d3aea3583e 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<SelectProjectDialogOptions, string>;
    }

    Properties

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

    Properties

    platform.selectMultipleProjects platform.selectProject -

    Properties

    platform.selectMultipleProjects

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

    platform.selectProject

    platform.selectProject: DialogDataTypes<SelectProjectDialogOptions, string>

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file +

    Properties

    platform.selectMultipleProjects

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

    platform.selectProject

    platform.selectProject: DialogDataTypes<SelectProjectDialogOptions, string>

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file diff --git a/papi-dts/interfaces/_shared_models_docking_framework_model_.FloatLayout.html b/papi-dts/interfaces/_shared_models_docking_framework_model_.FloatLayout.html index 473d258bcb..513df6ad10 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

    Generated using TypeDoc

    \ 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

    Generated using TypeDoc

    \ No newline at end of file diff --git a/papi-dts/interfaces/_shared_models_docking_framework_model_.PanelLayout.html b/papi-dts/interfaces/_shared_models_docking_framework_model_.PanelLayout.html index eadd7d76d7..8512f51d4d 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

    Generated using TypeDoc

    \ 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

    Generated using TypeDoc

    \ No newline at end of file diff --git a/papi-dts/interfaces/_shared_models_docking_framework_model_.TabLayout.html b/papi-dts/interfaces/_shared_models_docking_framework_model_.TabLayout.html index a7d8773d8c..9e930f6b7a 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

    Generated using TypeDoc

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

    Properties

    type +

    Properties

    type

    type: "tab"

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file diff --git a/papi-dts/interfaces/_shared_models_project_data_provider_engine_model_.ProjectDataProviderEngineFactory.html b/papi-dts/interfaces/_shared_models_project_data_provider_engine_model_.ProjectDataProviderEngineFactory.html index f0868fffdd..f53049325a 100644 --- a/papi-dts/interfaces/_shared_models_project_data_provider_engine_model_.ProjectDataProviderEngineFactory.html +++ b/papi-dts/interfaces/_shared_models_project_data_provider_engine_model_.ProjectDataProviderEngineFactory.html @@ -1,2 +1,2 @@ -ProjectDataProviderEngineFactory | papi-dts

    Interface ProjectDataProviderEngineFactory<ProjectType>

    interface ProjectDataProviderEngineFactory {
        createProjectDataProviderEngine(projectId, projectStorageInterpreterId): ProjectDataProviderEngineTypes[ProjectType];
    }

    Type Parameters

    Methods

    createProjectDataProviderEngine -

    Methods

    createProjectDataProviderEngine

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

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

    Interface ProjectDataProviderEngineFactory<ProjectType>

    interface ProjectDataProviderEngineFactory {
        createProjectDataProviderEngine(projectId, projectStorageInterpreterId): ProjectDataProviderEngineTypes[ProjectType];
    }

    Type Parameters

    Methods

    createProjectDataProviderEngine +

    Methods

    createProjectDataProviderEngine

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file diff --git a/papi-dts/interfaces/_shared_models_web_view_provider_model_.DisposableWebViewProvider.html b/papi-dts/interfaces/_shared_models_web_view_provider_model_.DisposableWebViewProvider.html index 651e3a4a91..7cbd96d3b8 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

    Properties

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

    Hierarchy

    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

    Generated using TypeDoc

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

    • Returns Promise<undefined | WebViewDefinition>

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file diff --git a/papi-dts/interfaces/_shared_models_web_view_provider_model_.IWebViewProvider.html b/papi-dts/interfaces/_shared_models_web_view_provider_model_.IWebViewProvider.html index f5b710fa37..93da28d886 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

    Properties

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

    Hierarchy

    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

    Generated using TypeDoc

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

    • Returns Promise<undefined | WebViewDefinition>

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file diff --git a/papi-dts/interfaces/_shared_models_web_view_provider_model_.WebViewProvider.html b/papi-dts/interfaces/_shared_models_web_view_provider_model_.WebViewProvider.html index 059fe8c207..bf66c01bf9 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

    Properties

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

    Hierarchy

    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

    Generated using TypeDoc

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

    • Returns Promise<undefined | WebViewDefinition>

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file diff --git a/papi-dts/interfaces/_shared_services_data_provider_service_.DataProviderService.html b/papi-dts/interfaces/_shared_services_data_provider_service_.DataProviderService.html index b0cbcae97a..709d21d27a 100644 --- a/papi-dts/interfaces/_shared_services_data_provider_service_.DataProviderService.html +++ b/papi-dts/interfaces/_shared_services_data_provider_service_.DataProviderService.html @@ -1,9 +1,9 @@ -DataProviderService | papi-dts

    Interface DataProviderService

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

    Properties

    DataProviderEngine +DataProviderService | papi-dts

    Interface DataProviderService

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

    Properties

    DataProviderEngine decorators get hasKnown registerEngine -

    Properties

    DataProviderEngine

    DataProviderEngine: typeof "shared/services/data-provider.service".DataProviderEngine

    decorators

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

    Type declaration

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

        • Decorator function that marks a data provider engine set___ or get___ method to be ignored. +

    Properties

    DataProviderEngine

    DataProviderEngine: typeof "shared/services/data-provider.service".DataProviderEngine

    decorators

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

    Type declaration

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

        • Decorator function that marks a data provider engine set___ or get___ method to be ignored. papi will not layer over these methods or consider them to be data type methods

          Parameters

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

            The method to ignore

          Returns void

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

          class MyDataProviderEngine {
          ＠papi.dataProviders.decorators.ignore
          async getInternal() {}
          }
@@ -20,13 +20,13 @@ 
          Example: Call this function signature on an object's method:
        • member: keyof T

          The name of the method to ignore

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

          -

    Returns void

    get

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

    Type declaration

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

      • Get a data provider that has previously been set up

        +

    Returns void

    get

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

    Type declaration

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

      • Get a data provider that has previously been set up

        Type Parameters

        Parameters

        • providerName: DataProviderName

          Name of the desired data provider

        Returns Promise<DataProviders[DataProviderName] | undefined>

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

        -

    hasKnown

    hasKnown: ((providerName) => boolean)

    Type declaration

      • (providerName): boolean

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

    hasKnown

    hasKnown: ((providerName) => boolean)

    Type declaration

      • (providerName): boolean

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

        -

        Parameters

        • providerName: string

        Returns boolean

    registerEngine

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

    Type declaration

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

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

        Parameters

        • providerName: string

        Returns boolean

    registerEngine

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

    Type declaration

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file diff --git a/papi-dts/interfaces/_shared_services_dialog_service_model_.DialogService.html b/papi-dts/interfaces/_shared_services_dialog_service_model_.DialogService.html index c943a6f6b9..95ad181c2e 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

      • Optional options: DialogOptions

        Various options for configuring the dialog that shows

      Returns Promise<undefined | string>

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

      -

    showDialog

    • showDialog<DialogTabType>(dialogType, options?): Promise<undefined | DialogTypes[DialogTabType]["responseType"]>

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

      +

    showDialog

    • showDialog<DialogTabType>(dialogType, options?): Promise<undefined | DialogTypes[DialogTabType]["responseType"]>

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

      Type Parameters

      Parameters

      • dialogType: DialogTabType

        The type of dialog to show the user

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

        Various options for configuring the dialog that shows

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

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

      -

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file diff --git a/papi-dts/interfaces/_shared_services_internet_service_.InternetService.html b/papi-dts/interfaces/_shared_services_internet_service_.InternetService.html index b9b48d475e..ad0cbf43a3 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>);
    }

    Properties

    fetch +InternetService | papi-dts

    Interface InternetService

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

    Properties

    fetch

    Properties

    fetch

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

    Type declaration

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

      • MDN Reference

        -

        Parameters

        • input: RequestInfo | URL
        • Optional init: RequestInit

        Returns Promise<Response>

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file +

    Parameters

    • input: RequestInfo | URL
    • Optional init: RequestInit

    Returns Promise<Response>

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file diff --git a/papi-dts/interfaces/_shared_services_network_connector_interface_.default.html b/papi-dts/interfaces/_shared_services_network_connector_interface_.default.html index 8b86cae0d0..3c5177ee4d 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;
    }>>

    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)

    Type declaration

    connectorInfo

    connectorInfo: Readonly<{
        clientId: number;
    }>

    Information about the connector. Populated by the server while connecting

    +

    Type declaration

    • clientId: number

    disconnect

    disconnect: (() => void)

    Type declaration

      • (): void

      • Disconnects from the connection:

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

        Returns void

    emitEventOnNetwork

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

    Type declaration

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

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

        Returns void

    emitEventOnNetwork

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

    Type declaration

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

      • Sends an event to other processes. Does NOT run the local event subscriptions as they should be run by NetworkEventEmitter after sending on network.

        Type Parameters

        • T

        Parameters

        • eventType: string

          Unique network event type for coordinating between processes

        • event: InternalEvent<T>

          Event to emit on the network

          -

        Returns Promise<void>

    notifyClientConnected

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

    Type declaration

      • (): Promise<void>

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

        +

    Returns Promise<void>

    notifyClientConnected

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

    Type declaration

      • (): Promise<void>

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

        MUST RUN AFTER connect() WHEN ITS PROMISE RESOLVES

        TODO: Is this necessary?

        -

        Returns Promise<void>

    request

    request: InternalRequestHandler

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

    +

    Returns Promise<void>

    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

    Generated using TypeDoc

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file diff --git a/papi-dts/interfaces/_shared_services_network_object_status_service_model_.NetworkObjectStatusRemoteServiceType.html b/papi-dts/interfaces/_shared_services_network_object_status_service_model_.NetworkObjectStatusRemoteServiceType.html index de555bc3ce..e4b00d8858 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

    Properties

    getAllNetworkObjectDetails +NetworkObjectStatusRemoteServiceType | papi-dts

    Interface NetworkObjectStatusRemoteServiceType

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

    Hierarchy

    Properties

    getAllNetworkObjectDetails

    Properties

    getAllNetworkObjectDetails

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

    Type declaration

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file diff --git a/papi-dts/interfaces/_shared_services_network_object_status_service_model_.NetworkObjectStatusServiceType.html b/papi-dts/interfaces/_shared_services_network_object_status_service_model_.NetworkObjectStatusServiceType.html index 8f63446d2a..3d3cf8c73e 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

    Properties

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

    Hierarchy

    Properties

    getAllNetworkObjectDetails waitForNetworkObject

    Properties

    getAllNetworkObjectDetails

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

    Type declaration

    waitForNetworkObject

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

    Type declaration

      • (id, timeoutInMS?): Promise<NetworkObjectDetails>

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

        +

    waitForNetworkObject

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

    Type declaration

      • (id, timeoutInMS?): Promise<NetworkObjectDetails>

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

        Parameters

        • id: string
        • Optional timeoutInMS: number

        Returns Promise<NetworkObjectDetails>

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

        -

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file diff --git a/papi-dts/interfaces/_shared_services_network_service_.PapiNetworkService.html b/papi-dts/interfaces/_shared_services_network_service_.PapiNetworkService.html index 7608ae219b..27c31a0e51 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

    Generated using TypeDoc

    \ No newline at end of file +

    onDidClientConnect

    onDidClientConnect: PlatformEvent<ClientConnectEvent>

    onDidClientDisconnect

    onDidClientDisconnect: PlatformEvent<ClientDisconnectEvent>

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file diff --git a/papi-dts/interfaces/_shared_services_project_data_provider_service_.PapiBackendProjectDataProviderService.html b/papi-dts/interfaces/_shared_services_project_data_provider_service_.PapiBackendProjectDataProviderService.html index a1211c424c..23e38b9026 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

        • projectType: ProjectType

          Type of project that pdpEngineFactory supports

        • pdpEngineFactory: ProjectDataProviderEngineFactory<ProjectType>

          Used in a ProjectDataProviderFactory to create ProjectDataProviders

        Returns Promise<Dispose>

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

        -

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file diff --git a/papi-dts/interfaces/_shared_services_project_data_provider_service_.PapiFrontendProjectDataProviderService.html b/papi-dts/interfaces/_shared_services_project_data_provider_service_.PapiFrontendProjectDataProviderService.html index e90063d75d..81e657cc8c 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

    Generated using TypeDoc

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file diff --git a/papi-dts/interfaces/_shared_services_project_lookup_service_model_.ProjectLookupServiceType.html b/papi-dts/interfaces/_shared_services_project_lookup_service_model_.ProjectLookupServiceType.html index c7e06aef0c..7eb844d549 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[]>)

    Type declaration

      • (): Promise<ProjectMetadata[]>

      • Provide metadata for all projects found on the local system

        Returns Promise<ProjectMetadata[]>

        ProjectMetadata for all projects stored on the local system

        -

    getMetadataForProject

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

    Type declaration

      • (projectId): Promise<ProjectMetadata>

      • Look up metadata for a specific project ID

        +

    getMetadataForProject

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

    Type declaration

      • (projectId): Promise<ProjectMetadata>

      • Look up metadata for a specific project ID

        Parameters

        • projectId: string

          ID of the project to load

        Returns Promise<ProjectMetadata>

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

        -

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file diff --git a/papi-dts/interfaces/_shared_services_settings_service_.SettingsService.html b/papi-dts/interfaces/_shared_services_settings_service_.SettingsService.html index db8395b3c0..29e7ed5619 100644 --- a/papi-dts/interfaces/_shared_services_settings_service_.SettingsService.html +++ b/papi-dts/interfaces/_shared_services_settings_service_.SettingsService.html @@ -1,4 +1,4 @@ -SettingsService | papi-dts

    Interface SettingsService

    interface SettingsService {
        get: (<SettingName>(key, defaultSetting) => SettingTypes[SettingName]);
        reset: (<SettingName>(key) => void);
        set: (<SettingName>(key, newSetting) => void);
        subscribe: (<SettingName>(key, callback) => Unsubscriber);
    }

    Properties

    get +SettingsService | papi-dts

    Interface SettingsService

    interface SettingsService {
        get: (<SettingName>(key, defaultSetting) => SettingTypes[SettingName]);
        reset: (<SettingName>(key) => void);
        set: (<SettingName>(key, newSetting) => void);
        subscribe: (<SettingName>(key, callback) => Unsubscriber);
    }

    Properties

    get reset set subscribe @@ -7,15 +7,15 @@
  • defaultSetting: SettingTypes[SettingName]

    The default value used for the setting if no value is available for the key

    • Returns SettingTypes[SettingName]

    The value of the specified setting, parsed to an object. Returns default setting if setting does not exist

    -

    reset

    reset: (<SettingName>(key) => void)

    Type declaration

      • <SettingName>(key): void

      • Removes the setting from memory

        +

    reset

    reset: (<SettingName>(key) => void)

    Type declaration

      • <SettingName>(key): void

      • Removes the setting from memory

        Type Parameters

        Parameters

        • key: SettingName

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

          -

        Returns void

    set

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

    Type declaration

      • <SettingName>(key, newSetting): void

      • Sets the value of the specified setting

        +

    Returns void

    set

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

    Type declaration

      • <SettingName>(key, newSetting): void

      • Sets the value of the specified setting

        Type Parameters

        Parameters

        • key: SettingName

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

        • newSetting: SettingTypes[SettingName]

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

          -

        Returns void

    subscribe

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

    Type declaration

      • <SettingName>(key, callback): Unsubscriber

      • Subscribes to updates of the specified setting. Whenever the value of the setting changes, the +

    Returns void

    subscribe

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

    Type declaration

      • <SettingName>(key, callback): Unsubscriber

      • Subscribes to updates of the specified setting. Whenever the value of the setting changes, the callback function is executed.

        Type Parameters

        Parameters

        • key: SettingName

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

        • callback: ((newSetting) => void)

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

            • (newSetting): void

            • Parameters

              Returns void

        Returns Unsubscriber

        Unsubscriber that should be called whenever the subscription should be deleted

        -

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file diff --git a/papi-dts/interfaces/_shared_services_web_view_provider_service_.PapiWebViewProviderService.html b/papi-dts/interfaces/_shared_services_web_view_provider_service_.PapiWebViewProviderService.html index 7c566286f8..fce3994e1a 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

    Generated using TypeDoc

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file diff --git a/papi-dts/interfaces/_shared_services_web_view_provider_service_.WebViewProviderService.html b/papi-dts/interfaces/_shared_services_web_view_provider_service_.WebViewProviderService.html index a43e25fa83..4f5a835a07 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

    Generated using TypeDoc

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file diff --git a/papi-dts/interfaces/_shared_services_web_view_service_model_.WebViewServiceType.html b/papi-dts/interfaces/_shared_services_web_view_service_model_.WebViewServiceType.html index 17815fda13..32a3440461 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>)

    Type declaration

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

      • Creates a new web view or gets an existing one depending on if you request an existing one and if the web view provider decides to give that existing one to you (it is up to the provider).

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

    Returns Promise<undefined | string>

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

    Throws

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

    -

    onDidAddWebView

    onDidAddWebView: PlatformEvent<AddWebViewEvent>

    Event that emits with webView info when a webView is added

    -

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ 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

    Generated using TypeDoc

    \ No newline at end of file diff --git a/papi-dts/modules/__papi_backend_.html b/papi-dts/modules/__papi_backend_.html index bbc366f011..801cbc7f77 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 commands dataProviders default diff --git a/papi-dts/modules/__papi_core_.html b/papi-dts/modules/__papi_core_.html index 674b1b74cf..58a7535463 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 ef950f9187..3ab4f5b370 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 e3e817625d..ee985359ed 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 9ced36ced5..ec003ce28e 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

    Generated using TypeDoc

    \ No newline at end of file diff --git a/papi-dts/modules/_client_services_web_socket_factory_.html b/papi-dts/modules/_client_services_web_socket_factory_.html index 92d2f62f05..e5723c2f87 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

    Generated using TypeDoc

    \ No newline at end of file diff --git a/papi-dts/modules/_client_services_web_socket_interface_.html b/papi-dts/modules/_client_services_web_socket_interface_.html index 91a0cad444..ca27a08e36 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

    Generated using TypeDoc

    \ No newline at end of file diff --git a/papi-dts/modules/_extension_host_extension_types_extension_activation_context_model_.html b/papi-dts/modules/_extension_host_extension_types_extension_activation_context_model_.html index af4712a078..bcb1775c24 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

    Generated using TypeDoc

    \ No newline at end of file diff --git a/papi-dts/modules/_extension_host_extension_types_extension_interface_.html b/papi-dts/modules/_extension_host_extension_types_extension_interface_.html index 4dea9d7ec7..989f624d37 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

    Generated using TypeDoc

    \ No newline at end of file diff --git a/papi-dts/modules/_extension_host_extension_types_extension_manifest_model_.html b/papi-dts/modules/_extension_host_extension_types_extension_manifest_model_.html index 89b1ea2f66..8d25f365d2 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

    Generated using TypeDoc

    \ No newline at end of file diff --git a/papi-dts/modules/_extension_host_services_extension_host_web_socket_model_.html b/papi-dts/modules/_extension_host_services_extension_host_web_socket_model_.html index ae978ac89f..f7bc36b44b 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

    Generated using TypeDoc

    \ No newline at end of file diff --git a/papi-dts/modules/_extension_host_services_extension_storage_service_.html b/papi-dts/modules/_extension_host_services_extension_storage_service_.html index ebfbb41b0d..796c49bd81 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 b2063c4025..a3d2769f75 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

    Generated using TypeDoc

    \ No newline at end of file diff --git a/papi-dts/modules/_node_models_execution_token_model_.html b/papi-dts/modules/_node_models_execution_token_model_.html index 54b8e12974..6077344c86 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

    Generated using TypeDoc

    \ No newline at end of file diff --git a/papi-dts/modules/_node_services_execution_token_service_.html b/papi-dts/modules/_node_services_execution_token_service_.html index 16c41dc58f..94df76b8ec 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

    Generated using TypeDoc

    \ No newline at end of file diff --git a/papi-dts/modules/_node_services_node_file_system_service_.html b/papi-dts/modules/_node_services_node_file_system_service_.html index 8384cdb234..8b92a8bbd7 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 594829d31c..cb4d496197 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

    Generated using TypeDoc

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

    Namespace getAppDir

    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

    -

    Index

    Functions

    clear +

    Index

    Functions

    clear

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

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

    Namespace "node/utils/util"

    Index

    Namespaces

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

    Namespace "node/utils/util"

    Index

    Namespaces

    getAppDir

    Variables

    FILE_PROTOCOL RESOURCES_PROTOCOL

    Functions

    getAppDir diff --git a/papi-dts/modules/_papi_shared_types_.html b/papi-dts/modules/_papi_shared_types_.html index 551f3f9e29..f8ab49abea 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 SettingTypes diff --git a/papi-dts/modules/_renderer_components_dialogs_dialog_base_data_.html b/papi-dts/modules/_renderer_components_dialogs_dialog_base_data_.html index 6ee3fb1bca..e7373c7c70 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 61a25cecc5..7af7d56964 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 8221720ff5..77c74ac4aa 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

    Generated using TypeDoc

    \ No newline at end of file diff --git a/papi-dts/modules/_renderer_hooks_hook_generators_create_use_network_object_hook_util_.html b/papi-dts/modules/_renderer_hooks_hook_generators_create_use_network_object_hook_util_.html index 849b0de1e6..68d37840fe 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

    Generated using TypeDoc

    \ No newline at end of file diff --git a/papi-dts/modules/_renderer_hooks_papi_hooks_index_.html b/papi-dts/modules/_renderer_hooks_papi_hooks_index_.html index d21fafa0c9..2f2a6d0abb 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 ecfb45af83..7f005273d4 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

    Generated using TypeDoc

    \ No newline at end of file diff --git a/papi-dts/modules/_renderer_hooks_papi_hooks_use_data_provider_hook_.html b/papi-dts/modules/_renderer_hooks_papi_hooks_use_data_provider_hook_.html index e441fd7dac..7cb9cd5c19 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

    Generated using TypeDoc

    \ No newline at end of file diff --git a/papi-dts/modules/_renderer_hooks_papi_hooks_use_data_provider_multi_hook_.html b/papi-dts/modules/_renderer_hooks_papi_hooks_use_data_provider_multi_hook_.html index ca7635c4f1..b134297c21 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

    Generated using TypeDoc

    \ No newline at end of file diff --git a/papi-dts/modules/_renderer_hooks_papi_hooks_use_dialog_callback_hook_.html b/papi-dts/modules/_renderer_hooks_papi_hooks_use_dialog_callback_hook_.html index 07dc251ef4..ad321add52 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

    Generated using TypeDoc

    \ No newline at end of file diff --git a/papi-dts/modules/_renderer_hooks_papi_hooks_use_project_data_hook_.html b/papi-dts/modules/_renderer_hooks_papi_hooks_use_project_data_hook_.html index 2449982823..f9595fc365 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

    Generated using TypeDoc

    \ No newline at end of file diff --git a/papi-dts/modules/_renderer_hooks_papi_hooks_use_project_data_provider_hook_.html b/papi-dts/modules/_renderer_hooks_papi_hooks_use_project_data_provider_hook_.html index 1b3be8634c..4531fa7adb 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

    Generated using TypeDoc

    \ No newline at end of file diff --git a/papi-dts/modules/_renderer_hooks_papi_hooks_use_setting_hook_.html b/papi-dts/modules/_renderer_hooks_papi_hooks_use_setting_hook_.html index 366edc0659..3f918b985a 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

    Generated using TypeDoc

    \ No newline at end of file diff --git a/papi-dts/modules/_renderer_services_renderer_web_socket_service_.html b/papi-dts/modules/_renderer_services_renderer_web_socket_service_.html index f2729d39ee..6a2b9cb521 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

    Generated using TypeDoc

    \ No newline at end of file diff --git a/papi-dts/modules/_renderer_services_renderer_xml_http_request_service_.html b/papi-dts/modules/_renderer_services_renderer_xml_http_request_service_.html index d0204d50e2..946c69eda6 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

    Generated using TypeDoc

    \ No newline at end of file diff --git a/papi-dts/modules/_shared_data_file_system_model_.html b/papi-dts/modules/_shared_data_file_system_model_.html index 9ebf2601e7..5d1accbe04 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

    Generated using TypeDoc

    \ No newline at end of file diff --git a/papi-dts/modules/_shared_data_internal_connection_model_.html b/papi-dts/modules/_shared_data_internal_connection_model_.html index d4986dc3e9..ece168571d 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 b4cc451b98..1a01b1b8ea 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 62d3f86579..8e7f004728 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

    Generated using TypeDoc

    \ No newline at end of file diff --git a/papi-dts/modules/_shared_models_data_provider_engine_model_.html b/papi-dts/modules/_shared_models_data_provider_engine_model_.html index 271a19e26e..5f8050730f 100644 --- a/papi-dts/modules/_shared_models_data_provider_engine_model_.html +++ b/papi-dts/modules/_shared_models_data_provider_engine_model_.html @@ -1,4 +1,4 @@ -"shared/models/data-provider-engine.model" | papi-dts

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

    Index

    Type Aliases

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

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

    Index

    Type Aliases

    DataProviderEngineNotifyUpdate WithNotifyUpdate default

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/papi-dts/modules/_shared_models_data_provider_interface_.html b/papi-dts/modules/_shared_models_data_provider_interface_.html index c04af00730..5a1e9a6054 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

    Generated using TypeDoc

    \ No newline at end of file diff --git a/papi-dts/modules/_shared_models_data_provider_model_.html b/papi-dts/modules/_shared_models_data_provider_model_.html index 0d24acea16..9a6543cadf 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 aa1412ffcf..bfa0b26030 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

    Generated using TypeDoc

    \ 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 5c874773f5..99509570c2 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 f9d13576fc..034a63dea9 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

    Generated using TypeDoc

    \ No newline at end of file diff --git a/papi-dts/modules/_shared_models_network_object_model_.html b/papi-dts/modules/_shared_models_network_object_model_.html index c5d7133af9..96cb6fa33d 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 ff0092d812..f27295321d 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

    Generated using TypeDoc

    \ No newline at end of file diff --git a/papi-dts/modules/_shared_models_project_data_provider_engine_model_.html b/papi-dts/modules/_shared_models_project_data_provider_engine_model_.html index 4e1469adbd..ba58649424 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,3 +1,3 @@ -"shared/models/project-data-provider-engine.model" | papi-dts

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

    Index

    Interfaces

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

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

    Index

    Interfaces

    ProjectDataProviderEngineFactory

    Type Aliases

    ProjectDataProviderEngineTypes

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/papi-dts/modules/_shared_models_project_data_provider_model_.html b/papi-dts/modules/_shared_models_project_data_provider_model_.html index 284b222346..2a3d480fea 100644 --- a/papi-dts/modules/_shared_models_project_data_provider_model_.html +++ b/papi-dts/modules/_shared_models_project_data_provider_model_.html @@ -1,3 +1,3 @@ -"shared/models/project-data-provider.model" | papi-dts

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

    Index

    Type Aliases

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

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

    Index

    Type Aliases

    ExtensionDataScope MandatoryProjectDataType

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/papi-dts/modules/_shared_models_project_metadata_model_.html b/papi-dts/modules/_shared_models_project_metadata_model_.html index 0fd1f707b6..572ae5621b 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

    Generated using TypeDoc

    \ No newline at end of file diff --git a/papi-dts/modules/_shared_models_web_view_model_.html b/papi-dts/modules/_shared_models_web_view_model_.html index 0d5d9b13d0..6b76e60c3d 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 c662476123..386a68d1b4 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

    Generated using TypeDoc

    \ No newline at end of file diff --git a/papi-dts/modules/_shared_services_command_service_.html b/papi-dts/modules/_shared_services_command_service_.html index f82d2dceae..6247480704 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 0e5d10116b..e2a16eaaaf 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 68c8acbe23..a8075f9148 100644 --- a/papi-dts/modules/_shared_services_data_provider_service_.html +++ b/papi-dts/modules/_shared_services_data_provider_service_.html @@ -1,4 +1,4 @@ -"shared/services/data-provider.service" | papi-dts

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

    Index

    Classes

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

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

    Index

    Classes

    DataProviderEngine

    Interfaces

    DataProviderService

    Variables

    default

    Functions

    getByType diff --git a/papi-dts/modules/_shared_services_dialog_service_.html b/papi-dts/modules/_shared_services_dialog_service_.html index 614e4c17be..737601972d 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

    Generated using TypeDoc

    \ No newline at end of file diff --git a/papi-dts/modules/_shared_services_dialog_service_model_.html b/papi-dts/modules/_shared_services_dialog_service_model_.html index 638a754502..3e8cd19453 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

    Generated using TypeDoc

    \ No newline at end of file diff --git a/papi-dts/modules/_shared_services_internet_service_.html b/papi-dts/modules/_shared_services_internet_service_.html index ef85a5d59e..2759d9085c 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

    Generated using TypeDoc

    \ No newline at end of file diff --git a/papi-dts/modules/_shared_services_logger_service_.html b/papi-dts/modules/_shared_services_logger_service_.html index 024da14b79..589648e89e 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

    Generated using TypeDoc

    \ No newline at end of file diff --git a/papi-dts/modules/_shared_services_network_connector_factory_.html b/papi-dts/modules/_shared_services_network_connector_factory_.html index 214344eb52..67827c7438 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

    Generated using TypeDoc

    \ No newline at end of file diff --git a/papi-dts/modules/_shared_services_network_connector_interface_.html b/papi-dts/modules/_shared_services_network_connector_interface_.html index d4bb41ede0..907c7a477b 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

    Generated using TypeDoc

    \ No newline at end of file diff --git a/papi-dts/modules/_shared_services_network_object_service_.html b/papi-dts/modules/_shared_services_network_object_service_.html index 5837edbd77..6ac28696e8 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 c31164ed74..5e2ba72780 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

    Generated using TypeDoc

    \ No newline at end of file diff --git a/papi-dts/modules/_shared_services_network_object_status_service_model_.html b/papi-dts/modules/_shared_services_network_object_status_service_model_.html index 7394524963..751e137a2c 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

    Generated using TypeDoc

    \ No newline at end of file diff --git a/papi-dts/modules/_shared_services_network_service_.html b/papi-dts/modules/_shared_services_network_service_.html index 8ba1bd0096..21dfe4ecdd 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 d3ef48f93e..60de52dede 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 7509ec422c..d3b275acba 100644 --- a/papi-dts/modules/_shared_services_project_lookup_service_.html +++ b/papi-dts/modules/_shared_services_project_lookup_service_.html @@ -1,2 +1,2 @@ -"shared/services/project-lookup.service" | papi-dts

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

    Index

    Variables

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

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

    Index

    Variables

    default

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/papi-dts/modules/_shared_services_project_lookup_service_model_.html b/papi-dts/modules/_shared_services_project_lookup_service_model_.html index 033132f6d5..4bd7c334af 100644 --- a/papi-dts/modules/_shared_services_project_lookup_service_model_.html +++ b/papi-dts/modules/_shared_services_project_lookup_service_model_.html @@ -1,3 +1,3 @@ -"shared/services/project-lookup.service-model" | papi-dts

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

    Index

    Interfaces

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

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

    Index

    Interfaces

    ProjectLookupServiceType

    Variables

    projectLookupServiceNetworkObjectName

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/papi-dts/modules/_shared_services_settings_service_.html b/papi-dts/modules/_shared_services_settings_service_.html index 6b5cf91671..486baf5896 100644 --- a/papi-dts/modules/_shared_services_settings_service_.html +++ b/papi-dts/modules/_shared_services_settings_service_.html @@ -1,4 +1,4 @@ -"shared/services/settings.service" | papi-dts

    Namespace "shared/services/settings.service"

    Index

    Interfaces

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

    Namespace "shared/services/settings.service"

    Index

    Interfaces

    SettingsService

    Type Aliases

    ResetSettingEvent SettingEvent UpdateSettingEvent 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 ec066c046f..ba36e14587 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 0f05e8ce90..b7815e11d9 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

    Generated using TypeDoc

    \ No newline at end of file diff --git a/papi-dts/modules/_shared_services_web_view_service_model_.html b/papi-dts/modules/_shared_services_web_view_service_model_.html index bd21d51c2f..a4c243ca82 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

    Generated using TypeDoc

    \ No newline at end of file diff --git a/papi-dts/modules/_shared_utils_internal_util_.html b/papi-dts/modules/_shared_utils_internal_util_.html index 1f0759572c..1358cb5323 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 e85c0613ce..cccba7ac18 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/modules/webViewComponent.html b/papi-dts/modules/webViewComponent.html index 6b61d110b0..456ea3676e 100644 --- a/papi-dts/modules/webViewComponent.html +++ b/papi-dts/modules/webViewComponent.html @@ -1,6 +1,6 @@ webViewComponent | papi-dts

    Namespace webViewComponent

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

    -

    Index

    Variables

    contextTypes? +

    Index

    Variables

    contextTypes? defaultProps? displayName? propTypes? diff --git a/papi-dts/types/__papi_frontend_.Papi.html b/papi-dts/types/__papi_frontend_.Papi.html index 80b20c4037..1622f19697 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

    Generated using TypeDoc

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

    Type alias Papi

    Papi: typeof "@papi/frontend".default

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/papi-dts/types/_client_services_web_socket_interface_.IWebSocket.html b/papi-dts/types/_client_services_web_socket_interface_.IWebSocket.html index 0731f51e5d..04a6dfc7ec 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

    Generated using TypeDoc

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/papi-dts/types/_extension_host_extension_types_extension_activation_context_model_.ExecutionActivationContext.html b/papi-dts/types/_extension_host_extension_types_extension_activation_context_model_.ExecutionActivationContext.html index 768bd454c6..233849fe17 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

    Generated using TypeDoc

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/papi-dts/types/_extension_host_extension_types_extension_manifest_model_.ExtensionManifest.html b/papi-dts/types/_extension_host_extension_types_extension_manifest_model_.ExtensionManifest.html index ed2f4be9b8..2246480462 100644 --- a/papi-dts/types/_extension_host_extension_types_extension_manifest_model_.ExtensionManifest.html +++ b/papi-dts/types/_extension_host_extension_types_extension_manifest_model_.ExtensionManifest.html @@ -18,4 +18,4 @@ for more information about extension type declaration files.

  • version: string

    Extension version - expected to be semver like "0.1.3".

    Note: semver may become a hard requirement in the future, so we recommend using it now.

    -

    • Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/papi-dts/types/_node_models_execution_token_model_.ExecutionTokenType.html b/papi-dts/types/_node_models_execution_token_model_.ExecutionTokenType.html index ae32c8792e..ded12c922b 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

    Generated using TypeDoc

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/papi-dts/types/_node_services_node_file_system_service_.DirectoryEntries.html b/papi-dts/types/_node_services_node_file_system_service_.DirectoryEntries.html index 11572adb7a..cf1d04b81b 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

    Generated using TypeDoc

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/papi-dts/types/_papi_shared_types_.CommandNames.html b/papi-dts/types/_papi_shared_types_.CommandNames.html index ac88db5ad0..b5eeb0dbfb 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

    Generated using TypeDoc

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/papi-dts/types/_papi_shared_types_.DataProviderNames.html b/papi-dts/types/_papi_shared_types_.DataProviderNames.html index 1ff07f4fef..9d7f2012cb 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

    Generated using TypeDoc

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/papi-dts/types/_papi_shared_types_.DataProviderTypes.html b/papi-dts/types/_papi_shared_types_.DataProviderTypes.html index 4a20782d57..4d7e31f1e3 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

    Generated using TypeDoc

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/papi-dts/types/_papi_shared_types_.DisposableDataProviders.html b/papi-dts/types/_papi_shared_types_.DisposableDataProviders.html index 6b418b1afa..c857b92454 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

    Generated using TypeDoc

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/papi-dts/types/_papi_shared_types_.NotesOnlyProjectDataTypes.html b/papi-dts/types/_papi_shared_types_.NotesOnlyProjectDataTypes.html index b560356214..a71970e68a 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: MandatoryProjectDataType & {
        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

    Generated using TypeDoc

    \ No newline at end of file +

    Type declaration

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/papi-dts/types/_papi_shared_types_.PlaceholderDataTypes.html b/papi-dts/types/_papi_shared_types_.PlaceholderDataTypes.html index 37dce4855e..b1a95508a0 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

    Generated using TypeDoc

    \ 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

    Generated using TypeDoc

    \ 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 59b0b99d45..32ec96b2fc 100644 --- a/papi-dts/types/_papi_shared_types_.ProjectDataTypes.html +++ b/papi-dts/types/_papi_shared_types_.ProjectDataTypes.html @@ -4,4 +4,4 @@ ProjectDataProviders.

    Example

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

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/papi-dts/types/_papi_shared_types_.ProjectTypes.html b/papi-dts/types/_papi_shared_types_.ProjectTypes.html index 9bcf43d18b..59188ecc93 100644 --- a/papi-dts/types/_papi_shared_types_.ProjectTypes.html +++ b/papi-dts/types/_papi_shared_types_.ProjectTypes.html @@ -3,4 +3,4 @@ ProjectDataProviders.

    Example

    'platform.placeholder'
    -

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/papi-dts/types/_papi_shared_types_.SettingNames.html b/papi-dts/types/_papi_shared_types_.SettingNames.html index e21645cc5d..e6a532c40a 100644 --- a/papi-dts/types/_papi_shared_types_.SettingNames.html +++ b/papi-dts/types/_papi_shared_types_.SettingNames.html @@ -1 +1 @@ -SettingNames | papi-dts

    Type alias SettingNames

    SettingNames: keyof SettingTypes

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

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

    Type alias SettingNames

    SettingNames: keyof SettingTypes

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/papi-dts/types/_papi_shared_types_.StuffDataTypes.html b/papi-dts/types/_papi_shared_types_.StuffDataTypes.html index a9da648b9f..b4fb562e6e 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

    Generated using TypeDoc

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

    Type alias StuffDataTypes

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

    Type declaration

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/papi-dts/types/_renderer_components_dialogs_dialog_base_data_.DialogDefinitionBase.html b/papi-dts/types/_renderer_components_dialogs_dialog_base_data_.DialogDefinitionBase.html index fd94c28904..be1ec36671 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

    Generated using TypeDoc

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/papi-dts/types/_renderer_components_dialogs_dialog_base_data_.DialogProps.html b/papi-dts/types/_renderer_components_dialogs_dialog_base_data_.DialogProps.html index ee5e6dca5d..03a80af767 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

    Generated using TypeDoc

    \ No newline at end of file +

    Returns void

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/papi-dts/types/_renderer_components_dialogs_dialog_definition_model_.DialogDataTypes.html b/papi-dts/types/_renderer_components_dialogs_dialog_definition_model_.DialogDataTypes.html index 11c805f32d..abfb7d993a 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

    Generated using TypeDoc

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/papi-dts/types/_renderer_components_dialogs_dialog_definition_model_.DialogDefinition.html b/papi-dts/types/_renderer_components_dialogs_dialog_definition_model_.DialogDefinition.html index 437b9c3ff1..77a1dc1c2c 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

    Generated using TypeDoc

    \ 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

    Generated using TypeDoc

    \ No newline at end of file diff --git a/papi-dts/types/_renderer_components_dialogs_dialog_definition_model_.DialogTabTypes.html b/papi-dts/types/_renderer_components_dialogs_dialog_definition_model_.DialogTabTypes.html index c149c7f96f..4b88924032 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

    Generated using TypeDoc

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/papi-dts/types/_renderer_components_dialogs_dialog_definition_model_.SelectMultipleProjectsDialogOptions.html b/papi-dts/types/_renderer_components_dialogs_dialog_definition_model_.SelectMultipleProjectsDialogOptions.html index b6db9f7248..2d6a585b8a 100644 --- a/papi-dts/types/_renderer_components_dialogs_dialog_definition_model_.SelectMultipleProjectsDialogOptions.html +++ b/papi-dts/types/_renderer_components_dialogs_dialog_definition_model_.SelectMultipleProjectsDialogOptions.html @@ -1,4 +1,4 @@ SelectMultipleProjectsDialogOptions | papi-dts

    Type alias SelectMultipleProjectsDialogOptions

    SelectMultipleProjectsDialogOptions: DialogOptions & {
        excludeProjectIds?: string[];
        selectedProjectIds?: string[];
    }

    Options to provide when showing the Select Multiple Project dialog

    Type declaration

    • Optional excludeProjectIds?: string[]

      Project IDs to exclude from showing in the dialog

    • Optional selectedProjectIds?: string[]

      Project IDs that should start selected in the dialog

      -

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/papi-dts/types/_renderer_components_dialogs_dialog_definition_model_.SelectProjectDialogOptions.html b/papi-dts/types/_renderer_components_dialogs_dialog_definition_model_.SelectProjectDialogOptions.html index aa3b6944dc..39b834c951 100644 --- a/papi-dts/types/_renderer_components_dialogs_dialog_definition_model_.SelectProjectDialogOptions.html +++ b/papi-dts/types/_renderer_components_dialogs_dialog_definition_model_.SelectProjectDialogOptions.html @@ -1,3 +1,3 @@ SelectProjectDialogOptions | papi-dts

    Type alias SelectProjectDialogOptions

    SelectProjectDialogOptions: DialogOptions & {
        excludeProjectIds?: string[];
    }

    Options to provide when showing the Select Project dialog

    Type declaration

    • Optional excludeProjectIds?: string[]

      Project IDs to exclude from showing in the dialog

      -

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ 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 22d96e2055..392158e719 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

    Generated using TypeDoc

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/papi-dts/types/_shared_data_file_system_model_.Uri.html b/papi-dts/types/_shared_data_file_system_model_.Uri.html index eb15b335d5..22ac1546f2 100644 --- a/papi-dts/types/_shared_data_file_system_model_.Uri.html +++ b/papi-dts/types/_shared_data_file_system_model_.Uri.html @@ -7,4 +7,4 @@
  • resources:// - goes to the resources directory installed in the app
  • file:// - an absolute file path from root
    • -

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/papi-dts/types/_shared_data_internal_connection_model_.ClientConnectEvent.html b/papi-dts/types/_shared_data_internal_connection_model_.ClientConnectEvent.html index a2e3e33911..7471870c68 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

    Generated using TypeDoc

    \ No newline at end of file +

    Type declaration

    • clientId: number
    • didReconnect: boolean

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/papi-dts/types/_shared_data_internal_connection_model_.ClientDisconnectEvent.html b/papi-dts/types/_shared_data_internal_connection_model_.ClientDisconnectEvent.html index 9abe0f748b..48be4f2f5f 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

    Generated using TypeDoc

    \ No newline at end of file +

    Type declaration

    • clientId: number

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/papi-dts/types/_shared_data_internal_connection_model_.InternalEvent.html b/papi-dts/types/_shared_data_internal_connection_model_.InternalEvent.html index 91add92fef..bed733497a 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

    Generated using TypeDoc

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/papi-dts/types/_shared_data_internal_connection_model_.InternalNetworkEventHandler.html b/papi-dts/types/_shared_data_internal_connection_model_.InternalNetworkEventHandler.html index a0ad408cbb..20699ed62e 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)

    Type declaration

      • <T>(eventType, incomingEvent): void

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

        -

        Type Parameters

        • T

        Parameters

        Returns void

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Type Parameters

    • T

    Parameters

    Returns void

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/papi-dts/types/_shared_data_internal_connection_model_.InternalRequest.html b/papi-dts/types/_shared_data_internal_connection_model_.InternalRequest.html index 7003259a7b..a9563454d2 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

    Generated using TypeDoc

    \ No newline at end of file +

    Type Parameters

    • TParam = unknown

    Type declaration

    • requestId: number

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/papi-dts/types/_shared_data_internal_connection_model_.InternalRequestHandler.html b/papi-dts/types/_shared_data_internal_connection_model_.InternalRequestHandler.html index d7f9fe2ad8..f1ac2bdc88 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>>)

    Type declaration

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

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

        -

        Type Parameters

        • TParam

        • TReturn

        Parameters

        Returns Promise<InternalResponse<TReturn>>

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Type Parameters

    • TParam

    • TReturn

    Parameters

    Returns Promise<InternalResponse<TReturn>>

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/papi-dts/types/_shared_data_internal_connection_model_.InternalResponse.html b/papi-dts/types/_shared_data_internal_connection_model_.InternalResponse.html index 6768356698..b14fc1f4c3 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

    Generated using TypeDoc

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/papi-dts/types/_shared_data_internal_connection_model_.NetworkConnectorEventHandlers.html b/papi-dts/types/_shared_data_internal_connection_model_.NetworkConnectorEventHandlers.html index ddb9f14a4e..8c39feeedd 100644 --- a/papi-dts/types/_shared_data_internal_connection_model_.NetworkConnectorEventHandlers.html +++ b/papi-dts/types/_shared_data_internal_connection_model_.NetworkConnectorEventHandlers.html @@ -2,4 +2,4 @@ from NetworkEventEmitters so the events inform all interested connections

    Type declaration

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

        • Handles when a new connection is established

          Parameters

          Returns void

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

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Parameters

    Returns void

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/papi-dts/types/_shared_data_internal_connection_model_.NetworkConnectorInfo.html b/papi-dts/types/_shared_data_internal_connection_model_.NetworkConnectorInfo.html index b7305f4b82..6332936675 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

    Generated using TypeDoc

    \ No newline at end of file +

    Type declaration

    • clientId: number

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/papi-dts/types/_shared_data_internal_connection_model_.NetworkEventHandler.html b/papi-dts/types/_shared_data_internal_connection_model_.NetworkEventHandler.html index 11f2f60b63..cad9f36d66 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)

    Type declaration

      • <T>(eventType, event): void

      • Handler for events from on the network

        -

        Type Parameters

        • T

        Parameters

        • eventType: string
        • event: T

        Returns void

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Type Parameters

    • T

    Parameters

    • eventType: string
    • event: T

    Returns void

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/papi-dts/types/_shared_data_internal_connection_model_.RequestHandler.html b/papi-dts/types/_shared_data_internal_connection_model_.RequestHandler.html index 4fc3b2756a..9f57439878 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>>)

    Type declaration

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Type Parameters

    • TParam

    • TReturn

    Parameters

    Returns Promise<ComplexResponse<TReturn>>

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/papi-dts/types/_shared_data_internal_connection_model_.RequestRouter.html b/papi-dts/types/_shared_data_internal_connection_model_.RequestRouter.html index 7ab2bef4b9..96f9e352e7 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)

    Type declaration

      • (requestType): number

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

        -

        Parameters

        • requestType: string

        Returns number

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Parameters

    • requestType: string

    Returns number

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/papi-dts/types/_shared_data_network_connector_model_.ClientConnect.html b/papi-dts/types/_shared_data_network_connector_model_.ClientConnect.html index fd358e983e..2e4d2d02de 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

    Generated using TypeDoc

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

    • Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/papi-dts/types/_shared_data_network_connector_model_.InitClient.html b/papi-dts/types/_shared_data_network_connector_model_.InitClient.html index 0a45c66489..69f1f4528c 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

    Generated using TypeDoc

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

    • Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/papi-dts/types/_shared_data_network_connector_model_.Message.html b/papi-dts/types/_shared_data_network_connector_model_.Message.html index 2d4921bf72..451eeb7e21 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

    Generated using TypeDoc

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/papi-dts/types/_shared_data_network_connector_model_.WebSocketEvent.html b/papi-dts/types/_shared_data_network_connector_model_.WebSocketEvent.html index ef579fa15f..0e5e375d0e 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

    Generated using TypeDoc

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

    • Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/papi-dts/types/_shared_data_network_connector_model_.WebSocketRequest.html b/papi-dts/types/_shared_data_network_connector_model_.WebSocketRequest.html index 7569d55381..cea34196af 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

    Generated using TypeDoc

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

    • Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/papi-dts/types/_shared_data_network_connector_model_.WebSocketResponse.html b/papi-dts/types/_shared_data_network_connector_model_.WebSocketResponse.html index 6f5e4c0558..7e503aabd1 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

    Generated using TypeDoc

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

    • Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/papi-dts/types/_shared_models_data_provider_engine_model_.DataProviderEngineNotifyUpdate.html b/papi-dts/types/_shared_models_data_provider_engine_model_.DataProviderEngineNotifyUpdate.html index 3c687fa7de..d7915302c9 100644 --- a/papi-dts/types/_shared_models_data_provider_engine_model_.DataProviderEngineNotifyUpdate.html +++ b/papi-dts/types/_shared_models_data_provider_engine_model_.DataProviderEngineNotifyUpdate.html @@ -17,4 +17,4 @@

    Example: You can log the manual updates in your data provider engine by spec

    See

    DataProviderUpdateInstructions for more info on the updateInstructions parameter

    WARNING: Do not update a data type in its get<data_type> method (unless you make a base case)! It will create a destructive infinite loop.

    -

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/papi-dts/types/_shared_models_data_provider_engine_model_.WithNotifyUpdate.html b/papi-dts/types/_shared_models_data_provider_engine_model_.WithNotifyUpdate.html index ebf5b0d726..77a2389b8e 100644 --- a/papi-dts/types/_shared_models_data_provider_engine_model_.WithNotifyUpdate.html +++ b/papi-dts/types/_shared_models_data_provider_engine_model_.WithNotifyUpdate.html @@ -24,4 +24,4 @@

    See

    DataProviderUpdateInstructions for more info on the updateI

  • DataProviderEngineNotifyUpdate for more information on notifyUpdate.
  • IDataProviderEngine for more information on using this type.
    • -

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/papi-dts/types/_shared_models_data_provider_engine_model_.default.html b/papi-dts/types/_shared_models_data_provider_engine_model_.default.html index f86271e613..96c587013d 100644 --- a/papi-dts/types/_shared_models_data_provider_engine_model_.default.html +++ b/papi-dts/types/_shared_models_data_provider_engine_model_.default.html @@ -23,4 +23,4 @@ 
    class MyDPE extends DataProviderEngine<MyDataTypes> implements IDataProviderEngine<MyDataTypes> {
      ...
    }
    -

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/papi-dts/types/_shared_models_data_provider_interface_.IDisposableDataProvider.html b/papi-dts/types/_shared_models_data_provider_interface_.IDisposableDataProvider.html index 52363297a8..54be9b9fcc 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

    Generated using TypeDoc

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/papi-dts/types/_shared_models_data_provider_interface_.default.html b/papi-dts/types/_shared_models_data_provider_interface_.default.html index fa9843e705..d174cd7c4a 100644 --- a/papi-dts/types/_shared_models_data_provider_interface_.default.html +++ b/papi-dts/types/_shared_models_data_provider_interface_.default.html @@ -3,4 +3,4 @@ getting a data provider with dataProviderService.get.

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

    -

    Type Parameters

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Type Parameters

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/papi-dts/types/_shared_models_data_provider_model_.DataProviderDataType.html b/papi-dts/types/_shared_models_data_provider_model_.DataProviderDataType.html index 40ce250b8e..64b3873f55 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

    Generated using TypeDoc

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/papi-dts/types/_shared_models_data_provider_model_.DataProviderDataTypes.html b/papi-dts/types/_shared_models_data_provider_model_.DataProviderDataTypes.html index ce5170e84e..876a040508 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

    Generated using TypeDoc

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/papi-dts/types/_shared_models_data_provider_model_.DataProviderGetter.html b/papi-dts/types/_shared_models_data_provider_model_.DataProviderGetter.html index 7f86f19140..8d648cec0f 100644 --- a/papi-dts/types/_shared_models_data_provider_model_.DataProviderGetter.html +++ b/papi-dts/types/_shared_models_data_provider_model_.DataProviderGetter.html @@ -4,4 +4,4 @@ up-to-date.

    Parameters

    • selector: TDataType["selector"]

      Tells the provider what subset of data to get

    Returns Promise<TDataType["getData"]>

    The subset of data represented by the selector

    -

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/papi-dts/types/_shared_models_data_provider_model_.DataProviderGetters.html b/papi-dts/types/_shared_models_data_provider_model_.DataProviderGetters.html index b3d19c8dce..0b15ff0261 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

    Generated using TypeDoc

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/papi-dts/types/_shared_models_data_provider_model_.DataProviderSetter.html b/papi-dts/types/_shared_models_data_provider_model_.DataProviderSetter.html index 014375f1a0..1dc0790374 100644 --- a/papi-dts/types/_shared_models_data_provider_model_.DataProviderSetter.html +++ b/papi-dts/types/_shared_models_data_provider_model_.DataProviderSetter.html @@ -6,4 +6,4 @@

    Returns Promise<DataProviderUpdateInstructions<TDataTypes>>

    Information that papi uses to interpret whether to send out updates. Defaults to true (meaning send updates only for this data type).

    See

    DataProviderUpdateInstructions for more info on what to return

    -

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/papi-dts/types/_shared_models_data_provider_model_.DataProviderSetters.html b/papi-dts/types/_shared_models_data_provider_model_.DataProviderSetters.html index 17b21f7562..1117b28972 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

    Generated using TypeDoc

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/papi-dts/types/_shared_models_data_provider_model_.DataProviderSubscriber.html b/papi-dts/types/_shared_models_data_provider_model_.DataProviderSubscriber.html index 59958e13ec..d6c7f50da4 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>

    Unsubscriber to stop listening for updates

    -

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/papi-dts/types/_shared_models_data_provider_model_.DataProviderSubscriberOptions.html b/papi-dts/types/_shared_models_data_provider_model_.DataProviderSubscriberOptions.html index b63afb0b95..c8d4b26360 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

    Generated using TypeDoc

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/papi-dts/types/_shared_models_data_provider_model_.DataProviderSubscribers.html b/papi-dts/types/_shared_models_data_provider_model_.DataProviderSubscribers.html index 1b61495e49..98cfff6033 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

    Generated using TypeDoc

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/papi-dts/types/_shared_models_data_provider_model_.DataProviderUpdateInstructions.html b/papi-dts/types/_shared_models_data_provider_model_.DataProviderUpdateInstructions.html index 74f1f90bc4..3628d85f6c 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

    Generated using TypeDoc

    \ No newline at end of file +

    Type Parameters

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/papi-dts/types/_shared_models_data_provider_model_.DataTypeNames.html b/papi-dts/types/_shared_models_data_provider_model_.DataTypeNames.html index 56f97d5a71..83c5bdcf41 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

    Generated using TypeDoc

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/papi-dts/types/_shared_models_data_provider_model_.default.html b/papi-dts/types/_shared_models_data_provider_model_.default.html index 71b2ffd5f6..838dc10b22 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

    Generated using TypeDoc

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/papi-dts/types/_shared_models_dialog_options_model_.DialogData.html b/papi-dts/types/_shared_models_dialog_options_model_.DialogData.html index 60690f3ff4..5809b2fac4 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

    Generated using TypeDoc

    \ No newline at end of file +

    Type declaration

    • isDialog: true

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/papi-dts/types/_shared_models_dialog_options_model_.DialogOptions.html b/papi-dts/types/_shared_models_dialog_options_model_.DialogOptions.html index c59e9a8cf3..64c7876fd2 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

    Generated using TypeDoc

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/papi-dts/types/_shared_models_docking_framework_model_.AddWebViewEvent.html b/papi-dts/types/_shared_models_docking_framework_model_.AddWebViewEvent.html index 75bc6ed621..234878752f 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

    Generated using TypeDoc

    \ No newline at end of file +

    Type declaration

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/papi-dts/types/_shared_models_docking_framework_model_.FloatPosition.html b/papi-dts/types/_shared_models_docking_framework_model_.FloatPosition.html index 4f00a1480e..65cf867249 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

    Generated using TypeDoc

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/papi-dts/types/_shared_models_docking_framework_model_.FloatSize.html b/papi-dts/types/_shared_models_docking_framework_model_.FloatSize.html index f3bbd4c888..06f0e72205 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

    Generated using TypeDoc

    \ No newline at end of file +

    Type declaration

    • height: number
    • width: number

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/papi-dts/types/_shared_models_docking_framework_model_.Layout.html b/papi-dts/types/_shared_models_docking_framework_model_.Layout.html index af0accb09e..338c5511ad 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

    Generated using TypeDoc

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/papi-dts/types/_shared_models_docking_framework_model_.OnLayoutChangeRCDock.html b/papi-dts/types/_shared_models_docking_framework_model_.OnLayoutChangeRCDock.html index c1d208053c..cb020a47b3 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>)

    Type declaration

      • (newLayout, currentTabId?, direction?): Promise<void>

      • Rc-dock's onLayoutChange prop made asynchronous - resolves

        -

        Parameters

        • newLayout: LayoutBase
        • Optional currentTabId: string
        • Optional direction: DropDirection

        Returns Promise<void>

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Parameters

    • newLayout: LayoutBase
    • Optional currentTabId: string
    • Optional direction: DropDirection

    Returns Promise<void>

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/papi-dts/types/_shared_models_docking_framework_model_.PanelDirection.html b/papi-dts/types/_shared_models_docking_framework_model_.PanelDirection.html index 605db40b49..87ae740afc 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

    Generated using TypeDoc

    \ 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

    Generated using TypeDoc

    \ No newline at end of file diff --git a/papi-dts/types/_shared_models_docking_framework_model_.PapiDockLayout.html b/papi-dts/types/_shared_models_docking_framework_model_.PapiDockLayout.html index 42144031df..eb54232995 100644 --- a/papi-dts/types/_shared_models_docking_framework_model_.PapiDockLayout.html +++ b/papi-dts/types/_shared_models_docking_framework_model_.PapiDockLayout.html @@ -27,4 +27,4 @@
  • updateInfo: WebViewDefinitionUpdateInfo

    Properties to update on the WebView. Any unspecified properties will stay the same

    • Returns boolean

    True if successfully found the WebView to update; false otherwise

    -

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/papi-dts/types/_shared_models_docking_framework_model_.SavedTabInfo.html b/papi-dts/types/_shared_models_docking_framework_model_.SavedTabInfo.html index a383959e28..2225c421d9 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

    Generated using TypeDoc

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/papi-dts/types/_shared_models_docking_framework_model_.TabInfo.html b/papi-dts/types/_shared_models_docking_framework_model_.TabInfo.html index 5f057b2910..ba049a4be3 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

    Generated using TypeDoc

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/papi-dts/types/_shared_models_docking_framework_model_.TabLoader.html b/papi-dts/types/_shared_models_docking_framework_model_.TabLoader.html index 239a109df0..22e520200b 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)

    Type declaration

      • (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

        -

        Parameters

        Returns TabInfo

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Parameters

    Returns TabInfo

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/papi-dts/types/_shared_models_docking_framework_model_.TabSaver.html b/papi-dts/types/_shared_models_docking_framework_model_.TabSaver.html index 21a8641612..8960fecb02 100644 --- a/papi-dts/types/_shared_models_docking_framework_model_.TabSaver.html +++ b/papi-dts/types/_shared_models_docking_framework_model_.TabSaver.html @@ -3,4 +3,4 @@ stripped from TabInfo by saveTabInfoBase before saving (so it is just a SavedTabInfo).

    Parameters

    • tabInfo: TabInfo

      The Paranext tab to save

    Returns SavedTabInfo | undefined

    The saved tab info for Paranext to persist. If undefined, does not save the tab

    -

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/papi-dts/types/_shared_models_docking_framework_model_.WebViewTabProps.html b/papi-dts/types/_shared_models_docking_framework_model_.WebViewTabProps.html index 6674ac5658..548f8cc63d 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

    Generated using TypeDoc

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/papi-dts/types/_shared_models_extract_data_provider_data_types_model_.default.html b/papi-dts/types/_shared_models_extract_data_provider_data_types_model_.default.html index 100f610c3c..3adcb09ba0 100644 --- a/papi-dts/types/_shared_models_extract_data_provider_data_types_model_.default.html +++ b/papi-dts/types/_shared_models_extract_data_provider_data_types_model_.default.html @@ -3,4 +3,4 @@

    Works with generic types IDataProvider, DataProviderInternal, IDisposableDataProvider, and IDataProviderEngine along with the papi-shared-types extensible interfaces DataProviders and DisposableDataProviders

    -

    Type Parameters

    • TDataProvider

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Type Parameters

    • TDataProvider

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/papi-dts/types/_shared_models_network_object_model_.DisposableNetworkObject.html b/papi-dts/types/_shared_models_network_object_model_.DisposableNetworkObject.html index db054789f6..8eef0e3e64 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

    Generated using TypeDoc

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/papi-dts/types/_shared_models_network_object_model_.LocalObjectToProxyCreator.html b/papi-dts/types/_shared_models_network_object_model_.LocalObjectToProxyCreator.html index af2a3d85c7..30242f1a31 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

    Generated using TypeDoc

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/papi-dts/types/_shared_models_network_object_model_.NetworkObject.html b/papi-dts/types/_shared_models_network_object_model_.NetworkObject.html index 3bb314b6bf..deb553478c 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

    Generated using TypeDoc

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/papi-dts/types/_shared_models_network_object_model_.NetworkObjectDetails.html b/papi-dts/types/_shared_models_network_object_model_.NetworkObjectDetails.html index 215e6082c0..442ebf724d 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

    Generated using TypeDoc

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/papi-dts/types/_shared_models_network_object_model_.NetworkableObject.html b/papi-dts/types/_shared_models_network_object_model_.NetworkableObject.html index dd9362e389..01abc5149e 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

    Generated using TypeDoc

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/papi-dts/types/_shared_models_project_data_provider_engine_model_.ProjectDataProviderEngineTypes.html b/papi-dts/types/_shared_models_project_data_provider_engine_model_.ProjectDataProviderEngineTypes.html index 3e205af5d1..d33bda89bf 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]: "shared/models/data-provider-engine.model".default<ProjectDataTypes[ProjectType]>
    }

    All possible types for ProjectDataProviderEngines: IDataProviderEngine

    -

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/papi-dts/types/_shared_models_project_data_provider_model_.ExtensionDataScope.html b/papi-dts/types/_shared_models_project_data_provider_model_.ExtensionDataScope.html index d10bcea1cf..10aec91461 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

    Generated using TypeDoc

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/papi-dts/types/_shared_models_project_data_provider_model_.MandatoryProjectDataType.html b/papi-dts/types/_shared_models_project_data_provider_model_.MandatoryProjectDataType.html index 70da870cd9..dfbd42fa17 100644 --- a/papi-dts/types/_shared_models_project_data_provider_model_.MandatoryProjectDataType.html +++ b/papi-dts/types/_shared_models_project_data_provider_model_.MandatoryProjectDataType.html @@ -11,4 +11,4 @@ so following this interface ensures your PDP will not break if such a requirement is implemented. -

    Type declaration

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Type declaration

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/papi-dts/types/_shared_models_project_metadata_model_.ProjectMetadata.html b/papi-dts/types/_shared_models_project_metadata_model_.ProjectMetadata.html index f1e4d2aaaf..1f3cf5794c 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

    Generated using TypeDoc

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/papi-dts/types/_shared_models_web_view_model_.GetWebViewDefinitionUpdatableProperties.html b/papi-dts/types/_shared_models_web_view_model_.GetWebViewDefinitionUpdatableProperties.html index 796d167a35..073fc88bae 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)

    Type declaration

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Returns WebViewDefinitionUpdatableProperties | undefined

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/papi-dts/types/_shared_models_web_view_model_.GetWebViewOptions.html b/papi-dts/types/_shared_models_web_view_model_.GetWebViewOptions.html index c1236b9654..6a01225ff8 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

    Generated using TypeDoc

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/papi-dts/types/_shared_models_web_view_model_.SavedWebViewDefinition.html b/papi-dts/types/_shared_models_web_view_model_.SavedWebViewDefinition.html index e10964ed06..fe9c08b300 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

    Generated using TypeDoc

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/papi-dts/types/_shared_models_web_view_model_.UpdateWebViewDefinition.html b/papi-dts/types/_shared_models_web_view_model_.UpdateWebViewDefinition.html index 319ab4e453..9c158ac08a 100644 --- a/papi-dts/types/_shared_models_web_view_model_.UpdateWebViewDefinition.html +++ b/papi-dts/types/_shared_models_web_view_model_.UpdateWebViewDefinition.html @@ -5,4 +5,4 @@

    ＠example

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

    Parameters

    Returns boolean

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Parameters

    Returns boolean

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/papi-dts/types/_shared_models_web_view_model_.UseWebViewStateHook.html b/papi-dts/types/_shared_models_web_view_model_.UseWebViewStateHook.html index 7eb9da5ecd..5eeb804125 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 Parameters

    • T

    Parameters

    • stateKey: string
    • defaultStateValue: T

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

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Type Parameters

    • T

    Parameters

    • stateKey: string
    • defaultStateValue: T

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

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/papi-dts/types/_shared_models_web_view_model_.WebViewDefinition.html b/papi-dts/types/_shared_models_web_view_model_.WebViewDefinition.html index 6d3f0c883e..5397ec23fb 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

    Generated using TypeDoc

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/papi-dts/types/_shared_models_web_view_model_.WebViewDefinitionBase.html b/papi-dts/types/_shared_models_web_view_model_.WebViewDefinitionBase.html index cdecffd5b0..5987fde193 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

    Generated using TypeDoc

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/papi-dts/types/_shared_models_web_view_model_.WebViewDefinitionHtml.html b/papi-dts/types/_shared_models_web_view_model_.WebViewDefinitionHtml.html index 76f6a51f6e..6f922da3b7 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

    Generated using TypeDoc

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/papi-dts/types/_shared_models_web_view_model_.WebViewDefinitionReact.html b/papi-dts/types/_shared_models_web_view_model_.WebViewDefinitionReact.html index 559eee13b7..88d2262ca2 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

    Generated using TypeDoc

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/papi-dts/types/_shared_models_web_view_model_.WebViewDefinitionURL.html b/papi-dts/types/_shared_models_web_view_model_.WebViewDefinitionURL.html index ffeca9330b..97ff6c90aa 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

    Generated using TypeDoc

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/papi-dts/types/_shared_models_web_view_model_.WebViewDefinitionUpdatableProperties.html b/papi-dts/types/_shared_models_web_view_model_.WebViewDefinitionUpdatableProperties.html index 4d0feef14f..ec2a6a86f9 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

    Generated using TypeDoc

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/papi-dts/types/_shared_models_web_view_model_.WebViewDefinitionUpdateInfo.html b/papi-dts/types/_shared_models_web_view_model_.WebViewDefinitionUpdateInfo.html index e02bbd06fb..1c0af06727 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

    Generated using TypeDoc

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/papi-dts/types/_shared_models_web_view_model_.WebViewId.html b/papi-dts/types/_shared_models_web_view_model_.WebViewId.html index c405f7b944..104f747352 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

    Generated using TypeDoc

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/papi-dts/types/_shared_models_web_view_model_.WebViewProps.html b/papi-dts/types/_shared_models_web_view_model_.WebViewProps.html index 91d08f3bea..884ff4e944 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

    Generated using TypeDoc

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/papi-dts/types/_shared_models_web_view_model_.WebViewType.html b/papi-dts/types/_shared_models_web_view_model_.WebViewType.html index b69f6e9989..a3a172f38c 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

    Generated using TypeDoc

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/papi-dts/types/_shared_services_command_service_.moduleSummaryComments.html b/papi-dts/types/_shared_services_command_service_.moduleSummaryComments.html index cacec7f0ea..da5e918ab6 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

      Generated using TypeDoc

      \ No newline at end of file +

      Type declaration

        Settings

        Member Visibility

        Theme

        Generated using TypeDoc

        \ No newline at end of file diff --git a/papi-dts/types/_shared_services_network_service_.ArgsRequestHandler.html b/papi-dts/types/_shared_services_network_service_.ArgsRequestHandler.html index 53b15ef9df..ef3f913351 100644 --- a/papi-dts/types/_shared_services_network_service_.ArgsRequestHandler.html +++ b/papi-dts/types/_shared_services_network_service_.ArgsRequestHandler.html @@ -2,4 +2,4 @@ the spread of the contents array of the request as its parameters. The function should return an object that becomes the contents object of the response. This type of handler is a normal function.

        -

        Parameters

        • Rest ...args: TParam

        Returns Promise<TReturn> | TReturn

        Settings

        Member Visibility

        Theme

        Generated using TypeDoc

        \ No newline at end of file +

        Parameters

        • Rest ...args: TParam

        Returns Promise<TReturn> | TReturn

        Settings

        Member Visibility

        Theme

        Generated using TypeDoc

        \ No newline at end of file diff --git a/papi-dts/types/_shared_services_network_service_.ComplexRequestHandler.html b/papi-dts/types/_shared_services_network_service_.ComplexRequestHandler.html index 8c36fe6d37..a0f51324df 100644 --- a/papi-dts/types/_shared_services_network_service_.ComplexRequestHandler.html +++ b/papi-dts/types/_shared_services_network_service_.ComplexRequestHandler.html @@ -2,4 +2,4 @@ accept a ComplexRequest object as its single parameter. The function should return a ComplexResponse object that becomes the response.. This type of handler is the most flexible of the request handlers.

        -

        Parameters

        Returns Promise<ComplexResponse<TReturn>>

        Settings

        Member Visibility

        Theme

        Generated using TypeDoc

        \ No newline at end of file +

        Parameters

        Returns Promise<ComplexResponse<TReturn>>

        Settings

        Member Visibility

        Theme

        Generated using TypeDoc

        \ No newline at end of file diff --git a/papi-dts/types/_shared_services_network_service_.ContentsRequestHandler.html b/papi-dts/types/_shared_services_network_service_.ContentsRequestHandler.html index 410d38230a..abdc4b7f13 100644 --- a/papi-dts/types/_shared_services_network_service_.ContentsRequestHandler.html +++ b/papi-dts/types/_shared_services_network_service_.ContentsRequestHandler.html @@ -1,4 +1,4 @@ ContentsRequestHandler | papi-dts

        Type alias ContentsRequestHandler<TParam, TReturn>

        ContentsRequestHandler<TParam, TReturn>: ((contents) => Promise<TReturn>)

        Type Parameters

        • TParam = any

        • TReturn = any

        Type declaration

          • (contents): Promise<TReturn>

          • Contents handler function for a request. Called when a request is handled. The function should accept the contents object of the request as its single parameter. The function should return an object that becomes the contents object of the response.

            -

            Parameters

            • contents: TParam

            Returns Promise<TReturn>

        Settings

        Member Visibility

        Theme

        Generated using TypeDoc

        \ No newline at end of file +

        Parameters

        • contents: TParam

        Returns Promise<TReturn>

        Settings

        Member Visibility

        Theme

        Generated using TypeDoc

        \ No newline at end of file diff --git a/papi-dts/types/_shared_services_settings_service_.ResetSettingEvent.html b/papi-dts/types/_shared_services_settings_service_.ResetSettingEvent.html index f9ba5027de..b9d6809a3b 100644 --- a/papi-dts/types/_shared_services_settings_service_.ResetSettingEvent.html +++ b/papi-dts/types/_shared_services_settings_service_.ResetSettingEvent.html @@ -1,2 +1,2 @@ ResetSettingEvent | papi-dts

        Type alias ResetSettingEvent

        ResetSettingEvent: {
            type: "reset-setting";
        }

        Event to remove a setting

        -

        Type declaration

        • type: "reset-setting"

        Settings

        Member Visibility

        Theme

        Generated using TypeDoc

        \ No newline at end of file +

        Type declaration

        • type: "reset-setting"

        Settings

        Member Visibility

        Theme

        Generated using TypeDoc

        \ No newline at end of file diff --git a/papi-dts/types/_shared_services_settings_service_.SettingEvent.html b/papi-dts/types/_shared_services_settings_service_.SettingEvent.html index f08c4a4213..7a362f6339 100644 --- a/papi-dts/types/_shared_services_settings_service_.SettingEvent.html +++ b/papi-dts/types/_shared_services_settings_service_.SettingEvent.html @@ -1,2 +1,2 @@ SettingEvent | papi-dts

        Type alias SettingEvent<SettingName>

        SettingEvent<SettingName>: UpdateSettingEvent<SettingName> | ResetSettingEvent

        All supported setting events

        -

        Type Parameters

        Settings

        Member Visibility

        Theme

        Generated using TypeDoc

        \ No newline at end of file +

        Type Parameters

        Settings

        Member Visibility

        Theme

        Generated using TypeDoc

        \ No newline at end of file diff --git a/papi-dts/types/_shared_services_settings_service_.UpdateSettingEvent.html b/papi-dts/types/_shared_services_settings_service_.UpdateSettingEvent.html index 42f10aaa4c..e2704478f7 100644 --- a/papi-dts/types/_shared_services_settings_service_.UpdateSettingEvent.html +++ b/papi-dts/types/_shared_services_settings_service_.UpdateSettingEvent.html @@ -1,2 +1,2 @@ UpdateSettingEvent | papi-dts

        Type alias UpdateSettingEvent<SettingName>

        UpdateSettingEvent<SettingName>: {
            setting: SettingTypes[SettingName];
            type: "update-setting";
        }

        Event to set or update a setting

        -

        Type Parameters

        Type declaration

        Settings

        Member Visibility

        Theme

        Generated using TypeDoc

        \ No newline at end of file +

        Type Parameters

        Type declaration

        Settings

        Member Visibility

        Theme

        Generated using TypeDoc

        \ 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 092e61ac3b..b4567ab8be 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

        Generated using TypeDoc

        \ No newline at end of file +

        Settings

        Member Visibility

        Theme

        Generated using TypeDoc

        \ 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 bec053a360..ea5fa5f8e1 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

        Generated using TypeDoc

        \ No newline at end of file +

        Type Parameters

        • TReturn = unknown

        Settings

        Member Visibility

        Theme

        Generated using TypeDoc

        \ 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 2207e3c0c7..c17bfe92dc 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

        Generated using TypeDoc

        \ No newline at end of file +

        Settings

        Member Visibility

        Theme

        Generated using TypeDoc

        \ 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 0d04cd9b8a..5aa9a136fe 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

        Generated using TypeDoc

        \ No newline at end of file +

        Settings

        Member Visibility

        Theme

        Generated using TypeDoc

        \ 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 a2be1ca90b..50d32fcb68 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

        Generated using TypeDoc

        \ No newline at end of file +

        Settings

        Member Visibility

        Theme

        Generated using TypeDoc

        \ 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 bd6811f0b6..9ccd2778a6 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

        Generated using TypeDoc

        \ No newline at end of file +

        Settings

        Member Visibility

        Theme

        Generated using TypeDoc

        \ No newline at end of file diff --git a/papi-dts/variables/__papi_backend_.DataProviderEngine.html b/papi-dts/variables/__papi_backend_.DataProviderEngine.html index ce4f0edd1c..b1cda95582 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

        Generated using TypeDoc

        \ No newline at end of file +

        Settings

        Member Visibility

        Theme

        Generated using TypeDoc

        \ No newline at end of file diff --git a/papi-dts/variables/__papi_backend_.commands.html b/papi-dts/variables/__papi_backend_.commands.html index a65e3df1de..8f1394c97f 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

        Generated using TypeDoc

        \ No newline at end of file +

        Settings

        Member Visibility

        Theme

        Generated using TypeDoc

        \ No newline at end of file diff --git a/papi-dts/variables/__papi_backend_.dataProviders.html b/papi-dts/variables/__papi_backend_.dataProviders.html index 8b0f900e8f..1e7308647a 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

        Generated using TypeDoc

        \ No newline at end of file +

        Settings

        Member Visibility

        Theme

        Generated using TypeDoc

        \ No newline at end of file diff --git a/papi-dts/variables/__papi_backend_.default.html b/papi-dts/variables/__papi_backend_.default.html index b0646c158b..71db1fbc82 100644 --- a/papi-dts/variables/__papi_backend_.default.html +++ b/papi-dts/variables/__papi_backend_.default.html @@ -20,4 +20,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

        Generated using TypeDoc

        \ No newline at end of file +

        Settings

        Member Visibility

        Theme

        Generated using TypeDoc

        \ No newline at end of file diff --git a/papi-dts/variables/__papi_backend_.dialogs.html b/papi-dts/variables/__papi_backend_.dialogs.html index 53e70dd4d7..36a9837131 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

        Generated using TypeDoc

        \ No newline at end of file +

        Settings

        Member Visibility

        Theme

        Generated using TypeDoc

        \ No newline at end of file diff --git a/papi-dts/variables/__papi_backend_.internet.html b/papi-dts/variables/__papi_backend_.internet.html index 678e432c43..fe3dfe46e0 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

        Generated using TypeDoc

        \ No newline at end of file +

        Settings

        Member Visibility

        Theme

        Generated using TypeDoc

        \ No newline at end of file diff --git a/papi-dts/variables/__papi_backend_.logger.html b/papi-dts/variables/__papi_backend_.logger.html index 1f88aabe36..17064b4600 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

        Generated using TypeDoc

        \ No newline at end of file +

        Type declaration

        • default: MainLogger

        Settings

        Member Visibility

        Theme

        Generated using TypeDoc

        \ No newline at end of file diff --git a/papi-dts/variables/__papi_backend_.network.html b/papi-dts/variables/__papi_backend_.network.html index d3be7512e2..e5ef9caa23 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

        Generated using TypeDoc

        \ No newline at end of file +

        Settings

        Member Visibility

        Theme

        Generated using TypeDoc

        \ No newline at end of file diff --git a/papi-dts/variables/__papi_backend_.projectDataProviders.html b/papi-dts/variables/__papi_backend_.projectDataProviders.html index a5f47f6c1c..7323dad4eb 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

        Generated using TypeDoc

        \ No newline at end of file +

        Settings

        Member Visibility

        Theme

        Generated using TypeDoc

        \ No newline at end of file diff --git a/papi-dts/variables/__papi_backend_.projectLookup.html b/papi-dts/variables/__papi_backend_.projectLookup.html index 1d67ea7f6b..19cd9545e6 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

        Generated using TypeDoc

        \ No newline at end of file +

        Settings

        Member Visibility

        Theme

        Generated using TypeDoc

        \ No newline at end of file diff --git a/papi-dts/variables/__papi_backend_.storage.html b/papi-dts/variables/__papi_backend_.storage.html index 0f66b62e2b..994691e156 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

        Generated using TypeDoc

        \ No newline at end of file +

        Settings

        Member Visibility

        Theme

        Generated using TypeDoc

        \ No newline at end of file diff --git a/papi-dts/variables/__papi_backend_.webViewProviders.html b/papi-dts/variables/__papi_backend_.webViewProviders.html index 9501375228..5643369c07 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

        Generated using TypeDoc

        \ No newline at end of file +

        Settings

        Member Visibility

        Theme

        Generated using TypeDoc

        \ No newline at end of file diff --git a/papi-dts/variables/__papi_backend_.webViews.html b/papi-dts/variables/__papi_backend_.webViews.html index d22d620fda..c8bace1dd9 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

        Generated using TypeDoc

        \ No newline at end of file +

        Settings

        Member Visibility

        Theme

        Generated using TypeDoc

        \ No newline at end of file diff --git a/papi-dts/variables/__papi_core_.default.html b/papi-dts/variables/__papi_core_.default.html index 7c19b8d9aa..477ca986eb 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

          Generated using TypeDoc

          \ No newline at end of file +

          Type declaration

            Settings

            Member Visibility

            Theme

            Generated using TypeDoc

            \ No newline at end of file diff --git a/papi-dts/variables/__papi_frontend_.WebSocket.html b/papi-dts/variables/__papi_frontend_.WebSocket.html index 042d616f85..88f797fdc0 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

            Generated using TypeDoc

            \ No newline at end of file +

            Settings

            Member Visibility

            Theme

            Generated using TypeDoc

            \ No newline at end of file diff --git a/papi-dts/variables/__papi_frontend_.XMLHttpRequest.html b/papi-dts/variables/__papi_frontend_.XMLHttpRequest.html index f92dbbb0a9..710e38f752 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

            Generated using TypeDoc

            \ No newline at end of file +

            Settings

            Member Visibility

            Theme

            Generated using TypeDoc

            \ No newline at end of file diff --git a/papi-dts/variables/__papi_frontend_.commands.html b/papi-dts/variables/__papi_frontend_.commands.html index e015b7cd22..21e91ab9a4 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

            Generated using TypeDoc

            \ No newline at end of file +

            Settings

            Member Visibility

            Theme

            Generated using TypeDoc

            \ No newline at end of file diff --git a/papi-dts/variables/__papi_frontend_.dataProviders.html b/papi-dts/variables/__papi_frontend_.dataProviders.html index 7280a46a13..08c29fe1c7 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

            Generated using TypeDoc

            \ No newline at end of file +

            Settings

            Member Visibility

            Theme

            Generated using TypeDoc

            \ No newline at end of file diff --git a/papi-dts/variables/__papi_frontend_.default.html b/papi-dts/variables/__papi_frontend_.default.html index 3c02ac020c..c974e998db 100644 --- a/papi-dts/variables/__papi_frontend_.default.html +++ b/papi-dts/variables/__papi_frontend_.default.html @@ -22,4 +22,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

            Generated using TypeDoc

            \ No newline at end of file +

            Settings

            Member Visibility

            Theme

            Generated using TypeDoc

            \ No newline at end of file diff --git a/papi-dts/variables/__papi_frontend_.dialogs.html b/papi-dts/variables/__papi_frontend_.dialogs.html index 42f8ff698c..38db9b24e9 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

            Generated using TypeDoc

            \ No newline at end of file +

            Settings

            Member Visibility

            Theme

            Generated using TypeDoc

            \ No newline at end of file diff --git a/papi-dts/variables/__papi_frontend_.internet.html b/papi-dts/variables/__papi_frontend_.internet.html index d2b690c8e6..1d845cc017 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

            Generated using TypeDoc

            \ No newline at end of file +

            Settings

            Member Visibility

            Theme

            Generated using TypeDoc

            \ No newline at end of file diff --git a/papi-dts/variables/__papi_frontend_.logger.html b/papi-dts/variables/__papi_frontend_.logger.html index be5d7177ce..50b5d9c4b6 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

            Generated using TypeDoc

            \ No newline at end of file +

            Type declaration

            • default: MainLogger

            Settings

            Member Visibility

            Theme

            Generated using TypeDoc

            \ No newline at end of file diff --git a/papi-dts/variables/__papi_frontend_.network.html b/papi-dts/variables/__papi_frontend_.network.html index 2418f5b456..26f49906cc 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

            Generated using TypeDoc

            \ No newline at end of file +

            Settings

            Member Visibility

            Theme

            Generated using TypeDoc

            \ No newline at end of file diff --git a/papi-dts/variables/__papi_frontend_.projectDataProviders.html b/papi-dts/variables/__papi_frontend_.projectDataProviders.html index 89545c8702..c52bfe2656 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

            Generated using TypeDoc

            \ No newline at end of file +

            Settings

            Member Visibility

            Theme

            Generated using TypeDoc

            \ No newline at end of file diff --git a/papi-dts/variables/__papi_frontend_.projectLookup.html b/papi-dts/variables/__papi_frontend_.projectLookup.html index 2f49693f31..d0734ee905 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

            Generated using TypeDoc

            \ No newline at end of file +

            Settings

            Member Visibility

            Theme

            Generated using TypeDoc

            \ No newline at end of file diff --git a/papi-dts/variables/__papi_frontend_.react.html b/papi-dts/variables/__papi_frontend_.react.html index de733cf16d..888c706abd 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

            Generated using TypeDoc

            \ No newline at end of file +

            Settings

            Member Visibility

            Theme

            Generated using TypeDoc

            \ No newline at end of file diff --git a/papi-dts/variables/__papi_frontend_.settings.html b/papi-dts/variables/__papi_frontend_.settings.html index 8711664b4f..348f5ea2e1 100644 --- a/papi-dts/variables/__papi_frontend_.settings.html +++ b/papi-dts/variables/__papi_frontend_.settings.html @@ -1,2 +1,2 @@ settings | papi-dts

            Variable settingsConst

            settings: SettingsService

            Service that allows to get and set settings in local storage

            -

            Settings

            Member Visibility

            Theme

            Generated using TypeDoc

            \ No newline at end of file +

            Settings

            Member Visibility

            Theme

            Generated using TypeDoc

            \ No newline at end of file diff --git a/papi-dts/variables/__papi_frontend_.webViews.html b/papi-dts/variables/__papi_frontend_.webViews.html index 64e53cd021..f05f451bec 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

            Generated using TypeDoc

            \ No newline at end of file +

            Settings

            Member Visibility

            Theme

            Generated using TypeDoc

            \ No newline at end of file diff --git a/papi-dts/variables/_extension_host_services_extension_storage_service_.default.html b/papi-dts/variables/_extension_host_services_extension_storage_service_.default.html index c8a9637219..d7ed97e9cf 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

            Generated using TypeDoc

            \ No newline at end of file +

            Settings

            Member Visibility

            Theme

            Generated using TypeDoc

            \ No newline at end of file diff --git a/papi-dts/variables/_node_services_execution_token_service_.default.html b/papi-dts/variables/_node_services_execution_token_service_.default.html index 89aa2b0a0e..fd8afdb563 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

            Generated using TypeDoc

            \ 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

            Generated using TypeDoc

            \ No newline at end of file diff --git a/papi-dts/variables/_node_utils_util_.FILE_PROTOCOL.html b/papi-dts/variables/_node_utils_util_.FILE_PROTOCOL.html index d66fbe4201..4f9dffb9ab 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: string

            Settings

            Member Visibility

            Theme

            Generated using TypeDoc

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

            Variable FILE_PROTOCOLConst

            FILE_PROTOCOL: string

            Settings

            Member Visibility

            Theme

            Generated using TypeDoc

            \ No newline at end of file diff --git a/papi-dts/variables/_node_utils_util_.RESOURCES_PROTOCOL.html b/papi-dts/variables/_node_utils_util_.RESOURCES_PROTOCOL.html index 4ac67af2b1..35f1b1a10d 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: string

            Settings

            Member Visibility

            Theme

            Generated using TypeDoc

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

            Variable RESOURCES_PROTOCOLConst

            RESOURCES_PROTOCOL: string

            Settings

            Member Visibility

            Theme

            Generated using TypeDoc

            \ No newline at end of file diff --git a/papi-dts/variables/_renderer_components_dialogs_dialog_base_data_.default.html b/papi-dts/variables/_renderer_components_dialogs_dialog_base_data_.default.html index cecb1261fd..1436d0c5c9 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

            Generated using TypeDoc

            \ No newline at end of file +

            Settings

            Member Visibility

            Theme

            Generated using TypeDoc

            \ No newline at end of file diff --git a/papi-dts/variables/_renderer_components_dialogs_dialog_definition_model_.SELECT_MULTIPLE_PROJECTS_DIALOG_TYPE.html b/papi-dts/variables/_renderer_components_dialogs_dialog_definition_model_.SELECT_MULTIPLE_PROJECTS_DIALOG_TYPE.html index 2e418cd6fb..be854f6628 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

            Generated using TypeDoc

            \ No newline at end of file +

            Settings

            Member Visibility

            Theme

            Generated using TypeDoc

            \ No newline at end of file diff --git a/papi-dts/variables/_renderer_components_dialogs_dialog_definition_model_.SELECT_PROJECT_DIALOG_TYPE.html b/papi-dts/variables/_renderer_components_dialogs_dialog_definition_model_.SELECT_PROJECT_DIALOG_TYPE.html index 815eec1b5e..3d838207c7 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

            Generated using TypeDoc

            \ No newline at end of file +

            Settings

            Member Visibility

            Theme

            Generated using TypeDoc

            \ No newline at end of file diff --git a/papi-dts/variables/_shared_data_internal_connection_model_.CATEGORY_COMMAND.html b/papi-dts/variables/_shared_data_internal_connection_model_.CATEGORY_COMMAND.html index e0e1e1474a..3571690323 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

            Generated using TypeDoc

            \ No newline at end of file +

            Settings

            Member Visibility

            Theme

            Generated using TypeDoc

            \ No newline at end of file diff --git a/papi-dts/variables/_shared_data_internal_connection_model_.CLIENT_ID_SERVER.html b/papi-dts/variables/_shared_data_internal_connection_model_.CLIENT_ID_SERVER.html index bd1a6ca1ff..804667e16a 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

            Generated using TypeDoc

            \ No newline at end of file +

            Settings

            Member Visibility

            Theme

            Generated using TypeDoc

            \ No newline at end of file diff --git a/papi-dts/variables/_shared_data_internal_connection_model_.CLIENT_ID_UNASSIGNED.html b/papi-dts/variables/_shared_data_internal_connection_model_.CLIENT_ID_UNASSIGNED.html index 4f5fd0bd7a..c9f1006755 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

            Generated using TypeDoc

            \ No newline at end of file +

            Settings

            Member Visibility

            Theme

            Generated using TypeDoc

            \ No newline at end of file diff --git a/papi-dts/variables/_shared_data_internal_connection_model_.CONNECTOR_INFO_DISCONNECTED.html b/papi-dts/variables/_shared_data_internal_connection_model_.CONNECTOR_INFO_DISCONNECTED.html index dda3539d27..d4513ae9f9 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

            Generated using TypeDoc

            \ No newline at end of file +

            Type declaration

            • clientId: -1

            Settings

            Member Visibility

            Theme

            Generated using TypeDoc

            \ No newline at end of file diff --git a/papi-dts/variables/_shared_data_network_connector_model_.WEBSOCKET_ATTEMPTS_MAX.html b/papi-dts/variables/_shared_data_network_connector_model_.WEBSOCKET_ATTEMPTS_MAX.html index 4b7d6869dd..f1f6172ef4 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

            Generated using TypeDoc

            \ No newline at end of file +

            Settings

            Member Visibility

            Theme

            Generated using TypeDoc

            \ No newline at end of file diff --git a/papi-dts/variables/_shared_data_network_connector_model_.WEBSOCKET_ATTEMPTS_WAIT.html b/papi-dts/variables/_shared_data_network_connector_model_.WEBSOCKET_ATTEMPTS_WAIT.html index 0f554f09c8..c786593a80 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

            Generated using TypeDoc

            \ No newline at end of file +

            Settings

            Member Visibility

            Theme

            Generated using TypeDoc

            \ No newline at end of file diff --git a/papi-dts/variables/_shared_data_network_connector_model_.WEBSOCKET_PORT.html b/papi-dts/variables/_shared_data_network_connector_model_.WEBSOCKET_PORT.html index b5db806978..63a491ee4e 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

            Generated using TypeDoc

            \ No newline at end of file +

            Settings

            Member Visibility

            Theme

            Generated using TypeDoc

            \ No newline at end of file diff --git a/papi-dts/variables/_shared_services_data_provider_service_.default.html b/papi-dts/variables/_shared_services_data_provider_service_.default.html index b3ed457ce1..6c02599147 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

            Generated using TypeDoc

            \ No newline at end of file +

            Settings

            Member Visibility

            Theme

            Generated using TypeDoc

            \ No newline at end of file diff --git a/papi-dts/variables/_shared_services_dialog_service_.default.html b/papi-dts/variables/_shared_services_dialog_service_.default.html index b38a32079a..9e7d48af1a 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

            Generated using TypeDoc

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

            Variable defaultConst

            default: DialogService

            Settings

            Member Visibility

            Theme

            Generated using TypeDoc

            \ No newline at end of file diff --git a/papi-dts/variables/_shared_services_dialog_service_model_.CATEGORY_DIALOG.html b/papi-dts/variables/_shared_services_dialog_service_model_.CATEGORY_DIALOG.html index c4ac446174..353a214fff 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

            Generated using TypeDoc

            \ No newline at end of file +

            Settings

            Member Visibility

            Theme

            Generated using TypeDoc

            \ No newline at end of file diff --git a/papi-dts/variables/_shared_services_internet_service_.default.html b/papi-dts/variables/_shared_services_internet_service_.default.html index e14e9a3205..2ed16a2259 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

            Generated using TypeDoc

            \ No newline at end of file +

            Settings

            Member Visibility

            Theme

            Generated using TypeDoc

            \ No newline at end of file diff --git a/papi-dts/variables/_shared_services_logger_service_.WARN_TAG.html b/papi-dts/variables/_shared_services_logger_service_.WARN_TAG.html index cceec41f1e..8a2d0f6680 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

            Generated using TypeDoc

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

            Variable WARN_TAGConst

            WARN_TAG: "<WARN>" = '<WARN>'

            Settings

            Member Visibility

            Theme

            Generated using TypeDoc

            \ No newline at end of file diff --git a/papi-dts/variables/_shared_services_logger_service_.default.html b/papi-dts/variables/_shared_services_logger_service_.default.html index e5341bfd65..c7d2fd8072 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

            Generated using TypeDoc

            \ No newline at end of file +

            Type declaration

            • default: log.MainLogger

            Settings

            Member Visibility

            Theme

            Generated using TypeDoc

            \ No newline at end of file diff --git a/papi-dts/variables/_shared_services_network_object_service_.default.html b/papi-dts/variables/_shared_services_network_object_service_.default.html index 2498a41301..e756218b7a 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

            Generated using TypeDoc

            \ No newline at end of file +

            Settings

            Member Visibility

            Theme

            Generated using TypeDoc

            \ No newline at end of file diff --git a/papi-dts/variables/_shared_services_network_object_status_service_.default.html b/papi-dts/variables/_shared_services_network_object_status_service_.default.html index 3ea2c53aa3..75728e8a1c 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

            Generated using TypeDoc

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

            Variable defaultConst

            default: NetworkObjectStatusServiceType

            Settings

            Member Visibility

            Theme

            Generated using TypeDoc

            \ No newline at end of file diff --git a/papi-dts/variables/_shared_services_network_object_status_service_model_.networkObjectStatusServiceNetworkObjectName.html b/papi-dts/variables/_shared_services_network_object_status_service_model_.networkObjectStatusServiceNetworkObjectName.html index e8edb33fed..a102fe37c4 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

            Generated using TypeDoc

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

            Variable networkObjectStatusServiceNetworkObjectNameConst

            networkObjectStatusServiceNetworkObjectName: "NetworkObjectStatusService" = 'NetworkObjectStatusService'

            Settings

            Member Visibility

            Theme

            Generated using TypeDoc

            \ No newline at end of file diff --git a/papi-dts/variables/_shared_services_network_service_.papiNetworkService-1.html b/papi-dts/variables/_shared_services_network_service_.papiNetworkService-1.html index 239523d9cd..8bbb8e1339 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

            Generated using TypeDoc

            \ No newline at end of file +

            Settings

            Member Visibility

            Theme

            Generated using TypeDoc

            \ No newline at end of file diff --git a/papi-dts/variables/_shared_services_project_data_provider_service_.papiBackendProjectDataProviderService-1.html b/papi-dts/variables/_shared_services_project_data_provider_service_.papiBackendProjectDataProviderService-1.html index b2d1b291f9..2ed186887d 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

            Generated using TypeDoc

            \ No newline at end of file +

            Settings

            Member Visibility

            Theme

            Generated using TypeDoc

            \ No newline at end of file diff --git a/papi-dts/variables/_shared_services_project_data_provider_service_.papiFrontendProjectDataProviderService-1.html b/papi-dts/variables/_shared_services_project_data_provider_service_.papiFrontendProjectDataProviderService-1.html index d408daef23..a7e1272f03 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

            Generated using TypeDoc

            \ No newline at end of file +

            Type declaration

            • get: typeof get

            Settings

            Member Visibility

            Theme

            Generated using TypeDoc

            \ No newline at end of file diff --git a/papi-dts/variables/_shared_services_project_lookup_service_.default.html b/papi-dts/variables/_shared_services_project_lookup_service_.default.html index 0597826c0d..6ac99e3083 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

            Generated using TypeDoc

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

            Variable defaultConst

            default: ProjectLookupServiceType

            Settings

            Member Visibility

            Theme

            Generated using TypeDoc

            \ No newline at end of file diff --git a/papi-dts/variables/_shared_services_project_lookup_service_model_.projectLookupServiceNetworkObjectName.html b/papi-dts/variables/_shared_services_project_lookup_service_model_.projectLookupServiceNetworkObjectName.html index de2a634327..aee193ead1 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

            Generated using TypeDoc

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

            Variable projectLookupServiceNetworkObjectNameConst

            projectLookupServiceNetworkObjectName: "ProjectLookupService" = 'ProjectLookupService'

            Settings

            Member Visibility

            Theme

            Generated using TypeDoc

            \ No newline at end of file diff --git a/papi-dts/variables/_shared_services_settings_service_.default.html b/papi-dts/variables/_shared_services_settings_service_.default.html index e7e09b2d6f..db5c75c25c 100644 --- a/papi-dts/variables/_shared_services_settings_service_.default.html +++ b/papi-dts/variables/_shared_services_settings_service_.default.html @@ -1,2 +1,2 @@ default | papi-dts

            Variable defaultConst

            default: SettingsService

            Service that allows to get and set settings in local storage

            -

            Settings

            Member Visibility

            Theme

            Generated using TypeDoc

            \ No newline at end of file +

            Settings

            Member Visibility

            Theme

            Generated using TypeDoc

            \ No newline at end of file diff --git a/papi-dts/variables/_shared_services_web_view_provider_service_.default.html b/papi-dts/variables/_shared_services_web_view_provider_service_.default.html index 0612e81d16..6f38344a50 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

            Generated using TypeDoc

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

            Variable defaultConst

            default: WebViewProviderService

            Settings

            Member Visibility

            Theme

            Generated using TypeDoc

            \ No newline at end of file diff --git a/papi-dts/variables/_shared_services_web_view_provider_service_.papiWebViewProviderService-1.html b/papi-dts/variables/_shared_services_web_view_provider_service_.papiWebViewProviderService-1.html index 16971d7907..5f783b6a9b 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

            Generated using TypeDoc

            \ No newline at end of file +

            Settings

            Member Visibility

            Theme

            Generated using TypeDoc

            \ No newline at end of file diff --git a/papi-dts/variables/_shared_services_web_view_service_.default.html b/papi-dts/variables/_shared_services_web_view_service_.default.html index d252b16071..95cea4ee3c 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

            Generated using TypeDoc

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

            Variable defaultConst

            default: WebViewServiceType

            Settings

            Member Visibility

            Theme

            Generated using TypeDoc

            \ No newline at end of file diff --git a/papi-dts/variables/_shared_services_web_view_service_model_.EVENT_NAME_ON_DID_ADD_WEB_VIEW.html b/papi-dts/variables/_shared_services_web_view_service_model_.EVENT_NAME_ON_DID_ADD_WEB_VIEW.html index e789566d77..f457cfc133 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

            Generated using TypeDoc

            \ No newline at end of file +

            Settings

            Member Visibility

            Theme

            Generated using TypeDoc

            \ No newline at end of file diff --git a/papi-dts/variables/_shared_services_web_view_service_model_.NETWORK_OBJECT_NAME_WEB_VIEW_SERVICE.html b/papi-dts/variables/_shared_services_web_view_service_model_.NETWORK_OBJECT_NAME_WEB_VIEW_SERVICE.html index 41c8ee0c4a..92b51ac93c 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

            Generated using TypeDoc

            \ 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

            Generated using TypeDoc

            \ 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 256d73ab4d..c3212421fe 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

            Generated using TypeDoc

            \ No newline at end of file +

            Type declaration

            • [moduleName: string]: string | {
                  [process in ProcessType | "default"]?: string
              } | undefined

            Settings

            Member Visibility

            Theme

            Generated using TypeDoc

            \ 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 701000e3df..b0e9c6cc9e 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

            Generated using TypeDoc

            \ No newline at end of file +

            Settings

            Member Visibility

            Theme

            Generated using TypeDoc

            \ No newline at end of file diff --git a/papi-dts/variables/isPackaged.html b/papi-dts/variables/isPackaged.html index 28cb39cb72..ba20a906e0 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

            Generated using TypeDoc

            \ No newline at end of file +

            Settings

            Member Visibility

            Theme

            Generated using TypeDoc

            \ No newline at end of file diff --git a/papi-dts/variables/logLevel.html b/papi-dts/variables/logLevel.html index 39cfffefe0..cc140a991f 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

            Generated using TypeDoc

            \ No newline at end of file +

            Settings

            Member Visibility

            Theme

            Generated using TypeDoc

            \ No newline at end of file diff --git a/papi-dts/variables/processType.html b/papi-dts/variables/processType.html index be425b7244..1580498912 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

            Generated using TypeDoc

            \ No newline at end of file +

            Settings

            Member Visibility

            Theme

            Generated using TypeDoc

            \ No newline at end of file diff --git a/papi-dts/variables/resourcesPath.html b/papi-dts/variables/resourcesPath.html index b327c1467a..c168827a9f 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

            Generated using TypeDoc

            \ No newline at end of file +

            Settings

            Member Visibility

            Theme

            Generated using TypeDoc

            \ No newline at end of file diff --git a/platform-bible-react/enums/LabelPosition.html b/platform-bible-react/enums/LabelPosition.html index 769f3c4536..7f8a81b647 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

            Generated using TypeDoc

            \ 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

            Generated using TypeDoc

            \ No newline at end of file diff --git a/platform-bible-react/functions/Button.html b/platform-bible-react/functions/Button.html index 0bf206c201..a55cc46214 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

            Generated using TypeDoc

            \ No newline at end of file +

            Parameters

            Returns Element

            Settings

            Member Visibility

            Theme

            Generated using TypeDoc

            \ No newline at end of file diff --git a/platform-bible-react/functions/ChapterRangeSelector.html b/platform-bible-react/functions/ChapterRangeSelector.html index 6fa56b4cf1..778db605ee 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

            Generated using TypeDoc

            \ No newline at end of file +ChapterRangeSelector | platform-bible-react

            Function ChapterRangeSelector

            Settings

            Member Visibility

            Theme

            Generated using TypeDoc

            \ No newline at end of file diff --git a/platform-bible-react/functions/Checkbox.html b/platform-bible-react/functions/Checkbox.html index 7a3fe5bf45..31e8d85a02 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

            Generated using TypeDoc

            \ No newline at end of file +

            Parameters

            Returns Element

            Settings

            Member Visibility

            Theme

            Generated using TypeDoc

            \ No newline at end of file diff --git a/platform-bible-react/functions/ComboBox.html b/platform-bible-react/functions/ComboBox.html index 4ab985f1b7..2140ab7a35 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

            Generated using TypeDoc

            \ No newline at end of file +

            Type Parameters

            Parameters

            Returns Element

            Settings

            Member Visibility

            Theme

            Generated using TypeDoc

            \ No newline at end of file diff --git a/platform-bible-react/functions/GridMenu.html b/platform-bible-react/functions/GridMenu.html index 11907222db..2333a41a89 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

            Generated using TypeDoc

            \ No newline at end of file +GridMenu | platform-bible-react

            Function GridMenu

            Settings

            Member Visibility

            Theme

            Generated using TypeDoc

            \ No newline at end of file diff --git a/platform-bible-react/functions/IconButton.html b/platform-bible-react/functions/IconButton.html index 7c2570afc7..c1bf660182 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

            Generated using TypeDoc

            \ No newline at end of file +

            Parameters

            Returns Element

            Settings

            Member Visibility

            Theme

            Generated using TypeDoc

            \ No newline at end of file diff --git a/platform-bible-react/functions/MenuItem.html b/platform-bible-react/functions/MenuItem.html index 82a0db4a21..6f5b152c80 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

            Generated using TypeDoc

            \ No newline at end of file +MenuItem | platform-bible-react

            Function MenuItem

            Settings

            Member Visibility

            Theme

            Generated using TypeDoc

            \ No newline at end of file diff --git a/platform-bible-react/functions/RefSelector.html b/platform-bible-react/functions/RefSelector.html index 9deb45ee71..0bf7f3a289 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

            Generated using TypeDoc

            \ No newline at end of file +RefSelector | platform-bible-react

            Function RefSelector

            Settings

            Member Visibility

            Theme

            Generated using TypeDoc

            \ No newline at end of file diff --git a/platform-bible-react/functions/SearchBar.html b/platform-bible-react/functions/SearchBar.html index de47a22911..582f4c6315 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

            Generated using TypeDoc

            \ No newline at end of file +SearchBar | platform-bible-react

            Function SearchBar

            Settings

            Member Visibility

            Theme

            Generated using TypeDoc

            \ No newline at end of file diff --git a/platform-bible-react/functions/Slider.html b/platform-bible-react/functions/Slider.html index 366724104b..575859abb5 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

            Generated using TypeDoc

            \ No newline at end of file +

            Parameters

            Returns Element

            Settings

            Member Visibility

            Theme

            Generated using TypeDoc

            \ No newline at end of file diff --git a/platform-bible-react/functions/Snackbar.html b/platform-bible-react/functions/Snackbar.html index 4adcccf0ec..668c0408af 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

            Generated using TypeDoc

            \ No newline at end of file +

            Parameters

            Returns Element

            Settings

            Member Visibility

            Theme

            Generated using TypeDoc

            \ No newline at end of file diff --git a/platform-bible-react/functions/Switch.html b/platform-bible-react/functions/Switch.html index 6481ce0a5f..27c84c24c3 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

            Generated using TypeDoc

            \ No newline at end of file +

            Parameters

            Returns Element

            Settings

            Member Visibility

            Theme

            Generated using TypeDoc

            \ No newline at end of file diff --git a/platform-bible-react/functions/Table.html b/platform-bible-react/functions/Table.html index 76a057b9a6..788a2c4021 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

            Generated using TypeDoc

            \ No newline at end of file +

            Type Parameters

            • R

            Parameters

            Returns Element

            Settings

            Member Visibility

            Theme

            Generated using TypeDoc

            \ No newline at end of file diff --git a/platform-bible-react/functions/TextField.html b/platform-bible-react/functions/TextField.html index d50a4bf445..a88b826ec7 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

            Generated using TypeDoc

            \ No newline at end of file +

            Parameters

            Returns Element

            Settings

            Member Visibility

            Theme

            Generated using TypeDoc

            \ No newline at end of file diff --git a/platform-bible-react/functions/Toolbar.html b/platform-bible-react/functions/Toolbar.html index a4d2e6bda3..6f9429186b 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

            Generated using TypeDoc

            \ No newline at end of file +Toolbar | platform-bible-react

            Function Toolbar

            Settings

            Member Visibility

            Theme

            Generated using TypeDoc

            \ No newline at end of file diff --git a/platform-bible-react/functions/useEvent.html b/platform-bible-react/functions/useEvent.html index db3a7657bb..b0b579b366 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

            Generated using TypeDoc

            \ No newline at end of file +

            Returns void

            Settings

            Member Visibility

            Theme

            Generated using TypeDoc

            \ No newline at end of file diff --git a/platform-bible-react/functions/useEventAsync.html b/platform-bible-react/functions/useEventAsync.html index 234ae39b06..8c8e688ba3 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

            Generated using TypeDoc

            \ No newline at end of file +

            Returns void

            Settings

            Member Visibility

            Theme

            Generated using TypeDoc

            \ No newline at end of file diff --git a/platform-bible-react/functions/usePromise.html b/platform-bible-react/functions/usePromise.html index 8341675096..55d1b48642 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

            Generated using TypeDoc

            \ No newline at end of file +

            Settings

            Member Visibility

            Theme

            Generated using TypeDoc

            \ No newline at end of file diff --git a/platform-bible-react/interfaces/CommandHandler.html b/platform-bible-react/interfaces/CommandHandler.html index 59b31a3a04..ab10b9d2b5 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

            Generated using TypeDoc

            \ No newline at end of file +CommandHandler | platform-bible-react

            Interface CommandHandler

            interface CommandHandler ((command) => void)

            Settings

            Member Visibility

            Theme

            Generated using TypeDoc

            \ No newline at end of file diff --git a/platform-bible-react/interfaces/ScrRefSelectorProps.html b/platform-bible-react/interfaces/ScrRefSelectorProps.html index c33d347db1..6192e0d8ba 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

            Generated using TypeDoc

            \ 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

            Generated using TypeDoc

            \ No newline at end of file diff --git a/platform-bible-react/interfaces/TableCalculatedColumn.html b/platform-bible-react/interfaces/TableCalculatedColumn.html index 26b11cfb4e..3c071bc4d3 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 {
                editable?: null | boolean | ((row) => boolean);
                frozen: boolean;
                idx: number;
                isLastFrozenColumn: boolean;
                key: string;
                maxWidth: undefined | number;
                minWidth: number;
                name: string | ReactElement<any, string | JSXElementConstructor<any>>;
                renderCell: ((props) => ReactNode);
                renderEditCell?: null | ((props) => ReactNode);
                resizable: boolean;
                rowGroup: boolean;
                sortDescendingFirst?: null | boolean;
                sortable: boolean;
                width: string | number;
            }

            Type Parameters

            • R

            Hierarchy

            Properties

            editable? +TableCalculatedColumn | platform-bible-react

            Interface TableCalculatedColumn<R>

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

            Type Parameters

            • R

            Hierarchy

            Properties

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

            -

            Type declaration

              • (row): boolean

              • Parameters

                • row: R

                Returns boolean

            Readonly frozen

            frozen: boolean

            Readonly idx

            idx: number

            Readonly isLastFrozenColumn

            isLastFrozenColumn: boolean

            Readonly key

            key: string

            A unique key to distinguish each column

            -

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

            Readonly rowGroup

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

            Readonly rowGroup

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

            Generated using TypeDoc

            \ No newline at end of file +

            Readonly sortable

            sortable: boolean

            Readonly width

            width: string | number

            Settings

            Member Visibility

            Theme

            On This Page

            Generated using TypeDoc

            \ No newline at end of file diff --git a/platform-bible-react/interfaces/ToolbarDataHandler.html b/platform-bible-react/interfaces/ToolbarDataHandler.html index 2dbbb914d2..3b5b8b54c8 100644 --- a/platform-bible-react/interfaces/ToolbarDataHandler.html +++ b/platform-bible-react/interfaces/ToolbarDataHandler.html @@ -1 +1 @@ -ToolbarDataHandler | platform-bible-react

            Interface ToolbarDataHandler

            interface ToolbarDataHandler ((isSupportAndDevelopment) => GridMenuInfo)

            Settings

            Member Visibility

            Theme

            Generated using TypeDoc

            \ No newline at end of file +ToolbarDataHandler | platform-bible-react

            Interface ToolbarDataHandler

            interface ToolbarDataHandler ((isSupportAndDevelopment) => GridMenuInfo)

            Settings

            Member Visibility

            Theme

            Generated using TypeDoc

            \ No newline at end of file diff --git a/platform-bible-react/types/AnchorOrigin.html b/platform-bible-react/types/AnchorOrigin.html index 3a175ac0d0..51d5fa034f 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

            Generated using TypeDoc

            \ No newline at end of file +AnchorOrigin | platform-bible-react

            Type alias AnchorOrigin

            AnchorOrigin: SnackbarOrigin

            Settings

            Member Visibility

            Theme

            Generated using TypeDoc

            \ No newline at end of file diff --git a/platform-bible-react/types/ButtonProps.html b/platform-bible-react/types/ButtonProps.html index 28d22598b8..32b8e226e7 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

            Generated using TypeDoc

            \ No newline at end of file +

            Settings

            Member Visibility

            Theme

            Generated using TypeDoc

            \ No newline at end of file diff --git a/platform-bible-react/types/ChapterRangeSelectorProps.html b/platform-bible-react/types/ChapterRangeSelectorProps.html index 9693d5a347..9bee4d1df7 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

            Generated using TypeDoc

            \ 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

            Generated using TypeDoc

            \ No newline at end of file diff --git a/platform-bible-react/types/CheckboxProps.html b/platform-bible-react/types/CheckboxProps.html index d4065df0a0..e065b6cd44 100644 --- a/platform-bible-react/types/CheckboxProps.html +++ b/platform-bible-react/types/CheckboxProps.html @@ -21,4 +21,4 @@

            Parameters

            Returns void

            Settings

            Member Visibility

            Theme

            Generated using TypeDoc

            \ No newline at end of file +

            Returns void

            Settings

            Member Visibility

            Theme

            Generated using TypeDoc

            \ No newline at end of file diff --git a/platform-bible-react/types/CloseReason.html b/platform-bible-react/types/CloseReason.html index efcbbbbc91..a0e0832ffa 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

            Generated using TypeDoc

            \ No newline at end of file +CloseReason | platform-bible-react

            Type alias CloseReason

            CloseReason: SnackbarCloseReason

            Settings

            Member Visibility

            Theme

            Generated using TypeDoc

            \ No newline at end of file diff --git a/platform-bible-react/types/ComboBoxChangeDetails.html b/platform-bible-react/types/ComboBoxChangeDetails.html index ebd03471d4..afb4beab95 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

            Generated using TypeDoc

            \ 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

            Generated using TypeDoc

            \ No newline at end of file diff --git a/platform-bible-react/types/ComboBoxChangeReason.html b/platform-bible-react/types/ComboBoxChangeReason.html index 3453bfdd3a..2eb5d550d3 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

            Generated using TypeDoc

            \ No newline at end of file +ComboBoxChangeReason | platform-bible-react

            Type alias ComboBoxChangeReason

            ComboBoxChangeReason: AutocompleteChangeReason

            Settings

            Member Visibility

            Theme

            Generated using TypeDoc

            \ No newline at end of file diff --git a/platform-bible-react/types/ComboBoxLabelOption.html b/platform-bible-react/types/ComboBoxLabelOption.html index 909391e822..2331addd8c 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

            Generated using TypeDoc

            \ No newline at end of file +ComboBoxLabelOption | platform-bible-react

            Type alias ComboBoxLabelOption

            ComboBoxLabelOption: {
                label: string;
            }

            Type declaration

            • label: string

            Settings

            Member Visibility

            Theme

            Generated using TypeDoc

            \ No newline at end of file diff --git a/platform-bible-react/types/ComboBoxOption.html b/platform-bible-react/types/ComboBoxOption.html index 9ea47ac59e..66848c91e1 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

            Generated using TypeDoc

            \ No newline at end of file +ComboBoxOption | platform-bible-react

            Type alias ComboBoxOption

            ComboBoxOption: string | number | ComboBoxLabelOption

            Settings

            Member Visibility

            Theme

            Generated using TypeDoc

            \ No newline at end of file diff --git a/platform-bible-react/types/ComboBoxProps.html b/platform-bible-react/types/ComboBoxProps.html index 772110e3a1..06214011f4 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

            Generated using TypeDoc

            \ No newline at end of file +

            Settings

            Member Visibility

            Theme

            Generated using TypeDoc

            \ No newline at end of file diff --git a/platform-bible-react/types/ComboBoxValue.html b/platform-bible-react/types/ComboBoxValue.html index 9ce90c6d04..19bf26ca9f 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

            Generated using TypeDoc

            \ 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

            Generated using TypeDoc

            \ No newline at end of file diff --git a/platform-bible-react/types/Command.html b/platform-bible-react/types/Command.html index 7fad804821..c7d4bafa62 100644 --- a/platform-bible-react/types/Command.html +++ b/platform-bible-react/types/Command.html @@ -1,3 +1,3 @@ Command | platform-bible-react

            Type alias Command

            Command: {
                command: string;
                name: string;
            }

            Type declaration

            • command: string

              Command to execute (string.string)

            • name: string

              Text (displayable in the UI) as the name of the command

              -

            Settings

            Member Visibility

            Theme

            Generated using TypeDoc

            \ No newline at end of file +

            Settings

            Member Visibility

            Theme

            Generated using TypeDoc

            \ No newline at end of file diff --git a/platform-bible-react/types/GridMenuInfo.html b/platform-bible-react/types/GridMenuInfo.html index 1faf9809f6..70eec6e48d 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: {
                columns: MenuColumn[];
            }

            Type declaration

            • columns: MenuColumn[]

              The columns to display on the dropdown menu.

              -

            Settings

            Member Visibility

            Theme

            Generated using TypeDoc

            \ No newline at end of file +

            Settings

            Member Visibility

            Theme

            Generated using TypeDoc

            \ No newline at end of file diff --git a/platform-bible-react/types/GridMenuProps.html b/platform-bible-react/types/GridMenuProps.html index 987a701a4a..78b27cde78 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 toolbar

            • commandHandler: CommandHandler
            • Optional id?: string

              Optional unique identifier

              -

            Settings

            Member Visibility

            Theme

            Generated using TypeDoc

            \ No newline at end of file +

            Settings

            Member Visibility

            Theme

            Generated using TypeDoc

            \ No newline at end of file diff --git a/platform-bible-react/types/IconButtonProps.html b/platform-bible-react/types/IconButtonProps.html index dfa568eb40..c7c662e439 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

            Generated using TypeDoc

            \ No newline at end of file +

            Settings

            Member Visibility

            Theme

            Generated using TypeDoc

            \ No newline at end of file diff --git a/platform-bible-react/types/MenuColumn.html b/platform-bible-react/types/MenuColumn.html index 31ed59aa84..969c1bf8ad 100644 --- a/platform-bible-react/types/MenuColumn.html +++ b/platform-bible-react/types/MenuColumn.html @@ -1,2 +1,2 @@ MenuColumn | platform-bible-react

            Type alias MenuColumn

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

            Type declaration

            • items: MenuItemInfo[]
            • name: string

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

              -

            Settings

            Member Visibility

            Theme

            Generated using TypeDoc

            \ No newline at end of file +

            Settings

            Member Visibility

            Theme

            Generated using TypeDoc

            \ No newline at end of file diff --git a/platform-bible-react/types/MenuItemInfo.html b/platform-bible-react/types/MenuItemInfo.html index e1feb710ac..5817f24bb4 100644 --- a/platform-bible-react/types/MenuItemInfo.html +++ b/platform-bible-react/types/MenuItemInfo.html @@ -12,4 +12,4 @@
          • Optional isDense?: boolean

            If true, compact vertical padding designed for keyboard and mouse input is used.

            Default

            true
            -

            • Settings

            Member Visibility

            Theme

            Generated using TypeDoc

            \ No newline at end of file +

            Settings

            Member Visibility

            Theme

            Generated using TypeDoc

            \ No newline at end of file diff --git a/platform-bible-react/types/MenuItemProps.html b/platform-bible-react/types/MenuItemProps.html index 1a4d6f007f..1c9dd258f9 100644 --- a/platform-bible-react/types/MenuItemProps.html +++ b/platform-bible-react/types/MenuItemProps.html @@ -1 +1 @@ -MenuItemProps | platform-bible-react

            Type alias MenuItemProps

            MenuItemProps: Omit<MenuItemInfo, "command"> & PropsWithChildren<{
                id?: string;
                onClick: (() => void);
            }>

            Settings

            Member Visibility

            Theme

            Generated using TypeDoc

            \ No newline at end of file +MenuItemProps | platform-bible-react

            Type alias MenuItemProps

            MenuItemProps: Omit<MenuItemInfo, "command"> & PropsWithChildren<{
                id?: string;
                onClick: (() => void);
            }>

            Settings

            Member Visibility

            Theme

            Generated using TypeDoc

            \ No newline at end of file diff --git a/platform-bible-react/types/SearchBarProps.html b/platform-bible-react/types/SearchBarProps.html index e05bed501a..26f6c33ea8 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)
                • (searchQuery): void

                • Callback fired to handle the search query when button pressed

                  Parameters

                  • searchQuery: string

                  Returns void

            • Optional placeholder?: string

              Optional string that appears in the search bar without a search string

              -

            Settings

            Member Visibility

            Theme

            Generated using TypeDoc

            \ No newline at end of file +

            Settings

            Member Visibility

            Theme

            Generated using TypeDoc

            \ No newline at end of file diff --git a/platform-bible-react/types/SliderProps.html b/platform-bible-react/types/SliderProps.html index a6a11d153b..edccd5023c 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

            Generated using TypeDoc

            \ No newline at end of file +

            Settings

            Member Visibility

            Theme

            Generated using TypeDoc

            \ No newline at end of file diff --git a/platform-bible-react/types/SnackbarContentProps.html b/platform-bible-react/types/SnackbarContentProps.html index cb2a419d5a..aeebe7591c 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

            Generated using TypeDoc

            \ No newline at end of file +

            Settings

            Member Visibility

            Theme

            Generated using TypeDoc

            \ No newline at end of file diff --git a/platform-bible-react/types/SnackbarProps.html b/platform-bible-react/types/SnackbarProps.html index 0dce45a7e8..e774aaf7f7 100644 --- a/platform-bible-react/types/SnackbarProps.html +++ b/platform-bible-react/types/SnackbarProps.html @@ -12,4 +12,4 @@
          • Optional onClose?: ((event, reason) => void)

            • Settings

            Member Visibility

            Theme

            Generated using TypeDoc

            \ No newline at end of file +

            Parameters

            Returns void

            Settings

            Member Visibility

            Theme

            Generated using TypeDoc

            \ No newline at end of file diff --git a/platform-bible-react/types/SwitchProps.html b/platform-bible-react/types/SwitchProps.html index 086e615943..dde05be0cc 100644 --- a/platform-bible-react/types/SwitchProps.html +++ b/platform-bible-react/types/SwitchProps.html @@ -11,4 +11,4 @@

            Parameters

            Returns void

            Settings

            Member Visibility

            Theme

            Generated using TypeDoc

            \ No newline at end of file +

            Returns void

            Settings

            Member Visibility

            Theme

            Generated using TypeDoc

            \ No newline at end of file diff --git a/platform-bible-react/types/TableCellClickArgs.html b/platform-bible-react/types/TableCellClickArgs.html index fb79eb8641..8f0313450c 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

            Generated using TypeDoc

            \ 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

            Generated using TypeDoc

            \ No newline at end of file diff --git a/platform-bible-react/types/TableCellKeyDownArgs.html b/platform-bible-react/types/TableCellKeyDownArgs.html index a8b34faea7..38f133e6ea 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

            Generated using TypeDoc

            \ 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

            Generated using TypeDoc

            \ No newline at end of file diff --git a/platform-bible-react/types/TableCellKeyboardEvent.html b/platform-bible-react/types/TableCellKeyboardEvent.html index ae926253e1..7100453666 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

            Generated using TypeDoc

            \ No newline at end of file +TableCellKeyboardEvent | platform-bible-react

            Type alias TableCellKeyboardEvent

            TableCellKeyboardEvent: CellKeyboardEvent

            Settings

            Member Visibility

            Theme

            Generated using TypeDoc

            \ No newline at end of file diff --git a/platform-bible-react/types/TableCellMouseEvent.html b/platform-bible-react/types/TableCellMouseEvent.html index f01d6ca1bc..229a0f8eca 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

            Generated using TypeDoc

            \ No newline at end of file +TableCellMouseEvent | platform-bible-react

            Type alias TableCellMouseEvent

            TableCellMouseEvent: CellMouseEvent

            Settings

            Member Visibility

            Theme

            Generated using TypeDoc

            \ No newline at end of file diff --git a/platform-bible-react/types/TableColumn.html b/platform-bible-react/types/TableColumn.html index 0b284f16a2..6b92dc91c2 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

            Generated using TypeDoc

            \ No newline at end of file +

            Settings

            Member Visibility

            Theme

            Generated using TypeDoc

            \ No newline at end of file diff --git a/platform-bible-react/types/TableCopyEvent.html b/platform-bible-react/types/TableCopyEvent.html index 9cf9de421e..9c08544fcf 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

            Generated using TypeDoc

            \ 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

            Generated using TypeDoc

            \ No newline at end of file diff --git a/platform-bible-react/types/TableEditorProps.html b/platform-bible-react/types/TableEditorProps.html index e37f9ad7c5..c0e8df9e4a 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

            Generated using TypeDoc

            \ 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

            Generated using TypeDoc

            \ No newline at end of file diff --git a/platform-bible-react/types/TablePasteEvent.html b/platform-bible-react/types/TablePasteEvent.html index 594ad2dc4e..11719da794 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

            Generated using TypeDoc

            \ 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

            Generated using TypeDoc

            \ No newline at end of file diff --git a/platform-bible-react/types/TableProps.html b/platform-bible-react/types/TableProps.html index 331f5a7ad7..81b5bfbcfe 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

            Generated using TypeDoc

            \ No newline at end of file +

            Settings

            Member Visibility

            Theme

            Generated using TypeDoc

            \ No newline at end of file diff --git a/platform-bible-react/types/TableRowsChangeData.html b/platform-bible-react/types/TableRowsChangeData.html index 93bfac2358..430baa054c 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

            Generated using TypeDoc

            \ 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

            Generated using TypeDoc

            \ No newline at end of file diff --git a/platform-bible-react/types/TableSortColumn.html b/platform-bible-react/types/TableSortColumn.html index 12431d78dd..a4f02d99a1 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

            Generated using TypeDoc

            \ No newline at end of file +TableSortColumn | platform-bible-react

            Type alias TableSortColumn

            TableSortColumn: SortColumn

            Settings

            Member Visibility

            Theme

            Generated using TypeDoc

            \ No newline at end of file diff --git a/platform-bible-react/types/TextFieldProps.html b/platform-bible-react/types/TextFieldProps.html index e7976c7894..7fe7b3cbd1 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

            Generated using TypeDoc

            \ No newline at end of file +

            Settings

            Member Visibility

            Theme

            Generated using TypeDoc

            \ No newline at end of file diff --git a/platform-bible-react/types/ToolbarProps.html b/platform-bible-react/types/ToolbarProps.html index f6eff4be03..a9d64dc7fd 100644 --- a/platform-bible-react/types/ToolbarProps.html +++ b/platform-bible-react/types/ToolbarProps.html @@ -3,4 +3,4 @@
          • Optional dataHandler?: ToolbarDataHandler

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

          • Optional id?: string

            Optional unique identifier

          • Optional menu?: GridMenuInfo

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

            -

            • Settings

            Member Visibility

            Theme

            Generated using TypeDoc

            \ No newline at end of file +

            Settings

            Member Visibility

            Theme

            Generated using TypeDoc

            \ No newline at end of file diff --git a/platform-bible-react/types/UsePromiseOptions.html b/platform-bible-react/types/UsePromiseOptions.html index a8c4b8d47f..3d35839eef 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

            Generated using TypeDoc

            \ No newline at end of file +

            Settings

            Member Visibility

            Theme

            Generated using TypeDoc

            \ No newline at end of file diff --git a/platform-bible-utils/classes/AsyncVariable.html b/platform-bible-utils/classes/AsyncVariable.html index 945b67bdc0..e1552884bb 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

            • get hasSettled(): boolean

            • A simple way to see if this variable's promise was resolved or rejected already

              Returns boolean

              Whether the variable was already resolved or rejected

              -

            promise

            • get promise(): Promise<T>

            • Get this variable's promise to a value. This always returns the same promise even after the +

            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

            • complete(): void

            • Prevent any further updates to this variable

              -

              Returns void

            rejectWithReason

            • rejectWithReason(reason, throwIfAlreadySettled?): void

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

              +

            Methods

            Private complete

            • complete(): void

            • Prevent any further updates to this variable

              +

              Returns void

            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

            Settings

            Member Visibility

            Theme

            On This Page

            Generated using TypeDoc

            \ No newline at end of file +

            Returns void

            Settings

            Member Visibility

            Theme

            On This Page

            Generated using TypeDoc

            \ No newline at end of file diff --git a/platform-bible-utils/classes/PlatformEventEmitter.html b/platform-bible-utils/classes/PlatformEventEmitter.html index 3b627c3f87..a57a2237f8 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

            • get event(): PlatformEvent<T>

            • Event for listeners to subscribe to. Subscribes a function to run when this event is emitted. Use like const unsubscriber = event(callback)

              Returns PlatformEvent<T>

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

              -

            Methods

            Protected assertNotDisposed

            dispose

            • dispose(): Promise<boolean>

            • Disposes of this event, preparing it to release from memory

              -

              Returns Promise<boolean>

            Protected disposeFn

            Methods

            Protected assertNotDisposed

            dispose

            • dispose(): Promise<boolean>

            • Disposes of this event, preparing it to release from memory

              +

              Returns Promise<boolean>

            Protected disposeFn

            • disposeFn(): Promise<boolean>

            • Disposes of this event, preparing it to release from memory. Added here so children can override emit and still call the base functionality.

              -

              Returns Promise<boolean>

            emit

            emit

            • emit(event): void

            • Runs the subscriptions for the event

              Parameters

              • event: T

                Event data to provide to subscribed callbacks

                -

              Returns void

            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

            Generated using TypeDoc

            \ No newline at end of file +

            Parameters

            Returns void

            Settings

            Member Visibility

            Theme

            On This Page

            Generated using TypeDoc

            \ No newline at end of file diff --git a/platform-bible-utils/classes/UnsubscriberAsyncList.html b/platform-bible-utils/classes/UnsubscriberAsyncList.html index a4706c031e..05cd2898ce 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

            Generated using TypeDoc

            \ No newline at end of file +

            Settings

            Member Visibility

            Theme

            On This Page

            Generated using TypeDoc

            \ No newline at end of file diff --git a/platform-bible-utils/functions/aggregateUnsubscriberAsyncs.html b/platform-bible-utils/functions/aggregateUnsubscriberAsyncs.html index 3dc1805b44..f3d540be56 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

            Generated using TypeDoc

            \ No newline at end of file +

            Settings

            Member Visibility

            Theme

            Generated using TypeDoc

            \ No newline at end of file diff --git a/platform-bible-utils/functions/aggregateUnsubscribers.html b/platform-bible-utils/functions/aggregateUnsubscribers.html index 47fbabf420..270859789c 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

            • aggregateUnsubscribers(unsubscribers): Unsubscriber

            • Returns an Unsubscriber function that combines all the unsubscribers passed in.

              Parameters

              • unsubscribers: Unsubscriber[]

                All unsubscribers to aggregate into one unsubscriber

              Returns Unsubscriber

              Function that unsubscribes from all passed in unsubscribers when run

              -

            Settings

            Member Visibility

            Theme

            Generated using TypeDoc

            \ No newline at end of file +

            Settings

            Member Visibility

            Theme

            Generated using TypeDoc

            \ No newline at end of file diff --git a/platform-bible-utils/functions/debounce.html b/platform-bible-utils/functions/debounce.html index 6674cca67a..803630e167 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

            Generated using TypeDoc

            \ No newline at end of file +

            Settings

            Member Visibility

            Theme

            Generated using TypeDoc

            \ No newline at end of file diff --git a/platform-bible-utils/functions/deepEqual.html b/platform-bible-utils/functions/deepEqual.html index a234390a4d..77ae092c7f 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

            Generated using TypeDoc

            \ No newline at end of file +

            Settings

            Member Visibility

            Theme

            Generated using TypeDoc

            \ No newline at end of file diff --git a/platform-bible-utils/functions/deserialize.html b/platform-bible-utils/functions/deserialize.html index 76fd0c48b5..5a9d8e1959 100644 --- a/platform-bible-utils/functions/deserialize.html +++ b/platform-bible-utils/functions/deserialize.html @@ -8,4 +8,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

            Generated using TypeDoc

            \ No newline at end of file +

            Returns any

            Settings

            Member Visibility

            Theme

            Generated using TypeDoc

            \ No newline at end of file diff --git a/platform-bible-utils/functions/getAllObjectFunctionNames.html b/platform-bible-utils/functions/getAllObjectFunctionNames.html index a553546fd2..44fa6c5277 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

            Generated using TypeDoc

            \ No newline at end of file +

            Settings

            Member Visibility

            Theme

            Generated using TypeDoc

            \ No newline at end of file diff --git a/platform-bible-utils/functions/getChaptersForBook.html b/platform-bible-utils/functions/getChaptersForBook.html index 928a764173..ec58fb4c57 100644 --- a/platform-bible-utils/functions/getChaptersForBook.html +++ b/platform-bible-utils/functions/getChaptersForBook.html @@ -1 +1 @@ -getChaptersForBook | platform-bible-utils

            Function getChaptersForBook

            • getChaptersForBook(bookNum): number

            • Parameters

              • bookNum: number

              Returns number

            Settings

            Member Visibility

            Theme

            Generated using TypeDoc

            \ No newline at end of file +getChaptersForBook | platform-bible-utils

            Function getChaptersForBook

            • getChaptersForBook(bookNum): number

            • Parameters

              • bookNum: number

              Returns number

            Settings

            Member Visibility

            Theme

            Generated using TypeDoc

            \ No newline at end of file diff --git a/platform-bible-utils/functions/getErrorMessage.html b/platform-bible-utils/functions/getErrorMessage.html index 704373b768..6345a8484d 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

            Generated using TypeDoc

            \ No newline at end of file +

            Settings

            Member Visibility

            Theme

            Generated using TypeDoc

            \ No newline at end of file diff --git a/platform-bible-utils/functions/groupBy.html b/platform-bible-utils/functions/groupBy.html index 46832602e1..ba03a9d8e9 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

            Parameters

            Returns Map<K, V[]>

            • Settings

            Member Visibility

            Theme

            Generated using TypeDoc

            \ No newline at end of file +
          • groupBy<T, K, V>(items, keySelector, valueSelector): Map<K, V[]>

          • Type Parameters

            Parameters

            Returns Map<K, V[]>

            • Settings

            Member Visibility

            Theme

            Generated using TypeDoc

            \ No newline at end of file diff --git a/platform-bible-utils/functions/htmlEncode.html b/platform-bible-utils/functions/htmlEncode.html index 72f212ef3c..007f5d920e 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

            • htmlEncode(str): string

            • HTML Encodes the provided string. Thanks to ChatGPT

              Parameters

              • str: string

                String to HTML encode

              Returns string

              HTML-encoded string

              -

            Settings

            Member Visibility

            Theme

            Generated using TypeDoc

            \ No newline at end of file +

            Settings

            Member Visibility

            Theme

            Generated using TypeDoc

            \ No newline at end of file diff --git a/platform-bible-utils/functions/isSerializable.html b/platform-bible-utils/functions/isSerializable.html index 488ed972bd..0ef405842b 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

            Generated using TypeDoc

            \ No newline at end of file +

            Settings

            Member Visibility

            Theme

            Generated using TypeDoc

            \ No newline at end of file diff --git a/platform-bible-utils/functions/isString.html b/platform-bible-utils/functions/isString.html index 6d6dcd1c3f..8b5164f983 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

            Generated using TypeDoc

            \ No newline at end of file +

            Settings

            Member Visibility

            Theme

            Generated using TypeDoc

            \ No newline at end of file diff --git a/platform-bible-utils/functions/newGuid.html b/platform-bible-utils/functions/newGuid.html index 68fb8ea06d..5cdd25068e 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

            • newGuid(): string

            • Collection of functions, objects, and types that are used as helpers in other services.

              -

              Returns string

            Settings

            Member Visibility

            Theme

            Generated using TypeDoc

            \ No newline at end of file +

            Returns string

            Settings

            Member Visibility

            Theme

            Generated using TypeDoc

            \ No newline at end of file diff --git a/platform-bible-utils/functions/offsetBook.html b/platform-bible-utils/functions/offsetBook.html index 67e34159e8..4aca7ac7fa 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

            Generated using TypeDoc

            \ No newline at end of file +offsetBook | platform-bible-utils

            Function offsetBook

            Settings

            Member Visibility

            Theme

            Generated using TypeDoc

            \ No newline at end of file diff --git a/platform-bible-utils/functions/offsetChapter.html b/platform-bible-utils/functions/offsetChapter.html index f9c35ba08e..90fcf2fc17 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

            Generated using TypeDoc

            \ No newline at end of file +offsetChapter | platform-bible-utils

            Function offsetChapter

            Settings

            Member Visibility

            Theme

            Generated using TypeDoc

            \ No newline at end of file diff --git a/platform-bible-utils/functions/offsetVerse.html b/platform-bible-utils/functions/offsetVerse.html index b1749066ad..e21d154e47 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

            Generated using TypeDoc

            \ No newline at end of file +offsetVerse | platform-bible-utils

            Function offsetVerse

            Settings

            Member Visibility

            Theme

            Generated using TypeDoc

            \ No newline at end of file diff --git a/platform-bible-utils/functions/serialize.html b/platform-bible-utils/functions/serialize.html index 61b46e461c..63752bdf82 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

            Generated using TypeDoc

            \ No newline at end of file +

            Returns string

            Settings

            Member Visibility

            Theme

            Generated using TypeDoc

            \ No newline at end of file diff --git a/platform-bible-utils/functions/wait.html b/platform-bible-utils/functions/wait.html index 01101c6334..0bf99c0a08 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

            Generated using TypeDoc

            \ No newline at end of file +

            Parameters

            Returns Promise<void>

            Settings

            Member Visibility

            Theme

            Generated using TypeDoc

            \ No newline at end of file diff --git a/platform-bible-utils/functions/waitForDuration.html b/platform-bible-utils/functions/waitForDuration.html index 8a7476a771..a776c3d7b3 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

            Generated using TypeDoc

            \ No newline at end of file +

            Settings

            Member Visibility

            Theme

            Generated using TypeDoc

            \ No newline at end of file diff --git a/platform-bible-utils/interfaces/BookInfo.html b/platform-bible-utils/interfaces/BookInfo.html index 51b73209b6..6956fd3c48 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

            Generated using TypeDoc

            \ No newline at end of file +

            Properties

            chapters

            chapters: number

            fullNames

            fullNames: string[]

            shortName

            shortName: string

            Settings

            Member Visibility

            Theme

            On This Page

            Generated using TypeDoc

            \ No newline at end of file diff --git a/platform-bible-utils/interfaces/CannotHaveOnDidDispose.html b/platform-bible-utils/interfaces/CannotHaveOnDidDispose.html index 804f8ccfb0..22379a31bf 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

            Generated using TypeDoc

            \ 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

            Generated using TypeDoc

            \ No newline at end of file diff --git a/platform-bible-utils/interfaces/Dispose.html b/platform-bible-utils/interfaces/Dispose.html index 4e6da7c940..bc727bf7c1 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

            Generated using TypeDoc

            \ No newline at end of file +

            Settings

            Member Visibility

            Theme

            On This Page

            Generated using TypeDoc

            \ No newline at end of file diff --git a/platform-bible-utils/interfaces/OnDidDispose.html b/platform-bible-utils/interfaces/OnDidDispose.html index 78afd5f043..658a8c88d3 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

            Generated using TypeDoc

            \ No newline at end of file +

            Settings

            Member Visibility

            Theme

            On This Page

            Generated using TypeDoc

            \ No newline at end of file diff --git a/platform-bible-utils/interfaces/ScriptureReference.html b/platform-bible-utils/interfaces/ScriptureReference.html index 69c617944f..3e5da3392b 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

            Generated using TypeDoc

            \ No newline at end of file +

            Properties

            bookNum

            bookNum: number

            chapterNum

            chapterNum: number

            verseNum

            verseNum: number

            Settings

            Member Visibility

            Theme

            On This Page

            Generated using TypeDoc

            \ No newline at end of file diff --git a/platform-bible-utils/types/CanHaveOnDidDispose.html b/platform-bible-utils/types/CanHaveOnDidDispose.html index 970cdde35b..cc69d07580 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

            Generated using TypeDoc

            \ No newline at end of file +

            Type Parameters

            Settings

            Member Visibility

            Theme

            Generated using TypeDoc

            \ No newline at end of file diff --git a/platform-bible-utils/types/PlatformEvent.html b/platform-bible-utils/types/PlatformEvent.html index 9e2811f220..f71ce33e90 100644 --- a/platform-bible-utils/types/PlatformEvent.html +++ b/platform-bible-utils/types/PlatformEvent.html @@ -2,4 +2,4 @@

            Parameters

            Returns Unsubscriber

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

            -

            Settings

            Member Visibility

            Theme

            Generated using TypeDoc

            \ No newline at end of file +

            Settings

            Member Visibility

            Theme

            Generated using TypeDoc

            \ No newline at end of file diff --git a/platform-bible-utils/types/PlatformEventAsync.html b/platform-bible-utils/types/PlatformEventAsync.html index 74c5c2b1d2..5e7c83824f 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>)

            Type Parameters

            • T

            Type declaration

            Settings

            Member Visibility

            Theme

            Generated using TypeDoc

            \ No newline at end of file +

            Parameters

            Returns Promise<UnsubscriberAsync>

            Settings

            Member Visibility

            Theme

            Generated using TypeDoc

            \ No newline at end of file diff --git a/platform-bible-utils/types/PlatformEventHandler.html b/platform-bible-utils/types/PlatformEventHandler.html index d739ec4676..014c6c3021 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)

            Type Parameters

            • T

            Type declaration

              • (event): void

              • Callback function that accepts an event and should run when an event is emitted

                -

                Parameters

                • event: T

                Returns void

            Settings

            Member Visibility

            Theme

            Generated using TypeDoc

            \ No newline at end of file +

            Parameters

            Returns void

            Settings

            Member Visibility

            Theme

            Generated using TypeDoc

            \ No newline at end of file diff --git a/platform-bible-utils/types/Unsubscriber.html b/platform-bible-utils/types/Unsubscriber.html index a7bd3a8f50..2695abc12b 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)

            Type declaration

              • (): boolean

              • Function to run to dispose of something. Returns true if successfully unsubscribed

                -

                Returns boolean

            Settings

            Member Visibility

            Theme

            Generated using TypeDoc

            \ No newline at end of file +

            Returns boolean

            Settings

            Member Visibility

            Theme

            Generated using TypeDoc

            \ No newline at end of file diff --git a/platform-bible-utils/types/UnsubscriberAsync.html b/platform-bible-utils/types/UnsubscriberAsync.html index fa3d3d9b7d..96a1761fb1 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>)

            Type declaration

              • (): Promise<boolean>

              • Function to run to dispose of something that runs asynchronously. The promise resolves to true if successfully unsubscribed

                -

                Returns Promise<boolean>

            Settings

            Member Visibility

            Theme

            Generated using TypeDoc

            \ No newline at end of file +

            Returns Promise<boolean>

            Settings

            Member Visibility

            Theme

            Generated using TypeDoc

            \ 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 f5e4c7f87a..1382bc50b0 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

            Generated using TypeDoc

            \ 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

            Generated using TypeDoc

            \ 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 595fb69b17..6b08bd8260 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

            Generated using TypeDoc

            \ 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

            Generated using TypeDoc

            \ 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 f23efaef84..cc6326e1de 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

            Generated using TypeDoc

            \ 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

            Generated using TypeDoc

            \ 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 8440488cf4..3daa0160d9 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

            Generated using TypeDoc

            \ 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

            Generated using TypeDoc

            \ No newline at end of file