io.github.ydwk.yde.entities.Sticker.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.sticker.StickerFormatType
import io.github.ydwk.yde.entities.sticker.StickerType
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

/** This class is used to represent a discord sticker object. */
interface Sticker : GenericEntity, SnowFlake, NameAbleEntity {
    /**
     * The ID of the pack this sticker is from.
     *
     * @return The ID of the pack this sticker is from.
     */
    val packId: GetterSnowFlake?

    /**
     * The description of this sticker.
     *
     * @return The description of this sticker.
     */
    var description: String?

    /**
     * The autocomplete/suggestion tags for the sticker (max 200 characters).
     *
     * @return The autocomplete/suggestion tags for the sticker (max 200 characters).
     */
    var tags: List

    /**
     * The type of sticker.
     *
     * @return The type of sticker.
     */
    var type: StickerType

    /**
     * The format type of sticker.
     *
     * @return The format type of sticker.
     */
    var formatType: StickerFormatType

    /**
     * Gets weather this sticker can be used, may be false due to loss of Server Boosts.
     *
     * @return weather this sticker can be used, may be false due to loss of Server Boosts.
     */
    var available: Boolean

    /**
     * The guild id that owns this sticker.
     *
     * @return The guild id that owns this sticker.
     */
    val guildId: GetterSnowFlake?

    /**
     * The user that uploaded the sticker.
     *
     * @return The user that uploaded the sticker.
     */
    var user: User?

    /**
     * The standard sticker's sort order within its pack.
     *
     * @return The standard sticker's sort order within its pack
     */
    var sortvarue: Int?
}