core_v2_emailDigest Script API

Ben Tiedt — Fri, 15 Jan 2021 19:32:49 GMT

Current Revision posted to API Documentation by Ben Tiedt on 01/15/2021 19:32:49

Enables scripted content fragments to use email digest

Create
Delete
Get
GetByGroup
List
ListGroupSubscriptionsWithoutMembership
Update

Methods

Create

Create a new email digest subscription

Velocity

#set($emailDigestSubscriptionResponse = $core_v2_emailDigest.Create($context, $contextId, $frequencyInDays))

JavaScript

var emailDigestSubscriptionResponse = core_v2_emailDigest.Create(context, contextId, frequencyInDays);

Parameters

Name	Type	Description	Required	Options
context	`String`	Context	Required	group
contextId	`Int32`	Id of context	Required
frequencyInDays	`Int32`	Frequency in days	Required

Returns

[[EmailDigestSubscription Script API Type|EmailDigestSubscription]]

Delete

Delete an email digest subscription

Velocity

#set($additionalInfoResponse = $core_v2_emailDigest.Delete($subscriptionId))

JavaScript

var additionalInfoResponse = core_v2_emailDigest.Delete(subscriptionId);

Parameters

Name	Type	Description	Required	Default	Options
subscriptionId	`Int32`	Id of subscription	Required

Returns

[[AdditionalInfo Script API Type|AdditionalInfo]]

Get

Get an email digest subscription

Velocity

#set($emailDigestSubscriptionResponse = $core_v2_emailDigest.Get($id))

JavaScript

var emailDigestSubscriptionResponse = core_v2_emailDigest.Get(id);

Parameters

Name	Type	Description	Required	Default	Options
id	`Int32`	Id of the subscription	Required

Returns

[[EmailDigestSubscription Script API Type|EmailDigestSubscription]]

GetByGroup

Get an email digest subscription for a group

Velocity

#set($emailDigestSubscriptionResponse = $core_v2_emailDigest.GetByGroup($groupId))

JavaScript

var emailDigestSubscriptionResponse = core_v2_emailDigest.GetByGroup(groupId);

Parameters

Name	Type	Description	Required	Default	Options
groupId	`Int32`	Id of the group	Required

Returns

[[EmailDigestSubscription Script API Type|EmailDigestSubscription]]

List

List email digest subscriptions

Velocity

#set($pagedListResponse = $core_v2_emailDigest.List($pageIndex, $pageSize))

JavaScript

var pagedListResponse = core_v2_emailDigest.List(pageIndex, pageSize);

Parameters

Name	Type	Description	Required	Default	Options
pageIndex	`Int32`	Specify the page number of paged results to return. Zero-based index.	Required	0
pageSize	`Int32`	Specify the number of results to return per page.	Required	20

Returns

[[PagedList Script API Type|PagedList]] of [[EmailDigestSubscription Script API Type|EmailDigestSubscription]]

ListGroupSubscriptionsWithoutMembership

Velocity

#set($pagedListResponse = $core_v2_emailDigest.ListGroupSubscriptionsWithoutMembership($pageIndex, $pageSize))

JavaScript

var pagedListResponse = core_v2_emailDigest.ListGroupSubscriptionsWithoutMembership(pageIndex, pageSize);

Parameters

Name	Type	Description	Required	Default	Options
pageIndex	`Int32`	Page Index	Required
pageSize	`Int32`	Page Size	Required

Returns

[[PagedList Script API Type|PagedList]] of [[EmailDigestSubscription Script API Type|EmailDigestSubscription]]

Update

Update an email digest subscription

Velocity

#set($emailDigestSubscriptionResponse = $core_v2_emailDigest.Update($subscriptionId, $frequencyInDays))

JavaScript

var emailDigestSubscriptionResponse = core_v2_emailDigest.Update(subscriptionId, frequencyInDays);

Parameters

Name	Type	Description	Required	Default	Options
subscriptionId	`Int32`	Id of subscription	Required
frequencyInDays	`Int32`	Frequency of description	Required

Returns

[[EmailDigestSubscription Script API Type|EmailDigestSubscription]]