agent

---

@tsky/client / agent / User

User

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

Extends

• ActorLazyProfile

Constructors

new User()

new User(client, did): User

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

Parameters

client

Client

did

`did:${string}`

Returns

User

Inherited from

ActorLazyProfile.constructor

Properties

client

client: Client;

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

Inherited from

ActorLazyProfile.client

---

did

did: `did:${string}`;

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

Inherited from

ActorLazyProfile.did

Accessors

muted

Get Signature

get muted(): Muted

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

Returns

Muted

---

preferences

Get Signature

get preferences(): Preferences

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

Returns

Preferences

---

suggestion

Get Signature

get suggestion(): Suggestion

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

Returns

Suggestion

Methods

feed()

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

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

Get a list of feeds (feed generator records) created by the actor (in the actor's repo).

Parameters

params?

Omit<Params, "actor">

options?

RPCOptions

Returns

Promise<Paginator<Output>>

Inherited from

ActorLazyProfile.feed

---

feeds()

feeds(limit?, options?): Promise<Paginator<Output>>

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

Get a view of an actor's 'author feed' (post and reposts by the author). Does not require auth.

Parameters

limit?

number

options?

RPCOptions

Returns

Promise<Paginator<Output>>

Inherited from

ActorLazyProfile.feeds

---

followers()

followers(limit?, options?): Promise<Paginator<Output>>

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

Enumerates accounts which follow a specified account (actor).

Parameters

limit?

number

options?

RPCOptions = {}

Returns

Promise<Paginator<Output>>

Inherited from

ActorLazyProfile.followers

---

follows()

follows(limit?, options?): Promise<Paginator<Output>>

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

Enumerates accounts which a specified account (actor) follows.

Parameters

limit?

number

options?

RPCOptions = {}

Returns

Promise<Paginator<Output>>

Inherited from

ActorLazyProfile.follows

---

likes()

likes(limit?, options?): Promise<Paginator<Output>>

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

Get a list of posts liked by the current user

Parameters

limit?

number

options?

RPCOptions = {}

Returns

Promise<Paginator<Output>>

---

lists()

lists(limit?, options?): Promise<Paginator<Output>>

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

Enumerates the lists created by a specified account (actor).

Parameters

limit?

number

options?

RPCOptions = {}

Returns

Promise<Paginator<Output>>

Inherited from

ActorLazyProfile.lists

---

muteActor()

muteActor(identifier, options): Promise<XRPCResponse<never>>

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

Creates a mute relationship for the specified account. Mutes are private in Bluesky.

Parameters

identifier

string

options

RPCOptions = {}

Returns

Promise<XRPCResponse<never>>

---

muteActorList()

muteActorList(identifier, options): Promise<XRPCResponse<never>>

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

Mute an entire list (specified by AT-URI) of actors. This creates a mute relationship for all actors on the specified list. Mutes are private on Bluesky.

Parameters

identifier

string

options

RPCOptions = {}

Returns

Promise<XRPCResponse<never>>

---

muteThread()

muteThread(identifier, options): Promise<XRPCResponse<never>>

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

Mutes a thread preventing notifications from the thread and any of its children. Mutes are private in Bluesky.

Parameters

identifier

string

options

RPCOptions = {}

Returns

Promise<XRPCResponse<never>>

---

profile()

profile(): Promise<ActorProfile>

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

Returns

Promise<ActorProfile>

Inherited from

ActorLazyProfile.profile

---

relationships()

relationships(others?, options?): Promise<{
  $type: string;
  actor: undefined | ActorLazyProfile;
  relationships: (
     | Typed<NotFoundActor, string>
     | Typed<Relationship, string>)[];
}>

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

Enumerates public relationships between one account, and a list of other accounts. Does not require auth.

Parameters

others?

string[]

options?

RPCOptions

Returns

Promise<{ $type: string; actor: undefined | ActorLazyProfile; relationships: ( | Typed<NotFoundActor, string> | Typed<Relationship, string>)[]; }>

Inherited from

ActorLazyProfile.relationships

---

starterPacks()

starterPacks(limit?, options?): Promise<Paginator<Output>>

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

Get a list of starter packs created by the actor.

Parameters

limit?

number

options?

RPCOptions = {}

Returns

Promise<Paginator<Output>>

Inherited from

ActorLazyProfile.starterPacks

---

timeline()

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

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

Get a view of the requesting account's home timeline. This is expected to be some form of reverse-chronological feed.

Parameters

params

Params

options?

undefined

Returns

Promise<Paginator<Output>>

---

toJSON()

toJSON(): object

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

Returns

object

did

did: `did:${string}`;

Inherited from

ActorLazyProfile.toJSON

---

unmuteActor()

unmuteActor(identifier, options): Promise<XRPCResponse<never>>

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

Unmutes the specified account.

Parameters

identifier

string

options

RPCOptions = {}

Returns

Promise<XRPCResponse<never>>

---

unmuteActorList()

unmuteActorList(identifier, options): Promise<XRPCResponse<never>>

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

Unmute an entire list (specified by AT-URI) of actors. This removes the mute relationship for all actors on the specified list.

Parameters

identifier

string

options

RPCOptions = {}

Returns

Promise<XRPCResponse<never>>

---

unmuteThread()

unmuteThread(identifier, options): Promise<XRPCResponse<never>>

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

Unmutes the specified thread.

Parameters

identifier

string

options

RPCOptions = {}

Returns

Promise<XRPCResponse<never>>