AppMachine Central de Ajuda

Como podemos ajudá-lo?

Seguir

Módulo: core.js

A biblioteca core.js expõe a funcionalidade central do SDK JavaScript AppMachine. 

Incluir core.js

Para incluir core.js em seu bloco de JavaScript você só precisa adicionar a seguinte linha de código a sua página HTML.

<script type="text/javascript" src="/bridge/core.js"></script>

Nota: ao adicionar um novo bloco de JavaScript no seu app já fizemos isso para você.

Fazendo isso, irá incluir automaticamente a biblioteca central em sua página e permitirá que você acesse o AppMachine SDK usando:

<script type="text/javascript">
	window.App
</script>

Métodos

Agora que você incluiu o Core do AppMachine SDK em seu bloco, você pode começar a usá-lo. A biblioteca principal inclui os seguintes métodos:

getCurrentRecord(callback)

Vai obter o registro selecionado no escopo atual do aplicativo, por exemplo quando o bloco é posicionado em baixo de um bloco Excel ou Web Service.
Parâmetros:
NomeTipoDescrição
callback função O método de retorno que deve ser invocado uma vez que o registro foi recuperado.
Lançamento de erros:
Se o retorno de chamada foi especificado, mas não é uma função, ou quando o retorno é indefinido.
Tipo
Error

getRecords(callback)

Vai obter a coleção de registros disponíveis no escopo atual do aplicativo, por exemplo, quando o bloco é colocado debaixo de um bloco Excel ou Web Service.
Parâmetros:
NomeTipoDescrição
callback função O método de retorno que deve ser chamado quando a matriz de registros está disponível.
Lançamento de erros:
Se o retorno de chamada foi especificado, mas não é uma função, ou quando o retorno é indefinido.
Tipo
Error

getVariable(key, callback)

Permite recuperar uma variável do escopo atual do aplicativo.
Parâmetros:
NomeTipoDescrição
key String O nome da variável.
callback função O método de retorno que deve ser chamado uma vez que o valor da variável foi recuperado.
Lançamento de erros:
  • Se nenhuma chave válida foi especificada.
    Tipo
    Error
  • Se o retorno de chamada foi especificado, mas não é uma função, ou quando o retorno é indefinido.
    Tipo
    Error

goBack()

Irá fechar o bloco de JavaScript e navegar de volta para o bloco JavaScript raiz. Isso geralmente só é útil quando o seu bloco é executado em modo de tela cheia.
Permite navegar para outro bloco dentro do seu aplicativo usando a navegação nativa do app.
Parâmetros:
NomeTipoDescrição
blockIdentifier String O identificador do bloco de construção, este pode ser a legenda, nome da variável ou id.
callback função O método de retorno que deve ser invocado uma vez concluída a navegação.
Lançamento de erros:
Quando nenhum identificador do bloco válido foi especificado, ou se o identificador do bloco não é do tipo String.
Tipo
Error

setVariable(key, value)

Permite armazenar uma variável no escopo do aplicativo. Esta variável não será removida até que o aplicativo é desligado e permite que você armazene as variáveis em um bloco de JavaScript e as acesse em outro bloco de JavaScript.
Parâmetros:
NomeTipoDescrição
key String O nome da variável.
value objeto O valor da variável.
Lançamento de erros:
Se nenhuma chave válida foi especificada.
Tipo
Error

Notificações

Notificações fazem parte dos principais recursos e permitem a interação com o usuário.

<script type="text/javascript">
	window.App.Notification
</script>

showAlertMessage(title, message, buttons, buttonClickHandler)

Vai mostrar um diálogo de alerta com o título e a mensagem especificada. Opcionalmente você pode especificar botões que devem ser semeados no diálogo.
Parâmetros:
NomeTipoDescrição
title String O título que deve ser mostrado na caixa de diálogo.
message String A mensagem que deve ser mostrado no diálogo.
buttons Array Um array de strings contendo os botões.
buttonClickHandler função O método de retorno que deve ser invocado quando o usuário aperta um botão.
Lançamento de erros:
Se tanto o título e mensagem são indefinidos.
Tipo
Error
Exemplo
window.App.Notification.showAlertMessage('Hello world', 'Do you want to continue?', ['Yes', 'No'], function(args) {
				if(args.index === 0){
				//User clicked yes
			} else {
			//User clicked no
		}
	});

Cache

O cache pode ser um aspecto importante de um app, pois permite que o usuário use o app mesmo que estejam offline. O cache expõe um par de características que lhe permitem armazenar em cache dados ou imagens, sem afetar o armazenamento local.

<script type="text/javascript">
	window.App.Cache
</script>

downloadImage(url, type, onComplted, onFailed)

Irá fazer o download de uma imagem usando o cache de imagem nativa e retorna o resultado como uma string base64. Depois que a imagem está disponível, você pode acessá-lo, mesmo se o usuário estiver offline.
Parâmetros:
NomeTipoDescrição
url String A URL da imagem que deve ser baixado.
type String O tipo de imagem (png ou jpg).
onCompleted função O método de retorno que deve ser invocado uma vez que a imagem está disponível.
onFailed função O método de retorno que deve ser invocado quando baixar a imagem falhou.
Lançamento de erros:
  • Se nenhuma URL de download de imagem válido foi especificado ou se o tipo de url não é uma String.
    Tipo
    Error
  • Se o tipo de imagem não é suportado - tipos de imagem suportados são png e jpg.
    Tipo
    Error
  • Se o manipulador OnCompleted é indefinido ou não é uma função válida.
    Tipo
    Error
Exemplo
window.App.Cache.downloadImage('http://481xy61dp22v2uqbx85ez1twoe.wpengine.netdna-cdn.com/wp-content/themes/appmachinenew/2014/images/header/logo-dark.png', 'png', function(base64Image) {
if(base64Image) {
	var imageElement = document.getElementById('myImagePlaceholder');
	if (imageElement) {
		imageElement.src = base64Image;
	}
}
}, 
function(reason) {
	alert('Failed to download the image because: ' + reason);
});
Esse artigo foi útil?
Usuários que acharam isso útil: 1 de 1
Tem mais dúvidas? Submeter um pedido

Comentários