thumbscrw/PSMatrix
1
0
Fork 0
mirror of https://github.com/Thumbscrew/PSMatrix.git synced 2025-04-04 14:23:39 +00:00
Code Issues Packages Projects Releases Wiki Activity

add Get-Help block

Browse Source
This commit is contained in:
James 2022-04-05 17:13:11 +01:00
parent 9c7d12107b
commit 7f7f170c28
1 changed files with 25 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

25
public/Remove-MatrixRoomMessage.ps1
View File

@ -1,3 +1,28 @@
<#
.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)]