com.github.segmentio.models

Class Providers

java.lang.Object

java.util.AbstractMap<K,V>

java.util.HashMap<String,Object>

com.github.segmentio.models.Props

com.github.segmentio.models.Providers

All Implemented Interfaces:

Serializable, Cloneable, Map<String,Object>

public class Providers
extends Props

A context containers that helps specify which providers are enabled or disabled.

See Also:

Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from class java.util.AbstractMap

AbstractMap.SimpleEntry<K,V>, AbstractMap.SimpleImmutableEntry<K,V>

Constructor Summary

Constructors

Constructor and Description
Providers()

Method Summary

Methods

Modifier and Type	Method and Description
Providers	setDefault(boolean enabled) Sets all providers as enabled or disabled for default.
Providers	setEnabled(String providerName, boolean enabled) Set a specific provider as enabled or disabled for this call.

Methods inherited from class com.github.segmentio.models.Props

allowed, put

Methods inherited from class java.util.HashMap

clear, clone, containsKey, containsValue, entrySet, get, isEmpty, keySet, putAll, remove, size, values

Methods inherited from class java.util.AbstractMap

equals, hashCode, toString

Methods inherited from class java.lang.Object

finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface java.util.Map

equals, hashCode

Constructor Detail

Providers

public Providers()

Method Detail

setDefault

public Providers setDefault(boolean enabled)

Sets all providers as enabled or disabled for default. Useful for turning every provider except for one off.

Parameters:

enabled - Whether every provider is turned on or off by default.

Returns:

Providers object for chaining.

setEnabled

public Providers setEnabled(String providerName,
                   boolean enabled)

Set a specific provider as enabled or disabled for this call.

Parameters:

providerName - The name of the analytics provider you're trying to turn on/off. Check out https://segment.io/docs/methods/identify#choosing-providers for the list of provider names.

enabled - Specifies whether this provider is enabled or disabled.

Returns:

Providers object for chaining.