io.micronaut.chatbots.core.ChatbotsConfiguration Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of micronaut-chatbots-core Show documentation

Ease the creation of Telegram, Google Chat, Discord chatbots with the Micronaut Framework

There is a newer version: 2.0.0-M6

Show newest version

/*
 * Copyright 2017-2022 original authors
 *
 * 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 io.micronaut.chatbots.core;

import io.micronaut.core.annotation.NonNull;
import io.micronaut.core.annotation.Nullable;
import io.micronaut.core.util.Toggleable;

import java.util.List;

/**
 * @author Sergio del Amo
 * @since 1.0.0
 */
public interface ChatbotsConfiguration extends Toggleable {
    /**
     * The prefix for chatbots configuration.
     */
    String PREFIX = "micronaut.chatbots";

    /**
     * @return the command file extensions candidates for static resource. For a command such as {@code /help} and extensions HTML and MARKDOWN, possible files are  {@code help.md}, {@code help.markdown}, and {@code help.html}
     */
    @Nullable
    List getPossibleStaticCommandExtensions();

    /**
     * @return The resources' folder where static commands should be searched for.
     */
    @NonNull
    String getFolder();

}