Membrane React - v0.6.0
Console
SDK
REST API
Preparing search index...
useScreen
Function useScreen
useScreen
(
selector
:
string
|
ScreenSelector
,
)
:
{
accessor
:
undefined
|
ScreenAccessor
;
loading
:
boolean
;
saving
:
boolean
;
error
:
any
;
refresh
:
()
=>
Promise
<
{
id
:
string
;
name
:
string
;
type
:
Integration
;
key
?:
string
;
blocks
:
(
{
type
:
ScreenBlockType
}
&
Record
<
string
,
any
>
)
[]
;
}
,
>
;
refreshing
:
boolean
;
create
:
(
data
:
CreateScreenRequest
,
)
=>
Promise
<
|
undefined
|
{
id
:
string
;
name
:
string
;
type
:
Integration
;
key
?:
string
;
blocks
:
(
{
type
:
ScreenBlockType
}
&
Record
<
string
,
any
>
)
[]
;
}
,
>
;
patch
:
(
data
:
Partial
<
UpdateRequest
>
)
=>
Promise
<
void
>
;
put
:
(
data
:
UpdateScreenRequest
)
=>
Promise
<
void
>
;
archive
:
()
=>
Promise
<
void
>
;
screen
:
|
undefined
|
{
id
:
string
;
name
:
string
;
type
:
Integration
;
key
?:
string
;
blocks
:
(
{
type
:
ScreenBlockType
}
&
Record
<
string
,
any
>
)
[]
;
}
;
}
Parameters
selector
:
string
|
ScreenSelector
Returns
{
accessor
:
undefined
|
ScreenAccessor
;
loading
:
boolean
;
saving
:
boolean
;
error
:
any
;
refresh
:
()
=>
Promise
<
{
id
:
string
;
name
:
string
;
type
:
Integration
;
key
?:
string
;
blocks
:
(
{
type
:
ScreenBlockType
}
&
Record
<
string
,
any
>
)
[]
;
}
,
>
;
refreshing
:
boolean
;
create
:
(
data
:
CreateScreenRequest
,
)
=>
Promise
<
|
undefined
|
{
id
:
string
;
name
:
string
;
type
:
Integration
;
key
?:
string
;
blocks
:
(
{
type
:
ScreenBlockType
}
&
Record
<
string
,
any
>
)
[]
;
}
,
>
;
patch
:
(
data
:
Partial
<
UpdateRequest
>
)
=>
Promise
<
void
>
;
put
:
(
data
:
UpdateScreenRequest
)
=>
Promise
<
void
>
;
archive
:
()
=>
Promise
<
void
>
;
screen
:
|
undefined
|
{
id
:
string
;
name
:
string
;
type
:
Integration
;
key
?:
string
;
blocks
:
(
{
type
:
ScreenBlockType
}
&
Record
<
string
,
any
>
)
[]
;
}
;
}
Settings
Member Visibility
Protected
Inherited
External
Theme
OS
Light
Dark
Console
SDK
REST API
Membrane React - v0.6.0
Loading...