firebase::dynamic_links

Firebase Dynamic Links API.

Summary

Firebase Dynamic Links is a cross-platform solution for generating and receiving links, whether or not the app is already installed.

Deprecated. Dynamic Links is now deprecated. Please see the support documentation at https://firebase.google.com/support/dynamic-links-faq for more information.

Enumerations
ErrorCode enum
Error code used by Futures returned by this API.
LinkMatchStrength{
  kLinkMatchStrengthNoMatch = 0,
  kLinkMatchStrengthWeakMatch,
  kLinkMatchStrengthStrongMatch,
  kLinkMatchStrengthPerfectMatch
} 		enum
Enum describing the strength of a dynamic links match.
PathLength{
  kPathLengthDefault = 0,
  kPathLengthShort,
  kPathLengthUnguessable
} 		enum
The desired path length for shortened Dynamic Link URLs.

Functions
Fetch()
void
Deprecated. Dynamic Links is now deprecated. Please see the support documentation at https://firebase.google.com/support/dynamic-links-faq for more information.
Fetch any pending dynamic links.
GetLongLink(const DynamicLinkComponents & components)
Creates a long Dynamic Link from the given parameters.
GetShortLink(const DynamicLinkComponents & components)
Creates a shortened Dynamic Link from the given parameters.
GetShortLink(const DynamicLinkComponents & components, const DynamicLinkOptions & options)
Creates a shortened Dynamic Link from the given parameters.
GetShortLink(const char *long_dynamic_link)
Creates a shortened Dynamic Link from a given long Dynamic Link.
GetShortLink(const char *long_dynamic_link, const DynamicLinkOptions & options)
Creates a shortened Dynamic Link from a given long Dynamic Link.
GetShortLinkLastResult()
Get the (possibly still pending) results of the most recent GetShortUrl call.
Initialize(const App & app, Listener *listener) Deprecated. Dynamic Links is now deprecated. Please see the support documentation at https://firebase.google.com/support/dynamic-links-faq for more information.
Initialize Firebase Dynamic Links.
SetListener(Listener *listener) Deprecated. Dynamic Links is now deprecated. Please see the support documentation at https://firebase.google.com/support/dynamic-links-faq for more information.
Set the listener for receiving Dynamic Links.
Terminate()
void
Deprecated. Dynamic Links is now deprecated. Please see the support documentation at https://firebase.google.com/support/dynamic-links-faq for more information.
Terminate Firebase Dynamic Links.

Classes
firebase::dynamic_links::Listener

Base class used to receive Dynamic Links.

Structs
firebase::dynamic_links::AndroidParameters

Android Parameters.

firebase::dynamic_links::DynamicLink

The received Dynamic Link.

firebase::dynamic_links::DynamicLinkComponents

The information needed to generate a Dynamic Link.

firebase::dynamic_links::DynamicLinkOptions

Additional options for Dynamic Link creation.

firebase::dynamic_links::GeneratedDynamicLink

The returned value from creating a Dynamic Link.

firebase::dynamic_links::GoogleAnalyticsParameters

Google Analytics Parameters.

firebase::dynamic_links::IOSParameters

iOS Parameters.

firebase::dynamic_links::ITunesConnectAnalyticsParameters

iTunes Connect App Analytics Parameters.

firebase::dynamic_links::SocialMetaTagParameters

Social meta-tag Parameters.

Enumerations

ErrorCode

 ErrorCode

Error code used by Futures returned by this API.

LinkMatchStrength

 LinkMatchStrength

Enum describing the strength of a dynamic links match.

This version is local to dynamic links; there is a similar enum in invites and another internal version in app.

Properties
kLinkMatchStrengthNoMatch

No match has been achieved.

kLinkMatchStrengthPerfectMatch

The match between the Dynamic Link and the device is exact.

You may safely reveal any personal information related to this Dynamic Link.

kLinkMatchStrengthStrongMatch

The match between the Dynamic Link and this device has a high confidence, but there is a small possibility of error.

kLinkMatchStrengthWeakMatch

The match between the Dynamic Link and device is not perfect.

You should not reveal any personal information related to the Dynamic Link.

PathLength

 PathLength

The desired path length for shortened Dynamic Link URLs.

Properties
kPathLengthDefault

Uses the server-default for the path length.

See https://goo.gl/8yDAqC for more information.

kPathLengthShort

Typical short link for non-sensitive links.

kPathLengthUnguessable

Short link that uses a very long path to make it more difficult to guess.

Useful for sensitive links.

Functions

Fetch

void Fetch()

Fetch any pending dynamic links.

Each pending link will trigger a call to the registered Listener class.

This function is implicitly called on initialization. On iOS this is called automatically when the app gains focus, but on Android this needs to be called manually.

Deprecated. Dynamic Links is now deprecated. Please see the support documentation at https://firebase.google.com/support/dynamic-links-faq for more information. 

GeneratedDynamicLink GetLongLink(
  const DynamicLinkComponents & components
)

Creates a long Dynamic Link from the given parameters. 

Future< GeneratedDynamicLink > GetShortLink(
  const DynamicLinkComponents & components
)

Creates a shortened Dynamic Link from the given parameters.

Details
Parameters
components
Settings used to configure the behavior for the link. 
Future< GeneratedDynamicLink > GetShortLink(
  const DynamicLinkComponents & components,
  const DynamicLinkOptions & options
)

Creates a shortened Dynamic Link from the given parameters.

Details
Parameters
components
Settings used to configure the behavior for the link.
options
Additional options for Dynamic Link shortening, indicating whether or not to produce an unguessable or shortest possible link. No references to the options object will be retained after the call. 
Future< GeneratedDynamicLink > GetShortLink(
  const char *long_dynamic_link
)

Creates a shortened Dynamic Link from a given long Dynamic Link.

Details
Parameters
long_dynamic_link
A link previously generated from GetLongLink. 
Future< GeneratedDynamicLink > GetShortLink(
  const char *long_dynamic_link,
  const DynamicLinkOptions & options
)

Creates a shortened Dynamic Link from a given long Dynamic Link.

Details
Parameters
long_dynamic_link
A link previously generated from GetLongLink.
options
Additional options for Dynamic Link shortening, indicating whether or not to produce an unguessable or shortest possible link. No references to the options object will be retained after the call.

GetShortLinkLastResult

Future< GeneratedDynamicLink > GetShortLinkLastResult()

Get the (possibly still pending) results of the most recent GetShortUrl call.

Initialize

InitResult Initialize(
  const App & app,
  Listener *listener
)

Initialize Firebase Dynamic Links.

After Initialize is called, the implementation may call functions on the Listener provided at any time.

Deprecated. Dynamic Links is now deprecated. Please see the support documentation at https://firebase.google.com/support/dynamic-links-faq for more information.

Details
Parameters
app
The Firebase App object for this application.
listener
A Listener object that receives Dynamic Links.
Returns
kInitResultSuccess if initialization succeeded, or kInitResultFailedMissingDependency on Android if Google Play services is not available on the current device.

SetListener

Listener * SetListener(
  Listener *listener
)

Set the listener for receiving Dynamic Links.

Deprecated. Dynamic Links is now deprecated. Please see the support documentation at https://firebase.google.com/support/dynamic-links-faq for more information.

Details
Parameters
listener
A Listener object that receives Dynamic Links.
Returns
Pointer to the previously set listener.

Terminate

void Terminate()

Terminate Firebase Dynamic Links.

Deprecated. Dynamic Links is now deprecated. Please see the support documentation at https://firebase.google.com/support/dynamic-links-faq for more information.