Enables scripted content fragments to use Blogs
Properties
Name | Type | Description | Default | Options |
---|---|---|---|---|
ApplicationTypeId | Guid | Blogs application type identifier | ||
ContentTypeId | Guid | Blogs content type identifier | ||
Current | Blog | Current contextual blog | ||
ThemeTypeId | Guid | Blogs theme type identifier | ||
TotalLicensedRemaining | int | Total number licensed blogs |
Methods
Create
Creates a new blog
Usage
#set($blogResponse = $core_v2_blog.Create($groupId, $name))
Parameters
Name | Type | Description | Required | Default | Options |
---|---|---|---|---|---|
groupId | int | Group Id | Required | ||
name | string | Name | Required |
Return Type
Create
Creates a new blog
Usage
#set($blogResponse = $core_v2_blog.Create($groupId, $name, "%{Authors = $authorsArg, DefaultPostImageUrl = $defaultPostImageUrlArg, Description = $descriptionArg, Enabled = $enabledArg, ExtendedAttributes = $extendedAttributesArg, Key = $keyArg}"))
Parameters
Name | Type | Description | Required | Default | Options |
---|---|---|---|---|---|
groupId | int | Group in which to create the blog | Required | ||
name | string | Name of the blog | Required | ||
Authors | string | Comma separated list of usernames | Optional | ||
DefaultPostImageUrl | string | Default Post Image Url | Optional | ||
Description | string | Description | Optional | ||
Enabled | bool | Enabled | Optional | True | |
ExtendedAttributes | string | Extended attributes are key-value pairs set using the syntax _ExtendedAttributes_key=value. i.e. _ExtendedAttributes_MyKey=MyValue sets ExtendedAttributes["MyKey"] to "MyValue". | Optional | ||
Key | string | If not specified, the key will be generated | Optional |
Return Type
CreateContactRequest
Creates a contact request
Usage
#set($blogContactRequestResponse = $core_v2_blog.CreateContactRequest($blogId, $subject, $body, $name, $emailAddress, $dateCreated, $ipAddress))
Parameters
Name | Type | Description | Required | Default | Options |
---|---|---|---|---|---|
blogId | int | Blog Id | Required | ||
subject | string | Subject | Required | ||
body | string | Body | Required | ||
name | string | Name | Required | ||
emailAddress | string | Email Address | Required | ||
dateCreated | DateTime | Date Created | Required | ||
ipAddress | string | Ip Address | Required |
Return Type
Delete
Deletes a blog
Usage
#set($additionalInfoResponse = $core_v2_blog.Delete($id))
Parameters
Name | Type | Description | Required | Default | Options |
---|---|---|---|---|---|
id | int | Blog Id | Required |
Return Type
DeleteContactRequest
Deletes a contact request
Usage
#set($additionalInfoResponse = $core_v2_blog.DeleteContactRequest($blogId, $id))
Parameters
Name | Type | Description | Required | Default | Options |
---|---|---|---|---|---|
blogId | int | Blog Id | Required | ||
id | int | Id | Required |
Return Type
Get
Gets a blog
Usage
#set($blogResponse = $core_v2_blog.Get("%{GroupId = $groupIdArg, Id = $idArg, Key = $keyArg}"))
Parameters
Name | Type | Description | Required | Default | Options |
---|---|---|---|---|---|
GroupId | int | Either the Id or the Key + GroupId are required | Optional | ||
Id | int | Either the Id or the Key + GroupId are required | Optional | ||
Key | string | Either the Id or the Key + GroupId are required | Optional |
Return Type
Get
Gets a blog
Usage
#set($blogResponse = $core_v2_blog.Get($applicationId))
Parameters
Name | Type | Description | Required | Default | Options |
---|---|---|---|---|---|
applicationId | Guid | Application Id | Required |
Return Type
GetContactRequest
Gets a contact request
Usage
#set($blogContactRequestResponse = $core_v2_blog.GetContactRequest($id))
Parameters
Name | Type | Description | Required | Default | Options |
---|---|---|---|---|---|
id | int | Id | Required |
Return Type
IsSubscribed
Returns subscribed status for the accessing user
Usage
#set($booleanResponse = $core_v2_blog.IsSubscribed($blogId))
Parameters
Name | Type | Description | Required | Default | Options |
---|---|---|---|---|---|
blogId | int | Blog Id | Required |
Return Type
bool
List
Returns a queried listing of blogs
Usage
#set($pagedListResponse = $core_v2_blog.List("%{ApplicationIds = $applicationIdsArg, GroupId = $groupIdArg, IncludeSubGroups = $includeSubGroupsArg, OwnerUserId = $ownerUserIdArg, PageIndex = $pageIndexArg, PageSize = $pageSizeArg, PermissionId = $permissionIdArg, SortBy = $sortByArg, SortOrder = $sortOrderArg, UserId = $userIdArg}"))
Parameters
Name | Type | Description | Required | Default | Options |
---|---|---|---|---|---|
ApplicationIds | string | Comma separated list of ContentIds. Used to limit to a specific set of blogs as well as sort order if SoryBy is set to ApplicationIdsOrder | Optional | ||
GroupId | int | Group ID | Optional | ||
IncludeSubGroups | bool | Whether or not query should include sub-groups | Optional | ||
OwnerUserId | int | User ID of the owner of the blogs. When this value is present, only blogs where the given user is an owner are returned. The accessing user must specify their own user Id or the accessing user must have impersonation rights. | Optional | ||
PageIndex | int | Specify the page number of paged results to return. Zero-based index. | Optional | 0 | |
PageSize | int | Specify the number of results to return per page. | Optional | 20 | |
PermissionId | string | Used to get a list of blogs for which the user set in UserId has the provided Permission ID. | Optional | ||
SortBy | string | Attribute to order the results | Optional | ApplicationIdsOrder, MostComments, MostRecent, MostViewed, Score:SCORE_ID | |
SortOrder | string | Direction to sort the results | Optional | Ascending | Ascending, Descending |
UserId | int | Obsolete in 9.2: User Id should no longer be used. Rely on the authenticated or impersonated user instead. | Optional |
Return Type
List
Returns a listing of all blogs
Usage
#set($pagedListResponse = $core_v2_blog.List())
Return Type
ListContactRequests
Lists contact requests
Usage
#set($pagedListResponse = $core_v2_blog.ListContactRequests($blogId))
Parameters
Name | Type | Description | Required | Default | Options |
---|---|---|---|---|---|
blogId | int | Blog Id | Required |
Return Type
ListContactRequests
Lists contact requests
Usage
#set($pagedListResponse = $core_v2_blog.ListContactRequests($blogId, "%{IsModerated = $isModeratedArg, PageIndex = $pageIndexArg, PageSize = $pageSizeArg}"))
Parameters
Name | Type | Description | Required | Default | Options |
---|---|---|---|---|---|
blogId | int | Blog Id | Required | ||
IsModerated | bool | Is Moderated | Optional | False | |
PageIndex | int | Specify the page number of paged results to return. Zero-based index. | Optional | 0 | |
PageSize | int | Specify the number of results to return per page. | Optional | 20 |
Return Type
ListForQuickPost
Lists blogs available for a quick post context for the accessing user and current group
Usage
#set($iListResponse = $core_v2_blog.ListForQuickPost())
Return Type
IList<Blog>
ListTaggedContent
Lists tagged content. DEPRECATED: This method is supported for backwards compatibility, but $core_v2_taggedContent.List() should be used if possible.
Usage
#set($pagedListResponse = $core_v2_blog.ListTaggedContent($tags, "%{BlogId = $blogIdArg, GroupId = $groupIdArg, PageIndex = $pageIndexArg, PageSize = $pageSizeArg}"))
Parameters
Name | Type | Description | Required | Default | Options |
---|---|---|---|---|---|
tags | IList<string> | Tags | Required | ||
BlogId | int | Blog Id | Optional | ||
GroupId | int | Group Id | Optional | ||
PageIndex | int | Specify the page number of paged results to return. Zero-based index. | Optional | 0 | |
PageSize | int | Specify the number of results to return per page. | Optional | 20 |
Return Type
ListTags
Lists tags. DEPRECATED: This method is supported for backwards compatibility, but $core_v2_tags.List() should be used if possible.
Usage
#set($pagedListResponse = $core_v2_blog.ListTags("%{BlogId = $blogIdArg, FilterTags = $filterTagsArg, GroupId = $groupIdArg, MinimumItemsPerTag = $minimumItemsPerTagArg, PageIndex = $pageIndexArg, PageSize = $pageSizeArg}"))
Parameters
Name | Type | Description | Required | Default | Options |
---|---|---|---|---|---|
BlogId | int | Blog Id | Optional | ||
FilterTags | IList<string> | Tags to filter by | Optional | ||
GroupId | int | Group Id | Optional | ||
MinimumItemsPerTag | int | Minimum Items Per Tag | Optional | ||
PageIndex | int | Page Index | Optional | 0 | |
PageSize | int | Page Size | Optional | 100 |
Return Type
Search
Performs a blog search
Usage
#set($pagedListResponse = $core_v2_blog.Search($queryText, "%{GroupId = $groupIdArg, GroupId = $groupIdArg, IncludeSubGroups = $includeSubGroupsArg, PageIndex = $pageIndexArg}"))
Parameters
Name | Type | Description | Required | Default | Options |
---|---|---|---|---|---|
queryText | string | Query Text | Required | ||
GroupId |
| Group Id | Optional | ||
GroupId |
| Group Id | Optional | ||
IncludeSubGroups |
| Include Sub Groups | Optional | ||
PageIndex | int | Specify the page number of paged results to return. Zero-based index. | Optional | 0 |
Return Type
SetSubscribed
Sets subscribed status for the accessing user
Usage
#set($additionalInfoResponse = $core_v2_blog.SetSubscribed($blogId, $subscribe))
Parameters
Name | Type | Description | Required | Default | Options |
---|---|---|---|---|---|
blogId | int | Blog Id | Required | ||
subscribe | bool | Subscribed Status | Required |
Return Type
SubscribeAnonymously
Usage
#set($nullableResponse = $core_v2_blog.SubscribeAnonymously($blogId, $email))
Parameters
Name | Type | Description | Required | Default | Options |
---|---|---|---|---|---|
blogId | int | Blog Id | Required | ||
string | Required |
Return Type
AnonymousBlogSubscriptionResponse?
Update
Updates a blog
Usage
#set($blogResponse = $core_v2_blog.Update($id, "%{Authors = $authorsArg, DefaultPostImageUrl = $defaultPostImageUrlArg, Description = $descriptionArg, Enabled = $enabledArg, ExtendedAttributes = $extendedAttributesArg, GroupId = $groupIdArg, Key = $keyArg, Name = $nameArg}"))
Parameters
Name | Type | Description | Required | Default | Options |
---|---|---|---|---|---|
id | int | Id | Required | ||
Authors | string | Comma separated list of usernames | Optional | ||
DefaultPostImageUrl | string | Default Post Image Url | Optional | ||
Description | string | Description | Optional | ||
Enabled | bool | Enabled | Optional | True | |
ExtendedAttributes | string | Extended attributes are key-value pairs set using the syntax _ExtendedAttributes_key=value. i.e. _ExtendedAttributes_MyKey=MyValue sets ExtendedAttributes["MyKey"] to "MyValue". | Optional | ||
GroupId | int | Group Id | Optional | ||
Key | string | If not specified, the key will be generated | Optional | ||
Name | string | Name | Optional |