Skip to content

Latest commit

 

History

History
188 lines (112 loc) · 6.9 KB

profile-preferences-details.schema.md

File metadata and controls

188 lines (112 loc) · 6.9 KB

Profile preferences details Schema

https://ns.adobe.com/xdm/context/profile-preferences-details

This mixin is used to capture information regarding individual preferences in the profile, such as time zone, preferred language, and email format (rich text or plain text).

Abstract Extensible Status Identifiable Custom Properties Additional Properties Defined In
Can be instantiated Yes Experimental No Forbidden Permitted context/profile-preferences-details.schema.json

Schema Hierarchy

  • Profile preferences details https://ns.adobe.com/xdm/context/profile-preferences-details

Profile preferences details Example

{
  "xdm:optInOut": {
    "https://ns.adobe.com/xdm/channels/email": "pending",
    "https://ns.adobe.com/xdm/channels/phone": "out",
    "https://ns.adobe.com/xdm/channels/sms": "in",
    "https://ns.adobe.com/xdm/channels/fax": "not_provided",
    "https://ns.adobe.com/xdm/channels/direct-mail": "not_provided",
    "https://ns.adobe.com/xdm/channels/apns": "not_provided",
    "xdm:globalOptout": false
  }
}

Profile preferences details Properties

Property Type Required Defined by
xdm:emailFormat string Optional Profile preferences details (this schema)
xdm:optInOut OptInOut Optional Profile preferences details (this schema)
xdm:preferredLanguage string Optional Profile preferences details (this schema)
xdm:profilePictureLink string Optional Profile preferences details (this schema)
xdm:timeZone string Optional Profile preferences details (this schema)
* any Additional this schema allows additional properties

xdm:emailFormat

Email format

Email format preferred by the profile. This can be rich text or plain text.

xdm:emailFormat

  • is optional
  • type: string
  • defined in this schema

xdm:emailFormat Type

string

xdm:emailFormat Known Values

Value Description
html Rich text
plaintext Plain text

xdm:optInOut

OptInOut

Describes a users opting in and out preferences for communication by medium and communication type.

xdm:optInOut

  • is optional
  • type: OptInOut
  • defined in this schema

xdm:optInOut Type

  • OptInOut – https://ns.adobe.com/xdm/context/optinout

xdm:preferredLanguage

Preferred language

Describes the preferred system of communication used by the profile. Language codes are expressed in BCP 47 format.

xdm:preferredLanguage

  • is optional
  • type: string
  • defined in this schema

xdm:preferredLanguage Type

string

All instances must conform to this regular expression

^(((([A-Za-z]{2,3}(-([A-Za-z]{3}(-[A-Za-z]{3}){0,2}))?)|[A-Za-z]{4}|[A-Za-z]{5,8})(-([A-Za-z]{4}))?(-([A-Za-z]{2}|[0-9]{3}))?(-([A-Za-z0-9]{5,8}|[0-9][A-Za-z0-9]{3}))*(-([0-9A-WY-Za-wy-z](-[A-Za-z0-9]{2,8})+))*(-(x(-[A-Za-z0-9]{1,8})+))?)|(x(-[A-Za-z0-9]{1,8})+)|((en-GB-oed|i-ami|i-bnn|i-default|i-enochian|i-hak|i-klingon|i-lux|i-mingo|i-navajo|i-pwn|i-tao|i-tay|i-tsu|sgn-BE-FR|sgn-BE-NL|sgn-CH-DE)|(art-lojban|cel-gaulish|no-bok|no-nyn|zh-guoyu|zh-hakka|zh-min|zh-min-nan|zh-xiang)))$

xdm:preferredLanguage Examples

"en-GB"
"de-DE"
"yue-HK"

xdm:profilePictureLink

Profile picture link

Link to profile's picture.

xdm:profilePictureLink

  • is optional
  • type: string
  • defined in this schema

xdm:profilePictureLink Type

string

xdm:timeZone

Time zone

Describes which time zone the profile is present in, most frequently the time zone preferred by the profile. Time zones are expressed according to the IETF tz database: https://www.ietf.org/timezones/tzdb-2016i/tz-link.htm

xdm:timeZone

  • is optional
  • type: string
  • defined in this schema

xdm:timeZone Type

string

xdm:timeZone Examples

"America/Barbados"
"Antarctica/Davis"
"Asia/Calcutta"