mirror of
https://github.com/Thumbscrew/PSMatrix.git
synced 2025-04-12 02:03:39 +00:00
add Get-Help section
This commit is contained in:
parent
5cc813f849
commit
e4940a7b45
@ -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 {
|
function Get-MatrixJoinedMembers {
|
||||||
param(
|
param(
|
||||||
[Parameter(Mandatory)]
|
[Parameter(Mandatory)]
|
||||||
|
Loading…
Reference in New Issue
Block a user