# NotificationsAPI

## Content

# Type Alias: NotificationsAPI

```ts
type NotificationsAPI = object;
```

## Properties

### dismissAll

```ts
dismissAll: () => void;
```

Dismisses all the notifications

#### Returns

`void`

#### Examples

```javascript
// ESM usage
import { arWebDesigner } from './web-designer.js';
arWebDesigner.create('#ar-web-designer', {
		storeUnsavedReport: false
}).then((api) => {
		api.notifications.dismissAll();
});
```

```javascript
// UMD usage
const designer = GrapeCity.ActiveReports.Designer.create('#ar-web-designer', {
		storeUnsavedReport: false
}).then((api) => {
		api.notifications.dismissAll();
});
```

```typescript
	const designer = GrapeCity.ActiveReports.Designer.apiOf('ar-web-designer');
	designer.notifications.dismissAll();
```

***

### error

```ts
error: (caption, errorText?) => void;
```

Sends an error notification

#### Parameters

##### caption

`string`

Error caption

##### errorText?

`string`

Optional error details

#### Returns

`void`

#### Examples

```javascript
// ESM usage
import { arWebDesigner } from './web-designer.js';
arWebDesigner.create('#ar-web-designer', {
		storeUnsavedReport: false
}).then((api) => {
		api.notifications.error("Application error");
});
```

```javascript
// UMD usage
const designer = GrapeCity.ActiveReports.Designer.create('#ar-web-designer', {
		storeUnsavedReport: false
}).then((api) => {
		api.notifications.error("Application error");
});
```

```typescript
	var designer: DesignerAPI = GrapeCity.ActiveReports.Designer.create('#ar-web-designer', {
      storeUnsavedReport: false
  }).then((api: DesignerAPI) => {
          api.notifications.error("Application error");
 });
```

***

### info

```ts
info: (caption, text?) => void;
```

Sends a general notification. Can be used to notify when any user-initiated action is complete

#### Parameters

##### caption

`string`

Notification caption

##### text?

`string`

Optional notification content

#### Returns

`void`

#### Examples

```javascript
// ESM usage
import { arWebDesigner } from './web-designer.js';
arWebDesigner.create('#ar-web-designer', {
		storeUnsavedReport: false
}).then((api) => {
		api.notifications.info('Notification');
});
```

```javascript
// UMD usage
const designer = GrapeCity.ActiveReports.Designer.create('#ar-web-designer', {
		storeUnsavedReport: false
}).then((api) => {
		api.notifications.info('Notification');
});
```

```typescript
var designer: DesignerAPI = GrapeCity.ActiveReports.Designer.create('#ar-web-designer', {
     storeUnsavedReport: false
 }).then((api: DesignerAPI) => {
     api.notifications.info('Notification');
		});

***

### send

```ts
send: (level, caption, content?) => void;
```

Sends a notification of specified level, caption and content

#### Parameters

##### level

`"info"` \| `"warning"` \| `"error"`

Notification level. Determines color and icons used for the notifications

##### caption

`string`

Notification caption. Shown by default when notification pops up, then used as a title in Notification Details view

##### content?

`string`

Notification content. Only visible when Notification Details are open

#### Returns

`void`

#### Examples

```javascript
// ESM usage
import { arWebDesigner } from './web-designer.js';
arWebDesigner.create('#ar-web-designer', {
		storeUnsavedReport: false
}).then((api) => {
		api.notifications.send('info', 'My information');
});
```

```javascript
// UMD usage
const designer = GrapeCity.ActiveReports.Designer.create('#ar-web-designer', {
		storeUnsavedReport: false
}).then((api) => {
		api.notifications.send('info', 'My information');
});
```

```typescript
var designer: DesignerAPI = GrapeCity.ActiveReports.Designer.create('#ar-web-designer', {
     storeUnsavedReport: false
 }).then((api: DesignerAPI) => {
     api.notifications.send('info', 'My information');
});
```

***

### warning

```ts
warning: (caption, warningText?) => void;
```

Sends a warning notification

#### Parameters

##### caption

`string`

Warning caption

##### warningText?

`string`

Optional warning details

#### Returns

`void`

#### Examples

```javascript
// ESM usage
import { arWebDesigner } from './web-designer.js';
arWebDesigner.create('#ar-web-designer', {
		storeUnsavedReport: false
}).then((api) => {
		api.notifications.warning('Warning');
});
```

```javascript
// UMD usage
const designer = GrapeCity.ActiveReports.Designer.create('#ar-web-designer', {
		storeUnsavedReport: false
}).then((api) => {
		api.notifications.warning('Warning');
});
```

```typescript
	var designer: DesignerAPI = GrapeCity.ActiveReports.Designer.create('#ar-web-designer', {
      storeUnsavedReport: false
  }).then((api: DesignerAPI) => {
      api.notifications.warning('Warning');
 });
```