Interface TimelineRepository

interface TimelineRepository {
    direct: {
        list(params?: ListTimelineParams, meta?: HttpMetaParams<"none">): Paginator<Status[], ListTimelineParams>;
    };
    home: {
        list(params?: ListTimelineParams, meta?: HttpMetaParams<"none">): Paginator<Status[], ListTimelineParams>;
    };
    link: {
        list(params: ListLinkTimelineParams, meta?: HttpMetaParams<"none">): Paginator<Status[], ListLinkTimelineParams>;
    };
    list: {
        $select(id: string): {
            list(params?: ListTimelineParams, meta?: HttpMetaParams<"none">): Paginator<Status[], ListTimelineParams>;
        };
    };
    public: {
        list(params?: ListTimelineParams, meta?: HttpMetaParams<"none">): Paginator<Status[], ListTimelineParams>;
    };
    tag: {
        $select(hashtag: string): {
            list(params?: ListTimelineParams, meta?: HttpMetaParams<"none">): Paginator<Status[], ListTimelineParams>;
        };
    };
}

Index

Properties

direct home link list public tag

Properties

direct

direct: {
list(params?: ListTimelineParams, meta?: HttpMetaParams<"none">): Paginator<Status[], ListTimelineParams>;
}

Type declaration

list:function
- list(params?, meta?): Paginator<Status[], ListTimelineParams>
- View statuses with a “direct” privacy, from your account or in your notifications.
  Parameters
  - Optionalparams: ListTimelineParams
  - Optionalmeta: HttpMetaParams<"none">
  Returns Paginator<Status[], ListTimelineParams>
  Array of Status
  
  See
  https://docs.joinmastodon.org/methods/timelines/
  - Defined in src/mastodon/rest/v1/timeline-repository.ts:86

home

home: {
list(params?: ListTimelineParams, meta?: HttpMetaParams<"none">): Paginator<Status[], ListTimelineParams>;
}

Type declaration

list:function
- list(params?, meta?): Paginator<Status[], ListTimelineParams>
- View statuses from followed users.
  Parameters
  - Optionalparams: ListTimelineParams
    Parameters
  - Optionalmeta: HttpMetaParams<"none">
  Returns Paginator<Status[], ListTimelineParams>
  Array of Status
  
  See
  https://docs.joinmastodon.org/methods/timelines/
  - Defined in src/mastodon/rest/v1/timeline-repository.ts:28

link

link: {
list(params: ListLinkTimelineParams, meta?: HttpMetaParams<"none">): Paginator<Status[], ListLinkTimelineParams>;
}

Type declaration

list:function
- list(params, meta?): Paginator<Status[], ListLinkTimelineParams>
- View public statuses containing a link to the specified currently-trending article. This only lists statuses from people who have opted in to discoverability features.
  Parameters
  - params: ListLinkTimelineParams
  - Optionalmeta: HttpMetaParams<"none">
  Returns Paginator<Status[], ListLinkTimelineParams>
  Array of Status
  
  See
  https://docs.joinmastodon.org/methods/timelines/#link
  - Defined in src/mastodon/rest/v1/timeline-repository.ts:98

list

list: {
    $select(id: string): {
        list(params?: ListTimelineParams, meta?: HttpMetaParams<"none">): Paginator<Status[], ListTimelineParams>;
    };
}

public

public: {
list(params?: ListTimelineParams, meta?: HttpMetaParams<"none">): Paginator<Status[], ListTimelineParams>;
}

Type declaration

list:function
- list(params?, meta?): Paginator<Status[], ListTimelineParams>
- Public timeline
  Parameters
  - Optionalparams: ListTimelineParams
    Parameters
  - Optionalmeta: HttpMetaParams<"none">
  Returns Paginator<Status[], ListTimelineParams>
  Array of Status
  
  See
  https://docs.joinmastodon.org/methods/timelines/
  - Defined in src/mastodon/rest/v1/timeline-repository.ts:41

tag

tag: {
    $select(hashtag: string): {
        list(params?: ListTimelineParams, meta?: HttpMetaParams<"none">): Paginator<Status[], ListTimelineParams>;
    };
}

Interface TimelineRepository

Index

Properties

Properties

direct

Type declaration

list:function

Parameters

Returns Paginator<Status[], ListTimelineParams>

See

home

Type declaration

list:function

Parameters

Returns Paginator<Status[], ListTimelineParams>

See

link

Type declaration

list:function

Parameters

Returns Paginator<Status[], ListLinkTimelineParams>

See

list

public

Type declaration

list:function

Parameters

Returns Paginator<Status[], ListTimelineParams>

See

tag

Settings

On This Page