io.github.ydwk.yde.entities.Application.kt Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of yde-api Show documentation
YDE (Yusuf's Discord Entities) API contains all the entities that are used in wrappers like YDWK.
The newest version!
/*
 * Copyright 2024 YDWK inc.
 *
 *
 * 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.github.ydwk.yde.entities

import io.github.ydwk.yde.entities.util.GenericEntity
import io.github.ydwk.yde.util.GetterSnowFlake
import io.github.ydwk.yde.util.NameAbleEntity
import io.github.ydwk.yde.util.SnowFlake
import java.net.URL

interface Application : SnowFlake, NameAbleEntity, GenericEntity {

    /**
     * The icon hash of the application.
     *
     * @return the icon hash of the application.
     */
    var icon: String?

    /**
     * The description of the application.
     *
     * @return the description of the application.
     */
    var description: String

    /**
     * An array of rpc origin urls, if rpc is enabled.
     *
     * @return an array of rpc origin urls, if rpc is enabled.
     */
    var rpcOrigins: Array?

    /**
     * If the bot can only be added by the bot owner.
     *
     * @return true if the bot can only be added by the bot owner.
     */
    var botPublic: Boolean

    /**
     * If the bot will only join upon completion of the full oauth2 code grant flow.
     *
     * @return true if the bot will only join upon completion of the full oauth2 code grant flow.
     */
    var botRequireCodeGrant: Boolean

    /**
     * The bots terms of service.
     *
     * @return the bots terms of service.
     */
    var botTermsOfService: URL?

    /**
     * The bots privacy policy.
     *
     * @return the bots privacy policy.
     */
    var botPrivacyPolicy: URL?

    /**
     * The owner of the bot.
     *
     * @return the owner of the bot.
     */
    var botOwner: User?

    /**
     * The hex encoded key for verification in interactions and the GameSDK's GetTicket.
     *
     * @return the hex encoded key for verification in interactions and the GameSDK's GetTicket.
     */
    var verifyKey: String?

    /**
     * Gets the guild id this application is for.
     *
     * @return the guild id this application is for.
     */
    var guildId: GetterSnowFlake?

    /**
     * The game sdk id of the application.
     *
     * @return the game sdk id of the application.
     */
    var gameSdkId: GetterSnowFlake?

    /**
     * The url of the slug for the application.
     *
     * @return the url of the slug for the application.
     */
    var slug: String?

    /**
     * The cover image hash of the application.
     *
     * @return the cover image hash of the application.
     */
    var coverImage: String?

    /**
     * The application's public flags.
     *
     * @return the application's public flags.
     */
    var flags: Int?

    /**
     * The application's tags.
     *
     * @return the application's tags.
     */
    var tags: Array?
}