diff --git a/papi-components/enums/LabelPosition.html b/papi-components/enums/LabelPosition.html index 666c090294..7d65895bbf 100644 --- a/papi-components/enums/LabelPosition.html +++ b/papi-components/enums/LabelPosition.html @@ -1,5 +1,5 @@ -LabelPosition | papi-components

Enumeration LabelPosition

Enumeration Members

Above +LabelPosition | papi-components

Enumeration LabelPosition

Enumeration Members

Above After Before Below -

Enumeration Members

Above

Above: "above"

After

After: "after"

Before

Before: "before"

Below

Below: "below"

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file +

Enumeration Members

Above

Above: "above"

After

After: "after"

Before

Before: "before"

Below

Below: "below"

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file diff --git a/papi-components/functions/Button.html b/papi-components/functions/Button.html index 750e7345a8..139aad72ad 100644 --- a/papi-components/functions/Button.html +++ b/papi-components/functions/Button.html @@ -1,4 +1,4 @@ Button | papi-components

Function Button

Settings

Member Visibility

Theme

Generated using TypeDoc

\ No newline at end of file +

Parameters

Returns Element

Settings

Member Visibility

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/papi-components/functions/ChapterRangeSelector.html b/papi-components/functions/ChapterRangeSelector.html index f43d45aaa4..6b5ca6eff9 100644 --- a/papi-components/functions/ChapterRangeSelector.html +++ b/papi-components/functions/ChapterRangeSelector.html @@ -1 +1 @@ -ChapterRangeSelector | papi-components

Function ChapterRangeSelector

Settings

Member Visibility

Theme

Generated using TypeDoc

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

Function ChapterRangeSelector

Settings

Member Visibility

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/papi-components/functions/Checkbox.html b/papi-components/functions/Checkbox.html index 60d6ff5509..0750c9431e 100644 --- a/papi-components/functions/Checkbox.html +++ b/papi-components/functions/Checkbox.html @@ -1,2 +1,2 @@ Checkbox | papi-components

Function Checkbox

  • Checkbox(__namedParameters): Element

  • Primary UI component for user interaction

    -

    Parameters

    • __namedParameters: CheckboxProps

    Returns Element

Settings

Member Visibility

Theme

Generated using TypeDoc

\ No newline at end of file +

Parameters

Returns Element

Settings

Member Visibility

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/papi-components/functions/ComboBox.html b/papi-components/functions/ComboBox.html index 617b24499d..79b0ede485 100644 --- a/papi-components/functions/ComboBox.html +++ b/papi-components/functions/ComboBox.html @@ -1,4 +1,4 @@ ComboBox | papi-components

Function ComboBox

Settings

Member Visibility

Theme

Generated using TypeDoc

\ No newline at end of file +

Type Parameters

Parameters

Returns Element

Settings

Member Visibility

Theme

Generated using TypeDoc

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

Function GridMenu

Settings

Member Visibility

Theme

Generated using TypeDoc

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

Function GridMenu

Settings

Member Visibility

Theme

Generated using TypeDoc

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

Function IconButton

Settings

Member Visibility

Theme

Generated using TypeDoc

\ No newline at end of file +

Parameters

Returns Element

Settings

Member Visibility

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/papi-components/functions/MenuItem.html b/papi-components/functions/MenuItem.html index 6f964e2017..030b13b88b 100644 --- a/papi-components/functions/MenuItem.html +++ b/papi-components/functions/MenuItem.html @@ -1 +1 @@ -MenuItem | papi-components

Function MenuItem

Settings

Member Visibility

Theme

Generated using TypeDoc

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

Function MenuItem

Settings

Member Visibility

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/papi-components/functions/RefSelector.html b/papi-components/functions/RefSelector.html index 4cb83bf443..a83d157bca 100644 --- a/papi-components/functions/RefSelector.html +++ b/papi-components/functions/RefSelector.html @@ -1 +1 @@ -RefSelector | papi-components

Function RefSelector

Settings

Member Visibility

Theme

Generated using TypeDoc

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

Function RefSelector

Settings

Member Visibility

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/papi-components/functions/SearchBar.html b/papi-components/functions/SearchBar.html index 6f90baf73f..e2bcb4868b 100644 --- a/papi-components/functions/SearchBar.html +++ b/papi-components/functions/SearchBar.html @@ -1 +1 @@ -SearchBar | papi-components

Function SearchBar

Settings

Member Visibility

Theme

Generated using TypeDoc

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

Function SearchBar

Settings

Member Visibility

Theme

Generated using TypeDoc

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

Function Slider

Settings

Member Visibility

Theme

Generated using TypeDoc

\ No newline at end of file +

Parameters

Returns Element

Settings

Member Visibility

Theme

Generated using TypeDoc

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

Function Snackbar

Settings

Member Visibility

Theme

Generated using TypeDoc

\ No newline at end of file +

Parameters

Returns Element

Settings

Member Visibility

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/papi-components/functions/Switch.html b/papi-components/functions/Switch.html index 45f3227e6f..8e755d0f64 100644 --- a/papi-components/functions/Switch.html +++ b/papi-components/functions/Switch.html @@ -1,4 +1,4 @@ Switch | papi-components

Function Switch

Settings

Member Visibility

Theme

Generated using TypeDoc

\ No newline at end of file +

Parameters

Returns Element

Settings

Member Visibility

Theme

Generated using TypeDoc

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

Function Table

Settings

Member Visibility

Theme

Generated using TypeDoc

\ No newline at end of file +

Type Parameters

Parameters

Returns Element

Settings

Member Visibility

Theme

Generated using TypeDoc

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

Function TextField

Settings

Member Visibility

Theme

Generated using TypeDoc

\ No newline at end of file +

Parameters

Returns Element

Settings

Member Visibility

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/papi-components/functions/Toolbar.html b/papi-components/functions/Toolbar.html index a1c3f6140d..00f4353cb7 100644 --- a/papi-components/functions/Toolbar.html +++ b/papi-components/functions/Toolbar.html @@ -1 +1 @@ -Toolbar | papi-components

Function Toolbar

Settings

Member Visibility

Theme

Generated using TypeDoc

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

Function Toolbar

Settings

Member Visibility

Theme

Generated using TypeDoc

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

Function getChaptersForBook

Settings

Member Visibility

Theme

Generated using TypeDoc

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

Function getChaptersForBook

Settings

Member Visibility

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/papi-components/interfaces/ScrRefSelectorProps.html b/papi-components/interfaces/ScrRefSelectorProps.html index 0beda9ed82..21ad89d63d 100644 --- a/papi-components/interfaces/ScrRefSelectorProps.html +++ b/papi-components/interfaces/ScrRefSelectorProps.html @@ -1,4 +1,4 @@ -ScrRefSelectorProps | papi-components

Interface ScrRefSelectorProps

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

Properties

handleSubmit +ScrRefSelectorProps | papi-components

Interface ScrRefSelectorProps

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

Properties

handleSubmit id? scrRef -

Properties

handleSubmit

handleSubmit: ((scrRef) => void)

Type declaration

    • (scrRef): void

    • Parameters

      • scrRef: ScriptureReference

      Returns void

Optional id

id?: string

scrRef

scrRef: ScriptureReference

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file +

Properties

handleSubmit

handleSubmit: ((scrRef) => void)

Type declaration

    • (scrRef): void

    • Parameters

      • scrRef: ScriptureReference

      Returns void

Optional id

id?: string

scrRef

scrRef: ScriptureReference

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

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

Interface TableCalculatedColumn<R>

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

Type Parameters

  • R

Hierarchy

Properties

editable? +TableCalculatedColumn | papi-components

Interface TableCalculatedColumn<R>

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

Type Parameters

  • R

Hierarchy

Properties

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

-

Type declaration

    • (row): boolean

    • Parameters

      • row: R

      Returns boolean

Readonly frozen

frozen: boolean

Readonly idx

idx: number

Readonly isLastFrozenColumn

isLastFrozenColumn: boolean

Readonly key

key: string

A unique key to distinguish each column

-

Readonly maxWidth

maxWidth: undefined | number

Readonly minWidth

minWidth: number

Readonly name

name: string | ReactElement<any, string | JSXElementConstructor<any>>

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

-

Readonly renderCell

renderCell: ((props) => ReactNode)

Type declaration

    • (props): ReactNode

    • Parameters

      • props: RenderCellProps<R, unknown>

      Returns ReactNode

Optional Readonly renderEditCell

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

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

Type declaration

    • (row): boolean

    • Parameters

      • row: R

      Returns boolean

Readonly frozen

frozen: boolean

Readonly idx

idx: number

Readonly isLastFrozenColumn

isLastFrozenColumn: boolean

Readonly key

key: string

A unique key to distinguish each column

+

Readonly maxWidth

maxWidth: undefined | number

Readonly minWidth

minWidth: number

Readonly name

name: string | ReactElement<any, string | JSXElementConstructor<any>>

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

+

Readonly renderCell

renderCell: ((props) => ReactNode)

Type declaration

    • (props): ReactNode

    • Parameters

      • props: RenderCellProps<R, unknown>

      Returns ReactNode

Optional Readonly renderEditCell

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

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

-

Type declaration

Readonly resizable

resizable: boolean

Readonly rowGroup

rowGroup: boolean

Optional Readonly sortDescendingFirst

sortDescendingFirst?: null | boolean

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

Type declaration

Readonly resizable

resizable: boolean

Readonly rowGroup

rowGroup: boolean

Optional Readonly sortDescendingFirst

sortDescendingFirst?: null | boolean

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

-

Readonly sortable

sortable: boolean

Readonly width

width: string | number

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file +

Readonly sortable

sortable: boolean

Readonly width

width: string | number

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

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

Type alias ChapterRangeSelectorProps

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

Type declaration

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

      • Parameters

        • chapter: number

        Returns void

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

      • Parameters

        • chapter: number

        Returns void

  • Optional isDisabled?: boolean
  • startChapter: number

Settings

Member Visibility

Theme

Generated using TypeDoc

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

Type alias ChapterRangeSelectorProps

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

Type declaration

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

      • Parameters

        • chapter: number

        Returns void

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

      • Parameters

        • chapter: number

        Returns void

  • Optional isDisabled?: boolean
  • startChapter: number

Settings

Member Visibility

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/papi-components/types/GridMenuProps.html b/papi-components/types/GridMenuProps.html index 173d834452..cd10643134 100644 --- a/papi-components/types/GridMenuProps.html +++ b/papi-components/types/GridMenuProps.html @@ -1,3 +1,3 @@ GridMenuProps | papi-components

Type alias GridMenuProps

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

Type declaration

  • Optional className?: string

    Additional css classes to help with unique styling of the toolbar

  • commandHandler: CommandHandler
  • Optional id?: string

    Optional unique identifier

    -

Settings

Member Visibility

Theme

Generated using TypeDoc

\ No newline at end of file +

Settings

Member Visibility

Theme

Generated using TypeDoc

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

Type alias MenuColumn

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

Type declaration

  • items: MenuItemInfo[]
  • name: string

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

    -

Settings

Member Visibility

Theme

Generated using TypeDoc

\ No newline at end of file +

Settings

Member Visibility

Theme

Generated using TypeDoc

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

Type alias TableCellClickArgs<R>

TableCellClickArgs<R>: CellClickArgs<R>

Type Parameters

  • R

Settings

Member Visibility

Theme

Generated using TypeDoc

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

Type alias TableCellClickArgs<R>

TableCellClickArgs<R>: CellClickArgs<R>

Type Parameters

  • R

Settings

Member Visibility

Theme

Generated using TypeDoc

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

Type alias TableCellKeyDownArgs<R>

TableCellKeyDownArgs<R>: CellKeyDownArgs<R>

Type Parameters

  • R

Settings

Member Visibility

Theme

Generated using TypeDoc

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

Type alias TableCellKeyDownArgs<R>

TableCellKeyDownArgs<R>: CellKeyDownArgs<R>

Type Parameters

  • R

Settings

Member Visibility

Theme

Generated using TypeDoc

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

Type alias TableCellKeyboardEvent

TableCellKeyboardEvent: CellKeyboardEvent

Settings

Member Visibility

Theme

Generated using TypeDoc

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

Type alias TableCellKeyboardEvent

TableCellKeyboardEvent: CellKeyboardEvent

Settings

Member Visibility

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/papi-components/types/TableCellMouseEvent.html b/papi-components/types/TableCellMouseEvent.html index 0e20d0e5ef..6722349c48 100644 --- a/papi-components/types/TableCellMouseEvent.html +++ b/papi-components/types/TableCellMouseEvent.html @@ -1 +1 @@ -TableCellMouseEvent | papi-components

Type alias TableCellMouseEvent

TableCellMouseEvent: CellMouseEvent

Settings

Member Visibility

Theme

Generated using TypeDoc

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

Type alias TableCellMouseEvent

TableCellMouseEvent: CellMouseEvent

Settings

Member Visibility

Theme

Generated using TypeDoc

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

    Enable sorting of a column

  • Optional Readonly width?: number | string

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

    -

    • Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

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

    Type alias TableCopyEvent<R>

    TableCopyEvent<R>: CopyEvent<R>

    Type Parameters

    • R

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

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

    Type alias TableCopyEvent<R>

    TableCopyEvent<R>: CopyEvent<R>

    Type Parameters

    • R

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

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

    Type alias TableEditorProps<R>

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

    Type Parameters

    • R

    Type declaration

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

        • Parameters

          • Optional commitChanges: boolean

          Returns void

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

        • Parameters

          • row: R
          • Optional commitChanges: boolean

          Returns void

    • row: R

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

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

    Type alias TableEditorProps<R>

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

    Type Parameters

    • R

    Type declaration

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

        • Parameters

          • Optional commitChanges: boolean

          Returns void

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

        • Parameters

          • row: R
          • Optional commitChanges: boolean

          Returns void

    • row: R

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

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

    Type alias TablePasteEvent<R>

    TablePasteEvent<R>: PasteEvent<R>

    Type Parameters

    • R

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

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

    Type alias TablePasteEvent<R>

    TablePasteEvent<R>: PasteEvent<R>

    Type Parameters

    • R

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

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

    A set of keys representing the currently selected rows

  • Optional sortColumns?: readonly TableSortColumn[]

    An array of objects representing the currently sorted columns

    -

    • Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/papi-components/types/TableRowsChangeData.html b/papi-components/types/TableRowsChangeData.html index c92797ef6b..4ccefc2248 100644 --- a/papi-components/types/TableRowsChangeData.html +++ b/papi-components/types/TableRowsChangeData.html @@ -1 +1 @@ -TableRowsChangeData | papi-components

    Type alias TableRowsChangeData<R>

    TableRowsChangeData<R>: RowsChangeData<R>

    Type Parameters

    • R

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

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

    Type alias TableRowsChangeData<R>

    TableRowsChangeData<R>: RowsChangeData<R>

    Type Parameters

    • R

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

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

    Type alias TableSortColumn

    TableSortColumn: SortColumn

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

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

    Type alias TableSortColumn

    TableSortColumn: SortColumn

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

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

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

  • Optional id?: string

    Optional unique identifier

  • Optional menu?: GridMenuInfo

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

    -

    • Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

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

    Class default

    Handles the connection from the client to the server

    -

    Implements

    Constructors

    constructor +

    Implements

    Constructors

    constructor

    Properties

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

    Constructors

    constructor

    Properties

    Private clientGuid

    clientGuid: any

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

    -

    connect

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

    Type declaration

    Private Optional connectPromise

    connectPromise?: any

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

    connect

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

    Type declaration

    Private Optional connectPromise

    connectPromise?: any

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

    -

    connectionStatus

    connectionStatus: ConnectionStatus

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

    connectionStatus

    connectionStatus: ConnectionStatus

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

    -

    connectorInfo

    connectorInfo: Readonly<{
        clientId: number;
    }>

    Information about the connector. Populated by the server while connecting

    -

    Type declaration

    • clientId: number

    disconnect

    disconnect: (() => void)

    Type declaration

      • (): void

      • Returns void

    emitEventOnNetwork

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

    Type declaration

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

      • Type Parameters

        • T

        Parameters

        Returns Promise<void>

    Private handleEventMessage

    handleEventMessage: any

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

    connectorInfo

    connectorInfo: Readonly<{
        clientId: number;
    }>

    Information about the connector. Populated by the server while connecting

    +

    Type declaration

    • clientId: number

    disconnect

    disconnect: (() => void)

    Type declaration

      • (): void

      • Returns void

    emitEventOnNetwork

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

    Type declaration

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

      • Type Parameters

        • T

        Parameters

        Returns Promise<void>

    Private handleEventMessage

    handleEventMessage: any

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

    Param: eventMessage

    Event message to handle

    -

    Private handleRequestMessage

    handleRequestMessage: any

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

    Private handleRequestMessage

    handleRequestMessage: any

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

    Param: requestMessage

    Request message to handle

    Param: isIncoming

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

    -

    Private handleResponseMessage

    handleResponseMessage: any

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

    Private handleResponseMessage

    handleResponseMessage: any

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

    Param: response

    Response message to resolve

    -

    Private Optional localEventHandler

    localEventHandler?: any

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

    Private Optional localEventHandler

    localEventHandler?: any

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

    -

    Private Optional localRequestHandler

    localRequestHandler?: any

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

    Private Optional localRequestHandler

    localRequestHandler?: any

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

    -

    Private messageEmitters

    messageEmitters: any

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

    Private messageEmitters

    messageEmitters: any

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

    -

    notifyClientConnected

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

    Type declaration

      • (): Promise<void>

      • Returns Promise<void>

    Private onMessage

    onMessage: any

    Receives and appropriately publishes server webSocket messages

    +

    notifyClientConnected

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

    Type declaration

      • (): Promise<void>

      • Returns Promise<void>

    Private onMessage

    onMessage: any

    Receives and appropriately publishes server webSocket messages

    Param: event

    WebSocket message information

    Param: fromSelf

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

    -

    request

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

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

    +

    request

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

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

    Type declaration

    Param: requestType

    The type of request

    Param: contents

    Contents to send in the request

    Returns

    Promise that resolves with the response message

    -

    Private Optional requestRouter

    requestRouter?: any

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

    Private Optional requestRouter

    requestRouter?: any

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

    -

    Private requests

    requests: any

    All requests that are waiting for a response

    -

    Private sendMessage

    sendMessage: any

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

    +

    Private requests

    requests: any

    All requests that are waiting for a response

    +

    Private sendMessage

    sendMessage: any

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

    Param: message

    Message to send

    -

    Private subscribe

    subscribe: any

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

    +

    Private subscribe

    subscribe: any

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

    Param: messageType

    The type of message on which to subscribe the function

    Param: callback

    Function to run with the contents of the webSocket message

    Returns

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

    -

    Private Optional unsubscribeHandleEventMessage

    unsubscribeHandleEventMessage?: any

    Function that removes this handleEvent from the connection

    -

    Private Optional unsubscribeHandleInitClientMessage

    unsubscribeHandleInitClientMessage?: any

    Function that removes this initClient handler from the connection

    -

    Private Optional unsubscribeHandleRequestMessage

    unsubscribeHandleRequestMessage?: any

    Function that removes this handleRequest from the connection

    -

    Private Optional unsubscribeHandleResponseMessage

    unsubscribeHandleResponseMessage?: any

    Function that removes this response handler from the connection

    -

    Private Optional webSocket

    webSocket?: any

    The webSocket connected to the server

    -

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file +

    Private Optional unsubscribeHandleEventMessage

    unsubscribeHandleEventMessage?: any

    Function that removes this handleEvent from the connection

    +

    Private Optional unsubscribeHandleInitClientMessage

    unsubscribeHandleInitClientMessage?: any

    Function that removes this initClient handler from the connection

    +

    Private Optional unsubscribeHandleRequestMessage

    unsubscribeHandleRequestMessage?: any

    Function that removes this handleRequest from the connection

    +

    Private Optional unsubscribeHandleResponseMessage

    unsubscribeHandleResponseMessage?: any

    Function that removes this response handler from the connection

    +

    Private Optional webSocket

    webSocket?: any

    The webSocket connected to the server

    +

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

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

    Class default

    Handles the endpoint and connections from the server to the clients

    -

    Implements

    Constructors

    constructor +

    Implements

    Constructors

    constructor

    Properties

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

    Constructors

    constructor

    Properties

    Private clientSockets

    clientSockets: any

    The webSocket clients that are connected and information about them

    -

    connect

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

    Type declaration

    Private Optional connectPromise

    connectPromise?: any

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

    connect

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

    Type declaration

    Private Optional connectPromise

    connectPromise?: any

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

    -

    connectionStatus

    connectionStatus: ConnectionStatus

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

    connectionStatus

    connectionStatus: ConnectionStatus

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

    -

    connectorInfo

    connectorInfo: Readonly<{
        clientId: number;
    }>

    Information about the connector. Populated by the server while connecting

    -

    Type declaration

    • clientId: number

    disconnect

    disconnect: (() => void)

    Type declaration

      • (): void

      • Returns void

    Private disconnectClient

    disconnectClient: any

    Closes connection and unregisters a client webSocket when it has disconnected

    -

    emitEventOnNetwork

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

    Type declaration

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

      • Type Parameters

        • T

        Parameters

        Returns Promise<void>

    Private getClientIdFromSocket

    getClientIdFromSocket: any

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

    -

    Private getClientSocket

    getClientSocket: any

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

    -

    Private getClientSocketFromGuid

    getClientSocketFromGuid: any

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

    connectorInfo

    connectorInfo: Readonly<{
        clientId: number;
    }>

    Information about the connector. Populated by the server while connecting

    +

    Type declaration

    • clientId: number

    disconnect

    disconnect: (() => void)

    Type declaration

      • (): void

      • Returns void

    Private disconnectClient

    disconnectClient: any

    Closes connection and unregisters a client webSocket when it has disconnected

    +

    emitEventOnNetwork

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

    Type declaration

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

      • Type Parameters

        • T

        Parameters

        Returns Promise<void>

    Private getClientIdFromSocket

    getClientIdFromSocket: any

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

    +

    Private getClientSocket

    getClientSocket: any

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

    +

    Private getClientSocketFromGuid

    getClientSocketFromGuid: any

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

    -

    Private handleClientConnectMessage

    handleClientConnectMessage: any

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

    Private handleClientConnectMessage

    handleClientConnectMessage: any

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

    Param: clientConnect

    Message from the client about the connection

    Param: connectorId

    ClientId of the client who is sending this ClientConnect message

    -

    Private handleEventMessage

    handleEventMessage: any

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

    Private handleEventMessage

    handleEventMessage: any

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

    Param: eventMessage

    Event message to handle

    -

    Private handleRequestMessage

    handleRequestMessage: any

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

    Private handleRequestMessage

    handleRequestMessage: any

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

    Param: requestMessage

    Request to handle

    Param: requesterId

    Who sent this message

    -

    Private handleResponseMessage

    handleResponseMessage: any

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

    Private handleResponseMessage

    handleResponseMessage: any

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

    Param: response

    Response message to resolve

    Param: responderId

    Responding client

    -

    Private Optional localEventHandler

    localEventHandler?: any

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

    Private Optional localEventHandler

    localEventHandler?: any

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

    -

    Private Optional localRequestHandler

    localRequestHandler?: any

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

    Private Optional localRequestHandler

    localRequestHandler?: any

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

    -

    Private messageEmitters

    messageEmitters: any

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

    Private messageEmitters

    messageEmitters: any

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

    -

    Private Optional networkConnectorEventHandlers

    networkConnectorEventHandlers?: any

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

    -

    Private nextClientId

    nextClientId: any

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

    -

    notifyClientConnected

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

    Type declaration

      • (): Promise<void>

      • Returns Promise<void>

    Private onClientConnect

    onClientConnect: any

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

    Private Optional networkConnectorEventHandlers

    networkConnectorEventHandlers?: any

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

    +

    Private nextClientId

    nextClientId: any

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

    +

    notifyClientConnected

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

    Type declaration

      • (): Promise<void>

      • Returns Promise<void>

    Private onClientConnect

    onClientConnect: any

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

    -

    Private onClientDisconnect

    onClientDisconnect: any

    Handles when client connection disconnects. Unregisters and such

    -

    Private onMessage

    onMessage: any

    Receives and appropriately publishes webSocket messages

    +

    Private onClientDisconnect

    onClientDisconnect: any

    Handles when client connection disconnects. Unregisters and such

    +

    Private onMessage

    onMessage: any

    Receives and appropriately publishes webSocket messages

    Param: event

    WebSocket message information

    Param: fromSelf

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

    -

    request

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

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

    +

    request

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

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

    Type declaration

    Param: requestType

    The type of request

    Param: contents

    Contents to send in the request

    Returns

    Promise that resolves with the response message

    -

    Private Optional requestRouter

    requestRouter?: any

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

    Private Optional requestRouter

    requestRouter?: any

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

    -

    Private requests

    requests: any

    All requests that are waiting for a response

    -

    Private sendMessage

    sendMessage: any

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

    +

    Private requests

    requests: any

    All requests that are waiting for a response

    +

    Private sendMessage

    sendMessage: any

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

    Param: message

    Message to send

    Param: recipientId

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

    -

    Private subscribe

    subscribe: any

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

    +

    Private subscribe

    subscribe: any

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

    Param: messageType

    The type of message on which to subscribe the function

    Param: callback

    Function to run with the contents of the webSocket message

    Returns

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

    -

    Private Optional unsubscribeHandleClientConnectMessage

    unsubscribeHandleClientConnectMessage?: any

    Function that removes this clientConnect handler from connections

    -

    Private Optional unsubscribeHandleEventMessage

    unsubscribeHandleEventMessage?: any

    Function that removes this handleEvent from the connection

    -

    Private Optional unsubscribeHandleRequestMessage

    unsubscribeHandleRequestMessage?: any

    Function that removes this handleRequest from connections

    -

    Private Optional unsubscribeHandleResponseMessage

    unsubscribeHandleResponseMessage?: any

    Function that removes this response handler from connections

    -

    Private Optional webSocketServer

    webSocketServer?: any

    The webSocket connected to the server

    -

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file +

    Private Optional unsubscribeHandleClientConnectMessage

    unsubscribeHandleClientConnectMessage?: any

    Function that removes this clientConnect handler from connections

    +

    Private Optional unsubscribeHandleEventMessage

    unsubscribeHandleEventMessage?: any

    Function that removes this handleEvent from the connection

    +

    Private Optional unsubscribeHandleRequestMessage

    unsubscribeHandleRequestMessage?: any

    Function that removes this handleRequest from connections

    +

    Private Optional unsubscribeHandleResponseMessage

    unsubscribeHandleResponseMessage?: any

    Function that removes this response handler from connections

    +

    Private Optional webSocketServer

    webSocketServer?: any

    The webSocket connected to the server

    +

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

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

    Class ExecutionToken

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

    -

    Constructors

    constructor +

    Constructors

    constructor

    Properties

    name nonce type

    Methods

    getHash -

    Constructors

    constructor

    Properties

    Readonly name

    name: string

    Readonly nonce

    nonce: string

    Readonly type

    type: "extension"

    Methods

    getHash

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file +

    Constructors

    constructor

    Properties

    Readonly name

    name: string

    Readonly nonce

    nonce: string

    Readonly type

    type: "extension"

    Methods

    getHash

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

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

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

    -

    Implements

    Constructors

    constructor +

    Implements

    • WebSocket

    Constructors

    constructor

    Properties

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

    Constructors

    constructor

    Properties

    Readonly CLOSED

    CLOSED: 3

    Readonly CLOSING

    CLOSING: 2

    Readonly CONNECTING

    CONNECTING: 0

    Readonly OPEN

    OPEN: 1

    addEventListener

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

    Type declaration

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

      • Type Parameters

        • K extends keyof WebSocketEventMap

        Parameters

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

            • Parameters

              • this: WebSocket
              • ev: WebSocketEventMap[K]

              Returns any

        • Optional options: boolean | AddEventListenerOptions

        Returns void

    binaryType

    binaryType: BinaryType

    bufferedAmount

    bufferedAmount: number

    close

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

    Type declaration

      • (code?, reason?): void

      • Parameters

        • Optional code: number
        • Optional reason: string

        Returns void

    dispatchEvent

    dispatchEvent: ((event) => boolean)

    Type declaration

      • (event): boolean

      • Parameters

        • event: Event

        Returns boolean

    extensions

    extensions: string

    onclose

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

    Type declaration

      • (this, ev): any

      • Parameters

        • this: WebSocket
        • ev: CloseEvent

        Returns any

    onerror

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

    Type declaration

      • (this, ev): any

      • Parameters

        • this: WebSocket
        • ev: Event

        Returns any

    onmessage

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

    Type declaration

      • (this, ev): any

      • Parameters

        • this: WebSocket
        • ev: MessageEvent<any>

        Returns any

    onopen

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

    Type declaration

      • (this, ev): any

      • Parameters

        • this: WebSocket
        • ev: Event

        Returns any

    protocol

    protocol: string

    readyState

    readyState: number

    removeEventListener

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

    Type declaration

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

      • Type Parameters

        • K extends keyof WebSocketEventMap

        Parameters

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

            • Parameters

              • this: WebSocket
              • ev: WebSocketEventMap[K]

              Returns any

        • Optional options: boolean | EventListenerOptions

        Returns void

    send

    send: ((data) => void)

    Type declaration

      • (data): void

      • Parameters

        • data: string | ArrayBufferLike | ArrayBufferView | Blob

        Returns void

    url

    url: string

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file +

    Constructors

    constructor

    Properties

    Readonly CLOSED

    CLOSED: 3

    Readonly CLOSING

    CLOSING: 2

    Readonly CONNECTING

    CONNECTING: 0

    Readonly OPEN

    OPEN: 1

    addEventListener

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

    Type declaration

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

      • Type Parameters

        • K extends keyof WebSocketEventMap

        Parameters

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

            • Parameters

              • this: WebSocket
              • ev: WebSocketEventMap[K]

              Returns any

        • Optional options: boolean | AddEventListenerOptions

        Returns void

    binaryType

    binaryType: BinaryType

    bufferedAmount

    bufferedAmount: number

    close

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

    Type declaration

      • (code?, reason?): void

      • Parameters

        • Optional code: number
        • Optional reason: string

        Returns void

    dispatchEvent

    dispatchEvent: ((event) => boolean)

    Type declaration

      • (event): boolean

      • Parameters

        • event: Event

        Returns boolean

    extensions

    extensions: string

    onclose

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

    Type declaration

      • (this, ev): any

      • Parameters

        • this: WebSocket
        • ev: CloseEvent

        Returns any

    onerror

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

    Type declaration

      • (this, ev): any

      • Parameters

        • this: WebSocket
        • ev: Event

        Returns any

    onmessage

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

    Type declaration

      • (this, ev): any

      • Parameters

        • this: WebSocket
        • ev: MessageEvent<any>

        Returns any

    onopen

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

    Type declaration

      • (this, ev): any

      • Parameters

        • this: WebSocket
        • ev: Event

        Returns any

    protocol

    protocol: string

    readyState

    readyState: number

    removeEventListener

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

    Type declaration

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

      • Type Parameters

        • K extends keyof WebSocketEventMap

        Parameters

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

            • Parameters

              • this: WebSocket
              • ev: WebSocketEventMap[K]

              Returns any

        • Optional options: boolean | EventListenerOptions

        Returns void

    send

    send: ((data) => void)

    Type declaration

      • (data): void

      • Parameters

        • data: string | ArrayBufferLike | ArrayBufferView | Blob

        Returns void

    url

    url: string

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

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

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

    -

    Implements

    Constructors

    constructor +

    Implements

    • XMLHttpRequest

    Constructors

    constructor

    Properties

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

    Constructors

    constructor

    Properties

    Readonly DONE

    DONE: 4

    Readonly HEADERS_RECEIVED

    HEADERS_RECEIVED: 2

    Readonly LOADING

    LOADING: 3

    Readonly OPENED

    OPENED: 1

    Readonly UNSENT

    UNSENT: 0

    abort

    abort: (() => void)

    Type declaration

      • (): void

      • Returns void

    addEventListener

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

    Type declaration

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

      • Type Parameters

        • K extends keyof XMLHttpRequestEventMap

        Parameters

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

            • Parameters

              • this: XMLHttpRequest
              • ev: XMLHttpRequestEventMap[K]

              Returns any

        • Optional options: boolean | AddEventListenerOptions

        Returns void

    dispatchEvent

    dispatchEvent: ((event) => boolean)

    Type declaration

      • (event): boolean

      • Parameters

        • event: Event

        Returns boolean

    getAllResponseHeaders

    getAllResponseHeaders: (() => string)

    Type declaration

      • (): string

      • Returns string

    getResponseHeader

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

    Type declaration

      • (name): null | string

      • Parameters

        • name: string

        Returns null | string

    onabort

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

    Type declaration

      • (this, ev): any

      • Parameters

        • this: XMLHttpRequest
        • ev: ProgressEvent<EventTarget>

        Returns any

    onerror

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

    Type declaration

      • (this, ev): any

      • Parameters

        • this: XMLHttpRequest
        • ev: ProgressEvent<EventTarget>

        Returns any

    onload

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

    Type declaration

      • (this, ev): any

      • Parameters

        • this: XMLHttpRequest
        • ev: ProgressEvent<EventTarget>

        Returns any

    onloadend

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

    Type declaration

      • (this, ev): any

      • Parameters

        • this: XMLHttpRequest
        • ev: ProgressEvent<EventTarget>

        Returns any

    onloadstart

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

    Type declaration

      • (this, ev): any

      • Parameters

        • this: XMLHttpRequest
        • ev: ProgressEvent<EventTarget>

        Returns any

    onprogress

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

    Type declaration

      • (this, ev): any

      • Parameters

        • this: XMLHttpRequest
        • ev: ProgressEvent<EventTarget>

        Returns any

    onreadystatechange

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

    Type declaration

      • (this, ev): any

      • Parameters

        • this: XMLHttpRequest
        • ev: Event

        Returns any

    ontimeout

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

    Type declaration

      • (this, ev): any

      • Parameters

        • this: XMLHttpRequest
        • ev: ProgressEvent<EventTarget>

        Returns any

    open

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

    Type declaration

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

      • Parameters

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

        Returns void

    overrideMimeType

    overrideMimeType: ((mime) => void)

    Type declaration

      • (mime): void

      • Parameters

        • mime: string

        Returns void

    readyState

    readyState: number

    removeEventListener

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

    Type declaration

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

      • Type Parameters

        • K extends keyof XMLHttpRequestEventMap

        Parameters

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

            • Parameters

              • this: XMLHttpRequest
              • ev: XMLHttpRequestEventMap[K]

              Returns any

        • Optional options: boolean | EventListenerOptions

        Returns void

    response

    response: any

    responseText

    responseText: string

    responseType

    responseType: XMLHttpRequestResponseType

    responseURL

    responseURL: string

    responseXML

    responseXML: null | Document

    send

    send: ((body?) => void)

    Type declaration

      • (body?): void

      • Parameters

        • Optional body: null | Document | XMLHttpRequestBodyInit

        Returns void

    setRequestHeader

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

    Type declaration

      • (name, value): void

      • Parameters

        • name: string
        • value: string

        Returns void

    status

    status: number

    statusText

    statusText: string

    timeout

    timeout: number

    upload

    upload: XMLHttpRequestUpload

    withCredentials

    withCredentials: boolean

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file +

    Constructors

    constructor

    Properties

    Readonly DONE

    DONE: 4

    Readonly HEADERS_RECEIVED

    HEADERS_RECEIVED: 2

    Readonly LOADING

    LOADING: 3

    Readonly OPENED

    OPENED: 1

    Readonly UNSENT

    UNSENT: 0

    abort

    abort: (() => void)

    Type declaration

      • (): void

      • Returns void

    addEventListener

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

    Type declaration

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

      • Type Parameters

        • K extends keyof XMLHttpRequestEventMap

        Parameters

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

            • Parameters

              • this: XMLHttpRequest
              • ev: XMLHttpRequestEventMap[K]

              Returns any

        • Optional options: boolean | AddEventListenerOptions

        Returns void

    dispatchEvent

    dispatchEvent: ((event) => boolean)

    Type declaration

      • (event): boolean

      • Parameters

        • event: Event

        Returns boolean

    getAllResponseHeaders

    getAllResponseHeaders: (() => string)

    Type declaration

      • (): string

      • Returns string

    getResponseHeader

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

    Type declaration

      • (name): null | string

      • Parameters

        • name: string

        Returns null | string

    onabort

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

    Type declaration

      • (this, ev): any

      • Parameters

        • this: XMLHttpRequest
        • ev: ProgressEvent<EventTarget>

        Returns any

    onerror

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

    Type declaration

      • (this, ev): any

      • Parameters

        • this: XMLHttpRequest
        • ev: ProgressEvent<EventTarget>

        Returns any

    onload

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

    Type declaration

      • (this, ev): any

      • Parameters

        • this: XMLHttpRequest
        • ev: ProgressEvent<EventTarget>

        Returns any

    onloadend

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

    Type declaration

      • (this, ev): any

      • Parameters

        • this: XMLHttpRequest
        • ev: ProgressEvent<EventTarget>

        Returns any

    onloadstart

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

    Type declaration

      • (this, ev): any

      • Parameters

        • this: XMLHttpRequest
        • ev: ProgressEvent<EventTarget>

        Returns any

    onprogress

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

    Type declaration

      • (this, ev): any

      • Parameters

        • this: XMLHttpRequest
        • ev: ProgressEvent<EventTarget>

        Returns any

    onreadystatechange

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

    Type declaration

      • (this, ev): any

      • Parameters

        • this: XMLHttpRequest
        • ev: Event

        Returns any

    ontimeout

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

    Type declaration

      • (this, ev): any

      • Parameters

        • this: XMLHttpRequest
        • ev: ProgressEvent<EventTarget>

        Returns any

    open

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

    Type declaration

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

      • Parameters

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

        Returns void

    overrideMimeType

    overrideMimeType: ((mime) => void)

    Type declaration

      • (mime): void

      • Parameters

        • mime: string

        Returns void

    readyState

    readyState: number

    removeEventListener

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

    Type declaration

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

      • Type Parameters

        • K extends keyof XMLHttpRequestEventMap

        Parameters

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

            • Parameters

              • this: XMLHttpRequest
              • ev: XMLHttpRequestEventMap[K]

              Returns any

        • Optional options: boolean | EventListenerOptions

        Returns void

    response

    response: any

    responseText

    responseText: string

    responseType

    responseType: XMLHttpRequestResponseType

    responseURL

    responseURL: string

    responseXML

    responseXML: null | Document

    send

    send: ((body?) => void)

    Type declaration

      • (body?): void

      • Parameters

        • Optional body: null | Document | XMLHttpRequestBodyInit

        Returns void

    setRequestHeader

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

    Type declaration

      • (name, value): void

      • Parameters

        • name: string
        • value: string

        Returns void

    status

    status: number

    statusText

    statusText: string

    timeout

    timeout: number

    upload

    upload: XMLHttpRequestUpload

    withCredentials

    withCredentials: boolean

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

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

    -

    Type Parameters

    Hierarchy

    Implements

    Constructors

    constructor +

    Type Parameters

    • T

    Hierarchy

    Implements

    Constructors

    constructor

    Properties

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

    Constructors

    constructor

    Properties

    dispose

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

    Release resources and notify dependent services when tearing down an object

    Type declaration

      • (): Promise<boolean>

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

        -

        Returns Promise<boolean>

    emit

    emit: ((event) => void)

    Type declaration

      • (event): void

      • Runs the subscriptions for the event

        +

        Returns Promise<boolean>

    emit

    emit: ((event) => void)

    Type declaration

      • (event): void

      • Runs the subscriptions for the event

        Parameters

        • event: T

          Event data to provide to subscribed callbacks

          -

        Returns void

    Private isDisposed

    isDisposed: any

    Whether this emitter has been disposed

    -

    Private Optional lazyEvent

    lazyEvent?: any

    Event for listeners to subscribe to. Lazy loaded

    -

    subscribe

    subscribe: PapiEvent<T>

    Subscribes a function to run when this event is emitted.

    +

    Returns void

    Private isDisposed

    isDisposed: any

    Whether this emitter has been disposed

    +

    Private Optional lazyEvent

    lazyEvent?: any

    Event for listeners to subscribe to. Lazy loaded

    +

    subscribe

    subscribe: PapiEvent<T>

    Subscribes a function to run when this event is emitted.

    Param: callback

    Function to run with the event when it is emitted

    Returns

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

    Alias

    event

    -

    Private Optional subscriptions

    subscriptions?: any

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

    -

    Accessors

    event

    Private Optional subscriptions

    subscriptions?: any

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

    +

    Accessors

    event

    Methods

    Protected assertNotDisposed

    Protected disposeFn

    Methods

    Protected assertNotDisposed

    Protected disposeFn

    Protected emitFn

    Protected emitFn

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file +

    Parameters

    Returns void

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file diff --git a/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 c2fe91618a..b2e04621da 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

    Constructors

    constructor

    Properties

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

    Type Parameters

    • T

    Parameters

    • networkSubscriber: PapiEventHandler<T>

      Callback that accepts the event and emits it to other processes

    • networkDisposer: (() => void)

      Callback that unlinks this emitter from the network

        • (): void

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

          -

          Returns void

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

    Properties

    dispose

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

    Release resources and notify dependent services when tearing down an object

    -

    Type declaration

      • (): Promise<boolean>

      • Returns Promise<boolean>

    emit

    emit: ((event) => void)

    Type declaration

      • (event): void

      • Parameters

        • event: T

        Returns void

    Private networkDisposer

    networkDisposer: any

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

    -

    Private networkSubscriber

    networkSubscriber: any

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

    -

    subscribe

    subscribe: PapiEvent<T>

    Subscribes a function to run when this event is emitted.

    +

    Returns void

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

    Properties

    dispose

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

    Release resources and notify dependent services when tearing down an object

    +

    Type declaration

      • (): Promise<boolean>

      • Returns Promise<boolean>

    emit

    emit: ((event) => void)

    Type declaration

      • (event): void

      • Parameters

        • event: T

        Returns void

    Private networkDisposer

    networkDisposer: any

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

    +

    Private networkSubscriber

    networkSubscriber: any

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

    +

    subscribe

    subscribe: PapiEvent<T>

    Subscribes a function to run when this event is emitted.

    Param: callback

    Function to run with the event when it is emitted

    Returns

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

    Alias

    event

    -

    Accessors

    event

    Accessors

    event

    Methods

    Protected assertNotDisposed

    Protected disposeFn

    Methods

    Protected assertNotDisposed

    Protected disposeFn

    Protected emitFn

    Protected emitFn

    emitLocal

    emitLocal

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file +

    Returns void

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

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

    See

    IDataProviderEngine for more information on extending this class.

    -

    Type Parameters

    Constructors

    constructor +

    Type Parameters

    Constructors

    constructor

    Properties

    notifyUpdate -

    Constructors

    constructor

    Properties

    notifyUpdate

    notifyUpdate: DataProviderEngineNotifyUpdate<TDataTypes>

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file +

    Constructors

    constructor

    Properties

    notifyUpdate

    notifyUpdate: DataProviderEngineNotifyUpdate<TDataTypes>

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file diff --git a/papi-dts/classes/_shared_utils_async_variable_.default.html b/papi-dts/classes/_shared_utils_async_variable_.default.html index 77f5a6f0ec..7943e219b6 100644 --- a/papi-dts/classes/_shared_utils_async_variable_.default.html +++ b/papi-dts/classes/_shared_utils_async_variable_.default.html @@ -1,5 +1,5 @@ default | papi-dts

    Class default<T>

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

    -

    Type Parameters

    • T

    Constructors

    constructor +

    Type Parameters

    • T

    Constructors

    constructor

    Properties

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

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

    -

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

    Properties

    Private complete

    complete: any

    Prevent any further updates to this variable

    -

    Private Readonly promiseToValue

    promiseToValue: any

    Private rejecter

    rejecter: any

    Private resolver

    resolver: any

    Private Readonly variableName

    variableName: any

    Accessors

    hasSettled

    • get hasSettled(): boolean

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

      +

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

    Properties

    Private complete

    complete: any

    Prevent any further updates to this variable

    +

    Private Readonly promiseToValue

    promiseToValue: any

    Private rejecter

    rejecter: any

    Private resolver

    resolver: any

    Private Readonly variableName

    variableName: any

    Accessors

    hasSettled

    • get hasSettled(): boolean

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

      Returns boolean

      Whether the variable was already resolved or rejected

      -

    promise

    • get promise(): Promise<T>

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

    promise

    • get promise(): Promise<T>

    • Get this variable's promise to a value. This always returns the same promise even after the value has been resolved or rejected.

      Returns Promise<T>

      The promise for the value to be set

      -

    Methods

    rejectWithReason

    • rejectWithReason(reason, throwIfAlreadySettled?): void

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

      +

    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

      • Optional throwIfAlreadySettled: boolean

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

        -

      Returns void

    resolveToValue

    • resolveToValue(value, throwIfAlreadySettled?): void

    • Resolve this variable's promise to the given value

      +

    Returns void

    resolveToValue

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file +

    Returns void

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

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

    Class default

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

    -

    Constructors

    constructor +

    Constructors

    constructor

    Properties

    name unsubscribers

    Methods

    add runAllUnsubscribers -

    Constructors

    constructor

    Properties

    Private name

    name: any

    Readonly unsubscribers

    unsubscribers: Set<Unsubscriber | UnsubscriberAsync>

    Methods

    add

    • add(...unsubscribers): void

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

      +

    Constructors

    constructor

    Properties

    Private name

    name: any

    Readonly unsubscribers

    unsubscribers: Set<Unsubscriber | UnsubscriberAsync>

    Methods

    add

    runAllUnsubscribers

    • runAllUnsubscribers(): Promise<boolean>

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

      +

    Returns void

    runAllUnsubscribers

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

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

    Enumeration EntryType

    Type of file system item in a directory

    -

    Enumeration Members

    Directory +

    Enumeration Members

    Directory File Unknown -

    Enumeration Members

    Directory

    Directory: "directory"

    File

    File: "file"

    Unknown

    Unknown: "unknown"

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file +

    Enumeration Members

    Directory

    Directory: "directory"

    File

    File: "file"

    Unknown

    Unknown: "unknown"

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

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

    Enumeration ConnectionStatus

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

    -

    Enumeration Members

    Connected +

    Enumeration Members

    Connected Connecting Disconnected

    Enumeration Members

    Connected

    Connected: 2

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

    -

    Connecting

    Connecting: 1

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

    -

    Disconnected

    Disconnected: 0

    This connector is not connected to the network

    -

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file +

    Connecting

    Connecting: 1

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

    +

    Disconnected

    Disconnected: 0

    This connector is not connected to the network

    +

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

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

    Enumeration MessageType

    WebSocket message type that indicates how to handle it

    -

    Enumeration Members

    ClientConnect +

    Enumeration Members

    ClientConnect Event InitClient Request Response -

    Enumeration Members

    ClientConnect

    ClientConnect: "client-connect"

    Event

    Event: "event"

    InitClient

    InitClient: "init-client"

    Request

    Request: "request"

    Response

    Response: "response"

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file +

    Enumeration Members

    ClientConnect

    ClientConnect: "client-connect"

    Event

    Event: "event"

    InitClient

    InitClient: "init-client"

    Request

    Request: "request"

    Response

    Response: "response"

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

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

    Enumeration ProcessType

    Type of Paranext process

    -

    Enumeration Members

    ExtensionHost +

    Enumeration Members

    ExtensionHost Main Renderer -

    Enumeration Members

    ExtensionHost

    ExtensionHost: "extension-host"

    Main

    Main: "main"

    Renderer

    Renderer: "renderer"

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file +

    Enumeration Members

    ExtensionHost

    ExtensionHost: "extension-host"

    Main

    Main: "main"

    Renderer

    Renderer: "renderer"

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

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

    Enumeration WebViewContentType

    The type of code that defines a webview's content

    -

    Enumeration Members

    HTML +

    Enumeration Members

    HTML React URL

    Enumeration Members

    HTML

    HTML: "html"

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

    -

    React

    React: "react"

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

    React

    React: "react"

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

    -

    URL

    URL: "url"

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

    URL

    URL: "url"

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

    -

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

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

    Enumeration RequestHandlerType

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

    -

    Enumeration Members

    Args +

    Enumeration Members

    Args Complex Contents -

    Enumeration Members

    Args

    Args: "args"

    Complex

    Complex: "complex"

    Contents

    Contents: "contents"

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file +

    Enumeration Members

    Args

    Args: "args"

    Complex

    Complex: "complex"

    Contents

    Contents: "contents"

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file diff --git a/papi-dts/functions/_client_services_web_socket_factory_.createWebSocket.html b/papi-dts/functions/_client_services_web_socket_factory_.createWebSocket.html index 9fdcd4e312..f7874c7942 100644 --- a/papi-dts/functions/_client_services_web_socket_factory_.createWebSocket.html +++ b/papi-dts/functions/_client_services_web_socket_factory_.createWebSocket.html @@ -1,3 +1,3 @@ createWebSocket | papi-dts

    Function createWebSocket

    • createWebSocket(url): Promise<WebSocket>

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

      Parameters

      • url: string

      Returns Promise<WebSocket>

      WebSocket

      -

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/papi-dts/functions/_extension_host_services_extension_storage_service_.buildExtensionPathFromName.html b/papi-dts/functions/_extension_host_services_extension_storage_service_.buildExtensionPathFromName.html index 3a0bf72aa4..7c5116c285 100644 --- a/papi-dts/functions/_extension_host_services_extension_storage_service_.buildExtensionPathFromName.html +++ b/papi-dts/functions/_extension_host_services_extension_storage_service_.buildExtensionPathFromName.html @@ -1,2 +1,2 @@ buildExtensionPathFromName | papi-dts

    Function buildExtensionPathFromName

    • buildExtensionPathFromName(extensionName, fileName): string

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

      -

      Parameters

      • extensionName: string
      • fileName: string

      Returns string

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Parameters

    Returns string

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/papi-dts/functions/_extension_host_services_extension_storage_service_.setExtensionUris.html b/papi-dts/functions/_extension_host_services_extension_storage_service_.setExtensionUris.html index 3676c46b09..90014660f5 100644 --- a/papi-dts/functions/_extension_host_services_extension_storage_service_.setExtensionUris.html +++ b/papi-dts/functions/_extension_host_services_extension_storage_service_.setExtensionUris.html @@ -1,3 +1,3 @@ setExtensionUris | papi-dts

    Function setExtensionUris

    • setExtensionUris(urisPerExtension): void

    • This is only intended to be called by the extension service. This service cannot call into the extension service or it causes a circular dependency.

      -

      Parameters

      • urisPerExtension: Map<string, string>

      Returns void

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Parameters

    Returns void

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

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

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

    -

    • Returns Promise<void>

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Returns Promise<void>

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/papi-dts/functions/_node_services_node_file_system_service_.createDir.html b/papi-dts/functions/_node_services_node_file_system_service_.createDir.html index 33e4827030..fc5547c244 100644 --- a/papi-dts/functions/_node_services_node_file_system_service_.createDir.html +++ b/papi-dts/functions/_node_services_node_file_system_service_.createDir.html @@ -1,4 +1,4 @@ createDir | papi-dts

    Function createDir

    • createDir(uri): Promise<void>

    • Create a directory in the file system if it does not exist. Does not throw if it already exists.

      Parameters

      • uri: string

        URI of directory

      Returns Promise<void>

      Promise that resolves once the directory has been created

      -

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/papi-dts/functions/_node_services_node_file_system_service_.deleteDir.html b/papi-dts/functions/_node_services_node_file_system_service_.deleteDir.html index b08e001378..68f87974fb 100644 --- a/papi-dts/functions/_node_services_node_file_system_service_.deleteDir.html +++ b/papi-dts/functions/_node_services_node_file_system_service_.deleteDir.html @@ -1,4 +1,4 @@ deleteDir | papi-dts

    Function deleteDir

    • deleteDir(uri): Promise<void>

    • Remove a directory and all its contents recursively from the file system

      Parameters

      • uri: string

        URI of directory

      Returns Promise<void>

      Promise that resolves when the delete operation finishes

      -

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/papi-dts/functions/_node_services_node_file_system_service_.deleteFile.html b/papi-dts/functions/_node_services_node_file_system_service_.deleteFile.html index a17582a715..2cc26a3497 100644 --- a/papi-dts/functions/_node_services_node_file_system_service_.deleteFile.html +++ b/papi-dts/functions/_node_services_node_file_system_service_.deleteFile.html @@ -1,4 +1,4 @@ deleteFile | papi-dts

    Function deleteFile

    • deleteFile(uri): Promise<void>

    • Delete a file if it exists

      Parameters

      • uri: string

        URI of file

      Returns Promise<void>

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

      -

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

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

    Parameters

    Returns Promise<BigIntStats | undefined>

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

    -

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/papi-dts/functions/_node_services_node_file_system_service_.readDir.html b/papi-dts/functions/_node_services_node_file_system_service_.readDir.html index 54fdf20177..0cef4feba3 100644 --- a/papi-dts/functions/_node_services_node_file_system_service_.readDir.html +++ b/papi-dts/functions/_node_services_node_file_system_service_.readDir.html @@ -2,4 +2,4 @@

    Parameters

    Returns Promise<DirectoryEntries>

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

    -

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/papi-dts/functions/_node_services_node_file_system_service_.readFileBinary.html b/papi-dts/functions/_node_services_node_file_system_service_.readFileBinary.html index 39725c25cf..2ae8be76fc 100644 --- a/papi-dts/functions/_node_services_node_file_system_service_.readFileBinary.html +++ b/papi-dts/functions/_node_services_node_file_system_service_.readFileBinary.html @@ -1,4 +1,4 @@ readFileBinary | papi-dts

    Function readFileBinary

    • readFileBinary(uri): Promise<Buffer>

    • Read a binary file

      Parameters

      • uri: string

        URI of file

      Returns Promise<Buffer>

      Promise that resolves to the contents of the file

      -

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/papi-dts/functions/_node_services_node_file_system_service_.readFileText.html b/papi-dts/functions/_node_services_node_file_system_service_.readFileText.html index 5ab952a8a9..d554fa299b 100644 --- a/papi-dts/functions/_node_services_node_file_system_service_.readFileText.html +++ b/papi-dts/functions/_node_services_node_file_system_service_.readFileText.html @@ -1,4 +1,4 @@ readFileText | papi-dts

    Function readFileText

    • readFileText(uri): Promise<string>

    • Read a text file

      Parameters

      • uri: string

        URI of file

      Returns Promise<string>

      Promise that resolves to the contents of the file

      -

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/papi-dts/functions/_node_services_node_file_system_service_.touch.html b/papi-dts/functions/_node_services_node_file_system_service_.touch.html index 981cc2c328..c19bf00ea5 100644 --- a/papi-dts/functions/_node_services_node_file_system_service_.touch.html +++ b/papi-dts/functions/_node_services_node_file_system_service_.touch.html @@ -1,4 +1,4 @@ touch | papi-dts

    Function touch

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

    • Set the last modified and accessed times for the file or directory

      Parameters

      • uri: string

        URI of file or directory

      • date: Date

      Returns Promise<void>

      Promise that resolves once the touch operation finishes

      -

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/papi-dts/functions/_node_services_node_file_system_service_.writeFile.html b/papi-dts/functions/_node_services_node_file_system_service_.writeFile.html index 26d695e6d8..35b91f34c3 100644 --- a/papi-dts/functions/_node_services_node_file_system_service_.writeFile.html +++ b/papi-dts/functions/_node_services_node_file_system_service_.writeFile.html @@ -2,4 +2,4 @@

    Parameters

    Returns Promise<void>

    Promise that resolves after writing the file

    -

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

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

    Function createNonce

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

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

    Function createUuid

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

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

    Function createUuid

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/papi-dts/functions/_node_utils_util_.getPathFromUri.html b/papi-dts/functions/_node_utils_util_.getPathFromUri.html index d3b8d5b99d..eb0b704bc8 100644 --- a/papi-dts/functions/_node_utils_util_.getPathFromUri.html +++ b/papi-dts/functions/_node_utils_util_.getPathFromUri.html @@ -1,4 +1,4 @@ getPathFromUri | papi-dts

    Function getPathFromUri

    • getPathFromUri(uri): string

    • Resolves the uri to a path

      Parameters

      • uri: string

        The uri to resolve

      Returns string

      Real path to the uri supplied

      -

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

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

    Parameters

    Returns Uri

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

    -

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

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

    Function resolveHtmlPath

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

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

    Function resolveHtmlPath

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

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

    Parameters

    Returns void

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Returns void

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/papi-dts/functions/_renderer_hooks_hook_generators_create_use_data_hook_util_.default.html b/papi-dts/functions/_renderer_hooks_hook_generators_create_use_data_hook_util_.default.html index 5439f2a721..55f1d818a5 100644 --- a/papi-dts/functions/_renderer_hooks_hook_generators_create_use_data_hook_util_.default.html +++ b/papi-dts/functions/_renderer_hooks_hook_generators_create_use_data_hook_util_.default.html @@ -3,4 +3,4 @@

    Type Parameters

    Parameters

    Returns UseDataHookGeneric<TUseDataProviderParams>

    useData hook for getting data from a data provider

    -

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

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

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

    A function that takes in a networkObjectSource and returns a NetworkObject

    -

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

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

    Type Parameters

    Parameters

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

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Type Parameters

    Parameters

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

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

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

    Returns undefined | DataProviders[DataProviderName]

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

    -

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

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

    -

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/papi-dts/functions/_renderer_hooks_papi_hooks_use_dialog_callback_hook_.default.html b/papi-dts/functions/_renderer_hooks_papi_hooks_use_dialog_callback_hook_.default.html index 367267f6a1..adce5515eb 100644 --- a/papi-dts/functions/_renderer_hooks_papi_hooks_use_dialog_callback_hook_.default.html +++ b/papi-dts/functions/_renderer_hooks_papi_hooks_use_dialog_callback_hook_.default.html @@ -59,7 +59,7 @@ specify as many or as few properties here as you want to overwrite the properties in the options you provide to the hook -
  • default<DialogTabType, DialogOptions>(dialogType, options, resolveCallback): ((optionOverrides?) => Promise<void>)

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

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

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

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

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

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

    The callback to run when the event is emitted

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

    -

    • Returns void

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Returns void

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

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

    The callback to run when the event is emitted

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

    -

    • Returns void

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Returns void

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

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

    ï¼ returns [data, setData, isLoading]

    -

    Type Parameters

    Parameters

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

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Type Parameters

    Parameters

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

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

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

    Returns undefined | ProjectDataProviders[ProjectType]

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

    -

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

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

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/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 8dd2b18166..7948418066 100644 --- a/papi-dts/functions/_renderer_hooks_papi_hooks_use_setting_hook_.default.html +++ b/papi-dts/functions/_renderer_hooks_papi_hooks_use_setting_hook_.default.html @@ -14,4 +14,4 @@ papi, if any
  • setSetting: Function that updates the setting to a new value
    • -

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/papi-dts/functions/_renderer_services_renderer_web_socket_service_.blockWebSocketsToPapiNetwork.html b/papi-dts/functions/_renderer_services_renderer_web_socket_service_.blockWebSocketsToPapiNetwork.html index 8ecfddfec1..c3c73d4f7b 100644 --- a/papi-dts/functions/_renderer_services_renderer_web_socket_service_.blockWebSocketsToPapiNetwork.html +++ b/papi-dts/functions/_renderer_services_renderer_web_socket_service_.blockWebSocketsToPapiNetwork.html @@ -1,2 +1,2 @@ blockWebSocketsToPapiNetwork | papi-dts

    Function blockWebSocketsToPapiNetwork

    • blockWebSocketsToPapiNetwork(): void

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

      -

      Returns void

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Returns void

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

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

    Function getDataProviderDataTypeFromFunctionName

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/papi-dts/functions/_shared_services_command_service_.addThree.html b/papi-dts/functions/_shared_services_command_service_.addThree.html index 3e219bf505..63d80c2ba8 100644 --- a/papi-dts/functions/_shared_services_command_service_.addThree.html +++ b/papi-dts/functions/_shared_services_command_service_.addThree.html @@ -1 +1 @@ -addThree | papi-dts

    Function addThree

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

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

    Function addThree

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

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

    Type Parameters

    Parameters

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

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

    -

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/papi-dts/functions/_shared_services_command_service_.initialize.html b/papi-dts/functions/_shared_services_command_service_.initialize.html index dfdb8c65c0..20e0f1ac46 100644 --- a/papi-dts/functions/_shared_services_command_service_.initialize.html +++ b/papi-dts/functions/_shared_services_command_service_.initialize.html @@ -1,2 +1,2 @@ initialize | papi-dts

    Function initialize

    • initialize(): Promise<void>

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

      -

      Returns Promise<void>

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Returns Promise<void>

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

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

    Function to run when the command is invoked

    • Returns Promise<UnsubscriberAsync>

    True if successfully registered, throws with error message if not

    -

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/papi-dts/functions/_shared_services_command_service_.sendCommand.html b/papi-dts/functions/_shared_services_command_service_.sendCommand.html index b245142c8e..50c0e2d6bf 100644 --- a/papi-dts/functions/_shared_services_command_service_.sendCommand.html +++ b/papi-dts/functions/_shared_services_command_service_.sendCommand.html @@ -1,2 +1,2 @@ sendCommand | papi-dts

    Function sendCommand

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

    • Send a command to the backend.

      -

      Type Parameters

      • CommandName extends keyof CommandHandlers

      Parameters

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

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

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Type Parameters

    Parameters

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

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

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

    Function squareAndConcat

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

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

    Function squareAndConcat

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

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

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

    • Returns Promise<void>

    Promise that resolves when finished connecting

    -

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

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

    Function disconnect

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Returns void

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

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

    Type Parameters

    Parameters

    Returns Promise<void>

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Returns Promise<void>

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

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

    Function getClientId

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Returns number

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

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

    Type Parameters

    Parameters

    Returns Promise<ComplexResponse<TReturn>>

    Promise that resolves with the response message

    -

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/papi-dts/functions/_shared_services_data_provider_service_.getByType.html b/papi-dts/functions/_shared_services_data_provider_service_.getByType.html index ab9d8c3ca5..f823093cf7 100644 --- a/papi-dts/functions/_shared_services_data_provider_service_.getByType.html +++ b/papi-dts/functions/_shared_services_data_provider_service_.getByType.html @@ -1,4 +1,4 @@ getByType | papi-dts

    Function getByType

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

    • Get a data provider that has previously been set up

      Type Parameters

      Parameters

      • providerName: string

        Name of the desired data provider

      Returns Promise<T | undefined>

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

      -

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/papi-dts/functions/_shared_services_data_provider_service_.registerEngineByType.html b/papi-dts/functions/_shared_services_data_provider_service_.registerEngineByType.html index d6e3085e2f..233858fa2d 100644 --- a/papi-dts/functions/_shared_services_data_provider_service_.registerEngineByType.html +++ b/papi-dts/functions/_shared_services_data_provider_service_.registerEngineByType.html @@ -12,4 +12,4 @@ set methods are layered over to facilitate data provider subscriptions.

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

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

    -

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

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

    Name of the service to show in the log

  • Optional tag: string

    Optional tag at the end of the service name

    • Returns string

    Formatted string of a service message

    -

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

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

    Function createNetworkConnector

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

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

    Function onDidCreateNetworkObject

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Parameters

    Returns Unsubscriber

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

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

    Function onDidDisposeNetworkObject

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Parameters

    Returns Unsubscriber

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/papi-dts/functions/_shared_services_network_object_service_.overrideDispose.html b/papi-dts/functions/_shared_services_network_object_service_.overrideDispose.html index c260e2fb78..bf21726382 100644 --- a/papi-dts/functions/_shared_services_network_object_service_.overrideDispose.html +++ b/papi-dts/functions/_shared_services_network_object_service_.overrideDispose.html @@ -1,2 +1,2 @@ overrideDispose | papi-dts

    Function overrideDispose

    • overrideDispose(objectToMutate, newDispose): void

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

      -

      Parameters

      Returns void

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Parameters

    Returns void

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

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

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

    Type Parameters

    Parameters

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

    Event emitter whose event works between connections

    -

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

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

    Type Parameters

    Parameters

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

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

    -

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/papi-dts/functions/_shared_services_network_service_.getNetworkEvent.html b/papi-dts/functions/_shared_services_network_service_.getNetworkEvent.html index d7e6e394df..ef5701322d 100644 --- a/papi-dts/functions/_shared_services_network_service_.getNetworkEvent.html +++ b/papi-dts/functions/_shared_services_network_service_.getNetworkEvent.html @@ -1,4 +1,4 @@ getNetworkEvent | papi-dts

    Function getNetworkEvent

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

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

      Type Parameters

      • T

      Parameters

      • eventType: string

        Unique network event type for coordinating between connections

      Returns PapiEvent<T>

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

      -

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

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

    Function initialize

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Returns Promise<void>

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

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

    Function onDidClientConnect

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Parameters

    Returns Unsubscriber

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

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

    Function onDidClientDisconnect

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Parameters

    Returns Unsubscriber

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

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

    Returns Promise<UnsubscriberAsync>

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

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

  • Parameters

    Returns Promise<UnsubscriberAsync>

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

  • Parameters

    Returns Promise<UnsubscriberAsync>

    • Settings

    Member Visibility

    Theme

    Generated using TypeDoc

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

  • Parameters

    Returns Promise<UnsubscriberAsync>

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

  • Parameters

    Returns Promise<UnsubscriberAsync>

    • Settings

    Member Visibility

    Theme

    Generated using TypeDoc

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

    Type Parameters

    Parameters

    Returns Promise<TReturn>

    Promise that resolves with the response message

    -

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

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

    Function shutdown

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Returns void

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/papi-dts/functions/_shared_services_project_data_provider_service_.get.html b/papi-dts/functions/_shared_services_project_data_provider_service_.get.html index 34d3adb2a5..2d69be02cc 100644 --- a/papi-dts/functions/_shared_services_project_data_provider_service_.get.html +++ b/papi-dts/functions/_shared_services_project_data_provider_service_.get.html @@ -7,4 +7,4 @@

    Returns Promise<ProjectDataProviders[ProjectType]>

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

    Example

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

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

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

    Type Parameters

    Parameters

    Returns Promise<Dispose>

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

    -

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

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

    Function getProcessType

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/papi-dts/functions/_shared_utils_internal_util_.isClient.html b/papi-dts/functions/_shared_utils_internal_util_.isClient.html index 8f2b604ea7..bf8938efd9 100644 --- a/papi-dts/functions/_shared_utils_internal_util_.isClient.html +++ b/papi-dts/functions/_shared_utils_internal_util_.isClient.html @@ -1,3 +1,3 @@ isClient | papi-dts

    Function isClient

    • isClient(): boolean

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

      Returns boolean

      Returns true if running on a client, false otherwise

      -

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/papi-dts/functions/_shared_utils_internal_util_.isExtensionHost.html b/papi-dts/functions/_shared_utils_internal_util_.isExtensionHost.html index f8058742dc..ffa5a5c4cc 100644 --- a/papi-dts/functions/_shared_utils_internal_util_.isExtensionHost.html +++ b/papi-dts/functions/_shared_utils_internal_util_.isExtensionHost.html @@ -1,3 +1,3 @@ isExtensionHost | papi-dts

    Function isExtensionHost

    • isExtensionHost(): boolean

    • Determine if running on the extension host

      Returns boolean

      Returns true if running on the extension host, false otherwise

      -

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/papi-dts/functions/_shared_utils_internal_util_.isRenderer.html b/papi-dts/functions/_shared_utils_internal_util_.isRenderer.html index 27623ccbd4..76f0f19b75 100644 --- a/papi-dts/functions/_shared_utils_internal_util_.isRenderer.html +++ b/papi-dts/functions/_shared_utils_internal_util_.isRenderer.html @@ -1,3 +1,3 @@ isRenderer | papi-dts

    Function isRenderer

    • isRenderer(): boolean

    • Determine if running on the renderer process

      Returns boolean

      Returns true if running on the renderer, false otherwise

      -

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/papi-dts/functions/_shared_utils_internal_util_.isServer.html b/papi-dts/functions/_shared_utils_internal_util_.isServer.html index aa0840bfe0..1323cf3e65 100644 --- a/papi-dts/functions/_shared_utils_internal_util_.isServer.html +++ b/papi-dts/functions/_shared_utils_internal_util_.isServer.html @@ -1,3 +1,3 @@ isServer | papi-dts

    Function isServer

    • isServer(): boolean

    • Determine if running on the server process (main)

      Returns boolean

      Returns true if running on the server, false otherwise

      -

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

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

    Function aggregateUnsubscriberAsyncs

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/papi-dts/functions/_shared_utils_papi_util_.aggregateUnsubscribers.html b/papi-dts/functions/_shared_utils_papi_util_.aggregateUnsubscribers.html index b012effda9..e057a8bca5 100644 --- a/papi-dts/functions/_shared_utils_papi_util_.aggregateUnsubscribers.html +++ b/papi-dts/functions/_shared_utils_papi_util_.aggregateUnsubscribers.html @@ -1,4 +1,4 @@ aggregateUnsubscribers | papi-dts

    Function aggregateUnsubscribers

    • aggregateUnsubscribers(unsubscribers): Unsubscriber

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

      Parameters

      • unsubscribers: Unsubscriber[]

        All unsubscribers to aggregate into one unsubscriber

      Returns Unsubscriber

      Function that unsubscribes from all passed in unsubscribers when run

      -

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

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

    Promise that resolves when the service is finished initializing

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

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

    -

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

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

    Returns boolean

    True if a and b are deeply equal; false otherwise

    -

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/papi-dts/functions/_shared_utils_papi_util_.deserialize.html b/papi-dts/functions/_shared_utils_papi_util_.deserialize.html index 9f4b196456..fb240242ac 100644 --- a/papi-dts/functions/_shared_utils_papi_util_.deserialize.html +++ b/papi-dts/functions/_shared_utils_papi_util_.deserialize.html @@ -1,12 +1,11 @@ -deserialize | papi-dts

    Function deserialize

    Returns any

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

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

    Function deserializeRequestType

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Parameters

    Returns RequestType

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/papi-dts/functions/_shared_utils_papi_util_.getModuleSimilarApiMessage.html b/papi-dts/functions/_shared_utils_papi_util_.getModuleSimilarApiMessage.html index ff23daf672..252c2050fe 100644 --- a/papi-dts/functions/_shared_utils_papi_util_.getModuleSimilarApiMessage.html +++ b/papi-dts/functions/_shared_utils_papi_util_.getModuleSimilarApiMessage.html @@ -1,4 +1,4 @@ getModuleSimilarApiMessage | papi-dts

    Function getModuleSimilarApiMessage

    • getModuleSimilarApiMessage(moduleName): string

    • Get a message that says the module import was rejected and to try a similar api if available.

      Parameters

      • moduleName: string

        Name of required module that was rejected

      Returns string

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

      -

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/papi-dts/functions/_shared_utils_papi_util_.htmlEncode.html b/papi-dts/functions/_shared_utils_papi_util_.htmlEncode.html index cd23dd2fbb..5996c3e828 100644 --- a/papi-dts/functions/_shared_utils_papi_util_.htmlEncode.html +++ b/papi-dts/functions/_shared_utils_papi_util_.htmlEncode.html @@ -1,4 +1,4 @@ htmlEncode | papi-dts

    Function htmlEncode

    • htmlEncode(str): string

    • HTML Encodes the provided string. Thanks to ChatGPT

      Parameters

      • str: string

        String to HTML encode

      Returns string

      HTML-encoded string

      -

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/papi-dts/functions/_shared_utils_papi_util_.isSerializable.html b/papi-dts/functions/_shared_utils_papi_util_.isSerializable.html index 22e61be1ab..0f22090d68 100644 --- a/papi-dts/functions/_shared_utils_papi_util_.isSerializable.html +++ b/papi-dts/functions/_shared_utils_papi_util_.isSerializable.html @@ -2,8 +2,7 @@

    Parameters

    Returns boolean

    True if serializable; false otherwise

    Note: the values undefined and null are serializable (on their own or in an array), but - undefined and null properties of objects are dropped when serializing/deserializing. That - means undefined and null properties on a value passed in will cause it to fail.

    + null values get transformed into undefined when serializing/deserializing.

    WARNING: This is inefficient right now as it stringifies, parses, stringifies, and === the value. Please only use this if you need to

    DISCLAIMER: this does not successfully detect that values are not serializable in some cases:

    @@ -14,4 +13,4 @@

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

    -

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/papi-dts/functions/_shared_utils_papi_util_.serialize.html b/papi-dts/functions/_shared_utils_papi_util_.serialize.html index 6c0425cc57..2bce0611e4 100644 --- a/papi-dts/functions/_shared_utils_papi_util_.serialize.html +++ b/papi-dts/functions/_shared_utils_papi_util_.serialize.html @@ -1,17 +1,13 @@ -serialize | papi-dts

    Function serialize

    Returns string

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/papi-dts/functions/_shared_utils_papi_util_.serializeRequestType.html b/papi-dts/functions/_shared_utils_papi_util_.serializeRequestType.html index 6c11f08a9f..7b315ba157 100644 --- a/papi-dts/functions/_shared_utils_papi_util_.serializeRequestType.html +++ b/papi-dts/functions/_shared_utils_papi_util_.serializeRequestType.html @@ -2,4 +2,4 @@

    Parameters

    Returns SerializedRequestType

    Full requestType for use in network calls

    -

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

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

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

    • Returns T

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

    -

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/papi-dts/functions/_shared_utils_util_.getAllObjectFunctionNames.html b/papi-dts/functions/_shared_utils_util_.getAllObjectFunctionNames.html index 7bc21344a4..75d3b3007f 100644 --- a/papi-dts/functions/_shared_utils_util_.getAllObjectFunctionNames.html +++ b/papi-dts/functions/_shared_utils_util_.getAllObjectFunctionNames.html @@ -5,4 +5,4 @@

    Parameters

    Returns Set<string>

    Array of all function names on an object

    -

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

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

    Example

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

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

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

    Type Parameters

    Parameters

    Returns Map<K, T[]>

    Map of keys to groups of values corresponding to each item

    -
  • groupBy<T, K, V>(items, keySelector, valueSelector): Map<K, V[]>

  • Type Parameters

    Parameters

    Returns Map<K, V[]>

    • Settings

    Member Visibility

    Theme

    Generated using TypeDoc

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

  • Type Parameters

    Parameters

    Returns Map<K, V[]>

    • Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/papi-dts/functions/_shared_utils_util_.isString.html b/papi-dts/functions/_shared_utils_util_.isString.html index cb8db21a5c..8c00d8f1f6 100644 --- a/papi-dts/functions/_shared_utils_util_.isString.html +++ b/papi-dts/functions/_shared_utils_util_.isString.html @@ -1,4 +1,4 @@ isString | papi-dts

    Function isString

    • isString(o): o is string

    • Determine whether the object is a string

      Parameters

      • o: unknown

        Object to determine if it is a string

      Returns o is string

      True if the object is a string; false otherwise

      -

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/papi-dts/functions/_shared_utils_util_.newGuid.html b/papi-dts/functions/_shared_utils_util_.newGuid.html index fc0ad7d5be..702b442631 100644 --- a/papi-dts/functions/_shared_utils_util_.newGuid.html +++ b/papi-dts/functions/_shared_utils_util_.newGuid.html @@ -1 +1 @@ -newGuid | papi-dts

    Function newGuid

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

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

    Function newGuid

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/papi-dts/functions/_shared_utils_util_.newNonce.html b/papi-dts/functions/_shared_utils_util_.newNonce.html index 61ae71a9a0..fda820497e 100644 --- a/papi-dts/functions/_shared_utils_util_.newNonce.html +++ b/papi-dts/functions/_shared_utils_util_.newNonce.html @@ -3,4 +3,4 @@

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

    -

    Returns string

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Returns string

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/papi-dts/functions/_shared_utils_util_.wait.html b/papi-dts/functions/_shared_utils_util_.wait.html index beec7b659f..4f9e677a68 100644 --- a/papi-dts/functions/_shared_utils_util_.wait.html +++ b/papi-dts/functions/_shared_utils_util_.wait.html @@ -1,2 +1,2 @@ wait | papi-dts

    Function wait

    • wait(ms): Promise<void>

    • Asynchronously waits for the specified number of milliseconds. (wraps setTimeout in a promise)

      -

      Parameters

      • ms: number

      Returns Promise<void>

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Parameters

    Returns Promise<void>

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

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

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

    • Returns Promise<Awaited<TResult> | undefined>

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

    -

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

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

    Function getWebViewDefinitionUpdatableProperties

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Returns undefined | WebViewDefinitionUpdatableProperties

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

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

    Function getWebViewDefinitionUpdatablePropertiesById

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

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

    Function getWebViewDefinitionUpdatablePropertiesById

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

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

    Function getWebViewState

    • getWebViewState<T>(stateKey): undefined | T

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

      -

      Type Parameters

      • T

      Parameters

      • stateKey: string

      Returns undefined | T

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Type Parameters

    Parameters

    Returns undefined | T

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/papi-dts/functions/setWebViewState.html b/papi-dts/functions/setWebViewState.html index 9ff100bdf9..31e596adf3 100644 --- a/papi-dts/functions/setWebViewState.html +++ b/papi-dts/functions/setWebViewState.html @@ -1,2 +1,2 @@ setWebViewState | papi-dts

    Function setWebViewState

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

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

      -

      Type Parameters

      • T

      Parameters

      • stateKey: string
      • stateValue: NonNullable<T>

      Returns void

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Type Parameters

    Parameters

    Returns void

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/papi-dts/functions/updateWebViewDefinition.html b/papi-dts/functions/updateWebViewDefinition.html index 04a228821a..09753e2a16 100644 --- a/papi-dts/functions/updateWebViewDefinition.html +++ b/papi-dts/functions/updateWebViewDefinition.html @@ -5,4 +5,4 @@

    ï¼ example

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

    Parameters

    Returns boolean

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Parameters

    Returns boolean

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

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

    Function updateWebViewDefinitionById

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

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

    Function updateWebViewDefinitionById

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/papi-dts/functions/useWebViewState.html b/papi-dts/functions/useWebViewState.html index a7e839b0f5..30207aa7c5 100644 --- a/papi-dts/functions/useWebViewState.html +++ b/papi-dts/functions/useWebViewState.html @@ -15,4 +15,4 @@

    ï¼ example

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

    Type Parameters

    Parameters

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

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Type Parameters

    Parameters

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

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

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

    Interface IExtension

    Interface for all extensions to implement

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

    Properties

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

    Properties

    activate deactivate?

    Properties

    activate

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

    Type declaration

      • (context): Promise<void>

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

        Parameters

        Returns Promise<void>

    Optional deactivate

    deactivate?: UnsubscriberAsync

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

    Returns Promise<void>

    Optional deactivate

    deactivate?: UnsubscriberAsync

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

    Returns

    Promise that resolves to true if successfully deactivated

    -

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file diff --git a/papi-dts/interfaces/_extension_host_services_extension_storage_service_.ExtensionStorageService.html b/papi-dts/interfaces/_extension_host_services_extension_storage_service_.ExtensionStorageService.html index e2d31e181d..e6f3429102 100644 --- a/papi-dts/interfaces/_extension_host_services_extension_storage_service_.ExtensionStorageService.html +++ b/papi-dts/interfaces/_extension_host_services_extension_storage_service_.ExtensionStorageService.html @@ -1,4 +1,4 @@ -ExtensionStorageService | papi-dts

    Interface ExtensionStorageService

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

    Properties

    deleteUserData +ExtensionStorageService | papi-dts

    Interface ExtensionStorageService

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

    Properties

    deleteUserData readBinaryFileFromInstallDirectory readTextFileFromInstallDirectory readUserData @@ -8,23 +8,23 @@

    Parameters

    • token: ExecutionToken

      ExecutionToken provided to the extension when activate() was called

    • key: string

      Unique identifier of the data

    Returns Promise<void>

    Promise that will resolve if the data is deleted successfully

    -

    readBinaryFileFromInstallDirectory

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

    Type declaration

      • (token, fileName): Promise<Buffer>

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

        +

    readBinaryFileFromInstallDirectory

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

    Type declaration

      • (token, fileName): Promise<Buffer>

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

        Parameters

        • token: ExecutionToken

          ExecutionToken provided to the extension when activate() was called

        • fileName: string

          Name of the file to be read

        Returns Promise<Buffer>

        Promise for a Buffer with the contents of the file

        -

    readTextFileFromInstallDirectory

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

    Type declaration

      • (token, fileName): Promise<string>

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

        +

    readTextFileFromInstallDirectory

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

    Type declaration

      • (token, fileName): Promise<string>

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

        Parameters

        • token: ExecutionToken

          ExecutionToken provided to the extension when activate() was called

        • fileName: string

          Name of the file to be read

        Returns Promise<string>

        Promise for a string with the contents of the file

        -

    readUserData

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

    Type declaration

      • (token, key): Promise<string>

      • Read data specific to the user (as identified by the OS) and extension (as identified by the +

    readUserData

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

    Type declaration

      • (token, key): Promise<string>

      • Read data specific to the user (as identified by the OS) and extension (as identified by the ExecutionToken)

        Parameters

        • token: ExecutionToken

          ExecutionToken provided to the extension when activate() was called

        • key: string

          Unique identifier of the data

        Returns Promise<string>

        Promise for a string containing the data

        -

    writeUserData

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

    Type declaration

      • (token, key, data): Promise<void>

      • Write data specific to the user (as identified by the OS) and extension (as identified by the +

    writeUserData

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

    Type declaration

      • (token, key, data): Promise<void>

      • Write data specific to the user (as identified by the OS) and extension (as identified by the ExecutionToken)

        Parameters

        • token: ExecutionToken

          ExecutionToken provided to the extension when activate() was called

        • key: string

          Unique identifier of the data

        • data: string

          Data to be written

        Returns Promise<void>

        Promise that will resolve if the data is written successfully

        -

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

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

    Example

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

    Properties

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

    Properties

    platform.quit platform.restartExtensionHost test.addMany test.echo @@ -14,4 +14,4 @@ test.echoRenderer test.throwError test.throwErrorExtensionHost -

    Properties

    platform.quit

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

    Type declaration

      • (): Promise<void>

      • Returns Promise<void>

    platform.restartExtensionHost

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

    Type declaration

      • (): Promise<void>

      • Returns Promise<void>

    test.addMany

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

    Type declaration

      • (...nums): number

      • Parameters

        • Rest ...nums: number[]

        Returns number

    test.echo

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

    Type declaration

      • (message): string

      • Parameters

        • message: string

        Returns string

    test.echoExtensionHost

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

    Type declaration

      • (message): Promise<string>

      • Parameters

        • message: string

        Returns Promise<string>

    test.echoRenderer

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

    Type declaration

      • (message): Promise<string>

      • Parameters

        • message: string

        Returns Promise<string>

    test.throwError

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

    Type declaration

      • (message): void

      • Parameters

        • message: string

        Returns void

    test.throwErrorExtensionHost

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

    Type declaration

      • (message): void

      • Parameters

        • message: string

        Returns void

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file +

    Properties

    platform.quit

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

    Type declaration

      • (): Promise<void>

      • Returns Promise<void>

    platform.restartExtensionHost

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

    Type declaration

      • (): Promise<void>

      • Returns Promise<void>

    test.addMany

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

    Type declaration

      • (...nums): number

      • Parameters

        • Rest ...nums: number[]

        Returns number

    test.echo

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

    Type declaration

      • (message): string

      • Parameters

        • message: string

        Returns string

    test.echoExtensionHost

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

    Type declaration

      • (message): Promise<string>

      • Parameters

        • message: string

        Returns Promise<string>

    test.echoRenderer

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

    Type declaration

      • (message): Promise<string>

      • Parameters

        • message: string

        Returns Promise<string>

    test.throwError

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

    Type declaration

      • (message): void

      • Parameters

        • message: string

        Returns void

    test.throwErrorExtensionHost

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

    Type declaration

      • (message): void

      • Parameters

        • message: string

        Returns void

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

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

    Example

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

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

      export type PeopleDataProvider = IDataProvider<PeopleDataTypes> & PeopleDataMethods;

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

    Properties

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

    Properties

    platform.placeholder platform.stuff -

    Properties

    platform.placeholder

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

    platform.stuff

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

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file +

    Properties

    platform.placeholder

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

    platform.stuff

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

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file diff --git a/papi-dts/interfaces/_papi_shared_types_.ProjectDataProviders.html b/papi-dts/interfaces/_papi_shared_types_.ProjectDataProviders.html index 4253b6b1af..d6f2d83252 100644 --- a/papi-dts/interfaces/_papi_shared_types_.ProjectDataProviders.html +++ b/papi-dts/interfaces/_papi_shared_types_.ProjectDataProviders.html @@ -10,6 +10,6 @@ MyExtensionProjectTypeName data provider types):

    Example

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

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

    Properties

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

    Properties

    platform.notesOnly platform.placeholder -

    Properties

    platform.notesOnly

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

    platform.placeholder

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

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file +

    Properties

    platform.notesOnly

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

    platform.placeholder

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

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

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

    Interface SettingTypes

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

    Properties

    placeholder +SettingTypes | papi-dts

    Interface SettingTypes

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

    Properties

    placeholder platform.verseRef -

    Properties

    placeholder

    placeholder: undefined

    platform.verseRef

    platform.verseRef: ScriptureReference

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file +

    Properties

    placeholder

    placeholder: undefined

    platform.verseRef

    platform.verseRef: ScriptureReference

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

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

    Interface DialogTypes

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

    Keys should be dialog names, and values should be DialogDataTypes

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

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

    Properties

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

    Properties

    platform.selectMultipleProjects platform.selectProject -

    Properties

    platform.selectMultipleProjects

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

    platform.selectProject

    platform.selectProject: DialogDataTypes<SelectProjectDialogOptions, string>

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file +

    Properties

    platform.selectMultipleProjects

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

    platform.selectProject

    platform.selectProject: DialogDataTypes<SelectProjectDialogOptions, string>

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file diff --git a/papi-dts/interfaces/_shared_models_disposal_model_.CannotHaveOnDidDispose.html b/papi-dts/interfaces/_shared_models_disposal_model_.CannotHaveOnDidDispose.html index 868bff730e..05a950a62a 100644 --- a/papi-dts/interfaces/_shared_models_disposal_model_.CannotHaveOnDidDispose.html +++ b/papi-dts/interfaces/_shared_models_disposal_model_.CannotHaveOnDidDispose.html @@ -1,7 +1,7 @@ CannotHaveOnDidDispose | papi-dts

    Interface CannotHaveOnDidDispose

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

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

    Properties

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

    Properties

    dispose? onDidDispose?

    Properties

    Optional dispose

    dispose?: UnsubscriberAsync

    Release resources and notify dependent services when tearing down an object

    -

    Optional onDidDispose

    onDidDispose?: undefined

    Event that emits when dispose is called on an object

    -

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file +

    Optional onDidDispose

    onDidDispose?: undefined

    Event that emits when dispose is called on an object

    +

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

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

    Interface Dispose

    Require a dispose function

    -
    interface Dispose {
        dispose: UnsubscriberAsync;
    }

    Implemented by

    Properties

    dispose +
    interface Dispose {
        dispose: UnsubscriberAsync;
    }

    Implemented by

    Properties

    dispose

    Properties

    dispose

    dispose: UnsubscriberAsync

    Release resources and notify dependent services when tearing down an object

    -

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

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

    Interface OnDidDispose

    Require an onDidDispose event

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

    Properties

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

    Properties

    onDidDispose

    Properties

    onDidDispose

    onDidDispose: PapiEvent<void>

    Event that emits when dispose is called on an object

    -

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

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

    Interface FloatLayout

    Information about a floating window

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

    Properties

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

    Properties

    floatSize? position? type -

    Properties

    Optional floatSize

    floatSize?: FloatSize

    Optional position

    position?: FloatPosition

    Where to display the floating window. Defaults to cascade

    -

    type

    type: "float"

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file +

    Properties

    Optional floatSize

    floatSize?: FloatSize

    Optional position

    position?: FloatPosition

    Where to display the floating window. Defaults to cascade

    +

    type

    type: "float"

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

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

    Interface PanelLayout

    Information about a panel

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

    Properties

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

    Properties

    direction? targetTabId? type -

    Properties

    Optional direction

    direction?: PanelDirection

    Optional targetTabId

    targetTabId?: string

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

    -

    type

    type: "panel"

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file +

    Properties

    Optional direction

    direction?: PanelDirection

    Optional targetTabId

    targetTabId?: string

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

    +

    type

    type: "panel"

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

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

    Interface TabLayout

    Information about a tab in a panel

    -
    interface TabLayout {
        type: "tab";
    }

    Properties

    type -

    Properties

    type

    type: "tab"

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

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

    Properties

    type +

    Properties

    type

    type: "tab"

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

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

    Interface ProjectDataProviderEngineFactory<ProjectType>

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

    Type Parameters

    Methods

    createProjectDataProviderEngine -

    Methods

    createProjectDataProviderEngine

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

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

    Interface ProjectDataProviderEngineFactory<ProjectType>

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

    Type Parameters

    Methods

    createProjectDataProviderEngine +

    Methods

    createProjectDataProviderEngine

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file diff --git a/papi-dts/interfaces/_shared_models_web_view_provider_model_.DisposableWebViewProvider.html b/papi-dts/interfaces/_shared_models_web_view_provider_model_.DisposableWebViewProvider.html index 09e68970c7..3108e78f58 100644 --- a/papi-dts/interfaces/_shared_models_web_view_provider_model_.DisposableWebViewProvider.html +++ b/papi-dts/interfaces/_shared_models_web_view_provider_model_.DisposableWebViewProvider.html @@ -1,10 +1,10 @@ DisposableWebViewProvider | papi-dts

    Interface DisposableWebViewProvider

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

    See

    networkObjectService

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

    Hierarchy

    Properties

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

    Hierarchy

    Properties

    dispose onDidDispose

    Methods

    getWebView

    Properties

    dispose

    dispose: UnsubscriberAsync

    Release resources and notify dependent services when tearing down an object

    -

    onDidDispose

    onDidDispose: PapiEvent<void>

    Event that emits when dispose is called on an object

    -

    Methods

    getWebView

    onDidDispose

    onDidDispose: PapiEvent<void>

    Event that emits when dispose is called on an object

    +

    Methods

    getWebView

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

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

    • Returns Promise<undefined | WebViewDefinition>

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

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

    Interface IWebViewProvider

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

    See

    networkObjectService

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

    Hierarchy

    Properties

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

    Hierarchy

    Properties

    dispose? onDidDispose?

    Methods

    getWebView

    Properties

    Optional dispose

    dispose?: UnsubscriberAsync

    Release resources and notify dependent services when tearing down an object

    -

    Optional onDidDispose

    onDidDispose?: undefined

    Event that emits when dispose is called on an object

    -

    Methods

    getWebView

    Optional onDidDispose

    onDidDispose?: undefined

    Event that emits when dispose is called on an object

    +

    Methods

    getWebView

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

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

    • Returns Promise<undefined | WebViewDefinition>

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

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

    See

    networkObjectService

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

    Hierarchy

    Properties

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

    Hierarchy

    Properties

    dispose? onDidDispose

    Methods

    getWebView

    Properties

    Optional dispose

    dispose?: UnsubscriberAsync

    Release resources and notify dependent services when tearing down an object

    -

    onDidDispose

    onDidDispose: PapiEvent<void>

    Event that emits when dispose is called on an object

    -

    Methods

    getWebView

    onDidDispose

    onDidDispose: PapiEvent<void>

    Event that emits when dispose is called on an object

    +

    Methods

    getWebView

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

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

    • Returns Promise<undefined | WebViewDefinition>

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

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

    Interface DataProviderService

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

    Properties

    DataProviderEngine +DataProviderService | papi-dts

    Interface DataProviderService

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

    Properties

    DataProviderEngine decorators get hasKnown registerEngine -

    Properties

    DataProviderEngine

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

    decorators

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

    Type declaration

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

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

    Properties

    DataProviderEngine

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

    decorators

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

    Type declaration

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

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

          Parameters

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

            The method to ignore

          Returns void

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

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

          The name of the method to ignore

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

          -

    Returns void

    get

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

    Type declaration

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

      • Get a data provider that has previously been set up

        +

    Returns void

    get

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

    Type declaration

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

      • Get a data provider that has previously been set up

        Type Parameters

        Parameters

        • providerName: DataProviderName

          Name of the desired data provider

        Returns Promise<DataProviders[DataProviderName] | undefined>

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

        -

    hasKnown

    hasKnown: ((providerName) => boolean)

    Type declaration

      • (providerName): boolean

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

    hasKnown

    hasKnown: ((providerName) => boolean)

    Type declaration

      • (providerName): boolean

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

        -

        Parameters

        • providerName: string

        Returns boolean

    registerEngine

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

    Type declaration

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

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

        Parameters

        • providerName: string

        Returns boolean

    registerEngine

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

    Type declaration

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

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

    Interface DialogService

    Prompt the user for responses with dialogs

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

    Methods

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

    Methods

    selectProject showDialog

    Methods

    selectProject

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

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

      Parameters

      • Optional options: DialogOptions

        Various options for configuring the dialog that shows

      Returns Promise<undefined | string>

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

      -

    showDialog

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

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

      +

    showDialog

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

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

      Type Parameters

      Parameters

      • dialogType: DialogTabType

        The type of dialog to show the user

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

        Various options for configuring the dialog that shows

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

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

      -

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file diff --git a/papi-dts/interfaces/_shared_services_internet_service_.InternetService.html b/papi-dts/interfaces/_shared_services_internet_service_.InternetService.html index 2a77782f42..89e06936d7 100644 --- a/papi-dts/interfaces/_shared_services_internet_service_.InternetService.html +++ b/papi-dts/interfaces/_shared_services_internet_service_.InternetService.html @@ -1,3 +1,3 @@ -InternetService | papi-dts

    Interface InternetService

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

    Properties

    fetch +InternetService | papi-dts

    Interface InternetService

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

    Properties

    fetch

    Properties

    fetch

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

    Type declaration

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

      • MDN Reference

        -

        Parameters

        • input: RequestInfo | URL
        • Optional init: RequestInit

        Returns Promise<Response>

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file +

    Parameters

    • input: RequestInfo | URL
    • Optional init: RequestInit

    Returns Promise<Response>

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

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

    Interface default

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

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

    Implemented by

    Properties

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

    Implemented by

    Properties

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

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

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

    Promise that resolves with connector info when finished connecting

    -

    connectionStatus

    connectionStatus: ConnectionStatus

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

    connectionStatus

    connectionStatus: ConnectionStatus

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

    -

    connectorInfo

    connectorInfo: Readonly<{
        clientId: number;
    }>

    Information about the connector. Populated by the server while connecting

    -

    Type declaration

    • clientId: number

    disconnect

    disconnect: (() => void)

    Type declaration

    connectorInfo

    connectorInfo: Readonly<{
        clientId: number;
    }>

    Information about the connector. Populated by the server while connecting

    +

    Type declaration

    • clientId: number

    disconnect

    disconnect: (() => void)

    Type declaration

      • (): void

      • Disconnects from the connection:

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

        Returns void

    emitEventOnNetwork

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

    Type declaration

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

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

        Returns void

    emitEventOnNetwork

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

    Type declaration

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

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

        Type Parameters

        • T

        Parameters

        • eventType: string

          Unique network event type for coordinating between processes

        • event: InternalEvent<T>

          Event to emit on the network

          -

        Returns Promise<void>

    notifyClientConnected

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

    Type declaration

      • (): Promise<void>

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

        +

    Returns Promise<void>

    notifyClientConnected

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

    Type declaration

      • (): Promise<void>

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

        MUST RUN AFTER connect() WHEN ITS PROMISE RESOLVES

        TODO: Is this necessary?

        -

        Returns Promise<void>

    request

    request: InternalRequestHandler

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

    +

    Returns Promise<void>

    request

    request: InternalRequestHandler

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

    Param: requestType

    The type of request

    Param: contents

    Contents to send in the request

    Returns

    Promise that resolves with the response message

    -

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file diff --git a/papi-dts/interfaces/_shared_services_network_object_status_service_model_.NetworkObjectStatusRemoteServiceType.html b/papi-dts/interfaces/_shared_services_network_object_status_service_model_.NetworkObjectStatusRemoteServiceType.html index 8be9f46c85..eb9dc189ea 100644 --- a/papi-dts/interfaces/_shared_services_network_object_status_service_model_.NetworkObjectStatusRemoteServiceType.html +++ b/papi-dts/interfaces/_shared_services_network_object_status_service_model_.NetworkObjectStatusRemoteServiceType.html @@ -1,5 +1,5 @@ -NetworkObjectStatusRemoteServiceType | papi-dts

    Interface NetworkObjectStatusRemoteServiceType

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

    Hierarchy

    Properties

    getAllNetworkObjectDetails +NetworkObjectStatusRemoteServiceType | papi-dts

    Interface NetworkObjectStatusRemoteServiceType

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

    Hierarchy

    Properties

    getAllNetworkObjectDetails

    Properties

    getAllNetworkObjectDetails

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

    Type declaration

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

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

    Interface NetworkObjectStatusServiceType

    Provides functions related to the set of available network objects

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

    Hierarchy

    Properties

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

    Hierarchy

    Properties

    getAllNetworkObjectDetails waitForNetworkObject

    Properties

    getAllNetworkObjectDetails

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

    Type declaration

    waitForNetworkObject

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

    Type declaration

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

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

        +

    waitForNetworkObject

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

    Type declaration

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

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

        Parameters

        • id: string
        • Optional timeoutInMS: number

        Returns Promise<NetworkObjectDetails>

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

        -

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file diff --git a/papi-dts/interfaces/_shared_services_network_service_.PapiNetworkService.html b/papi-dts/interfaces/_shared_services_network_service_.PapiNetworkService.html index 45bece54e1..97645a5eb6 100644 --- a/papi-dts/interfaces/_shared_services_network_service_.PapiNetworkService.html +++ b/papi-dts/interfaces/_shared_services_network_service_.PapiNetworkService.html @@ -1,4 +1,4 @@ -PapiNetworkService | papi-dts

    Interface PapiNetworkService

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

    Properties

    createNetworkEventEmitter +PapiNetworkService | papi-dts

    Interface PapiNetworkService

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

    Properties

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

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

    Type Parameters

    • T

    Parameters

    • eventType: string

      Unique network event type for coordinating between connections

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

    Event emitter whose event works between connections

    -

    getNetworkEvent

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

    Type declaration

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

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

        +

    getNetworkEvent

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

    Type declaration

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

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

        Type Parameters

        • T

        Parameters

        • eventType: string

          Unique network event type for coordinating between connections

        Returns PapiEvent<T>

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

        -

    onDidClientConnect

    onDidClientConnect: PapiEvent<ClientConnectEvent>

    onDidClientDisconnect

    onDidClientDisconnect: PapiEvent<ClientDisconnectEvent>

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file +

    onDidClientConnect

    onDidClientConnect: PapiEvent<ClientConnectEvent>

    onDidClientDisconnect

    onDidClientDisconnect: PapiEvent<ClientDisconnectEvent>

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file diff --git a/papi-dts/interfaces/_shared_services_project_data_provider_service_.PapiBackendProjectDataProviderService.html b/papi-dts/interfaces/_shared_services_project_data_provider_service_.PapiBackendProjectDataProviderService.html index 85c8380830..e5e568be5e 100644 --- a/papi-dts/interfaces/_shared_services_project_data_provider_service_.PapiBackendProjectDataProviderService.html +++ b/papi-dts/interfaces/_shared_services_project_data_provider_service_.PapiBackendProjectDataProviderService.html @@ -1,4 +1,4 @@ -PapiBackendProjectDataProviderService | papi-dts

    Interface PapiBackendProjectDataProviderService

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

    Properties

    get +PapiBackendProjectDataProviderService | papi-dts

    Interface PapiBackendProjectDataProviderService

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

    Properties

    get registerProjectDataProviderEngineFactory

    Properties

    get

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

    Type declaration

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

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

        Type Parameters

        Parameters

        • projectType: ProjectType

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

        Returns Promise<ProjectDataProviders[ProjectType]>

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

        Example

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

    registerProjectDataProviderEngineFactory

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

    Type declaration

      • <ProjectType>(projectType, pdpEngineFactory): Promise<Dispose>

      • Add a new Project Data Provider Factory to PAPI that uses the given engine. There must not be an +

    registerProjectDataProviderEngineFactory

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

    Type declaration

      • <ProjectType>(projectType, pdpEngineFactory): Promise<Dispose>

      • Add a new Project Data Provider Factory to PAPI that uses the given engine. There must not be an existing factory already that handles the same project type or this operation will fail.

        Type Parameters

        Parameters

        • projectType: ProjectType

          Type of project that pdpEngineFactory supports

        • pdpEngineFactory: ProjectDataProviderEngineFactory<ProjectType>

          Used in a ProjectDataProviderFactory to create ProjectDataProviders

        Returns Promise<Dispose>

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

        -

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file diff --git a/papi-dts/interfaces/_shared_services_project_data_provider_service_.PapiFrontendProjectDataProviderService.html b/papi-dts/interfaces/_shared_services_project_data_provider_service_.PapiFrontendProjectDataProviderService.html index d52954e5d7..4a113b2179 100644 --- a/papi-dts/interfaces/_shared_services_project_data_provider_service_.PapiFrontendProjectDataProviderService.html +++ b/papi-dts/interfaces/_shared_services_project_data_provider_service_.PapiFrontendProjectDataProviderService.html @@ -1,4 +1,4 @@ -PapiFrontendProjectDataProviderService | papi-dts

    Interface PapiFrontendProjectDataProviderService

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

    Properties

    get +PapiFrontendProjectDataProviderService | papi-dts

    Interface PapiFrontendProjectDataProviderService

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

    Properties

    get

    Properties

    get

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

    Type declaration

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

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

        Type Parameters

        Parameters

        • projectType: ProjectType

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

        Returns Promise<ProjectDataProviders[ProjectType]>

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

        Example

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

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

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

    Interface ProjectLookupServiceType

    Provides metadata for projects known by the platform

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

    Properties

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

    Properties

    getMetadataForAllProjects getMetadataForProject

    Properties

    getMetadataForAllProjects

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

    Type declaration

      • (): Promise<ProjectMetadata[]>

      • Provide metadata for all projects found on the local system

        Returns Promise<ProjectMetadata[]>

        ProjectMetadata for all projects stored on the local system

        -

    getMetadataForProject

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

    Type declaration

      • (projectId): Promise<ProjectMetadata>

      • Look up metadata for a specific project ID

        +

    getMetadataForProject

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

    Type declaration

      • (projectId): Promise<ProjectMetadata>

      • Look up metadata for a specific project ID

        Parameters

        • projectId: string

          ID of the project to load

        Returns Promise<ProjectMetadata>

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

        -

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file diff --git a/papi-dts/interfaces/_shared_services_settings_service_.SettingsService.html b/papi-dts/interfaces/_shared_services_settings_service_.SettingsService.html index 28af06e15f..f95aa75696 100644 --- a/papi-dts/interfaces/_shared_services_settings_service_.SettingsService.html +++ b/papi-dts/interfaces/_shared_services_settings_service_.SettingsService.html @@ -1,17 +1,17 @@ -SettingsService | papi-dts

    Interface SettingsService

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

    Properties

    get +SettingsService | papi-dts

    Interface SettingsService

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

    Properties

    get set subscribe

    Properties

    get

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

    Type declaration

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

      • Retrieves the value of the specified setting

        Type Parameters

        Parameters

        • key: SettingName

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

        Returns undefined | SettingTypes[SettingName]

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

        -

    set

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

    Type declaration

      • <SettingName>(key, newSetting): void

      • Sets the value of the specified setting

        +

    set

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

    Type declaration

      • <SettingName>(key, newSetting): void

      • Sets the value of the specified setting

        Type Parameters

        Parameters

        • key: SettingName

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

        • newSetting: undefined | SettingTypes[SettingName]

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

          -

        Returns void

    subscribe

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

    Type declaration

      • <SettingName>(key, callback): Unsubscriber

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

    Returns void

    subscribe

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

    Type declaration

      • <SettingName>(key, callback): Unsubscriber

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

        Type Parameters

        Parameters

        • key: SettingName

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

        • callback: ((newSetting) => void)

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

            • (newSetting): void

            • Parameters

              Returns void

        Returns Unsubscriber

        Unsubscriber that should be called whenever the subscription should be deleted

        -

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file diff --git a/papi-dts/interfaces/_shared_services_web_view_provider_service_.PapiWebViewProviderService.html b/papi-dts/interfaces/_shared_services_web_view_provider_service_.PapiWebViewProviderService.html index 4aa1bfa74b..c3e0fc14fa 100644 --- a/papi-dts/interfaces/_shared_services_web_view_provider_service_.PapiWebViewProviderService.html +++ b/papi-dts/interfaces/_shared_services_web_view_provider_service_.PapiWebViewProviderService.html @@ -1,8 +1,8 @@ -PapiWebViewProviderService | papi-dts

    Interface PapiWebViewProviderService

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

    Properties

    register +PapiWebViewProviderService | papi-dts

    Interface PapiWebViewProviderService

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

    Properties

    register

    Properties

    register

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

    Type declaration

      • (webViewType, webViewProvider): Promise<DisposableWebViewProvider>

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

        Parameters

        • webViewType: string

          Type of web view to provide

        • webViewProvider: IWebViewProvider

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

          WARNING: setting a webView provider mutates the provided object.

        Returns Promise<DisposableWebViewProvider>

        webViewProvider modified to be a network object

        -

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file diff --git a/papi-dts/interfaces/_shared_services_web_view_provider_service_.WebViewProviderService.html b/papi-dts/interfaces/_shared_services_web_view_provider_service_.WebViewProviderService.html index f2a1dd6e09..bfd5bf13e7 100644 --- a/papi-dts/interfaces/_shared_services_web_view_provider_service_.WebViewProviderService.html +++ b/papi-dts/interfaces/_shared_services_web_view_provider_service_.WebViewProviderService.html @@ -1,19 +1,19 @@ -WebViewProviderService | papi-dts

    Interface WebViewProviderService

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

    Properties

    get +WebViewProviderService | papi-dts

    Interface WebViewProviderService

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

    Properties

    get hasKnown initialize register

    Properties

    get

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

    Type declaration

      • (webViewType): Promise<WebViewProvider | undefined>

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

        Parameters

        • webViewType: string

          Type of webview provider to get

        Returns Promise<WebViewProvider | undefined>

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

        -

    hasKnown

    hasKnown: ((webViewType) => boolean)

    Type declaration

      • (webViewType): boolean

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

    hasKnown

    hasKnown: ((webViewType) => boolean)

    Type declaration

      • (webViewType): boolean

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

        Parameters

        • webViewType: string

          Type of webView to check for

          -

        Returns boolean

    initialize

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

    Type declaration

      • (): Promise<void>

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

        -

        Returns Promise<void>

    register

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

    Type declaration

      • (webViewType, webViewProvider): Promise<DisposableWebViewProvider>

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

        +

    Returns boolean

    initialize

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

    Type declaration

      • (): Promise<void>

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

        +

        Returns Promise<void>

    register

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

    Type declaration

      • (webViewType, webViewProvider): Promise<DisposableWebViewProvider>

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

        Parameters

        • webViewType: string

          Type of web view to provide

        • webViewProvider: IWebViewProvider

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

          WARNING: setting a webView provider mutates the provided object.

        Returns Promise<DisposableWebViewProvider>

        webViewProvider modified to be a network object

        -

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

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

    Interface WebViewServiceType

    Service exposing various functions related to using webViews

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

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

    Properties

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

    Properties

    getWebView onDidAddWebView

    Properties

    getWebView

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

    Type declaration

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

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

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

    Returns Promise<undefined | string>

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

    Throws

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

    -

    onDidAddWebView

    onDidAddWebView: PapiEvent<AddWebViewEvent>

    Event that emits with webView info when a webView is added

    -

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file +

    onDidAddWebView

    onDidAddWebView: PapiEvent<AddWebViewEvent>

    Event that emits with webView info when a webView is added

    +

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

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

    Namespace "@papi/backend"

    Index

    Variables

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

    Namespace "@papi/backend"

    Index

    Variables

    DataProviderEngine EventEmitter commands dataProviders diff --git a/papi-dts/modules/__papi_core_.html b/papi-dts/modules/__papi_core_.html index 263376c6c7..2c065893a6 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 45c1adb4ba..b7c0c8acd0 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

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

    Namespace "@papi/frontend/react"

    References

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

    Namespace "@papi/frontend/react"

    References

    useData useDataProvider useDataProviderMulti useDialogCallback diff --git a/papi-dts/modules/_client_services_client_network_connector_service_.html b/papi-dts/modules/_client_services_client_network_connector_service_.html index 8e279bb0c5..051aa73d28 100644 --- a/papi-dts/modules/_client_services_client_network_connector_service_.html +++ b/papi-dts/modules/_client_services_client_network_connector_service_.html @@ -1,2 +1,2 @@ -"client/services/client-network-connector.service" | papi-dts

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

    Index

    Classes

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

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

    Index

    Classes

    default

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

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

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

    Index

    Functions

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

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

    Index

    Functions

    createWebSocket

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

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

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

    Index

    Type Aliases

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

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

    Index

    Type Aliases

    IWebSocket

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

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

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

    Index

    Type Aliases

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

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

    Index

    Type Aliases

    ExecutionActivationContext

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

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

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

    Index

    Interfaces

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

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

    Index

    Interfaces

    IExtension

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

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

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

    Index

    Type Aliases

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

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

    Index

    Type Aliases

    ExtensionManifest

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

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

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

    Index

    Namespaces

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

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

    Index

    Namespaces

    default

    Classes

    default

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

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

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

    Index

    Interfaces

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

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

    Index

    Interfaces

    ExtensionStorageService

    Variables

    default

    Functions

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

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

    Index

    Classes

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

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

    Index

    Classes

    default

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

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

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

    Index

    Classes

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

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

    Index

    Classes

    ExecutionToken

    Type Aliases

    ExecutionTokenType

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

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

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

    Index

    Variables

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

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

    Index

    Variables

    default

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/papi-dts/modules/_node_services_node_file_system_service_.html b/papi-dts/modules/_node_services_node_file_system_service_.html index 5ee1d6abee..2eb2cc644f 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 6f7190e111..3732b3a732 100644 --- a/papi-dts/modules/_node_utils_crypto_util_.html +++ b/papi-dts/modules/_node_utils_crypto_util_.html @@ -1,3 +1,3 @@ -"node/utils/crypto-util" | papi-dts

    Namespace "node/utils/crypto-util"

    Index

    Functions

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

    Namespace "node/utils/crypto-util"

    Index

    Functions

    createNonce createUuid

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

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

    Namespace getAppDir

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

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

    When packaged: <user_home_directory>/.platform.bible

    -

    Index

    Functions

    clear +

    Index

    Functions

    clear

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

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

    Namespace "node/utils/util"

    Index

    Namespaces

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

    Namespace "node/utils/util"

    Index

    Namespaces

    getAppDir

    Variables

    FILE_PROTOCOL RESOURCES_PROTOCOL

    Functions

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

    Namespace "papi-shared-types"

    Index

    Interfaces

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

    Namespace "papi-shared-types"

    Index

    Interfaces

    CommandHandlers DataProviders ProjectDataProviders SettingTypes diff --git a/papi-dts/modules/_renderer_components_dialogs_dialog_base_data_.html b/papi-dts/modules/_renderer_components_dialogs_dialog_base_data_.html index 98009544a8..07b1b3e1ca 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 42c0968b6f..0849f66ec2 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 f89e302aec..404493ddc5 100644 --- a/papi-dts/modules/_renderer_hooks_hook_generators_create_use_data_hook_util_.html +++ b/papi-dts/modules/_renderer_hooks_hook_generators_create_use_data_hook_util_.html @@ -1,2 +1,2 @@ -"renderer/hooks/hook-generators/create-use-data-hook.util" | papi-dts

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

    Index

    Functions

    default +"renderer/hooks/hook-generators/create-use-data-hook.util" | papi-dts

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

    Index

    Functions

    default

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/papi-dts/modules/_renderer_hooks_hook_generators_create_use_network_object_hook_util_.html b/papi-dts/modules/_renderer_hooks_hook_generators_create_use_network_object_hook_util_.html index 6d2bcc32c3..e8cd9bc99f 100644 --- a/papi-dts/modules/_renderer_hooks_hook_generators_create_use_network_object_hook_util_.html +++ b/papi-dts/modules/_renderer_hooks_hook_generators_create_use_network_object_hook_util_.html @@ -1,2 +1,2 @@ -"renderer/hooks/hook-generators/create-use-network-object-hook.util" | papi-dts

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

    Index

    Functions

    default +"renderer/hooks/hook-generators/create-use-network-object-hook.util" | papi-dts

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

    Index

    Functions

    default

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/papi-dts/modules/_renderer_hooks_papi_hooks_index_.html b/papi-dts/modules/_renderer_hooks_papi_hooks_index_.html index 312014cb8e..7351d7bab0 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 96670d897f..6ddfe2258f 100644 --- a/papi-dts/modules/_renderer_hooks_papi_hooks_use_data_hook_.html +++ b/papi-dts/modules/_renderer_hooks_papi_hooks_use_data_hook_.html @@ -1,2 +1,2 @@ -"renderer/hooks/papi-hooks/use-data.hook" | papi-dts

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

    Index

    Functions

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

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

    Index

    Functions

    default

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/papi-dts/modules/_renderer_hooks_papi_hooks_use_data_provider_hook_.html b/papi-dts/modules/_renderer_hooks_papi_hooks_use_data_provider_hook_.html index 3b79c4ae60..3679f2f686 100644 --- a/papi-dts/modules/_renderer_hooks_papi_hooks_use_data_provider_hook_.html +++ b/papi-dts/modules/_renderer_hooks_papi_hooks_use_data_provider_hook_.html @@ -1,2 +1,2 @@ -"renderer/hooks/papi-hooks/use-data-provider.hook" | papi-dts

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

    Index

    Functions

    default +"renderer/hooks/papi-hooks/use-data-provider.hook" | papi-dts

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

    Index

    Functions

    default

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/papi-dts/modules/_renderer_hooks_papi_hooks_use_data_provider_multi_hook_.html b/papi-dts/modules/_renderer_hooks_papi_hooks_use_data_provider_multi_hook_.html index 03196fe0ee..888db1e7aa 100644 --- a/papi-dts/modules/_renderer_hooks_papi_hooks_use_data_provider_multi_hook_.html +++ b/papi-dts/modules/_renderer_hooks_papi_hooks_use_data_provider_multi_hook_.html @@ -1,2 +1,2 @@ -"renderer/hooks/papi-hooks/use-data-provider-multi.hook" | papi-dts

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

    Index

    Functions

    default +"renderer/hooks/papi-hooks/use-data-provider-multi.hook" | papi-dts

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

    Index

    Functions

    default

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/papi-dts/modules/_renderer_hooks_papi_hooks_use_dialog_callback_hook_.html b/papi-dts/modules/_renderer_hooks_papi_hooks_use_dialog_callback_hook_.html index 56bb3714d1..9f153f665b 100644 --- a/papi-dts/modules/_renderer_hooks_papi_hooks_use_dialog_callback_hook_.html +++ b/papi-dts/modules/_renderer_hooks_papi_hooks_use_dialog_callback_hook_.html @@ -1,3 +1,3 @@ -"renderer/hooks/papi-hooks/use-dialog-callback.hook" | papi-dts

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

    Index

    Type Aliases

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

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

    Index

    Type Aliases

    UseDialogCallbackOptions

    Functions

    default

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/papi-dts/modules/_renderer_hooks_papi_hooks_use_event_async_hook_.html b/papi-dts/modules/_renderer_hooks_papi_hooks_use_event_async_hook_.html index d11e40d432..112592784c 100644 --- a/papi-dts/modules/_renderer_hooks_papi_hooks_use_event_async_hook_.html +++ b/papi-dts/modules/_renderer_hooks_papi_hooks_use_event_async_hook_.html @@ -1,2 +1,2 @@ -"renderer/hooks/papi-hooks/use-event-async.hook" | papi-dts

    Namespace "renderer/hooks/papi-hooks/use-event-async.hook"

    Index

    Functions

    default +"renderer/hooks/papi-hooks/use-event-async.hook" | papi-dts

    Namespace "renderer/hooks/papi-hooks/use-event-async.hook"

    Index

    Functions

    default

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/papi-dts/modules/_renderer_hooks_papi_hooks_use_event_hook_.html b/papi-dts/modules/_renderer_hooks_papi_hooks_use_event_hook_.html index 423397ca6e..b42ab10f80 100644 --- a/papi-dts/modules/_renderer_hooks_papi_hooks_use_event_hook_.html +++ b/papi-dts/modules/_renderer_hooks_papi_hooks_use_event_hook_.html @@ -1,2 +1,2 @@ -"renderer/hooks/papi-hooks/use-event.hook" | papi-dts

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

    Index

    Functions

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

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

    Index

    Functions

    default

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

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

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

    Index

    Functions

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

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

    Index

    Functions

    default

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/papi-dts/modules/_renderer_hooks_papi_hooks_use_project_data_provider_hook_.html b/papi-dts/modules/_renderer_hooks_papi_hooks_use_project_data_provider_hook_.html index ec94ca88f7..da57e5e286 100644 --- a/papi-dts/modules/_renderer_hooks_papi_hooks_use_project_data_provider_hook_.html +++ b/papi-dts/modules/_renderer_hooks_papi_hooks_use_project_data_provider_hook_.html @@ -1,2 +1,2 @@ -"renderer/hooks/papi-hooks/use-project-data-provider.hook" | papi-dts

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

    Index

    Functions

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

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

    Index

    Functions

    default

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/papi-dts/modules/_renderer_hooks_papi_hooks_use_promise_hook_.html b/papi-dts/modules/_renderer_hooks_papi_hooks_use_promise_hook_.html index 9a7908edaf..2b777224e3 100644 --- a/papi-dts/modules/_renderer_hooks_papi_hooks_use_promise_hook_.html +++ b/papi-dts/modules/_renderer_hooks_papi_hooks_use_promise_hook_.html @@ -1,3 +1,3 @@ -"renderer/hooks/papi-hooks/use-promise.hook" | papi-dts

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

    Index

    Type Aliases

    UsePromiseOptions +"renderer/hooks/papi-hooks/use-promise.hook" | papi-dts

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

    Index

    Type Aliases

    UsePromiseOptions

    Functions

    default

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

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

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

    Index

    Functions

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

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

    Index

    Functions

    default

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/papi-dts/modules/_renderer_services_renderer_web_socket_service_.html b/papi-dts/modules/_renderer_services_renderer_web_socket_service_.html index be1c28af1a..cbbfee20b7 100644 --- a/papi-dts/modules/_renderer_services_renderer_web_socket_service_.html +++ b/papi-dts/modules/_renderer_services_renderer_web_socket_service_.html @@ -1,3 +1,3 @@ -"renderer/services/renderer-web-socket.service" | papi-dts

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

    Index

    Classes

    default +"renderer/services/renderer-web-socket.service" | papi-dts

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

    Index

    Classes

    default

    Functions

    blockWebSocketsToPapiNetwork

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/papi-dts/modules/_renderer_services_renderer_xml_http_request_service_.html b/papi-dts/modules/_renderer_services_renderer_xml_http_request_service_.html index 4ede5d090e..c5d89812f9 100644 --- a/papi-dts/modules/_renderer_services_renderer_xml_http_request_service_.html +++ b/papi-dts/modules/_renderer_services_renderer_xml_http_request_service_.html @@ -1,2 +1,2 @@ -"renderer/services/renderer-xml-http-request.service" | papi-dts

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

    Index

    Classes

    default +"renderer/services/renderer-xml-http-request.service" | papi-dts

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

    Index

    Classes

    default

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/papi-dts/modules/_shared_data_file_system_model_.html b/papi-dts/modules/_shared_data_file_system_model_.html index 6ed858b3b5..686a7becc4 100644 --- a/papi-dts/modules/_shared_data_file_system_model_.html +++ b/papi-dts/modules/_shared_data_file_system_model_.html @@ -1,2 +1,2 @@ -"shared/data/file-system.model" | papi-dts

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

    Index

    Type Aliases

    Uri +"shared/data/file-system.model" | papi-dts

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

    Index

    Type Aliases

    Uri

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/papi-dts/modules/_shared_data_internal_connection_model_.html b/papi-dts/modules/_shared_data_internal_connection_model_.html index 2f0ab0bbc1..49cb949345 100644 --- a/papi-dts/modules/_shared_data_internal_connection_model_.html +++ b/papi-dts/modules/_shared_data_internal_connection_model_.html @@ -1,4 +1,4 @@ -"shared/data/internal-connection.model" | papi-dts

    Namespace "shared/data/internal-connection.model"

    Index

    Enumerations

    ConnectionStatus +"shared/data/internal-connection.model" | papi-dts

    Namespace "shared/data/internal-connection.model"

    Index

    Enumerations

    ConnectionStatus

    Type Aliases

    ClientConnectEvent ClientDisconnectEvent InternalEvent diff --git a/papi-dts/modules/_shared_data_network_connector_model_.html b/papi-dts/modules/_shared_data_network_connector_model_.html index ba44a4c546..813099bfc7 100644 --- a/papi-dts/modules/_shared_data_network_connector_model_.html +++ b/papi-dts/modules/_shared_data_network_connector_model_.html @@ -1,4 +1,4 @@ -"shared/data/network-connector.model" | papi-dts

    Namespace "shared/data/network-connector.model"

    Index

    Enumerations

    MessageType +"shared/data/network-connector.model" | papi-dts

    Namespace "shared/data/network-connector.model"

    Index

    Enumerations

    MessageType

    Type Aliases

    ClientConnect InitClient Message diff --git a/papi-dts/modules/_shared_global_this_model_.html b/papi-dts/modules/_shared_global_this_model_.html index d77b5ac04f..a7b686bd3a 100644 --- a/papi-dts/modules/_shared_global_this_model_.html +++ b/papi-dts/modules/_shared_global_this_model_.html @@ -1,2 +1,2 @@ -"shared/global-this.model" | papi-dts

    Namespace "shared/global-this.model"

    Index

    Enumerations

    ProcessType +"shared/global-this.model" | papi-dts

    Namespace "shared/global-this.model"

    Index

    Enumerations

    ProcessType

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

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

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

    Index

    Type Aliases

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

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

    Index

    Type Aliases

    DataProviderEngineNotifyUpdate WithNotifyUpdate default

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/papi-dts/modules/_shared_models_data_provider_interface_.html b/papi-dts/modules/_shared_models_data_provider_interface_.html index 3126c250fb..1a87a7c596 100644 --- a/papi-dts/modules/_shared_models_data_provider_interface_.html +++ b/papi-dts/modules/_shared_models_data_provider_interface_.html @@ -1,3 +1,3 @@ -"shared/models/data-provider.interface" | papi-dts

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

    Index

    Type Aliases

    IDisposableDataProvider +"shared/models/data-provider.interface" | papi-dts

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

    Index

    Type Aliases

    IDisposableDataProvider default

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/papi-dts/modules/_shared_models_data_provider_model_.html b/papi-dts/modules/_shared_models_data_provider_model_.html index b001f1451a..a5103207e5 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 8c9b77e36e..cdd25380a1 100644 --- a/papi-dts/modules/_shared_models_dialog_options_model_.html +++ b/papi-dts/modules/_shared_models_dialog_options_model_.html @@ -1,3 +1,3 @@ -"shared/models/dialog-options.model" | papi-dts

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

    Index

    Type Aliases

    DialogData +"shared/models/dialog-options.model" | papi-dts

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

    Index

    Type Aliases

    DialogData DialogOptions

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/papi-dts/modules/_shared_models_disposal_model_.html b/papi-dts/modules/_shared_models_disposal_model_.html index 1b5dad600e..508737916a 100644 --- a/papi-dts/modules/_shared_models_disposal_model_.html +++ b/papi-dts/modules/_shared_models_disposal_model_.html @@ -1,4 +1,4 @@ -"shared/models/disposal.model" | papi-dts

    Namespace "shared/models/disposal.model"

    Index

    Interfaces

    CannotHaveOnDidDispose +"shared/models/disposal.model" | papi-dts

    Namespace "shared/models/disposal.model"

    Index

    Interfaces

    CannotHaveOnDidDispose Dispose OnDidDispose

    Type Aliases

    CanHaveOnDidDispose diff --git a/papi-dts/modules/_shared_models_docking_framework_model_.html b/papi-dts/modules/_shared_models_docking_framework_model_.html index a871078046..0eeaed9dc9 100644 --- a/papi-dts/modules/_shared_models_docking_framework_model_.html +++ b/papi-dts/modules/_shared_models_docking_framework_model_.html @@ -1,4 +1,4 @@ -"shared/models/docking-framework.model" | papi-dts

    Namespace "shared/models/docking-framework.model"

    Index

    Interfaces

    FloatLayout +"shared/models/docking-framework.model" | papi-dts

    Namespace "shared/models/docking-framework.model"

    Index

    Interfaces

    FloatLayout PanelLayout TabLayout

    Type Aliases

    AddWebViewEvent diff --git a/papi-dts/modules/_shared_models_extract_data_provider_data_types_model_.html b/papi-dts/modules/_shared_models_extract_data_provider_data_types_model_.html index 1c696a4aca..a2ee0b9862 100644 --- a/papi-dts/modules/_shared_models_extract_data_provider_data_types_model_.html +++ b/papi-dts/modules/_shared_models_extract_data_provider_data_types_model_.html @@ -1,2 +1,2 @@ -"shared/models/extract-data-provider-data-types.model" | papi-dts

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

    Index

    Type Aliases

    default +"shared/models/extract-data-provider-data-types.model" | papi-dts

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

    Index

    Type Aliases

    default

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/papi-dts/modules/_shared_models_network_object_model_.html b/papi-dts/modules/_shared_models_network_object_model_.html index ee272ce6cc..265cb9f8e3 100644 --- a/papi-dts/modules/_shared_models_network_object_model_.html +++ b/papi-dts/modules/_shared_models_network_object_model_.html @@ -1,4 +1,4 @@ -"shared/models/network-object.model" | papi-dts

    Namespace "shared/models/network-object.model"

    Index

    Type Aliases

    DisposableNetworkObject +"shared/models/network-object.model" | papi-dts

    Namespace "shared/models/network-object.model"

    Index

    Type Aliases

    DisposableNetworkObject LocalObjectToProxyCreator NetworkObject NetworkObjectDetails diff --git a/papi-dts/modules/_shared_models_papi_event_emitter_model_.html b/papi-dts/modules/_shared_models_papi_event_emitter_model_.html index 4086595309..00eab624a0 100644 --- a/papi-dts/modules/_shared_models_papi_event_emitter_model_.html +++ b/papi-dts/modules/_shared_models_papi_event_emitter_model_.html @@ -1,2 +1,2 @@ -"shared/models/papi-event-emitter.model" | papi-dts

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

    Index

    Classes

    default +"shared/models/papi-event-emitter.model" | papi-dts

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

    Index

    Classes

    default

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/papi-dts/modules/_shared_models_papi_event_model_.html b/papi-dts/modules/_shared_models_papi_event_model_.html index 92a21feb4f..e8a5ffd70b 100644 --- a/papi-dts/modules/_shared_models_papi_event_model_.html +++ b/papi-dts/modules/_shared_models_papi_event_model_.html @@ -1,4 +1,4 @@ -"shared/models/papi-event.model" | papi-dts

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

    Index

    Type Aliases

    PapiEvent +"shared/models/papi-event.model" | papi-dts

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

    Index

    Type Aliases

    PapiEvent PapiEventAsync PapiEventHandler

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/papi-dts/modules/_shared_models_papi_network_event_emitter_model_.html b/papi-dts/modules/_shared_models_papi_network_event_emitter_model_.html index f77ecc8f77..18648e3b98 100644 --- a/papi-dts/modules/_shared_models_papi_network_event_emitter_model_.html +++ b/papi-dts/modules/_shared_models_papi_network_event_emitter_model_.html @@ -1,2 +1,2 @@ -"shared/models/papi-network-event-emitter.model" | papi-dts

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

    Index

    Classes

    default +"shared/models/papi-network-event-emitter.model" | papi-dts

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

    Index

    Classes

    default

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/papi-dts/modules/_shared_models_project_data_provider_engine_model_.html b/papi-dts/modules/_shared_models_project_data_provider_engine_model_.html index 45ddb50d97..ffd7e83507 100644 --- a/papi-dts/modules/_shared_models_project_data_provider_engine_model_.html +++ b/papi-dts/modules/_shared_models_project_data_provider_engine_model_.html @@ -1,3 +1,3 @@ -"shared/models/project-data-provider-engine.model" | papi-dts

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

    Index

    Interfaces

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

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

    Index

    Interfaces

    ProjectDataProviderEngineFactory

    Type Aliases

    ProjectDataProviderEngineTypes

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

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

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

    Index

    Type Aliases

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

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

    Index

    Type Aliases

    ExtensionDataScope MandatoryProjectDataType

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/papi-dts/modules/_shared_models_project_metadata_model_.html b/papi-dts/modules/_shared_models_project_metadata_model_.html index d30d9b06fb..619608d954 100644 --- a/papi-dts/modules/_shared_models_project_metadata_model_.html +++ b/papi-dts/modules/_shared_models_project_metadata_model_.html @@ -1,2 +1,2 @@ -"shared/models/project-metadata.model" | papi-dts

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

    Index

    Type Aliases

    ProjectMetadata +"shared/models/project-metadata.model" | papi-dts

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

    Index

    Type Aliases

    ProjectMetadata

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/papi-dts/modules/_shared_models_web_view_model_.html b/papi-dts/modules/_shared_models_web_view_model_.html index 7e4f5f7b5a..03ba224954 100644 --- a/papi-dts/modules/_shared_models_web_view_model_.html +++ b/papi-dts/modules/_shared_models_web_view_model_.html @@ -1,4 +1,4 @@ -"shared/models/web-view.model" | papi-dts

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

    Index

    Enumerations

    WebViewContentType +"shared/models/web-view.model" | papi-dts

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

    Index

    Enumerations

    WebViewContentType

    Type Aliases

    GetWebViewDefinitionUpdatableProperties GetWebViewOptions SavedWebViewDefinition diff --git a/papi-dts/modules/_shared_models_web_view_provider_model_.html b/papi-dts/modules/_shared_models_web_view_provider_model_.html index f2302eed0a..9066b03fdc 100644 --- a/papi-dts/modules/_shared_models_web_view_provider_model_.html +++ b/papi-dts/modules/_shared_models_web_view_provider_model_.html @@ -1,4 +1,4 @@ -"shared/models/web-view-provider.model" | papi-dts

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

    Index

    Interfaces

    DisposableWebViewProvider +"shared/models/web-view-provider.model" | papi-dts

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

    Index

    Interfaces

    DisposableWebViewProvider IWebViewProvider WebViewProvider

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/papi-dts/modules/_shared_services_command_service_.html b/papi-dts/modules/_shared_services_command_service_.html index 66c53d37eb..8957e5e5f4 100644 --- a/papi-dts/modules/_shared_services_command_service_.html +++ b/papi-dts/modules/_shared_services_command_service_.html @@ -1,4 +1,4 @@ -"shared/services/command.service" | papi-dts

    Namespace "shared/services/command.service"

    Index

    Type Aliases

    moduleSummaryComments +"shared/services/command.service" | papi-dts

    Namespace "shared/services/command.service"

    Index

    Type Aliases

    moduleSummaryComments

    Functions

    addThree createSendCommandFunction initialize diff --git a/papi-dts/modules/_shared_services_connection_service_.html b/papi-dts/modules/_shared_services_connection_service_.html index e013d25f66..3f42128b9c 100644 --- a/papi-dts/modules/_shared_services_connection_service_.html +++ b/papi-dts/modules/_shared_services_connection_service_.html @@ -1,4 +1,4 @@ -"shared/services/connection.service" | papi-dts

    Namespace "shared/services/connection.service"

    Index

    Functions

    connect +"shared/services/connection.service" | papi-dts

    Namespace "shared/services/connection.service"

    Index

    Functions

    connect disconnect emitEventOnNetwork getClientId diff --git a/papi-dts/modules/_shared_services_data_provider_service_.html b/papi-dts/modules/_shared_services_data_provider_service_.html index dac08e0651..46f0030fc1 100644 --- a/papi-dts/modules/_shared_services_data_provider_service_.html +++ b/papi-dts/modules/_shared_services_data_provider_service_.html @@ -1,4 +1,4 @@ -"shared/services/data-provider.service" | papi-dts

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

    Index

    Classes

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

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

    Index

    Classes

    DataProviderEngine

    Interfaces

    DataProviderService

    Variables

    default

    Functions

    getByType diff --git a/papi-dts/modules/_shared_services_dialog_service_.html b/papi-dts/modules/_shared_services_dialog_service_.html index 5e3f4a1998..3d44a49470 100644 --- a/papi-dts/modules/_shared_services_dialog_service_.html +++ b/papi-dts/modules/_shared_services_dialog_service_.html @@ -1,2 +1,2 @@ -"shared/services/dialog.service" | papi-dts

    Namespace "shared/services/dialog.service"

    Index

    Variables

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

    Namespace "shared/services/dialog.service"

    Index

    Variables

    default

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/papi-dts/modules/_shared_services_dialog_service_model_.html b/papi-dts/modules/_shared_services_dialog_service_model_.html index b746d6c931..9736f2a291 100644 --- a/papi-dts/modules/_shared_services_dialog_service_model_.html +++ b/papi-dts/modules/_shared_services_dialog_service_model_.html @@ -1,3 +1,3 @@ -"shared/services/dialog.service-model" | papi-dts

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

    Index

    Interfaces

    DialogService +"shared/services/dialog.service-model" | papi-dts

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

    Index

    Interfaces

    DialogService

    Variables

    CATEGORY_DIALOG

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/papi-dts/modules/_shared_services_internet_service_.html b/papi-dts/modules/_shared_services_internet_service_.html index c2583827c3..67ed9de397 100644 --- a/papi-dts/modules/_shared_services_internet_service_.html +++ b/papi-dts/modules/_shared_services_internet_service_.html @@ -1,3 +1,3 @@ -"shared/services/internet.service" | papi-dts

    Namespace "shared/services/internet.service"

    Index

    Interfaces

    InternetService +"shared/services/internet.service" | papi-dts

    Namespace "shared/services/internet.service"

    Index

    Interfaces

    InternetService

    Variables

    default

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/papi-dts/modules/_shared_services_logger_service_.html b/papi-dts/modules/_shared_services_logger_service_.html index 3adb2a96bf..4519eb9605 100644 --- a/papi-dts/modules/_shared_services_logger_service_.html +++ b/papi-dts/modules/_shared_services_logger_service_.html @@ -1,4 +1,4 @@ -"shared/services/logger.service" | papi-dts

    Namespace "shared/services/logger.service"

    Index

    Variables

    WARN_TAG +"shared/services/logger.service" | papi-dts

    Namespace "shared/services/logger.service"

    Index

    Variables

    WARN_TAG default

    Functions

    formatLog

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/papi-dts/modules/_shared_services_network_connector_factory_.html b/papi-dts/modules/_shared_services_network_connector_factory_.html index a8ccd003c4..51d9b93b54 100644 --- a/papi-dts/modules/_shared_services_network_connector_factory_.html +++ b/papi-dts/modules/_shared_services_network_connector_factory_.html @@ -1,2 +1,2 @@ -"shared/services/network-connector.factory" | papi-dts

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

    Index

    Functions

    createNetworkConnector +"shared/services/network-connector.factory" | papi-dts

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

    Index

    Functions

    createNetworkConnector

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/papi-dts/modules/_shared_services_network_connector_interface_.html b/papi-dts/modules/_shared_services_network_connector_interface_.html index 2ecda3f0c4..ff688409bd 100644 --- a/papi-dts/modules/_shared_services_network_connector_interface_.html +++ b/papi-dts/modules/_shared_services_network_connector_interface_.html @@ -1,2 +1,2 @@ -"shared/services/network-connector.interface" | papi-dts

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

    Index

    Interfaces

    default +"shared/services/network-connector.interface" | papi-dts

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

    Index

    Interfaces

    default

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/papi-dts/modules/_shared_services_network_object_service_.html b/papi-dts/modules/_shared_services_network_object_service_.html index 317d318b9c..213bc2d178 100644 --- a/papi-dts/modules/_shared_services_network_object_service_.html +++ b/papi-dts/modules/_shared_services_network_object_service_.html @@ -1,4 +1,4 @@ -"shared/services/network-object.service" | papi-dts

    Namespace "shared/services/network-object.service"

    Index

    Variables

    default +"shared/services/network-object.service" | papi-dts

    Namespace "shared/services/network-object.service"

    Index

    Variables

    default

    Functions

    onDidCreateNetworkObject onDidDisposeNetworkObject overrideDispose diff --git a/papi-dts/modules/_shared_services_network_object_status_service_.html b/papi-dts/modules/_shared_services_network_object_status_service_.html index aeed0c56a8..e1e7e133ce 100644 --- a/papi-dts/modules/_shared_services_network_object_status_service_.html +++ b/papi-dts/modules/_shared_services_network_object_status_service_.html @@ -1,2 +1,2 @@ -"shared/services/network-object-status.service" | papi-dts

    Namespace "shared/services/network-object-status.service"

    Index

    Variables

    default +"shared/services/network-object-status.service" | papi-dts

    Namespace "shared/services/network-object-status.service"

    Index

    Variables

    default

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/papi-dts/modules/_shared_services_network_object_status_service_model_.html b/papi-dts/modules/_shared_services_network_object_status_service_model_.html index af88ec1a87..26c58488ca 100644 --- a/papi-dts/modules/_shared_services_network_object_status_service_model_.html +++ b/papi-dts/modules/_shared_services_network_object_status_service_model_.html @@ -1,4 +1,4 @@ -"shared/services/network-object-status.service-model" | papi-dts

    Namespace "shared/services/network-object-status.service-model"

    Index

    Interfaces

    NetworkObjectStatusRemoteServiceType +"shared/services/network-object-status.service-model" | papi-dts

    Namespace "shared/services/network-object-status.service-model"

    Index

    Interfaces

    NetworkObjectStatusRemoteServiceType NetworkObjectStatusServiceType

    Variables

    networkObjectStatusServiceNetworkObjectName

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/papi-dts/modules/_shared_services_network_service_.html b/papi-dts/modules/_shared_services_network_service_.html index 85f817449d..0423deb169 100644 --- a/papi-dts/modules/_shared_services_network_service_.html +++ b/papi-dts/modules/_shared_services_network_service_.html @@ -1,4 +1,4 @@ -"shared/services/network.service" | papi-dts

    Namespace "shared/services/network.service"

    Index

    Interfaces

    PapiNetworkService +"shared/services/network.service" | papi-dts

    Namespace "shared/services/network.service"

    Index

    Interfaces

    PapiNetworkService

    Type Aliases

    ArgsRequestHandler ComplexRequestHandler ContentsRequestHandler diff --git a/papi-dts/modules/_shared_services_project_data_provider_service_.html b/papi-dts/modules/_shared_services_project_data_provider_service_.html index 03028ef909..b4b4ceeba1 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 55e0b4baf2..49ffabc1d0 100644 --- a/papi-dts/modules/_shared_services_project_lookup_service_.html +++ b/papi-dts/modules/_shared_services_project_lookup_service_.html @@ -1,2 +1,2 @@ -"shared/services/project-lookup.service" | papi-dts

    Namespace "shared/services/project-lookup.service"

    Index

    Variables

    default +"shared/services/project-lookup.service" | papi-dts

    Namespace "shared/services/project-lookup.service"

    Index

    Variables

    default

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/papi-dts/modules/_shared_services_project_lookup_service_model_.html b/papi-dts/modules/_shared_services_project_lookup_service_model_.html index c5694449e6..120506aac2 100644 --- a/papi-dts/modules/_shared_services_project_lookup_service_model_.html +++ b/papi-dts/modules/_shared_services_project_lookup_service_model_.html @@ -1,3 +1,3 @@ -"shared/services/project-lookup.service-model" | papi-dts

    Namespace "shared/services/project-lookup.service-model"

    Index

    Interfaces

    ProjectLookupServiceType +"shared/services/project-lookup.service-model" | papi-dts

    Namespace "shared/services/project-lookup.service-model"

    Index

    Interfaces

    ProjectLookupServiceType

    Variables

    projectLookupServiceNetworkObjectName

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/papi-dts/modules/_shared_services_settings_service_.html b/papi-dts/modules/_shared_services_settings_service_.html index e92c938e2f..3e55e2a1f5 100644 --- a/papi-dts/modules/_shared_services_settings_service_.html +++ b/papi-dts/modules/_shared_services_settings_service_.html @@ -1,3 +1,3 @@ -"shared/services/settings.service" | papi-dts

    Namespace "shared/services/settings.service"

    Index

    Interfaces

    SettingsService +"shared/services/settings.service" | papi-dts

    Namespace "shared/services/settings.service"

    Index

    Interfaces

    SettingsService

    Variables

    default

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/papi-dts/modules/_shared_services_web_view_provider_service_.html b/papi-dts/modules/_shared_services_web_view_provider_service_.html index b30d0f64e4..6ea47a1904 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 1c5fd357fb..888e20c0bb 100644 --- a/papi-dts/modules/_shared_services_web_view_service_.html +++ b/papi-dts/modules/_shared_services_web_view_service_.html @@ -1,2 +1,2 @@ -"shared/services/web-view.service" | papi-dts

    Namespace "shared/services/web-view.service"

    Index

    Variables

    default +"shared/services/web-view.service" | papi-dts

    Namespace "shared/services/web-view.service"

    Index

    Variables

    default

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/papi-dts/modules/_shared_services_web_view_service_model_.html b/papi-dts/modules/_shared_services_web_view_service_model_.html index 940aa39563..2bde6d194f 100644 --- a/papi-dts/modules/_shared_services_web_view_service_model_.html +++ b/papi-dts/modules/_shared_services_web_view_service_model_.html @@ -1,4 +1,4 @@ -"shared/services/web-view.service-model" | papi-dts

    Namespace "shared/services/web-view.service-model"

    Index

    Interfaces

    WebViewServiceType +"shared/services/web-view.service-model" | papi-dts

    Namespace "shared/services/web-view.service-model"

    Index

    Interfaces

    WebViewServiceType

    Variables

    EVENT_NAME_ON_DID_ADD_WEB_VIEW NETWORK_OBJECT_NAME_WEB_VIEW_SERVICE

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/papi-dts/modules/_shared_utils_async_variable_.html b/papi-dts/modules/_shared_utils_async_variable_.html index 3e2ddbc6ec..4795d8ef60 100644 --- a/papi-dts/modules/_shared_utils_async_variable_.html +++ b/papi-dts/modules/_shared_utils_async_variable_.html @@ -1,2 +1,2 @@ -"shared/utils/async-variable" | papi-dts

    Namespace "shared/utils/async-variable"

    Index

    Classes

    default +"shared/utils/async-variable" | papi-dts

    Namespace "shared/utils/async-variable"

    Index

    Classes

    default

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/papi-dts/modules/_shared_utils_internal_util_.html b/papi-dts/modules/_shared_utils_internal_util_.html index 0810a7e89f..fd415991b0 100644 --- a/papi-dts/modules/_shared_utils_internal_util_.html +++ b/papi-dts/modules/_shared_utils_internal_util_.html @@ -1,4 +1,4 @@ -"shared/utils/internal-util" | papi-dts

    Namespace "shared/utils/internal-util"

    Index

    Functions

    getProcessType +"shared/utils/internal-util" | papi-dts

    Namespace "shared/utils/internal-util"

    Index

    Functions

    getProcessType isClient isExtensionHost isRenderer diff --git a/papi-dts/modules/_shared_utils_papi_util_.html b/papi-dts/modules/_shared_utils_papi_util_.html index 2178a6e76a..7403a14b30 100644 --- a/papi-dts/modules/_shared_utils_papi_util_.html +++ b/papi-dts/modules/_shared_utils_papi_util_.html @@ -1,4 +1,4 @@ -"shared/utils/papi-util" | papi-dts

    Namespace "shared/utils/papi-util"

    Index

    Enumerations

    RequestHandlerType +"shared/utils/papi-util" | papi-dts

    Namespace "shared/utils/papi-util"

    Index

    Enumerations

    RequestHandlerType

    Type Aliases

    ComplexRequest ComplexResponse ComplexResponseFailure diff --git a/papi-dts/modules/_shared_utils_unsubscriber_async_list_.html b/papi-dts/modules/_shared_utils_unsubscriber_async_list_.html index 451727fd37..5f3ad22959 100644 --- a/papi-dts/modules/_shared_utils_unsubscriber_async_list_.html +++ b/papi-dts/modules/_shared_utils_unsubscriber_async_list_.html @@ -1,2 +1,2 @@ -"shared/utils/unsubscriber-async-list" | papi-dts

    Namespace "shared/utils/unsubscriber-async-list"

    Index

    Classes

    default +"shared/utils/unsubscriber-async-list" | papi-dts

    Namespace "shared/utils/unsubscriber-async-list"

    Index

    Classes

    default

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/papi-dts/modules/_shared_utils_util_.html b/papi-dts/modules/_shared_utils_util_.html index 9913c9ae13..1f7f2b5e27 100644 --- a/papi-dts/modules/_shared_utils_util_.html +++ b/papi-dts/modules/_shared_utils_util_.html @@ -1,4 +1,4 @@ -"shared/utils/util" | papi-dts

    Namespace "shared/utils/util"

    Index

    Functions

    debounce +"shared/utils/util" | papi-dts

    Namespace "shared/utils/util"

    Index

    Functions

    debounce getAllObjectFunctionNames getErrorMessage groupBy diff --git a/papi-dts/modules/webViewComponent.html b/papi-dts/modules/webViewComponent.html index 7fd5dbe5c5..c4265416a7 100644 --- a/papi-dts/modules/webViewComponent.html +++ b/papi-dts/modules/webViewComponent.html @@ -1,6 +1,6 @@ webViewComponent | papi-dts

    Namespace webViewComponent

    A function that each React WebView extension must provide for Paranext to display it. Only used in WebView iframes.

    -

    Index

    Variables

    contextTypes? +

    Index

    Variables

    contextTypes? defaultProps? displayName? propTypes? diff --git a/papi-dts/types/__papi_frontend_.Papi.html b/papi-dts/types/__papi_frontend_.Papi.html index 3520f5091d..bb8f6ce460 100644 --- a/papi-dts/types/__papi_frontend_.Papi.html +++ b/papi-dts/types/__papi_frontend_.Papi.html @@ -1 +1 @@ -Papi | papi-dts

    Type alias Papi

    Papi: typeof "@papi/frontend".default

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +Papi | papi-dts

    Type alias Papi

    Papi: typeof "@papi/frontend".default

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/papi-dts/types/_client_services_web_socket_interface_.IWebSocket.html b/papi-dts/types/_client_services_web_socket_interface_.IWebSocket.html index 6994886719..8cca102596 100644 --- a/papi-dts/types/_client_services_web_socket_interface_.IWebSocket.html +++ b/papi-dts/types/_client_services_web_socket_interface_.IWebSocket.html @@ -3,4 +3,4 @@ ClientNetworkConnector. For now, we are just using the browser WebSocket type. We may need specific functionality that don't line up between the ws library's implementation and the browser implementation. We can adjust as needed at that point.

    -

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/papi-dts/types/_extension_host_extension_types_extension_activation_context_model_.ExecutionActivationContext.html b/papi-dts/types/_extension_host_extension_types_extension_activation_context_model_.ExecutionActivationContext.html index 77f718a939..7652083bf7 100644 --- a/papi-dts/types/_extension_host_extension_types_extension_activation_context_model_.ExecutionActivationContext.html +++ b/papi-dts/types/_extension_host_extension_types_extension_activation_context_model_.ExecutionActivationContext.html @@ -2,4 +2,4 @@

    Type declaration

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/papi-dts/types/_extension_host_extension_types_extension_manifest_model_.ExtensionManifest.html b/papi-dts/types/_extension_host_extension_types_extension_manifest_model_.ExtensionManifest.html index 97075e7b9a..43e33533e2 100644 --- a/papi-dts/types/_extension_host_extension_types_extension_manifest_model_.ExtensionManifest.html +++ b/papi-dts/types/_extension_host_extension_types_extension_manifest_model_.ExtensionManifest.html @@ -18,4 +18,4 @@ for more information about extension type declaration files.

  • version: string

    Extension version - expected to be semver like "0.1.3".

    Note: semver may become a hard requirement in the future, so we recommend using it now.

    -

    • Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/papi-dts/types/_node_models_execution_token_model_.ExecutionTokenType.html b/papi-dts/types/_node_models_execution_token_model_.ExecutionTokenType.html index c3894e8990..9632f12d82 100644 --- a/papi-dts/types/_node_models_execution_token_model_.ExecutionTokenType.html +++ b/papi-dts/types/_node_models_execution_token_model_.ExecutionTokenType.html @@ -1,2 +1,2 @@ ExecutionTokenType | papi-dts

    Type alias ExecutionTokenType

    ExecutionTokenType: "extension"

    For now this is just for extensions, but maybe we will want to expand this in the future

    -

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/papi-dts/types/_node_services_node_file_system_service_.DirectoryEntries.html b/papi-dts/types/_node_services_node_file_system_service_.DirectoryEntries.html index a18fc0b173..e6b917a52c 100644 --- a/papi-dts/types/_node_services_node_file_system_service_.DirectoryEntries.html +++ b/papi-dts/types/_node_services_node_file_system_service_.DirectoryEntries.html @@ -1,2 +1,2 @@ DirectoryEntries | papi-dts

    Type alias DirectoryEntries

    DirectoryEntries: Readonly<{
        [entryType in EntryType]: Uri[]
    }>

    All entries in a directory, mapped from entry type to array of uris for the entries

    -

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/papi-dts/types/_papi_shared_types_.CommandNames.html b/papi-dts/types/_papi_shared_types_.CommandNames.html index b507092112..407417a2e4 100644 --- a/papi-dts/types/_papi_shared_types_.CommandNames.html +++ b/papi-dts/types/_papi_shared_types_.CommandNames.html @@ -2,4 +2,4 @@

    Automatically includes all extensions' commands that are added to CommandHandlers.

    Example

    'platform.quit';
    -

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/papi-dts/types/_papi_shared_types_.DataProviderNames.html b/papi-dts/types/_papi_shared_types_.DataProviderNames.html index de67647c63..844fdbdd57 100644 --- a/papi-dts/types/_papi_shared_types_.DataProviderNames.html +++ b/papi-dts/types/_papi_shared_types_.DataProviderNames.html @@ -2,4 +2,4 @@

    Automatically includes all extensions' data providers that are added to DataProviders.

    Example

    'platform.placeholder'
    -

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/papi-dts/types/_papi_shared_types_.DataProviderTypes.html b/papi-dts/types/_papi_shared_types_.DataProviderTypes.html index 84f1e3eae4..f08c1e4c19 100644 --- a/papi-dts/types/_papi_shared_types_.DataProviderTypes.html +++ b/papi-dts/types/_papi_shared_types_.DataProviderTypes.html @@ -3,4 +3,4 @@

    Automatically includes all extensions' data providers that are added to DataProviders.

    Example

    DataProviderTypes['helloSomeone.people'] => {
        Greeting: DataProviderDataType<string, string | undefined, string>;
        Age: DataProviderDataType<string, number | undefined, number>;
        People: DataProviderDataType<undefined, PeopleData, never>;
      }
    -

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/papi-dts/types/_papi_shared_types_.DisposableDataProviders.html b/papi-dts/types/_papi_shared_types_.DisposableDataProviders.html index be55d141b3..0fb16a71e7 100644 --- a/papi-dts/types/_papi_shared_types_.DisposableDataProviders.html +++ b/papi-dts/types/_papi_shared_types_.DisposableDataProviders.html @@ -2,4 +2,4 @@ returned from papi.dataProviders.registerEngine - only the one who registers a data provider engine is allowed to dispose of the data provider.

    Automatically includes all extensions' data providers that are added to DataProviders.

    -

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/papi-dts/types/_papi_shared_types_.NotesOnlyProjectDataTypes.html b/papi-dts/types/_papi_shared_types_.NotesOnlyProjectDataTypes.html index 45cceadcfc..636f191ff6 100644 --- a/papi-dts/types/_papi_shared_types_.NotesOnlyProjectDataTypes.html +++ b/papi-dts/types/_papi_shared_types_.NotesOnlyProjectDataTypes.html @@ -1,2 +1,2 @@ NotesOnlyProjectDataTypes | papi-dts

    Type alias NotesOnlyProjectDataTypes

    NotesOnlyProjectDataTypes: MandatoryProjectDataType & {
        Notes: DataProviderDataType<string, string | undefined, string>;
    }

    This is just a simple example so we have more than one. It's not intended to be real.

    -

    Type declaration

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Type declaration

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/papi-dts/types/_papi_shared_types_.PlaceholderDataTypes.html b/papi-dts/types/_papi_shared_types_.PlaceholderDataTypes.html index 9d40efb237..1ec0b6f3ec 100644 --- a/papi-dts/types/_papi_shared_types_.PlaceholderDataTypes.html +++ b/papi-dts/types/_papi_shared_types_.PlaceholderDataTypes.html @@ -1 +1 @@ -PlaceholderDataTypes | papi-dts

    Type alias PlaceholderDataTypes

    PlaceholderDataTypes: {
        Placeholder: DataProviderDataType<{
            thing: number;
        }, string[], number>;
    }

    Type declaration

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +PlaceholderDataTypes | papi-dts

    Type alias PlaceholderDataTypes

    PlaceholderDataTypes: {
        Placeholder: DataProviderDataType<{
            thing: number;
        }, string[], number>;
    }

    Type declaration

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/papi-dts/types/_papi_shared_types_.ProjectDataTypes.html b/papi-dts/types/_papi_shared_types_.ProjectDataTypes.html index 622d7d7727..75c968fd85 100644 --- a/papi-dts/types/_papi_shared_types_.ProjectDataTypes.html +++ b/papi-dts/types/_papi_shared_types_.ProjectDataTypes.html @@ -4,4 +4,4 @@ ProjectDataProviders.

    Example

    ProjectDataTypes['MyExtensionProjectTypeName'] => {
        MyProjectData: DataProviderDataType<string, string, string>;
      }
    -

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/papi-dts/types/_papi_shared_types_.ProjectTypes.html b/papi-dts/types/_papi_shared_types_.ProjectTypes.html index 4adefbca63..b83d12b099 100644 --- a/papi-dts/types/_papi_shared_types_.ProjectTypes.html +++ b/papi-dts/types/_papi_shared_types_.ProjectTypes.html @@ -3,4 +3,4 @@ ProjectDataProviders.

    Example

    'platform.placeholder'
    -

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/papi-dts/types/_papi_shared_types_.SettingNames.html b/papi-dts/types/_papi_shared_types_.SettingNames.html index 843fdbe84f..74a2dc3756 100644 --- a/papi-dts/types/_papi_shared_types_.SettingNames.html +++ b/papi-dts/types/_papi_shared_types_.SettingNames.html @@ -1 +1 @@ -SettingNames | papi-dts

    Type alias SettingNames

    SettingNames: keyof SettingTypes

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +SettingNames | papi-dts

    Type alias SettingNames

    SettingNames: keyof SettingTypes

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/papi-dts/types/_papi_shared_types_.StuffDataTypes.html b/papi-dts/types/_papi_shared_types_.StuffDataTypes.html index 0e5e99fa04..a12bb7c55d 100644 --- a/papi-dts/types/_papi_shared_types_.StuffDataTypes.html +++ b/papi-dts/types/_papi_shared_types_.StuffDataTypes.html @@ -1 +1 @@ -StuffDataTypes | papi-dts

    Type alias StuffDataTypes

    StuffDataTypes: {
        Stuff: DataProviderDataType<string, number, never>;
    }

    Type declaration

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +StuffDataTypes | papi-dts

    Type alias StuffDataTypes

    StuffDataTypes: {
        Stuff: DataProviderDataType<string, number, never>;
    }

    Type declaration

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/papi-dts/types/_renderer_components_dialogs_dialog_base_data_.DialogDefinitionBase.html b/papi-dts/types/_renderer_components_dialogs_dialog_base_data_.DialogDefinitionBase.html index 198400c6a5..b5d3834128 100644 --- a/papi-dts/types/_renderer_components_dialogs_dialog_base_data_.DialogDefinitionBase.html +++ b/papi-dts/types/_renderer_components_dialogs_dialog_base_data_.DialogDefinitionBase.html @@ -14,4 +14,4 @@

    TODO: preserve requests between refreshes - save the dialog info in such a way that it works when loading again after refresh

  • Optional tabType?: string

    Overwritten in DialogDefinition. Must be specified by all DialogDefinitions

    -

    • Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/papi-dts/types/_renderer_components_dialogs_dialog_base_data_.DialogProps.html b/papi-dts/types/_renderer_components_dialogs_dialog_base_data_.DialogProps.html index 6e9e02180a..d01b0e5f89 100644 --- a/papi-dts/types/_renderer_components_dialogs_dialog_base_data_.DialogProps.html +++ b/papi-dts/types/_renderer_components_dialogs_dialog_base_data_.DialogProps.html @@ -1,7 +1,7 @@ DialogProps | papi-dts

    Type alias DialogProps<TData>

    DialogProps<TData>: DialogData & {
        cancelDialog(): void;
        rejectDialog(errorMessage): void;
        submitDialog(data): void;
    }

    Props provided to the dialog component

    Type Parameters

    • TData = unknown

    Type declaration

    • cancelDialog:function
      • cancelDialog(): void

      • Cancels the dialog request (resolves the response with undefined) and closes the dialog

        -

        Returns void

    • rejectDialog:function
      • rejectDialog(errorMessage): void

      • Rejects the dialog request with the specified message and closes the dialog

        +

        Returns void

    • rejectDialog:function
      • rejectDialog(errorMessage): void

      • Rejects the dialog request with the specified message and closes the dialog

        Parameters

        • errorMessage: string

          Message to explain why the dialog request was rejected

          -

        Returns void

    • submitDialog:function
      • submitDialog(data): void

      • Sends the data as a resolved response to the dialog request and closes the dialog

        +

    Returns void

  • submitDialog:function
    • submitDialog(data): void

    • Sends the data as a resolved response to the dialog request and closes the dialog

      Parameters

      • data: TData

        Data with which to resolve the request

        -

      Returns void

    • Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Returns void

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/papi-dts/types/_renderer_components_dialogs_dialog_definition_model_.DialogDataTypes.html b/papi-dts/types/_renderer_components_dialogs_dialog_definition_model_.DialogDataTypes.html index bc06ef0664..54790d3d50 100644 --- a/papi-dts/types/_renderer_components_dialogs_dialog_definition_model_.DialogDataTypes.html +++ b/papi-dts/types/_renderer_components_dialogs_dialog_definition_model_.DialogDataTypes.html @@ -5,4 +5,4 @@ as props

  • props: DialogProps<TReturnType> & TOptions

    Props provided to the dialog component

  • responseType: TReturnType

    The type of the response to the dialog request

    -

    • Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/papi-dts/types/_renderer_components_dialogs_dialog_definition_model_.DialogDefinition.html b/papi-dts/types/_renderer_components_dialogs_dialog_definition_model_.DialogDefinition.html index a302a1a825..7c1736052b 100644 --- a/papi-dts/types/_renderer_components_dialogs_dialog_definition_model_.DialogDefinition.html +++ b/papi-dts/types/_renderer_components_dialogs_dialog_definition_model_.DialogDefinition.html @@ -1 +1 @@ -DialogDefinition | papi-dts

    Type alias DialogDefinition<DialogTabType>

    DialogDefinition<DialogTabType>: Readonly<DialogDefinitionBase & {
        Component: ((props) => ReactElement);
        tabType: DialogTabType;
    }>

    Type Parameters

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +DialogDefinition | papi-dts

    Type alias DialogDefinition<DialogTabType>

    DialogDefinition<DialogTabType>: Readonly<DialogDefinitionBase & {
        Component: ((props) => ReactElement);
        tabType: DialogTabType;
    }>

    Type Parameters

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/papi-dts/types/_renderer_components_dialogs_dialog_definition_model_.DialogTabTypes.html b/papi-dts/types/_renderer_components_dialogs_dialog_definition_model_.DialogTabTypes.html index 650e6d9fb4..c435e53fe5 100644 --- a/papi-dts/types/_renderer_components_dialogs_dialog_definition_model_.DialogTabTypes.html +++ b/papi-dts/types/_renderer_components_dialogs_dialog_definition_model_.DialogTabTypes.html @@ -1,2 +1,2 @@ DialogTabTypes | papi-dts

    Type alias DialogTabTypes

    DialogTabTypes: keyof DialogTypes

    Each type of dialog. These are the tab types used in the dock layout

    -

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/papi-dts/types/_renderer_components_dialogs_dialog_definition_model_.SelectMultipleProjectsDialogOptions.html b/papi-dts/types/_renderer_components_dialogs_dialog_definition_model_.SelectMultipleProjectsDialogOptions.html index 5560dbda64..4e604259a4 100644 --- a/papi-dts/types/_renderer_components_dialogs_dialog_definition_model_.SelectMultipleProjectsDialogOptions.html +++ b/papi-dts/types/_renderer_components_dialogs_dialog_definition_model_.SelectMultipleProjectsDialogOptions.html @@ -1,4 +1,4 @@ SelectMultipleProjectsDialogOptions | papi-dts

    Type alias SelectMultipleProjectsDialogOptions

    SelectMultipleProjectsDialogOptions: DialogOptions & {
        excludeProjectIds?: string[];
        selectedProjectIds?: string[];
    }

    Options to provide when showing the Select Multiple Project dialog

    Type declaration

    • Optional excludeProjectIds?: string[]

      Project IDs to exclude from showing in the dialog

    • Optional selectedProjectIds?: string[]

      Project IDs that should start selected in the dialog

      -

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/papi-dts/types/_renderer_components_dialogs_dialog_definition_model_.SelectProjectDialogOptions.html b/papi-dts/types/_renderer_components_dialogs_dialog_definition_model_.SelectProjectDialogOptions.html index 0afb940bfb..3911bf5da7 100644 --- a/papi-dts/types/_renderer_components_dialogs_dialog_definition_model_.SelectProjectDialogOptions.html +++ b/papi-dts/types/_renderer_components_dialogs_dialog_definition_model_.SelectProjectDialogOptions.html @@ -1,3 +1,3 @@ SelectProjectDialogOptions | papi-dts

    Type alias SelectProjectDialogOptions

    SelectProjectDialogOptions: DialogOptions & {
        excludeProjectIds?: string[];
    }

    Options to provide when showing the Select Project dialog

    Type declaration

    • Optional excludeProjectIds?: string[]

      Project IDs to exclude from showing in the dialog

      -

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/papi-dts/types/_renderer_hooks_papi_hooks_use_dialog_callback_hook_.UseDialogCallbackOptions.html b/papi-dts/types/_renderer_hooks_papi_hooks_use_dialog_callback_hook_.UseDialogCallbackOptions.html index 5c98de1fbc..d0a76b1fa2 100644 --- a/papi-dts/types/_renderer_hooks_papi_hooks_use_dialog_callback_hook_.UseDialogCallbackOptions.html +++ b/papi-dts/types/_renderer_hooks_papi_hooks_use_dialog_callback_hook_.UseDialogCallbackOptions.html @@ -1,4 +1,4 @@ UseDialogCallbackOptions | papi-dts

    Type alias UseDialogCallbackOptions

    UseDialogCallbackOptions: {
        maximumOpenDialogs?: number;
    }

    Type declaration

    • Optional maximumOpenDialogs?: number

      How many dialogs are allowed to be open at once from this dialog callback. Calling the callback when this number of maximum open dialogs has been reached does nothing. Set to -1 for unlimited. Defaults to 1.

      -

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/papi-dts/types/_renderer_hooks_papi_hooks_use_promise_hook_.UsePromiseOptions.html b/papi-dts/types/_renderer_hooks_papi_hooks_use_promise_hook_.UsePromiseOptions.html index 4728ac0b3e..b80bad22fe 100644 --- a/papi-dts/types/_renderer_hooks_papi_hooks_use_promise_hook_.UsePromiseOptions.html +++ b/papi-dts/types/_renderer_hooks_papi_hooks_use_promise_hook_.UsePromiseOptions.html @@ -1,3 +1,3 @@ UsePromiseOptions | papi-dts

    Type alias UsePromiseOptions

    UsePromiseOptions: {
        preserveValue?: boolean;
    }

    Type declaration

    • Optional preserveValue?: boolean

      Whether to leave the value as the most recent resolved promise value or set it back to defaultValue while running the promise again. Defaults to true

      -

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/papi-dts/types/_shared_data_file_system_model_.Uri.html b/papi-dts/types/_shared_data_file_system_model_.Uri.html index f9fb0dd30f..55dfde4fca 100644 --- a/papi-dts/types/_shared_data_file_system_model_.Uri.html +++ b/papi-dts/types/_shared_data_file_system_model_.Uri.html @@ -7,4 +7,4 @@
  • resources:// - goes to the resources directory installed in the app
  • file:// - an absolute file path from root
    • -

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/papi-dts/types/_shared_data_internal_connection_model_.ClientConnectEvent.html b/papi-dts/types/_shared_data_internal_connection_model_.ClientConnectEvent.html index 5320a4ca4b..7a3109e57c 100644 --- a/papi-dts/types/_shared_data_internal_connection_model_.ClientConnectEvent.html +++ b/papi-dts/types/_shared_data_internal_connection_model_.ClientConnectEvent.html @@ -1,2 +1,2 @@ ClientConnectEvent | papi-dts

    Type alias ClientConnectEvent

    ClientConnectEvent: {
        clientId: number;
        didReconnect: boolean;
    }

    Event emitted when client connections are established

    -

    Type declaration

    • clientId: number
    • didReconnect: boolean

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Type declaration

    • clientId: number
    • didReconnect: boolean

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/papi-dts/types/_shared_data_internal_connection_model_.ClientDisconnectEvent.html b/papi-dts/types/_shared_data_internal_connection_model_.ClientDisconnectEvent.html index 1283f3f27c..f07c13de88 100644 --- a/papi-dts/types/_shared_data_internal_connection_model_.ClientDisconnectEvent.html +++ b/papi-dts/types/_shared_data_internal_connection_model_.ClientDisconnectEvent.html @@ -1,2 +1,2 @@ ClientDisconnectEvent | papi-dts

    Type alias ClientDisconnectEvent

    ClientDisconnectEvent: {
        clientId: number;
    }

    Event emitted when client connections are lost

    -

    Type declaration

    • clientId: number

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Type declaration

    • clientId: number

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/papi-dts/types/_shared_data_internal_connection_model_.InternalEvent.html b/papi-dts/types/_shared_data_internal_connection_model_.InternalEvent.html index 6d070930d5..852da51a17 100644 --- a/papi-dts/types/_shared_data_internal_connection_model_.InternalEvent.html +++ b/papi-dts/types/_shared_data_internal_connection_model_.InternalEvent.html @@ -1,4 +1,4 @@ InternalEvent | papi-dts

    Type alias InternalEvent<T>

    InternalEvent<T>: {
        event: T;
        senderId: number;
    }

    Event to be sent out throughout all processes

    Type Parameters

    • T

    Type declaration

    • event: T

      Contents of the event

    • senderId: number

      The process that emitted this Event

      -

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/papi-dts/types/_shared_data_internal_connection_model_.InternalNetworkEventHandler.html b/papi-dts/types/_shared_data_internal_connection_model_.InternalNetworkEventHandler.html index 5470c3817c..ce84e247b0 100644 --- a/papi-dts/types/_shared_data_internal_connection_model_.InternalNetworkEventHandler.html +++ b/papi-dts/types/_shared_data_internal_connection_model_.InternalNetworkEventHandler.html @@ -1,3 +1,3 @@ InternalNetworkEventHandler | papi-dts

    Type alias InternalNetworkEventHandler

    InternalNetworkEventHandler: (<T>(eventType, incomingEvent) => void)

    Type declaration

      • <T>(eventType, incomingEvent): void

      • Handler for events from on the network. Used internally between network connector and Connection Service

        -

        Type Parameters

        • T

        Parameters

        Returns void

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Type Parameters

    • T

    Parameters

    Returns void

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/papi-dts/types/_shared_data_internal_connection_model_.InternalRequest.html b/papi-dts/types/_shared_data_internal_connection_model_.InternalRequest.html index b4f2b6f136..6519a6d1e8 100644 --- a/papi-dts/types/_shared_data_internal_connection_model_.InternalRequest.html +++ b/papi-dts/types/_shared_data_internal_connection_model_.InternalRequest.html @@ -1,2 +1,2 @@ InternalRequest | papi-dts

    Type alias InternalRequest<TParam>

    InternalRequest<TParam>: {
        requestId: number;
    } & ComplexRequest<TParam>

    Request to do something and to respond

    -

    Type Parameters

    • TParam = unknown

    Type declaration

    • requestId: number

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Type Parameters

    • TParam = unknown

    Type declaration

    • requestId: number

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/papi-dts/types/_shared_data_internal_connection_model_.InternalRequestHandler.html b/papi-dts/types/_shared_data_internal_connection_model_.InternalRequestHandler.html index b193500cb7..6694147031 100644 --- a/papi-dts/types/_shared_data_internal_connection_model_.InternalRequestHandler.html +++ b/papi-dts/types/_shared_data_internal_connection_model_.InternalRequestHandler.html @@ -1,3 +1,3 @@ InternalRequestHandler | papi-dts

    Type alias InternalRequestHandler

    InternalRequestHandler: (<TParam, TReturn>(requestType, request) => Promise<InternalResponse<TReturn>>)

    Type declaration

      • <TParam, TReturn>(requestType, request): Promise<InternalResponse<TReturn>>

      • Handler for requests from the server. Used internally between network connector and Connection Service

        -

        Type Parameters

        • TParam

        • TReturn

        Parameters

        Returns Promise<InternalResponse<TReturn>>

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Type Parameters

    • TParam

    • TReturn

    Parameters

    Returns Promise<InternalResponse<TReturn>>

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/papi-dts/types/_shared_data_internal_connection_model_.InternalResponse.html b/papi-dts/types/_shared_data_internal_connection_model_.InternalResponse.html index 0c301b2b18..fe273cfdfa 100644 --- a/papi-dts/types/_shared_data_internal_connection_model_.InternalResponse.html +++ b/papi-dts/types/_shared_data_internal_connection_model_.InternalResponse.html @@ -1,4 +1,4 @@ InternalResponse | papi-dts

    Type alias InternalResponse<TReturn>

    InternalResponse<TReturn>: {
        requestId: number;
        requesterId: number;
        senderId: number;
    } & ComplexResponse<TReturn>

    Response to a request

    Type Parameters

    • TReturn = unknown

    Type declaration

    • requestId: number
    • requesterId: number

      The process that originally sent the Request that matches to this response

    • senderId: number

      The process that sent this Response

      -

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/papi-dts/types/_shared_data_internal_connection_model_.NetworkConnectorEventHandlers.html b/papi-dts/types/_shared_data_internal_connection_model_.NetworkConnectorEventHandlers.html index f9074196cb..f1f8901b9b 100644 --- a/papi-dts/types/_shared_data_internal_connection_model_.NetworkConnectorEventHandlers.html +++ b/papi-dts/types/_shared_data_internal_connection_model_.NetworkConnectorEventHandlers.html @@ -2,4 +2,4 @@ from NetworkEventEmitters so the events inform all interested connections

    Type declaration

    • Optional didClientConnectHandler?: ((event) => void)
        • (event): void

        • Handles when a new connection is established

          Parameters

          Returns void

    • Optional didClientDisconnectHandler?: ((event) => void)

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Parameters

    Returns void

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/papi-dts/types/_shared_data_internal_connection_model_.NetworkConnectorInfo.html b/papi-dts/types/_shared_data_internal_connection_model_.NetworkConnectorInfo.html index 391c9671c2..a89f6b482d 100644 --- a/papi-dts/types/_shared_data_internal_connection_model_.NetworkConnectorInfo.html +++ b/papi-dts/types/_shared_data_internal_connection_model_.NetworkConnectorInfo.html @@ -1,2 +1,2 @@ NetworkConnectorInfo | papi-dts

    Type alias NetworkConnectorInfo

    NetworkConnectorInfo: Readonly<{
        clientId: number;
    }>

    Information about the network connector

    -

    Type declaration

    • clientId: number

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Type declaration

    • clientId: number

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/papi-dts/types/_shared_data_internal_connection_model_.NetworkEventHandler.html b/papi-dts/types/_shared_data_internal_connection_model_.NetworkEventHandler.html index 05fdcbf2c8..80cbe35d65 100644 --- a/papi-dts/types/_shared_data_internal_connection_model_.NetworkEventHandler.html +++ b/papi-dts/types/_shared_data_internal_connection_model_.NetworkEventHandler.html @@ -1,2 +1,2 @@ NetworkEventHandler | papi-dts

    Type alias NetworkEventHandler

    NetworkEventHandler: (<T>(eventType, event) => void)

    Type declaration

      • <T>(eventType, event): void

      • Handler for events from on the network

        -

        Type Parameters

        • T

        Parameters

        • eventType: string
        • event: T

        Returns void

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Type Parameters

    • T

    Parameters

    • eventType: string
    • event: T

    Returns void

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/papi-dts/types/_shared_data_internal_connection_model_.RequestHandler.html b/papi-dts/types/_shared_data_internal_connection_model_.RequestHandler.html index c2efeeb086..3678deb2ab 100644 --- a/papi-dts/types/_shared_data_internal_connection_model_.RequestHandler.html +++ b/papi-dts/types/_shared_data_internal_connection_model_.RequestHandler.html @@ -1,2 +1,2 @@ RequestHandler | papi-dts

    Type alias RequestHandler

    RequestHandler: (<TParam, TReturn>(requestType, request) => Promise<ComplexResponse<TReturn>>)

    Type declaration

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Type Parameters

    • TParam

    • TReturn

    Parameters

    Returns Promise<ComplexResponse<TReturn>>

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/papi-dts/types/_shared_data_internal_connection_model_.RequestRouter.html b/papi-dts/types/_shared_data_internal_connection_model_.RequestRouter.html index 8240fa543f..096df70aa1 100644 --- a/papi-dts/types/_shared_data_internal_connection_model_.RequestRouter.html +++ b/papi-dts/types/_shared_data_internal_connection_model_.RequestRouter.html @@ -1,2 +1,2 @@ RequestRouter | papi-dts

    Type alias RequestRouter

    RequestRouter: ((requestType) => number)

    Type declaration

      • (requestType): number

      • Function that returns a clientId to which to send the request based on the requestType

        -

        Parameters

        • requestType: string

        Returns number

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Parameters

    • requestType: string

    Returns number

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/papi-dts/types/_shared_data_network_connector_model_.ClientConnect.html b/papi-dts/types/_shared_data_network_connector_model_.ClientConnect.html index 895701688a..35e3333e0e 100644 --- a/papi-dts/types/_shared_data_network_connector_model_.ClientConnect.html +++ b/papi-dts/types/_shared_data_network_connector_model_.ClientConnect.html @@ -3,4 +3,4 @@ (like if the browser refreshes): if the server has a connection with this clientGuid, it will unregister all requests on that client so the reconnecting client can register its request handlers again.

    -
  • senderId: number
  • type: ClientConnect

    • Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +
  • senderId: number
  • type: ClientConnect

    • Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/papi-dts/types/_shared_data_network_connector_model_.InitClient.html b/papi-dts/types/_shared_data_network_connector_model_.InitClient.html index 12a133f21f..25d3410f33 100644 --- a/papi-dts/types/_shared_data_network_connector_model_.InitClient.html +++ b/papi-dts/types/_shared_data_network_connector_model_.InitClient.html @@ -1,3 +1,3 @@ InitClient | papi-dts

    Type alias InitClient

    InitClient: {
        clientGuid: string;
        connectorInfo: NetworkConnectorInfo;
        senderId: number;
        type: InitClient;
    }

    Message sent to the client to give it NetworkConnectorInfo

    Type declaration

    • clientGuid: string

      Guid unique to this connection. Used to verify important messages like reconnecting

      -
    • connectorInfo: NetworkConnectorInfo
    • senderId: number
    • type: InitClient

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +
  • connectorInfo: NetworkConnectorInfo
  • senderId: number
  • type: InitClient

    • Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/papi-dts/types/_shared_data_network_connector_model_.Message.html b/papi-dts/types/_shared_data_network_connector_model_.Message.html index 5022451b15..fa5f5fbac1 100644 --- a/papi-dts/types/_shared_data_network_connector_model_.Message.html +++ b/papi-dts/types/_shared_data_network_connector_model_.Message.html @@ -1,2 +1,2 @@ Message | papi-dts

    Type alias Message

    Message: InitClient | ClientConnect | WebSocketRequest | WebSocketResponse | WebSocketEvent<unknown>

    Messages send by the WebSocket

    -

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/papi-dts/types/_shared_data_network_connector_model_.WebSocketEvent.html b/papi-dts/types/_shared_data_network_connector_model_.WebSocketEvent.html index 2c7910fa33..4666960db7 100644 --- a/papi-dts/types/_shared_data_network_connector_model_.WebSocketEvent.html +++ b/papi-dts/types/_shared_data_network_connector_model_.WebSocketEvent.html @@ -1,3 +1,3 @@ WebSocketEvent | papi-dts

    Type alias WebSocketEvent<T>

    WebSocketEvent<T>: {
        eventType: string;
        type: Event;
    } & InternalEvent<T>

    Event to be sent out throughout all processes

    Type Parameters

    • T

    Type declaration

    • eventType: string

      What kind of event this is

      -
    • type: Event

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +
  • type: Event

    • Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/papi-dts/types/_shared_data_network_connector_model_.WebSocketRequest.html b/papi-dts/types/_shared_data_network_connector_model_.WebSocketRequest.html index 518ea3ff8e..9b146fd560 100644 --- a/papi-dts/types/_shared_data_network_connector_model_.WebSocketRequest.html +++ b/papi-dts/types/_shared_data_network_connector_model_.WebSocketRequest.html @@ -1,3 +1,3 @@ WebSocketRequest | papi-dts

    Type alias WebSocketRequest<TParam>

    WebSocketRequest<TParam>: {
        requestType: string;
        type: Request;
    } & InternalRequest<TParam>

    Request to do something and to respond

    Type Parameters

    • TParam = unknown

    Type declaration

    • requestType: string

      What kind of request this is. Certain command, etc

      -
    • type: Request

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +
  • type: Request

    • Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/papi-dts/types/_shared_data_network_connector_model_.WebSocketResponse.html b/papi-dts/types/_shared_data_network_connector_model_.WebSocketResponse.html index e6377c5285..48d29a4509 100644 --- a/papi-dts/types/_shared_data_network_connector_model_.WebSocketResponse.html +++ b/papi-dts/types/_shared_data_network_connector_model_.WebSocketResponse.html @@ -1,3 +1,3 @@ WebSocketResponse | papi-dts

    Type alias WebSocketResponse<TReturn>

    WebSocketResponse<TReturn>: {
        requestType: string;
        type: Response;
    } & InternalResponse<TReturn>

    Response to a request

    Type Parameters

    • TReturn = unknown

    Type declaration

    • requestType: string

      What kind of request this is. Certain command, etc

      -
    • type: Response

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +
  • type: Response

    • Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/papi-dts/types/_shared_models_data_provider_engine_model_.DataProviderEngineNotifyUpdate.html b/papi-dts/types/_shared_models_data_provider_engine_model_.DataProviderEngineNotifyUpdate.html index 2f2801331e..6c6e6f43b4 100644 --- a/papi-dts/types/_shared_models_data_provider_engine_model_.DataProviderEngineNotifyUpdate.html +++ b/papi-dts/types/_shared_models_data_provider_engine_model_.DataProviderEngineNotifyUpdate.html @@ -17,4 +17,4 @@

    Example: You can log the manual updates in your data provider engine by spec

    See

    DataProviderUpdateInstructions for more info on the updateInstructions parameter

    WARNING: Do not update a data type in its get<data_type> method (unless you make a base case)! It will create a destructive infinite loop.

    -

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/papi-dts/types/_shared_models_data_provider_engine_model_.WithNotifyUpdate.html b/papi-dts/types/_shared_models_data_provider_engine_model_.WithNotifyUpdate.html index 2bfe243900..8cf4964f04 100644 --- a/papi-dts/types/_shared_models_data_provider_engine_model_.WithNotifyUpdate.html +++ b/papi-dts/types/_shared_models_data_provider_engine_model_.WithNotifyUpdate.html @@ -24,4 +24,4 @@

    See

    DataProviderUpdateInstructions for more info on the updateI

  • DataProviderEngineNotifyUpdate for more information on notifyUpdate.
  • IDataProviderEngine for more information on using this type.
    • -

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/papi-dts/types/_shared_models_data_provider_engine_model_.default.html b/papi-dts/types/_shared_models_data_provider_engine_model_.default.html index 9ccdfbfe69..c4aeb0d326 100644 --- a/papi-dts/types/_shared_models_data_provider_engine_model_.default.html +++ b/papi-dts/types/_shared_models_data_provider_engine_model_.default.html @@ -23,4 +23,4 @@ 
    class MyDPE extends DataProviderEngine<MyDataTypes> implements IDataProviderEngine<MyDataTypes> {
      ...
    }
    -

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/papi-dts/types/_shared_models_data_provider_interface_.IDisposableDataProvider.html b/papi-dts/types/_shared_models_data_provider_interface_.IDisposableDataProvider.html index 9c35543adc..87e3f64a67 100644 --- a/papi-dts/types/_shared_models_data_provider_interface_.IDisposableDataProvider.html +++ b/papi-dts/types/_shared_models_data_provider_interface_.IDisposableDataProvider.html @@ -2,4 +2,4 @@ data provider (only the service that set it up should dispose of it) with dataProviderService.registerEngine

    Type Parameters

    See

    IDataProvider

    -

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/papi-dts/types/_shared_models_data_provider_interface_.default.html b/papi-dts/types/_shared_models_data_provider_interface_.default.html index 44b1e33060..211def9f1e 100644 --- a/papi-dts/types/_shared_models_data_provider_interface_.default.html +++ b/papi-dts/types/_shared_models_data_provider_interface_.default.html @@ -3,4 +3,4 @@ getting a data provider with dataProviderService.get.

    Note: each set<data_type> method has a corresponding get<data_type> and subscribe<data_type> method.

    -

    Type Parameters

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Type Parameters

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/papi-dts/types/_shared_models_data_provider_model_.DataProviderDataType.html b/papi-dts/types/_shared_models_data_provider_model_.DataProviderDataType.html index c233551528..6bedbf30af 100644 --- a/papi-dts/types/_shared_models_data_provider_model_.DataProviderDataType.html +++ b/papi-dts/types/_shared_models_data_provider_model_.DataProviderDataType.html @@ -7,4 +7,4 @@ wants at this data type.

  • setData: TSetData

    The type of data ingested by this data provider when you run set<data_type> based on a provided selector

    -

    • Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/papi-dts/types/_shared_models_data_provider_model_.DataProviderDataTypes.html b/papi-dts/types/_shared_models_data_provider_model_.DataProviderDataTypes.html index 5717e047ce..3d126ed3d8 100644 --- a/papi-dts/types/_shared_models_data_provider_model_.DataProviderDataTypes.html +++ b/papi-dts/types/_shared_models_data_provider_model_.DataProviderDataTypes.html @@ -7,4 +7,4 @@ following:

    {
    Greeting: DataProviderDataType<string, string | undefined, string>;
    Age: DataProviderDataType<string, number | undefined, number>;
    All: DataProviderDataType<undefined, { greeting: string, age: number }, never>;
    }
    -

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/papi-dts/types/_shared_models_data_provider_model_.DataProviderGetter.html b/papi-dts/types/_shared_models_data_provider_model_.DataProviderGetter.html index d26ac59a68..db5fe141b5 100644 --- a/papi-dts/types/_shared_models_data_provider_model_.DataProviderGetter.html +++ b/papi-dts/types/_shared_models_data_provider_model_.DataProviderGetter.html @@ -4,4 +4,4 @@ up-to-date.

    Parameters

    • selector: TDataType["selector"]

      Tells the provider what subset of data to get

    Returns Promise<TDataType["getData"]>

    The subset of data represented by the selector

    -

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/papi-dts/types/_shared_models_data_provider_model_.DataProviderGetters.html b/papi-dts/types/_shared_models_data_provider_model_.DataProviderGetters.html index 48c3676f4e..da8bb62d28 100644 --- a/papi-dts/types/_shared_models_data_provider_model_.DataProviderGetters.html +++ b/papi-dts/types/_shared_models_data_provider_model_.DataProviderGetters.html @@ -1,3 +1,3 @@ DataProviderGetters | papi-dts

    Type alias DataProviderGetters<TDataTypes>

    DataProviderGetters<TDataTypes>: {
        [DataType in keyof TDataTypes as `get${DataType & string}`]: DataProviderGetter<TDataTypes[DataType]>
    }

    Set of all get<data_type> methods that a data provider provides according to its data types.

    Type Parameters

    See

    DataProviderGetter for more information

    -

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/papi-dts/types/_shared_models_data_provider_model_.DataProviderSetter.html b/papi-dts/types/_shared_models_data_provider_model_.DataProviderSetter.html index 1d7e2bfd08..318d879e66 100644 --- a/papi-dts/types/_shared_models_data_provider_model_.DataProviderSetter.html +++ b/papi-dts/types/_shared_models_data_provider_model_.DataProviderSetter.html @@ -6,4 +6,4 @@

    Returns Promise<DataProviderUpdateInstructions<TDataTypes>>

    Information that papi uses to interpret whether to send out updates. Defaults to true (meaning send updates only for this data type).

    See

    DataProviderUpdateInstructions for more info on what to return

    -

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/papi-dts/types/_shared_models_data_provider_model_.DataProviderSetters.html b/papi-dts/types/_shared_models_data_provider_model_.DataProviderSetters.html index 90e644d8e8..0a85df5357 100644 --- a/papi-dts/types/_shared_models_data_provider_model_.DataProviderSetters.html +++ b/papi-dts/types/_shared_models_data_provider_model_.DataProviderSetters.html @@ -1,3 +1,3 @@ DataProviderSetters | papi-dts

    Type alias DataProviderSetters<TDataTypes>

    DataProviderSetters<TDataTypes>: {
        [DataType in keyof TDataTypes as `set${DataType & string}`]: DataProviderSetter<TDataTypes, DataType>
    }

    Set of all set<data_type> methods that a data provider provides according to its data types.

    Type Parameters

    See

    DataProviderSetter for more information

    -

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/papi-dts/types/_shared_models_data_provider_model_.DataProviderSubscriber.html b/papi-dts/types/_shared_models_data_provider_model_.DataProviderSubscriber.html index 9dda570723..dd8c3ab415 100644 --- a/papi-dts/types/_shared_models_data_provider_model_.DataProviderSubscriber.html +++ b/papi-dts/types/_shared_models_data_provider_model_.DataProviderSubscriber.html @@ -8,4 +8,4 @@
  • callback: PapiEventHandler<TDataType["getData"]>

    Function to run with the updated data for this selector

  • Optional options: DataProviderSubscriberOptions

    Various options to adjust how the subscriber emits updates

    • Returns Promise<UnsubscriberAsync>

    Unsubscriber to stop listening for updates

    -

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/papi-dts/types/_shared_models_data_provider_model_.DataProviderSubscriberOptions.html b/papi-dts/types/_shared_models_data_provider_model_.DataProviderSubscriberOptions.html index c309d6af40..8aea282108 100644 --- a/papi-dts/types/_shared_models_data_provider_model_.DataProviderSubscriberOptions.html +++ b/papi-dts/types/_shared_models_data_provider_model_.DataProviderSubscriberOptions.html @@ -21,4 +21,4 @@

    Default

    'deeply-equal'
    -

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/papi-dts/types/_shared_models_data_provider_model_.DataProviderSubscribers.html b/papi-dts/types/_shared_models_data_provider_model_.DataProviderSubscribers.html index 0422edfce6..bdd2b0a286 100644 --- a/papi-dts/types/_shared_models_data_provider_model_.DataProviderSubscribers.html +++ b/papi-dts/types/_shared_models_data_provider_model_.DataProviderSubscribers.html @@ -1,4 +1,4 @@ DataProviderSubscribers | papi-dts

    Type alias DataProviderSubscribers<TDataTypes>

    DataProviderSubscribers<TDataTypes>: {
        [DataType in keyof TDataTypes as `subscribe${DataType & string}`]: DataProviderSubscriber<TDataTypes[DataType]>
    }

    Set of all subscribe<data_type> methods that a data provider provides according to its data types.

    Type Parameters

    See

    DataProviderSubscriber for more information

    -

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/papi-dts/types/_shared_models_data_provider_model_.DataProviderUpdateInstructions.html b/papi-dts/types/_shared_models_data_provider_model_.DataProviderUpdateInstructions.html index 1c4f504cff..7d9817ba14 100644 --- a/papi-dts/types/_shared_models_data_provider_model_.DataProviderUpdateInstructions.html +++ b/papi-dts/types/_shared_models_data_provider_model_.DataProviderUpdateInstructions.html @@ -16,4 +16,4 @@

  • false (or falsy) do not update subscriptions

    • -

    Type Parameters

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Type Parameters

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/papi-dts/types/_shared_models_data_provider_model_.DataTypeNames.html b/papi-dts/types/_shared_models_data_provider_model_.DataTypeNames.html index f2f5124213..a43490e6f2 100644 --- a/papi-dts/types/_shared_models_data_provider_model_.DataTypeNames.html +++ b/papi-dts/types/_shared_models_data_provider_model_.DataTypeNames.html @@ -1,4 +1,4 @@ DataTypeNames | papi-dts

    Type alias DataTypeNames<TDataTypes>

    DataTypeNames<TDataTypes>: keyof TDataTypes & string

    Names of data types in a DataProviderDataTypes type. Indicates the data types that a data provider can handle (so it will have methods with these names like set<data_type>)

    Type Parameters

    See

    DataProviderDataTypes for more information

    -

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/papi-dts/types/_shared_models_data_provider_model_.default.html b/papi-dts/types/_shared_models_data_provider_model_.default.html index f9a4c7c59f..543c673c5e 100644 --- a/papi-dts/types/_shared_models_data_provider_model_.default.html +++ b/papi-dts/types/_shared_models_data_provider_model_.default.html @@ -2,4 +2,4 @@ object layers over the data provider engine and runs its methods along with other methods. This object is transformed into an IDataProvider by networkObjectService.set.

    Type Parameters

    See

    IDataProvider

    -

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/papi-dts/types/_shared_models_dialog_options_model_.DialogData.html b/papi-dts/types/_shared_models_dialog_options_model_.DialogData.html index 0257f90123..2db865af50 100644 --- a/papi-dts/types/_shared_models_dialog_options_model_.DialogData.html +++ b/papi-dts/types/_shared_models_dialog_options_model_.DialogData.html @@ -1,2 +1,2 @@ DialogData | papi-dts

    Type alias DialogData

    DialogData: DialogOptions & {
        isDialog: true;
    }

    Data in each tab that is a dialog. Added to DialogOptions in dialog.service-host.ts

    -

    Type declaration

    • isDialog: true

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Type declaration

    • isDialog: true

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/papi-dts/types/_shared_models_dialog_options_model_.DialogOptions.html b/papi-dts/types/_shared_models_dialog_options_model_.DialogOptions.html index b16ea809bc..44b61e249f 100644 --- a/papi-dts/types/_shared_models_dialog_options_model_.DialogOptions.html +++ b/papi-dts/types/_shared_models_dialog_options_model_.DialogOptions.html @@ -2,4 +2,4 @@

    Type declaration

    • Optional iconUrl?: string

      Url of dialog icon to display in the header. Default is Platform.Bible logo

    • Optional prompt?: string

      The message to show the user in the dialog. Default depends on the dialog

    • Optional title?: string

      Dialog title to display in the header. Default depends on the dialog

      -

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/papi-dts/types/_shared_models_disposal_model_.CanHaveOnDidDispose.html b/papi-dts/types/_shared_models_disposal_model_.CanHaveOnDidDispose.html index 771056287f..6df19704d0 100644 --- a/papi-dts/types/_shared_models_disposal_model_.CanHaveOnDidDispose.html +++ b/papi-dts/types/_shared_models_disposal_model_.CanHaveOnDidDispose.html @@ -1,2 +1,2 @@ CanHaveOnDidDispose | papi-dts

    Type alias CanHaveOnDidDispose<T>

    CanHaveOnDidDispose<T>: Omit<T, "onDidDispose">

    Allow onDidDispose to exist on the type if it was previously disallowed by CannotHaveOnDidDispose

    -

    Type Parameters

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Type Parameters

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/papi-dts/types/_shared_models_docking_framework_model_.AddWebViewEvent.html b/papi-dts/types/_shared_models_docking_framework_model_.AddWebViewEvent.html index e87c25b53d..6451ffed48 100644 --- a/papi-dts/types/_shared_models_docking_framework_model_.AddWebViewEvent.html +++ b/papi-dts/types/_shared_models_docking_framework_model_.AddWebViewEvent.html @@ -1,2 +1,2 @@ AddWebViewEvent | papi-dts

    Type alias AddWebViewEvent

    AddWebViewEvent: {
        layout: Layout;
        webView: SavedWebViewDefinition;
    }

    Event emitted when webViews are created

    -

    Type declaration

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Type declaration

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/papi-dts/types/_shared_models_docking_framework_model_.FloatPosition.html b/papi-dts/types/_shared_models_docking_framework_model_.FloatPosition.html index 8c224baaf9..23365f5f67 100644 --- a/papi-dts/types/_shared_models_docking_framework_model_.FloatPosition.html +++ b/papi-dts/types/_shared_models_docking_framework_model_.FloatPosition.html @@ -4,4 +4,4 @@ window
  • center - center the window in the dock layout
    • -

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/papi-dts/types/_shared_models_docking_framework_model_.FloatSize.html b/papi-dts/types/_shared_models_docking_framework_model_.FloatSize.html index 40141ebf0b..76bf278c4f 100644 --- a/papi-dts/types/_shared_models_docking_framework_model_.FloatSize.html +++ b/papi-dts/types/_shared_models_docking_framework_model_.FloatSize.html @@ -1,2 +1,2 @@ FloatSize | papi-dts

    Type alias FloatSize

    FloatSize: {
        height: number;
        width: number;
    }

    The dimensions for a floating tab in CSS px units

    -

    Type declaration

    • height: number
    • width: number

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Type declaration

    • height: number
    • width: number

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/papi-dts/types/_shared_models_docking_framework_model_.Layout.html b/papi-dts/types/_shared_models_docking_framework_model_.Layout.html index 8d0a2f738e..82a73d1f9b 100644 --- a/papi-dts/types/_shared_models_docking_framework_model_.Layout.html +++ b/papi-dts/types/_shared_models_docking_framework_model_.Layout.html @@ -1,2 +1,2 @@ Layout | papi-dts

    Type alias Layout

    Layout: TabLayout | FloatLayout | PanelLayout

    Information about how a Paranext tab fits into the dock layout

    -

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/papi-dts/types/_shared_models_docking_framework_model_.OnLayoutChangeRCDock.html b/papi-dts/types/_shared_models_docking_framework_model_.OnLayoutChangeRCDock.html index 4602748574..3d053d51c4 100644 --- a/papi-dts/types/_shared_models_docking_framework_model_.OnLayoutChangeRCDock.html +++ b/papi-dts/types/_shared_models_docking_framework_model_.OnLayoutChangeRCDock.html @@ -1,2 +1,2 @@ OnLayoutChangeRCDock | papi-dts

    Type alias OnLayoutChangeRCDock

    OnLayoutChangeRCDock: ((newLayout, currentTabId?, direction?) => Promise<void>)

    Type declaration

      • (newLayout, currentTabId?, direction?): Promise<void>

      • Rc-dock's onLayoutChange prop made asynchronous - resolves

        -

        Parameters

        • newLayout: LayoutBase
        • Optional currentTabId: string
        • Optional direction: DropDirection

        Returns Promise<void>

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Parameters

    • newLayout: LayoutBase
    • Optional currentTabId: string
    • Optional direction: DropDirection

    Returns Promise<void>

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/papi-dts/types/_shared_models_docking_framework_model_.PanelDirection.html b/papi-dts/types/_shared_models_docking_framework_model_.PanelDirection.html index 3f6a87e25b..1d7c790a8f 100644 --- a/papi-dts/types/_shared_models_docking_framework_model_.PanelDirection.html +++ b/papi-dts/types/_shared_models_docking_framework_model_.PanelDirection.html @@ -1 +1 @@ -PanelDirection | papi-dts

    Type alias PanelDirection

    PanelDirection: "left" | "right" | "bottom" | "top" | "before-tab" | "after-tab" | "maximize" | "move" | "active" | "update"

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +PanelDirection | papi-dts

    Type alias PanelDirection

    PanelDirection: "left" | "right" | "bottom" | "top" | "before-tab" | "after-tab" | "maximize" | "move" | "active" | "update"

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/papi-dts/types/_shared_models_docking_framework_model_.PapiDockLayout.html b/papi-dts/types/_shared_models_docking_framework_model_.PapiDockLayout.html index 29871b523f..402d5d7cc1 100644 --- a/papi-dts/types/_shared_models_docking_framework_model_.PapiDockLayout.html +++ b/papi-dts/types/_shared_models_docking_framework_model_.PapiDockLayout.html @@ -27,4 +27,4 @@
  • updateInfo: WebViewDefinitionUpdateInfo

    Properties to update on the WebView. Any unspecified properties will stay the same

    • Returns boolean

    True if successfully found the WebView to update; false otherwise

    -

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/papi-dts/types/_shared_models_docking_framework_model_.SavedTabInfo.html b/papi-dts/types/_shared_models_docking_framework_model_.SavedTabInfo.html index e918f97eb7..2f550a8236 100644 --- a/papi-dts/types/_shared_models_docking_framework_model_.SavedTabInfo.html +++ b/papi-dts/types/_shared_models_docking_framework_model_.SavedTabInfo.html @@ -7,4 +7,4 @@
  • id: string

    Tab ID - a unique identifier that identifies this tab. If this tab is a WebView, this ID will match the WebViewDefinition.id

  • tabType: string

    Type of tab - indicates what kind of built-in tab this info represents

    -

    • Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/papi-dts/types/_shared_models_docking_framework_model_.TabInfo.html b/papi-dts/types/_shared_models_docking_framework_model_.TabInfo.html index 61f9ffed47..b6dd3cbad6 100644 --- a/papi-dts/types/_shared_models_docking_framework_model_.TabInfo.html +++ b/papi-dts/types/_shared_models_docking_framework_model_.TabInfo.html @@ -10,4 +10,4 @@

    Defaults to Platform.Bible logo

  • tabTitle: string

    Text to show on the title bar of the tab

  • Optional tabTooltip?: string

    Text to show when hovering over the title bar of the tab

    -

    • Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/papi-dts/types/_shared_models_docking_framework_model_.TabLoader.html b/papi-dts/types/_shared_models_docking_framework_model_.TabLoader.html index 0190deb406..69e16c7899 100644 --- a/papi-dts/types/_shared_models_docking_framework_model_.TabLoader.html +++ b/papi-dts/types/_shared_models_docking_framework_model_.TabLoader.html @@ -1,4 +1,4 @@ TabLoader | papi-dts

    Type alias TabLoader

    TabLoader: ((savedTabInfo) => TabInfo)

    Type declaration

      • (savedTabInfo): TabInfo

      • Function that takes a SavedTabInfo and creates a Paranext tab out of it. Each type of tab must provide a TabLoader.

        For now all tab creators must do their own data type verification

        -

        Parameters

        Returns TabInfo

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Parameters

    Returns TabInfo

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/papi-dts/types/_shared_models_docking_framework_model_.TabSaver.html b/papi-dts/types/_shared_models_docking_framework_model_.TabSaver.html index 42fedeab2c..e9b56f55a9 100644 --- a/papi-dts/types/_shared_models_docking_framework_model_.TabSaver.html +++ b/papi-dts/types/_shared_models_docking_framework_model_.TabSaver.html @@ -3,4 +3,4 @@ stripped from TabInfo by saveTabInfoBase before saving (so it is just a SavedTabInfo).

    Parameters

    • tabInfo: TabInfo

      The Paranext tab to save

    Returns SavedTabInfo | undefined

    The saved tab info for Paranext to persist. If undefined, does not save the tab

    -

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/papi-dts/types/_shared_models_docking_framework_model_.WebViewTabProps.html b/papi-dts/types/_shared_models_docking_framework_model_.WebViewTabProps.html index b9b7d8a7f3..e61e845795 100644 --- a/papi-dts/types/_shared_models_docking_framework_model_.WebViewTabProps.html +++ b/papi-dts/types/_shared_models_docking_framework_model_.WebViewTabProps.html @@ -1,2 +1,2 @@ WebViewTabProps | papi-dts

    Type alias WebViewTabProps

    WebViewTabProps: WebViewDefinition

    Props that are passed to the web view tab component

    -

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/papi-dts/types/_shared_models_extract_data_provider_data_types_model_.default.html b/papi-dts/types/_shared_models_extract_data_provider_data_types_model_.default.html index 1fe44cf74a..e0e2fca2cc 100644 --- a/papi-dts/types/_shared_models_extract_data_provider_data_types_model_.default.html +++ b/papi-dts/types/_shared_models_extract_data_provider_data_types_model_.default.html @@ -3,4 +3,4 @@

    Works with generic types IDataProvider, DataProviderInternal, IDisposableDataProvider, and IDataProviderEngine along with the papi-shared-types extensible interfaces DataProviders and DisposableDataProviders

    -

    Type Parameters

    • TDataProvider

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Type Parameters

    • TDataProvider

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/papi-dts/types/_shared_models_network_object_model_.DisposableNetworkObject.html b/papi-dts/types/_shared_models_network_object_model_.DisposableNetworkObject.html index d503aa0863..31f13d74b8 100644 --- a/papi-dts/types/_shared_models_network_object_model_.DisposableNetworkObject.html +++ b/papi-dts/types/_shared_models_network_object_model_.DisposableNetworkObject.html @@ -1,3 +1,3 @@ DisposableNetworkObject | papi-dts

    Type alias DisposableNetworkObject<T>

    DisposableNetworkObject<T>: NetworkObject<T> & Dispose

    An object of this type is returned from networkObjectService.set.

    Type Parameters

    See

    networkObjectService

    -

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/papi-dts/types/_shared_models_network_object_model_.LocalObjectToProxyCreator.html b/papi-dts/types/_shared_models_network_object_model_.LocalObjectToProxyCreator.html index a0b489b979..24d9ebf32f 100644 --- a/papi-dts/types/_shared_models_network_object_model_.LocalObjectToProxyCreator.html +++ b/papi-dts/types/_shared_models_network_object_model_.LocalObjectToProxyCreator.html @@ -9,4 +9,4 @@ (probably has to do with that it's a wrapped and layered type). Functions that implement this type should return Partial

    See

    networkObjectService

    -

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/papi-dts/types/_shared_models_network_object_model_.NetworkObject.html b/papi-dts/types/_shared_models_network_object_model_.NetworkObject.html index 442f024986..e6bcca4972 100644 --- a/papi-dts/types/_shared_models_network_object_model_.NetworkObject.html +++ b/papi-dts/types/_shared_models_network_object_model_.NetworkObject.html @@ -5,4 +5,4 @@ call that method. This is because we don't want users of network objects to dispose of them. Only the caller of networkObjectService.set should be able to dispose of the network object.

    Type Parameters

    See

    networkObjectService

    -

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/papi-dts/types/_shared_models_network_object_model_.NetworkObjectDetails.html b/papi-dts/types/_shared_models_network_object_model_.NetworkObjectDetails.html index e57a42a21e..303ac35166 100644 --- a/papi-dts/types/_shared_models_network_object_model_.NetworkObjectDetails.html +++ b/papi-dts/types/_shared_models_network_object_model_.NetworkObjectDetails.html @@ -8,4 +8,4 @@ Data Providers => pdp) should be the same across all process on the network regardless of what programming language they use. For generic network objects, networkObject is appropriate.

    -

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/papi-dts/types/_shared_models_network_object_model_.NetworkableObject.html b/papi-dts/types/_shared_models_network_object_model_.NetworkableObject.html index dd5a74e19a..55fe3a05f6 100644 --- a/papi-dts/types/_shared_models_network_object_model_.NetworkableObject.html +++ b/papi-dts/types/_shared_models_network_object_model_.NetworkableObject.html @@ -1,3 +1,3 @@ NetworkableObject | papi-dts

    Type alias NetworkableObject<T>

    NetworkableObject<T>: T & CannotHaveOnDidDispose

    An object of this type is passed into networkObjectService.set.

    Type Parameters

    • T = object

    See

    networkObjectService

    -

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/papi-dts/types/_shared_models_papi_event_model_.PapiEvent.html b/papi-dts/types/_shared_models_papi_event_model_.PapiEvent.html index dcfeec39d5..8b746d069e 100644 --- a/papi-dts/types/_shared_models_papi_event_model_.PapiEvent.html +++ b/papi-dts/types/_shared_models_papi_event_model_.PapiEvent.html @@ -2,4 +2,4 @@

    Parameters

    Returns Unsubscriber

    Unsubscriber function to run to stop calling the passed-in function when the event is emitted

    -

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/papi-dts/types/_shared_models_papi_event_model_.PapiEventAsync.html b/papi-dts/types/_shared_models_papi_event_model_.PapiEventAsync.html index 7a3eaafc7a..19aaaebaaf 100644 --- a/papi-dts/types/_shared_models_papi_event_model_.PapiEventAsync.html +++ b/papi-dts/types/_shared_models_papi_event_model_.PapiEventAsync.html @@ -1,3 +1,3 @@ PapiEventAsync | papi-dts

    Type alias PapiEventAsync<T>

    PapiEventAsync<T>: ((callback) => Promise<UnsubscriberAsync>)

    Type Parameters

    • T

    Type declaration

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Parameters

    Returns Promise<UnsubscriberAsync>

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/papi-dts/types/_shared_models_papi_event_model_.PapiEventHandler.html b/papi-dts/types/_shared_models_papi_event_model_.PapiEventHandler.html index 2be9677da2..b5558b959e 100644 --- a/papi-dts/types/_shared_models_papi_event_model_.PapiEventHandler.html +++ b/papi-dts/types/_shared_models_papi_event_model_.PapiEventHandler.html @@ -1,2 +1,2 @@ PapiEventHandler | papi-dts

    Type alias PapiEventHandler<T>

    PapiEventHandler<T>: ((event) => void)

    Type Parameters

    • T

    Type declaration

      • (event): void

      • Callback function that accepts an event and should run when an event is emitted

        -

        Parameters

        • event: T

        Returns void

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Parameters

    • event: T

    Returns void

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/papi-dts/types/_shared_models_project_data_provider_engine_model_.ProjectDataProviderEngineTypes.html b/papi-dts/types/_shared_models_project_data_provider_engine_model_.ProjectDataProviderEngineTypes.html index 846e64ee54..0ebc11f13d 100644 --- a/papi-dts/types/_shared_models_project_data_provider_engine_model_.ProjectDataProviderEngineTypes.html +++ b/papi-dts/types/_shared_models_project_data_provider_engine_model_.ProjectDataProviderEngineTypes.html @@ -1,2 +1,2 @@ ProjectDataProviderEngineTypes | papi-dts

    Type alias ProjectDataProviderEngineTypes

    ProjectDataProviderEngineTypes: {
        [ProjectType in ProjectTypes]: "shared/models/data-provider-engine.model".default<ProjectDataTypes[ProjectType]>
    }

    All possible types for ProjectDataProviderEngines: IDataProviderEngine

    -

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/papi-dts/types/_shared_models_project_data_provider_model_.ExtensionDataScope.html b/papi-dts/types/_shared_models_project_data_provider_model_.ExtensionDataScope.html index 572d95339c..ef7375e778 100644 --- a/papi-dts/types/_shared_models_project_data_provider_model_.ExtensionDataScope.html +++ b/papi-dts/types/_shared_models_project_data_provider_model_.ExtensionDataScope.html @@ -9,4 +9,4 @@

    This is the smallest level of granularity provided by a PDP for accessing extension data. There is no way to get or set just a portion of data identified by a single dataQualifier value.

  • extensionName: string

    Name of an extension as provided in its manifest

    -

    • Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/papi-dts/types/_shared_models_project_data_provider_model_.MandatoryProjectDataType.html b/papi-dts/types/_shared_models_project_data_provider_model_.MandatoryProjectDataType.html index 8a91c659a3..f1fe3f2a44 100644 --- a/papi-dts/types/_shared_models_project_data_provider_model_.MandatoryProjectDataType.html +++ b/papi-dts/types/_shared_models_project_data_provider_model_.MandatoryProjectDataType.html @@ -11,4 +11,4 @@ so following this interface ensures your PDP will not break if such a requirement is implemented. -

    Type declaration

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Type declaration

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/papi-dts/types/_shared_models_project_metadata_model_.ProjectMetadata.html b/papi-dts/types/_shared_models_project_metadata_model_.ProjectMetadata.html index 149176d4e1..7e3727a0e2 100644 --- a/papi-dts/types/_shared_models_project_metadata_model_.ProjectMetadata.html +++ b/papi-dts/types/_shared_models_project_metadata_model_.ProjectMetadata.html @@ -5,4 +5,4 @@
  • projectType: ProjectTypes

    Indicates what sort of project this is which implies its data shape (e.g., what data streams should be available)

  • storageType: string

    Indicates how the project is persisted to storage

    -

    • Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/papi-dts/types/_shared_models_web_view_model_.GetWebViewDefinitionUpdatableProperties.html b/papi-dts/types/_shared_models_web_view_model_.GetWebViewDefinitionUpdatableProperties.html index 377d5ef498..6b8e78e926 100644 --- a/papi-dts/types/_shared_models_web_view_model_.GetWebViewDefinitionUpdatableProperties.html +++ b/papi-dts/types/_shared_models_web_view_model_.GetWebViewDefinitionUpdatableProperties.html @@ -1,4 +1,4 @@ GetWebViewDefinitionUpdatableProperties | papi-dts

    Type alias GetWebViewDefinitionUpdatableProperties

    GetWebViewDefinitionUpdatableProperties: (() => WebViewDefinitionUpdatableProperties | undefined)

    Type declaration

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Returns WebViewDefinitionUpdatableProperties | undefined

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/papi-dts/types/_shared_models_web_view_model_.GetWebViewOptions.html b/papi-dts/types/_shared_models_web_view_model_.GetWebViewOptions.html index 6d5f56794e..aadde49e8c 100644 --- a/papi-dts/types/_shared_models_web_view_model_.GetWebViewOptions.html +++ b/papi-dts/types/_shared_models_web_view_model_.GetWebViewOptions.html @@ -11,4 +11,4 @@

    Note: setting existingId to undefined counts as providing in this case (providing is tested with 'existingId' in options, not just testing if existingId is truthy). Not providing an existingId at all is the only way to specify we are not looking for an existing webView

    -

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/papi-dts/types/_shared_models_web_view_model_.SavedWebViewDefinition.html b/papi-dts/types/_shared_models_web_view_model_.SavedWebViewDefinition.html index 38c87d523b..20246178a4 100644 --- a/papi-dts/types/_shared_models_web_view_model_.SavedWebViewDefinition.html +++ b/papi-dts/types/_shared_models_web_view_model_.SavedWebViewDefinition.html @@ -1,4 +1,4 @@ SavedWebViewDefinition | papi-dts

    Type alias SavedWebViewDefinition

    SavedWebViewDefinition: (Partial<Omit<WebViewDefinitionReact, "content" | "styles" | "allowScripts">> | Partial<Omit<WebViewDefinitionHtml, "content" | "allowScripts">> | Partial<Omit<WebViewDefinitionURL, "content" | "allowScripts">>) & Pick<WebViewDefinitionBase, "id" | "webViewType">

    Saved WebView information that does not contain the actual content of the WebView. Saved into layouts. Could have as little as the type and ID. WebView providers load these into actual WebViewDefinitions and verify any existing properties on the WebViews.

    -

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/papi-dts/types/_shared_models_web_view_model_.UpdateWebViewDefinition.html b/papi-dts/types/_shared_models_web_view_model_.UpdateWebViewDefinition.html index 674117c333..30004450fc 100644 --- a/papi-dts/types/_shared_models_web_view_model_.UpdateWebViewDefinition.html +++ b/papi-dts/types/_shared_models_web_view_model_.UpdateWebViewDefinition.html @@ -5,4 +5,4 @@

    ï¼ example

    updateWebViewDefinition({ title: `Hello ${name}` });
    -

    Parameters

    Returns boolean

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Parameters

    Returns boolean

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/papi-dts/types/_shared_models_web_view_model_.UseWebViewStateHook.html b/papi-dts/types/_shared_models_web_view_model_.UseWebViewStateHook.html index 1c0a8dc9e0..39960d79e9 100644 --- a/papi-dts/types/_shared_models_web_view_model_.UseWebViewStateHook.html +++ b/papi-dts/types/_shared_models_web_view_model_.UseWebViewStateHook.html @@ -15,4 +15,4 @@

    ï¼ example

    const [lastPersonSeen, setLastPersonSeen] = useWebViewState('lastSeen', 'No one');
    -

    Type Parameters

    • T

    Parameters

    • stateKey: string
    • defaultStateValue: NonNullable<T>

    Returns [webViewState: NonNullable<T>, setWebViewState: Dispatch<SetStateAction<NonNullable<T>>>]

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Type Parameters

    • T

    Parameters

    • stateKey: string
    • defaultStateValue: NonNullable<T>

    Returns [webViewState: NonNullable<T>, setWebViewState: Dispatch<SetStateAction<NonNullable<T>>>]

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/papi-dts/types/_shared_models_web_view_model_.WebViewDefinition.html b/papi-dts/types/_shared_models_web_view_model_.WebViewDefinition.html index f1968599d7..a7936d28f1 100644 --- a/papi-dts/types/_shared_models_web_view_model_.WebViewDefinition.html +++ b/papi-dts/types/_shared_models_web_view_model_.WebViewDefinition.html @@ -1,2 +1,2 @@ WebViewDefinition | papi-dts

    Type alias WebViewDefinition

    WebViewDefinition: WebViewDefinitionReact | WebViewDefinitionHtml | WebViewDefinitionURL

    Properties defining a type of WebView created by extensions to show web content

    -

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/papi-dts/types/_shared_models_web_view_model_.WebViewDefinitionBase.html b/papi-dts/types/_shared_models_web_view_model_.WebViewDefinitionBase.html index 8200a57f38..df0505726a 100644 --- a/papi-dts/types/_shared_models_web_view_model_.WebViewDefinitionBase.html +++ b/papi-dts/types/_shared_models_web_view_model_.WebViewDefinitionBase.html @@ -65,4 +65,4 @@
  • Optional title?: string

    Name of the tab for the WebView

  • Optional tooltip?: string

    Tooltip that is shown when hovering over the webview title

  • webViewType: WebViewType

    What type of WebView this is. Unique to all other WebView definitions

    -

    • Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/papi-dts/types/_shared_models_web_view_model_.WebViewDefinitionHtml.html b/papi-dts/types/_shared_models_web_view_model_.WebViewDefinitionHtml.html index 7d81c8c9b4..532ed8f674 100644 --- a/papi-dts/types/_shared_models_web_view_model_.WebViewDefinitionHtml.html +++ b/papi-dts/types/_shared_models_web_view_model_.WebViewDefinitionHtml.html @@ -1,3 +1,3 @@ WebViewDefinitionHtml | papi-dts

    Type alias WebViewDefinitionHtml

    WebViewDefinitionHtml: WebViewDefinitionBase & {
        contentType: HTML;
    }

    WebView representation using HTML

    Type declaration

    • contentType: HTML

      Indicates this WebView uses HTML

      -

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/papi-dts/types/_shared_models_web_view_model_.WebViewDefinitionReact.html b/papi-dts/types/_shared_models_web_view_model_.WebViewDefinitionReact.html index ee75c04b95..31feffab54 100644 --- a/papi-dts/types/_shared_models_web_view_model_.WebViewDefinitionReact.html +++ b/papi-dts/types/_shared_models_web_view_model_.WebViewDefinitionReact.html @@ -1,4 +1,4 @@ WebViewDefinitionReact | papi-dts

    Type alias WebViewDefinitionReact

    WebViewDefinitionReact: WebViewDefinitionBase & {
        contentType?: React;
        styles?: string;
    }

    WebView representation using React

    Type declaration

    • Optional contentType?: React

      Indicates this WebView uses React

    • Optional styles?: string

      String of styles to be loaded into the iframe for this WebView

      -

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/papi-dts/types/_shared_models_web_view_model_.WebViewDefinitionURL.html b/papi-dts/types/_shared_models_web_view_model_.WebViewDefinitionURL.html index df1a21605f..e56e3cbb8b 100644 --- a/papi-dts/types/_shared_models_web_view_model_.WebViewDefinitionURL.html +++ b/papi-dts/types/_shared_models_web_view_model_.WebViewDefinitionURL.html @@ -1,4 +1,4 @@ WebViewDefinitionURL | papi-dts

    Type alias WebViewDefinitionURL

    WebViewDefinitionURL: WebViewDefinitionBase & {
        contentType: URL;
    }

    WebView representation using a URL.

    Note: you can only use papi-extension: and https: urls

    Type declaration

    • contentType: URL

      Indicates this WebView uses a URL

      -

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/papi-dts/types/_shared_models_web_view_model_.WebViewDefinitionUpdatableProperties.html b/papi-dts/types/_shared_models_web_view_model_.WebViewDefinitionUpdatableProperties.html index ed8d4c6222..4f77bd1cf4 100644 --- a/papi-dts/types/_shared_models_web_view_model_.WebViewDefinitionUpdatableProperties.html +++ b/papi-dts/types/_shared_models_web_view_model_.WebViewDefinitionUpdatableProperties.html @@ -1,2 +1,2 @@ WebViewDefinitionUpdatableProperties | papi-dts

    Type alias WebViewDefinitionUpdatableProperties

    WebViewDefinitionUpdatableProperties: Pick<WebViewDefinitionBase, "iconUrl" | "title" | "tooltip">

    The properties on a WebViewDefinition that may be updated when that webview is already displayed

    -

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/papi-dts/types/_shared_models_web_view_model_.WebViewDefinitionUpdateInfo.html b/papi-dts/types/_shared_models_web_view_model_.WebViewDefinitionUpdateInfo.html index 07b5c5a36d..dbff2e9a35 100644 --- a/papi-dts/types/_shared_models_web_view_model_.WebViewDefinitionUpdateInfo.html +++ b/papi-dts/types/_shared_models_web_view_model_.WebViewDefinitionUpdateInfo.html @@ -1,3 +1,3 @@ WebViewDefinitionUpdateInfo | papi-dts

    Type alias WebViewDefinitionUpdateInfo

    WebViewDefinitionUpdateInfo: Partial<WebViewDefinitionUpdatableProperties>

    WebViewDefinition properties for updating a WebView that is already displayed. Any unspecified properties will stay the same

    -

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/papi-dts/types/_shared_models_web_view_model_.WebViewId.html b/papi-dts/types/_shared_models_web_view_model_.WebViewId.html index aba35223ef..1e221294a8 100644 --- a/papi-dts/types/_shared_models_web_view_model_.WebViewId.html +++ b/papi-dts/types/_shared_models_web_view_model_.WebViewId.html @@ -1,2 +1,2 @@ WebViewId | papi-dts

    Type alias WebViewId

    WebViewId: string

    ID for a specific WebView. Each WebView has a unique ID

    -

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/papi-dts/types/_shared_models_web_view_model_.WebViewProps.html b/papi-dts/types/_shared_models_web_view_model_.WebViewProps.html index 603bd9ca92..2d9ea858f5 100644 --- a/papi-dts/types/_shared_models_web_view_model_.WebViewProps.html +++ b/papi-dts/types/_shared_models_web_view_model_.WebViewProps.html @@ -26,4 +26,4 @@

    ï¼ example

    const [lastPersonSeen, setLastPersonSeen] = useWebViewState('lastSeen', 'No one');
    -

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/papi-dts/types/_shared_models_web_view_model_.WebViewType.html b/papi-dts/types/_shared_models_web_view_model_.WebViewType.html index 32ec6257c8..72ec4f675b 100644 --- a/papi-dts/types/_shared_models_web_view_model_.WebViewType.html +++ b/papi-dts/types/_shared_models_web_view_model_.WebViewType.html @@ -1,2 +1,2 @@ WebViewType | papi-dts

    Type alias WebViewType

    WebViewType: string

    What type a WebView is. Each WebView definition must have a unique type.

    -

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/papi-dts/types/_shared_services_command_service_.moduleSummaryComments.html b/papi-dts/types/_shared_services_command_service_.moduleSummaryComments.html index cf8ac2ec78..3ceabeb4e7 100644 --- a/papi-dts/types/_shared_services_command_service_.moduleSummaryComments.html +++ b/papi-dts/types/_shared_services_command_service_.moduleSummaryComments.html @@ -1,4 +1,4 @@ moduleSummaryComments | papi-dts

    Type alias moduleSummaryComments

    moduleSummaryComments: {}

    The command service allows you to exchange messages with other components in the platform. You can register a command that other services and extensions can send you. You can send commands to other services and extensions that have registered commands.

    -

    Type declaration

      Settings

      Member Visibility

      Theme

      Generated using TypeDoc

      \ No newline at end of file +

      Type declaration

        Settings

        Member Visibility

        Theme

        Generated using TypeDoc

        \ No newline at end of file diff --git a/papi-dts/types/_shared_services_network_service_.ArgsRequestHandler.html b/papi-dts/types/_shared_services_network_service_.ArgsRequestHandler.html index 0ac70de7bd..42a6a1091d 100644 --- a/papi-dts/types/_shared_services_network_service_.ArgsRequestHandler.html +++ b/papi-dts/types/_shared_services_network_service_.ArgsRequestHandler.html @@ -2,4 +2,4 @@ the spread of the contents array of the request as its parameters. The function should return an object that becomes the contents object of the response. This type of handler is a normal function.

        -

        Parameters

        • Rest ...args: TParam

        Returns Promise<TReturn> | TReturn

        Settings

        Member Visibility

        Theme

        Generated using TypeDoc

        \ No newline at end of file +

        Parameters

        • Rest ...args: TParam

        Returns Promise<TReturn> | TReturn

        Settings

        Member Visibility

        Theme

        Generated using TypeDoc

        \ No newline at end of file diff --git a/papi-dts/types/_shared_services_network_service_.ComplexRequestHandler.html b/papi-dts/types/_shared_services_network_service_.ComplexRequestHandler.html index a5eb1e67c9..fdddb510be 100644 --- a/papi-dts/types/_shared_services_network_service_.ComplexRequestHandler.html +++ b/papi-dts/types/_shared_services_network_service_.ComplexRequestHandler.html @@ -2,4 +2,4 @@ accept a ComplexRequest object as its single parameter. The function should return a ComplexResponse object that becomes the response.. This type of handler is the most flexible of the request handlers.

        -

        Parameters

        Returns Promise<ComplexResponse<TReturn>>

        Settings

        Member Visibility

        Theme

        Generated using TypeDoc

        \ No newline at end of file +

        Parameters

        Returns Promise<ComplexResponse<TReturn>>

        Settings

        Member Visibility

        Theme

        Generated using TypeDoc

        \ No newline at end of file diff --git a/papi-dts/types/_shared_services_network_service_.ContentsRequestHandler.html b/papi-dts/types/_shared_services_network_service_.ContentsRequestHandler.html index e00b90f127..9dc1292f0d 100644 --- a/papi-dts/types/_shared_services_network_service_.ContentsRequestHandler.html +++ b/papi-dts/types/_shared_services_network_service_.ContentsRequestHandler.html @@ -1,4 +1,4 @@ ContentsRequestHandler | papi-dts

        Type alias ContentsRequestHandler<TParam, TReturn>

        ContentsRequestHandler<TParam, TReturn>: ((contents) => Promise<TReturn>)

        Type Parameters

        • TParam = any

        • TReturn = any

        Type declaration

          • (contents): Promise<TReturn>

          • Contents handler function for a request. Called when a request is handled. The function should accept the contents object of the request as its single parameter. The function should return an object that becomes the contents object of the response.

            -

            Parameters

            • contents: TParam

            Returns Promise<TReturn>

        Settings

        Member Visibility

        Theme

        Generated using TypeDoc

        \ No newline at end of file +

        Parameters

        • contents: TParam

        Returns Promise<TReturn>

        Settings

        Member Visibility

        Theme

        Generated using TypeDoc

        \ No newline at end of file diff --git a/papi-dts/types/_shared_utils_papi_util_.ComplexRequest.html b/papi-dts/types/_shared_utils_papi_util_.ComplexRequest.html index 6980badaa6..cc9179132f 100644 --- a/papi-dts/types/_shared_utils_papi_util_.ComplexRequest.html +++ b/papi-dts/types/_shared_utils_papi_util_.ComplexRequest.html @@ -1,4 +1,4 @@ ComplexRequest | papi-dts

        Type alias ComplexRequest<TParam>

        ComplexRequest<TParam>: {
            contents: TParam;
            senderId: number;
        }

        Type of object passed to a complex request handler that provides information about the request. This type is used as the public-facing interface for requests

        Type Parameters

        • TParam = unknown

        Type declaration

        • contents: TParam
        • senderId: number

          The one who sent the request

          -

        Settings

        Member Visibility

        Theme

        Generated using TypeDoc

        \ No newline at end of file +

        Settings

        Member Visibility

        Theme

        Generated using TypeDoc

        \ No newline at end of file diff --git a/papi-dts/types/_shared_utils_papi_util_.ComplexResponse.html b/papi-dts/types/_shared_utils_papi_util_.ComplexResponse.html index 923cbf28fe..0a87e67ccb 100644 --- a/papi-dts/types/_shared_utils_papi_util_.ComplexResponse.html +++ b/papi-dts/types/_shared_utils_papi_util_.ComplexResponse.html @@ -1,4 +1,4 @@ ComplexResponse | papi-dts

        Type alias ComplexResponse<TReturn>

        ComplexResponse<TReturn>: ComplexResponseSuccess<TReturn> | ComplexResponseFailure

        Type of object to create when handling a complex request where you desire to provide additional information beyond the contents of the response This type is used as the public-facing interface for responses

        -

        Type Parameters

        • TReturn = unknown

        Settings

        Member Visibility

        Theme

        Generated using TypeDoc

        \ No newline at end of file +

        Type Parameters

        • TReturn = unknown

        Settings

        Member Visibility

        Theme

        Generated using TypeDoc

        \ No newline at end of file diff --git a/papi-dts/types/_shared_utils_papi_util_.ComplexResponseFailure.html b/papi-dts/types/_shared_utils_papi_util_.ComplexResponseFailure.html index 62d91e591f..896d548f7d 100644 --- a/papi-dts/types/_shared_utils_papi_util_.ComplexResponseFailure.html +++ b/papi-dts/types/_shared_utils_papi_util_.ComplexResponseFailure.html @@ -1,3 +1,3 @@ ComplexResponseFailure | papi-dts

        Type alias ComplexResponseFailure

        ComplexResponseFailure: {
            errorMessage: string;
            success: false;
        }

        Type declaration

        • errorMessage: string

          Error explaining the problem that is only populated if success is false

        • success: false

          Whether the handler that created this response was successful in handling the request

          -

        Settings

        Member Visibility

        Theme

        Generated using TypeDoc

        \ No newline at end of file +

        Settings

        Member Visibility

        Theme

        Generated using TypeDoc

        \ No newline at end of file diff --git a/papi-dts/types/_shared_utils_papi_util_.ComplexResponseSuccess.html b/papi-dts/types/_shared_utils_papi_util_.ComplexResponseSuccess.html index 491b967277..7f92fbe84a 100644 --- a/papi-dts/types/_shared_utils_papi_util_.ComplexResponseSuccess.html +++ b/papi-dts/types/_shared_utils_papi_util_.ComplexResponseSuccess.html @@ -1,4 +1,4 @@ ComplexResponseSuccess | papi-dts

        Type alias ComplexResponseSuccess<TReturn>

        ComplexResponseSuccess<TReturn>: {
            contents: TReturn;
            success: true;
        }

        Type Parameters

        • TReturn = unknown

        Type declaration

        • contents: TReturn

          Content with which to respond to the request. Must be provided unless the response failed or TReturn is undefined

        • success: true

          Whether the handler that created this response was successful in handling the request

          -

        Settings

        Member Visibility

        Theme

        Generated using TypeDoc

        \ No newline at end of file +

        Settings

        Member Visibility

        Theme

        Generated using TypeDoc

        \ No newline at end of file diff --git a/papi-dts/types/_shared_utils_papi_util_.RequestType.html b/papi-dts/types/_shared_utils_papi_util_.RequestType.html index 1859552ef5..842ed3fcdc 100644 --- a/papi-dts/types/_shared_utils_papi_util_.RequestType.html +++ b/papi-dts/types/_shared_utils_papi_util_.RequestType.html @@ -1,4 +1,4 @@ RequestType | papi-dts

        Type alias RequestType

        RequestType: {
            category: string;
            directive: string;
        }

        Information about a request that tells us what to do with it

        Type declaration

        • category: string

          The general category of request

        • directive: string

          Specific identifier for this type of request

          -

        Settings

        Member Visibility

        Theme

        Generated using TypeDoc

        \ No newline at end of file +

        Settings

        Member Visibility

        Theme

        Generated using TypeDoc

        \ No newline at end of file diff --git a/papi-dts/types/_shared_utils_papi_util_.SerializedRequestType.html b/papi-dts/types/_shared_utils_papi_util_.SerializedRequestType.html index 62a4fd30ab..8a50209b4b 100644 --- a/papi-dts/types/_shared_utils_papi_util_.SerializedRequestType.html +++ b/papi-dts/types/_shared_utils_papi_util_.SerializedRequestType.html @@ -1,3 +1,3 @@ SerializedRequestType | papi-dts

        Type alias SerializedRequestType

        SerializedRequestType: `${string}${typeof REQUEST_TYPE_SEPARATOR}${string}`

        String version of a request type that tells us what to do with a request.

        Consists of two strings concatenated by a colon

        -

        Settings

        Member Visibility

        Theme

        Generated using TypeDoc

        \ No newline at end of file +

        Settings

        Member Visibility

        Theme

        Generated using TypeDoc

        \ No newline at end of file diff --git a/papi-dts/types/_shared_utils_papi_util_.Unsubscriber.html b/papi-dts/types/_shared_utils_papi_util_.Unsubscriber.html index 062ef02de0..d3c5f5a588 100644 --- a/papi-dts/types/_shared_utils_papi_util_.Unsubscriber.html +++ b/papi-dts/types/_shared_utils_papi_util_.Unsubscriber.html @@ -1,2 +1,2 @@ Unsubscriber | papi-dts

        Type alias Unsubscriber

        Unsubscriber: (() => boolean)

        Type declaration

          • (): boolean

          • Function to run to dispose of something. Returns true if successfully unsubscribed

            -

            Returns boolean

        Settings

        Member Visibility

        Theme

        Generated using TypeDoc

        \ No newline at end of file +

        Returns boolean

        Settings

        Member Visibility

        Theme

        Generated using TypeDoc

        \ No newline at end of file diff --git a/papi-dts/types/_shared_utils_papi_util_.UnsubscriberAsync.html b/papi-dts/types/_shared_utils_papi_util_.UnsubscriberAsync.html index ceee945370..3cc2da4e1a 100644 --- a/papi-dts/types/_shared_utils_papi_util_.UnsubscriberAsync.html +++ b/papi-dts/types/_shared_utils_papi_util_.UnsubscriberAsync.html @@ -1,3 +1,3 @@ UnsubscriberAsync | papi-dts

        Type alias UnsubscriberAsync

        UnsubscriberAsync: (() => Promise<boolean>)

        Type declaration

          • (): Promise<boolean>

          • Function to run to dispose of something that runs asynchronously. The promise resolves to true if successfully unsubscribed

            -

            Returns Promise<boolean>

        Settings

        Member Visibility

        Theme

        Generated using TypeDoc

        \ No newline at end of file +

        Returns Promise<boolean>

        Settings

        Member Visibility

        Theme

        Generated using TypeDoc

        \ No newline at end of file diff --git a/papi-dts/types/_shared_utils_papi_util_.moduleSummaryComments.html b/papi-dts/types/_shared_utils_papi_util_.moduleSummaryComments.html index 230c60a871..f7a8a6d8fc 100644 --- a/papi-dts/types/_shared_utils_papi_util_.moduleSummaryComments.html +++ b/papi-dts/types/_shared_utils_papi_util_.moduleSummaryComments.html @@ -1,4 +1,4 @@ moduleSummaryComments | papi-dts

        Type alias moduleSummaryComments

        moduleSummaryComments: {}

        PapiUtil is a collection of functions, objects, and types that are used as helpers in other services. Extensions should not use or rely on anything in papiUtil unless some other service requires it.

        -

        Type declaration

          Settings

          Member Visibility

          Theme

          Generated using TypeDoc

          \ No newline at end of file +

          Type declaration

            Settings

            Member Visibility

            Theme

            Generated using TypeDoc

            \ No newline at end of file diff --git a/papi-dts/variables/__papi_backend_.DataProviderEngine.html b/papi-dts/variables/__papi_backend_.DataProviderEngine.html index caa4bdbb32..65e3e12999 100644 --- a/papi-dts/variables/__papi_backend_.DataProviderEngine.html +++ b/papi-dts/variables/__papi_backend_.DataProviderEngine.html @@ -2,4 +2,4 @@ data provider engine class extends this class, it doesn't have to specify its own notifyUpdate function in order to use notifyUpdate.

            See

            IDataProviderEngine for more information on extending this class.

            -

            Settings

            Member Visibility

            Theme

            Generated using TypeDoc

            \ No newline at end of file +

            Settings

            Member Visibility

            Theme

            Generated using TypeDoc

            \ No newline at end of file diff --git a/papi-dts/variables/__papi_backend_.EventEmitter.html b/papi-dts/variables/__papi_backend_.EventEmitter.html index b0ab4b8ebf..c1de61cd6d 100644 --- a/papi-dts/variables/__papi_backend_.EventEmitter.html +++ b/papi-dts/variables/__papi_backend_.EventEmitter.html @@ -3,4 +3,4 @@ eventEmitter.emit(event) to run the subscriptions. Generally, this EventEmitter should be private, and its event should be public. That way, the emitter is not publicized, but anyone can subscribe to the event.

            -

            Settings

            Member Visibility

            Theme

            Generated using TypeDoc

            \ No newline at end of file +

            Settings

            Member Visibility

            Theme

            Generated using TypeDoc

            \ No newline at end of file diff --git a/papi-dts/variables/__papi_backend_.commands.html b/papi-dts/variables/__papi_backend_.commands.html index c3cf28a9d8..204058e611 100644 --- a/papi-dts/variables/__papi_backend_.commands.html +++ b/papi-dts/variables/__papi_backend_.commands.html @@ -1,4 +1,4 @@ commands | papi-dts

            Variable commandsConst

            commands: typeof "shared/services/command.service"

            The command service allows you to exchange messages with other components in the platform. You can register a command that other services and extensions can send you. You can send commands to other services and extensions that have registered commands.

            -

            Settings

            Member Visibility

            Theme

            Generated using TypeDoc

            \ No newline at end of file +

            Settings

            Member Visibility

            Theme

            Generated using TypeDoc

            \ No newline at end of file diff --git a/papi-dts/variables/__papi_backend_.dataProviders.html b/papi-dts/variables/__papi_backend_.dataProviders.html index acca4388bf..477c251d40 100644 --- a/papi-dts/variables/__papi_backend_.dataProviders.html +++ b/papi-dts/variables/__papi_backend_.dataProviders.html @@ -1,2 +1,2 @@ dataProviders | papi-dts

            Variable dataProvidersConst

            dataProviders: DataProviderService

            Service that allows extensions to send and receive data to/from other extensions

            -

            Settings

            Member Visibility

            Theme

            Generated using TypeDoc

            \ No newline at end of file +

            Settings

            Member Visibility

            Theme

            Generated using TypeDoc

            \ No newline at end of file diff --git a/papi-dts/variables/__papi_backend_.default.html b/papi-dts/variables/__papi_backend_.default.html index 5ff835b0d4..d4535720eb 100644 --- a/papi-dts/variables/__papi_backend_.default.html +++ b/papi-dts/variables/__papi_backend_.default.html @@ -28,4 +28,4 @@
          • webViews: WebViewServiceType

            Service exposing various functions related to using webViews

            WebViews are iframes in the Platform.Bible UI into which extensions load frontend code, either HTML or React components.

            -

            • Settings

            Member Visibility

            Theme

            Generated using TypeDoc

            \ No newline at end of file +

            Settings

            Member Visibility

            Theme

            Generated using TypeDoc

            \ No newline at end of file diff --git a/papi-dts/variables/__papi_backend_.dialogs.html b/papi-dts/variables/__papi_backend_.dialogs.html index ab7eb406e2..5880ff0cbc 100644 --- a/papi-dts/variables/__papi_backend_.dialogs.html +++ b/papi-dts/variables/__papi_backend_.dialogs.html @@ -1,2 +1,2 @@ dialogs | papi-dts

            Variable dialogsConst

            dialogs: DialogService

            Prompt the user for responses with dialogs

            -

            Settings

            Member Visibility

            Theme

            Generated using TypeDoc

            \ No newline at end of file +

            Settings

            Member Visibility

            Theme

            Generated using TypeDoc

            \ No newline at end of file diff --git a/papi-dts/variables/__papi_backend_.internet.html b/papi-dts/variables/__papi_backend_.internet.html index c878c16662..767d095961 100644 --- a/papi-dts/variables/__papi_backend_.internet.html +++ b/papi-dts/variables/__papi_backend_.internet.html @@ -1,2 +1,2 @@ internet | papi-dts

            Variable internetConst

            internet: InternetService

            Service that provides a way to call fetch since the original function is not available

            -

            Settings

            Member Visibility

            Theme

            Generated using TypeDoc

            \ No newline at end of file +

            Settings

            Member Visibility

            Theme

            Generated using TypeDoc

            \ No newline at end of file diff --git a/papi-dts/variables/__papi_backend_.logger.html b/papi-dts/variables/__papi_backend_.logger.html index ef47ef3b2c..f4333e5b5b 100644 --- a/papi-dts/variables/__papi_backend_.logger.html +++ b/papi-dts/variables/__papi_backend_.logger.html @@ -1,2 +1,2 @@ logger | papi-dts

            Variable loggerConst

            logger: MainLogger & {
                default: MainLogger;
            }

            All extensions and services should use this logger to provide a unified output of logs

            -

            Type declaration

            • default: MainLogger

            Settings

            Member Visibility

            Theme

            Generated using TypeDoc

            \ No newline at end of file +

            Type declaration

            • default: MainLogger

            Settings

            Member Visibility

            Theme

            Generated using TypeDoc

            \ No newline at end of file diff --git a/papi-dts/variables/__papi_backend_.network.html b/papi-dts/variables/__papi_backend_.network.html index 628e306ac9..49f1104513 100644 --- a/papi-dts/variables/__papi_backend_.network.html +++ b/papi-dts/variables/__papi_backend_.network.html @@ -1,2 +1,2 @@ network | papi-dts

            Variable networkConst

            network: PapiNetworkService

            Service that provides a way to send and receive network events

            -

            Settings

            Member Visibility

            Theme

            Generated using TypeDoc

            \ No newline at end of file +

            Settings

            Member Visibility

            Theme

            Generated using TypeDoc

            \ No newline at end of file diff --git a/papi-dts/variables/__papi_backend_.projectDataProviders.html b/papi-dts/variables/__papi_backend_.projectDataProviders.html index aae7348f65..cbe4dbd754 100644 --- a/papi-dts/variables/__papi_backend_.projectDataProviders.html +++ b/papi-dts/variables/__papi_backend_.projectDataProviders.html @@ -1,2 +1,2 @@ projectDataProviders | papi-dts

            Variable projectDataProvidersConst

            projectDataProviders: PapiBackendProjectDataProviderService

            Service that registers and gets project data providers

            -

            Settings

            Member Visibility

            Theme

            Generated using TypeDoc

            \ No newline at end of file +

            Settings

            Member Visibility

            Theme

            Generated using TypeDoc

            \ No newline at end of file diff --git a/papi-dts/variables/__papi_backend_.projectLookup.html b/papi-dts/variables/__papi_backend_.projectLookup.html index 2da9e1ebcf..e264a244e4 100644 --- a/papi-dts/variables/__papi_backend_.projectLookup.html +++ b/papi-dts/variables/__papi_backend_.projectLookup.html @@ -1,2 +1,2 @@ projectLookup | papi-dts

            Variable projectLookupConst

            projectLookup: ProjectLookupServiceType

            Provides metadata for projects known by the platform

            -

            Settings

            Member Visibility

            Theme

            Generated using TypeDoc

            \ No newline at end of file +

            Settings

            Member Visibility

            Theme

            Generated using TypeDoc

            \ No newline at end of file diff --git a/papi-dts/variables/__papi_backend_.storage.html b/papi-dts/variables/__papi_backend_.storage.html index 84425baf36..9475e6da20 100644 --- a/papi-dts/variables/__papi_backend_.storage.html +++ b/papi-dts/variables/__papi_backend_.storage.html @@ -1,4 +1,4 @@ storage | papi-dts

            Variable storageConst

            storage: ExtensionStorageService

            This service provides extensions in the extension host the ability to read/write data based on the extension identity and current user (as identified by the OS). This service will not work within the renderer.

            -

            Settings

            Member Visibility

            Theme

            Generated using TypeDoc

            \ No newline at end of file +

            Settings

            Member Visibility

            Theme

            Generated using TypeDoc

            \ No newline at end of file diff --git a/papi-dts/variables/__papi_backend_.utils.html b/papi-dts/variables/__papi_backend_.utils.html index 4a8029dc44..d4d6e7dd48 100644 --- a/papi-dts/variables/__papi_backend_.utils.html +++ b/papi-dts/variables/__papi_backend_.utils.html @@ -1,4 +1,4 @@ utils | papi-dts

            Variable utilsConst

            utils: typeof "shared/utils/papi-util"

            PapiUtil is a collection of functions, objects, and types that are used as helpers in other services. Extensions should not use or rely on anything in papiUtil unless some other service requires it.

            -

            Settings

            Member Visibility

            Theme

            Generated using TypeDoc

            \ No newline at end of file +

            Settings

            Member Visibility

            Theme

            Generated using TypeDoc

            \ No newline at end of file diff --git a/papi-dts/variables/__papi_backend_.webViewProviders.html b/papi-dts/variables/__papi_backend_.webViewProviders.html index a292f7beec..0bbdc916e9 100644 --- a/papi-dts/variables/__papi_backend_.webViewProviders.html +++ b/papi-dts/variables/__papi_backend_.webViewProviders.html @@ -1,2 +1,2 @@ webViewProviders | papi-dts

            Variable webViewProvidersConst

            webViewProviders: PapiWebViewProviderService

            Interface for registering webView providers

            -

            Settings

            Member Visibility

            Theme

            Generated using TypeDoc

            \ No newline at end of file +

            Settings

            Member Visibility

            Theme

            Generated using TypeDoc

            \ No newline at end of file diff --git a/papi-dts/variables/__papi_backend_.webViews.html b/papi-dts/variables/__papi_backend_.webViews.html index 48b5551865..71faf30066 100644 --- a/papi-dts/variables/__papi_backend_.webViews.html +++ b/papi-dts/variables/__papi_backend_.webViews.html @@ -1,4 +1,4 @@ webViews | papi-dts

            Variable webViewsConst

            webViews: WebViewServiceType

            Service exposing various functions related to using webViews

            WebViews are iframes in the Platform.Bible UI into which extensions load frontend code, either HTML or React components.

            -

            Settings

            Member Visibility

            Theme

            Generated using TypeDoc

            \ No newline at end of file +

            Settings

            Member Visibility

            Theme

            Generated using TypeDoc

            \ No newline at end of file diff --git a/papi-dts/variables/__papi_core_.default.html b/papi-dts/variables/__papi_core_.default.html index 085ae48929..1c13ca3635 100644 --- a/papi-dts/variables/__papi_core_.default.html +++ b/papi-dts/variables/__papi_core_.default.html @@ -1,2 +1,2 @@ default | papi-dts

            Variable defaultConst

            default: {}

            Exporting empty object so people don't have to put 'type' in their import statements

            -

            Type declaration

              Settings

              Member Visibility

              Theme

              Generated using TypeDoc

              \ No newline at end of file +

              Type declaration

                Settings

                Member Visibility

                Theme

                Generated using TypeDoc

                \ No newline at end of file diff --git a/papi-dts/variables/__papi_frontend_.EventEmitter.html b/papi-dts/variables/__papi_frontend_.EventEmitter.html index 8d26e2fa80..826681072a 100644 --- a/papi-dts/variables/__papi_frontend_.EventEmitter.html +++ b/papi-dts/variables/__papi_frontend_.EventEmitter.html @@ -3,4 +3,4 @@ eventEmitter.emit(event) to run the subscriptions. Generally, this EventEmitter should be private, and its event should be public. That way, the emitter is not publicized, but anyone can subscribe to the event.

                -

                Settings

                Member Visibility

                Theme

                Generated using TypeDoc

                \ No newline at end of file +

                Settings

                Member Visibility

                Theme

                Generated using TypeDoc

                \ No newline at end of file diff --git a/papi-dts/variables/__papi_frontend_.WebSocket.html b/papi-dts/variables/__papi_frontend_.WebSocket.html index 3a9b98376a..4586c01dd0 100644 --- a/papi-dts/variables/__papi_frontend_.WebSocket.html +++ b/papi-dts/variables/__papi_frontend_.WebSocket.html @@ -2,4 +2,4 @@ better control over internet access. It is isomorphic with the standard WebSocket, so it should act as a drop-in replacement.

                Note that the Node WebSocket implementation is different and not wrapped here.

                -

                Settings

                Member Visibility

                Theme

                Generated using TypeDoc

                \ No newline at end of file +

                Settings

                Member Visibility

                Theme

                Generated using TypeDoc

                \ No newline at end of file diff --git a/papi-dts/variables/__papi_frontend_.XMLHttpRequest.html b/papi-dts/variables/__papi_frontend_.XMLHttpRequest.html index ee674be91e..1cfa1a7f7e 100644 --- a/papi-dts/variables/__papi_frontend_.XMLHttpRequest.html +++ b/papi-dts/variables/__papi_frontend_.XMLHttpRequest.html @@ -2,4 +2,4 @@ provide better control over internet access. It is isomorphic with the standard XMLHttpRequest, so it should act as a drop-in replacement.

                Note that Node doesn't have a native implementation, so this is only for the renderer.

                -

                Settings

                Member Visibility

                Theme

                Generated using TypeDoc

                \ No newline at end of file +

                Settings

                Member Visibility

                Theme

                Generated using TypeDoc

                \ No newline at end of file diff --git a/papi-dts/variables/__papi_frontend_.commands.html b/papi-dts/variables/__papi_frontend_.commands.html index bd3a7d3fe6..43afd35295 100644 --- a/papi-dts/variables/__papi_frontend_.commands.html +++ b/papi-dts/variables/__papi_frontend_.commands.html @@ -1,4 +1,4 @@ commands | papi-dts

                Variable commandsConst

                commands: typeof "shared/services/command.service"

                The command service allows you to exchange messages with other components in the platform. You can register a command that other services and extensions can send you. You can send commands to other services and extensions that have registered commands.

                -

                Settings

                Member Visibility

                Theme

                Generated using TypeDoc

                \ No newline at end of file +

                Settings

                Member Visibility

                Theme

                Generated using TypeDoc

                \ No newline at end of file diff --git a/papi-dts/variables/__papi_frontend_.dataProviders.html b/papi-dts/variables/__papi_frontend_.dataProviders.html index c2578a92c4..dae8aa1ba1 100644 --- a/papi-dts/variables/__papi_frontend_.dataProviders.html +++ b/papi-dts/variables/__papi_frontend_.dataProviders.html @@ -1,2 +1,2 @@ dataProviders | papi-dts

                Variable dataProvidersConst

                dataProviders: DataProviderService

                Service that allows extensions to send and receive data to/from other extensions

                -

                Settings

                Member Visibility

                Theme

                Generated using TypeDoc

                \ No newline at end of file +

                Settings

                Member Visibility

                Theme

                Generated using TypeDoc

                \ No newline at end of file diff --git a/papi-dts/variables/__papi_frontend_.default.html b/papi-dts/variables/__papi_frontend_.default.html index 92351ff404..4cada79745 100644 --- a/papi-dts/variables/__papi_frontend_.default.html +++ b/papi-dts/variables/__papi_frontend_.default.html @@ -30,4 +30,4 @@
              • webViews: WebViewServiceType

                Service exposing various functions related to using webViews

                WebViews are iframes in the Platform.Bible UI into which extensions load frontend code, either HTML or React components.

                -

                • Settings

                Member Visibility

                Theme

                Generated using TypeDoc

                \ No newline at end of file +

                Settings

                Member Visibility

                Theme

                Generated using TypeDoc

                \ No newline at end of file diff --git a/papi-dts/variables/__papi_frontend_.dialogs.html b/papi-dts/variables/__papi_frontend_.dialogs.html index 2dcea0f0e0..6ee4b7cd81 100644 --- a/papi-dts/variables/__papi_frontend_.dialogs.html +++ b/papi-dts/variables/__papi_frontend_.dialogs.html @@ -1,2 +1,2 @@ dialogs | papi-dts

                Variable dialogsConst

                dialogs: DialogService

                Prompt the user for responses with dialogs

                -

                Settings

                Member Visibility

                Theme

                Generated using TypeDoc

                \ No newline at end of file +

                Settings

                Member Visibility

                Theme

                Generated using TypeDoc

                \ No newline at end of file diff --git a/papi-dts/variables/__papi_frontend_.internet.html b/papi-dts/variables/__papi_frontend_.internet.html index 8608232a92..095f245f77 100644 --- a/papi-dts/variables/__papi_frontend_.internet.html +++ b/papi-dts/variables/__papi_frontend_.internet.html @@ -1,2 +1,2 @@ internet | papi-dts

                Variable internetConst

                internet: InternetService

                Service that provides a way to call fetch since the original function is not available

                -

                Settings

                Member Visibility

                Theme

                Generated using TypeDoc

                \ No newline at end of file +

                Settings

                Member Visibility

                Theme

                Generated using TypeDoc

                \ No newline at end of file diff --git a/papi-dts/variables/__papi_frontend_.logger.html b/papi-dts/variables/__papi_frontend_.logger.html index dd27f2d290..467d014375 100644 --- a/papi-dts/variables/__papi_frontend_.logger.html +++ b/papi-dts/variables/__papi_frontend_.logger.html @@ -1,2 +1,2 @@ logger | papi-dts

                Variable loggerConst

                logger: MainLogger & {
                    default: MainLogger;
                }

                All extensions and services should use this logger to provide a unified output of logs

                -

                Type declaration

                • default: MainLogger

                Settings

                Member Visibility

                Theme

                Generated using TypeDoc

                \ No newline at end of file +

                Type declaration

                • default: MainLogger

                Settings

                Member Visibility

                Theme

                Generated using TypeDoc

                \ No newline at end of file diff --git a/papi-dts/variables/__papi_frontend_.network.html b/papi-dts/variables/__papi_frontend_.network.html index 4ba1bc7cd5..c41fc3a9b8 100644 --- a/papi-dts/variables/__papi_frontend_.network.html +++ b/papi-dts/variables/__papi_frontend_.network.html @@ -1,2 +1,2 @@ network | papi-dts

                Variable networkConst

                network: PapiNetworkService

                Service that provides a way to send and receive network events

                -

                Settings

                Member Visibility

                Theme

                Generated using TypeDoc

                \ No newline at end of file +

                Settings

                Member Visibility

                Theme

                Generated using TypeDoc

                \ No newline at end of file diff --git a/papi-dts/variables/__papi_frontend_.projectDataProviders.html b/papi-dts/variables/__papi_frontend_.projectDataProviders.html index 0353880ee5..dc7156238b 100644 --- a/papi-dts/variables/__papi_frontend_.projectDataProviders.html +++ b/papi-dts/variables/__papi_frontend_.projectDataProviders.html @@ -1,2 +1,2 @@ projectDataProviders | papi-dts

                Variable projectDataProvidersConst

                projectDataProviders: PapiFrontendProjectDataProviderService

                Service that registers and gets project data providers

                -

                Settings

                Member Visibility

                Theme

                Generated using TypeDoc

                \ No newline at end of file +

                Settings

                Member Visibility

                Theme

                Generated using TypeDoc

                \ No newline at end of file diff --git a/papi-dts/variables/__papi_frontend_.projectLookup.html b/papi-dts/variables/__papi_frontend_.projectLookup.html index 0d3a44f242..69301c0a4c 100644 --- a/papi-dts/variables/__papi_frontend_.projectLookup.html +++ b/papi-dts/variables/__papi_frontend_.projectLookup.html @@ -1,2 +1,2 @@ projectLookup | papi-dts

                Variable projectLookupConst

                projectLookup: ProjectLookupServiceType

                Provides metadata for projects known by the platform

                -

                Settings

                Member Visibility

                Theme

                Generated using TypeDoc

                \ No newline at end of file +

                Settings

                Member Visibility

                Theme

                Generated using TypeDoc

                \ No newline at end of file diff --git a/papi-dts/variables/__papi_frontend_.react.html b/papi-dts/variables/__papi_frontend_.react.html index 359e22017b..b4dea395e1 100644 --- a/papi-dts/variables/__papi_frontend_.react.html +++ b/papi-dts/variables/__papi_frontend_.react.html @@ -1,2 +1,2 @@ react | papi-dts

                Variable reactConst

                react: typeof "@papi/frontend/react"

                React hooks that enable interacting with the papi in React components more easily.

                -

                Settings

                Member Visibility

                Theme

                Generated using TypeDoc

                \ No newline at end of file +

                Settings

                Member Visibility

                Theme

                Generated using TypeDoc

                \ No newline at end of file diff --git a/papi-dts/variables/__papi_frontend_.settings.html b/papi-dts/variables/__papi_frontend_.settings.html index 568e764dbb..26e6176dab 100644 --- a/papi-dts/variables/__papi_frontend_.settings.html +++ b/papi-dts/variables/__papi_frontend_.settings.html @@ -1,2 +1,2 @@ settings | papi-dts

                Variable settingsConst

                settings: SettingsService

                Service that allows to get and set settings in local storage

                -

                Settings

                Member Visibility

                Theme

                Generated using TypeDoc

                \ No newline at end of file +

                Settings

                Member Visibility

                Theme

                Generated using TypeDoc

                \ No newline at end of file diff --git a/papi-dts/variables/__papi_frontend_.utils.html b/papi-dts/variables/__papi_frontend_.utils.html index 6b3166215a..de0a104c22 100644 --- a/papi-dts/variables/__papi_frontend_.utils.html +++ b/papi-dts/variables/__papi_frontend_.utils.html @@ -1,4 +1,4 @@ utils | papi-dts

                Variable utilsConst

                utils: typeof "shared/utils/papi-util"

                PapiUtil is a collection of functions, objects, and types that are used as helpers in other services. Extensions should not use or rely on anything in papiUtil unless some other service requires it.

                -

                Settings

                Member Visibility

                Theme

                Generated using TypeDoc

                \ No newline at end of file +

                Settings

                Member Visibility

                Theme

                Generated using TypeDoc

                \ No newline at end of file diff --git a/papi-dts/variables/__papi_frontend_.webViews.html b/papi-dts/variables/__papi_frontend_.webViews.html index 21342fec2c..a4640a479f 100644 --- a/papi-dts/variables/__papi_frontend_.webViews.html +++ b/papi-dts/variables/__papi_frontend_.webViews.html @@ -1,4 +1,4 @@ webViews | papi-dts

                Variable webViewsConst

                webViews: WebViewServiceType

                Service exposing various functions related to using webViews

                WebViews are iframes in the Platform.Bible UI into which extensions load frontend code, either HTML or React components.

                -

                Settings

                Member Visibility

                Theme

                Generated using TypeDoc

                \ No newline at end of file +

                Settings

                Member Visibility

                Theme

                Generated using TypeDoc

                \ No newline at end of file diff --git a/papi-dts/variables/_extension_host_services_extension_storage_service_.default.html b/papi-dts/variables/_extension_host_services_extension_storage_service_.default.html index bcac54956c..4de5c106a7 100644 --- a/papi-dts/variables/_extension_host_services_extension_storage_service_.default.html +++ b/papi-dts/variables/_extension_host_services_extension_storage_service_.default.html @@ -1,4 +1,4 @@ default | papi-dts

                Variable defaultConst

                default: ExtensionStorageService

                This service provides extensions in the extension host the ability to read/write data based on the extension identity and current user (as identified by the OS). This service will not work within the renderer.

                -

                Settings

                Member Visibility

                Theme

                Generated using TypeDoc

                \ No newline at end of file +

                Settings

                Member Visibility

                Theme

                Generated using TypeDoc

                \ No newline at end of file diff --git a/papi-dts/variables/_node_services_execution_token_service_.default.html b/papi-dts/variables/_node_services_execution_token_service_.default.html index 608d64c0b9..2fb1757d21 100644 --- a/papi-dts/variables/_node_services_execution_token_service_.default.html +++ b/papi-dts/variables/_node_services_execution_token_service_.default.html @@ -1 +1 @@ -default | papi-dts

                Variable defaultConst

                default: {
                    registerExtension: typeof registerExtension;
                    tokenIsValid: typeof tokenIsValid;
                    unregisterExtension: typeof unregisterExtension;
                }

                Type declaration

                • registerExtension: typeof registerExtension
                • tokenIsValid: typeof tokenIsValid
                • unregisterExtension: typeof unregisterExtension

                Settings

                Member Visibility

                Theme

                Generated using TypeDoc

                \ No newline at end of file +default | papi-dts

                Variable defaultConst

                default: {
                    registerExtension: typeof registerExtension;
                    tokenIsValid: typeof tokenIsValid;
                    unregisterExtension: typeof unregisterExtension;
                }

                Type declaration

                • registerExtension: typeof registerExtension
                • tokenIsValid: typeof tokenIsValid
                • unregisterExtension: typeof unregisterExtension

                Settings

                Member Visibility

                Theme

                Generated using TypeDoc

                \ No newline at end of file diff --git a/papi-dts/variables/_node_utils_util_.FILE_PROTOCOL.html b/papi-dts/variables/_node_utils_util_.FILE_PROTOCOL.html index 004a18778d..c7c15ae154 100644 --- a/papi-dts/variables/_node_utils_util_.FILE_PROTOCOL.html +++ b/papi-dts/variables/_node_utils_util_.FILE_PROTOCOL.html @@ -1 +1 @@ -FILE_PROTOCOL | papi-dts

                Variable FILE_PROTOCOLConst

                FILE_PROTOCOL: string

                Settings

                Member Visibility

                Theme

                Generated using TypeDoc

                \ No newline at end of file +FILE_PROTOCOL | papi-dts

                Variable FILE_PROTOCOLConst

                FILE_PROTOCOL: string

                Settings

                Member Visibility

                Theme

                Generated using TypeDoc

                \ No newline at end of file diff --git a/papi-dts/variables/_node_utils_util_.RESOURCES_PROTOCOL.html b/papi-dts/variables/_node_utils_util_.RESOURCES_PROTOCOL.html index 35cd3d3068..7173cd54c3 100644 --- a/papi-dts/variables/_node_utils_util_.RESOURCES_PROTOCOL.html +++ b/papi-dts/variables/_node_utils_util_.RESOURCES_PROTOCOL.html @@ -1 +1 @@ -RESOURCES_PROTOCOL | papi-dts

                Variable RESOURCES_PROTOCOLConst

                RESOURCES_PROTOCOL: string

                Settings

                Member Visibility

                Theme

                Generated using TypeDoc

                \ No newline at end of file +RESOURCES_PROTOCOL | papi-dts

                Variable RESOURCES_PROTOCOLConst

                RESOURCES_PROTOCOL: string

                Settings

                Member Visibility

                Theme

                Generated using TypeDoc

                \ No newline at end of file diff --git a/papi-dts/variables/_renderer_components_dialogs_dialog_base_data_.default.html b/papi-dts/variables/_renderer_components_dialogs_dialog_base_data_.default.html index 99ac87c266..349c997401 100644 --- a/papi-dts/variables/_renderer_components_dialogs_dialog_base_data_.default.html +++ b/papi-dts/variables/_renderer_components_dialogs_dialog_base_data_.default.html @@ -5,4 +5,4 @@ we would not be able to use the default loadDialog because it would be using a static reference to a nonexistent Component. Instead of inheriting this as a class, any dialog definition can spread this { ...DIALOG_BASE }

                -

                Settings

                Member Visibility

                Theme

                Generated using TypeDoc

                \ No newline at end of file +

                Settings

                Member Visibility

                Theme

                Generated using TypeDoc

                \ No newline at end of file diff --git a/papi-dts/variables/_renderer_components_dialogs_dialog_definition_model_.SELECT_MULTIPLE_PROJECTS_DIALOG_TYPE.html b/papi-dts/variables/_renderer_components_dialogs_dialog_definition_model_.SELECT_MULTIPLE_PROJECTS_DIALOG_TYPE.html index 82c3544f75..89b5274ecb 100644 --- a/papi-dts/variables/_renderer_components_dialogs_dialog_definition_model_.SELECT_MULTIPLE_PROJECTS_DIALOG_TYPE.html +++ b/papi-dts/variables/_renderer_components_dialogs_dialog_definition_model_.SELECT_MULTIPLE_PROJECTS_DIALOG_TYPE.html @@ -1,2 +1,2 @@ SELECT_MULTIPLE_PROJECTS_DIALOG_TYPE | papi-dts

                Variable SELECT_MULTIPLE_PROJECTS_DIALOG_TYPEConst

                SELECT_MULTIPLE_PROJECTS_DIALOG_TYPE: "platform.selectMultipleProjects" = 'platform.selectMultipleProjects'

                The tabType for the select multiple projects dialog in select-multiple-projects.dialog.tsx

                -

                Settings

                Member Visibility

                Theme

                Generated using TypeDoc

                \ No newline at end of file +

                Settings

                Member Visibility

                Theme

                Generated using TypeDoc

                \ No newline at end of file diff --git a/papi-dts/variables/_renderer_components_dialogs_dialog_definition_model_.SELECT_PROJECT_DIALOG_TYPE.html b/papi-dts/variables/_renderer_components_dialogs_dialog_definition_model_.SELECT_PROJECT_DIALOG_TYPE.html index 7c4c9d0c18..6c12ed0d16 100644 --- a/papi-dts/variables/_renderer_components_dialogs_dialog_definition_model_.SELECT_PROJECT_DIALOG_TYPE.html +++ b/papi-dts/variables/_renderer_components_dialogs_dialog_definition_model_.SELECT_PROJECT_DIALOG_TYPE.html @@ -1,2 +1,2 @@ SELECT_PROJECT_DIALOG_TYPE | papi-dts

                Variable SELECT_PROJECT_DIALOG_TYPEConst

                SELECT_PROJECT_DIALOG_TYPE: "platform.selectProject" = 'platform.selectProject'

                The tabType for the select project dialog in select-project.dialog.tsx

                -

                Settings

                Member Visibility

                Theme

                Generated using TypeDoc

                \ No newline at end of file +

                Settings

                Member Visibility

                Theme

                Generated using TypeDoc

                \ No newline at end of file diff --git a/papi-dts/variables/_shared_data_internal_connection_model_.CATEGORY_COMMAND.html b/papi-dts/variables/_shared_data_internal_connection_model_.CATEGORY_COMMAND.html index 71c0b3439c..509e667d6c 100644 --- a/papi-dts/variables/_shared_data_internal_connection_model_.CATEGORY_COMMAND.html +++ b/papi-dts/variables/_shared_data_internal_connection_model_.CATEGORY_COMMAND.html @@ -1,2 +1,2 @@ CATEGORY_COMMAND | papi-dts

                Variable CATEGORY_COMMANDConst

                CATEGORY_COMMAND: "command" = 'command'

                Prefix on requests that indicates that the request is a command

                -

                Settings

                Member Visibility

                Theme

                Generated using TypeDoc

                \ No newline at end of file +

                Settings

                Member Visibility

                Theme

                Generated using TypeDoc

                \ No newline at end of file diff --git a/papi-dts/variables/_shared_data_internal_connection_model_.CLIENT_ID_SERVER.html b/papi-dts/variables/_shared_data_internal_connection_model_.CLIENT_ID_SERVER.html index 9eafbfd162..1ffe8e8c08 100644 --- a/papi-dts/variables/_shared_data_internal_connection_model_.CLIENT_ID_SERVER.html +++ b/papi-dts/variables/_shared_data_internal_connection_model_.CLIENT_ID_SERVER.html @@ -1,2 +1,2 @@ CLIENT_ID_SERVER | papi-dts

                Variable CLIENT_ID_SERVERConst

                CLIENT_ID_SERVER: 0 = 0

                "Client id" for the server

                -

                Settings

                Member Visibility

                Theme

                Generated using TypeDoc

                \ No newline at end of file +

                Settings

                Member Visibility

                Theme

                Generated using TypeDoc

                \ No newline at end of file diff --git a/papi-dts/variables/_shared_data_internal_connection_model_.CLIENT_ID_UNASSIGNED.html b/papi-dts/variables/_shared_data_internal_connection_model_.CLIENT_ID_UNASSIGNED.html index 9854c23135..a71671a8bc 100644 --- a/papi-dts/variables/_shared_data_internal_connection_model_.CLIENT_ID_UNASSIGNED.html +++ b/papi-dts/variables/_shared_data_internal_connection_model_.CLIENT_ID_UNASSIGNED.html @@ -1,2 +1,2 @@ CLIENT_ID_UNASSIGNED | papi-dts

                Variable CLIENT_ID_UNASSIGNEDConst

                CLIENT_ID_UNASSIGNED: -1 = -1

                Represents when the client id has not been assigned by the server

                -

                Settings

                Member Visibility

                Theme

                Generated using TypeDoc

                \ No newline at end of file +

                Settings

                Member Visibility

                Theme

                Generated using TypeDoc

                \ No newline at end of file diff --git a/papi-dts/variables/_shared_data_internal_connection_model_.CONNECTOR_INFO_DISCONNECTED.html b/papi-dts/variables/_shared_data_internal_connection_model_.CONNECTOR_INFO_DISCONNECTED.html index 5991afc4bf..cfe4b87c93 100644 --- a/papi-dts/variables/_shared_data_internal_connection_model_.CONNECTOR_INFO_DISCONNECTED.html +++ b/papi-dts/variables/_shared_data_internal_connection_model_.CONNECTOR_INFO_DISCONNECTED.html @@ -1,2 +1,2 @@ CONNECTOR_INFO_DISCONNECTED | papi-dts

                Variable CONNECTOR_INFO_DISCONNECTEDConst

                CONNECTOR_INFO_DISCONNECTED: Readonly<{
                    clientId: -1;
                }>

                Represents when the connector info has not been populated by the server

                -

                Type declaration

                • clientId: -1

                Settings

                Member Visibility

                Theme

                Generated using TypeDoc

                \ No newline at end of file +

                Type declaration

                • clientId: -1

                Settings

                Member Visibility

                Theme

                Generated using TypeDoc

                \ No newline at end of file diff --git a/papi-dts/variables/_shared_data_network_connector_model_.WEBSOCKET_ATTEMPTS_MAX.html b/papi-dts/variables/_shared_data_network_connector_model_.WEBSOCKET_ATTEMPTS_MAX.html index 773901131a..16300bb0e8 100644 --- a/papi-dts/variables/_shared_data_network_connector_model_.WEBSOCKET_ATTEMPTS_MAX.html +++ b/papi-dts/variables/_shared_data_network_connector_model_.WEBSOCKET_ATTEMPTS_MAX.html @@ -1,2 +1,2 @@ WEBSOCKET_ATTEMPTS_MAX | papi-dts

                Variable WEBSOCKET_ATTEMPTS_MAXConst

                WEBSOCKET_ATTEMPTS_MAX: 5 = 5

                Number of attempts a client will make to connect to the WebSocket server before failing

                -

                Settings

                Member Visibility

                Theme

                Generated using TypeDoc

                \ No newline at end of file +

                Settings

                Member Visibility

                Theme

                Generated using TypeDoc

                \ No newline at end of file diff --git a/papi-dts/variables/_shared_data_network_connector_model_.WEBSOCKET_ATTEMPTS_WAIT.html b/papi-dts/variables/_shared_data_network_connector_model_.WEBSOCKET_ATTEMPTS_WAIT.html index c0a07e2cd7..8aed2c4ffb 100644 --- a/papi-dts/variables/_shared_data_network_connector_model_.WEBSOCKET_ATTEMPTS_WAIT.html +++ b/papi-dts/variables/_shared_data_network_connector_model_.WEBSOCKET_ATTEMPTS_WAIT.html @@ -1,3 +1,3 @@ WEBSOCKET_ATTEMPTS_WAIT | papi-dts

                Variable WEBSOCKET_ATTEMPTS_WAITConst

                WEBSOCKET_ATTEMPTS_WAIT: 1000 = 1000

                Time in ms for the client to wait before attempting to connect to the WebSocket server again after a failure

                -

                Settings

                Member Visibility

                Theme

                Generated using TypeDoc

                \ No newline at end of file +

                Settings

                Member Visibility

                Theme

                Generated using TypeDoc

                \ No newline at end of file diff --git a/papi-dts/variables/_shared_data_network_connector_model_.WEBSOCKET_PORT.html b/papi-dts/variables/_shared_data_network_connector_model_.WEBSOCKET_PORT.html index 900e2c7bca..d3e25243f4 100644 --- a/papi-dts/variables/_shared_data_network_connector_model_.WEBSOCKET_PORT.html +++ b/papi-dts/variables/_shared_data_network_connector_model_.WEBSOCKET_PORT.html @@ -1,2 +1,2 @@ WEBSOCKET_PORT | papi-dts

                Variable WEBSOCKET_PORTConst

                WEBSOCKET_PORT: 8876 = 8876

                Port to use for the webSocket

                -

                Settings

                Member Visibility

                Theme

                Generated using TypeDoc

                \ No newline at end of file +

                Settings

                Member Visibility

                Theme

                Generated using TypeDoc

                \ No newline at end of file diff --git a/papi-dts/variables/_shared_services_data_provider_service_.default.html b/papi-dts/variables/_shared_services_data_provider_service_.default.html index 8935201805..aba5a8842f 100644 --- a/papi-dts/variables/_shared_services_data_provider_service_.default.html +++ b/papi-dts/variables/_shared_services_data_provider_service_.default.html @@ -1,2 +1,2 @@ default | papi-dts

                Variable defaultConst

                default: DataProviderService

                Service that allows extensions to send and receive data to/from other extensions

                -

                Settings

                Member Visibility

                Theme

                Generated using TypeDoc

                \ No newline at end of file +

                Settings

                Member Visibility

                Theme

                Generated using TypeDoc

                \ No newline at end of file diff --git a/papi-dts/variables/_shared_services_dialog_service_.default.html b/papi-dts/variables/_shared_services_dialog_service_.default.html index 7e1e5aa223..dee4a98286 100644 --- a/papi-dts/variables/_shared_services_dialog_service_.default.html +++ b/papi-dts/variables/_shared_services_dialog_service_.default.html @@ -1 +1 @@ -default | papi-dts

                Variable defaultConst

                default: DialogService

                Settings

                Member Visibility

                Theme

                Generated using TypeDoc

                \ No newline at end of file +default | papi-dts

                Variable defaultConst

                default: DialogService

                Settings

                Member Visibility

                Theme

                Generated using TypeDoc

                \ No newline at end of file diff --git a/papi-dts/variables/_shared_services_dialog_service_model_.CATEGORY_DIALOG.html b/papi-dts/variables/_shared_services_dialog_service_model_.CATEGORY_DIALOG.html index dcb986b240..2a6e874fcd 100644 --- a/papi-dts/variables/_shared_services_dialog_service_model_.CATEGORY_DIALOG.html +++ b/papi-dts/variables/_shared_services_dialog_service_model_.CATEGORY_DIALOG.html @@ -1,2 +1,2 @@ CATEGORY_DIALOG | papi-dts

                Variable CATEGORY_DIALOGConst

                CATEGORY_DIALOG: "dialog" = 'dialog'

                Prefix on requests that indicates that the request is related to dialog operations

                -

                Settings

                Member Visibility

                Theme

                Generated using TypeDoc

                \ No newline at end of file +

                Settings

                Member Visibility

                Theme

                Generated using TypeDoc

                \ No newline at end of file diff --git a/papi-dts/variables/_shared_services_internet_service_.default.html b/papi-dts/variables/_shared_services_internet_service_.default.html index fbaf1557f0..0cfb6bafe0 100644 --- a/papi-dts/variables/_shared_services_internet_service_.default.html +++ b/papi-dts/variables/_shared_services_internet_service_.default.html @@ -1,2 +1,2 @@ default | papi-dts

                Variable defaultConst

                default: InternetService

                Service that provides a way to call fetch since the original function is not available

                -

                Settings

                Member Visibility

                Theme

                Generated using TypeDoc

                \ No newline at end of file +

                Settings

                Member Visibility

                Theme

                Generated using TypeDoc

                \ No newline at end of file diff --git a/papi-dts/variables/_shared_services_logger_service_.WARN_TAG.html b/papi-dts/variables/_shared_services_logger_service_.WARN_TAG.html index 1719035dcf..ed2e0f2e22 100644 --- a/papi-dts/variables/_shared_services_logger_service_.WARN_TAG.html +++ b/papi-dts/variables/_shared_services_logger_service_.WARN_TAG.html @@ -1 +1 @@ -WARN_TAG | papi-dts

                Variable WARN_TAGConst

                WARN_TAG: "<WARN>" = '<WARN>'

                Settings

                Member Visibility

                Theme

                Generated using TypeDoc

                \ No newline at end of file +WARN_TAG | papi-dts

                Variable WARN_TAGConst

                WARN_TAG: "<WARN>" = '<WARN>'

                Settings

                Member Visibility

                Theme

                Generated using TypeDoc

                \ No newline at end of file diff --git a/papi-dts/variables/_shared_services_logger_service_.default.html b/papi-dts/variables/_shared_services_logger_service_.default.html index 29b4189d86..1bbae5f06a 100644 --- a/papi-dts/variables/_shared_services_logger_service_.default.html +++ b/papi-dts/variables/_shared_services_logger_service_.default.html @@ -1,2 +1,2 @@ default | papi-dts

                Variable defaultConst

                default: log.MainLogger & {
                    default: log.MainLogger;
                }

                All extensions and services should use this logger to provide a unified output of logs

                -

                Type declaration

                • default: log.MainLogger

                Settings

                Member Visibility

                Theme

                Generated using TypeDoc

                \ No newline at end of file +

                Type declaration

                • default: log.MainLogger

                Settings

                Member Visibility

                Theme

                Generated using TypeDoc

                \ No newline at end of file diff --git a/papi-dts/variables/_shared_services_network_object_service_.default.html b/papi-dts/variables/_shared_services_network_object_service_.default.html index d5a55325a1..dd7efce19e 100644 --- a/papi-dts/variables/_shared_services_network_object_service_.default.html +++ b/papi-dts/variables/_shared_services_network_object_service_.default.html @@ -18,4 +18,4 @@

                When an object is disposed by calling dispose, all functions registered with the onDidDispose event handler will be called. After an object is disposed, calls to its functions will no longer be proxied to the original object.

                -

                Settings

                Member Visibility

                Theme

                Generated using TypeDoc

                \ No newline at end of file +

                Settings

                Member Visibility

                Theme

                Generated using TypeDoc

                \ No newline at end of file diff --git a/papi-dts/variables/_shared_services_network_object_status_service_.default.html b/papi-dts/variables/_shared_services_network_object_status_service_.default.html index 0a40bcc925..2e69ff2198 100644 --- a/papi-dts/variables/_shared_services_network_object_status_service_.default.html +++ b/papi-dts/variables/_shared_services_network_object_status_service_.default.html @@ -1 +1 @@ -default | papi-dts

                Variable defaultConst

                default: NetworkObjectStatusServiceType

                Settings

                Member Visibility

                Theme

                Generated using TypeDoc

                \ No newline at end of file +default | papi-dts

                Variable defaultConst

                default: NetworkObjectStatusServiceType

                Settings

                Member Visibility

                Theme

                Generated using TypeDoc

                \ No newline at end of file diff --git a/papi-dts/variables/_shared_services_network_object_status_service_model_.networkObjectStatusServiceNetworkObjectName.html b/papi-dts/variables/_shared_services_network_object_status_service_model_.networkObjectStatusServiceNetworkObjectName.html index 1ac71e832e..dc2af8c18d 100644 --- a/papi-dts/variables/_shared_services_network_object_status_service_model_.networkObjectStatusServiceNetworkObjectName.html +++ b/papi-dts/variables/_shared_services_network_object_status_service_model_.networkObjectStatusServiceNetworkObjectName.html @@ -1 +1 @@ -networkObjectStatusServiceNetworkObjectName | papi-dts

                Variable networkObjectStatusServiceNetworkObjectNameConst

                networkObjectStatusServiceNetworkObjectName: "NetworkObjectStatusService" = 'NetworkObjectStatusService'

                Settings

                Member Visibility

                Theme

                Generated using TypeDoc

                \ No newline at end of file +networkObjectStatusServiceNetworkObjectName | papi-dts

                Variable networkObjectStatusServiceNetworkObjectNameConst

                networkObjectStatusServiceNetworkObjectName: "NetworkObjectStatusService" = 'NetworkObjectStatusService'

                Settings

                Member Visibility

                Theme

                Generated using TypeDoc

                \ No newline at end of file diff --git a/papi-dts/variables/_shared_services_network_service_.papiNetworkService-1.html b/papi-dts/variables/_shared_services_network_service_.papiNetworkService-1.html index aab666afa8..045e3a9a2c 100644 --- a/papi-dts/variables/_shared_services_network_service_.papiNetworkService-1.html +++ b/papi-dts/variables/_shared_services_network_service_.papiNetworkService-1.html @@ -1,2 +1,2 @@ papiNetworkService | papi-dts

                Variable papiNetworkServiceConst

                papiNetworkService: PapiNetworkService

                Service that provides a way to send and receive network events

                -

                Settings

                Member Visibility

                Theme

                Generated using TypeDoc

                \ No newline at end of file +

                Settings

                Member Visibility

                Theme

                Generated using TypeDoc

                \ No newline at end of file diff --git a/papi-dts/variables/_shared_services_project_data_provider_service_.papiBackendProjectDataProviderService-1.html b/papi-dts/variables/_shared_services_project_data_provider_service_.papiBackendProjectDataProviderService-1.html index cec3ccd19f..43f77ba237 100644 --- a/papi-dts/variables/_shared_services_project_data_provider_service_.papiBackendProjectDataProviderService-1.html +++ b/papi-dts/variables/_shared_services_project_data_provider_service_.papiBackendProjectDataProviderService-1.html @@ -1,2 +1,2 @@ papiBackendProjectDataProviderService | papi-dts

                Variable papiBackendProjectDataProviderServiceConst

                papiBackendProjectDataProviderService: PapiBackendProjectDataProviderService

                Service that registers and gets project data providers

                -

                Settings

                Member Visibility

                Theme

                Generated using TypeDoc

                \ No newline at end of file +

                Settings

                Member Visibility

                Theme

                Generated using TypeDoc

                \ No newline at end of file diff --git a/papi-dts/variables/_shared_services_project_data_provider_service_.papiFrontendProjectDataProviderService-1.html b/papi-dts/variables/_shared_services_project_data_provider_service_.papiFrontendProjectDataProviderService-1.html index a819b463ca..21ff582a77 100644 --- a/papi-dts/variables/_shared_services_project_data_provider_service_.papiFrontendProjectDataProviderService-1.html +++ b/papi-dts/variables/_shared_services_project_data_provider_service_.papiFrontendProjectDataProviderService-1.html @@ -1,2 +1,2 @@ papiFrontendProjectDataProviderService | papi-dts

                Variable papiFrontendProjectDataProviderServiceConst

                papiFrontendProjectDataProviderService: {
                    get: typeof get;
                }

                Service that gets project data providers

                -

                Type declaration

                • get: typeof get

                Settings

                Member Visibility

                Theme

                Generated using TypeDoc

                \ No newline at end of file +

                Type declaration

                • get: typeof get

                Settings

                Member Visibility

                Theme

                Generated using TypeDoc

                \ No newline at end of file diff --git a/papi-dts/variables/_shared_services_project_lookup_service_.default.html b/papi-dts/variables/_shared_services_project_lookup_service_.default.html index 9b630bca18..9d6ae2c47a 100644 --- a/papi-dts/variables/_shared_services_project_lookup_service_.default.html +++ b/papi-dts/variables/_shared_services_project_lookup_service_.default.html @@ -1 +1 @@ -default | papi-dts

                Variable defaultConst

                default: ProjectLookupServiceType

                Settings

                Member Visibility

                Theme

                Generated using TypeDoc

                \ No newline at end of file +default | papi-dts

                Variable defaultConst

                default: ProjectLookupServiceType

                Settings

                Member Visibility

                Theme

                Generated using TypeDoc

                \ No newline at end of file diff --git a/papi-dts/variables/_shared_services_project_lookup_service_model_.projectLookupServiceNetworkObjectName.html b/papi-dts/variables/_shared_services_project_lookup_service_model_.projectLookupServiceNetworkObjectName.html index d8706e8bcc..799bc3b876 100644 --- a/papi-dts/variables/_shared_services_project_lookup_service_model_.projectLookupServiceNetworkObjectName.html +++ b/papi-dts/variables/_shared_services_project_lookup_service_model_.projectLookupServiceNetworkObjectName.html @@ -1 +1 @@ -projectLookupServiceNetworkObjectName | papi-dts

                Variable projectLookupServiceNetworkObjectNameConst

                projectLookupServiceNetworkObjectName: "ProjectLookupService" = 'ProjectLookupService'

                Settings

                Member Visibility

                Theme

                Generated using TypeDoc

                \ No newline at end of file +projectLookupServiceNetworkObjectName | papi-dts

                Variable projectLookupServiceNetworkObjectNameConst

                projectLookupServiceNetworkObjectName: "ProjectLookupService" = 'ProjectLookupService'

                Settings

                Member Visibility

                Theme

                Generated using TypeDoc

                \ No newline at end of file diff --git a/papi-dts/variables/_shared_services_settings_service_.default.html b/papi-dts/variables/_shared_services_settings_service_.default.html index e76ddd734b..c634846752 100644 --- a/papi-dts/variables/_shared_services_settings_service_.default.html +++ b/papi-dts/variables/_shared_services_settings_service_.default.html @@ -1,2 +1,2 @@ default | papi-dts

                Variable defaultConst

                default: SettingsService

                Service that allows to get and set settings in local storage

                -

                Settings

                Member Visibility

                Theme

                Generated using TypeDoc

                \ No newline at end of file +

                Settings

                Member Visibility

                Theme

                Generated using TypeDoc

                \ No newline at end of file diff --git a/papi-dts/variables/_shared_services_web_view_provider_service_.default.html b/papi-dts/variables/_shared_services_web_view_provider_service_.default.html index 56e35ac78a..cf5fa7eca2 100644 --- a/papi-dts/variables/_shared_services_web_view_provider_service_.default.html +++ b/papi-dts/variables/_shared_services_web_view_provider_service_.default.html @@ -1 +1 @@ -default | papi-dts

                Variable defaultConst

                default: WebViewProviderService

                Settings

                Member Visibility

                Theme

                Generated using TypeDoc

                \ No newline at end of file +default | papi-dts

                Variable defaultConst

                default: WebViewProviderService

                Settings

                Member Visibility

                Theme

                Generated using TypeDoc

                \ No newline at end of file diff --git a/papi-dts/variables/_shared_services_web_view_provider_service_.papiWebViewProviderService-1.html b/papi-dts/variables/_shared_services_web_view_provider_service_.papiWebViewProviderService-1.html index c4ea4e0f51..78f3d0af8c 100644 --- a/papi-dts/variables/_shared_services_web_view_provider_service_.papiWebViewProviderService-1.html +++ b/papi-dts/variables/_shared_services_web_view_provider_service_.papiWebViewProviderService-1.html @@ -1,2 +1,2 @@ papiWebViewProviderService | papi-dts

                Variable papiWebViewProviderServiceConst

                papiWebViewProviderService: PapiWebViewProviderService

                Interface for registering webView providers

                -

                Settings

                Member Visibility

                Theme

                Generated using TypeDoc

                \ No newline at end of file +

                Settings

                Member Visibility

                Theme

                Generated using TypeDoc

                \ No newline at end of file diff --git a/papi-dts/variables/_shared_services_web_view_service_.default.html b/papi-dts/variables/_shared_services_web_view_service_.default.html index 4224058a64..05c4f8f1dd 100644 --- a/papi-dts/variables/_shared_services_web_view_service_.default.html +++ b/papi-dts/variables/_shared_services_web_view_service_.default.html @@ -1 +1 @@ -default | papi-dts

                Variable defaultConst

                default: WebViewServiceType

                Settings

                Member Visibility

                Theme

                Generated using TypeDoc

                \ No newline at end of file +default | papi-dts

                Variable defaultConst

                default: WebViewServiceType

                Settings

                Member Visibility

                Theme

                Generated using TypeDoc

                \ No newline at end of file diff --git a/papi-dts/variables/_shared_services_web_view_service_model_.EVENT_NAME_ON_DID_ADD_WEB_VIEW.html b/papi-dts/variables/_shared_services_web_view_service_model_.EVENT_NAME_ON_DID_ADD_WEB_VIEW.html index bbf935f36a..e2b1caa720 100644 --- a/papi-dts/variables/_shared_services_web_view_service_model_.EVENT_NAME_ON_DID_ADD_WEB_VIEW.html +++ b/papi-dts/variables/_shared_services_web_view_service_model_.EVENT_NAME_ON_DID_ADD_WEB_VIEW.html @@ -1,2 +1,2 @@ EVENT_NAME_ON_DID_ADD_WEB_VIEW | papi-dts

                Variable EVENT_NAME_ON_DID_ADD_WEB_VIEWConst

                EVENT_NAME_ON_DID_ADD_WEB_VIEW: `${string}:${string}`

                Name to use when creating a network event that is fired when webViews are created

                -

                Settings

                Member Visibility

                Theme

                Generated using TypeDoc

                \ No newline at end of file +

                Settings

                Member Visibility

                Theme

                Generated using TypeDoc

                \ No newline at end of file diff --git a/papi-dts/variables/_shared_services_web_view_service_model_.NETWORK_OBJECT_NAME_WEB_VIEW_SERVICE.html b/papi-dts/variables/_shared_services_web_view_service_model_.NETWORK_OBJECT_NAME_WEB_VIEW_SERVICE.html index 65d98c8343..a71c181947 100644 --- a/papi-dts/variables/_shared_services_web_view_service_model_.NETWORK_OBJECT_NAME_WEB_VIEW_SERVICE.html +++ b/papi-dts/variables/_shared_services_web_view_service_model_.NETWORK_OBJECT_NAME_WEB_VIEW_SERVICE.html @@ -1 +1 @@ -NETWORK_OBJECT_NAME_WEB_VIEW_SERVICE | papi-dts

                Variable NETWORK_OBJECT_NAME_WEB_VIEW_SERVICEConst

                NETWORK_OBJECT_NAME_WEB_VIEW_SERVICE: "WebViewService" = 'WebViewService'

                Settings

                Member Visibility

                Theme

                Generated using TypeDoc

                \ No newline at end of file +NETWORK_OBJECT_NAME_WEB_VIEW_SERVICE | papi-dts

                Variable NETWORK_OBJECT_NAME_WEB_VIEW_SERVICEConst

                NETWORK_OBJECT_NAME_WEB_VIEW_SERVICE: "WebViewService" = 'WebViewService'

                Settings

                Member Visibility

                Theme

                Generated using TypeDoc

                \ No newline at end of file diff --git a/papi-dts/variables/_shared_utils_papi_util_.MODULE_SIMILAR_APIS.html b/papi-dts/variables/_shared_utils_papi_util_.MODULE_SIMILAR_APIS.html index 3ea1310b9b..62673a672a 100644 --- a/papi-dts/variables/_shared_utils_papi_util_.MODULE_SIMILAR_APIS.html +++ b/papi-dts/variables/_shared_utils_papi_util_.MODULE_SIMILAR_APIS.html @@ -1,3 +1,3 @@ MODULE_SIMILAR_APIS | papi-dts

                Variable MODULE_SIMILAR_APISConst

                MODULE_SIMILAR_APIS: Readonly<{
                    [moduleName: string]: string | {
                        [process in ProcessType | "default"]?: string
                    } | undefined;
                }>

                Modules that someone might try to require in their extensions that we have similar apis for. When an extension requires these modules, an error throws that lets them know about our similar api.

                -

                Type declaration

                • [moduleName: string]: string | {
                      [process in ProcessType | "default"]?: string
                  } | undefined

                Settings

                Member Visibility

                Theme

                Generated using TypeDoc

                \ No newline at end of file +

                Type declaration

                • [moduleName: string]: string | {
                      [process in ProcessType | "default"]?: string
                  } | undefined

                Settings

                Member Visibility

                Theme

                Generated using TypeDoc

                \ No newline at end of file diff --git a/papi-dts/variables/_shared_utils_papi_util_.REQUEST_TYPE_SEPARATOR.html b/papi-dts/variables/_shared_utils_papi_util_.REQUEST_TYPE_SEPARATOR.html index 50a44e31e1..22f17b3976 100644 --- a/papi-dts/variables/_shared_utils_papi_util_.REQUEST_TYPE_SEPARATOR.html +++ b/papi-dts/variables/_shared_utils_papi_util_.REQUEST_TYPE_SEPARATOR.html @@ -1,2 +1,2 @@ REQUEST_TYPE_SEPARATOR | papi-dts

                Variable REQUEST_TYPE_SEPARATORConst

                REQUEST_TYPE_SEPARATOR: ":" = ':'

                Separator between parts of a serialized request

                -

                Settings

                Member Visibility

                Theme

                Generated using TypeDoc

                \ No newline at end of file +

                Settings

                Member Visibility

                Theme

                Generated using TypeDoc

                \ No newline at end of file diff --git a/papi-dts/variables/isPackaged.html b/papi-dts/variables/isPackaged.html index 5eacd9b413..c1eaa674e6 100644 --- a/papi-dts/variables/isPackaged.html +++ b/papi-dts/variables/isPackaged.html @@ -1,2 +1,2 @@ isPackaged | papi-dts

                Variable isPackaged

                isPackaged: boolean

                Whether this process is packaged or running from sources

                -

                Settings

                Member Visibility

                Theme

                Generated using TypeDoc

                \ No newline at end of file +

                Settings

                Member Visibility

                Theme

                Generated using TypeDoc

                \ No newline at end of file diff --git a/papi-dts/variables/logLevel.html b/papi-dts/variables/logLevel.html index 3fe534bace..13ad172703 100644 --- a/papi-dts/variables/logLevel.html +++ b/papi-dts/variables/logLevel.html @@ -1,2 +1,2 @@ logLevel | papi-dts

                Variable logLevel

                logLevel: LogLevel

                How much logging should be recorded. Defaults to 'debug' if not packaged, 'info' if packaged

                -

                Settings

                Member Visibility

                Theme

                Generated using TypeDoc

                \ No newline at end of file +

                Settings

                Member Visibility

                Theme

                Generated using TypeDoc

                \ No newline at end of file diff --git a/papi-dts/variables/processType.html b/papi-dts/variables/processType.html index 7a0fdb30ca..f5566f5fef 100644 --- a/papi-dts/variables/processType.html +++ b/papi-dts/variables/processType.html @@ -1,2 +1,2 @@ processType | papi-dts

                Variable processType

                processType: ProcessType

                Type of process this is. Helps with running specific code based on which process you're in

                -

                Settings

                Member Visibility

                Theme

                Generated using TypeDoc

                \ No newline at end of file +

                Settings

                Member Visibility

                Theme

                Generated using TypeDoc

                \ No newline at end of file diff --git a/papi-dts/variables/resourcesPath.html b/papi-dts/variables/resourcesPath.html index 12f128ce7e..f643cd0920 100644 --- a/papi-dts/variables/resourcesPath.html +++ b/papi-dts/variables/resourcesPath.html @@ -1,3 +1,3 @@ resourcesPath | papi-dts

                Variable resourcesPath

                resourcesPath: string

                Path to the app's resources directory. This is a string representation of the resources uri on frontend

                -

                Settings

                Member Visibility

                Theme

                Generated using TypeDoc

                \ No newline at end of file +

                Settings

                Member Visibility

                Theme

                Generated using TypeDoc

                \ No newline at end of file