Web.XING

OAuth

consumer

Arguments

:: ByteString

consumer key

-> ByteString

consumer secret

-> OAuth

Create an OAuth consumer

getRequestToken

Arguments

:: (MonadResource m, MonadBaseControl IO m)

=> OAuth

OAuth consumer

-> Manager

-> m (RequestToken, URL)

request token and authorize URL

Create a request token (temporary credentials)

authorizeUrl

Arguments

:: OAuth

OAuth consumer

-> Credential

request token getRequestToken

-> ByteString

URL to send the user to

URL to obtain OAuth verifier

getAccessToken

Arguments

:: (MonadResource m, MonadBaseControl IO m)

=> RequestToken

request token obtained from getRequestToken

-> Verifier

verifier obtained by calling authorizeUrl

-> OAuth

OAuth consumer (see consumer)

-> Manager

-> m (Credential, ByteString)

Exchange request token for an access token (token credentials)

token :: Credential -> ByteString

extract the token from the Credential

tokenSecret :: Credential -> ByteString

extract the secret from the Credential

newCredential

Arguments

:: ByteString

value for oauth_token

-> ByteString

value for oauth_token_secret

-> Credential

Convenient function to create Credential with OAuth Token and Token Secret.

(re)create an OAuth token (for example access token)

oauthCallback :: OAuth -> Maybe ByteString

Callback uri to redirect after authentication (default: Nothing)

extract the OAuth callback from a consumer

API request interface

apiRequest

Arguments

:: (MonadResource m, MonadBaseControl IO m)

=> OAuth

OAuth consumer

-> Manager

-> AccessToken

-> Method

HTTP verb

-> ByteString

HTTP path

-> m (Response ByteString)

Low level API request interface

data APIError

Constructors

OAuthError String

TokenError String

CallError String

Throttled

Mapping

Instances

Eq APIError

Show APIError

Typeable APIError

Exception APIError

type RequestToken = Credential

type Verifier = ByteString

type AccessToken = Credential

type URL = ByteString

data Manager

Keeps track of open connections for keep-alive. If possible, you should share a single Manager between multiple threads and requests.

data OAuth

Data type for OAuth client (consumer).

The constructor for this data type is not exposed. Instead, you should use the def method or newOAuth function to retrieve a default instance, and then use the records below to make modifications. This approach allows us to add configuration options without breaking backwards compatibility.

Instances

Eq OAuth

Data OAuth

Ord OAuth

Read OAuth

Show OAuth

Typeable OAuth

Default OAuth

data Credential

Data type for redential.

Constructors

Credential

Fields

unCredential :: [(ByteString, ByteString)]

Instances

Eq Credential

Data Credential

Ord Credential

Read Credential

Show Credential

Typeable Credential

data Status

HTTP Status.

Only the statusCode is used for comparisons.

Please use mkStatus to create status codes from code and message, or the Enum instance or the status code constants (like ok200). There might be additional record members in the future.

Note that the Show instance is only for debugging.

Instances

Enum Status

Eq Status

Ord Status

Show Status

XING data types

data Address

Constructors

Address

Fields

street :: Maybe Text

zipCode :: Maybe Text

city :: Maybe Text

province :: Maybe Text

country :: Maybe Text

email :: Maybe Text

phone :: Maybe Text

fax :: Maybe Text

mobilePhone :: Maybe Text

Instances

Eq Address

Show Address

FromJSON Address

data Award

Constructors

Award Text Int (Maybe Text)

Instances

Eq Award

Show Award

FromJSON Award

data BirthDate

Constructors

FullDate Integer Int Int

DayOnly Int Int

Instances

Eq BirthDate

Show BirthDate

FromJSON BirthDate

data ProfessionalExperience

Constructors

ProfessionalExperience

Fields

pe_title :: Maybe Text

pe_beginDate :: Maybe Text

pe_endDate :: Maybe Text

pe_careerLevel :: Maybe Text

pe_description :: Maybe Text

pe_name :: Maybe Text

pe_tag :: Maybe Text

pe_companySize :: Maybe Text

pe_url :: Maybe Text

pe_industry :: Text

Instances

Eq ProfessionalExperience

Show ProfessionalExperience

FromJSON ProfessionalExperience

class User a where

Methods

userId :: a -> UserId

displayName :: a -> Text

permalink :: a -> Text

photoUrls :: a -> PhotoUrls

Instances

User MinimalUser

User FullUser

type UserId = Text

type PhotoUrls = Map Text Text

data FullUser

Instances

Eq FullUser

Show FullUser

FromJSON FullUser

User FullUser

newtype UserList

Constructors

UserList

Fields

unUserList :: [FullUser]

Instances

Show UserList

FromJSON UserList

data Gender

Constructors

Male

Female

Instances

Eq Gender

Show Gender

FromJSON Gender

type Language = Text

type Skill = Text

birthDate :: FullUser -> Maybe BirthDate

gender :: FullUser -> Gender

firstName :: FullUser -> Text

lastName :: FullUser -> Text

activeEmail :: FullUser -> Maybe Text

premiumServices :: FullUser -> [Text]

badges :: FullUser -> [Text]

languages :: FullUser -> Map Language (Maybe Skill)

wants :: FullUser -> Maybe Text

haves :: FullUser -> Maybe Text

interests :: FullUser -> Maybe Text

organisations :: FullUser -> Maybe Text

pageName :: FullUser -> Text

privateAddress :: FullUser -> Address

businessAddress :: FullUser -> Address

data MinimalUser

Constructors

MinimalUser UserId Text Text PhotoUrls

Instances

Eq MinimalUser

Show MinimalUser

FromJSON MinimalUser

User MinimalUser

Calls

getIdCard :: (MonadResource m, MonadBaseControl IO m) => OAuth -> Manager -> AccessToken -> m MinimalUser

Get your id card https://dev.xing.com/docs/get/users/me/id_card

demoIdCard :: Value

demoIdCard' :: ByteString

demoUser :: Value

demoUser' :: ByteString

demoUsers :: Value

demoUsers' :: ByteString

getUsers :: (MonadResource m, MonadBaseControl IO m) => OAuth -> Manager -> AccessToken -> [UserId] -> m UserList

Get user details https://dev.xing.com/docs/get/users/:id

Common used functions (re-exports)

liftIO :: MonadIO m => forall a. IO a -> m a

Lift a computation from the IO monad.

withManager :: (MonadIO m, MonadBaseControl IO m, MonadThrow m, MonadUnsafeIO m) => (Manager -> ResourceT m a) -> m a

Create a new manager, use it in the provided function, and then release it.

This function uses the default manager settings. For more control, use withManagerSettings.