Class CardGetEmbedUrlParams.Builder
-
- All Implemented Interfaces:
public final class CardGetEmbedUrlParams.Builder
-
-
Constructor Summary
Constructors Constructor Description CardGetEmbedUrlParams.Builder()
-
Method Summary
-
-
Method Detail
-
token
final CardGetEmbedUrlParams.Builder token(String token)
Globally unique identifier for the card to be displayed.
-
css
final CardGetEmbedUrlParams.Builder css(String css)
A publicly available URI, so the white-labeled card element can be styled with the client's branding.
-
expiration
final CardGetEmbedUrlParams.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 CardGetEmbedUrlParams.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 CardGetEmbedUrlParams.Builder additionalQueryParams(Map<String, List<String>> additionalQueryParams)
-
putQueryParam
final CardGetEmbedUrlParams.Builder putQueryParam(String name, String value)
-
putQueryParams
final CardGetEmbedUrlParams.Builder putQueryParams(String name, Iterable<String> values)
-
putAllQueryParams
final CardGetEmbedUrlParams.Builder putAllQueryParams(Map<String, Iterable<String>> additionalQueryParams)
-
removeQueryParam
final CardGetEmbedUrlParams.Builder removeQueryParam(String name)
-
additionalHeaders
final CardGetEmbedUrlParams.Builder additionalHeaders(Map<String, Iterable<String>> additionalHeaders)
-
putHeader
final CardGetEmbedUrlParams.Builder putHeader(String name, String value)
-
putHeaders
final CardGetEmbedUrlParams.Builder putHeaders(String name, Iterable<String> values)
-
putAllHeaders
final CardGetEmbedUrlParams.Builder putAllHeaders(Map<String, Iterable<String>> additionalHeaders)
-
removeHeader
final CardGetEmbedUrlParams.Builder removeHeader(String name)
-
additionalBodyProperties
final CardGetEmbedUrlParams.Builder additionalBodyProperties(Map<String, JsonValue> additionalBodyProperties)
-
putAdditionalBodyProperty
final CardGetEmbedUrlParams.Builder putAdditionalBodyProperty(String key, JsonValue value)
-
putAllAdditionalBodyProperties
final CardGetEmbedUrlParams.Builder putAllAdditionalBodyProperties(Map<String, JsonValue> additionalBodyProperties)
-
build
final CardGetEmbedUrlParams build()
-
-
-
-