Interface StatusRepository

interface StatusRepository {
    $select(id): {
        card: {
            fetch(meta?): Promise<PreviewCard>;
        };
        context: {
            fetch(meta?): Promise<Context>;
        };
        favouritedBy: {
            list(meta?): Paginator<mastodon.v1.Account[], undefined>;
        };
        history: {
            list(meta?): Paginator<StatusEdit[], undefined>;
        };
        rebloggedBy: {
            list(meta?): Paginator<mastodon.v1.Account[], undefined>;
        };
        source: {
            fetch(meta?): Promise<StatusSource>;
        };
        bookmark(meta?): Promise<Status>;
        favourite(meta?): Promise<Status>;
        fetch(meta?): Promise<Status>;
        mute(meta?): Promise<Status>;
        pin(meta?): Promise<Status>;
        reblog(params?, meta?): Promise<Status>;
        remove(meta?): Promise<Status>;
        translate(params, meta?): Promise<Translation>;
        unbookmark(meta?): Promise<Status>;
        unfavourite(meta?): Promise<Status>;
        unmute(meta?): Promise<Status>;
        unpin(meta?): Promise<Status>;
        unreblog(meta?): Promise<Status>;
        update(params, meta?): Promise<Status>;
    };
    create(params, meta?): Promise<Status>;
    create(params, meta?): Promise<ScheduledStatus>;
}

Index

Methods

$select create

Methods

$select

$select(id): {
    card: {
        fetch(meta?): Promise<PreviewCard>;
    };
    context: {
        fetch(meta?): Promise<Context>;
    };
    favouritedBy: {
        list(meta?): Paginator<mastodon.v1.Account[], undefined>;
    };
    history: {
        list(meta?): Paginator<StatusEdit[], undefined>;
    };
    rebloggedBy: {
        list(meta?): Paginator<mastodon.v1.Account[], undefined>;
    };
    source: {
        fetch(meta?): Promise<StatusSource>;
    };
    bookmark(meta?): Promise<Status>;
    favourite(meta?): Promise<Status>;
    fetch(meta?): Promise<Status>;
    mute(meta?): Promise<Status>;
    pin(meta?): Promise<Status>;
    reblog(params?, meta?): Promise<Status>;
    remove(meta?): Promise<Status>;
    translate(params, meta?): Promise<Translation>;
    unbookmark(meta?): Promise<Status>;
    unfavourite(meta?): Promise<Status>;
    unmute(meta?): Promise<Status>;
    unpin(meta?): Promise<Status>;
    unreblog(meta?): Promise<Status>;
    update(params, meta?): Promise<Status>;
}
Parameters
- id: string
Returns {
    card: {
        fetch(meta?): Promise<PreviewCard>;
    };
    context: {
        fetch(meta?): Promise<Context>;
    };
    favouritedBy: {
        list(meta?): Paginator<mastodon.v1.Account[], undefined>;
    };
    history: {
        list(meta?): Paginator<StatusEdit[], undefined>;
    };
    rebloggedBy: {
        list(meta?): Paginator<mastodon.v1.Account[], undefined>;
    };
    source: {
        fetch(meta?): Promise<StatusSource>;
    };
    bookmark(meta?): Promise<Status>;
    favourite(meta?): Promise<Status>;
    fetch(meta?): Promise<Status>;
    mute(meta?): Promise<Status>;
    pin(meta?): Promise<Status>;
    reblog(params?, meta?): Promise<Status>;
    remove(meta?): Promise<Status>;
    translate(params, meta?): Promise<Translation>;
    unbookmark(meta?): Promise<Status>;
    unfavourite(meta?): Promise<Status>;
    unmute(meta?): Promise<Status>;
    unpin(meta?): Promise<Status>;
    unreblog(meta?): Promise<Status>;
    update(params, meta?): Promise<Status>;
}
- card: {
  fetch(meta?): Promise<PreviewCard>;
  }
  - fetch:function
    - fetch(meta?): Promise<PreviewCard>
    - Preview card
      Parameters
      Optional meta: HttpMetaParams<"none">
      Returns Promise<PreviewCard>
      Card
      
      See
      https://docs.joinmastodon.org/api/rest/statuses/#get-api-v1-statuses-id-card
      
      Deprecated
      Defined in src/mastodon/rest/v1/status-repository.ts:150
- context: {
  fetch(meta?): Promise<Context>;
  }
  - fetch:function
    - fetch(meta?): Promise<Context>
    - View statuses above and below this status in the thread.
      Parameters
      Optional meta: HttpMetaParams<"none">
      Returns Promise<Context>
      Context
      
      See
      https://docs.joinmastodon.org/methods/statuses/
      Defined in src/mastodon/rest/v1/status-repository.ts:140
- favouritedBy: {
  list(meta?): Paginator<mastodon.v1.Account[], undefined>;
  }
  - list:function
    - list(meta?): Paginator<mastodon.v1.Account[], undefined>
    - View who favourited a given status.
      Parameters
      Optional meta: HttpMetaParams<"none">
      Returns Paginator<mastodon.v1.Account[], undefined>
      Array of Account
      
      See
      https://docs.joinmastodon.org/methods/statuses/
      Defined in src/mastodon/rest/v1/status-repository.ts:196
- history: {
  list(meta?): Paginator<StatusEdit[], undefined>;
  }
  - list:function
    - list(meta?): Paginator<StatusEdit[], undefined>
    - Get all known versions of a status, including the initial and current states.
      Parameters
      Optional meta: HttpMetaParams<"none">
      Returns Paginator<StatusEdit[], undefined>
      StatusEdit
      
      See
      https://docs.joinmastodon.org/methods/statuses/#history
      Defined in src/mastodon/rest/v1/status-repository.ts:250
- rebloggedBy: {
  list(meta?): Paginator<mastodon.v1.Account[], undefined>;
  }
  - list:function
    - list(meta?): Paginator<mastodon.v1.Account[], undefined>
    - View who boosted a given status.
      Parameters
      Optional meta: HttpMetaParams<"none">
      Returns Paginator<mastodon.v1.Account[], undefined>
      Array of Account
      
      See
      https://docs.joinmastodon.org/methods/statuses/
      Defined in src/mastodon/rest/v1/status-repository.ts:187
- source: {
  fetch(meta?): Promise<StatusSource>;
  }
  - fetch:function
    - fetch(meta?): Promise<StatusSource>
    - Obtain the source properties for a status so that it can be edited.
      Parameters
      Optional meta: HttpMetaParams<"none">
      Returns Promise<StatusSource>
      StatusSource
      
      See
      https://docs.joinmastodon.org/methods/statuses/#source
      Defined in src/mastodon/rest/v1/status-repository.ts:259
- bookmark:function
  - bookmark(meta?): Promise<Status>
  - Privately bookmark a status.
    Parameters
    - Optional meta: HttpMetaParams<"none">
    Returns Promise<Status>
    Status
    
    See
    https://docs.joinmastodon.org/methods/statuses/
    - Defined in src/mastodon/rest/v1/status-repository.ts:235
- favourite:function
  - favourite(meta?): Promise<Status>
  - Add a status to your favourites list.
    Parameters
    - Optional meta: HttpMetaParams<"none">
    Returns Promise<Status>
    Status
    
    See
    https://docs.joinmastodon.org/methods/statuses/
    - Defined in src/mastodon/rest/v1/status-repository.ts:158
- fetch:function
  - fetch(meta?): Promise<Status>
  - View information about a status.
    Parameters
    - Optional meta: HttpMetaParams<"none">
    Returns Promise<Status>
    Status
    
    See
    https://docs.joinmastodon.org/methods/statuses/
    - Defined in src/mastodon/rest/v1/status-repository.ts:114
- mute:function
  - mute(meta?): Promise<Status>
  - Do not receive notifications for the thread that this status is part of. Must be a thread in which you are a participant.
    Parameters
    - Optional meta: HttpMetaParams<"none">
    Returns Promise<Status>
    Status
    
    See
    https://docs.joinmastodon.org/methods/statuses/
    - Defined in src/mastodon/rest/v1/status-repository.ts:172
- pin:function
  - pin(meta?): Promise<Status>
  - Feature one of your own public statuses at the top of your profile.
    Parameters
    - Optional meta: HttpMetaParams<"none">
    Returns Promise<Status>
    Status
    
    See
    https://docs.joinmastodon.org/methods/statuses/
    - Defined in src/mastodon/rest/v1/status-repository.ts:221
- reblog:function
  - reblog(params?, meta?): Promise<Status>
  - Re-share a status.
    Parameters
    - Optional params: ReblogStatusParams
    - Optional meta: HttpMetaParams<"json">
    Returns Promise<Status>
    Status
    
    See
    https://docs.joinmastodon.org/api/rest/statuses/#post-api-v1-statuses-id-reblog
    - Defined in src/mastodon/rest/v1/status-repository.ts:204
- remove:function
  - remove(meta?): Promise<Status>
  - Delete one of your own statuses.
    Parameters
    - Optional meta: HttpMetaParams<"none">
    Returns Promise<Status>
    Status with source text and media_attachments or poll
    
    See
    https://docs.joinmastodon.org/methods/statuses/
    - Defined in src/mastodon/rest/v1/status-repository.ts:132
- translate:function
  - translate(params, meta?): Promise<Translation>
  - Translate the status content into some language.
    Parameters
    - params: TranslateStatusParams
      Form data parameters
    - Optional meta: HttpMetaParams<"none">
    Returns Promise<Translation>
    Translation
    - Defined in src/mastodon/rest/v1/status-repository.ts:267
- unbookmark:function
  - unbookmark(meta?): Promise<Status>
  - Remove a status from your private bookmarks.
    Parameters
    - Optional meta: HttpMetaParams<"none">
    Returns Promise<Status>
    Status
    
    See
    https://docs.joinmastodon.org/methods/statuses/
    - Defined in src/mastodon/rest/v1/status-repository.ts:242
- unfavourite:function
  - unfavourite(meta?): Promise<Status>
  - Remove a status from your favourites list.
    Parameters
    - Optional meta: HttpMetaParams<"none">
    Returns Promise<Status>
    Status
    
    See
    https://docs.joinmastodon.org/methods/statuses/
    - Defined in src/mastodon/rest/v1/status-repository.ts:165
- unmute:function
  - unmute(meta?): Promise<Status>
  - Start receiving notifications again for the thread that this status is part of.
    Parameters
    - Optional meta: HttpMetaParams<"none">
    Returns Promise<Status>
    Status
    
    See
    https://docs.joinmastodon.org/methods/statuses/
    - Defined in src/mastodon/rest/v1/status-repository.ts:179
- unpin:function
  - unpin(meta?): Promise<Status>
  - Un-feature a status from the top of your profile.
    Parameters
    - Optional meta: HttpMetaParams<"none">
    Returns Promise<Status>
    Status
    
    See
    https://docs.joinmastodon.org/methods/statuses/
    - Defined in src/mastodon/rest/v1/status-repository.ts:228
- unreblog:function
  - unreblog(meta?): Promise<Status>
  - Undo a re-share of a status.
    Parameters
    - Optional meta: HttpMetaParams<"none">
    Returns Promise<Status>
    Status
    
    See
    https://docs.joinmastodon.org/methods/statuses/
    - Defined in src/mastodon/rest/v1/status-repository.ts:214
- update:function
  - update(params, meta?): Promise<Status>
  - Update a status
    Parameters
    - params: UpdateStatusParams
      Parameters
    - Optional meta: HttpMetaParams<"json">
    Returns Promise<Status>
    Status. When scheduled_at is present, ScheduledStatus is returned instead.
    
    See
    https://docs.joinmastodon.org/api/rest/statuses/#post-api-v1-statuses
    - Defined in src/mastodon/rest/v1/status-repository.ts:122
- Defined in src/mastodon/rest/v1/status-repository.ts:108

create

create(params, meta?): Promise<Status>
Post a new status.
Parameters
- params: CreateStatusParams
  Parameters
- Optional meta: HttpMetaParams<"json">
Returns Promise<Status>
Status. When scheduled_at is present, ScheduledStatus is returned instead.

See
https://docs.joinmastodon.org/api/rest/statuses/#post-api-v1-statuses
- Defined in src/mastodon/rest/v1/status-repository.ts:99
create(params, meta?): Promise<ScheduledStatus>
Parameters
- params: CreateScheduledStatusParams
- Optional meta: HttpMetaParams<"json">
Returns Promise<ScheduledStatus>
- Defined in src/mastodon/rest/v1/status-repository.ts:103

Interface StatusRepository

Index

Methods

Methods

$select

Parameters

card: { fetch(meta?): Promise<PreviewCard>; }

fetch:function

Parameters

Returns Promise<PreviewCard>

See

Deprecated

context: { fetch(meta?): Promise<Context>; }

fetch:function

Parameters

Returns Promise<Context>

See

favouritedBy: { list(meta?): Paginator<mastodon.v1.Account[], undefined>; }

list:function

Parameters

Returns Paginator<mastodon.v1.Account[], undefined>

See

history: { list(meta?): Paginator<StatusEdit[], undefined>; }

list:function

Parameters

Returns Paginator<StatusEdit[], undefined>

See

rebloggedBy: { list(meta?): Paginator<mastodon.v1.Account[], undefined>; }

list:function

Parameters

Returns Paginator<mastodon.v1.Account[], undefined>

See

source: { fetch(meta?): Promise<StatusSource>; }

fetch:function

Parameters

Returns Promise<StatusSource>

See

bookmark:function

Parameters

Returns Promise<Status>

See

favourite:function

Parameters

Returns Promise<Status>

See

fetch:function

Parameters

Returns Promise<Status>

See

mute:function

Parameters

Returns Promise<Status>

See

pin:function

Parameters

Returns Promise<Status>

See

reblog:function

Parameters

Returns Promise<Status>

See

remove:function

Parameters

Returns Promise<Status>

See

translate:function

Parameters

Returns Promise<Translation>

unbookmark:function

Parameters

Returns Promise<Status>

See

unfavourite:function

Parameters

Returns Promise<Status>

See

unmute:function

Parameters

Returns Promise<Status>

See

card: {
fetch(meta?): Promise<PreviewCard>;
}

context: {
fetch(meta?): Promise<Context>;
}

favouritedBy: {
list(meta?): Paginator<mastodon.v1.Account[], undefined>;
}

history: {
list(meta?): Paginator<StatusEdit[], undefined>;
}

rebloggedBy: {
list(meta?): Paginator<mastodon.v1.Account[], undefined>;
}

source: {
fetch(meta?): Promise<StatusSource>;
}