| author | Da Risk <da_risk@geekorum.com> |
| Mon, 15 Sep 2025 14:00:07 -0400 | |
| changeset 1370 | 13e39ef920a8 |
| parent 1174 | 731f6ee517b6 |
| permissions | -rw-r--r-- |
|
137
5464f07a306c
Update copyright headers for 2019
Da Risk <da_risk@geekorum.com>
parents:
113
diff
changeset
|
1 |
/* |
| 0 | 2 |
* Geekttrss is a RSS feed reader application on the Android Platform. |
3 |
* |
|
| 1370 | 4 |
* Copyright (C) 2017-2025 by Frederic-Charles Barthelery. |
| 0 | 5 |
* |
6 |
* This file is part of Geekttrss. |
|
7 |
* |
|
8 |
* Geekttrss is free software: you can redistribute it and/or modify |
|
9 |
* it under the terms of the GNU General Public License as published by |
|
10 |
* the Free Software Foundation, either version 3 of the License, or |
|
11 |
* (at your option) any later version. |
|
12 |
* |
|
13 |
* Geekttrss is distributed in the hope that it will be useful, |
|
14 |
* but WITHOUT ANY WARRANTY; without even the implied warranty of |
|
15 |
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the |
|
16 |
* GNU General Public License for more details. |
|
17 |
* |
|
18 |
* You should have received a copy of the GNU General Public License |
|
19 |
* along with Geekttrss. If not, see <http://www.gnu.org/licenses/>. |
|
20 |
*/ |
|
|
754
a138890f66f0
webapi: update dependencies and fix some warnings
Da Risk <da_risk@geekorum.com>
parents:
750
diff
changeset
|
21 |
@file:OptIn(ExperimentalSerializationApi::class) |
|
310
bd0611482474
Extract tinyrss web api to a new module "webapi"
Da Risk <da_risk@geekorum.com>
parents:
300
diff
changeset
|
22 |
package com.geekorum.ttrss.webapi.model |
| 0 | 23 |
|
24 |
import androidx.annotation.Keep |
|
|
754
a138890f66f0
webapi: update dependencies and fix some warnings
Da Risk <da_risk@geekorum.com>
parents:
750
diff
changeset
|
25 |
import kotlinx.serialization.ExperimentalSerializationApi |
| 0 | 26 |
import kotlinx.serialization.SerialName |
27 |
import kotlinx.serialization.Serializable |
|
28 |
||
29 |
/** |
|
30 |
* The payload gor a getHeadlines request. |
|
31 |
* |
|
32 |
* It allows to retrieve articles from the Tiny Tiny Rss server. |
|
33 |
*/ |
|
34 |
@Keep |
|
35 |
@Serializable |
|
36 |
data class GetArticlesRequestPayload( |
|
37 |
@SerialName("feed_id")
|
|
38 |
val feedId: Long, |
|
39 |
||
40 |
@SerialName("view_mode")
|
|
41 |
val viewMode: ViewMode = ViewMode.ALL_ARTICLES, |
|
42 |
||
43 |
@SerialName("show_content")
|
|
44 |
val showContent: Boolean = true, |
|
45 |
||
46 |
@SerialName("show_excerpt")
|
|
47 |
val showExcerpt: Boolean = true, |
|
48 |
||
|
624
cd636ef89d05
webapi: Allow to request headline attachments
Da Risk <da_risk@geekorum.com>
parents:
611
diff
changeset
|
49 |
@SerialName("include_attachments")
|
|
cd636ef89d05
webapi: Allow to request headline attachments
Da Risk <da_risk@geekorum.com>
parents:
611
diff
changeset
|
50 |
val includeAttachments: Boolean = false, |
|
cd636ef89d05
webapi: Allow to request headline attachments
Da Risk <da_risk@geekorum.com>
parents:
611
diff
changeset
|
51 |
|
| 0 | 52 |
private val skip: Int = 0, |
53 |
||
54 |
@SerialName("since_id")
|
|
55 |
val sinceId: Long = 0, |
|
56 |
||
57 |
val limit: Int = 200, |
|
58 |
||
59 |
@SerialName("order_by")
|
|
60 |
val orderBy: SortOrder = SortOrder.NOTHING |
|
61 |
) : LoggedRequestPayload() {
|
|
62 |
||
63 |
@SerialName("op")
|
|
64 |
override val operation = "getHeadlines" |
|
65 |
||
|
600
c9d6a339dd04
build: update some androidx dependencies
Da Risk <da_risk@geekorum.com>
parents:
565
diff
changeset
|
66 |
@Serializable |
| 0 | 67 |
enum class ViewMode {
|
68 |
@SerialName("all_articles")
|
|
69 |
ALL_ARTICLES, |
|
70 |
@SerialName("unread")
|
|
71 |
UNREAD, |
|
72 |
@SerialName("adaptive")
|
|
73 |
ADAPTIVE, |
|
74 |
@SerialName("marked")
|
|
75 |
MARKED, |
|
76 |
@SerialName("updated")
|
|
77 |
UPDATED |
|
78 |
} |
|
79 |
||
|
600
c9d6a339dd04
build: update some androidx dependencies
Da Risk <da_risk@geekorum.com>
parents:
565
diff
changeset
|
80 |
@Serializable |
| 0 | 81 |
enum class SortOrder {
|
82 |
@SerialName("title")
|
|
83 |
TITLE, |
|
84 |
@SerialName("date_reverse")
|
|
85 |
DATE_REVERSE, |
|
86 |
@SerialName("feed_dates")
|
|
87 |
FEED_DATES, |
|
88 |
@SerialName("")
|
|
89 |
NOTHING |
|
90 |
} |
|
91 |
} |
|
92 |
||
93 |
||
94 |
/** |
|
95 |
* Request payload to update an Article. |
|
96 |
*/ |
|
97 |
@Keep |
|
98 |
@Serializable |
|
99 |
data class UpdateArticleRequestPayload( |
|
100 |
@SerialName("article_ids")
|
|
101 |
val articleIds: String, |
|
102 |
val mode: Int, |
|
103 |
val field: Int, |
|
104 |
val data: String? = null |
|
105 |
) : LoggedRequestPayload() {
|
|
106 |
||
107 |
@SerialName("op")
|
|
108 |
override val operation = "updateArticle" |
|
109 |
} |
|
110 |
||
111 |
/** |
|
112 |
* The response of an update article request. |
|
113 |
*/ |
|
114 |
@Keep |
|
|
1135
5dd06d1fbe83
webapi: rework serialization to use Content based polymorphic deserialization
Da Risk <da_risk@geekorum.com>
parents:
943
diff
changeset
|
115 |
@Serializable |
| 0 | 116 |
data class UpdateArticleResponsePayload( |
117 |
@SerialName("seq")
|
|
118 |
override val sequence: Int? = null, |
|
119 |
override val status: Int = 0, |
|
|
1135
5dd06d1fbe83
webapi: rework serialization to use Content based polymorphic deserialization
Da Risk <da_risk@geekorum.com>
parents:
943
diff
changeset
|
120 |
@Serializable(with = ContentSerializer::class) |
|
5dd06d1fbe83
webapi: rework serialization to use Content based polymorphic deserialization
Da Risk <da_risk@geekorum.com>
parents:
943
diff
changeset
|
121 |
override val content: BaseContent |
| 0 | 122 |
) : ResponsePayload<UpdateArticleResponsePayload.Content>() {
|
123 |
||
|
1135
5dd06d1fbe83
webapi: rework serialization to use Content based polymorphic deserialization
Da Risk <da_risk@geekorum.com>
parents:
943
diff
changeset
|
124 |
val updated: Int |
|
5dd06d1fbe83
webapi: rework serialization to use Content based polymorphic deserialization
Da Risk <da_risk@geekorum.com>
parents:
943
diff
changeset
|
125 |
get() = typedContent?.updated ?: 0 |
| 0 | 126 |
|
127 |
@Serializable |
|
128 |
data class Content( |
|
129 |
val status: String? = null, |
|
130 |
val updated: Int? = null, |
|
|
1135
5dd06d1fbe83
webapi: rework serialization to use Content based polymorphic deserialization
Da Risk <da_risk@geekorum.com>
parents:
943
diff
changeset
|
131 |
): BaseContent |
| 0 | 132 |
|
|
1135
5dd06d1fbe83
webapi: rework serialization to use Content based polymorphic deserialization
Da Risk <da_risk@geekorum.com>
parents:
943
diff
changeset
|
133 |
object ContentSerializer : BaseContentSerializer(Content.serializer()) |
| 0 | 134 |
} |