Options
All
  • Public
  • Public/Protected
  • All
Menu

Class CommunitiesService

Hierarchy

  • CommunitiesFederationService
    • CommunitiesService

Index

Constructors

Methods

Constructors

constructor

Methods

create

  • create(username: string, id: string, title: string, description: string): Promise<boolean>

getAll

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

  • 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>

  • 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