Get-MgTeamChannelMessageDelta
Retrieve the list of messages (without the replies) in a channel of a team. By using delta query, you can get new or updated messages in a channel. Delta query supports both full synchronization that retrieves all the messages in the specified channel, and incremental synchronization that retrieves those messages that have been added or changed in the channel since the last synchronization. Typically, you would do an initial full synchronization, and then get incremental changes to that messages view periodically. To get the replies for a message, use the list message replies or the get message reply operation. A GET request with the delta function returns either: State tokens are opaque to the client. To proceed with a round of change tracking, copy and apply the @odata.nextLink or @odata.deltaLink URL returned from the last GET request to the next delta function call for that same calendar view. A @odata.deltaLink returned in a response signifies that the current round of change tracking is complete. You can save and use the @odata.deltaLink URL when you begin to retrieve more changes (messages changed or posted after acquiring @odata.deltaLink). For more information, see the delta query documentation.
Note
To view the beta release of this cmdlet, view Get-MgBetaTeamChannelMessageDelta
Syntax
Get-MgTeamChannelMessageDelta
-ChannelId <String>
-TeamId <String>
[-ExpandProperty <String[]>]
[-Filter <String>]
[-Property <String[]>]
[-Search <String>]
[-Skip <Int32>]
[-Sort <String[]>]
[-Top <Int32>]
[-ResponseHeadersVariable <String>]
[-Headers <IDictionary>]
[-PageSize <Int32>]
[-All]
[-CountVariable <String>]
[-ProgressAction <ActionPreference>]
[<CommonParameters>]
Get-MgTeamChannelMessageDelta
-InputObject <ITeamsIdentity>
[-ExpandProperty <String[]>]
[-Filter <String>]
[-Property <String[]>]
[-Search <String>]
[-Skip <Int32>]
[-Sort <String[]>]
[-Top <Int32>]
[-Count]
[-ResponseHeadersVariable <String>]
[-Headers <IDictionary>]
[-ProgressAction <ActionPreference>]
[<CommonParameters>]
Description
Retrieve the list of messages (without the replies) in a channel of a team. By using delta query, you can get new or updated messages in a channel. Delta query supports both full synchronization that retrieves all the messages in the specified channel, and incremental synchronization that retrieves those messages that have been added or changed in the channel since the last synchronization. Typically, you would do an initial full synchronization, and then get incremental changes to that messages view periodically. To get the replies for a message, use the list message replies or the get message reply operation. A GET request with the delta function returns either: State tokens are opaque to the client. To proceed with a round of change tracking, copy and apply the @odata.nextLink or @odata.deltaLink URL returned from the last GET request to the next delta function call for that same calendar view. A @odata.deltaLink returned in a response signifies that the current round of change tracking is complete. You can save and use the @odata.deltaLink URL when you begin to retrieve more changes (messages changed or posted after acquiring @odata.deltaLink). For more information, see the delta query documentation.
Permissions
Permission type | Least privileged permissions | Higher privileged permissions |
---|---|---|
Delegated (work or school account) | ChannelMessage.Read.All | Group.Read.All, Group.ReadWrite.All |
Delegated (personal Microsoft account) | Not supported. | Not supported. |
Application | ChannelMessage.Read.Group | ChannelMessage.Read.All, Group.Read.All, Group.ReadWrite.All |
Examples
Example 1: Code snippet
Import-Module Microsoft.Graph.Teams
Get-MgTeamChannelMessageDelta -TeamId $teamId -ChannelId $channelId -Top 2
This example shows how to use the Get-MgTeamChannelMessageDelta Cmdlet.
Example 2: Code snippet
Import-Module Microsoft.Graph.Teams
Get-MgTeamChannelMessageDelta -TeamId $teamId -ChannelId $channelId -Skiptoken "-FG3FPHv7HuyuazNLuy3eXlzQGbEjYLUsW9-pYkmXgn5KGsaOwrCoor2W23dGNNM1KtAX4AyvpFQNVsBgsEwUOX9lw8x9zDumgJy-C-UbjZLlZDQACyC9FyrVelZus9n.--rshdLwy_WBFJd8anPXJPbSUtUD7r3V4neB5tcrG58"
This example shows how to use the Get-MgTeamChannelMessageDelta Cmdlet.
Example 3: Code snippet
Import-Module Microsoft.Graph.Teams
Get-MgTeamChannelMessageDelta -TeamId $teamId -ChannelId $channelId -Skiptoken "8UusBixEHS9UUau6uGcryrA6FpnWwMJbuTYILM1PArHxnZzDVcsHQrijNzCyIVeEauMQsKUfMhNjLWFs1o4sBS_LofJ7xMftZUfec_pijuT6cAk5ugcWCca9RCjK7iVj.DKZ9w4bX9vCR7Sj9P0_qxjLAAPiEZgxlOxxmCLMzHJ4"
This example shows how to use the Get-MgTeamChannelMessageDelta Cmdlet.
Example 4: Code snippet
Import-Module Microsoft.Graph.Teams
Get-MgTeamChannelMessageDelta -TeamId $teamId -ChannelId $channelId -Deltatoken "aQdvS1VwGCSRxVmZJqykmDik_JIC44iCZpv-GLiA2VnFuE5yG-kCEBROb2iaPT_y_eMWVQtBO_ejzzyIxl00ji-tQ3HzAbW4liZAVG88lO3nG_6-MBFoHY1n8y21YUzjocG-Cn1tCNeeLPLTzIe5Dw.EP9gLiCoF2CE_e6l_m1bTk2aokD9KcgfgfcLGqd1r_4"
This example shows how to use the Get-MgTeamChannelMessageDelta Cmdlet.
Parameters
-All
List all pages.
Type: | SwitchParameter |
Position: | Named |
Default value: | False |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
-ChannelId
The unique identifier of channel
Type: | String |
Position: | Named |
Default value: | None |
Required: | True |
Accept pipeline input: | False |
Accept wildcard characters: | False |
-Count
Include count of items
Type: | SwitchParameter |
Position: | Named |
Default value: | False |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
-CountVariable
Specifies a count of the total number of items in a collection. By default, this variable will be set in the global scope.
Type: | String |
Aliases: | CV |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
-ExpandProperty
Expand related entities
Type: | String[] |
Aliases: | Expand |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
-Filter
Filter items by property values
Type: | String |
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: | ITeamsIdentity |
Position: | Named |
Default value: | None |
Required: | True |
Accept pipeline input: | True |
Accept wildcard characters: | False |
-PageSize
Sets the page size of results.
Type: | Int32 |
Position: | Named |
Default value: | 0 |
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 |
-Property
Select properties to be returned
Type: | String[] |
Aliases: | Select |
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 |
-Search
Search items by search phrases
Type: | String |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
-Skip
Skip the first n items
Type: | Int32 |
Position: | Named |
Default value: | 0 |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
-Sort
Order items by property values
Type: | String[] |
Aliases: | OrderBy |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
-TeamId
The unique identifier of team
Type: | String |
Position: | Named |
Default value: | None |
Required: | True |
Accept pipeline input: | False |
Accept wildcard characters: | False |
-Top
Show only the first n items
Type: | Int32 |
Aliases: | Limit |
Position: | Named |
Default value: | 0 |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
Inputs
Microsoft.Graph.PowerShell.Models.ITeamsIdentity
System.Collections.IDictionary
Outputs
Microsoft.Graph.PowerShell.Models.IMicrosoftGraphChatMessage
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.
INPUTOBJECT <ITeamsIdentity>
: Identity Parameter
[AssociatedTeamInfoId <String>]
: The unique identifier of associatedTeamInfo[ChannelId <String>]
: The unique identifier of channel[ChatId <String>]
: The unique identifier of chat[ChatMessageHostedContentId <String>]
: The unique identifier of chatMessageHostedContent[ChatMessageId <String>]
: The unique identifier of chatMessage[ChatMessageId1 <String>]
: The unique identifier of chatMessage[ConversationMemberId <String>]
: The unique identifier of conversationMember[DeletedChatId <String>]
: The unique identifier of deletedChat[DeletedTeamId <String>]
: The unique identifier of deletedTeam[GroupId <String>]
: The unique identifier of group[OfferShiftRequestId <String>]
: The unique identifier of offerShiftRequest[OpenShiftChangeRequestId <String>]
: The unique identifier of openShiftChangeRequest[OpenShiftId <String>]
: The unique identifier of openShift[PinnedChatMessageInfoId <String>]
: The unique identifier of pinnedChatMessageInfo[ResourceSpecificPermissionGrantId <String>]
: The unique identifier of resourceSpecificPermissionGrant[SchedulingGroupId <String>]
: The unique identifier of schedulingGroup[SharedWithChannelTeamInfoId <String>]
: The unique identifier of sharedWithChannelTeamInfo[ShiftId <String>]
: The unique identifier of shift[SwapShiftsChangeRequestId <String>]
: The unique identifier of swapShiftsChangeRequest[TeamId <String>]
: The unique identifier of team[TeamsAppDefinitionId <String>]
: The unique identifier of teamsAppDefinition[TeamsAppId <String>]
: The unique identifier of teamsApp[TeamsAppInstallationId <String>]
: The unique identifier of teamsAppInstallation[TeamsAsyncOperationId <String>]
: The unique identifier of teamsAsyncOperation[TeamsTabId <String>]
: The unique identifier of teamsTab[TeamworkTagId <String>]
: The unique identifier of teamworkTag[TeamworkTagMemberId <String>]
: The unique identifier of teamworkTagMember[TimeOffId <String>]
: The unique identifier of timeOff[TimeOffReasonId <String>]
: The unique identifier of timeOffReason[TimeOffRequestId <String>]
: The unique identifier of timeOffRequest[UserId <String>]
: The unique identifier of user[UserScopeTeamsAppInstallationId <String>]
: The unique identifier of userScopeTeamsAppInstallation[WorkforceIntegrationId <String>]
: The unique identifier of workforceIntegration