Options
All
  • Public
  • Public/Protected
  • All
Menu

The base class for all sharing link providers.

Hierarchy

  • SharingLinkProviderBase

Index

Constructors

constructor

Properties

acceptParameter

acceptParameter: boolean

Whether the sharing link provider will apply a url parameter on startup.

app

generateParameter

generateParameter: boolean

Whether the sharing link provider will produce a parameter when generating a url.

libraryId

libraryId: string

name

name: string

The name of the sharing link provider to be used in the url.

priority

priority: number

The priority for this sharing link provider when being applying on startup.

Methods

apply

  • apply(urlParameter: string): void
  • Apply the url parameter.

    Parameters

    • urlParameter: string

      The url parameter to apply.

    Returns void

generate

  • generate(): string
  • Generate the url parameter.

    Returns string

getResource

  • getResource(resourceKey: string, locale?: string): string
  • Gets a language resource from the Application's resource dictionary, given a key, and optional locale. Returns null if the resource does not exist.

    Parameters

    • resourceKey: string
    • Optional locale: string

      The locale of the resource to fetch. Defaults to the current application locale.

    Returns string

initialize

  • initialize(config: any): void
  • Initialize the provider.

    Parameters

    • config: any

      The configuration object.

    Returns void