SAS(R) SDK for Android/com.sas.android.visualanalytics.sdk.model/Server

Server

class Server : ConnectionWrapper

Describes a connection to a SAS Visual Analytics server.

Since

8.30

Types

sealed class Result

Describes the result of a report subscribe operation.

Properties

allowsGuestMode

open override val allowsGuestMode: Boolean

Indicates whether the server allows guest mode (true) or not (not true).

open override val description: String?

An optional description of the connection.

open override val esriEnabled: Boolean

open override var esriPassword: String?

Fetched asynchronously with fetchEsriCreds.

open override val esriSupported: Boolean

open override var esriUserId: String?

Fetched asynchronously with fetchEsriCreds.

open override val hostName: String

The host name or IP address of the server.

open override val password: String?

The password to use when creating the connection, or null if the connection uses guest mode or has already been created.

open override val port: Int

The port used in the connection.

subscribedReports

val subscribedReports: List<Report>

All subscribed reports on this server.

open override val useGuestMode: Boolean

Indicates whether the connection uses guest mode (true) or a userId/password (not true).

open override var userAvatar: String?

Fetched asynchronously with fetchUserAvatar.

userDisplayName

open override val userDisplayName: String?

open override val userId: String?

The user ID to use when creating the connection, or null if the connection uses guest mode.

open override val useSsl: Boolean

Indicates whether the connection uses HTTPS (true) or HTTP (not true).

open override val useStdAuth: Boolean

Whether to use standard (user ID/password) authentication instead of web authentication even if the latter is supported by this connection. This may require special configuration on the server.

val uuid: String?

Functions

suspend fun fetchEsriCreds(timeout: Duration? = null): Boolean

Populate esriUserId and esriPassword.

fetchUserAvatar

suspend fun fetchUserAvatar(timeout: Duration? = null): Boolean

Populate userAvatar.

fun subscribe(descriptors: List<ReportDescriptor>, updateIfSubscribed: Boolean, onSubscribeComplete: (Server.Result) -> Unit? = null)

Subscribe to the given reports.

fun unsubscribe(report: Report)

Unsubscribe from the given report.