Remove-HipchatUserFromRoom

NAME Remove-HipchatUserFromRoom



SYNOPSIS

Removes a HipChat user from a HipChat room.





SYNTAX

Remove-HipchatUserFromRoom [-MentionName] <String> [-RoomName] <String> [-ApiToken] <String> [<CommonParameters>]





DESCRIPTION

Removes an existing HipChat user from 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: 5/4/17

Purpose/Change: Full Functionality



-------------------------- EXAMPLE 1 --------------------------



PS C:\\>Remove-HipchatUserFromRoom -MentionName 'JohnSmith' -RoomName 'Development' -ApiToken

'REXsCauSe553gsoIJg1Gj4zwNsSAwS'



Removes @JohnSmith from the Development room.











RELATED LINKS