@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
| create |
Creates a wrapper for an agent notification activity. |
| create |
Factory function to create an EmailReference entity. |
| create |
Factory function to create an EmailResponse entity. |
| create |
Creates an activity with an EmailResponse entity |
| create |
Factory function to create a WpxComment entity. |
| is |
Type guard to check if an entity is an EmailReference. |
| is |
Type guard to check if an entity is a WpxComment. |
Variables
| AGENTS_CHANNEL | Channel and sub-channel constants for agent notifications. |
| AGENTS_EMAIL_SUBCHANNEL | |
| AGENTS_EXCEL_SUBCHANNEL | |
| AGENTS_POWERPOINT_SUBCHANNEL | |
| AGENTS_WORD_SUBCHANNEL | |
| AGENT_LIFECYCLE | Lifecycle constants for agent notifications. |
| EMAIL_NOTIFICATION_TYPE | The entity type name for email notifications. |
| EMAIL_RESPONSE_TYPE | The entity type name for email responses. |
| USER_CREATED_LIFECYCLE_EVENT | |
| USER_DELETED_LIFECYCLE_EVENT | |
| USER_WORKLOAD_ONBOARDING_LIFECYCLE_EVENT | |
| WPX_COMMENT_TYPE | The entity type name for WPX comments. |
Function Details
createAgentNotificationActivity(Activity)
Creates a wrapper for an agent notification activity.
function createAgentNotificationActivity(activity: Activity): AgentNotificationActivityParameters
- activity
- Activity
The activity
Returns
An agent notification activity
createEmailReference(string, string, string)
Factory function to create an EmailReference entity.
function createEmailReference(id?: string, conversationId?: string, htmlBody?: string): EmailReferenceParameters
- id
-
string
- conversationId
-
string
- htmlBody
-
string
Returns
createEmailResponse(string)
Factory function to create an EmailResponse entity.
function createEmailResponse(htmlBody?: string): EmailResponseParameters
- htmlBody
-
string
Returns
createEmailResponseActivity(string)
Creates an activity with an EmailResponse entity
function createEmailResponseActivity(emailResponseHtmlBody?: string): ActivityParameters
- emailResponseHtmlBody
-
string
(Optional) The HTML body content for the email response
Returns
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): WpxCommentParameters
- odataId
-
string
- documentId
-
string
- initiatingCommentId
-
string
- subjectCommentId
-
string
Returns
isEmailReference(Entity)
Type guard to check if an entity is an EmailReference.
function isEmailReference(entity: Entity): entityParameters
- entity
- Entity
Returns
entity
isWpxComment(Entity)
Type guard to check if an entity is a WpxComment.
function isWpxComment(entity: Entity): entityParameters
- entity
- Entity
Returns
entity
Variable Details
AGENTS_CHANNEL
Channel and sub-channel constants for agent notifications.
AGENTS_CHANNEL: "agents"Type
"agents"
AGENTS_EMAIL_SUBCHANNEL
AGENTS_EMAIL_SUBCHANNEL: "agents:email"Type
"agents:email"
AGENTS_EXCEL_SUBCHANNEL
AGENTS_EXCEL_SUBCHANNEL: "agents:excel"Type
"agents:excel"
AGENTS_POWERPOINT_SUBCHANNEL
AGENTS_POWERPOINT_SUBCHANNEL: "agents:powerpoint"Type
"agents:powerpoint"
AGENTS_WORD_SUBCHANNEL
AGENTS_WORD_SUBCHANNEL: "agents:word"Type
"agents:word"
AGENT_LIFECYCLE
Lifecycle constants for agent notifications.
AGENT_LIFECYCLE: "agentlifecycle"Type
"agentlifecycle"
EMAIL_NOTIFICATION_TYPE
The entity type name for email notifications.
EMAIL_NOTIFICATION_TYPE: "emailNotification"Type
"emailNotification"
EMAIL_RESPONSE_TYPE
The entity type name for email responses.
EMAIL_RESPONSE_TYPE: "emailResponse"Type
"emailResponse"
USER_CREATED_LIFECYCLE_EVENT
USER_CREATED_LIFECYCLE_EVENT: "agenticuseridentitycreated"Type
"agenticuseridentitycreated"
USER_DELETED_LIFECYCLE_EVENT
USER_DELETED_LIFECYCLE_EVENT: "agenticuserdeleted"Type
"agenticuserdeleted"
USER_WORKLOAD_ONBOARDING_LIFECYCLE_EVENT
USER_WORKLOAD_ONBOARDING_LIFECYCLE_EVENT: "agenticuserworkloadonboardingupdated"Type
"agenticuserworkloadonboardingupdated"
WPX_COMMENT_TYPE
The entity type name for WPX comments.
WPX_COMMENT_TYPE: "WpxComment"Type
"WpxComment"