Membrane SDK - v0.29.2
Console
React Lib
REST API
Preparing search index...
AppDataSchemasAccessor
Class AppDataSchemasAccessor
Hierarchy (
View Summary
)
ElementListAccessor
<
BaseAppDataSchema
,
FindAppDataSchemasQuery
,
CreateAppDataSchemaRequest
,
>
AppDataSchemasAccessor
Index
Constructors
constructor
Methods
find
find
All
create
Constructors
constructor
new
AppDataSchemasAccessor
(
client
:
MembraneApiClient
)
:
AppDataSchemasAccessor
Parameters
client
:
MembraneApiClient
Returns
AppDataSchemasAccessor
Methods
find
find
(
query
?:
{
limit
?:
number
;
cursor
?:
string
;
includeArchived
?:
boolean
;
search
?:
string
;
isUniversal
?:
boolean
;
tenantId
?:
string
;
userId
?:
string
;
appDataSchemaId
?:
string
;
instanceKey
?:
string
;
}
,
)
:
Promise
<
PaginationResponse
<
{
instanceKey
?:
string
;
appDataSchemaId
?:
string
;
schema
?:
any
;
code
?:
string
;
appDataSchemaRevision
?:
string
;
archivedAt
?:
string
;
isCustomized
?:
boolean
;
error
?:
ErrorDataSchema
;
id
:
string
;
uuid
?:
string
;
key
?:
string
;
description
?:
string
;
meta
?:
Record
<
string
,
any
>
;
name
:
string
;
state
?:
|
BUILDING
|
CLIENT_ACTION_REQUIRED
|
CONFIGURATION_ERROR
|
SETUP_FAILED
|
READY
|
DISCONNECTING
;
errors
?:
ErrorDataSchema
[]
;
revision
?:
string
;
createdAt
?:
string
;
updatedAt
?:
string
;
isDeactivated
?:
boolean
;
isReadOnly
?:
boolean
;
userId
?:
string
;
tenantId
?:
string
;
}
,
>
,
>
Parameters
Optional
query
:
{
limit
?:
number
;
cursor
?:
string
;
includeArchived
?:
boolean
;
search
?:
string
;
isUniversal
?:
boolean
;
tenantId
?:
string
;
userId
?:
string
;
appDataSchemaId
?:
string
;
instanceKey
?:
string
;
}
Returns
Promise
<
PaginationResponse
<
{
instanceKey
?:
string
;
appDataSchemaId
?:
string
;
schema
?:
any
;
code
?:
string
;
appDataSchemaRevision
?:
string
;
archivedAt
?:
string
;
isCustomized
?:
boolean
;
error
?:
ErrorDataSchema
;
id
:
string
;
uuid
?:
string
;
key
?:
string
;
description
?:
string
;
meta
?:
Record
<
string
,
any
>
;
name
:
string
;
state
?:
|
BUILDING
|
CLIENT_ACTION_REQUIRED
|
CONFIGURATION_ERROR
|
SETUP_FAILED
|
READY
|
DISCONNECTING
;
errors
?:
ErrorDataSchema
[]
;
revision
?:
string
;
createdAt
?:
string
;
updatedAt
?:
string
;
isDeactivated
?:
boolean
;
isReadOnly
?:
boolean
;
userId
?:
string
;
tenantId
?:
string
;
}
,
>
,
>
find
All
findAll
(
query
?:
Omit
<
{
limit
?:
number
;
cursor
?:
string
;
includeArchived
?:
boolean
;
search
?:
string
;
isUniversal
?:
boolean
;
tenantId
?:
string
;
userId
?:
string
;
appDataSchemaId
?:
string
;
instanceKey
?:
string
;
}
,
"limit"
,
>
,
)
:
Promise
<
{
instanceKey
?:
string
;
appDataSchemaId
?:
string
;
schema
?:
any
;
code
?:
string
;
appDataSchemaRevision
?:
string
;
archivedAt
?:
string
;
isCustomized
?:
boolean
;
error
?:
ErrorDataSchema
;
id
:
string
;
uuid
?:
string
;
key
?:
string
;
description
?:
string
;
meta
?:
Record
<
string
,
any
>
;
name
:
string
;
state
?:
|
BUILDING
|
CLIENT_ACTION_REQUIRED
|
CONFIGURATION_ERROR
|
SETUP_FAILED
|
READY
|
DISCONNECTING
;
errors
?:
ErrorDataSchema
[]
;
revision
?:
string
;
createdAt
?:
string
;
updatedAt
?:
string
;
isDeactivated
?:
boolean
;
isReadOnly
?:
boolean
;
userId
?:
string
;
tenantId
?:
string
;
}
[]
,
>
Parameters
Optional
query
:
Omit
<
{
limit
?:
number
;
cursor
?:
string
;
includeArchived
?:
boolean
;
search
?:
string
;
isUniversal
?:
boolean
;
tenantId
?:
string
;
userId
?:
string
;
appDataSchemaId
?:
string
;
instanceKey
?:
string
;
}
,
"limit"
,
>
Returns
Promise
<
{
instanceKey
?:
string
;
appDataSchemaId
?:
string
;
schema
?:
any
;
code
?:
string
;
appDataSchemaRevision
?:
string
;
archivedAt
?:
string
;
isCustomized
?:
boolean
;
error
?:
ErrorDataSchema
;
id
:
string
;
uuid
?:
string
;
key
?:
string
;
description
?:
string
;
meta
?:
Record
<
string
,
any
>
;
name
:
string
;
state
?:
|
BUILDING
|
CLIENT_ACTION_REQUIRED
|
CONFIGURATION_ERROR
|
SETUP_FAILED
|
READY
|
DISCONNECTING
;
errors
?:
ErrorDataSchema
[]
;
revision
?:
string
;
createdAt
?:
string
;
updatedAt
?:
string
;
isDeactivated
?:
boolean
;
isReadOnly
?:
boolean
;
userId
?:
string
;
tenantId
?:
string
;
}
[]
,
>
create
create
(
data
:
CreateAppDataSchemaRequest
,
)
:
Promise
<
{
instanceKey
?:
string
;
appDataSchemaId
?:
string
;
schema
?:
any
;
code
?:
string
;
appDataSchemaRevision
?:
string
;
archivedAt
?:
string
;
isCustomized
?:
boolean
;
error
?:
ErrorDataSchema
;
id
:
string
;
uuid
?:
string
;
key
?:
string
;
description
?:
string
;
meta
?:
Record
<
string
,
any
>
;
name
:
string
;
state
?:
|
BUILDING
|
CLIENT_ACTION_REQUIRED
|
CONFIGURATION_ERROR
|
SETUP_FAILED
|
READY
|
DISCONNECTING
;
errors
?:
ErrorDataSchema
[]
;
revision
?:
string
;
createdAt
?:
string
;
updatedAt
?:
string
;
isDeactivated
?:
boolean
;
isReadOnly
?:
boolean
;
userId
?:
string
;
tenantId
?:
string
;
}
,
>
Parameters
data
:
CreateAppDataSchemaRequest
Returns
Promise
<
{
instanceKey
?:
string
;
appDataSchemaId
?:
string
;
schema
?:
any
;
code
?:
string
;
appDataSchemaRevision
?:
string
;
archivedAt
?:
string
;
isCustomized
?:
boolean
;
error
?:
ErrorDataSchema
;
id
:
string
;
uuid
?:
string
;
key
?:
string
;
description
?:
string
;
meta
?:
Record
<
string
,
any
>
;
name
:
string
;
state
?:
|
BUILDING
|
CLIENT_ACTION_REQUIRED
|
CONFIGURATION_ERROR
|
SETUP_FAILED
|
READY
|
DISCONNECTING
;
errors
?:
ErrorDataSchema
[]
;
revision
?:
string
;
createdAt
?:
string
;
updatedAt
?:
string
;
isDeactivated
?:
boolean
;
isReadOnly
?:
boolean
;
userId
?:
string
;
tenantId
?:
string
;
}
,
>
Settings
Member Visibility
Protected
Inherited
External
Theme
OS
Light
Dark
On This Page
Constructors
constructor
Methods
find
find
All
create
Console
React Lib
REST API
Membrane SDK - v0.29.2
Loading...