Page

All Superinterfaces:: AuditingContext, LoggingContext, PerspectiveElement, PropertyTreeOwner

All Known Implementing Classes:: DesignerPageModel, PageModel

public interface Page extends PerspectiveElement

Method Summary

Modifier and Type

Method

Description

void

close(String message)

long

getCreated()

String

getId()

com.google.common.eventbus.EventBus

getPageEventBus()

Deprecated.
Replaced by getPageEventManager().

EventManager

getPageEventManager()

List<ViewModel>

getViews()

boolean

isConnected()

void

newAuthChallenge(AuthChallengeRequest authChallengeRequest)

Trigger a new authentication challenge.

void

send(String protocol, String payload)

Methods inherited from interface com.inductiveautomation.perspective.gateway.api.AuditingContext
audit, getAuditSnapshot

Methods inherited from interface com.inductiveautomation.perspective.gateway.api.LoggingContext
getLogger, getMdcParent, mdc, mdcSetup, mdcSetupTree, mdcTeardown, mdcTeardownTree, mdcWrap

Methods inherited from interface com.inductiveautomation.perspective.gateway.api.PerspectiveElement
createPropertyReference, getAuditProfile, getName, getPage, getQualifiedPath, getSession, getView, isRunning

Methods inherited from interface com.inductiveautomation.perspective.gateway.api.PropertyTreeOwner
getPropertyTreeOf

Method Details
- getId
  
  String getId()
- getCreated
  
  long getCreated()
- getViews
  
  List<ViewModel> getViews()
- send
  
  void send(String protocol, String payload) throws IOException
  
  Throws:
  
  IOException
- getPageEventBus
  
  @Deprecated com.google.common.eventbus.EventBus getPageEventBus()
  
  Deprecated.
  Replaced by getPageEventManager(). Will be removed in 8.2.0
- getPageEventManager
  
  EventManager getPageEventManager()
- isConnected
  
  boolean isConnected()
- close
  
  void close(@Nullable String message)
- newAuthChallenge
  
  void newAuthChallenge(AuthChallengeRequest authChallengeRequest) throws 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:
  
  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