Remove-KFItemData

Syntax

Remove-KFData 
  [-Key] <string>
  [-Item <list-item-objekt>]
  [-ThrowErrors[:$true]]

Support

>= kenaflow 1.0.0

Return

Nothing.

Description

This is only available in SharePoint list or state machine workflows!

This cmdlet can be used to delete data previously persisted with Set-KFItemData.

Parameters

[-Key] <string>

The key that is used to read the serialized data.

[-Item <list-item-object>]

The SharePoint list item in whose context the data is serialized.

[-ThrowErrors[:$true]]

This is a default parameter for all kenaflow cmdlets. If set to $true (default!) the engine will pass exception within the cmdlet to the script for further handling.

Example

$item = Get-PnPListItem -List "Custom List" -Id 1
Set-KFItemData -Item $item -Key "kenaflow" -Data @{"is" = "a workflow engine for SharePoint, Email and PowerShell"}
Write-KFLog (Get-KFItemData -Item $item -Key "kenaflow")
Remove-KFItemData -Item $item -Key "kenaflow"

Discussion