Struct UpdateLiveActivityRequest 

pub struct UpdateLiveActivityRequest {
    pub name: String,
    pub event: EventType,
    pub event_updates: Value,
    pub contents: Option<Box<LanguageStringMap>>,
    pub headings: Option<Box<LanguageStringMap>>,
    pub sound: Option<String>,
    pub ios_sound: Option<String>,
    pub stale_date: Option<i32>,
    pub dismissal_date: Option<i32>,
    pub priority: Option<i32>,
    pub ios_relevance_score: Option<f32>,
}

Fields

name: String

An internal name to assist with your campaign organization. This does not get displayed in the message itself.

event: EventType

event_updates: Value

This must match the ContentState interface you have defined within your Live Activity in your app.

contents: Option<Box<LanguageStringMap>>

headings: Option<Box<LanguageStringMap>>

sound: Option<String>

Deprecated. The API ignores this field. Use ios_sound.

ios_sound: Option<String>

Sound file that is included in your app to play instead of the default device notification sound. Omit to disable vibration and sound for the notification. Requires headings on the same request: ActivityKit ignores an update whose alert has no title, which silently drops the sound. Supersedes the deprecated sound field.

stale_date: Option<i32>

Accepts Unix timestamp in seconds. When time reaches the configured stale date, the system considers the Live Activity out of date, and the ActivityState of the Live Activity changes to ActivityState.stale.

dismissal_date: Option<i32>

Accepts Unix timestamp in seconds; only allowed if event is "end"

priority: Option<i32>

Delivery priority through the push provider (APNs). Pass 10 for higher priority notifications, or 5 for lower priority notifications. Lower priority notifications are sent based on the power considerations of the end user’s device. If not set, defaults to 10. Some providers (APNs) allow for a limited budget of high priority notifications per hour, and if that budget is exceeded, the provider may throttle notification delivery.

ios_relevance_score: Option<f32>

A value between 0 and 1. When more than one Live Activity is active for your app, the one with the highest relevance score shows in the Dynamic Island. If the scores are equal, the system shows the Live Activity that started first. The score also sets the order of Live Activities on the Lock Screen. Only available on iOS 16.2 and later.

Implementations

impl UpdateLiveActivityRequest

pub fn new( name: String, event: EventType, event_updates: Value, ) -> UpdateLiveActivityRequest

Trait Implementations

impl Clone for UpdateLiveActivityRequest

fn clone(&self) -> UpdateLiveActivityRequest

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for UpdateLiveActivityRequest

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Default for UpdateLiveActivityRequest

fn default() -> UpdateLiveActivityRequest

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for UpdateLiveActivityRequest

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl PartialEq for UpdateLiveActivityRequest

fn eq(&self, other: &UpdateLiveActivityRequest) -> bool

Equality operator ==.

fn ne(&self, other: &Rhs) -> bool

Inequality operator !=.

impl Serialize for UpdateLiveActivityRequest

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for UpdateLiveActivityRequest