Rally.RestApi.Auth.ApiAuthManager.Configure C# (CSharp) Method

Configure() public static method

Configures the authorization manger.
public static Configure ( string loginWindowTitle = null, string loginWindowHeaderLabelText = null, string loginWindowCredentialsTabText = null, string loginWindowUserNameLabelText = null, string loginWindowPwdLabelText = null, string loginWindowServerTabText = null, string loginWindowConnectionTypeText = null, string loginWindowServerLabelText = null, string loginWindowTrustAllCertificatesText = null, Uri loginWindowDefaultServer = null, string loginWindowProxyServerTabText = null, string loginWindowProxyServerLabelText = null, string loginWindowProxyUserNameLabelText = null, string loginWindowProxyPwdLabelText = null, Uri loginWindowDefaultProxyServer = null, string loginWindowSsoInProgressText = null, string loginWindowLoginButtonText = null, string loginWindowLogoutButtonText = null, string loginWindowCancelButtonText = null, string loginFailureBadServer = null, string loginFailureCredentials = null, string loginFailureLoginEmpty = null, string loginFailureServerEmpty = null, string loginFailureProxyCredentials = null, string loginFailureBadConnection = null, string loginFailureUnknown = null ) : void
loginWindowTitle string The title to be used for the login window.
loginWindowHeaderLabelText string The header title to be used for the login window.
loginWindowCredentialsTabText string The credentials tab text to be used for the login window.
loginWindowUserNameLabelText string The user name label to be used for the login window.
loginWindowPwdLabelText string The password label to be used for the login window.
loginWindowServerTabText string The server tab label to be used for the login window.
loginWindowConnectionTypeText string The connection type label to be used for the login window.
loginWindowServerLabelText string The server label to be used for the login window.
loginWindowTrustAllCertificatesText string The trust all certificates label to be used for the login window.
loginWindowDefaultServer System.Uri The default server to be used for the login window.
loginWindowProxyServerTabText string The proxy tab label to be used for the login window.
loginWindowProxyServerLabelText string The proxy server label to be used for the login window.
loginWindowProxyUserNameLabelText string The proxy user name label to be used for the login window.
loginWindowProxyPwdLabelText string The proxy password label to be used for the login window.
loginWindowDefaultProxyServer System.Uri The default proxy server to be used for the login window.
loginWindowSsoInProgressText string The SSO in progress label to be used for the login window.
loginWindowLoginButtonText string The login button text to be used for the login window.
loginWindowLogoutButtonText string The logout button text to be used for the login window.
loginWindowCancelButtonText string The cancel button text to be used for the login window.
loginFailureBadServer string The error message to be used for when the server is bad (can't connect).
loginFailureCredentials string The error message to be used for when the credentials to Rally are bad.
loginFailureLoginEmpty string The error message to be used for when the login input field is left empty.
loginFailureServerEmpty string The error message to be used for when the server input field is left empty.
loginFailureProxyCredentials string The error message to be used for bad proxy credentials.
loginFailureBadConnection string The error message to be used for bad connection login failures.
loginFailureUnknown string The error message to be used for unknown login failures.
return void
		public static void Configure(string loginWindowTitle = null,
			string loginWindowHeaderLabelText = null,
			string loginWindowCredentialsTabText = null,
			string loginWindowUserNameLabelText = null, string loginWindowPwdLabelText = null,
			string loginWindowServerTabText = null, string loginWindowConnectionTypeText = null,
			string loginWindowServerLabelText = null, string loginWindowTrustAllCertificatesText = null,
			Uri loginWindowDefaultServer = null,
			string loginWindowProxyServerTabText = null,
			string loginWindowProxyServerLabelText = null, string loginWindowProxyUserNameLabelText = null,
			string loginWindowProxyPwdLabelText = null, Uri loginWindowDefaultProxyServer = null,
			string loginWindowSsoInProgressText = null,
			string loginWindowLoginButtonText = null, string loginWindowLogoutButtonText = null,
			string loginWindowCancelButtonText = null,
			string loginFailureBadServer = null,
			string loginFailureCredentials = null,
			string loginFailureLoginEmpty = null,
			string loginFailureServerEmpty = null,
			string loginFailureProxyCredentials = null,
			string loginFailureBadConnection = null,
			string loginFailureUnknown = null)
		{
			LoginWindowTitle = loginWindowTitle;
			if (String.IsNullOrWhiteSpace(LoginWindowTitle))
				LoginWindowTitle = "Login to CA Agile Central";

			LoginWindowHeaderLabelText = loginWindowHeaderLabelText;
			if (String.IsNullOrWhiteSpace(LoginWindowHeaderLabelText))
				LoginWindowHeaderLabelText = "Login to CA Agile Central";

			LoginWindowDefaultServer = loginWindowDefaultServer;
			if (LoginWindowDefaultServer == null)
				LoginWindowDefaultServer = new Uri(RallyRestApi.DEFAULT_SERVER);
			LoginWindowDefaultProxyServer = loginWindowDefaultProxyServer;

			#region Default Strings: Credentials
			LoginWindowCredentialsTabText = loginWindowCredentialsTabText;
			if (String.IsNullOrWhiteSpace(LoginWindowCredentialsTabText))
				LoginWindowCredentialsTabText = "Credentials";

			LoginWindowUserNameLabelText = loginWindowUserNameLabelText;
			if (String.IsNullOrWhiteSpace(LoginWindowUserNameLabelText))
				LoginWindowUserNameLabelText = "User Name";

			LoginWindowPwdLabelText = loginWindowPwdLabelText;
			if (String.IsNullOrWhiteSpace(LoginWindowPwdLabelText))
				LoginWindowPwdLabelText = "Password";
			#endregion

			#region Default Strings: Rally
			LoginWindowConnectionTypeText = loginWindowConnectionTypeText;
			if (String.IsNullOrWhiteSpace(LoginWindowConnectionTypeText))
				LoginWindowConnectionTypeText = "Connection Type";

			LoginWindowRallyServerTabText = loginWindowServerTabText;
			if (String.IsNullOrWhiteSpace(LoginWindowRallyServerTabText))
				LoginWindowRallyServerTabText = "CA Agile Central";

			LoginWindowServerLabelText = loginWindowServerLabelText;
			if (String.IsNullOrWhiteSpace(LoginWindowServerLabelText))
				LoginWindowServerLabelText = "Server";

			LoginWindowTrustAllCertificatesText = loginWindowTrustAllCertificatesText;
			if (String.IsNullOrWhiteSpace(LoginWindowTrustAllCertificatesText))
				LoginWindowTrustAllCertificatesText = "Trust all certificates";
			#endregion

			#region Default Strings: Proxy
			LoginWindowProxyServerTabText = loginWindowProxyServerTabText;
			if (String.IsNullOrWhiteSpace(LoginWindowProxyServerTabText))
				LoginWindowProxyServerTabText = "Proxy";

			LoginWindowProxyServerLabelText = loginWindowProxyServerLabelText;
			if (String.IsNullOrWhiteSpace(LoginWindowProxyServerLabelText))
				LoginWindowProxyServerLabelText = "Server";

			LoginWindowProxyUserNameLabelText = loginWindowProxyUserNameLabelText;
			if (String.IsNullOrWhiteSpace(LoginWindowProxyUserNameLabelText))
				LoginWindowProxyUserNameLabelText = "User Name";

			LoginWindowProxyPwdLabelText = loginWindowProxyPwdLabelText;
			if (String.IsNullOrWhiteSpace(LoginWindowProxyPwdLabelText))
				LoginWindowProxyPwdLabelText = "Password";
			#endregion

			#region Default Strings: Buttons
			LoginWindowSsoInProgressText = loginWindowSsoInProgressText;
			if (String.IsNullOrWhiteSpace(LoginWindowSsoInProgressText))
				LoginWindowSsoInProgressText = "SSO in Progress";

			LoginWindowLoginText = loginWindowLoginButtonText;
			if (String.IsNullOrWhiteSpace(LoginWindowLoginText))
				LoginWindowLoginText = "Login";

			LoginWindowLogoutText = loginWindowLogoutButtonText;
			if (String.IsNullOrWhiteSpace(LoginWindowLogoutText))
				LoginWindowLogoutText = "Logout";

			LoginWindowCancelText = loginWindowCancelButtonText;
			if (String.IsNullOrWhiteSpace(LoginWindowCancelText))
				LoginWindowCancelText = "Cancel";
			#endregion

			#region Default Strings: Error Messages
			LoginFailureBadServer = loginFailureBadServer;
			if (String.IsNullOrWhiteSpace(LoginFailureBadServer))
				LoginFailureBadServer = "Bad Server or Network Issues";

			LoginFailureProxyCredentials = loginFailureProxyCredentials;
			if (String.IsNullOrWhiteSpace(LoginFailureProxyCredentials))
				LoginFailureProxyCredentials = "Bad Proxy Credentials";

			LoginFailureCredentials = loginFailureCredentials;
			if (String.IsNullOrWhiteSpace(LoginFailureCredentials))
				LoginFailureCredentials = "Bad Credentials";

			LoginFailureLoginEmpty = loginFailureLoginEmpty;
			if (String.IsNullOrWhiteSpace(LoginFailureLoginEmpty))
				LoginFailureLoginEmpty = "Username is a required field.";

			LoginFailureServerEmpty = loginFailureServerEmpty;
			if (String.IsNullOrWhiteSpace(LoginFailureServerEmpty))
				LoginFailureServerEmpty = "CA Agile Central Server is a required field.";

			LoginFailureBadConnection = loginFailureBadConnection;
			if (String.IsNullOrWhiteSpace(LoginFailureBadConnection))
				LoginFailureBadConnection = "Failed to connect to the CA Agile Central server or proxy.";

			LoginFailureUnknown = loginFailureUnknown;
			if (String.IsNullOrWhiteSpace(LoginFailureUnknown))
				LoginFailureUnknown = "An unknown error occurred while attempting to log in. Please try again.";
			#endregion
		}
		#endregion