mapsglmaps/com.xweather.mapsgl.weather/XweatherAuthenticator

XweatherAuthenticator

class XweatherAuthenticator(account: XweatherAccount, server: URL) : Authenticator, EventSource

Request authenticator used by WeatherService and source descriptors.

Builds signed headers / query params from account. Hosts typically use the instance on WeatherService.authenticator rather than constructing this type directly.

Parameters

account

Client credentials.

server

Token / API host (defaults to the MapsGL production server).

Constructors

XweatherAuthenticator

constructor(account: XweatherAccount, server: URL)

Properties

credentials

var credentials: AccessToken?

eventDispatcher

open override val eventDispatcher: EventDispatcher

headers

open override val headers: Map<String, String>

isSessionValid

val isSessionValid: Boolean

Functions

appendTileCredentialVariables

fun appendTileCredentialVariables(target: MutableMap<String, Any>)

Template variables merged into tile / metadata URLs by com.xweather.mapsgl.utils.replaceVars. Use {accessKey} (id + _ + secret), {clientId}, or {clientSecret} in URL strings when the source sets com.xweather.mapsgl.sources.source.spec.VectorSourceDescriptor.authenticator (or other descriptors that carry the same authenticator).

authenticate

open suspend override fun authenticate(): Map<String, String>

publisher

inline fun <EventType : Event> EventSource.publisher(eventType: Class<EventType>): Flow<EventType>

inline suspend fun <EventType : Event> EventSource.subscribe(eventType: Class<EventType>, crossinline handler: (EventType) -> Unit)

trigger

fun <EventType : Event> EventSource.trigger(event: EventType)