external help file: PoshBot-help.xml Module Name: poshbot online version: schema: 2.0.0


New-PoshBotInstance

SYNOPSIS

Creates a new instance of PoshBot

SYNTAX

path (Default)

New-PoshBotInstance -Backend <Backend> [<CommonParameters>]

Path

New-PoshBotInstance [-Path] <String[]> -Backend <Backend> [<CommonParameters>]

LiteralPath

New-PoshBotInstance [-LiteralPath] <String[]> -Backend <Backend> [<CommonParameters>]

config

New-PoshBotInstance -Configuration <BotConfiguration[]> -Backend <Backend> [<CommonParameters>]

DESCRIPTION

Creates a new instance of PoshBot from an existing configuration (.psd1) file or a configuration object.

EXAMPLES

EXAMPLE 1

New-PoshBotInstance -Path 'C:\Users\joeuser\.poshbot\Cherry2000.psd1' -Backend $backend

Name : Cherry2000 Backend : SlackBackend Storage : StorageProvider PluginManager : PluginManager RoleManager : RoleManager Executor : CommandExecutor MessageQueue : {} Configuration : BotConfiguration

Create a new PoshBot instance from configuration file [C:\Users\joeuser.poshbot\Cherry2000.psd1] and Slack backend object [$backend].

EXAMPLE 2

$botConfig = Get-PoshBotConfiguration -Path (Join-Path -Path $env:USERPROFILE -ChildPath '.poshbot\Cherry2000.psd1')

PS C:\> $backend = New-PoshBotSlackBackend -Configuration $botConfig.BackendConfiguration PS C:\> $myBot = $botConfig | New-PoshBotInstance -Backend $backend PS C:\> $myBot | Format-List

Name : Cherry2000 Backend : SlackBackend Storage : StorageProvider PluginManager : PluginManager RoleManager : RoleManager Executor : CommandExecutor MessageQueue : {} Configuration : BotConfiguration

Gets a bot configuration from the filesytem, creates a chat backend object, and then creates a new bot instance.

EXAMPLE 3

$botConfig = Get-PoshBotConfiguration -Path (Join-Path -Path $env:USERPROFILE -ChildPath '.poshbot\Cherry2000.psd1')

PS C:\> $backend = $botConfig | New-PoshBotSlackBackend PS C:\> $myBotJob = $botConfig | New-PoshBotInstance -Backend $backend | Start-PoshBot -AsJob -PassThru

Gets a bot configuration, creates a Slack backend from it, then creates a new PoshBot instance and starts it as a background job.

PARAMETERS

-Path

The path to a PowerShell data (.psd1) file to create a new instance from.

Type: String[]
Parameter Sets: Path
Aliases:

Required: True
Position: 1
Default value: None
Accept pipeline input: True (ByPropertyName, ByValue)
Accept wildcard characters: True

-LiteralPath

Specifies the path(s) to the current location of the file(s). Unlike the Path parameter, the value of LiteralPath is used exactly as it is typed. No characters are interpreted as wildcards. If the path includes escape characters, enclose it in single quotation marks. Single quotation marks tell PowerShell not to interpret any characters as escape sequences.

Type: String[]
Parameter Sets: LiteralPath
Aliases: PSPath

Required: True
Position: 1
Default value: None
Accept pipeline input: True (ByPropertyName)
Accept wildcard characters: False

-Configuration

The bot configuration object to create a new instance from.

Type: BotConfiguration[]
Parameter Sets: config
Aliases:

Required: True
Position: Named
Default value: None
Accept pipeline input: True (ByPropertyName, ByValue)
Accept wildcard characters: False

-Backend

The backend object that hosts logic for receiving and sending messages to a chat network.

Type: Backend
Parameter Sets: (All)
Aliases:

Required: True
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

CommonParameters

This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216).

INPUTS

String

BotConfiguration

OUTPUTS

Bot

NOTES

Get-PoshBotConfiguration

New-PoshBotSlackBackend

Start-PoshBot