Lê um arquivo em um diretório privado do dispositivo móvel.

Figura 1 - Bloco Ler Arquivo

Por padrão, cada aplicação tem um espaço reservado no armazenamento interno do dispositivo para sua execução e gerenciamento de arquivos. Esse espaço é conhecido como diretório privado.

Compatibilidade

• Bloco cliente mobile: cronapi.cordova.file.readFile()

Retorno

Retorna o conteúdo do arquivo lido de acordo com o tipo de retorno escolhido.

Parâmetros

Nome do Arquivo

Caminho completo do arquivo a ser removido. Neste parâmetro deve ser inserido o bloco Obter Diretório, que especifica o diretório que deverá ser criado o arquivo, juntamente com um bloco de texto, que deve conter o nome do arquivo e sua extensão. Para concatenar essas informações utilize o bloco criar texto com, assim como exibido no Exemplo.

• Posição: 1
• Inglês: File Name
• Tipo: Texto / String
• Exemplo: file:///data/user/0/io.meuapp/files/meuarquivo.txt

Sucesso

Executa uma ação caso o arquivo seja lido com sucesso.

• Posição: 2
• Inglês: Success
• Tipo: Comando com retorno ("item") / Command with return ("item")
• Exemplo: uso do bloco Exibir Notificação

Erro

Executa uma ação caso ocorra um erro durante a leitura do arquivo.

• Posição: 3
• Inglês: Error
• Tipo: Comando com retorno ("item") / Command with return ("item")
• Exemplo: uso do bloco Exibir Notificação

Tipo de Retorno

Tipo de retorno do arquivo lido.

• Posição: 4
• Inglês: Return Type
• Tipo: Texto / String
• Exemplo: "TEXT"
• Opções:
  • ARRAYBUFFER: lê o conteúdo do arquivo como um objeto ArrayBuffer.
  • TEXT: lê o conteúdo do arquivo como texto.
  • BINARYSTRING: lê o conteúdo do arquivo como binário e retorna uma string binária.
  • DATAURL: lê o conteúdo do arquivo e retorna uma URL de dados (Data URL) codificado em base64.

Exemplo

A função abaixo mostra um exemplo de uso do bloco Ler Arquivo, que exibe uma notificação contendo o conteúdo do arquivo lido. No parâmetro Nome do Arquivo, inserimos o bloco de concatenação criar texto com, e nele adicionamos o bloco Obter Diretório, indicando que o arquivo deverá ser lido no diretório interno do dispositivo móvel, e um bloco de texto, com o nome do arquivo para leitura. 

O bloco Exibir Notificação retornará uma mensagem a depender do resultado da leitura do arquivo. Caso ocorra com sucesso, o fluxo de execução é direcionado para os comandos contidos no parâmetro Sucesso, caso contrário, os comandos em Erro são executados. O arquivo deste exemplo, é o mesmo criado na documentação do bloco Criar Arquivo, consulte-a para visualizar o nome e o conteúdo do arquivo criado. Por fim, no parâmetro Tipo de Retorno, escolhemos o tipo "TEXT", que retornará o conteúdo do arquivo em texto.

Figura 2 - Exemplo de uso do bloco Ler Arquivo

A imagem a seguir mostra o resultado de execução da função da Figura 2. Após clicar no botão "Ler arquivo", a função será executada. Na imagem, vemos a notificação exibida após esta ação contendo o conteúdo do arquivo.

Figura 2.1 - Resultado de execução da função da Figura 2