en-us/SlackWeb-help.xml
|
<?xml version="1.0" encoding="utf-8"?>
<helpItems schema="maml" xmlns="http://msh"> <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" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Clear-SlackWebConfiguration</command:name> <command:verb>Clear</command:verb> <command:noun>SlackWebConfiguration</command:noun> <maml:description> <maml:para>Removes your custom module configuration.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Removes your custom module configuration. Currently that's the token and cookie.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Clear-SlackWebConfiguration</maml:name> </command:syntaxItem> </command:syntax> <command:parameters /> <command:inputTypes> <command:inputType> <dev:type> <maml:name>None</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues /> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>PS C:\> Clear-SlackWebConfiguration</dev:code> <dev:remarks> <maml:para>Clears your cookie and the token values.</maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks /> </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" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Export-SlackWebChannelHistory</command:name> <command:verb>Export</command:verb> <command:noun>SlackWebChannelHistory</command:noun> <maml:description> <maml:para>Exports all messages and files from a channel, direct messages, or a group chat.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Exports all messages, replies, and files from a channel, direct messages, or a group chat. The messages are put into a JSON-file. Files sent to the channel will have the channel ID and the unique file identifier as prefixes to their name.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Export-SlackWebChannelHistory</maml:name> <command:parameter required="true" variableLength="true" globbing="true" pipelineInput="False" position="named" aliases="none"> <maml:name>Name</maml:name> <maml:description> <maml:para>The name of a channel(s) to export.</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>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>OutFolder</maml:name> <maml:description> <maml:para>The path to a folder where you want to put the exported data.</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>None</dev:defaultValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Export-SlackWebChannelHistory</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>OutFolder</maml:name> <maml:description> <maml:para>The path to a folder where you want to put the exported data.</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>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>ID</maml:name> <maml:description> <maml:para>The ID of a channel you want to export. You can get it from a URL in the web-interface: https://app.slack.com/client/<Team ID>/<Channel ID></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>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="true" globbing="true" pipelineInput="False" position="named" aliases="none"> <maml:name>Name</maml:name> <maml:description> <maml:para>The name of a channel(s) to export.</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>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>OutFolder</maml:name> <maml:description> <maml:para>The path to a folder where you want to put the exported data.</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>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>ID</maml:name> <maml:description> <maml:para>The ID of a channel you want to export. You can get it from a URL in the web-interface: https://app.slack.com/client/<Team ID>/<Channel ID></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>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>None</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues /> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>PS C:\> Export-SlackWebChannelHistory -Name MyChannel -OutFolder .\export</dev:code> <dev:remarks> <maml:para>Saves channel history from all channels available to you named "MyChannel" into the folder ".\export"</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code>PS C:\> Export-SlackWebChannelHistory -ID AAA1AAA1A -OutFolder .\export</dev:code> <dev:remarks> <maml:para>Saves channel history from the channel with ID AAA1AAA1A into the folder ".\export"</maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks /> </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" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Export-SlackWebPeople</command:name> <command:verb>Export</command:verb> <command:noun>SlackWebPeople</command:noun> <maml:description> <maml:para>Exports all user accounts into a JSON-file.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Exports all user accounts from your workspace (and connected to it) into a JSON-file.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Export-SlackWebPeople</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="0" aliases="none"> <maml:name>OutFile</maml:name> <maml:description> <maml:para>A path to the resulting file.</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>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>IncludeDeactivated</maml:name> <maml:description> <maml:para>Specifies that deactivated accounts should be exported too.</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>IncludeDeactivated</maml:name> <maml:description> <maml:para>Specifies that deactivated accounts should be exported too.</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>False</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="0" aliases="none"> <maml:name>OutFile</maml:name> <maml:description> <maml:para>A path to the resulting file.</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>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>None</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues /> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>PS C:\> Export-SlackWebPeople -OutFile .\people.json</dev:code> <dev:remarks> <maml:para>Exports all active user accounts from your workspace (and connected to it) into a JSON-file "people.json".</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>PS C:\> Export-SlackWebPeople -IncludeDeactivated -OutFile .\people.json</dev:code> <dev:remarks> <maml:para>Exports all user accounts from your workspace (and connected to it) into a JSON-file "people.json".</maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks /> </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" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Get-SlackWebChannel</command:name> <command:verb>Get</command:verb> <command:noun>SlackWebChannel</command:noun> <maml:description> <maml:para>Lets you find either a specific channel or get a list of all of them.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Lets you find either a specific channel or get a list of all of them. You can get only channels to which you have access.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Get-SlackWebChannel</maml:name> <command:parameter required="false" variableLength="true" globbing="true" pipelineInput="False" position="0" aliases="none"> <maml:name>Name</maml:name> <maml:description> <maml:para>The name of a channel you want to get in return.</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>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="1" aliases="none"> <maml:name>SearchString</maml:name> <maml:description> <maml:para>Use this as you would you the search field on the Slack channels page.</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>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>ExcludeMine</maml:name> <maml:description> <maml:para>Excludes channels which you are member of from the resulting output.</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>ExcludeMine</maml:name> <maml:description> <maml:para>Excludes channels which you are member of from the resulting output.</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>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="true" pipelineInput="False" position="0" aliases="none"> <maml:name>Name</maml:name> <maml:description> <maml:para>The name of a channel you want to get in return.</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>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="1" aliases="none"> <maml:name>SearchString</maml:name> <maml:description> <maml:para>Use this as you would you the search field on the Slack channels page.</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>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues /> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>PS C:\> Get-SlackWebChannel</dev:code> <dev:remarks> <maml:para>Returns all channels to which you have access</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code>PS C:\> Get-SlackWebChannel -Name MyChannel</dev:code> <dev:remarks> <maml:para>Returns all channels that have the name "MyChannel".</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 3 --------------------------</maml:title> <dev:code>PS C:\> Get-SlackWebChannel -Name '*MyChannel*' -SearchString 'admin'</dev:code> <dev:remarks> <maml:para>Returns all channels that have "MyChannel" in their name AND "admin" the the name or the description.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 4 --------------------------</maml:title> <dev:code>PS C:\> Get-SlackWebChannel -SearchString 'admin'</dev:code> <dev:remarks> <maml:para>Returns all channels that have "admin" the the name or the description.</maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks /> </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" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Get-SlackWebChannelMessages</command:name> <command:verb>Get</command:verb> <command:noun>SlackWebChannelMessages</command:noun> <maml:description> <maml:para>Gets all messages from a channel.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Gets all messages from a channel. Does not return replies (messages in threads).</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Get-SlackWebChannelMessages</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="0" aliases="none"> <maml:name>ChannelID</maml:name> <maml:description> <maml:para>The ID of a channel from which you want to retrieve messages. You can get this ID from a URL in the web-interface: https://app.slack.com/client/<Team ID>/<Channel ID></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>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="0" aliases="none"> <maml:name>ChannelID</maml:name> <maml:description> <maml:para>The ID of a channel from which you want to retrieve messages. You can get this ID from a URL in the web-interface: https://app.slack.com/client/<Team ID>/<Channel ID></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>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>None</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues /> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>PS C:\> Get-SlackWebChannelMessages -ChannelID AAA1AAA1A</dev:code> <dev:remarks> <maml:para>Returns all messages from the channel with an ID AAA1AAA1A</maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks /> </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" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Get-SlackWebConfiguration</command:name> <command:verb>Get</command:verb> <command:noun>SlackWebConfiguration</command:noun> <maml:description> <maml:para>Retrieves your current configuration (token and d-cookie).</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Retrieves your current configuration (token and d-cookie).</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Get-SlackWebConfiguration</maml:name> </command:syntaxItem> </command:syntax> <command:parameters /> <command:inputTypes> <command:inputType> <dev:type> <maml:name>None</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues /> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>PS C:\> Get-SlackWebConfiguration</dev:code> <dev:remarks> <maml:para>Retrieves your current configuration (token and d-cookie).</maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks /> </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" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Get-SlackWebPeople</command:name> <command:verb>Get</command:verb> <command:noun>SlackWebPeople</command:noun> <maml:description> <maml:para>Returns accounts from your workspace (and all connections).</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Returns accounts from your workspace (and all connections).</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Get-SlackWebPeople</maml:name> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>IncludeDeactivated</maml:name> <maml:description> <maml:para>Specifies that deactivated accounts should be returned too.</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>IncludeDeactivated</maml:name> <maml:description> <maml:para>Specifies that deactivated accounts should be returned too.</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>False</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>None</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues /> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>PS C:\> Get-SlackWebPeople</dev:code> <dev:remarks> <maml:para>Returns all active accounts from your workspace (and all connections).</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code>PS C:\> Get-SlackWebPeople -IncludeDeactivated</dev:code> <dev:remarks> <maml:para>Returns all accounts from your workspace (and all connections).</maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks /> </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" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Send-SlackWebMessage</command:name> <command:verb>Send</command:verb> <command:noun>SlackWebMessage</command:noun> <maml:description> <maml:para>Sends a message to one or several channels.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Sends a message to one or several channels.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Send-SlackWebMessage</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>ChannelID</maml:name> <maml:description> <maml:para>The ID of a channel(s) where you want to send a message. You can get it from a URL in the web-interface: https://app.slack.com/client/<Team ID>/<Channel ID></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>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Text</maml:name> <maml:description> <maml:para>Text of your plain-text 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>None</dev:defaultValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Send-SlackWebMessage</maml:name> <command:parameter required="true" variableLength="true" globbing="true" pipelineInput="False" position="named" aliases="none"> <maml:name>ChannelName</maml:name> <maml:description> <maml:para>The ID of a channel(s) where you want to send a 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>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Text</maml:name> <maml:description> <maml:para>Text of your plain-text 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>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>ChannelID</maml:name> <maml:description> <maml:para>The ID of a channel(s) where you want to send a message. You can get it from a URL in the web-interface: https://app.slack.com/client/<Team ID>/<Channel ID></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>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="true" pipelineInput="False" position="named" aliases="none"> <maml:name>ChannelName</maml:name> <maml:description> <maml:para>The ID of a channel(s) where you want to send a 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>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Text</maml:name> <maml:description> <maml:para>Text of your plain-text 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>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>None</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues /> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>PS C:\> Send-SlackWebMessage -ChannelName MyChannel -Text 'TEST'</dev:code> <dev:remarks> <maml:para>Sends a plain-text message "TEST" to a channel called MyName.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code>PS C:\> Send-SlackWebMessage -ChannelName MyC* -Text 'TEST'</dev:code> <dev:remarks> <maml:para>Sends a plain-text message "TEST" to all channels which name starts with "MyC".</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 3 --------------------------</maml:title> <dev:code>PS C:\> Send-SlackWebMessage -ChannelID AAA1AAA1A -Text 'TEST'</dev:code> <dev:remarks> <maml:para>Sends a plain-text message "TEST" to a channel with the ID "AAA1AAA1A".</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 4 --------------------------</maml:title> <dev:code>PS C:\> Send-SlackWebMessage -ChannelID AAA1AAA1A, BBB2BBB2B -Text 'TEST'</dev:code> <dev:remarks> <maml:para>Sends a plain-text message "TEST" to channels with IDs "AAA1AAA1A" and "BBB2BBB2B".</maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks /> </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" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Set-SlackWebConfiguration</command:name> <command:verb>Set</command:verb> <command:noun>SlackWebConfiguration</command:noun> <maml:description> <maml:para>Allows you to change your cookie and token in module's settings.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Use this function if you want to update your token and/or d-cookie values. You will have to reload the module for the new values to become active.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Set-SlackWebConfiguration</maml:name> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="0" aliases="none"> <maml:name>Token</maml:name> <maml:description> <maml:para>The value of your web-token (xoxc-).</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>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="1" aliases="none"> <maml:name>Cookie</maml:name> <maml:description> <maml:para>The value of your d-cookie.</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>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="1" aliases="none"> <maml:name>Cookie</maml:name> <maml:description> <maml:para>The value of your d-cookie.</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>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="0" aliases="none"> <maml:name>Token</maml:name> <maml:description> <maml:para>The value of your web-token (xoxc-).</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>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>None</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues /> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>PS C:\> Set-SlackWebConfiguration -Token 'xoxc-111111111111-111111111111-1111111111111-aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa' -Cookie 'zJYZLiEmWCDwf1UK2Rd7MAFOesSaGVuH86on0vgPQhTXcBlkpyN3x49bjtqr5Ili54uEJRskqyM7A6FInHgUKo93pC2GSP1LVZ8f0vwDcNxadtrmWeTYBQOzbXhjTkhyzi4SLXHjY9REMGfeCQpnoAstdV0xbBc723ZOwgP8qKNav5l6IrDJW1FmUu'</dev:code> <dev:remarks> <maml:para>Sets the values of the cookie and token.</maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks /> </command:command> </helpItems> |