Llamadas a la API Mensaje del día de la gema en la nube - Lumberyard Guía del usuario

Si proporcionásemos una traducción de la versión en inglés de la guía, prevalecerá la versión en inglés de la guía si hubiese algún conflicto. La traducción se proporciona mediante traducción automática.

Llamadas a la API Mensaje del día de la gema en la nube

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


      Cliente de juego y llamada a Cloud Gem Portal Lambda funciones a través de API Gateway

Las llamadas a la API del servicio de cliente de juegos: /player/messages

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

obtener (Leer mensajes)

El get La función lee mensajes para el jugador.

Parameters

El get tiene lo siguiente Los parámetros de.

{ "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. }

Description

El get La función devuelve una lista de mensajes cuyo startTime [EMPTY] clientTime [EMPTY] endTime.

Valor de devolución

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

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

Llamadas a la API del servicio de administración de Cloud Gem Portal: /admin/mensajes

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

post (Añadir mensaje)

El post añade un mensaje de la función día.

Parameters

El post tiene lo siguiente Los parámetros de.

{ "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 ] }

Description

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

put (Editar mensaje)

El put La función edita un mensaje existente.

Parameters

El put tiene lo siguiente Los parámetros de.

{ "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 ] }

Description

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

Valor de devolución

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

eliminar (eliminar mensaje)

El delete función elimina el especificado mensaje.

Parameters

El delete tiene lo siguiente Los parámetros de.

{ "UniqueMsgID": String: Required }

Description

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

Valor de devolución

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

obtener (mensajes de lista)

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

Parameters

El get tiene lo siguiente Los parámetros de.

{ "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" }

Description

El get devuelve la función filtrada de entradas de la tabla, incluidos todos los campos que empiezan en el índice especificado.

Valor de devolución

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

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