Web API

NavigatorResponse extends Response

Other API in Package

User

Internal Tunnel

Internal Web

Tunnel

Method Summary
  accessTransaction(Pin pin, String action)

Routes the user to Navigator and provides access to the Transaction associated with the Pin. Depending on the type of PIN, this will either require authentication by the user or direct access to Navigator without authentication.

  accessTransaction(String txId, String action)

Routes the user to Navigator and provides access to the specified Transaction. Requires authentication by that user and authorization to be handled by the transaction.

  accessTransaction(String txId, String action, String email)

Routes the user to Navigator and provides access to the specified Transaction. Requires authentication by that user and authorization to be handled by the application (meaning the user must have a role on the transaction).

boolean allowAnonymousTransactionAccess()

Over-rides the default Transaction security which is to require users to have a role on existing transactions. If you call this method, you must handle authorization in the Transaction workflow. The application will still require authentication and restrict access to the account identified by email.

  createNewTransaction()

Routes the user to Navigator and creates a new Transaction. Requires authentication by that user. This method is the equivalent of having a public tokenized link.

  createNewTransaction(String email)

Routes the user to Navigator and creates a new Transaction. Requires authentication by that user.

  createOrGetFirstTransaction(String action)

Routes the user to Navigator and provides access to the first transaction the user has active role in. New transaction created in case the user has no transactions.

  createOrGetLastTransaction(String action)

Routes the user to Navigator and provides access to the last transaction the user has active role in. New transaction created in case the user has no transactions.

Data getData()

Returns the Data object for this response.

  requireEmail(String email)

If the user will be creating a new account, this method requires that the account use this email address.

  setCancelUrl(String url)

Specifies the url the user should be taken to if unable to log in. If this is set, a cancel button will be shown on the login screen.

boolean setHeadless(boolean runHeadless)

If set to true, the transaction pal application will run without the standard navigator desktop.

boolean setLoginPage(String loginPage)

Sets the login page for this response. The loginPage must be of type login. Pass null to use the default system login page.

  setNewUserEmailValidation(boolean validate)

This method applies only to new users who will create an account as part of accessing the transaction. This is true by default.

  showCreateAccount(boolean show)

Show or hide the create account button. Default is true (show).

  showLogin(boolean show)

Show or hide the create login button. Default is true (show). If false, showCreateAccount(true) should be called.

String toString()

Returns a description of this object.

Method Detail


accessTransaction(Pin pin, String action)

Routes the user to Navigator and provides access to the Transaction associated with the Pin. Depending on the type of PIN, this will either require authentication by the user or direct access to Navigator without authentication.

Parameters:

  • Pin   pin Required parameter.
  • String   action Required parameter.

Since: 05-15-2014

top

accessTransaction(String txId, String action)

Routes the user to Navigator and provides access to the specified Transaction. Requires authentication by that user and authorization to be handled by the transaction.

Parameters:

  • String   txId Required parameter.
  • String   action Required parameter.

Since: 05-15-2014

top

accessTransaction(String txId, String action, String email)

Routes the user to Navigator and provides access to the specified Transaction. Requires authentication by that user and authorization to be handled by the application (meaning the user must have a role on the transaction).

Parameters:

  • String   txId Required parameter.
  • String   action Required parameter.
  • String   email Required parameter.

Since: 05-15-2014

top

boolean allowAnonymousTransactionAccess()

Over-rides the default Transaction security which is to require users to have a role on existing transactions. If you call this method, you must handle authorization in the Transaction workflow. The application will still require authentication and restrict access to the account identified by email.

Returns:  boolean

Since: 08-22-2008

top

createNewTransaction()

Routes the user to Navigator and creates a new Transaction. Requires authentication by that user. This method is the equivalent of having a public tokenized link.

Since: 05-15-2014

top

createNewTransaction(String email)

Routes the user to Navigator and creates a new Transaction. Requires authentication by that user.

Parameters:

  • String   email Required parameter.

Since: 05-15-2014

top

createOrGetFirstTransaction(String action)

Routes the user to Navigator and provides access to the first transaction the user has active role in. New transaction created in case the user has no transactions.

Parameters:

  • String   action Required parameter.

Since: 05-15-2014

top

createOrGetLastTransaction(String action)

Routes the user to Navigator and provides access to the last transaction the user has active role in. New transaction created in case the user has no transactions.

Parameters:

  • String   action Required parameter.

Since: 05-15-2014

top

Data getData()

Returns the Data object for this response.

Returns:  Data

Since: 02-22-2013

top

requireEmail(String email)

If the user will be creating a new account, this method requires that the account use this email address.

Parameters:

  • String   email

Since: 01-15-2010

top

setCancelUrl(String url)

Specifies the url the user should be taken to if unable to log in. If this is set, a cancel button will be shown on the login screen.

Parameters:

  • String   url

Since: 05-14-2009

top

boolean setHeadless(boolean runHeadless)

If set to true, the transaction pal application will run without the standard navigator desktop.

Parameters:

  • boolean   runHeadless Required parameter.

Returns:  boolean

Since: 01-11-2011

top

boolean setLoginPage(String loginPage)

Sets the login page for this response. The loginPage must be of type login. Pass null to use the default system login page.

Parameters:

  • String   loginPage

Returns:  boolean

Since: 11-01-2010

top

setNewUserEmailValidation(boolean validate)

This method applies only to new users who will create an account as part of accessing the transaction. This is true by default.

Parameters:

  • boolean   validate

Since: 12-03-2009

top

showCreateAccount(boolean show)

Show or hide the create account button. Default is true (show).

Parameters:

  • boolean   show

Since: 01-13-2010

top

showLogin(boolean show)

Show or hide the create login button. Default is true (show). If false, showCreateAccount(true) should be called.

Parameters:

  • boolean   show Required parameter.

Since: 07-05-2017

top

String toString()

Returns a description of this object.

Returns:  String

Since: 08-22-2008

top
Copyright © 2006 - 2024, ContractPal, Inc. All rights reserved. API Date: Dec 03, 2024 10:24 AM