Safe Haskell	None
Language	Haskell2010

DMCC.Types

Description

Shared type declarations.

Synopsis

newtype DeviceId = DeviceId (CI Text)
newtype CallId = CallId Text
newtype UCID = UCID Text
newtype Extension = Extension Text
newtype SwitchName = SwitchName Text
newtype AgentId = AgentId (SwitchName, Extension)
data CallDirection
- = In {
  - vdn :: DeviceId
  }
- | Out
data Call = Call {
- direction :: CallDirection
- ucid :: UCID
- start :: UTCTime
- interlocutors :: [DeviceId]
- answered :: Maybe UTCTime
- held :: Bool
- failed :: Bool
}
data SettableAgentState
- = Ready
- | AfterCall
- | NotReady
- | Logout
data AgentState
- = Busy
- | Settable SettableAgentState
data ParticipationType
- = Active
- | Silent
newtype LoggingOptions = LoggingOptions {
- syslogIdent :: ByteString
}
data SessionOptions = SessionOptions {
- statePollingDelay :: Int
- sessionDuration :: Int
- connectionRetryAttempts :: Int
- connectionRetryDelay :: Int
}

Documentation

newtype DeviceId Source #

Device ID used in DMCC requests.

This is based on text as stated in DMCC specification.

Constructors

DeviceId (CI Text)

Instances

Eq DeviceId Source #
Instance details Defined in DMCC.Types Methods (==) :: DeviceId -> DeviceId -> Bool # (/=) :: DeviceId -> DeviceId -> Bool #
Ord DeviceId Source #
Instance details Defined in DMCC.Types 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 Source #
Instance details Defined in DMCC.Types Methods showsPrec :: Int -> DeviceId -> ShowS # show :: DeviceId -> String # showList :: [DeviceId] -> ShowS #
ToJSON DeviceId Source #
Instance details Defined in DMCC.Types Methods toJSON :: DeviceId -> Value # toEncoding :: DeviceId -> Encoding # toJSONList :: [DeviceId] -> Value # toEncodingList :: [DeviceId] -> Encoding #
FromJSON DeviceId Source #
Instance details Defined in DMCC.Types Methods parseJSON :: Value -> Parser DeviceId # parseJSONList :: Value -> Parser [DeviceId] #
ToText DeviceId Source #
Instance details Defined in DMCC.XML.Request Methods toText :: DeviceId -> Text Source #

newtype CallId Source #

Constructors

CallId Text

Instances

Eq CallId Source #
Instance details Defined in DMCC.Types Methods (==) :: CallId -> CallId -> Bool # (/=) :: CallId -> CallId -> Bool #
Ord CallId Source #
Instance details Defined in DMCC.Types Methods compare :: CallId -> CallId -> Ordering # (<) :: CallId -> CallId -> Bool # (<=) :: CallId -> CallId -> Bool # (>) :: CallId -> CallId -> Bool # (>=) :: CallId -> CallId -> Bool # max :: CallId -> CallId -> CallId # min :: CallId -> CallId -> CallId #
Show CallId Source #
Instance details Defined in DMCC.Types Methods showsPrec :: Int -> CallId -> ShowS # show :: CallId -> String # showList :: [CallId] -> ShowS #
ToJSON CallId Source #
Instance details Defined in DMCC.Types Methods toJSON :: CallId -> Value # toEncoding :: CallId -> Encoding # toJSONList :: [CallId] -> Value # toEncodingList :: [CallId] -> Encoding #
FromJSON CallId Source #
Instance details Defined in DMCC.Types Methods parseJSON :: Value -> Parser CallId # parseJSONList :: Value -> Parser [CallId] #
ToText CallId Source #
Instance details Defined in DMCC.XML.Request Methods toText :: CallId -> Text Source #

newtype UCID Source #

Globally unique call ID.

Constructors

UCID Text

Instances

Eq UCID Source #
Instance details Defined in DMCC.Types Methods (==) :: UCID -> UCID -> Bool # (/=) :: UCID -> UCID -> Bool #
Ord UCID Source #
Instance details Defined in DMCC.Types Methods compare :: UCID -> UCID -> Ordering # (<) :: UCID -> UCID -> Bool # (<=) :: UCID -> UCID -> Bool # (>) :: UCID -> UCID -> Bool # (>=) :: UCID -> UCID -> Bool # max :: UCID -> UCID -> UCID # min :: UCID -> UCID -> UCID #
Show UCID Source #
Instance details Defined in DMCC.Types Methods showsPrec :: Int -> UCID -> ShowS # show :: UCID -> String # showList :: [UCID] -> ShowS #
ToJSON UCID Source #
Instance details Defined in DMCC.Types Methods toJSON :: UCID -> Value # toEncoding :: UCID -> Encoding # toJSONList :: [UCID] -> Value # toEncodingList :: [UCID] -> Encoding #
FromJSON UCID Source #
Instance details Defined in DMCC.Types Methods parseJSON :: Value -> Parser UCID # parseJSONList :: Value -> Parser [UCID] #

newtype Extension Source #

Constructors

Extension Text

Instances

Eq Extension Source #
Instance details Defined in DMCC.Types Methods (==) :: Extension -> Extension -> Bool # (/=) :: Extension -> Extension -> Bool #
Data Extension Source #
Instance details Defined in DMCC.Types Methods gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> Extension -> c Extension # gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c Extension # toConstr :: Extension -> Constr # dataTypeOf :: Extension -> DataType # dataCast1 :: Typeable t => (forall d. Data d => c (t d)) -> Maybe (c Extension) # dataCast2 :: Typeable t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c Extension) # gmapT :: (forall b. Data b => b -> b) -> Extension -> Extension # gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> Extension -> r # gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> Extension -> r # gmapQ :: (forall d. Data d => d -> u) -> Extension -> [u] # gmapQi :: Int -> (forall d. Data d => d -> u) -> Extension -> u # gmapM :: Monad m => (forall d. Data d => d -> m d) -> Extension -> m Extension # gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> Extension -> m Extension # gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> Extension -> m Extension #
Ord Extension Source #
Instance details Defined in DMCC.Types Methods compare :: Extension -> Extension -> Ordering # (<) :: Extension -> Extension -> Bool # (<=) :: Extension -> Extension -> Bool # (>) :: Extension -> Extension -> Bool # (>=) :: Extension -> Extension -> Bool # max :: Extension -> Extension -> Extension # min :: Extension -> Extension -> Extension #
Show Extension Source #
Instance details Defined in DMCC.Types Methods showsPrec :: Int -> Extension -> ShowS # show :: Extension -> String # showList :: [Extension] -> ShowS #
ToJSON Extension Source #
Instance details Defined in DMCC.Types Methods toJSON :: Extension -> Value # toEncoding :: Extension -> Encoding # toJSONList :: [Extension] -> Value # toEncodingList :: [Extension] -> Encoding #
FromJSON Extension Source #
Instance details Defined in DMCC.Types Methods parseJSON :: Value -> Parser Extension # parseJSONList :: Value -> Parser [Extension] #
ToText Extension Source #
Instance details Defined in DMCC.XML.Request Methods toText :: Extension -> Text Source #

newtype SwitchName Source #

Constructors

SwitchName Text

Instances

Eq SwitchName Source #
Instance details Defined in DMCC.Types Methods (==) :: SwitchName -> SwitchName -> Bool # (/=) :: SwitchName -> SwitchName -> Bool #
Data SwitchName Source #
Instance details Defined in DMCC.Types Methods gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> SwitchName -> c SwitchName # gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c SwitchName # toConstr :: SwitchName -> Constr # dataTypeOf :: SwitchName -> DataType # dataCast1 :: Typeable t => (forall d. Data d => c (t d)) -> Maybe (c SwitchName) # dataCast2 :: Typeable t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c SwitchName) # gmapT :: (forall b. Data b => b -> b) -> SwitchName -> SwitchName # gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> SwitchName -> r # gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> SwitchName -> r # gmapQ :: (forall d. Data d => d -> u) -> SwitchName -> [u] # gmapQi :: Int -> (forall d. Data d => d -> u) -> SwitchName -> u # gmapM :: Monad m => (forall d. Data d => d -> m d) -> SwitchName -> m SwitchName # gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> SwitchName -> m SwitchName # gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> SwitchName -> m SwitchName #
Ord SwitchName Source #
Instance details Defined in DMCC.Types Methods compare :: SwitchName -> SwitchName -> Ordering # (<) :: SwitchName -> SwitchName -> Bool # (<=) :: SwitchName -> SwitchName -> Bool # (>) :: SwitchName -> SwitchName -> Bool # (>=) :: SwitchName -> SwitchName -> Bool # max :: SwitchName -> SwitchName -> SwitchName # min :: SwitchName -> SwitchName -> SwitchName #
Show SwitchName Source #
Instance details Defined in DMCC.Types Methods showsPrec :: Int -> SwitchName -> ShowS # show :: SwitchName -> String # showList :: [SwitchName] -> ShowS #
ToJSON SwitchName Source #
Instance details Defined in DMCC.Types Methods toJSON :: SwitchName -> Value # toEncoding :: SwitchName -> Encoding # toJSONList :: [SwitchName] -> Value # toEncodingList :: [SwitchName] -> Encoding #
FromJSON SwitchName Source #
Instance details Defined in DMCC.Types Methods parseJSON :: Value -> Parser SwitchName # parseJSONList :: Value -> Parser [SwitchName] #
ToText SwitchName Source #
Instance details Defined in DMCC.XML.Request Methods toText :: SwitchName -> Text Source #

newtype AgentId Source #

Constructors

AgentId (SwitchName, Extension)

Instances

Eq AgentId Source #
Instance details Defined in DMCC.Types Methods (==) :: AgentId -> AgentId -> Bool # (/=) :: AgentId -> AgentId -> Bool #
Data AgentId Source #
Instance details Defined in DMCC.Types Methods gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> AgentId -> c AgentId # gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c AgentId # toConstr :: AgentId -> Constr # dataTypeOf :: AgentId -> DataType # dataCast1 :: Typeable t => (forall d. Data d => c (t d)) -> Maybe (c AgentId) # dataCast2 :: Typeable t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c AgentId) # gmapT :: (forall b. Data b => b -> b) -> AgentId -> AgentId # gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> AgentId -> r # gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> AgentId -> r # gmapQ :: (forall d. Data d => d -> u) -> AgentId -> [u] # gmapQi :: Int -> (forall d. Data d => d -> u) -> AgentId -> u # gmapM :: Monad m => (forall d. Data d => d -> m d) -> AgentId -> m AgentId # gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> AgentId -> m AgentId # gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> AgentId -> m AgentId #
Ord AgentId Source #
Instance details Defined in DMCC.Types Methods compare :: AgentId -> AgentId -> Ordering # (<) :: AgentId -> AgentId -> Bool # (<=) :: AgentId -> AgentId -> Bool # (>) :: AgentId -> AgentId -> Bool # (>=) :: AgentId -> AgentId -> Bool # max :: AgentId -> AgentId -> AgentId # min :: AgentId -> AgentId -> AgentId #
Show AgentId Source #
Instance details Defined in DMCC.Types Methods showsPrec :: Int -> AgentId -> ShowS # show :: AgentId -> String # showList :: [AgentId] -> ShowS #
ToJSON AgentId Source #
Instance details Defined in DMCC.Types Methods toJSON :: AgentId -> Value # toEncoding :: AgentId -> Encoding # toJSONList :: [AgentId] -> Value # toEncodingList :: [AgentId] -> Encoding #
FromJSON AgentId Source #
Instance details Defined in DMCC.Types Methods parseJSON :: Value -> Parser AgentId # parseJSONList :: Value -> Parser [AgentId] #

data CallDirection Source #

Constructors

In
Fields vdn :: DeviceId
Out

Instances

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

data Call Source #

Constructors

Call
Fields direction :: CallDirection ucid :: UCID start :: UTCTime When did call came into existence? interlocutors :: [DeviceId] answered :: Maybe UTCTime When did another party answer this call? held :: Bool failed :: Bool

Instances

Show Call Source #
Instance details Defined in DMCC.Types Methods showsPrec :: Int -> Call -> ShowS # show :: Call -> String # showList :: [Call] -> ShowS #
ToJSON Call Source #
Instance details Defined in DMCC.Types Methods toJSON :: Call -> Value # toEncoding :: Call -> Encoding # toJSONList :: [Call] -> Value # toEncodingList :: [Call] -> Encoding #
FromJSON Call Source #
Instance details Defined in DMCC.Types Methods parseJSON :: Value -> Parser Call # parseJSONList :: Value -> Parser [Call] #

data SettableAgentState Source #

Constructors

Ready
AfterCall
NotReady
Logout

Instances

Eq SettableAgentState Source #
Instance details Defined in DMCC.Types Methods (==) :: SettableAgentState -> SettableAgentState -> Bool # (/=) :: SettableAgentState -> SettableAgentState -> Bool #
Show SettableAgentState Source #
Instance details Defined in DMCC.Types Methods showsPrec :: Int -> SettableAgentState -> ShowS # show :: SettableAgentState -> String # showList :: [SettableAgentState] -> ShowS #
ToJSON SettableAgentState Source #
Instance details Defined in DMCC.Types Methods toJSON :: SettableAgentState -> Value # toEncoding :: SettableAgentState -> Encoding # toJSONList :: [SettableAgentState] -> Value # toEncodingList :: [SettableAgentState] -> Encoding #
FromJSON SettableAgentState Source #
Instance details Defined in DMCC.Types Methods parseJSON :: Value -> Parser SettableAgentState # parseJSONList :: Value -> Parser [SettableAgentState] #
ToText SettableAgentState Source #
Instance details Defined in DMCC.XML.Request Methods toText :: SettableAgentState -> Text Source #

data AgentState Source #

Constructors

Busy
Settable SettableAgentState

Instances

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

data ParticipationType Source #

Constructors

Active
Silent

Instances

Eq ParticipationType Source #
Instance details Defined in DMCC.Types Methods (==) :: ParticipationType -> ParticipationType -> Bool # (/=) :: ParticipationType -> ParticipationType -> Bool #
Show ParticipationType Source #
Instance details Defined in DMCC.Types Methods showsPrec :: Int -> ParticipationType -> ShowS # show :: ParticipationType -> String # showList :: [ParticipationType] -> ShowS #
ToJSON ParticipationType Source #
Instance details Defined in DMCC.Types Methods toJSON :: ParticipationType -> Value # toEncoding :: ParticipationType -> Encoding # toJSONList :: [ParticipationType] -> Value # toEncodingList :: [ParticipationType] -> Encoding #
FromJSON ParticipationType Source #
Instance details Defined in DMCC.Types Methods parseJSON :: Value -> Parser ParticipationType # parseJSONList :: Value -> Parser [ParticipationType] #
ToText ParticipationType Source #
Instance details Defined in DMCC.XML.Request Methods toText :: ParticipationType -> Text Source #

newtype LoggingOptions Source #

Constructors

LoggingOptions
Fields syslogIdent :: ByteString

data SessionOptions Source #

Constructors

SessionOptions
Fields statePollingDelay :: Int How often to poll every agent for state changes (in seconds). sessionDuration :: Int Serves both as session duration and session cleanup delay (in seconds). connectionRetryAttempts :: Int connectionRetryDelay :: Int In seconds.