-
Notifications
You must be signed in to change notification settings - Fork 0
/
Forum.kt
95 lines (80 loc) · 3.69 KB
/
Forum.kt
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
/**
* Copyright 2023-2024 Bram Wijnands
*
* Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except
* in compliance with the License. You may obtain a copy of the License at
*
* http:https://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software distributed under the License
* is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express
* or implied. See the License for the specific language governing permissions and limitations under
* the License.
*/
package org.audux.bgg.response
import com.fasterxml.jackson.annotation.JsonFormat
import com.fasterxml.jackson.annotation.JsonRootName
import com.fasterxml.jackson.databind.annotation.JsonDeserialize
import com.fasterxml.jackson.dataformat.xml.annotation.JacksonXmlElementWrapper
import com.fasterxml.jackson.dataformat.xml.annotation.JacksonXmlProperty
import java.time.LocalDateTime
import kotlinx.serialization.Serializable
/**
* Encapsulates a forum containing a list of thread summaries - these can be retrieve using in
* [org.audux.bgg.request.thread] endpoint.
*/
@JsonRootName("forum")
@Serializable
data class Forum(
/** Terms of use of the BGG API. */
@JacksonXmlProperty(isAttribute = true) val termsOfUse: String,
/** Unique ID that can be used to look up more information using the forum endpoint. */
@JacksonXmlProperty(isAttribute = true) val id: Int,
/** Whether posting is allowed or not. */
@JsonDeserialize(using = NumberToBooleanDeserializer::class)
@JacksonXmlProperty(isAttribute = true)
val noPosting: Boolean,
/** Title/Name of the forum. */
@JsonDeserialize(using = TrimmedStringDeserializer::class)
@JacksonXmlProperty(isAttribute = true)
val title: String,
/** The number of threads that are active/created in the forum. */
@JacksonXmlProperty(isAttribute = true) val numThreads: Int,
/** Total number of posts in the forum spread over the threads. */
@JacksonXmlProperty(isAttribute = true) val numPosts: Int,
/** The date and time a post was last made. */
@JsonFormat(pattern = "E, dd MMM yyyy HH:mm:ss Z")
@JacksonXmlProperty(isAttribute = true)
@Serializable(with = LocalDateTimeSerializer::class)
val lastPostDate: LocalDateTime?,
/** The list of threads in this forum. */
@JacksonXmlElementWrapper(localName = "threads") val threads: List<ThreadSummary> = listOf(),
)
/**
* Summary of a thread in the forum, contains some stats and aggregated data but no articles/posts.
*/
@Serializable
data class ThreadSummary(
/** Unique ID that can be used to look up more information using the thread endpoint. */
@JacksonXmlProperty(isAttribute = true) val id: Int,
/** Title/Subject of the thread. */
@JsonDeserialize(using = TrimmedStringDeserializer::class)
@JacksonXmlProperty(isAttribute = true)
val subject: String,
/** Username of the thread creator. */
@JsonDeserialize(using = TrimmedStringDeserializer::class)
@JacksonXmlProperty(isAttribute = true)
val author: String,
/** The number of posts/articles in this thread. */
@JacksonXmlProperty(isAttribute = true) val numArticles: Int,
/** The date and time this thread was created. */
@JsonFormat(pattern = "E, dd MMM yyyy HH:mm:ss Z")
@JacksonXmlProperty(isAttribute = true)
@Serializable(with = LocalDateTimeSerializer::class)
val postDate: LocalDateTime?,
/** The date and time a post was last made in this thread. */
@JsonFormat(pattern = "E, dd MMM yyyy HH:mm:ss Z")
@JacksonXmlProperty(isAttribute = true)
@Serializable(with = LocalDateTimeSerializer::class)
val lastPostDate: LocalDateTime?,
)