Follows In-Process API Service

Ben Tiedt — Fri, 15 Jan 2021 19:49:27 GMT

Current Revision posted to API Documentation by Ben Tiedt on 01/15/2021 19:49:27

This service is available via Telligent.Evolution.Extensibility.Apis.Get<Telligent.Evolution.Extensibility.Api.Version1.IFollows>() and is defined in Telligent.Evolution.Platform.dll

Events

Events.AfterCreate

Handler

void FollowAfterCreateEventHandler([[FollowAfterCreateEventArgs In-Process API Event Argument|FollowAfterCreateEventArgs]] e);

Events.AfterDelete

Handler

void FollowAfterDeleteEventHandler([[FollowAfterDeleteEventArgs In-Process API Event Argument|FollowAfterDeleteEventArgs]] e);

Events.BeforeCreate

Handler

void FollowBeforeCreateEventHandler([[FollowBeforeCreateEventArgs In-Process API Event Argument|FollowBeforeCreateEventArgs]] e);

Events.BeforeDelete

Handler

void FollowBeforeDeleteEventHandler([[FollowBeforeDeleteEventArgs In-Process API Event Argument|FollowBeforeDeleteEventArgs]] e);

Properties

Name	Type	Description	Default	Options
DataTypeId	`Guid`	Follows data type identifier

Methods

Follow Create(int followingId, FollowsCreateOptions options = null);

Creates a new following relationship for the accessing user

Parameters

Name	Type	Description	Required	Default	Options
followingId	`int`	Id of user to follow	Required
options	`[[FollowsCreateOptions In-Process API Supplementary Type\|FollowsCreateOptions]]`	Optional parameter names are: FollowerId, FollowerName	Optional

Return Type

[[Follow In-Process API Supplementary Type|Follow]]

AdditionalInfo Delete(FollowsDeleteOptions options);

Deletes a following relationship between users.

Parameters

Name	Type	Description	Required	Default	Options
options	`[[FollowsDeleteOptions In-Process API Supplementary Type\|FollowsDeleteOptions]]`	Optional parameter names are: FollowingId, FollowingName, FollowerId, FollowerName	Required

Return Type

[[AdditionalInfo In-Process API Supplementary Type|AdditionalInfo]]

User Get(int userId, FollowsGetOptions options);

Gets a following relationship.

Parameters

Name	Type	Description	Required	Default	Options
userId	`int`	Id of user who is following	Required
options	`[[FollowsGetOptions In-Process API Supplementary Type\|FollowsGetOptions]]`	Optional parameters are: FollowingId, FollowingName	Required

Return Type

[[User In-Process API Supplementary Type|User]]

IsFollowingResponse IsFollowing(IsFollowingOptions options);

Checks whether a user is following another user.

Parameters

Name	Type	Description	Required	Default	Options
options	`[[IsFollowingOptions In-Process API Supplementary Type\|IsFollowingOptions]]`	Optional parameter names are: FollowingId, FollowingName, FollowerId, FollowerName	Required

Return Type

[[IsFollowingResponse In-Process API Supplementary Type|IsFollowingResponse]]

PagedList<User> List(FollowsListOptions options);

Lists following relationships for a follower

Parameters

Name	Type	Description	Required	Default	Options
options	`[[FollowsListOptions In-Process API Supplementary Type\|FollowsListOptions]]`	Optional parameter names are: FollowerName, FollowerId, PageSize, PageIndex	Required

Return Type

[[PagedList(T) In-Process API Supplementary Type|PagedList]]<[[User In-Process API Supplementary Type|User]]>