Enables scripted content fragments to use Followers
Methods
Get
Gets a follower for a given user, useful for detecting if a user follows a user.
Usage
#set($userResponse = $core_v2_follower.Get($userId, "%{FollowerId = $followerIdArg, FollowerName = $followerNameArg}"))
Parameters
Name | Type | Description | Required | Default | Options |
---|---|---|---|---|---|
userId | int | Followed user id | Required | ||
FollowerId | int | Id of following user. Either FollowerId or FollowerName are required. | Optional | ||
FollowerName | string | UserName of following user. Either FollowerId or FollowerName are required. | Optional |
Return Type
List
Lists users following a given user
Usage
#set($pagedListResponse = $core_v2_follower.List("%{PageIndex = $pageIndexArg, PageSize = $pageSizeArg, SortBy = $sortByArg, SortOrder = $sortOrderArg, UserId = $userIdArg, Username = $usernameArg}"))
Parameters
Name | Type | Description | Required | Default | Options |
---|---|---|---|---|---|
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 |
UserId | int | Id of user followed user. Either UserId or Username are required. | Optional | ||
Username | string | UserName of followed user. Either UserId or Username are required. | Optional |