References

Class Summary

Static Public Class Summary
public	App class responsible for creating the first-rendered React component
public	InputBox Generic component for an input box.
public	Logo
public	PasswordBox Renders a password box with masked input characters.
public	Reducer Implements a registry for adding reducers, allowing them to be combined into a single reducing function.
public	SignInButton Constructs and renders a button enabling the user to sign in
public	SignInSpinner
public	SignUpButton
public	UserNameBox Renders a username box

Function Summary

Static Public Function Summary
public	auth_failure(message: string): {type: string, message: *} Create an action stating that the authentication failed
public	auth_failure_reducer(state: , action: ): *
public	auth_started(username: , password: ): *
public	auth_started_reducer(state: Object, action: Object): * Process the asynchronous action indicating that authentication has started.
public	auth_success(token: str, expiration_date: str): * Action creator for the "AUTH_SUCCESS" action.
public	auth_success_reducer(state: , action: ): * Clean up the authenticator, create and add an authorization header to the omicron_api headers,
public	authenticate_user(): function Dispatch a thunk to authenticate the user given a username and password
public	cloneObject(obj: ): Created by Michal on 2016-02-11.
public	fetch_data(): Function Thunk action to fetch the data from the URL.
public	get_data_from_url(url: ):
public	get_data_from_url_reducer(state: , action: ): *
public	logout(): *
public	map_dispatch_to_props(dispatch: ):
public	map_header_state_to_props(state: Object): {buttons: string} Takes the current application state, and returns an object containing the buttons to render in the menu bar
public	map_logout_state_to_props(state: ):
public	map_state_to_props(state: Object): {http_test_result: initial_state.http_test.reactjs.data\|{}, url_value: *} Takes in the current application state, and returns an object with the required properties to render the HTTP Request form.
public	password_change_reducer(state: , action: ): *
public	receive_data_from_url(url: , received_json: ): *
public	receive_data_from_url_reducer(state: , action: ): *
public	run_test(): {type: string} Create the test action
public	run_test_reducer(state: Object, action: Object): Object Toggle the fetching flag to "true"
public	submit_reducer(state: , action: ): *
public	url_changed(new_url: ): {type: string, new_url: } Action creator for the URL_CHANGED action
public	url_changed_reducer(state: Object, action: Object): Object If the action is of the "URL_CHANGED" type, copies the current application state, alters the url to be the new url, and returns the new state
public	username_change_reducer(state: , action: ): *

Variable Summary

Static Public Variable Summary
public	AUTH_FAILURE: string
public	AUTH_STARTED: string Inform the UI that the asynchronous authentication procedure has started
public	AUTH_SUCCESS: string Action that is thrown last, indicating that the authentication request completed successfully
public	Footer: *
public	GET_DATA_FROM_URL: string Now that it's time to get a request, we dispatch the request action. A separate action is done for this, in order to decouple the UI's "RUN_TEST" action from the actual request.
public	HTTPTest: * Connect the HTTP template and the template's mappers to the application state, and export it.
public	HTTPTestTemplate(on_url_change: function, on_button_click: function, http_test_result: Object, url_value: string): * Template for running the asynchronous HTTP request test.
public	Header: *
public	HeaderBar: * Connect the header bar to the store using the state mapper and export it
public	HeaderNavBar: *
public	HelloBox: *
public	LoginBox: *
public	LoginButton: *
public	LoginForm(on_username_change: function, on_password_change: function, uname_value: string, password_value: string, on_submit: function, is_spinner_visible:: bool): XML: * Builds the Login Form component
public	LogoutButton: *
public	LogoutButtonTemplate: *
public	PasswordBox: *
public	RECEIVE_DATA_FROM_URL: string This action is called when the request is recieved by the UX.
public	RUN_TEST: string Toggle the fetching flag on the front end, in order to let the UI know that the appropriate loading graphics (i.e.
public	ResultsBox: *
public	URLEntryForm: *
public	URL_CHANGED: string Action signifying that the URL entered into the URL Test input box has changed.
public	UsernameBox: *
public	mapLoginDispatchToProps: *
public	mapLoginStateToProps(state: Object): Object: * Maps the application state to the required props in the LoginForm component.
public	map_dispatch_to_props(dispatch: function): * Maps the required action creators to the callback properties required to render the HTTP Request form
public	reducer: Reducer