tile_server_options.hpp

Go to the documentation of this file.

#pragma once
 
#include <mbgl/util/default_style.hpp>
 
#include <memory>
#include <optional>
#include <string>
#include <vector>
 
namespace mbgl {
 
    class TileServerOptions final {
    public:
        explicit TileServerOptions();
        ~TileServerOptions();
        
        // movable
        TileServerOptions(TileServerOptions&& options) noexcept;
        TileServerOptions& operator=(TileServerOptions&& options) noexcept;
        
        // copyable
        TileServerOptions(const TileServerOptions&);
 
        
        TileServerOptions clone() const;
 
        TileServerOptions& withBaseURL(std::string baseURL);
        
        const std::string& baseURL() const;
        
        TileServerOptions& withUriSchemeAlias(std::string alias);
 
        const std::string& uriSchemeAlias() const;
 
        TileServerOptions& withSourceTemplate(std::string sourceTemplate, std::string domainName, std::optional<std::string> versionPrefix);
 
        const std::string& sourceTemplate() const;
        
        const std::string& sourceDomainName() const;
        
        const std::optional<std::string>& sourceVersionPrefix() const;
 
        TileServerOptions& withStyleTemplate(std::string styleTemplate, std::string domainName, std::optional<std::string> versionPrefix);
 
        const std::string& styleTemplate() const;
        
        const std::string& styleDomainName() const;
        
        const std::optional<std::string>& styleVersionPrefix() const;
 
        TileServerOptions& withSpritesTemplate(std::string spritesTemplate, std::string domainName, std::optional<std::string> versionPrefix);
 
        const std::string& spritesTemplate() const;
        
        const std::string& spritesDomainName() const;
        
        const std::optional<std::string>& spritesVersionPrefix() const;
 
        TileServerOptions& withGlyphsTemplate(std::string glyphsTemplate, std::string domainName, std::optional<std::string> versionPrefix);
 
        const std::string& glyphsTemplate() const;
        
        const std::string& glyphsDomainName() const;
        
        const std::optional<std::string>& glyphsVersionPrefix() const;
 
        TileServerOptions& withTileTemplate(std::string tileTemplate, std::string domainName, std::optional<std::string> versionPrefix);
 
        const std::string& tileTemplate() const;
 
        const std::string& tileDomainName() const;
        
        const std::optional<std::string>& tileVersionPrefix() const;
        
        TileServerOptions& withApiKeyParameterName(std::string apiKeyParameterName);
 
        const std::string& apiKeyParameterName() const;
        
        TileServerOptions& setRequiresApiKey(bool apiKeyRequired);
 
        bool requiresApiKey() const;
        const std::vector<mbgl::util::DefaultStyle> defaultStyles() const;
 
        TileServerOptions& withDefaultStyles(std::vector<mbgl::util::DefaultStyle> styles);
 
        TileServerOptions& withDefaultStyle(std::string defaultStyle);
 
        const std::string& defaultStyle() const;
 
        static TileServerOptions DefaultConfiguration();
 
        static TileServerOptions MapLibreConfiguration();
 
        static TileServerOptions MapboxConfiguration();
 
        static TileServerOptions MapTilerConfiguration();
 
    private:
        class Impl;
        std::unique_ptr<Impl> impl_;
    };
 
} // namespace mbgl