Search Results for

    Show / Hide Table of Contents

    Interface IUserProfile

    An entry point for the user profile APIs

    Inherited Members
    IDataModel<IUserProfile>.Requested
    IDataModel<IUserProfile>.HasValue(String)
    IDataModel<IUserProfile>.HasChanged(String)
    IDataModel<IUserProfile>.IsPropertyAvailable(Expression<Func<IUserProfile, Object>>)
    IDataModel<IUserProfile>.ArePropertiesAvailable(Expression<Func<IUserProfile, Object>>[])
    IDataModel<IUserProfile>.EnsureProperties(Expression<Func<IUserProfile, Object>>[])
    IDataModel<IUserProfile>.EnsurePropertiesAsync(Expression<Func<IUserProfile, Object>>[])
    IDataModel<IUserProfile>.ExecuteRequestAsync(ApiRequest)
    IDataModel<IUserProfile>.ExecuteRequest(ApiRequest)
    IDataModel<IUserProfile>.ExecuteRequestBatchAsync(ApiRequest)
    IDataModel<IUserProfile>.ExecuteRequestBatch(ApiRequest)
    IDataModel<IUserProfile>.ExecuteRequestBatchAsync(Batch, ApiRequest)
    IDataModel<IUserProfile>.ExecuteRequestBatch(Batch, ApiRequest)
    IDataModelParent.Parent
    IDataModelWithContext.PnPContext
    IDataModelGet<IUserProfile>.GetBatchAsync(Batch, Expression<Func<IUserProfile, Object>>[])
    IDataModelGet<IUserProfile>.GetAsync(Expression<Func<IUserProfile, Object>>[])
    IDataModelLoad<IUserProfile>.LoadBatchAsync(Batch, Expression<Func<IUserProfile, Object>>[])
    IDataModelLoad<IUserProfile>.LoadAsync(Expression<Func<IUserProfile, Object>>[])
    Namespace: PnP.Core.Model.SharePoint
    Assembly: PnP.Core.dll
    Syntax
    public interface IUserProfile : IDataModel<IUserProfile>, IDataModelParent, IDataModelWithContext, ISupportModules<IUserProfile>, IDataModelGet<IUserProfile>, IDataModelLoad<IUserProfile>

    Properties

    EditProfileLink

    The link to edit the current user's profile

    Declaration
    string EditProfileLink { get; }
    Property Value
    System.String

    IsMyPeopleListPublic

    A Boolean value that indicates whether the current user's People I'm Following list is public.

    Declaration
    bool IsMyPeopleListPublic { get; }
    Property Value
    System.Boolean

    Methods

    GetMyProperties(Expression<Func<IPersonProperties, Object>>[])

    Gets user properties for the current user.

    Declaration
    IPersonProperties GetMyProperties(params Expression<Func<IPersonProperties, object>>[] selectors)
    Parameters
    Expression<Func<IPersonProperties, System.Object>>[] selectors

    Specific properties to return

    Returns
    IPersonProperties

    An instance of IPersonProperties

    GetMyPropertiesAsync(Expression<Func<IPersonProperties, Object>>[])

    Gets user properties for the current user.

    Declaration
    Task<IPersonProperties> GetMyPropertiesAsync(params Expression<Func<IPersonProperties, object>>[] selectors)
    Parameters
    Expression<Func<IPersonProperties, System.Object>>[] selectors

    Specific properties to return

    Returns
    Task<IPersonProperties>

    An instance of IPersonProperties

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

    Gets user properties for the specified user.

    Declaration
    IPersonProperties GetPropertiesFor(string accountName, params Expression<Func<IPersonProperties, object>>[] selectors)
    Parameters
    System.String accountName

    The account name, i.e. "i:0#.f|membership|admin@m365x790252.onmicrosoft.com&quot;

    Expression<Func<IPersonProperties, System.Object>>[] selectors

    Specific properties to return

    Returns
    IPersonProperties

    An instance of IPersonProperties

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

    Gets user properties for the specified user.

    Declaration
    Task<IPersonProperties> GetPropertiesForAsync(string accountName, params Expression<Func<IPersonProperties, object>>[] selectors)
    Parameters
    System.String accountName

    The account name, i.e. "i:0#.f|membership|admin@m365x790252.onmicrosoft.com&quot;

    Expression<Func<IPersonProperties, System.Object>>[] selectors

    Specific properties to return

    Returns
    Task<IPersonProperties>

    An instance of IPersonProperties

    GetPropertyFor(String, String)

    Gets the specified user profile property for the specified user.

    Declaration
    string GetPropertyFor(string accountName, string propertyName)
    Parameters
    System.String accountName

    The account name, i.e. "i:0#.f|membership|admin@m365x790252.onmicrosoft.com&quot;

    System.String propertyName

    The case-sensitive name of the property to get.

    Returns
    System.String

    The specified profile property for the specified user.

    GetPropertyForAsync(String, String)

    Gets the specified user profile property for the specified user.

    Declaration
    Task<string> GetPropertyForAsync(string accountName, string propertyName)
    Parameters
    System.String accountName

    The account name, i.e. "i:0#.f|membership|admin@m365x790252.onmicrosoft.com&quot;

    System.String propertyName

    The case-sensitive name of the property to get.

    Returns
    Task<System.String>

    The specified profile property for the specified user.

    GetUserOneDriveQuotaMax(String)

    Gets the user's onedrive max quota

    Declaration
    long GetUserOneDriveQuotaMax(string accountName)
    Parameters
    System.String accountName

    The account name, i.e. "i:0#.f|membership|admin@m365x790252.onmicrosoft.com&quot;

    Returns
    System.Int64

    The max quota value

    GetUserOneDriveQuotaMaxAsync(String)

    Gets the user's onedrive max quota

    Declaration
    Task<long> GetUserOneDriveQuotaMaxAsync(string accountName)
    Parameters
    System.String accountName

    The account name, i.e. "i:0#.f|membership|admin@m365x790252.onmicrosoft.com&quot;

    Returns
    Task<System.Int64>

    The max quota value

    ResetUserOneDriveQuotaToDefault(String)

    Resets the user's onedrive quota to the default value

    Declaration
    string ResetUserOneDriveQuotaToDefault(string accountName)
    Parameters
    System.String accountName

    The account name, i.e. "i:0#.f|membership|admin@m365x790252.onmicrosoft.com&quot;

    Returns
    System.String

    The string outcome

    ResetUserOneDriveQuotaToDefaultAsync(String)

    Resets the user's onedrive quota to the default value

    Declaration
    Task<string> ResetUserOneDriveQuotaToDefaultAsync(string accountName)
    Parameters
    System.String accountName

    The account name, i.e. "i:0#.f|membership|admin@m365x790252.onmicrosoft.com&quot;

    Returns
    Task<System.String>

    The string outcome

    SetMultiValuedProfileProperty(String, String, IList<String>)

    Sets the user's multi value profile property.

    Declaration
    void SetMultiValuedProfileProperty(string accountName, string propertyName, IList<string> propertyValues)
    Parameters
    System.String accountName

    The account name, i.e. "i:0#.f|membership|admin@m365x790252.onmicrosoft.com&quot;

    System.String propertyName

    The case-sensitive name of the property to get.

    PnP.Core.Model.SharePoint.IList<System.String> propertyValues

    The property values

    SetMultiValuedProfilePropertyAsync(String, String, IList<String>)

    Sets the user's multi value profile property.

    Declaration
    Task SetMultiValuedProfilePropertyAsync(string accountName, string propertyName, IList<string> propertyValues)
    Parameters
    System.String accountName

    The account name, i.e. "i:0#.f|membership|admin@m365x790252.onmicrosoft.com&quot;

    System.String propertyName

    The case-sensitive name of the property to get.

    PnP.Core.Model.SharePoint.IList<System.String> propertyValues

    The property values

    Returns
    Task

    SetMyProfilePicture(Byte[])

    Uploads and sets the user profile picture. Users can upload a picture to their own profile only.

    Declaration
    void SetMyProfilePicture(byte[] fileBytes)
    Parameters
    System.Byte[] fileBytes

    A byte array representing the file

    SetMyProfilePictureAsync(Byte[])

    Uploads and sets the user profile picture. Users can upload a picture to their own profile only.

    Declaration
    Task SetMyProfilePictureAsync(byte[] fileBytes)
    Parameters
    System.Byte[] fileBytes

    A byte array representing the file

    Returns
    Task

    SetSingleValueProfileProperty(String, String, String)

    Sets the user's profile property.

    Declaration
    void SetSingleValueProfileProperty(string accountName, string propertyName, string propertyValue)
    Parameters
    System.String accountName

    The account name, i.e. "i:0#.f|membership|admin@m365x790252.onmicrosoft.com&quot;

    System.String propertyName

    The case-sensitive name of the property to get.

    System.String propertyValue

    The property value

    SetSingleValueProfilePropertyAsync(String, String, String)

    Sets the user's profile property.

    Declaration
    Task SetSingleValueProfilePropertyAsync(string accountName, string propertyName, string propertyValue)
    Parameters
    System.String accountName

    The account name, i.e. "i:0#.f|membership|admin@m365x790252.onmicrosoft.com&quot;

    System.String propertyName

    The case-sensitive name of the property to get.

    System.String propertyValue

    The property value

    Returns
    Task

    SetUserOneDriveQuota(String, Int64, Int64)

    Sets the user's onedrive quota

    Declaration
    string SetUserOneDriveQuota(string accountName, long newQuota, long newQuotaWarning)
    Parameters
    System.String accountName

    The account name, i.e. "i:0#.f|membership|admin@m365x790252.onmicrosoft.com&quot;

    System.Int64 newQuota

    New quota value

    System.Int64 newQuotaWarning

    Quota warning value

    Returns
    System.String

    The string outcome

    SetUserOneDriveQuotaAsync(String, Int64, Int64)

    Sets the user's onedrive quota

    Declaration
    Task<string> SetUserOneDriveQuotaAsync(string accountName, long newQuota, long newQuotaWarning)
    Parameters
    System.String accountName

    The account name, i.e. "i:0#.f|membership|admin@m365x790252.onmicrosoft.com&quot;

    System.Int64 newQuota

    New quota value

    System.Int64 newQuotaWarning

    Quota warning value

    Returns
    Task<System.String>

    The string outcome

    Extension Methods

    DataModelGetExtensions.GetBatchAsync<TModel>(IDataModelGet<TModel>, Expression<Func<TModel, Object>>[])
    DataModelGetExtensions.GetBatchAsync<TModel>(IDataModelGet<TModel>, Batch, Expression<Func<TModel, Object>>[])
    DataModelGetExtensions.GetBatch<TModel>(IDataModelGet<TModel>, Batch, Expression<Func<TModel, Object>>[])
    DataModelGetExtensions.GetBatch<TModel>(IDataModelGet<TModel>, Expression<Func<TModel, Object>>[])
    DataModelGetExtensions.Get<TModel>(IDataModelGet<TModel>, Expression<Func<TModel, Object>>[])
    DataModelLoadExtensions.LoadBatchAsync<TModel>(IDataModelLoad<TModel>, Expression<Func<TModel, Object>>[])
    DataModelLoadExtensions.LoadBatchAsync<TModel>(IDataModelLoad<TModel>, Batch, Expression<Func<TModel, Object>>[])
    DataModelLoadExtensions.LoadBatch<TModel>(IDataModelLoad<TModel>, Batch, Expression<Func<TModel, Object>>[])
    DataModelLoadExtensions.LoadBatch<TModel>(IDataModelLoad<TModel>, Expression<Func<TModel, Object>>[])
    DataModelLoadExtensions.Load<TModel>(IDataModelLoad<TModel>, Expression<Func<TModel, Object>>[])
    DataModelLoadExtensions.QueryProperties<TModel>(IDataModelLoad<TModel>, Expression<Func<TModel, Object>>[])
    RequestModuleExtensions.WithHeaders<TModel>(ISupportModules<TModel>, Dictionary<String, String>, Action<Dictionary<String, String>>)
    RequestModuleExtensions.WithResponseHeaders<TModel>(ISupportModules<TModel>, Action<Dictionary<String, String>>)
    Back to top PnP Core SDK
    Generated by DocFX with Material UI
    spacer