connector.media.MediaFileDescriptor.kt Maven / Gradle / Ivy

Go to download
/*
 * Copyright (C) 2017/2021 e-voyageurs technologies
 *
 * 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 ai.tock.bot.connector.media

import ai.tock.bot.engine.BotBus
import ai.tock.bot.engine.action.SendAttachment.AttachmentType
import ai.tock.bot.engine.config.UploadedFilesService
import ai.tock.shared.Dice
import ai.tock.translator.I18nLabel
import ai.tock.translator.I18nLabelValue
import ai.tock.translator.Translator

/**
 * A file descriptor.
 */
data class MediaFileDescriptor(
    val suffix: String,
    val name: String,
    val id: String = Dice.newId(),
    val type: AttachmentType = UploadedFilesService.attachmentType(suffix),
    val externalUrl: String? = null,
    val description: I18nLabel? = null
) {

    /**
     * Creates a [MediaMessage] for the specified [BotBus].
     */
    fun toMessage(bus: BotBus): MediaFile =
        MediaFile(externalUrl ?: UploadedFilesService.botFilePath(bus, id, suffix), name, type, bus.translate(description?.let { I18nLabelValue(it) }).takeUnless { it.isBlank() })
}