GramIO API Reference / @gramio/scenes/dist

@gramio/scenes/dist

Classes

Class	Description
Scene	-

Interfaces

Interface	Description
EnterExit	-
InActiveSceneHandlerReturn	-
InUnknownScene	-
ParentSceneFrame	-
PossibleInUnknownScene	-
ScenesOptions	-
ScenesStorageData	-
SceneUpdateState	-

Type Aliases

Type Alias	Description
AnyScene	-
Modify	-
SceneDerivesDefinitions	-
SceneEnterHandler	-
ScenesStorage	-
SceneStepReturn	-
StateTypesDefault	-
StepHandler	-
UpdateData	-

Functions

scenes()

scenes(scenes, options?): Plugin<{ }, DeriveDefinitions & object, { }>

Defined in: scenes/index.d.ts:789

Parameters

Parameter	Type
scenes	AnyScene[]
options?	ScenesOptions

Returns

Plugin<{ }, DeriveDefinitions & object, { }>

---

scenesDerives()

scenesDerives<WithCurrentScene>(scenesOrOptions, optionsRaw?): EventComposer<Context<AnyBot>, { boost_added: BoostAddedContext<AnyBot>; business_connection: BusinessConnectionContext<AnyBot>; business_message: MessageContext<AnyBot> & Require<MessageContext<AnyBot>, "from">; callback_query: CallbackQueryContext<AnyBot>; channel_post: MessageContext<AnyBot>; chat_background_set: ChatBackgroundSetContext<AnyBot>; chat_boost: ChatBoostContext<AnyBot>; chat_join_request: ChatJoinRequestContext<AnyBot>; chat_member: ChatMemberContext<AnyBot>; chat_owner_changed: ChatOwnerChangedContext<AnyBot>; chat_owner_left: ChatOwnerLeftContext<AnyBot>; chat_shared: ChatSharedContext<AnyBot>; checklist_tasks_added: ChecklistTasksAddedContext<AnyBot>; checklist_tasks_done: ChecklistTasksDoneContext<AnyBot>; chosen_inline_result: ChosenInlineResultContext<AnyBot>; delete_chat_photo: DeleteChatPhotoContext<AnyBot>; deleted_business_messages: BusinessMessagesDeletedContext<AnyBot>; direct_message_price_changed: DirectMessagePriceChangedContext<AnyBot>; edited_business_message: MessageContext<AnyBot> & Require<MessageContext<AnyBot>, "from">; edited_channel_post: MessageContext<AnyBot> & Require<MessageContext<AnyBot>, "from">; edited_message: MessageContext<AnyBot> & Require<MessageContext<AnyBot>, "from">; forum_topic_closed: ForumTopicClosedContext<AnyBot>; forum_topic_created: ForumTopicCreatedContext<AnyBot>; forum_topic_edited: ForumTopicEditedContext<AnyBot>; forum_topic_reopened: ForumTopicReopenedContext<AnyBot>; general_forum_topic_hidden: GeneralForumTopicHiddenContext<AnyBot>; general_forum_topic_unhidden: GeneralForumTopicUnhiddenContext<AnyBot>; gift: GiftContext<AnyBot>; gift_upgrade_sent: GiftUpgradeSentContext<AnyBot>; giveaway_completed: GiveawayCompletedContext<AnyBot>; giveaway_created: GiveawayCreatedContext<AnyBot>; giveaway_winners: GiveawayWinnersContext<AnyBot>; group_chat_created: GroupChatCreatedContext<AnyBot>; inline_query: InlineQueryContext<AnyBot>; invoice: InvoiceContext<AnyBot>; left_chat_member: LeftChatMemberContext<AnyBot>; location: LocationContext<AnyBot>; message: MessageContext<AnyBot> & Require<MessageContext<AnyBot>, "from">; message_auto_delete_timer_changed: MessageAutoDeleteTimerChangedContext<AnyBot>; message_reaction: MessageReactionContext<AnyBot>; message_reaction_count: MessageReactionCountContext<AnyBot>; migrate_from_chat_id: MigrateFromChatIdContext<AnyBot>; migrate_to_chat_id: MigrateToChatIdContext<AnyBot>; my_chat_member: ChatMemberContext<AnyBot>; new_chat_members: NewChatMembersContext<AnyBot>; new_chat_photo: NewChatPhotoContext<AnyBot>; new_chat_title: NewChatTitleContext<AnyBot>; paid_message_price_changed: PaidMessagePriceChangedContext<AnyBot>; passport_data: PassportDataContext<AnyBot>; pinned_message: PinnedMessageContext<AnyBot>; poll: PollContext<AnyBot>; poll_answer: PollAnswerContext<AnyBot>; pre_checkout_query: PreCheckoutQueryContext<AnyBot>; proximity_alert_triggered: ProximityAlertTriggeredContext<AnyBot>; purchased_paid_media: PaidMediaPurchasedContext<AnyBot>; refunded_payment: RefundedPaymentContext<AnyBot>; removed_chat_boost: RemovedChatBoostContext<AnyBot>; service_message: MessageContext<AnyBot>; shipping_query: ShippingQueryContext<AnyBot>; successful_payment: SuccessfulPaymentContext<AnyBot>; suggested_post_approval_failed: SuggestedPostApprovalFailedContext<AnyBot>; suggested_post_approved: SuggestedPostApprovedContext<AnyBot>; suggested_post_declined: SuggestedPostDeclinedContext<AnyBot>; suggested_post_paid: SuggestedPostPaidContext<AnyBot>; suggested_post_refunded: SuggestedPostRefundedContext<AnyBot>; unique_gift: UniqueGiftContext<AnyBot>; users_shared: UsersSharedContext<AnyBot>; video_chat_ended: VideoChatEndedContext<AnyBot>; video_chat_participants_invited: VideoChatParticipantsInvitedContext<AnyBot>; video_chat_scheduled: VideoChatScheduledContext<AnyBot>; video_chat_started: VideoChatStartedContext<AnyBot>; web_app_data: WebAppDataContext<AnyBot>; write_access_allowed: WriteAccessAllowedContext<AnyBot>; }, Context<AnyBot>, Context<AnyBot>, { }, { callback_query: { scene: WithCurrentScene extends true ? PossibleInUnknownScene<any, any, null> : EnterExit; }; channel_post: { scene: WithCurrentScene extends true ? PossibleInUnknownScene<any, any, null> : EnterExit; }; chat_join_request: { scene: WithCurrentScene extends true ? PossibleInUnknownScene<any, any, null> : EnterExit; }; chat_shared: { scene: WithCurrentScene extends true ? PossibleInUnknownScene<any, any, null> : EnterExit; }; chosen_inline_result: { scene: WithCurrentScene extends true ? PossibleInUnknownScene<any, any, null> : EnterExit; }; delete_chat_photo: { scene: WithCurrentScene extends true ? PossibleInUnknownScene<any, any, null> : EnterExit; }; group_chat_created: { scene: WithCurrentScene extends true ? PossibleInUnknownScene<any, any, null> : EnterExit; }; inline_query: { scene: WithCurrentScene extends true ? PossibleInUnknownScene<any, any, null> : EnterExit; }; invoice: { scene: WithCurrentScene extends true ? PossibleInUnknownScene<any, any, null> : EnterExit; }; location: { scene: WithCurrentScene extends true ? PossibleInUnknownScene<any, any, null> : EnterExit; }; message: { scene: WithCurrentScene extends true ? PossibleInUnknownScene<any, any, null> : EnterExit; }; message_auto_delete_timer_changed: { scene: WithCurrentScene extends true ? PossibleInUnknownScene<any, any, null> : EnterExit; }; migrate_from_chat_id: { scene: WithCurrentScene extends true ? PossibleInUnknownScene<any, any, null> : EnterExit; }; migrate_to_chat_id: { scene: WithCurrentScene extends true ? PossibleInUnknownScene<any, any, null> : EnterExit; }; new_chat_members: { scene: WithCurrentScene extends true ? PossibleInUnknownScene<any, any, null> : EnterExit; }; new_chat_photo: { scene: WithCurrentScene extends true ? PossibleInUnknownScene<any, any, null> : EnterExit; }; new_chat_title: { scene: WithCurrentScene extends true ? PossibleInUnknownScene<any, any, null> : EnterExit; }; passport_data: { scene: WithCurrentScene extends true ? PossibleInUnknownScene<any, any, null> : EnterExit; }; pinned_message: { scene: WithCurrentScene extends true ? PossibleInUnknownScene<any, any, null> : EnterExit; }; pre_checkout_query: { scene: WithCurrentScene extends true ? PossibleInUnknownScene<any, any, null> : EnterExit; }; proximity_alert_triggered: { scene: WithCurrentScene extends true ? PossibleInUnknownScene<any, any, null> : EnterExit; }; shipping_query: { scene: WithCurrentScene extends true ? PossibleInUnknownScene<any, any, null> : EnterExit; }; successful_payment: { scene: WithCurrentScene extends true ? PossibleInUnknownScene<any, any, null> : EnterExit; }; users_shared: { scene: WithCurrentScene extends true ? PossibleInUnknownScene<any, any, null> : EnterExit; }; video_chat_ended: { scene: WithCurrentScene extends true ? PossibleInUnknownScene<any, any, null> : EnterExit; }; video_chat_participants_invited: { scene: WithCurrentScene extends true ? PossibleInUnknownScene<any, any, null> : EnterExit; }; video_chat_scheduled: { scene: WithCurrentScene extends true ? PossibleInUnknownScene<any, any, null> : EnterExit; }; video_chat_started: { scene: WithCurrentScene extends true ? PossibleInUnknownScene<any, any, null> : EnterExit; }; web_app_data: { scene: WithCurrentScene extends true ? PossibleInUnknownScene<any, any, null> : EnterExit; }; }, { callbackQuery: TThis; chosenInlineResult: TThis; command: TThis; hears: TThis; inlineQuery: TThis; reaction: TThis; startParameter: TThis; }, { }> & object

Defined in: scenes/index.d.ts:494

Type Parameters

Type Parameter	Default type
WithCurrentScene extends boolean	false

Parameters

Parameter	Type
scenesOrOptions	AnyScene[] | ScenesDerivesOptions<WithCurrentScene>
optionsRaw?	ScenesDerivesOptions<WithCurrentScene>

Returns

EventComposer<Context<AnyBot>, { boost_added: BoostAddedContext<AnyBot>; business_connection: BusinessConnectionContext<AnyBot>; business_message: MessageContext<AnyBot> & Require<MessageContext<AnyBot>, "from">; callback_query: CallbackQueryContext<AnyBot>; channel_post: MessageContext<AnyBot>; chat_background_set: ChatBackgroundSetContext<AnyBot>; chat_boost: ChatBoostContext<AnyBot>; chat_join_request: ChatJoinRequestContext<AnyBot>; chat_member: ChatMemberContext<AnyBot>; chat_owner_changed: ChatOwnerChangedContext<AnyBot>; chat_owner_left: ChatOwnerLeftContext<AnyBot>; chat_shared: ChatSharedContext<AnyBot>; checklist_tasks_added: ChecklistTasksAddedContext<AnyBot>; checklist_tasks_done: ChecklistTasksDoneContext<AnyBot>; chosen_inline_result: ChosenInlineResultContext<AnyBot>; delete_chat_photo: DeleteChatPhotoContext<AnyBot>; deleted_business_messages: BusinessMessagesDeletedContext<AnyBot>; direct_message_price_changed: DirectMessagePriceChangedContext<AnyBot>; edited_business_message: MessageContext<AnyBot> & Require<MessageContext<AnyBot>, "from">; edited_channel_post: MessageContext<AnyBot> & Require<MessageContext<AnyBot>, "from">; edited_message: MessageContext<AnyBot> & Require<MessageContext<AnyBot>, "from">; forum_topic_closed: ForumTopicClosedContext<AnyBot>; forum_topic_created: ForumTopicCreatedContext<AnyBot>; forum_topic_edited: ForumTopicEditedContext<AnyBot>; forum_topic_reopened: ForumTopicReopenedContext<AnyBot>; general_forum_topic_hidden: GeneralForumTopicHiddenContext<AnyBot>; general_forum_topic_unhidden: GeneralForumTopicUnhiddenContext<AnyBot>; gift: GiftContext<AnyBot>; gift_upgrade_sent: GiftUpgradeSentContext<AnyBot>; giveaway_completed: GiveawayCompletedContext<AnyBot>; giveaway_created: GiveawayCreatedContext<AnyBot>; giveaway_winners: GiveawayWinnersContext<AnyBot>; group_chat_created: GroupChatCreatedContext<AnyBot>; inline_query: InlineQueryContext<AnyBot>; invoice: InvoiceContext<AnyBot>; left_chat_member: LeftChatMemberContext<AnyBot>; location: LocationContext<AnyBot>; message: MessageContext<AnyBot> & Require<MessageContext<AnyBot>, "from">; message_auto_delete_timer_changed: MessageAutoDeleteTimerChangedContext<AnyBot>; message_reaction: MessageReactionContext<AnyBot>; message_reaction_count: MessageReactionCountContext<AnyBot>; migrate_from_chat_id: MigrateFromChatIdContext<AnyBot>; migrate_to_chat_id: MigrateToChatIdContext<AnyBot>; my_chat_member: ChatMemberContext<AnyBot>; new_chat_members: NewChatMembersContext<AnyBot>; new_chat_photo: NewChatPhotoContext<AnyBot>; new_chat_title: NewChatTitleContext<AnyBot>; paid_message_price_changed: PaidMessagePriceChangedContext<AnyBot>; passport_data: PassportDataContext<AnyBot>; pinned_message: PinnedMessageContext<AnyBot>; poll: PollContext<AnyBot>; poll_answer: PollAnswerContext<AnyBot>; pre_checkout_query: PreCheckoutQueryContext<AnyBot>; proximity_alert_triggered: ProximityAlertTriggeredContext<AnyBot>; purchased_paid_media: PaidMediaPurchasedContext<AnyBot>; refunded_payment: RefundedPaymentContext<AnyBot>; removed_chat_boost: RemovedChatBoostContext<AnyBot>; service_message: MessageContext<AnyBot>; shipping_query: ShippingQueryContext<AnyBot>; successful_payment: SuccessfulPaymentContext<AnyBot>; suggested_post_approval_failed: SuggestedPostApprovalFailedContext<AnyBot>; suggested_post_approved: SuggestedPostApprovedContext<AnyBot>; suggested_post_declined: SuggestedPostDeclinedContext<AnyBot>; suggested_post_paid: SuggestedPostPaidContext<AnyBot>; suggested_post_refunded: SuggestedPostRefundedContext<AnyBot>; unique_gift: UniqueGiftContext<AnyBot>; users_shared: UsersSharedContext<AnyBot>; video_chat_ended: VideoChatEndedContext<AnyBot>; video_chat_participants_invited: VideoChatParticipantsInvitedContext<AnyBot>; video_chat_scheduled: VideoChatScheduledContext<AnyBot>; video_chat_started: VideoChatStartedContext<AnyBot>; web_app_data: WebAppDataContext<AnyBot>; write_access_allowed: WriteAccessAllowedContext<AnyBot>; }, Context<AnyBot>, Context<AnyBot>, { }, { callback_query: { scene: WithCurrentScene extends true ? PossibleInUnknownScene<any, any, null> : EnterExit; }; channel_post: { scene: WithCurrentScene extends true ? PossibleInUnknownScene<any, any, null> : EnterExit; }; chat_join_request: { scene: WithCurrentScene extends true ? PossibleInUnknownScene<any, any, null> : EnterExit; }; chat_shared: { scene: WithCurrentScene extends true ? PossibleInUnknownScene<any, any, null> : EnterExit; }; chosen_inline_result: { scene: WithCurrentScene extends true ? PossibleInUnknownScene<any, any, null> : EnterExit; }; delete_chat_photo: { scene: WithCurrentScene extends true ? PossibleInUnknownScene<any, any, null> : EnterExit; }; group_chat_created: { scene: WithCurrentScene extends true ? PossibleInUnknownScene<any, any, null> : EnterExit; }; inline_query: { scene: WithCurrentScene extends true ? PossibleInUnknownScene<any, any, null> : EnterExit; }; invoice: { scene: WithCurrentScene extends true ? PossibleInUnknownScene<any, any, null> : EnterExit; }; location: { scene: WithCurrentScene extends true ? PossibleInUnknownScene<any, any, null> : EnterExit; }; message: { scene: WithCurrentScene extends true ? PossibleInUnknownScene<any, any, null> : EnterExit; }; message_auto_delete_timer_changed: { scene: WithCurrentScene extends true ? PossibleInUnknownScene<any, any, null> : EnterExit; }; migrate_from_chat_id: { scene: WithCurrentScene extends true ? PossibleInUnknownScene<any, any, null> : EnterExit; }; migrate_to_chat_id: { scene: WithCurrentScene extends true ? PossibleInUnknownScene<any, any, null> : EnterExit; }; new_chat_members: { scene: WithCurrentScene extends true ? PossibleInUnknownScene<any, any, null> : EnterExit; }; new_chat_photo: { scene: WithCurrentScene extends true ? PossibleInUnknownScene<any, any, null> : EnterExit; }; new_chat_title: { scene: WithCurrentScene extends true ? PossibleInUnknownScene<any, any, null> : EnterExit; }; passport_data: { scene: WithCurrentScene extends true ? PossibleInUnknownScene<any, any, null> : EnterExit; }; pinned_message: { scene: WithCurrentScene extends true ? PossibleInUnknownScene<any, any, null> : EnterExit; }; pre_checkout_query: { scene: WithCurrentScene extends true ? PossibleInUnknownScene<any, any, null> : EnterExit; }; proximity_alert_triggered: { scene: WithCurrentScene extends true ? PossibleInUnknownScene<any, any, null> : EnterExit; }; shipping_query: { scene: WithCurrentScene extends true ? PossibleInUnknownScene<any, any, null> : EnterExit; }; successful_payment: { scene: WithCurrentScene extends true ? PossibleInUnknownScene<any, any, null> : EnterExit; }; users_shared: { scene: WithCurrentScene extends true ? PossibleInUnknownScene<any, any, null> : EnterExit; }; video_chat_ended: { scene: WithCurrentScene extends true ? PossibleInUnknownScene<any, any, null> : EnterExit; }; video_chat_participants_invited: { scene: WithCurrentScene extends true ? PossibleInUnknownScene<any, any, null> : EnterExit; }; video_chat_scheduled: { scene: WithCurrentScene extends true ? PossibleInUnknownScene<any, any, null> : EnterExit; }; video_chat_started: { scene: WithCurrentScene extends true ? PossibleInUnknownScene<any, any, null> : EnterExit; }; web_app_data: { scene: WithCurrentScene extends true ? PossibleInUnknownScene<any, any, null> : EnterExit; }; }, { callbackQuery: TThis; chosenInlineResult: TThis; command: TThis; hears: TThis; inlineQuery: TThis; reaction: TThis; startParameter: TThis; }, { }> & object