FCMClient.JSON.Types

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

Data types in this module map field for field in the google docs. See FCMClient.Types module for some wrapper functions on top of raw JSON types.

Documentation

type FCMData = Map Text Text

data FCMNotification

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

Defined in FCMClient.JSON.Types

Methods

(==) :: FCMNotification -> FCMNotification -> Bool

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

Show FCMNotification

Defined in FCMClient.JSON.Types

Methods

showsPrec :: Int -> FCMNotification -> ShowS

show :: FCMNotification -> String

showList :: [FCMNotification] -> ShowS

ToJSON FCMNotification

Defined in FCMClient.JSON.Types

Methods

toJSON :: FCMNotification -> Value

toEncoding :: FCMNotification -> Encoding

toJSONList :: [FCMNotification] -> Value

toEncodingList :: [FCMNotification] -> Encoding

FromJSON FCMNotification

Defined in FCMClient.JSON.Types

Methods

parseJSON :: Value -> Parser FCMNotification

parseJSONList :: Value -> Parser [FCMNotification]

Default FCMNotification

Defined in FCMClient.JSON.Types

Methods

def :: FCMNotification

fcmTitle :: Lens' FCMNotification (Maybe Text)

fcmBody :: Lens' FCMNotification (Maybe Text)

fcmAndroidChannelId :: Lens' FCMNotification (Maybe Text)

fcmIcon :: Lens' FCMNotification (Maybe Text)

fcmSound :: Lens' FCMNotification (Maybe Text)

fcmTag :: Lens' FCMNotification (Maybe Text)

fcmColor :: Lens' FCMNotification (Maybe Text)

fcmBadge :: Lens' FCMNotification (Maybe Text)

fcmClickAction :: Lens' FCMNotification (Maybe Text)

fcmBodyLocKey :: Lens' FCMNotification (Maybe Text)

fcmBodyLocArgs :: Lens' FCMNotification (Maybe Text)

fcmTitleLocKey :: Lens' FCMNotification (Maybe Text)

fcmTitleLocArgs :: Lens' FCMNotification (Maybe Text)

data FCMMessage

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

Defined in FCMClient.JSON.Types

Methods

(==) :: FCMMessage -> FCMMessage -> Bool

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

Show FCMMessage

Defined in FCMClient.JSON.Types

Methods

showsPrec :: Int -> FCMMessage -> ShowS

show :: FCMMessage -> String

showList :: [FCMMessage] -> ShowS

ToJSON FCMMessage

Defined in FCMClient.JSON.Types

Methods

toJSON :: FCMMessage -> Value

toEncoding :: FCMMessage -> Encoding

toJSONList :: [FCMMessage] -> Value

toEncodingList :: [FCMMessage] -> Encoding

FromJSON FCMMessage

Defined in FCMClient.JSON.Types

Methods

parseJSON :: Value -> Parser FCMMessage

parseJSONList :: Value -> Parser [FCMMessage]

Default FCMMessage

Defined in FCMClient.JSON.Types

Methods

def :: FCMMessage

fcmTo :: Lens' FCMMessage (Maybe Text)

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

fcmCondition :: Lens' FCMMessage (Maybe Text)

fcmCollapseKey :: Lens' FCMMessage (Maybe Text)

fcmPriority :: Lens' FCMMessage (Maybe Text)

fcmContentAvailable :: Lens' FCMMessage (Maybe Bool)

fcmDelayWhileIdle :: Lens' FCMMessage (Maybe Bool)

fcmTimeToLive :: Lens' FCMMessage (Maybe Word)

fcmRestrictedPackageName :: Lens' FCMMessage (Maybe Text)

fcmDryRun :: Lens' FCMMessage (Maybe Bool)

fcmData :: Lens' FCMMessage (Maybe FCMData)

fcmNotification :: Lens' FCMMessage (Maybe FCMNotification)

data FCMResult

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

Defined in FCMClient.JSON.Types

Methods

showsPrec :: Int -> FCMResult -> ShowS

show :: FCMResult -> String

showList :: [FCMResult] -> ShowS

_FCMResultSuccess :: Prism' FCMResult FCMResponseBody

_FCMResultError :: Prism' FCMResult FCMClientError

data FCMClientError

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

Defined in FCMClient.JSON.Types

Methods

showsPrec :: Int -> FCMClientError -> ShowS

show :: FCMClientError -> String

showList :: [FCMClientError] -> ShowS

fcmErrorMessage :: Traversal' FCMClientError Text

fcmErrorHttpStatus :: Traversal' FCMClientError Status

_FCMErrorResponseInvalidJSON :: Prism' FCMClientError Text

_FCMErrorResponseInvalidAuth :: Prism' FCMClientError ()

_FCMServerError :: Prism' FCMClientError (Status, Text)

_FCMClientJSONError :: Prism' FCMClientError Text

_FCMClientHTTPError :: Prism' FCMClientError Text

data FCMResponseBody

Constructors

FCMMessageResponse !FCMMessageResponse

FCMTopicResponse !FCMTopicResponse

Instances

Eq FCMResponseBody

Defined in FCMClient.JSON.Types

Methods

(==) :: FCMResponseBody -> FCMResponseBody -> Bool

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

Show FCMResponseBody

Defined in FCMClient.JSON.Types

Methods

showsPrec :: Int -> FCMResponseBody -> ShowS

show :: FCMResponseBody -> String

showList :: [FCMResponseBody] -> ShowS

ToJSON FCMResponseBody

Defined in FCMClient.JSON.Types

Methods

toJSON :: FCMResponseBody -> Value

toEncoding :: FCMResponseBody -> Encoding

toJSONList :: [FCMResponseBody] -> Value

toEncodingList :: [FCMResponseBody] -> Encoding

FromJSON FCMResponseBody

Defined in FCMClient.JSON.Types

Methods

parseJSON :: Value -> Parser FCMResponseBody

parseJSONList :: Value -> Parser [FCMResponseBody]

data FCMMessageResponse

Instances

Eq FCMMessageResponse

Defined in FCMClient.JSON.Types

Methods

(==) :: FCMMessageResponse -> FCMMessageResponse -> Bool

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

Show FCMMessageResponse

Defined in FCMClient.JSON.Types

Methods

showsPrec :: Int -> FCMMessageResponse -> ShowS

show :: FCMMessageResponse -> String

showList :: [FCMMessageResponse] -> ShowS

ToJSON FCMMessageResponse

Defined in FCMClient.JSON.Types

Methods

toJSON :: FCMMessageResponse -> Value

toEncoding :: FCMMessageResponse -> Encoding

toJSONList :: [FCMMessageResponse] -> Value

toEncodingList :: [FCMMessageResponse] -> Encoding

FromJSON FCMMessageResponse

Defined in FCMClient.JSON.Types

Methods

parseJSON :: Value -> Parser FCMMessageResponse

parseJSONList :: Value -> Parser [FCMMessageResponse]

Default FCMMessageResponse

Defined in FCMClient.JSON.Types

Methods

def :: FCMMessageResponse

_FCMMessageResponse :: Prism' FCMResponseBody FCMMessageResponse

_FCMTopicResponse :: Prism' FCMResponseBody FCMTopicResponse

fcmCanonicalIds :: Lens' FCMMessageResponse Integer

fcmFailure :: Lens' FCMMessageResponse Integer

fcmMulticastId :: Lens' FCMMessageResponse Integer

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

fcmSuccess :: Lens' FCMMessageResponse Integer

data FCMMessageResponseResult

Constructors

FCMMessageResponseResultOk !FCMMessageResponseResultOk

FCMMessageResponseResultError !FCMError

Instances

Eq FCMMessageResponseResult

Defined in FCMClient.JSON.Types

Methods

(==) :: FCMMessageResponseResult -> FCMMessageResponseResult -> Bool

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

Show FCMMessageResponseResult

Defined in FCMClient.JSON.Types

Methods

showsPrec :: Int -> FCMMessageResponseResult -> ShowS

show :: FCMMessageResponseResult -> String

showList :: [FCMMessageResponseResult] -> ShowS

ToJSON FCMMessageResponseResult

Defined in FCMClient.JSON.Types

Methods

toJSON :: FCMMessageResponseResult -> Value

toEncoding :: FCMMessageResponseResult -> Encoding

toJSONList :: [FCMMessageResponseResult] -> Value

toEncodingList :: [FCMMessageResponseResult] -> Encoding

FromJSON FCMMessageResponseResult

Defined in FCMClient.JSON.Types

Methods

parseJSON :: Value -> Parser FCMMessageResponseResult

parseJSONList :: Value -> Parser [FCMMessageResponseResult]

_FCMMessageResponseResultOk :: Prism' FCMMessageResponseResult FCMMessageResponseResultOk

_FCMMessageResponseResultError :: Prism' FCMMessageResponseResult FCMError

data FCMMessageResponseResultOk

Instances

Eq FCMMessageResponseResultOk

Defined in FCMClient.JSON.Types

Methods

(==) :: FCMMessageResponseResultOk -> FCMMessageResponseResultOk -> Bool

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

Show FCMMessageResponseResultOk

Defined in FCMClient.JSON.Types

Methods

showsPrec :: Int -> FCMMessageResponseResultOk -> ShowS

show :: FCMMessageResponseResultOk -> String

showList :: [FCMMessageResponseResultOk] -> ShowS

ToJSON FCMMessageResponseResultOk

Defined in FCMClient.JSON.Types

Methods

toJSON :: FCMMessageResponseResultOk -> Value

toEncoding :: FCMMessageResponseResultOk -> Encoding

toJSONList :: [FCMMessageResponseResultOk] -> Value

toEncodingList :: [FCMMessageResponseResultOk] -> Encoding

FromJSON FCMMessageResponseResultOk

Defined in FCMClient.JSON.Types

Methods

parseJSON :: Value -> Parser FCMMessageResponseResultOk

parseJSONList :: Value -> Parser [FCMMessageResponseResultOk]

Default FCMMessageResponseResultOk

Defined in FCMClient.JSON.Types

Methods

def :: FCMMessageResponseResultOk

fcmMessageId :: Lens' FCMMessageResponseResultOk Text

fcmRegistrationId :: Lens' FCMMessageResponseResultOk (Maybe Text)

data FCMTopicResponse

Constructors

FCMTopicResponseOk !FCMTopicResponseOk

FCMTopicResponseError !FCMError

Instances

Eq FCMTopicResponse

Defined in FCMClient.JSON.Types

Methods

(==) :: FCMTopicResponse -> FCMTopicResponse -> Bool

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

Show FCMTopicResponse

Defined in FCMClient.JSON.Types

Methods

showsPrec :: Int -> FCMTopicResponse -> ShowS

show :: FCMTopicResponse -> String

showList :: [FCMTopicResponse] -> ShowS

ToJSON FCMTopicResponse

Defined in FCMClient.JSON.Types

Methods

toJSON :: FCMTopicResponse -> Value

toEncoding :: FCMTopicResponse -> Encoding

toJSONList :: [FCMTopicResponse] -> Value

toEncodingList :: [FCMTopicResponse] -> Encoding

FromJSON FCMTopicResponse

Defined in FCMClient.JSON.Types

Methods

parseJSON :: Value -> Parser FCMTopicResponse

parseJSONList :: Value -> Parser [FCMTopicResponse]

data FCMTopicResponseOk

Instances

Eq FCMTopicResponseOk

Defined in FCMClient.JSON.Types

Methods

(==) :: FCMTopicResponseOk -> FCMTopicResponseOk -> Bool

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

Show FCMTopicResponseOk

Defined in FCMClient.JSON.Types

Methods

showsPrec :: Int -> FCMTopicResponseOk -> ShowS

show :: FCMTopicResponseOk -> String

showList :: [FCMTopicResponseOk] -> ShowS

ToJSON FCMTopicResponseOk

Defined in FCMClient.JSON.Types

Methods

toJSON :: FCMTopicResponseOk -> Value

toEncoding :: FCMTopicResponseOk -> Encoding

toJSONList :: [FCMTopicResponseOk] -> Value

toEncodingList :: [FCMTopicResponseOk] -> Encoding

FromJSON FCMTopicResponseOk

Defined in FCMClient.JSON.Types

Methods

parseJSON :: Value -> Parser FCMTopicResponseOk

parseJSONList :: Value -> Parser [FCMTopicResponseOk]

Default FCMTopicResponseOk

Defined in FCMClient.JSON.Types

Methods

def :: FCMTopicResponseOk

_FCMTopicResponseOk :: Prism' FCMTopicResponse FCMTopicResponseOk

_FCMTopicResponseError :: Prism' FCMTopicResponse FCMError

fcmTopicMessageId :: Iso' FCMTopicResponseOk Integer

data FCMError

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

Defined in FCMClient.JSON.Types

Methods

(==) :: FCMError -> FCMError -> Bool

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

Show FCMError

Defined in FCMClient.JSON.Types

Methods

showsPrec :: Int -> FCMError -> ShowS

show :: FCMError -> String

showList :: [FCMError] -> ShowS

ToJSON FCMError

Defined in FCMClient.JSON.Types

Methods

toJSON :: FCMError -> Value

toEncoding :: FCMError -> Encoding

toJSONList :: [FCMError] -> Value

toEncodingList :: [FCMError] -> Encoding

FromJSON FCMError

Defined in FCMClient.JSON.Types

Methods

parseJSON :: Value -> Parser FCMError

parseJSONList :: Value -> Parser [FCMError]