Search
Preparing search index...
The search index is not available
Cognite JavaScript SDK (beta)
Options
All
Public
Public/Protected
All
Inherited
Externals
Only exported
Menu
Globals
"beta/src/api/alerts/subscribersApi"
SubscribersAPI
Class SubscribersAPI
Hierarchy
BaseResourceAPI
<
Subscriber
>
SubscribersAPI
Index
Constructors
constructor
Methods
create
delete
list
Constructors
constructor
new
SubscribersAPI
(
...
args
:
[
string
,
CDFHttpClient
,
MetadataMap
]
)
:
SubscribersAPI
Parameters
Rest
...
args:
[
string
,
CDFHttpClient
,
MetadataMap
]
Returns
SubscribersAPI
Methods
create
create
(
items
:
SubscriberCreate
[]
)
:
Promise
<
Subscriber
[]
>
Parameters
items:
SubscriberCreate
[]
Returns
Promise
<
Subscriber
[]
>
delete
delete
(
ids
:
IdEither
[]
)
:
Promise
<
{}
>
Parameters
ids:
IdEither
[]
Returns
Promise
<
{}
>
list
list
(
filter
?:
SubscriberFilterQuery
)
:
Promise
<
ListResponse
<
Subscriber
[]
>
>
Parameters
Optional
filter:
SubscriberFilterQuery
Returns
Promise
<
ListResponse
<
Subscriber
[]
>
>
Globals
"beta/src/api/alerts/subscribers
Api"
SubscribersAPI
constructor
create
delete
list