Scene 7 Plugin/Documentation

From 360Works Product Documentation Wiki
Jump to: navigation, search

Contents

Scene 7 Plugin User Guide

Created by sterling on 3/16/15.


360Works Plugin Setup Guides

See Plugins_101 for Error reporting, installation, registration, and more.

Function Summary

Function Detail

Scene7GetCompanyInfo

Scene7LastError

Returns the text of the last error triggered by a plugin function. This should be called immediately after a plugin function returns "ERROR" to get a description of the error.

Returns: Error text, or "" if there was no error.

Scene7LicenseInfo

Returns information about the license used.

Returns: The type of license the plugin is registered under.

Scene7Register ( licenseKey ; registeredTo )

Registers the Scene7 Plugin.

Parameters:

licenseKey
a valid license key string, or the literal string "DEMO" to run in demo mode.
registeredTo
the company name for the license key used.

Returns: 1 on success, or "ERROR" on failure.

Scene7SetAuthCredentials ( username ; password ; appName ; appVersion )

Parameters:


Scene7SetErrorCapture ( errorCapture )

Toggles error dialogs on or off. When something unexpected happens, the plug-in will pop up a dialog displaying the error message. This makes it easy to see what went wrong. However, in some cases, you (the developer) may prefer to show your own message to the user, or possibly not show a message at all. In that case, you can call EmailSetErrorCapture with a parameter of true. That will suppress the error dialog from appearing to the user.

Parameters:

errorCapture
set to true to suppress the default popups.


Scene7Version

Returns the version of the plugin that is installed.

Returns: a decimal version number.
Personal tools
Namespaces

Variants
Actions
Plug-in Products
Other Products
Navigation
Toolbox