I recently came across a need to clear Teams cache. While the task might be simple, I ended up spending a little more time to address the scenarios I can foresee so the PowerShell script is more useful that a single use case.<\/p>\n
In this blog post, we’ll be examining this script and also highlight how I applied PowerShell best practices in the process.<\/p>\n
The script begins with a comment block that provides a synopsis, description, parameters, example usage, disclaimer, and notes about the script. This is a common practice in PowerShell to provide detailed information about what the script does, how to use it, and who authored it.<\/p>\n
<#
\n.SYNOPSIS
\nClears the cache for Microsoft Teams (New Client).
\n…
\n.NOTES
\nAuthor: Bhargav Shukla
\nDate: 01\/29\/2024
\n#><\/p><\/blockquote>\nParameters<\/h2>\n
The use of parameters in the script allows users to customize its behavior. This is a best practice in PowerShell as it makes scripts more flexible and reusable. The parameters are defined using the `param` keyword and include default values, another best practice as it makes the script easier to use and more robust.<\/p>\n
param (
\n[bool]$cacheCleared = $false,
\n[string]$logFilePath = “C:\\Logs\\CacheLog.txt”,
\n[string]$errorFilePath = “C:\\Logs\\ErrorLog.txt”
\n)<\/p><\/blockquote>\nPowerShell Best Practices in the Code<\/h2>\n
1. **Commenting**: The script begins with a comprehensive comment block that provides a synopsis, description, parameters, example usage, disclaimer, and notes about the script. This is a best practice as it makes the script self-documenting, which is crucial for maintenance and collaboration.<\/p>\n
3. **Default Parameter Values**: The parameters are defined with default values. This is a best practice as it makes the script easier to use and more robust. It also provides a fallback in case the user does not provide a value.<\/p>\n
4. **Data Types**: The script specifies the data types for each parameter (`bool` for `$cacheCleared` and `string` for `$logFilePath` and `$errorFilePath`). This is a best practice as it ensures that the script receives the correct types of data.<\/p>\n
5. **Code Reusability**: The script uses functions and variables to avoid repeating code and optimize script structure as well.<\/p>\n
Complete Script<\/h2>\n
\n<#\r\n.SYNOPSIS\r\nClears the cache for Microsoft Teams (New Client).\r\n\r\n.DESCRIPTION\r\nThis script sets the variable $cacheCleared to $false, indicating that the cache has not been cleared yet.\r\n\r\n.PARAMETER cacheCleared\r\nA boolean variable that indicates whether the cache has been cleared or not.\r\n\r\n.PARAMETER logFilePath\r\nSpecifies the path where the log file will be created.\r\n\r\n.PARAMETER errorFilePath\r\nSpecifies the path where the error file will be created.\r\n\r\n.EXAMPLE\r\nClear-NewTeamsCache.ps1 -logFilePath \"C:\\Logs\\CacheLog.txt\" -errorFilePath \"C:\\Logs\\ErrorLog.txt\"\r\nClears the cache for Microsoft Teams and creates a log file at the specified path.\r\n\r\n.DISCLAIMER\r\nThis script is provided as-is without any warranty or support. Use it at your own risk.\r\nThe author and Microsoft shall not be liable for any damages or losses arising from the use of this script.\r\n\r\n.NOTES\r\nAuthor: Bhargav Shukla\r\nDate: 01\/29\/2024\r\n#>\r\n\r\nparam (\r\n [bool]$cacheCleared = $false,\r\n [string]$logFilePath = \"C:\\Logs\\CacheLog.txt\",\r\n [string]$errorFilePath = \"C:\\Logs\\ErrorLog.txt\"\r\n)\r\n\r\n# Define cache folder paths\r\n$newCacheFolder = \"$env:userprofile\\appdata\\local\\Packages\\MSTeams_8wekyb3d8bbwe\\LocalCache\\Microsoft\\MSTeams\"\r\n$classicCacheFolder = \"$env:userprofile\\appdata\\roaming\\Microsoft\\Teams\"\r\n\r\n# Function to create a file if it doesn't exist\r\nfunction Create-FileIfNotExists {\r\n param (\r\n [string]$filePath\r\n )\r\n\r\n if (-not (Test-Path -Path $filePath)) {\r\n New-Item -Path $filePath -ItemType File -Force | Out-Null\r\n }\r\n}\r\n\r\n# Function to clear cache\r\nfunction Clear-Cache {\r\n param (\r\n [string]$cacheFolder\r\n )\r\n\r\n Remove-Item -Path $cacheFolder\\* -Force -Recurse\r\n Write-Host \"Cache cleared from $cacheFolder\"\r\n Add-Content -Path $logFilePath -Value \"$(Get-Date -Format 'yyyy-MM-dd HH:mm:ss') - Cache cleared from $cacheFolder\"\r\n}\r\n\r\n# Create log and error files if they don't exist\r\nCreate-FileIfNotExists -filePath $logFilePath\r\nCreate-FileIfNotExists -filePath $errorFilePath\r\n\r\n# Prompt user to clear cache or defer\r\n$choice = Read-Host \"Do you want to clear the Teams cache now? (Y\/N)\"\r\n\r\nif ($choice -eq \"Y\" -or $choice -eq \"y\") {\r\n try {\r\n # Check which version of Teams client is running\r\n $teamsProcess = Get-Process -Name \"MS-Teams\" -ErrorAction SilentlyContinue\r\n if ($teamsProcess -eq $null) {\r\n $teamsProcess = Get-Process -Name \"Teams\" -ErrorAction SilentlyContinue\r\n }\r\n\r\n if ($teamsProcess -ne $null) {\r\n # Quit Teams application\r\n Stop-Process -Id $teamsProcess.Id -Force\r\n\r\n # Delete cache files based on the client version\r\n if ($teamsProcess.Name -eq \"MS-Teams\") {\r\n Clear-Cache -cacheFolder $newCacheFolder\r\n }\r\n else {\r\n Clear-Cache -cacheFolder $classicCacheFolder\r\n }\r\n\r\n # Notify user to start Teams\r\n Write-Host \"Teams cache cleared. You can now start Teams.\"\r\n\r\n # Log the action\r\n Add-Content -Path $logFilePath -Value \"$(Get-Date -Format 'yyyy-MM-dd HH:mm:ss') Cache Cleared\"\r\n }\r\n else {\r\n # Clear cache if Teams is not running\r\n $clientMessage = \"Teams application is not running.\"\r\n Write-Host $clientMessage\r\n Add-Content -Path $logFilePath -Value \"$(Get-Date -Format 'yyyy-MM-dd HH:mm:ss') - $clientMessage\"\r\n\r\n # Verify existence of cache folder(s) and clear cache\r\n if (Test-Path -Path $newCacheFolder) {\r\n Clear-Cache -cacheFolder $newCacheFolder\r\n }\r\n else {\r\n Clear-Cache -cacheFolder $classicCacheFolder\r\n }\r\n }\r\n }\r\n catch {\r\n # Log error if cache clearing fails\r\n $errorMessage = \"Failed to clear cache. Error: $($_.Exception.Message)\"\r\n Write-Host $errorMessage\r\n Add-Content -Path $logFilePath -Value \"$(Get-Date -Format 'yyyy-MM-dd HH:mm:ss') - $errorMessage\"\r\n }\r\n finally {\r\n # Perform cleanup operations here if needed\r\n }\r\n}\r\nelse {\r\n # Log the action\r\n Add-Content -Path $logFilePath -Value \"$(Get-Date -Format 'yyyy-MM-dd HH:mm:ss') - Cache Clearing Deferred\"\r\n}\r\n<\/pre>\nConclusion<\/h2>\n