Interface DomainBlocksResource

interface DomainBlocksResource {
    $select(id: string): DomainBlocks$SelectResource;
    create(
        params: CreateDomainBlockParams,
        meta?: HttpMetaParams<"json">,
    ): Promise<mastodon.v1.Admin.DomainBlock>;
    list(
        params?: ListDomainBlocksParams,
        meta?: HttpMetaParams<"none">,
    ): Paginator<mastodon.v1.Admin.DomainBlock[], ListDomainBlocksParams>;
}

Index

Methods

$select create list

Methods

$select

$select(id: string): DomainBlocks$SelectResource
Parameters
- id: string
Returns DomainBlocks$SelectResource
- Defined in src/mastodon/rest/v1/admin/domain-blocks.ts:56

create

create(
params: CreateDomainBlockParams,
meta?: HttpMetaParams<"json">,
): Promise<mastodon.v1.Admin.DomainBlock>
Add a domain to the list of domains blocked from federating.
Parameters
- params: CreateDomainBlockParams
  Parameters
- Optionalmeta: HttpMetaParams<"json">
Returns Promise<mastodon.v1.Admin.DomainBlock>
DomainBlock

See
https://docs.joinmastodon.org/methods/admin/domain_blocks/#post
- Defined in src/mastodon/rest/v1/admin/domain-blocks.ts:75

list

list(
params?: ListDomainBlocksParams,
meta?: HttpMetaParams<"none">,
): Paginator<mastodon.v1.Admin.DomainBlock[], ListDomainBlocksParams>
Show information about all blocked domains
Parameters
- Optionalparams: ListDomainBlocksParams
  Parameters
- Optionalmeta: HttpMetaParams<"none">
Returns Paginator<mastodon.v1.Admin.DomainBlock[], ListDomainBlocksParams>
Array of DomainBlock

See
https://docs.joinmastodon.org/methods/admin/domain_blocks/#get
- Defined in src/mastodon/rest/v1/admin/domain-blocks.ts:64