الجماهير
`audiences.list` و`get` و`create` و`update` و`delete` و`listContacts` و`addContact` و`removeContact`.
كل الطرق
const audiences = await openemail.audiences.list()const everyone = audiences.find((audience) => audience.builtin === 'default') const list = await openemail.audiences.create({ name: 'Product updates', description: 'Customers who asked to hear about releases',}) await openemail.contacts.create({ email: '[email protected]', name: 'Grace Hopper' })await openemail.audiences.addContact(list.id, { email: '[email protected]' }) const members = await openemail.audiences.listContacts(list.id, { limit: 200 }) await openemail.audiences.update(list.id, { name: 'Release notes' })await openemail.audiences.removeContact(list.id, '[email protected]')await openemail.audiences.delete(list.id) console.log(everyone?.contactCount, members.length)الجمهور قائمة مسمّاة من جهات الاتصال في مساحة العمل هذه. وكل جهة اتصال تكون في الجمهور الافتراضي المدمج منذ لحظة وجودها، وbuiltin هو ما يسمّي ذلك الصف؛ وما عداه لك أن تنشئه وتملأه وتحذفه. فرّع على builtin لا على الاسم الذي يستطيع أي أحد تغييره.
هذا الإصدار يدير القوائم ولا يرسل إليها شيئاً. فلا توجد طريقة بث تبحث عنها، ووضع جهة اتصال في جمهور كتابة على الجمهور لا على جهة الاتصال، ومن ثمّ فـ audiences:write هو النطاق الوحيد الذي يُفحص.
يقبل addContact عنواناً هو جهة اتصال أصلاً ويرفض ما ليس كذلك، بـ 422 contact_not_found. احفظه أولاً بـ openemail.contacts.create. وإضافة شخص مرتين تردّ بالعضوية القائمة أصلاً حاملةً addedAt الأصلي، فالطلب آمن لإعادة المحاولة.
يمكن إعادة تسمية الجمهور الافتراضي ووصفه كأي جمهور آخر، لكن لا يمكن حذفه ولا تقليمه. ويُرفض الأمران بـ 409 audience_immutable. احذف جهة الاتصال حين تقصد أن تذهب جهة الاتصال.
الاستجابة: AudienceResource
يُرجع list مصفوفة بسيطة من هذه، الجمهور الافتراضي أولاً ثم البقية الأحدث أولاً، ويُرجع كل من get وcreate وupdate واحداً منها. أما listContacts فيُرجع مصفوفة من ContactResource بدلاً من ذلك، أي جهات الاتصال نفسها لا سجلات العضوية.
idstring- المقبض الدائم، `aud_` يليه 24 حرفاً ست عشرياً. الأسماء ليست فريدة، فهذا ما ينتمي إلى الإعدادات المخزَّنة.
namestring- يُقلَّم عند الكتابة، من 1 إلى 120 حرفاً. ويجوز أن يتشارك جمهوران اسماً واحداً، لأن الجمهور يُعنوَن بمعرّفه.
descriptionstring | null- نص حر لمن يقرأ القائمة لاحقاً. يكون null حين لا يكتبه أحد، وتمرير null صريح في `update` يمسحه.
builtin'default' | (string & {}) | null- القيمة `default` على صف واحد بالضبط في كل مساحة عمل، وهو الجمهور الذي يحمل كل جهات الاتصال، وnull على كل جمهور أنشأه شخص. ويبقى الاتحاد مفتوحاً حتى يضيّق أي عنصر مدمج يُضاف لاحقاً في المحرّر دون كسر النوع المنشور.
contactCountnumber- كم جهة اتصال في الجمهور، محسوبةً لحظة القراءة لا مأخوذة من ذاكرة مؤقتة. وقراءتان على جانبي `contacts.create` تختلفان بواحدة.
createdAtstring- بصيغة ISO-8601 بتوقيت UTC، وقت إنشاء الجمهور. ويثبّت ترتيب القائمة بعد الجمهور الافتراضي.
updatedAtstring- بصيغة ISO-8601 بتوقيت UTC، يتحدّث عند إعادة التسمية أو تغيير الوصف. ولا تمسّه تغييرات العضوية.