Class Index

Classes


Class com.zmags.api.Viewer.Context

If you are experiencing a problem and need to troubleshoot, please send an e-mail to support@zmags.com.

Class Summary
Constructor Attributes Constructor Name and Description
 
Enum class for contexts.
Field Summary
Field Attributes Field Name and Description
<static> <constant>  
com.zmags.api.Viewer.Context.CUSTOM_CHANNEL
The Custom channel.
<static> <constant>  
com.zmags.api.Viewer.Context.FACEBOOK
The Facebook context.
Class Detail
com.zmags.api.Viewer.Context()
Enum class for contexts.

Contexts are used to determine how the publication is presented, and how statistics are collected.

See:
com.zmags.api.Viewer#addContext
Field Detail
<static> <constant> com.zmags.api.Viewer.Context.CUSTOM_CHANNEL
The Custom channel.

Set this channel by calling addContext(com.zmags.api.Viewer.Context.CUSTOM_CHANNEL, "myCustomChannel")

This channel doesn't exclude adding additional contexts.

The custom channel must be defined prior to calling show() to load the viewer. Calling this function later has no effect.

Note: If the custom channel is not defined in the contextual viewers, the viewer will act as if no custom channel was set.

The custom channel name may only contain the following characters: a-z, A-Z, 0-9, _, -. The maximum length is 20 characters.

See:
com.zmags.api.Viewer#addContext

<static> <constant> com.zmags.api.Viewer.Context.FACEBOOK
The Facebook context.

Documentation generated by JsDoc Toolkit 2.3.2 on Mon Jun 19 2017 01:43:28 GMT-0000 (UTC)