Options
All
  • Public
  • Public/Protected
  • All
Menu
label

COMMON

description

The social controller of the app. Handles requests about social platforms. Typically, these requests are used by the frontend runtime to determine dynamic referral links.

This controller defines the following routes:

URI HTTP method Class method Description
/social/platforms GET SocialController.find Responds with a SocialPlatformDTO object that contains a social platforms link details.
/social/share/:provider GET SocialController.share Responds with a SocialPlatformDTO object that contains a social platforms link details.


since

v0.5.0

Hierarchy

  • SocialController

Index

Constructors

Methods

Constructors

  • new SocialController(configService: ConfigService<Record<string, unknown>, false>): SocialController

Methods

  • This method returns a SocialPlatformDTO object that contains information about a social platform's links to share content.

    Note that future iterations may use a browser redirection here or provide a redirection capacity.

    method

    GET

    access

    protected

    async

    Parameters

    • platform: string

      The name of the social platform, e.g. "facebook", "twitter", etc.

    Returns SocialPlatformDTO

    A social platform configuration object.

Generated using TypeDoc