launchMakePhotoShow

Use the launchMakePhotoShow JavaScript call to launch the authoring widget in a new browser window. See the authoring widget overview for more background.

var configOptions = {option: value, ...};
PhotoShow.widgets.launchMakePhotoShow(developerKey, configOptions);

developerKey

string, required

Your developer key.

configOptions

object, required

An associative array of additional parameters used to configure the authoring widget. Any of the parameters described below can be included in the configOptions object.

Post Callback Authentication

If set, these parameters are passed to your postShow callback function. You can use them to authenticate the post callback and make sure the new PhotoShow is added to the correct user's pages.

userId

string, optional

A unique user id (optional, but highly recommended). PhotoShow treats this as opaque and permanent. It will use it to group together shows created by the same user. PhotoShow will hand the userId back to you as part of the post callback.

Default: none

sessionKey

string, optional

A session key or similar authorization context. PhotoShow treats this as opaque and transient. PhotoShow will hand the sessionId back to you as part of the post callback.

Default: none

Viewer Customization

These settings don't affect the authoring widget itself. Instead, they control how the PhotoShow viewer will appear for the show the user creates.

viewerWidth

integer, optional

The desired width of the embedded PhotoShow Viewer widget, in pixels. You should specify at most one of viewerWidth or viewerHeight.

Default: 466

Minimum: 272

viewerHeight

integer, optional

The desired height of the embedded PhotoShow Viewer widget, in pixels. You should specify at most one of viewerWidth or viewerHeight. If both viewerWidth and viewerHeight settings are specified, viewerHeight will be ignored in order to preserve the standard PhotoShow Viewer aspect ratio.

Default: 375, or (viewerWidth * 3/4) + 25

Minimum: 229

Developer Setting Overrides

These parameters can be used to override, on a case by case basis, the default settings stored in your developer configuration.

postShow

string, optional

The absolute URL of a callback function on your server that will accept embed code for the PhotoShow. If postShow is not provided, your default callback function will be used. See the post callback section of the authoring widget guide for more details.

Default: none

getAlbumList

string, optional

The absolute URL of a callback function on your server that is used to obtain a list of the albums the currently logged in user can see. See getAlbumList for details.

Default: none

getAlbum

string, optional

The absolute URL of a callback function on your server that is used to obtain a list of the photos in a particular album. See getAlbum for details.

Default: none