Search
Preparing search index...
The search index is not available
Deco BCF Documentation - v1.0.0
Options
All
Public
Public/Protected
All
Inherited
Menu
Deco BCF Documentation - v1.0.0
BcfCoreControllerMiddleware
Class BcfCoreControllerMiddleware
Hierarchy
ControllerMiddleware
BcfCoreControllerMiddleware
Index
Constructors
constructor
Methods
check
Project
Authorization
extend
Get
All
Query
get
One
Element
Id
get
Project
First
get
Topic
First
prepare
Author
Body
prepare
Comment
Body
prepare
Topic
Body
prepare
Viewpoint
Body
put
Element
return
Project
Extensions
store
Project
Element
store
Topic
Element
authenticate
Constructors
constructor
new
Bcf
Core
Controller
Middleware
(
model
:
typeof
Model
)
:
BcfCoreControllerMiddleware
Parameters
model:
typeof
Model
Returns
BcfCoreControllerMiddleware
Methods
check
Project
Authorization
check
Project
Authorization
(
action
:
BcfProjectActions
)
:
(
req
:
Request
<
ParamsDictionary
,
any
,
any
,
ParsedQs
,
Record
<
string
,
any
>
>
, res
:
Response
<
any
,
Record
<
string
,
any
>
>
, next
:
NextFunction
)
=>
void
Parameters
action:
BcfProjectActions
Returns
(
req
:
Request
<
ParamsDictionary
,
any
,
any
,
ParsedQs
,
Record
<
string
,
any
>
>
, res
:
Response
<
any
,
Record
<
string
,
any
>
>
, next
:
NextFunction
)
=>
void
(
req
:
Request
<
ParamsDictionary
,
any
,
any
,
ParsedQs
,
Record
<
string
,
any
>
>
, res
:
Response
<
any
,
Record
<
string
,
any
>
>
, next
:
NextFunction
)
:
void
Parameters
req:
Request
<
ParamsDictionary
,
any
,
any
,
ParsedQs
,
Record
<
string
,
any
>
>
res:
Response
<
any
,
Record
<
string
,
any
>
>
next:
NextFunction
Returns
void
extend
Get
All
Query
extend
Get
All
Query
(
query
:
Query
, req
:
Request
<
ParamsDictionary
,
any
,
any
,
ParsedQs
,
Record
<
string
,
any
>
>
, res
:
Response
<
any
,
Record
<
string
,
any
>
>
)
:
Promise
<
void
>
Parameters
query:
Query
req:
Request
<
ParamsDictionary
,
any
,
any
,
ParsedQs
,
Record
<
string
,
any
>
>
res:
Response
<
any
,
Record
<
string
,
any
>
>
Returns
Promise
<
void
>
get
One
Element
Id
get
One
Element
Id
(
elementId
:
string
|
ObjectId
, req
:
Request
<
ParamsDictionary
,
any
,
any
,
ParsedQs
,
Record
<
string
,
any
>
>
, res
:
Response
<
any
,
Record
<
string
,
any
>
>
)
:
Promise
<
string
|
ObjectId
>
Parameters
elementId:
string
|
ObjectId
req:
Request
<
ParamsDictionary
,
any
,
any
,
ParsedQs
,
Record
<
string
,
any
>
>
res:
Response
<
any
,
Record
<
string
,
any
>
>
Returns
Promise
<
string
|
ObjectId
>
get
Project
First
get
Project
First
(
req
:
Request
<
ParamsDictionary
,
any
,
any
,
ParsedQs
,
Record
<
string
,
any
>
>
, res
:
Response
<
any
,
Record
<
string
,
any
>
>
, next
:
NextFunction
)
:
void
Parameters
req:
Request
<
ParamsDictionary
,
any
,
any
,
ParsedQs
,
Record
<
string
,
any
>
>
res:
Response
<
any
,
Record
<
string
,
any
>
>
next:
NextFunction
Returns
void
get
Topic
First
get
Topic
First
(
req
:
Request
<
ParamsDictionary
,
any
,
any
,
ParsedQs
,
Record
<
string
,
any
>
>
, res
:
Response
<
any
,
Record
<
string
,
any
>
>
, next
:
NextFunction
)
:
void
Parameters
req:
Request
<
ParamsDictionary
,
any
,
any
,
ParsedQs
,
Record
<
string
,
any
>
>
res:
Response
<
any
,
Record
<
string
,
any
>
>
next:
NextFunction
Returns
void
prepare
Author
Body
prepare
Author
Body
(
)
:
(
req
:
Request
<
ParamsDictionary
,
any
,
any
,
ParsedQs
,
Record
<
string
,
any
>
>
, res
:
Response
<
any
,
Record
<
string
,
any
>
>
, next
:
NextFunction
)
=>
void
Returns
(
req
:
Request
<
ParamsDictionary
,
any
,
any
,
ParsedQs
,
Record
<
string
,
any
>
>
, res
:
Response
<
any
,
Record
<
string
,
any
>
>
, next
:
NextFunction
)
=>
void
(
req
:
Request
<
ParamsDictionary
,
any
,
any
,
ParsedQs
,
Record
<
string
,
any
>
>
, res
:
Response
<
any
,
Record
<
string
,
any
>
>
, next
:
NextFunction
)
:
void
Parameters
req:
Request
<
ParamsDictionary
,
any
,
any
,
ParsedQs
,
Record
<
string
,
any
>
>
res:
Response
<
any
,
Record
<
string
,
any
>
>
next:
NextFunction
Returns
void
prepare
Comment
Body
prepare
Comment
Body
(
)
:
(
req
:
Request
<
ParamsDictionary
,
any
,
any
,
ParsedQs
,
Record
<
string
,
any
>
>
, res
:
Response
<
any
,
Record
<
string
,
any
>
>
, next
:
NextFunction
)
=>
void
Returns
(
req
:
Request
<
ParamsDictionary
,
any
,
any
,
ParsedQs
,
Record
<
string
,
any
>
>
, res
:
Response
<
any
,
Record
<
string
,
any
>
>
, next
:
NextFunction
)
=>
void
(
req
:
Request
<
ParamsDictionary
,
any
,
any
,
ParsedQs
,
Record
<
string
,
any
>
>
, res
:
Response
<
any
,
Record
<
string
,
any
>
>
, next
:
NextFunction
)
:
void
Parameters
req:
Request
<
ParamsDictionary
,
any
,
any
,
ParsedQs
,
Record
<
string
,
any
>
>
res:
Response
<
any
,
Record
<
string
,
any
>
>
next:
NextFunction
Returns
void
prepare
Topic
Body
prepare
Topic
Body
(
)
:
(
req
:
Request
<
ParamsDictionary
,
any
,
any
,
ParsedQs
,
Record
<
string
,
any
>
>
, res
:
Response
<
any
,
Record
<
string
,
any
>
>
, next
:
NextFunction
)
=>
void
Returns
(
req
:
Request
<
ParamsDictionary
,
any
,
any
,
ParsedQs
,
Record
<
string
,
any
>
>
, res
:
Response
<
any
,
Record
<
string
,
any
>
>
, next
:
NextFunction
)
=>
void
(
req
:
Request
<
ParamsDictionary
,
any
,
any
,
ParsedQs
,
Record
<
string
,
any
>
>
, res
:
Response
<
any
,
Record
<
string
,
any
>
>
, next
:
NextFunction
)
:
void
Parameters
req:
Request
<
ParamsDictionary
,
any
,
any
,
ParsedQs
,
Record
<
string
,
any
>
>
res:
Response
<
any
,
Record
<
string
,
any
>
>
next:
NextFunction
Returns
void
prepare
Viewpoint
Body
prepare
Viewpoint
Body
(
)
:
(
req
:
Request
<
ParamsDictionary
,
any
,
any
,
ParsedQs
,
Record
<
string
,
any
>
>
, res
:
Response
<
any
,
Record
<
string
,
any
>
>
, next
:
NextFunction
)
=>
void
Returns
(
req
:
Request
<
ParamsDictionary
,
any
,
any
,
ParsedQs
,
Record
<
string
,
any
>
>
, res
:
Response
<
any
,
Record
<
string
,
any
>
>
, next
:
NextFunction
)
=>
void
(
req
:
Request
<
ParamsDictionary
,
any
,
any
,
ParsedQs
,
Record
<
string
,
any
>
>
, res
:
Response
<
any
,
Record
<
string
,
any
>
>
, next
:
NextFunction
)
:
void
Parameters
req:
Request
<
ParamsDictionary
,
any
,
any
,
ParsedQs
,
Record
<
string
,
any
>
>
res:
Response
<
any
,
Record
<
string
,
any
>
>
next:
NextFunction
Returns
void
put
Element
put
Element
(
element
:
Model
, req
:
Request
<
ParamsDictionary
,
any
,
any
,
ParsedQs
,
Record
<
string
,
any
>
>
, res
:
Response
<
any
,
Record
<
string
,
any
>
>
)
:
Promise
<
Model
>
Parameters
element:
Model
req:
Request
<
ParamsDictionary
,
any
,
any
,
ParsedQs
,
Record
<
string
,
any
>
>
res:
Response
<
any
,
Record
<
string
,
any
>
>
Returns
Promise
<
Model
>
return
Project
Extensions
return
Project
Extensions
(
req
:
Request
<
ParamsDictionary
,
any
,
any
,
ParsedQs
,
Record
<
string
,
any
>
>
, res
:
Response
<
any
,
Record
<
string
,
any
>
>
, next
:
NextFunction
)
:
void
Parameters
req:
Request
<
ParamsDictionary
,
any
,
any
,
ParsedQs
,
Record
<
string
,
any
>
>
res:
Response
<
any
,
Record
<
string
,
any
>
>
next:
NextFunction
Returns
void
store
Project
Element
store
Project
Element
(
req
:
Request
<
ParamsDictionary
,
any
,
any
,
ParsedQs
,
Record
<
string
,
any
>
>
, res
:
Response
<
any
,
Record
<
string
,
any
>
>
, next
:
NextFunction
)
:
void
Parameters
req:
Request
<
ParamsDictionary
,
any
,
any
,
ParsedQs
,
Record
<
string
,
any
>
>
res:
Response
<
any
,
Record
<
string
,
any
>
>
next:
NextFunction
Returns
void
store
Topic
Element
store
Topic
Element
(
req
:
Request
<
ParamsDictionary
,
any
,
any
,
ParsedQs
,
Record
<
string
,
any
>
>
, res
:
Response
<
any
,
Record
<
string
,
any
>
>
, next
:
NextFunction
)
:
void
Parameters
req:
Request
<
ParamsDictionary
,
any
,
any
,
ParsedQs
,
Record
<
string
,
any
>
>
res:
Response
<
any
,
Record
<
string
,
any
>
>
next:
NextFunction
Returns
void
Static
authenticate
authenticate
(
req
:
Request
<
ParamsDictionary
,
any
,
any
,
ParsedQs
,
Record
<
string
,
any
>
>
, res
:
Response
<
any
,
Record
<
string
,
any
>
>
, next
:
NextFunction
)
:
void
Parameters
req:
Request
<
ParamsDictionary
,
any
,
any
,
ParsedQs
,
Record
<
string
,
any
>
>
res:
Response
<
any
,
Record
<
string
,
any
>
>
next:
NextFunction
Returns
void
Exports
Bcf
Comment
Model
Bcf
Core
Controller
Middleware
constructor
check
Project
Authorization
extend
Get
All
Query
get
One
Element
Id
get
Project
First
get
Topic
First
prepare
Author
Body
prepare
Comment
Body
prepare
Topic
Body
prepare
Viewpoint
Body
put
Element
return
Project
Extensions
store
Project
Element
store
Topic
Element
authenticate
Bcf
Export
Controller
Bcf
Project
Model
Bcf
Topic
Model
Bcf
Viewpoint
Model
Bcf
Bitmap
Bcf
Clipping
Plane
Bcf
Coloring
Bcf
Component
Bcf
Components
Bcf
Direction
Bcf
Line
Bcf
Orthogonal
Camera
Bcf
Perspective
Camera
Bcf
Point
Bcf
Snapshot
Bcf
View
Setup
Hints
Bcf
Visibility
Bcf
Comment
Actions
Bcf
Project
Actions
Bcf
Topic
Actions
Bcf
Auth
Controller
Bcf
Comment
Actions
Options
Bcf
Comment
Controller
Bcf
Project
Actions
Options
Bcf
Project
Controller
Bcf
Routes
Bcf
Topic
Actions
Options
Bcf
Topic
Controller
Bcf
Topic
Label
Options
Bcf
Topic
Priority
Options
Bcf
Topic
Snippet
Type
Options
Bcf
Topic
Stage
Options
Bcf
Topic
Status
Options
Bcf
Topic
Types
Options
Bcf
User
Controller
Bcf
Version
Controller
Bcf
Viewpoint
Controller
Generated using
TypeDoc