Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[BD-2667] Gif Support for all wrappers #7846

Merged
merged 1 commit into from
Aug 12, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Original file line number Diff line number Diff line change
Expand Up @@ -27,3 +27,7 @@ You can use these additional methods to build a custom Content Cards Feed within
|`logContentCardImpression(cardId)`|Logs an impression for the given Content Card ID.|
|`logContentCardDismissed(cardId)`|Logs a dismissal for the given Content Card ID.|
{: .reset-td-br-1 .reset-td-br-2}

## GIF Support

{% multi_lang_include wrappers/gif_support/content_cards.md %}
Original file line number Diff line number Diff line change
Expand Up @@ -14,6 +14,10 @@ page_order: 6

By default the Cordova SDK supports in-app messages with no changes. See the [Android]({{site.baseurl}}/developer_guide/platform_integration_guides/android/in-app_messaging/integration/) or [iOS]({{site.baseurl}}/developer_guide/platform_integration_guides/swift/in-app_messaging/overview/) integration examples for information on customizing in-app messages. Furthermore, you can look at the [sample Cordova application](https://github.com/braze-inc/braze-cordova-sdk/blob/master/sample-project/www/js/index.js) or the sample [Android](https://github.com/braze-inc/braze-android-sdk) or [iOS](https://github.com/braze-inc/braze-swift-sdk) application for implementation samples.

### GIF Support

{% multi_lang_include wrappers/gif_support/in_app_messaging.md %}

## News Feed

{% alert note %}
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -92,6 +92,9 @@ Follow these steps to test a sample Content Card.

For more details on each platform, follow the [Android integration][5] or [iOS integration][6] guides.

## GIF Support

{% multi_lang_include wrappers/gif_support/content_cards.md %}

[3]: {{site.baseurl}}/user_guide/message_building_by_channel/content_cards/create
[4]: {% image_buster /assets/img/react-native/content-card-test.png %} "Content Card Campaign Test"
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -139,6 +139,10 @@ Follow these steps to test a sample in-app message.
3. Compose your test in-app messaging campaign and head over to the **Test** tab. Add the same `user-id` as the test user and click **Send Test**.
4. Tap the push notification and that should display the in-app message on your device.

## GIF Support

{% multi_lang_include wrappers/gif_support/in_app_messaging.md %}

![A Braze in-app message campaign showing you can add your own user ID as a test recipient to test your in-app message.][2]

[1]: {{site.baseurl}}/user_guide/message_building_by_channel/in-app_messages/create/
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -152,16 +152,7 @@ For a full reference of the control card, see the [Android][18] and [iOS][19] do

## GIF Support

The Braze React Native SDK allows you to incorporate animated GIFs into your Content Cards, with distinct implementation methods for Android and iOS platforms.

{% tabs %}
{% tab Android %}
The Android SDK requires an external image library to display animated GIFs with Content Cards. For more details, refer to the guide for [GIFs]({{site.baseurl}}/developer_guide/platform_integration_guides/android/content_cards/GIFs/).
{% endtab %}
{% tab iOS %}
The Swift SDK does not provide animated GIF support by default. Support can be added by wrapping a third party or your own view in an instance of `GIFViewProvider`. For more details on GIF support, refer to the tutorial for [GIF Support](https://braze-inc.github.io/braze-swift-sdk/tutorials/braze/c3-gif-support/).
{% endtab %}
{% endtabs %}
{% multi_lang_include wrappers/gif_support/content_cards.md %}

[1]: https://github.com/braze-inc/braze-react-native-sdk
[2]: {{site.baseurl}}/developer_guide/platform_integration_guides/android/content_cards/data_models/
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -216,16 +216,7 @@ For a full reference of button model, see the [Android][12] and [iOS][13] docume

## GIF Support

The Braze React Native SDK allows you to incorporate animated GIFs into your in-app messages, with distinct implementation methods for Android and iOS platforms.

{% tabs %}
{% tab Android %}
On the Android SDK, HTML in-app messages support displaying animated GIFs by default. For all other in-app messages, a custom image library is required. For more details, refer to the guide for [GIFs]({{site.baseurl}}/developer_guide/platform_integration_guides/android/in-app_messaging/customization/gifs/).
{% endtab %}
{% tab iOS %}
On the Swift SDK, all Braze in-app messages support displaying animated GIFs by default. For more details, refer to the tutorial for [GIF Support](https://braze-inc.github.io/braze-swift-sdk/tutorials/braze/c3-gif-support).
{% endtab %}
{% endtabs %}
{% multi_lang_include wrappers/gif_support/in_app_messaging.md %}

[1]: {{site.baseurl}}/developer_guide/platform_integration_guides/android/in-app_messaging/customization/custom_listeners/#custom-manager-listener
[2]: {{site.baseurl}}/developer_guide/platform_integration_guides/android/in-app_messaging/customization/custom_listeners/#step-1-implement-an-in-app-message-manager-listener
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -81,6 +81,10 @@ AppboyBinding.RequestContentCardsRefresh()
AppboyBinding.RequestContentCardsRefreshFromCache()
```

## GIF Support

{% multi_lang_include wrappers/gif_support/content_cards.md %}

## Analytics

Clicks and impressions must be manually logged for Content Cards not displayed directly by Braze.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -86,6 +86,10 @@ void InAppMessageReceivedCallback(string message) {
}
```

## GIF Support

{% multi_lang_include wrappers/gif_support/in_app_messaging.md %}

## Analytics

Clicks and impressions must be manually logged for in-app messages not displayed directly by Braze.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -101,6 +101,10 @@ Classic cards have a title, description, and an optional image on the left of th

For a full reference of the classic (text announcement) Content Card, see the [Android][9] and [iOS][10] documentation. For a full reference of the classic image (short news) card, see the [Android][11] and [iOS][12] documentation.

## GIF Support

{% multi_lang_include wrappers/gif_support/content_cards.md %}

[1]: {{site.baseurl}}/developer_guide/platform_integration_guides/android/content_cards/data_models/
[2]: {{site.baseurl}}/developer_guide/platform_integration_guides/swift/content_cards/integration/
[3]: https://braze-inc.github.io/braze-android-sdk/kdoc/braze-android-sdk/com.braze.models.cards/-card/index.html
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -115,3 +115,7 @@ braze.InAppMessagePresenter = inAppMessageUI;
Now you can present new in-app messages using Braze's default in-app message UI.
{% endtab %}
{% endtabs %}

## GIF Support

{% multi_lang_include wrappers/gif_support/in_app_messaging.md %}
9 changes: 9 additions & 0 deletions _includes/wrappers/gif_support/content_cards.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
{% tabs %}
{% tab Android %}
By default, the native [Braze Android SDK](https://github.com/braze-inc/braze-android-sdk) does not provide animated GIF support for Content Cards—however, you can use a third-party image library to display GIFs instead. For more information, see [Android Content Cards: GIFs]({{site.baseurl}}/developer_guide/platform_integration_guides/android/content_cards/GIFs/).
{% endtab %}

{% tab iOS %}
By default, the [Braze Swift SDK](https://github.com/braze-inc/braze-swift-sdk) does not provide animated GIF support for Content Cards—however, you can wrap your own view or a third-party view in an instance of [`GIFViewProvider`](https://braze-inc.github.io/braze-swift-sdk/documentation/brazeui/gifviewprovider). For a full walkthrough, see [Tutorial: GIF Support for Swift Content Cards](https://braze-inc.github.io/braze-swift-sdk/tutorials/braze/c3-gif-support/).
{% endtab %}
{% endtabs %}
11 changes: 11 additions & 0 deletions _includes/wrappers/gif_support/in_app_messaging.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
{% tabs %}
{% tab Android %}
You can add animated GIFs to your in-app messages using the native [Braze Android SDK](https://github.com/braze-inc/braze-android-sdk). By default, the Android SDK uses HTML in-app messages to display GIFs.

For all other in-app message types, you'll need to use a custom image library. To learn more, see [Android In-App Messaging: GIFs]({{site.baseurl}}/developer_guide/platform_integration_guides/android/in-app_messaging/customization/gifs/).
{% endtab %}

{% tab iOS %}
You can add animated GIFs to your in-app messages using the native [Braze Swift SDK](https://github.com/braze-inc/braze-swift-sdk). By default, all Braze in-app messages support GIFs. For a full walkthrough, see [Tutorial: GIF Support for Swift In-App Messages](https://braze-inc.github.io/braze-swift-sdk/tutorials/braze/c3-gif-support).
{% endtab %}
{% endtabs %}