Siftsciex

v0.5.0

Siftsciex v0.5.0 Siftsciex.Event.Payload.App View Source

A Sift Science App type for the Event API.

Link to this section Summary

Types

attribute()
data()
t()

Functions

new(app_data)

Creates a new App object for a Sift Science Event

Link to this section Types

Link to this type attribute() View Source 
attribute() ::
  :os
  | :os_version
  | :device_manufacturer
  | :device_model
  | :device_unique_id
  | :app_name
  | :app_version
Link to this type data() View Source 
data() :: %{optional(attribute()) => String.t()}
Link to this type t() View Source 
t() :: %Siftsciex.Event.Payload.App{
  "$app_name": Siftsciex.Event.Payload.payload_string(),
  "$app_version": Siftsciex.Event.Payload.payload_string(),
  "$device_manufacturer": Siftsciex.Event.Payload.payload_string(),
  "$device_model": Siftsciex.Event.Payload.payload_string(),
  "$device_unique_id": Siftsciex.Event.Payload.payload_string(),
  "$os": Siftsciex.Event.Payload.payload_string(),
  "$os_version": Siftsciex.Event.Payload.payload_string()
}

Link to this section Functions

Link to this function new(app_data) View Source 
new(data()) :: Siftsciex.Event.Payload.App.t()

Creates a new App object for a Sift Science Event.

Parameters

  • app_data: The data for the application context which is being reported, there are several available attributes:

    • :os
    • :os_version
    • :device_manufacturer
    • :device_model
    • :device_unique_id
    • :app_name
    • :app_version

Examples 

iex> App.new(%{os: "iOS", os_version: "10.3", app_name: "Test"})
%App{"$os": "iOS", "$os_version": "10.3", "$app_name": "Test"}