HandoffActionInvokeActivity Class

Handoff action invoke activity for handoff/action invokes.

Represents an invoke activity when a handoff action occurs, typically used for transferring conversation control.

Create a new model by parsing and validating input data from keyword arguments.

Raises [ValidationError][pydantic_core.ValidationError] if the input data cannot be validated to form a valid model.

self is explicitly positional-only to allow self as a field name.

Constructor

HandoffActionInvokeActivity(*, serviceUrl: str | None = None, timestamp: datetime | None = None, locale: str | None = None, localTimestamp: datetime | None = None, channelId: Literal['webchat', 'msteams'] | str = 'msteams', from_: Account, conversation: ConversationAccount, replyToId: str | None = None, entities: List[ClientInfoEntity | MentionEntity | MessageEntity | AIMessageEntity | StreamInfoEntity | CitationEntity | SensitiveUsageEntity | ProductInfoEntity | QuotedReplyEntity | TargetedMessageInfoEntity | UnknownEntity] | None = None, channelData: ChannelData | None = None, type: Literal['invoke'] = 'invoke', id: str, recipient: Account, name: Literal['handoff/action'] = 'handoff/action', value: HandoffActionValue, **extra_data: Any)

Keyword-Only Parameters

Name	Description
serviceUrl	Default value: None
timestamp	Default value: None
locale	Default value: None
localTimestamp	Default value: None
channelId	Default value: msteams
from_ Required
conversation Required
replyToId	Default value: None
entities	Default value: None
channelData	Default value: None
type	Default value: invoke
id Required
recipient Required
name	Default value: handoff/action
value Required

Attributes

model_config

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

model_config: ClassVar[ConfigDict] = {'alias_generator': AliasGenerator(alias=None, validation_alias=<staticmethod(<function CustomBaseModel.validation_alias_generator>)>, serialization_alias=<staticmethod(<function CustomBaseModel.serialization_alias_generator>)>), 'arbitrary_types_allowed': True, 'extra': 'allow', 'populate_by_name': True, 'serialize_by_alias': True, 'validate_by_alias': True, 'validate_by_name': True}

name

The name of the operation associated with an invoke or event activity.

name: Literal['handoff/action']

value

A value that is associated with the activity.

value: HandoffActionValue