Skip to content

Latest commit

 

History

History
160 lines (60 loc) · 3.36 KB

Search-BskyUnspeccedActorsSkeleton.md

File metadata and controls

160 lines (60 loc) · 3.36 KB

Search-BskyUnspeccedActorsSkeleton

Synopsis

app.bsky.unspecced.searchActorsSkeleton


Description

app.bsky.unspecced.searchActorsSkeleton


Related Links


Parameters

Q

search query string; syntax, phrase, boolean, and faceting is unspecified, but Lucene query syntax is recommended. For typeahead search, only simple term match is supported, not full syntax

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

Typeahead

if true, acts as fast/simple 'typeahead' query

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

Limit

A limit to the number of results returned.

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

Cursor

optional pagination mechanism; may not necessarily allow scrolling through entire result set

Type Required Position PipelineInput
[String] false 3 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

Search-BskyUnspeccedActorsSkeleton [-Q] <String> [-Typeahead] [[-Limit] <PSObject>] [[-Cursor] <String>] [-Cache] [-Authorization] [-Raw] [-WhatIf] [-Confirm] [<CommonParameters>]