Interface ConversationRepository

interface ConversationRepository {
    $select(id): {
        read(meta?): Promise<Conversation>;
        remove(meta?): Promise<void>;
        unread(meta?): Promise<Conversation>;
    };
    list(params?, meta?): Paginator<Conversation[], DefaultPaginationParams>;
}

Index

Methods

$select list

Methods

$select

$select(id): {
    read(meta?): Promise<Conversation>;
    remove(meta?): Promise<void>;
    unread(meta?): Promise<Conversation>;
}
Parameters
- id: string
Returns {
    read(meta?): Promise<Conversation>;
    remove(meta?): Promise<void>;
    unread(meta?): Promise<Conversation>;
}
- read:function
  - read(meta?): Promise<Conversation>
  - Mark as read
    Parameters
    - Optional meta: HttpMetaParams<"none">
    Returns Promise<Conversation>
    Conversation
    
    See
    https://docs.joinmastodon.org/methods/timelines/conversations/#post
    - Defined in src/mastodon/rest/v1/conversation-repository.ts:31
- remove:function
  - remove(meta?): Promise<void>
  - Remove conversation
    Parameters
    - Optional meta: HttpMetaParams<"none">
    Returns Promise<void>
    N/A
    
    See
    https://docs.joinmastodon.org/methods/timelines/conversations/#delete
    - Defined in src/mastodon/rest/v1/conversation-repository.ts:24
- unread:function
  - unread(meta?): Promise<Conversation>
  - https://github.com/mastodon/mastodon/pull/25509
    Parameters
    - Optional meta: HttpMetaParams<"none">
    Returns Promise<Conversation>
    - Defined in src/mastodon/rest/v1/conversation-repository.ts:34
- Defined in src/mastodon/rest/v1/conversation-repository.ts:18

list

list(params?, meta?): Paginator<Conversation[], DefaultPaginationParams>
Show conversation
Parameters
- Optional params: DefaultPaginationParams
  Parameters
- Optional meta: HttpMetaParams<"none">
Returns Paginator<Conversation[], DefaultPaginationParams>
Array of Conversation

See
https://docs.joinmastodon.org/methods/timelines/conversations/
- Defined in src/mastodon/rest/v1/conversation-repository.ts:13

Interface ConversationRepository

Index

Methods

Methods

$select

Parameters

Returns {
    read(meta?): Promise<Conversation>;
    remove(meta?): Promise<void>;
    unread(meta?): Promise<Conversation>;
}

read:function

Parameters

Returns Promise<Conversation>

See

remove:function

Parameters

Returns Promise<void>

See

unread:function

Parameters

Returns Promise<Conversation>

list

Parameters

Returns Paginator<Conversation[], DefaultPaginationParams>

See

Settings

Member Visibility

Theme

On This Page

Interface ConversationRepository

Index

Methods

Methods

$select

Parameters

Returns { read(meta?): Promise<Conversation>; remove(meta?): Promise<void>; unread(meta?): Promise<Conversation>; }

read:function

Parameters

Returns Promise<Conversation>

See

remove:function

Parameters

Returns Promise<void>

See

unread:function

Parameters

Returns Promise<Conversation>

list

Parameters

Returns Paginator<Conversation[], DefaultPaginationParams>

See

Settings

Member Visibility

Theme

On This Page

Returns {
read(meta?): Promise<Conversation>;
remove(meta?): Promise<void>;
unread(meta?): Promise<Conversation>;
}