Package com.vonage.client.users.channels

Class Channel

java.lang.Object

com.vonage.client.JsonableBaseObject

com.vonage.client.users.channels.Channel

All Implemented Interfaces:

Jsonable

Direct Known Subclasses:

Messenger, Mms, Pstn, Sip, Sms, Vbc, Viber, Websocket, Whatsapp, WhatsappVoice

public abstract class Channel
extends JsonableBaseObject

Base class for channels.

Field Summary

Fields

Modifier and Type	Field	Description
protected ChannelType	type

Constructor Summary

Constructors

Constructor	Description
Channel()

Method Summary

Modifier and Type	Method	Description
static Class<? extends Channel>	getConcreteClass(ChannelType type)	Finds the corresponding subclass of Channel based on the enum's value.
ChannelType	getType()	If the type field is present in JSON payload, returns the value as an enum.
void	removeTypeField()	This method makes getType() return null; effectively the opposite of setTypeField().
void	setTypeField()	Sets the getType() based on this class's type.

Methods inherited from class com.vonage.client.JsonableBaseObject

createJsonObjectMapper, equals, hashCode, toString

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.vonage.client.Jsonable

toJson, updateFromJson

Field Details

type

protected ChannelType type

Constructor Details

Channel

public Channel()

Method Details

getType

public ChannelType getType()

If the type field is present in JSON payload, returns the value as an enum. Usually however, the type can be inferred from the class name. This method is provided for completeness in cases where the field may be present.

Returns:

The channel type as an enum, or null if absent or not applicable in this context.

Since:

8.4.0

setTypeField

public void setTypeField()

Sets the getType() based on this class's type. This is useful for some API calls where the type information is expected to be present in the JSON.

Since:

8.4.0

See Also:

• removeTypeField()

removeTypeField

public void removeTypeField()

This method makes getType() return null; effectively the opposite of setTypeField(). This is useful for some API calls where the type information should be omitted from the generated JSON.

Since:

8.4.0

See Also:

• setTypeField()

getConcreteClass

public static Class<? extends Channel> getConcreteClass(ChannelType type)

Finds the corresponding subclass of Channel based on the enum's value.

Parameters:

type - The channel type as an enum.

Returns:

The appropriate concrete Channel class, or null if there isn't one.

Since:

8.4.0