Ir para o conteúdo

Referências, repositórios e apps de exemplo

Esta é uma lista de documentação de referência, repositórios GitHub e apps de exemplo pertencentes a cada SDK da Braze. A documentação de referência de um SDK detalha suas classes, tipos, funções e variáveis disponíveis. O repositório GitHub fornece insight sobre as declarações de funções e atributos desse SDK, alterações de código e controle de versão. Cada repositório também inclui aplicativos de exemplo totalmente compiláveis que você pode usar para testar os recursos da Braze ou implementar junto com seus próprios aplicativos.

Para conteúdo de README de repositórios espelhados na documentação, consulte Guias de repositório.

Lista de recursos

Plataforma Referência Repositório App de exemplo
Android SDK Documentação de referência Repositório GitHub App de exemplo
Swift SDK Documentação de referência Repositório GitHub App de exemplo
Web SDK Documentação de referência Repositório GitHub App de exemplo
Javascript SDK Documentação de referência Repositório GitHub N/A
Cordova SDK Arquivo de declaração Repositório GitHub App de exemplo
Flutter SDK Documentação de referência Repositório GitHub App de exemplo
React Native SDK Documentação de referência Repositório GitHub App de exemplo
Vega SDK Documentação de referência Repositório GitHub N/A
Roku SDK N/A Repositório GitHub App de exemplo
Unity SDK Arquivo de declaração Repositório GitHub App de exemplo
.NET MAUI SDK (anteriormente Xamarin) N/A Repositório GitHub App de exemplo

Compilando um app de exemplo

Compilando o “Droidboy”

Nosso aplicativo de teste dentro do repositório GitHub do Android SDK se chama Droidboy. Siga estas instruções para compilar uma cópia totalmente funcional dele junto com seu projeto.

  1. Crie um novo espaço de trabalho e anote a chave identificadora da API da Braze.

  2. Copie o ID do remetente do FCM e a chave identificadora da API da Braze nos locais apropriados em /droidboy/res/values/braze.xml (entre as tags das strings chamadas com_braze_push_fcm_sender_id e com_braze_api_key, respectivamente).

  3. Copie a chave do servidor e o ID do servidor do FCM nas configurações do seu espaço de trabalho em Manage Settings.

  4. Para montar o APK do Droidboy, execute ./gradlew assemble dentro do diretório do SDK. Use gradlew.bat no Windows.

  5. Para instalar automaticamente o APK do Droidboy em um dispositivo de teste, execute ./gradlew installDebug dentro do diretório do SDK:

Compilando o “Hello Braze”

O aplicativo de teste Hello Braze mostra um caso de uso mínimo do SDK da Braze e também demonstra como integrar facilmente o SDK da Braze em um projeto Gradle.

  1. Copie sua chave identificadora de API da página Manage Settings para o arquivo braze.xml na pasta res/values. Captura de tela relacionada à compilação do "Hello Braze".

  2. Para instalar o app de exemplo em um dispositivo ou emulador, execute o seguinte comando dentro do diretório do SDK:
    ./gradlew installDebug
    

    Se você não tiver a variável ANDROID_HOME configurada corretamente ou não tiver uma pasta local.properties com uma pasta sdk.dir válida, este plugin também instalará o SDK base para você. Consulte o repositório do plugin para saber mais.

Para saber mais sobre o sistema de compilação do Android SDK, consulte o README do repositório GitHub.

Compilando apps de teste Swift

Siga estas instruções para compilar e executar nossos aplicativos de teste.

  1. Crie um novo espaço de trabalho e anote a chave de API do identificador do app e o endpoint.
  2. Com base no seu método de integração (Swift Package Manager, CocoaPods, manual), selecione o arquivo xcodeproj apropriado para abrir.
  3. Insira sua chave de API e seu endpoint no campo apropriado no arquivo Credentials.
New Stuff!