Interface DomainBlocksResource

interface DomainBlocksResource {
    create: Method<
        void,
        mastodon.rest.v1.CreateDomainBlockParams,
        HttpMetaParams<"json">,
    >;
    list: Method<
        Paginator<string[], DefaultPaginationParams>,
        DefaultPaginationParams,
    >;
    remove: Method<void, RemoveDomainBlockParams, HttpMetaParams<"json">>;
}

Index

Properties

create list remove

Properties

create

create: Method<
    void,
    mastodon.rest.v1.CreateDomainBlockParams,
    HttpMetaParams<"json">,
>

Block a domain to:

hide all public posts from it
hide all notifications from it
remove all followers from it
prevent following new users from it (but does not remove existing follows)

Param: domain

Domain to block.

Returns

N/A

See

https://docs.joinmastodon.org/methods/accounts/domain_blocks/

list

list: Method<
Paginator<string[], DefaultPaginationParams>,
DefaultPaginationParams,
>

View domains the user has blocked.

Param: params

Parameters

Returns

Array of strings

See

https://docs.joinmastodon.org/methods/accounts/domain_blocks/

remove

remove: Method<void, RemoveDomainBlockParams, HttpMetaParams<"json">>

Remove a domain block, if it exists in the user's array of blocked domains.

Param: domain

Domain to unblock

Returns

N/A

See

https://docs.joinmastodon.org/methods/accounts/domain_blocks/