SlackClient

Attributes

TRIGGER_OPERATIONS module-attribute

TRIGGER_OPERATIONS: Dict[str, Dict[str, Any]] = {'OnNewFile': {'operation_id': 'OnNewFile', 'path': '/{connectionId}/trigger/files.list', 'method': 'get', 'required_parameters': ['channel'], 'callback_payload_type': None}}

Classes

SetDNDResponse dataclass

SetDNDResponse(snooze_enabled: Optional[bool] = None)

Response for Set do not disturb

Attributes

snooze_enabled class-attribute instance-attribute

snooze_enabled: Optional[bool] = None

Whether snooze is enabled.

CreateChannelResponse dataclass

CreateChannelResponse(channel: Optional[Channel] = None)

Response for Create a channel

JoinChannelResponse dataclass

JoinChannelResponse(channel: Optional[Channel] = None, warning: Optional[str] = None)

Response for Join a public channel

Attributes

warning class-attribute instance-attribute

warning: Optional[str] = None

Whether the user is already in the channel or not.

ListChannelsResponse dataclass

ListChannelsResponse(value: Optional[List[Channel]] = None, next_link: Optional[str] = None)

Response for List public channels (Pagination support)

Attributes

next_link class-attribute instance-attribute

next_link: Optional[str] = field(default=None, metadata={'wire_name': '@odata.nextLink'})

Link to get next page of results

PostMessageResponse dataclass

PostMessageResponse(ok: Optional[bool] = None, channel: Optional[str] = None, ts: Optional[str] = None, message: Optional[Dict[str, Any]] = None, error: Optional[str] = None)

Response for Post message

Attributes

ok class-attribute instance-attribute

ok: Optional[bool] = None

Indicates if the operation was successful.

channel class-attribute instance-attribute

channel: Optional[str] = None

The channel which the message was posted to.

ts class-attribute instance-attribute

ts: Optional[str] = None

Unix timestamp for when the message was created.

message class-attribute instance-attribute

message: Optional[Dict[str, Any]] = None

A channel message.

error class-attribute instance-attribute

error: Optional[str] = None

Details of the error messages, if any.

Channel dataclass

Channel(id: Optional[str] = None, name: Optional[str] = None)

Definition: Channel

Attributes

id class-attribute instance-attribute

id: Optional[str] = None

The id of the channel.

name class-attribute instance-attribute

name: Optional[str] = None

The name of channel.

PostMessageRequest dataclass

PostMessageRequest(channel: Optional[str] = None, text: Optional[str] = None, username: Optional[str] = None, as_user: Optional[bool] = None, parse: Optional[str] = None, mrkdwn: Optional[bool] = None, link_names: Optional[int] = None, unfurl_links: Optional[bool] = None, unfurl_media: Optional[bool] = None, icon_url: Optional[str] = None, icon_emoji: Optional[str] = None)

Definition: PostMessageRequest

Attributes

channel class-attribute instance-attribute

channel: Optional[str] = None

Channel, private group, or IM channel to send message to. Can be a name(ex:

general) or an encoded ID.

text class-attribute instance-attribute

text: Optional[str] = None

Body of the message to send. Slack API will truncate messages containing more than 40,000 characters. For formatting options, see https://api.slack.com/docs/formatting

username class-attribute instance-attribute

username: Optional[str] = None

Name of the bot.

as_user class-attribute instance-attribute

as_user: Optional[bool] = None

Pass true to post the message as the authenticated user, instead of as a bot.

parse class-attribute instance-attribute

parse: Optional[str] = None

Change how messages are treated. For details, see https://api.slack.com/docs/formatting

mrkdwn class-attribute instance-attribute

mrkdwn: Optional[bool] = None

Slack markup parsing setting. Enabled by default.

link_names class-attribute instance-attribute

link_names: Optional[int] = None

Find and link channel names and usernames.

unfurl_links class-attribute instance-attribute

unfurl_links: Optional[bool] = None

Pass true to enable unfurling of primarily text-based content.

unfurl_media class-attribute instance-attribute

unfurl_media: Optional[bool] = None

Pass false to disable unfurling of media content.

icon_url class-attribute instance-attribute

icon_url: Optional[str] = None

URL to an image to use as an icon for this message.

icon_emoji class-attribute instance-attribute

icon_emoji: Optional[str] = None

Emoji to use as an icon for this message.

SlackClient

SlackClient(connection_runtime_url: str, token_provider: Optional[TokenProvider] = None, options: Optional[ConnectorClientOptions] = None)

Bases: ConnectorClientBase

Typed client for slack connector.

Initialize a SlackClient.

Parameters:

Name	Type	Description	Default
connection_runtime_url	str	The connection runtime URL from Azure Portal.	required
token_provider	Optional[TokenProvider]	Optional token provider. Defaults to ManagedIdentityTokenProvider.	None
options	Optional[ConnectorClientOptions]	Optional connector client options.	None

Methods:

set_dnd_async async

set_dnd_async(num_minutes: Optional[str] = None) -> dict[str, Any] | None

Set do not disturb

Set the do not disturb status for the user.

create_channel_async async

create_channel_async(name: Optional[str] = None, is_private: Optional[bool] = None) -> dict[str, Any] | None

Create a channel

Create a channel in slack.

join_channel_async async

join_channel_async(channel: Optional[str] = None) -> dict[str, Any] | None

Join a public channel

Join a public channel in slack.

list_channels_async async

list_channels_async() -> dict[str, Any] | None

List public channels (Pagination support)

List the public channels in slack.

post_message_async async

post_message_async(input: PostMessageRequest) -> dict[str, Any] | None

Post message

This operation is used to post a message to the specified channel.