python-slack-sdk API reference

68 public APIs from python-slack-sdk (slackapi/python-slack-sdk) — 53 classes, 1 functions, 14 methods. Signatures extracted by static analysis of the actual source.

Repository: slackapi/python-slack-sdk

Kind	Count
Classes	53
Functions	1
Methods	14

API list

methodslack.signature.verifier.SignatureVerifier.generate_signature(*timestamp:str, *body:Union[str, bytes]) -> Optional[str]

Generates a signature

methodslack.signature.verifier.SignatureVerifier.is_valid(body:Union[str, bytes], timestamp:str, signature:str) -> bool

Verifies if the given signature is valid

methodslack.signature.verifier.SignatureVerifier.is_valid_request(body:Union[str, bytes], headers:Dict[str, str]) -> bool

Verifies if the given signature is valid

classslack.web.async_slack_response.AsyncSlackResponse

An iterable container of response data.

classslack.web.classes.interactions.IDNamePair

Simple type used to help with unpacking event data

classslack_sdk.errors.SlackApiError

Error raised when Slack does not send the expected response.

classslack_sdk.errors.SlackClientError

Base class for Client errors

classslack_sdk.http_retry.async_handler.AsyncRetryHandler

asyncio compatible RetryHandler interface.

classslack_sdk.http_retry.handler.RetryHandler

RetryHandler interface.

classslack_sdk.http_retry.interval_calculator.RetryIntervalCalculator

Retry interval calculator interface.

methodslack_sdk.http_retry.interval_calculator.RetryIntervalCalculator.calculate_sleep_duration(current_attempt:int) -> float

Calculates an interval duration in seconds.

classslack_sdk.http_retry.jitter.Jitter

Jitter interface

methodslack_sdk.http_retry.jitter.Jitter.recalculate(duration:float) -> float

Recalculate the given duration.

classslack_sdk.http_retry.jitter.RandomJitter

Random jitter implementation

classslack_sdk.http_retry.request.HttpRequest

HTTP request representation

classslack_sdk.http_retry.response.HttpResponse

HTTP response representation

classslack_sdk.models.basic_objects.BaseObject

The base class for all model objects in this module

classslack_sdk.models.basic_objects.JsonObject

The base class for JSON serializable class objects

methodslack_sdk.models.basic_objects.JsonObject.validate_json() -> None

Raises: SlackObjectFormationError if the object was not valid

classslack_sdk.models.blocks.basic_components.MarkdownTextObject

mrkdwn typed text object

classslack_sdk.models.blocks.basic_components.PlainTextObject

plain_text typed text object

classslack_sdk.models.blocks.basic_components.RawTextObject

raw_text typed text object

methodslack_sdk.models.blocks.basic_components.RawTextObject.from_str(text:str) -> 'RawTextObject'

Transforms a string into a RawTextObject

classslack_sdk.models.blocks.basic_components.TextObject

The interface for text objects (types: plain_text, mrkdwn)

classslack_sdk.models.dialogs.DialogTextArea

A textarea is a multi-line plain text editing control.

classslack_sdk.models.dialogs.DialogTextField

Text elements are single-line plain text fields.

classslack_sdk.models.messages.chunk.Chunk

Chunk for streaming messages.

classslack_sdk.models.metadata.ContentItemEntityFields

Fields specific to content item entities

classslack_sdk.models.metadata.EntityActionButton

Action button for entity

classslack_sdk.models.metadata.EntityActions

Actions configuration for entity

classslack_sdk.models.metadata.EntityAttributes

Attributes for an entity

classslack_sdk.models.metadata.EntityBooleanCheckboxField

Boolean checkbox properties

classslack_sdk.models.metadata.EntityBooleanTextField

Boolean text properties

classslack_sdk.models.metadata.EntityCustomField

Custom field for entity with flexible types

classslack_sdk.models.metadata.EntityEditNumberConfig

Number configuration for entity edit support

classslack_sdk.models.metadata.EntityEditSelectConfig

Select configuration for entity edit support

classslack_sdk.models.metadata.EntityEditSupport

Edit support configuration for entity fields

classslack_sdk.models.metadata.EntityEditTextConfig

Text configuration for entity edit support

classslack_sdk.models.metadata.EntityFullSizePreview

Full-size preview configuration for entity

classslack_sdk.models.metadata.EntityFullSizePreviewError

Error information for full-size preview

classslack_sdk.models.metadata.EntityIconField

Icon field for entity attributes

classslack_sdk.models.metadata.EntityIconSlackFile

Slack file reference for entity icon

classslack_sdk.models.metadata.EntityImageField

Image field for entity

classslack_sdk.models.metadata.EntityPayload

Payload schema for an entity

methodslack_sdk.models.metadata.EntityPayload.entity_attributes() -> Union[Dict[str, Any], EntityAttributes]

Get the entity attributes data.

classslack_sdk.models.metadata.EntityRefField

Entity reference field

classslack_sdk.models.metadata.EntityStringField

String field for entity

classslack_sdk.models.metadata.EntityTimestampField

Timestamp field for entity

classslack_sdk.models.metadata.EntityTitle

Title for entity attributes

classslack_sdk.models.metadata.EntityTypedField

Typed field for entity with various display options

classslack_sdk.models.metadata.EntityUserField

User field for entity

classslack_sdk.models.metadata.EntityUserIDField

User ID field for entity

classslack_sdk.models.metadata.FileEntityFields

Fields specific to file entities

classslack_sdk.models.metadata.FileEntitySlackFile

Slack file reference for file entities

classslack_sdk.models.metadata.IncidentEntityFields

Fields specific to incident entities

classslack_sdk.models.metadata.TaskEntityFields

Fields specific to task entities

classslack_sdk.models.views.View

View object for modals and Home tabs.

classslack_sdk.oauth.installation_store.installation_store.InstallationStore

The installation store interface.

methodslack_sdk.oauth.installation_store.installation_store.InstallationStore.save(installation:Installation)

Saves an installation data

methodslack_sdk.oauth.installation_store.installation_store.InstallationStore.save_bot(bot:Bot)

Saves a bot installation data

methodslack_sdk.signature.SignatureVerifier.generate_signature(*timestamp:str, *body:Union[str, bytes]) -> Optional[str]

Generates a signature

method

slack_sdk.signature.SignatureVerifier.is_valid(body:Union[str, bytes], timestamp:Optional[str], signature:Optional[str]) -> bool

Verifies if the given signature is valid

methodslack_sdk.signature.SignatureVerifier.is_valid_request(body:Union[str, bytes], headers:Mapping[str, str]) -> bool

Verifies if the given signature is valid

classslack_sdk.web.async_slack_response.AsyncSlackResponse

An iterable container of response data.

methodslack_sdk.web.base_client.BaseClient.logger() -> logging.Logger

The logger this client uses.

funcslack_sdk.web.internal_utils.convert_bool_to_0_or_1(params:Optional[Dict[str, Any]]) -> Optional[Dict[str, Any]]

Converts all bool values in dict to "0" or "1".

classslack_sdk.web.legacy_slack_response.LegacySlackResponse

An iterable container of response data.

classslack_sdk.web.slack_response.SlackResponse

An iterable container of response data.

About this data

These signatures were extracted from the public source of slackapi/python-slack-sdk using Python's ast module. Argument names, default values, type annotations and return types are taken verbatim from the code. Implementation bodies are never stored. See how it works for details.

Back to all 805 libraries