فهرستهای مخاطب
`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)یک audience فهرستی نامدار از مخاطبان این فضای کاری است. هر مخاطب از همان لحظهٔ ساختهشدنش در audience پیشفرض درونساخت است، و builtin همان چیزی است که آن ردیف را نام میبرد؛ بقیه را خودتان میسازید، پر میکنید و حذف میکنید. بهجای نام که هرکسی میتواند عوضش کند، روی builtin شاخه بزنید.
این نسخه فهرستها را مدیریت میکند و چیزی به آنها نمیفرستد. هیچ متد broadcast ای وجود ندارد که دنبالش بگردید، و گذاشتن یک مخاطب در یک audience نوشتنی روی audience است نه روی مخاطب، پس audiences:write تنها scope ای است که بررسی میشود.
addContact آدرسی را میگیرد که از پیش مخاطب است و آدرسی را که نیست با 422 contact_not_found رد میکند. نخست آن را با openemail.contacts.create ذخیره کنید. افزودن دوبارهٔ یک نفر با همان عضویتی که از پیش هست پاسخ میدهد و addedAt اصلی خود را حمل میکند، پس تکرار این فراخوانی بیخطر است.
audience پیشفرض را میتوان مانند هر audience دیگری تغییر نام داد و توصیف کرد، اما نه میتوان حذفش کرد و نه میتوان از آن کم کرد. هر دو با 409 audience_immutable رد میشوند. وقتی میخواهید مخاطبی برود، خود مخاطب را حذف کنید.
پاسخ: AudienceResource
list به آرایهای ساده از اینها میرسد، با audience پیشفرض در ابتدا و بقیه بهترتیب تازهترین، و get، create و update هرکدام به یکی میرسند. listContacts بهجای آن به آرایهای از ContactResource میرسد، یعنی خود مخاطبان نه رکوردهای عضویت.
idstring- دستگیرهٔ ماندگار، `aud_` و پس از آن 24 نویسهٔ hex. نامها یکتا نیستند، پس همین است که باید در پیکربندی ذخیرهشده بیاید.
namestring- هنگام نوشتن فاصلههای اضافی حذف میشود، از 1 تا 120 نویسه. دو audience میتوانند یک نام داشته باشند، چون audience با id خود آدرسدهی میشود.
descriptionstring | null- متن آزاد برای کسی که بعداً فهرست را میخواند. وقتی کسی چیزی ننوشته باشد null است، و null صریح در `update` آن را پاک میکند.
builtin'default' | (string & {}) | null- `default` دقیقاً روی یک ردیف در هر فضای کاری، همان audience ای که همهٔ مخاطبان را نگه میدارد، و روی هر audience ای که کسی ساخته باشد null. این union باز میماند تا اگر بعدها موردی درونساخت اضافه شود، در ویرایشگر محدودتر شود بیآنکه نوع منتشرشده بشکند.
contactCountnumber- تعداد مخاطبان درون audience، که در لحظهٔ خواندن شمرده میشود نه از حافظهٔ نهان. دو خواندن در دو سوی یک `contacts.create` بهاندازهٔ یک با هم اختلاف دارند.
createdAtstring- ISO-8601 به وقت UTC، زمان ساختهشدن audience. ترتیب فهرست را پس از audience پیشفرض تعیین میکند.
updatedAtstring- ISO-8601 به وقت UTC، که با تغییر نام یا تغییر توصیف جلو میرود. تغییر عضویت آن را دست نمیزند.