Module user 

.ph/user/... endpoints, used by the (‘global’) web client

Structs

AuthToken

An opaque token used to identify the user towards pubhubs central via the Authorization header. The token can be obtained via the EnterEP, and be refreshed via the RefreshEP.

AuthTokenPackage

An AuthToken with some additional information.

CachedHubInfoEP

Provides the global client with cached details about the hubs

CachedHubInfoResp

Returned by CachedHubInfoEP.

CardPseud

A registration pseudonym used on pubhubs cards

CardPseudEP

Requests the ‘registration pseudonym’ used on PubHubs cards issued for this account. Requires authentication.

CardPseudPackage

A registration pseudonym coupled with the registration date.

EnterEP

Login (and register if needed)

EnterReq

Request to log in to an existing account, or register a new one.

GetObjectEP

Retrieves a user object with the given hash from PubHubs central

HhppEP

Requests an sso::HashedHubPseudonymPackage. Requires authentication.

HhppReq

Request type for HhppEP

NewObjectEP

Stores a new object at pubhubs central, under the given handle.

OverwriteObjectEP

Stores an object at pubhubs central under the given handle, overwriting the previous object stored there.

PpNonce

Type of sso::PolymorphicPseudonymPackage::nonce

PppEP

Requests an sso::PolymorphicPseudonymPackage. Requires authentication.

Quota

Quota for a user

RefreshEP

Refresh authentication token. Requires authentication, but the access token used to authenticate may be expired.

StateEP

Get state of the current user

UserObjectDetails

Details on an object stored at pubhubs central for a user.

UserState

State of a user’s account at pubhubs as shown to the user.

WelcomeEP

Provides the global client with basic details about the current PubHubs setup.

WelcomeResp

Returned by WelcomeEP.

Enums

AttrAddStatus

Result of trying to add an attribute via EnterEP.

AuthTokenDeniedReason

Why no auth token was granted

CardPseudResp

Returned by CardPseudEP.

EnterMode

Whether to login, register, or both.

EnterResp

Returned by EnterEP.

GetObjectResp

Returned by GetObjectEP when there’s a problem. When there’s no problem an octet stream is returned instead.

HhppResp

Returned by HhppEP.

PppResp

Returned by PppEP.

QuotumName

The different quota used in Quota.

RefreshResp

Returned by RefreshEP.

StateResp

Result of retrieving a user’s state

StoreObjectResp

Returned by NewObjectEP and OverwriteObjectEP.