Package com.zendesk.sunshine_conversations_client.model

Class Conversation

  • public class Conversation
extends java.lang.Object
    Conversation

    • Field Detail

      • JSON_PROPERTY_ID

        public static final java.lang.String JSON_PROPERTY_ID
        See Also:
        Constant Field Values

      • JSON_PROPERTY_TYPE

        public static final java.lang.String JSON_PROPERTY_TYPE
        See Also:
        Constant Field Values

      • JSON_PROPERTY_METADATA

        public static final java.lang.String JSON_PROPERTY_METADATA
        See Also:
        Constant Field Values

      • JSON_PROPERTY_ACTIVE_SWITCHBOARD_INTEGRATION

        public static final java.lang.String JSON_PROPERTY_ACTIVE_SWITCHBOARD_INTEGRATION
        See Also:
        Constant Field Values

      • JSON_PROPERTY_PENDING_SWITCHBOARD_INTEGRATION

        public static final java.lang.String JSON_PROPERTY_PENDING_SWITCHBOARD_INTEGRATION
        See Also:
        Constant Field Values

      • JSON_PROPERTY_IS_DEFAULT

        public static final java.lang.String JSON_PROPERTY_IS_DEFAULT
        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_BUSINESS_LAST_READ

        public static final java.lang.String JSON_PROPERTY_BUSINESS_LAST_READ
        See Also:
        Constant Field Values

      • JSON_PROPERTY_LAST_UPDATED_AT

        public static final java.lang.String JSON_PROPERTY_LAST_UPDATED_AT
        See Also:
        Constant Field Values

    • Constructor Detail

      • Conversation

        public Conversation()

    • Method Detail

      • getId

        @Nullable
public java.lang.String getId()
        The unique ID of the conversation.
        Returns:
        id

      • setId

        public void setId​(java.lang.String id)

      • metadata

        public Conversation 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)

      • getActiveSwitchboardIntegration

        @Nullable
public SwitchboardIntegrationWebhook getActiveSwitchboardIntegration()
        The current switchboard integration that is in control of the conversation. This field is omitted if no `activeSwitchboardIntegration` exists for the conversation.
        Returns:
        activeSwitchboardIntegration

      • getActiveSwitchboardIntegration_JsonNullable

        public org.openapitools.jackson.nullable.JsonNullable<SwitchboardIntegrationWebhook> getActiveSwitchboardIntegration_JsonNullable()

      • setActiveSwitchboardIntegration_JsonNullable

        public void setActiveSwitchboardIntegration_JsonNullable​(org.openapitools.jackson.nullable.JsonNullable<SwitchboardIntegrationWebhook> activeSwitchboardIntegration)

      • getPendingSwitchboardIntegration

        @Nullable
public SwitchboardIntegrationWebhook getPendingSwitchboardIntegration()
        The switchboard integration that is awaiting control. This field is omitted if no switchboard integration has been previously offered control.
        Returns:
        pendingSwitchboardIntegration

      • getPendingSwitchboardIntegration_JsonNullable

        public org.openapitools.jackson.nullable.JsonNullable<SwitchboardIntegrationWebhook> getPendingSwitchboardIntegration_JsonNullable()

      • setPendingSwitchboardIntegration_JsonNullable

        public void setPendingSwitchboardIntegration_JsonNullable​(org.openapitools.jackson.nullable.JsonNullable<SwitchboardIntegrationWebhook> pendingSwitchboardIntegration)

      • setPendingSwitchboardIntegration

        public void setPendingSwitchboardIntegration​(SwitchboardIntegrationWebhook pendingSwitchboardIntegration)

      • isDefault

        public Conversation isDefault​(java.lang.Boolean isDefault)

      • getIsDefault

        @Nullable
public java.lang.Boolean getIsDefault()
        Whether the conversation is the default conversation for the user. Will be true for the first personal conversation created for the user, and false in all other cases.
        Returns:
        isDefault

      • setIsDefault

        public void setIsDefault​(java.lang.Boolean isDefault)

      • displayName

        public Conversation 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 Conversation 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 Conversation 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)

      • businessLastRead

        public Conversation businessLastRead​(java.lang.String businessLastRead)

      • getBusinessLastRead

        @Nullable
public java.lang.String getBusinessLastRead()
        A datetime string with the format YYYY-MM-DDThh:mm:ss.SSSZ representing the moment the conversation was last marked as read with role business.
        Returns:
        businessLastRead

      • getBusinessLastRead_JsonNullable

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

      • setBusinessLastRead_JsonNullable

        public void setBusinessLastRead_JsonNullable​(org.openapitools.jackson.nullable.JsonNullable<java.lang.String> businessLastRead)

      • setBusinessLastRead

        public void setBusinessLastRead​(java.lang.String businessLastRead)

      • lastUpdatedAt

        public Conversation lastUpdatedAt​(java.lang.String lastUpdatedAt)

      • getLastUpdatedAt

        @Nullable
public java.lang.String getLastUpdatedAt()
        A datetime string with the format YYYY-MM-DDThh:mm:ss.SSSZ representing the moment the last message was received in the conversation, or the creation time if no messages have been received yet.
        Returns:
        lastUpdatedAt

      • getLastUpdatedAt_JsonNullable

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

      • setLastUpdatedAt_JsonNullable

        public void setLastUpdatedAt_JsonNullable​(org.openapitools.jackson.nullable.JsonNullable<java.lang.String> lastUpdatedAt)

      • setLastUpdatedAt

        public void setLastUpdatedAt​(java.lang.String lastUpdatedAt)

      • 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