Package com.vonage.client.users.channels

Class Websocket

java.lang.Object

com.vonage.client.JsonableBaseObject

com.vonage.client.users.channels.Channel

com.vonage.client.users.channels.Websocket

All Implemented Interfaces:

Jsonable

public class Websocket
extends Channel

Represents a Websocket channel.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static enum	Websocket.ContentType	Represents the possible content types for a Websocket.

Field Summary

Fields inherited from class com.vonage.client.users.channels.Channel

type

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	Websocket()
	Websocket(String uri)
	Websocket(String uri, Websocket.ContentType contentType, Map<String,?> headers)

Method Summary

Modifier and Type	Method	Description
Websocket.ContentType	getContentType()	MIME type of the content sent over the websocket.
Map<String,?>	getHeaders()	Custom properties to add to the header.
URI	getUri()	Full URI of the websocket.

Methods inherited from class com.vonage.client.users.channels.Channel

getConcreteClass, getType, removeTypeField, setTypeField

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

Constructor Details

Websocket

protected Websocket()

Websocket

public Websocket(String uri)

Websocket

public Websocket(String uri,
 Websocket.ContentType contentType,
 Map<String,?> headers)

Method Details

getUri

public URI getUri()

Full URI of the websocket.

Returns:

The websocket URI, or null if not set.

getContentType

public Websocket.ContentType getContentType()

MIME type of the content sent over the websocket.

Returns:

The media content type as an enum, or null if unknown.

getHeaders

public Map<String,?> getHeaders()

Custom properties to add to the header.

Returns:

Header properties as a Map, or null if not set.