jamespot-user-api
Preparing search index...
JLandApi
Class JLandApi
Hierarchy (
View Summary
)
JBaseApi
JLandApi
Index
Constructors
constructor
Properties
j
Api
network
Methods
create
Map
get
All
Maps
As
Admin
get
Logs
get
Stats
Constructors
constructor
new
JLandApi
(
jApi
:
JamespotUserApi
)
:
JLandApi
Parameters
jApi
:
JamespotUserApi
Returns
JLandApi
Properties
j
Api
jApi
:
JamespotUserApi
network
network
:
Network
Methods
create
Map
createMap
<
T
extends
|
JLandMapLittle
|
JLandMapList
|
Omit
<
Merge
<
jArticleView
,
JLandMapList
>
,
never
>
=
JLandMapList
,
>
(
map
:
MaybeWithToken
<
{
description
?:
string
|
null
;
idSpot
?:
string
[]
;
jlandMapAggregated
:
string
;
publishTo
?:
string
;
title
?:
string
;
type
:
"jlandmap"
;
}
,
>
,
format
?:
string
,
)
:
Promise
<
ApiWrapper
<
T
[]
,
BaseMessages
>
>
Type Parameters
T
extends
JLandMapLittle
|
JLandMapList
|
Omit
<
Merge
<
jArticleView
,
JLandMapList
>
,
never
>
=
JLandMapList
Parameters
map
:
MaybeWithToken
<
{
description
?:
string
|
null
;
idSpot
?:
string
[]
;
jlandMapAggregated
:
string
;
publishTo
?:
string
;
title
?:
string
;
type
:
"jlandmap"
;
}
,
>
format
:
string
= 'raw-list'
Returns
Promise
<
ApiWrapper
<
T
[]
,
BaseMessages
>
>
get
All
Maps
As
Admin
getAllMapsAsAdmin
(
format
?:
string
,
)
:
Promise
<
ApiWrapper
<
PagingResults
<
Omit
<
jArticleList
,
|
"id"
|
"type"
|
"limit"
|
"mainType"
|
"uri"
|
"dateCreation"
|
"dateModified"
|
"title"
|
"_url"
|
"jlandMapKind"
|
"jlandMapFlavor"
|
"waMapUrl"
,
>
&
Omit
<
jArticleLittle
,
"type"
|
"limit"
|
"jlandMapKind"
|
"jlandMapFlavor"
|
"waMapUrl"
,
>
&
{
jlandMapFlavor
:
string
;
jlandMapKind
:
string
;
limit
:
number
|
null
;
type
:
"jlandmap"
;
waMapUrl
:
string
|
null
;
}
&
{
_extend
:
Pick
<
z.infer
<
typeof
extendSchema
>
,
K
[
number
]
>
}
,
>
,
BaseMessages
,
>
,
>
Parameters
format
:
string
= 'raw-list,licenses'
Returns
Promise
<
ApiWrapper
<
PagingResults
<
Omit
<
jArticleList
,
|
"id"
|
"type"
|
"limit"
|
"mainType"
|
"uri"
|
"dateCreation"
|
"dateModified"
|
"title"
|
"_url"
|
"jlandMapKind"
|
"jlandMapFlavor"
|
"waMapUrl"
,
>
&
Omit
<
jArticleLittle
,
"type"
|
"limit"
|
"jlandMapKind"
|
"jlandMapFlavor"
|
"waMapUrl"
,
>
&
{
jlandMapFlavor
:
string
;
jlandMapKind
:
string
;
limit
:
number
|
null
;
type
:
"jlandmap"
;
waMapUrl
:
string
|
null
;
}
&
{
_extend
:
Pick
<
z.infer
<
typeof
extendSchema
>
,
K
[
number
]
>
}
,
>
,
BaseMessages
,
>
,
>
get
Logs
getLogs
(
__namedParameters
:
{
dateEnd
?:
string
;
idLogMax
?:
number
}
,
)
:
Promise
<
ApiWrapper
<
JLandLog
[]
,
BaseMessages
>
>
Parameters
__namedParameters
:
{
dateEnd
?:
string
;
idLogMax
?:
number
}
Returns
Promise
<
ApiWrapper
<
JLandLog
[]
,
BaseMessages
>
>
get
Stats
getStats
(
__namedParameters
:
{
dateEnd
?:
string
;
dateStart
?:
string
;
map
:
string
}
,
)
:
Promise
<
ApiWrapper
<
JLandStat
[]
,
BaseMessages
>
>
Parameters
__namedParameters
:
{
dateEnd
?:
string
;
dateStart
?:
string
;
map
:
string
}
Returns
Promise
<
ApiWrapper
<
JLandStat
[]
,
BaseMessages
>
>
Settings
Member Visibility
Protected
Inherited
External
Theme
OS
Light
Dark
On This Page
Constructors
constructor
Properties
j
Api
network
Methods
create
Map
get
All
Maps
As
Admin
get
Logs
get
Stats
jamespot-user-api
Loading...