Class SessionCreateParams.Builder

  • Enclosing class:
    SessionCreateParams

    public static class SessionCreateParams.Builder
    extends java.lang.Object
    • Constructor Detail

      • Builder

        public Builder()
    • Method Detail

      • build

        public SessionCreateParams build()
        Finalize and obtain parameter instance from this builder.
      • setConfiguration

        public SessionCreateParams.Builder setConfiguration​(java.lang.String configuration)
        The ID of an existing configuration to use for this session, describing its functionality and features. If not specified, the session uses the default configuration.
      • addExpand

        public SessionCreateParams.Builder addExpand​(java.lang.String element)
        Add an element to `expand` list. A list is initialized for the first `add/addAll` call, and subsequent calls adds additional elements to the original list. See SessionCreateParams.expand for the field documentation.
      • addAllExpand

        public SessionCreateParams.Builder addAllExpand​(java.util.List<java.lang.String> elements)
        Add all elements to `expand` list. A list is initialized for the first `add/addAll` call, and subsequent calls adds additional elements to the original list. See SessionCreateParams.expand for the field documentation.
      • putExtraParam

        public SessionCreateParams.Builder putExtraParam​(java.lang.String key,
                                                         java.lang.Object value)
        Add a key/value pair to `extraParams` map. A map is initialized for the first `put/putAll` call, and subsequent calls add additional key/value pairs to the original map. See SessionCreateParams.extraParams for the field documentation.
      • putAllExtraParam

        public SessionCreateParams.Builder putAllExtraParam​(java.util.Map<java.lang.String,​java.lang.Object> map)
        Add all map key/value pairs to `extraParams` map. A map is initialized for the first `put/putAll` call, and subsequent calls add additional key/value pairs to the original map. See SessionCreateParams.extraParams for the field documentation.
      • setOnBehalfOf

        public SessionCreateParams.Builder setOnBehalfOf​(java.lang.String onBehalfOf)
        The on_behalf_of account to use for this session. When specified, only subscriptions and invoices with this on_behalf_of account appear in the portal. For more information, see the docs. Use the Accounts API to modify the on_behalf_of account's branding settings, which the portal displays.
      • setReturnUrl

        public SessionCreateParams.Builder setReturnUrl​(java.lang.String returnUrl)
        The default URL to redirect customers to when they click on the portal's link to return to your website.