Skip to main content

Get-IMActivity

SYNOPSIS

Retrieves activities from an Immich album

SYNTAX

Get-IMActivity [[-Session] <ImmichSession>] [-AlbumId] <String> [[-AssetId] <String>] [[-Level] <String>]
[[-Type] <String>] [[-UserId] <String>] [-ProgressAction <ActionPreference>] [<CommonParameters>]

DESCRIPTION

Retrieves activities (comments and likes) from an Immich album. Can be filtered by asset, activity type, user, or activity level (album vs asset level).

EXAMPLES

EXAMPLE 1

Get-IMActivity -AlbumId 'bde7ceba-f301-4e9e-87a2-163937a2a3db'

Retrieves all activities for the specified album.

EXAMPLE 2

Get-IMActivity -AlbumId 'bde7ceba-f301-4e9e-87a2-163937a2a3db' -AssetId 'a4908e1f-697f-4d7b-9330-93b5eabe3baf'

Retrieves all activities for a specific asset within the album.

EXAMPLE 3

Get-IMActivity -AlbumId 'bde7ceba-f301-4e9e-87a2-163937a2a3db' -Type 'comment'

Retrieves only comment activities for the album.

PARAMETERS

-Session

Optionally define an Immich session object to use. This is useful when you are connected to more than one Immich instance.

Type: ImmichSession
Parameter Sets: (All)
Aliases:

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

-AlbumId

The UUID of the album to retrieve activities from. Accepts pipeline input.

Type: String
Parameter Sets: (All)
Aliases:

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

-AssetId

The UUID of a specific asset to retrieve activities for. If specified, only activities related to this asset are returned.

Type: String
Parameter Sets: (All)
Aliases:

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

-Level

The level of activities to retrieve. Valid values are 'album' or 'asset'.

Type: String
Parameter Sets: (All)
Aliases:

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

-Type

The type of activities to retrieve. Valid values are 'comment' or 'like'.

Type: String
Parameter Sets: (All)
Aliases:

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

-UserId

The UUID of a specific user to retrieve activities for. If specified, only activities by this user are returned.

Type: String
Parameter Sets: (All)
Aliases:

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

-ProgressAction

{{ Fill ProgressAction Description }}

Type: ActionPreference
Parameter Sets: (All)
Aliases: proga

Required: False
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.

INPUTS

OUTPUTS

NOTES

EDIT THIS DOC

This page was auto-generated from the powershell command comment based help. To edit the content of this page, update the script file comment based help on github Github