HtmlServerInfo
Overview
Static class that provides helper methods for general server information page creation:
Location
- Reference: RemObjects.SDK.Server.dll
- Namespace: RemObjects.SDK.Server
- Platforms: .NET Core, .NET Framework, .NET Standard
constructor
constructor
HtmlServerInfo()
init()
Sub New()
Channel
property Channel: HttpServerChannel read write;
HttpServerChannel Channel { get; set; }
var Channel: HttpServerChannel { get{} set{} }
Property Channel() As HttpServerChannel
GetAppleTouchIconStream
method GetAppleTouchIconStream: Stream
Stream GetAppleTouchIconStream()
func GetAppleTouchIconStream() -> Stream
Function GetAppleTouchIconStream() As Stream
GetDispatchersList
Returns a string containing HTML for a list of available message dispatchers.
class method GetDispatchersList(basePath: String; dispatchers: MessageDispatchers): String
static String GetDispatchersList(String basePath, MessageDispatchers dispatchers)
static func GetDispatchersList(_ basePath: String, _ dispatchers: MessageDispatchers) -> String
Shared Function GetDispatchersList(basePath As String, dispatchers As MessageDispatchers) As String
Parameters:
- basePath:
- dispatchers:
GetFavIconStream
method GetFavIconStream: Stream
Stream GetFavIconStream()
func GetFavIconStream() -> Stream
Function GetFavIconStream() As Stream
GetHtmlErrorResponse (Int32, String): String
class method GetHtmlErrorResponse(code: Int32; message: String): String
static String GetHtmlErrorResponse(Int32 code, String message)
static func GetHtmlErrorResponse(_ code: Int32, _ message: String) -> String
Shared Function GetHtmlErrorResponse(code As Int32, message As String) As String
Parameters:
- code:
- message:
GetHtmlErrorResponse (Exception): String
Returns a string containing HTML for 'Server Error' pages, for given exceptions.
class method GetHtmlErrorResponse(ex: Exception): String
static String GetHtmlErrorResponse(Exception ex)
static func GetHtmlErrorResponse(_ ex: Exception) -> String
Shared Function GetHtmlErrorResponse(ex As Exception) As String
Parameters:
- ex:
GetHtmlResponse
This method returns a HTML page based on the HtmlResponseTemplate with a given title and body.
class method GetHtmlResponse(title: String; body: String): String
static String GetHtmlResponse(String title, String body)
static func GetHtmlResponse(_ title: String, _ body: String) -> String
Shared Function GetHtmlResponse(title As String, body As String) As String
Parameters:
- title:
- body:
GetServerDocumentation
class method GetServerDocumentation(rodlAssembly: Assembly; serviceGroup: String := nil): String
static String GetServerDocumentation(Assembly rodlAssembly, String serviceGroup = null)
static func GetServerDocumentation(_ rodlAssembly: Assembly, _ serviceGroup: String = nil) -> String
Shared Function GetServerDocumentation(rodlAssembly As Assembly, serviceGroup As String = Nothing) As String
Parameters:
- rodlAssembly:
- serviceGroup:
GetServerInfo (Assembly, MessageDispatchers, ExtendedDispatcherList, Boolean, String): String
method GetServerInfo(rodlAssembly: Assembly; dispatchers: MessageDispatchers; extendedDispatchers: ExtendedDispatcherList; addTrialNotification: Boolean; basePath: String): String
String GetServerInfo(Assembly rodlAssembly, MessageDispatchers dispatchers, ExtendedDispatcherList extendedDispatchers, Boolean addTrialNotification, String basePath)
func GetServerInfo(_ rodlAssembly: Assembly, _ dispatchers: MessageDispatchers, _ extendedDispatchers: ExtendedDispatcherList, _ addTrialNotification: Boolean, _ basePath: String) -> String
Function GetServerInfo(rodlAssembly As Assembly, dispatchers As MessageDispatchers, extendedDispatchers As ExtendedDispatcherList, addTrialNotification As Boolean, basePath As String) As String
Parameters:
- rodlAssembly:
- dispatchers:
- extendedDispatchers:
- addTrialNotification:
- basePath:
GetServerInfo (Assembly, MessageDispatchers, ExtendedDispatcherList, Boolean, String, String): String
method GetServerInfo(rodlAssembly: Assembly; dispatchers: MessageDispatchers; extendedDispatchers: ExtendedDispatcherList; addTrialNotification: Boolean; basePath: String; template: String): String
String GetServerInfo(Assembly rodlAssembly, MessageDispatchers dispatchers, ExtendedDispatcherList extendedDispatchers, Boolean addTrialNotification, String basePath, String template)
func GetServerInfo(_ rodlAssembly: Assembly, _ dispatchers: MessageDispatchers, _ extendedDispatchers: ExtendedDispatcherList, _ addTrialNotification: Boolean, _ basePath: String, _ template: String) -> String
Function GetServerInfo(rodlAssembly As Assembly, dispatchers As MessageDispatchers, extendedDispatchers As ExtendedDispatcherList, addTrialNotification As Boolean, basePath As String, template As String) As String
Parameters:
- rodlAssembly:
- dispatchers:
- extendedDispatchers:
- addTrialNotification:
- basePath:
- template:
Channel
property Channel: HttpServerChannel read write;
HttpServerChannel Channel { get; set; }
var Channel: HttpServerChannel { get{} set{} }
Property Channel() As HttpServerChannel
GetDispatchersList
Returns a string containing HTML for a list of available message dispatchers.
class method GetDispatchersList(basePath: String; dispatchers: MessageDispatchers): String
static String GetDispatchersList(String basePath, MessageDispatchers dispatchers)
static func GetDispatchersList(_ basePath: String, _ dispatchers: MessageDispatchers) -> String
Shared Function GetDispatchersList(basePath As String, dispatchers As MessageDispatchers) As String
Parameters:
- basePath:
- dispatchers:
GetHtmlErrorResponse (Int32, String): String
class method GetHtmlErrorResponse(code: Int32; message: String): String
static String GetHtmlErrorResponse(Int32 code, String message)
static func GetHtmlErrorResponse(_ code: Int32, _ message: String) -> String
Shared Function GetHtmlErrorResponse(code As Int32, message As String) As String
Parameters:
- code:
- message:
GetHtmlErrorResponse (Exception): String
Returns a string containing HTML for 'Server Error' pages, for given exceptions.
class method GetHtmlErrorResponse(ex: Exception): String
static String GetHtmlErrorResponse(Exception ex)
static func GetHtmlErrorResponse(_ ex: Exception) -> String
Shared Function GetHtmlErrorResponse(ex As Exception) As String
Parameters:
- ex:
GetHtmlResponse
This method returns a HTML page based on the HtmlResponseTemplate with a given title and body.
class method GetHtmlResponse(title: String; body: String): String
static String GetHtmlResponse(String title, String body)
static func GetHtmlResponse(_ title: String, _ body: String) -> String
Shared Function GetHtmlResponse(title As String, body As String) As String
Parameters:
- title:
- body:
GetServerDocumentation
class method GetServerDocumentation(rodlAssembly: Assembly; serviceGroup: String := nil): String
static String GetServerDocumentation(Assembly rodlAssembly, String serviceGroup = null)
static func GetServerDocumentation(_ rodlAssembly: Assembly, _ serviceGroup: String = nil) -> String
Shared Function GetServerDocumentation(rodlAssembly As Assembly, serviceGroup As String = Nothing) As String
Parameters:
- rodlAssembly:
- serviceGroup:
constructor
constructor
HtmlServerInfo()
init()
Sub New()
GetAppleTouchIconStream
method GetAppleTouchIconStream: Stream
Stream GetAppleTouchIconStream()
func GetAppleTouchIconStream() -> Stream
Function GetAppleTouchIconStream() As Stream
GetFavIconStream
method GetFavIconStream: Stream
Stream GetFavIconStream()
func GetFavIconStream() -> Stream
Function GetFavIconStream() As Stream
GetServerInfo (Assembly, MessageDispatchers, ExtendedDispatcherList, Boolean, String): String
method GetServerInfo(rodlAssembly: Assembly; dispatchers: MessageDispatchers; extendedDispatchers: ExtendedDispatcherList; addTrialNotification: Boolean; basePath: String): String
String GetServerInfo(Assembly rodlAssembly, MessageDispatchers dispatchers, ExtendedDispatcherList extendedDispatchers, Boolean addTrialNotification, String basePath)
func GetServerInfo(_ rodlAssembly: Assembly, _ dispatchers: MessageDispatchers, _ extendedDispatchers: ExtendedDispatcherList, _ addTrialNotification: Boolean, _ basePath: String) -> String
Function GetServerInfo(rodlAssembly As Assembly, dispatchers As MessageDispatchers, extendedDispatchers As ExtendedDispatcherList, addTrialNotification As Boolean, basePath As String) As String
Parameters:
- rodlAssembly:
- dispatchers:
- extendedDispatchers:
- addTrialNotification:
- basePath:
GetServerInfo (Assembly, MessageDispatchers, ExtendedDispatcherList, Boolean, String, String): String
method GetServerInfo(rodlAssembly: Assembly; dispatchers: MessageDispatchers; extendedDispatchers: ExtendedDispatcherList; addTrialNotification: Boolean; basePath: String; template: String): String
String GetServerInfo(Assembly rodlAssembly, MessageDispatchers dispatchers, ExtendedDispatcherList extendedDispatchers, Boolean addTrialNotification, String basePath, String template)
func GetServerInfo(_ rodlAssembly: Assembly, _ dispatchers: MessageDispatchers, _ extendedDispatchers: ExtendedDispatcherList, _ addTrialNotification: Boolean, _ basePath: String, _ template: String) -> String
Function GetServerInfo(rodlAssembly As Assembly, dispatchers As MessageDispatchers, extendedDispatchers As ExtendedDispatcherList, addTrialNotification As Boolean, basePath As String, template As String) As String
Parameters:
- rodlAssembly:
- dispatchers:
- extendedDispatchers:
- addTrialNotification:
- basePath:
- template: