Interface AnnouncementRepository

interface AnnouncementRepository {
    $select(
        id: string,
    ): {
        addReaction(name: string, meta?: HttpMetaParams<"none">): Promise<void>;
        dismiss(meta?: HttpMetaParams<"none">): Promise<void>;
        removeReaction(name: string, meta?: HttpMetaParams<"none">): Promise<void>;
    };
    list(meta?: HttpMetaParams<"none">): Paginator<Announcement[]>;
}

Index

Methods

$select list

Methods

$select

$select(
    id: string,
): {
    addReaction(name: string, meta?: HttpMetaParams<"none">): Promise<void>;
    dismiss(meta?: HttpMetaParams<"none">): Promise<void>;
    removeReaction(name: string, meta?: HttpMetaParams<"none">): Promise<void>;
}
Parameters
- id: string
Returns {
    addReaction(name: string, meta?: HttpMetaParams<"none">): Promise<void>;
    dismiss(meta?: HttpMetaParams<"none">): Promise<void>;
    removeReaction(name: string, meta?: HttpMetaParams<"none">): Promise<void>;
}
- addReaction:function
  - addReaction(name: string, meta?: HttpMetaParams<"none">): Promise<void>
    Add a reaction to an announcement
    
    Parameters
    name: string
    Emoji string
    
    Optionalmeta: HttpMetaParams<"none">
    Returns Promise<void>
    N/A
    
    See
    https://docs.joinmastodon.org/methods/announcements/
    
    Defined in src/mastodon/rest/v1/announcement-repository.ts:27
- dismiss:function
  - dismiss(meta?: HttpMetaParams<"none">): Promise<void>
    Dismiss announcement
    
    Parameters
    Optionalmeta: HttpMetaParams<"none">
    Returns Promise<void>
    Nothing
    
    See
    https://docs.joinmastodon.org/methods/announcements/
    
    Defined in src/mastodon/rest/v1/announcement-repository.ts:19
- removeReaction:function
  - removeReaction(name: string, meta?: HttpMetaParams<"none">): Promise<void>
    Remove a reaction from an announcement
    
    Parameters
    name: string
    Emoji string
    
    Optionalmeta: HttpMetaParams<"none">
    Returns Promise<void>
    N/A
    
    See
    https://docs.joinmastodon.org/methods/announcements/
    
    Defined in src/mastodon/rest/v1/announcement-repository.ts:35
- Defined in src/mastodon/rest/v1/announcement-repository.ts:13

list

list(meta?: HttpMetaParams<"none">): Paginator<Announcement[]>
Fetch announcements
Parameters
- Optionalmeta: HttpMetaParams<"none">
Returns Paginator<Announcement[]>
Announcements

See
https://docs.joinmastodon.org/methods/announcements/
- Defined in src/mastodon/rest/v1/announcement-repository.ts:11

Interface AnnouncementRepository

Index

Methods

Methods

$select

Parameters

Returns {
    addReaction(name: string, meta?: HttpMetaParams<"none">): Promise<void>;
    dismiss(meta?: HttpMetaParams<"none">): Promise<void>;
    removeReaction(name: string, meta?: HttpMetaParams<"none">): Promise<void>;
}

addReaction:function

Parameters

Returns Promise<void>

See

dismiss:function

Parameters

Returns Promise<void>

See

removeReaction:function

Parameters

Returns Promise<void>

See

list

Parameters

Returns Paginator<Announcement[]>

See

Settings

On This Page

Interface AnnouncementRepository

Index

Methods

Methods

$select

Parameters

Returns { addReaction(name: string, meta?: HttpMetaParams<"none">): Promise<void>; dismiss(meta?: HttpMetaParams<"none">): Promise<void>; removeReaction(name: string, meta?: HttpMetaParams<"none">): Promise<void>;}

addReaction:function

Parameters

Returns Promise<void>

See

dismiss:function

Parameters

Returns Promise<void>

See

removeReaction:function

Parameters

Returns Promise<void>

See

list

Parameters

Returns Paginator<Announcement[]>

See

Settings

On This Page

Returns {
addReaction(name: string, meta?: HttpMetaParams<"none">): Promise<void>;
dismiss(meta?: HttpMetaParams<"none">): Promise<void>;
removeReaction(name: string, meta?: HttpMetaParams<"none">): Promise<void>;
}