discorb-lib/discorb

View on GitHub
sig/discorb/partial_emoji.rbs

Summary

Maintainability
Test Coverage
module Discorb
  #
  # Represents a partial custom emoji in discord.
  class PartialEmoji < Discorb::DiscordModel
    #
    # Initialize a new partial custom emoji.
    # @private
    #
    # @param [Hash] data The data of the emoji.
    def initialize: (Discorb::json data) -> void

    #
    # Format the emoji for URI.
    #
    # @return [String] the formatted emoji.
    %a{pure}
    def to_uri: -> String

    %a{pure}
    def inspect: -> String

    #
    # Format the emoji for sending.
    #
    # @return [String] the formatted emoji.
    %a{pure}
    def to_s: -> String

    # @return [Discorb::Snowflake] The ID of the emoji.
    attr_reader id: Discorb::Snowflake

    # @return [String] The name of the emoji.
    attr_reader name: String

    # @return [Boolean] Whether the emoji is deleted.
    attr_reader deleted: bool
  end
end