Class CardGetEmbedHtmlParams.Builder
-
- All Implemented Interfaces:
public final class CardGetEmbedHtmlParams.Builder
-
-
Constructor Summary
Constructors Constructor Description CardGetEmbedHtmlParams.Builder()
-
Method Summary
-
-
Method Detail
-
token
final CardGetEmbedHtmlParams.Builder token(String token)
Globally unique identifier for the card to be displayed.
-
css
final CardGetEmbedHtmlParams.Builder css(String css)
A publicly available URI, so the white-labeled card element can be styled with the client's branding.
-
expiration
final CardGetEmbedHtmlParams.Builder expiration(OffsetDateTime expiration)
An RFC 3339 timestamp for when the request should expire. UTC time zone.
If no timezone is specified, UTC will be used. If payload does not contain an expiration, the request will never expire.
Using an
expirationreduces the risk of a replay attack. Without supplying theexpiration, in the event that a malicious user gets a copy of your request in transit, they will be able to obtain the response data indefinitely.
-
targetOrigin
final CardGetEmbedHtmlParams.Builder targetOrigin(String targetOrigin)
Required if you want to post the element clicked to the parent iframe.
If you supply this param, you can also capture click events in the parent iframe by adding an event listener.
-
additionalQueryParams
final CardGetEmbedHtmlParams.Builder additionalQueryParams(Map<String, List<String>> additionalQueryParams)
-
putQueryParam
final CardGetEmbedHtmlParams.Builder putQueryParam(String name, String value)
-
putQueryParams
final CardGetEmbedHtmlParams.Builder putQueryParams(String name, Iterable<String> values)
-
putAllQueryParams
final CardGetEmbedHtmlParams.Builder putAllQueryParams(Map<String, Iterable<String>> additionalQueryParams)
-
removeQueryParam
final CardGetEmbedHtmlParams.Builder removeQueryParam(String name)
-
additionalHeaders
final CardGetEmbedHtmlParams.Builder additionalHeaders(Map<String, Iterable<String>> additionalHeaders)
-
putHeader
final CardGetEmbedHtmlParams.Builder putHeader(String name, String value)
-
putHeaders
final CardGetEmbedHtmlParams.Builder putHeaders(String name, Iterable<String> values)
-
putAllHeaders
final CardGetEmbedHtmlParams.Builder putAllHeaders(Map<String, Iterable<String>> additionalHeaders)
-
removeHeader
final CardGetEmbedHtmlParams.Builder removeHeader(String name)
-
additionalBodyProperties
final CardGetEmbedHtmlParams.Builder additionalBodyProperties(Map<String, JsonValue> additionalBodyProperties)
-
putAdditionalBodyProperty
final CardGetEmbedHtmlParams.Builder putAdditionalBodyProperty(String key, JsonValue value)
-
putAllAdditionalBodyProperties
final CardGetEmbedHtmlParams.Builder putAllAdditionalBodyProperties(Map<String, JsonValue> additionalBodyProperties)
-
build
final CardGetEmbedHtmlParams build()
-
-
-
-