Models¶

Note

Nearly all classes here have slots defined which means that it is impossible to have dynamic attributes to the data classes.

BaseView¶

View UI blocks

BaseView¶

class slack.view.BaseView¶

Base class of view object.

This class carries abstract methods for all components.

New in version 1.4.0.

Placeholder¶

Attributes

emoji
mrkdwn
text

Methods

defto_dict

class slack.view.Placeholder¶

This represents placeholder for Select or Input

New in version 1.4.0.

text¶

Text for placeholder.

Type: str

mrkdwn¶

Use markdown or not.

Type: bool

emoji¶

Use emoji or not.

Type: bool

to_dict()¶: Converts this object into a dict. :returns: A dictionary of str field keys bound to the respective value. :rtype: Dict[str, Union[str, bool]]

Select¶

Attributes

action_id
initial_text
options
placeholder
select_type

Methods

defto_dict

class slack.view.Select¶

Represents a UI select menu with a list of custom options.

New in version 1.4.0.

action_id¶

ID for this event occured.

Type: str

placeholder¶

Placeholder of select.

Type: Placeholder

options¶

Options to selections. Some type must be this attribute to select.

Type: List[SelectOption]

select_type¶

Select type of this object.

Type: SelectType

initial_text¶

Initial text for selections.

Type: str

to_dict()¶

Converts this object into a dict.

Returns: A dictionary of str field keys bound to the respective value.
Return type: Dict[str, Any]

SelectOption¶

Attributes

description
emoji
mrkdwn
text
value

Methods

defto_dict

class slack.view.SelectOption¶

Option for select items.

New in version 1.4.0.

text¶

Text of select.

Type: str

value¶

Value of select.

Type: str

description¶

Text description of select.

Type: Optional[str]

mrkdwn¶

Markdown or nor.

Type: Optional[bool]

emoji¶

Use emoji or not

Type: Optional[bool]

to_dict()¶

Converts this object into a dict.

New in version 1.4.0.

Returns: A dictionary of str field keys bound to the respective value.
Return type: Dict[str, Dict[str, Union[str, bool]]]

Enums¶

SelectType¶

class slack.view.SelectType¶: Enums of select variety.

New in version 1.4.0.

ViewFrame¶

This is a frame of UI block.

ViewFrame¶

class slack.view.ViewFrame¶

This class is base class for all components.

This class carries abstract methods for all components.

New in version 1.4.0.

View¶

Attributes

blocks

Methods

defadd_block
defto_list

class slack.view.View¶

This is a frame of view block.

New in version 1.4.0.

len(x): Returns the total length of the blocks.

bool(b): Returns whether this has one or more blocks.

Example:

select = Select(
    action_id="action",
    placeholder=Placeholder(
        "text", mrkdwn=False, emoji=True),
        select_type=SelectType.users_select,
        initial_text="initial"
)

view = View(select)
await message.channel.send(view=view)

blocks¶

Blocks of View.

Type: List[BaseView]

add_block(block: BaseView) → View¶

Add block to the view object.

Parameters: block (BaseView) – Add block to this view object. Block must be inherit BaseView.
Returns: Returns self object.
Return type: View

to_list()¶

Converts this object into a dict.

Returns: A dictionary of str embed field keys bound to the respective value.
Return type: Dict[str, Any]