diff --git a/papi-dts/classes/_client_services_rpc_client_.default.html b/papi-dts/classes/_client_services_rpc_client_.default.html index bb095f5653..de17e12ffe 100644 --- a/papi-dts/classes/_client_services_rpc_client_.default.html +++ b/papi-dts/classes/_client_services_rpc_client_.default.html @@ -1,6 +1,6 @@ default | papi-dts

Classdefault

Manages the JSON-RPC protocol on the client end of a websocket that connects to main

Created by any process that connects to the websocket server owned by main

-

Implements

Constructors

constructor +

Implements

Constructors

constructor

Properties

connectionStatus

Methods

connect disconnect @@ -8,9 +8,9 @@ registerMethod request unregisterMethod -

Constructors

constructor

Properties

connectionStatus

connectionStatus: ConnectionStatus

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

Constructors

constructor

Properties

connectionStatus

connectionStatus: ConnectionStatus

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

-

Methods

connect

Methods

connect

  • connect(localEventHandler): Promise<boolean>

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

    • On clients: connecting to the server
      • @@ -19,19 +19,19 @@

    Parameters

    • localEventHandler: EventHandler

      Function that handles events from the server by accepting an eventType and an event and emitting the event locally. Used when receiving an event over the network.

    Returns Promise<boolean>

    Promise that resolves when finished connecting

    -

disconnect

disconnect

  • disconnect(): Promise<void>

  • Disconnects from the connection:

    • On clients: disconnects from the server
    • On servers: disconnects from all clients and closes its connection endpoint
    -

    Returns Promise<void>

emitEventOnNetwork

emitEventOnNetwork

  • emitEventOnNetwork<T>(eventType, event): 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: T

      Event data to emit on the network

      -

    Returns void

registerMethod

request

  • request(requestType, requestParams): Promise<JSONRPCResponse>

  • Send a request and resolve after receiving a response

    +

Returns void

registerMethod

request

unregisterMethod

Settings

Member Visibility

On This Page

Constructors
Properties
Methods
+

unregisterMethod

Settings

Member Visibility

On This Page

Constructors
Properties
Methods
diff --git a/papi-dts/classes/_main_services_rpc_server_.default.html b/papi-dts/classes/_main_services_rpc_server_.default.html index 9edd866348..970bddf755 100644 --- a/papi-dts/classes/_main_services_rpc_server_.default.html +++ b/papi-dts/classes/_main_services_rpc_server_.default.html @@ -2,7 +2,7 @@ intended to be instantiated by anything other than RpcWebSocketListener.

Created by RpcWebSocketListener when a client connects to the web socket server. There is one RpcServer object per client that connects to the web socket server.

-

Implements

Constructors

constructor +

Implements

Constructors

constructor

Properties

connectionStatus

Methods

connect disconnect @@ -10,26 +10,26 @@ registerRemoteMethod request unregisterRemoteMethod -

Constructors

constructor

Properties

connectionStatus

connectionStatus: ConnectionStatus

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

Constructors

constructor

Properties

connectionStatus

connectionStatus: ConnectionStatus

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

-

Methods

connect

Methods

connect

  • connect(): Promise<boolean>

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

    • On clients: connecting to the server
    • On servers: opening an endpoint for clients to connect

    Returns Promise<boolean>

    Promise that resolves when finished connecting

    -

disconnect

disconnect

  • disconnect(): Promise<void>

  • Disconnects from the connection:

    • On clients: disconnects from the server
    • On servers: disconnects from all clients and closes its connection endpoint
    -

    Returns Promise<void>

emitEventOnNetwork

emitEventOnNetwork

  • emitEventOnNetwork<T>(eventType, event): 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: T

      Event data to emit on the network

      -

    Returns void

registerRemoteMethod

request

  • request(requestType, requestParams): Promise<JSONRPCResponse>

  • Send a request and resolve after receiving a response

    +

Returns void

registerRemoteMethod

request

  • request(requestType, requestParams): Promise<JSONRPCResponse>

  • Send a request and resolve after receiving a response

    Parameters

    • requestType: `${string}:${string}`

      Type of request (or "method" in JSONRPC jargon) to call

    • requestParams: RequestParams

      Parameters associated with this request

    Returns Promise<JSONRPCResponse>

    Promise that resolves to a JSONRPCSuccessResponse or JSONRPCErrorResponse message

    -

unregisterRemoteMethod

Settings

Member Visibility

On This Page

Constructors
Properties
Methods
+

unregisterRemoteMethod

Settings

Member Visibility

On This Page

Constructors
Properties
Methods
diff --git a/papi-dts/classes/_main_services_rpc_websocket_listener_.default.html b/papi-dts/classes/_main_services_rpc_websocket_listener_.default.html index 28469648f7..3733b3e091 100644 --- a/papi-dts/classes/_main_services_rpc_websocket_listener_.default.html +++ b/papi-dts/classes/_main_services_rpc_websocket_listener_.default.html @@ -5,7 +5,7 @@ other processes will be tied to the RPCServer that services the connection for that other process.

Created by the main process on start up when the network service initializes

-

Implements

Constructors

constructor +

Implements

Constructors

constructor

Properties

connectionStatus

Accessors

nextSocketId

Methods

connect @@ -14,9 +14,9 @@ registerMethod request unregisterMethod -

Constructors

constructor

Properties

connectionStatus

connectionStatus: ConnectionStatus

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

Constructors

constructor

Properties

connectionStatus

connectionStatus: ConnectionStatus

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

-

Accessors

nextSocketId

Methods

connect

Accessors

nextSocketId

Methods

connect

  • connect(localEventHandler): Promise<boolean>

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

    • On clients: connecting to the server
      • @@ -25,19 +25,19 @@

    Parameters

    • localEventHandler: EventHandler

      Function that handles events from the server by accepting an eventType and an event and emitting the event locally. Used when receiving an event over the network.

    Returns Promise<boolean>

    Promise that resolves when finished connecting

    -

disconnect

disconnect

  • disconnect(): Promise<void>

  • Disconnects from the connection:

    • On clients: disconnects from the server
    • On servers: disconnects from all clients and closes its connection endpoint
    -

    Returns Promise<void>

emitEventOnNetwork

emitEventOnNetwork

  • emitEventOnNetwork<T>(eventType, event): 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: T

      Event data to emit on the network

      -

    Returns void

registerMethod

request

  • request(requestType, requestParams): Promise<JSONRPCResponse>

  • Send a request and resolve after receiving a response

    +

Returns void

registerMethod

request

  • request(requestType, requestParams): Promise<JSONRPCResponse>

  • Send a request and resolve after receiving a response

    Parameters

    • requestType: `${string}:${string}`

      Type of request (or "method" in JSONRPC jargon) to call

    • requestParams: RequestParams

      Parameters associated with this request

    Returns Promise<JSONRPCResponse>

    Promise that resolves to a JSONRPCSuccessResponse or JSONRPCErrorResponse message

    -

unregisterMethod

Settings

Member Visibility

On This Page

Constructors
Properties
Accessors
Methods
+

unregisterMethod

Settings

Member Visibility

On This Page

Constructors
Properties
Accessors
Methods
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 22db18518b..f5d894be1d 100644 --- a/papi-dts/classes/_node_models_execution_token_model_.ExecutionToken.html +++ b/papi-dts/classes/_node_models_execution_token_model_.ExecutionToken.html @@ -1,8 +1,8 @@ ExecutionToken | papi-dts

ClassExecutionToken

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

-

Implements

Constructors

constructor +

Implements

Constructors

constructor

Properties

name nonce type

Methods

getHash -

Constructors

constructor

Properties

Readonlyname

name: string

Name of an extension

-

Readonlynonce

nonce: string

Readonlytype

type

Methods

getHash

Settings

Member Visibility

On This Page

Constructors
Properties
Methods
+

Constructors

constructor

Properties

Readonlyname

name: string

Name of an extension

+

Readonlynonce

nonce: string

Readonlytype

type

Methods

getHash

Settings

Member Visibility

On This Page

Constructors
Properties
Methods
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 f38f4d10c0..c4e3136a9c 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

addEventListener binaryType bufferedAmount @@ -22,28 +22,28 @@ removeEventListener send url -

Constructors

constructor

Properties

addEventListener

addEventListener: (<K>(type: K, listener: ((this: WebSocket, ev: WebSocketEventMap[K]) => any), options?: boolean | AddEventListenerOptions) => void)

binaryType

binaryType: BinaryType

Returns a string that indicates how binary data from the WebSocket object is exposed to scripts:

+

Constructors

constructor

Properties

addEventListener

addEventListener: (<K>(type: K, listener: ((this: WebSocket, ev: WebSocketEventMap[K]) => any), options?: boolean | AddEventListenerOptions) => void)

binaryType

binaryType: BinaryType

Returns a string that indicates how binary data from the WebSocket object is exposed to scripts:

Can be set, to change how binary data is returned. The default is "blob".

MDN Reference

-

bufferedAmount

bufferedAmount: number

Returns the number of bytes of application data (UTF-8 text and binary data) that have been queued using send() but not yet been transmitted to the network.

+

bufferedAmount

bufferedAmount: number

Returns the number of bytes of application data (UTF-8 text and binary data) that have been queued using send() but not yet been transmitted to the network.

If the WebSocket connection is closed, this attribute's value will only increase with each call to the send() method. (The number does not reset to zero once the connection closes.)

MDN Reference

-

close

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

Closes the WebSocket connection, optionally using code as the the WebSocket connection close code and reason as the the WebSocket connection close reason.

+

close

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

Closes the WebSocket connection, optionally using code as the the WebSocket connection close code and reason as the the WebSocket connection close reason.

MDN Reference

-

ReadonlyCLOSED

CLOSED

ReadonlyCLOSING

CLOSING

ReadonlyCONNECTING

CONNECTING

dispatchEvent

dispatchEvent: ((event: Event) => boolean)

Dispatches a synthetic event event to target and returns true if either event's cancelable attribute value is false or its preventDefault() method was not invoked, and false otherwise.

+

ReadonlyCLOSED

CLOSED

ReadonlyCLOSING

CLOSING

ReadonlyCONNECTING

CONNECTING

dispatchEvent

dispatchEvent: ((event: Event) => boolean)

Dispatches a synthetic event event to target and returns true if either event's cancelable attribute value is false or its preventDefault() method was not invoked, and false otherwise.

MDN Reference

-

extensions

extensions: string

Returns the extensions selected by the server, if any.

+

extensions

extensions: string

Returns the extensions selected by the server, if any.

MDN Reference

-

onclose

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

MDN Reference

-

onerror

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

MDN Reference

-

onmessage

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

MDN Reference

-

onopen

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

MDN Reference

-

ReadonlyOPEN

OPEN

protocol

protocol: string

Returns the subprotocol selected by the server, if any. It can be used in conjunction with the array form of the constructor's second argument to perform subprotocol negotiation.

+

onclose

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

MDN Reference

+

onerror

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

MDN Reference

+

onmessage

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

MDN Reference

+

onopen

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

MDN Reference

+

ReadonlyOPEN

OPEN

protocol

protocol: string

Returns the subprotocol selected by the server, if any. It can be used in conjunction with the array form of the constructor's second argument to perform subprotocol negotiation.

MDN Reference

-

readyState

readyState: number

Returns the state of the WebSocket object's connection. It can have the values described below.

+

readyState

readyState: number

Returns the state of the WebSocket object's connection. It can have the values described below.

MDN Reference

-

removeEventListener

removeEventListener: (<K>(type: K, listener: ((this: WebSocket, ev: WebSocketEventMap[K]) => any), options?: boolean | EventListenerOptions) => void)

send

send: ((data:
    | string
    | ArrayBufferLike
    | ArrayBufferView
    | Blob) => void)

Transmits data using the WebSocket connection. data can be a string, a Blob, an ArrayBuffer, or an ArrayBufferView.

+

removeEventListener

removeEventListener: (<K>(type: K, listener: ((this: WebSocket, ev: WebSocketEventMap[K]) => any), options?: boolean | EventListenerOptions) => void)

send

send: ((data:
    | string
    | ArrayBufferLike
    | ArrayBufferView
    | Blob) => void)

Transmits data using the WebSocket connection. data can be a string, a Blob, an ArrayBuffer, or an ArrayBufferView.

MDN Reference

-

url

url: string

Returns the URL that was used to establish the WebSocket connection.

+

url

url: string

Returns the URL that was used to establish the WebSocket connection.

MDN Reference

-

Settings

Member Visibility

On This Page

Constructors
Properties
+

Settings

Member Visibility

On This Page

Constructors
Properties
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 ec0a3425f7..bd7483e8ce 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

abort addEventListener dispatchEvent @@ -37,53 +37,53 @@ UNSENT upload withCredentials -

Constructors

constructor

Properties

abort

abort: (() => void)

Cancels any network activity.

+

Constructors

constructor

Properties

abort

abort: (() => void)

Cancels any network activity.

MDN Reference

-

addEventListener

addEventListener: (<K>(type: K, listener: ((this: XMLHttpRequest, ev: XMLHttpRequestEventMap[K]) => any), options?: boolean | AddEventListenerOptions) => void)

dispatchEvent

dispatchEvent: ((event: Event) => boolean)

Dispatches a synthetic event event to target and returns true if either event's cancelable attribute value is false or its preventDefault() method was not invoked, and false otherwise.

+

addEventListener

addEventListener: (<K>(type: K, listener: ((this: XMLHttpRequest, ev: XMLHttpRequestEventMap[K]) => any), options?: boolean | AddEventListenerOptions) => void)

dispatchEvent

dispatchEvent: ((event: Event) => boolean)

Dispatches a synthetic event event to target and returns true if either event's cancelable attribute value is false or its preventDefault() method was not invoked, and false otherwise.

MDN Reference

-

ReadonlyDONE

DONE

getAllResponseHeaders

getAllResponseHeaders: (() => string)

MDN Reference

-

getResponseHeader

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

MDN Reference

-

ReadonlyHEADERS_RECEIVED

HEADERS_RECEIVED

ReadonlyLOADING

LOADING

onabort

onabort: null | ((this: XMLHttpRequest, ev: ProgressEvent<EventTarget>) => any)

onerror

onerror: null | ((this: XMLHttpRequest, ev: ProgressEvent<EventTarget>) => any)

onload

onload: null | ((this: XMLHttpRequest, ev: ProgressEvent<EventTarget>) => any)

onloadend

onloadend: null | ((this: XMLHttpRequest, ev: ProgressEvent<EventTarget>) => any)

onloadstart

onloadstart: null | ((this: XMLHttpRequest, ev: ProgressEvent<EventTarget>) => any)

onprogress

onprogress: null | ((this: XMLHttpRequest, ev: ProgressEvent<EventTarget>) => any)

onreadystatechange

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

MDN Reference

-

ontimeout

ontimeout: null | ((this: XMLHttpRequest, ev: ProgressEvent<EventTarget>) => any)

open

open: ((method: string, url: string, async?: boolean, username?: null | string, password?: null | string) => void)

Sets the request method, request URL, and synchronous flag.

+

ReadonlyDONE

DONE

getAllResponseHeaders

getAllResponseHeaders: (() => string)

MDN Reference

+

getResponseHeader

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

MDN Reference

+

ReadonlyHEADERS_RECEIVED

HEADERS_RECEIVED

ReadonlyLOADING

LOADING

onabort

onabort: null | ((this: XMLHttpRequest, ev: ProgressEvent<EventTarget>) => any)

onerror

onerror: null | ((this: XMLHttpRequest, ev: ProgressEvent<EventTarget>) => any)

onload

onload: null | ((this: XMLHttpRequest, ev: ProgressEvent<EventTarget>) => any)

onloadend

onloadend: null | ((this: XMLHttpRequest, ev: ProgressEvent<EventTarget>) => any)

onloadstart

onloadstart: null | ((this: XMLHttpRequest, ev: ProgressEvent<EventTarget>) => any)

onprogress

onprogress: null | ((this: XMLHttpRequest, ev: ProgressEvent<EventTarget>) => any)

onreadystatechange

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

MDN Reference

+

ontimeout

ontimeout: null | ((this: XMLHttpRequest, ev: ProgressEvent<EventTarget>) => any)

open

open: ((method: string, url: string, async?: boolean, username?: null | string, password?: null | string) => void)

Sets the request method, request URL, and synchronous flag.

Throws a "SyntaxError" DOMException if either method is not a valid method or url cannot be parsed.

Throws a "SecurityError" DOMException if method is a case-insensitive match for CONNECT, TRACE, or TRACK.

Throws an "InvalidAccessError" DOMException if async is false, current global object is a Window object, and the timeout attribute is not zero or the responseType attribute is not the empty string.

MDN Reference

-

ReadonlyOPENED

OPENED

overrideMimeType

overrideMimeType: ((mime: string) => void)

Acts as if the Content-Type header value for a response is mime. (It does not change the header.)

+

ReadonlyOPENED

OPENED

overrideMimeType

overrideMimeType: ((mime: string) => void)

Acts as if the Content-Type header value for a response is mime. (It does not change the header.)

Throws an "InvalidStateError" DOMException if state is loading or done.

MDN Reference

-

readyState

readyState: number

Returns client's state.

+

readyState

readyState: number

Returns client's state.

MDN Reference

-

removeEventListener

removeEventListener: (<K>(type: K, listener: ((this: XMLHttpRequest, ev: XMLHttpRequestEventMap[K]) => any), options?: boolean | EventListenerOptions) => void)

response

response: any

Returns the response body.

+

removeEventListener

removeEventListener: (<K>(type: K, listener: ((this: XMLHttpRequest, ev: XMLHttpRequestEventMap[K]) => any), options?: boolean | EventListenerOptions) => void)

response

response: any

Returns the response body.

MDN Reference

-

responseText

responseText: string

Returns response as text.

+

responseText

responseText: string

Returns response as text.

Throws an "InvalidStateError" DOMException if responseType is not the empty string or "text".

MDN Reference

-

responseType

responseType: XMLHttpRequestResponseType

Returns the response type.

+

responseType

responseType: XMLHttpRequestResponseType

Returns the response type.

Can be set to change the response type. Values are: the empty string (default), "arraybuffer", "blob", "document", "json", and "text".

When set: setting to "document" is ignored if current global object is not a Window object.

When set: throws an "InvalidStateError" DOMException if state is loading or done.

When set: throws an "InvalidAccessError" DOMException if the synchronous flag is set and current global object is a Window object.

MDN Reference

-

responseURL

responseURL: string

MDN Reference

-

responseXML

responseXML: null | Document

Returns the response as document.

+

responseURL

responseURL: string

MDN Reference

+

responseXML

responseXML: null | Document

Returns the response as document.

Throws an "InvalidStateError" DOMException if responseType is not the empty string or "document".

MDN Reference

-

send

send: ((body?: null | Document | XMLHttpRequestBodyInit) => void)

Initiates the request. The body argument provides the request body, if any, and is ignored if the request method is GET or HEAD.

+

send

send: ((body?: null | Document | XMLHttpRequestBodyInit) => void)

Initiates the request. The body argument provides the request body, if any, and is ignored if the request method is GET or HEAD.

Throws an "InvalidStateError" DOMException if either state is not opened or the send() flag is set.

MDN Reference

-

setRequestHeader

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

Combines a header in author request headers.

+

setRequestHeader

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

Combines a header in author request headers.

Throws an "InvalidStateError" DOMException if either state is not opened or the send() flag is set.

Throws a "SyntaxError" DOMException if name is not a header name or if value is not a header value.

MDN Reference

-

status

status: number

MDN Reference

-

statusText

statusText: string

MDN Reference

-

timeout

timeout: number

Can be set to a time in milliseconds. When set to a non-zero value will cause fetching to terminate after the given time has passed. When the time has passed, the request has not yet completed, and this's synchronous flag is unset, a timeout event will then be dispatched, or a "TimeoutError" DOMException will be thrown otherwise (for the send() method).

+

status

status: number

MDN Reference

+

statusText

statusText: string

MDN Reference

+

timeout

timeout: number

Can be set to a time in milliseconds. When set to a non-zero value will cause fetching to terminate after the given time has passed. When the time has passed, the request has not yet completed, and this's synchronous flag is unset, a timeout event will then be dispatched, or a "TimeoutError" DOMException will be thrown otherwise (for the send() method).

When set: throws an "InvalidAccessError" DOMException if the synchronous flag is set and current global object is a Window object.

MDN Reference

-

ReadonlyUNSENT

UNSENT

upload

upload: XMLHttpRequestUpload

Returns the associated XMLHttpRequestUpload object. It can be used to gather transmission information when data is transferred to a server.

+

ReadonlyUNSENT

UNSENT

upload

upload: XMLHttpRequestUpload

Returns the associated XMLHttpRequestUpload object. It can be used to gather transmission information when data is transferred to a server.

MDN Reference

-

withCredentials

withCredentials: boolean

True when credentials are to be included in a cross-origin request. False when they are to be excluded in a cross-origin request and when cookies are to be ignored in its response. Initially false.

+

withCredentials

withCredentials: boolean

True when credentials are to be included in a cross-origin request. False when they are to be excluded in a cross-origin request and when cookies are to be ignored in its response. Initially false.

When set: throws an "InvalidStateError" DOMException if state is not unsent or opened, or if the send() flag is set.

MDN Reference

-

Settings

Member Visibility

On This Page

Constructors
Properties
+

Settings

Member Visibility

On This Page

Constructors
Properties
diff --git a/papi-dts/classes/_shared_log_error_model_.default.html b/papi-dts/classes/_shared_log_error_model_.default.html index d5f5db08df..fa4c52b31d 100644 --- a/papi-dts/classes/_shared_log_error_model_.default.html +++ b/papi-dts/classes/_shared_log_error_model_.default.html @@ -1,5 +1,5 @@ default | papi-dts

Classdefault

Error that force logs the error message before throwing. Useful for debugging in some situations.

-

Hierarchy

  • Error
    • default

Constructors

constructor +

Hierarchy

  • Error
    • default

Constructors

constructor

Properties

cause? message name @@ -7,7 +7,7 @@ stack? stackTraceLimit

Methods

captureStackTrace -

Constructors

constructor

Properties

Optionalcause

cause?: unknown

message

message: string

name

name: string

Static OptionalprepareStackTrace

prepareStackTrace?: ((err: Error, stackTraces: CallSite[]) => any)

Optional override for formatting stack traces

+

Constructors

constructor

Properties

Optionalcause

cause?: unknown

message

message: string

name

name: string

Static OptionalprepareStackTrace

prepareStackTrace?: ((err: Error, stackTraces: CallSite[]) => any)

Optional override for formatting stack traces

See

https://v8.dev/docs/stack-trace-api#customizing-stack-traces

Optionalstack

stack?: string

StaticstackTraceLimit

stackTraceLimit: number

Methods

StaticcaptureStackTrace

  • captureStackTrace(targetObject, constructorOpt?): void

  • Create .stack property on a target object

    Parameters

    • targetObject: object
    • OptionalconstructorOpt: Function

    Returns void

Settings

Member Visibility

On This Page

Constructors
Properties
Methods
diff --git a/papi-dts/classes/_shared_models_base_project_data_provider_engine_model_.BaseProjectDataProviderEngine.html b/papi-dts/classes/_shared_models_base_project_data_provider_engine_model_.BaseProjectDataProviderEngine.html index 25a53e2430..506d9c4dd6 100644 --- a/papi-dts/classes/_shared_models_base_project_data_provider_engine_model_.BaseProjectDataProviderEngine.html +++ b/papi-dts/classes/_shared_models_base_project_data_provider_engine_model_.BaseProjectDataProviderEngine.html @@ -7,7 +7,7 @@

See

IBaseProjectDataProviderEngine for more information on extending this class.

-

Type Parameters

Hierarchy (view full)

Constructors

constructor +

Type Parameters

Hierarchy (view full)

Constructors

constructor

Methods

notifyUpdate

Constructors

constructor

Methods

notifyUpdate

Settings

Member Visibility

On This Page

Constructors
Methods
+

Parameters

Returns void

Settings

Member Visibility

On This Page

Constructors
Methods
diff --git a/papi-dts/classes/_shared_models_data_provider_engine_model_.DataProviderEngine.html b/papi-dts/classes/_shared_models_data_provider_engine_model_.DataProviderEngine.html index 448ef2b284..32a90b7734 100644 --- a/papi-dts/classes/_shared_models_data_provider_engine_model_.DataProviderEngine.html +++ b/papi-dts/classes/_shared_models_data_provider_engine_model_.DataProviderEngine.html @@ -2,7 +2,7 @@ data provider engine class extends this class, it doesn't have to specify its own notifyUpdate function in order to use notifyUpdate.

See

IDataProviderEngine for more information on extending this class.

-

Type Parameters

Hierarchy (view full)

Implements

Constructors

constructor +

Type Parameters

Hierarchy (view full)

Implements

Constructors

constructor

Methods

notifyUpdate

Constructors

constructor

Methods

notifyUpdate

  • notifyUpdate(updateInstructions?): void

  • Method to run to send clients updates for a specific data type outside of the set<data_type> method. papi overwrites this function on the DataProviderEngine itself to emit an update based on @@ -28,4 +28,4 @@

    ＠see DataProviderUpdateInstructions for more info on the updateInstructions parameter

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

    -

    Parameters

    Returns void

Settings

Member Visibility

On This Page

Constructors
Methods
+

Parameters

Returns void

Settings

Member Visibility

On This Page

Constructors
Methods
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 5b66085261..e64958efac 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 subscribe @@ -19,23 +19,23 @@

Constructors

constructor

Properties

dispose

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

Disposes of this event, preparing it to release from memory

-

emit

emit: ((event: T) => void)

Runs the subscriptions for the event

+
    • (): void

    • Returns void

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

Properties

dispose

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

Disposes of this event, preparing it to release from memory

+

emit

emit: ((event: T) => void)

Runs the subscriptions for the event

Type declaration

    • (event): void

    • Parameters

      • event: T

        Event data to provide to subscribed callbacks

        -

      Returns void

subscribe

subscribe: PlatformEvent<T>

Subscribes a function to run when this event is emitted.

+

Returns void

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

  • get event(): PlatformEvent<T>

  • Event for listeners to subscribe to. Subscribes a function to run when this event is emitted. +

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

ProtectedassertNotDisposed

ProtecteddisposeFn

Methods

ProtectedassertNotDisposed

ProtecteddisposeFn

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

ProtectedemitFn

  • emitFn(event): void

  • Function that runs the subscriptions for the event. Added here so children can override emit +

    Returns Promise<boolean>

ProtectedemitFn

  • emitFn(event): void

  • Function that runs the subscriptions for the event. Added here so children can override emit and still call the base functionality. See NetworkEventEmitter.emit for example

    -

    Parameters

    • event: T

    Returns void

emitLocal

  • emitLocal(event): void

  • Runs only the subscriptions for the event that are on this process. Does not send over network

    +

    Parameters

    • event: T

    Returns void

emitLocal

  • emitLocal(event): void

  • Runs only the subscriptions for the event that are on this process. Does not send over network

    Parameters

    • event: T

      Event data to provide to subscribed callbacks

      -

    Returns void

Settings

Member Visibility

On This Page

Constructors
Properties
Accessors
Methods
+

Returns void

Settings

Member Visibility

On This Page

Constructors
Properties
Accessors
Methods
diff --git a/papi-dts/classes/_shared_models_project_data_provider_engine_factory_model_.LayeringProjectDataProviderEngineFactory.html b/papi-dts/classes/_shared_models_project_data_provider_engine_factory_model_.LayeringProjectDataProviderEngineFactory.html index d26068bc6e..cf107b2df9 100644 --- a/papi-dts/classes/_shared_models_project_data_provider_engine_factory_model_.LayeringProjectDataProviderEngineFactory.html +++ b/papi-dts/classes/_shared_models_project_data_provider_engine_factory_model_.LayeringProjectDataProviderEngineFactory.html @@ -5,15 +5,15 @@ highly recommend extending this class. Please see IProjectDataProviderEngineFactory.getAvailableProjects for more information on the requirements.

-

Type Parameters

Constructors

constructor +

Type Parameters

Constructors

constructor

Properties

pdpfId pdpfIdRegexString projectInterfacesToLayerOver providedProjectInterfaces

Methods

getAvailableProjects

Constructors

constructor

Properties

pdpfId

pdpfId: string

ProtectedpdpfIdRegexString

pdpfIdRegexString: string

Regex-escaped string of this pdpfId.

-

AbstractprojectInterfacesToLayerOver

projectInterfacesToLayerOver: undefined | string | (string | string[])[]

String representation of RegExp pattern(s) to match against projects' projectInterfaces +

Returns "shared/models/project-data-provider-engine-factory.model".LayeringProjectDataProviderEngineFactory<SupportedProjectInterfaces>

Properties

pdpfId

pdpfId: string

ProtectedpdpfIdRegexString

pdpfIdRegexString: string

Regex-escaped string of this pdpfId.

+

AbstractprojectInterfacesToLayerOver

projectInterfacesToLayerOver: undefined | string | (string | string[])[]

String representation of RegExp pattern(s) to match against projects' projectInterfaces (using the test function) to determine if they should be included in the available projects this Layering PDPF @@ -33,14 +33,14 @@

  • Include one
  • Include both two and three.
    • -

    AbstractprovidedProjectInterfaces

    providedProjectInterfaces: SupportedProjectInterfaces

    The list of projectInterfaces that this layering PDPF provides on top of existing projects.

    +

    AbstractprovidedProjectInterfaces

    providedProjectInterfaces: SupportedProjectInterfaces

    The list of projectInterfaces that this layering PDPF provides on top of existing projects.

    Example

    providedProjectInterfaces: ['four', 'five'];

    This layering PDPF will announce that its provides the projectInterfaces four and five for projects that match projectInterfacesToLayerOver.

    -

    Methods

    getAvailableProjects

    Methods

    getAvailableProjects

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    Methods
    +

    Parameters

    Returns Promise<ProjectMetadataWithoutFactoryInfo[]>

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    Methods
    diff --git a/papi-dts/classes/_shared_models_project_data_provider_engine_model_.ProjectDataProviderEngine.html b/papi-dts/classes/_shared_models_project_data_provider_engine_model_.ProjectDataProviderEngine.html index 44cddacb51..5c9b5d6955 100644 --- a/papi-dts/classes/_shared_models_project_data_provider_engine_model_.ProjectDataProviderEngine.html +++ b/papi-dts/classes/_shared_models_project_data_provider_engine_model_.ProjectDataProviderEngine.html @@ -7,7 +7,7 @@

    See

    IProjectDataProviderEngine for more information on extending this class.

    -

    Type Parameters

    Hierarchy (view full)

    Constructors

    constructor +

    Type Parameters

    Hierarchy (view full)

    Constructors

    constructor

    Methods

    notifyUpdate

    Constructors

    constructor

    Methods

    notifyUpdate

    Settings

    Member Visibility

    On This Page

    Constructors
    Methods
    +

    Parameters

    Returns void

    Settings

    Member Visibility

    On This Page

    Constructors
    Methods
    diff --git a/papi-dts/classes/_shared_models_web_view_factory_model_.WebViewFactory.html b/papi-dts/classes/_shared_models_web_view_factory_model_.WebViewFactory.html index ed99f61984..9b92d2adc4 100644 --- a/papi-dts/classes/_shared_models_web_view_factory_model_.WebViewFactory.html +++ b/papi-dts/classes/_shared_models_web_view_factory_model_.WebViewFactory.html @@ -13,13 +13,13 @@ want to overwrite this class's getWebView because that will eliminate most of the benefits associated with using this class.

    See

    IWebViewProvider for more information on extending this class.

    -

    Type Parameters

    Implements

    Constructors

    constructor +

    Type Parameters

    Implements

    Constructors

    constructor

    Properties

    webViewType

    Methods

    createWebViewController dispose getWebView getWebViewDefinition -

    Constructors

    constructor

    Properties

    ReadonlywebViewType

    webViewType: WebViewType

    Methods

    AbstractcreateWebViewController

    Constructors

    constructor

    Properties

    ReadonlywebViewType

    webViewType: WebViewType

    Methods

    AbstractcreateWebViewController

    • createWebViewController(webViewDefinition, webViewNonce): Promise<WebViewControllers[WebViewType]>

    • Creates a WebViewController that corresponds to the WebViewDefinition provided. WebViewFactory calls this as part of its getWebView. WebViewFactory will automatically register this controller with the web view provider service (papi.webViewProviders.registerWebViewController), run its dispose when the web view is @@ -37,15 +37,15 @@ web view controller created for this web view.

    Returns Promise<WebViewControllers[WebViewType]>

    Web view controller for the web view with the webViewDefinition provided. Or undefined if you do not want to create a web view controller for this web view.

    -

    dispose

    • dispose(): Promise<boolean>

    • Disposes of all WVCs that were created by this provider

      -

      Returns Promise<boolean>

    getWebView

    dispose

    • dispose(): Promise<boolean>

    • Disposes of all WVCs that were created by this provider

      +

      Returns Promise<boolean>

    getWebView

    AbstractgetWebViewDefinition

    AbstractgetWebViewDefinition

    • getWebViewDefinition(savedWebViewDefinition, getWebViewOptions, webViewNonce): Promise<undefined | WebViewDefinition>

    • Receives a SavedWebViewDefinition and fills it out into a full WebViewDefinition, providing the contents of the web view and other properties that are important for displaying the web view.

      WebViewFactory calls this as part of its getWebView, which is called by the PAPI @@ -72,4 +72,4 @@ applicable (See papi.webViewProviders.registerWebViewController).

    Returns Promise<undefined | WebViewDefinition>

    Full WebViewDefinition including the content and other important display properties based on the SavedWebViewDefinition provided

    -

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    Methods
    +

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    Methods
    diff --git a/papi-dts/classes/_shared_utils_project_settings_document_combiner_.default.html b/papi-dts/classes/_shared_utils_project_settings_document_combiner_.default.html index bd05eaff0b..812435b84e 100644 --- a/papi-dts/classes/_shared_utils_project_settings_document_combiner_.default.html +++ b/papi-dts/classes/_shared_utils_project_settings_document_combiner_.default.html @@ -1,4 +1,4 @@ -default | papi-dts

    Classdefault

    Hierarchy (view full)

    Constructors

    constructor +default | papi-dts

    Classdefault

    Hierarchy (view full)

    Constructors

    constructor

    Properties

    baseDocument contributions latestOutput @@ -20,9 +20,9 @@ validateBaseDocument validateContribution validateOutput -

    Constructors

    constructor

    Properties

    ProtectedbaseDocument

    baseDocument: JsonDocumentLike

    Protected Readonlycontributions

    contributions: Map<string, JsonDocumentLike>

    ProtectedlatestOutput

    latestOutput: undefined | JsonDocumentLike

    ReadonlyonDidRebuild

    onDidRebuild: PlatformEvent<undefined>

    Event that emits to announce that the document has been rebuilt and the output has been updated

    -

    Protected Readonlyoptions

    options: DocumentCombinerOptions

    Protected ReadonlysettingTypeName

    settingTypeName: "Project Setting" = 'Project Setting'

    Name for type of setting to use in error messages

    -

    Methods

    addOrUpdateContribution

    • addOrUpdateContribution(documentName, document): undefined | JsonDocumentLike

    • Add or update one of the contribution documents for the composition process

      +

    Constructors

    constructor

    Properties

    ProtectedbaseDocument

    baseDocument: JsonDocumentLike

    Protected Readonlycontributions

    contributions: Map<string, JsonDocumentLike>

    ProtectedlatestOutput

    latestOutput: undefined | JsonDocumentLike

    ReadonlyonDidRebuild

    onDidRebuild: PlatformEvent<undefined>

    Event that emits to announce that the document has been rebuilt and the output has been updated

    +

    Protected Readonlyoptions

    options: DocumentCombinerOptions

    Protected ReadonlysettingTypeName

    settingTypeName: "Project Setting" = 'Project Setting'

    Name for type of setting to use in error messages

    +

    Methods

    addOrUpdateContribution

    • addOrUpdateContribution(documentName, document): undefined | JsonDocumentLike

    • Add or update one of the contribution documents for the composition process

      Note: the order in which contribution documents are added can be considered to be indeterminate as it is currently ordered by however Map.forEach provides the contributions. The order matters when merging two arrays into one. Also, when options.ignoreDuplicateProperties is @@ -33,13 +33,13 @@

    • document: JsonDocumentLike

      Content of the contributed document to combine

    Returns undefined | JsonDocumentLike

    Recalculated output document given the new or updated contribution and existing other documents

    -

    deleteAllContributions

    deleteAllContributions

    deleteContribution

    deleteContribution

    ProtectedgetLocalizedOutput

    ProtectedgetLocalizedOutput

    getLocalizedProjectSettingsContributionInfo

    getLocalizedProjectSettingsContributionInfo

    getProjectSettingsContributionInfo

    getProjectSettingsContributionInfo

    ProtectedperformSchemaValidation

    rebuild

    ProtectedperformSchemaValidation

    rebuild

    ProtectedtransformBaseDocumentAfterValidation

    ProtectedtransformBaseDocumentAfterValidation

    ProtectedtransformContributionAfterValidation

    ProtectedtransformContributionAfterValidation

    Returns JsonDocumentLike

    Transformed contributed document

    -

    ProtectedtransformFinalOutputBeforeValidation

    ProtectedtransformFinalOutputBeforeValidation

    updateBaseDocument

    Returns JsonDocumentLike

    updateBaseDocument

    ProtectedvalidateBaseDocument

    ProtectedvalidateBaseDocument

    ProtectedvalidateContribution

    Returns void

    ProtectedvalidateContribution

    ProtectedvalidateOutput

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    Methods
    +

    Returns void

    ProtectedvalidateOutput

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    Methods
    diff --git a/papi-dts/classes/_shared_utils_settings_document_combiner_base_.default.html b/papi-dts/classes/_shared_utils_settings_document_combiner_base_.default.html index 022f5e1ec1..f58e1e60de 100644 --- a/papi-dts/classes/_shared_utils_settings_document_combiner_base_.default.html +++ b/papi-dts/classes/_shared_utils_settings_document_combiner_base_.default.html @@ -1,4 +1,4 @@ -default | papi-dts

    ClassdefaultAbstract

    Hierarchy (view full)

    Constructors

    constructor +default | papi-dts

    ClassdefaultAbstract

    Hierarchy (view full)

    Constructors

    constructor

    Properties

    baseDocument contributions latestOutput @@ -18,9 +18,9 @@ validateBaseDocument validateContribution validateOutput -

    Constructors

    constructor

    Properties

    ProtectedbaseDocument

    baseDocument: JsonDocumentLike

    Protected Readonlycontributions

    contributions: Map<string, JsonDocumentLike>

    ProtectedlatestOutput

    latestOutput: undefined | JsonDocumentLike

    ReadonlyonDidRebuild

    onDidRebuild: PlatformEvent<undefined>

    Event that emits to announce that the document has been rebuilt and the output has been updated

    -

    Protected Readonlyoptions

    options: DocumentCombinerOptions

    Protected ReadonlysettingTypeName

    settingTypeName: string

    Name for type of setting to use in error messages

    -

    Methods

    addOrUpdateContribution

    • addOrUpdateContribution(documentName, document): undefined | JsonDocumentLike

    • Add or update one of the contribution documents for the composition process

      +

    Constructors

    constructor

    Properties

    ProtectedbaseDocument

    baseDocument: JsonDocumentLike

    Protected Readonlycontributions

    contributions: Map<string, JsonDocumentLike>

    ProtectedlatestOutput

    latestOutput: undefined | JsonDocumentLike

    ReadonlyonDidRebuild

    onDidRebuild: PlatformEvent<undefined>

    Event that emits to announce that the document has been rebuilt and the output has been updated

    +

    Protected Readonlyoptions

    options: DocumentCombinerOptions

    Protected ReadonlysettingTypeName

    settingTypeName: string

    Name for type of setting to use in error messages

    +

    Methods

    addOrUpdateContribution

    • addOrUpdateContribution(documentName, document): undefined | JsonDocumentLike

    • Add or update one of the contribution documents for the composition process

      Note: the order in which contribution documents are added can be considered to be indeterminate as it is currently ordered by however Map.forEach provides the contributions. The order matters when merging two arrays into one. Also, when options.ignoreDuplicateProperties is @@ -31,13 +31,13 @@

    • document: JsonDocumentLike

      Content of the contributed document to combine

    Returns undefined | JsonDocumentLike

    Recalculated output document given the new or updated contribution and existing other documents

    -

    deleteAllContributions

    deleteAllContributions

    deleteContribution

    deleteContribution

    ProtectedgetLocalizedOutput

    ProtectedgetLocalizedOutput

    Protected AbstractperformSchemaValidation

    rebuild

    Protected AbstractperformSchemaValidation

    rebuild

    ProtectedtransformBaseDocumentAfterValidation

    ProtectedtransformBaseDocumentAfterValidation

    ProtectedtransformContributionAfterValidation

    ProtectedtransformContributionAfterValidation

    Returns JsonDocumentLike

    Transformed contributed document

    -

    ProtectedtransformFinalOutputBeforeValidation

    ProtectedtransformFinalOutputBeforeValidation

    updateBaseDocument

    Returns JsonDocumentLike

    updateBaseDocument

    ProtectedvalidateBaseDocument

    ProtectedvalidateBaseDocument

    ProtectedvalidateContribution

    Returns void

    ProtectedvalidateContribution

    ProtectedvalidateOutput

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    Methods
    +

    Returns void

    ProtectedvalidateOutput

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    Methods
    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 4991aff117..4c00bbcede 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

    EnumerationEntryType

    Type of file system item in a directory

    -

    Enumeration Members

    Directory +

    Enumeration Members

    Directory File Unknown -

    Enumeration Members

    Directory

    Directory

    File

    File

    Unknown

    Unknown

    Settings

    Member Visibility

    On This Page

    Enumeration Members
    +

    Enumeration Members

    Directory

    Directory

    File

    File

    Unknown

    Unknown

    Settings

    Member Visibility

    On This Page

    Enumeration Members
    diff --git a/papi-dts/enums/_shared_data_rpc_model_.ConnectionStatus.html b/papi-dts/enums/_shared_data_rpc_model_.ConnectionStatus.html index f599807c63..1db29b874b 100644 --- a/papi-dts/enums/_shared_data_rpc_model_.ConnectionStatus.html +++ b/papi-dts/enums/_shared_data_rpc_model_.ConnectionStatus.html @@ -1,9 +1,9 @@ ConnectionStatus | papi-dts

    EnumerationConnectionStatus

    Whether an RPC object 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

    Finished setting up its connection

    -

    Connecting

    Connecting

    Attempting to connect to the network

    -

    Disconnected

    Disconnected

    Not connected to the network

    -

    Settings

    Member Visibility

    On This Page

    Enumeration Members
    +

    Connecting

    Connecting

    Attempting to connect to the network

    +

    Disconnected

    Disconnected

    Not connected to the network

    +

    Settings

    Member Visibility

    On This Page

    Enumeration Members
    diff --git a/papi-dts/enums/_shared_global_this_model_.ProcessType.html b/papi-dts/enums/_shared_global_this_model_.ProcessType.html index e6f1add813..86d583713c 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

    EnumerationProcessType

    Type of Paranext process

    -

    Enumeration Members

    ExtensionHost +

    Enumeration Members

    ExtensionHost Main Renderer -

    Enumeration Members

    ExtensionHost

    ExtensionHost

    Main

    Main

    Renderer

    Renderer

    Settings

    Member Visibility

    On This Page

    Enumeration Members
    +

    Enumeration Members

    ExtensionHost

    ExtensionHost

    Main

    Main

    Renderer

    Renderer

    Settings

    Member Visibility

    On This Page

    Enumeration Members
    diff --git a/papi-dts/enums/_shared_models_elevated_privileges_model_.ElevatedPrivilegeNames.html b/papi-dts/enums/_shared_models_elevated_privileges_model_.ElevatedPrivilegeNames.html index 67bb464907..8389804e47 100644 --- a/papi-dts/enums/_shared_models_elevated_privileges_model_.ElevatedPrivilegeNames.html +++ b/papi-dts/enums/_shared_models_elevated_privileges_model_.ElevatedPrivilegeNames.html @@ -1,4 +1,4 @@ ElevatedPrivilegeNames | papi-dts

    EnumerationElevatedPrivilegeNames

    String constants that are listed in an extension's manifest.json to state needed privileges

    -

    Enumeration Members

    createProcess +

    Enumeration Members

    createProcess manageExtensions -

    Enumeration Members

    createProcess

    createProcess

    manageExtensions

    manageExtensions

    Settings

    Member Visibility

    On This Page

    Enumeration Members
    +

    Enumeration Members

    createProcess

    createProcess

    manageExtensions

    manageExtensions

    Settings

    Member Visibility

    On This Page

    Enumeration Members
    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 6b9330b8a3..87d02f633c 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

    EnumerationWebViewContentType

    The type of code that defines a webview's content

    -

    Enumeration Members

    HTML +

    Enumeration Members

    HTML React URL

    Enumeration Members

    HTML

    HTML

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

    -

    React

    React

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

    React

    React

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

    -

    URL

    URL

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

    URL

    URL

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

    -

    Settings

    Member Visibility

    On This Page

    Enumeration Members
    +

    Settings

    Member Visibility

    On This Page

    Enumeration Members
    diff --git a/papi-dts/functions/__papi_backend_.fetch.html b/papi-dts/functions/__papi_backend_.fetch.html index b751ad6cbc..be490a2406 100644 --- a/papi-dts/functions/__papi_backend_.fetch.html +++ b/papi-dts/functions/__papi_backend_.fetch.html @@ -1,3 +1,3 @@ fetch | papi-dts

    Functionfetch

    This is just an alias for internet.fetch

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

    • MDN Reference

      -

      Parameters

      • input: RequestInfo | URL
      • Optionalinit: RequestInit

      Returns Promise<Response>

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

    • Parameters

      • input: string | Request | URL
      • Optionalinit: RequestInit

      Returns Promise<Response>

    Settings

    Member Visibility
    +

    Parameters

    Returns Promise<Response>

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

  • Parameters

    Returns Promise<Response>

    • Settings

    Member Visibility
    diff --git a/papi-dts/functions/__papi_frontend_.fetch.html b/papi-dts/functions/__papi_frontend_.fetch.html index 8dda310191..7bd871c3f9 100644 --- a/papi-dts/functions/__papi_frontend_.fetch.html +++ b/papi-dts/functions/__papi_frontend_.fetch.html @@ -1,3 +1,3 @@ fetch | papi-dts

    Functionfetch

    This is just an alias for internet.fetch

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

    • MDN Reference

      -

      Parameters

      • input: RequestInfo | URL
      • Optionalinit: RequestInit

      Returns Promise<Response>

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

    • Parameters

      • input: string | Request | URL
      • Optionalinit: RequestInit

      Returns Promise<Response>

    Settings

    Member Visibility
    +

    Parameters

    Returns Promise<Response>

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

  • Parameters

    Returns Promise<Response>

    • Settings

    Member Visibility
    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 b46768a03b..4499abe4ed 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

    FunctioncreateWebSocket

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

    • createWebSocket(url): Promise<WebSocket>

    • Parameters

      • url: string

      Returns Promise<WebSocket>

      WebSocket

      -

    Settings

    Member Visibility
    +

    Settings

    Member Visibility
    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 6360289c56..d187ea5968 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

    FunctionbuildExtensionPathFromName

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

    Parameters

    Returns string

    Settings

    Member Visibility
    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 62a8131483..e24b84c34a 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

    FunctionsetExtensionUris

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

    Parameters

    Returns void

    Settings

    Member Visibility
    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 139d97a278..1d1aebaccf 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 @@
  • Optionalmode: number

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

    -

    • Returns Promise<void>

    Settings

    Member Visibility
    +

    Returns Promise<void>

    Settings

    Member Visibility
    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 1272cf4b27..882c43d93f 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

    FunctioncreateDir

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

    Settings

    Member Visibility
    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 c42bd49e3e..719871c436 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

    FunctiondeleteDir

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

    Settings

    Member Visibility
    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 b0b5054ef8..7153bc6936 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

    FunctiondeleteFile

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

    Settings

    Member Visibility
    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 6bdcc4d51d..59b72710a8 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
    +

    Settings

    Member Visibility
    diff --git a/papi-dts/functions/_node_services_node_file_system_service_.moveFile.html b/papi-dts/functions/_node_services_node_file_system_service_.moveFile.html index 07dc84fea0..e56054e8b5 100644 --- a/papi-dts/functions/_node_services_node_file_system_service_.moveFile.html +++ b/papi-dts/functions/_node_services_node_file_system_service_.moveFile.html @@ -1,4 +1,4 @@ moveFile | papi-dts

    FunctionmoveFile

    • moveFile(sourceUri, destinationUri): Promise<void>

    • Moves a file from one location to another

      Parameters

      • sourceUri: string

        The location of the file to move

      • destinationUri: string

        The uri where the file should be moved

        -

      Returns Promise<void>

    Settings

    Member Visibility
    +

    Returns Promise<void>

    Settings

    Member Visibility
    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 c526a0e550..cd218e7870 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
    +

    Settings

    Member Visibility
    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 7cc7a032d7..ca8bd9694b 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

    FunctionreadFileBinary

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

    Settings

    Member Visibility
    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 cb1e07a09b..3164556db1 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

    FunctionreadFileText

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

    Settings

    Member Visibility
    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 c1fbe8e663..7d8342dda7 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

    Functiontouch

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

    Settings

    Member Visibility
    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 aed1aa1515..6b8fe02a7b 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
    +

    Settings

    Member Visibility
    diff --git a/papi-dts/functions/_node_utils_crypto_util_.createNonce.html b/papi-dts/functions/_node_utils_crypto_util_.createNonce.html index 688b16fa93..ad7f6d1ebf 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

    FunctioncreateNonce

    Settings

    Member Visibility
    +

    Settings

    Member Visibility
    diff --git a/papi-dts/functions/_node_utils_crypto_util_.createUuid.html b/papi-dts/functions/_node_utils_crypto_util_.createUuid.html index b3d3e34b78..af5b503855 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

    FunctioncreateUuid

    Settings

    Member Visibility
    +createUuid | papi-dts

    FunctioncreateUuid

    Settings

    Member Visibility
    diff --git a/papi-dts/functions/_node_utils_crypto_util_.generateHashFromBuffer.html b/papi-dts/functions/_node_utils_crypto_util_.generateHashFromBuffer.html index 279eff1016..51883c116c 100644 --- a/papi-dts/functions/_node_utils_crypto_util_.generateHashFromBuffer.html +++ b/papi-dts/functions/_node_utils_crypto_util_.generateHashFromBuffer.html @@ -3,4 +3,4 @@
  • encodingType:
        | "base64"
        | "base64url"
        | "binary"
        | "hex"

    String encoding to use for returning the binary hash value that is calculated

  • buffer: Buffer

    Raw data to be fed into the hash algorithm

    • Returns string

    String encoded value of the digest (https://csrc.nist.gov/glossary/term/hash_digest)

    -

    Settings

    Member Visibility
    +

    Settings

    Member Visibility
    diff --git a/papi-dts/functions/_node_utils_util_.getAppDir.html b/papi-dts/functions/_node_utils_util_.getAppDir.html index e0637c064a..7ac56ac1ae 100644 --- a/papi-dts/functions/_node_utils_util_.getAppDir.html +++ b/papi-dts/functions/_node_utils_util_.getAppDir.html @@ -1,5 +1,5 @@ getAppDir | papi-dts

    FunctiongetAppDir

    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

    -

    Properties

    clear +

    Properties

    clear

    Properties

    clear

    clear: (() => void)

    Settings

    Member Visibility

    On This Page

    Properties
    diff --git a/papi-dts/functions/_node_utils_util_.getPathFromUri.html b/papi-dts/functions/_node_utils_util_.getPathFromUri.html index 99fe185896..86e4d6437d 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

    FunctiongetPathFromUri

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

    Settings

    Member Visibility
    diff --git a/papi-dts/functions/_node_utils_util_.isNoisyDevModeEnvVariableSet.html b/papi-dts/functions/_node_utils_util_.isNoisyDevModeEnvVariableSet.html index c4717e9649..e42c616f8d 100644 --- a/papi-dts/functions/_node_utils_util_.isNoisyDevModeEnvVariableSet.html +++ b/papi-dts/functions/_node_utils_util_.isNoisyDevModeEnvVariableSet.html @@ -1,3 +1,3 @@ isNoisyDevModeEnvVariableSet | papi-dts

    FunctionisNoisyDevModeEnvVariableSet

    Determines if running in noisy dev mode

    • isNoisyDevModeEnvVariableSet(): boolean

    • Returns boolean

      True if the process is running in noisy dev mode, false otherwise

      -

    Settings

    Member Visibility
    +

    Settings

    Member Visibility
    diff --git a/papi-dts/functions/_node_utils_util_.joinUriPaths.html b/papi-dts/functions/_node_utils_util_.joinUriPaths.html index 72d941ccfd..81fbf91109 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
    +

    Settings

    Member Visibility
    diff --git a/papi-dts/functions/_node_utils_util_.resolveHtmlPath.html b/papi-dts/functions/_node_utils_util_.resolveHtmlPath.html index 146e18fc62..b584406ada 100644 --- a/papi-dts/functions/_node_utils_util_.resolveHtmlPath.html +++ b/papi-dts/functions/_node_utils_util_.resolveHtmlPath.html @@ -1 +1 @@ -resolveHtmlPath | papi-dts

    FunctionresolveHtmlPath

    Settings

    Member Visibility
    +resolveHtmlPath | papi-dts

    FunctionresolveHtmlPath

    Settings

    Member Visibility
    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 83ba3f492e..770cd3a069 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
    +

    Returns void

    Settings

    Member Visibility
    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 7b81711da1..3eccf5a8ed 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
    +

    Settings

    Member Visibility
    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 f74fc75163..3cd14c89d3 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: THookParams) => NetworkObject<object> | undefined)

    A function that takes in a networkObjectSource and returns a NetworkObject

    -

    Settings

    Member Visibility
    +

    Settings

    Member Visibility
    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 aa79bd3fe9..5fed449812 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 @@ -31,4 +31,4 @@
  • isLoading: whether the data with the data type and selector is awaiting retrieval from the data provider
    • -

    Settings

    Member Visibility
    +

    Settings

    Member Visibility
    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 06e3b37c6f..dc8d4a9f0a 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
    +

    Settings

    Member Visibility
    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 296d9d2ce9..76d96c1fc7 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
    +

    Settings

    Member Visibility
    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 303461a9cd..3dc4855f23 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?: Partial<DialogOptions & UseDialogCallbackOptions>) => 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?: Partial<DialogOptions & UseDialogCallbackOptions>) => 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
    +

    Settings

    Member Visibility
    diff --git a/papi-dts/functions/_renderer_hooks_papi_hooks_use_localized_strings_hook_.default.html b/papi-dts/functions/_renderer_hooks_papi_hooks_use_localized_strings_hook_.default.html index ac5948a2f8..7a5abda85f 100644 --- a/papi-dts/functions/_renderer_hooks_papi_hooks_use_localized_strings_hook_.default.html +++ b/papi-dts/functions/_renderer_hooks_papi_hooks_use_localized_strings_hook_.default.html @@ -15,4 +15,4 @@
  • localizedStrings: The current state of the localizations, either defaultState or the stored state on the papi, if any
    • -

    Settings

    Member Visibility
    +

    Settings

    Member Visibility
    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 454b984502..92124732a1 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 @@ -39,4 +39,4 @@
  • isLoading: whether the data with the data type and selector is awaiting retrieval from the data provider
    • -

    Settings

    Member Visibility
    +

    Settings

    Member Visibility
    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 f84984ec81..e26bf62b05 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 @@ -12,4 +12,4 @@

    Returns undefined | ProjectDataProviderInterfaces[ProjectInterface]

    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
    +

    Settings

    Member Visibility
    diff --git a/papi-dts/functions/_renderer_hooks_papi_hooks_use_project_setting_hook_.default.html b/papi-dts/functions/_renderer_hooks_papi_hooks_use_project_setting_hook_.default.html index 2b7e1fc464..a017ae5730 100644 --- a/papi-dts/functions/_renderer_hooks_papi_hooks_use_project_setting_hook_.default.html +++ b/papi-dts/functions/_renderer_hooks_papi_hooks_use_project_setting_hook_.default.html @@ -30,4 +30,4 @@ setting
  • isLoading: whether the setting value is awaiting retrieval from the Project Data Provider
    • -

    Settings

    Member Visibility
    +

    Settings

    Member Visibility
    diff --git a/papi-dts/functions/_renderer_hooks_papi_hooks_use_scroll_group_scr_ref_hook_.default.html b/papi-dts/functions/_renderer_hooks_papi_hooks_use_scroll_group_scr_ref_hook_.default.html index daa4921cc8..92561cf6e7 100644 --- a/papi-dts/functions/_renderer_hooks_papi_hooks_use_scroll_group_scr_ref_hook_.default.html +++ b/papi-dts/functions/_renderer_hooks_papi_hooks_use_scroll_group_scr_ref_hook_.default.html @@ -22,4 +22,4 @@
  • setScrollGroupId: Function to use to update the scroll group with which this scrollGroupScrRef is synced
    • -

    Settings

    Member Visibility
    +

    Settings

    Member Visibility
    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 71ee793d5b..6ed22cbd08 100644 --- a/papi-dts/functions/_renderer_hooks_papi_hooks_use_setting_hook_.default.html +++ b/papi-dts/functions/_renderer_hooks_papi_hooks_use_setting_hook_.default.html @@ -18,4 +18,4 @@
  • setSetting: Function that updates the setting to a new value
  • resetSetting: Function that removes the setting and resets the value to defaultState
    • -

    Settings

    Member Visibility
    +

    Settings

    Member Visibility
    diff --git a/papi-dts/functions/_renderer_hooks_papi_hooks_use_web_view_controller_hook_.default.html b/papi-dts/functions/_renderer_hooks_papi_hooks_use_web_view_controller_hook_.default.html index fb9ca9aefb..a841844191 100644 --- a/papi-dts/functions/_renderer_hooks_papi_hooks_use_web_view_controller_hook_.default.html +++ b/papi-dts/functions/_renderer_hooks_papi_hooks_use_web_view_controller_hook_.default.html @@ -9,4 +9,4 @@

    Returns undefined | NetworkObject<WebViewControllers[WebViewType]>

    undefined if the Web View Controller has not been retrieved, the requested Web View Controller if it has been retrieved and is not disposed, and undefined again if the Web View Controller is disposed

    -

    Settings

    Member Visibility
    +

    Settings

    Member Visibility
    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 1e870da5ef..e09b5690d2 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

    FunctionblockWebSocketsToPapiNetwork

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

    -

    Settings

    Member Visibility
    +

    Settings

    Member Visibility
    diff --git a/papi-dts/functions/_renderer_services_scroll_group_service_host_.getScrRefSync.html b/papi-dts/functions/_renderer_services_scroll_group_service_host_.getScrRefSync.html index e4b4a93180..99beb5c663 100644 --- a/papi-dts/functions/_renderer_services_scroll_group_service_host_.getScrRefSync.html +++ b/papi-dts/functions/_renderer_services_scroll_group_service_host_.getScrRefSync.html @@ -1,2 +1,2 @@ getScrRefSync | papi-dts

    FunctiongetScrRefSync

    • getScrRefSync(scrollGroupId?): ScriptureReference

    • See IScrollGroupRemoteService.getScrRef

      -

      Parameters

      • OptionalscrollGroupId: number

      Returns ScriptureReference

    Settings

    Member Visibility
    +

    Parameters

    Returns ScriptureReference

    Settings

    Member Visibility
    diff --git a/papi-dts/functions/_renderer_services_scroll_group_service_host_.onDidUpdateScrRef.html b/papi-dts/functions/_renderer_services_scroll_group_service_host_.onDidUpdateScrRef.html index ac7a9ef6b7..4912218e24 100644 --- a/papi-dts/functions/_renderer_services_scroll_group_service_host_.onDidUpdateScrRef.html +++ b/papi-dts/functions/_renderer_services_scroll_group_service_host_.onDidUpdateScrRef.html @@ -1,2 +1,2 @@ onDidUpdateScrRef | papi-dts

    FunctiononDidUpdateScrRef

    Event that emits with information about a changed Scripture Reference for a scroll group

    -

    Settings

    Member Visibility
    +

    Settings

    Member Visibility
    diff --git a/papi-dts/functions/_renderer_services_scroll_group_service_host_.setScrRefSync.html b/papi-dts/functions/_renderer_services_scroll_group_service_host_.setScrRefSync.html index a6ddbee6db..5bd446e3ce 100644 --- a/papi-dts/functions/_renderer_services_scroll_group_service_host_.setScrRefSync.html +++ b/papi-dts/functions/_renderer_services_scroll_group_service_host_.setScrRefSync.html @@ -2,4 +2,4 @@

    Parameters

    Returns boolean

    Settings

    Member Visibility
    +

    Returns boolean

    Settings

    Member Visibility
    diff --git a/papi-dts/functions/_renderer_services_scroll_group_service_host_.startScrollGroupService.html b/papi-dts/functions/_renderer_services_scroll_group_service_host_.startScrollGroupService.html index 2dee110e1e..6c516f6b65 100644 --- a/papi-dts/functions/_renderer_services_scroll_group_service_host_.startScrollGroupService.html +++ b/papi-dts/functions/_renderer_services_scroll_group_service_host_.startScrollGroupService.html @@ -1,2 +1,2 @@ startScrollGroupService | papi-dts

    FunctionstartScrollGroupService

    • startScrollGroupService(): Promise<void>

    • Register the network object that backs the scroll group service

      -

      Returns Promise<void>

    Settings

    Member Visibility
    +

    Returns Promise<void>

    Settings

    Member Visibility
    diff --git a/papi-dts/functions/_shared_data_rpc_model_.createErrorResponse.html b/papi-dts/functions/_shared_data_rpc_model_.createErrorResponse.html index 6ac6ae9c9f..a9c63d32ea 100644 --- a/papi-dts/functions/_shared_data_rpc_model_.createErrorResponse.html +++ b/papi-dts/functions/_shared_data_rpc_model_.createErrorResponse.html @@ -4,4 +4,4 @@
  • OptionalrequestId: RequestId

    ID of the request that this response is intended to address. If no ID was provided, don't pass a value to this parameter.

    • Returns JSONRPCErrorResponse

    JSONRPCErrorResponse message that can be serialized and sent over a connection

    -

    Settings

    Member Visibility
    +

    Settings

    Member Visibility
    diff --git a/papi-dts/functions/_shared_data_rpc_model_.createRequest.html b/papi-dts/functions/_shared_data_rpc_model_.createRequest.html index ed3fde0acd..25b3c17068 100644 --- a/papi-dts/functions/_shared_data_rpc_model_.createRequest.html +++ b/papi-dts/functions/_shared_data_rpc_model_.createRequest.html @@ -3,4 +3,4 @@
  • requestParams: RequestParams

    Parameters to pass along when the request is processed

  • requestId: RequestId

    Unique ID for this connection of this request

    • Returns JSONRPCRequest

    JSONRPCRequest message that can be serialized and sent over a connection

    -

    Settings

    Member Visibility
    +

    Settings

    Member Visibility
    diff --git a/papi-dts/functions/_shared_data_rpc_model_.createSuccessResponse.html b/papi-dts/functions/_shared_data_rpc_model_.createSuccessResponse.html index 531d311bfa..88da78a456 100644 --- a/papi-dts/functions/_shared_data_rpc_model_.createSuccessResponse.html +++ b/papi-dts/functions/_shared_data_rpc_model_.createSuccessResponse.html @@ -3,4 +3,4 @@
  • OptionalrequestId: RequestId

    ID of the request that this response is intended to address. If no ID was provided, don't pass a value to this parameter.

    • Returns JSONRPCSuccessResponse

    JSONRPCSuccessResponse message that can be serialized and sent over a connection

    -

    Settings

    Member Visibility
    +

    Settings

    Member Visibility
    diff --git a/papi-dts/functions/_shared_data_rpc_model_.deserializeMessage.html b/papi-dts/functions/_shared_data_rpc_model_.deserializeMessage.html index 4bc287590d..7531fc6182 100644 --- a/papi-dts/functions/_shared_data_rpc_model_.deserializeMessage.html +++ b/papi-dts/functions/_shared_data_rpc_model_.deserializeMessage.html @@ -4,4 +4,4 @@ must not be converted to undefined per the JSONRPC protocol.

    After a request has been processed by the protocol stack, call fixupResponse to restore undefined responses.

    -

    Parameters

    Returns JSONRPCRequest | JSONRPCResponse | (JSONRPCRequest | JSONRPCResponse)[]

    Settings

    Member Visibility
    +

    Parameters

    Returns JSONRPCRequest | JSONRPCResponse | (JSONRPCRequest | JSONRPCResponse)[]

    Settings

    Member Visibility
    diff --git a/papi-dts/functions/_shared_data_rpc_model_.fixupResponse.html b/papi-dts/functions/_shared_data_rpc_model_.fixupResponse.html index de623f8525..f0a4b7516a 100644 --- a/papi-dts/functions/_shared_data_rpc_model_.fixupResponse.html +++ b/papi-dts/functions/_shared_data_rpc_model_.fixupResponse.html @@ -1,4 +1,4 @@ fixupResponse | papi-dts

    FunctionfixupResponse

    • fixupResponse(response): JSONRPCResponse

    • Convert null results back to undefined once we're out of the protocol stack.

      This works in tandem with deserializeMessage to properly handle null values in JSONRPC messages.

      -

      Parameters

      • response: JSONRPCResponse

      Returns JSONRPCResponse

    Settings

    Member Visibility
    +

    Parameters

    Returns JSONRPCResponse

    Settings

    Member Visibility
    diff --git a/papi-dts/functions/_shared_data_rpc_model_.requestWithRetry.html b/papi-dts/functions/_shared_data_rpc_model_.requestWithRetry.html index 4b1df239aa..d9136b2610 100644 --- a/papi-dts/functions/_shared_data_rpc_model_.requestWithRetry.html +++ b/papi-dts/functions/_shared_data_rpc_model_.requestWithRetry.html @@ -5,4 +5,4 @@
  • name: string

    Name of the handler running this request for logging purposes

  • requestType: string

    Type of request for logging purposes

    • Returns Promise<JSONRPCResponse>

    The response from the request including the method not found error if it times out

    -

    Settings

    Member Visibility
    +

    Settings

    Member Visibility
    diff --git a/papi-dts/functions/_shared_data_rpc_model_.sendPayloadToWebSocket.html b/papi-dts/functions/_shared_data_rpc_model_.sendPayloadToWebSocket.html index 7e57312f7f..52462b821b 100644 --- a/papi-dts/functions/_shared_data_rpc_model_.sendPayloadToWebSocket.html +++ b/papi-dts/functions/_shared_data_rpc_model_.sendPayloadToWebSocket.html @@ -1,2 +1,2 @@ sendPayloadToWebSocket | papi-dts

    FunctionsendPayloadToWebSocket

    • sendPayloadToWebSocket(ws, payload): void

    • Serialize a payload, if needed, and send it over the provided WebSocket

      -

      Parameters

      • ws: undefined | WebSocket
      • payload: unknown

      Returns void

    Settings

    Member Visibility
    +

    Parameters

    Returns void

    Settings

    Member Visibility
    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 331e232137..f1107dbfa9 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

    FunctiongetDataProviderDataTypeFromFunctionName

    Settings

    Member Visibility
    +

    Settings

    Member Visibility
    diff --git a/papi-dts/functions/_shared_models_project_lookup_service_model_.areProjectInterfacesIncluded.html b/papi-dts/functions/_shared_models_project_lookup_service_model_.areProjectInterfacesIncluded.html index 3975932265..928370161d 100644 --- a/papi-dts/functions/_shared_models_project_lookup_service_model_.areProjectInterfacesIncluded.html +++ b/papi-dts/functions/_shared_models_project_lookup_service_model_.areProjectInterfacesIncluded.html @@ -15,4 +15,4 @@ expressions defining which interfaces should be excluded.

    Returns boolean

    A boolean value indicating whether the project interfaces satisfy the inclusion and exclusion criteria.

    -

    Settings

    Member Visibility
    +

    Settings

    Member Visibility
    diff --git a/papi-dts/functions/_shared_models_project_lookup_service_model_.compareProjectDataProviderFactoryMetadataInfoMinimalMatch.html b/papi-dts/functions/_shared_models_project_lookup_service_model_.compareProjectDataProviderFactoryMetadataInfoMinimalMatch.html index c2e6a68b55..d47221b16c 100644 --- a/papi-dts/functions/_shared_models_project_lookup_service_model_.compareProjectDataProviderFactoryMetadataInfoMinimalMatch.html +++ b/papi-dts/functions/_shared_models_project_lookup_service_model_.compareProjectDataProviderFactoryMetadataInfoMinimalMatch.html @@ -5,4 +5,4 @@

    Parameters

    Returns -1 | 0 | 1

    -1 if a is less than b, 0 if equal, and 1 otherwise

    -

    Settings

    Member Visibility
    +

    Settings

    Member Visibility
    diff --git a/papi-dts/functions/_shared_models_project_lookup_service_model_.getPDPFactoryIdFromNetworkObjectName.html b/papi-dts/functions/_shared_models_project_lookup_service_model_.getPDPFactoryIdFromNetworkObjectName.html index 4121bfcaac..add667367b 100644 --- a/papi-dts/functions/_shared_models_project_lookup_service_model_.getPDPFactoryIdFromNetworkObjectName.html +++ b/papi-dts/functions/_shared_models_project_lookup_service_model_.getPDPFactoryIdFromNetworkObjectName.html @@ -1,4 +1,4 @@ getPDPFactoryIdFromNetworkObjectName | papi-dts

    FunctiongetPDPFactoryIdFromNetworkObjectName

    • getPDPFactoryIdFromNetworkObjectName(pdpFactoryNetworkObjectName): string

    • Transform a network object id for a pdp factory into its well-known pdp factory id

      Parameters

      • pdpFactoryNetworkObjectName: string

        Id for then network object for this pdp factory

      Returns string

      Id extensions use to identify this pdp factory

      -

    Settings

    Member Visibility
    +

    Settings

    Member Visibility
    diff --git a/papi-dts/functions/_shared_models_project_lookup_service_model_.getPDPFactoryNetworkObjectNameFromId.html b/papi-dts/functions/_shared_models_project_lookup_service_model_.getPDPFactoryNetworkObjectNameFromId.html index 31bd69a0a5..a7b25618cf 100644 --- a/papi-dts/functions/_shared_models_project_lookup_service_model_.getPDPFactoryNetworkObjectNameFromId.html +++ b/papi-dts/functions/_shared_models_project_lookup_service_model_.getPDPFactoryNetworkObjectNameFromId.html @@ -1,4 +1,4 @@ getPDPFactoryNetworkObjectNameFromId | papi-dts

    FunctiongetPDPFactoryNetworkObjectNameFromId

    • getPDPFactoryNetworkObjectNameFromId(pdpFactoryId): string

    • Transform the well-known pdp factory id into an id for its network object to use

      Parameters

      • pdpFactoryId: string

        Id extensions use to identify this pdp factory

      Returns string

      Id for then network object for this pdp factory

      -

    Settings

    Member Visibility
    +

    Settings

    Member Visibility
    diff --git a/papi-dts/functions/_shared_models_project_lookup_service_model_.internalGetMetadata.html b/papi-dts/functions/_shared_models_project_lookup_service_model_.internalGetMetadata.html index c55471439c..ff3ff02d2e 100644 --- a/papi-dts/functions/_shared_models_project_lookup_service_model_.internalGetMetadata.html +++ b/papi-dts/functions/_shared_models_project_lookup_service_model_.internalGetMetadata.html @@ -3,4 +3,4 @@ provided by the PDP Factory with the matching id (or all PDP Factories if no id is specified) for the project will be returned. If you need projectInterfaces supported by specific PDP Factories, you can access it at ProjectMetadata.pdpFactoryInfo.

    -

    Parameters

    Returns Promise<ProjectMetadata[]>

    Settings

    Member Visibility
    +

    Parameters

    Returns Promise<ProjectMetadata[]>

    Settings

    Member Visibility
    diff --git a/papi-dts/functions/_shared_models_project_lookup_service_model_.transformGetMetadataForProjectParametersToFilter.html b/papi-dts/functions/_shared_models_project_lookup_service_model_.transformGetMetadataForProjectParametersToFilter.html index 1cf1d8c278..c9faa3fc8d 100644 --- a/papi-dts/functions/_shared_models_project_lookup_service_model_.transformGetMetadataForProjectParametersToFilter.html +++ b/papi-dts/functions/_shared_models_project_lookup_service_model_.transformGetMetadataForProjectParametersToFilter.html @@ -1 +1 @@ -transformGetMetadataForProjectParametersToFilter | papi-dts

    FunctiontransformGetMetadataForProjectParametersToFilter

    • transformGetMetadataForProjectParametersToFilter(projectId?, projectInterface?, pdpFactoryId?): {
          includePdpFactoryIds: string | undefined;
          includeProjectIds: string | undefined;
          includeProjectInterfaces: string | undefined;
      }

    • Parameters

      • OptionalprojectId: string
      • OptionalprojectInterface: keyof ProjectDataProviderInterfaces
      • OptionalpdpFactoryId: string

      Returns {
          includePdpFactoryIds: string | undefined;
          includeProjectIds: string | undefined;
          includeProjectInterfaces: string | undefined;
      }

      • includePdpFactoryIds: string | undefined
      • includeProjectIds: string | undefined
      • includeProjectInterfaces: string | undefined

    Settings

    Member Visibility
    +transformGetMetadataForProjectParametersToFilter | papi-dts

    FunctiontransformGetMetadataForProjectParametersToFilter

    • transformGetMetadataForProjectParametersToFilter(projectId?, projectInterface?, pdpFactoryId?): {
          includePdpFactoryIds: string | undefined;
          includeProjectIds: string | undefined;
          includeProjectInterfaces: string | undefined;
      }

    • Parameters

      • OptionalprojectId: string
      • OptionalprojectInterface: keyof ProjectDataProviderInterfaces
      • OptionalpdpFactoryId: string

      Returns {
          includePdpFactoryIds: string | undefined;
          includeProjectIds: string | undefined;
          includeProjectInterfaces: string | undefined;
      }

      • includePdpFactoryIds: string | undefined
      • includeProjectIds: string | undefined
      • includeProjectInterfaces: string | undefined

    Settings

    Member Visibility
    diff --git a/papi-dts/functions/_shared_services_command_service_.createSendCommandFunction.html b/papi-dts/functions/_shared_services_command_service_.createSendCommandFunction.html index ca81a812fe..413d0df24b 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 @@

    Settings

    Member Visibility
    +

    Settings

    Member Visibility
    diff --git a/papi-dts/functions/_shared_services_command_service_.registerCommand.html b/papi-dts/functions/_shared_services_command_service_.registerCommand.html index 7ff0f85d7e..6d4915ea49 100644 --- a/papi-dts/functions/_shared_services_command_service_.registerCommand.html +++ b/papi-dts/functions/_shared_services_command_service_.registerCommand.html @@ -7,4 +7,4 @@
  • handler: CommandHandlers[CommandName]

    Function to run when the command is invoked

    • Returns Promise<UnsubscriberAsync>

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

    -

    Settings

    Member Visibility
    +

    Settings

    Member Visibility
    diff --git a/papi-dts/functions/_shared_services_command_service_.sendCommand.html b/papi-dts/functions/_shared_services_command_service_.sendCommand.html index 48146f3350..ae18ed843d 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

    FunctionsendCommand

    Send a command to the backend.

    -

    Settings

    Member Visibility
    +

    Settings

    Member Visibility
    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 8d0e08fa17..5a97efbe2a 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

    FunctiongetByType

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

    Settings

    Member Visibility
    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 69e4b64bca..bf93383add 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
    +

    Settings

    Member Visibility
    diff --git a/papi-dts/functions/_shared_services_logger_service_.formatLog.html b/papi-dts/functions/_shared_services_logger_service_.formatLog.html index 57a2c8ea0c..045979ac76 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

  • Optionaltag: string

    Optional tag at the end of the service name

    • Returns string

    Formatted string of a service message

    -

    Settings

    Member Visibility
    +

    Settings

    Member Visibility
    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 30733af0b2..bdb2611624 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

    FunctiononDidCreateNetworkObject

    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.

    -

    Settings

    Member Visibility
    +

    Settings

    Member Visibility
    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 35388f28dd..5fb3855b7b 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

    FunctiononDidDisposeNetworkObject

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

    -
    • onDidDisposeNetworkObject(callback): Unsubscriber

    • Parameters

      • callback: PlatformEventHandler<string>

      Returns Unsubscriber

    Settings

    Member Visibility
    +

    Settings

    Member Visibility
    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 c7c601d82f..5a5dec2c73 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

    FunctionoverrideDispose

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

    Parameters

    Returns void

    Settings

    Member Visibility
    diff --git a/papi-dts/functions/_shared_services_network_service_.createNetworkEventEmitter.html b/papi-dts/functions/_shared_services_network_service_.createNetworkEventEmitter.html index 65c8c668c1..628ec0c2fb 100644 --- a/papi-dts/functions/_shared_services_network_service_.createNetworkEventEmitter.html +++ b/papi-dts/functions/_shared_services_network_service_.createNetworkEventEmitter.html @@ -4,4 +4,4 @@ emitters.

    Settings

    Member Visibility
    +

    Settings

    Member Visibility
    diff --git a/papi-dts/functions/_shared_services_network_service_.createRequestFunction.html b/papi-dts/functions/_shared_services_network_service_.createRequestFunction.html index d2aaf56a9c..91ace3cd3d 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 @@

    Settings

    Member Visibility
    +

    Settings

    Member Visibility
    diff --git a/papi-dts/functions/_shared_services_network_service_.getNetworkEvent.html b/papi-dts/functions/_shared_services_network_service_.getNetworkEvent.html index d5cd40fd19..33ce5ad3a9 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

    FunctiongetNetworkEvent

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

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

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

    Settings

    Member Visibility
    diff --git a/papi-dts/functions/_shared_services_network_service_.initialize.html b/papi-dts/functions/_shared_services_network_service_.initialize.html index d85c7af131..932b6af686 100644 --- a/papi-dts/functions/_shared_services_network_service_.initialize.html +++ b/papi-dts/functions/_shared_services_network_service_.initialize.html @@ -1 +1 @@ -initialize | papi-dts

    Functioninitialize

    Settings

    Member Visibility
    +initialize | papi-dts

    Functioninitialize

    Settings

    Member Visibility
    diff --git a/papi-dts/functions/_shared_services_network_service_.registerRequestHandler.html b/papi-dts/functions/_shared_services_network_service_.registerRequestHandler.html index 884fcfccee..d0dbc37faa 100644 --- a/papi-dts/functions/_shared_services_network_service_.registerRequestHandler.html +++ b/papi-dts/functions/_shared_services_network_service_.registerRequestHandler.html @@ -2,4 +2,4 @@

    Parameters

    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

    -

    Settings

    Member Visibility
    +

    Settings

    Member Visibility
    diff --git a/papi-dts/functions/_shared_services_network_service_.request.html b/papi-dts/functions/_shared_services_network_service_.request.html index 0c3a11a6f5..55e631bb89 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 @@

    Settings

    Member Visibility
    +

    Settings

    Member Visibility
    diff --git a/papi-dts/functions/_shared_services_network_service_.shutdown.html b/papi-dts/functions/_shared_services_network_service_.shutdown.html index 80f236fdbe..ea56ad6ece 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

    Functionshutdown

    Closes the network services gracefully

    -

    Settings

    Member Visibility
    +

    Settings

    Member Visibility
    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 04be380335..c2a5fbed26 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 @@ -13,4 +13,4 @@

    Throws

    If did not find a project data provider for the project id that supports the requested projectInterface (and from the requested PDP factory if specified)

    -

    Settings

    Member Visibility
    +

    Settings

    Member Visibility
    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 0996937b8e..d30140f083 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 @@ -5,4 +5,4 @@ should be available on the PDPEs created by this factory.

  • pdpEngineFactory: IProjectDataProviderEngineFactory<SupportedProjectInterfaces>

    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
    +

    Settings

    Member Visibility
    diff --git a/papi-dts/functions/_shared_services_project_settings_service_.filterProjectSettingsContributionsByProjectInterfaces.html b/papi-dts/functions/_shared_services_project_settings_service_.filterProjectSettingsContributionsByProjectInterfaces.html index 4ae238f693..c09131eacb 100644 --- a/papi-dts/functions/_shared_services_project_settings_service_.filterProjectSettingsContributionsByProjectInterfaces.html +++ b/papi-dts/functions/_shared_services_project_settings_service_.filterProjectSettingsContributionsByProjectInterfaces.html @@ -7,4 +7,4 @@ contributions by.

    Returns Localized<ProjectSettingsContributionInfo["contributions"]> | undefined

    A filtered set of contributions, or undefined if no contributions match the project interfaces.

    -

    Settings

    Member Visibility
    +

    Settings

    Member Visibility
    diff --git a/papi-dts/functions/_shared_services_rpc_handler_factory_.createRpcHandler.html b/papi-dts/functions/_shared_services_rpc_handler_factory_.createRpcHandler.html index 3756842738..10f456545b 100644 --- a/papi-dts/functions/_shared_services_rpc_handler_factory_.createRpcHandler.html +++ b/papi-dts/functions/_shared_services_rpc_handler_factory_.createRpcHandler.html @@ -1,2 +1,2 @@ createRpcHandler | papi-dts

    FunctioncreateRpcHandler

    Creates a server or client RPC handler depending on if we're in main or some other process

    -

    Settings

    Member Visibility
    +

    Settings

    Member Visibility
    diff --git a/papi-dts/functions/_shared_services_web_view_service_model_.getWebViewController.html b/papi-dts/functions/_shared_services_web_view_service_model_.getWebViewController.html index 479584c427..2495c32d86 100644 --- a/papi-dts/functions/_shared_services_web_view_service_model_.getWebViewController.html +++ b/papi-dts/functions/_shared_services_web_view_service_model_.getWebViewController.html @@ -1 +1 @@ -getWebViewController | papi-dts

    FunctiongetWebViewController

    Settings

    Member Visibility
    +getWebViewController | papi-dts

    FunctiongetWebViewController

    Settings

    Member Visibility
    diff --git a/papi-dts/functions/_shared_services_web_view_service_model_.getWebViewControllerObjectId.html b/papi-dts/functions/_shared_services_web_view_service_model_.getWebViewControllerObjectId.html index ccdcdf07ae..c5c058a55a 100644 --- a/papi-dts/functions/_shared_services_web_view_service_model_.getWebViewControllerObjectId.html +++ b/papi-dts/functions/_shared_services_web_view_service_model_.getWebViewControllerObjectId.html @@ -1,2 +1,2 @@ getWebViewControllerObjectId | papi-dts

    FunctiongetWebViewControllerObjectId

    Gets the id for the web view controller network object with the given name

    -

    Settings

    Member Visibility
    +

    Settings

    Member Visibility
    diff --git a/papi-dts/functions/_shared_services_web_view_service_model_.getWebViewMessageRequestType.html b/papi-dts/functions/_shared_services_web_view_service_model_.getWebViewMessageRequestType.html index 002b289eb5..11369dcb7e 100644 --- a/papi-dts/functions/_shared_services_web_view_service_model_.getWebViewMessageRequestType.html +++ b/papi-dts/functions/_shared_services_web_view_service_model_.getWebViewMessageRequestType.html @@ -1,2 +1,2 @@ getWebViewMessageRequestType | papi-dts

    FunctiongetWebViewMessageRequestType

    • getWebViewMessageRequestType(webViewId): `${string}:${string}`

    • Get request type for posting a message to a web view

      -

      Parameters

      • webViewId: string

      Returns `${string}:${string}`

    Settings

    Member Visibility
    +

    Parameters

    Returns `${string}:${string}`

    Settings

    Member Visibility
    diff --git a/papi-dts/functions/_shared_utils_internal_util_.getProcessType.html b/papi-dts/functions/_shared_utils_internal_util_.getProcessType.html index 4fe70dbc98..de9ecb2d7c 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

    FunctiongetProcessType

    Gets which kind of process this is (main, renderer, extension-host)

    Settings

    Member Visibility
    +

    Settings

    Member Visibility
    diff --git a/papi-dts/functions/_shared_utils_internal_util_.isClient.html b/papi-dts/functions/_shared_utils_internal_util_.isClient.html index 9b214431e3..198e525aef 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

    FunctionisClient

    Determine if running on a client process (renderer, extension-host) or on the server.

    Settings

    Member Visibility
    +

    Settings

    Member Visibility
    diff --git a/papi-dts/functions/_shared_utils_internal_util_.isExtensionHost.html b/papi-dts/functions/_shared_utils_internal_util_.isExtensionHost.html index 519a077181..ba16870fc5 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

    FunctionisExtensionHost

    Determine if running on the extension host

    • isExtensionHost(): boolean

    • Returns boolean

      Returns true if running on the extension host, false otherwise

      -

    Settings

    Member Visibility
    +

    Settings

    Member Visibility
    diff --git a/papi-dts/functions/_shared_utils_internal_util_.isRenderer.html b/papi-dts/functions/_shared_utils_internal_util_.isRenderer.html index f7ed4dcbfc..765a2207d3 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

    FunctionisRenderer

    Determine if running on the renderer process

    • isRenderer(): boolean

    • Returns boolean

      Returns true if running on the renderer, false otherwise

      -

    Settings

    Member Visibility
    +

    Settings

    Member Visibility
    diff --git a/papi-dts/functions/_shared_utils_internal_util_.isServer.html b/papi-dts/functions/_shared_utils_internal_util_.isServer.html index fafba40d0e..06de5e3427 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

    FunctionisServer

    Determine if running on the server process (main)

    Settings

    Member Visibility
    +

    Settings

    Member Visibility
    diff --git a/papi-dts/functions/_shared_utils_util_.bindClassMethods.html b/papi-dts/functions/_shared_utils_util_.bindClassMethods.html index 97e7feafd0..b127f70ac1 100644 --- a/papi-dts/functions/_shared_utils_util_.bindClassMethods.html +++ b/papi-dts/functions/_shared_utils_util_.bindClassMethods.html @@ -2,4 +2,4 @@ "this" in its functions refer to the object rather than the caller of the function. For example, if a function on the class is provided to a callback, if "this" isn't bound to the object then "this" will refer to the entity running the callback.

    -

    Type Parameters

    Parameters

    Returns void

    Settings

    Member Visibility
    +

    Type Parameters

    Parameters

    Returns void

    Settings

    Member Visibility
    diff --git a/papi-dts/functions/_shared_utils_util_.deserializeRequestType.html b/papi-dts/functions/_shared_utils_util_.deserializeRequestType.html index 1db95d0354..7371f7328f 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

    FunctiondeserializeRequestType

    Settings

    Member Visibility
    +

    Parameters

    Returns RequestType

    Settings

    Member Visibility
    diff --git a/papi-dts/functions/_shared_utils_util_.getModuleSimilarApiMessage.html b/papi-dts/functions/_shared_utils_util_.getModuleSimilarApiMessage.html index a06dd98818..2ab06bd3ac 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

    FunctiongetModuleSimilarApiMessage

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

    Settings

    Member Visibility
    diff --git a/papi-dts/functions/_shared_utils_util_.newNonce.html b/papi-dts/functions/_shared_utils_util_.newNonce.html index 8ec07df2e6..1278896a26 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
    +

    Returns string

    Settings

    Member Visibility
    diff --git a/papi-dts/functions/_shared_utils_util_.serializeRequestType.html b/papi-dts/functions/_shared_utils_util_.serializeRequestType.html index 3257231b1d..1a27da9b96 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
    +

    Settings

    Member Visibility
    diff --git a/papi-dts/functions/getSavedWebViewDefinition.html b/papi-dts/functions/getSavedWebViewDefinition.html index 5e4d0470c2..da8e1331e2 100644 --- a/papi-dts/functions/getSavedWebViewDefinition.html +++ b/papi-dts/functions/getSavedWebViewDefinition.html @@ -1,4 +1,4 @@ getSavedWebViewDefinition | papi-dts

    FunctiongetSavedWebViewDefinition

    Gets the saved properties on this WebView's WebView definition

    ＠returns saved properties this WebView's WebView definition or undefined if not found for some reason

    -

    Settings

    Member Visibility
    +

    Settings

    Member Visibility
    diff --git a/papi-dts/functions/getSavedWebViewDefinitionById.html b/papi-dts/functions/getSavedWebViewDefinitionById.html index 6e69dbc971..e13d485277 100644 --- a/papi-dts/functions/getSavedWebViewDefinitionById.html +++ b/papi-dts/functions/getSavedWebViewDefinitionById.html @@ -1 +1 @@ -getSavedWebViewDefinitionById | papi-dts

    FunctiongetSavedWebViewDefinitionById

    Settings

    Member Visibility
    +getSavedWebViewDefinitionById | papi-dts

    FunctiongetSavedWebViewDefinitionById

    Settings

    Member Visibility
    diff --git a/papi-dts/functions/getWebViewState.html b/papi-dts/functions/getWebViewState.html index e67b950f30..2cc96686f6 100644 --- a/papi-dts/functions/getWebViewState.html +++ b/papi-dts/functions/getWebViewState.html @@ -1,3 +1,3 @@ getWebViewState | papi-dts

    FunctiongetWebViewState

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

    -

    Settings

    Member Visibility
    +

    Settings

    Member Visibility
    diff --git a/papi-dts/functions/resetWebViewState.html b/papi-dts/functions/resetWebViewState.html index 91539291f4..4c4da3ac4d 100644 --- a/papi-dts/functions/resetWebViewState.html +++ b/papi-dts/functions/resetWebViewState.html @@ -1,2 +1,2 @@ resetWebViewState | papi-dts

    FunctionresetWebViewState

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

    -

    Settings

    Member Visibility
    +

    Settings

    Member Visibility
    diff --git a/papi-dts/functions/setWebViewState.html b/papi-dts/functions/setWebViewState.html index 479fe64e65..5ccfcdf5aa 100644 --- a/papi-dts/functions/setWebViewState.html +++ b/papi-dts/functions/setWebViewState.html @@ -1,2 +1,2 @@ setWebViewState | papi-dts

    FunctionsetWebViewState

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

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

    • Type Parameters

      • T

      Parameters

      • stateKey: string
      • stateValue: T

      Returns void

    Settings

    Member Visibility
    +

    Settings

    Member Visibility
    diff --git a/papi-dts/functions/updateWebViewDefinition.html b/papi-dts/functions/updateWebViewDefinition.html index c966ff903e..a3230874c3 100644 --- a/papi-dts/functions/updateWebViewDefinition.html +++ b/papi-dts/functions/updateWebViewDefinition.html @@ -7,4 +7,4 @@ 
    updateWebViewDefinition({ title: `Hello ${name}` });
    -

    Settings

    Member Visibility
    +

    Settings

    Member Visibility
    diff --git a/papi-dts/functions/updateWebViewDefinitionById.html b/papi-dts/functions/updateWebViewDefinitionById.html index eb6a573a4c..6ad32ccca2 100644 --- a/papi-dts/functions/updateWebViewDefinitionById.html +++ b/papi-dts/functions/updateWebViewDefinitionById.html @@ -1 +1 @@ -updateWebViewDefinitionById | papi-dts

    FunctionupdateWebViewDefinitionById

    Settings

    Member Visibility
    +updateWebViewDefinitionById | papi-dts

    FunctionupdateWebViewDefinitionById

    Settings

    Member Visibility
    diff --git a/papi-dts/functions/useWebViewScrollGroupScrRef.html b/papi-dts/functions/useWebViewScrollGroupScrRef.html index fa67709404..fad04f5fe8 100644 --- a/papi-dts/functions/useWebViewScrollGroupScrRef.html +++ b/papi-dts/functions/useWebViewScrollGroupScrRef.html @@ -16,4 +16,4 @@ 
    const [scrRef, setScrRef, scrollGroupId, setScrollGroupId] = useWebViewScrollGroupScrRef();
    -

    Settings

    Member Visibility
    +

    Settings

    Member Visibility
    diff --git a/papi-dts/functions/useWebViewState.html b/papi-dts/functions/useWebViewState.html index fed8666f15..814209ec9c 100644 --- a/papi-dts/functions/useWebViewState.html +++ b/papi-dts/functions/useWebViewState.html @@ -25,4 +25,4 @@ 
    const [lastPersonSeen, setLastPersonSeen] = useWebViewState('lastSeen', 'No one');
    -

    Settings

    Member Visibility
    +

    Settings

    Member Visibility
    diff --git a/papi-dts/functions/webViewComponent.html b/papi-dts/functions/webViewComponent.html index 23ff72eb3d..32dacfb5d0 100644 --- a/papi-dts/functions/webViewComponent.html +++ b/papi-dts/functions/webViewComponent.html @@ -1,7 +1,7 @@ webViewComponent | papi-dts

    FunctionwebViewComponent

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

    Properties

    contextTypes? +

    Returns ReactNode

    Properties

    contextTypes? defaultProps? displayName? propTypes? diff --git a/papi-dts/interfaces/_extension_host_extension_types_extension_interface_.IExtension.html b/papi-dts/interfaces/_extension_host_extension_types_extension_interface_.IExtension.html index 7dba90a6b3..4b19f23386 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

    InterfaceIExtension

    Interface for all extensions to implement

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

    Properties

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

    Properties

    activate deactivate?

    Properties

    activate

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

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

    Type declaration

      • (context): Promise<void>

      • Parameters

        Returns Promise<void>

    Optionaldeactivate

    deactivate?: UnsubscriberAsync

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

    Returns Promise<void>

    Optionaldeactivate

    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

    On This Page

    Properties
    +

    Settings

    Member Visibility

    On This Page

    Properties
    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 4b17c2435b..8f8146022b 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

    InterfaceExtensionStorageService

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

    Properties

    deleteUserData +ExtensionStorageService | papi-dts

    InterfaceExtensionStorageService

    interface ExtensionStorageService {
        deleteUserData: ((token: ExecutionToken, key: string) => Promise<void>);
        readBinaryFileFromInstallDirectory: ((token: ExecutionToken, fileName: string) => Promise<Buffer>);
        readTextFileFromInstallDirectory: ((token: ExecutionToken, fileName: string) => Promise<string>);
        readUserData: ((token: ExecutionToken, key: string) => Promise<string>);
        writeUserData: ((token: ExecutionToken, key: string, data: string) => 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: ExecutionToken, fileName: string) => Promise<Buffer>)

    Type declaration

      • (token, fileName): Promise<Buffer>

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

        +

    readBinaryFileFromInstallDirectory

    readBinaryFileFromInstallDirectory: ((token: ExecutionToken, fileName: string) => 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: ExecutionToken, fileName: string) => Promise<string>)

    Type declaration

      • (token, fileName): Promise<string>

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

        +

    readTextFileFromInstallDirectory

    readTextFileFromInstallDirectory: ((token: ExecutionToken, fileName: string) => 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: ExecutionToken, key: string) => 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: ExecutionToken, key: string) => 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: ExecutionToken, key: string, data: string) => 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: ExecutionToken, key: string, data: string) => 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

    On This Page

    Properties
    +

    Settings

    Member Visibility

    On This Page

    Properties
    diff --git a/papi-dts/interfaces/_papi_shared_types_.CommandHandlers.html b/papi-dts/interfaces/_papi_shared_types_.CommandHandlers.html index 12394dcbe8..357bd8d290 100644 --- a/papi-dts/interfaces/_papi_shared_types_.CommandHandlers.html +++ b/papi-dts/interfaces/_papi_shared_types_.CommandHandlers.html @@ -7,7 +7,7 @@

    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.openProjectSettings: ((webViewId: string) => Promise<void>);
        platform.openUserSettings: (() => Promise<void>);
        platform.quit: (() => Promise<void>);
        platform.restart: (() => Promise<void>);
        platform.restartExtensionHost: (() => Promise<void>);
        test.addMany: ((...nums: number[]) => number);
        test.echo: ((message: string) => string);
        test.echoExtensionHost: ((message: string) => Promise<string>);
        test.throwError: ((message: string) => void);
        test.throwErrorExtensionHost: ((message: string) => void);
    }

    Properties

    platform.openProjectSettings +
    interface CommandHandlers {
        platform.openProjectSettings: ((webViewId: string) => Promise<void>);
        platform.openUserSettings: (() => Promise<void>);
        platform.quit: (() => Promise<void>);
        platform.restart: (() => Promise<void>);
        platform.restartExtensionHost: (() => Promise<void>);
        test.addMany: ((...nums: number[]) => number);
        test.echo: ((message: string) => string);
        test.echoExtensionHost: ((message: string) => Promise<string>);
        test.throwError: ((message: string) => void);
        test.throwErrorExtensionHost: ((message: string) => void);
    }

    Properties

    platform.openProjectSettings platform.openUserSettings platform.quit platform.restart @@ -17,6 +17,6 @@ test.echoExtensionHost test.throwError test.throwErrorExtensionHost -

    Properties

    platform.openProjectSettings

    platform.openProjectSettings: ((webViewId: string) => Promise<void>)

    platform.openUserSettings

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

    platform.quit

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

    Shut down the application

    -

    platform.restart

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

    Restart the application

    -

    platform.restartExtensionHost

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

    test.addMany

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

    test.echo

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

    test.echoExtensionHost

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

    test.throwError

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

    test.throwErrorExtensionHost

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

    Settings

    Member Visibility

    On This Page

    Properties
    +

    Properties

    platform.openProjectSettings

    platform.openProjectSettings: ((webViewId: string) => Promise<void>)

    platform.openUserSettings

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

    platform.quit

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

    Shut down the application

    +

    platform.restart

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

    Restart the application

    +

    platform.restartExtensionHost

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

    test.addMany

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

    test.echo

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

    test.echoExtensionHost

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

    test.throwError

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

    test.throwErrorExtensionHost

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

    Settings

    Member Visibility

    On This Page

    Properties
    diff --git a/papi-dts/interfaces/_papi_shared_types_.DataProviders.html b/papi-dts/interfaces/_papi_shared_types_.DataProviders.html index 3f5d4b4b18..df3134fa4f 100644 --- a/papi-dts/interfaces/_papi_shared_types_.DataProviders.html +++ b/papi-dts/interfaces/_papi_shared_types_.DataProviders.html @@ -11,6 +11,6 @@

    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

    On This Page

    Properties
    +

    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

    On This Page

    Properties
    diff --git a/papi-dts/interfaces/_papi_shared_types_.ProjectDataProviderInterfaces.html b/papi-dts/interfaces/_papi_shared_types_.ProjectDataProviderInterfaces.html index 6c56487da9..322deff78a 100644 --- a/papi-dts/interfaces/_papi_shared_types_.ProjectDataProviderInterfaces.html +++ b/papi-dts/interfaces/_papi_shared_types_.ProjectDataProviderInterfaces.html @@ -34,10 +34,10 @@

    Example

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

      export type MyLayeringProjectDataTypes = {
        MyOtherProjectData: DataProviderDataType<number, number, number>;
      };

      export interface ProjectDataProviderInterfaces {
        // Note that the base PDP implements `I**Base**ProjectDataProvider`
        MyExtensionBaseProjectInterface: IBaseProjectDataProvider<MyProjectDataTypes>;
        // Note that the layering PDP only implements `IProjectDataProvider` because the base PDP already
        // provides the `platform.base` data types
        MyExtensionLayeringProjectInterface: IProjectDataProvider<MyLayeringProjectDataTypes>;
      }
    }
    -
    interface ProjectDataProviderInterfaces {
        platform.base: IBaseProjectDataProvider<MandatoryProjectDataTypes>;
        platform.notesOnly: IProjectDataProvider<NotesOnlyProjectDataTypes>;
        platform.placeholder: IProjectDataProvider<PlaceholderDataTypes>;
    }

    Properties

    platform.base +
    interface ProjectDataProviderInterfaces {
        platform.base: IBaseProjectDataProvider<MandatoryProjectDataTypes>;
        platform.notesOnly: IProjectDataProvider<NotesOnlyProjectDataTypes>;
        platform.placeholder: IProjectDataProvider<PlaceholderDataTypes>;
    }

    Properties

    platform.base platform.notesOnly platform.placeholder

    Properties

    platform.base

    platform.base: IBaseProjectDataProvider<MandatoryProjectDataTypes>

    Base projectInterface that all PDPs that expose their own unique project ids must implement.

    There should be a PDP that provides platform.base for all available project ids.

    -

    platform.notesOnly

    platform.notesOnly: IProjectDataProvider<NotesOnlyProjectDataTypes>

    platform.placeholder

    platform.placeholder: IProjectDataProvider<PlaceholderDataTypes>

    Settings

    Member Visibility

    On This Page

    Properties
    +

    platform.notesOnly

    platform.notesOnly: IProjectDataProvider<NotesOnlyProjectDataTypes>

    platform.placeholder

    platform.placeholder: IProjectDataProvider<PlaceholderDataTypes>

    Settings

    Member Visibility

    On This Page

    Properties
    diff --git a/papi-dts/interfaces/_papi_shared_types_.ProjectSettingTypes.html b/papi-dts/interfaces/_papi_shared_types_.ProjectSettingTypes.html index ec7c624a56..a267eff0ea 100644 --- a/papi-dts/interfaces/_papi_shared_types_.ProjectSettingTypes.html +++ b/papi-dts/interfaces/_papi_shared_types_.ProjectSettingTypes.html @@ -10,7 +10,7 @@

    Example

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

    Properties

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

    Properties

    platform.fullName platform.isEditable platform.language platform.name @@ -18,17 +18,17 @@

    Example

    'World English Bible'
    -

    platform.isEditable

    platform.isEditable: boolean

    Whether or not the project is editable. This is a general "editable", not necessarily that it +

    platform.isEditable

    platform.isEditable: boolean

    Whether or not the project is editable. This is a general "editable", not necessarily that it is editable by the current user.

    Projects that are not editable are sometimes called "resources".

    -

    platform.language

    platform.language: string

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

    platform.language

    platform.language: string

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

    Example

    'English'
    -

    platform.name

    platform.name: string

    Short name of the project (not necessarily unique). This will be displayed directly in the +

    platform.name

    platform.name: string

    Short name of the project (not necessarily unique). This will be displayed directly in the UI.

    Example

    'WEB'
    -

    Settings

    Member Visibility

    On This Page

    Properties
    +

    Settings

    Member Visibility

    On This Page

    Properties
    diff --git a/papi-dts/interfaces/_papi_shared_types_.SettingTypes.html b/papi-dts/interfaces/_papi_shared_types_.SettingTypes.html index 7b6d326f3c..7d8320d1d2 100644 --- a/papi-dts/interfaces/_papi_shared_types_.SettingTypes.html +++ b/papi-dts/interfaces/_papi_shared_types_.SettingTypes.html @@ -9,19 +9,19 @@

    Example

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

    Properties

    platform.commentsEnabled +
    interface SettingTypes {
        platform.commentsEnabled: boolean;
        platform.interfaceLanguage: string[];
        platform.paratextDataLastRegistryDataCachedTimes: {
            [key: string]: string;
        };
        platform.ptxUtilsMementoData: {
            [key: string]: string;
        };
        platform.verseRef: ScriptureReference;
    }

    Properties

    platform.commentsEnabled platform.interfaceLanguage platform.paratextDataLastRegistryDataCachedTimes platform.ptxUtilsMementoData platform.verseRef

    Properties

    platform.commentsEnabled

    platform.commentsEnabled: boolean

    Enable reading and writing comments in projects. This is an experimental feature.

    -

    platform.interfaceLanguage

    platform.interfaceLanguage: string[]

    List of locales to use when localizing the interface. First in the list receives highest +

    platform.interfaceLanguage

    platform.interfaceLanguage: string[]

    List of locales to use when localizing the interface. First in the list receives highest priority. Please always add 'en' (English) at the end when using this setting so everything localizes to English if it does not have a localization in a higher-priority locale.

    -

    platform.paratextDataLastRegistryDataCachedTimes

    platform.paratextDataLastRegistryDataCachedTimes: {
        [key: string]: string;
    }

    Tracking last S/R registry data cache time managed in the dotnet process and used for +

    platform.paratextDataLastRegistryDataCachedTimes

    platform.paratextDataLastRegistryDataCachedTimes: {
        [key: string]: string;
    }

    Tracking last S/R registry data cache time managed in the dotnet process and used for interacting with ParatextData.

    -

    platform.ptxUtilsMementoData

    platform.ptxUtilsMementoData: {
        [key: string]: string;
    }

    Mementos managed in the dotnet process and used for interacting with PtxUtils. Mementos are +

    platform.ptxUtilsMementoData

    platform.ptxUtilsMementoData: {
        [key: string]: string;
    }

    Mementos managed in the dotnet process and used for interacting with PtxUtils. Mementos are persisted objects containing some data. They are stored as xml strings.

    -

    platform.verseRef

    platform.verseRef: ScriptureReference

    Current Verse Reference for Scroll Group A. Deprecated - please use papi.scrollGroups and +

    platform.verseRef

    platform.verseRef: ScriptureReference

    Current Verse Reference for Scroll Group A. Deprecated - please use papi.scrollGroups and useWebViewScrollGroupScrRef

    -

    Settings

    Member Visibility

    On This Page

    Properties
    +

    Settings

    Member Visibility

    On This Page

    Properties
    diff --git a/papi-dts/interfaces/_papi_shared_types_.WebViewControllers.html b/papi-dts/interfaces/_papi_shared_types_.WebViewControllers.html index c820224310..ee50f6b4ba 100644 --- a/papi-dts/interfaces/_papi_shared_types_.WebViewControllers.html +++ b/papi-dts/interfaces/_papi_shared_types_.WebViewControllers.html @@ -18,6 +18,6 @@

    Example

    declare module 'papi-shared-types' {
      export type PeopleWebViewController = NetworkableObject<{
        setSelectedPerson(name: string): Promise<boolean>;
        testRandomMethod(things: string): Promise<string>;
      }>;

      export interface WebViewControllers {
        'helloSomeone.peopleWebView': PeopleWebViewController;
      }
    }
    -
    interface WebViewControllers {
        platform.placeholderWebView: NetworkableObject<{
            runPlaceholderStuff(thing: string): Promise<boolean>;
        }>;
        platform.stuffWebView: NetworkableObject<{
            doStuff(thing: string): Promise<boolean>;
        }>;
    }

    Properties

    platform.placeholderWebView +
    interface WebViewControllers {
        platform.placeholderWebView: NetworkableObject<{
            runPlaceholderStuff(thing: string): Promise<boolean>;
        }>;
        platform.stuffWebView: NetworkableObject<{
            doStuff(thing: string): Promise<boolean>;
        }>;
    }

    Properties

    platform.placeholderWebView platform.stuffWebView -

    Properties

    platform.placeholderWebView

    platform.placeholderWebView: NetworkableObject<{
        runPlaceholderStuff(thing: string): Promise<boolean>;
    }>

    platform.stuffWebView

    platform.stuffWebView: NetworkableObject<{
        doStuff(thing: string): Promise<boolean>;
    }>

    Settings

    Member Visibility

    On This Page

    Properties
    +

    Properties

    platform.placeholderWebView

    platform.placeholderWebView: NetworkableObject<{
        runPlaceholderStuff(thing: string): Promise<boolean>;
    }>

    platform.stuffWebView

    platform.stuffWebView: NetworkableObject<{
        doStuff(thing: string): Promise<boolean>;
    }>

    Settings

    Member Visibility

    On This Page

    Properties
    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 351e82935a..a37231f97e 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,7 +1,7 @@ DialogTypes | papi-dts

    InterfaceDialogTypes

    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.selectBooks: DialogDataTypes<SelectBooksDialogOptions, string[]>;
        platform.selectMultipleProjects: DialogDataTypes<SelectMultipleProjectsDialogOptions, string[]>;
        platform.selectProject: DialogDataTypes<ProjectDialogOptionsBase, string>;
    }

    Properties

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

    Properties

    platform.selectBooks platform.selectMultipleProjects platform.selectProject -

    Properties

    platform.selectBooks

    platform.selectBooks: DialogDataTypes<SelectBooksDialogOptions, string[]>

    platform.selectMultipleProjects

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

    platform.selectProject

    platform.selectProject: DialogDataTypes<ProjectDialogOptionsBase, string>

    Settings

    Member Visibility

    On This Page

    Properties
    +

    Properties

    platform.selectBooks

    platform.selectBooks: DialogDataTypes<SelectBooksDialogOptions, string[]>

    platform.selectMultipleProjects

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

    platform.selectProject

    platform.selectProject: DialogDataTypes<ProjectDialogOptionsBase, string>

    Settings

    Member Visibility

    On This Page

    Properties
    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 ef40f5190a..06185ddac0 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

    InterfaceFloatLayout

    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

    OptionalfloatSize

    floatSize?: FloatSize

    Optionalposition

    position?: FloatPosition

    Where to display the floating window. Defaults to cascade

    -

    type

    type

    Settings

    Member Visibility

    On This Page

    Properties
    +

    Properties

    OptionalfloatSize

    floatSize?: FloatSize

    Optionalposition

    position?: FloatPosition

    Where to display the floating window. Defaults to cascade

    +

    type

    type

    Settings

    Member Visibility

    On This Page

    Properties
    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 febf3f88f4..a4cfa3803b 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

    InterfacePanelLayout

    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

    Optionaldirection

    direction?: PanelDirection

    OptionaltargetTabId

    targetTabId?: string

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

    -

    type

    type

    Settings

    Member Visibility

    On This Page

    Properties
    +

    Properties

    Optionaldirection

    direction?: PanelDirection

    OptionaltargetTabId

    targetTabId?: string

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

    +

    type

    type

    Settings

    Member Visibility

    On This Page

    Properties
    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 f8e787ab36..35e5a920ce 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

    InterfaceTabLayout

    Information about a tab in a panel

    -
    interface TabLayout {
        type: "tab";
    }

    Properties

    type -

    Properties

    type

    type

    Settings

    Member Visibility

    On This Page

    Properties
    +
    interface TabLayout {
        type: "tab";
    }

    Properties

    type +

    Properties

    type

    type

    Settings

    Member Visibility

    On This Page

    Properties
    diff --git a/papi-dts/interfaces/_shared_models_network_object_status_service_model_.NetworkObjectStatusRemoteServiceType.html b/papi-dts/interfaces/_shared_models_network_object_status_service_model_.NetworkObjectStatusRemoteServiceType.html index d272780673..a367398577 100644 --- a/papi-dts/interfaces/_shared_models_network_object_status_service_model_.NetworkObjectStatusRemoteServiceType.html +++ b/papi-dts/interfaces/_shared_models_network_object_status_service_model_.NetworkObjectStatusRemoteServiceType.html @@ -1,5 +1,5 @@ -NetworkObjectStatusRemoteServiceType | papi-dts

    InterfaceNetworkObjectStatusRemoteServiceType

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

    Hierarchy (view full)

    Properties

    getAllNetworkObjectDetails +NetworkObjectStatusRemoteServiceType | papi-dts

    InterfaceNetworkObjectStatusRemoteServiceType

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

    Hierarchy (view full)

    Properties

    getAllNetworkObjectDetails

    Properties

    getAllNetworkObjectDetails

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

    Get details about all available network objects

    Type declaration

    Settings

    Member Visibility

    On This Page

    Properties
    +

    Settings

    Member Visibility

    On This Page

    Properties
    diff --git a/papi-dts/interfaces/_shared_models_network_object_status_service_model_.NetworkObjectStatusServiceType.html b/papi-dts/interfaces/_shared_models_network_object_status_service_model_.NetworkObjectStatusServiceType.html index 3868c9a90e..556f3be263 100644 --- a/papi-dts/interfaces/_shared_models_network_object_status_service_model_.NetworkObjectStatusServiceType.html +++ b/papi-dts/interfaces/_shared_models_network_object_status_service_model_.NetworkObjectStatusServiceType.html @@ -1,10 +1,10 @@ NetworkObjectStatusServiceType | papi-dts

    InterfaceNetworkObjectStatusServiceType

    Provides functions related to the set of available network objects

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

    Hierarchy (view full)

    Properties

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

    Hierarchy (view full)

    Properties

    getAllNetworkObjectDetails waitForNetworkObject

    Properties

    getAllNetworkObjectDetails

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

    Get details about all available network objects

    Type declaration

    waitForNetworkObject

    waitForNetworkObject: ((objectDetailsToMatch: Partial<NetworkObjectDetails>, timeoutInMS?: number) => Promise<NetworkObjectDetails>)

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

    +

    waitForNetworkObject

    waitForNetworkObject: ((objectDetailsToMatch: Partial<NetworkObjectDetails>, timeoutInMS?: number) => Promise<NetworkObjectDetails>)

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

    Type declaration

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

      • Parameters

        • objectDetailsToMatch: Partial<NetworkObjectDetails>

          Subset of object details on the network object to wait for. Compared to object details using isSubset

        • OptionaltimeoutInMS: number

          Max duration to wait for the network object. If not provided, it will wait @@ -12,4 +12,4 @@

        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

    On This Page

    Properties
    +

    Settings

    Member Visibility

    On This Page

    Properties
    diff --git a/papi-dts/interfaces/_shared_models_project_data_provider_engine_factory_model_.IProjectDataProviderEngineFactory.html b/papi-dts/interfaces/_shared_models_project_data_provider_engine_factory_model_.IProjectDataProviderEngineFactory.html index ceb603b313..caa3819933 100644 --- a/papi-dts/interfaces/_shared_models_project_data_provider_engine_factory_model_.IProjectDataProviderEngineFactory.html +++ b/papi-dts/interfaces/_shared_models_project_data_provider_engine_factory_model_.IProjectDataProviderEngineFactory.html @@ -20,7 +20,7 @@

    To make creating a Layering PDPF easier, you can extend LayeringProjectDataProviderEngineFactory, which automatically fulfills the special requirements for Layering PDPFs. We highly recommend using it.

    -
    interface IProjectDataProviderEngineFactory<SupportedProjectInterfaces> {
        createProjectDataProviderEngine(projectId: string): Promise<IProjectDataProviderEngine<SupportedProjectInterfaces>>;
        getAvailableProjects(layeringFilters?: ProjectMetadataFilterOptions): Promise<ProjectMetadataWithoutFactoryInfo[]>;
    }

    Type Parameters

    Methods

    createProjectDataProviderEngine +
    interface IProjectDataProviderEngineFactory<SupportedProjectInterfaces> {
        createProjectDataProviderEngine(projectId: string): Promise<IProjectDataProviderEngine<SupportedProjectInterfaces>>;
        getAvailableProjects(layeringFilters?: ProjectMetadataFilterOptions): Promise<ProjectMetadataWithoutFactoryInfo[]>;
    }

    Type Parameters

    Methods

    createProjectDataProviderEngine getAvailableProjects

    Methods

    createProjectDataProviderEngine

    getAvailableProjects

    getAvailableProjects

    • getAvailableProjects(layeringFilters?): Promise<ProjectMetadataWithoutFactoryInfo[]>

    • Get metadata about all projects that can be served by PDPs created by this PDP factory.

      If this is a Base PDP Factory, this method should return this PDP Factory's own unique project IDs.

      If this is a Layering PDP Factory, this method should call @@ -46,4 +46,4 @@ calling papi.projectLookup.getMetadataForAllProjects inside this method. If you are not calling getMetadataForAllProjects inside this method (likely if this is a Base PDPF), you can safely ignore this parameter.

      -

    Returns Promise<ProjectMetadataWithoutFactoryInfo[]>

    Settings

    Member Visibility

    On This Page

    Methods
    +

    Returns Promise<ProjectMetadataWithoutFactoryInfo[]>

    Settings

    Member Visibility

    On This Page

    Methods
    diff --git a/papi-dts/interfaces/_shared_models_project_data_provider_factory_interface_.default.html b/papi-dts/interfaces/_shared_models_project_data_provider_factory_interface_.default.html index 7fdc07f97c..1d5a8c3452 100644 --- a/papi-dts/interfaces/_shared_models_project_data_provider_factory_interface_.default.html +++ b/papi-dts/interfaces/_shared_models_project_data_provider_factory_interface_.default.html @@ -6,11 +6,11 @@ and provide additional projectInterfaces on those projects (Layering PDP Factory). Base PDP Factories must create PDPs that support the platform.base projectInterface. See IBaseProjectDataProvider and ProjectDataProviderInterfaces for more information.

    -
    interface default {
        dispose: UnsubscriberAsync;
        getAvailableProjects(layeringFilters?: ProjectMetadataFilterOptions): Promise<ProjectMetadataWithoutFactoryInfo[]>;
        getProjectDataProviderId(projectId: string): Promise<string>;
    }

    Hierarchy

    Properties

    dispose +
    interface default {
        dispose: UnsubscriberAsync;
        getAvailableProjects(layeringFilters?: ProjectMetadataFilterOptions): Promise<ProjectMetadataWithoutFactoryInfo[]>;
        getProjectDataProviderId(projectId: string): Promise<string>;
    }

    Hierarchy

    • Dispose
      • default

    Properties

    dispose

    Methods

    getAvailableProjects getProjectDataProviderId

    Properties

    dispose

    dispose: UnsubscriberAsync

    Release resources and notify dependent services when tearing down an object

    -

    Methods

    getAvailableProjects

    Methods

    getAvailableProjects

    • getAvailableProjects(layeringFilters?): Promise<ProjectMetadataWithoutFactoryInfo[]>

    • Get metadata about all projects that can be served by PDPs created by this PDP factory.

      If this is a Base PDP Factory, this method should return this PDP Factory's own unique project IDs.

      If this is a Layering PDP Factory, this method should call @@ -28,11 +28,11 @@ calling papi.projectLookup.getMetadataForAllProjects inside this method. If you are not calling getMetadataForAllProjects inside this method (likely if this is a Base PDPF), you can safely ignore this parameter.

      -

    Returns Promise<ProjectMetadataWithoutFactoryInfo[]>

    getProjectDataProviderId

    Returns Promise<ProjectMetadataWithoutFactoryInfo[]>

    getProjectDataProviderId

    Settings

    Member Visibility

    On This Page

    Properties
    Methods
    +

    Settings

    Member Visibility

    On This Page

    Properties
    Methods
    diff --git a/papi-dts/interfaces/_shared_models_rpc_interface_.IRpcHandler.html b/papi-dts/interfaces/_shared_models_rpc_interface_.IRpcHandler.html index 8a4b6bdff6..9d5aed7aa6 100644 --- a/papi-dts/interfaces/_shared_models_rpc_interface_.IRpcHandler.html +++ b/papi-dts/interfaces/_shared_models_rpc_interface_.IRpcHandler.html @@ -4,7 +4,7 @@ really just the name of a method in JSONRPC. So "method names" and "request types" are treated as the same thing. Similarly, what we call a "request handler" is the same thing as a "method" that has been registered with a JSONRPC server.

    -
    interface IRpcHandler {
        connect: ((localEventHandler: EventHandler) => Promise<boolean>);
        connectionStatus: ConnectionStatus;
        disconnect: (() => Promise<void>);
        emitEventOnNetwork: EventHandler;
        request: ((requestType: `${string}:${string}`, requestParams: RequestParams) => Promise<JSONRPCResponse>);
    }

    Hierarchy (view full)

    Implemented by

    Properties

    connect +
    interface IRpcHandler {
        connect: ((localEventHandler: EventHandler) => Promise<boolean>);
        connectionStatus: ConnectionStatus;
        disconnect: (() => Promise<void>);
        emitEventOnNetwork: EventHandler;
        request: ((requestType: `${string}:${string}`, requestParams: RequestParams) => Promise<JSONRPCResponse>);
    }

    Hierarchy (view full)

    Implemented by

    Properties

    connect connectionStatus disconnect emitEventOnNetwork @@ -18,19 +18,19 @@

    Type declaration

      • (localEventHandler): Promise<boolean>

      • Parameters

        • localEventHandler: EventHandler

          Function that handles events from the server by accepting an eventType and an event and emitting the event locally. Used when receiving an event over the network.

        Returns Promise<boolean>

        Promise that resolves 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

    -

    disconnect

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

    Disconnects from the connection:

    +

    disconnect

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

    Disconnects from the connection:

    • On clients: disconnects from the server
    • On servers: disconnects from all clients and closes its connection endpoint
    -

    emitEventOnNetwork

    emitEventOnNetwork: EventHandler

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

    emitEventOnNetwork

    emitEventOnNetwork: EventHandler

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

    Param: eventType

    Unique network event type for coordinating between processes

    Param: event

    Event data to emit on the network

    -

    request

    request: ((requestType: `${string}:${string}`, requestParams: RequestParams) => Promise<JSONRPCResponse>)

    Send a request and resolve after receiving a response

    +

    request

    request: ((requestType: `${string}:${string}`, requestParams: RequestParams) => Promise<JSONRPCResponse>)

    Send a request and resolve after receiving a response

    Type declaration

      • (requestType, requestParams): Promise<JSONRPCResponse>

      • Parameters

        • requestType: `${string}:${string}`

          Type of request (or "method" in JSONRPC jargon) to call

        • requestParams: RequestParams

          Parameters associated with this request

        Returns Promise<JSONRPCResponse>

        Promise that resolves to a JSONRPCSuccessResponse or JSONRPCErrorResponse message

        -

    Settings

    Member Visibility

    On This Page

    Properties
    +

    Settings

    Member Visibility

    On This Page

    Properties
    diff --git a/papi-dts/interfaces/_shared_models_rpc_interface_.IRpcMethodRegistrar.html b/papi-dts/interfaces/_shared_models_rpc_interface_.IRpcMethodRegistrar.html index 752bb50283..6181fb9a46 100644 --- a/papi-dts/interfaces/_shared_models_rpc_interface_.IRpcMethodRegistrar.html +++ b/papi-dts/interfaces/_shared_models_rpc_interface_.IRpcMethodRegistrar.html @@ -5,7 +5,7 @@ really just the name of a method in JSONRPC. So "method names" and "request types" are treated as the same thing. Similarly, what we call a "request handler" is the same thing as a "method" that has been registered with a JSONRPC server.

    -
    interface IRpcMethodRegistrar {
        connect: ((localEventHandler: EventHandler) => Promise<boolean>);
        connectionStatus: ConnectionStatus;
        disconnect: (() => Promise<void>);
        emitEventOnNetwork: EventHandler;
        registerMethod: ((methodName: string, method: InternalRequestHandler) => Promise<boolean>);
        request: ((requestType: `${string}:${string}`, requestParams: RequestParams) => Promise<JSONRPCResponse>);
        unregisterMethod: ((methodName: string) => Promise<boolean>);
    }

    Hierarchy (view full)

    Implemented by

    Properties

    connect +
    interface IRpcMethodRegistrar {
        connect: ((localEventHandler: EventHandler) => Promise<boolean>);
        connectionStatus: ConnectionStatus;
        disconnect: (() => Promise<void>);
        emitEventOnNetwork: EventHandler;
        registerMethod: ((methodName: string, method: InternalRequestHandler) => Promise<boolean>);
        request: ((requestType: `${string}:${string}`, requestParams: RequestParams) => Promise<JSONRPCResponse>);
        unregisterMethod: ((methodName: string) => Promise<boolean>);
    }

    Hierarchy (view full)

    Implemented by

    Properties

    connect connectionStatus disconnect emitEventOnNetwork @@ -21,21 +21,21 @@

    Type declaration

      • (localEventHandler): Promise<boolean>

      • Parameters

        • localEventHandler: EventHandler

          Function that handles events from the server by accepting an eventType and an event and emitting the event locally. Used when receiving an event over the network.

        Returns Promise<boolean>

        Promise that resolves 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

    -

    disconnect

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

    Disconnects from the connection:

    +

    disconnect

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

    Disconnects from the connection:

    • On clients: disconnects from the server
    • On servers: disconnects from all clients and closes its connection endpoint
    -

    emitEventOnNetwork

    emitEventOnNetwork: EventHandler

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

    emitEventOnNetwork

    emitEventOnNetwork: EventHandler

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

    Param: eventType

    Unique network event type for coordinating between processes

    Param: event

    Event data to emit on the network

    -

    registerMethod

    registerMethod: ((methodName: string, method: InternalRequestHandler) => Promise<boolean>)

    Register a method that will be called if an RPC request is made

    -

    request

    request: ((requestType: `${string}:${string}`, requestParams: RequestParams) => Promise<JSONRPCResponse>)

    Send a request and resolve after receiving a response

    +

    registerMethod

    registerMethod: ((methodName: string, method: InternalRequestHandler) => Promise<boolean>)

    Register a method that will be called if an RPC request is made

    +

    request

    request: ((requestType: `${string}:${string}`, requestParams: RequestParams) => Promise<JSONRPCResponse>)

    Send a request and resolve after receiving a response

    Type declaration

      • (requestType, requestParams): Promise<JSONRPCResponse>

      • Parameters

        • requestType: `${string}:${string}`

          Type of request (or "method" in JSONRPC jargon) to call

        • requestParams: RequestParams

          Parameters associated with this request

        Returns Promise<JSONRPCResponse>

        Promise that resolves to a JSONRPCSuccessResponse or JSONRPCErrorResponse message

        -

    unregisterMethod

    unregisterMethod: ((methodName: string) => Promise<boolean>)

    Unregister a method so it is no longer available to RPC requests

    -

    Settings

    Member Visibility

    On This Page

    Properties
    +

    unregisterMethod

    unregisterMethod: ((methodName: string) => Promise<boolean>)

    Unregister a method so it is no longer available to RPC requests

    +

    Settings

    Member Visibility

    On This Page

    Properties
    diff --git a/papi-dts/interfaces/_shared_models_web_view_provider_model_.IDisposableWebViewProvider.html b/papi-dts/interfaces/_shared_models_web_view_provider_model_.IDisposableWebViewProvider.html index 0d605e402f..20a6c3a2af 100644 --- a/papi-dts/interfaces/_shared_models_web_view_provider_model_.IDisposableWebViewProvider.html +++ b/papi-dts/interfaces/_shared_models_web_view_provider_model_.IDisposableWebViewProvider.html @@ -1,12 +1,12 @@ IDisposableWebViewProvider | papi-dts

    InterfaceIDisposableWebViewProvider

    A web view provider that has been registered with the PAPI and returned to the extension that registered it. It is able to be disposed with dispose.

    The PAPI returns this type from papi.webViewProviders.register.

    -
    interface IDisposableWebViewProvider {
        dispose: UnsubscriberAsync;
        onDidDispose: PlatformEvent<void>;
        getWebView(savedWebViewDefinition: SavedWebViewDefinition, getWebViewOptions: GetWebViewOptions, webViewNonce: string): Promise<undefined | WebViewDefinition>;
    }

    Hierarchy (view full)

    Properties

    dispose +
    interface IDisposableWebViewProvider {
        dispose: UnsubscriberAsync;
        onDidDispose: PlatformEvent<void>;
        getWebView(savedWebViewDefinition: SavedWebViewDefinition, getWebViewOptions: GetWebViewOptions, webViewNonce: string): Promise<undefined | WebViewDefinition>;
    }

    Hierarchy (view full)

    Properties

    dispose onDidDispose

    Methods

    getWebView

    Properties

    dispose

    dispose: UnsubscriberAsync

    Release resources and notify dependent services when tearing down an object

    -

    onDidDispose

    onDidDispose: PlatformEvent<void>

    Event that emits when dispose is called on an object

    -

    Methods

    getWebView

    onDidDispose

    onDidDispose: PlatformEvent<void>

    Event that emits when dispose is called on an object

    +

    Methods

    getWebView

    • getWebView(savedWebViewDefinition, getWebViewOptions, webViewNonce): Promise<undefined | WebViewDefinition>

    • Receives a SavedWebViewDefinition and fills it out into a full WebViewDefinition, providing the contents of the web view and other properties that are important for displaying the web view.

      The PAPI calls this method as part of opening a new web view or (re)loading an existing web @@ -34,4 +34,4 @@ applicable (See papi.webViewProviders.registerWebViewController).

    Returns Promise<undefined | WebViewDefinition>

    Full WebViewDefinition including the content and other important display properties based on the SavedWebViewDefinition provided

    -

    Settings

    Member Visibility

    On This Page

    Properties
    Methods
    +

    Settings

    Member Visibility

    On This Page

    Properties
    Methods
    diff --git a/papi-dts/interfaces/_shared_models_web_view_provider_model_.IRegisteredWebViewProvider.html b/papi-dts/interfaces/_shared_models_web_view_provider_model_.IRegisteredWebViewProvider.html index 30d1354c79..02b5f67d54 100644 --- a/papi-dts/interfaces/_shared_models_web_view_provider_model_.IRegisteredWebViewProvider.html +++ b/papi-dts/interfaces/_shared_models_web_view_provider_model_.IRegisteredWebViewProvider.html @@ -2,10 +2,10 @@

    This is what the papi gives on webViewProviderService.get (not exposed on the PAPI). Basically a layer over NetworkObject

    This type is internal to core and is not used by extensions

    -
    interface IRegisteredWebViewProvider {
        onDidDispose: PlatformEvent<void>;
        getWebView(savedWebViewDefinition: SavedWebViewDefinition, getWebViewOptions: GetWebViewOptions, webViewNonce: string): Promise<undefined | WebViewDefinition>;
    }

    Hierarchy (view full)

    Properties

    onDidDispose +
    interface IRegisteredWebViewProvider {
        onDidDispose: PlatformEvent<void>;
        getWebView(savedWebViewDefinition: SavedWebViewDefinition, getWebViewOptions: GetWebViewOptions, webViewNonce: string): Promise<undefined | WebViewDefinition>;
    }

    Hierarchy (view full)

    Properties

    onDidDispose

    Methods

    getWebView

    Properties

    onDidDispose

    onDidDispose: PlatformEvent<void>

    Event that emits when dispose is called on an object

    -

    Methods

    getWebView

    Methods

    getWebView

    • getWebView(savedWebViewDefinition, getWebViewOptions, webViewNonce): Promise<undefined | WebViewDefinition>

    • Receives a SavedWebViewDefinition and fills it out into a full WebViewDefinition, providing the contents of the web view and other properties that are important for displaying the web view.

      The PAPI calls this method as part of opening a new web view or (re)loading an existing web @@ -33,4 +33,4 @@ applicable (See papi.webViewProviders.registerWebViewController).

    Returns Promise<undefined | WebViewDefinition>

    Full WebViewDefinition including the content and other important display properties based on the SavedWebViewDefinition provided

    -

    Settings

    Member Visibility

    On This Page

    Properties
    Methods
    +

    Settings

    Member Visibility

    On This Page

    Properties
    Methods
    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 965da38ffe..ccf31bca1a 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 @@ -6,12 +6,12 @@ and extensions, you can extend the abstract class WebViewFactory to make the process easier. Alternatively, if you want to manage web view controllers manually, you can register them in IWebViewProvider.getWebView.

    -
    interface IWebViewProvider {
        dispose?: UnsubscriberAsync;
        onDidDispose?: undefined;
        getWebView(savedWebViewDefinition: SavedWebViewDefinition, getWebViewOptions: GetWebViewOptions, webViewNonce: string): Promise<undefined | WebViewDefinition>;
    }

    Hierarchy (view full)

    Implemented by

    Properties

    dispose? +
    interface IWebViewProvider {
        dispose?: UnsubscriberAsync;
        onDidDispose?: undefined;
        getWebView(savedWebViewDefinition: SavedWebViewDefinition, getWebViewOptions: GetWebViewOptions, webViewNonce: string): Promise<undefined | WebViewDefinition>;
    }

    Hierarchy (view full)

    Implemented by

    Properties

    dispose? onDidDispose?

    Methods

    getWebView

    Properties

    Optionaldispose

    dispose?: UnsubscriberAsync

    Release resources and notify dependent services when tearing down an object

    -

    OptionalonDidDispose

    onDidDispose?: undefined

    Event that emits when dispose is called on an object

    -

    Methods

    getWebView

    OptionalonDidDispose

    onDidDispose?: undefined

    Event that emits when dispose is called on an object

    +

    Methods

    getWebView

    • getWebView(savedWebViewDefinition, getWebViewOptions, webViewNonce): Promise<undefined | WebViewDefinition>

    • Receives a SavedWebViewDefinition and fills it out into a full WebViewDefinition, providing the contents of the web view and other properties that are important for displaying the web view.

      The PAPI calls this method as part of opening a new web view or (re)loading an existing web @@ -39,4 +39,4 @@ applicable (See papi.webViewProviders.registerWebViewController).

    Returns Promise<undefined | WebViewDefinition>

    Full WebViewDefinition including the content and other important display properties based on the SavedWebViewDefinition provided

    -

    Settings

    Member Visibility

    On This Page

    Properties
    Methods
    +

    Settings

    Member Visibility

    On This Page

    Properties
    Methods
    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 d0d3247531..81c5c997f2 100644 --- a/papi-dts/interfaces/_shared_services_data_provider_service_.DataProviderService.html +++ b/papi-dts/interfaces/_shared_services_data_provider_service_.DataProviderService.html @@ -1,4 +1,4 @@ -DataProviderService | papi-dts

    InterfaceDataProviderService

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

    Properties

    DataProviderEngine +DataProviderService | papi-dts

    InterfaceDataProviderService

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

    Properties

    DataProviderEngine decorators get hasKnown @@ -7,7 +7,7 @@ data provider engine class extends this class, it doesn't have to specify its own notifyUpdate function in order to use notifyUpdate.

    See

    IDataProviderEngine for more information on extending this class.

    -

    decorators

    decorators: {
        doNotNotify: {
            (method: Function & {
                doNotNotify?: boolean;
            }): void;
            (target: object, member: string): void;
        };
        ignore: {
            (method: Function & {
                isIgnored?: boolean;
            }): void;
            (target: object, member: string): void;
        };
    }

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

    +

    decorators

    decorators: {
        doNotNotify: {
            (method: Function & {
                doNotNotify?: boolean;
            }): void;
            (target: object, member: string): void;
        };
        ignore: {
            (method: Function & {
                isIgnored?: boolean;
            }): void;
            (target: object, member: string): void;
        };
    }

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

    Type declaration

    • doNotNotify: {
          (method: Function & {
              doNotNotify?: boolean;
          }): void;
          (target: object, member: string): void;
      }

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

      @@ -81,19 +81,19 @@

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

      -

    get

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

    Get a data provider that has previously been set up

    +

    get

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

    Get a data provider that has previously been set up

    Type declaration

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

      • Get a data provider that has previously been set up

        Type Parameters

        • DataProviderName extends keyof DataProviders

        Parameters

        Returns Promise<DataProviders[DataProviderName] | undefined>

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

    Param: providerName

    Name of the desired data provider

    Returns

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

    -

    hasKnown

    hasKnown: ((providerName: string) => boolean)

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

    hasKnown

    hasKnown: ((providerName: string) => boolean)

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

    Type declaration

      • (providerName): boolean

      • 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: DataProviderName, dataProviderEngine: "shared/models/data-provider-engine.model".default<DataProviderTypes[DataProviderName]>, dataProviderType?: string, dataProviderAttributes?: {
        [property: string]: unknown;
    }) => 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: DataProviderName, dataProviderEngine: "shared/models/data-provider-engine.model".default<DataProviderTypes[DataProviderName]>, dataProviderType?: string, dataProviderAttributes?: {
        [property: string]: unknown;
    }) => Promise<DisposableDataProviders[DataProviderName]>)

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

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

        @@ -121,4 +121,4 @@ set methods are layered over to facilitate data provider subscriptions.

        Returns

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

        -

    Settings

    Member Visibility

    On This Page

    Properties
    +

    Settings

    Member Visibility

    On This Page

    Properties
    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 07219951c0..eb06296137 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

    InterfaceDialogService

    Prompt the user for responses with dialogs

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

    Methods

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

    Methods

    selectProject showDialog

    Methods

    selectProject

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

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

      Parameters

      Returns Promise<undefined | string>

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

      -

    showDialog

    showDialog

    Settings

    Member Visibility

    On This Page

    Methods
    +

    Settings

    Member Visibility

    On This Page

    Methods
    diff --git a/papi-dts/interfaces/_shared_services_internet_service_.InternetService.html b/papi-dts/interfaces/_shared_services_internet_service_.InternetService.html index 6082470ed7..a625d41cbf 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

    InterfaceInternetService

    interface InternetService {
        fetch: {
            (input: RequestInfo | URL, init?: RequestInit): Promise<Response>;
            (input: string | Request | URL, init?: RequestInit): Promise<Response>;
        };
    }

    Properties

    fetch +InternetService | papi-dts

    InterfaceInternetService

    interface InternetService {
        fetch: {
            (input: RequestInfo | URL, init?: RequestInit): Promise<Response>;
            (input: string | Request | URL, init?: RequestInit): Promise<Response>;
        };
    }

    Properties

    fetch

    Properties

    fetch

    fetch: {
        (input: RequestInfo | URL, init?: RequestInit): Promise<Response>;
        (input: string | Request | URL, init?: RequestInit): Promise<Response>;
    }

    Type declaration

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

      • MDN Reference

        -

        Parameters

        • input: RequestInfo | URL
        • Optionalinit: RequestInit

        Returns Promise<Response>

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

      • Parameters

        • input: string | Request | URL
        • Optionalinit: RequestInit

        Returns Promise<Response>

    Settings

    Member Visibility

    On This Page

    Properties
    +

    Parameters

    • input: RequestInfo | URL
    • Optionalinit: RequestInit

    Returns Promise<Response>

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

  • Parameters

    • input: string | Request | URL
    • Optionalinit: RequestInit

    Returns Promise<Response>

    • Settings

    Member Visibility

    On This Page

    Properties
    diff --git a/papi-dts/interfaces/_shared_services_network_object_service_.MinimalNetworkObjectService.html b/papi-dts/interfaces/_shared_services_network_object_service_.MinimalNetworkObjectService.html index 3c3638f778..e68c4d5421 100644 --- a/papi-dts/interfaces/_shared_services_network_object_service_.MinimalNetworkObjectService.html +++ b/papi-dts/interfaces/_shared_services_network_object_service_.MinimalNetworkObjectService.html @@ -1,4 +1,4 @@ -MinimalNetworkObjectService | papi-dts

    InterfaceMinimalNetworkObjectService

    interface MinimalNetworkObjectService {
        get: (<T>(id: string, createLocalObjectToProxy?: LocalObjectToProxyCreator<T>) => Promise<undefined | NetworkObject<T>>);
        onDidCreateNetworkObject: PlatformEvent<NetworkObjectDetails>;
        set: (<T>(id: string, objectToShare: T, objectType?: string, objectAttributes?: {
            [property: string]: unknown;
        }) => Promise<DisposableNetworkObject<T>>);
    }

    Hierarchy (view full)

    Properties

    get +MinimalNetworkObjectService | papi-dts

    InterfaceMinimalNetworkObjectService

    interface MinimalNetworkObjectService {
        get: (<T>(id: string, createLocalObjectToProxy?: LocalObjectToProxyCreator<T>) => Promise<undefined | NetworkObject<T>>);
        onDidCreateNetworkObject: PlatformEvent<NetworkObjectDetails>;
        set: (<T>(id: string, objectToShare: T, objectType?: string, objectAttributes?: {
            [property: string]: unknown;
        }) => Promise<DisposableNetworkObject<T>>);
    }

    Hierarchy (view full)

    Properties

    get onDidCreateNetworkObject set

    Properties

    get

    get: (<T>(id: string, createLocalObjectToProxy?: LocalObjectToProxyCreator<T>) => Promise<undefined | NetworkObject<T>>)

    Type declaration

      • <T>(id, createLocalObjectToProxy?): Promise<undefined | NetworkObject<T>>

      • Get a network object that has previously been set up to be shared on the network. A network @@ -10,7 +10,7 @@ will be based upon. The object this function creates cannot have an onDidDispose property. This function is useful for setting up network events on a network object.

    Returns Promise<undefined | NetworkObject<T>>

    A promise for the network object with specified ID if one exists, undefined otherwise

    -

    onDidCreateNetworkObject

    onDidCreateNetworkObject: PlatformEvent<NetworkObjectDetails>

    set

    set: (<T>(id: string, objectToShare: T, objectType?: string, objectAttributes?: {
        [property: string]: unknown;
    }) => Promise<DisposableNetworkObject<T>>)

    Type declaration

      • <T>(id, objectToShare, objectType?, objectAttributes?): Promise<DisposableNetworkObject<T>>

      • Set up an object to be shared on the network.

        +

    onDidCreateNetworkObject

    onDidCreateNetworkObject: PlatformEvent<NetworkObjectDetails>

    set

    set: (<T>(id: string, objectToShare: T, objectType?: string, objectAttributes?: {
        [property: string]: unknown;
    }) => Promise<DisposableNetworkObject<T>>)

    Type declaration

      • <T>(id, objectToShare, objectType?, objectAttributes?): Promise<DisposableNetworkObject<T>>

      • Set up an object to be shared on the network.

        Type Parameters

        Parameters

        • id: string

          ID of the object to share on the network. All processes must use this ID to look it up.

        • objectToShare: T

          The object to set up as a network object. It will have an event named onDidDispose added to its properties. An error will be thrown if the object already had an @@ -19,4 +19,4 @@ object did not already define a dispose function, one will be added.

          WARNING: setting a network object mutates the provided object.

        • OptionalobjectType: string
        • OptionalobjectAttributes: {
              [property: string]: unknown;
          }
          • [property: string]: unknown

        Returns Promise<DisposableNetworkObject<T>>

        objectToShare modified to be a network object

        -

    Settings

    Member Visibility

    On This Page

    Properties
    +

    Settings

    Member Visibility

    On This Page

    Properties
    diff --git a/papi-dts/interfaces/_shared_services_network_object_service_.NetworkObjectService.html b/papi-dts/interfaces/_shared_services_network_object_service_.NetworkObjectService.html index f9b1fc59bf..c9fdff0bf1 100644 --- a/papi-dts/interfaces/_shared_services_network_object_service_.NetworkObjectService.html +++ b/papi-dts/interfaces/_shared_services_network_object_service_.NetworkObjectService.html @@ -1,4 +1,4 @@ -NetworkObjectService | papi-dts

    InterfaceNetworkObjectService

    interface NetworkObjectService {
        get: (<T>(id: string, createLocalObjectToProxy?: LocalObjectToProxyCreator<T>) => Promise<undefined | NetworkObject<T>>);
        hasKnown: ((id: string) => boolean);
        initialize: (() => Promise<void>);
        onDidCreateNetworkObject: PlatformEvent<NetworkObjectDetails>;
        set: (<T>(id: string, objectToShare: T, objectType?: string, objectAttributes?: {
            [property: string]: unknown;
        }) => Promise<DisposableNetworkObject<T>>);
    }

    Hierarchy (view full)

    Properties

    get +NetworkObjectService | papi-dts

    InterfaceNetworkObjectService

    interface NetworkObjectService {
        get: (<T>(id: string, createLocalObjectToProxy?: LocalObjectToProxyCreator<T>) => Promise<undefined | NetworkObject<T>>);
        hasKnown: ((id: string) => boolean);
        initialize: (() => Promise<void>);
        onDidCreateNetworkObject: PlatformEvent<NetworkObjectDetails>;
        set: (<T>(id: string, objectToShare: T, objectType?: string, objectAttributes?: {
            [property: string]: unknown;
        }) => Promise<DisposableNetworkObject<T>>);
    }

    Hierarchy (view full)

    Properties

    get hasKnown initialize onDidCreateNetworkObject @@ -12,12 +12,12 @@ will be based upon. The object this function creates cannot have an onDidDispose property. This function is useful for setting up network events on a network object.

    Returns Promise<undefined | NetworkObject<T>>

    A promise for the network object with specified ID if one exists, undefined otherwise

    -

    hasKnown

    hasKnown: ((id: string) => boolean)

    Type declaration

      • (id): boolean

      • Search locally known network objects for the given ID. Don't look on the network for more +

    hasKnown

    hasKnown: ((id: string) => boolean)

    Type declaration

      • (id): boolean

      • Search locally known network objects for the given ID. Don't look on the network for more objects.

        Parameters

        • id: string

        Returns boolean

        Whether we know of an existing network object with the provided ID already on the network

        -

    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>

    onDidCreateNetworkObject

    onDidCreateNetworkObject: PlatformEvent<NetworkObjectDetails>

    set

    set: (<T>(id: string, objectToShare: T, objectType?: string, objectAttributes?: {
        [property: string]: unknown;
    }) => Promise<DisposableNetworkObject<T>>)

    Type declaration

      • <T>(id, objectToShare, objectType?, objectAttributes?): Promise<DisposableNetworkObject<T>>

      • Set up an object to be shared on the network.

        +

    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>

    onDidCreateNetworkObject

    onDidCreateNetworkObject: PlatformEvent<NetworkObjectDetails>

    set

    set: (<T>(id: string, objectToShare: T, objectType?: string, objectAttributes?: {
        [property: string]: unknown;
    }) => Promise<DisposableNetworkObject<T>>)

    Type declaration

      • <T>(id, objectToShare, objectType?, objectAttributes?): Promise<DisposableNetworkObject<T>>

      • Set up an object to be shared on the network.

        Type Parameters

        Parameters

        • id: string

          ID of the object to share on the network. All processes must use this ID to look it up.

        • objectToShare: T

          The object to set up as a network object. It will have an event named onDidDispose added to its properties. An error will be thrown if the object already had an @@ -26,4 +26,4 @@ object did not already define a dispose function, one will be added.

          WARNING: setting a network object mutates the provided object.

        • OptionalobjectType: string
        • OptionalobjectAttributes: {
              [property: string]: unknown;
          }
          • [property: string]: unknown

        Returns Promise<DisposableNetworkObject<T>>

        objectToShare modified to be a network object

        -

    Settings

    Member Visibility

    On This Page

    Properties
    +

    Settings

    Member Visibility

    On This Page

    Properties
    diff --git a/papi-dts/interfaces/_shared_services_network_service_.PapiNetworkService.html b/papi-dts/interfaces/_shared_services_network_service_.PapiNetworkService.html index f8f0c1108a..4e2c5c50d2 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

    InterfacePapiNetworkService

    interface PapiNetworkService {
        createNetworkEventEmitter: (<T>(eventType: string) => PlatformEventEmitter<T>);
        getNetworkEvent: (<T>(eventType: string) => PlatformEvent<T>);
    }

    Properties

    createNetworkEventEmitter +PapiNetworkService | papi-dts

    InterfacePapiNetworkService

    interface PapiNetworkService {
        createNetworkEventEmitter: (<T>(eventType: string) => PlatformEventEmitter<T>);
        getNetworkEvent: (<T>(eventType: string) => PlatformEvent<T>);
    }

    Properties

    createNetworkEventEmitter getNetworkEvent

    Properties

    createNetworkEventEmitter

    createNetworkEventEmitter: (<T>(eventType: string) => PlatformEventEmitter<T>)

    Type declaration

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

      • Creates an event emitter that works properly over the network. Other connections receive this event when it is emitted.

        @@ -6,7 +6,7 @@ emitters.

        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: string) => 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: string) => 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

        -

    Settings

    Member Visibility

    On This Page

    Properties
    +

    Settings

    Member Visibility

    On This Page

    Properties
    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 8e3a90573a..7f7430b95b 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

    InterfacePapiBackendProjectDataProviderService

    interface PapiBackendProjectDataProviderService {
        get: (<ProjectInterface>(projectInterface: ProjectInterface, projectId: string, pdpFactoryId?: string) => Promise<ProjectDataProviderInterfaces[ProjectInterface]>);
        registerProjectDataProviderEngineFactory: (<SupportedProjectInterfaces>(pdpFactoryId: string, projectInterfaces: SupportedProjectInterfaces, pdpEngineFactory: IProjectDataProviderEngineFactory<SupportedProjectInterfaces>) => Promise<Dispose>);
    }

    Properties

    get +PapiBackendProjectDataProviderService | papi-dts

    InterfacePapiBackendProjectDataProviderService

    interface PapiBackendProjectDataProviderService {
        get: (<ProjectInterface>(projectInterface: ProjectInterface, projectId: string, pdpFactoryId?: string) => Promise<ProjectDataProviderInterfaces[ProjectInterface]>);
        registerProjectDataProviderEngineFactory: (<SupportedProjectInterfaces>(pdpFactoryId: string, projectInterfaces: SupportedProjectInterfaces, pdpEngineFactory: IProjectDataProviderEngineFactory<SupportedProjectInterfaces>) => Promise<Dispose>);
    }

    Properties

    get registerProjectDataProviderEngineFactory

    Properties

    get

    get: (<ProjectInterface>(projectInterface: ProjectInterface, projectId: string, pdpFactoryId?: string) => Promise<ProjectDataProviderInterfaces[ProjectInterface]>)

    Type declaration

      • <ProjectInterface>(projectInterface, projectId, pdpFactoryId?): Promise<ProjectDataProviderInterfaces[ProjectInterface]>

      • Get a Project Data Provider for the given project ID.

        Type Parameters

        Parameters

        • projectInterface: ProjectInterface

          projectInterface that the project to load must support. The TypeScript @@ -15,11 +15,11 @@

          Throws

          If did not find a project data provider for the project id that supports the requested projectInterface (and from the requested PDP factory if specified)

          -

    registerProjectDataProviderEngineFactory

    registerProjectDataProviderEngineFactory: (<SupportedProjectInterfaces>(pdpFactoryId: string, projectInterfaces: SupportedProjectInterfaces, pdpEngineFactory: IProjectDataProviderEngineFactory<SupportedProjectInterfaces>) => Promise<Dispose>)

    Type declaration

      • <SupportedProjectInterfaces>(pdpFactoryId, projectInterfaces, pdpEngineFactory): Promise<Dispose>

      • Add a new Project Data Provider Factory to PAPI that uses the given engine.

        +

    registerProjectDataProviderEngineFactory

    registerProjectDataProviderEngineFactory: (<SupportedProjectInterfaces>(pdpFactoryId: string, projectInterfaces: SupportedProjectInterfaces, pdpEngineFactory: IProjectDataProviderEngineFactory<SupportedProjectInterfaces>) => Promise<Dispose>)

    Type declaration

      • <SupportedProjectInterfaces>(pdpFactoryId, projectInterfaces, pdpEngineFactory): Promise<Dispose>

      • Add a new Project Data Provider Factory to PAPI that uses the given engine.

        Type Parameters

        Parameters

        • pdpFactoryId: string

          Unique id for this PDP factory

        • projectInterfaces: SupportedProjectInterfaces

          The standardized sets of methods (projectInterfaces) supported by the Project Data Provider Engines produced by this factory. Indicates what sort of project data should be available on the PDPEs created by this factory.

        • pdpEngineFactory: IProjectDataProviderEngineFactory<SupportedProjectInterfaces>

          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

    On This Page

    Properties
    +

    Settings

    Member Visibility

    On This Page

    Properties
    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 ab2b15c219..ec83921e83 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

    InterfacePapiFrontendProjectDataProviderService

    interface PapiFrontendProjectDataProviderService {
        get: (<ProjectInterface>(projectInterface: ProjectInterface, projectId: string, pdpFactoryId?: string) => Promise<ProjectDataProviderInterfaces[ProjectInterface]>);
    }

    Properties

    get +PapiFrontendProjectDataProviderService | papi-dts

    InterfacePapiFrontendProjectDataProviderService

    interface PapiFrontendProjectDataProviderService {
        get: (<ProjectInterface>(projectInterface: ProjectInterface, projectId: string, pdpFactoryId?: string) => Promise<ProjectDataProviderInterfaces[ProjectInterface]>);
    }

    Properties

    get

    Properties

    get

    get: (<ProjectInterface>(projectInterface: ProjectInterface, projectId: string, pdpFactoryId?: string) => Promise<ProjectDataProviderInterfaces[ProjectInterface]>)

    Type declaration

      • <ProjectInterface>(projectInterface, projectId, pdpFactoryId?): Promise<ProjectDataProviderInterfaces[ProjectInterface]>

      • Get a Project Data Provider for the given project ID.

        Type Parameters

        Parameters

        • projectInterface: ProjectInterface

          projectInterface that the project to load must support. The TypeScript type for the returned project data provider will have the project data provider interface type @@ -14,4 +14,4 @@

          Throws

          If did not find a project data provider for the project id that supports the requested projectInterface (and from the requested PDP factory if specified)

          -

    Settings

    Member Visibility

    On This Page

    Properties
    +

    Settings

    Member Visibility

    On This Page

    Properties
    diff --git a/papi-dts/interfaces/_shared_services_project_settings_service_model_.IProjectSettingsService.html b/papi-dts/interfaces/_shared_services_project_settings_service_model_.IProjectSettingsService.html index b03578d20a..ecbeb26cfc 100644 --- a/papi-dts/interfaces/_shared_services_project_settings_service_model_.IProjectSettingsService.html +++ b/papi-dts/interfaces/_shared_services_project_settings_service_model_.IProjectSettingsService.html @@ -1,5 +1,5 @@ IProjectSettingsService | papi-dts

    InterfaceIProjectSettingsService

    Provides utility functions that project data providers should call when handling project settings

    -
    interface IProjectSettingsService {
        getDefault<ProjectSettingName>(key: ProjectSettingName): Promise<ProjectSettingTypes[ProjectSettingName]>;
        getLocalizedContributionInfo(): Promise<undefined | {
            contributions: {};
            settings: {
                platform.fullName: undefined | {
                    default: string;
                    derivesFrom?: string;
                    description?: string;
                    excludePdpFactoryIds?: string | string[];
                    excludeProjectInterfaces?: string | (string | string[])[];
                    includePdpFactoryIds?: string | string[];
                    includeProjectInterfaces?: string | (string | string[])[];
                    label: string;
                    platformType?: undefined;
                    type?: undefined;
                };
                platform.isEditable: undefined | {
                    default: boolean;
                    derivesFrom?: string;
                    description?: string;
                    excludePdpFactoryIds?: string | string[];
                    excludeProjectInterfaces?: string | (string | string[])[];
                    includePdpFactoryIds?: string | string[];
                    includeProjectInterfaces?: string | (string | string[])[];
                    label: string;
                    platformType?: undefined;
                    type?: undefined;
                };
                platform.language: undefined | {
                    default: string;
                    derivesFrom?: string;
                    description?: string;
                    excludePdpFactoryIds?: string | string[];
                    excludeProjectInterfaces?: string | (string | string[])[];
                    includePdpFactoryIds?: string | string[];
                    includeProjectInterfaces?: string | (string | string[])[];
                    label: string;
                    platformType?: undefined;
                    type?: undefined;
                };
                platform.name: undefined | {
                    default: string;
                    derivesFrom?: string;
                    description?: string;
                    excludePdpFactoryIds?: string | string[];
                    excludeProjectInterfaces?: string | (string | string[])[];
                    includePdpFactoryIds?: string | string[];
                    includeProjectInterfaces?: string | (string | string[])[];
                    label: string;
                    platformType?: undefined;
                    type?: undefined;
                };
            };
        }>;
        isValid<ProjectSettingName>(key: ProjectSettingName, newValue: ProjectSettingTypes[ProjectSettingName], currentValue: ProjectSettingTypes[ProjectSettingName], allChanges?: SimultaneousProjectSettingsChanges): Promise<boolean>;
        registerValidator<ProjectSettingName>(key: ProjectSettingName, validatorCallback: ProjectSettingValidator<ProjectSettingName>): Promise<UnsubscriberAsync>;
    }

    Methods

    getDefault +
    interface IProjectSettingsService {
        getDefault<ProjectSettingName>(key: ProjectSettingName): Promise<ProjectSettingTypes[ProjectSettingName]>;
        getLocalizedContributionInfo(): Promise<undefined | {
            contributions: {};
            settings: {
                platform.fullName: undefined | {
                    default: string;
                    derivesFrom?: string;
                    description?: string;
                    excludePdpFactoryIds?: string | string[];
                    excludeProjectInterfaces?: string | (string | string[])[];
                    includePdpFactoryIds?: string | string[];
                    includeProjectInterfaces?: string | (string | string[])[];
                    label: string;
                    platformType?: undefined;
                    type?: undefined;
                };
                platform.isEditable: undefined | {
                    default: boolean;
                    derivesFrom?: string;
                    description?: string;
                    excludePdpFactoryIds?: string | string[];
                    excludeProjectInterfaces?: string | (string | string[])[];
                    includePdpFactoryIds?: string | string[];
                    includeProjectInterfaces?: string | (string | string[])[];
                    label: string;
                    platformType?: undefined;
                    type?: undefined;
                };
                platform.language: undefined | {
                    default: string;
                    derivesFrom?: string;
                    description?: string;
                    excludePdpFactoryIds?: string | string[];
                    excludeProjectInterfaces?: string | (string | string[])[];
                    includePdpFactoryIds?: string | string[];
                    includeProjectInterfaces?: string | (string | string[])[];
                    label: string;
                    platformType?: undefined;
                    type?: undefined;
                };
                platform.name: undefined | {
                    default: string;
                    derivesFrom?: string;
                    description?: string;
                    excludePdpFactoryIds?: string | string[];
                    excludeProjectInterfaces?: string | (string | string[])[];
                    includePdpFactoryIds?: string | string[];
                    includeProjectInterfaces?: string | (string | string[])[];
                    label: string;
                    platformType?: undefined;
                    type?: undefined;
                };
            };
        }>;
        isValid<ProjectSettingName>(key: ProjectSettingName, newValue: ProjectSettingTypes[ProjectSettingName], currentValue: ProjectSettingTypes[ProjectSettingName], allChanges?: SimultaneousProjectSettingsChanges): Promise<boolean>;
        registerValidator<ProjectSettingName>(key: ProjectSettingName, validatorCallback: ProjectSettingValidator<ProjectSettingName>): Promise<UnsubscriberAsync>;
    }

    Methods

    getDefault getLocalizedContributionInfo isValid registerValidator @@ -11,10 +11,10 @@

    Type Parameters

    Parameters

    Returns Promise<ProjectSettingTypes[ProjectSettingName]>

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

    Throws

    If a default value is not registered for the setting

    -

    getLocalizedContributionInfo

    • getLocalizedContributionInfo(): Promise<undefined | {
          contributions: {};
          settings: {
              platform.fullName: undefined | {
                  default: string;
                  derivesFrom?: string;
                  description?: string;
                  excludePdpFactoryIds?: string | string[];
                  excludeProjectInterfaces?: string | (string | string[])[];
                  includePdpFactoryIds?: string | string[];
                  includeProjectInterfaces?: string | (string | string[])[];
                  label: string;
                  platformType?: undefined;
                  type?: undefined;
              };
              platform.isEditable: undefined | {
                  default: boolean;
                  derivesFrom?: string;
                  description?: string;
                  excludePdpFactoryIds?: string | string[];
                  excludeProjectInterfaces?: string | (string | string[])[];
                  includePdpFactoryIds?: string | string[];
                  includeProjectInterfaces?: string | (string | string[])[];
                  label: string;
                  platformType?: undefined;
                  type?: undefined;
              };
              platform.language: undefined | {
                  default: string;
                  derivesFrom?: string;
                  description?: string;
                  excludePdpFactoryIds?: string | string[];
                  excludeProjectInterfaces?: string | (string | string[])[];
                  includePdpFactoryIds?: string | string[];
                  includeProjectInterfaces?: string | (string | string[])[];
                  label: string;
                  platformType?: undefined;
                  type?: undefined;
              };
              platform.name: undefined | {
                  default: string;
                  derivesFrom?: string;
                  description?: string;
                  excludePdpFactoryIds?: string | string[];
                  excludeProjectInterfaces?: string | (string | string[])[];
                  includePdpFactoryIds?: string | string[];
                  includeProjectInterfaces?: string | (string | string[])[];
                  label: string;
                  platformType?: undefined;
                  type?: undefined;
              };
          };
      }>

    • Get the current set of project settings contribution info given all the input documents with +

    getLocalizedContributionInfo

    • getLocalizedContributionInfo(): Promise<undefined | {
          contributions: {};
          settings: {
              platform.fullName: undefined | {
                  default: string;
                  derivesFrom?: string;
                  description?: string;
                  excludePdpFactoryIds?: string | string[];
                  excludeProjectInterfaces?: string | (string | string[])[];
                  includePdpFactoryIds?: string | string[];
                  includeProjectInterfaces?: string | (string | string[])[];
                  label: string;
                  platformType?: undefined;
                  type?: undefined;
              };
              platform.isEditable: undefined | {
                  default: boolean;
                  derivesFrom?: string;
                  description?: string;
                  excludePdpFactoryIds?: string | string[];
                  excludeProjectInterfaces?: string | (string | string[])[];
                  includePdpFactoryIds?: string | string[];
                  includeProjectInterfaces?: string | (string | string[])[];
                  label: string;
                  platformType?: undefined;
                  type?: undefined;
              };
              platform.language: undefined | {
                  default: string;
                  derivesFrom?: string;
                  description?: string;
                  excludePdpFactoryIds?: string | string[];
                  excludeProjectInterfaces?: string | (string | string[])[];
                  includePdpFactoryIds?: string | string[];
                  includeProjectInterfaces?: string | (string | string[])[];
                  label: string;
                  platformType?: undefined;
                  type?: undefined;
              };
              platform.name: undefined | {
                  default: string;
                  derivesFrom?: string;
                  description?: string;
                  excludePdpFactoryIds?: string | string[];
                  excludeProjectInterfaces?: string | (string | string[])[];
                  includePdpFactoryIds?: string | string[];
                  includeProjectInterfaces?: string | (string | string[])[];
                  label: string;
                  platformType?: undefined;
                  type?: undefined;
              };
          };
      }>

    • Get the current set of project settings contribution info given all the input documents with all localized string keys localized properly.

      Returns Promise<undefined | {
          contributions: {};
          settings: {
              platform.fullName: undefined | {
                  default: string;
                  derivesFrom?: string;
                  description?: string;
                  excludePdpFactoryIds?: string | string[];
                  excludeProjectInterfaces?: string | (string | string[])[];
                  includePdpFactoryIds?: string | string[];
                  includeProjectInterfaces?: string | (string | string[])[];
                  label: string;
                  platformType?: undefined;
                  type?: undefined;
              };
              platform.isEditable: undefined | {
                  default: boolean;
                  derivesFrom?: string;
                  description?: string;
                  excludePdpFactoryIds?: string | string[];
                  excludeProjectInterfaces?: string | (string | string[])[];
                  includePdpFactoryIds?: string | string[];
                  includeProjectInterfaces?: string | (string | string[])[];
                  label: string;
                  platformType?: undefined;
                  type?: undefined;
              };
              platform.language: undefined | {
                  default: string;
                  derivesFrom?: string;
                  description?: string;
                  excludePdpFactoryIds?: string | string[];
                  excludeProjectInterfaces?: string | (string | string[])[];
                  includePdpFactoryIds?: string | string[];
                  includeProjectInterfaces?: string | (string | string[])[];
                  label: string;
                  platformType?: undefined;
                  type?: undefined;
              };
              platform.name: undefined | {
                  default: string;
                  derivesFrom?: string;
                  description?: string;
                  excludePdpFactoryIds?: string | string[];
                  excludeProjectInterfaces?: string | (string | string[])[];
                  includePdpFactoryIds?: string | string[];
                  includeProjectInterfaces?: string | (string | string[])[];
                  label: string;
                  platformType?: undefined;
                  type?: undefined;
              };
          };
      }>

      Localized project settings contribution info or undefined

      -

    isValid

    isValid

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

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

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

      @@ -23,7 +23,7 @@
    • currentValue: ProjectSettingTypes[ProjectSettingName]

      The current project setting value

    • OptionalallChanges: SimultaneousProjectSettingsChanges

      All project settings changes being set in one batch

    Returns Promise<boolean>

    true if change is valid, false otherwise

    -

    registerValidator

    registerValidator

    Settings

    Member Visibility

    On This Page

    Methods
    +

    Settings

    Member Visibility

    On This Page

    Methods
    diff --git a/papi-dts/interfaces/_shared_services_scroll_group_service_model_.IScrollGroupRemoteService.html b/papi-dts/interfaces/_shared_services_scroll_group_service_model_.IScrollGroupRemoteService.html index fc222926dc..4cdc88f32c 100644 --- a/papi-dts/interfaces/_shared_services_scroll_group_service_model_.IScrollGroupRemoteService.html +++ b/papi-dts/interfaces/_shared_services_scroll_group_service_model_.IScrollGroupRemoteService.html @@ -1,12 +1,12 @@ IScrollGroupRemoteService | papi-dts

    InterfaceIScrollGroupRemoteService

    Parts of the Scroll Group Service that are exposed through the network object

    -
    interface IScrollGroupRemoteService {
        getScrRef(scrollGroupId?: number): Promise<ScriptureReference>;
        setScrRef(scrollGroupId: undefined | number, scrRef: ScriptureReference): Promise<boolean>;
    }

    Hierarchy (view full)

    Methods

    getScrRef +
    interface IScrollGroupRemoteService {
        getScrRef(scrollGroupId?: number): Promise<ScriptureReference>;
        setScrRef(scrollGroupId: undefined | number, scrRef: ScriptureReference): Promise<boolean>;
    }

    Hierarchy (view full)

    Methods

    getScrRef setScrRef

    Methods

    getScrRef

    • getScrRef(scrollGroupId?): Promise<ScriptureReference>

    • Get the ScriptureReference associated with the provided scroll group

      Parameters

      • OptionalscrollGroupId: number

        Scroll group whose Scripture reference to get. Defaults to 0

      Returns Promise<ScriptureReference>

      Scripture reference associated with the provided scroll group

      -

    setScrRef

    • setScrRef(scrollGroupId, scrRef): Promise<boolean>

    • Sets the ScriptureReference associated with the provided scroll group

      +

    setScrRef

    • setScrRef(scrollGroupId, scrRef): Promise<boolean>

    • Sets the ScriptureReference associated with the provided scroll group

      Parameters

      • scrollGroupId: undefined | number

        Scroll group whose Scripture reference to get. If undefined, defaults to 0

      • scrRef: ScriptureReference

        Scripture reference to which to set the scroll group

      Returns Promise<boolean>

      true if the Scripture reference changed. false otherwise

      -

    Settings

    Member Visibility

    On This Page

    Methods
    +

    Settings

    Member Visibility

    On This Page

    Methods
    diff --git a/papi-dts/interfaces/_shared_services_scroll_group_service_model_.IScrollGroupService.html b/papi-dts/interfaces/_shared_services_scroll_group_service_model_.IScrollGroupService.html index 0748e03642..3921b49cb0 100644 --- a/papi-dts/interfaces/_shared_services_scroll_group_service_model_.IScrollGroupService.html +++ b/papi-dts/interfaces/_shared_services_scroll_group_service_model_.IScrollGroupService.html @@ -1,14 +1,14 @@ IScrollGroupService | papi-dts

    InterfaceIScrollGroupService

    Provides functions related to scroll groups and Scripture references at those scroll groups

    -
    interface IScrollGroupService {
        onDidUpdateScrRef: PlatformEvent<ScrollGroupUpdateInfo>;
        getScrRef(scrollGroupId?: number): Promise<ScriptureReference>;
        setScrRef(scrollGroupId: undefined | number, scrRef: ScriptureReference): Promise<boolean>;
    }

    Hierarchy (view full)

    Properties

    onDidUpdateScrRef +
    interface IScrollGroupService {
        onDidUpdateScrRef: PlatformEvent<ScrollGroupUpdateInfo>;
        getScrRef(scrollGroupId?: number): Promise<ScriptureReference>;
        setScrRef(scrollGroupId: undefined | number, scrRef: ScriptureReference): Promise<boolean>;
    }

    Hierarchy (view full)

    Properties

    onDidUpdateScrRef

    Methods

    getScrRef setScrRef

    Properties

    onDidUpdateScrRef

    onDidUpdateScrRef: PlatformEvent<ScrollGroupUpdateInfo>

    Event that emits with information about a changed Scripture Reference for a scroll group

    -

    Methods

    getScrRef

    • getScrRef(scrollGroupId?): Promise<ScriptureReference>

    • Get the ScriptureReference associated with the provided scroll group

      +

    Methods

    getScrRef

    • getScrRef(scrollGroupId?): Promise<ScriptureReference>

    • Get the ScriptureReference associated with the provided scroll group

      Parameters

      • OptionalscrollGroupId: number

        Scroll group whose Scripture reference to get. Defaults to 0

      Returns Promise<ScriptureReference>

      Scripture reference associated with the provided scroll group

      -

    setScrRef

    setScrRef

    • setScrRef(scrollGroupId, scrRef): Promise<boolean>

    • Sets the ScriptureReference associated with the provided scroll group

      Parameters

      • scrollGroupId: undefined | number

        Scroll group whose Scripture reference to get. If undefined, defaults to 0

      • scrRef: ScriptureReference

        Scripture reference to which to set the scroll group

      Returns Promise<boolean>

      true if the Scripture reference changed. false otherwise

      -

    Settings

    Member Visibility

    On This Page

    Properties
    Methods
    +

    Settings

    Member Visibility

    On This Page

    Properties
    Methods
    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 2ab1ac3281..85ef150d3a 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,4 +1,4 @@ -PapiWebViewProviderService | papi-dts

    InterfacePapiWebViewProviderService

    interface PapiWebViewProviderService {
        postMessageToWebView: ((webViewId: string, webViewNonce: string, message: unknown, targetOrigin?: string) => Promise<void>);
        register: ((...args: [webViewType: string, webViewProvider: IWebViewProvider]) => Promise<IDisposableWebViewProvider>);
        registerWebViewController: (<WebViewType>(webViewType: WebViewType, webViewId: string, webViewController: WebViewControllers[WebViewType]) => Promise<DisposableNetworkObject<WebViewControllers[WebViewType]>>);
        registerWebViewProvider: ((webViewType: string, webViewProvider: IWebViewProvider) => Promise<IDisposableWebViewProvider>);
    }

    Properties

    postMessageToWebView +PapiWebViewProviderService | papi-dts

    InterfacePapiWebViewProviderService

    interface PapiWebViewProviderService {
        postMessageToWebView: ((webViewId: string, webViewNonce: string, message: unknown, targetOrigin?: string) => Promise<void>);
        register: ((...args: [webViewType: string, webViewProvider: IWebViewProvider]) => Promise<IDisposableWebViewProvider>);
        registerWebViewController: (<WebViewType>(webViewType: WebViewType, webViewId: string, webViewController: WebViewControllers[WebViewType]) => Promise<DisposableNetworkObject<WebViewControllers[WebViewType]>>);
        registerWebViewProvider: ((webViewType: string, webViewProvider: IWebViewProvider) => Promise<IDisposableWebViewProvider>);
    }

    Properties

    postMessageToWebView register registerWebViewController registerWebViewProvider @@ -19,8 +19,8 @@ targetOrigin for more information. Defaults to same origin only (works automatically with React and HTML web views)

    -

    Returns Promise<void>

    register

    register: ((...args: [webViewType: string, webViewProvider: IWebViewProvider]) => Promise<IDisposableWebViewProvider>)

    Deprecated

    13 November 2024. Renamed to registerWebViewProvider

    -

    registerWebViewController

    registerWebViewController: (<WebViewType>(webViewType: WebViewType, webViewId: string, webViewController: WebViewControllers[WebViewType]) => Promise<DisposableNetworkObject<WebViewControllers[WebViewType]>>)

    Type declaration

    Returns Promise<void>

    register

    register: ((...args: [webViewType: string, webViewProvider: IWebViewProvider]) => Promise<IDisposableWebViewProvider>)

    Deprecated

    13 November 2024. Renamed to registerWebViewProvider

    +

    registerWebViewController

    registerWebViewController: (<WebViewType>(webViewType: WebViewType, webViewId: string, webViewController: WebViewControllers[WebViewType]) => Promise<DisposableNetworkObject<WebViewControllers[WebViewType]>>)

    Type declaration

      • <WebViewType>(webViewType, webViewId, webViewController): Promise<DisposableNetworkObject<WebViewControllers[WebViewType]>>

      • Register a web view controller to represent a web view. It is expected that a web view provider calls this to register a web view controller for a web view that is being created. If a web view provider extends WebViewFactory, it will call this function automatically.

        A Web View Controller is a network object that represents a web view and whose methods facilitate @@ -33,10 +33,10 @@ is closed

        WARNING: setting a web view controller mutates the provided object.

    Returns Promise<DisposableNetworkObject<WebViewControllers[WebViewType]>>

    webViewController modified to be a network object

    -

    registerWebViewProvider

    registerWebViewProvider: ((webViewType: string, webViewProvider: IWebViewProvider) => Promise<IDisposableWebViewProvider>)

    Type declaration

      • (webViewType, webViewProvider): Promise<IDisposableWebViewProvider>

      • Register a web view provider to serve webViews for a specified type of webViews

        +

    registerWebViewProvider

    registerWebViewProvider: ((webViewType: string, webViewProvider: IWebViewProvider) => Promise<IDisposableWebViewProvider>)

    Type declaration

      • (webViewType, webViewProvider): Promise<IDisposableWebViewProvider>

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

        webViewProvider modified to be a network object and able to be disposed with dispose

        -

    Settings

    Member Visibility

    On This Page

    Properties
    +

    Settings

    Member Visibility

    On This Page

    Properties
    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 bb2634e564..11402cbd26 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,4 +1,4 @@ -WebViewProviderService | papi-dts

    InterfaceWebViewProviderService

    interface WebViewProviderService {
        getWebViewProvider: ((webViewType: string) => Promise<IRegisteredWebViewProvider | undefined>);
        initialize: (() => Promise<void>);
        postMessageToWebView: ((webViewId: string, webViewNonce: string, message: unknown, targetOrigin?: string) => Promise<void>);
        registerWebViewController: (<WebViewType>(webViewType: WebViewType, webViewId: string, webViewController: WebViewControllers[WebViewType]) => Promise<DisposableNetworkObject<WebViewControllers[WebViewType]>>);
        registerWebViewProvider: ((webViewType: string, webViewProvider: IWebViewProvider) => Promise<IDisposableWebViewProvider>);
    }

    Properties

    getWebViewProvider +WebViewProviderService | papi-dts

    InterfaceWebViewProviderService

    interface WebViewProviderService {
        getWebViewProvider: ((webViewType: string) => Promise<IRegisteredWebViewProvider | undefined>);
        initialize: (() => Promise<void>);
        postMessageToWebView: ((webViewId: string, webViewNonce: string, message: unknown, targetOrigin?: string) => Promise<void>);
        registerWebViewController: (<WebViewType>(webViewType: WebViewType, webViewId: string, webViewController: WebViewControllers[WebViewType]) => Promise<DisposableNetworkObject<WebViewControllers[WebViewType]>>);
        registerWebViewProvider: ((webViewType: string, webViewProvider: IWebViewProvider) => Promise<IDisposableWebViewProvider>);
    }

    Properties

    getWebViewProvider initialize postMessageToWebView registerWebViewController @@ -6,8 +6,8 @@

    Properties

    getWebViewProvider

    getWebViewProvider: ((webViewType: string) => Promise<IRegisteredWebViewProvider | undefined>)

    Type declaration

      • (webViewType): Promise<IRegisteredWebViewProvider | undefined>

      • Get a web view provider that has previously been set up

        Parameters

        • webViewType: string

          Type of webview provider to get

        Returns Promise<IRegisteredWebViewProvider | undefined>

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

        -

    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>

    postMessageToWebView

    postMessageToWebView: ((webViewId: string, webViewNonce: string, message: unknown, targetOrigin?: string) => Promise<void>)

    Type declaration

      • (webViewId, webViewNonce, message, targetOrigin?): Promise<void>

      • Sends a message to the specified web view. Expected to be used only by the +

    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>

    postMessageToWebView

    postMessageToWebView: ((webViewId: string, webViewNonce: string, message: unknown, targetOrigin?: string) => Promise<void>)

    Type declaration

      • (webViewId, webViewNonce, message, targetOrigin?): Promise<void>

      • Sends a message to the specified web view. Expected to be used only by the IWebViewProvider that created the web view or the WebViewControllers that represents the web view created by the Web View Provider.

        postMessage is used to @@ -24,7 +24,7 @@ targetOrigin for more information. Defaults to same origin only (works automatically with React and HTML web views)

        -

    Returns Promise<void>

    registerWebViewController

    registerWebViewController: (<WebViewType>(webViewType: WebViewType, webViewId: string, webViewController: WebViewControllers[WebViewType]) => Promise<DisposableNetworkObject<WebViewControllers[WebViewType]>>)

    Type declaration

    Returns Promise<void>

    registerWebViewController

    registerWebViewController: (<WebViewType>(webViewType: WebViewType, webViewId: string, webViewController: WebViewControllers[WebViewType]) => Promise<DisposableNetworkObject<WebViewControllers[WebViewType]>>)

    Type declaration

      • <WebViewType>(webViewType, webViewId, webViewController): Promise<DisposableNetworkObject<WebViewControllers[WebViewType]>>

      • Register a web view controller to represent a web view. It is expected that a web view provider calls this to register a web view controller for a web view that is being created. If a web view provider extends WebViewFactory, it will call this function automatically.

        A Web View Controller is a network object that represents a web view and whose methods facilitate @@ -37,10 +37,10 @@ is closed

        WARNING: setting a web view controller mutates the provided object.

    Returns Promise<DisposableNetworkObject<WebViewControllers[WebViewType]>>

    webViewController modified to be a network object

    -

    registerWebViewProvider

    registerWebViewProvider: ((webViewType: string, webViewProvider: IWebViewProvider) => Promise<IDisposableWebViewProvider>)

    Type declaration

      • (webViewType, webViewProvider): Promise<IDisposableWebViewProvider>

      • Register a web view provider to serve webViews for a specified type of webViews

        +

    registerWebViewProvider

    registerWebViewProvider: ((webViewType: string, webViewProvider: IWebViewProvider) => Promise<IDisposableWebViewProvider>)

    Type declaration

      • (webViewType, webViewProvider): Promise<IDisposableWebViewProvider>

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

        webViewProvider modified to be a network object and able to be disposed with dispose

        -

    Settings

    Member Visibility

    On This Page

    Properties
    +

    Settings

    Member Visibility

    On This Page

    Properties
    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 ab88c0c976..5579baf894 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

    InterfaceWebViewServiceType

    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: string, layout?: Layout, options?: GetWebViewOptions) => Promise<undefined | string>);
        onDidAddWebView: PlatformEvent<OpenWebViewEvent>;
        onDidCloseWebView: PlatformEvent<CloseWebViewEvent>;
        onDidOpenWebView: PlatformEvent<OpenWebViewEvent>;
        onDidUpdateWebView: PlatformEvent<UpdateWebViewEvent>;
        openWebView: ((webViewType: string, layout?: Layout, options?: GetWebViewOptions) => Promise<undefined | string>);
        getOpenWebViewDefinition(webViewId: string): Promise<undefined | SavedWebViewDefinition>;
        getSavedWebViewDefinition(webViewId: string): Promise<undefined | SavedWebViewDefinition>;
        getWebViewController<WebViewType>(webViewType: WebViewType, webViewId: string): Promise<undefined | NetworkObject<WebViewControllers[WebViewType]>>;
    }

    Properties

    getWebView +
    interface WebViewServiceType {
        getWebView: ((webViewType: string, layout?: Layout, options?: GetWebViewOptions) => Promise<undefined | string>);
        onDidAddWebView: PlatformEvent<OpenWebViewEvent>;
        onDidCloseWebView: PlatformEvent<CloseWebViewEvent>;
        onDidOpenWebView: PlatformEvent<OpenWebViewEvent>;
        onDidUpdateWebView: PlatformEvent<UpdateWebViewEvent>;
        openWebView: ((webViewType: string, layout?: Layout, options?: GetWebViewOptions) => Promise<undefined | string>);
        getOpenWebViewDefinition(webViewId: string): Promise<undefined | SavedWebViewDefinition>;
        getSavedWebViewDefinition(webViewId: string): Promise<undefined | SavedWebViewDefinition>;
        getWebViewController<WebViewType>(webViewType: WebViewType, webViewId: string): Promise<undefined | NetworkObject<WebViewControllers[WebViewType]>>;
    }

    Properties

    getWebView onDidAddWebView onDidCloseWebView onDidOpenWebView @@ -11,11 +11,11 @@ getSavedWebViewDefinition getWebViewController

    Properties

    getWebView

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

    Deprecated

    6 November 2024. Renamed to openWebView.

    -

    onDidAddWebView

    onDidAddWebView: PlatformEvent<OpenWebViewEvent>

    Deprecated

    13 November 2024. Renamed to onDidOpenWebView

    -

    onDidCloseWebView

    onDidCloseWebView: PlatformEvent<CloseWebViewEvent>

    Event that emits with webView info when a webView is closed

    -

    onDidOpenWebView

    onDidOpenWebView: PlatformEvent<OpenWebViewEvent>

    Event that emits with webView info when a webView is created

    -

    onDidUpdateWebView

    onDidUpdateWebView: PlatformEvent<UpdateWebViewEvent>

    Event that emits with webView info when a webView is updated

    -

    openWebView

    openWebView: ((webViewType: string, layout?: Layout, options?: GetWebViewOptions) => Promise<undefined | string>)

    Creates a new web view or gets an existing one depending on if you request an existing one and +

    onDidAddWebView

    onDidAddWebView: PlatformEvent<OpenWebViewEvent>

    Deprecated

    13 November 2024. Renamed to onDidOpenWebView

    +

    onDidCloseWebView

    onDidCloseWebView: PlatformEvent<CloseWebViewEvent>

    Event that emits with webView info when a webView is closed

    +

    onDidOpenWebView

    onDidOpenWebView: PlatformEvent<OpenWebViewEvent>

    Event that emits with webView info when a webView is created

    +

    onDidUpdateWebView

    onDidUpdateWebView: PlatformEvent<UpdateWebViewEvent>

    Event that emits with webView info when a webView is updated

    +

    openWebView

    openWebView: ((webViewType: string, layout?: Layout, options?: GetWebViewOptions) => 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).

    Type declaration

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

      • Parameters

        • webViewType: string

          Type of WebView to create

        • Optionallayout: Layout

          Information about where you want the web view to go. Defaults to adding as a tab

          @@ -24,7 +24,7 @@

        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

    -

    Methods

    getOpenWebViewDefinition

    • getOpenWebViewDefinition(webViewId): Promise<undefined | SavedWebViewDefinition>

    • Gets the saved properties on the WebView definition with the specified ID

      +

    Methods

    getOpenWebViewDefinition

    • getOpenWebViewDefinition(webViewId): Promise<undefined | SavedWebViewDefinition>

    • Gets the saved properties on the WebView definition with the specified ID

      Note: this only returns a representation of the current web view definition, not the actual web view definition itself. Changing properties on the returned definition does not affect the actual web view definition. You can possibly change the actual web view definition by calling @@ -33,8 +33,8 @@

      Parameters

      • webViewId: string

        The ID of the WebView whose saved properties to get

      Returns Promise<undefined | SavedWebViewDefinition>

      Saved properties of the WebView definition with the specified ID or undefined if not found

      -

    getSavedWebViewDefinition

    getWebViewController

    getSavedWebViewDefinition

    getWebViewController

    • getWebViewController<WebViewType>(webViewType, webViewId): Promise<undefined | NetworkObject<WebViewControllers[WebViewType]>>

    • Get an existing web view controller for an open web view.

      A Web View Controller is a network object that represents a web view and whose methods facilitate communication between its associated web view and extensions that want to interact with it.

      @@ -44,4 +44,4 @@
    • webViewId: string

      Id of web view for which to get the corresponding web view controller if one exists

    Returns Promise<undefined | NetworkObject<WebViewControllers[WebViewType]>>

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

    -

    Settings

    Member Visibility

    On This Page

    Properties
    Methods
    +

    Settings

    Member Visibility

    On This Page

    Properties
    Methods
    diff --git a/papi-dts/modules/__papi_backend_.html b/papi-dts/modules/__papi_backend_.html index ac1f27551a..15ade64402 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

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

    Namespace"@papi/backend"

    Index

    Variables

    BaseProjectDataProviderEngine commands DataProviderEngine dataProviders diff --git a/papi-dts/modules/__papi_core_.html b/papi-dts/modules/__papi_core_.html index 2c10d6425b..14259d8d6c 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 cf6ac0d12d..46fa5d4f0a 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

    commands dataProviders default diff --git a/papi-dts/modules/__papi_frontend_react_.html b/papi-dts/modules/__papi_frontend_react_.html index 8fec9630f8..76f339910a 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_rpc_client_.html b/papi-dts/modules/_client_services_rpc_client_.html index 3537675755..72c0d0a58d 100644 --- a/papi-dts/modules/_client_services_rpc_client_.html +++ b/papi-dts/modules/_client_services_rpc_client_.html @@ -1,2 +1,2 @@ -"client/services/rpc-client" | papi-dts

    Namespace"client/services/rpc-client"

    Index

    Classes

    default +"client/services/rpc-client" | papi-dts

    Namespace"client/services/rpc-client"

    Index

    Classes

    default

    Settings

    Member Visibility
    diff --git a/papi-dts/modules/_client_services_web_socket_factory_.html b/papi-dts/modules/_client_services_web_socket_factory_.html index 0d713bfb6e..38cebe7d0f 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
    diff --git a/papi-dts/modules/_client_services_web_socket_interface_.html b/papi-dts/modules/_client_services_web_socket_interface_.html index b808ba4961..8f76d985be 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
    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 119b93b6ad..a4e376cda7 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
    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 1e98b054ee..a26fba0a8e 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
    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 227740a8be..a57078aa88 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
    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 ade100965d..da071e348f 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
    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 0963c82ea1..d431b9234c 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_rpc_server_.html b/papi-dts/modules/_main_services_rpc_server_.html index 53c4d6259f..edc7ef83c7 100644 --- a/papi-dts/modules/_main_services_rpc_server_.html +++ b/papi-dts/modules/_main_services_rpc_server_.html @@ -1,3 +1,3 @@ -"main/services/rpc-server" | papi-dts

    Namespace"main/services/rpc-server"

    Index

    Classes

    default +"main/services/rpc-server" | papi-dts

    Namespace"main/services/rpc-server"

    Index

    Classes

    default

    Type Aliases

    PropagateEventMethod

    Settings

    Member Visibility
    diff --git a/papi-dts/modules/_main_services_rpc_websocket_listener_.html b/papi-dts/modules/_main_services_rpc_websocket_listener_.html index a2283951e8..8fb4cb14c8 100644 --- a/papi-dts/modules/_main_services_rpc_websocket_listener_.html +++ b/papi-dts/modules/_main_services_rpc_websocket_listener_.html @@ -1,2 +1,2 @@ -"main/services/rpc-websocket-listener" | papi-dts

    Namespace"main/services/rpc-websocket-listener"

    Index

    Classes

    default +"main/services/rpc-websocket-listener" | papi-dts

    Namespace"main/services/rpc-websocket-listener"

    Index

    Classes

    default

    Settings

    Member Visibility
    diff --git a/papi-dts/modules/_node_models_execution_token_model_.html b/papi-dts/modules/_node_models_execution_token_model_.html index d8192f0b9f..8a125dc4fc 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
    diff --git a/papi-dts/modules/_node_services_execution_token_service_.html b/papi-dts/modules/_node_services_execution_token_service_.html index 4ec8f31ca5..4b5659e326 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
    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 279b0b9a53..b9e087e08a 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 f95f445167..23b947d54e 100644 --- a/papi-dts/modules/_node_utils_crypto_util_.html +++ b/papi-dts/modules/_node_utils_crypto_util_.html @@ -1,4 +1,4 @@ -"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 generateHashFromBuffer

    Settings

    Member Visibility
    diff --git a/papi-dts/modules/_node_utils_util_.html b/papi-dts/modules/_node_utils_util_.html index 3bc628f995..a5506b6435 100644 --- a/papi-dts/modules/_node_utils_util_.html +++ b/papi-dts/modules/_node_utils_util_.html @@ -1,4 +1,4 @@ -"node/utils/util" | papi-dts

    Namespace"node/utils/util"

    Index

    Variables

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

    Namespace"node/utils/util"

    Index

    Variables

    FILE_PROTOCOL RESOURCES_PROTOCOL

    Functions

    getAppDir getPathFromUri diff --git a/papi-dts/modules/_papi_shared_types_.html b/papi-dts/modules/_papi_shared_types_.html index 2d844c9e8c..31fbd79109 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 ProjectDataProviderInterfaces ProjectSettingTypes diff --git a/papi-dts/modules/_renderer_components_dialogs_dialog_base_data_.html b/papi-dts/modules/_renderer_components_dialogs_dialog_base_data_.html index e1464a5d7a..4664e5b7a5 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 16ce6b2e89..2396f93893 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 1f438b022b..9fcbd8b3de 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
    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 8c3389afca..882bab92ff 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
    diff --git a/papi-dts/modules/_renderer_hooks_papi_hooks_index_.html b/papi-dts/modules/_renderer_hooks_papi_hooks_index_.html index 1f9e6c71ad..2cb8d63082 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 64cf659806..2a380164ee 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
    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 700e789632..a11c651182 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
    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 0df9e1a297..cc1a03a619 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
    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 bb1729f802..a922e279ce 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
    diff --git a/papi-dts/modules/_renderer_hooks_papi_hooks_use_localized_strings_hook_.html b/papi-dts/modules/_renderer_hooks_papi_hooks_use_localized_strings_hook_.html index 2c17776984..2d0f1ba8f9 100644 --- a/papi-dts/modules/_renderer_hooks_papi_hooks_use_localized_strings_hook_.html +++ b/papi-dts/modules/_renderer_hooks_papi_hooks_use_localized_strings_hook_.html @@ -1,2 +1,2 @@ -"renderer/hooks/papi-hooks/use-localized-strings-hook" | papi-dts

    Namespace"renderer/hooks/papi-hooks/use-localized-strings-hook"

    Index

    Functions

    default +"renderer/hooks/papi-hooks/use-localized-strings-hook" | papi-dts

    Namespace"renderer/hooks/papi-hooks/use-localized-strings-hook"

    Index

    Functions

    default

    Settings

    Member Visibility
    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 37e31ea96c..2cd2e78210 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
    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 763226382e..792ea86b3d 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
    diff --git a/papi-dts/modules/_renderer_hooks_papi_hooks_use_project_setting_hook_.html b/papi-dts/modules/_renderer_hooks_papi_hooks_use_project_setting_hook_.html index 7340b98609..373e9c2e17 100644 --- a/papi-dts/modules/_renderer_hooks_papi_hooks_use_project_setting_hook_.html +++ b/papi-dts/modules/_renderer_hooks_papi_hooks_use_project_setting_hook_.html @@ -1,2 +1,2 @@ -"renderer/hooks/papi-hooks/use-project-setting.hook" | papi-dts

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

    Index

    Functions

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

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

    Index

    Functions

    default

    Settings

    Member Visibility
    diff --git a/papi-dts/modules/_renderer_hooks_papi_hooks_use_scroll_group_scr_ref_hook_.html b/papi-dts/modules/_renderer_hooks_papi_hooks_use_scroll_group_scr_ref_hook_.html index 4fa653714f..c0a67efa03 100644 --- a/papi-dts/modules/_renderer_hooks_papi_hooks_use_scroll_group_scr_ref_hook_.html +++ b/papi-dts/modules/_renderer_hooks_papi_hooks_use_scroll_group_scr_ref_hook_.html @@ -1,2 +1,2 @@ -"renderer/hooks/papi-hooks/use-scroll-group-scr-ref.hook" | papi-dts

    Namespace"renderer/hooks/papi-hooks/use-scroll-group-scr-ref.hook"

    Index

    Functions

    default +"renderer/hooks/papi-hooks/use-scroll-group-scr-ref.hook" | papi-dts

    Namespace"renderer/hooks/papi-hooks/use-scroll-group-scr-ref.hook"

    Index

    Functions

    default

    Settings

    Member Visibility
    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 810802d9cd..8729ea3fae 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
    diff --git a/papi-dts/modules/_renderer_hooks_papi_hooks_use_web_view_controller_hook_.html b/papi-dts/modules/_renderer_hooks_papi_hooks_use_web_view_controller_hook_.html index fde161790d..ab7b7a26ba 100644 --- a/papi-dts/modules/_renderer_hooks_papi_hooks_use_web_view_controller_hook_.html +++ b/papi-dts/modules/_renderer_hooks_papi_hooks_use_web_view_controller_hook_.html @@ -1,2 +1,2 @@ -"renderer/hooks/papi-hooks/use-web-view-controller.hook" | papi-dts

    Namespace"renderer/hooks/papi-hooks/use-web-view-controller.hook"

    Index

    Functions

    default +"renderer/hooks/papi-hooks/use-web-view-controller.hook" | papi-dts

    Namespace"renderer/hooks/papi-hooks/use-web-view-controller.hook"

    Index

    Functions

    default

    Settings

    Member Visibility
    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 68bba68828..eb34663510 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
    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 d08f1c5a3e..65daf3810c 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
    diff --git a/papi-dts/modules/_renderer_services_scroll_group_service_host_.html b/papi-dts/modules/_renderer_services_scroll_group_service_host_.html index c5f7517801..49cefe374a 100644 --- a/papi-dts/modules/_renderer_services_scroll_group_service_host_.html +++ b/papi-dts/modules/_renderer_services_scroll_group_service_host_.html @@ -1,4 +1,4 @@ -"renderer/services/scroll-group.service-host" | papi-dts

    Namespace"renderer/services/scroll-group.service-host"

    Index

    Variables

    availableScrollGroupIds +"renderer/services/scroll-group.service-host" | papi-dts

    Namespace"renderer/services/scroll-group.service-host"

    Index

    Variables

    availableScrollGroupIds

    Functions

    getScrRefSync onDidUpdateScrRef setScrRefSync diff --git a/papi-dts/modules/_shared_data_file_system_model_.html b/papi-dts/modules/_shared_data_file_system_model_.html index 9bc46c3bf1..7e7583579c 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
    diff --git a/papi-dts/modules/_shared_data_platform_data_.html b/papi-dts/modules/_shared_data_platform_data_.html index b3360277cb..4542309bc8 100644 --- a/papi-dts/modules/_shared_data_platform_data_.html +++ b/papi-dts/modules/_shared_data_platform_data_.html @@ -1,3 +1,3 @@ -"shared/data/platform.data" | papi-dts

    Namespace"shared/data/platform.data"

    Index

    Variables

    DEV_MODE_RENDERER_INDICATOR +"shared/data/platform.data" | papi-dts

    Namespace"shared/data/platform.data"

    Index

    Variables

    DEV_MODE_RENDERER_INDICATOR PLATFORM_NAMESPACE

    Settings

    Member Visibility
    diff --git a/papi-dts/modules/_shared_data_rpc_model_.html b/papi-dts/modules/_shared_data_rpc_model_.html index fcf9279e48..b0810eb7cd 100644 --- a/papi-dts/modules/_shared_data_rpc_model_.html +++ b/papi-dts/modules/_shared_data_rpc_model_.html @@ -1,4 +1,4 @@ -"shared/data/rpc.model" | papi-dts

    Namespace"shared/data/rpc.model"

    Index

    Enumerations

    ConnectionStatus +"shared/data/rpc.model" | papi-dts

    Namespace"shared/data/rpc.model"

    Index

    Enumerations

    ConnectionStatus

    Type Aliases

    EventHandler InternalRequestHandler RequestId diff --git a/papi-dts/modules/_shared_global_this_model_.html b/papi-dts/modules/_shared_global_this_model_.html index 42903366da..0a2f1d2efa 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
    diff --git a/papi-dts/modules/_shared_log_error_model_.html b/papi-dts/modules/_shared_log_error_model_.html index 43d55f9758..a589768aa9 100644 --- a/papi-dts/modules/_shared_log_error_model_.html +++ b/papi-dts/modules/_shared_log_error_model_.html @@ -1,2 +1,2 @@ -"shared/log-error.model" | papi-dts

    Namespace"shared/log-error.model"

    Index

    Classes

    default +"shared/log-error.model" | papi-dts

    Namespace"shared/log-error.model"

    Index

    Classes

    default

    Settings

    Member Visibility
    diff --git a/papi-dts/modules/_shared_models_base_project_data_provider_engine_model_.html b/papi-dts/modules/_shared_models_base_project_data_provider_engine_model_.html index c5831b88cc..07deda2ae4 100644 --- a/papi-dts/modules/_shared_models_base_project_data_provider_engine_model_.html +++ b/papi-dts/modules/_shared_models_base_project_data_provider_engine_model_.html @@ -1,3 +1,3 @@ -"shared/models/base-project-data-provider-engine.model" | papi-dts

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

    Index

    Classes

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

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

    Index

    Classes

    BaseProjectDataProviderEngine

    Type Aliases

    IBaseProjectDataProviderEngine

    Settings

    Member Visibility
    diff --git a/papi-dts/modules/_shared_models_create_process_privilege_model_.html b/papi-dts/modules/_shared_models_create_process_privilege_model_.html index 8e66db1d57..bf1ea4978a 100644 --- a/papi-dts/modules/_shared_models_create_process_privilege_model_.html +++ b/papi-dts/modules/_shared_models_create_process_privilege_model_.html @@ -1,4 +1,4 @@ -"shared/models/create-process-privilege.model" | papi-dts

    Namespace"shared/models/create-process-privilege.model"

    Index

    Type Aliases

    CreateProcess +"shared/models/create-process-privilege.model" | papi-dts

    Namespace"shared/models/create-process-privilege.model"

    Index

    Type Aliases

    CreateProcess OperatingSystemData PlatformFork PlatformSpawn 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 a3ba112692..4a7c2d3371 100644 --- a/papi-dts/modules/_shared_models_data_provider_engine_model_.html +++ b/papi-dts/modules/_shared_models_data_provider_engine_model_.html @@ -1,4 +1,4 @@ -"shared/models/data-provider-engine.model" | papi-dts

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

    Index

    Classes

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

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

    Index

    Classes

    DataProviderEngine

    Type Aliases

    DataProviderEngineNotifyUpdate default WithNotifyUpdate diff --git a/papi-dts/modules/_shared_models_data_provider_interface_.html b/papi-dts/modules/_shared_models_data_provider_interface_.html index ea5c1593fa..48cfdbe28e 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

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

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

    Index

    Type Aliases

    default IDisposableDataProvider

    Settings

    Member Visibility
    diff --git a/papi-dts/modules/_shared_models_data_provider_model_.html b/papi-dts/modules/_shared_models_data_provider_model_.html index 5d5b33b18f..2ff759b0f2 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 c3c68e6735..3805c5d6e8 100644 --- a/papi-dts/modules/_shared_models_dialog_options_model_.html +++ b/papi-dts/modules/_shared_models_dialog_options_model_.html @@ -1,4 +1,4 @@ -"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

    Variables

    DIALOG_OPTIONS_LOCALIZABLE_PROPERTY_KEYS

    Settings

    Member Visibility
    diff --git a/papi-dts/modules/_shared_models_docking_framework_model_.html b/papi-dts/modules/_shared_models_docking_framework_model_.html index 9f2f621976..a6b4039388 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

    FloatPosition diff --git a/papi-dts/modules/_shared_models_elevated_privileges_model_.html b/papi-dts/modules/_shared_models_elevated_privileges_model_.html index 98601d21f8..a54b07602e 100644 --- a/papi-dts/modules/_shared_models_elevated_privileges_model_.html +++ b/papi-dts/modules/_shared_models_elevated_privileges_model_.html @@ -1,3 +1,3 @@ -"shared/models/elevated-privileges.model" | papi-dts

    Namespace"shared/models/elevated-privileges.model"

    Index

    Enumerations

    ElevatedPrivilegeNames +"shared/models/elevated-privileges.model" | papi-dts

    Namespace"shared/models/elevated-privileges.model"

    Index

    Enumerations

    ElevatedPrivilegeNames

    Type Aliases

    ElevatedPrivileges

    Settings

    Member Visibility
    diff --git a/papi-dts/modules/_shared_models_extension_basic_data_model_.html b/papi-dts/modules/_shared_models_extension_basic_data_model_.html index c3ddb454bb..587a3069cc 100644 --- a/papi-dts/modules/_shared_models_extension_basic_data_model_.html +++ b/papi-dts/modules/_shared_models_extension_basic_data_model_.html @@ -1,2 +1,2 @@ -"shared/models/extension-basic-data.model" | papi-dts

    Namespace"shared/models/extension-basic-data.model"

    Index

    Type Aliases

    ExtensionBasicData +"shared/models/extension-basic-data.model" | papi-dts

    Namespace"shared/models/extension-basic-data.model"

    Index

    Type Aliases

    ExtensionBasicData

    Settings

    Member Visibility
    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 d7dad72e5c..a5c6e7974a 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
    diff --git a/papi-dts/modules/_shared_models_manage_extensions_privilege_model_.html b/papi-dts/modules/_shared_models_manage_extensions_privilege_model_.html index 494a278b1f..d66808b29b 100644 --- a/papi-dts/modules/_shared_models_manage_extensions_privilege_model_.html +++ b/papi-dts/modules/_shared_models_manage_extensions_privilege_model_.html @@ -1,4 +1,4 @@ -"shared/models/manage-extensions-privilege.model" | papi-dts

    Namespace"shared/models/manage-extensions-privilege.model"

    Index

    Type Aliases

    DisableExtensionFunction +"shared/models/manage-extensions-privilege.model" | papi-dts

    Namespace"shared/models/manage-extensions-privilege.model"

    Index

    Type Aliases

    DisableExtensionFunction EnableExtensionFunction ExtensionIdentifier GetInstalledExtensionsFunction diff --git a/papi-dts/modules/_shared_models_network_object_model_.html b/papi-dts/modules/_shared_models_network_object_model_.html index 467b223255..c7569b188f 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 NetworkableObject NetworkObject diff --git a/papi-dts/modules/_shared_models_network_object_status_service_model_.html b/papi-dts/modules/_shared_models_network_object_status_service_model_.html index 430889855c..e886d574d0 100644 --- a/papi-dts/modules/_shared_models_network_object_status_service_model_.html +++ b/papi-dts/modules/_shared_models_network_object_status_service_model_.html @@ -1,4 +1,4 @@ -"shared/models/network-object-status.service-model" | papi-dts

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

    Index

    Interfaces

    NetworkObjectStatusRemoteServiceType +"shared/models/network-object-status.service-model" | papi-dts

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

    Index

    Interfaces

    NetworkObjectStatusRemoteServiceType NetworkObjectStatusServiceType

    Variables

    networkObjectStatusServiceNetworkObjectName

    Settings

    Member Visibility
    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 c952ab3928..9c3ed95261 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
    diff --git a/papi-dts/modules/_shared_models_project_data_provider_engine_factory_model_.html b/papi-dts/modules/_shared_models_project_data_provider_engine_factory_model_.html index 2d766b70fa..562a998108 100644 --- a/papi-dts/modules/_shared_models_project_data_provider_engine_factory_model_.html +++ b/papi-dts/modules/_shared_models_project_data_provider_engine_factory_model_.html @@ -1,3 +1,3 @@ -"shared/models/project-data-provider-engine-factory.model" | papi-dts

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

    Index

    Classes

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

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

    Index

    Classes

    LayeringProjectDataProviderEngineFactory

    Interfaces

    IProjectDataProviderEngineFactory

    Settings

    Member Visibility
    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 a7f30de309..e560653f1d 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

    Classes

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

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

    Index

    Classes

    ProjectDataProviderEngine

    Type Aliases

    IProjectDataProviderEngine

    Settings

    Member Visibility
    diff --git a/papi-dts/modules/_shared_models_project_data_provider_factory_interface_.html b/papi-dts/modules/_shared_models_project_data_provider_factory_interface_.html index 6b93031a4f..35e28e6c47 100644 --- a/papi-dts/modules/_shared_models_project_data_provider_factory_interface_.html +++ b/papi-dts/modules/_shared_models_project_data_provider_factory_interface_.html @@ -1,4 +1,4 @@ -"shared/models/project-data-provider-factory.interface" | papi-dts

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

    Index

    Interfaces

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

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

    Index

    Interfaces

    default

    Type Aliases

    ProjectMetadataFilterOptions

    Variables

    PDP_FACTORY_OBJECT_TYPE

    Settings

    Member Visibility
    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 697dabb8be..6322db9e0b 100644 --- a/papi-dts/modules/_shared_models_project_data_provider_model_.html +++ b/papi-dts/modules/_shared_models_project_data_provider_model_.html @@ -1,4 +1,4 @@ -"shared/models/project-data-provider.model" | papi-dts

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

    Index

    Type Aliases

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

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

    Index

    Type Aliases

    ExtensionDataScope MandatoryProjectDataTypes WithProjectDataProviderEngineExtensionDataMethods

    Variables

    PROJECT_INTERFACE_PLATFORM_BASE diff --git a/papi-dts/modules/_shared_models_project_lookup_service_model_.html b/papi-dts/modules/_shared_models_project_lookup_service_model_.html index 36e37a7c2f..c6a76cb9f0 100644 --- a/papi-dts/modules/_shared_models_project_lookup_service_model_.html +++ b/papi-dts/modules/_shared_models_project_lookup_service_model_.html @@ -1,4 +1,4 @@ -"shared/models/project-lookup.service-model" | papi-dts

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

    Index

    Type Aliases

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

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

    Index

    Type Aliases

    ProjectLookupServiceType

    Variables

    NETWORK_OBJECT_NAME_PROJECT_LOOKUP_SERVICE projectLookupServiceBase testingProjectLookupService diff --git a/papi-dts/modules/_shared_models_project_metadata_model_.html b/papi-dts/modules/_shared_models_project_metadata_model_.html index 17f9ba6f19..32d46fc4c9 100644 --- a/papi-dts/modules/_shared_models_project_metadata_model_.html +++ b/papi-dts/modules/_shared_models_project_metadata_model_.html @@ -1,4 +1,4 @@ -"shared/models/project-metadata.model" | papi-dts

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

    Index

    Type Aliases

    ProjectDataProviderFactoryMetadataInfo +"shared/models/project-metadata.model" | papi-dts

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

    Index

    Type Aliases

    ProjectDataProviderFactoryMetadataInfo ProjectMetadata ProjectMetadataWithoutFactoryInfo

    Settings

    Member Visibility
    diff --git a/papi-dts/modules/_shared_models_rpc_interface_.html b/papi-dts/modules/_shared_models_rpc_interface_.html index 21a07e20dc..be1cbdcc43 100644 --- a/papi-dts/modules/_shared_models_rpc_interface_.html +++ b/papi-dts/modules/_shared_models_rpc_interface_.html @@ -1,3 +1,3 @@ -"shared/models/rpc.interface" | papi-dts

    Namespace"shared/models/rpc.interface"

    Index

    Interfaces

    IRpcHandler +"shared/models/rpc.interface" | papi-dts

    Namespace"shared/models/rpc.interface"

    Index

    Interfaces

    IRpcHandler IRpcMethodRegistrar

    Settings

    Member Visibility
    diff --git a/papi-dts/modules/_shared_models_web_view_factory_model_.html b/papi-dts/modules/_shared_models_web_view_factory_model_.html index efd7a125a0..e22d2a7b2b 100644 --- a/papi-dts/modules/_shared_models_web_view_factory_model_.html +++ b/papi-dts/modules/_shared_models_web_view_factory_model_.html @@ -1,2 +1,2 @@ -"shared/models/web-view-factory.model" | papi-dts

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

    Index

    Classes

    WebViewFactory +"shared/models/web-view-factory.model" | papi-dts

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

    Index

    Classes

    WebViewFactory

    Settings

    Member Visibility
    diff --git a/papi-dts/modules/_shared_models_web_view_model_.html b/papi-dts/modules/_shared_models_web_view_model_.html index d96ced7366..33f47fdc99 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

    GetSavedWebViewDefinition 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 93c0f86796..1e240842a4 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

    IDisposableWebViewProvider +"shared/models/web-view-provider.model" | papi-dts

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

    Index

    Interfaces

    IDisposableWebViewProvider IRegisteredWebViewProvider IWebViewProvider

    Settings

    Member Visibility
    diff --git a/papi-dts/modules/_shared_services_command_service_.html b/papi-dts/modules/_shared_services_command_service_.html index c10d4dd02f..31f061d1b2 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

    createSendCommandFunction registerCommand sendCommand diff --git a/papi-dts/modules/_shared_services_data_provider_service_.html b/papi-dts/modules/_shared_services_data_provider_service_.html index 7c40319193..1128251e02 100644 --- a/papi-dts/modules/_shared_services_data_provider_service_.html +++ b/papi-dts/modules/_shared_services_data_provider_service_.html @@ -1,4 +1,4 @@ -"shared/services/data-provider.service" | papi-dts

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

    Index

    Interfaces

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

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

    Index

    Interfaces

    DataProviderService

    Variables

    default

    Functions

    getByType registerEngineByType diff --git a/papi-dts/modules/_shared_services_dialog_service_.html b/papi-dts/modules/_shared_services_dialog_service_.html index bbb5e545af..b6a2ac8109 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
    diff --git a/papi-dts/modules/_shared_services_dialog_service_model_.html b/papi-dts/modules/_shared_services_dialog_service_model_.html index 066fbe285c..dea1a9aec0 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
    diff --git a/papi-dts/modules/_shared_services_internet_service_.html b/papi-dts/modules/_shared_services_internet_service_.html index 9b1e8ea97b..cd8f6e1a84 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
    diff --git a/papi-dts/modules/_shared_services_localization_service_.html b/papi-dts/modules/_shared_services_localization_service_.html index 6de5f307cc..1f7f23dfc4 100644 --- a/papi-dts/modules/_shared_services_localization_service_.html +++ b/papi-dts/modules/_shared_services_localization_service_.html @@ -1,2 +1,2 @@ -"shared/services/localization.service" | papi-dts

    Namespace"shared/services/localization.service"

    Index

    Variables

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

    Namespace"shared/services/localization.service"

    Index

    Variables

    default

    Settings

    Member Visibility
    diff --git a/papi-dts/modules/_shared_services_localization_service_model_.html b/papi-dts/modules/_shared_services_localization_service_model_.html index c7fd017951..2d6974de84 100644 --- a/papi-dts/modules/_shared_services_localization_service_model_.html +++ b/papi-dts/modules/_shared_services_localization_service_model_.html @@ -1,4 +1,4 @@ -"shared/services/localization.service-model" | papi-dts

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

    Index

    Type Aliases

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

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

    Index

    Type Aliases

    ILocalizationService LocalizationData LocalizationDataDataTypes LocalizationSelector diff --git a/papi-dts/modules/_shared_services_logger_service_.html b/papi-dts/modules/_shared_services_logger_service_.html index 5abf7ca55c..88ebf224d9 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

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

    Namespace"shared/services/logger.service"

    Index

    Variables

    default WARN_TAG

    Functions

    formatLog

    Settings

    Member Visibility
    diff --git a/papi-dts/modules/_shared_services_menu_data_service_.html b/papi-dts/modules/_shared_services_menu_data_service_.html index f0f2c935f2..f08e437a87 100644 --- a/papi-dts/modules/_shared_services_menu_data_service_.html +++ b/papi-dts/modules/_shared_services_menu_data_service_.html @@ -1,2 +1,2 @@ -"shared/services/menu-data.service" | papi-dts

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

    Index

    Variables

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

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

    Index

    Variables

    default

    Settings

    Member Visibility
    diff --git a/papi-dts/modules/_shared_services_menu_data_service_model_.html b/papi-dts/modules/_shared_services_menu_data_service_model_.html index ff6e976ce4..03cc399b25 100644 --- a/papi-dts/modules/_shared_services_menu_data_service_model_.html +++ b/papi-dts/modules/_shared_services_menu_data_service_model_.html @@ -1,4 +1,4 @@ -"shared/services/menu-data.service-model" | papi-dts

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

    Index

    Type Aliases

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

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

    Index

    Type Aliases

    IMenuDataService MenuDataDataTypes

    Variables

    menuDataServiceObjectToProxy menuDataServiceProviderName diff --git a/papi-dts/modules/_shared_services_network_object_service_.html b/papi-dts/modules/_shared_services_network_object_service_.html index fd045517b4..ecb4115207 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

    Interfaces

    MinimalNetworkObjectService +"shared/services/network-object.service" | papi-dts

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

    Index

    Interfaces

    MinimalNetworkObjectService NetworkObjectService

    Variables

    default minimalNetworkObjectService 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 6442f0451c..9c74735793 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
    diff --git a/papi-dts/modules/_shared_services_network_service_.html b/papi-dts/modules/_shared_services_network_service_.html index 698697e4e4..d08ae79526 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

    Variables

    papiNetworkService

    Functions

    createNetworkEventEmitter createRequestFunction 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 0cc817774d..6cfa4a1ea7 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 22be481332..621e32364a 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
    diff --git a/papi-dts/modules/_shared_services_project_settings_service_.html b/papi-dts/modules/_shared_services_project_settings_service_.html index 5ce2e4c189..a6d8f1d034 100644 --- a/papi-dts/modules/_shared_services_project_settings_service_.html +++ b/papi-dts/modules/_shared_services_project_settings_service_.html @@ -1,3 +1,3 @@ -"shared/services/project-settings.service" | papi-dts

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

    Index

    Variables

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

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

    Index

    Variables

    default

    Functions

    filterProjectSettingsContributionsByProjectInterfaces

    Settings

    Member Visibility
    diff --git a/papi-dts/modules/_shared_services_project_settings_service_model_.html b/papi-dts/modules/_shared_services_project_settings_service_model_.html index 75205c1fd1..5afd560a34 100644 --- a/papi-dts/modules/_shared_services_project_settings_service_model_.html +++ b/papi-dts/modules/_shared_services_project_settings_service_model_.html @@ -1,4 +1,4 @@ -"shared/services/project-settings.service-model" | papi-dts

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

    Index

    Interfaces

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

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

    Index

    Interfaces

    IProjectSettingsService

    Type Aliases

    AllProjectSettingsValidators ProjectSettingValidator SimultaneousProjectSettingsChanges diff --git a/papi-dts/modules/_shared_services_rpc_handler_factory_.html b/papi-dts/modules/_shared_services_rpc_handler_factory_.html index 05b9f681a6..b254c7a866 100644 --- a/papi-dts/modules/_shared_services_rpc_handler_factory_.html +++ b/papi-dts/modules/_shared_services_rpc_handler_factory_.html @@ -1,2 +1,2 @@ -"shared/services/rpc-handler.factory" | papi-dts

    Namespace"shared/services/rpc-handler.factory"

    Index

    Functions

    createRpcHandler +"shared/services/rpc-handler.factory" | papi-dts

    Namespace"shared/services/rpc-handler.factory"

    Index

    Functions

    createRpcHandler

    Settings

    Member Visibility
    diff --git a/papi-dts/modules/_shared_services_scroll_group_service_.html b/papi-dts/modules/_shared_services_scroll_group_service_.html index 8dca287518..eecb75d180 100644 --- a/papi-dts/modules/_shared_services_scroll_group_service_.html +++ b/papi-dts/modules/_shared_services_scroll_group_service_.html @@ -1,2 +1,2 @@ -"shared/services/scroll-group.service" | papi-dts

    Namespace"shared/services/scroll-group.service"

    Index

    Variables

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

    Namespace"shared/services/scroll-group.service"

    Index

    Variables

    default

    Settings

    Member Visibility
    diff --git a/papi-dts/modules/_shared_services_scroll_group_service_model_.html b/papi-dts/modules/_shared_services_scroll_group_service_model_.html index 3fe0db24e8..d6659927fb 100644 --- a/papi-dts/modules/_shared_services_scroll_group_service_model_.html +++ b/papi-dts/modules/_shared_services_scroll_group_service_model_.html @@ -1,4 +1,4 @@ -"shared/services/scroll-group.service-model" | papi-dts

    Namespace"shared/services/scroll-group.service-model"

    Index

    Interfaces

    IScrollGroupRemoteService +"shared/services/scroll-group.service-model" | papi-dts

    Namespace"shared/services/scroll-group.service-model"

    Index

    Interfaces

    IScrollGroupRemoteService IScrollGroupService

    Type Aliases

    ScrollGroupScrRef ScrollGroupUpdateInfo diff --git a/papi-dts/modules/_shared_services_settings_service_.html b/papi-dts/modules/_shared_services_settings_service_.html index e507d7bdfe..16f279b54f 100644 --- a/papi-dts/modules/_shared_services_settings_service_.html +++ b/papi-dts/modules/_shared_services_settings_service_.html @@ -1,2 +1,2 @@ -"shared/services/settings.service" | papi-dts

    Namespace"shared/services/settings.service"

    Index

    Variables

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

    Namespace"shared/services/settings.service"

    Index

    Variables

    default

    Settings

    Member Visibility
    diff --git a/papi-dts/modules/_shared_services_settings_service_model_.html b/papi-dts/modules/_shared_services_settings_service_model_.html index 9837d10037..f7f0eb0b04 100644 --- a/papi-dts/modules/_shared_services_settings_service_model_.html +++ b/papi-dts/modules/_shared_services_settings_service_model_.html @@ -1,4 +1,4 @@ -"shared/services/settings.service-model" | papi-dts

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

    Index

    Type Aliases

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

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

    Index

    Type Aliases

    AllSettingsData AllSettingsValidators ISettingsService SettingDataTypes diff --git a/papi-dts/modules/_shared_services_web_view_provider_service_.html b/papi-dts/modules/_shared_services_web_view_provider_service_.html index c008e95155..b68a361dc6 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 31c07d07cb..d2e73b5ec2 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
    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 043425a068..32ab706fa7 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

    Type Aliases

    CloseWebViewEvent OpenWebViewEvent UpdateWebViewEvent diff --git a/papi-dts/modules/_shared_utils_internal_util_.html b/papi-dts/modules/_shared_utils_internal_util_.html index 97019a5080..223561e630 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_project_settings_document_combiner_.html b/papi-dts/modules/_shared_utils_project_settings_document_combiner_.html index f2195d216d..8faea0978a 100644 --- a/papi-dts/modules/_shared_utils_project_settings_document_combiner_.html +++ b/papi-dts/modules/_shared_utils_project_settings_document_combiner_.html @@ -1,4 +1,4 @@ -"shared/utils/project-settings-document-combiner" | papi-dts

    Namespace"shared/utils/project-settings-document-combiner"

    Index

    Classes

    default +"shared/utils/project-settings-document-combiner" | papi-dts

    Namespace"shared/utils/project-settings-document-combiner"

    Index

    Classes

    default

    Type Aliases

    AllProjectSettingsInfo LocalizedProjectSettingsContributionInfo ProjectSettingInfo diff --git a/papi-dts/modules/_shared_utils_settings_document_combiner_base_.html b/papi-dts/modules/_shared_utils_settings_document_combiner_base_.html index 37afa0d45c..eda86734fd 100644 --- a/papi-dts/modules/_shared_utils_settings_document_combiner_base_.html +++ b/papi-dts/modules/_shared_utils_settings_document_combiner_base_.html @@ -1,4 +1,4 @@ -"shared/utils/settings-document-combiner-base" | papi-dts

    Namespace"shared/utils/settings-document-combiner-base"

    Index

    Classes

    default +"shared/utils/settings-document-combiner-base" | papi-dts

    Namespace"shared/utils/settings-document-combiner-base"

    Index

    Classes

    default

    Type Aliases

    AllSettingsInfo LocalizedSettingsContributionInfo SettingInfo diff --git a/papi-dts/modules/_shared_utils_util_.html b/papi-dts/modules/_shared_utils_util_.html index 17b3b484e1..494cdcf0b1 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

    Type Aliases

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

    Namespace"shared/utils/util"

    Index

    Type Aliases

    RequestType SerializedRequestType

    Variables

    MODULE_SIMILAR_APIS REQUEST_TYPE_SEPARATOR diff --git a/papi-dts/types/__papi_frontend_.Papi.html b/papi-dts/types/__papi_frontend_.Papi.html index f7d26469ea..4cb81c237f 100644 --- a/papi-dts/types/__papi_frontend_.Papi.html +++ b/papi-dts/types/__papi_frontend_.Papi.html @@ -1 +1 @@ -Papi | papi-dts

    Type AliasPapi

    Papi: typeof "@papi/frontend".default

    Settings

    Member Visibility
    +Papi | papi-dts

    Type AliasPapi

    Papi: typeof "@papi/frontend".default

    Settings

    Member Visibility
    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 ddd2a70735..e8f9f9b47c 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
    +

    Settings

    Member Visibility
    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 8ab52cb531..02ef0d6809 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 @@ -9,4 +9,4 @@
  • executionToken: ExecutionToken

    Used to save and load data by 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
    +

    Settings

    Member Visibility
    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 ebae5573da..6ecdc1d285 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 @@ -23,4 +23,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
    +

    Settings

    Member Visibility
    diff --git a/papi-dts/types/_main_services_rpc_server_.PropagateEventMethod.html b/papi-dts/types/_main_services_rpc_server_.PropagateEventMethod.html index b0c3d763cd..1588c9434f 100644 --- a/papi-dts/types/_main_services_rpc_server_.PropagateEventMethod.html +++ b/papi-dts/types/_main_services_rpc_server_.PropagateEventMethod.html @@ -1 +1 @@ -PropagateEventMethod | papi-dts

    Type AliasPropagateEventMethod

    PropagateEventMethod: (<T>(source: "main/services/rpc-server".default, eventType: string, event: T) => void)

    Settings

    Member Visibility
    +PropagateEventMethod | papi-dts

    Type AliasPropagateEventMethod

    PropagateEventMethod: (<T>(source: "main/services/rpc-server".default, eventType: string, event: T) => void)

    Settings

    Member Visibility
    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 073a97e238..3715e98710 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 AliasExecutionTokenType

    ExecutionTokenType

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

    -

    Settings

    Member Visibility
    +

    Settings

    Member Visibility
    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 9b60f36fed..9b14fbeb87 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 AliasDirectoryEntries

    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
    +

    Settings

    Member Visibility
    diff --git a/papi-dts/types/_papi_shared_types_.CommandNames.html b/papi-dts/types/_papi_shared_types_.CommandNames.html index 975ca340da..c152aa6355 100644 --- a/papi-dts/types/_papi_shared_types_.CommandNames.html +++ b/papi-dts/types/_papi_shared_types_.CommandNames.html @@ -3,4 +3,4 @@

    Example

    'platform.quit';
    -

    Settings

    Member Visibility
    +

    Settings

    Member Visibility
    diff --git a/papi-dts/types/_papi_shared_types_.DataProviderNames.html b/papi-dts/types/_papi_shared_types_.DataProviderNames.html index f332ece532..e588ea18b4 100644 --- a/papi-dts/types/_papi_shared_types_.DataProviderNames.html +++ b/papi-dts/types/_papi_shared_types_.DataProviderNames.html @@ -3,4 +3,4 @@

    Example

    'platform.placeholder'
    -

    Settings

    Member Visibility
    +

    Settings

    Member Visibility
    diff --git a/papi-dts/types/_papi_shared_types_.DataProviderTypes.html b/papi-dts/types/_papi_shared_types_.DataProviderTypes.html index 5c27ca8d06..772ae2a3af 100644 --- a/papi-dts/types/_papi_shared_types_.DataProviderTypes.html +++ b/papi-dts/types/_papi_shared_types_.DataProviderTypes.html @@ -4,4 +4,4 @@

    Example

    DataProviderTypes['helloSomeone.people'] => {
        Greeting: DataProviderDataType<string, string | undefined, string>;
        Age: DataProviderDataType<string, number | undefined, number>;
        People: DataProviderDataType<undefined, PeopleData, never>;
      }
    -

    Settings

    Member Visibility
    +

    Settings

    Member Visibility
    diff --git a/papi-dts/types/_papi_shared_types_.DisposableDataProviders.html b/papi-dts/types/_papi_shared_types_.DisposableDataProviders.html index 3930c8b9a1..0d156462c3 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
    +

    Settings

    Member Visibility
    diff --git a/papi-dts/types/_papi_shared_types_.IBaseProjectDataProvider.html b/papi-dts/types/_papi_shared_types_.IBaseProjectDataProvider.html index 342042214d..4889f22fec 100644 --- a/papi-dts/types/_papi_shared_types_.IBaseProjectDataProvider.html +++ b/papi-dts/types/_papi_shared_types_.IBaseProjectDataProvider.html @@ -19,4 +19,4 @@
  • callback: ((value: ProjectSettingTypes[ProjectSettingName]) => void)

    Function to run with the updated project setting value

  • options: DataProviderSubscriberOptions

    Various options to adjust how the subscriber emits updates

    • Returns Promise<UnsubscriberAsync>

    Unsubscriber to stop listening for updates

    -

    Settings

    Member Visibility
    +

    Settings

    Member Visibility
    diff --git a/papi-dts/types/_papi_shared_types_.IProjectDataProvider.html b/papi-dts/types/_papi_shared_types_.IProjectDataProvider.html index 6084e4e372..3a982b6f2d 100644 --- a/papi-dts/types/_papi_shared_types_.IProjectDataProvider.html +++ b/papi-dts/types/_papi_shared_types_.IProjectDataProvider.html @@ -10,4 +10,4 @@ IBaseProjectDataProvider, which imposes additional requirements.

    See more information, including the difference between Base and Layering PDPs, at ProjectDataProviderInterfaces.

    -

    Type Parameters

    Settings

    Member Visibility
    +

    Type Parameters

    Settings

    Member Visibility
    diff --git a/papi-dts/types/_papi_shared_types_.NotesOnlyProjectDataTypes.html b/papi-dts/types/_papi_shared_types_.NotesOnlyProjectDataTypes.html index 5dba3ac326..a3ac05f6d1 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 AliasNotesOnlyProjectDataTypes

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

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

    -

    Settings

    Member Visibility
    +

    Settings

    Member Visibility
    diff --git a/papi-dts/types/_papi_shared_types_.PlaceholderDataTypes.html b/papi-dts/types/_papi_shared_types_.PlaceholderDataTypes.html index a1cdb06f96..bf18d03d97 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 AliasPlaceholderDataTypes

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

    Settings

    Member Visibility
    +PlaceholderDataTypes | papi-dts

    Type AliasPlaceholderDataTypes

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

    Settings

    Member Visibility
    diff --git a/papi-dts/types/_papi_shared_types_.ProjectInterfaceDataTypes.html b/papi-dts/types/_papi_shared_types_.ProjectInterfaceDataTypes.html index a4ec3ec952..7f8befefe2 100644 --- a/papi-dts/types/_papi_shared_types_.ProjectInterfaceDataTypes.html +++ b/papi-dts/types/_papi_shared_types_.ProjectInterfaceDataTypes.html @@ -8,4 +8,4 @@

    Example

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

    Settings

    Member Visibility
    +

    Settings

    Member Visibility
    diff --git a/papi-dts/types/_papi_shared_types_.ProjectInterfaces.html b/papi-dts/types/_papi_shared_types_.ProjectInterfaces.html index 360c35b3a9..8e96bea6a4 100644 --- a/papi-dts/types/_papi_shared_types_.ProjectInterfaces.html +++ b/papi-dts/types/_papi_shared_types_.ProjectInterfaces.html @@ -7,4 +7,4 @@

    Example

    'platform.notesOnly'
    -

    Settings

    Member Visibility
    +

    Settings

    Member Visibility
    diff --git a/papi-dts/types/_papi_shared_types_.ProjectSettingNames.html b/papi-dts/types/_papi_shared_types_.ProjectSettingNames.html index 768011fb54..554e6aab34 100644 --- a/papi-dts/types/_papi_shared_types_.ProjectSettingNames.html +++ b/papi-dts/types/_papi_shared_types_.ProjectSettingNames.html @@ -4,4 +4,4 @@

    Example

    'platform.fullName'
    -

    Settings

    Member Visibility
    +

    Settings

    Member Visibility
    diff --git a/papi-dts/types/_papi_shared_types_.SettingNames.html b/papi-dts/types/_papi_shared_types_.SettingNames.html index 99c1a2279f..2a305d1442 100644 --- a/papi-dts/types/_papi_shared_types_.SettingNames.html +++ b/papi-dts/types/_papi_shared_types_.SettingNames.html @@ -3,4 +3,4 @@

    Example

    'platform.verseRef'
    -

    Settings

    Member Visibility
    +

    Settings

    Member Visibility
    diff --git a/papi-dts/types/_papi_shared_types_.StuffDataTypes.html b/papi-dts/types/_papi_shared_types_.StuffDataTypes.html index d5b4d64aa3..c52d203129 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 AliasStuffDataTypes

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

    Settings

    Member Visibility
    +StuffDataTypes | papi-dts

    Type AliasStuffDataTypes

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

    Settings

    Member Visibility
    diff --git a/papi-dts/types/_papi_shared_types_.WebViewControllerTypes.html b/papi-dts/types/_papi_shared_types_.WebViewControllerTypes.html index 1df88dcda2..969c96cc08 100644 --- a/papi-dts/types/_papi_shared_types_.WebViewControllerTypes.html +++ b/papi-dts/types/_papi_shared_types_.WebViewControllerTypes.html @@ -4,4 +4,4 @@

    Example

    'platform.placeholderWebView'
    -

    Settings

    Member Visibility
    +

    Settings

    Member Visibility
    diff --git a/papi-dts/types/_papi_shared_types_.WithProjectDataProviderEngineSettingMethods.html b/papi-dts/types/_papi_shared_types_.WithProjectDataProviderEngineSettingMethods.html index 91652a6c0f..3f4f4ad8d0 100644 --- a/papi-dts/types/_papi_shared_types_.WithProjectDataProviderEngineSettingMethods.html +++ b/papi-dts/types/_papi_shared_types_.WithProjectDataProviderEngineSettingMethods.html @@ -25,4 +25,4 @@
  • newSetting: ProjectSettingTypes[ProjectSettingName]

    The value that is to be set to the project setting.

    • Returns Promise<DataProviderUpdateInstructions<TProjectDataTypes & MandatoryProjectDataTypes>>

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

    -

    Settings

    Member Visibility
    +

    Settings

    Member Visibility
    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 b6b8649cf9..4273b4d0d9 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

  • OptionaltabType?: string

    Overwritten in DialogDefinition. Must be specified by all DialogDefinitions

    -

    • Settings

    Member Visibility
    +

    Settings

    Member Visibility
    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 0c75e12523..d11012eb40 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 AliasDialogProps<TData>

    DialogProps<TData>: DialogData & {
        cancelDialog(): void;
        rejectDialog(errorMessage: string): void;
        submitDialog(data: TData): 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
    +

    Returns void

    Settings

    Member Visibility
    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 f6cb999db4..0d486d8d9b 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
    +

    Settings

    Member Visibility
    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 1c005cc157..0c22742f9f 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 AliasDialogDefinition<DialogTabType>

    DialogDefinition<DialogTabType>: Readonly<DialogDefinitionBase & {
        Component: ((props: DialogProps<DialogTypes[DialogTabType]["responseType"]> & DialogTypes[DialogTabType]["options"]) => ReactElement);
        tabType: DialogTabType;
    }>

    Type Parameters

    Settings

    Member Visibility
    +DialogDefinition | papi-dts

    Type AliasDialogDefinition<DialogTabType>

    DialogDefinition<DialogTabType>: Readonly<DialogDefinitionBase & {
        Component: ((props: DialogProps<DialogTypes[DialogTabType]["responseType"]> & DialogTypes[DialogTabType]["options"]) => ReactElement);
        tabType: DialogTabType;
    }>

    Type Parameters

    Settings

    Member Visibility
    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 826aaf1032..04c5e64866 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 AliasDialogTabTypes

    DialogTabTypes: keyof DialogTypes

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

    -

    Settings

    Member Visibility
    +

    Settings

    Member Visibility
    diff --git a/papi-dts/types/_renderer_components_dialogs_dialog_definition_model_.ProjectDialogOptionsBase.html b/papi-dts/types/_renderer_components_dialogs_dialog_definition_model_.ProjectDialogOptionsBase.html index f3bc972e91..5aa4c8b619 100644 --- a/papi-dts/types/_renderer_components_dialogs_dialog_definition_model_.ProjectDialogOptionsBase.html +++ b/papi-dts/types/_renderer_components_dialogs_dialog_definition_model_.ProjectDialogOptionsBase.html @@ -1 +1 @@ -ProjectDialogOptionsBase | papi-dts

    Type AliasProjectDialogOptionsBase

    ProjectDialogOptionsBase: DialogOptions & ProjectMetadataFilterOptions

    Settings

    Member Visibility
    +ProjectDialogOptionsBase | papi-dts

    Type AliasProjectDialogOptionsBase

    ProjectDialogOptionsBase: DialogOptions & ProjectMetadataFilterOptions

    Settings

    Member Visibility
    diff --git a/papi-dts/types/_renderer_components_dialogs_dialog_definition_model_.SelectBooksDialogOptions.html b/papi-dts/types/_renderer_components_dialogs_dialog_definition_model_.SelectBooksDialogOptions.html index b89376efda..d1a8efd202 100644 --- a/papi-dts/types/_renderer_components_dialogs_dialog_definition_model_.SelectBooksDialogOptions.html +++ b/papi-dts/types/_renderer_components_dialogs_dialog_definition_model_.SelectBooksDialogOptions.html @@ -1,3 +1,3 @@ SelectBooksDialogOptions | papi-dts

    Type AliasSelectBooksDialogOptions

    SelectBooksDialogOptions: DialogOptions & {
        selectedBookIds?: string[];
    }

    Options to provide when showing the Select Books dialog

    Type declaration

    • OptionalselectedBookIds?: string[]

      Books IDs that should start selected in the dialog

      -

    Settings

    Member Visibility
    +

    Settings

    Member Visibility
    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 9116b94bd6..a19309a2d4 100644 --- a/papi-dts/types/_renderer_components_dialogs_dialog_definition_model_.SelectMultipleProjectsDialogOptions.html +++ b/papi-dts/types/_renderer_components_dialogs_dialog_definition_model_.SelectMultipleProjectsDialogOptions.html @@ -1,3 +1,3 @@ SelectMultipleProjectsDialogOptions | papi-dts

    Type AliasSelectMultipleProjectsDialogOptions

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

    Options to provide when showing the Select Multiple Project dialog

    Type declaration

    • OptionalselectedProjectIds?: string[]

      Project IDs that should start selected in the dialog

      -

    Settings

    Member Visibility
    +

    Settings

    Member Visibility
    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 eca6f286fd..b4c93f58cc 100644 --- a/papi-dts/types/_renderer_components_dialogs_dialog_definition_model_.SelectProjectDialogOptions.html +++ b/papi-dts/types/_renderer_components_dialogs_dialog_definition_model_.SelectProjectDialogOptions.html @@ -1,2 +1,2 @@ SelectProjectDialogOptions | papi-dts

    Type AliasSelectProjectDialogOptions

    SelectProjectDialogOptions: ProjectDialogOptionsBase

    Options to provide when showing the Select Project dialog

    -

    Settings

    Member Visibility
    +

    Settings

    Member Visibility
    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 898c008c05..2ad873a6ae 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 AliasUseDialogCallbackOptions

    UseDialogCallbackOptions: {
        maximumOpenDialogs?: number;
    }

    Type declaration

    • OptionalmaximumOpenDialogs?: 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
    +

    Settings

    Member Visibility
    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 3761622535..f0f07f593d 100644 --- a/papi-dts/types/_shared_data_file_system_model_.Uri.html +++ b/papi-dts/types/_shared_data_file_system_model_.Uri.html @@ -29,4 +29,4 @@

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

    -

    Settings

    Member Visibility
    +

    Settings

    Member Visibility
    diff --git a/papi-dts/types/_shared_data_rpc_model_.EventHandler.html b/papi-dts/types/_shared_data_rpc_model_.EventHandler.html index b18e46e2a2..e6b4130546 100644 --- a/papi-dts/types/_shared_data_rpc_model_.EventHandler.html +++ b/papi-dts/types/_shared_data_rpc_model_.EventHandler.html @@ -1,2 +1,2 @@ EventHandler | papi-dts

    Type AliasEventHandler

    EventHandler: (<T>(eventType: string, event: T) => void)

    Function that processes an event received locally or over the network

    -

    Settings

    Member Visibility
    +

    Settings

    Member Visibility
    diff --git a/papi-dts/types/_shared_data_rpc_model_.InternalRequestHandler.html b/papi-dts/types/_shared_data_rpc_model_.InternalRequestHandler.html index ec6b7d5d42..d485adc90d 100644 --- a/papi-dts/types/_shared_data_rpc_model_.InternalRequestHandler.html +++ b/papi-dts/types/_shared_data_rpc_model_.InternalRequestHandler.html @@ -1,4 +1,4 @@ InternalRequestHandler | papi-dts

    Type AliasInternalRequestHandler

    InternalRequestHandler: ((...requestParams: RequestParams) => any)

    Function to call internally when a request is received. The return value is sent back as the response to the request. If the request was received over the network, the response will be packaged into a JSONRPCSuccessResponse message.

    -

    Settings

    Member Visibility
    +

    Settings

    Member Visibility
    diff --git a/papi-dts/types/_shared_data_rpc_model_.RequestId.html b/papi-dts/types/_shared_data_rpc_model_.RequestId.html index 5aef393f7d..207f4b7cf1 100644 --- a/papi-dts/types/_shared_data_rpc_model_.RequestId.html +++ b/papi-dts/types/_shared_data_rpc_model_.RequestId.html @@ -1,3 +1,3 @@ RequestId | papi-dts

    Type AliasRequestId

    RequestId: number | string

    ID of an individual request. It must be unique between an RPC client and server for a single connection. Once a connection has closed and reopens, IDs can be reused.

    -

    Settings

    Member Visibility
    +

    Settings

    Member Visibility
    diff --git a/papi-dts/types/_shared_data_rpc_model_.RequestParams.html b/papi-dts/types/_shared_data_rpc_model_.RequestParams.html index 1124c0520e..5c34adc1f8 100644 --- a/papi-dts/types/_shared_data_rpc_model_.RequestParams.html +++ b/papi-dts/types/_shared_data_rpc_model_.RequestParams.html @@ -1,2 +1,2 @@ RequestParams | papi-dts

    Type AliasRequestParams

    RequestParams: any[]

    Parameters provided to an RPC request message

    -

    Settings

    Member Visibility
    +

    Settings

    Member Visibility
    diff --git a/papi-dts/types/_shared_models_base_project_data_provider_engine_model_.IBaseProjectDataProviderEngine.html b/papi-dts/types/_shared_models_base_project_data_provider_engine_model_.IBaseProjectDataProviderEngine.html index 99dfa72730..6267c6dfeb 100644 --- a/papi-dts/types/_shared_models_base_project_data_provider_engine_model_.IBaseProjectDataProviderEngine.html +++ b/papi-dts/types/_shared_models_base_project_data_provider_engine_model_.IBaseProjectDataProviderEngine.html @@ -30,4 +30,4 @@ 
    class MyPDPE implements IBaseProjectDataProviderEngine<['MyProjectData']> {
      notifyUpdate(updateInstructions?: DataProviderEngineNotifyUpdate<ProjectDataTypes['MyProjectData']>) {}
      ...
    }
    -

    Type Parameters

    Settings

    Member Visibility
    +

    Type Parameters

    Settings

    Member Visibility
    diff --git a/papi-dts/types/_shared_models_create_process_privilege_model_.CreateProcess.html b/papi-dts/types/_shared_models_create_process_privilege_model_.CreateProcess.html index 08bd9fed5f..1afba7da74 100644 --- a/papi-dts/types/_shared_models_create_process_privilege_model_.CreateProcess.html +++ b/papi-dts/types/_shared_models_create_process_privilege_model_.CreateProcess.html @@ -1 +1 @@ -CreateProcess | papi-dts

    Type AliasCreateProcess

    CreateProcess: {
        fork: PlatformFork;
        osData: OperatingSystemData;
        spawn: PlatformSpawn;
    }

    Settings

    Member Visibility
    +CreateProcess | papi-dts

    Type AliasCreateProcess

    CreateProcess: {
        fork: PlatformFork;
        osData: OperatingSystemData;
        spawn: PlatformSpawn;
    }

    Settings

    Member Visibility
    diff --git a/papi-dts/types/_shared_models_create_process_privilege_model_.OperatingSystemData.html b/papi-dts/types/_shared_models_create_process_privilege_model_.OperatingSystemData.html index 7287404e61..9a226bfe88 100644 --- a/papi-dts/types/_shared_models_create_process_privilege_model_.OperatingSystemData.html +++ b/papi-dts/types/_shared_models_create_process_privilege_model_.OperatingSystemData.html @@ -2,4 +2,4 @@

    Type declaration

    • platform: string

      Value of os.platform() in Node

    • release: string

      Value of os.release() in Node

    • type: string

      Value of os.type() in Node

      -

    Settings

    Member Visibility
    +

    Settings

    Member Visibility
    diff --git a/papi-dts/types/_shared_models_create_process_privilege_model_.PlatformFork.html b/papi-dts/types/_shared_models_create_process_privilege_model_.PlatformFork.html index 1b7b46d2a0..bc3ab64cc7 100644 --- a/papi-dts/types/_shared_models_create_process_privilege_model_.PlatformFork.html +++ b/papi-dts/types/_shared_models_create_process_privilege_model_.PlatformFork.html @@ -19,4 +19,4 @@ createProcess.fork(executionToken, 'assets/childProcess.js'); -

    Settings

    Member Visibility
    +

    Settings

    Member Visibility
    diff --git a/papi-dts/types/_shared_models_create_process_privilege_model_.PlatformSpawn.html b/papi-dts/types/_shared_models_create_process_privilege_model_.PlatformSpawn.html index 0688e72ff3..9b8f9f5e73 100644 --- a/papi-dts/types/_shared_models_create_process_privilege_model_.PlatformSpawn.html +++ b/papi-dts/types/_shared_models_create_process_privilege_model_.PlatformSpawn.html @@ -31,4 +31,4 @@ } -

    Settings

    Member Visibility
    +

    Settings

    Member Visibility
    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 eeb5333014..ad88e4b1d7 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 @@ -22,4 +22,4 @@

    ＠see DataProviderUpdateInstructions for more info on the updateInstructions parameter

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

    -

    Type Parameters

    Settings

    Member Visibility
    +

    Type Parameters

    Settings

    Member Visibility
    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 f76cbd9933..fc1df3e2dd 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 @@ -29,4 +29,4 @@
  • DataProviderEngineNotifyUpdate for more information on notifyUpdate.
  • IDataProviderEngine for more information on using this type.
    • -

    Settings

    Member Visibility
    +

    Settings

    Member Visibility
    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 3950fb4481..e8c90edbb3 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 @@ -26,4 +26,4 @@ 
    class MyDPE implements IDataProviderEngine<MyDataTypes> {
      notifyUpdate(updateInstructions?: DataProviderEngineNotifyUpdate<MyDataTypes>) {}
      ...
    }
    -

    Type Parameters

    Settings

    Member Visibility
    +

    Type Parameters

    Settings

    Member Visibility
    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 c757ded718..8eb81f4619 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
    +

    Settings

    Member Visibility
    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 f871a23b1e..6454174a7c 100644 --- a/papi-dts/types/_shared_models_data_provider_interface_.default.html +++ b/papi-dts/types/_shared_models_data_provider_interface_.default.html @@ -3,4 +3,4 @@ getting a data provider with papi.dataProviders.get.

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

    -

    Type Parameters

    Settings

    Member Visibility
    +

    Type Parameters

    Settings

    Member Visibility
    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 a49d04b224..8af949b7c8 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
    +

    Settings

    Member Visibility
    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 8c829054ab..e5c299fc96 100644 --- a/papi-dts/types/_shared_models_data_provider_model_.DataProviderDataTypes.html +++ b/papi-dts/types/_shared_models_data_provider_model_.DataProviderDataTypes.html @@ -8,4 +8,4 @@ 
    {
    Greeting: DataProviderDataType<string, string | undefined, string>;
    Age: DataProviderDataType<string, number | undefined, number>;
    All: DataProviderDataType<undefined, { greeting: string, age: number }, never>;
    }
    -

    Settings

    Member Visibility
    +

    Settings

    Member Visibility
    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 790a12b05e..7d58353ddc 100644 --- a/papi-dts/types/_shared_models_data_provider_model_.DataProviderGetter.html +++ b/papi-dts/types/_shared_models_data_provider_model_.DataProviderGetter.html @@ -4,4 +4,4 @@ up-to-date.

    Type Parameters

    Type declaration

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

      • Parameters

        • selector: TDataType["selector"]

          Tells the provider what subset of data to get

        Returns Promise<TDataType["getData"]>

        The subset of data represented by the selector

        -

    Settings

    Member Visibility
    +

    Settings

    Member Visibility
    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 985135b04b..787b02c63a 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 AliasDataProviderGetters<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
    +

    Settings

    Member Visibility
    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 90d5761008..dbbf25e722 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
    +

    Settings

    Member Visibility
    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 37de724c16..1eeb1a42c3 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 AliasDataProviderSetters<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
    +

    Settings

    Member Visibility
    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 544b549f29..d5b8eedb44 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

  • Optionaloptions: DataProviderSubscriberOptions

    Various options to adjust how the subscriber emits updates

    • Returns Promise<UnsubscriberAsync>

    Unsubscriber to stop listening for updates

    -

    Settings

    Member Visibility
    +

    Settings

    Member Visibility
    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 22050417f4..bf74862e0d 100644 --- a/papi-dts/types/_shared_models_data_provider_model_.DataProviderSubscriberOptions.html +++ b/papi-dts/types/_shared_models_data_provider_model_.DataProviderSubscriberOptions.html @@ -25,4 +25,4 @@

    Default

    'deeply-equal'
    -

    Settings

    Member Visibility
    +

    Settings

    Member Visibility
    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 9e9b7fec4c..e719e6201b 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 AliasDataProviderSubscribers<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
    +

    Settings

    Member Visibility
    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 5a56f425dc..ff71f86cbe 100644 --- a/papi-dts/types/_shared_models_data_provider_model_.DataProviderUpdateInstructions.html +++ b/papi-dts/types/_shared_models_data_provider_model_.DataProviderUpdateInstructions.html @@ -21,4 +21,4 @@

    false (or falsy) do not update subscriptions

    -

    Type Parameters

    Settings

    Member Visibility
    +

    Type Parameters

    Settings

    Member Visibility
    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 6585255d8f..b774860f76 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 AliasDataTypeNames<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
    +

    Settings

    Member Visibility
    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 9eaafbc851..2a51da5555 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
    +

    Settings

    Member Visibility
    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 8bb714961b..5907222d44 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 AliasDialogData

    DialogData: DialogOptions & {
        isDialog: true;
    }

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

    -

    Settings

    Member Visibility
    +

    Settings

    Member Visibility
    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 170684f872..515d56984e 100644 --- a/papi-dts/types/_shared_models_dialog_options_model_.DialogOptions.html +++ b/papi-dts/types/_shared_models_dialog_options_model_.DialogOptions.html @@ -6,4 +6,4 @@
  • Optionaltitle?: string | LocalizeKey

    Dialog title to display in the header. If you provide a LocalizeKey, it will be localized before displaying.

    Default depends on the dialog

    -

    • Settings

    Member Visibility
    +

    Settings

    Member Visibility
    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 009bf8dd51..cd3433c592 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
    +

    Settings

    Member Visibility
    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 dbe734403f..870219dbc0 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 AliasFloatSize

    FloatSize: {
        height: number;
        width: number;
    }

    The dimensions for a floating tab in CSS px units

    -

    Settings

    Member Visibility
    +

    Settings

    Member Visibility
    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 3f3c02c802..1376ce280c 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 AliasLayout

    Layout: TabLayout | FloatLayout | PanelLayout

    Information about how a Paranext tab fits into the dock layout

    -

    Settings

    Member Visibility
    +

    Settings

    Member Visibility
    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 1348729cee..57f758c795 100644 --- a/papi-dts/types/_shared_models_docking_framework_model_.OnLayoutChangeRCDock.html +++ b/papi-dts/types/_shared_models_docking_framework_model_.OnLayoutChangeRCDock.html @@ -7,4 +7,4 @@
  • OptionalwebViewDefinition: WebViewDefinition

    The web view definition if the edit was on a web view; undefined otherwise

    • Returns Promise<void>

    Promise that resolves when finished doing things

    -

    Settings

    Member Visibility
    +

    Settings

    Member Visibility
    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 f6c8e057d6..46869feb62 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 AliasPanelDirection

    PanelDirection:
        | "left"
        | "right"
        | "bottom"
        | "top"
        | "before-tab"
        | "after-tab"
        | "maximize"
        | "move"
        | "active"
        | "update"

    Settings

    Member Visibility
    +PanelDirection | papi-dts

    Type AliasPanelDirection

    PanelDirection:
        | "left"
        | "right"
        | "bottom"
        | "top"
        | "before-tab"
        | "after-tab"
        | "maximize"
        | "move"
        | "active"
        | "update"

    Settings

    Member Visibility
    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 d1919b36f6..7566c598ac 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
    +

    Settings

    Member Visibility
    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 6ff2560a2d..c024d7eb4f 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
    +

    Settings

    Member Visibility
    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 1fab725653..3b60e6085e 100644 --- a/papi-dts/types/_shared_models_docking_framework_model_.TabInfo.html +++ b/papi-dts/types/_shared_models_docking_framework_model_.TabInfo.html @@ -11,4 +11,4 @@
  • tabTitle: string | LocalizeKey

    Text to show (or a localizeKey that will automatically be localized) on the title bar of the tab

  • OptionaltabTooltip?: string

    Text to show when hovering over the title bar of the tab

    -

    • Settings

    Member Visibility
    +

    Settings

    Member Visibility
    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 0fa4df4f1b..01c444a9f4 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 AliasTabLoader

    TabLoader: ((savedTabInfo: 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

    -

    Settings

    Member Visibility
    +

    Settings

    Member Visibility
    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 ced000adc5..bcf8b30e08 100644 --- a/papi-dts/types/_shared_models_docking_framework_model_.TabSaver.html +++ b/papi-dts/types/_shared_models_docking_framework_model_.TabSaver.html @@ -3,4 +3,4 @@ stripped from TabInfo by saveTabInfoBase before saving (so it is just a SavedTabInfo).

    Type declaration

      • (tabInfo): SavedTabInfo | undefined

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

    Settings

    Member Visibility
    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 7599f5403d..86d4d0c062 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 AliasWebViewTabProps

    WebViewTabProps: WebViewDefinition

    Props that are passed to the web view tab component

    -

    Settings

    Member Visibility
    +

    Settings

    Member Visibility
    diff --git a/papi-dts/types/_shared_models_elevated_privileges_model_.ElevatedPrivileges.html b/papi-dts/types/_shared_models_elevated_privileges_model_.ElevatedPrivileges.html index cf548a5b8d..1b6a64e891 100644 --- a/papi-dts/types/_shared_models_elevated_privileges_model_.ElevatedPrivileges.html +++ b/papi-dts/types/_shared_models_elevated_privileges_model_.ElevatedPrivileges.html @@ -1,4 +1,4 @@ ElevatedPrivileges | papi-dts

    Type AliasElevatedPrivileges

    ElevatedPrivileges: {
        createProcess: CreateProcess | undefined;
        manageExtensions: ManageExtensions | undefined;
    }

    Object that contains properties with special capabilities for extensions that required them

    Type declaration

    • createProcess: CreateProcess | undefined

      Functions that can be run to start new processes

    • manageExtensions: ManageExtensions | undefined

      Functions that can be run to manage what extensions are running

      -

    Settings

    Member Visibility
    +

    Settings

    Member Visibility
    diff --git a/papi-dts/types/_shared_models_extension_basic_data_model_.ExtensionBasicData.html b/papi-dts/types/_shared_models_extension_basic_data_model_.ExtensionBasicData.html index 8ed7178f21..ffdf9c1e9b 100644 --- a/papi-dts/types/_shared_models_extension_basic_data_model_.ExtensionBasicData.html +++ b/papi-dts/types/_shared_models_extension_basic_data_model_.ExtensionBasicData.html @@ -1,3 +1,3 @@ ExtensionBasicData | papi-dts

    Type AliasExtensionBasicData

    ExtensionBasicData: {
        name: string;
    }

    Represents an object that contains the most basic information about an extension

    Type declaration

    • name: string

      Name of an extension

      -

    Settings

    Member Visibility
    +

    Settings

    Member Visibility
    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 a38e991d03..97072df764 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
    +

    Type Parameters

    • TDataProvider

    Settings

    Member Visibility
    diff --git a/papi-dts/types/_shared_models_manage_extensions_privilege_model_.DisableExtensionFunction.html b/papi-dts/types/_shared_models_manage_extensions_privilege_model_.DisableExtensionFunction.html index d134862d1b..085b6ea534 100644 --- a/papi-dts/types/_shared_models_manage_extensions_privilege_model_.DisableExtensionFunction.html +++ b/papi-dts/types/_shared_models_manage_extensions_privilege_model_.DisableExtensionFunction.html @@ -1,4 +1,4 @@ DisableExtensionFunction | papi-dts

    Type AliasDisableExtensionFunction

    DisableExtensionFunction: ((extensionIdentifier: ExtensionIdentifier) => Promise<void>)

    Stop running an extension that had been previously downloaded and enabled

    Type declaration

      • (extensionIdentifier): Promise<void>

      • Parameters

        Returns Promise<void>

        Promise that resolves when the extension has been enabled, throws if enabling fails

        -

    Settings

    Member Visibility
    +

    Settings

    Member Visibility
    diff --git a/papi-dts/types/_shared_models_manage_extensions_privilege_model_.EnableExtensionFunction.html b/papi-dts/types/_shared_models_manage_extensions_privilege_model_.EnableExtensionFunction.html index fe0094b694..2a73ed9e71 100644 --- a/papi-dts/types/_shared_models_manage_extensions_privilege_model_.EnableExtensionFunction.html +++ b/papi-dts/types/_shared_models_manage_extensions_privilege_model_.EnableExtensionFunction.html @@ -1,4 +1,4 @@ EnableExtensionFunction | papi-dts

    Type AliasEnableExtensionFunction

    EnableExtensionFunction: ((extensionIdentifier: ExtensionIdentifier) => Promise<void>)

    Start running an extension that had been previously downloaded and disabled

    Type declaration

      • (extensionIdentifier): Promise<void>

      • Parameters

        Returns Promise<void>

        Promise that resolves when the extension has been enabled, throws if enabling fails

        -

    Settings

    Member Visibility
    +

    Settings

    Member Visibility
    diff --git a/papi-dts/types/_shared_models_manage_extensions_privilege_model_.ExtensionIdentifier.html b/papi-dts/types/_shared_models_manage_extensions_privilege_model_.ExtensionIdentifier.html index 1acbbc89a8..35ab050024 100644 --- a/papi-dts/types/_shared_models_manage_extensions_privilege_model_.ExtensionIdentifier.html +++ b/papi-dts/types/_shared_models_manage_extensions_privilege_model_.ExtensionIdentifier.html @@ -1,2 +1,2 @@ ExtensionIdentifier | papi-dts

    Type AliasExtensionIdentifier

    ExtensionIdentifier: {
        extensionName: string;
        extensionVersion: string;
    }

    Represents an extension that can be enabled or disabled

    -

    Settings

    Member Visibility
    +

    Settings

    Member Visibility
    diff --git a/papi-dts/types/_shared_models_manage_extensions_privilege_model_.GetInstalledExtensionsFunction.html b/papi-dts/types/_shared_models_manage_extensions_privilege_model_.GetInstalledExtensionsFunction.html index 2505ce5844..1b60272bb4 100644 --- a/papi-dts/types/_shared_models_manage_extensions_privilege_model_.GetInstalledExtensionsFunction.html +++ b/papi-dts/types/_shared_models_manage_extensions_privilege_model_.GetInstalledExtensionsFunction.html @@ -1,2 +1,2 @@ GetInstalledExtensionsFunction | papi-dts

    Type AliasGetInstalledExtensionsFunction

    GetInstalledExtensionsFunction: (() => Promise<InstalledExtensions>)

    Get extension identifiers of all extensions on the system

    -

    Settings

    Member Visibility
    +

    Settings

    Member Visibility
    diff --git a/papi-dts/types/_shared_models_manage_extensions_privilege_model_.HashValues.html b/papi-dts/types/_shared_models_manage_extensions_privilege_model_.HashValues.html index b33d250c58..3d29bc69dd 100644 --- a/papi-dts/types/_shared_models_manage_extensions_privilege_model_.HashValues.html +++ b/papi-dts/types/_shared_models_manage_extensions_privilege_model_.HashValues.html @@ -1,2 +1,2 @@ HashValues | papi-dts

    Type AliasHashValues

    HashValues: Partial<{
        sha256: string;
        sha512: string;
    }>

    Base64 encoded hash values

    -

    Settings

    Member Visibility
    +

    Settings

    Member Visibility
    diff --git a/papi-dts/types/_shared_models_manage_extensions_privilege_model_.InstallExtensionFunction.html b/papi-dts/types/_shared_models_manage_extensions_privilege_model_.InstallExtensionFunction.html index 7d766ebf0c..93aa320d55 100644 --- a/papi-dts/types/_shared_models_manage_extensions_privilege_model_.InstallExtensionFunction.html +++ b/papi-dts/types/_shared_models_manage_extensions_privilege_model_.InstallExtensionFunction.html @@ -6,4 +6,4 @@ validation. For example, if you provide a sha256 hash value and a sha512 hash value, the installer may only use the sha512 hash value for validation.

    Returns Promise<void>

    Promise that resolves when the extension has been installed

    -

    Settings

    Member Visibility
    +

    Settings

    Member Visibility
    diff --git a/papi-dts/types/_shared_models_manage_extensions_privilege_model_.InstalledExtensions.html b/papi-dts/types/_shared_models_manage_extensions_privilege_model_.InstalledExtensions.html index 7a4e384790..d03c8e1556 100644 --- a/papi-dts/types/_shared_models_manage_extensions_privilege_model_.InstalledExtensions.html +++ b/papi-dts/types/_shared_models_manage_extensions_privilege_model_.InstalledExtensions.html @@ -8,4 +8,4 @@ or removed from the set of enabled extensions.

  • packaged: ExtensionIdentifier[]

    Extensions that are explicitly bundled to be part of the application. They cannot be disabled. At runtime no extensions can be added or removed from the set of packaged extensions.

    -

    • Settings

    Member Visibility
    +

    Settings

    Member Visibility
    diff --git a/papi-dts/types/_shared_models_manage_extensions_privilege_model_.ManageExtensions.html b/papi-dts/types/_shared_models_manage_extensions_privilege_model_.ManageExtensions.html index 182d0abca1..67853bb2e9 100644 --- a/papi-dts/types/_shared_models_manage_extensions_privilege_model_.ManageExtensions.html +++ b/papi-dts/types/_shared_models_manage_extensions_privilege_model_.ManageExtensions.html @@ -3,4 +3,4 @@
  • enableExtension: EnableExtensionFunction

    Function to start running an extension that had been previously downloaded and disabled

  • getInstalledExtensions: GetInstalledExtensionsFunction

    Function to retrieve details about all installed extensions

  • installExtension: InstallExtensionFunction

    Function to download an extension and enable it

    -

    • Settings

    Member Visibility
    +

    Settings

    Member Visibility
    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 968d7d9e71..47d6903370 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 AliasDisposableNetworkObject<T>

    DisposableNetworkObject<T>: NetworkObject<T> & Dispose

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

    Type Parameters

    See

    networkObjectService

    -

    Settings

    Member Visibility
    +

    Settings

    Member Visibility
    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 806237c4b4..eae5e8f739 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
    +

    Settings

    Member Visibility
    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 75bf7b8f81..d809dbf81e 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
    +

    Settings

    Member Visibility
    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 d58021767d..b51731ee56 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
    +

    Settings

    Member Visibility
    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 b943e1e311..286805b646 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 AliasNetworkableObject<T>

    NetworkableObject<T>: T & CannotHaveOnDidDispose

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

    Type Parameters

    • T = object

    See

    networkObjectService

    -

    Settings

    Member Visibility
    +

    Settings

    Member Visibility
    diff --git a/papi-dts/types/_shared_models_project_data_provider_engine_model_.IProjectDataProviderEngine.html b/papi-dts/types/_shared_models_project_data_provider_engine_model_.IProjectDataProviderEngine.html index 496fb8c779..7f6b127bfb 100644 --- a/papi-dts/types/_shared_models_project_data_provider_engine_model_.IProjectDataProviderEngine.html +++ b/papi-dts/types/_shared_models_project_data_provider_engine_model_.IProjectDataProviderEngine.html @@ -29,4 +29,4 @@ 
    class MyPDPE implements IProjectDataProviderEngine<['MyProjectData']> {
      notifyUpdate(updateInstructions?: DataProviderEngineNotifyUpdate<ProjectDataTypes['MyProjectData']>) {}
      ...
    }
    -

    Type Parameters

    Settings

    Member Visibility
    +

    Type Parameters

    Settings

    Member Visibility
    diff --git a/papi-dts/types/_shared_models_project_data_provider_factory_interface_.ProjectMetadataFilterOptions.html b/papi-dts/types/_shared_models_project_data_provider_factory_interface_.ProjectMetadataFilterOptions.html index 64bdebb32d..2be95c4834 100644 --- a/papi-dts/types/_shared_models_project_data_provider_factory_interface_.ProjectMetadataFilterOptions.html +++ b/papi-dts/types/_shared_models_project_data_provider_factory_interface_.ProjectMetadataFilterOptions.html @@ -1,3 +1,3 @@ ProjectMetadataFilterOptions | papi-dts

    Type AliasProjectMetadataFilterOptions

    ProjectMetadataFilterOptions: ModifierProject & {
        excludeProjectIds?: string | string[];
        includeProjectIds?: string | string[];
    }

    Type declaration

    • OptionalexcludeProjectIds?: string | string[]

      Project IDs to exclude

    • OptionalincludeProjectIds?: string | string[]

      Project IDs to include

      -

    Settings

    Member Visibility
    +

    Settings

    Member Visibility
    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 5168157f48..b9cfa83204 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
    +

    Settings

    Member Visibility
    diff --git a/papi-dts/types/_shared_models_project_data_provider_model_.MandatoryProjectDataTypes.html b/papi-dts/types/_shared_models_project_data_provider_model_.MandatoryProjectDataTypes.html index 24732a436d..f54db8a6c4 100644 --- a/papi-dts/types/_shared_models_project_data_provider_model_.MandatoryProjectDataTypes.html +++ b/papi-dts/types/_shared_models_project_data_provider_model_.MandatoryProjectDataTypes.html @@ -54,4 +54,4 @@ so following this interface ensures your PDP will not break if such a requirement is implemented. -

    Settings

    Member Visibility

    On This Page

    SettingExtensionData
    +

    Settings

    Member Visibility

    On This Page

    SettingExtensionData
    diff --git a/papi-dts/types/_shared_models_project_data_provider_model_.WithProjectDataProviderEngineExtensionDataMethods.html b/papi-dts/types/_shared_models_project_data_provider_model_.WithProjectDataProviderEngineExtensionDataMethods.html index de4cdfa720..2e04ca630a 100644 --- a/papi-dts/types/_shared_models_project_data_provider_model_.WithProjectDataProviderEngineExtensionDataMethods.html +++ b/papi-dts/types/_shared_models_project_data_provider_model_.WithProjectDataProviderEngineExtensionDataMethods.html @@ -7,11 +7,11 @@ to this Project Data Provider

    Returns Promise<undefined | string>

    Extension project data in this project for an extension to use in serving its extension project data

    -
  • setExtensionData:function
  • setExtensionData:function

    • Settings

    Member Visibility
    +

    Settings

    Member Visibility
    diff --git a/papi-dts/types/_shared_models_project_lookup_service_model_.ProjectLookupServiceType.html b/papi-dts/types/_shared_models_project_lookup_service_model_.ProjectLookupServiceType.html index bedf06e516..6b17380755 100644 --- a/papi-dts/types/_shared_models_project_lookup_service_model_.ProjectLookupServiceType.html +++ b/papi-dts/types/_shared_models_project_lookup_service_model_.ProjectLookupServiceType.html @@ -8,8 +8,8 @@ https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Intl/Collator/Collator:

    Only strings that differ in base letters or accents and other diacritic marks compare as unequal. Examples: a ≠ b, a ≠ á, a = A.

    -

    Parameters

    Returns boolean

  • filterProjectsMetadata:function
  • getMetadataForAllProjects:function
  • filterProjectsMetadata:function
  • getMetadataForAllProjects:function

    Returns Promise<ProjectMetadata[]>

    ProjectMetadata for all projects stored on the local system

    -
  • getMetadataForProject:function
  • getMetadataForProject:function

    Returns Promise<ProjectMetadata>

    ProjectMetadata for the given project

    -
  • getMinimalMatchPdpFactoryId:function
  • getMinimalMatchPdpFactoryId:function

    Returns undefined | string

    PDP Factory id whose projectInterfaces minimally match the provided projectInterface if at least one PDP Factory was found that supports the projectInterface provided

    -
  • mergeMetadataFilters:function

    • Settings

    Member Visibility
    +
  • mergeMetadataFilters:function

    • Settings

    Member Visibility
    diff --git a/papi-dts/types/_shared_models_project_metadata_model_.ProjectDataProviderFactoryMetadataInfo.html b/papi-dts/types/_shared_models_project_metadata_model_.ProjectDataProviderFactoryMetadataInfo.html index d651001e27..7856d3985a 100644 --- a/papi-dts/types/_shared_models_project_metadata_model_.ProjectDataProviderFactoryMetadataInfo.html +++ b/papi-dts/types/_shared_models_project_metadata_model_.ProjectDataProviderFactoryMetadataInfo.html @@ -1,4 +1,4 @@ ProjectDataProviderFactoryMetadataInfo | papi-dts

    Type AliasProjectDataProviderFactoryMetadataInfo

    ProjectDataProviderFactoryMetadataInfo: {
        projectInterfaces: ProjectInterfaces[];
    }

    Type declaration

    • projectInterfaces: ProjectInterfaces[]

      Which projectInterfaces (aka standardized sets of methods on a PDP) the Project Data Provider for this project created by this Project Data Provider Factory supports. Indicates what sort of project data should be available on this project from this PDP Factory.

      -

    Settings

    Member Visibility
    +

    Settings

    Member Visibility
    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 fa86b5b404..606efd67ba 100644 --- a/papi-dts/types/_shared_models_project_metadata_model_.ProjectMetadata.html +++ b/papi-dts/types/_shared_models_project_metadata_model_.ProjectMetadata.html @@ -12,4 +12,4 @@

    The keys of this object are ids of the PDP Factories that provide the metadata, namely the projectInterfaces for this project (meaning this PDPF can provide a Project Data Provider for this project with these projectInterfaces)

    -

    Settings

    Member Visibility
    +

    Settings

    Member Visibility
    diff --git a/papi-dts/types/_shared_models_project_metadata_model_.ProjectMetadataWithoutFactoryInfo.html b/papi-dts/types/_shared_models_project_metadata_model_.ProjectMetadataWithoutFactoryInfo.html index 7ef07e2f8c..9ce3220b26 100644 --- a/papi-dts/types/_shared_models_project_metadata_model_.ProjectMetadataWithoutFactoryInfo.html +++ b/papi-dts/types/_shared_models_project_metadata_model_.ProjectMetadataWithoutFactoryInfo.html @@ -6,4 +6,4 @@
  • projectInterfaces: ProjectInterfaces[]

    All projectInterfaces (aka standardized sets of methods on a PDP) that Project Data Providers for this project support. Indicates what sort of project data should be available on this project.

    -

    • Settings

    Member Visibility
    +

    Settings

    Member Visibility
    diff --git a/papi-dts/types/_shared_models_web_view_model_.GetSavedWebViewDefinition.html b/papi-dts/types/_shared_models_web_view_model_.GetSavedWebViewDefinition.html index 0ab3e1d836..f06dc634ca 100644 --- a/papi-dts/types/_shared_models_web_view_model_.GetSavedWebViewDefinition.html +++ b/papi-dts/types/_shared_models_web_view_model_.GetSavedWebViewDefinition.html @@ -1,4 +1,4 @@ GetSavedWebViewDefinition | papi-dts

    Type AliasGetSavedWebViewDefinition

    GetSavedWebViewDefinition: (() => SavedWebViewDefinition | undefined)

    Gets the saved properties on this WebView's WebView definition

    ＠returns saved properties this WebView's WebView definition or undefined if not found for some reason

    -

    Settings

    Member Visibility
    +

    Settings

    Member Visibility
    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 78595042bf..3b2de293dd 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
    +

    Settings

    Member Visibility
    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 5cec8331d4..6fa94b1326 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 AliasSavedWebViewDefinition

    SavedWebViewDefinition: (Partial<Omit<WebViewDefinitionReact, SavedWebViewDefinitionOmittedKeys>> | Partial<Omit<WebViewDefinitionHtml, SavedWebViewDefinitionOmittedKeys>> | Partial<Omit<WebViewDefinitionURL, SavedWebViewDefinitionOmittedKeys>>) & 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
    +

    Settings

    Member Visibility
    diff --git a/papi-dts/types/_shared_models_web_view_model_.SavedWebViewDefinitionOmittedKeys.html b/papi-dts/types/_shared_models_web_view_model_.SavedWebViewDefinitionOmittedKeys.html index 2f90b28c7e..55da6f8632 100644 --- a/papi-dts/types/_shared_models_web_view_model_.SavedWebViewDefinitionOmittedKeys.html +++ b/papi-dts/types/_shared_models_web_view_model_.SavedWebViewDefinitionOmittedKeys.html @@ -1,3 +1,3 @@ SavedWebViewDefinitionOmittedKeys | papi-dts

    Type AliasSavedWebViewDefinitionOmittedKeys

    SavedWebViewDefinitionOmittedKeys: typeof SAVED_WEBVIEW_DEFINITION_OMITTED_KEYS[number]

    The keys of properties on a WebViewDefinition that are omitted when converting to a SavedWebViewDefinition

    -

    Settings

    Member Visibility
    +

    Settings

    Member Visibility
    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 c2eac0b591..2d339fa9c2 100644 --- a/papi-dts/types/_shared_models_web_view_model_.UpdateWebViewDefinition.html +++ b/papi-dts/types/_shared_models_web_view_model_.UpdateWebViewDefinition.html @@ -7,4 +7,4 @@ 
    updateWebViewDefinition({ title: `Hello ${name}` });
    -

    Settings

    Member Visibility
    +

    Settings

    Member Visibility
    diff --git a/papi-dts/types/_shared_models_web_view_model_.UseWebViewScrollGroupScrRefHook.html b/papi-dts/types/_shared_models_web_view_model_.UseWebViewScrollGroupScrRefHook.html index d38c322ae7..604a2490b6 100644 --- a/papi-dts/types/_shared_models_web_view_model_.UseWebViewScrollGroupScrRefHook.html +++ b/papi-dts/types/_shared_models_web_view_model_.UseWebViewScrollGroupScrRefHook.html @@ -16,4 +16,4 @@ 
    const [scrRef, setScrRef, scrollGroupId, setScrollGroupId] = useWebViewScrollGroupScrRef();
    -

    Settings

    Member Visibility
    +

    Settings

    Member Visibility
    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 04e046a341..b87d5d7d3f 100644 --- a/papi-dts/types/_shared_models_web_view_model_.UseWebViewStateHook.html +++ b/papi-dts/types/_shared_models_web_view_model_.UseWebViewStateHook.html @@ -25,4 +25,4 @@ 
    const [lastPersonSeen, setLastPersonSeen] = useWebViewState('lastSeen', 'No one');
    -

    Settings

    Member Visibility
    +

    Settings

    Member Visibility
    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 5deb6df1bd..7a462f97bd 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 AliasWebViewDefinition

    WebViewDefinition: WebViewDefinitionReact | WebViewDefinitionHtml | WebViewDefinitionURL

    Properties defining a type of WebView created by extensions to show web content

    -

    Settings

    Member Visibility
    +

    Settings

    Member Visibility
    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 3556a955cf..51c02f2387 100644 --- a/papi-dts/types/_shared_models_web_view_model_.WebViewDefinitionBase.html +++ b/papi-dts/types/_shared_models_web_view_model_.WebViewDefinitionBase.html @@ -106,4 +106,4 @@ WebView

  • Optionaltooltip?: 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
    +

    Settings

    Member Visibility
    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 8fe8b626b5..418ddd4238 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 AliasWebViewDefinitionHtml

    WebViewDefinitionHtml: WebViewDefinitionBase & {
        contentType: HTML;
    }

    WebView representation using HTML

    Type declaration

    • contentType: HTML

      Indicates this WebView uses HTML

      -

    Settings

    Member Visibility
    +

    Settings

    Member Visibility
    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 d1a89116a8..5fb00837e2 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 AliasWebViewDefinitionReact

    WebViewDefinitionReact: WebViewDefinitionBase & {
        contentType?: React;
        styles?: string;
    }

    WebView representation using React

    Type declaration

    • OptionalcontentType?: React

      Indicates this WebView uses React

    • Optionalstyles?: string

      String of styles to be loaded into the iframe for this WebView

      -

    Settings

    Member Visibility
    +

    Settings

    Member Visibility
    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 82ac569cf6..43218b3cb6 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 AliasWebViewDefinitionURL

    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
    +

    Settings

    Member Visibility
    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 06dbf9d1d9..5b9826b2b0 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 AliasWebViewDefinitionUpdatableProperties

    WebViewDefinitionUpdatableProperties: Pick<WebViewDefinitionBase, typeof WEBVIEW_DEFINITION_UPDATABLE_PROPERTY_KEYS[number]>

    The properties on a WebViewDefinition that may be updated when that webview is already displayed

    -

    Settings

    Member Visibility
    +

    Settings

    Member Visibility
    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 8fcebddac1..47ab6045f0 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 AliasWebViewDefinitionUpdateInfo

    WebViewDefinitionUpdateInfo: Partial<WebViewDefinitionUpdatableProperties>

    WebViewDefinition properties for updating a WebView that is already displayed. Any unspecified properties will stay the same

    -

    Settings

    Member Visibility
    +

    Settings

    Member Visibility
    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 0e45646157..f5f54bf7c1 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 AliasWebViewId

    WebViewId: string

    ID for a specific WebView. Each WebView has a unique ID

    -

    Settings

    Member Visibility
    +

    Settings

    Member Visibility
    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 9e619ec07a..5be71e6d73 100644 --- a/papi-dts/types/_shared_models_web_view_model_.WebViewProps.html +++ b/papi-dts/types/_shared_models_web_view_model_.WebViewProps.html @@ -53,4 +53,4 @@ 
    const [lastPersonSeen, setLastPersonSeen] = useWebViewState('lastSeen', 'No one');
    -

    Settings

    Member Visibility
    +

    Settings

    Member Visibility
    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 47b401bd87..314d8bd8fb 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 AliasWebViewType

    WebViewType: string

    What type a WebView is. Each WebView definition must have a unique type.

    -

    Settings

    Member Visibility
    +

    Settings

    Member Visibility
    diff --git a/papi-dts/types/_shared_services_command_service_.moduleSummaryComments.html b/papi-dts/types/_shared_services_command_service_.moduleSummaryComments.html index 782f511cbd..c679412704 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 AliasmoduleSummaryComments

    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.

    -

    Settings

    Member Visibility
    +

    Settings

    Member Visibility
    diff --git a/papi-dts/types/_shared_services_localization_service_model_.ILocalizationService.html b/papi-dts/types/_shared_services_localization_service_model_.ILocalizationService.html index 70c89e7b04..30d212415c 100644 --- a/papi-dts/types/_shared_services_localization_service_model_.ILocalizationService.html +++ b/papi-dts/types/_shared_services_localization_service_model_.ILocalizationService.html @@ -9,8 +9,8 @@

    Returns Promise<LocalizationData>

    Object whose keys are localizeKeys and values are localized strings

  • setLocalizedString:function
  • setLocalizedStrings:function
  • setLocalizedStrings:function

    • Type declaration

    Type declaration

    Settings

    Member Visibility
    +

    Parameters

    Returns Promise<string>

    Settings

    Member Visibility
    diff --git a/papi-dts/types/_shared_services_localization_service_model_.LocalizationData.html b/papi-dts/types/_shared_services_localization_service_model_.LocalizationData.html index 46e0ab56b5..fa9bc83198 100644 --- a/papi-dts/types/_shared_services_localization_service_model_.LocalizationData.html +++ b/papi-dts/types/_shared_services_localization_service_model_.LocalizationData.html @@ -1 +1 @@ -LocalizationData | papi-dts

    Type AliasLocalizationData

    LocalizationData: LanguageStrings

    Settings

    Member Visibility
    +LocalizationData | papi-dts

    Type AliasLocalizationData

    LocalizationData: LanguageStrings

    Settings

    Member Visibility
    diff --git a/papi-dts/types/_shared_services_localization_service_model_.LocalizationDataDataTypes.html b/papi-dts/types/_shared_services_localization_service_model_.LocalizationDataDataTypes.html index 6744637c83..e8e6494767 100644 --- a/papi-dts/types/_shared_services_localization_service_model_.LocalizationDataDataTypes.html +++ b/papi-dts/types/_shared_services_localization_service_model_.LocalizationDataDataTypes.html @@ -1 +1 @@ -LocalizationDataDataTypes | papi-dts

    Type AliasLocalizationDataDataTypes

    LocalizationDataDataTypes: {
        LocalizedString: DataProviderDataType<LocalizationSelector, string, never>;
        LocalizedStrings: DataProviderDataType<LocalizationSelectors, LocalizationData, never>;
    }

    Settings

    Member Visibility
    +LocalizationDataDataTypes | papi-dts

    Type AliasLocalizationDataDataTypes

    LocalizationDataDataTypes: {
        LocalizedString: DataProviderDataType<LocalizationSelector, string, never>;
        LocalizedStrings: DataProviderDataType<LocalizationSelectors, LocalizationData, never>;
    }

    Settings

    Member Visibility
    diff --git a/papi-dts/types/_shared_services_localization_service_model_.LocalizationSelector.html b/papi-dts/types/_shared_services_localization_service_model_.LocalizationSelector.html index 782e6b0558..57a066f289 100644 --- a/papi-dts/types/_shared_services_localization_service_model_.LocalizationSelector.html +++ b/papi-dts/types/_shared_services_localization_service_model_.LocalizationSelector.html @@ -1 +1 @@ -LocalizationSelector | papi-dts

    Type AliasLocalizationSelector

    LocalizationSelector: {
        locales?: string[];
        localizeKey: LocalizeKey;
    }

    Settings

    Member Visibility
    +LocalizationSelector | papi-dts

    Type AliasLocalizationSelector

    LocalizationSelector: {
        locales?: string[];
        localizeKey: LocalizeKey;
    }

    Settings

    Member Visibility
    diff --git a/papi-dts/types/_shared_services_localization_service_model_.LocalizationSelectors.html b/papi-dts/types/_shared_services_localization_service_model_.LocalizationSelectors.html index bc5a6df176..35a1c04cb6 100644 --- a/papi-dts/types/_shared_services_localization_service_model_.LocalizationSelectors.html +++ b/papi-dts/types/_shared_services_localization_service_model_.LocalizationSelectors.html @@ -1 +1 @@ -LocalizationSelectors | papi-dts

    Type AliasLocalizationSelectors

    LocalizationSelectors: {
        locales?: string[];
        localizeKeys: LocalizeKey[];
    }

    Settings

    Member Visibility
    +LocalizationSelectors | papi-dts

    Type AliasLocalizationSelectors

    LocalizationSelectors: {
        locales?: string[];
        localizeKeys: LocalizeKey[];
    }

    Settings

    Member Visibility
    diff --git a/papi-dts/types/_shared_services_menu_data_service_model_.IMenuDataService.html b/papi-dts/types/_shared_services_menu_data_service_model_.IMenuDataService.html index 08a3f3c05b..4fdf03103b 100644 --- a/papi-dts/types/_shared_services_menu_data_service_model_.IMenuDataService.html +++ b/papi-dts/types/_shared_services_menu_data_service_model_.IMenuDataService.html @@ -2,21 +2,21 @@

    Type declaration

    Settings

    Member Visibility
    +

    Settings

    Member Visibility
    diff --git a/papi-dts/types/_shared_services_menu_data_service_model_.MenuDataDataTypes.html b/papi-dts/types/_shared_services_menu_data_service_model_.MenuDataDataTypes.html index 8797850014..873410bc9f 100644 --- a/papi-dts/types/_shared_services_menu_data_service_model_.MenuDataDataTypes.html +++ b/papi-dts/types/_shared_services_menu_data_service_model_.MenuDataDataTypes.html @@ -1 +1 @@ -MenuDataDataTypes | papi-dts

    Type AliasMenuDataDataTypes

    MenuDataDataTypes: {
        MainMenu: DataProviderDataType<undefined, Localized<MultiColumnMenu>, never>;
        WebViewMenu: DataProviderDataType<ReferencedItem, Localized<WebViewMenu>, never>;
    }

    Settings

    Member Visibility
    +MenuDataDataTypes | papi-dts

    Type AliasMenuDataDataTypes

    MenuDataDataTypes: {
        MainMenu: DataProviderDataType<undefined, Localized<MultiColumnMenu>, never>;
        WebViewMenu: DataProviderDataType<ReferencedItem, Localized<WebViewMenu>, never>;
    }

    Settings

    Member Visibility
    diff --git a/papi-dts/types/_shared_services_project_settings_service_model_.AllProjectSettingsValidators.html b/papi-dts/types/_shared_services_project_settings_service_model_.AllProjectSettingsValidators.html index d9d6b0877a..d265440a6b 100644 --- a/papi-dts/types/_shared_services_project_settings_service_model_.AllProjectSettingsValidators.html +++ b/papi-dts/types/_shared_services_project_settings_service_model_.AllProjectSettingsValidators.html @@ -1,3 +1,3 @@ AllProjectSettingsValidators | papi-dts

    Type AliasAllProjectSettingsValidators

    AllProjectSettingsValidators: {
        [ProjectSettingName in ProjectSettingNames]: ProjectSettingValidator<ProjectSettingName>
    }

    Validators for all project settings. Keys are setting keys, values are functions to validate new settings

    -

    Settings

    Member Visibility
    +

    Settings

    Member Visibility
    diff --git a/papi-dts/types/_shared_services_project_settings_service_model_.ProjectSettingValidator.html b/papi-dts/types/_shared_services_project_settings_service_model_.ProjectSettingValidator.html index cd0346518f..63c49c1cb0 100644 --- a/papi-dts/types/_shared_services_project_settings_service_model_.ProjectSettingValidator.html +++ b/papi-dts/types/_shared_services_project_settings_service_model_.ProjectSettingValidator.html @@ -2,4 +2,4 @@

    Type Parameters

    Type declaration

    Settings

    Member Visibility
    +

    Returns Promise<boolean>

    Settings

    Member Visibility
    diff --git a/papi-dts/types/_shared_services_project_settings_service_model_.SimultaneousProjectSettingsChanges.html b/papi-dts/types/_shared_services_project_settings_service_model_.SimultaneousProjectSettingsChanges.html index 55cfc58ff6..3eef9bb03d 100644 --- a/papi-dts/types/_shared_services_project_settings_service_model_.SimultaneousProjectSettingsChanges.html +++ b/papi-dts/types/_shared_services_project_settings_service_model_.SimultaneousProjectSettingsChanges.html @@ -1,4 +1,4 @@ SimultaneousProjectSettingsChanges | papi-dts

    Type AliasSimultaneousProjectSettingsChanges

    SimultaneousProjectSettingsChanges: {
        [ProjectSettingName in ProjectSettingNames]?: {
            currentValue: ProjectSettingTypes[ProjectSettingName];
            newValue: ProjectSettingTypes[ProjectSettingName];
        }
    }

    All project settings changes being set in one batch

    Project settings may be circularly dependent on one another, so multiple project settings may need to be changed at once in some cases

    -

    Settings

    Member Visibility
    +

    Settings

    Member Visibility
    diff --git a/papi-dts/types/_shared_services_scroll_group_service_model_.ScrollGroupScrRef.html b/papi-dts/types/_shared_services_scroll_group_service_model_.ScrollGroupScrRef.html index daa1a3c310..73f310ab4f 100644 --- a/papi-dts/types/_shared_services_scroll_group_service_model_.ScrollGroupScrRef.html +++ b/papi-dts/types/_shared_services_scroll_group_service_model_.ScrollGroupScrRef.html @@ -2,4 +2,4 @@ that means this should be synced with the scroll group sharing that number. If this value is an object, that means it is an independent Scripture reference and should not be synced with any scroll group.

    -

    Settings

    Member Visibility
    +

    Settings

    Member Visibility
    diff --git a/papi-dts/types/_shared_services_scroll_group_service_model_.ScrollGroupUpdateInfo.html b/papi-dts/types/_shared_services_scroll_group_service_model_.ScrollGroupUpdateInfo.html index 5361f0c635..fa5d5d1fda 100644 --- a/papi-dts/types/_shared_services_scroll_group_service_model_.ScrollGroupUpdateInfo.html +++ b/papi-dts/types/_shared_services_scroll_group_service_model_.ScrollGroupUpdateInfo.html @@ -1,3 +1,3 @@ ScrollGroupUpdateInfo | papi-dts

    Type AliasScrollGroupUpdateInfo

    ScrollGroupUpdateInfo: {
        scrollGroupId: ScrollGroupId;
        scrRef: ScriptureReference;
    }

    Information about an update to a scroll group. Informs about the new ScriptureReference at a ScrollGroupId

    -

    Settings

    Member Visibility
    +

    Settings

    Member Visibility
    diff --git a/papi-dts/types/_shared_services_settings_service_model_.AllSettingsData.html b/papi-dts/types/_shared_services_settings_service_model_.AllSettingsData.html index 29895149fa..d2c2259e3c 100644 --- a/papi-dts/types/_shared_services_settings_service_model_.AllSettingsData.html +++ b/papi-dts/types/_shared_services_settings_service_model_.AllSettingsData.html @@ -1 +1 @@ -AllSettingsData | papi-dts

    Type AliasAllSettingsData

    AllSettingsData: {
        [SettingName in SettingNames]: SettingTypes[SettingName]
    }

    Settings

    Member Visibility
    +AllSettingsData | papi-dts

    Type AliasAllSettingsData

    AllSettingsData: {
        [SettingName in SettingNames]: SettingTypes[SettingName]
    }

    Settings

    Member Visibility
    diff --git a/papi-dts/types/_shared_services_settings_service_model_.AllSettingsValidators.html b/papi-dts/types/_shared_services_settings_service_model_.AllSettingsValidators.html index c58174258e..6b9c049b89 100644 --- a/papi-dts/types/_shared_services_settings_service_model_.AllSettingsValidators.html +++ b/papi-dts/types/_shared_services_settings_service_model_.AllSettingsValidators.html @@ -1,2 +1,2 @@ AllSettingsValidators | papi-dts

    Type AliasAllSettingsValidators

    AllSettingsValidators: {
        [SettingName in SettingNames]: SettingValidator<SettingName>
    }

    Validators for all settings. Keys are setting keys, values are functions to validate new settings

    -

    Settings

    Member Visibility
    +

    Settings

    Member Visibility
    diff --git a/papi-dts/types/_shared_services_settings_service_model_.ISettingsService.html b/papi-dts/types/_shared_services_settings_service_model_.ISettingsService.html index 69361e02ba..8b318a4a1a 100644 --- a/papi-dts/types/_shared_services_settings_service_model_.ISettingsService.html +++ b/papi-dts/types/_shared_services_settings_service_model_.ISettingsService.html @@ -3,30 +3,30 @@

    Returns Promise<SettingTypes[SettingName]>

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

    Throws

    If no default value is available for the setting.

    -
  • getLocalizedSettingsContributionInfo:function
  • getLocalizedSettingsContributionInfo:function
  • registerValidator:function
  • registerValidator:function
  • reset:function
  • reset:function
  • set:function
  • set:function
  • subscribe:function
  • subscribe:function
  • validateSetting:function
  • validateSetting:function

    • Settings

    Member Visibility
    +
  • OptionalallChanges: Partial<SettingTypes>

    • Returns Promise<boolean>

    Settings

    Member Visibility
    diff --git a/papi-dts/types/_shared_services_settings_service_model_.SettingDataTypes.html b/papi-dts/types/_shared_services_settings_service_model_.SettingDataTypes.html index 37e26af53a..a105a51e41 100644 --- a/papi-dts/types/_shared_services_settings_service_model_.SettingDataTypes.html +++ b/papi-dts/types/_shared_services_settings_service_model_.SettingDataTypes.html @@ -10,4 +10,4 @@ 
    '': DataProviderDataType<SettingName, SettingTypes[SettingName], SettingTypes[SettingName]>;
    -

    Settings

    Member Visibility
    +

    Settings

    Member Visibility
    diff --git a/papi-dts/types/_shared_services_settings_service_model_.SettingValidator.html b/papi-dts/types/_shared_services_settings_service_model_.SettingValidator.html index ca4dcbec75..f3f67a0fe3 100644 --- a/papi-dts/types/_shared_services_settings_service_model_.SettingValidator.html +++ b/papi-dts/types/_shared_services_settings_service_model_.SettingValidator.html @@ -1,2 +1,2 @@ SettingValidator | papi-dts

    Type AliasSettingValidator<SettingName>

    SettingValidator<SettingName>: ((newValue: SettingTypes[SettingName], currentValue: SettingTypes[SettingName], allChanges: Partial<SettingTypes>) => Promise<boolean>)

    Function that validates whether a new setting value should be allowed to be set

    -

    Type Parameters

    Settings

    Member Visibility
    +

    Type Parameters

    Settings

    Member Visibility
    diff --git a/papi-dts/types/_shared_services_web_view_service_model_.CloseWebViewEvent.html b/papi-dts/types/_shared_services_web_view_service_model_.CloseWebViewEvent.html index 37e81253f5..2c8fb63d8f 100644 --- a/papi-dts/types/_shared_services_web_view_service_model_.CloseWebViewEvent.html +++ b/papi-dts/types/_shared_services_web_view_service_model_.CloseWebViewEvent.html @@ -1,2 +1,2 @@ CloseWebViewEvent | papi-dts

    Type AliasCloseWebViewEvent

    CloseWebViewEvent: {
        webView: SavedWebViewDefinition;
    }

    Event emitted when webViews are closed

    -

    Settings

    Member Visibility
    +

    Settings

    Member Visibility
    diff --git a/papi-dts/types/_shared_services_web_view_service_model_.OpenWebViewEvent.html b/papi-dts/types/_shared_services_web_view_service_model_.OpenWebViewEvent.html index 9159d4309b..13872411fc 100644 --- a/papi-dts/types/_shared_services_web_view_service_model_.OpenWebViewEvent.html +++ b/papi-dts/types/_shared_services_web_view_service_model_.OpenWebViewEvent.html @@ -1,2 +1,2 @@ OpenWebViewEvent | papi-dts

    Type AliasOpenWebViewEvent

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

    Event emitted when webViews are created

    -

    Settings

    Member Visibility
    +

    Settings

    Member Visibility
    diff --git a/papi-dts/types/_shared_services_web_view_service_model_.UpdateWebViewEvent.html b/papi-dts/types/_shared_services_web_view_service_model_.UpdateWebViewEvent.html index 3c9626df9a..44ac3cbb2c 100644 --- a/papi-dts/types/_shared_services_web_view_service_model_.UpdateWebViewEvent.html +++ b/papi-dts/types/_shared_services_web_view_service_model_.UpdateWebViewEvent.html @@ -1,2 +1,2 @@ UpdateWebViewEvent | papi-dts

    Type AliasUpdateWebViewEvent

    UpdateWebViewEvent: {
        webView: SavedWebViewDefinition;
    }

    Event emitted when webViews are updated

    -

    Settings

    Member Visibility
    +

    Settings

    Member Visibility
    diff --git a/papi-dts/types/_shared_services_web_view_service_model_.WebViewMessageRequestHandler.html b/papi-dts/types/_shared_services_web_view_service_model_.WebViewMessageRequestHandler.html index 036cdbb562..45f6e59250 100644 --- a/papi-dts/types/_shared_services_web_view_service_model_.WebViewMessageRequestHandler.html +++ b/papi-dts/types/_shared_services_web_view_service_model_.WebViewMessageRequestHandler.html @@ -1,4 +1,4 @@ WebViewMessageRequestHandler | papi-dts

    Type AliasWebViewMessageRequestHandler

    WebViewMessageRequestHandler: ((webViewNonce: string, message: unknown, targetOrigin?: string) => Promise<void>)

    Type of function to receive messages sent to a web view.

    See web-view-provider.service.ts's postMessageToWebView and web-view.component for information on this type

    -

    Settings

    Member Visibility
    +

    Settings

    Member Visibility
    diff --git a/papi-dts/types/_shared_utils_project_settings_document_combiner_.AllProjectSettingsInfo.html b/papi-dts/types/_shared_utils_project_settings_document_combiner_.AllProjectSettingsInfo.html index c723392b3b..68e604760b 100644 --- a/papi-dts/types/_shared_utils_project_settings_document_combiner_.AllProjectSettingsInfo.html +++ b/papi-dts/types/_shared_utils_project_settings_document_combiner_.AllProjectSettingsInfo.html @@ -1,2 +1,2 @@ AllProjectSettingsInfo | papi-dts

    Type AliasAllProjectSettingsInfo

    AllProjectSettingsInfo: {
        [ProjectSettingName in ProjectSettingNames]: ProjectSettingInfo<ProjectSettingName>
    }

    Information about all settings. Keys are setting keys, values are information for that setting

    -

    Settings

    Member Visibility
    +

    Settings

    Member Visibility
    diff --git a/papi-dts/types/_shared_utils_project_settings_document_combiner_.LocalizedProjectSettingsContributionInfo.html b/papi-dts/types/_shared_utils_project_settings_document_combiner_.LocalizedProjectSettingsContributionInfo.html index 0f5831928e..7b7f039f01 100644 --- a/papi-dts/types/_shared_utils_project_settings_document_combiner_.LocalizedProjectSettingsContributionInfo.html +++ b/papi-dts/types/_shared_utils_project_settings_document_combiner_.LocalizedProjectSettingsContributionInfo.html @@ -1 +1 @@ -LocalizedProjectSettingsContributionInfo | papi-dts

    Type AliasLocalizedProjectSettingsContributionInfo

    LocalizedProjectSettingsContributionInfo: Localized<ProjectSettingsContributionInfo>

    Settings

    Member Visibility
    +LocalizedProjectSettingsContributionInfo | papi-dts

    Type AliasLocalizedProjectSettingsContributionInfo

    LocalizedProjectSettingsContributionInfo: Localized<ProjectSettingsContributionInfo>

    Settings

    Member Visibility
    diff --git a/papi-dts/types/_shared_utils_project_settings_document_combiner_.ProjectSettingInfo.html b/papi-dts/types/_shared_utils_project_settings_document_combiner_.ProjectSettingInfo.html index e86e5d989a..c5b7f2262d 100644 --- a/papi-dts/types/_shared_utils_project_settings_document_combiner_.ProjectSettingInfo.html +++ b/papi-dts/types/_shared_utils_project_settings_document_combiner_.ProjectSettingInfo.html @@ -1,3 +1,3 @@ ProjectSettingInfo | papi-dts

    Type AliasProjectSettingInfo<ProjectSettingName>

    ProjectSettingInfo<ProjectSettingName>: ProjectSetting & {
        default: ProjectSettingTypes[ProjectSettingName];
    }

    Information about one specific setting. Basically just Setting but with specific default type info

    -

    Type Parameters

    Settings

    Member Visibility
    +

    Type Parameters

    Settings

    Member Visibility
    diff --git a/papi-dts/types/_shared_utils_project_settings_document_combiner_.ProjectSettingsContributionInfo.html b/papi-dts/types/_shared_utils_project_settings_document_combiner_.ProjectSettingsContributionInfo.html index 8ab651c954..16466b356e 100644 --- a/papi-dts/types/_shared_utils_project_settings_document_combiner_.ProjectSettingsContributionInfo.html +++ b/papi-dts/types/_shared_utils_project_settings_document_combiner_.ProjectSettingsContributionInfo.html @@ -1,4 +1,4 @@ ProjectSettingsContributionInfo | papi-dts

    Type AliasProjectSettingsContributionInfo

    ProjectSettingsContributionInfo: {
        contributions: {
            [extensionName: string]: ProjectSettingsGroup[] | undefined;
        };
        settings: Partial<AllProjectSettingsInfo>;
    }

    Type declaration

    • contributions: {
          [extensionName: string]: ProjectSettingsGroup[] | undefined;
      }

      Map of extension name to that extension's provided settings groups if provided

      • [extensionName: string]: ProjectSettingsGroup[] | undefined
    • settings: Partial<AllProjectSettingsInfo>

      Map of setting name to setting definition. For type specificity and ease of accessing settings since they're a bit hard to find in contributions

      -

    Settings

    Member Visibility
    +

    Settings

    Member Visibility
    diff --git a/papi-dts/types/_shared_utils_settings_document_combiner_base_.AllSettingsInfo.html b/papi-dts/types/_shared_utils_settings_document_combiner_base_.AllSettingsInfo.html index c3f2418e6b..da22012f44 100644 --- a/papi-dts/types/_shared_utils_settings_document_combiner_base_.AllSettingsInfo.html +++ b/papi-dts/types/_shared_utils_settings_document_combiner_base_.AllSettingsInfo.html @@ -1,2 +1,2 @@ AllSettingsInfo | papi-dts

    Type AliasAllSettingsInfo

    AllSettingsInfo: {
        [SettingName in SettingNames]: SettingInfo<SettingName>
    }

    Information about all settings. Keys are setting keys, values are information for that setting

    -

    Settings

    Member Visibility
    +

    Settings

    Member Visibility
    diff --git a/papi-dts/types/_shared_utils_settings_document_combiner_base_.LocalizedSettingsContributionInfo.html b/papi-dts/types/_shared_utils_settings_document_combiner_base_.LocalizedSettingsContributionInfo.html index b0632195c1..696407c1af 100644 --- a/papi-dts/types/_shared_utils_settings_document_combiner_base_.LocalizedSettingsContributionInfo.html +++ b/papi-dts/types/_shared_utils_settings_document_combiner_base_.LocalizedSettingsContributionInfo.html @@ -1 +1 @@ -LocalizedSettingsContributionInfo | papi-dts

    Type AliasLocalizedSettingsContributionInfo

    LocalizedSettingsContributionInfo: Localized<SettingsContributionInfo>

    Settings

    Member Visibility
    +LocalizedSettingsContributionInfo | papi-dts

    Type AliasLocalizedSettingsContributionInfo

    LocalizedSettingsContributionInfo: Localized<SettingsContributionInfo>

    Settings

    Member Visibility
    diff --git a/papi-dts/types/_shared_utils_settings_document_combiner_base_.SettingInfo.html b/papi-dts/types/_shared_utils_settings_document_combiner_base_.SettingInfo.html index 002fdaaf5a..e5b94592ce 100644 --- a/papi-dts/types/_shared_utils_settings_document_combiner_base_.SettingInfo.html +++ b/papi-dts/types/_shared_utils_settings_document_combiner_base_.SettingInfo.html @@ -1,3 +1,3 @@ SettingInfo | papi-dts

    Type AliasSettingInfo<SettingName>

    SettingInfo<SettingName>: Setting & {
        default: SettingTypes[SettingName];
    }

    Information about one specific setting. Basically just Setting but with specific default type info

    -

    Type Parameters

    Settings

    Member Visibility
    +

    Type Parameters

    Settings

    Member Visibility
    diff --git a/papi-dts/types/_shared_utils_settings_document_combiner_base_.SettingsContributionInfo.html b/papi-dts/types/_shared_utils_settings_document_combiner_base_.SettingsContributionInfo.html index c5902e7c77..5085078843 100644 --- a/papi-dts/types/_shared_utils_settings_document_combiner_base_.SettingsContributionInfo.html +++ b/papi-dts/types/_shared_utils_settings_document_combiner_base_.SettingsContributionInfo.html @@ -1,4 +1,4 @@ SettingsContributionInfo | papi-dts

    Type AliasSettingsContributionInfo

    SettingsContributionInfo: {
        contributions: {
            [extensionName: string]: SettingsGroup[] | undefined;
        };
        settings: Partial<AllSettingsInfo>;
    }

    Type declaration

    • contributions: {
          [extensionName: string]: SettingsGroup[] | undefined;
      }

      Map of extension name to that extension's provided settings groups if provided

      • [extensionName: string]: SettingsGroup[] | undefined
    • settings: Partial<AllSettingsInfo>

      Map of setting name to setting definition. For type specificity and ease of accessing settings since they're a bit hard to find in contributions

      -

    Settings

    Member Visibility
    +

    Settings

    Member Visibility
    diff --git a/papi-dts/types/_shared_utils_util_.RequestType.html b/papi-dts/types/_shared_utils_util_.RequestType.html index a0ece89e57..3ecad5d64b 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 AliasRequestType

    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
    +

    Settings

    Member Visibility
    diff --git a/papi-dts/types/_shared_utils_util_.SerializedRequestType.html b/papi-dts/types/_shared_utils_util_.SerializedRequestType.html index 53750d3e53..de76e3b30a 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 AliasSerializedRequestType

    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
    +

    Settings

    Member Visibility
    diff --git a/papi-dts/variables/__papi_backend_.BaseProjectDataProviderEngine.html b/papi-dts/variables/__papi_backend_.BaseProjectDataProviderEngine.html index 770bcdff3a..3073f415ba 100644 --- a/papi-dts/variables/__papi_backend_.BaseProjectDataProviderEngine.html +++ b/papi-dts/variables/__papi_backend_.BaseProjectDataProviderEngine.html @@ -7,4 +7,4 @@

    See

    IBaseProjectDataProviderEngine for more information on extending this class.

    -

    Settings

    Member Visibility
    +

    Settings

    Member Visibility
    diff --git a/papi-dts/variables/__papi_backend_.DataProviderEngine.html b/papi-dts/variables/__papi_backend_.DataProviderEngine.html index cd1ddfc113..f3752ded80 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
    +

    Settings

    Member Visibility
    diff --git a/papi-dts/variables/__papi_backend_.LayeringProjectDataProviderEngineFactory.html b/papi-dts/variables/__papi_backend_.LayeringProjectDataProviderEngineFactory.html index a8321aca46..762a5a55f9 100644 --- a/papi-dts/variables/__papi_backend_.LayeringProjectDataProviderEngineFactory.html +++ b/papi-dts/variables/__papi_backend_.LayeringProjectDataProviderEngineFactory.html @@ -5,4 +5,4 @@ highly recommend extending this class. Please see IProjectDataProviderEngineFactory.getAvailableProjects for more information on the requirements.

    -

    Settings

    Member Visibility
    +

    Settings

    Member Visibility
    diff --git a/papi-dts/variables/__papi_backend_.ProjectDataProviderEngine.html b/papi-dts/variables/__papi_backend_.ProjectDataProviderEngine.html index 9fbc6daa00..616458b8fd 100644 --- a/papi-dts/variables/__papi_backend_.ProjectDataProviderEngine.html +++ b/papi-dts/variables/__papi_backend_.ProjectDataProviderEngine.html @@ -7,4 +7,4 @@

    See

    IProjectDataProviderEngine for more information on extending this class.

    -

    Settings

    Member Visibility
    +

    Settings

    Member Visibility
    diff --git a/papi-dts/variables/__papi_backend_.WebViewFactory.html b/papi-dts/variables/__papi_backend_.WebViewFactory.html index a59e25798e..656d94f93c 100644 --- a/papi-dts/variables/__papi_backend_.WebViewFactory.html +++ b/papi-dts/variables/__papi_backend_.WebViewFactory.html @@ -13,4 +13,4 @@ want to overwrite this class's getWebView because that will eliminate most of the benefits associated with using this class.

    See

    IWebViewProvider for more information on extending this class.

    -

    Settings

    Member Visibility
    +

    Settings

    Member Visibility
    diff --git a/papi-dts/variables/__papi_backend_.commands.html b/papi-dts/variables/__papi_backend_.commands.html index 222babe361..0feee34aa6 100644 --- a/papi-dts/variables/__papi_backend_.commands.html +++ b/papi-dts/variables/__papi_backend_.commands.html @@ -1,4 +1,4 @@ commands | papi-dts

    VariablecommandsConst

    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
    +

    Settings

    Member Visibility
    diff --git a/papi-dts/variables/__papi_backend_.dataProviders.html b/papi-dts/variables/__papi_backend_.dataProviders.html index ad04ce63cf..d1beaca69a 100644 --- a/papi-dts/variables/__papi_backend_.dataProviders.html +++ b/papi-dts/variables/__papi_backend_.dataProviders.html @@ -1,2 +1,2 @@ dataProviders | papi-dts

    VariabledataProvidersConst

    dataProviders: DataProviderService

    Service that allows extensions to send and receive data to/from other extensions

    -

    Settings

    Member Visibility
    +

    Settings

    Member Visibility
    diff --git a/papi-dts/variables/__papi_backend_.default.html b/papi-dts/variables/__papi_backend_.default.html index 18fcf211d1..485123e48c 100644 --- a/papi-dts/variables/__papi_backend_.default.html +++ b/papi-dts/variables/__papi_backend_.default.html @@ -89,4 +89,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
    +

    Settings

    Member Visibility
    diff --git a/papi-dts/variables/__papi_backend_.dialogs.html b/papi-dts/variables/__papi_backend_.dialogs.html index 54916c8a66..b7659a7cc6 100644 --- a/papi-dts/variables/__papi_backend_.dialogs.html +++ b/papi-dts/variables/__papi_backend_.dialogs.html @@ -1,2 +1,2 @@ dialogs | papi-dts

    VariabledialogsConst

    dialogs: DialogService

    Prompt the user for responses with dialogs

    -

    Settings

    Member Visibility
    +

    Settings

    Member Visibility
    diff --git a/papi-dts/variables/__papi_backend_.internet.html b/papi-dts/variables/__papi_backend_.internet.html index 89ea856f0d..65c5ee3432 100644 --- a/papi-dts/variables/__papi_backend_.internet.html +++ b/papi-dts/variables/__papi_backend_.internet.html @@ -1,2 +1,2 @@ internet | papi-dts

    VariableinternetConst

    internet: InternetService

    Service that provides a way to call fetch since the original function is not available

    -

    Settings

    Member Visibility
    +

    Settings

    Member Visibility
    diff --git a/papi-dts/variables/__papi_backend_.localization.html b/papi-dts/variables/__papi_backend_.localization.html index 84881419a4..60a8a0e947 100644 --- a/papi-dts/variables/__papi_backend_.localization.html +++ b/papi-dts/variables/__papi_backend_.localization.html @@ -1,2 +1,2 @@ localization | papi-dts

    VariablelocalizationConst

    localization: ILocalizationService

    Service that allows to get and store localizations

    -

    Settings

    Member Visibility
    +

    Settings

    Member Visibility
    diff --git a/papi-dts/variables/__papi_backend_.logger.html b/papi-dts/variables/__papi_backend_.logger.html index 4f310ccaa2..77a343b566 100644 --- a/papi-dts/variables/__papi_backend_.logger.html +++ b/papi-dts/variables/__papi_backend_.logger.html @@ -1,2 +1,2 @@ logger | papi-dts

    VariableloggerConst

    logger: MainLogger & {
        default: MainLogger;
    }

    All extensions and services should use this logger to provide a unified output of logs

    -

    Settings

    Member Visibility
    +

    Settings

    Member Visibility
    diff --git a/papi-dts/variables/__papi_backend_.menuData.html b/papi-dts/variables/__papi_backend_.menuData.html index 7254b56b39..dd16143f9d 100644 --- a/papi-dts/variables/__papi_backend_.menuData.html +++ b/papi-dts/variables/__papi_backend_.menuData.html @@ -1,2 +1,2 @@ menuData | papi-dts

    VariablemenuDataConst

    menuData: IMenuDataService

    Service that allows to get and store menu data

    -

    Settings

    Member Visibility
    +

    Settings

    Member Visibility
    diff --git a/papi-dts/variables/__papi_backend_.network.html b/papi-dts/variables/__papi_backend_.network.html index 55db0594ad..9de8b58b12 100644 --- a/papi-dts/variables/__papi_backend_.network.html +++ b/papi-dts/variables/__papi_backend_.network.html @@ -1,2 +1,2 @@ network | papi-dts

    VariablenetworkConst

    network: PapiNetworkService

    Service that provides a way to send and receive network events

    -

    Settings

    Member Visibility
    +

    Settings

    Member Visibility
    diff --git a/papi-dts/variables/__papi_backend_.networkObjectStatus.html b/papi-dts/variables/__papi_backend_.networkObjectStatus.html index f35de93583..ef0c0802b7 100644 --- a/papi-dts/variables/__papi_backend_.networkObjectStatus.html +++ b/papi-dts/variables/__papi_backend_.networkObjectStatus.html @@ -1,2 +1,2 @@ networkObjectStatus | papi-dts

    VariablenetworkObjectStatusConst

    networkObjectStatus: NetworkObjectStatusServiceType

    Provides functions related to the set of available network objects

    -

    Settings

    Member Visibility
    +

    Settings

    Member Visibility
    diff --git a/papi-dts/variables/__papi_backend_.networkObjects.html b/papi-dts/variables/__papi_backend_.networkObjects.html index 29290257ac..7cf31faa24 100644 --- a/papi-dts/variables/__papi_backend_.networkObjects.html +++ b/papi-dts/variables/__papi_backend_.networkObjects.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
    +

    Settings

    Member Visibility
    diff --git a/papi-dts/variables/__papi_backend_.projectDataProviders.html b/papi-dts/variables/__papi_backend_.projectDataProviders.html index 1650b25886..70f475a080 100644 --- a/papi-dts/variables/__papi_backend_.projectDataProviders.html +++ b/papi-dts/variables/__papi_backend_.projectDataProviders.html @@ -1,2 +1,2 @@ projectDataProviders | papi-dts

    VariableprojectDataProvidersConst

    projectDataProviders: PapiBackendProjectDataProviderService

    Service that registers and gets project data providers

    -

    Settings

    Member Visibility
    +

    Settings

    Member Visibility
    diff --git a/papi-dts/variables/__papi_backend_.projectLookup.html b/papi-dts/variables/__papi_backend_.projectLookup.html index 47d215f869..b103aa3464 100644 --- a/papi-dts/variables/__papi_backend_.projectLookup.html +++ b/papi-dts/variables/__papi_backend_.projectLookup.html @@ -2,4 +2,4 @@

    Note: this service runs locally everywhere in the TypeScript processes. It is also exposed on the PAPI websocket. Note these functions are all asynchronous on the PAPI websocket regardless of if their types are synchronous locally.

    -

    Settings

    Member Visibility
    +

    Settings

    Member Visibility
    diff --git a/papi-dts/variables/__papi_backend_.projectSettings.html b/papi-dts/variables/__papi_backend_.projectSettings.html index 02573916ec..03932aef49 100644 --- a/papi-dts/variables/__papi_backend_.projectSettings.html +++ b/papi-dts/variables/__papi_backend_.projectSettings.html @@ -1,2 +1,2 @@ projectSettings | papi-dts

    VariableprojectSettingsConst

    projectSettings: IProjectSettingsService

    Provides utility functions that project data providers should call when handling project settings

    -

    Settings

    Member Visibility
    +

    Settings

    Member Visibility
    diff --git a/papi-dts/variables/__papi_backend_.scrollGroups.html b/papi-dts/variables/__papi_backend_.scrollGroups.html index 4f7987165f..7133dff323 100644 --- a/papi-dts/variables/__papi_backend_.scrollGroups.html +++ b/papi-dts/variables/__papi_backend_.scrollGroups.html @@ -1,2 +1,2 @@ scrollGroups | papi-dts

    VariablescrollGroupsConst

    scrollGroups: IScrollGroupService

    Provides functions related to scroll groups and Scripture references at those scroll groups

    -

    Settings

    Member Visibility
    +

    Settings

    Member Visibility
    diff --git a/papi-dts/variables/__papi_backend_.settings.html b/papi-dts/variables/__papi_backend_.settings.html index 49af3750b1..7de039a2d0 100644 --- a/papi-dts/variables/__papi_backend_.settings.html +++ b/papi-dts/variables/__papi_backend_.settings.html @@ -1 +1 @@ -settings | papi-dts

    VariablesettingsConst

    settings: ISettingsService

    Settings

    Member Visibility
    +settings | papi-dts

    VariablesettingsConst

    settings: ISettingsService

    Settings

    Member Visibility
    diff --git a/papi-dts/variables/__papi_backend_.storage.html b/papi-dts/variables/__papi_backend_.storage.html index 6640175a8e..ab74c9f270 100644 --- a/papi-dts/variables/__papi_backend_.storage.html +++ b/papi-dts/variables/__papi_backend_.storage.html @@ -1,4 +1,4 @@ storage | papi-dts

    VariablestorageConst

    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
    +

    Settings

    Member Visibility
    diff --git a/papi-dts/variables/__papi_backend_.webViewProviders.html b/papi-dts/variables/__papi_backend_.webViewProviders.html index 1b967cb9f4..c559c5ca41 100644 --- a/papi-dts/variables/__papi_backend_.webViewProviders.html +++ b/papi-dts/variables/__papi_backend_.webViewProviders.html @@ -1,3 +1,3 @@ webViewProviders | papi-dts

    VariablewebViewProvidersConst

    webViewProviders: PapiWebViewProviderService

    Interface for registering webView providers, registering webView controllers, and performing privileged interactions with web views

    -

    Settings

    Member Visibility
    +

    Settings

    Member Visibility
    diff --git a/papi-dts/variables/__papi_backend_.webViews.html b/papi-dts/variables/__papi_backend_.webViews.html index 617fc47869..1f12bbdc3a 100644 --- a/papi-dts/variables/__papi_backend_.webViews.html +++ b/papi-dts/variables/__papi_backend_.webViews.html @@ -1,4 +1,4 @@ webViews | papi-dts

    VariablewebViewsConst

    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
    +

    Settings

    Member Visibility
    diff --git a/papi-dts/variables/__papi_core_.default.html b/papi-dts/variables/__papi_core_.default.html index 7822307c3e..6f5c2b350c 100644 --- a/papi-dts/variables/__papi_core_.default.html +++ b/papi-dts/variables/__papi_core_.default.html @@ -1,2 +1,2 @@ default | papi-dts

    VariabledefaultConst

    default: {}

    Exporting empty object so people don't have to put 'type' in their import statements

    -

    Settings

    Member Visibility
    +

    Settings

    Member Visibility
    diff --git a/papi-dts/variables/__papi_frontend_.WebSocket.html b/papi-dts/variables/__papi_frontend_.WebSocket.html index a1e9d1c865..f878cadb35 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
    +

    Settings

    Member Visibility
    diff --git a/papi-dts/variables/__papi_frontend_.XMLHttpRequest.html b/papi-dts/variables/__papi_frontend_.XMLHttpRequest.html index 4f6cebc933..1a8a12c8a6 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
    +

    Settings

    Member Visibility
    diff --git a/papi-dts/variables/__papi_frontend_.commands.html b/papi-dts/variables/__papi_frontend_.commands.html index f59afd6993..e54f7e55a4 100644 --- a/papi-dts/variables/__papi_frontend_.commands.html +++ b/papi-dts/variables/__papi_frontend_.commands.html @@ -1,4 +1,4 @@ commands | papi-dts

    VariablecommandsConst

    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
    +

    Settings

    Member Visibility
    diff --git a/papi-dts/variables/__papi_frontend_.dataProviders.html b/papi-dts/variables/__papi_frontend_.dataProviders.html index c7ca4db315..927b59361f 100644 --- a/papi-dts/variables/__papi_frontend_.dataProviders.html +++ b/papi-dts/variables/__papi_frontend_.dataProviders.html @@ -1,2 +1,2 @@ dataProviders | papi-dts

    VariabledataProvidersConst

    dataProviders: DataProviderService

    Service that allows extensions to send and receive data to/from other extensions

    -

    Settings

    Member Visibility
    +

    Settings

    Member Visibility
    diff --git a/papi-dts/variables/__papi_frontend_.default.html b/papi-dts/variables/__papi_frontend_.default.html index 794ef963bc..02151b9f2c 100644 --- a/papi-dts/variables/__papi_frontend_.default.html +++ b/papi-dts/variables/__papi_frontend_.default.html @@ -27,4 +27,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
    +

    Settings

    Member Visibility
    diff --git a/papi-dts/variables/__papi_frontend_.dialogs.html b/papi-dts/variables/__papi_frontend_.dialogs.html index 7d8ef749c3..cd132f5443 100644 --- a/papi-dts/variables/__papi_frontend_.dialogs.html +++ b/papi-dts/variables/__papi_frontend_.dialogs.html @@ -1,2 +1,2 @@ dialogs | papi-dts

    VariabledialogsConst

    dialogs: DialogService

    Prompt the user for responses with dialogs

    -

    Settings

    Member Visibility
    +

    Settings

    Member Visibility
    diff --git a/papi-dts/variables/__papi_frontend_.internet.html b/papi-dts/variables/__papi_frontend_.internet.html index dd1221309b..633c624293 100644 --- a/papi-dts/variables/__papi_frontend_.internet.html +++ b/papi-dts/variables/__papi_frontend_.internet.html @@ -1,2 +1,2 @@ internet | papi-dts

    VariableinternetConst

    internet: InternetService

    Service that provides a way to call fetch since the original function is not available

    -

    Settings

    Member Visibility
    +

    Settings

    Member Visibility
    diff --git a/papi-dts/variables/__papi_frontend_.localization.html b/papi-dts/variables/__papi_frontend_.localization.html index 5b4704d32b..c6f2cf65cd 100644 --- a/papi-dts/variables/__papi_frontend_.localization.html +++ b/papi-dts/variables/__papi_frontend_.localization.html @@ -1,2 +1,2 @@ localization | papi-dts

    VariablelocalizationConst

    localization: ILocalizationService

    Service that allows to get and store localizations

    -

    Settings

    Member Visibility
    +

    Settings

    Member Visibility
    diff --git a/papi-dts/variables/__papi_frontend_.logger.html b/papi-dts/variables/__papi_frontend_.logger.html index 6a60c09aec..87c99c3d99 100644 --- a/papi-dts/variables/__papi_frontend_.logger.html +++ b/papi-dts/variables/__papi_frontend_.logger.html @@ -1,2 +1,2 @@ logger | papi-dts

    VariableloggerConst

    logger: MainLogger & {
        default: MainLogger;
    }

    All extensions and services should use this logger to provide a unified output of logs

    -

    Settings

    Member Visibility
    +

    Settings

    Member Visibility
    diff --git a/papi-dts/variables/__papi_frontend_.menuData.html b/papi-dts/variables/__papi_frontend_.menuData.html index 31be097e48..c3701ec05d 100644 --- a/papi-dts/variables/__papi_frontend_.menuData.html +++ b/papi-dts/variables/__papi_frontend_.menuData.html @@ -1,2 +1,2 @@ menuData | papi-dts

    VariablemenuDataConst

    menuData: IMenuDataService

    Service that allows to get and store menu data

    -

    Settings

    Member Visibility
    +

    Settings

    Member Visibility
    diff --git a/papi-dts/variables/__papi_frontend_.network.html b/papi-dts/variables/__papi_frontend_.network.html index 6651eb960e..c7ee597d4c 100644 --- a/papi-dts/variables/__papi_frontend_.network.html +++ b/papi-dts/variables/__papi_frontend_.network.html @@ -1,2 +1,2 @@ network | papi-dts

    VariablenetworkConst

    network: PapiNetworkService

    Service that provides a way to send and receive network events

    -

    Settings

    Member Visibility
    +

    Settings

    Member Visibility
    diff --git a/papi-dts/variables/__papi_frontend_.projectDataProviders.html b/papi-dts/variables/__papi_frontend_.projectDataProviders.html index e4e6259914..650ab50512 100644 --- a/papi-dts/variables/__papi_frontend_.projectDataProviders.html +++ b/papi-dts/variables/__papi_frontend_.projectDataProviders.html @@ -1,2 +1,2 @@ projectDataProviders | papi-dts

    VariableprojectDataProvidersConst

    projectDataProviders: PapiFrontendProjectDataProviderService

    Service that registers and gets project data providers

    -

    Settings

    Member Visibility
    +

    Settings

    Member Visibility
    diff --git a/papi-dts/variables/__papi_frontend_.projectLookup.html b/papi-dts/variables/__papi_frontend_.projectLookup.html index e055dd9c97..cc25a957a3 100644 --- a/papi-dts/variables/__papi_frontend_.projectLookup.html +++ b/papi-dts/variables/__papi_frontend_.projectLookup.html @@ -2,4 +2,4 @@

    Note: this service runs locally everywhere in the TypeScript processes. It is also exposed on the PAPI websocket. Note these functions are all asynchronous on the PAPI websocket regardless of if their types are synchronous locally.

    -

    Settings

    Member Visibility
    +

    Settings

    Member Visibility
    diff --git a/papi-dts/variables/__papi_frontend_.react.html b/papi-dts/variables/__papi_frontend_.react.html index 4b1fb55649..1fba768319 100644 --- a/papi-dts/variables/__papi_frontend_.react.html +++ b/papi-dts/variables/__papi_frontend_.react.html @@ -1,2 +1,2 @@ react | papi-dts

    VariablereactConst

    react: typeof "@papi/frontend/react"

    React hooks that enable interacting with the papi in React components more easily.

    -

    Settings

    Member Visibility
    +

    Settings

    Member Visibility
    diff --git a/papi-dts/variables/__papi_frontend_.scrollGroups.html b/papi-dts/variables/__papi_frontend_.scrollGroups.html index fe3b9aa99e..80fd4e37a2 100644 --- a/papi-dts/variables/__papi_frontend_.scrollGroups.html +++ b/papi-dts/variables/__papi_frontend_.scrollGroups.html @@ -1,2 +1,2 @@ scrollGroups | papi-dts

    VariablescrollGroupsConst

    scrollGroups: IScrollGroupService

    Provides functions related to scroll groups and Scripture references at those scroll groups

    -

    Settings

    Member Visibility
    +

    Settings

    Member Visibility
    diff --git a/papi-dts/variables/__papi_frontend_.settings.html b/papi-dts/variables/__papi_frontend_.settings.html index b89c23715f..5e2ee59728 100644 --- a/papi-dts/variables/__papi_frontend_.settings.html +++ b/papi-dts/variables/__papi_frontend_.settings.html @@ -1 +1 @@ -settings | papi-dts

    VariablesettingsConst

    settings: ISettingsService

    Settings

    Member Visibility
    +settings | papi-dts

    VariablesettingsConst

    settings: ISettingsService

    Settings

    Member Visibility
    diff --git a/papi-dts/variables/__papi_frontend_.webViews.html b/papi-dts/variables/__papi_frontend_.webViews.html index 195051a981..0663a471c2 100644 --- a/papi-dts/variables/__papi_frontend_.webViews.html +++ b/papi-dts/variables/__papi_frontend_.webViews.html @@ -1,4 +1,4 @@ webViews | papi-dts

    VariablewebViewsConst

    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
    +

    Settings

    Member Visibility
    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 08f51ab7c4..b19e442536 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

    VariabledefaultConst

    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
    +

    Settings

    Member Visibility
    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 e9ac6ddef1..26b5f37c66 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

    VariabledefaultConst

    default: {
        registerExtension: typeof registerExtension;
        tokenIsValid: typeof tokenIsValid;
        unregisterExtension: typeof unregisterExtension;
    }

    Settings

    Member Visibility
    +default | papi-dts

    VariabledefaultConst

    default: {
        registerExtension: typeof registerExtension;
        tokenIsValid: typeof tokenIsValid;
        unregisterExtension: typeof unregisterExtension;
    }

    Settings

    Member Visibility
    diff --git a/papi-dts/variables/_node_utils_util_.FILE_PROTOCOL.html b/papi-dts/variables/_node_utils_util_.FILE_PROTOCOL.html index fdeec04424..5067825715 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

    VariableFILE_PROTOCOLConst

    FILE_PROTOCOL: "file://" = 'file://'

    Settings

    Member Visibility
    +FILE_PROTOCOL | papi-dts

    VariableFILE_PROTOCOLConst

    FILE_PROTOCOL: "file://" = 'file://'

    Settings

    Member Visibility
    diff --git a/papi-dts/variables/_node_utils_util_.RESOURCES_PROTOCOL.html b/papi-dts/variables/_node_utils_util_.RESOURCES_PROTOCOL.html index 3c9f01594e..29106cac2e 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

    VariableRESOURCES_PROTOCOLConst

    RESOURCES_PROTOCOL: "resources://" = 'resources://'

    Settings

    Member Visibility
    +RESOURCES_PROTOCOL | papi-dts

    VariableRESOURCES_PROTOCOLConst

    RESOURCES_PROTOCOL: "resources://" = 'resources://'

    Settings

    Member Visibility
    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 5e822dcaef..87fc82b567 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
    +

    Settings

    Member Visibility
    diff --git a/papi-dts/variables/_renderer_components_dialogs_dialog_definition_model_.SELECT_BOOKS_DIALOG_TYPE.html b/papi-dts/variables/_renderer_components_dialogs_dialog_definition_model_.SELECT_BOOKS_DIALOG_TYPE.html index 3e61c774b3..94142be9d6 100644 --- a/papi-dts/variables/_renderer_components_dialogs_dialog_definition_model_.SELECT_BOOKS_DIALOG_TYPE.html +++ b/papi-dts/variables/_renderer_components_dialogs_dialog_definition_model_.SELECT_BOOKS_DIALOG_TYPE.html @@ -1,2 +1,2 @@ SELECT_BOOKS_DIALOG_TYPE | papi-dts

    VariableSELECT_BOOKS_DIALOG_TYPEConst

    SELECT_BOOKS_DIALOG_TYPE: "platform.selectBooks" = 'platform.selectBooks'

    The tabType for the select books dialog in select-books.dialog.tsx

    -

    Settings

    Member Visibility
    +

    Settings

    Member Visibility
    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 b7daca3441..50df625f2e 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

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

    Settings

    Member Visibility
    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 6a3c6ca5d5..0702820055 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

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

    Settings

    Member Visibility
    diff --git a/papi-dts/variables/_renderer_services_scroll_group_service_host_.availableScrollGroupIds.html b/papi-dts/variables/_renderer_services_scroll_group_service_host_.availableScrollGroupIds.html index 14a6404eff..ed6a25d59b 100644 --- a/papi-dts/variables/_renderer_services_scroll_group_service_host_.availableScrollGroupIds.html +++ b/papi-dts/variables/_renderer_services_scroll_group_service_host_.availableScrollGroupIds.html @@ -1,4 +1,4 @@ availableScrollGroupIds | papi-dts

    VariableavailableScrollGroupIdsConst

    availableScrollGroupIds: (number | undefined)[]

    All Scroll Group IDs that are intended to be shown in scroll group selectors. This is a placeholder and will be refactored significantly in https://github.com/paranext/paranext-core/issues/788

    -

    Settings

    Member Visibility
    +

    Settings

    Member Visibility
    diff --git a/papi-dts/variables/_shared_data_platform_data_.DEV_MODE_RENDERER_INDICATOR.html b/papi-dts/variables/_shared_data_platform_data_.DEV_MODE_RENDERER_INDICATOR.html index 560b1ac7e9..3e82294c15 100644 --- a/papi-dts/variables/_shared_data_platform_data_.DEV_MODE_RENDERER_INDICATOR.html +++ b/papi-dts/variables/_shared_data_platform_data_.DEV_MODE_RENDERER_INDICATOR.html @@ -1,2 +1,2 @@ DEV_MODE_RENDERER_INDICATOR | papi-dts

    VariableDEV_MODE_RENDERER_INDICATORConst

    DEV_MODE_RENDERER_INDICATOR: "?noisyDevMode" = '?noisyDevMode'

    Query string passed to the renderer when starting if it should enable noisy dev mode

    -

    Settings

    Member Visibility
    +

    Settings

    Member Visibility
    diff --git a/papi-dts/variables/_shared_data_platform_data_.PLATFORM_NAMESPACE.html b/papi-dts/variables/_shared_data_platform_data_.PLATFORM_NAMESPACE.html index 464295af57..c1759e275c 100644 --- a/papi-dts/variables/_shared_data_platform_data_.PLATFORM_NAMESPACE.html +++ b/papi-dts/variables/_shared_data_platform_data_.PLATFORM_NAMESPACE.html @@ -1,3 +1,3 @@ PLATFORM_NAMESPACE | papi-dts

    VariablePLATFORM_NAMESPACEConst

    PLATFORM_NAMESPACE: "platform" = 'platform'

    Namespace to use for features like commands, settings, etc. on the PAPI that are provided by Platform.Bible core

    -

    Settings

    Member Visibility
    +

    Settings

    Member Visibility
    diff --git a/papi-dts/variables/_shared_data_rpc_model_.CATEGORY_COMMAND.html b/papi-dts/variables/_shared_data_rpc_model_.CATEGORY_COMMAND.html index a71af2c6ab..a9ccf3a3e5 100644 --- a/papi-dts/variables/_shared_data_rpc_model_.CATEGORY_COMMAND.html +++ b/papi-dts/variables/_shared_data_rpc_model_.CATEGORY_COMMAND.html @@ -1,2 +1,2 @@ CATEGORY_COMMAND | papi-dts

    VariableCATEGORY_COMMANDConst

    CATEGORY_COMMAND: "command" = 'command'

    Prefix on requests that indicates that the request is a command

    -

    Settings

    Member Visibility
    +

    Settings

    Member Visibility
    diff --git a/papi-dts/variables/_shared_data_rpc_model_.GET_METHODS.html b/papi-dts/variables/_shared_data_rpc_model_.GET_METHODS.html index 7ab749fff9..42419deb9f 100644 --- a/papi-dts/variables/_shared_data_rpc_model_.GET_METHODS.html +++ b/papi-dts/variables/_shared_data_rpc_model_.GET_METHODS.html @@ -1,2 +1,2 @@ GET_METHODS | papi-dts

    VariableGET_METHODSConst

    GET_METHODS: "network:getMethods" = 'network:getMethods'

    Get all methods that are currently registered on the network.

    -

    Settings

    Member Visibility
    +

    Settings

    Member Visibility
    diff --git a/papi-dts/variables/_shared_data_rpc_model_.REGISTER_METHOD.html b/papi-dts/variables/_shared_data_rpc_model_.REGISTER_METHOD.html index 832c7e8c4a..7cc7d7623e 100644 --- a/papi-dts/variables/_shared_data_rpc_model_.REGISTER_METHOD.html +++ b/papi-dts/variables/_shared_data_rpc_model_.REGISTER_METHOD.html @@ -1,3 +1,3 @@ REGISTER_METHOD | papi-dts

    VariableREGISTER_METHODConst

    REGISTER_METHOD: "network:registerMethod" = 'network:registerMethod'

    Register a method on the network so that requests of the given type are routed to your request handler.

    -

    Settings

    Member Visibility
    +

    Settings

    Member Visibility
    diff --git a/papi-dts/variables/_shared_data_rpc_model_.UNREGISTER_METHOD.html b/papi-dts/variables/_shared_data_rpc_model_.UNREGISTER_METHOD.html index 1b81fef56b..dae539cd63 100644 --- a/papi-dts/variables/_shared_data_rpc_model_.UNREGISTER_METHOD.html +++ b/papi-dts/variables/_shared_data_rpc_model_.UNREGISTER_METHOD.html @@ -1,3 +1,3 @@ UNREGISTER_METHOD | papi-dts

    VariableUNREGISTER_METHODConst

    UNREGISTER_METHOD: "network:unregisterMethod" = 'network:unregisterMethod'

    Unregister a method on the network so that requests of the given type are no longer routed to your request handler.

    -

    Settings

    Member Visibility
    +

    Settings

    Member Visibility
    diff --git a/papi-dts/variables/_shared_data_rpc_model_.WEBSOCKET_PORT.html b/papi-dts/variables/_shared_data_rpc_model_.WEBSOCKET_PORT.html index 17ba1e69e2..ebfca381e8 100644 --- a/papi-dts/variables/_shared_data_rpc_model_.WEBSOCKET_PORT.html +++ b/papi-dts/variables/_shared_data_rpc_model_.WEBSOCKET_PORT.html @@ -1,2 +1,2 @@ WEBSOCKET_PORT | papi-dts

    VariableWEBSOCKET_PORTConst

    WEBSOCKET_PORT = 8876

    Port to use for the WebSocket

    -

    Settings

    Member Visibility
    +

    Settings

    Member Visibility
    diff --git a/papi-dts/variables/_shared_models_dialog_options_model_.DIALOG_OPTIONS_LOCALIZABLE_PROPERTY_KEYS.html b/papi-dts/variables/_shared_models_dialog_options_model_.DIALOG_OPTIONS_LOCALIZABLE_PROPERTY_KEYS.html index 0ef6c62479..74580aa487 100644 --- a/papi-dts/variables/_shared_models_dialog_options_model_.DIALOG_OPTIONS_LOCALIZABLE_PROPERTY_KEYS.html +++ b/papi-dts/variables/_shared_models_dialog_options_model_.DIALOG_OPTIONS_LOCALIZABLE_PROPERTY_KEYS.html @@ -1,2 +1,2 @@ DIALOG_OPTIONS_LOCALIZABLE_PROPERTY_KEYS | papi-dts

    VariableDIALOG_OPTIONS_LOCALIZABLE_PROPERTY_KEYSConst

    DIALOG_OPTIONS_LOCALIZABLE_PROPERTY_KEYS: readonly ["title", "prompt"]

    Keys of properties on DialogOptions that should be localized if they are LocalizeKeys

    -

    Settings

    Member Visibility
    +

    Settings

    Member Visibility
    diff --git a/papi-dts/variables/_shared_models_network_object_status_service_model_.networkObjectStatusServiceNetworkObjectName.html b/papi-dts/variables/_shared_models_network_object_status_service_model_.networkObjectStatusServiceNetworkObjectName.html index 19643c3254..f6e054f7f8 100644 --- a/papi-dts/variables/_shared_models_network_object_status_service_model_.networkObjectStatusServiceNetworkObjectName.html +++ b/papi-dts/variables/_shared_models_network_object_status_service_model_.networkObjectStatusServiceNetworkObjectName.html @@ -1 +1 @@ -networkObjectStatusServiceNetworkObjectName | papi-dts

    VariablenetworkObjectStatusServiceNetworkObjectNameConst

    networkObjectStatusServiceNetworkObjectName: "NetworkObjectStatusService" = 'NetworkObjectStatusService'

    Settings

    Member Visibility
    +networkObjectStatusServiceNetworkObjectName | papi-dts

    VariablenetworkObjectStatusServiceNetworkObjectNameConst

    networkObjectStatusServiceNetworkObjectName: "NetworkObjectStatusService" = 'NetworkObjectStatusService'

    Settings

    Member Visibility
    diff --git a/papi-dts/variables/_shared_models_project_data_provider_factory_interface_.PDP_FACTORY_OBJECT_TYPE.html b/papi-dts/variables/_shared_models_project_data_provider_factory_interface_.PDP_FACTORY_OBJECT_TYPE.html index a72ef69ab2..d62422b241 100644 --- a/papi-dts/variables/_shared_models_project_data_provider_factory_interface_.PDP_FACTORY_OBJECT_TYPE.html +++ b/papi-dts/variables/_shared_models_project_data_provider_factory_interface_.PDP_FACTORY_OBJECT_TYPE.html @@ -1 +1 @@ -PDP_FACTORY_OBJECT_TYPE | papi-dts

    VariablePDP_FACTORY_OBJECT_TYPEConst

    PDP_FACTORY_OBJECT_TYPE: string

    Settings

    Member Visibility
    +PDP_FACTORY_OBJECT_TYPE | papi-dts

    VariablePDP_FACTORY_OBJECT_TYPEConst

    PDP_FACTORY_OBJECT_TYPE: string

    Settings

    Member Visibility
    diff --git a/papi-dts/variables/_shared_models_project_data_provider_model_.PROJECT_INTERFACE_PLATFORM_BASE.html b/papi-dts/variables/_shared_models_project_data_provider_model_.PROJECT_INTERFACE_PLATFORM_BASE.html index 3a5428d30e..05d9421ce3 100644 --- a/papi-dts/variables/_shared_models_project_data_provider_model_.PROJECT_INTERFACE_PLATFORM_BASE.html +++ b/papi-dts/variables/_shared_models_project_data_provider_model_.PROJECT_INTERFACE_PLATFORM_BASE.html @@ -1,3 +1,3 @@ PROJECT_INTERFACE_PLATFORM_BASE | papi-dts

    VariablePROJECT_INTERFACE_PLATFORM_BASEConst

    PROJECT_INTERFACE_PLATFORM_BASE: "platform.base" = 'platform.base'

    The name of the projectInterface representing the essential methods every Base Project Data Provider must implement

    -

    Settings

    Member Visibility
    +

    Settings

    Member Visibility
    diff --git a/papi-dts/variables/_shared_models_project_lookup_service_model_.NETWORK_OBJECT_NAME_PROJECT_LOOKUP_SERVICE.html b/papi-dts/variables/_shared_models_project_lookup_service_model_.NETWORK_OBJECT_NAME_PROJECT_LOOKUP_SERVICE.html index 14db8dd3e5..d3b575da11 100644 --- a/papi-dts/variables/_shared_models_project_lookup_service_model_.NETWORK_OBJECT_NAME_PROJECT_LOOKUP_SERVICE.html +++ b/papi-dts/variables/_shared_models_project_lookup_service_model_.NETWORK_OBJECT_NAME_PROJECT_LOOKUP_SERVICE.html @@ -1 +1 @@ -NETWORK_OBJECT_NAME_PROJECT_LOOKUP_SERVICE | papi-dts

    VariableNETWORK_OBJECT_NAME_PROJECT_LOOKUP_SERVICEConst

    NETWORK_OBJECT_NAME_PROJECT_LOOKUP_SERVICE: "ProjectLookupService" = 'ProjectLookupService'

    Settings

    Member Visibility
    +NETWORK_OBJECT_NAME_PROJECT_LOOKUP_SERVICE | papi-dts

    VariableNETWORK_OBJECT_NAME_PROJECT_LOOKUP_SERVICEConst

    NETWORK_OBJECT_NAME_PROJECT_LOOKUP_SERVICE: "ProjectLookupService" = 'ProjectLookupService'

    Settings

    Member Visibility
    diff --git a/papi-dts/variables/_shared_models_project_lookup_service_model_.projectLookupServiceBase.html b/papi-dts/variables/_shared_models_project_lookup_service_model_.projectLookupServiceBase.html index ca47dceea3..f7e73564a5 100644 --- a/papi-dts/variables/_shared_models_project_lookup_service_model_.projectLookupServiceBase.html +++ b/papi-dts/variables/_shared_models_project_lookup_service_model_.projectLookupServiceBase.html @@ -1,2 +1,2 @@ projectLookupServiceBase | papi-dts

    VariableprojectLookupServiceBaseConst

    projectLookupServiceBase: ProjectLookupServiceType

    Local object of functions to run locally on each process as part of the project lookup service

    -

    Settings

    Member Visibility
    +

    Settings

    Member Visibility
    diff --git a/papi-dts/variables/_shared_models_project_lookup_service_model_.testingProjectLookupService.html b/papi-dts/variables/_shared_models_project_lookup_service_model_.testingProjectLookupService.html index 566be6e3ed..7cf470bebd 100644 --- a/papi-dts/variables/_shared_models_project_lookup_service_model_.testingProjectLookupService.html +++ b/papi-dts/variables/_shared_models_project_lookup_service_model_.testingProjectLookupService.html @@ -1,2 +1,2 @@ testingProjectLookupService | papi-dts

    VariabletestingProjectLookupServiceConst

    testingProjectLookupService: {
        compareProjectDataProviderFactoryMetadataInfoMinimalMatch: typeof compareProjectDataProviderFactoryMetadataInfoMinimalMatch;
        internalGetMetadata: typeof internalGetMetadata;
        transformGetMetadataForProjectParametersToFilter: typeof transformGetMetadataForProjectParametersToFilter;
    }

    This is an internal-only export for testing purposes and should not be used in development

    -

    Settings

    Member Visibility
    +

    Settings

    Member Visibility
    diff --git a/papi-dts/variables/_shared_models_web_view_model_.SAVED_WEBVIEW_DEFINITION_OMITTED_KEYS.html b/papi-dts/variables/_shared_models_web_view_model_.SAVED_WEBVIEW_DEFINITION_OMITTED_KEYS.html index 1a4fd66acf..963d420ff9 100644 --- a/papi-dts/variables/_shared_models_web_view_model_.SAVED_WEBVIEW_DEFINITION_OMITTED_KEYS.html +++ b/papi-dts/variables/_shared_models_web_view_model_.SAVED_WEBVIEW_DEFINITION_OMITTED_KEYS.html @@ -1,3 +1,3 @@ SAVED_WEBVIEW_DEFINITION_OMITTED_KEYS | papi-dts

    VariableSAVED_WEBVIEW_DEFINITION_OMITTED_KEYSConst

    SAVED_WEBVIEW_DEFINITION_OMITTED_KEYS: readonly ["content", "styles", "allowScripts", "allowSameOrigin", "allowedFrameSources", "allowPopups"]

    The keys of properties on a WebViewDefinition that are omitted when converting to a SavedWebViewDefinition

    -

    Settings

    Member Visibility
    +

    Settings

    Member Visibility
    diff --git a/papi-dts/variables/_shared_models_web_view_model_.WEBVIEW_DEFINITION_UPDATABLE_PROPERTY_KEYS.html b/papi-dts/variables/_shared_models_web_view_model_.WEBVIEW_DEFINITION_UPDATABLE_PROPERTY_KEYS.html index 4da241275e..f65ad8d066 100644 --- a/papi-dts/variables/_shared_models_web_view_model_.WEBVIEW_DEFINITION_UPDATABLE_PROPERTY_KEYS.html +++ b/papi-dts/variables/_shared_models_web_view_model_.WEBVIEW_DEFINITION_UPDATABLE_PROPERTY_KEYS.html @@ -1,3 +1,3 @@ WEBVIEW_DEFINITION_UPDATABLE_PROPERTY_KEYS | papi-dts

    VariableWEBVIEW_DEFINITION_UPDATABLE_PROPERTY_KEYSConst

    WEBVIEW_DEFINITION_UPDATABLE_PROPERTY_KEYS: readonly ["iconUrl", "title", "tooltip", "projectId", "scrollGroupScrRef"]

    The keys of properties on a WebViewDefinition that may be updated when that webview is already displayed

    -

    Settings

    Member Visibility
    +

    Settings

    Member Visibility
    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 16fcee1f1a..df7bf2a19a 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

    VariabledefaultConst

    default: DataProviderService

    Service that allows extensions to send and receive data to/from other extensions

    -

    Settings

    Member Visibility
    +

    Settings

    Member Visibility
    diff --git a/papi-dts/variables/_shared_services_dialog_service_.default.html b/papi-dts/variables/_shared_services_dialog_service_.default.html index 10fa3a5415..028749b5e5 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

    VariabledefaultConst

    default: DialogService

    Settings

    Member Visibility
    +default | papi-dts

    VariabledefaultConst

    default: DialogService

    Settings

    Member Visibility
    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 5fa12833d6..959e3a5aef 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

    VariableCATEGORY_DIALOGConst

    CATEGORY_DIALOG: "dialog" = 'dialog'

    Prefix on requests that indicates that the request is related to dialog operations

    -

    Settings

    Member Visibility
    +

    Settings

    Member Visibility
    diff --git a/papi-dts/variables/_shared_services_internet_service_.default.html b/papi-dts/variables/_shared_services_internet_service_.default.html index 18da8c0f2f..d43ea9075b 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

    VariabledefaultConst

    default: InternetService

    Service that provides a way to call fetch since the original function is not available

    -

    Settings

    Member Visibility
    +

    Settings

    Member Visibility
    diff --git a/papi-dts/variables/_shared_services_localization_service_.default.html b/papi-dts/variables/_shared_services_localization_service_.default.html index c7c500fb8d..7f04f24fca 100644 --- a/papi-dts/variables/_shared_services_localization_service_.default.html +++ b/papi-dts/variables/_shared_services_localization_service_.default.html @@ -1 +1 @@ -default | papi-dts

    VariabledefaultConst

    default: ILocalizationService

    Settings

    Member Visibility
    +default | papi-dts

    VariabledefaultConst

    default: ILocalizationService

    Settings

    Member Visibility
    diff --git a/papi-dts/variables/_shared_services_localization_service_model_.localizationServiceObjectToProxy.html b/papi-dts/variables/_shared_services_localization_service_model_.localizationServiceObjectToProxy.html index d9bcf635f2..fca4a1c2eb 100644 --- a/papi-dts/variables/_shared_services_localization_service_model_.localizationServiceObjectToProxy.html +++ b/papi-dts/variables/_shared_services_localization_service_model_.localizationServiceObjectToProxy.html @@ -1,3 +1,3 @@ localizationServiceObjectToProxy | papi-dts

    VariablelocalizationServiceObjectToProxyConst

    localizationServiceObjectToProxy: Readonly<{
        dataProviderName: "platform.localizationDataServiceDataProvider";
    }>

    Type declaration

    • dataProviderName: "platform.localizationDataServiceDataProvider"

      This name is used to register the localization data provider on the papi. You can use this name to find the data provider when accessing it using the useData hook

      -

    Settings

    Member Visibility
    +

    Settings

    Member Visibility
    diff --git a/papi-dts/variables/_shared_services_localization_service_model_.localizationServiceProviderName.html b/papi-dts/variables/_shared_services_localization_service_model_.localizationServiceProviderName.html index 84cb15f0a4..efcb115d87 100644 --- a/papi-dts/variables/_shared_services_localization_service_model_.localizationServiceProviderName.html +++ b/papi-dts/variables/_shared_services_localization_service_model_.localizationServiceProviderName.html @@ -1,3 +1,3 @@ localizationServiceProviderName | papi-dts

    VariablelocalizationServiceProviderNameConst

    localizationServiceProviderName: "platform.localizationDataServiceDataProvider" = 'platform.localizationDataServiceDataProvider'

    This name is used to register the localization data provider on the papi. You can use this name to find the data provider when accessing it using the useData hook

    -

    Settings

    Member Visibility
    +

    Settings

    Member Visibility
    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 8e85d7c613..e65897d311 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

    VariableWARN_TAGConst

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

    Settings

    Member Visibility
    +WARN_TAG | papi-dts

    VariableWARN_TAGConst

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

    Settings

    Member Visibility
    diff --git a/papi-dts/variables/_shared_services_logger_service_.default.html b/papi-dts/variables/_shared_services_logger_service_.default.html index a34cbfa45e..2d93a42f13 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

    VariabledefaultConst

    default: log.MainLogger & {
        default: log.MainLogger;
    }

    All extensions and services should use this logger to provide a unified output of logs

    -

    Settings

    Member Visibility
    +

    Settings

    Member Visibility
    diff --git a/papi-dts/variables/_shared_services_menu_data_service_.default.html b/papi-dts/variables/_shared_services_menu_data_service_.default.html index 619fae6426..d8fb9a5eb7 100644 --- a/papi-dts/variables/_shared_services_menu_data_service_.default.html +++ b/papi-dts/variables/_shared_services_menu_data_service_.default.html @@ -1 +1 @@ -default | papi-dts

    VariabledefaultConst

    default: IMenuDataService

    Settings

    Member Visibility
    +default | papi-dts

    VariabledefaultConst

    default: IMenuDataService

    Settings

    Member Visibility
    diff --git a/papi-dts/variables/_shared_services_menu_data_service_model_.menuDataServiceObjectToProxy.html b/papi-dts/variables/_shared_services_menu_data_service_model_.menuDataServiceObjectToProxy.html index 0b34e82512..4286a28ba1 100644 --- a/papi-dts/variables/_shared_services_menu_data_service_model_.menuDataServiceObjectToProxy.html +++ b/papi-dts/variables/_shared_services_menu_data_service_model_.menuDataServiceObjectToProxy.html @@ -1,3 +1,3 @@ menuDataServiceObjectToProxy | papi-dts

    VariablemenuDataServiceObjectToProxyConst

    menuDataServiceObjectToProxy: Readonly<{
        dataProviderName: "platform.menuDataServiceDataProvider";
    }>

    Type declaration

    • dataProviderName: "platform.menuDataServiceDataProvider"

      This name is used to register the menu data data provider on the papi. You can use this name to find the data provider when accessing it using the useData hook

      -

    Settings

    Member Visibility
    +

    Settings

    Member Visibility
    diff --git a/papi-dts/variables/_shared_services_menu_data_service_model_.menuDataServiceProviderName.html b/papi-dts/variables/_shared_services_menu_data_service_model_.menuDataServiceProviderName.html index cf10bdbbe0..baa745745a 100644 --- a/papi-dts/variables/_shared_services_menu_data_service_model_.menuDataServiceProviderName.html +++ b/papi-dts/variables/_shared_services_menu_data_service_model_.menuDataServiceProviderName.html @@ -1,3 +1,3 @@ menuDataServiceProviderName | papi-dts

    VariablemenuDataServiceProviderNameConst

    menuDataServiceProviderName: "platform.menuDataServiceDataProvider" = 'platform.menuDataServiceDataProvider'

    This name is used to register the menu data data provider on the papi. You can use this name to find the data provider when accessing it using the useData hook

    -

    Settings

    Member Visibility
    +

    Settings

    Member Visibility
    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 c4be088ca7..a4f766efbc 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
    +

    Settings

    Member Visibility
    diff --git a/papi-dts/variables/_shared_services_network_object_service_.minimalNetworkObjectService-1.html b/papi-dts/variables/_shared_services_network_object_service_.minimalNetworkObjectService-1.html index c471de4db0..dd1fa8da5f 100644 --- a/papi-dts/variables/_shared_services_network_object_service_.minimalNetworkObjectService-1.html +++ b/papi-dts/variables/_shared_services_network_object_service_.minimalNetworkObjectService-1.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
    +

    Settings

    Member Visibility
    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 6b394b5776..0405f65120 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,2 +1,2 @@ default | papi-dts

    VariabledefaultConst

    default: NetworkObjectStatusServiceType

    Provides functions related to the set of available network objects

    -

    Settings

    Member Visibility
    +

    Settings

    Member Visibility
    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 f5ccd17f27..e962f89ad8 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

    VariablepapiNetworkServiceConst

    papiNetworkService: PapiNetworkService

    Service that provides a way to send and receive network events

    -

    Settings

    Member Visibility
    +

    Settings

    Member Visibility
    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 ade63f7e8a..746848cc0f 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

    VariablepapiBackendProjectDataProviderServiceConst

    papiBackendProjectDataProviderService: PapiBackendProjectDataProviderService

    Service that registers and gets project data providers

    -

    Settings

    Member Visibility
    +

    Settings

    Member Visibility
    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 6d73581dc5..44595fd053 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

    VariablepapiFrontendProjectDataProviderServiceConst

    papiFrontendProjectDataProviderService: {
        get: typeof get;
    }

    Service that gets project data providers

    -

    Settings

    Member Visibility
    +

    Settings

    Member Visibility
    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 078c831018..34178adaf8 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

    VariabledefaultConst

    default: "shared/models/project-lookup.service-model"

    Settings

    Member Visibility
    +default | papi-dts

    VariabledefaultConst

    default: "shared/models/project-lookup.service-model"

    Settings

    Member Visibility
    diff --git a/papi-dts/variables/_shared_services_project_settings_service_.default.html b/papi-dts/variables/_shared_services_project_settings_service_.default.html index 1dacb67878..73270679c7 100644 --- a/papi-dts/variables/_shared_services_project_settings_service_.default.html +++ b/papi-dts/variables/_shared_services_project_settings_service_.default.html @@ -1 +1 @@ -default | papi-dts

    VariabledefaultConst

    default: IProjectSettingsService

    Settings

    Member Visibility
    +default | papi-dts

    VariabledefaultConst

    default: IProjectSettingsService

    Settings

    Member Visibility
    diff --git a/papi-dts/variables/_shared_services_project_settings_service_model_.CATEGORY_EXTENSION_PROJECT_SETTING_VALIDATOR.html b/papi-dts/variables/_shared_services_project_settings_service_model_.CATEGORY_EXTENSION_PROJECT_SETTING_VALIDATOR.html index 1551b315c7..fb5fdc9b27 100644 --- a/papi-dts/variables/_shared_services_project_settings_service_model_.CATEGORY_EXTENSION_PROJECT_SETTING_VALIDATOR.html +++ b/papi-dts/variables/_shared_services_project_settings_service_model_.CATEGORY_EXTENSION_PROJECT_SETTING_VALIDATOR.html @@ -1,2 +1,2 @@ CATEGORY_EXTENSION_PROJECT_SETTING_VALIDATOR | papi-dts

    VariableCATEGORY_EXTENSION_PROJECT_SETTING_VALIDATORConst

    CATEGORY_EXTENSION_PROJECT_SETTING_VALIDATOR: "extensionProjectSettingValidator" = 'extensionProjectSettingValidator'

    Name prefix for registered commands that call project settings validators

    -

    Settings

    Member Visibility
    +

    Settings

    Member Visibility
    diff --git a/papi-dts/variables/_shared_services_project_settings_service_model_.projectSettingsServiceNetworkObjectName.html b/papi-dts/variables/_shared_services_project_settings_service_model_.projectSettingsServiceNetworkObjectName.html index 54d403314a..52488c3512 100644 --- a/papi-dts/variables/_shared_services_project_settings_service_model_.projectSettingsServiceNetworkObjectName.html +++ b/papi-dts/variables/_shared_services_project_settings_service_model_.projectSettingsServiceNetworkObjectName.html @@ -1 +1 @@ -projectSettingsServiceNetworkObjectName | papi-dts

    VariableprojectSettingsServiceNetworkObjectNameConst

    projectSettingsServiceNetworkObjectName: "ProjectSettingsService" = 'ProjectSettingsService'

    Settings

    Member Visibility
    +projectSettingsServiceNetworkObjectName | papi-dts

    VariableprojectSettingsServiceNetworkObjectNameConst

    projectSettingsServiceNetworkObjectName: "ProjectSettingsService" = 'ProjectSettingsService'

    Settings

    Member Visibility
    diff --git a/papi-dts/variables/_shared_services_project_settings_service_model_.projectSettingsServiceObjectToProxy.html b/papi-dts/variables/_shared_services_project_settings_service_model_.projectSettingsServiceObjectToProxy.html index 9d1c6acd5e..7b59c6eae0 100644 --- a/papi-dts/variables/_shared_services_project_settings_service_model_.projectSettingsServiceObjectToProxy.html +++ b/papi-dts/variables/_shared_services_project_settings_service_model_.projectSettingsServiceObjectToProxy.html @@ -2,4 +2,4 @@

    Settings

    Member Visibility
    +

    Settings

    Member Visibility
    diff --git a/papi-dts/variables/_shared_services_scroll_group_service_.default.html b/papi-dts/variables/_shared_services_scroll_group_service_.default.html index a5dd277a46..dd3b4527bc 100644 --- a/papi-dts/variables/_shared_services_scroll_group_service_.default.html +++ b/papi-dts/variables/_shared_services_scroll_group_service_.default.html @@ -1,2 +1,2 @@ default | papi-dts

    VariabledefaultConst

    default: IScrollGroupService

    Provides functions related to scroll groups and Scripture references at those scroll groups

    -

    Settings

    Member Visibility
    +

    Settings

    Member Visibility
    diff --git a/papi-dts/variables/_shared_services_scroll_group_service_model_.EVENT_NAME_ON_DID_UPDATE_SCR_REF.html b/papi-dts/variables/_shared_services_scroll_group_service_model_.EVENT_NAME_ON_DID_UPDATE_SCR_REF.html index c67ee63973..b72b7c99ca 100644 --- a/papi-dts/variables/_shared_services_scroll_group_service_model_.EVENT_NAME_ON_DID_UPDATE_SCR_REF.html +++ b/papi-dts/variables/_shared_services_scroll_group_service_model_.EVENT_NAME_ON_DID_UPDATE_SCR_REF.html @@ -1,2 +1,2 @@ EVENT_NAME_ON_DID_UPDATE_SCR_REF | papi-dts

    VariableEVENT_NAME_ON_DID_UPDATE_SCR_REFConst

    EVENT_NAME_ON_DID_UPDATE_SCR_REF: `${string}:${string}`

    Name to use when creating a network event that is fired when webViews are updated

    -

    Settings

    Member Visibility
    +

    Settings

    Member Visibility
    diff --git a/papi-dts/variables/_shared_services_scroll_group_service_model_.NETWORK_OBJECT_NAME_SCROLL_GROUP_SERVICE.html b/papi-dts/variables/_shared_services_scroll_group_service_model_.NETWORK_OBJECT_NAME_SCROLL_GROUP_SERVICE.html index 5be2bd34ab..9934756f4a 100644 --- a/papi-dts/variables/_shared_services_scroll_group_service_model_.NETWORK_OBJECT_NAME_SCROLL_GROUP_SERVICE.html +++ b/papi-dts/variables/_shared_services_scroll_group_service_model_.NETWORK_OBJECT_NAME_SCROLL_GROUP_SERVICE.html @@ -1 +1 @@ -NETWORK_OBJECT_NAME_SCROLL_GROUP_SERVICE | papi-dts

    VariableNETWORK_OBJECT_NAME_SCROLL_GROUP_SERVICEConst

    NETWORK_OBJECT_NAME_SCROLL_GROUP_SERVICE: "ScrollGroupService" = 'ScrollGroupService'

    Settings

    Member Visibility
    +NETWORK_OBJECT_NAME_SCROLL_GROUP_SERVICE | papi-dts

    VariableNETWORK_OBJECT_NAME_SCROLL_GROUP_SERVICEConst

    NETWORK_OBJECT_NAME_SCROLL_GROUP_SERVICE: "ScrollGroupService" = 'ScrollGroupService'

    Settings

    Member Visibility
    diff --git a/papi-dts/variables/_shared_services_settings_service_.default.html b/papi-dts/variables/_shared_services_settings_service_.default.html index a4281bebba..794abd8756 100644 --- a/papi-dts/variables/_shared_services_settings_service_.default.html +++ b/papi-dts/variables/_shared_services_settings_service_.default.html @@ -1 +1 @@ -default | papi-dts

    VariabledefaultConst

    default: ISettingsService

    Settings

    Member Visibility
    +default | papi-dts

    VariabledefaultConst

    default: ISettingsService

    Settings

    Member Visibility
    diff --git a/papi-dts/variables/_shared_services_settings_service_model_.CATEGORY_EXTENSION_SETTING_VALIDATOR.html b/papi-dts/variables/_shared_services_settings_service_model_.CATEGORY_EXTENSION_SETTING_VALIDATOR.html index 4c1cbe4be2..81bf0dc98d 100644 --- a/papi-dts/variables/_shared_services_settings_service_model_.CATEGORY_EXTENSION_SETTING_VALIDATOR.html +++ b/papi-dts/variables/_shared_services_settings_service_model_.CATEGORY_EXTENSION_SETTING_VALIDATOR.html @@ -1,2 +1,2 @@ CATEGORY_EXTENSION_SETTING_VALIDATOR | papi-dts

    VariableCATEGORY_EXTENSION_SETTING_VALIDATORConst

    CATEGORY_EXTENSION_SETTING_VALIDATOR: "extensionSettingValidator" = 'extensionSettingValidator'

    Name prefix for registered commands that call settings validators

    -

    Settings

    Member Visibility
    +

    Settings

    Member Visibility
    diff --git a/papi-dts/variables/_shared_services_settings_service_model_.settingsServiceDataProviderName.html b/papi-dts/variables/_shared_services_settings_service_model_.settingsServiceDataProviderName.html index 89c339eb00..7bc6579f2a 100644 --- a/papi-dts/variables/_shared_services_settings_service_model_.settingsServiceDataProviderName.html +++ b/papi-dts/variables/_shared_services_settings_service_model_.settingsServiceDataProviderName.html @@ -1,3 +1,3 @@ settingsServiceDataProviderName | papi-dts

    VariablesettingsServiceDataProviderNameConst

    settingsServiceDataProviderName: "platform.settingsServiceDataProvider" = 'platform.settingsServiceDataProvider'

    This name is used to register the settings service data provider on the papi. You can use this name to find the data provider when accessing it using the useData hook

    -

    Settings

    Member Visibility
    +

    Settings

    Member Visibility
    diff --git a/papi-dts/variables/_shared_services_settings_service_model_.settingsServiceObjectToProxy.html b/papi-dts/variables/_shared_services_settings_service_model_.settingsServiceObjectToProxy.html index 441055bd58..055a8b3ece 100644 --- a/papi-dts/variables/_shared_services_settings_service_model_.settingsServiceObjectToProxy.html +++ b/papi-dts/variables/_shared_services_settings_service_model_.settingsServiceObjectToProxy.html @@ -4,4 +4,4 @@

    Settings

    Member Visibility
    +

    Settings

    Member Visibility
    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 23c4205e0d..f607741705 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

    VariabledefaultConst

    default: WebViewProviderService

    Settings

    Member Visibility
    +default | papi-dts

    VariabledefaultConst

    default: WebViewProviderService

    Settings

    Member Visibility
    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 4a77882386..4c364af592 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,3 +1,3 @@ papiWebViewProviderService | papi-dts

    VariablepapiWebViewProviderServiceConst

    papiWebViewProviderService: PapiWebViewProviderService

    Interface for registering webView providers, registering webView controllers, and performing privileged interactions with web views

    -

    Settings

    Member Visibility
    +

    Settings

    Member Visibility
    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 6f6f4dc473..01bbbc38dc 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

    VariabledefaultConst

    default: WebViewServiceType

    Settings

    Member Visibility
    +default | papi-dts

    VariabledefaultConst

    default: WebViewServiceType

    Settings

    Member Visibility
    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 6a8288f23e..928e6782ed 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

    VariableEVENT_NAME_ON_DID_ADD_WEB_VIEWConst

    EVENT_NAME_ON_DID_ADD_WEB_VIEW: `${string}:${string}`

    Deprecated

    13 November 2024. Renamed to EVENT_NAME_ON_DID_OPEN_WEB_VIEW

    -

    Settings

    Member Visibility
    +

    Settings

    Member Visibility
    diff --git a/papi-dts/variables/_shared_services_web_view_service_model_.EVENT_NAME_ON_DID_CLOSE_WEB_VIEW.html b/papi-dts/variables/_shared_services_web_view_service_model_.EVENT_NAME_ON_DID_CLOSE_WEB_VIEW.html index 277d8d630d..44f8717350 100644 --- a/papi-dts/variables/_shared_services_web_view_service_model_.EVENT_NAME_ON_DID_CLOSE_WEB_VIEW.html +++ b/papi-dts/variables/_shared_services_web_view_service_model_.EVENT_NAME_ON_DID_CLOSE_WEB_VIEW.html @@ -1,2 +1,2 @@ EVENT_NAME_ON_DID_CLOSE_WEB_VIEW | papi-dts

    VariableEVENT_NAME_ON_DID_CLOSE_WEB_VIEWConst

    EVENT_NAME_ON_DID_CLOSE_WEB_VIEW: `${string}:${string}`

    Name to use when creating a network event that is fired when webViews are closed

    -

    Settings

    Member Visibility
    +

    Settings

    Member Visibility
    diff --git a/papi-dts/variables/_shared_services_web_view_service_model_.EVENT_NAME_ON_DID_OPEN_WEB_VIEW.html b/papi-dts/variables/_shared_services_web_view_service_model_.EVENT_NAME_ON_DID_OPEN_WEB_VIEW.html index 1ff21dfab5..52a90bfe34 100644 --- a/papi-dts/variables/_shared_services_web_view_service_model_.EVENT_NAME_ON_DID_OPEN_WEB_VIEW.html +++ b/papi-dts/variables/_shared_services_web_view_service_model_.EVENT_NAME_ON_DID_OPEN_WEB_VIEW.html @@ -1,2 +1,2 @@ EVENT_NAME_ON_DID_OPEN_WEB_VIEW | papi-dts

    VariableEVENT_NAME_ON_DID_OPEN_WEB_VIEWConst

    EVENT_NAME_ON_DID_OPEN_WEB_VIEW: `${string}:${string}`

    Name to use when creating a network event that is fired when webViews are created

    -

    Settings

    Member Visibility
    +

    Settings

    Member Visibility
    diff --git a/papi-dts/variables/_shared_services_web_view_service_model_.EVENT_NAME_ON_DID_UPDATE_WEB_VIEW.html b/papi-dts/variables/_shared_services_web_view_service_model_.EVENT_NAME_ON_DID_UPDATE_WEB_VIEW.html index e8a1e6b11f..6010de3991 100644 --- a/papi-dts/variables/_shared_services_web_view_service_model_.EVENT_NAME_ON_DID_UPDATE_WEB_VIEW.html +++ b/papi-dts/variables/_shared_services_web_view_service_model_.EVENT_NAME_ON_DID_UPDATE_WEB_VIEW.html @@ -1,2 +1,2 @@ EVENT_NAME_ON_DID_UPDATE_WEB_VIEW | papi-dts

    VariableEVENT_NAME_ON_DID_UPDATE_WEB_VIEWConst

    EVENT_NAME_ON_DID_UPDATE_WEB_VIEW: `${string}:${string}`

    Name to use when creating a network event that is fired when webViews are updated

    -

    Settings

    Member Visibility
    +

    Settings

    Member Visibility
    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 03e264783e..ecaafa51d5 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

    VariableNETWORK_OBJECT_NAME_WEB_VIEW_SERVICEConst

    NETWORK_OBJECT_NAME_WEB_VIEW_SERVICE: "WebViewService" = 'WebViewService'

    Settings

    Member Visibility
    +NETWORK_OBJECT_NAME_WEB_VIEW_SERVICE | papi-dts

    VariableNETWORK_OBJECT_NAME_WEB_VIEW_SERVICEConst

    NETWORK_OBJECT_NAME_WEB_VIEW_SERVICE: "WebViewService" = 'WebViewService'

    Settings

    Member Visibility
    diff --git a/papi-dts/variables/_shared_services_web_view_service_model_.WEB_VIEW_CONTROLLER_OBJECT_TYPE.html b/papi-dts/variables/_shared_services_web_view_service_model_.WEB_VIEW_CONTROLLER_OBJECT_TYPE.html index b471134b54..57e69393df 100644 --- a/papi-dts/variables/_shared_services_web_view_service_model_.WEB_VIEW_CONTROLLER_OBJECT_TYPE.html +++ b/papi-dts/variables/_shared_services_web_view_service_model_.WEB_VIEW_CONTROLLER_OBJECT_TYPE.html @@ -1,2 +1,2 @@ WEB_VIEW_CONTROLLER_OBJECT_TYPE | papi-dts

    VariableWEB_VIEW_CONTROLLER_OBJECT_TYPEConst

    WEB_VIEW_CONTROLLER_OBJECT_TYPE: "webViewController" = 'webViewController'

    Network object type for web view controllers

    -

    Settings

    Member Visibility
    +

    Settings

    Member Visibility
    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 cb203603cc..16147074bc 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

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

    -

    Settings

    Member Visibility
    +

    Settings

    Member Visibility
    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 fca542ce19..d8cb258523 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

    VariableREQUEST_TYPE_SEPARATORConst

    REQUEST_TYPE_SEPARATOR: ":" = ':'

    Separator between parts of a serialized request

    -

    Settings

    Member Visibility
    +

    Settings

    Member Visibility
    diff --git a/papi-dts/variables/isNoisyDevModeEnabled.html b/papi-dts/variables/isNoisyDevModeEnabled.html index 3868b7534e..0f8b27c038 100644 --- a/papi-dts/variables/isNoisyDevModeEnabled.html +++ b/papi-dts/variables/isNoisyDevModeEnabled.html @@ -1,2 +1,2 @@ isNoisyDevModeEnabled | papi-dts

    VariableisNoisyDevModeEnabled

    isNoisyDevModeEnabled: boolean

    Indicates whether test code meant just for developers to see should be run

    -

    Settings

    Member Visibility
    +

    Settings

    Member Visibility
    diff --git a/papi-dts/variables/isPackaged.html b/papi-dts/variables/isPackaged.html index 448a1f31b2..dad5550cd9 100644 --- a/papi-dts/variables/isPackaged.html +++ b/papi-dts/variables/isPackaged.html @@ -1,2 +1,2 @@ isPackaged | papi-dts

    VariableisPackaged

    isPackaged: boolean

    Whether this process is packaged or running from sources

    -

    Settings

    Member Visibility
    +

    Settings

    Member Visibility
    diff --git a/papi-dts/variables/logLevel.html b/papi-dts/variables/logLevel.html index b9e64bcbab..e2349fcf15 100644 --- a/papi-dts/variables/logLevel.html +++ b/papi-dts/variables/logLevel.html @@ -1,2 +1,2 @@ logLevel | papi-dts

    VariablelogLevel

    logLevel: LogLevel

    How much logging should be recorded. Defaults to 'debug' if not packaged, 'info' if packaged

    -

    Settings

    Member Visibility
    +

    Settings

    Member Visibility
    diff --git a/papi-dts/variables/processType.html b/papi-dts/variables/processType.html index 0d417665a0..af97684828 100644 --- a/papi-dts/variables/processType.html +++ b/papi-dts/variables/processType.html @@ -1,2 +1,2 @@ processType | papi-dts

    VariableprocessType

    processType: ProcessType

    Type of process this is. Helps with running specific code based on which process you're in

    -

    Settings

    Member Visibility
    +

    Settings

    Member Visibility
    diff --git a/papi-dts/variables/resourcesPath.html b/papi-dts/variables/resourcesPath.html index 413179db3d..94297b715c 100644 --- a/papi-dts/variables/resourcesPath.html +++ b/papi-dts/variables/resourcesPath.html @@ -1,3 +1,3 @@ resourcesPath | papi-dts

    VariableresourcesPath

    resourcesPath: string

    Path to the app's resources directory. This is a string representation of the resources uri on frontend

    -

    Settings

    Member Visibility
    +

    Settings

    Member Visibility
    diff --git a/papi-dts/variables/webViewId.html b/papi-dts/variables/webViewId.html index bc4f893a2c..bee1dc3fcd 100644 --- a/papi-dts/variables/webViewId.html +++ b/papi-dts/variables/webViewId.html @@ -1,2 +1,2 @@ webViewId | papi-dts

    VariablewebViewId

    webViewId: WebViewId

    The id of the current web view. Only used in WebView iframes.

    -

    Settings

    Member Visibility
    +

    Settings

    Member Visibility
    diff --git a/platform-bible-react/enums/BookSelectionMode.html b/platform-bible-react/enums/BookSelectionMode.html index 8d34a47fff..ecbc5b2f8c 100644 --- a/platform-bible-react/enums/BookSelectionMode.html +++ b/platform-bible-react/enums/BookSelectionMode.html @@ -1,3 +1,3 @@ -BookSelectionMode | platform-bible-react

    EnumerationBookSelectionMode

    Enumeration Members

    CHOOSE_BOOKS +BookSelectionMode | platform-bible-react

    EnumerationBookSelectionMode

    Enumeration Members

    CHOOSE_BOOKS CURRENT_BOOK -

    Enumeration Members

    CHOOSE_BOOKS

    CHOOSE_BOOKS

    CURRENT_BOOK

    CURRENT_BOOK

    Settings

    Member Visibility

    On This Page

    Enumeration Members
    +

    Enumeration Members

    CHOOSE_BOOKS

    CHOOSE_BOOKS

    CURRENT_BOOK

    CURRENT_BOOK

    Settings

    Member Visibility

    On This Page

    Enumeration Members
    diff --git a/platform-bible-react/enums/DropdownMenuItemType.html b/platform-bible-react/enums/DropdownMenuItemType.html index 1c62aecd99..74b0d6fbe3 100644 --- a/platform-bible-react/enums/DropdownMenuItemType.html +++ b/platform-bible-react/enums/DropdownMenuItemType.html @@ -1,3 +1,3 @@ -DropdownMenuItemType | platform-bible-react

    EnumerationDropdownMenuItemType

    Enumeration Members

    Check +DropdownMenuItemType | platform-bible-react

    EnumerationDropdownMenuItemType

    Enumeration Members

    Check Radio -

    Enumeration Members

    Check

    Check

    Radio

    Radio

    Settings

    Member Visibility

    On This Page

    Enumeration Members
    +

    Enumeration Members

    Check

    Check

    Radio

    Radio

    Settings

    Member Visibility

    On This Page

    Enumeration Members
    diff --git a/platform-bible-react/functions/Alert.html b/platform-bible-react/functions/Alert.html index bd812a97c4..36e6d96b6e 100644 --- a/platform-bible-react/functions/Alert.html +++ b/platform-bible-react/functions/Alert.html @@ -1,4 +1,4 @@ -Alert | platform-bible-react

    FunctionAlert

    • Alert(props): ReactNode

    • Parameters

      • props: HTMLAttributes<HTMLDivElement> & VariantProps<((props?: ConfigVariants<{ variant: { default: string; destructive: string; }; }> & ClassProp) => string)> & RefAttributes<HTMLDivElement>

      Returns ReactNode

    Properties

    $$typeof +Alert | platform-bible-react

    FunctionAlert

    • Alert(props): ReactNode

    • Parameters

      • props: HTMLAttributes<HTMLDivElement> & VariantProps<((props?: ConfigVariants<{ variant: { default: string; destructive: string; }; }> & ClassProp) => string)> & RefAttributes<HTMLDivElement>

      Returns ReactNode

    Properties

    $$typeof defaultProps? displayName? propTypes? diff --git a/platform-bible-react/functions/AlertDescription.html b/platform-bible-react/functions/AlertDescription.html index 296ad81c74..60467992a4 100644 --- a/platform-bible-react/functions/AlertDescription.html +++ b/platform-bible-react/functions/AlertDescription.html @@ -1,4 +1,4 @@ -AlertDescription | platform-bible-react

    FunctionAlertDescription

    Properties

    $$typeof +AlertDescription | platform-bible-react

    FunctionAlertDescription

    Properties

    $$typeof defaultProps? displayName? propTypes? diff --git a/platform-bible-react/functions/AlertTitle.html b/platform-bible-react/functions/AlertTitle.html index eb72f04e02..04da6001de 100644 --- a/platform-bible-react/functions/AlertTitle.html +++ b/platform-bible-react/functions/AlertTitle.html @@ -1,4 +1,4 @@ -AlertTitle | platform-bible-react

    FunctionAlertTitle

    Properties

    $$typeof +AlertTitle | platform-bible-react

    FunctionAlertTitle

    Properties

    $$typeof defaultProps? displayName? propTypes? diff --git a/platform-bible-react/functions/BookChapterControl.html b/platform-bible-react/functions/BookChapterControl.html index 235901b938..eec5cce8a8 100644 --- a/platform-bible-react/functions/BookChapterControl.html +++ b/platform-bible-react/functions/BookChapterControl.html @@ -1 +1 @@ -BookChapterControl | platform-bible-react

    FunctionBookChapterControl

    Settings

    Member Visibility
    +BookChapterControl | platform-bible-react

    FunctionBookChapterControl

    Settings

    Member Visibility
    diff --git a/platform-bible-react/functions/BookSelector.html b/platform-bible-react/functions/BookSelector.html index f36b7390e2..f3aee34edb 100644 --- a/platform-bible-react/functions/BookSelector.html +++ b/platform-bible-react/functions/BookSelector.html @@ -1 +1 @@ -BookSelector | platform-bible-react

    FunctionBookSelector

    Settings

    Member Visibility
    +BookSelector | platform-bible-react

    FunctionBookSelector

    Settings

    Member Visibility
    diff --git a/platform-bible-react/functions/Button.html b/platform-bible-react/functions/Button.html index d299f1c3ee..cabcbbc15a 100644 --- a/platform-bible-react/functions/Button.html +++ b/platform-bible-react/functions/Button.html @@ -1,4 +1,4 @@ -Button | platform-bible-react

    FunctionButton

    Properties

    $$typeof +Button | platform-bible-react

    FunctionButton

    Properties

    $$typeof defaultProps? displayName? propTypes? diff --git a/platform-bible-react/functions/Card.html b/platform-bible-react/functions/Card.html index 32e50c75c7..c20ae8f475 100644 --- a/platform-bible-react/functions/Card.html +++ b/platform-bible-react/functions/Card.html @@ -1,4 +1,4 @@ -Card | platform-bible-react

    FunctionCard

    Properties

    $$typeof +Card | platform-bible-react

    FunctionCard

    Properties

    $$typeof defaultProps? displayName? propTypes? diff --git a/platform-bible-react/functions/CardContent.html b/platform-bible-react/functions/CardContent.html index 9ba61b42e7..ad39e47761 100644 --- a/platform-bible-react/functions/CardContent.html +++ b/platform-bible-react/functions/CardContent.html @@ -1,4 +1,4 @@ -CardContent | platform-bible-react

    FunctionCardContent

    Properties

    $$typeof +CardContent | platform-bible-react

    FunctionCardContent

    Properties

    $$typeof defaultProps? displayName? propTypes? diff --git a/platform-bible-react/functions/CardDescription.html b/platform-bible-react/functions/CardDescription.html index 1493d5e152..9bd22bf9e8 100644 --- a/platform-bible-react/functions/CardDescription.html +++ b/platform-bible-react/functions/CardDescription.html @@ -1,4 +1,4 @@ -CardDescription | platform-bible-react

    FunctionCardDescription

    Properties

    $$typeof +CardDescription | platform-bible-react

    FunctionCardDescription

    Properties

    $$typeof defaultProps? displayName? propTypes? diff --git a/platform-bible-react/functions/CardFooter.html b/platform-bible-react/functions/CardFooter.html index 1505d83752..5f87814e99 100644 --- a/platform-bible-react/functions/CardFooter.html +++ b/platform-bible-react/functions/CardFooter.html @@ -1,4 +1,4 @@ -CardFooter | platform-bible-react

    FunctionCardFooter

    Properties

    $$typeof +CardFooter | platform-bible-react

    FunctionCardFooter

    Properties

    $$typeof defaultProps? displayName? propTypes? diff --git a/platform-bible-react/functions/CardHeader.html b/platform-bible-react/functions/CardHeader.html index 0876fdb829..6a38834fb6 100644 --- a/platform-bible-react/functions/CardHeader.html +++ b/platform-bible-react/functions/CardHeader.html @@ -1,4 +1,4 @@ -CardHeader | platform-bible-react

    FunctionCardHeader

    Properties

    $$typeof +CardHeader | platform-bible-react

    FunctionCardHeader

    Properties

    $$typeof defaultProps? displayName? propTypes? diff --git a/platform-bible-react/functions/CardTitle.html b/platform-bible-react/functions/CardTitle.html index f27fd8102d..727d6e805c 100644 --- a/platform-bible-react/functions/CardTitle.html +++ b/platform-bible-react/functions/CardTitle.html @@ -1,4 +1,4 @@ -CardTitle | platform-bible-react

    FunctionCardTitle

    Properties

    $$typeof +CardTitle | platform-bible-react

    FunctionCardTitle

    Properties

    $$typeof defaultProps? displayName? propTypes? diff --git a/platform-bible-react/functions/ChapterRangeSelector.html b/platform-bible-react/functions/ChapterRangeSelector.html index 25e049f6fc..0a2841b9ae 100644 --- a/platform-bible-react/functions/ChapterRangeSelector.html +++ b/platform-bible-react/functions/ChapterRangeSelector.html @@ -1 +1 @@ -ChapterRangeSelector | platform-bible-react

    FunctionChapterRangeSelector

    Settings

    Member Visibility
    +ChapterRangeSelector | platform-bible-react

    FunctionChapterRangeSelector

    Settings

    Member Visibility
    diff --git a/platform-bible-react/functions/Checkbox.html b/platform-bible-react/functions/Checkbox.html index 1a81dd4a6f..59832178c3 100644 --- a/platform-bible-react/functions/Checkbox.html +++ b/platform-bible-react/functions/Checkbox.html @@ -1,4 +1,4 @@ -Checkbox | platform-bible-react

    FunctionCheckbox

    Properties

    $$typeof +Checkbox | platform-bible-react

    FunctionCheckbox

    Properties

    $$typeof defaultProps? displayName? propTypes? diff --git a/platform-bible-react/functions/Checklist.html b/platform-bible-react/functions/Checklist.html index c017bbf5fc..43bf128254 100644 --- a/platform-bible-react/functions/Checklist.html +++ b/platform-bible-react/functions/Checklist.html @@ -1,2 +1,2 @@ Checklist | platform-bible-react

    FunctionChecklist

    Settings

    Member Visibility
    +

    Parameters

    Returns Element

    Settings

    Member Visibility
    diff --git a/platform-bible-react/functions/ComboBox.html b/platform-bible-react/functions/ComboBox.html index 513f186455..65b500f931 100644 --- a/platform-bible-react/functions/ComboBox.html +++ b/platform-bible-react/functions/ComboBox.html @@ -1,4 +1,4 @@ ComboBox | platform-bible-react

    FunctionComboBox

    Settings

    Member Visibility
    +

    Type Parameters

    Parameters

    Returns Element

    Settings

    Member Visibility
    diff --git a/platform-bible-react/functions/DataTable.html b/platform-bible-react/functions/DataTable.html index f69bba570f..0bb89333d1 100644 --- a/platform-bible-react/functions/DataTable.html +++ b/platform-bible-react/functions/DataTable.html @@ -1,3 +1,3 @@ DataTable | platform-bible-react

    FunctionDataTable

    Settings

    Member Visibility
    +

    Type Parameters

    • TData
    • TValue

    Parameters

    Returns Element

    Settings

    Member Visibility
    diff --git a/platform-bible-react/functions/DisableButton.html b/platform-bible-react/functions/DisableButton.html index 0097ca2b66..ac62f6a47d 100644 --- a/platform-bible-react/functions/DisableButton.html +++ b/platform-bible-react/functions/DisableButton.html @@ -1,4 +1,4 @@ DisableButton | platform-bible-react

    FunctionDisableButton

    Settings

    Member Visibility
    +

    Settings

    Member Visibility
    diff --git a/platform-bible-react/functions/DropdownMenu.html b/platform-bible-react/functions/DropdownMenu.html index 49903443cb..6090fa18fd 100644 --- a/platform-bible-react/functions/DropdownMenu.html +++ b/platform-bible-react/functions/DropdownMenu.html @@ -1,5 +1,5 @@ DropdownMenu | platform-bible-react

    FunctionDropdownMenu

    Properties

    contextTypes? +

    Returns ReactNode

    Properties

    contextTypes? defaultProps? displayName? propTypes? diff --git a/platform-bible-react/functions/DropdownMenuCheckboxItem.html b/platform-bible-react/functions/DropdownMenuCheckboxItem.html index c611b7e167..9995d78109 100644 --- a/platform-bible-react/functions/DropdownMenuCheckboxItem.html +++ b/platform-bible-react/functions/DropdownMenuCheckboxItem.html @@ -1,4 +1,4 @@ -DropdownMenuCheckboxItem | platform-bible-react

    FunctionDropdownMenuCheckboxItem

    Properties

    $$typeof +DropdownMenuCheckboxItem | platform-bible-react

    FunctionDropdownMenuCheckboxItem

    Properties

    $$typeof defaultProps? displayName? propTypes? diff --git a/platform-bible-react/functions/DropdownMenuContent.html b/platform-bible-react/functions/DropdownMenuContent.html index b562202e5e..7d6c5be04f 100644 --- a/platform-bible-react/functions/DropdownMenuContent.html +++ b/platform-bible-react/functions/DropdownMenuContent.html @@ -1,4 +1,4 @@ -DropdownMenuContent | platform-bible-react

    FunctionDropdownMenuContent

    Properties

    $$typeof +DropdownMenuContent | platform-bible-react

    FunctionDropdownMenuContent

    Properties

    $$typeof defaultProps? displayName? propTypes? diff --git a/platform-bible-react/functions/DropdownMenuGroup.html b/platform-bible-react/functions/DropdownMenuGroup.html index 530354bcb4..5dc60e5b85 100644 --- a/platform-bible-react/functions/DropdownMenuGroup.html +++ b/platform-bible-react/functions/DropdownMenuGroup.html @@ -1,4 +1,4 @@ -DropdownMenuGroup | platform-bible-react

    FunctionDropdownMenuGroup

    Properties

    $$typeof +DropdownMenuGroup | platform-bible-react

    FunctionDropdownMenuGroup

    Properties

    $$typeof defaultProps? displayName? propTypes? diff --git a/platform-bible-react/functions/DropdownMenuItem.html b/platform-bible-react/functions/DropdownMenuItem.html index 238f229759..0485d7cd9d 100644 --- a/platform-bible-react/functions/DropdownMenuItem.html +++ b/platform-bible-react/functions/DropdownMenuItem.html @@ -1,6 +1,6 @@ DropdownMenuItem | platform-bible-react

    FunctionDropdownMenuItem

    TODO: fix: direction is not automatically handled by this component, so that shortcuts are display always to the right

    -

    Properties

    $$typeof +

    Properties

    $$typeof defaultProps? displayName? propTypes? diff --git a/platform-bible-react/functions/DropdownMenuLabel.html b/platform-bible-react/functions/DropdownMenuLabel.html index 1f1e76c75b..96c631d304 100644 --- a/platform-bible-react/functions/DropdownMenuLabel.html +++ b/platform-bible-react/functions/DropdownMenuLabel.html @@ -1,4 +1,4 @@ -DropdownMenuLabel | platform-bible-react

    FunctionDropdownMenuLabel

    Properties

    $$typeof +DropdownMenuLabel | platform-bible-react

    FunctionDropdownMenuLabel

    Properties

    $$typeof defaultProps? displayName? propTypes? diff --git a/platform-bible-react/functions/DropdownMenuPortal.html b/platform-bible-react/functions/DropdownMenuPortal.html index 61afe5a639..39239442d4 100644 --- a/platform-bible-react/functions/DropdownMenuPortal.html +++ b/platform-bible-react/functions/DropdownMenuPortal.html @@ -1,5 +1,5 @@ DropdownMenuPortal | platform-bible-react

    FunctionDropdownMenuPortal

    Properties

    contextTypes? +

    Returns ReactNode

    Properties

    contextTypes? defaultProps? displayName? propTypes? diff --git a/platform-bible-react/functions/DropdownMenuRadioGroup.html b/platform-bible-react/functions/DropdownMenuRadioGroup.html index 711be42e26..6638a36854 100644 --- a/platform-bible-react/functions/DropdownMenuRadioGroup.html +++ b/platform-bible-react/functions/DropdownMenuRadioGroup.html @@ -1,4 +1,4 @@ -DropdownMenuRadioGroup | platform-bible-react

    FunctionDropdownMenuRadioGroup

    Properties

    $$typeof +DropdownMenuRadioGroup | platform-bible-react

    FunctionDropdownMenuRadioGroup

    Properties

    $$typeof defaultProps? displayName? propTypes? diff --git a/platform-bible-react/functions/DropdownMenuRadioItem.html b/platform-bible-react/functions/DropdownMenuRadioItem.html index 79c5a03f64..8e99848210 100644 --- a/platform-bible-react/functions/DropdownMenuRadioItem.html +++ b/platform-bible-react/functions/DropdownMenuRadioItem.html @@ -1,4 +1,4 @@ -DropdownMenuRadioItem | platform-bible-react

    FunctionDropdownMenuRadioItem

    Properties

    $$typeof +DropdownMenuRadioItem | platform-bible-react

    FunctionDropdownMenuRadioItem

    Properties

    $$typeof defaultProps? displayName? propTypes? diff --git a/platform-bible-react/functions/DropdownMenuSeparator.html b/platform-bible-react/functions/DropdownMenuSeparator.html index 752c23def2..1c651e8774 100644 --- a/platform-bible-react/functions/DropdownMenuSeparator.html +++ b/platform-bible-react/functions/DropdownMenuSeparator.html @@ -1,4 +1,4 @@ -DropdownMenuSeparator | platform-bible-react

    FunctionDropdownMenuSeparator

    Properties

    $$typeof +DropdownMenuSeparator | platform-bible-react

    FunctionDropdownMenuSeparator

    Properties

    $$typeof defaultProps? displayName? propTypes? diff --git a/platform-bible-react/functions/DropdownMenuShortcut.html b/platform-bible-react/functions/DropdownMenuShortcut.html index 4830fde90b..e0b2b2c9d1 100644 --- a/platform-bible-react/functions/DropdownMenuShortcut.html +++ b/platform-bible-react/functions/DropdownMenuShortcut.html @@ -1,2 +1,2 @@ -DropdownMenuShortcut | platform-bible-react

    FunctionDropdownMenuShortcut

    Properties

    displayName -

    Properties

    displayName

    displayName: string

    Settings

    Member Visibility

    On This Page

    Properties
    +DropdownMenuShortcut | platform-bible-react

    FunctionDropdownMenuShortcut

    Properties

    displayName +

    Properties

    displayName

    displayName: string

    Settings

    Member Visibility

    On This Page

    Properties
    diff --git a/platform-bible-react/functions/DropdownMenuSub.html b/platform-bible-react/functions/DropdownMenuSub.html index 9cc9f96294..025f0a4a9d 100644 --- a/platform-bible-react/functions/DropdownMenuSub.html +++ b/platform-bible-react/functions/DropdownMenuSub.html @@ -1,5 +1,5 @@ DropdownMenuSub | platform-bible-react

    FunctionDropdownMenuSub

    Properties

    contextTypes? +

    Returns ReactNode

    Properties

    contextTypes? defaultProps? displayName? propTypes? diff --git a/platform-bible-react/functions/DropdownMenuSubContent.html b/platform-bible-react/functions/DropdownMenuSubContent.html index 8143f165f6..c95541751d 100644 --- a/platform-bible-react/functions/DropdownMenuSubContent.html +++ b/platform-bible-react/functions/DropdownMenuSubContent.html @@ -1,4 +1,4 @@ -DropdownMenuSubContent | platform-bible-react

    FunctionDropdownMenuSubContent

    Properties

    $$typeof +DropdownMenuSubContent | platform-bible-react

    FunctionDropdownMenuSubContent

    Properties

    $$typeof defaultProps? displayName? propTypes? diff --git a/platform-bible-react/functions/DropdownMenuSubTrigger.html b/platform-bible-react/functions/DropdownMenuSubTrigger.html index 387c579089..08faa243c0 100644 --- a/platform-bible-react/functions/DropdownMenuSubTrigger.html +++ b/platform-bible-react/functions/DropdownMenuSubTrigger.html @@ -1,4 +1,4 @@ -DropdownMenuSubTrigger | platform-bible-react

    FunctionDropdownMenuSubTrigger

    Properties

    $$typeof +DropdownMenuSubTrigger | platform-bible-react

    FunctionDropdownMenuSubTrigger

    Properties

    $$typeof defaultProps? displayName? propTypes? diff --git a/platform-bible-react/functions/DropdownMenuTrigger.html b/platform-bible-react/functions/DropdownMenuTrigger.html index 06bb76ff1a..c641dbf239 100644 --- a/platform-bible-react/functions/DropdownMenuTrigger.html +++ b/platform-bible-react/functions/DropdownMenuTrigger.html @@ -1,4 +1,4 @@ -DropdownMenuTrigger | platform-bible-react

    FunctionDropdownMenuTrigger

    Properties

    $$typeof +DropdownMenuTrigger | platform-bible-react

    FunctionDropdownMenuTrigger

    Properties

    $$typeof defaultProps? displayName? propTypes? diff --git a/platform-bible-react/functions/EnableButton.html b/platform-bible-react/functions/EnableButton.html index 7bea1e729b..ba5537daf6 100644 --- a/platform-bible-react/functions/EnableButton.html +++ b/platform-bible-react/functions/EnableButton.html @@ -1,4 +1,4 @@ EnableButton | platform-bible-react

    FunctionEnableButton

    Settings

    Member Visibility
    +

    Settings

    Member Visibility
    diff --git a/platform-bible-react/functions/FilterButton.html b/platform-bible-react/functions/FilterButton.html index bfcb97b0f2..b3bb33da2c 100644 --- a/platform-bible-react/functions/FilterButton.html +++ b/platform-bible-react/functions/FilterButton.html @@ -2,7 +2,7 @@ to be used with the dropdown menu. It uses forwardRef to pass the button to the dropdown trigger asChild.

    Properties

    $$typeof +

    Properties

    $$typeof defaultProps? displayName? propTypes? diff --git a/platform-bible-react/functions/FilterDropdown.html b/platform-bible-react/functions/FilterDropdown.html index 999fc24be6..787b304a9d 100644 --- a/platform-bible-react/functions/FilterDropdown.html +++ b/platform-bible-react/functions/FilterDropdown.html @@ -1,4 +1,4 @@ FilterDropdown | platform-bible-react

    FunctionFilterDropdown

    Settings

    Member Visibility
    +

    Settings

    Member Visibility
    diff --git a/platform-bible-react/functions/Footer.html b/platform-bible-react/functions/Footer.html index f37cb2e4b3..b12269aa08 100644 --- a/platform-bible-react/functions/Footer.html +++ b/platform-bible-react/functions/Footer.html @@ -1,4 +1,4 @@ Footer | platform-bible-react

    FunctionFooter

    Settings

    Member Visibility
    +

    Settings

    Member Visibility
    diff --git a/platform-bible-react/functions/GridMenu.html b/platform-bible-react/functions/GridMenu.html index c9acf7b50d..c564c82f1a 100644 --- a/platform-bible-react/functions/GridMenu.html +++ b/platform-bible-react/functions/GridMenu.html @@ -1 +1 @@ -GridMenu | platform-bible-react

    FunctionGridMenu

    Settings

    Member Visibility
    +GridMenu | platform-bible-react

    FunctionGridMenu

    Settings

    Member Visibility
    diff --git a/platform-bible-react/functions/HamburgerMenuButton.html b/platform-bible-react/functions/HamburgerMenuButton.html index bf0cd52070..58d02e52dc 100644 --- a/platform-bible-react/functions/HamburgerMenuButton.html +++ b/platform-bible-react/functions/HamburgerMenuButton.html @@ -1 +1 @@ -HamburgerMenuButton | platform-bible-react

    FunctionHamburgerMenuButton

    Settings

    Member Visibility
    +HamburgerMenuButton | platform-bible-react

    FunctionHamburgerMenuButton

    Settings

    Member Visibility
    diff --git a/platform-bible-react/functions/IconButton.html b/platform-bible-react/functions/IconButton.html index 5bedea65ba..4f614f2089 100644 --- a/platform-bible-react/functions/IconButton.html +++ b/platform-bible-react/functions/IconButton.html @@ -1,4 +1,4 @@ IconButton | platform-bible-react

    FunctionIconButton

    Settings

    Member Visibility
    +

    Parameters

    Returns Element

    Settings

    Member Visibility
    diff --git a/platform-bible-react/functions/Input.html b/platform-bible-react/functions/Input.html index 4d6d6a9f0b..ea057f8a15 100644 --- a/platform-bible-react/functions/Input.html +++ b/platform-bible-react/functions/Input.html @@ -1,4 +1,4 @@ -Input | platform-bible-react

    FunctionInput

    Properties

    $$typeof +Input | platform-bible-react

    FunctionInput

    Properties

    $$typeof defaultProps? displayName? propTypes? diff --git a/platform-bible-react/functions/InstallButton.html b/platform-bible-react/functions/InstallButton.html index de0d14fb90..ee8f407457 100644 --- a/platform-bible-react/functions/InstallButton.html +++ b/platform-bible-react/functions/InstallButton.html @@ -1,4 +1,4 @@ InstallButton | platform-bible-react

    FunctionInstallButton

    Settings

    Member Visibility
    +

    Settings

    Member Visibility
    diff --git a/platform-bible-react/functions/Inventory.html b/platform-bible-react/functions/Inventory.html index 83caa549c8..19b8dd44b9 100644 --- a/platform-bible-react/functions/Inventory.html +++ b/platform-bible-react/functions/Inventory.html @@ -1,2 +1,2 @@ Inventory | platform-bible-react

    FunctionInventory

    Settings

    Member Visibility
    +

    Parameters

    • __namedParameters: InventoryProps

    Returns Element

    Settings

    Member Visibility
    diff --git a/platform-bible-react/functions/Label.html b/platform-bible-react/functions/Label.html index 47e13df123..aa07c67ad9 100644 --- a/platform-bible-react/functions/Label.html +++ b/platform-bible-react/functions/Label.html @@ -1,4 +1,4 @@ -Label | platform-bible-react

    FunctionLabel

    Properties

    $$typeof +Label | platform-bible-react

    FunctionLabel

    Properties

    $$typeof defaultProps? displayName? propTypes? diff --git a/platform-bible-react/functions/MarkdownRenderer.html b/platform-bible-react/functions/MarkdownRenderer.html index 2e1d675ba9..4fc1b86463 100644 --- a/platform-bible-react/functions/MarkdownRenderer.html +++ b/platform-bible-react/functions/MarkdownRenderer.html @@ -1,4 +1,4 @@ MarkdownRenderer | platform-bible-react

    FunctionMarkdownRenderer

    Settings

    Member Visibility
    +

    Settings

    Member Visibility
    diff --git a/platform-bible-react/functions/MenuItem.html b/platform-bible-react/functions/MenuItem.html index 59b56cc7ac..a94bfe1302 100644 --- a/platform-bible-react/functions/MenuItem.html +++ b/platform-bible-react/functions/MenuItem.html @@ -1 +1 @@ -MenuItem | platform-bible-react

    FunctionMenuItem

    Settings

    Member Visibility
    +MenuItem | platform-bible-react

    FunctionMenuItem

    Settings

    Member Visibility
    diff --git a/platform-bible-react/functions/MoreInfo.html b/platform-bible-react/functions/MoreInfo.html index bd6852935c..39dbb18688 100644 --- a/platform-bible-react/functions/MoreInfo.html +++ b/platform-bible-react/functions/MoreInfo.html @@ -4,4 +4,4 @@
  • Returns the more info component that displays the category, number of downloads, languages, and links to the website and support
    • -

    Settings

    Member Visibility
    +

    Settings

    Member Visibility
    diff --git a/platform-bible-react/functions/NavigationContentSearch.html b/platform-bible-react/functions/NavigationContentSearch.html index 8731324d0d..f77e3a6934 100644 --- a/platform-bible-react/functions/NavigationContentSearch.html +++ b/platform-bible-react/functions/NavigationContentSearch.html @@ -1 +1 @@ -NavigationContentSearch | platform-bible-react

    FunctionNavigationContentSearch

    Settings

    Member Visibility
    +NavigationContentSearch | platform-bible-react

    FunctionNavigationContentSearch

    Settings

    Member Visibility
    diff --git a/platform-bible-react/functions/NoExtensionsFound.html b/platform-bible-react/functions/NoExtensionsFound.html index c1e8175a4e..bb8591bb5d 100644 --- a/platform-bible-react/functions/NoExtensionsFound.html +++ b/platform-bible-react/functions/NoExtensionsFound.html @@ -2,4 +2,4 @@

    Parameters

    • __namedParameters: NoExtensionsFoundProps

    Returns Element

    • Returns the message component that displays the message to the user.
    -

    Settings

    Member Visibility
    +

    Settings

    Member Visibility
    diff --git a/platform-bible-react/functions/RadioGroup.html b/platform-bible-react/functions/RadioGroup.html index 7ded5434f9..a157ca57da 100644 --- a/platform-bible-react/functions/RadioGroup.html +++ b/platform-bible-react/functions/RadioGroup.html @@ -1,4 +1,4 @@ -RadioGroup | platform-bible-react

    FunctionRadioGroup

    Properties

    $$typeof +RadioGroup | platform-bible-react

    FunctionRadioGroup

    Properties

    $$typeof defaultProps? displayName? propTypes? diff --git a/platform-bible-react/functions/RadioGroupItem.html b/platform-bible-react/functions/RadioGroupItem.html index 3fdf3e6bc3..ef87c09f54 100644 --- a/platform-bible-react/functions/RadioGroupItem.html +++ b/platform-bible-react/functions/RadioGroupItem.html @@ -1,4 +1,4 @@ -RadioGroupItem | platform-bible-react

    FunctionRadioGroupItem

    Properties

    $$typeof +RadioGroupItem | platform-bible-react

    FunctionRadioGroupItem

    Properties

    $$typeof defaultProps? displayName? propTypes? diff --git a/platform-bible-react/functions/ScriptureResultsViewer.html b/platform-bible-react/functions/ScriptureResultsViewer.html index 49bca9dad8..872547f939 100644 --- a/platform-bible-react/functions/ScriptureResultsViewer.html +++ b/platform-bible-react/functions/ScriptureResultsViewer.html @@ -5,4 +5,4 @@ displays somewhat "tree-like" which allows it to be more horizontally compact and intuitive. But it also has the option of displaying as a traditional table with column headings (with or without the source column showing).

    -

    Parameters

    Returns Element

    Settings

    Member Visibility
    +

    Parameters

    Returns Element

    Settings

    Member Visibility
    diff --git a/platform-bible-react/functions/ScrollGroupSelector.html b/platform-bible-react/functions/ScrollGroupSelector.html index 6b5f6ed332..c1989570ea 100644 --- a/platform-bible-react/functions/ScrollGroupSelector.html +++ b/platform-bible-react/functions/ScrollGroupSelector.html @@ -1,2 +1,2 @@ ScrollGroupSelector | platform-bible-react

    FunctionScrollGroupSelector

    Settings

    Member Visibility
    +

    Parameters

    Returns Element

    Settings

    Member Visibility
    diff --git a/platform-bible-react/functions/SearchBar.html b/platform-bible-react/functions/SearchBar.html index 35074131ea..431478b684 100644 --- a/platform-bible-react/functions/SearchBar.html +++ b/platform-bible-react/functions/SearchBar.html @@ -1 +1 @@ -SearchBar | platform-bible-react

    FunctionSearchBar

    Settings

    Member Visibility
    +SearchBar | platform-bible-react

    FunctionSearchBar

    Settings

    Member Visibility
    diff --git a/platform-bible-react/functions/Select.html b/platform-bible-react/functions/Select.html index c57bfba6e6..d233225930 100644 --- a/platform-bible-react/functions/Select.html +++ b/platform-bible-react/functions/Select.html @@ -1,5 +1,5 @@ Select | platform-bible-react

    FunctionSelect

    Properties

    contextTypes? +

    Returns ReactNode

    Properties

    contextTypes? defaultProps? displayName? propTypes? diff --git a/platform-bible-react/functions/SelectContent.html b/platform-bible-react/functions/SelectContent.html index 98a5f8d27b..e82ce6f41e 100644 --- a/platform-bible-react/functions/SelectContent.html +++ b/platform-bible-react/functions/SelectContent.html @@ -1,4 +1,4 @@ -SelectContent | platform-bible-react

    FunctionSelectContent

    Properties

    $$typeof +SelectContent | platform-bible-react

    FunctionSelectContent

    Properties

    $$typeof defaultProps? displayName? propTypes? diff --git a/platform-bible-react/functions/SelectGroup.html b/platform-bible-react/functions/SelectGroup.html index a3fa59fa81..cf9243e74d 100644 --- a/platform-bible-react/functions/SelectGroup.html +++ b/platform-bible-react/functions/SelectGroup.html @@ -1,4 +1,4 @@ -SelectGroup | platform-bible-react

    FunctionSelectGroup

    Properties

    $$typeof +SelectGroup | platform-bible-react

    FunctionSelectGroup

    Properties

    $$typeof defaultProps? displayName? propTypes? diff --git a/platform-bible-react/functions/SelectItem.html b/platform-bible-react/functions/SelectItem.html index e3c0bc5684..0f2e87887c 100644 --- a/platform-bible-react/functions/SelectItem.html +++ b/platform-bible-react/functions/SelectItem.html @@ -1,4 +1,4 @@ -SelectItem | platform-bible-react

    FunctionSelectItem

    Properties

    $$typeof +SelectItem | platform-bible-react

    FunctionSelectItem

    Properties

    $$typeof defaultProps? displayName? propTypes? diff --git a/platform-bible-react/functions/SelectLabel.html b/platform-bible-react/functions/SelectLabel.html index 57f6e09aed..b1681d46f0 100644 --- a/platform-bible-react/functions/SelectLabel.html +++ b/platform-bible-react/functions/SelectLabel.html @@ -1,4 +1,4 @@ -SelectLabel | platform-bible-react

    FunctionSelectLabel

    Properties

    $$typeof +SelectLabel | platform-bible-react

    FunctionSelectLabel

    Properties

    $$typeof defaultProps? displayName? propTypes? diff --git a/platform-bible-react/functions/SelectScrollDownButton.html b/platform-bible-react/functions/SelectScrollDownButton.html index 7546ac7a33..1babdcda8d 100644 --- a/platform-bible-react/functions/SelectScrollDownButton.html +++ b/platform-bible-react/functions/SelectScrollDownButton.html @@ -1,4 +1,4 @@ -SelectScrollDownButton | platform-bible-react

    FunctionSelectScrollDownButton

    Properties

    $$typeof +SelectScrollDownButton | platform-bible-react

    FunctionSelectScrollDownButton

    Properties

    $$typeof defaultProps? displayName? propTypes? diff --git a/platform-bible-react/functions/SelectScrollUpButton.html b/platform-bible-react/functions/SelectScrollUpButton.html index 4c164c7bbf..0cbb815b88 100644 --- a/platform-bible-react/functions/SelectScrollUpButton.html +++ b/platform-bible-react/functions/SelectScrollUpButton.html @@ -1,4 +1,4 @@ -SelectScrollUpButton | platform-bible-react

    FunctionSelectScrollUpButton

    Properties

    $$typeof +SelectScrollUpButton | platform-bible-react

    FunctionSelectScrollUpButton

    Properties

    $$typeof defaultProps? displayName? propTypes? diff --git a/platform-bible-react/functions/SelectSeparator.html b/platform-bible-react/functions/SelectSeparator.html index 290c4221fa..3396cda93e 100644 --- a/platform-bible-react/functions/SelectSeparator.html +++ b/platform-bible-react/functions/SelectSeparator.html @@ -1,4 +1,4 @@ -SelectSeparator | platform-bible-react

    FunctionSelectSeparator

    Properties

    $$typeof +SelectSeparator | platform-bible-react

    FunctionSelectSeparator

    Properties

    $$typeof defaultProps? displayName? propTypes? diff --git a/platform-bible-react/functions/SelectTrigger.html b/platform-bible-react/functions/SelectTrigger.html index d2cc8e5b40..c621a4b864 100644 --- a/platform-bible-react/functions/SelectTrigger.html +++ b/platform-bible-react/functions/SelectTrigger.html @@ -1,4 +1,4 @@ -SelectTrigger | platform-bible-react

    FunctionSelectTrigger

    Properties

    $$typeof +SelectTrigger | platform-bible-react

    FunctionSelectTrigger

    Properties

    $$typeof defaultProps? displayName? propTypes? diff --git a/platform-bible-react/functions/SelectValue.html b/platform-bible-react/functions/SelectValue.html index b0aede2f79..c4df63bfac 100644 --- a/platform-bible-react/functions/SelectValue.html +++ b/platform-bible-react/functions/SelectValue.html @@ -1,4 +1,4 @@ -SelectValue | platform-bible-react

    FunctionSelectValue

    Properties

    $$typeof +SelectValue | platform-bible-react

    FunctionSelectValue

    Properties

    $$typeof defaultProps? displayName? propTypes? diff --git a/platform-bible-react/functions/Separator.html b/platform-bible-react/functions/Separator.html index 598265f847..7d39f205ff 100644 --- a/platform-bible-react/functions/Separator.html +++ b/platform-bible-react/functions/Separator.html @@ -1,4 +1,4 @@ -Separator | platform-bible-react

    FunctionSeparator

    Properties

    $$typeof +Separator | platform-bible-react

    FunctionSeparator

    Properties

    $$typeof defaultProps? displayName? propTypes? diff --git a/platform-bible-react/functions/SettingsList.html b/platform-bible-react/functions/SettingsList.html index f62b931df6..d5d5e3a484 100644 --- a/platform-bible-react/functions/SettingsList.html +++ b/platform-bible-react/functions/SettingsList.html @@ -1,4 +1,4 @@ SettingsList | platform-bible-react

    FunctionSettingsList

    Settings

    Member Visibility
    +

    Settings

    Member Visibility
    diff --git a/platform-bible-react/functions/SettingsListHeader.html b/platform-bible-react/functions/SettingsListHeader.html index 6699132d6e..6912723511 100644 --- a/platform-bible-react/functions/SettingsListHeader.html +++ b/platform-bible-react/functions/SettingsListHeader.html @@ -1,3 +1,3 @@ SettingsListHeader | platform-bible-react

    FunctionSettingsListHeader

    Settings

    Member Visibility
    +

    Settings

    Member Visibility
    diff --git a/platform-bible-react/functions/SettingsListItem.html b/platform-bible-react/functions/SettingsListItem.html index 9719347a29..f2afe74f87 100644 --- a/platform-bible-react/functions/SettingsListItem.html +++ b/platform-bible-react/functions/SettingsListItem.html @@ -1,3 +1,3 @@ SettingsListItem | platform-bible-react

    FunctionSettingsListItem

    Settings

    Member Visibility
    +

    Settings

    Member Visibility
    diff --git a/platform-bible-react/functions/Slider.html b/platform-bible-react/functions/Slider.html index 86d2825d4b..e012c77d01 100644 --- a/platform-bible-react/functions/Slider.html +++ b/platform-bible-react/functions/Slider.html @@ -1,4 +1,4 @@ -Slider | platform-bible-react

    FunctionSlider

    Properties

    $$typeof +Slider | platform-bible-react

    FunctionSlider

    Properties

    $$typeof defaultProps? displayName? propTypes? diff --git a/platform-bible-react/functions/Sonner-1.html b/platform-bible-react/functions/Sonner-1.html index 4e9b3e81e5..477ab62f62 100644 --- a/platform-bible-react/functions/Sonner-1.html +++ b/platform-bible-react/functions/Sonner-1.html @@ -1 +1 @@ -Sonner | platform-bible-react

    FunctionSonner

    Settings

    Member Visibility
    +Sonner | platform-bible-react

    FunctionSonner

    Settings

    Member Visibility
    diff --git a/platform-bible-react/functions/Spinner.html b/platform-bible-react/functions/Spinner.html index 6890c7f61f..fab40df646 100644 --- a/platform-bible-react/functions/Spinner.html +++ b/platform-bible-react/functions/Spinner.html @@ -1,4 +1,4 @@ -Spinner | platform-bible-react

    FunctionSpinner

    Properties

    $$typeof +Spinner | platform-bible-react

    FunctionSpinner

    Properties

    $$typeof defaultProps? displayName? propTypes? diff --git a/platform-bible-react/functions/Switch.html b/platform-bible-react/functions/Switch.html index e171ff94a7..b27a889a2a 100644 --- a/platform-bible-react/functions/Switch.html +++ b/platform-bible-react/functions/Switch.html @@ -1,4 +1,4 @@ -Switch | platform-bible-react

    FunctionSwitch

    Properties

    $$typeof +Switch | platform-bible-react

    FunctionSwitch

    Properties

    $$typeof defaultProps? displayName? propTypes? diff --git a/platform-bible-react/functions/Table.html b/platform-bible-react/functions/Table.html index 3ce0577e55..a5524f0bea 100644 --- a/platform-bible-react/functions/Table.html +++ b/platform-bible-react/functions/Table.html @@ -1,4 +1,4 @@ -Table | platform-bible-react

    FunctionTable

    Properties

    $$typeof +Table | platform-bible-react

    FunctionTable

    Properties

    $$typeof defaultProps? displayName? propTypes? diff --git a/platform-bible-react/functions/TableBody.html b/platform-bible-react/functions/TableBody.html index 1e83945a85..4c1fe4b41d 100644 --- a/platform-bible-react/functions/TableBody.html +++ b/platform-bible-react/functions/TableBody.html @@ -1,4 +1,4 @@ -TableBody | platform-bible-react

    FunctionTableBody

    Properties

    $$typeof +TableBody | platform-bible-react

    FunctionTableBody

    Properties

    $$typeof defaultProps? displayName? propTypes? diff --git a/platform-bible-react/functions/TableCaption.html b/platform-bible-react/functions/TableCaption.html index 25f2cb1feb..2a18ca62a2 100644 --- a/platform-bible-react/functions/TableCaption.html +++ b/platform-bible-react/functions/TableCaption.html @@ -1,4 +1,4 @@ -TableCaption | platform-bible-react

    FunctionTableCaption

    Properties

    $$typeof +TableCaption | platform-bible-react

    FunctionTableCaption

    Properties

    $$typeof defaultProps? displayName? propTypes? diff --git a/platform-bible-react/functions/TableCell.html b/platform-bible-react/functions/TableCell.html index d2fd5b0cfb..de4a866a5a 100644 --- a/platform-bible-react/functions/TableCell.html +++ b/platform-bible-react/functions/TableCell.html @@ -1,4 +1,4 @@ -TableCell | platform-bible-react

    FunctionTableCell

    Properties

    $$typeof +TableCell | platform-bible-react

    FunctionTableCell

    Properties

    $$typeof defaultProps? displayName? propTypes? diff --git a/platform-bible-react/functions/TableFooter.html b/platform-bible-react/functions/TableFooter.html index 3f7cd740dc..9fb4bd0e43 100644 --- a/platform-bible-react/functions/TableFooter.html +++ b/platform-bible-react/functions/TableFooter.html @@ -1,4 +1,4 @@ -TableFooter | platform-bible-react

    FunctionTableFooter

    Properties

    $$typeof +TableFooter | platform-bible-react

    FunctionTableFooter

    Properties

    $$typeof defaultProps? displayName? propTypes? diff --git a/platform-bible-react/functions/TableHead.html b/platform-bible-react/functions/TableHead.html index c6867fb574..207b2d1d0a 100644 --- a/platform-bible-react/functions/TableHead.html +++ b/platform-bible-react/functions/TableHead.html @@ -1,4 +1,4 @@ -TableHead | platform-bible-react

    FunctionTableHead

    Properties

    $$typeof +TableHead | platform-bible-react

    FunctionTableHead

    Properties

    $$typeof defaultProps? displayName? propTypes? diff --git a/platform-bible-react/functions/TableHeader.html b/platform-bible-react/functions/TableHeader.html index 9e7ebdad51..1c35cf96e6 100644 --- a/platform-bible-react/functions/TableHeader.html +++ b/platform-bible-react/functions/TableHeader.html @@ -1,4 +1,4 @@ -TableHeader | platform-bible-react

    FunctionTableHeader

    Properties

    $$typeof +TableHeader | platform-bible-react

    FunctionTableHeader

    Properties

    $$typeof defaultProps? displayName? propTypes? diff --git a/platform-bible-react/functions/TableRow.html b/platform-bible-react/functions/TableRow.html index 0340d786af..6f92234946 100644 --- a/platform-bible-react/functions/TableRow.html +++ b/platform-bible-react/functions/TableRow.html @@ -1,4 +1,4 @@ -TableRow | platform-bible-react

    FunctionTableRow

    Properties

    $$typeof +TableRow | platform-bible-react

    FunctionTableRow

    Properties

    $$typeof defaultProps? displayName? propTypes? diff --git a/platform-bible-react/functions/Tabs.html b/platform-bible-react/functions/Tabs.html index 5ec0044065..d4ae6e8c4c 100644 --- a/platform-bible-react/functions/Tabs.html +++ b/platform-bible-react/functions/Tabs.html @@ -1,4 +1,4 @@ -Tabs | platform-bible-react

    FunctionTabs

    Properties

    $$typeof +Tabs | platform-bible-react

    FunctionTabs

    Properties

    $$typeof defaultProps? displayName? propTypes? diff --git a/platform-bible-react/functions/TabsContent.html b/platform-bible-react/functions/TabsContent.html index f460c25063..53b3267ecd 100644 --- a/platform-bible-react/functions/TabsContent.html +++ b/platform-bible-react/functions/TabsContent.html @@ -1,4 +1,4 @@ -TabsContent | platform-bible-react

    FunctionTabsContent

    Properties

    $$typeof +TabsContent | platform-bible-react

    FunctionTabsContent

    Properties

    $$typeof defaultProps? displayName? propTypes? diff --git a/platform-bible-react/functions/TabsList.html b/platform-bible-react/functions/TabsList.html index 62ffded74d..fdcdbe0585 100644 --- a/platform-bible-react/functions/TabsList.html +++ b/platform-bible-react/functions/TabsList.html @@ -1,4 +1,4 @@ -TabsList | platform-bible-react

    FunctionTabsList

    Properties

    $$typeof +TabsList | platform-bible-react

    FunctionTabsList

    Properties

    $$typeof defaultProps? displayName? propTypes? diff --git a/platform-bible-react/functions/TabsTrigger.html b/platform-bible-react/functions/TabsTrigger.html index 4b43829da0..da2b4b774f 100644 --- a/platform-bible-react/functions/TabsTrigger.html +++ b/platform-bible-react/functions/TabsTrigger.html @@ -1,4 +1,4 @@ -TabsTrigger | platform-bible-react

    FunctionTabsTrigger

    Properties

    $$typeof +TabsTrigger | platform-bible-react

    FunctionTabsTrigger

    Properties

    $$typeof defaultProps? displayName? propTypes? diff --git a/platform-bible-react/functions/TextField.html b/platform-bible-react/functions/TextField.html index 549d35c2fa..9763aa4c1a 100644 --- a/platform-bible-react/functions/TextField.html +++ b/platform-bible-react/functions/TextField.html @@ -1,4 +1,4 @@ TextField | platform-bible-react

    FunctionTextField

    Settings

    Member Visibility
    +

    Parameters

    Returns Element

    Settings

    Member Visibility
    diff --git a/platform-bible-react/functions/ToggleGroup.html b/platform-bible-react/functions/ToggleGroup.html index d80f21d1d3..906c085414 100644 --- a/platform-bible-react/functions/ToggleGroup.html +++ b/platform-bible-react/functions/ToggleGroup.html @@ -1,4 +1,4 @@ -ToggleGroup | platform-bible-react

    FunctionToggleGroup

    Properties

    $$typeof +ToggleGroup | platform-bible-react

    FunctionToggleGroup

    Properties

    $$typeof defaultProps? displayName? propTypes? diff --git a/platform-bible-react/functions/ToggleGroupItem.html b/platform-bible-react/functions/ToggleGroupItem.html index 12048f3ebb..72cd4d6bca 100644 --- a/platform-bible-react/functions/ToggleGroupItem.html +++ b/platform-bible-react/functions/ToggleGroupItem.html @@ -1,4 +1,4 @@ -ToggleGroupItem | platform-bible-react

    FunctionToggleGroupItem

    • ToggleGroupItem(props): ReactNode

    • Parameters

      • props: Omit<ToggleGroupItemProps & RefAttributes<HTMLButtonElement>, "ref"> & VariantProps<((props?: ConfigVariants<{ variant: { default: string; outline: string; }; size: { default: string; sm: string; lg: string; }; }> & ClassProp) => string)> & RefAttributes<HTMLButtonElement>

      Returns ReactNode

    Properties

    $$typeof +ToggleGroupItem | platform-bible-react

    FunctionToggleGroupItem

    • ToggleGroupItem(props): ReactNode

    • Parameters

      • props: Omit<ToggleGroupItemProps & RefAttributes<HTMLButtonElement>, "ref"> & VariantProps<((props?: ConfigVariants<{ variant: { default: string; outline: string; }; size: { default: string; sm: string; lg: string; }; }> & ClassProp) => string)> & RefAttributes<HTMLButtonElement>

      Returns ReactNode

    Properties

    $$typeof defaultProps? displayName? propTypes? diff --git a/platform-bible-react/functions/Toolbar.html b/platform-bible-react/functions/Toolbar.html index 9546dc09ce..0bba7f9462 100644 --- a/platform-bible-react/functions/Toolbar.html +++ b/platform-bible-react/functions/Toolbar.html @@ -1 +1 @@ -Toolbar | platform-bible-react

    FunctionToolbar

    Settings

    Member Visibility
    +Toolbar | platform-bible-react

    FunctionToolbar

    Settings

    Member Visibility
    diff --git a/platform-bible-react/functions/UpdateButton.html b/platform-bible-react/functions/UpdateButton.html index 8d13a35877..431770c10c 100644 --- a/platform-bible-react/functions/UpdateButton.html +++ b/platform-bible-react/functions/UpdateButton.html @@ -1,4 +1,4 @@ UpdateButton | platform-bible-react

    FunctionUpdateButton

    Settings

    Member Visibility
    +

    Settings

    Member Visibility
    diff --git a/platform-bible-react/functions/VersionHistory.html b/platform-bible-react/functions/VersionHistory.html index 75b5dfaffa..1c926f333e 100644 --- a/platform-bible-react/functions/VersionHistory.html +++ b/platform-bible-react/functions/VersionHistory.html @@ -1,4 +1,4 @@ VersionHistory | platform-bible-react

    FunctionVersionHistory

    Settings

    Member Visibility
    +

    Settings

    Member Visibility
    diff --git a/platform-bible-react/functions/VerticalTabs.html b/platform-bible-react/functions/VerticalTabs.html index 5ab2d56978..9093b5f6c9 100644 --- a/platform-bible-react/functions/VerticalTabs.html +++ b/platform-bible-react/functions/VerticalTabs.html @@ -1,4 +1,4 @@ -VerticalTabs | platform-bible-react

    FunctionVerticalTabs

    Properties

    $$typeof +VerticalTabs | platform-bible-react

    FunctionVerticalTabs

    Properties

    $$typeof defaultProps? displayName? propTypes? diff --git a/platform-bible-react/functions/VerticalTabsContent.html b/platform-bible-react/functions/VerticalTabsContent.html index be1bf0a71d..8c1322e8e3 100644 --- a/platform-bible-react/functions/VerticalTabsContent.html +++ b/platform-bible-react/functions/VerticalTabsContent.html @@ -1,4 +1,4 @@ -VerticalTabsContent | platform-bible-react

    FunctionVerticalTabsContent

    Properties

    $$typeof +VerticalTabsContent | platform-bible-react

    FunctionVerticalTabsContent

    Properties

    $$typeof defaultProps? displayName? propTypes? diff --git a/platform-bible-react/functions/VerticalTabsList.html b/platform-bible-react/functions/VerticalTabsList.html index 65afaa5cd8..214821a842 100644 --- a/platform-bible-react/functions/VerticalTabsList.html +++ b/platform-bible-react/functions/VerticalTabsList.html @@ -1,4 +1,4 @@ -VerticalTabsList | platform-bible-react

    FunctionVerticalTabsList

    Properties

    $$typeof +VerticalTabsList | platform-bible-react

    FunctionVerticalTabsList

    Properties

    $$typeof defaultProps? displayName? propTypes? diff --git a/platform-bible-react/functions/VerticalTabsTrigger.html b/platform-bible-react/functions/VerticalTabsTrigger.html index 56316773f9..cc48518b91 100644 --- a/platform-bible-react/functions/VerticalTabsTrigger.html +++ b/platform-bible-react/functions/VerticalTabsTrigger.html @@ -1,4 +1,4 @@ -VerticalTabsTrigger | platform-bible-react

    FunctionVerticalTabsTrigger

    Properties

    $$typeof +VerticalTabsTrigger | platform-bible-react

    FunctionVerticalTabsTrigger

    Properties

    $$typeof defaultProps? displayName? propTypes? diff --git a/platform-bible-react/functions/buttonVariants.html b/platform-bible-react/functions/buttonVariants.html index 4bd59318f7..91c31c7355 100644 --- a/platform-bible-react/functions/buttonVariants.html +++ b/platform-bible-react/functions/buttonVariants.html @@ -1 +1 @@ -buttonVariants | platform-bible-react

    FunctionbuttonVariants

    • buttonVariants(props?): string

    • Parameters

      • Optionalprops: ConfigVariants<{ variant: { default: string; destructive: string; outline: string; secondary: string; ghost: string; link: string; }; size: { default: string; sm: string; lg: string; icon: string; }; }> & ClassProp

      Returns string

    Settings

    Member Visibility
    +buttonVariants | platform-bible-react

    FunctionbuttonVariants

    • buttonVariants(props?): string

    • Parameters

      • Optionalprops: ConfigVariants<{ variant: { default: string; destructive: string; outline: string; secondary: string; ghost: string; link: string; }; size: { default: string; sm: string; lg: string; icon: string; }; }> & ClassProp

      Returns string

    Settings

    Member Visibility
    diff --git a/platform-bible-react/functions/cn.html b/platform-bible-react/functions/cn.html index 4f0d830cb0..d15e423875 100644 --- a/platform-bible-react/functions/cn.html +++ b/platform-bible-react/functions/cn.html @@ -29,4 +29,4 @@ therefore it was not applied
  • Notice that 'some-class' was applied. This function is not limited only to Tailwind classes.
    • -

    Settings

    Member Visibility
    +

    Settings

    Member Visibility
    diff --git a/platform-bible-react/functions/getBookNumFromId.html b/platform-bible-react/functions/getBookNumFromId.html index 9a4014a245..e5f39dab06 100644 --- a/platform-bible-react/functions/getBookNumFromId.html +++ b/platform-bible-react/functions/getBookNumFromId.html @@ -2,4 +2,4 @@

    Settings

    Member Visibility
    +

    Settings

    Member Visibility
    diff --git a/platform-bible-react/functions/getLinesFromUSFM.html b/platform-bible-react/functions/getLinesFromUSFM.html index da5a845b9d..3b82801af9 100644 --- a/platform-bible-react/functions/getLinesFromUSFM.html +++ b/platform-bible-react/functions/getLinesFromUSFM.html @@ -1,4 +1,4 @@ getLinesFromUSFM | platform-bible-react

    FunctiongetLinesFromUSFM

    Splits USFM string into shorter line-like segments

    Settings

    Member Visibility
    +

    Settings

    Member Visibility
    diff --git a/platform-bible-react/functions/getNumberFromUSFM.html b/platform-bible-react/functions/getNumberFromUSFM.html index 4c70db24f9..622226cfb9 100644 --- a/platform-bible-react/functions/getNumberFromUSFM.html +++ b/platform-bible-react/functions/getNumberFromUSFM.html @@ -1,4 +1,4 @@ getNumberFromUSFM | platform-bible-react

    FunctiongetNumberFromUSFM

    Extracts chapter or verse number from USFM strings that start with a \c or \v marker

    Settings

    Member Visibility
    +

    Settings

    Member Visibility
    diff --git a/platform-bible-react/functions/getStatusForItem.html b/platform-bible-react/functions/getStatusForItem.html index 1ce0534f3a..4616b791d7 100644 --- a/platform-bible-react/functions/getStatusForItem.html +++ b/platform-bible-react/functions/getStatusForItem.html @@ -3,4 +3,4 @@
  • approvedItems: string[]

    Array of approved items, typically as defined in Settings.xml

  • unapprovedItems: string[]

    Array of unapproved items, typically as defined in Settings.xml

    • Returns Status

    The status for the specified item

    -

    Settings

    Member Visibility
    +

    Settings

    Member Visibility
    diff --git a/platform-bible-react/functions/inventoryCountColumn.html b/platform-bible-react/functions/inventoryCountColumn.html index 981842497f..0c8d48ba4a 100644 --- a/platform-bible-react/functions/inventoryCountColumn.html +++ b/platform-bible-react/functions/inventoryCountColumn.html @@ -1,4 +1,4 @@ inventoryCountColumn | platform-bible-react

    FunctioninventoryCountColumn

    Function that creates the count column for inventories. Should be used with the DataTable component.

    Settings

    Member Visibility
    +

    Settings

    Member Visibility
    diff --git a/platform-bible-react/functions/inventoryItemColumn.html b/platform-bible-react/functions/inventoryItemColumn.html index 6287d64168..87e21846a0 100644 --- a/platform-bible-react/functions/inventoryItemColumn.html +++ b/platform-bible-react/functions/inventoryItemColumn.html @@ -1,4 +1,4 @@ inventoryItemColumn | platform-bible-react

    FunctioninventoryItemColumn

    Function that creates the item column for inventories

    Settings

    Member Visibility
    +

    Settings

    Member Visibility
    diff --git a/platform-bible-react/functions/inventoryStatusColumn.html b/platform-bible-react/functions/inventoryStatusColumn.html index 1521caa346..2ec7114f5e 100644 --- a/platform-bible-react/functions/inventoryStatusColumn.html +++ b/platform-bible-react/functions/inventoryStatusColumn.html @@ -7,4 +7,4 @@
  • onUnapprovedItemsChange: ((items: string[]) => void)

    Callback function that stores the updated list of unapproved items

      • (items): void

      • Parameters

        • items: string[]

        Returns void

    • Returns ColumnDef<InventoryTableData>

    Column that shows the status buttons for the related inventory item. The button for the current status of the item is selected

    -

    Settings

    Member Visibility
    +

    Settings

    Member Visibility
    diff --git a/platform-bible-react/functions/useEvent.html b/platform-bible-react/functions/useEvent.html index c711611dbf..db42305b77 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
    +

    Returns void

    Settings

    Member Visibility
    diff --git a/platform-bible-react/functions/useEventAsync.html b/platform-bible-react/functions/useEventAsync.html index de2fdca06a..020517a6cb 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
    +

    Returns void

    Settings

    Member Visibility
    diff --git a/platform-bible-react/functions/usePromise.html b/platform-bible-react/functions/usePromise.html index 078a873144..8a1057a712 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
    +

    Settings

    Member Visibility
    diff --git a/platform-bible-react/interfaces/ButtonProps.html b/platform-bible-react/interfaces/ButtonProps.html index 7e769b6b28..9808c44840 100644 --- a/platform-bible-react/interfaces/ButtonProps.html +++ b/platform-bible-react/interfaces/ButtonProps.html @@ -1,4 +1,4 @@ -ButtonProps | platform-bible-react

    InterfaceButtonProps

    interface ButtonProps {
        about?: string;
        accessKey?: string;
        aria-activedescendant?: string;
        aria-atomic?: Booleanish;
        aria-autocomplete?:
            | "inline"
            | "both"
            | "none"
            | "list";
        aria-braillelabel?: string;
        aria-brailleroledescription?: string;
        aria-busy?: Booleanish;
        aria-checked?:
            | boolean
            | "false"
            | "mixed"
            | "true";
        aria-colcount?: number;
        aria-colindex?: number;
        aria-colindextext?: string;
        aria-colspan?: number;
        aria-controls?: string;
        aria-current?:
            | boolean
            | "false"
            | "time"
            | "location"
            | "page"
            | "true"
            | "step"
            | "date";
        aria-describedby?: string;
        aria-description?: string;
        aria-details?: string;
        aria-disabled?: Booleanish;
        aria-dropeffect?:
            | "link"
            | "none"
            | "copy"
            | "move"
            | "execute"
            | "popup";
        aria-errormessage?: string;
        aria-expanded?: Booleanish;
        aria-flowto?: string;
        aria-grabbed?: Booleanish;
        aria-haspopup?:
            | boolean
            | "false"
            | "grid"
            | "dialog"
            | "menu"
            | "listbox"
            | "true"
            | "tree";
        aria-hidden?: Booleanish;
        aria-invalid?:
            | boolean
            | "false"
            | "true"
            | "grammar"
            | "spelling";
        aria-keyshortcuts?: string;
        aria-label?: string;
        aria-labelledby?: string;
        aria-level?: number;
        aria-live?: "off" | "assertive" | "polite";
        aria-modal?: Booleanish;
        aria-multiline?: Booleanish;
        aria-multiselectable?: Booleanish;
        aria-orientation?: "horizontal" | "vertical";
        aria-owns?: string;
        aria-placeholder?: string;
        aria-posinset?: number;
        aria-pressed?:
            | boolean
            | "false"
            | "mixed"
            | "true";
        aria-readonly?: Booleanish;
        aria-relevant?:
            | "all"
            | "text"
            | "additions"
            | "additions removals"
            | "additions text"
            | "removals"
            | "removals additions"
            | "removals text"
            | "text additions"
            | "text removals";
        aria-required?: Booleanish;
        aria-roledescription?: string;
        aria-rowcount?: number;
        aria-rowindex?: number;
        aria-rowindextext?: string;
        aria-rowspan?: number;
        aria-selected?: Booleanish;
        aria-setsize?: number;
        aria-sort?:
            | "none"
            | "other"
            | "ascending"
            | "descending";
        aria-valuemax?: number;
        aria-valuemin?: number;
        aria-valuenow?: number;
        aria-valuetext?: string;
        asChild?: boolean;
        autoCapitalize?:
            | "none"
            | "off"
            | "on"
            | string & {}
            | "words"
            | "sentences"
            | "characters";
        autoCorrect?: string;
        autoFocus?: boolean;
        autoSave?: string;
        children?: ReactNode;
        className?: string;
        color?: string;
        content?: string;
        contentEditable?: "inherit" | Booleanish | "plaintext-only";
        contextMenu?: string;
        dangerouslySetInnerHTML?: {
            __html: string | TrustedHTML;
        };
        datatype?: string;
        defaultChecked?: boolean;
        defaultValue?: string | number | readonly string[];
        dir?: string;
        disabled?: boolean;
        draggable?: Booleanish;
        enterKeyHint?:
            | "search"
            | "next"
            | "done"
            | "enter"
            | "go"
            | "previous"
            | "send";
        form?: string;
        formAction?: string;
        formEncType?: string;
        formMethod?: string;
        formNoValidate?: boolean;
        formTarget?: string;
        hidden?: boolean;
        id?: string;
        inlist?: any;
        inputMode?:
            | "search"
            | "numeric"
            | "none"
            | "url"
            | "text"
            | "email"
            | "tel"
            | "decimal";
        is?: string;
        itemID?: string;
        itemProp?: string;
        itemRef?: string;
        itemScope?: boolean;
        itemType?: string;
        lang?: string;
        name?: string;
        nonce?: string;
        onAbort?: ReactEventHandler<HTMLButtonElement>;
        onAbortCapture?: ReactEventHandler<HTMLButtonElement>;
        onAnimationEnd?: AnimationEventHandler<HTMLButtonElement>;
        onAnimationEndCapture?: AnimationEventHandler<HTMLButtonElement>;
        onAnimationIteration?: AnimationEventHandler<HTMLButtonElement>;
        onAnimationIterationCapture?: AnimationEventHandler<HTMLButtonElement>;
        onAnimationStart?: AnimationEventHandler<HTMLButtonElement>;
        onAnimationStartCapture?: AnimationEventHandler<HTMLButtonElement>;
        onAuxClick?: MouseEventHandler<HTMLButtonElement>;
        onAuxClickCapture?: MouseEventHandler<HTMLButtonElement>;
        onBeforeInput?: FormEventHandler<HTMLButtonElement>;
        onBeforeInputCapture?: FormEventHandler<HTMLButtonElement>;
        onBlur?: FocusEventHandler<HTMLButtonElement>;
        onBlurCapture?: FocusEventHandler<HTMLButtonElement>;
        onCanPlay?: ReactEventHandler<HTMLButtonElement>;
        onCanPlayCapture?: ReactEventHandler<HTMLButtonElement>;
        onCanPlayThrough?: ReactEventHandler<HTMLButtonElement>;
        onCanPlayThroughCapture?: ReactEventHandler<HTMLButtonElement>;
        onChange?: FormEventHandler<HTMLButtonElement>;
        onChangeCapture?: FormEventHandler<HTMLButtonElement>;
        onClick?: MouseEventHandler<HTMLButtonElement>;
        onClickCapture?: MouseEventHandler<HTMLButtonElement>;
        onCompositionEnd?: CompositionEventHandler<HTMLButtonElement>;
        onCompositionEndCapture?: CompositionEventHandler<HTMLButtonElement>;
        onCompositionStart?: CompositionEventHandler<HTMLButtonElement>;
        onCompositionStartCapture?: CompositionEventHandler<HTMLButtonElement>;
        onCompositionUpdate?: CompositionEventHandler<HTMLButtonElement>;
        onCompositionUpdateCapture?: CompositionEventHandler<HTMLButtonElement>;
        onContextMenu?: MouseEventHandler<HTMLButtonElement>;
        onContextMenuCapture?: MouseEventHandler<HTMLButtonElement>;
        onCopy?: ClipboardEventHandler<HTMLButtonElement>;
        onCopyCapture?: ClipboardEventHandler<HTMLButtonElement>;
        onCut?: ClipboardEventHandler<HTMLButtonElement>;
        onCutCapture?: ClipboardEventHandler<HTMLButtonElement>;
        onDoubleClick?: MouseEventHandler<HTMLButtonElement>;
        onDoubleClickCapture?: MouseEventHandler<HTMLButtonElement>;
        onDrag?: DragEventHandler<HTMLButtonElement>;
        onDragCapture?: DragEventHandler<HTMLButtonElement>;
        onDragEnd?: DragEventHandler<HTMLButtonElement>;
        onDragEndCapture?: DragEventHandler<HTMLButtonElement>;
        onDragEnter?: DragEventHandler<HTMLButtonElement>;
        onDragEnterCapture?: DragEventHandler<HTMLButtonElement>;
        onDragExit?: DragEventHandler<HTMLButtonElement>;
        onDragExitCapture?: DragEventHandler<HTMLButtonElement>;
        onDragLeave?: DragEventHandler<HTMLButtonElement>;
        onDragLeaveCapture?: DragEventHandler<HTMLButtonElement>;
        onDragOver?: DragEventHandler<HTMLButtonElement>;
        onDragOverCapture?: DragEventHandler<HTMLButtonElement>;
        onDragStart?: DragEventHandler<HTMLButtonElement>;
        onDragStartCapture?: DragEventHandler<HTMLButtonElement>;
        onDrop?: DragEventHandler<HTMLButtonElement>;
        onDropCapture?: DragEventHandler<HTMLButtonElement>;
        onDurationChange?: ReactEventHandler<HTMLButtonElement>;
        onDurationChangeCapture?: ReactEventHandler<HTMLButtonElement>;
        onEmptied?: ReactEventHandler<HTMLButtonElement>;
        onEmptiedCapture?: ReactEventHandler<HTMLButtonElement>;
        onEncrypted?: ReactEventHandler<HTMLButtonElement>;
        onEncryptedCapture?: ReactEventHandler<HTMLButtonElement>;
        onEnded?: ReactEventHandler<HTMLButtonElement>;
        onEndedCapture?: ReactEventHandler<HTMLButtonElement>;
        onError?: ReactEventHandler<HTMLButtonElement>;
        onErrorCapture?: ReactEventHandler<HTMLButtonElement>;
        onFocus?: FocusEventHandler<HTMLButtonElement>;
        onFocusCapture?: FocusEventHandler<HTMLButtonElement>;
        onGotPointerCapture?: PointerEventHandler<HTMLButtonElement>;
        onGotPointerCaptureCapture?: PointerEventHandler<HTMLButtonElement>;
        onInput?: FormEventHandler<HTMLButtonElement>;
        onInputCapture?: FormEventHandler<HTMLButtonElement>;
        onInvalid?: FormEventHandler<HTMLButtonElement>;
        onInvalidCapture?: FormEventHandler<HTMLButtonElement>;
        onKeyDown?: KeyboardEventHandler<HTMLButtonElement>;
        onKeyDownCapture?: KeyboardEventHandler<HTMLButtonElement>;
        onKeyPress?: KeyboardEventHandler<HTMLButtonElement>;
        onKeyPressCapture?: KeyboardEventHandler<HTMLButtonElement>;
        onKeyUp?: KeyboardEventHandler<HTMLButtonElement>;
        onKeyUpCapture?: KeyboardEventHandler<HTMLButtonElement>;
        onLoad?: ReactEventHandler<HTMLButtonElement>;
        onLoadCapture?: ReactEventHandler<HTMLButtonElement>;
        onLoadedData?: ReactEventHandler<HTMLButtonElement>;
        onLoadedDataCapture?: ReactEventHandler<HTMLButtonElement>;
        onLoadedMetadata?: ReactEventHandler<HTMLButtonElement>;
        onLoadedMetadataCapture?: ReactEventHandler<HTMLButtonElement>;
        onLoadStart?: ReactEventHandler<HTMLButtonElement>;
        onLoadStartCapture?: ReactEventHandler<HTMLButtonElement>;
        onLostPointerCapture?: PointerEventHandler<HTMLButtonElement>;
        onLostPointerCaptureCapture?: PointerEventHandler<HTMLButtonElement>;
        onMouseDown?: MouseEventHandler<HTMLButtonElement>;
        onMouseDownCapture?: MouseEventHandler<HTMLButtonElement>;
        onMouseEnter?: MouseEventHandler<HTMLButtonElement>;
        onMouseLeave?: MouseEventHandler<HTMLButtonElement>;
        onMouseMove?: MouseEventHandler<HTMLButtonElement>;
        onMouseMoveCapture?: MouseEventHandler<HTMLButtonElement>;
        onMouseOut?: MouseEventHandler<HTMLButtonElement>;
        onMouseOutCapture?: MouseEventHandler<HTMLButtonElement>;
        onMouseOver?: MouseEventHandler<HTMLButtonElement>;
        onMouseOverCapture?: MouseEventHandler<HTMLButtonElement>;
        onMouseUp?: MouseEventHandler<HTMLButtonElement>;
        onMouseUpCapture?: MouseEventHandler<HTMLButtonElement>;
        onPaste?: ClipboardEventHandler<HTMLButtonElement>;
        onPasteCapture?: ClipboardEventHandler<HTMLButtonElement>;
        onPause?: ReactEventHandler<HTMLButtonElement>;
        onPauseCapture?: ReactEventHandler<HTMLButtonElement>;
        onPlay?: ReactEventHandler<HTMLButtonElement>;
        onPlayCapture?: ReactEventHandler<HTMLButtonElement>;
        onPlaying?: ReactEventHandler<HTMLButtonElement>;
        onPlayingCapture?: ReactEventHandler<HTMLButtonElement>;
        onPointerCancel?: PointerEventHandler<HTMLButtonElement>;
        onPointerCancelCapture?: PointerEventHandler<HTMLButtonElement>;
        onPointerDown?: PointerEventHandler<HTMLButtonElement>;
        onPointerDownCapture?: PointerEventHandler<HTMLButtonElement>;
        onPointerEnter?: PointerEventHandler<HTMLButtonElement>;
        onPointerLeave?: PointerEventHandler<HTMLButtonElement>;
        onPointerMove?: PointerEventHandler<HTMLButtonElement>;
        onPointerMoveCapture?: PointerEventHandler<HTMLButtonElement>;
        onPointerOut?: PointerEventHandler<HTMLButtonElement>;
        onPointerOutCapture?: PointerEventHandler<HTMLButtonElement>;
        onPointerOver?: PointerEventHandler<HTMLButtonElement>;
        onPointerOverCapture?: PointerEventHandler<HTMLButtonElement>;
        onPointerUp?: PointerEventHandler<HTMLButtonElement>;
        onPointerUpCapture?: PointerEventHandler<HTMLButtonElement>;
        onProgress?: ReactEventHandler<HTMLButtonElement>;
        onProgressCapture?: ReactEventHandler<HTMLButtonElement>;
        onRateChange?: ReactEventHandler<HTMLButtonElement>;
        onRateChangeCapture?: ReactEventHandler<HTMLButtonElement>;
        onReset?: FormEventHandler<HTMLButtonElement>;
        onResetCapture?: FormEventHandler<HTMLButtonElement>;
        onResize?: ReactEventHandler<HTMLButtonElement>;
        onResizeCapture?: ReactEventHandler<HTMLButtonElement>;
        onScroll?: UIEventHandler<HTMLButtonElement>;
        onScrollCapture?: UIEventHandler<HTMLButtonElement>;
        onSeeked?: ReactEventHandler<HTMLButtonElement>;
        onSeekedCapture?: ReactEventHandler<HTMLButtonElement>;
        onSeeking?: ReactEventHandler<HTMLButtonElement>;
        onSeekingCapture?: ReactEventHandler<HTMLButtonElement>;
        onSelect?: ReactEventHandler<HTMLButtonElement>;
        onSelectCapture?: ReactEventHandler<HTMLButtonElement>;
        onStalled?: ReactEventHandler<HTMLButtonElement>;
        onStalledCapture?: ReactEventHandler<HTMLButtonElement>;
        onSubmit?: FormEventHandler<HTMLButtonElement>;
        onSubmitCapture?: FormEventHandler<HTMLButtonElement>;
        onSuspend?: ReactEventHandler<HTMLButtonElement>;
        onSuspendCapture?: ReactEventHandler<HTMLButtonElement>;
        onTimeUpdate?: ReactEventHandler<HTMLButtonElement>;
        onTimeUpdateCapture?: ReactEventHandler<HTMLButtonElement>;
        onTouchCancel?: TouchEventHandler<HTMLButtonElement>;
        onTouchCancelCapture?: TouchEventHandler<HTMLButtonElement>;
        onTouchEnd?: TouchEventHandler<HTMLButtonElement>;
        onTouchEndCapture?: TouchEventHandler<HTMLButtonElement>;
        onTouchMove?: TouchEventHandler<HTMLButtonElement>;
        onTouchMoveCapture?: TouchEventHandler<HTMLButtonElement>;
        onTouchStart?: TouchEventHandler<HTMLButtonElement>;
        onTouchStartCapture?: TouchEventHandler<HTMLButtonElement>;
        onTransitionEnd?: TransitionEventHandler<HTMLButtonElement>;
        onTransitionEndCapture?: TransitionEventHandler<HTMLButtonElement>;
        onVolumeChange?: ReactEventHandler<HTMLButtonElement>;
        onVolumeChangeCapture?: ReactEventHandler<HTMLButtonElement>;
        onWaiting?: ReactEventHandler<HTMLButtonElement>;
        onWaitingCapture?: ReactEventHandler<HTMLButtonElement>;
        onWheel?: WheelEventHandler<HTMLButtonElement>;
        onWheelCapture?: WheelEventHandler<HTMLButtonElement>;
        prefix?: string;
        property?: string;
        radioGroup?: string;
        rel?: string;
        resource?: string;
        results?: number;
        rev?: string;
        role?: AriaRole;
        security?: string;
        size?:
            | null
            | "default"
            | "icon"
            | "sm"
            | "lg";
        slot?: string;
        spellCheck?: Booleanish;
        style?: CSSProperties;
        suppressContentEditableWarning?: boolean;
        suppressHydrationWarning?: boolean;
        tabIndex?: number;
        title?: string;
        translate?: "yes" | "no";
        type?: "button" | "reset" | "submit";
        typeof?: string;
        unselectable?: "off" | "on";
        value?: string | number | readonly string[];
        variant?:
            | null
            | "link"
            | "default"
            | "outline"
            | "destructive"
            | "secondary"
            | "ghost";
        vocab?: string;
    }

    Hierarchy

    • ButtonHTMLAttributes<HTMLButtonElement>
    • VariantProps<typeof buttonVariants>
      • ButtonProps

    Properties

    about? +ButtonProps | platform-bible-react

    InterfaceButtonProps

    interface ButtonProps {
        about?: string;
        accessKey?: string;
        aria-activedescendant?: string;
        aria-atomic?: Booleanish;
        aria-autocomplete?:
            | "inline"
            | "both"
            | "none"
            | "list";
        aria-braillelabel?: string;
        aria-brailleroledescription?: string;
        aria-busy?: Booleanish;
        aria-checked?:
            | boolean
            | "false"
            | "mixed"
            | "true";
        aria-colcount?: number;
        aria-colindex?: number;
        aria-colindextext?: string;
        aria-colspan?: number;
        aria-controls?: string;
        aria-current?:
            | boolean
            | "false"
            | "time"
            | "location"
            | "page"
            | "true"
            | "step"
            | "date";
        aria-describedby?: string;
        aria-description?: string;
        aria-details?: string;
        aria-disabled?: Booleanish;
        aria-dropeffect?:
            | "link"
            | "none"
            | "copy"
            | "move"
            | "execute"
            | "popup";
        aria-errormessage?: string;
        aria-expanded?: Booleanish;
        aria-flowto?: string;
        aria-grabbed?: Booleanish;
        aria-haspopup?:
            | boolean
            | "false"
            | "grid"
            | "dialog"
            | "menu"
            | "listbox"
            | "true"
            | "tree";
        aria-hidden?: Booleanish;
        aria-invalid?:
            | boolean
            | "false"
            | "true"
            | "grammar"
            | "spelling";
        aria-keyshortcuts?: string;
        aria-label?: string;
        aria-labelledby?: string;
        aria-level?: number;
        aria-live?: "off" | "assertive" | "polite";
        aria-modal?: Booleanish;
        aria-multiline?: Booleanish;
        aria-multiselectable?: Booleanish;
        aria-orientation?: "horizontal" | "vertical";
        aria-owns?: string;
        aria-placeholder?: string;
        aria-posinset?: number;
        aria-pressed?:
            | boolean
            | "false"
            | "mixed"
            | "true";
        aria-readonly?: Booleanish;
        aria-relevant?:
            | "all"
            | "text"
            | "additions"
            | "additions removals"
            | "additions text"
            | "removals"
            | "removals additions"
            | "removals text"
            | "text additions"
            | "text removals";
        aria-required?: Booleanish;
        aria-roledescription?: string;
        aria-rowcount?: number;
        aria-rowindex?: number;
        aria-rowindextext?: string;
        aria-rowspan?: number;
        aria-selected?: Booleanish;
        aria-setsize?: number;
        aria-sort?:
            | "none"
            | "other"
            | "ascending"
            | "descending";
        aria-valuemax?: number;
        aria-valuemin?: number;
        aria-valuenow?: number;
        aria-valuetext?: string;
        asChild?: boolean;
        autoCapitalize?:
            | "none"
            | "off"
            | "on"
            | string & {}
            | "words"
            | "sentences"
            | "characters";
        autoCorrect?: string;
        autoFocus?: boolean;
        autoSave?: string;
        children?: ReactNode;
        className?: string;
        color?: string;
        content?: string;
        contentEditable?: "inherit" | Booleanish | "plaintext-only";
        contextMenu?: string;
        dangerouslySetInnerHTML?: {
            __html: string | TrustedHTML;
        };
        datatype?: string;
        defaultChecked?: boolean;
        defaultValue?: string | number | readonly string[];
        dir?: string;
        disabled?: boolean;
        draggable?: Booleanish;
        enterKeyHint?:
            | "search"
            | "next"
            | "done"
            | "enter"
            | "go"
            | "previous"
            | "send";
        form?: string;
        formAction?: string;
        formEncType?: string;
        formMethod?: string;
        formNoValidate?: boolean;
        formTarget?: string;
        hidden?: boolean;
        id?: string;
        inlist?: any;
        inputMode?:
            | "search"
            | "numeric"
            | "none"
            | "url"
            | "text"
            | "email"
            | "tel"
            | "decimal";
        is?: string;
        itemID?: string;
        itemProp?: string;
        itemRef?: string;
        itemScope?: boolean;
        itemType?: string;
        lang?: string;
        name?: string;
        nonce?: string;
        onAbort?: ReactEventHandler<HTMLButtonElement>;
        onAbortCapture?: ReactEventHandler<HTMLButtonElement>;
        onAnimationEnd?: AnimationEventHandler<HTMLButtonElement>;
        onAnimationEndCapture?: AnimationEventHandler<HTMLButtonElement>;
        onAnimationIteration?: AnimationEventHandler<HTMLButtonElement>;
        onAnimationIterationCapture?: AnimationEventHandler<HTMLButtonElement>;
        onAnimationStart?: AnimationEventHandler<HTMLButtonElement>;
        onAnimationStartCapture?: AnimationEventHandler<HTMLButtonElement>;
        onAuxClick?: MouseEventHandler<HTMLButtonElement>;
        onAuxClickCapture?: MouseEventHandler<HTMLButtonElement>;
        onBeforeInput?: FormEventHandler<HTMLButtonElement>;
        onBeforeInputCapture?: FormEventHandler<HTMLButtonElement>;
        onBlur?: FocusEventHandler<HTMLButtonElement>;
        onBlurCapture?: FocusEventHandler<HTMLButtonElement>;
        onCanPlay?: ReactEventHandler<HTMLButtonElement>;
        onCanPlayCapture?: ReactEventHandler<HTMLButtonElement>;
        onCanPlayThrough?: ReactEventHandler<HTMLButtonElement>;
        onCanPlayThroughCapture?: ReactEventHandler<HTMLButtonElement>;
        onChange?: FormEventHandler<HTMLButtonElement>;
        onChangeCapture?: FormEventHandler<HTMLButtonElement>;
        onClick?: MouseEventHandler<HTMLButtonElement>;
        onClickCapture?: MouseEventHandler<HTMLButtonElement>;
        onCompositionEnd?: CompositionEventHandler<HTMLButtonElement>;
        onCompositionEndCapture?: CompositionEventHandler<HTMLButtonElement>;
        onCompositionStart?: CompositionEventHandler<HTMLButtonElement>;
        onCompositionStartCapture?: CompositionEventHandler<HTMLButtonElement>;
        onCompositionUpdate?: CompositionEventHandler<HTMLButtonElement>;
        onCompositionUpdateCapture?: CompositionEventHandler<HTMLButtonElement>;
        onContextMenu?: MouseEventHandler<HTMLButtonElement>;
        onContextMenuCapture?: MouseEventHandler<HTMLButtonElement>;
        onCopy?: ClipboardEventHandler<HTMLButtonElement>;
        onCopyCapture?: ClipboardEventHandler<HTMLButtonElement>;
        onCut?: ClipboardEventHandler<HTMLButtonElement>;
        onCutCapture?: ClipboardEventHandler<HTMLButtonElement>;
        onDoubleClick?: MouseEventHandler<HTMLButtonElement>;
        onDoubleClickCapture?: MouseEventHandler<HTMLButtonElement>;
        onDrag?: DragEventHandler<HTMLButtonElement>;
        onDragCapture?: DragEventHandler<HTMLButtonElement>;
        onDragEnd?: DragEventHandler<HTMLButtonElement>;
        onDragEndCapture?: DragEventHandler<HTMLButtonElement>;
        onDragEnter?: DragEventHandler<HTMLButtonElement>;
        onDragEnterCapture?: DragEventHandler<HTMLButtonElement>;
        onDragExit?: DragEventHandler<HTMLButtonElement>;
        onDragExitCapture?: DragEventHandler<HTMLButtonElement>;
        onDragLeave?: DragEventHandler<HTMLButtonElement>;
        onDragLeaveCapture?: DragEventHandler<HTMLButtonElement>;
        onDragOver?: DragEventHandler<HTMLButtonElement>;
        onDragOverCapture?: DragEventHandler<HTMLButtonElement>;
        onDragStart?: DragEventHandler<HTMLButtonElement>;
        onDragStartCapture?: DragEventHandler<HTMLButtonElement>;
        onDrop?: DragEventHandler<HTMLButtonElement>;
        onDropCapture?: DragEventHandler<HTMLButtonElement>;
        onDurationChange?: ReactEventHandler<HTMLButtonElement>;
        onDurationChangeCapture?: ReactEventHandler<HTMLButtonElement>;
        onEmptied?: ReactEventHandler<HTMLButtonElement>;
        onEmptiedCapture?: ReactEventHandler<HTMLButtonElement>;
        onEncrypted?: ReactEventHandler<HTMLButtonElement>;
        onEncryptedCapture?: ReactEventHandler<HTMLButtonElement>;
        onEnded?: ReactEventHandler<HTMLButtonElement>;
        onEndedCapture?: ReactEventHandler<HTMLButtonElement>;
        onError?: ReactEventHandler<HTMLButtonElement>;
        onErrorCapture?: ReactEventHandler<HTMLButtonElement>;
        onFocus?: FocusEventHandler<HTMLButtonElement>;
        onFocusCapture?: FocusEventHandler<HTMLButtonElement>;
        onGotPointerCapture?: PointerEventHandler<HTMLButtonElement>;
        onGotPointerCaptureCapture?: PointerEventHandler<HTMLButtonElement>;
        onInput?: FormEventHandler<HTMLButtonElement>;
        onInputCapture?: FormEventHandler<HTMLButtonElement>;
        onInvalid?: FormEventHandler<HTMLButtonElement>;
        onInvalidCapture?: FormEventHandler<HTMLButtonElement>;
        onKeyDown?: KeyboardEventHandler<HTMLButtonElement>;
        onKeyDownCapture?: KeyboardEventHandler<HTMLButtonElement>;
        onKeyPress?: KeyboardEventHandler<HTMLButtonElement>;
        onKeyPressCapture?: KeyboardEventHandler<HTMLButtonElement>;
        onKeyUp?: KeyboardEventHandler<HTMLButtonElement>;
        onKeyUpCapture?: KeyboardEventHandler<HTMLButtonElement>;
        onLoad?: ReactEventHandler<HTMLButtonElement>;
        onLoadCapture?: ReactEventHandler<HTMLButtonElement>;
        onLoadedData?: ReactEventHandler<HTMLButtonElement>;
        onLoadedDataCapture?: ReactEventHandler<HTMLButtonElement>;
        onLoadedMetadata?: ReactEventHandler<HTMLButtonElement>;
        onLoadedMetadataCapture?: ReactEventHandler<HTMLButtonElement>;
        onLoadStart?: ReactEventHandler<HTMLButtonElement>;
        onLoadStartCapture?: ReactEventHandler<HTMLButtonElement>;
        onLostPointerCapture?: PointerEventHandler<HTMLButtonElement>;
        onLostPointerCaptureCapture?: PointerEventHandler<HTMLButtonElement>;
        onMouseDown?: MouseEventHandler<HTMLButtonElement>;
        onMouseDownCapture?: MouseEventHandler<HTMLButtonElement>;
        onMouseEnter?: MouseEventHandler<HTMLButtonElement>;
        onMouseLeave?: MouseEventHandler<HTMLButtonElement>;
        onMouseMove?: MouseEventHandler<HTMLButtonElement>;
        onMouseMoveCapture?: MouseEventHandler<HTMLButtonElement>;
        onMouseOut?: MouseEventHandler<HTMLButtonElement>;
        onMouseOutCapture?: MouseEventHandler<HTMLButtonElement>;
        onMouseOver?: MouseEventHandler<HTMLButtonElement>;
        onMouseOverCapture?: MouseEventHandler<HTMLButtonElement>;
        onMouseUp?: MouseEventHandler<HTMLButtonElement>;
        onMouseUpCapture?: MouseEventHandler<HTMLButtonElement>;
        onPaste?: ClipboardEventHandler<HTMLButtonElement>;
        onPasteCapture?: ClipboardEventHandler<HTMLButtonElement>;
        onPause?: ReactEventHandler<HTMLButtonElement>;
        onPauseCapture?: ReactEventHandler<HTMLButtonElement>;
        onPlay?: ReactEventHandler<HTMLButtonElement>;
        onPlayCapture?: ReactEventHandler<HTMLButtonElement>;
        onPlaying?: ReactEventHandler<HTMLButtonElement>;
        onPlayingCapture?: ReactEventHandler<HTMLButtonElement>;
        onPointerCancel?: PointerEventHandler<HTMLButtonElement>;
        onPointerCancelCapture?: PointerEventHandler<HTMLButtonElement>;
        onPointerDown?: PointerEventHandler<HTMLButtonElement>;
        onPointerDownCapture?: PointerEventHandler<HTMLButtonElement>;
        onPointerEnter?: PointerEventHandler<HTMLButtonElement>;
        onPointerLeave?: PointerEventHandler<HTMLButtonElement>;
        onPointerMove?: PointerEventHandler<HTMLButtonElement>;
        onPointerMoveCapture?: PointerEventHandler<HTMLButtonElement>;
        onPointerOut?: PointerEventHandler<HTMLButtonElement>;
        onPointerOutCapture?: PointerEventHandler<HTMLButtonElement>;
        onPointerOver?: PointerEventHandler<HTMLButtonElement>;
        onPointerOverCapture?: PointerEventHandler<HTMLButtonElement>;
        onPointerUp?: PointerEventHandler<HTMLButtonElement>;
        onPointerUpCapture?: PointerEventHandler<HTMLButtonElement>;
        onProgress?: ReactEventHandler<HTMLButtonElement>;
        onProgressCapture?: ReactEventHandler<HTMLButtonElement>;
        onRateChange?: ReactEventHandler<HTMLButtonElement>;
        onRateChangeCapture?: ReactEventHandler<HTMLButtonElement>;
        onReset?: FormEventHandler<HTMLButtonElement>;
        onResetCapture?: FormEventHandler<HTMLButtonElement>;
        onResize?: ReactEventHandler<HTMLButtonElement>;
        onResizeCapture?: ReactEventHandler<HTMLButtonElement>;
        onScroll?: UIEventHandler<HTMLButtonElement>;
        onScrollCapture?: UIEventHandler<HTMLButtonElement>;
        onSeeked?: ReactEventHandler<HTMLButtonElement>;
        onSeekedCapture?: ReactEventHandler<HTMLButtonElement>;
        onSeeking?: ReactEventHandler<HTMLButtonElement>;
        onSeekingCapture?: ReactEventHandler<HTMLButtonElement>;
        onSelect?: ReactEventHandler<HTMLButtonElement>;
        onSelectCapture?: ReactEventHandler<HTMLButtonElement>;
        onStalled?: ReactEventHandler<HTMLButtonElement>;
        onStalledCapture?: ReactEventHandler<HTMLButtonElement>;
        onSubmit?: FormEventHandler<HTMLButtonElement>;
        onSubmitCapture?: FormEventHandler<HTMLButtonElement>;
        onSuspend?: ReactEventHandler<HTMLButtonElement>;
        onSuspendCapture?: ReactEventHandler<HTMLButtonElement>;
        onTimeUpdate?: ReactEventHandler<HTMLButtonElement>;
        onTimeUpdateCapture?: ReactEventHandler<HTMLButtonElement>;
        onTouchCancel?: TouchEventHandler<HTMLButtonElement>;
        onTouchCancelCapture?: TouchEventHandler<HTMLButtonElement>;
        onTouchEnd?: TouchEventHandler<HTMLButtonElement>;
        onTouchEndCapture?: TouchEventHandler<HTMLButtonElement>;
        onTouchMove?: TouchEventHandler<HTMLButtonElement>;
        onTouchMoveCapture?: TouchEventHandler<HTMLButtonElement>;
        onTouchStart?: TouchEventHandler<HTMLButtonElement>;
        onTouchStartCapture?: TouchEventHandler<HTMLButtonElement>;
        onTransitionEnd?: TransitionEventHandler<HTMLButtonElement>;
        onTransitionEndCapture?: TransitionEventHandler<HTMLButtonElement>;
        onVolumeChange?: ReactEventHandler<HTMLButtonElement>;
        onVolumeChangeCapture?: ReactEventHandler<HTMLButtonElement>;
        onWaiting?: ReactEventHandler<HTMLButtonElement>;
        onWaitingCapture?: ReactEventHandler<HTMLButtonElement>;
        onWheel?: WheelEventHandler<HTMLButtonElement>;
        onWheelCapture?: WheelEventHandler<HTMLButtonElement>;
        prefix?: string;
        property?: string;
        radioGroup?: string;
        rel?: string;
        resource?: string;
        results?: number;
        rev?: string;
        role?: AriaRole;
        security?: string;
        size?:
            | null
            | "default"
            | "icon"
            | "sm"
            | "lg";
        slot?: string;
        spellCheck?: Booleanish;
        style?: CSSProperties;
        suppressContentEditableWarning?: boolean;
        suppressHydrationWarning?: boolean;
        tabIndex?: number;
        title?: string;
        translate?: "yes" | "no";
        type?: "button" | "reset" | "submit";
        typeof?: string;
        unselectable?: "off" | "on";
        value?: string | number | readonly string[];
        variant?:
            | null
            | "link"
            | "default"
            | "outline"
            | "destructive"
            | "secondary"
            | "ghost";
        vocab?: string;
    }

    Hierarchy

    • ButtonHTMLAttributes<HTMLButtonElement>
    • VariantProps<typeof buttonVariants>
      • ButtonProps

    Properties

    about? accessKey? aria-activedescendant? aria-atomic? @@ -389,10 +389,10 @@

    Optionalaria-valuenow

    aria-valuenow?: number

    Defines the current value for a range widget.

    See

    aria-valuetext.

    Optionalaria-valuetext

    aria-valuetext?: string

    Defines the human readable text alternative of aria-valuenow for a range widget.

    -

    OptionalasChild

    asChild?: boolean

    OptionalautoCapitalize

    autoCapitalize?:
        | "none"
        | "off"
        | "on"
        | string & {}
        | "words"
        | "sentences"
        | "characters"

    OptionalautoCorrect

    autoCorrect?: string

    OptionalautoFocus

    autoFocus?: boolean

    OptionalautoSave

    autoSave?: string

    Optionalchildren

    children?: ReactNode

    OptionalclassName

    className?: string

    Optionalcolor

    color?: string

    Optionalcontent

    content?: string

    OptionalcontentEditable

    contentEditable?: "inherit" | Booleanish | "plaintext-only"

    OptionalcontextMenu

    contextMenu?: string

    OptionaldangerouslySetInnerHTML

    dangerouslySetInnerHTML?: {
        __html: string | TrustedHTML;
    }

    Optionaldatatype

    datatype?: string

    OptionaldefaultChecked

    defaultChecked?: boolean

    OptionaldefaultValue

    defaultValue?: string | number | readonly string[]

    Optionaldir

    dir?: string

    Optionaldisabled

    disabled?: boolean

    Optionaldraggable

    draggable?: Booleanish

    OptionalenterKeyHint

    enterKeyHint?:
        | "search"
        | "next"
        | "done"
        | "enter"
        | "go"
        | "previous"
        | "send"

    Optionalform

    form?: string

    OptionalformAction

    formAction?: string

    OptionalformEncType

    formEncType?: string

    OptionalformMethod

    formMethod?: string

    OptionalformNoValidate

    formNoValidate?: boolean

    OptionalformTarget

    formTarget?: string

    Optionalhidden

    hidden?: boolean

    Optionalid

    id?: string

    Optionalinlist

    inlist?: any

    OptionalinputMode

    inputMode?:
        | "search"
        | "numeric"
        | "none"
        | "url"
        | "text"
        | "email"
        | "tel"
        | "decimal"

    Hints at the type of data that might be entered by the user while editing the element or its contents

    +

    OptionalasChild

    asChild?: boolean

    OptionalautoCapitalize

    autoCapitalize?:
        | "none"
        | "off"
        | "on"
        | string & {}
        | "words"
        | "sentences"
        | "characters"

    OptionalautoCorrect

    autoCorrect?: string

    OptionalautoFocus

    autoFocus?: boolean

    OptionalautoSave

    autoSave?: string

    Optionalchildren

    children?: ReactNode

    OptionalclassName

    className?: string

    Optionalcolor

    color?: string

    Optionalcontent

    content?: string

    OptionalcontentEditable

    contentEditable?: "inherit" | Booleanish | "plaintext-only"

    OptionalcontextMenu

    contextMenu?: string

    OptionaldangerouslySetInnerHTML

    dangerouslySetInnerHTML?: {
        __html: string | TrustedHTML;
    }

    Optionaldatatype

    datatype?: string

    OptionaldefaultChecked

    defaultChecked?: boolean

    OptionaldefaultValue

    defaultValue?: string | number | readonly string[]

    Optionaldir

    dir?: string

    Optionaldisabled

    disabled?: boolean

    Optionaldraggable

    draggable?: Booleanish

    OptionalenterKeyHint

    enterKeyHint?:
        | "search"
        | "next"
        | "done"
        | "enter"
        | "go"
        | "previous"
        | "send"

    Optionalform

    form?: string

    OptionalformAction

    formAction?: string

    OptionalformEncType

    formEncType?: string

    OptionalformMethod

    formMethod?: string

    OptionalformNoValidate

    formNoValidate?: boolean

    OptionalformTarget

    formTarget?: string

    Optionalhidden

    hidden?: boolean

    Optionalid

    id?: string

    Optionalinlist

    inlist?: any

    OptionalinputMode

    inputMode?:
        | "search"
        | "numeric"
        | "none"
        | "url"
        | "text"
        | "email"
        | "tel"
        | "decimal"

    Hints at the type of data that might be entered by the user while editing the element or its contents

    See

    https://html.spec.whatwg.org/multipage/interaction.html#input-modalities:-the-inputmode-attribute

    Optionalis

    is?: string

    Specify that a standard HTML element should behave like a defined custom built-in element

    See

    https://html.spec.whatwg.org/multipage/custom-elements.html#attr-is

    OptionalitemID

    itemID?: string

    OptionalitemProp

    itemProp?: string

    OptionalitemRef

    itemRef?: string

    OptionalitemScope

    itemScope?: boolean

    OptionalitemType

    itemType?: string

    Optionallang

    lang?: string

    Optionalname

    name?: string

    Optionalnonce

    nonce?: string

    OptionalonAbort

    onAbort?: ReactEventHandler<HTMLButtonElement>

    OptionalonAbortCapture

    onAbortCapture?: ReactEventHandler<HTMLButtonElement>

    OptionalonAnimationEnd

    onAnimationEnd?: AnimationEventHandler<HTMLButtonElement>

    OptionalonAnimationEndCapture

    onAnimationEndCapture?: AnimationEventHandler<HTMLButtonElement>

    OptionalonAnimationIteration

    onAnimationIteration?: AnimationEventHandler<HTMLButtonElement>

    OptionalonAnimationIterationCapture

    onAnimationIterationCapture?: AnimationEventHandler<HTMLButtonElement>

    OptionalonAnimationStart

    onAnimationStart?: AnimationEventHandler<HTMLButtonElement>

    OptionalonAnimationStartCapture

    onAnimationStartCapture?: AnimationEventHandler<HTMLButtonElement>

    OptionalonAuxClick

    onAuxClick?: MouseEventHandler<HTMLButtonElement>

    OptionalonAuxClickCapture

    onAuxClickCapture?: MouseEventHandler<HTMLButtonElement>

    OptionalonBeforeInput

    onBeforeInput?: FormEventHandler<HTMLButtonElement>

    OptionalonBeforeInputCapture

    onBeforeInputCapture?: FormEventHandler<HTMLButtonElement>

    OptionalonBlur

    onBlur?: FocusEventHandler<HTMLButtonElement>

    OptionalonBlurCapture

    onBlurCapture?: FocusEventHandler<HTMLButtonElement>

    OptionalonCanPlay

    onCanPlay?: ReactEventHandler<HTMLButtonElement>

    OptionalonCanPlayCapture

    onCanPlayCapture?: ReactEventHandler<HTMLButtonElement>

    OptionalonCanPlayThrough

    onCanPlayThrough?: ReactEventHandler<HTMLButtonElement>

    OptionalonCanPlayThroughCapture

    onCanPlayThroughCapture?: ReactEventHandler<HTMLButtonElement>

    OptionalonChange

    onChange?: FormEventHandler<HTMLButtonElement>

    OptionalonChangeCapture

    onChangeCapture?: FormEventHandler<HTMLButtonElement>

    OptionalonClick

    onClick?: MouseEventHandler<HTMLButtonElement>

    OptionalonClickCapture

    onClickCapture?: MouseEventHandler<HTMLButtonElement>

    OptionalonCompositionEnd

    onCompositionEnd?: CompositionEventHandler<HTMLButtonElement>

    OptionalonCompositionEndCapture

    onCompositionEndCapture?: CompositionEventHandler<HTMLButtonElement>

    OptionalonCompositionStart

    onCompositionStart?: CompositionEventHandler<HTMLButtonElement>

    OptionalonCompositionStartCapture

    onCompositionStartCapture?: CompositionEventHandler<HTMLButtonElement>

    OptionalonCompositionUpdate

    onCompositionUpdate?: CompositionEventHandler<HTMLButtonElement>

    OptionalonCompositionUpdateCapture

    onCompositionUpdateCapture?: CompositionEventHandler<HTMLButtonElement>

    OptionalonContextMenu

    onContextMenu?: MouseEventHandler<HTMLButtonElement>

    OptionalonContextMenuCapture

    onContextMenuCapture?: MouseEventHandler<HTMLButtonElement>

    OptionalonCopy

    onCopy?: ClipboardEventHandler<HTMLButtonElement>

    OptionalonCopyCapture

    onCopyCapture?: ClipboardEventHandler<HTMLButtonElement>

    OptionalonCut

    onCut?: ClipboardEventHandler<HTMLButtonElement>

    OptionalonCutCapture

    onCutCapture?: ClipboardEventHandler<HTMLButtonElement>

    OptionalonDoubleClick

    onDoubleClick?: MouseEventHandler<HTMLButtonElement>

    OptionalonDoubleClickCapture

    onDoubleClickCapture?: MouseEventHandler<HTMLButtonElement>

    OptionalonDrag

    onDrag?: DragEventHandler<HTMLButtonElement>

    OptionalonDragCapture

    onDragCapture?: DragEventHandler<HTMLButtonElement>

    OptionalonDragEnd

    onDragEnd?: DragEventHandler<HTMLButtonElement>

    OptionalonDragEndCapture

    onDragEndCapture?: DragEventHandler<HTMLButtonElement>

    OptionalonDragEnter

    onDragEnter?: DragEventHandler<HTMLButtonElement>

    OptionalonDragEnterCapture

    onDragEnterCapture?: DragEventHandler<HTMLButtonElement>

    OptionalonDragExit

    onDragExit?: DragEventHandler<HTMLButtonElement>

    OptionalonDragExitCapture

    onDragExitCapture?: DragEventHandler<HTMLButtonElement>

    OptionalonDragLeave

    onDragLeave?: DragEventHandler<HTMLButtonElement>

    OptionalonDragLeaveCapture

    onDragLeaveCapture?: DragEventHandler<HTMLButtonElement>

    OptionalonDragOver

    onDragOver?: DragEventHandler<HTMLButtonElement>

    OptionalonDragOverCapture

    onDragOverCapture?: DragEventHandler<HTMLButtonElement>

    OptionalonDragStart

    onDragStart?: DragEventHandler<HTMLButtonElement>

    OptionalonDragStartCapture

    onDragStartCapture?: DragEventHandler<HTMLButtonElement>

    OptionalonDrop

    onDrop?: DragEventHandler<HTMLButtonElement>

    OptionalonDropCapture

    onDropCapture?: DragEventHandler<HTMLButtonElement>

    OptionalonDurationChange

    onDurationChange?: ReactEventHandler<HTMLButtonElement>

    OptionalonDurationChangeCapture

    onDurationChangeCapture?: ReactEventHandler<HTMLButtonElement>

    OptionalonEmptied

    onEmptied?: ReactEventHandler<HTMLButtonElement>

    OptionalonEmptiedCapture

    onEmptiedCapture?: ReactEventHandler<HTMLButtonElement>

    OptionalonEncrypted

    onEncrypted?: ReactEventHandler<HTMLButtonElement>

    OptionalonEncryptedCapture

    onEncryptedCapture?: ReactEventHandler<HTMLButtonElement>

    OptionalonEnded

    onEnded?: ReactEventHandler<HTMLButtonElement>

    OptionalonEndedCapture

    onEndedCapture?: ReactEventHandler<HTMLButtonElement>

    OptionalonError

    onError?: ReactEventHandler<HTMLButtonElement>

    OptionalonErrorCapture

    onErrorCapture?: ReactEventHandler<HTMLButtonElement>

    OptionalonFocus

    onFocus?: FocusEventHandler<HTMLButtonElement>

    OptionalonFocusCapture

    onFocusCapture?: FocusEventHandler<HTMLButtonElement>

    OptionalonGotPointerCapture

    onGotPointerCapture?: PointerEventHandler<HTMLButtonElement>

    OptionalonGotPointerCaptureCapture

    onGotPointerCaptureCapture?: PointerEventHandler<HTMLButtonElement>

    OptionalonInput

    onInput?: FormEventHandler<HTMLButtonElement>

    OptionalonInputCapture

    onInputCapture?: FormEventHandler<HTMLButtonElement>

    OptionalonInvalid

    onInvalid?: FormEventHandler<HTMLButtonElement>

    OptionalonInvalidCapture

    onInvalidCapture?: FormEventHandler<HTMLButtonElement>

    OptionalonKeyDown

    onKeyDown?: KeyboardEventHandler<HTMLButtonElement>

    OptionalonKeyDownCapture

    onKeyDownCapture?: KeyboardEventHandler<HTMLButtonElement>

    OptionalonKeyPress

    onKeyPress?: KeyboardEventHandler<HTMLButtonElement>

    Deprecated

    Use onKeyUp or onKeyDown instead

    OptionalonKeyPressCapture

    onKeyPressCapture?: KeyboardEventHandler<HTMLButtonElement>

    Deprecated

    Use onKeyUpCapture or onKeyDownCapture instead

    -

    OptionalonKeyUp

    onKeyUp?: KeyboardEventHandler<HTMLButtonElement>

    OptionalonKeyUpCapture

    onKeyUpCapture?: KeyboardEventHandler<HTMLButtonElement>

    OptionalonLoad

    onLoad?: ReactEventHandler<HTMLButtonElement>

    OptionalonLoadCapture

    onLoadCapture?: ReactEventHandler<HTMLButtonElement>

    OptionalonLoadedData

    onLoadedData?: ReactEventHandler<HTMLButtonElement>

    OptionalonLoadedDataCapture

    onLoadedDataCapture?: ReactEventHandler<HTMLButtonElement>

    OptionalonLoadedMetadata

    onLoadedMetadata?: ReactEventHandler<HTMLButtonElement>

    OptionalonLoadedMetadataCapture

    onLoadedMetadataCapture?: ReactEventHandler<HTMLButtonElement>

    OptionalonLoadStart

    onLoadStart?: ReactEventHandler<HTMLButtonElement>

    OptionalonLoadStartCapture

    onLoadStartCapture?: ReactEventHandler<HTMLButtonElement>

    OptionalonLostPointerCapture

    onLostPointerCapture?: PointerEventHandler<HTMLButtonElement>

    OptionalonLostPointerCaptureCapture

    onLostPointerCaptureCapture?: PointerEventHandler<HTMLButtonElement>

    OptionalonMouseDown

    onMouseDown?: MouseEventHandler<HTMLButtonElement>

    OptionalonMouseDownCapture

    onMouseDownCapture?: MouseEventHandler<HTMLButtonElement>

    OptionalonMouseEnter

    onMouseEnter?: MouseEventHandler<HTMLButtonElement>

    OptionalonMouseLeave

    onMouseLeave?: MouseEventHandler<HTMLButtonElement>

    OptionalonMouseMove

    onMouseMove?: MouseEventHandler<HTMLButtonElement>

    OptionalonMouseMoveCapture

    onMouseMoveCapture?: MouseEventHandler<HTMLButtonElement>

    OptionalonMouseOut

    onMouseOut?: MouseEventHandler<HTMLButtonElement>

    OptionalonMouseOutCapture

    onMouseOutCapture?: MouseEventHandler<HTMLButtonElement>

    OptionalonMouseOver

    onMouseOver?: MouseEventHandler<HTMLButtonElement>

    OptionalonMouseOverCapture

    onMouseOverCapture?: MouseEventHandler<HTMLButtonElement>

    OptionalonMouseUp

    onMouseUp?: MouseEventHandler<HTMLButtonElement>

    OptionalonMouseUpCapture

    onMouseUpCapture?: MouseEventHandler<HTMLButtonElement>

    OptionalonPaste

    onPaste?: ClipboardEventHandler<HTMLButtonElement>

    OptionalonPasteCapture

    onPasteCapture?: ClipboardEventHandler<HTMLButtonElement>

    OptionalonPause

    onPause?: ReactEventHandler<HTMLButtonElement>

    OptionalonPauseCapture

    onPauseCapture?: ReactEventHandler<HTMLButtonElement>

    OptionalonPlay

    onPlay?: ReactEventHandler<HTMLButtonElement>

    OptionalonPlayCapture

    onPlayCapture?: ReactEventHandler<HTMLButtonElement>

    OptionalonPlaying

    onPlaying?: ReactEventHandler<HTMLButtonElement>

    OptionalonPlayingCapture

    onPlayingCapture?: ReactEventHandler<HTMLButtonElement>

    OptionalonPointerCancel

    onPointerCancel?: PointerEventHandler<HTMLButtonElement>

    OptionalonPointerCancelCapture

    onPointerCancelCapture?: PointerEventHandler<HTMLButtonElement>

    OptionalonPointerDown

    onPointerDown?: PointerEventHandler<HTMLButtonElement>

    OptionalonPointerDownCapture

    onPointerDownCapture?: PointerEventHandler<HTMLButtonElement>

    OptionalonPointerEnter

    onPointerEnter?: PointerEventHandler<HTMLButtonElement>

    OptionalonPointerLeave

    onPointerLeave?: PointerEventHandler<HTMLButtonElement>

    OptionalonPointerMove

    onPointerMove?: PointerEventHandler<HTMLButtonElement>

    OptionalonPointerMoveCapture

    onPointerMoveCapture?: PointerEventHandler<HTMLButtonElement>

    OptionalonPointerOut

    onPointerOut?: PointerEventHandler<HTMLButtonElement>

    OptionalonPointerOutCapture

    onPointerOutCapture?: PointerEventHandler<HTMLButtonElement>

    OptionalonPointerOver

    onPointerOver?: PointerEventHandler<HTMLButtonElement>

    OptionalonPointerOverCapture

    onPointerOverCapture?: PointerEventHandler<HTMLButtonElement>

    OptionalonPointerUp

    onPointerUp?: PointerEventHandler<HTMLButtonElement>

    OptionalonPointerUpCapture

    onPointerUpCapture?: PointerEventHandler<HTMLButtonElement>

    OptionalonProgress

    onProgress?: ReactEventHandler<HTMLButtonElement>

    OptionalonProgressCapture

    onProgressCapture?: ReactEventHandler<HTMLButtonElement>

    OptionalonRateChange

    onRateChange?: ReactEventHandler<HTMLButtonElement>

    OptionalonRateChangeCapture

    onRateChangeCapture?: ReactEventHandler<HTMLButtonElement>

    OptionalonReset

    onReset?: FormEventHandler<HTMLButtonElement>

    OptionalonResetCapture

    onResetCapture?: FormEventHandler<HTMLButtonElement>

    OptionalonResize

    onResize?: ReactEventHandler<HTMLButtonElement>

    OptionalonResizeCapture

    onResizeCapture?: ReactEventHandler<HTMLButtonElement>

    OptionalonScroll

    onScroll?: UIEventHandler<HTMLButtonElement>

    OptionalonScrollCapture

    onScrollCapture?: UIEventHandler<HTMLButtonElement>

    OptionalonSeeked

    onSeeked?: ReactEventHandler<HTMLButtonElement>

    OptionalonSeekedCapture

    onSeekedCapture?: ReactEventHandler<HTMLButtonElement>

    OptionalonSeeking

    onSeeking?: ReactEventHandler<HTMLButtonElement>

    OptionalonSeekingCapture

    onSeekingCapture?: ReactEventHandler<HTMLButtonElement>

    OptionalonSelect

    onSelect?: ReactEventHandler<HTMLButtonElement>

    OptionalonSelectCapture

    onSelectCapture?: ReactEventHandler<HTMLButtonElement>

    OptionalonStalled

    onStalled?: ReactEventHandler<HTMLButtonElement>

    OptionalonStalledCapture

    onStalledCapture?: ReactEventHandler<HTMLButtonElement>

    OptionalonSubmit

    onSubmit?: FormEventHandler<HTMLButtonElement>

    OptionalonSubmitCapture

    onSubmitCapture?: FormEventHandler<HTMLButtonElement>

    OptionalonSuspend

    onSuspend?: ReactEventHandler<HTMLButtonElement>

    OptionalonSuspendCapture

    onSuspendCapture?: ReactEventHandler<HTMLButtonElement>

    OptionalonTimeUpdate

    onTimeUpdate?: ReactEventHandler<HTMLButtonElement>

    OptionalonTimeUpdateCapture

    onTimeUpdateCapture?: ReactEventHandler<HTMLButtonElement>

    OptionalonTouchCancel

    onTouchCancel?: TouchEventHandler<HTMLButtonElement>

    OptionalonTouchCancelCapture

    onTouchCancelCapture?: TouchEventHandler<HTMLButtonElement>

    OptionalonTouchEnd

    onTouchEnd?: TouchEventHandler<HTMLButtonElement>

    OptionalonTouchEndCapture

    onTouchEndCapture?: TouchEventHandler<HTMLButtonElement>

    OptionalonTouchMove

    onTouchMove?: TouchEventHandler<HTMLButtonElement>

    OptionalonTouchMoveCapture

    onTouchMoveCapture?: TouchEventHandler<HTMLButtonElement>

    OptionalonTouchStart

    onTouchStart?: TouchEventHandler<HTMLButtonElement>

    OptionalonTouchStartCapture

    onTouchStartCapture?: TouchEventHandler<HTMLButtonElement>

    OptionalonTransitionEnd

    onTransitionEnd?: TransitionEventHandler<HTMLButtonElement>

    OptionalonTransitionEndCapture

    onTransitionEndCapture?: TransitionEventHandler<HTMLButtonElement>

    OptionalonVolumeChange

    onVolumeChange?: ReactEventHandler<HTMLButtonElement>

    OptionalonVolumeChangeCapture

    onVolumeChangeCapture?: ReactEventHandler<HTMLButtonElement>

    OptionalonWaiting

    onWaiting?: ReactEventHandler<HTMLButtonElement>

    OptionalonWaitingCapture

    onWaitingCapture?: ReactEventHandler<HTMLButtonElement>

    OptionalonWheel

    onWheel?: WheelEventHandler<HTMLButtonElement>

    OptionalonWheelCapture

    onWheelCapture?: WheelEventHandler<HTMLButtonElement>

    Optionalprefix

    prefix?: string

    Optionalproperty

    property?: string

    OptionalradioGroup

    radioGroup?: string

    Optionalrel

    rel?: string

    Optionalresource

    resource?: string

    Optionalresults

    results?: number

    Optionalrev

    rev?: string

    Optionalrole

    role?: AriaRole

    Optionalsecurity

    security?: string

    Optionalsize

    size?:
        | null
        | "default"
        | "icon"
        | "sm"
        | "lg" = ...

    Optionalslot

    slot?: string

    OptionalspellCheck

    spellCheck?: Booleanish

    Optionalstyle

    style?: CSSProperties

    OptionalsuppressContentEditableWarning

    suppressContentEditableWarning?: boolean

    OptionalsuppressHydrationWarning

    suppressHydrationWarning?: boolean

    OptionaltabIndex

    tabIndex?: number

    Optionaltitle

    title?: string

    Optionaltranslate

    translate?: "yes" | "no"

    Optionaltype

    type?: "button" | "reset" | "submit"

    Optionaltypeof

    typeof?: string

    Optionalunselectable

    unselectable?: "off" | "on"

    Optionalvalue

    value?: string | number | readonly string[]

    Optionalvariant

    variant?:
        | null
        | "link"
        | "default"
        | "outline"
        | "destructive"
        | "secondary"
        | "ghost" = ...

    Optionalvocab

    vocab?: string

    Settings

    Member Visibility

    On This Page

    Properties
    aboutaccessKeyaria-activedescendantaria-atomicaria-autocompletearia-braillelabelaria-brailleroledescriptionaria-busyaria-checkedaria-colcountaria-colindexaria-colindextextaria-colspanaria-controlsaria-currentaria-describedbyaria-descriptionaria-detailsaria-disabledaria-dropeffectaria-errormessagearia-expandedaria-flowtoaria-grabbedaria-haspopuparia-hiddenaria-invalidaria-keyshortcutsaria-labelaria-labelledbyaria-levelaria-livearia-modalaria-multilinearia-multiselectablearia-orientationaria-ownsaria-placeholderaria-posinsetaria-pressedaria-readonlyaria-relevantaria-requiredaria-roledescriptionaria-rowcountaria-rowindexaria-rowindextextaria-rowspanaria-selectedaria-setsizearia-sortaria-valuemaxaria-valueminaria-valuenowaria-valuetextasChildautoCapitalizeautoCorrectautoFocusautoSavechildrenclassNamecolorcontentcontentEditablecontextMenudangerouslySetInnerHTMLdatatypedefaultCheckeddefaultValuedirdisableddraggableenterKeyHintformformActionformEncTypeformMethodformNoValidateformTargethiddenidinlistinputModeisitemIDitemPropitemRefitemScopeitemTypelangnamenonceonAbortonAbortCaptureonAnimationEndonAnimationEndCaptureonAnimationIterationonAnimationIterationCaptureonAnimationStartonAnimationStartCaptureonAuxClickonAuxClickCaptureonBeforeInputonBeforeInputCaptureonBluronBlurCaptureonCanPlayonCanPlayCaptureonCanPlayThroughonCanPlayThroughCaptureonChangeonChangeCaptureonClickonClickCaptureonCompositionEndonCompositionEndCaptureonCompositionStartonCompositionStartCaptureonCompositionUpdateonCompositionUpdateCaptureonContextMenuonContextMenuCaptureonCopyonCopyCaptureonCutonCutCaptureonDoubleClickonDoubleClickCaptureonDragonDragCaptureonDragEndonDragEndCaptureonDragEnteronDragEnterCaptureonDragExitonDragExitCaptureonDragLeaveonDragLeaveCaptureonDragOveronDragOverCaptureonDragStartonDragStartCaptureonDroponDropCaptureonDurationChangeonDurationChangeCaptureonEmptiedonEmptiedCaptureonEncryptedonEncryptedCaptureonEndedonEndedCaptureonErroronErrorCaptureonFocusonFocusCaptureonGotPointerCaptureonGotPointerCaptureCaptureonInputonInputCaptureonInvalidonInvalidCaptureonKeyDownonKeyDownCaptureonKeyPressonKeyPressCaptureonKeyUponKeyUpCaptureonLoadonLoadCaptureonLoadedDataonLoadedDataCaptureonLoadedMetadataonLoadedMetadataCaptureonLoadStartonLoadStartCaptureonLostPointerCaptureonLostPointerCaptureCaptureonMouseDownonMouseDownCaptureonMouseEnteronMouseLeaveonMouseMoveonMouseMoveCaptureonMouseOutonMouseOutCaptureonMouseOveronMouseOverCaptureonMouseUponMouseUpCaptureonPasteonPasteCaptureonPauseonPauseCaptureonPlayonPlayCaptureonPlayingonPlayingCaptureonPointerCancelonPointerCancelCaptureonPointerDownonPointerDownCaptureonPointerEnteronPointerLeaveonPointerMoveonPointerMoveCaptureonPointerOutonPointerOutCaptureonPointerOveronPointerOverCaptureonPointerUponPointerUpCaptureonProgressonProgressCaptureonRateChangeonRateChangeCaptureonResetonResetCaptureonResizeonResizeCaptureonScrollonScrollCaptureonSeekedonSeekedCaptureonSeekingonSeekingCaptureonSelectonSelectCaptureonStalledonStalledCaptureonSubmitonSubmitCaptureonSuspendonSuspendCaptureonTimeUpdateonTimeUpdateCaptureonTouchCancelonTouchCancelCaptureonTouchEndonTouchEndCaptureonTouchMoveonTouchMoveCaptureonTouchStartonTouchStartCaptureonTransitionEndonTransitionEndCaptureonVolumeChangeonVolumeChangeCaptureonWaitingonWaitingCaptureonWheelonWheelCaptureprefixpropertyradioGrouprelresourceresultsrevrolesecuritysizeslotspellCheckstylesuppressContentEditableWarningsuppressHydrationWarningtabIndextitletranslatetypetypeofunselectablevaluevariantvocab
    +

    OptionalonKeyUp

    onKeyUp?: KeyboardEventHandler<HTMLButtonElement>

    OptionalonKeyUpCapture

    onKeyUpCapture?: KeyboardEventHandler<HTMLButtonElement>

    OptionalonLoad

    onLoad?: ReactEventHandler<HTMLButtonElement>

    OptionalonLoadCapture

    onLoadCapture?: ReactEventHandler<HTMLButtonElement>

    OptionalonLoadedData

    onLoadedData?: ReactEventHandler<HTMLButtonElement>

    OptionalonLoadedDataCapture

    onLoadedDataCapture?: ReactEventHandler<HTMLButtonElement>

    OptionalonLoadedMetadata

    onLoadedMetadata?: ReactEventHandler<HTMLButtonElement>

    OptionalonLoadedMetadataCapture

    onLoadedMetadataCapture?: ReactEventHandler<HTMLButtonElement>

    OptionalonLoadStart

    onLoadStart?: ReactEventHandler<HTMLButtonElement>

    OptionalonLoadStartCapture

    onLoadStartCapture?: ReactEventHandler<HTMLButtonElement>

    OptionalonLostPointerCapture

    onLostPointerCapture?: PointerEventHandler<HTMLButtonElement>

    OptionalonLostPointerCaptureCapture

    onLostPointerCaptureCapture?: PointerEventHandler<HTMLButtonElement>

    OptionalonMouseDown

    onMouseDown?: MouseEventHandler<HTMLButtonElement>

    OptionalonMouseDownCapture

    onMouseDownCapture?: MouseEventHandler<HTMLButtonElement>

    OptionalonMouseEnter

    onMouseEnter?: MouseEventHandler<HTMLButtonElement>

    OptionalonMouseLeave

    onMouseLeave?: MouseEventHandler<HTMLButtonElement>

    OptionalonMouseMove

    onMouseMove?: MouseEventHandler<HTMLButtonElement>

    OptionalonMouseMoveCapture

    onMouseMoveCapture?: MouseEventHandler<HTMLButtonElement>

    OptionalonMouseOut

    onMouseOut?: MouseEventHandler<HTMLButtonElement>

    OptionalonMouseOutCapture

    onMouseOutCapture?: MouseEventHandler<HTMLButtonElement>

    OptionalonMouseOver

    onMouseOver?: MouseEventHandler<HTMLButtonElement>

    OptionalonMouseOverCapture

    onMouseOverCapture?: MouseEventHandler<HTMLButtonElement>

    OptionalonMouseUp

    onMouseUp?: MouseEventHandler<HTMLButtonElement>

    OptionalonMouseUpCapture

    onMouseUpCapture?: MouseEventHandler<HTMLButtonElement>

    OptionalonPaste

    onPaste?: ClipboardEventHandler<HTMLButtonElement>

    OptionalonPasteCapture

    onPasteCapture?: ClipboardEventHandler<HTMLButtonElement>

    OptionalonPause

    onPause?: ReactEventHandler<HTMLButtonElement>

    OptionalonPauseCapture

    onPauseCapture?: ReactEventHandler<HTMLButtonElement>

    OptionalonPlay

    onPlay?: ReactEventHandler<HTMLButtonElement>

    OptionalonPlayCapture

    onPlayCapture?: ReactEventHandler<HTMLButtonElement>

    OptionalonPlaying

    onPlaying?: ReactEventHandler<HTMLButtonElement>

    OptionalonPlayingCapture

    onPlayingCapture?: ReactEventHandler<HTMLButtonElement>

    OptionalonPointerCancel

    onPointerCancel?: PointerEventHandler<HTMLButtonElement>

    OptionalonPointerCancelCapture

    onPointerCancelCapture?: PointerEventHandler<HTMLButtonElement>

    OptionalonPointerDown

    onPointerDown?: PointerEventHandler<HTMLButtonElement>

    OptionalonPointerDownCapture

    onPointerDownCapture?: PointerEventHandler<HTMLButtonElement>

    OptionalonPointerEnter

    onPointerEnter?: PointerEventHandler<HTMLButtonElement>

    OptionalonPointerLeave

    onPointerLeave?: PointerEventHandler<HTMLButtonElement>

    OptionalonPointerMove

    onPointerMove?: PointerEventHandler<HTMLButtonElement>

    OptionalonPointerMoveCapture

    onPointerMoveCapture?: PointerEventHandler<HTMLButtonElement>

    OptionalonPointerOut

    onPointerOut?: PointerEventHandler<HTMLButtonElement>

    OptionalonPointerOutCapture

    onPointerOutCapture?: PointerEventHandler<HTMLButtonElement>

    OptionalonPointerOver

    onPointerOver?: PointerEventHandler<HTMLButtonElement>

    OptionalonPointerOverCapture

    onPointerOverCapture?: PointerEventHandler<HTMLButtonElement>

    OptionalonPointerUp

    onPointerUp?: PointerEventHandler<HTMLButtonElement>

    OptionalonPointerUpCapture

    onPointerUpCapture?: PointerEventHandler<HTMLButtonElement>

    OptionalonProgress

    onProgress?: ReactEventHandler<HTMLButtonElement>

    OptionalonProgressCapture

    onProgressCapture?: ReactEventHandler<HTMLButtonElement>

    OptionalonRateChange

    onRateChange?: ReactEventHandler<HTMLButtonElement>

    OptionalonRateChangeCapture

    onRateChangeCapture?: ReactEventHandler<HTMLButtonElement>

    OptionalonReset

    onReset?: FormEventHandler<HTMLButtonElement>

    OptionalonResetCapture

    onResetCapture?: FormEventHandler<HTMLButtonElement>

    OptionalonResize

    onResize?: ReactEventHandler<HTMLButtonElement>

    OptionalonResizeCapture

    onResizeCapture?: ReactEventHandler<HTMLButtonElement>

    OptionalonScroll

    onScroll?: UIEventHandler<HTMLButtonElement>

    OptionalonScrollCapture

    onScrollCapture?: UIEventHandler<HTMLButtonElement>

    OptionalonSeeked

    onSeeked?: ReactEventHandler<HTMLButtonElement>

    OptionalonSeekedCapture

    onSeekedCapture?: ReactEventHandler<HTMLButtonElement>

    OptionalonSeeking

    onSeeking?: ReactEventHandler<HTMLButtonElement>

    OptionalonSeekingCapture

    onSeekingCapture?: ReactEventHandler<HTMLButtonElement>

    OptionalonSelect

    onSelect?: ReactEventHandler<HTMLButtonElement>

    OptionalonSelectCapture

    onSelectCapture?: ReactEventHandler<HTMLButtonElement>

    OptionalonStalled

    onStalled?: ReactEventHandler<HTMLButtonElement>

    OptionalonStalledCapture

    onStalledCapture?: ReactEventHandler<HTMLButtonElement>

    OptionalonSubmit

    onSubmit?: FormEventHandler<HTMLButtonElement>

    OptionalonSubmitCapture

    onSubmitCapture?: FormEventHandler<HTMLButtonElement>

    OptionalonSuspend

    onSuspend?: ReactEventHandler<HTMLButtonElement>

    OptionalonSuspendCapture

    onSuspendCapture?: ReactEventHandler<HTMLButtonElement>

    OptionalonTimeUpdate

    onTimeUpdate?: ReactEventHandler<HTMLButtonElement>

    OptionalonTimeUpdateCapture

    onTimeUpdateCapture?: ReactEventHandler<HTMLButtonElement>

    OptionalonTouchCancel

    onTouchCancel?: TouchEventHandler<HTMLButtonElement>

    OptionalonTouchCancelCapture

    onTouchCancelCapture?: TouchEventHandler<HTMLButtonElement>

    OptionalonTouchEnd

    onTouchEnd?: TouchEventHandler<HTMLButtonElement>

    OptionalonTouchEndCapture

    onTouchEndCapture?: TouchEventHandler<HTMLButtonElement>

    OptionalonTouchMove

    onTouchMove?: TouchEventHandler<HTMLButtonElement>

    OptionalonTouchMoveCapture

    onTouchMoveCapture?: TouchEventHandler<HTMLButtonElement>

    OptionalonTouchStart

    onTouchStart?: TouchEventHandler<HTMLButtonElement>

    OptionalonTouchStartCapture

    onTouchStartCapture?: TouchEventHandler<HTMLButtonElement>

    OptionalonTransitionEnd

    onTransitionEnd?: TransitionEventHandler<HTMLButtonElement>

    OptionalonTransitionEndCapture

    onTransitionEndCapture?: TransitionEventHandler<HTMLButtonElement>

    OptionalonVolumeChange

    onVolumeChange?: ReactEventHandler<HTMLButtonElement>

    OptionalonVolumeChangeCapture

    onVolumeChangeCapture?: ReactEventHandler<HTMLButtonElement>

    OptionalonWaiting

    onWaiting?: ReactEventHandler<HTMLButtonElement>

    OptionalonWaitingCapture

    onWaitingCapture?: ReactEventHandler<HTMLButtonElement>

    OptionalonWheel

    onWheel?: WheelEventHandler<HTMLButtonElement>

    OptionalonWheelCapture

    onWheelCapture?: WheelEventHandler<HTMLButtonElement>

    Optionalprefix

    prefix?: string

    Optionalproperty

    property?: string

    OptionalradioGroup

    radioGroup?: string

    Optionalrel

    rel?: string

    Optionalresource

    resource?: string

    Optionalresults

    results?: number

    Optionalrev

    rev?: string

    Optionalrole

    role?: AriaRole

    Optionalsecurity

    security?: string

    Optionalsize

    size?:
        | null
        | "default"
        | "icon"
        | "sm"
        | "lg" = ...

    Optionalslot

    slot?: string

    OptionalspellCheck

    spellCheck?: Booleanish

    Optionalstyle

    style?: CSSProperties

    OptionalsuppressContentEditableWarning

    suppressContentEditableWarning?: boolean

    OptionalsuppressHydrationWarning

    suppressHydrationWarning?: boolean

    OptionaltabIndex

    tabIndex?: number

    Optionaltitle

    title?: string

    Optionaltranslate

    translate?: "yes" | "no"

    Optionaltype

    type?: "button" | "reset" | "submit"

    Optionaltypeof

    typeof?: string

    Optionalunselectable

    unselectable?: "off" | "on"

    Optionalvalue

    value?: string | number | readonly string[]

    Optionalvariant

    variant?:
        | null
        | "link"
        | "default"
        | "outline"
        | "destructive"
        | "secondary"
        | "ghost" = ...

    Optionalvocab

    vocab?: string

    Settings

    Member Visibility

    On This Page

    Properties
    aboutaccessKeyaria-activedescendantaria-atomicaria-autocompletearia-braillelabelaria-brailleroledescriptionaria-busyaria-checkedaria-colcountaria-colindexaria-colindextextaria-colspanaria-controlsaria-currentaria-describedbyaria-descriptionaria-detailsaria-disabledaria-dropeffectaria-errormessagearia-expandedaria-flowtoaria-grabbedaria-haspopuparia-hiddenaria-invalidaria-keyshortcutsaria-labelaria-labelledbyaria-levelaria-livearia-modalaria-multilinearia-multiselectablearia-orientationaria-ownsaria-placeholderaria-posinsetaria-pressedaria-readonlyaria-relevantaria-requiredaria-roledescriptionaria-rowcountaria-rowindexaria-rowindextextaria-rowspanaria-selectedaria-setsizearia-sortaria-valuemaxaria-valueminaria-valuenowaria-valuetextasChildautoCapitalizeautoCorrectautoFocusautoSavechildrenclassNamecolorcontentcontentEditablecontextMenudangerouslySetInnerHTMLdatatypedefaultCheckeddefaultValuedirdisableddraggableenterKeyHintformformActionformEncTypeformMethodformNoValidateformTargethiddenidinlistinputModeisitemIDitemPropitemRefitemScopeitemTypelangnamenonceonAbortonAbortCaptureonAnimationEndonAnimationEndCaptureonAnimationIterationonAnimationIterationCaptureonAnimationStartonAnimationStartCaptureonAuxClickonAuxClickCaptureonBeforeInputonBeforeInputCaptureonBluronBlurCaptureonCanPlayonCanPlayCaptureonCanPlayThroughonCanPlayThroughCaptureonChangeonChangeCaptureonClickonClickCaptureonCompositionEndonCompositionEndCaptureonCompositionStartonCompositionStartCaptureonCompositionUpdateonCompositionUpdateCaptureonContextMenuonContextMenuCaptureonCopyonCopyCaptureonCutonCutCaptureonDoubleClickonDoubleClickCaptureonDragonDragCaptureonDragEndonDragEndCaptureonDragEnteronDragEnterCaptureonDragExitonDragExitCaptureonDragLeaveonDragLeaveCaptureonDragOveronDragOverCaptureonDragStartonDragStartCaptureonDroponDropCaptureonDurationChangeonDurationChangeCaptureonEmptiedonEmptiedCaptureonEncryptedonEncryptedCaptureonEndedonEndedCaptureonErroronErrorCaptureonFocusonFocusCaptureonGotPointerCaptureonGotPointerCaptureCaptureonInputonInputCaptureonInvalidonInvalidCaptureonKeyDownonKeyDownCaptureonKeyPressonKeyPressCaptureonKeyUponKeyUpCaptureonLoadonLoadCaptureonLoadedDataonLoadedDataCaptureonLoadedMetadataonLoadedMetadataCaptureonLoadStartonLoadStartCaptureonLostPointerCaptureonLostPointerCaptureCaptureonMouseDownonMouseDownCaptureonMouseEnteronMouseLeaveonMouseMoveonMouseMoveCaptureonMouseOutonMouseOutCaptureonMouseOveronMouseOverCaptureonMouseUponMouseUpCaptureonPasteonPasteCaptureonPauseonPauseCaptureonPlayonPlayCaptureonPlayingonPlayingCaptureonPointerCancelonPointerCancelCaptureonPointerDownonPointerDownCaptureonPointerEnteronPointerLeaveonPointerMoveonPointerMoveCaptureonPointerOutonPointerOutCaptureonPointerOveronPointerOverCaptureonPointerUponPointerUpCaptureonProgressonProgressCaptureonRateChangeonRateChangeCaptureonResetonResetCaptureonResizeonResizeCaptureonScrollonScrollCaptureonSeekedonSeekedCaptureonSeekingonSeekingCaptureonSelectonSelectCaptureonStalledonStalledCaptureonSubmitonSubmitCaptureonSuspendonSuspendCaptureonTimeUpdateonTimeUpdateCaptureonTouchCancelonTouchCancelCaptureonTouchEndonTouchEndCaptureonTouchMoveonTouchMoveCaptureonTouchStartonTouchStartCaptureonTransitionEndonTransitionEndCaptureonVolumeChangeonVolumeChangeCaptureonWaitingonWaitingCaptureonWheelonWheelCaptureprefixpropertyradioGrouprelresourceresultsrevrolesecuritysizeslotspellCheckstylesuppressContentEditableWarningsuppressHydrationWarningtabIndextitletranslatetypetypeofunselectablevaluevariantvocab
    diff --git a/platform-bible-react/interfaces/CommandHandler.html b/platform-bible-react/interfaces/CommandHandler.html index 2e10a0a0b4..36b6a3b1c9 100644 --- a/platform-bible-react/interfaces/CommandHandler.html +++ b/platform-bible-react/interfaces/CommandHandler.html @@ -1 +1 @@ -CommandHandler | platform-bible-react

    InterfaceCommandHandler

    Settings

    Member Visibility
    +CommandHandler | platform-bible-react

    InterfaceCommandHandler

    Settings

    Member Visibility
    diff --git a/platform-bible-react/interfaces/MultiColumnMenuProvider.html b/platform-bible-react/interfaces/MultiColumnMenuProvider.html index 257ed6c8e6..a8b5f48007 100644 --- a/platform-bible-react/interfaces/MultiColumnMenuProvider.html +++ b/platform-bible-react/interfaces/MultiColumnMenuProvider.html @@ -1 +1 @@ -MultiColumnMenuProvider | platform-bible-react

    InterfaceMultiColumnMenuProvider

    • MultiColumnMenuProvider(isSupportAndDevelopment): Promise<{
          columns: {
              isExtensible?: boolean;
          };
          groups: {};
          items: ({
              group: string;
              id: string;
              label: string;
              localizeNotes: string;
              order: number;
              searchTerms?: string;
              tooltip?: string;
          } | {
              command: string;
              group: string;
              iconPathAfter?: string;
              iconPathBefore?: string;
              label: string;
              localizeNotes: string;
              order: number;
              searchTerms?: string;
              tooltip?: string;
          })[];
      }>

    • Parameters

      • isSupportAndDevelopment: boolean

      Returns Promise<{
          columns: {
              isExtensible?: boolean;
          };
          groups: {};
          items: ({
              group: string;
              id: string;
              label: string;
              localizeNotes: string;
              order: number;
              searchTerms?: string;
              tooltip?: string;
          } | {
              command: string;
              group: string;
              iconPathAfter?: string;
              iconPathBefore?: string;
              label: string;
              localizeNotes: string;
              order: number;
              searchTerms?: string;
              tooltip?: string;
          })[];
      }>

    Settings

    Member Visibility
    +MultiColumnMenuProvider | platform-bible-react

    InterfaceMultiColumnMenuProvider

    • MultiColumnMenuProvider(isSupportAndDevelopment): Promise<{
          columns: {
              isExtensible?: boolean;
          };
          groups: {};
          items: ({
              group: string;
              id: string;
              label: string;
              localizeNotes: string;
              order: number;
              searchTerms?: string;
              tooltip?: string;
          } | {
              command: string;
              group: string;
              iconPathAfter?: string;
              iconPathBefore?: string;
              label: string;
              localizeNotes: string;
              order: number;
              searchTerms?: string;
              tooltip?: string;
          })[];
      }>

    • Parameters

      • isSupportAndDevelopment: boolean

      Returns Promise<{
          columns: {
              isExtensible?: boolean;
          };
          groups: {};
          items: ({
              group: string;
              id: string;
              label: string;
              localizeNotes: string;
              order: number;
              searchTerms?: string;
              tooltip?: string;
          } | {
              command: string;
              group: string;
              iconPathAfter?: string;
              iconPathBefore?: string;
              label: string;
              localizeNotes: string;
              order: number;
              searchTerms?: string;
              tooltip?: string;
          })[];
      }>

    Settings

    Member Visibility
    diff --git a/platform-bible-react/types/BookSelectorLocalizedStrings.html b/platform-bible-react/types/BookSelectorLocalizedStrings.html index b4de47fbb6..6672e49a6b 100644 --- a/platform-bible-react/types/BookSelectorLocalizedStrings.html +++ b/platform-bible-react/types/BookSelectorLocalizedStrings.html @@ -1 +1 @@ -BookSelectorLocalizedStrings | platform-bible-react

    Type AliasBookSelectorLocalizedStrings

    BookSelectorLocalizedStrings: {
        [localizedInventoryKey in typeof BOOK_SELECTOR_STRING_KEYS[number]]?: LocalizedStringValue
    }

    Settings

    Member Visibility
    +BookSelectorLocalizedStrings | platform-bible-react

    Type AliasBookSelectorLocalizedStrings

    BookSelectorLocalizedStrings: {
        [localizedInventoryKey in typeof BOOK_SELECTOR_STRING_KEYS[number]]?: LocalizedStringValue
    }

    Settings

    Member Visibility
    diff --git a/platform-bible-react/types/ChapterRangeSelectorProps.html b/platform-bible-react/types/ChapterRangeSelectorProps.html index 3cb0d467a0..c94c5afd0d 100644 --- a/platform-bible-react/types/ChapterRangeSelectorProps.html +++ b/platform-bible-react/types/ChapterRangeSelectorProps.html @@ -1 +1 @@ -ChapterRangeSelectorProps | platform-bible-react

    Type AliasChapterRangeSelectorProps

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

    Settings

    Member Visibility
    +ChapterRangeSelectorProps | platform-bible-react

    Type AliasChapterRangeSelectorProps

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

    Settings

    Member Visibility
    diff --git a/platform-bible-react/types/ChecklistProps.html b/platform-bible-react/types/ChecklistProps.html index b265cce698..edb0a5ac88 100644 --- a/platform-bible-react/types/ChecklistProps.html +++ b/platform-bible-react/types/ChecklistProps.html @@ -8,4 +8,4 @@

    Returns void

  • Optionalid?: string

    Optional string representing the id attribute of the Checklist

  • listItems: string[]

    Array of strings representing the checkable items

  • selectedListItems: string[]

    Array of strings representing the checked items

    -

    • Settings

    Member Visibility
    +

    Settings

    Member Visibility
    diff --git a/platform-bible-react/types/ColumnDef.html b/platform-bible-react/types/ColumnDef.html index 447d4d97b4..21e44c1db9 100644 --- a/platform-bible-react/types/ColumnDef.html +++ b/platform-bible-react/types/ColumnDef.html @@ -1 +1 @@ -ColumnDef | platform-bible-react

    Type AliasColumnDef<TData, TValue>

    ColumnDef<TData, TValue>: TSColumnDef<TData, TValue>

    Type Parameters

    • TData
    • TValue = unknown

    Settings

    Member Visibility
    +ColumnDef | platform-bible-react

    Type AliasColumnDef<TData, TValue>

    ColumnDef<TData, TValue>: TSColumnDef<TData, TValue>

    Type Parameters

    • TData
    • TValue = unknown

    Settings

    Member Visibility
    diff --git a/platform-bible-react/types/ComboBoxLabelOption.html b/platform-bible-react/types/ComboBoxLabelOption.html index ce66c4af5c..c603249a7f 100644 --- a/platform-bible-react/types/ComboBoxLabelOption.html +++ b/platform-bible-react/types/ComboBoxLabelOption.html @@ -1 +1 @@ -ComboBoxLabelOption | platform-bible-react

    Type AliasComboBoxLabelOption

    ComboBoxLabelOption: {
        label: string;
    }

    Settings

    Member Visibility
    +ComboBoxLabelOption | platform-bible-react

    Type AliasComboBoxLabelOption

    ComboBoxLabelOption: {
        label: string;
    }

    Settings

    Member Visibility
    diff --git a/platform-bible-react/types/ComboBoxOption.html b/platform-bible-react/types/ComboBoxOption.html index ed26259b6a..7aa2c2948a 100644 --- a/platform-bible-react/types/ComboBoxOption.html +++ b/platform-bible-react/types/ComboBoxOption.html @@ -1 +1 @@ -ComboBoxOption | platform-bible-react

    Type AliasComboBoxOption

    ComboBoxOption: string | number | ComboBoxLabelOption

    Settings

    Member Visibility
    +ComboBoxOption | platform-bible-react

    Type AliasComboBoxOption

    ComboBoxOption: string | number | ComboBoxLabelOption

    Settings

    Member Visibility
    diff --git a/platform-bible-react/types/ComboBoxProps.html b/platform-bible-react/types/ComboBoxProps.html index 29c1e2b3b9..ff113bbb35 100644 --- a/platform-bible-react/types/ComboBoxProps.html +++ b/platform-bible-react/types/ComboBoxProps.html @@ -11,4 +11,4 @@
  • OptionaltextPlaceholder?: string

    Placeholder text for text field

  • Optionalvalue?: T

    The selected value that the combo box currently holds. Must be shallow equal to one of the options entries.

    -

    • Settings

    Member Visibility
    +

    Settings

    Member Visibility
    diff --git a/platform-bible-react/types/DropdownGroup.html b/platform-bible-react/types/DropdownGroup.html index 4401d0b9ec..61bf36a051 100644 --- a/platform-bible-react/types/DropdownGroup.html +++ b/platform-bible-react/types/DropdownGroup.html @@ -1,4 +1,4 @@ DropdownGroup | platform-bible-react

    Type AliasDropdownGroup

    DropdownGroup: {
        items: DropdownItem[];
        label: string;
    }

    Type declaration

    • items: DropdownItem[]

      The items array contains the items that will be displayed in the dropdown group

    • label: string

      The label is the text that will be displayed on the dropdown group. It is used to categorize the items in the group.

      -

    Settings

    Member Visibility
    +

    Settings

    Member Visibility
    diff --git a/platform-bible-react/types/DropdownItem.html b/platform-bible-react/types/DropdownItem.html index 63f604241a..c0e372bfe2 100644 --- a/platform-bible-react/types/DropdownItem.html +++ b/platform-bible-react/types/DropdownItem.html @@ -1,4 +1,4 @@ DropdownItem | platform-bible-react

    Type AliasDropdownItem

    DropdownItem: {
        itemType: DropdownMenuItemType;
        label: string;
        onClick: (() => void);
    }

    Type declaration

    • itemType: DropdownMenuItemType

      The itemType determines the DropdownMenuItemType type as either Check or Radio.

    • label: string

      The label is the text that will be displayed on the dropdown item.

    • onClick: (() => void)

      The onClick function is called when the item is clicked.

      -
        • (): void

        • Returns void

    Settings

    Member Visibility
    +
      • (): void

      • Returns void

    Settings

    Member Visibility
    diff --git a/platform-bible-react/types/DropdownMenuCheckboxItemProps.html b/platform-bible-react/types/DropdownMenuCheckboxItemProps.html index cf57a58b29..9f8ba16a78 100644 --- a/platform-bible-react/types/DropdownMenuCheckboxItemProps.html +++ b/platform-bible-react/types/DropdownMenuCheckboxItemProps.html @@ -1 +1 @@ -DropdownMenuCheckboxItemProps | platform-bible-react

    Type AliasDropdownMenuCheckboxItemProps

    DropdownMenuCheckboxItemProps: React.ComponentPropsWithoutRef<typeof DropdownMenuPrimitive.CheckboxItem> & {
        checked?: boolean;
        className?: string;
    }

    Settings

    Member Visibility
    +DropdownMenuCheckboxItemProps | platform-bible-react

    Type AliasDropdownMenuCheckboxItemProps

    DropdownMenuCheckboxItemProps: React.ComponentPropsWithoutRef<typeof DropdownMenuPrimitive.CheckboxItem> & {
        checked?: boolean;
        className?: string;
    }

    Settings

    Member Visibility
    diff --git a/platform-bible-react/types/DropdownMenuContentProps.html b/platform-bible-react/types/DropdownMenuContentProps.html index c2135dd6fe..6d39334ce7 100644 --- a/platform-bible-react/types/DropdownMenuContentProps.html +++ b/platform-bible-react/types/DropdownMenuContentProps.html @@ -1 +1 @@ -DropdownMenuContentProps | platform-bible-react

    Type AliasDropdownMenuContentProps

    DropdownMenuContentProps: React.ComponentPropsWithoutRef<typeof DropdownMenuPrimitive.Content> & {
        className?: string;
        sideOffset?: number;
    }

    Settings

    Member Visibility
    +DropdownMenuContentProps | platform-bible-react

    Type AliasDropdownMenuContentProps

    DropdownMenuContentProps: React.ComponentPropsWithoutRef<typeof DropdownMenuPrimitive.Content> & {
        className?: string;
        sideOffset?: number;
    }

    Settings

    Member Visibility
    diff --git a/platform-bible-react/types/DropdownMenuItemProps.html b/platform-bible-react/types/DropdownMenuItemProps.html index c445c875ec..5258324339 100644 --- a/platform-bible-react/types/DropdownMenuItemProps.html +++ b/platform-bible-react/types/DropdownMenuItemProps.html @@ -1 +1 @@ -DropdownMenuItemProps | platform-bible-react

    Type AliasDropdownMenuItemProps

    DropdownMenuItemProps: React.ComponentPropsWithoutRef<typeof DropdownMenuPrimitive.Item> & {
        className?: string;
        inset?: boolean;
    }

    Settings

    Member Visibility
    +DropdownMenuItemProps | platform-bible-react

    Type AliasDropdownMenuItemProps

    DropdownMenuItemProps: React.ComponentPropsWithoutRef<typeof DropdownMenuPrimitive.Item> & {
        className?: string;
        inset?: boolean;
    }

    Settings

    Member Visibility
    diff --git a/platform-bible-react/types/DropdownMenuLabelProps.html b/platform-bible-react/types/DropdownMenuLabelProps.html index ed26c73064..884b91428f 100644 --- a/platform-bible-react/types/DropdownMenuLabelProps.html +++ b/platform-bible-react/types/DropdownMenuLabelProps.html @@ -1 +1 @@ -DropdownMenuLabelProps | platform-bible-react

    Type AliasDropdownMenuLabelProps

    DropdownMenuLabelProps: React.ComponentPropsWithoutRef<typeof DropdownMenuPrimitive.Label> & {
        className?: string;
        inset?: boolean;
    }

    Settings

    Member Visibility
    +DropdownMenuLabelProps | platform-bible-react

    Type AliasDropdownMenuLabelProps

    DropdownMenuLabelProps: React.ComponentPropsWithoutRef<typeof DropdownMenuPrimitive.Label> & {
        className?: string;
        inset?: boolean;
    }

    Settings

    Member Visibility
    diff --git a/platform-bible-react/types/DropdownMenuRadioItemProps.html b/platform-bible-react/types/DropdownMenuRadioItemProps.html index cd6427c3bc..5b0c043bef 100644 --- a/platform-bible-react/types/DropdownMenuRadioItemProps.html +++ b/platform-bible-react/types/DropdownMenuRadioItemProps.html @@ -1 +1 @@ -DropdownMenuRadioItemProps | platform-bible-react

    Type AliasDropdownMenuRadioItemProps

    DropdownMenuRadioItemProps: React.ComponentPropsWithoutRef<typeof DropdownMenuPrimitive.RadioItem> & {
        className?: string;
    }

    Settings

    Member Visibility
    +DropdownMenuRadioItemProps | platform-bible-react

    Type AliasDropdownMenuRadioItemProps

    DropdownMenuRadioItemProps: React.ComponentPropsWithoutRef<typeof DropdownMenuPrimitive.RadioItem> & {
        className?: string;
    }

    Settings

    Member Visibility
    diff --git a/platform-bible-react/types/DropdownMenuSeparatorProps.html b/platform-bible-react/types/DropdownMenuSeparatorProps.html index 7d561fa81b..2f2b1230c9 100644 --- a/platform-bible-react/types/DropdownMenuSeparatorProps.html +++ b/platform-bible-react/types/DropdownMenuSeparatorProps.html @@ -1 +1 @@ -DropdownMenuSeparatorProps | platform-bible-react

    Type AliasDropdownMenuSeparatorProps

    DropdownMenuSeparatorProps: React.ComponentPropsWithoutRef<typeof DropdownMenuPrimitive.Separator> & {
        className?: string;
    }

    Settings

    Member Visibility
    +DropdownMenuSeparatorProps | platform-bible-react

    Type AliasDropdownMenuSeparatorProps

    DropdownMenuSeparatorProps: React.ComponentPropsWithoutRef<typeof DropdownMenuPrimitive.Separator> & {
        className?: string;
    }

    Settings

    Member Visibility
    diff --git a/platform-bible-react/types/DropdownMenuShortcutProps.html b/platform-bible-react/types/DropdownMenuShortcutProps.html index 769f6ddac6..1ab29c10ba 100644 --- a/platform-bible-react/types/DropdownMenuShortcutProps.html +++ b/platform-bible-react/types/DropdownMenuShortcutProps.html @@ -1 +1 @@ -DropdownMenuShortcutProps | platform-bible-react

    Type AliasDropdownMenuShortcutProps

    DropdownMenuShortcutProps: React.HTMLAttributes<HTMLSpanElement> & {
        className?: string;
    }

    Settings

    Member Visibility
    +DropdownMenuShortcutProps | platform-bible-react

    Type AliasDropdownMenuShortcutProps

    DropdownMenuShortcutProps: React.HTMLAttributes<HTMLSpanElement> & {
        className?: string;
    }

    Settings

    Member Visibility
    diff --git a/platform-bible-react/types/DropdownMenuSubContentProps.html b/platform-bible-react/types/DropdownMenuSubContentProps.html index 4e2cf030df..dc6c46454d 100644 --- a/platform-bible-react/types/DropdownMenuSubContentProps.html +++ b/platform-bible-react/types/DropdownMenuSubContentProps.html @@ -1 +1 @@ -DropdownMenuSubContentProps | platform-bible-react

    Type AliasDropdownMenuSubContentProps

    DropdownMenuSubContentProps: React.ComponentPropsWithoutRef<typeof DropdownMenuPrimitive.SubContent> & {
        className?: string;
    }

    Settings

    Member Visibility
    +DropdownMenuSubContentProps | platform-bible-react

    Type AliasDropdownMenuSubContentProps

    DropdownMenuSubContentProps: React.ComponentPropsWithoutRef<typeof DropdownMenuPrimitive.SubContent> & {
        className?: string;
    }

    Settings

    Member Visibility
    diff --git a/platform-bible-react/types/DropdownMenuSubTriggerProps.html b/platform-bible-react/types/DropdownMenuSubTriggerProps.html index cab582e93f..3999523b57 100644 --- a/platform-bible-react/types/DropdownMenuSubTriggerProps.html +++ b/platform-bible-react/types/DropdownMenuSubTriggerProps.html @@ -1 +1 @@ -DropdownMenuSubTriggerProps | platform-bible-react

    Type AliasDropdownMenuSubTriggerProps

    DropdownMenuSubTriggerProps: React.ComponentPropsWithoutRef<typeof DropdownMenuPrimitive.SubTrigger> & {
        className?: string;
        inset?: boolean;
    }

    Settings

    Member Visibility
    +DropdownMenuSubTriggerProps | platform-bible-react

    Type AliasDropdownMenuSubTriggerProps

    DropdownMenuSubTriggerProps: React.ComponentPropsWithoutRef<typeof DropdownMenuPrimitive.SubTrigger> & {
        className?: string;
        inset?: boolean;
    }

    Settings

    Member Visibility
    diff --git a/platform-bible-react/types/GridMenuInfo.html b/platform-bible-react/types/GridMenuInfo.html index 57acb029ed..c96e2a101b 100644 --- a/platform-bible-react/types/GridMenuInfo.html +++ b/platform-bible-react/types/GridMenuInfo.html @@ -1,2 +1,2 @@ GridMenuInfo | platform-bible-react

    Type AliasGridMenuInfo

    GridMenuInfo: {
        multiColumnMenu: Localized<MultiColumnMenu>;
    }

    Type declaration

    • multiColumnMenu: Localized<MultiColumnMenu>

      The menu object containing information about the columns, groups, and items to display.

      -

    Settings

    Member Visibility
    +

    Settings

    Member Visibility
    diff --git a/platform-bible-react/types/GridMenuProps.html b/platform-bible-react/types/GridMenuProps.html index 360449bb95..1f9d1686a2 100644 --- a/platform-bible-react/types/GridMenuProps.html +++ b/platform-bible-react/types/GridMenuProps.html @@ -1,3 +1,3 @@ GridMenuProps | platform-bible-react

    Type AliasGridMenuProps

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

    Type declaration

    • OptionalclassName?: string

      Additional css classes to help with unique styling of the grid menu

    • commandHandler: CommandHandler
    • Optionalid?: string

      Optional unique identifier

      -

    Settings

    Member Visibility
    +

    Settings

    Member Visibility
    diff --git a/platform-bible-react/types/IconButtonProps.html b/platform-bible-react/types/IconButtonProps.html index 3330f4095c..e018b8451d 100644 --- a/platform-bible-react/types/IconButtonProps.html +++ b/platform-bible-react/types/IconButtonProps.html @@ -19,4 +19,4 @@
  • Optionaltooltip?: string

    Optional tooltip to display if different from the aria-label.

    -

    • Settings

    Member Visibility
    +

    Settings

    Member Visibility
    diff --git a/platform-bible-react/types/InventoryItemOccurrence.html b/platform-bible-react/types/InventoryItemOccurrence.html index 55ccfae0ae..495c7fbe4c 100644 --- a/platform-bible-react/types/InventoryItemOccurrence.html +++ b/platform-bible-react/types/InventoryItemOccurrence.html @@ -1,4 +1,4 @@ InventoryItemOccurrence | platform-bible-react

    Type AliasInventoryItemOccurrence

    InventoryItemOccurrence: {
        reference: ScriptureReference;
        text: string;
    }

    Occurrence of item in inventory. Primarily used by table that shows occurrences

    Type declaration

    • reference: ScriptureReference

      Reference to scripture where the item appears

    • text: string

      Snippet of scripture that contains the occurrence

      -

    Settings

    Member Visibility
    +

    Settings

    Member Visibility
    diff --git a/platform-bible-react/types/InventoryLocalizedStrings.html b/platform-bible-react/types/InventoryLocalizedStrings.html index fc5a77ad9f..2f487fe64b 100644 --- a/platform-bible-react/types/InventoryLocalizedStrings.html +++ b/platform-bible-react/types/InventoryLocalizedStrings.html @@ -1 +1 @@ -InventoryLocalizedStrings | platform-bible-react

    Type AliasInventoryLocalizedStrings

    InventoryLocalizedStrings: {
        [localizedInventoryKey in typeof INVENTORY_STRING_KEYS[number]]?: LocalizedStringValue
    }

    Settings

    Member Visibility
    +InventoryLocalizedStrings | platform-bible-react

    Type AliasInventoryLocalizedStrings

    InventoryLocalizedStrings: {
        [localizedInventoryKey in typeof INVENTORY_STRING_KEYS[number]]?: LocalizedStringValue
    }

    Settings

    Member Visibility
    diff --git a/platform-bible-react/types/InventoryTableData.html b/platform-bible-react/types/InventoryTableData.html index f4f8af4a45..10f16471f3 100644 --- a/platform-bible-react/types/InventoryTableData.html +++ b/platform-bible-react/types/InventoryTableData.html @@ -7,4 +7,4 @@ prop for the Inventory component

  • occurrences: InventoryItemOccurrence[]

    Occurrences of this item in the scripture text for the selected scope

  • status: Status

    The status of this item (see documentation for Status type for more information)

    -

    • Settings

    Member Visibility
    +

    Settings

    Member Visibility
    diff --git a/platform-bible-react/types/MenuItemListProps.html b/platform-bible-react/types/MenuItemListProps.html index 2b09b15d4e..c05e8b401e 100644 --- a/platform-bible-react/types/MenuItemListProps.html +++ b/platform-bible-react/types/MenuItemListProps.html @@ -1,2 +1,2 @@ MenuItemListProps | platform-bible-react

    Type AliasMenuItemListProps

    MenuItemListProps: MenuPropsBase & {
        columnId?: ReferencedItem;
    }

    Type declaration

    • OptionalcolumnId?: ReferencedItem

      Optional unique (column) identifier

      -

    Settings

    Member Visibility
    +

    Settings

    Member Visibility
    diff --git a/platform-bible-react/types/ResultsSet.html b/platform-bible-react/types/ResultsSet.html index 7a6db4ce76..367d7c0968 100644 --- a/platform-bible-react/types/ResultsSet.html +++ b/platform-bible-react/types/ResultsSet.html @@ -3,4 +3,4 @@ sources.

    Type declaration

    • data: ScriptureItemDetail[]

      Array of Scripture item details (messages keyed by Scripture reference).

    • source: ResultsSource

      The backing source associated with this set of results.

      -

    Settings

    Member Visibility
    +

    Settings

    Member Visibility
    diff --git a/platform-bible-react/types/ResultsSource.html b/platform-bible-react/types/ResultsSource.html index 83862b7fd9..1c341c0b95 100644 --- a/platform-bible-react/types/ResultsSource.html +++ b/platform-bible-react/types/ResultsSource.html @@ -3,4 +3,4 @@ sources.

    Type declaration

    • displayName: string

      Name (potentially localized) of the source, suitable for display in the UI.

    • id: string

      Uniquely identifies the source.

      -

    Settings

    Member Visibility
    +

    Settings

    Member Visibility
    diff --git a/platform-bible-react/types/RowContents.html b/platform-bible-react/types/RowContents.html index afeb65f5e0..9e72e33763 100644 --- a/platform-bible-react/types/RowContents.html +++ b/platform-bible-react/types/RowContents.html @@ -1 +1 @@ -RowContents | platform-bible-react

    Type AliasRowContents<TData>

    RowContents<TData>: TSRow<TData>

    Type Parameters

    • TData

    Settings

    Member Visibility
    +RowContents | platform-bible-react

    Type AliasRowContents<TData>

    RowContents<TData>: TSRow<TData>

    Type Parameters

    • TData

    Settings

    Member Visibility
    diff --git a/platform-bible-react/types/Scope.html b/platform-bible-react/types/Scope.html index d177e673f7..0057f45a0e 100644 --- a/platform-bible-react/types/Scope.html +++ b/platform-bible-react/types/Scope.html @@ -1,2 +1,2 @@ Scope | platform-bible-react

    Type AliasScope

    Scope: "book" | "chapter" | "verse"

    Scope of scripture that the inventory can operate on

    -

    Settings

    Member Visibility
    +

    Settings

    Member Visibility
    diff --git a/platform-bible-react/types/ScriptureItemDetail.html b/platform-bible-react/types/ScriptureItemDetail.html index 853052a1cb..86d4186441 100644 --- a/platform-bible-react/types/ScriptureItemDetail.html +++ b/platform-bible-react/types/ScriptureItemDetail.html @@ -3,4 +3,4 @@

    Type declaration

    • detail: string

      Text of the error, note, etc. In the future, we might want to support something more than just text so that a JSX element could be provided with a link or some other controls related to the issue being reported.

      -

    Settings

    Member Visibility
    +

    Settings

    Member Visibility
    diff --git a/platform-bible-react/types/ScriptureResultsViewerColumnInfo.html b/platform-bible-react/types/ScriptureResultsViewerColumnInfo.html index 31454e421b..9a0a75bc45 100644 --- a/platform-bible-react/types/ScriptureResultsViewerColumnInfo.html +++ b/platform-bible-react/types/ScriptureResultsViewerColumnInfo.html @@ -2,4 +2,4 @@
  • OptionalscriptureBookGroupName?: string

    Optional text to display to refer to the Scripture book group. Default value: 'Scripture Book'.

  • OptionalscriptureReferenceColumnName?: string

    Optional header to display for the Reference column. Default value: 'Scripture Reference'.

  • OptionaltypeColumnName?: string

    Optional header to display for the Type column. Default value: 'Type'.

    -

    • Settings

    Member Visibility
    +

    Settings

    Member Visibility
    diff --git a/platform-bible-react/types/ScriptureResultsViewerProps.html b/platform-bible-react/types/ScriptureResultsViewerProps.html index 120b11845a..d7993346aa 100644 --- a/platform-bible-react/types/ScriptureResultsViewerProps.html +++ b/platform-bible-react/types/ScriptureResultsViewerProps.html @@ -3,4 +3,4 @@
  • OptionalshowColumnHeaders?: boolean

    Flag indicating whether to display column headers. Default is false.

  • OptionalshowSourceColumn?: boolean

    Flag indicating whether to display source column. Default is false.

  • sources: ResultsSet[]

    Groups of ScriptureItemDetail objects from particular sources (e.g., Scripture checks)

    -

    • Settings

    Member Visibility
    +

    Settings

    Member Visibility
    diff --git a/platform-bible-react/types/ScriptureSrcItemDetail.html b/platform-bible-react/types/ScriptureSrcItemDetail.html index 12b0b0e446..5912a1c47d 100644 --- a/platform-bible-react/types/ScriptureSrcItemDetail.html +++ b/platform-bible-react/types/ScriptureSrcItemDetail.html @@ -1,2 +1,2 @@ ScriptureSrcItemDetail | platform-bible-react

    Type AliasScriptureSrcItemDetail

    ScriptureSrcItemDetail: ScriptureItemDetail & {
        source: ResultsSource;
    }

    Type declaration

    • source: ResultsSource

      Source/type of detail. Can be used for grouping.

      -

    Settings

    Member Visibility
    +

    Settings

    Member Visibility
    diff --git a/platform-bible-react/types/ScrollGroupSelectorProps.html b/platform-bible-react/types/ScrollGroupSelectorProps.html index 464d3a4efe..d462b3de41 100644 --- a/platform-bible-react/types/ScrollGroupSelectorProps.html +++ b/platform-bible-react/types/ScrollGroupSelectorProps.html @@ -17,4 +17,4 @@
  • onChangeScrollGroupId: ((newScrollGroupId: ScrollGroupId | undefined) => void)

    Callback function run when the user tries to change the scroll group id

      • (newScrollGroupId): void

      • Parameters

        • newScrollGroupId: ScrollGroupId | undefined

        Returns void

  • scrollGroupId: ScrollGroupId | undefined

    Currently selected scroll group id. undefined for no scroll group

    -

    • Settings

    Member Visibility
    +

    Settings

    Member Visibility
    diff --git a/platform-bible-react/types/SearchBarProps.html b/platform-bible-react/types/SearchBarProps.html index 4e777b8f66..efa2109129 100644 --- a/platform-bible-react/types/SearchBarProps.html +++ b/platform-bible-react/types/SearchBarProps.html @@ -1,4 +1,4 @@ SearchBarProps | platform-bible-react

    Type AliasSearchBarProps

    SearchBarProps: {
        isFullWidth?: boolean;
        onSearch: ((searchQuery: string) => void);
        placeholder?: string;
    }

    Type declaration

    • OptionalisFullWidth?: boolean

      Optional boolean to set the input base to full width

    • onSearch: ((searchQuery: string) => void)

      Callback fired to handle the search query when button pressed

        • (searchQuery): void

        • Parameters

          • searchQuery: string

          Returns void

    • Optionalplaceholder?: string

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

      -

    Settings

    Member Visibility
    +

    Settings

    Member Visibility
    diff --git a/platform-bible-react/types/SortDirection.html b/platform-bible-react/types/SortDirection.html index 5e0ab694e7..894f0d3613 100644 --- a/platform-bible-react/types/SortDirection.html +++ b/platform-bible-react/types/SortDirection.html @@ -1 +1 @@ -SortDirection | platform-bible-react

    Type AliasSortDirection

    SortDirection: TSSortDirection

    Settings

    Member Visibility
    +SortDirection | platform-bible-react

    Type AliasSortDirection

    SortDirection: TSSortDirection

    Settings

    Member Visibility
    diff --git a/platform-bible-react/types/SpinnerProps.html b/platform-bible-react/types/SpinnerProps.html index 53ccb8f800..d913414fed 100644 --- a/platform-bible-react/types/SpinnerProps.html +++ b/platform-bible-react/types/SpinnerProps.html @@ -1 +1 @@ -SpinnerProps | platform-bible-react

    Type AliasSpinnerProps

    SpinnerProps: LucideProps

    Settings

    Member Visibility
    +SpinnerProps | platform-bible-react

    Type AliasSpinnerProps

    SpinnerProps: LucideProps

    Settings

    Member Visibility
    diff --git a/platform-bible-react/types/TabKeyValueContent.html b/platform-bible-react/types/TabKeyValueContent.html index de96fb4e6e..39e7e7250d 100644 --- a/platform-bible-react/types/TabKeyValueContent.html +++ b/platform-bible-react/types/TabKeyValueContent.html @@ -1 +1 @@ -TabKeyValueContent | platform-bible-react

    Type AliasTabKeyValueContent

    TabKeyValueContent: {
        content: ReactNode;
        key: string;
        value: string;
    }

    Settings

    Member Visibility
    +TabKeyValueContent | platform-bible-react

    Type AliasTabKeyValueContent

    TabKeyValueContent: {
        content: ReactNode;
        key: string;
        value: string;
    }

    Settings

    Member Visibility
    diff --git a/platform-bible-react/types/TableContents.html b/platform-bible-react/types/TableContents.html index 36a65bca6a..2fa142d24c 100644 --- a/platform-bible-react/types/TableContents.html +++ b/platform-bible-react/types/TableContents.html @@ -1 +1 @@ -TableContents | platform-bible-react

    Type AliasTableContents<TData>

    TableContents<TData>: TSTable<TData>

    Type Parameters

    • TData

    Settings

    Member Visibility
    +TableContents | platform-bible-react

    Type AliasTableContents<TData>

    TableContents<TData>: TSTable<TData>

    Type Parameters

    • TData

    Settings

    Member Visibility
    diff --git a/platform-bible-react/types/TextFieldProps.html b/platform-bible-react/types/TextFieldProps.html index 559d3b7fdd..9d720493bc 100644 --- a/platform-bible-react/types/TextFieldProps.html +++ b/platform-bible-react/types/TextFieldProps.html @@ -24,4 +24,4 @@
  • OptionalonFocus?: FocusEventHandler<HTMLInputElement>

    Triggers when textfield gets focus

  • Optionalplaceholder?: string

    The short hint displayed in the input before the user enters a value.

  • Optionalvalue?: string | number

    Value of the text field if controlled

    -

    • Settings

    Member Visibility
    +

    Settings

    Member Visibility
    diff --git a/platform-bible-react/types/ToolbarProps.html b/platform-bible-react/types/ToolbarProps.html index 8aa1e1a6c9..e8983259c8 100644 --- a/platform-bible-react/types/ToolbarProps.html +++ b/platform-bible-react/types/ToolbarProps.html @@ -3,4 +3,4 @@
  • Optionalid?: string

    Optional unique identifier

  • OptionalmenuProvider?: MultiColumnMenuProvider

    The optional delegate to use to get the menu data. If not specified, the "hamburger" menu will not display.

    -

    • Settings

    Member Visibility
    +

    Settings

    Member Visibility
    diff --git a/platform-bible-react/types/UsePromiseOptions.html b/platform-bible-react/types/UsePromiseOptions.html index a49455f703..12402e8170 100644 --- a/platform-bible-react/types/UsePromiseOptions.html +++ b/platform-bible-react/types/UsePromiseOptions.html @@ -1,3 +1,3 @@ UsePromiseOptions | platform-bible-react

    Type AliasUsePromiseOptions

    UsePromiseOptions: {
        preserveValue?: boolean;
    }

    Type declaration

    • OptionalpreserveValue?: 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
    +

    Settings

    Member Visibility
    diff --git a/platform-bible-react/types/VersionHistoryType.html b/platform-bible-react/types/VersionHistoryType.html index 78df237e90..85eed12abc 100644 --- a/platform-bible-react/types/VersionHistoryType.html +++ b/platform-bible-react/types/VersionHistoryType.html @@ -1,2 +1,2 @@ VersionHistoryType | platform-bible-react

    Type AliasVersionHistoryType

    VersionHistoryType: Record<string, VersionInformation>

    Type to store the version history information

    -

    Settings

    Member Visibility
    +

    Settings

    Member Visibility
    diff --git a/platform-bible-react/types/VersionInformation.html b/platform-bible-react/types/VersionInformation.html index e18a3c87ad..52f7e7c71b 100644 --- a/platform-bible-react/types/VersionInformation.html +++ b/platform-bible-react/types/VersionInformation.html @@ -1,3 +1,3 @@ VersionInformation | platform-bible-react

    Type AliasVersionInformation

    VersionInformation: {
        date: string;
        description: string;
    }

    Type declaration

    • date: string

      Date the version was published

    • description: string

      Description of the changes in the version

      -

    Settings

    Member Visibility
    +

    Settings

    Member Visibility
    diff --git a/platform-bible-react/variables/BOOK_SELECTOR_STRING_KEYS.html b/platform-bible-react/variables/BOOK_SELECTOR_STRING_KEYS.html index 302ef988b9..dff518eed0 100644 --- a/platform-bible-react/variables/BOOK_SELECTOR_STRING_KEYS.html +++ b/platform-bible-react/variables/BOOK_SELECTOR_STRING_KEYS.html @@ -1,4 +1,4 @@ BOOK_SELECTOR_STRING_KEYS | platform-bible-react

    VariableBOOK_SELECTOR_STRING_KEYSConst

    BOOK_SELECTOR_STRING_KEYS: readonly ["%webView_bookSelector_currentBook%", "%webView_bookSelector_choose%", "%webView_bookSelector_chooseBooks%"] = ...

    Object containing all keys used for localization in this component. If you're using this component in an extension, you can pass it into the useLocalizedStrings hook to easily obtain the localized strings and pass them into the localizedStrings prop of this component

    -

    Settings

    Member Visibility
    +

    Settings

    Member Visibility
    diff --git a/platform-bible-react/variables/INVENTORY_STRING_KEYS.html b/platform-bible-react/variables/INVENTORY_STRING_KEYS.html index 27f64529db..57daf8bba3 100644 --- a/platform-bible-react/variables/INVENTORY_STRING_KEYS.html +++ b/platform-bible-react/variables/INVENTORY_STRING_KEYS.html @@ -1,4 +1,4 @@ INVENTORY_STRING_KEYS | platform-bible-react

    VariableINVENTORY_STRING_KEYSConst

    INVENTORY_STRING_KEYS: readonly ["%webView_inventory_all%", "%webView_inventory_approved%", "%webView_inventory_unapproved%", "%webView_inventory_unknown%", "%webView_inventory_scope_currentBook%", "%webView_inventory_scope_chapter%", "%webView_inventory_scope_verse%", "%webView_inventory_filter_text%", "%webView_inventory_show_additional_items%", "%webView_inventory_occurrences_table_header_reference%", "%webView_inventory_occurrences_table_header_occurrence%"] = ...

    Object containing all keys used for localization in this component. If you're using this component in an extension, you can pass it into the useLocalizedStrings hook to easily obtain the localized strings and pass them into the localizedStrings prop of this component

    -

    Settings

    Member Visibility
    +

    Settings

    Member Visibility
    diff --git a/platform-bible-utils/assets/highlight.css b/platform-bible-utils/assets/highlight.css index 08f243b451..e6e13fbca9 100644 --- a/platform-bible-utils/assets/highlight.css +++ b/platform-bible-utils/assets/highlight.css @@ -19,10 +19,18 @@ --dark-hl-8: #B5CEA8; --light-hl-9: #EE0000; --dark-hl-9: #D7BA7D; - --light-hl-10: #000000; - --dark-hl-10: #C8C8C8; - --light-hl-11: #267F99; - --dark-hl-11: #4EC9B0; + --light-hl-10: #800000; + --dark-hl-10: #808080; + --light-hl-11: #800000; + --dark-hl-11: #569CD6; + --light-hl-12: #000000FF; + --dark-hl-12: #D4D4D4; + --light-hl-13: #E50000; + --dark-hl-13: #9CDCFE; + --light-hl-14: #000000; + --dark-hl-14: #C8C8C8; + --light-hl-15: #267F99; + --dark-hl-15: #4EC9B0; --light-code-background: #FFFFFF; --dark-code-background: #1E1E1E; } @@ -40,6 +48,10 @@ --hl-9: var(--light-hl-9); --hl-10: var(--light-hl-10); --hl-11: var(--light-hl-11); + --hl-12: var(--light-hl-12); + --hl-13: var(--light-hl-13); + --hl-14: var(--light-hl-14); + --hl-15: var(--light-hl-15); --code-background: var(--light-code-background); } } @@ -56,6 +68,10 @@ --hl-9: var(--dark-hl-9); --hl-10: var(--dark-hl-10); --hl-11: var(--dark-hl-11); + --hl-12: var(--dark-hl-12); + --hl-13: var(--dark-hl-13); + --hl-14: var(--dark-hl-14); + --hl-15: var(--dark-hl-15); --code-background: var(--dark-code-background); } } @@ -72,6 +88,10 @@ --hl-9: var(--light-hl-9); --hl-10: var(--light-hl-10); --hl-11: var(--light-hl-11); + --hl-12: var(--light-hl-12); + --hl-13: var(--light-hl-13); + --hl-14: var(--light-hl-14); + --hl-15: var(--light-hl-15); --code-background: var(--light-code-background); } @@ -88,6 +108,10 @@ --hl-9: var(--dark-hl-9); --hl-10: var(--dark-hl-10); --hl-11: var(--dark-hl-11); + --hl-12: var(--dark-hl-12); + --hl-13: var(--dark-hl-13); + --hl-14: var(--dark-hl-14); + --hl-15: var(--dark-hl-15); --code-background: var(--dark-code-background); } @@ -103,4 +127,8 @@ .hl-9 { color: var(--hl-9); } .hl-10 { color: var(--hl-10); } .hl-11 { color: var(--hl-11); } +.hl-12 { color: var(--hl-12); } +.hl-13 { color: var(--hl-13); } +.hl-14 { color: var(--hl-14); } +.hl-15 { color: var(--hl-15); } pre, code { background: var(--code-background); } diff --git a/platform-bible-utils/assets/navigation.js b/platform-bible-utils/assets/navigation.js index 22362ea8da..cdd4f871cf 100644 --- a/platform-bible-utils/assets/navigation.js +++ b/platform-bible-utils/assets/navigation.js @@ -1 +1 @@ -window.navigationData = "data:application/octet-stream;base64,H4sIAAAAAAAAA6Wab5PaNhDGvwuvM70mbdI274DjcjTHwWCOTKfTuRH2wimxJVeSEy6dfveO/4FtrVbi+pbn2d/a8kpa2fz5z8jA0Yzej9jhoODADDwIXex0rPgO1Fg/i1iPXo1yZp5G70f7QsSGS6GvCPsPTyZLR69GX7hIRu/f/fzvKzpJOJ9EGxRjiJD4iakxGlYrVKhMYCW5MI74s0xCspwpiGK1hj06Cn0HhVLADETPIl4peXy+kfWzWO4+Q4xfIRVAJEpgJwsRA8ZsNTIc8mkqhSO+ET2A2d8FS12ASiQBGhRnKf/uuIaTTEBAJPoTN08YodXIcF0oGCvFnnHCSaYgOmY5REZxcVjDAY45yrJcBHIvVcbM5NkAWo0d2QtZQ56yGDIQpk7uBlpWL7yeD25irROYA5hxmtbFftME37MMv22nmU4wfWK5AaVvpJpI+cVBHrg8yEIpEOZOxixFq3fooXEzpaRagNbs4KJ1LTSsSsi/QzJPbpTMypu5L7IdKAfZ6Q9L8xHKNSuKlUzTD0oW+TzxJEIiglPpYaSrUMgYKl1pmaCrQSMRwaUyE+Weg8WfVQLBRZwWCV7/rUaGJ3BcojOykahg3Rk1FNE1kKCoWbvZDp8ffQeNcq5arUaHFzsN6M7bakR4yrSZu4e0IxMQAd8+FBydFY1EBZfrqGuPPIkEQO73Goxr4TurXkSzQLopjcEL2oLS6O10ZAqiEi5YOq07MpTTcxConCUzgT6YWqFDI8MUWlitRoTramPcyMlkMp1Ot9stxrFMFJDqpUI6KZ1yvJmsBCowTzk6DJVABZZj5OzeziqJKOf/HYiDC3LWKUyx085V5iQSACOdPWQjUcGKCV32S2ORzKqOcw2H2TF3I6mAFyR6YbqwpN8YXh3l756wG6muC8VKv4vQsRCw6kS1ZYr3t6M4ZVqDvurJfczrN792OFOZpsxIZSNahYq+ZgY2PIObqjW2GX2dJMm4KLv0qcx2XAByPUMHRVsUBo42ovrZG7dguSN0wXIq+l6KLUt5wgwXB/8NkXYyT9XLusa8q1KUVcpMOQVmX0GYWcaNwS4Sc1FU65XNHdfIRaI2kqs/r4EloD4pjl7owECxyt5gLvbyDOHCgNqzGPRVK/YBb96+604aJoQ0t+wrLMU1T665zmV3/+/gcCsFp2gB4XPnSHU4QxMFvGPiULBDc87XKG/gIXHt2az2XjPDplIYxXdFf1Xs4ukYKt1CJnzPQc2OBoTmUlSBMk0hQVMR/pA0KyX7b8UQdOOhcN6yCi2mJlcEplxkVkrmoAwH/Cm6zOEJdHUcDYDXxhCwYQa8BeIyUwmiWPHcVFv/HhT03jt20LaNhAYN9EUj7B/a4DGtxmfCHDV1UmlEOQMXYFjCDHNwuhY/TAfQdAjuQYMKqxfU6Vnx3cu9ec7rld6zzP/42y+v377pN19FJqoTwW21GmsLajl8zGuAfMWU4d3X2DWsI3kpg3ZkmVcNqkXEbT46srj2l4dhHm/ACzKGp/ofOcoaC8lQ+nz8anrruVgUqeF1YSxAFEO8wxZKj7g4pODHD30+/u9airZc7vgXa1SGuo936gmGoJMQTKiXmC1LC+uqME8ot/fGsY+z3jXalHJM69E9T/4hDvOEcKtneA2G8VTPRU3A2Jjvcn5U7LBCchpDMswNZP2N7AxttVBOOQ0ZF1wcpjLLmLAqymm8PENU7DLHWKBGbwZ6LbhwDViqBBQkzQK1S6G5Hrvy3M7AHOXdOqCl5KP0jqVDTk+8iFQdRUlc5biIectEktojiHlCueWztPbinuglkdvtZXtr343NSttxGVPjDR0G10RHZ2U5tfRoOfZVP6v60rx5zq3b70g+yum0cd/74lZzemIwKYIUYmzgbEcwcwNHMxbxk7TKGrEEULEPrSee65sqQsLLObCOiQK+oHJDSvYlterryy7txx4El2Ij5+WhSOMFglj81PN7PRt31i7hoIuyZfAS2yOfRWoFP+Fz+cCaP0CgA2Y5fMzqy+Aa9svqO+GQ11d9rE+w23L4hhVHR7qAYm0xXc17tr0drzaz9ePmj9XszPnafJLQV129z/qpi0lgz4rU+lfOmdMzEKCb+TraPEbT9eNkufz4eP+wwGi2KwjZ3oyX2jEGgbezdTTzY082Ano3Drh/y0QA0/7ZSLentyh+goxhdDqCSFW2wn687SKQeb9t8NPJACKRDs6AOwl0/dhdM+ysWoi//gOZPQDMnCsAAA==" \ No newline at end of file +window.navigationData = "data:application/octet-stream;base64,H4sIAAAAAAAAA6Wa3XLbNhCF30XXmbpJm7TNnSTLsRrL0oiyMp1OxwORKxkJCLAAmMjp9N07JPVDEosF5N7qnP2WBBfAgtSf/wws7O3g/YDtdhp2zMKDNOXGpJpvQA/Ns0zN4NWgYPZp8H6wLWVquZLmirD/8GRzMXg1+MJlNnj/7ud/X9FJ4vkk2qIYS4SkT0wP0bBGoUJVBgvFpfXEn2USkhdMQ5LqJWzRUeg6KJQGZiF5lulCq/3zjWqexXzzGVL8CqkAIlEGG1XKFDDmUSPDoRgLJT3xBzEAmPxdMuED1CIJMKA5E/y75xpOMgEBmZlP3D5hhKNGhptSw1Br9owTTjIFMSkrILGay90SdrAvUJbjIpBbpXNmR88W0GpsyUHIEgrBUshB2ia5H+hYL4evlHcw6Yhgqmbq+cGNTmB2YIdCNPPq5hB8z3J8hL1mOsH4iRUWtLlReqTUFw+55wogS61B2juVMoFOlL6Hxk20VnoGxrCdj9a20LA6If8O2TS70Sqvbua+zDegPWSvPy7NR6iWxyTVSogPWpXFNAskQiKiU5l+pK9QyBgqXWUZoXPlIBHBlTKR1faGxZ9VAsFlKsoMr/+jRoZnsJ+jM/IgUcGmNWooom0gQclhm2AbfH50HTTKu0AeNTq83BhAN/mjRoQLZuzUP6QtmYBI+Pah5OisOEhUcLWO+rbjk0gA1HZrwPoWvrMaRBwWSD/lYAiC1qANejstmYLojEsmxk3zh3I6DgJVsGwi0QfTKHRoYplGC+uoEeGm3hhXajQajcfj9XqNcRwTBaTatpimzQiO9621QAUWgqPDUAtUYDVG3kbxrJKIav7fgdz5IGedwpQb411lTiIBsP4OywZbKauZNFW/NJTZpG5ul7Cb7As/kgp4QaIXpotL+o3h1VH9Hgi7Ufq61Kzy+wgtCwGrD29rpnl3O0oFMwbMVUfuYl6/+bXFGSshmFXaRRwVKvqaWVjxHG7q1thldHWSpNKyatbHKt9wCcj19B0UbVZa2LuI+udg3IwVntAZK6joeyXXTPCMWS534Rsi7WSeupf1jXlbpSgLwWw1BSZfQdpJzq3FLhJzUVTn7dAdN8hFojaSaz4vgWWgP2mOXmjPQLGq3mAqt+oM4dKC3rIUzNVR7ALevH3XnjRMSmVv2VeYy2ueXXNTqPb+38LhVgpO0SLCp96RanH6Jgp4x+SuZLvDKwWD8noeEnc8mzXea2bZWEmr+absroptPB1DpZupjG856MnegjRcyTpQCQEZmorwx6RZaNV9AYegDx4KFyyr2GI65ErAVovMQqsCtOWAP0WfOT6BqY+jEfDGGAO2zEKwQHxmKkGSal7YeuvfgobOK84W2rWR0KiBvmiEw0MbPab1+IyYp6ZOKo2oZuAMLMuYZR5O2xKGmQiaicE9GNBx9YI6Ayu+f7m3z0Wz0geW+R9/++X12zfd5qvMZX0iuK1XY+NAHUeIeQ1QLJi2vP3GvIG1pCCl147Mi7pBdYi4LURHFtfu8tDPEwx4Qcb4VP8jR1VjMRkqX4hfT28zlbNSWN4Uxgxk2cd7bLH0hMudgDC+7wvxfzdKHsvljn9xRqWvh3innqAPOgnRhGaJWTNROleFeWK5nTeOXZzzrtGlVGPajO558vdxmCeGWz/Da7CMCzOVDQFjY77L+Um5wQrJa4zJMLWQdzeyM/SoxXKqaci45HI3VnnOpFNRXuPlGZJyk3vGAjUGM9BrwYVrwFxnoCE7LFAbAYfrcSvP74zMUd2tB1pJIUrnWNrndMSLSPVRlMTVjouYt0xmwh1BzBPLrZ6lsxd3xCCJ3G4v21u7bmxWuo7LmAZv6DC4ITo6J8uppUfLsauGWfUH59Vz4dx+SwpRTqeN+84Xt4bTEaNJCQhIsYFzHdHMFeztUKZPyilrxBJBxT60nni+b6oICS/nyDomCviCyo0p2ZfUaqgvu7Qfe5BcyZWaVocigxcIYglTz+/1XNxZu4SDLsqOIUg8Hvkc0lEIEz5XD+zwBwh0wBxHiFl/GVzCdl5/J+zzumqI9Qk2aw7fsOJoSRdQnC2mrQXPtrfDxWqyfFz9sZicOV8PnyTMVVvvsn5qYzLYslI4/8o5czoGAnQzXSarx2S8fBzN5x8f7x9mGM11RSGPNxOktoxR4PVkmUzC2JONgN4NI+7fMRFA0T0bmePpLUmfIGcYnY4gUlWtcBjvughk0W0bwnQygEhkojPgTgLdPHbfDDurDuKv/wAZbplTBywAAA==" \ No newline at end of file diff --git a/platform-bible-utils/assets/search.js b/platform-bible-utils/assets/search.js index ad2515d1e3..5f106bee08 100644 --- a/platform-bible-utils/assets/search.js +++ b/platform-bible-utils/assets/search.js @@ -1 +1 @@ -window.searchData = "data:application/octet-stream;base64,H4sIAAAAAAAAA+29X5PjNpKv/VXeaO+52naN8B/yne2xd312PHbYHm+80Z7jUFWxuuVRSTUS1W3vxHz3EyQFFpD8AYQkklKNz1xMl0USQCYTCSAfIPmPV9vNh92rT97849Xfluv7V58wbl+/Wi8ei1efvPp099v67sfFdrm4XRWvXr/ab1evPnl1t1rsdsXuD8HVm3fl4+rVa3fx1SevXv3ztStTMd6WebdZ78rt/q7cbDNK/Ci83Sv99aunxbZYl51mPlfLNWdStjU/bTePy12OHB8933pWje8Wu++LslwV9zmVBncfWe9MPr+1bbHbrN4XP2x+XKz2WeJ2njir9l+Ku/K/l+W774rFbrPOq7/zzHEt8I32881qtUDW5S4MYqpBYVlW2rYrori7zWN1b29N7q7Tajm86vtvnsrlZr3rqa17d3at/iv546Isflg+Fl9uto+LslNneHmQ1wOKzHpJpKURJT5ky/FRe+v59X23WL/tmke8Unf/QDX/sPl2sS27FtPTgOfHzm/H8U0Ypva+ToPqz+060RYEHWhzt38s1uXnm8fb5boA9k5uGKYToUKj3ajc3X+83H38tN2UxV1ZD2LPQtL2e2LO+POAebvYFe7ezOaQR4Ztz91mXW6Xt/vIa4/pJ3hm2BatFmWxK7/Zl0/7XA2RR4ZtzybWJWBTNqAzDNKK9R+X998Vt/vlqjvVijQlfCTSOeP1Bw5i/3S/KIvPjrde+OB5bVnc33+z/Utd7ueeKWY2KP70ea26L1bFSQ2CDw7Rlk9Xq89P6N7Rh89r0/Yo490OZLfldrHeVSOlb4GfPpTF9sfFanm/OOI9ZRZ1dr/H7fdfxpntTxc1bPvfN0Wf4jkij47TvhP6beTRcdp31HjYeWgkm/xyuV6smko+Kx422+J0m0wXdf5Y6k01v96Xxa+d9tW/JieVnTK+XjzhYr5ePA0yPQ0Ky1rdte2KvLq3RdeGwlqaO7JL95Xy583avbX1294JffLuQdTXX0OWTtNiRUNjG9xjMxq16XbbU9qTv+7IaFP2IuT/O/ywXL8rtkvSQ09qenqJkveSM9crwzc+uZrJaHv20mb4pscWPjkWnLEKGqHBqTVSTqtjC6YhWnrsaiqjvT1Lq8Fbnbvuymh6ziJs8PZnrNAymt6zXBup1b1rueyWJxd2g7c+turLaC5aAg7evpPWhxmNP3uxOIh7PH8peYyop64rhxc1a9WZIdrRS9DxRDnXbR29Wh1PlNNnQ0csbEfsP8cse4/pP6eugYeZSfkLuf3jbbGNsEz/4jDLNFpg3qrMb+NxFLNbYQ/DzK8LE8xYhWl+eWStMXSYrLyPHua34djqh6i5j1p2685llpHa/U7y7WpRVqJ88b5Yl188LssSBDnQTYN0mmjBWZ0Htj2yqtrtb3d32+Vt16zjbfCfOakFJJZSvEcDeLx+d/9pdQez7+XuaQO2VMXrfn7i/NqLx+VRYje3D1Pvl93BLF3zl/mR2mPaUpW3Lf+8Kf/YKLa7log3Cz07fAsPb/wohfnPDNIi3zX9Zd12wG29oexPy13XjuBdgzineMlZ3gk3P+Ke9t7N3REg0RL64GltoQGSY1rQ3D5Avdv9+tPV6i+nagI/flq79PObeVuUn79bPJXFdvflZvvZZvO3tlEP+/VdPQD/oXtT0gK94jcPD7uijBT7fPG44g5tiZZ4uH5coT8WW28EoUXWV5MFiude9+VX333/w8/ff/7dz599881//fznv3zdlvv+sGl094fuTbnF/+nT/tI79xzf9s//89Nvf/jiu97me/cdX8mPX3z3/Re9VbR35b7St0X5p83dYrX8n+K/it++3Gy/v9tuVqv/2G72T1/dYwtPPHBatTtazK634u4juSq9Lx4W+1X5/d32u+IBKDO4nivP4u3bbfF2URbYaz1LgW88q5rab2XX1dydqyxnsj/8/99+AXTlX84tsjHRSIHPF3NVsi4+/Md+iSz1cCW3oOXu+3K7XL8FJblLuUXdF8XT56vNGnnJ9lp+Ybeb/foOl9Vcyu51VVf57DfUuZorR3TfL7bbzfbrYrdbvEVNI3fkFvxh4a0Qnkurfj6miC832z/ut2EIKyzNu+MIoT9drb65rY4+fHko7M+LxyLirPC9uZXdbYtFWXz/2/ru2+3m18rP1h23KRFUmLw/u9LmrELj+pBY4Q25xTYREuJwnwv1L58wftx/df/ldvNYTY6aMEd67Ojcnlvlrm7gD5vPPvvs888///HHH0E9nXuyHTt6pz0BSf/FvVtsP4VmUV/If//3xbeb5brEZT1fzS2wWN/vqlNCoDR3Kbuo3d3iqWj88HfF2+LXJ1Ro56bjbPS74mm1uCuqmHJ0MIjcmT3MrO9W+3voNNyl/KLui1+/QV3qcCV/6PNmVnD8867nFrpa7Mqvoi30rmZ3wFrPfyrWb6FB+ZezJw/Vu6zkQtMHdy23sKfF/RdrNBFpLhxRzPflYot6oLuUrbHVEs4b6t+zC3lawTG5/j3/3VXR8YgreL6YXdz+dhfrn+213MLKzafb7QLZ/eFK9vJ4e18hr8/JuUBvhRzckN0+B9Q+Xd9/sd7tt8V3xdsvfn1q/j/a9v6nzm3AsVUfVWk1T/7i7/vFKjKHrq8dMbff3+4KZMbuUrbpFdtlzGW01/KFTBXnXT1C0MMjwQnwQFzvhtxiq9u+WFcTAFDk88UjZm+f77dVCK4eVyLrh+CW48bxz34r4QjrXc2fwlQGHDN172qyQD6bG6aeF8F/LIqnChguPfsuf3uqNpY/XzmqxMOE5IffngpSonflqBL/sl5u1j9svlpX0cziLlhMNSWDO9I1KP2sAUKillUhD4u7SgXNpfTudT9oTqlWpKxeluXahFv8TbWfMtFs/3p+2zfHlvoReQKLEjQWy/P5Yr3elP+5eF/0SYbvHOT9JIrufV0RAU5UdKolWSrvbQ7tYJ8v1lHtNx0M3HFUFw4g238u1vcrb3ncVIFuSftGpcSzEf38c9n1ONEyP2pvz4C6rr2Z4qXaMKhAx0uSK0IdsklVXd8wqDDPJR4lUdNS7Feq0MpX64cN6mTuWr7v2L3bbMsqdNZb3Ef+rViGtmmRyh72q1UY0otW5t96WmV3B1DYX5d3Z3ZV/hv5/m67fCrrefhDsS38YLJXZ/eu/Ld024TTjij2o+dHsEyg0WlFHll/8NS5TXhfTYCObID3zAnVU0eCuV3T4/MRHSi1acKf/bl/W+rztdNK/b5YwYll94ZznV6kxD6nB1oa81NBzCan0hv3SG7VN4fGRlpQrMF7T9XfPHB67dHX+kPxa/np+u7dhk42wB1HLkmeQWZnLfJ86Vxj6ZTVZyZBu/Kaj8b6zvUhBckf6bvNTCxkyRZsunf1sKjFd50rXqrYPiFjDY+NMZun39wjx0jn+hp9/qhG9XT85dv1Zlv8cf+0Wt4tyuLb7eap2JbL4pR2pso6s83UdP73brN2D/9p+Tf6cunl7MjCnxbrt/vF2wMGgtMrckt+0Q4iNg/+cVEu4EEWv6r0I/lTrMeiXNwvysWplXzkFYDfZJ90kYatwsewwnMaCAo6t6FJJ3Ju+256XExfoR15432FFBUmimz6C7ol27CbZ75OmFh4R77ZPixWq9vF3d98spgu9qPwkcj8JGxwpPL1psRrOVStu/nICrtq3PXrcZelSG/XFLUV5xm/v3tXPD5X9LyTKv3A6SPvUTX0DcI9UkXe6r/tzhDaDXQ/t4Wc0rSeEblclqvzVHbjihihdffFrp6H+yPWSW30CvrYjKTJc23vpvq/j+04rXvqTrVOauNzOR+zwVo6eDcOmnmo72Mmz2uwV2j2zGfAxt/0zoqOleJyL6KVpf3pzE7ZlepZXTHfvIWbqseQ7ebnbfHwsRhNxJ6+H532Dil19pT4BVlpZBr9MVODv8rEDHvgUeZoWZtxafgOGlukRCRf3N8vq/F7sQJhg4k0gdrwMb+AZq6gC0SU0d6gp1ILbMjkXv8MRTXDw2RmBNvT0/n+7d7fZn/aMuZQxLVOGev2tS/lzJfR6Cs2HkfCfgM0+6Zb9tliTK98KoW7cG4X8cXpaGrsJWimiDdhhWOJO/piNlfcM6IuA8j5tKhO86+HmlHkCo2qnU4DF+u+XbndpXPXRhkKAEqPGMX/+V9vfvrpw08/ffzTTzd//ff/9W+X1s3Nzz///POHnw//u4SmXoYNhXpyP58b9TlHYTcdUxptWjqa+urZ6TXpcPJ1Yq5qIzVfaGgjFYQgbhA94Ape5HwTEcnD1XNjPeErRDqbeuaZEjYgJYOsglKiTz4LTYo+3MrvDJl3ETA7hPjdsl9iZyVStBcGfXNUVRP30aiMQf88N8SWknjqrhmXuP73gqKOu0aMy92pd1jf1KuEy3VkJHp7ddAgEG7ClSwVT9RPOI+fwmiuYsE4kLbaK4OGJI7U2+XWjYNrsYEblzTCq1tAxnUMSdG0Xh9MRkeci/5LTEXpizwXlYMXdtl5aEfAYBY6gqO87CS0K+7wgYCj5Bxq816mtE+jRK/6JL5UZ+2C83P3YGbInbGXEG1Hn1gNNzn720dQyXUbh68V9+P8AuoJ3s6VjAu56goGkEEJzQnKu5ZRJlt55eDIdHitHWbj16W4Q6PGmFIPanG7H67P5uo2XbvmwmNUUysufS7r9zdQ1vpoH51dwnSaV3LFoyPRUTAwjr/iiGnsmodEqrFy8F0eQ6rKVT/0ND4s9yUGTzwJ3I+DUh5fQxdC7L5oQc8edidrp7bJgXogaDn8Xt1sCceYdkIhnyu6xHscfoKI36SrZxoZY7kEfN9ZBikE+rJ8d3OPHvJT3X9VFo+k0PDiUeV+s70vtrBQ78q5SWRoUX1n1v1GxVJNVrfkVXPj7u2trP/FHm7+4teyWO+Wt6v647iL+sOosC3gxqNez9fFel+1rPqcMKnBv3RSmYcWLddvv9/fPhbrfaSCzn1n1vb55vFx0UmkFb3v6NrqJGx/LMrFcrX7av35ZrV/pMnPYredWdf3+9uvsR7hfUfX1jSyyuL+n8Wia//olqPqqFtZtW+5fltZbFUUECh227luIllun8+Itr1f3K/3q3LZKy25ayhhUbG5stKGJ/Lg1jftnu2CJq7q3nCugJES+2QDLY3l5No9e9ej6r4hT+Y2pH946Ok4Q3eYkzpKooME6q2/V0XNJFXjTftEXsU9U8VlWTweVb174NTaOx436RYGdgenuIF49yd59WpDzq/w5vmJrIp7XiQ0pFT1PXZ0XO3IjFKVp62ot25qRP9d3P64LD4AA/KunGs8tKg+w/EbFVNb86GkPzZfaqQKjFR4032qtwF9C8bNU4bu2kRE7d3n1nu3WZfFr+URdYdPnFB/wnQS+j97nO6UdYT1pPLpuWTmqP3BtXMF6BaWm2edihCmRFoskd+P1nbjPZBRbY/9fYi//HgLyEPnt+LwodbDG/882ifiTUqVMHT7foC+IrdtP/T4jp52RdNJxnJI5qYlrFbcJGlfN3zWvWmI9IORUvu6F2jxkUn80hX3JO4DD58UXO5rRB0sjrPBo5uR3CzX0xgvt0ucveW0aBDLCJrjgrIivrs02rCczHXUTZ/ZyH43ntPaaRXbttn9JE8wS5SmzaniJAo1lCghf4pvWDtFsp4uGTmlMJhkzRGD+NaUEURKD5nnynjckHqFPQkK0F4fxviwkibsYz1Chh0uvqf4bJmn7H19MjddcRi/eYqw/VPtYTWQMxW/+v7pCdHeM4a9+sq6WD+FwoZ99bwpVq/sl+uvWPa6z47hk/Nlhuv0c2XPWsdfYef0293OcoaZ3XzAQafRuyAWKTxGNsygAWoadsF6nIT1v2yYznWEaDk5CwaVs3s6OL4BbDiZL9ANkaTt1dFkPiIjweGs81///aefbtq/UWKC6bRy4x8Ob/4YzzwGTEZwYQ21l+NHfcbS1U3MjKaYs4ygwMO6ZHqjiymyx39n5iAYVL8w+UB8X/1II9e2+Pt+ufXi/dnSuicTJ+OODiYP8x6gZgdsZSw7d0+z0hm5pwtzZ2bejhtcOtt28gDGUU3LOnTR08xplIi2cye+sZLX5vNPVAwgQ5ig8JQ1w7BnJ4YQqUwnHRhclPghiSGk6TsZMbg4W7yp/1SpOsVdcz8PG9sO8ifQy1D7RAkT9PaYJGFobmDBpujzUcEG8spHSTRU148K1X/Efgyx7uIbs0+VEBZ5za6g22B37ZRlT/AugC4m8AgJgbK+knGycFN4hZRw9T9ne7qj5RogaHiEkPnfwBhQ3qk73ilfvDhX3AvECgdRCAjhTKijq7YVoJo2cDO9jo4NDk41Jpymv8yM95Nr89KD0InanNy5nafGc3aLjq/MjEyMV6DQF+IoQTKZ8eZYp6o1Y6vuanFbrF6Ifm9cY69Wy/9S5tyo2/3n2ZGFCfR+MJCXOXPofwOZiZKv7X30DJqn0d6reB/Jj5m9sNfgIuR/jiQ9vM73QRp97W/iX2Vg8NXufj4bOU3SEwKD+RcaKOAbyUyMfK3v54UuWo94P+VZmxSu9cWEecCu/M2kE5Fdzxv4Fxk6anW7/zxlJ/Pklt8YyL/OUBG+gcwUwdf2Pv6FhgbyPsqRGOtlXgTMB3blLyQrE9n1vId/kYHB17r7NZ7B+XrUH5rLv84wAd9HZtrpK307/0KDBn475XEZYF7CSzl9B//4L8Zr23WpfNwDCOMrNtLOl6HkqSDw8+GP8QIIF51beAK2T5y9RT9hBr2sdLrJLBQ9cJujRo2uaoqZo4v2wpRaua6Z33FqCiZyY06zr3tCdqTSmuHpSrX16FLanz/uBEVd8y7154a2v52NoTzhJ+jTSIJwE+HZLq1Txaj9DQo00OCdLcnwm8+hWOAr9mOKOFkXQoK1V88O2ndqvPwe8+OVgFIEDP/yL7azfCCFtEPt8F3/KjeUD662cCg4O+J2vhYvNoScpcVyENo4uvY26+Kb8/fCDa8+167r1t4o0S2oTJiCY7p52uPhs1yDCPcCjqW7ZrYWOYiqpzqK3m196NTP3shLKhjdNRNhmitTSTGciyRi1AUP04lzTs4P66GILF5cY8T3MlFfD6Rpfx5kKuRVNNlRmWwBm13bg1vk9NHdoyVufzk71NYr+3QnRs7QQjhenL1JK1MpPR5skGMb5yilTsI3lYX0ja2bzapcPk2oj+cafy/O4SBx+8sggd70q3dKvir30NFD6B4GWeVmqeW6HERXLbWDOJttDaWOXbHY3r37odg+jj7l87QS1vp7cRWe1O2vZ59f7TcEX9lX5TKgPkK3MYE37bbiSlwHVk/tPiaYbOWrZdgjmkfMvfx6f18LklDy9soUc/CpTyoOoJXQpUww9E5+XHAIJZXD7FQaVjv1950nVI+r7/fiSWp52/8eOioHXn6j4KvyG0QHobeYYCXv138lUw+qknrSMZV19KhimGO8+bqo6/tdTS8OEre/TDBiTnaa9QwthI5hgoXbZEdKz1FKU8SI3OMYbQx2LAdopP30xtCyxoTZr4v3i9V+URb3A+8cIJLFKppCyNrj7z5d1wmwz5euU9w1byAIG9v+frZ9ESVM4FVjkgQu82yPCWsZ1TFG5ar/nVagAdl8VCzP6w9shRfuUoFk7c9nz2hhdRnM/u0wByKOlPamrXZUoa/zVR/ub384e2GXqQan9Et64UyNBN767Mj7cfqZYv17tn6aD+xdlWKWI0yb+jWzHGB29VL9yDK47eyQe641LC8+l8vTR+BEzqb+R2nnojPCTO3U/54dUBlSLRf0IJ5e6v+ezrdGFHONDsappv3lItaT9j8XGZ579dSM1+MsZLLU1dPz9uvl3/fFGIGP45UXtuVqnNNgAb2oftqw3ji+J7rvarl+uyo+r8/cV58MPltAUOA1x75oc90VcbZ36yhigjlTXJowNdngwk0x5UkI19xx9lLxSKkWq9UAh20SYtUVnO8QjhRrnHh/QkxY4fnj5ZFiP+5X5XJAR9gt75r9IGlt+3bO33dA1DAFW43JEjrBoUWbwgfGRRtoTn6cTMN4wLhQrvwJRRqJdkZFxM7v/G0eRwldFbr7crP9Zl38d3H747L4MAjf7RR51R6w02B3jQ9yaIQoY6I9JjGJQlc4SP4RWNXo+0WiApbDxEWPlmzgs8tR+bwF9SCbA/uEnLzTBRK2HnM8U81Jcbm+W+3viz8WD4v9qpzwBT+Lf9Ntw+jquF5joNporwyyOSpTL51XcmnffqyuwsHgkqq7+KhxtOrKYSj+iDrbPA2znj1Bbc91/5591EEL7S+DbGDPNRb3Cq7UJ3V0E/qiS6iqpz8NdgTifFXVXGmQo6nDquhusy6LX8uLuZ2w/t+z6/E00f46yBGSXIPxX8WVuiCoo9ANXUpl1+qKsMpqdzTIeZThVTVa9sOo6mAWxPHm1p7gfDY3TPFW9kOO9M3688263G5WqzrU+EtxV35flOVy/bZVRFXQ7g+999c6CSU5qvbsaoeqr1yURUZt1W3putSzV/96c798WBZbUFBb1XJdFtuHxV2x+0Pi9mSVYWxptSgfNtvHH/zx5IhKPiIFYFNMSZazMDumQeX5DUEv5WCvqSYdbslX/mHZdXjuq7bE3Eo+ShSQlt9JE2lY8euZDUsUcFbDnMD3T18u7srN9rev7o/XFnl4EE2d1KDIw8c2iPqrpCs+w++Gj3622FEP2L0h2/eFj4IR1dNl7N4zhNnVfmB5uw/mjEiq4M4Txdv9R5D8ISpac1++PwkTZuYU+5F7BNscbPYRk+6sJoQPnt8QgEuy2hE8d1Iz0BuvZgDQuECb6L1HGTTu7qf083gHP6VnZ3Xp8/pyRic+q/f2dtuh++vRHXWIHnpi1xygT57WGXN6Yd2lAkP2q3UX89/YfRMh7y/to+c7I61vWxatart8X+y+3G4es6rz786vknalv+yKLVrctL9nd5r2iT7vB29MViO4b1i+Rw7Xu2A5nrw/WWlmBK6/go/aZ/FrSosUC9zsTpe4jUW0ZZzQsD5mtCzhNxzzW+dKGL5t6XBhfgv9AF9im+M5TV2sf4Pb4/IbWZeQ+jTYOc2rA0vn2eChhEHaNnSXJdG6s5rZBOES42Xv6uR8AW7S1Zwr3OQvJCVPG0c9z/LD2GlKfyM7m1Mkz00AN6giRvdoJ2micYPxzc1TqoA8Ga4yhteIK//Fd+//CHL5DeGOI+/y6FXV6LLmfqFiGNFP20M1luj1vyM6rxyRk1tyxxI86wv0Y4l/2b4Nvxyd2Fc4qBbO+FTRtOq4SQeJxlLKCzGW4MMyqcNaI+vpnE8gXVZjuV8wmESBp+1kubACe/I2XIPirsoAM/Pb/949W6im9kJ8r+vYhuYb0cuzs2cF5mZGnlCfL8LvRfXZk2juevR48Rm+p82s5KW/dx+I0gElvhsztqX1rxmuo6ditfV9F2E67fV000QapbEU6VV52QhEesPU4IrIyKD+coKH31IDG3N0/7bXF0wyGUIy534afTgVXDSYCFVQ/3sFoj8tyrLYrqfty54eUP3Tq+TyfqCriPbaeDGPTmXgdUTs5v+8+emnDz/99PFf//2nn27av//tepR28/PPP3/4+fC/5o9L6vGl2RxQX3sxnkhmOkXexAzwIhPfQbVbz4OvWMU9I0rmGbUxNR9pwqWH2uCx8VTyLzBTbn8fby190Vnxs3zhXHi8IFVfpx13R4wnb7MJZrz32iNokX2KdAAl5FT28rpqr1Rt3GLAl9yvymn7c74SbnIONIygkL4eH0l6OYVG0gkxp9dFWGNwdGNwV3go/eV1+64Y7bXxIGn6sMoEI3UoZzhaj8dFvFon679JuZsc3uPFqzIEfowcih9A9G7RL697EhnchSHX6lRN0/bLmIBBnxzSE+EKp4ohR8UdfGp1nJzjMOqotBlnMkeQ+FKdtcsgzz01lSN4BjfuzRoytVJujk5DMoK2rtxwojpqbxlyP2qutuJv7krGkxNVGc4NJ+21fZqdOvgzuGqboNFVWWtvnOnaHObR6ZF+hw4zpqP2lvHnXcAEo2/umh1mvyozP5B8AcVet7/M0GzjL6/KWHt0mkyydrEhKStJ2u/QTyL9tJeHjBIdPUwHb+ya/WNahZnffZ5YodftF3s02vjEqzHOzPnjdfjDo5JG/g79IdJPe3lIqH/0MPxi/GFahYE/HHLT9FkKvW5/2KPRQ1KmF6LL3aEZY2UlipT/8jgQEsRdTXxP6vi3DTU2rYdJy5r7DZZhRJ/aF/TI3vTuIVfVJwjtHhk8uxAt+OV20+CgV+KbSqe/r0skEopIl/vl4jOF7bHKiV5lA2qHBNLHCDkOpo2J6h3oHM2Er6aPBtK2P49tzZdICHScAppMH4POKHsUce0m4TTS/jK2N7iSxD/naikcJ4Zc7h2jtB4PO/SJorOV1vPhqosq6zoMLTCrIY8gvHQ/FSqmvTC9ii6YxGcglYUXLuDwL5e2ZygN1o7sqjV3udm1pz//q4b/z5dBtbQ/X2BYnD4ZzyCK6vsc7wT66ul8Y6TfianO1TX6qqYnhDbOUWpU+IsNpXVPgvMhwXlXVxeZniApw5F0hBj/xRLppISu/x1hhnodqXNSkncqHsM7XTJ1yZHCt/56yE3XsTYcmSLnOXnG0OlxTlaSn3zkw8B5cfK19oKsqqOw9tIU/a4nPwsxsGmnmoPqspl5TuHRj1JpzygwdrqblKbhx9knHgvQbHUE+V/yzLR9YyOsQi8zC32WKJx7jjAA93W/kfZVeBI2WylGeHc9ooGsFt8P37+Stby8LhcXpx1oxk088v1F+mWG2OH5xEmU0Nd3J0hB09FCk8niKuQ/uIGh882Exb68Luy1v/XCI8QjL5BaBkoWjqAjzN4ukUwGS9r0vRFgRYaIruzo16EHTKED6nh53TAmTPs+x8j61NHcZXI/xWUOR9ExMuFG6p46sW1CBfU6fYxPmR0p+j75tfcBdBGr4OV1ZiiJuyyHnBJjnU3bjXukDT+aPiQvSVU8VQfuE775GtKQK/VTpG6fGSdqhot/wf22G/+TQ3pgpK8L9VkkadhjR3FXF2OcacHrf4ecZhwv8KicMy19FyWM4q0vSaWOVkB7dUhSEm/FVX0S5AxlgU8uDBoFOkaDL8rKoOLay0MuAk9Q4aU/AzKeXg/ztAub6JV+AyStdohFJx848HR3FC287Klt++ZGeUWXmsY+SxVOXkfp0H3dcWhIiqRsMOkoU9Ue8RCAGbqvJep4eV0vJkz7NkemYxfol70ihxhmAgVMjWT6NdDgmSuQ3SWS+aL7+BjpdHA1L69bJ+RxN42ROgmp7zKZplKCB/17yKVzf+Uxbaw3o3zFIqmFps6LyH4N5l/J7/5jjJSz8bprzU+dKCxbFTeuCdMqpKeD7KqxYvDtMV6hL8/Ht613P4lBt8a0upl4Y0xXqnA+NoqQEwf6kZCDO6Jc4UY6wQxE9I6ZDrq3Py7oBfpgIGX786DnD0mlGeeL74uHxX416BwjX/Sb59onUME1G4HTRLvQGnSXfK9O2hdxeZeeq5/Q90/Ui4i6rmBwyFbX4Eu7wdR0X2yX74vdl9vN48W05bfg/7miVhut/Qy65TjHcJ5fyBW7JKCnMJA/uRenLZrsrOe5aqtJ5uRePFddo6QTASprU4kMmqAhc7q/2twtVsv/Kf6r+G1IOcNiX95q2mu/+3HIDQ2+eqZ1dUiwwH0NiXi6lU01a4JiNtcuIt9hG8XoIh7quZCU5e6HSd5jXc2FZFwOOh4sXyZQWrbR4iEjN8up8ZAnRjiFG1SoiV2fL9Sh7MlkGcHN+eI8Fz/d2xncpQXvx5U+pjyCd767EJYEpMM31mKFrT3a5yRK/qh9CKsj0vrYamd3gnDtO2sfPqYpfba0LFenqeTGPTpga9I+NaNNgceMTxtPalwMfGY06/D5ovgq/KQG1b3sRFs6PHpeawbrXsQfndawxuv0Hak+lNBzCvPoJt+kyz9ZnOmUnpLA3ZTImZMvS1JVYzmGU2QNj0+f6E2yRR/P+5wke+Oy4gGGSYQmT8Y+zXS2DtKfZrrqbhokAU5k5Dj9fZ3xTaahpQt7ZHydd6awp62OBhe2TG9vHlfI5J6LwUX1QvSjmfDV9NFA2vbneKR9GLnP+CbTRAq4cfVPpIZrN4jgYzWpT9CNpZlzvsd0IR2FI0R8s9q4KutbuGHoeSmV1chzQvdzjKquw8gCoxpjTvxSPVSomPZCPFg9mjGd/S2mS6ssvBDfIDWFBq/bf0U12JxCv2bNXW5W7enP+3l6r3+9vsxXS/vz2GvMIb/FdFlFNb3vAp5/iG8xDa46r64Lrd69R5J5Lc4VPSNp2TUH0LpJOcYYe8/NVDaGlOE4OkLHPTdL2ShC1/9eUticDGWjSI4qnlAJF+zP0YxBo0QIJslKNrWaQAKoi2juxdgVUFh7Mb69fALVDZSF7Kr0Wc89r1GpPWNBZuqxUXQdqftiw2Lw2AhKeJGz0/b3Edahl5mJPksUzj9HCNv0db6RdlR4EjabKEZ4dz2igVRG3w7fv3JqeQldrleOdl0/xIvs19pE/TJf7Juw6vFV0NdzI+nGRtWBq/Ti0oeeIJJx5lwnlsw5c13dt9vw9toIqO70hDPDShaOniPE8c/4EtPAkjap/kaI2WSI6FJDHXroIMJ2y3wJ3Yy02l0YZC1LNTJR/4qJFPStQXwIrmn0eGhUwOGmM8dJNjD/jMr3NOiStlfGyTtdF3qdfLokR9QMJrlc363298Xhua/WZbF9WNxN956f1XCTaMr4+rlW44hqpb1lkP2FufqJv6RL+/4TlRfOx6bpi326nCwAMrgym8DJdVhkb6zlahxfoim/Y8cX00p7y4jzIGBm0Zd0lY6vX3mB4xsEp56tyiv1exm6bPzedRhkjxadu7x/+nJxV262v311f8nJHmnG79jfIY20lweJohw9pAYv5yr9XFppgY8bI+JxnAqv1L/16LDxbZc3wMz53IX9WqQZv2O/hjTSXh4EHx89ZF6/X0srLfBrg2x7PUuFV+rXenR4SO5y7dpzzRg880mk4JfANFDT3dXEt9aPeKNQORN5irR0Yd7yQYblRIXj9+keaZteOsj69AQx3SPDZTChJb6k7hYclkl8If2EdzJpspKIPGHPGiSIiWoanR7GxKv/HQSLHiPWwOgwJpx3uG14w7x8Xwvka38ezUYnTTpynMhN+oFh5m09ol/ta3c6aH8ZrVdfOrnIuXoJffogS6Vj1NTjGwc7o3G2mupDwNemngsbU2A6g2wGf7H+JlRFe2FCpVwiUchASgovTOmqL5AaZCid1Q7pOnV1gRmtpzHv5ymmf9frk3xFtD9POYRNmPBjENU0fWrQUMpVpviIKav9ONJoa4eeMNLAh0VRqS8onNQ93Zr4CuPxL2b61B0JucJxbsgI9fTJOlJi1v8OOSu8cHqOlKydGgf1KxdJnXCkuK1vHWTbbKzyI9NwPB/lHywFx8lq8ZMffBgq90a+nl6C5XRU1F4atTf1ZIQgRjTR9G5Q7TWzvVF98VFK7PHfo6XUSOkWVTqZF0czxCElflmzwfatDLmCm3jm9yxDON8bcnjs60ZDc3lPpgbFD/l+eoQBJ+5HzoPx4hNgkPQHg6DQhJ4ul/KCChqe4xpX7L4+OGaai47czSn7y0p8qGOwnBZheS+hK3otbj3mkJG2KdNXQFnCEW3IOdKkCSuwbE0fGjKcniGUy2lRfV19tM/agcJfQneKNb99Z4NmiOkoaeI8MXEpw1Ft0PyTkUonSyeZELpeuQ762Zwjhd3viu04/TJW8kvolLDt7rIcZKqJ1TNRd+yRL/xI7SAx/FSNo3fEPnGbr3IMsnY9Rc72mYHjQbjcF9X/urEsOYi3RKqZuu8h2cKeN6yjmZ6fpUWt/x1koD9exHEYWlrebnh7WM96ERpytMjt1UHi9fHqryOl/RnqAenEh4l9HKOzl2FJUFXt5UEWUCco7WJp7MfT5GGmdCkzvLYc9mlFQ+Q2ncvHU8xh5X5p08n27Qz7GiafOj7LEU4Yh+2Yfd1qMACH5GoQ3LDTwx6BEBQYrM8kCn8JXSjW/PaNjUVlpuxfvUKGaGBMkSfDBP0yN8jgktK6pBNfdB8fNNkGLv8ldM+EBO6mQZOnIE1NnF0mJWrQTwdZaPbXGpN/vRk2J3tS7qayaaW9qFFXErv/GDS1Y7zSWsmTJQDKFv7G1T2RCnrMflf59eG2SXilvQR/3LbX/SSG2SLRqmGqDRJdOcI50LBiTRWYRmIN50JyxRn6dCUQyjseN8z+6LhoU/alQK7252HOVJHaMs4+3hcPi/1qmFE+X9ib52rHFPoqX7STvV2kDLPvuFcLrc4v6H5zNRL66bH7BlHQJR15toKGWxYNppj7Yrt8X+y+3G4ep9ePX/Xv0aW08rc2MszmzxzjeNb9NboWoJkw8Dyd/6VNGf/E2rmKqpnZdP43V0HDJiIASmqTEAxzCDxzUr3a3C1Wy/8p/qv4bRDJwvJewtrTa7H7cRAE7mtiIieFRAkczyDYoVvL6PMWKFhzbVqJDqh9PKEOFUwtV7n7Ydx3VZc/tVTLYbz18qVgjWUb6xwkerGcDFJ4DQ8nSsOIMZWb8sU4FDp+64d0Sb4Az+VO8AaGcz/BO3DFjiIBV8+d+Ku/7H75rljcF9v/3i7LYtuKsmy/vvQHek8tRdg4r/CZtP5Oi+3irvyh+LXMLvij8CGsgU6z+xvwWVF+KIr1t5vlutyd1BpawnlNe1iu7/9c/Fr+aXO3qHzGNw9fL8q7d8v12+PU1VvO+c38frl+uyp+XKz2xXHtCh88vyHfNg8d1Yb2mfOq/2W3WX+7KN/9sPmx2O6K74qHT9f33zw87Ioj2pMu5LwGrjf3xQ+b/32oIb9NneeGaMYZOooXcF7DtsXj5n19XKdYl3/e3BdHOAH47HnN2e9++fzdYv3WW5j3NiN45rzq3x/0+8PmL7tfDoI5D5LfoJ5STmji3DDF21Ym2laNabs/dG9IDk7JCWyyxI/am7FQoKXRfSL3x9V5c3git+KeKcsm7I9ZLdiku+DRbfiFeqmsVvzS56Ny2kFNzDmab5BawovnmhYorc+sSOsi6nTdMLu+G++JnIpPMalE7T3m1Fs3t76HgNPXQ8l/OGbqqtizWdxt1rtyu6++aJVV5kfhA1H7PHFoSFadMSycOdlLVp870Tt9ntdbfc8c77wZVLL2zNnTQJOnjKbkT5wGnPgm23XKpHfIWUyycSfNYIZd4fVa9wmru+OXx3nNyVmbD7U0z21I3rL8/FVCsj1HrBA6Lfnr61fL9X3x66tP/lFbdGV6n7ziN+KmookPy2J1v3v1yZumia9f3W0eHxtvd3+I/7z66+G2H4tq/Klubu7+w+zV6zez11reSDX/619fv3EP1xfqH1wZz7/UD7JXr9+w11LeWC6CB1nnQRY8yF+9fsNRjbzzIA8eFK9evxHoQdF5UAQPylev30j0oOw8KIMH1avXbxR6UHUeVMGD+tXrNxo9qDsP6uBBE9Oq6Txoggftq9dvDKrRdh60wYPzV6/f2NdK3cxn4YPzzoPz0AAqe5ijKlnXdhgxnrj1APMJ7YdVVsFmr9X8Rsxk+HDXhFhoQ9VHxd8wBh/umhEL7YhV1sE4fLhrSiy0JVZZCBPw4a45sdCemI69Jda1KBaaFKttCto/61oVC82K2eiL6hoWCy2ryt30hikocde4WGhdVQLRN0yjh3nXvHhoXrw2LwMf7toXJ/6pti8LHwYuKrQvXtvXHD7ctS8e2lf1/cU3HFo279oXD+2r+lrTGw4tm3fti4f2VeUWe8OhZfOugfHQwKr0tW84tGzeNTAeGli1b/wNl/DhroXx0MKqzYxvOLQw3rUwHlpYtVXpDYcWJroWJkILqw7YvuHQwkTXwkRoYaIeAqGFia6FCTIKVjbDoYUJMBCGFlZ9PfGNgBYmuhYmQgurPn31RjA4AnctTIQWVn2u742A477oWpgILUxEh0XRNTARGlh13uKNwPOGroGJ0MCqneRvBPSdomtgIjQwOYu1WnbtS4b2VW04fCPg3EN27UuG9iV51PHKrn3J0L6kiDpe2bUvSWZaMup4JZhshfYlVdTxyq59ydC+quQeEccru/YlQ/uSJup4ZdfAZGhg0kYdr+wamAwNTM6jjld2DUyGBqZmUceruhamQgtTLOp4VdfCVGhhikcdr+pamAotTImo41VdC1OhhSkZdbyqa2GKzOdV1PEqMKUPLUzpqONVXQtToYUpE3W8qmthKrQwVbswuJ5QXQtToYWpecwLqa6BqdDA9Cw61dZdA9OhgWkWnWrrroHp0MA0j061ddfAdGhgWkSn2rprYDo0MC1jU23dtS8d2peuR0i4DNNd+9JkzahjL0qDVWNoXro2Lwsr7pqXDs1L1+YFV3K6a146NC9dWYycvVbiRhjS7K596dC+TGUxEs4oTNe+TGhfprIYCWcUpmtfJrQvU1mMhLMC07UvE9qXqSxGwlmB6dqXCe3L1NEIOLKbroGZ0MCMisYHuvZlQvsylclI6EVM18AMiUtUJiOhZRsQmggNzFQmI6F1mq6BmdDATG1g0DpN18BMaGC2MhkF41u2a2A2NDBbmYyC1mm7BmZDA7OVyShonbZrYDY0MFuZjILWabsGZkMDs5XJKGidtmtgNjQwW4e8oHXaroXZ0MJsZTMKWpjtWpgNLcxWNqNwCKtrYZZEvyqbUdDCLAiAhRZmK5tR0MJs18JsaGHzymY0tLB518LmoYXNK5vR0MLmXQubhxY2r2xGQwubdy1sHlrYvLIZDS1s3rWweWhh88pmNLSwedfC5qGFzSub0dDC5l0Lm4cWNq8Dq9DC5l0Lm4cWNq9sRkMLm3ctbB5a2LyyGQ0tbN61sDmJsVY2o6GFzUGYlcZZK6Mx0MSaa+Hj3m+H5yu7MdDKmmv0eRJvnVWmY6ChNdfo8yTkOqusx0Bba67R50nUdVYZkMEBzBmIu85I4HVW2ZCBFtdco8+T2OusMiMDja65Rp8n8ddZZUkG2l1zjT5PQrCzOrYPTa+5Rp8nYdhZZU8mEqkHgdgZsb86dm+x/aFQfyfWX9mTxfYHw/3E/uoQvsX2hyL+NORfR/Ettj8U9KdR/zqQb7H9obg/DfzXsXyL7Q+F/mnsvwn+Y/tD4X8a/69D+hbbHyIAFAHUYX2L7Q9RAIoB6si+xfaHQAAhAawO7s+x/QEWwAgMYHV8f47tD+AARngAq0P8c2x/gAgwggRYHeWfY/sDUIARKsDqQP8c2x/gAoyAAVbH+ufY/gAaYIQNsDrcP8f2B+gAI3iA1RH/ObY/AAgYIQSsDvrPsf0BRsAIJGB13H+O7Q9gAkY4ARNNFAQbIEAFjLACVof/2QxbIMAFjPACJhrkiU0QIANGmAGrMQCbYRsE2IARbsBqFMBm2AgBOmCEHbAaB7AZtkKADxjhB6xGAmyGzRAgBEYYAmsgwgzbIeAIjIAEVrMBNsOGCFgCIzCB1XyAzbAlAp7ACFBgDVFg2BIBVGCEKjDZxOSwJQKwwAhZYDUswOEeBtgCI3CB1bwg9jywQ8IXWAMYqsAgQOEAMTDCGFgDGWIFADsknIE1oIHhrgRQAyOsgdX4IKYCYIYEN7CaIEQlAGZIkAOrKQKL7AgA1IER7MBUY4a4LwPywAh6YKoxQ/2a6Rs506QAYIYEP7CaKDCG+zIgEIwgCKZEqgXAEAmGYKoxROwMAIlgBEUwpVItQDtCiCGqxhCxNwFEghEkwWrKwDj2JoBKMIIlWE0aGMfeBJAJRtAEa9gEx+MawBOM8AnWAAqOOyNAFIwwCtZACo77AsAUjHAKdgAVuC8AVMEIq2ANrOB4XAO4ghFewXSzKwn3BcAsGIEWrOYQ1ZZ5WACwRAIuWEMuOLZEAC8YoResBhKxvgAABiMEg9VQgglsygBiMEIxWA0mGN7cwADIYIRksBpOMLzBgQGYwQjNYDWgYHijAgNAgxGiwQxPKBFADUaoBjMNNovsFAOWSMgGMzLVAmCJhG6wBm/gbQ8MEA5GEAczOtUCYIkEc7CaXDDMWhkgHYygDmYaS8S9EdAORnAHM40l4t4IiAcjyIPZxhIhqGaAejCCPVhNMpjEnQmQD0bQB6tpBpN4lyWgH4zgD1YTDSbxTktAQBhBIMymLBFQEEYwCKvJBpN4uyYgIYygEFbTDSbh/goGaAgjOITZZtsm3j4JiAgjSITVlINJuM+CASrCCBZhNelgEu61YICMMIJGWE07GAZ/DNARRvAIm6fmiYCQMIJI2LyxxDmcKwNKwggmYTX5YArP1gEpYQSVsJp+MMVe89nN3NICgCUSXMJqAlKdR+T2xhhDCgCWSJAJqykIU+K1MDdM0BYASyTYhM1TozMgJ4ygEza3CX8A6Akj+ITN56kWoL3EdDNxbYlKvhazm7kKC+CAoXDCUPiMxT0SBxCFE4jCZ4nRmQOKwglF4TMRtwMOMAonGIXPGktUryW7UZq2AOwvJhyFzxIrFg5ACicghc906i2AfcaEpPCajDClUW/kAKVwglL4zKZEAPuNCUvhs3l8cOUApnACUzibJVoAaAonNIU3RyewQ+EAp3CCU3hzfiJiSICncMJTeHOGQpnXUtzMOyIASyRAhbPE6MwBUeGEqPDmLIWyrwW74ca+Zmp++JOUBYyS0BXOElNGDvAKJ3iFN+crIlYN+AonfIU3ZywiHRMAFk4AC28OWuDJCgeEhdOzFjxllOi4BT1vwVNGiY5cdM5cpIwSHrsgRtkcvMCTFY6OXtCzFzxllOj4BT1/wVVKB8AS6RkMrlM6AJZIz2Fwk+iY6CgGPYvBU+4RHceg5zH4PK9jotMZBLtwkTJKgF04wS68wS6RjgmwCyfYhTfYJdIxAXbhBLvwBrvgRQAH2IUT7MJFyigBduEEu3CRMkqAXTjBLlykjBJgF06wC2+wC55+coBdOMEuXKSMEmAXTrALb7ALXklxgF04wS5cpiwRYBdOsAuXKfcIsAsn2IXLlHsE3IUT7sIPpzpmr6Xu9gUAXjgBL7wBL5q9lvMbrakI6HQascQGvODlKAfghRPwwmVqoAbghRPwwqVJvQVgiYS88Ia8xN4CsERCXnhDXjR/rdiNkMQnAvLCCXnhKmWJgLxwQl64SlkiIC+ckBeuUpYIyAsn5IWrlCUC8sIJeeEqZYmAvHBCXnhDXiJvAZAXTsgLb8iLxvMtQF44IS+8IS94ByUH5IUT8sJVyicC8sIJeeENedEKBUY4IC+ckBfekBe8FZMD8sIJeeENecHbMTkgL5yQF96QF7wlkwPywgl54Q15wdsyOSAvnJAX3pAXvDOTA/LCCXnhDXnBWzM5IC+ckBfekBe8N5MD8sIJeeENecGbMzkgL5yQF65TlgjICyfkhTfkBW/v5IC8cEJeuEn5REBeOCEvvCEvBs8PAHnhhLzwFHnhgLxwQl54Q16Mhr0RkBdOyAtvyIvBqx9AXjghL9ykYjuAvHBCXnhDXgw8OMUBeeGEvPCGvJg5jO0A8sIJeeENebH4+DwgL5yQF24SUUYOyAsn5IU35AXvdOWAvHBCXnhDXiJKBOSFE/LCG/ISUSIgL5yQF96QF7zZlgPywgl54SnywgF54YS88Ia8WDy4AvLCCXnhDXmxkZQCwBIJeeENebHYHwDywgl54Q15sbg7A/LCCXnhNmWJgLxwQl54Q17wnl8OyAsn5IWnyAsH5IUT8sIb8mJxGg1AXjghL7whLxElAvLCCXnhDXmxOFQLyAsn5IU35GWOHQogL5yQF96QF7zzmAPywgl54Q15wVuPOSAvnJAXPk+NzoC8cEJeeENeMP/igLxwQl7EgbzA9YIA5EUQ8iIa8oLjBwKQF0HIi0iRFwHIiyDkRTTkBZuyAORFEPIiZgmfKAB5EYS8iFkiiiMAeRGEvIgUeRGAvAhCXkRDXnBfEIC8CEJeRIq8CEBeBCEvoiEvMR2AZByEvAiWYIACkBdByItoyAt2KAKQF0HIi2ApSwTkRRDyIg7kBesAkBdByItoyEtMB8ASCXkRDXnBXlkA3CIIbhEp3CIAbhEEtwiWiOIIgFsEwS2CJaI4AuAWQXCLOOS1gmF2AXCLILhFpHCLALhFENwiDrjFvhb2xsh5HWbn8obPGSkLGCUhL4KnjBKQF0HIi2jIS8SmAHkRhLwIngDTApAXQciLaMjLXMAEQYC8CEJexIG8RFoAjJKQF8ETYFoA8iIIeREp8iIAeRGEvAieCC0KgFsEzYaVwi0CJcSiGbFEIrQoUFIsmhVLJEKLAiXG6mTGSoQWBUyORSyxwS04sCdQgiyaIUskltECJcmiWbIOuCWiRGCJNFPWAbdElAgskabLanBLTInAEmnKrAa34HCKQFmzCG4RKdwiAG4RBLeIFG4RALcIgltECrcIgFsEwS1CJrZICIBbBMEtQqamjAC3CIJbhFR5QwQgL4KQF5EiLwKQF0HIi0iRFwHIiyDkRaTIiwDkRRDyIhryEllFAPIiCHkRKfIiAHkRhLyIhrzMJexXgLwIQl6ESg3UgLwIQl6ESs0eAXkRhLwIlZo9AvIiCHkRDXmZY9cAyIsg5EWolCUC8iIIeREqZYmAvAhCXoRKWSIgL4KQF5EiLwKQF0HIi9ApSwTkRRDyInTKPQLyIgh5ETrlHgF5EYS8CJ2IdwtAXgQhL0Kn3CMgL4KQF6FTK2pAXgQhL0In9kUIQF4EIS+iIS+RSSsgL4KQF6ET28YEIC+CkBehUz4RkBdByItIkRcByIsg5EUcyAu2A0BeBCEvIkVeBCAvgpAXYVI+EZAXQciLaMhLxA4AeRGEvIiGvODj9QKQF0HIi0ideRGAvAhCXoRJ+URAXgQhL8KkfCIgL4KQF2FSK2pAXgQhL8KmLBGQF0HIi7CZK2oAYQSBMMKmjBJAGEEgjLApowQQRhAII2zKKAGEEQTCiAbCzHF+YwBhBIEwwqZW1ADCCAJhRANhcNYHASCMIBBG2NSKGkAYQSCMsKmAI4AwgkAYMU+FvgGEEQTCiAbCRN4CgDCCQBjRQJiIhwcQRhAII+aJY9ICQBhBIIxoIExk1gsgjCAQRsxTK2oAYQSBMGKeWlEDCCMIhBHzxP5uASCMIBBGNBAGJyARAMIIAmFE6viLABBGEAgjDxAG6kACCCMJhJGzxFZaCSCMJBBG1kyF4xwqEkAYSSCMnCUsUQIIIwmEkbPEQSwJIIwkEEYeIExEByBBNYEwsoEwePUjAYSRBMLIWeIglgQQRhIIIxsIE9MBSFZNIIw8QBjo0iSAMJJAGFkzFY5T4UgAYSSBMJIlwLQEEEYSCCMPx1+wDgCEkQTCSJaId0sAYSSBMLKBMHgFKAGEkQTCSJbwiRJAGEkgjGQJnygBhJEEwkiWiDJKAGEkgTCygTB49SMBhJEEwsiaqfAZzIIiAYSRBMJI3lgi3PkmAYSRBMJInrJEQF4kIS+SpywRkBdJyIvkiSOBEpAXSciLPJAXOD+QgLxIQl4kT1kiIC+SkBfJE9vGJCAvkpAXyVM+EZAXSciL5CmfCMiLJORFHs68YH8AyIsk5EU25AVv2pKAvEhCXqRIWSIgL5KQFylSlgjIiyTkRYqUJQLyIgl5kQ15iekAWCIhLzJFXiQgL5KQFykSWyQkIC+SkBcpmo9I4A+NAfIiCXmRIuUTAXmRhLzIA3nBn98A5EXSD5akyItEHy2hXy1JkReJPlxCv1ySIi8SfbyEfr2kBil8pqpQwkzTT5AAS+x8wUQmBhb4ERNiiYfPmOCviaAPmdAvmaRwi0QfM6FfM0nhFok+aEK/aJLCLRJ91IR+1aT5rEnsLQBLJLhFNp82ibwFgFskwS2y+bwJThcoAW6RBLfIFG6RALdIgltkCrdIgFskwS1SJaI4EuAWSXCLbHBLZHgHuEUS3CJTuEUC3CIJbpENbsGbeSXALZLgFpk66CIBbpEEt0iViOJIgFskwS1SJ6I4EuAWSXCLbHAL3o8sAW6RBLdInbJEgFskwS1SpywR4BZJcIvUCfAnAW6RBLfIBrfgLdUS4BZJcIvUKUsEuEUS3CJ1yicC3CIJbpEH3BLRAbBEglvkAbfAkKgEuEUS3CJN4xMN9IkAt0iCW6RpfCKebAPcIglukaaJ4sB0OhLgFklwi6zpCa++KIQKAJZIcIus6QnHCUwlwC2S4BZpEul0JMAtkuAWWdMTjtNvSoBbJMEtsqYnvPo8ESoAWCLBLbKmJ5xJXACwRIJbZE1POMMBCIBbJMEtsqYnnEFuJwFukQS3yBqZcIZNGTAWSRiLrJEJZ9iUAWORhLFI21giNmXAWCRhLLJGJpxjUwaMRRLGImtkwqsPx6ECgCUSxiIbxoJj6xIwFkkYi7QpnwgYiySMRTaMJTLBAIxFEsYia2TCOe5MgLFIwlhkjUw4x50JMBZJGIuskQnnuDMBxiIJY5E1MuEcdybAWCRhLLJGJpzjzgQYiySMRc4bS8SdCTAWSRiLPBx0wYYEGIskjEWmGIsEjEUSxiLniSQREjAWSRiLrJEJ59gfAMYiCWOR88YSsT8AjEUSxqJqZMIF9AcKMBZFGIuqkQkX0B8owFgUYSyqYSwCdiYFGIsijEXVyITjFKQKMBZFGItKHXRRgLEowlhUw1hwvj4FGIsijEUdDrrA80oKMBZFGIuaJXyiAoxFEcaiamTChUSmrABjUYSxqANjgXvJFWAsijAWlUoxpgBjUYSxKMbiQ5sCjEURxqJSB10UYCyKMBaVOuiiAGNRhLGoGpnE3gJgLIowFsUSo7MCjEURxqJSB10UYCyKMBaVOuiiAGNRhLGo1EEXBRiLIoxFscQGMQUYiyKMRaUOuijAWBRhLIonNs0qwFgUYSwqdbpFAcaiCGNRPGWJgLEowlgUT6ydFWAsijAWlcorpgBjUYSxKJ6yRMBYFGEsiqcsETAWRRiL4om1swKMRRHGonjKEgFjUYSxqNTpFgUYiyKMRaWSiSnAWBRhLKphLDi6rwBjUYSxKJFYsSjAWBRhLCqVTEwBxqIIY1GpZGIKMBZFGItKJRNTgLEowliUSGS4U4CxKMJYVCqZmAKMRRHGokSb4S65UVAB3KIIblEp3KIAblEEtyiZMkqAWxTBLUomMtwpgFsUwS2qwS14Ia8AblEEt6jUQRcFcIsiuEXJlFEC3KIIblE1PYlNFQBuUQS3qMPX4yM6AEZJcIuSKaMEuEUR3KJkIsitAG5R9EPyB9wCeY1C35KnH5NvcAuOxyj0PXn6QfkUblHom/L0o/Ip3KLQd+Xph+WbL8vHdAAssfNxeRWPDCr4fXliiSncotA35ulH5lOnWxT6zjz90HzqdItC35qnH5tXqYEafXCe4BaVOt2iAG5RBLcozeLhVQVwiyK4RaVwiwK4RRHcolK4RQHcoghuUTq1eAG4RRHcorSKR4gVwC2K4BaVwi0K4BZFcItK4RYFcIsiuEXp1DIa4BZFcIvSiSC3ArhFEdyiUqdbFMAtiuAWZRKbIRTALYrgFtXglogOAG5RBLeoA26BoUUFcIsiuEWlvuiiAG5RBLcokxqdAW5RBLcokxqdAW5RBLeoBrfg8KoCuEUR3KJManQGuEUR3KJManQGuEUR3KIa3BLRAcAtiuAW1eAWHCFWALcogltU6kiLArhFEdyiUkdaFMAtiuAWlTrSogBuUQS3KJvYDKEAblEEtyib8okAtyiCW9ThSAsOZgDcoghuUakjLQrgFkVwi0odaVEAtyiCW9Q8kUNHAdyiCG5R85RPBLhFEdyi5ilLBLhFEdyi5ilLBLhFEdyi5qmADsAtiuAWNU9ZIsAtiuAWNU9ZIsAtiuAWlTrSogBuUQS3qHliq6ICuEUR3KIOuAWPzgC3KIJb9CwxOmuAWzTBLXqWsEQNcIsmuEXPElsVNcAtmuAWPUskidAAt2iCW3QKt2iAWzTBLXqWlyRCA/KiCXnRs4RRakBeNCEvepYwSg3IiybkRc8SB6I1IC+akBc9m8dhsgbkRRPyolPkRQPyogl50amPu2hAXjQhL5olpowakBdNyItmIr5HSAPyogl50amPu2hAXjQhL5olpowakBdNyIuuQUpkIa8BedGEvGhm4nsCNCAvmpAXzRIDtQbkRRPyollioNaAvGhCXjRPBHQ0IC+akBfNWXxnhgbkRRPyolPkRQPyogl50SnyogF50YS86BR50YC8aEJedA1SIkBdA/KiCXnRKfKiAXnRhLzoFHnRgLxoQl50irxoQF40IS+6BilcwJ2bGpAXTciLTpEXDciLJuRFp/KKaUBeNCEvOpVXTAPyogl50SI1UAPyogl50SnyogF50YS8aJE5UAMIowmE0SJllADCaAJhtEgN1ADCaAJhtEgN1ADCaAJhtJjHt8poQF40IS86RV40IC+akBedOuiiAXnRhLxomRqoAXnRhLzow0EXiAM1IC+akBedIi8akBdNyItOkRcNyIsm5EXL1EANyIsm5EU35AVvJ9aAvGhCXnSKvGhAXjQhLzpFXjQgL5qQF92QFwE/i6MBedGEvGiVOPynAXnRhLxolbJEQF40IS9aifjeOw3IiybkRauUJQLyogl50SpliYC8aEJetEqAaQ3IiybkRavEBkYNyIsm5EWnDrpoQF40IS9aJTYwakBeNCEvOkVeNCAvmpAXncorpgF50YS86FReMQ3IiybkRWsR34OpAXnRhLzoVF4xDciLJuRFp/KKaUBeNCEvWieOoWpAXjQhLzqVV0wD8qIJedHNQRecSVYD8qIJedE6ka5EA/KiCXnRJpGuRAPyogl50Qfygg0JkBdNyItu8orhJKgakBdNyItu8orhj1RpQF40IS+6Oegi4FleDciLJuRFp77oogF50YS8aJPY1K0BedGEvGiTSBKhAXnRhLxok0hFqwF50YS86Ia8xN4CsERCXvSBvMAsVBqQF03Ii7ap0RmQF03Ii27IC94RrQF50YS86AN5gTuiNSAvmpAXbROJczQgL5qQF90cdIlMMAB50YS86EMyMbgjWgPyogl50TaRJEID8qIJedHWxndEa0BeNCEvOvVFFw3IiybkRc9TPhGQF03Ii24OukTeAiAvmpAXfTjoghddgLxoQl50KpmYBuRFE/Ki5ylLBORFE/Ki54nDfxqQF03Iiz4cdMHTPEBeNCEvep6yREBeNCEv+kBeIETUgLxoQl50KpmYBuRFE/JiUsnEDCAvhpAXk0omZgB5MYS8mFkiXYkB5MUQ8mJSycQMIC+GkBeTSiZmAHkxhLyYVDIxA3CLIbjFzBKWaABuMQS3mFQyMQNwiyG4xcwSoUUDcIshuMU0B13wTNUA3GIIbjFNMjG8I9oA3GIIbjGpZGIG4BZDcItJJRMzALcYglsMSyTOMQC3GIJbzOGLLjA2aQBuMQS3mFQyMQNwiyG4xRySifXFJg0gL4aQF8NSRgnIiyHkxbCUUQLyYgh5MSxxSt8A8mIIeTENecE7og0gL4aQF5PKK2YAeTGEvJhUXjEDyIsh5MVwEZ8qGEBeDCEvhsv4jmgDyIsh5MWk8ooZQF4MIS+GJxYvBpAXQ8iL4SYemzSAvBhCXgy38R3RBpAXQ8iL4YmB2gDyYgh5MSI1UAPyYgh5MYIldADIiyHkxQge3xFtAHkxhLwYkRqoAXkxhLwYkRqoAXkxhLwYkZgyGoBbDMEtRqQGaoBbDMEtRqR8IsAthuAWI2x8R7QBuMUQ3GJEyhIBbjEEtxiZskSAWwzBLUYmFi8G4BZDcItpcAveEW0AbjEEtxiZskSAWwzBLUamLBHgFkNwi5GJZbQBuMUQ3GIa3IJ3RBuAWwzBLUamLBHgFkNwi5GJXIsG4BZDcItp8orFdAAskeAWoxKZSwzALYbgFpPCLQbgFkNwi1Gp0RngFkNwi1Gp0RngFkNwi2kOuuAd0QbgFkNwi1Gp0RngFkNwi1Gp0RngFkNwi6npSVQHwBIJbjHKxndEG4BbDMEtRqV8IsAthuAWo1M+EeAWQ3CL0YkgtwG4xRDcYnQiO7wBuMUQ3GJ0yicC3GIIbjE6kR3eANxiCG4xOmWJALcYgluMTlkiwC2G4BajE5shDMAthuAWo1M+EeAWQ3CLSeEWA3CLIbjFpHCLAbjFENxiTCqgA3CLIbjFmJQlAtxiCG4xJmWJALcYgluMSewVMwC3GIJbzOEzLjiYAXCLIbjFNAdd8I5oA3CLIbjFmNToDHCLIbjFmJQlAtxiCG4xJpEd3gDcYghuMc1nXCLBDIBbDMEtJoVbDMAthuAW0+CW/mAGIC+GkBdjU0YJyIsh5MXYlFEC8mIIeTGHMy84mAHIiyHkxVgd3xFtAHkxhLyYFHkxgLwYQl6MTRklIC+GkBdjU1NGQF4MIS+mSTGGd0QbQF4MIS9mnjJKQF4MIS9mnpoyAvJiCHkx80RSZAPIiyHkxRxSjOHlEyAvhpAXk/qMiwHkxRDyYlIpxgwgL4aQFzNPBXQAeTGEvJhDijEczADkxRDyYlLkxQDyYgh5sSnyYgF5sYS82BR5sYC8WEJebCrFmAXkxRLyYlPkxQLyYgl5sSnyYgF5sYS82BR5sYC8WEJe7EzHd0RbQF4sIS82RV4sIC+WkBeb+oyLBeTFEvJiU59xsYC8WEJeLEsM1BaQF0vIi02RFwvIiyXkxbK8gdoCCGMJhLEsZZQAwlgCYSxLDNQWQBhLIIxliYHaAghjCYSxzZkXvCPaAvJiCXmxKfJiAXmxhLxYljJKQF4sIS+WJQZqC8iLJeTFHs68QBxoAXmxhLzYFHmxgLxYQl5sirxYQF4sIS+WJwZqC8iLJeTFNuQF74i2gLxYQl5sirxYQF4sIS82RV4sIC+WkBfbkBe8I9oC8mIJebE8sZXWAvJiCXmxPGWJgLxYQl6smMV3RFtAXiwhLzb1RRcLyIsl5MWmvuhiAXmxhLzY1BddLCAvlpAXKxLfFrKAvFhCXmzqiy4WkBdLyIsVOr4j2gLyYgl5sSnyYgF5sYS8WJHyiYC8WEJerEgN1IC8WEJerExkpbWAvFhCXqxMWSIgL5aQFytTlgjIiyXkxTbkJTK4AvJiCXmxDXnBoRkLyIsl5MU2B13wjmgLyIsl5MWmvuhiAXmxhLzY1BddLCAvlpAXm/qiiwXkxRLyYpuDLngvrgXkxRLyYmuQEtmLawF5sYS82CbFGN4RbQF5sYS82FSKMQvIiyXkxaZSjFlAXiwhLzb1RRcLyIsl5MU25CXyFgB5sYS82Ia8xN4CsERCXuyBvMCPmVpAXiwhL7YhLxJ+HskC8mIJebHNQRfJcAHAEgl5sTVI4ZLDAgB5sYS82CbFmIRftbGAvFhCXmwNUriEn4SxgLxYQl5sc9BF4jUoIC+WkBfbpBiTeJIFyIsl5MU2KcYk7o2AvFhCXmwNUri0uABgiYS82Bqk8GpnPCoAWCIhL7ZJMaawJQLyYgl5sU2KMQU/RmIBebGEvNhUijELyIsl5MU2X3RRHLYAkBdLyIttUowpbMqAvFhCXmyTYkzBr95ZQF4sIS+2OeiiFC4AWCIhLzZ10MUC8mIJebENeVHwU2EWkBdLyIttUozFlAgskZAX23zRRRncAmCJhLzYhrzACQ7gLpZwF9scc4l0JcBdLOEu1qY8IuAulnAXa1MeEcAWS2CLbb7nEnFoALZYAlts8z2XiEMDsMUS2GKbYy4RnwxgiyWwxTawJeKPAGyxBLZYaxIDG4AtlsAWa1NjM4AtlsAWa1NjM4AtlsAW28CWyKgAYIv77a+vXy3X74ttWdx/tb4vfn31yZs3r169/sern5fNf1bxwbqOV5/84xVn6tUn//jn61ecz5s/BGeHP+ThkrCHX6q0zfUfVcqj5g9x+KPav9z8YXnzRxVb/OQf//zna9fq5mfX3vpaJcDPP5e/PRVBA5l+biBTh8qZEu6PQ51Mm8Mfhrs/pPvj0Bxm3S9zV87cPTU/SMNn3P3hlDGzhz/YzP0h3R/aKcxd4u4Sd08Jd0m4S8Jdku6SdOUo94ty92j3h3GXnIDcuBYa13gnILfuFycpnx/KEU5AMZPuD3eJuUtOLuHkEtxdcnIJJ5dwr104cYR0JTu5hJNLKFeOcpe0u6TdU05S4SQV7g0K6y45yxLWtWcu3B+uPe6dVh+9P/xxeN3V588Pfxxuls7Sq28xH/5wNwt3yUkqnaTSCSidXFK1vxwaVn138PDH4ZJymlfOopTTvHKaV07zymm++v7Aoee5S86ilLMo5Rqm3CuokmI3f7gWKtdC5TSvXAtV20L3CpTrRFX6zuYPp/kqkePhD3dp7i7NtfMNM/eHdH+4S0527XpTle6p+cOJrJ3I2omsnchV+pXmDyeydiJrJ7J27qLKjHD4w11ysmtnddVx6+YP1620c3XVucfDH+4eZ2zaORDtjM04YzPO2IwzNsNaB+kuOaszzuqMc73Vnu3DH+5m53GrTbSHP9wlJ6lx/rDaWNf8od3N2l1yklbbfQ5/uHKcyNWmi8Mf7pLzJMb1L+NEtk5k60S2TuSKCR3+cJecyNaJbJ1Lsa6jWdfRrJO9ip8d/ji8d+vs2Tpbtc2L6x1kFvf3/ggjzfMA0+ghp4RludysF6un7eap2JbLYheOqsobVWftaNEOCa0zdS6Pt97QuTPXu6R7W9VHBg5dyBmx6/bVaZvD23KKY9m62Gz3T/eLsrjbrMvt8nZfCeYLw5kni3OANq/0t2+3xdtFWezXu/3t7m67vC22i91v67tAXdqrobGy00oOC515hc7yCl2tNg+B6DPvPUrX66qvMh88qfOSrX9x7lvz1iu5uRBvu3HbkVwfm7d9Q+Q1dP0baaiQzw1Vzj4UaweB1uW7X5ydKTfGKtO689YxO4NrLc/1Oe3sTLdegbc+yf3ipozG6cu4WVu17/hgr86FOAu2jf/rV8FuV2zL9aa8X+6eNrsi7NLC69J5M8/aKt8vtsvF7SqYgHpmlGlFpf+4sd70dZbXbW4Xu6L9MXArXllubpMn3u1m87fl+mETTq3n/tRaZxe03j8G5XDP+JjO68B3i/W7xftis75f3h9eYdg2v0yZZxN3i/V6U6aLFX6xeSLfvVs8lcW2szTR3PMwea/hUFRHgf6L1UcVFY47nPtvNFNr7xZbYrO+XcwyS9ncF0+b5boMi7Je92EsrwPdbVarRbnZBrp+LibzpW1W+8d1qB3rj2Q2uzFVOR+W5bt3xeKeKtz4A71xi2WRq7PHp8U2sClvLpLnKw5l7O622+IhaJvxe1AzB8kobb0rt/s7on1Pb865N/+4aZ6b2bjpWrsMcfNlNwi66YnJ1dC6LH4tH4v1PnyTvtrdDFXqvDmPP9EJ36b2Z22HQvNG5LvN02/ux7BM4ccvMueXd9tiURbViPS03fz628OmmTRtbn8p7sKe6ruzWV5Tq7leuXwsHjbbx7CzBt0+r6zidrNf34Vu0bPheZ6890XxdLfarMNyPMXN8zp9VU7x9/1iFbyBme+DRK5gxdPTYlsuaVm+jjK7+X3xsNivAk1X2y+eJ5ZuHaVdd7EiV9665Kbz++X7UT17VCs/FLfvl8WHaMfzw4Vzt3pheWN+WEW5eeoUP5/5xbs4zizXih7IKizozwcvIdw8XM2c2m2utldFWSxWq6gD4cIfDVw1RxQeXYN547pbKmZOiu6L7fJ9sXvYbh7DpnqqVm2YxgULrMxtdrX2eqLtrXYDeFPVdgHsgpG8/cOFMN2Kn7vlA3exDe5iG2LWGoQLT7vognDRBSHaMditqF2BwhUo3DJEuGWI0O4eFyMRLjQiXGhEuIiIcGsW4aJc0qlPuqW+dEsw6dZQ0q0MpQtuSRf2kC4cIF1TpWuqdE2VzjVI94akC3jLdvybt/FFZ3tOP8rpR7llmnKaV62hulegZPtHu9B1TzmNKdcM5Zqh3OxHuUFeubC0cqpTTnXKLRtVG0ibuWAba/9wa0y31tGu8dq1WbvXrWX7h3tKtl7V/eLesnZvWbvQkXaLX+0i6HruLjnrNe4tGxdBN+51G/eWDW//cDMeF7k0LnJp3OTIyPYXF8dx62vjYrTGxSlNO4VyK3fjGm9caNa4QKxxgVjjTMK6xlvXZutM1LrJm3WNt67x1lmmdZEm60IB1pmoVZnTjmJXbJeL1fJ/whXZzJ/CiMyyuis76bkzFzFjrrHMhW6YzBxKmgoeAqcmvQm1yWzo4Ye7zePtcl2Ek2p/fp7ZLFLc5qk7hxX+WjIzIlo8LoPpifS8t8kbCKoiiLq8McvkTRCK9X0oiz+K6Lzxrljf16u1YBXql5M5WSnWu/22WGy3i99Ce/UDOiJvkVbs7hZPxa7cLtdV2LL49Slonb9ozwSlxXsSGxLexExnturXu9X+vni6f3pYVCu+35b34WzGXw9J2xKhNoiXaRmHarabavWyXJfF9mFxV5CqvM4gW9TUEovMKFfxa1msd8vNup5HbVar4v5Q7a4oy+X6bRjcNX6dLThr0UzekhnUCSuzfmXtENdGgHN12a2sXJRFWJW/tjBtDNfN7Hh2VdvFXVmtAoLSfUdrHU6zNtfk2kJvi/JDUazrmFFoC773se2SKHMZ87BYrW4Xd3/7WxF2W+m7RTdj4pkruIfl+n5d/FquNneLyuNuHh4X5d275fptVz1eZ7Zu8LY2z79X9VTRnDUpU/plugHY5vWJqszdcv12VbxfrPahpfhxcutmR9bmOciH5XZX/ry72/5cxYR/JjFN5RedN1g+F+girrRM5RvGkWW+L7a7olOi9hWQV2InbML8+ELL6I4o7Pa3kvBD3zUxkWk8dVnbxfotCXn7RTm/c2yJ5aaKhpBgsx9KPxScaZNNwcXTanFX1CGzemgMBkV/WsgyDaguthsN8YO0bJZpOHVZSGy/Ye3Op7wy96tV9ShRo/+CVJ4ffVuEg7/XpswpyduirHBnHVF82K/vKrfWaZvxX/Es792+LUqHJh4228o1BJNCb2zKjAFXBe63lVOs3O+KrB786Gpm1OxtURbb7Wb7WOx2i7CzaK958+zm1e1a/k9xv7yvwiwHRHYbTveN39JZdktd2X8rqjDw7q4a9N9uN/unZTBVVj44yPMXYeE7WnpgCMqbvWQO9XUx4bzEM3SZGWCuS7kNhnLttWV+RFsIuPFK4W71z932F8kzX1Bd8GJ9vyyLx3AW469rZeacqyluuX7cr8plQ546IVIf6/DMNZErt5kHxAr2g5c6z4beVRi+LFchfve9UV4x5eOqWFcIMezcvt8WeX477BbVuajnZZHby2ZV3vi3fLvebIv7/dNqebcoi8heH78KZvIMcrmu10Qufh+G2P334PZZSJX3Qg4FJ9Z0/o6WNkDX7gjLROKumvSazu8Bpg0cOoKYOVAdqgqKtn7ohOWt0+pHw10zPkVkmRumlrvDGoxsE2G+f+dt9Fi3YeRMk9t5Pjloqz98sMy3tHMhN7qphc18DYpMDe660zTtqXCeq8Fqx1ZBptDBLDVTV9TnMn/jAncWx92GVSlappsp8H73y7aG/h+2yzIczrkfcLGZvfOX3Wbtflwt/xa+EuEHljLnRlWBT4sw2FWdOvLmAnke2BVUbup10rZ4WKzvNw8P5D1xfxltW1iUuRhbLW6LEKfOvaaKlvO4iLts90DOW1jhuEG7Jdftazc676WuFuu3+8XbQzSOuHKf7rqAF8/cAbNapJbD/jvJbeiuRE7LH24y48arajdBudmXT/uw23lltfvfM1vn5rzh+/R32GRC+7ak5o3cL8pFDIMyP/jEMuMUpPzwjfvhGuYwFZ+dVnK7AeTuXfG4COvxO3dmsI8U3wnfMD98w9xMgbNMc8XjDPN3tXHH0LhjaIK3O3paIpTZ+Q/1rTc02DFXvhNwE57MJdLjYtmdylp/cu9YmMjcH1OV1kyRnzd9hZ0mgPGZzSzW+4R5zP0iMzfNVEXWE/v7olwsV7vluml12FZ/Q0Wmh+wWvNvfdpcLflfP3HnVlkwMwJvbiExkVRVVTQDCgrz3LjKXwa6gatNt2BF855gZMXOFVQ5ssVwv12+r+xcEa/lRBp4ZO+qWjF6KvzbmmcG4qpBq9b9ZF4edOeE61odAmQunx6JcVH489Fb+FM/NyVjmCv5xc798WBZbAEDCNYdn79LNwnXLqjOZjqvtsL4Ja+B+DW7HRXvsRmQqPbHC9/fMcsfCZKabfdyXxa/BYpz53jW/jMdFEL0RntiZcbZ18eHtPlyPa28aNM97F2sSFaiO9XvT2zyDrAopN3C2LAME4CIEmciiKbdnyuyH5hzRtJmTwPVm/X6xWt4vKqCY2k3gHwDJpFrrKsRN92P4G/xY5lRivQkl9re8andGxvI8f9ydH/hviLktLjyzPzSB2C608duYGXQH7zagXA612sxdvk15NEKufL6aN1FsCjpE3YOyfJKa11OasmqLDkryO12ei4ufwQjAkTuS7fZtscyzZXXx2+J2v1yRNYjnPdu9cplFFuFai82NP6FozxVnqhLszvHH5/bEcF5pWzoP9WMv3HFy0W4UzIyL1eUW989RrcMMg1bmh7cy6eah6M40zR8FeGboZLO9X64XK3Bkwn9HLNPJdJfC/rYpmfd+nxb3ZMPSPCDBeUp6WlRbOLbhRnx/qsRzW1NWJ4tCRfszCbcBhLfbX0X7hztQ2u4WMe3qzu2/UHlmemhG7FxsEHBwDXK7OYXb6ClkGzZ1EWp3skS7s8a6PR/t4LNxERubCZeeVouyGhk6m6mYHxhhKs/fBaXV5zXCIv0IgMrrm0GR1Q474t8DupH5fvwi3y3W9yvS0YNDhplbvFyh9VIi9Hf+C8+Me7jS6Hk77m9lkCZThfH9X/5Llm1ak/ZsfW7/DSqgq0juv3bZpk5oj+vzvMEurAR3Lu6PfLLdcv3cTU6RZxc/keCvtNyuadVu3s6kxKS2eIiE+3scVGYoh5TeRdL+3gvpxnfVbuvIPNXpqilTp+j9IxyyzSPR5n/IXAc/bTePS2JiXg/LLQP6Zj+a6PaNc+d3hdufL9yIIHR7DqI90eAC920Uz03X5bw9kuA8Om8PF7THBNwLcOF+rdoov9v9Pmv31bf74d1e93b+nYl3wOTRP8nsjmdkxjzIniPmR/z5rGUJTq+s3YLYnm5xB1ZcYhThBjbh5rHC5RkQTp3SvRbpDsdIN6xKp2DpVCXd8la2p//dG1OttKJ1hO0RjfYwp7u5TXriDppo3m4Aa3NTuEvtwQXXVOOaatwRBMNaiON237otssa0o3t7cMFtVHTlWKcom3lac1s8FNtifYfmpj59b3MUZVtU5QeqsPG2WOxCB+ANq3kj9bZ43Lyv/UmxLqtAA9kl62/JcTq2mUPsYetdN9mWP4HNPAK2Lf6+X24pCPL3gLijRqI9suTet2wTF7mTJsrxPN2agjvtZdrTw5mMalvsNqv3xT1YiPl7iJqn28wdR5VdbjpYxt/JnlfUfr1YraKJTPwXnbm9BAEoP67T5mlqU7dlrumbw377bUGjcoz709vMuWhbWtsfwyL9ASlzydkWuStWxV2HH/rHblkmummLrPZ6L9Z378jZeD8yyjJPy0T38THurzwybbHZ8Vpubm9v7+7u3r9/H+w79AvMPEm7Kxbbu3dlsaV72vw5X+Z+0MipL19pmTFzNIf3bUS2R/Zaj5G5pzs2efenA9IdWdRt8q7MCHZ61u7n/pDPCdRan3eUBInpuo9x3KFL1eb9ylyQ5szTPUegMwOYiQm6v0Zr5x9tlrLMyO3u3WZb1sUEXc0f7DLDUOkdlP5i181bZGY0frdahv7PZ8KMZ3aRp1V4ks8fh1lmdqlOOIr5Z8VZ5umyupTOSTx/ww/LpHH1uqrbN/2FdTtpcLEtm5nnodlasSrWb8mJQX84Y7kSV2Vh9umLbdu1Ve77qHeX4IJ9794m/cx90W7CEcSU/P6b2Sn2t92dgf6uDsbzJgTlsiT7FH0awpzb4s47qjaZZCavKzedA53+5gOWue273GxW5TLwVGzuTS1E5moepcCwwRK0XbnlLUKrwzq7Gnat75sDrM1x067U/kQoM+VarPBYFX4XyoxztVX4KdAWD2WxdRSUDGs+AmkDC8dV5Q+Zqar8TSptAtbjqnqoEEbDHm6r/DsFrsp3t22K17yuWO46azo/uyJ3uI23GQvbTRKmjfS7MHpmSrhOjT4sZC6Ww13gnrszcpy3f7Qe0f3hTu5zlxqBt4mDZ214pM1E7C61wSr3uHCPC3dSVbhwkXBrZuFGauGgh7BtmKVN7NFSNbeEbdmiC7BKV6l0lUrVxltcOW1uDNYufNstJG2C3TZVrqMxTkDtAhJat6DGzUpNGyprk8y2CWTbxK9tUKXN3NpmHGoHTveLk8Jmzg336/qE6aKsD12jqa4/6ZdtAkPZBg3zhuz9erlZl5v60MEOrPGCA4+ZKG+/Xv59X4BDPP4CIPMcpr+QD2dR/lwsc+NKJ3FqWGKQQiLPGXVKXC13YfIHz6dmQpZ47MJzmpkrmSYZbSwFJg+IputUeQXvim33sLy/PUq1OWjaTpB50qItO7r+8qMEqu3YbQrkzMV0W0+kh/kUW/O2k+cK8cvdu+qwLwmJ+wcdXFDOZq7sqjKbCKY7Ox8O3/4GlczDbKlDGeExyLw5x2EMjpucvwekDY4fVXTUKvz9qi0bPKro7k4GP8blvHrmSN6cke/kOfX81jzPydQFdbKc+jPtzG2vbmtd+Jb9LXuZbsUVhDZx+WdaMj2eK67c9Fm4v52r3TOfGZf6EE6r/M1DF/9Ux4dFGGnwd5qzWZ53qMp42Gzv99uO4vzt5SzzPMZh+3J3SeUj0syVolcW2dHgb4RqdyO2H5/IOUb419evnpZPxWq5Ll598uav//zn/wVxZAq8iRYEAA=="; \ No newline at end of file +window.searchData = "data:application/octet-stream;base64,H4sIAAAAAAAAA+29XZfjtpXv/VWe1Z5zNe2K8A75znHsGZ9JYi/b8axntXO81CVWtxyVVJGotj1Z+e5nkRRYwOYfICSRlCo+uUiXRRLA3tjYAPYPL/94tdv+vH/1yZt/vPrbarN89Qnj9vWrzeKxePXJq0/3v27uv1/sVou36+LV61eH3frVJ6/u14v9vtj/Lnh69758XL967R6++uTVq3++dmkqxts077ebfbk73JfbXUaKH4Wve6m/fvW02BWbslPM52y55kzKNuen3fZxtc+R46PnVy/K8f1i/21RlutimZNp8PaJ+c7kc63tiv12/aH4bvv9Yn3IErfzxUW5/1Tcl/+9Kt9/Uyz2201e/p1vTiuBb7SfbdfrBbIu92AQUw0Sy7LStlwRxd1vH6t3e3Nyb52Xy7Gql189lavtZt+TW/ft7Fz9KvnDoiy+Wz0WX2x3j4uyk2f4eJDqAUlmVRIpaUSJD9lyfNS+enl+3yw277rmEc/UvT9Qzt9tv17syq7F9BTg+bPLy3F6EYbJva/RoPxzm060BEED2t4fHotN+dn28e1qUwB7Jy8M04hQotFmVO6XH6/2Hz/ttmVxX9ad2LOQtPyemDP+3GG+XewL925mccgnw5bnfrspd6u3h0i1x/QTfDNsidaLstiXXx3Kp0Ouhsgnw5ZnG2sSsChb0BgGKcXmD6vlN8Xbw2rdHWpFihJ+Emmc8fwDB3F4Wi7K4venWy/88LKyLJbLr3Z/qdP9zDPFzALFv76sVMtiXZxVIPjhEGX5dL3+7IzmHf34sjLtTjLe3UB2W+4Wm33VU/oW+OlDWey+X6xXy8UJ9ZSZ1MXtHpffr4wLy59Oatjyf2iSPsdzRD4dp3xntNvIp+OU76T+sPPRSDb5xWqzWDeZ/L542O6K820yndTlfak31PzToSx+6ZSv/jU5qOyk8afFE07mT4unQYanQWJZs7u2XJGqe1d0bSjMpXkjO3VfKX/eblytbd71DuiTbw+ivv4csnSaFisaGtviFptRqG232Z5Tnvx5R0aZsich/9/xh9XmfbFbkRZ6VtHTU5S8Ss6crwxf+ORsJqPs2VOb4Ysem/jkWHDGLGiEAqfmSDmljk2YhijpqbOpjPL2TK0GL3XuvCuj6DmTsMHLnzFDyyh6z3RtpFL3zuWyS56c2A1e+tisL6O4aAo4ePnOmh9mFP7iyeIg7vHyqeQpop47rxxe1KxZZ4ZoJ09BxxPlUrd18mx1PFHOHw2dMLEdsf2cMu09pf2cOwceZiTlT+QOj2+LXYRl+g+HmabRBPNmZX4ZT6OY3Qx7GGZ+XphgxjJM88sTc42hw2TmffQwvwynZj9Ezn3Uspt3LrOM5O43kq/Xi7IS5fMPxab8/HFVliDIgV4apNFEE85qPLDskVnV/vB2f79bve2adbwM/jdnlYDEUooPqAOP5+/ePy/vYPS92j9twZKqeN7PX1yee/G4Okns5vVh8v2i25mlc/4iP1J7Slmq9Hbln7flHxrFducS8WKhb4cv4bHGT1KY/80gJfJd0182bQPc1QvK/rjad+0IvjWIc4qnnOWdcPEj7ungvdztARIloR+eVxYaIDmlBM3rA+S7O2w+Xa//cq4m8OfnlUs/18y7ovzs/eKpLHb7L7a732+3f2sL9XDY3Ncd8O+6LyUt0Et++/CwL8pIss8PT0vuWJZoisfnpyX6fbHzehCaZP00maB4bnVffPnNt9/9+O1n3/z4+6+++q8f//yXP7XpfjguGt3/rvtSbvJ//LQ/9c47p5f9s//89OvvPv+mt/jee6dn8v3n33z7eW8W7Vu5VfquKP+4vV+sV/9T/Ffx6xfb3bf3u+16/R+77eHpyyW28MQH52W7p8nsezPufpKr0mXxsDisy2/vd98UD0CZwfNceRbv3u2Kd4uywF7rWQr84kXZ1H4rO6/m7VxlOZP97v//+nOgK/9xbpKNiUYSfH6Yq5JN8fN/HFbIUo9PchNa7b8td6vNO5CSe5Sb1LIonj5bbzfIS7bP8hN7uz1s7nFazaPsVlc1ld//ihpX8+SE5vv5brfd/anY7xfvUNHIG7kJ/7zwZgjPqVU/n5LEF9vdHw67MIQVpua9cYLQn67XX72ttj58cUzsz4vHIuKs8Lu5md3vikVZfPvr5v7r3faXys/WDbdJEWSYfD8702avQuP6kFjhC7nJNhES4nCfE/Ufn9F/LL9cfrHbPlaDoybMke47Oq/nZrmvC/jd9ve///1nn332/fffg3w672Q7dlSnPQFJv+LeL3afQrOoH+TX/7L4ervalDit56e5CRab5b7aJQRSc4+yk9rfL56Kxg9/U7wrfnlCiXZeOs1Gvyme1ov7ooopRzuDyJsXZvTd9tPdboFcc/qD7N5tc78+LKGvco/yk1oWv3yFWvLxSX6P6w3oYLfrPc9NdL3Yl19GS+g9zW73tbr/WGzeQTv2H2ePWaoqreRCoxb3LDexp8Xy8w0a/zQPTkjm23KxQw3fPcrW2HoFhyv179mJPK3hUKD+Pb/uqqB8xAM9P8xO7vB2H3ML7bPcxMpoiy9Pa9rb3bIibZ+R7YjexDx4Ibt8juN9ull+vtkfdsU3xbvPf3lq/j9a9v6vLi3AqVmflGk1PP/874fFOjJ0r5+dMKU4vN0XyIzdo2zTK3armMton+ULmUrOe3qCoMdPgo3ngbjeC7nJVq99vqnGHSDJ54cnDBo/O+yqyF/dr0SmLcErp/Xqv/+1hD2s9zR/5FQZcMzUvafJBPlsbph6nnv/oSieKk658uy7/PWpWs/+/OSkFI/jku9+fSpIit6Tk1L8y2a13Xy3/XJTBVGL+2AO16QM3kjnoPSzBggAW1WJPCzuKxU0j9KL5v1YPYVpkbR6EZorEy7xV9UyzkSx/ef5Zd+emupH5AssSlBYLM9ni81mW/7n4kPRJxl+c5D6SSTdW10RAc5UdKokWSrvLQ5tYJ8tNlHtNw0MvHFSEw7Y3n8uNsu1NytvskCvpH2jUuLZiH78sex6nGiaH7WvZ7BkV95M8VJlGFSg0yXJFaGOFKWyrl8YVJjnFE+SqCkp9itVROfLzcMWNTL3LN937N9vd2UVsetN7iP/VSxDW7RIZg+H9TqMJEYz8189L7P7I5/sz8t7Mzsrv0a+vd+tnsp6HP5Q7Ao/hu3l2X0rv5beNlG8E5L96PkTLBModFqRJ+YffHVpET5UA6ATC+B9c0b21JFgXNi0+HwyCFJtivBnf+zfpvr87LxUvy3WcGDZfeFSpxdJsc/pgZLG/FQQs8nJ9M59kpv13bGwkRIUG1DvqfybD87PPVqt3xW/lJ9u7t9v6WADvHHilOSZn3bmIs+PLjWWTlp9ZhKUK6/4qK/vPB9SkPyevlvMxESWrPymS2aPk1r81qXipZLtEzJW8Fgfs3361X1yinSurdHvTypUT8Nfvdtsd8UfDk/r1f2iLL7ebZ+KXbkqzilnKq0Ly0xN53/vtxv38R9Xf6OVSx9nRxb+uNi8OyzeHekTHF6RV/KTduyy+fAPi3IB98/4WaU/yR9iPRblYrkoF+dm8pGXAK7JPukiBVuHn2GF5xQQJHRpQZNO5NLy3fW4mL5EO/LG2wpJKjyfsmkv6JVsw26++VPCxMI38s32YbFev13c/80ni+lkPwo/iYxPwgJHMt9sSzyXQ9m6l0/MsKvGfb8e91mK9BZrUVtxnvHb+/fF43NGzwu40h+c3/OelENfJ9wjVaRW/21/gdCuo/uxTeScovX0yOWqXF+msjuXxAilWxb7ehzu91hnldFL6GMzkiYvtb276v8+tuOU7qk71DqrjM/pfMwGK+ngzTgo5jG/j5m8rMBeotkjnwELf9c7KjpViutVRCtL+9OFjbIr1bO6Yr55B9dyjyHb3Y+74uFjMZqIPW0/OuwdUursIfELstLIMPpjpgavysQIe+Be5mRZm35p+AYam6REJF8sl6uq/16sQdhgIk2gMnzMr6CZG2gCEWW0L+ip1AILMrnXv0BRTfcwmRnB8vQ0vn9b+qv7z5vGHJO41SFjXb62Ui6sjEZfsf44EvYboNh33bQvFmN65VMp3INLm4gvTkdTY09BM0W8CzMcS9zRJ7O54l4QdRlAzqdFdYjAZqgRRa7QKNvpNHC15tuV2z26dG6UoQCg9IhR/J//9eaHH37+4YePf/jh7q///r/+7dq6ufvxxx9//PnH4/+uoamXYUOhntzPl0Z9LlHYXceURhuWjqa+enR6SzqcfJ6Yq9pIzlfq2kgGIYgbRA84gxc53kRE8vj00lhPWIVIZ1OPPFPCBqRkkFlQSvTJR6FJ0Yeb+V0g8z4CZocQv5v2S2ysRIr2waA1R1U1cRuNyhi0z0tDbCmJp26acYnrf68o6rhzxLjcnXyH9U29SrheQ0ait08HDQLhItzIVPFM/YTj+CmM5iYmjANpq30yaEjiRL1db944uBYbuHFNI7y5CWRcx5AUTev1wWB0xLHov8RQlFbkpagcVNh1x6EdAYNR6AiO8rqD0K64wwcCTpJzqMV7mdI+jRK96pP4Wo21C84vXYOZIXfGWkK0HH1iNdzlrG8fQSW3bRy+VtyP8yuoJ6idG+kXctUVdCCDEpozlHcrvUy28srBkenwWjuOxm9LccdCjTGkHtTi9t/dns3VZbp1zYXbqKZWXHpf1m+vo6z10X46u4bpNFVyw70j0VHQMY4/44hp7Ja7RKqxcvBVHkOqymU/9DA+TPclBk88CdyPg1IeX0NXQuy+aEHLHnYlaye3yYF6IGg5/FrdbAnHGHZCIZ8zukY9Dj9AxDXp8plGxthZAr7vLIMjBPpO+e6ePXo8n2r5ZVk8kkTDhyel+9VuWexgot6TSw+RoUn17Vn3CxU7arJ6JS+bO/dub2b9FXt8+fNfymKzX71d13fyLur7WGFZwIsnVc+fis2hKll1izHJwX90VprHEq027749vH0sNodIBp33Lszts+3j46JzkFb0vZNzqw9h+0NRLlbr/Zebz7brwyM9/Cz22oV5fXt4+yesR/jeybk1haxOcf/PYtG1f/TKSXnUpazKt9q8qyy2SgoIFHvtUjeRTLfPZ0TL3i/unw7rctUrLXlrKGFRsrmy0oInzsGtX9o/2wU9uKr7wqUCRlLskw2UNHYm1/7Zu56U9x35Mrcg/d1DT8MZusGc1VASDSRQb31NFjWTVI537Rd5GfcMFVdl8XhS9u6Dc3PveNykWxjYHZzjBuLNn5yrVxtyfoZ3z19kZdxTkdCQUtn32NFpuSMzSmWetqLevKkR/Xfx9vtV8TMwIO/JpcZDk+ozHL9QMbU1FyX9obkgkiowkuFd96veAvRNGLdPGbprDyJq37403/vtpix+KU/IO/zijPwTppPQ/8X9dCetE6wndZ6eO8wclT94dqkA3cRyz1mnIoRHIi1WyO9Hc7vzPsjItsf+fo5XfrwE5KPLS3G8H/ZY459F20S8SKkUhi7fd9BX5Jbtux7f0VOu6HGSsTMkc48lrGbc5NC+bvis+9IQxw9GUu1rXqDEJx7il8645+A+8PFZweW+QtTB4jgbPLkYycVyPYXxznaJs7ecEg1iGUFxXFBWxFeXRguWc3IdddMXFrLfjeeUdlrFtmV2P8kzzBId0+ZUcRaFGkqUkD/FF6ydI1lPk4zsUhhMsmaLQXxpyggipbvMS2U8rUu9wZYEBWifD2N8WEkTtrEeIcMGF19TfLHMU7a+PpmbpjiM3zxH2P6h9rAayBmK33z79IRo3xnDXn1lXa2dQmHDtnrZEKtX9uu1Vyx73WbH8Mn5MsN5+qWyZ83jb7Bx+uVuRznDjG5+xkGn0ZsgFincRjZMpwFyGnbCepqE9b9smMZ1gmg5ZxYMKmd3d3B8AdhwMl+hGSJJ26ejyXzCiQTHvc5//fcffrhr/0YHE0ynlTt/c3jzx3jmMeBhBFfWUPs4vtVnLF3dxcxoijHLCAo8zkumN7qYInv8d+YZBIPqFx4+EF9XP1LPtSv+fljtvHh/trTuy8TOuJODycPUA9TsgKWMnc7dU6z0idzThbkzT96OG1z6tO3kBoyTipa16aKnmNMoES3nTtyxklfmy3dUDCBDeEDhOXOGYfdODCFSmT50YHBR4pskhpCmb2fE4OLs8KL+c6XqJHfL7TwsbNvJn0EvQ+0TJUzQ2mOShKG5gQWbos1HBRvIK58k0VBNPypU/xb7McS6jy/MPldCmOQtu4Jugd2zc6Y9QV0AXUzgERICZd2ScbZwU3iFlHD1Pxd7upPlGiBoeIKQ+XdgDCjv1A3vnBsvLhX3CrHCQRQCQjgT6uimbQWopg3cTK+jU4ODU/UJ5+kv88T7ybV57U7oTG1O7twuU+Mlq0XHV2bGSYw3oNAX4ijBYTLjjbHOVWvGUt314m2xfiH6vXOFvVkt/0uZc6Nu958XRxYm0PvRQF7myKG/BjIPSr61+ujpNM+jvTdRH8nLzF5YNbgI+Z8jhx7eZn2QQt96TfyrdAy+2t3PFyOnSVpCYDD/Qh0FrJHMg5FvtX5e6KT1hPopL1qkcKsVE54DduM1kz6I7HZq4F+k66jV7f7znJXMk1t+YyD/Ol1FWAOZRwTfWn38C3UNpD7KkRjrdSoCngd24xWSdRLZ7dTDv0jH4Gvd/Ro/wfl21B+ay79ONwHrI/PY6RutnX+hTgPXTnnaCTAvoVLOX8E/fsV4ZbstlY+7AWF8xUbK+TKUPBUEft78MV4A4apjC0/A9ouLl+gnzKCXlU43mIWiB25z1KjRTQ0xc3TRPphSK7c18jtNTcFAbsxh9m0PyE5UWtM93ai2Ht2R9pf3O0FSt7xK/bmg7W8XYyhP+AnaNJIgXER4sUvrZDFqe4MCDdR5Z0sy/OJzKBa4xX5MESdrQkiw9unFQftOjtdfY366EtARAcNX/tVWlg+kkLarHb7p3+SC8sHVFnYFF0fcLtfi1bqQi7RYDkIbR9fedlN8dflauOHV58p129obJboFlQmP4JhunPZ4vJZrEOFewLZ0V8zWIgdR9VRb0bulD536xQt5SQaju2YiTPNkKimGc5FEjDrhYRpxzs75YT0UkcWLa4xYLxO19UCa9udBhkJeRpNtlckWsFm1PbhFTh/dPVni9peLQ229sk+3Y+QCLYT9xcWLtDKV0uPBBtm2cYlS6kP4prKQvr51u12Xq6cJ9fGc42/FORwlbn8ZJNCbrnqn5JtyDx09hO5hkFlullpuy0F01VI7iIvZ1lDq2BeL3f3774rd4+hDPk8rYa6/FVfhSd3+evH+1X5D8JV9Uy4D6iN0GxN4024pbsR1YPXU7mOCwVa+WobdonnC2MvP97c1IQklb59MMQafeqfiAFoJXcoEXe/k2wWHUFI5zEqlYbVT3+88oXpcfr8VT1LL2/730FE5UPmNgm/KbxAdhN5igpm8n/+NDD2oSupBx1TW0aOKYbbx5uuizu83Nbw4Stz+MkGPOdlu1gu0EDqGCSZuk20pvUQpTRIjco9TtDHYthygkfbqjaFljQlz2BQfFuvDoiyWA68cIJLFMppCyNrj7z/d1AdgXy5dJ7lbXkAQFrb9/WL7IkqYwKvGJAlc5sUeE+YyqmOMylX/O61AA7L5qFie1x/YCq/cpALJ2p8vHtHC7DKY/bthNkScKO1dm+2oQt9mVR/fb3+4eGKXqQan9Gt64UyNBN764sj7afqZYv57sX6aC/ZuSjGrEYZN/ZpZDTC6eql+ZBW8dnHIPdcaVlcfy+XpI3AiF1P/k7Rz1RFhpnbqfy8OqAyplit6EE8v9X9P51sjirlFB+NU0/5yFetJ+5+rdM+9emr663EmMlnq6ml5h83q74dijMDH6coLy3IzzmmwgF5UP21YbxzfE113tdq8Wxef1XvuqyuDLxYQJHjLsS9aXPdEXOzdOoqYYMwUlyY8mmxw4aYY8iSEa964eKp4olSL9XqAzTYJseoMLncIJ4o1Trw/ISbM8PL+8kSxHw/rcjWgI+ymd8t+kJS2rZ3L1x0QNUzBVmOyhE5waNGm8IFx0QYak58m0zAeMC6US39CkUainVERsfO7fJnHSUJXie6/2O6+2hT/Xbz9flX8PAjf7SR50x6wU2D3jA+yaYQoY6I1JjGJQlc4yPkjMKvR14tEBSyHiYueLNnAe5ej8nkT6kEWB/YJOXmjCyRsPeZ4pppzxOXmfn1YFn8oHhaHdTlhBT+Lf9ctw+jquF1joNponwyyOCpTL50qubZvP1VXYWdwTdVdvdc4WXXlMBR/RJ1tn4aZz56htue8f8s+6qiF9pdBFrDnGourghv1SR3dhL7oGqrqaU+DbYG4XFU1Vxpka+qwKrrfbsril/JqbifM/7fsejxNtL8OsoUk12D8qrhRFwR1FLqha6nsVl0RVlntjgbZjzK8qkY7/TCqOngK4nhja09wPpsbpngr+/GM9O3ms+2m3G3X6zrU+FNxX35blOVq865VRJXQ/ne979c6CSU5KffsbIfKr1yURUZu1WvpvNSzV//Tdrl6WBU7kFCb1WpTFruHxX2x/13i9WSWYWxpvSgftrvH7/z+5IRMPiIJYFNMSZYzMTulQOXlBUGVcrTXVJGOr+Qr/zjtOn73ZZtibiYfJRJIy++kiRSs+OXCgiUSuKhgTuDl0xeL+3K7+/XL5enaIh8PoqmzChT5+NQCUX+VdMUX+N3w098v9tQDdl/I9n3hp6BH9XQZe/cCYfa1H1i9PQRjRiRV8OaZ4u3/Izj8ISpa816+PwkPzMxJ9iP3CbY5WOwTBt1ZRQg/vLwgAJdklSP47qxioBqvRgDQuECZ6LsnGTRu7ue083gDP6dlZzXpy9pyRiO+qPX2Ntuh2+vJDXWIFnpm0xygTZ7XGHNaYd2kAkP2s3UP82ts2UTI+1P76PnNSOnbkkWz2q0+FPsvdtvHrOz8t/OzpE3pL/tihyY37e/Zjab9os/7wReT2QjuG5bvkcP5LpiOJ99PZpoZgevP4KP2W1xNaZFigZv9+RK3sYg2jTMK1seMViW8wzG/dC6F4cuWDhfml9AP8CWWOV5S1MXmV7g8Lr+QdQqpq8EuKV4dWLrMBo8pDFK2oZssidZdVMwmCJfoL3tnJ5cLcJfO5lLhJq+QlDxtHPUyyw9jpyn9jexszpE89wC4QRUxukc7SxONG4wvbp5SBeTLcJYxvEZc+i++ef9HcJbfEO44Upcnz6pGlzX3hophRD9vDdVYotf/jui8ckROLskdS/CsG+jHEv+6bRveHJ1YVzioFi64qmhaddylg0RjKeWFGEtwsUxqs9bIerrkCqTraiz3BoNJFHjeSpYrK7Dn3IZbUNxNGWDm+fa/dc8Wqql9EF/rOrah+Ub08uzsWYG5JyNPqM8X4fei+uw5aO529Hj1Eb6nzazDS3/rPhAdB5S4N2ZsS+ufM9xGS8Vq67sXYTrt9TTTxDFKYynSy/K6EYj0gqnBFZFxgvrLCR5+TQ1szN79615fMMlgCMmcezX6cCq4ajARqqD+9wZEf1qUZbHbTNuWPT2g/KdXyfX9QFcR7bPxYh6dzEB1ROzm/7z54Yeff/jh47/++w8/3LV//9vtKO3uxx9//PnH4/+aP66px5dmc0B97cP4QTLTKfIuZoBXGfgOqt16HHzDKu7pUTL3qI2p+UgRrt3VBp+Np5J/gZFy+/t4c+mrjoqf5QvHwuMFqfoa7bgrYjx5m0Uw49Vrj6BF9i7SAZSQk9nLa6q9UrVxiwEruV+V07bnfCXc5WxoGEEhfS0+cujlFBpJH4g5vS7CHIOtG4O7wmPqL6/Zd8Von40HSdObVSboqUM5w956PC7i5TpZ+03K3ZzhPV68KkPgx8im+AFE7yb98ponkcE9GHKuTtU0bbuMCRi0ySE9Ec5wqhhyVNzBh1anyTkOo45Km7EncwSJr9VYuwzy0l1TOYJncOPeU0OmVsrdyceQjKCtGzecqI7aV4Zcj5qrrXjN3Uh/cqYqw7HhpK22T7NTB38GV20TNLopa+2NM92awzz5eKTfoMOM6ah9ZfxxFzDBaM3dssPsV2XmBclXUOxt+8sMzTb+8qaMtUenyUPWrtYlZR2S9hv0k0g/7eMho0Qnd9NBjd2yf0yrMPPe54kVett+sUejjU+8GePMHD/ehj886dDI36A/RPppHw8J9U/uhl+MP0yrMPCHQy6avkiht+0PezR6PJTphehyfyzGWKcSRdJ/eRwICeKeJu6TOr22ocam9TBpWXPvYBlG9Kl9QY/sTeseclZ9htDuk8FPF6IJv9xmGmz0StypdH59XeMgoYh0uTcXXyhsj1VOVJUNqB0SSJ8i5DiYNiaqt6FzNBO+mTYaSNv+PLY1X+NAoNMU0Jz0MeiIskcRt24STiPtL2N7gxs5+OdSLYX9xJDTvVOU1uNhh95RdLHSei6uuqqybsPQArMacgvCS/dToWLaB9Or6IqH+AyksvDBFRz+9Y7tGUqDtSO7ac1db3Tt6c+/1fD/+TKolvbnK3SL0x/GM4ii+q7jnUBfPY1vjON3YqpzeY0+q+kJoY2zlRol/mJDad2d4HxIcN7V1VWGJ0jKsCcdIcZ/tYN0UkLX/44wQr2No3NSkncyHsM7XfPokhOFb/31kIuuY2U48Yic58Mzhj4e52wl+YeP/DzwuTj5WntBVtVRWPtoinbXcz4LMbBph5qD6rIZeU7h0U9SaU8vMPZxNylNw8vZJ+4L0Gh1BPlf8si0rbERZqHXGYU+SxSOPUfogPua30jrKjwJm6UUI9Rdj2jgVItvh29fyVxeXpOLi9N2NOMePPLtVdplhtjh/sRJlNDXdic4gqajheYki5uQ/+gGhj5vJkz25TVhr/ytFx4hHnmFo2WgZGEPOsLo7RqHyWBJm7Y3AqzIENGlHb0desAjdEAeL68ZxoRp63OMU586mrvO2U9xmcNedIyTcCN5T32wbUIF9Tx9jKvMThT9kLztfQBdxDJ4eY0ZSuIeyyGHxFhn0zbjHmnDS9OH5CWpjKdqwH3CN7chDTlTP0fq9ptxomY4+RfcbrvxPzmkB0b6ulKbRZKGLXYUd3U1xpkWvP53yGHG6QKPyjnT0ndRwije+ppU6mQFtE+HJCXxUtzUlSAXKAtcuTBoFOgUDb4oK4OKax8POQk8Q4XXvgZkPL0ex2lXNtEbvQMkrXaIRSfvOPBwdxQtvOyhbVtzo1TRtYaxz1KFg9dRGnRfcxwakiIpG0w6ylC1RzwEYIZua4k8Xl7TiwnT1ubIdOwK7bJX5BDDTKCAqZFMvwYaPHMDsruDZD7vfj7GcTo4m5fXrBPyuJfGODoJqe86J02lBA/a95BT5/7MY9rYbEe5xSKphSbPq8h+C+Zfye/+Y4wjZ+N515qf+qCwbFXcuSJMq5CeBrKv+orBl8d4ib48H9+W3v0kBl0a0+pm4oUxXanC8dgoQk4c6EdCDu6IcoUbaQczENHbZjro2v64oFdog4GU7c+D7j8kmWbsL14WD4vDetAxRr7od8+5T6CCWzYCp4l2ojXoKvlenbQVcX2Xnquf0PdP1IqIum6gc8hW1+BTu8HUtCx2qw/F/ovd9vFq2vJL8P9cUauN1n4GXXKcYzjPFXLDLgnoKQzkT+7FaYkm2+t5qdpqkjm5F89V1yjHiQCVtUeJDHpAQ+Zwf729X6xX/1P8V/HrkHKGyb682bRXfvfjkAsafPVM6+qQYIH7GhLxdDObatQExWyeXUW+4zKK0UU85nMlKcv9d5PUY53NlWRcDdofrF4mUFq10eIhIzerqfGQJ0Y4hBtUqIldny/UMe3JZBnBzfniPCc/Xe0M7tKC+nGpjymP4J17F8KUgHT4xVqssLQn+5xEyh+1H2F1REofm+3szxCurbP241OK0mdLq3J9nkru3KcDlibtUzPKFHjM+LDxrMLFwGdGsY7XF8Vn4WcVqG5lZ9rS8dPLSjNY8yL+6LyCNV6nb0v1MYWeXZgnF/kunf7Z4kyn9JQE7qXEmTn5siRVNZZjOEfWcPv0md4kW/TxvM9ZsjcuKx5gmERo8mXsaqaLdZC+mummm2lwCHDiRI7z6+uCO5mGli5skfF53oXCnjc7GlzYMr28eVwhk2suBhfVC9GPZsI300YDaduf45H2YeS+4E6miRRw5/KfSA23bhDBZTWpK+jG0swl9zFdSUdhDxFfrDauyvombhh6XktlNfKc0P2coqrbMLLAqMYYE79UDxUqpn0QD1aPZkwX38V0bZWFD+ILpKbQ4G37r6gGm13ot6y5642qPf15P0/v9W/Xl/lqaX8ee4455F1M11VU0/qu4PmHuItpcNV5eV1p9u59kjzX4lLRMw4tu+UAWvdQjjH63ktPKhtDyrAfHaHhXnpK2ShC1/9eU9icE8pGkRxlPKESrtieoycGjRIhmORUsqnVBA6AuormXoxdAYW1D+PLyydQ3UCnkN2UPuux5y0qtacvyDx6bBRdR/K+WrcYfDaCEl7k6LT9fYR56HVGos8ShePPEcI2fY1vpBUVnoTNIooR6q5HNHCU0dfDt6+cXF5Ck+uVo53XD1GR/VqbqF3mi30XZj2+CvpabuS4sVF14DK9uvShJ4icOHOpE0ueOXNbzbdb8PbZCKju/ANnhpUs7D1HiONfcBPTwJI2R/2NELPJENEdDXVsoYMI203zJTQzUmr3YJC5LNXIRO0rJlLQtgbxITin0eOhUQGHG86cJtnA/DMq39OgU9peGSdvdF3odfbukhxRM5jkanO/PiyL43dfbspi97C4n66en9VwlyjK+Pq5VeOIaqV9ZZD1hbn6iVfStX3/mcoLx2PTtMU+XU4WABlcmU3g5DYssjfWcjOOL1GU37Dji2mlfWXEcRAws2gl3aTj61de4PgGwakXq/JG/V6GLhu/dxsG2aNF5y6XT18s7svt7tcvl9cc7JFi/Ib9HdJI+3iQKMrJXWpQOTfp59JKC3zcGBGP01R4o/6tR4eNb7u+AWaO567s1yLF+A37NaSR9vEg+PjkLvP2/VpaaYFfG2TZ60UqvFG/1qPD4+Eut649V4zBTz6JJPwSmAYqunuauGv9hBqFypnIU6SlC88tH6RbTmQ4fpvukbZppYPMT88Q030y3AkmNMWX1NyCzTKJG9LPqJNJDyuJyBO2rEGCmCin0elhTLz630Gw6CliDYwOY8J5m9uGN8zrt7VAvvbn0Wx00kNHThO5OX5gmHFbj+g3W+1OB+0vo7Xqax8ucqleQp8+yFTpFDX1+MbB9mhcrKZ6E/CtqefKxhSYziCLwV+svwlV0T6YUCnXOChkICWFD6Z01Vc4GmQondUO6TZ1dYURracx7+cphn+365N8RbQ/T9mFTXjgxyCqadrUoKGUmzziI6as9nKk0eYOPWGkgTeLolRfUDipu7s1cQvj6RUz/dEdCbnCfm7ICPX0h3WkxKz/HXJUeOXjOVKydnIc1K9c5eiEE8Vtfesgy2ZjmZ94DMfzVv7BjuA4Wy3+4Qc/D3X2Rr6eXoLldFTUPhq1NfWcCEGMaKLh3aDaa0Z7o/rik5TY479HO1IjpVuU6WReHI0Qh5T4ZY0G21oZcgY38cjvWYZwvDdk99jXjIbm8p5MDYofsn56hAE77kc+B+PFH4BBjj8YBIUm9HS9Iy+ooOE+rnHF7muDYx5z0ZG72WV/XYmPeQx2pkWY3ktoil6JW485ZKRtyuMroCxhjzbkGGnSAyuwbE0bGjKcniGUO9Oiul19tGvtQOIvoTnFit/W2aAnxHSUNPE5MXEpw15t0PMnI5lOdpxkQuh65jrotTknCnvYF7tx2mUs5ZfQKGHZ3WM5yFATq2ei5tgjX3hJ7SAx/FSOozfEPnGbWzkGmbueI2f7zcDxIJzui2p/3ViWHMRbItVM3faQbGHLG9bRTM/P0qLW/w7S0Z8u4jgMLS1vN7w9rGe9Cg05WeT26SDx+nj2t3Gk/QXqAceJDxP7OEVnL8OSoKrax4NMoM5Q2tWOsR9Pk8eR0rXM8NbOsE8rGiK36Vw+HmIOK/dLG062tTNsNUw+dHyWIxwwDtsw+5rVYAAOydUguGGHhz0CISgwWJtJJP4SmlCs+G2NjUVlpmxfvUKGaGBMkSfDBP0yN8jgmtK6Qyc+734+6GEbOP2X0DwTEriXBj08BWlq4tNlUqIG7XSQiWZ/rjH5N9thz2RPyt1kNq20VzXqSmL3H4Me7RjPtFbyZAcAZQt/5/KeSAU9Zr+v/PpwyyS81F6CP27L634SwyyRaNUw1QKJrhzhGGhYsaYKTCOxhnMhueIMvbsSCOVtjxtmfXRctCnbUiBX+/Mwe6pIbhl7H5fFw+KwHqaXzxf27jnbMYW+yYp2sreTlGHWHfdqodX5Fd1vrkZCPz122yAKuqYjz1bQcNOiwRSzLHarD8X+i932cXr9+Fn/Fl1KK39rI8Ms/swxjmfd36JrAZoJA8/T+V9alPF3rF2qqJqZTed/cxU07EEEQEntIQTDbALPHFSvt/eL9ep/iv8qfh1EsjC9lzD39ErsfhwEgfuamMhJIVECxzMIdujmMvq4BQrWPJtWoiNqH0+oYwZTy1Xuvxu3rur0p5ZqNYy3Xr0UrLFqY52DRC9Wk0EKr+DhQGkYMaZyU74Yx0THL/2QLskX4DndCWpgOPcT1IFLdhQJuHpuxF/+Zf/TN8ViWez+e7cqi10ryqq9fel39J1airBwXuIzaf2VFrvFffld8UuZnfBH4UdYA51i9xfg90X5c1Fsvt6uNuX+rNLQFC4r2sNqs/xz8Uv5x+39ovIZXz38aVHev19t3p2mrt50Li/mt6vNu3Xx/WJ9KE4rV/jh5QX5uvnopDK031yW/U/77ebrRfn+u+33xW5ffFM8fLpZfvXwsC9OKE86kcsKuNkui++2//uYQ36ZOt8NUYwLdBRP4LKC7YrH7Yd6u06xKf+8XRYnOAH47WXFOex/+uz9YvPOm5j3FiP45rLsPxz1+932L/ufjoI5D5JfoJ5Uziji3DDF21Imylb1afvfdV9Idk7JAWwyxY/al7FQoKTRdSLL0/K8O36Rm3HPkGUbtsesEmzTTfDkMvxEvVRWKX7q81E55aAm5hzNV0gt4cNLTQuk1mdWpHQRdbpmmJ3fnfdFTsbnmFQi9x5z6s2bW99DwOHrMeXfnTJ0VezZLO63m325O1Q3WmWl+VH4QdQ+z+wakllndAsXDvaS2ecO9M4f5/Vm3zPGu2wElcw9c/Q00OApoyj5A6cBB77Jcp0z6B1yFJMs3FkjmGFneL3Wfcbs7vTpcV5xcubmQ03NcwuSNy2/fJaQLM8JM4ROSf76+tVqsyx+efXJP2qLrkzvk1f8TtxVNPFhVayX+1efvGmK+PrV/fbxsfF2y2P859Vfj699X1T9T/Vy8/bvZq9ev5m91vJOmr/+9fUb9239e/2DS+L5l/o79ur1G/ZayjsrZPAh63zIgg/5q9dvOMiQd77jwXfi1es3AnwnOt+J4Dv56vUbCb6Tne9k8J169fqNAt+pzncq+E6/ev1Gg+905zsdfGdiCjWdD03woX31+o0BGdrOdzb4bv7q9Rv7Wqm7OQ++m3e+m4c1XxnCHGTIujbDiNHErQaYTWg3rDIHNnut5neCqfDjru2w0Hiqu8TfMAY/7hoQCy2IVYbBOPy4a0UsNCNWWQcT8OOuKbHQlpiO1BHrWhMLzYnV9oQMn3UNioUWxWy0mrpGxUKrqg5sesMUlLdrWSw0rerU0DdMo49517h4aFy8Ni4DP+5aFydeqbYuCz8Gnim0Ll5b1xx+3LUuHlpXdeniGw7tmneti4fWVV3R9IZDu+Zd6+KhdVUHir3h0K551754aF/VmbVvOLRr3jUwHhpYtVj8DZfw466F8dDCqhWMbzi0MN61MB5aWLU+6Q2HFia6FiZCC6t21b7h0MJE18JEaGGi7vighYmuhQnS+VU2w6GFCdABhhZWXZn4RkALE10LE6GFVfddvREMdbxdAxOhgVVX9L0RqLMXXfsSoX2JaH8ouuYlQvOqtli8EXCw0LUuEVpXtXb8jUB+U3SNS4TGJWexMsuubcnQtqoVhm8EGnDIrmnJ0LQkj/pc2TUtGZqWFFGfK7umJcngSkZ9rgQDrNC0pIr6XNm1LRnaVnWYR8Tnyq5xydC4pIn6XNm1Lhlal7RRnyu75iVD85LzqM+VXfuSoX2pWdTnqq6BqdDAFIv6XNW1MBVamOJRn6u6FqZCC1Mi6nNV18JUaGFKRn2u6lqYImN4FfW5CozjQwtTOupzVdfCVGhhykR9rupamAotTNX+C00iVNfAVGhgah7zQaprXyq0Lz2LDrF11750aF+aRYfYumtfOrQvzaNDbN21Lx3alxbRIbbu2pcO7UvLyBBbd61Lh9al664RTb1017g0mSXqWDVpMFEMbUvXtmVRvl3T0qFp6dq00OxNd01Lh6alK2uRs9dK3AlLCt21LR3alqmsRaJxhOmalglNy1TGItE4wnQty4SWZSpbkWgsYLqGZULDMpWpSDQWMF27MqFdmTrugPpz0zUsExqWUdFYQNewTGhYprIViXyH6RqWISGIylYkMmgDghChYZnKViQyStM1LBMalqkNCxml6dqVCe3KVqaiUATLdu3KhnZlK1NRyCZt165saFe2MhWFbNJ27cqGdmUrU1HIJm3XrmxoV7YyFYVs0nbtyoZ2ZeuYFrJJ27UrG9qVrUxFIbuyXbuyoV3ZylQUjFF17cqS6FZlKgrZlQUBrtCubGUqCtmV7dqVDe1qXpmKRnY179rVPLSreWUqGtnVvGtX89Cu5pWpaGRX865dzUO7mlemopFdzbt2NQ/tal6ZikZ2Ne/a1Ty0q3llKhrZ1bxrV/PQruZ1vBTZ1bxrV/PQruaVqWhkV/OuXc1Du5pXpqKRXc27djUnkdPKVDSyqzkIntLoaWUrBhlW8yj82vvt+HllLgbZVvOIfk6CqLPKYgwyr+YR/ZyEUWeV0RhkYc0j+jkJpM4quzEwKDkDkdQZCaXOKtMxyM6aR/RzEkydVdZjkKk1j+jnJKA6qwzIIGtrHtHPSUx1VsfpkcE1j+jnJKw6q8zI4LA7iKvOiNXVgXgLrQ6F7Ttx+8qMLLQ6GLknVldH4y20OhS7p8H7Oh5vodWh6D0N39cReQutDsXvaQC/jslbaHUogk9D+E0MH1odiuLTMH4dmrfQ6lAgn0by6+i8hVaHYvk0mF/H5y20OhTNJ+F8Vkfo59DqQDyfkYA+q2P0c2h1IKLPSEif1VH6ObQ6ENNnJKjP6jj9HFodiOozEtZndaR+Dq0OxPUZCeyzOlY/h1YHIvuMhPZZHa2fQ6sDsX1GgvusjtfPodWB6D4j4X1WR+zn0OpAfJ+RAD+rY/ZzaHUgws9IiJ+JJowBzQ4E+RmJ8rM6cM9m0O5AnJ+RQD8TDamEhgdC/YzE+lkdvmczaHkg2s9IuJ/VEXw2g6YHAv6MRPxZHcVnM2h7IOjPSNSf1ZF8NoPGBwL/jET+WRP6n0HrA8F/RqL/rI7osxk0PwAAGCEArI7qsxm0PwABGKEArMEADNofAAGMkAAmm0gatD8AAxihAazBAQzaH+ABjAABVsf4cZyHASTACBNgdZg/9j0C5sT+Gi5QBfS63BuAAUbIAGvQQOR7YH8EDrA63s8wOwd4gBE+wOqQf0x+YH8EEbA66h8rP7A/QgmYauwPtl/ACRgBBUw19gfbL0AFjLACphr7M6+ZvpOMJgAMkPACpprVGrABA2LACDJgNQWIFgBYIMEGTDUWCD0AAAeMkAOmdKoAwAQJPWA1EGAcuhDADxgBCKyGAoxDFwIYAiMQgTUUgUMXAjgCIyCBNSSBwy4MoARGWAJrYAKHTRDQBEZwAjvyBNgEAFBghCiwBilw2AQAU2AEKjDdLBmCXRgAC4yQBVbTgmoVO/oeGCChC6zBCxwaMAAMjBAGVlMDJqD9AcjACGVgNTmINQBAGhhBDaymBwyuO2AANjBCG1hNEBhce8AAcGCEOLCaIjC4hoAB6MAIdWA1SWBwHQED4IER8sCMSCgQ0AdG8AOrkQKDCwoYIBCMIAjWMIhYAYAJEg7BarbAIMVkAEUwwiKYMakCoDVsxAZryMAgn2OASTACJZhpTBC2QcAlGAETzDYmCNsgYBOMwAlWAwcm8YpHACgYIRSspg4MMjcGIAUjlILV5IFJvPARkApGUAWr8QOTePEjwBWM8ApmU0YImAUj0ILVIIJJuOqBAXDBCLlgtllGidczAnrBCL5gNZJgEq5+YABhMMIwWM0lmIQrIBjgGIyADFbDCSbhKggGYAYjNIPNG0OEhgyABiNEg81T40FANRjBGqxGFUzN0IAYkA1G0AarcQVTDI7IAd5ghG+wmllUewL57G4+pwkAOySQg9Xgginxmts7Yy1JANghIR2sphdMydfC3DFJSwDskOAONk/1yAB5MMI82Hye8AaAezACPvhsFi8BB+iDE/TBa5bBlHotZndzTRMAS3wJ/OAzHvdHHOAPTvAHnyV6ZQ4ACCcAhM9k3A44QCCcIBA+ayxRv5bsThlaArDkl0AQPktMTTjAIJxgED4zqVoAS38JCOE12WDKoNbIAQrhBIXw2TwlAlgCTGAIZ7N4z8oBDuEEh/BmH0OkBACIcAJEeLOZATsUDpAIJ0iENxsaIoYEoAgnUIQ3mxqUfS3F3ZxpkgCwRIJFOEv0zRyAEU7ACGeNT5y/FuyOW/Wa6dnxT5IWMEpCSThLDBY54CSccBLebHmIWDUgJZyQEn7c94AbJmAlnG59aPY+4KEKR7sf6PYHnjJKtAOiswUiZZRwFwQxSp4ySrQTgm6F4DI+VOFoNwTdDsFTRol2RNAtEVyndAAskW6L4CalA2CJdGsEt4mGiXZH0O0RPOUe0Q4Jwk94w0/6GyZgKZywFC5SRglgCicwhTcwJdIwAU3hhKbwhqZEGibAKZzgFN7gFDwF4ICncMJTuEgZJQAqnAAVLlJGCYgKJ0SFi5RRAqTCCVLhDVLBw08OmAonTIWLlFECqMIJVOENVMHzKA6oCidUhcuUJQKswglW4TLlHgFX4YSrcJlyjwCscAJWeLPbQrPXUnfbAiArnJAV3pAVzV/L+Z02giQALJGgFd6gFTwZ5YCtcMJWuEx11ACucAJXuLSpWgCWSOgKb+hKrBaAJRK8whu8osVrxe6EmocJAL7CCV/hKmWJALBwAli4SlkiACycABauUpYICAsnhIWrlCUCwsIJYeEqZYkAsXCCWHiDWGK1ACyRIBbeIBaNx1uAsXDCWHjDWOCyRw4YCyeMhauUSwSQhRPIwhvIojUIi3AAWTiBLLyBLHD9JAeQhRPIwhvIAtdQcgBZOIEsvIEscB0lB5CFE8jCG8gCl1JyAFk4gSy8gSxwLSUHkIUTyMIbyAIXU3IAWTiBLLyBLHA1JQeQhRPIwhvIApdTcsBYOGEsXKcMEEAWTiALbyALXJDJAWThBLJwk3KEgLJwQll4Q1kMHhQAzMIJZuEpzMIBZuEEs/AGsxiD2iDALJxgFt5gFoNnPACzcIJZuEnFcwBn4YSz8IazmDmUAO3kJlbYYBYLlztwwFk44Sy84SwWb2IHoIUT0MJtKrAISAsnpIU3pAWuT+UAtHACWngDWrAKAWjhBLTwBrREVAhACyeghTegxUJPAjgLJ5yFpzgLB5yFE87CG85iIzv6gRUSzsIbzmLxJAtwFk44C284i8WuAHAWTjgLbziLhS0ZYBZOMAufp6wQYBZOMAtvMAtcq8sBZuEEs/AUZuEAs3CCWXiDWSw+xwJwFk44C284C1YhwCycYBbeYJY5jssCzMIJZuENZpljVwIwCyeYhTeYBa4Z5oCycEJZeENZ4KJhDiALJ5CFz1NdMoAsnEAW0UAWjLoEgCyCQBZxhCxwaiAAZBEEsogGsuBQgQCQRRDIIlKQRQDIIghkEQ1kwXYsAGQRBLKIWcIdCgBZBIEsYpYI2AgAWQSBLCIFWQSALIJAFtFAFtwSBIAsgkAWkYIsAkAWQSCLaCBLRAcAsggCWQRL4D4BIIsgkEU0kAW7EwEgiyCQRbCUJQLIIghkEUfIEtEBsEQCWUQDWWI6AJZIIItoIAt0yQKAFUHAikiBFQHAiiBgRbBEvEYAsCIIWBEsEa8RAKwIAlZEA1ZwQF0AsCIIWBEpsCIAWBEErIgjWJm/FvbOqHkdUOfyjs9pWugcIGKTPGWTgLEIwlhEw1giJgUYiyCMRfAEghaAsQjCWETDWOYSHu4DGIsgjEUcGUukBMAoCWMRPIGgBWAsgjAWkWIsAjAWQY+hEokgokAnUdGjqFJgRaDTqOhxVCIRRBToRKrOkVSJIKKAp1IRSxSJIKJAJ1PRo6kasIJDeAIdT0XPpxKJybNAZ1TRQ6qOYCWiRGCJ9KSqI1iJKBFYIj2uqgErMSUCSyRgRTRgBcdQBAArgoAVkQIrAoAVQcCKSIEVAcCKIGBFpMCKAGBFELAiZGIxhABgRRCwImRqxAjAiiBgRUid10UAxiIIYxEpxiIAYxGEsYgUYxGAsQjCWESKsQjAWARhLKJhLJFJBGAsgjAWkWIsAjAWQRiLaBjLXMF2BRiLIIxFqFRHDRiLIIxFqNTgETAWQRiLUKnBI2AsgjAW0TCWOXYNgLEIwliESlkiYCyCMBahUpYIIIsgkEWolCUCyCIIZBEJyCIAZBEEsgidMkRAWQShLEKnvCPALIJgFqFT3hFwFkE4i9DxGLcAnEUQziJ0yjkC0CIIaBE6NZ0GpEUQ0iJ0Yv2DAKhFENQiGtQSGbIC1iIIaxE6sTxMANYiCGsRJuURAWwRBLaIFGwRALYIAlvEEbZAMwCsRRDWIlKsRQDWIghrESblEAFsEQS2iAa2RMwAwBZBYItoYAvcFy8AaxGEtYjUnhYBYIsgsEWYlD8EsEUQ2CJMyh8C2CIIbBE2NZsGsEUQ2CJsyg4BbRGEtgibOZsG5EUQ8iJsyiYBeRGEvAibskmAXgRBL8KmbBKgF0HQi2jQyxwfLAzQiyDoRdjUbBqgF0HQi2jQCzyvQQDyIgh5ETY1mQboRRD0IuapUCNAL4KgFzFPBb0BexGEvYiGvUQqAbAXQdiLOG5xwe4dsBdB2IuYJ/Y8CwBfBIEv4ghf8IAXwBdB4IuYpybTAL4IAl/EPDWZBvRFEPoi5olF3ALgF0Hwi6hpCocnhwhAXwShLzK1xUUC+iIJfZFH+gJVIAF9kYS+yFliuawE9EUS+iJrmMLh4ScSwBdJ4IucJexQAvgiCXyRs8ReKwngiyTwRR7hS0QF4GxoAl9kA1/wtEcC+CIJfJGzxF4rCeCLJPBFNvAlpgNwTjSBL/IIX6BDkwC+SAJfZM1SODzDRgL2Igl7kSwBoyVgL5KwF3nc4IJVANiLJOxFskScWwL2Igl7kQ17gTM/CdCLJOhFsoQ/lIC9SMJeJEv4QwnYiyTsRbJEcFEC9iIJe5ENe8HTHgnYiyTsRdYohc/QUSYSoBdJ0IvkjRnC+3sAeZGEvEieMkOAWyTBLZKnzBDgFklwi+SJHX8S4BZJcIs84hY4MpAAt0iCWyRP2SHALZLgFsnjK8QkoC2S0BbJU+4Q0BZJaIvkKXcIaIsktEUed7RgXwBoiyS0RTa0Ba/QkoC2SEJbpEgZIqAtktAWKVKGCGiLJLRFipQhAtoiCW2RDW2J6QAYIqEtMkVbJKAtktAWKRKrIiSgLZLQFlnDEw5PNpMAtkgCW6RI+UMAWyS9IOQIW/CdF+iSEHpLSAq2SHRTCL0qJAVbJLothF4XkoItEt0Y0rkypLnwSFcRhJmhOkC3hhBDrNlJpFNBF4fQm0Ma1oIXnEp0eQi9PSQFWCS6QITeIJICLBJdIkJvEUkBFokuEiGARTZXiUQqAQAWSQCLbK4TwZUA+IokfEU2N4rAQ/4kwCuS4BWZwisS4BVJ8IpM4RUJ8IokeEWqRORGArwiCV6RDV6J9OwAr0iCV2QKr0iAVyTBK7LBK3jZrgR4RRK8IlN7WCTAK5LgFakToRsJ+IokfEXqROhGAr4iCV+RDV/BK48l4CuS8BWpU5YI+IokfEXqlCUCwCIJYJE6AfokACySABbZABa8eFoCwCIJYJE6ZYkAsEgCWKROeUQAWCQBLPIIWCI6AJZIAIs8AhYYBpUAsEgCWKRpPCK6S0YCviIJX5Gm8YhwmA34iiR8Rda4hDN0So4EeEUSvCJrWsKrG3zA98AKCV2RNSzh8NhRCeCKJHBFmsQZORLQFUnoiqxhCYfnZkoAVySBK7JmJZxJ+D0wQcJWZI1KeHUPG/geWCBBK7ImJZzBgAMgK5KQFVmDEs4QoJMArEgCVmQNRziDBgxgiiQwRdrGAKEBA5YiCUuRNRrhHBowQCmSoBRZkxHOoQEDkiIJSZE1GOHV5Wzge2B/BKTIBqTgCLoEIEUSkCJtygkCkiIJSZENSYmMKABJkYSkyBqMcA6bEAApkoAUWXMRzmETAhxFEo4iayzCOWxCAKNIglFkTUU4h00IUBRJKIqcNyYImxCAKJJAFDlvTBA2IcBQJGEo8riBBZsQYCiSMBSZYigSMBRJGIqcJ056kIChSMJQZMNQOPQCgKFIwlBUjUS4QF5AAYSiCEJRNRHhAnkBBQiKIgRF1UCEC+QFFAAoigAU1QAUgZqQAgBFEYCiah7C4cmhCvATRfiJSm1eUYCfKMJP1JGf4AromqAi+EQd967ALUgK4BNF8ImaJdygAvhEEXyiahrChUI2rAA+UQSfqCM+gevDFcAniuATlTogTAF+ogg/UYxH+zIF8Iki+ESltq4ogE8UwScqtXVFAXyiCD5RNQ6JVQLgJ4rwE8Xi3bEC+EQRfKJSW1cUwCeK4BOV2rqiAD5RBJ+o1NYVBfCJIvhE8cSiLwX4iSL8RKW2rigAUBQBKIonlsEqAFAUASgqtV9FAYCiCEBRPGWIAKAoAlAUT8yOFQAoigAUlToTTAGAoghAUTxliYCgKEJQFE9ZIiAoihAUxROzYwUIiiIERYmUJQKCoghBUan9KgoQFEUIikodBKYAQVGEoKiGoODgvQIERRGCokR8fqIAQFEEoKjUOWAKABRFAIpKnQOmAEBRBKCo1DlgCgAURQCKEonD6RQgKIoQFJU6B0wBgqIIQVGyPZwuufpPAZiiCExRKZiiAExRBKYombJJAFMUgSlKJg6nUwCmKAJTVANT4JxdAZaiCEtRqY0rCsAURWCKkimbBDBFEZiimrvYI+MEAFMUgSmquY8dxt0UYCmKsBQlUyYJWIqit7KrRAxboYvZ6c3sR5YCYYxCl7PT29kbmAIjLwrdz04vaE/BFIXuaKeXtKdgikL3tHcualcpFQA7pJe1N7e1w+CfQte10/vaUyxFoSvb6Z3tqa0qCt3bTi9uT21VUejydsJSlE710YClKMJSVGqvigIsRRGWojSPRlAVQCmKoBSVQikKoBRFUIpKoRQFUIoiKEXp1KwFoBRFUIrSOhoEVoCkKEJSVIqkKEBSFCEpKkVSFCApipAUpVOzZ0BSFCEpysTj2AqAFEVAikrtVFGApChCUpRJrHFQAKUoglJUg1IiKgAsRRGWoo4sBcURFWApirAUlbp9RQGYoghMUSbVLQOYoghMUSbVLQOaoghNUQ1NgaFUBWiKIjRFmVS3DHCKIjhF2VS3DHiKIjxFNTwlogIAVBQBKqoBKjAarABQUQSoqNTuFAWIiiJERaV2pyiAVBRBKiq1O0UBpqIIU1E2scZBAaiiCFRRNuUPAVRRBKqo4+4UHMEAUEURqKJS21MUgCqKQBWV2p6iAFVRhKqoeeIkHAWwiiJYRc1TDhFwFUW4ipqnLBGAFUXAipqnLBGQFUXIipqnojgArSiCVtQ8ZYkArSiCVtQ8ZYkArSiCVlRqe4oCaEURtKLmieWHCrAVRdiKbtgKxGMasBVN2IqeJXpmDeCKJnBFzxKGqAFd0YSu6Fli9aEGeEUTvKJniaMeNOArmvAVneIrGvAVTfiKnuUd9aABa9GEtehZwiY1YC2asBY9S9ikBqxFE9aiZ4mNzRqwFk1Yi2azKDLWALVoglp0CrVogFo0QS06dReLBqxFE9aiWWK0qAFr0YS1aCajK380QC2aoBaduopFA9SiCWrRLDFa1IC1aMJadI1OItN3DViLJqxFMxsF/xqgFk1Qi2aJTloD1KIJatE80UlrgFo0QS2aJ4I4GqAWTVCL5jy69kID0qIJadEp0qIBadGEtOgUadGAtGhCWnSKtGhAWjQhLboGJ5idawBaNAEtOgVaNAAtmoAWnQItGoAWTUCLToEWDUCLJqBFi2b5A1yKqQFo0QS06BRo0QC0aAJadOpgMA1AiyagRacOBtMAtGgCWrRI9dGAtGhCWnSKtGhAWjQhLVpk9tEAumgCXbRIGSWALppAFy1SfTSALppAFy1SfTSALppAFy1n0TUxGoAWTUCLToEWDUCLJqBFp3ataABaNAEtWqb6aABaNAEt+ghaEPzTALRoAlp0CrRoAFo0AS06BVo0AC2agBYtU300AC2agBbdgBa4QFgD0KIJaNEp0KIBaNEEtOgUaNEAtGgCWnQDWgS8vkYD0KIJaNGpq+01IC2akBatUnYISIsmpEUrGV1epwFo0QS0aJWyQwBaNAEtWqXsEJAWTUiLVgkIrQFp0YS0aJVYoqgBadGEtOjUrhUNSIsmpEXr+BpFDUCLJqBFp0CLBqBFE9CiU4eCaUBaNCEtOnUomAakRRPSorWMLrPUALRoAlp06lAwDUCLJqBFpw4F04C0aEJatE7sJtWAtGhCWnTqUDANSIsmpEU3e1bwIbAakBZNSIs2ifNGNEAtmqAWbRLnjWiAWjRBLfqIWrAdAdSiCWrRzalg+PxSDVCLJqhFN6eC4ZukNGAtmrAW3exbEXBPrgasRRPWolNXsGjAWjRhLdokFm1rwFo0YS3aJA560AC2aAJbtEmcIqsBbNEEtugGtkRqAcAWTWCLPsIWdIiUBqxFE9aibapnBrBFE9iiG9gClz1rwFo0YS36yFrgsmcNWIsmrEXbxME3GrAWTViLbvavRMYWgLVowlr08SQwuOxZA9aiCWvRNnHSgwasRRPWou08uuxZA9SiCWrRqUtYNEAtmqAWPU85RIBaNEEtutnBEqkEgFo0QS36uIUFzrUAadGEtOjUQWAakBZNSItOXXavAWnRhLTo1GX3GpAWTUiLTl12rwFp0YS06NRl9xqQFk1Iiz6SFggNNSAtmpAWkzoJzADUYghqMamTwAxALYagFpM6CcwA1GIIajGzxIkjBqAWQ1CLSR0FZgBqMQS1mNRRYAagFkNQi0kdBWYAXzGEr5hZwhIN4CuG8BWTOgrMAL5iCF8xs0RA0QC+YghfMc1eFjxKNQCwGAJYTHMUGFz2bABfMYSvmNRRYAbwFUP4ikkdBWYAXzGErxiWOPrGAMBiCGAxx2tYYEDSAMBiCGAxqbPADAAshgAWczwLrC8gaQBrMYS1GJaySQBbDIEthqVsEsAWQ2CL4Ym99gbAFkNgi2lgC1z2bABrMYS1mNS5YAbAFkNgi0mdC2YAbDEEthgu4+MEA2CLIbDFcBVd9mwAazGEtZjUsWAGwBZDYIvhiVmLAbDFENhiuI0HJA2ALYbAFsPn0WXPBrAWQ1iLEalOGrAWQ1iLEalOGrAWQ1iLETyhAsBaDGEtRojosmcDUIshqMWIVB8NUIshqMWIVB8NUIshqMWIxGjRAL5iCF8xItVHA75iCF8xIuUPAV8xhK8YMY8uezYArxiCV4xM2SHgK4bwFSNTdgj4iiF8xcjErMUAvmIIXzENX4HLng3AK4bgFSNTdgj4iiF8xciUHQK+YghfMTIxezaArxjCV0zDV+CyZwPwiiF4xciUGQK+YghfMTJxTKIBfMUQvmKaQ8EiKgB8xRC+YlT8BBID8IoheMWk8IoBeMUQvGJUqlsGeMUQvGJUqlsGfMUQvmKajSxw2bMBeMUQvGJUqlsGeMUQvGJUqlsGeMUQvGJqWhJVAbBDgleMmkeXPRtAVwyhK0an3CHAK4bgFaNT7hDgFUPwitGJqLYBeMUQvGJ04jh3A/CKIXjF6JQ/BHzFEL5idOI4dwP4iiF8xeiUIQK+YghfMTpliICvGMJXjE6sezCArxjCV4xOOUTAVwzhKybFVwzgK4bwFZPiKwbwFUP4ijGpKA7gK4bwFWNSlgj4iiF8xZiUJQK+YghfMSaxKswAvmIIXzHHW1dwBAPwFUP4imn2ssBlzwbgFUPwijGpnhngFUPwijEpQwR4xRC8YmziPHcD8IoheMU0t65EIhiArxjCV0yKrxjAVwzhK+bIV3ojGIC1GMJajE3ZJGAthrAWY1M2CViLIazFHPe14AgGYC2GsBZjTXTZswGoxRDUYlKoxQDUYghqMTZlk4C1GMJazDw1WgSsxRDWYprDwuCyZwNQiyGoxaQuvDcAtRiCWsw8NVoErMUQ1mLmiaOMDWAthrAWczwvDE6bAGoxBLWY1J0rBqAWQ1CLSZ0XZgBqMQS1mHkqiANQiyGoxRzPC4MRDEBaDCEtNkVaLCAtlpAWmyItFpAWS0iLTZEWC0iLJaTFJo4MswC0WAJabAq0WABaLAEtNgVaLAAtloAWmwItFoAWS0CLnZn4smcLQIsloMWmQIsFoMUS0GJTd65YAFosAS02deeKBaDFEtBiWaKPtoC0WEJabIq0WEBaLCEtluX10RZAF0ugi2UpowTQxRLoYlmij7YAulgCXSxL9NEWQBdLoIttdrXAZc8WgBZLQItNgRYLQIsloMWylE0C0GIJaLE80UdbAFosAS32CFoQ/LMAtFgCWmwKtFgAWiwBLTYFWiwALZaAFssTfbQFoMUS0GIb0AKXPVsAWiwBLTYFWiwALZaAFpsCLRaAFktAi21AC172bAFosQS02NR19xaQFktIixUpOwSkxRLSYgWLLnu2ALRYAlps6v4VC0CLJaDFpu5fsYC0WEJabOr+FQtIiyWkxYrERUAWkBZLSItN3b9iAWmxhLRYYaLLni0ALZaAFpsCLRaAFktAixUpfwhIiyWkxcpUHw1IiyWkxcr46bIWgBZLQIuVKTsEoMUS0GJlyg4BabGEtNjjXfe4WwWkxRLSYhvSgsMxFpAWS0iLbXay4GXPFpAWS0iLTd2/YgFqsQS12NT9KxagFktQi03dv2IBarEEtdhmKwtecGsBarEEtdjmgnu84NYC1mIJa7HNmWF42bMFrMUS1mJTh4ZZwFosYS02dWiYBazFEtZiUzewWABbLIEttoEtsVoAlkhgi21gS6wWgCUS2GIb2CLRjaMWsBZLWIttWIuEdxlZAFssgS222coiOUwAwBZLYIut2QmXAicADJHAFtscGibhJTQWwBZLYIut2QmX8AYXC2CLJbDFNntZJJ58AthiCWyxzalhEg+wAGyxBLbY5tQwiRsjgC2WwBZbsxMu5zgBYIgEttianfBq+TtKAFgigS22OTZMYUsEsMUS2GKbY8MUuj/EAtZiCWuxqWPDLGAtlrAW21zAogQsALBDglpsc2qYwoYMUIslqMU2p4YpdD2dBaTFEtJim50sSsPvgRUS0GJTG1ksAC2WgBbbgBaFLvWyALRYAlpsc2ZYTIPACAlosc0VLMrCAgAbJJzFNpwFjmwAZbGEsthmE0ukEQHKYgllsTblCwFlsYSyWJvyhQCtWIJWbHMJS8SVAbRiCVqxzS0sEVcG0IolaMU221gi3higFUvQim3QSsQTAbZiCVux1ia6NMBWLGEr1qZ6ZcBWLGErdp7qlQFbsYSt2IatRPoDAFfcb399/Wq1+VDsymL55WZZ/PLqkzdvXr16/Y9XP66a/6xCgnUerz75xyvO9KtP/vHP16+4mDV/CM6Pf8jjI2GPv1THL9d/VKcYNX+I4x/VEuXmDyuaP6pw4if/+Oc/X7tSNz+78tbPKgF+/LH89akICsjMcwGZOmbOlHR/HPNk2h7/MML9odwfx+Iw636Zu3Tmx6/4bOb+EO4Pp4zZ/PgHY+4P5f44psy5e8TdI+6+Eu6RcI+EeyTdI+nSUe4X5d7R7g/jHjkBuXEltK7wTkA+d784Sfn8mI5wAoqZcn+4R8w9cnIJJ5fg7pGTSzi5hKt24cQR0qXs5BJOLqFcOso90u6Rdl85SYWTVLgaFNY9cpYlrCvPXLo/juWRrk6rS+mPfxyru7qf/PiHe9lZenVf8vEP97Jwj5yk0kkqnYDSySVV+8uxYNUFgcc/jo+U07xyFqWc5pXTvHKaV07z1TUCzR9O88pZlHIWpVzBlKuC6njr5g9XQuVKqJzmlSuhakvoqkC5RlSdx9n84TRfHc14/MM9mrtHc+N8A3N/KPeHe+Rk1641VYc4NX84kbUTWTuRtRO5Olal+cOJrJ3I2omsnbuoTj04/uEeOdm1s7pqM/XxD+fPnKur9jU2f7hmpZ2xaedAjDM244zNOGMzztgMax2ke+SszjirM871Vkuzj3+4l53HrVbLHv9wj5ykxvnDahXd8Q/3snaPnKTV2p7jHy4dJ3K1xOL4h3vkPIlx7cs6ka0T2TqRrRO5wkDHP9wjJ7J1IlvnUqxraNY1NOtkrwJnxz+O9W6dPVtnq7apuN5OZrFc+j2M9DqYxs/kpLAqV9vNYv202z4Vu3JV7INOS2mvV521vUXbJbTO1Lk83npD585c65KutqrLAo5NyBmxa/bVhppjbTnFsWxdbHeHp+WiLO63m3K3enuoBPOF4cyT5Vjexu76U3/3ble8W5TFYbM/vN3f71Zvi91i/+vmPlCX9nKYs/NTDhP1BjZNs+1PdL3ePgSiz7x6lK7VVZcnHz2p85Ktf3HuW/PWK7mxkOtOjGgbkmtj87ZtyLyCbn4lBRXquaDK2YdibSfQunz3i7Mz5fpYZVp33jpmZ3Ct5bk2p52d6dYr8NYnuV/ckNE4fRk3aqvWGB8ldy7EWbAVmXW13xe7crMtl6v903ZfhE1aeE2aZ6b36+b+w2K3WrxdBwNQz4wyS1b6nxvrDV9nec3m7WJftD8GbsVLy40u8sR7u93+bbV52AbJ8Zk/tM5zfVVCm8NjmI5fLp1XoPvF5v3iQ7HdLFfLYxWGw34/TZWn+fvFZrMt08lKL1mZJ/L9+8VTWew6UxPNPQ+TKXWTVEeB2ldg3lTpmFTY73DhJ5SptfeLHbHZuW+z87xUtsviabvalGFS1jcxllmg7Xq9KLe7QNfPyeR1bPfb9eFxE2rHehXGbV5Hc0zn51X5/n2xWFKFG7+jN+1kOVfQx6fFLrApbyyS5yuOaezvd7viISib8U19ltex3G83+3J3uCfa9/rnY9/gZtTH/3SDOzcodyPV5+G2c/xHL29zNbQpi1/Kx2JzCGvSV7sboUqdaxrPA52wNoNR2zHRzNa4ffrV/RimKfz4hcms1F2xKIuqR3rabX/59WHbDJq2b38q7sOW6rf3WV5Rq7FeuXosHra7x7CxBs0+L63i7fawuQ/doifwPM/DLovi6X693YTpeLUxz6vZKp3i74fFOqiBmW++Iq/ZVyk9LXbliqTFfH+W2cyXxcPisC7D8drMH6+5WaVuB0G5eqtTbhq/n77yqtLmOfBjWj8Xbz+sip9jDW/uhwvnbvbC8nq/MIty+9RN3p9ruHmmyBw2LYkDrI4+8tqzc1FuHK6YU7vN1fa6KIvFeh11IH7320Zrco2kSjw6B/N7LheEyq3X3epDsX/YbR/DojLfAttoiJuuy9x2Us29nmh5q2UA3lC1nQC7YCRv/2gjzu4PN33gLrbBXWxDuIiscDUnXHRBtB2Qm1wJ1xUJ2fbK7h03DRFuGiK0e8d1VMKFRoQLjQjbxhdd7vO2t3PhQDfVl24KJt0cSrqZoXTBLenCHtKFA6QrqnRFla6o0rkGqdtf3Dtt/zdvTa41cen+cL+4aZpymldte3BVoNzETT1PdN1XTmPKFUO5Yig3+lEufqZcWFo51al5Oy5wL7eBtJkLtrH2DzfHdH2xdoXXrszaVbeW7R/uK1d47UJi2tWydrWsXehIu8mvdhF0PXePnPUaV8vGRdCNq27jatnw9g837XeRS+Mil8YFLI1sf3FxHDe/Ni5Ga1yc0uj2F/eyK7xxoVnjArHGBWKNMwnrCm9dma0zUeumktYV3rrCW2eZ1kWarAsFWGeiVuUNLZfFvtitFuvV/4Qzspk/TBWZaXVndtLrmJyGmCssc6Eblhm4OmbwEDg16ZXUZI61jj/cbx/frjZFOKj2Bc/sgUhy26fuGFb4c8nMiGjxuAqGJ9LrG0xe/1UlQdTldQEmrzcpNstQFr8XyS3IZlnP1oJZqD8CZLll2R92xWK3W/wa2qs/ShZ5fXCxv188Fftyt9pUYcvil6egdL6UmUOp4gOJDQmvWDrPyItf7teHZfG0fHpYVDO+X1fLcDTjo1dpWyLUBvEyFXnMZretZi+rTVnsHhb3BcnKC/fIFjW108bMWVjxS1ls9qvtph5HbdfrYnnMdl+U5WrzLgzuWj/PFpy1aEadmyfMbO5n1nZxbQQ4V5fdzMpFWYS6nPlZtTFcN7Lj2VntFvdlNQsIUvd9g3Xze5s5yfASfVuUPxfFpo4ZhbbgOw7bTokyY/gPi/X67eL+b38rwmYrfbfoRkw8cwb3sNosN8Uv5Xp7v6g87vbhcVHev19t3nXVI/zCu07X5rXIKp8qmrMhaSo/TdcB27w2UaW5X23erYsPi/UhtBS/R7NudGRtngt6WO325Y/7+92PVUz4RxLTVL4eckvqEnQRV5qmr4e81vmc5odity86KWpfAXkpdsImQUzAtexMw6oTe/trSfih75qYyDSeOq3dYvOOhLz9pJzfOTXFcltFQ0iw2Q+FHBPONJ0m4eJpvbgv6pBZ3TUGnaIf2cpcPRRJttx2enHrj71Y3qCzSb0bazE+qZhlmmWdFlKqL3a71CEvzcN6XX1KKsmvJZXnpd8V4dDCK1OmLb4rygqm1vHKh8PmvnKanbIZv2izPMt5V5QOfDxsd5XjCYacXidrsmW9P+wql1s59zWZm/ix28yY3LuiLHa77e6x2O8XYVPUXvHm2cWry7X6n2K5WlZBnCOAextOJnwOwWZ5nsxL+29FFWTe31dDine77eFpFQzE/UBaZrAsTHxPUw8MQXneLrOnrJMJB1ieNcnMMX6dytvAM2ivLPMTykKwkFfT3MUWuFtcI3mmDuuEF5vlqiwewzGSP2uWmSO6JrnV5vGwLlcN1+oEYH1nxjNnXC7dZpQRS9grMM+coLyvIH9ZrkO473ujvGTKx3WxqQBl2Lj9JiPymkzYLKrtVs+TrpZtqTxXtnq32e6K5eFpvbpflEVkJZGfBcv0aatNPeNydCAkZ349uFUcUuVVyDHhxIzRXy/Thv/a9WaZwN1lk54x+i3AtGFJt/gkc2Z+zCpI2vodOsvr0OtPwzU5PqNkmcuxVvvjDI8sQmHGRxltbFq3QepMk9t7Pjkoq9/RZQajVnsX0KNLZtjM16DI1OC+OwjUXjrz7GQOb/cFGaD7Iw2RqSvqc5m/loE7i+NuOax0gV6ZK/Bh/9OuXlLw825Vht0598OZNrN1/rTfbtyP69Xfwirx40Msk75XCT4twlAaDyZhJm/o7BIqt/UsbFc8LDbL7cMDqScug+mYC1hkTszWi7dFCGvnXlFFS5Hm7RpGR2TmLQpxVOJ5wa+LqOu8Sl0vNu8Oi3fHWF9oP36dMhdO45mkfb1ITbb9eXxelVTpIafldzcsz+7W1VqFcnsonw5hs/N9VrtgPi9JN+YN69OnoJlLC9qUmhpZLspFDLIyP7TFMqMgJH1S4/5szkEwnjnVoSm3y0vu3xePizAfv3FnhhJJ8p3gEPODQ8yNFDjPNFfcz1THBHiLid0mFUfohGhXQrS8KbPxH/PbbGkoZa59J9BuDcmznsfFqjuUtf7g3pE2kbnCqkqtGSI/LykLG42vIZ1ZzGJzSJjH3E8yc1JTJVkP7JdFuVit96tNU+qwrP5yjUwP2U14f3jbnS4ECx7ybKBNmRiA54ZEJhCrkqoGAGFCXr2LzHmqS6ha0hs2BOsLmOcRXGKVA1usNqvNu+r9BYFmxh+m6HyrDFNGleLHL3hmVKpKpJr9bzfFcd1POI/1EVPmxOmxKBeVHw+9lT/Ec2MylhlledwuVw+rYgfwSjjn8OxdulG4bkl4JjFyuR3nN2EOws/BredoN/WITKUnZvg+C+WOtMlMN/t4KItfgsk4871rfhqPiyB644PezKn4pvj53SGcj2uvx5rnGf6GRAV4wC0yp1VVIuUWjpb9zUVWt6tf8wvXO2T2Y2eOl9pMOrLZbj4s1qvlosKVqbUKwtNs5sx6U4W46WqPeYBK8oYSmy1ZOumpVLsdOJbn+ePu+MCvIeYW0PDM9tAEYrtIyF+EkTl7A3UbDOsdyLWZa4ib9GiEXPnzyjz9Nwkdo+5BWj4Jzht0NmnVFh2k5BPfvDYX3+Hhj7ndCivmVoWxzFWTdfK74u1htSZzEM97tvt6M5MswrkWm1t/QOHGwJlbSdDaH39M4WLNeZ5gu6PjUH/5NXcUXrTLEDPjYnW6xfI5qnUcYdDM/KliJp08Jt0ZpvlBI57b+HbL1WaxBhsy/DpimU6mOxX2t+dlrqx9WizJcih/cTTLjPk/LaoFIrtwmb8/VOJ51va0KKt9S6Gi/ZGEW17C28W1ov3DbQJp16K4YYd1M0Cr8trQsRixXbe+/Tskzd1aUeGWkQpXVtFGqN02Y+12Mut297WjsMZFbGwmXHpaL8qqZ+gs1WJ+O2Uqb0gXpFbvBgmT9CMAKq9tBklW6/eIfw872tOTfL/YLNekofuAgGUuIHOJ1lOJ0N/5FZ4Z93Cp0d183F/PIE2mvPHVZX4ly+dDU5xZ5bbfIAM6i+R+tcv2YIb2MACe19mFmeDGxf3NorJd0P3cTM6RZx/f7+DPtNyabNWurslcbkZyi4dIuD/AVZmhHJJ6F0n7ay+k699Vu6x9ntnyj9mUqT36/s4T2Z5S0Z4ukTkPftptH1fExLwWlpsG9M1+NNGtSufO7wq3+l+4HkE4aCjm7X4JF7hvo3huuC7dBnrFW4/u/nAjFtVWwLzdIdBG+d3a+lm7ar9dbe9W0rfj78xpLhg88oC9OnPITC0cOvoUhru1/dwVn7vtHrzdDuMeCbdlU7iOTbhdFcKdYiCcOqWrFum23kjXrUqnYNnu+XTTW9meLeBqTLmtLkq0jrDdAOIW3jouo+ZtZ+z+cOlol45uO+x2W4QrqnFFNW6Dg2EtxHFre90CXGPa3r3dFuGWQbp0rFOUzYQXu+Kh2BWbezQ29S2gPQEp26IqP1CFjXfFYh86AP/4h8zEHrcfan9SbMoq0EDW4PobCJ2ObWYXe1yB1z3Kyx/AZg6Dd8XfD6sdBUF+OMJtZBLthqj2bIT2WCS3j0U5nqdbU3B7yYzbtmQzp0y7Yr9dfyiWYCLmryFqvm6dfq4J1WmX2w6W8Vc95CV12CzW6+gxKX78KDOyAAiDH1Zg7SlQ7cFwmQuAm62Eh11Bo3KM+8PbTBzQpta2xzBJv0PKnHK2Se6LdXHf4Yf+pl6WiW7aJKuV5IvN/Xuy895ffMkyt9FE1/Ex7s88Msf0zYrXcvv27dv7+/sPHz4E6w796FkmVNsXi939+7LY0TVt/pgvczN7ZE+Zr7TMmDkaw/s2ItsNga3HyFwKGRu8+8emSLchUrdHg2UueOkZtfsLslzD1O1ZZZnnXfUP132M47Z0qvZUscwJac44PdjmlNkc4gN0f47Wjj/aM9Ayl0vv3293ZZ1M0NT8zi4zDJVeQelPdt24RWbuYNmvV6H/85kw45lN5Gkd7hP0+2GWeXZVJxzFfIbEdKbOq1Q6+/z8BT8sk8bV86pu2/Qn1u2gwcW2bOYpEs3SinWxeUf2I/rdGcuVuEoLs09fbNvOrXLro15dghP2u4v2SNHcinYDjiCmFKyYzU6nszLQX9XBeN6AoFyVZJ2iTzBYe36o846qPaoyk9eBjSb+4gOWuey73G7X5YqsbveGFiJzNo8O2PDXtvJ2AVzm+oNqK9C+hl2bZbM9ttnMCjbJ+iOhzBPdYqlH8vBXY7DMQFebhX/C2uKhLHYOg5J+zddWO6k9LSu/z0xl5S9TaoMYp2X1UDGMBj68rY73KXBW/jBVtH11Xlb7zqTOPwWNO97G2wMR21UStg31uzh6bp40Rx/RMxfM4S5yz90mN87bP1qX6P5wBwNwd/ICb88lnrXxkfagY/eojVa5z4X7XLiNsMLFi4SbNAvXVQtHPYRt4yxuVSRrsZqbw/I2zuL+cJlKl6lUbcDFpdMevcHamW+7hqQ9v7c9idcNB52A2kUktG5JjRuWmjZW1p5h255P2x452x4e6+rayWWdFNadDGZly4Dy+unDpt7AuijrPd1orOuP+mV7fpdso4Z5ffZhs9puym2962APJnnhtsc8Z3DYrP5+KMAuHn8GkLm1zp/Jh8Oo4DyJ3IKRc1nDFP1xReZS706K69U+PFvCS/SMNMPghec0M1f2NWfdxk7Y9CFH2wLz3NRhX+y6e/H9hU2qPeKmbQSZWy3atKMTMD9MoNqG3Z6wnDmbbvOJtDB/WYt2vZTNnPYf9j/dv6/2Eocx8WBFiovK2cypXZVmE8J0W/PDtP11JZm72VK7MoKNipmbsY59cNzk/OWp7SEUJyUdtQp/fYmLt+d5W5d0dymDPzNqw6p5ba/Zgt85RtUz3UwkVifUOUTVH2pnxlnd2rqwloPdrnnG7RJCq7j8TS2ZXNklV277LNxfg9Uums8MTP0cDqv8pU1Xvwnk50UYavBXNbNZXlOu0njY7paHXUdx/sp1NstzNsf1y905lb+8PnOq6KVFljT4K6Ha5Yjt3DRnH+FfX796Wj0V69WmePXJm7/+85//F7eB42unFgQA"; \ No newline at end of file diff --git a/platform-bible-utils/classes/AsyncVariable.html b/platform-bible-utils/classes/AsyncVariable.html index 352ef71dde..5c8f1207f7 100644 --- a/platform-bible-utils/classes/AsyncVariable.html +++ b/platform-bible-utils/classes/AsyncVariable.html @@ -1,5 +1,5 @@ AsyncVariable | platform-bible-utils

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

    Accessors

    hasSettled promise

    Methods

    rejectWithReason @@ -9,17 +9,17 @@
  • 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. Defaults to 10000 ms

    -

    • Returns AsyncVariable<T>

    Accessors

    hasSettled

    • get hasSettled(): boolean

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

      +

    Returns AsyncVariable<T>

    Accessors

    hasSettled

    promise

    promise

    • get promise(): Promise<T>

    • Get this variable's promise to a value. This always returns the same promise even after the value has been resolved or rejected.

      Returns Promise<T>

      The promise for the value to be set

      -

    Methods

    rejectWithReason

    Methods

    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. Defaults to false

        -

      Returns void

    resolveToValue

    • resolveToValue(value, throwIfAlreadySettled?): void

    • Resolve this variable's promise to the given value

      +

    Returns void

    resolveToValue

    • resolveToValue(value, throwIfAlreadySettled?): void

    • Resolve this variable's promise to the given value

      Parameters

      • value: T

        This variable's promise will resolve to this value

      • throwIfAlreadySettled: boolean = false

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

        -

      Returns void

    Settings

    Member Visibility

    On This Page

    Constructors
    Accessors
    Methods
    +

    Returns void

    Settings

    Member Visibility

    On This Page

    Constructors
    Accessors
    Methods
    diff --git a/platform-bible-utils/classes/Collator.html b/platform-bible-utils/classes/Collator.html index 590ffa18c5..5be9d933c3 100644 --- a/platform-bible-utils/classes/Collator.html +++ b/platform-bible-utils/classes/Collator.html @@ -1,14 +1,14 @@ Collator | platform-bible-utils

    ClassCollator

    Enables language-sensitive string comparison. Wraps Intl.Collator

    -

    Constructors

    constructor +

    Constructors

    constructor

    Methods

    compare resolvedOptions -

    Constructors

    constructor

    Methods

    compare

    • compare(string1, string2): number

    • Compares two strings according to the sort order of this Collator object

      +

    Constructors

    constructor

    Methods

    compare

    • compare(string1, string2): number

    • Compares two strings according to the sort order of this Collator object

      Parameters

      • string1: string

        String to compare

      • string2: string

        String to compare

      Returns number

      A number indicating how string1 and string2 compare to each other according to the sort order of this Collator object. Negative value if string1 comes before string2. Positive value if string1 comes after string2. 0 if they are considered equal.

      -

    resolvedOptions

    resolvedOptions

    • resolvedOptions(): ResolvedCollatorOptions

    • Returns a new object with properties reflecting the locale and collation options computed during initialization of this collator object.

      Returns ResolvedCollatorOptions

      ResolvedCollatorOptions object

      -

    Settings

    Member Visibility

    On This Page

    Constructors
    Methods
    +

    Settings

    Member Visibility

    On This Page

    Constructors
    Methods
    diff --git a/platform-bible-utils/classes/DateTimeFormat.html b/platform-bible-utils/classes/DateTimeFormat.html index 7c1450c97c..55a9ef0658 100644 --- a/platform-bible-utils/classes/DateTimeFormat.html +++ b/platform-bible-utils/classes/DateTimeFormat.html @@ -1,29 +1,29 @@ DateTimeFormat | platform-bible-utils

    ClassDateTimeFormat

    Enables language-sensitive data and time formatting. Wraps Intl.DateTimeFormat

    -

    Constructors

    constructor +

    Constructors

    constructor

    Methods

    format formatRange formatRangeToParts formatToParts resolvedOptions -

    Constructors

    constructor

    Methods

    format

    • format(date): string

    • Formats a date according to the locale and formatting option for this DateTimeFormat object

      +

    Constructors

    constructor

    Methods

    format

    • format(date): string

    • Formats a date according to the locale and formatting option for this DateTimeFormat object

      Parameters

      • date: Date

        The date to format

      Returns string

      String representing the given date formatted according to the locale and formatting options of this DateTimeFormat object

      -

    formatRange

    formatRange

    • formatRange(startDate, endDate): string

    • Formats a date range in the most concise way based on the locales and options provided when instantiating this DateTimeFormat object

      Parameters

      • startDate: Date

        Date object representing start of the date range

      • endDate: Date

        Date object representing the end of the date range

      Returns string

      String representing the given date range formatted according to the locale and formatting options of this DateTimeFormat object

      -

    formatRangeToParts

    formatRangeToParts

    • formatRangeToParts(startDate, endDate): DateTimeRangeFormatPart[]

    • Returns an array of locale-specific tokens representing each part of the formatted date range produced by this DateTimeFormat object

      Parameters

      • startDate: Date

        Date object representing start of the date range

      • endDate: Date

        Date object representing the end of the date range

      Returns DateTimeRangeFormatPart[]

      Array of DateTimeRangeFormatPart objects

      -

    formatToParts

    formatToParts

    • formatToParts(date): DateTimeFormatPart[]

    • Allows locale-aware formatting of strings produced by this DateTimeFormat object

      Parameters

      • date: Date

        The date to format

      Returns DateTimeFormatPart[]

      Array of DateTimeFormatPart objects

      -

    resolvedOptions

    resolvedOptions

    • resolvedOptions(): ResolvedDateTimeFormatOptions

    • Returns a new object with properties reflecting the locale and date and time formatting options computed during initialization of this DateTimeFormat object

      Returns ResolvedDateTimeFormatOptions

      ResolvedDateTimeFormatOptions object

      -

    Settings

    Member Visibility

    On This Page

    Constructors
    Methods
    +

    Settings

    Member Visibility

    On This Page

    Constructors
    Methods
    diff --git a/platform-bible-utils/classes/DocumentCombiner.html b/platform-bible-utils/classes/DocumentCombiner.html index e79b52283e..4029e6a433 100644 --- a/platform-bible-utils/classes/DocumentCombiner.html +++ b/platform-bible-utils/classes/DocumentCombiner.html @@ -1,6 +1,6 @@ DocumentCombiner | platform-bible-utils

    ClassDocumentCombiner

    Base class for any code that wants to compose JSON documents (primarily in the form of JS objects or arrays) together into a single output document.

    -

    Hierarchy (view full)

    Constructors

    constructor +

    Hierarchy (view full)

    Constructors

    constructor

    Properties

    baseDocument contributions latestOutput @@ -20,8 +20,8 @@

    Constructors

    Protectedconstructor

    Properties

    ProtectedbaseDocument

    baseDocument: JsonDocumentLike

    Protected Readonlycontributions

    contributions: Map<string, JsonDocumentLike> = ...

    ProtectedlatestOutput

    latestOutput: undefined | JsonDocumentLike

    ReadonlyonDidRebuild

    onDidRebuild: PlatformEvent<undefined> = ...

    Event that emits to announce that the document has been rebuilt and the output has been updated

    -

    Protected Readonlyoptions

    options: DocumentCombinerOptions

    Methods

    addOrUpdateContribution

    • addOrUpdateContribution(documentName, document): undefined | JsonDocumentLike

    • Add or update one of the contribution documents for the composition process

      +

    Returns DocumentCombiner

    Properties

    ProtectedbaseDocument

    baseDocument: JsonDocumentLike

    Protected Readonlycontributions

    contributions: Map<string, JsonDocumentLike> = ...

    ProtectedlatestOutput

    latestOutput: undefined | JsonDocumentLike

    ReadonlyonDidRebuild

    onDidRebuild: PlatformEvent<undefined> = ...

    Event that emits to announce that the document has been rebuilt and the output has been updated

    +

    Protected Readonlyoptions

    options: DocumentCombinerOptions

    Methods

    addOrUpdateContribution

    • addOrUpdateContribution(documentName, document): undefined | JsonDocumentLike

    • Add or update one of the contribution documents for the composition process

      Note: the order in which contribution documents are added can be considered to be indeterminate as it is currently ordered by however Map.forEach provides the contributions. The order matters when merging two arrays into one. Also, when options.ignoreDuplicateProperties is @@ -32,22 +32,22 @@

    • document: JsonDocumentLike

      Content of the contributed document to combine

    Returns undefined | JsonDocumentLike

    Recalculated output document given the new or updated contribution and existing other documents

    -

    deleteAllContributions

    deleteAllContributions

    deleteContribution

    deleteContribution

    rebuild

    rebuild

    ProtectedtransformBaseDocumentAfterValidation

    ProtectedtransformBaseDocumentAfterValidation

    • transformBaseDocumentAfterValidation(baseDocument): JsonDocumentLike

    • Transform the starting document that is given to the combiner. This transformation occurs after validating the base document and before combining any contributions.

      WARNING: If you do not create the combiner with option copyDocuments: true or clone inside this method, this method will directly modify the baseDocument passed in.

      Parameters

      • baseDocument: JsonDocumentLike

        Initial input document. Already validated via validateBaseDocument

      Returns JsonDocumentLike

      Transformed base document

      -

    ProtectedtransformContributionAfterValidation

    ProtectedtransformContributionAfterValidation

    • transformContributionAfterValidation(documentName, document): JsonDocumentLike

    • Transform the contributed document associated with documentName. This transformation occurs after validating the contributed document and before combining with other documents.

      WARNING: If you do not create the combiner with option copyDocuments: true or clone inside this method, this method will directly modify the contributed document passed in.

      @@ -55,19 +55,19 @@
    • document: JsonDocumentLike

      Content of the contributed document to combine. Already validated via validateContribution

    Returns JsonDocumentLike

    Transformed contributed document

    -

    ProtectedtransformFinalOutputBeforeValidation

    ProtectedtransformFinalOutputBeforeValidation

    • transformFinalOutputBeforeValidation(finalOutput): JsonDocumentLike

    • Transform the document that is the composition of the base document and all contribution documents. This is the last step that will be run prior to validation via validateOutput before this.latestOutput is updated to the new output.

      Parameters

      • finalOutput: JsonDocumentLike

        Final output document that could potentially be returned to callers. "Final" means no further contribution documents will be merged.

        -

      Returns JsonDocumentLike

    updateBaseDocument

    • updateBaseDocument(baseDocument): undefined | JsonDocumentLike

    • Update the starting document for composition process

      +

    Returns JsonDocumentLike

    updateBaseDocument

    ProtectedvalidateBaseDocument

    ProtectedvalidateBaseDocument

    ProtectedvalidateContribution

    • validateContribution(documentName, document): void

    • Throw an error if the provided document is not a valid contribution document.

      +

    Returns void

    ProtectedvalidateContribution

    • validateContribution(documentName, document): void

    • Throw an error if the provided document is not a valid contribution document.

      Parameters

      • documentName: string

        Name of the contributed document to combine

      • document: JsonDocumentLike

        Content of the contributed document to combine

        -

      Returns void

    ProtectedvalidateOutput

    • validateOutput(output): void

    • Throw an error if the provided output is not valid.

      +

    Returns void

    ProtectedvalidateOutput

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    Methods
    +

    Returns void

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    Methods
    diff --git a/platform-bible-utils/classes/Mutex.html b/platform-bible-utils/classes/Mutex.html index c6d18d9c80..66bf17ae01 100644 --- a/platform-bible-utils/classes/Mutex.html +++ b/platform-bible-utils/classes/Mutex.html @@ -4,7 +4,7 @@

    See async-mutex for more information.

    -

    Hierarchy

    • Mutex
      • Mutex

    Constructors

    constructor +

    Hierarchy

    • Mutex
      • Mutex

    Constructors

    constructor

    Methods

    acquire cancel isLocked diff --git a/platform-bible-utils/classes/MutexMap.html b/platform-bible-utils/classes/MutexMap.html index 948ddb2c42..e070ec875d 100644 --- a/platform-bible-utils/classes/MutexMap.html +++ b/platform-bible-utils/classes/MutexMap.html @@ -1,4 +1,4 @@ MutexMap | platform-bible-utils

    ClassMutexMap

    Map of Mutexes that automatically (lazily) generates a new Mutex for any new key

    -

    Constructors

    constructor +

    Constructors

    constructor

    Methods

    get -

    Constructors

    constructor

    Methods

    get

    Settings

    Member Visibility

    On This Page

    Constructors
    Methods
    +

    Constructors

    constructor

    Methods

    get

    Settings

    Member Visibility

    On This Page

    Constructors
    Methods
    diff --git a/platform-bible-utils/classes/NonValidatingDocumentCombiner.html b/platform-bible-utils/classes/NonValidatingDocumentCombiner.html index 222d489615..4d6b579e02 100644 --- a/platform-bible-utils/classes/NonValidatingDocumentCombiner.html +++ b/platform-bible-utils/classes/NonValidatingDocumentCombiner.html @@ -1,6 +1,6 @@ NonValidatingDocumentCombiner | platform-bible-utils

    ClassNonValidatingDocumentCombiner

    Base class for any code that wants to compose JSON documents (primarily in the form of JS objects or arrays) together into a single output document.

    -

    Hierarchy (view full)

    Constructors

    constructor +

    Hierarchy (view full)

    Constructors

    constructor

    Properties

    baseDocument contributions latestOutput @@ -18,8 +18,8 @@ validateBaseDocument validateContribution validateOutput -

    Constructors

    constructor

    Properties

    ProtectedbaseDocument

    baseDocument: JsonDocumentLike

    Protected Readonlycontributions

    contributions: Map<string, JsonDocumentLike> = ...

    ProtectedlatestOutput

    latestOutput: undefined | JsonDocumentLike

    ReadonlyonDidRebuild

    onDidRebuild: PlatformEvent<undefined> = ...

    Event that emits to announce that the document has been rebuilt and the output has been updated

    -

    Protected Readonlyoptions

    options: DocumentCombinerOptions

    Accessors

    output

    Methods

    addOrUpdateContribution

    • addOrUpdateContribution(documentName, document): undefined | JsonDocumentLike

    • Add or update one of the contribution documents for the composition process

      +

    Constructors

    constructor

    Properties

    ProtectedbaseDocument

    baseDocument: JsonDocumentLike

    Protected Readonlycontributions

    contributions: Map<string, JsonDocumentLike> = ...

    ProtectedlatestOutput

    latestOutput: undefined | JsonDocumentLike

    ReadonlyonDidRebuild

    onDidRebuild: PlatformEvent<undefined> = ...

    Event that emits to announce that the document has been rebuilt and the output has been updated

    +

    Protected Readonlyoptions

    options: DocumentCombinerOptions

    Accessors

    output

    Methods

    addOrUpdateContribution

    • addOrUpdateContribution(documentName, document): undefined | JsonDocumentLike

    • Add or update one of the contribution documents for the composition process

      Note: the order in which contribution documents are added can be considered to be indeterminate as it is currently ordered by however Map.forEach provides the contributions. The order matters when merging two arrays into one. Also, when options.ignoreDuplicateProperties is @@ -30,22 +30,22 @@

    • document: JsonDocumentLike

      Content of the contributed document to combine

    Returns undefined | JsonDocumentLike

    Recalculated output document given the new or updated contribution and existing other documents

    -

    deleteAllContributions

    deleteAllContributions

    deleteContribution

    deleteContribution

    rebuild

    rebuild

    ProtectedtransformBaseDocumentAfterValidation

    ProtectedtransformBaseDocumentAfterValidation

    ProtectedtransformContributionAfterValidation

    ProtectedtransformContributionAfterValidation

    • transformContributionAfterValidation(documentName, document): JsonDocumentLike

    • Transform the contributed document associated with documentName. This transformation occurs after validating the contributed document and before combining with other documents.

      WARNING: If you do not create the combiner with option copyDocuments: true or clone inside this method, this method will directly modify the contributed document passed in.

      @@ -53,19 +53,19 @@
    • document: JsonDocumentLike

      Content of the contributed document to combine. Already validated via validateContribution

    Returns JsonDocumentLike

    Transformed contributed document

    -

    ProtectedtransformFinalOutputBeforeValidation

    ProtectedtransformFinalOutputBeforeValidation

    updateBaseDocument

    • updateBaseDocument(baseDocument): undefined | JsonDocumentLike

    • Update the starting document for composition process

      +

    Returns JsonDocumentLike

    updateBaseDocument

    ProtectedvalidateBaseDocument

    ProtectedvalidateBaseDocument

    ProtectedvalidateContribution

    • validateContribution(documentName, document): void

    • Throw an error if the provided document is not a valid contribution document.

      +

    Returns void

    ProtectedvalidateContribution

    ProtectedvalidateOutput

    • validateOutput(output): void

    • Throw an error if the provided output is not valid.

      +

    Returns void

    ProtectedvalidateOutput

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    Accessors
    Methods
    +

    Returns void

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    Accessors
    Methods
    diff --git a/platform-bible-utils/classes/NumberFormat.html b/platform-bible-utils/classes/NumberFormat.html index efd185f7e3..38042d4c40 100644 --- a/platform-bible-utils/classes/NumberFormat.html +++ b/platform-bible-utils/classes/NumberFormat.html @@ -1,30 +1,30 @@ NumberFormat | platform-bible-utils

    ClassNumberFormat

    Enables language-sensitive number formatting. Wraps Intl.NumberFormat

    -

    Constructors

    constructor +

    Constructors

    constructor

    Methods

    format formatRange formatRangeToParts formatToParts resolvedOptions -

    Constructors

    constructor

    Methods

    format

    • format(value): string

    • Formats a number according to the locale and formatting options of this NumberFormat object

      +

    Constructors

    constructor

    Methods

    format

    • format(value): string

    • Formats a number according to the locale and formatting options of this NumberFormat object

      Parameters

      • value: number | bigint

        Number or BigInt to format

      Returns string

      String representing the given number formatted according to the locale and formatting options of this NumberFormat object

      -

    formatRange

    formatRange

    • formatRange(startRange, endRange): string

    • Formats a range of numbers according to the locale and formatting options of this NumberFormat object

      Parameters

      • startRange: number | bigint

        Number or bigint representing the start of the range

      • endRange: number | bigint

        Number or bigint representing the end of the range

      Returns string

      String representing the given range of numbers formatted according to the locale and formatting options of this NumberFormat object

      -

    formatRangeToParts

    formatRangeToParts

    • formatRangeToParts(startRange, endRange): NumberRangeFormatPart[]

    • Returns an array of objects containing the locale-specific tokens from which it is possible to build custom strings while preserving the locale-specific parts.

      Parameters

      • startRange: number | bigint

        Number or bigint representing start of the range

      • endRange: number | bigint

        Number or bigint representing end of the range

      Returns NumberRangeFormatPart[]

      Array of NumberRangeFormatPart objects containing the formatted range of numbers in parts

      -

    formatToParts

    formatToParts

    • formatToParts(value): NumberFormatPart[]

    • Allows locale-aware formatting of strings produced by this NumberFormat object

      Parameters

      • value: number | bigint

        Number or bigint to format

      Returns NumberFormatPart[]

      Array of NumberFormatPart objects containing the formatted number in parts

      -

    resolvedOptions

    resolvedOptions

    • resolvedOptions(): ResolvedNumberFormatOptions

    • Returns a new object with properties reflecting the locale and number formatting options computed during initialization of this NumberFormat object

      Returns ResolvedNumberFormatOptions

      ResolvedNumberFormatOptions object

      -

    Settings

    Member Visibility

    On This Page

    Constructors
    Methods
    +

    Settings

    Member Visibility

    On This Page

    Constructors
    Methods
    diff --git a/platform-bible-utils/classes/PlatformEventEmitter.html b/platform-bible-utils/classes/PlatformEventEmitter.html index 850770c659..11910eb14c 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

    • T

    Implements

    Constructors

    constructor +

    Type Parameters

    • T

    Implements

    Constructors

    constructor

    Properties

    subscribe

    Accessors

    event

    Methods

    assertNotDisposed @@ -16,16 +16,16 @@

    Returns

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

    Alias

    event

    -

    Accessors

    event

    • get event(): PlatformEvent<T>

    • Event for listeners to subscribe to. Subscribes a function to run when this event is emitted. +

    Accessors

    event

    Methods

    ProtectedassertNotDisposed

    dispose

    ProtecteddisposeFn

    Methods

    ProtectedassertNotDisposed

    dispose

    ProtecteddisposeFn

    emit

    emit

    ProtectedemitFn

    • emitFn(event): void

    • Function that runs the subscriptions for the event. Added here so children can override emit +

    Returns void

    ProtectedemitFn

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    Accessors
    Methods
    +

    Parameters

    • event: T

    Returns void

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    Accessors
    Methods
    diff --git a/platform-bible-utils/classes/UnsubscriberAsyncList.html b/platform-bible-utils/classes/UnsubscriberAsyncList.html index cc8d92d6c8..29f1604242 100644 --- a/platform-bible-utils/classes/UnsubscriberAsyncList.html +++ b/platform-bible-utils/classes/UnsubscriberAsyncList.html @@ -1,10 +1,10 @@ UnsubscriberAsyncList | platform-bible-utils

    ClassUnsubscriberAsyncList

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

    -

    Constructors

    constructor +

    Constructors

    constructor

    Properties

    unsubscribers

    Methods

    add runAllUnsubscribers -

    Constructors

    constructor

    Properties

    Readonlyunsubscribers

    unsubscribers: Set<Unsubscriber | UnsubscriberAsync> = ...

    Methods

    add

    • add(...unsubscribers): void

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

      +

    Constructors

    constructor

    Properties

    Readonlyunsubscribers

    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

    On This Page

    Constructors
    Properties
    Methods
    +

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    Methods
    diff --git a/platform-bible-utils/classes/UsjReaderWriter.html b/platform-bible-utils/classes/UsjReaderWriter.html index 12001ec495..915f277ce7 100644 --- a/platform-bible-utils/classes/UsjReaderWriter.html +++ b/platform-bible-utils/classes/UsjReaderWriter.html @@ -1,5 +1,5 @@ UsjReaderWriter | platform-bible-utils

    ClassUsjReaderWriter

    Represents USJ formatted scripture with helpful utilities for working with it

    -

    Implements

    Constructors

    constructor +

    Implements

    Constructors

    constructor

    Methods

    extractText extractTextBetweenPoints findNextLocationOfMatchingText @@ -11,15 +11,15 @@ removeContentNodes usjChanged verseRefToUsjContentLocation -

    Constructors

    constructor

    Methods

    extractText

    • extractText(start, desiredLength): string

    • Return a copy of text following a given starting point

      +

    Constructors

    constructor

    Methods

    extractText

    extractTextBetweenPoints

    • extractTextBetweenPoints(start, end, maxLength?): string

    • Return a copy of text between two points

      +

    Returns string

    extractTextBetweenPoints

    findNextLocationOfMatchingText

    findNextLocationOfMatchingText

    • findNextLocationOfMatchingText(startingPoint, text, maxTextLengthToSearch?): undefined | UsjContentLocation

    • Given a starting point, find the next location in this USJ data that matches the given text

      Parameters

      • startingPoint: UsjContentLocation
      • text: string

        Text to find

      • maxTextLengthToSearch: number = 1000

        Maximum length of text to search before stopping (default is 1000)

      Returns undefined | UsjContentLocation

      Object containing the USJ node where text begins (it might be split across nodes), @@ -27,17 +27,17 @@ indicates the location of the of USJ node within usj. Note that if the USJ node returned is an object, it is the same object that is within this USJ data. So if you change it, you are changing this USJ data.

      -

    findParent

    findSingleValue

    jsonPathToVerseRefAndOffset

    findParent

    findSingleValue

    jsonPathToVerseRefAndOffset

    • jsonPathToVerseRefAndOffset(jsonPathQuery, bookId?): VerseRefOffset

    • Convert a JSONPath query into a VerseRef and offset

      Parameters

      • jsonPathQuery: string

        JSONPath search expression that indicates a node within this USJ data. If the expression matches more than one node, then only the first node found is considered.

      • OptionalbookId: string

        3 letter ID of the book being searched (must be defined in this USJ data if not provided here)

      Returns VerseRefOffset

      VerseRef and offset that represents the location within this USJ data indicated by jsonPathQuery

      -

    nodeToJsonPath

    nodeToVerseRefAndOffset

    nodeToJsonPath

    nodeToVerseRefAndOffset

    • nodeToVerseRefAndOffset(bookId, node, nodeParent): undefined | {
          offset: number;
          verseRef: VerseRef;
      }

    • Determine the VerseRef and offset that correspond to the location of a node somewhere within this USJ data

      Parameters

      • bookId: string

        ID of the book represented by this USJ data

      • node: MarkerContent

        JSON object representing the location of the VerseRef and offset

        @@ -45,12 +45,12 @@ 'undefined' is provided then the UsjReaderWriter will attempt to lookup the parent of node. The lookup will always fail and throw an error if node is a string.

      Returns undefined | {
          offset: number;
          verseRef: VerseRef;
      }

      VerseRef and offset representing the location of node, if one could be found

      -

    removeContentNodes

    removeContentNodes

    • removeContentNodes(searchFunction): number

    • Remove all nodes from this USJ data that match a given search function.

      Parameters

      • searchFunction: ((potentiallyMatchingNode: MarkerContent) => boolean)

        Function that returns true if the given node should be removed

          • (potentiallyMatchingNode): boolean

          • Parameters

            • potentiallyMatchingNode: MarkerContent

            Returns boolean

      Returns number

      Number of nodes removed

      -

    usjChanged

    usjChanged

    verseRefToUsjContentLocation

    verseRefToUsjContentLocation

    • verseRefToUsjContentLocation(verseRef, verseRefOffset?): UsjContentLocation

    • Convert a verse ref + offset into a node + offset within this USJ data and a JSONPath query

      Parameters

      • verseRef: VerseRef

        Indicates the book, chapter, and verse of interest to find

      • verseRefOffset: number = 0

        Specific location within verse text (defaults to 0)

      Returns UsjContentLocation

      Object containing the USJ node indicated by verseRef and verseRefOffset, offset @@ -58,4 +58,4 @@ location of the of USJ node within this USJ data. Note that if the USJ node returned is an object, it is the same object that is within this USJ data. So if you change it, you are changing this USJ data.

      -

    Settings

    Member Visibility

    On This Page

    Constructors
    Methods
    +

    Settings

    Member Visibility

    On This Page

    Constructors
    Methods
    diff --git a/platform-bible-utils/functions/aggregateUnsubscriberAsyncs.html b/platform-bible-utils/functions/aggregateUnsubscriberAsyncs.html index 128ad53f8f..a56c0dd0b1 100644 --- a/platform-bible-utils/functions/aggregateUnsubscriberAsyncs.html +++ b/platform-bible-utils/functions/aggregateUnsubscriberAsyncs.html @@ -1,4 +1,4 @@ aggregateUnsubscriberAsyncs | platform-bible-utils

    FunctionaggregateUnsubscriberAsyncs

    Returns an UnsubscriberAsync function that combines all the unsubscribers passed in.

    Settings

    Member Visibility
    +

    Settings

    Member Visibility
    diff --git a/platform-bible-utils/functions/aggregateUnsubscribers.html b/platform-bible-utils/functions/aggregateUnsubscribers.html index 29bc4d6da5..aec53dc70b 100644 --- a/platform-bible-utils/functions/aggregateUnsubscribers.html +++ b/platform-bible-utils/functions/aggregateUnsubscribers.html @@ -1,4 +1,4 @@ aggregateUnsubscribers | platform-bible-utils

    FunctionaggregateUnsubscribers

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

    Settings

    Member Visibility
    +

    Settings

    Member Visibility
    diff --git a/platform-bible-utils/functions/at.html b/platform-bible-utils/functions/at.html index edfd5abf6b..dd12896054 100644 --- a/platform-bible-utils/functions/at.html +++ b/platform-bible-utils/functions/at.html @@ -6,4 +6,4 @@ length(string)

    Returns string | undefined

    New string consisting of the Unicode code point located at the specified offset, undefined if index is out of bounds

    -

    Settings

    Member Visibility
    +

    Settings

    Member Visibility
    diff --git a/platform-bible-utils/functions/charAt.html b/platform-bible-utils/functions/charAt.html index 9c82fc803e..cc3a88e634 100644 --- a/platform-bible-utils/functions/charAt.html +++ b/platform-bible-utils/functions/charAt.html @@ -6,4 +6,4 @@ length(string)-1

    Returns string

    New string consisting of the Unicode code point located at the specified offset, empty string if index is out of bounds

    -

    Settings

    Member Visibility
    +

    Settings

    Member Visibility
    diff --git a/platform-bible-utils/functions/codePointAt.html b/platform-bible-utils/functions/codePointAt.html index b2f6d5df81..e75b0914e0 100644 --- a/platform-bible-utils/functions/codePointAt.html +++ b/platform-bible-utils/functions/codePointAt.html @@ -7,4 +7,4 @@ length(string)-1

    Returns number | undefined

    Non-negative integer representing the code point value of the character at the given index, or undefined if there is no element at that position

    -

    Settings

    Member Visibility
    +

    Settings

    Member Visibility
    diff --git a/platform-bible-utils/functions/compareScrRefs.html b/platform-bible-utils/functions/compareScrRefs.html index e63b736648..2aac091c7b 100644 --- a/platform-bible-utils/functions/compareScrRefs.html +++ b/platform-bible-utils/functions/compareScrRefs.html @@ -4,4 +4,4 @@

    Returns number

    A number indicating the result of the comparison: - Negative value if scrRef1 precedes scrRef2 in sorting order. - Zero if scrRef1 and scrRef2 are equivalent in sorting order. - Positive value if scrRef1 follows scrRef2 in sorting order.

    -

    Settings

    Member Visibility
    +

    Settings

    Member Visibility
    diff --git a/platform-bible-utils/functions/createSyncProxyForAsyncObject.html b/platform-bible-utils/functions/createSyncProxyForAsyncObject.html index 92f0441b31..06ee123c89 100644 --- a/platform-bible-utils/functions/createSyncProxyForAsyncObject.html +++ b/platform-bible-utils/functions/createSyncProxyForAsyncObject.html @@ -7,4 +7,4 @@ does not exist on this object, it will be considered to be an asynchronous method called on the object returned from getObject.

    Returns T

    A synchronous proxy for the asynchronous object.

    -

    Settings

    Member Visibility
    +

    Settings

    Member Visibility
    diff --git a/platform-bible-utils/functions/debounce.html b/platform-bible-utils/functions/debounce.html index eebae65d56..11e2257ebc 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
    +

    Settings

    Member Visibility
    diff --git a/platform-bible-utils/functions/deepClone.html b/platform-bible-utils/functions/deepClone.html index bda580791c..a46d5577f6 100644 --- a/platform-bible-utils/functions/deepClone.html +++ b/platform-bible-utils/functions/deepClone.html @@ -2,4 +2,4 @@ references between the source and target of property copying operations.

    Type Parameters

    Parameters

    Returns T

    Duplicate copy of obj without any references back to the original one

    -

    Settings

    Member Visibility
    +

    Settings

    Member Visibility
    diff --git a/platform-bible-utils/functions/deepEqual.html b/platform-bible-utils/functions/deepEqual.html index 7ef6a790fa..6e3d7490fd 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
    +

    Settings

    Member Visibility
    diff --git a/platform-bible-utils/functions/deserialize.html b/platform-bible-utils/functions/deserialize.html index b8076770b8..e9ebb7bda5 100644 --- a/platform-bible-utils/functions/deserialize.html +++ b/platform-bible-utils/functions/deserialize.html @@ -9,4 +9,4 @@ the object. If a member contains nested objects, the nested objects are transformed before the parent object is. Note that null values are converted into undefined values after the reviver has run.

    -

    Returns any

    Settings

    Member Visibility
    +

    Returns any

    Settings

    Member Visibility
    diff --git a/platform-bible-utils/functions/endsWith.html b/platform-bible-utils/functions/endsWith.html index 6d3887fe4a..725176b198 100644 --- a/platform-bible-utils/functions/endsWith.html +++ b/platform-bible-utils/functions/endsWith.html @@ -6,4 +6,4 @@
  • endPosition: number = ...

    End position where searchString is expected to be found. Default is length(string)

    • Returns boolean

    True if it ends with searchString, false if it does not

    -

    Settings

    Member Visibility
    +

    Settings

    Member Visibility
    diff --git a/platform-bible-utils/functions/ensureArray.html b/platform-bible-utils/functions/ensureArray.html index be6fde806d..37d36264f2 100644 --- a/platform-bible-utils/functions/ensureArray.html +++ b/platform-bible-utils/functions/ensureArray.html @@ -10,4 +10,4 @@

    Parameters

    Returns T[]

    An array containing the input value(s). If the input is undefined, an empty array is returned.

    -

    Settings

    Member Visibility
    +

    Settings

    Member Visibility
    diff --git a/platform-bible-utils/functions/escapeStringRegexp.html b/platform-bible-utils/functions/escapeStringRegexp.html index 1ce9878146..2d9a3073fe 100644 --- a/platform-bible-utils/functions/escapeStringRegexp.html +++ b/platform-bible-utils/functions/escapeStringRegexp.html @@ -6,4 +6,4 @@

    Parameters

    Returns string

    Example

    import escapeStringRegexp from 'platform-bible-utils';

        const escapedString = escapeStringRegexp('How much $ for a 🦄?');
        //=> 'How much \\$ for a 🦄\\?'

        new RegExp(escapedString);
    -

    Settings

    Member Visibility
    +

    Settings

    Member Visibility
    diff --git a/platform-bible-utils/functions/formatBytes.html b/platform-bible-utils/functions/formatBytes.html index cacb8d17ea..b168dc19e5 100644 --- a/platform-bible-utils/functions/formatBytes.html +++ b/platform-bible-utils/functions/formatBytes.html @@ -9,4 +9,4 @@

    Example

    FormatBytes(1024, 0) => "1 KB"
    -

    Settings

    Member Visibility
    +

    Settings

    Member Visibility
    diff --git a/platform-bible-utils/functions/formatReplacementString.html b/platform-bible-utils/functions/formatReplacementString.html index 0d2c633630..d3746a1c27 100644 --- a/platform-bible-utils/functions/formatReplacementString.html +++ b/platform-bible-utils/functions/formatReplacementString.html @@ -14,4 +14,4 @@

    Example

    formatReplacementString(
      'Hi, this is {name}! I like \{curly braces\}! I have a {carColor} car. My favorite food is {food}.',
      { name: 'Bill', carColor: 'blue' }
    );

    =>

    'Hi, this is Bill! I like {curly braces}! I have a blue car. My favorite food is food.'
    -

    Settings

    Member Visibility
    +

    Settings

    Member Visibility
    diff --git a/platform-bible-utils/functions/formatReplacementStringToArray.html b/platform-bible-utils/functions/formatReplacementStringToArray.html new file mode 100644 index 0000000000..b9262431c4 --- /dev/null +++ b/platform-bible-utils/functions/formatReplacementStringToArray.html @@ -0,0 +1,22 @@ +formatReplacementStringToArray | platform-bible-utils

    FunctionformatReplacementStringToArray

    • formatReplacementStringToArray<T>(str, replacers): (string | T)[]

    • Formats a string into an array of objects (adjacent strings are concatenated in one array entry), +replacing {replacer key} with the value in the replacers at that replacer key (or multiple +replacer values if there are multiple in the string). Will also remove \ before curly braces if +curly braces are escaped with a backslash in order to preserve the curly braces. E.g. 'Hi, this +is {name}! I like \{curly braces\}! would become Hi, this is Jim! I like {curly braces}!

      +

      If the key in unescaped braces is not found, returns the key without the braces. Empty unescaped +curly braces will just return a string without the braces e.g. ('I am {Nemo}', { 'name': 'Jim'}) +would return 'I am Nemo'.

      +

      Note: React elements can be used as replacer values.

      +

      Type Parameters

      • T = unknown

      Parameters

      • str: string

        String to format and break out into an array of objects

        +
      • replacers: object | {
            [key: string | number]: T;
        }

        Object whose keys are replacer keys and whose values are the values with which +to replace {replacer key}s found in the string to format. If the replacer value is a string, +it will be concatenated into existing strings in the array. Otherwise, the replacer value will +be added as a new entry in the array

        +

      Returns (string | T)[]

      Array of formatted strings and replaced objects

      +

      Example

      <p>
        {formatReplacementStringToArray('Hi {other}! I am {name}.', {
          other: 'Billy',
          name: <span className="tw-text-red-500">Jim</span>,
        })}
      </p>
+
      + +

      Example

      formatReplacementStringToArray(
        'Hi, this is {name}! I like \{curly braces\}! I have a {carInfo} car. My favorite food is {food}.',
        { name: ['Bill'], carInfo: { year: 2015, color: 'blue' } }
      );

      =>

      ['Hi, this is ', ['Bill'], '! I like {curly braces}! I have a ', { year: 2015, color: 'blue' }, ' car. My favorite food is food.']
+
      + +

    Settings

    Member Visibility
    diff --git a/platform-bible-utils/functions/formatScrRef.html b/platform-bible-utils/functions/formatScrRef.html index 75005deb6e..b61a1e8ebe 100644 --- a/platform-bible-utils/functions/formatScrRef.html +++ b/platform-bible-utils/functions/formatScrRef.html @@ -9,4 +9,4 @@
  • OptionalbookChapterSeparator: string

    The character used to separate the book from the chapter number. Default is a single space. Note: More than one character is allowed.

    • Returns string

    The formatted reference.

    -

    Settings

    Member Visibility
    +

    Settings

    Member Visibility
    diff --git a/platform-bible-utils/functions/getAllObjectFunctionNames.html b/platform-bible-utils/functions/getAllObjectFunctionNames.html index 9499d22c83..20e090d8fd 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
    +

    Settings

    Member Visibility
    diff --git a/platform-bible-utils/functions/getChaptersForBook.html b/platform-bible-utils/functions/getChaptersForBook.html index 7520b5963a..ae1664ee93 100644 --- a/platform-bible-utils/functions/getChaptersForBook.html +++ b/platform-bible-utils/functions/getChaptersForBook.html @@ -1 +1 @@ -getChaptersForBook | platform-bible-utils

    FunctiongetChaptersForBook

    Settings

    Member Visibility
    +getChaptersForBook | platform-bible-utils

    FunctiongetChaptersForBook

    Settings

    Member Visibility
    diff --git a/platform-bible-utils/functions/getCurrentLocale.html b/platform-bible-utils/functions/getCurrentLocale.html index d18d4d2934..a424d9fb01 100644 --- a/platform-bible-utils/functions/getCurrentLocale.html +++ b/platform-bible-utils/functions/getCurrentLocale.html @@ -1,4 +1,4 @@ getCurrentLocale | platform-bible-utils

    FunctiongetCurrentLocale

    • getCurrentLocale(): string

    • Retrieves the current locale of the user's environment.

      Returns string

      A string representing the current locale. If the locale cannot be determined, the function returns an empty string.

      -

    Settings

    Member Visibility
    +

    Settings

    Member Visibility
    diff --git a/platform-bible-utils/functions/getErrorMessage.html b/platform-bible-utils/functions/getErrorMessage.html index 46c29b2ba4..1841289c69 100644 --- a/platform-bible-utils/functions/getErrorMessage.html +++ b/platform-bible-utils/functions/getErrorMessage.html @@ -6,4 +6,4 @@

    Example

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

    Settings

    Member Visibility
    +

    Settings

    Member Visibility
    diff --git a/platform-bible-utils/functions/getLocalizeKeyForScrollGroupId.html b/platform-bible-utils/functions/getLocalizeKeyForScrollGroupId.html index 633c8bf770..7fbadfd66c 100644 --- a/platform-bible-utils/functions/getLocalizeKeyForScrollGroupId.html +++ b/platform-bible-utils/functions/getLocalizeKeyForScrollGroupId.html @@ -1,2 +1,2 @@ getLocalizeKeyForScrollGroupId | platform-bible-utils

    FunctiongetLocalizeKeyForScrollGroupId

    Settings

    Member Visibility
    +

    Parameters

    Returns LocalizeKey

    Settings

    Member Visibility
    diff --git a/platform-bible-utils/functions/getLocalizeKeysForScrollGroupIds.html b/platform-bible-utils/functions/getLocalizeKeysForScrollGroupIds.html index 402b579ca1..00719c0841 100644 --- a/platform-bible-utils/functions/getLocalizeKeysForScrollGroupIds.html +++ b/platform-bible-utils/functions/getLocalizeKeysForScrollGroupIds.html @@ -5,4 +5,4 @@

    Example

    getLocalizeKeysForScrollGroupIds([undefined, 0, 1, 2, 3, 4]);
    // Gives localized string keys for the provided scroll group ids in an array
    -

    Settings

    Member Visibility
    +

    Settings

    Member Visibility
    diff --git a/platform-bible-utils/functions/getLocalizedIdFromBookNumber.html b/platform-bible-utils/functions/getLocalizedIdFromBookNumber.html index e0500ad8b5..de64bd66e2 100644 --- a/platform-bible-utils/functions/getLocalizedIdFromBookNumber.html +++ b/platform-bible-utils/functions/getLocalizedIdFromBookNumber.html @@ -6,4 +6,4 @@

    Parameters

    Returns Promise<string>

    Settings

    Member Visibility
    +

    Returns Promise<string>

    Settings

    Member Visibility
    diff --git a/platform-bible-utils/functions/groupBy.html b/platform-bible-utils/functions/groupBy.html index 3868abc677..7a783e1f7f 100644 --- a/platform-bible-utils/functions/groupBy.html +++ b/platform-bible-utils/functions/groupBy.html @@ -2,4 +2,4 @@

    Type Parameters

    Parameters

    Returns Map<K, T[]>

    Map of keys to groups of values corresponding to each item

    -
  • groupBy<T, K, V>(items, keySelector, valueSelector): Map<K, V[]>

  • Type Parameters

    • T
    • K
    • V

    Parameters

    • items: T[]
    • keySelector: ((item: T) => K)
        • (item): K

        • Parameters

          • item: T

          Returns K

    • valueSelector: ((item: T, key: K) => V)
        • (item, key): V

        • Parameters

          • item: T
          • key: K

          Returns V

    Returns Map<K, V[]>

    • Settings

    Member Visibility
    +
  • groupBy<T, K, V>(items, keySelector, valueSelector): Map<K, V[]>

  • Type Parameters

    • T
    • K
    • V

    Parameters

    • items: T[]
    • keySelector: ((item: T) => K)
        • (item): K

        • Parameters

          • item: T

          Returns K

    • valueSelector: ((item: T, key: K) => V)
        • (item, key): V

        • Parameters

          • item: T
          • key: K

          Returns V

    Returns Map<K, V[]>

    • Settings

    Member Visibility
    diff --git a/platform-bible-utils/functions/htmlEncode.html b/platform-bible-utils/functions/htmlEncode.html index 7091992995..6fdc43973c 100644 --- a/platform-bible-utils/functions/htmlEncode.html +++ b/platform-bible-utils/functions/htmlEncode.html @@ -1,4 +1,4 @@ htmlEncode | platform-bible-utils

    FunctionhtmlEncode

    HTML Encodes the provided string. Thanks to ChatGPT

    Settings

    Member Visibility
    +

    Settings

    Member Visibility
    diff --git a/platform-bible-utils/functions/includes.html b/platform-bible-utils/functions/includes.html index 74f0965d38..dfd73c551a 100644 --- a/platform-bible-utils/functions/includes.html +++ b/platform-bible-utils/functions/includes.html @@ -5,4 +5,4 @@
  • searchString: string

    String to search for

  • position: number = 0

    Position within the string to start searching for searchString. Default is 0

    • Returns boolean

    True if search string is found, false if it is not

    -

    Settings

    Member Visibility
    +

    Settings

    Member Visibility
    diff --git a/platform-bible-utils/functions/indexOf.html b/platform-bible-utils/functions/indexOf.html index 72370b4686..889342f592 100644 --- a/platform-bible-utils/functions/indexOf.html +++ b/platform-bible-utils/functions/indexOf.html @@ -5,4 +5,4 @@
  • searchString: string

    The string to search for

  • position: undefined | number = 0

    Start of searching. Default is 0

    • Returns number

    Index of the first occurrence of a given string

    -

    Settings

    Member Visibility
    +

    Settings

    Member Visibility
    diff --git a/platform-bible-utils/functions/isLocalizeKey.html b/platform-bible-utils/functions/isLocalizeKey.html index 96f3fe2355..82aa3fcf14 100644 --- a/platform-bible-utils/functions/isLocalizeKey.html +++ b/platform-bible-utils/functions/isLocalizeKey.html @@ -1,2 +1,2 @@ isLocalizeKey | platform-bible-utils

    FunctionisLocalizeKey

    • isLocalizeKey(str): str is `%${string}%`

    • Determine whether the string is a LocalizeKey meant to be localized in Platform.Bible.

      -

      Parameters

      • str: string

      Returns str is `%${string}%`

    Settings

    Member Visibility
    +

    Parameters

    Returns str is `%${string}%`

    Settings

    Member Visibility
    diff --git a/platform-bible-utils/functions/isSerializable.html b/platform-bible-utils/functions/isSerializable.html index bf08fac9c4..669a43c16d 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
    +

    Settings

    Member Visibility
    diff --git a/platform-bible-utils/functions/isString.html b/platform-bible-utils/functions/isString.html index 1345ace0b8..48d2d78f52 100644 --- a/platform-bible-utils/functions/isString.html +++ b/platform-bible-utils/functions/isString.html @@ -1,4 +1,4 @@ isString | platform-bible-utils

    FunctionisString

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

    Settings

    Member Visibility
    diff --git a/platform-bible-utils/functions/isSubset.html b/platform-bible-utils/functions/isSubset.html index 0928297c2b..5ca53c5836 100644 --- a/platform-bible-utils/functions/isSubset.html +++ b/platform-bible-utils/functions/isSubset.html @@ -14,4 +14,4 @@

    It is important to note that only arrays of primitives (i.e., booleans, numbers, strings) are supported. In particular, objects in arrays will not be checked for deep equality. Also, presence in an array is all this checks, not the number of times that an item appears in an array. [1, 1] is a subset of [1].

    -

    Settings

    Member Visibility
    +

    Settings

    Member Visibility
    diff --git a/platform-bible-utils/functions/lastIndexOf.html b/platform-bible-utils/functions/lastIndexOf.html index 769f796028..f35ebe7ad5 100644 --- a/platform-bible-utils/functions/lastIndexOf.html +++ b/platform-bible-utils/functions/lastIndexOf.html @@ -6,4 +6,4 @@
  • Optionalposition: number

    The index at which to begin searching. If omitted, the search begins at the end of the string. Default is undefined

    • Returns number

    Index of the last occurrence of searchString found, or -1 if not found.

    -

    Settings

    Member Visibility
    +

    Settings

    Member Visibility
    diff --git a/platform-bible-utils/functions/newGuid.html b/platform-bible-utils/functions/newGuid.html index 16bccb260b..3fe2d80446 100644 --- a/platform-bible-utils/functions/newGuid.html +++ b/platform-bible-utils/functions/newGuid.html @@ -1,2 +1,2 @@ newGuid | platform-bible-utils

    FunctionnewGuid

    Settings

    Member Visibility
    +

    Returns string

    Settings

    Member Visibility
    diff --git a/platform-bible-utils/functions/normalize.html b/platform-bible-utils/functions/normalize.html index 8c6a2e45b5..0480e48cad 100644 --- a/platform-bible-utils/functions/normalize.html +++ b/platform-bible-utils/functions/normalize.html @@ -4,4 +4,4 @@

    Parameters

    Returns string

    A string containing the Unicode Normalization Form of the given string.

    -

    Settings

    Member Visibility
    +

    Settings

    Member Visibility
    diff --git a/platform-bible-utils/functions/offsetBook.html b/platform-bible-utils/functions/offsetBook.html index a1f57a8981..4399f2342c 100644 --- a/platform-bible-utils/functions/offsetBook.html +++ b/platform-bible-utils/functions/offsetBook.html @@ -1 +1 @@ -offsetBook | platform-bible-utils

    FunctionoffsetBook

    Settings

    Member Visibility
    +offsetBook | platform-bible-utils

    FunctionoffsetBook

    Settings

    Member Visibility
    diff --git a/platform-bible-utils/functions/offsetChapter.html b/platform-bible-utils/functions/offsetChapter.html index ad55bfc594..5c2f131d1f 100644 --- a/platform-bible-utils/functions/offsetChapter.html +++ b/platform-bible-utils/functions/offsetChapter.html @@ -1 +1 @@ -offsetChapter | platform-bible-utils

    FunctionoffsetChapter

    Settings

    Member Visibility
    +offsetChapter | platform-bible-utils

    FunctionoffsetChapter

    Settings

    Member Visibility
    diff --git a/platform-bible-utils/functions/offsetVerse.html b/platform-bible-utils/functions/offsetVerse.html index 394f4aaaf8..fcf20c5f72 100644 --- a/platform-bible-utils/functions/offsetVerse.html +++ b/platform-bible-utils/functions/offsetVerse.html @@ -1 +1 @@ -offsetVerse | platform-bible-utils

    FunctionoffsetVerse

    Settings

    Member Visibility
    +offsetVerse | platform-bible-utils

    FunctionoffsetVerse

    Settings

    Member Visibility
    diff --git a/platform-bible-utils/functions/ordinalCompare.html b/platform-bible-utils/functions/ordinalCompare.html index 92e7662f34..fb7f1ce572 100644 --- a/platform-bible-utils/functions/ordinalCompare.html +++ b/platform-bible-utils/functions/ordinalCompare.html @@ -7,4 +7,4 @@

    Returns number

    A number indicating the result of the comparison: - Negative value if string1 precedes string2 in sorting order. - Zero if string1 and string2 are equivalent in sorting order. - Positive value if string1 follows string2 in sorting order.

    -

    Settings

    Member Visibility
    +

    Settings

    Member Visibility
    diff --git a/platform-bible-utils/functions/padEnd.html b/platform-bible-utils/functions/padEnd.html index 5a40db7ea2..10db96a29f 100644 --- a/platform-bible-utils/functions/padEnd.html +++ b/platform-bible-utils/functions/padEnd.html @@ -8,4 +8,4 @@
  • padString: string = ' '

    The string to pad the current string with. If padString is too long to stay within targetLength, it will be truncated. Default is " "

    • Returns string

    String with appropriate padding at the end

    -

    Settings

    Member Visibility
    +

    Settings

    Member Visibility
    diff --git a/platform-bible-utils/functions/padStart.html b/platform-bible-utils/functions/padStart.html index 83c06ff54f..3ed5c72081 100644 --- a/platform-bible-utils/functions/padStart.html +++ b/platform-bible-utils/functions/padStart.html @@ -8,4 +8,4 @@
  • padString: string = ' '

    The string to pad the current string with. If padString is too long to stay within the targetLength, it will be truncated from the end. Default is " "

    • Returns string

    String with of specified targetLength with padString applied from the start

    -

    Settings

    Member Visibility
    +

    Settings

    Member Visibility
    diff --git a/platform-bible-utils/functions/scrRefToBBBCCCVVV.html b/platform-bible-utils/functions/scrRefToBBBCCCVVV.html index 4b6f7a74ba..7046dcf479 100644 --- a/platform-bible-utils/functions/scrRefToBBBCCCVVV.html +++ b/platform-bible-utils/functions/scrRefToBBBCCCVVV.html @@ -2,4 +2,4 @@

    Parameters

    Returns number

    An integer where the first three digits represent the book, the next three represent the chapter and the last three represent the verse.

    -

    Settings

    Member Visibility
    +

    Settings

    Member Visibility
    diff --git a/platform-bible-utils/functions/serialize.html b/platform-bible-utils/functions/serialize.html index c8123072ed..e81dee0fd3 100644 --- a/platform-bible-utils/functions/serialize.html +++ b/platform-bible-utils/functions/serialize.html @@ -10,4 +10,4 @@
  • Optionalspace: 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
    +

    Returns string

    Settings

    Member Visibility
    diff --git a/platform-bible-utils/functions/slice.html b/platform-bible-utils/functions/slice.html index 5e0964a1a3..088d2daaf3 100644 --- a/platform-bible-utils/functions/slice.html +++ b/platform-bible-utils/functions/slice.html @@ -6,4 +6,4 @@
  • indexStart: number

    The index of the first character to include in the returned substring.

  • OptionalindexEnd: number

    The index of the first character to exclude from the returned substring.

    • Returns string

    A new string containing the extracted section of the string.

    -

    Settings

    Member Visibility
    +

    Settings

    Member Visibility
    diff --git a/platform-bible-utils/functions/split.html b/platform-bible-utils/functions/split.html index faf96bb807..0062c97a71 100644 --- a/platform-bible-utils/functions/split.html +++ b/platform-bible-utils/functions/split.html @@ -9,4 +9,4 @@ in the array.

    Returns string[]

    An array of strings, split at each point where separator occurs in the starting string. Returns undefined if separator is not found in string.

    -

    Settings

    Member Visibility
    +

    Settings

    Member Visibility
    diff --git a/platform-bible-utils/functions/startsWith.html b/platform-bible-utils/functions/startsWith.html index cd60fc3e8f..4d1461257e 100644 --- a/platform-bible-utils/functions/startsWith.html +++ b/platform-bible-utils/functions/startsWith.html @@ -8,4 +8,4 @@ searchString's first character). Default is 0

    Returns boolean

    True if the given characters are found at the beginning of the string, including when searchString is an empty string; otherwise, false.

    -

    Settings

    Member Visibility
    +

    Settings

    Member Visibility
    diff --git a/platform-bible-utils/functions/stringLength.html b/platform-bible-utils/functions/stringLength.html index ec467a9e0a..42a3a0a0a0 100644 --- a/platform-bible-utils/functions/stringLength.html +++ b/platform-bible-utils/functions/stringLength.html @@ -4,4 +4,4 @@

    Returns the length of a string.

    Parameters

    Returns number

    Number that is length of the starting string

    -

    Settings

    Member Visibility
    +

    Settings

    Member Visibility
    diff --git a/platform-bible-utils/functions/substring.html b/platform-bible-utils/functions/substring.html index c322f01578..43e594be0e 100644 --- a/platform-bible-utils/functions/substring.html +++ b/platform-bible-utils/functions/substring.html @@ -5,4 +5,4 @@
  • begin: number

    Start position

  • end: number = ...

    End position. Default is End of string

    • Returns string

    Substring from starting string

    -

    Settings

    Member Visibility
    +

    Settings

    Member Visibility
    diff --git a/platform-bible-utils/functions/toArray.html b/platform-bible-utils/functions/toArray.html index 6c31fc794a..73e5c2f8f7 100644 --- a/platform-bible-utils/functions/toArray.html +++ b/platform-bible-utils/functions/toArray.html @@ -3,4 +3,4 @@

    Converts a string to an array of string characters.

    Parameters

    Returns string[]

    An array of characters from the starting string

    -

    Settings

    Member Visibility
    +

    Settings

    Member Visibility
    diff --git a/platform-bible-utils/functions/transformAndEnsureRegExpArray.html b/platform-bible-utils/functions/transformAndEnsureRegExpArray.html index 959da9f514..5c5262a0be 100644 --- a/platform-bible-utils/functions/transformAndEnsureRegExpArray.html +++ b/platform-bible-utils/functions/transformAndEnsureRegExpArray.html @@ -8,4 +8,4 @@

    Parameters

    Returns RegExp[]

    An array of RegExp objects. If the input is undefined, an empty array is returned.

    -

    Settings

    Member Visibility
    +

    Settings

    Member Visibility
    diff --git a/platform-bible-utils/functions/transformAndEnsureRegExpRegExpArray.html b/platform-bible-utils/functions/transformAndEnsureRegExpRegExpArray.html index bd533e24c5..92fcb9c44b 100644 --- a/platform-bible-utils/functions/transformAndEnsureRegExpRegExpArray.html +++ b/platform-bible-utils/functions/transformAndEnsureRegExpRegExpArray.html @@ -12,4 +12,4 @@ array of strings or arrays of strings, or undefined.

    Returns (RegExp | RegExp[])[]

    An array of RegExp objects or arrays of RegExp objects. If the input is undefined, an empty array is returned.

    -

    Settings

    Member Visibility
    +

    Settings

    Member Visibility
    diff --git a/platform-bible-utils/functions/wait.html b/platform-bible-utils/functions/wait.html index 7e3d697a7f..6d4b6b340d 100644 --- a/platform-bible-utils/functions/wait.html +++ b/platform-bible-utils/functions/wait.html @@ -1,2 +1,2 @@ wait | platform-bible-utils

    Functionwait

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

    Parameters

    Returns Promise<void>

    Settings

    Member Visibility
    diff --git a/platform-bible-utils/functions/waitForDuration.html b/platform-bible-utils/functions/waitForDuration.html index f034b76708..773950f2f9 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
    +

    Settings

    Member Visibility
    diff --git a/platform-bible-utils/interfaces/BookInfo.html b/platform-bible-utils/interfaces/BookInfo.html index ee9df61b63..7576d6883a 100644 --- a/platform-bible-utils/interfaces/BookInfo.html +++ b/platform-bible-utils/interfaces/BookInfo.html @@ -1,4 +1,4 @@ -BookInfo | platform-bible-utils

    InterfaceBookInfo

    interface BookInfo {
        chapters: number;
        fullNames: string[];
        shortName: string;
    }

    Properties

    chapters +BookInfo | platform-bible-utils

    InterfaceBookInfo

    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

    On This Page

    Properties
    +

    Properties

    chapters

    chapters: number

    fullNames

    fullNames: string[]

    shortName

    shortName: string

    Settings

    Member Visibility

    On This Page

    Properties
    diff --git a/platform-bible-utils/interfaces/CannotHaveOnDidDispose.html b/platform-bible-utils/interfaces/CannotHaveOnDidDispose.html index 892fda602f..b3c0d6ea9d 100644 --- a/platform-bible-utils/interfaces/CannotHaveOnDidDispose.html +++ b/platform-bible-utils/interfaces/CannotHaveOnDidDispose.html @@ -1,7 +1,7 @@ CannotHaveOnDidDispose | platform-bible-utils

    InterfaceCannotHaveOnDidDispose

    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

    Optionaldispose

    dispose?: UnsubscriberAsync

    Release resources and notify dependent services when tearing down an object

    -

    OptionalonDidDispose

    onDidDispose?: undefined

    Event that emits when dispose is called on an object

    -

    Settings

    Member Visibility

    On This Page

    Properties
    +

    OptionalonDidDispose

    onDidDispose?: undefined

    Event that emits when dispose is called on an object

    +

    Settings

    Member Visibility

    On This Page

    Properties
    diff --git a/platform-bible-utils/interfaces/Dispose.html b/platform-bible-utils/interfaces/Dispose.html index cb2bb605d1..4e93da925a 100644 --- a/platform-bible-utils/interfaces/Dispose.html +++ b/platform-bible-utils/interfaces/Dispose.html @@ -1,4 +1,4 @@ Dispose | platform-bible-utils

    InterfaceDispose

    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

    On This Page

    Properties
    +

    Settings

    Member Visibility

    On This Page

    Properties
    diff --git a/platform-bible-utils/interfaces/IUsjReaderWriter.html b/platform-bible-utils/interfaces/IUsjReaderWriter.html index e24f78d8c0..f173f479b0 100644 --- a/platform-bible-utils/interfaces/IUsjReaderWriter.html +++ b/platform-bible-utils/interfaces/IUsjReaderWriter.html @@ -1,5 +1,5 @@ IUsjReaderWriter | platform-bible-utils

    InterfaceIUsjReaderWriter

    Utilities for reading from and writing to Usj objects

    -
    interface IUsjReaderWriter {
        extractText(start: UsjContentLocation, desiredLength: number): string;
        extractTextBetweenPoints(start: UsjContentLocation, end: UsjContentLocation, maxLength: number): string;
        findNextLocationOfMatchingText(start: UsjContentLocation, text: string, maxTextLengthToSearch: number): undefined | UsjContentLocation;
        findParent<T>(jsonPathQuery: string): undefined | T;
        findSingleValue<T>(jsonPathQuery: string): undefined | T;
        jsonPathToVerseRefAndOffset(jsonPathQuery: string, bookId?: string): VerseRefOffset;
        nodeToJsonPath(node: MarkerObject): ContentJsonPath;
        nodeToVerseRefAndOffset(bookId: string, node: MarkerContent, nodeParent: undefined | MarkerObject | MarkerContent[]): undefined | {
            offset: number;
            verseRef: VerseRef;
        };
        removeContentNodes(searchFunction: ((potentiallyMatchingNode: MarkerContent) => boolean)): number;
        usjChanged(): void;
        verseRefToUsjContentLocation(verseRef: VerseRef, verseRefOffset: number): UsjContentLocation;
    }

    Implemented by

    Methods

    extractText +
    interface IUsjReaderWriter {
        extractText(start: UsjContentLocation, desiredLength: number): string;
        extractTextBetweenPoints(start: UsjContentLocation, end: UsjContentLocation, maxLength: number): string;
        findNextLocationOfMatchingText(start: UsjContentLocation, text: string, maxTextLengthToSearch: number): undefined | UsjContentLocation;
        findParent<T>(jsonPathQuery: string): undefined | T;
        findSingleValue<T>(jsonPathQuery: string): undefined | T;
        jsonPathToVerseRefAndOffset(jsonPathQuery: string, bookId?: string): VerseRefOffset;
        nodeToJsonPath(node: MarkerObject): ContentJsonPath;
        nodeToVerseRefAndOffset(bookId: string, node: MarkerContent, nodeParent: undefined | MarkerObject | MarkerContent[]): undefined | {
            offset: number;
            verseRef: VerseRef;
        };
        removeContentNodes(searchFunction: ((potentiallyMatchingNode: MarkerContent) => boolean)): number;
        usjChanged(): void;
        verseRefToUsjContentLocation(verseRef: VerseRef, verseRefOffset: number): UsjContentLocation;
    }

    Implemented by

    Methods

    extractText extractTextBetweenPoints findNextLocationOfMatchingText findParent @@ -13,12 +13,12 @@

    Methods

    extractText

    extractTextBetweenPoints

    • extractTextBetweenPoints(start, end, maxLength): string

    • Return a copy of text between two points

      +

    Returns string

    extractTextBetweenPoints

    findNextLocationOfMatchingText

    findNextLocationOfMatchingText

    • findNextLocationOfMatchingText(start, text, maxTextLengthToSearch): undefined | UsjContentLocation

    • Given a starting point, find the next location in this USJ data that matches the given text

      Parameters

      • start: UsjContentLocation

        Point where the search for text will start

      • text: string

        Text to find

      • maxTextLengthToSearch: number

        Maximum length of text to search before stopping (default is 1000)

        @@ -27,17 +27,17 @@ indicates the location of the of USJ node within usj. Note that if the USJ node returned is an object, it is the same object that is within this USJ data. So if you change it, you are changing this USJ data.

        -

    findParent

    findSingleValue

    jsonPathToVerseRefAndOffset

    findParent

    findSingleValue

    jsonPathToVerseRefAndOffset

    • jsonPathToVerseRefAndOffset(jsonPathQuery, bookId?): VerseRefOffset

    • Convert a JSONPath query into a VerseRef and offset

      Parameters

      • jsonPathQuery: string

        JSONPath search expression that indicates a node within this USJ data. If the expression matches more than one node, then only the first node found is considered.

      • OptionalbookId: string

        3 letter ID of the book being searched (must be defined in this USJ data if not provided here)

      Returns VerseRefOffset

      VerseRef and offset that represents the location within this USJ data indicated by jsonPathQuery

      -

    nodeToJsonPath

    nodeToVerseRefAndOffset

    nodeToJsonPath

    nodeToVerseRefAndOffset

    • nodeToVerseRefAndOffset(bookId, node, nodeParent): undefined | {
          offset: number;
          verseRef: VerseRef;
      }

    • Determine the VerseRef and offset that correspond to the location of a node somewhere within this USJ data

      Parameters

      • bookId: string

        ID of the book represented by this USJ data

      • node: MarkerContent

        JSON object representing the location of the VerseRef and offset

        @@ -45,12 +45,12 @@ 'undefined' is provided then the UsjReaderWriter will attempt to lookup the parent of node. The lookup will always fail and throw an error if node is a string.

      Returns undefined | {
          offset: number;
          verseRef: VerseRef;
      }

      VerseRef and offset representing the location of node, if one could be found

      -

    removeContentNodes

    removeContentNodes

    • removeContentNodes(searchFunction): number

    • Remove all nodes from this USJ data that match a given search function.

      Parameters

      • searchFunction: ((potentiallyMatchingNode: MarkerContent) => boolean)

        Function that returns true if the given node should be removed

          • (potentiallyMatchingNode): boolean

          • Parameters

            • potentiallyMatchingNode: MarkerContent

            Returns boolean

      Returns number

      Number of nodes removed

      -

    usjChanged

    usjChanged

    verseRefToUsjContentLocation

    verseRefToUsjContentLocation

    • verseRefToUsjContentLocation(verseRef, verseRefOffset): UsjContentLocation

    • Convert a verse ref + offset into a node + offset within this USJ data and a JSONPath query

      Parameters

      • verseRef: VerseRef

        Indicates the book, chapter, and verse of interest to find

      • verseRefOffset: number

        Specific location within verse text (defaults to 0)

      Returns UsjContentLocation

      Object containing the USJ node indicated by verseRef and verseRefOffset, offset @@ -58,4 +58,4 @@ location of the of USJ node within this USJ data. Note that if the USJ node returned is an object, it is the same object that is within this USJ data. So if you change it, you are changing this USJ data.

      -

    Settings

    Member Visibility

    On This Page

    Methods
    +

    Settings

    Member Visibility

    On This Page

    Methods
    diff --git a/platform-bible-utils/interfaces/LanguageStrings.html b/platform-bible-utils/interfaces/LanguageStrings.html index 29212330e6..c3288278bd 100644 --- a/platform-bible-utils/interfaces/LanguageStrings.html +++ b/platform-bible-utils/interfaces/LanguageStrings.html @@ -1,3 +1,3 @@ LanguageStrings | platform-bible-utils

    InterfaceLanguageStrings

    Map whose keys are localized string keys and whose values provide information about how to localize strings for the localized string key

    -

    Indexable

    Settings

    Member Visibility
    +

    Indexable

    Settings

    Member Visibility
    diff --git a/platform-bible-utils/interfaces/LocalizedStringDataContribution.html b/platform-bible-utils/interfaces/LocalizedStringDataContribution.html index 931f36c472..f77a98dc42 100644 --- a/platform-bible-utils/interfaces/LocalizedStringDataContribution.html +++ b/platform-bible-utils/interfaces/LocalizedStringDataContribution.html @@ -1,4 +1,4 @@ LocalizedStringDataContribution | platform-bible-utils

    InterfaceLocalizedStringDataContribution

    The data an extension provides to inform Platform.Bible of the localized strings it provides.

    -
    interface LocalizedStringDataContribution {
        localizedStrings?: {
            [k: string]: LanguageStrings;
        };
        metadata?: StringsMetadata;
        [k: string]: unknown;
    }

    Indexable

    • [k: string]: unknown

    Properties

    localizedStrings? +
    interface LocalizedStringDataContribution {
        localizedStrings?: {
            [k: string]: LanguageStrings;
        };
        metadata?: StringsMetadata;
        [k: string]: unknown;
    }

    Indexable

    • [k: string]: unknown

    Properties

    localizedStrings? metadata? -

    Properties

    OptionallocalizedStrings

    localizedStrings?: {
        [k: string]: LanguageStrings;
    }

    Optionalmetadata

    metadata?: StringsMetadata

    Settings

    Member Visibility

    On This Page

    Properties
    +

    Properties

    OptionallocalizedStrings

    localizedStrings?: {
        [k: string]: LanguageStrings;
    }

    Optionalmetadata

    metadata?: StringsMetadata

    Settings

    Member Visibility

    On This Page

    Properties
    diff --git a/platform-bible-utils/interfaces/ModifierExtensionControlled.html b/platform-bible-utils/interfaces/ModifierExtensionControlled.html index dceef34ba4..dbeb7b6792 100644 --- a/platform-bible-utils/interfaces/ModifierExtensionControlled.html +++ b/platform-bible-utils/interfaces/ModifierExtensionControlled.html @@ -1,6 +1,6 @@ ModifierExtensionControlled | platform-bible-utils

    InterfaceModifierExtensionControlled

    Modifies state/setting type to be extension-controlled. "Extension-controlled" means the extension provides the component and the validator for the state/setting, so the state/setting is controlled by the extension.

    -
    interface ModifierExtensionControlled {
        platformType?: undefined;
        type?: undefined;
        [k: string]: unknown;
    }

    Indexable

    • [k: string]: unknown

    Properties

    platformType? +
    interface ModifierExtensionControlled {
        platformType?: undefined;
        type?: undefined;
        [k: string]: unknown;
    }

    Indexable

    • [k: string]: unknown

    Properties

    platformType? type? -

    Properties

    OptionalplatformType

    platformType?: undefined

    Optionaltype

    type?: undefined

    Settings

    Member Visibility

    On This Page

    Properties
    +

    Properties

    OptionalplatformType

    platformType?: undefined

    Optionaltype

    type?: undefined

    Settings

    Member Visibility

    On This Page

    Properties
    diff --git a/platform-bible-utils/interfaces/ModifierProject.html b/platform-bible-utils/interfaces/ModifierProject.html index 1257384d32..2f89b537bd 100644 --- a/platform-bible-utils/interfaces/ModifierProject.html +++ b/platform-bible-utils/interfaces/ModifierProject.html @@ -1,4 +1,4 @@ -ModifierProject | platform-bible-utils

    InterfaceModifierProject

    interface ModifierProject {
        excludePdpFactoryIds?: string | string[];
        excludeProjectInterfaces?: string | (string | string[])[];
        includePdpFactoryIds?: string | string[];
        includeProjectInterfaces?: string | (string | string[])[];
    }

    Properties

    excludePdpFactoryIds? +ModifierProject | platform-bible-utils

    InterfaceModifierProject

    interface ModifierProject {
        excludePdpFactoryIds?: string | string[];
        excludeProjectInterfaces?: string | (string | string[])[];
        includePdpFactoryIds?: string | string[];
        includeProjectInterfaces?: string | (string | string[])[];
    }

    Properties

    excludePdpFactoryIds? excludeProjectInterfaces? includePdpFactoryIds? includeProjectInterfaces? @@ -8,7 +8,7 @@ function) to determine if the projects should absolutely not be included even if they match with includeProjectInterfaces.

    Defaults to none, so all projects that match includePdpFactoryIds will be included

    -

    OptionalexcludeProjectInterfaces

    excludeProjectInterfaces?: string | (string | string[])[]

    String representation of RegExp pattern(s) to match against projects' projectInterfaces +

    OptionalexcludeProjectInterfaces

    excludeProjectInterfaces?: string | (string | string[])[]

    String representation of RegExp pattern(s) to match against projects' projectInterfaces (using the test function) to determine if they should absolutely not be included even if they match with @@ -27,7 +27,7 @@ second-level arrays (arrays within the first-level array) are AND'ed together.

    Defaults to no ProjectInterfaces, so all projects that match includeProjectInterfaces will be included

    -

    Example

    excludeProjectInterfaces: ['one', ['two', 'three']];
+

    Example

    excludeProjectInterfaces: ['one', ['two', 'three']];

    This filter condition will succeed and exclude projects whose projectInterfaces fulfill at @@ -36,13 +36,13 @@

  • Include one
  • Include both two and three.
    • -

    OptionalincludePdpFactoryIds

    includePdpFactoryIds?: string | string[]

    String representation of RegExp pattern(s) to match against the Project Data Provider Factory +

    OptionalincludePdpFactoryIds

    includePdpFactoryIds?: string | string[]

    String representation of RegExp pattern(s) to match against the Project Data Provider Factory Ids that provided each project's metadata (using the test function) to determine if the projects should be included.

    Defaults to all Project Data Provider Factory Ids, so all projects that do not match excludePdpFactoryIds will be included

    -

    OptionalincludeProjectInterfaces

    includeProjectInterfaces?: string | (string | string[])[]

    String representation of RegExp pattern(s) to match against projects' projectInterfaces +

    OptionalincludeProjectInterfaces

    includeProjectInterfaces?: string | (string | string[])[]

    String representation of RegExp pattern(s) to match against projects' projectInterfaces (using the test function) to determine if they should be included.

    @@ -60,7 +60,7 @@ second-level arrays (arrays within the first-level array) are AND'ed together.

    Defaults to all ProjectInterfaces, so all projects that do not match excludeProjectInterfaces will be included

    -

    Example

    includeProjectInterfaces: ['one', ['two', 'three']];
+

    Example

    includeProjectInterfaces: ['one', ['two', 'three']];

    This filter condition will succeed on projects whose projectInterfaces fulfill at least one @@ -69,4 +69,4 @@

  • Include one
  • Include both two and three.
    • -

    Settings

    Member Visibility

    On This Page

    Properties
    +

    Settings

    Member Visibility

    On This Page

    Properties
    diff --git a/platform-bible-utils/interfaces/OnDidDispose.html b/platform-bible-utils/interfaces/OnDidDispose.html index 9d37aea3f7..26149d3882 100644 --- a/platform-bible-utils/interfaces/OnDidDispose.html +++ b/platform-bible-utils/interfaces/OnDidDispose.html @@ -1,4 +1,4 @@ OnDidDispose | platform-bible-utils

    InterfaceOnDidDispose

    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

    On This Page

    Properties
    +

    Settings

    Member Visibility

    On This Page

    Properties
    diff --git a/platform-bible-utils/interfaces/ProjectSettingProperties.html b/platform-bible-utils/interfaces/ProjectSettingProperties.html index 0db69a673c..0b21a09a06 100644 --- a/platform-bible-utils/interfaces/ProjectSettingProperties.html +++ b/platform-bible-utils/interfaces/ProjectSettingProperties.html @@ -1,2 +1,2 @@ ProjectSettingProperties | platform-bible-utils

    InterfaceProjectSettingProperties

    Object whose keys are setting IDs and whose values are settings objects

    -

    Indexable

    Settings

    Member Visibility
    +

    Indexable

    Settings

    Member Visibility
    diff --git a/platform-bible-utils/interfaces/ProjectSettingsGroup.html b/platform-bible-utils/interfaces/ProjectSettingsGroup.html index 3243c766e8..2366b219e0 100644 --- a/platform-bible-utils/interfaces/ProjectSettingsGroup.html +++ b/platform-bible-utils/interfaces/ProjectSettingsGroup.html @@ -1,7 +1,7 @@ ProjectSettingsGroup | platform-bible-utils

    InterfaceProjectSettingsGroup

    Group of related settings definitions

    -
    interface ProjectSettingsGroup {
        description?: `%${string}%`;
        label: `%${string}%`;
        properties: ProjectSettingProperties;
        [k: string]: unknown;
    }

    Indexable

    • [k: string]: unknown

    Properties

    description? +
    interface ProjectSettingsGroup {
        description?: `%${string}%`;
        label: `%${string}%`;
        properties: ProjectSettingProperties;
        [k: string]: unknown;
    }

    Indexable

    • [k: string]: unknown

    Properties

    description? label properties

    Properties

    Optionaldescription

    description?: `%${string}%`

    LocalizeKey that displays in the project settings dialog to describe the group

    -

    label

    label: `%${string}%`

    LocalizeKey that displays in the project settings dialog as the group name

    -

    properties

    properties: ProjectSettingProperties

    Settings

    Member Visibility

    On This Page

    Properties
    +

    label

    label: `%${string}%`

    LocalizeKey that displays in the project settings dialog as the group name

    +

    properties

    properties: ProjectSettingProperties

    Settings

    Member Visibility

    On This Page

    Properties
    diff --git a/platform-bible-utils/interfaces/ProjectStateContribution.html b/platform-bible-utils/interfaces/ProjectStateContribution.html index 15df664b5c..ebef8fcf21 100644 --- a/platform-bible-utils/interfaces/ProjectStateContribution.html +++ b/platform-bible-utils/interfaces/ProjectStateContribution.html @@ -1,2 +1,2 @@ ProjectStateContribution | platform-bible-utils

    InterfaceProjectStateContribution

    The data an extension provides to inform Platform.Bible of the project state it provides

    -

    Indexable

    Settings

    Member Visibility
    +

    Indexable

    Settings

    Member Visibility
    diff --git a/platform-bible-utils/interfaces/ScriptureReference.html b/platform-bible-utils/interfaces/ScriptureReference.html index c843d6318a..4bb8495932 100644 --- a/platform-bible-utils/interfaces/ScriptureReference.html +++ b/platform-bible-utils/interfaces/ScriptureReference.html @@ -1,4 +1,4 @@ -ScriptureReference | platform-bible-utils

    InterfaceScriptureReference

    interface ScriptureReference {
        bookNum: number;
        chapterNum: number;
        verseNum: number;
    }

    Properties

    bookNum +ScriptureReference | platform-bible-utils

    InterfaceScriptureReference

    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

    On This Page

    Properties
    +

    Properties

    bookNum

    bookNum: number

    chapterNum

    chapterNum: number

    verseNum

    verseNum: number

    Settings

    Member Visibility

    On This Page

    Properties
    diff --git a/platform-bible-utils/interfaces/SettingProperties.html b/platform-bible-utils/interfaces/SettingProperties.html index 0ee1bf1134..70859a3342 100644 --- a/platform-bible-utils/interfaces/SettingProperties.html +++ b/platform-bible-utils/interfaces/SettingProperties.html @@ -1,2 +1,2 @@ SettingProperties | platform-bible-utils

    InterfaceSettingProperties

    Object whose keys are setting IDs and whose values are settings objects

    -

    Indexable

    Settings

    Member Visibility
    +

    Indexable

    Settings

    Member Visibility
    diff --git a/platform-bible-utils/interfaces/SettingsGroup.html b/platform-bible-utils/interfaces/SettingsGroup.html index e49ce12be7..cae00f1bd6 100644 --- a/platform-bible-utils/interfaces/SettingsGroup.html +++ b/platform-bible-utils/interfaces/SettingsGroup.html @@ -1,7 +1,7 @@ SettingsGroup | platform-bible-utils

    InterfaceSettingsGroup

    Group of related settings definitions

    -
    interface SettingsGroup {
        description?: `%${string}%`;
        label: `%${string}%`;
        properties: SettingProperties;
        [k: string]: unknown;
    }

    Indexable

    • [k: string]: unknown

    Properties

    description? +
    interface SettingsGroup {
        description?: `%${string}%`;
        label: `%${string}%`;
        properties: SettingProperties;
        [k: string]: unknown;
    }

    Indexable

    • [k: string]: unknown

    Properties

    description? label properties

    Properties

    Optionaldescription

    description?: `%${string}%`

    LocalizeKey that displays in the settings dialog to describe the group

    -

    label

    label: `%${string}%`

    LocalizeKey that displays in the settings dialog as the group name

    -

    properties

    properties: SettingProperties

    Settings

    Member Visibility

    On This Page

    Properties
    +

    label

    label: `%${string}%`

    LocalizeKey that displays in the settings dialog as the group name

    +

    properties

    properties: SettingProperties

    Settings

    Member Visibility

    On This Page

    Properties
    diff --git a/platform-bible-utils/interfaces/StateBase.html b/platform-bible-utils/interfaces/StateBase.html index a8fba3a291..f512e2ab21 100644 --- a/platform-bible-utils/interfaces/StateBase.html +++ b/platform-bible-utils/interfaces/StateBase.html @@ -1,7 +1,7 @@ StateBase | platform-bible-utils

    InterfaceStateBase

    Base information needed to describe a state entry

    -
    interface StateBase {
        default: unknown;
        derivesFrom?: `${string}.${string}`;
        [k: string]: unknown;
    }

    Indexable

    • [k: string]: unknown

    Properties

    default +
    interface StateBase {
        default: unknown;
        derivesFrom?: `${string}.${string}`;
        [k: string]: unknown;
    }

    Indexable

    • [k: string]: unknown

    Properties

    default derivesFrom?

    Properties

    default

    default: unknown

    Default value for the state/setting

    -

    OptionalderivesFrom

    derivesFrom?: `${string}.${string}`

    A state/setting ID whose value to set to this state/setting's starting value the first time +

    OptionalderivesFrom

    derivesFrom?: `${string}.${string}`

    A state/setting ID whose value to set to this state/setting's starting value the first time this state/setting is loaded

    -

    Settings

    Member Visibility

    On This Page

    Properties
    +

    Settings

    Member Visibility

    On This Page

    Properties
    diff --git a/platform-bible-utils/interfaces/StringMetadata.html b/platform-bible-utils/interfaces/StringMetadata.html index fdaadc58d2..851ee8a1d9 100644 --- a/platform-bible-utils/interfaces/StringMetadata.html +++ b/platform-bible-utils/interfaces/StringMetadata.html @@ -1,11 +1,11 @@ StringMetadata | platform-bible-utils

    InterfaceStringMetadata

    Additional non-locale-specific information about a localized string key

    -
    interface StringMetadata {
        fallbackKey?: `%${string}%`;
        notes?: string;
        [k: string]: unknown;
    }

    Indexable

    • [k: string]: unknown

    Properties

    fallbackKey? +
    interface StringMetadata {
        fallbackKey?: `%${string}%`;
        notes?: string;
        [k: string]: unknown;
    }

    Indexable

    • [k: string]: unknown

    Properties

    fallbackKey? notes?

    Properties

    OptionalfallbackKey

    fallbackKey?: `%${string}%`

    Localized string key from which to get this value if one does not exist in the specified language. If a new key/value pair needs to be made to replace an existing one, this could help smooth over the transition if the meanings are close enough

    You can use Paratext 9 Localized String Keys here. Be sure to escape any % signs with a backslash ``.

    -

    Optionalnotes

    notes?: string

    Additional information provided by developers in English to help the translator to know how to +

    Optionalnotes

    notes?: string

    Additional information provided by developers in English to help the translator to know how to translate this localized string accurately

    -

    Settings

    Member Visibility

    On This Page

    Properties
    +

    Settings

    Member Visibility

    On This Page

    Properties
    diff --git a/platform-bible-utils/interfaces/StringsMetadata.html b/platform-bible-utils/interfaces/StringsMetadata.html index 38e05278c7..148d1de046 100644 --- a/platform-bible-utils/interfaces/StringsMetadata.html +++ b/platform-bible-utils/interfaces/StringsMetadata.html @@ -1,3 +1,3 @@ StringsMetadata | platform-bible-utils

    InterfaceStringsMetadata

    Map whose keys are localized string keys and whose values provide additional non-locale-specific information about the localized string key

    -

    Indexable

    Settings

    Member Visibility
    +

    Indexable

    Settings

    Member Visibility
    diff --git a/platform-bible-utils/interfaces/UserStateContribution.html b/platform-bible-utils/interfaces/UserStateContribution.html index b344fd7580..c193738380 100644 --- a/platform-bible-utils/interfaces/UserStateContribution.html +++ b/platform-bible-utils/interfaces/UserStateContribution.html @@ -1,2 +1,2 @@ UserStateContribution | platform-bible-utils

    InterfaceUserStateContribution

    The data an extension provides to inform Platform.Bible of the user state it provides

    -

    Indexable

    Settings

    Member Visibility
    +

    Indexable

    Settings

    Member Visibility
    diff --git a/platform-bible-utils/modules.html b/platform-bible-utils/modules.html index 6059a2654b..786eb2f036 100644 --- a/platform-bible-utils/modules.html +++ b/platform-bible-utils/modules.html @@ -102,6 +102,7 @@ escapeStringRegexp formatBytes formatReplacementString +formatReplacementStringToArray formatScrRef getAllObjectFunctionNames getChaptersForBook diff --git a/platform-bible-utils/types/CanHaveOnDidDispose.html b/platform-bible-utils/types/CanHaveOnDidDispose.html index 6e5a974e12..9b5c180482 100644 --- a/platform-bible-utils/types/CanHaveOnDidDispose.html +++ b/platform-bible-utils/types/CanHaveOnDidDispose.html @@ -1,2 +1,2 @@ CanHaveOnDidDispose | platform-bible-utils

    Type AliasCanHaveOnDidDispose<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
    +

    Type Parameters

    Settings

    Member Visibility
    diff --git a/platform-bible-utils/types/ColumnsWithHeaders.html b/platform-bible-utils/types/ColumnsWithHeaders.html index 14b6e057a6..9e3d5ac5af 100644 --- a/platform-bible-utils/types/ColumnsWithHeaders.html +++ b/platform-bible-utils/types/ColumnsWithHeaders.html @@ -1,4 +1,4 @@ ColumnsWithHeaders | platform-bible-utils

    Type AliasColumnsWithHeaders

    ColumnsWithHeaders: {
        isExtensible?: boolean;
        [property: ReferencedItem]: MenuColumnWithHeader;
    }

    Group of columns that can be combined with other columns to form a multi-column menu

    Type declaration

    Settings

    Member Visibility
    +

    Settings

    Member Visibility
    diff --git a/platform-bible-utils/types/DeepPartial.html b/platform-bible-utils/types/DeepPartial.html index 96adc5f8a8..d19350789b 100644 --- a/platform-bible-utils/types/DeepPartial.html +++ b/platform-bible-utils/types/DeepPartial.html @@ -1,2 +1,2 @@ DeepPartial | platform-bible-utils

    Type AliasDeepPartial<T>

    DeepPartial<T>: T extends object
        ? {
            [P in keyof T]?: DeepPartial<T[P]>
        }
        : T

    Within type T, recursively change all properties to be optional

    -

    Type Parameters

    • T

    Settings

    Member Visibility
    +

    Type Parameters

    • T

    Settings

    Member Visibility
    diff --git a/platform-bible-utils/types/DocumentCombinerOptions.html b/platform-bible-utils/types/DocumentCombinerOptions.html index d859ba7900..911b51491f 100644 --- a/platform-bible-utils/types/DocumentCombinerOptions.html +++ b/platform-bible-utils/types/DocumentCombinerOptions.html @@ -7,4 +7,4 @@ contributed documents. If false, then throw when duplicate properties are seen in contributed documents. -

    Settings

    Member Visibility
    +

    Settings

    Member Visibility
    diff --git a/platform-bible-utils/types/ExtensionControlledProjectSetting.html b/platform-bible-utils/types/ExtensionControlledProjectSetting.html index ee61cd6d46..2f45f42769 100644 --- a/platform-bible-utils/types/ExtensionControlledProjectSetting.html +++ b/platform-bible-utils/types/ExtensionControlledProjectSetting.html @@ -1,2 +1,2 @@ ExtensionControlledProjectSetting | platform-bible-utils

    Type AliasExtensionControlledProjectSetting

    ExtensionControlledProjectSetting: ProjectSettingBase & ModifierExtensionControlled

    Setting definition that is validated by the extension.

    -

    Settings

    Member Visibility
    +

    Settings

    Member Visibility
    diff --git a/platform-bible-utils/types/ExtensionControlledSetting.html b/platform-bible-utils/types/ExtensionControlledSetting.html index 3dbfe293eb..a965a6cf9e 100644 --- a/platform-bible-utils/types/ExtensionControlledSetting.html +++ b/platform-bible-utils/types/ExtensionControlledSetting.html @@ -1,2 +1,2 @@ ExtensionControlledSetting | platform-bible-utils

    Type AliasExtensionControlledSetting

    ExtensionControlledSetting: SettingBase & ModifierExtensionControlled

    Setting definition that is validated by the extension.

    -

    Settings

    Member Visibility
    +

    Settings

    Member Visibility
    diff --git a/platform-bible-utils/types/ExtensionControlledState.html b/platform-bible-utils/types/ExtensionControlledState.html index eb4a1efa49..67d1f7190a 100644 --- a/platform-bible-utils/types/ExtensionControlledState.html +++ b/platform-bible-utils/types/ExtensionControlledState.html @@ -1,2 +1,2 @@ ExtensionControlledState | platform-bible-utils

    Type AliasExtensionControlledState

    ExtensionControlledState: StateBase & ModifierExtensionControlled

    State definition that is validated by the extension.

    -

    Settings

    Member Visibility
    +

    Settings

    Member Visibility
    diff --git a/platform-bible-utils/types/GroupsInMultiColumnMenu.html b/platform-bible-utils/types/GroupsInMultiColumnMenu.html index 6a427a3fb0..7075eaa1cb 100644 --- a/platform-bible-utils/types/GroupsInMultiColumnMenu.html +++ b/platform-bible-utils/types/GroupsInMultiColumnMenu.html @@ -1,4 +1,4 @@ GroupsInMultiColumnMenu | platform-bible-utils

    Type AliasGroupsInMultiColumnMenu

    GroupsInMultiColumnMenu: {
        [property: ReferencedItem]: MenuGroupDetailsInColumn | MenuGroupDetailsInSubMenu;
    }

    Group of menu items that can be combined with other groups to form a single menu/submenu within a multi-column menu. Groups are separated using a line within the menu/submenu.

    Type declaration

    Settings

    Member Visibility
    +

    Settings

    Member Visibility
    diff --git a/platform-bible-utils/types/GroupsInSingleColumnMenu.html b/platform-bible-utils/types/GroupsInSingleColumnMenu.html index 57f9c313a4..f94223075e 100644 --- a/platform-bible-utils/types/GroupsInSingleColumnMenu.html +++ b/platform-bible-utils/types/GroupsInSingleColumnMenu.html @@ -1,4 +1,4 @@ GroupsInSingleColumnMenu | platform-bible-utils

    Type AliasGroupsInSingleColumnMenu

    GroupsInSingleColumnMenu: {
        [property: ReferencedItem]: OrderedExtensibleContainer | MenuGroupDetailsInSubMenu;
    }

    Group of menu items that can be combined with other groups to form a single context menu/submenu. Groups are separated using a line within the menu/submenu.

    Type declaration

    Settings

    Member Visibility
    +

    Settings

    Member Visibility
    diff --git a/platform-bible-utils/types/JsonDocumentLike.html b/platform-bible-utils/types/JsonDocumentLike.html index faac0a81ae..193bc928d4 100644 --- a/platform-bible-utils/types/JsonDocumentLike.html +++ b/platform-bible-utils/types/JsonDocumentLike.html @@ -1 +1 @@ -JsonDocumentLike | platform-bible-utils

    Type AliasJsonDocumentLike

    JsonDocumentLike: JsonObjectLike | JsonArrayLike

    Settings

    Member Visibility
    +JsonDocumentLike | platform-bible-utils

    Type AliasJsonDocumentLike

    JsonDocumentLike: JsonObjectLike | JsonArrayLike

    Settings

    Member Visibility
    diff --git a/platform-bible-utils/types/LocalizeKey.html b/platform-bible-utils/types/LocalizeKey.html index 66d1ebdf3d..1089cad75d 100644 --- a/platform-bible-utils/types/LocalizeKey.html +++ b/platform-bible-utils/types/LocalizeKey.html @@ -1,2 +1,2 @@ LocalizeKey | platform-bible-utils

    Type AliasLocalizeKey

    LocalizeKey: `%${string}%`

    Identifier for a string that will be localized in a menu based on the user's UI language

    -

    Settings

    Member Visibility
    +

    Settings

    Member Visibility
    diff --git a/platform-bible-utils/types/Localized.html b/platform-bible-utils/types/Localized.html index e57283633d..2595806710 100644 --- a/platform-bible-utils/types/Localized.html +++ b/platform-bible-utils/types/Localized.html @@ -1,3 +1,3 @@ Localized | platform-bible-utils

    Type AliasLocalized<T>

    Localized<T>: ReplaceType<ReplaceType<T, LocalizeKey, string>, ReferencedItem, string>

    Type that converts any menu type before it is localized to what it is after it is localized. This can be applied to any menu type as needed.

    -

    Type Parameters

    • T

    Settings

    Member Visibility
    +

    Type Parameters

    • T

    Settings

    Member Visibility
    diff --git a/platform-bible-utils/types/LocalizedStringValue.html b/platform-bible-utils/types/LocalizedStringValue.html index 324b8f89d6..aab20e5295 100644 --- a/platform-bible-utils/types/LocalizedStringValue.html +++ b/platform-bible-utils/types/LocalizedStringValue.html @@ -1,2 +1,2 @@ LocalizedStringValue | platform-bible-utils

    Type AliasLocalizedStringValue

    LocalizedStringValue: string

    Localized string value associated with this key

    -

    Settings

    Member Visibility
    +

    Settings

    Member Visibility
    diff --git a/platform-bible-utils/types/MenuColumnWithHeader.html b/platform-bible-utils/types/MenuColumnWithHeader.html index 82e030c822..08b09e335f 100644 --- a/platform-bible-utils/types/MenuColumnWithHeader.html +++ b/platform-bible-utils/types/MenuColumnWithHeader.html @@ -1,3 +1,3 @@ MenuColumnWithHeader | platform-bible-utils

    Type AliasMenuColumnWithHeader

    MenuColumnWithHeader: OrderedExtensibleContainer & {
        label: LocalizeKey;
    }

    Column that includes header text in a menu

    Type declaration

    • label: LocalizeKey

      Key that represents the text of the header text of the column

      -

    Settings

    Member Visibility
    +

    Settings

    Member Visibility
    diff --git a/platform-bible-utils/types/MenuGroupDetailsInColumn.html b/platform-bible-utils/types/MenuGroupDetailsInColumn.html index c89b33869d..94f2e2eb7e 100644 --- a/platform-bible-utils/types/MenuGroupDetailsInColumn.html +++ b/platform-bible-utils/types/MenuGroupDetailsInColumn.html @@ -1,3 +1,3 @@ MenuGroupDetailsInColumn | platform-bible-utils

    Type AliasMenuGroupDetailsInColumn

    MenuGroupDetailsInColumn: OrderedExtensibleContainer & {
        column: ReferencedItem;
    }

    Group of menu items that belongs in a column

    Type declaration

    Settings

    Member Visibility
    +

    Settings

    Member Visibility
    diff --git a/platform-bible-utils/types/MenuGroupDetailsInSubMenu.html b/platform-bible-utils/types/MenuGroupDetailsInSubMenu.html index aa22db759d..e448fbd588 100644 --- a/platform-bible-utils/types/MenuGroupDetailsInSubMenu.html +++ b/platform-bible-utils/types/MenuGroupDetailsInSubMenu.html @@ -1,3 +1,3 @@ MenuGroupDetailsInSubMenu | platform-bible-utils

    Type AliasMenuGroupDetailsInSubMenu

    MenuGroupDetailsInSubMenu: OrderedExtensibleContainer & {
        menuItem: ReferencedItem;
    }

    Group of menu items that belongs in a submenu

    Type declaration

    • menuItem: ReferencedItem

      ID of menu item hosting the submenu in which this group resides

      -

    Settings

    Member Visibility
    +

    Settings

    Member Visibility
    diff --git a/platform-bible-utils/types/MenuItemBase.html b/platform-bible-utils/types/MenuItemBase.html index b36872f2ee..7535bb0e4e 100644 --- a/platform-bible-utils/types/MenuItemBase.html +++ b/platform-bible-utils/types/MenuItemBase.html @@ -3,4 +3,4 @@
  • localizeNotes: string

    Additional information provided by developers to help people who perform localization

  • OptionalsearchTerms?: LocalizeKey

    Key that represents words the platform should reference when users are searching for menu items

  • Optionaltooltip?: LocalizeKey

    Key that represents the text to display if a mouse pointer hovers over the menu item

    -

    • Settings

    Member Visibility
    +

    Settings

    Member Visibility
    diff --git a/platform-bible-utils/types/MenuItemContainingCommand.html b/platform-bible-utils/types/MenuItemContainingCommand.html index a444e8ac12..79c8d7d95e 100644 --- a/platform-bible-utils/types/MenuItemContainingCommand.html +++ b/platform-bible-utils/types/MenuItemContainingCommand.html @@ -4,4 +4,4 @@ papi-extension://helloWorld/assets/icon.png

  • OptionaliconPathBefore?: string

    Uri path to the icon to display before the menu text. Ex: papi-extension://helloWorld/assets/icon.png

    -

    • Settings

    Member Visibility
    +

    Settings

    Member Visibility
    diff --git a/platform-bible-utils/types/MenuItemContainingSubmenu.html b/platform-bible-utils/types/MenuItemContainingSubmenu.html index b67e6cdd90..0885c6a3cb 100644 --- a/platform-bible-utils/types/MenuItemContainingSubmenu.html +++ b/platform-bible-utils/types/MenuItemContainingSubmenu.html @@ -1,3 +1,3 @@ MenuItemContainingSubmenu | platform-bible-utils

    Type AliasMenuItemContainingSubmenu

    MenuItemContainingSubmenu: MenuItemBase & {
        id: ReferencedItem;
    }

    Menu item that hosts a submenu

    Type declaration

    Settings

    Member Visibility
    +

    Settings

    Member Visibility
    diff --git a/platform-bible-utils/types/MultiColumnMenu.html b/platform-bible-utils/types/MultiColumnMenu.html index 4085989d50..f036b0caeb 100644 --- a/platform-bible-utils/types/MultiColumnMenu.html +++ b/platform-bible-utils/types/MultiColumnMenu.html @@ -2,4 +2,4 @@

    Type declaration

    Settings

    Member Visibility
    +

    Settings

    Member Visibility
    diff --git a/platform-bible-utils/types/OrderedExtensibleContainer.html b/platform-bible-utils/types/OrderedExtensibleContainer.html index 39d9c2ef8a..83428fdec0 100644 --- a/platform-bible-utils/types/OrderedExtensibleContainer.html +++ b/platform-bible-utils/types/OrderedExtensibleContainer.html @@ -1,2 +1,2 @@ OrderedExtensibleContainer | platform-bible-utils

    Type AliasOrderedExtensibleContainer

    OrderedExtensibleContainer: OrderedItem & {
        isExtensible?: boolean;
    }

    Type declaration

    • OptionalisExtensible?: boolean

      Determines whether other items can be added to this after it has been defined

      -

    Settings

    Member Visibility
    +

    Settings

    Member Visibility
    diff --git a/platform-bible-utils/types/OrderedItem.html b/platform-bible-utils/types/OrderedItem.html index 7220b68dfa..7d50f897bf 100644 --- a/platform-bible-utils/types/OrderedItem.html +++ b/platform-bible-utils/types/OrderedItem.html @@ -1,2 +1,2 @@ OrderedItem | platform-bible-utils

    Type AliasOrderedItem

    OrderedItem: {
        order: number;
    }

    Type declaration

    • order: number

      Relative order of this item compared to other items in the same parent/scope (sorted ascending)

      -

    Settings

    Member Visibility
    +

    Settings

    Member Visibility
    diff --git a/platform-bible-utils/types/PlatformEvent.html b/platform-bible-utils/types/PlatformEvent.html index 1b8b752f65..80ca31b8bc 100644 --- a/platform-bible-utils/types/PlatformEvent.html +++ b/platform-bible-utils/types/PlatformEvent.html @@ -2,4 +2,4 @@

    Type Parameters

    • T

    Type declaration

      • (callback): Unsubscriber

      • Parameters

        Returns Unsubscriber

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

        -

    Settings

    Member Visibility
    +

    Settings

    Member Visibility
    diff --git a/platform-bible-utils/types/PlatformEventAsync.html b/platform-bible-utils/types/PlatformEventAsync.html index b6483d9e91..bc250b4763 100644 --- a/platform-bible-utils/types/PlatformEventAsync.html +++ b/platform-bible-utils/types/PlatformEventAsync.html @@ -1,3 +1,3 @@ PlatformEventAsync | platform-bible-utils

    Type AliasPlatformEventAsync<T>

    PlatformEventAsync<T>: ((callback: PlatformEventHandler<T>) => Promise<UnsubscriberAsync>)

    A PapiEvent that subscribes asynchronously and resolves an asynchronous unsubscriber.

    Note: The callback itself is not asynchronous.

    -

    Type Parameters

    • T

    Settings

    Member Visibility
    +

    Type Parameters

    • T

    Settings

    Member Visibility
    diff --git a/platform-bible-utils/types/PlatformEventHandler.html b/platform-bible-utils/types/PlatformEventHandler.html index b954b1caf2..955bf19bfe 100644 --- a/platform-bible-utils/types/PlatformEventHandler.html +++ b/platform-bible-utils/types/PlatformEventHandler.html @@ -1,2 +1,2 @@ PlatformEventHandler | platform-bible-utils

    Type AliasPlatformEventHandler<T>

    PlatformEventHandler<T>: ((event: T) => void)

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

    -

    Type Parameters

    • T

    Settings

    Member Visibility
    +

    Type Parameters

    • T

    Settings

    Member Visibility
    diff --git a/platform-bible-utils/types/PlatformMenus.html b/platform-bible-utils/types/PlatformMenus.html index 12dc86bec9..66e667668c 100644 --- a/platform-bible-utils/types/PlatformMenus.html +++ b/platform-bible-utils/types/PlatformMenus.html @@ -3,4 +3,4 @@
  • defaultWebViewTopMenu: MultiColumnMenu

    Default top menu for web views that don't specify their own

  • mainMenu: MultiColumnMenu

    Top level menu for the application

  • webViewMenus: WebViewMenus

    Menus that apply per web view in the application

    -

    • Settings

    Member Visibility
    +

    Settings

    Member Visibility
    diff --git a/platform-bible-utils/types/ProjectSetting.html b/platform-bible-utils/types/ProjectSetting.html index 62fa910c70..7e7d174168 100644 --- a/platform-bible-utils/types/ProjectSetting.html +++ b/platform-bible-utils/types/ProjectSetting.html @@ -1,2 +1,2 @@ ProjectSetting | platform-bible-utils

    Type AliasProjectSetting

    ProjectSetting: ExtensionControlledProjectSetting

    A description of an extension's setting entry

    -

    Settings

    Member Visibility
    +

    Settings

    Member Visibility
    diff --git a/platform-bible-utils/types/ProjectSettingBase.html b/platform-bible-utils/types/ProjectSettingBase.html index 12735b10e6..c15301704b 100644 --- a/platform-bible-utils/types/ProjectSettingBase.html +++ b/platform-bible-utils/types/ProjectSettingBase.html @@ -1,2 +1,2 @@ ProjectSettingBase | platform-bible-utils

    Type AliasProjectSettingBase

    ProjectSettingBase: SettingBase & ModifierProject

    Base information needed to describe a project setting entry

    -

    Settings

    Member Visibility
    +

    Settings

    Member Visibility
    diff --git a/platform-bible-utils/types/ProjectSettingsContribution.html b/platform-bible-utils/types/ProjectSettingsContribution.html index aeea4df6eb..9bba8e6b28 100644 --- a/platform-bible-utils/types/ProjectSettingsContribution.html +++ b/platform-bible-utils/types/ProjectSettingsContribution.html @@ -1,2 +1,2 @@ ProjectSettingsContribution | platform-bible-utils

    Type AliasProjectSettingsContribution

    ProjectSettingsContribution: ProjectSettingsGroup | ProjectSettingsGroup[]

    The data an extension provides to inform Platform.Bible of the project settings it provides

    -

    Settings

    Member Visibility
    +

    Settings

    Member Visibility
    diff --git a/platform-bible-utils/types/ReferencedItem.html b/platform-bible-utils/types/ReferencedItem.html index b10cfe8a60..9cf3b4d893 100644 --- a/platform-bible-utils/types/ReferencedItem.html +++ b/platform-bible-utils/types/ReferencedItem.html @@ -1,2 +1,2 @@ ReferencedItem | platform-bible-utils

    Type AliasReferencedItem

    ReferencedItem: `${string}.${string}`

    Name of some UI element (i.e., tab, column, group, menu item) or some PAPI object (i.e., command)

    -

    Settings

    Member Visibility
    +

    Settings

    Member Visibility
    diff --git a/platform-bible-utils/types/ReplaceType.html b/platform-bible-utils/types/ReplaceType.html index 182afa12dc..2c100ae101 100644 --- a/platform-bible-utils/types/ReplaceType.html +++ b/platform-bible-utils/types/ReplaceType.html @@ -1,2 +1,2 @@ ReplaceType | platform-bible-utils

    Type AliasReplaceType<T, A, B>

    ReplaceType<T, A, B>: T extends A
        ? B
        : T extends object
            ? {
                [K in keyof T]: ReplaceType<T[K], A, B>
            }
            : T

    Within type T, recursively change properties that were of type A to be of type B

    -

    Type Parameters

    • T
    • A
    • B

    Settings

    Member Visibility
    +

    Type Parameters

    • T
    • A
    • B

    Settings

    Member Visibility
    diff --git a/platform-bible-utils/types/ScriptureNode.html b/platform-bible-utils/types/ScriptureNode.html index 8ddf0fa0f3..3c4ca7b255 100644 --- a/platform-bible-utils/types/ScriptureNode.html +++ b/platform-bible-utils/types/ScriptureNode.html @@ -1,3 +1,3 @@ ScriptureNode | platform-bible-utils

    Type AliasScriptureNode

    ScriptureNode: ScriptureReference & {
        jsonPath: string;
    }

    Represents a "node" in the JSON used to present Scripture in the editor, with a path that is relative to the start of a verse.

    -

    Settings

    Member Visibility
    +

    Settings

    Member Visibility
    diff --git a/platform-bible-utils/types/ScriptureSelection.html b/platform-bible-utils/types/ScriptureSelection.html index ff660f7045..781dfd13ed 100644 --- a/platform-bible-utils/types/ScriptureSelection.html +++ b/platform-bible-utils/types/ScriptureSelection.html @@ -1,3 +1,3 @@ ScriptureSelection | platform-bible-utils

    Type AliasScriptureSelection

    ScriptureSelection: {
        end?: ScriptureNode | ScriptureTextAnchor;
        start: ScriptureNode | ScriptureTextAnchor;
    }

    Represents a range of text in the Scripture editor. The start and end node are expected to be in the same book.

    -

    Settings

    Member Visibility
    +

    Settings

    Member Visibility
    diff --git a/platform-bible-utils/types/ScriptureTextAnchor.html b/platform-bible-utils/types/ScriptureTextAnchor.html index cf801b4d18..f1f35d3a71 100644 --- a/platform-bible-utils/types/ScriptureTextAnchor.html +++ b/platform-bible-utils/types/ScriptureTextAnchor.html @@ -1,2 +1,2 @@ ScriptureTextAnchor | platform-bible-utils

    Type AliasScriptureTextAnchor

    ScriptureTextAnchor: ScriptureNode & {
        offset: number;
    }

    Represents a specific character offset in the text of a textual Scripture node (in the editor.)

    -

    Settings

    Member Visibility
    +

    Settings

    Member Visibility
    diff --git a/platform-bible-utils/types/ScrollGroupId.html b/platform-bible-utils/types/ScrollGroupId.html index e7c0f7786b..0bec164843 100644 --- a/platform-bible-utils/types/ScrollGroupId.html +++ b/platform-bible-utils/types/ScrollGroupId.html @@ -3,4 +3,4 @@

    For example, a few web views that share a Scroll Group Id would all change Scripture Reference together.

    These are generally expected to be non-negative numbers (starting at 0).

    -

    Settings

    Member Visibility
    +

    Settings

    Member Visibility
    diff --git a/platform-bible-utils/types/Setting.html b/platform-bible-utils/types/Setting.html index 9a3ee794c3..39aa82e603 100644 --- a/platform-bible-utils/types/Setting.html +++ b/platform-bible-utils/types/Setting.html @@ -1,2 +1,2 @@ Setting | platform-bible-utils

    Type AliasSetting

    Setting: ExtensionControlledSetting

    A description of an extension's setting entry

    -

    Settings

    Member Visibility
    +

    Settings

    Member Visibility
    diff --git a/platform-bible-utils/types/SettingBase.html b/platform-bible-utils/types/SettingBase.html index 38a17e4bab..f10dd29195 100644 --- a/platform-bible-utils/types/SettingBase.html +++ b/platform-bible-utils/types/SettingBase.html @@ -1,4 +1,4 @@ SettingBase | platform-bible-utils

    Type AliasSettingBase

    SettingBase: StateBase & {
        description?: LocalizeKey;
        label: LocalizeKey;
        [k: string]: unknown;
    }

    Base information needed to describe a setting entry

    Type declaration

    • [k: string]: unknown
    • Optionaldescription?: LocalizeKey

      LocalizeKey that displays in the settings dialog to describe the setting

    • label: LocalizeKey

      LocalizeKey that displays in the settings dialog as the setting name

      -

    Settings

    Member Visibility
    +

    Settings

    Member Visibility
    diff --git a/platform-bible-utils/types/SettingsContribution.html b/platform-bible-utils/types/SettingsContribution.html index 14d8fe6ff6..5074fa2842 100644 --- a/platform-bible-utils/types/SettingsContribution.html +++ b/platform-bible-utils/types/SettingsContribution.html @@ -1,2 +1,2 @@ SettingsContribution | platform-bible-utils

    Type AliasSettingsContribution

    SettingsContribution: SettingsGroup | SettingsGroup[]

    The data an extension provides to inform Platform.Bible of the settings it provides

    -

    Settings

    Member Visibility
    +

    Settings

    Member Visibility
    diff --git a/platform-bible-utils/types/SingleColumnMenu.html b/platform-bible-utils/types/SingleColumnMenu.html index 36f59afabc..1d76a07a25 100644 --- a/platform-bible-utils/types/SingleColumnMenu.html +++ b/platform-bible-utils/types/SingleColumnMenu.html @@ -1,4 +1,4 @@ SingleColumnMenu | platform-bible-utils

    Type AliasSingleColumnMenu

    SingleColumnMenu: {
        groups: GroupsInSingleColumnMenu;
        items: (MenuItemContainingCommand | MenuItemContainingSubmenu)[];
    }

    Menu that contains a column without a header

    Type declaration

    Settings

    Member Visibility
    +

    Settings

    Member Visibility
    diff --git a/platform-bible-utils/types/UnionToIntersection.html b/platform-bible-utils/types/UnionToIntersection.html index bb402ece5c..1d2b135dcd 100644 --- a/platform-bible-utils/types/UnionToIntersection.html +++ b/platform-bible-utils/types/UnionToIntersection.html @@ -1,6 +1,6 @@ UnionToIntersection | platform-bible-utils

    Type AliasUnionToIntersection<U>

    UnionToIntersection<U>: (U extends any
            ? ((x: U) => void)
            : never) extends ((x: infer I) => void)
        ? I
        : never

    Converts a union type to an intersection type (| to &).

    Note: this utility type is for use on object types. It may fail on other types.

    -

    Type Parameters

    • U

    Example

    type TypeOne = { one: string };
    type TypeTwo = { two: number };
    type TypeThree = { three: string };

    type TypeNums = { one: TypeOne; two: TypeTwo; three: TypeThree };
    const numNames = ['one', 'two'] as const;
    type TypeNumNames = typeof numNames;

    // Same as `TypeOne | TypeTwo`
    // `{ one: string } | { two: number }`
    type TypeOneTwoUnion = TypeNums[TypeNumNames[number]];

    // Same as `TypeOne & TypeTwo`
    // `{ one: string; two: number }`
    type TypeOneTwoIntersection = UnionToIntersection<TypeOneTwoUnion>;
+

    Type Parameters

    • U

    Example

    type TypeOne = { one: string };
    type TypeTwo = { two: number };
    type TypeThree = { three: string };

    type TypeNums = { one: TypeOne; two: TypeTwo; three: TypeThree };
    const numNames = ['one', 'two'] as const;
    type TypeNumNames = typeof numNames;

    // Same as `TypeOne | TypeTwo`
    // `{ one: string } | { two: number }`
    type TypeOneTwoUnion = TypeNums[TypeNumNames[number]];

    // Same as `TypeOne & TypeTwo`
    // `{ one: string; two: number }`
    type TypeOneTwoIntersection = UnionToIntersection<TypeOneTwoUnion>;
    -

    Settings

    Member Visibility
    +

    Settings

    Member Visibility
    diff --git a/platform-bible-utils/types/Unsubscriber.html b/platform-bible-utils/types/Unsubscriber.html index 44aae74bd2..223714804a 100644 --- a/platform-bible-utils/types/Unsubscriber.html +++ b/platform-bible-utils/types/Unsubscriber.html @@ -1,2 +1,2 @@ Unsubscriber | platform-bible-utils

    Type AliasUnsubscriber

    Unsubscriber: (() => boolean)

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

    -

    Settings

    Member Visibility
    +

    Settings

    Member Visibility
    diff --git a/platform-bible-utils/types/UnsubscriberAsync.html b/platform-bible-utils/types/UnsubscriberAsync.html index 1f6a8181aa..797a84fd95 100644 --- a/platform-bible-utils/types/UnsubscriberAsync.html +++ b/platform-bible-utils/types/UnsubscriberAsync.html @@ -1,3 +1,3 @@ UnsubscriberAsync | platform-bible-utils

    Type AliasUnsubscriberAsync

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

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

    -

    Settings

    Member Visibility
    +

    Settings

    Member Visibility
    diff --git a/platform-bible-utils/types/UserState.html b/platform-bible-utils/types/UserState.html index f19b365b9d..9b0900194b 100644 --- a/platform-bible-utils/types/UserState.html +++ b/platform-bible-utils/types/UserState.html @@ -1,2 +1,2 @@ UserState | platform-bible-utils

    Type AliasUserState

    UserState: ExtensionControlledState

    A description of an extension's user state entry

    -

    Settings

    Member Visibility
    +

    Settings

    Member Visibility
    diff --git a/platform-bible-utils/types/UsjContentLocation.html b/platform-bible-utils/types/UsjContentLocation.html index 246fa526af..64d47c8210 100644 --- a/platform-bible-utils/types/UsjContentLocation.html +++ b/platform-bible-utils/types/UsjContentLocation.html @@ -1,2 +1,2 @@ UsjContentLocation | platform-bible-utils

    Type AliasUsjContentLocation

    UsjContentLocation: {
        jsonPath: ContentJsonPath;
        node: MarkerContent;
        offset: number;
    }

    Node within a USJ object, an offset within that node, and a JSONPath query to the node

    -

    Settings

    Member Visibility
    +

    Settings

    Member Visibility
    diff --git a/platform-bible-utils/types/VerseRefOffset.html b/platform-bible-utils/types/VerseRefOffset.html index 94fe760073..b22a302540 100644 --- a/platform-bible-utils/types/VerseRefOffset.html +++ b/platform-bible-utils/types/VerseRefOffset.html @@ -1,2 +1,2 @@ VerseRefOffset | platform-bible-utils

    Type AliasVerseRefOffset

    VerseRefOffset: {
        offset: number;
        verseRef: VerseRef;
    }

    Represents a book, chapter, verse, and offset

    -

    Settings

    Member Visibility
    +

    Settings

    Member Visibility
    diff --git a/platform-bible-utils/types/WebViewMenu.html b/platform-bible-utils/types/WebViewMenu.html index fbdac07008..05bd0cf59a 100644 --- a/platform-bible-utils/types/WebViewMenu.html +++ b/platform-bible-utils/types/WebViewMenu.html @@ -2,4 +2,4 @@

    Type declaration

    • contextMenu: SingleColumnMenu | undefined

      Menu that opens when you right click on the main body/area of a tab

    • includeDefaults: boolean | undefined

      Indicates whether the platform default menus should be included for this webview

    • topMenu: MultiColumnMenu | undefined

      Menu that opens when you click on the top left corner of a tab

      -

    Settings

    Member Visibility
    +

    Settings

    Member Visibility
    diff --git a/platform-bible-utils/types/WebViewMenus.html b/platform-bible-utils/types/WebViewMenus.html index 8eddbd46ae..973ce17789 100644 --- a/platform-bible-utils/types/WebViewMenus.html +++ b/platform-bible-utils/types/WebViewMenus.html @@ -1,3 +1,3 @@ WebViewMenus | platform-bible-utils

    Type AliasWebViewMenus

    WebViewMenus: {
        [property: ReferencedItem]: WebViewMenu;
    }

    Menus for all web views

    Type declaration

    Settings

    Member Visibility
    +

    Settings

    Member Visibility
    diff --git a/platform-bible-utils/variables/CHAPTER_TYPE.html b/platform-bible-utils/variables/CHAPTER_TYPE.html index 08ca20cbf9..39f6d6bf5c 100644 --- a/platform-bible-utils/variables/CHAPTER_TYPE.html +++ b/platform-bible-utils/variables/CHAPTER_TYPE.html @@ -1,2 +1,2 @@ CHAPTER_TYPE | platform-bible-utils

    VariableCHAPTER_TYPEConst

    CHAPTER_TYPE: "chapter" = 'chapter'

    USJ content node type for a chapter

    -

    Settings

    Member Visibility
    +

    Settings

    Member Visibility
    diff --git a/platform-bible-utils/variables/FIRST_SCR_BOOK_NUM.html b/platform-bible-utils/variables/FIRST_SCR_BOOK_NUM.html index 27d737b6e4..ff1186c9a8 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

    VariableFIRST_SCR_BOOK_NUMConst

    FIRST_SCR_BOOK_NUM = 1

    Settings

    Member Visibility
    +FIRST_SCR_BOOK_NUM | platform-bible-utils

    VariableFIRST_SCR_BOOK_NUMConst

    FIRST_SCR_BOOK_NUM = 1

    Settings

    Member Visibility
    diff --git a/platform-bible-utils/variables/FIRST_SCR_CHAPTER_NUM.html b/platform-bible-utils/variables/FIRST_SCR_CHAPTER_NUM.html index a701b18b1c..adbedfd9a6 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

    VariableFIRST_SCR_CHAPTER_NUMConst

    FIRST_SCR_CHAPTER_NUM = 1

    Settings

    Member Visibility
    +FIRST_SCR_CHAPTER_NUM | platform-bible-utils

    VariableFIRST_SCR_CHAPTER_NUMConst

    FIRST_SCR_CHAPTER_NUM = 1

    Settings

    Member Visibility
    diff --git a/platform-bible-utils/variables/FIRST_SCR_VERSE_NUM.html b/platform-bible-utils/variables/FIRST_SCR_VERSE_NUM.html index d6044ff96c..08a99d0c6c 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

    VariableFIRST_SCR_VERSE_NUMConst

    FIRST_SCR_VERSE_NUM = 1

    Settings

    Member Visibility
    +FIRST_SCR_VERSE_NUM | platform-bible-utils

    VariableFIRST_SCR_VERSE_NUMConst

    FIRST_SCR_VERSE_NUM = 1

    Settings

    Member Visibility
    diff --git a/platform-bible-utils/variables/LAST_SCR_BOOK_NUM.html b/platform-bible-utils/variables/LAST_SCR_BOOK_NUM.html index 46e3481d4d..67214daa93 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

    VariableLAST_SCR_BOOK_NUMConst

    LAST_SCR_BOOK_NUM: number = ...

    Settings

    Member Visibility
    +LAST_SCR_BOOK_NUM | platform-bible-utils

    VariableLAST_SCR_BOOK_NUMConst

    LAST_SCR_BOOK_NUM: number = ...

    Settings

    Member Visibility
    diff --git a/platform-bible-utils/variables/VERSE_TYPE.html b/platform-bible-utils/variables/VERSE_TYPE.html index 26b9c27c45..6c1d4e1c4e 100644 --- a/platform-bible-utils/variables/VERSE_TYPE.html +++ b/platform-bible-utils/variables/VERSE_TYPE.html @@ -1,2 +1,2 @@ VERSE_TYPE | platform-bible-utils

    VariableVERSE_TYPEConst

    VERSE_TYPE: "verse" = 'verse'

    USJ content node type for a verse

    -

    Settings

    Member Visibility
    +

    Settings

    Member Visibility
    diff --git a/platform-bible-utils/variables/defaultScrRef.html b/platform-bible-utils/variables/defaultScrRef.html index aa6d764f06..d65ddd59ab 100644 --- a/platform-bible-utils/variables/defaultScrRef.html +++ b/platform-bible-utils/variables/defaultScrRef.html @@ -1 +1 @@ -defaultScrRef | platform-bible-utils

    VariabledefaultScrRefConst

    defaultScrRef: ScriptureReference = ...

    Settings

    Member Visibility
    +defaultScrRef | platform-bible-utils

    VariabledefaultScrRefConst

    defaultScrRef: ScriptureReference = ...

    Settings

    Member Visibility
    diff --git a/platform-bible-utils/variables/localizedStringsDocumentSchema.html b/platform-bible-utils/variables/localizedStringsDocumentSchema.html index 35cf42a68d..65e44b1a27 100644 --- a/platform-bible-utils/variables/localizedStringsDocumentSchema.html +++ b/platform-bible-utils/variables/localizedStringsDocumentSchema.html @@ -1,2 +1,2 @@ localizedStringsDocumentSchema | platform-bible-utils

    VariablelocalizedStringsDocumentSchemaConst

    localizedStringsDocumentSchema: {
        $defs: {
            languageStrings: {
                additionalProperties: boolean;
                description: string;
                patternProperties: {
                    ^%[\w\-\.]+%$: {
                        $ref: string;
                    };
                };
                type: string;
            };
            localizedStringValue: {
                description: string;
                type: string;
            };
            localizeKey: {
                description: string;
                pattern: string;
                tsType: string;
                type: string;
            };
            stringMetadata: {
                description: string;
                properties: {
                    fallbackKey: {
                        description: string;
                        pattern: string;
                        tsType: string;
                        type: string;
                    };
                    notes: {
                        description: string;
                        type: string;
                    };
                };
                type: string;
            };
            stringsMetadata: {
                additionalProperties: boolean;
                description: string;
                patternProperties: {
                    ^%[\w\-\.]+%$: {
                        $ref: string;
                    };
                };
                type: string;
            };
        };
        $schema: string;
        description: string;
        properties: {
            localizedStrings: {
                additionalProperties: {
                    $ref: string;
                };
                type: string;
            };
            metadata: {
                $ref: string;
            };
        };
        title: string;
        type: string;
    } = ...

    JSON schema object that aligns with the LocalizedStringDataContribution type

    -

    Settings

    Member Visibility
    +

    Settings

    Member Visibility
    diff --git a/platform-bible-utils/variables/menuDocumentSchema.html b/platform-bible-utils/variables/menuDocumentSchema.html index 2fbe7eab28..d0e95aca54 100644 --- a/platform-bible-utils/variables/menuDocumentSchema.html +++ b/platform-bible-utils/variables/menuDocumentSchema.html @@ -1,2 +1,2 @@ menuDocumentSchema | platform-bible-utils

    VariablemenuDocumentSchemaConst

    menuDocumentSchema: {
        $defs: {
            columnsWithHeaders: {
                description: string;
                patternProperties: {
                    ^[\w\-]+\.[\w\-]+$: {
                        additionalProperties: boolean;
                        description: string;
                        properties: {
                            isExtensible: {
                                description: string;
                                type: string;
                            };
                            label: {
                                $ref: string;
                                description: string;
                            };
                            localizeNotes: {
                                description: string;
                                type: string;
                            };
                            order: {
                                description: string;
                                type: string;
                            };
                        };
                        required: string[];
                        type: string;
                    };
                };
                properties: {
                    isExtensible: {
                        description: string;
                        type: string;
                    };
                };
                type: string;
            };
            groupsAndItems: {
                description: string;
                properties: {
                    groups: {
                        $ref: string;
                        description: string;
                    };
                    items: {
                        description: string;
                        items: {
                            $ref: string;
                        };
                        type: string;
                        uniqueItems: boolean;
                    };
                };
                required: string[];
                type: string;
            };
            localizeKey: {
                description: string;
                pattern: string;
                type: string;
            };
            menuGroups: {
                additionalProperties: boolean;
                description: string;
                patternProperties: {
                    ^[\w\-]+\.[\w\-]+$: {
                        description: string;
                        oneOf: ({
                            additionalProperties: boolean;
                            properties: {
                                column: {
                                    $ref: string;
                                    description: string;
                                };
                                isExtensible: {
                                    description: string;
                                    type: string;
                                };
                                menuItem?: undefined;
                                order: {
                                    description: string;
                                    type: string;
                                };
                            };
                            required: string[];
                        } | {
                            additionalProperties: boolean;
                            properties: {
                                column?: undefined;
                                isExtensible: {
                                    description: string;
                                    type: string;
                                };
                                menuItem: {
                                    $ref: string;
                                    description: string;
                                };
                                order: {
                                    description: string;
                                    type: string;
                                };
                            };
                            required: string[];
                        })[];
                        type: string;
                    };
                };
                type: string;
            };
            menuItem: {
                description: string;
                oneOf: ({
                    properties: {
                        command?: undefined;
                        iconPathAfter?: undefined;
                        iconPathBefore?: undefined;
                        id: {
                            $ref: string;
                            description: string;
                        };
                    };
                    required: string[];
                } | {
                    properties: {
                        command: {
                            $ref: string;
                            description: string;
                        };
                        iconPathAfter: {
                            description: string;
                            type: string;
                        };
                        iconPathBefore: {
                            description: string;
                            type: string;
                        };
                        id?: undefined;
                    };
                    required: string[];
                })[];
                properties: {
                    group: {
                        $ref: string;
                        description: string;
                    };
                    label: {
                        $ref: string;
                        description: string;
                    };
                    localizeNotes: {
                        description: string;
                        type: string;
                    };
                    order: {
                        description: string;
                        type: string;
                    };
                    searchTerms: {
                        $ref: string;
                        description: string;
                    };
                    tooltip: {
                        $ref: string;
                        description: string;
                    };
                };
                required: string[];
                type: string;
                unevaluatedProperties: boolean;
            };
            menusForOneWebView: {
                additionalProperties: boolean;
                description: string;
                properties: {
                    contextMenu: {
                        $ref: string;
                        description: string;
                    };
                    includeDefaults: {
                        description: string;
                        type: string;
                    };
                    topMenu: {
                        $ref: string;
                        description: string;
                    };
                };
                type: string;
            };
            multiColumnMenu: {
                allOf: ({
                    $ref: string;
                    properties?: undefined;
                    required?: undefined;
                } | {
                    $ref?: undefined;
                    properties: {
                        columns: {
                            $ref: string;
                            description: string;
                        };
                    };
                    required: string[];
                })[];
                description: string;
                type: string;
                unevaluatedProperties: boolean;
            };
            referencedItem: {
                description: string;
                pattern: string;
                type: string;
            };
            singleColumnMenu: {
                allOf: {
                    $ref: string;
                }[];
                description: string;
                type: string;
                unevaluatedProperties: boolean;
            };
        };
        additionalProperties: boolean;
        properties: {
            defaultWebViewContextMenu: {
                $ref: string;
                description: string;
            };
            defaultWebViewTopMenu: {
                $ref: string;
                description: string;
            };
            mainMenu: {
                $ref: string;
                description: string;
            };
            webViewMenus: {
                additionalProperties: boolean;
                description: string;
                patternProperties: {
                    ^[\w\-]+\.[\w\-]+$: {
                        $ref: string;
                    };
                };
                type: string;
            };
        };
        required: string[];
        title: string;
        type: string;
    } = ...

    JSON schema object that aligns with the PlatformMenus type

    -

    Settings

    Member Visibility
    +

    Settings

    Member Visibility
    diff --git a/platform-bible-utils/variables/projectSettingsDocumentSchema.html b/platform-bible-utils/variables/projectSettingsDocumentSchema.html index 1791bb5971..b92083d8ff 100644 --- a/platform-bible-utils/variables/projectSettingsDocumentSchema.html +++ b/platform-bible-utils/variables/projectSettingsDocumentSchema.html @@ -1,2 +1,2 @@ projectSettingsDocumentSchema | platform-bible-utils

    VariableprojectSettingsDocumentSchemaConst

    projectSettingsDocumentSchema: {
        $defs: {
            extensionControlledProjectSetting: {
                allOf: {
                    $ref: string;
                }[];
                description: string;
            };
            extensionControlledSetting: {
                allOf: {
                    $ref: string;
                }[];
                description: string;
            };
            extensionControlledState: {
                allOf: {
                    $ref: string;
                }[];
                description: string;
            };
            id: {
                description: string;
                pattern: string;
                tsType: string;
                type: string;
            };
            localizeKey: {
                description: string;
                pattern: string;
                tsType: string;
                type: string;
            };
            modifierExtensionControlled: {
                description: string;
                not: {
                    anyOf: {
                        required: string[];
                        type: string;
                    }[];
                };
            };
            modifierProject: {
                description: string;
                properties: {
                    excludePdpFactoryIds: {
                        anyOf: ({
                            items?: undefined;
                            type: string;
                        } | {
                            items: {
                                type: string;
                            };
                            type: string;
                        })[];
                        description: string;
                    };
                    excludeProjectInterfaces: {
                        anyOf: ({
                            items?: undefined;
                            type: string;
                        } | {
                            items: {
                                anyOf: ((...) | (...))[];
                            };
                            type: string;
                        })[];
                        description: string;
                    };
                    includePdpFactoryIds: {
                        anyOf: ({
                            items?: undefined;
                            type: string;
                        } | {
                            items: {
                                type: string;
                            };
                            type: string;
                        })[];
                        description: string;
                    };
                    includeProjectInterfaces: {
                        anyOf: ({
                            items?: undefined;
                            type: string;
                        } | {
                            items: {
                                anyOf: ((...) | (...))[];
                            };
                            type: string;
                        })[];
                        description: string;
                    };
                };
                type: string;
            };
            projectSetting: {
                anyOf: {
                    $ref: string;
                }[];
                description: string;
            };
            projectSettingBase: {
                allOf: {
                    $ref: string;
                }[];
                description: string;
            };
            projectSettingProperties: {
                additionalProperties: boolean;
                description: string;
                patternProperties: {
                    ^[\w\-]+\.[\w\-]+$: {
                        $ref: string;
                    };
                };
                type: string;
            };
            projectSettingsContribution: {
                anyOf: ({
                    $ref: string;
                    items?: undefined;
                    type?: undefined;
                } | {
                    $ref?: undefined;
                    items: {
                        $ref: string;
                    };
                    type: string;
                })[];
                description: string;
            };
            projectSettingsGroup: {
                description: string;
                properties: {
                    description: {
                        $ref: string;
                        description: string;
                    };
                    label: {
                        $ref: string;
                        description: string;
                    };
                    properties: {
                        $ref: string;
                    };
                };
                required: string[];
                type: string;
            };
            projectStateContribution: {
                $ref: string;
                description: string;
            };
            setting: {
                anyOf: {
                    $ref: string;
                }[];
                description: string;
            };
            settingBase: {
                allOf: ({
                    $ref: string;
                    properties?: undefined;
                    required?: undefined;
                    type?: undefined;
                } | {
                    $ref?: undefined;
                    properties: {
                        description: {
                            $ref: string;
                            description: string;
                        };
                        label: {
                            $ref: string;
                            description: string;
                        };
                    };
                    required: string[];
                    type: string;
                })[];
                description: string;
            };
            settingProperties: {
                additionalProperties: boolean;
                description: string;
                patternProperties: {
                    ^[\w-]+\.[\w-]+$: {
                        $ref: string;
                    };
                };
                type: string;
            };
            settingsContribution: {
                anyOf: ({
                    $ref: string;
                    items?: undefined;
                    type?: undefined;
                } | {
                    $ref?: undefined;
                    items: {
                        $ref: string;
                    };
                    type: string;
                })[];
                description: string;
            };
            settingsGroup: {
                description: string;
                properties: {
                    description: {
                        $ref: string;
                        description: string;
                    };
                    label: {
                        $ref: string;
                        description: string;
                    };
                    properties: {
                        $ref: string;
                    };
                };
                required: string[];
                type: string;
            };
            stateBase: {
                description: string;
                properties: {
                    default: {
                        description: string;
                        type: string;
                    };
                    derivesFrom: {
                        $ref: string;
                        description: string;
                    };
                };
                required: string[];
                type: string;
            };
            userState: {
                anyOf: {
                    $ref: string;
                }[];
                description: string;
            };
            userStateContribution: {
                $ref: string;
                description: string;
            };
            userStateProperties: {
                additionalProperties: boolean;
                description: string;
                patternProperties: {
                    ^[\w\-]+\.[\w\-]+$: {
                        $ref: string;
                    };
                };
                type: string;
            };
        };
        $schema: string;
        anyOf: ({
            $ref: string;
            items?: undefined;
            type?: undefined;
        } | {
            $ref?: undefined;
            items: {
                $ref: string;
            };
            type: string;
        })[];
        description: string;
        title: string;
    } = ...

    JSON schema object that aligns with the ProjectSettingsContribution type

    -

    Settings

    Member Visibility
    +

    Settings

    Member Visibility
    diff --git a/platform-bible-utils/variables/settingsDocumentSchema.html b/platform-bible-utils/variables/settingsDocumentSchema.html index 850afb0354..c1c4f90b25 100644 --- a/platform-bible-utils/variables/settingsDocumentSchema.html +++ b/platform-bible-utils/variables/settingsDocumentSchema.html @@ -1,2 +1,2 @@ settingsDocumentSchema | platform-bible-utils

    VariablesettingsDocumentSchemaConst

    settingsDocumentSchema: {
        $defs: {
            extensionControlledProjectSetting: {
                allOf: {
                    $ref: string;
                }[];
                description: string;
            };
            extensionControlledSetting: {
                allOf: {
                    $ref: string;
                }[];
                description: string;
            };
            extensionControlledState: {
                allOf: {
                    $ref: string;
                }[];
                description: string;
            };
            id: {
                description: string;
                pattern: string;
                tsType: string;
                type: string;
            };
            localizeKey: {
                description: string;
                pattern: string;
                tsType: string;
                type: string;
            };
            modifierExtensionControlled: {
                description: string;
                not: {
                    anyOf: {
                        required: string[];
                        type: string;
                    }[];
                };
            };
            modifierProject: {
                description: string;
                properties: {
                    excludePdpFactoryIds: {
                        anyOf: ({
                            items?: undefined;
                            type: string;
                        } | {
                            items: {
                                type: string;
                            };
                            type: string;
                        })[];
                        description: string;
                    };
                    excludeProjectInterfaces: {
                        anyOf: ({
                            items?: undefined;
                            type: string;
                        } | {
                            items: {
                                anyOf: ((...) | (...))[];
                            };
                            type: string;
                        })[];
                        description: string;
                    };
                    includePdpFactoryIds: {
                        anyOf: ({
                            items?: undefined;
                            type: string;
                        } | {
                            items: {
                                type: string;
                            };
                            type: string;
                        })[];
                        description: string;
                    };
                    includeProjectInterfaces: {
                        anyOf: ({
                            items?: undefined;
                            type: string;
                        } | {
                            items: {
                                anyOf: ((...) | (...))[];
                            };
                            type: string;
                        })[];
                        description: string;
                    };
                };
                type: string;
            };
            projectSetting: {
                anyOf: {
                    $ref: string;
                }[];
                description: string;
            };
            projectSettingBase: {
                allOf: {
                    $ref: string;
                }[];
                description: string;
            };
            projectSettingProperties: {
                additionalProperties: boolean;
                description: string;
                patternProperties: {
                    ^[\w\-]+\.[\w\-]+$: {
                        $ref: string;
                    };
                };
                type: string;
            };
            projectSettingsContribution: {
                anyOf: ({
                    $ref: string;
                    items?: undefined;
                    type?: undefined;
                } | {
                    $ref?: undefined;
                    items: {
                        $ref: string;
                    };
                    type: string;
                })[];
                description: string;
            };
            projectSettingsGroup: {
                description: string;
                properties: {
                    description: {
                        $ref: string;
                        description: string;
                    };
                    label: {
                        $ref: string;
                        description: string;
                    };
                    properties: {
                        $ref: string;
                    };
                };
                required: string[];
                type: string;
            };
            projectStateContribution: {
                $ref: string;
                description: string;
            };
            setting: {
                anyOf: {
                    $ref: string;
                }[];
                description: string;
            };
            settingBase: {
                allOf: ({
                    $ref: string;
                    properties?: undefined;
                    required?: undefined;
                    type?: undefined;
                } | {
                    $ref?: undefined;
                    properties: {
                        description: {
                            $ref: string;
                            description: string;
                        };
                        label: {
                            $ref: string;
                            description: string;
                        };
                    };
                    required: string[];
                    type: string;
                })[];
                description: string;
            };
            settingProperties: {
                additionalProperties: boolean;
                description: string;
                patternProperties: {
                    ^[\w-]+\.[\w-]+$: {
                        $ref: string;
                    };
                };
                type: string;
            };
            settingsContribution: {
                anyOf: ({
                    $ref: string;
                    items?: undefined;
                    type?: undefined;
                } | {
                    $ref?: undefined;
                    items: {
                        $ref: string;
                    };
                    type: string;
                })[];
                description: string;
            };
            settingsGroup: {
                description: string;
                properties: {
                    description: {
                        $ref: string;
                        description: string;
                    };
                    label: {
                        $ref: string;
                        description: string;
                    };
                    properties: {
                        $ref: string;
                    };
                };
                required: string[];
                type: string;
            };
            stateBase: {
                description: string;
                properties: {
                    default: {
                        description: string;
                        type: string;
                    };
                    derivesFrom: {
                        $ref: string;
                        description: string;
                    };
                };
                required: string[];
                type: string;
            };
            userState: {
                anyOf: {
                    $ref: string;
                }[];
                description: string;
            };
            userStateContribution: {
                $ref: string;
                description: string;
            };
            userStateProperties: {
                additionalProperties: boolean;
                description: string;
                patternProperties: {
                    ^[\w\-]+\.[\w\-]+$: {
                        $ref: string;
                    };
                };
                type: string;
            };
        };
        $schema: string;
        anyOf: ({
            $ref: string;
            items?: undefined;
            type?: undefined;
        } | {
            $ref?: undefined;
            items: {
                $ref: string;
            };
            type: string;
        })[];
        description: string;
        title: string;
    } = ...

    JSON schema object that aligns with the SettingsContribution type

    -

    Settings

    Member Visibility
    +

    Settings

    Member Visibility