Documentation / joplin-api / EventApi
Class: EventApi
Link
https://joplinapp.org/api/references/rest_api/#events
Constructors
new EventApi()
new EventApi(
ajax):EventApi
Parameters
• ajax: Ajax
Returns
Defined in
Methods
get()
Link
https://joplinapp.org/api/references/rest_api/#get-events-id
Param
get(id)
get(
id):Promise<EventGetRes>
Parameters
• id: number
Returns
Promise<EventGetRes>
Link
https://joplinapp.org/api/references/rest_api/#get-events-id
Param
Defined in
get(id, fields)
get<
K>(id,fields):Promise<Pick<EventProperties,K> &CommonType>
Type Parameters
• K extends keyof EventProperties
Parameters
• id: number
• fields: K[]
Returns
Promise<Pick<EventProperties, K> & CommonType>
Link
https://joplinapp.org/api/references/rest_api/#get-events-id
Param
Defined in
list()
Link
https://joplinapp.org/api/references/rest_api/#get-events
Param
list(param)
list(
param?):Promise<PageRes<EventListRes> &object>
Parameters
• param?
• param.cursor?: string
Returns
Promise<PageRes<EventListRes> & object>
Link
https://joplinapp.org/api/references/rest_api/#get-events
Param
Defined in
list(param)
list<
K>(param):Promise<PageRes<Pick<EventProperties,K>> &object>
Type Parameters
• K extends keyof EventProperties
Parameters
• param
• param.cursor?: string
• param.fields: K[]
Returns
Promise<PageRes<Pick<EventProperties, K>> & object>
Link
https://joplinapp.org/api/references/rest_api/#get-events