Interface TimelineRepository

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

Index

Properties

direct home list public tag

Properties

direct

direct: {
list(params?, meta?): 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
  - Optional params: ListTimelineParams
  - Optional meta: 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:81

home

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

Type declaration

list:function
- list(params?, meta?): Paginator<Status[], ListTimelineParams>
- View statuses from followed users.
  Parameters
  - Optional params: ListTimelineParams
    Parameters
  - Optional meta: 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:23

list

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

Type declaration

$select:function
- $select(id): {
  list(params?, meta?): Paginator<Status[], ListTimelineParams>;
  }
- Parameters
  - id: string
  Returns {
  list(params?, meta?): Paginator<Status[], ListTimelineParams>;
  }
  - list:function
    - list(params?, meta?): Paginator<Status[], ListTimelineParams>
    - View statuses in the given list timeline.
      Parameters
      Optional params: ListTimelineParams
      Query parameter
      
      Optional meta: 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:67
  - Defined in src/mastodon/rest/v1/timeline-repository.ts:59

public

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

Type declaration

list:function
- list(params?, meta?): Paginator<Status[], ListTimelineParams>
- Public timeline
  Parameters
  - Optional params: ListTimelineParams
    Parameters
  - Optional meta: 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:36

tag

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

Type declaration

$select:function
- $select(hashtag): {
  list(params?, meta?): Paginator<Status[], ListTimelineParams>;
  }
- Parameters
  - hashtag: string
  Returns {
  list(params?, meta?): Paginator<Status[], ListTimelineParams>;
  }
  - list:function
    - list(params?, meta?): Paginator<Status[], ListTimelineParams>
    - View public statuses containing the given hashtag.
      Parameters
      Optional params: ListTimelineParams
      Parameters
      
      Optional meta: HttpMetaParams<"none">
      Returns Paginator<Status[], ListTimelineParams>
      Array of Status
      
      See
      https://docs.joinmastodon.org/methods/timelines#tag
      Defined in src/mastodon/rest/v1/timeline-repository.ts:51
  - Defined in src/mastodon/rest/v1/timeline-repository.ts:43

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

list

Type declaration

$select:function

Parameters

Returns { list(params?, meta?): Paginator<Status[], ListTimelineParams>; }

list:function

Parameters

Returns Paginator<Status[], ListTimelineParams>

See

public

Type declaration

list:function

Parameters

Returns Paginator<Status[], ListTimelineParams>

See

tag

Type declaration

$select:function

Parameters

Returns { list(params?, meta?): Paginator<Status[], ListTimelineParams>; }

list:function

Parameters

Returns Paginator<Status[], ListTimelineParams>

See

Settings

Member Visibility

Theme

On This Page

Returns {
list(params?, meta?): Paginator<Status[], ListTimelineParams>;
}

Returns {
list(params?, meta?): Paginator<Status[], ListTimelineParams>;
}