Function action

action<
    T extends
        | "call"
        | "chat_created"
        | "channel_created"
        | "chat_migrate_to"
        | "channel_migrate_from"
        | "message_pinned"
        | "history_cleared"
        | "game_score"
        | "contact_joined"
        | "title_changed"
        | "photo_changed"
        | "photo_deleted"
        | "users_added"
        | "user_left"
        | "user_removed"
        | "user_joined_link"
        | "user_joined_approved"
        | "payment_received"
        | "payment_sent"
        | "screenshot_taken"
        | "bot_allowed"
        | "geo_proximity"
        | "group_call_started"
        | "group_call_ended"
        | "group_call_scheduled"
        | "group_call_invite"
        | "ttl_changed"
        | "topic_created"
        | "topic_edited"
        | "custom"
        | "theme_changed"
        | "theme_changed_unique"
        | "webview_sent"
        | "webview_received"
        | "premium_gifted"
        | "photo_suggested"
        | "peer_sent"
        | "peer_chosen"
        | "wallpaper_changed"
        | "gift_code"
        | "giveaway_started"
        | "giveaway_ended"
        | "boost_apply"
        | "payment_refunded"
        | "stars_gifted"
        | "stars_prize"
        | "star_gift_sent"
        | "star_gift_upgrade_paid"
        | "star_gift_upgraded"
        | "star_gift_bought_resale"
        | "star_gift_bought_offer"
        | "star_gift_purchase_offer"
        | "star_gift_purchase_offer_declined"
        | "star_gift_assigned"
        | "star_gift_transferred"
        | "messages_paid"
        | "messages_refunded"
        | "todo_completions"
        | "todo_append_tasks"
        | "ton_gift"
        | "suggest_birthday",
>(
    type: MaybeArray<T>,
): filters.UpdateFilter<
    Message,
    {
        action: | Extract<ActionChatCreated, { type: T }>
        | Extract<ActionChannelCreated, { type: T }>
        | Extract<ActionChatMigrateTo, { type: T }>
        | Extract<ActionChannelMigrateFrom, { type: T }>
        | Extract<ActionMessagePinned, { type: T }>
        | Extract<ActionHistoryCleared, { type: T }>
        | Extract<ActionGameScore, { type: T }>
        | Extract<ActionContactJoined, { type: T }>
        | Extract<ActionTitleChanged, { type: T }>
        | Extract<ActionPhotoChanged, { type: T }>
        | Extract<ActionPhotoDeleted, { type: T }>
        | Extract<ActionUsersAdded, { type: T }>
        | Extract<ActionUserLeft, { type: T }>
        | Extract<ActionUserRemoved, { type: T }>
        | Extract<ActionUserJoinedLink, { type: T }>
        | Extract<ActionUserJoinedApproved, { type: T }>
        | Extract<ActionPaymentReceived, { type: T }>
        | Extract<ActionPaymentSent, { type: T }>
        | Extract<ActionCall, { type: T }>
        | Extract<ActionScreenshotTaken, { type: T }>
        | Extract<ActionBotAllowed, { type: T }>
        | Extract<ActionGeoProximity, { type: T }>
        | Extract<ActionGroupCallStarted, { type: T }>
        | Extract<ActionGroupCallEnded, { type: T }>
        | Extract<ActionGroupCallScheduled, { type: T }>
        | Extract<ActionGroupInvite, { type: T }>
        | Extract<ActionTtlChanged, { type: T }>
        | Extract<ActionTopicCreated, { type: T }>
        | Extract<ActionTopicEdited, { type: T }>
        | Extract<ActionCustom, { type: T }>
        | Extract<ActionThemeChanged, { type: T }>
        | Extract<ActionThemeChangedUnique, { type: T }>
        | Extract<ActionWebviewDataSent, { type: T }>
        | Extract<ActionWebviewDataReceived, { type: T }>
        | Extract<ActionPremiumGifted, { type: T }>
        | Extract<ActionPhotoSuggested, { type: T }>
        | Extract<ActionPeerSent, { type: T }>
        | Extract<ActionPeerChosen, { type: T }>
        | Extract<ActionWallpaperChanged, { type: T }>
        | Extract<ActionGiftCode, { type: T }>
        | Extract<ActionGiveawayStarted, { type: T }>
        | Extract<ActionGiveawayEnded, { type: T }>
        | Extract<ActionBoostApply, { type: T }>
        | Extract<ActionPaymentRefunded, { type: T }>
        | Extract<ActionStarGifted, { type: T }>
        | Extract<ActionStarsPrize, { type: T }>
        | Extract<ActionStarGiftSent, { type: T }>
        | Extract<ActionStarGiftUpgradePaid, { type: T }>
        | Extract<ActionStarGiftUpgraded, { type: T }>
        | Extract<ActionStarGiftBoughtResale, { type: T }>
        | Extract<ActionStarGiftBoughtOffer, { type: T }>
        | Extract<ActionStarGiftPurchaseOffer, { type: T }>
        | Extract<ActionStarGiftPurchaseOfferDeclined, { type: T }>
        | Extract<ActionStarGiftAssigned, { type: T }>
        | Extract<ActionStarGiftTransferred, { type: T }>
        | Extract<ActionPaidMessagesPaid, { type: T }>
        | Extract<ActionPaidMessagesRefunded, { type: T }>
        | Extract<ActionTodoCompletions, { type: T }>
        | Extract<ActionTodoAppendTasks, { type: T }>
        | Extract<ActionTonGift, { type: T }>
        | Extract<ActionSuggestBirthday, { type: T }>;
        sender: T extends | "history_cleared"
        | "contact_joined"
        | "user_removed"
        | "user_joined_link"
        | "bot_allowed"
            ? User
            : Peer;
    },
>
Filter service messages by action type
Type Parameters
- T extends
      | "call"
      | "chat_created"
      | "channel_created"
      | "chat_migrate_to"
      | "channel_migrate_from"
      | "message_pinned"
      | "history_cleared"
      | "game_score"
      | "contact_joined"
      | "title_changed"
      | "photo_changed"
      | "photo_deleted"
      | "users_added"
      | "user_left"
      | "user_removed"
      | "user_joined_link"
      | "user_joined_approved"
      | "payment_received"
      | "payment_sent"
      | "screenshot_taken"
      | "bot_allowed"
      | "geo_proximity"
      | "group_call_started"
      | "group_call_ended"
      | "group_call_scheduled"
      | "group_call_invite"
      | "ttl_changed"
      | "topic_created"
      | "topic_edited"
      | "custom"
      | "theme_changed"
      | "theme_changed_unique"
      | "webview_sent"
      | "webview_received"
      | "premium_gifted"
      | "photo_suggested"
      | "peer_sent"
      | "peer_chosen"
      | "wallpaper_changed"
      | "gift_code"
      | "giveaway_started"
      | "giveaway_ended"
      | "boost_apply"
      | "payment_refunded"
      | "stars_gifted"
      | "stars_prize"
      | "star_gift_sent"
      | "star_gift_upgrade_paid"
      | "star_gift_upgraded"
      | "star_gift_bought_resale"
      | "star_gift_bought_offer"
      | "star_gift_purchase_offer"
      | "star_gift_purchase_offer_declined"
      | "star_gift_assigned"
      | "star_gift_transferred"
      | "messages_paid"
      | "messages_refunded"
      | "todo_completions"
      | "todo_append_tasks"
      | "ton_gift"
      | "suggest_birthday"
Parameters
- type: MaybeArray<T>
Returns filters.UpdateFilter<
    Message,
    {
        action: | Extract<ActionChatCreated, { type: T }>
        | Extract<ActionChannelCreated, { type: T }>
        | Extract<ActionChatMigrateTo, { type: T }>
        | Extract<ActionChannelMigrateFrom, { type: T }>
        | Extract<ActionMessagePinned, { type: T }>
        | Extract<ActionHistoryCleared, { type: T }>
        | Extract<ActionGameScore, { type: T }>
        | Extract<ActionContactJoined, { type: T }>
        | Extract<ActionTitleChanged, { type: T }>
        | Extract<ActionPhotoChanged, { type: T }>
        | Extract<ActionPhotoDeleted, { type: T }>
        | Extract<ActionUsersAdded, { type: T }>
        | Extract<ActionUserLeft, { type: T }>
        | Extract<ActionUserRemoved, { type: T }>
        | Extract<ActionUserJoinedLink, { type: T }>
        | Extract<ActionUserJoinedApproved, { type: T }>
        | Extract<ActionPaymentReceived, { type: T }>
        | Extract<ActionPaymentSent, { type: T }>
        | Extract<ActionCall, { type: T }>
        | Extract<ActionScreenshotTaken, { type: T }>
        | Extract<ActionBotAllowed, { type: T }>
        | Extract<ActionGeoProximity, { type: T }>
        | Extract<ActionGroupCallStarted, { type: T }>
        | Extract<ActionGroupCallEnded, { type: T }>
        | Extract<ActionGroupCallScheduled, { type: T }>
        | Extract<ActionGroupInvite, { type: T }>
        | Extract<ActionTtlChanged, { type: T }>
        | Extract<ActionTopicCreated, { type: T }>
        | Extract<ActionTopicEdited, { type: T }>
        | Extract<ActionCustom, { type: T }>
        | Extract<ActionThemeChanged, { type: T }>
        | Extract<ActionThemeChangedUnique, { type: T }>
        | Extract<ActionWebviewDataSent, { type: T }>
        | Extract<ActionWebviewDataReceived, { type: T }>
        | Extract<ActionPremiumGifted, { type: T }>
        | Extract<ActionPhotoSuggested, { type: T }>
        | Extract<ActionPeerSent, { type: T }>
        | Extract<ActionPeerChosen, { type: T }>
        | Extract<ActionWallpaperChanged, { type: T }>
        | Extract<ActionGiftCode, { type: T }>
        | Extract<ActionGiveawayStarted, { type: T }>
        | Extract<ActionGiveawayEnded, { type: T }>
        | Extract<ActionBoostApply, { type: T }>
        | Extract<ActionPaymentRefunded, { type: T }>
        | Extract<ActionStarGifted, { type: T }>
        | Extract<ActionStarsPrize, { type: T }>
        | Extract<ActionStarGiftSent, { type: T }>
        | Extract<ActionStarGiftUpgradePaid, { type: T }>
        | Extract<ActionStarGiftUpgraded, { type: T }>
        | Extract<ActionStarGiftBoughtResale, { type: T }>
        | Extract<ActionStarGiftBoughtOffer, { type: T }>
        | Extract<ActionStarGiftPurchaseOffer, { type: T }>
        | Extract<ActionStarGiftPurchaseOfferDeclined, { type: T }>
        | Extract<ActionStarGiftAssigned, { type: T }>
        | Extract<ActionStarGiftTransferred, { type: T }>
        | Extract<ActionPaidMessagesPaid, { type: T }>
        | Extract<ActionPaidMessagesRefunded, { type: T }>
        | Extract<ActionTodoCompletions, { type: T }>
        | Extract<ActionTodoAppendTasks, { type: T }>
        | Extract<ActionTonGift, { type: T }>
        | Extract<ActionSuggestBirthday, { type: T }>;
        sender: T extends | "history_cleared"
        | "contact_joined"
        | "user_removed"
        | "user_joined_link"
        | "bot_allowed"
            ? User
            : Peer;
    },
>
- Defined in packages/dispatcher/src/filters/message.ts:227

Function action

Type Parameters

Parameters

Settings