com.twilio.rest.chat.v1.service.user

Class UserChannel

java.lang.Object

com.twilio.base.Resource

com.twilio.rest.chat.v1.service.user.UserChannel

All Implemented Interfaces:

Serializable

public class UserChannel
extends Resource

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	UserChannel.ChannelStatus

Method Summary

Modifier and Type	Method and Description
boolean	equals(Object o)
static UserChannel	fromJson(InputStream json, com.fasterxml.jackson.databind.ObjectMapper objectMapper) Converts a JSON InputStream into a UserChannel object using the provided ObjectMapper.
static UserChannel	fromJson(String json, com.fasterxml.jackson.databind.ObjectMapper objectMapper) Converts a JSON String into a UserChannel object using the provided ObjectMapper.
String	getAccountSid() Returns The SID of the Account that created the resource.
String	getChannelSid() Returns The SID of the Channel the resource belongs to.
Integer	getLastConsumedMessageIndex() Returns The index of the last Message in the Channel the Member has read.
Map<String,String>	getLinks() Returns Absolute URLs to access the Members, Messages , Invites and, if it exists, the last Message for the Channel.
String	getMemberSid() Returns The SID of the User as a Member in the Channel.
String	getServiceSid() Returns The SID of the Service that the resource is associated with.
UserChannel.ChannelStatus	getStatus() Returns The status of the User on the Channel.
Integer	getUnreadMessagesCount() Returns The number of unread Messages in the Channel for the User.
int	hashCode()
static UserChannelReader	reader(String pathServiceSid, String pathUserSid) Create a UserChannelReader to execute read.

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, toString, wait, wait, wait

Method Detail

reader

public static UserChannelReader reader(String pathServiceSid,
                                       String pathUserSid)

Create a UserChannelReader to execute read.

Parameters:

pathServiceSid - The SID of the Service to read the resources from

pathUserSid - The SID of the User to fetch the User Channel resources from

Returns:

UserChannelReader capable of executing the read

fromJson

public static UserChannel fromJson(String json,
                                   com.fasterxml.jackson.databind.ObjectMapper objectMapper)

Converts a JSON String into a UserChannel object using the provided ObjectMapper.

Parameters:

json - Raw JSON String

objectMapper - Jackson ObjectMapper

Returns:

UserChannel object represented by the provided JSON

fromJson

public static UserChannel fromJson(InputStream json,
                                   com.fasterxml.jackson.databind.ObjectMapper objectMapper)

Converts a JSON InputStream into a UserChannel object using the provided ObjectMapper.

Parameters:

json - Raw JSON InputStream

objectMapper - Jackson ObjectMapper

Returns:

UserChannel object represented by the provided JSON

getAccountSid

public final String getAccountSid()

Returns The SID of the Account that created the resource.

Returns:

The SID of the Account that created the resource

getServiceSid

public final String getServiceSid()

Returns The SID of the Service that the resource is associated with.

Returns:

The SID of the Service that the resource is associated with

getChannelSid

public final String getChannelSid()

Returns The SID of the Channel the resource belongs to.

Returns:

The SID of the Channel the resource belongs to

getMemberSid

public final String getMemberSid()

Returns The SID of the User as a Member in the Channel.

Returns:

The SID of the User as a Member in the Channel

getStatus

public final UserChannel.ChannelStatus getStatus()

Returns The status of the User on the Channel.

Returns:

The status of the User on the Channel

getLastConsumedMessageIndex

public final Integer getLastConsumedMessageIndex()

Returns The index of the last Message in the Channel the Member has read.

Returns:

The index of the last Message in the Channel the Member has read

getUnreadMessagesCount

public final Integer getUnreadMessagesCount()

Returns The number of unread Messages in the Channel for the User.

Returns:

The number of unread Messages in the Channel for the User

getLinks

public final Map<String,String> getLinks()

Returns Absolute URLs to access the Members, Messages , Invites and, if it exists, the last Message for the Channel.

Returns:

Absolute URLs to access the Members, Messages , Invites and, if it exists, the last Message for the Channel

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object