PackageManagement.Sdk.Request.YieldDynamicOption C# (CSharp) Method

YieldDynamicOption() public abstract method

Used by a provider to return the fields for a Metadata Definition The cmdlets can use this to supply tab-completion for metadata to the user.
public abstract YieldDynamicOption ( string name, string expectedType, bool isRequired ) : bool
name string the provider-defined name of the option
expectedType string one of ['string','int','path','switch']
isRequired bool if the parameter is mandatory
return bool
        public abstract bool YieldDynamicOption(string name, string expectedType, bool isRequired);

Same methods

Request::YieldDynamicOption ( string name, string expectedType, bool isRequired, IEnumerable permittedValues ) : bool

Usage Example

        public void GetDynamicOptions(string category, Request request)
        {
            request.Debug("Calling '{0}::GetDynamicOptions'", PackageProviderName);
            switch ((category ?? string.Empty).ToLowerInvariant())
            {
                case "package":
                    request.YieldDynamicOption("Refresh", Constants.OptionType.Switch, isRequired: false);
                    request.YieldDynamicOption("AllVersions", Constants.OptionType.Switch, isRequired: false);
                    request.YieldDynamicOption("GlobalSearch", Constants.OptionType.Switch, isRequired: false);
                    break;

                case "install":
                    request.YieldDynamicOption("Refresh", Constants.OptionType.Switch, isRequired: false);
                    request.YieldDynamicOption("DeferDownload", Constants.OptionType.Switch, isRequired: false);
                    request.YieldDynamicOption("Scope", Constants.OptionType.String, isRequired: false, permittedValues: new[] { "CurrentUser", "AllUsers" });
                    break;

                case "source":
                    break;
            }
        }