InvergeDocs
JavaScriptAPI reference

Links

Links in the JavaScript SDK.

// access
nexus.links
SymbolKindSummary
AttributeOptionsinterface
NexusLinksclassDeep linking & attribution (OneLink-style).

AttributeOptions

interface

type

property
type?: string

clickId

property
clickId?: string

name

property
name?: string

platform

property
platform?: string

properties

property
properties?: Record<string, unknown>
class

Deep linking & attribution (OneLink-style).

constructor
new NexusLinks(http: NexusHttp, id: NexusIdentity)

Parameters

Prop

Type

Returns NexusLinks

View source

attribute()

method
async 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>

View source

handleCurrentUrl()

method
async 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>

View source

On this page