Documentation - v19.2.0-dev
Preparing search index...
@stereograph/teiaviewer-plugins
TwinPlanApi
Function TwinPlanApi
TwinPlanApi
(
client
:
ApiClient
,
)
:
{
addPlan
(
twin
:
Twin
,
createPlanBody
:
NewPlanConfig
)
:
Promise
<
void
>
;
deletePlan
(
twin
:
Twin
,
twinPlanConfigurationId
:
number
)
:
Promise
<
void
>
;
downloadExport
(
twin
:
Twin
,
dxfCfgId
:
number
)
:
Promise
<
string
>
;
getTwinPlans
(
twin
:
Twin
,
pageNumber
:
number
,
pageSize
:
number
,
name
?:
string
,
statusList
?:
(
|
"Completed"
|
"Failed"
|
"Expired"
|
"ToDo"
|
"InProgressGltf"
|
"InProgressDxf"
)
[]
,
orderBy
?:
string
,
orderDirection
?:
string
,
)
:
Promise
<
ApiDataList
<
PlanConfig
>
>
;
restartExport
(
twin
:
Twin
,
dxfConfigurationId
:
number
)
:
Promise
<
void
>
;
updatePlan
(
twin
:
Twin
,
dxfConfigurationId
:
number
,
updatePlanBody
:
NewPlanConfig
,
)
:
Promise
<
void
>
;
}
Parameters
client
:
ApiClient
Returns
{
addPlan
(
twin
:
Twin
,
createPlanBody
:
NewPlanConfig
)
:
Promise
<
void
>
;
deletePlan
(
twin
:
Twin
,
twinPlanConfigurationId
:
number
)
:
Promise
<
void
>
;
downloadExport
(
twin
:
Twin
,
dxfCfgId
:
number
)
:
Promise
<
string
>
;
getTwinPlans
(
twin
:
Twin
,
pageNumber
:
number
,
pageSize
:
number
,
name
?:
string
,
statusList
?:
(
|
"Completed"
|
"Failed"
|
"Expired"
|
"ToDo"
|
"InProgressGltf"
|
"InProgressDxf"
)
[]
,
orderBy
?:
string
,
orderDirection
?:
string
,
)
:
Promise
<
ApiDataList
<
PlanConfig
>
>
;
restartExport
(
twin
:
Twin
,
dxfConfigurationId
:
number
)
:
Promise
<
void
>
;
updatePlan
(
twin
:
Twin
,
dxfConfigurationId
:
number
,
updatePlanBody
:
NewPlanConfig
,
)
:
Promise
<
void
>
;
}
Settings
Member Visibility
Protected
Inherited
Theme
OS
Light
Dark
Documentation - v19.2.0-dev
Loading...