Back to Bolt Python

slack_bolt.middleware.attaching_conversation_kwargs API documentation

docs/reference/middleware/attaching_conversation_kwargs/index.html

1.30.03.0 KB
Original Source

Sub-modules

slack_bolt.middleware.attaching_conversation_kwargs.async_attaching_conversation_kwargs

slack_bolt.middleware.attaching_conversation_kwargs.attaching_conversation_kwargs

Classes

class AttachingConversationKwargs (thread_context_store: AssistantThreadContextStore | None = None)#Expand source code

class AttachingConversationKwargs(Middleware):

    thread_context_store: Optional[AssistantThreadContextStore]

    def __init__ (self, thread_context_store: Optional[AssistantThreadContextStore] = None):
        self.thread_context_store = thread_context_store

    def process(self, *, req: BoltRequest, resp: BoltResponse, next: Callable[[], BoltResponse]) -> Optional[BoltResponse]:
        event = to_event(req.body)
        if event is None:
            return next()
        if req.context.channel_id is None:
            return next()

        if is_assistant_event(req.body):
            # TODO: eventually we might remove this assistant specific logic
            assistant = AssistantUtilities(
                payload=event,
                context=req.context,
                thread_context_store=self.thread_context_store,
            )
            req.context["say"] = assistant.say
            req.context["set_title"] = assistant.set_title
            req.context["get_thread_context"] = assistant.get_thread_context
            req.context["save_thread_context"] = assistant.save_thread_context

        if (
            is_im_message_event(req.body)
            or is_assistant_thread_started_event(req.body)
            or is_assistant_thread_context_changed_event(req.body)
            or is_app_home_opened_event(req.body, tab="messages")
        ):
            req.context["set_suggested_prompts"] = SetSuggestedPrompts(
                client=req.context.client,
                channel_id=req.context.channel_id,
                thread_ts=req.context.thread_ts,
            )

        # TODO: in the future we might want to introduce a "proper" extract_ts utility
        thread_ts_or_ts = req.context.thread_ts or event.get("ts")
        if thread_ts_or_ts:
            req.context["set_status"] = SetStatus(
                client=req.context.client,
                channel_id=req.context.channel_id,
                thread_ts=thread_ts_or_ts,
            )
            req.context["say_stream"] = SayStream(
                client=req.context.client,
                channel=req.context.channel_id,
                recipient_team_id=req.context.team_id or req.context.enterprise_id,
                recipient_user_id=req.context.user_id,
                thread_ts=thread_ts_or_ts,
            )
        return next()

A middleware can process request data before other middleware and listener functions.

Ancestors

Class variables

var thread_context_store : AssistantThreadContextStore | None

The type of the None singleton.

Inherited members

  • Middleware:
    • name
    • process