Safe Haskell	Safe-Inferred
Language	GHC2021

Wire.API.Push.V2

Contents

Priority (re-export)
PushToken (re-export)
PushToken fields (re-export)

Synopsis

data Push = Push {
- _pushRecipients :: Range 1 1024 (Set Recipient)
- _pushOrigin :: !(Maybe UserId)
- _pushConnections :: !(Set ConnId)
- _pushOriginConnection :: !(Maybe ConnId)
- _pushTransient :: !Bool
- _pushNativeIncludeOrigin :: !Bool
- _pushNativeEncrypt :: !Bool
- _pushNativeAps :: !(Maybe ApsData)
- _pushNativePriority :: !Priority
- _pushPayload :: !(List1 Object)
}
newPush :: Maybe UserId -> Range 1 1024 (Set Recipient) -> List1 Object -> Push
pushRecipients :: Lens' Push (Range 1 1024 (Set Recipient))
pushOrigin :: Lens' Push (Maybe UserId)
pushConnections :: Lens' Push (Set ConnId)
pushOriginConnection :: Lens' Push (Maybe ConnId)
pushTransient :: Lens' Push Bool
pushNativeIncludeOrigin :: Lens' Push Bool
pushNativeEncrypt :: Lens' Push Bool
pushNativeAps :: Lens' Push (Maybe ApsData)
pushNativePriority :: Lens' Push Priority
pushPayload :: Lens' Push (List1 Object)
singletonPayload :: ToJSONObject a => a -> List1 Object
data Recipient = Recipient {
- _recipientId :: !UserId
- _recipientRoute :: !Route
- _recipientClients :: !RecipientClients
}
data RecipientClients
- = RecipientClientsAll
- | RecipientClientsSome (List1 ClientId)
recipient :: UserId -> Route -> Recipient
recipientId :: Lens' Recipient UserId
recipientRoute :: Lens' Recipient Route
recipientClients :: Lens' Recipient RecipientClients
data Route
- = RouteAny
- | RouteDirect
data ApsData
newtype ApsLocKey = ApsLocKey {
- fromLocKey :: Text
}
newtype ApsSound = ApsSound {
- fromSound :: Text
}
apsData :: ApsLocKey -> [Text] -> ApsData
apsLocKey :: Lens' ApsData ApsLocKey
apsLocArgs :: Lens' ApsData [Text]
apsSound :: Lens' ApsData (Maybe ApsSound)
apsBadge :: Lens' ApsData Bool
data Priority
- = LowPriority
- | HighPriority
newtype PushTokenList = PushTokenList {
- pushTokens :: [PushToken]
}
data PushToken
pushToken :: Transport -> AppName -> Token -> ClientId -> PushToken
tokenTransport :: Lens' PushToken Transport
tokenApp :: Lens' PushToken AppName
tokenClient :: Lens' PushToken ClientId
token :: Lens' PushToken Token
newtype Token = Token {
- tokenText :: Text
}
data Transport
- = GCM
- | APNS
- | APNSSandbox
- | APNSVoIP
- | APNSVoIPSandbox
newtype AppName = AppName {
- appNameText :: Text
}

Documentation

data Push Source #

Constructors

Push

Fields

_pushRecipients :: Range 1 1024 (Set Recipient)
Recipients
REFACTOR: $sel:_pushRecipients:Push should be Set (Recipient, Maybe (NonEmptySet ConnId)), and $sel:_pushConnections:Push should go away. Rationale: the current setup only works under the assumption that no ConnId is used by two Recipients. This is *probably* correct, but not in any contract. (Changing this may require a new version module, since we need to support both the old and the new data type simultaneously during upgrade.)
_pushOrigin :: !(Maybe UserId)
Originating user
Nothing here means that the originating user is on another backend.
REFACTOR: where is this required, and for what? or can it be removed? (see also: #531)
_pushConnections :: !(Set ConnId)
Destination connections. If empty, ignore. Otherwise, filter the connections derived from $sel:_pushRecipients:Push and only push to those contained in this set.
REFACTOR: change this to _pushConnectionWhitelist :: Maybe (Set ConnId).
_pushOriginConnection :: !(Maybe ConnId)
Originating connection, if any.
_pushTransient :: !Bool
Transient payloads are not forwarded to the notification stream.
_pushNativeIncludeOrigin :: !Bool
Whether to send native notifications to other clients of the originating user, if he is among the recipients.
_pushNativeEncrypt :: !Bool
Should native push payloads be encrypted?
REFACTOR: this make no sense any more since native push notifications have no more payload. https://github.com/wireapp/wire-server/pull/546
_pushNativeAps :: !(Maybe ApsData)
APNs-specific metadata (needed eg. in "Brig.IO.Intra.toApsData").
_pushNativePriority :: !Priority
Native push priority.
_pushPayload :: !(List1 Object)
Opaque payload

Instances

Instances details

FromJSON Push Source #
Instance details Defined in Wire.API.Push.V2 Methods parseJSON :: Value -> Parser Push Source # parseJSONList :: Value -> Parser [Push] Source #
ToJSON Push Source #
Instance details Defined in Wire.API.Push.V2 Methods toJSON :: Push -> Value Source # toEncoding :: Push -> Encoding Source # toJSONList :: [Push] -> Value Source # toEncodingList :: [Push] -> Encoding Source #
Show Push Source #
Instance details Defined in Wire.API.Push.V2 Methods showsPrec :: Int -> Push -> ShowS # show :: Push -> String # showList :: [Push] -> ShowS #
Eq Push Source #
Instance details Defined in Wire.API.Push.V2 Methods (==) :: Push -> Push -> Bool # (/=) :: Push -> Push -> Bool #
ToSchema Push Source #
Instance details Defined in Wire.API.Push.V2 Methods declareNamedSchema :: Proxy Push -> Declare (Definitions Schema) NamedSchema Source #
ToSchema Push Source #
Instance details Defined in Wire.API.Push.V2 Methods schema :: ValueSchema NamedSwaggerDoc Push Source #

newPush :: Maybe UserId -> Range 1 1024 (Set Recipient) -> List1 Object -> Push Source #

pushRecipients :: Lens' Push (Range 1 1024 (Set Recipient)) Source #

pushOrigin :: Lens' Push (Maybe UserId) Source #

pushConnections :: Lens' Push (Set ConnId) Source #

pushOriginConnection :: Lens' Push (Maybe ConnId) Source #

pushTransient :: Lens' Push Bool Source #

pushNativeIncludeOrigin :: Lens' Push Bool Source #

pushNativeEncrypt :: Lens' Push Bool Source #

pushNativeAps :: Lens' Push (Maybe ApsData) Source #

pushNativePriority :: Lens' Push Priority Source #

pushPayload :: Lens' Push (List1 Object) Source #

singletonPayload :: ToJSONObject a => a -> List1 Object Source #

data Recipient Source #

Constructors

Recipient
Fields _recipientId :: !UserId _recipientRoute :: !Route _recipientClients :: !RecipientClients

Instances

Instances details

FromJSON Recipient Source #
Instance details Defined in Wire.API.Push.V2 Methods parseJSON :: Value -> Parser Recipient Source # parseJSONList :: Value -> Parser [Recipient] Source #
ToJSON Recipient Source #
Instance details Defined in Wire.API.Push.V2 Methods toJSON :: Recipient -> Value Source # toEncoding :: Recipient -> Encoding Source # toJSONList :: [Recipient] -> Value Source # toEncodingList :: [Recipient] -> Encoding Source #
Generic Recipient Source #
Instance details Defined in Wire.API.Push.V2 Associated Types type Rep Recipient :: Type -> Type # Methods from :: Recipient -> Rep Recipient x # to :: Rep Recipient x -> Recipient #
Show Recipient Source #
Instance details Defined in Wire.API.Push.V2 Methods showsPrec :: Int -> Recipient -> ShowS # show :: Recipient -> String # showList :: [Recipient] -> ShowS #
Eq Recipient Source #
Instance details Defined in Wire.API.Push.V2 Methods (==) :: Recipient -> Recipient -> Bool # (/=) :: Recipient -> Recipient -> Bool #
Ord Recipient Source #
Instance details Defined in Wire.API.Push.V2 Methods compare :: Recipient -> Recipient -> Ordering # (<) :: Recipient -> Recipient -> Bool # (<=) :: Recipient -> Recipient -> Bool # (>) :: Recipient -> Recipient -> Bool # (>=) :: Recipient -> Recipient -> Bool # max :: Recipient -> Recipient -> Recipient # min :: Recipient -> Recipient -> Recipient #
ToSchema Recipient Source #
Instance details Defined in Wire.API.Push.V2 Methods declareNamedSchema :: Proxy Recipient -> Declare (Definitions Schema) NamedSchema Source #
ToSchema Recipient Source #
Instance details Defined in Wire.API.Push.V2 Methods schema :: ValueSchema NamedSwaggerDoc Recipient Source #
type Rep Recipient Source #
Instance details Defined in Wire.API.Push.V2 type Rep Recipient = D1 ('MetaData "Recipient" "Wire.API.Push.V2" "wire-api-0.1.0-EbZS9CKNOfZ8BBy5DRJfXi" 'False) (C1 ('MetaCons "Recipient" 'PrefixI 'True) (S1 ('MetaSel ('Just "_recipientId") 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 UserId) :: (S1 ('MetaSel ('Just "_recipientRoute") 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 Route) :: S1 ('MetaSel ('Just "_recipientClients") 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 RecipientClients))))

data RecipientClients Source #

Constructors

RecipientClientsAll	All clients of some user
RecipientClientsSome (List1 ClientId)	An explicit list of clients

Instances

Instances details

Arbitrary RecipientClients Source #
Instance details Defined in Wire.API.Push.V2 Methods arbitrary :: Gen RecipientClients Source # shrink :: RecipientClients -> [RecipientClients] Source #
FromJSON RecipientClients Source #
Instance details Defined in Wire.API.Push.V2 Methods parseJSON :: Value -> Parser RecipientClients Source # parseJSONList :: Value -> Parser [RecipientClients] Source #
ToJSON RecipientClients Source #
Instance details Defined in Wire.API.Push.V2 Methods toJSON :: RecipientClients -> Value Source # toEncoding :: RecipientClients -> Encoding Source # toJSONList :: [RecipientClients] -> Value Source # toEncodingList :: [RecipientClients] -> Encoding Source #
Semigroup RecipientClients Source #
Instance details Defined in Wire.API.Push.V2 Methods (<>) :: RecipientClients -> RecipientClients -> RecipientClients # sconcat :: NonEmpty RecipientClients -> RecipientClients # stimes :: Integral b => b -> RecipientClients -> RecipientClients #
Generic RecipientClients Source #
Instance details Defined in Wire.API.Push.V2 Associated Types type Rep RecipientClients :: Type -> Type # Methods from :: RecipientClients -> Rep RecipientClients x # to :: Rep RecipientClients x -> RecipientClients #
Show RecipientClients Source #
Instance details Defined in Wire.API.Push.V2 Methods showsPrec :: Int -> RecipientClients -> ShowS # show :: RecipientClients -> String # showList :: [RecipientClients] -> ShowS #
Eq RecipientClients Source #
Instance details Defined in Wire.API.Push.V2 Methods (==) :: RecipientClients -> RecipientClients -> Bool # (/=) :: RecipientClients -> RecipientClients -> Bool #
Ord RecipientClients Source #
Instance details Defined in Wire.API.Push.V2 Methods compare :: RecipientClients -> RecipientClients -> Ordering # (<) :: RecipientClients -> RecipientClients -> Bool # (<=) :: RecipientClients -> RecipientClients -> Bool # (>) :: RecipientClients -> RecipientClients -> Bool # (>=) :: RecipientClients -> RecipientClients -> Bool # max :: RecipientClients -> RecipientClients -> RecipientClients # min :: RecipientClients -> RecipientClients -> RecipientClients #
ToSchema RecipientClients Source #
Instance details Defined in Wire.API.Push.V2 Methods declareNamedSchema :: Proxy RecipientClients -> Declare (Definitions Schema) NamedSchema Source #
ToSchema RecipientClients Source #
Instance details Defined in Wire.API.Push.V2 Methods schema :: ValueSchema NamedSwaggerDoc RecipientClients Source #
type Rep RecipientClients Source #
Instance details Defined in Wire.API.Push.V2 type Rep RecipientClients = D1 ('MetaData "RecipientClients" "Wire.API.Push.V2" "wire-api-0.1.0-EbZS9CKNOfZ8BBy5DRJfXi" 'False) (C1 ('MetaCons "RecipientClientsAll" 'PrefixI 'False) (U1 :: Type -> Type) :+: C1 ('MetaCons "RecipientClientsSome" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (List1 ClientId))))

recipient :: UserId -> Route -> Recipient Source #

recipientId :: Lens' Recipient UserId Source #

recipientRoute :: Lens' Recipient Route Source #

recipientClients :: Lens' Recipient RecipientClients Source #

data Route Source #

Constructors

RouteAny	Sends notification on all channels including push notifications to mobile clients. Note that transient messages never cause a push notification.
RouteDirect	Avoids causing push notification for mobile clients.

Instances

Instances details

Arbitrary Route Source #
Instance details Defined in Wire.API.Push.V2 Methods arbitrary :: Gen Route Source # shrink :: Route -> [Route] Source #
FromJSON Route Source #
Instance details Defined in Wire.API.Push.V2 Methods parseJSON :: Value -> Parser Route Source # parseJSONList :: Value -> Parser [Route] Source #
ToJSON Route Source #
Instance details Defined in Wire.API.Push.V2 Methods toJSON :: Route -> Value Source # toEncoding :: Route -> Encoding Source # toJSONList :: [Route] -> Value Source # toEncodingList :: [Route] -> Encoding Source #
Bounded Route Source #
Instance details Defined in Wire.API.Push.V2 Methods minBound :: Route # maxBound :: Route #
Enum Route Source #
Instance details Defined in Wire.API.Push.V2 Methods succ :: Route -> Route # pred :: Route -> Route # toEnum :: Int -> Route # fromEnum :: Route -> Int # enumFrom :: Route -> [Route] # enumFromThen :: Route -> Route -> [Route] # enumFromTo :: Route -> Route -> [Route] # enumFromThenTo :: Route -> Route -> Route -> [Route] #
Generic Route Source #
Instance details Defined in Wire.API.Push.V2 Associated Types type Rep Route :: Type -> Type # Methods from :: Route -> Rep Route x # to :: Rep Route x -> Route #
Show Route Source #
Instance details Defined in Wire.API.Push.V2 Methods showsPrec :: Int -> Route -> ShowS # show :: Route -> String # showList :: [Route] -> ShowS #
Eq Route Source #
Instance details Defined in Wire.API.Push.V2 Methods (==) :: Route -> Route -> Bool # (/=) :: Route -> Route -> Bool #
Ord Route Source #
Instance details Defined in Wire.API.Push.V2 Methods compare :: Route -> Route -> Ordering # (<) :: Route -> Route -> Bool # (<=) :: Route -> Route -> Bool # (>) :: Route -> Route -> Bool # (>=) :: Route -> Route -> Bool # max :: Route -> Route -> Route # min :: Route -> Route -> Route #
ToSchema Route Source #
Instance details Defined in Wire.API.Push.V2 Methods declareNamedSchema :: Proxy Route -> Declare (Definitions Schema) NamedSchema Source #
ToSchema Route Source #
Instance details Defined in Wire.API.Push.V2 Methods schema :: ValueSchema NamedSwaggerDoc Route Source #
type Rep Route Source #
Instance details Defined in Wire.API.Push.V2 type Rep Route = D1 ('MetaData "Route" "Wire.API.Push.V2" "wire-api-0.1.0-EbZS9CKNOfZ8BBy5DRJfXi" 'False) (C1 ('MetaCons "RouteAny" 'PrefixI 'False) (U1 :: Type -> Type) :+: C1 ('MetaCons "RouteDirect" 'PrefixI 'False) (U1 :: Type -> Type))

data ApsData Source #

Instances

Instances details

Arbitrary ApsData Source #
Instance details Defined in Wire.API.Push.V2 Methods arbitrary :: Gen ApsData Source # shrink :: ApsData -> [ApsData] Source #
FromJSON ApsData Source #
Instance details Defined in Wire.API.Push.V2 Methods parseJSON :: Value -> Parser ApsData Source # parseJSONList :: Value -> Parser [ApsData] Source #
ToJSON ApsData Source #
Instance details Defined in Wire.API.Push.V2 Methods toJSON :: ApsData -> Value Source # toEncoding :: ApsData -> Encoding Source # toJSONList :: [ApsData] -> Value Source # toEncodingList :: [ApsData] -> Encoding Source #
Generic ApsData Source #
Instance details Defined in Wire.API.Push.V2 Associated Types type Rep ApsData :: Type -> Type # Methods from :: ApsData -> Rep ApsData x # to :: Rep ApsData x -> ApsData #
Show ApsData Source #
Instance details Defined in Wire.API.Push.V2 Methods showsPrec :: Int -> ApsData -> ShowS # show :: ApsData -> String # showList :: [ApsData] -> ShowS #
Eq ApsData Source #
Instance details Defined in Wire.API.Push.V2 Methods (==) :: ApsData -> ApsData -> Bool # (/=) :: ApsData -> ApsData -> Bool #
ToSchema ApsData Source #
Instance details Defined in Wire.API.Push.V2 Methods declareNamedSchema :: Proxy ApsData -> Declare (Definitions Schema) NamedSchema Source #
ToSchema ApsData Source #
Instance details Defined in Wire.API.Push.V2 Methods schema :: ValueSchema NamedSwaggerDoc ApsData Source #
type Rep ApsData Source #
Instance details Defined in Wire.API.Push.V2 type Rep ApsData = D1 ('MetaData "ApsData" "Wire.API.Push.V2" "wire-api-0.1.0-EbZS9CKNOfZ8BBy5DRJfXi" 'False) (C1 ('MetaCons "ApsData" 'PrefixI 'True) ((S1 ('MetaSel ('Just "_apsLocKey") 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 ApsLocKey) :: S1 ('MetaSel ('Just "_apsLocArgs") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 [Text])) :: (S1 ('MetaSel ('Just "_apsSound") 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 (Maybe ApsSound)) :*: S1 ('MetaSel ('Just "_apsBadge") 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 Bool))))

newtype ApsLocKey Source #

Constructors

ApsLocKey
Fields fromLocKey :: Text

Instances

Instances details

Arbitrary ApsLocKey Source #
Instance details Defined in Wire.API.Push.V2 Methods arbitrary :: Gen ApsLocKey Source # shrink :: ApsLocKey -> [ApsLocKey] Source #
FromJSON ApsLocKey Source #
Instance details Defined in Wire.API.Push.V2 Methods parseJSON :: Value -> Parser ApsLocKey Source # parseJSONList :: Value -> Parser [ApsLocKey] Source #
ToJSON ApsLocKey Source #
Instance details Defined in Wire.API.Push.V2 Methods toJSON :: ApsLocKey -> Value Source # toEncoding :: ApsLocKey -> Encoding Source # toJSONList :: [ApsLocKey] -> Value Source # toEncodingList :: [ApsLocKey] -> Encoding Source #
Show ApsLocKey Source #
Instance details Defined in Wire.API.Push.V2 Methods showsPrec :: Int -> ApsLocKey -> ShowS # show :: ApsLocKey -> String # showList :: [ApsLocKey] -> ShowS #
Eq ApsLocKey Source #
Instance details Defined in Wire.API.Push.V2 Methods (==) :: ApsLocKey -> ApsLocKey -> Bool # (/=) :: ApsLocKey -> ApsLocKey -> Bool #
ToSchema ApsLocKey Source #
Instance details Defined in Wire.API.Push.V2 Methods schema :: ValueSchema NamedSwaggerDoc ApsLocKey Source #

newtype ApsSound Source #

Constructors

ApsSound
Fields fromSound :: Text

Instances

Instances details

Arbitrary ApsSound Source #
Instance details Defined in Wire.API.Push.V2 Methods arbitrary :: Gen ApsSound Source # shrink :: ApsSound -> [ApsSound] Source #
FromJSON ApsSound Source #
Instance details Defined in Wire.API.Push.V2 Methods parseJSON :: Value -> Parser ApsSound Source # parseJSONList :: Value -> Parser [ApsSound] Source #
ToJSON ApsSound Source #
Instance details Defined in Wire.API.Push.V2 Methods toJSON :: ApsSound -> Value Source # toEncoding :: ApsSound -> Encoding Source # toJSONList :: [ApsSound] -> Value Source # toEncodingList :: [ApsSound] -> Encoding Source #
Show ApsSound Source #
Instance details Defined in Wire.API.Push.V2 Methods showsPrec :: Int -> ApsSound -> ShowS # show :: ApsSound -> String # showList :: [ApsSound] -> ShowS #
Eq ApsSound Source #
Instance details Defined in Wire.API.Push.V2 Methods (==) :: ApsSound -> ApsSound -> Bool # (/=) :: ApsSound -> ApsSound -> Bool #
ToSchema ApsSound Source #
Instance details Defined in Wire.API.Push.V2 Methods schema :: ValueSchema NamedSwaggerDoc ApsSound Source #

apsData :: ApsLocKey -> [Text] -> ApsData Source #

apsLocKey :: Lens' ApsData ApsLocKey Source #

apsLocArgs :: Lens' ApsData [Text] Source #

apsSound :: Lens' ApsData (Maybe ApsSound) Source #

apsBadge :: Lens' ApsData Bool Source #

Priority (re-export)

data Priority Source #

Native push notification priority flag. LowPriority is never used, but might be in the future.

@neongreen writes: [...] nobody seems to ever set native_priority in the client code. Exhibits A1 and A2:

Instances

Instances details

Arbitrary Priority Source #
Instance details Defined in Wire.API.Message Methods arbitrary :: Gen Priority Source # shrink :: Priority -> [Priority] Source #
FromJSON Priority Source #
Instance details Defined in Wire.API.Message Methods parseJSON :: Value -> Parser Priority Source # parseJSONList :: Value -> Parser [Priority] Source #
ToJSON Priority Source #
Instance details Defined in Wire.API.Message Methods toJSON :: Priority -> Value Source # toEncoding :: Priority -> Encoding Source # toJSONList :: [Priority] -> Value Source # toEncodingList :: [Priority] -> Encoding Source #
Enum Priority Source #
Instance details Defined in Wire.API.Message Methods succ :: Priority -> Priority # pred :: Priority -> Priority # toEnum :: Int -> Priority # fromEnum :: Priority -> Int # enumFrom :: Priority -> [Priority] # enumFromThen :: Priority -> Priority -> [Priority] # enumFromTo :: Priority -> Priority -> [Priority] # enumFromThenTo :: Priority -> Priority -> Priority -> [Priority] #
Generic Priority Source #
Instance details Defined in Wire.API.Message Associated Types type Rep Priority :: Type -> Type # Methods from :: Priority -> Rep Priority x # to :: Rep Priority x -> Priority #
Show Priority Source #
Instance details Defined in Wire.API.Message Methods showsPrec :: Int -> Priority -> ShowS # show :: Priority -> String # showList :: [Priority] -> ShowS #
Eq Priority Source #
Instance details Defined in Wire.API.Message Methods (==) :: Priority -> Priority -> Bool # (/=) :: Priority -> Priority -> Bool #
Ord Priority Source #
Instance details Defined in Wire.API.Message Methods compare :: Priority -> Priority -> Ordering # (<) :: Priority -> Priority -> Bool # (<=) :: Priority -> Priority -> Bool # (>) :: Priority -> Priority -> Bool # (>=) :: Priority -> Priority -> Bool # max :: Priority -> Priority -> Priority # min :: Priority -> Priority -> Priority #
ToSchema Priority Source #
Instance details Defined in Wire.API.Message Methods declareNamedSchema :: Proxy Priority -> Declare (Definitions Schema) NamedSchema Source #
ToSchema Priority Source #
Instance details Defined in Wire.API.Message Methods schema :: ValueSchema NamedSwaggerDoc Priority Source #
type Rep Priority Source #
Instance details Defined in Wire.API.Message type Rep Priority = D1 ('MetaData "Priority" "Wire.API.Message" "wire-api-0.1.0-EbZS9CKNOfZ8BBy5DRJfXi" 'False) (C1 ('MetaCons "LowPriority" 'PrefixI 'False) (U1 :: Type -> Type) :+: C1 ('MetaCons "HighPriority" 'PrefixI 'False) (U1 :: Type -> Type))

PushToken (re-export)

newtype PushTokenList Source #

Constructors

PushTokenList
Fields pushTokens :: [PushToken]

Instances

Instances details

Arbitrary PushTokenList Source #
Instance details Defined in Wire.API.Push.V2.Token Methods arbitrary :: Gen PushTokenList Source # shrink :: PushTokenList -> [PushTokenList] Source #
FromJSON PushTokenList Source #
Instance details Defined in Wire.API.Push.V2.Token Methods parseJSON :: Value -> Parser PushTokenList Source # parseJSONList :: Value -> Parser [PushTokenList] Source #
ToJSON PushTokenList Source #
Instance details Defined in Wire.API.Push.V2.Token Methods toJSON :: PushTokenList -> Value Source # toEncoding :: PushTokenList -> Encoding Source # toJSONList :: [PushTokenList] -> Value Source # toEncodingList :: [PushTokenList] -> Encoding Source #
Show PushTokenList Source #
Instance details Defined in Wire.API.Push.V2.Token Methods showsPrec :: Int -> PushTokenList -> ShowS # show :: PushTokenList -> String # showList :: [PushTokenList] -> ShowS #
Eq PushTokenList Source #
Instance details Defined in Wire.API.Push.V2.Token Methods (==) :: PushTokenList -> PushTokenList -> Bool # (/=) :: PushTokenList -> PushTokenList -> Bool #
ToSchema PushTokenList Source #
Instance details Defined in Wire.API.Push.V2.Token Methods declareNamedSchema :: Proxy PushTokenList -> Declare (Definitions Schema) NamedSchema Source #
ToSchema PushTokenList Source #
Instance details Defined in Wire.API.Push.V2.Token Methods schema :: ValueSchema NamedSwaggerDoc PushTokenList Source #

data PushToken Source #

Instances

Instances details

Arbitrary PushToken Source #
Instance details Defined in Wire.API.Push.V2.Token Methods arbitrary :: Gen PushToken Source # shrink :: PushToken -> [PushToken] Source #
FromJSON PushToken Source #
Instance details Defined in Wire.API.Push.V2.Token Methods parseJSON :: Value -> Parser PushToken Source # parseJSONList :: Value -> Parser [PushToken] Source #
ToJSON PushToken Source #
Instance details Defined in Wire.API.Push.V2.Token Methods toJSON :: PushToken -> Value Source # toEncoding :: PushToken -> Encoding Source # toJSONList :: [PushToken] -> Value Source # toEncodingList :: [PushToken] -> Encoding Source #
Generic PushToken Source #
Instance details Defined in Wire.API.Push.V2.Token Associated Types type Rep PushToken :: Type -> Type # Methods from :: PushToken -> Rep PushToken x # to :: Rep PushToken x -> PushToken #
Show PushToken Source #
Instance details Defined in Wire.API.Push.V2.Token Methods showsPrec :: Int -> PushToken -> ShowS # show :: PushToken -> String # showList :: [PushToken] -> ShowS #
Eq PushToken Source #
Instance details Defined in Wire.API.Push.V2.Token Methods (==) :: PushToken -> PushToken -> Bool # (/=) :: PushToken -> PushToken -> Bool #
Ord PushToken Source #
Instance details Defined in Wire.API.Push.V2.Token Methods compare :: PushToken -> PushToken -> Ordering # (<) :: PushToken -> PushToken -> Bool # (<=) :: PushToken -> PushToken -> Bool # (>) :: PushToken -> PushToken -> Bool # (>=) :: PushToken -> PushToken -> Bool # max :: PushToken -> PushToken -> PushToken # min :: PushToken -> PushToken -> PushToken #
ToSchema PushToken Source #
Instance details Defined in Wire.API.Push.V2.Token Methods declareNamedSchema :: Proxy PushToken -> Declare (Definitions Schema) NamedSchema Source #
ToSchema PushToken Source #
Instance details Defined in Wire.API.Push.V2.Token Methods schema :: ValueSchema NamedSwaggerDoc PushToken Source #
AsHeaders '[Token] PushToken AddTokenSuccess Source #
Instance details Defined in Wire.API.Push.V2.Token Methods fromHeaders :: (NP I '[Token], PushToken) -> AddTokenSuccess Source # toHeaders :: AddTokenSuccess -> (NP I '[Token], PushToken) Source #
type Rep PushToken Source #
Instance details Defined in Wire.API.Push.V2.Token type Rep PushToken = D1 ('MetaData "PushToken" "Wire.API.Push.V2.Token" "wire-api-0.1.0-EbZS9CKNOfZ8BBy5DRJfXi" 'False) (C1 ('MetaCons "PushToken" 'PrefixI 'True) ((S1 ('MetaSel ('Just "_tokenTransport") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Transport) :: S1 ('MetaSel ('Just "_tokenApp") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 AppName)) :: (S1 ('MetaSel ('Just "_token") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Token) :*: S1 ('MetaSel ('Just "_tokenClient") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 ClientId))))

pushToken :: Transport -> AppName -> Token -> ClientId -> PushToken Source #

tokenTransport :: Lens' PushToken Transport Source #

tokenApp :: Lens' PushToken AppName Source #

tokenClient :: Lens' PushToken ClientId Source #

token :: Lens' PushToken Token Source #

PushToken fields (re-export)

newtype Token Source #

Constructors

Token
Fields tokenText :: Text

Instances

Instances details

Arbitrary Token Source #
Instance details Defined in Wire.API.Push.V2.Token Methods arbitrary :: Gen Token Source # shrink :: Token -> [Token] Source #
FromJSON Token Source #
Instance details Defined in Wire.API.Push.V2.Token Methods parseJSON :: Value -> Parser Token Source # parseJSONList :: Value -> Parser [Token] Source #
ToJSON Token Source #
Instance details Defined in Wire.API.Push.V2.Token Methods toJSON :: Token -> Value Source # toEncoding :: Token -> Encoding Source # toJSONList :: [Token] -> Value Source # toEncodingList :: [Token] -> Encoding Source #
Show Token Source #
Instance details Defined in Wire.API.Push.V2.Token Methods showsPrec :: Int -> Token -> ShowS # show :: Token -> String # showList :: [Token] -> ShowS #
FromByteString Token Source #
Instance details Defined in Wire.API.Push.V2.Token Methods parser :: Parser Token Source #
ToByteString Token Source #
Instance details Defined in Wire.API.Push.V2.Token Methods builder :: Token -> Builder Source #
Eq Token Source #
Instance details Defined in Wire.API.Push.V2.Token Methods (==) :: Token -> Token -> Bool # (/=) :: Token -> Token -> Bool #
Ord Token Source #
Instance details Defined in Wire.API.Push.V2.Token Methods compare :: Token -> Token -> Ordering # (<) :: Token -> Token -> Bool # (<=) :: Token -> Token -> Bool # (>) :: Token -> Token -> Bool # (>=) :: Token -> Token -> Bool # max :: Token -> Token -> Token # min :: Token -> Token -> Token #
FromHttpApiData Token Source #
Instance details Defined in Wire.API.Push.V2.Token Methods parseUrlPiece :: Text -> Either Text Token Source # parseHeader :: ByteString -> Either Text Token Source # parseQueryParam :: Text -> Either Text Token Source #
ToHttpApiData Token Source #
Instance details Defined in Wire.API.Push.V2.Token Methods toUrlPiece :: Token -> Text Source # toEncodedUrlPiece :: Token -> Builder Source # toHeader :: Token -> ByteString Source # toQueryParam :: Token -> Text Source # toEncodedQueryParam :: Token -> Builder Source #
ToParamSchema Token Source #
Instance details Defined in Wire.API.Push.V2.Token Methods toParamSchema :: Proxy Token -> Schema Source #
ToSchema Token Source #
Instance details Defined in Wire.API.Push.V2.Token Methods declareNamedSchema :: Proxy Token -> Declare (Definitions Schema) NamedSchema Source #
ToSchema Token Source #
Instance details Defined in Wire.API.Push.V2.Token Methods schema :: ValueSchema NamedSwaggerDoc Token Source #
AsHeaders '[Token] PushToken AddTokenSuccess Source #
Instance details Defined in Wire.API.Push.V2.Token Methods fromHeaders :: (NP I '[Token], PushToken) -> AddTokenSuccess Source # toHeaders :: AddTokenSuccess -> (NP I '[Token], PushToken) Source #

data Transport Source #

Constructors

GCM
APNS
APNSSandbox
APNSVoIP
APNSVoIPSandbox

Instances

Instances details

Arbitrary Transport Source #
Instance details Defined in Wire.API.Push.V2.Token Methods arbitrary :: Gen Transport Source # shrink :: Transport -> [Transport] Source #
FromJSON Transport Source #
Instance details Defined in Wire.API.Push.V2.Token Methods parseJSON :: Value -> Parser Transport Source # parseJSONList :: Value -> Parser [Transport] Source #
ToJSON Transport Source #
Instance details Defined in Wire.API.Push.V2.Token Methods toJSON :: Transport -> Value Source # toEncoding :: Transport -> Encoding Source # toJSONList :: [Transport] -> Value Source # toEncodingList :: [Transport] -> Encoding Source #
Bounded Transport Source #
Instance details Defined in Wire.API.Push.V2.Token Methods minBound :: Transport # maxBound :: Transport #
Enum Transport Source #
Instance details Defined in Wire.API.Push.V2.Token Methods succ :: Transport -> Transport # pred :: Transport -> Transport # toEnum :: Int -> Transport # fromEnum :: Transport -> Int # enumFrom :: Transport -> [Transport] # enumFromThen :: Transport -> Transport -> [Transport] # enumFromTo :: Transport -> Transport -> [Transport] # enumFromThenTo :: Transport -> Transport -> Transport -> [Transport] #
Generic Transport Source #
Instance details Defined in Wire.API.Push.V2.Token Associated Types type Rep Transport :: Type -> Type # Methods from :: Transport -> Rep Transport x # to :: Rep Transport x -> Transport #
Show Transport Source #
Instance details Defined in Wire.API.Push.V2.Token Methods showsPrec :: Int -> Transport -> ShowS # show :: Transport -> String # showList :: [Transport] -> ShowS #
FromByteString Transport Source #
Instance details Defined in Wire.API.Push.V2.Token Methods parser :: Parser Transport Source #
Eq Transport Source #
Instance details Defined in Wire.API.Push.V2.Token Methods (==) :: Transport -> Transport -> Bool # (/=) :: Transport -> Transport -> Bool #
Ord Transport Source #
Instance details Defined in Wire.API.Push.V2.Token Methods compare :: Transport -> Transport -> Ordering # (<) :: Transport -> Transport -> Bool # (<=) :: Transport -> Transport -> Bool # (>) :: Transport -> Transport -> Bool # (>=) :: Transport -> Transport -> Bool # max :: Transport -> Transport -> Transport # min :: Transport -> Transport -> Transport #
ToSchema Transport Source #
Instance details Defined in Wire.API.Push.V2.Token Methods declareNamedSchema :: Proxy Transport -> Declare (Definitions Schema) NamedSchema Source #
ToSchema Transport Source #
Instance details Defined in Wire.API.Push.V2.Token Methods schema :: ValueSchema NamedSwaggerDoc Transport Source #
type Rep Transport Source #
Instance details Defined in Wire.API.Push.V2.Token type Rep Transport = D1 ('MetaData "Transport" "Wire.API.Push.V2.Token" "wire-api-0.1.0-EbZS9CKNOfZ8BBy5DRJfXi" 'False) ((C1 ('MetaCons "GCM" 'PrefixI 'False) (U1 :: Type -> Type) :+: C1 ('MetaCons "APNS" 'PrefixI 'False) (U1 :: Type -> Type)) :+: (C1 ('MetaCons "APNSSandbox" 'PrefixI 'False) (U1 :: Type -> Type) :+: (C1 ('MetaCons "APNSVoIP" 'PrefixI 'False) (U1 :: Type -> Type) :+: C1 ('MetaCons "APNSVoIPSandbox" 'PrefixI 'False) (U1 :: Type -> Type))))

newtype AppName Source #

Constructors

AppName
Fields appNameText :: Text

Instances

Instances details

Arbitrary AppName Source #
Instance details Defined in Wire.API.Push.V2.Token Methods arbitrary :: Gen AppName Source # shrink :: AppName -> [AppName] Source #
FromJSON AppName Source #
Instance details Defined in Wire.API.Push.V2.Token Methods parseJSON :: Value -> Parser AppName Source # parseJSONList :: Value -> Parser [AppName] Source #
ToJSON AppName Source #
Instance details Defined in Wire.API.Push.V2.Token Methods toJSON :: AppName -> Value Source # toEncoding :: AppName -> Encoding Source # toJSONList :: [AppName] -> Value Source # toEncodingList :: [AppName] -> Encoding Source #
IsString AppName Source #
Instance details Defined in Wire.API.Push.V2.Token Methods fromString :: String -> AppName #
Show AppName Source #
Instance details Defined in Wire.API.Push.V2.Token Methods showsPrec :: Int -> AppName -> ShowS # show :: AppName -> String # showList :: [AppName] -> ShowS #
Eq AppName Source #
Instance details Defined in Wire.API.Push.V2.Token Methods (==) :: AppName -> AppName -> Bool # (/=) :: AppName -> AppName -> Bool #
Ord AppName Source #
Instance details Defined in Wire.API.Push.V2.Token Methods compare :: AppName -> AppName -> Ordering # (<) :: AppName -> AppName -> Bool # (<=) :: AppName -> AppName -> Bool # (>) :: AppName -> AppName -> Bool # (>=) :: AppName -> AppName -> Bool # max :: AppName -> AppName -> AppName # min :: AppName -> AppName -> AppName #
ToSchema AppName Source #
Instance details Defined in Wire.API.Push.V2.Token Methods declareNamedSchema :: Proxy AppName -> Declare (Definitions Schema) NamedSchema Source #
ToSchema AppName Source #
Instance details Defined in Wire.API.Push.V2.Token Methods schema :: ValueSchema NamedSwaggerDoc AppName Source #