Options
All
  • Public
  • Public/Protected
  • All
Menu

Module "src/CardForm"

Index

Type aliases

CardFormOption

CardFormOption: { cardFormType?: CardFormType; tenantId?: undefined | string }

カードフォームのオプション

Type declaration

CardFormType

CardFormType: "multiLine" | "cardDisplay"

カードフォームの表示タイプ

IOSCardFormStyle

IOSCardFormStyle: { errorTextColor?: ColorValue; highlightColor?: ColorValue; inputFieldBackgroundColor?: ColorValue; inputTextColor?: ColorValue; labelTextColor?: ColorValue; submitButtonColor?: ColorValue; tintColor?: ColorValue }

カードフォームスタイル(iOS用)

Type declaration

  • Optional errorTextColor?: ColorValue
  • Optional highlightColor?: ColorValue
  • Optional inputFieldBackgroundColor?: ColorValue
  • Optional inputTextColor?: ColorValue
  • Optional labelTextColor?: ColorValue
  • Optional submitButtonColor?: ColorValue
  • Optional tintColor?: ColorValue

OnCardFormCanceled

OnCardFormCanceled: () => void

カードフォームがキャンセルされたときに実行されるリスナー

Type declaration

    • (): void
    • Returns void

OnCardFormCompleted

OnCardFormCompleted: () => void

カードフォームが完了したときに実行されるリスナー

Type declaration

    • (): void
    • Returns void

OnCardFormProducedToken

OnCardFormProducedToken: (token: Token) => void

カードフォームでトークンが生成されたときに実行されるリスナー

param

PAY.JPトークン

Type declaration

    • Parameters

      Returns void

Variables

RNPAYCardForm

RNPAYCardForm: any

Const cardFormEventEmitter

cardFormEventEmitter: NativeEventEmitter = new NativeEventEmitter(RNPAYCardForm)

Const onCardFormCanceledSet

onCardFormCanceledSet: Set<OnCardFormCanceled> = new Set()

Const onCardFormCompletedSet

onCardFormCompletedSet: Set<OnCardFormCompleted> = new Set()

Const onCardFormProducedTokenSet

onCardFormProducedTokenSet: Set<OnCardFormProducedToken> = new Set()

Functions

Const completeCardForm

  • completeCardForm(): Promise<void>
  • カードフォーム画面を閉じます。

    Returns Promise<void>

Const connectCardForm

  • connectCardForm(): () => void

Const onCardFormUpdate

  • カードフォームの更新を受け取ります。 登録したリスナーを解除するには、返却される関数を実行します。

    const unsubscribe = PayjpCardForm.onCardFormUpdate({
      onCardFormCanceled: () => {},
      onCardFormCompleted: () => {},
      onCardFormProducedToken: token => {}
    });
    // when you need to release listener...
    unsubscribe();

    Parameters

    Returns () => void

    unsubscribe function リスナーを解除する(多くの場合アンマウント時にコールする)関数

      • (): void
      • Returns void

Const setIOSCardFormStyle

  • カードフォームのスタイルをセットします。(iOS用)

    Parameters

    Returns Promise<void>

Const showTokenProcessingError

  • showTokenProcessingError(message: string): Promise<void>
  • カードフォーム画面を終了せずにエラーメッセージを表示します。

    Parameters

    • message: string

      エラーメッセージ

    Returns Promise<void>

Const startCardForm

  • カードフォームを開始します。 更新を受け取るには onCardFormUpdate にリスナーを登録してください。

    Parameters

    • Optional options: CardFormOption

      カードフォームのオプション

    Returns Promise<void>

Generated using TypeDoc