package api

Ordering
  1. Alphabetic
Visibility
  1. Public
  2. All

Type Members

  1. case class ArrayAttrValue (arr: Seq[AttributeValue]) extends AttributeValue with Product with Serializable

    An array attribute value.

    An array attribute value.

    arr

    the array of attribute values

  2. sealed trait AttributeMergingStrategy extends AnyRef

    A strategy to merge two sets of user attributes.

  3. sealed trait AttributeValue extends AnyRef

    The value of an attribute.

    The value of an attribute. An attribute takes one of a fixed set of attribute types.

  4. case class BooleanAttrValue (value: Boolean) extends AttributeValue with Product with Serializable

    A boolean attribute value.

    A boolean attribute value.

    value

    the boolean value

  5. case class DeleteUser (userId: UserId) extends UserProfileStorageRequest with Product with Serializable

    A request to delete the information about a user.

    A request to delete the information about a user.

    userId

    the identifier of the user

  6. case class DeleteUserAttribute (userId: UserId, attributeName: String) extends UserProfileStorageRequest with Product with Serializable

    A request to delete an attribute of a user.

    A request to delete an attribute of a user.

    userId

    the identifier of the user

    attributeName

    the name of the attribute

  7. case class GeoAttrValue (lat: Double, lon: Double) extends AttributeValue with Product with Serializable

    An attribute value representing a set of lan-lon coordinates.

    An attribute value representing a set of lan-lon coordinates.

    lat

    the latitude value

    lon

    the longitude value

  8. case class GetIds (userId: UserId) extends UserProfileStorageRequest with Product with Serializable

    A request to fetch the set of ids associated with a given user

    A request to fetch the set of ids associated with a given user

    userId

    the id of the user to fetch the set of ids for

  9. case class GetIdsResponse (ids: Set[UserId]) extends UserProfileStorageResponse with Product with Serializable

    The response for a GetIds request.

  10. case class GetUser (userId: UserId) extends UserProfileStorageRequest with Product with Serializable

    A request to retrieve information about a user.

    A request to retrieve information about a user.

    userId

    the identifier of the user

  11. case class GetUserAttribute (userId: UserId, attributeName: String) extends UserProfileStorageRequest with Product with Serializable

    A request to retrieve a single attribute of a user.

    A request to retrieve a single attribute of a user.

    userId

    the identifier of the user

    attributeName

    the name of the attribute

  12. case class GetUserAttributeResponse (attributeValue: Option[AttributeValue]) extends UserProfileStorageResponse with Product with Serializable

    The response for a GetUserAttribute request.

    The response for a GetUserAttribute request.

    attributeValue

    the attribute value for the requested key wrapped in a Some if the user and the attribute exists, None otherwise

  13. case class GetUserResponse (attributes: Option[UserAttributes]) extends UserProfileStorageResponse with Product with Serializable

    The response for a GetUser request.

    The response for a GetUser request.

    attributes

    the attributes associated with the user wrapped in a Some if the user exists, None otherwise

  14. case class LinkUsers (userId1: UserId, userId2: UserId, source: Option[String]) extends UserProfileStorageRequest with Product with Serializable

    A request to link the two users.

    A request to link the two users.

    userId1

    the identifier of the first user

    userId2

    the identifier of the second user

    source

    an optional source for the link

  15. case class MapAttrValue (map: Map[String, AttributeValue]) extends AttributeValue with Product with Serializable

    A map attribute value.

    A map attribute value.

    map

    the map of keys to attribute values

  16. case class NumericAttrValue (value: Double) extends AttributeValue with Product with Serializable

    A numeric attribute value.

    A numeric attribute value.

    value

    the number value

  17. case class ResetLinks (source: String) extends UserProfileStorageRequest with Product with Serializable

    A request to reset the links of a given source.

    A request to reset the links of a given source.

    source

    the source to be reset

  18. case class StringAttrValue (value: String) extends AttributeValue with Product with Serializable

    A string attribute value.

    A string attribute value.

    value

    the string value

  19. case class UpdateUser (userId: UserId, attributes: UserAttributes, mergeStrategy: AttributeMergingStrategy) extends UserProfileStorageRequest with Product with Serializable

    A request to update the information about a user.

    A request to update the information about a user.

    userId

    the identifier of the user

    attributes

    the attributes to update the user with

    mergeStrategy

    the strategy to use when merging the attributes

  20. case class UserAttributes (attributes: Map[String, AttributeValue]) extends Product with Serializable

    The attribute set of a user.

    The attribute set of a user.

    attributes

    the map from attribute names to values

  21. case class UserId (idType: String, clientId: String, id: String) extends Product with Serializable

    A fully qualified user identifier.

    A fully qualified user identifier.

    idType

    the type of identifier

    clientId

    the client that scopes the provided user id

    id

    the identifier

  22. trait UserProfileStorageClient extends AnyRef

    Interface for clients capable of interacting with the User Profile Storage module by retrieving, updating or deleting information about users.

  23. sealed trait UserProfileStorageRequest extends AnyRef

    A request to be sent to the User Profile Storage module.

  24. sealed trait UserProfileStorageResponse extends AnyRef

    A response from the User Profile Storage module to a UserProfileStorageRequest.

Value Members

  1. object AttributeMergingStrategy
  2. object AttributeValue
  3. object DeleteUser extends Serializable
  4. object DeleteUserAttribute extends Serializable
  5. object DeleteUserAttributeResponse extends UserProfileStorageResponse with Product with Serializable

    The response for a DeleteUserAttribute request.

  6. object DeleteUserResponse extends UserProfileStorageResponse with Product with Serializable

    The response for a DeleteUser request.

  7. object GetIds extends Serializable
  8. object GetIdsResponse extends Serializable
  9. object GetUser extends Serializable
  10. object GetUserAttribute extends Serializable
  11. object GetUserAttributeResponse extends Serializable
  12. object GetUserResponse extends Serializable
  13. object JoinMergingStrategy extends AttributeMergingStrategy with Product with Serializable

    Simple attribute merge strategy that updates the old attributes with the most recent ones.

    Simple attribute merge strategy that updates the old attributes with the most recent ones. Attributes that were only present in the old attributes are preserved.

    Example: [(a, 1), (b, 1)] * [(a, 3), (c, 1)] = [(a, 3), (b, 1), (c, 1)]

  14. object LinkUsers extends Serializable
  15. object LinkUsersResponse extends UserProfileStorageResponse with Product with Serializable

    The response for a LinkUsers request.

  16. object ReplaceMergingStrategy extends AttributeMergingStrategy with Product with Serializable

    Simple attribute merge strategy that overwrites the old attributes with new attributes, removing all old attributes.

    Simple attribute merge strategy that overwrites the old attributes with new attributes, removing all old attributes.

    Example: [(a, 1), (b, 1)] * [(a, 3), (c, 1)] = [(a, 3), (c, 1)]

  17. object ResetLinks extends Serializable
  18. object ResetLinksResponse extends UserProfileStorageResponse with Product with Serializable

    The response for a ResetLinks request.

  19. object UpdateUser extends Serializable
  20. object UpdateUserResponse extends UserProfileStorageResponse with Product with Serializable

    The response for an UpdateUser request.

  21. object UserAttributes extends Serializable
  22. object UserId extends Serializable

Ungrouped