Search
Preparing search index...
The search index is not available
Aurelia Deco Documentation - v2.0.9
Options
All
Public
Public/Protected
All
Inherited
Menu
Aurelia Deco Documentation - v2.0.9
Model
Class Model
Hierarchy
Model
UserModel
ProfileModel
AppModel
DicoModel
DynamicConfigModel
DynamicDataModel
Index
Constructors
constructor
Properties
_created
At
_created
By
_ref
Locales
_updated
At
_updated
By
_validation
Controller
id
options
Accessors
_label
api
deco
is
Multilang
validation
Controller
api
baseroute
deco
is
Multilang
Methods
add
Locale
InSuffix
IfNecessary
delete
Route
fix
Body
IfFiles
ToUpload
get
get
File
Preview
get
File
Preview
Url
get
One
Route
get
Route
get
UxFile
Preview
Data
post
Route
put
Route
remove
save
set
un
Class
update
Instance
From
Element
update
Instance
From
Unclassed
Element
update
Properties
validate
validation
Rules
add
Locale
InSuffix
IfNecessary
delete
Route
get
All
get
All
Route
get
One
Route
get
One
With
Id
get
One
With
Query
instance
From
Api
instance
From
Element
instance
From
Unclassed
Element
post
Route
put
Route
request
Constructors
constructor
new
Model
(
)
:
Model
Returns
Model
Properties
_created
At
_created
At
:
Date
_created
By
_created
By
:
string
Optional
_ref
Locales
_ref
Locales
:
StringTMap
<
StringAnyMap
>
_updated
At
_updated
At
:
Date
_updated
By
_updated
By
:
string
Private
_validation
Controller
_validation
Controller
:
ValidationController
id
id
:
string
Static
options
options
:
ModelOptions
Accessors
_label
get
_label
(
)
:
string
Returns
string
api
get
api
(
)
:
DecoApi
Returns
DecoApi
deco
get
deco
(
)
:
Deco
Returns
Deco
is
Multilang
get
isMultilang
(
)
:
boolean
Returns
boolean
validation
Controller
get
validationController
(
)
:
ValidationController
Returns
ValidationController
Static
api
get
api
(
)
:
DecoApi
Returns
DecoApi
Static
baseroute
get
baseroute
(
)
:
string
Returns
string
Static
deco
get
deco
(
)
:
Deco
Returns
Deco
Static
is
Multilang
get
isMultilang
(
)
:
boolean
Returns
boolean
Methods
add
Locale
InSuffix
IfNecessary
add
Locale
InSuffix
IfNecessary
(
suffix
:
string
, options
?:
GetAllOptions
)
:
string
Parameters
suffix:
string
options:
GetAllOptions
= ...
Returns
string
delete
Route
delete
Route
(
elementId
:
string
)
:
string
Parameters
elementId:
string
Returns
string
fix
Body
IfFiles
ToUpload
fix
Body
IfFiles
ToUpload
(
body
:
any
, options
?:
FixBodyOptions
)
:
Promise
<
any
>
Parameters
body:
any
options:
FixBodyOptions
= ...
Returns
Promise
<
any
>
get
get
(
propertyName
:
string
)
:
any
Parameters
propertyName:
string
Returns
any
get
File
Preview
get
File
Preview
(
property
:
string
, format
:
string
, options
?:
FilePreviewOptions
)
:
Promise
<
Blob
>
Parameters
property:
string
format:
string
Optional
options:
FilePreviewOptions
Returns
Promise
<
Blob
>
get
File
Preview
Url
get
File
Preview
Url
(
property
:
string
, format
:
string
)
:
Promise
<
string
>
Parameters
property:
string
format:
string
Returns
Promise
<
string
>
get
One
Route
get
One
Route
(
elementId
:
string
)
:
string
Parameters
elementId:
string
Returns
string
get
Route
get
Route
(
)
:
string
Returns
string
get
UxFile
Preview
Data
get
UxFile
Preview
Data
(
property
:
string
, file
:
UxFileItem
, format
:
string
)
:
Promise
<
void
>
Parameters
property:
string
file:
UxFileItem
format:
string
Returns
Promise
<
void
>
post
Route
post
Route
(
)
:
string
Returns
string
put
Route
put
Route
(
elementId
:
string
)
:
string
Parameters
elementId:
string
Returns
string
remove
remove
(
suffix
?:
string
, options
?:
RemoveOptions
)
:
Promise
<
any
>
Parameters
suffix:
string
= ''
options:
RemoveOptions
= ...
Returns
Promise
<
any
>
save
save
(
suffix
?:
string
, options
?:
SaveOptions
)
:
Promise
<
any
>
Parameters
suffix:
string
= ''
options:
SaveOptions
= ...
Returns
Promise
<
any
>
set
set
(
propertyName
:
string
, value
:
any
)
:
void
Parameters
propertyName:
string
value:
any
Returns
void
un
Class
un
Class
(
)
:
any
Returns
any
update
Instance
From
Element
update
Instance
From
Element<T>
(
element
:
any
, properties
?:
string
[]
)
:
Promise
<
T
>
Type parameters
T
:
Model
<
T
>
Parameters
element:
any
Optional
properties:
string
[]
Returns
Promise
<
T
>
update
Instance
From
Unclassed
Element
update
Instance
From
Unclassed
Element<T>
(
element
:
any
, properties
?:
string
[]
)
:
T
Type parameters
T
:
Model
<
T
>
Parameters
element:
any
Optional
properties:
string
[]
Returns
T
update
Properties
update
Properties
(
suffix
?:
string
, properties
:
string
[]
, options
?:
UpdatePropertiesOptions
)
:
Promise
<
Model
>
Parameters
suffix:
string
= ''
properties:
string
[]
options:
UpdatePropertiesOptions
= ...
Returns
Promise
<
Model
>
validate
validate
(
)
:
Promise
<
boolean
>
Returns
Promise
<
boolean
>
validation
Rules
validation
Rules
(
)
:
any
Returns
any
Static
add
Locale
InSuffix
IfNecessary
add
Locale
InSuffix
IfNecessary
(
suffix
:
string
, options
?:
GetAllOptions
)
:
string
Parameters
suffix:
string
options:
GetAllOptions
= ...
Returns
string
Static
delete
Route
delete
Route
(
elementId
:
string
)
:
string
Parameters
elementId:
string
Returns
string
Static
get
All
get
All<T>
(
suffix
:
string
, options
?:
GetAllOptions
)
:
Promise
<
InstanceType
<
T
>
[]
>
Type parameters
T
:
typeof
Model
Parameters
suffix:
string
options:
GetAllOptions
= ''
Returns
Promise
<
InstanceType
<
T
>
[]
>
Static
get
All
Route
get
All
Route
(
)
:
string
Returns
string
Static
get
One
Route
get
One
Route
(
elementId
:
string
)
:
string
Parameters
elementId:
string
Returns
string
Static
get
One
With
Id
get
One
With
Id<T>
(
id
:
string
, suffix
:
string
, options
?:
GetOneOptions
)
:
Promise
<
InstanceType
<
T
>
>
Type parameters
T
:
typeof
Model
Parameters
id:
string
suffix:
string
options:
GetOneOptions
= ''
Returns
Promise
<
InstanceType
<
T
>
>
Static
get
One
With
Query
get
One
With
Query<T>
(
)
:
Promise
<
InstanceType
<
T
>
>
Type parameters
T
:
typeof
Model
Returns
Promise
<
InstanceType
<
T
>
>
Static
instance
From
Api
instance
From
Api<T>
(
element
:
any
)
:
Promise
<
InstanceType
<
T
>
>
Type parameters
T
:
typeof
Model
Parameters
element:
any
Returns
Promise
<
InstanceType
<
T
>
>
Static
instance
From
Element
instance
From
Element<T>
(
element
:
any
)
:
InstanceType
<
T
>
Type parameters
T
:
typeof
Model
Parameters
element:
any
Returns
InstanceType
<
T
>
Static
instance
From
Unclassed
Element
instance
From
Unclassed
Element<T>
(
element
:
any
)
:
InstanceType
<
T
>
Type parameters
T
:
typeof
Model
Parameters
element:
any
Returns
InstanceType
<
T
>
Static
post
Route
post
Route
(
)
:
string
Returns
string
Static
put
Route
put
Route
(
elementId
:
string
)
:
string
Parameters
elementId:
string
Returns
string
Static
request
request
(
method
:
"get"
|
"post"
|
"delete"
|
"put"
, uri
?:
string
, body
?:
any
, options
?:
RequestOption
)
:
Promise
<
Model
[]
>
Parameters
method:
"get"
|
"post"
|
"delete"
|
"put"
uri:
string
= ''
body:
any
= ...
options:
RequestOption
= ...
Returns
Promise
<
Model
[]
>
Exports
Model
constructor
_created
At
_created
By
_ref
Locales
_updated
At
_updated
By
_validation
Controller
id
options
_label
api
deco
is
Multilang
validation
Controller
api
baseroute
deco
is
Multilang
add
Locale
InSuffix
IfNecessary
delete
Route
fix
Body
IfFiles
ToUpload
get
get
File
Preview
get
File
Preview
Url
get
One
Route
get
Route
get
UxFile
Preview
Data
post
Route
put
Route
remove
save
set
un
Class
update
Instance
From
Element
update
Instance
From
Unclassed
Element
update
Properties
validate
validation
Rules
add
Locale
InSuffix
IfNecessary
delete
Route
get
All
get
All
Route
get
One
Route
get
One
With
Id
get
One
With
Query
instance
From
Api
instance
From
Element
instance
From
Unclassed
Element
post
Route
put
Route
request
Generated using
TypeDoc