Console
SDK
REST API
Preparing search index...
The search index is not available
Integration App React - v2.13.2
Integration App React
useScreen
Function useScreen
useScreen
(
selector
:
string
|
ScreenSelector
,
)
:
{
screen
:
undefined
|
Screen
;
accessor
:
undefined
|
ScreenAccessor
;
loading
:
boolean
;
saving
:
boolean
;
error
:
any
;
refresh
:
()
=>
Promise
<
Screen
>
;
refreshing
:
boolean
;
create
:
(
data
:
CreateScreenRequest
)
=>
Promise
<
undefined
|
Screen
>
;
patch
:
(
data
:
Partial
<
UpdateScreenRequest
>
)
=>
Promise
<
void
>
;
put
:
(
data
:
UpdateScreenRequest
)
=>
Promise
<
void
>
;
archive
:
()
=>
Promise
<
void
>
;
}
Parameters
selector
:
string
|
ScreenSelector
Returns
{
screen
:
undefined
|
Screen
;
accessor
:
undefined
|
ScreenAccessor
;
loading
:
boolean
;
saving
:
boolean
;
error
:
any
;
refresh
:
()
=>
Promise
<
Screen
>
;
refreshing
:
boolean
;
create
:
(
data
:
CreateScreenRequest
)
=>
Promise
<
undefined
|
Screen
>
;
patch
:
(
data
:
Partial
<
UpdateScreenRequest
>
)
=>
Promise
<
void
>
;
put
:
(
data
:
UpdateScreenRequest
)
=>
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...