Network.Join

Documentation

newtype APIKey

API Key for the account

Constructors

APIKey

Fields

• unAPIKey :: Text

Instances

Eq APIKey

Methods

(==) :: APIKey -> APIKey -> Bool

(/=) :: APIKey -> APIKey -> Bool

Ord APIKey

Methods

compare :: APIKey -> APIKey -> Ordering

(<) :: APIKey -> APIKey -> Bool

(<=) :: APIKey -> APIKey -> Bool

(>) :: APIKey -> APIKey -> Bool

(>=) :: APIKey -> APIKey -> Bool

max :: APIKey -> APIKey -> APIKey

min :: APIKey -> APIKey -> APIKey

Show APIKey

Methods

showsPrec :: Int -> APIKey -> ShowS

show :: APIKey -> String

showList :: [APIKey] -> ShowS

IsString APIKey

Methods

fromString :: String -> APIKey

newtype DeviceId

Device ID to send the message to/through

Constructors

DeviceId

Fields

• unDeviceId :: Text

Instances

Eq DeviceId

Methods

(==) :: DeviceId -> DeviceId -> Bool

(/=) :: DeviceId -> DeviceId -> Bool

Ord DeviceId

Methods

compare :: DeviceId -> DeviceId -> Ordering

(<) :: DeviceId -> DeviceId -> Bool

(<=) :: DeviceId -> DeviceId -> Bool

(>) :: DeviceId -> DeviceId -> Bool

(>=) :: DeviceId -> DeviceId -> Bool

max :: DeviceId -> DeviceId -> DeviceId

min :: DeviceId -> DeviceId -> DeviceId

Show DeviceId

Methods

showsPrec :: Int -> DeviceId -> ShowS

show :: DeviceId -> String

showList :: [DeviceId] -> ShowS

IsString DeviceId

Methods

fromString :: String -> DeviceId

data SMS

SMS Message with phone number to send the message to

Constructors

SMS

Fields

• smsNumber :: Text
• smsText :: Text

Instances

Eq SMS

Methods

(==) :: SMS -> SMS -> Bool

(/=) :: SMS -> SMS -> Bool

Ord SMS

Methods

compare :: SMS -> SMS -> Ordering

(<) :: SMS -> SMS -> Bool

(<=) :: SMS -> SMS -> Bool

(>) :: SMS -> SMS -> Bool

(>=) :: SMS -> SMS -> Bool

max :: SMS -> SMS -> SMS

min :: SMS -> SMS -> SMS

Show SMS

Methods

showsPrec :: Int -> SMS -> ShowS

show :: SMS -> String

showList :: [SMS] -> ShowS

sendSMS :: APIKey -> DeviceId -> SMS -> IO JoinResponse

Send an SMS from the given device. If the device doesn't allow join to send SMS, there will be an error in the response

sendPush :: APIKey -> DeviceId -> Text -> IO JoinResponse

Send a push notification to a given device