ProfileLoader.xml

<Type Name="ProfileLoader" FullName="Microsoft.Office.Server.UserProfiles.ProfileLoader">
  <TypeSignature Language="C#" Value="public class ProfileLoader" />
  <TypeSignature Language="ILAsm" Value=".class public auto ansi beforefieldinit ProfileLoader extends System.Object" />
  <TypeSignature Language="DocId" Value="T:Microsoft.Office.Server.UserProfiles.ProfileLoader" />
  <TypeSignature Language="VB.NET" Value="Public Class ProfileLoader" />
  <TypeSignature Language="C++ CLI" Value="public ref class ProfileLoader" />
  <TypeSignature Language="F#" Value="type ProfileLoader = class" />
  <AssemblyInfo>
    <AssemblyName>Microsoft.Office.Server.UserProfiles</AssemblyName>
    <AssemblyVersion>15.0.0.0</AssemblyVersion>
  </AssemblyInfo>
  <Base>
    <BaseTypeName>System.Object</BaseTypeName>
  </Base>
  <Interfaces />
  <Attributes>
    <Attribute>
      <AttributeName>Microsoft.SharePoint.Client.ClientCallableType(ServerTypeId="9c42543a-91b3-4902-b2fe-14ccdefb6e2b")</AttributeName>
    </Attribute>
    <Attribute>
      <AttributeName>System.ComponentModel.DefaultProperty("ErrorText")</AttributeName>
    </Attribute>
    <Attribute>
      <AttributeName>System.Web.UI.ToolboxData("&lt;{0}:ProfileLoader runat=server&gt;&lt;/{0}:ProfileLoader&gt;")</AttributeName>
    </Attribute>
  </Attributes>
  <Docs>
    <summary>Provides an alternate entry point to user profiles rather than calling methods directly.</summary>
    <remarks>
      <para>This class is intended to be used from within a Web context, where multiple Web Parts can share a single-user profile object.</para>
      <para>Using a <b>ProfileLoader</b> object depends on you using the Web. If your application is on the Web, the <b>ProfileLoader</b> object attempts to use a Web cache and a server context. If your application is not on the Web, you must specify the server context.</para>
      <para />
    </remarks>
  </Docs>
  <Members>
    <Member MemberName="GetProfileLoader">
      <MemberSignature Language="C#" Value="public static Microsoft.Office.Server.UserProfiles.ProfileLoader GetProfileLoader ();" />
      <MemberSignature Language="ILAsm" Value=".method public static hidebysig class Microsoft.Office.Server.UserProfiles.ProfileLoader GetProfileLoader() cil managed" />
      <MemberSignature Language="DocId" Value="M:Microsoft.Office.Server.UserProfiles.ProfileLoader.GetProfileLoader" />
      <MemberSignature Language="VB.NET" Value="Public Shared Function GetProfileLoader () As ProfileLoader" />
      <MemberSignature Language="C++ CLI" Value="public:&#xA; static Microsoft::Office::Server::UserProfiles::ProfileLoader ^ GetProfileLoader();" />
      <MemberSignature Language="F#" Value="static member GetProfileLoader : unit -&gt; Microsoft.Office.Server.UserProfiles.ProfileLoader" Usage="Microsoft.Office.Server.UserProfiles.ProfileLoader.GetProfileLoader " />
      <MemberType>Method</MemberType>
      <AssemblyInfo>
        <AssemblyName>Microsoft.Office.Server.UserProfiles</AssemblyName>
        <AssemblyVersion>15.0.0.0</AssemblyVersion>
      </AssemblyInfo>
      <Attributes>
        <Attribute>
          <AttributeName>Microsoft.SharePoint.Client.ClientCallable</AttributeName>
        </Attribute>
      </Attributes>
      <ReturnValue>
        <ReturnType>Microsoft.Office.Server.UserProfiles.ProfileLoader</ReturnType>
      </ReturnValue>
      <Parameters />
      <Docs>
        <summary>Gets a <see cref="T:Microsoft.Office.Server.UserProfiles.ProfileLoader" /> object from the context cache.</summary>
        <returns>The <see cref="T:Microsoft.Office.Server.UserProfiles.ProfileLoader" /> object.</returns>
        <remarks>
          <para>Use the <see cref="M:Microsoft.Office.Server.UserProfiles.ProfileLoader.GetProfileLoader" /> method if you are writing code for the web. The <see cref="M:Microsoft.Office.Server.UserProfiles.ProfileLoader.GetProfileLoader" /> method uses the default server context (the server context of the portal that you are currently browsing).</para>
          <para />
        </remarks>
      </Docs>
    </Member>
    <Member MemberName="GetProfileLoader">
      <MemberSignature Language="C#" Value="public static Microsoft.Office.Server.UserProfiles.ProfileLoader GetProfileLoader (Microsoft.Office.Server.ServerContext serverContext);" />
      <MemberSignature Language="ILAsm" Value=".method public static hidebysig class Microsoft.Office.Server.UserProfiles.ProfileLoader GetProfileLoader(class Microsoft.Office.Server.ServerContext serverContext) cil managed" />
      <MemberSignature Language="DocId" Value="M:Microsoft.Office.Server.UserProfiles.ProfileLoader.GetProfileLoader(Microsoft.Office.Server.ServerContext)" />
      <MemberSignature Language="C++ CLI" Value="public:&#xA; static Microsoft::Office::Server::UserProfiles::ProfileLoader ^ GetProfileLoader(Microsoft::Office::Server::ServerContext ^ serverContext);" />
      <MemberSignature Language="F#" Value="static member GetProfileLoader : Microsoft.Office.Server.ServerContext -&gt; Microsoft.Office.Server.UserProfiles.ProfileLoader" Usage="Microsoft.Office.Server.UserProfiles.ProfileLoader.GetProfileLoader serverContext" />
      <MemberType>Method</MemberType>
      <AssemblyInfo>
        <AssemblyName>Microsoft.Office.Server.UserProfiles</AssemblyName>
        <AssemblyVersion>15.0.0.0</AssemblyVersion>
      </AssemblyInfo>
      <Attributes>
        <Attribute>
          <AttributeName>System.Obsolete("ServerContext parameter is obsolete, use SPServiceContext instead.")</AttributeName>
        </Attribute>
      </Attributes>
      <ReturnValue>
        <ReturnType>Microsoft.Office.Server.UserProfiles.ProfileLoader</ReturnType>
      </ReturnValue>
      <Parameters>
        <Parameter Name="serverContext" Type="Microsoft.Office.Server.ServerContext" />
      </Parameters>
      <Docs>
        <param name="serverContext">The server context that contains the source or destination contextual information.</param>
        <summary>Gets a <see cref="T:Microsoft.Office.Server.UserProfiles.ProfileLoader" /> object from the context cache.</summary>
        <returns>The <see cref="T:Microsoft.Office.Server.UserProfiles.ProfileLoader" /><b> object</b>.</returns>
        <remarks>
          <para>Use the <see cref="M:Microsoft.Office.Server.UserProfiles.ProfileLoader.GetProfileLoader" /> method if you are writing code for the web. The <see cref="M:Microsoft.Office.Server.UserProfiles.ProfileLoader.GetProfileLoader" /> method uses the default server context (the server context of the portal that you are currently browsing).</para>
          <para />
        </remarks>
      </Docs>
    </Member>
    <Member MemberName="GetProfileLoader">
      <MemberSignature Language="C#" Value="public static Microsoft.Office.Server.UserProfiles.ProfileLoader GetProfileLoader (Microsoft.SharePoint.SPServiceContext serviceContext);" />
      <MemberSignature Language="ILAsm" Value=".method public static hidebysig class Microsoft.Office.Server.UserProfiles.ProfileLoader GetProfileLoader(class Microsoft.SharePoint.SPServiceContext serviceContext) cil managed" />
      <MemberSignature Language="DocId" Value="M:Microsoft.Office.Server.UserProfiles.ProfileLoader.GetProfileLoader(Microsoft.SharePoint.SPServiceContext)" />
      <MemberSignature Language="VB.NET" Value="Public Shared Function GetProfileLoader (serviceContext As SPServiceContext) As ProfileLoader" />
      <MemberSignature Language="C++ CLI" Value="public:&#xA; static Microsoft::Office::Server::UserProfiles::ProfileLoader ^ GetProfileLoader(Microsoft::SharePoint::SPServiceContext ^ serviceContext);" />
      <MemberSignature Language="F#" Value="static member GetProfileLoader : Microsoft.SharePoint.SPServiceContext -&gt; Microsoft.Office.Server.UserProfiles.ProfileLoader" Usage="Microsoft.Office.Server.UserProfiles.ProfileLoader.GetProfileLoader serviceContext" />
      <MemberType>Method</MemberType>
      <AssemblyInfo>
        <AssemblyName>Microsoft.Office.Server.UserProfiles</AssemblyName>
        <AssemblyVersion>15.0.0.0</AssemblyVersion>
      </AssemblyInfo>
      <ReturnValue>
        <ReturnType>Microsoft.Office.Server.UserProfiles.ProfileLoader</ReturnType>
      </ReturnValue>
      <Parameters>
        <Parameter Name="serviceContext" Type="Microsoft.SharePoint.SPServiceContext" />
      </Parameters>
      <Docs>
        <param name="serviceContext">To be added.</param>
        <summary>To be added.</summary>
        <returns>To be added.</returns>
        <remarks>To be added.</remarks>
      </Docs>
    </Member>
    <Member MemberName="GetProfileLoader">
      <MemberSignature Language="C#" Value="public static Microsoft.Office.Server.UserProfiles.ProfileLoader GetProfileLoader (bool IgnoreUserPrivacy);" />
      <MemberSignature Language="ILAsm" Value=".method public static hidebysig class Microsoft.Office.Server.UserProfiles.ProfileLoader GetProfileLoader(bool IgnoreUserPrivacy) cil managed" />
      <MemberSignature Language="DocId" Value="M:Microsoft.Office.Server.UserProfiles.ProfileLoader.GetProfileLoader(System.Boolean)" />
      <MemberSignature Language="VB.NET" Value="Public Shared Function GetProfileLoader (IgnoreUserPrivacy As Boolean) As ProfileLoader" />
      <MemberSignature Language="C++ CLI" Value="public:&#xA; static Microsoft::Office::Server::UserProfiles::ProfileLoader ^ GetProfileLoader(bool IgnoreUserPrivacy);" />
      <MemberSignature Language="F#" Value="static member GetProfileLoader : bool -&gt; Microsoft.Office.Server.UserProfiles.ProfileLoader" Usage="Microsoft.Office.Server.UserProfiles.ProfileLoader.GetProfileLoader IgnoreUserPrivacy" />
      <MemberType>Method</MemberType>
      <AssemblyInfo>
        <AssemblyName>Microsoft.Office.Server.UserProfiles</AssemblyName>
        <AssemblyVersion>15.0.0.0</AssemblyVersion>
      </AssemblyInfo>
      <ReturnValue>
        <ReturnType>Microsoft.Office.Server.UserProfiles.ProfileLoader</ReturnType>
      </ReturnValue>
      <Parameters>
        <Parameter Name="IgnoreUserPrivacy" Type="System.Boolean" />
      </Parameters>
      <Docs>
        <param name="IgnoreUserPrivacy">Set to <b>true</b> to ignore the user privacy setting; otherwise, <b>false</b>.</param>
        <summary>Gets a <see cref="T:Microsoft.Office.Server.UserProfiles.ProfileLoader" /> object from the context cache.</summary>
        <returns>The <see cref="T:Microsoft.Office.Server.UserProfiles.ProfileLoader" /> object.</returns>
        <remarks>
          <para>Use the <see cref="M:Microsoft.Office.Server.UserProfiles.ProfileLoader.GetProfileLoader" /> method if you are writing code for the web. The <see cref="M:Microsoft.Office.Server.UserProfiles.ProfileLoader.GetProfileLoader" />method uses the default server context (the server context of the portal that you are currently browsing).</para>
          <para />
        </remarks>
      </Docs>
    </Member>
    <Member MemberName="GetProfileLoader">
      <MemberSignature Language="C#" Value="public static Microsoft.Office.Server.UserProfiles.ProfileLoader GetProfileLoader (Microsoft.Office.Server.ServerContext serverContext, bool IgnoreUserPrivacy);" />
      <MemberSignature Language="ILAsm" Value=".method public static hidebysig class Microsoft.Office.Server.UserProfiles.ProfileLoader GetProfileLoader(class Microsoft.Office.Server.ServerContext serverContext, bool IgnoreUserPrivacy) cil managed" />
      <MemberSignature Language="DocId" Value="M:Microsoft.Office.Server.UserProfiles.ProfileLoader.GetProfileLoader(Microsoft.Office.Server.ServerContext,System.Boolean)" />
      <MemberSignature Language="C++ CLI" Value="public:&#xA; static Microsoft::Office::Server::UserProfiles::ProfileLoader ^ GetProfileLoader(Microsoft::Office::Server::ServerContext ^ serverContext, bool IgnoreUserPrivacy);" />
      <MemberSignature Language="F#" Value="static member GetProfileLoader : Microsoft.Office.Server.ServerContext * bool -&gt; Microsoft.Office.Server.UserProfiles.ProfileLoader" Usage="Microsoft.Office.Server.UserProfiles.ProfileLoader.GetProfileLoader (serverContext, IgnoreUserPrivacy)" />
      <MemberType>Method</MemberType>
      <AssemblyInfo>
        <AssemblyName>Microsoft.Office.Server.UserProfiles</AssemblyName>
        <AssemblyVersion>15.0.0.0</AssemblyVersion>
      </AssemblyInfo>
      <Attributes>
        <Attribute>
          <AttributeName>System.Obsolete("ServerContext parameter is obsolete, use SPServiceContext instead.")</AttributeName>
        </Attribute>
      </Attributes>
      <ReturnValue>
        <ReturnType>Microsoft.Office.Server.UserProfiles.ProfileLoader</ReturnType>
      </ReturnValue>
      <Parameters>
        <Parameter Name="serverContext" Type="Microsoft.Office.Server.ServerContext" />
        <Parameter Name="IgnoreUserPrivacy" Type="System.Boolean" />
      </Parameters>
      <Docs>
        <param name="serverContext">The server context that contains the source or destination contextual information.</param>
        <param name="IgnoreUserPrivacy">Set to <b>true</b> to ignore user privacy setting; otherwise, <b>false</b>.</param>
        <summary>Gets a <see cref="T:Microsoft.Office.Server.UserProfiles.ProfileLoader" /> object from the context cache.</summary>
        <returns>The <see cref="T:Microsoft.Office.Server.UserProfiles.ProfileLoader" /><b> object</b>.</returns>
        <remarks>
          <para>Use the <see cref="M:Microsoft.Office.Server.UserProfiles.ProfileLoader.GetProfileLoader" /> method if you are writing code for the web. The <see cref="M:Microsoft.Office.Server.UserProfiles.ProfileLoader.GetProfileLoader" /> method uses the default server context (the server context of the portal that you are currently browsing).</para>
          <para />
        </remarks>
      </Docs>
    </Member>
    <Member MemberName="GetProfileLoader">
      <MemberSignature Language="C#" Value="public static Microsoft.Office.Server.UserProfiles.ProfileLoader GetProfileLoader (Microsoft.SharePoint.SPServiceContext serviceContext, bool IgnoreUserPrivacy);" />
      <MemberSignature Language="ILAsm" Value=".method public static hidebysig class Microsoft.Office.Server.UserProfiles.ProfileLoader GetProfileLoader(class Microsoft.SharePoint.SPServiceContext serviceContext, bool IgnoreUserPrivacy) cil managed" />
      <MemberSignature Language="DocId" Value="M:Microsoft.Office.Server.UserProfiles.ProfileLoader.GetProfileLoader(Microsoft.SharePoint.SPServiceContext,System.Boolean)" />
      <MemberSignature Language="VB.NET" Value="Public Shared Function GetProfileLoader (serviceContext As SPServiceContext, IgnoreUserPrivacy As Boolean) As ProfileLoader" />
      <MemberSignature Language="C++ CLI" Value="public:&#xA; static Microsoft::Office::Server::UserProfiles::ProfileLoader ^ GetProfileLoader(Microsoft::SharePoint::SPServiceContext ^ serviceContext, bool IgnoreUserPrivacy);" />
      <MemberSignature Language="F#" Value="static member GetProfileLoader : Microsoft.SharePoint.SPServiceContext * bool -&gt; Microsoft.Office.Server.UserProfiles.ProfileLoader" Usage="Microsoft.Office.Server.UserProfiles.ProfileLoader.GetProfileLoader (serviceContext, IgnoreUserPrivacy)" />
      <MemberType>Method</MemberType>
      <AssemblyInfo>
        <AssemblyName>Microsoft.Office.Server.UserProfiles</AssemblyName>
        <AssemblyVersion>15.0.0.0</AssemblyVersion>
      </AssemblyInfo>
      <ReturnValue>
        <ReturnType>Microsoft.Office.Server.UserProfiles.ProfileLoader</ReturnType>
      </ReturnValue>
      <Parameters>
        <Parameter Name="serviceContext" Type="Microsoft.SharePoint.SPServiceContext" />
        <Parameter Name="IgnoreUserPrivacy" Type="System.Boolean" />
      </Parameters>
      <Docs>
        <param name="serviceContext">To be added.</param>
        <param name="IgnoreUserPrivacy">To be added.</param>
        <summary>To be added.</summary>
        <returns>To be added.</returns>
        <remarks>To be added.</remarks>
      </Docs>
    </Member>
    <Member MemberName="GetUserProfile">
      <MemberSignature Language="C#" Value="public Microsoft.Office.Server.UserProfiles.UserProfile GetUserProfile ();" />
      <MemberSignature Language="ILAsm" Value=".method public hidebysig instance class Microsoft.Office.Server.UserProfiles.UserProfile GetUserProfile() cil managed" />
      <MemberSignature Language="DocId" Value="M:Microsoft.Office.Server.UserProfiles.ProfileLoader.GetUserProfile" />
      <MemberSignature Language="VB.NET" Value="Public Function GetUserProfile () As UserProfile" />
      <MemberSignature Language="C++ CLI" Value="public:&#xA; Microsoft::Office::Server::UserProfiles::UserProfile ^ GetUserProfile();" />
      <MemberSignature Language="F#" Value="member this.GetUserProfile : unit -&gt; Microsoft.Office.Server.UserProfiles.UserProfile" Usage="profileLoader.GetUserProfile " />
      <MemberType>Method</MemberType>
      <AssemblyInfo>
        <AssemblyName>Microsoft.Office.Server.UserProfiles</AssemblyName>
        <AssemblyVersion>15.0.0.0</AssemblyVersion>
      </AssemblyInfo>
      <Attributes>
        <Attribute>
          <AttributeName>Microsoft.SharePoint.Client.ClientCallable</AttributeName>
        </Attribute>
      </Attributes>
      <ReturnValue>
        <ReturnType>Microsoft.Office.Server.UserProfiles.UserProfile</ReturnType>
      </ReturnValue>
      <Parameters />
      <Docs>
        <summary>Gets a <b>UserProfile</b> object corresponding to the current user.</summary>
        <returns>The <see cref="F:Microsoft.Office.Server.UserProfiles.ObjectTypes.UserProfile" /> object corresponding to the current user.</returns>
        <remarks>To be added.</remarks>
      </Docs>
    </Member>
    <Member MemberName="GetUserProfileManager">
      <MemberSignature Language="C#" Value="public Microsoft.Office.Server.UserProfiles.UserProfileManager GetUserProfileManager ();" />
      <MemberSignature Language="ILAsm" Value=".method public hidebysig instance class Microsoft.Office.Server.UserProfiles.UserProfileManager GetUserProfileManager() cil managed" />
      <MemberSignature Language="DocId" Value="M:Microsoft.Office.Server.UserProfiles.ProfileLoader.GetUserProfileManager" />
      <MemberSignature Language="VB.NET" Value="Public Function GetUserProfileManager () As UserProfileManager" />
      <MemberSignature Language="C++ CLI" Value="public:&#xA; Microsoft::Office::Server::UserProfiles::UserProfileManager ^ GetUserProfileManager();" />
      <MemberSignature Language="F#" Value="member this.GetUserProfileManager : unit -&gt; Microsoft.Office.Server.UserProfiles.UserProfileManager" Usage="profileLoader.GetUserProfileManager " />
      <MemberType>Method</MemberType>
      <AssemblyInfo>
        <AssemblyName>Microsoft.Office.Server.UserProfiles</AssemblyName>
        <AssemblyVersion>15.0.0.0</AssemblyVersion>
      </AssemblyInfo>
      <ReturnValue>
        <ReturnType>Microsoft.Office.Server.UserProfiles.UserProfileManager</ReturnType>
      </ReturnValue>
      <Parameters />
      <Docs>
        <summary>Gets a <see cref="T:Microsoft.Office.Server.UserProfiles.UserProfileManager" /> object.</summary>
        <returns>The <see cref="T:Microsoft.Office.Server.UserProfiles.UserProfileManager" /> object.</returns>
        <remarks>To be added.</remarks>
      </Docs>
    </Member>
  </Members>
</Type>