cabrillo.attachments - cliente

  • Versão de lançamento: Washingtondc
  • Atualizado 1 de fev. de 2024
  • 3 min. de leitura
  • O namespace para funções de anexo Cabrillo JS. Isso permite adicionar e exibir anexos.

    cabrillo.attachments - addFile(cadeia de caracteres "tableName", cadeia de caracteres sysId, parâmetros do objeto, opções de cadeia de caracteres)

    Apresenta um seletor de documentos e carrega o arquivo selecionado.

    Importante:
    Este método está obsoleto. Em vez disso, use o método addFiles().
    Tabela 1. Parâmetros
    Nome Tipo Descrição
    tableName Cadeia de caracteres Nome da tabela do registro ao qual o anexo será anexado.
    sysID Cadeia de caracteres O sys_id do registro ao qual o anexo será anexado.
    parâms Objeto Não utilizado. Defina como nulo.
    opções Cadeia de caracteres Não utilizado. Defina como nulo.
    Tabela 2. Retorna
    Tipo Descrição
    compromisso Se for bem-sucedido, um objeto Cabrillo.Attachment. Se a operação falhar, um erro.
    var table = 'incident';
    var sysID = 'a9e30c7dc61122760116894de7bcc7bd';
    
    cabrillo.attachments.addFile(table,
        sysID, 
        null,
        null
    ).then(function(attachment) {
        if (attachment) {
            console.log('Added a new file.', attachment);
        } else {
            console.log('User cancelled adding an attachment.');
        }
    }, function(error) {
        console.log('Failed to attach new file.', error);
    });

    cabrillo.attachments - addFiles(cadeia de caracteres "tableName", cadeia de caracteres sysId, parâmetros do objeto, opções do objeto)

    Apresenta um seletor de documentos para selecionar e carregar arquivos.

    Tabela 3. Parâmetros
    Nome Tipo Descrição
    tableName Cadeia de caracteres Nome da tabela que contém o registro ao qual o arquivo será anexado.
    sysID Cadeia de caracteres Sys_id do registro ao qual o arquivo será anexado.
    parâms Objeto Opcional. Reservado para uso futuro. Defina como nulo.
    opções Objeto Opcional. Configurações adicionais para carregar arquivos.
    {
      "isSingleSelection": Boolean
    }
    opções.isSingleSelection Booliano

    Opcional. Sinalizador que indica se o seletor de documentos para carregar arquivos permite seleção múltipla.

    Valores válidos:
    • verdadeiro: somente um arquivo para carregar pode ser selecionado de cada vez.
    • falso: vários arquivos para carregar podem ser selecionados de uma vez.

    Padrão: Falso

    Tabela 4. Retorna
    Tipo Descrição
    Promessa Contém anexos criados com sucesso e erros.

    Se vários arquivos forem selecionados, um anexo.Cabrilho será criado para cada arquivo carregado com êxito, enquanto uma mensagem de erro será gerada para cada carregamento malsucedido.

    Tipo de dados: objeto

    { 
       “attachments”: [Array], 
       “errors”: [Array] 
    }
    Promessa.anexos Contém todos os anexos criados com sucesso.

    Tipo de dados: matriz

    “attachments”: [Cabrillo.Attachment]
    Promessa.erros Contém erros.

    Tipo de dados: matriz

    “errors”: ["String"]

    Este exemplo cria um botão para adicionar vários anexos a um registro de incidente e verifica se há erros de upload.

    this.attachMultipleFilesButton = function() {
       c.log("Attempting to add multiple attachments to INC0010453");
       var table = 'incident';
       var sysID = 'fc74aefa1bfb2c10181499f1b24bcb3c';
    
       cabrillo.attachments.addFiles(table, sysID).then(function(result) {
          if (result) {
             handleMultipleResult(result)
          } else {
             c.log('User cancelled adding an attachment.');
          }
       }, function(error) {
          c.log('Failed to attach new files.', error);
       });
    }
    
    // A helper function to handle addFiles results 
    function handleMultipleResult(result) {
       c.log('Added multiple attachments.', result);
       if (result.attachments) {
          c.log('Number of new attachments', result.attachments.length);
       }
       if (result.errors) {
          c.log('Number of errors during upload', result.errors.length);
       }
    }

    cabrillo.attachments -viewFile(Cabrillo.Attachment attachment, Cabrillo.Rect sourceRect, String sourceBase64Image)

    Apresenta um seletor de documentos e carrega o arquivo selecionado.

    Nota:
    O escalonamento usando um parâmetro sourceRect com uma imagem sourceBase64 só é compatível com iOS. O Android ignora esses parâmetros e abre a imagem sem uma animação de escala.
    Tabela 5. Parâmetros
    Nome Tipo Descrição
    anexo Anexo.Cabrilho Descreve o anexo a ser exibido.
    sourceRect Cabrilho.Ret. Opcional. Descreve o retângulo de origem da imagem a ser ampliada.
    sourceBase64Image Cadeia de caracteres Opcional. Uma representação em base64 da imagem de origem para ampliar.
    Tabela 6. Retorna
    Tipo Descrição
    compromisso Se for bem-sucedido, será um objeto não resolvido, caso contrário, será um erro.
    // A Cabrillo.Attachment dictionary to view
    var attachment = {
        sys_id: '8e99daa3ff133100ba13ffffffffff2d',
        content_type: 'image/jpeg',
        path: '8e99daa3ff133100ba13ffffffffff2d.iix'
    };
    
    cabrillo.attachments.viewFile(attachment,
        null,
        null
    ).then(function() {
        // It worked. Nothing to do here.
    }, function(error) {
        console.log('Failed to view file.', error);
    });

    Para dimensionar uma imagem que foi acessada em um visualizador de imagens nativo, o método viewFile() aceita argumentos opcionais para o retângulo da imagem na página, bem como uma miniatura codificada em base64 da imagem. A miniatura é dimensionada para a imagem de tamanho completo com uma animação.

    // Grab image metadata from an image that was tapped
    var imageMetadata = imageMetadataFromEvent(event);
    
    // Optional rect of image on page
    var imageRect = imageMetadata.rect;
    
    // Optional base64 encoded image to scale up into native viewer
    var base64EncodedImage = imageMetadata.base64;
    
    // A Cabrillo.Attachment dictionary to view
    var attachment = {
        sys_id: '8e99daa3ff133100ba13ffffffffff2d',
        content_type: 'image/jpeg',
        path: '8e99daa3ff133100ba13ffffffffff2d.iix'
    }
    
    cabrillo.attachments.viewFile(attachment,
        imageRect,
        base64EncodedImage
    ).then(function() {
        // It worked. Nothing to do here.
    }, function(error) {
        console.log('Failed to view file.', error);
    });