Interface SmiConnectionApi

This section of the API relates to information about the connection to the server.

interface SmiConnectionApi {
    getAuthHeader(): string | null;
    getPort(): number | "";
    getProtocol(): "http" | "https" | null;
    getServer(): string;
    isOnline(): boolean;
}

Index

Methods

getAuthHeader getPort getProtocol getServer isOnline

Methods

getAuthHeader

getAuthHeader(): string | null
A method to return the authentication header, or null if the token does not exist.

Returns string | null
Method

getPort

getPort(): number | ""
A method to return the stored port, or an empty string if a port is not being used.

Returns number | ""
Method

getProtocol

getProtocol(): "http" | "https" | null
A method to return the stored protocol, or null if the protocol does not exist.

Returns "http" | "https" | null
Method

getServer

getServer(): string
A method to return the stored server name, including the tenant. For example: http://acme.myserver.com

Returns string
Method

isOnline

isOnline(): boolean
Check if the app is connected to the server.

Returns boolean
Method