Package com.courier.api.resources.users.tokens.types

Class UserToken.Builder

java.lang.Object

com.courier.api.resources.users.tokens.types.UserToken.Builder

All Implemented Interfaces:

UserToken._FinalStage, UserToken.ProviderKeyStage

Enclosing class:

UserToken

public static final class UserToken.Builder
extends java.lang.Object
implements UserToken.ProviderKeyStage, UserToken._FinalStage

Method Summary

Modifier and Type	Method	Description
UserToken	build()
UserToken._FinalStage	device(Device device)	Information about the device the token is associated with.
UserToken._FinalStage	device(java.util.Optional<Device> device)
UserToken._FinalStage	expiryDate(ExpiryDate expiryDate)	ISO 8601 formatted date the token expires.
UserToken._FinalStage	expiryDate(java.util.Optional<ExpiryDate> expiryDate)
UserToken.Builder	from(UserToken other)
UserToken._FinalStage	properties(java.lang.Object properties)	Properties sent to the provider along with the token
UserToken._FinalStage	properties(java.util.Optional<java.lang.Object> properties)
UserToken._FinalStage	providerKey(ProviderKey providerKey)
UserToken._FinalStage	token(java.lang.String token)	Full body of the token.
UserToken._FinalStage	token(java.util.Optional<java.lang.String> token)
UserToken._FinalStage	tracking(Tracking tracking)	Information about the device the token is associated with.
UserToken._FinalStage	tracking(java.util.Optional<Tracking> tracking)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

from

public UserToken.Builder from(UserToken other)

Specified by:

from in interface UserToken.ProviderKeyStage

providerKey

public UserToken._FinalStage providerKey(ProviderKey providerKey)

Specified by:

providerKey in interface UserToken.ProviderKeyStage

tracking

public UserToken._FinalStage tracking(Tracking tracking)

Information about the device the token is associated with.

Specified by:

tracking in interface UserToken._FinalStage

Returns:

Reference to this so that method calls can be chained together.

tracking

public UserToken._FinalStage tracking(java.util.Optional<Tracking> tracking)

Specified by:

tracking in interface UserToken._FinalStage

device

public UserToken._FinalStage device(Device device)

Information about the device the token is associated with.

Specified by:

device in interface UserToken._FinalStage

Returns:

Reference to this so that method calls can be chained together.

device

public UserToken._FinalStage device(java.util.Optional<Device> device)

Specified by:

device in interface UserToken._FinalStage

properties

public UserToken._FinalStage properties(java.lang.Object properties)

Properties sent to the provider along with the token

Specified by:

properties in interface UserToken._FinalStage

Returns:

Reference to this so that method calls can be chained together.

properties

public UserToken._FinalStage properties(java.util.Optional<java.lang.Object> properties)

Specified by:

properties in interface UserToken._FinalStage

expiryDate

public UserToken._FinalStage expiryDate(ExpiryDate expiryDate)

ISO 8601 formatted date the token expires. Defaults to 2 months. Set to false to disable expiration.

Specified by:

expiryDate in interface UserToken._FinalStage

Returns:

Reference to this so that method calls can be chained together.

expiryDate

public UserToken._FinalStage expiryDate(java.util.Optional<ExpiryDate> expiryDate)

Specified by:

expiryDate in interface UserToken._FinalStage

token

public UserToken._FinalStage token(java.lang.String token)

Full body of the token. Must match token in URL.

Specified by:

token in interface UserToken._FinalStage

Returns:

Reference to this so that method calls can be chained together.

token

public UserToken._FinalStage token(java.util.Optional<java.lang.String> token)

Specified by:

token in interface UserToken._FinalStage

build

public UserToken build()

Specified by:

build in interface UserToken._FinalStage