View Source ROR.Matches (ROR v0.1.0)

A structure for storing organization match results from Identify/Affiliation searches

Matches is the equivalent to the ROR.Results struct when checking for affiliation matches with ROR.identify!/2

This struct supports the Enum protocol, so you can directly iterate the matches within

Summary

t()

chosen(matches)

Returns a chosen Match (a reliably high-rated match) or nil if one has not been found

Returns a chosen Organization (from within a reliably high-rated match) or nil if one has not been found

extract(data)

Extract a Matches struct, containing Match structs and Organizations, from the JSON returned by the ROR affiliation API.

matches(matches)

Lists Matches

Returns the total number of matches

@type t() :: %ROR.Matches{items: [ROR.Match.t()], results: integer(), time: integer()}

@spec chosen(matches :: t()) :: ROR.Match.t() | nil

Returns a chosen Match (a reliably high-rated match) or nil if one has not been found

@spec chosen_organization(matches :: t()) :: nil | ROR.Organization.t()

Returns a chosen Organization (from within a reliably high-rated match) or nil if one has not been found

@spec extract(data :: map()) :: t()

Extract a Matches struct, containing Match structs and Organizations, from the JSON returned by the ROR affiliation API.

If you are retrieving records via the ROR module and the REST API you will not need to use this function yourself.

@spec matches(matches :: t()) :: [ROR.Match.t()]

Lists Matches

@spec number_of_matches(matches :: t()) :: integer()

Returns the total number of matches