Skip to content

Latest commit

 

History

History
209 lines (77 loc) · 4 KB

Get-AtProtoRepoRecords.md

File metadata and controls

209 lines (77 loc) · 4 KB
Raw

Get-AtProtoRepoRecords

Synopsis

com.atproto.repo.listRecords

Description

com.atproto.repo.listRecords

Related Links

Parameters

Repo

The handle or DID of the repo.

Type Required Position PipelineInput
[String] true 1 true (ByPropertyName)

Collection

The NSID of the record type.

Type Required Position PipelineInput
[String] true 2 true (ByPropertyName)

Limit

The number of records to return.

Type Required Position PipelineInput
[PSObject] false 3 true (ByPropertyName)

Cursor

A cursor that can be used to get more results.

Any command that accepts a -Cursor parameter returns a .Cursor property.

You can provide this -Cursor to the same command with the same input to get more results.

Type Required Position PipelineInput
[String] false 4 true (ByPropertyName)

RkeyStart

DEPRECATED: The lowest sort-ordered rkey to start from (exclusive)

Type Required Position PipelineInput
[String] false 5 true (ByPropertyName)

RkeyEnd

DEPRECATED: The highest sort-ordered rkey to stop at (exclusive)

Type Required Position PipelineInput
[String] false 6 true (ByPropertyName)

Reverse

Reverse the order of the returned records?

Type Required Position PipelineInput
[Switch] false named true (ByPropertyName)

Cache

If set, will cache results for performance.

Type Required Position PipelineInput
[Switch] false named false

Authorization

The authorization. This can be a JWT that accesses the at protocol or a credential. If this is provided as a credential the username is a handle or email and the password is the app password.

Type Required Position PipelineInput Aliases
[Switch] false named false Authentication
AppPassword
Credential
PSCredential

Raw

If set, will return raw results. This will ignore -Property, -DecorateProperty, -ExpandProperty, and -PSTypeName.

Type Required Position PipelineInput
[Switch] false named false

WhatIf

-WhatIf is an automatic variable that is created when a command has [CmdletBinding(SupportsShouldProcess)]. -WhatIf is used to see what would happen, or return operations without executing them

Confirm

-Confirm is an automatic variable that is created when a command has [CmdletBinding(SupportsShouldProcess)]. -Confirm is used to -Confirm each operation.

If you pass -Confirm:$false you will not be prompted.

If the command sets a [ConfirmImpact("Medium")] which is lower than $confirmImpactPreference, you will not be prompted unless -Confirm is passed.

Syntax

Get-AtProtoRepoRecords [-Repo] <String> [-Collection] <String> [[-Limit] <PSObject>] [[-Cursor] <String>] [[-RkeyStart] <String>] [[-RkeyEnd] <String>] [-Reverse] [-Cache] [-Authorization] [-Raw] [-WhatIf] [-Confirm] [<CommonParameters>]