Microsoft.PSRule.Rules.GitHub.Core.xml

<?xml version="1.0"?>
<doc>
    <assembly>
        <name>Microsoft.PSRule.Rules.GitHub.Core</name>
    </assembly>
    <members>
        <member name="T:PSRule.Rules.GitHub.PSObjectJsonConverter">
            <summary>
            A custom serializer to correctly convert PSObject properties to JSON instead of CLIXML.
            </summary>
        </member>
        <member name="T:PSRule.Rules.GitHub.Configuration.ConfigurationOption">
            <summary>
            A set of configuration values that can be used within rule definitions.
            </summary>
        </member>
        <member name="T:PSRule.Rules.GitHub.Configuration.OutputOption">
            <summary>
            Options for generating and formatting output.
            </summary>
        </member>
        <member name="P:PSRule.Rules.GitHub.Configuration.OutputOption.Encoding">
            <summary>
            The encoding to use when writing results to file.
            </summary>
        </member>
        <member name="P:PSRule.Rules.GitHub.Configuration.OutputOption.Path">
            <summary>
            The file path location to save results.
            </summary>
        </member>
        <member name="T:PSRule.Rules.GitHub.Configuration.PathDelegate">
            <summary>
            A delgate to allow callback to PowerShell to get current working path.
            </summary>
        </member>
        <member name="F:PSRule.Rules.GitHub.Configuration.PSRuleOption._GetWorkingPath">
            <summary>
            A callback that is overridden by PowerShell so that the current working path can be retrieved.
            </summary>
        </member>
        <member name="P:PSRule.Rules.GitHub.Configuration.PSRuleOption.Output">
            <summary>
            Options that affect how output is generated.
            </summary>
        </member>
        <member name="M:PSRule.Rules.GitHub.Configuration.PSRuleOption.UseExecutionContext(System.Management.Automation.EngineIntrinsics)">
            <summary>
            Set working path from PowerShell host environment.
            </summary>
            <param name="executionContext">An $ExecutionContext object.</param>
            <remarks>
            Called from PowerShell.
            </remarks>
        </member>
        <member name="M:PSRule.Rules.GitHub.Configuration.PSRuleOption.GetRootedPath(System.String)">
            <summary>
            Get a full path instead of a relative path that may be passed from PowerShell.
            </summary>
        </member>
        <member name="M:PSRule.Rules.GitHub.Configuration.PSRuleOption.GetRootedBasePath(System.String)">
            <summary>
            Get a full path instead of a relative path that may be passed from PowerShell.
            </summary>
        </member>
        <member name="T:PSRule.Rules.GitHub.Pipeline.PipelineException">
            <summary>
            A base class for all pipeline exceptions.
            </summary>
        </member>
        <member name="M:PSRule.Rules.GitHub.Pipeline.PipelineException.#ctor">
            <summary>
            Creates a pipeline exception.
            </summary>
        </member>
        <member name="M:PSRule.Rules.GitHub.Pipeline.PipelineException.#ctor(System.String)">
            <summary>
            Creates a pipeline exception.
            </summary>
            <param name="message">The detail of the exception.</param>
        </member>
        <member name="M:PSRule.Rules.GitHub.Pipeline.PipelineException.#ctor(System.String,System.Exception)">
            <summary>
            Creates a pipeline exception.
            </summary>
            <param name="message">The detail of the exception.</param>
            <param name="innerException">A nested exception that caused the issue.</param>
        </member>
        <member name="T:PSRule.Rules.GitHub.Pipeline.PipelineSerializationException">
            <summary>
            A serialization exception.
            </summary>
        </member>
        <member name="M:PSRule.Rules.GitHub.Pipeline.PipelineSerializationException.#ctor">
            <summary>
            Creates a serialization exception.
            </summary>
        </member>
        <member name="M:PSRule.Rules.GitHub.Pipeline.PipelineSerializationException.#ctor(System.String)">
            <summary>
            Creates a serialization exception.
            </summary>
            <param name="message">The detail of the exception.</param>
        </member>
        <member name="M:PSRule.Rules.GitHub.Pipeline.PipelineSerializationException.#ctor(System.String,System.Exception)">
            <summary>
            Creates a serialization exception.
            </summary>
            <param name="message">The detail of the exception.</param>
            <param name="innerException">A nested exception that caused the issue.</param>
        </member>
        <member name="T:PSRule.Rules.GitHub.Pipeline.InvalidTemplateLinkException">
            <summary>
            An exception related to template linking.
            </summary>
        </member>
        <member name="M:PSRule.Rules.GitHub.Pipeline.InvalidTemplateLinkException.#ctor">
            <summary>
            Creates a template linking exception.
            </summary>
        </member>
        <member name="M:PSRule.Rules.GitHub.Pipeline.InvalidTemplateLinkException.#ctor(System.String)">
            <summary>
            Creates a template linking exception.
            </summary>
            <param name="message">The detail of the exception.</param>
        </member>
        <member name="M:PSRule.Rules.GitHub.Pipeline.InvalidTemplateLinkException.#ctor(System.String,System.Exception)">
            <summary>
            Creates a template linking exception.
            </summary>
            <param name="message">The detail of the exception.</param>
            <param name="innerException">A nested exception that caused the issue.</param>
        </member>
        <member name="M:PSRule.Rules.GitHub.Pipeline.ExportPipelineBuilder.GetEncoding(System.Nullable{PSRule.Rules.GitHub.Configuration.OutputEncoding})">
            <summary>
            Get the character encoding for the specified output encoding.
            </summary>
            <param name="encoding"></param>
            <returns></returns>
        </member>
        <member name="M:PSRule.Rules.GitHub.Pipeline.GitHubClient.GetRepositoryInternal(System.String)">
            <summary>
            Get matching repositories for the GitHub organization.
            </summary>
        </member>
        <member name="M:PSRule.Rules.GitHub.Pipeline.GitHubClient.GetBranchesInternal(System.String,System.String)">
            <summary>
            Get branches for the repository.
            </summary>
        </member>
        <member name="M:PSRule.Rules.GitHub.Pipeline.GitHubClient.GetMilestonesInternal(System.String,System.String)">
            <summary>
            Get issue milestones for the repository.
            </summary>
        </member>
        <member name="M:PSRule.Rules.GitHub.Pipeline.GitHubClient.GetReleasesInternal(System.String,System.String)">
            <summary>
            Get releases for the repository.
            </summary>
        </member>
        <member name="M:PSRule.Rules.GitHub.Pipeline.GitHubClient.GetLabelsInternal(System.String,System.String)">
            <summary>
            Get issue labels for the repository.
            </summary>
        </member>
        <member name="M:PSRule.Rules.GitHub.Pipeline.GitHubClient.IsOrg(System.String)">
            <summary>
            Do a lookup against a login to determine if it is an organization.
            </summary>
        </member>
        <member name="T:PSRule.Rules.GitHub.Pipeline.LoggingExtensions">
            <summary>
            Extensions for logging to the pipeline.
            </summary>
        </member>
        <member name="T:PSRule.Rules.GitHub.Pipeline.Output.FileOutputWriter">
            <summary>
            An output writer that writes output to disk.
            </summary>
        </member>
        <member name="T:PSRule.Rules.GitHub.Pipeline.Output.PSPipelineWriter">
            <summary>
            An output writer that returns output to the host PowerShell runspace.
            </summary>
        </member>
        <member name="M:PSRule.Rules.GitHub.Pipeline.Output.PSPipelineWriter.WriteError(System.Management.Automation.ErrorRecord)">
            <summary>
            Core methods to hand off to logger.
            </summary>
            <param name="errorRecord">A valid PowerShell error record.</param>
        </member>
        <member name="M:PSRule.Rules.GitHub.Pipeline.Output.PSPipelineWriter.WriteVerbose(System.String)">
            <summary>
            Core method to hand off verbose messages to logger.
            </summary>
            <param name="message">A message to log.</param>
        </member>
        <member name="M:PSRule.Rules.GitHub.Pipeline.Output.PSPipelineWriter.WriteWarning(System.String)">
            <summary>
            Core method to hand off warning messages to logger.
            </summary>
            <param name="message">A message to log</param>
        </member>
        <member name="M:PSRule.Rules.GitHub.Pipeline.Output.PSPipelineWriter.WriteInformation(System.Management.Automation.InformationRecord)">
            <summary>
            Core method to hand off information messages to logger.
            </summary>
        </member>
        <member name="M:PSRule.Rules.GitHub.Pipeline.Output.PSPipelineWriter.WriteDebug(System.Management.Automation.DebugRecord)">
            <summary>
            Core method to hand off debug messages to logger.
            </summary>
        </member>
        <member name="T:PSRule.Rules.GitHub.Pipeline.PipelineBuilder">
            <summary>
            A helper class for building a pipeline from PowerShell.
            </summary>
        </member>
        <member name="T:PSRule.Rules.GitHub.Resources.PSRuleResources">
            <summary>
              A strongly-typed resource class, for looking up localized strings, etc.
            </summary>
        </member>
        <member name="P:PSRule.Rules.GitHub.Resources.PSRuleResources.ResourceManager">
            <summary>
              Returns the cached ResourceManager instance used by this class.
            </summary>
        </member>
        <member name="P:PSRule.Rules.GitHub.Resources.PSRuleResources.Culture">
            <summary>
              Overrides the current thread's CurrentUICulture property for all
              resource lookups using this strongly typed resource class.
            </summary>
        </member>
        <member name="P:PSRule.Rules.GitHub.Resources.PSRuleResources.ReadJsonFailed">
            <summary>
              Looks up a localized string similar to Read JSON failed..
            </summary>
        </member>
        <member name="P:PSRule.Rules.GitHub.Resources.PSRuleResources.SerializeNullPSObject">
            <summary>
              Looks up a localized string similar to Can not serialize a null PSObject..
            </summary>
        </member>
        <member name="P:PSRule.Rules.GitHub.Resources.PSRuleResources.ShouldCreatePath">
            <summary>
              Looks up a localized string similar to Create path.
            </summary>
        </member>
        <member name="P:PSRule.Rules.GitHub.Resources.PSRuleResources.ShouldWriteFile">
            <summary>
              Looks up a localized string similar to Write file.
            </summary>
        </member>
        <member name="T:PSRule.Rules.GitHub.Runtime.Helper">
            <summary>
            External helper to be referenced within rules.
            </summary>
        </member>
    </members>
</doc>