blob: 7be1dd2ca4a73976fb22410355b08f9f177acaaf [file] [log] [blame]
// Copyright 2017 The Chromium Authors. All rights reserved.
// Use of this source code is governed by a BSD-style license that can be
// found in the LICENSE file.
#ifndef COMPONENTS_PAYMENTS_CORE_PAYMENT_INSTRUMENT_H_
#define COMPONENTS_PAYMENTS_CORE_PAYMENT_INSTRUMENT_H_
#include <set>
#include <string>
#include <vector>
#include "base/macros.h"
#include "base/strings/string16.h"
#include "build/build_config.h"
#include "components/autofill/core/browser/data_model/credit_card.h"
#include "ui/gfx/image/image_skia.h"
namespace payments {
// Base class which represents a form of payment in Payment Request.
class PaymentInstrument {
public:
// The type of this instrument instance.
enum class Type { AUTOFILL, NATIVE_MOBILE_APP, SERVICE_WORKER_APP };
class Delegate {
public:
virtual ~Delegate() {}
// Should be called with method name (e.g., "visa") and json-serialized
// stringified details.
virtual void OnInstrumentDetailsReady(
const std::string& method_name,
const std::string& stringified_details) = 0;
virtual void OnInstrumentDetailsError() = 0;
};
virtual ~PaymentInstrument();
// Will call into the |delegate| (can't be null) on success or error.
virtual void InvokePaymentApp(Delegate* delegate) = 0;
// Called when the payment app window has closed.
virtual void OnPaymentAppWindowClosed() {}
// Returns whether the instrument is complete to be used as a payment method
// without further editing.
virtual bool IsCompleteForPayment() const = 0;
// Returns whether the instrument is exactly matching all filters provided by
// the merchant. For example, this can return "false" for unknown card types,
// if the merchant requested only debit cards.
virtual bool IsExactlyMatchingMerchantRequest() const = 0;
// Returns a message to indicate to the user what's missing for the instrument
// to be complete for payment.
virtual base::string16 GetMissingInfoLabel() const = 0;
// Returns whether the instrument is valid for the purposes of responding to
// canMakePayment.
// TODO(crbug.com/915907): rename to IsValidForHasEnrolledInstrument.
virtual bool IsValidForCanMakePayment() const = 0;
// Records the use of this payment instrument.
virtual void RecordUse() = 0;
// Return the sub/label of payment instrument, to be displayed to the user.
virtual base::string16 GetLabel() const = 0;
virtual base::string16 GetSublabel() const = 0;
virtual gfx::ImageSkia icon_image_skia() const;
// Returns true if this payment instrument can be used to fulfill a request
// specifying |method| as supported method of payment, false otherwise. The
// parsed basic-card specific data (supported_networks, supported_types, etc)
// is relevant only for the AutofillPaymentInstrument, which runs inside of
// the browser process and thus should not be parsing untrusted JSON strings
// from the renderer.
virtual bool IsValidForModifier(
const std::string& method,
bool supported_networks_specified,
const std::set<std::string>& supported_networks,
bool supported_types_specified,
const std::set<autofill::CreditCard::CardType>& supported_types)
const = 0;
// Returns true if this payment instrument can handle payments for the given
// |payment_method_identifier|.
virtual bool IsValidForPaymentMethodIdentifier(
const std::string& payment_method_identifier) const = 0;
int icon_resource_id() const { return icon_resource_id_; }
Type type() { return type_; }
protected:
PaymentInstrument(int icon_resource_id, Type type);
private:
int icon_resource_id_;
Type type_;
DISALLOW_COPY_AND_ASSIGN(PaymentInstrument);
};
} // namespace payments
#endif // COMPONENTS_PAYMENTS_CORE_PAYMENT_INSTRUMENT_H_