Module Values.PushAPNSMessageTemplateContentSource

The content of the push message template that applies to APNS (Apple Push Notification service) notification service.

Sourcetype nonrec t = {
  1. title : NonEmptyUnlimitedString.t option;
    (*

    The title to use in a push notification that's based on the message template. This title appears above the notification message on a recipient's device.

    *)
  2. body : MessageTemplateBodyContentProvider.t option;
    (*

    The message body to use in a push notification that is based on the message template.

    *)
  3. action : PushMessageAction.t option;
    (*

    The action to occur if a recipient taps a push notification that is based on the message template. Valid values are: OPEN_APP - Your app opens or it becomes the foreground app if it was sent to the background. This is the default action. DEEP_LINK - Your app opens and displays a designated user interface in the app. This action uses the deep-linking features of the iOS platform. URL - The default mobile browser on the recipient's device opens and loads the web page at a URL that you specify.

    *)
  4. sound : NonEmptyUnlimitedString.t option;
    (*

    The key for the sound to play when the recipient receives a push notification that's based on the message template. The value for this key is the name of a sound file in your app's main bundle or the Library/Sounds folder in your app's data container. If the sound file can't be found or you specify default for the value, the system plays the default alert sound.

    *)
  5. url : NonEmptyUnlimitedString.t option;
    (*

    The URL to open in a recipient's default mobile browser, if a recipient taps a push notification that's based on the message template and the value of the action property is URL.

    *)
  6. mediaUrl : NonEmptyUnlimitedString.t option;
    (*

    The URL of an image or video to display in push notifications that are based on the message template.

    *)
  7. rawContent : MessageTemplateBodyContentProvider.t option;
    (*

    The raw, JSON-formatted string to use as the payload for a push notification that's based on the message template. If specified, this value overrides all other content for the message template.

    *)
}
Sourceval make : ?title:??? -> ?body:??? -> ?action:??? -> ?sound:??? -> ?url:??? -> ?mediaUrl:??? -> ?rawContent:??? -> unit -> t
Sourceval to_value : t -> [> `Structure of (string * [> `Enum of string | `String of NonEmptyUnlimitedString.t | `Structure of (string * [> `String of NonEmptyUnlimitedString.t ]) list ]) list ]
Sourceval to_query : t -> Awso.Client.Query.t
Sourceval of_xml : Awso.Xml.t -> t
Sourceval of_string : string -> t
Sourceval of_json : Yojson.Safe.t -> t
Sourceval to_json : t -> Yojson.Safe.t