Methods
(async) list(sort) → {Array.<Alert>}
List a single page of unread alerts.
Parameters:
| Name | Type | Description |
|---|---|---|
sort |
SortOptions | undefined | An optional set of sort options. |
- Source:
Returns:
An array of raw data objects.
- Type
- Array.<Alert>
(async) listAll(sort) → {Array.<Alert>}
List all pages of unread alerts.
Parameters:
| Name | Type | Description |
|---|---|---|
sort |
SortOptions | undefined | An optional set of sort options. |
- Source:
Returns:
An array of raw data objects.
- Type
- Array.<Alert>
(async) listUntil(shouldContinue, sort) → {Array.<Alert>}
List multiple pages of unread alerts until a condition is no longer met.
Parameters:
| Name | Type | Description |
|---|---|---|
shouldContinue |
function | A function which determines if further pages are requested. |
sort |
SortOptions | undefined | An optional set of sort options. |
- Source:
Returns:
An array of raw data objects.
- Type
- Array.<Alert>
(async) markAsRead()
Mark unread alerts as read.
- Source: