Interface IGenericPromaApi
-
public interface IGenericPromaApi
API for basic interactions via PROMA (product manager).- Author:
- XIMA MEDIA GmbH
-
-
Method Summary
All Methods Instance Methods Abstract Methods Modifier and Type Method Description <R> StageChain<Boolean,R>
isHasWebsocketConnection(IPublicPromaInvocationContext pc)
This method checks if the browser(client) has a active web socket connection.<R> StageChain<Boolean,R>
isPromaAvailable(IPublicPromaInvocationContext pc)
This method pings the PROMA rest API and checks if it is available.
-
-
-
Method Detail
-
isPromaAvailable
<R> StageChain<Boolean,R> isPromaAvailable(IPublicPromaInvocationContext pc)
This method pings the PROMA rest API and checks if it is available.- Parameters:
pc
- Context for accessing the PROMA APIs.- Returns:
- true when the status code after pinging the PROMA rest API is 200 otherwise it returns false
-
isHasWebsocketConnection
<R> StageChain<Boolean,R> isHasWebsocketConnection(IPublicPromaInvocationContext pc)
This method checks if the browser(client) has a active web socket connection.- Parameters:
pc
- Context for accessing the PROMA APIs. This should be aIPublicAsyncWebSocketContext
.- Returns:
- Returns true if the http request with web socket client has a status code of 200. False when there is a
NoActiveWebSocketSessionException
is thrown.
-
-