Console
SDK
REST API
Preparing search index...
The search index is not available
Integration App React - v2.13.2
Integration App React
useDataSourceInstance
Function useDataSourceInstance
useDataSourceInstance
(
selector
:
undefined
|
string
|
DataSourceInstanceSelector
,
)
:
{
dataSourceInstance
:
undefined
|
DataSourceInstance
;
accessor
:
undefined
|
DataSourceInstanceAccessor
;
refresh
:
()
=>
Promise
<
DataSourceInstance
>
;
setup
:
()
=>
Promise
<
void
>
;
reset
:
()
=>
Promise
<
void
>
;
openConfiguration
:
(
options
?:
OpenDataSourceConfigurationOptions
,
)
=>
Promise
<
undefined
|
void
>
;
listRecords
:
(
request
?:
DataCollectionListRequest
,
)
=>
Promise
<
undefined
|
DataCollectionListResponse
>
;
findRecords
:
(
request
?:
DataCollectionFindRequest
,
)
=>
Promise
<
undefined
|
DataCollectionFindResponse
>
;
findRecordById
:
(
id
:
string
,
)
=>
Promise
<
undefined
|
DataCollectionFindByIdResponse
>
;
createRecord
:
(
request
?:
DataCollectionCreateRequest
,
)
=>
Promise
<
undefined
|
DataCollectionCreateResponse
>
;
updateRecord
:
(
request
?:
DataCollectionUpdateRequest
,
)
=>
Promise
<
undefined
|
DataCollectionUpdateResponse
>
;
deleteRecord
:
(
id
?:
string
,
)
=>
Promise
<
undefined
|
DataCollectionDeleteResponse
>
;
unifiedFieldsToNative
:
(
unifiedFields
:
any
)
=>
Promise
<
any
>
;
getCollection
:
()
=>
Promise
<
undefined
|
DataCollectionSpec
>
;
loading
:
boolean
;
saving
:
boolean
;
error
:
any
;
refreshing
:
boolean
;
create
:
(
data
:
CreateDataSourceInstanceRequest
,
)
=>
Promise
<
undefined
|
DataSourceInstance
>
;
patch
:
(
data
:
Partial
<
UpdateDataSourceInstanceRequest
>
)
=>
Promise
<
void
>
;
put
:
(
data
:
UpdateDataSourceInstanceRequest
)
=>
Promise
<
void
>
;
archive
:
()
=>
Promise
<
void
>
;
}
Parameters
selector
:
undefined
|
string
|
DataSourceInstanceSelector
Returns
{
dataSourceInstance
:
undefined
|
DataSourceInstance
;
accessor
:
undefined
|
DataSourceInstanceAccessor
;
refresh
:
()
=>
Promise
<
DataSourceInstance
>
;
setup
:
()
=>
Promise
<
void
>
;
reset
:
()
=>
Promise
<
void
>
;
openConfiguration
:
(
options
?:
OpenDataSourceConfigurationOptions
,
)
=>
Promise
<
undefined
|
void
>
;
listRecords
:
(
request
?:
DataCollectionListRequest
,
)
=>
Promise
<
undefined
|
DataCollectionListResponse
>
;
findRecords
:
(
request
?:
DataCollectionFindRequest
,
)
=>
Promise
<
undefined
|
DataCollectionFindResponse
>
;
findRecordById
:
(
id
:
string
,
)
=>
Promise
<
undefined
|
DataCollectionFindByIdResponse
>
;
createRecord
:
(
request
?:
DataCollectionCreateRequest
,
)
=>
Promise
<
undefined
|
DataCollectionCreateResponse
>
;
updateRecord
:
(
request
?:
DataCollectionUpdateRequest
,
)
=>
Promise
<
undefined
|
DataCollectionUpdateResponse
>
;
deleteRecord
:
(
id
?:
string
,
)
=>
Promise
<
undefined
|
DataCollectionDeleteResponse
>
;
unifiedFieldsToNative
:
(
unifiedFields
:
any
)
=>
Promise
<
any
>
;
getCollection
:
()
=>
Promise
<
undefined
|
DataCollectionSpec
>
;
loading
:
boolean
;
saving
:
boolean
;
error
:
any
;
refreshing
:
boolean
;
create
:
(
data
:
CreateDataSourceInstanceRequest
,
)
=>
Promise
<
undefined
|
DataSourceInstance
>
;
patch
:
(
data
:
Partial
<
UpdateDataSourceInstanceRequest
>
)
=>
Promise
<
void
>
;
put
:
(
data
:
UpdateDataSourceInstanceRequest
)
=>
Promise
<
void
>
;
archive
:
()
=>
Promise
<
void
>
;
}
Settings
Member Visibility
Protected
Inherited
External
Theme
OS
Light
Dark
Console
SDK
REST API
Integration App React - v2.13.2
Loading...