Interface DomainAllowsResource

interface DomainAllowsResource {
    $select(id: string): DomainAllows$SelectResource;
    create(
        params: CreateDomainAllowParams,
        meta?: HttpMetaParams<"json">,
    ): Promise<DomainAllow>;
    list(
        params?: DefaultPaginationParams,
        meta?: HttpMetaParams<"none">,
    ): Paginator<DomainAllow[], DefaultPaginationParams>;
}

Index

Methods

$select create list

Methods

$select

$select(id: string): DomainAllows$SelectResource
Parameters
- id: string
Returns DomainAllows$SelectResource
- Defined in src/mastodon/rest/v1/admin/domain-allows.ts:27

create

create(
params: CreateDomainAllowParams,
meta?: HttpMetaParams<"json">,
): Promise<DomainAllow>
Add a domain to the list of domains allowed to federate, to be used when the instance is in allow-list federation mode.
Parameters
- params: CreateDomainAllowParams
  parameters
- Optionalmeta: HttpMetaParams<"json">
Returns Promise<DomainAllow>
DomainAllow

See
https://docs.joinmastodon.org/methods/admin/domain_allows/#get-one
- Defined in src/mastodon/rest/v1/admin/domain-allows.ts:47

list

list(
params?: DefaultPaginationParams,
meta?: HttpMetaParams<"none">,
): Paginator<DomainAllow[], DefaultPaginationParams>
Show information about all allowed domains
Parameters
- Optionalparams: DefaultPaginationParams
  Parameters
- Optionalmeta: HttpMetaParams<"none">
Returns Paginator<DomainAllow[], DefaultPaginationParams>
Array of DomainAllow

See
https://docs.joinmastodon.org/methods/admin/domain_allows/#get
- Defined in src/mastodon/rest/v1/admin/domain-allows.ts:35