@tgsnake/skema
    Preparing search index...

    Class StarGiftUnique

    Base abstract class for all Type Language (TL) schema objects within the MTProto protocol.

    In the Telegram MTProto protocol, messages and API payloads are defined in a custom ID-based schema language called Type Language (TL). TLObject is the root class providing fundamental binary serialization (write) and deserialization (read) interfaces, alongside custom console print formatters and standard JSON serializers.

    Hierarchy (View Summary)

    Index

    Constructors

    constructor

    Properties

    _slots attributes availabilityIssued availabilityTotal burned? className classType cls constructorId craftChancePermille? crafted? giftAddress? giftId hostId? id num offerMinStars? ownerAddress? ownerId? ownerName? peerColor? releasedBy? requirePremium? resaleTonOnly? resellAmount? slug subclassOfId themeAvailable? themePeer? title valueAmount? valueCurrency? valueUsdAmount?

    Methods

    read toJSON toString write read write

    Constructors

    • Parameters

      • params: {
            attributes: Raw.Vector<TypeStarGiftAttribute>;
            availabilityIssued: number;
            availabilityTotal: number;
            burned?: boolean;
            craftChancePermille?: number;
            crafted?: boolean;
            giftAddress?: string;
            giftId: bigint;
            hostId?: TypePeer;
            id: bigint;
            num: number;
            offerMinStars?: number;
            ownerAddress?: string;
            ownerId?: TypePeer;
            ownerName?: string;
            peerColor?: TypePeerColor;
            releasedBy?: TypePeer;
            requirePremium?: boolean;
            resaleTonOnly?: boolean;
            resellAmount?: Raw.Vector<TypeStarsAmount>;
            slug: string;
            themeAvailable?: boolean;
            themePeer?: TypePeer;
            title: string;
            valueAmount?: bigint;
            valueCurrency?: string;
            valueUsdAmount?: bigint;
        }

      Returns StarGiftUnique

    Properties

    Internal_slots

    _slots: string[]

    The internal slot list storing serialization field property names.

    attributes: Raw.Vector<TypeStarGiftAttribute>
    availabilityIssued: number
    availabilityTotal: number
    burned?: boolean
    className: string

    The canonical string name of this class representation.

    classType: string

    The underlying classification type (e.g. request, constructor, function).

    cls: any = ...

    A dynamic reference to the current subclass constructor. Enables late static binding for instance methods to access static helper operations.

    constructorId: number

    The unique 32-bit integer identifier (CRC32 checksum) of this TL constructor.

    craftChancePermille?: number
    crafted?: boolean
    giftAddress?: string
    giftId: bigint
    hostId?: TypePeer
    id: bigint
    num: number
    offerMinStars?: number
    ownerAddress?: string
    ownerId?: TypePeer
    ownerName?: string
    peerColor?: TypePeerColor
    releasedBy?: TypePeer
    requirePremium?: boolean
    resaleTonOnly?: boolean
    resellAmount?: Raw.Vector<TypeStarsAmount>
    slug: string
    subclassOfId: number

    The unique 32-bit integer identifier of the parent/abstract type this TL subclass represents.

    themeAvailable?: boolean
    themePeer?: TypePeer
    title: string
    valueAmount?: bigint
    valueCurrency?: string
    valueUsdAmount?: bigint

    Methods

    • Deserializes a binary stream into this specific TLObject instance.

      Parameters

      • data: BytesIO

        The BytesIO buffer stream containing the serialized TLObject.

      • ...args: any[]

        Additional arguments passed down to the read parser.

      Returns Promise<any>

      A promise resolving to the parsed instance.

    • Serializes the TLObject instance to a clean JSON-compatible representation.

      Returns { [key: string]: any }

      A plain object containing class attributes and values.

      Correctly stringifies extremely large fields (e.g. bigints) that are normally not serializable in standard JSON.stringify calls.

    • Formats the TLObject into a structured string.

      Returns string

      A string starting with the constructor name followed by a pretty JSON payload.

    • Serializes constructor arguments into a raw binary buffer.

      Parameters

      • ..._args: any[]

        Arguments to be serialized.

      Returns Buffer

      An empty Buffer of size 0.

      This base implementation acts as an abstract stub returning an empty Buffer. Subclasses override this static method to handle specific binary serialization layouts.

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    Methods