Send-MgUserChatActivityNotification

Module:

Microsoft.Graph.Users.Actions

Send an activity feed notification in scope of a chat. For more information about sending notifications and the requirements for doing so, see sending Teams activity notifications.

Note

To view the beta release of this cmdlet, view Send-MgBetaUserChatActivityNotification

Syntax

Send-MgUserChatActivityNotification
    -ChatId <String>
    -UserId <String>
    [-ResponseHeadersVariable <String>]
    [-ActivityType <String>]
    [-AdditionalProperties <Hashtable>]
    [-ChainId <Int64>]
    [-PreviewText <IMicrosoftGraphItemBody>]
    [-Recipient <Hashtable>]
    [-TeamsAppId <String>]
    [-TemplateParameters <IMicrosoftGraphKeyValuePair[]>]
    [-Topic <IMicrosoftGraphTeamworkActivityTopic>]
    [-Headers <IDictionary>]
    [-PassThru]
    [-ProgressAction <ActionPreference>]
    [-WhatIf]
    [-Confirm]
    [<CommonParameters>]

Send-MgUserChatActivityNotification
    -ChatId <String>
    -UserId <String>
    -BodyParameter <IPathsBdscpeUsersUserIdChatsChatIdMicrosoftGraphSendactivitynotificationPostRequestbodyContentApplicationJsonSchema>
    [-ResponseHeadersVariable <String>]
    [-Headers <IDictionary>]
    [-PassThru]
    [-ProgressAction <ActionPreference>]
    [-WhatIf]
    [-Confirm]
    [<CommonParameters>]

Send-MgUserChatActivityNotification
    -InputObject <IUsersActionsIdentity>
    [-ResponseHeadersVariable <String>]
    [-ActivityType <String>]
    [-AdditionalProperties <Hashtable>]
    [-ChainId <Int64>]
    [-PreviewText <IMicrosoftGraphItemBody>]
    [-Recipient <Hashtable>]
    [-TeamsAppId <String>]
    [-TemplateParameters <IMicrosoftGraphKeyValuePair[]>]
    [-Topic <IMicrosoftGraphTeamworkActivityTopic>]
    [-Headers <IDictionary>]
    [-PassThru]
    [-ProgressAction <ActionPreference>]
    [-WhatIf]
    [-Confirm]
    [<CommonParameters>]

Send-MgUserChatActivityNotification
    -InputObject <IUsersActionsIdentity>
    -BodyParameter <IPathsBdscpeUsersUserIdChatsChatIdMicrosoftGraphSendactivitynotificationPostRequestbodyContentApplicationJsonSchema>
    [-ResponseHeadersVariable <String>]
    [-Headers <IDictionary>]
    [-PassThru]
    [-ProgressAction <ActionPreference>]
    [-WhatIf]
    [-Confirm]
    [<CommonParameters>]

Description

Send an activity feed notification in scope of a chat. For more information about sending notifications and the requirements for doing so, see sending Teams activity notifications.

Parameters

-ActivityType

.

Type:	String
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-AdditionalProperties

Additional Parameters

Type:	Hashtable
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-BodyParameter

. To construct, see NOTES section for BODYPARAMETER properties and create a hash table.

Type:	IPathsBdscpeUsersUserIdChatsChatIdMicrosoftGraphSendactivitynotificationPostRequestbodyContentApplicationJsonSchema
Position:	Named
Default value:	None
Required:	True
Accept pipeline input:	True
Accept wildcard characters:	False

-ChainId

.

Type:	Int64
Position:	Named
Default value:	0
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-ChatId

The unique identifier of chat

Type:	String
Position:	Named
Default value:	None
Required:	True
Accept pipeline input:	False
Accept wildcard characters:	False

-Confirm

Prompts you for confirmation before running the cmdlet.

Type:	SwitchParameter
Aliases:	cf
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-Headers

Optional headers that will be added to the request.

Type:	IDictionary
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	True
Accept wildcard characters:	False

-InputObject

Identity Parameter To construct, see NOTES section for INPUTOBJECT properties and create a hash table.

Type:	IUsersActionsIdentity
Position:	Named
Default value:	None
Required:	True
Accept pipeline input:	True
Accept wildcard characters:	False

-PassThru

Returns true when the command succeeds

Type:	SwitchParameter
Position:	Named
Default value:	False
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-PreviewText

itemBody To construct, see NOTES section for PREVIEWTEXT properties and create a hash table.

Type:	IMicrosoftGraphItemBody
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-ProgressAction

{{ Fill ProgressAction Description }}

Type:	ActionPreference
Aliases:	proga
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-Recipient

teamworkNotificationRecipient

Type:	Hashtable
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-ResponseHeadersVariable

Optional Response Headers Variable.

Type:	String
Aliases:	RHV
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-TeamsAppId

.

Type:	String
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-TemplateParameters

. To construct, see NOTES section for TEMPLATEPARAMETERS properties and create a hash table.

Type:	IMicrosoftGraphKeyValuePair[]
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-Topic

teamworkActivityTopic To construct, see NOTES section for TOPIC properties and create a hash table.

Type:	IMicrosoftGraphTeamworkActivityTopic
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-UserId

The unique identifier of user

Type:	String
Position:	Named
Default value:	None
Required:	True
Accept pipeline input:	False
Accept wildcard characters:	False

-WhatIf

Shows what would happen if the cmdlet runs. The cmdlet is not run.

Type:	SwitchParameter
Aliases:	wi
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

Inputs

Microsoft.Graph.PowerShell.Models.IPathsBdscpeUsersUserIdChatsChatIdMicrosoftGraphSendactivitynotificationPostRequestbodyContentApplicationJsonSchema

Microsoft.Graph.PowerShell.Models.IUsersActionsIdentity

System.Collections.IDictionary

Outputs

System.Boolean

Notes

COMPLEX PARAMETER PROPERTIES

To create the parameters described below, construct a hash table containing the appropriate properties. For information on hash tables, run Get-Help about_Hash_Tables.

BODYPARAMETER <IPathsBdscpeUsersUserIdChatsChatIdMicrosoftGraphSendactivitynotificationPostRequestbodyContentApplicationJsonSchema>: .

• [(Any) <Object>]: This indicates any property can be added to this object.
• [ActivityType <String>]:
• [ChainId <Int64?>]:
• [PreviewText <IMicrosoftGraphItemBody>]: itemBody
  • [(Any) <Object>]: This indicates any property can be added to this object.
  • [Content <String>]: The content of the item.
  • [ContentType <String>]: bodyType
• [Recipient <IMicrosoftGraphTeamworkNotificationRecipient>]: teamworkNotificationRecipient
  • [(Any) <Object>]: This indicates any property can be added to this object.
• [TeamsAppId <String>]:
• [TemplateParameters <IMicrosoftGraphKeyValuePair- []>]:
  • [Name <String>]: Name for this key-value pair
  • [Value <String>]: Value for this key-value pair
• [Topic <IMicrosoftGraphTeamworkActivityTopic>]: teamworkActivityTopic
  • [(Any) <Object>]: This indicates any property can be added to this object.
  • [Source <String>]: teamworkActivityTopicSource
  • [Value <String>]: The topic value. If the value of the source property is entityUrl, this must be a Microsoft Graph URL. If the value is text, this must be a plain text value.
  • [WebUrl <String>]: The link the user clicks when they select the notification. Optional when source is entityUrl; required when source is text.

INPUTOBJECT <IUsersActionsIdentity>: Identity Parameter

• [AuthenticationMethodId <String>]: The unique identifier of authenticationMethod
• [CalendarId <String>]: The unique identifier of calendar
• [ChatId <String>]: The unique identifier of chat
• [ChatMessageId <String>]: The unique identifier of chatMessage
• [ChatMessageId1 <String>]: The unique identifier of chatMessage
• [ContentTypeId <String>]: The unique identifier of contentType
• [DeviceLogCollectionResponseId <String>]: The unique identifier of deviceLogCollectionResponse
• [DocumentSetVersionId <String>]: The unique identifier of documentSetVersion
• [DriveId <String>]: The unique identifier of drive
• [DriveItemId <String>]: The unique identifier of driveItem
• [DriveItemVersionId <String>]: The unique identifier of driveItemVersion
• [EventId <String>]: The unique identifier of event
• [EventId1 <String>]: The unique identifier of event
• [ListItemId <String>]: The unique identifier of listItem
• [ListItemVersionId <String>]: The unique identifier of listItemVersion
• [MailFolderId <String>]: The unique identifier of mailFolder
• [MailFolderId1 <String>]: The unique identifier of mailFolder
• [ManagedDeviceId <String>]: The unique identifier of managedDevice
• [MessageId <String>]: The unique identifier of message
• [NotebookId <String>]: The unique identifier of notebook
• [OnenotePageId <String>]: The unique identifier of onenotePage
• [OnenoteSectionId <String>]: The unique identifier of onenoteSection
• [OnlineMeetingId <String>]: The unique identifier of onlineMeeting
• [PermissionId <String>]: The unique identifier of permission
• [PhoneAuthenticationMethodId <String>]: The unique identifier of phoneAuthenticationMethod
• [SubscriptionId <String>]: The unique identifier of subscription
• [TeamsAppInstallationId <String>]: The unique identifier of teamsAppInstallation
• [TodoTaskId <String>]: The unique identifier of todoTask
• [TodoTaskListId <String>]: The unique identifier of todoTaskList
• [UserId <String>]: The unique identifier of user

PREVIEWTEXT <IMicrosoftGraphItemBody>: itemBody

• [(Any) <Object>]: This indicates any property can be added to this object.
• [Content <String>]: The content of the item.
• [ContentType <String>]: bodyType

TEMPLATEPARAMETERS <IMicrosoftGraphKeyValuePair- []>: .

• [Name <String>]: Name for this key-value pair
• [Value <String>]: Value for this key-value pair

TOPIC <IMicrosoftGraphTeamworkActivityTopic>: teamworkActivityTopic

• [(Any) <Object>]: This indicates any property can be added to this object.
• [Source <String>]: teamworkActivityTopicSource
• [Value <String>]: The topic value. If the value of the source property is entityUrl, this must be a Microsoft Graph URL. If the value is text, this must be a plain text value.
• [WebUrl <String>]: The link the user clicks when they select the notification. Optional when source is entityUrl; required when source is text.

Related Links

• https://learn.microsoft.com/powershell/module/microsoft.graph.users.actions/send-mguserchatactivitynotification
• https://learn.microsoft.com/graph/api/chat-sendactivitynotification?view=graph-rest-1.0