Interface IFollowing

An entry point to the social following APIs

Inherited Members

IDataModel<IFollowing>.Requested

IDataModel<IFollowing>.HasValue(String)

IDataModel<IFollowing>.HasChanged(String)

IDataModel<IFollowing>.IsPropertyAvailable(Expression<Func<IFollowing, Object>>)

IDataModel<IFollowing>.ArePropertiesAvailable(Expression<Func<IFollowing, Object>>[])

IDataModel<IFollowing>.EnsureProperties(Expression<Func<IFollowing, Object>>[])

IDataModel<IFollowing>.EnsurePropertiesAsync(Expression<Func<IFollowing, Object>>[])

IDataModel<IFollowing>.ExecuteRequestAsync(ApiRequest)

IDataModel<IFollowing>.ExecuteRequest(ApiRequest)

IDataModel<IFollowing>.ExecuteRequestBatchAsync(ApiRequest)

IDataModel<IFollowing>.ExecuteRequestBatch(ApiRequest)

IDataModel<IFollowing>.ExecuteRequestBatchAsync(Batch, ApiRequest)

IDataModel<IFollowing>.ExecuteRequestBatch(Batch, ApiRequest)

IDataModelParent.Parent

IDataModelWithContext.PnPContext

Namespace: PnP.Core.Model.SharePoint

Assembly: PnP.Core.dll

Syntax

public interface IFollowing : IDataModel<IFollowing>, IDataModelParent, IDataModelWithContext, ISupportModules<IFollowing>

Methods

AmIFollowedBy(String)

Checks whether the specified user is following the current user.

Declaration

bool AmIFollowedBy(string accountName)

Parameters

System.String accountName The account name of the user, i.e. "i:0#.f|membership|admin@m365x790252.onmicrosoft.com"

Returns

System.Boolean True if the specified user follows the current user

AmIFollowedByAsync(String)

Checks whether the specified user is following the current user.

Declaration

Task<bool> AmIFollowedByAsync(string accountName)

Parameters

System.String accountName The account name of the user, i.e. "i:0#.f|membership|admin@m365x790252.onmicrosoft.com"

Returns

Task<System.Boolean> True if the specified user follows the current user

AmIFollowing(String)

Checks whether the current user is following the specified user.

Declaration

bool AmIFollowing(string accountName)

Parameters

System.String accountName The account name of the user, i.e. "i:0#.f|membership|admin@m365x790252.onmicrosoft.com"

Returns

System.Boolean True if the current user follows the specified user

AmIFollowingAsync(String)

Checks whether the current user is following the specified user.

Declaration

Task<bool> AmIFollowingAsync(string accountName)

Parameters

System.String accountName The account name of the user, i.e. "i:0#.f|membership|admin@m365x790252.onmicrosoft.com"

Returns

Task<System.Boolean> True if the current user follows the specified user

Follow(FollowData)

Makes the current user start following a user, document, site, or tag.

Declaration

SocialFollowResult Follow(FollowData data)

Parameters

FollowData data Depending on what entity your're going to follow, can be an instance of FollowTagData, FollowDocumentData, FollowPersonData or FollowSiteData

Returns

SocialFollowResult A result, the follow status or an error

FollowAsync(FollowData)

Makes the current user start following a user, document, site, or tag.

Declaration

Task<SocialFollowResult> FollowAsync(FollowData data)

Parameters

FollowData data Depending on what entity your're going to follow, can be an instance of FollowTagData, FollowDocumentData, FollowPersonData or FollowSiteData

Returns

Task<SocialFollowResult> A result, the follow status or an error

FollowedByMe(SocialActorTypes)

Gets users, documents, sites, and tags that the current user is following.

Declaration

IList<ISocialActor> FollowedByMe(SocialActorTypes types)

Parameters

SocialActorTypes types The actor type to include. You can include many actory using bitwise operatoins. I.e. to include document and site types use SocialActorTypes.Documents | SocialActorTypes.Sites

Returns

PnP.Core.Model.SharePoint.IList<ISocialActor> A collection of ISocialActor

FollowedByMeAsync(SocialActorTypes)

Gets users, documents, sites, and tags that the current user is following.

Declaration

Task<IList<ISocialActor>> FollowedByMeAsync(SocialActorTypes types)

Parameters

SocialActorTypes types The actor type to include. You can include many actory using bitwise operatoins. I.e. to include document and site types use SocialActorTypes.Documents | SocialActorTypes.Sites

Returns

Task<PnP.Core.Model.SharePoint.IList<ISocialActor>> A collection of ISocialActor

FollowedByMeCount(SocialActorTypes)

Gets the count of users, documents, sites, and tags that the current user is following.

Declaration

int FollowedByMeCount(SocialActorTypes types)

Parameters

SocialActorTypes types The actor type to include. You can include many actory using bitwise operatoins. I.e. to include document and site types use SocialActorTypes.Documents | SocialActorTypes.Sites

Returns

System.Int32 The number of followed items

FollowedByMeCountAsync(SocialActorTypes)

Gets the count of users, documents, sites, and tags that the current user is following.

Declaration

Task<int> FollowedByMeCountAsync(SocialActorTypes types)

Parameters

SocialActorTypes types The actor type to include. You can include many actory using bitwise operatoins. I.e. to include document and site types use SocialActorTypes.Documents | SocialActorTypes.Sites

Returns

Task<System.Int32> The number of followed items

GetFollowersFor(String, Expression<Func<IPersonProperties, Object>>[])

Gets the people who are following the specified user.

Declaration

IList<IPersonProperties> GetFollowersFor(string accountName, params Expression<Func<IPersonProperties, object>>[] selectors)

Parameters

System.String accountName The account name of the user, i.e. "i:0#.f|membership|admin@m365x790252.onmicrosoft.com"

Expression<Func<IPersonProperties, System.Object>>[] selectors Specific properties to return

Returns

PnP.Core.Model.SharePoint.IList<IPersonProperties> An instance of IPersonProperties

GetFollowersForAsync(String, Expression<Func<IPersonProperties, Object>>[])

Gets the people who are following the specified user.

Declaration

Task<IList<IPersonProperties>> GetFollowersForAsync(string accountName, params Expression<Func<IPersonProperties, object>>[] selectors)

Parameters

System.String accountName The account name of the user, i.e. "i:0#.f|membership|admin@m365x790252.onmicrosoft.com"

Expression<Func<IPersonProperties, System.Object>>[] selectors Specific properties to return

Returns

Task<PnP.Core.Model.SharePoint.IList<IPersonProperties>> An instance of IPersonProperties

GetFollowingInfo()

Gets following information for the current user

Declaration

IFollowingInfo GetFollowingInfo()

Returns

IFollowingInfo An instance of IFollowingInfo

GetFollowingInfoAsync()

Gets following information for the current user

Declaration

Task<IFollowingInfo> GetFollowingInfoAsync()

Returns

Task<IFollowingInfo> An instance of IFollowingInfo

GetPeopleFollowedBy(String, Expression<Func<IPersonProperties, Object>>[])

Gets the people who the specified user is following.

Declaration

IList<IPersonProperties> GetPeopleFollowedBy(string accountName, params Expression<Func<IPersonProperties, object>>[] selectors)

Parameters

System.String accountName The account name of the user, i.e. "i:0#.f|membership|admin@m365x790252.onmicrosoft.com"

Expression<Func<IPersonProperties, System.Object>>[] selectors Specific properties to return

Returns

PnP.Core.Model.SharePoint.IList<IPersonProperties> An instance of IPersonProperties

GetPeopleFollowedByAsync(String, Expression<Func<IPersonProperties, Object>>[])

Gets the people who the specified user is following.

Declaration

Task<IList<IPersonProperties>> GetPeopleFollowedByAsync(string accountName, params Expression<Func<IPersonProperties, object>>[] selectors)

Parameters

System.String accountName The account name of the user, i.e. "i:0#.f|membership|admin@m365x790252.onmicrosoft.com"

Expression<Func<IPersonProperties, System.Object>>[] selectors Specific properties to return

Returns

Task<PnP.Core.Model.SharePoint.IList<IPersonProperties>> An instance of IPersonProperties

IsFollowed(FollowData)

Indicates whether the current user is following a specified user, document, site, or tag.

Declaration

bool IsFollowed(FollowData data)

Parameters

FollowData data Depending on what entity your're going to stop following, can be an instance of FollowTagData, FollowDocumentData, FollowPersonData or FollowSiteData

Returns

System.Boolean True if the current user is following a specified user, document, site, or tag.

IsFollowedAsync(FollowData)

Indicates whether the current user is following a specified user, document, site, or tag.

Declaration

Task<bool> IsFollowedAsync(FollowData data)

Parameters

FollowData data Depending on what entity your're going to stop following, can be an instance of FollowTagData, FollowDocumentData, FollowPersonData or FollowSiteData

Returns

Task<System.Boolean> True if the current user is following a specified user, document, site, or tag.

MyFollowers()

Gets the users who are following the current user.

Declaration

IList<ISocialActor> MyFollowers()

Returns

PnP.Core.Model.SharePoint.IList<ISocialActor> A collection of ISocialActor

MyFollowersAsync()

Gets the users who are following the current user.

Declaration

Task<IList<ISocialActor>> MyFollowersAsync()

Returns

Task<PnP.Core.Model.SharePoint.IList<ISocialActor>> A collection of ISocialActor

MySuggestions()

Gets users who the current user might want to follow.

Declaration

IList<ISocialActor> MySuggestions()

Returns

PnP.Core.Model.SharePoint.IList<ISocialActor> A collection of ISocialActor

MySuggestionsAsync()

Gets users who the current user might want to follow.

Declaration

Task<IList<ISocialActor>> MySuggestionsAsync()

Returns

Task<PnP.Core.Model.SharePoint.IList<ISocialActor>> A collection of ISocialActor

StopFollowing(FollowData)

Makes the current user stop following a user, document, site, or tag.

Declaration

void StopFollowing(FollowData data)

Parameters

FollowData data Depending on what entity your're going to stop following, can be an instance of FollowTagData, FollowDocumentData, FollowPersonData or FollowSiteData

StopFollowingAsync(FollowData)

Makes the current user stop following a user, document, site, or tag.

Declaration

Task StopFollowingAsync(FollowData data)

Parameters

FollowData data Depending on what entity your're going to stop following, can be an instance of FollowTagData, FollowDocumentData, FollowPersonData or FollowSiteData

Returns

Task

Extension Methods

RequestModuleExtensions.WithHeaders<TModel>(ISupportModules<TModel>, Dictionary<String, String>, Action<Dictionary<String, String>>)

RequestModuleExtensions.WithResponseHeaders<TModel>(ISupportModules<TModel>, Action<Dictionary<String, String>>)