### Hierarchy

- NavigationService
  - MockNavigationService
  - WindowService
  - XFNavigationService

## Index

### Constructors

- constructor

### Properties

- app

### Accessors

- location
- title

### Methods

- alert
- back
- confirm
- navigate
- notify
- openPage
- openWindow
- refresh
- registerNavigationHook
- remove

## Constructors

### constructor

- new NavigationService(app: App): NavigationService

- - Defined in src/services/NavigationService.ts:65

  #### Parameters

  - ##### app: App

  #### Returns NavigationService

## Properties

### app

app: App

- Defined in src/services/NavigationService.ts:67

## Accessors

### location

- get location(): AtomUri
- set location(v: AtomUri): any

- - Defined in src/services/NavigationService.ts:141

  #### Returns AtomUri

- - Defined in src/services/NavigationService.ts:142

  #### Parameters

  - ##### v: AtomUri

  #### Returns any

### title

- get title(): string
- set title(v: string): any

- - Defined in src/services/NavigationService.ts:138

  #### Returns string

- - Defined in src/services/NavigationService.ts:139

  #### Parameters

  - ##### v: string

  #### Returns any

## Methods

### Abstract alert

- alert(message: string | FormattedString, title?: string): Promise<any>

- - Defined in src/services/NavigationService.ts:71

  #### Parameters

  - ##### message: string | FormattedString

  - ##### Optional title: string

  #### Returns Promise<any>

### Abstract back

- back(): void

- - Defined in src/services/NavigationService.ts:146

  #### Returns void

### Abstract confirm

- confirm(message: string | FormattedString, title?: string): Promise<boolean>

- - Defined in src/services/NavigationService.ts:72

  #### Parameters

  - ##### message: string | FormattedString

  - ##### Optional title: string

  #### Returns Promise<boolean>

### Abstract navigate

- navigate(url: string): void

- - Defined in src/services/NavigationService.ts:144

  #### Parameters

  - ##### url: string

  #### Returns void

### Abstract notify

- notify(message: string | FormattedString, title?: string, type?: NotifyType, delay?: number): void

- - Defined in src/services/NavigationService.ts:136

  #### Parameters

  - ##### message: string | FormattedString

  - ##### Optional title: string

  - ##### Optional type: NotifyType

  - ##### Optional delay: number

  #### Returns void

### openPage

- openPage<T>(pageName: string | any, p?: INameValuePairs, options?: IPageOptions): Promise<T>

- - Defined in src/services/NavigationService.ts:80

  #### Type parameters

  - #### T

  #### Parameters

  - ##### pageName: string | any

    url

  - ##### Optional p: INameValuePairs

    parameters

  - ##### Optional options: IPageOptions

  #### Returns Promise<T>

### Protected Abstract openWindow

- openWindow<T>(url: AtomUri, options: IPageOptions): Promise<T>

- - Defined in src/services/NavigationService.ts:180

  #### Type parameters

  - #### T

  #### Parameters

  - ##### url: AtomUri

  - ##### options: IPageOptions

  #### Returns Promise<T>

### Abstract refresh

- refresh(): void

- - Defined in src/services/NavigationService.ts:148

  #### Returns void

### registerNavigationHook

- registerNavigationHook(callback: navigateCallback): IDisposable

- - Defined in src/services/NavigationService.ts:171

  #### Parameters

  - ##### callback: navigateCallback

  #### Returns IDisposable

### remove

- remove(view: object, force?: boolean): Promise<boolean>

- - Defined in src/services/NavigationService.ts:157

  Sends signal to remove window/popup/frame, it will not immediately remove, because it will identify whether it can remove or not by displaying cancellation warning. Only if there is no cancellation warning or user chooses to force close, it will not remove.

  #### Parameters

  - ##### view: object

  - ##### Optional force: boolean

  #### Returns Promise<boolean>

  true if view was removed successfully

Generated using TypeDoc