org.theta4j.webapi.ListFiles.kt Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of theta-web-api Show documentation

Client implementation of RICOH THETA API.

The newest version!

/*
 * Copyright (C) 2022 theta4j project
 *
 * 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://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.theta4j.webapi

import kotlinx.serialization.SerialName
import kotlinx.serialization.Serializable
import org.theta4j.osc.URISerializer
import java.net.URI

object ListFiles {
    @Serializable
    data class Parameter(
            val fileType: FileType,

            val entryCount: Int,

            val maxThumbSize: Int,

            val startPosition: Int? = null,

            @Serializable(URISerializer::class)
            @SerialName("_startFileUrl")
            val startFileUrl: URI? = null,

            @SerialName("_detail")
            val detail: Boolean? = null,

            @SerialName("_sort")
            val sortOrder: SortOrder? = null,
    )

    @Serializable
    data class Result internal constructor(
            val entries: List,
            val totalEntries: Int,
    )

    @Serializable
    @JvmInline
    value class FileType private constructor(private val value: String) {
        companion object {
            val ALL = FileType("all")

            val IMAGE = FileType("image")

            val VIDEO = FileType("video")
        }
    }

    @Serializable
    @JvmInline
    value class SortOrder private constructor(private val value: String) {
        companion object {
            val NEWEST = SortOrder("newest")

            val OLDEST = SortOrder("oldest")
        }
    }
}