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/channelsApi"
ChannelsAPI
Class ChannelsAPI
Hierarchy
BaseResourceAPI
<
Channel
>
ChannelsAPI
Index
Constructors
constructor
Methods
create
delete
list
update
Constructors
constructor
new
ChannelsAPI
(
...
args
:
[
string
,
CDFHttpClient
,
MetadataMap
]
)
:
ChannelsAPI
Parameters
Rest
...
args:
[
string
,
CDFHttpClient
,
MetadataMap
]
Returns
ChannelsAPI
Methods
create
create
(
items
:
ChannelCreate
[]
)
:
Promise
<
Channel
[]
>
Parameters
items:
ChannelCreate
[]
Returns
Promise
<
Channel
[]
>
delete
delete
(
ids
:
IdEither
[]
)
:
Promise
<
{}
>
Parameters
ids:
IdEither
[]
Returns
Promise
<
{}
>
list
list
(
filter
?:
ChannelFilterQuery
)
:
Promise
<
ListResponse
<
Channel
[]
>
>
Parameters
Optional
filter:
ChannelFilterQuery
Returns
Promise
<
ListResponse
<
Channel
[]
>
>
update
update
(
changes
:
ChannelChange
[]
)
:
Promise
<
Channel
[]
>
Parameters
changes:
ChannelChange
[]
Returns
Promise
<
Channel
[]
>
Globals
"beta/src/api/alerts/channels
Api"
ChannelsAPI
constructor
create
delete
list
update