Module slack_bolt.context.complete.complete

Classes

class Complete (client: slack_sdk.web.client.WebClient, function_execution_id: str | None)

Expand source code

class Complete:
    client: WebClient
    function_execution_id: Optional[str]
    _called: bool

    def __init__(
        self,
        client: WebClient,
        function_execution_id: Optional[str],
    ):
        self.client = client
        self.function_execution_id = function_execution_id
        self._called = False

    def __call__(self, outputs: Optional[Dict[str, Any]] = None) -> SlackResponse:
        """Signal the successful completion of the custom function.

        Kwargs:
            outputs: Json serializable object containing the output values

        Returns:
            SlackResponse: The response object returned from slack

        Raises:
            ValueError: If this function cannot be used.
        """
        if self.function_execution_id is None:
            raise ValueError("complete is unsupported here as there is no function_execution_id")

        self._called = True
        return self.client.functions_completeSuccess(function_execution_id=self.function_execution_id, outputs=outputs or {})

    def has_been_called(self) -> bool:
        """Check if this complete function has been called.

        Returns:
            bool: True if the complete function has been called, False otherwise.
        """
        return self._called

Class variables

var client : slack_sdk.web.client.WebClient

The type of the None singleton.

var function_execution_id : str | None

The type of the None singleton.

Methods

def has_been_called(self) ‑> bool

Expand source code

def has_been_called(self) -> bool:
    """Check if this complete function has been called.

    Returns:
        bool: True if the complete function has been called, False otherwise.
    """
    return self._called

Check if this complete function has been called.

Returns

bool

True if the complete function has been called, False otherwise.