Class CommunitiesFederationService

Service used for interacting with communities on a federated host.

Hierarchy

CommunitiesFederationService

Index

Constructors

constructor

Methods

Constructors

constructor

new CommunitiesFederationService(): CommunitiesFederationService

Returns CommunitiesFederationService

Methods

getAll

getAll(host: string): Promise<Community[]>

- Defined in packages/backend-federation-client/src/communities.ts:55
Return all communities on a given host.

Parameters
- host: string
  
  Host to get communities from.
Returns Promise<Community[]>

All communities on the given host.

getOne

getOne(host: string, id: string): Promise<null | Community>

- Defined in packages/backend-federation-client/src/communities.ts:88
Returns information for a given community on a host.

Parameters
- host: string
  
  The host to get community information from.
- id: string
  
  The ID of the community.
Returns Promise<null | Community>

Information about the community, or null if it does not exist.

Generated using TypeDoc