Referencia de gadgets de JavaScript

En este documento, se describen las clases y los métodos en el espacio de nombres gadgets.*, algunos de los cuales son específicos de una función. Para obtener más información sobre la inclusión de funciones, consulta la Especificación de gadgets.

Convenciones de tipo

En este documento, se usan las siguientes convenciones para los tipos:

Arreglo o Arreglo

Una matriz llena solo con objetos de tipo T. Esta convención es similar a la genérica de Java.

Mapa, V&gt o Mapa, V >

Un objeto JavaScript con claves de tipo K que se asignan a valores de tipo V. Nuevamente, esta convención es similar a los genéricos de Java. A menudo, se usa para las variables opt_params.

static

Los tipos marcados con clase estática no tienen constructores públicos ni privados. En otras palabras, el tipo es un espacio de nombres, no una clase de la que se pueden crear instancias para crear objetos. Los campos y las funciones de este tipo también se marcan como estáticos.

Booleano

Un valor booleano (no un objeto Boolean).

String

Un valor de string (no un objeto String).

Volver al principio

Clases del gadget.MiniMessage

RESUMEN DETALLES

MiniMessage, que se utiliza para crear mensajes que el usuario verá dentro del gadget. Casos prácticos típicos:

• Mensajes de estado: carga, guardado, etc.
• Mensajes promocionales: nuevas funciones, nuevos gadgets, etc.
• Mensajes de depuración/error: entrada incorrecta, conexión fallida con el servidor, etc.

Resumen del constructor

gadgets.MiniMessage(opt_moduleId, opt_container)

Crea un MiniMessage.

 

Resumen del método

 HTMLElement createDismissibleMessage(message, opt_callback)

Crea un mensaje descartable con un ícono [x] que permite a los usuarios descartar el mensaje.

 HTMLElement createStaticMessage(message)

Crea un mensaje estático que solo se puede descartar de manera programática (llamando a messageMessage()).

 HTMLElement createTimerMessage(message, seconds, opt_callback)

Crea un mensaje que se muestra durante la cantidad de segundos especificada.

dismissMessage(message)

Descartar el mensaje especificado

 

Detalle del constructor

gadgets.MiniMessage

gadgets.MiniMessage(opt_moduleId, opt_container)

Crea un MiniMessage.

Parámetros:
String opt_moduleId: ID de módulo opcional
HTMLElement opt_container - Elemento de contenedor HTML opcional donde aparecerán los minimensajes

Detalle del método

createDismissibleMessage

HTMLElement createDismissibleMessage(message, opt_callback)

Crea un mensaje descartable con un ícono [x] que permite a los usuarios descartar el mensaje. Cuando se descarta el mensaje, se quita del DOM y se llama a la función de devolución de llamada opcional, si está definida.

Parámetros:
String, Object message : El mensaje como una string HTML o un elemento del DOM
Function opt_callback : Es una función de devolución de llamada opcional que se puede llamar cuando se descarta el mensaje.

Muestra:
HTMLElement  elemento HTML del mensaje creado

createStaticMessage

HTMLElement createStaticMessage(message)

Crea un mensaje estático que solo se puede descartar de manera programática (llamando a messageMessage()).

Parámetros:
String, Object message : El mensaje como una string HTML o un elemento del DOM

Muestra:
HTMLElement  elemento del mensaje creado

createTimerMessage

HTMLElement createTimerMessage(message, seconds, opt_callback)

Crea un mensaje que se muestra durante la cantidad de segundos especificada. Cuando el temporizador vence, el mensaje se descarta y se ejecuta la función de devolución de llamada opcional.

Parámetros:
String, Object message : mensaje como string HTML o elemento de DOM
number seconds : cantidad de segundos que se debe esperar antes de descartar mensaje
Function opt_callback : función de devolución de llamada opcional que se debe invocar cuando se descarta el mensaje

Muestra:
HTMLElement  HTML1 1

descartarMensaje

dismissMessage(message)

Descarta el mensaje especificado.
Parámetros:
HTMLElement message : Elemento HTML del mensaje que se desea quitar

Volver al principio

Gadgets de la clase

RESUMEN DETALLES

Proporciona acceso a las preferencias del usuario, las dimensiones del módulo y los mensajes. Para acceder a sus preferencias, los clientes pueden construir una instancia de gadgets.Prefs y pasar su ID de módulo. Ejemplo:

var prefs = new gadgets.Prefs();
var name = prefs.getString("name");
var lang = prefs.getLang();

Resumen del constructor

gadgets.Prefs(opt_moduleId)

Crea un nuevo objeto Prefs.

 

Resumen del método

 Array.<String> getArray(key)

Recupera una preferencia como arreglo.

 Boolean getBool(key)

Recupera una preferencia como un valor booleano.

 String getCountry()

Obtiene el país actual, que se muestra como código ISO 3166-1 alpha-2.

 Number getFloat(key)

Recupera una preferencia como un valor de punto flotante.

 Number getInt(key)

Recupera una preferencia como un número entero.

 String getLang()

Obtiene el idioma actual que el gadget debe usar cuando se procesa, que se muestra como un código de idioma ISO 639-1.

 String, Number getModuleId()

Obtiene el ID del módulo para la instancia actual.

 String getMsg(key)

Recupera un mensaje sin formato.

 String getString(key)

Recupera una preferencia como string.

set(key, val)

Almacena una preferencia.

setArray(key, val)

Almacena una preferencia de arreglo.

 


Detalle del constructor

Gadgets y preferencias

gadgets.Prefs(opt_moduleId)

Crea un nuevo objeto Prefs.
Parámetros:
String, Number opt_moduleId: Es un parámetro opcional que especifica el ID del módulo para el que se crean las preferencias; si no se proporciona, se usa el ID predeterminado del módulo.

Detalle del método

getArray

Array.<String> getArray(key)

Recupera una preferencia como un arreglo. Los valores de UserPref que no se declararon como listas se tratan como arreglos de un elemento.
Parámetros:
String key La preferencia para recuperar
Muestra:
Array.<String> 

getBool

Boolean getBool(key)

Recupera una preferencia como un valor booleano.
Parámetros:
String key La preferencia para recuperar
Muestra:
Boolean 

getCountry

String getCountry()

Obtiene el país actual, que se muestra como código ISO 3166-1 alpha-2.
Resultados:
String  El país para esta instancia del módulo

getFloat.

Number getFloat(key)

Recupera una preferencia como un valor de punto flotante.
Parámetros:
String key La preferencia para recuperar
Muestra:
Number 

getInt

Number getInt(key)

Recupera una preferencia como un número entero.
Parámetros:
String key La preferencia para recuperar
Muestra:
Number 

getLang

String getLang()

Obtiene el idioma actual que el gadget debe usar cuando se procesa, que se muestra como un código de idioma ISO 639-1.
Muestra:
String  El lenguaje de esta instancia del módulo

getModuleId.

String, Number getModuleId()

Obtiene el ID del módulo para la instancia actual.
Muestra:
String, Number  El ID del módulo de esta instancia del módulo

getMsg.

String getMsg(key)

Recupera un mensaje sin formato.
Parámetros:
String key - El mensaje que se debe obtener
Muestra:
String  El mensaje

getString.

String getString(key)

Recupera una preferencia como string.
Parámetros:
String key : La preferencia para recuperar
Muestra:
String  La preferencia; si no se establece, una string vacía

set

set(key, val)

Almacena una preferencia. Para usar esta llamada, el gadget debe solicitar las preferencias de configuración de funciones.

Nota: Si el gadget necesita almacenar un Array, debes usar setArray en lugar de esta llamada.

Parámetros:
String key - La preferencia que se almacenará
Object val - Los valores que se almacenarán

setArray

setArray(key, val)

Almacena una preferencia de arreglo. Para usar esta llamada, el gadget debe solicitar las preferencias de configuración de funciones.
Parámetros:
String key - La preferencia que se almacenará
Array val - Los valores que se almacenarán

Volver al principio

Pestaña de gadgets de la clase

RESUMEN DETALLES

Clase de pestaña para gadgets Las pestañas se crean con el método TabSet addTab(). Para obtener objetos Tab, usa los métodos getSetTab() o getTabs().

Consulta también: TabSet

Resumen del método

 Function getCallback()

Muestra la función de devolución de llamada que se ejecuta cuando se selecciona la pestaña.

 HTMLElement getContentContainer()

Muestra el elemento HTML donde se procesa el contenido de la pestaña.

 Number getIndex()

Muestra el índice de la pestaña.

 String getName()

Muestra la etiqueta de la pestaña como una string (puede contener HTML).

 HTMLElement getNameContainer()

Muestra el elemento HTML que contiene la etiqueta de la pestaña.

 


Detalle del método

getCallback

Function getCallback()

Muestra la función de devolución de llamada que se ejecuta cuando se selecciona la pestaña.
Muestra:
Function  La función de devolución de llamada de la pestaña

getContentContainer.

HTMLElement getContentContainer()

Muestra el elemento HTML donde se procesa el contenido de la pestaña.
Muestra:
HTMLElement  El elemento HTML del contenedor de contenido

getIndex.

Number getIndex()

Muestra el índice de la pestaña.
Muestra:
Number  El índice de la pestaña

getName

String getName()

Muestra la etiqueta de la pestaña como una string (puede contener HTML).
Muestra:
String  La etiqueta de la pestaña

getNameContainer

HTMLElement getNameContainer()

Muestra el elemento HTML que contiene la etiqueta de la pestaña.
Muestra:
HTMLElement  El elemento HTML de la etiqueta de la pestaña

Volver al principio

Gadgets de clase.TabSet

RESUMEN DETALLES

Un gadget de clase puede usar para hacer pestañas.

Resumen del constructor

gadgets.TabSet(opt_moduleId, opt_defaultTab, opt_container)

Crea un nuevo objeto TabSet

Resumen del método

 String addTab(tabName, opt_params)

Agrega una pestaña nueva en función de los pares nombre-valor especificados en opt_params.

alignTabs(align, opt_offset)

Establece la alineación de las pestañas.

displayTabs(display)

Muestra u oculta las pestañas y todo el contenido asociado.

 HTMLElement getHeaderContainer()

Muestra el elemento contenedor del encabezado de la pestaña.

 gadgets.Tab getSelectedTab()

Muestra el objeto de pestaña seleccionado.

 Array.<gadgets.Tab> getTabs()

Muestra un arreglo de todos los objetos de pestaña existentes.

removeTab(tabIndex)

Quita una pestaña de tabIndex y todo su contenido asociado.

setSelectedTab(tabIndex)

Selecciona la pestaña en tabIndex y activa la función de devolución de llamada de la pestaña, si existe.

swapTabs(tabIndex1, tabIndex2)

Cambia las posiciones de las pestañas en tabIndex1 y tabIndex2.

 


Detalle del constructor

gadgets.TabSet

gadgets.TabSet(opt_moduleId, opt_defaultTab, opt_container)

Crea un nuevo objeto TabSet
Parámetros:
String opt_moduleId: Sufijo opcional para el ID del contenedor de la pestaña
String opt_defaultTab - Nombre opcional de la pestaña que especifica el nombre de la pestaña que se selecciona después de la inicialización; si se omite este parámetro 1 si el elemento 0 se encuentra en la parte superior

Detalle del método

agregarTab

String addTab(tabName, opt_params)

Agrega una pestaña nueva en función de los pares nombre-valor especificados en opt_params. Las siguientes propiedades son compatibles con opt_params:

contenedordecontenido

Un elemento HTML existente que se usará como contenedor de contenido de la pestaña. Si se omite, la biblioteca de pestañas crea una.

devolución de llamada

Es una función de devolución de llamada que se ejecuta cuando se selecciona la pestaña.

información sobre la herramienta

Es una descripción de información que aparece cuando el usuario mueve el cursor del mouse sobre la pestaña.

index

Es el índice en el que se inserta la pestaña. Si se omite, la pestaña nueva se agrega al final.

Parámetros:
String tabName - Etiqueta de la pestaña que se creará
Object opt_params - Objeto opcional del parámetro
Muestra:
String  ID del contenedor de la pestaña

alignTabs

alignTabs(align, opt_offset)

Establece la alineación de las pestañas. Las pestañas están alineadas al centro de forma predeterminada.
Parámetros:
String align - 'left'center' o 'right'
Number opt_offset - Parámetro opcional para establecer la cantidad de píxeles que se desplazan desde el borde izquierdo o derecho; el valor predeterminado es 3px
1 1 }

Pestañas de visualización

displayTabs(display)

Muestra u oculta las pestañas y todo el contenido asociado.
Parámetros:
Boolean display : Verdadero para mostrar pestañas; falso para ocultar pestañas

getHeaderContainer

HTMLElement getHeaderContainer()

Muestra el elemento contenedor del encabezado de la pestaña.
Muestra:
HTMLElement  El elemento de contenedor de los encabezados de pestaña

getSelectedTab.

gadgets.Tab getSelectedTab()

Muestra el objeto de pestaña seleccionado actualmente.
Muestra:
gadgets.Tab  El objeto de pestaña seleccionado actualmente

getTabs

Array.<gadgets.Tab> getTabs()

Muestra un arreglo de todos los objetos de pestaña existentes.
Resultados:
Array.<gadgets.Tab> Arreglo de todos los objetos de pestaña existentes

eliminarTab

removeTab(tabIndex)

Quita una pestaña de tabIndex y todo su contenido asociado.
Parámetros:
Number tabIndex - Índice de la pestaña que se quitará

setSelectedTab

setSelectedTab(tabIndex)

Selecciona la pestaña en tabIndex y activa la función de devolución de llamada de la pestaña, si existe. Si la pestaña ya está seleccionada, la devolución de llamada no se activa.
Parámetros:
Number tabIndex : Índice de la pestaña para seleccionar

Cambiar pestañas

swapTabs(tabIndex1, tabIndex2)

Intercambia las posiciones de las pestañas en tabIndex1 y tabIndex2. La pestaña seleccionada no cambia y no se llama a ninguna función de devolución de llamada.
Parámetros:
Number tabIndex1 - Índice de la primera pestaña que se debe cambiar
Number tabIndex2 - Índice de la pestaña secundaria que se debe cambiar

Volver al principio

Clase estática gadgets.flash

RESUMEN DETALLES

Incorpora contenido Flash en gadgets.

Resumen del método

<static>  Boolean embedCachedFlash()

Incorpora un archivo Flash almacenado en caché en el árbol del DOM.

<static>  Boolean embedFlash(swfUrl, swfContainer, swfVersion, opt_params)

Inyecta un archivo Flash en el árbol del DOM.

<static>  Number getMajorVersion()

Detecta Flash Player y su versión principal.

 


Detalle del método

incorporaciónCachedFlash

<static> Boolean embedCachedFlash()

Incorpora un archivo Flash almacenado en caché en el árbol del DOM. Acepta los mismos parámetros que gadgets.flash.embedFlash.
Muestra:
Boolean  Si la llamada a función se completa correctamente

incorporaciónFlash

<static> Boolean embedFlash(swfUrl, swfContainer, swfVersion, opt_params)

Incorpora un archivo Flash en el árbol del DOM.
Parámetros:
String swfUrl - URL SWF
String, Object swfContainer - El ID o la referencia de objeto de un elemento de contenedor HTML existente
Number swfVersion - Versión mínima de Flash Player necesaria
Object opt_params - Un objeto opcional que puede contener cualquier parámetro HTML válido; todos los atributos se pasarán a la película Flash durante la creación
1 4 1 1

getMajorVersion.

<static> Number getMajorVersion()

Detecta Flash Player y su versión principal.
Muestra:
Number  La versión principal de Flash Player o 0 si no se admite Flash

Volver al principio

Clase estática gadgets.io

RESUMEN DETALLES

Proporciona funciones remotas de recuperación de contenido.

Resumen del método

<static>  String encodeValues(fields)

Convierte un objeto de entrada en una string de datos codificada en URL.

<static>  String getProxyUrl(url, opt_params)

Obtiene la versión de proxy de la URL que se pasó.

<static> makeRequest(url, callback, opt_params)

Recupera contenido de la URL proporcionada y lo envía a la función de devolución de llamada.

 


Detalle del método

Valores codificados

<static> String encodeValues(fields)

Convierte un objeto de entrada en una string de datos codificada en URL. (clave=valor&...)
Parámetros:
Object fields - Los campos de entrada que deseas codificar
Muestra:
String  Los datos de publicación procesados, incluidos el signo final (&)

getProxyUrl.

<static> String getProxyUrl(url, opt_params)

Obtiene la versión del proxy de la URL que se pasó.
Parámetros:
String url : URL para obtener la URL del proxy de
Map<String, String> opt_params - parámetros adicionales para pasar a la solicitud
Muestra:
String  La versión con proxy de la URL

MakeRequest

<static> makeRequest(url, callback, opt_params)

Recupera el contenido de la URL proporcionada y lo envía a la función de devolución de llamada. Ejemplo:

var params = {};
params[gadgets.io.RequestParameters.CONTENT_TYPE] = gadgets.io.ContentType.TEXT;
gadgets.io.makeRequest(url, callback, params);

Autorización firmada

Si opt_params[gadgets.io.RequestParameters.AUTHORIZATION] está configurado como gadgets.io.AuthorizationType.SIGNED, el contenedor debe verificar la identidad del usuario en el servidor de destino. El contenedor hace esto de la siguiente manera:

1. Quitar los parámetros de solicitud con nombres que comiencen con oauth, xoauth o opensocial (no distinguen mayúsculas y minúsculas).

2. Agrega los siguientes parámetros a la string de consulta de la solicitud:

   opensocial_viewer_id

   Opcional.
   Corresponde al ID del usuario actual, que coincide con el valor getId() en el objeto usuario persona.

   opensocial_owner_id.

   Obligatorio.
   Corresponde al ID del propietario actual, que coincide con el valor getId() en el objeto de persona del propietario.

   URL_de_aplicaciones_sociales

   Obligatorio.
   Es la URL de la aplicación que realiza la solicitud. Los contenedores pueden alias de varias URL de aplicación a una sola URL de aplicación canónica en el caso de que una aplicación cambie las URL.

   opensocial_instance_id.

   Opcional.
   Un identificador opaco que se usa para distinguir entre varias instancias de la misma aplicación en un solo contenedor. Si un contenedor no permite que coexistan varias instancias de la misma aplicación, se puede omitir este parámetro. La combinación de opensocial_app_url y opensocial_instance_id identifica de forma única una instancia de una aplicación en un contenedor.

   opensocial_app_id

   Opcional.
   Un identificador opaco para la aplicación, único para un contenedor en particular. Los contenedores que deseen mantener la retrocompatibilidad con la especificación opensocial-0.7 pueden incluir este parámetro.

   xoauth_signature_publickey

   Opcional.
   Un identificador opaco para la clave pública que se usa a fin de firmar la solicitud. Los contenedores que no usan claves públicas para firmar solicitudes pueden omitir este parámetro o si el contenedor organiza otros medios de distribución de claves con el objetivo de la solicitud.

3. Firma la solicitud resultante de acuerdo con la sección 9 de la especificación de OAuth.

Administración de claves para gadgets.io.AuthorizationType.SIGNED

Si un contenedor usa claves públicas para firmar solicitudes, el contenedor puede optar por usar certificados autofirmados o certificados firmados por una autoridad certificada conocida. Si un contenedor no distribuye su clave de firma de OAuth a través de HTTPS, debe usar un certificado firmado por una autoridad certificada conocida.

El atributo commonName del certificado debe coincidir con el nombre de host del servidor del contenedor y con el valor del parámetro oauth_consumer_key especificado en la solicitud.

El contenedor debe hacer que su clave pública esté disponible para su descarga en una ubicación conocida. Se recomienda la ubicación https://container-hostname/opensocial/certificates/xoauth_signature_publickeyvalue.

Los destinatarios de las solicitudes firmadas deben verificar que la firma en la solicitud sea correcta y que la marca de tiempo de la solicitud esté dentro de un período razonable. Se recomienda un período de 5 minutos antes y después de la hora actual.

Los destinatarios de las solicitudes firmadas pueden usar los parámetros oauth_consumer_key y xoauth_signature_publickey para detectar de forma automática cuándo un contenedor implementa certificados nuevos. Si el contenedor implementa certificados en una ubicación conocida, el destinatario puede descargar el certificado nuevo de forma automática. Los destinatarios que descargan certificados nuevos de forma automática deben almacenar en caché los certificados resultantes.

Si un certificado de contenedor no se descarga desde https://container-hostname, el destinatario debe verificar que el certificado esté firmado por una autoridad certificada conocida antes de confiar en el certificado.

Autorización OAuth

Si opt_params[gadgets.io.RequestParameters.AUTHORIZATION] está configurado como gadgets.io.AuthorizationType.OAUTH, el contenedor debe usar OAuth para obtener acceso al recurso especificado en la solicitud. Esto puede requerir que el gadget obtenga el contenido del usuario dirigiéndolo al proveedor de servicios para obtener acceso.

Parámetros adicionales

Los siguientes parámetros adicionales se pueden especificar en opt_params:

gadgets.io.RequestParameters.OAUTH_SERVICE_NAME

El sobrenombre que usa el gadget para referirse al elemento <Service> de su especificación XML. Si no se especifica, el valor predeterminado es "".

gadgets.io.RequestParameters.OAUTH_TOKEN_NAME

El sobrenombre que el gadget utiliza para hacer referencia a un token de OAuth que otorga acceso a un recurso en particular. Si no se especifica, el valor predeterminado es "". Los gadgets pueden usar varios nombres de token si tienen acceso a varios recursos del mismo proveedor de servicios. Por ejemplo, un gadget con acceso a una lista de contactos y un calendario puede utilizar el nombre de un token de "contactos" para usar el token de la lista de contactos, y una lista de contactos de "calendar" para usar el token de calendario.

gadgets.io.RequestParameters.OAUTH_REQUEST_TOKEN

Un proveedor de servicios puede aprovisionar automáticamente un gadget con un token de solicitud aprobado con anterioridad para acceder a un recurso. El gadget puede utilizar ese token con el parámetro OAUTH_REQUEST_TOKEN. Este parámetro es opcional.

gadgets.io.RequestParameters.OAUTH_REQUEST_TOKEN_SECRET

El secreto correspondiente a un token de solicitud aprobado con anterioridad. Este parámetro es opcional.

Si se utiliza OAuth, el contenedor debe ejecutar el protocolo OAuth en nombre del gadget. Si el gadget no registró una clave de consumidor para usarla con este proveedor de servicios, el contenedor puede optar por usar una clave de firma RSA predeterminada correspondiente a un certificado conocido para firmar solicitudes. Si el contenedor utiliza una clave de consumidor predeterminada, incluirá un parámetro de OAuth adicional xoauth_app_url que identifica el gadget que realiza la solicitud.

El parámetro de devolución de llamada

El parámetro de devolución de llamada makeRequest() recibe un objeto JavaScript con varios campos específicos de OAuth, además de los valores normales que muestra makeRequest():

"oauthApprovalUrl"

Si se especifica este valor, el usuario debe visitar una página externa para aprobar la solicitud de acceso de datos del gadget. Se recomienda usar una ventana emergente para dirigir al usuario a la página externa. Una vez que el usuario ha aprobado el acceso, el gadget puede repetir la llamada makeRequest para recuperar los datos.

&ot;oauthError"

Si se especifica este valor, significa que se produjo un error relacionado con OAuth. El valor será uno de un conjunto de constantes de string que se pueden usar para detectar errores de manera programática. Las constantes no están definidas para opensocial-0.8, pero los implementadores deben intentar acordar un conjunto de valores constantes útiles para la estandarización en opensocial-0.9.

"oauthErrorText"

Si se especifica este valor, significa que se produjo un error relacionado con OAuth. El valor es un texto de formato libre que se puede usar para proporcionar información de depuración a los desarrolladores de gadgets.

Parámetros:
String url - La URL en la que se encuentra el contenido
Function callback - La función que se debe llamar con los datos de la URL una vez obtenida

Volver al principio

Clase estática gadgets.io.AuthorizationType

RESUMEN DETALLES

Lo usa RequestParameters.

Resumen del campo

<static> object NONE

Sin autorización

<static> object OAUTH

El contenedor usará OAuth para la autenticación.

<static> object SIGNED

El contenedor firmará la solicitud.

 


Detalle del campo

NINGUNO

<static> object NONE

Sin autorización.

OAUTH

<static> object OAUTH

El contenedor usará OAuth para la autenticación.

FIRMA

<static> object SIGNED

El contenedor firmará la solicitud.

Volver al principio

Clase estática gadgets.io.ContentType

RESUMEN DETALLES

Lo usa RequestParameters.

Resumen del campo

<static> object DOM

Muestra un objeto DOM; se usa para recuperar XML.

<static> object FEED

Muestra una representación JSON de un feed RSS o Atom.

<static> object JSON

Muestra un objeto JSON.

<static> object TEXT

Muestra texto; se usa para recuperar HTML.

 


Detalle del campo

DOM

<static> object DOM

Muestra un objeto DOM; se usa para recuperar XML.

FEED

<static> object FEED

Muestra una representación JSON de un feed RSS o Atom.

JSON

<static> object JSON

Muestra un objeto JSON.

TEXT

<static> object TEXT

Muestra texto; se usa para recuperar HTML.

Volver al principio

Clase estática gadgets.io.MethodType

RESUMEN DETALLES

Define los valores de RequestParameters.METHOD.

Resumen del campo

<static> object DELETE

La compatibilidad de los contenedores con este tipo de método es OPCIONAL.

<static> object GET

El tipo predeterminado.

<static> object HEAD

La compatibilidad de los contenedores con este tipo de método es OPCIONAL.

<static> object POST

La compatibilidad de los contenedores con este tipo de método es OPCIONAL.

<static> object PUT

La compatibilidad de los contenedores con este tipo de método es OPCIONAL.

 


Detalle del campo

BORRAR

<static> object DELETE

La compatibilidad del contenedor con este tipo de método es OPCIONAL.

GET

<static> object GET

El tipo predeterminado.

HEAD

<static> object HEAD

La compatibilidad del contenedor con este tipo de método es OPCIONAL.

POST

<static> object POST

La compatibilidad del contenedor con este tipo de método es OPCIONAL.

PUT

<static> object PUT

La compatibilidad del contenedor con este tipo de método es OPCIONAL.

Volver al principio

Clase estática gadgets.io.ProxyUrlRequestParameters

RESUMEN DETALLES

Lo usa el método gadgets.io.getProxyUrl().

Resumen del campo

<static> object REFRESH_INTERVAL

Intenta usar el almacenamiento en caché del contenido.

 


Detalle del campo

REFRESH_INTERVAL

<static> object REFRESH_INTERVAL

Intenta usar el almacenamiento en caché del contenido. El intervalo de actualización es la cantidad de segundos que deseamos almacenar en caché la respuesta dada. De forma predeterminada, se respetarán los encabezados HTTP. Si no hay encabezados HTTP, este valor se establecerá de forma predeterminada en 3,600 (una hora). Ten en cuenta que las solicitudes firmadas y los objetos con POST_DATA presentes no suelen almacenarse en caché.

Volver al principio

Clase estática gadgets.io.RequestParameters

RESUMEN DETALLES

Lo usa el método gadgets.io.makeRequest().

Resumen del campo

<static> object AUTHORIZATION

El tipo de autenticación que se usará para recuperar el contenido; el valor predeterminado es AuthorizationType.NONE.

<static> object CONTENT_TYPE

El tipo de contenido que se encuentra en la URL; el valor predeterminado es ContentType.TEXT.

<static> object GET_SUMMARIES

Si el contenido es un feed, indica si se deben recuperar resúmenes para ese feed. El valor predeterminado es “false”.

<static> object HEADERS

Los encabezados HTTP que se enviarán a la URL; el valor predeterminado es nulo.

<static> object METHOD

El método que se debe usar cuando se recupera contenido de la URL; el valor predeterminado es MethodType.GET.

<static> object NUM_ENTRIES

Si el contenido es un feed, la cantidad de entradas que se recuperarán es 3.

<static> object POST_DATA

Los datos que se enviarán a la URL con el método POST; el valor predeterminado es nulo.

 


Detalle del campo

AUTORIZACIÓN

<static> object AUTHORIZATION

El tipo de autenticación que se usará para recuperar el contenido; el valor predeterminado es AuthorizationType.NONE. Especificado como un AuthorizationType.

CONTENT_TYPE

<static> object CONTENT_TYPE

El tipo de contenido que se encuentra en la URL; el valor predeterminado es ContentType.TEXT. Especificado como un ContentType.

GET_SUMMARIES

<static> object GET_SUMMARIES

Si el contenido es un feed, indica si se deben recuperar resúmenes para ese feed. La configuración predeterminada es "false". Se especifica como Boolean.

ENCABEZADOS

<static> object HEADERS

Los encabezados HTTP que se enviarán a la URL; el valor predeterminado es nulo. Se especifica como Map.<String,String>.

MÉTODO

<static> object METHOD

El método que se debe usar cuando se recupera contenido de la URL; el valor predeterminado es MethodType.GET. Los valores válidos se especifican mediante MethodType.

NUM_ENTRIES

<static> object NUM_ENTRIES

Si el contenido es un feed, la cantidad de entradas que se recuperarán es 3 de forma predeterminada. Se especifica como Number.

POST_DATA

<static> object POST_DATA

Los datos que se enviarán a la URL con el método POST; el valor predeterminado es nulo. Se especifica como String.

Volver al principio

Clase estática de gadgets.json

RESUMEN DETALLES

Proporciona operaciones para traducir objetos hacia y desde JSON.

Resumen del método

<static>  Object parse(text)

Analiza una string JSON y produce un valor de JavaScript.

<static>  String stringify(v)

Convierte un valor de JavaScript en una string JSON.

 


Detalle del método

parse

<static> Object parse(text)

Analiza una string JSON, lo que produce un valor de JavaScript.
Parámetros:
String text : Es la string que se transforma en un objeto. En general, es el resultado de una llamada de stringify anterior.
Muestra:
Object  El objeto analizado del que se pasó en texto; falso si se produjo un error

encadenar

<static> String stringify(v)

Convierte un valor de JavaScript en una string JSON.
Parámetros:
Object v - El objeto que se va a convertir
Muestra:
String  El equivalente de JSON

Volver al principio

Clase estática gadgets.pubsub

RESUMEN DETALLES

Proporciona operaciones para publicar y suscribirse a canales de mensajes.

Resumen del método

<static> publish(channelName, message)

Publica un mensaje de tipo string en un canal.

<static> subscribe(channelName, callback)

Suscribe un gadget a un canal de mensajes.

<static> unsubscribe(channelName)

Anula la suscripción del gadget a un canal de mensajes.

 


Detalle del método

publish

<static> publish(channelName, message)

Publica un mensaje de tipo string en un canal.
Parámetros:
String channelName - El nombre del canal
String message - El mensaje para publicar

suscribirse

<static> subscribe(channelName, callback)

Suscribe un gadget a un canal de mensajes.
Parámetros:
String channelName - El nombre del canal
Function callback - Una función a la que se llamará con los mensajes del canal

anular la suscripción

<static> unsubscribe(channelName)

Anula la suscripción del gadget a un canal de mensajes.
Parámetros:
String channelName : El nombre del canal

Volver al principio

Clase estática de gadgets.rpc

RESUMEN DETALLES

Proporciona operaciones a fin de realizar llamadas de procedimiento remoto para la comunicación de gadget a contenedor, de contenedor a gadget y de gadget a gadget.

Resumen del método

<static> call(targetId, serviceName, callback, var_args)

Llama a un servicio RPC.

<static> register(serviceName, handler)

Registra un servicio RPC.

<static> registerDefault(handler)

Registra un controlador de servicio predeterminado para procesar todas las llamadas de procedimiento remoto desconocidas, que fallan silenciosamente de forma predeterminada.

<static> unregister(serviceName)

Cancela el registro de un servicio de RPC.

<static> unregisterDefault()

Cancela el registro del controlador de servicio predeterminado.

 


Detalle del método

call

<static> call(targetId, serviceName, callback, var_args)

Llama a un servicio RPC.
Parámetros:
String targetId : ID del proveedor de servicios de RPC; vacío si se llama al contenedor principal
String serviceName - Nombre del servicio que se debe llamar
Function, null callback - Función de devolución de llamada (si existe) para procesar el valor de retorno de la solicitud de RPC
* var_args - Parámetros de la solicitud de RPC
{11/3]

regístrese

<static> register(serviceName, handler)

Registra un servicio de RPC.
Parámetros:
String serviceName - Nombre de servicio que se registrará
Function handler - Controlador de servicio

registropredeterminado

<static> registerDefault(handler)

Registra un controlador de servicio predeterminado para procesar todas las llamadas de procedimiento remoto desconocidas, que fallan de forma predeterminada y silenciosa.
Parámetros:
Function handler - Controlador de servicio

unregister

<static> unregister(serviceName)

Cancela el registro de un servicio de RPC.
Parámetros:
String serviceName - Nombre del servicio para cancelar el registro

unregisterDefault

<static> unregisterDefault()

Cancela el registro del controlador de servicio predeterminado. Las futuras llamadas a procedimientos remotos desconocidas fallarán en silencio.

Volver al principio

Clases estáticas de gadgets

RESUMEN DETALLES

Proporciona operaciones para obtener información sobre la máscara que se muestra actualmente.

Resumen del método

<static>  String getProperty(propertyKey)

Recupera la propiedad de visualización asignada a la clave determinada.

 


Detalle del método

getProperty

<static> String getProperty(propertyKey)

Recupera la propiedad de visualización asignada a la clave determinada.
Parámetros:
String propertyKey : La clave para la que se obtienen datos; las claves se definen en gadgets.skins.Property
Muestra:
String  Los datos

Volver al principio

Clase estática gadgets.skins.Property

RESUMEN DETALLES

Todos los valores visibles que se pueden recuperar y utilizar en la IU de los gadgets. Estas son las claves compatibles para el método gadgets.skins.getProperty().

Resumen del campo

<static> object ANCHOR_COLOR

El color que deben usar las etiquetas delimitadoras.

<static> object BG_COLOR

El color del fondo del gadget.

<static> object BG_IMAGE

Una imagen para utilizar en el fondo del gadget.

<static> object FONT_COLOR

El color en el que se debe renderizar la fuente principal

 


Detalle del campo

ANCHOR_COLOR

<static> object ANCHOR_COLOR

El color que deben usar las etiquetas de anclaje.

BG_COLOR

<static> object BG_COLOR

El color del fondo del gadget.

BG_IMAGE

<static> object BG_IMAGE

Una imagen para utilizar en el fondo del gadget.

FONT_COLOR

<static> object FONT_COLOR

Es el color en el que se debe renderizar la fuente principal.

Volver al principio

Clase estática de gadgets.util

RESUMEN DETALLES

Proporciona funciones de utilidad de uso general.

Resumen del método

<static>  String escapeString(str)

Usa entradas HTML para escapar la entrada.

<static>  Object getFeatureParameters(feature)

Muestra el valor de los parámetros para esta característica.

<static>  Boolean hasFeature(feature)

Muestra si se admite la función especificada.

<static> registerOnLoadHandler(callback)

Registra un controlador de carga, una función que se ejecuta cuando se carga el gadget.

<static>  String unescapeString(str)

Revierte escapeString




Detalle del método

escapeString

<static> String escapeString(str)

Escapa la entrada mediante entidades HTML para que sea más seguro. Los siguientes caracteres se ven afectados:
• nueva línea (\n, punto de código Unicode 10)
• retorno de carro (\r, Unicode 13)
• comilla doble (&i;; Unicode 34)
• Y comercial (&i; Unicode 38)
• comilla simple (' Unicode 39)
• corchete angular de apertura (< Unicode 60)
• corchete angular de cierre (>, Unicode 62)
• barra invertida (\, Unicode 92)
• separador de línea (Unicode 8232)
• separador de párrafos (Unicode 8233)
Parámetros:
String str : String que se debe escapar
Muestra:
String  La string con escape

getFeatureParameters

<static> Object getFeatureParameters(feature)

Muestra el valor de los parámetros de esta característica. Un gadget especifica parámetros con el subelemento <Param> del elemento <Requires> o <Optional>.
Parámetros:
String feature : La función para obtener parámetros de
Muestra:
Object  Los parámetros para un atributo determinado o nulo

hasFeature

<static> Boolean hasFeature(feature)

Muestra si se admite la función especificada.
Parámetros:
String feature : La función para la cual realizar pruebas
Muestra:
Boolean  Verdadero si la función es compatible

registerOnLoadHandler

<static> registerOnLoadHandler(callback)

Registra un controlador de carga, una función que se ejecuta cuando se carga el gadget.
Parámetros:
Function callback - El controlador que se ejecutará

unescapeString;

<static> String unescapeString(str)

Revierte escapeString
Parámetros:
String str : Es la string para quitar el formato de escape.
Muestra:
String  La string sin escape

Volver al principio

Clase estática de gadgets.views

RESUMEN DETALLES

Proporciona operaciones para administrar vistas.

Consulta también: gadgets.views.View

Resumen del método

<static>  String bind(urlTemplate, environment)

Vincula una plantilla de URL con variables en el entorno pasado para producir una string de URL.

<static>  gadgets.views.View getCurrentView()

Muestra la vista actual.

<static>  Map.<String, String> getParams()

Muestra los parámetros pasados a este gadget para esta vista.

<static>  Map<gadgets.views.ViewType, String, gadgets.views.View> getSupportedViews()

Muestra un mapa de todas las vistas compatibles.

<static> requestNavigateTo(view, opt_params, opt_ownerId)

Intenta navegar a este gadget en otra vista.

 


Detalle del método

bind

<static> String bind(urlTemplate, environment)

Vincula una plantilla de URL con variables en el entorno pasado para producir una string de URL.

Consulta también: View.getUrlTemplate()

Parámetros:
urlTemplate : Una plantilla de URL para una vista de contenedor
environment : un conjunto de variables con nombre (por ejemplo, [OWNER | PATH | PARAMS | NAME]) de la string de tipo.
Muestra:
String  Una string de URL

getCurrentView

<static> gadgets.views.View getCurrentView()

Muestra la vista actual.
Muestra:
gadgets.views.View  La vista actual

getParams;

<static> Map.<String, String> getParams()

Muestra los parámetros pasados a este gadget para esta vista. No incluye todos los parámetros de URL, solo los que se pasan a gadgets.views.requestNavigateTo.
Muestra:
Map.<String, String>  El mapa de parámetros

getSupportedViews

<static> Map<gadgets.views.ViewType, String, gadgets.views.View> getSupportedViews()

Muestra un mapa de todas las vistas compatibles. Claves de cada gadget.view.View por su nombre.
Muestra:
Map<gadgets.views.ViewType, String, gadgets.views.View>  Todas las vistas compatibles, en clave de su atributo de nombre.

requestNavigateTo

<static> requestNavigateTo(view, opt_params, opt_ownerId)

Intenta acceder a este gadget en otra vista. Si el contenedor admite parámetros, transmitirá los parámetros opcionales junto con el gadget en la vista nueva.
Parámetros:
gadgets.views.View view gadgets.views.View view

Volver al principio

Clase gadgets.views.View

RESUMEN DETALLES

Interfaz base para todos los objetos de vista.

Resumen del método

 String bind(environment)

Vincula la plantilla de URL de la vista con variables en el entorno aprobado para producir una string de URL.

 gadgets.views.ViewType, String getName()

Muestra el nombre de esta vista.

 String getUrlTemplate()

Muestra una plantilla de URI de string que se ajusta al borrador de especificaciones de IETF con variables para la sustitución.

 boolean isOnlyVisibleGadget()

El resultado es verdadero si el gadget es el único visible en esta vista.

 


Detalle del método

bind

String bind(environment)

Vincula la plantilla de URL de la vista con variables en el entorno aprobado para producir una string de URL.

Consulta también: getUrlTemplate()

Parámetros:
environment : Un conjunto de variables con nombre (por ejemplo, [OWNER | PATH | PARAMS | NAME]) de la string de tipo.
Muestra:
String  Una string de URL

getName

gadgets.views.ViewType, String getName()

Muestra el nombre de esta vista.
Muestra:
gadgets.views.ViewType, String  El nombre de la vista, que se suele especificar como gadgets.views.ViewType

getUrlTemplate.

String getUrlTemplate()

Muestra una plantilla de URI de string que se ajusta al borrador de especificaciones de IETF con variables de sustitución.

Se admiten cuatro variables:

name

El nombre o ID de la aplicación

propietario

El ID del propietario de la página

ruta de acceso

Un arreglo de pasos de la ruta de acceso

parámetros

Arreglo o arreglo asociado[param1,value1,param2,value2,...]

Ejemplo

Estas son dos strings de plantillas de URL válidas:

http://container.com/{-list|/|name,owner,path}?{-join|&|params}
http://container.com/apps/{name}/{owner}{-prefix|/|path}{-opt|?os_|params}{-join|&os_|params} 

Estos son algunos parámetros:

{ 
  name : 'Wilma',
  owner : 'Betty',
  path : ['dino','car'], 
  params = { a : 'Barney', b : 'Fred'}
}

Con esos parámetros, las dos strings de plantilla de URL de ejemplo se resuelven en las siguientes URL:

http://container.com/Wilma/Betty/dino/car?a=Barney&b=Fred
http://container.com/apps/Wilma/Betty/dino/car?os_a=Barney&os_b=Fred

Consulta también: bind()

Muestra:
String  Una plantilla que se puede usar para crear URL que naveguen a esta vista

isOnlyVisibleGadget

boolean isOnlyVisibleGadget()

Muestra true si el gadget es el único visible en esta vista. En una página de lienzo o en el modo de maximización, esto es más probable; en una página de perfil o en modo de panel, lo más probable es que sea falso.
Muestra:
boolean  Verdadero si el gadget es el único visible; de lo contrario, falso

Volver al principio

Clase estática gadgets.views.ViewType

RESUMEN DETALLES

Utilizado por vistas

Resumen del campo

<static> object CANVAS

Vista en la que el gadget se muestra en un modo muy grande

<static> object HOME

Vista en la que el gadget se muestra en un área pequeña, generalmente, en una página con otros gadgets.

<static> object PREVIEW

Vista de demostración del gadget

<static> object PROFILE

Vista en la que el gadget se muestra en un área pequeña, generalmente, en una página con otros gadgets.

 


Detalle del campo

LIENZO

<static> object CANVAS

Vista en la que el gadget se muestra en un modo muy grande. Por lo general, es el contenido principal de la página. El usuario no siempre es lo mismo que el propietario.

CASA

<static> object HOME

Vista en la que el gadget se muestra en un área pequeña, por lo general, en una página con otros gadgets. Por lo general, el espectador es el mismo que el propietario.

VISTA PREVIA

<static> object PREVIEW

Vista de demostración del gadget. En esta vista, se desconoce al propietario y al visualizador.

PERFIL

<static> object PROFILE

Vista en la que el gadget se muestra en un área pequeña, por lo general, en una página con otros gadgets. El espectador no siempre es lo mismo que el propietario.

Volver al principio

Clase estática gadgets.window

RESUMEN DETALLES

Proporciona operaciones para obtener información sobre la ventana en la que se coloca el gadget y modificarla.

Resumen del método

<static> adjustHeight(opt_height)

Ajusta la altura del gadget.

<static>  Object getViewportDimensions()

Detecta las dimensiones internas de un marco.

<static> setTitle(title)

Establece el título del gadget.

 


Detalle del método

Ajustar altura

<static> adjustHeight(opt_height)

Ajusta la altura del gadget.
Parámetros:
Number opt_height : Es una altura opcional en píxeles; si no se especifica, intentará ajustar el gadget a su contenido

getViewportDimensions

<static> Object getViewportDimensions()

Detecta las dimensiones internas de un marco. Consulta http://www.quirksmode.org/dom/w3c_cssom.html para obtener más información.
Resultados:
Object Un objeto con propiedades de ancho y altura

setTitle

<static> setTitle(title)

Establece el título del gadget.
Parámetros:
String title : el título preferido

Volver al principio