Ana içeriğe atla

Kurulum ve hata ayıklama

Bu metodlar, OneSignal SDK’sını uygulamanıza entegre etmek için bir referanstır. Platforma özel tam kurulum talimatları için Mobil SDK kurulumu sayfasına bakın.

initialize()

OneSignal SDK’sını başlatır. Bu, uygulama başlangıcında çağrılmalıdır. ONESIGNAL_APP_ID, Anahtarlar ve Kimlikler bölümünde bulunabilir.
OneSignal SDK’sının başlatılmasını geciktirmek istiyorsanız, Gizlilik metodlarımızı kullanmanızı öneririz.
OneSignal.initWithContext(this, ONESIGNAL_APP_ID)

setLogLevel()

Android LogCat veya Xcode günlüklerine ek günlükler yazdırmak için günlük kaydını ayarlar. Bunu OneSignal’i başlatmadan önce çağırın. Daha fazla ayrıntı için Hata Ayıklama Günlüğü Alma sayfasına bakın.
// LogLevel: .None | .Fatal | .Error | .Warn | .Info | .Debug | .Verbose
OneSignal.Debug.logLevel = LogLevel.Verbose

setAlertLevel()

Uygulamanızda uyarı diyalogları olarak gösterilecek günlük kaydı seviyesini ayarlar. Bunu uygulama mağazasına göndermeden önce kaldırdığınızdan emin olun.
OneSignal.Debug.alertLevel = LogLevel.Exception

Kullanıcı kimliği ve özellikleri

Kullanıcılar uygulamanızı açtığında, OneSignal otomatik olarak bir OneSignal ID (kullanıcı seviyesi) ve bir Abonelik ID’si (cihaz seviyesi) oluşturur. Benzersiz kullanıcı tanımlayıcınızla login() metodunu çağırarak birden fazla aboneliği (örneğin, cihazlar, e-postalar, telefon numaraları) tek bir kullanıcıyla ilişkilendirebilirsiniz.
Daha fazla ayrıntı için Kullanıcılar ve Takma Adlar sayfalarına bakın.

login(external_id)

Kullanıcı bağlamını sağlanan external_id’ye ayarlar. Bu external_id ile ilişkili tüm aboneliklerin ve özelliklerin tek bir onesignal_id altında birleştirilmesini sağlar. Daha fazla ayrıntı için Kullanıcılar sayfasına bakın. Ana davranışlar:
  • external_id zaten mevcutsa, SDK o kullanıcıya geçer. Oturum açmadan önce toplanan anonim veriler birleştirilmez ve atılır.
  • external_id mevcut değilse, yerel durum mevcut onesignal_id altında kaydedilir. Kullanıcı anonim durumdayken toplanan tüm veriler saklanır.
  • SDK, ağ hatası veya sunucu hatası durumunda otomatik olarak yeniden dener.
Harici Kimliğin ayarlandığından ve aboneliğin kullanıcıya bağlı olduğundan emin olmak için kullanıcı uygulamayı her açtığında bu metodu çağırın.
OneSignal.login("external_id")

logout()

Mevcut kullanıcıyı abonelikten ayırır.
  • Mevcut push aboneliğinden external_id’yi kaldırır.
  • OneSignal ID’sini yeni bir anonim kullanıcıya sıfırlar.
  • Artık tüm yeni veriler (örneğin etiketler, Abonelikler, oturum verileri vb.) login metoduyla tanımlanana kadar yeni anonim kullanıcı üzerinde ayarlanacaktır.
Aboneliği yeni bir anonim kullanıcıya ayarlamak istiyorsanız, kullanıcı uygulamanızdan çıkış yaptığında bunu kullanın.
OneSignal.logout()

getOnesignalId()

Cihazda yerel olarak kaydedilmiş mevcut kullanıcının OneSignal ID’sini alır. Kullanıcı durumu başlatılmadan önce çağrılırsa null olabilir. Bunun yerine, kullanıcı durumu değişikliklerini dinlemek için Kullanıcı Durumu addObserver() kullanın.
val id = OneSignal.User.onesignalId

getExternalId()

Cihazda yerel olarak kaydedilmiş mevcut kullanıcının Harici Kimliğini alır. login metodu aracılığıyla ayarlanmadıysa veya kullanıcı durumu başlatılmadan önce çağrılırsa null olabilir. Bunun yerine, kullanıcı durumu değişikliklerini dinlemek için Kullanıcı Durumu addObserver() kullanın.
  val id = OneSignal.User.externalId

addObserver() kullanıcı durumu

Kullanıcı bağlamındaki değişiklikleri dinler (örneğin, oturum açma, oturum kapatma, kimlik ataması).
OneSignal.User.addObserver(object : IUserStateObserver {
    override fun onUserStateChange(state: UserChangedState) {
        println("User State Changed: onesignalId=${state.current.onesignalId}, externalId=${state.current.externalId}")
    }
})

addAlias(), addAliases(), removeAlias(), removeAliases()

Takma adlar alternatif tanımlayıcılardır (kullanıcı adları veya CRM kimlikleri gibi).
  • Takma ad eklemeden önce login() ile external_id’yi ayarlayın. external_id olmayan aboneliklere eklenen takma adlar birden fazla abonelik arasında senkronize olmaz.
  • Ayrıntılar için Takma Adlar sayfasına bakın.
// Add a single alias
OneSignal.User.addAlias("ALIAS_LABEL", "ALIAS_ID")

// Add multiple aliases
var aliases = mapOf("ALIAS_LABEL_01" to "ALIAS_ID_01", "ALIAS_LABEL_02" to "ALIAS_ID_02")
OneSignal.User.addAliases(aliases)

// Remove a single alias
OneSignal.User.removeAlias("ALIAS_LABEL")

// Remove multiple aliases
OneSignal.User.removeAliases(["ALIAS_LABEL_01", "ALIAS_LABEL_02"])

setLanguage()

Kullanıcının otomatik olarak algılanan dilini geçersiz kılar. ISO 639-1 dil kodunu kullanın.
OneSignal.User.setLanguage("en")

Özel etkinlikler

Özel bir etkinlik aracılığıyla Yolculukları Tetikleme ve Bekle Adımı aktivasyonu.
Özel etkinlikler hala beta aşamasındadır ve uygulamanızdan tetiklenmesi için SDK’nın aşağıdaki sürümlerini gerektirir:
  • iOS yerel SDK, 5.4.0-alpha-01 sürümünden itibaren kullanılabilir
  • Android yerel SDK, 5.3.0-alpha-01 sürümünden itibaren kullanılabilir
  • React-native SDK, 5.3.0-beta-01 sürümünden itibaren kullanılabilir
  • Flutter SDK, 5.4.0-beta-01 sürümünden itibaren kullanılabilir
  • Unity SDK, 5.2.0-beta-01 sürümünden itibaren kullanılabilir
Mevcut kullanıcı tarafından gerçekleştirilen özel bir etkinliği izleyin ve gönderin.
  • name - Gerekli. Etkinliğin adı string olarak.
  • properties - İsteğe bağlı. Etkinliğe eklenecek anahtar-değer çiftleri. Özellikler sözlüğü veya haritası geçerli bir JSON Nesnesine serileştirilebilir olmalıdır. İç içe değerleri destekler.
SDK, tüketilebilir olacak ayrılmış os_sdk anahtarı altında uygulamaya özel verileri özelliklere otomatik olarak dahil eder. Örneğin, etkinlikleri cihaz türüne göre hedeflemek için os_sdk.device_type değerine erişirsiniz.
json
{ 
  "os_sdk": { 
    "sdk": "050213", 
    "device_os": "18.5", 
    "type": "iOSPush", 
    "device_model": "iPhone14,4", 
    "device_type": "ios", 
    "app_version": "5.4.0" 
  }
}

trackEvent()

Daha fazla ayrıntı için Özel Etkinlikler sayfasına bakın.
// Track an event, by name, without additional properties
OneSignal.User.trackEvent("my_event_name")

// Track an event, by name, with additional properties
OneSignal.User.trackEvent(
   name = "started_free_trial",
   properties = mapOf(
       "promo_code" to "NEW50",
       "membership_details" to mapOf(
           "vip" to true,
           "products_viewed_count" to 15
       )
   )
)

Veri etiketleri

Etiketler, olaylara veya kullanıcı özelliklerine göre kullanıcılar üzerinde ayarladığınız özel anahtar : değer çiftleri string verileridir. Daha fazla ayrıntı için Veri Etiketleri sayfasına bakın.

addTag(), addTags()

Mevcut kullanıcıya tek veya birden fazla etiket ayarlar.
  • Anahtar zaten mevcutsa değerler değiştirilir.
  • Planınızın etiket sınırını aşmak işlemlerin sessizce başarısız olmasına neden olur.
OneSignal.User.addTag("KEY", "VALUE")

OneSignal.User.addTags(mapOf("KEY_01" to "VALUE_01", "KEY_02" to "VALUE_02"))

removeTag(), removeTags()

Mevcut kullanıcıdan tek veya birden fazla etiketi siler.
OneSignal.User.removeTag("KEY")

OneSignal.User.removeTags(listOf("KEY_01", "KEY_02"))

getTags()

Kullanıcının etiketlerinin yerel kopyasını döndürür. Etiketler login() veya yeni uygulama oturumları sırasında sunucudan güncellenir.
val tags: Map<String, String> = OneSignal.User.getTags()

Gizlilik

setConsentRequired()

Veri toplama başlamadan önce kullanıcı onayını zorunlu kılar. SDK’yı başlatmadan önce çağrılmalıdır.
OneSignal.consentRequired = true

setConsentGiven()

Veri toplama için kullanıcı onayını verir veya iptal eder. Onay olmadan OneSignal’e hiçbir veri gönderilmez ve hiçbir abonelik oluşturulmaz.
  • setConsentRequired() true ise, SDK’mız setConsentGiven true ile çağrılana kadar tam olarak etkinleştirilmez.
  • setConsentGiven true olarak ayarlanmışsa ve bir Abonelik oluşturulmuşsa, daha sonra false olarak ayarlanırsa, bu Abonelik artık güncellemeler almaz. Bu Abonelik için mevcut veriler, setConsentGiven tekrar true olarak ayarlanana kadar değişmeden kalır.
  • Kullanıcı ve/veya Abonelik verilerini silmek istiyorsanız, Kullanıcıyı sil veya Aboneliği sil API’lerimizi kullanın.
OneSignal.consentGiven = true

Konum

Konum noktalarını izlemek 3 adım gerektirir:
  1. Uygulamanıza konum izleme izinleri ve bağımlılıkları ekleyin.
Aşağıdaki hataları alabilirsiniz:
LocationManager.startGetLocation: mümkün değil, konum bağımlılığı bulunamadı
Uygulamanızın bağımlılıklarını kontrol edin. Yaygın bir çözüm app/build.gradle dosyanıza şunu eklemektir: implementation 'com.google.android.gms:play-services-location:21.0.1'
  1. Location.setShared() metodunu kullanarak uygulamanızın OneSignal ile konum paylaşmasını etkinleştirin.
  2. Location.requestPermission metoduyla veya uygulama içi mesajları kullanarak kullanıcıdan konum izleme izni isteyin.

setShared() konum

SDK’mızın Aboneliğin enlem ve boylamını izlemeye başlamasına izin vermek için bu metodu kullanın. Önce uygulamanızda uygun konum izinlerini ayarladığınızdan emin olun.
// Enable your app to share location with OneSignal
OneSignal.Location.isShared = true

// Returns true if your app is sharing location with OneSignal
var isShared: Boolean = OneSignal.isShared

requestPermission() konum

Kullanıcılarınıza sistem düzeyinde konum izni istemini göstermek için bu metodu kullanın veya bunun yerine uygulama içi mesajları kullanın. Uygulamanızda uygun konum izinlerini ayarladığınızdan ve uygulamanızın OneSignal ile konum paylaşmasını etkinleştirdiğinizden emin olun.
// Request location tracking permissions
OneSignal.Location.requestPermission(true)

Abonelikler

Daha fazla ayrıntı için Abonelikler sayfasına bakın.

User.pushSubscription.id

Cihazda yerel olarak kaydedilmiş mevcut kullanıcının push Abonelik Kimliğini alır. Çok erken çağrılırsa null döndürebilir. Değişikliklere tepki vermek için bu veriyi abonelik gözlemcisi içinde almanız önerilir.
val id = OneSignal.User.pushSubscription.id

User.pushSubscription.token

Mevcut push abonelik belirtecini döndürür. Çok erken çağrılırsa null döndürebilir. Değişikliklere tepki vermek için bu veriyi abonelik gözlemcisi içinde almanız önerilir.
val pushToken = OneSignal.User.pushSubscription.token

addObserver() push abonelik değişiklikleri

Şu gibi push abonelik değişikliklerine yanıt vermek için bu metodu kullanın:
  • Cihaz Google (FCM) veya Apple (APNs)‘den yeni bir push belirteci alır
  • OneSignal bir abonelik kimliği atar
  • optedIn değeri değişir (örneğin optIn() veya optOut() çağrıldı)
  • Kullanıcı sistem ayarlarında push iznini değiştirir, ardından uygulamayı açar
Bu olduğunda, SDK onPushSubscriptionChange olayını tetikler. Dinleyiciniz, neyin tam olarak değiştiğini tespit edebilmeniz için previous ve current değerlerini içeren bir durum nesnesi alır. Güncellemeleri dinlemeyi durdurmak için ilişkili removeObserver() veya removeEventListener() metodunu çağırın.
class MyObserver : IPushSubscriptionObserver {
  init {
    OneSignal.User.pushSubscription.addObserver(this)
  }

  override fun onPushSubscriptionChange(state: PushSubscriptionChangedState) {
    if (state.current.optedIn) {
      println("User is now opted-in with push token: ${state.current.token}")
    }
  }
}

// Remove the observer
OneSignal.User.pushSubscription.removeObserver(this)

optOut(), optIn(), optedIn

Mevcut push Aboneliğinin abonelik durumunu (abone olundu veya abonelikten çıkıldı) kontrol eder. Uygulamanızda push abonelik durumunu kontrol etmek için bu metodları kullanın. Yaygın kullanım durumları: 1) Oturumu kapatan kullanıcılara push gönderilmesini önleyin. 2) Uygulamanızda bir bildirim tercih merkezi uygulayın.
  • optOut(): Mevcut push abonelik durumunu abonelikten çıkıldı olarak ayarlar (kullanıcının geçerli bir push belirteci olsa bile).
  • optIn(): Üç eylemden birini yapar:
    1. Aboneliğin geçerli bir push belirteci varsa, mevcut push abonelik durumunu abone olundu olarak ayarlar.
    2. Aboneliğin geçerli bir push belirteci yoksa, push izin istemini görüntüler.
    3. Push izin istemi işletim sisteminin sınırından fazla görüntülendiyse (iOS’ta bir kez, Android’de iki kez), yedek istemi görüntüler.

Ayarlar istemine geri dönüş

  • optedIn: Mevcut push abonelik durumu abone olundu ise true döndürür, aksi takdirde false. Push belirteci geçerliyse ancak optOut() çağrıldıysa, bu false döndürür.
OneSignal.User.pushSubscription.optOut()

OneSignal.User.pushSubscription.optIn()

val optedIn = OneSignal.User.pushSubscription.optedIn

addEmail(), removeEmail()

Mevcut kullanıcıya/kullanıcıdan bir e-posta Aboneliği (e-posta adresi) ekler veya kaldırır. Doğru kullanıcı bağlamını ayarlamak için login() sonrasında addEmail çağırın. Kimlik Doğrulama ile uyumludur.
OneSignal.User.addEmail("example@email.com")

OneSignal.User.removeEmail("example@email.com")

addSms(), removeSms()

Mevcut kullanıcıya/kullanıcıdan bir SMS Aboneliği (telefon numarası) ekler veya kaldırır. E.164 formatı gerektirir. Doğru kullanıcı bağlamını ayarlamak için login() sonrasında addSms çağırın. Kimlik Doğrulama ile uyumludur.
OneSignal.User.addSms("+15558675309")

OneSignal.User.removeSms("+15558675309")

Push izinleri

requestPermission(fallbackToSettings) push

Kullanıcıdan push bildirim izni isteyen yerel sistem istemini gösterir. İsteğe bağlı olarak ayarlar uygulamasına bağlantı veren bir yedek istem etkinleştirin.
  • fallbackToSettings: true ise, kullanıcı işletim sisteminin sınırından fazla push izinlerini reddettiyse (iOS’ta bir kez, Android’de iki kez) yedek istem görüntülenir.

İzin engellendiğinde ayarlara geri dönüş istemi

Daha fazla bilgi için Push İzinleri için İstem sayfasına bakın.
// We recommend removing this method after testing and instead use In-App Messages to prompt for notification permission.
// Passing true will fallback to setting prompt if the user denies push permissions
OneSignal.Notifications.requestPermission(true)

addPermissionObserver() push

Şu gibi push izin değişikliklerini izlemek için bu metodu kullanın:
  • Bildirim izin istemi kullanıcıya görüntülenir.
  • Kullanıcı izin istemini kabul eder veya reddeder.
  • Kullanıcı cihazın uygulama ayarlarında uygulamanız için bildirimleri etkinleştirir veya devre dışı bırakır ve ardından uygulamanıza geri döner.
Bu olduğunda, SDK onOSPermissionChanged olayını tetikler. Dinleyiciniz, neyin tam olarak değiştiğini tespit edebilmeniz için from ve to değerlerini içeren bir durum nesnesi alır. Güncellemeleri dinlemeyi durdurmak için ilişkili removePermissionObserver() metodunu çağırın.
class MyObserver : IPermissionObserver {
  init {
    OneSignal.Notifications.addPermissionObserver(this)
  }

  override fun onNotificationPermissionChange(granted: Boolean) {
    if (granted) {
      // Notifications are now enabled
    }
  }

  fun cleanup() {
    OneSignal.Notifications.removePermissionObserver(this)
  }
}

getPermission(), getCanRequestPermission()

getPermission(), uygulama düzeyinde mevcut push izin durumunu döndürür. Kullanıcılar ve Abonelikler API’lerinde optOut() veya enabled parametresi aracılığıyla değiştirdiyseniz OneSignal düzeyinde abonelik durumunu dikkate almaz. getPermission() kullanmak yerine, uygulama çalışırken cihazın bildirim izin durumundaki değişiklikleri izlemek için Push İzin Gözlemcisini veya push abonelik durumundaki değişiklikleri izlemek için Push Abonelik Gözlemcisini kullanmanızı öneririz. getCanRequestPermission(), izin isteme girişiminin kullanıcıya bir istemin gösterilmesiyle sonuçlanıp sonuçlanmayacağını döndürür. false ise, kullanıcı zaten izni reddetmiştir ve ya yedek istem gösterilebilir ya da hiç istem gösterilmez. Daha fazla bilgi için Push izinleri için istem sayfasına bakın.
// true if the app has permission to display notifications
OneSignal.Notifications.permission

// true if the device can display system notification permission prompt
val canRequest: Boolean = OneSignal.Notifications.canRequestPermission

permissionNative iOS

iOS cihazının yerel izni için bir enum döndürür. Şunlardan biri olacaktır:
  • 0 = NotDetermined (Belirlenmedi)
  • 1 = Denied (Reddedildi)
  • 2 = Authorized (Yetkilendirildi)
  • 3 = Provisional (yalnızca iOS 12+ sürümlerinde kullanılabilir)
  • 4 = Ephemeral (yalnızca iOS 14+ sürümlerinde kullanılabilir)
let permissionNative: OSNotificationPermission = OneSignal.Notifications.permissionNative.rawValue

Push bildirim olayları

addClickListener() push

Kullanıcı uygulamayı açan bir push bildirimine tıkladığında çalışan bir geri çağırma ayarlar. Bu olay tetiklendiğinde uygulamanın etkinliği veya sahnesi zaten başlatılmıştır. Herhangi bir özel mantık gerçekleştirmek için bu işleyiciyi kullanın — uygulama navigasyonunu manuel olarak yeniden başlatmayın veya çoğaltmayın. İşleyici artık gerekmediğinde dinlemeyi durdurmak için removeClickListener() veya removeEventListener() kullanın.
val clickListener = object : INotificationClickListener {
  override fun onClick(event: INotificationClickEvent) {
    Log.d("OneSignal", "Notification clicked: ${event.notification.title}")
  }
}
OneSignal.Notifications.addClickListener(clickListener)

addForegroundLifecycleListener() push

Uygulama ön planda olduğunda bildirimlerin nasıl davrandığını kesmenize ve kontrol etmenize olanak tanır. Varsayılan olarak, OneSignal bildirimi otomatik olarak görüntüler. Bu davranışı event.preventDefault() kullanarak geçersiz kılabilir ve şunları yapabilirsiniz:
  • Bildirimi bastırma
  • Özelleştirme
  • Eşzamansız mantık için görüntülemeyi geciktirme (örneğin, kullanıcı durumunu alma, olayları kaydetme)
Daha sonra manuel olarak göstermek için event.notification.display() çağırın.
Bu, görüntülemeden önce yükü değiştiren Bildirim Hizmeti Uzantılarından sonra çalışır.
İşleyici artık gerekmediğinde dinlemeyi durdurmak için removeForegroundLifecycleListener() veya removeEventListener() kullanın.
val lifecycleListener = object : INotificationLifecycleListener {
  override fun onWillDisplay(event: INotificationWillDisplayEvent) {
    Log.d("OneSignal", "Foreground notification: ${event.notification.title}")
    // Uncomment to prevent the notification from being displayed while in the foreground
    // event.preventDefault()
  }
}
OneSignal.Notifications.addForegroundLifecycleListener(lifecycleListener)

clearAllNotifications()

Removes all OneSignal notifications from the Notification Shade. Use instead of Android’s android.app.NotificationManager.cancel. Otherwise, the notifications will be restored when your app is restarted.
OneSignal.Notifications.clearAllNotifications()

removeNotification() Android

Android bildirim kimliğine dayalı olarak tek bir bildirimi iptal eder. Android’in android.app.NotificationManager.cancel yerine kullanın. Aksi takdirde, uygulamanız yeniden başlatıldığında bildirim geri yüklenecektir.
OneSignal.Notifications.removeNotification(id)

removeGroupedNotifications() Android

Cancel a group of OneSignal notifications with the provided group key. Grouping notifications is a OneSignal concept. There is no android.app.NotificationManager equivalent.
OneSignal.Notifications.removeGroupedNotifications("GROUP_KEY")

Uygulama İçi Mesajlar

Uygulama içi mesajlar herhangi bir kod gerektirmez; ancak SDK, mesajların ne zaman sunulacağını özelleştirmenize ve yaşam döngüsü olaylarını yönetmenize olanak tanır.

addTrigger(), addTriggers()

Tek veya birden fazla tetikleyiciye dayalı olarak bir Uygulama İçi Mesajın ne zaman görüntüleneceğine karar verin. Daha fazla bilgi için Tetikleyiciler sayfasına bakın. Tetikleyiciler arka uca kalıcı olarak kaydedilmez. Yalnızca yerel cihazda bulunurlar ve mevcut kullanıcı için geçerlidir.
OneSignal.InAppMessages.addTrigger("KEY", "VALUE")

OneSignal.InAppMessages.addTriggers(mapOf("KEY_01" to "VALUE_01", "KEY_02" to "VALUE_02"))

removeTrigger(), removeTriggers(), clearTriggers()

Sağlanan anahtarla mevcut kullanıcıdan tek, birden fazla veya tüm tetikleyicileri kaldırır.
OneSignal.InAppMessages.removeTrigger("KEY")

OneSignal.InAppMessages.removeTriggers(setOf("KEY_01", "KEY_02"))

OneSignal.InAppMessages.clearTriggers()

paused

Uygulama içi mesajların kullanıcıya görüntülenmesini engeller. true olarak ayarlandığında, hiçbir uygulama içi mesaj sunulmaz. false olarak ayarlandığında, kullanıcının uygun olduğu herhangi bir mesaj uygun zamanda kendilerine sunulur.
OneSignal.InAppMessages.paused = true

addLifecycleListener()

Görüntülenen ve kapatılan Uygulama İçi Mesajlara yanıt verir veya bunları izler.
val lifecycleListener = object : IInAppMessageLifecycleListener {
  override fun onWillDisplay(event: IInAppMessageWillDisplayEvent) {
    print(event.message.messageId)
  }

  override fun onDidDisplay(event: IInAppMessageDidDisplayEvent) {
    print(event.message.messageId)
  }

  override fun onWillDismiss(event: IInAppMessageWillDismissEvent) {
    print(event.message.messageId)
  }

  override fun onDidDismiss(event: IInAppMessageDidDismissEvent) {
    print(event.message.messageId)
  }
}
OneSignal.InAppMessages.addLifecycleListener(lifecycleListener)
OneSignal.InAppMessages.removeLifecycleListener(lifecycleListener)

addClickListener() uygulama-içi

Uygulama içi mesaj tıklama olaylarına yanıt verir. Olay aşağıdaki tıklama eylemi meta verilerini içerir:
  • actionId: Öğe üzerinde ayarladığınız özel bir tanımlayıcı.
  • urlTarget: Mesaj için başlatma URL’sinin nasıl sunulacağını belirten bir enum.
  • url: Eylem için başlatma URL’si, varsa.
  • closingMessage: Eylemin mesajın kapatılmasına neden olup olmadığını gösteren bir boolean değeri.
val clickListener = object : IInAppMessageClickListener {
  override fun onClick(event: IInAppMessageClickEvent) {
    print(event.result.actionId)
  }
}
OneSignal.InAppMessages.addClickListener(clickListener)

Canlı Aktivite

Uygulamalar, kullanıcıların Canlı Aktivitelere katılmalarına izin vermelidir. Örneğin, uygulamanız kullanıcıya bir düğme kullanarak veya bir IAM sunarak ABD içinde Canlı Aktiviteyi başlatma seçeneği sunar. Bildirim İzni veya Konum İzninin aksine, açık bir istem olmadan herhangi bir yöntemle bir Canlı Aktivite başlatabilir ve güncelleyebilirsiniz. Canlı Aktiviteler iOS Geçici Yetkilendirme kullanıcı arayüzü ile görünür. Canlı Aktiviteler, uygulamanız ön plandayken başlatılmalıdır. Canlı Aktiviteler hakkında daha fazla bilgi edinmek için Apple’ın geliştirici yönergelerini okumanızı öneririz.

setup()

OneSignal’in uygulama adına bir LiveActivity yaşam döngüsünü yönetmesine izin verir. Bu, hem pushToStart belirteç güncellemelerini hem de pushToUpdate belirteç güncellemelerini dinlemeyi içerir.
//... your app's code
OneSignal.LiveActivities.setup(MyWidgetAttributes.self);

setupDefault()

Müşteri uygulamasının kendi ActivityAttributes’ını tanımlama ve yönetme ihtiyacını ortadan kaldırarak platformlar arası SDK’ların bir LiveActivity yaşam döngüsünü yönetmesine izin verir. Daha fazla ayrıntı için Platformlar arası kurulum sayfasına bakın.
using OneSignalSDK;

//Push To Start
OneSignal.LiveActivities.SetupDefault();

//Launching the Live Activity from within the app (not needed for push to start)
string activityId = "my_activity_id";

OneSignal.LiveActivities.StartDefault(
  activityId,
  new Dictionary<string, object>() {
      { "title", "Welcome!" }
  },
  new Dictionary<string, object>() {
      { "message", new Dictionary<string, object>() {
          { "en", "Hello World!"}
      }},
  });

enter()

Bir Canlı Aktiviteye girme, sunucumuzda bir activityId’yi bir Canlı Aktivite Geçici Push Belirteci ile ilişkilendirir. Bir veya birden fazla Canlı Aktiviteyi aynı anda güncellemek için Canlı Aktiviteleri Güncelle REST API’sini kullanırken bu tanımlayıcıyı belirtin.
// ... your app's code
let activity = try Activity<MyWidgetAttributes>.request(
  attributes: attributes,
  contentState: contentState,
  pushType: .token)
Task {
  for await data in activity.pushTokenUpdates {
      let token = data.map {String(format: "%02x", $0)}.joined()
      // ... required code for entering a live activity
      // Activity ID cannot contain "/" characters
      OneSignal.LiveActivities.enter("ACTIVITY_ID", withToken: token)
  }
}

exit()

Bir Canlı aktiviteden çıkma, sunucumuzda bir Aktivite Tanımlayıcısı ile Canlı Aktivite push belirteci arasındaki ilişkiyi siler.
OneSignal.LiveActivities.exit("ACTIVITY_ID")

setPushToStartToken()

Canlı aktiviteleri başlatmak için push için isteğe bağlı “düşük seviyeli” yaklaşım. ActivityAttribute yapısını değiştirmeden LiveActivity başlatma ve güncelleme belirteçleri üzerinde hassas kontrol sunar. Ek ayrıntılar burada mevcuttur
if #available(iOS 17.2, *) {
  // Setup an async task to monitor and send pushToStartToken updates to OneSignalSDK.
  Task {
      for try await data in Activity<MyWidgetAttributes>.pushToStartTokenUpdates {
          let token = data.map {String(format: "%02x", $0)}.joined()
          OneSignal.LiveActivities.setPushToStartToken(MyWidgetAttributes.self, withToken: token)
      }
  }
  // Setup an async task to monitor for an activity to be started, for each started activity we
  // can then set up an async task to monitor and send updateToken updates to OneSignalSDK.
  Task {
      for await activity in Activity<MyWidgetAttributes>.activityUpdates {
        Task {
            for await pushToken in activity.pushTokenUpdates {
                let token = pushToken.map {String(format: "%02x", $0)}.joined()
                OneSignal.LiveActivities.enter("my-activity-id", withToken: token)
            }
        }
      }
  }
}

removePushToStartToken()

Bu aktivite türü artık mevcut aboneliğe karşı kaydedilmemesi gerektiğinde aktivite türü başına çağrılır
OneSignal.LiveActivities.removePushToStartToken(MyWidgetAttributes.self)

Sonuçlar

Kullanıcılar tarafından gerçekleştirilen eylemleri izleyin ve bunları mesajlara atfedin. Daha fazla ayrıntı için Sonuçlar sayfasına bakın.

addOutcome()

Sağlanan adla mevcut oturuma karşı yakalanan bir sonuç ekler.
OneSignal.Session.addOutcome("OUTCOME_NAME")

addUniqueOutcome()

Sağlanan adla mevcut oturuma karşı yakalanan benzersiz bir sonuç ekler.
OneSignal.Session.addUniqueOutcome("OUTCOME_NAME")

addOutcomeWithValue()

Sağlanan ad ve değerle mevcut oturuma karşı yakalanan bir sonuç ekler.
OneSignal.Session.addOutcomeWithValue("OUTCOME_NAME", 3.14)