Interface Page
-
- All Superinterfaces:
AuditingContext,LoggingContext,PerspectiveElement,PropertyTreeOwner
- All Known Implementing Classes:
DesignerPageModel,PageModel
public interface Page extends PerspectiveElement
-
-
Method Summary
All 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.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 Detail
-
getId
java.lang.String getId()
-
getCreated
long getCreated()
-
getViews
java.util.List<ViewModel> getViews()
-
send
void 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
-
getPageEventManager
EventManager getPageEventManager()
-
isConnected
boolean isConnected()
-
close
void close(@Nullable java.lang.String message)
-
newAuthChallenge
void 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- theAuthChallengeRequest- 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
-
-