Lumberyard
Guía del usuario (Version 1.18)

Llamadas al API de Cloud Gem Message of the Day

El cliente del juego y Cloud Gem Portal usan Amazon API Gateway para invocar de forma segura funciones Lambda de la API del servicio. El cliente del juego puede leer mensajes, mientras que Cloud Gem Portal puede añadir, incluir, editar y eliminar mensajes.


      El cliente del juego y Cloud Gem Portal llaman a las funciones Lambda a través de API Gateway

Las llamadas al API del servicio del cliente del juego: /player/messages

El archivo player_messages.py ubicado en el directorio \dev\Gems\CloudGemMessageOfTheDay\AWS\lambda-function-code\api implementa la funcionalidad de lectura de mensajes del cliente del juego.

get (lectura de mensajes)

La función get lee mensajes para el jugador.

Parámetros

La función get tiene los siguientes parámetros.

{ "clientTime" : datetime as string : Opt [default UTC] : The datetime value used to retrieve the messages. The default is UTC. "clientLanguage" : String : Opt [default "Eng"] : The language used for localization. }

Descripción

La función get devuelve una lista de mensajes cuyo startTime <= clientTime <= endTime.

Valor devuelto

La función get devuelve una lista de mensajes del día.

{ "list" : a list of objects { "message": string "priority": integer, "startTime": datetime, "endTime": datetime } }

Llamadas al API del servicio de administración de Cloud Gem Portal: /admin/messages

La funcionalidad de mensaje de Cloud Gem Portal se implementa por medio de código en el archivo admin_messages.py ubicado en el directorio \dev\Gems\CloudGemMessageOfTheDay\AWS\lambda-function-code\api.

post (adición de mensajes)

La función post añade un mensaje del día.

Parámetros

La función post tiene los siguientes parámetros.

{ "message": String: Required "priority": Integer, : Opt [default 0] "startTime": datetime: Opt [default Jan 01 1900 00:00 ] "endTime": datetime: Opt [default Dec 31 2100 23:59 ] }

Descripción

La función post añade una entrada de mensaje a la tabla principal en DynamoDB y devuelve una cadena UniqueMsgID.

put (edición de mensajes)

La función put edita un mensaje existente.

Parámetros

La función put tiene los siguientes parámetros.

{ "UniqueMsgID": String: Required "message": String: Opt [default leaves current message unchanged] "priority": Integer, : Opt [default 0] "startTime": datetime: Opt [default Jan 01 1900 00:00 ] "endTime": datetime: Opt [default Dec 31 2100 23:59 ] }

Descripción

La función put actualiza el mensaje en la tabla principal que coincide con el ID de mensaje especificado. Para actualizar el mensaje, la función sobrescribe sus atributos. También puede usar la función put para volver a programar y dar prioridad a un mensaje actualizando la hora de inicio, la hora de finalización y los valores de prioridad.

Valor devuelto

La función put devuelve una cadena que indica el estado de resultado de la operación.

delete (eliminación de mensajes)

La función delete elimina el mensaje especificado.

Parámetros

La función delete tiene los siguientes parámetros.

{ "UniqueMsgID": String: Required }

Descripción

Elimina el mensaje de la tabla principal que coincide con el ID de mensaje especificado.

Valor devuelto

La función delete devuelve una cadena que indica el estado de resultado de la operación.

get (generación de una lista de mensajes)

La función get recupera una lista de mensajes del día.

Parámetros

La función get tiene los siguientes parámetros.

{ "index": Integer: Opt [default 0] "count": Integer: Opt [default 9999999] "filter": Opt [default all] Can be one of the following: "active", "expired", "planned" or "all" }

Descripción

La función get devuelve el recuento filtrado de entradas en la tabla, incluidos todos los campos a partir del índice especificado.

Valor devuelto

La función get devuelve una lista de mensajes del día en el siguiente formato.

{ "list" : a list of objects { "UniqueMsgID": String "message": String "priority": Integer, "startTime": datetime, "endTime": datetime } }