Struct onesignal_rust_api::models::notification_target::NotificationTarget

pub struct NotificationTarget {
    pub included_segments: Option<Vec<String>>,
    pub excluded_segments: Option<Vec<String>>,
    pub include_player_ids: Option<Vec<String>>,
    pub include_external_user_ids: Option<Vec<String>>,
    pub include_email_tokens: Option<Vec<String>>,
    pub include_phone_numbers: Option<Vec<String>>,
    pub include_ios_tokens: Option<Vec<String>>,
    pub include_wp_wns_uris: Option<Vec<String>>,
    pub include_amazon_reg_ids: Option<Vec<String>>,
    pub include_chrome_reg_ids: Option<Vec<String>>,
    pub include_chrome_web_reg_ids: Option<Vec<String>>,
    pub include_android_reg_ids: Option<Vec<String>>,
}

Fields

included_segments: Option<Vec<String>>

The segment names you want to target. Users in these segments will receive a notification. This targeting parameter is only compatible with excluded_segments. Example: ["Active Users", "Inactive Users"]

excluded_segments: Option<Vec<String>>

Segment that will be excluded when sending. Users in these segments will not receive a notification, even if they were included in included_segments. This targeting parameter is only compatible with included_segments. Example: ["Active Users", "Inactive Users"]

include_player_ids: Option<Vec<String>>

Specific playerids to send your notification to. _Does not require API Auth Key. Do not combine with other targeting parameters. Not compatible with any other targeting parameters. Example: ["1dd608f2-c6a1-11e3-851d-000c2940e62c"] Limit of 2,000 entries per REST API call

include_external_user_ids: Option<Vec<String>>

Target specific devices by custom user IDs assigned via API. Not compatible with any other targeting parameters Example: ["custom-id-assigned-by-api"] REQUIRED: REST API Key Authentication Limit of 2,000 entries per REST API call. Note: If targeting push, email, or sms subscribers with same ids, use with channel_for_external_user_ids to indicate you are sending a push or email or sms.

include_email_tokens: Option<Vec<String>>

Recommended for Sending Emails - Target specific email addresses. If an email does not correspond to an existing user, a new user will be created. Example: nick@catfac.ts Limit of 2,000 entries per REST API call

include_phone_numbers: Option<Vec<String>>

Recommended for Sending SMS - Target specific phone numbers. The phone number should be in the E.164 format. Phone number should be an existing subscriber on OneSignal. Refer our docs to learn how to add phone numbers to OneSignal. Example phone number: +1999999999 Limit of 2,000 entries per REST API call

include_ios_tokens: Option<Vec<String>>

Not Recommended: Please consider using include_player_ids or include_external_user_ids instead. Target using iOS device tokens. Warning: Only works with Production tokens. All non-alphanumeric characters must be removed from each token. If a token does not correspond to an existing user, a new user will be created. Example: ce777617da7f548fe7a9ab6febb56cf39fba6d38203… Limit of 2,000 entries per REST API call

include_wp_wns_uris: Option<Vec<String>>

Not Recommended: Please consider using include_player_ids or include_external_user_ids instead. Target using Windows URIs. If a token does not correspond to an existing user, a new user will be created. Example: http://s.notify.live.net/u/1/bn1/HmQAAACPaLDr-… Limit of 2,000 entries per REST API call

include_amazon_reg_ids: Option<Vec<String>>

Not Recommended: Please consider using include_player_ids or include_external_user_ids instead. Target using Amazon ADM registration IDs. If a token does not correspond to an existing user, a new user will be created. Example: amzn1.adm-registration.v1.XpvSSUk0Rc3hTVVV… Limit of 2,000 entries per REST API call

include_chrome_reg_ids: Option<Vec<String>>

Not Recommended: Please consider using include_player_ids or include_external_user_ids instead. Target using Chrome App registration IDs. If a token does not correspond to an existing user, a new user will be created. Example: APA91bEeiUeSukAAUdnw3O2RB45FWlSpgJ7Ji_… Limit of 2,000 entries per REST API call

include_chrome_web_reg_ids: Option<Vec<String>>

Not Recommended: Please consider using include_player_ids or include_external_user_ids instead. Target using Chrome Web Push registration IDs. If a token does not correspond to an existing user, a new user will be created. Example: APA91bEeiUeSukAAUdnw3O2RB45FWlSpgJ7Ji_… Limit of 2,000 entries per REST API call

include_android_reg_ids: Option<Vec<String>>

Not Recommended: Please consider using include_player_ids or include_external_user_ids instead. Target using Android device registration IDs. If a token does not correspond to an existing user, a new user will be created. Example: APA91bEeiUeSukAAUdnw3O2RB45FWlSpgJ7Ji_… Limit of 2,000 entries per REST API call

Implementations

impl NotificationTarget

pub fn new() -> NotificationTarget

Trait Implementations

impl Clone for NotificationTarget

fn clone(&self) -> NotificationTarget

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for NotificationTarget

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

Formats the value using the given formatter.

impl Default for NotificationTarget

fn default() -> NotificationTarget

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for NotificationTarget

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>where
    __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl PartialEq<NotificationTarget> for NotificationTarget

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

This method tests for self and other values to be equal, and is used by ==.

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

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Serialize for NotificationTarget

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 NotificationTarget