Rule.io SDK

---

Rule.io SDK / rcml/src / smsRfmSpec

Variable: smsRfmSpec

const smsRfmSpec: SmsRfmSpec

Defined in: rcml/src/sms/sms-rfm-spec.ts:245

Machine-readable SMS RFM specification.

Example

import { smsRfmSpec, smsPlaceholderSpec } from '@rule/rcml'

// Which node types are valid at the top level?
smsRfmSpec.flavors['sms-rfm-content'].topLevelNodes
// → ['message', 'link', 'placeholder']

// Attribute schema for the link node:
smsRfmSpec.nodes['link'].attrs?.['track']
// → { type: 'boolean', required: true, description: '...' }

// Which placeholder types are allowed?
smsRfmSpec.nodes['placeholder'].attrs?.['type'].allowedValues
// → ['CustomField', 'Subscriber', 'User', 'RemoteContent', 'Date']

// Cross-reference token syntax:
smsPlaceholderSpec.tokens['Subscriber'].syntax
// → '[Subscriber:<field>]'