GoogleApi.ContentWarehouse.V1.Model.AppsPeopleOzExternalMergedpeopleapiMembership
Table of Contents ▼
Jump to a specific part of the page:
Description
A membership that the person has. The person can be a member of multiple circles and multiple contact-groups. A circle membership is created by adding a person to a circle by person-id or by email. A contact-group membership is created by adding a contact to a contact-group.
Attributes List
This module has the following attributes (case-insensitive ascending order):
Attributes
-
circleId
(type:String.t
, default:nil
)
- A circle that the person belongs to. -
contactGroupId
(type:String.t
, default:nil
)
- A contact-group that the person belong to. The id can be either a hex-formatted id or a camel-cased SystemContactGroup predefined group name. The id will be predefined group name iff the system_contact_group_id has a value. -
metadata
(type:GoogleApi.ContentWarehouse.V1.Model.AppsPeopleOzExternalMergedpeopleapiPersonFieldMetadata
, default:nil
)
- The metadata field can be used to determine which container generated the membership. For example, when the membership has a contact_group_id, the metadata.container will be CONTACT and the container_id will be the contact Id. -
systemContactGroupId
(type:String.t
, default:nil
)
- The membership has a contact_group_id, this field will be populated when the membership is in a system-reserved contact-group.
Type
@type t() :: %GoogleApi.ContentWarehouse.V1.Model.AppsPeopleOzExternalMergedpeopleapiMembership{
circleId: String.t() | nil,
contactGroupId: String.t() | nil,
metadata: GoogleApi.ContentWarehouse.V1.Model.AppsPeopleOzExternalMergedpeopleapiPersonFieldMetadata.t() | nil,
systemContactGroupId: String.t() | nil
}
circleId: String.t() | nil,
contactGroupId: String.t() | nil,
metadata: GoogleApi.ContentWarehouse.V1.Model.AppsPeopleOzExternalMergedpeopleapiPersonFieldMetadata.t() | nil,
systemContactGroupId: String.t() | nil
}
Function
@spec decode(struct(), keyword()) :: struct()Data sourced from HexDocs : GoogleApi.ContentWarehouse.V1.Model.AppsPeopleOzExternalMergedpeopleapiMembership