tsky

Appearance

agent

@tsky/client / agent / Agent

Agent ​

Defined in: client/src/agent.ts:1180

Constructors ​

new Agent() ​

ts
new Agent(handler): Agent

Defined in: client/src/agent.ts:1183

Parameters ​

handler ​

CredentialManager

Returns ​

Agent

Properties ​

client ​

ts
client: Client;

Defined in: client/src/agent.ts:1181

Accessors ​

Get Signature ​

ts
get search(): Search

Defined in: client/src/agent.ts:1239

Returns ​

Search

session ​

Get Signature ​

ts
get session(): undefined | AtpSessionData

Defined in: client/src/agent.ts:1189

Returns ​

undefined | AtpSessionData

user ​

Get Signature ​

ts
get user(): User

Defined in: client/src/agent.ts:1243

Returns ​

User

video ​

Get Signature ​

ts
get video(): Video

Defined in: client/src/agent.ts:1251

Returns ​

Video

Methods ​

actor() ​

ts
actor(identifier): Promise<ActorLazyProfile>

Defined in: client/src/agent.ts:1196

Get detailed profile view of an actor. Does not require auth, but contains relevant metadata with auth.

Parameters ​

identifier ​

`did:${string}`

Returns ​

Promise<ActorLazyProfile>

feed() ​

ts
feed(params, options?): Promise<Paginator<Output>>

Defined in: client/src/agent.ts:1203

Get a hydrated feed from an actor's selected feed generator. Implemented by App View.

Parameters ​

params ​

Params

options? ​

undefined

Returns ​

Promise<Paginator<Output>>

posts() ​

ts
posts(uris, options?): Promise<PostView[]>

Defined in: client/src/agent.ts:1259

Parameters ​

uris ​

string[]

options? ​

RPCOptions

Returns ​

Promise<PostView[]>

resolveDIDFromHandle() ​

ts
resolveDIDFromHandle(handle, options): Promise<Output>

Defined in: client/src/agent.ts:1309

Parameters ​

handle ​

string

options ​

RPCOptions = {}

Returns ​

Promise<Output>

sendInteractions() ​

ts
sendInteractions(interactions, options): Promise<Output>

Defined in: client/src/agent.ts:1227

Send information about interactions with feed items back to the feed generator that served them.

Parameters ​

interactions ​

Interaction[]

options ​

RPCOptions = {}

Returns ​

Promise<Output>

startpacks() ​

Call Signature ​

ts
startpacks(uri, options?): Promise<Output>

Defined in: client/src/agent.ts:1273

Gets a view of a starter pack.

Parameters ​
uri ​

string

options? ​

RPCOptions

Returns ​

Promise<Output>

Call Signature ​

ts
startpacks(uris, options?): Promise<StarterPackViewBasic[]>

Defined in: client/src/agent.ts:1280

Get views for a list of starter packs.

Parameters ​
uris ​

string[]

options? ​

RPCOptions

Returns ​

Promise<StarterPackViewBasic[]>