Share via

@microsoft/agents-a365-notifications package

Interfaces

AgentNotificationActivity

Represents a parsed agent notification activity with strongly-typed notification data.
EmailReference

Represents an email notification entity.
EmailResponse

Represents an email response entity to be sent back.
WpxComment

Represents a Word (WPX) comment notification entity.

Type Aliases

AgentNotificationHandler

Type definition for an agent notification handler function. Handles agent notification activities with strongly-typed notification data.

Enums

NotificationType

Enum representing the types of notifications that can be received.

Functions

createAgentNotificationActivity(Activity)

Creates a wrapper for an agent notification activity.
createEmailReference(string, string, string)

Factory function to create an EmailReference entity.
createEmailResponse(string)

Factory function to create an EmailResponse entity.
createEmailResponseActivity(string)

Creates an activity with an EmailResponse entity
createWpxComment(string, string, string, string)

Factory function to create a WpxComment entity.
isEmailReference(Entity)

Type guard to check if an entity is an EmailReference.
isWpxComment(Entity)

Type guard to check if an entity is a WpxComment.

Function Details

createAgentNotificationActivity(Activity)

Creates a wrapper for an agent notification activity.

function createAgentNotificationActivity(activity: Activity): AgentNotificationActivity

Parameters

activity
Activity

The activity

Returns

AgentNotificationActivity

An agent notification activity

createEmailReference(string, string, string)

Factory function to create an EmailReference entity.

function createEmailReference(id?: string, conversationId?: string, htmlBody?: string): EmailReference

Parameters

id

string

conversationId

string

htmlBody

string

Returns

EmailReference

createEmailResponse(string)

Factory function to create an EmailResponse entity.

function createEmailResponse(htmlBody?: string): EmailResponse

Parameters

htmlBody

string

Returns

EmailResponse

createEmailResponseActivity(string)

Creates an activity with an EmailResponse entity

function createEmailResponseActivity(emailResponseHtmlBody?: string): Activity

Parameters

emailResponseHtmlBody

string

(Optional) The HTML body content for the email response

Returns

Activity

A message activity containing the EmailResponse entity

createWpxComment(string, string, string, string)

Factory function to create a WpxComment entity.

function createWpxComment(odataId?: string, documentId?: string, initiatingCommentId?: string, subjectCommentId?: string): WpxComment

Parameters

odataId

string

documentId

string

initiatingCommentId

string

subjectCommentId

string

Returns

WpxComment

isEmailReference(Entity)

Type guard to check if an entity is an EmailReference.

function isEmailReference(entity: Entity): entity

Parameters

entity
Entity

Returns

entity

isWpxComment(Entity)

Type guard to check if an entity is a WpxComment.

function isWpxComment(entity: Entity): entity

Parameters

entity
Entity

Returns

entity