dispatcher - activitystream/asa.js GitHub Wiki

@activitystream/asa > dispatcher

Module: dispatcher

Interfaces

Local events


Local events

<Const> local

local: object

Defined in dispatcher.ts:92

connected.partners.provided

Used to provide asa.js with a list of domains for which automatic tracking should be enabled. If not set, automatic tracking will be disabled.

asa("connected.partners.provided", ["partner1.com", "partner2.com", ...])

● connected.partners.provided: track = track

Defined in dispatcher.ts:96


custom.session.created

● custom.session.created: customSession = customSession

Defined in dispatcher.ts:95


debug.mode.enabled

● debug.mode.enabled: mode = logger.mode

Defined in dispatcher.ts:99


metadata.transformer.provided

Used to provide asa.js with a custom transformer for metadata. If set, it will be called with (metadata, [element?]) of each event created, and the returned value will be sent as meta.

asa("metadata.transformer.provided", function(metadata, element?) {
    metadata.additionalProperty = 'additionalValue';
    delete metadata.existingProperty1
    metadata.existingProperty2 = metadata.existingProperty2 === 'value0' ? 'value2' : 'value1'

    return metadata
})

● metadata.transformer.provided: setMapper = metadata.setMapper

Defined in dispatcher.ts:100


service.providers.provided

Used to provide asa.js with a list of service provider domains, which are not to be considered referrers and will not affect campaign data.

asa("service.providers.provided", ["http://payment-provider.com", "http://login-provider.com", ...])

● service.providers.provided: any = Dispatcher.prototype.setProviders

Defined in dispatcher.ts:97


tenant.id.provided

Used to provide asa.js with tenant ID.

asa("tenant.id.provided", "XX-XXXXXXXXX-X")

● tenant.id.provided: any = Dispatcher.prototype.setTenant

Defined in dispatcher.ts:98



⚠️ **GitHub.com Fallback** ⚠️