mPaaS mini program file APIs - save, retrieve, list, remove, open - Mobile Platform as a Service: Central de Documentação do Alibaba Cloud

Utilize estas APIs para salvar, recuperar, listar e excluir arquivos locais em mini programas mPaaS, além de visualizar documentos PDF.

my.saveFile

Nota

Compatível com a biblioteca base 1.13.0+ e mPaaS 10.1.32+. Para versões anteriores, garanta a compatibilidade. Para mais informações, consulte Bibliotecas base do Mini Program.

Salva um arquivo no dispositivo local (limite total de tamanho de arquivo local: 10 MB). Após chamar my.saveFile, os arquivos salvos ficam na pasta /alipay/pictures/ no Android. No iOS, o caminho da pasta é oculto.

Parâmetros de entrada

Nome	Tipo	Obrigatório	Descrição
apFilePath	String	Sim	Caminho do arquivo
success	Function	Não	Chamado em caso de sucesso.
fail	Function	Não	Chamado em caso de falha.
complete	Function	Não	Chamado quando a chamada é concluída, independentemente do resultado.

Resultado do callback de sucesso

Nome	Tipo	Descrição
apFilePath	String	Caminho do arquivo salvo.

Exemplo de código

my.chooseImage({
  success: (res) => {
    my.saveFile({
      apFilePath: res.apFilePaths[0],
      success: (res) => {
        console.log(JSON.stringify(res))
      },
    });
  },
});

my.getFileInfo

Nota

Compatível com a biblioteca base 1.4.0+ e mPaaS 10.1.32+. Para versões anteriores, garanta a compatibilidade. Para mais informações, consulte Bibliotecas base do Mini Program.

Parâmetros de entrada

Nome	Tipo	Obrigatório	Descrição
apFilePath	String	Sim	Caminho do arquivo (caminho local).
digestAlgorithm	String	Não	Algoritmo de resumo. Valores válidos: `md5` e `sha1`. Padrão: `md5`.
success	Function	Não	Chamado em caso de sucesso.
fail	Function	Não	Chamado em caso de falha.
complete	Function	Não	Chamado quando a chamada é concluída, independentemente do resultado.

Resultado do callback de sucesso

Nome	Tipo	Descrição
size	Number	Tamanho do arquivo.
digest	String	Resultado do resumo.

Exemplo de código

my.getFileInfo({
    apFilePath:'https://resource/apml953bb093ebd2834530196f50a4413a87.video',
    digestAlgorithm:'sha1',
    success:(res)=>{
        console.log(JSON.stringify(res))
    }
})

my.getSavedFileInfo

Nota

Compatível com a biblioteca base 1.3.0+ e mPaaS 10.1.32+. Para versões anteriores, garanta a compatibilidade. Para mais informações, consulte Bibliotecas base do Mini Program.

Recupera informações sobre um arquivo salvo.

Parâmetros de entrada

Nome	Tipo	Obrigatório	Descrição
apFilePath	String	Sim	Caminho do arquivo.
success	Function	Não	Chamado em caso de sucesso.
fail	Function	Não	Chamado em caso de falha.
complete	Function	Não	Chamado quando a chamada é concluída, independentemente do resultado.

Resultado do callback de sucesso

Nome	Tipo	Descrição
size	Number	Tamanho do arquivo.
createTime	Number	Timestamp de criação.

Exemplo de código

my.getSavedFileInfo funciona apenas com caminhos salvos por my.saveFile.

var that = this;
    my.chooseImage({
    success: (res) => {
      console.log(res.apFilePaths[0], 1212)
      my.saveFile({
        apFilePath: res.apFilePaths[0],
        success: (result) => {
          console.log(result, 1212)
          my.getSavedFileInfo({
            apFilePath: result.apFilePath,
            success: (resu) => {
              console.log(JSON.stringify(resu))
              that.filePath = resu
            }
          })
        },
      });
    },
});

my.getSavedFileList

Nota

Compatível com a biblioteca base 1.13.0+ e mPaaS 10.1.32+. Para versões anteriores, garanta a compatibilidade. Para mais informações, consulte Bibliotecas base do Mini Program.

Recupera todos os arquivos salvos.

Parâmetros de entrada

Nome	Tipo	Obrigatório	Descrição
success	Function	Não	Chamado em caso de sucesso.
fail	Function	Não	Chamado em caso de falha.
complete	Function	Não	Chamado quando a chamada é concluída, independentemente do resultado.

Resultado do callback de sucesso

Nome	Tipo	Descrição
fileList	List	Lista de arquivos.

Propriedades do objeto de arquivo

Nome	Tipo	Descrição
size	Number	Tamanho do arquivo.
createTime	Number	Hora de criação.
apFilePath	String	Caminho do arquivo.

Exemplo de código

my.getSavedFileList({
    success:(res)=>{
        console.log(JSON.stringify(res))
    }
});

my.removeSavedFile

Nota

Compatível com a biblioteca base 1.13.0+ e mPaaS 10.1.32+. Para versões anteriores, garanta a compatibilidade. Para mais informações, consulte Bibliotecas base do Mini Program.

Exclui um arquivo salvo.

Parâmetros de entrada

Nome	Tipo	Obrigatório	Descrição
apFilePath	String	Sim	Caminho do arquivo.
success	Function	Não	Chamado em caso de sucesso.
fail	Function	Não	Chamado em caso de falha.
complete	Function	Não	Chamado quando a chamada é concluída, independentemente do resultado.

Exemplo de código

my.getSavedFileList({
        success:(res)=>{
            my.removeSavedFile({
          apFilePath:res.fileList[0].apFilePath,
          success:(res)=>{
            console.log('remove success')
          }
        })
        }
    });

my.openDocument

my.openDocument(Object)

Visualiza arquivos PDF locais.

Parâmetros de entrada

Object

Propriedade	Tipo	Padrão	Obrigatório	Compatibilidade	Descrição
filePath	String	-	Sim	-	Caminho do arquivo (arquivo temporário, arquivo de cache ou arquivo do usuário).
fileType	String	-	Sim	-	Tipo de arquivo. Valor válido: pdf.
success	Function	-	Não	-	Chamado em caso de sucesso.
fail	Function	-	Não	-	Chamado em caso de falha.
complete	Function	-	Não	-	Chamado quando a chamada é concluída. Nota Executado independentemente do resultado.

Códigos de erro

O callback fail retorna um Object com as propriedades error (código de erro) e errorMessage (descrição do erro).

Código de erro	Mensagem de erro	Soluções
4011	Caminho inválido	Verifique se o parâmetro filePath está correto. Para mais informações, consulte o tipo e a descrição do parâmetro filePath.
4012	O arquivo não existe	Verifique se o arquivo especificado por `filePath` existe.
4013	Este tipo de arquivo não é suportado	Verifique se o parâmetro `fileType` está correto. Para mais informações, consulte a descrição do parâmetro fileType.

Exemplo de código

my.openDocument({
  filePath: `${my.env.USER_DATA_PATH}/test.pdf`,
  fileType: 'pdf',
  success: (res) => {
    console.log(res);
  },
  fail: (err) => {
    console.log(err);
  },
});

Dica

Baixe um PDF com my.downloadFile e passe o caminho do arquivo temporário como o parâmetro filePath.

Instruções

Leia o conteúdo em inglês para entender O QUE precisa ser comunicado
Escreva o português brasileiro DO ZERO — esqueça a estrutura das frases em inglês
Preserve toda a formatação markdown, blocos de código, links e imagens exatamente como estão
Tags xref (<a data-tag="xref" ...>texto</a>) — preserve a tag INTEIRA com todos os atributos na ordem e caixa originais, traduza APENAS o texto visível entre > e
Aplique todas as regras específicas do idioma rigorosamente
Aplique as regras de stopwords com tolerância zero
Use o modo imperativo em passos numerados e listas de procedimentos
Garanta a consistência terminológica — mesmo termo = mesma tradução em todo o documento
Varie os inícios de frase em listas/tabelas — nenhum início repetido mais de 3 vezes
Retorne APENAS o documento markdown em português brasileiro, sem explicações