docs(braintree): typo

This commit is contained in:
Daniel 2018-04-08 19:11:52 +02:00
parent 7cbe7a6287
commit 502203936c

View File

@ -1,5 +1,5 @@
import { Injectable } from '@angular/core'; import { Injectable } from '@angular/core';
import { Plugin, Cordova, IonicNativePlugin } from '@ionic-native/core'; import { Cordova, IonicNativePlugin, Plugin } from '@ionic-native/core';
/** /**
* Options for the setupApplePay method. * Options for the setupApplePay method.
@ -116,8 +116,7 @@ export interface PaymentUIResult {
/** /**
* Information about the Apple Pay card used to complete a payment (if Apple Pay was used). * Information about the Apple Pay card used to complete a payment (if Apple Pay was used).
*/ */
applePaycard: { applePaycard: {};
};
/** /**
* Information about 3D Secure card used to complete a payment (if 3D Secure was used). * Information about 3D Secure card used to complete a payment (if 3D Secure was used).
@ -140,7 +139,7 @@ export interface PaymentUIResult {
* @description * @description
* This plugin enables the use of the Braintree Drop-In Payments UI in your Ionic applications on Android and iOS, using the native Drop-In UI for each platform (not the Javascript SDK). * This plugin enables the use of the Braintree Drop-In Payments UI in your Ionic applications on Android and iOS, using the native Drop-In UI for each platform (not the Javascript SDK).
* *
* Ionic Native utilizes [a maintaned fork](https://github.com/taracque/cordova-plugin-braintree) of the original `cordova-plugin-braintree` * Ionic Native utilizes [a maintained fork](https://github.com/taracque/cordova-plugin-braintree) of the original `cordova-plugin-braintree`
* *
* For information on how to use Apple Pay with this plugin, please refer to the [plugin documentation](https://github.com/Taracque/cordova-plugin-braintree#apple-pay-ios-only) * For information on how to use Apple Pay with this plugin, please refer to the [plugin documentation](https://github.com/Taracque/cordova-plugin-braintree#apple-pay-ios-only)
* *
@ -201,23 +200,25 @@ export interface PaymentUIResult {
pluginRef: 'BraintreePlugin', pluginRef: 'BraintreePlugin',
repo: 'https://github.com/taracque/cordova-plugin-braintree', repo: 'https://github.com/taracque/cordova-plugin-braintree',
platforms: ['Android', 'iOS'], platforms: ['Android', 'iOS'],
install: 'ionic cordova plugin add https://github.com/taracque/cordova-plugin-braintree', install:
installVariables: [], 'ionic cordova plugin add https://github.com/taracque/cordova-plugin-braintree',
installVariables: []
}) })
@Injectable() @Injectable()
export class Braintree extends IonicNativePlugin { export class Braintree extends IonicNativePlugin {
/** /**
* Used to initialize the Braintree client. This function must be called before other methods can be used. * Used to initialize the Braintree client. This function must be called before other methods can be used.
* As the initialize code is async, be sure you call all Braintree related methods after the initialize promise has resolved. * As the initialize code is async, be sure you call all Braintree related methods after the initialize promise has resolved.
* *
* @param token {string} The client token or tokenization key to use with the Braintree client. * @param {string} token The client token or tokenization key to use with the Braintree client.
* @return {Promise<undefined | string>} Returns a promise that resolves with undefined on successful initialization, or rejects with a string message describing the failure. * @return {Promise<undefined | string>} Returns a promise that resolves with undefined on successful initialization, or rejects with a string message describing the failure.
*/ */
@Cordova({ @Cordova({
platforms: ['Android', 'iOS'], platforms: ['Android', 'iOS']
}) })
initialize(token: string): Promise<undefined | string> { return; } initialize(token: string): Promise<undefined | string> {
return;
}
/** /**
* Used to configure Apple Pay on iOS. * Used to configure Apple Pay on iOS.
@ -228,13 +229,15 @@ export class Braintree extends IonicNativePlugin {
* *
* Calling this function on Android is a `noop` so you can call it without having to check which cordova platform you are on! :D * Calling this function on Android is a `noop` so you can call it without having to check which cordova platform you are on! :D
* *
* @param options {ApplePayOptions} The options used to configure Apple Pay. * @param {ApplePayOptions}options The options used to configure Apple Pay.
* @return {Promise<undefined | string>} Returns a promise that resolves with undefined on successful initialization, or rejects with a string message describing the failure. * @return {Promise<undefined | string>} Returns a promise that resolves with undefined on successful initialization, or rejects with a string message describing the failure.
*/ */
@Cordova({ @Cordova({
platforms: ['iOS'], platforms: ['iOS']
}) })
setupApplePay(options: ApplePayOptions): Promise<undefined | string> { return; } setupApplePay(options: ApplePayOptions): Promise<undefined | string> {
return;
}
/** /**
* Shows Braintree's Drop-In Payments UI. * Shows Braintree's Drop-In Payments UI.
@ -244,7 +247,11 @@ export class Braintree extends IonicNativePlugin {
* @return {Promise<PaymentUIResult | string>} Returns a promise that resolves with a PaymentUIResult object on successful payment (or the user cancels), or rejects with a string message describing the failure. * @return {Promise<PaymentUIResult | string>} Returns a promise that resolves with a PaymentUIResult object on successful payment (or the user cancels), or rejects with a string message describing the failure.
*/ */
@Cordova({ @Cordova({
platforms: ['Android', 'iOS'], platforms: ['Android', 'iOS']
}) })
presentDropInPaymentUI(options?: PaymentUIOptions): Promise<PaymentUIResult | string> { return; } presentDropInPaymentUI(
options?: PaymentUIOptions
): Promise<PaymentUIResult | string> {
return;
}
} }