add Remove-MatrixRoomMessage (#4)

* fix debug url

* fix `MatrixMessage` type

* add `Remove-MatrixRoomMessage`

* add `Get-Help` block

PSMatrix.psd1

@@ -77,7 +77,8 @@ FunctionsToExport = @(
     'Get-MatrixJoinedRooms',
     'Get-MatrixJoinedMembers',
     'Get-MatrixRoomId',
-    'Get-MatrixRoomMessages'
+    'Get-MatrixRoomMessages',
+    'Remove-MatrixRoomMessage'
 )
 
 # Cmdlets to export from this module, for best performance, do not use wildcards and do not delete the entry, use an empty array if there are no cmdlets to export.

PSMatrixTypes.ps1xml

@@ -2,30 +2,22 @@
   <Type>
     <Name>MatrixMessage</Name>
     <Members>
-      <NoteProperty>
+      <MemberSet>
-        <Name>EventID</Name>
+        <Name>PSStandardMembers</Name>
-        <Value>EventID</Value>
+        <Members>
-      </NoteProperty>
+          <PropertySet>
-      <NoteProperty>
+            <Name>DefaultDisplayPropertySet</Name>
-        <Name>Sender</Name>
+            <ReferencedProperties>
-        <Value>Sender</Value>
+              <Name>EventID</Name>
-      </NoteProperty>
+              <Name>Sender</Name>
-      <NoteProperty>
+              <Name>Body</Name>
-        <Name>Body</Name>
+              <Name>Format</Name>
-        <Value>Body</Value>
+              <Name>FormattedBody</Name>
-      </NoteProperty>
+              <Name>MsgType</Name>
-      <NoteProperty>
+            </ReferencedProperties>
-        <Name>Format</Name>
+          </PropertySet>
-        <Value>Format</Value>
+        </Members>
-      </NoteProperty>
+      </MemberSet>
-      <NoteProperty>
-        <Name>FormattedBody</Name>
-        <Value>FormattedBody</Value>
-      </NoteProperty>
-      <NoteProperty>
-        <Name>MsgType</Name>
-        <Value>MsgType</Value>
-      </NoteProperty>
     </Members>
   </Type>
 </Types>

public/Get-MatrixRoomMessages.ps1

@@ -16,7 +16,6 @@ function Get-MatrixRoomMessages {
         [int]$Limit = 50
     )
 
-    Write-Debug "URL: $url"
     $headers = Get-MatrixAuthHeaders -AccessToken $AccessToken
 
     try {
@@ -51,6 +50,8 @@ function Get-MatrixRoomMessages {
             + "?filter=$filterId" `
             + "&full_state=true&set_presence=offline")
 
+        Write-Debug "URL: $url"
+
         $res = Invoke-RestMethod -Uri $url -Headers $headers
     } catch {
         Write-Error $_

public/Remove-MatrixRoomMessage.ps1

@@ -0,0 +1,64 @@
+<#
+    .Synopsis
+    Redact a Matrix message in a given Room ID.
+
+    .Description
+    Redact a Matrix message in a given Room ID from _matrix/client/v3/rooms/{roomId}/redact/{eventId}/{txnId}. See https://spec.matrix.org/v1.2/client-server-api/#put_matrixclientv3roomsroomidredacteventidtxnid.
+
+    .Parameter ServerUrl
+    URL for the Matrix server to log into, for example "https://matrix.example.com".
+
+    .Parameter AccessToken
+    A SecureString containing the Matrix access token.
+
+    .Parameter RoomId
+    The Matrix room ID to redact the message from.
+
+    .Parameter Message
+    The MatrixMessage object that contains the Event ID to redact.
+
+    .Parameter Reason
+    The reason to provide for the redaction (optional).
+
+    .Example
+    Remove-MatrixRoomMessage -ServerUrl $server -AccessToken $token -RoomId "!ehXvUhWNASUkSLvAGP:matrix.org" -Message $message -Reason "Redacted by PSMatrix"
+#>
+function Remove-MatrixRoomMessage {
+    param (
+        [Parameter(Mandatory)]
+        [string]
+        $ServerUrl,
+
+        [Parameter(Mandatory)]
+        [SecureString]
+        $AccessToken,
+
+        [Parameter(Mandatory)]
+        [string]
+        $RoomId,
+
+        [Parameter(Mandatory)]
+        [MatrixMessage]
+        $Message,
+
+        [Parameter(Mandatory=$false)]
+        [string]
+        $Reason
+    )
+
+    $eventId = $Message.EventID
+    $txnId = New-Guid
+    $url = New-MatrixUrl -ServerUrl $ServerUrl -ApiPath "_matrix/client/v3/rooms/$RoomId/redact/$eventId/$txnId"
+    Write-Debug "URL: $url"
+    $method = "Put"
+    $headers = Get-MatrixAuthHeaders -AccessToken $AccessToken
+    $body = @{
+        reason = $Reason
+    } | ConvertTo-Json
+
+    try {
+        return Invoke-RestMethod -Uri $url -Method $method -Headers $headers -Body $body
+    } catch {
+        Write-Error $_
+    }
+}