tsky

Appearance

agent

@tsky/client / agent / ListView

ListView ​

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

Extends ​

Implements ​

  • ListView

Constructors ​

new ListView() ​

ts
new ListView(client, list): ListView

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

Parameters ​

client ​

Client

list ​

ListView

Returns ​

ListView

Overrides ​

ListBasicView.constructor

Properties ​

$type? ​

ts
optional $type: string;

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

Implementation of ​

ts
AppBskyGraphDefs.ListView.$type

Inherited from ​

ListBasicView.$type

avatar? ​

ts
optional avatar: string;

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

Implementation of ​

ts
AppBskyGraphDefs.ListView.avatar

Inherited from ​

ListBasicView.avatar

cid ​

ts
cid: string;

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

Implementation of ​

ts
AppBskyGraphDefs.ListView.cid

Inherited from ​

ListBasicView.cid

client ​

ts
client: Client;

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

Inherited from ​

ListBasicView.client

creator ​

ts
creator: ProfileView;

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

Implementation of ​

ts
AppBskyGraphDefs.ListView.creator

description? ​

ts
optional description: string;

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

Maximum string length: 3000 Maximum grapheme length: 300

Implementation of ​

ts
AppBskyGraphDefs.ListView.description

descriptionFacets? ​

ts
optional descriptionFacets: Main[];

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

Implementation of ​

ts
AppBskyGraphDefs.ListView.descriptionFacets

indexedAt ​

ts
indexedAt: string;

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

Implementation of ​

ts
AppBskyGraphDefs.ListView.indexedAt

Overrides ​

ListBasicView.indexedAt

labels? ​

ts
optional labels: Label[];

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

Implementation of ​

ts
AppBskyGraphDefs.ListView.labels

Inherited from ​

ListBasicView.labels

listItemCount? ​

ts
optional listItemCount: number;

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

Minimum: 0

Implementation of ​

ts
AppBskyGraphDefs.ListView.listItemCount

Inherited from ​

ListBasicView.listItemCount

name ​

ts
name: string;

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

Minimum string length: 1 Maximum string length: 64

Implementation of ​

ts
AppBskyGraphDefs.ListView.name

Inherited from ​

ListBasicView.name

purpose ​

ts
purpose: ListPurpose;

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

Implementation of ​

ts
AppBskyGraphDefs.ListView.purpose

Inherited from ​

ListBasicView.purpose

uri ​

ts
uri: string;

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

Implementation of ​

ts
AppBskyGraphDefs.ListView.uri

Inherited from ​

ListBasicView.uri

viewer? ​

ts
optional viewer: ListViewerState;

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

Implementation of ​

ts
AppBskyGraphDefs.ListView.viewer

Inherited from ​

ListBasicView.viewer

Methods ​

about() ​

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

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

Gets a 'view' (with additional context) of a specified list.

Parameters ​

limit? ​

number

options? ​

RPCOptions

Returns ​

Promise<Paginator<Output>>

Inherited from ​

ListBasicView.about

feed() ​

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

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

Get a feed of recent posts from a list (posts and reposts from any actors on the list). Does not require auth.

Parameters ​

limit? ​

number

options? ​

RPCOptions

Returns ​

Promise<Paginator<Output>>

Inherited from ​

ListBasicView.feed