Options
All
  • Public
  • Public/Protected
  • All
Menu

Module activitypub/follow

Index

Functions

Functions

acceptFollow

  • acceptFollow(uri: string, actor?: APActor): Promise<void>

  • Mark an ActivityPub follow request as Accepted

    Parameters

    • uri: string

      The follow URI

    • Optional actor: APActor

      The actor that made the follow request

    Returns Promise<void>

createFollow

  • createFollow(actor: APActor, target: APActor): Promise<Record<string, unknown>>

  • Create an ActivityPub Follow Activity

    Parameters

    • actor: APActor

      An APActor model representing the follow Actor

    • target: APActor

      An APActor model representing the follow target

    Returns Promise<Record<string, unknown>>

    ActivityPub Follow JSON

followJson

  • followJson(follow: APFollow): Promise<Record<string, unknown>>

  • Generate ActivityPub Follow JSON from an APFollow model

    Parameters

    Returns Promise<Record<string, unknown>>

    ActivityPub JSON for follow

rejectFollow

  • rejectFollow(uri: string, actor?: APActor): Promise<void>

  • Delete a rejected ActivityPub follow request

    Parameters

    • uri: string

      The follow URI

    • Optional actor: APActor

      The actor that made the follow request

    Returns Promise<void>

Generated using TypeDoc