Skip to main content

Get-IMTimeBucket

SYNOPSIS​

SYNTAX​

list (Default)​

Get-IMTimeBucket [-Session <ImmichSession>] [-albumId <String>] [-isArchived <Boolean>] [-isFavorite <Boolean>]
 [-isTrashed <Boolean>] [-order <String>] [-personId <String>] -size <String> [-userId <String>]
 [-withPartners <Boolean>] [-withStacked <Boolean>] [-ProgressAction <ActionPreference>] [<CommonParameters>]

timebucket​

Get-IMTimeBucket [-Session <ImmichSession>] [-albumId <String>] [-isArchived <Boolean>] [-isFavorite <Boolean>]
 [-isTrashed <Boolean>] [-order <String>] [-personId <String>] -size <String> [-timeBucket <String>]
 [-userId <String>] [-withPartners <Boolean>] [-withStacked <Boolean>] [-ProgressAction <ActionPreference>]
 [<CommonParameters>]

DESCRIPTION​

Retreives timebucket objects

EXAMPLES​

EXAMPLE 1​

Get-IMTimeBucket

Retreives timebucket

PARAMETERS​

-Session​

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

-Session $Session

Type: ImmichSession
Parameter Sets: (All)
Aliases:

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

-albumId​

Albumid filter

Type: String
Parameter Sets: (All)
Aliases:

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

-isArchived​

Archived filter

Type: Boolean
Parameter Sets: (All)
Aliases:

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

-isFavorite​

Favorite filter

Type: Boolean
Parameter Sets: (All)
Aliases:

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

-isTrashed​

Trashed filter

Type: Boolean
Parameter Sets: (All)
Aliases:

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

-order​

Defines sort order

Type: String
Parameter Sets: (All)
Aliases:

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

-personId​

PersonId filter

Type: String
Parameter Sets: (All)
Aliases:

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

-size​

Defines size, DAY or MONTH

Type: String
Parameter Sets: (All)
Aliases:

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

-timeBucket​

Timebucket

Type: String
Parameter Sets: timebucket
Aliases:

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

-userId​

UserId filter

Type: String
Parameter Sets: (All)
Aliases:

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

-withPartners​

With partners filter

Type: Boolean
Parameter Sets: (All)
Aliases:

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

-withStacked​

With stacked filter

Type: Boolean
Parameter Sets: (All)
Aliases:

Required: False
Position: Named
Default value: False
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