< Back
Add-HipchatUserToRoom
Post
NAME Add-HipchatUserToRoom
SYNOPSIS
Adds a HipChat user to a HipChat room.
SYNTAX
Add-HipchatUserToRoom [-MentionName] <String> [-RoomName] <String> [-ApiToken] <String> [<CommonParameters>]
DESCRIPTION
Adds an existing HipChat user to an existing HipChat room.
PARAMETERS
-MentionName <String>
Required: The user's mention name (@name).
Required? true
Position? 1
Default value
Accept pipeline input? true (ByValue)
Accept wildcard characters? false
-RoomName <String>
Required: The name of the room.
Required? true
Position? 2
Default value
Accept pipeline input? true (ByValue)
Accept wildcard characters? false
-ApiToken <String>
Required: Your HipChat API Token. You can obtain an API Token from the
HipChat website by navigating to Account Settings > API Access.
Required? true
Position? 3
Default value
Accept pipeline input? true (ByValue)
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
NOTES
Version: 1.0
Author: Corey Fonseca
Creation Date: 3/19/17
Purpose/Change: Full Functionality
-------------------------- EXAMPLE 1 --------------------------
PS C:\\>Add-HipchatUserToRoom -MentionName 'JohnSmith' -RoomName 'Development' -ApiToken
'REXsCauSe553gsoIJg1Gj4zwNsSAwS'
Adds @JohnSmith to the Development room.
RELATED LINKS
SYNOPSIS
Adds a HipChat user to a HipChat room.
SYNTAX
Add-HipchatUserToRoom [-MentionName] <String> [-RoomName] <String> [-ApiToken] <String> [<CommonParameters>]
DESCRIPTION
Adds an existing HipChat user to an existing HipChat room.
PARAMETERS
-MentionName <String>
Required: The user's mention name (@name).
Required? true
Position? 1
Default value
Accept pipeline input? true (ByValue)
Accept wildcard characters? false
-RoomName <String>
Required: The name of the room.
Required? true
Position? 2
Default value
Accept pipeline input? true (ByValue)
Accept wildcard characters? false
-ApiToken <String>
Required: Your HipChat API Token. You can obtain an API Token from the
HipChat website by navigating to Account Settings > API Access.
Required? true
Position? 3
Default value
Accept pipeline input? true (ByValue)
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
NOTES
Version: 1.0
Author: Corey Fonseca
Creation Date: 3/19/17
Purpose/Change: Full Functionality
-------------------------- EXAMPLE 1 --------------------------
PS C:\\>Add-HipchatUserToRoom -MentionName 'JohnSmith' -RoomName 'Development' -ApiToken
'REXsCauSe553gsoIJg1Gj4zwNsSAwS'
Adds @JohnSmith to the Development room.
RELATED LINKS