Class AlertsAPI

Hierarchy

BaseResourceAPI<Alert>
- AlertsAPI

Index

Constructors

Methods

close create createChannels createSubscribers createSubscriptions deleteChannels deleteSubscribers deleteSubscription list listChannels listSubscribers listSubscriptions updateChannels

Constructors

constructor

new AlertsAPI(...args): AlertsAPI
Parameters
- Rest...args: [string, CDFHttpClient, MetadataMap]
Returns AlertsAPI
Overrides BaseResourceAPI<Alert>.constructor
- Defined in packages/beta/src/api/alerts/alertsApi.ts:32

Methods

close

close(items): Promise<object>
Parameters
- items: IdEither[]
Returns Promise<object>
- Defined in packages/beta/src/api/alerts/alertsApi.ts:62

create

create(items): Promise<Alert[]>
Parameters
- items: AlertCreate[]
Returns Promise<Alert[]>
- Defined in packages/beta/src/api/alerts/alertsApi.ts:54

createChannels

createChannels(items): Promise<Channel[]>
Parameters
- items: ChannelCreate[]
Returns Promise<Channel[]>
- Defined in packages/beta/src/api/alerts/alertsApi.ts:75

createSubscribers

createSubscribers(items): Promise<Subscriber[]>
Parameters
- items: SubscriberCreate[]
Returns Promise<Subscriber[]>
- Defined in packages/beta/src/api/alerts/alertsApi.ts:87

createSubscriptions

createSubscriptions(items): Promise<Subscription[]>
Parameters
- items: SubscriptionCreate[]
Returns Promise<Subscription[]>
- Defined in packages/beta/src/api/alerts/alertsApi.ts:99

deleteChannels

deleteChannels(items): Promise<{}>
Parameters
- items: IdEither[]
Returns Promise<{}>
- Defined in packages/beta/src/api/alerts/alertsApi.ts:79

deleteSubscribers

deleteSubscribers(items): Promise<{}>
Parameters
- items: IdEither[]
Returns Promise<{}>
- Defined in packages/beta/src/api/alerts/alertsApi.ts:95

deleteSubscription

deleteSubscription(items): Promise<{}>
Parameters
- items: SubscriptionDelete[]
Returns Promise<{}>
- Defined in packages/beta/src/api/alerts/alertsApi.ts:107

list

list(query?): CursorAndAsyncIterator<Alert>
Parameters
- Optionalquery: AlertFilterQuery
Returns CursorAndAsyncIterator<Alert>
- Defined in packages/beta/src/api/alerts/alertsApi.ts:58

listChannels

listChannels(filter?): Promise<ListResponse<Channel[]>>
Parameters
- Optionalfilter: ChannelFilterQuery
Returns Promise<ListResponse<Channel[]>>
- Defined in packages/beta/src/api/alerts/alertsApi.ts:71

listSubscribers

listSubscribers(filter?): Promise<ListResponse<Subscriber[]>>
Parameters
- Optionalfilter: SubscriberFilterQuery
Returns Promise<ListResponse<Subscriber[]>>
- Defined in packages/beta/src/api/alerts/alertsApi.ts:91

listSubscriptions

listSubscriptions(filter?): Promise<ListResponse<Subscription[]>>
Parameters
- Optionalfilter: SubscriptionFilterQuery
Returns Promise<ListResponse<Subscription[]>>
- Defined in packages/beta/src/api/alerts/alertsApi.ts:103

updateChannels

updateChannels(items): Promise<Channel[]>
Parameters
- items: ChannelChange[]
Returns Promise<Channel[]>
- Defined in packages/beta/src/api/alerts/alertsApi.ts:83