SteeringManifest


@UnstableApi
class SteeringManifest


Represents a steering manifest.

See Content Steering specification.

Summary

Nested types

Represents a pathway clone.

Represents a definition of URI modifications to apply during the pathway cloning process.

Public constructors

SteeringManifest(
    version: Int,
    timeToLiveMs: Long,
    reloadUri: Uri?,
    pathwayPriority: (Mutable)List<String!>!,
    pathwayClones: (Mutable)List<SteeringManifest.PathwayClone!>!
)

Constructs an instance.

Public functions

Boolean
equals(o: Any?)
Int

Public properties

ImmutableList<SteeringManifest.PathwayClone!>!

The list of PathwayClone objects.

ImmutableList<String!>!

The priority list of pathway IDs.

Uri?

The optional Uri that the client must use for future steering manifest requests.

Long

The duration in milliseconds that the client must wait after loading the steering manifest before reloading it.

Int

The version of the steering manifest.

Public constructors

SteeringManifest

SteeringManifest(
    version: Int,
    timeToLiveMs: Long,
    reloadUri: Uri?,
    pathwayPriority: (Mutable)List<String!>!,
    pathwayClones: (Mutable)List<SteeringManifest.PathwayClone!>!
)

Constructs an instance.

Parameters
version: Int

See version.

timeToLiveMs: Long

See timeToLiveMs.

reloadUri: Uri?

See reloadUri.

pathwayPriority: (Mutable)List<String!>!

See pathwayPriority.

pathwayClones: (Mutable)List<SteeringManifest.PathwayClone!>!

See pathwayClones.

Public functions

equals

fun equals(o: Any?): Boolean

hashCode

fun hashCode(): Int

Public properties

pathwayClones

val pathwayClonesImmutableList<SteeringManifest.PathwayClone!>!

The list of PathwayClone objects.

pathwayPriority

val pathwayPriorityImmutableList<String!>!

The priority list of pathway IDs. The pathway IDs are ordered by pathway preference, with the first being most preferred. This list must not be empty.

reloadUri

val reloadUriUri?

The optional Uri that the client must use for future steering manifest requests. It may be relative to the current Steering Manifest URI. Null if not present.

timeToLiveMs

val timeToLiveMsLong

The duration in milliseconds that the client must wait after loading the steering manifest before reloading it. TIME_UNSET if not present.

version

val versionInt

The version of the steering manifest.