Documentos de API

Establecer configuración

Establecer configuración - kintone.plugin.app.setConfig()

Guarda los ajustes de configuración del plug-in como un objeto con un conjunto de claves y valores en su interior.
Solo se guardan los últimos ajustes guardados.

Esta API funciona de forma asíncrona.

Función

Escritorio

kintone.plugin.app.setConfig(config, successCallback)

Parámetros

PARÁMETRO TIPO OBLIGATORIO DESCRIPCIÓN
config Objeto Sí Especifique la configuración como un objeto, con un conjunto de claves y valores.
Las claves deben ser caracteres compatibles con ASCII.
Los valores deben ser cadenas. La longitud máxima de caracteres es 65535.
Ejemplo:{ "key1": "value1", "key2": "value2" }
successCallback Función optional La función a la que se llamará después de que los ajustes se hayan guardado correctamente. No hay parámetros.
Si no está definido, es nulo o no se especifica, la página navegará a la página de lista de complementos y mostrará un mensaje que indica que la configuración ha finalizado.

Devuelve

Nada

Páginas disponibles

Escritorio

Este método se puede utilizar en las siguientes páginas:

  • Configuración del plug-in

Muestra

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12

(async () => {
  'use strict';
  const config = {
    'key1': 'value1',
    'key2': 'value2'
  };
  await new Promise((resolve) => {
    kintone.plugin.app.setConfig(config, () => {
      resolve();
    });
  });
})();

Ejemplos de error

Los siguientes formatos no son aplicables para el parámetro config.

Caso de error 1: Uso de objetos anidados

 1
 2
 3
 4
 5
 6
 7
 8
 9
10

const config = {
  'key1': {
    'key1-1': 'value1-1',
    'key1-2': 'value1-2'
  },
  'key2': {
    'key2-1': 'value2-1',
    'key2-2': 'value2-2'
  }
};

Caso de error 2: Uso de números enteros como valores

1
2
3
4

const config = {
  'key1': 1,
  'key2': 2
};

Limitaciones

  • El tamaño máximo de datos que se puede establecer con esta API para un complemento es de 256KB.