Wix openapi-node

Class: WixActivity

WixActivity

new WixActivity()

Represents a new Activity in the Wix ecosystem, allowing for easy construction and creation

Source:
  • WixClient.js

Mixes In

Members

contactUpdate :Object

Updates to the existing contact that performed this activity. The structure of this object should match the schema for Contact, with the relevant fields updated.

Type:
  • Object
Source:
  • WixClient.js

Methods

post(sessionToken, wix) → {Promise.<string, error>}

Posts the Activity to Wix. Returns a Promise for an id

Parameters:
Name Type Description
sessionToken string

The current session token for the active Wix site visitor
wix Wix

A Wix API object
Source:
  • WixClient.js
Returns:

A new id, or an error

Type
Promise.<string, error>

withActivityDetails(summary, additionalInfoUrl) → {WixActivity}

Configures the details of this Activity

Parameters:
Name Type Description
summary string

A summary of this Activity
additionalInfoUrl string

a link to additional information about this Activity
Source:
  • WixClient.js
Returns:
Type
WixActivity

withActivityType(type) → {WixActivity}

Configures this Activity with a given type

Parameters:
Name Type Description
type ActivityType

the type of the Activity to create
Source:
  • WixClient.js
Returns:
Type
WixActivity

withLocationUrl(url) → {WixActivity}

Configures the activityLocationUrl of this Activity

Parameters:
Name Type Description
url string

The URL of the Activities location
Source:
  • WixClient.js
Returns:
Type
WixActivity