AFCore/com.advantahealth.api/AFRealm

AFRealm

The Advanta Mobile API platform (realm) your app's members belong to.

Set via AFCoreConfig.Builder.realm. The SDK sends it on every request as the X-Advanta-Realm header so the AIDE Gateway routes the member to the platform that owns their account. This matters most for login and token refresh, which run before the Gateway has a signed token to read the realm from.

The member's access token also carries the realm it was issued for. The Gateway rejects a request whose header disagrees with that token, so the realm configured here must match the platform the app authenticates against.

When no realm is configured the header is omitted and the Gateway routes to BISMUTH, which preserves the behavior of integrations built before this setting existed.

Entries

BISMUTH

The Bismuth platform (BIS). The Gateway's default when no realm is sent.

HORIZON

The Horizon platform (HRZ).

Properties

entries

val entries: EnumEntries<AFRealm>

Returns a representation of an immutable list of all enum entries, in the order they're declared.

name

expect val name: String

ordinal

expect val ordinal: Int

Functions

valueOf

fun valueOf(value: String): AFRealm

Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)

values

fun values(): Array<AFRealm>

Returns an array containing the constants of this enum type, in the order they're declared.