Notifier
OCP App SDK / Notifier
Notifier
Index
Methods
Methods
error()
Create an error notification.
Signature
error(
activity: string,
title: string,
summary: string,
details?: string): Promise<void>;
Parameters
Name | Type | Description |
---|---|---|
activity | string | The activity, must not be empty |
title | string | The title, must not be empty |
summary | string | The activity summary, must not be empty |
details? | string | The activity details |
Returns
Promise
<void
>
Defined in: src/notifications/Notifier.ts:36
info()
Create an informational notification.
Signature
info(
activity: string,
title: string,
summary: string,
details?: string): Promise<void>;
Parameters
Name | Type | Description |
---|---|---|
activity | string | The activity, must not be empty |
title | string | The title, must not be empty |
summary | string | The activity summary, must not be empty |
details? | string | The activity details |
Returns
Promise
<void
>
Defined in: src/notifications/Notifier.ts:9
success()
Create a success notification.
Signature
success(
activity: string,
title: string,
summary: string,
details?: string): Promise<void>;
Parameters
Name | Type | Description |
---|---|---|
activity | string | The activity, must not be empty |
title | string | The title, must not be empty |
summary | string | The activity summary, must not be empty |
details? | string | The activity details |
Returns
Promise
<void
>
Defined in: src/notifications/Notifier.ts:18
warn()
Create a warning notification.
Signature
warn(
activity: string,
title: string,
summary: string,
details?: string): Promise<void>;
Parameters
Name | Type | Description |
---|---|---|
activity | string | The activity, must not be empty |
title | string | The title, must not be empty |
summary | string | The activity summary, must not be empty |
details? | string | The activity details |
Returns
Promise
<void
>
Defined in: src/notifications/Notifier.ts:27
Updated 2 months ago