ChannelConfiguration (Cyclos 4.13 Scripting API Documentation)

java.lang.Object
- org.cyclos.entities.SimpleEntity
- - org.cyclos.entities.NetworkedEntity
  - - org.cyclos.entities.BaseEntity
    - - org.cyclos.entities.system.ChannelConfiguration

All Implemented Interfaces:

java.lang.Cloneable, ProcessableForDataTranslation, org.cyclos.impl.system.ChannelAccessAccessor, org.cyclos.impl.system.ChannelSettingsAccessor, IEntity

Direct Known Subclasses:

SmsChannelConfiguration
```
@Entity
public class ChannelConfiguration
extends BaseEntity
implements org.cyclos.impl.system.ChannelSettingsAccessor, org.cyclos.impl.system.ChannelAccessAccessor
```
Contains definitions for a given pair of configuration and channel

Author:

luis

Constructor Summary

Constructors
Constructor and Description

ChannelConfiguration()

Constructors
Constructor and Description
`ChannelConfiguration()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`PasswordType`	`getAccessPassword()`
`Channel`	`getChannel()`
`Configuration`	`getConfiguration()`
`Availability`	`getConfirmationDeviceAvailability()`
`PasswordType`	`getConfirmationPassword()`
`IdentificationMethod`	`getDefaultPaymentIdMethod()`
`PrincipalType`	`getDefaultPaymentPrincipalType()`
`PrincipalType`	`getDefaultPrincipalType()`
`IdentificationMethod`	`getDefaultReceivePaymentIdMethod()`
`PrincipalType`	`getDefaultReceivePaymentPrincipalType()`
`java.util.Set<IdentityProvider>`	`getIdentityProviders()`
`java.lang.String`	`getIpWhitelist()`
`Network`	`getNetwork()` Returns the network this entity belongs to
`java.util.Set<PrincipalType>`	`getPaymentPrincipalTypes()`
`PinChannelConfiguration`	`getPinConfiguration()`
`java.util.Set<PrincipalType>`	`getPrincipalTypes()`
`java.util.Set<PrincipalType>`	`getPrincipalTypesAllowingQrCode()`
`java.util.Set<PrincipalType>`	`getReceivePaymentPrincipalTypes()`
`RegistrationWithIdentityProviders`	`getRegistrationWithIdentityProviders()`
`Availability`	`getSecondaryDeviceAvailability()`
`PasswordType`	`getSecondaryPassword()`
`TimeInterval`	`getSessionTimeout()`
`UserChannelAccess`	`getUserAccess()`
`InternetAddressList`	`getWhitelist()`
`boolean`	`isAllowLogin()`
`boolean`	`isAllowScanQrCodeOnPayment()`
`boolean`	`isAllowScanQrCodeOnReceivePayment()`
`boolean`	`isAutocompleteOnPayment()`
`boolean`	`isAutocompleteOnReceivePayment()`
`boolean`	`isConfirmationOncePerSession()`
`boolean`	`isContactsOnPayment()`
`boolean`	`isContactsOnReceivePayment()`
`boolean`	`isDefined()`
`boolean`	`isEnabled()`
`boolean`	`isLocked()`
`boolean`	`isRequireAuthenticationForDeviceConfirmation()`
`boolean`	`isRequireTrustedDeviceForLogin()`
`boolean`	`isSkipConfirmationForTrustedDevices()`
`boolean`	`isUseIpWhitelist()`
`void`	`setAccessPassword(PasswordType accessPassword)`
`void`	`setAllowLogin(boolean allowLogin)`
`void`	`setAllowScanQrCodeOnPayment(boolean allowScanQrCodeOnPayment)`
`void`	`setAllowScanQrCodeOnReceivePayment(boolean allowScanQrCodeOnReceivePayment)`
`void`	`setAutocompleteOnPayment(boolean autocompleteOnPayment)`
`void`	`setAutocompleteOnReceivePayment(boolean autocompleteOnReceivePayment)`
`void`	`setChannel(Channel channel)`
`void`	`setConfiguration(Configuration configuration)`
`void`	`setConfirmationDeviceAvailability(Availability confirmationDeviceAvailability)`
`void`	`setConfirmationOncePerSession(boolean confirmationOncePerSession)`
`void`	`setConfirmationPassword(PasswordType confirmationPassword)`
`void`	`setContactsOnPayment(boolean contactsOnPayment)`
`void`	`setContactsOnReceivePayment(boolean contactsOnReceivePayment)`
`void`	`setDefaultPaymentIdMethod(IdentificationMethod defaultPaymentIdMethod)`
`void`	`setDefaultPaymentPrincipalType(PrincipalType defaultPaymentPrincipalType)`
`void`	`setDefaultPrincipalType(PrincipalType defaultPrincipalType)`
`void`	`setDefaultReceivePaymentIdMethod(IdentificationMethod defaultReceivePaymentIdMethod)`
`void`	`setDefaultReceivePaymentPrincipalType(PrincipalType defaultReceivePaymentPrincipalType)`
`void`	`setDefined(boolean defined)`
`void`	`setEnabled(boolean enabled)`
`void`	`setIdentityProviders(java.util.Set<IdentityProvider> identityProviders)`
`void`	`setLocked(boolean locked)`
`void`	`setPaymentPrincipalTypes(java.util.Set<PrincipalType> paymentPrincipalTypes)`
`void`	`setPinConfiguration(PinChannelConfiguration pinConfiguration)`
`void`	`setPrincipalTypes(java.util.Set<PrincipalType> principalTypes)`
`void`	`setPrincipalTypesAllowingQrCode(java.util.Set<PrincipalType> principalTypesAllowingQrCode)`
`void`	`setReceivePaymentPrincipalTypes(java.util.Set<PrincipalType> receivePaymentPrincipalTypes)`
`void`	`setRegistrationWithIdentityProviders(RegistrationWithIdentityProviders registrationWithIdentityProviders)`
`void`	`setRequireAuthenticationForDeviceConfirmation(boolean requireAuthenticationForDeviceConfirmation)`
`void`	`setRequireTrustedDeviceForLogin(boolean requireTrustedDeviceForLogin)`
`void`	`setSecondaryDeviceAvailability(Availability secondaryDeviceAvailability)`
`void`	`setSecondaryPassword(PasswordType secondaryPassword)`
`void`	`setSessionTimeout(TimeInterval sessionTimeout)`
`void`	`setSkipConfirmationForTrustedDevices(boolean skipConfirmationForTrustedDevices)`
`void`	`setUserAccess(UserChannelAccess userAccess)`
`void`	`setWhitelist(InternetAddressList whitelist)`

Methods inherited from class org.cyclos.entities.BaseEntity
getDataTranslationType, getVersion

Methods inherited from class org.cyclos.entities.NetworkedEntity
isGlobal

Methods inherited from class org.cyclos.entities.SimpleEntity
clone, equals, getId, getId, getIds, getUniqueIds, getUniqueIds, hashCode, isPersistent, isTransient, toShortString, toString

Methods inherited from class java.lang.Object
finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface org.cyclos.model.IEntity
matches

- Constructor Detail
  - ChannelConfiguration
```
public ChannelConfiguration()
```
- Method Detail
  - getAccessPassword
```
public PasswordType getAccessPassword()
```
    Specified by:
    
    getAccessPassword in interface org.cyclos.impl.system.ChannelAccessAccessor
  - getChannel
```
public Channel getChannel()
```
    Specified by:
    
    getChannel in interface org.cyclos.impl.system.ChannelAccessAccessor
    
    Specified by:
    
    getChannel in interface org.cyclos.impl.system.ChannelSettingsAccessor
  - getConfiguration
```
public Configuration getConfiguration()
```
  - getConfirmationDeviceAvailability
```
public Availability getConfirmationDeviceAvailability()
```
    Specified by:
    
    getConfirmationDeviceAvailability in interface org.cyclos.impl.system.ChannelAccessAccessor
  - getConfirmationPassword
```
public PasswordType getConfirmationPassword()
```
    Specified by:
    
    getConfirmationPassword in interface org.cyclos.impl.system.ChannelAccessAccessor
  - getDefaultPaymentIdMethod
```
public IdentificationMethod getDefaultPaymentIdMethod()
```
    Specified by:
    
    getDefaultPaymentIdMethod in interface org.cyclos.impl.system.ChannelSettingsAccessor
  - getDefaultPaymentPrincipalType
```
public PrincipalType getDefaultPaymentPrincipalType()
```
    Specified by:
    
    getDefaultPaymentPrincipalType in interface org.cyclos.impl.system.ChannelSettingsAccessor
  - getDefaultPrincipalType
```
public PrincipalType getDefaultPrincipalType()
```
    Specified by:
    
    getDefaultPrincipalType in interface org.cyclos.impl.system.ChannelAccessAccessor
  - getDefaultReceivePaymentIdMethod
```
public IdentificationMethod getDefaultReceivePaymentIdMethod()
```
    Specified by:
    
    getDefaultReceivePaymentIdMethod in interface org.cyclos.impl.system.ChannelSettingsAccessor
  - getDefaultReceivePaymentPrincipalType
```
public PrincipalType getDefaultReceivePaymentPrincipalType()
```
    Specified by:
    
    getDefaultReceivePaymentPrincipalType in interface org.cyclos.impl.system.ChannelSettingsAccessor
  - getIdentityProviders
```
public java.util.Set<IdentityProvider> getIdentityProviders()
```
    Specified by:
    
    getIdentityProviders in interface org.cyclos.impl.system.ChannelAccessAccessor
  - getIpWhitelist
```
public java.lang.String getIpWhitelist()
```
  - getNetwork
```
public Network getNetwork()
```
    Description copied from class: NetworkedEntity
    
    Returns the network this entity belongs to
    
    Specified by:
    
    getNetwork in class NetworkedEntity
  - getPaymentPrincipalTypes
```
public java.util.Set<PrincipalType> getPaymentPrincipalTypes()
```
    Specified by:
    
    getPaymentPrincipalTypes in interface org.cyclos.impl.system.ChannelSettingsAccessor
  - getPinConfiguration
```
public PinChannelConfiguration getPinConfiguration()
```
    Specified by:
    
    getPinConfiguration in interface org.cyclos.impl.system.ChannelAccessAccessor
  - getPrincipalTypes
```
public java.util.Set<PrincipalType> getPrincipalTypes()
```
    Specified by:
    
    getPrincipalTypes in interface org.cyclos.impl.system.ChannelAccessAccessor
  - getPrincipalTypesAllowingQrCode
```
public java.util.Set<PrincipalType> getPrincipalTypesAllowingQrCode()
```
    Specified by:
    
    getPrincipalTypesAllowingQrCode in interface org.cyclos.impl.system.ChannelSettingsAccessor
  - getReceivePaymentPrincipalTypes
```
public java.util.Set<PrincipalType> getReceivePaymentPrincipalTypes()
```
    Specified by:
    
    getReceivePaymentPrincipalTypes in interface org.cyclos.impl.system.ChannelSettingsAccessor
  - getRegistrationWithIdentityProviders
```
public RegistrationWithIdentityProviders getRegistrationWithIdentityProviders()
```
    Specified by:
    
    getRegistrationWithIdentityProviders in interface org.cyclos.impl.system.ChannelAccessAccessor
  - getSecondaryDeviceAvailability
```
public Availability getSecondaryDeviceAvailability()
```
    Specified by:
    
    getSecondaryDeviceAvailability in interface org.cyclos.impl.system.ChannelAccessAccessor
  - getSecondaryPassword
```
public PasswordType getSecondaryPassword()
```
    Specified by:
    
    getSecondaryPassword in interface org.cyclos.impl.system.ChannelAccessAccessor
  - getSessionTimeout
```
public TimeInterval getSessionTimeout()
```
    Specified by:
    
    getSessionTimeout in interface org.cyclos.impl.system.ChannelAccessAccessor
  - getUserAccess
```
public UserChannelAccess getUserAccess()
```
    Specified by:
    
    getUserAccess in interface org.cyclos.impl.system.ChannelAccessAccessor
  - getWhitelist
```
public InternetAddressList getWhitelist()
```
    Specified by:
    
    getWhitelist in interface org.cyclos.impl.system.ChannelAccessAccessor
  - isAllowLogin
```
public boolean isAllowLogin()
```
  - isAllowScanQrCodeOnPayment
```
public boolean isAllowScanQrCodeOnPayment()
```
    Specified by:
    
    isAllowScanQrCodeOnPayment in interface org.cyclos.impl.system.ChannelSettingsAccessor
  - isAllowScanQrCodeOnReceivePayment
```
public boolean isAllowScanQrCodeOnReceivePayment()
```
    Specified by:
    
    isAllowScanQrCodeOnReceivePayment in interface org.cyclos.impl.system.ChannelSettingsAccessor
  - isAutocompleteOnPayment
```
public boolean isAutocompleteOnPayment()
```
    Specified by:
    
    isAutocompleteOnPayment in interface org.cyclos.impl.system.ChannelSettingsAccessor
  - isAutocompleteOnReceivePayment
```
public boolean isAutocompleteOnReceivePayment()
```
    Specified by:
    
    isAutocompleteOnReceivePayment in interface org.cyclos.impl.system.ChannelSettingsAccessor
  - isConfirmationOncePerSession
```
public boolean isConfirmationOncePerSession()
```
    Specified by:
    
    isConfirmationOncePerSession in interface org.cyclos.impl.system.ChannelAccessAccessor
  - isContactsOnPayment
```
public boolean isContactsOnPayment()
```
    Specified by:
    
    isContactsOnPayment in interface org.cyclos.impl.system.ChannelSettingsAccessor
  - isContactsOnReceivePayment
```
public boolean isContactsOnReceivePayment()
```
    Specified by:
    
    isContactsOnReceivePayment in interface org.cyclos.impl.system.ChannelSettingsAccessor
  - isDefined
```
public boolean isDefined()
```
  - isEnabled
```
public boolean isEnabled()
```
  - isLocked
```
public boolean isLocked()
```
  - isRequireAuthenticationForDeviceConfirmation
```
public boolean isRequireAuthenticationForDeviceConfirmation()
```
    Specified by:
    
    isRequireAuthenticationForDeviceConfirmation in interface org.cyclos.impl.system.ChannelAccessAccessor
  - isRequireTrustedDeviceForLogin
```
public boolean isRequireTrustedDeviceForLogin()
```
    Specified by:
    
    isRequireTrustedDeviceForLogin in interface org.cyclos.impl.system.ChannelAccessAccessor
  - isSkipConfirmationForTrustedDevices
```
public boolean isSkipConfirmationForTrustedDevices()
```
    Specified by:
    
    isSkipConfirmationForTrustedDevices in interface org.cyclos.impl.system.ChannelAccessAccessor
  - isUseIpWhitelist
```
public boolean isUseIpWhitelist()
```
    Specified by:
    
    isUseIpWhitelist in interface org.cyclos.impl.system.ChannelAccessAccessor
  - setAccessPassword
```
public void setAccessPassword(PasswordType accessPassword)
```
  - setAllowLogin
```
public void setAllowLogin(boolean allowLogin)
```
  - setAllowScanQrCodeOnPayment
```
public void setAllowScanQrCodeOnPayment(boolean allowScanQrCodeOnPayment)
```
  - setAllowScanQrCodeOnReceivePayment
```
public void setAllowScanQrCodeOnReceivePayment(boolean allowScanQrCodeOnReceivePayment)
```
  - setAutocompleteOnPayment
```
public void setAutocompleteOnPayment(boolean autocompleteOnPayment)
```
  - setAutocompleteOnReceivePayment
```
public void setAutocompleteOnReceivePayment(boolean autocompleteOnReceivePayment)
```
  - setChannel
```
public void setChannel(Channel channel)
```
  - setConfiguration
```
public void setConfiguration(Configuration configuration)
```
  - setConfirmationDeviceAvailability
```
public void setConfirmationDeviceAvailability(Availability confirmationDeviceAvailability)
```
  - setConfirmationOncePerSession
```
public void setConfirmationOncePerSession(boolean confirmationOncePerSession)
```
  - setConfirmationPassword
```
public void setConfirmationPassword(PasswordType confirmationPassword)
```
  - setContactsOnPayment
```
public void setContactsOnPayment(boolean contactsOnPayment)
```
  - setContactsOnReceivePayment
```
public void setContactsOnReceivePayment(boolean contactsOnReceivePayment)
```
  - setDefaultPaymentIdMethod
```
public void setDefaultPaymentIdMethod(IdentificationMethod defaultPaymentIdMethod)
```
  - setDefaultPaymentPrincipalType
```
public void setDefaultPaymentPrincipalType(PrincipalType defaultPaymentPrincipalType)
```
  - setDefaultPrincipalType
```
public void setDefaultPrincipalType(PrincipalType defaultPrincipalType)
```
  - setDefaultReceivePaymentIdMethod
```
public void setDefaultReceivePaymentIdMethod(IdentificationMethod defaultReceivePaymentIdMethod)
```
  - setDefaultReceivePaymentPrincipalType
```
public void setDefaultReceivePaymentPrincipalType(PrincipalType defaultReceivePaymentPrincipalType)
```
  - setDefined
```
public void setDefined(boolean defined)
```
  - setEnabled
```
public void setEnabled(boolean enabled)
```
  - setIdentityProviders
```
public void setIdentityProviders(java.util.Set<IdentityProvider> identityProviders)
```
  - setLocked
```
public void setLocked(boolean locked)
```
  - setPaymentPrincipalTypes
```
public void setPaymentPrincipalTypes(java.util.Set<PrincipalType> paymentPrincipalTypes)
```
  - setPinConfiguration
```
public void setPinConfiguration(PinChannelConfiguration pinConfiguration)
```
  - setPrincipalTypes
```
public void setPrincipalTypes(java.util.Set<PrincipalType> principalTypes)
```
  - setPrincipalTypesAllowingQrCode
```
public void setPrincipalTypesAllowingQrCode(java.util.Set<PrincipalType> principalTypesAllowingQrCode)
```
  - setReceivePaymentPrincipalTypes
```
public void setReceivePaymentPrincipalTypes(java.util.Set<PrincipalType> receivePaymentPrincipalTypes)
```
  - setRegistrationWithIdentityProviders
```
public void setRegistrationWithIdentityProviders(RegistrationWithIdentityProviders registrationWithIdentityProviders)
```
  - setRequireAuthenticationForDeviceConfirmation
```
public void setRequireAuthenticationForDeviceConfirmation(boolean requireAuthenticationForDeviceConfirmation)
```
  - setRequireTrustedDeviceForLogin
```
public void setRequireTrustedDeviceForLogin(boolean requireTrustedDeviceForLogin)
```
  - setSecondaryDeviceAvailability
```
public void setSecondaryDeviceAvailability(Availability secondaryDeviceAvailability)
```
  - setSecondaryPassword
```
public void setSecondaryPassword(PasswordType secondaryPassword)
```
  - setSessionTimeout
```
public void setSessionTimeout(TimeInterval sessionTimeout)
```
  - setSkipConfirmationForTrustedDevices
```
public void setSkipConfirmationForTrustedDevices(boolean skipConfirmationForTrustedDevices)
```
  - setUserAccess
```
public void setUserAccess(UserChannelAccess userAccess)
```
  - setWhitelist
```
public void setWhitelist(InternetAddressList whitelist)
```

Class ChannelConfiguration

Constructor Summary

Method Summary

Methods inherited from class org.cyclos.entities.BaseEntity

Methods inherited from class org.cyclos.entities.NetworkedEntity

Methods inherited from class org.cyclos.entities.SimpleEntity

Methods inherited from class java.lang.Object

Methods inherited from interface org.cyclos.model.IEntity

Constructor Detail

ChannelConfiguration

Method Detail

getAccessPassword

getChannel

getConfiguration

getConfirmationDeviceAvailability

getConfirmationPassword

getDefaultPaymentIdMethod

getDefaultPaymentPrincipalType

getDefaultPrincipalType

getDefaultReceivePaymentIdMethod

getDefaultReceivePaymentPrincipalType

getIdentityProviders

getIpWhitelist

getNetwork

getPaymentPrincipalTypes

getPinConfiguration

getPrincipalTypes

getPrincipalTypesAllowingQrCode

getReceivePaymentPrincipalTypes

getRegistrationWithIdentityProviders

getSecondaryDeviceAvailability

getSecondaryPassword

getSessionTimeout

getUserAccess

getWhitelist

isAllowLogin

isAllowScanQrCodeOnPayment

isAllowScanQrCodeOnReceivePayment

isAutocompleteOnPayment

isAutocompleteOnReceivePayment

isConfirmationOncePerSession

isContactsOnPayment

isContactsOnReceivePayment

isDefined

isEnabled

isLocked

isRequireAuthenticationForDeviceConfirmation

isRequireTrustedDeviceForLogin

isSkipConfirmationForTrustedDevices

isUseIpWhitelist

setAccessPassword

setAllowLogin

setAllowScanQrCodeOnPayment

setAllowScanQrCodeOnReceivePayment

setAutocompleteOnPayment

setAutocompleteOnReceivePayment

setChannel

setConfiguration

setConfirmationDeviceAvailability

setConfirmationOncePerSession

setConfirmationPassword

setContactsOnPayment

setContactsOnReceivePayment

setDefaultPaymentIdMethod

setDefaultPaymentPrincipalType

setDefaultPrincipalType

setDefaultReceivePaymentIdMethod

setDefaultReceivePaymentPrincipalType

setDefined

setEnabled

setIdentityProviders

setLocked

setPaymentPrincipalTypes

setPinConfiguration

setPrincipalTypes

setPrincipalTypesAllowingQrCode

setReceivePaymentPrincipalTypes

setRegistrationWithIdentityProviders

setRequireAuthenticationForDeviceConfirmation

setRequireTrustedDeviceForLogin