Packagecom.distriqt.extension.firebase.dynamiclinks
Interfacepublic interface DynamicLinks extends flash.events.IEventDispatcher
Implementors FirebaseDynamicLinks

This interface defines the Firebase Dynamic Links functionality



Public Methods
 MethodDefined By
  
createDynamicLink(linkDetails:Object):DynamicLink
Create a long dynamic link
DynamicLinks
  
createShortDynamicLink(linkDetails:Object):Boolean
Create a dynamic link and shorten.
DynamicLinks
Events
 Event Summary Defined By
   Dispatched after successful link creation and shortening DynamicLinks
  DynamicLinks
Method Detail
createDynamicLink()method
public function createDynamicLink(linkDetails:Object):DynamicLink

Create a long dynamic link

Parameters

linkDetails:Object — Details for this dynamic link. This should be generated using the DynamicLinkBuilder class

Returns
DynamicLink — The dynamic link as an instance of the DynamicLink class

See also


Example
         var link:DynamicLink = FirebaseDynamicLinks.service.createDynamicLink(
              new DynamicLinkBuilder()
                      .setLink( "https://example.com/" )
                      .setDynamicLinkDomain( "XXXXX.app.goo.gl" )
                      .setAndroidParameters( new AndroidParametersBuilder( "air.com.distriqt.test" ).build() )
                      .setIosParameters( new IosParametersBuilder( "com.distriqt.test" ).build() )
                      .build()
         );
         
createShortDynamicLink()method 
public function createShortDynamicLink(linkDetails:Object):Boolean

Create a dynamic link and shorten. This call is asynchronous and will dispatch an event when complete.

Parameters

linkDetails:Object — Details for this dynamic link. This should be generated using the DynamicLinkBuilder class

Returns
Booleantrue if the link shortening started successfully and false if there was an error (check the extension is initialised correctly).

Example
         FirebaseDynamicLinks.service.createShortDynamicLink(
              new DynamicLinkBuilder()
                      .setLink( "https://example.com/" )
                      .setDynamicLinkDomain( "XXXXX.app.goo.gl" )
                      .setAndroidParameters( new AndroidParametersBuilder( "air.com.distriqt.test" ).build() )
                      .setIosParameters( new IosParametersBuilder( "com.distriqt.test" ).build() )
                      .build()
         );
         
Event Detail
dynamiclink:created Event
Event Object Type: com.distriqt.extension.firebase.dynamiclinks.events.ShortDynamicLinkEvent
ShortDynamicLinkEvent.type property = com.distriqt.extension.firebase.dynamiclinks.events.ShortDynamicLinkEvent.LINK_CREATED

Dispatched after successful link creation and shortening
dynamiclink:error Event  
Event Object Type: com.distriqt.extension.firebase.dynamiclinks.events.ShortDynamicLinkEvent
ShortDynamicLinkEvent.type property = com.distriqt.extension.firebase.dynamiclinks.events.ShortDynamicLinkEvent.DYNAMIC_LINK_ERROR