Logo
Developer SDK
Version 1.9.632.913d652c-152450467.
MerchantManager Class Referenceabstract

Public Member Functions

abstract Employee parseEmployeeFromIntent (Intent intent)
 
abstract void requestAuthenticationForAction (Context context, AuthenticationMethods[] allowedAuthenticationMethods, PendingIntent intent)
 
abstract void requestPermissionForAction (Context context, Employee.Roles[] roles, AuthenticationMethods[] allowedAuthenticationMethods, PendingIntent intent)
 

Static Public Member Functions

static MerchantManager getMerchantManager (Context context)
 

Static Public Attributes

static final String ACTION_EMPLOYEE_LOGGED_IN = "com.verifone.commerce.content.intent.action.EMPLOYEE_LOGGED_IN"
 
static final String ACTION_EMPLOYEE_LOGGED_OUT = "com.verifone.commerce.content.intent.action.EMPLOYEE_LOGGED_OUT"
 
static final String EXTRA_EMPLOYEE_ID = "com.verifone.commerce.content.intent.extra.EMPLOYEE_ID"
 
static final String EXTRA_EMPLOYEE_NAME = "com.verifone.commerce.content.intent.extra.EMPLOYEE_NAME"
 
static final String EXTRA_EMPLOYEE_DISPLAY_NAME = "com.verifone.commerce.content.intent.extra.EMPLOYEE_DISPLAY_NAME"
 
static final String EXTRA_EMPLOYEE_ROLES = "com.verifone.commerce.content.intent.extra.EMPLOYEE_ROLES"
 
static final String EXTRA_EMPLOYEE_EMAIL = "com.verifone.commerce.content.intent.extra.EMPLOYEE_EMAIL"
 

Detailed Description

The service handle to enable merchant / employee actions, particularly, privilege escalations.

Definition at line 12 of file MerchantManager.java.

Member Function Documentation

◆ getMerchantManager()

static MerchantManager getMerchantManager ( Context  context)
static

A convenience method to fetch a concrete implementation of the Employee Manager.

Returns
The concrete implementation of the MerchantManager.

Definition at line 59 of file MerchantManager.java.

◆ parseEmployeeFromIntent()

abstract Employee parseEmployeeFromIntent ( Intent  intent)
abstract

A helper method to return the employee parsed from the intent when requesting permission for an action.

◆ requestAuthenticationForAction()

abstract void requestAuthenticationForAction ( Context  context,
AuthenticationMethods []  allowedAuthenticationMethods,
PendingIntent  intent 
)
abstract

Requests authorization from the current user. This is useful if it has been a certain amount of time since the user was last required to login, and appropriately updates the

getLastLoggedInTime

value. This will require another application to present the necessary UI to the user, and the requesting application should be prepared to enter the pause/stop state.

Parameters
allowedAuthenticationMethodsAllows the authentication methods to be limited. Setting to EMAIL_WITH_PASSWORD may narrow the employees able to authorize the action, and should be used carefully.
intentA pending intent, called by the service after authenticating the user. This intent should be explicit, containing the appropriate component name for the class receiving the information. After authentication, the service adds the extras as described above to the intent.

◆ requestPermissionForAction()

abstract void requestPermissionForAction ( Context  context,
Employee.Roles []  roles,
AuthenticationMethods []  allowedAuthenticationMethods,
PendingIntent  intent 
)
abstract

Enables the application to require authorization from an employee with a specific role for a specific action. If the current employee has one of the provided roles, this behaves as if calling

. This will require another application to present the necessary UI to the user, and the requesting application should be prepared to enter the pause/stop state.

Parameters
rolesThe role(s) necessary to appropriately authorize the action.
allowedAuthenticationMethodsAllows the authentication methods to be limited. Setting to EMAIL_WITH_PASSWORD may narrow the employees able to authorize the action, and should be used carefully.
intentA pending intent, called by the service after authenticating the user. This intent should be explicit, containing the appropriate component name for the class receiving the information. After authentication, the service adds the extras as described above to the intent.

Member Data Documentation

◆ ACTION_EMPLOYEE_LOGGED_IN

final String ACTION_EMPLOYEE_LOGGED_IN = "com.verifone.commerce.content.intent.action.EMPLOYEE_LOGGED_IN"
static

The intent action that can be received when an employee logs in to the device.

Definition at line 23 of file MerchantManager.java.

◆ ACTION_EMPLOYEE_LOGGED_OUT

final String ACTION_EMPLOYEE_LOGGED_OUT = "com.verifone.commerce.content.intent.action.EMPLOYEE_LOGGED_OUT"
static

The intent action that can be received when an employee logs out of the device.

Definition at line 28 of file MerchantManager.java.

◆ EXTRA_EMPLOYEE_DISPLAY_NAME

final String EXTRA_EMPLOYEE_DISPLAY_NAME = "com.verifone.commerce.content.intent.extra.EMPLOYEE_DISPLAY_NAME"
static

The intent extra to retrieve the employee's display name.

Definition at line 43 of file MerchantManager.java.

◆ EXTRA_EMPLOYEE_EMAIL

final String EXTRA_EMPLOYEE_EMAIL = "com.verifone.commerce.content.intent.extra.EMPLOYEE_EMAIL"
static

The intent extra to retrieve the employee's email, if used for authentication.

Definition at line 53 of file MerchantManager.java.

◆ EXTRA_EMPLOYEE_ID

final String EXTRA_EMPLOYEE_ID = "com.verifone.commerce.content.intent.extra.EMPLOYEE_ID"
static

The intent extra to retrieve the employee's ID.

Definition at line 33 of file MerchantManager.java.

◆ EXTRA_EMPLOYEE_NAME

final String EXTRA_EMPLOYEE_NAME = "com.verifone.commerce.content.intent.extra.EMPLOYEE_NAME"
static

The intent extra to retrieve the employee's full name.

Definition at line 38 of file MerchantManager.java.

◆ EXTRA_EMPLOYEE_ROLES

final String EXTRA_EMPLOYEE_ROLES = "com.verifone.commerce.content.intent.extra.EMPLOYEE_ROLES"
static

The intent extra to retrieve the employee's role that qualified them for the action. The employee may have multiple roles that qualify them, this only returns one of them.

Definition at line 48 of file MerchantManager.java.


The documentation for this class was generated from the following file:

This document is the confidential property of Verifone, Inc. Any reproduction or distribution of this document, in whole or in part, or the disclosure of any of the information contained herein, without the prior written consent of Verifone, Inc. is prohibited. This document and any supplemental material supplied as part of any review must be returned to Verifone, Inc. upon request. Notice: This document may go through material revisions over time. While the Company will make every effort to keep readers updated as changes occur, care must be taken by the reader to make sure they are reading the latest version. Version numbers appear in the title page and revision history page of this document. All rights reserved. Verifone, the Verifone logo are either trademarks or registered trademarks of Verifone in the United States and/or other countries. All other trademarks or brand names are properties of their respective holders.