Interface Page
- 
- All Superinterfaces:
- AuditingContext,- LoggingContext,- PerspectiveElement,- PropertyTreeOwner
 - All Known Implementing Classes:
- DesignerPageModel,- PageModel
 
 public interface Page extends PerspectiveElement 
- 
- 
Method SummaryAll Methods Instance Methods Abstract Methods Deprecated Methods Modifier and Type Method Description voidclose(java.lang.String message)longgetCreated()java.lang.StringgetId()com.google.common.eventbus.EventBusgetPageEventBus()Deprecated.Replaced bygetPageEventManager().EventManagergetPageEventManager()java.util.List<ViewModel>getViews()booleanisConnected()voidnewAuthChallenge(AuthChallengeRequest authChallengeRequest)Trigger a new authentication challenge.voidsend(java.lang.String protocol, java.lang.String payload)- 
Methods inherited from interface com.inductiveautomation.perspective.gateway.api.AuditingContextaudit, getAuditSnapshot
 - 
Methods inherited from interface com.inductiveautomation.perspective.gateway.api.LoggingContextgetLogger, getMdcParent, mdc, mdcSetup, mdcSetupTree, mdcTeardown, mdcTeardownTree, mdcWrap
 - 
Methods inherited from interface com.inductiveautomation.perspective.gateway.api.PerspectiveElementcreatePropertyReference, getAuditProfile, getName, getPage, getQualifiedPath, getSession, getView, isRunning
 - 
Methods inherited from interface com.inductiveautomation.perspective.gateway.api.PropertyTreeOwnergetPropertyTreeOf
 
- 
 
- 
- 
- 
Method Detail- 
getIdjava.lang.String getId() 
 - 
getCreatedlong getCreated() 
 - 
getViewsjava.util.List<ViewModel> getViews() 
 - 
sendvoid send(java.lang.String protocol, java.lang.String payload) throws java.io.IOException- Throws:
- java.io.IOException
 
 - 
getPageEventBus@Deprecated com.google.common.eventbus.EventBus getPageEventBus() Deprecated.Replaced bygetPageEventManager(). Will be removed in 8.2.0
 - 
getPageEventManagerEventManager getPageEventManager() 
 - 
isConnectedboolean isConnected() 
 - 
closevoid close(@Nullable java.lang.String message)
 - 
newAuthChallengevoid newAuthChallenge(AuthChallengeRequest authChallengeRequest) throws java.lang.Exception Trigger a new authentication challenge. Sends a message to the client to open the authentication challenge workflow using whatever framing option was specified in the auth challenge request.- Parameters:
- authChallengeRequest- the- AuthChallengeRequest
- Throws:
- java.lang.Exception- if the client identifier associated with the auth challenge request is blank, or if the message channel between the Gateway and the Client is not currently open
 
 
- 
 
-