Índice |
---|
outline | true |
---|
exclude | .*ndice |
---|
style | none |
---|
|
Objetivo
O objetivo do fluig SDK é auxiliar na criação de aplicativos móveis da plataforma fluig de forma simples e eficiente. Provendo facilitadores como mapeamento de chamadas de APIs, componentes de interfaces, fluxos integrados, ferramentas, etc.
Requisitos
Para utilizar o SDK Android, certifique-se que seu projeto atende os seguintes requisitos mínimos:
- Android 5.0+ (API level 21+)
- JDK 1.7+
- Android Studio 3.0+
Nota |
---|
|
Atualmente o Google não reconhece o Eclipse como ferramenta de desenvolvimento para Android, portanto não oferecemos suporte para este ambiente. |
Instalação
Para instalar o SDK em seu projeto, é necessário seguir os passos descritos a seguir:
- Importar o SDK pelo build.gradle
- Adicionar as permissões necessárias no AndroidManifest
- Adicionar um arquivo de configuração
- Criar as classes necessárias
- Utilizar o fluxo de login
Importar o SDK pelo build.gradle
Adicione a URL do SDK no Maven no arquivo build.gradle
do seu projeto.
Bloco de código |
---|
language | groovy |
---|
title | build.gradle (project) |
---|
|
allprojects {
repositories {
maven { url "https://dl.bintray.com/fluig/maven" }
}
}
|
Adicionada a URL acima, insira a dependência do SDK no arquivo build.gradle
do seu aplicativo.
Bloco de código |
---|
language | groovy |
---|
title | build.gradle (app) |
---|
|
dependencies {
implementation 'sdk.fluig.com:<nome_do_modulo>:<versao_do_sdk>'
} |
Adicionar as permissões necessárias no AndroidManifest
O fluig SDK requer algumas permisssões e referências do arquivo AndroidManifest.xml
da sua aplicação para poder monitorar o estado de rede.
Confira abaixo um exemplo com um pacote chamado com.myapp.package
. Substitua com o nome do seu próprio pacote ao mesclar com o manifesto de seu projeto.
Bloco de código |
---|
language | xml |
---|
title | AndroidManifest.xml |
---|
|
<?xml version="1.0" encoding="utf-8"?>
<manifest
xmlns:android="http://schemas.android.com/apk/res/android"
package="com.myapp.package">
<!-- permissões padrão -->
<uses-permission android:name="android.permission.INTERNET" />
<uses-permission android:name="android.permission.ACCESS_WIFI_STATE" />
<uses-permission android:name="android.permission.ACCESS_NETWORK_STATE" />
<uses-permission android:name="android.permission.ACCESS_FINE_LOCATION" />
...
<application>
...
</application>
</manifest> |
Adicionar um arquivo de configuração
Qualquer configuração que o SDK necessite no momento da inicialização do seu aplicativo deve estar localizada em um arquivo de configuração dentro do seu projeto. Este arquivo deve ser incluído dentro do diretório assets e deve ser um arquivo JSON chamado fluigSDKConfiguration.
É possível criar mais de um arquivo de configuração, caso esteja desenvolvendo para outros clientes com customizações, contanto é necessário a criação de flavors em seu projeto. Neste caso cada arquivo deverá ficar no diretório assets de cada flavor criado.
Atualmente a principal função deste arquivo é fornecer as chaves responsáveis pela renovação do token de acesso às APIs do fluig. Para criar as chaves que serão fornecidas no arquivo de configuração, siga os passos descritos em Criar Usuário Aplicativo.
O exemplo abaixo demonstra como deve ser a formatação do arquivo JSON.
Bloco de código |
---|
language | js |
---|
title | fluigSDKConfiguration.json |
---|
|
{
"Authentication": [{
"Protocol": "OAuth1",
"ConsumerKey": "<my_consumer_key>",
"ConsumerSecret": "<my_consumer_secret>"
}],
"applications": [tipo1, tipo2] (opcional, através deste parâmetro o aplicativo direciona o login do identity para conexões específicas, ex: learning),
"showAdvancedAccess": true (opcional, este parâmetro habilita ou desabilita a opção de acesso avançado da tela de Login
} |
Nota |
---|
|
As chaves deste arquivo são case sensitive. |
Habilitando o SDK
Para que o SDK inicialize as configurações fornecidas no passo anterior, é necessária a criação de uma classe de aplicação customizada que extenda de FluigSdkApplication
. Esta classe é reponsável por iniciar todas as principais funções do SDK no momento que seu aplicativo iniciar. Segue abaixo um exemplo de como ficará essa classe de aplicação.
Bloco de código |
---|
language | java |
---|
title | Application.java |
---|
|
import sdk.fluig.com.bll.core.base.view.application;
public class Application extends FluigSdkApplication {
@Override
public void onCreate() {
super.onCreate();
...
}
} |
Ao criar uma classe de aplicação dentro do seu projeto, é necessário também informar no AndroidManifest.xml
o nome da classe criada. No exemplo abaixo, o nome informado será .application.Application
pois foi o nome escolhido foi Application
localizado dentro do pacote application
.
Bloco de código |
---|
language | xml |
---|
title | AndroidManifest.xml |
---|
|
<?xml version="1.0" encoding="utf-8"?>
<manifest
xmlns:android="http://schemas.android.com/apk/res/android"
package="com.myapp.package">
<application
android:name=".application.Application"
android:label="@string/app_name"
... >
...
</application>
</manifest> |
Utilizar o fluxo de login
Este passo é opcional mas altamente recomendado devido a complexidade do fluxo de login. Acesse a documentação e obtenha todas as informações necessárias para adicionar este recurso ao seu projeto.
Nota |
---|
|
Para a chamadas das APIs do fluig, é necessário autenticação na plataforma. |
Informações |
---|
|
Esta versão do SDK Android é válida a partir da atualização 1.6.1 do fluig. Se você utiliza uma atualização anterior, ela pode conter informações diferentes das quais você vê no seu projeto |
...