Class Service

    • Method Detail

      • fetcher

        public static ServiceFetcher fetcher​(String pathSid)
        Create a ServiceFetcher to execute fetch.
        Parameters:
        pathSid - The unique string that identifies the resource
        Returns:
        ServiceFetcher capable of executing the fetch
      • deleter

        public static ServiceDeleter deleter​(String pathSid)
        Create a ServiceDeleter to execute delete.
        Parameters:
        pathSid - The unique string that identifies the resource
        Returns:
        ServiceDeleter capable of executing the delete
      • creator

        public static ServiceCreator creator​(String friendlyName)
        Create a ServiceCreator to execute create.
        Parameters:
        friendlyName - A string to describe the resource
        Returns:
        ServiceCreator capable of executing the create
      • reader

        public static ServiceReader reader()
        Create a ServiceReader to execute read.
        Returns:
        ServiceReader capable of executing the read
      • updater

        public static ServiceUpdater updater​(String pathSid)
        Create a ServiceUpdater to execute update.
        Parameters:
        pathSid - The unique string that identifies the resource
        Returns:
        ServiceUpdater capable of executing the update
      • fromJson

        public static Service fromJson​(String json,
                                       com.fasterxml.jackson.databind.ObjectMapper objectMapper)
        Converts a JSON String into a Service object using the provided ObjectMapper.
        Parameters:
        json - Raw JSON String
        objectMapper - Jackson ObjectMapper
        Returns:
        Service object represented by the provided JSON
      • fromJson

        public static Service fromJson​(InputStream json,
                                       com.fasterxml.jackson.databind.ObjectMapper objectMapper)
        Converts a JSON InputStream into a Service object using the provided ObjectMapper.
        Parameters:
        json - Raw JSON InputStream
        objectMapper - Jackson ObjectMapper
        Returns:
        Service object represented by the provided JSON
      • getSid

        public final String getSid()
        Returns The The unique string that identifies the resource.
        Returns:
        The unique string that identifies the resource
      • getAccountSid

        public final String getAccountSid()
        Returns The The SID of the Account that created the resource.
        Returns:
        The SID of the Account that created the resource
      • getFriendlyName

        public final String getFriendlyName()
        Returns The The string that you assigned to describe the resource.
        Returns:
        The string that you assigned to describe the resource
      • getDateCreated

        public final org.joda.time.DateTime getDateCreated()
        Returns The The RFC 2822 date and time in GMT when the resource was created.
        Returns:
        The RFC 2822 date and time in GMT when the resource was created
      • getDateUpdated

        public final org.joda.time.DateTime getDateUpdated()
        Returns The The RFC 2822 date and time in GMT when the resource was last updated.
        Returns:
        The RFC 2822 date and time in GMT when the resource was last updated
      • getDefaultServiceRoleSid

        public final String getDefaultServiceRoleSid()
        Returns The The service role assigned to users when they are added to the service.
        Returns:
        The service role assigned to users when they are added to the service
      • getDefaultChannelRoleSid

        public final String getDefaultChannelRoleSid()
        Returns The The channel role assigned to users when they are added to a channel.
        Returns:
        The channel role assigned to users when they are added to a channel
      • getDefaultChannelCreatorRoleSid

        public final String getDefaultChannelCreatorRoleSid()
        Returns The The channel role assigned to a channel creator when they join a new channel.
        Returns:
        The channel role assigned to a channel creator when they join a new channel
      • getReadStatusEnabled

        public final Boolean getReadStatusEnabled()
        Returns The Whether the Message Consumption Horizon feature is enabled.
        Returns:
        Whether the Message Consumption Horizon feature is enabled
      • getReachabilityEnabled

        public final Boolean getReachabilityEnabled()
        Returns The Whether the Reachability Indicator feature is enabled for this Service instance.
        Returns:
        Whether the Reachability Indicator feature is enabled for this Service instance
      • getTypingIndicatorTimeout

        public final Integer getTypingIndicatorTimeout()
        Returns The How long in seconds to wait before assuming the user is no longer typing.
        Returns:
        How long in seconds to wait before assuming the user is no longer typing
      • getConsumptionReportInterval

        public final Integer getConsumptionReportInterval()
        Returns The DEPRECATED.
        Returns:
        DEPRECATED
      • getLimits

        public final Map<String,​Object> getLimits()
        Returns The An object that describes the limits of the service instance.
        Returns:
        An object that describes the limits of the service instance
      • getPreWebhookUrl

        public final String getPreWebhookUrl()
        Returns The The webhook URL for pre-event webhooks.
        Returns:
        The webhook URL for pre-event webhooks
      • getPostWebhookUrl

        public final String getPostWebhookUrl()
        Returns The The URL for post-event webhooks.
        Returns:
        The URL for post-event webhooks
      • getWebhookMethod

        public final String getWebhookMethod()
        Returns The The HTTP method to use for both PRE and POST webhooks.
        Returns:
        The HTTP method to use for both PRE and POST webhooks
      • getWebhookFilters

        public final List<String> getWebhookFilters()
        Returns The The list of WebHook events that are enabled for this Service instance.
        Returns:
        The list of WebHook events that are enabled for this Service instance
      • getPreWebhookRetryCount

        public final Integer getPreWebhookRetryCount()
        Returns The Count of times webhook will be retried in case of timeout or 429/503/504 HTTP responses.
        Returns:
        Count of times webhook will be retried in case of timeout or 429/503/504 HTTP responses
      • getPostWebhookRetryCount

        public final Integer getPostWebhookRetryCount()
        Returns The The number of times calls to the `post_webhook_url` will be retried.
        Returns:
        The number of times calls to the `post_webhook_url` will be retried
      • getNotifications

        public final Map<String,​Object> getNotifications()
        Returns The The notification configuration for the Service instance.
        Returns:
        The notification configuration for the Service instance
      • getMedia

        public final Map<String,​Object> getMedia()
        Returns The The properties of the media that the service supports.
        Returns:
        The properties of the media that the service supports
      • getUrl

        public final URI getUrl()
        Returns The The absolute URL of the Service resource.
        Returns:
        The absolute URL of the Service resource
      • getLinks

        public final Map<String,​String> getLinks()
        Returns The The absolute URLs of the Service's Channels, Roles, and Users.
        Returns:
        The absolute URLs of the Service's Channels, Roles, and Users
      • hashCode

        public int hashCode()
        Overrides:
        hashCode in class Object