OpenTok.Token

Documentation

data Role

Information on user roles can be found at https://tokbox.com/developer/guides/create-token/

Constructors

Subscriber

Publisher

Moderator

Instances

Show Role

Defined in OpenTok.Token

Methods

showsPrec :: Int -> Role -> ShowS

show :: Role -> String

showList :: [Role] -> ShowS

data TokenOptions

Constructors

TokenOptions

Fields

• _role :: Role
• _expireTime :: Maybe UTCTime
• _connectionData :: Maybe String
• _initialLayoutClassList :: Maybe [String]

Instances

Show TokenOptions

Defined in OpenTok.Token

Methods

showsPrec :: Int -> TokenOptions -> ShowS

show :: TokenOptions -> String

showList :: [TokenOptions] -> ShowS

Generic TokenOptions

Defined in OpenTok.Token

Associated Types

type Rep TokenOptions :: * -> *

Methods

from :: TokenOptions -> Rep TokenOptions x

to :: Rep TokenOptions x -> TokenOptions

type Rep TokenOptions

Defined in OpenTok.Token

type Rep TokenOptions = D1 (MetaData "TokenOptions" "OpenTok.Token" "opentok-0.0.1-C3l0wmoQLhV5aSIPMnVfOR" False) (C1 (MetaCons "TokenOptions" PrefixI True) ((S1 (MetaSel (Just "_role") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 Role) :*: S1 (MetaSel (Just "_expireTime") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 (Maybe UTCTime))) :*: (S1 (MetaSel (Just "_connectionData") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 (Maybe String)) :*: S1 (MetaSel (Just "_initialLayoutClassList") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 (Maybe [String])))))

tokenOpts :: TokenOptions

Default token options

sanitize :: String -> String

Replace invalid base64 chars

validSessionId :: SessionId -> APIKey -> Bool

Extract an API key from a session Id and compare against provided key

validExpireTime :: TokenOptions -> IO Bool

Validate token options

cleanTokenOptions :: [(a, Maybe b)] -> [(a, Maybe b)]

Remove pairs with Nothing values before creating query string

formatToken :: String -> String

Remove new-line characters from the final token

encodeToken :: APIKey -> APISecret -> SessionId -> TokenOptions -> IO Token

Create a SHA1 encoded token

generate :: APIKey -> APISecret -> SessionId -> TokenOptions -> IO (Either OTError Token)

Generate a new token for an OpenTok session using the provided token options