Kelverion.Slack.dll-Help.xml
|
<?xml version="1.0" encoding="utf-8"?>
<helpItems xmlns="http://msh" schema="maml"> <!--Edited with: SAPIEN PowerShell HelpWriter 2018 v2.2.38--> <!--Generated by: SAPIEN PowerShell HelpWriter 2018 v2.2.38--> <!-- Module: Kelverion.Slack Version: 1.0 --> <!--All Commands--> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <!--TAG: HASCOMMONPARAMETERS--> <!--Command--> <command:details> <command:name>Close-SlackDirectMessage</command:name> <maml:description> <maml:para>Closes a direct message or multi-person direct message.</maml:para> </maml:description> <maml:copyright> <maml:para></maml:para> </maml:copyright> <command:verb>Close</command:verb> <command:noun>SlackDirectMessage</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>The Close-SlackDirectMessage cmdlet closes a direct message or multi-person direct message.</maml:para> </maml:description> <command:syntax> <!--Parameter Sets--> <command:syntaxItem parametersetname="Default" default="true"> <!--NAME: Default--> <!--TAG: DEFAULT--> <maml:name>Close-SlackDirectMessage</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="0"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Specifies a hashtable that contains information used to license the module and to connect to Slack. Connection information is typically retrieved from Azure Automation using the Get-AutomationConnection cmdlet or in graphical runbooks, with a connection asset data source.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Hashtable</command:parameterValue> <dev:type> <maml:name>Hashtable</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>ChannelId</maml:name> <maml:description> <maml:para>Specifies the ID of the channel to close.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!--All Parameters--> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="False" position="named"> <maml:name>ChannelId</maml:name> <maml:description> <maml:para>Specifies the ID of the channel to close.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="False" position="0"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Specifies a hashtable that contains information used to license the module and to connect to Slack. Connection information is typically retrieved from Azure Automation using the Get-AutomationConnection cmdlet or in graphical runbooks, with a connection asset data source.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Hashtable</command:parameterValue> <dev:type> <maml:name>Hashtable</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <!--Inputs--> <command:inputType> <dev:type> <maml:name>None</maml:name> <maml:uri></maml:uri> </dev:type> <maml:description> <maml:para>You cannot pipe objects to Close-SlackDirectMessage.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <!--Outputs--> <command:returnValue> <dev:type> <maml:name>System.Boolean</maml:name> <maml:uri></maml:uri> </dev:type> <maml:description> <maml:para>This cmdlet outputs true if the channel was closed and false to indicate that the conversaion was already closed.</maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <!--Notes--> <maml:title>Required Scopes</maml:title> <maml:alert> <maml:para>This cmdlet requires Bot User tokens to have the channels:manage, groups:write, im:write and mpim:write scopes. User tokens must have the channels:write, groups:write, im:write and mpim:write scopes.</maml:para> </maml:alert> </maml:alertSet> <command:examples> <!--Examples--> <command:example> <maml:title>Example 1: Close a slack direct message.</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>C:\PS> $connection = Get-AutomationConnection -Name 'Slack' C:\PS> Close-SlackDirectMessage -Connection $connection -ChannelId 'G1234567890'</dev:code> <dev:remarks> <maml:para /> </dev:remarks> </command:example> </command:examples> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <!--TAG: HASCOMMONPARAMETERS--> <!--Command--> <command:details> <command:name>Get-SlackChannel</command:name> <maml:description> <maml:para>Lists the channels that are in a slack team or retrieves information about a specific channel.</maml:para> </maml:description> <maml:copyright> <maml:para></maml:para> </maml:copyright> <command:verb>Get</command:verb> <command:noun>SlackChannel</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>The Get-SlackChannel cmdlet lists the channels that are in a slack team or retrieves information about a specific channel.</maml:para> </maml:description> <command:syntax> <!--Parameter Sets--> <command:syntaxItem parametersetname="Info"> <!--NAME: Info--> <maml:name>Get-SlackChannel</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="0"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Specifies a hashtable that contains information used to license the module and to connect to Slack. Connection information is typically retrieved from Azure Automation using the Get-AutomationConnection cmdlet or in graphical runbooks, with a connection asset data source.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Hashtable</command:parameterValue> <dev:type> <maml:name>Hashtable</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByValue)" position="named"> <maml:name>ChannelId</maml:name> <maml:description> <maml:para>Specifies the ID of the channel to retrieve information for.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> </command:syntaxItem> <command:syntaxItem parametersetname="Default"> <!--NAME: Default--> <maml:name>Get-SlackChannel</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="0"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Specifies a hashtable that contains information used to license the module and to connect to Slack. Connection information is typically retrieved from Azure Automation using the Get-AutomationConnection cmdlet or in graphical runbooks, with a connection asset data source.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Hashtable</command:parameterValue> <dev:type> <maml:name>Hashtable</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>ExcludeArchived</maml:name> <maml:description> <maml:para>Indicates whether to exclude archived channels.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Limit</maml:name> <maml:description> <maml:para>Specifies that maximum number of channels to retrieve. By default, the cmdlet will retrieve up to 100 channels.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Int32</command:parameterValue> <dev:type> <maml:name>Int32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>100</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>TeamId</maml:name> <maml:description> <maml:para>Specifies the encoded team ID to list channels in. Required if the OAuth Token belongs to an org-wide app.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>MessageTypes</maml:name> <maml:description> <maml:para>Specifies the types of channels to retrieve. Allowed values include public_channel, private_channel, mpim and im.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">public_channel</command:parameterValue> <command:parameterValue required="false" variableLength="false">private_channel</command:parameterValue> <command:parameterValue required="false" variableLength="false">mpim</command:parameterValue> <command:parameterValue required="false" variableLength="false">im</command:parameterValue> </command:parameterValueGroup> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>public_channel</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!--All Parameters--> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByValue)" position="named"> <maml:name>ChannelId</maml:name> <maml:description> <maml:para>Specifies the ID of the channel to retrieve information for.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="False" position="0"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Specifies a hashtable that contains information used to license the module and to connect to Slack. Connection information is typically retrieved from Azure Automation using the Get-AutomationConnection cmdlet or in graphical runbooks, with a connection asset data source.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Hashtable</command:parameterValue> <dev:type> <maml:name>Hashtable</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="False" position="named"> <maml:name>ExcludeArchived</maml:name> <maml:description> <maml:para>Indicates whether to exclude archived channels.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="False" position="named"> <maml:name>Limit</maml:name> <maml:description> <maml:para>Specifies that maximum number of channels to retrieve. By default, the cmdlet will retrieve up to 100 channels.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Int32</command:parameterValue> <dev:type> <maml:name>Int32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>100</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="False" position="named"> <maml:name>TeamId</maml:name> <maml:description> <maml:para>Specifies the encoded team ID to list channels in. Required if the OAuth Token belongs to an org-wide app.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="False" position="named"> <maml:name>MessageTypes</maml:name> <maml:description> <maml:para>Specifies the types of channels to retrieve. Allowed values include public_channel, private_channel, mpim and im.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">public_channel</command:parameterValue> <command:parameterValue required="false" variableLength="false">private_channel</command:parameterValue> <command:parameterValue required="false" variableLength="false">mpim</command:parameterValue> <command:parameterValue required="false" variableLength="false">im</command:parameterValue> </command:parameterValueGroup> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>public_channel</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <!--Inputs--> <command:inputType> <dev:type> <maml:name>String</maml:name> <maml:uri></maml:uri> </dev:type> <maml:description> <maml:para>You can pipe strings, representing channel IDs, to the Get-SlackChannel cmdlet.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <!--Outputs--> <command:returnValue> <dev:type> <maml:name>Kelverion.Slack.Models.Channel</maml:name> <maml:uri></maml:uri> </dev:type> <maml:description> <maml:para>This cmdlet generates Kelverion.Slack.Models.Channel object that represents the channels the were retreived from Slack.</maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <!--Notes--> <maml:title>Required Scopes</maml:title> <maml:alert> <maml:para>This cmdlet requires Bot User and User tokens to have the channels:read, groups:read, im:read, mpim:read scopes.</maml:para> </maml:alert> </maml:alertSet> <command:examples> <!--Examples--> <command:example> <maml:title>Example 1: Retrieve the channels for a team, excluding archived channels</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>C:\PS> $connection = Get-AutomationConnection -Name 'Slack' C:\PS> Get-SlackChannel -Connection $connection -TeamId 'T1234567890' -ExcludeArchived</dev:code> <dev:remarks> <maml:para /> </dev:remarks> </command:example> <command:example xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10"> <maml:title xmlns:maml="http://schemas.microsoft.com/maml/2004/10">Example 1: Retrieve the direct message and multi-person direct message channels for a team.</maml:title> <maml:introduction xmlns:maml="http://schemas.microsoft.com/maml/2004/10"> <maml:para /> </maml:introduction> <dev:code xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10">C:\PS> $connection = Get-AutomationConnection -Name 'Slack' C:\PS> Get-SlackChannel -Connection $connection -TeamId 'T1234567890' -MessageTypes 'im', 'mpim'</dev:code> <dev:remarks xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <maml:para /> </dev:remarks> </command:example> </command:examples> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <!--TAG: HASCOMMONPARAMETERS--> <!--Command--> <command:details> <command:name>Get-SlackChannelHistory</command:name> <maml:description> <maml:para>Retrieves message and event history from a channel.</maml:para> </maml:description> <maml:copyright> <maml:para></maml:para> </maml:copyright> <command:verb>Get</command:verb> <command:noun>SlackChannelHistory</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>The Get-SlackChannelHistory cmdlet retrieves the message and event history from a channel.</maml:para> </maml:description> <command:syntax> <!--Parameter Sets--> <command:syntaxItem parametersetname="Default" default="true"> <!--NAME: Default--> <!--TAG: DEFAULT--> <maml:name>Get-SlackChannelHistory</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="0"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Specifies a hashtable that contains information used to license the module and to connect to Slack. Connection information is typically retrieved from Azure Automation using the Get-AutomationConnection cmdlet or in graphical runbooks, with a connection asset data source.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Hashtable</command:parameterValue> <dev:type> <maml:name>Hashtable</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>After</maml:name> <maml:description> <maml:para>Specifies the date and time after which to retrieve messages.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Nullable[DateTimeOffset]</command:parameterValue> <dev:type> <maml:name>Nullable[DateTimeOffset]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Before</maml:name> <maml:description> <maml:para>Specifies the date and time before which to retrieve messages.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Nullable[DateTimeOffset]</command:parameterValue> <dev:type> <maml:name>Nullable[DateTimeOffset]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>ChannelId</maml:name> <maml:description> <maml:para>Specifies the ID of the channel retrieve the history for.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Limit</maml:name> <maml:description> <maml:para>Specifies the maximum number of messages to retrieve.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Int32</command:parameterValue> <dev:type> <maml:name>Int32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>100</dev:defaultValue> </command:parameter> </command:syntaxItem> <command:syntaxItem parametersetname="Timestamp"> <!--NAME: Timestamp--> <maml:name>Get-SlackChannelHistory</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="False" position="0"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Specifies a hashtable that contains information used to license the module and to connect to Slack. Connection information is typically retrieved from Azure Automation using the Get-AutomationConnection cmdlet or in graphical runbooks, with a connection asset data source.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Hashtable</command:parameterValue> <dev:type> <maml:name>Hashtable</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="False" position="named"> <maml:name>ChannelId</maml:name> <maml:description> <maml:para>Specifies the ID of the channel retrieve the history for.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="False" position="named"> <maml:name>Inclusive</maml:name> <maml:description> <maml:para>Indicates whether to include messages that occur at the beginning or end of the specified date and time range.</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="False" position="named"> <maml:name>Limit</maml:name> <maml:description> <maml:para>Specifies the maximum number of messages to retrieve.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Int32</command:parameterValue> <dev:type> <maml:name>Int32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>100</dev:defaultValue> </command:parameter> <command:parameter required="false" globbing="false" pipelineInput="False" variableLength="false" position="named"> <maml:name>Oldest</maml:name> <maml:description> <maml:para>Specifies the timestamp that marks the lower limit of the of the time range from which to retrieve message history.</maml:para> </maml:description> <dev:type> <maml:name /> <maml:uri /> </dev:type> <dev:defaultValue /> </command:parameter> <command:parameter required="false" globbing="false" pipelineInput="False" variableLength="false" position="named"> <maml:name>Latest</maml:name> <maml:description> <maml:para>Specifies the timestamp that marks the upper limit of the of the time range from which to retrieve message history.</maml:para> </maml:description> <dev:type> <maml:name /> <maml:uri /> </dev:type> <dev:defaultValue /> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!--All Parameters--> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="False" position="named"> <maml:name>After</maml:name> <maml:description> <maml:para>Specifies the date and time after which to retrieve messages.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Nullable[DateTimeOffset]</command:parameterValue> <dev:type> <maml:name>Nullable[DateTimeOffset]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="False" position="named"> <maml:name>Before</maml:name> <maml:description> <maml:para>Specifies the date and time before which to retrieve messages.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Nullable[DateTimeOffset]</command:parameterValue> <dev:type> <maml:name>Nullable[DateTimeOffset]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="False" position="named"> <maml:name>ChannelId</maml:name> <maml:description> <maml:para>Specifies the ID of the channel retrieve the history for.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="False" position="named"> <maml:name>Inclusive</maml:name> <maml:description> <maml:para>Indicates whether to include messages that occur at the beginning or end of the specified date and time range.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="False" position="named"> <maml:name>Limit</maml:name> <maml:description> <maml:para>Specifies the maximum number of messages to retrieve.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Int32</command:parameterValue> <dev:type> <maml:name>Int32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>100</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="False" position="0"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Specifies a hashtable that contains information used to license the module and to connect to Slack. Connection information is typically retrieved from Azure Automation using the Get-AutomationConnection cmdlet or in graphical runbooks, with a connection asset data source.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Hashtable</command:parameterValue> <dev:type> <maml:name>Hashtable</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" globbing="false" pipelineInput="False" variableLength="false" position="named"> <maml:name>Oldest</maml:name> <maml:description> <maml:para>Specifies the timestamp that marks the lower limit of the of the time range from which to retrieve message history.</maml:para> </maml:description> <dev:type> <maml:name /> <maml:uri /> </dev:type> <dev:defaultValue /> </command:parameter> <command:parameter required="false" globbing="false" pipelineInput="False" variableLength="false" position="named"> <maml:name>Latest</maml:name> <maml:description> <maml:para>Specifies the timestamp that marks the upper limit of the of the time range from which to retrieve message history.</maml:para> </maml:description> <dev:type> <maml:name /> <maml:uri /> </dev:type> <dev:defaultValue /> </command:parameter> </command:parameters> <command:inputTypes> <!--Inputs--> <command:inputType> <dev:type> <maml:name>None</maml:name> <maml:uri></maml:uri> </dev:type> <maml:description> <maml:para>You cannot pipe objects to the Get-SlackHistory cmdlet.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <!--Outputs--> <command:returnValue> <dev:type> <maml:name>Kelverion.Slack.Models.Message</maml:name> <maml:uri></maml:uri> </dev:type> <maml:description> <maml:para>This cmdlet generates Kelverion.Slack.Models.Message objects that represent the Slack messages that were retrieved.</maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <!--Notes--> <maml:title>Required Scopes</maml:title> <maml:alert> <maml:para>This cmdlet requires Bot User and User tokens to have the channels:history, groups:history, im:history and mpim:history scopes.</maml:para> </maml:alert> </maml:alertSet> <command:examples> <!--Examples--> <command:example> <maml:title>Example: Retrieve messages from a channel for the current day</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>C:\PS> $connection = Get-AutomationConnection -Name 'Slack' C:\PS> $midnight = Get-Date -Hour 0 -Minute 0 -Second C:\PS> Get-SlackChannelHistory -Connection $connection -ChannelId 'C1234567890' -After $midnight</dev:code> <dev:remarks> <maml:para /> </dev:remarks> </command:example> </command:examples> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <!--TAG: HASCOMMONPARAMETERS--> <!--Command--> <command:details> <command:name>Get-SlackMessageThread</command:name> <maml:description> <maml:para>Retrieves a thread of messages that have been posted to a channel.</maml:para> </maml:description> <maml:copyright> <maml:para></maml:para> </maml:copyright> <command:verb>Get</command:verb> <command:noun>SlackMessageThread</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>The Get-SlackMessageThread cmdlet retrieves a thread of messages that have been posted to a channel.</maml:para> </maml:description> <command:syntax> <!--Parameter Sets--> <command:syntaxItem parametersetname="Default" default="true"> <!--NAME: Default--> <!--TAG: DEFAULT--> <maml:name>Get-SlackMessageThread</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="0"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Specifies a hashtable that contains information used to license the module and to connect to Slack. Connection information is typically retrieved from Azure Automation using the Get-AutomationConnection cmdlet or in graphical runbooks, with a connection asset data source.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Hashtable</command:parameterValue> <dev:type> <maml:name>Hashtable</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>ChannelId</maml:name> <maml:description> <maml:para>Specifies the ID of the channel retrieve the history for.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Thread</maml:name> <maml:description> <maml:para>Specifies the unique identifier of the thread's parent message. The ID must be the timestamp of an existing message with one or more replies. If there are no replies, then just the single message referenced by the timestamp will be retrieved.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!--All Parameters--> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="False" position="named"> <maml:name>ChannelId</maml:name> <maml:description> <maml:para>Specifies the ID of the channel retrieve the history for.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="False" position="named"> <maml:name>Thread</maml:name> <maml:description> <maml:para>Specifies the unique identifier of the thread's parent message. The ID must be the timestamp of an existing message with one or more replies. If there are no replies, then just the single message referenced by the timestamp will be retrieved.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="False" position="0"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Specifies a hashtable that contains information used to license the module and to connect to Slack. Connection information is typically retrieved from Azure Automation using the Get-AutomationConnection cmdlet or in graphical runbooks, with a connection asset data source.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Hashtable</command:parameterValue> <dev:type> <maml:name>Hashtable</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <!--Inputs--> <command:inputType> <dev:type> <maml:name>None</maml:name> <maml:uri></maml:uri> </dev:type> <maml:description> <maml:para>You cannot pipe objects the Get-SlackReplies cmdlet.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <!--Outputs--> <command:returnValue> <dev:type> <maml:name>Kelverion.Slack.Models.Message</maml:name> <maml:uri></maml:uri> </dev:type> <maml:description> <maml:para>This cmdlet generates Kelverion.Slack.Models.Message objects that represent the Slack messages that were retrieved.</maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <!--Notes--> <maml:title>Required Scopes</maml:title> <maml:alert> <maml:para>This cmdlet requires Bot User and User tokens to have the channels:history, groups:history, im:history and mpim:history scopes.</maml:para> </maml:alert> </maml:alertSet> <command:examples> <!--Examples--> <command:example> <maml:title>Example 1: Retrieve the replies to a message.</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>C:\PS> $connection = Get-AutomationConnection -Name 'Slack' C:\PS> Get-SlackMessageThread -Connection $connection -ChannelId 'C1234567890' -Thread '1234567890.123456'</dev:code> <dev:remarks> <maml:para /> </dev:remarks> </command:example> </command:examples> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <!--TAG: HASCOMMONPARAMETERS--> <!--Command--> <command:details> <command:name>Get-SlackMessage</command:name> <maml:description> <maml:para>Gets a message from a channel.</maml:para> </maml:description> <maml:copyright> <maml:para></maml:para> </maml:copyright> <command:verb>Get</command:verb> <command:noun>SlackMessage</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>The Get-SlackMessage cmdlet retreives details about a specified message.</maml:para> </maml:description> <command:syntax> <!--Parameter Sets--> <command:syntaxItem parametersetname="Default" default="true"> <!--NAME: Default--> <!--TAG: DEFAULT--> <maml:name>Get-SlackMessage</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="0"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Specifies a hashtable that contains information used to license the module and to connect to Slack. Connection information is typically retrieved from Azure Automation using the Get-AutomationConnection cmdlet or in graphical runbooks, with a connection asset data source.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Hashtable</command:parameterValue> <dev:type> <maml:name>Hashtable</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>ChannelId</maml:name> <maml:description> <maml:para>Specifies the ID of the channel that the message is in.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByValue)" position="named"> <maml:name>Timestamp</maml:name> <maml:description> <maml:para>Specifies the timestamps of the message(s) to retrieve.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!--All Parameters--> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="False" position="named"> <maml:name>ChannelId</maml:name> <maml:description> <maml:para>Specifies the ID of the channel that the message is in.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByValue)" position="named"> <maml:name>Timestamp</maml:name> <maml:description> <maml:para>Specifies the timestamps of the message(s) to retrieve.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="False" position="0"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Specifies a hashtable that contains information used to license the module and to connect to Slack. Connection information is typically retrieved from Azure Automation using the Get-AutomationConnection cmdlet or in graphical runbooks, with a connection asset data source.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Hashtable</command:parameterValue> <dev:type> <maml:name>Hashtable</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <!--Inputs--> <command:inputType> <dev:type> <maml:name>String</maml:name> <maml:uri></maml:uri> </dev:type> <maml:description> <maml:para>You can pipe strings, representing message timestamps, to the Get-SlackMessage cmdlet.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <!--Outputs--> <command:returnValue> <dev:type> <maml:name>Kelverion.Slack.Models.Message</maml:name> <maml:uri></maml:uri> </dev:type> <maml:description> <maml:para>This cmdlet generates Kelverion.Slack.Models.Message objects that represent the Slack messages that were retrieved.</maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <!--Notes--> <maml:title>Required Scopes</maml:title> <maml:alert> <maml:para>This cmdlet requires Bot User and User tokens to have the channels:history, groups:history, im:history and mpim:history scopes.</maml:para> </maml:alert> </maml:alertSet> <command:examples> <!--Examples--> <command:example> <maml:title>Example: Retrieve a specific message.</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>C:\PS> $connection = Get-AutomationConnection -Name 'Slack' C:\PS> Get-SlackMessage -Connection $connection -ChannelId 'C1234567890' -Timestamp '1234567890.123456'</dev:code> <dev:remarks> <maml:para /> </dev:remarks> </command:example> </command:examples> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <!--TAG: HASCOMMONPARAMETERS--> <!--Command--> <command:details> <command:name>Get-SlackTeam</command:name> <maml:description> <maml:para>Retrieves information about the current team.</maml:para> </maml:description> <maml:copyright> <maml:para></maml:para> </maml:copyright> <command:verb>Get</command:verb> <command:noun>SlackTeam</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>The Get-SlackTeam cmdlet retrieves information about the current team. The cmdlet will only retrieve information about teams that the authenticated token is allowed to see through external shared channels.</maml:para> </maml:description> <command:syntax> <!--Parameter Sets--> <command:syntaxItem parametersetname="Default"> <!--NAME: Default--> <maml:name>Get-SlackTeam</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="0"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Specifies a hashtable that contains information used to license the module and to connect to Slack. Connection information is typically retrieved from Azure Automation using the Get-AutomationConnection cmdlet or in graphical runbooks, with a connection asset data source.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Hashtable</command:parameterValue> <dev:type> <maml:name>Hashtable</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByValue)" position="named"> <maml:name>TeamId</maml:name> <maml:description> <maml:para>Specifies the ID of the team to retrieve information for. If omitted, the cmdlet will return information about the current team.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!--All Parameters--> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByValue)" position="named"> <maml:name>TeamId</maml:name> <maml:description> <maml:para>Specifies the ID of the team to retrieve information for. If omitted, the cmdlet will return information about the current team.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="False" position="0"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Specifies a hashtable that contains information used to license the module and to connect to Slack. Connection information is typically retrieved from Azure Automation using the Get-AutomationConnection cmdlet or in graphical runbooks, with a connection asset data source.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Hashtable</command:parameterValue> <dev:type> <maml:name>Hashtable</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <!--Inputs--> <command:inputType> <dev:type> <maml:name>String</maml:name> <maml:uri></maml:uri> </dev:type> <maml:description> <maml:para>You can pipe strings, that represent the IDs of teams, to this cmdlet.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <!--Outputs--> <command:returnValue> <dev:type> <maml:name>Kelverion.Slack.Models.Team</maml:name> <maml:uri></maml:uri> </dev:type> <maml:description> <maml:para>This cmdlet generates Kelverion.Slack.Models.Team that represent the teams that were retrieved.</maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <!--Notes--> <maml:title>Required Scopes</maml:title> <maml:alert> <maml:para>This cmdlet requires Both and User tokens to have the team:read scope.</maml:para> </maml:alert> </maml:alertSet> <command:examples> <!--Examples--> <command:example> <maml:title>Example: Get information for the current team.</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>C:\PS> $connection = Get-AutomationConnection -Name 'Slack' C:\PS> Get-SlackTeam -Connection $connection</dev:code> <dev:remarks> <maml:para /> </dev:remarks> </command:example> </command:examples> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <!--TAG: HASCOMMONPARAMETERS--> <!--Command--> <command:details> <command:name>Get-SlackUser</command:name> <maml:description> <maml:para>Retrieves information about the users in a team, or more detailed information about a specific user.</maml:para> </maml:description> <maml:copyright> <maml:para></maml:para> </maml:copyright> <command:verb>Get</command:verb> <command:noun>SlackUser</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>The Get-SlackUser cmdlet retrieves information about the users in a team, or more detailed information about a specific user.</maml:para> </maml:description> <command:syntax> <!--Parameter Sets--> <command:syntaxItem parametersetname="Default" default="true"> <!--NAME: Default--> <!--TAG: DEFAULT--> <maml:name>Get-SlackUser</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="0"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Specifies a hashtable that contains information used to license the module and to connect to Slack. Connection information is typically retrieved from Azure Automation using the Get-AutomationConnection cmdlet or in graphical runbooks, with a connection asset data source.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Hashtable</command:parameterValue> <dev:type> <maml:name>Hashtable</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Limit</maml:name> <maml:description> <maml:para>The maximum number of items to retrieve.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Int32</command:parameterValue> <dev:type> <maml:name>Int32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>100</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>TeamId</maml:name> <maml:description> <maml:para>Specifies the ID of the team to retrieve users for. Required if the OAuth Token belongs to an org-wide app.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> </command:syntaxItem> <command:syntaxItem parametersetname="Info"> <!--NAME: Info--> <maml:name>Get-SlackUser</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="0"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Specifies a hashtable that contains information used to license the module and to connect to Slack. Connection information is typically retrieved from Azure Automation using the Get-AutomationConnection cmdlet or in graphical runbooks, with a connection asset data source.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Hashtable</command:parameterValue> <dev:type> <maml:name>Hashtable</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByValue)" position="named"> <maml:name>UserId</maml:name> <maml:description> <maml:para>Specifies the ID of the user to retrieve information for.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!--All Parameters--> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="False" position="named"> <maml:name>Limit</maml:name> <maml:description> <maml:para>The maximum number of items to retrieve.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Int32</command:parameterValue> <dev:type> <maml:name>Int32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>100</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="False" position="named"> <maml:name>TeamId</maml:name> <maml:description> <maml:para>Specifies the ID of the team to retrieve users for. Required if the OAuth Token belongs to an org-wide app.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="False" position="0"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Specifies a hashtable that contains information used to license the module and to connect to Slack. Connection information is typically retrieved from Azure Automation using the Get-AutomationConnection cmdlet or in graphical runbooks, with a connection asset data source.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Hashtable</command:parameterValue> <dev:type> <maml:name>Hashtable</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByValue)" position="named"> <maml:name>UserId</maml:name> <maml:description> <maml:para>Specifies the ID of the user to retrieve information for.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <!--Inputs--> <command:inputType> <dev:type> <maml:name>System.String</maml:name> <maml:uri></maml:uri> </dev:type> <maml:description> <maml:para>You can pipe strings, containing user IDs, to the Get-SlackUser cmdlet.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <!--Outputs--> <command:returnValue> <dev:type> <maml:name>Kelverion.Slack.Models.User</maml:name> <maml:uri></maml:uri> </dev:type> <maml:description> <maml:para>This cmdlet generates Kelverion.Slack.Models.User that represent Slack users.</maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <!--Notes--> <maml:title>Required Scopes</maml:title> <maml:alert> <maml:para>This cmdlet requires that Bot User and User tokens have the users:read scope.</maml:para> </maml:alert> </maml:alertSet> <command:examples> <!--Examples--> <command:example> <maml:title>Example 1: Retrieve users for a team.</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>C:\PS> $connection = Get-AutomationConnection -Name 'Slack' C:\PS> Get-SlackUser -Connection $connection -TeamId 'T1234567890'</dev:code> <dev:remarks> <maml:para /> </dev:remarks> </command:example> </command:examples> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <!--TAG: HASCOMMONPARAMETERS--> <!--Command--> <command:details> <command:name>Get-SlackUserGroup</command:name> <maml:description> <maml:para>Retrieves information about the user groups in a Slack team.</maml:para> </maml:description> <maml:copyright> <maml:para></maml:para> </maml:copyright> <command:verb>Get</command:verb> <command:noun>SlackUserGroup</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>The Get-SlackUser cmdlet retrieves information about the user groups in a Slack team.</maml:para> </maml:description> <command:syntax> <!--Parameter Sets--> <command:syntaxItem parametersetname="Default" default="true"> <!--NAME: Default--> <!--TAG: DEFAULT--> <maml:name>Get-SlackUserGroup</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="0"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Specifies a hashtable that contains information used to license the module and to connect to Slack. Connection information is typically retrieved from Azure Automation using the Get-AutomationConnection cmdlet or in graphical runbooks, with a connection asset data source.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Hashtable</command:parameterValue> <dev:type> <maml:name>Hashtable</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>IncludeDisabled</maml:name> <maml:description> <maml:para>Indicates whether to retrieve disabled user groups.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Boolean</command:parameterValue> <dev:type> <maml:name>Boolean</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>TeamId</maml:name> <maml:description> <maml:para>Specifies the ID of the team from which to retrieve user groups for.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!--All Parameters--> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="False" position="named"> <maml:name>IncludeDisabled</maml:name> <maml:description> <maml:para>Indicates whether to retrieve disabled user groups.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Boolean</command:parameterValue> <dev:type> <maml:name>Boolean</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="False" position="named"> <maml:name>TeamId</maml:name> <maml:description> <maml:para>Specifies the ID of the team from which to retrieve user groups for.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="False" position="0"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Specifies a hashtable that contains information used to license the module and to connect to Slack. Connection information is typically retrieved from Azure Automation using the Get-AutomationConnection cmdlet or in graphical runbooks, with a connection asset data source.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Hashtable</command:parameterValue> <dev:type> <maml:name>Hashtable</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <!--Inputs--> <command:inputType> <dev:type> <maml:name>None</maml:name> <maml:uri></maml:uri> </dev:type> <maml:description> <maml:para>You cannot pipe objects to the Get-SlackUserGroup cmdlet.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <!--Outputs--> <command:returnValue> <dev:type> <maml:name>Kelverion.Slack.Models.UserGroup</maml:name> <maml:uri></maml:uri> </dev:type> <maml:description> <maml:para>This cmdlet generates Kelverion.Slack.Models.UserGroup object that represent the user groups that were retrieved.</maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <!--Notes--> <maml:title>Required Scopes</maml:title> <maml:alert> <maml:para>This cmdlet requires Bot User and User tokens to have the usergroups:read scope.</maml:para> </maml:alert> </maml:alertSet> <command:examples> <!--Examples--> <command:example> <maml:title>Example 1: Retrieve user groups for a team.</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>C:\PS> $connection = Get-AutomationConnection -Name 'Slack' C:\PS> Get-SlackUserGroup -Connection $connection -TeamId 'T1234567890'</dev:code> <dev:remarks> <maml:para /> </dev:remarks> </command:example> </command:examples> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <!--TAG: HASCOMMONPARAMETERS--> <!--Command--> <command:details> <command:name>New-SlackChannel</command:name> <maml:description> <maml:para>Initiate a new public or private channel-based conversation.</maml:para> </maml:description> <maml:copyright> <maml:para></maml:para> </maml:copyright> <command:verb>New</command:verb> <command:noun>SlackChannel</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>The New-SlackChannel initiates a new public or private channel-based conversation.</maml:para> </maml:description> <command:syntax> <!--Parameter Sets--> <command:syntaxItem parametersetname="Default" default="true"> <!--NAME: Default--> <!--TAG: DEFAULT--> <maml:name>New-SlackChannel</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="0"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Specifies a hashtable that contains information used to license the module and to connect to Slack. Connection information is typically retrieved from Azure Automation using the Get-AutomationConnection cmdlet or in graphical runbooks, with a connection asset data source.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Hashtable</command:parameterValue> <dev:type> <maml:name>Hashtable</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Name</maml:name> <maml:description> <maml:para>Specifies the name of the channel.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Private</maml:name> <maml:description> <maml:para>Indicates that the channel should be private.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>TeamId</maml:name> <maml:description> <maml:para>Specifies the encoded team ID to create the channel in. Required if the OAuth Token belongs to an org-wide app.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!--All Parameters--> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="False" position="named"> <maml:name>Name</maml:name> <maml:description> <maml:para>Specifies the name of the channel.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="False" position="named"> <maml:name>Private</maml:name> <maml:description> <maml:para>Indicates that the channel should be private.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="False" position="named"> <maml:name>TeamId</maml:name> <maml:description> <maml:para>Specifies the encoded team ID to create the channel in. Required if the OAuth Token belongs to an org-wide app.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="False" position="0"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Specifies a hashtable that contains information used to license the module and to connect to Slack. Connection information is typically retrieved from Azure Automation using the Get-AutomationConnection cmdlet or in graphical runbooks, with a connection asset data source.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Hashtable</command:parameterValue> <dev:type> <maml:name>Hashtable</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <!--Inputs--> <command:inputType> <dev:type> <maml:name>None </maml:name> <maml:uri></maml:uri> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <!--Outputs--> <command:returnValue> <dev:type> <maml:name>Kelverion.Slack.Models.Channel</maml:name> <maml:uri></maml:uri> </dev:type> <maml:description> <maml:para>This cmdlet generate a Kelverion.Slack.Models.Channel object that represents the channel that was created.</maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <!--Notes--> <maml:title>Required Scopes</maml:title> <maml:alert> <maml:para>This cmdlet requires Bot User and User tokens to have the channels:manage, groups.write, im:write and mpim:write scopes.</maml:para> </maml:alert> </maml:alertSet> <command:examples> <!--Examples--> <command:example> <maml:title>Example: Create a new public channel.</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>C:\PS> $connection = Get-AutomationConnection -Name 'Slack' C:\PS> New-SlackChannel -Connection $connection -Name 'Testing'</dev:code> <dev:remarks> <maml:para /> </dev:remarks> </command:example> <command:example xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10"> <maml:title xmlns:maml="http://schemas.microsoft.com/maml/2004/10">Example: Create a new private channel.</maml:title> <maml:introduction xmlns:maml="http://schemas.microsoft.com/maml/2004/10"> <maml:para /> </maml:introduction> <dev:code xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10">C:\PS> $connection = Get-AutomationConnection -Name 'Slack' C:\PS> New-SlackChannel -Connection $connection -Name 'Testing' -Private</dev:code> <dev:remarks xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <maml:para /> </dev:remarks> </command:example> </command:examples> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <!--TAG: HASCOMMONPARAMETERS--> <!--Command--> <command:details> <command:name>Open-SlackDirectMessage</command:name> <maml:description> <maml:para>Opens or resumes a direct message or multi-person direct message.</maml:para> </maml:description> <maml:copyright> <maml:para></maml:para> </maml:copyright> <command:verb>Open</command:verb> <command:noun>SlackDirectMessage</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>The Open-SlackDirectMessage cmdlet opens or resumes a direct message or multi-person direct message.</maml:para> </maml:description> <command:syntax> <!--Parameter Sets--> <command:syntaxItem parametersetname="Default"> <!--NAME: Default--> <maml:name>Open-SlackDirectMessage</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="0"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Specifies a hashtable that contains information used to license the module and to connect to Slack. Connection information is typically retrieved from Azure Automation using the Get-AutomationConnection cmdlet or in graphical runbooks, with a connection asset data source.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Hashtable</command:parameterValue> <dev:type> <maml:name>Hashtable</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>ChannelId</maml:name> <maml:description> <maml:para>Specifies the ID of the direct message or multi-person direct message to resume.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> </command:syntaxItem> <command:syntaxItem parametersetname="User"> <!--NAME: User--> <maml:name>Open-SlackDirectMessage</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="0"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Specifies a hashtable that contains information used to license the module and to connect to Slack. Connection information is typically retrieved from Azure Automation using the Get-AutomationConnection cmdlet or in graphical runbooks, with a connection asset data source.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Hashtable</command:parameterValue> <dev:type> <maml:name>Hashtable</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>UserId</maml:name> <maml:description> <maml:para>Specifies the IDs of the users to include. If only one user is specified, a 1:1 direct message is created.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!--All Parameters--> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="False" position="named"> <maml:name>ChannelId</maml:name> <maml:description> <maml:para>Specifies the ID of the direct message or multi-person direct message to resume.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="False" position="0"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Specifies a hashtable that contains information used to license the module and to connect to Slack. Connection information is typically retrieved from Azure Automation using the Get-AutomationConnection cmdlet or in graphical runbooks, with a connection asset data source.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Hashtable</command:parameterValue> <dev:type> <maml:name>Hashtable</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="False" position="named"> <maml:name>UserId</maml:name> <maml:description> <maml:para>Specifies the IDs of the users to include. If only one user is specified, a 1:1 direct message is created.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <!--Inputs--> <command:inputType> <dev:type> <maml:name>None</maml:name> <maml:uri></maml:uri> </dev:type> <maml:description> <maml:para>You cannot pipe objects to the Open-SlackDirectMessage cmdlet.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <!--Outputs--> <command:returnValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri></maml:uri> </dev:type> <maml:description> <maml:para>This cmdlet outputs the ID of the channel that was opened or resumed.</maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <!--Notes--> <maml:title>Required Scopes</maml:title> <maml:alert> <maml:para>This cmdlet requires Bot User tokens to have the channels:manage, groups:write, im:write and mpim:write scopes. User tokens must have the channels:write, groups:write, im:write and mpim:write scopes.</maml:para> </maml:alert> </maml:alertSet> <command:examples> <!--Examples--> <command:example> <maml:title>Example1: Open a direct message.</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>C:\PS> $connection = Get-AutomationConnection -Name 'Slack' C:\PS> Open-SlackDirectMessage -Connection $connection -UserId 'U3456789012'</dev:code> <dev:remarks> <maml:para /> </dev:remarks> </command:example> <command:example> <maml:title>Example: Open a multi-person direct message.</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>C:\PS> $connection = Get-AutomationConnection -Name 'Slack' C:\PS> Open-SlackDirectMessage -Connection $connection -UserId 'W1234567890', 'U2345678901' ',U3456789012'</dev:code> <dev:remarks> <maml:para /> </dev:remarks> </command:example> </command:examples> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <!--TAG: HASCOMMONPARAMETERS--> <!--Command--> <command:details> <command:name>Close-SlackChannel</command:name> <maml:description> <maml:para>Archives a conversation.</maml:para> </maml:description> <maml:copyright> <maml:para></maml:para> </maml:copyright> <command:verb>Close</command:verb> <command:noun>SlackChannel</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>The Close-SlackChannel archives a conversation.</maml:para> </maml:description> <command:syntax> <!--Parameter Sets--> <command:syntaxItem parametersetname="Default" default="true"> <!--NAME: Default--> <!--TAG: DEFAULT--> <maml:name>Close-SlackChannel</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="0"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Specifies a hashtable that contains information used to license the module and to connect to Slack. Connection information is typically retrieved from Azure Automation using the Get-AutomationConnection cmdlet or in graphical runbooks, with a connection asset data source.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Hashtable</command:parameterValue> <dev:type> <maml:name>Hashtable</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>ChannelId</maml:name> <maml:description> <maml:para>Specifies the ID of the channel to archive.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> </command:syntaxItem> <command:syntaxItem parametersetname="InputObject"> <!--NAME: InputObject--> <maml:name>Close-SlackChannel</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="False" position="0"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Specifies a hashtable that contains information used to license the module and to connect to Slack. Connection information is typically retrieved from Azure Automation using the Get-AutomationConnection cmdlet or in graphical runbooks, with a connection asset data source.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Hashtable</command:parameterValue> <dev:type> <maml:name>Hashtable</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" globbing="false" pipelineInput="False" variableLength="false" position="named"> <maml:name>Channel</maml:name> <maml:description> <maml:para>Specifies the channel to archive.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Kelverion.Slack.Models.Channel</command:parameterValue> <dev:type> <maml:name>Kelverion.Slack.Models.Channel</maml:name> <maml:uri /> </dev:type> <dev:defaultValue /> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!--All Parameters--> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="False" position="named"> <maml:name>ChannelId</maml:name> <maml:description> <maml:para>Specifies the ID of the channel to archive.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="False" position="0"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Specifies a hashtable that contains information used to license the module and to connect to Slack. Connection information is typically retrieved from Azure Automation using the Get-AutomationConnection cmdlet or in graphical runbooks, with a connection asset data source.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Hashtable</command:parameterValue> <dev:type> <maml:name>Hashtable</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" globbing="false" pipelineInput="False" variableLength="false" position="named"> <maml:name>Channel</maml:name> <maml:description> <maml:para>Specifies the channel to archive.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Kelverion.Slack.Models.Channel</command:parameterValue> <dev:type> <maml:name>Kelverion.Slack.Models.Channel</maml:name> <maml:uri /> </dev:type> <dev:defaultValue /> </command:parameter> </command:parameters> <command:inputTypes> <!--Inputs--> <command:inputType> <dev:type> <maml:name>None </maml:name> <maml:uri></maml:uri> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <!--Outputs--> <command:returnValue> <dev:type> <maml:name>String, Kelverion.Slack.Models.Channel</maml:name> <maml:uri></maml:uri> </dev:type> <maml:description> <maml:para>This cmdlet ouputs either the ID of the channel or the channel object that was archived, depending on whether the ChannelId or Channel parameters was used.</maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <!--Notes--> <maml:title>Required Scopes.</maml:title> <maml:alert> <maml:para>This cmdlet requires Bot User tokens to have the channels:manage, groups:write, im:write and mpim:write scopes. User tokens must have the channels:write, groups:write, im:write and mpim:write scopes.</maml:para> </maml:alert> </maml:alertSet> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <!--TAG: HASCOMMONPARAMETERS--> <!--Command--> <command:details> <command:name>Remove-SlackMessage</command:name> <maml:description> <maml:para>Removes a message.</maml:para> </maml:description> <maml:copyright> <maml:para></maml:para> </maml:copyright> <command:verb>Remove</command:verb> <command:noun>SlackMessage</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>The Remove-SlackMessage cmdlet removes a message.</maml:para> </maml:description> <command:syntax> <!--Parameter Sets--> <command:syntaxItem parametersetname="Default" default="true"> <!--TAG: DEFAULT--> <!--NAME: Default--> <maml:name>Remove-SlackMessage</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="0"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Specifies a hashtable that contains information used to license the module and to connect to Slack. Connection information is typically retrieved from Azure Automation using the Get-AutomationConnection cmdlet or in graphical runbooks, with a connection asset data source.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Hashtable</command:parameterValue> <dev:type> <maml:name>Hashtable</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>ChannelId</maml:name> <maml:description> <maml:para>Specifies the ID of the channel that contains the message.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="named" aliases="TS"> <maml:name>Timestamp</maml:name> <maml:description> <maml:para>Specifies the timestamps of the messages to remove.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!--All Parameters--> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="False" position="0"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Specifies a hashtable that contains information used to license the module and to connect to Slack. Connection information is typically retrieved from Azure Automation using the Get-AutomationConnection cmdlet or in graphical runbooks, with a connection asset data source.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Hashtable</command:parameterValue> <dev:type> <maml:name>Hashtable</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="False" position="named"> <maml:name>ChannelId</maml:name> <maml:description> <maml:para>Specifies the ID of the channel that contains the message.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="named" aliases="TS"> <maml:name>Timestamp</maml:name> <maml:description> <maml:para>Specifies the timestamps of the messages to remove.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <!--Inputs--> <command:inputType> <dev:type> <maml:name>String, Kelverion.Slack.Models.Message[]</maml:name> <maml:uri></maml:uri> </dev:type> <maml:description> <maml:para>Depending on which parameter set is used, this cmdlet outputs the timestamp of the message that was removed or the message that was passed to the cmdlet.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <!--Outputs--> <command:returnValue> <dev:type> <maml:name>System.String System.Object</maml:name> <maml:uri></maml:uri> </dev:type> <maml:description> <maml:para>The cmdlet outputs the timestamps of the messages that were removed.</maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <!--Notes--> <maml:title>Required Scopes</maml:title> <maml:alert> <maml:para>This cmdlet requires Bot User tokens to have the chat:write scope. User tokens must have the chat:write, chat:write:user and chat:write:bot scopes.</maml:para> </maml:alert> </maml:alertSet> <command:examples> <!--Examples--> <command:example> <maml:title>Example: Remove a mesage.</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>C:\PS> $connection = Get-AutomationConnection -Name 'Slack' C:\PS> Remove-SlackMessage -Connection $connection -ChannelId 'C1234567890' -Timestamp '1405894322.002768'</dev:code> <dev:remarks> <maml:para /> </dev:remarks> </command:example> </command:examples> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <!--TAG: HASCOMMONPARAMETERS--> <!--Command--> <command:details> <command:name>Send-SlackEphemeralMessage</command:name> <maml:description> <maml:para>Sends an ephemeral message to a user in a channel.</maml:para> </maml:description> <maml:copyright> <maml:para></maml:para> </maml:copyright> <command:verb>Send</command:verb> <command:noun>SlackEphemeralMessage</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>The Send-SlackEphemeralMessage cmdlet sends an ephemeral message to a user in a channel.</maml:para> </maml:description> <command:syntax> <!--Parameter Sets--> <command:syntaxItem parametersetname="Default" default="true"> <!--NAME: Default--> <!--TAG: DEFAULT--> <maml:name>Send-SlackEphemeralMessage</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="0"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Specifies a hashtable that contains information used to license the module and to connect to Slack. Connection information is typically retrieved from Azure Automation using the Get-AutomationConnection cmdlet or in graphical runbooks, with a connection asset data source.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Hashtable</command:parameterValue> <dev:type> <maml:name>Hashtable</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Channel</maml:name> <maml:description> <maml:para>Specifies the channel, private group, or IM channel to send the message to. Can be encoded ID or a name.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="Emoji"> <maml:name>Emoji</maml:name> <maml:description> <maml:para>Specifies the emoji to use as the icon for this message. Overrides the Icon parameter.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="Icon"> <maml:name>Icon</maml:name> <maml:description> <maml:para>Specifies the URL to an image to use as the icon for this message.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>UserId</maml:name> <maml:description> <maml:para>Specifies the ID of the user who will receive the ephemeral message. The user should be in the channel specified by the ChannelId parameter.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Text</maml:name> <maml:description> <maml:para>Specifies the text message to send.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Thread</maml:name> <maml:description> <maml:para>Specifies the timestamp of another message. Avoid using the timestamp of a reply message and instead use the timestamp of the parent message. Ephemeral messages in threads are only show if there is already an active thread.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!--All Parameters--> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="False" position="named"> <maml:name>Channel</maml:name> <maml:description> <maml:para>Specifies the channel, private group, or IM channel to send the message to. Can be encoded ID or a name.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="False" position="named" aliases="Emoji"> <maml:name>Emoji</maml:name> <maml:description> <maml:para>Specifies the emoji to use as the icon for this message. Overrides the Icon parameter.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="False" position="named" aliases="Icon"> <maml:name>Icon</maml:name> <maml:description> <maml:para>Specifies the URL to an image to use as the icon for this message.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="False" position="named"> <maml:name>UserId</maml:name> <maml:description> <maml:para>Specifies the ID of the user who will receive the ephemeral message. The user should be in the channel specified by the ChannelId parameter.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="False" position="named"> <maml:name>Text</maml:name> <maml:description> <maml:para>Specifies the text message to send.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="False" position="named"> <maml:name>Thread</maml:name> <maml:description> <maml:para>Specifies the timestamp of another message. Avoid using the timestamp of a reply message and instead use the timestamp of the parent message. Ephemeral messages in threads are only show if there is already an active thread.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="False" position="0"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Specifies a hashtable that contains information used to license the module and to connect to Slack. Connection information is typically retrieved from Azure Automation using the Get-AutomationConnection cmdlet or in graphical runbooks, with a connection asset data source.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Hashtable</command:parameterValue> <dev:type> <maml:name>Hashtable</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <!--Inputs--> <command:inputType> <dev:type> <maml:name>None</maml:name> <maml:uri></maml:uri> </dev:type> <maml:description> <maml:para>You cannot pipe objects to the Send-SlackEphemeralMessage cmdlet.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <!--Outputs--> <command:returnValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri></maml:uri> </dev:type> <maml:description> <maml:para>This cmdlet outputs the timestamp of the message that was sent.</maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <!--Notes--> <maml:title>Required Scopes</maml:title> <maml:alert> <maml:para>This cmdlet requires Bot User tokens to have the chat:write scope. User tokens must have the chat:write, chat:write:user and chat:write:bot scopes.</maml:para> </maml:alert> </maml:alertSet> <command:examples> <!--Examples--> <command:example> <maml:title>Example 1: Send an ephemeral message.</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>C:\PS> $connection = Get-AutomationConnection -Name 'Slack' C:\PS> Send-SlackEphemeralMessage -Connection $connection -ChannelId 'C1234567890' -UserId 'U0BPQUNTA' -Text 'This is a test message'</dev:code> <dev:remarks> <maml:para /> </dev:remarks> </command:example> </command:examples> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <!--TAG: HASCOMMONPARAMETERS--> <!--Command--> <command:details> <command:name>Send-SlackMessage</command:name> <maml:description> <maml:para>Sends a message to a channel.</maml:para> </maml:description> <maml:copyright> <maml:para></maml:para> </maml:copyright> <command:verb>Send</command:verb> <command:noun>SlackMessage</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>The Send-SlackMessage cmdlet sends a message to a channel.</maml:para> </maml:description> <command:syntax> <!--Parameter Sets--> <command:syntaxItem parametersetname="Default" default="true"> <!--NAME: Default--> <!--TAG: DEFAULT--> <maml:name>Send-SlackMessage</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="0"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Specifies a hashtable that contains information used to license the module and to connect to Slack. Connection information is typically retrieved from Azure Automation using the Get-AutomationConnection cmdlet or in graphical runbooks, with a connection asset data source.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Hashtable</command:parameterValue> <dev:type> <maml:name>Hashtable</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Channel</maml:name> <maml:description /> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="Emoji"> <maml:name>Emoji</maml:name> <maml:description> <maml:para>Specifies the emoji to use as the icon for this message. Overrides the Icon parameter.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="Icon"> <maml:name>Icon</maml:name> <maml:description> <maml:para>Specifies the URL to an image to use as the icon for this message.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>ReplyBroadcast</maml:name> <maml:description> <maml:para>Indicates whether the reply should be made visible to everyone in the channel or conversation.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Text</maml:name> <maml:description> <maml:para>Specifies the text message to send.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Thread</maml:name> <maml:description> <maml:para>Specifies the timestamp of another message. Avoid using the timestamp of a reply message and instead use the timestamp of the parent message. Ephemeral messages in threads are only show if there is already an active thread.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!--All Parameters--> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="False" position="named"> <maml:name>Channel</maml:name> <maml:description /> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="False" position="named" aliases="Emoji"> <maml:name>Emoji</maml:name> <maml:description> <maml:para>Specifies the emoji to use as the icon for this message. Overrides the Icon parameter.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="False" position="named" aliases="Icon"> <maml:name>Icon</maml:name> <maml:description> <maml:para>Specifies the URL to an image to use as the icon for this message.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="False" position="named"> <maml:name>ReplyBroadcast</maml:name> <maml:description> <maml:para>Indicates whether the reply should be made visible to everyone in the channel or conversation.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="False" position="named"> <maml:name>Text</maml:name> <maml:description> <maml:para>Specifies the text message to send.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="False" position="named"> <maml:name>Thread</maml:name> <maml:description> <maml:para>Specifies the timestamp of another message. Avoid using the timestamp of a reply message and instead use the timestamp of the parent message. Ephemeral messages in threads are only show if there is already an active thread.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="False" position="0"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Specifies a hashtable that contains information used to license the module and to connect to Slack. Connection information is typically retrieved from Azure Automation using the Get-AutomationConnection cmdlet or in graphical runbooks, with a connection asset data source.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Hashtable</command:parameterValue> <dev:type> <maml:name>Hashtable</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <!--Inputs--> <command:inputType> <dev:type> <maml:name>None</maml:name> <maml:uri></maml:uri> </dev:type> <maml:description> <maml:para>You cannot pipe objects to the Send-SlackMessage cmdlet.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <!--Outputs--> <command:returnValue> <dev:type> <maml:name>Kelverion.Slack.Models.Message</maml:name> <maml:uri></maml:uri> </dev:type> <maml:description> <maml:para>The cmdlet generates a Kelverion.Slack.Models.Message object that represents the message that was sent.</maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <!--Notes--> <maml:title>Required Scopes</maml:title> <maml:alert> <maml:para>This cmdlet requires Bot User tokens to have the chat:write scope. User tokens must have the chat:write, chat:write:user and chat:write:bot scopes.</maml:para> </maml:alert> </maml:alertSet> <command:examples> <!--Examples--> <command:example> <maml:title>Example: Send a text message to a channel.</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>C:\PS> $connection = Get-AutomationConnection -Name 'Slack' C:\PS> Send-SlackMessage -Connection $connection -Channel 'C1234567890' -Text 'This is a test message'</dev:code> <dev:remarks> <maml:para /> </dev:remarks> </command:example> <command:example> <maml:title>Example: Reply to another message.</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>C:\PS> $connection = Get-AutomationConnection -Name 'Slack' C:\PS> Send-SlackMessage -Connection $connection -Channel 'C1234567890' -Thread '1503435956.000247' -Text 'This is a test message'</dev:code> <dev:remarks> <maml:para /> </dev:remarks> </command:example> </command:examples> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <!--TAG: HASCOMMONPARAMETERS--> <!--Command--> <command:details> <command:name>Send-SlackScheduledMessage</command:name> <maml:description> <maml:para>Schedules a message to be send to a channel.</maml:para> </maml:description> <maml:copyright> <maml:para></maml:para> </maml:copyright> <command:verb>Send</command:verb> <command:noun>SlackScheduledMessage</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>The Send-SlackScheduledMessage cmdlet schedules a message to be send to a channel.</maml:para> </maml:description> <command:syntax> <!--Parameter Sets--> <command:syntaxItem parametersetname="Default" default="true"> <!--NAME: Default--> <!--TAG: DEFAULT--> <maml:name>Send-SlackScheduledMessage</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="0"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Specifies a hashtable that contains information used to license the module and to connect to Slack. Connection information is typically retrieved from Azure Automation using the Get-AutomationConnection cmdlet or in graphical runbooks, with a connection asset data source.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Hashtable</command:parameterValue> <dev:type> <maml:name>Hashtable</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Channel</maml:name> <maml:description> <maml:para>Specifies the channel, private group, or IM channel to send the message to. Can be encoded ID or a name.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>DateTime</maml:name> <maml:description> <maml:para>Specifies the date and time when the message should be sent.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">DateTimeOffset</command:parameterValue> <dev:type> <maml:name>DateTimeOffset</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>ReplyBroadcast</maml:name> <maml:description> <maml:para>Indicates whether the reply should be made visible to everyone in the channel or conversation.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Text</maml:name> <maml:description> <maml:para>Specifies the text message to send.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Thread</maml:name> <maml:description> <maml:para>Specifies the timestamp of another message. Avoid using the timestamp of a reply message and instead use the timestamp of the parent message. Ephemeral messages in threads are only show if there is already an active thread.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!--All Parameters--> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="False" position="named"> <maml:name>Channel</maml:name> <maml:description> <maml:para>Specifies the channel, private group, or IM channel to send the message to. Can be encoded ID or a name.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="False" position="named"> <maml:name>DateTime</maml:name> <maml:description> <maml:para>Specifies the date and time when the message should be sent.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">DateTimeOffset</command:parameterValue> <dev:type> <maml:name>DateTimeOffset</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="False" position="named"> <maml:name>ReplyBroadcast</maml:name> <maml:description> <maml:para>Indicates whether the reply should be made visible to everyone in the channel or conversation.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="False" position="named"> <maml:name>Text</maml:name> <maml:description> <maml:para>Specifies the text message to send.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="False" position="named"> <maml:name>Thread</maml:name> <maml:description> <maml:para>Specifies the timestamp of another message. Avoid using the timestamp of a reply message and instead use the timestamp of the parent message. Ephemeral messages in threads are only show if there is already an active thread.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="False" position="0"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Specifies a hashtable that contains information used to license the module and to connect to Slack. Connection information is typically retrieved from Azure Automation using the Get-AutomationConnection cmdlet or in graphical runbooks, with a connection asset data source.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Hashtable</command:parameterValue> <dev:type> <maml:name>Hashtable</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <!--Inputs--> <command:inputType> <dev:type> <maml:name>None </maml:name> <maml:uri></maml:uri> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <!--Outputs--> <command:returnValue> <dev:type> <maml:name>String</maml:name> <maml:uri></maml:uri> </dev:type> <maml:description> <maml:para>This cmdlet outputs the ID of the scheduled message. Not to be confused with message timestamps.</maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <!--Notes--> <maml:title>Required Scopes</maml:title> <maml:alert> <maml:para>This cmdlet requires Bot User tokens to have the chat:write scope. User tokens must have the chat:write, chat:write:user and chat:write:bot scopes.</maml:para> </maml:alert> </maml:alertSet> <command:examples> <!--Examples--> <command:example> <maml:title>Example 1: Schedule a message to be sent at a specified date and time.</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>C:\PS> $connection = Get-AutomationConnection -Name 'Slack' C:\PS> $dateTime = (Get-Date -Hour 12 -Minute).AddDays(1) C:\PS> Send-SlackScheduledMessage -Connection $connection -Channel 'C1234567890' -DateTime $dateTime -Text 'This is a test message'</dev:code> <dev:remarks> <maml:para /> </dev:remarks> </command:example> </command:examples> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <!--TAG: HASCOMMONPARAMETERS--> <!--Command--> <command:details> <command:name>Set-SlackMessage</command:name> <maml:description> <maml:para>Updates a message.</maml:para> </maml:description> <maml:copyright> <maml:para></maml:para> </maml:copyright> <command:verb>Set</command:verb> <command:noun>SlackMessage</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>The Set-SlackMessage cmdlet updates a message.</maml:para> </maml:description> <command:syntax> <!--Parameter Sets--> <command:syntaxItem parametersetname="Default"> <!--NAME: Default--> <maml:name>Set-SlackMessage</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="0"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Specifies a hashtable that contains information used to license the module and to connect to Slack. Connection information is typically retrieved from Azure Automation using the Get-AutomationConnection cmdlet or in graphical runbooks, with a connection asset data source.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Hashtable</command:parameterValue> <dev:type> <maml:name>Hashtable</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>ChannelId</maml:name> <maml:description> <maml:para>Specifies the ID of the channel containing the message to be updated.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Text</maml:name> <maml:description> <maml:para>Specifies new text for the message.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="named" aliases="Ts"> <maml:name>Timestamp</maml:name> <maml:description> <maml:para>Specifies the timestamps of the messages to be updated.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!--All Parameters--> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="False" position="named"> <maml:name>Text</maml:name> <maml:description> <maml:para>Specifies new text for the message.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="False" position="0"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Specifies a hashtable that contains information used to license the module and to connect to Slack. Connection information is typically retrieved from Azure Automation using the Get-AutomationConnection cmdlet or in graphical runbooks, with a connection asset data source.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Hashtable</command:parameterValue> <dev:type> <maml:name>Hashtable</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="False" position="named"> <maml:name>ChannelId</maml:name> <maml:description> <maml:para>Specifies the ID of the channel containing the message to be updated.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="named" aliases="Ts"> <maml:name>Timestamp</maml:name> <maml:description> <maml:para>Specifies the timestamps of the messages to be updated.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <!--Inputs--> <command:inputType> <dev:type> <maml:name>Kelverion.Slack.Models.Message[] </maml:name> <maml:uri></maml:uri> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <!--Outputs--> <command:returnValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri></maml:uri> </dev:type> <maml:description> <maml:para>This cmdlet outputs the timestamp of the message that was updated.</maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <!--Notes--> <maml:title>Required Scopes</maml:title> <maml:alert> <maml:para>This cmdlet requires Bot User tokens to have the chat:write scope. User tokens must have the chat:write, chat:write:user and chat:write:bot scopes.</maml:para> </maml:alert> </maml:alertSet> <command:examples> <!--Examples--> <command:example> <maml:title>Example: Update the text of a message.</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>C:\PS> $connection = Get-AutomationConnection -Name 'Slack' C:\PS> Set-SlackMessage -Connection $connection -ChannelId 'C1234567890' -Timestamp '1405894322.002768' -Text 'This is a test message'</dev:code> <dev:remarks> <maml:para /> </dev:remarks> </command:example> </command:examples> </command:command> <!--Generated by: SAPIEN PowerShell HelpWriter 2018 v2.2.38--> </helpItems> |