Elementos de las declaraciones de Tin Can

Lata API: Declaraciones 101

En la introducción técnica a Tin Can , esbozamos algunos conceptos básicos acerca de las declaraciones. Aquí vamos a echar un vistazo más profundo en la estructura de los estados, y descubrir su utilidad en la captura de experiencias.

Una nota rápida: en el desarrollo de su propio poder de estaño declaraciones, la Lata Registro será un recurso valioso. Contiene URI resolver, que son los bloques de construcción de Can declaraciones de estaño. Si no encuentra las piezas que usted está buscando en el Registro , háganoslo saber . Vamos a trabajar con usted para obtener el registro actualizado.

En el nivel más simple, Lata estructura declaración se puede expresar en forma de "agente objeto del verbo". Un ejemplo de este tipo de declaración es "a Sally con experiencia 'Solo Ala Delta'". En la introducción técnica, vimos el formato JSON de esta declaración como

{

"actor" : {

"name" : "a Sally

Ala Delta " }

}

}

}

El uso de este ejemplo como base, vamos a empezar a explorar y ampliar los elementos de Tin Can declaraciones.

Partes de un Lata Declaración

• Actor

• Verbo

• Objeto

• Verbos vs Actividades

• Contexto

• Resultar

• Extensiones

• Otros campos declaración

Actor

Como llevamos a cabo la investigación que participan en el Proyecto Lata, un sentimiento que hemos escuchado repetidamente en nuestras entrevistas con líderes de la industria fue la siguiente: El aprendizaje es cada vez, y debe llegar a ser, cada vez más personas-céntrica. Descubrimos que las personas, no las empresas, estaban más interesados en la propiedad a largo plazo de sus experiencias y resultados.

En Lata, las personas no tienen que ser identificados únicamente por un sistema o ID. Eso es un paso importante en la toma de poder de lata persona-céntrica. Imagine una vista consolidada de su actividad a través de todos los sistemas con los que se interactúa. A pesar de que tuiteó con @ yourhandle en Twitter, cuando se ve el conjunto de su actividad, se ve la experiencia más en los términos que usted escribió en Twitter, el mismo "tú" que tomó 'Solo Ala Delta "y el mismo" tú "que leer Hang Gliding Training Manual. Debido a la preocupación por la privacidad, cada declaración contendrá sólo una representación de "usted", sin embargo los sistemas que son conscientes de estas múltiples personalidades puede agregarlos informes.

Con esa explicación en mente, echemos un vistazo a nuestro ejemplo de objeto actor:

{

"name" : "Planeador de Sally" ,

"mbox" : "mailto: sally@example.com"

}

Este objeto actor tiene dos propiedades, "name" y "mbox". Sólo "mbox" describe exclusiva este Sally-. Puede haber mucha gente por ahí con el nombre de Sally, pero sólo uno de ellos es dueño de la dirección de correo electrónico sally@example.com.

Vamos a considerar otra manera de representar a Sally:

{

"name" : "Planeador de Sally" ,

"cuenta" : {

"homepage" : "http://twitter.com" ,

"name" : "sallyglider434"

}

}

En este caso, estamos identificando a Sally por su cuenta de Twitter con el mango "sallyglider434". Esta flexibilidad en la identificación de las personas es una característica importante de Lata, y puedes leer más sobre esto en nuestro mensaje Deep Dive Actor / Agente . También hablaremos acerca de los sistemas que representan (no personas) y grupos como actores también. Por ahora, los detalles se pueden encontrar en el Tin Can especificación API.

Verbo

Los verbos en poder de estaño son los URI, y deben ser emparejados con una cadena de presentación corto. Son un elemento fundamental de los estados, ya que describen lo que ha ocurrido entre el actor y el objeto de la declaración. La lata especificación (1.0.0 en el momento de escribir estas líneas) permite a cualquier URI completo para ser utilizado como un verbo. Hemos construido la Lata Registro API como un lugar para almacenar y agregar verbos, junto con un lugar para los URI sus verbos 'de resolver. Hay un conjunto inicial de verbos publicados por ADL, y se puede encontrar en la Lata Registro . Es sin duda una buena idea por lo menos considerar estos verbos antes de crear su cuenta. Dicha lista incluye "experiencia", "asistido", "intento", "finalizado", "pasado", "no", "respuesta", "interactúa", "importada", "creado", "compartir" y "anulado ". Para más información sobre los verbos, echa un vistazo a nuestro post profundas buceo en los verbos .

Objeto

Terminando la estructura declaración de núcleo, vamos a considerar el campo "objeto". Normalmente, el objeto será un Lata actividad, aunque podría ser otro actor, y en el caso de la micción, otro comunicado. Por ahora, vamos a mantener nuestro enfoque en actividades como objetos.

Mientras que los actores de la lata suelen estar relacionados con los existentes y verbos tienden a tener una clara definición existente, las actividades son más propensas a ser definidos y proporcionados por los sistemas de declaraciones de informes. Todas las actividades deben ser definidas únicamente por un URI, y pueden incluir opcionalmente información descriptiva. Vamos a echar otro vistazo al objeto de nuestra declaración de ejemplo:

{

"id" : "http://example.com/activities/solo-hang-gliding" ,

"definición" : {

"name" : { "en-US" : "Solo Ala Delta" }

}

Se trata de una actividad identificada de forma única por su campo "id". Es un principio importante de la poder de lata que no hay dos actividades son siempre referenciados por el mismo ID. Por definición, un ID corresponde uno a uno con la actividad lógico que identifica. Es posible que la definición lógica de una actividad a ser confuso si los identificadores se eligen mal, por ejemplo: "el ala delta, la natación y la pregunta # 4", pero sigue siendo una actividad lógica. Por esta razón, los creadores de los identificadores de actividad hay que tener cuidado para crear sólo los identificadores de actividad que utilizan dominios bajo su control, o se les ha dado un camino dentro de ese dominio de control, y deben establecer un sistema para garantizar la singularidad dentro de ese dominio. Tenga en cuenta que estamos usando example.com aquí. A menos que también están haciendo declaraciones ejemplo, que nunca tienen la intención de transmitir un significado real a nadie, no hagas eso.

La definición de un objeto de la actividad puede ser refinada con el tiempo (aunque no debería nunca ser cambiado lo suficientemente significativa para describir lo que debería haber sido alguna otra nueva actividad). Campos descriptivos en la definición de las actividades ofrecen una manera de Lata para apoyar la internacionalización de forma nativa. Vamos a añadir un poco más a nuestro ejemplo de objeto como un ejemplo:

Ala Delta " ,

"es" : "Solo Ala Delta"

},

"description" : {

"en-US" : "Por supuesto el 'Solo Ala Delta' proporcionada por el Club de Ala Delta" ,

"es" : "El curso de 'Solo Ala Delta' Siempre por El Club de Planeadores Hang "

},

"extensiones" : {

"http://example.com/gliderClubId" : "Por supuesto-435"

}

}

Aquí hemos añadido un campo "tipo", lo que indica que la actividad es un curso de parapente en solitario. También hemos añadido un campo "descripción", que como era de esperar, se recoge una breve descripción del curso. En el caso de "nombre" y "descripción", hemos añadido la versión española (cuidado de Google Translate). De esta manera, herramientas u otras capas de visualización presentación de informes podría cambiar automáticamente la salida de lenguaje basado en las preferencias de un usuario.

También hemos añadido al campo "extensiones", donde podemos poner clave arbitraria (URI) / pares de valores que son por encargo a una aplicación particular (o convenio). Hablaremos más acerca de las extensiones de abajo. Los detalles completos de las definiciones de actividad se pueden encontrar en la Lata especificación API.

Verbos vs Actividades

A veces la línea entre un verbo y un objeto puede ser borrosa. En nuestro ejemplo, la declaración de Sally, hay una implicación de que "Solo Ala Delta" es una actividad bien definida. Tal vez es un curso o prueba definida por la escuela de ala delta desde example.com. Pero ¿qué pasa si queremos decir "a Sally ala deslizó sobre Mount Magazine"? Es "ala delta sobre Mount Magazine", una actividad específica que Sally está "experimentando"? ¿O a Sally "ala delta", con "Revista Monte" como el objeto de la declaración?

Por

...