@tgsnake/skema
    Preparing search index...

    Class UserFull

    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

    • Parameters

      • params: {
            about?: string;
            birthday?: Birthday;
            blocked?: boolean;
            blockedMyStoriesFrom?: boolean;
            botBroadcastAdminRights?: ChatAdminRights;
            botCanManageEmojiStatus?: boolean;
            botGroupAdminRights?: ChatAdminRights;
            botInfo?: Raw.BotInfo;
            botManagerId?: bigint;
            botVerification?: BotVerification;
            businessAwayMessage?: BusinessAwayMessage;
            businessGreetingMessage?: BusinessGreetingMessage;
            businessIntro?: BusinessIntro;
            businessLocation?: BusinessLocation;
            businessWorkHours?: BusinessWorkHours;
            canPinMessage?: boolean;
            canViewRevenue?: boolean;
            commonChatsCount: number;
            contactRequirePremium?: boolean;
            disallowedGifts?: DisallowedGiftsSettings;
            displayGiftsButton?: boolean;
            fallbackPhoto?: Raw.TypePhoto;
            folderId?: number;
            hasScheduled?: boolean;
            id: bigint;
            mainTab?: TypeProfileTab;
            noforwardsMyEnabled?: boolean;
            noforwardsPeerEnabled?: boolean;
            note?: TextWithEntities;
            notifySettings: PeerNotifySettings;
            personalChannelId?: bigint;
            personalChannelMessage?: number;
            personalPhoto?: Raw.TypePhoto;
            phoneCallsAvailable?: boolean;
            phoneCallsPrivate?: boolean;
            pinnedMsgId?: number;
            privateForwardName?: string;
            profilePhoto?: Raw.TypePhoto;
            readDatesPrivate?: boolean;
            savedMusic?: TypeDocument;
            sendPaidMessagesStars?: bigint;
            settings: Raw.PeerSettings;
            sponsoredEnabled?: boolean;
            stargiftsCount?: number;
            starrefProgram?: StarRefProgram;
            starsMyPendingRating?: StarsRating;
            starsMyPendingRatingDate?: number;
            starsRating?: StarsRating;
            stories?: Raw.PeerStories;
            storiesPinnedAvailable?: boolean;
            theme?: TypeChatTheme;
            translationsDisabled?: boolean;
            ttlPeriod?: number;
            unofficialSecurityRisk?: boolean;
            videoCallsAvailable?: boolean;
            voiceMessagesForbidden?: boolean;
            wallpaper?: TypeWallPaper;
            wallpaperOverridden?: boolean;
        }

      Returns Raw.UserFull

    Properties

    _slots: string[]

    The internal slot list storing serialization field property names.

    about?: string
    birthday?: Birthday
    blocked?: boolean
    blockedMyStoriesFrom?: boolean
    botBroadcastAdminRights?: ChatAdminRights
    botCanManageEmojiStatus?: boolean
    botGroupAdminRights?: ChatAdminRights
    botInfo?: Raw.BotInfo
    botManagerId?: bigint
    botVerification?: BotVerification
    businessAwayMessage?: BusinessAwayMessage
    businessGreetingMessage?: BusinessGreetingMessage
    businessIntro?: BusinessIntro
    businessLocation?: BusinessLocation
    businessWorkHours?: BusinessWorkHours
    canPinMessage?: boolean
    canViewRevenue?: 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.

    commonChatsCount: number
    constructorId: number

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

    contactRequirePremium?: boolean
    disallowedGifts?: DisallowedGiftsSettings
    displayGiftsButton?: boolean
    fallbackPhoto?: Raw.TypePhoto
    folderId?: number
    hasScheduled?: boolean
    id: bigint
    mainTab?: TypeProfileTab
    noforwardsMyEnabled?: boolean
    noforwardsPeerEnabled?: boolean
    notifySettings: PeerNotifySettings
    personalChannelId?: bigint
    personalChannelMessage?: number
    personalPhoto?: Raw.TypePhoto
    phoneCallsAvailable?: boolean
    phoneCallsPrivate?: boolean
    pinnedMsgId?: number
    privateForwardName?: string
    profilePhoto?: Raw.TypePhoto
    readDatesPrivate?: boolean
    savedMusic?: TypeDocument
    sendPaidMessagesStars?: bigint
    settings: Raw.PeerSettings
    sponsoredEnabled?: boolean
    stargiftsCount?: number
    starrefProgram?: StarRefProgram
    starsMyPendingRating?: StarsRating
    starsMyPendingRatingDate?: number
    starsRating?: StarsRating
    stories?: Raw.PeerStories
    storiesPinnedAvailable?: boolean
    subclassOfId: number

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

    translationsDisabled?: boolean
    ttlPeriod?: number
    unofficialSecurityRisk?: boolean
    videoCallsAvailable?: boolean
    voiceMessagesForbidden?: boolean
    wallpaper?: TypeWallPaper
    wallpaperOverridden?: boolean

    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.

    • Generate the TLObject from buffer.

      Parameters

      • _data: BytesIO

        BytesIO class from TLObject will be convert to TLObject class.

      • ..._args: any[]

      Returns Promise<Raw.UserFull>

    • 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.