Vikunja.API.Subscriptions

Operations

Subscriptions

notificationsGet

notificationsGet :: VikunjaRequest NotificationsGet MimeNoContent [NotificationsDatabaseNotification] MimeJSON

GET /notifications

Get all notifications for the current user

Returns an array with all notifications for the current user.

AuthMethod: AuthApiKeyJWTKeyAuth

data NotificationsGet

Instances

Produces NotificationsGet MimeJSON

application/json

Defined in Vikunja.API.Subscriptions

HasOptionalParam NotificationsGet PerPage

Optional Param "per_page" - The maximum number of items per page. Note this parameter is limited by the configured maximum of items per page.

Defined in Vikunja.API.Subscriptions

Methods

applyOptionalParam :: VikunjaRequest NotificationsGet contentType res accept -> PerPage -> VikunjaRequest NotificationsGet contentType res accept

(-&-) :: VikunjaRequest NotificationsGet contentType res accept -> PerPage -> VikunjaRequest NotificationsGet contentType res accept

HasOptionalParam NotificationsGet Page

Optional Param "page" - The page number. Used for pagination. If not provided, the first page of results is returned.

Defined in Vikunja.API.Subscriptions

Methods

applyOptionalParam :: VikunjaRequest NotificationsGet contentType res accept -> Page -> VikunjaRequest NotificationsGet contentType res accept

(-&-) :: VikunjaRequest NotificationsGet contentType res accept -> Page -> VikunjaRequest NotificationsGet contentType res accept

notificationsIdPost

notificationsIdPost

Arguments

:: Id

"id" - Notification ID

-> VikunjaRequest NotificationsIdPost MimeNoContent ModelsDatabaseNotifications MimeJSON

POST /notifications/{id}

Mark a notification as (un-)read

Marks a notification as either read or unread. A user can only mark their own notifications as read.

AuthMethod: AuthApiKeyJWTKeyAuth

data NotificationsIdPost

Instances

Produces NotificationsIdPost MimeJSON

application/json

Defined in Vikunja.API.Subscriptions

subscriptionsEntityEntityIDDelete

subscriptionsEntityEntityIDDelete

Arguments

:: Entity

"entity" - The entity the user subscribed to. Can be either project or task.

-> EntityId

"entityId" - The numeric id of the subscribed entity to.

-> VikunjaRequest SubscriptionsEntityEntityIDDelete MimeNoContent ModelsSubscription MimeJSON

DELETE /subscriptions/{entity}/{entityID}

Unsubscribe the current user from an entity.

Unsubscribes the current user to an entity.

AuthMethod: AuthApiKeyJWTKeyAuth

data SubscriptionsEntityEntityIDDelete

Instances

Produces SubscriptionsEntityEntityIDDelete MimeJSON

application/json

Defined in Vikunja.API.Subscriptions

subscriptionsEntityEntityIDPut

subscriptionsEntityEntityIDPut

Arguments

:: Entity

"entity" - The entity the user subscribes to. Can be either project or task.

-> EntityId

"entityId" - The numeric id of the entity to subscribe to.

-> VikunjaRequest SubscriptionsEntityEntityIDPut MimeNoContent ModelsSubscription MimeJSON

PUT /subscriptions/{entity}/{entityID}

Subscribes the current user to an entity.

Subscribes the current user to an entity.

AuthMethod: AuthApiKeyJWTKeyAuth

data SubscriptionsEntityEntityIDPut

Instances

Produces SubscriptionsEntityEntityIDPut MimeJSON

application/json

Defined in Vikunja.API.Subscriptions