Interface DomainBlocksResource

interface DomainBlocksResource {
    create(
        params: mastodon.rest.v1.CreateDomainBlockParams,
        meta?: HttpMetaParams<"json">,
    ): Promise<void>;
    list(
        params?: DefaultPaginationParams,
        meta?: HttpMetaParams<"none">,
    ): Paginator<string[], DefaultPaginationParams>;
    remove(
        params: RemoveDomainBlockParams,
        meta?: HttpMetaParams<"json">,
    ): Promise<void>;
}

Index

Methods

create list remove

Methods

create

create(
params: mastodon.rest.v1.CreateDomainBlockParams,
meta?: HttpMetaParams<"json">,
): Promise<void>
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)
Parameters
- params: mastodon.rest.v1.CreateDomainBlockParams
- Optionalmeta: HttpMetaParams<"json">
Returns Promise<void>
N/A

See
https://docs.joinmastodon.org/methods/accounts/domain_blocks/
- Defined in src/mastodon/rest/v1/domain-blocks.ts:37

list

list(
params?: DefaultPaginationParams,
meta?: HttpMetaParams<"none">,
): Paginator<string[], DefaultPaginationParams>
View domains the user has blocked.
Parameters
- Optionalparams: DefaultPaginationParams
  Parameters
- Optionalmeta: HttpMetaParams<"none">
Returns Paginator<string[], DefaultPaginationParams>
Array of strings

See
https://docs.joinmastodon.org/methods/accounts/domain_blocks/
- Defined in src/mastodon/rest/v1/domain-blocks.ts:22

remove

remove(
params: RemoveDomainBlockParams,
meta?: HttpMetaParams<"json">,
): Promise<void>
Remove a domain block, if it exists in the user's array of blocked domains.
Parameters
- params: RemoveDomainBlockParams
- Optionalmeta: HttpMetaParams<"json">
Returns Promise<void>
N/A

See
https://docs.joinmastodon.org/methods/accounts/domain_blocks/
- Defined in src/mastodon/rest/v1/domain-blocks.ts:48