SuggestedActions Class
SuggestedActions that can be performed.
Constructor
pydantic model SuggestedActionsParameters
| Name | Description |
|---|---|
|
to
Required
|
Ids of the recipients that the actions should be shown to. These Ids are relative to the channelId and a subset of all recipients of the activity |
|
actions
Required
|
Actions that can be shown to the user |
Keyword-Only Parameters
| Name | Description |
|---|---|
|
to
|
Default value: <factory>
|
|
actions
|
Default value: None
|
Methods
| add_action |
Adds a single action to the actions and returns this instance. |
| add_actions |
Adds one or more actions to the actions and returns this instance. |
| add_recipients |
Adds one or more recipient ids to the recipients and returns this instance. |
add_action
Adds a single action to the actions and returns this instance.
add_action(action: CardAction) -> SuggestedActionsParameters
| Name | Description |
|---|---|
|
action
Required
|
The action to add. |
Returns
| Type | Description |
|---|---|
|
This instance, to allow for method chaining. |
add_actions
Adds one or more actions to the actions and returns this instance.
add_actions(*actions: CardAction) -> SuggestedActionsParameters
| Name | Description |
|---|---|
|
actions
Required
|
The actions to add. |
Returns
| Type | Description |
|---|---|
|
This instance, to allow for method chaining. |
add_recipients
Adds one or more recipient ids to the recipients and returns this instance.
add_recipients(*recipients: str) -> SuggestedActionsParameters
| Name | Description |
|---|---|
|
recipients
Required
|
The recipient ids to add. |
Returns
| Type | Description |
|---|---|
|
This instance, to allow for method chaining. |
Attributes
actions
field actions: list[CardAction] = Noneto
field to: Annotated[str, StringConstraints(strip_whitespace=None, to_upper=None, to_lower=None, strict=None, min_length=1, max_length=None, pattern=None, ascii_only=None)]] [Optional]