C# Class Rock.CheckIn.CheckInBlock

Inheritance: Rock.Web.UI.RockBlock

Mostrar archivo Open project: NewSpring/Rock

Protected Properties

Property	Type	Description
CurrentCheckInState	CheckInState
CurrentGroupTypeIds	List
CurrentWorkflow	Rock.Model.Workflow

Public Methods

Method	Description
RequiresSelection ( bool backingUp ) : bool	Determines if the block requires that a selection be made. This is used to determine if user should be redirected to this block or not.

Protected Methods

Method	Description
CancelCheckin ( ) : void	Cancels the check-in.
CheckForOverride ( string>.Dictionary queryParams = null ) : string>.Dictionary	Checks if the override option is currently being used.
GetCheckInBlock ( string attributeKey ) : CheckInBlock	Loads a check-in block to determine if it will require a selection or not. This is used to find the next page/block that does require a selection so that user can be redirected once to that block, rather than just continuesly redirected to next/prev page blocks and possibly exceeding the maximum number of redirects.
GetGroupTypesLocations ( RockContext rockContext ) : IEnumerable	Returns the locations for this Kiosk for the configured group types
GetPersonScheduleSubTitle ( ) : string	Gets the person schedule sub title.
GoBack ( ) : void	Do nothing (such as unselecting something) but simply return to previous screen.
GoBack ( bool validateSelectionRequired ) : void	Goes the back.
NavigateToHomePage ( ) : void	Navigates to the check-in home page.
NavigateToNextPage ( ) : void	Navigates to next page.
NavigateToNextPage ( string>.Dictionary queryParams ) : void	Navigates to next page.
NavigateToNextPage ( string>.Dictionary queryParams, bool validateSelectionRequired ) : void	Navigates to next page.
NavigateToNextPage ( bool validateSelectionRequired ) : void	Navigates to next page.
NavigateToPreviousPage ( ) : void	Navigates to previous page.
NavigateToPreviousPage ( string>.Dictionary queryParams ) : void	Navigates to previous page.
NavigateToPreviousPage ( string>.Dictionary queryParams, bool validateSelectionRequired ) : void	Navigates to previous page.
NavigateToPreviousPage ( bool validateSelectionRequired ) : void	Navigates to previous page.
OnInit ( EventArgs e ) : void	Raises the E:System.Web.UI.Control.Init event.
ProcessActivity ( string activityName, List &errorMessages ) : bool	Activates and processes a workflow activity. If the workflow has not yet been activated, it will also be activated
ProcessSelection ( Rock modalAlert ) : List	Processes the selection, save state and navigates to the next page if no errors are encountered during processing the activity.
ProcessSelection ( Rock modalAlert, bool validateSelectionRequired ) : List	Processes the selection, save state and navigates to the next page if no errors are encountered during processing the activity.
ProcessSelection ( Rock modalAlert, Func doNotProceedCondition, string conditionMessage ) : bool	Processes the selection, save state and navigates to the next page if no errors are encountered during processing the activity.
ProcessSelection ( Rock modalAlert, Func doNotProceedCondition, string conditionMessage, bool validateSelectionRequired ) : bool	Processes the selection, save state and navigates to the next page if no errors are encountered during processing the activity.
SaveState ( ) : void	Saves the current state of the kiosk and workflow

Private Methods

Method	Description
GetState ( ) : void	Gets the state.

Method Details

CancelCheckin() protected method

Cancels the check-in.

protected CancelCheckin ( ) : void
return	void

CheckForOverride() protected method

Checks if the override option is currently being used.

protected CheckForOverride ( string>.Dictionary queryParams = null ) : string>.Dictionary
queryParams	string>.Dictionary	The query parameters.
return	string>.Dictionary

GetCheckInBlock() protected method

Loads a check-in block to determine if it will require a selection or not. This is used to find the next page/block that does require a selection so that user can be redirected once to that block, rather than just continuesly redirected to next/prev page blocks and possibly exceeding the maximum number of redirects.

protected GetCheckInBlock ( string attributeKey ) : CheckInBlock
attributeKey	string	The attribute key.
return	CheckInBlock

GetGroupTypesLocations() protected method

Returns the locations for this Kiosk for the configured group types

protected GetGroupTypesLocations ( RockContext rockContext ) : IEnumerable
rockContext	RockContext
return	IEnumerable

GetPersonScheduleSubTitle() protected method

Gets the person schedule sub title.

protected GetPersonScheduleSubTitle ( ) : string
return	string

GoBack() protected method

Do nothing (such as unselecting something) but simply return to previous screen.

protected GoBack ( ) : void
return	void

GoBack() protected method

Goes the back.

protected GoBack ( bool validateSelectionRequired ) : void
validateSelectionRequired	bool	if set to true will check that block on prev page has a selection required before redirecting.
return	void

NavigateToHomePage() protected method

Navigates to the check-in home page.

protected NavigateToHomePage ( ) : void
return	void

NavigateToNextPage() protected method

Navigates to next page.

protected NavigateToNextPage ( ) : void
return	void

NavigateToNextPage() protected method

Navigates to next page.

protected NavigateToNextPage ( string>.Dictionary queryParams ) : void
queryParams	string>.Dictionary	The query parameters.
return	void

NavigateToNextPage() protected method

Navigates to next page.

protected NavigateToNextPage ( string>.Dictionary queryParams, bool validateSelectionRequired ) : void
queryParams	string>.Dictionary	The query parameters.
validateSelectionRequired	bool	if set to true will check that block on next page has a selection required before redirecting.
return	void

NavigateToNextPage() protected method

Navigates to next page.

protected NavigateToNextPage ( bool validateSelectionRequired ) : void
validateSelectionRequired	bool	if set to true will check that block on next page has a selection required before redirecting.
return	void

NavigateToPreviousPage() protected method

Navigates to previous page.

protected NavigateToPreviousPage ( ) : void
return	void

NavigateToPreviousPage() protected method

Navigates to previous page.

protected NavigateToPreviousPage ( string>.Dictionary queryParams ) : void
queryParams	string>.Dictionary	The query parameters.
return	void

NavigateToPreviousPage() protected method

Navigates to previous page.

protected NavigateToPreviousPage ( string>.Dictionary queryParams, bool validateSelectionRequired ) : void
queryParams	string>.Dictionary	The query parameters.
validateSelectionRequired	bool	if set to true will check that block on previous page has a selection required before redirecting.
return	void

NavigateToPreviousPage() protected method

Navigates to previous page.

protected NavigateToPreviousPage ( bool validateSelectionRequired ) : void
validateSelectionRequired	bool	if set to true will check that block on previous page has a selection required before redirecting.
return	void

OnInit() protected method

Raises the E:System.Web.UI.Control.Init event.

protected OnInit ( EventArgs e ) : void
e	System.EventArgs	An object that contains the event data.
return	void

ProcessActivity() protected method

Activates and processes a workflow activity. If the workflow has not yet been activated, it will also be activated

protected ProcessActivity ( string activityName, List &errorMessages ) : bool
activityName	string	Name of the activity.
errorMessages	List	The error messages.
return	bool

ProcessSelection() protected method

Processes the selection, save state and navigates to the next page if no errors are encountered during processing the activity.

protected ProcessSelection ( Rock modalAlert ) : List
modalAlert	Rock	The modal alert control to show if errors occur.
return	List

ProcessSelection() protected method

Processes the selection, save state and navigates to the next page if no errors are encountered during processing the activity.

protected ProcessSelection ( Rock modalAlert, bool validateSelectionRequired ) : List
modalAlert	Rock	The modal alert control to show if errors occur.
validateSelectionRequired	bool	if set to true will check that block on next page has a selection required before redirecting.
return	List

ProcessSelection() protected method

Processes the selection, save state and navigates to the next page if no errors are encountered during processing the activity.

protected ProcessSelection ( Rock modalAlert, Func doNotProceedCondition, string conditionMessage ) : bool
modalAlert	Rock	The modal alert control to show if errors occur.
doNotProceedCondition	Func	A condition that must be met after processing /// the activity in order to save state and continue to the next page.
conditionMessage	string	The message to display in the modal if the condition fails.
return	bool

ProcessSelection() protected method

Processes the selection, save state and navigates to the next page if no errors are encountered during processing the activity.

protected ProcessSelection ( Rock modalAlert, Func doNotProceedCondition, string conditionMessage, bool validateSelectionRequired ) : bool
modalAlert	Rock	The modal alert control to show if errors occur.
doNotProceedCondition	Func	A condition that must be met after processing /// the activity in order to save state and continue to the next page.
conditionMessage	string	The message to display in the modal if the condition fails.
validateSelectionRequired	bool	if set to true will check that block on next page has a selection required before redirecting.
return	bool

RequiresSelection() public method

Determines if the block requires that a selection be made. This is used to determine if user should be redirected to this block or not.

public RequiresSelection ( bool backingUp ) : bool
backingUp	bool	if set to true [backing up].
return	bool

SaveState() protected method

Saves the current state of the kiosk and workflow

protected SaveState ( ) : void
return	void

Property Details

CurrentCheckInState protected_oe property

The current check-in state

protected CheckInState,Rock.CheckIn CurrentCheckInState
return	CheckInState

CurrentGroupTypeIds protected_oe property

The current group type ids

protected List CurrentGroupTypeIds
return	List

CurrentWorkflow protected_oe property

The current workflow

protected Workflow,Rock.Model CurrentWorkflow
return	Rock.Model.Workflow