Skip to content

Latest commit

 

History

History
172 lines (104 loc) · 4.36 KB

twitter-feed.schema.md

File metadata and controls

172 lines (104 loc) · 4.36 KB
Raw

Twitter Feed Schema

https://ns.adobe.com/xdm/channels/twitter-feed

The Twitter Feed, i.e. the stream of user-generated tweets. This does not include Twitter direct messages.

Abstract Extensible Status Identifiable Custom Properties Additional Properties Defined In
Can be instantiated Yes Experimental Yes Forbidden Permitted channels/twitter-feed.schema.json

Schema Hierarchy

Twitter Feed Example

{
  "@id": "https://ns.adobe.com/xdm/channels/twitter-feed",
  "@type": "https://ns.adobe.com/xdm/channel-types/social"
}

Twitter Feed Properties

Property Type Required Defined by
@id const Required Twitter Feed (this schema)
@type const Optional Twitter Feed (this schema)
xdm:contentTypes const Optional Twitter Feed (this schema)
xdm:locationTypes const Optional Twitter Feed (this schema)
xdm:metricTypes const Optional Twitter Feed (this schema)
xdm:mode const Optional Twitter Feed (this schema)
* any Additional this schema allows additional properties

@id

The ID uniquely identifies the channel. Each specific experience channel defines a constant @id.

@id

  • is required
  • type: const
  • defined in this schema

The value of this property must be equal to:

"https://ns.adobe.com/xdm/channels/twitter-feed"

@type

The @type property is used to provide a rough classification of channels with similar properties.

@type

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

The value of this property must be equal to:

"https://ns.adobe.com/xdm/channel-types/social"

@type Known Values

Value Description
https://ns.adobe.com/xdm/channel-types/web The world wide web, including mobile web
https://ns.adobe.com/xdm/channel-types/social Social media platforms
https://ns.adobe.com/xdm/channel-types/mobile Mobile applications
https://ns.adobe.com/xdm/channel-types/messaging Instant Messaging
https://ns.adobe.com/xdm/channel-types/email E-Mail
https://ns.adobe.com/xdm/channel-types/offline Non-Digital experience channels

xdm:contentTypes

The content types that this channel can deliver.

xdm:contentTypes

  • is optional

  • type: const

  • defined in this schema

The value of this property must be equal to:

[]

xdm:locationTypes

The types of locations (virtual places) that this channel consists of and can deliver content to.

xdm:locationTypes

  • is optional

  • type: const

  • defined in this schema

The value of this property must be equal to:

[]

xdm:metricTypes

The metrics that can be collected in this channel.

xdm:metricTypes

  • is optional

  • type: const

  • defined in this schema

The value of this property must be equal to:

[]

xdm:mode

How experiences are delivered in this channel.

xdm:mode

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

The value of this property must be equal to:

"pull"

xdm:mode Known Values

Value Description
push The publisher of an experience can initiate an experience by sending a message into the channel. Most push channels involve some form of subscription or opt-in.
pull The consumer can initiate an experience by requesting a location in the channel. Most pull channels give publishers some control how the experience is then delivered.
bidirectional Both push and pull interaction modes are supported by the channel.