AgentNotificationActivity Classe
Wrapper em torno de um objeto Activity com entidades de notificação digitadas.
Essa classe fornece acesso conveniente a entidades de notificação tipadas extraídas de uma coleção de entidades de atividade. Ele analisa e valida automaticamente notificações por email, comentários do Word/PowerPoint/Excel e eventos de ciclo de vida em tempo de construção.
Construtor
AgentNotificationActivity()
Parâmetros
| Nome | Description |
|---|---|
|
activity
Obrigatório
|
O objeto Activity a ser encapsulado. Não deve ser Nenhum. |
Exemplos
'''<<>><<python async def email_handler(context: TurnContext, state: TurnState, notification: AgentNotificationActivity):
email = notification.email se email:
print(f"Received email: {email.id}")
print(f"Body: {email.html_body}")
''<<>>'<<
Métodos
| __init__ | |
| __new__ | |
| as_model |
Analise o valor da atividade como um tipo de modelo personalizado. Esse método fornece uma maneira genérica de validar e analisar o conteúdo do valor da atividade em qualquer tipo de modelo Pydantic. Útil para tipos de notificação personalizados que não são compatíveis diretamente com as propriedades tipadas. |
__init__
__new__
__new__(**kwargs)
as_model
Analise o valor da atividade como um tipo de modelo personalizado.
Esse método fornece uma maneira genérica de validar e analisar o conteúdo do valor da atividade em qualquer tipo de modelo Pydantic. Útil para tipos de notificação personalizados que não são compatíveis diretamente com as propriedades tipadas.
as_model(model: Type[TModel]) -> TModel | None
Parâmetros
| Nome | Description |
|---|---|
|
model
Obrigatório
|
Type[<xref:microsoft_agents_a365.notifications.models.agent_notification_activity.TModel>]
Uma classe de modelo Pydantic para validar e analisar o valor da atividade. |
Retornos
| Tipo | Description |
|---|---|
|
<xref:microsoft_agents_a365.notifications.models.agent_notification_activity.TModel> | None
|
Uma instância do tipo de modelo especificado se a validação for bem-sucedida, caso contrário, Nenhuma. |
Exemplos
'''<<>><<python da importação pedante BaseModel
classe CustomNotification(BaseModel): custom_field: str
notification = AgentNotificationActivity(activity) custom = notification.as_model(CustomNotification) if custom:
print(custom.custom_field)
''<<>>'<<
Atributos
channel
O identificador de canal do channel_id da atividade.
Retornos
| Tipo | Description |
|---|---|
|
O nome do canal (por exemplo, 'agents', 'msteams') ou Nenhum se não estiver disponível. |
A entidade de referência de email analisada, se presente.
Retornos
| Tipo | Description |
|---|---|
|
Um objeto EmailReference se uma entidade de notificação por email tiver sido encontrada e analisada com êxito, caso contrário, Nenhuma. |
notification_type
O tipo de notificação detectado.
Retornos
| Tipo | Description |
|---|---|
|
O valor de enumeração NotificationTypes que indica o tipo de notificação (EMAIL_NOTIFICATION, WPX_COMMENT ou AGENT_LIFECYCLE) ou Nenhum se o tipo de notificação não pôde ser determinado. |
sub_channel
O identificador de subcanal do channel_id da atividade.
Retornos
| Tipo | Description |
|---|---|
|
O nome do subcanal (por exemplo, 'email', 'word') ou Nenhum se não estiver disponível. |
type
O tipo de atividade.
Retornos
| Tipo | Description |
|---|---|
|
O tipo da atividade (por exemplo, 'message', 'event') ou None se não for definido. |
value
O conteúdo do valor da atividade.
Retornos
| Tipo | Description |
|---|---|
|
O valor da atividade, que pode conter dados de notificação adicionais. |
wpx_comment
A entidade de comentário do Word/PowerPoint/Excel analisada, se presente.
Retornos
| Tipo | Description |
|---|---|
|
Um objeto WpxComment se uma entidade de comentário tiver sido encontrada e analisada com êxito, caso contrário, Nenhuma. |
activity
O objeto Atividade subjacente.