Jump to top

dynamic-links

interface

The Firebase Dynamic DynamicLinks service is available for the default app only.

Example 1

Get the links instance for the default app:

const links = firebase.dynamicLinks();

Methods

buildLink

</>

Builds a Dynamic Link from the provided DynamicLinkParameters instances.

buildLink(dynamicLinkParams: DynamicLinkParameters): Promise<string>;

buildShortLink

</>

Builds a short Dynamic Link from the provided DynamicLinkParameters interface.

buildShortLink(dynamicLinkParams: DynamicLinkParameters, shortLinkType?: ShortLinkType): Promise<string>;

getInitialLink

</>

Returns the Dynamic Link that the app has been launched from. If the app was not launched from a Dynamic Link the value will be null.

getInitialLink(): Promise<DynamicLink | null>;

onLink

</>

Subscribe to Dynamic Link open events while the app is still running.

onLink(listener: (link: DynamicLink) => void): () => void;

performDiagnostics

</>

Perform built-in diagnostics on iOS. This is best performed on a real device running a build from Xcode so you may see the output easily. Alternatively it should be visible in Console.app with an iPhone plugged into a macOS computer

performDiagnostics(): void;

resolveLink

</>

Resolve a given dynamic link (short or long) directly.

resolveLink(link: string): Promise<DynamicLink>;

Statics

ShortLinkType

</>

Returns the ShortLinkType enum.

dynamic-links.ShortLinkType: ;