-
Notifications
You must be signed in to change notification settings - Fork 0
/
ForumLists.kt
45 lines (43 loc) · 1.71 KB
/
ForumLists.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
/**
* 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
*
* 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.request
import io.ktor.client.request.get
import io.ktor.client.statement.bodyAsText
import io.ktor.http.appendPathSegments
import org.audux.bgg.BggClient
import org.audux.bgg.common.ForumListType
import org.audux.bgg.response.Family
import org.audux.bgg.response.ForumList
import org.audux.bgg.response.Response
import org.audux.bgg.response.Thing
/**
* Retrieves the list of available forums for the given id / type combination. e.g. Retrieve all the
* available forums for `[id=342942, type=thing]` i.e. Ark nova.
*
* @param id The id of either the Family or Thing to retrieve
* @param type Single [ForumListType] to retrieve, either a [Thing] or [Family]
*/
fun BggClient.forumList(id: Int, type: ForumListType) = request {
client
.get(Constants.XML2_API_URL) {
url {
appendPathSegments(Constants.PATH_FORUM_LIST)
parameters.apply {
append(Constants.PARAM_ID, id.toString())
append(Constants.PARAM_TYPE, type.param)
}
}
}
.let { Response.from<ForumList>(it.bodyAsText(), mapper) }
}