AtlassianCLI

1.2.2

Private/Atlassian/ConvertTo-AtlassianDateTime.ps1

function ConvertTo-AtlassianDateTime {
    <#
        .SYNOPSIS
            Creates a DateTime objects.
        .DESCRIPTION
            The ConvertTo-AtlassianDateTime cmdlet creates a String object based on specified input.
        .PARAMETER InputObject
            Specifies the DateTime to be used to retrieve the String object.
        .EXAMPLE
            PS C:\> ConvertTo-AtlassianDateTime -InputObject (Get-Date)
            2017-02-24T13:26:32.482+01:00
        .INPUTS
            System.DateTime
            A String object is retrieved using the InputObject parameter
        .OUTPUTS
            System.String
            Returns a String object.
        .NOTES
        .LINK
            http://docs.invoke-automation.com
    #>
    [CmdletBinding(
        #SupportsShouldProcess=$true
    )]
    Param(
        [Parameter(
            Mandatory = $true,
            Position = 1,
            ValueFromPipeline = $true
        )]
        [System.DateTime] $InputObject
    )
    Begin {
        $DATETIMEFORMAT = $SETTINGS.Atlassian.DateTimeStringFormat
    }
    Process {
        try {
            $InputObject.ToString($DATETIMEFORMAT)
        } catch {
            throw ('{0} can not be converted to String' -f $InputObject)
        }
    }
    End {}
}