IMPORTANT: In July 2025, we stopped releasing new versions of KTX modules, and we removed the KTX libraries from the Firebase Android BoM (v34.0.0). If you use KTX APIs from the previously released KTX modules, we recommend that you migrate your app to use KTX APIs from the main modules instead. For details, see the FAQ about this initiative.

UrlRetrievalStatus

@PublicPreviewAPI
class UrlRetrievalStatus

The status of a URL retrieval.

Summary

Public companion properties
`UrlRetrievalStatus`	`ERROR` The URL retrieval failed.
`UrlRetrievalStatus`	`PAYWALL` The URL retrieval failed because the content is behind a paywall.
`UrlRetrievalStatus`	`SUCCESS` The URL retrieval was successful.
`UrlRetrievalStatus`	`UNSAFE` The URL retrieval failed because the content is unsafe.
`UrlRetrievalStatus`	`UNSPECIFIED` Unspecified retrieval status.

Public properties
`String`	`name` The name of the retrieval status.
`Int`	`ordinal` The ordinal value of the retrieval status.

Public companion properties

ERROR

val ERROR: UrlRetrievalStatus

The URL retrieval failed.

PAYWALL

val PAYWALL: UrlRetrievalStatus

The URL retrieval failed because the content is behind a paywall.

SUCCESS

val SUCCESS: UrlRetrievalStatus

The URL retrieval was successful.

UNSAFE

val UNSAFE: UrlRetrievalStatus

The URL retrieval failed because the content is unsafe.

UNSPECIFIED

val UNSPECIFIED: UrlRetrievalStatus

Unspecified retrieval status.

Public properties

name

val name: String

The name of the retrieval status.

ordinal

val ordinal: Int

The ordinal value of the retrieval status.