JavaScriptAPI reference
Links
Links in the JavaScript SDK.
// access
nexus.links| Symbol | Kind | Summary |
|---|---|---|
AttributeOptions | interface | |
NexusLinks | class | Deep linking & attribution (OneLink-style). |
AttributeOptions
interfacetype
propertytype?: stringclickId
propertyclickId?: stringname
propertyname?: stringplatform
propertyplatform?: stringproperties
propertyproperties?: Record<string, unknown>NexusLinks
classDeep linking & attribution (OneLink-style).
NexusLinks
constructornew NexusLinks(http: NexusHttp, id: NexusIdentity)Parameters
Prop
Type
Returns NexusLinks
attribute()
methodasync attribute(options: AttributeOptions = {}): Promise<Record<string, unknown> | null>Report a conversion; returns the matched link's deep-link data (or null).
Parameters
Prop
Type
Returns Promise<Record<string, unknown> | null>
handleCurrentUrl()
methodasync handleCurrentUrl(type: string = 'open'): Promise<Record<string, unknown> | null>Parse the current URL (browser) for link_click_id and attribute an open.
Parameters
Prop
Type
Returns Promise<Record<string, unknown> | null>
