Methods
Create
Create a new email digest subscription
Usage
#set($emailDigestSubscriptionResponse = $core_v2_emailDigest.Create($context, $contextId, $frequencyInDays))
Parameters
| Name | Type | Description | Required | Default | Options |
|---|
| context | string | Context | Required | | group |
| contextId | int | Id of context | Required | | |
| frequencyInDays | int | Frequency in days | Required | | |
Return Type
EmailDigestSubscription
Delete
Delete an email digest subscription
Usage
#set($additionalInfoResponse = $core_v2_emailDigest.Delete($subscriptionId))
Parameters
| Name | Type | Description | Required | Default | Options |
|---|
| subscriptionId | int | Id of subscription | Required | | |
Return Type
AdditionalInfo
Get
Get an email digest subscription
Usage
#set($emailDigestSubscriptionResponse = $core_v2_emailDigest.Get($id))
Parameters
| Name | Type | Description | Required | Default | Options |
|---|
| id | int | Id of the subscription | Required | | |
Return Type
EmailDigestSubscription
GetByGroup
Get an email digest subscription for a group
Usage
#set($emailDigestSubscriptionResponse = $core_v2_emailDigest.GetByGroup($groupId))
Parameters
| Name | Type | Description | Required | Default | Options |
|---|
| groupId | int | Id of the group | Required | | |
Return Type
EmailDigestSubscription
List
List email digest subscriptions
Usage
#set($pagedListResponse = $core_v2_emailDigest.List($pageIndex, $pageSize))
Parameters
| Name | Type | Description | Required | Default | Options |
|---|
| pageIndex | int | Specify the page number of paged results to return. Zero-based index. | Required | 0 | |
| pageSize | int | Specify the number of results to return per page. | Required | 20 | |
Return Type
PagedList<EmailDigestSubscription>
ListGroupSubscriptionsWithoutMembership
Usage
#set($pagedListResponse = $core_v2_emailDigest.ListGroupSubscriptionsWithoutMembership($pageIndex, $pageSize))
Parameters
| Name | Type | Description | Required | Default | Options |
|---|
| pageIndex | int | Page Index | Required | | |
| pageSize | int | Page Size | Required | | |
Return Type
PagedList<EmailDigestSubscription>
Update
Update an email digest subscription
Usage
#set($emailDigestSubscriptionResponse = $core_v2_emailDigest.Update($subscriptionId, $frequencyInDays))
Parameters
| Name | Type | Description | Required | Default | Options |
|---|
| subscriptionId | int | Id of subscription | Required | | |
| frequencyInDays | int | Frequency of description | Required | | |
Return Type
EmailDigestSubscription