ZapbirdDocs

zapbird.yaml

The settings file for your own app build.

zapbird.yaml lives in your project folder. It holds what your store build needs: the app name and the permissions your code uses, each with a reason in your words.

zapbird.yaml
app:  name: My Apppermissions:  camera:    reason: Take a photo for your profile picture.  microphone:    reason: Record sound for your videos.

#app

KeyWhat it does
nameThe name under the app icon. Leave it out to keep the one in the project.

#permissions

Each key is a permission id, such as camera, microphone, photos, location, bluetooth, contacts, notifications, push, biometrics, speech, nfc, vibration, internet or sign_in_with_apple. Its value is a map with a reason, or true when iOS shows no reason.

  • iOS shows the reason when it asks the user, and Apple rejects vague ones.
  • A reason that starts with TODO: is skipped by config apply and flagged by config check.
  • Some permissions need setup only you can do, such as turning on a capability in Xcode.

#ios and android

Anything else is written into the files as it is:

zapbird.yaml
ios:  info_plist:    LSApplicationQueriesSchemes: [https]android:  permissions: [WAKE_LOCK]

See config and Prepare a store build.

Was this doc helpful?

Zapbird sends no analytics. Read about security.

Flutter and the related logo are trademarks of Google LLC. Zapbird is not endorsed by or affiliated with Google LLC.

esc