diff --git a/papi-components/enums/LabelPosition.html b/papi-components/enums/LabelPosition.html index d830a6ae26..7687f275bb 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 25b32a948a..53e7401fdc 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 9ca18e123f..9b6324fa09 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 02f89e6ceb..cb2593b7da 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 4fd3ac26f1..edf6fbafb3 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 a78161ad11..ba879af917 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 ecdd670c87..c1d3bf199b 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 7927f5e3a5..b6f3ac08df 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 67920c7fdf..a352731520 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 9b5dd8150b..44092608ea 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 9b9274153e..a4f7c74a55 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 540ae1ee67..027ba76daa 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 e6c8df9d72..bef54eb877 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 e75bfbb169..764e6ab513 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 55a8685243..9afd969b30 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 d93464a85e..fbb3bd69b7 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 595ab7d396..b89b7d0bcb 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 bc4c22b60d..c3c5411b6b 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 067f47c08e..f1901aeb21 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 741b30a4f1..576b84e0a0 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 0a0a4286e9..07194ab61f 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 5b232bebfa..8f887ca970 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 09c7a88277..81613c4b31 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 92098753d9..bb42f87f42 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 52ce278b1f..ddf2d1b4a3 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 a3be5bc25f..a0ee4221e7 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 34fe7db14b..9a5cd202e3 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 a586846c27..dccaa45269 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 66547c1e25..aafacf574a 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 1c1b8d4790..b2dfe95d7a 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 73baf79fdb..7126758695 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 d7062853be..9d7201025e 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 41c94efec3..ebcb4191ac 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 842bd880a6..e78992c5fb 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 492b0c5f27..4676a02e98 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 b0537472c3..62966bc22e 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 f067609f96..b685977c9d 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 e1aa14d8e2..a4a974414c 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 3600b8d21b..0e20e20dcd 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 423284dcc1..c3d8cf192f 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 0237700f0e..376109cf4d 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 d570305a66..9c5632d42d 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 2245214a7b..47ac0e7c6c 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 1532e26105..377ce83d21 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 dd1fc10619..5069406c29 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 d1d7176614..31888284ab 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 f0182ac9ed..1886d3e3af 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 24a796bdcb..e122776616 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 5dcae97710..b4e538bb54 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 927523f192..70e044809c 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 3da7e275df..016e3014b7 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 0363fec7a8..ce3cc3f4b0 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 54ff486eb0..23bd957fad 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 01efa887dd..4c2a5382ff 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 0e0f0e4243..a7a4098ddb 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 7de3564b8a..e5691358c6 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 bad01c8636..121511c8e7 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 92f455f2e0..fb1a0fc953 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 6b6cae921b..af5b6fbd23 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 ed066ba04f..41e350c655 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 b98b936d67..bdd7a6ab22 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 a158ddefd9..eecf681bea 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 2474bb67e6..bd07e11b10 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 9edcc43b97..b088f50569 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 c6701474e4..3b8850ba83 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 ae5c2d2bc0..97a8c43b63 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 d28021edfe..a1b142aaeb 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 6016f824d5..1981d591eb 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 40640368a2..ea082ce489 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 5d99435373..fae89f3802 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 3448cf670c..2d322af578 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 b11bb3724f..27468241f8 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 f3df751d48..79b049ca84 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 d9603e313b..e10334a90f 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 35ce27f4d2..16130d83f3 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 @@ -23,4 +23,4 @@
  • isShowingDialog - whether this dialog is showing (the callback has been run but has not responded)
    • -

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ 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 bb021e9187..389d1f500d 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 4cbd39c227..e97aca3d9d 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 8dc04d906a..ad58233e3d 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 @@

    WARNING: If provided, MUST BE STABLE - const or wrapped in useState, useMemo, etc. The reference must not be updated every render

    ï¼ 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 126b590794..3b172c7e94 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 | "shared/models/data-provider.interface".default<ProjectDataTypes[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 53a0c59ab0..09b85bc9e5 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 @@ -16,4 +16,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 849bb82be2..5d115ff540 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 fbe9890e46..130298cd55 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 f91dc8418c..36aaade5bb 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 493e7710fb..72349b2110 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 172eff1ef6..c1f4aff239 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 f69dc014f8..2be1fb3200 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 3e2ca8cdda..d504a64557 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 a055db2738..3d1ac4a73e 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 f931fdcd31..9e8a930221 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 53cc8bfaab..9b75b82e8d 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 f4adb3cb96..d3963f599b 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 32a11b30b2..1654d9a2b5 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 9c2200d91f..7b0302eac7 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 33b9295808..1d2853fed0 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 667babef7c..a689701f70 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 a34502835a..378fe6d177 100644 --- a/papi-dts/functions/_shared_services_data_provider_service_.registerEngineByType.html +++ b/papi-dts/functions/_shared_services_data_provider_service_.registerEngineByType.html @@ -6,4 +6,4 @@

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

    Local data provider object that represents a remote data provider

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

    -

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ 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 5d17e1feee..c305c646b0 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 0ed786d158..052e05f131 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 c8a05ff559..5c97e00011 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 7846e07c99..ade52fb322 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 33e85be7f0..01d56e2286 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 111622257d..63aa14dd00 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 58365d568f..f7dca0270b 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 4943efda09..899c20385a 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 72005a806c..c32b245b45 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 cdc4b8491d..d293a66db1 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 27ca3f5e6f..44d92b9fcf 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 b5bf0bad45..336ac16268 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 ef5b91cf7f..2a63ef521b 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 912b9eb49d..52ffc4e780 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 8846727090..d4d9df7c06 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<ProjectDataProvider[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 8ecdec3461..2bbc0ab020 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 fca2c9b011..127c915298 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 b979d6308e..c831f7c7c4 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 881d543f75..9853dbdd71 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 f4876956d7..1234b7f545 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 f29333bfcc..c4574a9f19 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 68a44385b7..80f1be809b 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 8888652d7e..cde22bc62f 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 1ff2200c9d..1c1a6e1f57 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 f1768d51d9..a376587b76 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 b7e1b58d25..a14f42b216 100644 --- a/papi-dts/functions/_shared_utils_papi_util_.deserialize.html +++ b/papi-dts/functions/_shared_utils_papi_util_.deserialize.html @@ -9,4 +9,4 @@

    Parameters

    Returns any

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Returns any

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/papi-dts/functions/_shared_utils_papi_util_.deserializeRequestType.html b/papi-dts/functions/_shared_utils_papi_util_.deserializeRequestType.html index 444935c79d..f23048a01e 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 6ff345dbd2..1d206dbf86 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 7d11cbcac8..9a30c954f5 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 47ade9a2b8..d790016de3 100644 --- a/papi-dts/functions/_shared_utils_papi_util_.isSerializable.html +++ b/papi-dts/functions/_shared_utils_papi_util_.isSerializable.html @@ -14,4 +14,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 ea179464ba..914172bb94 100644 --- a/papi-dts/functions/_shared_utils_papi_util_.serialize.html +++ b/papi-dts/functions/_shared_utils_papi_util_.serialize.html @@ -14,4 +14,4 @@
  • Optional space: string | number

    Adds indentation, white space, and line break characters to the return-value JSON text to make it easier to read. See the space parameter of JSON.stringify for more details.

    -

    • Returns string

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Returns string

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/papi-dts/functions/_shared_utils_papi_util_.serializeRequestType.html b/papi-dts/functions/_shared_utils_papi_util_.serializeRequestType.html index c3118b28ec..954dfdda7d 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 298af96396..6cdf5a77d9 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 364b5b526a..2606d4165f 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 c373bf47bd..02ea2542c8 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 8387fc1047..f791c331c3 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 ff53ec9aa2..3c31ea735f 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 d8019ed697..9396cb5907 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 4489356899..3f37bedfd2 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 904c15a83a..5bb3290806 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 f84b6c51c3..f9934be18a 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 84784bebdf..6bfb8ee4a1 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 c194758c05..8e92db4597 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 c256148e10..60b603c195 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 f1794677e0..30e0ab4a77 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 5c6b1c603b..85add83596 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 7947e28580..ae8ee5aaa8 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 21cf7874ab..9b2b459b73 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 a7e2895453..a0510444ec 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 fe1ec55870..4259c4016a 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 dc6331d5b9..547a000b3c 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 174daf60d4..204ccf429f 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_.ProjectDataTypes.html b/papi-dts/interfaces/_papi_shared_types_.ProjectDataTypes.html index 4d5cf4de7b..cfad9fc2bb 100644 --- a/papi-dts/interfaces/_papi_shared_types_.ProjectDataTypes.html +++ b/papi-dts/interfaces/_papi_shared_types_.ProjectDataTypes.html @@ -3,6 +3,6 @@ all project data types should extend MandatoryProjectDataTypes like the following example.

    Example

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

      export interface ProjectDataTypes {
        MyExtensionProjectTypeName: MyProjectDataTypes;
      }
    }
    -
    interface ProjectDataTypes {
        NotesOnly: NotesOnlyProjectDataTypes;
        placeholder: MandatoryProjectDataType;
    }

    Properties

    NotesOnly +
    interface ProjectDataTypes {
        NotesOnly: NotesOnlyProjectDataTypes;
        placeholder: MandatoryProjectDataType;
    }

    Properties

    NotesOnly placeholder -

    Properties

    NotesOnly

    NotesOnly: NotesOnlyProjectDataTypes

    placeholder

    placeholder: MandatoryProjectDataType

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file +

    Properties

    NotesOnly

    NotesOnly: NotesOnlyProjectDataTypes

    placeholder

    placeholder: 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 a12fec78ba..33a6444315 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 ac21cc3189..75e2587268 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 b17e294938..f6fe1c9201 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 b5137634c3..9f247ffa04 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 0321ec939c..52e4ab4044 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 2c1225a08b..6df5bb7992 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 adf04cf2d9..c599721910 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 b8add435ae..10822bcf23 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 1a17178dcf..d159eea79d 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 6ba40770fb..463b702171 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 d629656614..e9fa955b71 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 d6d39e7324..2d0fabee7d 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 460c012bd6..a7e9b05a7a 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) => 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) => 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) => Promise<DisposableDataProviders[DataProviderName]>)

    Type declaration

      • <DataProviderName>(providerName, dataProviderEngine): 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) => 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 223a5ac689..3ab0daaa18 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 6d206a929a..dcd1c7d227 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 1051c8a56b..e76a70b95b 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 d8e9579ad7..ac58c480e0 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 6a20320ad5..e639e98997 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 35b472ac15..ccd4f6347f 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 f8f90ce016..8b909916cb 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<ProjectDataProvider[ProjectType]>);
        registerProjectDataProviderEngineFactory: (<ProjectType>(projectType, pdpEngineFactory) => Promise<Dispose>);
    }

    Properties

    get +PapiBackendProjectDataProviderService | papi-dts

    Interface PapiBackendProjectDataProviderService

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

    Properties

    get registerProjectDataProviderEngineFactory

    Properties

    get

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

    Type declaration

      • <ProjectType>(projectType, projectId): Promise<ProjectDataProvider[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<ProjectDataProvider[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 4e9fcdfa0a..ac8112c85a 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<ProjectDataProvider[ProjectType]>);
    }

    Properties

    get +PapiFrontendProjectDataProviderService | papi-dts

    Interface PapiFrontendProjectDataProviderService

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

    Properties

    get

    Properties

    get

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

    Type declaration

      • <ProjectType>(projectType, projectId): Promise<ProjectDataProvider[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<ProjectDataProvider[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 e51c8f8f83..bf883f6777 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 eff6ac26bd..9b89be26df 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 bcb5fb57f6..cfa905b0f1 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 89e091d066..8b73b67272 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 56a8a8c99f..8a3fc40c5b 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 ec4b5abf75..4c68aaec0d 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 2009e7e83d..df3b66180a 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 e6ba2a58fc..45f9ae2607 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 31a5682d50..b6c49bc368 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 0bb6cb6a71..51b42ef21c 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 5cb1edebfa..eccd0191c8 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 6c8ea14ec0..1fe25aed89 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 853665a558..35d7693a44 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 454867999f..830c71278c 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 5923e7c2f3..05c41d8a9f 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 8c82882b37..352ab5a284 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 2be2e5d1e4..34ffef2055 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 6759c68a25..4922db8633 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 d1f87d125f..7b5e63ba75 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 9e5e4ddc9d..54e9c2d123 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 35d27a84a2..17cfece084 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 775170a20c..79629b8362 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 011d58fc70..ed154d01d2 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 12f0e4d7d9..792a2d1a8e 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 9c5158e575..9aaba881e2 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 ProjectDataTypes 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 fd8ac8bb36..f628da0c6d 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 898be3247e..b25ac27ec0 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 3e841686ec..6810264fed 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 552e103ecb..a3306a4234 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 facc4875c0..b70f339b01 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 394f94d6c4..053640fcd6 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 b0142e6aff..52eda7a9ce 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 56143c46b8..e6d30cc5e7 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 b3a2a4b9ef..99064af860 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,2 +1,2 @@ -"renderer/hooks/papi-hooks/use-dialog-callback.hook" | papi-dts

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

    Index

    Functions

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

    Namespace "renderer/hooks/papi-hooks/use-dialog-callback.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_async_hook_.html b/papi-dts/modules/_renderer_hooks_papi_hooks_use_event_async_hook_.html index 0ca0bffdc8..edfe3a818c 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 b0c56b4911..4737838115 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 862429f521..6f5783469b 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 88e8306d02..d714276be9 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 f79bf67e48..de51ddb776 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,2 +1,2 @@ -"renderer/hooks/papi-hooks/use-promise.hook" | papi-dts

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

    Index

    Functions

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

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

    Index

    Functions

    default

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/papi-dts/modules/_renderer_hooks_papi_hooks_use_setting_hook_.html b/papi-dts/modules/_renderer_hooks_papi_hooks_use_setting_hook_.html index f6ce2e49a5..4d84c471f0 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 6e1ea4c0ef..6a63f3873e 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 80db71f66f..44c54319a3 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 09b2502161..a99e11b331 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 e18a774edc..8f71852fd3 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 82fb54d590..7422687448 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 ff91184eef..12b8833581 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 e534900057..85e08fd3f8 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 cac1700458..bf693c36d7 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 7d9a154b0e..17eb743c78 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 cc92253f45..956360dbe3 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 859d9e57e3..e2fcc64363 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 fe64275dca..dbbbd2362f 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 5cadfca9ca..182c481c26 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 07f5c3c809..61a09a7707 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 bb180e6eea..3119ce4a69 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 7364bf4d69..7dfd8c8f1c 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 ce35a241a4..a9b50bf7c7 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 6613a04f72..798180100f 100644 --- a/papi-dts/modules/_shared_models_project_data_provider_engine_model_.html +++ b/papi-dts/modules/_shared_models_project_data_provider_engine_model_.html @@ -1,4 +1,4 @@ -"shared/models/project-data-provider-engine.model" | papi-dts

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

    Index

    Interfaces

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

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

    Index

    Interfaces

    ProjectDataProviderEngineFactory

    Type Aliases

    ProjectDataProvider 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 ca0246d387..f19f9f7664 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 d86506c5ab..ab2eac083c 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 839bc6acba..a7ab14c3a2 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 c9f8b8f98b..3cce221a3a 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 a6ce922ad4..245bb762d7 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 356bea5df5..33bba52496 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 7fd4d50984..36d635ebae 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 8eb19c8ce9..e91a7bec66 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 a186f86511..24aa255310 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 81e5d7b7d8..f70622e55f 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 9f9a09eb7b..fd39fa9b0f 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 735eee7443..e3b1d70413 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 91c8a195d4..4d2cbda88d 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 ce5d7243c6..6374973799 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 062f15063b..2552309104 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 221a27e5ef..40378a5eb4 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 5618153d4e..132d808cdf 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 1e14a4f3c3..57dcd36974 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 82d959680c..1270933285 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 b7ee5eb543..831ba353ef 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 a1db7925d4..85670fc7af 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 3aec63d62a..8c746e7221 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 9684db2056..47f383f7e4 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 2383c63136..c3a1f26e14 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 d4c905737a..0d2565ce33 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 741d7146c7..31ea9c2522 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 fe1bab3a56..b50c862529 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 20a7ed9ed0..1070c40ab6 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 67b565f4df..9e29a82fdf 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 c184f06132..fe1409dd7e 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 6347d54008..c03d06dc3b 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 ed497f9c7d..a462c36b9a 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 1eb1ef6b20..8d5bc967e2 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 54eaefd6b5..18cf152d55 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 910f67f86a..4d2f13bbcc 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 512c5ffe7d..7b302e7698 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 a7939c4038..f8f66aa1f8 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 ca55d2a17c..963a93bdf2 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 aebca4da66..6f492cfe46 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 d45faef633..d3a326f6b9 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 fda2f0abaf..b4e4d80ff4 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 e8e5606420..f2d1f40e13 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_.ProjectTypes.html b/papi-dts/types/_papi_shared_types_.ProjectTypes.html index 8e5fcaa376..7a833c86ae 100644 --- a/papi-dts/types/_papi_shared_types_.ProjectTypes.html +++ b/papi-dts/types/_papi_shared_types_.ProjectTypes.html @@ -1,3 +1,3 @@ ProjectTypes | papi-dts

    Type alias ProjectTypes

    ProjectTypes: keyof ProjectDataTypes

    Identifiers for all project types supported by PAPI. These are not intended to correspond 1:1 to the set of project types available in Paratext.

    -

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ 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 4b39642279..770c01629c 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 59ebb117cc..d0624f15d4 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 4765e0e577..21ecdbd643 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 b72508fa5b..3e2b26c248 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 faa053e10c..2a01853e4d 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 bb341ec13d..7d6480a66c 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 d31f8bfdd9..28b317f9c0 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 9a3dcb29fa..787d5b42cd 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 296aafb074..2d9108bb04 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/_shared_data_file_system_model_.Uri.html b/papi-dts/types/_shared_data_file_system_model_.Uri.html index 7397af6d8f..bd18bc9b81 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 1e85fe0e6a..863f6ea84e 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 2db4947d2a..8517a97870 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 c0acb11e60..52bccb5362 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 303eeb176d..bc0b28efa6 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 fddad388c5..3fdde7a9fa 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 c76df21e46..71684d92bf 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 d7b816411f..c8e0bed01f 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 5be8bc5f43..5784f2347d 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 bd12293c59..2fe830fe1d 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 43e0933012..e55dfbd076 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 023e50eb27..bca9f98c88 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 fad18de219..b33b8680dd 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 7a35602f9e..bac5ec69ae 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 acf39aa0c8..899649a48e 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 4bddf426b3..c319553f29 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 84c7733d04..27821bce49 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 8820636a58..7f25d8e787 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 a971753419..116105f83a 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 b8951cce4c..73d1ab40c2 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 0f1b6d63b6..7cc6085246 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 aa762233fd..2ad0cde949 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 5f4b617e13..a81daa7b45 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 a22b8ecf22..7db61dad6b 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 7bf488f885..2b2a251261 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 3f2bf360a8..3b0e28cb3d 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 5b9ce29deb..389e4256f4 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 c7a81575b3..52d3f696dc 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 693412667b..602f23459c 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 f3add54d66..cf16748fe4 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 7dbe61cbbf..f677df4d89 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 85c5a65a47..41fc3f647b 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 06a02f0130..5f7df12c34 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 c2a589a721..94adc0bf1b 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 098e3ed379..fa67386966 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 0432e2b261..e7d37e7cb5 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 debdb50423..f489e864d8 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 8a1c21db9d..aaa13a0c28 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 ce00eb3ed1..9a338c36d2 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 d97d010f8d..e8d638d924 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 7d287b55dc..a4e6d3a636 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 c1034cf67b..d2926dbd41 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 0b7295d849..c4f6403592 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 78702147a8..f3ca1132c2 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 9403b79ebe..0b91611bdd 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 b7ef7868c8..278999ee79 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 b54997665e..19d43415a6 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 b6ea5fb4f2..1dadb4bd1c 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 569a001d97..ce4c1c332f 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 db71071310..1546435ec5 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 740d635575..05c4e60f78 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 c2207cb9fb..0f320c9a04 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 7c3eaaadc0..aaae2d9ec2 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 6f36907150..bbe58a17d6 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 0f04f31012..f1d9045756 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 d7c53d67dc..e8be161ef3 100644 --- a/papi-dts/types/_shared_models_network_object_model_.NetworkObjectDetails.html +++ b/papi-dts/types/_shared_models_network_object_model_.NetworkObjectDetails.html @@ -1,4 +1,4 @@ NetworkObjectDetails | papi-dts

    Type alias NetworkObjectDetails

    NetworkObjectDetails: {
        functionNames: string[];
        id: string;
    }

    Data about an object shared on the network

    Type declaration

    • functionNames: string[]
    • id: string

    Param: id

    ID of the network object that processes use to reference it

    Param: functionNames

    Array of strings with the function names exposed on this network 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/types/_shared_models_network_object_model_.NetworkableObject.html b/papi-dts/types/_shared_models_network_object_model_.NetworkableObject.html index 498a131ef6..b487ecbb41 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 dc69feeb30..686765f929 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 2045af69b8..7ad66f58c4 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 767ea2f707..9f0ead0c91 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_.ProjectDataProvider.html b/papi-dts/types/_shared_models_project_data_provider_engine_model_.ProjectDataProvider.html index e287e84b32..ccbe2bedbf 100644 --- a/papi-dts/types/_shared_models_project_data_provider_engine_model_.ProjectDataProvider.html +++ b/papi-dts/types/_shared_models_project_data_provider_engine_model_.ProjectDataProvider.html @@ -1,2 +1,2 @@ ProjectDataProvider | papi-dts

    Type alias ProjectDataProvider

    ProjectDataProvider: {
        [ProjectType in ProjectTypes]: "shared/models/data-provider.interface".default<ProjectDataTypes[ProjectType]>
    }

    All possible types for ProjectDataProviders: 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_project_data_provider_engine_model_.ProjectDataProviderEngineTypes.html b/papi-dts/types/_shared_models_project_data_provider_engine_model_.ProjectDataProviderEngineTypes.html index 614681f55f..2b64f29942 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 fc315da55a..1743162ce1 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 1ef7b515aa..3075ffde50 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 f197144b0d..d9a01ff4e2 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 e236cb8d4b..8a58150070 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 06d126716a..fd8a1f8a03 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 966be92d9d..965d1440f7 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 09afc9d555..8e6f6a96ea 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 a62101375d..40c9503de9 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 9467f29971..90976f9f33 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 a1c66d8b23..4e304dae38 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 9715c95dea..76b0d0429d 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 70bcc7f022..e478d98c95 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 b6d405f0f6..58a856b50e 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 1a15363a4c..7e3a788746 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 364fa9b02c..17f9944f18 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 b3692819d2..842aa19ea7 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 1469f5c417..d497ccfd22 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 8bb13ed96b..a1a1056fe7 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 b60a8a7257..c5120a3eec 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 806efb2159..9fc69bac6e 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 047f36c624..0120e2261e 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 a208886f9c..62fadbedc4 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 8d0c00307f..913ce8fd47 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 88d4a98f5e..57e09fd986 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 bd79d1272b..1cf516bb47 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 277952205e..69af93f758 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 5a5ac0b053..b686e633ee 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 df2d14cd94..a554644101 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 315ac2cc53..02e65185c9 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 ee2fd34da5..b948354a4d 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 5f1e0a3677..d61fbb8c16 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 493268c4d5..bd011d949d 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 073a9a303d..80e54b19e7 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 dbef831788..1689cd849a 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 b913b3a10f..12db0a14da 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 1eae91861b..54313a9790 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 b0e6c3212b..890f737186 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 e03b939732..b6f609c2cd 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 19ffa10f79..8c37ae03c0 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 8133ad4c62..2bd39b4979 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 a5a5635754..953a60cfce 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 fca26f3360..7a82926aaa 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 ea2e86cdb1..2660951ea7 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 e0b8f5ff9c..8b50b14909 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 c44a86e29d..688c0b2178 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 11df14886c..c2ef142d80 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 bf56ffaa58..f2eb8457cb 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 ae1082f9da..eae19d83ed 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 ea9d101c46..18da7821fb 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 c316f04b63..7bd351d697 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 3efdf003b0..66ad43e088 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 5e772c63c7..566aa49097 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 4a51549c03..2dee7056da 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 d4347ded04..b077083fc6 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 d13647ee5f..51ae978486 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 b6f0354d0e..99408e2ec3 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 5fb836a4f1..790cc260e3 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 0183c47c8b..76f6d22d80 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 0dafeedd3c..6f9dfe45a4 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 8022b98cb7..ea4ae9f9ca 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 a8fe0a6a47..250fb126a7 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 3250128878..a006cd7306 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 db615d048f..1cc74a8274 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 ca38ee9901..6c144264ae 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 55bb951d44..415be71842 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 06c48297be..0d1d06c3c3 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 60d7948791..10882bedaa 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 437c52d546..e365aba124 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 9081fa8661..18d7124164 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 89b3358cdb..081c6976f9 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 49176076e9..c4cf3dbfdd 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 3c3fb9429a..1f561e1c90 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 cb55372b41..b5f52c08f2 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 c78aaf1bff..82975e8b55 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 85e8834f6a..3ac39e4303 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 ca1a08b4b1..5681c6f797 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 69cc13fea2..69a31ee687 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 3189cbdd36..c065ae8afa 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 02aac9880d..80e73c09f7 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 45b081defc..5eeccffc17 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 57209c4dc1..513b5e2cfa 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 3f106e4950..cd4b00e594 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 6094fd0d03..35c5ed92b0 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 78ffa30097..7ac5edb53f 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 b9c6a83cdc..604e752385 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 4cc8521471..f157ab3bda 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 8eb7b9d9dd..10ea2a13f4 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 ef8d1d7f41..3c35ec4a3c 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 84f5f98cca..53299d671b 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 491909a94c..a463bb7fb6 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 6fd831d772..f8438dd5fd 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 0cd433248b..0ea9965061 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 0306212baa..304975ef4b 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 ebd4c6196b..9b262532d8 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 e29e895019..fb47cc41e9 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 5f567ef050..8aa2193881 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 acfdf15094..0e799bdac4 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 42cfca5657..297321ff3d 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 3f98849fb9..98d1be2168 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 a8bedb2858..312ce3422a 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 09a6873866..27c6456e92 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 995ee562a9..292c911d8f 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 ae1393b792..b56e39d253 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