Class: class_1()
This Class provides all of the information about an "access method" that may be needed to link to a native or web deepstate.
syntax AccessMethod(accessUrl, packageName, action, category, component, editions, extra, method)
| Parameter | Type | Description |
|---|---|---|
accessUrl |
String | A native or web link to access the deepstate. |
packageName |
String | Unique identifier for Android apps, for example: "com.yelp.android". |
action |
String | Android specific. Should default to 'android.intent.action.VIEW' on Chrome. |
category |
String | Android specific. Supported in Chrome Intent URIs. |
component |
String | Android specific. Supported in Chrome Intent URIs. |
editions |
Array | Example defined. Our Example-defined structure of an app 'edition'. |
extra |
Array | Android specific. Not currently supported in Chrome Intent URIs but could be later. |
method |
String | Example defined. Tells us how we should launch the deeplink. For example, launchIntentViaJSON means we should use Intent params but not AccessUrl if Chrome. |
| Source: models/model_1.js, line 23 | ||
Method: (static) fromStateAccessInfoObject()
Creates an AccessMethod from one of the objects in the 'accessMethods' array returned by the Example API. The API response includes 'jar' which is only relevant to the Example Android SDK.
syntax (static) fromStateAccessInfoObject(stateAccessInfoObj)
| Parameter | Type | Description |
|---|---|---|
stateAccessInfoObj |
Object | The API object representing this AccessMethod. |
| Source: Model 1, line 39 | ||
Method: selectAccessMethod()
Specifies which access method we should use, or null if there are no access methods this client can use.
syntax (static) selectAccessMethod(client, accessMethods)
| Parameter | Type | Description |
|---|---|---|
client |
Object | This is the client object created by redirector.detectClient. |
accessMethods |
Array | This is an array of accessMethods instances. |
| Source: Model 1, line 74 | ||
Method: isApplicable()
Specifies whether this client (given the information we parsed out of their user agent) can apply a given access method.
syntax isApplicable(client)
| Parameter | Type | Description |
|---|---|---|
client |
Object | This is the client object created by redirector.detectClient. |
| Source: Model 1, line 50 | ||