GiftEvent

GiftEvent.

Signature

class GiftEvent(BaseEvent, WebcastGiftMessage)

Attributes

• common (Optional[CommonMessageData])
• gift_id (int)
• fan_ticket_count (int)
• group_count (int)
• repeat_count (int)
• combo_count (int)
• repeat_end (int)
• text_effect (Optional[TextEffect])
• group_id (int)
• income_taskgifts (int)
• room_fan_ticket_count (int)
• priority (Optional[GiftImPriority])
• log_id (str)
• send_type (int)
• public_area_common (Optional[PublicAreaCommon])
• tray_display_text (Optional[Text])
• banned_display_effects (int)
• tray_info (Optional[GiftTrayInfo])
• monitor_extra (str)
• monitor_info (Optional[GiftMonitorInfo])
• color_id (int)
• is_first_sent (bool)
• display_text_for_anchor (Optional[Text])
• display_text_for_audience (Optional[Text])
• order_id (str)
• gifts_in_box (Optional[GiftsBoxInfo])
• msg_filter (Optional[MsgFilter])
• lynx_extra (List[LynxGiftExtra])
• user_identity (Optional[UserIdentity])
• match_info (Optional[MatchInfo])
• linkmic_gift_expression_strategy (LinkmicGiftExpressionStrategy)
• flying_mic_resources (Optional[FlyingMicResources])
• disable_gift_tracking (bool)
• asset (Optional[AssetsModel])
• version (GiftMessageVersion)
• sponsorship_info (List[SponsorshipInfo])
• flying_mic_resources_v2 (Optional[FlyingMicResources])
• public_area_message_common (Optional[PublicAreaMessageCommon])
• signature (str)
• signature_version (str)
• multi_generate_message (bool)
• to_member_id (str)
• to_member_id_int (int)
• to_member_nickname (str)
• interactive_gift_info (Optional[InteractiveGiftInfo])
• display_duration_ms (int)
• display_text_for_sender (Optional[Text])
• is_asset_bundle_gift (bool)
• asset_bundle (Optional[AssetBundle])
• effect_extra (str)
• secondary_effect_info (Optional[SecondaryEffectInfo])
• gift_variant_id (int)
• shiny_card_unlock_token (str)
• gift_effect (Optional[GiftEffect])
• user (Optional[ExtendedUser])
• to_user (Optional[ExtendedUser])
• gift (Optional[ExtendedGift])
• user_is_super_fan (property, bool) — Return whether the user is a TikTok super fan.
• streaking (property, bool) — Whether the user is currently engaged in a streak. False for non-streakable gifts; otherwise the inverse of repeat_end.
• value (property, Optional[float]) — USD value of this gift event. Returns None mid-streak so callers do not double-count; the final non-streaking event carries the full repeat_count.

Bases

• BaseEvent
• WebcastGiftMessage

Import

from TikTokLive.events import GiftEvent

Source

TikTokLive/events/proto_events.py:621