> ## Documentation Index
> Fetch the complete documentation index at: https://dev.marginnote.com.cn/llms.txt
> Use this file to discover all available pages before exploring further.

# Application

> Native instance exported as .

Native instance exported as `Application`.

## Properties

**appVersion** `string | null` *required*

Exported member.

**build** `string | null` *required*

Exported member.

**cachePath** `string | null` *required*

Exported member.

**currentTheme** `string | null` *required*

Exported member.

**dbPath** `string | null` *required*

Exported member.

**defaultBookPageColor** `UIColor | null` *required*

Exported member.

**defaultDisableColor** `UIColor | null` *required*

Exported member.

**defaultHighlightBlendColor** `UIColor | null` *required*

Exported member.

**defaultNotebookColor** `UIColor | null` *required*

Exported member.

**defaultTextColor** `UIColor | null` *required*

Exported member.

**defaultTintColor** `UIColor | null` *required*

Exported member.

**defaultTintColorForDarkBackground** `UIColor | null` *required*

Exported member.

**defaultTintColorForSelected** `UIColor | null` *required*

Exported member.

**documentPath** `string | null` *required*

Exported member.

**focusWindow** `UIWindow | null` *required*

Exported member.

**osType** `number` *required*

Exported member.

**searchManager** `SearchManager | null` *required*

**Type:** `SearchManager | null`

Exported member.

**tempPath** `string | null` *required*

Exported member.

## Methods

### aiPickSenseInContext()

```typescript
aiPickSenseInContext(_note: Note | null, _word: string | null, _sentence: string | null, _senses: unknown[] | null, _completion: unknown): void
```

Exported member.

#### Parameters

**\_note** `Note | null` *required*

**Type:** `Note | null`

**\_word** `string | null` *required*

**\_sentence** `string | null` *required*

**\_senses** `unknown[] | null` *required*

**\_completion** `unknown` *required*

### aiRunTask()

```typescript
aiRunTask(_note: Note | null, _taskId: string | null, _params: Record<string, unknown> | null, _completion: unknown): void
```

Exported member.

#### Parameters

**\_note** `Note | null` *required*

**Type:** `Note | null`

**\_taskId** `string | null` *required*

**\_params** `Record\<string, unknown\> | null` *required*

**\_completion** `unknown` *required*

### aiWordInContext()

```typescript
aiWordInContext(_note: Note | null, _word: string | null, _sentence: string | null, _completion: unknown): void
```

Exported member.

#### Parameters

**\_note** `Note | null` *required*

**Type:** `Note | null`

**\_word** `string | null` *required*

**\_sentence** `string | null` *required*

**\_completion** `unknown` *required*

### alert()

```typescript
alert(_message: string | null): void
```

Exported member.

#### Parameters

**\_message** `string | null` *required*

### checkNotifySenderInWindow()

```typescript
checkNotifySenderInWindow(_obj: unknown, _window: UIWindow | null): boolean
```

Exported member.

#### Parameters

**\_obj** `unknown` *required*

**\_window** `UIWindow | null` *required*

#### Returns

`boolean`

### immersiveTemplateForAddon()

```typescript
immersiveTemplateForAddon(_addonID: string | null): Record<string, unknown> | null
```

Exported member.

#### Parameters

**\_addonID** `string | null` *required*

#### Returns

`Record<string, unknown> | null`

### importDocument()

```typescript
importDocument(_fileUrl: string | null): string | null
```

Exported member.

#### Parameters

**\_fileUrl** `string | null` *required*

#### Returns

`string | null`

### openFileWithUTIs()

```typescript
openFileWithUTIs(_types: string[] | null, _controller: UIViewController | null, _block: unknown): void
```

Exported member.

#### Parameters

**\_types** `string[] | null` *required*

**\_controller** `UIViewController | null` *required*

**\_block** `unknown` *required*

### openURL()

```typescript
openURL(_url: NSURL | null): void
```

Exported member.

#### Parameters

**\_url** `NSURL | null` *required*

### processCommandWithKeyFlagsInWindow()

```typescript
processCommandWithKeyFlagsInWindow(_command: string | null, _keyFlags: number, _window: UIWindow | null): void
```

Exported member.

#### Parameters

**\_command** `string | null` *required*

**\_keyFlags** `number` *required*

**\_window** `UIWindow | null` *required*

### queryCommandWithKeyFlagsInWindow()

```typescript
queryCommandWithKeyFlagsInWindow(_command: string | null, _keyFlags: number, _window: UIWindow | null): Record<string, unknown> | null
```

Exported member.

#### Parameters

**\_command** `string | null` *required*

**\_keyFlags** `number` *required*

**\_window** `UIWindow | null` *required*

#### Returns

`Record<string, unknown> | null`

### refreshAfterDBChanged()

```typescript
refreshAfterDBChanged(_topicid: string | null): void
```

Exported member.

#### Parameters

**\_topicid** `string | null` *required*

### regsiterHtmlCommentEditor()

```typescript
regsiterHtmlCommentEditor(_commentEditor: Record<string, unknown> | null, _htmlEditor: unknown, _htmlRender: unknown, _commentTag: string | null): void
```

Exported member.

#### Parameters

**\_commentEditor** `Record\<string, unknown\> | null` *required*

**\_htmlEditor** `unknown` *required*

**\_htmlRender** `unknown` *required*

**\_commentTag** `string | null` *required*

### saveFileWithUti()

```typescript
saveFileWithUti(_mfile: string | null, _uti: string | null): void
```

Exported member.

#### Parameters

**\_mfile** `string | null` *required*

**\_uti** `string | null` *required*

### showHUD()

```typescript
showHUD(_message: string | null, _view: UIView | null, _duration: number): void
```

Exported member.

#### Parameters

**\_message** `string | null` *required*

**\_view** `UIView | null` *required*

**\_duration** `number` *required*

### stopWaitHUDOnView()

```typescript
stopWaitHUDOnView(_view: UIView | null): void
```

Exported member.

#### Parameters

**\_view** `UIView | null` *required*

### studyController()

```typescript
studyController(_window: UIWindow | null): StudyController | null
```

Exported member.

#### Parameters

**\_window** `UIWindow | null` *required*

#### Returns

`StudyController | null`

### unregsiterHtmlCommentEditor()

```typescript
unregsiterHtmlCommentEditor(_commentTag: string | null): void
```

Exported member.

#### Parameters

**\_commentTag** `string | null` *required*

### waitHUDOnView()

```typescript
waitHUDOnView(_message: string | null, _view: UIView | null): void
```

Exported member.

#### Parameters

**\_message** `string | null` *required*

**\_view** `UIView | null` *required*


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.