Unity
Cross-platform SDK guide for Unity-based mobile apps.
React Native & Expo
Setup instructions for React Native and Expo environments.
Flutter
SDK guide for Flutter apps using Dart.
Ionic & Ionic Capacitor
Setup for Ionic and Capacitor hybrid mobile apps.
.NET MAUI
Guide for integrating with .NET MAUI apps.
Huawei Android Native
SDK setup for Huawei devices using HMS push services.
Select and press **Next**.
Configure the Widget Extension by providing a name (example: `OneSignalWidget`) and ensure **Include Live Activity** is selected. Then click **Finish**.
Click **Don't Activate** if prompted to activate the scheme.
Open your `Podfile` and add the following code. Replace `OneSignalWidgetExtension` with the name of your widget extension target.
```ruby Podfile theme={null}
target 'OneSignalWidgetExtension' do
#use_frameworks!
pod 'OneSignalXCFramework', '>= 5.0.0', '< 6.0'
end
```
Close Xcode and run `pod repo update && pod install` to install the `OneSignalLiveActivities` pod.
Update the contents of *WidgetExtensionLiveActivity.swift* with the following default Live Activity layout. The values in this Widget can be changed to whatever you'd like displayed on the widget, the setupDefault method will handle defining the struct for these attributes.
```swift Swift theme={null}
import ActivityKit
import WidgetKit
import SwiftUI
import OneSignalLiveActivities
// Your struct name might be different here
@available(iOS 16.2, *)
struct OneSignalWidgetLiveActivity: Widget {
var body: some WidgetConfiguration {
ActivityConfiguration(for: DefaultLiveActivityAttributes.self) { context in
// Lock screen / banner UI
VStack {
Spacer()
Text("Title: " + (context.attributes.data["title"]?.asString() ?? ""))
.font(.headline)
Spacer()
HStack {
Spacer()
Text(context.state.data["message"]?.asDict()?["en"]?.asString() ?? "Default Message")
Spacer()
}
Text("INT: " + String(context.state.data["intValue"]?.asInt() ?? 0))
Text("DBL: " + String(context.state.data["doubleValue"]?.asDouble() ?? 0.0))
Text("BOL: " + String(context.state.data["boolValue"]?.asBool() ?? false))
Spacer()
}
.activitySystemActionForegroundColor(.black)
.activityBackgroundTint(.white)
} dynamicIsland: { _ in
DynamicIsland {
// Expanded UI
DynamicIslandExpandedRegion(.leading) {
Text("Leading")
}
DynamicIslandExpandedRegion(.trailing) {
Text("Trailing")
}
DynamicIslandExpandedRegion(.bottom) {
Text("Bottom")
// More content
}
} compactLeading: {
Text("L")
} compactTrailing: {
Text("T")
} minimal: {
Text("Min")
}
.widgetURL(URL(string: "http://www.apple.com"))
.keylineTint(Color.red)
}
}
}
```
***
## Test the Live Activity
1. Start the app
2. See all possible fields in our [Start Live Activity API reference](/reference/start-live-activity). The structure of these fields might differ depending on how you've set up your UI. For example :
* `"event_updates"`: This is the dynamic data that can be updated after the Live Activity has been started (anything after `context.state` in the code example). Since we have context.state.data we would add a data object to this field and any additional fields within like the message dictionary we have added in the code example. For usage, see example request below.
* `"event_attributes"`: This is the static data that is set in the push to start request, and remains the same value until the Live Activity is removed or overwritten.
3. When using push to start, you set the `"activity_id"` in the request, rather than in the code. Using different Activity ID's will start new Live Activities. Using the same Activity ID will overwrite the widget that is currently using that ID.
4. Ensure that you've changed the [OneSignal App ID](./keys-and-ids) in your url path, and the [App API key](./keys-and-ids) in the Authorization header. The `DefaultActivityAttributes` type cannot be changed if you are using the default setup. Please also note, the activity type added to your path is case sensitive and should match what is defined either by you or the Default activity used in the example below.
```curl curl theme={null}
curl --request POST \
--url https://api.onesignal.com/apps/YOUR_APP_ID/activities/activity/DefaultLiveActivityAttributes \
--header 'Authorization: key YOUR_REST_API_KEY' \
--header 'Content-Type: application/json' \
--header 'accept: application/json' \
--data '
{
"event": "start",
"event_updates": {
"data": {
"message": {
"en": "The message is nested in context.state.data[\"message\"] as a dictionary"
},
"intValue": 10,
"doubleValue": 3.14,
"boolValue": true
}
},
"event_attributes": {
"data": {
"title": "this is set when the LA starts and does not get updated after"
}
},
"activity_id": "my-activity-id",
"name": "OneSignal Notification Name",
"contents": {
"en": "English Message"
},
"headings": {
"en": "English Message"
},
"sound": "beep.wav",
"priority": 10
}'
```
***
## Low-level methods
These are optional methods to use if you want to generate your own Push To Start token, which has also been added in the latest release of the SDK. Using these methods requires that you interact with Xcode more, and generate your own token for Push To Start with Swift. You can find a guide on this [here](https://github.com/OneSignal/OneSignal-iOS-SDK/pull/1377#:~:text=Alternative%20\(low%20level\)%20method%20to%20setup%20Live%20Activities%20with%20OneSignal).