Referências, repositórios e aplicativos de exemplo
Esta é uma lista de documentação de referência, repositórios do GitHub e aplicativos de exemplo pertencentes a cada SDK Braze. A documentação de referência de um SDK detalha suas classes, tipos, funções e variáveis disponíveis. Enquanto o repositório do GitHub fornece insights sobre as declarações de funções e atributos desse SDK, alterações de código e versionamento. Cada repositório também inclui aplicativos de exemplo totalmente construíveis que você pode usar para testar os recursos do Braze ou implementar ao lado de seus próprios aplicativos.
Lista de recursos
Atualmente, alguns SDKs não têm documentação de referência dedicada—mas estamos trabalhando ativamente nisso.
| Plataforma | Referência | Repositório | App de amostra |
|---|---|---|---|
| Android SDK | Documentação de referência | Repositório do GitHub | App de amostra |
| SWIFT SDK | Documentação de referência | Repositório do GitHub | App de amostra |
| SDK da Web | Documentação de referência | Repositório do GitHub | App de amostra |
| Cordova SDK | Arquivo de Declaração | Repositório do GitHub | App de amostra |
| SDK para Flutter | Documentação de referência | Repositório do GitHub | App de amostra |
| SDK React Native | Arquivo de Declaração | Repositório do GitHub | App de amostra |
| Roku SDK | N/D | Repositório do GitHub | App de amostra |
| Unity SDK | Arquivo de declaração | Repositório do GitHub | App de amostra |
| .NET MAUI SDK (anteriormente Xamarin) | N/D | Repositório do GitHub | App de amostra |
Construindo um aplicativo de exemplo
Construindo “Droidboy”
Nosso aplicativo de teste no repositório do Android SDK GitHub é chamado Droidboy. Siga estas instruções para criar uma cópia totalmente funcional dela em seu projeto.
- Crie um novo espaço de trabalho e note a chave de identificação da API do Braze.
- Copie seu ID de remetente FCM e a chave de identificação da API do Braze nos locais apropriados em
/droidboy/res/values/braze.xml(entre as tags das strings denominadascom_braze_push_fcm_sender_idecom_braze_api_key, respectivamente). - Copie a chave do servidor FCM e o ID do servidor nas configurações do espaço de trabalho em Gerenciar configurações.
- Para montar o APK do Droidboy, execute
./gradlew assembleno diretório do SDK. Usegradlew.batno Windows. - Para instalar automaticamente o APK do Droidboy em um dispositivo de teste, execute
./gradlew installDebugno diretório do SDK:
Construindo “Hello Braze”
O aplicativo de teste Hello Braze mostra um caso de uso mínimo do SDK da Braze e, além disso, mostra como integrar facilmente o SDK da Braze em um projeto Gradle.
- Copie sua chave de identificador de API da página Manage Settings em seu arquivo
braze.xmlna pastares/values.
- Para instalar o app de amostra em um dispositivo ou emulador, execute o seguinte comando no diretório do SDK:
1
./gradlew installDebug
Se você não tiver a variável
ANDROID_HOMEdefinida corretamente ou não tiver uma pastalocal.propertiescom uma pastasdk.dirválida, esse plug-in também instalará o SDK básico para você. Consulte o repositório de plug-ins para obter mais informações.
Para saber mais sobre o sistema de compilação do Android SDK, consulte o LEIAME do repositório do GitHub.
Construindo aplicativos de teste Swift
Siga estas instruções para criar e executar nossos aplicativos de teste.
- Crie um novo espaço de trabalho e note a chave de API do identificador do app e o ponto de extremidade.
- Com base em seu método de integração (Swift Package Manager, CocoaPods, Manual), selecione o arquivo
xcodeprojapropriado para abrir. - Coloque sua chave de API e seu endpoint no campo apropriado no arquivo
Credentials.
Ao realizar QA na sua integração de SDK, use o SDK Debugger para solucionar problemas sem ativar o registro detalhado para o seu app.
Editar esta página no GitHub