Documentation

Fields

• acctUser :: ByteString
   
• acctHost :: ByteString
   

Fields

• authUser :: ByteString
   
• authPassword :: ByteString
   

Fields

• qryTarget :: Resource

  A URI representing an entity about which you would like to get information.

• qryLinkRels :: [Either ByteString LinkRelation]

  A list of link relations by which to filter the link list in the returned description. If you'd like to receive all the links, leave this list empty. Use Left to specify a raw link relation string, and Right to specify a known typed relation.

• qryHost :: Maybe ByteString

  You can explicitly specify a host (e.g. www.example.org) here, to which the WebFinger query will be sent. If you don't specify a host here, it will be extracted from the qryTarget field (if it has a host part). Therefore this field is useful in special cases where the WebFinger server isn't the one referred by the target URI, or the URI doesn't have a host.

• qryAuth :: Maybe Auth

  HTTP authentication details. If the WebFinger server requires a username and password to access it, specify them here. For publicly available WebFinger servers, pass Nothing.

Fields

• lnkRelation :: Either Text LinkRelation

  The link relation type. Determines the relation between the target resource (about which the query was made) and the resource referred by the link. For example, if the target resource is a user and the linked resource is the user's avatar image, the link relation may be avatar.

  A link relation may be a URI or one of the registered relation type names. If the relation type is recognized when parsing the server's response, you will get Right a typed link relation here. Otherwise, e.g. if a non-URL private application-specific relation type is found, you will get Left the raw relation type string.

• lnkMediaType :: Maybe Text

  The MIME type to be expected of the content behind the link URI. For example, if the link refers to a user's avatar image, the MIME type may be image/png (i.e. an image file in PNG format).

• lnkAddress :: Maybe Text

  The link address itself. It is optional, because there may be cases in which all the information about the link is provided by the properties (the lnkProperties field). For example, if the link is a user's avatar image, the address may be https://example.org/users/john/avatar.png.

• lnkTitles :: HashMap Language Text

  Optional title(s) for the link, possibly in various languages.

• lnkProperties :: HashMap Text (Maybe Text)

  Additional properties the link may have. Maps property names, which are URIs, to string values.

Fields

• desSubject :: Maybe Text

  A URI representing the resource being described. This is the same resource specified in the query, but the URI may slightly differ (e.g. appear in canonical form).

• desAliases :: [Text]

  List of URIs which identify the same resource as the desSubject URI.

• desProperties :: HashMap Text (Maybe Text)

  Additional information about the subject. Maps property names, which are URIs, to string values.

• desLinks :: [Link]

  Links of various relation types from the subject resource to other resources represented by URIs.