matrix-sdk-android/org.matrix.android.sdk.api.auth.data/SsoIdentityProvider

SsoIdentityProvider

@JsonClass(generateAdapter = true)

data class SsoIdentityProvider( @Json(name = "id") val id: String, @Json(name = "name") val name: String?, @Json(name = "icon") val iconUrl: String?, @Json(name = "brand") val brand: String?) : Parcelable, Comparable<SsoIdentityProvider>

Constructors

SsoIdentityProvider

fun SsoIdentityProvider( @Json(name = "id") id: String, @Json(name = "name") name: String?, @Json(name = "icon") iconUrl: String?, @Json(name = "brand") brand: String?)

Types

Companion

object Companion

Functions

compareTo

open operator override fun compareTo(other: SsoIdentityProvider): Int

describeContents

abstract fun describeContents(): Int

writeToParcel

abstract fun writeToParcel(p0: Parcel, p1: Int)

Properties

brand

val brand: String?

The brand field is optional. It allows the client to style the login button to suit a particular brand. It should be a string matching the "Common namespaced identifier grammar" as defined in MSC2758.

iconUrl

val iconUrl: String?

The icon field is the only optional field and should point to an icon representing the IdP. If present then it must be an HTTPS URL to an image resource. This should be hosted by the homeserver service provider to not leak the client's IP address unnecessarily.

val id: String

The id field would be opaque with the accepted characters matching unreserved URI characters as defined in RFC3986

name

val name: String?

The name field should be the human readable string intended for printing by the client.