Histórico da Página
Índice | ||||||
---|---|---|---|---|---|---|
|
Objetivo
Este guia é destinado para desenvolvedores internos e externos do Fluig que desejam utilizar o componente de Renomear documento. O objetivo é mostrar o funcionamento e o detalhamento de todos os parâmetros de configuração.
Componente
O componente de Renomear documento tem como objetivo facilitar o processo de renomear documentos encapsulando todas as configurações básicas necessárias para essa atualização, restando somente para o desenvolvedor configurar o plugin e utilizar o callback para montar sua lógica de negócio.
Estrutura básica
Bloco de código | ||||||
---|---|---|---|---|---|---|
| ||||||
ECMBC.renameDocument(config, callback); |
Como podemos notar na estrutura básica, o componente recebe basicamente dois parâmetros, o primeiro, um objeto config com as configurações do componente e o segundo uma função callback contendo o erro e/ou o sucesso da atualização.
O primeiro parâmetro espera um objeto contendo três atributos: id, version e types, onde types não é obrigatório e os demais sim.
Bloco de código | ||||||
---|---|---|---|---|---|---|
| ||||||
var config - {
id: 10, //id do documento para atualização
version: 1000, //versão ATUAL do documento para atualização
}; |
O segundo parâmetro espera uma função que recebe dois valores: error e data.
Bloco de código | ||||||
---|---|---|---|---|---|---|
| ||||||
function(error, data) {
if(error) {
//tratamento de erro...
}
//lógica do sucesso...
} |
Utilização básica
Bloco de código | ||||||
---|---|---|---|---|---|---|
| ||||||
var EcmDocumentUpdate = SuperWidget.extend({
id: null,
version: null,
types: null,
bindings: {
local: {
'rename-document': ['click_renameDocument']
}
},
init: function() {
this.id = 10;
this.version = 1000;
},
renameDocument: function(el, ev) {
var that = this;
ECMBC.updateDocument({
id: that.id,
version: that.version
}, function(err, data) {
if(err) {
return alert(err.responseText);
}
that.someFunc(data);
});
},
someFunc: function(data) {
//Qualquer coisa com o retorno de sucesso...
}
}); |
No application.info de sua Widget adicione o componente como dependência
Bloco de código | ||||||
---|---|---|---|---|---|---|
| ||||||
application.resource.component.1=ecm/renamedocument |
Tela exibida ao chamar o componente: