Package com.google.api.services.rcsbusinessmessaging.v1.model

Class PaymentRequestAction

  • All Implemented Interfaces:
    java.lang.Cloneable, java.util.Map<java.lang.String,​java.lang.Object>
    public final class PaymentRequestAction
extends com.google.api.client.json.GenericJson
    Payment request action.

    This is the Java data model class that specifies how to parse/serialize into the JSON that is transmitted over HTTP when working with the RCS Business Messaging API. For a detailed explanation see: https://developers.google.com/api-client-library/java/google-http-java-client/json

    Author:
    Google, Inc.

    • Nested Class Summary

      • Nested classes/interfaces inherited from class com.google.api.client.util.GenericData

        com.google.api.client.util.GenericData.Flags

      • Nested classes/interfaces inherited from class java.util.AbstractMap

        java.util.AbstractMap.SimpleEntry<K extends java.lang.Object,​V extends java.lang.Object>, java.util.AbstractMap.SimpleImmutableEntry<K extends java.lang.Object,​V extends java.lang.Object>

      • Nested classes/interfaces inherited from interface java.util.Map

        java.util.Map.Entry<K extends java.lang.Object,​V extends java.lang.Object>

    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      PaymentRequestAction clone()  
      java.lang.String getCompletedMessage()
      Text that replaces the payment request text when the transaction is complete.
      java.lang.String getExpiredMessage()
      Text that replaces the payment request text when the request is expired.
      java.lang.String getExpireTime()
      (Optional) A timestamp of when the payment request expires.
      java.util.List<LineItem> getItems()
      Payment request line items, including regular items, taxes, sub-total, and shipping.
      java.util.List<Method> getPaymentMethods()
      Supported payment methods.
      java.lang.String getRequestId()
      The agent-assigned ID of the payment request.
      java.lang.String getSignature()
      This field is set by the RBM platform.
      LineItem getTotal()
      The total amount of the payment request.
      PaymentRequestAction set​(java.lang.String fieldName, java.lang.Object value)  
      PaymentRequestAction setCompletedMessage​(java.lang.String completedMessage)
      Text that replaces the payment request text when the transaction is complete.
      PaymentRequestAction setExpiredMessage​(java.lang.String expiredMessage)
      Text that replaces the payment request text when the request is expired.
      PaymentRequestAction setExpireTime​(java.lang.String expireTime)
      (Optional) A timestamp of when the payment request expires.
      PaymentRequestAction setItems​(java.util.List<LineItem> items)
      Payment request line items, including regular items, taxes, sub-total, and shipping.
      PaymentRequestAction setPaymentMethods​(java.util.List<Method> paymentMethods)
      Supported payment methods.
      PaymentRequestAction setRequestId​(java.lang.String requestId)
      The agent-assigned ID of the payment request.
      PaymentRequestAction setSignature​(java.lang.String signature)
      This field is set by the RBM platform.
      PaymentRequestAction setTotal​(LineItem total)
      The total amount of the payment request.

      • Methods inherited from class com.google.api.client.json.GenericJson

        getFactory, setFactory, toPrettyString, toString

      • Methods inherited from class com.google.api.client.util.GenericData

        entrySet, get, getClassInfo, getUnknownKeys, put, putAll, remove, setUnknownKeys

      • Methods inherited from class java.util.AbstractMap

        clear, containsKey, containsValue, equals, hashCode, isEmpty, keySet, size, values

      • Methods inherited from class java.lang.Object

        finalize, getClass, notify, notifyAll, wait, wait, wait

      • Methods inherited from interface java.util.Map

        compute, computeIfAbsent, computeIfPresent, forEach, getOrDefault, merge, putIfAbsent, remove, replace, replace, replaceAll

    • Constructor Detail

      • PaymentRequestAction

        public PaymentRequestAction()

    • Method Detail

      • getCompletedMessage

        public java.lang.String getCompletedMessage()
        Text that replaces the payment request text when the transaction is complete.
        Returns:
        value or null for none

      • setCompletedMessage

        public PaymentRequestAction setCompletedMessage​(java.lang.String completedMessage)
        Text that replaces the payment request text when the transaction is complete.
        Parameters:
        completedMessage - completedMessage or null for none

      • getExpireTime

        public java.lang.String getExpireTime()
        (Optional) A timestamp of when the payment request expires. If a payment request expires, the request becomes invalid. If you specify a timestamp, the RCS-enabled messaging app doesn't verify an expiration time with the RBM agent. If you don't specify a timestamp, the payment request only expires if the agent flags the request as expired via the experation check webhook.
        Returns:
        value or null for none

      • setExpireTime

        public PaymentRequestAction setExpireTime​(java.lang.String expireTime)
        (Optional) A timestamp of when the payment request expires. If a payment request expires, the request becomes invalid. If you specify a timestamp, the RCS-enabled messaging app doesn't verify an expiration time with the RBM agent. If you don't specify a timestamp, the payment request only expires if the agent flags the request as expired via the experation check webhook.
        Parameters:
        expireTime - expireTime or null for none

      • getExpiredMessage

        public java.lang.String getExpiredMessage()
        Text that replaces the payment request text when the request is expired.
        Returns:
        value or null for none

      • setExpiredMessage

        public PaymentRequestAction setExpiredMessage​(java.lang.String expiredMessage)
        Text that replaces the payment request text when the request is expired.
        Parameters:
        expiredMessage - expiredMessage or null for none

      • getItems

        public java.util.List<LineItem> getItems()
        Payment request line items, including regular items, taxes, sub-total, and shipping.
        Returns:
        value or null for none

      • setItems

        public PaymentRequestAction setItems​(java.util.List<LineItem> items)
        Payment request line items, including regular items, taxes, sub-total, and shipping.
        Parameters:
        items - items or null for none

      • getPaymentMethods

        public java.util.List<Method> getPaymentMethods()
        Supported payment methods.
        Returns:
        value or null for none

      • setPaymentMethods

        public PaymentRequestAction setPaymentMethods​(java.util.List<Method> paymentMethods)
        Supported payment methods.
        Parameters:
        paymentMethods - paymentMethods or null for none

      • getRequestId

        public java.lang.String getRequestId()
        The agent-assigned ID of the payment request. This may be a UUID, as defined in https://tools.ietf.org/html/rfc4122.
        Returns:
        value or null for none

      • setRequestId

        public PaymentRequestAction setRequestId​(java.lang.String requestId)
        The agent-assigned ID of the payment request. This may be a UUID, as defined in https://tools.ietf.org/html/rfc4122.
        Parameters:
        requestId - requestId or null for none

      • getSignature

        public java.lang.String getSignature()
        This field is set by the RBM platform. Do not include it when creating a payment request. The field resolves to a checksum the RBM platform uses to validate the payment request.
        Returns:
        value or null for none

      • setSignature

        public PaymentRequestAction setSignature​(java.lang.String signature)
        This field is set by the RBM platform. Do not include it when creating a payment request. The field resolves to a checksum the RBM platform uses to validate the payment request.
        Parameters:
        signature - signature or null for none

      • getTotal

        public LineItem getTotal()
        The total amount of the payment request. The value must be positive.
        Returns:
        value or null for none

      • setTotal

        public PaymentRequestAction setTotal​(LineItem total)
        The total amount of the payment request. The value must be positive.
        Parameters:
        total - total or null for none

      • set

        public PaymentRequestAction set​(java.lang.String fieldName,
                                java.lang.Object value)
        Overrides:
        set in class com.google.api.client.json.GenericJson

      • clone

        public PaymentRequestAction clone()
        Overrides:
        clone in class com.google.api.client.json.GenericJson