Enables scripted content fragments to use Followings
Methods
Create
Creates a new following relationship for the accessing user
Usage
#set($followResponse = $core_v2_following.Create($followingId))
Parameters
Name | Type | Description | Required | Default | Options |
---|---|---|---|---|---|
followingId | int | Id of user to follow | Required |
Return Type
Create
Creates a new following relationship
Usage
#set($followResponse = $core_v2_following.Create($followingId, "%{FollowerName = $followerNameArg, FollowingId = $followingIdArg}"))
Parameters
Name | Type | Description | Required | Default | Options |
---|---|---|---|---|---|
followingId | int | Id of user to follow | Required | ||
FollowerName | string | Username of following user. Either FollowingId or FollowerName is required. | Optional | ||
FollowingId | int | Id of following user. Either FollowingId or FollowerName is required. | Optional |
Return Type
Delete
Deletes a following relationship between users.
Usage
#set($additionalInfoResponse = $core_v2_following.Delete("%{FollowerId = $followerIdArg, FollowerName = $followerNameArg, FollowingId = $followingIdArg, FollowingName = $followingNameArg}"))
Parameters
Name | Type | Description | Required | Default | Options |
---|---|---|---|---|---|
FollowerId | int | Id of user who is following. Either FollowerId or FollowerName is required. | Optional | ||
FollowerName | string | Username of user who is following. Either FollowerId or FollowerName is required. | Optional | ||
FollowingId | int | Id of user who is followed. Either FollowingId or FollowingName is required. | Optional | ||
FollowingName | string | Username of user who is followed. Either FollowingId or FollowingName is required. | Optional |
Return Type
Get
Gets a following relationship.
Usage
#set($userResponse = $core_v2_following.Get($userId, "%{FollowerName = $followerNameArg, FollowingId = $followingIdArg}"))
Parameters
Name | Type | Description | Required | Default | Options |
---|---|---|---|---|---|
userId | int | Id of user who is following | Required | ||
FollowerName | string | Username of the followed user. Either FollowingId or FollowerName is required. | Optional | ||
FollowingId | int | Id of the followed user. Either FollowingId or FollowerName is required. | Optional |
Return Type
IsFollowing
Usage
#set($isFollowingResponseResponse = $core_v2_following.IsFollowing("%{FollowerId = $followerIdArg, FollowerName = $followerNameArg, FollowingId = $followingIdArg, FollowingName = $followingNameArg}"))
Parameters
Name | Type | Description | Required | Default | Options |
---|---|---|---|---|---|
FollowerId | int | Id of user who is following. Either FollowerId or FollowerName is required. | Optional | ||
FollowerName | string | Username of user who is following. Either FollowerId or FollowerName is required. | Optional | ||
FollowingId | int | Id of user who is being followed. Either FollowingId or FollowingName is required. | Optional | ||
FollowingName | string | Username of user who is being followed. Either FollowingId or FollowingName is required. | Optional |
Return Type
List
Lists following relationships for a follower
Usage
#set($pagedListResponse = $core_v2_following.List("%{FollowerId = $followerIdArg, FollowerName = $followerNameArg, PageIndex = $pageIndexArg, PageSize = $pageSizeArg, SortBy = $sortByArg, SortOrder = $sortOrderArg}"))
Parameters
Name | Type | Description | Required | Default | Options |
---|---|---|---|---|---|
FollowerId | int | Id of user who is following. Either FollowerId or FollowerName is required. | Optional | ||
FollowerName | string | Username of user who is following. Either FollowerId or FollowerName is required. | 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 | |
SortBy | string | Sort by | Optional | Username | CreatedDate, DisplayName |
SortOrder | string | Sort order | Optional | Ascending | Ascending, Descending |