ResourceBuilders.Resources.Builder

Added in 1.0.0
Deprecated in 1.2.0

class ResourceBuilders.Resources.Builder


Builder for Resources

Summary

Public constructors

Public functions

ResourceBuilders.Resources.Builder

Adds an entry into a map of resource_ids to images, which can be used by layouts.

ResourceBuilders.Resources

Builds an instance from accumulated values.

ResourceBuilders.Resources.Builder
setVersion(version: String)

Sets the version of this Resources instance.

Public constructors

Builder

Added in 1.0.0
Deprecated in 1.2.0
Builder()

Public functions

addIdToImageMapping

Added in 1.0.0
Deprecated in 1.2.0
fun addIdToImageMapping(id: String, image: ResourceBuilders.ImageResource): ResourceBuilders.Resources.Builder

Adds an entry into a map of resource_ids to images, which can be used by layouts.

build

Added in 1.0.0
Deprecated in 1.2.0
fun build(): ResourceBuilders.Resources

Builds an instance from accumulated values.

setVersion

Added in 1.0.0
Deprecated in 1.2.0
fun setVersion(version: String): ResourceBuilders.Resources.Builder

Sets the version of this Resources instance.

Each tile specifies the version of resources it requires. After fetching a tile, the renderer will use the resources version specified by the tile to separately fetch the resources.

This value must match the version of the resources required by the tile for the tile to render successfully, and must match the resource version specified in which triggered this request.