AppsPeopleOzExternalMergedpeopleapiRelation

Posted on by Darth Emmett

GoogleApi.ContentWarehouse.V1.Model.AppsPeopleOzExternalMergedpeopleapiRelation

Table of Contents ▼

Jump to a specific part of the page:

Description

Relation stores the related person between the contact or profile and a third person. See go/relation-vs-relationship for relation vs relationship explanation. This field currently includes RelationshipToMe data in fields value and canonical_value for ContainerType CONTACT_ANNOTATION. This will be moved to RelationshipToMe in b/221081499.

Attributes List

This module has the following attributes (case-insensitive ascending order):

View Attributes

Attributes

  1. canonicalValue (type: String.t, default: nil)
    - Canonicalized value of the relation from this person to the user. This is currently used for data from contact annotations. Possible canonical values are based from http://google3/googledata/quality/aliases/relationship_en.config.
  2. formattedType (type: String.t, default: nil)
    - The type translated and formatted in the request locale. See go/people-api-howto/localization for details on how to usage.
  3. metadata (type: GoogleApi.ContentWarehouse.V1.Model.AppsPeopleOzExternalMergedpeopleapiPersonFieldMetadata, default: nil)
    -
  4. relationDetails (type: GoogleApi.ContentWarehouse.V1.Model.AppsPeopleOzExternalMergedpeopleapiRelationRelationDetails, default: nil)
    - The person whose email matches the Relation.value field, if it is a valid email address. This field is read-only and ignored on update.
  5. type (type: String.t, default: nil)
    - The relation type. The type can be free form or one of these predefined values: spouse child mother father parent brother sister friend relative domesticPartner manager assistant referredBy partner
  6. value (type: String.t, default: nil)
    - The person this relation applies to. Custom value provided by the user.

Type

@type t() :: %GoogleApi.ContentWarehouse.V1.Model.AppsPeopleOzExternalMergedpeopleapiRelation{
canonicalValue: String.t() | nil,
formattedType: String.t() | nil,
metadata: GoogleApi.ContentWarehouse.V1.Model.AppsPeopleOzExternalMergedpeopleapiPersonFieldMetadata.t() | nil,
relationDetails: GoogleApi.ContentWarehouse.V1.Model.AppsPeopleOzExternalMergedpeopleapiRelationRelationDetails.t() | nil,
type: String.t() | nil,
value: String.t() | nil
}

Function

@spec decode(struct(), keyword()) :: struct()

Data sourced from HexDocs : GoogleApi.ContentWarehouse.V1.Model.AppsPeopleOzExternalMergedpeopleapiRelation