valueToSave

Objeto contendo valores que podem ser armazenados localmente e utilizados posteriormente em actions com querystring, no header das requisições disparadas via action ou recuperado na exibição do menu principal.

Essa funcionalidade permite enviar os dados salvos via query string ou via header. Sendo assim, NÃO É RECOMENDÁVEL passar dados sensíveis via querystring. É preferível passar via header já que eles são criptografados quando usamos HTTPS, mas ainda assim não recomendamos.

O valueToSave é salvo assim que a action é acionada. Sendo assim, se o usuário acionar a action resultado da requisição dela for de erro, ainda assim os dados são armazenados.

Os valores salvos estão associados ao usuário autenticado e ao endpoint selecionado no momento. Sendo assim, se o usuário trocar de endpoint ou outro usuário se autenticar na app no mesmo aparelho, os dados salvos não estarão disponíveis.

Como os valores salvos estão associados ao usuário e ao endpoint, se a app for pública e algum dado tiver sido salvo durante o período em que o usuário não esteja autenticado, esse dado não estará associado a nenhum usuário específico e só poderá ser usado enquanto nenhum usuário estiver autenticado na app. Caso o usuário se autentique na app um novo dado precisará ser salvo.

Exemplo de uso em um action específico

{
   "order": 0,
   "permissionLevel": 2,
   "publishLevel": 1,
   "name": "call",
   "title": "Ligar Para",
   "valueToSave": [
      {"key": "codCall", "value": "12345"},
      {"key": "codUser", "value": "54321"}
   ]
   "parameters": [
      {"title":"Pessoal","value":"[phone]" }
   ]
}

Ao acionar essa action os dados codCall=12345 e codUser=54321 serão salvos localmente. Para usar esses dados é preciso fazer referência a eles em outra action.

Digamos que exista uma outra action usada para confirmar que a ligação foi feita. Ela poderia ser definida da forma descrita o exemplo abaixo:

Exemplo de action confirmando a ligação

{
    "order": 0,
    "name": "open",
    "permissionLevel": 2,
    "publishLevel": 1,
    "path": "CONFIRMAR-CHAMADA",
    "parameters": [
        {"title":"querystring","value":"?codigoDaChamada=<<codCall>>&codigoDoUsuario=<<codUser>>}
    ]
}

Quando essa action for acionada <<codCall>> será substituído por 12345 e <<codUser>> será substituído por 54321.

Se não existir nenhum dado salvo para a chave informada (valor que está entre << e >>) o valor será substituído por vazio (string vazia).

Essa funcionalidade pode ser usada também para passar dado no header da requisição da action. Para isso basta passar o "title" = "header" no lugar de "querystring", e o value no formato de query string contendo a chave que você gostaria passar no header.

Ex:

…

{"title":"header","value":"codigoDaChamada=<>&codigoDoUsuario=<>}

…

No exemplo acima serão passados os header "codigoDaChamada" = "12345" e "codigoDoUsuario" = "54321".