jamespot-user-api
Preparing search index...
JCalendarApi
Class JCalendarApi
Hierarchy (
View Summary
)
JBaseApi
JCalendarApi
Index
Constructors
constructor
Properties
j
Api
network
Methods
get
Events
get
Last
Events
list
Events
revive
Submit
transform
Occurrence
Into
Event
Constructors
constructor
new
JCalendarApi
(
jApi
:
JamespotUserApi
)
:
JCalendarApi
Parameters
jApi
:
JamespotUserApi
Returns
JCalendarApi
Properties
j
Api
jApi
:
JamespotUserApi
network
network
:
Network
Methods
get
Events
getEvents
(
params
:
{
end
?:
string
;
idArticle
?:
number
;
idSpot
?:
number
;
mode
?:
"user"
|
"spot"
;
start
?:
string
;
}
,
)
:
Promise
<
ApiWrapper
<
{
backgroundColor
?:
string
;
bgColor
?:
string
;
color
?:
string
;
end
:
string
;
idArticle
:
number
;
start
:
string
;
subscribe
:
boolean
;
textColor
?:
string
;
title
:
string
;
url
:
string
;
}
[]
,
BaseMessages
,
>
,
>
Parameters
params
:
{
end
?:
string
;
idArticle
?:
number
;
idSpot
?:
number
;
mode
?:
"user"
|
"spot"
;
start
?:
string
;
}
Returns
Promise
<
ApiWrapper
<
{
backgroundColor
?:
string
;
bgColor
?:
string
;
color
?:
string
;
end
:
string
;
idArticle
:
number
;
start
:
string
;
subscribe
:
boolean
;
textColor
?:
string
;
title
:
string
;
url
:
string
;
}
[]
,
BaseMessages
,
>
,
>
Deprecated
Use
getEventsV2
instead.
get
Last
Events
getLastEvents
(
params
:
{
format
?:
Format
;
limit
?:
number
;
page
?:
number
;
uriContext
?:
string
;
}
,
)
:
Promise
<
ApiWrapper
<
CalendarCombinedEventsList
[]
,
BaseMessages
>
>
Parameters
params
:
{
format
?:
Format
;
limit
?:
number
;
page
?:
number
;
uriContext
?:
string
}
Returns
Promise
<
ApiWrapper
<
CalendarCombinedEventsList
[]
,
BaseMessages
>
>
list
Events
listEvents
<
T
extends
CalendarEventList
=
CalendarEventList
>
(
params
:
{
dateEnd
:
string
;
dateStart
:
string
;
spotId
?:
number
;
statuses
?:
(
"subscribed"
|
"unanswered"
|
"refused"
)
[]
;
types
?:
string
[]
;
}
,
options
?:
{
format
?:
"raw-little"
|
"raw-list"
|
"raw-view"
;
signal
?:
AbortSignal
;
}
,
)
:
Promise
<
ApiWrapper
<
CalendarEventWithExtensions
<
T
,
[
"socialEventRecord"
,
"recurringEventRecord"
]
,
>
[]
,
BaseMessages
,
>
,
>
Type Parameters
T
extends
CalendarEventList
=
CalendarEventList
Parameters
params
:
{
dateEnd
:
string
;
dateStart
:
string
;
spotId
?:
number
;
statuses
?:
(
"subscribed"
|
"unanswered"
|
"refused"
)
[]
;
types
?:
string
[]
;
}
Optional
options
:
{
format
?:
"raw-little"
|
"raw-list"
|
"raw-view"
;
signal
?:
AbortSignal
}
Returns
Promise
<
ApiWrapper
<
CalendarEventWithExtensions
<
T
,
[
"socialEventRecord"
,
"recurringEventRecord"
]
,
>
[]
,
BaseMessages
,
>
,
>
revive
Submit
reviveSubmit
(
params
:
{
idArticle
:
number
;
list
:
|
"unit"
|
"onSpot"
|
"visio"
|
"available"
|
"unavailable"
|
"presence"
|
"refused"
|
"all"
|
"waiting"
;
text
:
string
;
userURI
?:
string
;
}
,
)
:
Promise
<
ApiWrapper
<
boolean
,
BaseMessages
>
>
Parameters
params
:
{
idArticle
:
number
;
list
:
|
"unit"
|
"onSpot"
|
"visio"
|
"available"
|
"unavailable"
|
"presence"
|
"refused"
|
"all"
|
"waiting"
;
text
:
string
;
userURI
?:
string
;
}
Returns
Promise
<
ApiWrapper
<
boolean
,
BaseMessages
>
>
transform
Occurrence
Into
Event
transformOccurrenceIntoEvent
<
P
extends
{
address
?:
string
|
null
;
allDay
?:
boolean
;
bgColor
?:
string
|
null
;
dateEnd
:
string
;
dateStart
:
string
;
description
?:
string
;
hideFromCalendar
?:
boolean
;
noGestion
?:
boolean
;
place
?:
string
|
null
;
publishTo
?:
string
;
socialEventCeiling
?:
number
|
null
;
socialEventUseCeiling
?:
boolean
;
textColor
?:
string
|
null
;
title
:
string
;
token
:
string
;
type
:
"socialEvent"
;
uiObjectLink
?:
string
;
urlGestion
?:
string
;
useQrcode
?:
boolean
;
}
&
{
alertAuthor
?:
"0"
|
"1"
;
idDraft
?:
number
;
sendAlert
?:
"0"
|
"1"
}
=
{
address
?:
string
|
null
;
allDay
?:
boolean
;
bgColor
?:
string
|
null
;
dateEnd
:
string
;
dateStart
:
string
;
description
?:
string
;
hideFromCalendar
?:
boolean
;
noGestion
?:
boolean
;
place
?:
string
|
null
;
publishTo
?:
string
;
socialEventCeiling
?:
number
|
null
;
socialEventUseCeiling
?:
boolean
;
textColor
?:
string
|
null
;
title
:
string
;
token
:
string
;
type
:
"socialEvent"
;
uiObjectLink
?:
string
;
urlGestion
?:
string
;
useQrcode
?:
boolean
;
}
&
{
alertAuthor
?:
"0"
|
"1"
;
idDraft
?:
number
;
sendAlert
?:
"0"
|
"1"
}
,
F
extends
"raw-little"
|
"raw-list"
|
"raw-view"
=
VIEW
,
E
extends
ArticleFormatsExtension
=
[
]
,
>
(
payload
:
P
&
{
hiddenOccurrenceDateTime
:
string
}
,
options
?:
{
format
?:
F
;
formatExtension
?:
E
;
signal
?:
AbortSignal
}
,
)
:
PromiseApiWrapper
<
ArticleReturn
<
F
,
"socialEvent"
,
E
>
>
Type Parameters
P
extends
{
address
?:
string
|
null
;
allDay
?:
boolean
;
bgColor
?:
string
|
null
;
dateEnd
:
string
;
dateStart
:
string
;
description
?:
string
;
hideFromCalendar
?:
boolean
;
noGestion
?:
boolean
;
place
?:
string
|
null
;
publishTo
?:
string
;
socialEventCeiling
?:
number
|
null
;
socialEventUseCeiling
?:
boolean
;
textColor
?:
string
|
null
;
title
:
string
;
token
:
string
;
type
:
"socialEvent"
;
uiObjectLink
?:
string
;
urlGestion
?:
string
;
useQrcode
?:
boolean
;
}
&
{
alertAuthor
?:
"0"
|
"1"
;
idDraft
?:
number
;
sendAlert
?:
"0"
|
"1"
}
=
{
address
?:
string
|
null
;
allDay
?:
boolean
;
bgColor
?:
string
|
null
;
dateEnd
:
string
;
dateStart
:
string
;
description
?:
string
;
hideFromCalendar
?:
boolean
;
noGestion
?:
boolean
;
place
?:
string
|
null
;
publishTo
?:
string
;
socialEventCeiling
?:
number
|
null
;
socialEventUseCeiling
?:
boolean
;
textColor
?:
string
|
null
;
title
:
string
;
token
:
string
;
type
:
"socialEvent"
;
uiObjectLink
?:
string
;
urlGestion
?:
string
;
useQrcode
?:
boolean
;
}
&
{
alertAuthor
?:
"0"
|
"1"
;
idDraft
?:
number
;
sendAlert
?:
"0"
|
"1"
}
F
extends
"raw-little"
|
"raw-list"
|
"raw-view"
=
VIEW
E
extends
ArticleFormatsExtension
=
[
]
Parameters
payload
:
P
&
{
hiddenOccurrenceDateTime
:
string
}
Optional
options
:
{
format
?:
F
;
formatExtension
?:
E
;
signal
?:
AbortSignal
}
Returns
PromiseApiWrapper
<
ArticleReturn
<
F
,
"socialEvent"
,
E
>
>
Settings
Member Visibility
Protected
Inherited
External
Theme
OS
Light
Dark
On This Page
Constructors
constructor
Properties
j
Api
network
Methods
get
Events
get
Last
Events
list
Events
revive
Submit
transform
Occurrence
Into
Event
jamespot-user-api
Loading...
Deprecated
Use
getEventsV2instead.