Package com.zendesk.sunshine_conversations_client.model

Class ConversationCreateBody

java.lang.Object

com.zendesk.sunshine_conversations_client.model.ConversationCreateBody

public class ConversationCreateBody
extends java.lang.Object

ConversationCreateBody

Field Summary

Fields

Modifier and Type	Field	Description
static java.lang.String	JSON_PROPERTY_DESCRIPTION
static java.lang.String	JSON_PROPERTY_DISPLAY_NAME
static java.lang.String	JSON_PROPERTY_ICON_URL
static java.lang.String	JSON_PROPERTY_METADATA
static java.lang.String	JSON_PROPERTY_PARTICIPANTS
static java.lang.String	JSON_PROPERTY_TYPE

Constructor Summary

Constructors

Constructor	Description
ConversationCreateBody()

Method Summary

Modifier and Type	Method	Description
ConversationCreateBody	addParticipantsItem(ParticipantSubSchema participantsItem)
ConversationCreateBody	description(java.lang.String description)
ConversationCreateBody	displayName(java.lang.String displayName)
boolean	equals(java.lang.Object o)
java.lang.String	getDescription()	A short text describing the conversation.
org.openapitools.jackson.nullable.JsonNullable<java.lang.String>	getDescription_JsonNullable()
java.lang.String	getDisplayName()	A friendly name for the conversation, may be displayed to the business or the user.
java.net.URI	getIconUrl()	A custom conversation icon url.
org.openapitools.jackson.nullable.JsonNullable<java.net.URI>	getIconUrl_JsonNullable()
java.lang.Object	getMetadata()	Flat object containing custom properties.
org.openapitools.jackson.nullable.JsonNullable<java.lang.Object>	getMetadata_JsonNullable()
java.util.List<ParticipantSubSchema>	getParticipants()	The users participating in the conversation.
ConversationType	getType()	Get type
int	hashCode()
ConversationCreateBody	iconUrl(java.net.URI iconUrl)
ConversationCreateBody	metadata(java.lang.Object metadata)
ConversationCreateBody	participants(java.util.List<ParticipantSubSchema> participants)
void	setDescription(java.lang.String description)
void	setDescription_JsonNullable(org.openapitools.jackson.nullable.JsonNullable<java.lang.String> description)
void	setDisplayName(java.lang.String displayName)
void	setIconUrl(java.net.URI iconUrl)
void	setIconUrl_JsonNullable(org.openapitools.jackson.nullable.JsonNullable<java.net.URI> iconUrl)
void	setMetadata(java.lang.Object metadata)
void	setMetadata_JsonNullable(org.openapitools.jackson.nullable.JsonNullable<java.lang.Object> metadata)
void	setParticipants(java.util.List<ParticipantSubSchema> participants)
void	setType(ConversationType type)
java.lang.String	toString()
ConversationCreateBody	type(ConversationType type)

Methods inherited from class java.lang.Object

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

Field Detail

JSON_PROPERTY_TYPE

public static final java.lang.String JSON_PROPERTY_TYPE

See Also:

Constant Field Values

JSON_PROPERTY_PARTICIPANTS

public static final java.lang.String JSON_PROPERTY_PARTICIPANTS

See Also:

Constant Field Values

JSON_PROPERTY_DISPLAY_NAME

public static final java.lang.String JSON_PROPERTY_DISPLAY_NAME

See Also:

Constant Field Values

JSON_PROPERTY_DESCRIPTION

public static final java.lang.String JSON_PROPERTY_DESCRIPTION

See Also:

Constant Field Values

JSON_PROPERTY_ICON_URL

public static final java.lang.String JSON_PROPERTY_ICON_URL

See Also:

Constant Field Values

JSON_PROPERTY_METADATA

public static final java.lang.String JSON_PROPERTY_METADATA

See Also:

Constant Field Values

Constructor Detail

ConversationCreateBody

public ConversationCreateBody()

Method Detail

type

public ConversationCreateBody type(ConversationType type)

getType

public ConversationType getType()

Get type

Returns:

type

setType

public void setType(ConversationType type)

participants

public ConversationCreateBody participants(java.util.List<ParticipantSubSchema> participants)

addParticipantsItem

public ConversationCreateBody addParticipantsItem(ParticipantSubSchema participantsItem)

getParticipants

@Nullable
public java.util.List<ParticipantSubSchema> getParticipants()

The users participating in the conversation. For `personal` conversations, this field is required with a length of exactly 1. For `sdkGroup` conversations, must have a length less than or equal to 10. Can be omitted to have a conversation with no participants if the type is `sdkGroup`.

Returns:

participants

setParticipants

public void setParticipants(java.util.List<ParticipantSubSchema> participants)

displayName

public ConversationCreateBody displayName(java.lang.String displayName)

getDisplayName

@Nullable
public java.lang.String getDisplayName()

A friendly name for the conversation, may be displayed to the business or the user.

Returns:

displayName

setDisplayName

public void setDisplayName(java.lang.String displayName)

description

public ConversationCreateBody description(java.lang.String description)

getDescription

@Nullable
public java.lang.String getDescription()

A short text describing the conversation.

Returns:

description

getDescription_JsonNullable

public org.openapitools.jackson.nullable.JsonNullable<java.lang.String> getDescription_JsonNullable()

setDescription_JsonNullable

public void setDescription_JsonNullable(org.openapitools.jackson.nullable.JsonNullable<java.lang.String> description)

setDescription

public void setDescription(java.lang.String description)

iconUrl

public ConversationCreateBody iconUrl(java.net.URI iconUrl)

getIconUrl

@Nullable
public java.net.URI getIconUrl()

A custom conversation icon url. The image must be in either JPG, PNG, or GIF format

Returns:

iconUrl

getIconUrl_JsonNullable

public org.openapitools.jackson.nullable.JsonNullable<java.net.URI> getIconUrl_JsonNullable()

setIconUrl_JsonNullable

public void setIconUrl_JsonNullable(org.openapitools.jackson.nullable.JsonNullable<java.net.URI> iconUrl)

setIconUrl

public void setIconUrl(java.net.URI iconUrl)

metadata

public ConversationCreateBody metadata(java.lang.Object metadata)

getMetadata

@Nullable
public java.lang.Object getMetadata()

Flat object containing custom properties. Strings, numbers and booleans are the only supported format that can be passed to metadata. The metadata is limited to 4KB in size.

Returns:

metadata

getMetadata_JsonNullable

public org.openapitools.jackson.nullable.JsonNullable<java.lang.Object> getMetadata_JsonNullable()

setMetadata_JsonNullable

public void setMetadata_JsonNullable(org.openapitools.jackson.nullable.JsonNullable<java.lang.Object> metadata)

setMetadata

public void setMetadata(java.lang.Object metadata)

equals

public boolean equals(java.lang.Object o)

Overrides:

equals in class java.lang.Object

hashCode

public int hashCode()

Overrides:

hashCode in class java.lang.Object

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object