Safe Haskell	None
Language	Haskell2010

FCMClient.Types

Description

Google Firebase Cloud Messaging model / JSON conversions. https://firebase.google.com/docs/cloud-messaging/http-server-ref

This module re-exports JSON types with a few convenience wrappers around selected fields.

Models are constructed with lenses, starting with a default value, e.g: >>> encode (def & fcmBody ?~ "fcm body") "{"body":"fcm body"}"

Synopsis

module Control.Lens
decode :: FromJSON a => ByteString -> Maybe a
encode :: ToJSON a => a -> ByteString
module Data.Default.Class
data Scientific
data FCMNotification
type FCMData = Map Text Text
fcmAndroidChannelId :: Lens' FCMNotification (Maybe Text)
fcmBadge :: Lens' FCMNotification (Maybe Text)
fcmBody :: Lens' FCMNotification (Maybe Text)
fcmBodyLocKey :: Lens' FCMNotification (Maybe Text)
fcmClickAction :: Lens' FCMNotification (Maybe Text)
fcmColor :: Lens' FCMNotification (Maybe Text)
fcmIcon :: Lens' FCMNotification (Maybe Text)
fcmSound :: Lens' FCMNotification (Maybe Text)
fcmTag :: Lens' FCMNotification (Maybe Text)
fcmTitle :: Lens' FCMNotification (Maybe Text)
fcmTitleLocKey :: Lens' FCMNotification (Maybe Text)
data FCMMessage
fcmCollapseKey :: Lens' FCMMessage (Maybe Text)
fcmCondition :: Lens' FCMMessage (Maybe Text)
fcmData :: Lens' FCMMessage (Maybe FCMData)
fcmNotification :: Lens' FCMMessage (Maybe FCMNotification)
fcmRegistrationIds :: Lens' FCMMessage (Maybe (NonEmpty Text))
fcmRestrictedPackageName :: Lens' FCMMessage (Maybe Text)
fcmTimeToLive :: Lens' FCMMessage (Maybe Word)
fcmTo :: Lens' FCMMessage (Maybe Text)
data FCMMessageResponseResultOk
data FCMError
- = FCMErrorDeviceMessageRate
- | FCMErrorInternalServerError
- | FCMErrorInvalidDataKey
- | FCMErrorInvalidPackageName
- | FCMErrorInvalidRegistration
- | FCMErrorInvalidTtl
- | FCMErrorMessageTooBig
- | FCMErrorMismatchSenderId
- | FCMErrorMissingRegistration
- | FCMErrorNotRegistered
- | FCMErrorTopicsMessageRate
- | FCMErrorUnavailable
- | FCMErrorOther Text
fcmMessageId :: Lens' FCMMessageResponseResultOk Text
fcmRegistrationId :: Lens' FCMMessageResponseResultOk (Maybe Text)
data FCMMessageResponseResult
- = FCMMessageResponseResultOk !FCMMessageResponseResultOk
- | FCMMessageResponseResultError !FCMError
data FCMMessageResponse
_FCMMessageResponseResultOk :: Prism' FCMMessageResponseResult FCMMessageResponseResultOk
_FCMMessageResponseResultError :: Prism' FCMMessageResponseResult FCMError
fcmCanonicalIds :: Lens' FCMMessageResponse Integer
fcmFailure :: Lens' FCMMessageResponse Integer
fcmMulticastId :: Lens' FCMMessageResponse Integer
fcmResults :: Lens' FCMMessageResponse (Maybe (NonEmpty FCMMessageResponseResult))
fcmSuccess :: Lens' FCMMessageResponse Integer
data FCMTopicResponseOk
fcmTopicMessageId :: Iso' FCMTopicResponseOk Integer
data FCMTopicResponse
- = FCMTopicResponseOk !FCMTopicResponseOk
- | FCMTopicResponseError !FCMError
data FCMResponseBody
- = FCMMessageResponse !FCMMessageResponse
- | FCMTopicResponse !FCMTopicResponse
_FCMTopicResponseOk :: Prism' FCMTopicResponse FCMTopicResponseOk
_FCMTopicResponseError :: Prism' FCMTopicResponse FCMError
data FCMClientError
- = FCMErrorResponseInvalidJSON !Text
- | FCMErrorResponseInvalidAuth
- | FCMServerError !Status !Text
- | FCMClientJSONError !Text
- | FCMClientHTTPError !Text
_FCMMessageResponse :: Prism' FCMResponseBody FCMMessageResponse
_FCMTopicResponse :: Prism' FCMResponseBody FCMTopicResponse
fcmErrorHttpStatus :: Traversal' FCMClientError Status
fcmErrorMessage :: Traversal' FCMClientError Text
data FCMResult
- = FCMResultSuccess !FCMResponseBody
- | FCMResultError !FCMClientError
_FCMErrorResponseInvalidJSON :: Prism' FCMClientError Text
_FCMErrorResponseInvalidAuth :: Prism' FCMClientError ()
_FCMServerError :: Prism' FCMClientError (Status, Text)
_FCMClientJSONError :: Prism' FCMClientError Text
_FCMClientHTTPError :: Prism' FCMClientError Text
_FCMResultSuccess :: Prism' FCMResult FCMResponseBody
_FCMResultError :: Prism' FCMResult FCMClientError
data FCMLocValue
- = FCMLocString !Text
- | FCMLocNumber !Scientific
- | FCMLocBool !Bool
data FCMPriority
- = FCMPriorityNormal
- | FCMPriorityHigh
fcmBodyLocArgs :: Applicative f => ([FCMLocValue] -> f [FCMLocValue]) -> FCMNotification -> f FCMNotification
fcmContentAvailable :: Applicative f => (Bool -> f Bool) -> FCMMessage -> f FCMMessage
fcmDelayWhileIdle :: Applicative f => (Bool -> f Bool) -> FCMMessage -> f FCMMessage
fcmDryRun :: Applicative f => (Bool -> f Bool) -> FCMMessage -> f FCMMessage
fcmPriority :: Applicative f => (FCMPriority -> f FCMPriority) -> FCMMessage -> f FCMMessage
fcmTitleLocArgs :: Applicative f => ([FCMLocValue] -> f [FCMLocValue]) -> FCMNotification -> f FCMNotification
fcmWithNotification :: Applicative f => (FCMNotification -> f FCMNotification) -> FCMMessage -> f FCMMessage

Documentation

module Control.Lens

decode :: FromJSON a => ByteString -> Maybe a #

Efficiently deserialize a JSON value from a lazy ByteString. If this fails due to incomplete or invalid input, Nothing is returned.

The input must consist solely of a JSON document, with no trailing data except for whitespace.

This function parses immediately, but defers conversion. See json for details.

encode :: ToJSON a => a -> ByteString #

Efficiently serialize a JSON value as a lazy ByteString.

This is implemented in terms of the ToJSON class's toEncoding method.

module Data.Default.Class

data Scientific #

An arbitrary-precision number represented using scientific notation.

This type describes the set of all Reals which have a finite decimal expansion.

A scientific number with coefficient c and base10Exponent e corresponds to the Fractional number: fromInteger c * 10 ^^ e

Instances

Eq Scientific	Scientific numbers can be safely compared for equality. No magnitude `10^e` is calculated so there's no risk of a blowup in space or time when comparing scientific numbers coming from untrusted sources.
Instance details Defined in Data.Scientific Methods (==) :: Scientific -> Scientific -> Bool # (/=) :: Scientific -> Scientific -> Bool #
Fractional Scientific	WARNING: `recip` and `/` will throw an error when their outputs are repeating decimals. `fromRational` will throw an error when the input `Rational` is a repeating decimal. Consider using `fromRationalRepetend` for these rationals which will detect the repetition and indicate where it starts.
Instance details Defined in Data.Scientific Methods (/) :: Scientific -> Scientific -> Scientific # recip :: Scientific -> Scientific # fromRational :: Rational -> Scientific #
Data Scientific
Instance details Defined in Data.Scientific Methods gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> Scientific -> c Scientific # gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c Scientific # toConstr :: Scientific -> Constr # dataTypeOf :: Scientific -> DataType # dataCast1 :: Typeable t => (forall d. Data d => c (t d)) -> Maybe (c Scientific) # dataCast2 :: Typeable t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c Scientific) # gmapT :: (forall b. Data b => b -> b) -> Scientific -> Scientific # gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> Scientific -> r # gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> Scientific -> r # gmapQ :: (forall d. Data d => d -> u) -> Scientific -> [u] # gmapQi :: Int -> (forall d. Data d => d -> u) -> Scientific -> u # gmapM :: Monad m => (forall d. Data d => d -> m d) -> Scientific -> m Scientific # gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> Scientific -> m Scientific # gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> Scientific -> m Scientific #
Num Scientific	WARNING: `+` and `-` compute the `Integer` magnitude: `10^e` where `e` is the difference between the `base10Exponents` of the arguments. If these methods are applied to arguments which have huge exponents this could fill up all space and crash your program! So don't apply these methods to scientific numbers coming from untrusted sources. The other methods can be used safely.
Instance details Defined in Data.Scientific Methods (+) :: Scientific -> Scientific -> Scientific # (-) :: Scientific -> Scientific -> Scientific # (*) :: Scientific -> Scientific -> Scientific # negate :: Scientific -> Scientific # abs :: Scientific -> Scientific # signum :: Scientific -> Scientific # fromInteger :: Integer -> Scientific #
Ord Scientific	Scientific numbers can be safely compared for ordering. No magnitude `10^e` is calculated so there's no risk of a blowup in space or time when comparing scientific numbers coming from untrusted sources.
Instance details Defined in Data.Scientific Methods compare :: Scientific -> Scientific -> Ordering # (<) :: Scientific -> Scientific -> Bool # (<=) :: Scientific -> Scientific -> Bool # (>) :: Scientific -> Scientific -> Bool # (>=) :: Scientific -> Scientific -> Bool # max :: Scientific -> Scientific -> Scientific # min :: Scientific -> Scientific -> Scientific #
Read Scientific	Supports the skipping of parentheses and whitespaces. Example: > read " ( (( -1.0e+3 ) ))" :: Scientific -1000.0 (Note: This `Read` instance makes internal use of `scientificP` to parse the floating-point number.)
Instance details Defined in Data.Scientific Methods readsPrec :: Int -> ReadS Scientific # readList :: ReadS [Scientific] # readPrec :: ReadPrec Scientific # readListPrec :: ReadPrec [Scientific] #
Real Scientific	WARNING: `toRational` needs to compute the `Integer` magnitude: `10^e`. If applied to a huge exponent this could fill up all space and crash your program! Avoid applying `toRational` (or `realToFrac`) to scientific numbers coming from an untrusted source and use `toRealFloat` instead. The latter guards against excessive space usage.
Instance details Defined in Data.Scientific Methods toRational :: Scientific -> Rational #
RealFrac Scientific	WARNING: the methods of the `RealFrac` instance need to compute the magnitude `10^e`. If applied to a huge exponent this could take a long time. Even worse, when the destination type is unbounded (i.e. `Integer`) it could fill up all space and crash your program!
Instance details Defined in Data.Scientific Methods properFraction :: Integral b => Scientific -> (b, Scientific) # truncate :: Integral b => Scientific -> b # round :: Integral b => Scientific -> b # ceiling :: Integral b => Scientific -> b # floor :: Integral b => Scientific -> b #
Show Scientific	See `formatScientific` if you need more control over the rendering.
Instance details Defined in Data.Scientific Methods showsPrec :: Int -> Scientific -> ShowS # show :: Scientific -> String # showList :: [Scientific] -> ShowS #
Hashable Scientific	A hash can be safely calculated from a `Scientific`. No magnitude `10^e` is calculated so there's no risk of a blowup in space or time when hashing scientific numbers coming from untrusted sources.
Instance details Defined in Data.Scientific Methods hashWithSalt :: Int -> Scientific -> Int # hash :: Scientific -> Int #
ToJSON Scientific
Instance details Defined in Data.Aeson.Types.ToJSON Methods toJSON :: Scientific -> Value # toEncoding :: Scientific -> Encoding # toJSONList :: [Scientific] -> Value # toEncodingList :: [Scientific] -> Encoding #
ToJSONKey Scientific
Instance details Defined in Data.Aeson.Types.ToJSON Methods toJSONKey :: ToJSONKeyFunction Scientific # toJSONKeyList :: ToJSONKeyFunction [Scientific] #
FromJSON Scientific
Instance details Defined in Data.Aeson.Types.FromJSON Methods parseJSON :: Value -> Parser Scientific # parseJSONList :: Value -> Parser [Scientific] #
Binary Scientific	Note that in the future I intend to change the type of the `base10Exponent` from `Int` to `Integer`. To be forward compatible the `Binary` instance already encodes the exponent as `Integer`.
Instance details Defined in Data.Scientific Methods put :: Scientific -> Put # get :: Get Scientific # putList :: [Scientific] -> Put #
NFData Scientific
Instance details Defined in Data.Scientific Methods rnf :: Scientific -> () #

data FCMNotification Source #

FCM Notification as defined in https://firebase.google.com/docs/cloud-messaging/http-server-ref#notification-payload-support Abstract type, use lens API to access fields. Record fields are kept private and used for JSON conversion.

Instances

Eq FCMNotification Source #
Instance details Defined in FCMClient.JSON.Types Methods (==) :: FCMNotification -> FCMNotification -> Bool # (/=) :: FCMNotification -> FCMNotification -> Bool #
Show FCMNotification Source #
Instance details Defined in FCMClient.JSON.Types Methods showsPrec :: Int -> FCMNotification -> ShowS # show :: FCMNotification -> String # showList :: [FCMNotification] -> ShowS #
ToJSON FCMNotification Source #
Instance details Defined in FCMClient.JSON.Types Methods toJSON :: FCMNotification -> Value # toEncoding :: FCMNotification -> Encoding # toJSONList :: [FCMNotification] -> Value # toEncodingList :: [FCMNotification] -> Encoding #
FromJSON FCMNotification Source #
Instance details Defined in FCMClient.JSON.Types Methods parseJSON :: Value -> Parser FCMNotification # parseJSONList :: Value -> Parser [FCMNotification] #
Default FCMNotification Source #
Instance details Defined in FCMClient.JSON.Types Methods def :: FCMNotification #

type FCMData = Map Text Text Source #

fcmAndroidChannelId :: Lens' FCMNotification (Maybe Text) Source #

fcmBadge :: Lens' FCMNotification (Maybe Text) Source #

fcmBody :: Lens' FCMNotification (Maybe Text) Source #

fcmBodyLocKey :: Lens' FCMNotification (Maybe Text) Source #

fcmClickAction :: Lens' FCMNotification (Maybe Text) Source #

fcmColor :: Lens' FCMNotification (Maybe Text) Source #

fcmIcon :: Lens' FCMNotification (Maybe Text) Source #

fcmSound :: Lens' FCMNotification (Maybe Text) Source #

fcmTag :: Lens' FCMNotification (Maybe Text) Source #

fcmTitle :: Lens' FCMNotification (Maybe Text) Source #

fcmTitleLocKey :: Lens' FCMNotification (Maybe Text) Source #

data FCMMessage Source #

FCM Message as defined in https://firebase.google.com/docs/cloud-messaging/http-server-ref#send-downstream Abstract type, use lens API to access fields. Record fields are kept private and used for JSON conversion.

Instances

Eq FCMMessage Source #
Instance details Defined in FCMClient.JSON.Types Methods (==) :: FCMMessage -> FCMMessage -> Bool # (/=) :: FCMMessage -> FCMMessage -> Bool #
Show FCMMessage Source #
Instance details Defined in FCMClient.JSON.Types Methods showsPrec :: Int -> FCMMessage -> ShowS # show :: FCMMessage -> String # showList :: [FCMMessage] -> ShowS #
ToJSON FCMMessage Source #
Instance details Defined in FCMClient.JSON.Types Methods toJSON :: FCMMessage -> Value # toEncoding :: FCMMessage -> Encoding # toJSONList :: [FCMMessage] -> Value # toEncodingList :: [FCMMessage] -> Encoding #
FromJSON FCMMessage Source #
Instance details Defined in FCMClient.JSON.Types Methods parseJSON :: Value -> Parser FCMMessage # parseJSONList :: Value -> Parser [FCMMessage] #
Default FCMMessage Source #
Instance details Defined in FCMClient.JSON.Types Methods def :: FCMMessage #

fcmCollapseKey :: Lens' FCMMessage (Maybe Text) Source #

fcmCondition :: Lens' FCMMessage (Maybe Text) Source #

fcmData :: Lens' FCMMessage (Maybe FCMData) Source #

fcmNotification :: Lens' FCMMessage (Maybe FCMNotification) Source #

fcmRegistrationIds :: Lens' FCMMessage (Maybe (NonEmpty Text)) Source #

fcmRestrictedPackageName :: Lens' FCMMessage (Maybe Text) Source #

fcmTimeToLive :: Lens' FCMMessage (Maybe Word) Source #

fcmTo :: Lens' FCMMessage (Maybe Text) Source #

data FCMMessageResponseResultOk Source #

Instances

Eq FCMMessageResponseResultOk Source #
Instance details Defined in FCMClient.JSON.Types Methods (==) :: FCMMessageResponseResultOk -> FCMMessageResponseResultOk -> Bool # (/=) :: FCMMessageResponseResultOk -> FCMMessageResponseResultOk -> Bool #
Show FCMMessageResponseResultOk Source #
Instance details Defined in FCMClient.JSON.Types Methods showsPrec :: Int -> FCMMessageResponseResultOk -> ShowS # show :: FCMMessageResponseResultOk -> String # showList :: [FCMMessageResponseResultOk] -> ShowS #
ToJSON FCMMessageResponseResultOk Source #
Instance details Defined in FCMClient.JSON.Types Methods toJSON :: FCMMessageResponseResultOk -> Value # toEncoding :: FCMMessageResponseResultOk -> Encoding # toJSONList :: [FCMMessageResponseResultOk] -> Value # toEncodingList :: [FCMMessageResponseResultOk] -> Encoding #
FromJSON FCMMessageResponseResultOk Source #
Instance details Defined in FCMClient.JSON.Types Methods parseJSON :: Value -> Parser FCMMessageResponseResultOk # parseJSONList :: Value -> Parser [FCMMessageResponseResultOk] #
Default FCMMessageResponseResultOk Source #
Instance details Defined in FCMClient.JSON.Types Methods def :: FCMMessageResponseResultOk #

data FCMError Source #

String specifying the error that occurred when processing the message for the recipient. The possible values can be found in table 9. https://firebase.google.com/docs/cloud-messaging/http-server-ref#table9

Constructors

FCMErrorDeviceMessageRate
FCMErrorInternalServerError
FCMErrorInvalidDataKey
FCMErrorInvalidPackageName
FCMErrorInvalidRegistration
FCMErrorInvalidTtl
FCMErrorMessageTooBig
FCMErrorMismatchSenderId
FCMErrorMissingRegistration
FCMErrorNotRegistered
FCMErrorTopicsMessageRate
FCMErrorUnavailable
FCMErrorOther Text	used if we can't parse any of the above

Instances

Eq FCMError Source #
Instance details Defined in FCMClient.JSON.Types Methods (==) :: FCMError -> FCMError -> Bool # (/=) :: FCMError -> FCMError -> Bool #
Show FCMError Source #
Instance details Defined in FCMClient.JSON.Types Methods showsPrec :: Int -> FCMError -> ShowS # show :: FCMError -> String # showList :: [FCMError] -> ShowS #
ToJSON FCMError Source #
Instance details Defined in FCMClient.JSON.Types Methods toJSON :: FCMError -> Value # toEncoding :: FCMError -> Encoding # toJSONList :: [FCMError] -> Value # toEncodingList :: [FCMError] -> Encoding #
FromJSON FCMError Source #
Instance details Defined in FCMClient.JSON.Types Methods parseJSON :: Value -> Parser FCMError # parseJSONList :: Value -> Parser [FCMError] #

fcmMessageId :: Lens' FCMMessageResponseResultOk Text Source #

fcmRegistrationId :: Lens' FCMMessageResponseResultOk (Maybe Text) Source #

data FCMMessageResponseResult Source #

Constructors

FCMMessageResponseResultOk !FCMMessageResponseResultOk
FCMMessageResponseResultError !FCMError

Instances

Eq FCMMessageResponseResult Source #
Instance details Defined in FCMClient.JSON.Types Methods (==) :: FCMMessageResponseResult -> FCMMessageResponseResult -> Bool # (/=) :: FCMMessageResponseResult -> FCMMessageResponseResult -> Bool #
Show FCMMessageResponseResult Source #
Instance details Defined in FCMClient.JSON.Types Methods showsPrec :: Int -> FCMMessageResponseResult -> ShowS # show :: FCMMessageResponseResult -> String # showList :: [FCMMessageResponseResult] -> ShowS #
ToJSON FCMMessageResponseResult Source #
Instance details Defined in FCMClient.JSON.Types Methods toJSON :: FCMMessageResponseResult -> Value # toEncoding :: FCMMessageResponseResult -> Encoding # toJSONList :: [FCMMessageResponseResult] -> Value # toEncodingList :: [FCMMessageResponseResult] -> Encoding #
FromJSON FCMMessageResponseResult Source #
Instance details Defined in FCMClient.JSON.Types Methods parseJSON :: Value -> Parser FCMMessageResponseResult # parseJSONList :: Value -> Parser [FCMMessageResponseResult] #

data FCMMessageResponse Source #

Instances

Eq FCMMessageResponse Source #
Instance details Defined in FCMClient.JSON.Types Methods (==) :: FCMMessageResponse -> FCMMessageResponse -> Bool # (/=) :: FCMMessageResponse -> FCMMessageResponse -> Bool #
Show FCMMessageResponse Source #
Instance details Defined in FCMClient.JSON.Types Methods showsPrec :: Int -> FCMMessageResponse -> ShowS # show :: FCMMessageResponse -> String # showList :: [FCMMessageResponse] -> ShowS #
ToJSON FCMMessageResponse Source #
Instance details Defined in FCMClient.JSON.Types Methods toJSON :: FCMMessageResponse -> Value # toEncoding :: FCMMessageResponse -> Encoding # toJSONList :: [FCMMessageResponse] -> Value # toEncodingList :: [FCMMessageResponse] -> Encoding #
FromJSON FCMMessageResponse Source #
Instance details Defined in FCMClient.JSON.Types Methods parseJSON :: Value -> Parser FCMMessageResponse # parseJSONList :: Value -> Parser [FCMMessageResponse] #
Default FCMMessageResponse Source #
Instance details Defined in FCMClient.JSON.Types Methods def :: FCMMessageResponse #

_FCMMessageResponseResultOk :: Prism' FCMMessageResponseResult FCMMessageResponseResultOk Source #

_FCMMessageResponseResultError :: Prism' FCMMessageResponseResult FCMError Source #

fcmCanonicalIds :: Lens' FCMMessageResponse Integer Source #

fcmFailure :: Lens' FCMMessageResponse Integer Source #

fcmMulticastId :: Lens' FCMMessageResponse Integer Source #

fcmResults :: Lens' FCMMessageResponse (Maybe (NonEmpty FCMMessageResponseResult)) Source #

fcmSuccess :: Lens' FCMMessageResponse Integer Source #

data FCMTopicResponseOk Source #

Instances

Eq FCMTopicResponseOk Source #
Instance details Defined in FCMClient.JSON.Types Methods (==) :: FCMTopicResponseOk -> FCMTopicResponseOk -> Bool # (/=) :: FCMTopicResponseOk -> FCMTopicResponseOk -> Bool #
Show FCMTopicResponseOk Source #
Instance details Defined in FCMClient.JSON.Types Methods showsPrec :: Int -> FCMTopicResponseOk -> ShowS # show :: FCMTopicResponseOk -> String # showList :: [FCMTopicResponseOk] -> ShowS #
ToJSON FCMTopicResponseOk Source #
Instance details Defined in FCMClient.JSON.Types Methods toJSON :: FCMTopicResponseOk -> Value # toEncoding :: FCMTopicResponseOk -> Encoding # toJSONList :: [FCMTopicResponseOk] -> Value # toEncodingList :: [FCMTopicResponseOk] -> Encoding #
FromJSON FCMTopicResponseOk Source #
Instance details Defined in FCMClient.JSON.Types Methods parseJSON :: Value -> Parser FCMTopicResponseOk # parseJSONList :: Value -> Parser [FCMTopicResponseOk] #
Default FCMTopicResponseOk Source #
Instance details Defined in FCMClient.JSON.Types Methods def :: FCMTopicResponseOk #

fcmTopicMessageId :: Iso' FCMTopicResponseOk Integer Source #

data FCMTopicResponse Source #

Constructors

FCMTopicResponseOk !FCMTopicResponseOk
FCMTopicResponseError !FCMError

Instances

Eq FCMTopicResponse Source #
Instance details Defined in FCMClient.JSON.Types Methods (==) :: FCMTopicResponse -> FCMTopicResponse -> Bool # (/=) :: FCMTopicResponse -> FCMTopicResponse -> Bool #
Show FCMTopicResponse Source #
Instance details Defined in FCMClient.JSON.Types Methods showsPrec :: Int -> FCMTopicResponse -> ShowS # show :: FCMTopicResponse -> String # showList :: [FCMTopicResponse] -> ShowS #
ToJSON FCMTopicResponse Source #
Instance details Defined in FCMClient.JSON.Types Methods toJSON :: FCMTopicResponse -> Value # toEncoding :: FCMTopicResponse -> Encoding # toJSONList :: [FCMTopicResponse] -> Value # toEncodingList :: [FCMTopicResponse] -> Encoding #
FromJSON FCMTopicResponse Source #
Instance details Defined in FCMClient.JSON.Types Methods parseJSON :: Value -> Parser FCMTopicResponse # parseJSONList :: Value -> Parser [FCMTopicResponse] #

data FCMResponseBody Source #

Constructors

FCMMessageResponse !FCMMessageResponse
FCMTopicResponse !FCMTopicResponse

Instances

Eq FCMResponseBody Source #
Instance details Defined in FCMClient.JSON.Types Methods (==) :: FCMResponseBody -> FCMResponseBody -> Bool # (/=) :: FCMResponseBody -> FCMResponseBody -> Bool #
Show FCMResponseBody Source #
Instance details Defined in FCMClient.JSON.Types Methods showsPrec :: Int -> FCMResponseBody -> ShowS # show :: FCMResponseBody -> String # showList :: [FCMResponseBody] -> ShowS #
ToJSON FCMResponseBody Source #
Instance details Defined in FCMClient.JSON.Types Methods toJSON :: FCMResponseBody -> Value # toEncoding :: FCMResponseBody -> Encoding # toJSONList :: [FCMResponseBody] -> Value # toEncodingList :: [FCMResponseBody] -> Encoding #
FromJSON FCMResponseBody Source #
Instance details Defined in FCMClient.JSON.Types Methods parseJSON :: Value -> Parser FCMResponseBody # parseJSONList :: Value -> Parser [FCMResponseBody] #

_FCMTopicResponseOk :: Prism' FCMTopicResponse FCMTopicResponseOk Source #

_FCMTopicResponseError :: Prism' FCMTopicResponse FCMError Source #

data FCMClientError Source #

Types of FCM errors.

Constructors

FCMErrorResponseInvalidJSON !Text	Indicates that the request could not be parsed as JSON, or it contained invalid fields (for instance, passing a string where a number was expected). The exact failure reason is described in the response and the problem should be addressed before the request can be retried.
FCMErrorResponseInvalidAuth	There was an error authenticating the sender account.
FCMServerError !Status !Text	Errors in the 500-599 range (such as 500 or 503) indicate that there was an internal error in the FCM connection server while trying to process the request, or that the server is temporarily unavailable (for example, because of timeouts). Sender must retry later, honoring any Retry-After header included in the response. Application servers must implement exponential back-off.
FCMClientJSONError !Text	Client couldn't parse JSON response from server.
FCMClientHTTPError !Text	Unexpected HTTP response or some other HTTP error.

Instances

Show FCMClientError Source #
Instance details Defined in FCMClient.JSON.Types Methods showsPrec :: Int -> FCMClientError -> ShowS # show :: FCMClientError -> String # showList :: [FCMClientError] -> ShowS #

_FCMMessageResponse :: Prism' FCMResponseBody FCMMessageResponse Source #

_FCMTopicResponse :: Prism' FCMResponseBody FCMTopicResponse Source #

fcmErrorHttpStatus :: Traversal' FCMClientError Status Source #

fcmErrorMessage :: Traversal' FCMClientError Text Source #

data FCMResult Source #

Result of an RPC call.

Successful response doesn't imply all the messages were delivered, e.g. some may need to be re-sent if a rate limit was exceeded.

Error cases enumerate all, client and server error conditions.

Constructors

FCMResultSuccess !FCMResponseBody	Successful response (http 200). Doesn't imply all the messages were delivered, response body may contain error codes.
FCMResultError !FCMClientError	Didn't receive JSON response, there were an error of some kind.

Instances

Show FCMResult Source #
Instance details Defined in FCMClient.JSON.Types Methods showsPrec :: Int -> FCMResult -> ShowS # show :: FCMResult -> String # showList :: [FCMResult] -> ShowS #

_FCMErrorResponseInvalidJSON :: Prism' FCMClientError Text Source #

_FCMErrorResponseInvalidAuth :: Prism' FCMClientError () Source #

_FCMServerError :: Prism' FCMClientError (Status, Text) Source #

_FCMClientJSONError :: Prism' FCMClientError Text Source #

_FCMClientHTTPError :: Prism' FCMClientError Text Source #

_FCMResultSuccess :: Prism' FCMResult FCMResponseBody Source #

_FCMResultError :: Prism' FCMResult FCMClientError Source #

data FCMLocValue Source #

Constructors

FCMLocString !Text
FCMLocNumber !Scientific
FCMLocBool !Bool

Instances

Eq FCMLocValue Source #
Instance details Defined in FCMClient.Types Methods (==) :: FCMLocValue -> FCMLocValue -> Bool # (/=) :: FCMLocValue -> FCMLocValue -> Bool #
Ord FCMLocValue Source #
Instance details Defined in FCMClient.Types Methods compare :: FCMLocValue -> FCMLocValue -> Ordering # (<) :: FCMLocValue -> FCMLocValue -> Bool # (<=) :: FCMLocValue -> FCMLocValue -> Bool # (>) :: FCMLocValue -> FCMLocValue -> Bool # (>=) :: FCMLocValue -> FCMLocValue -> Bool # max :: FCMLocValue -> FCMLocValue -> FCMLocValue # min :: FCMLocValue -> FCMLocValue -> FCMLocValue #
Read FCMLocValue Source #
Instance details Defined in FCMClient.Types Methods readsPrec :: Int -> ReadS FCMLocValue # readList :: ReadS [FCMLocValue] # readPrec :: ReadPrec FCMLocValue # readListPrec :: ReadPrec [FCMLocValue] #
Show FCMLocValue Source #
Instance details Defined in FCMClient.Types Methods showsPrec :: Int -> FCMLocValue -> ShowS # show :: FCMLocValue -> String # showList :: [FCMLocValue] -> ShowS #
IsString FCMLocValue Source #	Shortcut for string localized parameters
Instance details Defined in FCMClient.Types Methods fromString :: String -> FCMLocValue #
ToJSON FCMLocValue Source #
Instance details Defined in FCMClient.Types Methods toJSON :: FCMLocValue -> Value # toEncoding :: FCMLocValue -> Encoding # toJSONList :: [FCMLocValue] -> Value # toEncodingList :: [FCMLocValue] -> Encoding #
FromJSON FCMLocValue Source #
Instance details Defined in FCMClient.Types Methods parseJSON :: Value -> Parser FCMLocValue # parseJSONList :: Value -> Parser [FCMLocValue] #

data FCMPriority Source #

Constructors

FCMPriorityNormal
FCMPriorityHigh

Instances

Eq FCMPriority Source #
Instance details Defined in FCMClient.Types Methods (==) :: FCMPriority -> FCMPriority -> Bool # (/=) :: FCMPriority -> FCMPriority -> Bool #
Ord FCMPriority Source #
Instance details Defined in FCMClient.Types Methods compare :: FCMPriority -> FCMPriority -> Ordering # (<) :: FCMPriority -> FCMPriority -> Bool # (<=) :: FCMPriority -> FCMPriority -> Bool # (>) :: FCMPriority -> FCMPriority -> Bool # (>=) :: FCMPriority -> FCMPriority -> Bool # max :: FCMPriority -> FCMPriority -> FCMPriority # min :: FCMPriority -> FCMPriority -> FCMPriority #
Show FCMPriority Source #
Instance details Defined in FCMClient.Types Methods showsPrec :: Int -> FCMPriority -> ShowS # show :: FCMPriority -> String # showList :: [FCMPriority] -> ShowS #

fcmBodyLocArgs :: Applicative f => ([FCMLocValue] -> f [FCMLocValue]) -> FCMNotification -> f FCMNotification Source #

Typed lens focused on localized notification body arguments.

fcmContentAvailable :: Applicative f => (Bool -> f Bool) -> FCMMessage -> f FCMMessage Source #

Sets content available field when True, sets Nothing when False.

fcmDelayWhileIdle :: Applicative f => (Bool -> f Bool) -> FCMMessage -> f FCMMessage Source #

Sets delay while idle field when True, sets Nothing when False.

fcmDryRun :: Applicative f => (Bool -> f Bool) -> FCMMessage -> f FCMMessage Source #

Sets dry run field when True, sets Nothing when False.

fcmPriority :: Applicative f => (FCMPriority -> f FCMPriority) -> FCMMessage -> f FCMMessage Source #

Typed lens focused on message priority.

fcmTitleLocArgs :: Applicative f => ([FCMLocValue] -> f [FCMLocValue]) -> FCMNotification -> f FCMNotification Source #

Typed lens focused on localized notification title arguments.

fcmWithNotification :: Applicative f => (FCMNotification -> f FCMNotification) -> FCMMessage -> f FCMMessage Source #

Creates default empty notification if missing