Module slack_bolt.context.async_context

Classes

class AsyncBoltContext (*args, **kwargs)

Context object associated with a request from Slack.

Expand source code

class AsyncBoltContext(BaseContext):
    """Context object associated with a request from Slack."""

    def to_copyable(self) -> "AsyncBoltContext":
        new_dict = {}
        for prop_name, prop_value in self.items():
            if prop_name in self.standard_property_names:
                # all the standard properties are copiable
                new_dict[prop_name] = prop_value
            else:
                try:
                    copied_value = create_copy(prop_value)
                    new_dict[prop_name] = copied_value
                except TypeError as te:
                    self.logger.debug(
                        f"Skipped settings '{prop_name}' to a copied request for lazy listeners "
                        f"as it's not possible to make a deep copy (error: {te})"
                    )
        return AsyncBoltContext(new_dict)

    @property
    def client(self) -> Optional[AsyncWebClient]:
        """The `AsyncWebClient` instance available for this request.

            @app.event("app_mention")
            async def handle_events(context):
                await context.client.chat_postMessage(
                    channel=context.channel_id,
                    text="Thanks!",
                )

            # You can access "client" this way too.
            @app.event("app_mention")
            async def handle_events(client, context):
                await client.chat_postMessage(
                    channel=context.channel_id,
                    text="Thanks!",
                )

        Returns:
            `AsyncWebClient` instance
        """
        if "client" not in self:
            self["client"] = AsyncWebClient(token=None)
        return self["client"]

    @property
    def ack(self) -> AsyncAck:
        """`ack()` function for this request.

            @app.action("button")
            async def handle_button_clicks(context):
                await context.ack()

            # You can access "ack" this way too.
            @app.action("button")
            async def handle_button_clicks(ack):
                await ack()

        Returns:
            Callable `ack()` function
        """
        if "ack" not in self:
            self["ack"] = AsyncAck()
        return self["ack"]

    @property
    def say(self) -> AsyncSay:
        """`say()` function for this request.

            @app.action("button")
            async def handle_button_clicks(context):
                await context.ack()
                await context.say("Hi!")

            # You can access "ack" this way too.
            @app.action("button")
            async def handle_button_clicks(ack, say):
                await ack()
                await say("Hi!")

        Returns:
            Callable `say()` function
        """
        if "say" not in self:
            self["say"] = AsyncSay(client=self.client, channel=self.channel_id)
        return self["say"]

    @property
    def respond(self) -> Optional[AsyncRespond]:
        """`respond()` function for this request.

            @app.action("button")
            async def handle_button_clicks(context):
                await context.ack()
                await context.respond("Hi!")

            # You can access "ack" this way too.
            @app.action("button")
            async def handle_button_clicks(ack, respond):
                await ack()
                await respond("Hi!")

        Returns:
            Callable `respond()` function
        """
        if "respond" not in self:
            self["respond"] = AsyncRespond(
                response_url=self.response_url,
                proxy=self.client.proxy,
                ssl=self.client.ssl,
            )
        return self["respond"]

Ancestors

• BaseContext
• builtins.dict

Instance variables

var ack : AsyncAck

ack() function for this request.

@app.action("button")
async def handle_button_clicks(context):
    await context.ack()

# You can access "ack" this way too.
@app.action("button")
async def handle_button_clicks(ack):
    await ack()

Returns

Callable ack() function

Expand source code

@property
def ack(self) -> AsyncAck:
    """`ack()` function for this request.

        @app.action("button")
        async def handle_button_clicks(context):
            await context.ack()

        # You can access "ack" this way too.
        @app.action("button")
        async def handle_button_clicks(ack):
            await ack()

    Returns:
        Callable `ack()` function
    """
    if "ack" not in self:
        self["ack"] = AsyncAck()
    return self["ack"]

var client : Optional[slack_sdk.web.async_client.AsyncWebClient]

The AsyncWebClient instance available for this request.

@app.event("app_mention")
async def handle_events(context):
    await context.client.chat_postMessage(
        channel=context.channel_id,
        text="Thanks!",
    )

# You can access "client" this way too.
@app.event("app_mention")
async def handle_events(client, context):
    await client.chat_postMessage(
        channel=context.channel_id,
        text="Thanks!",
    )

Returns

AsyncWebClient instance

Expand source code

@property
def client(self) -> Optional[AsyncWebClient]:
    """The `AsyncWebClient` instance available for this request.

        @app.event("app_mention")
        async def handle_events(context):
            await context.client.chat_postMessage(
                channel=context.channel_id,
                text="Thanks!",
            )

        # You can access "client" this way too.
        @app.event("app_mention")
        async def handle_events(client, context):
            await client.chat_postMessage(
                channel=context.channel_id,
                text="Thanks!",
            )

    Returns:
        `AsyncWebClient` instance
    """
    if "client" not in self:
        self["client"] = AsyncWebClient(token=None)
    return self["client"]

var respond : Optional[AsyncRespond]

respond() function for this request.

@app.action("button")
async def handle_button_clicks(context):
    await context.ack()
    await context.respond("Hi!")

# You can access "ack" this way too.
@app.action("button")
async def handle_button_clicks(ack, respond):
    await ack()
    await respond("Hi!")

Returns

Callable respond() function

Expand source code

@property
def respond(self) -> Optional[AsyncRespond]:
    """`respond()` function for this request.

        @app.action("button")
        async def handle_button_clicks(context):
            await context.ack()
            await context.respond("Hi!")

        # You can access "ack" this way too.
        @app.action("button")
        async def handle_button_clicks(ack, respond):
            await ack()
            await respond("Hi!")

    Returns:
        Callable `respond()` function
    """
    if "respond" not in self:
        self["respond"] = AsyncRespond(
            response_url=self.response_url,
            proxy=self.client.proxy,
            ssl=self.client.ssl,
        )
    return self["respond"]

var say : AsyncSay

say() function for this request.

@app.action("button")
async def handle_button_clicks(context):
    await context.ack()
    await context.say("Hi!")

# You can access "ack" this way too.
@app.action("button")
async def handle_button_clicks(ack, say):
    await ack()
    await say("Hi!")

Returns

Callable say() function

Expand source code

@property
def say(self) -> AsyncSay:
    """`say()` function for this request.

        @app.action("button")
        async def handle_button_clicks(context):
            await context.ack()
            await context.say("Hi!")

        # You can access "ack" this way too.
        @app.action("button")
        async def handle_button_clicks(ack, say):
            await ack()
            await say("Hi!")

    Returns:
        Callable `say()` function
    """
    if "say" not in self:
        self["say"] = AsyncSay(client=self.client, channel=self.channel_id)
    return self["say"]

Methods

def to_copyable(self) ‑> AsyncBoltContext

Expand source code

def to_copyable(self) -> "AsyncBoltContext":
    new_dict = {}
    for prop_name, prop_value in self.items():
        if prop_name in self.standard_property_names:
            # all the standard properties are copiable
            new_dict[prop_name] = prop_value
        else:
            try:
                copied_value = create_copy(prop_value)
                new_dict[prop_name] = copied_value
            except TypeError as te:
                self.logger.debug(
                    f"Skipped settings '{prop_name}' to a copied request for lazy listeners "
                    f"as it's not possible to make a deep copy (error: {te})"
                )
    return AsyncBoltContext(new_dict)

Inherited members

• BaseContext:
  • actor_enterprise_id
  • actor_team_id
  • actor_user_id
  • authorize_result
  • bot_id
  • bot_token
  • bot_user_id
  • channel_id
  • enterprise_id
  • is_enterprise_install
  • logger
  • matches
  • response_url
  • team_id
  • token
  • user_id
  • user_token