Package com.yoti.api.client.docs.session.create

Class NotificationConfig

java.lang.Object

com.yoti.api.client.docs.session.create.NotificationConfig

public class NotificationConfig
extends Object

Configures call-back Notifications to some backend endpoint provided by the Relying Business.

Notifications can be configured to notify a clients backend of certain events, avoiding the need to poll for the state of the Session.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	NotificationConfig.Builder	Builder to assist in the creation of NotificationConfig.

Method Summary

Modifier and Type	Method	Description
static NotificationConfig.Builder	builder()
String	getAuthToken()	The authorization token to be included in call-back messages
String	getAuthType()	The authorization type to use for the token
String	getEndpoint()	The endpoint that notifications should be sent to
List<String>	getTopics()	The list of topics that should trigger notifications

Methods inherited from class java.lang.Object

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

Method Details

builder

public static NotificationConfig.Builder builder()

getAuthToken

public String getAuthToken()

The authorization token to be included in call-back messages

Returns:

the authorization token

getAuthType

public String getAuthType()

The authorization type to use for the token

Returns:

the authorization type

getEndpoint

public String getEndpoint()

The endpoint that notifications should be sent to

Returns:

the endpoint

getTopics

public List<String> getTopics()

The list of topics that should trigger notifications

Returns:

the list of topics