Matterhorn.Types.Users

Documentation

data UserInfo

A UserInfo value represents everything we need to know at runtime about a user

Constructors

UserInfo

Fields

• _uiName :: Text
• _uiId :: UserId
• _uiStatus :: UserStatus
• _uiInTeam :: Bool
• _uiNickName :: Maybe Text
• _uiFirstName :: Text
• _uiLastName :: Text
• _uiEmail :: Text
• _uiDeleted :: Bool

Instances

Eq UserInfo

Defined in Matterhorn.Types.Users

Methods

(==) :: UserInfo -> UserInfo -> Bool

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

Show UserInfo

Defined in Matterhorn.Types.Users

Methods

showsPrec :: Int -> UserInfo -> ShowS

show :: UserInfo -> String

showList :: [UserInfo] -> ShowS

data UserStatus

The UserStatus value represents possible current status for a user

Constructors

Online

Away

Offline

DoNotDisturb

Other Text

Instances

Eq UserStatus

Defined in Matterhorn.Types.Users

Methods

(==) :: UserStatus -> UserStatus -> Bool

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

Show UserStatus

Defined in Matterhorn.Types.Users

Methods

showsPrec :: Int -> UserStatus -> ShowS

show :: UserStatus -> String

showList :: [UserStatus] -> ShowS

type Users = AllMyUsers UserInfo

Define the exported typename which universally binds the collection to the UserInfo type.

Lenses created for accessing UserInfo fields

uiName :: Lens' UserInfo Text

uiId :: Lens' UserInfo UserId

uiStatus :: Lens' UserInfo UserStatus

uiInTeam :: Lens' UserInfo Bool

uiNickName :: Lens' UserInfo (Maybe Text)

uiFirstName :: Lens' UserInfo Text

uiLastName :: Lens' UserInfo Text

uiEmail :: Lens' UserInfo Text

uiDeleted :: Lens' UserInfo Bool

Various operations on UserInfo

Creating UserInfo objects

userInfoFromUser :: User -> Bool -> UserInfo

Create a UserInfo value from a Mattermost User value

Miscellaneous

getUsernameSet :: Users -> Set Text

trimUserSigil :: Text -> Text

statusFromText :: Text -> UserStatus

findUserById :: UserId -> Users -> Maybe UserInfo

Get the User information given the UserId

findUserByUsername :: Text -> Users -> Maybe (UserId, UserInfo)

Get the User information given the user's name. This is an exact match on the username field. It will automatically trim a user sigil from the input.

findUserByNickname :: Text -> Users -> Maybe (UserId, UserInfo)

Get the User information given the user's name. This is an exact match on the nickname field, not necessarily the presented name. It will automatically trim a user sigil from the input.

noUsers :: Users

Initial collection of Users with no members

addUser :: UserInfo -> Users -> Users

Add a member to the existing collection of Users

allUsers :: Users -> [UserInfo]

Get a list of all known users

modifyUserById :: UserId -> (UserInfo -> UserInfo) -> Users -> Users

Extract a specific user from the collection and perform an endomorphism operation on it, then put it back into the collection.

userDeleted :: User -> Bool

Is this user deleted?

type TypingUsers = AllMyUsers (Max UTCTime)

Define the exported typename to represent the collection of users | who are currently typing. The values kept against the user id keys are the | latest timestamps of typing events from the server.

noTypingUsers :: TypingUsers

Initial collection of TypingUsers with no members

addTypingUser :: UserId -> UTCTime -> TypingUsers -> TypingUsers

Add a member to the existing collection of TypingUsers

allTypingUsers :: TypingUsers -> [UserId]

Get a list of all typing users

expireTypingUsers :: UTCTime -> TypingUsers -> TypingUsers

Remove all the expired users from the collection of TypingUsers. | Expiry is decided by the given timestamp.

getAllUserIds :: Users -> [UserId]