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
Blog
Create
Creates a new blog
Usage
#set($blogResponse = $core_v2_blog.Create($groupId, $name, "%{Description = $descriptionArg, Enabled = $enabledArg, 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 | | |
| Description | string | Description | Optional | | |
| Enabled | bool | Enabled | Optional | True | |
| Key | string | If not specified, the key will be generated | Optional | | |
Return Type
Blog
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
BlogContactRequest
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
AdditionalInfo
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
Blog
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
Blog
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
BlogContactRequest
IsFavorite
Returns favorite status for the accessing user
Usage
#set($booleanResponse = $core_v2_blog.IsFavorite($blogId))
Parameters
| Name | Type | Description | Required | Default | Options |
|---|
| blogId | int | Blog Id | Required | | |
Return Type
bool
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 listing of all blogs
Usage
#set($pagedListResponse = $core_v2_blog.List())
Return Type
PagedList<Blog>
List
Returns a queried listing of blogs
Usage
#set($pagedListResponse = $core_v2_blog.List("%{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 |
|---|
| 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. | 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 | | MostComments, MostRecent, MostViewed, Score:SCORE_ID |
| SortOrder | string | Direction to sort the results | Optional | Ascending | Ascending, Descending |
| UserId | int | User ID of the user to check permissions for. This option is only used whenever the PermissionId is also supplied. | Optional | | |
Return Type
PagedList<Blog>
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
PagedList<BlogContactRequest>
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
PagedList<BlogContactRequest>
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. 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
PagedList<TaggedContent>
ListTags
Lists tags. 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
PagedList<Tag>
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
PagedList<SearchResult>
SetFavorite
Sets favorite status for the accessing user
Usage
$core_v2_blog.SetFavorite($blogId, $favorite)
Parameters
| Name | Type | Description | Required | Default | Options |
|---|
| blogId | int | Blog Id | Required | | |
| favorite | bool | Favorite Status | Required | | |
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
AdditionalInfo
SubscribeAnonymously
Usage
#set($nullableResponse = $core_v2_blog.SubscribeAnonymously($blogId, $email))
Parameters
| Name | Type | Description | Required | Default | Options |
|---|
| blogId | int | Blog Id | Required | | |
| email | string | Email | Required | | |
Return Type
AnonymousBlogSubscriptionResponse?
Update
Updates a blog
Usage
#set($blogResponse = $core_v2_blog.Update($id, "%{Description = $descriptionArg, Enabled = $enabledArg, GroupId = $groupIdArg, Key = $keyArg, Name = $nameArg}"))Parameters
| Name | Type | Description | Required | Default | Options |
|---|
| id | int | Id | Required | | |
| Description | string | Description | Optional | | |
| Enabled | bool | Enabled | Optional | True | |
| GroupId | int | Group Id | Optional | | |
| Key | string | If not specified, the key will be generated | Optional | | |
| Name | string | Name | Optional | | |
Return Type
Blog