| Package | com.distriqt.extension.firebase.dynamiclinks |
| Class | public final class FirebaseDynamicLinks |
| Inheritance | FirebaseDynamicLinks  flash.events.EventDispatcher |
| Implements | DynamicLinks |
This class represents the Firebase Dynamic Links extension.
| Property | Defined By | ||
|---|---|---|---|
| implementation : String [read-only]
The implementation currently in use. | FirebaseDynamicLinks | ||
| isSupported : Boolean [static] [read-only]
Whether the current device supports the extensions functionality
| FirebaseDynamicLinks | ||
| nativeVersion : String [read-only]
The native version string of the native extension. | FirebaseDynamicLinks | ||
| service : FirebaseDynamicLinks [static] [read-only]
The singleton instance of the DynamicLinks class. | FirebaseDynamicLinks | ||
| version : String [read-only]
The version of this extension. | FirebaseDynamicLinks | ||
| Method | Defined By | ||
|---|---|---|---|
Constructor
You should not call this directly, but instead use the singleton access
| FirebaseDynamicLinks | ||
addEventListener(type:String, listener:Function, useCapture:Boolean = false, priority:int = 0, useWeakReference:Boolean = false):void [override]
| FirebaseDynamicLinks | ||
createDynamicLink(linkDetails:Object):DynamicLink
Create a long dynamic link
| FirebaseDynamicLinks | ||
createShortDynamicLink(linkDetails:Object):Boolean
Create a dynamic link and shorten. | FirebaseDynamicLinks | ||
dispose():void
Disposes the extension and releases any allocated resources. | FirebaseDynamicLinks | ||
getDynamicLink(dynamicLinkUri:String, callback:Function = null):void
Attempts to decode the given dynamic link short url to extract the relevant information. | FirebaseDynamicLinks | ||
init(key:String):void Deprecated: You no longer need to call this function or use an application key [static]
Initialises the extension class for use with the provided key. | FirebaseDynamicLinks | ||
removeEventListener(type:String, listener:Function, useCapture:Boolean = false):void [override]
| FirebaseDynamicLinks | ||
| Event | Summary | Defined By | ||
|---|---|---|---|---|
| Dispatched after successful link creation and shortening | FirebaseDynamicLinks | |||
| FirebaseDynamicLinks | ||||
| Constant | Defined By | ||
|---|---|---|---|
| EXT_CONTEXT_ID : String = com.distriqt.firebase.DynamicLinks [static] | FirebaseDynamicLinks | ||
| VERSION : String = 10.1.0 [static] | FirebaseDynamicLinks | ||
| implementation | property |
implementation:String [read-only]
The implementation currently in use. This should be one of the following depending on the platform in use and the functionality supported by this extension:
AndroidiOSdefaultunknown public function get implementation():String| isSupported | property |
isSupported:Boolean [read-only] Whether the current device supports the extensions functionality
public static function get isSupported():Boolean| nativeVersion | property |
nativeVersion:String [read-only]
The native version string of the native extension.
public function get nativeVersion():String| service | property |
service:FirebaseDynamicLinks [read-only] The singleton instance of the DynamicLinks class.
public static function get service():FirebaseDynamicLinksError — If there was a problem creating or accessing the extension, or if the key is invalid
|
| version | property |
version:String [read-only]
The version of this extension.
This should be of the format, MAJOR.MINOR.BUILD
public function get version():String| FirebaseDynamicLinks | () | Constructor |
public function FirebaseDynamicLinks()Constructor You should not call this directly, but instead use the singleton access
| addEventListener | () | method |
override public function addEventListener(type:String, listener:Function, useCapture:Boolean = false, priority:int = 0, useWeakReference:Boolean = false):void
Parameters
type:String | |
listener:Function | |
useCapture:Boolean (default = false) | |
priority:int (default = 0) | |
useWeakReference:Boolean (default = false) |
| createDynamicLink | () | method |
public function createDynamicLink(linkDetails:Object):DynamicLinkCreate a long dynamic link
Parameters
linkDetails:Object — Details for this dynamic link. This should be generated using the DynamicLinkBuilder class
|
DynamicLink — The dynamic link as an instance of the DynamicLink class
|
| createShortDynamicLink | () | method |
public function createShortDynamicLink(linkDetails:Object):BooleanCreate 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
|
Boolean — true if the link shortening started successfully and false if there was an error (check the extension is initialised correctly).
|
| dispose | () | method |
public function dispose():void
Disposes the extension and releases any allocated resources. Once this function
has been called, a call to init is neccesary again before any of the
extensions functionality will work.
| getDynamicLink | () | method |
public function getDynamicLink(dynamicLinkUri:String, callback:Function = null):void
Attempts to decode the given dynamic link short url to extract the relevant information.
This will do two things on completion:
- dispatch a DynamicLinkEvent.GET_DYNAMIC_LINK with the decoded data
- attempt to call your callback function.
Parameters
dynamicLinkUri:String — The dynamic link url to decode
| |
callback:Function (default = null)function( link:PendingDynamicLinkData ):void which will be called when the task completes
|
| init | () | method |
public static function init(key:String):voidInitialises the extension class for use with the provided key.
Parameters
key:String |
Error — If there was a problem creating or accessing the extension, or if the key is invalid
|
| removeEventListener | () | method |
override public function removeEventListener(type:String, listener:Function, useCapture:Boolean = false):void
Parameters
type:String | |
listener:Function | |
useCapture:Boolean (default = false) |
| dynamiclink:created | Event |
com.distriqt.extension.firebase.dynamiclinks.events.ShortDynamicLinkEventcom.distriqt.extension.firebase.dynamiclinks.events.ShortDynamicLinkEvent.LINK_CREATEDDispatched after successful link creation and shortening
| dynamiclink:error | Event |
com.distriqt.extension.firebase.dynamiclinks.events.ShortDynamicLinkEventcom.distriqt.extension.firebase.dynamiclinks.events.ShortDynamicLinkEvent.DYNAMIC_LINK_ERROR
| EXT_CONTEXT_ID | Constant |
public static const EXT_CONTEXT_ID:String = com.distriqt.firebase.DynamicLinks| VERSION | Constant |
public static const VERSION:String = 10.1.0