< Back
Get-HipChatRooms
Post
NAME Get-HipChatRooms
SYNOPSIS
Returns an array of HipChat rooms that the auth token has access to.
SYNTAX
Get-HipChatRooms [-AuthToken] <String> [[-MaxResults] <String>] [[-IncludePrivate] <String>] [[-IncludeArchived]
<String>] [[-ApiHost] <String>] [[-TimeoutSecs] <String>] [<CommonParameters>]
DESCRIPTION
Returns an array of HipChat rooms that the auth token has access to.
PARAMETERS
-AuthToken <String>
Required. Your HipChat API token, that you can create here https://www.hipchat.com/account/api
Required? true
Position? 1
Default value
Accept pipeline input? false
Accept wildcard characters? false
-MaxResults <String>
The maximum results that you want to see. Defaults to 100, limited to 1000 by the Hipchat API.
Required? false
Position? 2
Default value 100
Accept pipeline input? false
Accept wildcard characters? false
-IncludePrivate <String>
Whether to include private rooms in the results. Defaults to true.
Required? false
Position? 3
Default value true
Accept pipeline input? false
Accept wildcard characters? false
-IncludeArchived <String>
Whether to include archived rooms in the results. Defaults to false.
Required? false
Position? 4
Default value false
Accept pipeline input? false
Accept wildcard characters? false
-ApiHost <String>
The URI of the HipChat api (default: api.hipchat.com)
Required? false
Position? 5
Default value api.hipchat.com
Accept pipeline input? false
Accept wildcard characters? false
-TimeoutSecs <String>
Timeout of the HTTP call to the HipChat API. Defaults to 10 seconds.
Required? false
Position? 6
Default value 10
Accept pipeline input? false
Accept wildcard characters? false
<CommonParameters>
This cmdlet supports the common parameters: Verbose, Debug,
ErrorAction, ErrorVariable, WarningAction, WarningVariable,
OutBuffer, PipelineVariable, and OutVariable. For more information, see
about_CommonParameters (https:/go.microsoft.com/fwlink/?LinkID=113216).
INPUTS
OUTPUTS
-------------------------- EXAMPLE 1 --------------------------
PS C:\\>Get-HipChatRooms -AuthToken 1234abcd5678efgh -MaxResults 1000
RELATED LINKS
https://github.com/DaveStephens/PSHipchat
SYNOPSIS
Returns an array of HipChat rooms that the auth token has access to.
SYNTAX
Get-HipChatRooms [-AuthToken] <String> [[-MaxResults] <String>] [[-IncludePrivate] <String>] [[-IncludeArchived]
<String>] [[-ApiHost] <String>] [[-TimeoutSecs] <String>] [<CommonParameters>]
DESCRIPTION
Returns an array of HipChat rooms that the auth token has access to.
PARAMETERS
-AuthToken <String>
Required. Your HipChat API token, that you can create here https://www.hipchat.com/account/api
Required? true
Position? 1
Default value
Accept pipeline input? false
Accept wildcard characters? false
-MaxResults <String>
The maximum results that you want to see. Defaults to 100, limited to 1000 by the Hipchat API.
Required? false
Position? 2
Default value 100
Accept pipeline input? false
Accept wildcard characters? false
-IncludePrivate <String>
Whether to include private rooms in the results. Defaults to true.
Required? false
Position? 3
Default value true
Accept pipeline input? false
Accept wildcard characters? false
-IncludeArchived <String>
Whether to include archived rooms in the results. Defaults to false.
Required? false
Position? 4
Default value false
Accept pipeline input? false
Accept wildcard characters? false
-ApiHost <String>
The URI of the HipChat api (default: api.hipchat.com)
Required? false
Position? 5
Default value api.hipchat.com
Accept pipeline input? false
Accept wildcard characters? false
-TimeoutSecs <String>
Timeout of the HTTP call to the HipChat API. Defaults to 10 seconds.
Required? false
Position? 6
Default value 10
Accept pipeline input? false
Accept wildcard characters? false
<CommonParameters>
This cmdlet supports the common parameters: Verbose, Debug,
ErrorAction, ErrorVariable, WarningAction, WarningVariable,
OutBuffer, PipelineVariable, and OutVariable. For more information, see
about_CommonParameters (https:/go.microsoft.com/fwlink/?LinkID=113216).
INPUTS
OUTPUTS
-------------------------- EXAMPLE 1 --------------------------
PS C:\\>Get-HipChatRooms -AuthToken 1234abcd5678efgh -MaxResults 1000
RELATED LINKS
https://github.com/DaveStephens/PSHipchat