io.vertx.kotlin.ext.web.handler.graphql.GraphiQLHandlerOptions.kt Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of vertx-lang-kotlin Show documentation
There is a newer version: 5.0.0.CR1
/*
 * Copyright 2019 Red Hat, Inc.
 *
 * All rights reserved. This program and the accompanying materials
 * are made available under the terms of the Eclipse Public License v1.0
 * and Apache License v2.0 which accompanies this distribution.
 *
 * The Eclipse Public License is available at
 * http://www.eclipse.org/legal/epl-v10.html
 *
 * The Apache License v2.0 is available at
 * http://www.opensource.org/licenses/apache2.0.php
 *
 * You may elect to redistribute this code under either of these licenses.
 */
package io.vertx.kotlin.ext.web.handler.graphql

import io.vertx.ext.web.handler.graphql.GraphiQLHandlerOptions

/**
 * A function providing a DSL for building [io.vertx.ext.web.handler.graphql.GraphiQLHandlerOptions] objects.
 *
 * Embedded GraphiQL user interface options.
 *
 * @param enabled  Whether the GraphiQL development tool should be enabled. Defaults to false.
 * @param graphQLUri  Set the GraphQL endpoint URI. Defaults to the path used to get the GraphiQL user interface.
 * @param headers  A fixed set of HTTP headers to add to GraphiQL requests. Defaults to null.
 * @param query  Initial value of the query area in the GraphiQL user interface. Defaults to null.
 * @param variables  Initial value of the variables area in the GraphiQL user interface. Defaults to null.
 *
 * 
 * NOTE: This function has been automatically generated from the [io.vertx.ext.web.handler.graphql.GraphiQLHandlerOptions original] using Vert.x codegen.
 */
fun graphiQLHandlerOptionsOf(
  enabled: Boolean? = null,
  graphQLUri: String? = null,
  headers: Map? = null,
  query: String? = null,
  variables: io.vertx.core.json.JsonObject? = null): GraphiQLHandlerOptions = io.vertx.ext.web.handler.graphql.GraphiQLHandlerOptions().apply {

  if (enabled != null) {
    this.setEnabled(enabled)
  }
  if (graphQLUri != null) {
    this.setGraphQLUri(graphQLUri)
  }
  if (headers != null) {
    this.setHeaders(headers)
  }
  if (query != null) {
    this.setQuery(query)
  }
  if (variables != null) {
    this.setVariables(variables)
  }
}

/**
 * A function providing a DSL for building [io.vertx.ext.web.handler.graphql.GraphiQLHandlerOptions] objects.
 *
 * Embedded GraphiQL user interface options.
 *
 * @param enabled  Whether the GraphiQL development tool should be enabled. Defaults to false.
 * @param graphQLUri  Set the GraphQL endpoint URI. Defaults to the path used to get the GraphiQL user interface.
 * @param headers  A fixed set of HTTP headers to add to GraphiQL requests. Defaults to null.
 * @param query  Initial value of the query area in the GraphiQL user interface. Defaults to null.
 * @param variables  Initial value of the variables area in the GraphiQL user interface. Defaults to null.
 *
 * 
 * NOTE: This function has been automatically generated from the [io.vertx.ext.web.handler.graphql.GraphiQLHandlerOptions original] using Vert.x codegen.
 */
@Deprecated(
  message = "This function will be removed in a future version",
  replaceWith = ReplaceWith("graphiQLHandlerOptionsOf(enabled, graphQLUri, headers, query, variables)")
)
fun GraphiQLHandlerOptions(
  enabled: Boolean? = null,
  graphQLUri: String? = null,
  headers: Map? = null,
  query: String? = null,
  variables: io.vertx.core.json.JsonObject? = null): GraphiQLHandlerOptions = io.vertx.ext.web.handler.graphql.GraphiQLHandlerOptions().apply {

  if (enabled != null) {
    this.setEnabled(enabled)
  }
  if (graphQLUri != null) {
    this.setGraphQLUri(graphQLUri)
  }
  if (headers != null) {
    this.setHeaders(headers)
  }
  if (query != null) {
    this.setQuery(query)
  }
  if (variables != null) {
    this.setVariables(variables)
  }
}