api.access
api.access.deny(reason, userMessage)
string
Un motivo interno que describe por qué se deniega este intento de registro. Este valor
aparecerá en los registros del inquilino.
string
Una explicación en lenguaje claro de por qué se rechaza el intento de registro. Puede mostrarse
directamente en las interfaces para el usuario final.
api.user
api.user.setAppMetadata(key, value)
string
La propiedad de metadatos que se va a establecer.
unknown
El valor de la propiedad de metadatos. Puede establecerse en
null para eliminar la
propiedad de metadatos.api.user.setUserMetadata(key, value)
string
La propiedad de metadatos que se va a establecer.
unknown
El valor de la propiedad de metadatos. Puede establecerse en
null para eliminar la
propiedad de metadatos.api.cache
api.cache.delete(key)
string
La clave del registro de caché que se va a eliminar.
api.cache.get(key)
value del objeto devuelto.
string
La clave del registro almacenado en la caché.
api.cache.set(key, value, options)
ttl o expires_at. Si no se especifica ninguna vigencia, se usará una vigencia
predeterminada de 15 minutos. Las vigencias no pueden superar la duración máxima
indicada en límites de caché de Actions.
Importante: Esta caché está diseñada para datos efímeros de corta duración. Es posible que los elementos no estén
disponibles en transacciones posteriores, incluso si aún se encuentran dentro de la vigencia indicada.
string
La clave del registro que se almacenará.
string
El valor del registro que se almacenará.
cachesetoptions
optional
Opciones para ajustar el comportamiento de la caché.
api.validation
api.validation.error(errorCode, errorMessage)
string
Un code de error definido por el cliente que describe por qué se rechaza este intento de registro. Este valor
aparecerá en los registros del inquilino.
string
Una explicación definida por el cliente para rechazar el intento de registro. Puede mostrarse
directamente en las interfaces de usuario final.