@tgsnake/skema
    Preparing search index...

    Class StarsTransaction

    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 adsProceedsFromDate? adsProceedsToDate? amount botPayload? businessTransfer? className classType cls constructorId date description? extendedMedia? failed? floodskipNumber? gift? giveawayPostId? id msgId? offer? paidMessages? peer pending? phonegroupMessage? photo? postsSearch? premiumGiftMonths? reaction? refund? stargift? stargiftAuctionBid? stargiftDropOriginalDetails? stargiftPrepaidUpgrade? stargiftResale? stargiftUpgrade? starrefAmount? starrefCommissionPermille? starrefPeer? subclassOfId subscriptionPeriod? title? transactionDate? transactionUrl?

    Methods

    read toJSON toString write read write

    Constructors

    • Parameters

      • params: {
            adsProceedsFromDate?: number;
            adsProceedsToDate?: number;
            amount: TypeStarsAmount;
            botPayload?: bytes;
            businessTransfer?: boolean;
            date: number;
            description?: string;
            extendedMedia?: Raw.Vector<TypeMessageMedia>;
            failed?: boolean;
            floodskipNumber?: number;
            gift?: boolean;
            giveawayPostId?: number;
            id: string;
            msgId?: number;
            offer?: boolean;
            paidMessages?: number;
            peer: TypeStarsTransactionPeer;
            pending?: boolean;
            phonegroupMessage?: boolean;
            photo?: TypeWebDocument;
            postsSearch?: boolean;
            premiumGiftMonths?: number;
            reaction?: boolean;
            refund?: boolean;
            stargift?: TypeStarGift;
            stargiftAuctionBid?: boolean;
            stargiftDropOriginalDetails?: boolean;
            stargiftPrepaidUpgrade?: boolean;
            stargiftResale?: boolean;
            stargiftUpgrade?: boolean;
            starrefAmount?: TypeStarsAmount;
            starrefCommissionPermille?: number;
            starrefPeer?: TypePeer;
            subscriptionPeriod?: number;
            title?: string;
            transactionDate?: number;
            transactionUrl?: string;
        }

      Returns StarsTransaction

    Properties

    Internal_slots

    _slots: string[]

    The internal slot list storing serialization field property names.

    adsProceedsFromDate?: number
    adsProceedsToDate?: number
    amount: TypeStarsAmount
    botPayload?: bytes
    businessTransfer?: 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.

    date: number
    description?: string
    extendedMedia?: Raw.Vector<TypeMessageMedia>
    failed?: boolean
    floodskipNumber?: number
    gift?: boolean
    giveawayPostId?: number
    id: string
    msgId?: number
    offer?: boolean
    paidMessages?: number
    peer: TypeStarsTransactionPeer
    pending?: boolean
    phonegroupMessage?: boolean
    photo?: TypeWebDocument
    postsSearch?: boolean
    premiumGiftMonths?: number
    reaction?: boolean
    refund?: boolean
    stargift?: TypeStarGift
    stargiftAuctionBid?: boolean
    stargiftDropOriginalDetails?: boolean
    stargiftPrepaidUpgrade?: boolean
    stargiftResale?: boolean
    stargiftUpgrade?: boolean
    starrefAmount?: TypeStarsAmount
    starrefCommissionPermille?: number
    starrefPeer?: TypePeer
    subclassOfId: number

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

    subscriptionPeriod?: number
    title?: string
    transactionDate?: number
    transactionUrl?: string

    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