Skip to content

examples.rst

Latest commit

 

History

History
120 lines (90 loc) · 2.93 KB

examples.rst

File metadata and controls

120 lines (90 loc) · 2.93 KB

Examples

Common setup:

import urbanairship as ua
airship = ua.Airship(app_key, master_secret)

Simple broadcast to all devices

push = airship.create_push()
push.audience = ua.all_
push.notification = ua.notification(alert="Hello, world!")
push.device_types = ua.all_
push.send()

Complex audience with platform specifics

push = airship.create_push()
push.audience = ua.and_(
   ua.tag("breakingnews"),
   ua.or_(
      ua.tag("sports"),
      ua.tag("worldnews")
   )
)
push.notification = ua.notification(
   ios=ua.ios(
      alert="Kim Jong-Un wins U.S. Open",
      badge="+1",
      extra={"articleid": "123456"}
   ),
   android=ua.android(
      alert="Breaking Android News! Glorious Leader Kim Jong-Un wins U.S. Open!",
      extra={"articleid": "http://m.example.com/123456"}
   ),
   amazon=ua.amazon(
   alert='Breaking Amazon News!',
   expires_after=60,
   extra={'articleid': '12345'},
   summary='This is a short message summary',
   )
)
push.device_types = ua.device_types('ios', 'android', 'amazon')
push.send()

Single iOS push

push = airship.create_push()
push.audience = ua.ios_channel('074e84a2-9ed9-4eee-9ca4-cc597bfdbef3')
push.notification = ua.notification(
    ios=ua.ios(alert="Kim Jong-Un is following you on Twitter")
)
push.device_types = ua.device_types('ios')
push.send()

Single iOS Rich Push with notification

push = airship.create_push()
push.audience = ua.ios_channel('074e84a2-9ed9-4eee-9ca4-cc597bfdbef3')
push.notification = ua.notification(
    ios=ua.ios(alert="Kim Jong-Un is following you on Twitter")
)
push.device_types = ua.device_types('ios')
push.message = ua.message("New follower", "<h1>OMG It's Kim Jong-Un</h1>")
push.send()

Rich Push with extra and without notification

push = airship.create_push()
push.audience = ua.all_
push.device_types = ua.all_
push.message = ua.message(
   title="New follower",
   body="<h1>OMG It's Kim Jong-Un</h1>",
   extra={"articleid": "http://m.example.com/123456"}
)
push.send()

Scheduled iOS Push

import datetime

sched = airship.create_scheduled_push()
sched.schedule = ua.scheduled_time(
   datetime.datetime(2013, 10, 10, 2, 45))

sched.push = airship.create_push()
sched.push.audience = ua.ios_channel('074e84a2-9ed9-4eee-9ca4-cc597bfdbef3')
sched.push.notification = ua.notification(
    ios=ua.ios(alert="Kim Jong-Un is following you on Twitter"))
sched.push.device_types = ua.device_types('ios')

sched.send()