review.tizen.org Git - platform/core/dotnet/build-tools.git/blob

   1 <?xml version="1.0"?>\r
   2 <doc>\r
   3     <assembly>\r
   4         <name>Microsoft.Extensions.Configuration.UserSecrets</name>\r
   5     </assembly>\r
   6     <members>\r
   7         <member name="T:Microsoft.Extensions.Configuration.UserSecrets.PathHelper">\r
   8             <summary>\r
   9             Provides paths for user secrets configuration files.\r
  10             </summary>\r
  11         </member>\r
  12         <member name="M:Microsoft.Extensions.Configuration.UserSecrets.PathHelper.GetSecretsPathFromSecretsId(System.String)">\r
  13             <summary>\r
  14             <para>\r
  15             Returns the path to the JSON file that stores user secrets.\r
  16             </para>\r
  17             <para>\r
  18             This uses the current user profile to locate the secrets file on disk in a location outside of source control.\r
  19             </para>\r
  20             </summary>\r
  21             <param name="userSecretsId">The user secret ID.</param>\r
  22             <returns>The full path to the secret file.</returns>\r
  23         </member>\r
  24         <member name="T:Microsoft.Extensions.Configuration.UserSecrets.UserSecretsIdAttribute">\r
  25             <summary>\r
  26             <para>\r
  27             Represents the user secrets ID.\r
  28             </para>\r
  29             <para>\r
  30             In most cases, this attribute is automatically generated during compilation by MSBuild targets\r
  31             included in the UserSecrets NuGet package. These targets use the MSBuild property 'UserSecretsId'\r
  32             to set the value for <see cref="P:Microsoft.Extensions.Configuration.UserSecrets.UserSecretsIdAttribute.UserSecretsId"/>.\r
  33             </para>\r
  34             </summary>\r
  35         </member>\r
  36         <member name="M:Microsoft.Extensions.Configuration.UserSecrets.UserSecretsIdAttribute.#ctor(System.String)">\r
  37             <summary>\r
  38             Initializes an instance of <see cref="T:Microsoft.Extensions.Configuration.UserSecrets.UserSecretsIdAttribute" />.\r
  39             </summary>\r
  40             <param name="userSecretId">The user secrets ID.</param>\r
  41         </member>\r
  42         <member name="P:Microsoft.Extensions.Configuration.UserSecrets.UserSecretsIdAttribute.UserSecretsId">\r
  43             <summary>\r
  44             The user secrets ID.\r
  45             </summary>\r
  46         </member>\r
  47         <member name="T:Microsoft.Extensions.Configuration.UserSecretsConfigurationExtensions">\r
  48             <summary>\r
  49             Configuration extensions for adding user secrets configuration source.\r
  50             </summary>\r
  51         </member>\r
  52         <member name="M:Microsoft.Extensions.Configuration.UserSecretsConfigurationExtensions.AddUserSecrets``1(Microsoft.Extensions.Configuration.IConfigurationBuilder)">\r
  53             <summary>\r
  54             <para>\r
  55             Adds the user secrets configuration source. Searches the assembly that contains type <typeparamref name="T"/>\r
  56             for an instance of <see cref="T:Microsoft.Extensions.Configuration.UserSecrets.UserSecretsIdAttribute"/>, which specifies a user secrets ID.\r
  57             </para>\r
  58             <para>\r
  59             A user secrets ID is unique value used to store and identify a collection of secret configuration values.\r
  60             </para>\r
  61             </summary>\r
  62             <param name="configuration">The configuration builder.</param>\r
  63             <typeparam name="T">The type from the assembly to search for an instance of <see cref="T:Microsoft.Extensions.Configuration.UserSecrets.UserSecretsIdAttribute"/>.</typeparam>\r
  64             <exception cref="T:System.InvalidOperationException">Thrown when the assembly containing <typeparamref name="T"/> does not have <see cref="T:Microsoft.Extensions.Configuration.UserSecrets.UserSecretsIdAttribute"/>.</exception>\r
  65             <returns>The configuration builder.</returns>\r
  66         </member>\r
  67         <member name="M:Microsoft.Extensions.Configuration.UserSecretsConfigurationExtensions.AddUserSecrets``1(Microsoft.Extensions.Configuration.IConfigurationBuilder,System.Boolean)">\r
  68             <summary>\r
  69             <para>\r
  70             Adds the user secrets configuration source. Searches the assembly that contains type <typeparamref name="T"/>\r
  71             for an instance of <see cref="T:Microsoft.Extensions.Configuration.UserSecrets.UserSecretsIdAttribute"/>, which specifies a user secrets ID.\r
  72             </para>\r
  73             <para>\r
  74             A user secrets ID is unique value used to store and identify a collection of secret configuration values.\r
  75             </para>\r
  76             </summary>\r
  77             <param name="configuration">The configuration builder.</param>\r
  78             <param name="optional">Whether loading secrets is optional. When false, this method may throw.</param>\r
  79             <exception cref="T:System.InvalidOperationException">Thrown when <paramref name="optional"/> is false and the assembly containing <typeparamref name="T"/> does not have a valid <see cref="T:Microsoft.Extensions.Configuration.UserSecrets.UserSecretsIdAttribute"/>.</exception>\r
  80             <typeparam name="T">The type from the assembly to search for an instance of <see cref="T:Microsoft.Extensions.Configuration.UserSecrets.UserSecretsIdAttribute"/>.</typeparam>\r
  81             <returns>The configuration builder.</returns>\r
  82         </member>\r
  83         <member name="M:Microsoft.Extensions.Configuration.UserSecretsConfigurationExtensions.AddUserSecrets``1(Microsoft.Extensions.Configuration.IConfigurationBuilder,System.Boolean,System.Boolean)">\r
  84             <summary>\r
  85             <para>\r
  86             Adds the user secrets configuration source. Searches the assembly that contains type <typeparamref name="T"/>\r
  87             for an instance of <see cref="T:Microsoft.Extensions.Configuration.UserSecrets.UserSecretsIdAttribute"/>, which specifies a user secrets ID.\r
  88             </para>\r
  89             <para>\r
  90             A user secrets ID is unique value used to store and identify a collection of secret configuration values.\r
  91             </para>\r
  92             </summary>\r
  93             <param name="configuration">The configuration builder.</param>\r
  94             <param name="optional">Whether loading secrets is optional. When false, this method may throw.</param>\r
  95             <param name="reloadOnChange">Whether the configuration should be reloaded if the file changes.</param>\r
  96             <exception cref="T:System.InvalidOperationException">Thrown when <paramref name="optional"/> is false and the assembly containing <typeparamref name="T"/> does not have a valid <see cref="T:Microsoft.Extensions.Configuration.UserSecrets.UserSecretsIdAttribute"/>.</exception>\r
  97             <typeparam name="T">The type from the assembly to search for an instance of <see cref="T:Microsoft.Extensions.Configuration.UserSecrets.UserSecretsIdAttribute"/>.</typeparam>\r
  98             <returns>The configuration builder.</returns>\r
  99         </member>\r
 100         <member name="M:Microsoft.Extensions.Configuration.UserSecretsConfigurationExtensions.AddUserSecrets(Microsoft.Extensions.Configuration.IConfigurationBuilder,System.Reflection.Assembly)">\r
 101             <summary>\r
 102             <para>\r
 103             Adds the user secrets configuration source. This searches <paramref name="assembly"/> for an instance\r
 104             of <see cref="T:Microsoft.Extensions.Configuration.UserSecrets.UserSecretsIdAttribute"/>, which specifies a user secrets ID.\r
 105             </para>\r
 106             <para>\r
 107             A user secrets ID is unique value used to store and identify a collection of secret configuration values.\r
 108             </para>\r
 109             </summary>\r
 110             <param name="configuration">The configuration builder.</param>\r
 111             <param name="assembly">The assembly with the <see cref="T:Microsoft.Extensions.Configuration.UserSecrets.UserSecretsIdAttribute" />.</param>\r
 112             <exception cref="T:System.InvalidOperationException">Thrown when <paramref name="assembly"/> does not have a valid <see cref="T:Microsoft.Extensions.Configuration.UserSecrets.UserSecretsIdAttribute"/></exception>\r
 113             <returns>The configuration builder.</returns>\r
 114         </member>\r
 115         <member name="M:Microsoft.Extensions.Configuration.UserSecretsConfigurationExtensions.AddUserSecrets(Microsoft.Extensions.Configuration.IConfigurationBuilder,System.Reflection.Assembly,System.Boolean)">\r
 116             <summary>\r
 117             <para>\r
 118             Adds the user secrets configuration source. This searches <paramref name="assembly"/> for an instance\r
 119             of <see cref="T:Microsoft.Extensions.Configuration.UserSecrets.UserSecretsIdAttribute"/>, which specifies a user secrets ID.\r
 120             </para>\r
 121             <para>\r
 122             A user secrets ID is unique value used to store and identify a collection of secret configuration values.\r
 123             </para>\r
 124             </summary>\r
 125             <param name="configuration">The configuration builder.</param>\r
 126             <param name="assembly">The assembly with the <see cref="T:Microsoft.Extensions.Configuration.UserSecrets.UserSecretsIdAttribute" />.</param>\r
 127             <param name="optional">Whether loading secrets is optional. When false, this method may throw.</param>\r
 128             <exception cref="T:System.InvalidOperationException">Thrown when <paramref name="optional"/> is false and <paramref name="assembly"/> does not have a valid <see cref="T:Microsoft.Extensions.Configuration.UserSecrets.UserSecretsIdAttribute"/>.</exception>\r
 129             <returns>The configuration builder.</returns>\r
 130         </member>\r
 131         <member name="M:Microsoft.Extensions.Configuration.UserSecretsConfigurationExtensions.AddUserSecrets(Microsoft.Extensions.Configuration.IConfigurationBuilder,System.Reflection.Assembly,System.Boolean,System.Boolean)">\r
 132             <summary>\r
 133             <para>\r
 134             Adds the user secrets configuration source. This searches <paramref name="assembly"/> for an instance\r
 135             of <see cref="T:Microsoft.Extensions.Configuration.UserSecrets.UserSecretsIdAttribute"/>, which specifies a user secrets ID.\r
 136             </para>\r
 137             <para>\r
 138             A user secrets ID is unique value used to store and identify a collection of secret configuration values.\r
 139             </para>\r
 140             </summary>\r
 141             <param name="configuration">The configuration builder.</param>\r
 142             <param name="assembly">The assembly with the <see cref="T:Microsoft.Extensions.Configuration.UserSecrets.UserSecretsIdAttribute" />.</param>\r
 143             <param name="optional">Whether loading secrets is optional. When false, this method may throw.</param>\r
 144             <param name="reloadOnChange">Whether the configuration should be reloaded if the file changes.</param>\r
 145             <exception cref="T:System.InvalidOperationException">Thrown when <paramref name="optional"/> is false and <paramref name="assembly"/> does not have a valid <see cref="T:Microsoft.Extensions.Configuration.UserSecrets.UserSecretsIdAttribute"/>.</exception>\r
 146             <returns>The configuration builder.</returns>\r
 147         </member>\r
 148         <member name="M:Microsoft.Extensions.Configuration.UserSecretsConfigurationExtensions.AddUserSecrets(Microsoft.Extensions.Configuration.IConfigurationBuilder,System.String)">\r
 149             <summary>\r
 150             <para>\r
 151             Adds the user secrets configuration source with specified user secrets ID.\r
 152             </para>\r
 153             <para>\r
 154             A user secrets ID is unique value used to store and identify a collection of secret configuration values.\r
 155             </para>\r
 156             </summary>\r
 157             <param name="configuration">The configuration builder.</param>\r
 158             <param name="userSecretsId">The user secrets ID.</param>\r
 159             <returns>The configuration builder.</returns>\r
 160         </member>\r
 161         <member name="M:Microsoft.Extensions.Configuration.UserSecretsConfigurationExtensions.AddUserSecrets(Microsoft.Extensions.Configuration.IConfigurationBuilder,System.String,System.Boolean)">\r
 162             <summary>\r
 163             <para>\r
 164             Adds the user secrets configuration source with specified user secrets ID.\r
 165             </para>\r
 166             <para>\r
 167             A user secrets ID is unique value used to store and identify a collection of secret configuration values.\r
 168             </para>\r
 169             </summary>\r
 170             <param name="configuration">The configuration builder.</param>\r
 171             <param name="userSecretsId">The user secrets ID.</param>\r
 172             <param name="reloadOnChange">Whether the configuration should be reloaded if the file changes.</param>\r
 173             <returns>The configuration builder.</returns>\r
 174         </member>\r
 175         <member name="P:System.SR.Common_StringNullOrEmpty">\r
 176             <summary>Value cannot be null or an empty string.</summary>\r
 177         </member>\r
 178         <member name="P:System.SR.Error_Invalid_Character_In_UserSecrets_Id">\r
 179             <summary>Invalid character '{0}' found in the user secrets ID at index '{1}'.</summary>\r
 180         </member>\r
 181         <member name="P:System.SR.Error_Missing_UserSecretsIdAttribute">\r
 182             <summary>Could not find 'UserSecretsIdAttribute' on assembly '{0}'.\r
 183             Check that the project for '{0}' has set the 'UserSecretsId' build property.\r
 184             If the 'UserSecretsId' property is already set then add a reference to the Microsoft.Extensions.Configuration.UserSecret ...</summary>\r
 185         </member>\r
 186         <member name="P:System.SR.Error_Missing_UserSecretsLocation">\r
 187             <summary>Could not determine an appropriate location for storing user secrets. Set the {0} environment variable to a folder where user secrets should be stored.</summary>\r
 188         </member>\r
 189     </members>\r
 190 </doc>\r