Bentley.FeatureToggle.xml
|
<?xml version="1.0"?>
<doc> <assembly> <name>Bentley.FeatureToggle</name> </assembly> <members> <member name="T:Bentley.FeatureToggle.FeatureToggleClient"> <summary> And implementation of the IFeatureToggleClient that uses IDisposable for convenience and interfaces with a LaunchDarkly client </summary> </member> <member name="M:Bentley.FeatureToggle.FeatureToggleClient.#ctor(System.String,System.Boolean,System.Int32,System.UInt16,Common.Logging.ILog,System.Int32)"> <summary> A constructor that takes a SDK Key and can disable streaming. </summary> <param name="apiKey">This is a Launch Darkly SDK Key</param> /// <param name="enableStreaming">To disable streaming, set this to false. To use streaming, use the contructor that takes relayUri</param> <param name="eventViewCapacity">Sets the capacity of the events buffer</param> <param name="eventQueueSecondsFrequency">Sets the number of seconds between flushes of the event buffer</param> <param name="logger">Allows an ILog implementation to adapt the Common.Logging interface</param> <param name="pollingInterval">For non-streaming connections, sets the polling interval in seconds</param> </member> <member name="M:Bentley.FeatureToggle.FeatureToggleClient.#ctor(System.String,System.String,System.Int32,System.UInt16,Common.Logging.ILog,System.Boolean)"> <summary> A contructor that takes in a Launch Darkly SDK Key and a URI for a Launch Darkly relay </summary> <param name="sdkKey">SDK Key for Launch Darkly which defines a project and environment</param> <param name="relayUri">Uri for a relay</param> <param name="eventViewCapacity">Sets the capacity of the events buffer</param> <param name="eventQueueSecondsFrequency">Sets the number of seconds between flushes of the event buffer</param> <param name="logger">Allows an ILog implementation to adapt the Common.Logging interface</param> <param name="enableStreaming">Boolean value which enables streaming</param> </member> <member name="M:Bentley.FeatureToggle.FeatureToggleClient.IsFeatureEnabled(System.String,Bentley.FeatureToggle.IFeatureToggleUser,System.Boolean)"> <summary> Checks if a feature is enabled for the supplied user </summary> <param name="featureName">The feature name to check</param> <param name="user">the supplied user</param> <param name="fallback">The fallback value if the Feature Service cannot be reached</param> <returns></returns> </member> <member name="M:Bentley.FeatureToggle.FeatureToggleClient.GetMultivariateFeature(System.String,Bentley.FeatureToggle.IFeatureToggleUser,System.String)"> <summary> Gets the value of the multivariate feature for the supplied user </summary> <param name="featureName">The feature name to check</param> <param name="user">the supplied user</param> <param name="fallback">Returned if the Feature Service cannot be reached</param> <returns></returns> </member> <member name="M:Bentley.FeatureToggle.FeatureToggleClient.Track(System.String,Bentley.FeatureToggle.IFeatureToggleUser,System.String)"> <summary> Track that a certain "Goal" was met for a given user </summary> <param name="goalName">The Goal used</param> <param name="user">The user who met the goal</param> <param name="data">any additional json data to attach to the goal's experiment</param> </member> <member name="M:Bentley.FeatureToggle.FeatureToggleClient.DumpFlags(Bentley.FeatureToggle.IFeatureToggleUser)"> <summary> Dumps the current state of feature flags for the given user </summary> <param name="user">The user to dump for</param> </member> <member name="M:Bentley.FeatureToggle.FeatureToggleClient.Flush"> <summary> Flush the reporting buffer back to server </summary> </member> <member name="P:Bentley.FeatureToggle.FeatureToggleUser.EmailOrName"> <summary> The User's email address or Name (name on LaunchDarkly) </summary> </member> <member name="P:Bentley.FeatureToggle.FeatureToggleUser.ImsId"> <summary> The User's unique ImsId (ImsId and key on LaunchDarkly) </summary> </member> <member name="P:Bentley.FeatureToggle.FeatureToggleUser.CountryISO"> <summary> The User's Country ISO (CountryIso on LaunchDarkly) </summary> </member> <member name="P:Bentley.FeatureToggle.FeatureToggleUser.UltimateId"> <summary> Ultimate Id (UltimateId on LaunchDarkly) </summary> </member> <member name="P:Bentley.FeatureToggle.FeatureToggleUser.Roles"> <summary> A list of the User's IMS Role Guids (RoleGuids on LaunchDarkly) </summary> </member> <member name="M:Bentley.FeatureToggle.FeatureToggleUser.#ctor(System.String)"> <summary> Takes the SAML token and fills in the remaining fields from the SAML Claims </summary> <param name="samlToken">The authenticated SAML token. From this token, the following claims will be extracted: name -> <see cref="P:Bentley.FeatureToggle.FeatureToggleUser.EmailOrName"/> countryiso -> <see cref="P:Bentley.FeatureToggle.FeatureToggleUser.CountryISO"/> ultimatesite -> <see cref="P:Bentley.FeatureToggle.FeatureToggleUser.UltimateId"/> userid -> <see cref="P:Bentley.FeatureToggle.FeatureToggleUser.ImsId"/> </param> <param name="userRoles">The user's IMS role GUIDs</param> </member> <member name="M:Bentley.FeatureToggle.FeatureToggleUser.#ctor(System.String,System.String,System.Int64,System.String)"> <summary> Takes the fields worth Gating against </summary> <param name="userEmailOrName"><see cref="P:Bentley.FeatureToggle.FeatureToggleUser.EmailOrName"/></param> <param name="countryIso"><see cref="P:Bentley.FeatureToggle.FeatureToggleUser.CountryISO"/></param> <param name="ultimateId"><see cref="P:Bentley.FeatureToggle.FeatureToggleUser.UltimateId"/></param> <param name="imsId"><see cref="P:Bentley.FeatureToggle.FeatureToggleUser.ImsId"/></param> </member> <member name="M:Bentley.FeatureToggle.FeatureToggleUser.WithImsRoles(System.Collections.Generic.List{System.Guid})"> <summary> Add IMS User Roles to a FeatureToggleUser object </summary> <param name="ImsUserRoles">The user's IMS role GUIDs</param> <returns></returns> </member> <member name="M:Bentley.FeatureToggle.Helper.TokenRegistry.GetIssuerName(System.IdentityModel.Tokens.SecurityToken)"> <summary> Gets the name of the issuer. </summary> <param name="securityToken">The security token.</param> <returns>System.String.</returns> </member> <member name="M:Bentley.FeatureToggle.Helper.TokenRegistry.GetIssuerName(System.IdentityModel.Tokens.SecurityToken,System.String)"> <summary> Gets the name of the issuer. </summary> <param name="securityToken">The security token.</param> <param name="requestedIssuerName">Name of the requested issuer.</param> <returns>System.String.</returns> </member> <member name="T:Bentley.FeatureToggle.IFeatureToggleClient"> <summary> The interface for the FeatureToggleClient </summary> </member> <member name="M:Bentley.FeatureToggle.IFeatureToggleClient.IsFeatureEnabled(System.String,Bentley.FeatureToggle.IFeatureToggleUser,System.Boolean)"> <summary> Checks if the given feature is enabled for the supplied user </summary> <param name="featureName"></param> <param name="user">the supplied user</param> <param name="fallback">Returned if the Feature Service cannot be reached</param> <returns></returns> </member> <member name="M:Bentley.FeatureToggle.IFeatureToggleClient.GetMultivariateFeature(System.String,Bentley.FeatureToggle.IFeatureToggleUser,System.String)"> <summary> Gets the value of the multivariate feature </summary> <param name="featureName"></param> <param name="user"></param> <param name="fallback">Returned if the Feature Service cannot be reached</param> <returns></returns> </member> <member name="M:Bentley.FeatureToggle.IFeatureToggleClient.Track(System.String,Bentley.FeatureToggle.IFeatureToggleUser,System.String)"> <summary> Track that a certain "Goal" was met for a given user </summary> <param name="goalName">The Goal used</param> <param name="user">The user who met the goal</param> <param name="data">any additional json data to attach to the goal's experiment</param> </member> <member name="M:Bentley.FeatureToggle.IFeatureToggleClient.DumpFlags(Bentley.FeatureToggle.IFeatureToggleUser)"> <summary> Dumps the current state of feature flags for the given user </summary> <param name="user">The user to dump for</param> </member> <member name="M:Bentley.FeatureToggle.IFeatureToggleClient.Flush"> <summary> Flush the reporting buffer back to server </summary> </member> <member name="T:Bentley.FeatureToggle.IFeatureToggleUser"> <summary> And interface to define the connection between an IMS User and any potential Third-Party system users </summary> </member> <member name="P:Bentley.FeatureToggle.IFeatureToggleUser.EmailOrName"> <summary> The User's email address or Name (name on LaunchDarkly) NOTE: This property is UpperCased before being sent to LaunchDarkly </summary> </member> <member name="P:Bentley.FeatureToggle.IFeatureToggleUser.ImsId"> <summary> The User's unique ImsId (ImsId and key on LaunchDarkly) NOTE: This property is UpperCased before being sent to LaunchDarkly </summary> </member> <member name="P:Bentley.FeatureToggle.IFeatureToggleUser.CountryISO"> <summary> The User's Country ISO (CountryIso on LaunchDarkly) NOTE: This property is UpperCased before being sent to LaunchDarkly </summary> </member> <member name="P:Bentley.FeatureToggle.IFeatureToggleUser.UltimateId"> <summary> Ultimate Id (UltimateId on LaunchDarkly) </summary> </member> <member name="P:Bentley.FeatureToggle.IFeatureToggleUser.Roles"> <summary> A list of the User's IMS Role Guids (RoleGuids on LaunchDarkly) NOTE: These properties are UpperCased before being sent to LaunchDarkly </summary> </member> <member name="T:Bentley.FeatureToggle.LaunchDarklyClient"> <summary> A LaunchDarkly implementation of the IFeatureToggleClient interface </summary> </member> <member name="F:Bentley.FeatureToggle.LaunchDarklyClient._client"> <summary> The singleton LaunchDarkly client object </summary> </member> <member name="M:Bentley.FeatureToggle.LaunchDarklyClient.#ctor(System.String,System.Int32,System.UInt16,System.Boolean,Common.Logging.ILog,System.Int32)"> <summary> Init the LdClient </summary> <param name="sdkKey">SDK Key for Launch Darkly</param> <param name="eventViewCapacity">Sets the capacity of the events buffer</param> <param name="eventQueueSecondsFrequency">Sets the number of seconds between flushes of the event buffer</param> <param name="enableStreaming">Boolean value which enables streaming</param> <param name="logger">Allows an ILog implementation to adapt the Common.Logging interface</param> <param name="pollingInterval">For non-streaming connections, sets the polling interval in seconds</param> </member> <member name="M:Bentley.FeatureToggle.LaunchDarklyClient.#ctor(System.String,System.String,System.Int32,System.UInt16,Common.Logging.ILog,System.Boolean)"> <summary> Init the LdClient using a relay to contact LD </summary> <param name="sdkKey">SDK Key for Launch Darkly</param> <param name="relayUri">Uri for a relay</param> <param name="eventViewCapacity">Sets the capacity of the events buffer</param> <param name="eventQueueSecondsFrequency">Sets the number of seconds between flushes of the event buffer</param> <param name="logger">Allows an ILog implementation to adapt the Common.Logging interface</param> <param name="enableStreaming">Boolean value which enables streaming</param> </member> <member name="M:Bentley.FeatureToggle.LaunchDarklyClient.Finalize"> <summary> Flush logs on closing </summary> </member> <member name="M:Bentley.FeatureToggle.LaunchDarklyClient.IsFeatureEnabled(System.String,Bentley.FeatureToggle.IFeatureToggleUser,System.Boolean)"> <summary> Checks if a given feature is enabled for the provided user token </summary> <param name="featureName">The feature name</param> <param name="fallback">The fallback value if the lookup cannot be completed</param> <param name="user">The user token to check for</param> <returns></returns> </member> <member name="M:Bentley.FeatureToggle.LaunchDarklyClient.GetMultivariateFeature(System.String,Bentley.FeatureToggle.IFeatureToggleUser,System.String)"> <summary> Gets the value of the multivariate feature for the supplied user </summary> <param name="featureName"></param> <param name="fallback">Returned if the Feature Service cannot be reached</param> <param name="user">A SAML Encoded IMS Token</param> <returns></returns> </member> <member name="M:Bentley.FeatureToggle.LaunchDarklyClient.Track(System.String,Bentley.FeatureToggle.IFeatureToggleUser,System.String)"> <summary> Track that a certain "Goal" was met for a given user </summary> <param name="goalName">The Goal used</param> <param name="user">The user who met the goal</param> <param name="data">any additional json data to attach to the goal's experiment</param> </member> <member name="M:Bentley.FeatureToggle.LaunchDarklyClient.DumpFlags(Bentley.FeatureToggle.IFeatureToggleUser)"> <summary> Dumps the current state of feature flags for the given user </summary> <param name="user">The user to dump for</param> </member> <member name="M:Bentley.FeatureToggle.LaunchDarklyClient.Flush"> <summary> Will flush any non-sent metric data back to LD </summary> </member> <member name="T:Bentley.FeatureToggle.LaunchDarklyUser"> <summary> A class that ties IMS user info to a LaunchDarkly.Client.User type </summary> </member> <member name="M:Bentley.FeatureToggle.LaunchDarklyUser.#ctor(Bentley.FeatureToggle.IFeatureToggleUser)"> <summary> Add a list of IMS role GUIDs and other user info to the User object </summary> </member> </members> </doc> |