diff --git a/public/Get-MatrixJoinedMembers.ps1 b/public/Get-MatrixJoinedMembers.ps1 index af8c3ff..8484bac 100644 --- a/public/Get-MatrixJoinedMembers.ps1 +++ b/public/Get-MatrixJoinedMembers.ps1 @@ -1,3 +1,22 @@ +<# + .Synopsis + Get all joined members for a given Room ID. + + .Description + Get all joined members for a given Room ID from _matrix/client/v3/rooms/{roomId}/joined_members. See https://spec.matrix.org/v1.2/client-server-api/#get_matrixclientv3roomsroomidjoined_members. + + .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 retrieve joined members for. + + .Example + Get-MatrixJoinedMembers -ServerUrl $server -AccessToken $token -RoomId "!ehXvUhWNASUkSLvAGP:matrix.org" +#> function Get-MatrixJoinedMembers { param( [Parameter(Mandatory)]